@backstage/plugin-search-backend-module-catalog 0.3.7-next.0 → 0.3.7

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-search-backend-module-catalog
 
+## 0.3.7
+
+### Patch Changes
+
+- d9bda0f: Allow filter to be an array in config schema
+- Updated dependencies
+  - @backstage/catalog-client@1.11.0
+  - @backstage/plugin-catalog-node@1.18.0
+  - @backstage/plugin-search-backend-node@1.3.14
+  - @backstage/backend-plugin-api@1.4.2
+
+## 0.3.7-next.1
+
+### Patch Changes
+
+- d9bda0f: Allow filter to be an array in config schema
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.4.2-next.0
+  - @backstage/catalog-client@1.11.0-next.0
+  - @backstage/catalog-model@1.7.5
+  - @backstage/config@1.3.3
+  - @backstage/errors@1.2.7
+  - @backstage/plugin-catalog-common@1.1.5
+  - @backstage/plugin-catalog-node@1.18.0-next.0
+  - @backstage/plugin-permission-common@0.9.1
+  - @backstage/plugin-search-backend-node@1.3.14-next.0
+  - @backstage/plugin-search-common@1.2.19
+
 ## 0.3.7-next.0
 
 ### Patch Changes

package/config.d.ts

@@ -36,7 +36,7 @@ export interface Config {
          *
          * Defaults to no filter, ie indexing all entities.
          */
-        filter?: object;
+        filter?: object | object[];
         /**
          * The number of entities to process at a time. Keep this at a
          * reasonable number to avoid overloading either the catalog or the

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

@@ -1 +1 @@
-{"version":3,"file":"DefaultCatalogCollatorFactory.cjs.js","sources":["../../src/collators/DefaultCatalogCollatorFactory.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { AuthService } from '@backstage/backend-plugin-api';\nimport { QueryEntitiesInitialRequest } from '@backstage/catalog-client';\nimport { stringifyEntityRef } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { CatalogEntityDocument } from '@backstage/plugin-catalog-common';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { Readable } from 'stream';\nimport { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\nimport { readCollatorConfigOptions } from './config';\nimport { defaultCatalogCollatorEntityTransformer } from './defaultCatalogCollatorEntityTransformer';\n\nexport type DefaultCatalogCollatorFactoryOptions = {\n  auth: AuthService;\n  catalog: CatalogService;\n  /*\n   * Allows you to customize how entities are shaped into documents.\n   */\n  entityTransformer?: CatalogCollatorEntityTransformer;\n};\n\n/**\n * Collates entities from the Catalog into documents for the search backend.\n */\nexport class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {\n  public readonly type = 'software-catalog';\n  public readonly visibilityPermission: Permission =\n    catalogEntityReadPermission;\n\n  private locationTemplate: string;\n  private filter?: QueryEntitiesInitialRequest['filter'];\n  private batchSize: number;\n  private readonly catalog: CatalogService;\n  private entityTransformer: CatalogCollatorEntityTransformer;\n  private auth: AuthService;\n\n  static fromConfig(\n    configRoot: Config,\n    options: DefaultCatalogCollatorFactoryOptions,\n  ) {\n    const configOptions = readCollatorConfigOptions(configRoot);\n    return new DefaultCatalogCollatorFactory({\n      locationTemplate: configOptions.locationTemplate,\n      filter: configOptions.filter,\n      batchSize: configOptions.batchSize,\n      entityTransformer: options.entityTransformer,\n      auth: options.auth,\n      catalog: options.catalog,\n    });\n  }\n\n  private constructor(options: {\n    locationTemplate: string;\n    filter: QueryEntitiesInitialRequest['filter'];\n    batchSize: number;\n    entityTransformer?: CatalogCollatorEntityTransformer;\n    auth: AuthService;\n    catalog: CatalogService;\n  }) {\n    const {\n      auth,\n      batchSize,\n      locationTemplate,\n      filter,\n      catalog,\n      entityTransformer,\n    } = options;\n\n    this.locationTemplate = locationTemplate;\n    this.filter = filter;\n    this.batchSize = batchSize;\n    this.catalog = catalog;\n    this.entityTransformer =\n      entityTransformer ?? defaultCatalogCollatorEntityTransformer;\n    this.auth = auth;\n  }\n\n  async getCollator(): Promise<Readable> {\n    return Readable.from(this.execute());\n  }\n\n  private async *execute(): AsyncGenerator<CatalogEntityDocument> {\n    let entitiesRetrieved = 0;\n    let cursor: string | undefined = undefined;\n\n    do {\n      const response = await this.catalog.queryEntities(\n        {\n          filter: this.filter,\n          limit: this.batchSize,\n          ...(cursor ? { cursor } : {}),\n        },\n        { credentials: await this.auth.getOwnServiceCredentials() },\n      );\n      cursor = response.pageInfo.nextCursor;\n      entitiesRetrieved += response.items.length;\n\n      for (const entity of response.items) {\n        yield {\n          ...this.entityTransformer(entity),\n          authorization: {\n            resourceRef: stringifyEntityRef(entity),\n          },\n          location: this.applyArgsToFormat(this.locationTemplate, {\n            namespace: encodeURIComponent(\n              entity.metadata.namespace || 'default',\n            ),\n            kind: encodeURIComponent(entity.kind),\n            name: encodeURIComponent(entity.metadata.name),\n          }),\n        };\n      }\n    } while (cursor);\n  }\n\n  private applyArgsToFormat(\n    format: string,\n    args: Record<string, string>,\n  ): string {\n    let formatted = format;\n\n    for (const [key, value] of Object.entries(args)) {\n      formatted = formatted.replace(`:${key}`, value);\n    }\n\n    return formatted.toLowerCase();\n  }\n}\n"],"names":["catalogEntityReadPermission","readCollatorConfigOptions","defaultCatalogCollatorEntityTransformer","Readable","stringifyEntityRef"],"mappings":";;;;;;;;AA0CO,MAAM,6BAAiE,CAAA;AAAA,EAC5D,IAAO,GAAA,kBAAA;AAAA,EACP,oBACd,GAAAA,iCAAA;AAAA,EAEM,gBAAA;AAAA,EACA,MAAA;AAAA,EACA,SAAA;AAAA,EACS,OAAA;AAAA,EACT,iBAAA;AAAA,EACA,IAAA;AAAA,EAER,OAAO,UACL,CAAA,UAAA,EACA,OACA,EAAA;AACA,IAAM,MAAA,aAAA,GAAgBC,iCAA0B,UAAU,CAAA;AAC1D,IAAA,OAAO,IAAI,6BAA8B,CAAA;AAAA,MACvC,kBAAkB,aAAc,CAAA,gBAAA;AAAA,MAChC,QAAQ,aAAc,CAAA,MAAA;AAAA,MACtB,WAAW,aAAc,CAAA,SAAA;AAAA,MACzB,mBAAmB,OAAQ,CAAA,iBAAA;AAAA,MAC3B,MAAM,OAAQ,CAAA,IAAA;AAAA,MACd,SAAS,OAAQ,CAAA;AAAA,KAClB,CAAA;AAAA;AACH,EAEQ,YAAY,OAOjB,EAAA;AACD,IAAM,MAAA;AAAA,MACJ,IAAA;AAAA,MACA,SAAA;AAAA,MACA,gBAAA;AAAA,MACA,MAAA;AAAA,MACA,OAAA;AAAA,MACA;AAAA,KACE,GAAA,OAAA;AAEJ,IAAA,IAAA,CAAK,gBAAmB,GAAA,gBAAA;AACxB,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA;AACd,IAAA,IAAA,CAAK,SAAY,GAAA,SAAA;AACjB,IAAA,IAAA,CAAK,OAAU,GAAA,OAAA;AACf,IAAA,IAAA,CAAK,oBACH,iBAAqB,IAAAC,+EAAA;AACvB,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA;AAAA;AACd,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA;AAAA;AACrC,EAEA,OAAe,OAAiD,GAAA;AAC9D,IAAA,IAAI,iBAAoB,GAAA,CAAA;AACxB,IAAA,IAAI,MAA6B,GAAA,KAAA,CAAA;AAEjC,IAAG,GAAA;AACD,MAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,OAAQ,CAAA,aAAA;AAAA,QAClC;AAAA,UACE,QAAQ,IAAK,CAAA,MAAA;AAAA,UACb,OAAO,IAAK,CAAA,SAAA;AAAA,UACZ,GAAI,MAAA,GAAS,EAAE,MAAA,KAAW;AAAC,SAC7B;AAAA,QACA,EAAE,WAAa,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,0BAA2B;AAAA,OAC5D;AACA,MAAA,MAAA,GAAS,SAAS,QAAS,CAAA,UAAA;AAC3B,MAAA,iBAAA,IAAqB,SAAS,KAAM,CAAA,MAAA;AAEpC,MAAW,KAAA,MAAA,MAAA,IAAU,SAAS,KAAO,EAAA;AACnC,QAAM,MAAA;AAAA,UACJ,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,UAChC,aAAe,EAAA;AAAA,YACb,WAAA,EAAaC,gCAAmB,MAAM;AAAA,WACxC;AAAA,UACA,QAAU,EAAA,IAAA,CAAK,iBAAkB,CAAA,IAAA,CAAK,gBAAkB,EAAA;AAAA,YACtD,SAAW,EAAA,kBAAA;AAAA,cACT,MAAA,CAAO,SAAS,SAAa,IAAA;AAAA,aAC/B;AAAA,YACA,IAAA,EAAM,kBAAmB,CAAA,MAAA,CAAO,IAAI,CAAA;AAAA,YACpC,IAAM,EAAA,kBAAA,CAAmB,MAAO,CAAA,QAAA,CAAS,IAAI;AAAA,WAC9C;AAAA,SACH;AAAA;AACF,KACO,QAAA,MAAA;AAAA;AACX,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA;AAEhB,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;AAGhD,IAAA,OAAO,UAAU,WAAY,EAAA;AAAA;AAEjC;;;;"}
+{"version":3,"file":"DefaultCatalogCollatorFactory.cjs.js","sources":["../../src/collators/DefaultCatalogCollatorFactory.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { AuthService } from '@backstage/backend-plugin-api';\nimport { QueryEntitiesInitialRequest } from '@backstage/catalog-client';\nimport { stringifyEntityRef } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { CatalogEntityDocument } from '@backstage/plugin-catalog-common';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { Readable } from 'stream';\nimport { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\nimport { readCollatorConfigOptions } from './config';\nimport { defaultCatalogCollatorEntityTransformer } from './defaultCatalogCollatorEntityTransformer';\n\nexport type DefaultCatalogCollatorFactoryOptions = {\n  auth: AuthService;\n  catalog: CatalogService;\n  /*\n   * Allows you to customize how entities are shaped into documents.\n   */\n  entityTransformer?: CatalogCollatorEntityTransformer;\n};\n\n/**\n * Collates entities from the Catalog into documents for the search backend.\n */\nexport class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {\n  public readonly type = 'software-catalog';\n  public readonly visibilityPermission: Permission =\n    catalogEntityReadPermission;\n\n  private locationTemplate: string;\n  private filter?: QueryEntitiesInitialRequest['filter'];\n  private batchSize: number;\n  private readonly catalog: CatalogService;\n  private entityTransformer: CatalogCollatorEntityTransformer;\n  private auth: AuthService;\n\n  static fromConfig(\n    configRoot: Config,\n    options: DefaultCatalogCollatorFactoryOptions,\n  ) {\n    const configOptions = readCollatorConfigOptions(configRoot);\n    return new DefaultCatalogCollatorFactory({\n      locationTemplate: configOptions.locationTemplate,\n      filter: configOptions.filter,\n      batchSize: configOptions.batchSize,\n      entityTransformer: options.entityTransformer,\n      auth: options.auth,\n      catalog: options.catalog,\n    });\n  }\n\n  private constructor(options: {\n    locationTemplate: string;\n    filter: QueryEntitiesInitialRequest['filter'];\n    batchSize: number;\n    entityTransformer?: CatalogCollatorEntityTransformer;\n    auth: AuthService;\n    catalog: CatalogService;\n  }) {\n    const {\n      auth,\n      batchSize,\n      locationTemplate,\n      filter,\n      catalog,\n      entityTransformer,\n    } = options;\n\n    this.locationTemplate = locationTemplate;\n    this.filter = filter;\n    this.batchSize = batchSize;\n    this.catalog = catalog;\n    this.entityTransformer =\n      entityTransformer ?? defaultCatalogCollatorEntityTransformer;\n    this.auth = auth;\n  }\n\n  async getCollator(): Promise<Readable> {\n    return Readable.from(this.execute());\n  }\n\n  private async *execute(): AsyncGenerator<CatalogEntityDocument> {\n    let entitiesRetrieved = 0;\n    let cursor: string | undefined = undefined;\n\n    do {\n      const response = await this.catalog.queryEntities(\n        {\n          filter: this.filter,\n          limit: this.batchSize,\n          ...(cursor ? { cursor } : {}),\n        },\n        { credentials: await this.auth.getOwnServiceCredentials() },\n      );\n      cursor = response.pageInfo.nextCursor;\n      entitiesRetrieved += response.items.length;\n\n      for (const entity of response.items) {\n        yield {\n          ...this.entityTransformer(entity),\n          authorization: {\n            resourceRef: stringifyEntityRef(entity),\n          },\n          location: this.applyArgsToFormat(this.locationTemplate, {\n            namespace: encodeURIComponent(\n              entity.metadata.namespace || 'default',\n            ),\n            kind: encodeURIComponent(entity.kind),\n            name: encodeURIComponent(entity.metadata.name),\n          }),\n        };\n      }\n    } while (cursor);\n  }\n\n  private applyArgsToFormat(\n    format: string,\n    args: Record<string, string>,\n  ): string {\n    let formatted = format;\n\n    for (const [key, value] of Object.entries(args)) {\n      formatted = formatted.replace(`:${key}`, value);\n    }\n\n    return formatted.toLowerCase();\n  }\n}\n"],"names":["catalogEntityReadPermission","readCollatorConfigOptions","defaultCatalogCollatorEntityTransformer","Readable","stringifyEntityRef"],"mappings":";;;;;;;;AA0CO,MAAM,6BAAA,CAAiE;AAAA,EAC5D,IAAA,GAAO,kBAAA;AAAA,EACP,oBAAA,GACdA,iCAAA;AAAA,EAEM,gBAAA;AAAA,EACA,MAAA;AAAA,EACA,SAAA;AAAA,EACS,OAAA;AAAA,EACT,iBAAA;AAAA,EACA,IAAA;AAAA,EAER,OAAO,UAAA,CACL,UAAA,EACA,OAAA,EACA;AACA,IAAA,MAAM,aAAA,GAAgBC,iCAA0B,UAAU,CAAA;AAC1D,IAAA,OAAO,IAAI,6BAAA,CAA8B;AAAA,MACvC,kBAAkB,aAAA,CAAc,gBAAA;AAAA,MAChC,QAAQ,aAAA,CAAc,MAAA;AAAA,MACtB,WAAW,aAAA,CAAc,SAAA;AAAA,MACzB,mBAAmB,OAAA,CAAQ,iBAAA;AAAA,MAC3B,MAAM,OAAA,CAAQ,IAAA;AAAA,MACd,SAAS,OAAA,CAAQ;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEQ,YAAY,OAAA,EAOjB;AACD,IAAA,MAAM;AAAA,MACJ,IAAA;AAAA,MACA,SAAA;AAAA,MACA,gBAAA;AAAA,MACA,MAAA;AAAA,MACA,OAAA;AAAA,MACA;AAAA,KACF,GAAI,OAAA;AAEJ,IAAA,IAAA,CAAK,gBAAA,GAAmB,gBAAA;AACxB,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,SAAA,GAAY,SAAA;AACjB,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,oBACH,iBAAA,IAAqBC,+EAAA;AACvB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,WAAA,GAAiC;AACrC,IAAA,OAAOC,eAAA,CAAS,IAAA,CAAK,IAAA,CAAK,OAAA,EAAS,CAAA;AAAA,EACrC;AAAA,EAEA,OAAe,OAAA,GAAiD;AAC9D,IAAA,IAAI,iBAAA,GAAoB,CAAA;AACxB,IAAA,IAAI,MAAA,GAA6B,MAAA;AAEjC,IAAA,GAAG;AACD,MAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,aAAA;AAAA,QAClC;AAAA,UACE,QAAQ,IAAA,CAAK,MAAA;AAAA,UACb,OAAO,IAAA,CAAK,SAAA;AAAA,UACZ,GAAI,MAAA,GAAS,EAAE,MAAA,KAAW;AAAC,SAC7B;AAAA,QACA,EAAE,WAAA,EAAa,MAAM,IAAA,CAAK,IAAA,CAAK,0BAAyB;AAAE,OAC5D;AACA,MAAA,MAAA,GAAS,SAAS,QAAA,CAAS,UAAA;AAC3B,MAAA,iBAAA,IAAqB,SAAS,KAAA,CAAM,MAAA;AAEpC,MAAA,KAAA,MAAW,MAAA,IAAU,SAAS,KAAA,EAAO;AACnC,QAAA,MAAM;AAAA,UACJ,GAAG,IAAA,CAAK,iBAAA,CAAkB,MAAM,CAAA;AAAA,UAChC,aAAA,EAAe;AAAA,YACb,WAAA,EAAaC,gCAAmB,MAAM;AAAA,WACxC;AAAA,UACA,QAAA,EAAU,IAAA,CAAK,iBAAA,CAAkB,IAAA,CAAK,gBAAA,EAAkB;AAAA,YACtD,SAAA,EAAW,kBAAA;AAAA,cACT,MAAA,CAAO,SAAS,SAAA,IAAa;AAAA,aAC/B;AAAA,YACA,IAAA,EAAM,kBAAA,CAAmB,MAAA,CAAO,IAAI,CAAA;AAAA,YACpC,IAAA,EAAM,kBAAA,CAAmB,MAAA,CAAO,QAAA,CAAS,IAAI;AAAA,WAC9C;AAAA,SACH;AAAA,MACF;AAAA,IACF,CAAA,QAAS,MAAA;AAAA,EACX;AAAA,EAEQ,iBAAA,CACN,QACA,IAAA,EACQ;AACR,IAAA,IAAI,SAAA,GAAY,MAAA;AAEhB,IAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,IAAI,CAAA,EAAG;AAC/C,MAAA,SAAA,GAAY,SAAA,CAAU,OAAA,CAAQ,CAAA,CAAA,EAAI,GAAG,IAAI,KAAK,CAAA;AAAA,IAChD;AAEA,IAAA,OAAO,UAAU,WAAA,EAAY;AAAA,EAC/B;AACF;;;;"}

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

@@ -1 +1 @@
-{"version":3,"file":"config.cjs.js","sources":["../../src/collators/config.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  SchedulerServiceTaskScheduleDefinition,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { EntityFilterQuery } from '@backstage/catalog-client';\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\n\nconst configKey = 'search.collators.catalog';\n\nexport const defaults = {\n  schedule: {\n    frequency: { minutes: 10 },\n    timeout: { minutes: 15 },\n    initialDelay: { seconds: 3 },\n  },\n  collatorOptions: {\n    locationTemplate: '/catalog/:namespace/:kind/:name',\n    filter: undefined,\n    batchSize: 500,\n  },\n};\n\nexport function readScheduleConfigOptions(\n  configRoot: Config,\n): SchedulerServiceTaskScheduleDefinition {\n  let schedule: SchedulerServiceTaskScheduleDefinition | undefined = undefined;\n\n  const config = configRoot.getOptionalConfig(configKey);\n  if (config) {\n    const scheduleConfig = config.getOptionalConfig('schedule');\n    if (scheduleConfig) {\n      try {\n        schedule =\n          readSchedulerServiceTaskScheduleDefinitionFromConfig(scheduleConfig);\n      } catch (error) {\n        throw new InputError(`Invalid schedule at ${configKey}, ${error}`);\n      }\n    }\n  }\n\n  return schedule ?? defaults.schedule;\n}\n\nexport function readCollatorConfigOptions(configRoot: Config): {\n  locationTemplate: string;\n  filter: EntityFilterQuery | undefined;\n  batchSize: number;\n} {\n  const config = configRoot.getOptionalConfig(configKey);\n  if (!config) {\n    return defaults.collatorOptions;\n  }\n\n  return {\n    locationTemplate:\n      config.getOptionalString('locationTemplate') ??\n      defaults.collatorOptions.locationTemplate,\n    filter:\n      config.getOptional<EntityFilterQuery>('filter') ??\n      defaults.collatorOptions.filter,\n    batchSize:\n      config.getOptionalNumber('batchSize') ??\n      defaults.collatorOptions.batchSize,\n  };\n}\n"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig","InputError"],"mappings":";;;;;AAwBA,MAAM,SAAY,GAAA,0BAAA;AAEX,MAAM,QAAW,GAAA;AAAA,EACtB,QAAU,EAAA;AAAA,IACR,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,IACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,IACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE;AAAA,GAC7B;AAAA,EACA,eAAiB,EAAA;AAAA,IACf,gBAAkB,EAAA,iCAAA;AAAA,IAClB,MAAQ,EAAA,KAAA,CAAA;AAAA,IACR,SAAW,EAAA;AAAA;AAEf;AAEO,SAAS,0BACd,UACwC,EAAA;AACxC,EAAA,IAAI,QAA+D,GAAA,KAAA,CAAA;AAEnE,EAAM,MAAA,MAAA,GAAS,UAAW,CAAA,iBAAA,CAAkB,SAAS,CAAA;AACrD,EAAA,IAAI,MAAQ,EAAA;AACV,IAAM,MAAA,cAAA,GAAiB,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA;AAC1D,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAI,IAAA;AACF,QAAA,QAAA,GACEA,sEAAqD,cAAc,CAAA;AAAA,eAC9D,KAAO,EAAA;AACd,QAAA,MAAM,IAAIC,iBAAW,CAAA,CAAA,oBAAA,EAAuB,SAAS,CAAA,EAAA,EAAK,KAAK,CAAE,CAAA,CAAA;AAAA;AACnE;AACF;AAGF,EAAA,OAAO,YAAY,QAAS,CAAA,QAAA;AAC9B;AAEO,SAAS,0BAA0B,UAIxC,EAAA;AACA,EAAM,MAAA,MAAA,GAAS,UAAW,CAAA,iBAAA,CAAkB,SAAS,CAAA;AACrD,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAA,OAAO,QAAS,CAAA,eAAA;AAAA;AAGlB,EAAO,OAAA;AAAA,IACL,kBACE,MAAO,CAAA,iBAAA,CAAkB,kBAAkB,CAAA,IAC3C,SAAS,eAAgB,CAAA,gBAAA;AAAA,IAC3B,QACE,MAAO,CAAA,WAAA,CAA+B,QAAQ,CAAA,IAC9C,SAAS,eAAgB,CAAA,MAAA;AAAA,IAC3B,WACE,MAAO,CAAA,iBAAA,CAAkB,WAAW,CAAA,IACpC,SAAS,eAAgB,CAAA;AAAA,GAC7B;AACF;;;;;;"}
+{"version":3,"file":"config.cjs.js","sources":["../../src/collators/config.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  SchedulerServiceTaskScheduleDefinition,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { EntityFilterQuery } from '@backstage/catalog-client';\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\n\nconst configKey = 'search.collators.catalog';\n\nexport const defaults = {\n  schedule: {\n    frequency: { minutes: 10 },\n    timeout: { minutes: 15 },\n    initialDelay: { seconds: 3 },\n  },\n  collatorOptions: {\n    locationTemplate: '/catalog/:namespace/:kind/:name',\n    filter: undefined,\n    batchSize: 500,\n  },\n};\n\nexport function readScheduleConfigOptions(\n  configRoot: Config,\n): SchedulerServiceTaskScheduleDefinition {\n  let schedule: SchedulerServiceTaskScheduleDefinition | undefined = undefined;\n\n  const config = configRoot.getOptionalConfig(configKey);\n  if (config) {\n    const scheduleConfig = config.getOptionalConfig('schedule');\n    if (scheduleConfig) {\n      try {\n        schedule =\n          readSchedulerServiceTaskScheduleDefinitionFromConfig(scheduleConfig);\n      } catch (error) {\n        throw new InputError(`Invalid schedule at ${configKey}, ${error}`);\n      }\n    }\n  }\n\n  return schedule ?? defaults.schedule;\n}\n\nexport function readCollatorConfigOptions(configRoot: Config): {\n  locationTemplate: string;\n  filter: EntityFilterQuery | undefined;\n  batchSize: number;\n} {\n  const config = configRoot.getOptionalConfig(configKey);\n  if (!config) {\n    return defaults.collatorOptions;\n  }\n\n  return {\n    locationTemplate:\n      config.getOptionalString('locationTemplate') ??\n      defaults.collatorOptions.locationTemplate,\n    filter:\n      config.getOptional<EntityFilterQuery>('filter') ??\n      defaults.collatorOptions.filter,\n    batchSize:\n      config.getOptionalNumber('batchSize') ??\n      defaults.collatorOptions.batchSize,\n  };\n}\n"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig","InputError"],"mappings":";;;;;AAwBA,MAAM,SAAA,GAAY,0BAAA;AAEX,MAAM,QAAA,GAAW;AAAA,EACtB,QAAA,EAAU;AAAA,IACR,SAAA,EAAW,EAAE,OAAA,EAAS,EAAA,EAAG;AAAA,IACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAA,EAAG;AAAA,IACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAA;AAAE,GAC7B;AAAA,EACA,eAAA,EAAiB;AAAA,IACf,gBAAA,EAAkB,iCAAA;AAAA,IAClB,MAAA,EAAQ,MAAA;AAAA,IACR,SAAA,EAAW;AAAA;AAEf;AAEO,SAAS,0BACd,UAAA,EACwC;AACxC,EAAA,IAAI,QAAA,GAA+D,MAAA;AAEnE,EAAA,MAAM,MAAA,GAAS,UAAA,CAAW,iBAAA,CAAkB,SAAS,CAAA;AACrD,EAAA,IAAI,MAAA,EAAQ;AACV,IAAA,MAAM,cAAA,GAAiB,MAAA,CAAO,iBAAA,CAAkB,UAAU,CAAA;AAC1D,IAAA,IAAI,cAAA,EAAgB;AAClB,MAAA,IAAI;AACF,QAAA,QAAA,GACEA,sEAAqD,cAAc,CAAA;AAAA,MACvE,SAAS,KAAA,EAAO;AACd,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,oBAAA,EAAuB,SAAS,CAAA,EAAA,EAAK,KAAK,CAAA,CAAE,CAAA;AAAA,MACnE;AAAA,IACF;AAAA,EACF;AAEA,EAAA,OAAO,YAAY,QAAA,CAAS,QAAA;AAC9B;AAEO,SAAS,0BAA0B,UAAA,EAIxC;AACA,EAAA,MAAM,MAAA,GAAS,UAAA,CAAW,iBAAA,CAAkB,SAAS,CAAA;AACrD,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,QAAA,CAAS,eAAA;AAAA,EAClB;AAEA,EAAA,OAAO;AAAA,IACL,kBACE,MAAA,CAAO,iBAAA,CAAkB,kBAAkB,CAAA,IAC3C,SAAS,eAAA,CAAgB,gBAAA;AAAA,IAC3B,QACE,MAAA,CAAO,WAAA,CAA+B,QAAQ,CAAA,IAC9C,SAAS,eAAA,CAAgB,MAAA;AAAA,IAC3B,WACE,MAAA,CAAO,iBAAA,CAAkB,WAAW,CAAA,IACpC,SAAS,eAAA,CAAgB;AAAA,GAC7B;AACF;;;;;;"}

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

@@ -1 +1 @@
-{"version":3,"file":"defaultCatalogCollatorEntityTransformer.cjs.js","sources":["../../src/collators/defaultCatalogCollatorEntityTransformer.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\n\nconst getDocumentText = (entity: Entity): string => {\n  const documentTexts: string[] = [];\n  if (entity.metadata.description) {\n    documentTexts.push(entity.metadata.description);\n  }\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 defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer =\n  (entity: Entity) => {\n    return {\n      title: entity.metadata.title ?? entity.metadata.name,\n      text: getDocumentText(entity),\n      componentType: entity.spec?.type?.toString() || 'other',\n      type: entity.spec?.type?.toString() || 'other',\n      namespace: entity.metadata.namespace || 'default',\n      kind: entity.kind,\n      lifecycle: (entity.spec?.lifecycle as string) || '',\n      owner: (entity.spec?.owner as string) || '',\n    };\n  };\n"],"names":["isUserEntity","isGroupEntity"],"mappings":";;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAClD,EAAA,MAAM,gBAA0B,EAAC;AACjC,EAAI,IAAA,MAAA,CAAO,SAAS,WAAa,EAAA;AAC/B,IAAc,aAAA,CAAA,IAAA,CAAK,MAAO,CAAA,QAAA,CAAS,WAAW,CAAA;AAAA;AAGhD,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;AAAA;AACpD;AAGF,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;AAAA;AAC9C;AAGF,EAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA;AACjC,CAAA;AAGa,MAAA,uCAAA,GACX,CAAC,MAAmB,KAAA;AAClB,EAAO,OAAA;AAAA,IACL,KAAO,EAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,OAAO,QAAS,CAAA,IAAA;AAAA,IAChD,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,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,IACxC,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,IACjD,KAAA,EAAQ,MAAO,CAAA,IAAA,EAAM,KAAoB,IAAA;AAAA,GAC3C;AACF;;;;"}
+{"version":3,"file":"defaultCatalogCollatorEntityTransformer.cjs.js","sources":["../../src/collators/defaultCatalogCollatorEntityTransformer.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\n\nconst getDocumentText = (entity: Entity): string => {\n  const documentTexts: string[] = [];\n  if (entity.metadata.description) {\n    documentTexts.push(entity.metadata.description);\n  }\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 defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer =\n  (entity: Entity) => {\n    return {\n      title: entity.metadata.title ?? entity.metadata.name,\n      text: getDocumentText(entity),\n      componentType: entity.spec?.type?.toString() || 'other',\n      type: entity.spec?.type?.toString() || 'other',\n      namespace: entity.metadata.namespace || 'default',\n      kind: entity.kind,\n      lifecycle: (entity.spec?.lifecycle as string) || '',\n      owner: (entity.spec?.owner as string) || '',\n    };\n  };\n"],"names":["isUserEntity","isGroupEntity"],"mappings":";;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAAA,KAA2B;AAClD,EAAA,MAAM,gBAA0B,EAAC;AACjC,EAAA,IAAI,MAAA,CAAO,SAAS,WAAA,EAAa;AAC/B,IAAA,aAAA,CAAc,IAAA,CAAK,MAAA,CAAO,QAAA,CAAS,WAAW,CAAA;AAAA,EAChD;AAEA,EAAA,IAAIA,yBAAA,CAAa,MAAM,CAAA,IAAKC,0BAAA,CAAc,MAAM,CAAA,EAAG;AACjD,IAAA,IAAI,MAAA,CAAO,IAAA,EAAM,OAAA,EAAS,WAAA,EAAa;AACrC,MAAA,aAAA,CAAc,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,WAAW,CAAA;AAAA,IACpD;AAAA,EACF;AAEA,EAAA,IAAID,yBAAA,CAAa,MAAM,CAAA,EAAG;AACxB,IAAA,IAAI,MAAA,CAAO,IAAA,EAAM,OAAA,EAAS,KAAA,EAAO;AAC/B,MAAA,aAAA,CAAc,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,KAAK,CAAA;AAAA,IAC9C;AAAA,EACF;AAEA,EAAA,OAAO,aAAA,CAAc,KAAK,KAAK,CAAA;AACjC,CAAA;AAGO,MAAM,uCAAA,GACX,CAAC,MAAA,KAAmB;AAClB,EAAA,OAAO;AAAA,IACL,KAAA,EAAO,MAAA,CAAO,QAAA,CAAS,KAAA,IAAS,OAAO,QAAA,CAAS,IAAA;AAAA,IAChD,IAAA,EAAM,gBAAgB,MAAM,CAAA;AAAA,IAC5B,aAAA,EAAe,MAAA,CAAO,IAAA,EAAM,IAAA,EAAM,UAAS,IAAK,OAAA;AAAA,IAChD,IAAA,EAAM,MAAA,CAAO,IAAA,EAAM,IAAA,EAAM,UAAS,IAAK,OAAA;AAAA,IACvC,SAAA,EAAW,MAAA,CAAO,QAAA,CAAS,SAAA,IAAa,SAAA;AAAA,IACxC,MAAM,MAAA,CAAO,IAAA;AAAA,IACb,SAAA,EAAY,MAAA,CAAO,IAAA,EAAM,SAAA,IAAwB,EAAA;AAAA,IACjD,KAAA,EAAQ,MAAA,CAAO,IAAA,EAAM,KAAA,IAAoB;AAAA,GAC3C;AACF;;;;"}

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 *\n * A collator module for the search backend that indexes your software catalog.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { readScheduleConfigOptions } from './collators/config';\nimport { CatalogCollatorEntityTransformer } from './collators';\nimport { DefaultCatalogCollatorFactory } from './collators/DefaultCatalogCollatorFactory';\n\n/**\n * Options for {@link catalogCollatorExtensionPoint}.\n *\n * @public\n */\nexport type CatalogCollatorExtensionPoint = {\n  /**\n   * Allows you to customize how entities are shaped into documents.\n   */\n  setEntityTransformer(transformer: CatalogCollatorEntityTransformer): void;\n};\n\n/**\n * Extension point for customizing how catalog entities are shaped into\n * documents for the search backend.\n *\n * @public\n */\nexport const catalogCollatorExtensionPoint =\n  createExtensionPoint<CatalogCollatorExtensionPoint>({\n    id: 'search.catalogCollator.extension',\n  });\n\n/**\n * Search backend module for the Catalog index.\n *\n * @public\n */\nexport const searchModuleCatalogCollator = createBackendModule({\n  pluginId: 'search',\n  moduleId: 'catalog-collator',\n  register(env) {\n    let entityTransformer: CatalogCollatorEntityTransformer | undefined;\n\n    env.registerExtensionPoint(catalogCollatorExtensionPoint, {\n      setEntityTransformer(transformer) {\n        if (entityTransformer) {\n          throw new Error('setEntityTransformer can only be called once');\n        }\n        entityTransformer = transformer;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        auth: coreServices.auth,\n        config: coreServices.rootConfig,\n        scheduler: coreServices.scheduler,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n        catalog: catalogServiceRef,\n      },\n      async init({ auth, config, scheduler, indexRegistry, catalog }) {\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(\n            readScheduleConfigOptions(config),\n          ),\n          factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n            auth,\n            catalog,\n            entityTransformer,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","searchIndexRegistryExtensionPoint","catalogServiceRef","config","readScheduleConfigOptions","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;AAmDO,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA;AACN,CAAC;AAOI,MAAM,8BAA8BC,oCAAoB,CAAA;AAAA,EAC7D,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,kBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,6BAA+B,EAAA;AAAA,MACxD,qBAAqB,WAAa,EAAA;AAChC,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,8CAA8C,CAAA;AAAA;AAEhE,QAAoB,iBAAA,GAAA,WAAA;AAAA;AACtB,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAe,EAAAC,uCAAA;AAAA,QACf,OAAS,EAAAC;AAAA,OACX;AAAA,MACA,MAAM,KAAK,EAAE,IAAA,UAAMC,UAAQ,SAAW,EAAA,aAAA,EAAe,SAAW,EAAA;AAC9D,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,YAClBC,iCAA0BD,QAAM;AAAA,WAClC;AAAA,UACA,OAAA,EAASE,2DAA8B,CAAA,UAAA,CAAWF,QAAQ,EAAA;AAAA,YACxD,IAAA;AAAA,YACA,OAAA;AAAA,YACA;AAAA,WACD;AAAA,SACF,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC;;;;;"}
+{"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 *\n * A collator module for the search backend that indexes your software catalog.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { readScheduleConfigOptions } from './collators/config';\nimport { CatalogCollatorEntityTransformer } from './collators';\nimport { DefaultCatalogCollatorFactory } from './collators/DefaultCatalogCollatorFactory';\n\n/**\n * Options for {@link catalogCollatorExtensionPoint}.\n *\n * @public\n */\nexport type CatalogCollatorExtensionPoint = {\n  /**\n   * Allows you to customize how entities are shaped into documents.\n   */\n  setEntityTransformer(transformer: CatalogCollatorEntityTransformer): void;\n};\n\n/**\n * Extension point for customizing how catalog entities are shaped into\n * documents for the search backend.\n *\n * @public\n */\nexport const catalogCollatorExtensionPoint =\n  createExtensionPoint<CatalogCollatorExtensionPoint>({\n    id: 'search.catalogCollator.extension',\n  });\n\n/**\n * Search backend module for the Catalog index.\n *\n * @public\n */\nexport const searchModuleCatalogCollator = createBackendModule({\n  pluginId: 'search',\n  moduleId: 'catalog-collator',\n  register(env) {\n    let entityTransformer: CatalogCollatorEntityTransformer | undefined;\n\n    env.registerExtensionPoint(catalogCollatorExtensionPoint, {\n      setEntityTransformer(transformer) {\n        if (entityTransformer) {\n          throw new Error('setEntityTransformer can only be called once');\n        }\n        entityTransformer = transformer;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        auth: coreServices.auth,\n        config: coreServices.rootConfig,\n        scheduler: coreServices.scheduler,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n        catalog: catalogServiceRef,\n      },\n      async init({ auth, config, scheduler, indexRegistry, catalog }) {\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(\n            readScheduleConfigOptions(config),\n          ),\n          factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n            auth,\n            catalog,\n            entityTransformer,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","searchIndexRegistryExtensionPoint","catalogServiceRef","config","readScheduleConfigOptions","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;AAmDO,MAAM,gCACXA,qCAAA,CAAoD;AAAA,EAClD,EAAA,EAAI;AACN,CAAC;AAOI,MAAM,8BAA8BC,oCAAA,CAAoB;AAAA,EAC7D,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,EAAU,kBAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,IAAI,iBAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,6BAAA,EAA+B;AAAA,MACxD,qBAAqB,WAAA,EAAa;AAChC,QAAA,IAAI,iBAAA,EAAmB;AACrB,UAAA,MAAM,IAAI,MAAM,8CAA8C,CAAA;AAAA,QAChE;AACA,QAAA,iBAAA,GAAoB,WAAA;AAAA,MACtB;AAAA,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,MAAMC,6BAAA,CAAa,IAAA;AAAA,QACnB,QAAQA,6BAAA,CAAa,UAAA;AAAA,QACrB,WAAWA,6BAAA,CAAa,SAAA;AAAA,QACxB,aAAA,EAAeC,uCAAA;AAAA,QACf,OAAA,EAASC;AAAA,OACX;AAAA,MACA,MAAM,KAAK,EAAE,IAAA,UAAMC,UAAQ,SAAA,EAAW,aAAA,EAAe,SAAQ,EAAG;AAC9D,QAAA,aAAA,CAAc,WAAA,CAAY;AAAA,UACxB,UAAU,SAAA,CAAU,yBAAA;AAAA,YAClBC,iCAA0BD,QAAM;AAAA,WAClC;AAAA,UACA,OAAA,EAASE,2DAAA,CAA8B,UAAA,CAAWF,QAAA,EAAQ;AAAA,YACxD,IAAA;AAAA,YACA,OAAA;AAAA,YACA;AAAA,WACD;AAAA,SACF,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-catalog",
-  "version": "0.3.7-next.0",
+  "version": "0.3.7",
   "description": "A module for the search backend that exports catalog modules",
   "backstage": {
     "role": "backend-plugin-module",
@@ -38,20 +38,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.4.2-next.0",
-    "@backstage/catalog-client": "1.11.0-next.0",
-    "@backstage/catalog-model": "1.7.5",
-    "@backstage/config": "1.3.3",
-    "@backstage/errors": "1.2.7",
-    "@backstage/plugin-catalog-common": "1.1.5",
-    "@backstage/plugin-catalog-node": "1.18.0-next.0",
-    "@backstage/plugin-permission-common": "0.9.1",
-    "@backstage/plugin-search-backend-node": "1.3.14-next.0",
-    "@backstage/plugin-search-common": "1.2.19"
+    "@backstage/backend-plugin-api": "^1.4.2",
+    "@backstage/catalog-client": "^1.11.0",
+    "@backstage/catalog-model": "^1.7.5",
+    "@backstage/config": "^1.3.3",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-catalog-common": "^1.1.5",
+    "@backstage/plugin-catalog-node": "^1.18.0",
+    "@backstage/plugin-permission-common": "^0.9.1",
+    "@backstage/plugin-search-backend-node": "^1.3.14",
+    "@backstage/plugin-search-common": "^1.2.19"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.7.1-next.0",
-    "@backstage/cli": "0.33.2-next.0"
+    "@backstage/backend-test-utils": "^1.8.0",
+    "@backstage/cli": "^0.34.0"
   },
   "configSchema": "config.d.ts",
   "typesVersions": {