From becf03a94ba59b8722a3b31448fd960b357a6d57 Mon Sep 17 00:00:00 2001 From: blam Date: Fri, 30 Dec 2022 12:17:25 +0100 Subject: [PATCH] chore: moving the `scaffolderApiRef` and types to `-react` Signed-off-by: blam --- plugins/scaffolder-react/src/api/index.ts | 17 +++++++++ plugins/scaffolder-react/src/api/ref.ts | 22 +++++++++++ .../src => scaffolder-react/src/api}/types.ts | 3 +- plugins/scaffolder-react/src/index.ts | 1 + plugins/scaffolder/src/api.ts | 14 +------ .../ActionsPage/ActionsPage.test.tsx | 8 ++-- .../components/ActionsPage/ActionsPage.tsx | 2 +- .../ListTasksPage/ListTaskPage.test.tsx | 8 ++-- .../ListTasksPage/ListTasksPage.tsx | 8 ++-- .../columns/TemplateTitleColumn.test.tsx | 6 ++- .../columns/TemplateTitleColumn.tsx | 2 +- .../src/components/TaskPage/TaskPage.tsx | 3 +- .../src/components/TaskPage/TaskPageLinks.tsx | 2 +- .../TemplateEditorPage/DryRunContext.tsx | 6 ++- .../DryRunResults/DryRunResults.test.tsx | 2 +- .../DryRunResults/DryRunResultsList.test.tsx | 2 +- .../DryRunResults/DryRunResultsView.test.tsx | 2 +- .../TemplatePage/TemplatePage.test.tsx | 8 ++-- .../components/TemplatePage/TemplatePage.tsx | 2 +- .../RepoUrlPicker/RepoUrlPicker.test.tsx | 4 +- .../RepoUrlPicker/RepoUrlPickerHost.test.tsx | 2 +- .../RepoUrlPicker/RepoUrlPickerHost.tsx | 2 +- .../src/components/hooks/useEventStream.ts | 4 +- plugins/scaffolder/src/index.ts | 37 ++++++++++--------- .../TemplateWizardPage.test.tsx | 9 +++-- .../TemplateWizardPage/TemplateWizardPage.tsx | 2 +- plugins/scaffolder/src/plugin.tsx | 3 +- yarn.lock | 1 + 28 files changed, 116 insertions(+), 66 deletions(-) create mode 100644 plugins/scaffolder-react/src/api/index.ts create mode 100644 plugins/scaffolder-react/src/api/ref.ts rename plugins/{scaffolder/src => scaffolder-react/src/api}/types.ts (98%) diff --git a/plugins/scaffolder-react/src/api/index.ts b/plugins/scaffolder-react/src/api/index.ts new file mode 100644 index 0000000000..fa8d758afb --- /dev/null +++ b/plugins/scaffolder-react/src/api/index.ts @@ -0,0 +1,17 @@ +/* + * 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. + */ +export * from './ref'; +export * from './types'; diff --git a/plugins/scaffolder-react/src/api/ref.ts b/plugins/scaffolder-react/src/api/ref.ts new file mode 100644 index 0000000000..bf0a5faddf --- /dev/null +++ b/plugins/scaffolder-react/src/api/ref.ts @@ -0,0 +1,22 @@ +/* + * 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. + */ + +import { createApiRef } from '@backstage/core-plugin-api'; +import { ScaffolderApi } from './types'; + +export const scaffolderApiRef = createApiRef({ + id: 'plugin.scaffolder.service', +}); diff --git a/plugins/scaffolder/src/types.ts b/plugins/scaffolder-react/src/api/types.ts similarity index 98% rename from plugins/scaffolder/src/types.ts rename to plugins/scaffolder-react/src/api/types.ts index 0bde515bda..554dc08ef5 100644 --- a/plugins/scaffolder/src/types.ts +++ b/plugins/scaffolder-react/src/api/types.ts @@ -14,9 +14,9 @@ * limitations under the License. */ import { TaskSpec, TaskStep } from '@backstage/plugin-scaffolder-common'; -import { TemplateParameterSchema } from '@backstage/plugin-scaffolder-react'; import { JsonObject, JsonValue, Observable } from '@backstage/types'; import { JSONSchema7 } from 'json-schema'; +import { TemplateParameterSchema } from '../types'; /** * The status of each task in a Scaffolder Job @@ -156,7 +156,6 @@ export interface ScaffolderDryRunResponse { steps: TaskStep[]; output: ScaffolderTaskOutput; } - /** * An API to interact with the scaffolder backend. * diff --git a/plugins/scaffolder-react/src/index.ts b/plugins/scaffolder-react/src/index.ts index e6395f151b..14bcb1e44f 100644 --- a/plugins/scaffolder-react/src/index.ts +++ b/plugins/scaffolder-react/src/index.ts @@ -18,5 +18,6 @@ export * from './routes'; export * from './extensions'; export * from './types'; export * from './secrets'; +export * from './api'; export * from './next'; diff --git a/plugins/scaffolder/src/api.ts b/plugins/scaffolder/src/api.ts index 3a60f6b9a9..515496a363 100644 --- a/plugins/scaffolder/src/api.ts +++ b/plugins/scaffolder/src/api.ts @@ -16,7 +16,6 @@ import { parseEntityRef } from '@backstage/catalog-model'; import { - createApiRef, DiscoveryApi, FetchApi, IdentityApi, @@ -38,20 +37,11 @@ import { ScaffolderTask, ScaffolderDryRunOptions, ScaffolderDryRunResponse, -} from './types'; + TemplateParameterSchema, +} from '@backstage/plugin-scaffolder-react'; -import { TemplateParameterSchema } from '@backstage/plugin-scaffolder-react'; import queryString from 'qs'; -/** - * Utility API reference for the {@link ScaffolderApi}. - * - * @public - */ -export const scaffolderApiRef = createApiRef({ - id: 'plugin.scaffolder.service', -}); - /** * An API to interact with the scaffolder backend. * diff --git a/plugins/scaffolder/src/components/ActionsPage/ActionsPage.test.tsx b/plugins/scaffolder/src/components/ActionsPage/ActionsPage.test.tsx index ee94c5ecd3..a049959ae4 100644 --- a/plugins/scaffolder/src/components/ActionsPage/ActionsPage.test.tsx +++ b/plugins/scaffolder/src/components/ActionsPage/ActionsPage.test.tsx @@ -14,12 +14,14 @@ * limitations under the License. */ import React from 'react'; -import { scaffolderApiRef } from '../../api'; import { ActionsPage } from './ActionsPage'; -import { rootRouteRef } from '@backstage/plugin-scaffolder-react'; +import { + rootRouteRef, + scaffolderApiRef, + ScaffolderApi, +} from '@backstage/plugin-scaffolder-react'; import { renderInTestApp, TestApiRegistry } from '@backstage/test-utils'; import { ApiProvider } from '@backstage/core-app-api'; -import { ScaffolderApi } from '../../types'; const scaffolderApiMock: jest.Mocked = { scaffold: jest.fn(), diff --git a/plugins/scaffolder/src/components/ActionsPage/ActionsPage.tsx b/plugins/scaffolder/src/components/ActionsPage/ActionsPage.tsx index 1fca434a96..50ec86f2f5 100644 --- a/plugins/scaffolder/src/components/ActionsPage/ActionsPage.tsx +++ b/plugins/scaffolder/src/components/ActionsPage/ActionsPage.tsx @@ -15,7 +15,7 @@ */ import React from 'react'; import useAsync from 'react-use/lib/useAsync'; -import { scaffolderApiRef } from '../../api'; +import { scaffolderApiRef } from '@backstage/plugin-scaffolder-react'; import { Typography, Paper, diff --git a/plugins/scaffolder/src/components/ListTasksPage/ListTaskPage.test.tsx b/plugins/scaffolder/src/components/ListTasksPage/ListTaskPage.test.tsx index 7188aed082..4843d9bcc0 100644 --- a/plugins/scaffolder/src/components/ListTasksPage/ListTaskPage.test.tsx +++ b/plugins/scaffolder/src/components/ListTasksPage/ListTaskPage.test.tsx @@ -24,9 +24,11 @@ import { import React from 'react'; import { identityApiRef } from '@backstage/core-plugin-api'; import { ListTasksPage } from './ListTasksPage'; -import { ScaffolderApi } from '../../types'; -import { scaffolderApiRef } from '../../api'; -import { rootRouteRef } from '@backstage/plugin-scaffolder-react'; +import { + rootRouteRef, + scaffolderApiRef, + ScaffolderApi, +} from '@backstage/plugin-scaffolder-react'; import { act, fireEvent } from '@testing-library/react'; describe('', () => { diff --git a/plugins/scaffolder/src/components/ListTasksPage/ListTasksPage.tsx b/plugins/scaffolder/src/components/ListTasksPage/ListTasksPage.tsx index 0685b42a59..68dcedc99f 100644 --- a/plugins/scaffolder/src/components/ListTasksPage/ListTasksPage.tsx +++ b/plugins/scaffolder/src/components/ListTasksPage/ListTasksPage.tsx @@ -28,9 +28,11 @@ import { useApi, useRouteRef } from '@backstage/core-plugin-api'; import { CatalogFilterLayout } from '@backstage/plugin-catalog-react'; import useAsync from 'react-use/lib/useAsync'; import React, { useState } from 'react'; -import { scaffolderApiRef } from '../../api'; -import { rootRouteRef } from '@backstage/plugin-scaffolder-react'; -import { ScaffolderTask } from '../../types'; +import { + rootRouteRef, + ScaffolderTask, + scaffolderApiRef, +} from '@backstage/plugin-scaffolder-react'; import { OwnerListPicker } from './OwnerListPicker'; import { CreatedAtColumn, diff --git a/plugins/scaffolder/src/components/ListTasksPage/columns/TemplateTitleColumn.test.tsx b/plugins/scaffolder/src/components/ListTasksPage/columns/TemplateTitleColumn.test.tsx index 3dc20312aa..bf06c09436 100644 --- a/plugins/scaffolder/src/components/ListTasksPage/columns/TemplateTitleColumn.test.tsx +++ b/plugins/scaffolder/src/components/ListTasksPage/columns/TemplateTitleColumn.test.tsx @@ -18,9 +18,11 @@ import { renderInTestApp, TestApiProvider } from '@backstage/test-utils'; import React from 'react'; import { TemplateTitleColumn } from './TemplateTitleColumn'; -import { scaffolderApiRef } from '../../../api'; -import { ScaffolderApi } from '../../../types'; import { entityRouteRef } from '@backstage/plugin-catalog-react'; +import { + scaffolderApiRef, + ScaffolderApi, +} from '@backstage/plugin-scaffolder-react'; describe('', () => { const scaffolderApiMock: jest.Mocked = { diff --git a/plugins/scaffolder/src/components/ListTasksPage/columns/TemplateTitleColumn.tsx b/plugins/scaffolder/src/components/ListTasksPage/columns/TemplateTitleColumn.tsx index 0561b40392..cbac929a33 100644 --- a/plugins/scaffolder/src/components/ListTasksPage/columns/TemplateTitleColumn.tsx +++ b/plugins/scaffolder/src/components/ListTasksPage/columns/TemplateTitleColumn.tsx @@ -15,7 +15,7 @@ */ import { useApi } from '@backstage/core-plugin-api'; import React from 'react'; -import { scaffolderApiRef } from '../../../api'; +import { scaffolderApiRef } from '@backstage/plugin-scaffolder-react'; import useAsync from 'react-use/lib/useAsync'; import { parseEntityRef } from '@backstage/catalog-model'; import { EntityRefLink } from '@backstage/plugin-catalog-react'; diff --git a/plugins/scaffolder/src/components/TaskPage/TaskPage.tsx b/plugins/scaffolder/src/components/TaskPage/TaskPage.tsx index 42f6e6fd30..02f27bd0c0 100644 --- a/plugins/scaffolder/src/components/TaskPage/TaskPage.tsx +++ b/plugins/scaffolder/src/components/TaskPage/TaskPage.tsx @@ -51,8 +51,9 @@ import { rootRouteRef, scaffolderTaskRouteRef, selectedTemplateRouteRef, + ScaffolderTaskStatus, + ScaffolderTaskOutput, } from '@backstage/plugin-scaffolder-react'; -import { ScaffolderTaskStatus, ScaffolderTaskOutput } from '../../types'; import { useTaskEventStream } from '../hooks/useEventStream'; import { TaskErrors } from './TaskErrors'; import { TaskPageLinks } from './TaskPageLinks'; diff --git a/plugins/scaffolder/src/components/TaskPage/TaskPageLinks.tsx b/plugins/scaffolder/src/components/TaskPage/TaskPageLinks.tsx index 78d6a452ea..59c1515b79 100644 --- a/plugins/scaffolder/src/components/TaskPage/TaskPageLinks.tsx +++ b/plugins/scaffolder/src/components/TaskPage/TaskPageLinks.tsx @@ -19,7 +19,7 @@ import { entityRouteRef } from '@backstage/plugin-catalog-react'; import { Box } from '@material-ui/core'; import LanguageIcon from '@material-ui/icons/Language'; import React from 'react'; -import { ScaffolderTaskOutput } from '../../types'; +import { ScaffolderTaskOutput } from '@backstage/plugin-scaffolder-react'; import { IconLink } from './IconLink'; import { IconComponent, useApp, useRouteRef } from '@backstage/core-plugin-api'; diff --git a/plugins/scaffolder/src/components/TemplateEditorPage/DryRunContext.tsx b/plugins/scaffolder/src/components/TemplateEditorPage/DryRunContext.tsx index 3534b62c39..a617eebe1e 100644 --- a/plugins/scaffolder/src/components/TemplateEditorPage/DryRunContext.tsx +++ b/plugins/scaffolder/src/components/TemplateEditorPage/DryRunContext.tsx @@ -26,8 +26,10 @@ import React, { useRef, useState, } from 'react'; -import { scaffolderApiRef } from '../../api'; -import { ScaffolderDryRunResponse } from '../../types'; +import { + scaffolderApiRef, + ScaffolderDryRunResponse, +} from '@backstage/plugin-scaffolder-react'; const MAX_CONTENT_SIZE = 64 * 1024; const CHUNK_SIZE = 32 * 1024; diff --git a/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResults.test.tsx b/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResults.test.tsx index bc3354cc46..0267093ee6 100644 --- a/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResults.test.tsx +++ b/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResults.test.tsx @@ -18,7 +18,7 @@ import { renderInTestApp, TestApiProvider } from '@backstage/test-utils'; import { act, screen, waitFor } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React, { useEffect } from 'react'; -import { scaffolderApiRef } from '../../../api'; +import { scaffolderApiRef } from '@backstage/plugin-scaffolder-react'; import { DryRunProvider, useDryRun } from '../DryRunContext'; import { DryRunResults } from './DryRunResults'; diff --git a/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResultsList.test.tsx b/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResultsList.test.tsx index 417c23c483..706f284db1 100644 --- a/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResultsList.test.tsx +++ b/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResultsList.test.tsx @@ -18,7 +18,7 @@ import { renderInTestApp, TestApiProvider } from '@backstage/test-utils'; import { act, screen } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React, { useEffect } from 'react'; -import { scaffolderApiRef } from '../../../api'; +import { scaffolderApiRef } from '@backstage/plugin-scaffolder-react'; import { DryRunProvider, useDryRun } from '../DryRunContext'; import { DryRunResultsList } from './DryRunResultsList'; diff --git a/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResultsView.test.tsx b/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResultsView.test.tsx index c709adfd68..c2d8d3a2a4 100644 --- a/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResultsView.test.tsx +++ b/plugins/scaffolder/src/components/TemplateEditorPage/DryRunResults/DryRunResultsView.test.tsx @@ -19,7 +19,7 @@ import { renderInTestApp, TestApiProvider } from '@backstage/test-utils'; import { screen } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React, { ReactNode, useEffect } from 'react'; -import { scaffolderApiRef } from '../../../api'; +import { scaffolderApiRef } from '@backstage/plugin-scaffolder-react'; import { DryRunProvider, useDryRun } from '../DryRunContext'; import { DryRunResultsView } from './DryRunResultsView'; diff --git a/plugins/scaffolder/src/components/TemplatePage/TemplatePage.test.tsx b/plugins/scaffolder/src/components/TemplatePage/TemplatePage.test.tsx index 7b54d047e7..5de29c42a5 100644 --- a/plugins/scaffolder/src/components/TemplatePage/TemplatePage.test.tsx +++ b/plugins/scaffolder/src/components/TemplatePage/TemplatePage.test.tsx @@ -22,9 +22,11 @@ import { import { act, fireEvent, screen, within } from '@testing-library/react'; import React from 'react'; import { Route, Routes } from 'react-router-dom'; -import { scaffolderApiRef } from '../../api'; -import { ScaffolderApi } from '../../types'; -import { rootRouteRef } from '@backstage/plugin-scaffolder-react'; +import { + rootRouteRef, + scaffolderApiRef, + ScaffolderApi, +} from '@backstage/plugin-scaffolder-react'; import { TemplatePage } from './TemplatePage'; import { featureFlagsApiRef, diff --git a/plugins/scaffolder/src/components/TemplatePage/TemplatePage.tsx b/plugins/scaffolder/src/components/TemplatePage/TemplatePage.tsx index 1c0994db10..08254491ce 100644 --- a/plugins/scaffolder/src/components/TemplatePage/TemplatePage.tsx +++ b/plugins/scaffolder/src/components/TemplatePage/TemplatePage.tsx @@ -19,13 +19,13 @@ import qs from 'qs'; import React, { ComponentType, useCallback, useContext, useState } from 'react'; import { Navigate, useNavigate } from 'react-router-dom'; import useAsync from 'react-use/lib/useAsync'; -import { scaffolderApiRef } from '../../api'; import { rootRouteRef, scaffolderTaskRouteRef, selectedTemplateRouteRef, FieldExtensionOptions, SecretsContext, + scaffolderApiRef, } from '@backstage/plugin-scaffolder-react'; import { MultistepJsonForm } from '../MultistepJsonForm'; import { createValidator } from './createValidator'; diff --git a/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPicker.test.tsx b/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPicker.test.tsx index 32991f3757..1cf8d91059 100644 --- a/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPicker.test.tsx +++ b/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPicker.test.tsx @@ -23,12 +23,12 @@ import { scmAuthApiRef, ScmAuthApi, } from '@backstage/integration-react'; -import { scaffolderApiRef } from '../../../api'; -import { ScaffolderApi } from '../../../types'; import { SecretsContextProvider, SecretsContext, + scaffolderApiRef, + ScaffolderApi, } from '@backstage/plugin-scaffolder-react'; import { act, fireEvent } from '@testing-library/react'; diff --git a/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPickerHost.test.tsx b/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPickerHost.test.tsx index bd71fb160f..0c7ca75990 100644 --- a/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPickerHost.test.tsx +++ b/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPickerHost.test.tsx @@ -16,7 +16,7 @@ import React from 'react'; import { RepoUrlPickerHost } from './RepoUrlPickerHost'; import { renderInTestApp, TestApiProvider } from '@backstage/test-utils'; -import { scaffolderApiRef } from '../../../api'; +import { scaffolderApiRef } from '@backstage/plugin-scaffolder-react'; import { fireEvent, within } from '@testing-library/react'; describe('RepoUrlPickerHostField', () => { diff --git a/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPickerHost.tsx b/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPickerHost.tsx index b9762cd69d..5a78cf6195 100644 --- a/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPickerHost.tsx +++ b/plugins/scaffolder/src/components/fields/RepoUrlPicker/RepoUrlPickerHost.tsx @@ -18,7 +18,7 @@ import { Progress, Select, SelectItem } from '@backstage/core-components'; import FormControl from '@material-ui/core/FormControl'; import FormHelperText from '@material-ui/core/FormHelperText'; import { useApi } from '@backstage/core-plugin-api'; -import { scaffolderApiRef } from '../../../api'; +import { scaffolderApiRef } from '@backstage/plugin-scaffolder-react'; import useAsync from 'react-use/lib/useAsync'; export const RepoUrlPickerHost = (props: { diff --git a/plugins/scaffolder/src/components/hooks/useEventStream.ts b/plugins/scaffolder/src/components/hooks/useEventStream.ts index bb24c0d612..0b36c85ad8 100644 --- a/plugins/scaffolder/src/components/hooks/useEventStream.ts +++ b/plugins/scaffolder/src/components/hooks/useEventStream.ts @@ -15,13 +15,13 @@ */ import { useImmerReducer } from 'use-immer'; import { useEffect } from 'react'; -import { scaffolderApiRef } from '../../api'; import { ScaffolderTask, ScaffolderTaskStatus, ScaffolderTaskOutput, LogEvent, -} from '../../types'; + scaffolderApiRef, +} from '@backstage/plugin-scaffolder-react'; import { useApi } from '@backstage/core-plugin-api'; import { Subscription } from '@backstage/types'; diff --git a/plugins/scaffolder/src/index.ts b/plugins/scaffolder/src/index.ts index a23324646f..85de61b667 100644 --- a/plugins/scaffolder/src/index.ts +++ b/plugins/scaffolder/src/index.ts @@ -20,23 +20,7 @@ * @packageDocumentation */ -export { scaffolderApiRef, ScaffolderClient } from './api'; -export type { - ListActionsResponse, - LogEvent, - ScaffolderApi, - ScaffolderDryRunOptions, - ScaffolderDryRunResponse, - ScaffolderGetIntegrationsListOptions, - ScaffolderGetIntegrationsListResponse, - ScaffolderOutputLink, - ScaffolderScaffoldOptions, - ScaffolderScaffoldResponse, - ScaffolderStreamLogsOptions, - ScaffolderTask, - ScaffolderTaskOutput, - ScaffolderTaskStatus, -} from './types'; +export { ScaffolderClient } from './api'; export { createScaffolderLayout, ScaffolderLayouts } from './layouts'; export type { LayoutOptions, LayoutTemplate, LayoutComponent } from './layouts'; @@ -52,19 +36,38 @@ 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 type { TaskPageProps } from './components/TaskPage'; diff --git a/plugins/scaffolder/src/next/TemplateWizardPage/TemplateWizardPage.test.tsx b/plugins/scaffolder/src/next/TemplateWizardPage/TemplateWizardPage.test.tsx index 854cfc6545..52b6451862 100644 --- a/plugins/scaffolder/src/next/TemplateWizardPage/TemplateWizardPage.test.tsx +++ b/plugins/scaffolder/src/next/TemplateWizardPage/TemplateWizardPage.test.tsx @@ -22,9 +22,12 @@ import { } from '@backstage/test-utils'; import { act, fireEvent } from '@testing-library/react'; import React from 'react'; -import { scaffolderApiRef } from '../../api'; -import { nextRouteRef, rootRouteRef } from '@backstage/plugin-scaffolder-react'; -import { ScaffolderApi } from '../../types'; +import { + nextRouteRef, + rootRouteRef, + ScaffolderApi, + scaffolderApiRef, +} from '@backstage/plugin-scaffolder-react'; import { TemplateWizardPage } from './TemplateWizardPage'; jest.mock('react-router-dom', () => { diff --git a/plugins/scaffolder/src/next/TemplateWizardPage/TemplateWizardPage.tsx b/plugins/scaffolder/src/next/TemplateWizardPage/TemplateWizardPage.tsx index 9ee5e89cab..d2ef72d4ae 100644 --- a/plugins/scaffolder/src/next/TemplateWizardPage/TemplateWizardPage.tsx +++ b/plugins/scaffolder/src/next/TemplateWizardPage/TemplateWizardPage.tsx @@ -31,7 +31,7 @@ import { useRouteRef, useRouteRefParams, } from '@backstage/core-plugin-api'; -import { scaffolderApiRef } from '../../api'; +import { scaffolderApiRef } from '@backstage/plugin-scaffolder-react'; import useAsync from 'react-use/lib/useAsync'; import { makeStyles } from '@material-ui/core'; import { BackstageTheme } from '@backstage/theme'; diff --git a/plugins/scaffolder/src/plugin.tsx b/plugins/scaffolder/src/plugin.tsx index 5049f8a050..5bbe51dd2d 100644 --- a/plugins/scaffolder/src/plugin.tsx +++ b/plugins/scaffolder/src/plugin.tsx @@ -21,8 +21,9 @@ import { rootRouteRef, viewTechDocRouteRef, createScaffolderFieldExtension, + scaffolderApiRef, } from '@backstage/plugin-scaffolder-react'; -import { scaffolderApiRef, ScaffolderClient } from './api'; +import { ScaffolderClient } from './api'; import { EntityPicker, EntityPickerSchema, diff --git a/yarn.lock b/yarn.lock index 00f8355d8b..371902d90e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -22430,6 +22430,7 @@ __metadata: "@backstage/plugin-playlist": "workspace:^" "@backstage/plugin-rollbar": "workspace:^" "@backstage/plugin-scaffolder": "workspace:^" + "@backstage/plugin-scaffolder-react": "workspace:^" "@backstage/plugin-search": "workspace:^" "@backstage/plugin-search-common": "workspace:^" "@backstage/plugin-search-react": "workspace:^"