@backstage/plugin-search-backend-module-techdocs 0.3.7-next.2 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @backstage/plugin-search-backend-module-techdocs
 
+## 0.4.0
+
+### Minor Changes
+
+- d5c4a9d: **BREAKING** Removed support for the legacy backend system and references to `@backstage/backend-common`, please migrate to the new backend system.
+
+### Patch Changes
+
+- d32bdc4: Added an extension point that allows for custom entity filtering during document collation.
+- Updated dependencies
+  - @backstage/plugin-techdocs-node@1.13.1
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/catalog-client@1.9.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/config@1.3.2
+  - @backstage/plugin-catalog-common@1.1.3
+  - @backstage/plugin-catalog-node@1.16.1
+  - @backstage/plugin-permission-common@0.8.4
+  - @backstage/plugin-search-backend-node@1.3.9
+  - @backstage/plugin-search-common@1.2.17
+
 ## 0.3.7-next.2
 
 ### Patch Changes

package/dist/collators/DefaultTechDocsCollatorFactory.cjs.js

@@ -1,6 +1,5 @@
 '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');
@@ -25,6 +24,8 @@ class DefaultTechDocsCollatorFactory {
   legacyPathCasing;
   entityTransformer;
   documentTransformer;
+  entityFilterFunction;
+  customCatalogApiFilters;
   constructor(options) {
     this.discovery = options.discovery;
     this.locationTemplate = options.locationTemplate || "/docs/:namespace/:kind/:name/:path";
@@ -34,11 +35,9 @@ class DefaultTechDocsCollatorFactory {
     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;
+    this.entityFilterFunction = options.entityFilterFunction;
+    this.customCatalogApiFilters = options.customCatalogApiFilters;
+    this.auth = options.auth;
   }
   static fromConfig(config, options) {
     const legacyPathCasing = config.getOptionalBoolean(
@@ -74,7 +73,8 @@ class DefaultTechDocsCollatorFactory {
       const entities = (await this.catalogClient.getEntities(
         {
           filter: {
-            "metadata.annotations.backstage.io/techdocs-ref": catalogClient.CATALOG_FILTER_EXISTS
+            "metadata.annotations.backstage.io/techdocs-ref": catalogClient.CATALOG_FILTER_EXISTS,
+            ...this.customCatalogApiFilters
           },
           limit: batchSize,
           offset: entitiesRetrieved
@@ -83,7 +83,8 @@ class DefaultTechDocsCollatorFactory {
       )).items;
       moreEntitiesToGet = entities.length === batchSize;
       entitiesRetrieved += entities.length;
-      const docPromises = entities.filter((it) => it.metadata?.annotations?.["backstage.io/techdocs-ref"]).map(
+      const filteredEntities = this.entityFilterFunction ? this.entityFilterFunction(entities) : this.defaultFilteringFunction(entities);
+      const docPromises = filteredEntities.map(
         (entity) => limit(async () => {
           const entityInfo = DefaultTechDocsCollatorFactory.handleEntityInfoCasing(
             this.legacyPathCasing,
@@ -98,7 +99,7 @@ class DefaultTechDocsCollatorFactory {
               onBehalfOf: await this.auth.getOwnServiceCredentials(),
               targetPluginId: "techdocs"
             });
-            const searchIndexResponse = await fetch(
+            const searchIndex = await fetch(
               DefaultTechDocsCollatorFactory.constructDocsIndexUrl(
                 techDocsBaseUrl,
                 entityInfo
@@ -108,15 +109,7 @@ class DefaultTechDocsCollatorFactory {
                   Authorization: `Bearer ${techdocsToken}`
                 }
               }
-            );
-            const searchIndex = await Promise.race([
-              searchIndexResponse.json(),
-              new Promise((_resolve, reject) => {
-                setTimeout(() => {
-                  reject("Could not parse JSON in 5 seconds.");
-                }, 5e3);
-              })
-            ]);
+            ).then((res) => res.json());
             return searchIndex.docs.map((doc) => ({
               ...defaultTechDocsCollatorEntityTransformer.defaultTechDocsCollatorEntityTransformer(entity),
               ...defaultTechDocsCollatorDocumentTransformer.defaultTechDocsCollatorDocumentTransformer(doc),
@@ -157,6 +150,11 @@ class DefaultTechDocsCollatorFactory {
     }
     return formatted;
   }
+  defaultFilteringFunction(entities) {
+    return entities.filter(
+      (entity) => entity.metadata?.annotations?.["backstage.io/techdocs-ref"]
+    );
+  }
   static constructDocsIndexUrl(techDocsBaseUrl, entityInfo) {
     return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;
   }

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

@@ -1 +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 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","defaultTechDocsCollatorEntityTransformer","defaultTechDocsCollatorDocumentTransformer","stringifyEntityRef","RELATION_OWNED_BY","parseEntityRef"],"mappings":";;;;;;;;;;;;;;;AAqFO,MAAM,8BAAkE,CAAA;AAAA,EAC7D,IAAe,GAAA,UAAA;AAAA,EACf,oBACd,GAAAA,iCAAA;AAAA,EAEM,SAAA;AAAA,EACA,gBAAA;AAAA,EACS,MAAA;AAAA,EACA,IAAA;AAAA,EACA,aAAA;AAAA,EACA,gBAAA;AAAA,EACA,gBAAA;AAAA,EACT,iBAAA;AAAA,EACA,mBAAA;AAAA,EAEA,YAAY,OAAyC,EAAA;AAC3D,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA;AACzB,IAAK,IAAA,CAAA,gBAAA,GACH,QAAQ,gBAAoB,IAAA,oCAAA;AAC9B,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,IAAA,CAAK,MAAM,CAAA;AAC9D,IAAK,IAAA,CAAA,aAAA,GACH,QAAQ,aACR,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,OAAQ,CAAA,SAAA,EAAW,CAAA;AACvD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,EAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,KAAA;AACpD,IAAA,IAAA,CAAK,iBAAoB,GAAA,OAAA,CAAQ,iBAAsB,KAAA,OAAO,EAAC,CAAA,CAAA;AAC/D,IAAA,IAAA,CAAK,mBAAsB,GAAA,OAAA,CAAQ,mBAAwB,KAAA,OAAO,EAAC,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;AAAA,KACvB,CAAE,CAAA,IAAA;AAAA;AACL,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,OAAyC,EAAA;AACzE,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL;AAAA,KACG,IAAA,KAAA;AACP,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B;AAAA,KACF;AACA,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B;AAAA,KACF;AACA,IAAA,OAAO,IAAI,8BAA+B,CAAA;AAAA,MACxC,GAAG,OAAA;AAAA,MACH,gBAAA;AAAA,MACA,gBAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA;AACH,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA;AAAA;AACrC,EAEA,OAAe,OAA6D,GAAA;AAC1E,IAAM,MAAA,KAAA,GAAQC,uBAAO,CAAA,IAAA,CAAK,gBAAgB,CAAA;AAC1C,IAAA,MAAM,eAAkB,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,UAAU,CAAA;AAElE,IAAA,IAAI,iBAAoB,GAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA;AAMxB,IAAM,MAAA,SAAA,GAAY,KAAK,gBAAmB,GAAA,EAAA;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;AAAA,OACjB,CAAA;AAED,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,QACvB;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,gDACE,EAAAC;AAAA,WACJ;AAAA,UACA,KAAO,EAAA,SAAA;AAAA,UACP,MAAQ,EAAA;AAAA,SACV;AAAA,QACA,EAAE,OAAO,YAAa;AAAA,OAExB,EAAA,KAAA;AAGF,MAAA,iBAAA,GAAoB,SAAS,MAAW,KAAA,SAAA;AACxC,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA;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;AAAA;AACxB,WACF;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;AAAA,aACjB,CAAA;AAEH,YAAA,MAAM,sBAAsB,MAAM,KAAA;AAAA,cAChC,8BAA+B,CAAA,qBAAA;AAAA,gBAC7B,eAAA;AAAA,gBACA;AAAA,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA;AAAA,kBACP,aAAA,EAAe,UAAU,aAAa,CAAA;AAAA;AACxC;AACF,aACF;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;AAAA,mBAC1C,GAAI,CAAA;AAAA,eACR;AAAA,aACF,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;AAAA;AACZ,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;AAAA;AACxC,aACA,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;AAAA,aACF;AACA,YAAA,OAAO,EAAC;AAAA;AACV,SACD;AAAA,OACH;AACF,MAAA,OAAA,CAAQ,MAAM,OAAA,CAAQ,GAAI,CAAA,WAAW,GAAG,IAAK,EAAA;AAAA;AAC/C;AACF,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA;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;AAAA;AAEhD,IAAO,OAAA,SAAA;AAAA;AACT,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;AAAA;AACrG,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;AAAA,KAC3D,EAAG,EAAgB,CAAA;AAAA;AAE3B;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;AACrE,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,2BAAA,CAAe,MAAM,SAAS,CAAA;AAC/C,MAAO,OAAA,IAAA;AAAA;AACT;AAEF,EAAO,OAAA,EAAA;AACT;;;;"}
+{"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  CATALOG_FILTER_EXISTS,\n  CatalogApi,\n  CatalogClient,\n  EntityFilterQuery,\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 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  LoggerService,\n} from '@backstage/backend-plugin-api';\n\n/**\n * Options to configure the TechDocs collator factory\n *\n * @internal\n */\nexport type TechDocsCollatorFactoryOptions = {\n  discovery: DiscoveryService;\n  logger: LoggerService;\n  auth: AuthService;\n  locationTemplate?: string;\n  catalogClient?: CatalogApi;\n  parallelismLimit?: number;\n  legacyPathCasing?: boolean;\n  entityTransformer?: TechDocsCollatorEntityTransformer;\n  documentTransformer?: TechDocsCollatorDocumentTransformer;\n  entityFilterFunction?: (entity: Entity[]) => Entity[];\n  customCatalogApiFilters?: EntityFilterQuery;\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 * @internal\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  private entityFilterFunction: Function | undefined;\n  private customCatalogApiFilters: EntityFilterQuery | undefined;\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    this.entityFilterFunction = options.entityFilterFunction;\n    this.customCatalogApiFilters = options.customCatalogApiFilters;\n    this.auth = options.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              ...this.customCatalogApiFilters,\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 filteredEntities = this.entityFilterFunction\n        ? this.entityFilterFunction(entities)\n        : this.defaultFilteringFunction(entities);\n\n      const docPromises = filteredEntities.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 searchIndex = await fetch(\n              DefaultTechDocsCollatorFactory.constructDocsIndexUrl(\n                techDocsBaseUrl,\n                entityInfo,\n              ),\n              {\n                headers: {\n                  Authorization: `Bearer ${techdocsToken}`,\n                },\n              },\n            ).then(res => res.json());\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 defaultFilteringFunction(entities: Entity[]): Entity[] {\n    return entities.filter(\n      entity => entity.metadata?.annotations?.['backstage.io/techdocs-ref'],\n    );\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","Readable","pLimit","CATALOG_FILTER_EXISTS","defaultTechDocsCollatorEntityTransformer","defaultTechDocsCollatorDocumentTransformer","stringifyEntityRef","RELATION_OWNED_BY","parseEntityRef"],"mappings":";;;;;;;;;;;;;;AA+EO,MAAM,8BAAkE,CAAA;AAAA,EAC7D,IAAe,GAAA,UAAA;AAAA,EACf,oBACd,GAAAA,iCAAA;AAAA,EAEM,SAAA;AAAA,EACA,gBAAA;AAAA,EACS,MAAA;AAAA,EACA,IAAA;AAAA,EACA,aAAA;AAAA,EACA,gBAAA;AAAA,EACA,gBAAA;AAAA,EACT,iBAAA;AAAA,EACA,mBAAA;AAAA,EACA,oBAAA;AAAA,EACA,uBAAA;AAAA,EAEA,YAAY,OAAyC,EAAA;AAC3D,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA;AACzB,IAAK,IAAA,CAAA,gBAAA,GACH,QAAQ,gBAAoB,IAAA,oCAAA;AAC9B,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,IAAA,CAAK,MAAM,CAAA;AAC9D,IAAK,IAAA,CAAA,aAAA,GACH,QAAQ,aACR,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,OAAQ,CAAA,SAAA,EAAW,CAAA;AACvD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,EAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,KAAA;AACpD,IAAA,IAAA,CAAK,iBAAoB,GAAA,OAAA,CAAQ,iBAAsB,KAAA,OAAO,EAAC,CAAA,CAAA;AAC/D,IAAA,IAAA,CAAK,mBAAsB,GAAA,OAAA,CAAQ,mBAAwB,KAAA,OAAO,EAAC,CAAA,CAAA;AACnE,IAAA,IAAA,CAAK,uBAAuB,OAAQ,CAAA,oBAAA;AACpC,IAAA,IAAA,CAAK,0BAA0B,OAAQ,CAAA,uBAAA;AACvC,IAAA,IAAA,CAAK,OAAO,OAAQ,CAAA,IAAA;AAAA;AACtB,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,OAAyC,EAAA;AACzE,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL;AAAA,KACG,IAAA,KAAA;AACP,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B;AAAA,KACF;AACA,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B;AAAA,KACF;AACA,IAAA,OAAO,IAAI,8BAA+B,CAAA;AAAA,MACxC,GAAG,OAAA;AAAA,MACH,gBAAA;AAAA,MACA,gBAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA;AACH,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA;AAAA;AACrC,EAEA,OAAe,OAA6D,GAAA;AAC1E,IAAM,MAAA,KAAA,GAAQC,uBAAO,CAAA,IAAA,CAAK,gBAAgB,CAAA;AAC1C,IAAA,MAAM,eAAkB,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,UAAU,CAAA;AAElE,IAAA,IAAI,iBAAoB,GAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA;AAMxB,IAAM,MAAA,SAAA,GAAY,KAAK,gBAAmB,GAAA,EAAA;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;AAAA,OACjB,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,YACF,GAAG,IAAK,CAAA;AAAA,WACV;AAAA,UACA,KAAO,EAAA,SAAA;AAAA,UACP,MAAQ,EAAA;AAAA,SACV;AAAA,QACA,EAAE,OAAO,YAAa;AAAA,OAExB,EAAA,KAAA;AAGF,MAAA,iBAAA,GAAoB,SAAS,MAAW,KAAA,SAAA;AACxC,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA;AAE9B,MAAM,MAAA,gBAAA,GAAmB,KAAK,oBAC1B,GAAA,IAAA,CAAK,qBAAqB,QAAQ,CAAA,GAClC,IAAK,CAAA,wBAAA,CAAyB,QAAQ,CAAA;AAE1C,MAAA,MAAM,cAAc,gBAAiB,CAAA,GAAA;AAAA,QAAI,CAAC,MACxC,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;AAAA;AACxB,WACF;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;AAAA,aACjB,CAAA;AAEH,YAAA,MAAM,cAAc,MAAM,KAAA;AAAA,cACxB,8BAA+B,CAAA,qBAAA;AAAA,gBAC7B,eAAA;AAAA,gBACA;AAAA,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA;AAAA,kBACP,aAAA,EAAe,UAAU,aAAa,CAAA;AAAA;AACxC;AACF,aACA,CAAA,IAAA,CAAK,CAAO,GAAA,KAAA,GAAA,CAAI,MAAM,CAAA;AAExB,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;AAAA;AACZ,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;AAAA;AACxC,aACA,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;AAAA,aACF;AACA,YAAA,OAAO,EAAC;AAAA;AACV,SACD;AAAA,OACH;AACA,MAAA,OAAA,CAAQ,MAAM,OAAA,CAAQ,GAAI,CAAA,WAAW,GAAG,IAAK,EAAA;AAAA;AAC/C;AACF,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA;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;AAAA;AAEhD,IAAO,OAAA,SAAA;AAAA;AACT,EAEQ,yBAAyB,QAA8B,EAAA;AAC7D,IAAA,OAAO,QAAS,CAAA,MAAA;AAAA,MACd,CAAU,MAAA,KAAA,MAAA,CAAO,QAAU,EAAA,WAAA,GAAc,2BAA2B;AAAA,KACtE;AAAA;AACF,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;AAAA;AACrG,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;AAAA,KAC3D,EAAG,EAAgB,CAAA;AAAA;AAE3B;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;AACrE,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,2BAAA,CAAe,MAAM,SAAS,CAAA;AAC/C,MAAO,OAAA,IAAA;AAAA;AACT;AAEF,EAAO,OAAA,EAAA;AACT;;;;"}

package/dist/index.cjs.js

@@ -3,13 +3,12 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var module$1 = require('./module.cjs.js');
-var DefaultTechDocsCollatorFactory = require('./collators/DefaultTechDocsCollatorFactory.cjs.js');
 var defaultTechDocsCollatorEntityTransformer = require('./collators/defaultTechDocsCollatorEntityTransformer.cjs.js');
 
 
 
 exports.default = module$1.default;
+exports.techDocsCollatorEntityFilterExtensionPoint = module$1.techDocsCollatorEntityFilterExtensionPoint;
 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":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,34 +1,13 @@
 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';
-import { Permission } from '@backstage/plugin-permission-common';
-import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
-import { Readable } from 'stream';
+import { EntityFilterQuery } from '@backstage/catalog-client';
 import { Entity } from '@backstage/catalog-model';
 import { TechDocsDocument } from '@backstage/plugin-techdocs-node';
 
 /** @public */
-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;
+type TechDocsCollatorEntityTransformer = (entity: Entity) => Partial<Omit<TechDocsDocument, 'location' | 'authorization'>>;
 
 /** @public */
-type TechDocsCollatorEntityTransformer = (entity: Entity) => Partial<Omit<TechDocsDocument, 'location' | 'authorization'>>;
+declare const defaultTechDocsCollatorEntityTransformer: TechDocsCollatorEntityTransformer;
 
 /** @public */
 interface MkSearchIndexDoc {
@@ -40,54 +19,32 @@ interface MkSearchIndexDoc {
 /** @public */
 type TechDocsCollatorDocumentTransformer = (doc: MkSearchIndexDoc) => Partial<Omit<TechDocsDocument, 'location' | 'authorization' | 'kind' | 'namespace' | 'name' | 'lifecycle' | 'owner'>>;
 
+/** @public */
+interface TechDocsCollatorEntityTransformerExtensionPoint {
+    setTransformer(transformer: TechDocsCollatorEntityTransformer): void;
+    setDocumentTransformer(transformer: TechDocsCollatorDocumentTransformer): void;
+}
 /**
- * Options to configure the TechDocs collator factory
+ * Extension point used to customize the TechDocs collator entity transformer.
  *
  * @public
- * @deprecated This type is deprecated along with the {@link DefaultTechDocsCollatorFactory}.
  */
-type TechDocsCollatorFactoryOptions = {
-    discovery: DiscoveryService;
-    logger: LoggerService;
-    tokenManager?: TokenManager;
-    auth?: AuthService;
-    httpAuth?: HttpAuthService;
-    locationTemplate?: string;
-    catalogClient?: CatalogApi;
-    parallelismLimit?: number;
-    legacyPathCasing?: boolean;
-    entityTransformer?: TechDocsCollatorEntityTransformer;
-    documentTransformer?: TechDocsCollatorDocumentTransformer;
-};
+declare const techdocsCollatorEntityTransformerExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>;
+/** @public */
+interface TechDocsCollatorEntityFilterExtensionPoint {
+    setEntityFilterFunction(filterFunction: (entities: Entity[]) => Entity[]): void;
+    setCustomCatalogApiFilters(apiFilters: EntityFilterQuery): void;
+}
 /**
- * A search collator factory responsible for gathering and transforming
- * TechDocs documents.
+ * Extension point used to filter the entities that the collator will use.
  *
  * @public
- * @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).
  */
-declare class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {
-    readonly type: string;
-    readonly visibilityPermission: Permission;
-    private discovery;
-    private locationTemplate;
-    private readonly logger;
-    private readonly auth;
-    private readonly catalogClient;
-    private readonly parallelismLimit;
-    private readonly legacyPathCasing;
-    private entityTransformer;
-    private documentTransformer;
-    private constructor();
-    static fromConfig(config: Config, options: TechDocsCollatorFactoryOptions): DefaultTechDocsCollatorFactory;
-    getCollator(): Promise<Readable>;
-    private execute;
-    private applyArgsToFormat;
-    private static constructDocsIndexUrl;
-    private static handleEntityInfoCasing;
-}
-
-/** @public */
-declare const defaultTechDocsCollatorEntityTransformer: TechDocsCollatorEntityTransformer;
+declare const techDocsCollatorEntityFilterExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechDocsCollatorEntityFilterExtensionPoint>;
+/**
+ * @public
+ * Search backend module for the TechDocs index.
+ */
+declare const _default: _backstage_backend_plugin_api.BackendFeature;
 
-export { DefaultTechDocsCollatorFactory, type MkSearchIndexDoc, type TechDocsCollatorDocumentTransformer, type TechDocsCollatorEntityTransformer, type TechDocsCollatorEntityTransformerExtensionPoint, type TechDocsCollatorFactoryOptions, _default as default, defaultTechDocsCollatorEntityTransformer, techdocsCollatorEntityTransformerExtensionPoint };
+export { type MkSearchIndexDoc, type TechDocsCollatorDocumentTransformer, type TechDocsCollatorEntityFilterExtensionPoint, type TechDocsCollatorEntityTransformer, type TechDocsCollatorEntityTransformerExtensionPoint, _default as default, defaultTechDocsCollatorEntityTransformer, techDocsCollatorEntityFilterExtensionPoint, techdocsCollatorEntityTransformerExtensionPoint };

package/dist/module.cjs.js

@@ -4,18 +4,23 @@ 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');
+var DefaultTechDocsCollatorFactory = require('./collators/DefaultTechDocsCollatorFactory.cjs.js');
 
 const techdocsCollatorEntityTransformerExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "search.techdocsCollator.transformer"
 });
+const techDocsCollatorEntityFilterExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "search.techdocsCollator.entityFilter"
+});
 var feature = backendPluginApi.createBackendModule({
   pluginId: "search",
   moduleId: "techdocs-collator",
   register(env) {
     let entityTransformer;
     let documentTransformer;
+    let entityFilterFunction;
+    let customCatalogApiFilters;
     env.registerExtensionPoint(
       techdocsCollatorEntityTransformerExtensionPoint,
       {
@@ -37,12 +42,29 @@ var feature = backendPluginApi.createBackendModule({
         }
       }
     );
+    env.registerExtensionPoint(techDocsCollatorEntityFilterExtensionPoint, {
+      setEntityFilterFunction(newEntityFilterFunction) {
+        if (entityFilterFunction) {
+          throw new Error(
+            "TechDocs entity filter functions may only be set once"
+          );
+        }
+        entityFilterFunction = newEntityFilterFunction;
+      },
+      setCustomCatalogApiFilters(newCatalogApiFilters) {
+        if (customCatalogApiFilters) {
+          throw new Error(
+            "TechDocs catalog entity filters may only be set once"
+          );
+        }
+        customCatalogApiFilters = newCatalogApiFilters;
+      }
+    });
     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,
@@ -52,7 +74,6 @@ var feature = backendPluginApi.createBackendModule({
         config,
         logger,
         auth,
-        httpAuth,
         discovery,
         scheduler,
         catalog,
@@ -68,14 +89,15 @@ var feature = backendPluginApi.createBackendModule({
         ) : defaultSchedule;
         indexRegistry.addCollator({
           schedule: scheduler.createScheduledTaskRunner(schedule),
-          factory: pluginSearchBackendModuleTechdocs.DefaultTechDocsCollatorFactory.fromConfig(config, {
+          factory: DefaultTechDocsCollatorFactory.DefaultTechDocsCollatorFactory.fromConfig(config, {
             discovery,
             auth,
-            httpAuth,
             logger,
             catalogClient: catalog,
             entityTransformer,
-            documentTransformer
+            documentTransformer,
+            customCatalogApiFilters,
+            entityFilterFunction
           })
         });
       }
@@ -84,5 +106,6 @@ var feature = backendPluginApi.createBackendModule({
 });
 
 exports.default = feature;
+exports.techDocsCollatorEntityFilterExtensionPoint = techDocsCollatorEntityFilterExtensionPoint;
 exports.techdocsCollatorEntityTransformerExtensionPoint = techdocsCollatorEntityTransformerExtensionPoint;
 //# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -1 +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;AACN,CAAC;AAMH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA;AACJ,IAAI,IAAA,mBAAA;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;AAAA,aACF;AAAA;AAEF,UAAoB,iBAAA,GAAA,cAAA;AAAA,SACtB;AAAA,QACA,uBAAuB,cAAgB,EAAA;AACrC,UAAA,IAAI,mBAAqB,EAAA;AACvB,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA;AAEF,UAAsB,mBAAA,GAAA,cAAA;AAAA;AACxB;AACF,KACF;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;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,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;AAAA,SAC7B;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,oCAAoC,CAC5D,GAAAC,qEAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC;AAAA,SAEvD,GAAA,eAAA;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;AAAA,WACD;AAAA,SACF,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC,CAAA;;;;;"}
+{"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 { EntityFilterQuery } from '@backstage/catalog-client';\nimport { Entity } from '@backstage/catalog-model';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { DefaultTechDocsCollatorFactory } from './collators/DefaultTechDocsCollatorFactory';\nimport {\n  TechDocsCollatorDocumentTransformer,\n  TechDocsCollatorEntityTransformer,\n} from './collators';\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/** @public */\nexport interface TechDocsCollatorEntityFilterExtensionPoint {\n  setEntityFilterFunction(\n    filterFunction: (entities: Entity[]) => Entity[],\n  ): void;\n  setCustomCatalogApiFilters(apiFilters: EntityFilterQuery): void;\n}\n\n/**\n * Extension point used to filter the entities that the collator will use.\n *\n * @public\n */\nexport const techDocsCollatorEntityFilterExtensionPoint =\n  createExtensionPoint<TechDocsCollatorEntityFilterExtensionPoint>({\n    id: 'search.techdocsCollator.entityFilter',\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    let entityFilterFunction: ((e: Entity[]) => Entity[]) | undefined;\n    let customCatalogApiFilters: EntityFilterQuery | 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.registerExtensionPoint(techDocsCollatorEntityFilterExtensionPoint, {\n      setEntityFilterFunction(newEntityFilterFunction) {\n        if (entityFilterFunction) {\n          throw new Error(\n            'TechDocs entity filter functions may only be set once',\n          );\n        }\n        entityFilterFunction = newEntityFilterFunction;\n      },\n      setCustomCatalogApiFilters(newCatalogApiFilters) {\n        if (customCatalogApiFilters) {\n          throw new Error(\n            'TechDocs catalog entity filters may only be set once',\n          );\n        }\n        customCatalogApiFilters = newCatalogApiFilters;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        auth: coreServices.auth,\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        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            logger,\n            catalogClient: catalog,\n            entityTransformer,\n            documentTransformer,\n            customCatalogApiFilters,\n            entityFilterFunction,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readSchedulerServiceTaskScheduleDefinitionFromConfig","DefaultTechDocsCollatorFactory"],"mappings":";;;;;;;;;AAkDO,MAAM,kDACXA,qCAAsE,CAAA;AAAA,EACpE,EAAI,EAAA;AACN,CAAC;AAeI,MAAM,6CACXA,qCAAiE,CAAA;AAAA,EAC/D,EAAI,EAAA;AACN,CAAC;AAMH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA;AACJ,IAAI,IAAA,mBAAA;AACJ,IAAI,IAAA,oBAAA;AACJ,IAAI,IAAA,uBAAA;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;AAAA,aACF;AAAA;AAEF,UAAoB,iBAAA,GAAA,cAAA;AAAA,SACtB;AAAA,QACA,uBAAuB,cAAgB,EAAA;AACrC,UAAA,IAAI,mBAAqB,EAAA;AACvB,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA;AAEF,UAAsB,mBAAA,GAAA,cAAA;AAAA;AACxB;AACF,KACF;AAEA,IAAA,GAAA,CAAI,uBAAuB,0CAA4C,EAAA;AAAA,MACrE,wBAAwB,uBAAyB,EAAA;AAC/C,QAAA,IAAI,oBAAsB,EAAA;AACxB,UAAA,MAAM,IAAI,KAAA;AAAA,YACR;AAAA,WACF;AAAA;AAEF,QAAuB,oBAAA,GAAA,uBAAA;AAAA,OACzB;AAAA,MACA,2BAA2B,oBAAsB,EAAA;AAC/C,QAAA,IAAI,uBAAyB,EAAA;AAC3B,UAAA,MAAM,IAAI,KAAA;AAAA,YACR;AAAA,WACF;AAAA;AAEF,QAA0B,uBAAA,GAAA,oBAAA;AAAA;AAC5B,KACD,CAAA;AAED,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,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAS,EAAAC,uBAAA;AAAA,QACT,aAAe,EAAAC;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,OAAA;AAAA,QACA;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;AAAA,SAC7B;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,oCAAoC,CAC5D,GAAAC,qEAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC;AAAA,SAEvD,GAAA,eAAA;AAEJ,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,QAAA,EAAU,SAAU,CAAA,yBAAA,CAA0B,QAAQ,CAAA;AAAA,UACtD,OAAA,EAASC,6DAA+B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,YACzD,SAAA;AAAA,YACA,IAAA;AAAA,YACA,MAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,YACf,iBAAA;AAAA,YACA,mBAAA;AAAA,YACA,uBAAA;AAAA,YACA;AAAA,WACD;AAAA,SACF,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC,CAAA;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-techdocs",
-  "version": "0.3.7-next.2",
+  "version": "0.4.0",
   "description": "A module for the search backend that exports techdocs modules",
   "backstage": {
     "role": "backend-plugin-module",
@@ -62,23 +62,22 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "1.2.1-next.1",
-    "@backstage/catalog-client": "1.9.1",
-    "@backstage/catalog-model": "1.7.3",
-    "@backstage/config": "1.3.2",
-    "@backstage/plugin-catalog-common": "1.1.3",
-    "@backstage/plugin-catalog-node": "1.16.1-next.1",
-    "@backstage/plugin-permission-common": "0.8.4",
-    "@backstage/plugin-search-backend-node": "1.3.9-next.1",
-    "@backstage/plugin-search-common": "1.2.17",
-    "@backstage/plugin-techdocs-node": "1.13.1-next.2",
+    "@backstage/backend-plugin-api": "^1.2.1",
+    "@backstage/catalog-client": "^1.9.1",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/config": "^1.3.2",
+    "@backstage/plugin-catalog-common": "^1.1.3",
+    "@backstage/plugin-catalog-node": "^1.16.1",
+    "@backstage/plugin-permission-common": "^0.8.4",
+    "@backstage/plugin-search-backend-node": "^1.3.9",
+    "@backstage/plugin-search-common": "^1.2.17",
+    "@backstage/plugin-techdocs-node": "^1.13.1",
     "lodash": "^4.17.21",
     "p-limit": "^3.1.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.3.1-next.2",
-    "@backstage/cli": "0.31.0-next.1",
+    "@backstage/backend-test-utils": "^1.3.1",
+    "@backstage/cli": "^0.31.0",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts"