@backstage/plugin-search-backend-module-techdocs 0.2.3-next.1 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @backstage/plugin-search-backend-module-techdocs
 
+## 0.3.0
+
+### Minor Changes
+
+- 07a7fc2: Refactor TechDocs collator, enable clients to override the mkdocs search index transformer, so that per document properties (like tags) can be added to Backstage search index.
+
+### Patch Changes
+
+- 4b60e0c: Remove extension points from `/alpha` export, they're available from the main package already
+- 094eaa3: Remove references to in-repo backend-common
+- 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
+- 2f88f88: Updated backend installation instructions.
+- Updated dependencies
+  - @backstage/plugin-search-backend-node@1.3.3
+  - @backstage/plugin-catalog-node@1.13.1
+  - @backstage/plugin-techdocs-node@1.12.12
+  - @backstage/catalog-client@1.7.1
+  - @backstage/backend-plugin-api@1.0.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/plugin-catalog-common@1.1.0
+  - @backstage/plugin-permission-common@0.8.1
+  - @backstage/plugin-search-common@1.2.14
+
+## 0.2.3-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.13.1-next.1
+  - @backstage/plugin-techdocs-node@1.12.12-next.2
+  - @backstage/catalog-client@1.7.1-next.0
+  - @backstage/backend-plugin-api@1.0.1-next.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/plugin-catalog-common@1.1.0
+  - @backstage/plugin-permission-common@0.8.1
+  - @backstage/plugin-search-backend-node@1.3.3-next.2
+  - @backstage/plugin-search-common@1.2.14
+
 ## 0.2.3-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-techdocs__alpha",
-  "version": "0.2.3-next.1",
+  "version": "0.3.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -2,77 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var backendPluginApi = require('@backstage/backend-plugin-api');
-var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
-var pluginSearchBackendModuleTechdocs = require('@backstage/plugin-search-backend-module-techdocs');
-var alpha$2 = require('@backstage/plugin-search-backend-node/alpha');
+var module$1 = require('./module.cjs.js');
 
-const techdocsCollatorEntityTransformerExtensionPoint = backendPluginApi.createExtensionPoint({
-  id: "search.techdocsCollator.transformer"
-});
-var alpha = backendPluginApi.createBackendModule({
-  pluginId: "search",
-  moduleId: "techdocs-collator",
-  register(env) {
-    let transformer;
-    env.registerExtensionPoint(
-      techdocsCollatorEntityTransformerExtensionPoint,
-      {
-        setTransformer(newTransformer) {
-          if (transformer) {
-            throw new Error(
-              "TechDocs collator entity transformer may only be set once"
-            );
-          }
-          transformer = newTransformer;
-        }
-      }
-    );
-    env.registerInit({
-      deps: {
-        config: backendPluginApi.coreServices.rootConfig,
-        logger: backendPluginApi.coreServices.logger,
-        auth: backendPluginApi.coreServices.auth,
-        httpAuth: backendPluginApi.coreServices.httpAuth,
-        discovery: backendPluginApi.coreServices.discovery,
-        scheduler: backendPluginApi.coreServices.scheduler,
-        catalog: alpha$1.catalogServiceRef,
-        indexRegistry: alpha$2.searchIndexRegistryExtensionPoint
-      },
-      async init({
-        config,
-        logger,
-        auth,
-        httpAuth,
-        discovery,
-        scheduler,
-        catalog,
-        indexRegistry
-      }) {
-        const defaultSchedule = {
-          frequency: { minutes: 10 },
-          timeout: { minutes: 15 },
-          initialDelay: { seconds: 3 }
-        };
-        const schedule = config.has("search.collators.techdocs.schedule") ? backendPluginApi.readSchedulerServiceTaskScheduleDefinitionFromConfig(
-          config.getConfig("search.collators.techdocs.schedule")
-        ) : defaultSchedule;
-        indexRegistry.addCollator({
-          schedule: scheduler.createScheduledTaskRunner(schedule),
-          factory: pluginSearchBackendModuleTechdocs.DefaultTechDocsCollatorFactory.fromConfig(config, {
-            discovery,
-            auth,
-            httpAuth,
-            logger,
-            catalogClient: catalog,
-            entityTransformer: transformer
-          })
-        });
-      }
-    });
-  }
-});
+const _feature = module$1.default;
 
-exports.default = alpha;
-exports.techdocsCollatorEntityTransformerExtensionPoint = techdocsCollatorEntityTransformerExtensionPoint;
+exports.default = _feature;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * @packageDocumentation\n * A module for the search backend that exports TechDocs modules.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n  DefaultTechDocsCollatorFactory,\n  TechDocsCollatorEntityTransformer,\n} from '@backstage/plugin-search-backend-module-techdocs';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\n/** @alpha */\nexport interface TechDocsCollatorEntityTransformerExtensionPoint {\n  setTransformer(transformer: TechDocsCollatorEntityTransformer): void;\n}\n\n/**\n * Extension point used to customize the TechDocs collator entity transformer.\n *\n * @alpha\n */\nexport const techdocsCollatorEntityTransformerExtensionPoint =\n  createExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>({\n    id: 'search.techdocsCollator.transformer',\n  });\n\n/**\n * @alpha\n * Search backend module for the TechDocs index.\n */\nexport default createBackendModule({\n  pluginId: 'search',\n  moduleId: 'techdocs-collator',\n  register(env) {\n    let transformer: TechDocsCollatorEntityTransformer | undefined;\n\n    env.registerExtensionPoint(\n      techdocsCollatorEntityTransformerExtensionPoint,\n      {\n        setTransformer(newTransformer) {\n          if (transformer) {\n            throw new Error(\n              'TechDocs collator entity transformer may only be set once',\n            );\n          }\n          transformer = newTransformer;\n        },\n      },\n    );\n\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        auth: coreServices.auth,\n        httpAuth: coreServices.httpAuth,\n        discovery: coreServices.discovery,\n        scheduler: coreServices.scheduler,\n        catalog: catalogServiceRef,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n      },\n      async init({\n        config,\n        logger,\n        auth,\n        httpAuth,\n        discovery,\n        scheduler,\n        catalog,\n        indexRegistry,\n      }) {\n        const defaultSchedule = {\n          frequency: { minutes: 10 },\n          timeout: { minutes: 15 },\n          initialDelay: { seconds: 3 },\n        };\n\n        const schedule = config.has('search.collators.techdocs.schedule')\n          ? readSchedulerServiceTaskScheduleDefinitionFromConfig(\n              config.getConfig('search.collators.techdocs.schedule'),\n            )\n          : defaultSchedule;\n\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(schedule),\n          factory: DefaultTechDocsCollatorFactory.fromConfig(config, {\n            discovery,\n            auth,\n            httpAuth,\n            logger,\n            catalogClient: catalog,\n            entityTransformer: transformer,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readSchedulerServiceTaskScheduleDefinitionFromConfig","DefaultTechDocsCollatorFactory"],"mappings":";;;;;;;;;AA4CO,MAAM,kDACXA,qCAAsE,CAAA;AAAA,EACpE,EAAI,EAAA,qCAAA;AACN,CAAC,EAAA;AAMH,YAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,WAAA,CAAA;AAEJ,IAAI,GAAA,CAAA,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,eAAe,cAAgB,EAAA;AAC7B,UAAA,IAAI,WAAa,EAAA;AACf,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,2DAAA;AAAA,aACF,CAAA;AAAA,WACF;AACA,UAAc,WAAA,GAAA,cAAA,CAAA;AAAA,SAChB;AAAA,OACF;AAAA,KACF,CAAA;AAEA,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAS,EAAAC,yBAAA;AAAA,QACT,aAAe,EAAAC,yCAAA;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,OAAA;AAAA,QACA,aAAA;AAAA,OACC,EAAA;AACD,QAAA,MAAM,eAAkB,GAAA;AAAA,UACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,SAC7B,CAAA;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,oCAAoC,CAC5D,GAAAC,qEAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC,CAAA;AAAA,SAEvD,GAAA,eAAA,CAAA;AAEJ,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,QAAA,EAAU,SAAU,CAAA,yBAAA,CAA0B,QAAQ,CAAA;AAAA,UACtD,OAAA,EAASC,gEAA+B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,YACzD,SAAA;AAAA,YACA,IAAA;AAAA,YACA,QAAA;AAAA,YACA,MAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,YACf,iBAAmB,EAAA,WAAA;AAAA,WACpB,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { default as feature } from './module';\n\n/** @alpha */\nconst _feature = feature;\nexport default _feature;\n"],"names":["feature"],"mappings":";;;;;;AAmBA,MAAM,QAAW,GAAAA;;;;"}

package/dist/alpha.d.ts

@@ -1,20 +1,6 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { TechDocsCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-techdocs';
 
 /** @alpha */
-interface TechDocsCollatorEntityTransformerExtensionPoint {
-    setTransformer(transformer: TechDocsCollatorEntityTransformer): void;
-}
-/**
- * Extension point used to customize the TechDocs collator entity transformer.
- *
- * @alpha
- */
-declare const techdocsCollatorEntityTransformerExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>;
-/**
- * @alpha
- * Search backend module for the TechDocs index.
- */
-declare const _default: _backstage_backend_plugin_api.BackendFeature;
+declare const _feature: _backstage_backend_plugin_api.BackendFeature;
 
-export { type TechDocsCollatorEntityTransformerExtensionPoint, _default as default, techdocsCollatorEntityTransformerExtensionPoint };
+export { _feature as default };

package/dist/collators/DefaultTechDocsCollatorFactory.cjs.js

@@ -0,0 +1,183 @@
+'use strict';
+
+var backendCommon = require('@backstage/backend-common');
+var catalogClient = require('@backstage/catalog-client');
+var catalogModel = require('@backstage/catalog-model');
+var alpha = require('@backstage/plugin-catalog-common/alpha');
+var fetch = require('node-fetch');
+var pLimit = require('p-limit');
+var stream = require('stream');
+var defaultTechDocsCollatorEntityTransformer = require('./defaultTechDocsCollatorEntityTransformer.cjs.js');
+var defaultTechDocsCollatorDocumentTransformer = require('./defaultTechDocsCollatorDocumentTransformer.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
+var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
+
+class DefaultTechDocsCollatorFactory {
+  type = "techdocs";
+  visibilityPermission = alpha.catalogEntityReadPermission;
+  discovery;
+  locationTemplate;
+  logger;
+  auth;
+  catalogClient;
+  parallelismLimit;
+  legacyPathCasing;
+  entityTransformer;
+  documentTransformer;
+  constructor(options) {
+    this.discovery = options.discovery;
+    this.locationTemplate = options.locationTemplate || "/docs/:namespace/:kind/:name/:path";
+    this.logger = options.logger.child({ documentType: this.type });
+    this.catalogClient = options.catalogClient || new catalogClient.CatalogClient({ discoveryApi: options.discovery });
+    this.parallelismLimit = options.parallelismLimit ?? 10;
+    this.legacyPathCasing = options.legacyPathCasing ?? false;
+    this.entityTransformer = options.entityTransformer ?? (() => ({}));
+    this.documentTransformer = options.documentTransformer ?? (() => ({}));
+    this.auth = backendCommon.createLegacyAuthAdapters({
+      auth: options.auth,
+      discovery: options.discovery,
+      tokenManager: options.tokenManager
+    }).auth;
+  }
+  static fromConfig(config, options) {
+    const legacyPathCasing = config.getOptionalBoolean(
+      "techdocs.legacyUseCaseSensitiveTripletPaths"
+    ) || false;
+    const locationTemplate = config.getOptionalString(
+      "search.collators.techdocs.locationTemplate"
+    );
+    const parallelismLimit = config.getOptionalNumber(
+      "search.collators.techdocs.parallelismLimit"
+    );
+    return new DefaultTechDocsCollatorFactory({
+      ...options,
+      locationTemplate,
+      parallelismLimit,
+      legacyPathCasing
+    });
+  }
+  async getCollator() {
+    return stream.Readable.from(this.execute());
+  }
+  async *execute() {
+    const limit = pLimit__default.default(this.parallelismLimit);
+    const techDocsBaseUrl = await this.discovery.getBaseUrl("techdocs");
+    let entitiesRetrieved = 0;
+    let moreEntitiesToGet = true;
+    const batchSize = this.parallelismLimit * 50;
+    while (moreEntitiesToGet) {
+      const { token: catalogToken } = await this.auth.getPluginRequestToken({
+        onBehalfOf: await this.auth.getOwnServiceCredentials(),
+        targetPluginId: "catalog"
+      });
+      const entities = (await this.catalogClient.getEntities(
+        {
+          filter: {
+            "metadata.annotations.backstage.io/techdocs-ref": catalogClient.CATALOG_FILTER_EXISTS
+          },
+          limit: batchSize,
+          offset: entitiesRetrieved
+        },
+        { token: catalogToken }
+      )).items;
+      moreEntitiesToGet = entities.length === batchSize;
+      entitiesRetrieved += entities.length;
+      const docPromises = entities.filter((it) => it.metadata?.annotations?.["backstage.io/techdocs-ref"]).map(
+        (entity) => limit(async () => {
+          const entityInfo = DefaultTechDocsCollatorFactory.handleEntityInfoCasing(
+            this.legacyPathCasing,
+            {
+              kind: entity.kind,
+              namespace: entity.metadata.namespace || "default",
+              name: entity.metadata.name
+            }
+          );
+          try {
+            const { token: techdocsToken } = await this.auth.getPluginRequestToken({
+              onBehalfOf: await this.auth.getOwnServiceCredentials(),
+              targetPluginId: "techdocs"
+            });
+            const searchIndexResponse = await fetch__default.default(
+              DefaultTechDocsCollatorFactory.constructDocsIndexUrl(
+                techDocsBaseUrl,
+                entityInfo
+              ),
+              {
+                headers: {
+                  Authorization: `Bearer ${techdocsToken}`
+                }
+              }
+            );
+            const searchIndex = await Promise.race([
+              searchIndexResponse.json(),
+              new Promise((_resolve, reject) => {
+                setTimeout(() => {
+                  reject("Could not parse JSON in 5 seconds.");
+                }, 5e3);
+              })
+            ]);
+            return searchIndex.docs.map((doc) => ({
+              ...defaultTechDocsCollatorEntityTransformer.defaultTechDocsCollatorEntityTransformer(entity),
+              ...defaultTechDocsCollatorDocumentTransformer.defaultTechDocsCollatorDocumentTransformer(doc),
+              ...this.entityTransformer(entity),
+              ...this.documentTransformer(doc),
+              location: this.applyArgsToFormat(
+                this.locationTemplate || "/docs/:namespace/:kind/:name/:path",
+                {
+                  ...entityInfo,
+                  path: doc.location
+                }
+              ),
+              ...entityInfo,
+              entityTitle: entity.metadata.title,
+              componentType: entity.spec?.type?.toString() || "other",
+              lifecycle: entity.spec?.lifecycle || "",
+              owner: getSimpleEntityOwnerString(entity),
+              authorization: {
+                resourceRef: catalogModel.stringifyEntityRef(entity)
+              }
+            }));
+          } catch (e) {
+            this.logger.debug(
+              `Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,
+              e
+            );
+            return [];
+          }
+        })
+      );
+      yield* (await Promise.all(docPromises)).flat();
+    }
+  }
+  applyArgsToFormat(format, args) {
+    let formatted = format;
+    for (const [key, value] of Object.entries(args)) {
+      formatted = formatted.replace(`:${key}`, value);
+    }
+    return formatted;
+  }
+  static constructDocsIndexUrl(techDocsBaseUrl, entityInfo) {
+    return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;
+  }
+  static handleEntityInfoCasing(legacyPaths, entityInfo) {
+    return legacyPaths ? entityInfo : Object.entries(entityInfo).reduce((acc, [key, value]) => {
+      return { ...acc, [key]: value.toLocaleLowerCase("en-US") };
+    }, {});
+  }
+}
+function getSimpleEntityOwnerString(entity) {
+  if (entity.relations) {
+    const owner = entity.relations.find((r) => r.type === catalogModel.RELATION_OWNED_BY);
+    if (owner) {
+      const { name } = catalogModel.parseEntityRef(owner.targetRef);
+      return name;
+    }
+  }
+  return "";
+}
+
+exports.DefaultTechDocsCollatorFactory = DefaultTechDocsCollatorFactory;
+//# sourceMappingURL=DefaultTechDocsCollatorFactory.cjs.js.map

package/dist/collators/DefaultTechDocsCollatorFactory.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultTechDocsCollatorFactory.cjs.js","sources":["../../src/collators/DefaultTechDocsCollatorFactory.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createLegacyAuthAdapters,\n  TokenManager,\n} from '@backstage/backend-common';\nimport {\n  CATALOG_FILTER_EXISTS,\n  CatalogApi,\n  CatalogClient,\n} from '@backstage/catalog-client';\nimport {\n  Entity,\n  parseEntityRef,\n  RELATION_OWNED_BY,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { TechDocsDocument } from '@backstage/plugin-techdocs-node';\nimport fetch from 'node-fetch';\nimport pLimit from 'p-limit';\nimport { Readable } from 'stream';\nimport { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\nimport {\n  MkSearchIndexDoc,\n  TechDocsCollatorDocumentTransformer,\n} from './TechDocsCollatorDocumentTransformer';\nimport { defaultTechDocsCollatorEntityTransformer } from './defaultTechDocsCollatorEntityTransformer';\nimport { defaultTechDocsCollatorDocumentTransformer } from './defaultTechDocsCollatorDocumentTransformer';\nimport {\n  AuthService,\n  DiscoveryService,\n  HttpAuthService,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\n\n/**\n * Options to configure the TechDocs collator factory\n *\n * @public\n * @deprecated This type is deprecated along with the {@link DefaultTechDocsCollatorFactory}.\n */\nexport type TechDocsCollatorFactoryOptions = {\n  discovery: DiscoveryService;\n  logger: LoggerService;\n  tokenManager?: TokenManager;\n  auth?: AuthService;\n  httpAuth?: HttpAuthService;\n  locationTemplate?: string;\n  catalogClient?: CatalogApi;\n  parallelismLimit?: number;\n  legacyPathCasing?: boolean;\n  entityTransformer?: TechDocsCollatorEntityTransformer;\n  documentTransformer?: TechDocsCollatorDocumentTransformer;\n};\n\ntype EntityInfo = {\n  name: string;\n  namespace: string;\n  kind: string;\n};\n\n/**\n * A search collator factory responsible for gathering and transforming\n * TechDocs documents.\n *\n * @public\n * @deprecated Migrate to the {@link https://backstage.io/docs/backend-system/building-backends/migrating | new backend system} and install this collator via module instead (see {@link https://github.com/backstage/backstage/blob/nbs10/search-deprecate-create-router/plugins/search-backend-module-techdocs/README.md#installation | here} for more installation details).\n */\nexport class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {\n  public readonly type: string = 'techdocs';\n  public readonly visibilityPermission: Permission =\n    catalogEntityReadPermission;\n\n  private discovery: DiscoveryService;\n  private locationTemplate: string;\n  private readonly logger: LoggerService;\n  private readonly auth: AuthService;\n  private readonly catalogClient: CatalogApi;\n  private readonly parallelismLimit: number;\n  private readonly legacyPathCasing: boolean;\n  private entityTransformer: TechDocsCollatorEntityTransformer;\n  private documentTransformer: TechDocsCollatorDocumentTransformer;\n\n  private constructor(options: TechDocsCollatorFactoryOptions) {\n    this.discovery = options.discovery;\n    this.locationTemplate =\n      options.locationTemplate || '/docs/:namespace/:kind/:name/:path';\n    this.logger = options.logger.child({ documentType: this.type });\n    this.catalogClient =\n      options.catalogClient ||\n      new CatalogClient({ discoveryApi: options.discovery });\n    this.parallelismLimit = options.parallelismLimit ?? 10;\n    this.legacyPathCasing = options.legacyPathCasing ?? false;\n    this.entityTransformer = options.entityTransformer ?? (() => ({}));\n    this.documentTransformer = options.documentTransformer ?? (() => ({}));\n\n    this.auth = createLegacyAuthAdapters({\n      auth: options.auth,\n      discovery: options.discovery,\n      tokenManager: options.tokenManager,\n    }).auth;\n  }\n\n  static fromConfig(config: Config, options: TechDocsCollatorFactoryOptions) {\n    const legacyPathCasing =\n      config.getOptionalBoolean(\n        'techdocs.legacyUseCaseSensitiveTripletPaths',\n      ) || false;\n    const locationTemplate = config.getOptionalString(\n      'search.collators.techdocs.locationTemplate',\n    );\n    const parallelismLimit = config.getOptionalNumber(\n      'search.collators.techdocs.parallelismLimit',\n    );\n    return new DefaultTechDocsCollatorFactory({\n      ...options,\n      locationTemplate,\n      parallelismLimit,\n      legacyPathCasing,\n    });\n  }\n\n  async getCollator(): Promise<Readable> {\n    return Readable.from(this.execute());\n  }\n\n  private async *execute(): AsyncGenerator<TechDocsDocument, void, undefined> {\n    const limit = pLimit(this.parallelismLimit);\n    const techDocsBaseUrl = await this.discovery.getBaseUrl('techdocs');\n\n    let entitiesRetrieved = 0;\n    let moreEntitiesToGet = true;\n\n    // Offset/limit pagination is used on the Catalog Client in order to\n    // limit (and allow some control over) memory used by the search backend\n    // at index-time. The batchSize is calculated as a factor of the given\n    // parallelism limit to simplify configuration.\n    const batchSize = this.parallelismLimit * 50;\n    while (moreEntitiesToGet) {\n      const { token: catalogToken } = await this.auth.getPluginRequestToken({\n        onBehalfOf: await this.auth.getOwnServiceCredentials(),\n        targetPluginId: 'catalog',\n      });\n\n      const entities = (\n        await this.catalogClient.getEntities(\n          {\n            filter: {\n              'metadata.annotations.backstage.io/techdocs-ref':\n                CATALOG_FILTER_EXISTS,\n            },\n            limit: batchSize,\n            offset: entitiesRetrieved,\n          },\n          { token: catalogToken },\n        )\n      ).items;\n\n      // Control looping through entity batches.\n      moreEntitiesToGet = entities.length === batchSize;\n      entitiesRetrieved += entities.length;\n\n      const docPromises = entities\n        .filter(it => it.metadata?.annotations?.['backstage.io/techdocs-ref'])\n        .map((entity: Entity) =>\n          limit(async (): Promise<TechDocsDocument[]> => {\n            const entityInfo =\n              DefaultTechDocsCollatorFactory.handleEntityInfoCasing(\n                this.legacyPathCasing,\n                {\n                  kind: entity.kind,\n                  namespace: entity.metadata.namespace || 'default',\n                  name: entity.metadata.name,\n                },\n              );\n\n            try {\n              const { token: techdocsToken } =\n                await this.auth.getPluginRequestToken({\n                  onBehalfOf: await this.auth.getOwnServiceCredentials(),\n                  targetPluginId: 'techdocs',\n                });\n\n              const searchIndexResponse = await fetch(\n                DefaultTechDocsCollatorFactory.constructDocsIndexUrl(\n                  techDocsBaseUrl,\n                  entityInfo,\n                ),\n                {\n                  headers: {\n                    Authorization: `Bearer ${techdocsToken}`,\n                  },\n                },\n              );\n\n              // todo(@backstage/techdocs-core): remove Promise.race() when node-fetch is 3.x+\n              // workaround for fetch().json() hanging in node-fetch@2.x.x, fixed in 3.x.x\n              // https://github.com/node-fetch/node-fetch/issues/665\n              const searchIndex = await Promise.race([\n                searchIndexResponse.json(),\n                new Promise((_resolve, reject) => {\n                  setTimeout(() => {\n                    reject('Could not parse JSON in 5 seconds.');\n                  }, 5000);\n                }),\n              ]);\n\n              return searchIndex.docs.map((doc: MkSearchIndexDoc) => ({\n                ...defaultTechDocsCollatorEntityTransformer(entity),\n                ...defaultTechDocsCollatorDocumentTransformer(doc),\n                ...this.entityTransformer(entity),\n                ...this.documentTransformer(doc),\n                location: this.applyArgsToFormat(\n                  this.locationTemplate || '/docs/:namespace/:kind/:name/:path',\n                  {\n                    ...entityInfo,\n                    path: doc.location,\n                  },\n                ),\n                ...entityInfo,\n                entityTitle: entity.metadata.title,\n                componentType: entity.spec?.type?.toString() || 'other',\n                lifecycle: (entity.spec?.lifecycle as string) || '',\n                owner: getSimpleEntityOwnerString(entity),\n                authorization: {\n                  resourceRef: stringifyEntityRef(entity),\n                },\n              }));\n            } catch (e) {\n              this.logger.debug(\n                `Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,\n                e,\n              );\n              return [];\n            }\n          }),\n        );\n      yield* (await Promise.all(docPromises)).flat();\n    }\n  }\n\n  private applyArgsToFormat(\n    format: string,\n    args: Record<string, string>,\n  ): string {\n    let formatted = format;\n    for (const [key, value] of Object.entries(args)) {\n      formatted = formatted.replace(`:${key}`, value);\n    }\n    return formatted;\n  }\n\n  private static constructDocsIndexUrl(\n    techDocsBaseUrl: string,\n    entityInfo: { kind: string; namespace: string; name: string },\n  ) {\n    return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;\n  }\n\n  private static handleEntityInfoCasing(\n    legacyPaths: boolean,\n    entityInfo: EntityInfo,\n  ): EntityInfo {\n    return legacyPaths\n      ? entityInfo\n      : Object.entries(entityInfo).reduce((acc, [key, value]) => {\n          return { ...acc, [key]: value.toLocaleLowerCase('en-US') };\n        }, {} as EntityInfo);\n  }\n}\n\nfunction getSimpleEntityOwnerString(entity: Entity): string {\n  if (entity.relations) {\n    const owner = entity.relations.find(r => r.type === RELATION_OWNED_BY);\n    if (owner) {\n      const { name } = parseEntityRef(owner.targetRef);\n      return name;\n    }\n  }\n  return '';\n}\n"],"names":["catalogEntityReadPermission","CatalogClient","createLegacyAuthAdapters","Readable","pLimit","CATALOG_FILTER_EXISTS","fetch","defaultTechDocsCollatorEntityTransformer","defaultTechDocsCollatorDocumentTransformer","stringifyEntityRef","RELATION_OWNED_BY","parseEntityRef"],"mappings":";;;;;;;;;;;;;;;;;AAsFO,MAAM,8BAAkE,CAAA;AAAA,EAC7D,IAAe,GAAA,UAAA,CAAA;AAAA,EACf,oBACd,GAAAA,iCAAA,CAAA;AAAA,EAEM,SAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACS,MAAA,CAAA;AAAA,EACA,IAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACT,iBAAA,CAAA;AAAA,EACA,mBAAA,CAAA;AAAA,EAEA,YAAY,OAAyC,EAAA;AAC3D,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAK,IAAA,CAAA,gBAAA,GACH,QAAQ,gBAAoB,IAAA,oCAAA,CAAA;AAC9B,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC9D,IAAK,IAAA,CAAA,aAAA,GACH,QAAQ,aACR,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,OAAQ,CAAA,SAAA,EAAW,CAAA,CAAA;AACvD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,EAAA,CAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,KAAA,CAAA;AACpD,IAAA,IAAA,CAAK,iBAAoB,GAAA,OAAA,CAAQ,iBAAsB,KAAA,OAAO,EAAC,CAAA,CAAA,CAAA;AAC/D,IAAA,IAAA,CAAK,mBAAsB,GAAA,OAAA,CAAQ,mBAAwB,KAAA,OAAO,EAAC,CAAA,CAAA,CAAA;AAEnE,IAAA,IAAA,CAAK,OAAOC,sCAAyB,CAAA;AAAA,MACnC,MAAM,OAAQ,CAAA,IAAA;AAAA,MACd,WAAW,OAAQ,CAAA,SAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,YAAA;AAAA,KACvB,CAAE,CAAA,IAAA,CAAA;AAAA,GACL;AAAA,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,OAAyC,EAAA;AACzE,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL,6CAAA;AAAA,KACG,IAAA,KAAA,CAAA;AACP,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,OAAO,IAAI,8BAA+B,CAAA;AAAA,MACxC,GAAG,OAAA;AAAA,MACH,gBAAA;AAAA,MACA,gBAAA;AAAA,MACA,gBAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,OAA6D,GAAA;AAC1E,IAAM,MAAA,KAAA,GAAQC,uBAAO,CAAA,IAAA,CAAK,gBAAgB,CAAA,CAAA;AAC1C,IAAA,MAAM,eAAkB,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,UAAU,CAAA,CAAA;AAElE,IAAA,IAAI,iBAAoB,GAAA,CAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA,CAAA;AAMxB,IAAM,MAAA,SAAA,GAAY,KAAK,gBAAmB,GAAA,EAAA,CAAA;AAC1C,IAAA,OAAO,iBAAmB,EAAA;AACxB,MAAA,MAAM,EAAE,KAAO,EAAA,YAAA,KAAiB,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,QACpE,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,QACrD,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA,CAAA;AAED,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,QACvB;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,gDACE,EAAAC,mCAAA;AAAA,WACJ;AAAA,UACA,KAAO,EAAA,SAAA;AAAA,UACP,MAAQ,EAAA,iBAAA;AAAA,SACV;AAAA,QACA,EAAE,OAAO,YAAa,EAAA;AAAA,OAExB,EAAA,KAAA,CAAA;AAGF,MAAA,iBAAA,GAAoB,SAAS,MAAW,KAAA,SAAA,CAAA;AACxC,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA,CAAA;AAE9B,MAAM,MAAA,WAAA,GAAc,SACjB,MAAO,CAAA,CAAA,EAAA,KAAM,GAAG,QAAU,EAAA,WAAA,GAAc,2BAA2B,CAAC,CACpE,CAAA,GAAA;AAAA,QAAI,CAAC,MACJ,KAAA,KAAA,CAAM,YAAyC;AAC7C,UAAA,MAAM,aACJ,8BAA+B,CAAA,sBAAA;AAAA,YAC7B,IAAK,CAAA,gBAAA;AAAA,YACL;AAAA,cACE,MAAM,MAAO,CAAA,IAAA;AAAA,cACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cACxC,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,aACxB;AAAA,WACF,CAAA;AAEF,UAAI,IAAA;AACF,YAAA,MAAM,EAAE,KAAO,EAAA,aAAA,KACb,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,cACpC,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,cACrD,cAAgB,EAAA,UAAA;AAAA,aACjB,CAAA,CAAA;AAEH,YAAA,MAAM,sBAAsB,MAAMC,sBAAA;AAAA,cAChC,8BAA+B,CAAA,qBAAA;AAAA,gBAC7B,eAAA;AAAA,gBACA,UAAA;AAAA,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA;AAAA,kBACP,aAAA,EAAe,UAAU,aAAa,CAAA,CAAA;AAAA,iBACxC;AAAA,eACF;AAAA,aACF,CAAA;AAKA,YAAM,MAAA,WAAA,GAAc,MAAM,OAAA,CAAQ,IAAK,CAAA;AAAA,cACrC,oBAAoB,IAAK,EAAA;AAAA,cACzB,IAAI,OAAA,CAAQ,CAAC,QAAA,EAAU,MAAW,KAAA;AAChC,gBAAA,UAAA,CAAW,MAAM;AACf,kBAAA,MAAA,CAAO,oCAAoC,CAAA,CAAA;AAAA,mBAC1C,GAAI,CAAA,CAAA;AAAA,eACR,CAAA;AAAA,aACF,CAAA,CAAA;AAED,YAAA,OAAO,WAAY,CAAA,IAAA,CAAK,GAAI,CAAA,CAAC,GAA2B,MAAA;AAAA,cACtD,GAAGC,kFAAyC,MAAM,CAAA;AAAA,cAClD,GAAGC,sFAA2C,GAAG,CAAA;AAAA,cACjD,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,cAChC,GAAG,IAAK,CAAA,mBAAA,CAAoB,GAAG,CAAA;AAAA,cAC/B,UAAU,IAAK,CAAA,iBAAA;AAAA,gBACb,KAAK,gBAAoB,IAAA,oCAAA;AAAA,gBACzB;AAAA,kBACE,GAAG,UAAA;AAAA,kBACH,MAAM,GAAI,CAAA,QAAA;AAAA,iBACZ;AAAA,eACF;AAAA,cACA,GAAG,UAAA;AAAA,cACH,WAAA,EAAa,OAAO,QAAS,CAAA,KAAA;AAAA,cAC7B,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,cAChD,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,cACjD,KAAA,EAAO,2BAA2B,MAAM,CAAA;AAAA,cACxC,aAAe,EAAA;AAAA,gBACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,eACxC;AAAA,aACA,CAAA,CAAA,CAAA;AAAA,mBACK,CAAG,EAAA;AACV,YAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,cACV,CAAA,qDAAA,EAAwD,WAAW,SAAS,CAAA,CAAA,EAAI,WAAW,IAAI,CAAA,CAAA,EAAI,WAAW,IAAI,CAAA,CAAA;AAAA,cAClH,CAAA;AAAA,aACF,CAAA;AACA,YAAA,OAAO,EAAC,CAAA;AAAA,WACV;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AACF,MAAA,OAAA,CAAQ,MAAM,OAAA,CAAQ,GAAI,CAAA,WAAW,GAAG,IAAK,EAAA,CAAA;AAAA,KAC/C;AAAA,GACF;AAAA,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA,CAAA;AAChB,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC/C,MAAA,SAAA,GAAY,SAAU,CAAA,OAAA,CAAQ,CAAI,CAAA,EAAA,GAAG,IAAI,KAAK,CAAA,CAAA;AAAA,KAChD;AACA,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEA,OAAe,qBACb,CAAA,eAAA,EACA,UACA,EAAA;AACA,IAAO,OAAA,CAAA,EAAG,eAAe,CAAA,aAAA,EAAgB,UAAW,CAAA,SAAS,IAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,yBAAA,CAAA,CAAA;AAAA,GACrG;AAAA,EAEA,OAAe,sBACb,CAAA,WAAA,EACA,UACY,EAAA;AACZ,IAAA,OAAO,WACH,GAAA,UAAA,GACA,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAE,MAAO,CAAA,CAAC,GAAK,EAAA,CAAC,GAAK,EAAA,KAAK,CAAM,KAAA;AACvD,MAAO,OAAA,EAAE,GAAG,GAAK,EAAA,CAAC,GAAG,GAAG,KAAA,CAAM,iBAAkB,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,KAC3D,EAAG,EAAgB,CAAA,CAAA;AAAA,GACzB;AACF,CAAA;AAEA,SAAS,2BAA2B,MAAwB,EAAA;AAC1D,EAAA,IAAI,OAAO,SAAW,EAAA;AACpB,IAAA,MAAM,QAAQ,MAAO,CAAA,SAAA,CAAU,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAASC,8BAAiB,CAAA,CAAA;AACrE,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,2BAAA,CAAe,MAAM,SAAS,CAAA,CAAA;AAC/C,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,GACF;AACA,EAAO,OAAA,EAAA,CAAA;AACT;;;;"}

package/dist/collators/defaultTechDocsCollatorDocumentTransformer.cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var unescape = require('lodash/unescape');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var unescape__default = /*#__PURE__*/_interopDefaultCompat(unescape);
+
+const defaultTechDocsCollatorDocumentTransformer = (doc) => {
+  return {
+    title: unescape__default.default(doc.title),
+    text: unescape__default.default(doc.text || ""),
+    path: doc.location
+  };
+};
+
+exports.defaultTechDocsCollatorDocumentTransformer = defaultTechDocsCollatorDocumentTransformer;
+//# sourceMappingURL=defaultTechDocsCollatorDocumentTransformer.cjs.js.map

package/dist/collators/defaultTechDocsCollatorDocumentTransformer.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultTechDocsCollatorDocumentTransformer.cjs.js","sources":["../../src/collators/defaultTechDocsCollatorDocumentTransformer.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport unescape from 'lodash/unescape';\nimport {\n  TechDocsCollatorDocumentTransformer,\n  MkSearchIndexDoc,\n} from './TechDocsCollatorDocumentTransformer';\n\n/** @public */\nexport const defaultTechDocsCollatorDocumentTransformer: TechDocsCollatorDocumentTransformer =\n  (doc: MkSearchIndexDoc) => {\n    return {\n      title: unescape(doc.title),\n      text: unescape(doc.text || ''),\n      path: doc.location,\n    };\n  };\n"],"names":["unescape"],"mappings":";;;;;;;;AAsBa,MAAA,0CAAA,GACX,CAAC,GAA0B,KAAA;AACzB,EAAO,OAAA;AAAA,IACL,KAAA,EAAOA,yBAAS,CAAA,GAAA,CAAI,KAAK,CAAA;AAAA,IACzB,IAAM,EAAAA,yBAAA,CAAS,GAAI,CAAA,IAAA,IAAQ,EAAE,CAAA;AAAA,IAC7B,MAAM,GAAI,CAAA,QAAA;AAAA,GACZ,CAAA;AACF;;;;"}

package/dist/collators/defaultTechDocsCollatorEntityTransformer.cjs.js

@@ -0,0 +1,37 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+
+const getDocumentText = (entity) => {
+  const documentTexts = [];
+  documentTexts.push(entity.metadata.description || "");
+  if (catalogModel.isUserEntity(entity) || catalogModel.isGroupEntity(entity)) {
+    if (entity.spec?.profile?.displayName) {
+      documentTexts.push(entity.spec.profile.displayName);
+    }
+  }
+  if (catalogModel.isUserEntity(entity)) {
+    if (entity.spec?.profile?.email) {
+      documentTexts.push(entity.spec.profile.email);
+    }
+  }
+  return documentTexts.join(" : ");
+};
+const defaultTechDocsCollatorEntityTransformer = (entity) => {
+  return {
+    kind: entity.kind,
+    namespace: entity.metadata.namespace || "default",
+    annotations: entity.metadata.annotations || "",
+    name: entity.metadata.name || "",
+    title: entity.metadata.title || "",
+    text: getDocumentText(entity),
+    componentType: entity.spec?.type?.toString() || "other",
+    type: entity.spec?.type?.toString() || "other",
+    lifecycle: entity.spec?.lifecycle || "",
+    owner: entity.spec?.owner || "",
+    path: ""
+  };
+};
+
+exports.defaultTechDocsCollatorEntityTransformer = defaultTechDocsCollatorEntityTransformer;
+//# sourceMappingURL=defaultTechDocsCollatorEntityTransformer.cjs.js.map

package/dist/collators/defaultTechDocsCollatorEntityTransformer.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultTechDocsCollatorEntityTransformer.cjs.js","sources":["../../src/collators/defaultTechDocsCollatorEntityTransformer.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Entity, isGroupEntity, isUserEntity } from '@backstage/catalog-model';\nimport { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\n\nconst getDocumentText = (entity: Entity): string => {\n  const documentTexts: string[] = [];\n  documentTexts.push(entity.metadata.description || '');\n\n  if (isUserEntity(entity) || isGroupEntity(entity)) {\n    if (entity.spec?.profile?.displayName) {\n      documentTexts.push(entity.spec.profile.displayName);\n    }\n  }\n\n  if (isUserEntity(entity)) {\n    if (entity.spec?.profile?.email) {\n      documentTexts.push(entity.spec.profile.email);\n    }\n  }\n\n  return documentTexts.join(' : ');\n};\n\n/** @public */\nexport const defaultTechDocsCollatorEntityTransformer: TechDocsCollatorEntityTransformer =\n  (entity: Entity) => {\n    return {\n      kind: entity.kind,\n      namespace: entity.metadata.namespace || 'default',\n      annotations: entity.metadata.annotations || '',\n      name: entity.metadata.name || '',\n      title: entity.metadata.title || '',\n      text: getDocumentText(entity),\n      componentType: entity.spec?.type?.toString() || 'other',\n      type: entity.spec?.type?.toString() || 'other',\n      lifecycle: (entity.spec?.lifecycle as string) || '',\n      owner: (entity.spec?.owner as string) || '',\n      path: '',\n    };\n  };\n"],"names":["isUserEntity","isGroupEntity"],"mappings":";;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAClD,EAAA,MAAM,gBAA0B,EAAC,CAAA;AACjC,EAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA,IAAe,EAAE,CAAA,CAAA;AAEpD,EAAA,IAAIA,yBAAa,CAAA,MAAM,CAAK,IAAAC,0BAAA,CAAc,MAAM,CAAG,EAAA;AACjD,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,WAAa,EAAA;AACrC,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,KACpD;AAAA,GACF;AAEA,EAAI,IAAAD,yBAAA,CAAa,MAAM,CAAG,EAAA;AACxB,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,KAAO,EAAA;AAC/B,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF;AAEA,EAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACjC,CAAA,CAAA;AAGa,MAAA,wCAAA,GACX,CAAC,MAAmB,KAAA;AAClB,EAAO,OAAA;AAAA,IACL,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,IACxC,WAAA,EAAa,MAAO,CAAA,QAAA,CAAS,WAAe,IAAA,EAAA;AAAA,IAC5C,IAAA,EAAM,MAAO,CAAA,QAAA,CAAS,IAAQ,IAAA,EAAA;AAAA,IAC9B,KAAA,EAAO,MAAO,CAAA,QAAA,CAAS,KAAS,IAAA,EAAA;AAAA,IAChC,IAAA,EAAM,gBAAgB,MAAM,CAAA;AAAA,IAC5B,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IAChD,IAAM,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IACvC,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,IACjD,KAAA,EAAQ,MAAO,CAAA,IAAA,EAAM,KAAoB,IAAA,EAAA;AAAA,IACzC,IAAM,EAAA,EAAA;AAAA,GACR,CAAA;AACF;;;;"}

package/dist/index.cjs.js

@@ -1,213 +1,15 @@
 'use strict';
 
-var backendCommon = require('@backstage/backend-common');
-var catalogClient = require('@backstage/catalog-client');
-var catalogModel = require('@backstage/catalog-model');
-var alpha = require('@backstage/plugin-catalog-common/alpha');
-var unescape = require('lodash/unescape');
-var fetch = require('node-fetch');
-var pLimit = require('p-limit');
-var stream = require('stream');
+Object.defineProperty(exports, '__esModule', { value: true });
 
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+var module$1 = require('./module.cjs.js');
+var DefaultTechDocsCollatorFactory = require('./collators/DefaultTechDocsCollatorFactory.cjs.js');
+var defaultTechDocsCollatorEntityTransformer = require('./collators/defaultTechDocsCollatorEntityTransformer.cjs.js');
 
-var unescape__default = /*#__PURE__*/_interopDefaultCompat(unescape);
-var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
-var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
 
-const getDocumentText = (entity) => {
-  const documentTexts = [];
-  documentTexts.push(entity.metadata.description || "");
-  if (catalogModel.isUserEntity(entity) || catalogModel.isGroupEntity(entity)) {
-    if (entity.spec?.profile?.displayName) {
-      documentTexts.push(entity.spec.profile.displayName);
-    }
-  }
-  if (catalogModel.isUserEntity(entity)) {
-    if (entity.spec?.profile?.email) {
-      documentTexts.push(entity.spec.profile.email);
-    }
-  }
-  return documentTexts.join(" : ");
-};
-const defaultTechDocsCollatorEntityTransformer = (entity) => {
-  return {
-    kind: entity.kind,
-    namespace: entity.metadata.namespace || "default",
-    annotations: entity.metadata.annotations || "",
-    name: entity.metadata.name || "",
-    title: entity.metadata.title || "",
-    text: getDocumentText(entity),
-    componentType: entity.spec?.type?.toString() || "other",
-    type: entity.spec?.type?.toString() || "other",
-    lifecycle: entity.spec?.lifecycle || "",
-    owner: entity.spec?.owner || "",
-    path: ""
-  };
-};
 
-class DefaultTechDocsCollatorFactory {
-  type = "techdocs";
-  visibilityPermission = alpha.catalogEntityReadPermission;
-  discovery;
-  locationTemplate;
-  logger;
-  auth;
-  catalogClient;
-  parallelismLimit;
-  legacyPathCasing;
-  entityTransformer;
-  constructor(options) {
-    this.discovery = options.discovery;
-    this.locationTemplate = options.locationTemplate || "/docs/:namespace/:kind/:name/:path";
-    this.logger = options.logger.child({ documentType: this.type });
-    this.catalogClient = options.catalogClient || new catalogClient.CatalogClient({ discoveryApi: options.discovery });
-    this.parallelismLimit = options.parallelismLimit ?? 10;
-    this.legacyPathCasing = options.legacyPathCasing ?? false;
-    this.entityTransformer = options.entityTransformer ?? defaultTechDocsCollatorEntityTransformer;
-    this.auth = backendCommon.createLegacyAuthAdapters({
-      auth: options.auth,
-      discovery: options.discovery,
-      tokenManager: options.tokenManager
-    }).auth;
-  }
-  static fromConfig(config, options) {
-    const legacyPathCasing = config.getOptionalBoolean(
-      "techdocs.legacyUseCaseSensitiveTripletPaths"
-    ) || false;
-    const locationTemplate = config.getOptionalString(
-      "search.collators.techdocs.locationTemplate"
-    );
-    const parallelismLimit = config.getOptionalNumber(
-      "search.collators.techdocs.parallelismLimit"
-    );
-    return new DefaultTechDocsCollatorFactory({
-      ...options,
-      locationTemplate,
-      parallelismLimit,
-      legacyPathCasing
-    });
-  }
-  async getCollator() {
-    return stream.Readable.from(this.execute());
-  }
-  async *execute() {
-    const limit = pLimit__default.default(this.parallelismLimit);
-    const techDocsBaseUrl = await this.discovery.getBaseUrl("techdocs");
-    let entitiesRetrieved = 0;
-    let moreEntitiesToGet = true;
-    const batchSize = this.parallelismLimit * 50;
-    while (moreEntitiesToGet) {
-      const { token: catalogToken } = await this.auth.getPluginRequestToken({
-        onBehalfOf: await this.auth.getOwnServiceCredentials(),
-        targetPluginId: "catalog"
-      });
-      const entities = (await this.catalogClient.getEntities(
-        {
-          filter: {
-            "metadata.annotations.backstage.io/techdocs-ref": catalogClient.CATALOG_FILTER_EXISTS
-          },
-          limit: batchSize,
-          offset: entitiesRetrieved
-        },
-        { token: catalogToken }
-      )).items;
-      moreEntitiesToGet = entities.length === batchSize;
-      entitiesRetrieved += entities.length;
-      const docPromises = entities.filter((it) => it.metadata?.annotations?.["backstage.io/techdocs-ref"]).map(
-        (entity) => limit(async () => {
-          const entityInfo = DefaultTechDocsCollatorFactory.handleEntityInfoCasing(
-            this.legacyPathCasing,
-            {
-              kind: entity.kind,
-              namespace: entity.metadata.namespace || "default",
-              name: entity.metadata.name
-            }
-          );
-          try {
-            const { token: techdocsToken } = await this.auth.getPluginRequestToken({
-              onBehalfOf: await this.auth.getOwnServiceCredentials(),
-              targetPluginId: "techdocs"
-            });
-            const searchIndexResponse = await fetch__default.default(
-              DefaultTechDocsCollatorFactory.constructDocsIndexUrl(
-                techDocsBaseUrl,
-                entityInfo
-              ),
-              {
-                headers: {
-                  Authorization: `Bearer ${techdocsToken}`
-                }
-              }
-            );
-            const searchIndex = await Promise.race([
-              searchIndexResponse.json(),
-              new Promise((_resolve, reject) => {
-                setTimeout(() => {
-                  reject("Could not parse JSON in 5 seconds.");
-                }, 5e3);
-              })
-            ]);
-            return searchIndex.docs.map((doc) => ({
-              ...this.entityTransformer(entity),
-              title: unescape__default.default(doc.title),
-              text: unescape__default.default(doc.text || ""),
-              location: this.applyArgsToFormat(
-                this.locationTemplate || "/docs/:namespace/:kind/:name/:path",
-                {
-                  ...entityInfo,
-                  path: doc.location
-                }
-              ),
-              path: doc.location,
-              ...entityInfo,
-              entityTitle: entity.metadata.title,
-              componentType: entity.spec?.type?.toString() || "other",
-              lifecycle: entity.spec?.lifecycle || "",
-              owner: getSimpleEntityOwnerString(entity),
-              authorization: {
-                resourceRef: catalogModel.stringifyEntityRef(entity)
-              }
-            }));
-          } catch (e) {
-            this.logger.debug(
-              `Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,
-              e
-            );
-            return [];
-          }
-        })
-      );
-      yield* (await Promise.all(docPromises)).flat();
-    }
-  }
-  applyArgsToFormat(format, args) {
-    let formatted = format;
-    for (const [key, value] of Object.entries(args)) {
-      formatted = formatted.replace(`:${key}`, value);
-    }
-    return formatted;
-  }
-  static constructDocsIndexUrl(techDocsBaseUrl, entityInfo) {
-    return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;
-  }
-  static handleEntityInfoCasing(legacyPaths, entityInfo) {
-    return legacyPaths ? entityInfo : Object.entries(entityInfo).reduce((acc, [key, value]) => {
-      return { ...acc, [key]: value.toLocaleLowerCase("en-US") };
-    }, {});
-  }
-}
-function getSimpleEntityOwnerString(entity) {
-  if (entity.relations) {
-    const owner = entity.relations.find((r) => r.type === catalogModel.RELATION_OWNED_BY);
-    if (owner) {
-      const { name } = catalogModel.parseEntityRef(owner.targetRef);
-      return name;
-    }
-  }
-  return "";
-}
-
-exports.DefaultTechDocsCollatorFactory = DefaultTechDocsCollatorFactory;
-exports.defaultTechDocsCollatorEntityTransformer = defaultTechDocsCollatorEntityTransformer;
+exports.default = module$1.default;
+exports.techdocsCollatorEntityTransformerExtensionPoint = module$1.techdocsCollatorEntityTransformerExtensionPoint;
+exports.DefaultTechDocsCollatorFactory = DefaultTechDocsCollatorFactory.DefaultTechDocsCollatorFactory;
+exports.defaultTechDocsCollatorEntityTransformer = defaultTechDocsCollatorEntityTransformer.defaultTechDocsCollatorEntityTransformer;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/collators/defaultTechDocsCollatorEntityTransformer.ts","../src/collators/DefaultTechDocsCollatorFactory.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Entity, isGroupEntity, isUserEntity } from '@backstage/catalog-model';\nimport { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\n\nconst getDocumentText = (entity: Entity): string => {\n  const documentTexts: string[] = [];\n  documentTexts.push(entity.metadata.description || '');\n\n  if (isUserEntity(entity) || isGroupEntity(entity)) {\n    if (entity.spec?.profile?.displayName) {\n      documentTexts.push(entity.spec.profile.displayName);\n    }\n  }\n\n  if (isUserEntity(entity)) {\n    if (entity.spec?.profile?.email) {\n      documentTexts.push(entity.spec.profile.email);\n    }\n  }\n\n  return documentTexts.join(' : ');\n};\n\n/** @public */\nexport const defaultTechDocsCollatorEntityTransformer: TechDocsCollatorEntityTransformer =\n  (entity: Entity) => {\n    return {\n      kind: entity.kind,\n      namespace: entity.metadata.namespace || 'default',\n      annotations: entity.metadata.annotations || '',\n      name: entity.metadata.name || '',\n      title: entity.metadata.title || '',\n      text: getDocumentText(entity),\n      componentType: entity.spec?.type?.toString() || 'other',\n      type: entity.spec?.type?.toString() || 'other',\n      lifecycle: (entity.spec?.lifecycle as string) || '',\n      owner: (entity.spec?.owner as string) || '',\n      path: '',\n    };\n  };\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createLegacyAuthAdapters,\n  TokenManager,\n} from '@backstage/backend-common';\nimport {\n  CATALOG_FILTER_EXISTS,\n  CatalogApi,\n  CatalogClient,\n} from '@backstage/catalog-client';\nimport {\n  Entity,\n  parseEntityRef,\n  RELATION_OWNED_BY,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { TechDocsDocument } from '@backstage/plugin-techdocs-node';\nimport unescape from 'lodash/unescape';\nimport fetch from 'node-fetch';\nimport pLimit from 'p-limit';\nimport { Readable } from 'stream';\nimport { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\nimport { defaultTechDocsCollatorEntityTransformer } from './defaultTechDocsCollatorEntityTransformer';\nimport {\n  AuthService,\n  DiscoveryService,\n  HttpAuthService,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\n\ninterface MkSearchIndexDoc {\n  title: string;\n  text: string;\n  location: string;\n}\n\n/**\n * Options to configure the TechDocs collator factory\n *\n * @public\n * @deprecated This type is deprecated along with the {@link DefaultTechDocsCollatorFactory}.\n */\nexport type TechDocsCollatorFactoryOptions = {\n  discovery: DiscoveryService;\n  logger: LoggerService;\n  tokenManager?: TokenManager;\n  auth?: AuthService;\n  httpAuth?: HttpAuthService;\n  locationTemplate?: string;\n  catalogClient?: CatalogApi;\n  parallelismLimit?: number;\n  legacyPathCasing?: boolean;\n  entityTransformer?: TechDocsCollatorEntityTransformer;\n};\n\ntype EntityInfo = {\n  name: string;\n  namespace: string;\n  kind: string;\n};\n\n/**\n * A search collator factory responsible for gathering and transforming\n * TechDocs documents.\n *\n * @public\n * @deprecated Migrate to the {@link https://backstage.io/docs/backend-system/building-backends/migrating | new backend system} and install this collator via module instead (see {@link https://github.com/backstage/backstage/blob/nbs10/search-deprecate-create-router/plugins/search-backend-module-techdocs/README.md#installation | here} for more installation details).\n */\nexport class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {\n  public readonly type: string = 'techdocs';\n  public readonly visibilityPermission: Permission =\n    catalogEntityReadPermission;\n\n  private discovery: DiscoveryService;\n  private locationTemplate: string;\n  private readonly logger: LoggerService;\n  private readonly auth: AuthService;\n  private readonly catalogClient: CatalogApi;\n  private readonly parallelismLimit: number;\n  private readonly legacyPathCasing: boolean;\n  private entityTransformer: TechDocsCollatorEntityTransformer;\n\n  private constructor(options: TechDocsCollatorFactoryOptions) {\n    this.discovery = options.discovery;\n    this.locationTemplate =\n      options.locationTemplate || '/docs/:namespace/:kind/:name/:path';\n    this.logger = options.logger.child({ documentType: this.type });\n    this.catalogClient =\n      options.catalogClient ||\n      new CatalogClient({ discoveryApi: options.discovery });\n    this.parallelismLimit = options.parallelismLimit ?? 10;\n    this.legacyPathCasing = options.legacyPathCasing ?? false;\n    this.entityTransformer =\n      options.entityTransformer ?? defaultTechDocsCollatorEntityTransformer;\n\n    this.auth = createLegacyAuthAdapters({\n      auth: options.auth,\n      discovery: options.discovery,\n      tokenManager: options.tokenManager,\n    }).auth;\n  }\n\n  static fromConfig(config: Config, options: TechDocsCollatorFactoryOptions) {\n    const legacyPathCasing =\n      config.getOptionalBoolean(\n        'techdocs.legacyUseCaseSensitiveTripletPaths',\n      ) || false;\n    const locationTemplate = config.getOptionalString(\n      'search.collators.techdocs.locationTemplate',\n    );\n    const parallelismLimit = config.getOptionalNumber(\n      'search.collators.techdocs.parallelismLimit',\n    );\n    return new DefaultTechDocsCollatorFactory({\n      ...options,\n      locationTemplate,\n      parallelismLimit,\n      legacyPathCasing,\n    });\n  }\n\n  async getCollator(): Promise<Readable> {\n    return Readable.from(this.execute());\n  }\n\n  private async *execute(): AsyncGenerator<TechDocsDocument, void, undefined> {\n    const limit = pLimit(this.parallelismLimit);\n    const techDocsBaseUrl = await this.discovery.getBaseUrl('techdocs');\n\n    let entitiesRetrieved = 0;\n    let moreEntitiesToGet = true;\n\n    // Offset/limit pagination is used on the Catalog Client in order to\n    // limit (and allow some control over) memory used by the search backend\n    // at index-time. The batchSize is calculated as a factor of the given\n    // parallelism limit to simplify configuration.\n    const batchSize = this.parallelismLimit * 50;\n    while (moreEntitiesToGet) {\n      const { token: catalogToken } = await this.auth.getPluginRequestToken({\n        onBehalfOf: await this.auth.getOwnServiceCredentials(),\n        targetPluginId: 'catalog',\n      });\n\n      const entities = (\n        await this.catalogClient.getEntities(\n          {\n            filter: {\n              'metadata.annotations.backstage.io/techdocs-ref':\n                CATALOG_FILTER_EXISTS,\n            },\n            limit: batchSize,\n            offset: entitiesRetrieved,\n          },\n          { token: catalogToken },\n        )\n      ).items;\n\n      // Control looping through entity batches.\n      moreEntitiesToGet = entities.length === batchSize;\n      entitiesRetrieved += entities.length;\n\n      const docPromises = entities\n        .filter(it => it.metadata?.annotations?.['backstage.io/techdocs-ref'])\n        .map((entity: Entity) =>\n          limit(async (): Promise<TechDocsDocument[]> => {\n            const entityInfo =\n              DefaultTechDocsCollatorFactory.handleEntityInfoCasing(\n                this.legacyPathCasing,\n                {\n                  kind: entity.kind,\n                  namespace: entity.metadata.namespace || 'default',\n                  name: entity.metadata.name,\n                },\n              );\n\n            try {\n              const { token: techdocsToken } =\n                await this.auth.getPluginRequestToken({\n                  onBehalfOf: await this.auth.getOwnServiceCredentials(),\n                  targetPluginId: 'techdocs',\n                });\n\n              const searchIndexResponse = await fetch(\n                DefaultTechDocsCollatorFactory.constructDocsIndexUrl(\n                  techDocsBaseUrl,\n                  entityInfo,\n                ),\n                {\n                  headers: {\n                    Authorization: `Bearer ${techdocsToken}`,\n                  },\n                },\n              );\n\n              // todo(@backstage/techdocs-core): remove Promise.race() when node-fetch is 3.x+\n              // workaround for fetch().json() hanging in node-fetch@2.x.x, fixed in 3.x.x\n              // https://github.com/node-fetch/node-fetch/issues/665\n              const searchIndex = await Promise.race([\n                searchIndexResponse.json(),\n                new Promise((_resolve, reject) => {\n                  setTimeout(() => {\n                    reject('Could not parse JSON in 5 seconds.');\n                  }, 5000);\n                }),\n              ]);\n\n              return searchIndex.docs.map((doc: MkSearchIndexDoc) => ({\n                ...this.entityTransformer(entity),\n                title: unescape(doc.title),\n                text: unescape(doc.text || ''),\n                location: this.applyArgsToFormat(\n                  this.locationTemplate || '/docs/:namespace/:kind/:name/:path',\n                  {\n                    ...entityInfo,\n                    path: doc.location,\n                  },\n                ),\n                path: doc.location,\n                ...entityInfo,\n                entityTitle: entity.metadata.title,\n                componentType: entity.spec?.type?.toString() || 'other',\n                lifecycle: (entity.spec?.lifecycle as string) || '',\n                owner: getSimpleEntityOwnerString(entity),\n                authorization: {\n                  resourceRef: stringifyEntityRef(entity),\n                },\n              }));\n            } catch (e) {\n              this.logger.debug(\n                `Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,\n                e,\n              );\n              return [];\n            }\n          }),\n        );\n      yield* (await Promise.all(docPromises)).flat();\n    }\n  }\n\n  private applyArgsToFormat(\n    format: string,\n    args: Record<string, string>,\n  ): string {\n    let formatted = format;\n    for (const [key, value] of Object.entries(args)) {\n      formatted = formatted.replace(`:${key}`, value);\n    }\n    return formatted;\n  }\n\n  private static constructDocsIndexUrl(\n    techDocsBaseUrl: string,\n    entityInfo: { kind: string; namespace: string; name: string },\n  ) {\n    return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;\n  }\n\n  private static handleEntityInfoCasing(\n    legacyPaths: boolean,\n    entityInfo: EntityInfo,\n  ): EntityInfo {\n    return legacyPaths\n      ? entityInfo\n      : Object.entries(entityInfo).reduce((acc, [key, value]) => {\n          return { ...acc, [key]: value.toLocaleLowerCase('en-US') };\n        }, {} as EntityInfo);\n  }\n}\n\nfunction getSimpleEntityOwnerString(entity: Entity): string {\n  if (entity.relations) {\n    const owner = entity.relations.find(r => r.type === RELATION_OWNED_BY);\n    if (owner) {\n      const { name } = parseEntityRef(owner.targetRef);\n      return name;\n    }\n  }\n  return '';\n}\n"],"names":["isUserEntity","isGroupEntity","catalogEntityReadPermission","CatalogClient","createLegacyAuthAdapters","Readable","pLimit","CATALOG_FILTER_EXISTS","fetch","unescape","stringifyEntityRef","RELATION_OWNED_BY","parseEntityRef"],"mappings":";;;;;;;;;;;;;;;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAClD,EAAA,MAAM,gBAA0B,EAAC,CAAA;AACjC,EAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA,IAAe,EAAE,CAAA,CAAA;AAEpD,EAAA,IAAIA,yBAAa,CAAA,MAAM,CAAK,IAAAC,0BAAA,CAAc,MAAM,CAAG,EAAA;AACjD,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,WAAa,EAAA;AACrC,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,KACpD;AAAA,GACF;AAEA,EAAI,IAAAD,yBAAA,CAAa,MAAM,CAAG,EAAA;AACxB,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,KAAO,EAAA;AAC/B,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF;AAEA,EAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACjC,CAAA,CAAA;AAGa,MAAA,wCAAA,GACX,CAAC,MAAmB,KAAA;AAClB,EAAO,OAAA;AAAA,IACL,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,IACxC,WAAA,EAAa,MAAO,CAAA,QAAA,CAAS,WAAe,IAAA,EAAA;AAAA,IAC5C,IAAA,EAAM,MAAO,CAAA,QAAA,CAAS,IAAQ,IAAA,EAAA;AAAA,IAC9B,KAAA,EAAO,MAAO,CAAA,QAAA,CAAS,KAAS,IAAA,EAAA;AAAA,IAChC,IAAA,EAAM,gBAAgB,MAAM,CAAA;AAAA,IAC5B,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IAChD,IAAM,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IACvC,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,IACjD,KAAA,EAAQ,MAAO,CAAA,IAAA,EAAM,KAAoB,IAAA,EAAA;AAAA,IACzC,IAAM,EAAA,EAAA;AAAA,GACR,CAAA;AACF;;ACiCK,MAAM,8BAAkE,CAAA;AAAA,EAC7D,IAAe,GAAA,UAAA,CAAA;AAAA,EACf,oBACd,GAAAE,iCAAA,CAAA;AAAA,EAEM,SAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACS,MAAA,CAAA;AAAA,EACA,IAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACT,iBAAA,CAAA;AAAA,EAEA,YAAY,OAAyC,EAAA;AAC3D,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAK,IAAA,CAAA,gBAAA,GACH,QAAQ,gBAAoB,IAAA,oCAAA,CAAA;AAC9B,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC9D,IAAK,IAAA,CAAA,aAAA,GACH,QAAQ,aACR,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,OAAQ,CAAA,SAAA,EAAW,CAAA,CAAA;AACvD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,EAAA,CAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,KAAA,CAAA;AACpD,IAAK,IAAA,CAAA,iBAAA,GACH,QAAQ,iBAAqB,IAAA,wCAAA,CAAA;AAE/B,IAAA,IAAA,CAAK,OAAOC,sCAAyB,CAAA;AAAA,MACnC,MAAM,OAAQ,CAAA,IAAA;AAAA,MACd,WAAW,OAAQ,CAAA,SAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,YAAA;AAAA,KACvB,CAAE,CAAA,IAAA,CAAA;AAAA,GACL;AAAA,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,OAAyC,EAAA;AACzE,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL,6CAAA;AAAA,KACG,IAAA,KAAA,CAAA;AACP,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,OAAO,IAAI,8BAA+B,CAAA;AAAA,MACxC,GAAG,OAAA;AAAA,MACH,gBAAA;AAAA,MACA,gBAAA;AAAA,MACA,gBAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,OAA6D,GAAA;AAC1E,IAAM,MAAA,KAAA,GAAQC,uBAAO,CAAA,IAAA,CAAK,gBAAgB,CAAA,CAAA;AAC1C,IAAA,MAAM,eAAkB,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,UAAU,CAAA,CAAA;AAElE,IAAA,IAAI,iBAAoB,GAAA,CAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA,CAAA;AAMxB,IAAM,MAAA,SAAA,GAAY,KAAK,gBAAmB,GAAA,EAAA,CAAA;AAC1C,IAAA,OAAO,iBAAmB,EAAA;AACxB,MAAA,MAAM,EAAE,KAAO,EAAA,YAAA,KAAiB,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,QACpE,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,QACrD,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA,CAAA;AAED,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,QACvB;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,gDACE,EAAAC,mCAAA;AAAA,WACJ;AAAA,UACA,KAAO,EAAA,SAAA;AAAA,UACP,MAAQ,EAAA,iBAAA;AAAA,SACV;AAAA,QACA,EAAE,OAAO,YAAa,EAAA;AAAA,OAExB,EAAA,KAAA,CAAA;AAGF,MAAA,iBAAA,GAAoB,SAAS,MAAW,KAAA,SAAA,CAAA;AACxC,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA,CAAA;AAE9B,MAAM,MAAA,WAAA,GAAc,SACjB,MAAO,CAAA,CAAA,EAAA,KAAM,GAAG,QAAU,EAAA,WAAA,GAAc,2BAA2B,CAAC,CACpE,CAAA,GAAA;AAAA,QAAI,CAAC,MACJ,KAAA,KAAA,CAAM,YAAyC;AAC7C,UAAA,MAAM,aACJ,8BAA+B,CAAA,sBAAA;AAAA,YAC7B,IAAK,CAAA,gBAAA;AAAA,YACL;AAAA,cACE,MAAM,MAAO,CAAA,IAAA;AAAA,cACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cACxC,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,aACxB;AAAA,WACF,CAAA;AAEF,UAAI,IAAA;AACF,YAAA,MAAM,EAAE,KAAO,EAAA,aAAA,KACb,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,cACpC,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,cACrD,cAAgB,EAAA,UAAA;AAAA,aACjB,CAAA,CAAA;AAEH,YAAA,MAAM,sBAAsB,MAAMC,sBAAA;AAAA,cAChC,8BAA+B,CAAA,qBAAA;AAAA,gBAC7B,eAAA;AAAA,gBACA,UAAA;AAAA,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA;AAAA,kBACP,aAAA,EAAe,UAAU,aAAa,CAAA,CAAA;AAAA,iBACxC;AAAA,eACF;AAAA,aACF,CAAA;AAKA,YAAM,MAAA,WAAA,GAAc,MAAM,OAAA,CAAQ,IAAK,CAAA;AAAA,cACrC,oBAAoB,IAAK,EAAA;AAAA,cACzB,IAAI,OAAA,CAAQ,CAAC,QAAA,EAAU,MAAW,KAAA;AAChC,gBAAA,UAAA,CAAW,MAAM;AACf,kBAAA,MAAA,CAAO,oCAAoC,CAAA,CAAA;AAAA,mBAC1C,GAAI,CAAA,CAAA;AAAA,eACR,CAAA;AAAA,aACF,CAAA,CAAA;AAED,YAAA,OAAO,WAAY,CAAA,IAAA,CAAK,GAAI,CAAA,CAAC,GAA2B,MAAA;AAAA,cACtD,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,cAChC,KAAA,EAAOC,yBAAS,CAAA,GAAA,CAAI,KAAK,CAAA;AAAA,cACzB,IAAM,EAAAA,yBAAA,CAAS,GAAI,CAAA,IAAA,IAAQ,EAAE,CAAA;AAAA,cAC7B,UAAU,IAAK,CAAA,iBAAA;AAAA,gBACb,KAAK,gBAAoB,IAAA,oCAAA;AAAA,gBACzB;AAAA,kBACE,GAAG,UAAA;AAAA,kBACH,MAAM,GAAI,CAAA,QAAA;AAAA,iBACZ;AAAA,eACF;AAAA,cACA,MAAM,GAAI,CAAA,QAAA;AAAA,cACV,GAAG,UAAA;AAAA,cACH,WAAA,EAAa,OAAO,QAAS,CAAA,KAAA;AAAA,cAC7B,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,cAChD,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,cACjD,KAAA,EAAO,2BAA2B,MAAM,CAAA;AAAA,cACxC,aAAe,EAAA;AAAA,gBACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,eACxC;AAAA,aACA,CAAA,CAAA,CAAA;AAAA,mBACK,CAAG,EAAA;AACV,YAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,cACV,CAAA,qDAAA,EAAwD,WAAW,SAAS,CAAA,CAAA,EAAI,WAAW,IAAI,CAAA,CAAA,EAAI,WAAW,IAAI,CAAA,CAAA;AAAA,cAClH,CAAA;AAAA,aACF,CAAA;AACA,YAAA,OAAO,EAAC,CAAA;AAAA,WACV;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AACF,MAAA,OAAA,CAAQ,MAAM,OAAA,CAAQ,GAAI,CAAA,WAAW,GAAG,IAAK,EAAA,CAAA;AAAA,KAC/C;AAAA,GACF;AAAA,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA,CAAA;AAChB,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC/C,MAAA,SAAA,GAAY,SAAU,CAAA,OAAA,CAAQ,CAAI,CAAA,EAAA,GAAG,IAAI,KAAK,CAAA,CAAA;AAAA,KAChD;AACA,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEA,OAAe,qBACb,CAAA,eAAA,EACA,UACA,EAAA;AACA,IAAO,OAAA,CAAA,EAAG,eAAe,CAAA,aAAA,EAAgB,UAAW,CAAA,SAAS,IAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,yBAAA,CAAA,CAAA;AAAA,GACrG;AAAA,EAEA,OAAe,sBACb,CAAA,WAAA,EACA,UACY,EAAA;AACZ,IAAA,OAAO,WACH,GAAA,UAAA,GACA,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAE,MAAO,CAAA,CAAC,GAAK,EAAA,CAAC,GAAK,EAAA,KAAK,CAAM,KAAA;AACvD,MAAO,OAAA,EAAE,GAAG,GAAK,EAAA,CAAC,GAAG,GAAG,KAAA,CAAM,iBAAkB,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,KAC3D,EAAG,EAAgB,CAAA,CAAA;AAAA,GACzB;AACF,CAAA;AAEA,SAAS,2BAA2B,MAAwB,EAAA;AAC1D,EAAA,IAAI,OAAO,SAAW,EAAA;AACpB,IAAA,MAAM,QAAQ,MAAO,CAAA,SAAA,CAAU,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAASC,8BAAiB,CAAA,CAAA;AACrE,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,2BAAA,CAAe,MAAM,SAAS,CAAA,CAAA;AAC/C,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,GACF;AACA,EAAO,OAAA,EAAA,CAAA;AACT;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="node" />
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { DiscoveryService, LoggerService, AuthService, HttpAuthService } from '@backstage/backend-plugin-api';
+import { TechDocsCollatorEntityTransformer as TechDocsCollatorEntityTransformer$1, TechDocsCollatorDocumentTransformer as TechDocsCollatorDocumentTransformer$1 } from '@backstage/plugin-search-backend-module-techdocs';
 import { TokenManager } from '@backstage/backend-common';
 import { CatalogApi } from '@backstage/catalog-client';
 import { Config } from '@backstage/config';
@@ -7,10 +10,36 @@ import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
 import { Readable } from 'stream';
 import { Entity } from '@backstage/catalog-model';
 import { TechDocsDocument } from '@backstage/plugin-techdocs-node';
-import { DiscoveryService, LoggerService, AuthService, HttpAuthService } from '@backstage/backend-plugin-api';
 
 /** @public */
-type TechDocsCollatorEntityTransformer = (entity: Entity) => Omit<TechDocsDocument, 'location' | 'authorization'>;
+interface TechDocsCollatorEntityTransformerExtensionPoint {
+    setTransformer(transformer: TechDocsCollatorEntityTransformer$1): void;
+    setDocumentTransformer(transformer: TechDocsCollatorDocumentTransformer$1): void;
+}
+/**
+ * Extension point used to customize the TechDocs collator entity transformer.
+ *
+ * @public
+ */
+declare const techdocsCollatorEntityTransformerExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>;
+/**
+ * @public
+ * Search backend module for the TechDocs index.
+ */
+declare const _default: _backstage_backend_plugin_api.BackendFeature;
+
+/** @public */
+type TechDocsCollatorEntityTransformer = (entity: Entity) => Partial<Omit<TechDocsDocument, 'location' | 'authorization'>>;
+
+/** @public */
+interface MkSearchIndexDoc {
+    title: string;
+    text: string;
+    location: string;
+    tags?: string[];
+}
+/** @public */
+type TechDocsCollatorDocumentTransformer = (doc: MkSearchIndexDoc) => Partial<Omit<TechDocsDocument, 'location' | 'authorization' | 'kind' | 'namespace' | 'name' | 'lifecycle' | 'owner'>>;
 
 /**
  * Options to configure the TechDocs collator factory
@@ -29,6 +58,7 @@ type TechDocsCollatorFactoryOptions = {
     parallelismLimit?: number;
     legacyPathCasing?: boolean;
     entityTransformer?: TechDocsCollatorEntityTransformer;
+    documentTransformer?: TechDocsCollatorDocumentTransformer;
 };
 /**
  * A search collator factory responsible for gathering and transforming
@@ -48,6 +78,7 @@ declare class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory
     private readonly parallelismLimit;
     private readonly legacyPathCasing;
     private entityTransformer;
+    private documentTransformer;
     private constructor();
     static fromConfig(config: Config, options: TechDocsCollatorFactoryOptions): DefaultTechDocsCollatorFactory;
     getCollator(): Promise<Readable>;
@@ -60,4 +91,4 @@ declare class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory
 /** @public */
 declare const defaultTechDocsCollatorEntityTransformer: TechDocsCollatorEntityTransformer;
 
-export { DefaultTechDocsCollatorFactory, type TechDocsCollatorEntityTransformer, type TechDocsCollatorFactoryOptions, defaultTechDocsCollatorEntityTransformer };
+export { DefaultTechDocsCollatorFactory, type MkSearchIndexDoc, type TechDocsCollatorDocumentTransformer, type TechDocsCollatorEntityTransformer, type TechDocsCollatorEntityTransformerExtensionPoint, type TechDocsCollatorFactoryOptions, _default as default, defaultTechDocsCollatorEntityTransformer, techdocsCollatorEntityTransformerExtensionPoint };

package/dist/module.cjs.js

@@ -0,0 +1,88 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+var pluginSearchBackendModuleTechdocs = require('@backstage/plugin-search-backend-module-techdocs');
+var alpha$1 = require('@backstage/plugin-search-backend-node/alpha');
+
+const techdocsCollatorEntityTransformerExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "search.techdocsCollator.transformer"
+});
+var feature = backendPluginApi.createBackendModule({
+  pluginId: "search",
+  moduleId: "techdocs-collator",
+  register(env) {
+    let entityTransformer;
+    let documentTransformer;
+    env.registerExtensionPoint(
+      techdocsCollatorEntityTransformerExtensionPoint,
+      {
+        setTransformer(newTransformer) {
+          if (entityTransformer) {
+            throw new Error(
+              "TechDocs collator entity transformer may only be set once"
+            );
+          }
+          entityTransformer = newTransformer;
+        },
+        setDocumentTransformer(newTransformer) {
+          if (documentTransformer) {
+            throw new Error(
+              "TechDocs collator document transformer may only be set once"
+            );
+          }
+          documentTransformer = newTransformer;
+        }
+      }
+    );
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger,
+        auth: backendPluginApi.coreServices.auth,
+        httpAuth: backendPluginApi.coreServices.httpAuth,
+        discovery: backendPluginApi.coreServices.discovery,
+        scheduler: backendPluginApi.coreServices.scheduler,
+        catalog: alpha.catalogServiceRef,
+        indexRegistry: alpha$1.searchIndexRegistryExtensionPoint
+      },
+      async init({
+        config,
+        logger,
+        auth,
+        httpAuth,
+        discovery,
+        scheduler,
+        catalog,
+        indexRegistry
+      }) {
+        const defaultSchedule = {
+          frequency: { minutes: 10 },
+          timeout: { minutes: 15 },
+          initialDelay: { seconds: 3 }
+        };
+        const schedule = config.has("search.collators.techdocs.schedule") ? backendPluginApi.readSchedulerServiceTaskScheduleDefinitionFromConfig(
+          config.getConfig("search.collators.techdocs.schedule")
+        ) : defaultSchedule;
+        indexRegistry.addCollator({
+          schedule: scheduler.createScheduledTaskRunner(schedule),
+          factory: pluginSearchBackendModuleTechdocs.DefaultTechDocsCollatorFactory.fromConfig(config, {
+            discovery,
+            auth,
+            httpAuth,
+            logger,
+            catalogClient: catalog,
+            entityTransformer,
+            documentTransformer
+          })
+        });
+      }
+    });
+  }
+});
+
+exports.default = feature;
+exports.techdocsCollatorEntityTransformerExtensionPoint = techdocsCollatorEntityTransformerExtensionPoint;
+//# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * @packageDocumentation\n * A module for the search backend that exports TechDocs modules.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n  DefaultTechDocsCollatorFactory,\n  TechDocsCollatorDocumentTransformer,\n  TechDocsCollatorEntityTransformer,\n} from '@backstage/plugin-search-backend-module-techdocs';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\n/** @public */\nexport interface TechDocsCollatorEntityTransformerExtensionPoint {\n  setTransformer(transformer: TechDocsCollatorEntityTransformer): void;\n  setDocumentTransformer(\n    transformer: TechDocsCollatorDocumentTransformer,\n  ): void;\n}\n\n/**\n * Extension point used to customize the TechDocs collator entity transformer.\n *\n * @public\n */\nexport const techdocsCollatorEntityTransformerExtensionPoint =\n  createExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>({\n    id: 'search.techdocsCollator.transformer',\n  });\n\n/**\n * @public\n * Search backend module for the TechDocs index.\n */\nexport default createBackendModule({\n  pluginId: 'search',\n  moduleId: 'techdocs-collator',\n  register(env) {\n    let entityTransformer: TechDocsCollatorEntityTransformer | undefined;\n    let documentTransformer: TechDocsCollatorDocumentTransformer | undefined;\n\n    env.registerExtensionPoint(\n      techdocsCollatorEntityTransformerExtensionPoint,\n      {\n        setTransformer(newTransformer) {\n          if (entityTransformer) {\n            throw new Error(\n              'TechDocs collator entity transformer may only be set once',\n            );\n          }\n          entityTransformer = newTransformer;\n        },\n        setDocumentTransformer(newTransformer) {\n          if (documentTransformer) {\n            throw new Error(\n              'TechDocs collator document transformer may only be set once',\n            );\n          }\n          documentTransformer = newTransformer;\n        },\n      },\n    );\n\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        auth: coreServices.auth,\n        httpAuth: coreServices.httpAuth,\n        discovery: coreServices.discovery,\n        scheduler: coreServices.scheduler,\n        catalog: catalogServiceRef,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n      },\n      async init({\n        config,\n        logger,\n        auth,\n        httpAuth,\n        discovery,\n        scheduler,\n        catalog,\n        indexRegistry,\n      }) {\n        const defaultSchedule = {\n          frequency: { minutes: 10 },\n          timeout: { minutes: 15 },\n          initialDelay: { seconds: 3 },\n        };\n\n        const schedule = config.has('search.collators.techdocs.schedule')\n          ? readSchedulerServiceTaskScheduleDefinitionFromConfig(\n              config.getConfig('search.collators.techdocs.schedule'),\n            )\n          : defaultSchedule;\n\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(schedule),\n          factory: DefaultTechDocsCollatorFactory.fromConfig(config, {\n            discovery,\n            auth,\n            httpAuth,\n            logger,\n            catalogClient: catalog,\n            entityTransformer,\n            documentTransformer,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readSchedulerServiceTaskScheduleDefinitionFromConfig","DefaultTechDocsCollatorFactory"],"mappings":";;;;;;;;;AAgDO,MAAM,kDACXA,qCAAsE,CAAA;AAAA,EACpE,EAAI,EAAA,qCAAA;AACN,CAAC,EAAA;AAMH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AACJ,IAAI,IAAA,mBAAA,CAAA;AAEJ,IAAI,GAAA,CAAA,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,eAAe,cAAgB,EAAA;AAC7B,UAAA,IAAI,iBAAmB,EAAA;AACrB,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,2DAAA;AAAA,aACF,CAAA;AAAA,WACF;AACA,UAAoB,iBAAA,GAAA,cAAA,CAAA;AAAA,SACtB;AAAA,QACA,uBAAuB,cAAgB,EAAA;AACrC,UAAA,IAAI,mBAAqB,EAAA;AACvB,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,6DAAA;AAAA,aACF,CAAA;AAAA,WACF;AACA,UAAsB,mBAAA,GAAA,cAAA,CAAA;AAAA,SACxB;AAAA,OACF;AAAA,KACF,CAAA;AAEA,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAS,EAAAC,uBAAA;AAAA,QACT,aAAe,EAAAC,yCAAA;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,OAAA;AAAA,QACA,aAAA;AAAA,OACC,EAAA;AACD,QAAA,MAAM,eAAkB,GAAA;AAAA,UACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,SAC7B,CAAA;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,oCAAoC,CAC5D,GAAAC,qEAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC,CAAA;AAAA,SAEvD,GAAA,eAAA,CAAA;AAEJ,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,QAAA,EAAU,SAAU,CAAA,yBAAA,CAA0B,QAAQ,CAAA;AAAA,UACtD,OAAA,EAASC,gEAA+B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,YACzD,SAAA;AAAA,YACA,IAAA;AAAA,YACA,QAAA;AAAA,YACA,MAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,YACf,iBAAA;AAAA,YACA,mBAAA;AAAA,WACD,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-techdocs",
-  "version": "0.2.3-next.1",
+  "version": "0.3.0",
   "description": "A module for the search backend that exports techdocs modules",
   "backstage": {
     "role": "backend-plugin-module",
@@ -19,6 +19,7 @@
   "license": "Apache-2.0",
   "exports": {
     ".": {
+      "backstage": "@backstage/BackendFeature",
       "require": "./dist/index.cjs.js",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.cjs.js"
@@ -49,23 +50,23 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "1.0.1-next.0",
-    "@backstage/catalog-client": "1.7.0",
-    "@backstage/catalog-model": "1.7.0",
-    "@backstage/config": "1.2.0",
-    "@backstage/plugin-catalog-common": "1.1.0",
-    "@backstage/plugin-catalog-node": "1.13.1-next.0",
-    "@backstage/plugin-permission-common": "0.8.1",
-    "@backstage/plugin-search-backend-node": "1.3.3-next.1",
-    "@backstage/plugin-search-common": "1.2.14",
-    "@backstage/plugin-techdocs-node": "1.12.12-next.1",
+    "@backstage/backend-plugin-api": "^1.0.1",
+    "@backstage/catalog-client": "^1.7.1",
+    "@backstage/catalog-model": "^1.7.0",
+    "@backstage/config": "^1.2.0",
+    "@backstage/plugin-catalog-common": "^1.1.0",
+    "@backstage/plugin-catalog-node": "^1.13.1",
+    "@backstage/plugin-permission-common": "^0.8.1",
+    "@backstage/plugin-search-backend-node": "^1.3.3",
+    "@backstage/plugin-search-common": "^1.2.14",
+    "@backstage/plugin-techdocs-node": "^1.12.12",
     "lodash": "^4.17.21",
     "node-fetch": "^2.7.0",
     "p-limit": "^3.1.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.0.1-next.1",
-    "@backstage/cli": "0.28.0-next.1",
+    "@backstage/backend-test-utils": "^1.0.1",
+    "@backstage/cli": "^0.28.0",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts"