@backstage/plugin-scaffolder-backend 0.15.12 → 0.15.13

package/dist/index.d.ts

@@ -146,51 +146,6 @@ declare type RunCommandOptions = {
 };
 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>;
-
 /**
  * Status
  *
@@ -234,6 +189,14 @@ declare type SerializedTaskEvent = {
     type: TaskEventType;
     createdAt: string;
 };
+/**
+ * TemplateMetadata
+ *
+ * @public
+ */
+declare type TemplateMetadata = {
+    name: string;
+};
 /**
  * TaskSpecV1beta2
  *
@@ -253,6 +216,7 @@ interface TaskSpecV1beta2 {
     output: {
         [name: string]: string;
     };
+    metadata?: TemplateMetadata;
 }
 interface TaskStep {
     id: string;
@@ -274,6 +238,7 @@ interface TaskSpecV1beta3 {
     output: {
         [name: string]: JsonValue;
     };
+    metadata?: TemplateMetadata;
 }
 /**
  * TaskSpec
@@ -379,6 +344,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 +529,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.13",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -30,13 +30,13 @@
     "clean": "backstage-cli clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.9.9",
-    "@backstage/catalog-client": "^0.5.1",
-    "@backstage/catalog-model": "^0.9.6",
+    "@backstage/backend-common": "^0.9.10",
+    "@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-catalog-backend": "^0.17.4",
     "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.4",
     "@backstage/plugin-scaffolder-common": "^0.1.1",
     "@backstage/types": "^0.1.1",
@@ -71,8 +71,8 @@
     "yaml": "^1.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.8.2",
-    "@backstage/test-utils": "^0.1.21",
+    "@backstage/cli": "^0.9.0",
+    "@backstage/test-utils": "^0.1.22",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -91,5 +91,5 @@
     "config.d.ts"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "5bdaccc40b4a814cf0b45d429f15a3afacc2f60b"
+  "gitHead": "ddfdcd2b44dc9848cf550cea5346d5f9916a36d9"
 }