chore: deprecated routeRef exports

Signed-off-by: blam <ben@blam.sh>

plugins/scaffolder/api-report.md

@@ -53,9 +53,6 @@ import { TemplateParameterSchema as TemplateParameterSchema_2 } from '@backstage
 import { UiSchema } from '@rjsf/utils';
 import { z } from 'zod';
 
-// @public (undocumented)
-export const actionsRouteRef: SubRouteRef<undefined>;
-
 // @public @deprecated (undocumented)
 export const createScaffolderFieldExtension: typeof createScaffolderFieldExtension_2;
 
@@ -71,9 +68,6 @@ export type CustomFieldExtensionSchema = CustomFieldExtensionSchema_2;
 export type CustomFieldValidator<TReturnFieldData> =
   CustomFieldValidator_2<TReturnFieldData>;
 
-// @public (undocumented)
-export const editRouteRef: SubRouteRef<undefined>;
-
 // @public
 export const EntityNamePickerFieldExtension: FieldExtensionComponent_2<
   string,
@@ -181,11 +175,6 @@ export interface LayoutOptions<P = any> {
 // @public
 export type LayoutTemplate<T = any> = FormProps_2<T>['ObjectFieldTemplate'];
 
-// @public @deprecated (undocumented)
-export const legacySelectedTemplateRouteRef: SubRouteRef<
-  PathParams<'/templates/:templateName'>
->;
-
 // @public @deprecated (undocumented)
 export type ListActionsResponse = ListActionsResponse_2;
 
@@ -206,9 +195,6 @@ export function makeFieldSchemaFromZod<
     : never
 >;
 
-// @alpha (undocumented)
-export const nextRouteRef: RouteRef<undefined>;
-
 // @alpha
 export type NextRouterProps = {
   components?: {
@@ -226,16 +212,6 @@ export const NextScaffolderPage: (
   props: PropsWithChildren<NextRouterProps>,
 ) => JSX.Element;
 
-// @alpha (undocumented)
-export const nextScaffolderTaskRouteRef: SubRouteRef<
-  PathParams<'/tasks/:taskId'>
->;
-
-// @alpha (undocumented)
-export const nextSelectedTemplateRouteRef: SubRouteRef<
-  PathParams<'/templates/:namespace/:templateName'>
->;
-
 // @public
 export const OwnedEntityPickerFieldExtension: FieldExtensionComponent_2<
   string,
@@ -293,9 +269,6 @@ export const OwnerPickerFieldSchema: FieldSchema<
 // @public
 export type OwnerPickerUiOptions = typeof OwnerPickerFieldSchema.uiOptionsType;
 
-// @public (undocumented)
-export const registerComponentRouteRef: ExternalRouteRef<undefined, true>;
-
 // @public
 export const repoPickerValidation: (
   value: string,
@@ -470,9 +443,6 @@ export type ScaffolderGetIntegrationsListResponse =
 // @public
 export const ScaffolderLayouts: React.ComponentType;
 
-// @public (undocumented)
-export const scaffolderListTaskRouteRef: SubRouteRef<undefined>;
-
 // @public @deprecated (undocumented)
 export type ScaffolderOutputlink = ScaffolderOutputLink;
 
@@ -483,6 +453,15 @@ export const ScaffolderPage: (props: RouterProps) => JSX.Element;
 export const scaffolderPlugin: BackstagePlugin<
   {
     root: RouteRef<undefined>;
+    selectedTemplate: SubRouteRef<
+      PathParams<'/templates/:namespace/:templateName'>
+    >;
+    ongoingTask: SubRouteRef<PathParams<'/tasks/:taskId'>>;
+    next: RouteRef<undefined>;
+    nextSelectedTemplate: SubRouteRef<
+      PathParams<'/templates/:namespace/:templateName'>
+    >;
+    nextOngoingTask: SubRouteRef<PathParams<'/tasks/:taskId'>>;
   },
   {
     registerComponent: ExternalRouteRef<undefined, true>;
@@ -513,20 +492,12 @@ export type ScaffolderTask = ScaffolderTask_2;
 // @public @deprecated (undocumented)
 export type ScaffolderTaskOutput = ScaffolderTaskOutput_2;
 
-// @public (undocumented)
-export const scaffolderTaskRouteRef: SubRouteRef<PathParams<'/tasks/:taskId'>>;
-
 // @public @deprecated (undocumented)
 export type ScaffolderTaskStatus = ScaffolderTaskStatus_2;
 
 // @public @deprecated (undocumented)
 export type ScaffolderUseTemplateSecrets = ScaffolderUseTemplateSecrets_2;
 
-// @public (undocumented)
-export const selectedTemplateRouteRef: SubRouteRef<
-  PathParams<'/templates/:namespace/:templateName'>
->;
-
 // @public
 export const TaskPage: ({ loadingText }: TaskPageProps) => JSX.Element;
 
@@ -549,14 +520,4 @@ export const TemplateTypePicker: () => JSX.Element | null;
 
 // @public @deprecated (undocumented)
 export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets_2;
-
-// @public (undocumented)
-export const viewTechDocRouteRef: ExternalRouteRef<
-  {
-    name: string;
-    kind: string;
-    namespace: string;
-  },
-  true
->;
 ```

plugins/scaffolder/src/deprecated.ts

@@ -48,6 +48,13 @@ import {
   type ScaffolderTaskStatus as ScaffolderTaskStatusTemp,
 } from '@backstage/plugin-scaffolder-react';
 
+import { rootRouteRef as rootRouteRefTemp } from './routes';
+
+/**
+ * @public
+ * @deprecated use import from {@link @backstage/plugin-scaffolder#plugin.routes.root} instead.
+ */
+export const rootRouteRef = rootRouteRefTemp;
 /**
  * @public
  * @deprecated use import from {@link @backstage/plugin-scaffolder-react#createScaffolderFieldExtension} instead as this has now been moved.

plugins/scaffolder/src/index.ts

@@ -42,15 +42,12 @@ export {
 } from './plugin';
 
 export * from './components';
-export * from './routes';
+export { rootRouteRef } from './routes';
 export * from './deprecated';
 
 /** next exports */
 export { NextScaffolderPage } from './plugin';
 export {
-  nextRouteRef,
-  nextSelectedTemplateRouteRef,
-  nextScaffolderTaskRouteRef,
   type TemplateGroupFilter,
   type NextRouterProps,
   type FormProps,

plugins/scaffolder/src/plugin.tsx

@@ -58,8 +58,14 @@ import {
   registerComponentRouteRef,
   rootRouteRef,
   viewTechDocRouteRef,
+  selectedTemplateRouteRef,
+  scaffolderTaskRouteRef,
 } from './routes';
-import { nextRouteRef } from './next';
+import {
+  nextRouteRef,
+  nextSelectedTemplateRouteRef,
+  nextScaffolderTaskRouteRef,
+} from './next';
 
 /**
  * The main plugin export for the scaffolder.
@@ -87,6 +93,12 @@ export const scaffolderPlugin = createPlugin({
   ],
   routes: {
     root: rootRouteRef,
+    selectedTemplate: selectedTemplateRouteRef,
+    ongoingTask: scaffolderTaskRouteRef,
+    /** next routes */
+    next: nextRouteRef,
+    nextSelectedTemplate: nextSelectedTemplateRouteRef,
+    nextOngoingTask: nextScaffolderTaskRouteRef,
   },
   externalRoutes: {
     registerComponent: registerComponentRouteRef,

plugins/scaffolder/src/routes.ts

@@ -19,20 +19,20 @@ import {
   createSubRouteRef,
 } from '@backstage/core-plugin-api';
 
-/** @public */
 export const registerComponentRouteRef = createExternalRouteRef({
   id: 'register-component',
   optional: true,
 });
 
-/** @public */
 export const viewTechDocRouteRef = createExternalRouteRef({
   id: 'view-techdoc',
   optional: true,
   params: ['namespace', 'kind', 'name'],
 });
 
-/** @public */
+/**
+ * @public
+ */
 export const rootRouteRef = createRouteRef({
   id: 'scaffolder',
 });
@@ -47,35 +47,30 @@ export const legacySelectedTemplateRouteRef = createSubRouteRef({
   path: '/templates/:templateName',
 });
 
-/** @public */
 export const selectedTemplateRouteRef = createSubRouteRef({
   id: 'scaffolder/selected-template',
   parent: rootRouteRef,
   path: '/templates/:namespace/:templateName',
 });
 
-/** @public */
 export const scaffolderTaskRouteRef = createSubRouteRef({
   id: 'scaffolder/task',
   parent: rootRouteRef,
   path: '/tasks/:taskId',
 });
 
-/** @public */
 export const scaffolderListTaskRouteRef = createSubRouteRef({
   id: 'scaffolder/list-tasks',
   parent: rootRouteRef,
   path: '/tasks',
 });
 
-/** @public */
 export const actionsRouteRef = createSubRouteRef({
   id: 'scaffolder/actions',
   parent: rootRouteRef,
   path: '/actions',
 });
 
-/** @public */
 export const editRouteRef = createSubRouteRef({
   id: 'scaffolder/edit',
   parent: rootRouteRef,