@backstage/plugin-scaffolder-backend 1.13.0-next.2 → 1.13.0

package/CHANGELOG.md

@@ -1,5 +1,90 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.13.0
+
+### Minor Changes
+
+- 2b15cb4aa0a: The non-PR/MR Git Actions now return the commit hash of the commit pushed as a new output called `commitHash`, isomorphic-git is now on version 1.23.0
+- 30ffdae70f9: Added `fetch:plain:file` action to fetch a single file, this action is also added to the list of built-in actions.
+- 65e989f4018: Added the possibility to authorize parameters and steps of a template
+
+  The scaffolder plugin is now integrated with the permission framework.
+  It is possible to toggle parameters or actions within templates by marking each section with specific `tags`, inside a `backstage:permissions` property under each parameter or action. Each parameter or action can then be permissioned by using a conditional decision containing the `scaffolderTemplateRules.hasTag` rule.
+
+- 3b68b09fc2d: Renamed permissionApi router option to permissions
+- bcae5aaf25c: Added the possibility to authorize actions
+
+  It is now possible to decide who should be able to execute certain actions or who should be able to pass specific input to specified actions.
+
+  Some of the existing utility functions for creating conditional decisions have been renamed:
+
+  - `createScaffolderConditionalDecision` has been renamed to `createScaffolderActionConditionalDecision`
+  - `scaffolderConditions` has been renamed to `scaffolderTemplateConditions`
+
+- d7c8c222e25: Allow for a commit message to differ from the PR title when publishing a GitHub pull request.
+- 95ea9f69b6f: Provide some more default filters out of the box and refactoring how the filters are applied to the `SecureTemplater`.
+
+  - `parseEntityRef` will take an string entity triplet and return a parsed object.
+  - `pick` will allow you to reference a specific property in the piped object.
+
+  So you can now combine things like this: `${{ parameters.entity | parseEntityRef | pick('name') }}` to get the name of a specific entity, or `${{ parameters.repoUrl | parseRepoUrl | pick('owner') }}` to get the owner of a repo.
+
+### Patch Changes
+
+- e23abb37ec1: Rename output parameter `mergeRequestURL` of `publish:gitlab:merge-request` action to `mergeRequestUrl`.
+- e27ddc36dad: Added a possibility to cancel the running task (executing of a scaffolder template)
+- a7eb36c6e38: Improve type-check for scaffolder output parameters
+- c9a0fdcd2c8: Fix deprecated types.
+- 1e4f5e91b8e: Bump `zod` and `zod-to-json-schema` dependencies.
+- 9c26e6d8ed3: Updated the alpha `scaffolderPlugin` to not require options.
+- f37a95adcd8: Stripped entity types and namespace before passing to GitHub API
+- Updated dependencies
+  - @backstage/backend-common@0.18.4
+  - @backstage/plugin-catalog-backend@1.9.0
+  - @backstage/plugin-scaffolder-common@1.2.7
+  - @backstage/plugin-scaffolder-node@0.1.2
+  - @backstage/catalog-client@1.4.1
+  - @backstage/plugin-permission-node@0.7.7
+  - @backstage/plugin-permission-common@0.7.5
+  - @backstage/backend-tasks@0.5.1
+  - @backstage/catalog-model@1.3.0
+  - @backstage/integration@1.4.4
+  - @backstage/plugin-auth-node@0.2.13
+  - @backstage/plugin-catalog-node@1.3.5
+  - @backstage/backend-plugin-api@0.5.1
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+  - @backstage/types@1.0.2
+  - @backstage/plugin-catalog-common@1.0.13
+
+## 1.13.0-next.3
+
+### Minor Changes
+
+- d7c8c222e25: Allow for a commit message to differ from the PR title when publishing a GitHub pull request.
+
+### Patch Changes
+
+- f37a95adcd8: Stripped entity types and namespace before passing to GitHub API
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.9.0-next.3
+  - @backstage/catalog-model@1.3.0-next.0
+  - @backstage/backend-common@0.18.4-next.2
+  - @backstage/backend-plugin-api@0.5.1-next.2
+  - @backstage/backend-tasks@0.5.1-next.2
+  - @backstage/catalog-client@1.4.1-next.1
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+  - @backstage/integration@1.4.4-next.0
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.13-next.2
+  - @backstage/plugin-catalog-common@1.0.13-next.1
+  - @backstage/plugin-catalog-node@1.3.5-next.3
+  - @backstage/plugin-permission-common@0.7.5-next.0
+  - @backstage/plugin-permission-node@0.7.7-next.2
+  - @backstage/plugin-scaffolder-common@1.2.7-next.2
+  - @backstage/plugin-scaffolder-node@0.1.2-next.3
+
 ## 1.13.0-next.2
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.13.0-next.2",
+  "version": "1.13.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
-var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-21c74c4d.cjs.js');
+var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-2f24bb9e.cjs.js');
 var alpha$1 = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var backendCommon = require('@backstage/backend-common');
@@ -31,18 +31,19 @@ require('@gitbeaker/node');
 require('@octokit/webhooks');
 require('zen-observable');
 require('p-queue');
-require('winston');
-require('nunjucks');
-require('lodash');
-require('jsonschema');
-require('prom-client');
 require('@backstage/plugin-scaffolder-common');
 require('express');
 require('express-promise-router');
+require('jsonschema');
 require('zod');
 require('yaml');
 require('luxon');
 require('uuid');
+require('winston');
+require('nunjucks');
+require('lodash');
+require('prom-client');
+require('@backstage/plugin-permission-common');
 require('url');
 require('os');
 require('@backstage/plugin-catalog-node');
@@ -62,13 +63,20 @@ const catalogModuleTemplateKind = backendPluginApi.createBackendModule({
   }
 });
 
-const { conditions, createConditionalDecision } = pluginPermissionNode.createConditionExports({
+const templateConditionExports = pluginPermissionNode.createConditionExports({
   pluginId: "scaffolder",
   resourceType: alpha$1.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
   rules: ScaffolderEntitiesProcessor.scaffolderTemplateRules
 });
-const scaffolderConditions = conditions;
-const createScaffolderConditionalDecision = createConditionalDecision;
+const actionsConditionExports = pluginPermissionNode.createConditionExports({
+  pluginId: "scaffolder",
+  resourceType: alpha$1.RESOURCE_TYPE_SCAFFOLDER_ACTION,
+  rules: ScaffolderEntitiesProcessor.scaffolderActionRules
+});
+const createScaffolderTemplateConditionalDecision = templateConditionExports.createConditionalDecision;
+const scaffolderTemplateConditions = templateConditionExports.conditions;
+const createScaffolderActionConditionalDecision = actionsConditionExports.createConditionalDecision;
+const scaffolderActionConditions = actionsConditionExports.conditions;
 
 var __accessCheck = (obj, member, msg) => {
   if (!member.has(obj))
@@ -129,9 +137,9 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin(
             taskBroker,
             taskWorkers,
             additionalTemplateGlobals
-          } = options;
+          } = options != null ? options : {};
           const log = backendCommon.loggerToWinstonLogger(logger);
-          const actions = options.actions || [
+          const actions = (options == null ? void 0 : options.actions) || [
             ...actionsExtensions.actions,
             ...ScaffolderEntitiesProcessor.createBuiltinActions({
               integrations: integration.ScmIntegrations.fromConfig(config),
@@ -157,7 +165,7 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin(
             taskWorkers,
             additionalTemplateFilters,
             additionalTemplateGlobals,
-            permissionApi: permissions
+            permissions
           });
           httpRouter.use(router);
         }
@@ -167,7 +175,9 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin(
 );
 
 exports.catalogModuleTemplateKind = catalogModuleTemplateKind;
-exports.createScaffolderConditionalDecision = createScaffolderConditionalDecision;
-exports.scaffolderConditions = scaffolderConditions;
+exports.createScaffolderActionConditionalDecision = createScaffolderActionConditionalDecision;
+exports.createScaffolderTemplateConditionalDecision = createScaffolderTemplateConditionalDecision;
+exports.scaffolderActionConditions = scaffolderActionConditions;
 exports.scaffolderPlugin = scaffolderPlugin;
+exports.scaffolderTemplateConditions = scaffolderTemplateConditions;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/modules/catalogModuleTemplateKind.ts","../src/service/conditionExports.ts","../src/ScaffolderPlugin.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createBackendModule } from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { ScaffolderEntitiesProcessor } from '../processor';\n\n/**\n * Registers support for the Template kind to the catalog backend plugin.\n *\n * @alpha\n */\nexport const catalogModuleTemplateKind = createBackendModule({\n  moduleId: 'scaffolder',\n  pluginId: 'templateKind',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n      },\n      async init({ catalog }) {\n        catalog.addProcessor(new ScaffolderEntitiesProcessor());\n      },\n    });\n  },\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha';\nimport { createConditionExports } from '@backstage/plugin-permission-node';\nimport { scaffolderTemplateRules } from './rules';\n\nconst { conditions, createConditionalDecision } = createConditionExports({\n  pluginId: 'scaffolder',\n  resourceType: RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,\n  rules: scaffolderTemplateRules,\n});\n\n/**\n * These conditions are used when creating conditional decisions for scaffolder\n * templates that are returned by authorization policies.\n *\n * @alpha\n */\nexport const scaffolderConditions = conditions;\n\n/**\n * `createScaffolderConditionalDecision` can be used when authoring policies to\n * create conditional decisions. It requires a permission of type\n * `ResourcePermission<'scaffolder-template'>` to be passed as the first parameter.\n * It's recommended that you use the provided `isResourcePermission` and\n * `isPermission` helper methods to narrow the type of the permission passed to\n * the handle method as shown below.\n *\n * ```\n * // MyAuthorizationPolicy.ts\n * ...\n * import { createScaffolderPolicyDecision } from '@backstage/plugin-scaffolder-backend';\n * import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common';\n *\n * class MyAuthorizationPolicy implements PermissionPolicy {\n *   async handle(request, user) {\n *    ...\n *\n *    if (isResourcePermission(request.permission, RESOURCE_TYPE_SCAFFOLDER_TEMPLATE)) {\n *      return createScaffolderConditionalDecision(\n *        request.permission,\n *        { anyOf: [...insert conditions here...] }\n *      );\n *    }\n *\n *    ...\n * }\n *\n * ```\n *\n * @alpha\n */\nexport const createScaffolderConditionalDecision = createConditionalDecision;\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createBackendPlugin,\n  coreServices,\n} from '@backstage/backend-plugin-api';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n  scaffolderActionsExtensionPoint,\n  ScaffolderActionsExtensionPoint,\n  TemplateAction,\n} from '@backstage/plugin-scaffolder-node';\nimport {\n  TemplateFilter,\n  TemplateGlobal,\n  TaskBroker,\n} from '@backstage/plugin-scaffolder-backend';\nimport { createBuiltinActions } from './scaffolder';\nimport { createRouter } from './service/router';\n\n/**\n * Catalog plugin options\n *\n * @alpha\n */\nexport type ScaffolderPluginOptions = {\n  actions?: TemplateAction<any>[];\n  taskWorkers?: number;\n  taskBroker?: TaskBroker;\n  additionalTemplateFilters?: Record<string, TemplateFilter>;\n  additionalTemplateGlobals?: Record<string, TemplateGlobal>;\n};\n\nclass ScaffolderActionsExtensionPointImpl\n  implements ScaffolderActionsExtensionPoint\n{\n  #actions = new Array<TemplateAction<any>>();\n\n  addActions(...actions: TemplateAction<any>[]): void {\n    this.#actions.push(...actions);\n  }\n\n  get actions() {\n    return this.#actions;\n  }\n}\n\n/**\n * Catalog plugin\n *\n * @alpha\n */\nexport const scaffolderPlugin = createBackendPlugin(\n  (options: ScaffolderPluginOptions) => ({\n    pluginId: 'scaffolder',\n    register(env) {\n      const actionsExtensions = new ScaffolderActionsExtensionPointImpl();\n\n      env.registerExtensionPoint(\n        scaffolderActionsExtensionPoint,\n        actionsExtensions,\n      );\n\n      env.registerInit({\n        deps: {\n          logger: coreServices.logger,\n          config: coreServices.config,\n          reader: coreServices.urlReader,\n          permissions: coreServices.permissions,\n          database: coreServices.database,\n          httpRouter: coreServices.httpRouter,\n          catalogClient: catalogServiceRef,\n        },\n        async init({\n          logger,\n          config,\n          reader,\n          database,\n          httpRouter,\n          catalogClient,\n          permissions,\n        }) {\n          const {\n            additionalTemplateFilters,\n            taskBroker,\n            taskWorkers,\n            additionalTemplateGlobals,\n          } = options;\n          const log = loggerToWinstonLogger(logger);\n\n          const actions = options.actions || [\n            ...actionsExtensions.actions,\n            ...createBuiltinActions({\n              integrations: ScmIntegrations.fromConfig(config),\n              catalogClient,\n              reader,\n              config,\n              additionalTemplateFilters,\n              additionalTemplateGlobals,\n            }),\n          ];\n\n          const actionIds = actions.map(action => action.id).join(', ');\n          log.info(\n            `Starting scaffolder with the following actions enabled ${actionIds}`,\n          );\n\n          const router = await createRouter({\n            logger: log,\n            config,\n            database,\n            catalogClient,\n            reader,\n            actions,\n            taskBroker,\n            taskWorkers,\n            additionalTemplateFilters,\n            additionalTemplateGlobals,\n            permissionApi: permissions,\n          });\n          httpRouter.use(router);\n        },\n      });\n    },\n  }),\n);\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","ScaffolderEntitiesProcessor","createConditionExports","RESOURCE_TYPE_SCAFFOLDER_TEMPLATE","scaffolderTemplateRules","createBackendPlugin","scaffolderActionsExtensionPoint","coreServices","catalogServiceRef","loggerToWinstonLogger","createBuiltinActions","ScmIntegrations","createRouter"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBO,MAAM,4BAA4BA,oCAAoB,CAAA;AAAA,EAC3D,QAAU,EAAA,YAAA;AAAA,EACV,QAAU,EAAA,cAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,OAAA,EAAW,EAAA;AACtB,QAAQ,OAAA,CAAA,YAAA,CAAa,IAAIC,uDAAA,EAA6B,CAAA,CAAA;AAAA,OACxD;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;AClBD,MAAM,EAAE,UAAA,EAAY,yBAA0B,EAAA,GAAIC,2CAAuB,CAAA;AAAA,EACvE,QAAU,EAAA,YAAA;AAAA,EACV,YAAc,EAAAC,yCAAA;AAAA,EACd,KAAO,EAAAC,mDAAA;AACT,CAAC,CAAA,CAAA;AAQM,MAAM,oBAAuB,GAAA,WAAA;AAkC7B,MAAM,mCAAsC,GAAA;;;;;;;;;;;;;;;AClEnD,IAAA,QAAA,CAAA;AAiDA,MAAM,mCAEN,CAAA;AAAA,EAFA,WAAA,GAAA;AAGE,IAAA,YAAA,CAAA,IAAA,EAAA,QAAA,EAAW,IAAI,KAA2B,EAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAE1C,cAAc,OAAsC,EAAA;AAClD,IAAK,YAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAS,IAAK,CAAA,GAAG,OAAO,CAAA,CAAA;AAAA,GAC/B;AAAA,EAEA,IAAI,OAAU,GAAA;AACZ,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AATE,QAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AAgBK,MAAM,gBAAmB,GAAAC,oCAAA;AAAA,EAC9B,CAAC,OAAsC,MAAA;AAAA,IACrC,QAAU,EAAA,YAAA;AAAA,IACV,SAAS,GAAK,EAAA;AACZ,MAAM,MAAA,iBAAA,GAAoB,IAAI,mCAAoC,EAAA,CAAA;AAElE,MAAI,GAAA,CAAA,sBAAA;AAAA,QACFC,oDAAA;AAAA,QACA,iBAAA;AAAA,OACF,CAAA;AAEA,MAAA,GAAA,CAAI,YAAa,CAAA;AAAA,QACf,IAAM,EAAA;AAAA,UACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,UACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,UACrB,QAAQA,6BAAa,CAAA,SAAA;AAAA,UACrB,aAAaA,6BAAa,CAAA,WAAA;AAAA,UAC1B,UAAUA,6BAAa,CAAA,QAAA;AAAA,UACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,UACzB,aAAe,EAAAC,uBAAA;AAAA,SACjB;AAAA,QACA,MAAM,IAAK,CAAA;AAAA,UACT,MAAA;AAAA,UACA,MAAA;AAAA,UACA,MAAA;AAAA,UACA,QAAA;AAAA,UACA,UAAA;AAAA,UACA,aAAA;AAAA,UACA,WAAA;AAAA,SACC,EAAA;AACD,UAAM,MAAA;AAAA,YACJ,yBAAA;AAAA,YACA,UAAA;AAAA,YACA,WAAA;AAAA,YACA,yBAAA;AAAA,WACE,GAAA,OAAA,CAAA;AACJ,UAAM,MAAA,GAAA,GAAMC,oCAAsB,MAAM,CAAA,CAAA;AAExC,UAAM,MAAA,OAAA,GAAU,QAAQ,OAAW,IAAA;AAAA,YACjC,GAAG,iBAAkB,CAAA,OAAA;AAAA,YACrB,GAAGC,gDAAqB,CAAA;AAAA,cACtB,YAAA,EAAcC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AAAA,cAC/C,aAAA;AAAA,cACA,MAAA;AAAA,cACA,MAAA;AAAA,cACA,yBAAA;AAAA,cACA,yBAAA;AAAA,aACD,CAAA;AAAA,WACH,CAAA;AAEA,UAAM,MAAA,SAAA,GAAY,QAAQ,GAAI,CAAA,CAAA,MAAA,KAAU,OAAO,EAAE,CAAA,CAAE,KAAK,IAAI,CAAA,CAAA;AAC5D,UAAI,GAAA,CAAA,IAAA;AAAA,YACF,CAA0D,uDAAA,EAAA,SAAA,CAAA,CAAA;AAAA,WAC5D,CAAA;AAEA,UAAM,MAAA,MAAA,GAAS,MAAMC,wCAAa,CAAA;AAAA,YAChC,MAAQ,EAAA,GAAA;AAAA,YACR,MAAA;AAAA,YACA,QAAA;AAAA,YACA,aAAA;AAAA,YACA,MAAA;AAAA,YACA,OAAA;AAAA,YACA,UAAA;AAAA,YACA,WAAA;AAAA,YACA,yBAAA;AAAA,YACA,yBAAA;AAAA,YACA,aAAe,EAAA,WAAA;AAAA,WAChB,CAAA,CAAA;AACD,UAAA,UAAA,CAAW,IAAI,MAAM,CAAA,CAAA;AAAA,SACvB;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/modules/catalogModuleTemplateKind.ts","../src/service/conditionExports.ts","../src/ScaffolderPlugin.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createBackendModule } from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { ScaffolderEntitiesProcessor } from '../processor';\n\n/**\n * Registers support for the Template kind to the catalog backend plugin.\n *\n * @alpha\n */\nexport const catalogModuleTemplateKind = createBackendModule({\n  moduleId: 'scaffolder',\n  pluginId: 'templateKind',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n      },\n      async init({ catalog }) {\n        catalog.addProcessor(new ScaffolderEntitiesProcessor());\n      },\n    });\n  },\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,\n  RESOURCE_TYPE_SCAFFOLDER_ACTION,\n} from '@backstage/plugin-scaffolder-common/alpha';\nimport { createConditionExports } from '@backstage/plugin-permission-node';\nimport { scaffolderTemplateRules, scaffolderActionRules } from './rules';\n\nconst templateConditionExports = createConditionExports({\n  pluginId: 'scaffolder',\n  resourceType: RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,\n  rules: scaffolderTemplateRules,\n});\n\nconst actionsConditionExports = createConditionExports({\n  pluginId: 'scaffolder',\n  resourceType: RESOURCE_TYPE_SCAFFOLDER_ACTION,\n  rules: scaffolderActionRules,\n});\n\n/**\n * `createScaffolderTemplateConditionalDecision` can be used when authoring policies to\n * create conditional decisions. It requires a permission of type\n * `ResourcePermission<'scaffolder-template'>` to be passed as the first parameter.\n * It's recommended that you use the provided `isResourcePermission` and\n * `isPermission` helper methods to narrow the type of the permission passed to\n * the handle method as shown below.\n *\n * ```\n * // MyAuthorizationPolicy.ts\n * ...\n * import { createScaffolderPolicyDecision } from '@backstage/plugin-scaffolder-backend';\n * import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common';\n *\n * class MyAuthorizationPolicy implements PermissionPolicy {\n *   async handle(request, user) {\n *    ...\n *\n *    if (isResourcePermission(request.permission, RESOURCE_TYPE_SCAFFOLDER_TEMPLATE)) {\n *      return createScaffolderConditionalDecision(\n *        request.permission,\n *        { anyOf: [...insert conditions here...] }\n *      );\n *    }\n *\n *    ...\n * }\n *\n * ```\n *\n * @alpha\n */\nexport const createScaffolderTemplateConditionalDecision =\n  templateConditionExports.createConditionalDecision;\n\n/**\n * These conditions are used when creating conditional decisions for scaffolder\n * templates that are returned by authorization policies.\n *\n * @alpha\n */\nexport const scaffolderTemplateConditions = templateConditionExports.conditions;\n\n/**\n * @alpha\n */\nexport const createScaffolderActionConditionalDecision =\n  actionsConditionExports.createConditionalDecision;\n\n/**\n *\n * These conditions are used when creating conditional decisions for scaffolder\n * actions that are returned by authorization policies.\n *\n * @alpha\n */\nexport const scaffolderActionConditions = actionsConditionExports.conditions;\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createBackendPlugin,\n  coreServices,\n} from '@backstage/backend-plugin-api';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n  scaffolderActionsExtensionPoint,\n  ScaffolderActionsExtensionPoint,\n  TemplateAction,\n} from '@backstage/plugin-scaffolder-node';\nimport {\n  TemplateFilter,\n  TemplateGlobal,\n  TaskBroker,\n} from '@backstage/plugin-scaffolder-backend';\nimport { createBuiltinActions } from './scaffolder';\nimport { createRouter } from './service/router';\n\n/**\n * Catalog plugin options\n *\n * @alpha\n */\nexport type ScaffolderPluginOptions = {\n  actions?: TemplateAction<any>[];\n  taskWorkers?: number;\n  taskBroker?: TaskBroker;\n  additionalTemplateFilters?: Record<string, TemplateFilter>;\n  additionalTemplateGlobals?: Record<string, TemplateGlobal>;\n};\n\nclass ScaffolderActionsExtensionPointImpl\n  implements ScaffolderActionsExtensionPoint\n{\n  #actions = new Array<TemplateAction<any>>();\n\n  addActions(...actions: TemplateAction<any>[]): void {\n    this.#actions.push(...actions);\n  }\n\n  get actions() {\n    return this.#actions;\n  }\n}\n\n/**\n * Catalog plugin\n *\n * @alpha\n */\nexport const scaffolderPlugin = createBackendPlugin(\n  (options?: ScaffolderPluginOptions) => ({\n    pluginId: 'scaffolder',\n    register(env) {\n      const actionsExtensions = new ScaffolderActionsExtensionPointImpl();\n\n      env.registerExtensionPoint(\n        scaffolderActionsExtensionPoint,\n        actionsExtensions,\n      );\n\n      env.registerInit({\n        deps: {\n          logger: coreServices.logger,\n          config: coreServices.config,\n          reader: coreServices.urlReader,\n          permissions: coreServices.permissions,\n          database: coreServices.database,\n          httpRouter: coreServices.httpRouter,\n          catalogClient: catalogServiceRef,\n        },\n        async init({\n          logger,\n          config,\n          reader,\n          database,\n          httpRouter,\n          catalogClient,\n          permissions,\n        }) {\n          const {\n            additionalTemplateFilters,\n            taskBroker,\n            taskWorkers,\n            additionalTemplateGlobals,\n          } = options ?? {};\n          const log = loggerToWinstonLogger(logger);\n\n          const actions = options?.actions || [\n            ...actionsExtensions.actions,\n            ...createBuiltinActions({\n              integrations: ScmIntegrations.fromConfig(config),\n              catalogClient,\n              reader,\n              config,\n              additionalTemplateFilters,\n              additionalTemplateGlobals,\n            }),\n          ];\n\n          const actionIds = actions.map(action => action.id).join(', ');\n          log.info(\n            `Starting scaffolder with the following actions enabled ${actionIds}`,\n          );\n\n          const router = await createRouter({\n            logger: log,\n            config,\n            database,\n            catalogClient,\n            reader,\n            actions,\n            taskBroker,\n            taskWorkers,\n            additionalTemplateFilters,\n            additionalTemplateGlobals,\n            permissions,\n          });\n          httpRouter.use(router);\n        },\n      });\n    },\n  }),\n);\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","ScaffolderEntitiesProcessor","createConditionExports","RESOURCE_TYPE_SCAFFOLDER_TEMPLATE","scaffolderTemplateRules","RESOURCE_TYPE_SCAFFOLDER_ACTION","scaffolderActionRules","createBackendPlugin","scaffolderActionsExtensionPoint","coreServices","catalogServiceRef","loggerToWinstonLogger","createBuiltinActions","ScmIntegrations","createRouter"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBO,MAAM,4BAA4BA,oCAAoB,CAAA;AAAA,EAC3D,QAAU,EAAA,YAAA;AAAA,EACV,QAAU,EAAA,cAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,OAAA,EAAW,EAAA;AACtB,QAAQ,OAAA,CAAA,YAAA,CAAa,IAAIC,uDAAA,EAA6B,CAAA,CAAA;AAAA,OACxD;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;ACfD,MAAM,2BAA2BC,2CAAuB,CAAA;AAAA,EACtD,QAAU,EAAA,YAAA;AAAA,EACV,YAAc,EAAAC,yCAAA;AAAA,EACd,KAAO,EAAAC,mDAAA;AACT,CAAC,CAAA,CAAA;AAED,MAAM,0BAA0BF,2CAAuB,CAAA;AAAA,EACrD,QAAU,EAAA,YAAA;AAAA,EACV,YAAc,EAAAG,uCAAA;AAAA,EACd,KAAO,EAAAC,iDAAA;AACT,CAAC,CAAA,CAAA;AAkCM,MAAM,8CACX,wBAAyB,CAAA,0BAAA;AAQpB,MAAM,+BAA+B,wBAAyB,CAAA,WAAA;AAK9D,MAAM,4CACX,uBAAwB,CAAA,0BAAA;AASnB,MAAM,6BAA6B,uBAAwB,CAAA;;;;;;;;;;;;;;;AC3FlE,IAAA,QAAA,CAAA;AAiDA,MAAM,mCAEN,CAAA;AAAA,EAFA,WAAA,GAAA;AAGE,IAAA,YAAA,CAAA,IAAA,EAAA,QAAA,EAAW,IAAI,KAA2B,EAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAE1C,cAAc,OAAsC,EAAA;AAClD,IAAK,YAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAS,IAAK,CAAA,GAAG,OAAO,CAAA,CAAA;AAAA,GAC/B;AAAA,EAEA,IAAI,OAAU,GAAA;AACZ,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAAA,GACd;AACF,CAAA;AATE,QAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AAgBK,MAAM,gBAAmB,GAAAC,oCAAA;AAAA,EAC9B,CAAC,OAAuC,MAAA;AAAA,IACtC,QAAU,EAAA,YAAA;AAAA,IACV,SAAS,GAAK,EAAA;AACZ,MAAM,MAAA,iBAAA,GAAoB,IAAI,mCAAoC,EAAA,CAAA;AAElE,MAAI,GAAA,CAAA,sBAAA;AAAA,QACFC,oDAAA;AAAA,QACA,iBAAA;AAAA,OACF,CAAA;AAEA,MAAA,GAAA,CAAI,YAAa,CAAA;AAAA,QACf,IAAM,EAAA;AAAA,UACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,UACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,UACrB,QAAQA,6BAAa,CAAA,SAAA;AAAA,UACrB,aAAaA,6BAAa,CAAA,WAAA;AAAA,UAC1B,UAAUA,6BAAa,CAAA,QAAA;AAAA,UACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,UACzB,aAAe,EAAAC,uBAAA;AAAA,SACjB;AAAA,QACA,MAAM,IAAK,CAAA;AAAA,UACT,MAAA;AAAA,UACA,MAAA;AAAA,UACA,MAAA;AAAA,UACA,QAAA;AAAA,UACA,UAAA;AAAA,UACA,aAAA;AAAA,UACA,WAAA;AAAA,SACC,EAAA;AACD,UAAM,MAAA;AAAA,YACJ,yBAAA;AAAA,YACA,UAAA;AAAA,YACA,WAAA;AAAA,YACA,yBAAA;AAAA,WACF,GAAI,4BAAW,EAAC,CAAA;AAChB,UAAM,MAAA,GAAA,GAAMC,oCAAsB,MAAM,CAAA,CAAA;AAExC,UAAM,MAAA,OAAA,GAAA,CAAU,mCAAS,OAAW,KAAA;AAAA,YAClC,GAAG,iBAAkB,CAAA,OAAA;AAAA,YACrB,GAAGC,gDAAqB,CAAA;AAAA,cACtB,YAAA,EAAcC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AAAA,cAC/C,aAAA;AAAA,cACA,MAAA;AAAA,cACA,MAAA;AAAA,cACA,yBAAA;AAAA,cACA,yBAAA;AAAA,aACD,CAAA;AAAA,WACH,CAAA;AAEA,UAAM,MAAA,SAAA,GAAY,QAAQ,GAAI,CAAA,CAAA,MAAA,KAAU,OAAO,EAAE,CAAA,CAAE,KAAK,IAAI,CAAA,CAAA;AAC5D,UAAI,GAAA,CAAA,IAAA;AAAA,YACF,CAA0D,uDAAA,EAAA,SAAA,CAAA,CAAA;AAAA,WAC5D,CAAA;AAEA,UAAM,MAAA,MAAA,GAAS,MAAMC,wCAAa,CAAA;AAAA,YAChC,MAAQ,EAAA,GAAA;AAAA,YACR,MAAA;AAAA,YACA,QAAA;AAAA,YACA,aAAA;AAAA,YACA,MAAA;AAAA,YACA,OAAA;AAAA,YACA,UAAA;AAAA,YACA,WAAA;AAAA,YACA,yBAAA;AAAA,YACA,yBAAA;AAAA,YACA,WAAA;AAAA,WACD,CAAA,CAAA;AACD,UAAA,UAAA,CAAW,IAAI,MAAM,CAAA,CAAA;AAAA,SACvB;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -1,7 +1,8 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
+import * as _backstage_types from '@backstage/types';
 import * as _backstage_plugin_permission_node from '@backstage/plugin-permission-node';
 import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
+import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
 import { TemplateAction } from '@backstage/plugin-scaffolder-node';
 import { TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-scaffolder-backend';
 
@@ -13,18 +14,7 @@ import { TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-sc
 declare const catalogModuleTemplateKind: () => _backstage_backend_plugin_api.BackendFeature;
 
 /**
- * These conditions are used when creating conditional decisions for scaffolder
- * templates that are returned by authorization policies.
- *
- * @alpha
- */
-declare const scaffolderConditions: _backstage_plugin_permission_node.Conditions<{
-    hasTag: _backstage_plugin_permission_node.PermissionRule<_backstage_plugin_scaffolder_common.TemplateParametersV1beta3 | _backstage_plugin_scaffolder_common.TemplateEntityStepV1beta3, {}, "scaffolder-template", {
-        tag: string;
-    }>;
-}>;
-/**
- * `createScaffolderConditionalDecision` can be used when authoring policies to
+ * `createScaffolderTemplateConditionalDecision` can be used when authoring policies to
  * create conditional decisions. It requires a permission of type
  * `ResourcePermission<'scaffolder-template'>` to be passed as the first parameter.
  * It's recommended that you use the provided `isResourcePermission` and
@@ -55,7 +45,58 @@ declare const scaffolderConditions: _backstage_plugin_permission_node.Conditions
  *
  * @alpha
  */
-declare const createScaffolderConditionalDecision: (permission: _backstage_plugin_permission_common.ResourcePermission<"scaffolder-template">, conditions: _backstage_plugin_permission_common.PermissionCriteria<_backstage_plugin_permission_common.PermissionCondition<"scaffolder-template">>) => _backstage_plugin_permission_common.ConditionalPolicyDecision;
+declare const createScaffolderTemplateConditionalDecision: (permission: _backstage_plugin_permission_common.ResourcePermission<"scaffolder-template">, conditions: _backstage_plugin_permission_common.PermissionCriteria<_backstage_plugin_permission_common.PermissionCondition<"scaffolder-template">>) => _backstage_plugin_permission_common.ConditionalPolicyDecision;
+/**
+ * These conditions are used when creating conditional decisions for scaffolder
+ * templates that are returned by authorization policies.
+ *
+ * @alpha
+ */
+declare const scaffolderTemplateConditions: _backstage_plugin_permission_node.Conditions<{
+    hasTag: _backstage_plugin_permission_node.PermissionRule<_backstage_plugin_scaffolder_common.TemplateParametersV1beta3 | _backstage_plugin_scaffolder_common.TemplateEntityStepV1beta3, {}, "scaffolder-template", {
+        tag: string;
+    }>;
+}>;
+/**
+ * @alpha
+ */
+declare const createScaffolderActionConditionalDecision: (permission: _backstage_plugin_permission_common.ResourcePermission<"scaffolder-action">, conditions: _backstage_plugin_permission_common.PermissionCriteria<_backstage_plugin_permission_common.PermissionCondition<"scaffolder-action">>) => _backstage_plugin_permission_common.ConditionalPolicyDecision;
+/**
+ *
+ * These conditions are used when creating conditional decisions for scaffolder
+ * actions that are returned by authorization policies.
+ *
+ * @alpha
+ */
+declare const scaffolderActionConditions: _backstage_plugin_permission_node.Conditions<{
+    hasActionId: _backstage_plugin_permission_node.PermissionRule<{
+        action: string;
+        input: _backstage_types.JsonObject | undefined;
+    }, {}, "scaffolder-action", {
+        actionId: string;
+    }>;
+    hasBooleanProperty: _backstage_plugin_permission_node.PermissionRule<{
+        action: string;
+        input: _backstage_types.JsonObject | undefined;
+    }, {}, "scaffolder-action", {
+        key: string;
+        value?: boolean | undefined;
+    }>;
+    hasNumberProperty: _backstage_plugin_permission_node.PermissionRule<{
+        action: string;
+        input: _backstage_types.JsonObject | undefined;
+    }, {}, "scaffolder-action", {
+        key: string;
+        value?: number | undefined;
+    }>;
+    hasStringProperty: _backstage_plugin_permission_node.PermissionRule<{
+        action: string;
+        input: _backstage_types.JsonObject | undefined;
+    }, {}, "scaffolder-action", {
+        key: string;
+        value?: string | undefined;
+    }>;
+}>;
 
 /**
  * Catalog plugin options
@@ -74,6 +115,6 @@ type ScaffolderPluginOptions = {
  *
  * @alpha
  */
-declare const scaffolderPlugin: (options: ScaffolderPluginOptions) => _backstage_backend_plugin_api.BackendFeature;
+declare const scaffolderPlugin: (options?: ScaffolderPluginOptions | undefined) => _backstage_backend_plugin_api.BackendFeature;
 
-export { ScaffolderPluginOptions, catalogModuleTemplateKind, createScaffolderConditionalDecision, scaffolderConditions, scaffolderPlugin };
+export { ScaffolderPluginOptions, catalogModuleTemplateKind, createScaffolderActionConditionalDecision, createScaffolderTemplateConditionalDecision, scaffolderActionConditions, scaffolderPlugin, scaffolderTemplateConditions };