@backstage/plugin-scaffolder 1.0.1 → 1.2.0-next.0

package/dist/index.d.ts

@@ -1,38 +1,128 @@
+/**
+ * The Backstage plugin that helps you create new things
+ *
+ * @packageDocumentation
+ */
+
 /// <reference types="react" />
-import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-import { DiscoveryApi, FetchApi, ApiHolder, Extension } from '@backstage/core-plugin-api';
-import { ScmIntegrationRegistry } from '@backstage/integration';
-import { JsonObject, JsonValue, Observable } from '@backstage/types';
-import { TaskSpec, TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
-import { JSONSchema7 } from 'json-schema';
-import React, { ComponentType } from 'react';
-import { FieldValidation, FieldProps } from '@rjsf/core';
+
+import { ApiHolder } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/core-plugin-api';
+import { BackstagePlugin } from '@backstage/core-plugin-api';
+import { ComponentType } from 'react';
+import { DiscoveryApi } from '@backstage/core-plugin-api';
 import { Entity } from '@backstage/catalog-model';
+import { Extension } from '@backstage/core-plugin-api';
+import { ExternalRouteRef } from '@backstage/core-plugin-api';
+import { FetchApi } from '@backstage/core-plugin-api';
+import { FieldProps } from '@rjsf/core';
+import { FieldValidation } from '@rjsf/core';
+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 { RouteRef } from '@backstage/core-plugin-api';
+import { ScmIntegrationRegistry } from '@backstage/integration';
+import { TaskSpec } from '@backstage/plugin-scaffolder-common';
+import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
 
 /**
- * The status of each task in a Scaffolder Job
+ * 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>>;
+
+/**
+ * Field validation type for Custom Field Extensions.
  *
  * @public
  */
-declare type ScaffolderTaskStatus = 'open' | 'processing' | 'failed' | 'completed' | 'skipped';
+export declare type CustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation, context: {
+    apiHolder: ApiHolder;
+}) => void;
+
 /**
- * The shape of each task returned from the `scaffolder-backend`
+ * The field extension for selecting a name for a new Entity in the Catalog.
  *
  * @public
  */
-declare type ScaffolderTask = {
-    id: string;
-    spec: TaskSpec;
-    status: 'failed' | 'completed' | 'processing' | 'open' | 'cancelled';
-    lastHeartbeatAt: string;
-    createdAt: string;
+export declare const EntityNamePickerFieldExtension: FieldExtensionComponent<string, {}>;
+
+/**
+ * A field extension for selecting an Entity that exists in the Catalog.
+ *
+ * @public
+ */
+export declare const EntityPickerFieldExtension: FieldExtensionComponent<string, EntityPickerUiOptions>;
+
+/**
+ * The input props that can be specified under `ui:options` for the
+ * `EntityPicker` field extension.
+ *
+ * @public
+ */
+export declare interface EntityPickerUiOptions {
+    allowedKinds?: string[];
+    defaultKind?: string;
+    allowArbitraryValues?: boolean;
+}
+
+/**
+ * EntityTagsPickerFieldExtension
+ * @public
+ */
+export declare const EntityTagsPickerFieldExtension: FieldExtensionComponent<string[], EntityTagsPickerUiOptions>;
+
+/**
+ * The input props that can be specified under `ui:options` for the
+ * `EntityTagsPicker` field extension.
+ *
+ * @public
+ */
+export declare interface EntityTagsPickerUiOptions {
+    kinds?: string[];
+}
+
+/**
+ * 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>;
 };
+
 /**
  * The response shape for the `listActions` call to the `scaffolder-backend`
  *
  * @public
  */
-declare type ListActionsResponse = Array<{
+export declare type ListActionsResponse = Array<{
     id: string;
     description?: string;
     schema?: {
@@ -40,38 +130,13 @@ declare type ListActionsResponse = Array<{
         output?: JSONSchema7;
     };
 }>;
-/** @public */
-declare type ScaffolderOutputLink = {
-    title?: string;
-    icon?: string;
-    url?: string;
-    entityRef?: string;
-};
-/** @public */
-declare type ScaffolderTaskOutput = {
-    links?: ScaffolderOutputLink[];
-} & {
-    [key: string]: unknown;
-};
-/**
- * The shape of each entry of parameters which gets rendered
- * as a separate step in the wizard input
- *
- * @public
- */
-declare type TemplateParameterSchema = {
-    title: string;
-    steps: Array<{
-        title: string;
-        schema: JsonObject;
-    }>;
-};
+
 /**
  * The shape of a `LogEvent` message from the `scaffolder-backend`
  *
  * @public
  */
-declare type LogEvent = {
+export declare type LogEvent = {
     type: 'log' | 'completion';
     body: {
         message: string;
@@ -82,59 +147,118 @@ declare type LogEvent = {
     id: string;
     taskId: string;
 };
+
+/* Excluded from this release type: NextRouterProps */
+
+/* Excluded from this release type: NextScaffolderPage */
+
 /**
- * The input options to the `scaffold` method of the `ScaffolderClient`.
+ * A field extension to show all the Entities that are owned by the current logged-in User for use in templates.
  *
  * @public
  */
-interface ScaffolderScaffoldOptions {
-    templateRef: string;
-    values: Record<string, JsonValue>;
-    secrets?: Record<string, string>;
-}
+export declare const OwnedEntityPickerFieldExtension: FieldExtensionComponent<string, OwnedEntityPickerUiOptions>;
+
 /**
- * The response shape of the `scaffold` method of the `ScaffolderClient`.
+ * The input props that can be specified under `ui:options` for the
+ * `OwnedEntityPicker` field extension.
  *
  * @public
  */
-interface ScaffolderScaffoldResponse {
-    taskId: string;
+export declare interface OwnedEntityPickerUiOptions {
+    allowedKinds?: string[];
+    defaultKind?: string;
 }
+
 /**
- * The arguments for `getIntegrationsList`.
+ * A field extension for picking users and groups out of the Catalog.
  *
  * @public
  */
-interface ScaffolderGetIntegrationsListOptions {
-    allowedHosts: string[];
-}
+export declare const OwnerPickerFieldExtension: FieldExtensionComponent<string, OwnerPickerUiOptions>;
+
 /**
- * The response shape for `getIntegrationsList`.
+ * The input props that can be specified under `ui:options` for the
+ * `OwnerPicker` field extension.
  *
  * @public
  */
-interface ScaffolderGetIntegrationsListResponse {
-    integrations: {
-        type: string;
-        title: string;
-        host: string;
-    }[];
+export declare interface OwnerPickerUiOptions {
+    allowedKinds?: string[];
 }
+
 /**
- * The input options to the `streamLogs` method of the `ScaffolderClient`.
+ * The validation function for the `repoUrl` that is returned from the
+ * field extension. Ensures that you have all the required fields filled for
+ * the different providers that exist.
  *
  * @public
  */
-interface ScaffolderStreamLogsOptions {
-    taskId: string;
-    after?: number;
+export declare const repoPickerValidation: (value: string, validation: FieldValidation, context: {
+    apiHolder: ApiHolder;
+}) => void;
+
+/**
+ * The field extension which provides the ability to select a RepositoryUrl.
+ * Currently this is an encoded URL that looks something like the following `github.com?repo=myRepoName&owner=backstage`.
+ *
+ * @public
+ */
+export declare const RepoUrlPickerFieldExtension: FieldExtensionComponent<string, RepoUrlPickerUiOptions>;
+
+/**
+ * The input props that can be specified under `ui:options` for the
+ * `RepoUrlPicker` field extension.
+ *
+ * @public
+ */
+export declare interface RepoUrlPickerUiOptions {
+    allowedHosts?: string[];
+    allowedOwners?: string[];
+    requestUserCredentials?: {
+        secretsKey: string;
+        additionalScopes?: {
+            github?: string[];
+            gitlab?: string[];
+            bitbucket?: string[];
+            azure?: string[];
+        };
+    };
 }
+
+/**
+ * The props for the entrypoint `ScaffolderPage` component the plugin.
+ * @public
+ */
+export declare type RouterProps = {
+    components?: {
+        TemplateCardComponent?: ComponentType<{
+            template: TemplateEntityV1beta3;
+        }> | undefined;
+        TaskPageComponent?: ComponentType<{}>;
+    };
+    groups?: Array<{
+        title?: React_2.ReactNode;
+        filter: (entity: Entity) => boolean;
+    }>;
+    defaultPreviewTemplate?: string;
+    /**
+     * Options for the context menu on the scaffolder page.
+     */
+    contextMenu?: {
+        /** Whether to show a link to the template editor */
+        editor?: boolean;
+        /** Whether to show a link to the actions documentation */
+        actions?: boolean;
+    };
+};
+
 /**
  * An API to interact with the scaffolder backend.
  *
  * @public
  */
-interface ScaffolderApi {
+export declare interface ScaffolderApi {
     getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema>;
     /**
      * Executes the scaffolding of a component, given a template and its
@@ -157,13 +281,14 @@ interface ScaffolderApi {
  *
  * @public
  */
-declare const scaffolderApiRef: _backstage_core_plugin_api.ApiRef<ScaffolderApi>;
+export declare const scaffolderApiRef: ApiRef<ScaffolderApi>;
+
 /**
  * An API to interact with the scaffolder backend.
  *
  * @public
  */
-declare class ScaffolderClient implements ScaffolderApi {
+export declare class ScaffolderClient implements ScaffolderApi {
     private readonly discoveryApi;
     private readonly scmIntegrationsApi;
     private readonly fetchApi;
@@ -191,234 +316,169 @@ declare class ScaffolderClient implements ScaffolderApi {
 }
 
 /**
- * Field validation type for Custom Field Extensions.
- *
- * @public
- */
-declare type CustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation, context: {
-    apiHolder: ApiHolder;
-}) => void;
-/**
- * Type for the Custom Field Extension with the
- * name and components and validation function.
- *
- * @public
- */
-declare type FieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
-    name: string;
-    component: (props: FieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
-    validation?: CustomFieldValidator<TFieldReturnValue>;
-};
-/**
- * Type for field extensions and being able to type
- * incoming props easier.
+ * The Wrapping component for defining fields extensions inside
  *
  * @public
  */
-interface FieldExtensionComponentProps<TFieldReturnValue, TUiOptions extends {} = {}> extends FieldProps<TFieldReturnValue> {
-    uiSchema: FieldProps['uiSchema'] & {
-        'ui:options'?: TUiOptions;
-    };
-}
+export declare const ScaffolderFieldExtensions: React_2.ComponentType;
 
 /**
- * The input props that can be specified under `ui:options` for the
- * `RepoUrlPicker` field extension.
+ * The arguments for `getIntegrationsList`.
  *
  * @public
  */
-interface RepoUrlPickerUiOptions {
-    allowedHosts?: string[];
-    allowedOwners?: string[];
-    requestUserCredentials?: {
-        secretsKey: string;
-        additionalScopes?: {
-            github?: string[];
-            gitlab?: string[];
-            bitbucket?: string[];
-            azure?: string[];
-        };
-    };
+export declare interface ScaffolderGetIntegrationsListOptions {
+    allowedHosts: string[];
 }
 
 /**
- * The input props that can be specified under `ui:options` for the
- * `EntityTagsPicker` field extension.
+ * The response shape for `getIntegrationsList`.
  *
  * @public
  */
-interface EntityTagsPickerUiOptions {
-    kinds?: string[];
+export declare interface ScaffolderGetIntegrationsListResponse {
+    integrations: {
+        type: string;
+        title: string;
+        host: string;
+    }[];
 }
 
-/**
- * The input props that can be specified under `ui:options` for the
- * `EntityPicker` field extension.
- *
- * @public
- */
-interface EntityPickerUiOptions {
-    allowedKinds?: string[];
-    defaultKind?: string;
-    allowArbitraryValues?: boolean;
-}
+/** @public */
+export declare type ScaffolderOutputLink = {
+    title?: string;
+    icon?: string;
+    url?: string;
+    entityRef?: string;
+};
 
 /**
- * A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
+ * The Router and main entrypoint to the Scaffolder plugin.
  *
  * @public
  */
-declare type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;
-/**
- * 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>>;
+export declare const ScaffolderPage: (props: RouterProps) => JSX.Element;
+
 /**
- * The Wrapping component for defining fields extensions inside
- *
+ * The main plugin export for the scaffolder.
  * @public
  */
-declare const ScaffolderFieldExtensions: React.ComponentType;
+export declare const scaffolderPlugin: BackstagePlugin<    {
+root: RouteRef<undefined>;
+}, {
+registerComponent: ExternalRouteRef<undefined, true>;
+}>;
 
 /**
- * The input props that can be specified under `ui:options` for the
- * `OwnedEntityPicker` field extension.
+ * The input options to the `scaffold` method of the `ScaffolderClient`.
  *
  * @public
  */
-interface OwnedEntityPickerUiOptions {
-    allowedKinds?: string[];
-    defaultKind?: string;
+export declare interface ScaffolderScaffoldOptions {
+    templateRef: string;
+    values: Record<string, JsonValue>;
+    secrets?: Record<string, string>;
 }
 
 /**
- * The props for the entrypoint `ScaffolderPage` component the plugin.
- * @public
- */
-declare type RouterProps = {
-    components?: {
-        TemplateCardComponent?: ComponentType<{
-            template: TemplateEntityV1beta3;
-        }> | undefined;
-        TaskPageComponent?: ComponentType<{}>;
-    };
-    groups?: Array<{
-        title?: React.ReactNode;
-        filter: (entity: Entity) => boolean;
-    }>;
-    defaultPreviewTemplate?: string;
-};
-
-/**
- * The input props that can be specified under `ui:options` for the
- * `OwnerPicker` field extension.
+ * The response shape of the `scaffold` method of the `ScaffolderClient`.
  *
  * @public
  */
-interface OwnerPickerUiOptions {
-    allowedKinds?: string[];
+export declare interface ScaffolderScaffoldResponse {
+    taskId: string;
 }
 
 /**
- * The validation function for the `repoUrl` that is returned from the
- * field extension. Ensures that you have all the required fields filled for
- * the different providers that exist.
+ * The input options to the `streamLogs` method of the `ScaffolderClient`.
  *
  * @public
  */
-declare const repoPickerValidation: (value: string, validation: FieldValidation, context: {
-    apiHolder: ApiHolder;
-}) => void;
+export declare interface ScaffolderStreamLogsOptions {
+    taskId: string;
+    after?: number;
+}
 
 /**
- * The main plugin export for the scaffolder.
- * @public
- */
-declare const scaffolderPlugin: _backstage_core_plugin_api.BackstagePlugin<{
-    root: _backstage_core_plugin_api.RouteRef<undefined>;
-}, {
-    registerComponent: _backstage_core_plugin_api.ExternalRouteRef<undefined, true>;
-}>;
-/**
- * A field extension for selecting an Entity that exists in the Catalog.
+ * The shape of each task returned from the `scaffolder-backend`
  *
  * @public
  */
-declare const EntityPickerFieldExtension: FieldExtensionComponent<string, EntityPickerUiOptions>;
+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 field extension for selecting a name for a new Entity in the Catalog.
+ * The status of each task in a Scaffolder Job
  *
  * @public
  */
-declare const EntityNamePickerFieldExtension: FieldExtensionComponent<string, {}>;
+export declare type ScaffolderTaskStatus = 'open' | 'processing' | 'failed' | 'completed' | 'skipped';
+
 /**
- * The field extension which provides the ability to select a RepositoryUrl.
- * Currently this is an encoded URL that looks something like the following `github.com?repo=myRepoName&owner=backstage`.
- *
+ * The return type from the useTemplateSecrets hook.
  * @public
  */
-declare const RepoUrlPickerFieldExtension: FieldExtensionComponent<string, RepoUrlPickerUiOptions>;
+export declare interface ScaffolderUseTemplateSecrets {
+    setSecrets: (input: Record<string, string>) => void;
+}
+
 /**
- * A field extension for picking users and groups out of the Catalog.
+ * TaskPage for showing the status of the taskId provided as a param
+ * @param loadingText - Optional loading text shown before a task begins executing.
  *
  * @public
  */
-declare const OwnerPickerFieldExtension: FieldExtensionComponent<string, OwnerPickerUiOptions>;
+export declare const TaskPage: ({ loadingText }: TaskPageProps) => JSX.Element;
+
 /**
- * The Router and main entrypoint to the Scaffolder plugin.
+ * TaskPageProps for constructing a TaskPage
+ * @param loadingText - Optional loading text shown before a task begins executing.
  *
  * @public
  */
-declare const ScaffolderPage: (props: RouterProps) => JSX.Element;
+export declare type TaskPageProps = {
+    loadingText?: string;
+};
+
+/* Excluded from this release type: TemplateGroupFilter */
+
 /**
- * A field extension to show all the Entities that are owned by the current logged-in User for use in templates.
+ * The shape of each entry of parameters which gets rendered
+ * as a separate step in the wizard input
  *
  * @public
  */
-declare const OwnedEntityPickerFieldExtension: FieldExtensionComponent<string, OwnedEntityPickerUiOptions>;
-/**
- * EntityTagsPickerFieldExtension
- * @public
- */
-declare const EntityTagsPickerFieldExtension: FieldExtensionComponent<string[], EntityTagsPickerUiOptions>;
+export declare type TemplateParameterSchema = {
+    title: string;
+    steps: Array<{
+        title: string;
+        schema: JsonObject;
+    }>;
+};
 
 /**
  * The component to select the `type` of `Template` that you will see in the table.
  *
  * @public
  */
-declare const TemplateTypePicker: () => JSX.Element | null;
+export declare const TemplateTypePicker: () => JSX.Element | null;
 
-/**
- * The return type from the useTemplateSecrets hook.
- * @public
- */
-interface ScaffolderUseTemplateSecrets {
-    setSecrets: (input: Record<string, string>) => void;
-}
 /**
  * Hook to access the secrets context.
  * @public
  */
-declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
-
-/**
- * TaskPageProps for constructing a TaskPage
- * @param loadingText - Optional loading text shown before a task begins executing.
- *
- * @public
- */
-declare type TaskPageProps = {
-    loadingText?: string;
-};
-/**
- * TaskPage for showing the status of the taskId provided as a param
- * @param loadingText - Optional loading text shown before a task begins executing.
- *
- * @public
- */
-declare const TaskPage: ({ loadingText }: TaskPageProps) => JSX.Element;
+export declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
 
-export { CustomFieldValidator, EntityNamePickerFieldExtension, EntityPickerFieldExtension, EntityPickerUiOptions, EntityTagsPickerFieldExtension, EntityTagsPickerUiOptions, FieldExtensionComponent, FieldExtensionComponentProps, FieldExtensionOptions, ListActionsResponse, LogEvent, OwnedEntityPickerFieldExtension, OwnedEntityPickerUiOptions, OwnerPickerFieldExtension, OwnerPickerUiOptions, RepoUrlPickerFieldExtension, RepoUrlPickerUiOptions, RouterProps, ScaffolderApi, ScaffolderClient, ScaffolderFieldExtensions, ScaffolderGetIntegrationsListOptions, ScaffolderGetIntegrationsListResponse, ScaffolderOutputLink, ScaffolderPage, ScaffolderScaffoldOptions, ScaffolderScaffoldResponse, ScaffolderStreamLogsOptions, ScaffolderTask, ScaffolderTaskOutput, ScaffolderTaskStatus, ScaffolderUseTemplateSecrets, TaskPage, TaskPageProps, TemplateParameterSchema, TemplateTypePicker, createScaffolderFieldExtension, repoPickerValidation, scaffolderApiRef, scaffolderPlugin, useTemplateSecrets };
+export { }

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-export { p as EntityNamePickerFieldExtension, o as EntityPickerFieldExtension, q as EntityTagsPickerFieldExtension, u as OwnedEntityPickerFieldExtension, t as OwnerPickerFieldExtension, v as RepoUrlPickerFieldExtension, l as ScaffolderClient, n as ScaffolderFieldExtensions, w as ScaffolderPage, k as TaskPage, T as TemplateTypePicker, m as createScaffolderFieldExtension, r as repoPickerValidation, f as scaffolderApiRef, x as scaffolderPlugin, y as useTemplateSecrets } from './esm/index-25fdb62e.esm.js';
+export { t as EntityNamePickerFieldExtension, q as EntityPickerFieldExtension, u as EntityTagsPickerFieldExtension, N as NextScaffolderPage, w as OwnedEntityPickerFieldExtension, v as OwnerPickerFieldExtension, x as RepoUrlPickerFieldExtension, n as ScaffolderClient, p as ScaffolderFieldExtensions, y as ScaffolderPage, h as TaskPage, T as TemplateTypePicker, o as createScaffolderFieldExtension, l as repoPickerValidation, b as scaffolderApiRef, z as scaffolderPlugin, A as useTemplateSecrets } from './esm/index-e7455fc8.esm.js';
 import '@backstage/catalog-model';
 import '@backstage/core-plugin-api';
 import '@backstage/errors';