From 28ef8573346e2408ae75d5574f4cc26617359718 Mon Sep 17 00:00:00 2001 From: Paul Cowan Date: Fri, 20 Jan 2023 07:16:26 +0000 Subject: [PATCH] add deprecated changeset Signed-off-by: Paul Cowan --- .changeset/friendly-scissors-shop.md | 23 +++++++++++++++++++++++ plugins/scaffolder/src/next/types.ts | 21 +-------------------- 2 files changed, 24 insertions(+), 20 deletions(-) create mode 100644 .changeset/friendly-scissors-shop.md diff --git a/.changeset/friendly-scissors-shop.md b/.changeset/friendly-scissors-shop.md new file mode 100644 index 0000000000..9d3b1aa232 --- /dev/null +++ b/.changeset/friendly-scissors-shop.md @@ -0,0 +1,23 @@ +--- +'@backstage/plugin-scaffolder': minor +--- + +- **Deprecation** - Deprecated the following exports, please import them directly from `@backstage/plugin-scaffolder-react` instead + + ``` + createScaffolderLayout + ScaffolderLayouts + LayoutOptions + LayoutTemplate + ``` + +- **Deprecation** - Deprecated the `rootRouteRef` export, this should now be used from `scaffolderPlugin.routes.root` + +- The following `/alpha` types have removed from this package and moved to the `@backstage/plugin-scaffolder-react/alpha` package + + ``` + createScaffolderLayout + ScaffolderLayouts + LayoutOptions + LayoutTemplate + ``` diff --git a/plugins/scaffolder/src/next/types.ts b/plugins/scaffolder/src/next/types.ts index d23c073661..c2ee473d54 100644 --- a/plugins/scaffolder/src/next/types.ts +++ b/plugins/scaffolder/src/next/types.ts @@ -23,26 +23,7 @@ import type { FormProps as SchemaFormProps } from '@rjsf/core-v5'; /** - * The field template from `@rjsf/core` which is a react component that gets passed `@rjsf/core` field related props. - * - * @alpha - */ -export type NextLayoutTemplate = NonNullable< - SchemaFormProps['uiSchema'] ->['ui:ObjectFieldTemplate']; - -/** - * The type of layouts that is passed to the TemplateForms - * - * @alpha - */ -export interface NextLayoutOptions

{ - name: string; - component: NextLayoutTemplate

; -} - -/** - * Any `@rjsf/core` form properties that are publicly exposed to the `NextScaffolderpage` + * Any `@rjsf/core` form properties that are publicly exposed to the `NextScaffolderPage` * * @alpha * @deprecated use the import from {@link @backstage/plugin-scaffolder-react/alpha#FormProps} instead