@backstage/plugin-scaffolder-react 1.18.0 → 1.19.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @backstage/plugin-scaffolder-react
 
+## 1.19.0-next.1
+
+### Minor Changes
+
+- 4f99e10: **DEPRECATION**: The following types have been deprecated from this package and moved into `@backstage/plugin-scaffolder-common` and should be imported from there instead.
+
+  `Action`, `ListActionsResponse`, `LogEvent`, `ScaffolderApi`, `ScaffolderDryRunOptions`, `ScaffolderDryRunResponse`, `ScaffolderGetIntegrationsListOptions`, `ScaffolderGetIntegrationsListResponse`,
+  `ScaffolderOutputLink`, `ScaffolderOutputText`, `ScaffolderScaffoldOptions`, `ScaffolderScaffoldResponse`, `ScaffolderStreamLogsOptions`, `ScaffolderTask`, `ScaffolderTaskOutput`, `ScaffolderTaskStatus`,
+  `ScaffolderUsageExample`, `TemplateFilter`, `TemplateGlobalFunction`, `TemplateGlobalValue`, `TemplateParameterSchema`.
+
+- c08cbc4: Move Scaffolder API to OpenAPI
+
+### Patch Changes
+
+- f2f133c: Internal update to use the new variant of `ApiBlueprint`.
+- c4b7c50: Export `FormField` type from `/alpha` in `-react` package, and internal refactor.
+- Updated dependencies
+  - @backstage/plugin-scaffolder-common@1.7.0-next.0
+  - @backstage/plugin-catalog-react@1.20.0-next.1
+  - @backstage/frontend-plugin-api@0.11.0-next.0
+  - @backstage/theme@0.6.8-next.0
+  - @backstage/catalog-client@1.11.0-next.0
+  - @backstage/core-components@0.17.5-next.0
+  - @backstage/catalog-model@1.7.5
+  - @backstage/core-plugin-api@1.10.9
+  - @backstage/types@1.2.1
+  - @backstage/version-bridge@1.0.11
+  - @backstage/plugin-permission-react@0.4.36
+
+## 1.18.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.19.2-next.0
+  - @backstage/frontend-plugin-api@0.10.4
+
 ## 1.18.0
 
 ### Minor Changes

package/dist/alpha.d.ts

@@ -12,47 +12,6 @@ import { Overrides } from '@material-ui/core/styles/overrides';
 import { StyleRules } from '@material-ui/core/styles/withStyles';
 import * as _backstage_core_plugin_api_alpha from '@backstage/core-plugin-api/alpha';
 
-/*
- * Copyright 2024 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.
- */
-
-
-
-/** @alpha */
-interface FormField {
-  readonly $$type: '@backstage/scaffolder/FormField';
-}
-
-/** @alpha */
-declare const formFieldsApi: _backstage_frontend_plugin_api.ExtensionDefinition<{
-    config: {};
-    configInput: {};
-    output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
-    inputs: {
-        formFields: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<() => Promise<FormField>, "scaffolder.form-field-loader", {}>, {
-            singleton: false;
-            optional: false;
-        }>;
-    };
-    kind: "api";
-    name: "form-fields";
-    params: {
-        factory: _backstage_frontend_plugin_api.AnyApiFactory;
-    };
-}>;
-
 /** @alpha */
 type ScaffolderFormDecoratorContext<TInput extends JsonObject = JsonObject> = {
     input: TInput;
@@ -152,6 +111,26 @@ declare function createFormField<TReturnValue extends z.ZodType, TUiOptions exte
 interface ScaffolderFormFieldsApi {
     getFormFields(): Promise<FormFieldExtensionData[]>;
 }
+/** @alpha */
+interface FormField {
+    readonly $$type: '@backstage/scaffolder/FormField';
+}
+
+/** @alpha */
+declare const formFieldsApi: _backstage_frontend_plugin_api.ExtensionDefinition<{
+    config: {};
+    configInput: {};
+    output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
+    inputs: {
+        formFields: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<() => Promise<FormField>, "scaffolder.form-field-loader", {}>, {
+            singleton: false;
+            optional: false;
+        }>;
+    };
+    kind: "api";
+    name: "form-fields";
+    params: <TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown; }>(params: _backstage_frontend_plugin_api.ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<_backstage_frontend_plugin_api.AnyApiFactory>;
+}>;
 
 /**
  * @alpha
@@ -490,4 +469,4 @@ declare const scaffolderReactTranslationRef: _backstage_core_plugin_api_alpha.Tr
     readonly "templateOutputs.title": "Text Output";
 }>;
 
-export { type BackstageOverrides, type BackstageTemplateStepperClassKey, DefaultTemplateOutputs, EmbeddableWorkflow, Form, FormDecoratorBlueprint, FormFieldBlueprint, type FormFieldExtensionData, type FormValidation, type ParsedTemplateSchema, ReviewState, type ReviewStateProps, ScaffolderField, type ScaffolderFieldProps, type ScaffolderFormDecorator, type ScaffolderFormDecoratorContext, type ScaffolderFormFieldsApi, ScaffolderPageContextMenu, type ScaffolderPageContextMenuProps, type ScaffolderReactComponentsNameToClassKey, type ScaffolderReactTemplateCategoryPickerClassKey, SecretWidget, Stepper, type StepperProps, TaskLogStream, TaskSteps, type TaskStepsProps, TemplateCard, type TemplateCardProps, TemplateCategoryPicker, TemplateGroup, type TemplateGroupProps, TemplateGroups, type TemplateGroupsProps, Workflow, type WorkflowProps, createAsyncValidators, createFieldValidation, createFormField, createScaffolderFormDecorator, extractSchemaFromStep, formFieldsApi, formFieldsApiRef, scaffolderReactTranslationRef, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };
+export { type BackstageOverrides, type BackstageTemplateStepperClassKey, DefaultTemplateOutputs, EmbeddableWorkflow, Form, FormDecoratorBlueprint, type FormField, FormFieldBlueprint, type FormFieldExtensionData, type FormValidation, type ParsedTemplateSchema, ReviewState, type ReviewStateProps, ScaffolderField, type ScaffolderFieldProps, type ScaffolderFormDecorator, type ScaffolderFormDecoratorContext, type ScaffolderFormFieldsApi, ScaffolderPageContextMenu, type ScaffolderPageContextMenuProps, type ScaffolderReactComponentsNameToClassKey, type ScaffolderReactTemplateCategoryPickerClassKey, SecretWidget, Stepper, type StepperProps, TaskLogStream, TaskSteps, type TaskStepsProps, TemplateCard, type TemplateCardProps, TemplateCategoryPicker, TemplateGroup, type TemplateGroupProps, TemplateGroups, type TemplateGroupsProps, Workflow, type WorkflowProps, createAsyncValidators, createFieldValidation, createFormField, createScaffolderFormDecorator, extractSchemaFromStep, formFieldsApi, formFieldsApiRef, scaffolderReactTranslationRef, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 import { ApiHolder, Extension } from '@backstage/core-plugin-api';
 import { HTMLAttributes, ReactNode, FormEvent, ElementType, Ref, ComponentType, PropsWithChildren } from 'react';
-import { JsonObject, JsonValue, Observable } from '@backstage/types';
+import { JsonObject } from '@backstage/types';
 import { JSONSchema7 } from 'json-schema';
 import { StrictRJSFSchema, RJSFSchema, FormContextType, GenericObjectType, UiSchema, IdSchema, ErrorSchema, Registry, ValidatorType, TemplatesType, RegistryWidgetsType, RJSFValidationError, CustomValidator, ErrorTransformer, Experimental_DefaultFormStateBehavior, UIOptionsType, FieldValidation } from '@rjsf/utils';
 import Form, { IChangeEvent, FormProps as FormProps$1 } from '@rjsf/core';
-import { TemplateEntityV1beta3, TemplatePresentationV1beta3, TaskSpec, TaskStep } from '@backstage/plugin-scaffolder-common';
+import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
+import { TemplateEntityV1beta3, TemplateParameterSchema as TemplateParameterSchema$1, ScaffolderTaskStatus as ScaffolderTaskStatus$1, ScaffolderTask as ScaffolderTask$1, ScaffolderUsageExample as ScaffolderUsageExample$1, Action as Action$1, ListActionsResponse as ListActionsResponse$1, TemplateFilter as TemplateFilter$1, TemplateGlobalFunction as TemplateGlobalFunction$1, TemplateGlobalValue as TemplateGlobalValue$1, ListTemplatingExtensionsResponse as ListTemplatingExtensionsResponse$1, ScaffolderOutputLink as ScaffolderOutputLink$1, ScaffolderOutputText as ScaffolderOutputText$1, ScaffolderTaskOutput as ScaffolderTaskOutput$1, LogEvent as LogEvent$1, ScaffolderScaffoldOptions as ScaffolderScaffoldOptions$1, ScaffolderScaffoldResponse as ScaffolderScaffoldResponse$1, ScaffolderGetIntegrationsListOptions as ScaffolderGetIntegrationsListOptions$1, ScaffolderGetIntegrationsListResponse as ScaffolderGetIntegrationsListResponse$1, ScaffolderStreamLogsOptions as ScaffolderStreamLogsOptions$1, ScaffolderDryRunOptions as ScaffolderDryRunOptions$1, ScaffolderDryRunResponse as ScaffolderDryRunResponse$1, ScaffolderApi as ScaffolderApi$1 } from '@backstage/plugin-scaffolder-common';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
 import { z } from 'zod';
@@ -338,21 +339,9 @@ type ReviewStepProps = {
  * as a separate step in the wizard input
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#TemplateParameterSchema} instead as this has now been moved.
  */
-type TemplateParameterSchema = {
-    title: string;
-    description?: string;
-    presentation?: TemplatePresentationV1beta3;
-    steps: Array<{
-        title: string;
-        description?: string;
-        schema: JsonObject;
-    }>;
-    EXPERIMENTAL_formDecorators?: {
-        id: string;
-        input?: JsonObject;
-    }[];
-};
+type TemplateParameterSchema = TemplateParameterSchema$1;
 
 /**
  * The Context Provider that holds the state for the secrets.
@@ -376,34 +365,30 @@ interface ScaffolderUseTemplateSecrets {
  */
 declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
 
+/** @public */
+declare const scaffolderApiRef: _backstage_frontend_plugin_api.ApiRef<_backstage_plugin_scaffolder_common.ScaffolderApi>;
+
 /**
  * The status of each task in a Scaffolder Job
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderTaskStatus} instead as this has now been moved.
  */
-type ScaffolderTaskStatus = 'cancelled' | 'completed' | 'failed' | 'open' | 'processing' | 'skipped';
+type ScaffolderTaskStatus = ScaffolderTaskStatus$1;
 /**
  * The shape of each task returned from the `scaffolder-backend`
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderTask} instead as this has now been moved.
  */
-type ScaffolderTask = {
-    id: string;
-    spec: TaskSpec;
-    status: 'failed' | 'completed' | 'processing' | 'open' | 'cancelled';
-    lastHeartbeatAt: string;
-    createdAt: string;
-};
+type ScaffolderTask = ScaffolderTask$1;
 /**
  * A single scaffolder usage example
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderUsageExample} instead as this has now been moved.
  */
-type ScaffolderUsageExample = {
-    description?: string;
-    example: string;
-    notes?: string;
-};
+type ScaffolderUsageExample = ScaffolderUsageExample$1;
 /**
  * A single action example
  *
@@ -415,237 +400,118 @@ type ActionExample = ScaffolderUsageExample;
  * The response shape for a single action in the `listActions` call to the `scaffolder-backend`
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#Action} instead as this has now been moved.
  */
-type Action = {
-    id: string;
-    description?: string;
-    schema?: {
-        input?: JSONSchema7;
-        output?: JSONSchema7;
-    };
-    examples?: ActionExample[];
-};
+type Action = Action$1;
 /**
  * The response shape for the `listActions` call to the `scaffolder-backend`
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ListActionsResponse} instead as this has now been moved.
  */
-type ListActionsResponse = Array<Action>;
+type ListActionsResponse = ListActionsResponse$1;
 /**
  * The response shape for a single filter in the `listTemplatingExtensions` call to the `scaffolder-backend`
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#TemplateFilter} instead as this has now been moved.
  */
-type TemplateFilter = {
-    description?: string;
-    schema?: {
-        input?: JSONSchema7;
-        arguments?: JSONSchema7[];
-        output?: JSONSchema7;
-    };
-    examples?: ScaffolderUsageExample[];
-};
+type TemplateFilter = TemplateFilter$1;
 /**
  * The response shape for a single global function in the `listTemplatingExtensions` call to the `scaffolder-backend`
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#TemplateGlobalFunction} instead as this has now been moved.
  */
-type TemplateGlobalFunction = {
-    description?: string;
-    schema?: {
-        arguments?: JSONSchema7[];
-        output?: JSONSchema7;
-    };
-    examples?: ScaffolderUsageExample[];
-};
+type TemplateGlobalFunction = TemplateGlobalFunction$1;
 /**
  * The response shape for a single global value in the `listTemplatingExtensions` call to the `scaffolder-backend`
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#TemplateGlobalValue} instead as this has now been moved.
  */
-type TemplateGlobalValue = {
-    description?: string;
-    value: JsonValue;
-};
+type TemplateGlobalValue = TemplateGlobalValue$1;
 /**
  * The response shape for the `listTemplatingExtensions` call to the `scaffolder-backend`
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ListTemplatingExtensionsResponse} instead as this has now been moved.
  */
-type ListTemplatingExtensionsResponse = {
-    filters: Record<string, TemplateFilter>;
-    globals: {
-        functions: Record<string, TemplateGlobalFunction>;
-        values: Record<string, TemplateGlobalValue>;
-    };
-};
-/** @public */
-type ScaffolderOutputLink = {
-    title?: string;
-    icon?: string;
-    url?: string;
-    entityRef?: string;
-};
-/** @public */
-type ScaffolderOutputText = {
-    title?: string;
-    icon?: string;
-    content?: string;
-    default?: boolean;
-};
-/** @public */
-type ScaffolderTaskOutput = {
-    links?: ScaffolderOutputLink[];
-    text?: ScaffolderOutputText[];
-} & {
-    [key: string]: unknown;
-};
+type ListTemplatingExtensionsResponse = ListTemplatingExtensionsResponse$1;
+/**
+ * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderOutputLink} instead as this has now been moved.
+ */
+type ScaffolderOutputLink = ScaffolderOutputLink$1;
+/**
+ * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderOutputText} instead as this has now been moved.
+ */
+type ScaffolderOutputText = ScaffolderOutputText$1;
+/**
+ * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderTaskOutput} instead as this has now been moved.
+ */
+type ScaffolderTaskOutput = ScaffolderTaskOutput$1;
 /**
  * The shape of a `LogEvent` message from the `scaffolder-backend`
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#LogEvent} instead as this has now been moved.
  */
-type LogEvent = {
-    type: 'log' | 'completion' | 'cancelled' | 'recovered';
-    body: {
-        message: string;
-        stepId?: string;
-        status?: ScaffolderTaskStatus;
-    };
-    createdAt: string;
-    id: string;
-    taskId: string;
-};
+type LogEvent = LogEvent$1;
 /**
  * The input options to the `scaffold` method of the `ScaffolderClient`.
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderScaffoldOptions} instead as this has now been moved.
  */
-interface ScaffolderScaffoldOptions {
-    templateRef: string;
-    values: Record<string, JsonValue>;
-    secrets?: Record<string, string>;
-}
+type ScaffolderScaffoldOptions = ScaffolderScaffoldOptions$1;
 /**
  * The response shape of the `scaffold` method of the `ScaffolderClient`.
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderScaffoldResponse} instead as this has now been moved.
  */
-interface ScaffolderScaffoldResponse {
-    taskId: string;
-}
+type ScaffolderScaffoldResponse = ScaffolderScaffoldResponse$1;
 /**
  * The arguments for `getIntegrationsList`.
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderGetIntegrationsListOptions} instead as this has now been moved.
  */
-interface ScaffolderGetIntegrationsListOptions {
-    allowedHosts: string[];
-}
+type ScaffolderGetIntegrationsListOptions = ScaffolderGetIntegrationsListOptions$1;
 /**
  * The response shape for `getIntegrationsList`.
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderGetIntegrationsListResponse} instead as this has now been moved.
  */
-interface ScaffolderGetIntegrationsListResponse {
-    integrations: {
-        type: string;
-        title: string;
-        host: string;
-    }[];
-}
+type ScaffolderGetIntegrationsListResponse = ScaffolderGetIntegrationsListResponse$1;
 /**
  * The input options to the `streamLogs` method of the `ScaffolderClient`.
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderStreamLogsOptions} instead as this has now been moved.
  */
-interface ScaffolderStreamLogsOptions {
-    isTaskRecoverable?: boolean;
-    taskId: string;
-    after?: number;
-}
-/** @public */
-interface ScaffolderDryRunOptions {
-    template: JsonValue;
-    values: JsonObject;
-    secrets?: Record<string, string>;
-    directoryContents: {
-        path: string;
-        base64Content: string;
-    }[];
-}
-/** @public */
-interface ScaffolderDryRunResponse {
-    directoryContents: Array<{
-        path: string;
-        base64Content: string;
-        executable: boolean;
-    }>;
-    log: Array<Pick<LogEvent, 'body'>>;
-    steps: TaskStep[];
-    output: ScaffolderTaskOutput;
-}
+type ScaffolderStreamLogsOptions = ScaffolderStreamLogsOptions$1;
+/**
+ * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderDryRunOptions} instead as this has now been moved.
+ */
+type ScaffolderDryRunOptions = ScaffolderDryRunOptions$1;
+/**
+ * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderDryRunResponse} instead as this has now been moved.
+ */
+type ScaffolderDryRunResponse = ScaffolderDryRunResponse$1;
 /**
  * An API to interact with the scaffolder backend.
  *
  * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-common#ScaffolderApi} instead as this has now been moved.
  */
-interface ScaffolderApi {
-    getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema>;
-    /**
-     * Executes the scaffolding of a component, given a template and its
-     * parameter values.
-     *
-     * @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
-     */
-    scaffold(options: ScaffolderScaffoldOptions): Promise<ScaffolderScaffoldResponse>;
-    getTask(taskId: string): Promise<ScaffolderTask>;
-    /**
-     * Sends a signal to a task broker to cancel the running task by taskId.
-     *
-     * @param taskId - the id of the task
-     */
-    cancelTask(taskId: string): Promise<void>;
-    /**
-     * Starts the task again from the point where it failed.
-     *
-     * @param taskId - the id of the task
-     */
-    retry?(taskId: string): Promise<void>;
-    listTasks?(options: {
-        filterByOwnership: 'owned' | 'all';
-        limit?: number;
-        offset?: number;
-    }): Promise<{
-        tasks: ScaffolderTask[];
-        totalTasks?: number;
-    }>;
-    getIntegrationsList(options: ScaffolderGetIntegrationsListOptions): Promise<ScaffolderGetIntegrationsListResponse>;
-    /**
-     * Returns a list of all installed actions.
-     */
-    listActions(): Promise<ListActionsResponse>;
-    /**
-     * Returns a structure describing the available templating extensions.
-     */
-    listTemplatingExtensions?(): Promise<ListTemplatingExtensionsResponse>;
-    streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
-    dryRun?(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
-    autocomplete?(options: {
-        token: string;
-        provider: string;
-        resource: string;
-        context?: Record<string, string>;
-    }): Promise<{
-        results: {
-            title?: string;
-            id: string;
-        }[];
-    }>;
-}
-
-/** @public */
-declare const scaffolderApiRef: _backstage_frontend_plugin_api.ApiRef<ScaffolderApi>;
+type ScaffolderApi = ScaffolderApi$1;
 
 /**
  * Hook that returns all custom field extensions from the current outlet.

package/dist/next/api/FormFieldsApi.esm.js

@@ -1,4 +1,4 @@
-import { ApiBlueprint, createExtensionInput, createApiFactory } from '@backstage/frontend-plugin-api';
+import { ApiBlueprint, createExtensionInput } from '@backstage/frontend-plugin-api';
 import { formFieldsApiRef } from './ref.esm.js';
 import '../blueprints/FormDecoratorBlueprint.esm.js';
 import { FormFieldBlueprint } from '../blueprints/FormFieldBlueprint.esm.js';
@@ -27,13 +27,13 @@ const formFieldsApi = ApiBlueprint.makeWithOverrides({
     const formFieldLoaders = inputs.formFields.map(
       (e) => e.get(FormFieldBlueprint.dataRefs.formFieldLoader)
     );
-    return originalFactory({
-      factory: createApiFactory({
+    return originalFactory(
+      (define) => define({
         api: formFieldsApiRef,
         deps: {},
         factory: () => new DefaultScaffolderFormFieldsApi(formFieldLoaders)
       })
-    });
+    );
   }
 });
 

package/dist/next/api/FormFieldsApi.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormFieldsApi.esm.js","sources":["../../../src/next/api/FormFieldsApi.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  ApiBlueprint,\n  createApiFactory,\n  createExtensionInput,\n} from '@backstage/frontend-plugin-api';\nimport { formFieldsApiRef } from './ref';\nimport { ScaffolderFormFieldsApi } from './types';\nimport { FormFieldBlueprint } from '../blueprints';\nimport { FormField, OpaqueFormField } from '@internal/scaffolder';\n\nclass DefaultScaffolderFormFieldsApi implements ScaffolderFormFieldsApi {\n  constructor(\n    private readonly formFieldLoaders: Array<() => Promise<FormField>> = [],\n  ) {}\n\n  async getFormFields() {\n    const formFields = await Promise.all(\n      this.formFieldLoaders.map(loader => loader()),\n    );\n\n    const internalFormFields = formFields.map(OpaqueFormField.toInternal);\n\n    return internalFormFields;\n  }\n}\n\n/** @alpha */\nexport const formFieldsApi = ApiBlueprint.makeWithOverrides({\n  name: 'form-fields',\n  inputs: {\n    formFields: createExtensionInput([\n      FormFieldBlueprint.dataRefs.formFieldLoader,\n    ]),\n  },\n  factory(originalFactory, { inputs }) {\n    const formFieldLoaders = inputs.formFields.map(e =>\n      e.get(FormFieldBlueprint.dataRefs.formFieldLoader),\n    );\n\n    return originalFactory({\n      factory: createApiFactory({\n        api: formFieldsApiRef,\n        deps: {},\n        factory: () => new DefaultScaffolderFormFieldsApi(formFieldLoaders),\n      }),\n    });\n  },\n});\n"],"names":[],"mappings":";;;;;;AA0BA,MAAM,8BAAkE,CAAA;AAAA,EACtE,WAAA,CACmB,gBAAoD,GAAA,EACrE,EAAA;AADiB,IAAA,IAAA,CAAA,gBAAA,GAAA,gBAAA;AAAA;AAChB,EAEH,MAAM,aAAgB,GAAA;AACpB,IAAM,MAAA,UAAA,GAAa,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC/B,IAAK,CAAA,gBAAA,CAAiB,GAAI,CAAA,CAAA,MAAA,KAAU,QAAQ;AAAA,KAC9C;AAEA,IAAA,MAAM,kBAAqB,GAAA,UAAA,CAAW,GAAI,CAAA,eAAA,CAAgB,UAAU,CAAA;AAEpE,IAAO,OAAA,kBAAA;AAAA;AAEX;AAGa,MAAA,aAAA,GAAgB,aAAa,iBAAkB,CAAA;AAAA,EAC1D,IAAM,EAAA,aAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,YAAY,oBAAqB,CAAA;AAAA,MAC/B,mBAAmB,QAAS,CAAA;AAAA,KAC7B;AAAA,GACH;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAU,EAAA;AACnC,IAAM,MAAA,gBAAA,GAAmB,OAAO,UAAW,CAAA,GAAA;AAAA,MAAI,CAC7C,CAAA,KAAA,CAAA,CAAE,GAAI,CAAA,kBAAA,CAAmB,SAAS,eAAe;AAAA,KACnD;AAEA,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,SAAS,gBAAiB,CAAA;AAAA,QACxB,GAAK,EAAA,gBAAA;AAAA,QACL,MAAM,EAAC;AAAA,QACP,OAAS,EAAA,MAAM,IAAI,8BAAA,CAA+B,gBAAgB;AAAA,OACnE;AAAA,KACF,CAAA;AAAA;AAEL,CAAC;;;;"}
+{"version":3,"file":"FormFieldsApi.esm.js","sources":["../../../src/next/api/FormFieldsApi.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  ApiBlueprint,\n  createExtensionInput,\n} from '@backstage/frontend-plugin-api';\nimport { formFieldsApiRef } from './ref';\nimport { FormField, ScaffolderFormFieldsApi } from './types';\nimport { FormFieldBlueprint } from '../blueprints';\nimport { OpaqueFormField } from '@internal/scaffolder';\n\nclass DefaultScaffolderFormFieldsApi implements ScaffolderFormFieldsApi {\n  constructor(\n    private readonly formFieldLoaders: Array<() => Promise<FormField>> = [],\n  ) {}\n\n  async getFormFields() {\n    const formFields = await Promise.all(\n      this.formFieldLoaders.map(loader => loader()),\n    );\n\n    const internalFormFields = formFields.map(OpaqueFormField.toInternal);\n\n    return internalFormFields;\n  }\n}\n\n/** @alpha */\nexport const formFieldsApi = ApiBlueprint.makeWithOverrides({\n  name: 'form-fields',\n  inputs: {\n    formFields: createExtensionInput([\n      FormFieldBlueprint.dataRefs.formFieldLoader,\n    ]),\n  },\n  factory(originalFactory, { inputs }) {\n    const formFieldLoaders = inputs.formFields.map(e =>\n      e.get(FormFieldBlueprint.dataRefs.formFieldLoader),\n    );\n\n    return originalFactory(define =>\n      define({\n        api: formFieldsApiRef,\n        deps: {},\n        factory: () => new DefaultScaffolderFormFieldsApi(formFieldLoaders),\n      }),\n    );\n  },\n});\n"],"names":[],"mappings":";;;;;;AAyBA,MAAM,8BAAkE,CAAA;AAAA,EACtE,WAAA,CACmB,gBAAoD,GAAA,EACrE,EAAA;AADiB,IAAA,IAAA,CAAA,gBAAA,GAAA,gBAAA;AAAA;AAChB,EAEH,MAAM,aAAgB,GAAA;AACpB,IAAM,MAAA,UAAA,GAAa,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC/B,IAAK,CAAA,gBAAA,CAAiB,GAAI,CAAA,CAAA,MAAA,KAAU,QAAQ;AAAA,KAC9C;AAEA,IAAA,MAAM,kBAAqB,GAAA,UAAA,CAAW,GAAI,CAAA,eAAA,CAAgB,UAAU,CAAA;AAEpE,IAAO,OAAA,kBAAA;AAAA;AAEX;AAGa,MAAA,aAAA,GAAgB,aAAa,iBAAkB,CAAA;AAAA,EAC1D,IAAM,EAAA,aAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,YAAY,oBAAqB,CAAA;AAAA,MAC/B,mBAAmB,QAAS,CAAA;AAAA,KAC7B;AAAA,GACH;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAU,EAAA;AACnC,IAAM,MAAA,gBAAA,GAAmB,OAAO,UAAW,CAAA,GAAA;AAAA,MAAI,CAC7C,CAAA,KAAA,CAAA,CAAE,GAAI,CAAA,kBAAA,CAAmB,SAAS,eAAe;AAAA,KACnD;AAEA,IAAO,OAAA,eAAA;AAAA,MAAgB,YACrB,MAAO,CAAA;AAAA,QACL,GAAK,EAAA,gBAAA;AAAA,QACL,MAAM,EAAC;AAAA,QACP,OAAS,EAAA,MAAM,IAAI,8BAAA,CAA+B,gBAAgB;AAAA,OACnE;AAAA,KACH;AAAA;AAEJ,CAAC;;;;"}

package/dist/next/blueprints/FormFieldBlueprint.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormFieldBlueprint.esm.js","sources":["../../../src/next/blueprints/FormFieldBlueprint.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  createExtensionBlueprint,\n  createExtensionDataRef,\n} from '@backstage/frontend-plugin-api';\nimport { z } from 'zod';\n\nimport { OpaqueFormField, FormField } from '@internal/scaffolder';\nimport { FormFieldExtensionData } from './types';\n\nconst formFieldExtensionDataRef = createExtensionDataRef<\n  () => Promise<FormField>\n>().with({\n  id: 'scaffolder.form-field-loader',\n});\n\n/**\n * @alpha\n * Creates extensions that are Field Extensions for the Scaffolder\n * */\nexport const FormFieldBlueprint = createExtensionBlueprint({\n  kind: 'scaffolder-form-field',\n  attachTo: [\n    { id: 'page:scaffolder', input: 'formFields' },\n    { id: 'api:scaffolder/form-fields', input: 'formFields' },\n  ],\n  dataRefs: {\n    formFieldLoader: formFieldExtensionDataRef,\n  },\n  output: [formFieldExtensionDataRef],\n  *factory(params: { field: () => Promise<FormField> }) {\n    yield formFieldExtensionDataRef(params.field);\n  },\n});\n\n/**\n * @alpha\n * Used to create a form field binding with typechecking for compliance\n */\nexport function createFormField<\n  TReturnValue extends z.ZodType,\n  TUiOptions extends z.ZodType,\n>(opts: FormFieldExtensionData<TReturnValue, TUiOptions>): FormField {\n  return OpaqueFormField.createInstance('v1', opts);\n}\n"],"names":[],"mappings":";;;;AAwBA,MAAM,yBAAA,GAA4B,sBAEhC,EAAA,CAAE,IAAK,CAAA;AAAA,EACP,EAAI,EAAA;AACN,CAAC,CAAA;AAMM,MAAM,qBAAqB,wBAAyB,CAAA;AAAA,EACzD,IAAM,EAAA,uBAAA;AAAA,EACN,QAAU,EAAA;AAAA,IACR,EAAE,EAAA,EAAI,iBAAmB,EAAA,KAAA,EAAO,YAAa,EAAA;AAAA,IAC7C,EAAE,EAAA,EAAI,4BAA8B,EAAA,KAAA,EAAO,YAAa;AAAA,GAC1D;AAAA,EACA,QAAU,EAAA;AAAA,IACR,eAAiB,EAAA;AAAA,GACnB;AAAA,EACA,MAAA,EAAQ,CAAC,yBAAyB,CAAA;AAAA,EAClC,CAAC,QAAQ,MAA6C,EAAA;AACpD,IAAM,MAAA,yBAAA,CAA0B,OAAO,KAAK,CAAA;AAAA;AAEhD,CAAC;AAMM,SAAS,gBAGd,IAAmE,EAAA;AACnE,EAAO,OAAA,eAAA,CAAgB,cAAe,CAAA,IAAA,EAAM,IAAI,CAAA;AAClD;;;;"}
+{"version":3,"file":"FormFieldBlueprint.esm.js","sources":["../../../src/next/blueprints/FormFieldBlueprint.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  createExtensionBlueprint,\n  createExtensionDataRef,\n} from '@backstage/frontend-plugin-api';\nimport { z } from 'zod';\n\nimport { OpaqueFormField } from '@internal/scaffolder';\nimport { FormFieldExtensionData } from './types';\nimport { FormField } from '../api';\n\nconst formFieldExtensionDataRef = createExtensionDataRef<\n  () => Promise<FormField>\n>().with({\n  id: 'scaffolder.form-field-loader',\n});\n\n/**\n * @alpha\n * Creates extensions that are Field Extensions for the Scaffolder\n * */\nexport const FormFieldBlueprint = createExtensionBlueprint({\n  kind: 'scaffolder-form-field',\n  attachTo: [\n    { id: 'page:scaffolder', input: 'formFields' },\n    { id: 'api:scaffolder/form-fields', input: 'formFields' },\n  ],\n  dataRefs: {\n    formFieldLoader: formFieldExtensionDataRef,\n  },\n  output: [formFieldExtensionDataRef],\n  *factory(params: { field: () => Promise<FormField> }) {\n    yield formFieldExtensionDataRef(params.field);\n  },\n});\n\n/**\n * @alpha\n * Used to create a form field binding with typechecking for compliance\n */\nexport function createFormField<\n  TReturnValue extends z.ZodType,\n  TUiOptions extends z.ZodType,\n>(opts: FormFieldExtensionData<TReturnValue, TUiOptions>): FormField {\n  return OpaqueFormField.createInstance('v1', opts);\n}\n"],"names":[],"mappings":";;;;AAyBA,MAAM,yBAAA,GAA4B,sBAEhC,EAAA,CAAE,IAAK,CAAA;AAAA,EACP,EAAI,EAAA;AACN,CAAC,CAAA;AAMM,MAAM,qBAAqB,wBAAyB,CAAA;AAAA,EACzD,IAAM,EAAA,uBAAA;AAAA,EACN,QAAU,EAAA;AAAA,IACR,EAAE,EAAA,EAAI,iBAAmB,EAAA,KAAA,EAAO,YAAa,EAAA;AAAA,IAC7C,EAAE,EAAA,EAAI,4BAA8B,EAAA,KAAA,EAAO,YAAa;AAAA,GAC1D;AAAA,EACA,QAAU,EAAA;AAAA,IACR,eAAiB,EAAA;AAAA,GACnB;AAAA,EACA,MAAA,EAAQ,CAAC,yBAAyB,CAAA;AAAA,EAClC,CAAC,QAAQ,MAA6C,EAAA;AACpD,IAAM,MAAA,yBAAA,CAA0B,OAAO,KAAK,CAAA;AAAA;AAEhD,CAAC;AAMM,SAAS,gBAGd,IAAmE,EAAA;AACnE,EAAO,OAAA,eAAA,CAAgB,cAAe,CAAA,IAAA,EAAM,IAAI,CAAA;AAClD;;;;"}

package/dist/packages/scaffolder-internal/src/wiring/InternalFormField.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"InternalFormField.esm.js","sources":["../../../../../../../packages/scaffolder-internal/src/wiring/InternalFormField.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { OpaqueType } from '@internal/opaque';\nimport { z } from 'zod';\n\nimport { FormFieldExtensionData } from '@backstage/plugin-scaffolder-react/alpha';\n\n/** @alpha */\nexport interface FormField {\n  readonly $$type: '@backstage/scaffolder/FormField';\n}\n\n/** @alpha */\nexport const OpaqueFormField = OpaqueType.create<{\n  public: FormField;\n  versions: FormFieldExtensionData<z.ZodType, z.ZodType> & {\n    readonly version: 'v1';\n  };\n}>({ type: '@backstage/scaffolder/FormField', versions: ['v1'] });\n"],"names":[],"mappings":";;AA2Ba,MAAA,eAAA,GAAkB,UAAW,CAAA,MAAA,CAKvC,EAAE,IAAA,EAAM,mCAAmC,QAAU,EAAA,CAAC,IAAI,CAAA,EAAG;;;;"}
+{"version":3,"file":"InternalFormField.esm.js","sources":["../../../../../../../packages/scaffolder-internal/src/wiring/InternalFormField.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { OpaqueType } from '@internal/opaque';\nimport { z } from 'zod';\n\nimport {\n  FormFieldExtensionData,\n  FormField,\n} from '@backstage/plugin-scaffolder-react/alpha';\n\n/** @alpha */\nexport const OpaqueFormField = OpaqueType.create<{\n  public: FormField;\n  versions: FormFieldExtensionData<z.ZodType, z.ZodType> & {\n    readonly version: 'v1';\n  };\n}>({ type: '@backstage/scaffolder/FormField', versions: ['v1'] });\n"],"names":[],"mappings":";;AAyBa,MAAA,eAAA,GAAkB,UAAW,CAAA,MAAA,CAKvC,EAAE,IAAA,EAAM,mCAAmC,QAAU,EAAA,CAAC,IAAI,CAAA,EAAG;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-react",
-  "version": "1.18.0",
+  "version": "1.19.0-next.1",
   "description": "A frontend library that helps other Backstage plugins interact with the Scaffolder",
   "backstage": {
     "role": "web-library",
@@ -66,17 +66,17 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "^1.10.2",
-    "@backstage/catalog-model": "^1.7.5",
-    "@backstage/core-components": "^0.17.4",
-    "@backstage/core-plugin-api": "^1.10.9",
-    "@backstage/frontend-plugin-api": "^0.10.4",
-    "@backstage/plugin-catalog-react": "^1.19.1",
-    "@backstage/plugin-permission-react": "^0.4.36",
-    "@backstage/plugin-scaffolder-common": "^1.6.0",
-    "@backstage/theme": "^0.6.7",
-    "@backstage/types": "^1.2.1",
-    "@backstage/version-bridge": "^1.0.11",
+    "@backstage/catalog-client": "1.11.0-next.0",
+    "@backstage/catalog-model": "1.7.5",
+    "@backstage/core-components": "0.17.5-next.0",
+    "@backstage/core-plugin-api": "1.10.9",
+    "@backstage/frontend-plugin-api": "0.11.0-next.0",
+    "@backstage/plugin-catalog-react": "1.20.0-next.1",
+    "@backstage/plugin-permission-react": "0.4.36",
+    "@backstage/plugin-scaffolder-common": "1.7.0-next.0",
+    "@backstage/theme": "0.6.8-next.0",
+    "@backstage/types": "1.2.1",
+    "@backstage/version-bridge": "1.0.11",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -104,12 +104,12 @@
     "zod-to-json-schema": "^3.20.4"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.33.1",
-    "@backstage/core-app-api": "^1.18.0",
-    "@backstage/plugin-catalog": "^1.31.1",
-    "@backstage/plugin-catalog-common": "^1.1.5",
-    "@backstage/plugin-permission-common": "^0.9.1",
-    "@backstage/test-utils": "^1.7.10",
+    "@backstage/cli": "0.33.2-next.0",
+    "@backstage/core-app-api": "1.18.0",
+    "@backstage/plugin-catalog": "1.31.2-next.1",
+    "@backstage/plugin-catalog-common": "1.1.5",
+    "@backstage/plugin-permission-common": "0.9.1",
+    "@backstage/test-utils": "1.7.11-next.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",