Fix API report

Signed-off-by: solimant <solimant@users.noreply.github.com>

plugins/scaffolder-react/report-alpha.api.md

@@ -39,6 +39,7 @@ import { TaskStep } from '@backstage/plugin-scaffolder-common';
 import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { TemplateGroupFilter } from '@backstage/plugin-scaffolder-react';
 import { TemplateParameterSchema } from '@backstage/plugin-scaffolder-react';
+import { TemplateParameterSchema as TemplateParameterSchema_2 } from '@backstage/plugin-scaffolder-common';
 import { TemplatePresentationV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { TranslationRef } from '@backstage/core-plugin-api/alpha';
 import { UiSchema } from '@rjsf/utils';
@@ -486,7 +487,7 @@ export const useFormDataFromQuery: (
 
 // @alpha (undocumented)
 export const useTemplateParameterSchema: (templateRef: string) => {
-  manifest?: TemplateParameterSchema;
+  manifest?: TemplateParameterSchema_2;
   loading: boolean;
   error?: Error;
 };

plugins/scaffolder-react/report.api.md

@@ -3,6 +3,10 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+/// <reference types="react" />
+
+import { Action as Action_2 } from '@backstage/plugin-scaffolder-common';
+import { ActionExample as ActionExample_2 } from '@backstage/plugin-scaffolder-common';
 import { ApiHolder } from '@backstage/core-plugin-api';
 import { ApiRef } from '@backstage/frontend-plugin-api';
 import { ComponentType } from 'react';
@@ -23,9 +27,9 @@ import { IChangeEvent } from '@rjsf/core';
 import { IdSchema } from '@rjsf/utils';
 import { JsonObject } from '@backstage/types';
 import { JSONSchema7 } from 'json-schema';
-import { JsonValue } from '@backstage/types';
-import { JSX as JSX_2 } from 'react/jsx-runtime';
-import { Observable } from '@backstage/types';
+import { ListActionsResponse as ListActionsResponse_2 } from '@backstage/plugin-scaffolder-common';
+import { ListTemplatingExtensionsResponse as ListTemplatingExtensionsResponse_2 } from '@backstage/plugin-scaffolder-common';
+import { LogEvent as LogEvent_2 } from '@backstage/plugin-scaffolder-common';
 import { PropsWithChildren } from 'react';
 import { ReactNode } from 'react';
 import { Ref } from 'react';
@@ -33,30 +37,33 @@ import { Registry } from '@rjsf/utils';
 import { RegistryWidgetsType } from '@rjsf/utils';
 import { RJSFSchema } from '@rjsf/utils';
 import { RJSFValidationError } from '@rjsf/utils';
+import { ScaffolderApi as ScaffolderApi_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderDryRunOptions as ScaffolderDryRunOptions_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderDryRunResponse as ScaffolderDryRunResponse_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderGetIntegrationsListOptions as ScaffolderGetIntegrationsListOptions_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderGetIntegrationsListResponse as ScaffolderGetIntegrationsListResponse_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderOutputLink as ScaffolderOutputLink_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderOutputText as ScaffolderOutputText_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderScaffoldOptions as ScaffolderScaffoldOptions_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderScaffoldResponse as ScaffolderScaffoldResponse_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderStreamLogsOptions as ScaffolderStreamLogsOptions_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderTask as ScaffolderTask_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderTaskOutput as ScaffolderTaskOutput_2 } from '@backstage/plugin-scaffolder-common';
+import { ScaffolderTaskStatus as ScaffolderTaskStatus_2 } from '@backstage/plugin-scaffolder-common';
 import { StrictRJSFSchema } from '@rjsf/utils';
-import { TaskSpec } from '@backstage/plugin-scaffolder-common';
-import { TaskStep } from '@backstage/plugin-scaffolder-common';
 import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
-import { TemplatePresentationV1beta3 } from '@backstage/plugin-scaffolder-common';
+import { TemplateParameterSchema as TemplateParameterSchema_2 } from '@backstage/plugin-scaffolder-common';
 import { TemplatesType } from '@rjsf/utils';
 import { UIOptionsType } from '@rjsf/utils';
 import { UiSchema } from '@rjsf/utils';
 import { ValidatorType } from '@rjsf/utils';
 import { z } from 'zod';
 
-// @public
-export type Action = {
-  id: string;
-  description?: string;
-  schema?: {
-    input?: JSONSchema7;
-    output?: JSONSchema7;
-  };
-  examples?: ActionExample[];
-};
+// @public @deprecated
+export type Action = Action_2;
 
 // @public @deprecated
-export type ActionExample = ScaffolderUsageExample;
+export type ActionExample = ActionExample_2;
 
 // @public
 export function createScaffolderFieldExtension<
@@ -162,30 +169,14 @@ export type LayoutTemplate<T = any> = NonNullable<
   FormProps_2<T>['uiSchema']
 >['ui:ObjectFieldTemplate'];
 
-// @public
-export type ListActionsResponse = Array<Action>;
+// @public @deprecated
+export type ListActionsResponse = ListActionsResponse_2;
 
-// @public
-export type ListTemplatingExtensionsResponse = {
-  filters: Record<string, TemplateFilter>;
-  globals: {
-    functions: Record<string, TemplateGlobalFunction>;
-    values: Record<string, TemplateGlobalValue>;
-  };
-};
+// @public @deprecated
+export type ListTemplatingExtensionsResponse = ListTemplatingExtensionsResponse_2;
 
-// @public
-export type LogEvent = {
-  type: 'log' | 'completion' | 'cancelled' | 'recovered';
-  body: {
-    message: string;
-    stepId?: string;
-    status?: ScaffolderTaskStatus;
-  };
-  createdAt: string;
-  id: string;
-  taskId: string;
-};
+// @public @deprecated
+export type LogEvent = LogEvent_2;
 
 // @public (undocumented)
 export function makeFieldSchema<
@@ -210,125 +201,39 @@ export type ReviewStepProps = {
   }[];
 };
 
-// @public
-export interface ScaffolderApi {
-  // (undocumented)
-  autocomplete?(options: {
-    token: string;
-    provider: string;
-    resource: string;
-    context?: Record<string, string>;
-  }): Promise<{
-    results: {
-      title?: string;
-      id: string;
-    }[];
-  }>;
-  cancelTask(taskId: string): Promise<void>;
-  // (undocumented)
-  dryRun?(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
-  // (undocumented)
-  getIntegrationsList(
-    options: ScaffolderGetIntegrationsListOptions,
-  ): Promise<ScaffolderGetIntegrationsListResponse>;
-  // (undocumented)
-  getTask(taskId: string): Promise<ScaffolderTask>;
-  // (undocumented)
-  getTemplateParameterSchema(
-    templateRef: string,
-  ): Promise<TemplateParameterSchema>;
-  listActions(): Promise<ListActionsResponse>;
-  // (undocumented)
-  listTasks?(options: {
-    filterByOwnership: 'owned' | 'all';
-    limit?: number;
-    offset?: number;
-  }): Promise<{
-    tasks: ScaffolderTask[];
-    totalTasks?: number;
-  }>;
-  listTemplatingExtensions?(): Promise<ListTemplatingExtensionsResponse>;
-  retry?(taskId: string): Promise<void>;
-  scaffold(
-    options: ScaffolderScaffoldOptions,
-  ): Promise<ScaffolderScaffoldResponse>;
-  // (undocumented)
-  streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
-}
+// @public @deprecated
+export type ScaffolderApi = ScaffolderApi_2;
 
 // @public (undocumented)
-export const scaffolderApiRef: ApiRef<ScaffolderApi>;
+export const scaffolderApiRef: ApiRef<ScaffolderApi_2>;
 
-// @public (undocumented)
-export interface ScaffolderDryRunOptions {
-  // (undocumented)
-  directoryContents: {
-    path: string;
-    base64Content: string;
-  }[];
-  // (undocumented)
-  secrets?: Record<string, string>;
-  // (undocumented)
-  template: JsonValue;
-  // (undocumented)
-  values: JsonObject;
-}
+// @public @deprecated (undocumented)
+export type ScaffolderDryRunOptions = ScaffolderDryRunOptions_2;
 
-// @public (undocumented)
-export interface ScaffolderDryRunResponse {
-  // (undocumented)
-  directoryContents: Array<{
-    path: string;
-    base64Content: string;
-    executable: boolean;
-  }>;
-  // (undocumented)
-  log: Array<Pick<LogEvent, 'body'>>;
-  // (undocumented)
-  output: ScaffolderTaskOutput;
-  // (undocumented)
-  steps: TaskStep[];
-}
+// @public @deprecated (undocumented)
+export type ScaffolderDryRunResponse = ScaffolderDryRunResponse_2;
 
 // @public
 export const ScaffolderFieldExtensions: React.ComponentType<
   React.PropsWithChildren<{}>
 >;
 
-// @public
-export interface ScaffolderGetIntegrationsListOptions {
-  // (undocumented)
-  allowedHosts: string[];
-}
+// @public @deprecated
+export type ScaffolderGetIntegrationsListOptions =
+  ScaffolderGetIntegrationsListOptions_2;
 
-// @public
-export interface ScaffolderGetIntegrationsListResponse {
-  // (undocumented)
-  integrations: {
-    type: string;
-    title: string;
-    host: string;
-  }[];
-}
+// @public @deprecated
+export type ScaffolderGetIntegrationsListResponse =
+  ScaffolderGetIntegrationsListResponse_2;
 
 // @public
 export const ScaffolderLayouts: ComponentType<PropsWithChildren<{}>>;
 
-// @public (undocumented)
-export type ScaffolderOutputLink = {
-  title?: string;
-  icon?: string;
-  url?: string;
-  entityRef?: string;
-};
+// @public @deprecated (undocumented)
+export type ScaffolderOutputLink = ScaffolderOutputLink_2;
 
-// @public (undocumented)
-export type ScaffolderOutputText = {
-  title?: string;
-  icon?: string;
-  content?: string;
-  default?: boolean;
-};
+// @public @deprecated (undocumented)
+export type ScaffolderOutputText = ScaffolderOutputText_2;
 
 // @public
 export type ScaffolderRJSFField<
@@ -437,21 +342,11 @@ export type ScaffolderRJSFRegistryFieldsType<
   [name: string]: ScaffolderRJSFField<T, S, F>;
 };
 
-// @public
-export interface ScaffolderScaffoldOptions {
-  // (undocumented)
-  secrets?: Record<string, string>;
-  // (undocumented)
-  templateRef: string;
-  // (undocumented)
-  values: Record<string, JsonValue>;
-}
+// @public @deprecated
+export type ScaffolderScaffoldOptions = ScaffolderScaffoldOptions_2;
 
-// @public
-export interface ScaffolderScaffoldResponse {
-  // (undocumented)
-  taskId: string;
-}
+// @public @deprecated
+export type ScaffolderScaffoldResponse = ScaffolderScaffoldResponse_2;
 
 // @public
 export type ScaffolderStep = {
@@ -461,41 +356,17 @@ export type ScaffolderStep = {
   startedAt?: string;
 };
 
-// @public
-export interface ScaffolderStreamLogsOptions {
-  // (undocumented)
-  after?: number;
-  // (undocumented)
-  isTaskRecoverable?: boolean;
-  // (undocumented)
-  taskId: string;
-}
+// @public @deprecated
+export type ScaffolderStreamLogsOptions = ScaffolderStreamLogsOptions_2;
 
-// @public
-export type ScaffolderTask = {
-  id: string;
-  spec: TaskSpec;
-  status: 'failed' | 'completed' | 'processing' | 'open' | 'cancelled';
-  lastHeartbeatAt: string;
-  createdAt: string;
-};
+// @public @deprecated
+export type ScaffolderTask = ScaffolderTask_2;
 
-// @public (undocumented)
-export type ScaffolderTaskOutput = {
-  links?: ScaffolderOutputLink[];
-  text?: ScaffolderOutputText[];
-} & {
-  [key: string]: unknown;
-};
+// @public @deprecated (undocumented)
+export type ScaffolderTaskOutput = ScaffolderTaskOutput_2;
 
-// @public
-export type ScaffolderTaskStatus =
-  | 'cancelled'
-  | 'completed'
-  | 'failed'
-  | 'open'
-  | 'processing'
-  | 'skipped';
+// @public @deprecated
+export type ScaffolderTaskStatus = ScaffolderTaskStatus_2;
 
 // @public
 export type ScaffolderUsageExample = {
@@ -568,21 +439,8 @@ export type TemplateGroupFilter = {
   filter: (entity: TemplateEntityV1beta3) => boolean;
 };
 
-// @public
-export type TemplateParameterSchema = {
-  title: string;
-  description?: string;
-  presentation?: TemplatePresentationV1beta3;
-  steps: Array<{
-    title: string;
-    description?: string;
-    schema: JsonObject;
-  }>;
-  EXPERIMENTAL_formDecorators?: {
-    id: string;
-    input?: JsonObject;
-  }[];
-};
+// @public @deprecated
+export type TemplateParameterSchema = TemplateParameterSchema_2;
 
 // @public
 export const useCustomFieldExtensions: <