@backstage/plugin-scaffolder-react 1.1.0 → 1.2.0-next.1

package/dist/index.d.ts

@@ -1,176 +1,175 @@
 /// <reference types="react" />
-
-import { ApiHolder } from '@backstage/core-plugin-api';
-import { ApiRef } from '@backstage/core-plugin-api';
-import { ComponentType } from 'react';
-import { Dispatch } from 'react';
-import { Extension } from '@backstage/core-plugin-api';
-import { FieldProps } from '@rjsf/core';
-import { FieldProps as FieldProps_2 } from '@rjsf/utils';
-import { FieldValidation } from '@rjsf/core';
-import { FieldValidation as FieldValidation_2 } from '@rjsf/utils';
-import { FormProps as FormProps_2 } from '@rjsf/core-v5';
-import { IconComponent } from '@backstage/core-plugin-api';
-import { JsonObject } from '@backstage/types';
+import React$1, { PropsWithChildren } from 'react';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+import { ApiHolder, Extension } from '@backstage/core-plugin-api';
+import { FieldValidation, FieldProps } from '@rjsf/core';
 import { JSONSchema7 } from 'json-schema';
-import { JsonValue } from '@backstage/types';
-import { Observable } from '@backstage/types';
-import { PropsWithChildren } from 'react';
-import { default as React_2 } from 'react';
-import { ReactNode } from 'react';
-import { RJSFSchema } from '@rjsf/utils';
-import { SetStateAction } from 'react';
-import { TaskSpec } from '@backstage/plugin-scaffolder-common';
-import { TaskStep } from '@backstage/plugin-scaffolder-common';
-import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
-import { UIOptionsType } from '@rjsf/utils';
-import { UiSchema } from '@rjsf/utils';
+import { JsonObject, JsonValue, Observable } from '@backstage/types';
+import { TaskSpec, TaskStep } from '@backstage/plugin-scaffolder-common';
+import { FormProps } from '@rjsf/core-v5';
 
 /**
- * The response shape for a single action in the `listActions` call to the `scaffolder-backend`
+ * Field validation type for Custom Field Extensions.
  *
  * @public
  */
-export declare type Action = {
-    id: string;
-    description?: string;
-    schema?: {
-        input?: JSONSchema7;
-        output?: JSONSchema7;
-    };
-    examples?: ActionExample[];
-};
-
+declare type CustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation, context: {
+    apiHolder: ApiHolder;
+}) => void | Promise<void>;
 /**
- * A single action example
+ * Type for the Custom Field Extension schema.
  *
  * @public
  */
-export declare type ActionExample = {
-    description: string;
-    example: string;
+declare type CustomFieldExtensionSchema = {
+    returnValue: JSONSchema7;
+    uiOptions?: JSONSchema7;
 };
-
-/* Excluded from this release type: createFieldValidation */
-
-/* Excluded from this release type: createNextScaffolderFieldExtension */
-
 /**
- * Method for creating field extensions that can be used in the scaffolder
- * frontend form.
+ * Type for the Custom Field Extension with the
+ * name and components and validation function.
+ *
  * @public
  */
-export declare function createScaffolderFieldExtension<TReturnValue = unknown, TInputProps = unknown>(options: FieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
-
+declare type FieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
+    name: string;
+    component: (props: FieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
+    validation?: CustomFieldValidator<TFieldReturnValue>;
+    schema?: CustomFieldExtensionSchema;
+};
 /**
- * Method for creating custom Layouts that can be used in the scaffolder frontend form
+ * Type for field extensions and being able to type
+ * incoming props easier.
  *
  * @public
  */
-export declare function createScaffolderLayout<TInputProps = unknown>(options: LayoutOptions): Extension<LayoutComponent<TInputProps>>;
+interface FieldExtensionComponentProps<TFieldReturnValue, TUiOptions extends {} = {}> extends FieldProps<TFieldReturnValue> {
+    uiSchema: FieldProps['uiSchema'] & {
+        'ui:options'?: TUiOptions;
+    };
+}
 
 /**
- * Type for the Custom Field Extension schema.
+ * The type used to wrap up the Layout and embed the input props
  *
  * @public
  */
-export declare type CustomFieldExtensionSchema = {
-    returnValue: JSONSchema7;
-    uiOptions?: JSONSchema7;
-};
-
+declare type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;
 /**
- * Field validation type for Custom Field Extensions.
+ * Method for creating field extensions that can be used in the scaffolder
+ * frontend form.
+ * @public
+ */
+declare function createScaffolderFieldExtension<TReturnValue = unknown, TInputProps = unknown>(options: FieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
+/**
+ * The Wrapping component for defining fields extensions inside
  *
  * @public
  */
-export declare type CustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation, context: {
-    apiHolder: ApiHolder;
-}) => void | Promise<void>;
-
-/* Excluded from this release type: DefaultTemplateOutputs */
-
-/* Excluded from this release type: EmbeddableWorkflow */
-
-/* Excluded from this release type: extractSchemaFromStep */
+declare const ScaffolderFieldExtensions: React$1.ComponentType<React$1.PropsWithChildren<{}>>;
 
 /**
- * The type used to wrap up the Layout and embed the input props
+ * The shape of each entry of parameters which gets rendered
+ * as a separate step in the wizard input
  *
  * @public
  */
-export declare type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;
+declare type TemplateParameterSchema = {
+    title: string;
+    description?: string;
+    steps: Array<{
+        title: string;
+        description?: string;
+        schema: JsonObject;
+    }>;
+};
 
 /**
- * Type for field extensions and being able to type
- * incoming props easier.
- *
+ * The Context Provider that holds the state for the secrets.
  * @public
  */
-export declare interface FieldExtensionComponentProps<TFieldReturnValue, TUiOptions extends {} = {}> extends FieldProps<TFieldReturnValue> {
-    uiSchema: FieldProps['uiSchema'] & {
-        'ui:options'?: TUiOptions;
-    };
+declare const SecretsContextProvider: ({ children }: PropsWithChildren<{}>) => JSX.Element;
+/**
+ * The return type from the useTemplateSecrets hook.
+ * @public
+ */
+interface ScaffolderUseTemplateSecrets {
+    setSecrets: (input: Record<string, string>) => void;
+    secrets: Record<string, string>;
 }
-
 /**
- * Type for the Custom Field Extension with the
- * name and components and validation function.
- *
+ * Hook to access the secrets context to be able to set secrets that are
+ * passed to the Scaffolder backend.
  * @public
  */
-export declare type FieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
-    name: string;
-    component: (props: FieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
-    validation?: CustomFieldValidator<TFieldReturnValue>;
-    schema?: CustomFieldExtensionSchema;
-};
-
-/* Excluded from this release type: Form */
+declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
 
 /**
- * Any `@rjsf/core` form properties that are publicly exposed to the `NextScaffolderpage`
+ * The status of each task in a Scaffolder Job
  *
  * @public
  */
-export declare type FormProps = Pick<FormProps_2, 'transformErrors' | 'noHtml5Validate'>;
-
+declare type ScaffolderTaskStatus = 'open' | 'processing' | 'failed' | 'completed' | 'skipped';
 /**
- * A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
+ * The shape of each task returned from the `scaffolder-backend`
+ *
  * @public
  */
-export declare type LayoutComponent<_TInputProps> = () => null;
-
+declare type ScaffolderTask = {
+    id: string;
+    spec: TaskSpec;
+    status: 'failed' | 'completed' | 'processing' | 'open' | 'cancelled';
+    lastHeartbeatAt: string;
+    createdAt: string;
+};
 /**
- * The type of layouts that is passed to the TemplateForms
+ * A single action example
  *
  * @public
  */
-export declare interface LayoutOptions<P = any> {
-    name: string;
-    component: LayoutTemplate<P>;
-}
-
+declare type ActionExample = {
+    description: string;
+    example: string;
+};
 /**
- * The field template from `@rjsf/core` which is a react component that gets passed `@rjsf/core` field related props.
+ * The response shape for a single action in the `listActions` call to the `scaffolder-backend`
  *
  * @public
  */
-export declare type LayoutTemplate<T = any> = NonNullable<FormProps_2<T>['uiSchema']>['ui:ObjectFieldTemplate'];
-
+declare type Action = {
+    id: string;
+    description?: string;
+    schema?: {
+        input?: JSONSchema7;
+        output?: JSONSchema7;
+    };
+    examples?: ActionExample[];
+};
 /**
  * The response shape for the `listActions` call to the `scaffolder-backend`
  *
  * @public
  */
-export declare type ListActionsResponse = Array<Action>;
-
+declare type ListActionsResponse = Array<Action>;
+/** @public */
+declare type ScaffolderOutputLink = {
+    title?: string;
+    icon?: string;
+    url?: string;
+    entityRef?: string;
+};
+/** @public */
+declare type ScaffolderTaskOutput = {
+    links?: ScaffolderOutputLink[];
+} & {
+    [key: string]: unknown;
+};
 /**
  * The shape of a `LogEvent` message from the `scaffolder-backend`
  *
  * @public
  */
-export declare type LogEvent = {
+declare type LogEvent = {
     type: 'log' | 'completion';
     body: {
         message: string;
@@ -181,245 +180,185 @@ export declare type LogEvent = {
     id: string;
     taskId: string;
 };
-
-/* Excluded from this release type: NextCustomFieldValidator */
-
-/* Excluded from this release type: NextFieldExtensionComponentProps */
-
-/* Excluded from this release type: NextFieldExtensionOptions */
-
-/* Excluded from this release type: ParsedTemplateSchema */
-
-/* Excluded from this release type: ReviewState */
-
-/* Excluded from this release type: ReviewStateProps */
-
 /**
- * An API to interact with the scaffolder backend.
+ * The input options to the `scaffold` method of the `ScaffolderClient`.
  *
  * @public
  */
-export declare interface ScaffolderApi {
-    getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema>;
-    /**
-     * Executes the scaffolding of a component, given a template and its
-     * parameter values.
-     *
-     * @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
-     */
-    scaffold(options: ScaffolderScaffoldOptions): Promise<ScaffolderScaffoldResponse>;
-    getTask(taskId: string): Promise<ScaffolderTask>;
-    listTasks?(options: {
-        filterByOwnership: 'owned' | 'all';
-    }): Promise<{
-        tasks: ScaffolderTask[];
-    }>;
-    getIntegrationsList(options: ScaffolderGetIntegrationsListOptions): Promise<ScaffolderGetIntegrationsListResponse>;
-    /**
-     * Returns a list of all installed actions.
-     */
-    listActions(): Promise<ListActionsResponse>;
-    streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
-    dryRun?(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
-}
-
-/** @public */
-export declare const scaffolderApiRef: ApiRef<ScaffolderApi>;
-
-/** @public */
-export declare interface ScaffolderDryRunOptions {
-    template: JsonValue;
-    values: JsonObject;
+interface ScaffolderScaffoldOptions {
+    templateRef: string;
+    values: Record<string, JsonValue>;
     secrets?: Record<string, string>;
-    directoryContents: {
-        path: string;
-        base64Content: string;
-    }[];
-}
-
-/** @public */
-export declare interface ScaffolderDryRunResponse {
-    directoryContents: Array<{
-        path: string;
-        base64Content: string;
-        executable: boolean;
-    }>;
-    log: Array<Pick<LogEvent, 'body'>>;
-    steps: TaskStep[];
-    output: ScaffolderTaskOutput;
 }
-
 /**
- * The Wrapping component for defining fields extensions inside
+ * The response shape of the `scaffold` method of the `ScaffolderClient`.
  *
  * @public
  */
-export declare const ScaffolderFieldExtensions: React_2.ComponentType<React_2.PropsWithChildren<{}>>;
-
+interface ScaffolderScaffoldResponse {
+    taskId: string;
+}
 /**
  * The arguments for `getIntegrationsList`.
  *
  * @public
  */
-export declare interface ScaffolderGetIntegrationsListOptions {
+interface ScaffolderGetIntegrationsListOptions {
     allowedHosts: string[];
 }
-
 /**
  * The response shape for `getIntegrationsList`.
  *
  * @public
  */
-export declare interface ScaffolderGetIntegrationsListResponse {
+interface ScaffolderGetIntegrationsListResponse {
     integrations: {
         type: string;
         title: string;
         host: string;
     }[];
 }
-
 /**
- * The wrapping component for defining scaffolder layouts as children
+ * The input options to the `streamLogs` method of the `ScaffolderClient`.
  *
  * @public
  */
-export declare const ScaffolderLayouts: React.ComponentType;
-
+interface ScaffolderStreamLogsOptions {
+    taskId: string;
+    after?: number;
+}
 /** @public */
-export declare type ScaffolderOutputLink = {
-    title?: string;
-    icon?: string;
-    url?: string;
-    entityRef?: string;
-};
-
-/**
- * The input options to the `scaffold` method of the `ScaffolderClient`.
- *
- * @public
- */
-export declare interface ScaffolderScaffoldOptions {
-    templateRef: string;
-    values: Record<string, JsonValue>;
+interface ScaffolderDryRunOptions {
+    template: JsonValue;
+    values: JsonObject;
     secrets?: Record<string, string>;
+    directoryContents: {
+        path: string;
+        base64Content: string;
+    }[];
+}
+/** @public */
+interface ScaffolderDryRunResponse {
+    directoryContents: Array<{
+        path: string;
+        base64Content: string;
+        executable: boolean;
+    }>;
+    log: Array<Pick<LogEvent, 'body'>>;
+    steps: TaskStep[];
+    output: ScaffolderTaskOutput;
 }
-
 /**
- * The response shape of the `scaffold` method of the `ScaffolderClient`.
+ * An API to interact with the scaffolder backend.
  *
  * @public
  */
-export declare interface ScaffolderScaffoldResponse {
-    taskId: string;
+interface ScaffolderApi {
+    getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema>;
+    /**
+     * Executes the scaffolding of a component, given a template and its
+     * parameter values.
+     *
+     * @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
+     */
+    scaffold(options: ScaffolderScaffoldOptions): Promise<ScaffolderScaffoldResponse>;
+    getTask(taskId: string): Promise<ScaffolderTask>;
+    listTasks?(options: {
+        filterByOwnership: 'owned' | 'all';
+    }): Promise<{
+        tasks: ScaffolderTask[];
+    }>;
+    getIntegrationsList(options: ScaffolderGetIntegrationsListOptions): Promise<ScaffolderGetIntegrationsListResponse>;
+    /**
+     * Returns a list of all installed actions.
+     */
+    listActions(): Promise<ListActionsResponse>;
+    streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
+    dryRun?(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
 }
 
+/** @public */
+declare const scaffolderApiRef: _backstage_core_plugin_api.ApiRef<ScaffolderApi>;
+
 /**
- * The input options to the `streamLogs` method of the `ScaffolderClient`.
- *
+ * Hook that returns all custom field extensions from the current outlet.
  * @public
  */
-export declare interface ScaffolderStreamLogsOptions {
-    taskId: string;
-    after?: number;
-}
+declare const useCustomFieldExtensions: <TComponentDataType = FieldExtensionOptions<unknown, unknown>>(outlet: React.ReactNode) => TComponentDataType[];
 
 /**
- * The shape of each task returned from the `scaffolder-backend`
+ * The field template from `@rjsf/core` which is a react component that gets passed `@rjsf/core` field related props.
  *
  * @public
  */
-export declare type ScaffolderTask = {
-    id: string;
-    spec: TaskSpec;
-    status: 'failed' | 'completed' | 'processing' | 'open' | 'cancelled';
-    lastHeartbeatAt: string;
-    createdAt: string;
-};
-
-/** @public */
-export declare type ScaffolderTaskOutput = {
-    links?: ScaffolderOutputLink[];
-} & {
-    [key: string]: unknown;
-};
-
+declare type LayoutTemplate<T = any> = NonNullable<FormProps<T>['uiSchema']>['ui:ObjectFieldTemplate'];
 /**
- * The status of each task in a Scaffolder Job
+ * The type of layouts that is passed to the TemplateForms
  *
  * @public
  */
-export declare type ScaffolderTaskStatus = 'open' | 'processing' | 'failed' | 'completed' | 'skipped';
-
+interface LayoutOptions<P = any> {
+    name: string;
+    component: LayoutTemplate<P>;
+}
 /**
- * The return type from the useTemplateSecrets hook.
+ * A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
  * @public
  */
-export declare interface ScaffolderUseTemplateSecrets {
-    setSecrets: (input: Record<string, string>) => void;
-    secrets: Record<string, string>;
-}
-
+declare type LayoutComponent<_TInputProps> = () => null;
 /**
- * The Context Provider that holds the state for the secrets.
+ * Method for creating custom Layouts that can be used in the scaffolder frontend form
+ *
  * @public
  */
-export declare const SecretsContextProvider: ({ children }: PropsWithChildren<{}>) => JSX.Element;
-
-/* Excluded from this release type: Stepper */
-
-/* Excluded from this release type: StepperProps */
-
-/* Excluded from this release type: TemplateCard */
-
-/* Excluded from this release type: TemplateCardProps */
-
-/* Excluded from this release type: TemplateGroup */
-
-/* Excluded from this release type: TemplateGroupProps */
-
+declare function createScaffolderLayout<TInputProps = unknown>(options: LayoutOptions): Extension<LayoutComponent<TInputProps>>;
 /**
- * The shape of each entry of parameters which gets rendered
- * as a separate step in the wizard input
+ * The wrapping component for defining scaffolder layouts as children
  *
  * @public
  */
-export declare type TemplateParameterSchema = {
-    title: string;
-    description?: string;
-    steps: Array<{
-        title: string;
-        description?: string;
-        schema: JsonObject;
-    }>;
-};
+declare const ScaffolderLayouts: React.ComponentType;
 
 /**
  * Hook that returns all custom field extensions from the current outlet.
  * @public
  */
-export declare const useCustomFieldExtensions: <TComponentDataType = FieldExtensionOptions<unknown, unknown>>(outlet: React.ReactNode) => TComponentDataType[];
+declare const useCustomLayouts: <TComponentDataType = LayoutOptions<any>>(outlet: React.ReactNode) => TComponentDataType[];
 
 /**
- * Hook that returns all custom field extensions from the current outlet.
+ * The status of the step being processed
+ *
  * @public
  */
-export declare const useCustomLayouts: <TComponentDataType = LayoutOptions<any>>(outlet: React.ReactNode) => TComponentDataType[];
-
-/* Excluded from this release type: useFormDataFromQuery */
-
-/* Excluded from this release type: useTemplateParameterSchema */
-
-/* Excluded from this release type: useTemplateSchema */
-
+declare type ScaffolderStep = {
+    id: string;
+    status: ScaffolderTaskStatus;
+    endedAt?: string;
+    startedAt?: string;
+};
 /**
- * Hook to access the secrets context to be able to set secrets that are
- * passed to the Scaffolder backend.
+ * A task event from the event stream
+ *
  * @public
  */
-export declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
-
-/* Excluded from this release type: Workflow */
-
-/* Excluded from this release type: WorkflowProps */
+declare type TaskStream = {
+    loading: boolean;
+    error?: Error;
+    stepLogs: {
+        [stepId in string]: string[];
+    };
+    completed: boolean;
+    task?: ScaffolderTask;
+    steps: {
+        [stepId in string]: ScaffolderStep;
+    };
+    output?: ScaffolderTaskOutput;
+};
+/**
+ * A hook to stream the logs of a task being processed
+ *
+ * @public
+ */
+declare const useTaskEventStream: (taskId: string) => TaskStream;
 
-export { }
+export { Action, ActionExample, CustomFieldExtensionSchema, CustomFieldValidator, FieldExtensionComponent, FieldExtensionComponentProps, FieldExtensionOptions, LayoutComponent, LayoutOptions, LayoutTemplate, ListActionsResponse, LogEvent, ScaffolderApi, ScaffolderDryRunOptions, ScaffolderDryRunResponse, ScaffolderFieldExtensions, ScaffolderGetIntegrationsListOptions, ScaffolderGetIntegrationsListResponse, ScaffolderLayouts, ScaffolderOutputLink, ScaffolderScaffoldOptions, ScaffolderScaffoldResponse, ScaffolderStep, ScaffolderStreamLogsOptions, ScaffolderTask, ScaffolderTaskOutput, ScaffolderTaskStatus, ScaffolderUseTemplateSecrets, SecretsContextProvider, TaskStream, TemplateParameterSchema, createScaffolderFieldExtension, createScaffolderLayout, scaffolderApiRef, useCustomFieldExtensions, useCustomLayouts, useTaskEventStream, useTemplateSecrets };