@backstage/plugin-scaffolder-backend 0.15.23 → 0.16.1

package/dist/index.d.ts

@@ -3,11 +3,11 @@ import { ScmIntegrations, ScmIntegrationRegistry, GithubCredentialsProvider } fr
 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 { Entity, LocationSpec } 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';
@@ -16,179 +16,27 @@ export { createFetchCookiecutterAction } from '@backstage/plugin-scaffolder-back
 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>;
+}): TemplateAction<{
+    catalogInfoUrl: string;
+    optional?: boolean | undefined;
+} | {
+    repoContentsUrl: string;
+    catalogInfoPath?: string | undefined;
+    optional?: boolean | undefined;
+}>;
 
-/**
- * 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 function createCatalogWriteAction(): TemplateAction<{
+    filePath?: string | undefined;
+    entity: Entity;
+}>;
 
 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
  *
@@ -238,8 +86,6 @@ declare type SerializedTaskEvent = {
  * @public
  */
 declare type TaskSecrets = Record<string, string> & {
-    /** @deprecated Use `backstageToken` instead */
-    token?: string;
     backstageToken?: string;
 };
 /**
@@ -332,23 +178,13 @@ interface TaskStore {
     }>;
 }
 
-declare type PartialJsonObject = Partial<JsonObject>;
-declare type PartialJsonValue = PartialJsonObject | JsonValue | undefined;
-declare type InputBase = Partial<{
-    [name: string]: PartialJsonValue;
-}>;
-declare type ActionContext<Input extends InputBase> = {
+declare type ActionContext<Input extends JsonObject> = {
     /**
      * 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;
@@ -359,7 +195,7 @@ declare type ActionContext<Input extends InputBase> = {
     createTemporaryDirectory(): Promise<string>;
     metadata?: TemplateMetadata;
 };
-declare type TemplateAction<Input extends InputBase> = {
+declare type TemplateAction<Input extends JsonObject> = {
     id: string;
     description?: string;
     schema?: {
@@ -369,16 +205,249 @@ declare type TemplateAction<Input extends InputBase> = {
     handler: (ctx: ActionContext<Input>) => Promise<void>;
 };
 
+declare const createBuiltinActions: (options: {
+    reader: UrlReader;
+    integrations: ScmIntegrations;
+    catalogClient: CatalogApi;
+    containerRunner?: ContainerRunner;
+    config: Config;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
+}) => 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;
+}>;
+
+declare function fetchContents({ reader, integrations, baseUrl, fetchUrl, outputPath, }: {
+    reader: UrlReader;
+    integrations: ScmIntegrations;
+    baseUrl?: string;
+    fetchUrl?: JsonValue;
+    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.
+ */
+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>;
+
 declare class TemplateActionRegistry {
     private readonly actions;
-    register<Parameters extends InputBase>(action: TemplateAction<Parameters>): void;
-    get(actionId: string): TemplateAction<any>;
-    list(): TemplateAction<any>[];
+    register<TInput extends JsonObject>(action: TemplateAction<TInput>): void;
+    get(actionId: string): TemplateAction<JsonObject>;
+    list(): TemplateAction<JsonObject>[];
 }
 
-declare const createTemplateAction: <Input extends Partial<{
-    [name: string]: _backstage_types.JsonValue | Partial<_backstage_types.JsonObject> | undefined;
-}>>(templateAction: TemplateAction<Input>) => TemplateAction<any>;
+declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
 
 /**
  * DatabaseTaskStore
@@ -505,4 +574,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     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 };
+export { ActionContext, 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 };

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.23",
+  "version": "0.16.1",
   "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.6",
-    "@backstage/catalog-client": "^0.5.5",
-    "@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.2",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.10",
-    "@backstage/plugin-scaffolder-common": "^0.1.3",
-    "@backstage/types": "^0.1.1",
+    "@backstage/backend-common": "^0.10.9",
+    "@backstage/catalog-client": "^0.7.1",
+    "@backstage/catalog-model": "^0.10.1",
+    "@backstage/config": "^0.1.15",
+    "@backstage/errors": "^0.2.2",
+    "@backstage/integration": "^0.7.4",
+    "@backstage/plugin-catalog-backend": "^0.21.5",
+    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.2.1",
+    "@backstage/plugin-scaffolder-common": "^0.2.1",
+    "@backstage/types": "^0.1.3",
     "@gitbeaker/core": "^34.6.0",
     "@gitbeaker/node": "^35.1.0",
     "@octokit/webhooks": "^9.14.1",
@@ -55,26 +58,25 @@
     "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",
-    "knex": "^0.95.1",
+    "knex": "^1.0.2",
     "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",
     "uuid": "^8.2.0",
-    "vm2": "^3.9.5",
+    "vm2": "^3.9.6",
     "winston": "^3.2.1",
     "yaml": "^1.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.13.1",
-    "@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": "f944a625c4a8ec7f6a6237502691da9209ce6b14"
+  "gitHead": "e244b348c473700e7d5e5fbcef38bd9f9fd1d0ba"
 }