@backstage/plugin-scaffolder-react 1.19.7 → 1.19.8-next.1

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @backstage/plugin-scaffolder-react
 
+## 1.19.8-next.1
+
+### Patch Changes
+
+- 004b5c1: Added back `formFieldsApiRef` and `ScaffolderFormFieldsApi` as alpha exports.
+- f598909: Added `scaffolderApiMock` test utility, exported from `@backstage/plugin-scaffolder-react/testUtils`.
+- Updated dependencies
+  - @backstage/catalog-client@1.14.0-next.1
+  - @backstage/plugin-catalog-react@2.1.0-next.1
+  - @backstage/frontend-test-utils@0.5.1-next.1
+  - @backstage/plugin-scaffolder-common@2.0.0-next.1
+  - @backstage/catalog-model@1.7.6
+  - @backstage/core-components@0.18.8-next.0
+  - @backstage/core-plugin-api@1.12.4-next.0
+  - @backstage/frontend-plugin-api@0.14.2-next.0
+  - @backstage/theme@0.7.2
+  - @backstage/types@1.2.2
+  - @backstage/version-bridge@1.0.12
+  - @backstage/plugin-permission-react@0.4.41-next.0
+
+## 1.19.8-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.14.2-next.0
+  - @backstage/catalog-client@1.13.1-next.0
+  - @backstage/plugin-catalog-react@2.0.1-next.0
+  - @backstage/catalog-model@1.7.6
+  - @backstage/core-components@0.18.8-next.0
+  - @backstage/core-plugin-api@1.12.4-next.0
+  - @backstage/theme@0.7.2
+  - @backstage/types@1.2.2
+  - @backstage/version-bridge@1.0.12
+  - @backstage/plugin-permission-react@0.4.41-next.0
+  - @backstage/plugin-scaffolder-common@1.7.7-next.0
+
 ## 1.19.7
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -1,3 +1,4 @@
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { TemplateParameterSchema, FieldExtensionOptions, FormProps, ReviewStepProps, LayoutOptions, CustomFieldValidator, TemplateGroupFilter, ScaffolderTaskOutput, ScaffolderRJSFFormProps, ScaffolderStep, FieldExtensionComponentProps, FieldSchema } from '@backstage/plugin-scaffolder-react';
 import { JsonObject, JsonValue } from '@backstage/types';
@@ -8,13 +9,19 @@ import { UiSchema, FieldValidation, WidgetProps } from '@rjsf/utils';
 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';
 import { z } from 'zod';
 
 /** @alpha */
 interface FormField {
     readonly $$type: '@backstage/scaffolder/FormField';
 }
+/** @alpha */
+interface ScaffolderFormFieldsApi {
+    loadFormFields(): Promise<FormField[]>;
+}
+
+/** @alpha */
+declare const formFieldsApiRef: _backstage_frontend_plugin_api.ApiRef<ScaffolderFormFieldsApi>;
 
 /**
  * This is the parsed template schema that is returned from the {@link useTemplateSchema} hook.
@@ -437,5 +444,5 @@ declare const scaffolderReactTranslationRef: _backstage_frontend_plugin_api.Tran
     readonly "templateOutputs.title": "Text Output";
 }>;
 
-export { DefaultTemplateOutputs, EmbeddableWorkflow, Form, FormDecoratorBlueprint, FormFieldBlueprint, ReviewState, ScaffolderField, ScaffolderPageContextMenu, SecretWidget, Stepper, TaskLogStream, TaskSteps, TemplateCard, TemplateCategoryPicker, TemplateGroup, TemplateGroups, Workflow, createAsyncValidators, createFieldValidation, createFormField, createScaffolderFormDecorator, extractSchemaFromStep, scaffolderReactTranslationRef, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };
-export type { BackstageOverrides, BackstageTemplateStepperClassKey, FormField, FormFieldExtensionData, FormValidation, ParsedTemplateSchema, ReviewStateProps, ScaffolderFieldProps, ScaffolderFormDecorator, ScaffolderFormDecoratorContext, ScaffolderPageContextMenuProps, ScaffolderReactComponentsNameToClassKey, ScaffolderReactTemplateCategoryPickerClassKey, StepperProps, TaskStepsProps, TemplateCardProps, TemplateGroupProps, TemplateGroupsProps, WorkflowProps };
+export { DefaultTemplateOutputs, EmbeddableWorkflow, Form, FormDecoratorBlueprint, FormFieldBlueprint, ReviewState, ScaffolderField, ScaffolderPageContextMenu, SecretWidget, Stepper, TaskLogStream, TaskSteps, TemplateCard, TemplateCategoryPicker, TemplateGroup, TemplateGroups, Workflow, createAsyncValidators, createFieldValidation, createFormField, createScaffolderFormDecorator, extractSchemaFromStep, formFieldsApiRef, scaffolderReactTranslationRef, useFilteredSchemaProperties, useFormDataFromQuery, useTemplateParameterSchema, useTemplateSchema };
+export type { BackstageOverrides, BackstageTemplateStepperClassKey, FormField, FormFieldExtensionData, FormValidation, ParsedTemplateSchema, ReviewStateProps, ScaffolderFieldProps, ScaffolderFormDecorator, ScaffolderFormDecoratorContext, ScaffolderFormFieldsApi, ScaffolderPageContextMenuProps, ScaffolderReactComponentsNameToClassKey, ScaffolderReactTemplateCategoryPickerClassKey, StepperProps, TaskStepsProps, TemplateCardProps, TemplateGroupProps, TemplateGroupsProps, WorkflowProps };

package/dist/alpha.esm.js

@@ -1,3 +1,4 @@
+export { formFieldsApiRef } from './next/api/index.esm.js';
 export { Stepper } from './next/components/Stepper/Stepper.esm.js';
 export { createAsyncValidators } from './next/components/Stepper/createAsyncValidators.esm.js';
 export { TemplateCard } from './next/components/TemplateCard/TemplateCard.esm.js';

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/next/api/index.esm.js

@@ -0,0 +1,8 @@
+import { createApiRef } from '@backstage/frontend-plugin-api';
+
+const formFieldsApiRef = createApiRef({
+  id: "plugin.scaffolder.form-fields-loader"
+});
+
+export { formFieldsApiRef };
+//# sourceMappingURL=index.esm.js.map

package/dist/next/api/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../../../src/next/api/index.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 */\n\nimport { createApiRef } from '@backstage/frontend-plugin-api';\nimport { ScaffolderFormFieldsApi } from './types';\n\nexport { type FormField, type ScaffolderFormFieldsApi } from './types';\n\n/** @alpha */\nexport const formFieldsApiRef = createApiRef<ScaffolderFormFieldsApi>({\n  id: 'plugin.scaffolder.form-fields-loader',\n});\n"],"names":[],"mappings":";;AAsBO,MAAM,mBAAmB,YAAA,CAAsC;AAAA,EACpE,EAAA,EAAI;AACN,CAAC;;;;"}

package/dist/testUtils/scaffolderApiMock.esm.js

@@ -0,0 +1,23 @@
+import { createApiMock } from '@backstage/frontend-test-utils';
+import { scaffolderApiRef } from '../api/ref.esm.js';
+
+var scaffolderApiMock;
+((scaffolderApiMock2) => {
+  scaffolderApiMock2.mock = createApiMock(scaffolderApiRef, () => ({
+    getTemplateParameterSchema: jest.fn(),
+    scaffold: jest.fn(),
+    getTask: jest.fn(),
+    cancelTask: jest.fn(),
+    retry: jest.fn(),
+    listTasks: jest.fn(),
+    getIntegrationsList: jest.fn(),
+    listActions: jest.fn(),
+    listTemplatingExtensions: jest.fn(),
+    streamLogs: jest.fn(),
+    dryRun: jest.fn(),
+    autocomplete: jest.fn()
+  }));
+})(scaffolderApiMock || (scaffolderApiMock = {}));
+
+export { scaffolderApiMock };
+//# sourceMappingURL=scaffolderApiMock.esm.js.map

package/dist/testUtils/scaffolderApiMock.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffolderApiMock.esm.js","sources":["../../src/testUtils/scaffolderApiMock.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { createApiMock } from '@backstage/frontend-test-utils';\nimport { scaffolderApiRef } from '../api/ref';\n\n/**\n * A collection of mock functionality for the scaffolder API.\n *\n * @public\n */\nexport namespace scaffolderApiMock {\n  /**\n   * Creates a scaffolder API whose methods are mock functions, possibly with\n   * some of them overloaded by the caller.\n   */\n  export const mock = createApiMock(scaffolderApiRef, () => ({\n    getTemplateParameterSchema: jest.fn(),\n    scaffold: jest.fn(),\n    getTask: jest.fn(),\n    cancelTask: jest.fn(),\n    retry: jest.fn(),\n    listTasks: jest.fn(),\n    getIntegrationsList: jest.fn(),\n    listActions: jest.fn(),\n    listTemplatingExtensions: jest.fn(),\n    streamLogs: jest.fn(),\n    dryRun: jest.fn(),\n    autocomplete: jest.fn(),\n  }));\n}\n"],"names":["scaffolderApiMock"],"mappings":";;;AAwBO,IAAU;AAAA,CAAV,CAAUA,kBAAAA,KAAV;AAKE,EAAMA,kBAAAA,CAAA,IAAA,GAAO,aAAA,CAAc,gBAAA,EAAkB,OAAO;AAAA,IACzD,0BAAA,EAA4B,KAAK,EAAA,EAAG;AAAA,IACpC,QAAA,EAAU,KAAK,EAAA,EAAG;AAAA,IAClB,OAAA,EAAS,KAAK,EAAA,EAAG;AAAA,IACjB,UAAA,EAAY,KAAK,EAAA,EAAG;AAAA,IACpB,KAAA,EAAO,KAAK,EAAA,EAAG;AAAA,IACf,SAAA,EAAW,KAAK,EAAA,EAAG;AAAA,IACnB,mBAAA,EAAqB,KAAK,EAAA,EAAG;AAAA,IAC7B,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,IACrB,wBAAA,EAA0B,KAAK,EAAA,EAAG;AAAA,IAClC,UAAA,EAAY,KAAK,EAAA,EAAG;AAAA,IACpB,MAAA,EAAQ,KAAK,EAAA,EAAG;AAAA,IAChB,YAAA,EAAc,KAAK,EAAA;AAAG,GACxB,CAAE,CAAA;AAAA,CAAA,EAlBa,iBAAA,KAAA,iBAAA,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/testUtils.d.ts

@@ -0,0 +1,17 @@
+import * as _backstage_frontend_test_utils from '@backstage/frontend-test-utils';
+import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
+
+/**
+ * A collection of mock functionality for the scaffolder API.
+ *
+ * @public
+ */
+declare namespace scaffolderApiMock {
+    /**
+     * Creates a scaffolder API whose methods are mock functions, possibly with
+     * some of them overloaded by the caller.
+     */
+    const mock: (partialImpl?: Partial<_backstage_plugin_scaffolder_common.ScaffolderApi> | undefined) => _backstage_frontend_test_utils.ApiMock<_backstage_plugin_scaffolder_common.ScaffolderApi>;
+}
+
+export { scaffolderApiMock };

package/dist/testUtils.esm.js

@@ -0,0 +1,2 @@
+export { scaffolderApiMock } from './testUtils/scaffolderApiMock.esm.js';
+//# sourceMappingURL=testUtils.esm.js.map

package/dist/testUtils.esm.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-react",
-  "version": "1.19.7",
+  "version": "1.19.8-next.1",
   "description": "A frontend library that helps other Backstage plugins interact with the Scaffolder",
   "backstage": {
     "role": "web-library",
@@ -39,6 +39,11 @@
       "types": "./dist/alpha.d.ts",
       "default": "./dist/alpha.esm.js"
     },
+    "./testUtils": {
+      "import": "./dist/testUtils.esm.js",
+      "types": "./dist/testUtils.d.ts",
+      "default": "./dist/testUtils.esm.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.esm.js",
@@ -48,6 +53,9 @@
       "alpha": [
         "dist/alpha.d.ts"
       ],
+      "testUtils": [
+        "dist/testUtils.d.ts"
+      ],
       "package.json": [
         "package.json"
       ]
@@ -66,17 +74,17 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "^1.13.0",
-    "@backstage/catalog-model": "^1.7.6",
-    "@backstage/core-components": "^0.18.7",
-    "@backstage/core-plugin-api": "^1.12.3",
-    "@backstage/frontend-plugin-api": "^0.14.0",
-    "@backstage/plugin-catalog-react": "^2.0.0",
-    "@backstage/plugin-permission-react": "^0.4.40",
-    "@backstage/plugin-scaffolder-common": "^1.7.6",
-    "@backstage/theme": "^0.7.2",
-    "@backstage/types": "^1.2.2",
-    "@backstage/version-bridge": "^1.0.12",
+    "@backstage/catalog-client": "1.14.0-next.1",
+    "@backstage/catalog-model": "1.7.6",
+    "@backstage/core-components": "0.18.8-next.0",
+    "@backstage/core-plugin-api": "1.12.4-next.0",
+    "@backstage/frontend-plugin-api": "0.14.2-next.0",
+    "@backstage/plugin-catalog-react": "2.1.0-next.1",
+    "@backstage/plugin-permission-react": "0.4.41-next.0",
+    "@backstage/plugin-scaffolder-common": "2.0.0-next.1",
+    "@backstage/theme": "0.7.2",
+    "@backstage/types": "1.2.2",
+    "@backstage/version-bridge": "1.0.12",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -104,13 +112,13 @@
     "zod-to-json-schema": "^3.25.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.35.4",
-    "@backstage/core-app-api": "^1.19.5",
-    "@backstage/frontend-test-utils": "^0.5.0",
-    "@backstage/plugin-catalog": "^1.33.0",
-    "@backstage/plugin-catalog-common": "^1.1.8",
-    "@backstage/plugin-permission-common": "^0.9.6",
-    "@backstage/test-utils": "^1.7.15",
+    "@backstage/cli": "0.36.0-next.1",
+    "@backstage/core-app-api": "1.19.6-next.0",
+    "@backstage/frontend-test-utils": "0.5.1-next.1",
+    "@backstage/plugin-catalog": "1.34.0-next.1",
+    "@backstage/plugin-catalog-common": "1.1.8",
+    "@backstage/plugin-permission-common": "0.9.6",
+    "@backstage/test-utils": "1.7.16-next.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
@@ -123,12 +131,16 @@
     "swr": "^2.0.0"
   },
   "peerDependencies": {
+    "@backstage/frontend-test-utils": "0.5.1-next.1",
     "@types/react": "^17.0.0 || ^18.0.0",
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0",
     "react-router-dom": "^6.30.2"
   },
   "peerDependenciesMeta": {
+    "@backstage/frontend-test-utils": {
+      "optional": true
+    },
     "@types/react": {
       "optional": true
     }