diff --git a/.changeset/scaffolder-export-form-fields-api.md b/.changeset/scaffolder-export-form-fields-api.md new file mode 100644 index 0000000000..02ead2d2b2 --- /dev/null +++ b/.changeset/scaffolder-export-form-fields-api.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder': patch +--- + +Added back the `formFieldsApiRef` and `ScaffolderFormFieldsApi` alpha exports that were unintentionally removed. diff --git a/.patches/pr-32969.txt b/.patches/pr-32969.txt new file mode 100644 index 0000000000..15dc342a21 --- /dev/null +++ b/.patches/pr-32969.txt @@ -0,0 +1 @@ +Add back `formFieldsApiRef` and `ScaffolderFormFieldsApi` alpha exports from `@backstage/plugin-scaffolder` diff --git a/plugins/scaffolder/report-alpha.api.md b/plugins/scaffolder/report-alpha.api.md index 943b139cb9..e553e706da 100644 --- a/plugins/scaffolder/report-alpha.api.md +++ b/plugins/scaffolder/report-alpha.api.md @@ -480,6 +480,9 @@ export const formDecoratorsApi: OverridableExtensionDefinition<{ // @alpha (undocumented) export const formDecoratorsApiRef: ApiRef; +// @alpha (undocumented) +export const formFieldsApiRef: ApiRef; + // @alpha @deprecated export type FormProps = Pick< FormProps_2, @@ -499,6 +502,12 @@ export interface ScaffolderFormDecoratorsApi { getFormDecorators(): Promise; } +// @alpha (undocumented) +export interface ScaffolderFormFieldsApi { + // (undocumented) + loadFormFields(): Promise; +} + // @public (undocumented) export type ScaffolderTemplateEditorClassKey = | 'root' diff --git a/plugins/scaffolder/src/alpha/formFieldsApi.ts b/plugins/scaffolder/src/alpha/formFieldsApi.ts index df88645eb4..bcc2190f7e 100644 --- a/plugins/scaffolder/src/alpha/formFieldsApi.ts +++ b/plugins/scaffolder/src/alpha/formFieldsApi.ts @@ -19,17 +19,18 @@ import { createApiRef, createExtensionInput, } from '@backstage/frontend-plugin-api'; -import { FormFieldBlueprint } from '@backstage/plugin-scaffolder-react/alpha'; +import { + FormFieldBlueprint, + type FormField, +} from '@backstage/plugin-scaffolder-react/alpha'; import { OpaqueFormField } from '@internal/scaffolder'; -interface FormField { - readonly $$type: '@backstage/scaffolder/FormField'; -} - -interface ScaffolderFormFieldsApi { +/** @alpha */ +export interface ScaffolderFormFieldsApi { loadFormFields(): Promise; } +/** @alpha */ const formFieldsApiRef = createApiRef({ id: 'plugin.scaffolder.form-fields-loader', }); diff --git a/plugins/scaffolder/src/alpha/index.ts b/plugins/scaffolder/src/alpha/index.ts index 53e2b8f0bf..a0b30fd3df 100644 --- a/plugins/scaffolder/src/alpha/index.ts +++ b/plugins/scaffolder/src/alpha/index.ts @@ -24,5 +24,9 @@ export { export { scaffolderTranslationRef } from '../translation'; export * from './api'; +export { + formFieldsApiRef, + type ScaffolderFormFieldsApi, +} from './formFieldsApi'; export { default } from './plugin';