paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 34 Packages Projects Releases Wiki Activity

catalog-client: clean up api exports

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2022-02-11 15:51:18 +01:00
parent da6e8838f3
commit 538ca90790
22 changed files with 349 additions and 335 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/clever-pears-turn.md
+11
View File
@@ -0,0 +1,11 @@
---
'@backstage/plugin-catalog': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-catalog-graph': patch
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-org': patch
'@backstage/plugin-scaffolder': patch
'@backstage/plugin-tech-insights-backend': patch
---
Use updated type names from `@backstage/catalog-client`
.changeset/tasty-eagles-retire.md
+11
View File
@@ -0,0 +1,11 @@
---
'@backstage/catalog-client': minor
---
Deprecated the following types used by the catalog client, and created new
corresponding types to make them more consistent:
- `CatalogEntitiesRequest` -> `GetEntitiesRequest`
- `CatalogListResponse` was removed and generally replaced with `GetEntitiesResponse` (which does not use a type parameter argument)
- `CatalogEntityAncestorsRequest`-> `GetEntityAncestorsRequest`
- `CatalogEntityAncestorsResponse` -> `GetEntityAncestorsResponse`
packages/catalog-client/api-report.md
+57 -40
View File
@@ -32,13 +32,13 @@ export interface CatalogApi {
options?: CatalogRequestOptions,
): Promise<AddLocationResponse>;
getEntities(
request?: CatalogEntitiesRequest,
request?: GetEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
): Promise<GetEntitiesResponse>;
getEntityAncestors(
request: CatalogEntityAncestorsRequest,
request: GetEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse>;
): Promise<GetEntityAncestorsResponse>;
getEntityByName(
name: EntityName,
options?: CatalogRequestOptions,
@@ -84,13 +84,13 @@ export class CatalogClient implements CatalogApi {
options?: CatalogRequestOptions,
): Promise<AddLocationResponse>;
getEntities(
request?: CatalogEntitiesRequest,
request?: GetEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
): Promise<GetEntitiesResponse>;
getEntityAncestors(
request: CatalogEntityAncestorsRequest,
request: GetEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse>;
): Promise<GetEntityAncestorsResponse>;
getEntityByName(
compoundName: EntityName,
options?: CatalogRequestOptions,
@@ -121,43 +121,60 @@ export class CatalogClient implements CatalogApi {
): Promise<void>;
}
// @public
export type CatalogEntitiesRequest = {
filter?:
| Record<string, string | symbol | (string | symbol)[]>[]
| Record<string, string | symbol | (string | symbol)[]>
| undefined;
fields?: string[] | undefined;
offset?: number;
limit?: number;
after?: string;
};
// @public @deprecated (undocumented)
export type CatalogEntitiesRequest = GetEntitiesRequest;
// @public @deprecated (undocumented)
export type CatalogEntityAncestorsRequest = GetEntityAncestorsRequest;
// @public @deprecated (undocumented)
export type CatalogEntityAncestorsResponse = GetEntityAncestorsResponse;
// @public @deprecated (undocumented)
export type CatalogListResponse<_Entity> = GetEntitiesResponse;
// @public
export type CatalogEntityAncestorsRequest = {
entityRef: string;
};
// @public
export type CatalogEntityAncestorsResponse = {
rootEntityRef: string;
items: {
entity: Entity;
parentEntityRefs: string[];
}[];
};
// @public
export type CatalogListResponse<T> = {
items: T[];
};
// @public
export type CatalogRequestOptions = {
export interface CatalogRequestOptions {
// (undocumented)
token?: string;
};
}
// @public
export const ENTITY_STATUS_CATALOG_PROCESSING_TYPE =
'backstage.io/catalog-processing';
// @public
export interface GetEntitiesRequest {
after?: string;
fields?: string[] | undefined;
filter?:
| Record<string, string | symbol | (string | symbol)[]>[]
| Record<string, string | symbol | (string | symbol)[]>
| undefined;
limit?: number;
offset?: number;
}
// @public
export interface GetEntitiesResponse {
// (undocumented)
items: Entity[];
}
// @public
export interface GetEntityAncestorsRequest {
// (undocumented)
entityRef: string;
}
// @public
export interface GetEntityAncestorsResponse {
// (undocumented)
items: Array<{
entity: Entity;
parentEntityRefs: string[];
}>;
// (undocumented)
rootEntityRef: string;
}
```
packages/catalog-client/src/CatalogClient.test.ts
+2 -2
View File
@@ -18,7 +18,7 @@ import { Entity } from '@backstage/catalog-model';
import { rest } from 'msw';
import { setupServer } from 'msw/node';
import { CatalogClient } from './CatalogClient';
import { CATALOG_FILTER_EXISTS, CatalogListResponse } from './types/api';
import { CATALOG_FILTER_EXISTS, GetEntitiesResponse } from './types/api';
import { DiscoveryApi } from './types/discovery';
const server = setupServer();
@@ -60,7 +60,7 @@ describe('CatalogClient', () => {
},
},
];
const defaultResponse: CatalogListResponse<Entity> = {
const defaultResponse: GetEntitiesResponse = {
items: defaultServiceResponse.reverse(),
};
packages/catalog-client/src/CatalogClient.ts
+21 -84
View File
@@ -31,20 +31,21 @@ import {
AddLocationRequest,
AddLocationResponse,
CatalogApi,
CatalogEntitiesRequest,
CatalogListResponse,
GetEntitiesRequest,
GetEntitiesResponse,
CatalogRequestOptions,
CatalogEntityAncestorsRequest,
CatalogEntityAncestorsResponse,
GetEntityAncestorsRequest,
GetEntityAncestorsResponse,
} from './types/api';
import { DiscoveryApi } from './types/discovery';
import { FetchApi } from './types/fetch';
/**
* A frontend and backend compatible client for communicating with the Backstage Catalog.
* A frontend and backend compatible client for communicating with the Backstage
* software catalog.
*
* @public
* */
*/
export class CatalogClient implements CatalogApi {
private readonly discoveryApi: DiscoveryApi;
private readonly fetchApi: FetchApi;
@@ -58,19 +59,12 @@ export class CatalogClient implements CatalogApi {
}
/**
* Gets the Ancestors of an Entity.
*
* @param request - A request type for retrieving Entity ancestors.
* @param options - An object with your preferred options.
*
* @returns A CatalogEntityAncestorsResponse.
*
* @public
* {@inheritdoc CatalogApi.getEntityAncestors}
*/
async getEntityAncestors(
request: CatalogEntityAncestorsRequest,
request: GetEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse> {
): Promise<GetEntityAncestorsResponse> {
const { kind, namespace, name } = parseEntityRef(request.entityRef);
return await this.requestRequired(
'GET',
@@ -82,14 +76,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* Gets a Location by Id.
*
* @param id - A string containing the Id.
* @param options - An object with your preferred options.
*
* @returns A {@link catalog-model#Location_2}.
*
* @public
* {@inheritdoc CatalogApi.getLocationById}
*/
async getLocationById(
id: string,
@@ -103,19 +90,12 @@ export class CatalogClient implements CatalogApi {
}
/**
* Gets a set of Entities.
*
* @param request - A request type for retrieving an Entity.
* @param options - An object with your preferred options.
*
* @returns A CatalogListResponse.
*
* @public
* {@inheritdoc CatalogApi.getEntities}
*/
async getEntities(
request?: CatalogEntitiesRequest,
request?: GetEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>> {
): Promise<GetEntitiesResponse> {
const { filter = [], fields = [], offset, limit, after } = request ?? {};
const filterItems = [filter].flat();
const params: string[] = [];
@@ -190,14 +170,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* Gets a given Entity based on a provided name.
*
* @param compoundName - A string containing the name.
* @param options - An object with your preferred options.
*
* @returns An {@link catalog-model#Entity}.
*
* @public
* {@inheritdoc CatalogApi.getEntityByName}
*/
async getEntityByName(
compoundName: EntityName,
@@ -214,12 +187,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* Refreshes an Entity.
*
* @param entityRef - A string containing the entityREf
* @param options - An object with your preferred options.
*
* @public
* {@inheritdoc CatalogApi.refreshEntity}
*/
async refreshEntity(entityRef: string, options?: CatalogRequestOptions) {
const response = await this.fetchApi.fetch(
@@ -240,14 +208,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* Adds a location.
*
* @param options - An object with your preferred options.
* @param AddLocationRequest - A request object for adding locations.
*
* @returns An AddLocationResponse
*
* @public
* {@inheritdoc CatalogApi.addLocation}
*/
async addLocation(
{ type = 'url', target, dryRun, presence }: AddLocationRequest,
@@ -285,14 +246,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* Gets an origin Location By Entity.
*
* @param entity - An Entity
* @param options - An object with your preferred options.
*
* @returns A {@link catalog-model#Location_2}.
*
* @public
* {@inheritdoc CatalogApi.getOriginLocationByEntity}
*/
async getOriginLocationByEntity(
entity: Entity,
@@ -314,14 +268,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* Gets a Location by Entity.
*
* @param entity - An Entity
* @param options - An object with your preferred options.
*
* @returns A {@link catalog-model#Location_2}.
*
* @public
* {@inheritdoc CatalogApi.getLocationByEntity}
*/
async getLocationByEntity(
entity: Entity,
@@ -342,12 +289,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* Removes a location as identified by Id.
*
* @param id - A string containing the Id
* @param options - An object with your preferred options.
*
* @public
* {@inheritdoc CatalogApi.removeLocationById}
*/
async removeLocationById(
id: string,
@@ -361,12 +303,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* Removes an Entity as identified by Uid.
*
* @param uid - A string containing the Uid
* @param options - An object with your preferred options.
*
* @public
* {@inheritdoc CatalogApi.removeEntityByUid}
*/
async removeEntityByUid(
uid: string,
packages/catalog-client/src/types/api.ts
+151 -152
View File
@@ -17,7 +17,9 @@
import { Entity, EntityName, Location } from '@backstage/catalog-model';
/**
* A Symbol to define if a catalog filter exists or not.
* This symbol can be used in place of a value when passed to filters in e.g.
* {@link CatalogClient.getEntities}, to signify that you want to filter on the
* presence of that key no matter what its value is.
*
* @public
*/
@@ -27,11 +29,11 @@ export const CATALOG_FILTER_EXISTS = Symbol.for(
);
/**
* A request type for retrieving catalog Entities.
* The request type for {@link CatalogClient.getEntities}.
*
* @public
*/
export type CatalogEntitiesRequest = {
export interface GetEntitiesRequest {
/**
* If given, return only entities that match the given patterns.
*
@@ -107,175 +109,50 @@ export type CatalogEntitiesRequest = {
* request.
*/
after?: string;
};
}
/**
* A request type for Catalog Entity Ancestor information.
* The response type for {@link CatalogClient.getEntities}.
*
* @public
*/
export type CatalogEntityAncestorsRequest = {
export interface GetEntitiesResponse {
items: Entity[];
}
/**
* The request type for {@link CatalogClient.getEntityAncestors}.
*
* @public
*/
export interface GetEntityAncestorsRequest {
entityRef: string;
};
}
/**
* A response type for Catalog Entity Ancestor information.
* The response type for {@link CatalogClient.getEntityAncestors}.
*
* @public
*/
export type CatalogEntityAncestorsResponse = {
export interface GetEntityAncestorsResponse {
rootEntityRef: string;
items: { entity: Entity; parentEntityRefs: string[] }[];
};
/**
* A response type for the result of a catalog operation in list form.
*
* @public
*/
export type CatalogListResponse<T> = {
items: T[];
};
items: Array<{
entity: Entity;
parentEntityRefs: string[];
}>;
}
/**
* Options you can pass into a catalog request for additional information.
*
* @public
*/
export type CatalogRequestOptions = {
export interface CatalogRequestOptions {
token?: string;
};
/**
* Public functions for interacting with the Catalog API.
*
* @public
*/
export interface CatalogApi {
/**
* Gets the Entities from the catalog based on your request and options.
*
* @param request - An object with your filters and fields.
* @param options - An object with your preferred options.
*
* @returns A CatalogListResponse with items typed Catalog Model Entity.
*
*/
getEntities(
request?: CatalogEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
/**
* Gets the Entity ancestor information from the catalog based on your request and options.
*
* @param request - An object with your filters and fields.
* @param options - An object with your preferred options.
*
* @returns A CatalogEntityAncestorsResponse.
*/
getEntityAncestors(
request: CatalogEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse>;
/**
* Gets a single Entity from the catalog by Entity name.
*
* @param name - A complete Entity name, with the full kind-namespace-name triplet.
* @param options - An object with your preferred options.
*
* @returns A {@link catalog-model#Entity}.
*/
getEntityByName(
name: EntityName,
options?: CatalogRequestOptions,
): Promise<Entity | undefined>;
/**
* Removes a single Entity from the catalog by Entity UID.
*
* @param uid - A string of the Entity UID.
* @param options - An object with your preferred options.
*
*/
removeEntityByUid(
uid: string,
options?: CatalogRequestOptions,
): Promise<void>;
/**
* Refreshes an Entity in the catalog.
*
* @param entityRef - A string in the form of 'Kind/default:foo'.
* @param options - An object with your preferred options.
*
*/
refreshEntity(
entityRef: string,
options?: CatalogRequestOptions,
): Promise<void>;
// Locations
/**
* Gets a Location object by ID from the catalog.
*
* @param id - A string in of the Location Id.
* @param options - An object with your preferred options.
*
* @returns A {@link catalog-model#Location_2}.
*/
getLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<Location | undefined>;
/**
* Gets origin location by Entity.
*
* @param entity - An {@link catalog-model#Entity}.
* @param options - An object with your preferred options.
*
* @returns A {@link catalog-model#Location_2}.
*/
getOriginLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location | undefined>;
/**
* Gets Location by Entity.
*
* @param entity - An {@link catalog-model#Entity}.
* @param options - An object with your preferred options.
*
* @returns A {@link catalog-model#Location_2}.
*/
getLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location | undefined>;
/**
* Adds a Location.
*
* @param location - A request type for adding a Location to the catalog.
* @param options - An object with your preferred options.
*
* @returns A AddLocationResponse.
*/
addLocation(
location: AddLocationRequest,
options?: CatalogRequestOptions,
): Promise<AddLocationResponse>;
/**
* Removes a Location by Id.
*
* @param id - A string in of the Location Id.
* @param options - An object with your preferred options.
*
*/
removeLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<void>;
}
/**
* A request type for adding a Location to the catalog.
* The request type for {@link CatalogClient.addLocation}.
*
* @public
*/
@@ -287,13 +164,135 @@ export type AddLocationRequest = {
};
/**
* A response type for adding a Location to the catalog.
* The response type for {@link CatalogClient.addLocation}.
*
* @public
*/
export type AddLocationResponse = {
location: Location;
entities: Entity[];
// Exists is only set in DryRun mode.
// Only set in dryRun mode.
exists?: boolean;
};
/**
* A client for interacting with the Backstage software catalog through its API.
*
* @public
*/
export interface CatalogApi {
/**
* Lists catalog entities.
*
* @param request - Request parameters
* @param options - Additional options
*/
getEntities(
request?: GetEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<GetEntitiesResponse>;
/**
* Gets entity ancestor information, i.e. the hierarchy of parent entities
* whose processing resulted in a given entity appearing in the catalog.
*
* @param request - Request parameters
* @param options - Additional options
*/
getEntityAncestors(
request: GetEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<GetEntityAncestorsResponse>;
/**
* Gets a single entity from the catalog by its ref (kind, namespace, name)
* triplet.
*
* @param name - A complete entity ref
* @param options - Additional options
*/
getEntityByName(
name: EntityName,
options?: CatalogRequestOptions,
): Promise<Entity | undefined>;
/**
* Removes a single entity from the catalog by entity UID.
*
* @param uid - An entity UID
* @param options - Additional options
*/
removeEntityByUid(
uid: string,
options?: CatalogRequestOptions,
): Promise<void>;
/**
* Refreshes (marks for reprocessing) an entity in the catalog.
*
* @param entityRef - An entity ref on string form (e.g.
* 'component/default:my-component')
* @param options - Additional options
*/
refreshEntity(
entityRef: string,
options?: CatalogRequestOptions,
): Promise<void>;
// Locations
/**
* Gets a registered location by its ID.
*
* @param id - A location ID
* @param options - Additional options
*/
getLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<Location | undefined>;
/**
* Gets origin location by Entity.
*
* @param entity - An {@link catalog-model#Entity}.
* @param options - Additional options
*/
getOriginLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location | undefined>;
/**
* Gets Location by Entity.
*
* @param entity - An {@link catalog-model#Entity}.
* @param options - Additional options
*/
getLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location | undefined>;
/**
* Registers a new location.
*
* @param location - Request parameters
* @param options - Additional options
*/
addLocation(
location: AddLocationRequest,
options?: CatalogRequestOptions,
): Promise<AddLocationResponse>;
/**
* Removes a registered Location by its ID.
*
* @param id - A location ID
* @param options - Additional options
*/
removeLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<void>;
}
packages/catalog-client/src/types/deprecated.ts
+43
View File
@@ -0,0 +1,43 @@
/*
* Copyright 2022 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
GetEntitiesRequest,
GetEntitiesResponse,
GetEntityAncestorsRequest,
GetEntityAncestorsResponse,
} from './api';
/**
* @public
* @deprecated use GetEntitiesRequest instead
*/
export type CatalogEntitiesRequest = GetEntitiesRequest;
/**
* @public
* @deprecated use GetEntitiesResponse instead
*/
export type CatalogListResponse<_Entity> = GetEntitiesResponse;
/**
* @public
* @deprecated use GetEntityAncestorsRequest instead
*/
export type CatalogEntityAncestorsRequest = GetEntityAncestorsRequest;
/**
* @public
* @deprecated use GetEntityAncestorsResponse instead
*/
export type CatalogEntityAncestorsResponse = GetEntityAncestorsResponse;
packages/catalog-client/src/types/discovery.ts
-2
View File
@@ -16,8 +16,6 @@
/**
* This is a copy of the DiscoveryApi, to avoid importing core-plugin-api.
*
* @public
*/
export type DiscoveryApi = {
getBaseUrl(pluginId: string): Promise<string>;
packages/catalog-client/src/types/fetch.ts
-2
View File
@@ -16,8 +16,6 @@
/**
* This is a copy of FetchApi, to avoid importing core-plugin-api.
*
* @public
*/
export type FetchApi = {
fetch: typeof fetch;
packages/catalog-client/src/types/index.ts
+6 -5
View File
@@ -14,15 +14,16 @@
* limitations under the License.
*/
export { CATALOG_FILTER_EXISTS } from './api';
export type {
AddLocationRequest,
AddLocationResponse,
CatalogApi,
CatalogEntitiesRequest,
CatalogListResponse,
CatalogRequestOptions,
CatalogEntityAncestorsRequest,
CatalogEntityAncestorsResponse,
GetEntitiesRequest,
GetEntitiesResponse,
GetEntityAncestorsRequest,
GetEntityAncestorsResponse,
} from './api';
export { CATALOG_FILTER_EXISTS } from './api';
export { ENTITY_STATUS_CATALOG_PROCESSING_TYPE } from './status';
export * from './deprecated';
plugins/catalog-backend/api-report.md
+4 -4
View File
@@ -8,7 +8,6 @@
import { Account } from 'aws-sdk/clients/organizations';
import { BitbucketIntegration } from '@backstage/integration';
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogEntitiesRequest } from '@backstage/catalog-client';
import { ConditionalPolicyDecision } from '@backstage/plugin-permission-node';
import { Conditions } from '@backstage/plugin-permission-node';
import { Config } from '@backstage/config';
@@ -17,6 +16,7 @@ import { Entity } from '@backstage/catalog-model';
import { EntityPolicy } from '@backstage/catalog-model';
import { EntityRelationSpec } from '@backstage/catalog-model';
import express from 'express';
import { GetEntitiesRequest } from '@backstage/catalog-client';
import { GithubCredentialsProvider } from '@backstage/integration';
import { GitHubIntegrationConfig } from '@backstage/integration';
import { IndexableDocument } from '@backstage/search-common';
@@ -509,7 +509,7 @@ export class DefaultCatalogCollator implements DocumentCollator {
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
locationTemplate?: string;
filter?: CatalogEntitiesRequest['filter'];
filter?: GetEntitiesRequest['filter'];
catalogClient?: CatalogApi;
});
// (undocumented)
@@ -524,14 +524,14 @@ export class DefaultCatalogCollator implements DocumentCollator {
// (undocumented)
execute(): Promise<CatalogEntityDocument[]>;
// (undocumented)
protected filter?: CatalogEntitiesRequest['filter'];
protected filter?: GetEntitiesRequest['filter'];
// (undocumented)
static fromConfig(
_config: Config,
options: {
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
filter?: CatalogEntitiesRequest['filter'];
filter?: GetEntitiesRequest['filter'];
},
): DefaultCatalogCollator;
// (undocumented)
plugins/catalog-backend/src/search/DefaultCatalogCollator.ts
+4 -4
View File
@@ -28,7 +28,7 @@ import { Config } from '@backstage/config';
import {
CatalogApi,
CatalogClient,
CatalogEntitiesRequest,
GetEntitiesRequest,
} from '@backstage/catalog-client';
import { catalogEntityReadPermission } from '@backstage/plugin-catalog-common';
@@ -43,7 +43,7 @@ export interface CatalogEntityDocument extends IndexableDocument {
export class DefaultCatalogCollator implements DocumentCollator {
protected discovery: PluginEndpointDiscovery;
protected locationTemplate: string;
protected filter?: CatalogEntitiesRequest['filter'];
protected filter?: GetEntitiesRequest['filter'];
protected readonly catalogClient: CatalogApi;
public readonly type: string = 'software-catalog';
public readonly visibilityPermission = catalogEntityReadPermission;
@@ -54,7 +54,7 @@ export class DefaultCatalogCollator implements DocumentCollator {
options: {
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
filter?: CatalogEntitiesRequest['filter'];
filter?: GetEntitiesRequest['filter'];
},
) {
return new DefaultCatalogCollator({
@@ -66,7 +66,7 @@ export class DefaultCatalogCollator implements DocumentCollator {
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
locationTemplate?: string;
filter?: CatalogEntitiesRequest['filter'];
filter?: GetEntitiesRequest['filter'];
catalogClient?: CatalogApi;
}) {
const { discovery, locationTemplate, filter, catalogClient, tokenManager } =
plugins/catalog-graph/dev/index.tsx
+2 -2
View File
@@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { CatalogListResponse } from '@backstage/catalog-client';
import { GetEntitiesResponse } from '@backstage/catalog-client';
import {
Entity,
EntityName,
@@ -136,7 +136,7 @@ createDevApp()
async getEntityByName(name: EntityName): Promise<Entity | undefined> {
return entities[stringifyEntityRef(name)];
},
async getEntities(): Promise<CatalogListResponse<Entity>> {
async getEntities(): Promise<GetEntitiesResponse> {
return { items: Object.values(entities) };
},
} as Partial<CatalogApi> as unknown as CatalogApi;
plugins/catalog-react/api-report.md
+2 -2
View File
@@ -9,12 +9,12 @@ import { ApiRef } from '@backstage/core-plugin-api';
import { AsyncState } from 'react-use/lib/useAsync';
import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogListResponse } from '@backstage/catalog-client';
import { ComponentEntity } from '@backstage/catalog-model';
import { ComponentProps } from 'react';
import { Context } from 'react';
import { Entity } from '@backstage/catalog-model';
import { EntityName } from '@backstage/catalog-model';
import { GetEntitiesResponse } from '@backstage/catalog-client';
import { IconButton } from '@material-ui/core';
import { IdentityApi } from '@backstage/core-plugin-api';
import { LinkProps } from '@backstage/core-components';
@@ -612,7 +612,7 @@ export function useEntityTypeFilter(): EntityTypeReturn;
// @public
export function useOwnedEntities(allowedKinds?: string[]): {
loading: boolean;
ownedEntities: CatalogListResponse<Entity> | undefined;
ownedEntities: GetEntitiesResponse | undefined;
};
// Warning: (ae-missing-release-tag) "useOwnUser" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
plugins/catalog-react/src/hooks/useOwnedEntities.ts
+3 -4
View File
@@ -19,8 +19,8 @@ import {
loadIdentityOwnerRefs,
} from './useEntityOwnership';
import { identityApiRef, useApi } from '@backstage/core-plugin-api';
import { Entity, RELATION_OWNED_BY } from '@backstage/catalog-model';
import { CatalogListResponse } from '@backstage/catalog-client';
import { RELATION_OWNED_BY } from '@backstage/catalog-model';
import { GetEntitiesResponse } from '@backstage/catalog-client';
import useAsync from 'react-use/lib/useAsync';
import { useMemo } from 'react';
@@ -32,11 +32,10 @@ import { useMemo } from 'react';
* @public
*
* @param allowedKinds - Array of allowed kinds to filter the entities
* @returns CatalogListResponse<Entity>
*/
export function useOwnedEntities(allowedKinds?: string[]): {
loading: boolean;
ownedEntities: CatalogListResponse<Entity> | undefined;
ownedEntities: GetEntitiesResponse | undefined;
} {
const identityApi = useApi(identityApiRef);
const catalogApi = useApi(catalogApiRef);
plugins/catalog/api-report.md
+8 -8
View File
@@ -11,14 +11,14 @@ import { ApiHolder } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogClient } from '@backstage/catalog-client';
import { CatalogEntitiesRequest } from '@backstage/catalog-client';
import { CatalogEntityAncestorsRequest } from '@backstage/catalog-client';
import { CatalogEntityAncestorsResponse } from '@backstage/catalog-client';
import { CatalogListResponse } from '@backstage/catalog-client';
import { CatalogRequestOptions } from '@backstage/catalog-client';
import { Entity } from '@backstage/catalog-model';
import { EntityName } from '@backstage/catalog-model';
import { ExternalRouteRef } from '@backstage/core-plugin-api';
import { GetEntitiesRequest } from '@backstage/catalog-client';
import { GetEntitiesResponse } from '@backstage/catalog-client';
import { GetEntityAncestorsRequest } from '@backstage/catalog-client';
import { GetEntityAncestorsResponse } from '@backstage/catalog-client';
import { IconComponent } from '@backstage/core-plugin-api';
import { IdentityApi } from '@backstage/core-plugin-api';
import { InfoCardVariants } from '@backstage/core-components';
@@ -76,14 +76,14 @@ export class CatalogClientWrapper implements CatalogApi {
): Promise<AddLocationResponse>;
// (undocumented)
getEntities(
request?: CatalogEntitiesRequest,
request?: GetEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
): Promise<GetEntitiesResponse>;
// (undocumented)
getEntityAncestors(
request: CatalogEntityAncestorsRequest,
request: GetEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse>;
): Promise<GetEntityAncestorsResponse>;
// (undocumented)
getEntityByName(
compoundName: EntityName,
plugins/catalog/src/CatalogClientWrapper.ts
+8 -8
View File
@@ -20,11 +20,11 @@ import {
AddLocationResponse,
CatalogApi,
CatalogClient,
CatalogEntitiesRequest,
CatalogListResponse,
GetEntitiesRequest,
GetEntitiesResponse,
CatalogRequestOptions,
CatalogEntityAncestorsRequest,
CatalogEntityAncestorsResponse,
GetEntityAncestorsRequest,
GetEntityAncestorsResponse,
} from '@backstage/catalog-client';
import { IdentityApi } from '@backstage/core-plugin-api';
@@ -58,9 +58,9 @@ export class CatalogClientWrapper implements CatalogApi {
}
async getEntities(
request?: CatalogEntitiesRequest,
request?: GetEntitiesRequest,
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>> {
): Promise<GetEntitiesResponse> {
return await this.client.getEntities(
request,
await this.getCredentials(options),
@@ -138,9 +138,9 @@ export class CatalogClientWrapper implements CatalogApi {
}
async getEntityAncestors(
request: CatalogEntityAncestorsRequest,
request: GetEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse> {
): Promise<GetEntityAncestorsResponse> {
return await this.client.getEntityAncestors(
request,
await this.getCredentials(options),
plugins/org/src/components/Cards/OwnershipCard/OwnershipCard.test.tsx
+5 -5
View File
@@ -15,8 +15,8 @@
*/
import {
CatalogEntitiesRequest,
CatalogListResponse,
GetEntitiesRequest,
GetEntitiesResponse,
} from '@backstage/catalog-client';
import { Entity, GroupEntity, UserEntity } from '@backstage/catalog-model';
import {
@@ -110,15 +110,15 @@ const items = [
] as Entity[];
const getEntitiesMock = (
request?: CatalogEntitiesRequest,
): Promise<CatalogListResponse<Entity>> => {
request?: GetEntitiesRequest,
): Promise<GetEntitiesResponse> => {
const filterKinds =
!Array.isArray(request?.filter) && Array.isArray(request?.filter?.kind)
? request?.filter?.kind ?? []
: []; // we expect the request to be like { filter: { kind: ['API','System'], .... }. If changed in OwnerShipCard, let's change in also here
return Promise.resolve({
items: items.filter(item => filterKinds.find(k => k === item.kind)),
} as CatalogListResponse<Entity>);
} as GetEntitiesResponse);
};
describe('OwnershipCard', () => {
plugins/scaffolder/src/components/fields/EntityTagsPicker/EntityTagsPicker.tsx
+2 -2
View File
@@ -16,7 +16,7 @@
import React, { useState } from 'react';
import useAsync from 'react-use/lib/useAsync';
import useEffectOnce from 'react-use/lib/useEffectOnce';
import { CatalogEntitiesRequest } from '@backstage/catalog-client';
import { GetEntitiesRequest } from '@backstage/catalog-client';
import { Entity, makeValidator } from '@backstage/catalog-model';
import { useApi } from '@backstage/core-plugin-api';
import { catalogApiRef } from '@backstage/plugin-catalog-react';
@@ -40,7 +40,7 @@ export const EntityTagsPicker = ({
const kinds = uiSchema['ui:options']?.kinds as string[];
const { loading, value: existingTags } = useAsync(async () => {
const tagsRequest: CatalogEntitiesRequest = { fields: ['metadata.tags'] };
const tagsRequest: GetEntitiesRequest = { fields: ['metadata.tags'] };
if (kinds) {
tagsRequest.filter = { kind: kinds };
}
plugins/tech-insights-backend/src/service/fact/factRetrievers/entityMetadataFactRetriever.test.ts
+3 -3
View File
@@ -14,13 +14,13 @@
* limitations under the License.
*/
import { Entity, RELATION_OWNED_BY } from '@backstage/catalog-model';
import { RELATION_OWNED_BY } from '@backstage/catalog-model';
import {
PluginEndpointDiscovery,
getVoidLogger,
} from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { CatalogListResponse } from '@backstage/catalog-client';
import { GetEntitiesResponse } from '@backstage/catalog-client';
import { entityMetadataFactRetriever } from './entityMetadataFactRetriever';
const getEntitiesMock = jest.fn();
@@ -36,7 +36,7 @@ const discovery: jest.Mocked<PluginEndpointDiscovery> = {
getExternalBaseUrl: jest.fn(),
};
const defaultEntityListResponse: CatalogListResponse<Entity> = {
const defaultEntityListResponse: GetEntitiesResponse = {
items: [
{
apiVersion: 'backstage.io/v1beta1',
plugins/tech-insights-backend/src/service/fact/factRetrievers/entityOwnershipFactRetriever.test.ts
+3 -3
View File
@@ -15,13 +15,13 @@
*/
import { entityOwnershipFactRetriever } from './entityOwnershipFactRetriever';
import { Entity, RELATION_OWNED_BY } from '@backstage/catalog-model';
import { RELATION_OWNED_BY } from '@backstage/catalog-model';
import {
PluginEndpointDiscovery,
getVoidLogger,
} from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { CatalogListResponse } from '@backstage/catalog-client';
import { GetEntitiesResponse } from '@backstage/catalog-client';
const getEntitiesMock = jest.fn();
jest.mock('@backstage/catalog-client', () => {
@@ -36,7 +36,7 @@ const discovery: jest.Mocked<PluginEndpointDiscovery> = {
getExternalBaseUrl: jest.fn(),
};
const defaultEntityListResponse: CatalogListResponse<Entity> = {
const defaultEntityListResponse: GetEntitiesResponse = {
items: [
{
apiVersion: 'backstage.io/v1beta1',
plugins/tech-insights-backend/src/service/fact/factRetrievers/techdocsFactRetriever.test.ts
+3 -3
View File
@@ -15,13 +15,13 @@
*/
import { techdocsFactRetriever } from './techdocsFactRetriever';
import { Entity, RELATION_OWNED_BY } from '@backstage/catalog-model';
import { RELATION_OWNED_BY } from '@backstage/catalog-model';
import {
PluginEndpointDiscovery,
getVoidLogger,
} from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { CatalogListResponse } from '@backstage/catalog-client';
import { GetEntitiesResponse } from '@backstage/catalog-client';
const getEntitiesMock = jest.fn();
jest.mock('@backstage/catalog-client', () => {
@@ -36,7 +36,7 @@ const discovery: jest.Mocked<PluginEndpointDiscovery> = {
getExternalBaseUrl: jest.fn(),
};
const defaultEntityListResponse: CatalogListResponse<Entity> = {
const defaultEntityListResponse: GetEntitiesResponse = {
items: [
{
apiVersion: 'backstage.io/v1beta1',