feat(techdocs): rename extension point

Signed-off-by: Phil Kuang <pkuang@factset.com>

plugins/techdocs-backend/api-report.md

@@ -7,7 +7,7 @@ import { CatalogApi } from '@backstage/catalog-client';
 import { CatalogClient } from '@backstage/catalog-client';
 import { Config } from '@backstage/config';
 import { DefaultTechDocsCollatorFactory as DefaultTechDocsCollatorFactory_2 } from '@backstage/plugin-search-backend-module-techdocs';
-import { DocsBuildStrategy } from '@backstage/plugin-techdocs-node';
+import { DocsBuildStrategy as DocsBuildStrategy_2 } from '@backstage/plugin-techdocs-node';
 import express from 'express';
 import { GeneratorBuilder } from '@backstage/plugin-techdocs-node';
 import { Knex } from 'knex';
@@ -17,9 +17,9 @@ import { PluginCacheManager } from '@backstage/backend-common';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
 import { PreparerBuilder } from '@backstage/plugin-techdocs-node';
 import { PublisherBase } from '@backstage/plugin-techdocs-node';
-import { ShouldBuildParameters } from '@backstage/plugin-techdocs-node';
+import { ShouldBuildParameters as ShouldBuildParameters_2 } from '@backstage/plugin-techdocs-node';
 import type { TechDocsCollatorFactoryOptions as TechDocsCollatorFactoryOptions_2 } from '@backstage/plugin-search-backend-module-techdocs';
-import { TechDocsDocument } from '@backstage/plugin-techdocs-node';
+import { TechDocsDocument as TechDocsDocument_2 } from '@backstage/plugin-techdocs-node';
 import { TokenManager } from '@backstage/backend-common';
 import * as winston from 'winston';
 
@@ -34,7 +34,7 @@ export class DefaultTechDocsCollator {
     args: Record<string, string>,
   ): string;
   // (undocumented)
-  execute(): Promise<TechDocsDocument[]>;
+  execute(): Promise<TechDocsDocument_2[]>;
   // (undocumented)
   static fromConfig(
     config: Config,
@@ -49,7 +49,8 @@ export class DefaultTechDocsCollator {
 // @public @deprecated (undocumented)
 export const DefaultTechDocsCollatorFactory: typeof DefaultTechDocsCollatorFactory_2;
 
-export { DocsBuildStrategy };
+// @public @deprecated (undocumented)
+export type DocsBuildStrategy = DocsBuildStrategy_2;
 
 // @public
 export type OutOfTheBoxDeploymentOptions = {
@@ -61,7 +62,7 @@ export type OutOfTheBoxDeploymentOptions = {
   database?: Knex;
   config: Config;
   cache: PluginCacheManager;
-  docsBuildStrategy?: DocsBuildStrategy;
+  docsBuildStrategy?: DocsBuildStrategy_2;
   buildLogTransport?: winston.transport;
   catalogClient?: CatalogClient;
 };
@@ -73,7 +74,7 @@ export type RecommendedDeploymentOptions = {
   discovery: PluginEndpointDiscovery;
   config: Config;
   cache: PluginCacheManager;
-  docsBuildStrategy?: DocsBuildStrategy;
+  docsBuildStrategy?: DocsBuildStrategy_2;
   buildLogTransport?: winston.transport;
   catalogClient?: CatalogClient;
 };
@@ -83,7 +84,8 @@ export type RouterOptions =
   | RecommendedDeploymentOptions
   | OutOfTheBoxDeploymentOptions;
 
-export { ShouldBuildParameters };
+// @public @deprecated (undocumented)
+export type ShouldBuildParameters = ShouldBuildParameters_2;
 
 // @public @deprecated (undocumented)
 export type TechDocsCollatorFactoryOptions = TechDocsCollatorFactoryOptions_2;
@@ -99,7 +101,8 @@ export type TechDocsCollatorOptions = {
   legacyPathCasing?: boolean;
 };
 
-export { TechDocsDocument };
+// @public @deprecated (undocumented)
+export type TechDocsDocument = TechDocsDocument_2;
 
 export * from '@backstage/plugin-techdocs-node';
 ```

plugins/techdocs-backend/src/index.ts

@@ -20,6 +20,12 @@
  * @packageDocumentation
  */
 
+import {
+  DocsBuildStrategy as _DocsBuildStrategy,
+  ShouldBuildParameters as _ShouldBuildParameters,
+  TechDocsDocument as _TechDocsDocument,
+} from '@backstage/plugin-techdocs-node';
+
 export { createRouter } from './service';
 export type {
   RouterOptions,
@@ -37,12 +43,19 @@ export type {
 } from './search';
 
 /**
- * @deprecated Use directly from @backstage/plugin-techdocs-node
+ * @public
+ * @deprecated import from `@backstage/plugin-techdocs-node` instead
  */
-export type {
-  DocsBuildStrategy,
-  ShouldBuildParameters,
-  TechDocsDocument,
-} from '@backstage/plugin-techdocs-node';
+export type DocsBuildStrategy = _DocsBuildStrategy;
+/**
+ * @public
+ * @deprecated import from `@backstage/plugin-techdocs-node` instead
+ */
+export type ShouldBuildParameters = _ShouldBuildParameters;
+/**
+ * @public
+ * @deprecated import from `@backstage/plugin-techdocs-node` instead
+ */
+export type TechDocsDocument = _TechDocsDocument;
 
 export * from '@backstage/plugin-techdocs-node';

plugins/techdocs-backend/src/plugin.ts

@@ -29,7 +29,7 @@ import {
   Preparers,
   Generators,
   Publisher,
-  techdocsBuildStrategyExtensionPoint,
+  techdocsBuildsExtensionPoint,
 } from '@backstage/plugin-techdocs-node';
 import Docker from 'dockerode';
 import { createRouter } from '@backstage/plugin-techdocs-backend';
@@ -42,7 +42,7 @@ export const techdocsPlugin = createBackendPlugin({
   pluginId: 'techdocs',
   register(env) {
     let docsBuildStrategy: DocsBuildStrategy | undefined;
-    env.registerExtensionPoint(techdocsBuildStrategyExtensionPoint, {
+    env.registerExtensionPoint(techdocsBuildsExtensionPoint, {
       setBuildStrategy(buildStrategy: DocsBuildStrategy) {
         if (docsBuildStrategy) {
           throw new Error('DocsBuildStrategy may only be set once');

plugins/techdocs-node/api-report.md

@@ -242,13 +242,13 @@ export type ShouldBuildParameters = {
 export type SupportedGeneratorKey = 'techdocs' | string;
 
 // @public
-export interface TechdocsBuildStrategyExtensionPoint {
+export interface TechdocsBuildsExtensionPoint {
   // (undocumented)
   setBuildStrategy(buildStrategy: DocsBuildStrategy): void;
 }
 
 // @public
-export const techdocsBuildStrategyExtensionPoint: ExtensionPoint<TechdocsBuildStrategyExtensionPoint>;
+export const techdocsBuildsExtensionPoint: ExtensionPoint<TechdocsBuildsExtensionPoint>;
 
 // @public
 export interface TechDocsDocument extends IndexableDocument {

plugins/techdocs-node/src/extensions.ts

@@ -17,20 +17,20 @@ import { createExtensionPoint } from '@backstage/backend-plugin-api';
 import { DocsBuildStrategy } from './techdocsTypes';
 
 /**
- * Extension point type for setting a custom build strategy.
+ * Extension point type for configuring Techdocs builds.
  *
  * @public
  */
-export interface TechdocsBuildStrategyExtensionPoint {
+export interface TechdocsBuildsExtensionPoint {
   setBuildStrategy(buildStrategy: DocsBuildStrategy): void;
 }
 
 /**
- * Extension point for setting a custom build strategy.
+ * Extension point for configuring Techdocs builds.
  *
  * @public
  */
-export const techdocsBuildStrategyExtensionPoint =
-  createExtensionPoint<TechdocsBuildStrategyExtensionPoint>({
-    id: 'techdocs.buildStrategy',
+export const techdocsBuildsExtensionPoint =
+  createExtensionPoint<TechdocsBuildsExtensionPoint>({
+    id: 'techdocs.builds',
   });

plugins/techdocs-node/src/index.ts

@@ -24,6 +24,6 @@ export * from './stages';
 export * from './helpers';
 export * from './techdocsTypes';
 export {
-  techdocsBuildStrategyExtensionPoint,
-  type TechdocsBuildStrategyExtensionPoint,
+  techdocsBuildsExtensionPoint,
+  type TechdocsBuildsExtensionPoint,
 } from './extensions';