@backstage/plugin-scaffolder-backend 0.15.24 → 0.16.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "0.15.24",
+  "version": "0.16.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -11,6 +11,9 @@
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"
   },
+  "backstage": {
+    "role": "backend-plugin"
+  },
   "homepage": "https://backstage.io",
   "repository": {
     "type": "git",
@@ -21,26 +24,26 @@
     "backstage"
   ],
   "scripts": {
-    "start": "backstage-cli backend:dev",
-    "build": "backstage-cli backend:build",
-    "lint": "backstage-cli lint",
-    "test": "backstage-cli test",
-    "prepack": "backstage-cli prepack",
-    "postpack": "backstage-cli postpack",
-    "clean": "backstage-cli clean",
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean",
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.10.7",
-    "@backstage/catalog-client": "^0.6.0",
-    "@backstage/catalog-model": "^0.9.10",
-    "@backstage/config": "^0.1.13",
-    "@backstage/errors": "^0.2.0",
-    "@backstage/integration": "^0.7.2",
-    "@backstage/plugin-catalog-backend": "^0.21.3",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.11",
-    "@backstage/plugin-scaffolder-common": "^0.1.3",
-    "@backstage/types": "^0.1.1",
+    "@backstage/backend-common": "^0.10.8",
+    "@backstage/catalog-client": "^0.7.0",
+    "@backstage/catalog-model": "^0.10.0",
+    "@backstage/config": "^0.1.14",
+    "@backstage/errors": "^0.2.1",
+    "@backstage/integration": "^0.7.3",
+    "@backstage/plugin-catalog-backend": "^0.21.4",
+    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.2.0",
+    "@backstage/plugin-scaffolder-common": "^0.2.0",
+    "@backstage/types": "^0.1.2",
     "@gitbeaker/core": "^34.6.0",
     "@gitbeaker/node": "^35.1.0",
     "@octokit/webhooks": "^9.14.1",
@@ -55,7 +58,6 @@
     "git-url-parse": "^11.6.0",
     "globby": "^11.0.0",
     "handlebars": "^4.7.6",
-    "helmet": "^4.0.0",
     "isbinaryfile": "^4.0.8",
     "isomorphic-git": "^1.8.0",
     "jsonschema": "^1.2.6",
@@ -63,7 +65,7 @@
     "lodash": "^4.17.21",
     "luxon": "^2.0.2",
     "morgan": "^1.10.0",
-    "node-fetch": "^2.6.1",
+    "node-fetch": "^2.6.7",
     "nunjucks": "^3.2.3",
     "octokit": "^1.7.1",
     "octokit-plugin-create-pull-request": "^3.10.0",
@@ -73,8 +75,8 @@
     "yaml": "^1.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.13.2",
-    "@backstage/test-utils": "^0.2.4",
+    "@backstage/cli": "^0.14.0",
+    "@backstage/test-utils": "^0.2.5",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -95,5 +97,5 @@
     "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "4f4bc77a4152d372b10a4e8d97d92f00e23f3b56"
+  "gitHead": "4805c3d13ce9bfc369e53c271b1b95e722b3b4dc"
 }

package/dist/index.d.ts

@@ -1,508 +0,0 @@
-/// <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 * as _backstage_types from '@backstage/types';
-import { JsonValue, JsonObject } from '@backstage/types';
-import { Schema } from 'jsonschema';
-import { TaskSpec, TemplateMetadata } from '@backstage/plugin-scaffolder-common';
-export { TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TemplateMetadata } from '@backstage/plugin-scaffolder-common';
-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 { TemplateEntityV1beta2, Entity, LocationSpec } from '@backstage/catalog-model';
-import { CatalogProcessor, CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
-
-declare function createCatalogRegisterAction(options: {
-    catalogClient: CatalogApi;
-    integrations: ScmIntegrations;
-}): TemplateAction<any>;
-
-declare function createCatalogWriteAction(): TemplateAction<any>;
-
-/**
- * A catalog client tailored for reading out entity data from the catalog.
- */
-declare class CatalogEntityClient {
-    private readonly catalogClient;
-    constructor(catalogClient: CatalogApi);
-    /**
-     * Looks up a single template using a template name.
-     *
-     * Throws a NotFoundError or ConflictError if 0 or multiple templates are found.
-     */
-    findTemplate(templateName: string, options?: {
-        token?: string;
-    }): Promise<TemplateEntityV1beta2>;
-}
-
-declare type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
-
-declare const createBuiltinActions: (options: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
-    catalogClient: CatalogApi;
-    containerRunner?: ContainerRunner;
-    config: Config;
-    additionalTemplateFilters?: Record<string, TemplateFilter>;
-}) => TemplateAction<any>[];
-
-/**
- * This task is useful for local development and testing of both the scaffolder
- * and scaffolder templates.
- */
-declare function createDebugLogAction(): TemplateAction<any>;
-
-declare function createFetchPlainAction(options: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
-}): TemplateAction<any>;
-
-declare function createFetchTemplateAction(options: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
-    additionalTemplateFilters?: Record<string, TemplateFilter>;
-}): TemplateAction<any>;
-
-declare function fetchContents({ reader, integrations, baseUrl, fetchUrl, outputPath, }: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
-    baseUrl?: string;
-    fetchUrl?: JsonValue;
-    outputPath: string;
-}): Promise<void>;
-
-declare const createFilesystemDeleteAction: () => TemplateAction<any>;
-
-declare const createFilesystemRenameAction: () => TemplateAction<any>;
-
-declare function createPublishAzureAction(options: {
-    integrations: ScmIntegrationRegistry;
-    config: Config;
-}): TemplateAction<any>;
-
-declare function createPublishBitbucketAction(options: {
-    integrations: ScmIntegrationRegistry;
-    config: Config;
-}): TemplateAction<any>;
-
-/**
- * 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<any>;
-
-declare function createPublishGithubAction(options: {
-    integrations: ScmIntegrationRegistry;
-    config: Config;
-    githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<any>;
-
-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<any>;
-
-declare function createPublishGitlabAction(options: {
-    integrations: ScmIntegrationRegistry;
-    config: Config;
-}): TemplateAction<any>;
-
-declare const createPublishGitlabMergeRequestAction: (options: {
-    integrations: ScmIntegrationRegistry;
-}) => TemplateAction<any>;
-
-declare function createGithubActionsDispatchAction(options: {
-    integrations: ScmIntegrations;
-    githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<any>;
-
-declare function createGithubWebhookAction(options: {
-    integrations: ScmIntegrationRegistry;
-    defaultWebhookSecret?: string;
-    githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<any>;
-
-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.
- */
-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
-     */
-    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.
- */
-declare const runCommand: ({ command, args, logStream, options, }: RunCommandOptions) => Promise<void>;
-
-/**
- * Status
- *
- * @public
- */
-declare type Status = 'open' | 'processing' | 'failed' | 'cancelled' | 'completed';
-/**
- * CompletedTaskState
- *
- * @public
- */
-declare type CompletedTaskState = 'failed' | 'completed';
-/**
- * SerializedTask
- *
- * @public
- */
-declare type SerializedTask = {
-    id: string;
-    spec: TaskSpec;
-    status: Status;
-    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> & {
-    /** @deprecated Use `backstageToken` instead */
-    token?: string;
-    backstageToken?: string;
-};
-/**
- * DispatchResult
- *
- * @public
- */
-declare type DispatchResult = {
-    taskId: string;
-};
-/**
- * Task
- *
- * @public
- */
-interface TaskContext {
-    spec: TaskSpec;
-    secrets?: TaskSecrets;
-    done: boolean;
-    emitLog(message: string, metadata?: JsonValue): Promise<void>;
-    complete(result: CompletedTaskState, metadata?: JsonValue): Promise<void>;
-    getWorkspaceName(): Promise<string>;
-}
-/**
- * TaskBroker
- *
- * @public
- */
-interface TaskBroker {
-    claim(): Promise<TaskContext>;
-    dispatch(spec: TaskSpec, secrets?: TaskSecrets): Promise<DispatchResult>;
-    vacuumTasks(timeoutS: {
-        timeoutS: number;
-    }): Promise<void>;
-    observe(options: {
-        taskId: string;
-        after: number | undefined;
-    }, callback: (error: Error | undefined, result: {
-        events: SerializedTaskEvent[];
-    }) => void): {
-        unsubscribe: () => void;
-    };
-    get(taskId: string): Promise<SerializedTask>;
-}
-/**
- * TaskStoreEmitOptions
- *
- * @public
- */
-declare type TaskStoreEmitOptions = {
-    taskId: string;
-    body: JsonObject;
-};
-/**
- * TaskStoreListEventsOptions
- *
- * @public
- */
-declare type TaskStoreListEventsOptions = {
-    taskId: string;
-    after?: number | undefined;
-};
-/**
- * TaskStore
- *
- * @public
- */
-interface TaskStore {
-    createTask(task: TaskSpec, secrets?: TaskSecrets): Promise<{
-        taskId: string;
-    }>;
-    getTask(taskId: string): Promise<SerializedTask>;
-    claimTask(): Promise<SerializedTask | undefined>;
-    completeTask(options: {
-        taskId: string;
-        status: Status;
-        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 PartialJsonObject = Partial<JsonObject>;
-declare type PartialJsonValue = PartialJsonObject | JsonValue | undefined;
-declare type InputBase = Partial<{
-    [name: string]: PartialJsonValue;
-}>;
-declare type ActionContext<Input extends InputBase> = {
-    /**
-     * Base URL for the location of the task spec, typically the url of the source entity file.
-     */
-    baseUrl?: string;
-    logger: Logger;
-    logStream: Writable;
-    /**
-     * User token forwarded from initial request, for use in subsequent api requests
-     * @deprecated use `secrets.backstageToken` instead
-     */
-    token?: string | undefined;
-    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>;
-    metadata?: TemplateMetadata;
-};
-declare type TemplateAction<Input extends InputBase> = {
-    id: string;
-    description?: string;
-    schema?: {
-        input?: Schema;
-        output?: Schema;
-    };
-    handler: (ctx: ActionContext<Input>) => Promise<void>;
-};
-
-declare class TemplateActionRegistry {
-    private readonly actions;
-    register<Parameters extends InputBase>(action: TemplateAction<Parameters>): void;
-    get(actionId: string): TemplateAction<any>;
-    list(): TemplateAction<any>[];
-}
-
-declare const createTemplateAction: <Input extends Partial<{
-    [name: string]: _backstage_types.JsonValue | Partial<_backstage_types.JsonObject> | undefined;
-}>>(templateAction: TemplateAction<Input>) => TemplateAction<any>;
-
-/**
- * DatabaseTaskStore
- *
- * @public
- */
-declare type DatabaseTaskStoreOptions = {
-    database: Knex;
-};
-/**
- * DatabaseTaskStore
- *
- * @public
- */
-declare class DatabaseTaskStore implements TaskStore {
-    private readonly db;
-    static create(options: DatabaseTaskStoreOptions): Promise<DatabaseTaskStore>;
-    constructor(options: DatabaseTaskStoreOptions);
-    getTask(taskId: string): Promise<SerializedTask>;
-    createTask(spec: TaskSpec, secrets?: TaskSecrets): Promise<{
-        taskId: string;
-    }>;
-    claimTask(): Promise<SerializedTask | undefined>;
-    heartbeatTask(taskId: string): Promise<void>;
-    listStaleTasks({ timeoutS }: {
-        timeoutS: number;
-    }): Promise<{
-        tasks: {
-            taskId: string;
-        }[];
-    }>;
-    completeTask({ taskId, status, eventBody, }: {
-        taskId: string;
-        status: Status;
-        eventBody: JsonObject;
-    }): Promise<void>;
-    emitLogEvent({ taskId, body }: TaskStoreEmitOptions): Promise<void>;
-    listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
-        events: SerializedTaskEvent[];
-    }>;
-}
-
-/**
- * TaskManager
- *
- * @public
- */
-declare class TaskManager implements TaskContext {
-    private readonly state;
-    private readonly storage;
-    private readonly logger;
-    private isDone;
-    private heartbeatTimeoutId?;
-    static create(state: TaskState, storage: TaskStore, logger: Logger): TaskManager;
-    private constructor();
-    get spec(): TaskSpec;
-    get secrets(): TaskSecrets | undefined;
-    getWorkspaceName(): Promise<string>;
-    get done(): boolean;
-    emitLog(message: string, metadata?: JsonObject): Promise<void>;
-    complete(result: CompletedTaskState, metadata?: JsonObject): Promise<void>;
-    private startTimeout;
-}
-/**
- * TaskState
- *
- * @public
- */
-interface TaskState {
-    spec: TaskSpec;
-    taskId: string;
-    secrets?: TaskSecrets;
-}
-
-/**
- * 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 {
-    private readonly validators;
-    validateEntityKind(entity: Entity): Promise<boolean>;
-    postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
-}
-
-export { ActionContext, CatalogEntityClient, CompletedTaskState, CreateWorkerOptions, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskState, TaskStore, 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, fetchContents, runCommand };