@backstage/plugin-scaffolder-backend 0.16.0 → 0.17.1

package/dist/index.d.ts

@@ -0,0 +1,664 @@
+/// <reference types="node" />
+import { ScmIntegrations, ScmIntegrationRegistry, GithubCredentialsProvider } from '@backstage/integration';
+import { CatalogApi } from '@backstage/catalog-client';
+import { Logger } from 'winston';
+import { Writable } from 'stream';
+import { JsonValue, JsonObject, Observable } from '@backstage/types';
+import { Schema } from 'jsonschema';
+import { TaskSpec, TemplateMetadata, TemplateInfo } from '@backstage/plugin-scaffolder-common';
+import { Entity } from '@backstage/catalog-model';
+import { UrlReader, ContainerRunner, PluginDatabaseManager } from '@backstage/backend-common';
+import { Config } from '@backstage/config';
+import { createPullRequest } from 'octokit-plugin-create-pull-request';
+import { Octokit } from 'octokit';
+export { createFetchCookiecutterAction } from '@backstage/plugin-scaffolder-backend-module-cookiecutter';
+import { SpawnOptionsWithoutStdio } from 'child_process';
+import { Knex } from 'knex';
+import express from 'express';
+import { CatalogProcessor, LocationSpec, CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
+
+declare function createCatalogRegisterAction(options: {
+    catalogClient: CatalogApi;
+    integrations: ScmIntegrations;
+}): TemplateAction<{
+    catalogInfoUrl: string;
+    optional?: boolean | undefined;
+} | {
+    repoContentsUrl: string;
+    catalogInfoPath?: string | undefined;
+    optional?: boolean | undefined;
+}>;
+
+declare function createCatalogWriteAction(): TemplateAction<{
+    filePath?: string | undefined;
+    entity: Entity;
+}>;
+
+declare type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
+
+/**
+ * The status of each step of the Task
+ *
+ * @public
+ */
+declare type TaskStatus = 'open' | 'processing' | 'failed' | 'cancelled' | 'completed';
+/**
+ * The status of each step of the Task
+ *
+ * @public
+ * @deprecated use TaskStatus instead
+ */
+declare type Status = TaskStatus;
+/**
+ * The state of a completed task.
+ *
+ * @public
+ */
+declare type TaskCompletionState = 'failed' | 'completed';
+/**
+ * The state of a completed task.
+ *
+ * @public
+ * @deprecated use TaskCompletionState instead
+ */
+declare type CompletedTaskState = TaskCompletionState;
+/**
+ * SerializedTask
+ *
+ * @public
+ */
+declare type SerializedTask = {
+    id: string;
+    spec: TaskSpec;
+    status: TaskStatus;
+    createdAt: string;
+    lastHeartbeatAt?: string;
+    secrets?: TaskSecrets;
+};
+/**
+ * TaskEventType
+ *
+ * @public
+ */
+declare type TaskEventType = 'completion' | 'log';
+/**
+ * SerializedTaskEvent
+ *
+ * @public
+ */
+declare type SerializedTaskEvent = {
+    id: number;
+    taskId: string;
+    body: JsonObject;
+    type: TaskEventType;
+    createdAt: string;
+};
+/**
+ * TaskSecrets
+ *
+ * @public
+ */
+declare type TaskSecrets = Record<string, string> & {
+    backstageToken?: string;
+};
+/**
+ * The result of {@link TaskBroker.dispatch}
+ *
+ * @public
+ */
+declare type TaskBrokerDispatchResult = {
+    taskId: string;
+};
+/**
+ * The options passed to {@link TaskBroker.dispatch}
+ * Currently a spec and optional secrets
+ *
+ * @public
+ */
+declare type TaskBrokerDispatchOptions = {
+    spec: TaskSpec;
+    secrets?: TaskSecrets;
+};
+/**
+ * DispatchResult
+ *
+ * @public
+ * @deprecated use TaskBrokerDispatchResult instead
+ */
+declare type DispatchResult = TaskBrokerDispatchResult;
+/**
+ * Task
+ *
+ * @public
+ */
+interface TaskContext {
+    spec: TaskSpec;
+    secrets?: TaskSecrets;
+    done: boolean;
+    emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
+    complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
+    getWorkspaceName(): Promise<string>;
+}
+/**
+ * TaskBroker
+ *
+ * @public
+ */
+interface TaskBroker {
+    claim(): Promise<TaskContext>;
+    dispatch(options: TaskBrokerDispatchOptions): Promise<TaskBrokerDispatchResult>;
+    vacuumTasks(options: {
+        timeoutS: number;
+    }): Promise<void>;
+    event$(options: {
+        taskId: string;
+        after: number | undefined;
+    }): Observable<{
+        events: SerializedTaskEvent[];
+    }>;
+    get(taskId: string): Promise<SerializedTask>;
+}
+/**
+ * TaskStoreEmitOptions
+ *
+ * @public
+ */
+declare type TaskStoreEmitOptions<TBody = JsonObject> = {
+    taskId: string;
+    body: TBody;
+};
+/**
+ * TaskStoreListEventsOptions
+ *
+ * @public
+ */
+declare type TaskStoreListEventsOptions = {
+    taskId: string;
+    after?: number | undefined;
+};
+/**
+ * The options passed to {@link TaskStore.createTask}
+ * @public
+ */
+declare type TaskStoreCreateTaskOptions = {
+    spec: TaskSpec;
+    secrets?: TaskSecrets;
+};
+/**
+ * The response from {@link TaskStore.createTask}
+ * @public
+ */
+declare type TaskStoreCreateTaskResult = {
+    taskId: string;
+};
+/**
+ * TaskStore
+ *
+ * @public
+ */
+interface TaskStore {
+    createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
+    getTask(taskId: string): Promise<SerializedTask>;
+    claimTask(): Promise<SerializedTask | undefined>;
+    completeTask(options: {
+        taskId: string;
+        status: TaskStatus;
+        eventBody: JsonObject;
+    }): Promise<void>;
+    heartbeatTask(taskId: string): Promise<void>;
+    listStaleTasks(options: {
+        timeoutS: number;
+    }): Promise<{
+        tasks: {
+            taskId: string;
+        }[];
+    }>;
+    emitLogEvent({ taskId, body }: TaskStoreEmitOptions): Promise<void>;
+    listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
+        events: SerializedTaskEvent[];
+    }>;
+}
+
+declare type ActionContext<Input extends JsonObject> = {
+    /**
+     * Base URL for the location of the task spec, typically the url of the source entity file.
+     * @deprecated please use templateInfo.baseUrl instead
+     */
+    baseUrl?: string;
+    logger: Logger;
+    logStream: Writable;
+    secrets?: TaskSecrets;
+    workspacePath: string;
+    input: Input;
+    output(name: string, value: JsonValue): void;
+    /**
+     * Creates a temporary directory for use by the action, which is then cleaned up automatically.
+     */
+    createTemporaryDirectory(): Promise<string>;
+    /**
+     * @deprecated please use templateInfo instead
+     */
+    metadata?: TemplateMetadata;
+    templateInfo?: TemplateInfo;
+};
+declare type TemplateAction<Input extends JsonObject> = {
+    id: string;
+    description?: string;
+    schema?: {
+        input?: Schema;
+        output?: Schema;
+    };
+    handler: (ctx: ActionContext<Input>) => Promise<void>;
+};
+
+/**
+ * The options passed to {@link createBuiltinActions}
+ * @public
+ */
+interface CreateBuiltInActionsOptions {
+    reader: UrlReader;
+    integrations: ScmIntegrations;
+    catalogClient: CatalogApi;
+    /** @deprecated when the cookiecutter action is removed this won't be necessary */
+    containerRunner?: ContainerRunner;
+    config: Config;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
+}
+/**
+ * A function to generate create a list of default actions that the scaffolder provides.
+ * Is called internally in the default setup, but can be used when adding your own actions or overriding the default ones
+ *
+ * @public
+ * @returns A list of actions that can be used in the scaffolder
+ */
+declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction<JsonObject>[];
+
+/**
+ * This task is useful for local development and testing of both the scaffolder
+ * and scaffolder templates.
+ */
+declare function createDebugLogAction(): TemplateAction<{
+    message?: string | undefined;
+    listWorkspace?: boolean | undefined;
+}>;
+
+declare function createFetchPlainAction(options: {
+    reader: UrlReader;
+    integrations: ScmIntegrations;
+}): TemplateAction<{
+    url: string;
+    targetPath?: string | undefined;
+}>;
+
+declare function createFetchTemplateAction(options: {
+    reader: UrlReader;
+    integrations: ScmIntegrations;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
+}): TemplateAction<{
+    url: string;
+    targetPath?: string | undefined;
+    values: any;
+    templateFileExtension?: string | boolean | undefined;
+    copyWithoutRender?: string[] | undefined;
+    cookiecutterCompat?: boolean | undefined;
+}>;
+
+/**
+ * A helper function that reads the contents of a directory from the given URL.
+ * Can be used in your own actions, and also used behind fetch:template and fetch:plain
+ *
+ * @public
+ */
+declare function fetchContents({ reader, integrations, baseUrl, fetchUrl, outputPath, }: {
+    reader: UrlReader;
+    integrations: ScmIntegrations;
+    baseUrl?: string;
+    fetchUrl?: string;
+    outputPath: string;
+}): Promise<void>;
+
+declare const createFilesystemDeleteAction: () => TemplateAction<{
+    files: string[];
+}>;
+
+declare const createFilesystemRenameAction: () => TemplateAction<{
+    files: Array<{
+        from: string;
+        to: string;
+        overwrite?: boolean;
+    }>;
+}>;
+
+declare function createPublishAzureAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
+}): TemplateAction<{
+    repoUrl: string;
+    description?: string | undefined;
+    defaultBranch?: string | undefined;
+    sourcePath?: string | undefined;
+    token?: string | undefined;
+}>;
+
+declare function createPublishBitbucketAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
+}): TemplateAction<{
+    repoUrl: string;
+    description?: string | undefined;
+    defaultBranch?: string | undefined;
+    repoVisibility?: "private" | "public" | undefined;
+    sourcePath?: string | undefined;
+    enableLFS?: boolean | undefined;
+    token?: string | undefined;
+}>;
+
+/**
+ * This task is useful for local development and testing of both the scaffolder
+ * and scaffolder templates.
+ *
+ * This action is not installed by default and should not be installed in
+ * production, as it writes the files to the local filesystem of the scaffolder.
+ */
+declare function createPublishFileAction(): TemplateAction<{
+    path: string;
+}>;
+
+declare function createPublishGithubAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
+    githubCredentialsProvider?: GithubCredentialsProvider;
+}): TemplateAction<{
+    repoUrl: string;
+    description?: string | undefined;
+    access?: string | undefined;
+    defaultBranch?: string | undefined;
+    sourcePath?: string | undefined;
+    requireCodeOwnerReviews?: boolean | undefined;
+    repoVisibility?: "internal" | "private" | "public" | undefined;
+    collaborators?: {
+        username: string;
+        access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
+    }[] | undefined;
+    token?: string | undefined;
+    topics?: string[] | undefined;
+}>;
+
+declare type CreatePullRequestResponse = {
+    data: {
+        html_url: string;
+    };
+};
+interface PullRequestCreator {
+    createPullRequest(options: createPullRequest.Options): Promise<CreatePullRequestResponse | null>;
+}
+declare type ClientFactoryInput = {
+    integrations: ScmIntegrationRegistry;
+    githubCredentialsProvider?: GithubCredentialsProvider;
+    host: string;
+    owner: string;
+    repo: string;
+    token?: string;
+};
+interface CreateGithubPullRequestActionOptions {
+    integrations: ScmIntegrationRegistry;
+    githubCredentialsProvider?: GithubCredentialsProvider;
+    clientFactory?: (input: ClientFactoryInput) => Promise<PullRequestCreator>;
+}
+declare const createPublishGithubPullRequestAction: ({ integrations, githubCredentialsProvider, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<{
+    title: string;
+    branchName: string;
+    description: string;
+    repoUrl: string;
+    targetPath?: string | undefined;
+    sourcePath?: string | undefined;
+    token?: string | undefined;
+}>;
+
+declare function createPublishGitlabAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
+}): TemplateAction<{
+    repoUrl: string;
+    defaultBranch?: string | undefined;
+    repoVisibility?: "internal" | "private" | "public" | undefined;
+    sourcePath?: string | undefined;
+    token?: string | undefined;
+}>;
+
+declare const createPublishGitlabMergeRequestAction: (options: {
+    integrations: ScmIntegrationRegistry;
+}) => TemplateAction<{
+    projectid: string;
+    repoUrl: string;
+    title: string;
+    description: string;
+    branchName: string;
+    targetPath: string;
+    token?: string | undefined;
+}>;
+
+declare function createGithubActionsDispatchAction(options: {
+    integrations: ScmIntegrations;
+    githubCredentialsProvider?: GithubCredentialsProvider;
+}): TemplateAction<{
+    repoUrl: string;
+    workflowId: string;
+    branchOrTagName: string;
+    workflowInputs?: {
+        [key: string]: string;
+    } | undefined;
+    token?: string | undefined;
+}>;
+
+declare function createGithubWebhookAction(options: {
+    integrations: ScmIntegrationRegistry;
+    defaultWebhookSecret?: string;
+    githubCredentialsProvider?: GithubCredentialsProvider;
+}): TemplateAction<{
+    repoUrl: string;
+    webhookUrl: string;
+    webhookSecret?: string | undefined;
+    events?: string[] | undefined;
+    active?: boolean | undefined;
+    contentType?: "form" | "json" | undefined;
+    insecureSsl?: boolean | undefined;
+    token?: string | undefined;
+}>;
+
+declare type OctokitIntegration = {
+    client: Octokit;
+    token: string;
+    owner: string;
+    repo: string;
+};
+/**
+ * OctokitProvider provides Octokit client based on ScmIntegrationsRegistry configuration.
+ * OctokitProvider supports GitHub credentials caching out of the box.
+ *
+ * @deprecated we are no longer providing a way from the scaffolder to generate octokit instances.
+ * Implement your own if you're using this method from an external package, or use the internal `getOctokitOptions` function instead
+ */
+declare class OctokitProvider {
+    private readonly integrations;
+    private readonly githubCredentialsProvider;
+    constructor(integrations: ScmIntegrationRegistry, githubCredentialsProvider?: GithubCredentialsProvider);
+    /**
+     * gets standard Octokit client based on repository URL.
+     *
+     * @param repoUrl - Repository URL
+     *
+     * @deprecated we are no longer providing a way from the scaffolder to generate octokit instances.
+     * Implement your own if you're using this method from an external package, or use the internal `getOctokitOptions` function instead
+     */
+    getOctokit(repoUrl: string, options?: {
+        token?: string;
+    }): Promise<OctokitIntegration>;
+}
+
+declare type RunCommandOptions = {
+    /** command to run */
+    command: string;
+    /** arguments to pass the command */
+    args: string[];
+    /** options to pass to spawn */
+    options?: SpawnOptionsWithoutStdio;
+    /** stream to capture stdout and stderr output */
+    logStream?: Writable;
+};
+/**
+ * Run a command in a sub-process, normally a shell command.
+ *
+ * @public
+ */
+declare const executeShellCommand: (options: RunCommandOptions) => Promise<void>;
+/**
+ * Run a command in a sub-process, normally a shell command.
+ * @public
+ * @deprecated use {@link executeShellCommand} instead
+ */
+declare const runCommand: (options: RunCommandOptions) => Promise<void>;
+
+declare class TemplateActionRegistry {
+    private readonly actions;
+    register<TInput extends JsonObject>(action: TemplateAction<TInput>): void;
+    get(actionId: string): TemplateAction<JsonObject>;
+    list(): TemplateAction<JsonObject>[];
+}
+
+declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
+
+/**
+ * DatabaseTaskStore
+ *
+ * @public
+ */
+declare type DatabaseTaskStoreOptions = {
+    database: Knex;
+};
+/**
+ * DatabaseTaskStore
+ *
+ * @public
+ */
+declare class DatabaseTaskStore implements TaskStore {
+    private readonly db;
+    static create(options: DatabaseTaskStoreOptions): Promise<DatabaseTaskStore>;
+    private constructor();
+    getTask(taskId: string): Promise<SerializedTask>;
+    createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
+    claimTask(): Promise<SerializedTask | undefined>;
+    heartbeatTask(taskId: string): Promise<void>;
+    listStaleTasks({ timeoutS }: {
+        timeoutS: number;
+    }): Promise<{
+        tasks: {
+            taskId: string;
+        }[];
+    }>;
+    completeTask({ taskId, status, eventBody, }: {
+        taskId: string;
+        status: TaskStatus;
+        eventBody: JsonObject;
+    }): Promise<void>;
+    emitLogEvent(options: TaskStoreEmitOptions<{
+        message: string;
+    } & JsonObject>): Promise<void>;
+    listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
+        events: SerializedTaskEvent[];
+    }>;
+}
+
+/**
+ * TaskManager
+ *
+ * @public
+ */
+declare class TaskManager implements TaskContext {
+    private readonly task;
+    private readonly storage;
+    private readonly logger;
+    private isDone;
+    private heartbeatTimeoutId?;
+    static create(task: CurrentClaimedTask, storage: TaskStore, logger: Logger): TaskManager;
+    private constructor();
+    get spec(): TaskSpec;
+    get secrets(): TaskSecrets | undefined;
+    getWorkspaceName(): Promise<string>;
+    get done(): boolean;
+    emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
+    complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
+    private startTimeout;
+}
+/**
+ * Stores the state of the current claimed task passed to the TaskContext
+ *
+ * @public
+ */
+interface CurrentClaimedTask {
+    spec: TaskSpec;
+    taskId: string;
+    secrets?: TaskSecrets;
+}
+/**
+ * TaskState
+ *
+ * @public
+ * @deprecated use CurrentClaimedTask instead
+ */
+declare type TaskState = CurrentClaimedTask;
+
+/**
+ * CreateWorkerOptions
+ *
+ * @public
+ */
+declare type CreateWorkerOptions = {
+    taskBroker: TaskBroker;
+    actionRegistry: TemplateActionRegistry;
+    integrations: ScmIntegrations;
+    workingDirectory: string;
+    logger: Logger;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
+};
+/**
+ * TaskWorker
+ *
+ * @public
+ */
+declare class TaskWorker {
+    private readonly options;
+    private constructor();
+    static create(options: CreateWorkerOptions): Promise<TaskWorker>;
+    start(): void;
+    runOneTask(task: TaskContext): Promise<void>;
+}
+
+/**
+ * RouterOptions
+ *
+ * @public
+ */
+interface RouterOptions {
+    logger: Logger;
+    config: Config;
+    reader: UrlReader;
+    database: PluginDatabaseManager;
+    catalogClient: CatalogApi;
+    actions?: TemplateAction<any>[];
+    taskWorkers?: number;
+    containerRunner?: ContainerRunner;
+    taskBroker?: TaskBroker;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
+}
+declare function createRouter(options: RouterOptions): Promise<express.Router>;
+
+/** @public */
+declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
+    getProcessorName(): string;
+    private readonly validators;
+    validateEntityKind(entity: Entity): Promise<boolean>;
+    postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
+}
+
+export { ActionContext, CompletedTaskState, CreateBuiltInActionsOptions, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskState, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents, runCommand };