@backstage/plugin-scaffolder-backend 0.15.12 → 0.15.16

package/dist/index.d.ts

@@ -11,6 +11,7 @@ import { Config } from '@backstage/config';
 import { createPullRequest } from 'octokit-plugin-create-pull-request';
 import { Octokit } from '@octokit/rest';
 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';
@@ -140,56 +141,19 @@ declare class OctokitProvider {
 }
 
 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;
 };
-declare const runCommand: ({ command, args, logStream, }: RunCommandOptions) => Promise<void>;
-
-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
-     */
-    token?: string | undefined;
-    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>;
-};
-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>;
+/**
+ * Run a command in a sub-process, normally a shell command.
+ */
+declare const runCommand: ({ command, args, logStream, options, }: RunCommandOptions) => Promise<void>;
 
 /**
  * Status
@@ -234,6 +198,14 @@ declare type SerializedTaskEvent = {
     type: TaskEventType;
     createdAt: string;
 };
+/**
+ * TemplateMetadata
+ *
+ * @public
+ */
+declare type TemplateMetadata = {
+    name: string;
+};
 /**
  * TaskSpecV1beta2
  *
@@ -253,6 +225,7 @@ interface TaskSpecV1beta2 {
     output: {
         [name: string]: string;
     };
+    metadata?: TemplateMetadata;
 }
 interface TaskStep {
     id: string;
@@ -274,6 +247,7 @@ interface TaskSpecV1beta3 {
     output: {
         [name: string]: JsonValue;
     };
+    metadata?: TemplateMetadata;
 }
 /**
  * TaskSpec
@@ -379,6 +353,52 @@ 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> = {
+    /**
+     * 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
+     */
+    token?: string | undefined;
+    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
  *
@@ -518,4 +538,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, TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TaskState, TaskStore, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createRouter, createTemplateAction, fetchContents, runCommand };
+export { ActionContext, CatalogEntityClient, CompletedTaskState, CreateWorkerOptions, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TaskState, TaskStore, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateMetadata, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, 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.12",
+  "version": "0.15.16",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -27,21 +27,22 @@
     "test": "backstage-cli test",
     "prepack": "backstage-cli prepack",
     "postpack": "backstage-cli postpack",
-    "clean": "backstage-cli clean"
+    "clean": "backstage-cli clean",
+    "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.9.9",
-    "@backstage/catalog-client": "^0.5.1",
-    "@backstage/catalog-model": "^0.9.6",
+    "@backstage/backend-common": "^0.9.13",
+    "@backstage/catalog-client": "^0.5.2",
+    "@backstage/catalog-model": "^0.9.7",
     "@backstage/config": "^0.1.11",
-    "@backstage/errors": "^0.1.4",
-    "@backstage/integration": "^0.6.9",
-    "@backstage/plugin-catalog-backend": "^0.17.3",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.4",
+    "@backstage/errors": "^0.1.5",
+    "@backstage/integration": "^0.6.10",
+    "@backstage/plugin-catalog-backend": "^0.19.1",
+    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.5",
     "@backstage/plugin-scaffolder-common": "^0.1.1",
     "@backstage/types": "^0.1.1",
-    "@gitbeaker/core": "^30.2.0",
-    "@gitbeaker/node": "^30.2.0",
+    "@gitbeaker/core": "^34.6.0",
+    "@gitbeaker/node": "^34.6.0",
     "@octokit/rest": "^18.5.3",
     "@octokit/webhooks": "^9.14.1",
     "@types/express": "^4.17.6",
@@ -49,7 +50,6 @@
     "command-exists": "^1.2.9",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
-    "cross-fetch": "^3.0.6",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
     "fs-extra": "10.0.0",
@@ -64,21 +64,24 @@
     "lodash": "^4.17.21",
     "luxon": "^2.0.2",
     "morgan": "^1.10.0",
+    "node-fetch": "^2.6.1",
     "nunjucks": "^3.2.3",
     "octokit-plugin-create-pull-request": "^3.10.0",
     "uuid": "^8.2.0",
+    "vm2": "^3.9.5",
     "winston": "^3.2.1",
     "yaml": "^1.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.8.2",
-    "@backstage/test-utils": "^0.1.21",
+    "@backstage/cli": "^0.10.1",
+    "@backstage/test-utils": "^0.1.24",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
     "@types/mock-fs": "^4.13.0",
     "@types/nunjucks": "^3.1.4",
     "@types/supertest": "^2.0.8",
+    "esbuild": "^0.14.1",
     "jest-when": "^3.1.0",
     "mock-fs": "^5.1.0",
     "msw": "^0.35.0",
@@ -88,8 +91,9 @@
   "files": [
     "dist",
     "migrations",
-    "config.d.ts"
+    "config.d.ts",
+    "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "5bdaccc40b4a814cf0b45d429f15a3afacc2f60b"
+  "gitHead": "562be0b43016294e27af3ad024191bb86b13b1c1"
 }