Rename TechDocsCollatorFactoryOptions.catalogClient to .catalog

Signed-off-by: Fredrik Adelöw <freben@spotify.com>
Made-with: Cursor

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();
 

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':

plugins/search-backend-module-techdocs/src/module.ts

@@ -162,7 +162,7 @@ export default createBackendModule({
             discovery,
             auth,
             logger,
-            catalogClient: catalog,
+            catalog,
             entityTransformer,
             documentTransformer,
             customCatalogApiFilters,