@backstage/plugin-scaffolder-react 1.7.1-next.2 → 1.8.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # @backstage/plugin-scaffolder-react
 
+## 1.8.0-next.0
+
+### Minor Changes
+
+- c56f1a2: Remove the old legacy exports from `/alpha`
+- 11b9a08: Introduced the first version of recoverable tasks.
+
+### Patch Changes
+
+- 0b0c6b6: Allow defining default output text to be shown
+- 6a74ffd: Updated dependency `@rjsf/utils` to `5.16.1`.
+  Updated dependency `@rjsf/core` to `5.16.1`.
+  Updated dependency `@rjsf/material-ui` to `5.16.1`.
+  Updated dependency `@rjsf/validator-ajv8` to `5.16.1`.
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.9.4-next.0
+  - @backstage/catalog-client@1.6.0-next.0
+  - @backstage/plugin-scaffolder-common@1.5.0-next.0
+  - @backstage/core-components@0.13.10
+  - @backstage/catalog-model@1.4.3
+  - @backstage/core-plugin-api@1.8.2
+  - @backstage/theme@0.5.0
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+
+## 1.7.1
+
+### Patch Changes
+
+- c28f281: Scaffolder form now shows a list of errors at the top of the form.
+- 0b9ce2b: Fix for a step with no properties
+- 98ac5ab: Updated dependency `@rjsf/utils` to `5.15.1`.
+  Updated dependency `@rjsf/core` to `5.15.1`.
+  Updated dependency `@rjsf/material-ui` to `5.15.1`.
+  Updated dependency `@rjsf/validator-ajv8` to `5.15.1`.
+- 4016f21: Remove some unused dependencies
+- d16f85f: Show first scaffolder output text by default
+- Updated dependencies
+  - @backstage/core-components@0.13.10
+  - @backstage/plugin-scaffolder-common@1.4.5
+  - @backstage/core-plugin-api@1.8.2
+  - @backstage/catalog-client@1.5.2
+  - @backstage/plugin-catalog-react@1.9.3
+  - @backstage/catalog-model@1.4.3
+  - @backstage/theme@0.5.0
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+
 ## 1.7.1-next.2
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-react",
-  "version": "1.7.1-next.2",
+  "version": "1.8.0-next.0",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/alpha.d.ts

@@ -4,8 +4,8 @@ import * as React from 'react';
 import React__default, { ComponentType, ReactNode, PropsWithChildren, ReactElement } from 'react';
 import { TemplatePresentationV1beta3, TemplateEntityV1beta3, TaskStep } from '@backstage/plugin-scaffolder-common';
 import { UiSchema, FieldValidation } from '@rjsf/utils';
-import { TemplateParameterSchema, FieldExtensionOptions, FormProps, ReviewStepProps, LayoutOptions, CustomFieldValidator, TemplateGroupFilter, ScaffolderTaskOutput, ScaffolderRJSFFormProps, ScaffolderStep, CustomFieldExtensionSchema, ScaffolderRJSFFieldProps, FieldExtensionComponent } from '@backstage/plugin-scaffolder-react';
-import { ApiHolder, IconComponent, Extension } from '@backstage/core-plugin-api';
+import { TemplateParameterSchema, FieldExtensionOptions, FormProps, ReviewStepProps, LayoutOptions, CustomFieldValidator, TemplateGroupFilter, ScaffolderTaskOutput, ScaffolderRJSFFormProps, ScaffolderStep } from '@backstage/plugin-scaffolder-react';
+import { ApiHolder, IconComponent } from '@backstage/core-plugin-api';
 
 /**
  * This is the parsed template schema that is returned from the {@link useTemplateSchema} hook.
@@ -285,43 +285,4 @@ declare const useTemplateParameterSchema: (templateRef: string) => {
  */
 declare const useFilteredSchemaProperties: (manifest: TemplateParameterSchema | undefined) => TemplateParameterSchema | undefined;
 
-/**
- * Field validation type for Custom Field Extensions.
- *
- * @alpha
- */
-type LegacyCustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation, context: {
-    apiHolder: ApiHolder;
-}) => void | Promise<void>;
-/**
- * Type for the Custom Field Extension with the
- * name and components and validation function.
- *
- * @alpha
- */
-type LegacyFieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
-    name: string;
-    component: (props: LegacyFieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
-    validation?: LegacyCustomFieldValidator<TFieldReturnValue>;
-    schema?: CustomFieldExtensionSchema;
-};
-/**
- * Type for field extensions and being able to type
- * incoming props easier.
- *
- * @alpha
- */
-interface LegacyFieldExtensionComponentProps<TFieldReturnValue, TUiOptions = unknown> extends ScaffolderRJSFFieldProps<TFieldReturnValue> {
-    uiSchema: ScaffolderRJSFFieldProps['uiSchema'] & {
-        'ui:options'?: TUiOptions;
-    };
-}
-
-/**
- * Method for creating field extensions that can be used in the scaffolder
- * frontend form.
- * @alpha
- */
-declare function createLegacyScaffolderFieldExtension<TReturnValue = unknown, TInputProps = unknown>(options: LegacyFieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
-
-export { DefaultTemplateOutputs, EmbeddableWorkflow, Form, FormValidation, LegacyCustomFieldValidator, LegacyFieldExtensionComponentProps, LegacyFieldExtensionOptions, ParsedTemplateSchema, ReviewState, ReviewStateProps, ScaffolderField, ScaffolderFieldProps, ScaffolderPageContextMenu, ScaffolderPageContextMenuProps, Stepper, StepperProps, TaskLogStream, TaskSteps, TaskStepsProps, TemplateCard, TemplateCardProps, TemplateCategoryPicker, TemplateGroup, TemplateGroupProps, TemplateGroups, TemplateGroupsProps, Workflow, WorkflowProps, createAsyncValidators, createFieldValidation, createLegacyScaffolderFieldExtension, extractSchemaFromStep, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };
+export { DefaultTemplateOutputs, EmbeddableWorkflow, Form, FormValidation, ParsedTemplateSchema, ReviewState, ReviewStateProps, ScaffolderField, ScaffolderFieldProps, ScaffolderPageContextMenu, ScaffolderPageContextMenuProps, Stepper, StepperProps, TaskLogStream, TaskSteps, TaskStepsProps, TemplateCard, TemplateCardProps, TemplateCategoryPicker, TemplateGroup, TemplateGroupProps, TemplateGroups, TemplateGroupsProps, Workflow, WorkflowProps, createAsyncValidators, createFieldValidation, extractSchemaFromStep, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };

package/dist/alpha.esm.js

@@ -1,4 +1,4 @@
-import { useApi, featureFlagsApiRef, useAnalytics, useApiHolder, useApp, errorApiRef, useRouteRef, alertApiRef, attachComponentData } from '@backstage/core-plugin-api';
+import { useApi, featureFlagsApiRef, useAnalytics, useApiHolder, useApp, errorApiRef, useRouteRef, alertApiRef } from '@backstage/core-plugin-api';
 import { makeStyles, FormControl, Typography, createStyles, Paper, List, ListItem, ListItemIcon, ListItemText, LinearProgress, Stepper as Stepper$1, Step, StepLabel, Button, useTheme, Card, CardContent, Grid, Box, Divider, Chip, CardActions, CircularProgress, StepButton, FormControlLabel, Checkbox, TextField } from '@material-ui/core';
 import React, { useState, useMemo, useCallback, useEffect } from 'react';
 import { Draft07 } from 'json-schema-library';
@@ -6,7 +6,7 @@ import { StructuredMetadataTable, MarkdownContent, ItemCardHeader, Link, UserIco
 import validator from '@rjsf/validator-ajv8';
 import qs from 'qs';
 import useAsync from 'react-use/lib/useAsync';
-import { s as scaffolderApiRef, S as SecretsContextProvider, a as FIELD_EXTENSION_KEY } from './esm/ref-6fdfc121.esm.js';
+import { s as scaffolderApiRef, S as SecretsContextProvider } from './esm/ref-e2ee478c.esm.js';
 import cloneDeep from 'lodash/cloneDeep';
 import { withTheme } from '@rjsf/core';
 import { getUiOptions, getTemplate } from '@rjsf/utils';
@@ -283,7 +283,7 @@ const useTemplateSchema = (manifest) => {
     const stepFeatureFlag = (_a = step.uiSchema["ui:backstage"]) == null ? void 0 : _a.featureFlag;
     return stepFeatureFlag ? featureFlags.isActive(stepFeatureFlag) : true;
   }).map((step) => {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const strippedSchema = {
       ...step,
       schema: {
@@ -292,9 +292,9 @@ const useTemplateSchema = (manifest) => {
         title: void 0
       }
     };
-    if ((_a = step.schema) == null ? void 0 : _a.properties) {
+    if (((_a = step.schema) == null ? void 0 : _a.properties) || !((_b = step.schema) == null ? void 0 : _b.dependencies)) {
       strippedSchema.schema.properties = Object.fromEntries(
-        Object.entries((_c = (_b = step.schema) == null ? void 0 : _b.properties) != null ? _c : []).filter(
+        Object.entries((_d = (_c = step.schema) == null ? void 0 : _c.properties) != null ? _d : {}).filter(
           ([key]) => {
             var _a2, _b2;
             const stepFeatureFlag = (_b2 = (_a2 = step.uiSchema[key]) == null ? void 0 : _a2["ui:backstage"]) == null ? void 0 : _b2.featureFlag;
@@ -1088,7 +1088,11 @@ const TextOutputs = (props) => {
         startIcon: /* @__PURE__ */ React.createElement(Icon, null),
         component: "div",
         color: "primary",
-        onClick: () => setIndex == null ? void 0 : setIndex(index !== i ? i : void 0),
+        onClick: () => {
+          if (index !== i) {
+            setIndex == null ? void 0 : setIndex(i);
+          }
+        },
         variant: index === i ? "outlined" : void 0
       },
       title
@@ -1098,25 +1102,36 @@ const TextOutputs = (props) => {
 
 const DefaultTemplateOutputs = (props) => {
   var _a, _b;
-  const [textOutputIndex, setTextOutputIndex] = useState();
+  const { output } = props;
+  const [textOutputIndex, setTextOutputIndex] = useState(
+    void 0
+  );
+  useEffect(() => {
+    if (textOutputIndex === void 0 && (output == null ? void 0 : output.text)) {
+      const defaultIndex = output.text.findIndex(
+        (t) => t.default
+      );
+      setTextOutputIndex(defaultIndex >= 0 ? defaultIndex : 0);
+    }
+  }, [textOutputIndex, output]);
   const textOutput = useMemo(
     () => {
-      var _a2, _b2;
-      return textOutputIndex !== void 0 ? (_b2 = (_a2 = props.output) == null ? void 0 : _a2.text) == null ? void 0 : _b2[textOutputIndex] : null;
+      var _a2;
+      return textOutputIndex !== void 0 ? (_a2 = output == null ? void 0 : output.text) == null ? void 0 : _a2[textOutputIndex] : null;
     },
-    [props.output, textOutputIndex]
+    [output, textOutputIndex]
   );
-  if (!props.output) {
+  if (!output) {
     return null;
   }
   return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(Box, { paddingBottom: 2 }, /* @__PURE__ */ React.createElement(Paper, null, /* @__PURE__ */ React.createElement(Box, { padding: 2, justifyContent: "center", display: "flex", gridGap: 16 }, /* @__PURE__ */ React.createElement(
     TextOutputs,
     {
-      output: props.output,
+      output,
       index: textOutputIndex,
       setIndex: setTextOutputIndex
     }
-  ), /* @__PURE__ */ React.createElement(LinkOutputs, { output: props.output })))), textOutput ? /* @__PURE__ */ React.createElement(Box, { paddingBottom: 2 }, /* @__PURE__ */ React.createElement(
+  ), /* @__PURE__ */ React.createElement(LinkOutputs, { output })))), textOutput ? /* @__PURE__ */ React.createElement(Box, { paddingBottom: 2 }, /* @__PURE__ */ React.createElement(
     InfoCard,
     {
       title: (_a = textOutput.title) != null ? _a : "Text Output",
@@ -1376,19 +1391,5 @@ function ScaffolderPageContextMenu(props) {
   ));
 }
 
-function createLegacyScaffolderFieldExtension(options) {
-  return {
-    expose() {
-      const FieldExtensionDataHolder = () => null;
-      attachComponentData(
-        FieldExtensionDataHolder,
-        FIELD_EXTENSION_KEY,
-        options
-      );
-      return FieldExtensionDataHolder;
-    }
-  };
-}
-
-export { DefaultTemplateOutputs, EmbeddableWorkflow, Form, ReviewState, ScaffolderField, ScaffolderPageContextMenu, Stepper, TaskLogStream, TaskSteps, TemplateCard, TemplateCategoryPicker, TemplateGroup, TemplateGroups, Workflow, createAsyncValidators, createFieldValidation, createLegacyScaffolderFieldExtension, extractSchemaFromStep, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };
+export { DefaultTemplateOutputs, EmbeddableWorkflow, Form, ReviewState, ScaffolderField, ScaffolderPageContextMenu, Stepper, TaskLogStream, TaskSteps, TemplateCard, TemplateCategoryPicker, TemplateGroup, TemplateGroups, Workflow, createAsyncValidators, createFieldValidation, extractSchemaFromStep, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };
 //# sourceMappingURL=alpha.esm.js.map