From 31b6cc68b6cfe689de31833990db105dafe5590e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Fri, 3 Apr 2026 22:54:57 +0200 Subject: [PATCH] Rename TechDocsCollatorFactoryOptions.catalogClient to .catalog MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw Made-with: Cursor --- .../collators/DefaultTechDocsCollatorFactory.test.ts | 4 ++-- .../src/collators/DefaultTechDocsCollatorFactory.ts | 12 ++++++------ plugins/search-backend-module-techdocs/src/module.ts | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.test.ts b/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.test.ts index d4f3e33d60..cbddb1cadd 100644 --- a/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.test.ts +++ b/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.test.ts @@ -91,7 +91,7 @@ describe('DefaultTechDocsCollatorFactory', () => { logger, discovery: mockDiscoveryApi, auth: mockServices.auth(), - catalogClient: mockCatalog, + catalog: mockCatalog, }; it('has expected type', () => { @@ -161,7 +161,7 @@ describe('DefaultTechDocsCollatorFactory', () => { discovery: mockDiscoveryApi, logger, auth: mockServices.auth(), - catalogClient: mockCatalog, + catalog: mockCatalog, }); collator = await factory.getCollator(); diff --git a/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.ts b/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.ts index 1a2e4af099..c275224ba2 100644 --- a/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.ts +++ b/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.ts @@ -55,7 +55,7 @@ export type TechDocsCollatorFactoryOptions = { logger: LoggerService; auth: AuthService; locationTemplate?: string; - catalogClient?: CatalogService; + catalog?: CatalogService; parallelismLimit?: number; legacyPathCasing?: boolean; entityTransformer?: TechDocsCollatorEntityTransformer; @@ -85,7 +85,7 @@ export class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory { private locationTemplate: string; private readonly logger: LoggerService; private readonly auth: AuthService; - private readonly catalogClient: CatalogService; + private readonly catalog: CatalogService; private readonly parallelismLimit: number; private readonly legacyPathCasing: boolean; private entityTransformer: TechDocsCollatorEntityTransformer; @@ -98,10 +98,10 @@ export class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory { this.locationTemplate = options.locationTemplate || '/docs/:namespace/:kind/:name/:path'; this.logger = options.logger.child({ documentType: this.type }); - if (!options.catalogClient) { - throw new Error('catalogClient is required'); + if (!options.catalog) { + throw new Error('catalog is required'); } - this.catalogClient = options.catalogClient; + this.catalog = options.catalog; this.parallelismLimit = options.parallelismLimit ?? 10; this.legacyPathCasing = options.legacyPathCasing ?? false; this.entityTransformer = options.entityTransformer ?? (() => ({})); @@ -150,7 +150,7 @@ export class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory { const credentials = await this.auth.getOwnServiceCredentials(); const entities = ( - await this.catalogClient.getEntities( + await this.catalog.getEntities( { filter: { 'metadata.annotations.backstage.io/techdocs-ref': diff --git a/plugins/search-backend-module-techdocs/src/module.ts b/plugins/search-backend-module-techdocs/src/module.ts index 050c075ea2..d6149ca81a 100644 --- a/plugins/search-backend-module-techdocs/src/module.ts +++ b/plugins/search-backend-module-techdocs/src/module.ts @@ -162,7 +162,7 @@ export default createBackendModule({ discovery, auth, logger, - catalogClient: catalog, + catalog, entityTransformer, documentTransformer, customCatalogApiFilters,