From f911a60bafe69407aa79f6588d8cb5b6eb95d103 Mon Sep 17 00:00:00 2001
From: Joe Porpeglia <josephp@spotify.com>
Date: Thu, 13 Jan 2022 15:20:59 -0500
Subject: [PATCH] Update api-report

Signed-off-by: Joe Porpeglia <josephp@spotify.com>
---
 plugins/techdocs-backend/api-report.md        | 33 ++++++++++++++++++-
 plugins/techdocs-backend/src/index.ts         |  6 +++-
 plugins/techdocs-backend/src/service/index.ts |  6 +++-
 .../techdocs-backend/src/service/router.ts    |  4 +--
 4 files changed, 44 insertions(+), 5 deletions(-)

diff --git a/plugins/techdocs-backend/api-report.md b/plugins/techdocs-backend/api-report.md
index b241917bc0..76183d4c6c 100644
--- a/plugins/techdocs-backend/api-report.md
+++ b/plugins/techdocs-backend/api-report.md
@@ -17,7 +17,6 @@ import { PublisherBase } from '@backstage/techdocs-common';
 import { TechDocsDocument } from '@backstage/techdocs-common';
 import { TokenManager } from '@backstage/backend-common';
 
-// Warning: (ae-forgotten-export) The symbol "RouterOptions" needs to be exported by the entry point index.d.ts
 // Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -49,6 +48,38 @@ export class DefaultTechDocsCollator implements DocumentCollator {
   readonly type: string;
 }
 
+// Warning: (ae-missing-release-tag) "OutOfTheBoxDeploymentOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export type OutOfTheBoxDeploymentOptions = {
+  preparers: PreparerBuilder;
+  generators: GeneratorBuilder;
+  publisher: PublisherBase;
+  logger: Logger_2;
+  discovery: PluginEndpointDiscovery;
+  database?: Knex;
+  config: Config;
+  cache: PluginCacheManager;
+};
+
+// Warning: (ae-missing-release-tag) "RecommendedDeploymentOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export type RecommendedDeploymentOptions = {
+  publisher: PublisherBase;
+  logger: Logger_2;
+  discovery: PluginEndpointDiscovery;
+  config: Config;
+  cache: PluginCacheManager;
+};
+
+// Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export type RouterOptions =
+  | RecommendedDeploymentOptions
+  | OutOfTheBoxDeploymentOptions;
+
 // Warning: (ae-missing-release-tag) "TechDocsCollatorOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
diff --git a/plugins/techdocs-backend/src/index.ts b/plugins/techdocs-backend/src/index.ts
index 334369cb5f..12e7df1e9e 100644
--- a/plugins/techdocs-backend/src/index.ts
+++ b/plugins/techdocs-backend/src/index.ts
@@ -21,7 +21,11 @@
  */
 
 export { createRouter } from './service';
-export type { RouterOptions } from './service';
+export type {
+  RouterOptions,
+  RecommendedDeploymentOptions,
+  OutOfTheBoxDeploymentOptions,
+} from './service';
 
 export { DefaultTechDocsCollator } from './search';
 export type { TechDocsCollatorOptions } from './search';
diff --git a/plugins/techdocs-backend/src/service/index.ts b/plugins/techdocs-backend/src/service/index.ts
index 8727bd620b..0065e33a2a 100644
--- a/plugins/techdocs-backend/src/service/index.ts
+++ b/plugins/techdocs-backend/src/service/index.ts
@@ -15,4 +15,8 @@
  */
 
 export { createRouter } from './router';
-export type { RouterOptions } from './router';
+export type {
+  RouterOptions,
+  RecommendedDeploymentOptions,
+  OutOfTheBoxDeploymentOptions,
+} from './router';
diff --git a/plugins/techdocs-backend/src/service/router.ts b/plugins/techdocs-backend/src/service/router.ts
index fcb7a17757..141ce93f79 100644
--- a/plugins/techdocs-backend/src/service/router.ts
+++ b/plugins/techdocs-backend/src/service/router.ts
@@ -40,7 +40,7 @@ import { CachedEntityLoader } from './CachedEntityLoader';
  * All of the required dependencies for running TechDocs in the "out-of-the-box"
  * deployment configuration (prepare/generate/publish all in the Backend).
  */
-type OutOfTheBoxDeploymentOptions = {
+export type OutOfTheBoxDeploymentOptions = {
   preparers: PreparerBuilder;
   generators: GeneratorBuilder;
   publisher: PublisherBase;
@@ -55,7 +55,7 @@ type OutOfTheBoxDeploymentOptions = {
  * Required dependencies for running TechDocs in the "recommended" deployment
  * configuration (prepare/generate handled externally in CI/CD).
  */
-type RecommendedDeploymentOptions = {
+export type RecommendedDeploymentOptions = {
   publisher: PublisherBase;
   logger: Logger;
   discovery: PluginEndpointDiscovery;