Merge pull request #7160 from backstage/rugvip/exports

catalog-backend: add missing type exports

.changeset/perfect-keys-hide.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend': patch
+---
+
+Fill in most missing type exports.

plugins/catalog-backend/api-report.md

@@ -40,6 +40,36 @@ export type AddLocationResult = {
   entities: Entity[];
 };
 
+// Warning: (ae-missing-release-tag) "AnalyzeLocationEntityField" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type AnalyzeLocationEntityField = {
+  field: string;
+  state:
+    | 'analysisSuggestedValue'
+    | 'analysisSuggestedNoValue'
+    | 'needsUserInput';
+  value: string | null;
+  description: string;
+};
+
+// Warning: (ae-missing-release-tag) "AnalyzeLocationExistingEntity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type AnalyzeLocationExistingEntity = {
+  location: LocationSpec;
+  isRegistered: boolean;
+  entity: Entity;
+};
+
+// Warning: (ae-missing-release-tag) "AnalyzeLocationGenerateEntity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type AnalyzeLocationGenerateEntity = {
+  entity: RecursivePartial<Entity>;
+  fields: AnalyzeLocationEntityField[];
+};
+
 // Warning: (ae-missing-release-tag) "AnalyzeLocationRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -111,8 +141,6 @@ export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
   normalizeName(name: string): string;
   // (undocumented)
   organizations: Organizations;
-  // Warning: (ae-forgotten-export) The symbol "AwsOrganizationProviderConfig" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   provider: AwsOrganizationProviderConfig;
   // (undocumented)
@@ -123,6 +151,13 @@ export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
   ): Promise<boolean>;
 }
 
+// Warning: (ae-missing-release-tag) "AwsOrganizationProviderConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export type AwsOrganizationProviderConfig = {
+  roleArn?: string;
+};
+
 // Warning: (ae-missing-release-tag) "BitbucketDiscoveryProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -186,8 +221,6 @@ export class CatalogBuilder {
     higherOrderOperation: HigherOrderOperation;
     locationAnalyzer: LocationAnalyzer;
   }>;
-  // Warning: (ae-forgotten-export) The symbol "CatalogEnvironment" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   static create(env: CatalogEnvironment): Promise<NextCatalogBuilder>;
   // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
@@ -206,6 +239,42 @@ export class CatalogBuilder {
   ): CatalogBuilder;
 }
 
+// Warning: (ae-missing-release-tag) "CatalogEntityDocument" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface CatalogEntityDocument extends IndexableDocument {
+  // (undocumented)
+  componentType: string;
+  // (undocumented)
+  kind: string;
+  // (undocumented)
+  lifecycle: string;
+  // (undocumented)
+  namespace: string;
+  // (undocumented)
+  owner: string;
+}
+
+// Warning: (ae-missing-release-tag) "CatalogEnvironment" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type CatalogEnvironment = {
+  logger: Logger_2;
+  database: PluginDatabaseManager;
+  config: Config;
+  reader: UrlReader;
+};
+
+// Warning: (ae-missing-release-tag) "CatalogProcessingEngine" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface CatalogProcessingEngine {
+  // (undocumented)
+  start(): Promise<void>;
+  // (undocumented)
+  stop(): Promise<void>;
+}
+
 // Warning: (ae-missing-release-tag) "CatalogProcessingOrchestrator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -332,15 +401,11 @@ export class CommonDatabase implements Database {
     txOpaque: Transaction,
     request: DbEntityRequest[],
   ): Promise<DbEntityResponse[]>;
-  // Warning: (ae-forgotten-export) The symbol "DbLocationsRow" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   addLocation(
     txOpaque: Transaction,
     location: Location_2,
   ): Promise<DbLocationsRow>;
-  // Warning: (ae-forgotten-export) The symbol "DatabaseLocationUpdateLogStatus" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   addLocationUpdateLogEvent(
     locationId: string,
@@ -348,9 +413,6 @@ export class CommonDatabase implements Database {
     entityName?: string | string[],
     message?: string,
   ): Promise<void>;
-  // Warning: (ae-forgotten-export) The symbol "DbEntitiesRequest" needs to be exported by the entry point index.d.ts
-  // Warning: (ae-forgotten-export) The symbol "DbEntitiesResponse" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   entities(
     txOpaque: Transaction,
@@ -366,12 +428,8 @@ export class CommonDatabase implements Database {
     txOpaque: Transaction,
     uid: string,
   ): Promise<DbEntityResponse | undefined>;
-  // Warning: (ae-forgotten-export) The symbol "DbLocationsRowWithStatus" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   location(id: string): Promise<DbLocationsRowWithStatus>;
-  // Warning: (ae-forgotten-export) The symbol "DatabaseLocationUpdateLogEvent" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   locationHistory(id: string): Promise<DatabaseLocationUpdateLogEvent[]>;
   // (undocumented)
@@ -397,12 +455,18 @@ export class CommonDatabase implements Database {
   ): Promise<DbEntityResponse>;
 }
 
-// Warning: (ae-forgotten-export) The symbol "RouterOptions" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "CreateDatabaseOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type CreateDatabaseOptions = {
+  logger: Logger_2;
+};
+
 // Warning: (ae-missing-release-tag) "createNextRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
 export function createNextRouter(
-  options: RouterOptions_2,
+  options: NextRouterOptions,
 ): Promise<express.Router>;
 
 // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
@@ -471,9 +535,6 @@ export type Database = {
 // @public (undocumented)
 export class DatabaseEntitiesCatalog implements EntitiesCatalog {
   constructor(database: Database, logger: Logger_2);
-  // Warning: (ae-forgotten-export) The symbol "EntityUpsertRequest" needs to be exported by the entry point index.d.ts
-  // Warning: (ae-forgotten-export) The symbol "EntityUpsertResponse" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   batchAddOrUpdateEntities(
     requests: EntityUpsertRequest[],
@@ -483,9 +544,6 @@ export class DatabaseEntitiesCatalog implements EntitiesCatalog {
       outputEntities?: boolean;
     },
   ): Promise<EntityUpsertResponse[]>;
-  // Warning: (ae-forgotten-export) The symbol "EntitiesRequest" needs to be exported by the entry point index.d.ts
-  // Warning: (ae-forgotten-export) The symbol "EntitiesResponse" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   entities(request?: EntitiesRequest): Promise<EntitiesResponse>;
   // (undocumented)
@@ -503,8 +561,6 @@ export class DatabaseLocationsCatalog implements LocationsCatalog {
   location(id: string): Promise<LocationResponse>;
   // (undocumented)
   locationHistory(id: string): Promise<DatabaseLocationUpdateLogEvent[]>;
-  // Warning: (ae-forgotten-export) The symbol "LocationResponse" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   locations(): Promise<LocationResponse[]>;
   // (undocumented)
@@ -522,12 +578,32 @@ export class DatabaseLocationsCatalog implements LocationsCatalog {
   removeLocation(id: string): Promise<void>;
 }
 
+// Warning: (ae-missing-release-tag) "DatabaseLocationUpdateLogEvent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type DatabaseLocationUpdateLogEvent = {
+  id: string;
+  status: DatabaseLocationUpdateLogStatus;
+  location_id: string;
+  entity_name: string;
+  created_at?: string;
+  message?: string;
+};
+
+// Warning: (ae-missing-release-tag) "DatabaseLocationUpdateLogStatus" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export enum DatabaseLocationUpdateLogStatus {
+  // (undocumented)
+  FAIL = 'fail',
+  // (undocumented)
+  SUCCESS = 'success',
+}
+
 // Warning: (ae-missing-release-tag) "DatabaseManager" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
 export class DatabaseManager {
-  // Warning: (ae-forgotten-export) The symbol "CreateDatabaseOptions" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   static createDatabase(
     knex: Knex,
@@ -543,6 +619,22 @@ export class DatabaseManager {
   static createTestDatabaseConnection(): Promise<Knex>;
 }
 
+// Warning: (ae-missing-release-tag) "DbEntitiesRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type DbEntitiesRequest = {
+  filter?: EntityFilter;
+  pagination?: EntityPagination;
+};
+
+// Warning: (ae-missing-release-tag) "DbEntitiesResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type DbEntitiesResponse = {
+  entities: DbEntityResponse[];
+  pageInfo: DbPageInfo;
+};
+
 // Warning: (ae-missing-release-tag) "DbEntityRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -560,6 +652,36 @@ export type DbEntityResponse = {
   entity: Entity;
 };
 
+// Warning: (ae-missing-release-tag) "DbLocationsRow" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type DbLocationsRow = {
+  id: string;
+  type: string;
+  target: string;
+};
+
+// Warning: (ae-missing-release-tag) "DbLocationsRowWithStatus" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type DbLocationsRowWithStatus = DbLocationsRow & {
+  status: string | null;
+  timestamp: string | null;
+  message: string | null;
+};
+
+// Warning: (ae-missing-release-tag) "DbPageInfo" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type DbPageInfo =
+  | {
+      hasNextPage: false;
+    }
+  | {
+      hasNextPage: true;
+      endCursor: string;
+    };
+
 // Warning: (ae-missing-release-tag) "DefaultCatalogCollator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -584,8 +706,6 @@ export class DefaultCatalogCollator implements DocumentCollator {
   protected readonly catalogClient: CatalogApi;
   // (undocumented)
   protected discovery: PluginEndpointDiscovery;
-  // Warning: (ae-forgotten-export) The symbol "CatalogEntityDocument" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   execute(): Promise<CatalogEntityDocument[]>;
   // (undocumented)
@@ -621,6 +741,14 @@ export class DefaultCatalogProcessingOrchestrator
   process(request: EntityProcessingRequest): Promise<EntityProcessingResult>;
 }
 
+// Warning: (ae-missing-release-tag) "DeferredEntity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type DeferredEntity = {
+  entity: Entity;
+  locationKey?: string;
+};
+
 // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
 // Warning: (ae-missing-release-tag) "durationText" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -643,6 +771,23 @@ export type EntitiesCatalog = {
   ): Promise<EntityUpsertResponse[]>;
 };
 
+// Warning: (ae-missing-release-tag) "EntitiesRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type EntitiesRequest = {
+  filter?: EntityFilter;
+  fields?: (entity: Entity) => Entity;
+  pagination?: EntityPagination;
+};
+
+// Warning: (ae-missing-release-tag) "EntitiesResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type EntitiesResponse = {
+  entities: Entity[];
+  pageInfo: PageInfo;
+};
+
 // Warning: (ae-missing-release-tag) "EntitiesSearchFilter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
@@ -735,6 +880,22 @@ export type EntityProviderMutation =
       removed: DeferredEntity[];
     };
 
+// Warning: (ae-missing-release-tag) "EntityUpsertRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type EntityUpsertRequest = {
+  entity: Entity;
+  relations: EntityRelationSpec[];
+};
+
+// Warning: (ae-missing-release-tag) "EntityUpsertResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type EntityUpsertResponse = {
+  entityId: string;
+  entity?: Entity;
+};
+
 // Warning: (ae-missing-release-tag) "FileReaderProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -900,8 +1061,7 @@ export type LocationAnalyzer = {
 //
 // @public (undocumented)
 export class LocationEntityProcessor implements CatalogProcessor {
-  // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-  constructor(options: Options_3);
+  constructor(options: LocationEntityProcessorOptions);
   // (undocumented)
   postProcessEntity(
     entity: Entity,
@@ -910,6 +1070,13 @@ export class LocationEntityProcessor implements CatalogProcessor {
   ): Promise<Entity>;
 }
 
+// Warning: (ae-missing-release-tag) "LocationEntityProcessorOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type LocationEntityProcessorOptions = {
+  integrations: ScmIntegrationRegistry;
+};
+
 // Warning: (ae-missing-release-tag) "LocationReader" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -927,6 +1094,14 @@ export class LocationReaders implements LocationReader {
   read(location: LocationSpec): Promise<ReadLocationResult>;
 }
 
+// Warning: (ae-missing-release-tag) "LocationResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type LocationResponse = {
+  data: Location_2;
+  currentStatus: LocationUpdateStatus;
+};
+
 // Warning: (ae-missing-release-tag) "LocationsCatalog" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -947,12 +1122,66 @@ export type LocationsCatalog = {
   ): Promise<void>;
 };
 
+// Warning: (ae-missing-release-tag) "LocationService" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface LocationService {
+  // (undocumented)
+  createLocation(
+    spec: LocationSpec,
+    dryRun: boolean,
+  ): Promise<{
+    location: Location_2;
+    entities: Entity[];
+  }>;
+  // (undocumented)
+  deleteLocation(id: string): Promise<void>;
+  // (undocumented)
+  getLocation(id: string): Promise<Location_2>;
+  // (undocumented)
+  listLocations(): Promise<Location_2[]>;
+}
+
+// Warning: (ae-missing-release-tag) "LocationStore" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface LocationStore {
+  // (undocumented)
+  createLocation(spec: LocationSpec): Promise<Location_2>;
+  // (undocumented)
+  deleteLocation(id: string): Promise<void>;
+  // (undocumented)
+  getLocation(id: string): Promise<Location_2>;
+  // (undocumented)
+  listLocations(): Promise<Location_2[]>;
+}
+
+// Warning: (ae-missing-release-tag) "LocationUpdateLogEvent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type LocationUpdateLogEvent = {
+  id: string;
+  status: 'fail' | 'success';
+  location_id: string;
+  entity_name: string;
+  created_at?: string;
+  message?: string;
+};
+
+// Warning: (ae-missing-release-tag) "LocationUpdateStatus" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type LocationUpdateStatus = {
+  timestamp: string | null;
+  status: string | null;
+  message: string | null;
+};
+
 // Warning: (ae-missing-release-tag) "NextCatalogBuilder" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
 export class NextCatalogBuilder {
-  // Warning: (ae-forgotten-export) The symbol "CatalogEnvironment" needs to be exported by the entry point index.d.ts
-  constructor(env: CatalogEnvironment_2);
+  constructor(env: CatalogEnvironment);
   // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
   addEntityPolicy(...policies: EntityPolicy[]): NextCatalogBuilder;
   // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
@@ -986,6 +1215,22 @@ export class NextCatalogBuilder {
   setRefreshIntervalSeconds(seconds: number): NextCatalogBuilder;
 }
 
+// Warning: (ae-missing-release-tag) "NextRouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface NextRouterOptions {
+  // (undocumented)
+  config: Config;
+  // (undocumented)
+  entitiesCatalog?: EntitiesCatalog;
+  // (undocumented)
+  locationAnalyzer?: LocationAnalyzer;
+  // (undocumented)
+  locationService: LocationService;
+  // (undocumented)
+  logger: Logger_2;
+}
+
 // Warning: (ae-missing-release-tag) "notFoundError" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -994,6 +1239,18 @@ function notFoundError(
   message: string,
 ): CatalogProcessorResult;
 
+// Warning: (ae-missing-release-tag) "PageInfo" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type PageInfo =
+  | {
+      hasNextPage: false;
+    }
+  | {
+      hasNextPage: true;
+      endCursor: string;
+    };
+
 // Warning: (ae-missing-release-tag) "parseEntityYaml" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -1006,20 +1263,51 @@ export function parseEntityYaml(
 //
 // @public
 export class PlaceholderProcessor implements CatalogProcessor {
-  // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-  constructor(options: Options_4);
+  constructor(options: PlaceholderProcessorOptions);
   // (undocumented)
   preProcessEntity(entity: Entity, location: LocationSpec): Promise<Entity>;
 }
 
-// Warning: (ae-forgotten-export) The symbol "ResolverParams" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "PlaceholderProcessorOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type PlaceholderProcessorOptions = {
+  resolvers: Record<string, PlaceholderResolver>;
+  reader: UrlReader;
+  integrations: ScmIntegrationRegistry;
+};
+
 // Warning: (ae-missing-release-tag) "PlaceholderResolver" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
 export type PlaceholderResolver = (
-  params: ResolverParams,
+  params: PlaceholderResolverParams,
 ) => Promise<JsonValue>;
 
+// Warning: (ae-missing-release-tag) "PlaceholderResolverParams" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type PlaceholderResolverParams = {
+  key: string;
+  value: JsonValue;
+  baseUrl: string;
+  read: PlaceholderResolverRead;
+  resolveUrl: PlaceholderResolverResolveUrl;
+};
+
+// Warning: (ae-missing-release-tag) "PlaceholderResolverRead" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type PlaceholderResolverRead = (url: string) => Promise<Buffer>;
+
+// Warning: (ae-missing-release-tag) "PlaceholderResolverResolveUrl" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type PlaceholderResolverResolveUrl = (
+  url: string,
+  base: string,
+) => string;
+
 // Warning: (ae-missing-release-tag) "ReadLocationEntity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -1132,7 +1420,7 @@ export type Transaction = {
 // @public (undocumented)
 export class UrlReaderProcessor implements CatalogProcessor {
   // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-  constructor(options: Options_5);
+  constructor(options: Options_3);
   // (undocumented)
   readLocation(
     location: LocationSpec,
@@ -1150,7 +1438,6 @@ export class UrlReaderProcessor implements CatalogProcessor {
 // src/catalog/types.d.ts:43:8 - (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
 // src/catalog/types.d.ts:44:8 - (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
 // src/catalog/types.d.ts:45:8 - (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-// src/catalog/types.d.ts:75:5 - (ae-forgotten-export) The symbol "LocationUpdateLogEvent" needs to be exported by the entry point index.d.ts
 // src/database/types.d.ts:125:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
 // src/database/types.d.ts:131:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
 // src/database/types.d.ts:132:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
@@ -1179,11 +1466,6 @@ export class UrlReaderProcessor implements CatalogProcessor {
 // src/ingestion/processors/types.d.ts:58:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
 // src/ingestion/types.d.ts:17:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
 // src/ingestion/types.d.ts:41:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
-// src/ingestion/types.d.ts:49:5 - (ae-forgotten-export) The symbol "AnalyzeLocationExistingEntity" needs to be exported by the entry point index.d.ts
-// src/ingestion/types.d.ts:50:5 - (ae-forgotten-export) The symbol "AnalyzeLocationGenerateEntity" needs to be exported by the entry point index.d.ts
-// src/next/NextCatalogBuilder.d.ts:147:9 - (ae-forgotten-export) The symbol "CatalogProcessingEngine" needs to be exported by the entry point index.d.ts
-// src/next/NextCatalogBuilder.d.ts:148:9 - (ae-forgotten-export) The symbol "LocationService" needs to be exported by the entry point index.d.ts
-// src/next/processing/types.d.ts:11:5 - (ae-forgotten-export) The symbol "DeferredEntity" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 ```

plugins/catalog-backend/src/catalog/index.ts

@@ -16,4 +16,15 @@
 
 export { DatabaseEntitiesCatalog } from './DatabaseEntitiesCatalog';
 export { DatabaseLocationsCatalog } from './DatabaseLocationsCatalog';
-export type { EntitiesCatalog, LocationsCatalog } from './types';
+export type {
+  EntitiesCatalog,
+  LocationsCatalog,
+  EntityUpsertRequest,
+  EntityUpsertResponse,
+  EntitiesRequest,
+  EntitiesResponse,
+  LocationResponse,
+  PageInfo,
+  LocationUpdateLogEvent,
+  LocationUpdateStatus,
+} from './types';

plugins/catalog-backend/src/database/index.ts

@@ -16,6 +16,7 @@
 
 export { CommonDatabase } from './CommonDatabase';
 export { DatabaseManager } from './DatabaseManager';
+export type { CreateDatabaseOptions } from './DatabaseManager';
 export type {
   Database,
   DbEntityRequest,
@@ -24,4 +25,11 @@ export type {
   EntityFilter,
   EntityPagination,
   Transaction,
+  DbEntitiesRequest,
+  DbEntitiesResponse,
+  DbLocationsRowWithStatus,
+  DatabaseLocationUpdateLogEvent,
+  DbLocationsRow,
+  DatabaseLocationUpdateLogStatus,
+  DbPageInfo,
 } from './types';

plugins/catalog-backend/src/ingestion/index.ts

@@ -16,5 +16,18 @@
 
 export { HigherOrderOperations } from './HigherOrderOperations';
 export { LocationReaders } from './LocationReaders';
-export * from './types';
+export type {
+  AddLocationResult,
+  AnalyzeLocationRequest,
+  AnalyzeLocationResponse,
+  HigherOrderOperation,
+  LocationAnalyzer,
+  LocationReader,
+  ReadLocationEntity,
+  ReadLocationError,
+  ReadLocationResult,
+  AnalyzeLocationEntityField,
+  AnalyzeLocationExistingEntity,
+  AnalyzeLocationGenerateEntity,
+} from './types';
 export * from './processors';

plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts

@@ -38,12 +38,12 @@ export function toAbsoluteUrl(
   }
 }
 
-type Options = {
+export type LocationEntityProcessorOptions = {
   integrations: ScmIntegrationRegistry;
 };
 
 export class LocationEntityProcessor implements CatalogProcessor {
-  constructor(private readonly options: Options) {}
+  constructor(private readonly options: LocationEntityProcessorOptions) {}
 
   async postProcessEntity(
     entity: Entity,

plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.test.ts

@@ -21,8 +21,8 @@ import {
   jsonPlaceholderResolver,
   PlaceholderProcessor,
   PlaceholderResolver,
-  ResolverParams,
-  ResolverRead,
+  PlaceholderResolverParams,
+  PlaceholderResolverRead,
   textPlaceholderResolver,
   yamlPlaceholderResolver,
 } from './PlaceholderProcessor';
@@ -30,7 +30,7 @@ import {
 const integrations = ScmIntegrations.fromConfig(new ConfigReader({}));
 
 describe('PlaceholderProcessor', () => {
-  const read: jest.MockedFunction<ResolverRead> = jest.fn();
+  const read: jest.MockedFunction<PlaceholderResolverRead> = jest.fn();
   const reader: UrlReader = { read, readTree: jest.fn(), search: jest.fn() };
 
   beforeEach(() => {
@@ -353,8 +353,8 @@ describe('PlaceholderProcessor', () => {
 });
 
 describe('yamlPlaceholderResolver', () => {
-  const read: jest.MockedFunction<ResolverRead> = jest.fn();
-  const params: ResolverParams = {
+  const read: jest.MockedFunction<PlaceholderResolverRead> = jest.fn();
+  const params: PlaceholderResolverParams = {
     key: 'a',
     value: './file.yaml',
     baseUrl: 'https://github.com/backstage/backstage/a/b/catalog-info.yaml',
@@ -398,8 +398,8 @@ describe('yamlPlaceholderResolver', () => {
 });
 
 describe('jsonPlaceholderResolver', () => {
-  const read: jest.MockedFunction<ResolverRead> = jest.fn();
-  const params: ResolverParams = {
+  const read: jest.MockedFunction<PlaceholderResolverRead> = jest.fn();
+  const params: PlaceholderResolverParams = {
     key: 'a',
     value: './file.json',
     baseUrl: 'https://github.com/backstage/backstage/a/b/catalog-info.yaml',

plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.ts

@@ -21,22 +21,25 @@ import { ScmIntegrationRegistry } from '@backstage/integration';
 import yaml from 'yaml';
 import { CatalogProcessor } from './types';
 
-export type ResolverRead = (url: string) => Promise<Buffer>;
-export type ResolverResolveUrl = (url: string, base: string) => string;
+export type PlaceholderResolverRead = (url: string) => Promise<Buffer>;
+export type PlaceholderResolverResolveUrl = (
+  url: string,
+  base: string,
+) => string;
 
-export type ResolverParams = {
+export type PlaceholderResolverParams = {
   key: string;
   value: JsonValue;
   baseUrl: string;
-  read: ResolverRead;
-  resolveUrl: ResolverResolveUrl;
+  read: PlaceholderResolverRead;
+  resolveUrl: PlaceholderResolverResolveUrl;
 };
 
 export type PlaceholderResolver = (
-  params: ResolverParams,
+  params: PlaceholderResolverParams,
 ) => Promise<JsonValue>;
 
-type Options = {
+export type PlaceholderProcessorOptions = {
   resolvers: Record<string, PlaceholderResolver>;
   reader: UrlReader;
   integrations: ScmIntegrationRegistry;
@@ -47,7 +50,7 @@ type Options = {
  * that it then fills in with actual data.
  */
 export class PlaceholderProcessor implements CatalogProcessor {
-  constructor(private readonly options: Options) {}
+  constructor(private readonly options: PlaceholderProcessorOptions) {}
 
   async preProcessEntity(
     entity: Entity,
@@ -135,7 +138,7 @@ export class PlaceholderProcessor implements CatalogProcessor {
  */
 
 export async function yamlPlaceholderResolver(
-  params: ResolverParams,
+  params: PlaceholderResolverParams,
 ): Promise<JsonValue> {
   const text = await readTextLocation(params);
 
@@ -166,7 +169,7 @@ export async function yamlPlaceholderResolver(
 }
 
 export async function jsonPlaceholderResolver(
-  params: ResolverParams,
+  params: PlaceholderResolverParams,
 ): Promise<JsonValue> {
   const text = await readTextLocation(params);
 
@@ -180,7 +183,7 @@ export async function jsonPlaceholderResolver(
 }
 
 export async function textPlaceholderResolver(
-  params: ResolverParams,
+  params: PlaceholderResolverParams,
 ): Promise<JsonValue> {
   return await readTextLocation(params);
 }
@@ -189,7 +192,9 @@ export async function textPlaceholderResolver(
  * Helpers
  */
 
-async function readTextLocation(params: ResolverParams): Promise<string> {
+async function readTextLocation(
+  params: PlaceholderResolverParams,
+): Promise<string> {
   const newUrl = relativeUrl(params);
 
   try {
@@ -207,7 +212,7 @@ function relativeUrl({
   value,
   baseUrl,
   resolveUrl,
-}: ResolverParams): string {
+}: PlaceholderResolverParams): string {
   if (typeof value !== 'string') {
     throw new Error(
       `Placeholder \$${key} expected a string value parameter, in the form of an absolute URL or a relative path`,

plugins/catalog-backend/src/ingestion/processors/index.ts

@@ -19,6 +19,7 @@ import * as results from './results';
 export { AnnotateLocationEntityProcessor } from './AnnotateLocationEntityProcessor';
 export { AnnotateScmSlugEntityProcessor } from './AnnotateScmSlugEntityProcessor';
 export { AwsOrganizationCloudAccountProcessor } from './AwsOrganizationCloudAccountProcessor';
+export type { AwsOrganizationProviderConfig } from './awsOrganization/config';
 export { BitbucketDiscoveryProcessor } from './BitbucketDiscoveryProcessor';
 export { BuiltinKindsEntityProcessor } from './BuiltinKindsEntityProcessor';
 export { CodeOwnersProcessor } from './CodeOwnersProcessor';
@@ -28,8 +29,15 @@ export { GithubOrgReaderProcessor } from './GithubOrgReaderProcessor';
 export { GithubMultiOrgReaderProcessor } from './GithubMultiOrgReaderProcessor';
 export { GitLabDiscoveryProcessor } from './GitLabDiscoveryProcessor';
 export { LocationEntityProcessor } from './LocationEntityProcessor';
+export type { LocationEntityProcessorOptions } from './LocationEntityProcessor';
 export { PlaceholderProcessor } from './PlaceholderProcessor';
-export type { PlaceholderResolver } from './PlaceholderProcessor';
+export type {
+  PlaceholderProcessorOptions,
+  PlaceholderResolver,
+  PlaceholderResolverParams,
+  PlaceholderResolverRead,
+  PlaceholderResolverResolveUrl,
+} from './PlaceholderProcessor';
 export { StaticLocationProcessor } from './StaticLocationProcessor';
 export * from './types';
 export { UrlReaderProcessor } from './UrlReaderProcessor';

plugins/catalog-backend/src/ingestion/types.ts

@@ -99,7 +99,7 @@ export type AnalyzeLocationResponse = {
 // read and emitted like this so that the frontend can inform the user that it
 // located them and can make sure to register them as well if they weren't
 // already
-type AnalyzeLocationExistingEntity = {
+export type AnalyzeLocationExistingEntity = {
   location: LocationSpec;
   isRegistered: boolean;
   entity: Entity;
@@ -110,7 +110,7 @@ type AnalyzeLocationExistingEntity = {
 // the frontend. It'll probably contain a (possibly incomplete) entity, plus
 // enough info for the frontend to know what form data to show to the user
 // for overriding/completing the info.
-type AnalyzeLocationGenerateEntity = {
+export type AnalyzeLocationGenerateEntity = {
   // Some form of partial representation of the entity
   entity: RecursivePartial<Entity>;
   // Lists the suggestions that the user may want to override
@@ -120,7 +120,7 @@ type AnalyzeLocationGenerateEntity = {
 // This is where I get really vague. Something like this perhaps? Or it could be
 // something like a json-schema that contains enough info for the frontend to
 // be able to present a form and explanations
-type AnalyzeLocationEntityField = {
+export type AnalyzeLocationEntityField = {
   // e.g. "spec.owner"? The frontend needs to know how to "inject" the field into the
   // entity again if the user wants to change it
   field: string;

plugins/catalog-backend/src/next/NextCatalogBuilder.ts

@@ -14,11 +14,7 @@
  * limitations under the License.
  */
 
-import {
-  PluginDatabaseManager,
-  resolvePackagePath,
-  UrlReader,
-} from '@backstage/backend-common';
+import { resolvePackagePath } from '@backstage/backend-common';
 import {
   DefaultNamespaceEntityPolicy,
   EntityPolicies,
@@ -29,11 +25,9 @@ import {
   SchemaValidEntityPolicy,
   Validators,
 } from '@backstage/catalog-model';
-import { Config } from '@backstage/config';
 import { ScmIntegrations } from '@backstage/integration';
 import { createHash } from 'crypto';
 import lodash from 'lodash';
-import { Logger } from 'winston';
 import {
   DatabaseLocationsCatalog,
   EntitiesCatalog,
@@ -80,13 +74,7 @@ import {
   createRandomRefreshInterval,
   RefreshIntervalFunction,
 } from './refresh';
-
-export type CatalogEnvironment = {
-  logger: Logger;
-  database: PluginDatabaseManager;
-  config: Config;
-  reader: UrlReader;
-};
+import { CatalogEnvironment } from '../service/CatalogBuilder';
 
 /**
  * A builder that helps wire up all of the component parts of the catalog.

plugins/catalog-backend/src/next/NextRouter.ts

@@ -36,7 +36,7 @@ import {
 import { disallowReadonlyMode, validateRequestBody } from '../service/util';
 import { LocationService } from './types';
 
-export interface RouterOptions {
+export interface NextRouterOptions {
   entitiesCatalog?: EntitiesCatalog;
   locationAnalyzer?: LocationAnalyzer;
   locationService: LocationService;
@@ -45,7 +45,7 @@ export interface RouterOptions {
 }
 
 export async function createNextRouter(
-  options: RouterOptions,
+  options: NextRouterOptions,
 ): Promise<express.Router> {
   const { entitiesCatalog, locationAnalyzer, locationService, config, logger } =
     options;

plugins/catalog-backend/src/next/index.ts

@@ -16,6 +16,7 @@
 
 export { NextCatalogBuilder } from './NextCatalogBuilder';
 export { createNextRouter } from './NextRouter';
+export type { NextRouterOptions } from './NextRouter';
 export * from './processing';
 export { createRandomRefreshInterval } from './refresh';
 export type { RefreshIntervalFunction } from './refresh';
@@ -24,4 +25,7 @@ export type {
   EntityProvider,
   EntityProviderConnection,
   EntityProviderMutation,
+  CatalogProcessingEngine,
+  LocationService,
+  LocationStore,
 } from './types';

plugins/catalog-backend/src/next/processing/index.ts

@@ -18,5 +18,6 @@ export type {
   CatalogProcessingOrchestrator,
   EntityProcessingRequest,
   EntityProcessingResult,
+  DeferredEntity,
 } from './types';
 export { DefaultCatalogProcessingOrchestrator } from './DefaultCatalogProcessingOrchestrator';

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

@@ -15,3 +15,4 @@
  */
 
 export { DefaultCatalogCollator } from './DefaultCatalogCollator';
+export type { CatalogEntityDocument } from './DefaultCatalogCollator';

plugins/catalog-backend/src/service/index.ts

@@ -15,5 +15,6 @@
  */
 
 export { CatalogBuilder } from './CatalogBuilder';
+export type { CatalogEnvironment } from './CatalogBuilder';
 export { createRouter } from './router';
 export type { RouterOptions } from './router';