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

package/dist/index.alpha.d.ts

@@ -1,591 +0,0 @@
-/// <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 { 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';
-
-/**
- * The response shape for a single action in the `listActions` call to the `scaffolder-backend`
- *
- * @public
- */
-export declare type Action = {
-    id: string;
-    description?: string;
-    schema?: {
-        input?: JSONSchema7;
-        output?: JSONSchema7;
-    };
-    examples?: ActionExample[];
-};
-
-/**
- * A single action example
- *
- * @public
- */
-export declare type ActionExample = {
-    description: string;
-    example: string;
-};
-
-/**
- * Creates a field validation object for use in react jsonschema form
- * @alpha
- */
-export declare const createFieldValidation: () => FieldValidation_2;
-
-/**
- * Method for creating field extensions that can be used in the scaffolder
- * frontend form.
- * @alpha
- */
-export declare function createNextScaffolderFieldExtension<TReturnValue = unknown, TInputProps extends UIOptionsType = {}>(options: NextFieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
-
-/**
- * Method for creating field extensions that can be used in the scaffolder
- * frontend form.
- * @public
- */
-export declare function createScaffolderFieldExtension<TReturnValue = unknown, TInputProps = unknown>(options: FieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
-
-/**
- * Method for creating custom Layouts that can be used in the scaffolder frontend form
- *
- * @public
- */
-export declare function createScaffolderLayout<TInputProps = unknown>(options: LayoutOptions): Extension<LayoutComponent<TInputProps>>;
-
-/**
- * Type for the Custom Field Extension schema.
- *
- * @public
- */
-export declare type CustomFieldExtensionSchema = {
-    returnValue: JSONSchema7;
-    uiOptions?: JSONSchema7;
-};
-
-/**
- * Field validation type for Custom Field Extensions.
- *
- * @public
- */
-export declare type CustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation, context: {
-    apiHolder: ApiHolder;
-}) => void | Promise<void>;
-
-/**
- * The DefaultOutputs renderer for the scaffolder task output
- *
- * @alpha
- */
-export declare const DefaultTemplateOutputs: (props: {
-    output?: ScaffolderTaskOutput;
-}) => JSX.Element | null;
-
-/**
- * @alpha
- */
-export declare const EmbeddableWorkflow: (props: WorkflowProps) => JSX.Element;
-
-/**
- * Takes a step from a Backstage Template Manifest and converts it to a JSON Schema and UI Schema for rjsf
- * @alpha
- */
-export declare const extractSchemaFromStep: (inputStep: JsonObject) => {
-    uiSchema: UiSchema;
-    schema: JsonObject;
-};
-
-/**
- * The type used to wrap up the Layout and embed the input props
- *
- * @public
- */
-export declare type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;
-
-/**
- * Type for field extensions and being able to type
- * incoming props easier.
- *
- * @public
- */
-export declare interface FieldExtensionComponentProps<TFieldReturnValue, TUiOptions extends {} = {}> extends FieldProps<TFieldReturnValue> {
-    uiSchema: FieldProps['uiSchema'] & {
-        'ui:options'?: TUiOptions;
-    };
-}
-
-/**
- * Type for the Custom Field Extension with the
- * name and components and validation function.
- *
- * @public
- */
-export declare type FieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
-    name: string;
-    component: (props: FieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
-    validation?: CustomFieldValidator<TFieldReturnValue>;
-    schema?: CustomFieldExtensionSchema;
-};
-
-/** @alpha */
-export declare const Form: ComponentType<FormProps_2<any, RJSFSchema, any>>;
-
-/**
- * Any `@rjsf/core` form properties that are publicly exposed to the `NextScaffolderpage`
- *
- * @public
- */
-export declare type FormProps = Pick<FormProps_2, 'transformErrors' | 'noHtml5Validate'>;
-
-/**
- * A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
- * @public
- */
-export declare type LayoutComponent<_TInputProps> = () => null;
-
-/**
- * The type of layouts that is passed to the TemplateForms
- *
- * @public
- */
-export declare interface LayoutOptions<P = any> {
-    name: string;
-    component: LayoutTemplate<P>;
-}
-
-/**
- * The field template from `@rjsf/core` which is a react component that gets passed `@rjsf/core` field related props.
- *
- * @public
- */
-export declare type LayoutTemplate<T = any> = NonNullable<FormProps_2<T>['uiSchema']>['ui:ObjectFieldTemplate'];
-
-/**
- * The response shape for the `listActions` call to the `scaffolder-backend`
- *
- * @public
- */
-export declare type ListActionsResponse = Array<Action>;
-
-/**
- * The shape of a `LogEvent` message from the `scaffolder-backend`
- *
- * @public
- */
-export declare type LogEvent = {
-    type: 'log' | 'completion';
-    body: {
-        message: string;
-        stepId?: string;
-        status?: ScaffolderTaskStatus;
-    };
-    createdAt: string;
-    id: string;
-    taskId: string;
-};
-
-/**
- * Field validation type for Custom Field Extensions.
- *
- * @alpha
- */
-export declare type NextCustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation_2, context: {
-    apiHolder: ApiHolder;
-    formData: JsonObject;
-}) => void | Promise<void>;
-
-/**
- * Type for Field Extension Props for RJSF v5
- *
- * @alpha
- */
-export declare interface NextFieldExtensionComponentProps<TFieldReturnValue, TUiOptions = {}> extends PropsWithChildren<FieldProps_2<TFieldReturnValue>> {
-    uiSchema?: UiSchema<TFieldReturnValue> & {
-        'ui:options'?: TUiOptions & UIOptionsType;
-    };
-}
-
-/**
- * Type for the Custom Field Extension with the
- * name and components and validation function.
- *
- * @alpha
- */
-export declare type NextFieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
-    name: string;
-    component: (props: NextFieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
-    validation?: NextCustomFieldValidator<TFieldReturnValue>;
-    schema?: CustomFieldExtensionSchema;
-};
-
-/**
- * This is the parsed template schema that is returned from the {@link useTemplateSchema} hook.
- * @alpha
- */
-export declare interface ParsedTemplateSchema {
-    uiSchema: UiSchema;
-    mergedSchema: JsonObject;
-    schema: JsonObject;
-    title: string;
-    description?: string;
-}
-
-/**
- * The component used by the {@link Stepper} to render the review step.
- * @alpha
- */
-export declare const ReviewState: (props: ReviewStateProps) => JSX.Element;
-
-/**
- * The props for the {@link ReviewState} component.
- * @alpha
- */
-export declare type ReviewStateProps = {
-    schemas: ParsedTemplateSchema[];
-    formState: JsonObject;
-};
-
-/**
- * An API to interact with the scaffolder backend.
- *
- * @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;
-    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
- *
- * @public
- */
-export declare const ScaffolderFieldExtensions: React_2.ComponentType<React_2.PropsWithChildren<{}>>;
-
-/**
- * The arguments for `getIntegrationsList`.
- *
- * @public
- */
-export declare interface ScaffolderGetIntegrationsListOptions {
-    allowedHosts: string[];
-}
-
-/**
- * The response shape for `getIntegrationsList`.
- *
- * @public
- */
-export declare interface ScaffolderGetIntegrationsListResponse {
-    integrations: {
-        type: string;
-        title: string;
-        host: string;
-    }[];
-}
-
-/**
- * The wrapping component for defining scaffolder layouts as children
- *
- * @public
- */
-export declare const ScaffolderLayouts: React.ComponentType;
-
-/** @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>;
-    secrets?: Record<string, string>;
-}
-
-/**
- * The response shape of the `scaffold` method of the `ScaffolderClient`.
- *
- * @public
- */
-export declare interface ScaffolderScaffoldResponse {
-    taskId: string;
-}
-
-/**
- * The input options to the `streamLogs` method of the `ScaffolderClient`.
- *
- * @public
- */
-export declare interface ScaffolderStreamLogsOptions {
-    taskId: string;
-    after?: number;
-}
-
-/**
- * The shape of each task returned from the `scaffolder-backend`
- *
- * @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;
-};
-
-/**
- * The status of each task in a Scaffolder Job
- *
- * @public
- */
-export declare type ScaffolderTaskStatus = 'open' | 'processing' | 'failed' | 'completed' | 'skipped';
-
-/**
- * The return type from the useTemplateSecrets hook.
- * @public
- */
-export declare interface ScaffolderUseTemplateSecrets {
-    setSecrets: (input: Record<string, string>) => void;
-    secrets: Record<string, string>;
-}
-
-/**
- * The Context Provider that holds the state for the secrets.
- * @public
- */
-export declare const SecretsContextProvider: ({ children }: PropsWithChildren<{}>) => JSX.Element;
-
-/**
- * The `Stepper` component is the Wizard that is rendered when a user selects a template
- * @alpha
- */
-export declare const Stepper: (stepperProps: StepperProps) => JSX.Element;
-
-/**
- * The Props for {@link Stepper} component
- * @alpha
- */
-export declare type StepperProps = {
-    manifest: TemplateParameterSchema;
-    extensions: NextFieldExtensionOptions<any, any>[];
-    templateName?: string;
-    FormProps?: FormProps;
-    initialState?: Record<string, JsonValue>;
-    onCreate: (values: Record<string, JsonValue>) => Promise<void>;
-    components?: {
-        ReviewStateComponent?: (props: ReviewStateProps) => JSX.Element;
-        createButtonText?: ReactNode;
-        reviewButtonText?: ReactNode;
-    };
-    layouts?: LayoutOptions[];
-};
-
-/**
- * The `TemplateCard` component that is rendered in a list for each template
- * @alpha
- */
-export declare const TemplateCard: (props: TemplateCardProps) => JSX.Element;
-
-/**
- * The Props for the {@link TemplateCard} component
- * @alpha
- */
-export declare interface TemplateCardProps {
-    template: TemplateEntityV1beta3;
-    additionalLinks?: {
-        icon: IconComponent;
-        text: string;
-        url: string;
-    }[];
-    onSelected?: (template: TemplateEntityV1beta3) => void;
-}
-
-/**
- * The `TemplateGroup` component is used to display a group of templates with a title.
- * @alpha
- */
-export declare const TemplateGroup: (props: TemplateGroupProps) => JSX.Element;
-
-/**
- * The props for the {@link TemplateGroup} component.
- * @alpha
- */
-export declare interface TemplateGroupProps {
-    templates: {
-        template: TemplateEntityV1beta3;
-        additionalLinks?: {
-            icon: IconComponent;
-            text: string;
-            url: string;
-        }[];
-    }[];
-    onSelected: (template: TemplateEntityV1beta3) => void;
-    title: React_2.ReactNode;
-    components?: {
-        CardComponent?: React_2.ComponentType<TemplateCardProps>;
-    };
-}
-
-/**
- * The shape of each entry of parameters which gets rendered
- * as a separate step in the wizard input
- *
- * @public
- */
-export declare type TemplateParameterSchema = {
-    title: string;
-    description?: string;
-    steps: Array<{
-        title: string;
-        description?: string;
-        schema: JsonObject;
-    }>;
-};
-
-/**
- * Hook that returns all custom field extensions from the current outlet.
- * @public
- */
-export declare const useCustomFieldExtensions: <TComponentDataType = FieldExtensionOptions<unknown, unknown>>(outlet: React.ReactNode) => TComponentDataType[];
-
-/**
- * Hook that returns all custom field extensions from the current outlet.
- * @public
- */
-export declare const useCustomLayouts: <TComponentDataType = LayoutOptions<any>>(outlet: React.ReactNode) => TComponentDataType[];
-
-/**
- * This hook is used to get the formData from the query string.
- * @alpha
- */
-export declare const useFormDataFromQuery: (initialState?: Record<string, JsonValue>) => [Record<string, any>, Dispatch<SetStateAction<Record<string, any>>>];
-
-/**
- * @alpha
- */
-export declare const useTemplateParameterSchema: (templateRef: string) => {
-    manifest: TemplateParameterSchema | undefined;
-    loading: boolean;
-    error: Error | undefined;
-};
-
-/**
- * This hook will parse the template schema and return the steps with the
- * parsed schema and uiSchema. Filtering out any steps or properties that
- * are not enabled with feature flags.
- * @alpha
- */
-export declare const useTemplateSchema: (manifest: TemplateParameterSchema) => {
-    steps: ParsedTemplateSchema[];
-};
-
-/**
- * Hook to access the secrets context to be able to set secrets that are
- * passed to the Scaffolder backend.
- * @public
- */
-export declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
-
-/**
- * @alpha
- */
-export declare const Workflow: (workflowProps: WorkflowProps) => JSX.Element | null;
-
-/**
- * @alpha
- */
-export declare type WorkflowProps = {
-    title?: string;
-    description?: string;
-    namespace: string;
-    templateName: string;
-    onError(error: Error | undefined): JSX.Element | null;
-} & Pick<StepperProps, 'extensions' | 'FormProps' | 'components' | 'onCreate' | 'initialState' | 'layouts'>;
-
-export { }