update api reports

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
Co-authored-by: Camila Loiola <camilaibs@gmail.com>

plugins/catalog-backend/api-report.md

@@ -11,7 +11,7 @@ import { AnalyzeLocationGenerateEntity as AnalyzeLocationGenerateEntity_2 } from
 import { AnalyzeLocationRequest as AnalyzeLocationRequest_2 } from '@backstage/plugin-catalog-common';
 import { AnalyzeLocationResponse as AnalyzeLocationResponse_2 } from '@backstage/plugin-catalog-common';
 import { CatalogApi } from '@backstage/catalog-client';
-import { CatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog';
+import type { CatalogCollatorEntityTransformer as CatalogCollatorEntityTransformer_2 } from '@backstage/plugin-search-backend-module-catalog';
 import { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
 import { CatalogProcessor as CatalogProcessor_2 } from '@backstage/plugin-catalog-node';
 import { CatalogProcessorCache as CatalogProcessorCache_2 } from '@backstage/plugin-catalog-node';
@@ -24,15 +24,9 @@ import { CatalogProcessorRefreshKeysResult as CatalogProcessorRefreshKeysResult_
 import { CatalogProcessorRelationResult as CatalogProcessorRelationResult_2 } from '@backstage/plugin-catalog-node';
 import { CatalogProcessorResult as CatalogProcessorResult_2 } from '@backstage/plugin-catalog-node';
 import { Config } from '@backstage/config';
-<<<<<<< HEAD
+import { DefaultCatalogCollatorFactory as DefaultCatalogCollatorFactory_2 } from '@backstage/plugin-search-backend-module-catalog';
+import type { DefaultCatalogCollatorFactoryOptions as DefaultCatalogCollatorFactoryOptions_2 } from '@backstage/plugin-search-backend-module-catalog';
 import { DeferredEntity as DeferredEntity_2 } from '@backstage/plugin-catalog-node';
-import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
-=======
-import { defaultCatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog';
-import { DefaultCatalogCollatorFactory } from '@backstage/plugin-search-backend-module-catalog';
-import { DefaultCatalogCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-catalog';
-import { DeferredEntity } from '@backstage/plugin-catalog-node';
->>>>>>> 56a45401d3d (feat(search): create search collator modules)
 import { Entity } from '@backstage/catalog-model';
 import { EntityPolicy } from '@backstage/catalog-model';
 import { EntityProvider as EntityProvider_2 } from '@backstage/plugin-catalog-node';
@@ -52,11 +46,6 @@ import { PermissionRule } from '@backstage/plugin-permission-node';
 import { PermissionRuleParams } from '@backstage/plugin-permission-common';
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
-<<<<<<< HEAD
-import { Readable } from 'stream';
-=======
-import { processingResult } from '@backstage/plugin-catalog-node';
->>>>>>> 56a45401d3d (feat(search): create search collator modules)
 import { Router } from 'express';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { TokenManager } from '@backstage/backend-common';
@@ -172,7 +161,9 @@ export class CatalogBuilder {
   useLegacySingleProcessorValidation(): this;
 }
 
-export { CatalogCollatorEntityTransformer };
+// @public @deprecated (undocumented)
+export type CatalogCollatorEntityTransformer =
+  CatalogCollatorEntityTransformer_2;
 
 // @public (undocumented)
 export type CatalogEnvironment = {
@@ -295,11 +286,15 @@ export class DefaultCatalogCollator {
   readonly visibilityPermission: Permission;
 }
 
-export { defaultCatalogCollatorEntityTransformer };
+// @public @deprecated (undocumented)
+export const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer_2;
 
-export { DefaultCatalogCollatorFactory };
+// @public @deprecated (undocumented)
+export const DefaultCatalogCollatorFactory: typeof DefaultCatalogCollatorFactory_2;
 
-export { DefaultCatalogCollatorFactoryOptions };
+// @public @deprecated (undocumented)
+export type DefaultCatalogCollatorFactoryOptions =
+  DefaultCatalogCollatorFactoryOptions_2;
 
 // @public @deprecated (undocumented)
 export type DeferredEntity = DeferredEntity_2;

plugins/catalog-backend/src/index.ts

@@ -34,14 +34,14 @@ import {
 } from '@backstage/plugin-search-backend-module-catalog';
 
 /**
- * @deprecated
- * import from @backstage/search-backend-module-catalog instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-catalog` instead
  */
 export const DefaultCatalogCollatorFactory = _DefaultCatalogCollatorFactory;
 
 /**
- * @deprecated
- * import from @backstage/search-backend-module-catalog instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-catalog` instead
  */
 export const defaultCatalogCollatorEntityTransformer =
   _defaultCatalogCollatorEntityTransformer;
@@ -52,15 +52,15 @@ import type {
 } from '@backstage/plugin-search-backend-module-catalog';
 
 /**
- * @deprecated
- * import from @backstage/search-backend-module-catalog instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-catalog` instead
  */
 export type DefaultCatalogCollatorFactoryOptions =
   _DefaultCatalogCollatorFactoryOptions;
 
 /**
- * @deprecated
- * import from @backstage/search-backend-module-catalog instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-catalog` instead
  */
 export type CatalogCollatorEntityTransformer =
   _CatalogCollatorEntityTransformer;

plugins/explore-backend/api-report.md

@@ -8,9 +8,9 @@ import express from 'express';
 import { GetExploreToolsRequest } from '@backstage/plugin-explore-common';
 import { GetExploreToolsResponse } from '@backstage/plugin-explore-common';
 import { Logger } from 'winston';
-import { ToolDocument } from '@backstage/plugin-search-backend-module-explore';
-import { ToolDocumentCollatorFactory } from '@backstage/plugin-search-backend-module-explore';
-import { ToolDocumentCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-explore';
+import type { ToolDocument as ToolDocument_2 } from '@backstage/plugin-search-backend-module-explore';
+import { ToolDocumentCollatorFactory as ToolDocumentCollatorFactory_2 } from '@backstage/plugin-search-backend-module-explore';
+import type { ToolDocumentCollatorFactoryOptions as ToolDocumentCollatorFactoryOptions_2 } from '@backstage/plugin-search-backend-module-explore';
 
 // @public (undocumented)
 export function createRouter(options: RouterOptions): Promise<express.Router>;
@@ -36,9 +36,13 @@ export class StaticExploreToolProvider implements ExploreToolProvider {
   getTools(request: GetExploreToolsRequest): Promise<GetExploreToolsResponse>;
 }
 
-export { ToolDocument };
+// @public @deprecated (undocumented)
+export type ToolDocument = ToolDocument_2;
 
-export { ToolDocumentCollatorFactory };
+// @public @deprecated (undocumented)
+export const ToolDocumentCollatorFactory: typeof ToolDocumentCollatorFactory_2;
 
-export { ToolDocumentCollatorFactoryOptions };
+// @public @deprecated (undocumented)
+export type ToolDocumentCollatorFactoryOptions =
+  ToolDocumentCollatorFactoryOptions_2;
 ```

plugins/explore-backend/src/index.ts

@@ -35,20 +35,20 @@ import type {
 } from '@backstage/plugin-search-backend-module-explore';
 
 /**
- * @deprecated
- * import from @backstage/plugin-search-backend-module-explore instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-explore` instead
  */
 export const ToolDocumentCollatorFactory = _ToolDocumentCollatorFactory;
 
 /**
- * @deprecated
- * import from @backstage/plugin-search-backend-module-explore instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-explore` instead
  */
 export type ToolDocument = _ToolDocument;
 
 /**
- * @deprecated
- * import from @backstage/plugin-search-backend-module-explore instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-explore` instead
  */
 export type ToolDocumentCollatorFactoryOptions =
   _ToolDocumentCollatorFactoryOptions;

plugins/search-backend-module-catalog/alpha-api-report.md

@@ -3,55 +3,13 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
-/// <reference types="node" />
-
 import { BackendFeature } from '@backstage/backend-plugin-api';
-import { CatalogApi } from '@backstage/catalog-client';
-import { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
-import { Config } from '@backstage/config';
-import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
-import { Entity } from '@backstage/catalog-model';
-import { GetEntitiesRequest } from '@backstage/catalog-client';
-import { Permission } from '@backstage/plugin-permission-common';
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
-import { Readable } from 'stream';
+import { DefaultCatalogCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-catalog';
 import { TaskScheduleDefinition } from '@backstage/backend-tasks';
-import { TokenManager } from '@backstage/backend-common';
-
-// @public (undocumented)
-export type CatalogCollatorEntityTransformer = (
-  entity: Entity,
-) => Omit<CatalogEntityDocument, 'location' | 'authorization'>;
-
-// @public (undocumented)
-export class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
-  // (undocumented)
-  static fromConfig(
-    _config: Config,
-    options: DefaultCatalogCollatorFactoryOptions,
-  ): DefaultCatalogCollatorFactory;
-  // (undocumented)
-  getCollator(): Promise<Readable>;
-  // (undocumented)
-  readonly type = 'software-catalog';
-  // (undocumented)
-  readonly visibilityPermission: Permission;
-}
-
-// @public (undocumented)
-export type DefaultCatalogCollatorFactoryOptions = {
-  discovery: PluginEndpointDiscovery;
-  tokenManager: TokenManager;
-  locationTemplate?: string;
-  filter?: GetEntitiesRequest['filter'];
-  batchSize?: number;
-  catalogClient?: CatalogApi;
-  entityTransformer?: CatalogCollatorEntityTransformer;
-};
 
 // @alpha
 export const searchModuleCatalogCollator: (
-  options: SearchModuleCatalogCollatorOptions,
+  options?: SearchModuleCatalogCollatorOptions | undefined,
 ) => BackendFeature;
 
 // @alpha
@@ -59,7 +17,7 @@ export type SearchModuleCatalogCollatorOptions = Omit<
   DefaultCatalogCollatorFactoryOptions,
   'discovery' | 'tokenManager'
 > & {
-  schedule: TaskScheduleDefinition;
+  schedule?: TaskScheduleDefinition;
 };
 
 // (No @packageDocumentation comment for this package)

plugins/search-backend-module-elasticsearch/alpha-api-report.md

@@ -4,47 +4,8 @@
 
 ```ts
 import { BackendFeature } from '@backstage/backend-plugin-api';
-import { SearchQuery } from '@backstage/plugin-search-common';
-
-// @public
-export type ElasticSearchConcreteQuery = {
-  documentTypes?: string[];
-  elasticSearchQuery: Object;
-  pageSize: number;
-};
-
-// @public
-export type ElasticSearchCustomIndexTemplate = {
-  name: string;
-  body: ElasticSearchCustomIndexTemplateBody;
-};
-
-// @public
-export type ElasticSearchCustomIndexTemplateBody = {
-  index_patterns: string[];
-  composed_of?: string[];
-  template?: Record<string, any>;
-};
-
-// @public (undocumented)
-export type ElasticSearchHighlightConfig = {
-  fragmentDelimiter: string;
-  fragmentSize: number;
-  numFragments: number;
-  preTag: string;
-  postTag: string;
-};
-
-// @public
-export type ElasticSearchQueryTranslator = (
-  query: SearchQuery,
-  options?: ElasticSearchQueryTranslatorOptions,
-) => ElasticSearchConcreteQuery;
-
-// @public
-export type ElasticSearchQueryTranslatorOptions = {
-  highlightOptions?: ElasticSearchHighlightConfig;
-};
+import { ElasticSearchCustomIndexTemplate } from '@backstage/plugin-search-backend-module-elasticsearch';
+import { ElasticSearchQueryTranslator } from '@backstage/plugin-search-backend-module-elasticsearch';
 
 // @alpha
 export const searchModuleElasticsearchEngine: (

plugins/search-backend-module-explore/alpha-api-report.md

@@ -3,21 +3,13 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
-/// <reference types="node" />
-
 import { BackendFeature } from '@backstage/backend-plugin-api';
-import { Config } from '@backstage/config';
-import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
-import { ExploreTool } from '@backstage/plugin-explore-common';
-import { IndexableDocument } from '@backstage/plugin-search-common';
-import { Logger } from 'winston';
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
-import { Readable } from 'stream';
 import { TaskScheduleDefinition } from '@backstage/backend-tasks';
+import { ToolDocumentCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-explore';
 
 // @alpha
 export const searchModuleExploreCollator: (
-  options: SearchModuleExploreCollatorOptions,
+  options?: SearchModuleExploreCollatorOptions | undefined,
 ) => BackendFeature;
 
 // @alpha
@@ -25,31 +17,7 @@ export type SearchModuleExploreCollatorOptions = Omit<
   ToolDocumentCollatorFactoryOptions,
   'logger' | 'discovery'
 > & {
-  schedule: TaskScheduleDefinition;
-};
-
-// @public
-export interface ToolDocument extends IndexableDocument, ExploreTool {}
-
-// @public
-export class ToolDocumentCollatorFactory implements DocumentCollatorFactory {
-  // (undocumented)
-  execute(): AsyncGenerator<ToolDocument>;
-  // (undocumented)
-  static fromConfig(
-    _config: Config,
-    options: ToolDocumentCollatorFactoryOptions,
-  ): ToolDocumentCollatorFactory;
-  // (undocumented)
-  getCollator(): Promise<Readable>;
-  // (undocumented)
-  readonly type: string;
-}
-
-// @public
-export type ToolDocumentCollatorFactoryOptions = {
-  discovery: PluginEndpointDiscovery;
-  logger: Logger;
+  schedule?: TaskScheduleDefinition;
 };
 
 // (No @packageDocumentation comment for this package)

plugins/search-backend-module-techdocs/alpha-api-report.md

@@ -3,18 +3,13 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
-/// <reference types="node" />
-
 import { BackendFeature } from '@backstage/backend-plugin-api';
-import { CatalogApi } from '@backstage/catalog-client';
-import { Logger } from 'winston';
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
 import { TaskScheduleDefinition } from '@backstage/backend-tasks';
-import { TokenManager } from '@backstage/backend-common';
+import { TechDocsCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-techdocs';
 
 // @alpha
 export const searchModuleTechDocsCollator: (
-  options: SearchModuleTechDocsCollatorOptions,
+  options?: SearchModuleTechDocsCollatorOptions | undefined,
 ) => BackendFeature;
 
 // @alpha
@@ -22,18 +17,7 @@ export type SearchModuleTechDocsCollatorOptions = Omit<
   TechDocsCollatorFactoryOptions,
   'logger' | 'discovery' | 'tokenManager'
 > & {
-  schedule: TaskScheduleDefinition;
-};
-
-// @public
-export type TechDocsCollatorFactoryOptions = {
-  discovery: PluginEndpointDiscovery;
-  logger: Logger;
-  tokenManager: TokenManager;
-  locationTemplate?: string;
-  catalogClient?: CatalogApi;
-  parallelismLimit?: number;
-  legacyPathCasing?: boolean;
+  schedule?: TaskScheduleDefinition;
 };
 
 // (No @packageDocumentation comment for this package)

plugins/search-backend-node/alpha-api-report.md

@@ -11,13 +11,6 @@ import { SearchEngine } from '@backstage/plugin-search-common';
 import { ServiceRef } from '@backstage/backend-plugin-api';
 import { TaskRunner } from '@backstage/backend-tasks';
 
-// @alpha
-export type IndexServiceBuildOptions = {
-  searchEngine: SearchEngine;
-  collators: RegisterCollatorParameters[];
-  decorators: RegisterDecoratorParameters[];
-};
-
 // @public
 export interface RegisterCollatorParameters {
   factory: DocumentCollatorFactory;
@@ -52,11 +45,18 @@ export const searchIndexRegistryExtensionPoint: ExtensionPoint<SearchIndexRegist
 // @alpha
 export interface SearchIndexService {
   getDocumentTypes(): Record<string, DocumentTypeInfo>;
-  start(options: IndexServiceBuildOptions): Promise<void>;
+  start(options: SearchIndexServiceStartOptions): Promise<void>;
 }
 
 // @alpha
 export const searchIndexServiceRef: ServiceRef<SearchIndexService, 'plugin'>;
 
+// @alpha
+export type SearchIndexServiceStartOptions = {
+  searchEngine: SearchEngine;
+  collators: RegisterCollatorParameters[];
+  decorators: RegisterDecoratorParameters[];
+};
+
 // (No @packageDocumentation comment for this package)
 ```

plugins/techdocs-backend/api-report.md

@@ -6,7 +6,7 @@
 import { CatalogApi } from '@backstage/catalog-client';
 import { CatalogClient } from '@backstage/catalog-client';
 import { Config } from '@backstage/config';
-import { DefaultTechDocsCollatorFactory } from '@backstage/plugin-search-backend-module-techdocs';
+import { DefaultTechDocsCollatorFactory as DefaultTechDocsCollatorFactory_2 } from '@backstage/plugin-search-backend-module-techdocs';
 import { Entity } from '@backstage/catalog-model';
 import express from 'express';
 import { GeneratorBuilder } from '@backstage/plugin-techdocs-node';
@@ -17,7 +17,7 @@ import { PluginCacheManager } from '@backstage/backend-common';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
 import { PreparerBuilder } from '@backstage/plugin-techdocs-node';
 import { PublisherBase } from '@backstage/plugin-techdocs-node';
-import { TechDocsCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-techdocs';
+import type { TechDocsCollatorFactoryOptions as TechDocsCollatorFactoryOptions_2 } from '@backstage/plugin-search-backend-module-techdocs';
 import { TechDocsDocument } from '@backstage/plugin-techdocs-node';
 import { TokenManager } from '@backstage/backend-common';
 import * as winston from 'winston';
@@ -45,7 +45,8 @@ export class DefaultTechDocsCollator {
   readonly visibilityPermission: Permission;
 }
 
-export { DefaultTechDocsCollatorFactory };
+// @public @deprecated (undocumented)
+export const DefaultTechDocsCollatorFactory: typeof DefaultTechDocsCollatorFactory_2;
 
 // @public
 export interface DocsBuildStrategy {
@@ -90,7 +91,8 @@ export type ShouldBuildParameters = {
   entity: Entity;
 };
 
-export { TechDocsCollatorFactoryOptions };
+// @public @deprecated (undocumented)
+export type TechDocsCollatorFactoryOptions = TechDocsCollatorFactoryOptions_2;
 
 // @public
 export type TechDocsCollatorOptions = {

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

@@ -24,13 +24,13 @@ import { DefaultTechDocsCollatorFactory as _DefaultTechDocsCollatorFactory } fro
 import type { TechDocsCollatorFactoryOptions as _TechDocsCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-techdocs';
 
 /**
- * @deprecated
- * import from @backstage/search-backend-module-techdocs instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-techdocs` instead
  */
 export type TechDocsCollatorFactoryOptions = _TechDocsCollatorFactoryOptions;
 
 /**
- * @deprecated
- * import from @backstage/search-backend-module-techdocs instead
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-techdocs` instead
  */
 export const DefaultTechDocsCollatorFactory = _DefaultTechDocsCollatorFactory;