diff --git a/packages/catalog-model/api-report.md b/packages/catalog-model/api-report.md index b7456bb2f8..1a58dcb5ca 100644 --- a/packages/catalog-model/api-report.md +++ b/packages/catalog-model/api-report.md @@ -257,11 +257,7 @@ interface GroupEntityV1alpha1 extends Entity { // (undocumented) spec: { type: string; - profile?: { - displayName?: string; - email?: string; - picture?: string; - }; + profile?: GroupProfile; parent?: string; children: string[]; members?: string[]; @@ -491,11 +487,7 @@ interface UserEntityV1alpha1 extends Entity { kind: 'User'; // (undocumented) spec: { - profile?: { - displayName?: string; - email?: string; - picture?: string; - }; + profile?: UserProfile; memberOf?: string[]; }; } @@ -517,4 +509,9 @@ export type Validators = { isValidAnnotationValue(value: unknown): boolean; isValidTag(value: unknown): boolean; }; + +// Warnings were encountered during analysis: +// +// src/kinds/GroupEntityV1alpha1.d.ts:23:9 - (ae-forgotten-export) The symbol "GroupProfile" needs to be exported by the entry point index.d.ts +// src/kinds/UserEntityV1alpha1.d.ts:22:9 - (ae-forgotten-export) The symbol "UserProfile" needs to be exported by the entry point index.d.ts ``` diff --git a/packages/catalog-model/src/kinds/GroupEntityV1alpha1.ts b/packages/catalog-model/src/kinds/GroupEntityV1alpha1.ts index 9e514b1000..51f5f30f04 100644 --- a/packages/catalog-model/src/kinds/GroupEntityV1alpha1.ts +++ b/packages/catalog-model/src/kinds/GroupEntityV1alpha1.ts @@ -18,13 +18,18 @@ import type { Entity } from '../entity/Entity'; import schema from '../schema/kinds/Group.v1alpha1.schema.json'; import { ajvCompiledJsonSchemaValidator } from './util'; -interface GroupProfileStatic { +export interface GroupProfileStatic { displayName?: string; email?: string; picture?: string; } -type GroupProfile = Record & GroupProfileStatic; +/** + * Backstage Group Profile. + * + * @public + */ +export type GroupProfile = Record & GroupProfileStatic; /** * Backstage catalog Group kind Entity. diff --git a/packages/catalog-model/src/kinds/UserEntityV1alpha1.ts b/packages/catalog-model/src/kinds/UserEntityV1alpha1.ts index 53446a5275..39d3861702 100644 --- a/packages/catalog-model/src/kinds/UserEntityV1alpha1.ts +++ b/packages/catalog-model/src/kinds/UserEntityV1alpha1.ts @@ -18,13 +18,17 @@ import type { Entity } from '../entity/Entity'; import schema from '../schema/kinds/User.v1alpha1.schema.json'; import { ajvCompiledJsonSchemaValidator } from './util'; -interface UserProfileStatic { +export interface UserProfileStatic { displayName?: string; email?: string; picture?: string; } - -type UserProfile = Record & UserProfileStatic; +/** + * Backstage User Profile. + * + * @public + */ +export type UserProfile = Record & UserProfileStatic; /** * Backstage catalog User kind Entity.