@backstage/plugin-scaffolder-react 1.14.0 → 1.14.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-scaffolder-react
 
+## 1.14.2-next.0
+
+### Patch Changes
+
+- 3c62a50: Experimental support for `formDecorators` to enable secret collection and mutations to the parameters for scaffolder tasks
+- c4ffd13: Added the autocomplete feature to GitlabRepoUrlPicker
+- 9951ba4: Updated dependency `@rjsf/utils` to `5.23.1`.
+  Updated dependency `@rjsf/core` to `5.23.1`.
+  Updated dependency `@rjsf/material-ui` to `5.23.1`.
+  Updated dependency `@rjsf/validator-ajv8` to `5.23.1`.
+- Updated dependencies
+  - @backstage/plugin-scaffolder-common@1.5.8-next.0
+  - @backstage/plugin-catalog-react@1.14.3-next.0
+  - @backstage/frontend-plugin-api@0.9.3-next.0
+  - @backstage/theme@0.6.3-next.0
+  - @backstage/catalog-client@1.8.1-next.0
+  - @backstage/catalog-model@1.7.1
+  - @backstage/core-components@0.16.2-next.0
+  - @backstage/core-plugin-api@1.10.1
+  - @backstage/types@1.2.0
+  - @backstage/version-bridge@1.0.10
+  - @backstage/plugin-permission-react@0.4.28
+
 ## 1.14.0
 
 ### Minor Changes

package/dist/alpha.d.ts

@@ -5,7 +5,7 @@ import React__default, { ComponentType, ReactNode, PropsWithChildren, ReactEleme
 import { TemplatePresentationV1beta3, TemplateEntityV1beta3, TaskStep } from '@backstage/plugin-scaffolder-common';
 import { UiSchema, FieldValidation, WidgetProps } from '@rjsf/utils';
 import { TemplateParameterSchema, FieldExtensionOptions, FormProps, ReviewStepProps, LayoutOptions, CustomFieldValidator, TemplateGroupFilter, ScaffolderTaskOutput, ScaffolderRJSFFormProps, ScaffolderStep, FieldExtensionComponentProps, FieldSchema } from '@backstage/plugin-scaffolder-react';
-import { ApiHolder, IconComponent } from '@backstage/core-plugin-api';
+import { ApiHolder, IconComponent, AnyApiRef } from '@backstage/core-plugin-api';
 import { Overrides } from '@material-ui/core/styles/overrides';
 import { StyleRules } from '@material-ui/core/styles/withStyles';
 import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
@@ -294,9 +294,9 @@ declare const useFormDataFromQuery: (initialState?: Record<string, JsonValue>) =
  * @alpha
  */
 declare const useTemplateParameterSchema: (templateRef: string) => {
-    manifest: TemplateParameterSchema | undefined;
+    manifest?: TemplateParameterSchema | undefined;
     loading: boolean;
-    error: Error | undefined;
+    error?: Error | undefined;
 };
 
 /**
@@ -374,4 +374,45 @@ declare const FormFieldBlueprint: _backstage_frontend_plugin_api.ExtensionBluepr
  */
 declare function createFormField<TReturnValue extends z.ZodType, TUiOptions extends z.ZodType>(opts: FormFieldExtensionData<TReturnValue, TUiOptions>): FormField;
 
-export { type BackstageOverrides, type BackstageTemplateStepperClassKey, DefaultTemplateOutputs, EmbeddableWorkflow, Form, FormFieldBlueprint, type FormFieldExtensionData, type FormValidation, type ParsedTemplateSchema, ReviewState, type ReviewStateProps, ScaffolderField, type ScaffolderFieldProps, 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, extractSchemaFromStep, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };
+/** @alpha */
+type ScaffolderFormDecoratorContext<TInput extends JsonObject = JsonObject> = {
+    input: TInput;
+    formState: Record<string, JsonValue>;
+    setFormState: (fn: (currentState: Record<string, JsonValue>) => Record<string, JsonValue>) => void;
+    setSecrets: (fn: (currentState: Record<string, string>) => Record<string, string>) => void;
+};
+/** @alpha */
+type ScaffolderFormDecorator<TInput extends JsonObject = JsonObject> = {
+    readonly $$type: '@backstage/scaffolder/FormDecorator';
+    readonly id: string;
+    readonly TInput: TInput;
+};
+/**
+ * Method for creating decorators which can be used to collect
+ * secrets from the user before submitting to the backend.
+ * @alpha
+ */
+declare function createScaffolderFormDecorator<TInputSchema extends {
+    [key in string]: (zImpl: typeof z) => z.ZodType;
+} = {
+    [key in string]: (zImpl: typeof z) => z.ZodType;
+}, TDeps extends {
+    [key in string]: AnyApiRef;
+} = {
+    [key in string]: AnyApiRef;
+}, TInput extends JsonObject = {
+    [key in keyof TInputSchema]: z.infer<ReturnType<TInputSchema[key]>>;
+}>(options: {
+    id: string;
+    schema?: {
+        input?: TInputSchema;
+    };
+    deps?: TDeps;
+    decorator: (ctx: ScaffolderFormDecoratorContext<TInput>, deps: TDeps extends {
+        [key in string]: AnyApiRef;
+    } ? {
+        [key in keyof TDeps]: TDeps[key]['T'];
+    } : never) => Promise<void>;
+}): ScaffolderFormDecorator<TInput>;
+
+export { type BackstageOverrides, type BackstageTemplateStepperClassKey, DefaultTemplateOutputs, EmbeddableWorkflow, Form, FormFieldBlueprint, type FormFieldExtensionData, type FormValidation, type ParsedTemplateSchema, ReviewState, type ReviewStateProps, ScaffolderField, type ScaffolderFieldProps, type ScaffolderFormDecorator, type ScaffolderFormDecoratorContext, 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, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };

package/dist/alpha.esm.js

@@ -19,4 +19,5 @@ export { useTemplateSchema } from './next/hooks/useTemplateSchema.esm.js';
 export { useTemplateParameterSchema } from './next/hooks/useTemplateParameterSchema.esm.js';
 export { useFilteredSchemaProperties } from './next/hooks/useFilteredSchemaProperties.esm.js';
 export { FormFieldBlueprint, createFormField } from './next/blueprints/FormFieldBlueprint.esm.js';
+export { createScaffolderFormDecorator } from './next/extensions/createScaffolderFormDecorator.esm.js';
 //# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"alpha.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;"}

package/dist/extensions/{index.esm.js → createScaffolderFieldExtension.esm.js}

@@ -22,4 +22,4 @@ attachComponentData(
 );
 
 export { ScaffolderFieldExtensions, createScaffolderFieldExtension };
-//# sourceMappingURL=index.esm.js.map
+//# sourceMappingURL=createScaffolderFieldExtension.esm.js.map

package/dist/extensions/createScaffolderFieldExtension.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createScaffolderFieldExtension.esm.js","sources":["../../src/extensions/createScaffolderFieldExtension.tsx"],"sourcesContent":["/*\n * Copyright 2021 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  CustomFieldValidator,\n  FieldExtensionOptions,\n  FieldExtensionComponentProps,\n  FieldExtensionUiSchema,\n  CustomFieldExtensionSchema,\n} from './types';\nimport { Extension, attachComponentData } from '@backstage/core-plugin-api';\nimport { UIOptionsType } from '@rjsf/utils';\nimport { FIELD_EXTENSION_KEY, FIELD_EXTENSION_WRAPPER_KEY } from './keys';\n\n/**\n * Method for creating field extensions that can be used in the scaffolder\n * frontend form.\n * @public\n */\nexport function createScaffolderFieldExtension<\n  TReturnValue = unknown,\n  TInputProps extends UIOptionsType = {},\n>(\n  options: FieldExtensionOptions<TReturnValue, TInputProps>,\n): Extension<FieldExtensionComponent<TReturnValue, TInputProps>> {\n  return {\n    expose() {\n      const FieldExtensionDataHolder: any = () => null;\n\n      attachComponentData(\n        FieldExtensionDataHolder,\n        FIELD_EXTENSION_KEY,\n        options,\n      );\n\n      return FieldExtensionDataHolder;\n    },\n  };\n}\n\n/**\n * The Wrapping component for defining fields extensions inside\n *\n * @public\n */\nexport const ScaffolderFieldExtensions: React.ComponentType<\n  React.PropsWithChildren<{}>\n> = (): JSX.Element | null => null;\n\nattachComponentData(\n  ScaffolderFieldExtensions,\n  FIELD_EXTENSION_WRAPPER_KEY,\n  true,\n);\n\n/**\n * The type used to wrap up the Layout and embed the input props\n *\n * @public\n */\nexport type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;\n\nexport type {\n  CustomFieldValidator,\n  FieldExtensionOptions,\n  FieldExtensionComponentProps,\n  FieldExtensionUiSchema,\n  CustomFieldExtensionSchema,\n};\n\nexport * from './rjsf';\n"],"names":[],"mappings":";;;AAgCO,SAAS,+BAId,OAC+D,EAAA;AAC/D,EAAO,OAAA;AAAA,IACL,MAAS,GAAA;AACP,MAAA,MAAM,2BAAgC,MAAM,IAAA;AAE5C,MAAA,mBAAA;AAAA,QACE,wBAAA;AAAA,QACA,mBAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAO,OAAA,wBAAA;AAAA;AACT,GACF;AACF;AAOO,MAAM,4BAET,MAA0B;AAE9B,mBAAA;AAAA,EACE,yBAAA;AAAA,EACA,2BAAA;AAAA,EACA;AACF,CAAA;;;;"}

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="react" />
 import { ApiHolder, Extension } from '@backstage/core-plugin-api';
-import React__default, { HTMLAttributes, ReactNode, ComponentType, FormEvent, ElementType, Ref, PropsWithChildren } from 'react';
+import React__default, { HTMLAttributes, ReactNode, FormEvent, ElementType, Ref, ComponentType, PropsWithChildren } from 'react';
 import { JsonObject, JsonValue, Observable } 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, FieldValidation, UIOptionsType } from '@rjsf/utils';
+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_frontend_plugin_api from '@backstage/frontend-plugin-api';
@@ -348,6 +348,10 @@ type TemplateParameterSchema = {
         description?: string;
         schema: JsonObject;
     }>;
+    EXPERIMENTAL_formDecorators?: {
+        id: string;
+        input?: JsonObject;
+    }[];
 };
 
 /**
@@ -574,7 +578,8 @@ interface ScaffolderApi {
         context?: Record<string, string>;
     }): Promise<{
         results: {
-            title: string;
+            title?: string;
+            id: string;
         }[];
     }>;
 }

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-export { ScaffolderFieldExtensions, createScaffolderFieldExtension } from './extensions/index.esm.js';
+export { ScaffolderFieldExtensions, createScaffolderFieldExtension } from './extensions/createScaffolderFieldExtension.esm.js';
 export { SecretsContextProvider, useTemplateSecrets } from './secrets/SecretsContext.esm.js';
 export { scaffolderApiRef } from './api/ref.esm.js';
 export { useCustomFieldExtensions } from './hooks/useCustomFieldExtensions.esm.js';

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

@@ -1,5 +1,6 @@
 import { createExtensionDataRef, createExtensionBlueprint } from '@backstage/frontend-plugin-api';
 import { OpaqueFormField } from '../../packages/scaffolder-internal/src/wiring/InternalFormField.esm.js';
+import '../../packages/scaffolder-internal/src/wiring/InternalFormDecorator.esm.js';
 
 const formFieldExtensionDataRef = createExtensionDataRef().with({
   id: "scaffolder.form-field-loader"

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: { id: 'api:scaffolder/form-fields', input: 'formFields' },\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,EAAE,EAAI,EAAA,4BAAA,EAA8B,OAAO,YAAa,EAAA;AAAA,EAClE,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, 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: { id: 'api:scaffolder/form-fields', input: 'formFields' },\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,EAAE,EAAI,EAAA,4BAAA,EAA8B,OAAO,YAAa,EAAA;AAAA,EAClE,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/next/components/TemplateGroup/TemplateGroup.esm.js

@@ -1,5 +1,5 @@
 import React from 'react';
-import { Content, ContentHeader, ItemCardGrid } from '@backstage/core-components';
+import { Content, ItemCardGrid, ContentHeader } from '@backstage/core-components';
 import { stringifyEntityRef } from '@backstage/catalog-model';
 import { TemplateCard } from '../TemplateCard/TemplateCard.esm.js';
 

package/dist/next/extensions/createScaffolderFormDecorator.esm.js

@@ -0,0 +1,12 @@
+import { OpaqueFormDecorator } from '../../packages/scaffolder-internal/src/wiring/InternalFormDecorator.esm.js';
+import '../../packages/scaffolder-internal/src/wiring/InternalFormField.esm.js';
+
+function createScaffolderFormDecorator(options) {
+  return OpaqueFormDecorator.createInstance("v1", {
+    ...options,
+    TInput: null
+  });
+}
+
+export { createScaffolderFormDecorator };
+//# sourceMappingURL=createScaffolderFormDecorator.esm.js.map

package/dist/next/extensions/createScaffolderFormDecorator.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createScaffolderFormDecorator.esm.js","sources":["../../../src/next/extensions/createScaffolderFormDecorator.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 */\nimport { AnyApiRef } from '@backstage/core-plugin-api';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { OpaqueFormDecorator } from '@internal/scaffolder';\nimport { z } from 'zod';\n\n/** @alpha */\nexport type ScaffolderFormDecoratorContext<\n  TInput extends JsonObject = JsonObject,\n> = {\n  input: TInput;\n  formState: Record<string, JsonValue>;\n\n  setFormState: (\n    fn: (currentState: Record<string, JsonValue>) => Record<string, JsonValue>,\n  ) => void;\n  setSecrets: (\n    fn: (currentState: Record<string, string>) => Record<string, string>,\n  ) => void;\n};\n\n/** @alpha */\nexport type ScaffolderFormDecorator<TInput extends JsonObject = JsonObject> = {\n  readonly $$type: '@backstage/scaffolder/FormDecorator';\n  readonly id: string;\n  readonly TInput: TInput;\n};\n\n/**\n * Method for creating decorators which can be used to collect\n * secrets from the user before submitting to the backend.\n * @alpha\n */\nexport function createScaffolderFormDecorator<\n  TInputSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType } = {\n    [key in string]: (zImpl: typeof z) => z.ZodType;\n  },\n  TDeps extends { [key in string]: AnyApiRef } = { [key in string]: AnyApiRef },\n  TInput extends JsonObject = {\n    [key in keyof TInputSchema]: z.infer<ReturnType<TInputSchema[key]>>;\n  },\n>(options: {\n  id: string;\n  schema?: {\n    input?: TInputSchema;\n  };\n  deps?: TDeps;\n  decorator: (\n    ctx: ScaffolderFormDecoratorContext<TInput>,\n    deps: TDeps extends { [key in string]: AnyApiRef }\n      ? { [key in keyof TDeps]: TDeps[key]['T'] }\n      : never,\n  ) => Promise<void>;\n}): ScaffolderFormDecorator<TInput> {\n  return OpaqueFormDecorator.createInstance('v1', {\n    ...options,\n    TInput: null as unknown as TInput,\n  } as {\n    id: string;\n    schema?: {\n      input?: TInputSchema;\n    };\n    TInput: TInput;\n    deps?: TDeps;\n    decorator: (\n      ctx: ScaffolderFormDecoratorContext,\n      deps: { [key in string]: AnyApiRef['T'] },\n    ) => Promise<void>;\n  });\n}\n"],"names":[],"mappings":";;;AA+CO,SAAS,8BAQd,OAYkC,EAAA;AAClC,EAAO,OAAA,mBAAA,CAAoB,eAAe,IAAM,EAAA;AAAA,IAC9C,GAAG,OAAA;AAAA,IACH,MAAQ,EAAA;AAAA,GAYT,CAAA;AACH;;;;"}

package/dist/next/hooks/useTemplateParameterSchema.esm.js

@@ -4,12 +4,16 @@ import { useApi } from '@backstage/core-plugin-api';
 
 const useTemplateParameterSchema = (templateRef) => {
   const scaffolderApi = useApi(scaffolderApiRef);
-  const { value, loading, error } = useAsync(
+  const {
+    value: manifest,
+    loading,
+    error
+  } = useAsync(
     () => scaffolderApi.getTemplateParameterSchema(templateRef),
     [scaffolderApi, templateRef]
   );
   return {
-    manifest: value,
+    manifest,
     loading,
     error
   };

package/dist/next/hooks/useTemplateParameterSchema.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"useTemplateParameterSchema.esm.js","sources":["../../../src/next/hooks/useTemplateParameterSchema.ts"],"sourcesContent":["/*\n * Copyright 2023 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 useAsync from 'react-use/esm/useAsync';\nimport { scaffolderApiRef } from '../../api/ref';\nimport { useApi } from '@backstage/core-plugin-api';\nimport { TemplateParameterSchema } from '@backstage/plugin-scaffolder-react';\n\n/**\n * @alpha\n */\nexport const useTemplateParameterSchema = (templateRef: string) => {\n  const scaffolderApi = useApi(scaffolderApiRef);\n  const { value, loading, error } = useAsync(\n    () => scaffolderApi.getTemplateParameterSchema(templateRef),\n    [scaffolderApi, templateRef],\n  );\n\n  return {\n    manifest: value as TemplateParameterSchema | undefined,\n    loading,\n    error,\n  };\n};\n"],"names":[],"mappings":";;;;AAwBa,MAAA,0BAAA,GAA6B,CAAC,WAAwB,KAAA;AACjE,EAAM,MAAA,aAAA,GAAgB,OAAO,gBAAgB,CAAA;AAC7C,EAAA,MAAM,EAAE,KAAA,EAAO,OAAS,EAAA,KAAA,EAAU,GAAA,QAAA;AAAA,IAChC,MAAM,aAAc,CAAA,0BAAA,CAA2B,WAAW,CAAA;AAAA,IAC1D,CAAC,eAAe,WAAW;AAAA,GAC7B;AAEA,EAAO,OAAA;AAAA,IACL,QAAU,EAAA,KAAA;AAAA,IACV,OAAA;AAAA,IACA;AAAA,GACF;AACF;;;;"}
+{"version":3,"file":"useTemplateParameterSchema.esm.js","sources":["../../../src/next/hooks/useTemplateParameterSchema.ts"],"sourcesContent":["/*\n * Copyright 2023 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 useAsync from 'react-use/esm/useAsync';\nimport { scaffolderApiRef } from '../../api/ref';\nimport { useApi } from '@backstage/core-plugin-api';\nimport { TemplateParameterSchema } from '@backstage/plugin-scaffolder-react';\n\n/**\n * @alpha\n */\nexport const useTemplateParameterSchema = (\n  templateRef: string,\n): { manifest?: TemplateParameterSchema; loading: boolean; error?: Error } => {\n  const scaffolderApi = useApi(scaffolderApiRef);\n  const {\n    value: manifest,\n    loading,\n    error,\n  } = useAsync(\n    () => scaffolderApi.getTemplateParameterSchema(templateRef),\n    [scaffolderApi, templateRef],\n  );\n\n  return {\n    manifest,\n    loading,\n    error,\n  };\n};\n"],"names":[],"mappings":";;;;AAwBa,MAAA,0BAAA,GAA6B,CACxC,WAC4E,KAAA;AAC5E,EAAM,MAAA,aAAA,GAAgB,OAAO,gBAAgB,CAAA;AAC7C,EAAM,MAAA;AAAA,IACJ,KAAO,EAAA,QAAA;AAAA,IACP,OAAA;AAAA,IACA;AAAA,GACE,GAAA,QAAA;AAAA,IACF,MAAM,aAAc,CAAA,0BAAA,CAA2B,WAAW,CAAA;AAAA,IAC1D,CAAC,eAAe,WAAW;AAAA,GAC7B;AAEA,EAAO,OAAA;AAAA,IACL,QAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACF;AACF;;;;"}

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

@@ -0,0 +1,6 @@
+import { OpaqueType } from '../../../opaque-internal/src/OpaqueType.esm.js';
+
+const OpaqueFormDecorator = OpaqueType.create({ type: "@backstage/scaffolder/FormDecorator", versions: ["v1"] });
+
+export { OpaqueFormDecorator };
+//# sourceMappingURL=InternalFormDecorator.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalFormDecorator.esm.js","sources":["../../../../../../../packages/scaffolder-internal/src/wiring/InternalFormDecorator.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 */\nimport { OpaqueType } from '@internal/opaque';\nimport { z } from 'zod';\n\nimport {\n  ScaffolderFormDecorator,\n  ScaffolderFormDecoratorContext,\n} from '@backstage/plugin-scaffolder-react/alpha';\nimport { AnyApiRef } from '@backstage/frontend-plugin-api';\n\n/** @alpha */\nexport const OpaqueFormDecorator = OpaqueType.create<{\n  public: ScaffolderFormDecorator;\n  versions: {\n    readonly version: 'v1';\n    readonly id: string;\n    readonly schema?: {\n      input?: {\n        [key in string]: (zImpl: typeof z) => z.ZodType;\n      };\n    };\n    readonly deps?: { [key in string]: AnyApiRef };\n    readonly decorator: (\n      ctx: ScaffolderFormDecoratorContext,\n      deps: { [depName in string]: AnyApiRef['T'] },\n    ) => Promise<void>;\n  };\n}>({ type: '@backstage/scaffolder/FormDecorator', versions: ['v1'] });\n"],"names":[],"mappings":";;AAyBa,MAAA,mBAAA,GAAsB,UAAW,CAAA,MAAA,CAgB3C,EAAE,IAAA,EAAM,uCAAuC,QAAU,EAAA,CAAC,IAAI,CAAA,EAAG;;;;"}

package/dist/secrets/SecretsContext.esm.js

@@ -1,5 +1,5 @@
 import { createVersionedContext, createVersionedValueMap } from '@backstage/version-bridge';
-import React, { useContext, useCallback, useState } from 'react';
+import React, { useState, useContext, useCallback } from 'react';
 
 const SecretsContext = createVersionedContext("secrets-context");
 const SecretsContextProvider = (props) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-react",
-  "version": "1.14.0",
+  "version": "1.14.2-next.0",
   "description": "A frontend library that helps other Backstage plugins interact with the Scaffolder",
   "backstage": {
     "role": "web-library",
@@ -66,25 +66,25 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "^1.8.0",
-    "@backstage/catalog-model": "^1.7.1",
-    "@backstage/core-components": "^0.16.0",
-    "@backstage/core-plugin-api": "^1.10.1",
-    "@backstage/frontend-plugin-api": "^0.9.1",
-    "@backstage/plugin-catalog-react": "^1.14.1",
-    "@backstage/plugin-permission-react": "^0.4.28",
-    "@backstage/plugin-scaffolder-common": "^1.5.7",
-    "@backstage/theme": "^0.6.1",
-    "@backstage/types": "^1.2.0",
-    "@backstage/version-bridge": "^1.0.10",
+    "@backstage/catalog-client": "1.8.1-next.0",
+    "@backstage/catalog-model": "1.7.1",
+    "@backstage/core-components": "0.16.2-next.0",
+    "@backstage/core-plugin-api": "1.10.1",
+    "@backstage/frontend-plugin-api": "0.9.3-next.0",
+    "@backstage/plugin-catalog-react": "1.14.3-next.0",
+    "@backstage/plugin-permission-react": "0.4.28",
+    "@backstage/plugin-scaffolder-common": "1.5.8-next.0",
+    "@backstage/theme": "0.6.3-next.0",
+    "@backstage/types": "1.2.0",
+    "@backstage/version-bridge": "1.0.10",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
     "@react-hookz/web": "^24.0.0",
-    "@rjsf/core": "5.21.2",
-    "@rjsf/material-ui": "5.21.2",
-    "@rjsf/utils": "5.21.2",
-    "@rjsf/validator-ajv8": "5.21.2",
+    "@rjsf/core": "5.23.1",
+    "@rjsf/material-ui": "5.23.1",
+    "@rjsf/utils": "5.23.1",
+    "@rjsf/validator-ajv8": "5.23.1",
     "@types/json-schema": "^7.0.9",
     "ajv-errors": "^3.0.0",
     "classnames": "^2.2.6",
@@ -102,12 +102,12 @@
     "zod-to-json-schema": "^3.20.4"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.29.0",
-    "@backstage/core-app-api": "^1.15.2",
-    "@backstage/plugin-catalog": "^1.25.0",
-    "@backstage/plugin-catalog-common": "^1.1.1",
-    "@backstage/plugin-permission-common": "^0.8.2",
-    "@backstage/test-utils": "^1.7.1",
+    "@backstage/cli": "0.29.3-next.0",
+    "@backstage/core-app-api": "1.15.3-next.0",
+    "@backstage/plugin-catalog": "1.25.2-next.0",
+    "@backstage/plugin-catalog-common": "1.1.1",
+    "@backstage/plugin-permission-common": "0.8.2",
+    "@backstage/test-utils": "1.7.3-next.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",

package/dist/extensions/index.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.esm.js","sources":["../../src/extensions/index.tsx"],"sourcesContent":["/*\n * Copyright 2021 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  CustomFieldValidator,\n  FieldExtensionOptions,\n  FieldExtensionComponentProps,\n  FieldExtensionUiSchema,\n  CustomFieldExtensionSchema,\n} from './types';\nimport { Extension, attachComponentData } from '@backstage/core-plugin-api';\nimport { UIOptionsType } from '@rjsf/utils';\nimport { FIELD_EXTENSION_KEY, FIELD_EXTENSION_WRAPPER_KEY } from './keys';\n\n/**\n * Method for creating field extensions that can be used in the scaffolder\n * frontend form.\n * @public\n */\nexport function createScaffolderFieldExtension<\n  TReturnValue = unknown,\n  TInputProps extends UIOptionsType = {},\n>(\n  options: FieldExtensionOptions<TReturnValue, TInputProps>,\n): Extension<FieldExtensionComponent<TReturnValue, TInputProps>> {\n  return {\n    expose() {\n      const FieldExtensionDataHolder: any = () => null;\n\n      attachComponentData(\n        FieldExtensionDataHolder,\n        FIELD_EXTENSION_KEY,\n        options,\n      );\n\n      return FieldExtensionDataHolder;\n    },\n  };\n}\n\n/**\n * The Wrapping component for defining fields extensions inside\n *\n * @public\n */\nexport const ScaffolderFieldExtensions: React.ComponentType<\n  React.PropsWithChildren<{}>\n> = (): JSX.Element | null => null;\n\nattachComponentData(\n  ScaffolderFieldExtensions,\n  FIELD_EXTENSION_WRAPPER_KEY,\n  true,\n);\n\n/**\n * The type used to wrap up the Layout and embed the input props\n *\n * @public\n */\nexport type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;\n\nexport type {\n  CustomFieldValidator,\n  FieldExtensionOptions,\n  FieldExtensionComponentProps,\n  FieldExtensionUiSchema,\n  CustomFieldExtensionSchema,\n};\n\nexport * from './rjsf';\n"],"names":[],"mappings":";;;AAgCO,SAAS,+BAId,OAC+D,EAAA;AAC/D,EAAO,OAAA;AAAA,IACL,MAAS,GAAA;AACP,MAAA,MAAM,2BAAgC,MAAM,IAAA;AAE5C,MAAA,mBAAA;AAAA,QACE,wBAAA;AAAA,QACA,mBAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAO,OAAA,wBAAA;AAAA;AACT,GACF;AACF;AAOO,MAAM,4BAET,MAA0B;AAE9B,mBAAA;AAAA,EACE,yBAAA;AAAA,EACA,2BAAA;AAAA,EACA;AACF,CAAA;;;;"}