Exporting interface and adding docs

This makes the api reporter happy, with good reason

Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>

plugins/techdocs-backend/api-report.md

@@ -42,6 +42,12 @@ export class DefaultTechDocsCollator implements DocumentCollator {
   readonly visibilityPermission: Permission;
 }
 
+// @public
+export interface DocsBuildStrategy {
+  // (undocumented)
+  shouldBuild(entity: Entity): Promise<boolean>;
+}
+
 // @public
 export type OutOfTheBoxDeploymentOptions = {
   preparers: PreparerBuilder;
@@ -84,8 +90,4 @@ export type TechDocsCollatorOptions = {
 export { TechDocsDocument };
 
 export * from '@backstage/techdocs-common';
-
-// Warnings were encountered during analysis:
-//
-// src/service/router.d.ts:24:5 - (ae-forgotten-export) The symbol "DocsBuildStrategy" needs to be exported by the entry point index.d.ts
 ```

plugins/techdocs-backend/src/index.ts

@@ -25,6 +25,7 @@ export type {
   RouterOptions,
   RecommendedDeploymentOptions,
   OutOfTheBoxDeploymentOptions,
+  DocsBuildStrategy,
 } from './service';
 
 export { DefaultTechDocsCollator } from './search';

plugins/techdocs-backend/src/service/DocsBuildStrategy.ts

@@ -16,6 +16,11 @@
 import { Entity } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 
+/**
+ * A strategy for when to build TechDocs locally, and when to skip building TechDocs (allowing for an external build)
+ *
+ * @public
+ */
 export interface DocsBuildStrategy {
   shouldBuild(entity: Entity): Promise<boolean>;
 }

plugins/techdocs-backend/src/service/index.ts

@@ -20,3 +20,4 @@ export type {
   RecommendedDeploymentOptions,
   OutOfTheBoxDeploymentOptions,
 } from './router';
+export type { DocsBuildStrategy } from './DocsBuildStrategy';