From dc28726211315fe3f5a374b06ac151fe2fd204e0 Mon Sep 17 00:00:00 2001 From: blam Date: Fri, 30 Dec 2022 15:34:03 +0100 Subject: [PATCH] chore: fixing the deprecated export paths Signed-off-by: blam --- plugins/scaffolder/src/deprecated.ts | 195 +++++++++++++++++++++++++++ plugins/scaffolder/src/index.ts | 34 +---- 2 files changed, 196 insertions(+), 33 deletions(-) create mode 100644 plugins/scaffolder/src/deprecated.ts diff --git a/plugins/scaffolder/src/deprecated.ts b/plugins/scaffolder/src/deprecated.ts new file mode 100644 index 0000000000..64abbde7a4 --- /dev/null +++ b/plugins/scaffolder/src/deprecated.ts @@ -0,0 +1,195 @@ +/* + * Copyright 2022 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/* + * This file is here to re-export exports from the `@backage/plugin-scaffolder-react` package to keep backwards compatibility. + * But mark them as deprecated so that any import that is using these exports will be notified that they should use the `-react` package instead. + * It's a little awkward to get the deprecated notice to show up in the API report, which is why it's all been extracted out to this file. + */ + +import { + createScaffolderFieldExtension as createScaffolderFieldExtensionTemp, + ScaffolderFieldExtensions as ScaffolderFieldExtensionsTemp, + rootRouteRef as rootRouteRefTemp, + selectedTemplateRouteRef as selectedTemplateRouteRefTemp, + useTemplateSecrets as useTemplateSecretsTemp, + scaffolderApiRef as scaffolderApiRefTemp, + type ScaffolderApi as ScaffolderApiTemp, + type ScaffolderUseTemplateSecrets as ScaffolderUseTemplateSecretsTemp, + type TemplateParameterSchema as TemplateParameterSchemaTemp, + type CustomFieldExtensionSchema as CustomFieldExtensionSchemaTemp, + type CustomFieldValidator as CustomFieldValidatorTemp, + type FieldExtensionOptions as FieldExtensionOptionsTemp, + type FieldExtensionComponentProps as FieldExtensionComponentPropsTemp, + type FieldExtensionComponent as FieldExtensionComponentTemp, + type ListActionsResponse as ListActionsResponseTemp, + type LogEvent as LogEventTemp, + type ScaffolderDryRunOptions as ScaffolderDryRunOptionsTemp, + type ScaffolderDryRunResponse as ScaffolderDryRunResponseTemp, + type ScaffolderGetIntegrationsListOptions as ScaffolderGetIntegrationsListOptionsTemp, + type ScaffolderGetIntegrationsListResponse as ScaffolderGetIntegrationsListResponseTemp, + type ScaffolderOutputLink as ScaffolderOutputLinkTemp, + type ScaffolderScaffoldOptions as ScaffolderScaffoldOptionsTemp, + type ScaffolderScaffoldResponse as ScaffolderScaffoldResponseTemp, + type ScaffolderStreamLogsOptions as ScaffolderStreamLogsOptionsTemp, + type ScaffolderTask as ScaffolderTaskTemp, + type ScaffolderTaskOutput as ScaffolderTaskOutputTemp, + type ScaffolderTaskStatus as ScaffolderTaskStatusTemp, +} from '@backstage/plugin-scaffolder-react'; + +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#createScaffolderFieldExtension} instead as this has now been moved. + */ +export const createScaffolderFieldExtension = + createScaffolderFieldExtensionTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderFieldExtensions} instead as this has now been moved. + */ +export const ScaffolderFieldExtensions = ScaffolderFieldExtensionsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#rootRouteRef} instead as this has now been moved. + */ +export const rootRouteRef = rootRouteRefTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#selectedTemplateRouteRef} instead as this has now been moved. + */ +export const selectedTemplateRouteRef = selectedTemplateRouteRefTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#useTemplateSecrets} instead as this has now been moved. + */ +export const useTemplateSecrets = useTemplateSecretsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#scaffolderApiRef} instead as this has now been moved. + */ +export const scaffolderApiRef = scaffolderApiRefTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderApi} instead as this has now been moved. + */ +export type ScaffolderApi = ScaffolderApiTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderUseTemplateSecrets} instead as this has now been moved. + */ +export type ScaffolderUseTemplateSecrets = ScaffolderUseTemplateSecretsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#TemplateParameterSchema} instead as this has now been moved. + */ +export type TemplateParameterSchema = TemplateParameterSchemaTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#CustomFieldExtensionSchema} instead as this has now been moved. + */ +export type CustomFieldExtensionSchema = CustomFieldExtensionSchemaTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#CustomFieldValidator} instead as this has now been moved. + */ +export type CustomFieldValidator = + CustomFieldValidatorTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#FieldExtensionOptions} instead as this has now been moved. + */ +export type FieldExtensionOptions = FieldExtensionOptionsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#FieldExtensionComponentProps} instead as this has now been moved. + */ +export type FieldExtensionComponentProps< + TFieldReturnValue, + TUiOptions extends {} = {}, +> = FieldExtensionComponentPropsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#FieldExtensionComponent} instead as this has now been moved. + */ +export type FieldExtensionComponent<_TReturnValue, _TInputProps> = + FieldExtensionComponentTemp<_TReturnValue, _TInputProps>; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ListActionsResponse} instead as this has now been moved. + */ +export type ListActionsResponse = ListActionsResponseTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#LogEvent} instead as this has now been moved. + */ +export type LogEvent = LogEventTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderDryRunOptions} instead as this has now been moved. + */ +export type ScaffolderDryRunOptions = ScaffolderDryRunOptionsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderDryRunResponse} instead as this has now been moved. + */ +export type ScaffolderDryRunResponse = ScaffolderDryRunResponseTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderGetIntegrationsListOptions} instead as this has now been moved. + */ +export type ScaffolderGetIntegrationsListOptions = + ScaffolderGetIntegrationsListOptionsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderGetIntegrationsListResponse} instead as this has now been moved. + */ +export type ScaffolderGetIntegrationsListResponse = + ScaffolderGetIntegrationsListResponseTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderOutputlink} instead as this has now been moved. + */ +export type ScaffolderOutputlink = ScaffolderOutputLinkTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderScaffoldOptions} instead as this has now been moved. + */ +export type ScaffolderScaffoldOptions = ScaffolderScaffoldOptionsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderScaffoldResponse} instead as this has now been moved. + */ +export type ScaffolderScaffoldResponse = ScaffolderScaffoldResponseTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderStreamLogsOptions} instead as this has now been moved. + */ +export type ScaffolderStreamLogsOptions = ScaffolderStreamLogsOptionsTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderTask} instead as this has now been moved. + */ +export type ScaffolderTask = ScaffolderTaskTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderTaskOutput} instead as this has now been moved. + */ +export type ScaffolderTaskOutput = ScaffolderTaskOutputTemp; +/** + * @public + * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderTaskStatus} instead as this has now been moved. + */ +export type ScaffolderTaskStatus = ScaffolderTaskStatusTemp; diff --git a/plugins/scaffolder/src/index.ts b/plugins/scaffolder/src/index.ts index 85de61b667..c4abee4735 100644 --- a/plugins/scaffolder/src/index.ts +++ b/plugins/scaffolder/src/index.ts @@ -36,39 +36,7 @@ export { } from './plugin'; export * from './components'; -/** @deprecated - use imports from @backstage/plugin-scaffolder-react instead */ -export { - createScaffolderFieldExtension, - ScaffolderFieldExtensions, - rootRouteRef, - selectedTemplateRouteRef, - useTemplateSecrets, - scaffolderApiRef, - /** @deprecated - use imports from @backstage/plugin-scaffolder-react instead */ - type ScaffolderApi, - /** @deprecated */ - type ScaffolderUseTemplateSecrets, - /** @deprecated */ - type TemplateParameterSchema, - type CustomFieldExtensionSchema, - type CustomFieldValidator, - type FieldExtensionOptions, - type FieldExtensionComponentProps, - type FieldExtensionComponent, - type ListActionsResponse, - type LogEvent, - type ScaffolderDryRunOptions, - type ScaffolderDryRunResponse, - type ScaffolderGetIntegrationsListOptions, - type ScaffolderGetIntegrationsListResponse, - type ScaffolderOutputLink, - type ScaffolderScaffoldOptions, - type ScaffolderScaffoldResponse, - type ScaffolderStreamLogsOptions, - type ScaffolderTask, - type ScaffolderTaskOutput, - type ScaffolderTaskStatus, -} from '@backstage/plugin-scaffolder-react'; +export * from './deprecated'; export type { TaskPageProps } from './components/TaskPage';