@backstage/plugin-scaffolder 0.12.2-next.0 → 0.13.0

package/dist/esm/{index-71578268.esm.js → index-7ce19edf.esm.js}

@@ -1,14 +1,14 @@
+import { parseEntityRef, KubernetesValidatorFunctions, makeValidator, RELATION_OWNED_BY, stringifyEntityRef } from '@backstage/catalog-model';
 import { createApiRef, useApi, attachComponentData, createExternalRouteRef, createRouteRef, createPlugin, createApiFactory, discoveryApiRef, fetchApiRef, createRoutableExtension, useRouteRef, alertApiRef, useApp } from '@backstage/core-plugin-api';
 import { ResponseError } from '@backstage/errors';
 import qs from 'qs';
 import ObservableImpl from 'zen-observable';
-import { catalogApiRef, formatEntityRefTitle, useOwnedEntities, useStarredEntity, getEntityRelations, getEntitySourceLocation, EntityRefLinks, useEntityListProvider, useEntityTypeFilter, entityRouteRef } from '@backstage/plugin-catalog-react';
+import { catalogApiRef, formatEntityRefTitle, useOwnedEntities, useStarredEntity, getEntityRelations, getEntitySourceLocation, EntityRefLinks, useEntityList, useEntityTypeFilter, entityRouteRef } from '@backstage/plugin-catalog-react';
 import { TextField, FormControl as FormControl$1, withStyles, makeStyles, IconButton, Tooltip, useTheme, Card, CardMedia, CardContent, Box, Typography, Chip, CardActions, Link, FormControlLabel, Checkbox, Grid, StepButton, Paper, Button as Button$1, CircularProgress } from '@material-ui/core';
 import FormControl from '@material-ui/core/FormControl';
 import Autocomplete from '@material-ui/lab/Autocomplete';
 import React, { useCallback, useEffect, useState, createContext, useContext, useMemo, memo } from 'react';
 import useAsync from 'react-use/lib/useAsync';
-import { KubernetesValidatorFunctions, makeValidator, RELATION_OWNED_BY, stringifyEntityRef, parseEntityName } from '@backstage/catalog-model';
 import useEffectOnce from 'react-use/lib/useEffectOnce';
 import { Autocomplete as Autocomplete$1 } from '@material-ui/lab';
 import { scmIntegrationsApiRef, scmAuthApiRef, ScmIntegrationIcon } from '@backstage/integration-react';
@@ -52,15 +52,20 @@ class ScaffolderClient {
     this.useLongPollingLogs = (_b = options.useLongPollingLogs) != null ? _b : false;
   }
   async getIntegrationsList(options) {
-    return [
+    const integrations = [
       ...this.scmIntegrationsApi.azure.list(),
       ...this.scmIntegrationsApi.bitbucket.list(),
       ...this.scmIntegrationsApi.github.list(),
       ...this.scmIntegrationsApi.gitlab.list()
     ].map((c) => ({ type: c.type, title: c.title, host: c.config.host })).filter((c) => options.allowedHosts.includes(c.host));
+    return {
+      integrations
+    };
   }
-  async getTemplateParameterSchema(templateName) {
-    const { namespace, kind, name } = templateName;
+  async getTemplateParameterSchema(templateRef) {
+    const { namespace, kind, name } = parseEntityRef(templateRef, {
+      defaultKind: "template"
+    });
     const baseUrl = await this.discoveryApi.getBaseUrl("scaffolder");
     const templatePath = [namespace, kind, name].map((s) => encodeURIComponent(s)).join("/");
     const url = `${baseUrl}/v2/templates/${templatePath}/parameter-schema`;
@@ -71,7 +76,8 @@ class ScaffolderClient {
     const schema = await response.json();
     return schema;
   }
-  async scaffold(templateName, values, secrets = {}) {
+  async scaffold(options) {
+    const { templateRef, values, secrets = {} } = options;
     const url = `${await this.discoveryApi.getBaseUrl("scaffolder")}/v2/tasks`;
     const response = await this.fetchApi.fetch(url, {
       method: "POST",
@@ -79,7 +85,7 @@ class ScaffolderClient {
         "Content-Type": "application/json"
       },
       body: JSON.stringify({
-        templateName,
+        templateRef,
         values: { ...values },
         secrets
       })
@@ -90,7 +96,7 @@ class ScaffolderClient {
       throw new Error(`Backend request failed, ${status} ${body.trim()}`);
     }
     const { id } = await response.json();
-    return id;
+    return { taskId: id };
   }
   async getTask(taskId) {
     const baseUrl = await this.discoveryApi.getBaseUrl("scaffolder");
@@ -184,20 +190,17 @@ class ScaffolderClient {
   }
 }
 
-const allowArbitraryValues = (uiSchema) => {
-  var _a, _b;
-  return (_b = (_a = uiSchema["ui:options"]) == null ? void 0 : _a.allowArbitraryValues) != null ? _b : true;
-};
-const EntityPicker = ({
-  onChange,
-  schema: { title = "Entity", description = "An entity from the catalog" },
-  required,
-  uiSchema,
-  rawErrors,
-  formData,
-  idSchema
-}) => {
-  var _a, _b;
+const EntityPicker = (props) => {
+  var _a, _b, _c, _d;
+  const {
+    onChange,
+    schema: { title = "Entity", description = "An entity from the catalog" },
+    required,
+    uiSchema,
+    rawErrors,
+    formData,
+    idSchema
+  } = props;
   const allowedKinds = (_a = uiSchema["ui:options"]) == null ? void 0 : _a.allowedKinds;
   const defaultKind = (_b = uiSchema["ui:options"]) == null ? void 0 : _b.defaultKind;
   const catalogApi = useApi(catalogApiRef);
@@ -223,7 +226,7 @@ const EntityPicker = ({
     onChange: onSelect,
     options: entityRefs || [],
     autoSelect: true,
-    freeSolo: allowArbitraryValues(uiSchema),
+    freeSolo: (_d = (_c = uiSchema["ui:options"]) == null ? void 0 : _c.allowArbitraryValues) != null ? _d : true,
     renderInput: (params) => /* @__PURE__ */ React.createElement(TextField, {
       ...params,
       label: title,
@@ -236,35 +239,30 @@ const EntityPicker = ({
   }));
 };
 
-const TextValuePicker = ({
-  onChange,
-  required,
-  schema: { title, description },
-  rawErrors,
-  formData,
-  uiSchema: { "ui:autofocus": autoFocus },
-  idSchema,
-  placeholder
-}) => /* @__PURE__ */ React.createElement(TextField, {
-  id: idSchema == null ? void 0 : idSchema.$id,
-  label: title,
-  placeholder,
-  helperText: description,
-  required,
-  value: formData != null ? formData : "",
-  onChange: ({ target: { value } }) => onChange(value),
-  margin: "normal",
-  error: (rawErrors == null ? void 0 : rawErrors.length) > 0 && !formData,
-  inputProps: { autoFocus }
-});
-
-const EntityNamePicker = ({
-  schema: { title = "Name", description = "Unique name of the component" },
-  ...props
-}) => /* @__PURE__ */ React.createElement(TextValuePicker, {
-  schema: { title, description },
-  ...props
-});
+const EntityNamePicker = (props) => {
+  const {
+    onChange,
+    required,
+    schema: { title = "Name", description = "Unique name of the component" },
+    rawErrors,
+    formData,
+    uiSchema: { "ui:autofocus": autoFocus },
+    idSchema,
+    placeholder
+  } = props;
+  return /* @__PURE__ */ React.createElement(TextField, {
+    id: idSchema == null ? void 0 : idSchema.$id,
+    label: title,
+    placeholder,
+    helperText: description,
+    required,
+    value: formData != null ? formData : "",
+    onChange: ({ target: { value } }) => onChange(value),
+    margin: "normal",
+    error: (rawErrors == null ? void 0 : rawErrors.length) > 0 && !formData,
+    inputProps: { autoFocus }
+  });
+};
 
 const entityNamePickerValidation = (value, validation) => {
   if (!KubernetesValidatorFunctions.isValidObjectName(value)) {
@@ -272,12 +270,9 @@ const entityNamePickerValidation = (value, validation) => {
   }
 };
 
-const EntityTagsPicker = ({
-  formData,
-  onChange,
-  uiSchema
-}) => {
+const EntityTagsPicker = (props) => {
   var _a;
+  const { formData, onChange, uiSchema } = props;
   const catalogApi = useApi(catalogApiRef);
   const [inputValue, setInputValue] = useState("");
   const [inputError, setInputError] = useState(false);
@@ -334,12 +329,13 @@ const EntityTagsPicker = ({
   }));
 };
 
-const OwnerPicker = ({
-  schema: { title = "Owner", description = "The owner of the component" },
-  uiSchema,
-  ...props
-}) => {
+const OwnerPicker = (props) => {
   var _a;
+  const {
+    schema: { title = "Owner", description = "The owner of the component" },
+    uiSchema,
+    ...restProps
+  } = props;
   const ownerUiSchema = {
     ...uiSchema,
     "ui:options": {
@@ -351,7 +347,7 @@ const OwnerPicker = ({
     }
   };
   return /* @__PURE__ */ React.createElement(EntityPicker, {
-    ...props,
+    ...restProps,
     schema: { title, description },
     uiSchema: ownerUiSchema
   });
@@ -502,7 +498,7 @@ const BitbucketRepoPicker = (props) => {
 const RepoUrlPickerHost = (props) => {
   const { host, hosts, onChange, rawErrors } = props;
   const scaffolderApi = useApi(scaffolderApiRef);
-  const { value: integrations, loading } = useAsync(async () => {
+  const { value: { integrations } = { integrations: [] }, loading } = useAsync(async () => {
     return await scaffolderApi.getIntegrationsList({
       allowedHosts: hosts != null ? hosts : []
     });
@@ -700,16 +696,17 @@ const repoPickerValidation = (value, validation, context) => {
   }
 };
 
-const OwnedEntityPicker = ({
-  onChange,
-  schema: { title = "Entity", description = "An entity from the catalog" },
-  required,
-  uiSchema,
-  rawErrors,
-  formData,
-  idSchema
-}) => {
+const OwnedEntityPicker = (props) => {
   var _a, _b;
+  const {
+    onChange,
+    schema: { title = "Entity", description = "An entity from the catalog" },
+    required,
+    uiSchema,
+    rawErrors,
+    formData,
+    idSchema
+  } = props;
   const allowedKinds = (_a = uiSchema["ui:options"]) == null ? void 0 : _a.allowedKinds;
   const defaultKind = (_b = uiSchema["ui:options"]) == null ? void 0 : _b.defaultKind;
   const { ownedEntities, loading } = useOwnedEntities(allowedKinds);
@@ -807,7 +804,7 @@ const OwnerPickerFieldExtension = scaffolderPlugin.provide(createScaffolderField
 }));
 const ScaffolderPage = scaffolderPlugin.provide(createRoutableExtension({
   name: "ScaffolderPage",
-  component: () => import('./Router-5df57206.esm.js').then((m) => m.Router),
+  component: () => import('./Router-8ca04a51.esm.js').then((m) => m.Router),
   mountPoint: rootRouteRef
 }));
 const OwnedEntityPickerFieldExtension = scaffolderPlugin.provide(createScaffolderFieldExtension({
@@ -906,13 +903,13 @@ const DeprecationWarning = () => {
   const styles = useDeprecationStyles();
   const Title = /* @__PURE__ */ React.createElement(Typography, {
     style: { padding: 10, maxWidth: 300 }
-  }, "This template syntax is deprecated. Click for more info.");
+  }, "This template uses a syntax that has been deprecated, and should be migrated to a newer syntax. Click for more info.");
   return /* @__PURE__ */ React.createElement("div", {
     className: styles.deprecationIcon
   }, /* @__PURE__ */ React.createElement(Tooltip, {
     title: Title
   }, /* @__PURE__ */ React.createElement(Link, {
-    href: "https://backstage.io/docs/features/software-templates/migrating-from-v1alpha1-to-v1beta2",
+    href: "https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3",
     className: styles.link
   }, /* @__PURE__ */ React.createElement(WarningIcon, null))));
 };
@@ -976,7 +973,7 @@ const TemplateList = ({
   TemplateCardComponent,
   group
 }) => {
-  const { loading, error, entities } = useEntityListProvider();
+  const { loading, error, entities } = useEntityList();
   const Card = TemplateCardComponent || TemplateCard;
   const maybeFilteredEntities = group ? entities.filter((e) => group.filter(e)) : entities;
   const title = group ? group.titleComponent || /* @__PURE__ */ React.createElement(ContentHeader, {
@@ -995,7 +992,8 @@ const TemplateList = ({
     to: "https://backstage.io/docs/features/software-templates/adding-templates"
   }, "adding templates"), "."), /* @__PURE__ */ React.createElement(Content, null, title, /* @__PURE__ */ React.createElement(ItemCardGrid, null, maybeFilteredEntities && (maybeFilteredEntities == null ? void 0 : maybeFilteredEntities.length) > 0 && maybeFilteredEntities.map((template) => /* @__PURE__ */ React.createElement(Card, {
     key: stringifyEntityRef(template),
-    template
+    template,
+    deprecated: template.apiVersion === "backstage.io/v1beta2"
   })))));
 };
 
@@ -1223,7 +1221,7 @@ const TaskPageLinks = ({ output }) => {
     pb: 3
   }, links.filter(({ url, entityRef }) => url || entityRef).map(({ url, entityRef, title, icon }) => {
     if (entityRef) {
-      const entityName = parseEntityName(entityRef);
+      const entityName = parseEntityRef(entityRef);
       const target = entityRoute(entityName);
       return { title, icon, url: target };
     }
@@ -1357,7 +1355,11 @@ const TaskStatusStepper = memo(({
     })))));
   })));
 });
-const hasLinks = ({ entityRef, remoteUrl, links = [] }) => !!(entityRef || remoteUrl || links.length > 0);
+const hasLinks = ({
+  entityRef,
+  remoteUrl,
+  links = []
+}) => !!(entityRef || remoteUrl || links.length > 0);
 const TaskPage = ({ loadingText }) => {
   const classes = useStyles();
   const navigate = useNavigate();
@@ -1400,15 +1402,17 @@ const TaskPage = ({ loadingText }) => {
   const taskNotFound = taskStream.completed === true && taskStream.loading === false && !taskStream.task;
   const { output } = taskStream;
   const handleStartOver = () => {
-    var _a, _b;
-    if (!taskStream.task || !((_b = (_a = taskStream.task) == null ? void 0 : _a.spec.metadata) == null ? void 0 : _b.name)) {
+    var _a, _b, _c;
+    if (!taskStream.task || !((_b = (_a = taskStream.task) == null ? void 0 : _a.spec.templateInfo) == null ? void 0 : _b.entityRef)) {
       navigate(generatePath(rootLink()));
+      return;
     }
     const formData = taskStream.task.spec.apiVersion === "backstage.io/v1beta2" ? taskStream.task.spec.values : taskStream.task.spec.parameters;
+    const { name } = parseEntityRef((_c = taskStream.task.spec.templateInfo) == null ? void 0 : _c.entityRef);
     navigate(generatePath(`${rootLink()}/templates/:templateName?${qs.stringify({
       formData: JSON.stringify(formData)
     })}`, {
-      templateName: taskStream.task.spec.metadata.name
+      templateName: name
     }));
   };
   return /* @__PURE__ */ React.createElement(Page, {
@@ -1451,5 +1455,5 @@ const TaskPage = ({ loadingText }) => {
   })))))));
 };
 
-export { EntityPicker as E, FIELD_EXTENSION_WRAPPER_KEY as F, OwnerPicker as O, RepoUrlPicker as R, SecretsContext as S, TemplateTypePicker as T, EntityNamePicker as a, EntityTagsPicker as b, OwnedEntityPicker as c, registerComponentRouteRef as d, entityNamePickerValidation as e, TemplateList as f, rootRouteRef as g, FIELD_EXTENSION_KEY as h, SecretsContextProvider as i, TaskPage as j, ScaffolderClient as k, createScaffolderFieldExtension as l, ScaffolderFieldExtensions as m, EntityPickerFieldExtension as n, EntityNamePickerFieldExtension as o, EntityTagsPickerFieldExtension as p, OwnerPickerFieldExtension as q, repoPickerValidation as r, scaffolderApiRef as s, OwnedEntityPickerFieldExtension as t, RepoUrlPickerFieldExtension as u, ScaffolderPage as v, scaffolderPlugin as w, TextValuePicker as x, FavouriteTemplate as y, useTemplateSecrets as z };
-//# sourceMappingURL=index-71578268.esm.js.map
+export { EntityPicker as E, FIELD_EXTENSION_WRAPPER_KEY as F, OwnerPicker as O, RepoUrlPicker as R, SecretsContext as S, TemplateTypePicker as T, EntityNamePicker as a, EntityTagsPicker as b, OwnedEntityPicker as c, registerComponentRouteRef as d, entityNamePickerValidation as e, TemplateList as f, rootRouteRef as g, FIELD_EXTENSION_KEY as h, SecretsContextProvider as i, TaskPage as j, ScaffolderClient as k, createScaffolderFieldExtension as l, ScaffolderFieldExtensions as m, EntityPickerFieldExtension as n, EntityNamePickerFieldExtension as o, EntityTagsPickerFieldExtension as p, OwnerPickerFieldExtension as q, repoPickerValidation as r, scaffolderApiRef as s, OwnedEntityPickerFieldExtension as t, RepoUrlPickerFieldExtension as u, ScaffolderPage as v, scaffolderPlugin as w, FavouriteTemplate as x, useTemplateSecrets as y };
+//# sourceMappingURL=index-7ce19edf.esm.js.map