From 0278da3d5cbaced675572a0c807dc42d0201b50d Mon Sep 17 00:00:00 2001 From: Peter Macdonald Date: Wed, 31 May 2023 08:44:07 +0200 Subject: [PATCH] api-report fixed? Signed-off-by: Peter Macdonald --- plugins/scaffolder/api-report.md | 18 +++++++++------- .../fields/OwnershipEntityRefPicker/index.ts | 1 + .../fields/OwnershipEntityRefPicker/schema.ts | 21 +++++++++++++++++++ plugins/scaffolder/src/plugin.tsx | 2 +- 4 files changed, 34 insertions(+), 8 deletions(-) diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index 0785ff0982..0472f019cc 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -301,15 +301,19 @@ export const OwnershipEntityRefPickerFieldExtension: FieldExtensionComponent_2< } >; -// Warning: (ae-missing-release-tag) "OwnershipEntityRefPickerSchema" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public +export const OwnershipEntityRefPickerFieldSchema: FieldSchema< + string, + { + title?: string | undefined; + description?: string | undefined; + } +>; + +// @public export const OwnershipEntityRefPickerSchema: CustomFieldExtensionSchema_2; -// Warning: (ae-forgotten-export) The symbol "OwnershipEntityRefPickerFieldSchema" needs to be exported by the entry point index.d.ts -// Warning: (ae-missing-release-tag) "OwnershipEntityRefPickerUiOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public export type OwnershipEntityRefPickerUiOptions = typeof OwnershipEntityRefPickerFieldSchema.uiOptionsType; diff --git a/plugins/scaffolder/src/components/fields/OwnershipEntityRefPicker/index.ts b/plugins/scaffolder/src/components/fields/OwnershipEntityRefPicker/index.ts index 2e744ef6e9..6237038511 100644 --- a/plugins/scaffolder/src/components/fields/OwnershipEntityRefPicker/index.ts +++ b/plugins/scaffolder/src/components/fields/OwnershipEntityRefPicker/index.ts @@ -17,4 +17,5 @@ export { OwnershipEntityRefPickerSchema, type OwnershipEntityRefPickerUiOptions, + OwnershipEntityRefPickerFieldSchema, } from './schema'; diff --git a/plugins/scaffolder/src/components/fields/OwnershipEntityRefPicker/schema.ts b/plugins/scaffolder/src/components/fields/OwnershipEntityRefPicker/schema.ts index bc138bc8f9..6d1f85b62a 100644 --- a/plugins/scaffolder/src/components/fields/OwnershipEntityRefPicker/schema.ts +++ b/plugins/scaffolder/src/components/fields/OwnershipEntityRefPicker/schema.ts @@ -17,6 +17,11 @@ import { z } from 'zod'; import { makeFieldSchemaFromZod } from '../utils'; +/** + * Field schema for the OwnershipEntityRefPicker. + * @public + */ + export const OwnershipEntityRefPickerFieldSchema = makeFieldSchemaFromZod( z.string(), z.object({ @@ -28,9 +33,25 @@ export const OwnershipEntityRefPickerFieldSchema = makeFieldSchemaFromZod( }), ); +/** + * UI options for the OwnershipEntityRefPicker. + * @public + */ + export type OwnershipEntityRefPickerUiOptions = typeof OwnershipEntityRefPickerFieldSchema.uiOptionsType; +/** + * Props for the OwnershipEntityRefPicker. + * @public + */ + export type OwnershipEntityRefPickerProps = typeof OwnershipEntityRefPickerFieldSchema.type; + +/** + * Schema for the OwnershipEntityRefPicker. + * @public + */ + export const OwnershipEntityRefPickerSchema = OwnershipEntityRefPickerFieldSchema.schema; diff --git a/plugins/scaffolder/src/plugin.tsx b/plugins/scaffolder/src/plugin.tsx index b190cf982a..0a261a7ff0 100644 --- a/plugins/scaffolder/src/plugin.tsx +++ b/plugins/scaffolder/src/plugin.tsx @@ -163,7 +163,7 @@ export const OwnerPickerFieldExtension = scaffolderPlugin.provide( ); /** - * A field extension for picking users and groups out of the Catalog. + * A field extension for picking groups a user belongs to out of the catalog. * * @public */