@backstage/plugin-scaffolder 1.8.0-next.1 → 1.9.0-next.0

package/dist/index.d.ts

@@ -12,6 +12,7 @@ import { BackstagePlugin } from '@backstage/core-plugin-api';
 import { ComponentType } from 'react';
 import { DiscoveryApi } from '@backstage/core-plugin-api';
 import { Entity } from '@backstage/catalog-model';
+import type { ErrorTransformer } from '@rjsf/utils';
 import { Extension } from '@backstage/core-plugin-api';
 import { ExternalRouteRef } from '@backstage/core-plugin-api';
 import { FetchApi } from '@backstage/core-plugin-api';
@@ -36,6 +37,7 @@ import { TaskStep } from '@backstage/plugin-scaffolder-common';
 import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { UIOptionsType } from '@rjsf/utils';
 import { UiSchema } from '@rjsf/utils';
+import { z } from 'zod';
 
 /* Excluded from this release type: createNextScaffolderFieldExtension */
 
@@ -53,6 +55,16 @@ export declare function createScaffolderFieldExtension<TReturnValue = unknown, T
  */
 export declare function createScaffolderLayout<TInputProps = unknown>(options: LayoutOptions): Extension<LayoutComponent<TInputProps>>;
 
+/**
+ * Type for the Custom Field Extension schema.
+ *
+ * @public
+ */
+export declare type CustomFieldExtensionSchema = {
+    returnValue: JSONSchema7;
+    uiOptions?: JSONSchema7;
+};
+
 /**
  * Field validation type for Custom Field Extensions.
  *
@@ -74,7 +86,22 @@ export declare const EntityNamePickerFieldExtension: FieldExtensionComponent<str
  *
  * @public
  */
-export declare const EntityPickerFieldExtension: FieldExtensionComponent<string, EntityPickerUiOptions>;
+export declare const EntityPickerFieldExtension: FieldExtensionComponent<string, {
+defaultKind?: string | undefined;
+defaultNamespace?: string | false | undefined;
+allowedKinds?: string[] | undefined;
+allowArbitraryValues?: boolean | undefined;
+}>;
+
+/**
+ * @public
+ */
+export declare const EntityPickerFieldSchema: FieldSchema<string, {
+defaultKind?: string | undefined;
+defaultNamespace?: string | false | undefined;
+allowedKinds?: string[] | undefined;
+allowArbitraryValues?: boolean | undefined;
+}>;
 
 /**
  * The input props that can be specified under `ui:options` for the
@@ -82,18 +109,26 @@ export declare const EntityPickerFieldExtension: FieldExtensionComponent<string,
  *
  * @public
  */
-export declare interface EntityPickerUiOptions {
-    allowedKinds?: string[];
-    defaultKind?: string;
-    allowArbitraryValues?: boolean;
-    defaultNamespace?: string | false;
-}
+export declare type EntityPickerUiOptions = typeof EntityPickerFieldSchema.uiOptionsType;
 
 /**
  * EntityTagsPickerFieldExtension
  * @public
  */
-export declare const EntityTagsPickerFieldExtension: FieldExtensionComponent<string[], EntityTagsPickerUiOptions>;
+export declare const EntityTagsPickerFieldExtension: FieldExtensionComponent<string[], {
+showCounts?: boolean | undefined;
+kinds?: string[] | undefined;
+helperText?: string | undefined;
+}>;
+
+/**
+ * @public
+ */
+export declare const EntityTagsPickerFieldSchema: FieldSchema<string[], {
+showCounts?: boolean | undefined;
+kinds?: string[] | undefined;
+helperText?: string | undefined;
+}>;
 
 /**
  * The input props that can be specified under `ui:options` for the
@@ -101,11 +136,7 @@ export declare const EntityTagsPickerFieldExtension: FieldExtensionComponent<str
  *
  * @public
  */
-export declare interface EntityTagsPickerUiOptions {
-    kinds?: string[];
-    showCounts?: boolean;
-    helperText?: string;
-}
+export declare type EntityTagsPickerUiOptions = typeof EntityTagsPickerFieldSchema.uiOptionsType;
 
 /**
  * A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
@@ -136,8 +167,20 @@ export declare type FieldExtensionOptions<TFieldReturnValue = unknown, TInputPro
     name: string;
     component: (props: FieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
     validation?: CustomFieldValidator<TFieldReturnValue>;
+    schema?: CustomFieldExtensionSchema;
 };
 
+/**
+ * @public
+ * FieldSchema encapsulates a JSONSchema7 along with the
+ * matching FieldExtensionComponentProps type for a field extension.
+ */
+export declare interface FieldSchema<TReturn, TUiOptions> {
+    readonly schema: CustomFieldExtensionSchema;
+    readonly type: FieldExtensionComponentProps<TReturn, TUiOptions>;
+    readonly uiOptionsType: TUiOptions;
+}
+
 /**
  * The type used to wrap up the Layout and embed the input props
  *
@@ -193,6 +236,13 @@ export declare type LogEvent = {
     taskId: string;
 };
 
+/**
+ * @public
+ * Utility function to convert zod return and UI options schemas to a
+ * CustomFieldExtensionSchema with FieldExtensionComponentProps type inference
+ */
+export declare function makeFieldSchemaFromZod<TReturnSchema extends z.ZodType, TUiOptionsSchema extends z.ZodType = z.ZodType<any, any, {}>>(returnSchema: TReturnSchema, uiOptionsSchema?: TUiOptionsSchema): FieldSchema<TReturnSchema extends z.ZodType<any, any, infer IReturn> ? IReturn : never, TUiOptionsSchema extends z.ZodType<any, any, infer IUiOptions> ? IUiOptions : never>;
+
 /* Excluded from this release type: NextCustomFieldValidator */
 
 /* Excluded from this release type: NextFieldExtensionComponentProps */
@@ -212,7 +262,22 @@ export declare type LogEvent = {
  *
  * @public
  */
-export declare const OwnedEntityPickerFieldExtension: FieldExtensionComponent<string, OwnedEntityPickerUiOptions>;
+export declare const OwnedEntityPickerFieldExtension: FieldExtensionComponent<string, {
+defaultKind?: string | undefined;
+defaultNamespace?: string | false | undefined;
+allowedKinds?: string[] | undefined;
+allowArbitraryValues?: boolean | undefined;
+}>;
+
+/**
+ * @public
+ */
+export declare const OwnedEntityPickerFieldSchema: FieldSchema<string, {
+defaultKind?: string | undefined;
+defaultNamespace?: string | false | undefined;
+allowedKinds?: string[] | undefined;
+allowArbitraryValues?: boolean | undefined;
+}>;
 
 /**
  * The input props that can be specified under `ui:options` for the
@@ -220,19 +285,27 @@ export declare const OwnedEntityPickerFieldExtension: FieldExtensionComponent<st
  *
  * @public
  */
-export declare interface OwnedEntityPickerUiOptions {
-    allowedKinds?: string[];
-    defaultKind?: string;
-    allowArbitraryValues?: boolean;
-    defaultNamespace?: string | false;
-}
+export declare type OwnedEntityPickerUiOptions = typeof OwnedEntityPickerFieldSchema.uiOptionsType;
 
 /**
  * A field extension for picking users and groups out of the Catalog.
  *
  * @public
  */
-export declare const OwnerPickerFieldExtension: FieldExtensionComponent<string, OwnerPickerUiOptions>;
+export declare const OwnerPickerFieldExtension: FieldExtensionComponent<string, {
+defaultNamespace?: string | false | undefined;
+allowedKinds?: string[] | undefined;
+allowArbitraryValues?: boolean | undefined;
+}>;
+
+/**
+ * @public
+ */
+export declare const OwnerPickerFieldSchema: FieldSchema<string, {
+defaultNamespace?: string | false | undefined;
+allowedKinds?: string[] | undefined;
+allowArbitraryValues?: boolean | undefined;
+}>;
 
 /**
  * The input props that can be specified under `ui:options` for the
@@ -240,11 +313,7 @@ export declare const OwnerPickerFieldExtension: FieldExtensionComponent<string,
  *
  * @public
  */
-export declare interface OwnerPickerUiOptions {
-    allowedKinds?: string[];
-    allowArbitraryValues?: boolean;
-    defaultNamespace?: string | false;
-}
+export declare type OwnerPickerUiOptions = typeof OwnerPickerFieldSchema.uiOptionsType;
 
 /**
  * The validation function for the `repoUrl` that is returned from the
@@ -259,11 +328,46 @@ export declare const repoPickerValidation: (value: string, validation: FieldVali
 
 /**
  * The field extension which provides the ability to select a RepositoryUrl.
- * Currently this is an encoded URL that looks something like the following `github.com?repo=myRepoName&owner=backstage`.
- *
+ * Currently, this is an encoded URL that looks something like the following `github.com?repo=myRepoName&owner=backstage`.
+ *
+ * @public
+ */
+export declare const RepoUrlPickerFieldExtension: FieldExtensionComponent<string, {
+allowedOwners?: string[] | undefined;
+allowedOrganizations?: string[] | undefined;
+allowedRepos?: string[] | undefined;
+allowedHosts?: string[] | undefined;
+requestUserCredentials?: {
+additionalScopes?: {
+azure?: string[] | undefined;
+github?: string[] | undefined;
+gitlab?: string[] | undefined;
+bitbucket?: string[] | undefined;
+gerrit?: string[] | undefined;
+} | undefined;
+secretsKey: string;
+} | undefined;
+}>;
+
+/**
  * @public
  */
-export declare const RepoUrlPickerFieldExtension: FieldExtensionComponent<string, RepoUrlPickerUiOptions>;
+export declare const RepoUrlPickerFieldSchema: FieldSchema<string, {
+allowedOwners?: string[] | undefined;
+allowedOrganizations?: string[] | undefined;
+allowedRepos?: string[] | undefined;
+allowedHosts?: string[] | undefined;
+requestUserCredentials?: {
+additionalScopes?: {
+azure?: string[] | undefined;
+github?: string[] | undefined;
+gitlab?: string[] | undefined;
+bitbucket?: string[] | undefined;
+gerrit?: string[] | undefined;
+} | undefined;
+secretsKey: string;
+} | undefined;
+}>;
 
 /**
  * The input props that can be specified under `ui:options` for the
@@ -271,22 +375,26 @@ export declare const RepoUrlPickerFieldExtension: FieldExtensionComponent<string
  *
  * @public
  */
-export declare interface RepoUrlPickerUiOptions {
-    allowedHosts?: string[];
-    allowedOrganizations?: string[];
-    allowedOwners?: string[];
-    allowedRepos?: string[];
-    requestUserCredentials?: {
-        secretsKey: string;
-        additionalScopes?: {
-            gerrit?: string[];
-            github?: string[];
-            gitlab?: string[];
-            bitbucket?: string[];
-            azure?: string[];
-        };
-    };
-}
+export declare type RepoUrlPickerUiOptions = typeof RepoUrlPickerFieldSchema.uiOptionsType;
+
+/**
+ * The props for the Last Step in scaffolder template form.
+ * Which represents the summary of the input provided by the end user.
+ *
+ * @public
+ */
+export declare type ReviewStepProps = {
+    disableButtons: boolean;
+    formData: JsonObject;
+    handleBack: () => void;
+    handleReset: () => void;
+    handleCreate: () => void;
+    steps: {
+        uiSchema: UiSchema;
+        mergedSchema: JsonObject;
+        schema: JsonObject;
+    }[];
+};
 
 /** @public */
 export declare const rootRouteRef: RouteRef<undefined>;
@@ -297,6 +405,7 @@ export declare const rootRouteRef: RouteRef<undefined>;
  */
 export declare type RouterProps = {
     components?: {
+        ReviewStepComponent?: ComponentType<ReviewStepProps>;
         TemplateCardComponent?: ComponentType<{
             template: TemplateEntityV1beta3;
         }> | undefined;

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-export { D as EntityNamePickerFieldExtension, C as EntityPickerFieldExtension, G as EntityTagsPickerFieldExtension, N as NextScaffolderPage, I as OwnedEntityPickerFieldExtension, H as OwnerPickerFieldExtension, J as RepoUrlPickerFieldExtension, x as ScaffolderClient, z as ScaffolderFieldExtensions, B as ScaffolderLayouts, K as ScaffolderPage, m as TaskPage, T as TemplateTypePicker, P as createNextScaffolderFieldExtension, y as createScaffolderFieldExtension, A as createScaffolderLayout, w as nextRouteRef, u as nextSelectedTemplateRouteRef, q as repoPickerValidation, f as rootRouteRef, c as scaffolderApiRef, M as scaffolderPlugin, s as selectedTemplateRouteRef, Q as useTemplateSecrets } from './esm/index-68c01d69.esm.js';
+export { M as EntityNamePickerFieldExtension, K as EntityPickerFieldExtension, _ as EntityPickerFieldSchema, N as EntityTagsPickerFieldExtension, a2 as EntityTagsPickerFieldSchema, X as NextScaffolderPage, Q as OwnedEntityPickerFieldExtension, a1 as OwnedEntityPickerFieldSchema, P as OwnerPickerFieldExtension, $ as OwnerPickerFieldSchema, U as RepoUrlPickerFieldExtension, a0 as RepoUrlPickerFieldSchema, D as ScaffolderClient, H as ScaffolderFieldExtensions, J as ScaffolderLayouts, V as ScaffolderPage, m as TaskPage, T as TemplateTypePicker, Y as createNextScaffolderFieldExtension, G as createScaffolderFieldExtension, I as createScaffolderLayout, Z as makeFieldSchemaFromZod, C as nextRouteRef, B as nextSelectedTemplateRouteRef, w as repoPickerValidation, f as rootRouteRef, c as scaffolderApiRef, W as scaffolderPlugin, s as selectedTemplateRouteRef, a3 as useTemplateSecrets } from './esm/index-ed1a1fba.esm.js';
 import '@backstage/catalog-model';
 import '@backstage/core-plugin-api';
 import '@backstage/errors';
@@ -10,6 +10,8 @@ import '@material-ui/core/FormControl';
 import '@material-ui/lab/Autocomplete';
 import 'react';
 import 'react-use/lib/useAsync';
+import 'zod';
+import 'zod-to-json-schema';
 import 'react-use/lib/useEffectOnce';
 import '@material-ui/lab';
 import '@backstage/integration-react';

package/dist/index.esm.js.map

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder",
   "description": "The Backstage plugin that helps you create new things",
-  "version": "1.8.0-next.1",
+  "version": "1.9.0-next.0",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -33,20 +33,20 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/catalog-client": "^1.1.2-next.0",
-    "@backstage/catalog-model": "^1.1.3-next.0",
-    "@backstage/config": "^1.0.4-next.0",
-    "@backstage/core-components": "^0.12.0-next.1",
-    "@backstage/core-plugin-api": "^1.1.0-next.0",
-    "@backstage/errors": "^1.1.3-next.0",
-    "@backstage/integration": "^1.4.0-next.0",
-    "@backstage/integration-react": "^1.1.6-next.1",
-    "@backstage/plugin-catalog-common": "^1.0.8-next.0",
-    "@backstage/plugin-catalog-react": "^1.2.1-next.1",
-    "@backstage/plugin-permission-react": "^0.4.7-next.0",
-    "@backstage/plugin-scaffolder-common": "^1.2.2-next.0",
+    "@backstage/catalog-client": "^1.2.0-next.0",
+    "@backstage/catalog-model": "^1.1.4-next.0",
+    "@backstage/config": "^1.0.5-next.0",
+    "@backstage/core-components": "^0.12.1-next.0",
+    "@backstage/core-plugin-api": "^1.1.1-next.0",
+    "@backstage/errors": "^1.1.4-next.0",
+    "@backstage/integration": "^1.4.1-next.0",
+    "@backstage/integration-react": "^1.1.7-next.0",
+    "@backstage/plugin-catalog-common": "^1.0.9-next.0",
+    "@backstage/plugin-catalog-react": "^1.2.2-next.0",
+    "@backstage/plugin-permission-react": "^0.4.8-next.0",
+    "@backstage/plugin-scaffolder-common": "^1.2.3-next.0",
     "@backstage/theme": "^0.2.16",
-    "@backstage/types": "^1.0.1-next.0",
+    "@backstage/types": "^1.0.2-next.0",
     "@codemirror/language": "^6.0.0",
     "@codemirror/legacy-modes": "^6.1.0",
     "@codemirror/view": "^6.0.0",
@@ -55,11 +55,11 @@
     "@material-ui/lab": "4.0.0-alpha.57",
     "@react-hookz/web": "^15.0.0",
     "@rjsf/core": "^3.2.1",
-    "@rjsf/core-v5": "npm:@rjsf/core@^5.0.0-beta.10",
+    "@rjsf/core-v5": "npm:@rjsf/core@^5.0.0-beta.12",
     "@rjsf/material-ui": "^3.2.1",
-    "@rjsf/material-ui-v5": "npm:@rjsf/material-ui@^5.0.0-beta.10",
-    "@rjsf/utils": "^5.0.0-beta.10",
-    "@rjsf/validator-ajv8": "^5.0.0-beta.10",
+    "@rjsf/material-ui-v5": "npm:@rjsf/material-ui@^5.0.0-beta.12",
+    "@rjsf/utils": "^5.0.0-beta.12",
+    "@rjsf/validator-ajv8": "^5.0.0-beta.12",
     "@types/json-schema": "^7.0.9",
     "@uiw/react-codemirror": "^4.9.3",
     "classnames": "^2.2.6",
@@ -74,7 +74,9 @@
     "react-use": "^17.2.4",
     "use-immer": "^0.7.0",
     "yaml": "^2.0.0",
-    "zen-observable": "^0.8.15"
+    "zen-observable": "^0.9.0",
+    "zod": "^3.11.6",
+    "zod-to-json-schema": "^3.18.1"
   },
   "peerDependencies": {
     "@types/react": "^16.13.1 || ^17.0.0",
@@ -83,11 +85,11 @@
     "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.21.0-next.1",
-    "@backstage/core-app-api": "^1.2.0-next.0",
-    "@backstage/dev-utils": "^1.0.8-next.1",
-    "@backstage/plugin-catalog": "^1.6.1-next.1",
-    "@backstage/test-utils": "^1.2.2-next.0",
+    "@backstage/cli": "^0.21.2-next.0",
+    "@backstage/core-app-api": "^1.2.1-next.0",
+    "@backstage/dev-utils": "^1.0.9-next.0",
+    "@backstage/plugin-catalog": "^1.6.2-next.0",
+    "@backstage/test-utils": "^1.2.3-next.0",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^12.1.3",
     "@testing-library/react-hooks": "^8.0.0",
@@ -96,7 +98,7 @@
     "@types/node": "^16.11.26",
     "cross-fetch": "^3.1.5",
     "event-source-polyfill": "1.0.25",
-    "msw": "^0.47.0"
+    "msw": "^0.49.0"
   },
   "files": [
     "dist",