diff --git a/packages/catalog-client/api-report.md b/packages/catalog-client/api-report.md index 173af9aef3..2e39dfd07f 100644 --- a/packages/catalog-client/api-report.md +++ b/packages/catalog-client/api-report.md @@ -25,11 +25,6 @@ export type AddLocationResponse = { entities: Entity[]; }; -// Warning: (ae-missing-release-tag) "CATALOG_FILTER_EXISTS" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) -export const CATALOG_FILTER_EXISTS: unique symbol; - // Warning: (ae-missing-release-tag) "CatalogApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -76,50 +71,59 @@ export interface CatalogApi { ): Promise; } +// Warning: (ae-forgotten-export) The symbol "CatalogApi" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "CatalogClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export class CatalogClient implements CatalogApi { - constructor(options: { discoveryApi: DiscoveryApi }); +export class CatalogClient implements CatalogApi_2 { + constructor(options: { discoveryApi: DiscoveryApi_2 }); + // Warning: (ae-forgotten-export) The symbol "AddLocationRequest" needs to be exported by the entry point index.d.ts + // Warning: (ae-forgotten-export) The symbol "AddLocationResponse" needs to be exported by the entry point index.d.ts + // // (undocumented) addLocation( - { type, target, dryRun, presence }: AddLocationRequest, - options?: CatalogRequestOptions, - ): Promise; + { type, target, dryRun, presence }: AddLocationRequest_2, + options?: CatalogRequestOptions_2, + ): Promise; + // Warning: (ae-forgotten-export) The symbol "CatalogEntitiesRequest" needs to be exported by the entry point index.d.ts + // Warning: (ae-forgotten-export) The symbol "CatalogListResponse" needs to be exported by the entry point index.d.ts + // // (undocumented) getEntities( - request?: CatalogEntitiesRequest, - options?: CatalogRequestOptions, - ): Promise>; + request?: CatalogEntitiesRequest_2, + options?: CatalogRequestOptions_2, + ): Promise>; // (undocumented) getEntityByName( compoundName: EntityName, - options?: CatalogRequestOptions, + options?: CatalogRequestOptions_2, ): Promise; // (undocumented) getLocationByEntity( entity: Entity, - options?: CatalogRequestOptions, + options?: CatalogRequestOptions_2, ): Promise; + // Warning: (ae-forgotten-export) The symbol "CatalogRequestOptions" needs to be exported by the entry point index.d.ts + // // (undocumented) getLocationById( id: string, - options?: CatalogRequestOptions, + options?: CatalogRequestOptions_2, ): Promise; // (undocumented) getOriginLocationByEntity( entity: Entity, - options?: CatalogRequestOptions, + options?: CatalogRequestOptions_2, ): Promise; // (undocumented) removeEntityByUid( uid: string, - options?: CatalogRequestOptions, + options?: CatalogRequestOptions_2, ): Promise; // (undocumented) removeLocationById( id: string, - options?: CatalogRequestOptions, + options?: CatalogRequestOptions_2, ): Promise; } @@ -128,8 +132,8 @@ export class CatalogClient implements CatalogApi { // @public (undocumented) export type CatalogEntitiesRequest = { filter?: - | Record[] - | Record + | Record[] + | Record | undefined; fields?: string[] | undefined; }; @@ -148,11 +152,12 @@ export type CatalogRequestOptions = { token?: string; }; -// Warning: (ae-missing-release-tag) "ENTITY_STATUS_CATALOG_PROCESSING_TYPE" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// Warning: (ae-missing-release-tag) "DiscoveryApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public -export const ENTITY_STATUS_CATALOG_PROCESSING_TYPE = - 'backstage.io/catalog-processing'; +export type DiscoveryApi = { + getBaseUrl(pluginId: string): Promise; +}; // Warnings were encountered during analysis: // diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index 7286855d4e..8f0d6c32e9 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -419,6 +419,24 @@ export function createNextRouter( options: RouterOptions_2, ): Promise; +// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag +// Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" +// Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters +// Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' +// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag +// Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" +// Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters +// Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' +// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag +// Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" +// Warning: (ae-missing-release-tag) "createRandomRefreshInterval" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export function createRandomRefreshInterval(options: { + minSeconds: number; + maxSeconds: number; +}): RefreshIntervalFunction; + // Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -914,6 +932,9 @@ export class NextCatalogBuilder { key: string, resolver: PlaceholderResolver, ): NextCatalogBuilder; + setRefreshInterval( + refreshInterval: RefreshIntervalFunction, + ): NextCatalogBuilder; setRefreshIntervalSeconds(seconds: number): NextCatalogBuilder; } @@ -987,6 +1008,11 @@ export type RecursivePartial = { : T[P]; }; +// Warning: (ae-missing-release-tag) "RefreshIntervalFunction" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export type RefreshIntervalFunction = () => number; + // Warning: (ae-missing-release-tag) "relation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -1107,8 +1133,8 @@ export class UrlReaderProcessor implements CatalogProcessor { // 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:140:9 - (ae-forgotten-export) The symbol "CatalogProcessingEngine" needs to be exported by the entry point index.d.ts -// src/next/NextCatalogBuilder.d.ts:141:9 - (ae-forgotten-export) The symbol "LocationService" 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)