From 5c1840c16e2aff35d482d0d9801bce7f46c76bc1 Mon Sep 17 00:00:00 2001
From: Marcus Eide <eide@spotify.com>
Date: Tue, 7 Dec 2021 10:06:26 +0100
Subject: [PATCH] Rename to DatabaseManagerOptions and export

Signed-off-by: Marcus Eide <eide@spotify.com>
---
 packages/backend-common/api-report.md              | 11 +++++++++--
 .../backend-common/src/database/DatabaseManager.ts | 14 +++++++++++---
 2 files changed, 20 insertions(+), 5 deletions(-)

diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index 09a95b00ea..d6edfb0ce4 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -175,10 +175,17 @@ export function createStatusCheckRouter(options: {
 // @public (undocumented)
 export class DatabaseManager {
   forPlugin(pluginId: string): PluginDatabaseManager;
-  // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-  static fromConfig(config: Config, options?: Options): DatabaseManager;
+  static fromConfig(
+    config: Config,
+    options?: DatabaseManagerOptions,
+  ): DatabaseManager;
 }
 
+// @public
+export type DatabaseManagerOptions = {
+  migrations: PluginDatabaseManager['migrations'];
+};
+
 // @public (undocumented)
 export class DockerContainerRunner implements ContainerRunner {
   constructor({ dockerClient }: { dockerClient: Docker });
diff --git a/packages/backend-common/src/database/DatabaseManager.ts b/packages/backend-common/src/database/DatabaseManager.ts
index e564f2e0e6..befdd51218 100644
--- a/packages/backend-common/src/database/DatabaseManager.ts
+++ b/packages/backend-common/src/database/DatabaseManager.ts
@@ -36,7 +36,12 @@ function pluginPath(pluginId: string): string {
   return `plugin.${pluginId}`;
 }
 
-type Options = {
+/**
+ * Configuration options object.
+ *
+ * @public
+ */
+export type DatabaseManagerOptions = {
   migrations: PluginDatabaseManager['migrations'];
 };
 
@@ -53,7 +58,10 @@ export class DatabaseManager {
    * @param config - The loaded application configuration.
    * @param options - An optional configuration object.
    */
-  static fromConfig(config: Config, options?: Options): DatabaseManager {
+  static fromConfig(
+    config: Config,
+    options?: DatabaseManagerOptions,
+  ): DatabaseManager {
     const databaseConfig = config.getConfig('backend.database');
 
     return new DatabaseManager(
@@ -66,7 +74,7 @@ export class DatabaseManager {
   private constructor(
     private readonly config: Config,
     private readonly prefix: string = 'backstage_plugin_',
-    private readonly options?: Options,
+    private readonly options?: DatabaseManagerOptions,
   ) {}
 
   /**