@backstage/plugin-scaffolder-backend 1.12.0-next.2 → 1.12.1-next.0

package/dist/index.d.ts

@@ -5,7 +5,8 @@ import { ScmIntegrations, ScmIntegrationRegistry, GithubCredentialsProvider } fr
 import { CatalogApi } from '@backstage/catalog-client';
 import { UrlReader, PluginDatabaseManager } from '@backstage/backend-common';
 import { Config } from '@backstage/config';
-import { JsonValue, JsonObject, Observable } from '@backstage/types';
+import { JsonValue, HumanDuration, JsonObject, Observable } from '@backstage/types';
+import { Duration } from 'luxon';
 import { Octokit } from 'octokit';
 import { createPullRequest } from 'octokit-plugin-create-pull-request';
 import { SpawnOptionsWithoutStdio } from 'child_process';
@@ -18,7 +19,8 @@ import { PluginTaskScheduler } from '@backstage/backend-tasks';
 import express from 'express';
 import { IdentityApi } from '@backstage/plugin-auth-node';
 import { Entity } from '@backstage/catalog-model';
-import { CatalogProcessor, LocationSpec, CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
+import { CatalogProcessor, CatalogProcessorEmit } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import * as jsonschema from 'jsonschema';
 import * as zod from 'zod';
 
@@ -48,13 +50,15 @@ declare function createCatalogWriteAction(): _backstage_plugin_scaffolder_node.T
 }>;
 
 /**
- * Returns entity from the catalog by entity reference.
+ * Returns entity or entities from the catalog by entity reference(s).
+ *
  * @public
  */
 declare function createFetchCatalogEntityAction(options: {
     catalogClient: CatalogApi;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
-    entityRef: string;
+    entityRef?: string | undefined;
+    entityRefs?: string[] | undefined;
     optional?: boolean | undefined;
 }>;
 
@@ -115,6 +119,20 @@ declare function createDebugLogAction(): _backstage_plugin_scaffolder_node.Templ
     listWorkspace?: boolean | undefined;
 }>;
 
+/**
+ * Waits for a certain period of time.
+ *
+ * @remarks
+ *
+ * This task is useful to give some waiting time for manual intervention.
+ * Has to be used in a combination with other actions.
+ *
+ * @public
+ */
+declare function createWaitAction(options?: {
+    maxWaitTime?: Duration | HumanDuration;
+}): _backstage_plugin_scaffolder_node.TemplateAction<HumanDuration>;
+
 /**
  * Downloads content and places it in the workspace, or optionally
  * in a subdirectory specified by the 'targetPath' input option.
@@ -647,7 +665,7 @@ declare class TemplateActionRegistry {
  *
  * @public
  */
-declare type TaskStatus = 'open' | 'processing' | 'failed' | 'cancelled' | 'completed';
+declare type TaskStatus = 'cancelled' | 'completed' | 'failed' | 'open' | 'processing';
 /**
  * The state of a completed task.
  *
@@ -673,7 +691,7 @@ declare type SerializedTask = {
  *
  * @public
  */
-declare type TaskEventType = 'completion' | 'log';
+declare type TaskEventType = 'completion' | 'log' | 'cancelled';
 /**
  * SerializedTaskEvent
  *
@@ -711,13 +729,14 @@ declare type TaskBrokerDispatchOptions = {
  * @public
  */
 interface TaskContext {
+    cancelSignal: AbortSignal;
     spec: TaskSpec;
     secrets?: TaskSecrets$1;
     createdBy?: string;
     done: boolean;
     isDryRun?: boolean;
-    emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
     complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
+    emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
     getWorkspaceName(): Promise<string>;
 }
 /**
@@ -726,6 +745,7 @@ interface TaskContext {
  * @public
  */
 interface TaskBroker {
+    cancel?(taskId: string): Promise<void>;
     claim(): Promise<TaskContext>;
     dispatch(options: TaskBrokerDispatchOptions): Promise<TaskBrokerDispatchResult>;
     vacuumTasks(options: {
@@ -792,6 +812,7 @@ declare type TaskStoreCreateTaskResult = {
  * @public
  */
 interface TaskStore {
+    cancelTask?(options: TaskStoreEmitOptions): Promise<void>;
     createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
     getTask(taskId: string): Promise<SerializedTask>;
     claimTask(): Promise<SerializedTask | undefined>;
@@ -867,6 +888,9 @@ declare class DatabaseTaskStore implements TaskStore {
         events: SerializedTaskEvent[];
     }>;
     shutdownTask(options: TaskStoreShutDownTaskOptions): Promise<void>;
+    cancelTask(options: TaskStoreEmitOptions<{
+        message: string;
+    } & JsonObject>): Promise<void>;
 }
 
 /**
@@ -877,12 +901,14 @@ declare class DatabaseTaskStore implements TaskStore {
 declare class TaskManager implements TaskContext {
     private readonly task;
     private readonly storage;
+    private readonly signal;
     private readonly logger;
     private isDone;
     private heartbeatTimeoutId?;
-    static create(task: CurrentClaimedTask, storage: TaskStore, logger: Logger): TaskManager;
+    static create(task: CurrentClaimedTask, storage: TaskStore, abortSignal: AbortSignal, logger: Logger): TaskManager;
     private constructor();
     get spec(): _backstage_plugin_scaffolder_common.TaskSpecV1beta3;
+    get cancelSignal(): AbortSignal;
     get secrets(): TaskSecrets$1 | undefined;
     get createdBy(): string | undefined;
     getWorkspaceName(): Promise<string>;
@@ -1020,4 +1046,4 @@ declare type TaskSecrets = TaskSecrets$1;
  */
 declare type TemplateAction<TInput extends JsonObject> = TemplateAction$1<TInput>;
 
-export { ActionContext, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskStoreShutDownTaskOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, TemplateGlobal, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubIssuesLabelAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishGerritAction, createPublishGerritReviewAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents };
+export { ActionContext, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskStoreShutDownTaskOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, TemplateGlobal, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubIssuesLabelAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishGerritAction, createPublishGerritReviewAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, createWaitAction, executeShellCommand, fetchContents };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "1.12.0-next.2",
+  "version": "1.12.1-next.0",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -44,24 +44,26 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.18.3-next.2",
-    "@backstage/backend-plugin-api": "^0.4.1-next.2",
-    "@backstage/backend-tasks": "^0.5.0-next.2",
-    "@backstage/catalog-client": "^1.4.0-next.1",
-    "@backstage/catalog-model": "^1.2.1-next.1",
-    "@backstage/config": "^1.0.7-next.0",
-    "@backstage/errors": "^1.1.5-next.0",
-    "@backstage/integration": "^1.4.3-next.0",
-    "@backstage/plugin-auth-node": "^0.2.12-next.2",
-    "@backstage/plugin-catalog-backend": "^1.8.0-next.2",
-    "@backstage/plugin-catalog-node": "^1.3.4-next.2",
-    "@backstage/plugin-scaffolder-common": "^1.2.6-next.1",
-    "@backstage/plugin-scaffolder-node": "^0.1.1-next.2",
+    "@backstage/backend-common": "^0.18.4-next.0",
+    "@backstage/backend-plugin-api": "^0.5.1-next.0",
+    "@backstage/backend-tasks": "^0.5.1-next.0",
+    "@backstage/catalog-client": "^1.4.0",
+    "@backstage/catalog-model": "^1.2.1",
+    "@backstage/config": "^1.0.7",
+    "@backstage/errors": "^1.1.5",
+    "@backstage/integration": "^1.4.3",
+    "@backstage/plugin-auth-node": "^0.2.13-next.0",
+    "@backstage/plugin-catalog-backend": "^1.8.1-next.0",
+    "@backstage/plugin-catalog-common": "^1.0.12",
+    "@backstage/plugin-catalog-node": "^1.3.5-next.0",
+    "@backstage/plugin-scaffolder-common": "^1.2.7-next.0",
+    "@backstage/plugin-scaffolder-node": "^0.1.2-next.0",
     "@backstage/types": "^1.0.2",
     "@gitbeaker/core": "^35.6.0",
     "@gitbeaker/node": "^35.1.0",
     "@octokit/webhooks": "^10.0.0",
     "@types/express": "^4.17.6",
+    "@types/luxon": "^3.0.0",
     "azure-devops-node-api": "^11.0.1",
     "command-exists": "^1.2.9",
     "compression": "^1.7.4",
@@ -93,8 +95,8 @@
     "zod": "~3.18.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.35-next.2",
-    "@backstage/cli": "^0.22.4-next.1",
+    "@backstage/backend-test-utils": "^0.1.36-next.0",
+    "@backstage/cli": "^0.22.6-next.0",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -107,6 +109,7 @@
     "mock-fs": "^5.1.0",
     "msw": "^1.0.0",
     "supertest": "^6.1.3",
+    "wait-for-expect": "^3.0.2",
     "yaml": "^2.0.0"
   },
   "files": [