@backstage/plugin-scaffolder-backend 1.26.0-next.1 → 1.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/CHANGELOG.md +85 -0
  2. package/README.md +1 -1
  3. package/alpha/package.json +1 -1
  4. package/dist/ScaffolderPlugin.cjs.js +168 -0
  5. package/dist/ScaffolderPlugin.cjs.js.map +1 -0
  6. package/dist/alpha.cjs.js +8 -197
  7. package/dist/alpha.cjs.js.map +1 -1
  8. package/dist/alpha.d.ts +4 -8
  9. package/dist/deprecated.cjs.js +15 -0
  10. package/dist/deprecated.cjs.js.map +1 -0
  11. package/dist/index.cjs.js +60 -133
  12. package/dist/index.cjs.js.map +1 -1
  13. package/dist/index.d.ts +11 -3
  14. package/dist/lib/templating/SecureTemplater.cjs.js +169 -0
  15. package/dist/lib/templating/SecureTemplater.cjs.js.map +1 -0
  16. package/dist/lib/templating/filters.cjs.js +26 -0
  17. package/dist/lib/templating/filters.cjs.js.map +1 -0
  18. package/dist/lib/templating/helpers.cjs.js +13 -0
  19. package/dist/lib/templating/helpers.cjs.js.map +1 -0
  20. package/dist/scaffolder/actions/TemplateActionRegistry.cjs.js +30 -0
  21. package/dist/scaffolder/actions/TemplateActionRegistry.cjs.js.map +1 -0
  22. package/dist/scaffolder/actions/builtin/catalog/fetch.cjs.js +93 -0
  23. package/dist/scaffolder/actions/builtin/catalog/fetch.cjs.js.map +1 -0
  24. package/dist/scaffolder/actions/builtin/catalog/fetch.examples.cjs.js +43 -0
  25. package/dist/scaffolder/actions/builtin/catalog/fetch.examples.cjs.js.map +1 -0
  26. package/dist/scaffolder/actions/builtin/catalog/register.cjs.js +142 -0
  27. package/dist/scaffolder/actions/builtin/catalog/register.cjs.js.map +1 -0
  28. package/dist/scaffolder/actions/builtin/catalog/register.examples.cjs.js +28 -0
  29. package/dist/scaffolder/actions/builtin/catalog/register.examples.cjs.js.map +1 -0
  30. package/dist/scaffolder/actions/builtin/catalog/write.cjs.js +74 -0
  31. package/dist/scaffolder/actions/builtin/catalog/write.cjs.js.map +1 -0
  32. package/dist/scaffolder/actions/builtin/catalog/write.examples.cjs.js +56 -0
  33. package/dist/scaffolder/actions/builtin/catalog/write.examples.cjs.js.map +1 -0
  34. package/dist/scaffolder/actions/builtin/createBuiltinActions.cjs.js +156 -0
  35. package/dist/scaffolder/actions/builtin/createBuiltinActions.cjs.js.map +1 -0
  36. package/dist/scaffolder/actions/builtin/debug/log.cjs.js +66 -0
  37. package/dist/scaffolder/actions/builtin/debug/log.cjs.js.map +1 -0
  38. package/dist/scaffolder/actions/builtin/debug/log.examples.cjs.js +58 -0
  39. package/dist/scaffolder/actions/builtin/debug/log.examples.cjs.js.map +1 -0
  40. package/dist/scaffolder/actions/builtin/debug/wait.cjs.js +66 -0
  41. package/dist/scaffolder/actions/builtin/debug/wait.cjs.js.map +1 -0
  42. package/dist/scaffolder/actions/builtin/debug/wait.examples.cjs.js +58 -0
  43. package/dist/scaffolder/actions/builtin/debug/wait.examples.cjs.js.map +1 -0
  44. package/dist/scaffolder/actions/builtin/fetch/plain.cjs.js +56 -0
  45. package/dist/scaffolder/actions/builtin/fetch/plain.cjs.js.map +1 -0
  46. package/dist/scaffolder/actions/builtin/fetch/plain.examples.cjs.js +44 -0
  47. package/dist/scaffolder/actions/builtin/fetch/plain.examples.cjs.js.map +1 -0
  48. package/dist/scaffolder/actions/builtin/fetch/plainFile.cjs.js +56 -0
  49. package/dist/scaffolder/actions/builtin/fetch/plainFile.cjs.js.map +1 -0
  50. package/dist/scaffolder/actions/builtin/fetch/plainFile.examples.cjs.js +29 -0
  51. package/dist/scaffolder/actions/builtin/fetch/plainFile.examples.cjs.js.map +1 -0
  52. package/dist/scaffolder/actions/builtin/fetch/template.cjs.js +241 -0
  53. package/dist/scaffolder/actions/builtin/fetch/template.cjs.js.map +1 -0
  54. package/dist/scaffolder/actions/builtin/fetch/template.examples.cjs.js +35 -0
  55. package/dist/scaffolder/actions/builtin/fetch/template.examples.cjs.js.map +1 -0
  56. package/dist/scaffolder/actions/builtin/fetch/templateFile.cjs.js +119 -0
  57. package/dist/scaffolder/actions/builtin/fetch/templateFile.cjs.js.map +1 -0
  58. package/dist/scaffolder/actions/builtin/fetch/templateFile.examples.cjs.js +34 -0
  59. package/dist/scaffolder/actions/builtin/fetch/templateFile.examples.cjs.js.map +1 -0
  60. package/dist/scaffolder/actions/builtin/filesystem/delete.cjs.js +54 -0
  61. package/dist/scaffolder/actions/builtin/filesystem/delete.cjs.js.map +1 -0
  62. package/dist/scaffolder/actions/builtin/filesystem/delete.examples.cjs.js +44 -0
  63. package/dist/scaffolder/actions/builtin/filesystem/delete.examples.cjs.js.map +1 -0
  64. package/dist/scaffolder/actions/builtin/filesystem/rename.cjs.js +83 -0
  65. package/dist/scaffolder/actions/builtin/filesystem/rename.cjs.js.map +1 -0
  66. package/dist/scaffolder/actions/builtin/filesystem/rename.examples.cjs.js +48 -0
  67. package/dist/scaffolder/actions/builtin/filesystem/rename.examples.cjs.js.map +1 -0
  68. package/dist/scaffolder/actions/deprecated.cjs.js +74 -0
  69. package/dist/scaffolder/actions/deprecated.cjs.js.map +1 -0
  70. package/dist/scaffolder/dryrun/DecoratedActionsRegistry.cjs.js +57 -0
  71. package/dist/scaffolder/dryrun/DecoratedActionsRegistry.cjs.js.map +1 -0
  72. package/dist/scaffolder/dryrun/createDryRunner.cjs.js +97 -0
  73. package/dist/scaffolder/dryrun/createDryRunner.cjs.js.map +1 -0
  74. package/dist/scaffolder/tasks/DatabaseTaskStore.cjs.js +430 -0
  75. package/dist/scaffolder/tasks/DatabaseTaskStore.cjs.js.map +1 -0
  76. package/dist/scaffolder/tasks/DatabaseWorkspaceProvider.cjs.js +22 -0
  77. package/dist/scaffolder/tasks/DatabaseWorkspaceProvider.cjs.js.map +1 -0
  78. package/dist/scaffolder/tasks/NunjucksWorkflowRunner.cjs.js +545 -0
  79. package/dist/scaffolder/tasks/NunjucksWorkflowRunner.cjs.js.map +1 -0
  80. package/dist/scaffolder/tasks/StorageTaskBroker.cjs.js +318 -0
  81. package/dist/scaffolder/tasks/StorageTaskBroker.cjs.js.map +1 -0
  82. package/dist/scaffolder/tasks/TaskWorker.cjs.js +110 -0
  83. package/dist/scaffolder/tasks/TaskWorker.cjs.js.map +1 -0
  84. package/dist/scaffolder/tasks/WorkspaceService.cjs.js +50 -0
  85. package/dist/scaffolder/tasks/WorkspaceService.cjs.js.map +1 -0
  86. package/dist/scaffolder/tasks/dbUtil.cjs.js +20 -0
  87. package/dist/scaffolder/tasks/dbUtil.cjs.js.map +1 -0
  88. package/dist/scaffolder/tasks/helper.cjs.js +46 -0
  89. package/dist/scaffolder/tasks/helper.cjs.js.map +1 -0
  90. package/dist/scaffolder/tasks/logger.cjs.js +156 -0
  91. package/dist/scaffolder/tasks/logger.cjs.js.map +1 -0
  92. package/dist/scaffolder/tasks/taskRecoveryHelper.cjs.js +18 -0
  93. package/dist/scaffolder/tasks/taskRecoveryHelper.cjs.js.map +1 -0
  94. package/dist/service/conditionExports.cjs.js +26 -0
  95. package/dist/service/conditionExports.cjs.js.map +1 -0
  96. package/dist/service/helpers.cjs.js +92 -0
  97. package/dist/service/helpers.cjs.js.map +1 -0
  98. package/dist/service/router.cjs.js +640 -0
  99. package/dist/service/router.cjs.js.map +1 -0
  100. package/dist/service/rules.cjs.js +97 -0
  101. package/dist/service/rules.cjs.js.map +1 -0
  102. package/dist/util/checkPermissions.cjs.js +25 -0
  103. package/dist/util/checkPermissions.cjs.js.map +1 -0
  104. package/dist/util/metrics.cjs.js +24 -0
  105. package/dist/util/metrics.cjs.js.map +1 -0
  106. package/package.json +32 -31
  107. package/dist/cjs/router-BqZK9yax.cjs.js +0 -4101
  108. package/dist/cjs/router-BqZK9yax.cjs.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,90 @@
1
1
  # @backstage/plugin-scaffolder-backend
2
2
 
3
+ ## 1.26.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 3ec4e6d: Added pagination support for listing of tasks and the ability to filter on several users and task statuses.
8
+ - 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
9
+
10
+ ### Patch Changes
11
+
12
+ - 734c2d4: Add `fetch:template:file` scaffolder action to download a single file and template the contents. Example usage:
13
+
14
+ ```yaml
15
+ - id: fetch-file
16
+ name: Fetch File
17
+ action: fetch:template:file
18
+ input:
19
+ url: https://github.com/backstage/software-templates/blob/main/scaffolder-templates/create-react-app/skeleton/catalog-info.yaml
20
+ targetPath: './target/catalog-info.yaml'
21
+ values:
22
+ component_id: My Component
23
+ owner: Test
24
+ ```
25
+
26
+ - f1f0076: handle step.if: false
27
+ - 2f90932: Include step name and step id to checkpoint key
28
+ - 094eaa3: Remove references to in-repo backend-common
29
+ - 8f0898b: Updated dependency `esbuild` to `^0.24.0`.
30
+ - 11e0752: Make it possible to manually retry the scaffolder template from the step it failed
31
+ - Updated dependencies
32
+ - @backstage/backend-defaults@0.5.1
33
+ - @backstage/plugin-scaffolder-backend-module-github@0.5.1
34
+ - @backstage/plugin-scaffolder-node@0.5.0
35
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.6.0
36
+ - @backstage/plugin-auth-node@0.5.3
37
+ - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.2.1
38
+ - @backstage/plugin-permission-node@0.8.4
39
+ - @backstage/plugin-catalog-node@1.13.1
40
+ - @backstage/integration@1.15.1
41
+ - @backstage/plugin-scaffolder-backend-module-azure@0.2.1
42
+ - @backstage/catalog-client@1.7.1
43
+ - @backstage/backend-plugin-api@1.0.1
44
+ - @backstage/catalog-model@1.7.0
45
+ - @backstage/config@1.2.0
46
+ - @backstage/errors@1.2.4
47
+ - @backstage/types@1.1.1
48
+ - @backstage/plugin-bitbucket-cloud-common@0.2.24
49
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.2.1
50
+ - @backstage/plugin-permission-common@0.8.1
51
+ - @backstage/plugin-scaffolder-backend-module-bitbucket@0.3.1
52
+ - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.2.1
53
+ - @backstage/plugin-scaffolder-backend-module-gerrit@0.2.1
54
+ - @backstage/plugin-scaffolder-backend-module-gitea@0.2.1
55
+ - @backstage/plugin-scaffolder-common@1.5.6
56
+
57
+ ## 1.26.0-next.2
58
+
59
+ ### Patch Changes
60
+
61
+ - f1f0076: handle step.if: false
62
+ - Updated dependencies
63
+ - @backstage/plugin-scaffolder-backend-module-github@0.5.1-next.2
64
+ - @backstage/backend-defaults@0.5.1-next.2
65
+ - @backstage/plugin-auth-node@0.5.3-next.1
66
+ - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.2.1-next.2
67
+ - @backstage/plugin-catalog-node@1.13.1-next.1
68
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.6.0-next.2
69
+ - @backstage/integration@1.15.1-next.1
70
+ - @backstage/plugin-scaffolder-backend-module-azure@0.2.1-next.2
71
+ - @backstage/catalog-client@1.7.1-next.0
72
+ - @backstage/plugin-scaffolder-node@0.5.0-next.2
73
+ - @backstage/backend-plugin-api@1.0.1-next.1
74
+ - @backstage/catalog-model@1.7.0
75
+ - @backstage/config@1.2.0
76
+ - @backstage/errors@1.2.4
77
+ - @backstage/types@1.1.1
78
+ - @backstage/plugin-bitbucket-cloud-common@0.2.24-next.1
79
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.2.1-next.1
80
+ - @backstage/plugin-permission-common@0.8.1
81
+ - @backstage/plugin-permission-node@0.8.4-next.1
82
+ - @backstage/plugin-scaffolder-backend-module-bitbucket@0.3.1-next.2
83
+ - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.2.1-next.2
84
+ - @backstage/plugin-scaffolder-backend-module-gerrit@0.2.1-next.2
85
+ - @backstage/plugin-scaffolder-backend-module-gitea@0.2.1-next.2
86
+ - @backstage/plugin-scaffolder-common@1.5.6
87
+
3
88
  ## 1.26.0-next.1
4
89
 
5
90
  ### Patch Changes
package/README.md CHANGED
@@ -27,7 +27,7 @@ Then add the plugin to your backend, typically in `packages/backend/src/index.ts
27
27
  ```ts
28
28
  const backend = createBackend();
29
29
  // ...
30
- backend.add(import('@backstage/plugin-scaffolder-backend/alpha'));
30
+ backend.add(import('@backstage/plugin-scaffolder-backend'));
31
31
  ```
32
32
 
33
33
  #### Old backend system
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-backend__alpha",
3
- "version": "1.26.0-next.1",
3
+ "version": "1.26.0",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
@@ -0,0 +1,168 @@
1
+ 'use strict';
2
+
3
+ var backendPluginApi = require('@backstage/backend-plugin-api');
4
+ var backendCommon = require('@backstage/backend-common');
5
+ var integration = require('@backstage/integration');
6
+ var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
7
+ var alpha = require('@backstage/plugin-scaffolder-node/alpha');
8
+ var register = require('./scaffolder/actions/builtin/catalog/register.cjs.js');
9
+ var write = require('./scaffolder/actions/builtin/catalog/write.cjs.js');
10
+ var fetch = require('./scaffolder/actions/builtin/catalog/fetch.cjs.js');
11
+ var log = require('./scaffolder/actions/builtin/debug/log.cjs.js');
12
+ var wait = require('./scaffolder/actions/builtin/debug/wait.cjs.js');
13
+ var plain = require('./scaffolder/actions/builtin/fetch/plain.cjs.js');
14
+ var plainFile = require('./scaffolder/actions/builtin/fetch/plainFile.cjs.js');
15
+ var template = require('./scaffolder/actions/builtin/fetch/template.cjs.js');
16
+ var templateFile = require('./scaffolder/actions/builtin/fetch/templateFile.cjs.js');
17
+ var _delete = require('./scaffolder/actions/builtin/filesystem/delete.cjs.js');
18
+ var rename = require('./scaffolder/actions/builtin/filesystem/rename.cjs.js');
19
+ require('@backstage/plugin-scaffolder-backend-module-github');
20
+ require('@backstage/plugin-scaffolder-backend-module-azure');
21
+ require('@backstage/plugin-scaffolder-backend-module-bitbucket');
22
+ require('@backstage/plugin-scaffolder-backend-module-bitbucket-cloud');
23
+ require('@backstage/plugin-scaffolder-backend-module-bitbucket-server');
24
+ require('@backstage/plugin-scaffolder-backend-module-gerrit');
25
+ require('@backstage/plugin-scaffolder-backend-module-gitlab');
26
+ require('@backstage/plugin-scaffolder-backend-module-gitea');
27
+ require('@backstage/errors');
28
+ require('./scaffolder/tasks/DatabaseTaskStore.cjs.js');
29
+ require('zen-observable');
30
+ require('@backstage/config');
31
+ require('lodash');
32
+ require('fs-extra');
33
+ require('p-queue');
34
+ require('./scaffolder/tasks/NunjucksWorkflowRunner.cjs.js');
35
+ var router = require('./service/router.cjs.js');
36
+
37
+ const scaffolderPlugin = backendPluginApi.createBackendPlugin({
38
+ pluginId: "scaffolder",
39
+ register(env) {
40
+ const addedActions = new Array();
41
+ env.registerExtensionPoint(alpha.scaffolderActionsExtensionPoint, {
42
+ addActions(...newActions) {
43
+ addedActions.push(...newActions);
44
+ }
45
+ });
46
+ let taskBroker;
47
+ env.registerExtensionPoint(alpha.scaffolderTaskBrokerExtensionPoint, {
48
+ setTaskBroker(newTaskBroker) {
49
+ if (taskBroker) {
50
+ throw new Error("Task broker may only be set once");
51
+ }
52
+ taskBroker = newTaskBroker;
53
+ }
54
+ });
55
+ const additionalTemplateFilters = {};
56
+ const additionalTemplateGlobals = {};
57
+ env.registerExtensionPoint(alpha.scaffolderTemplatingExtensionPoint, {
58
+ addTemplateFilters(newFilters) {
59
+ Object.assign(additionalTemplateFilters, newFilters);
60
+ },
61
+ addTemplateGlobals(newGlobals) {
62
+ Object.assign(additionalTemplateGlobals, newGlobals);
63
+ }
64
+ });
65
+ const autocompleteHandlers = {};
66
+ env.registerExtensionPoint(alpha.scaffolderAutocompleteExtensionPoint, {
67
+ addAutocompleteProvider(provider) {
68
+ autocompleteHandlers[provider.id] = provider.handler;
69
+ }
70
+ });
71
+ const additionalWorkspaceProviders = {};
72
+ env.registerExtensionPoint(alpha.scaffolderWorkspaceProviderExtensionPoint, {
73
+ addProviders(provider) {
74
+ Object.assign(additionalWorkspaceProviders, provider);
75
+ }
76
+ });
77
+ env.registerInit({
78
+ deps: {
79
+ logger: backendPluginApi.coreServices.logger,
80
+ config: backendPluginApi.coreServices.rootConfig,
81
+ lifecycle: backendPluginApi.coreServices.rootLifecycle,
82
+ reader: backendPluginApi.coreServices.urlReader,
83
+ permissions: backendPluginApi.coreServices.permissions,
84
+ database: backendPluginApi.coreServices.database,
85
+ auth: backendPluginApi.coreServices.auth,
86
+ discovery: backendPluginApi.coreServices.discovery,
87
+ httpRouter: backendPluginApi.coreServices.httpRouter,
88
+ httpAuth: backendPluginApi.coreServices.httpAuth,
89
+ catalogClient: alpha$1.catalogServiceRef
90
+ },
91
+ async init({
92
+ logger,
93
+ config,
94
+ lifecycle,
95
+ reader,
96
+ database,
97
+ auth,
98
+ discovery,
99
+ httpRouter,
100
+ httpAuth,
101
+ catalogClient,
102
+ permissions
103
+ }) {
104
+ const log$1 = backendCommon.loggerToWinstonLogger(logger);
105
+ const integrations = integration.ScmIntegrations.fromConfig(config);
106
+ const actions = [
107
+ // actions provided from other modules
108
+ ...addedActions,
109
+ // built-in actions for the scaffolder
110
+ plain.createFetchPlainAction({
111
+ reader,
112
+ integrations
113
+ }),
114
+ plainFile.createFetchPlainFileAction({
115
+ reader,
116
+ integrations
117
+ }),
118
+ template.createFetchTemplateAction({
119
+ integrations,
120
+ reader,
121
+ additionalTemplateFilters,
122
+ additionalTemplateGlobals
123
+ }),
124
+ templateFile.createFetchTemplateFileAction({
125
+ integrations,
126
+ reader,
127
+ additionalTemplateFilters,
128
+ additionalTemplateGlobals
129
+ }),
130
+ log.createDebugLogAction(),
131
+ wait.createWaitAction(),
132
+ // todo(blam): maybe these should be a -catalog module?
133
+ register.createCatalogRegisterAction({ catalogClient, integrations, auth }),
134
+ fetch.createFetchCatalogEntityAction({ catalogClient, auth }),
135
+ write.createCatalogWriteAction(),
136
+ _delete.createFilesystemDeleteAction(),
137
+ rename.createFilesystemRenameAction()
138
+ ];
139
+ const actionIds = actions.map((action) => action.id).join(", ");
140
+ log$1.info(
141
+ `Starting scaffolder with the following actions enabled ${actionIds}`
142
+ );
143
+ const router$1 = await router.createRouter({
144
+ logger: log$1,
145
+ config,
146
+ database,
147
+ catalogClient,
148
+ reader,
149
+ lifecycle,
150
+ actions,
151
+ taskBroker,
152
+ additionalTemplateFilters,
153
+ additionalTemplateGlobals,
154
+ auth,
155
+ httpAuth,
156
+ discovery,
157
+ permissions,
158
+ autocompleteHandlers,
159
+ additionalWorkspaceProviders
160
+ });
161
+ httpRouter.use(router$1);
162
+ }
163
+ });
164
+ }
165
+ });
166
+
167
+ exports.scaffolderPlugin = scaffolderPlugin;
168
+ //# sourceMappingURL=ScaffolderPlugin.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ScaffolderPlugin.cjs.js","sources":["../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 {\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 TaskBroker,\n TemplateAction,\n TemplateFilter,\n TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport {\n AutocompleteHandler,\n scaffolderActionsExtensionPoint,\n scaffolderAutocompleteExtensionPoint,\n scaffolderTaskBrokerExtensionPoint,\n scaffolderTemplatingExtensionPoint,\n scaffolderWorkspaceProviderExtensionPoint,\n WorkspaceProvider,\n} from '@backstage/plugin-scaffolder-node/alpha';\nimport {\n createCatalogRegisterAction,\n createCatalogWriteAction,\n createDebugLogAction,\n createFetchCatalogEntityAction,\n createFetchPlainAction,\n createFetchPlainFileAction,\n createFetchTemplateAction,\n createFetchTemplateFileAction,\n createFilesystemDeleteAction,\n createFilesystemRenameAction,\n createWaitAction,\n} from './scaffolder';\nimport { createRouter } from './service/router';\n\n/**\n * Scaffolder plugin\n *\n * @public\n */\nexport const scaffolderPlugin = createBackendPlugin({\n pluginId: 'scaffolder',\n register(env) {\n const addedActions = new Array<TemplateAction<any, any>>();\n env.registerExtensionPoint(scaffolderActionsExtensionPoint, {\n addActions(...newActions: TemplateAction<any>[]) {\n addedActions.push(...newActions);\n },\n });\n\n let taskBroker: TaskBroker | undefined;\n env.registerExtensionPoint(scaffolderTaskBrokerExtensionPoint, {\n setTaskBroker(newTaskBroker) {\n if (taskBroker) {\n throw new Error('Task broker may only be set once');\n }\n taskBroker = newTaskBroker;\n },\n });\n\n const additionalTemplateFilters: Record<string, TemplateFilter> = {};\n const additionalTemplateGlobals: Record<string, TemplateGlobal> = {};\n env.registerExtensionPoint(scaffolderTemplatingExtensionPoint, {\n addTemplateFilters(newFilters) {\n Object.assign(additionalTemplateFilters, newFilters);\n },\n addTemplateGlobals(newGlobals) {\n Object.assign(additionalTemplateGlobals, newGlobals);\n },\n });\n\n const autocompleteHandlers: Record<string, AutocompleteHandler> = {};\n env.registerExtensionPoint(scaffolderAutocompleteExtensionPoint, {\n addAutocompleteProvider(provider) {\n autocompleteHandlers[provider.id] = provider.handler;\n },\n });\n\n const additionalWorkspaceProviders: Record<string, WorkspaceProvider> = {};\n env.registerExtensionPoint(scaffolderWorkspaceProviderExtensionPoint, {\n addProviders(provider) {\n Object.assign(additionalWorkspaceProviders, provider);\n },\n });\n\n env.registerInit({\n deps: {\n logger: coreServices.logger,\n config: coreServices.rootConfig,\n lifecycle: coreServices.rootLifecycle,\n reader: coreServices.urlReader,\n permissions: coreServices.permissions,\n database: coreServices.database,\n auth: coreServices.auth,\n discovery: coreServices.discovery,\n httpRouter: coreServices.httpRouter,\n httpAuth: coreServices.httpAuth,\n catalogClient: catalogServiceRef,\n },\n async init({\n logger,\n config,\n lifecycle,\n reader,\n database,\n auth,\n discovery,\n httpRouter,\n httpAuth,\n catalogClient,\n permissions,\n }) {\n const log = loggerToWinstonLogger(logger);\n const integrations = ScmIntegrations.fromConfig(config);\n\n const actions = [\n // actions provided from other modules\n ...addedActions,\n\n // built-in actions for the scaffolder\n createFetchPlainAction({\n reader,\n integrations,\n }),\n createFetchPlainFileAction({\n reader,\n integrations,\n }),\n createFetchTemplateAction({\n integrations,\n reader,\n additionalTemplateFilters,\n additionalTemplateGlobals,\n }),\n createFetchTemplateFileAction({\n integrations,\n reader,\n additionalTemplateFilters,\n additionalTemplateGlobals,\n }),\n createDebugLogAction(),\n createWaitAction(),\n // todo(blam): maybe these should be a -catalog module?\n createCatalogRegisterAction({ catalogClient, integrations, auth }),\n createFetchCatalogEntityAction({ catalogClient, auth }),\n createCatalogWriteAction(),\n createFilesystemDeleteAction(),\n createFilesystemRenameAction(),\n ];\n\n const actionIds = actions.map(action => action.id).join(', ');\n\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 lifecycle,\n actions,\n taskBroker,\n additionalTemplateFilters,\n additionalTemplateGlobals,\n auth,\n httpAuth,\n discovery,\n permissions,\n autocompleteHandlers,\n additionalWorkspaceProviders,\n });\n httpRouter.use(router);\n },\n });\n },\n});\n"],"names":["createBackendPlugin","scaffolderActionsExtensionPoint","scaffolderTaskBrokerExtensionPoint","scaffolderTemplatingExtensionPoint","scaffolderAutocompleteExtensionPoint","scaffolderWorkspaceProviderExtensionPoint","coreServices","catalogServiceRef","log","loggerToWinstonLogger","ScmIntegrations","createFetchPlainAction","createFetchPlainFileAction","createFetchTemplateAction","createFetchTemplateFileAction","createDebugLogAction","createWaitAction","createCatalogRegisterAction","createFetchCatalogEntityAction","createCatalogWriteAction","createFilesystemDeleteAction","createFilesystemRenameAction","router","createRouter"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DO,MAAM,mBAAmBA,oCAAoB,CAAA;AAAA,EAClD,QAAU,EAAA,YAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,YAAA,GAAe,IAAI,KAAgC,EAAA,CAAA;AACzD,IAAA,GAAA,CAAI,uBAAuBC,qCAAiC,EAAA;AAAA,MAC1D,cAAc,UAAmC,EAAA;AAC/C,QAAa,YAAA,CAAA,IAAA,CAAK,GAAG,UAAU,CAAA,CAAA;AAAA,OACjC;AAAA,KACD,CAAA,CAAA;AAED,IAAI,IAAA,UAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,wCAAoC,EAAA;AAAA,MAC7D,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAM,MAAA,IAAI,MAAM,kCAAkC,CAAA,CAAA;AAAA,SACpD;AACA,QAAa,UAAA,GAAA,aAAA,CAAA;AAAA,OACf;AAAA,KACD,CAAA,CAAA;AAED,IAAA,MAAM,4BAA4D,EAAC,CAAA;AACnE,IAAA,MAAM,4BAA4D,EAAC,CAAA;AACnE,IAAA,GAAA,CAAI,uBAAuBC,wCAAoC,EAAA;AAAA,MAC7D,mBAAmB,UAAY,EAAA;AAC7B,QAAO,MAAA,CAAA,MAAA,CAAO,2BAA2B,UAAU,CAAA,CAAA;AAAA,OACrD;AAAA,MACA,mBAAmB,UAAY,EAAA;AAC7B,QAAO,MAAA,CAAA,MAAA,CAAO,2BAA2B,UAAU,CAAA,CAAA;AAAA,OACrD;AAAA,KACD,CAAA,CAAA;AAED,IAAA,MAAM,uBAA4D,EAAC,CAAA;AACnE,IAAA,GAAA,CAAI,uBAAuBC,0CAAsC,EAAA;AAAA,MAC/D,wBAAwB,QAAU,EAAA;AAChC,QAAqB,oBAAA,CAAA,QAAA,CAAS,EAAE,CAAA,GAAI,QAAS,CAAA,OAAA,CAAA;AAAA,OAC/C;AAAA,KACD,CAAA,CAAA;AAED,IAAA,MAAM,+BAAkE,EAAC,CAAA;AACzE,IAAA,GAAA,CAAI,uBAAuBC,+CAA2C,EAAA;AAAA,MACpE,aAAa,QAAU,EAAA;AACrB,QAAO,MAAA,CAAA,MAAA,CAAO,8BAA8B,QAAQ,CAAA,CAAA;AAAA,OACtD;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,aAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,SAAA;AAAA,QACrB,aAAaA,6BAAa,CAAA,WAAA;AAAA,QAC1B,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,aAAe,EAAAC,yBAAA;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA,QAAA;AAAA,QACA,aAAA;AAAA,QACA,WAAA;AAAA,OACC,EAAA;AACD,QAAM,MAAAC,KAAA,GAAMC,oCAAsB,MAAM,CAAA,CAAA;AACxC,QAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAEtD,QAAA,MAAM,OAAU,GAAA;AAAA;AAAA,UAEd,GAAG,YAAA;AAAA;AAAA,UAGHC,4BAAuB,CAAA;AAAA,YACrB,MAAA;AAAA,YACA,YAAA;AAAA,WACD,CAAA;AAAA,UACDC,oCAA2B,CAAA;AAAA,YACzB,MAAA;AAAA,YACA,YAAA;AAAA,WACD,CAAA;AAAA,UACDC,kCAA0B,CAAA;AAAA,YACxB,YAAA;AAAA,YACA,MAAA;AAAA,YACA,yBAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,0CAA8B,CAAA;AAAA,YAC5B,YAAA;AAAA,YACA,MAAA;AAAA,YACA,yBAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,wBAAqB,EAAA;AAAA,UACrBC,qBAAiB,EAAA;AAAA;AAAA,UAEjBC,oCAA4B,CAAA,EAAE,aAAe,EAAA,YAAA,EAAc,MAAM,CAAA;AAAA,UACjEC,oCAA+B,CAAA,EAAE,aAAe,EAAA,IAAA,EAAM,CAAA;AAAA,UACtDC,8BAAyB,EAAA;AAAA,UACzBC,oCAA6B,EAAA;AAAA,UAC7BC,mCAA6B,EAAA;AAAA,SAC/B,CAAA;AAEA,QAAM,MAAA,SAAA,GAAY,QAAQ,GAAI,CAAA,CAAA,MAAA,KAAU,OAAO,EAAE,CAAA,CAAE,KAAK,IAAI,CAAA,CAAA;AAE5D,QAAIb,KAAA,CAAA,IAAA;AAAA,UACF,0DAA0D,SAAS,CAAA,CAAA;AAAA,SACrE,CAAA;AAEA,QAAM,MAAAc,QAAA,GAAS,MAAMC,mBAAa,CAAA;AAAA,UAChC,MAAQ,EAAAf,KAAA;AAAA,UACR,MAAA;AAAA,UACA,QAAA;AAAA,UACA,aAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,OAAA;AAAA,UACA,UAAA;AAAA,UACA,yBAAA;AAAA,UACA,yBAAA;AAAA,UACA,IAAA;AAAA,UACA,QAAA;AAAA,UACA,SAAA;AAAA,UACA,WAAA;AAAA,UACA,oBAAA;AAAA,UACA,4BAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAA,UAAA,CAAW,IAAIc,QAAM,CAAA,CAAA;AAAA,OACvB;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
package/dist/alpha.cjs.js CHANGED
@@ -2,203 +2,14 @@
2
2
 
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
- var alpha = require('@backstage/plugin-scaffolder-common/alpha');
6
- var pluginPermissionNode = require('@backstage/plugin-permission-node');
7
- var router = require('./cjs/router-BqZK9yax.cjs.js');
8
- var backendPluginApi = require('@backstage/backend-plugin-api');
9
- var backendCommon = require('@backstage/backend-common');
10
- var integration = require('@backstage/integration');
11
- var alpha$2 = require('@backstage/plugin-catalog-node/alpha');
12
- var alpha$1 = require('@backstage/plugin-scaffolder-node/alpha');
13
- require('@backstage/plugin-scaffolder-backend-module-github');
14
- require('@backstage/plugin-scaffolder-backend-module-azure');
15
- require('@backstage/plugin-scaffolder-backend-module-bitbucket');
16
- require('@backstage/plugin-scaffolder-backend-module-bitbucket-cloud');
17
- require('@backstage/plugin-scaffolder-backend-module-bitbucket-server');
18
- require('@backstage/plugin-scaffolder-backend-module-gerrit');
19
- require('@backstage/plugin-scaffolder-backend-module-gitlab');
20
- require('@backstage/plugin-scaffolder-backend-module-gitea');
21
- require('@backstage/errors');
22
- require('zen-observable');
23
- require('@backstage/config');
24
- require('lodash');
25
- require('fs-extra');
26
- require('p-queue');
27
- require('@backstage/catalog-model');
28
- require('@backstage/plugin-scaffolder-common');
29
- require('express');
30
- require('express-promise-router');
31
- require('jsonschema');
32
- require('zod');
33
- require('@backstage/plugin-scaffolder-node');
34
- require('yaml');
35
- require('path');
36
- require('fs');
37
- require('luxon');
38
- require('globby');
39
- require('isbinaryfile');
40
- require('isolated-vm');
41
- require('lodash/get');
42
- require('uuid');
43
- require('os');
44
- require('winston');
45
- require('nunjucks');
46
- require('stream');
47
- require('@opentelemetry/api');
48
- require('prom-client');
49
- require('@backstage/plugin-permission-common');
50
- require('winston-transport');
51
- require('triple-beam');
52
- require('url');
5
+ var ScaffolderPlugin = require('./ScaffolderPlugin.cjs.js');
6
+ var conditionExports = require('./service/conditionExports.cjs.js');
53
7
 
54
- const templateConditionExports = pluginPermissionNode.createConditionExports({
55
- pluginId: "scaffolder",
56
- resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
57
- rules: router.scaffolderTemplateRules
58
- });
59
- const actionsConditionExports = pluginPermissionNode.createConditionExports({
60
- pluginId: "scaffolder",
61
- resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_ACTION,
62
- rules: router.scaffolderActionRules
63
- });
64
- const createScaffolderTemplateConditionalDecision = templateConditionExports.createConditionalDecision;
65
- const scaffolderTemplateConditions = templateConditionExports.conditions;
66
- const createScaffolderActionConditionalDecision = actionsConditionExports.createConditionalDecision;
67
- const scaffolderActionConditions = actionsConditionExports.conditions;
8
+ const _feature = ScaffolderPlugin.scaffolderPlugin;
68
9
 
69
- const scaffolderPlugin = backendPluginApi.createBackendPlugin({
70
- pluginId: "scaffolder",
71
- register(env) {
72
- const addedActions = new Array();
73
- env.registerExtensionPoint(alpha$1.scaffolderActionsExtensionPoint, {
74
- addActions(...newActions) {
75
- addedActions.push(...newActions);
76
- }
77
- });
78
- let taskBroker;
79
- env.registerExtensionPoint(alpha$1.scaffolderTaskBrokerExtensionPoint, {
80
- setTaskBroker(newTaskBroker) {
81
- if (taskBroker) {
82
- throw new Error("Task broker may only be set once");
83
- }
84
- taskBroker = newTaskBroker;
85
- }
86
- });
87
- const additionalTemplateFilters = {};
88
- const additionalTemplateGlobals = {};
89
- env.registerExtensionPoint(alpha$1.scaffolderTemplatingExtensionPoint, {
90
- addTemplateFilters(newFilters) {
91
- Object.assign(additionalTemplateFilters, newFilters);
92
- },
93
- addTemplateGlobals(newGlobals) {
94
- Object.assign(additionalTemplateGlobals, newGlobals);
95
- }
96
- });
97
- const autocompleteHandlers = {};
98
- env.registerExtensionPoint(alpha$1.scaffolderAutocompleteExtensionPoint, {
99
- addAutocompleteProvider(provider) {
100
- autocompleteHandlers[provider.id] = provider.handler;
101
- }
102
- });
103
- const additionalWorkspaceProviders = {};
104
- env.registerExtensionPoint(alpha$1.scaffolderWorkspaceProviderExtensionPoint, {
105
- addProviders(provider) {
106
- Object.assign(additionalWorkspaceProviders, provider);
107
- }
108
- });
109
- env.registerInit({
110
- deps: {
111
- logger: backendPluginApi.coreServices.logger,
112
- config: backendPluginApi.coreServices.rootConfig,
113
- lifecycle: backendPluginApi.coreServices.rootLifecycle,
114
- reader: backendPluginApi.coreServices.urlReader,
115
- permissions: backendPluginApi.coreServices.permissions,
116
- database: backendPluginApi.coreServices.database,
117
- auth: backendPluginApi.coreServices.auth,
118
- discovery: backendPluginApi.coreServices.discovery,
119
- httpRouter: backendPluginApi.coreServices.httpRouter,
120
- httpAuth: backendPluginApi.coreServices.httpAuth,
121
- catalogClient: alpha$2.catalogServiceRef
122
- },
123
- async init({
124
- logger,
125
- config,
126
- lifecycle,
127
- reader,
128
- database,
129
- auth,
130
- discovery,
131
- httpRouter,
132
- httpAuth,
133
- catalogClient,
134
- permissions
135
- }) {
136
- const log = backendCommon.loggerToWinstonLogger(logger);
137
- const integrations = integration.ScmIntegrations.fromConfig(config);
138
- const actions = [
139
- // actions provided from other modules
140
- ...addedActions,
141
- // built-in actions for the scaffolder
142
- router.createFetchPlainAction({
143
- reader,
144
- integrations
145
- }),
146
- router.createFetchPlainFileAction({
147
- reader,
148
- integrations
149
- }),
150
- router.createFetchTemplateAction({
151
- integrations,
152
- reader,
153
- additionalTemplateFilters,
154
- additionalTemplateGlobals
155
- }),
156
- router.createFetchTemplateFileAction({
157
- integrations,
158
- reader,
159
- additionalTemplateFilters,
160
- additionalTemplateGlobals
161
- }),
162
- router.createDebugLogAction(),
163
- router.createWaitAction(),
164
- // todo(blam): maybe these should be a -catalog module?
165
- router.createCatalogRegisterAction({ catalogClient, integrations, auth }),
166
- router.createFetchCatalogEntityAction({ catalogClient, auth }),
167
- router.createCatalogWriteAction(),
168
- router.createFilesystemDeleteAction(),
169
- router.createFilesystemRenameAction()
170
- ];
171
- const actionIds = actions.map((action) => action.id).join(", ");
172
- log.info(
173
- `Starting scaffolder with the following actions enabled ${actionIds}`
174
- );
175
- const router$1 = await router.createRouter({
176
- logger: log,
177
- config,
178
- database,
179
- catalogClient,
180
- reader,
181
- lifecycle,
182
- actions,
183
- taskBroker,
184
- additionalTemplateFilters,
185
- additionalTemplateGlobals,
186
- auth,
187
- httpAuth,
188
- discovery,
189
- permissions,
190
- autocompleteHandlers,
191
- additionalWorkspaceProviders
192
- });
193
- httpRouter.use(router$1);
194
- }
195
- });
196
- }
197
- });
198
-
199
- exports.createScaffolderActionConditionalDecision = createScaffolderActionConditionalDecision;
200
- exports.createScaffolderTemplateConditionalDecision = createScaffolderTemplateConditionalDecision;
201
- exports.default = scaffolderPlugin;
202
- exports.scaffolderActionConditions = scaffolderActionConditions;
203
- exports.scaffolderTemplateConditions = scaffolderTemplateConditions;
10
+ exports.createScaffolderActionConditionalDecision = conditionExports.createScaffolderActionConditionalDecision;
11
+ exports.createScaffolderTemplateConditionalDecision = conditionExports.createScaffolderTemplateConditionalDecision;
12
+ exports.scaffolderActionConditions = conditionExports.scaffolderActionConditions;
13
+ exports.scaffolderTemplateConditions = conditionExports.scaffolderTemplateConditions;
14
+ exports.default = _feature;
204
15
  //# sourceMappingURL=alpha.cjs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"alpha.cjs.js","sources":["../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 {\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 TaskBroker,\n TemplateAction,\n TemplateFilter,\n TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport {\n AutocompleteHandler,\n scaffolderActionsExtensionPoint,\n scaffolderAutocompleteExtensionPoint,\n scaffolderTaskBrokerExtensionPoint,\n scaffolderTemplatingExtensionPoint,\n scaffolderWorkspaceProviderExtensionPoint,\n WorkspaceProvider,\n} from '@backstage/plugin-scaffolder-node/alpha';\nimport {\n createCatalogRegisterAction,\n createCatalogWriteAction,\n createDebugLogAction,\n createFetchCatalogEntityAction,\n createFetchPlainAction,\n createFetchPlainFileAction,\n createFetchTemplateAction,\n createFetchTemplateFileAction,\n createFilesystemDeleteAction,\n createFilesystemRenameAction,\n createWaitAction,\n} from './scaffolder';\nimport { createRouter } from './service/router';\n\n/**\n * Scaffolder plugin\n *\n * @alpha\n */\nexport const scaffolderPlugin = createBackendPlugin({\n pluginId: 'scaffolder',\n register(env) {\n const addedActions = new Array<TemplateAction<any, any>>();\n env.registerExtensionPoint(scaffolderActionsExtensionPoint, {\n addActions(...newActions: TemplateAction<any>[]) {\n addedActions.push(...newActions);\n },\n });\n\n let taskBroker: TaskBroker | undefined;\n env.registerExtensionPoint(scaffolderTaskBrokerExtensionPoint, {\n setTaskBroker(newTaskBroker) {\n if (taskBroker) {\n throw new Error('Task broker may only be set once');\n }\n taskBroker = newTaskBroker;\n },\n });\n\n const additionalTemplateFilters: Record<string, TemplateFilter> = {};\n const additionalTemplateGlobals: Record<string, TemplateGlobal> = {};\n env.registerExtensionPoint(scaffolderTemplatingExtensionPoint, {\n addTemplateFilters(newFilters) {\n Object.assign(additionalTemplateFilters, newFilters);\n },\n addTemplateGlobals(newGlobals) {\n Object.assign(additionalTemplateGlobals, newGlobals);\n },\n });\n\n const autocompleteHandlers: Record<string, AutocompleteHandler> = {};\n env.registerExtensionPoint(scaffolderAutocompleteExtensionPoint, {\n addAutocompleteProvider(provider) {\n autocompleteHandlers[provider.id] = provider.handler;\n },\n });\n\n const additionalWorkspaceProviders: Record<string, WorkspaceProvider> = {};\n env.registerExtensionPoint(scaffolderWorkspaceProviderExtensionPoint, {\n addProviders(provider) {\n Object.assign(additionalWorkspaceProviders, provider);\n },\n });\n\n env.registerInit({\n deps: {\n logger: coreServices.logger,\n config: coreServices.rootConfig,\n lifecycle: coreServices.rootLifecycle,\n reader: coreServices.urlReader,\n permissions: coreServices.permissions,\n database: coreServices.database,\n auth: coreServices.auth,\n discovery: coreServices.discovery,\n httpRouter: coreServices.httpRouter,\n httpAuth: coreServices.httpAuth,\n catalogClient: catalogServiceRef,\n },\n async init({\n logger,\n config,\n lifecycle,\n reader,\n database,\n auth,\n discovery,\n httpRouter,\n httpAuth,\n catalogClient,\n permissions,\n }) {\n const log = loggerToWinstonLogger(logger);\n const integrations = ScmIntegrations.fromConfig(config);\n\n const actions = [\n // actions provided from other modules\n ...addedActions,\n\n // built-in actions for the scaffolder\n createFetchPlainAction({\n reader,\n integrations,\n }),\n createFetchPlainFileAction({\n reader,\n integrations,\n }),\n createFetchTemplateAction({\n integrations,\n reader,\n additionalTemplateFilters,\n additionalTemplateGlobals,\n }),\n createFetchTemplateFileAction({\n integrations,\n reader,\n additionalTemplateFilters,\n additionalTemplateGlobals,\n }),\n createDebugLogAction(),\n createWaitAction(),\n // todo(blam): maybe these should be a -catalog module?\n createCatalogRegisterAction({ catalogClient, integrations, auth }),\n createFetchCatalogEntityAction({ catalogClient, auth }),\n createCatalogWriteAction(),\n createFilesystemDeleteAction(),\n createFilesystemRenameAction(),\n ];\n\n const actionIds = actions.map(action => action.id).join(', ');\n\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 lifecycle,\n actions,\n taskBroker,\n additionalTemplateFilters,\n additionalTemplateGlobals,\n auth,\n httpAuth,\n discovery,\n permissions,\n autocompleteHandlers,\n additionalWorkspaceProviders,\n });\n httpRouter.use(router);\n },\n });\n },\n});\n"],"names":["createConditionExports","RESOURCE_TYPE_SCAFFOLDER_TEMPLATE","scaffolderTemplateRules","RESOURCE_TYPE_SCAFFOLDER_ACTION","scaffolderActionRules","createBackendPlugin","scaffolderActionsExtensionPoint","scaffolderTaskBrokerExtensionPoint","scaffolderTemplatingExtensionPoint","scaffolderAutocompleteExtensionPoint","scaffolderWorkspaceProviderExtensionPoint","coreServices","catalogServiceRef","loggerToWinstonLogger","ScmIntegrations","createFetchPlainAction","createFetchPlainFileAction","createFetchTemplateAction","createFetchTemplateFileAction","createDebugLogAction","createWaitAction","createCatalogRegisterAction","createFetchCatalogEntityAction","createCatalogWriteAction","createFilesystemDeleteAction","createFilesystemRenameAction","router","createRouter"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBA,MAAM,2BAA2BA,2CAAuB,CAAA;AAAA,EACtD,QAAU,EAAA,YAAA;AAAA,EACV,YAAc,EAAAC,uCAAA;AAAA,EACd,KAAO,EAAAC,8BAAA;AACT,CAAC,CAAA,CAAA;AAED,MAAM,0BAA0BF,2CAAuB,CAAA;AAAA,EACrD,QAAU,EAAA,YAAA;AAAA,EACV,YAAc,EAAAG,qCAAA;AAAA,EACd,KAAO,EAAAC,4BAAA;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;;ACjC3D,MAAM,mBAAmBC,oCAAoB,CAAA;AAAA,EAClD,QAAU,EAAA,YAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,YAAA,GAAe,IAAI,KAAgC,EAAA,CAAA;AACzD,IAAA,GAAA,CAAI,uBAAuBC,uCAAiC,EAAA;AAAA,MAC1D,cAAc,UAAmC,EAAA;AAC/C,QAAa,YAAA,CAAA,IAAA,CAAK,GAAG,UAAU,CAAA,CAAA;AAAA,OACjC;AAAA,KACD,CAAA,CAAA;AAED,IAAI,IAAA,UAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,0CAAoC,EAAA;AAAA,MAC7D,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAM,MAAA,IAAI,MAAM,kCAAkC,CAAA,CAAA;AAAA,SACpD;AACA,QAAa,UAAA,GAAA,aAAA,CAAA;AAAA,OACf;AAAA,KACD,CAAA,CAAA;AAED,IAAA,MAAM,4BAA4D,EAAC,CAAA;AACnE,IAAA,MAAM,4BAA4D,EAAC,CAAA;AACnE,IAAA,GAAA,CAAI,uBAAuBC,0CAAoC,EAAA;AAAA,MAC7D,mBAAmB,UAAY,EAAA;AAC7B,QAAO,MAAA,CAAA,MAAA,CAAO,2BAA2B,UAAU,CAAA,CAAA;AAAA,OACrD;AAAA,MACA,mBAAmB,UAAY,EAAA;AAC7B,QAAO,MAAA,CAAA,MAAA,CAAO,2BAA2B,UAAU,CAAA,CAAA;AAAA,OACrD;AAAA,KACD,CAAA,CAAA;AAED,IAAA,MAAM,uBAA4D,EAAC,CAAA;AACnE,IAAA,GAAA,CAAI,uBAAuBC,4CAAsC,EAAA;AAAA,MAC/D,wBAAwB,QAAU,EAAA;AAChC,QAAqB,oBAAA,CAAA,QAAA,CAAS,EAAE,CAAA,GAAI,QAAS,CAAA,OAAA,CAAA;AAAA,OAC/C;AAAA,KACD,CAAA,CAAA;AAED,IAAA,MAAM,+BAAkE,EAAC,CAAA;AACzE,IAAA,GAAA,CAAI,uBAAuBC,iDAA2C,EAAA;AAAA,MACpE,aAAa,QAAU,EAAA;AACrB,QAAO,MAAA,CAAA,MAAA,CAAO,8BAA8B,QAAQ,CAAA,CAAA;AAAA,OACtD;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,aAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,SAAA;AAAA,QACrB,aAAaA,6BAAa,CAAA,WAAA;AAAA,QAC1B,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,aAAe,EAAAC,yBAAA;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA,QAAA;AAAA,QACA,aAAA;AAAA,QACA,WAAA;AAAA,OACC,EAAA;AACD,QAAM,MAAA,GAAA,GAAMC,oCAAsB,MAAM,CAAA,CAAA;AACxC,QAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAEtD,QAAA,MAAM,OAAU,GAAA;AAAA;AAAA,UAEd,GAAG,YAAA;AAAA;AAAA,UAGHC,6BAAuB,CAAA;AAAA,YACrB,MAAA;AAAA,YACA,YAAA;AAAA,WACD,CAAA;AAAA,UACDC,iCAA2B,CAAA;AAAA,YACzB,MAAA;AAAA,YACA,YAAA;AAAA,WACD,CAAA;AAAA,UACDC,gCAA0B,CAAA;AAAA,YACxB,YAAA;AAAA,YACA,MAAA;AAAA,YACA,yBAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,oCAA8B,CAAA;AAAA,YAC5B,YAAA;AAAA,YACA,MAAA;AAAA,YACA,yBAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,2BAAqB,EAAA;AAAA,UACrBC,uBAAiB,EAAA;AAAA;AAAA,UAEjBC,kCAA4B,CAAA,EAAE,aAAe,EAAA,YAAA,EAAc,MAAM,CAAA;AAAA,UACjEC,qCAA+B,CAAA,EAAE,aAAe,EAAA,IAAA,EAAM,CAAA;AAAA,UACtDC,+BAAyB,EAAA;AAAA,UACzBC,mCAA6B,EAAA;AAAA,UAC7BC,mCAA6B,EAAA;AAAA,SAC/B,CAAA;AAEA,QAAM,MAAA,SAAA,GAAY,QAAQ,GAAI,CAAA,CAAA,MAAA,KAAU,OAAO,EAAE,CAAA,CAAE,KAAK,IAAI,CAAA,CAAA;AAE5D,QAAI,GAAA,CAAA,IAAA;AAAA,UACF,0DAA0D,SAAS,CAAA,CAAA;AAAA,SACrE,CAAA;AAEA,QAAM,MAAAC,QAAA,GAAS,MAAMC,mBAAa,CAAA;AAAA,UAChC,MAAQ,EAAA,GAAA;AAAA,UACR,MAAA;AAAA,UACA,QAAA;AAAA,UACA,aAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,OAAA;AAAA,UACA,UAAA;AAAA,UACA,yBAAA;AAAA,UACA,yBAAA;AAAA,UACA,IAAA;AAAA,UACA,QAAA;AAAA,UACA,SAAA;AAAA,UACA,WAAA;AAAA,UACA,oBAAA;AAAA,UACA,4BAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAA,UAAA,CAAW,IAAID,QAAM,CAAA,CAAA;AAAA,OACvB;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;;;"}
1
+ {"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2020 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 */\nimport { scaffolderPlugin } from './ScaffolderPlugin';\n\n/** @alpha */\nconst _feature = scaffolderPlugin;\nexport default _feature;\n\nexport * from './service';\n"],"names":["scaffolderPlugin"],"mappings":";;;;;;;AAkBA,MAAM,QAAW,GAAAA;;;;;;;;"}
package/dist/alpha.d.ts CHANGED
@@ -1,8 +1,8 @@
1
+ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
1
2
  import * as _backstage_types from '@backstage/types';
2
3
  import * as _backstage_plugin_permission_node from '@backstage/plugin-permission-node';
3
4
  import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
4
5
  import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
5
- import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
6
6
 
7
7
  /**
8
8
  * `createScaffolderTemplateConditionalDecision` can be used when authoring policies to
@@ -89,11 +89,7 @@ declare const scaffolderActionConditions: _backstage_plugin_permission_node.Cond
89
89
  }>;
90
90
  }>;
91
91
 
92
- /**
93
- * Scaffolder plugin
94
- *
95
- * @alpha
96
- */
97
- declare const scaffolderPlugin: _backstage_backend_plugin_api.BackendFeature;
92
+ /** @alpha */
93
+ declare const _feature: _backstage_backend_plugin_api.BackendFeature;
98
94
 
99
- export { createScaffolderActionConditionalDecision, createScaffolderTemplateConditionalDecision, scaffolderPlugin as default, scaffolderActionConditions, scaffolderTemplateConditions };
95
+ export { createScaffolderActionConditionalDecision, createScaffolderTemplateConditionalDecision, _feature as default, scaffolderActionConditions, scaffolderTemplateConditions };
@@ -0,0 +1,15 @@
1
+ 'use strict';
2
+
3
+ var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
4
+ var pluginCatalogBackendModuleScaffolderEntityModel = require('@backstage/plugin-catalog-backend-module-scaffolder-entity-model');
5
+
6
+ const createTemplateAction = pluginScaffolderNode.createTemplateAction;
7
+ const executeShellCommand = pluginScaffolderNode.executeShellCommand;
8
+ const fetchContents = pluginScaffolderNode.fetchContents;
9
+ const ScaffolderEntitiesProcessor = pluginCatalogBackendModuleScaffolderEntityModel.ScaffolderEntitiesProcessor;
10
+
11
+ exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
12
+ exports.createTemplateAction = createTemplateAction;
13
+ exports.executeShellCommand = executeShellCommand;
14
+ exports.fetchContents = fetchContents;
15
+ //# sourceMappingURL=deprecated.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deprecated.cjs.js","sources":["../src/deprecated.ts"],"sourcesContent":["/*\n * Copyright 2023 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 ActionContext as ActionContextNode,\n createTemplateAction as createTemplateActionNode,\n TaskSecrets as TaskSecretsNode,\n TemplateAction as TemplateActionNode,\n executeShellCommand as executeShellCommandNode,\n ExecuteShellCommandOptions as ExecuteShellCommandOptionsNode,\n fetchContents as fetchContentsNode,\n} from '@backstage/plugin-scaffolder-node';\nimport { JsonObject } from '@backstage/types';\nimport { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessorModule } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';\n\n/**\n * @public\n * @deprecated Import from {@link @backstage/plugin-scaffolder-node#ActionContext} instead\n */\nexport type ActionContext<TInput extends JsonObject> =\n ActionContextNode<TInput>;\n\n/**\n * @public\n * @deprecated Use `createTemplateAction` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const createTemplateAction = createTemplateActionNode;\n\n/**\n * @public\n * @deprecated Use `TaskSecrets` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type TaskSecrets = TaskSecretsNode;\n\n/**\n * @public\n * @deprecated Use `TemplateAction` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type TemplateAction<TInput extends JsonObject> =\n TemplateActionNode<TInput>;\n\n/**\n * Options for {@link executeShellCommand}.\n *\n * @public\n * @deprecated Use `ExecuteShellCommandOptions` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type RunCommandOptions = ExecuteShellCommandOptionsNode;\n\n/**\n * Run a command in a sub-process, normally a shell command.\n *\n * @public\n * @deprecated Use `executeShellCommand` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const executeShellCommand = executeShellCommandNode;\n\n/**\n * A helper function that reads the contents of a directory from the given URL.\n * Can be used in your own actions, and also used behind fetch:template and fetch:plain\n *\n * @public\n * @deprecated Use `fetchContents` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const fetchContents = fetchContentsNode;\n\n/**\n * Adds support for scaffolder specific entity kinds to the catalog.\n *\n * @public\n * @deprecated Import from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead\n */\nexport const ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessorModule;\n"],"names":["createTemplateActionNode","executeShellCommandNode","fetchContentsNode","ScaffolderEntitiesProcessorModule"],"mappings":";;;;;AAuCO,MAAM,oBAAuB,GAAAA,0CAAA;AA6B7B,MAAM,mBAAsB,GAAAC,yCAAA;AAS5B,MAAM,aAAgB,GAAAC,mCAAA;AAQtB,MAAM,2BAA8B,GAAAC;;;;;;;"}