@backstage/plugin-scaffolder-backend 1.12.0 → 1.13.0-next.1

package/dist/index.d.ts

@@ -1,24 +1,30 @@
 /// <reference types="node" />
 import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
 import { TemplateAction as TemplateAction$1, TaskSecrets as TaskSecrets$1, ActionContext as ActionContext$1 } from '@backstage/plugin-scaffolder-node';
+import * as _backstage_types from '@backstage/types';
+import { JsonValue, HumanDuration, JsonObject, Observable } from '@backstage/types';
 import { ScmIntegrations, ScmIntegrationRegistry, GithubCredentialsProvider } from '@backstage/integration';
 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 { Duration } from 'luxon';
 import { Octokit } from 'octokit';
 import { createPullRequest } from 'octokit-plugin-create-pull-request';
 import { SpawnOptionsWithoutStdio } from 'child_process';
 import { Writable } from 'stream';
 import { Knex } from 'knex';
 import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
-import { TaskSpec } from '@backstage/plugin-scaffolder-common';
+import { TaskSpec, TemplateEntityStepV1beta3, TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { Logger } from 'winston';
 import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha';
 import express from 'express';
 import { IdentityApi } from '@backstage/plugin-auth-node';
+import { PermissionRuleParams, PermissionEvaluator } from '@backstage/plugin-permission-common';
+import { PermissionRule } from '@backstage/plugin-permission-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';
 
@@ -36,16 +42,18 @@ declare function createCatalogRegisterAction(options: {
     repoContentsUrl: string;
     catalogInfoPath?: string | undefined;
     optional?: boolean | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Writes a catalog descriptor file containing the provided entity to a path in the workspace.
  * @public
  */
 declare function createCatalogWriteAction(): _backstage_plugin_scaffolder_node.TemplateAction<{
+    entity: {} & {
+        [k: string]: unknown;
+    };
     filePath?: string | undefined;
-    entity: {};
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Returns entity or entities from the catalog by entity reference(s).
@@ -58,6 +66,9 @@ declare function createFetchCatalogEntityAction(options: {
     entityRef?: string | undefined;
     entityRefs?: string[] | undefined;
     optional?: boolean | undefined;
+}, {
+    entity?: any;
+    entities?: any[] | undefined;
 }>;
 
 /** @public */
@@ -115,7 +126,21 @@ declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => Te
 declare function createDebugLogAction(): _backstage_plugin_scaffolder_node.TemplateAction<{
     message?: string | undefined;
     listWorkspace?: boolean | undefined;
-}>;
+}, _backstage_types.JsonObject>;
+
+/**
+ * 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, _backstage_types.JsonObject>;
 
 /**
  * Downloads content and places it in the workspace, or optionally
@@ -128,7 +153,20 @@ declare function createFetchPlainAction(options: {
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     url: string;
     targetPath?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
+
+/**
+ * Downloads content and places it in the workspace, or optionally
+ * in a subdirectory specified by the 'targetPath' input option.
+ * @public
+ */
+declare function createFetchPlainFileAction(options: {
+    reader: UrlReader;
+    integrations: ScmIntegrations;
+}): _backstage_plugin_scaffolder_node.TemplateAction<{
+    url: string;
+    targetPath: string;
+}, _backstage_types.JsonObject>;
 
 /**
  * Downloads a skeleton, templates variables into file and directory names and content.
@@ -154,7 +192,7 @@ declare function createFetchTemplateAction(options: {
     copyWithoutTemplating?: string[] | undefined;
     cookiecutterCompat?: boolean | undefined;
     replace?: boolean | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * A helper function that reads the contents of a directory from the given URL.
@@ -176,7 +214,7 @@ declare function fetchContents(options: {
  */
 declare const createFilesystemDeleteAction: () => _backstage_plugin_scaffolder_node.TemplateAction<{
     files: string[];
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that allows renames of files and directories in the workspace.
@@ -188,7 +226,7 @@ declare const createFilesystemRenameAction: () => _backstage_plugin_scaffolder_n
         to: string;
         overwrite?: boolean;
     }>;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -207,7 +245,7 @@ declare function createPublishAzureAction(options: {
     gitCommitMessage?: string | undefined;
     gitAuthorName?: string | undefined;
     gitAuthorEmail?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -229,7 +267,7 @@ declare function createPublishBitbucketAction(options: {
     gitCommitMessage?: string | undefined;
     gitAuthorName?: string | undefined;
     gitAuthorEmail?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -246,7 +284,7 @@ declare function createPublishBitbucketCloudAction(options: {
     repoVisibility?: "private" | "public" | undefined;
     sourcePath?: string | undefined;
     token?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -267,7 +305,7 @@ declare function createPublishBitbucketServerAction(options: {
     gitCommitMessage?: string | undefined;
     gitAuthorName?: string | undefined;
     gitAuthorEmail?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -285,7 +323,7 @@ declare function createPublishGerritAction(options: {
     gitAuthorName?: string | undefined;
     gitAuthorEmail?: string | undefined;
     sourcePath?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that creates a Gerrit review
@@ -301,7 +339,7 @@ declare function createPublishGerritReviewAction(options: {
     gitCommitMessage?: string | undefined;
     gitAuthorName?: string | undefined;
     gitAuthorEmail?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -366,7 +404,7 @@ declare function createPublishGithubAction(options: {
     token?: string | undefined;
     topics?: string[] | undefined;
     requiredCommitSigning?: boolean | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /** @public */
 declare type OctokitWithPullRequestPluginClient = Octokit & {
@@ -422,7 +460,7 @@ declare const createPublishGithubPullRequestAction: (options: CreateGithubPullRe
     token?: string | undefined;
     reviewers?: string[] | undefined;
     teamReviewers?: string[] | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -444,7 +482,7 @@ declare function createPublishGitlabAction(options: {
     gitAuthorEmail?: string | undefined;
     setUserAsOwner?: boolean | undefined;
     topics?: string[] | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Create a new action that creates a gitlab merge request.
@@ -466,7 +504,7 @@ declare const createPublishGitlabMergeRequestAction: (options: {
     projectid?: string | undefined;
     removeSourceBranch?: boolean | undefined;
     assignee?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that dispatches a GitHub Action workflow for a given branch or tag.
@@ -483,7 +521,7 @@ declare function createGithubActionsDispatchAction(options: {
         [key: string]: string;
     } | undefined;
     token?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Adds labels to a pull request or issue on GitHub
@@ -497,7 +535,7 @@ declare function createGithubIssuesLabelAction(options: {
     number: number;
     labels: string[];
     token?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository
@@ -554,7 +592,7 @@ declare function createGithubRepoCreateAction(options: {
     token?: string | undefined;
     topics?: string[] | undefined;
     requireCommitSigning?: boolean | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -594,7 +632,7 @@ declare function createGithubRepoPushAction(options: {
     sourcePath?: string | undefined;
     token?: string | undefined;
     requiredCommitSigning?: boolean | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /**
  * Creates new action that creates a webhook for a repository on GitHub.
@@ -613,7 +651,7 @@ declare function createGithubWebhookAction(options: {
     contentType?: "form" | "json" | undefined;
     insecureSsl?: boolean | undefined;
     token?: string | undefined;
-}>;
+}, _backstage_types.JsonObject>;
 
 /** @public */
 declare type RunCommandOptions = {
@@ -649,7 +687,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.
  *
@@ -675,7 +713,7 @@ declare type SerializedTask = {
  *
  * @public
  */
-declare type TaskEventType = 'completion' | 'log';
+declare type TaskEventType = 'completion' | 'log' | 'cancelled';
 /**
  * SerializedTaskEvent
  *
@@ -713,13 +751,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>;
 }
 /**
@@ -728,6 +767,7 @@ interface TaskContext {
  * @public
  */
 interface TaskBroker {
+    cancel?(taskId: string): Promise<void>;
     claim(): Promise<TaskContext>;
     dispatch(options: TaskBrokerDispatchOptions): Promise<TaskBrokerDispatchResult>;
     vacuumTasks(options: {
@@ -794,6 +834,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>;
@@ -869,6 +910,9 @@ declare class DatabaseTaskStore implements TaskStore {
         events: SerializedTaskEvent[];
     }>;
     shutdownTask(options: TaskStoreShutDownTaskOptions): Promise<void>;
+    cancelTask(options: TaskStoreEmitOptions<{
+        message: string;
+    } & JsonObject>): Promise<void>;
 }
 
 /**
@@ -879,12 +923,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>;
@@ -959,6 +1005,11 @@ declare class TaskWorker {
     runOneTask(task: TaskContext): Promise<void>;
 }
 
+/**
+ *
+ * @public
+ */
+declare type TemplatePermissionRuleInput<TParams extends PermissionRuleParams = PermissionRuleParams> = PermissionRule<TemplateEntityStepV1beta3 | TemplateParametersV1beta3, {}, typeof RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, TParams>;
 /**
  * RouterOptions
  *
@@ -985,6 +1036,8 @@ interface RouterOptions {
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
     additionalTemplateGlobals?: Record<string, TemplateGlobal>;
+    permissionApi?: PermissionEvaluator;
+    permissionRules?: TemplatePermissionRuleInput[];
     identity?: IdentityApi;
 }
 /**
@@ -1010,7 +1063,7 @@ declare type ActionContext<TInput extends JsonObject> = ActionContext$1<TInput>;
  * @public
  * @deprecated Use `createTemplateAction` from `@backstage/plugin-scaffolder-node` instead
  */
-declare const createTemplateAction: <TParams, TInputSchema extends zod.ZodType<any, zod.ZodTypeDef, any> | jsonschema.Schema = {}, TOutputSchema extends zod.ZodType<any, zod.ZodTypeDef, any> | jsonschema.Schema = {}, TActionInput = TInputSchema extends zod.ZodType<any, any, infer IReturn> ? IReturn : TParams>(action: _backstage_plugin_scaffolder_node.TemplateActionOptions<TActionInput, TInputSchema, TOutputSchema>) => TemplateAction$1<TActionInput>;
+declare const createTemplateAction: <TInputParams extends JsonObject = JsonObject, TOutputParams extends JsonObject = JsonObject, TInputSchema extends zod.ZodType<any, zod.ZodTypeDef, any> | jsonschema.Schema = {}, TOutputSchema extends zod.ZodType<any, zod.ZodTypeDef, any> | jsonschema.Schema = {}, TActionInput = TInputSchema extends zod.ZodType<any, any, infer IReturn> ? IReturn : TInputParams, TActionOutput = TOutputSchema extends zod.ZodType<any, any, infer IReturn_1> ? IReturn_1 : TOutputParams>(action: _backstage_plugin_scaffolder_node.TemplateActionOptions<TActionInput, TActionOutput, TInputSchema, TOutputSchema>) => TemplateAction$1<TActionInput, TActionOutput>;
 /**
  * @public
  * @deprecated Use `TaskSecrets` from `@backstage/plugin-scaffolder-node` instead
@@ -1022,4 +1075,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, TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, 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",
+  "version": "1.13.0-next.1",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -44,24 +44,28 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.18.3",
-    "@backstage/backend-plugin-api": "^0.5.0",
-    "@backstage/backend-tasks": "^0.5.0",
+    "@backstage/backend-common": "^0.18.4-next.1",
+    "@backstage/backend-plugin-api": "^0.5.1-next.1",
+    "@backstage/backend-tasks": "^0.5.1-next.1",
     "@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.12",
-    "@backstage/plugin-catalog-backend": "^1.8.0",
-    "@backstage/plugin-catalog-node": "^1.3.4",
-    "@backstage/plugin-scaffolder-common": "^1.2.6",
-    "@backstage/plugin-scaffolder-node": "^0.1.1",
+    "@backstage/integration": "^1.4.4-next.0",
+    "@backstage/plugin-auth-node": "^0.2.13-next.1",
+    "@backstage/plugin-catalog-backend": "^1.8.1-next.1",
+    "@backstage/plugin-catalog-common": "^1.0.13-next.0",
+    "@backstage/plugin-catalog-node": "^1.3.5-next.1",
+    "@backstage/plugin-permission-common": "^0.7.5-next.0",
+    "@backstage/plugin-permission-node": "^0.7.7-next.1",
+    "@backstage/plugin-scaffolder-common": "^1.2.7-next.1",
+    "@backstage/plugin-scaffolder-node": "^0.1.2-next.1",
     "@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",
@@ -90,11 +94,11 @@
     "winston": "^3.2.1",
     "yaml": "^2.0.0",
     "zen-observable": "^0.10.0",
-    "zod": "~3.18.0"
+    "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.35",
-    "@backstage/cli": "^0.22.4",
+    "@backstage/backend-test-utils": "^0.1.36-next.1",
+    "@backstage/cli": "^0.22.6-next.1",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -107,6 +111,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": [