@backstage/plugin-scaffolder-react 0.0.0-nightly-20230111022819

package/dist/index.beta.d.ts

@@ -0,0 +1,361 @@
+/// <reference types="react" />
+
+import { ApiHolder } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/core-plugin-api';
+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 type { 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 { 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;
+};
+
+/* 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.
+ * @public
+ */
+export declare function createScaffolderFieldExtension<TReturnValue = unknown, TInputProps = unknown>(options: FieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, 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>;
+
+/* Excluded from this release type: extractSchemaFromStep */
+
+/**
+ * A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
+ * @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;
+};
+
+/* Excluded from this release type: FormProps */
+
+/**
+ * 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;
+};
+
+/* 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.
+ *
+ * @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;
+    }[];
+}
+
+/** @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;
+
+/* 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 */
+
+/**
+ * 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[];
+
+/* Excluded from this release type: useFormDataFromQuery */
+
+/* Excluded from this release type: useTemplateSchema */
+
+/**
+ * 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;
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,361 @@
+/// <reference types="react" />
+
+import { ApiHolder } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/core-plugin-api';
+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 type { 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 { 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;
+};
+
+/* 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.
+ * @public
+ */
+export declare function createScaffolderFieldExtension<TReturnValue = unknown, TInputProps = unknown>(options: FieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, 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>;
+
+/* Excluded from this release type: extractSchemaFromStep */
+
+/**
+ * A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
+ * @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;
+};
+
+/* Excluded from this release type: FormProps */
+
+/**
+ * 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;
+};
+
+/* 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.
+ *
+ * @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;
+    }[];
+}
+
+/** @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;
+
+/* 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 */
+
+/**
+ * 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[];
+
+/* Excluded from this release type: useFormDataFromQuery */
+
+/* Excluded from this release type: useTemplateSchema */
+
+/**
+ * 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;
+
+export { }