catalog-client: API report warnings cleanup

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

packages/catalog-client/api-report.md

@@ -7,8 +7,6 @@ import { Entity } from '@backstage/catalog-model';
 import { EntityName } from '@backstage/catalog-model';
 import { Location as Location_2 } from '@backstage/catalog-model';
 
-// Warning: (ae-missing-release-tag) "AddLocationRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type AddLocationRequest = {
   type?: string;
@@ -17,21 +15,15 @@ export type AddLocationRequest = {
   presence?: 'optional' | 'required';
 };
 
-// Warning: (ae-missing-release-tag) "AddLocationResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type AddLocationResponse = {
   location: Location_2;
   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)
 export interface CatalogApi {
   // (undocumented)
@@ -76,8 +68,6 @@ export interface CatalogApi {
   ): Promise<void>;
 }
 
-// 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 });
@@ -123,8 +113,6 @@ export class CatalogClient implements CatalogApi {
   ): Promise<void>;
 }
 
-// Warning: (ae-missing-release-tag) "CatalogEntitiesRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type CatalogEntitiesRequest = {
   filter?:
@@ -134,29 +122,24 @@ export type CatalogEntitiesRequest = {
   fields?: string[] | undefined;
 };
 
-// Warning: (ae-missing-release-tag) "CatalogListResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type CatalogListResponse<T> = {
   items: T[];
 };
 
-// Warning: (ae-missing-release-tag) "CatalogRequestOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 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)
-//
+// @public
+export type DiscoveryApi = {
+  getBaseUrl(pluginId: string): Promise<string>;
+};
+
 // @public
 export const ENTITY_STATUS_CATALOG_PROCESSING_TYPE =
   'backstage.io/catalog-processing';
 
-// Warnings were encountered during analysis:
-//
-// src/CatalogClient.d.ts:7:9 - (ae-forgotten-export) The symbol "DiscoveryApi" needs to be exported by the entry point index.d.ts
-
 // (No @packageDocumentation comment for this package)
 ```

packages/catalog-client/src/CatalogClient.ts

@@ -36,6 +36,7 @@ import {
 } from './types/api';
 import { DiscoveryApi } from './types/discovery';
 
+/** @public */
 export class CatalogClient implements CatalogApi {
   private readonly discoveryApi: DiscoveryApi;
 

packages/catalog-client/src/types/api.ts

@@ -16,8 +16,10 @@
 
 import { Entity, EntityName, Location } from '@backstage/catalog-model';
 
+/** @public */
 export const CATALOG_FILTER_EXISTS = Symbol('CATALOG_FILTER_EXISTS');
 
+/** @public */
 export type CatalogEntitiesRequest = {
   filter?:
     | Record<string, string | symbol | (string | symbol)[]>[]
@@ -26,14 +28,17 @@ export type CatalogEntitiesRequest = {
   fields?: string[] | undefined;
 };
 
+/** @public */
 export type CatalogListResponse<T> = {
   items: T[];
 };
 
+/** @public */
 export type CatalogRequestOptions = {
   token?: string;
 };
 
+/** @public */
 export interface CatalogApi {
   // Entities
   getEntities(
@@ -72,6 +77,7 @@ export interface CatalogApi {
   ): Promise<void>;
 }
 
+/** @public */
 export type AddLocationRequest = {
   type?: string;
   target: string;
@@ -79,6 +85,7 @@ export type AddLocationRequest = {
   presence?: 'optional' | 'required';
 };
 
+/** @public */
 export type AddLocationResponse = {
   location: Location;
   entities: Entity[];

packages/catalog-client/src/types/discovery.ts

@@ -16,6 +16,8 @@
 
 /**
  * This is a copy of the core DiscoveryApi, to avoid importing core.
+ *
+ * @public
  */
 export type DiscoveryApi = {
   getBaseUrl(pluginId: string): Promise<string>;

packages/catalog-client/src/types/index.ts

@@ -22,5 +22,6 @@ export type {
   CatalogListResponse,
   CatalogRequestOptions,
 } from './api';
+export type { DiscoveryApi } from './discovery';
 export { CATALOG_FILTER_EXISTS } from './api';
 export { ENTITY_STATUS_CATALOG_PROCESSING_TYPE } from './status';

packages/catalog-client/src/types/status.ts

@@ -17,6 +17,8 @@
 /**
  * The entity `status.items[].type` for the status of the processing engine in
  * regards to an entity.
+ *
+ * @public
  */
 export const ENTITY_STATUS_CATALOG_PROCESSING_TYPE =
   'backstage.io/catalog-processing';