@backstage/plugin-scaffolder-backend 1.15.2-next.0 → 1.15.2-next.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.15.2-next.1
+
+### Patch Changes
+
+- 629cbd194a87: Use `coreServices.rootConfig` instead of `coreService.config`
+- d3b31a791eb1: Deprecated `executeShellCommand`, `RunCommandOptions`, and `fetchContents` from `@backstage/plugin-scaffolder-backend`, since they are useful for Scaffolder modules (who should not be importing from the plugin package itself). You should now import these from `@backstage/plugin-scaffolder-backend-node` instead. `RunCommandOptions` was renamed in the Node package as `ExecuteShellCommandOptions`, for consistency.
+- Updated dependencies
+  - @backstage/backend-common@0.19.2-next.1
+  - @backstage/plugin-catalog-backend@1.12.0-next.1
+  - @backstage/plugin-scaffolder-node@0.1.6-next.1
+  - @backstage/plugin-catalog-node@1.4.1-next.1
+  - @backstage/plugin-auth-node@0.2.17-next.1
+  - @backstage/backend-plugin-api@0.6.0-next.1
+  - @backstage/backend-tasks@0.5.5-next.1
+  - @backstage/plugin-permission-node@0.7.11-next.1
+  - @backstage/integration@1.5.1
+  - @backstage/catalog-client@1.4.3
+  - @backstage/catalog-model@1.4.1
+  - @backstage/config@1.0.8
+  - @backstage/errors@1.2.1
+  - @backstage/types@1.1.0
+  - @backstage/plugin-catalog-common@1.0.15
+  - @backstage/plugin-permission-common@0.7.7
+  - @backstage/plugin-scaffolder-common@1.3.2
+
 ## 1.15.2-next.0
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -4,22 +4,20 @@ 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-b514f9e5.cjs.js');
+var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-1d387347.cjs.js');
 var alpha$1 = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');
 var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
-require('@backstage/errors');
-require('fs-extra');
 require('path');
+require('@backstage/errors');
 require('globby');
+require('fs-extra');
 require('isbinaryfile');
 require('isolated-vm');
 require('@backstage/catalog-model');
 require('lodash/get');
-require('child_process');
-require('stream');
 require('azure-devops-node-api');
 require('node-fetch');
 require('crypto');
@@ -42,6 +40,7 @@ require('luxon');
 require('uuid');
 require('winston');
 require('nunjucks');
+require('stream');
 require('lodash');
 require('prom-client');
 require('@backstage/plugin-permission-common');
@@ -117,7 +116,7 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin(
       env.registerInit({
         deps: {
           logger: backendPluginApi.coreServices.logger,
-          config: backendPluginApi.coreServices.config,
+          config: backendPluginApi.coreServices.rootConfig,
           reader: backendPluginApi.coreServices.urlReader,
           permissions: backendPluginApi.coreServices.permissions,
           database: backendPluginApi.coreServices.database,

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 {\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, 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, 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,KAAgC,EAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAE/C,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,0DAA0D,SAAS,CAAA,CAAA;AAAA,WACrE,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;;;;;;;;;"}
+{"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, 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, 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.rootConfig,\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,KAAgC,EAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAE/C,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,UAAA;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,0DAA0D,SAAS,CAAA,CAAA;AAAA,WACrE,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/cjs/{ScaffolderEntitiesProcessor-b514f9e5.cjs.js → ScaffolderEntitiesProcessor-1d387347.cjs.js}

@@ -20,8 +20,6 @@ var isbinaryfile = require('isbinaryfile');
 var isolatedVm = require('isolated-vm');
 var get = require('lodash/get');
 var octokit = require('octokit');
-var child_process = require('child_process');
-var stream = require('stream');
 var Sodium = require('libsodium-wrappers');
 var webhooks = require('@octokit/webhooks');
 var azureDevopsNodeApi = require('azure-devops-node-api');
@@ -36,6 +34,7 @@ var ObservableImpl = require('zen-observable');
 var PQueue = require('p-queue');
 var winston = require('winston');
 var nunjucks = require('nunjucks');
+var stream = require('stream');
 var lodash = require('lodash');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var promClient = require('prom-client');
@@ -575,62 +574,6 @@ function createWaitAction(options) {
   });
 }
 
-async function fetchContents(options) {
-  const { reader, integrations, baseUrl, fetchUrl = ".", outputPath } = options;
-  const fetchUrlIsAbsolute = isFetchUrlAbsolute(fetchUrl);
-  if (!fetchUrlIsAbsolute && (baseUrl == null ? void 0 : baseUrl.startsWith("file://"))) {
-    const basePath = baseUrl.slice("file://".length);
-    const srcDir = backendCommon.resolveSafeChildPath(path__default["default"].dirname(basePath), fetchUrl);
-    await fs__default["default"].copy(srcDir, outputPath);
-  } else {
-    const readUrl = getReadUrl(fetchUrl, baseUrl, integrations);
-    const res = await reader.readTree(readUrl);
-    await fs__default["default"].ensureDir(outputPath);
-    await res.dir({ targetDir: outputPath });
-  }
-}
-async function fetchFile(options) {
-  const { reader, integrations, baseUrl, fetchUrl = ".", outputPath } = options;
-  const fetchUrlIsAbsolute = isFetchUrlAbsolute(fetchUrl);
-  if (!fetchUrlIsAbsolute && (baseUrl == null ? void 0 : baseUrl.startsWith("file://"))) {
-    const basePath = baseUrl.slice("file://".length);
-    const src = backendCommon.resolveSafeChildPath(path__default["default"].dirname(basePath), fetchUrl);
-    await fs__default["default"].copyFile(src, outputPath);
-  } else {
-    const readUrl = getReadUrl(fetchUrl, baseUrl, integrations);
-    const res = await reader.readUrl(readUrl);
-    await fs__default["default"].ensureDir(path__default["default"].dirname(outputPath));
-    const buffer = await res.buffer();
-    await fs__default["default"].outputFile(outputPath, buffer.toString());
-  }
-}
-function isFetchUrlAbsolute(fetchUrl) {
-  let fetchUrlIsAbsolute = false;
-  try {
-    new URL(fetchUrl);
-    fetchUrlIsAbsolute = true;
-  } catch {
-  }
-  return fetchUrlIsAbsolute;
-}
-function getReadUrl(fetchUrl, baseUrl, integrations) {
-  if (isFetchUrlAbsolute(fetchUrl)) {
-    return fetchUrl;
-  } else if (baseUrl) {
-    const integration = integrations.byUrl(baseUrl);
-    if (!integration) {
-      throw new errors.InputError(`No integration found for location ${baseUrl}`);
-    }
-    return integration.resolveUrl({
-      url: fetchUrl,
-      base: baseUrl
-    });
-  }
-  throw new errors.InputError(
-    `Failed to fetch, template location could not be determined and the fetch URL is relative, ${fetchUrl}`
-  );
-}
-
 function createFetchPlainAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
@@ -660,7 +603,7 @@ function createFetchPlainAction(options) {
       ctx.logger.info("Fetching plain content from remote URL");
       const targetPath = (_a = ctx.input.targetPath) != null ? _a : "./";
       const outputPath = backendCommon.resolveSafeChildPath(ctx.workspacePath, targetPath);
-      await fetchContents({
+      await pluginScaffolderNode.fetchContents({
         reader,
         integrations,
         baseUrl: (_b = ctx.templateInfo) == null ? void 0 : _b.baseUrl,
@@ -702,7 +645,7 @@ function createFetchPlainFileAction(options) {
         ctx.workspacePath,
         ctx.input.targetPath
       );
-      await fetchFile({
+      await pluginScaffolderNode.fetchFile({
         reader,
         integrations,
         baseUrl: (_a = ctx.templateInfo) == null ? void 0 : _a.baseUrl,
@@ -1050,7 +993,7 @@ function createFetchTemplateAction(options) {
           extension = `.${extension}`;
         }
       }
-      await fetchContents({
+      await pluginScaffolderNode.fetchContents({
         reader,
         integrations,
         baseUrl: (_b = ctx.templateInfo) == null ? void 0 : _b.baseUrl,
@@ -1267,34 +1210,6 @@ const createFilesystemRenameAction = () => {
   });
 };
 
-const executeShellCommand = async (options) => {
-  const {
-    command,
-    args,
-    options: spawnOptions,
-    logStream = new stream.PassThrough()
-  } = options;
-  await new Promise((resolve, reject) => {
-    const process = child_process.spawn(command, args, spawnOptions);
-    process.stdout.on("data", (stream) => {
-      logStream.write(stream);
-    });
-    process.stderr.on("data", (stream) => {
-      logStream.write(stream);
-    });
-    process.on("error", (error) => {
-      return reject(error);
-    });
-    process.on("close", (code) => {
-      if (code !== 0) {
-        return reject(
-          new Error(`Command ${command} failed, exit code: ${code}`)
-        );
-      }
-      return resolve();
-    });
-  });
-};
 async function initRepoAndPush({
   dir,
   remoteUrl,
@@ -6801,8 +6716,6 @@ exports.createPublishGitlabAction = createPublishGitlabAction;
 exports.createPublishGitlabMergeRequestAction = createPublishGitlabMergeRequestAction;
 exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
-exports.executeShellCommand = executeShellCommand;
-exports.fetchContents = fetchContents;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=ScaffolderEntitiesProcessor-b514f9e5.cjs.js.map
+//# sourceMappingURL=ScaffolderEntitiesProcessor-1d387347.cjs.js.map