@backstage/plugin-scaffolder 1.6.0-next.3 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @backstage/plugin-scaffolder
 
+## 1.6.0
+
+### Minor Changes
+
+- 3424a8075d: Added support for `async` validation for the `next` version of the plugin
+- ad036784e9: Ability to modify the layout of the step form
+- 192d856495: Implementing review step for the scaffolder under `create/next`
+
+### Patch Changes
+
+- 817f3196f6: Updated React Router dependencies to be peer dependencies.
+- eadf56bbbf: Bump `git-url-parse` version to `^13.0.0`
+- 9ffb75616d: Fix bug with empty strings in `EntityPicker`
+- 3f739be9d9: Minor API signatures cleanup
+- 763fb81e82: Internal refactor to use more type safe code when dealing with route parameters.
+- a66d44b72b: Fixing bug when the workspace would not be automatically saved when using `allowedOwners`
+- 7d47def9c4: Removed dependency on `@types/jest`.
+- 6522e459aa: Support displaying and ordering by counts in `EntityTagPicker` field. Add the `showCounts` option to enable this. Also support configuring `helperText`.
+- f0510a20b5: Addition of a dismissible Error Banner in Scaffolder page
+- 667d917488: Updated dependency `msw` to `^0.47.0`.
+- 87ec2ba4d6: Updated dependency `msw` to `^0.46.0`.
+- 9097278df2: Updated dependency `json-schema-library` to `^7.0.0`.
+- bf5e9030eb: Updated dependency `msw` to `^0.45.0`.
+- de336de9cd: fix uiSchema generation when using complex dependencies
+- Updated dependencies
+  - @backstage/core-components@0.11.1
+  - @backstage/core-plugin-api@1.0.6
+  - @backstage/plugin-catalog-react@1.1.4
+  - @backstage/plugin-permission-react@0.4.5
+  - @backstage/integration@1.3.1
+  - @backstage/catalog-client@1.1.0
+  - @backstage/catalog-model@1.1.1
+  - @backstage/config@1.0.2
+  - @backstage/errors@1.1.1
+  - @backstage/integration-react@1.1.4
+  - @backstage/plugin-scaffolder-common@1.2.0
+  - @backstage/plugin-catalog-common@1.0.6
+
 ## 1.6.0-next.3
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder",
-  "version": "1.6.0-next.3",
+  "version": "1.6.0",
   "main": "../dist/index.esm.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/esm/{Router-7a18bcf2.esm.js → Router-ad1d6fa2.esm.js}

@@ -3,7 +3,7 @@ import { useNavigate, Navigate, useOutlet, Routes, Route } from 'react-router';
 import { ItemCardHeader, MarkdownContent, Button, ContentHeader, Progress, WarningPanel, Link as Link$1, Content, ItemCardGrid, Page, Header, CreateButton, SupportButton, StructuredMetadataTable, InfoCard, ErrorPage, ErrorPanel, LogViewer, StatusError, StatusOK, StatusPending, Lifecycle, EmptyState, Table as Table$1 } from '@backstage/core-components';
 import { useRouteRef, useApi, errorApiRef, featureFlagsApiRef, useApiHolder, useRouteRefParams, alertApiRef, useElementFilter } from '@backstage/core-plugin-api';
 import { getEntityRelations, getEntitySourceLocation, FavoriteEntity, EntityRefLinks, useEntityList, EntityListProvider, CatalogFilterLayout, EntitySearchBar, EntityKindPicker, UserListPicker, EntityTagPicker, catalogApiRef, humanizeEntityRef, EntityRefLink } from '@backstage/plugin-catalog-react';
-import { s as selectedTemplateRouteRef, e as editRouteRef, a as actionsRouteRef, b as scaffolderListTaskRouteRef, r as registerComponentRouteRef, T as TemplateTypePicker, S as SecretsContext, c as scaffolderApiRef, d as scaffolderTaskRouteRef, f as rootRouteRef, g as TaskStatusStepper, h as TaskPageLinks, F as FIELD_EXTENSION_WRAPPER_KEY, i as FIELD_EXTENSION_KEY, l as legacySelectedTemplateRouteRef, j as SecretsContextProvider, k as TaskPage } from './index-3b8e3839.esm.js';
+import { s as selectedTemplateRouteRef, e as editRouteRef, a as actionsRouteRef, b as scaffolderListTaskRouteRef, r as registerComponentRouteRef, T as TemplateTypePicker, S as SecretsContext, c as scaffolderApiRef, d as scaffolderTaskRouteRef, f as rootRouteRef, g as TaskStatusStepper, h as TaskPageLinks, F as FIELD_EXTENSION_WRAPPER_KEY, i as FIELD_EXTENSION_KEY, L as LAYOUTS_WRAPPER_KEY, j as LAYOUTS_KEY, l as legacySelectedTemplateRouteRef, k as SecretsContextProvider, m as TaskPage } from './index-59f10b07.esm.js';
 import { RELATION_OWNED_BY, parseEntityRef, stringifyEntityRef } from '@backstage/catalog-model';
 import { makeStyles, useTheme, Card, CardMedia, CardContent, Box, Typography, Chip, CardActions, IconButton, Tooltip, Link, Stepper, Step, StepLabel, StepContent, Button as Button$1, Paper, LinearProgress, TableContainer, Table, TableHead, TableRow, TableCell, TableBody, Divider as Divider$1, FormControl, InputLabel, Select, MenuItem as MenuItem$1, List as List$2, ListItemIcon as ListItemIcon$1, ListItemText as ListItemText$1 } from '@material-ui/core';
 import { scmIntegrationsApiRef, ScmIntegrationIcon } from '@backstage/integration-react';
@@ -65,7 +65,7 @@ import SettingsIcon from '@material-ui/icons/Settings';
 import AllIcon from '@material-ui/icons/FontDownload';
 import { DateTime, Interval } from 'luxon';
 import humanizeDuration from 'humanize-duration';
-import { D as DEFAULT_SCAFFOLDER_FIELD_EXTENSIONS } from './default-77c6fe10.esm.js';
+import { D as DEFAULT_SCAFFOLDER_FIELD_EXTENSIONS } from './default-e3b0d980.esm.js';
 import '@backstage/errors';
 import 'zen-observable';
 import '@material-ui/core/FormControl';
@@ -439,12 +439,22 @@ function extractUiSchema(schema, uiSchema) {
     }
   }
 }
-function transformSchemaToProps(inputSchema) {
+function transformSchemaToProps(inputSchema, layouts = []) {
+  var _a;
+  const customLayoutName = inputSchema["ui:ObjectFieldTemplate"];
   inputSchema.type = inputSchema.type || "object";
   const schema = JSON.parse(JSON.stringify(inputSchema));
   delete schema.title;
   const uiSchema = {};
   extractUiSchema(schema, uiSchema);
+  if (customLayoutName) {
+    const Layout = (_a = layouts.find(
+      (layout) => layout.name === customLayoutName
+    )) == null ? void 0 : _a.component;
+    if (Layout) {
+      uiSchema["ui:ObjectFieldTemplate"] = Layout;
+    }
+  }
   return { schema, uiSchema };
 }
 
@@ -512,7 +522,8 @@ const MultistepJsonForm = (props) => {
     onFinish,
     fields,
     widgets,
-    finishButtonLabel
+    finishButtonLabel,
+    layouts
   } = props;
   const [activeStep, setActiveStep] = useState(0);
   const [disableButtons, setDisableButtons] = useState(false);
@@ -597,7 +608,7 @@ const MultistepJsonForm = (props) => {
           handleNext();
       },
       ...formProps,
-      ...transformSchemaToProps(schema)
+      ...transformSchemaToProps(schema, layouts)
     }, /* @__PURE__ */ React.createElement(Button$1, {
       disabled: activeStep === 0,
       onClick: handleBack
@@ -686,7 +697,8 @@ const useTemplateParameterSchema = (templateRef) => {
   return { schema: value, loading, error };
 };
 const TemplatePage = ({
-  customFieldExtensions = []
+  customFieldExtensions = [],
+  layouts = []
 }) => {
   const apiHolder = useApiHolder();
   const secretsContext = useContext(SecretsContext);
@@ -771,6 +783,7 @@ const TemplatePage = ({
     onChange: handleChange,
     onReset: handleFormReset,
     onFinish: handleCreate,
+    layouts,
     steps: schema.steps.map((step) => {
       return {
         ...step,
@@ -1763,7 +1776,8 @@ function TemplateEditorForm(props) {
     onUpdate,
     onDryRun,
     setErrorText,
-    fieldExtensions = []
+    fieldExtensions = [],
+    layouts = []
   } = props;
   const classes = useStyles$4();
   const apiHolder = useApiHolder();
@@ -1841,7 +1855,8 @@ function TemplateEditorForm(props) {
     onChange: (e) => onUpdate(e.formData),
     onReset: () => onUpdate({}),
     finishButtonLabel: onDryRun && "Try It",
-    onFinish: onDryRun && (() => onDryRun(data))
+    onFinish: onDryRun && (() => onDryRun(data)),
+    layouts
   }))));
 }
 function TemplateEditorFormDirectoryEditorDryRun(props) {
@@ -2022,7 +2037,8 @@ const TemplateEditor = (props) => {
     className: classes.preview
   }, /* @__PURE__ */ React.createElement(TemplateEditorForm.DirectoryEditorDryRun, {
     setErrorText,
-    fieldExtensions: props.fieldExtensions
+    fieldExtensions: props.fieldExtensions,
+    layouts: props.layouts
   })), /* @__PURE__ */ React.createElement("section", {
     className: classes.results
   }, /* @__PURE__ */ React.createElement(DryRunResults, null)))));
@@ -2094,7 +2110,8 @@ const useStyles$1 = makeStyles((theme) => ({
 const TemplateFormPreviewer = ({
   defaultPreviewTemplate = EXAMPLE_TEMPLATE_PARAMS_YAML,
   customFieldExtensions = [],
-  onClose
+  onClose,
+  layouts = []
 }) => {
   const classes = useStyles$1();
   const alertApi = useApi(alertApiRef);
@@ -2176,7 +2193,8 @@ const TemplateFormPreviewer = ({
     fieldExtensions: customFieldExtensions,
     data: formState,
     onUpdate: setFormState,
-    setErrorText
+    setErrorText,
+    layouts
   }))));
 };
 
@@ -2187,13 +2205,15 @@ function TemplateEditorPage(props) {
     content = /* @__PURE__ */ React.createElement(TemplateEditor, {
       directory: selection.directory,
       fieldExtensions: props.customFieldExtensions,
-      onClose: () => setSelection(void 0)
+      onClose: () => setSelection(void 0),
+      layouts: props.layouts
     });
   } else if ((selection == null ? void 0 : selection.type) === "form") {
     content = /* @__PURE__ */ React.createElement(TemplateFormPreviewer, {
       defaultPreviewTemplate: props.defaultPreviewTemplate,
       customFieldExtensions: props.customFieldExtensions,
-      onClose: () => setSelection(void 0)
+      onClose: () => setSelection(void 0),
+      layouts: props.layouts
     });
   } else {
     content = /* @__PURE__ */ React.createElement(Content, null, /* @__PURE__ */ React.createElement(TemplateEditorIntro, {
@@ -2461,6 +2481,14 @@ const Router = (props) => {
       )
     )
   ];
+  const customLayouts = useElementFilter(
+    outlet,
+    (elements) => elements.selectByComponentData({
+      key: LAYOUTS_WRAPPER_KEY
+    }).findComponentData({
+      key: LAYOUTS_KEY
+    })
+  );
   const RedirectingComponent = () => {
     const { templateName } = useRouteRefParams(legacySelectedTemplateRouteRef);
     const newLink = useRouteRef(selectedTemplateRouteRef);
@@ -2487,7 +2515,8 @@ const Router = (props) => {
   }), /* @__PURE__ */ React.createElement(Route, {
     path: selectedTemplateRouteRef.path,
     element: /* @__PURE__ */ React.createElement(SecretsContextProvider, null, /* @__PURE__ */ React.createElement(TemplatePage, {
-      customFieldExtensions: fieldExtensions
+      customFieldExtensions: fieldExtensions,
+      layouts: customLayouts
     }))
   }), /* @__PURE__ */ React.createElement(Route, {
     path: scaffolderListTaskRouteRef.path,
@@ -2502,7 +2531,8 @@ const Router = (props) => {
     path: editRouteRef.path,
     element: /* @__PURE__ */ React.createElement(SecretsContextProvider, null, /* @__PURE__ */ React.createElement(TemplateEditorPage, {
       defaultPreviewTemplate,
-      customFieldExtensions: fieldExtensions
+      customFieldExtensions: fieldExtensions,
+      layouts: customLayouts
     }))
   }), /* @__PURE__ */ React.createElement(Route, {
     path: "preview",
@@ -2513,4 +2543,4 @@ const Router = (props) => {
 };
 
 export { Router };
-//# sourceMappingURL=Router-7a18bcf2.esm.js.map
+//# sourceMappingURL=Router-ad1d6fa2.esm.js.map