@backstage/plugin-scaffolder-backend 2.0.0-next.1 → 2.0.0-next.2

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 (48) hide show
  1. package/CHANGELOG.md +83 -0
  2. package/dist/ScaffolderPlugin.cjs.js +7 -16
  3. package/dist/ScaffolderPlugin.cjs.js.map +1 -1
  4. package/dist/index.cjs.js +0 -2
  5. package/dist/index.cjs.js.map +1 -1
  6. package/dist/index.d.ts +81 -95
  7. package/dist/scaffolder/actions/builtin/catalog/fetch.cjs.js +5 -11
  8. package/dist/scaffolder/actions/builtin/catalog/fetch.cjs.js.map +1 -1
  9. package/dist/scaffolder/actions/builtin/catalog/register.cjs.js +26 -62
  10. package/dist/scaffolder/actions/builtin/catalog/register.cjs.js.map +1 -1
  11. package/dist/scaffolder/actions/builtin/catalog/write.cjs.js +4 -5
  12. package/dist/scaffolder/actions/builtin/catalog/write.cjs.js.map +1 -1
  13. package/dist/scaffolder/actions/builtin/debug/log.cjs.js +4 -5
  14. package/dist/scaffolder/actions/builtin/debug/log.cjs.js.map +1 -1
  15. package/dist/scaffolder/actions/builtin/debug/wait.cjs.js +9 -15
  16. package/dist/scaffolder/actions/builtin/debug/wait.cjs.js.map +1 -1
  17. package/dist/scaffolder/actions/builtin/fetch/plain.cjs.js +9 -19
  18. package/dist/scaffolder/actions/builtin/fetch/plain.cjs.js.map +1 -1
  19. package/dist/scaffolder/actions/builtin/fetch/plainFile.cjs.js +9 -19
  20. package/dist/scaffolder/actions/builtin/fetch/plainFile.cjs.js.map +1 -1
  21. package/dist/scaffolder/actions/builtin/fetch/template.cjs.js +33 -55
  22. package/dist/scaffolder/actions/builtin/fetch/template.cjs.js.map +1 -1
  23. package/dist/scaffolder/actions/builtin/fetch/templateFile.cjs.js +24 -34
  24. package/dist/scaffolder/actions/builtin/fetch/templateFile.cjs.js.map +1 -1
  25. package/dist/scaffolder/actions/builtin/filesystem/delete.cjs.js +3 -12
  26. package/dist/scaffolder/actions/builtin/filesystem/delete.cjs.js.map +1 -1
  27. package/dist/scaffolder/actions/builtin/filesystem/read.cjs.js +14 -14
  28. package/dist/scaffolder/actions/builtin/filesystem/read.cjs.js.map +1 -1
  29. package/dist/scaffolder/actions/builtin/filesystem/rename.cjs.js +16 -27
  30. package/dist/scaffolder/actions/builtin/filesystem/rename.cjs.js.map +1 -1
  31. package/dist/scaffolder/dryrun/DecoratedActionsRegistry.cjs.js +2 -11
  32. package/dist/scaffolder/dryrun/DecoratedActionsRegistry.cjs.js.map +1 -1
  33. package/dist/scaffolder/dryrun/createDryRunner.cjs.js.map +1 -1
  34. package/dist/scaffolder/tasks/NunjucksWorkflowRunner.cjs.js +8 -15
  35. package/dist/scaffolder/tasks/NunjucksWorkflowRunner.cjs.js.map +1 -1
  36. package/dist/scaffolder/tasks/StorageTaskBroker.cjs.js.map +1 -1
  37. package/dist/scaffolder/tasks/TaskWorker.cjs.js.map +1 -1
  38. package/dist/service/helpers.cjs.js +4 -2
  39. package/dist/service/helpers.cjs.js.map +1 -1
  40. package/dist/service/router.cjs.js +18 -45
  41. package/dist/service/router.cjs.js.map +1 -1
  42. package/dist/service/rules.cjs.js +11 -11
  43. package/dist/service/rules.cjs.js.map +1 -1
  44. package/dist/util/templating.cjs.js +3 -3
  45. package/dist/util/templating.cjs.js.map +1 -1
  46. package/package.json +16 -17
  47. package/dist/scaffolder/actions/builtin/createBuiltinActions.cjs.js +0 -158
  48. package/dist/scaffolder/actions/builtin/createBuiltinActions.cjs.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,88 @@
1
1
  # @backstage/plugin-scaffolder-backend
2
2
 
3
+ ## 2.0.0-next.2
4
+
5
+ ### Major Changes
6
+
7
+ - 5863b04: **BREAKING CHANGES**
8
+
9
+ - The `createBuiltinActions` method has been removed, as this should no longer be needed with the new backend system route, and was only useful when passing the default list of actions again in the old backend system. You should be able to rely on the default behaviour of the new backend system which is to merge the actions.
10
+
11
+ - The `createCatalogRegisterAction` and `createFetchCatalogEntityAction` actions no longer require an `AuthService`, and now accepts a `CatalogService` instead of `CatalogClient`.
12
+
13
+ Unless you're providing your own override action to the default, this should be a non-breaking change.
14
+
15
+ You can migrate using the following if you're getting typescript errors:
16
+
17
+ ```ts
18
+ import { catalogServiceRef } from '@backstage/plugin-catalog-node';
19
+ import { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';
20
+
21
+ export const myModule = createBackendModule({
22
+ pluginId: 'scaffolder',
23
+ moduleId: 'test',
24
+ register({ registerInit }) {
25
+ registerInit({
26
+ deps: {
27
+ scaffolder: scaffolderActionsExtensionPoint,
28
+ catalog: catalogServiceRef,
29
+ },
30
+ async init({ scaffolder, catalog }) {
31
+ scaffolder.addActions(
32
+ createCatalogRegisterAction({
33
+ catalog,
34
+ }),
35
+ createFetchCatalogEntityAction({
36
+ catalog,
37
+ integrations,
38
+ }),
39
+ );
40
+ },
41
+ });
42
+ },
43
+ });
44
+ ```
45
+
46
+ ### Patch Changes
47
+
48
+ - 89a941d: Migrating to latest action format
49
+ - 023629e: Enable usage of secrets within 'each' step of software templates. For example, you can now structure your `each` step like this:
50
+
51
+ ```
52
+ each:
53
+ [
54
+ { name: "Service1", token: "${{ secrets.token1 }}" },
55
+ { name: "Service2", token: "${{ secrets.token2 }}" },
56
+ ]
57
+ ```
58
+
59
+ - e92e481: Add tests for Scaffolder
60
+ - Updated dependencies
61
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.9.2-next.2
62
+ - @backstage/plugin-scaffolder-backend-module-github@0.8.0-next.2
63
+ - @backstage/backend-defaults@0.11.0-next.2
64
+ - @backstage/plugin-scaffolder-node@0.9.0-next.2
65
+ - @backstage/backend-plugin-api@1.4.0-next.1
66
+ - @backstage/catalog-model@1.7.4
67
+ - @backstage/config@1.3.2
68
+ - @backstage/errors@1.2.7
69
+ - @backstage/integration@1.17.0
70
+ - @backstage/types@1.2.1
71
+ - @backstage/plugin-auth-node@0.6.4-next.1
72
+ - @backstage/plugin-bitbucket-cloud-common@0.3.0
73
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.2.9-next.1
74
+ - @backstage/plugin-catalog-node@1.17.1-next.1
75
+ - @backstage/plugin-events-node@0.4.12-next.1
76
+ - @backstage/plugin-permission-common@0.9.0
77
+ - @backstage/plugin-permission-node@0.10.1-next.1
78
+ - @backstage/plugin-scaffolder-backend-module-azure@0.2.10-next.2
79
+ - @backstage/plugin-scaffolder-backend-module-bitbucket@0.3.11-next.2
80
+ - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.2.10-next.2
81
+ - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.2.10-next.2
82
+ - @backstage/plugin-scaffolder-backend-module-gerrit@0.2.10-next.2
83
+ - @backstage/plugin-scaffolder-backend-module-gitea@0.2.10-next.2
84
+ - @backstage/plugin-scaffolder-common@1.5.11
85
+
3
86
  ## 2.0.0-next.1
4
87
 
5
88
  ### Major Changes
@@ -2,7 +2,7 @@
2
2
 
3
3
  var backendPluginApi = require('@backstage/backend-plugin-api');
4
4
  var integration = require('@backstage/integration');
5
- var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
5
+ var pluginCatalogNode = require('@backstage/plugin-catalog-node');
6
6
  var pluginEventsNode = require('@backstage/plugin-events-node');
7
7
  var alpha = require('@backstage/plugin-scaffolder-node/alpha');
8
8
  var register = require('./scaffolder/actions/builtin/catalog/register.cjs.js');
@@ -17,14 +17,6 @@ var templateFile = require('./scaffolder/actions/builtin/fetch/templateFile.cjs.
17
17
  var _delete = require('./scaffolder/actions/builtin/filesystem/delete.cjs.js');
18
18
  var rename = require('./scaffolder/actions/builtin/filesystem/rename.cjs.js');
19
19
  var read = require('./scaffolder/actions/builtin/filesystem/read.cjs.js');
20
- require('@backstage/plugin-scaffolder-backend-module-github');
21
- require('@backstage/plugin-scaffolder-backend-module-azure');
22
- require('@backstage/plugin-scaffolder-backend-module-bitbucket');
23
- require('@backstage/plugin-scaffolder-backend-module-bitbucket-cloud');
24
- require('@backstage/plugin-scaffolder-backend-module-bitbucket-server');
25
- require('@backstage/plugin-scaffolder-backend-module-gerrit');
26
- require('@backstage/plugin-scaffolder-backend-module-gitlab');
27
- require('@backstage/plugin-scaffolder-backend-module-gitea');
28
20
  require('@backstage/errors');
29
21
  require('./scaffolder/tasks/DatabaseTaskStore.cjs.js');
30
22
  require('@backstage/types');
@@ -102,7 +94,7 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin({
102
94
  httpRouter: backendPluginApi.coreServices.httpRouter,
103
95
  httpAuth: backendPluginApi.coreServices.httpAuth,
104
96
  auditor: backendPluginApi.coreServices.auditor,
105
- catalogClient: alpha$1.catalogServiceRef,
97
+ catalog: pluginCatalogNode.catalogServiceRef,
106
98
  events: pluginEventsNode.eventsServiceRef
107
99
  },
108
100
  async init({
@@ -114,7 +106,7 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin({
114
106
  auth,
115
107
  httpRouter,
116
108
  httpAuth,
117
- catalogClient,
109
+ catalog,
118
110
  permissions,
119
111
  events,
120
112
  auditor
@@ -154,8 +146,8 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin({
154
146
  log.createDebugLogAction(),
155
147
  wait.createWaitAction(),
156
148
  // todo(blam): maybe these should be a -catalog module?
157
- register.createCatalogRegisterAction({ catalogClient, integrations, auth }),
158
- fetch.createFetchCatalogEntityAction({ catalogClient, auth }),
149
+ register.createCatalogRegisterAction({ catalog, integrations }),
150
+ fetch.createFetchCatalogEntityAction({ catalog }),
159
151
  write.createCatalogWriteAction(),
160
152
  _delete.createFilesystemDeleteAction(),
161
153
  rename.createFilesystemRenameAction(),
@@ -166,11 +158,10 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin({
166
158
  `Starting scaffolder with the following actions enabled ${actionIds}`
167
159
  );
168
160
  const router$1 = await router.createRouter({
169
- logger: log$1,
161
+ logger,
170
162
  config,
171
163
  database,
172
- catalogClient,
173
- reader,
164
+ catalog,
174
165
  lifecycle,
175
166
  actions,
176
167
  taskBroker,
@@ -1 +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 coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { TaskBroker, TemplateAction } from '@backstage/plugin-scaffolder-node';\nimport {\n AutocompleteHandler,\n CreatedTemplateFilter,\n CreatedTemplateGlobal,\n createTemplateFilter,\n createTemplateGlobalFunction,\n createTemplateGlobalValue,\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 createFilesystemReadDirAction,\n createFilesystemRenameAction,\n createWaitAction,\n} from './scaffolder';\nimport { createRouter } from './service/router';\nimport { loggerToWinstonLogger } from './util/loggerToWinstonLogger';\nimport {\n convertFiltersToRecord,\n convertGlobalsToRecord,\n} from './util/templating';\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: CreatedTemplateFilter<any, any>[] = [];\n const additionalTemplateGlobals: CreatedTemplateGlobal[] = [];\n\n env.registerExtensionPoint(scaffolderTemplatingExtensionPoint, {\n addTemplateFilters(newFilters) {\n additionalTemplateFilters.push(\n ...(Array.isArray(newFilters)\n ? newFilters\n : Object.entries(newFilters).map(([id, filter]) =>\n createTemplateFilter({\n id,\n filter,\n }),\n )),\n );\n },\n addTemplateGlobals(newGlobals) {\n additionalTemplateGlobals.push(\n ...(Array.isArray(newGlobals)\n ? newGlobals\n : Object.entries(newGlobals).map(([id, global]) =>\n typeof global === 'function'\n ? createTemplateGlobalFunction({ id, fn: global })\n : createTemplateGlobalValue({ id, value: global }),\n )),\n );\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 httpRouter: coreServices.httpRouter,\n httpAuth: coreServices.httpAuth,\n auditor: coreServices.auditor,\n catalogClient: catalogServiceRef,\n events: eventsServiceRef,\n },\n async init({\n logger,\n config,\n lifecycle,\n reader,\n database,\n auth,\n httpRouter,\n httpAuth,\n catalogClient,\n permissions,\n events,\n auditor,\n }) {\n const log = loggerToWinstonLogger(logger);\n const integrations = ScmIntegrations.fromConfig(config);\n\n const templateExtensions = {\n additionalTemplateFilters: convertFiltersToRecord(\n additionalTemplateFilters,\n ),\n additionalTemplateGlobals: convertGlobalsToRecord(\n additionalTemplateGlobals,\n ),\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 ...templateExtensions,\n }),\n createFetchTemplateFileAction({\n integrations,\n reader,\n ...templateExtensions,\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 createFilesystemReadDirAction(),\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 permissions,\n autocompleteHandlers,\n additionalWorkspaceProviders,\n events,\n auditor,\n });\n httpRouter.use(router);\n },\n });\n },\n});\n"],"names":["createBackendPlugin","scaffolderActionsExtensionPoint","scaffolderTaskBrokerExtensionPoint","scaffolderTemplatingExtensionPoint","createTemplateFilter","createTemplateGlobalFunction","createTemplateGlobalValue","scaffolderAutocompleteExtensionPoint","scaffolderWorkspaceProviderExtensionPoint","coreServices","catalogServiceRef","eventsServiceRef","log","loggerToWinstonLogger","ScmIntegrations","convertFiltersToRecord","convertGlobalsToRecord","createFetchPlainAction","createFetchPlainFileAction","createFetchTemplateAction","createFetchTemplateFileAction","createDebugLogAction","createWaitAction","createCatalogRegisterAction","createFetchCatalogEntityAction","createCatalogWriteAction","createFilesystemDeleteAction","createFilesystemRenameAction","createFilesystemReadDirAction","router","createRouter"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgEO,MAAM,mBAAmBA,oCAAoB,CAAA;AAAA,EAClD,QAAU,EAAA,YAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,YAAA,GAAe,IAAI,KAAgC,EAAA;AACzD,IAAA,GAAA,CAAI,uBAAuBC,qCAAiC,EAAA;AAAA,MAC1D,cAAc,UAAmC,EAAA;AAC/C,QAAa,YAAA,CAAA,IAAA,CAAK,GAAG,UAAU,CAAA;AAAA;AACjC,KACD,CAAA;AAED,IAAI,IAAA,UAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,wCAAoC,EAAA;AAAA,MAC7D,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAM,MAAA,IAAI,MAAM,kCAAkC,CAAA;AAAA;AAEpD,QAAa,UAAA,GAAA,aAAA;AAAA;AACf,KACD,CAAA;AAED,IAAA,MAAM,4BAA+D,EAAC;AACtE,IAAA,MAAM,4BAAqD,EAAC;AAE5D,IAAA,GAAA,CAAI,uBAAuBC,wCAAoC,EAAA;AAAA,MAC7D,mBAAmB,UAAY,EAAA;AAC7B,QAA0B,yBAAA,CAAA,IAAA;AAAA,UACxB,GAAI,MAAM,OAAQ,CAAA,UAAU,IACxB,UACA,GAAA,MAAA,CAAO,OAAQ,CAAA,UAAU,CAAE,CAAA,GAAA;AAAA,YAAI,CAAC,CAAC,EAAI,EAAA,MAAM,MACzCC,0BAAqB,CAAA;AAAA,cACnB,EAAA;AAAA,cACA;AAAA,aACD;AAAA;AACH,SACN;AAAA,OACF;AAAA,MACA,mBAAmB,UAAY,EAAA;AAC7B,QAA0B,yBAAA,CAAA,IAAA;AAAA,UACxB,GAAI,MAAM,OAAQ,CAAA,UAAU,IACxB,UACA,GAAA,MAAA,CAAO,OAAQ,CAAA,UAAU,CAAE,CAAA,GAAA;AAAA,YAAI,CAAC,CAAC,EAAI,EAAA,MAAM,MACzC,OAAO,MAAA,KAAW,aACdC,kCAA6B,CAAA,EAAE,IAAI,EAAI,EAAA,MAAA,EAAQ,CAC/C,GAAAC,+BAAA,CAA0B,EAAE,EAAI,EAAA,KAAA,EAAO,QAAQ;AAAA;AACrD,SACN;AAAA;AACF,KACD,CAAA;AAED,IAAA,MAAM,uBAA4D,EAAC;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;AAAA;AAC/C,KACD,CAAA;AAED,IAAA,MAAM,+BAAkE,EAAC;AACzE,IAAA,GAAA,CAAI,uBAAuBC,+CAA2C,EAAA;AAAA,MACpE,aAAa,QAAU,EAAA;AACrB,QAAO,MAAA,CAAA,MAAA,CAAO,8BAA8B,QAAQ,CAAA;AAAA;AACtD,KACD,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,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,SAASA,6BAAa,CAAA,OAAA;AAAA,QACtB,aAAe,EAAAC,yBAAA;AAAA,QACf,MAAQ,EAAAC;AAAA,OACV;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,UAAA;AAAA,QACA,QAAA;AAAA,QACA,aAAA;AAAA,QACA,WAAA;AAAA,QACA,MAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAM,MAAAC,KAAA,GAAMC,4CAAsB,MAAM,CAAA;AACxC,QAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AAEtD,QAAA,MAAM,kBAAqB,GAAA;AAAA,UACzB,yBAA2B,EAAAC,iCAAA;AAAA,YACzB;AAAA,WACF;AAAA,UACA,yBAA2B,EAAAC,iCAAA;AAAA,YACzB;AAAA;AACF,SACF;AACA,QAAA,MAAM,OAAU,GAAA;AAAA;AAAA,UAEd,GAAG,YAAA;AAAA;AAAA,UAGHC,4BAAuB,CAAA;AAAA,YACrB,MAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,oCAA2B,CAAA;AAAA,YACzB,MAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,kCAA0B,CAAA;AAAA,YACxB,YAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAG;AAAA,WACJ,CAAA;AAAA,UACDC,0CAA8B,CAAA;AAAA,YAC5B,YAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAG;AAAA,WACJ,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,UAC7BC,kCAA8B;AAAA,SAChC;AAEA,QAAM,MAAA,SAAA,GAAY,QAAQ,GAAI,CAAA,CAAA,MAAA,KAAU,OAAO,EAAE,CAAA,CAAE,KAAK,IAAI,CAAA;AAE5D,QAAIhB,KAAA,CAAA,IAAA;AAAA,UACF,0DAA0D,SAAS,CAAA;AAAA,SACrE;AAEA,QAAM,MAAAiB,QAAA,GAAS,MAAMC,mBAAa,CAAA;AAAA,UAChC,MAAQ,EAAAlB,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,WAAA;AAAA,UACA,oBAAA;AAAA,UACA,4BAAA;AAAA,UACA,MAAA;AAAA,UACA;AAAA,SACD,CAAA;AACD,QAAA,UAAA,CAAW,IAAIiB,QAAM,CAAA;AAAA;AACvB,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
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 coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { TaskBroker, TemplateAction } from '@backstage/plugin-scaffolder-node';\nimport {\n AutocompleteHandler,\n CreatedTemplateFilter,\n CreatedTemplateGlobal,\n createTemplateFilter,\n createTemplateGlobalFunction,\n createTemplateGlobalValue,\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 createFilesystemReadDirAction,\n createFilesystemRenameAction,\n createWaitAction,\n} from './scaffolder';\nimport { createRouter } from './service/router';\nimport { loggerToWinstonLogger } from './util/loggerToWinstonLogger';\nimport {\n convertFiltersToRecord,\n convertGlobalsToRecord,\n} from './util/templating';\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: CreatedTemplateFilter<any, any>[] = [];\n const additionalTemplateGlobals: CreatedTemplateGlobal[] = [];\n\n env.registerExtensionPoint(scaffolderTemplatingExtensionPoint, {\n addTemplateFilters(newFilters) {\n additionalTemplateFilters.push(\n ...(Array.isArray(newFilters)\n ? newFilters\n : Object.entries(newFilters).map(([id, filter]) =>\n createTemplateFilter({\n id,\n filter,\n }),\n )),\n );\n },\n addTemplateGlobals(newGlobals) {\n additionalTemplateGlobals.push(\n ...(Array.isArray(newGlobals)\n ? newGlobals\n : Object.entries(newGlobals).map(([id, global]) =>\n typeof global === 'function'\n ? createTemplateGlobalFunction({ id, fn: global })\n : createTemplateGlobalValue({ id, value: global }),\n )),\n );\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 httpRouter: coreServices.httpRouter,\n httpAuth: coreServices.httpAuth,\n auditor: coreServices.auditor,\n catalog: catalogServiceRef,\n events: eventsServiceRef,\n },\n async init({\n logger,\n config,\n lifecycle,\n reader,\n database,\n auth,\n httpRouter,\n httpAuth,\n catalog,\n permissions,\n events,\n auditor,\n }) {\n const log = loggerToWinstonLogger(logger);\n const integrations = ScmIntegrations.fromConfig(config);\n\n const templateExtensions = {\n additionalTemplateFilters: convertFiltersToRecord(\n additionalTemplateFilters,\n ),\n additionalTemplateGlobals: convertGlobalsToRecord(\n additionalTemplateGlobals,\n ),\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 ...templateExtensions,\n }),\n createFetchTemplateFileAction({\n integrations,\n reader,\n ...templateExtensions,\n }),\n createDebugLogAction(),\n createWaitAction(),\n // todo(blam): maybe these should be a -catalog module?\n createCatalogRegisterAction({ catalog, integrations }),\n createFetchCatalogEntityAction({ catalog }),\n createCatalogWriteAction(),\n createFilesystemDeleteAction(),\n createFilesystemRenameAction(),\n createFilesystemReadDirAction(),\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,\n config,\n database,\n catalog,\n lifecycle,\n actions,\n taskBroker,\n additionalTemplateFilters,\n additionalTemplateGlobals,\n auth,\n httpAuth,\n permissions,\n autocompleteHandlers,\n additionalWorkspaceProviders,\n events,\n auditor,\n });\n httpRouter.use(router);\n },\n });\n },\n});\n"],"names":["createBackendPlugin","scaffolderActionsExtensionPoint","scaffolderTaskBrokerExtensionPoint","scaffolderTemplatingExtensionPoint","createTemplateFilter","createTemplateGlobalFunction","createTemplateGlobalValue","scaffolderAutocompleteExtensionPoint","scaffolderWorkspaceProviderExtensionPoint","coreServices","catalogServiceRef","eventsServiceRef","log","loggerToWinstonLogger","ScmIntegrations","convertFiltersToRecord","convertGlobalsToRecord","createFetchPlainAction","createFetchPlainFileAction","createFetchTemplateAction","createFetchTemplateFileAction","createDebugLogAction","createWaitAction","createCatalogRegisterAction","createFetchCatalogEntityAction","createCatalogWriteAction","createFilesystemDeleteAction","createFilesystemRenameAction","createFilesystemReadDirAction","router","createRouter"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgEO,MAAM,mBAAmBA,oCAAoB,CAAA;AAAA,EAClD,QAAU,EAAA,YAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,YAAA,GAAe,IAAI,KAAgC,EAAA;AACzD,IAAA,GAAA,CAAI,uBAAuBC,qCAAiC,EAAA;AAAA,MAC1D,cAAc,UAAmC,EAAA;AAC/C,QAAa,YAAA,CAAA,IAAA,CAAK,GAAG,UAAU,CAAA;AAAA;AACjC,KACD,CAAA;AAED,IAAI,IAAA,UAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,wCAAoC,EAAA;AAAA,MAC7D,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAM,MAAA,IAAI,MAAM,kCAAkC,CAAA;AAAA;AAEpD,QAAa,UAAA,GAAA,aAAA;AAAA;AACf,KACD,CAAA;AAED,IAAA,MAAM,4BAA+D,EAAC;AACtE,IAAA,MAAM,4BAAqD,EAAC;AAE5D,IAAA,GAAA,CAAI,uBAAuBC,wCAAoC,EAAA;AAAA,MAC7D,mBAAmB,UAAY,EAAA;AAC7B,QAA0B,yBAAA,CAAA,IAAA;AAAA,UACxB,GAAI,MAAM,OAAQ,CAAA,UAAU,IACxB,UACA,GAAA,MAAA,CAAO,OAAQ,CAAA,UAAU,CAAE,CAAA,GAAA;AAAA,YAAI,CAAC,CAAC,EAAI,EAAA,MAAM,MACzCC,0BAAqB,CAAA;AAAA,cACnB,EAAA;AAAA,cACA;AAAA,aACD;AAAA;AACH,SACN;AAAA,OACF;AAAA,MACA,mBAAmB,UAAY,EAAA;AAC7B,QAA0B,yBAAA,CAAA,IAAA;AAAA,UACxB,GAAI,MAAM,OAAQ,CAAA,UAAU,IACxB,UACA,GAAA,MAAA,CAAO,OAAQ,CAAA,UAAU,CAAE,CAAA,GAAA;AAAA,YAAI,CAAC,CAAC,EAAI,EAAA,MAAM,MACzC,OAAO,MAAA,KAAW,aACdC,kCAA6B,CAAA,EAAE,IAAI,EAAI,EAAA,MAAA,EAAQ,CAC/C,GAAAC,+BAAA,CAA0B,EAAE,EAAI,EAAA,KAAA,EAAO,QAAQ;AAAA;AACrD,SACN;AAAA;AACF,KACD,CAAA;AAED,IAAA,MAAM,uBAA4D,EAAC;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;AAAA;AAC/C,KACD,CAAA;AAED,IAAA,MAAM,+BAAkE,EAAC;AACzE,IAAA,GAAA,CAAI,uBAAuBC,+CAA2C,EAAA;AAAA,MACpE,aAAa,QAAU,EAAA;AACrB,QAAO,MAAA,CAAA,MAAA,CAAO,8BAA8B,QAAQ,CAAA;AAAA;AACtD,KACD,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,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,SAASA,6BAAa,CAAA,OAAA;AAAA,QACtB,OAAS,EAAAC,mCAAA;AAAA,QACT,MAAQ,EAAAC;AAAA,OACV;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,UAAA;AAAA,QACA,QAAA;AAAA,QACA,OAAA;AAAA,QACA,WAAA;AAAA,QACA,MAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAM,MAAAC,KAAA,GAAMC,4CAAsB,MAAM,CAAA;AACxC,QAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AAEtD,QAAA,MAAM,kBAAqB,GAAA;AAAA,UACzB,yBAA2B,EAAAC,iCAAA;AAAA,YACzB;AAAA,WACF;AAAA,UACA,yBAA2B,EAAAC,iCAAA;AAAA,YACzB;AAAA;AACF,SACF;AACA,QAAA,MAAM,OAAU,GAAA;AAAA;AAAA,UAEd,GAAG,YAAA;AAAA;AAAA,UAGHC,4BAAuB,CAAA;AAAA,YACrB,MAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,oCAA2B,CAAA;AAAA,YACzB,MAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,kCAA0B,CAAA;AAAA,YACxB,YAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAG;AAAA,WACJ,CAAA;AAAA,UACDC,0CAA8B,CAAA;AAAA,YAC5B,YAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAG;AAAA,WACJ,CAAA;AAAA,UACDC,wBAAqB,EAAA;AAAA,UACrBC,qBAAiB,EAAA;AAAA;AAAA,UAEjBC,oCAA4B,CAAA,EAAE,OAAS,EAAA,YAAA,EAAc,CAAA;AAAA,UACrDC,oCAAA,CAA+B,EAAE,OAAA,EAAS,CAAA;AAAA,UAC1CC,8BAAyB,EAAA;AAAA,UACzBC,oCAA6B,EAAA;AAAA,UAC7BC,mCAA6B,EAAA;AAAA,UAC7BC,kCAA8B;AAAA,SAChC;AAEA,QAAM,MAAA,SAAA,GAAY,QAAQ,GAAI,CAAA,CAAA,MAAA,KAAU,OAAO,EAAE,CAAA,CAAE,KAAK,IAAI,CAAA;AAE5D,QAAIhB,KAAA,CAAA,IAAA;AAAA,UACF,0DAA0D,SAAS,CAAA;AAAA,SACrE;AAEA,QAAM,MAAAiB,QAAA,GAAS,MAAMC,mBAAa,CAAA;AAAA,UAChC,MAAA;AAAA,UACA,MAAA;AAAA,UACA,QAAA;AAAA,UACA,OAAA;AAAA,UACA,SAAA;AAAA,UACA,OAAA;AAAA,UACA,UAAA;AAAA,UACA,yBAAA;AAAA,UACA,yBAAA;AAAA,UACA,IAAA;AAAA,UACA,QAAA;AAAA,UACA,WAAA;AAAA,UACA,oBAAA;AAAA,UACA,4BAAA;AAAA,UACA,MAAA;AAAA,UACA;AAAA,SACD,CAAA;AACD,QAAA,UAAA,CAAW,IAAID,QAAM,CAAA;AAAA;AACvB,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
package/dist/index.cjs.js CHANGED
@@ -6,7 +6,6 @@ var ScaffolderPlugin = require('./ScaffolderPlugin.cjs.js');
6
6
  var register = require('./scaffolder/actions/builtin/catalog/register.cjs.js');
7
7
  var write = require('./scaffolder/actions/builtin/catalog/write.cjs.js');
8
8
  var fetch = require('./scaffolder/actions/builtin/catalog/fetch.cjs.js');
9
- var createBuiltinActions = require('./scaffolder/actions/builtin/createBuiltinActions.cjs.js');
10
9
  var log = require('./scaffolder/actions/builtin/debug/log.cjs.js');
11
10
  var wait = require('./scaffolder/actions/builtin/debug/wait.cjs.js');
12
11
  var plain = require('./scaffolder/actions/builtin/fetch/plain.cjs.js');
@@ -27,7 +26,6 @@ exports.default = ScaffolderPlugin.scaffolderPlugin;
27
26
  exports.createCatalogRegisterAction = register.createCatalogRegisterAction;
28
27
  exports.createCatalogWriteAction = write.createCatalogWriteAction;
29
28
  exports.createFetchCatalogEntityAction = fetch.createFetchCatalogEntityAction;
30
- exports.createBuiltinActions = createBuiltinActions.createBuiltinActions;
31
29
  exports.createDebugLogAction = log.createDebugLogAction;
32
30
  exports.createWaitAction = wait.createWaitAction;
33
31
  exports.createFetchPlainAction = plain.createFetchPlainAction;
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/dist/index.d.ts CHANGED
@@ -1,19 +1,17 @@
1
1
  import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
2
- import { AuthService, UrlReaderService, DatabaseService, BackstageCredentials, AuditorService } from '@backstage/backend-plugin-api';
2
+ import { UrlReaderService, DatabaseService, LoggerService, AuthService, BackstageCredentials, AuditorService } from '@backstage/backend-plugin-api';
3
3
  import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
4
4
  import { TemplateFilter, TemplateGlobal, TemplateAction, TaskSecrets, SerializedTask, TaskStatus, SerializedTaskEvent, TaskContext, TaskCompletionState, TaskBroker } from '@backstage/plugin-scaffolder-node';
5
- import * as _backstage_types from '@backstage/types';
6
- import { HumanDuration, JsonObject, JsonValue } from '@backstage/types';
7
5
  import { ScmIntegrations } from '@backstage/integration';
8
- import { CatalogApi } from '@backstage/catalog-client';
9
- import { Config } from '@backstage/config';
6
+ import { CatalogService } from '@backstage/plugin-catalog-node';
7
+ import { HumanDuration, JsonObject, JsonValue } from '@backstage/types';
10
8
  import { Duration } from 'luxon';
11
9
  import { Knex } from 'knex';
12
10
  import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
13
11
  import { TaskSpec, TaskRecovery, TemplateEntityStepV1beta3, TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
14
12
  import { EventsService } from '@backstage/plugin-events-node';
13
+ import { Config } from '@backstage/config';
15
14
  import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
16
- import { Logger } from 'winston';
17
15
  import { PermissionEvaluator, PermissionRuleParams } from '@backstage/plugin-permission-common';
18
16
  import { PermissionRule } from '@backstage/plugin-permission-node';
19
17
  import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, RESOURCE_TYPE_SCAFFOLDER_ACTION } from '@backstage/plugin-scaffolder-common/alpha';
@@ -30,17 +28,25 @@ declare const scaffolderPlugin: _backstage_backend_plugin_api.BackendFeature;
30
28
  * @public
31
29
  */
32
30
  declare function createCatalogRegisterAction(options: {
33
- catalogClient: CatalogApi;
31
+ catalog: CatalogService;
34
32
  integrations: ScmIntegrations;
35
- auth?: AuthService;
36
33
  }): _backstage_plugin_scaffolder_node.TemplateAction<{
37
34
  catalogInfoUrl: string;
38
- optional?: boolean;
35
+ optional?: boolean | undefined;
36
+ } | {
37
+ catalogInfoUrl: string;
38
+ optional?: boolean | undefined;
39
+ catalogInfoPath?: string | undefined;
39
40
  } | {
40
41
  repoContentsUrl: string;
41
- catalogInfoPath?: string;
42
- optional?: boolean;
43
- }, _backstage_types.JsonObject, "v1">;
42
+ optional?: boolean | undefined;
43
+ } | {
44
+ repoContentsUrl: string;
45
+ optional?: boolean | undefined;
46
+ catalogInfoPath?: string | undefined;
47
+ }, {
48
+ [x: string]: any;
49
+ }, "v2">;
44
50
 
45
51
  /**
46
52
  * Writes a catalog descriptor file containing the provided entity to a path in the workspace.
@@ -49,7 +55,9 @@ declare function createCatalogRegisterAction(options: {
49
55
  declare function createCatalogWriteAction(): _backstage_plugin_scaffolder_node.TemplateAction<{
50
56
  entity: Record<string, any>;
51
57
  filePath?: string | undefined;
52
- }, any, "v1">;
58
+ }, {
59
+ [x: string]: any;
60
+ }, "v2">;
53
61
 
54
62
  /**
55
63
  * Returns entity or entities from the catalog by entity reference(s).
@@ -57,8 +65,7 @@ declare function createCatalogWriteAction(): _backstage_plugin_scaffolder_node.T
57
65
  * @public
58
66
  */
59
67
  declare function createFetchCatalogEntityAction(options: {
60
- catalogClient: CatalogApi;
61
- auth?: AuthService;
68
+ catalog: CatalogService;
62
69
  }): _backstage_plugin_scaffolder_node.TemplateAction<{
63
70
  entityRef?: string | undefined;
64
71
  entityRefs?: string[] | undefined;
@@ -70,50 +77,6 @@ declare function createFetchCatalogEntityAction(options: {
70
77
  entities?: any[] | undefined;
71
78
  }, "v2">;
72
79
 
73
- /**
74
- * The options passed to {@link createBuiltinActions}
75
- * @public
76
- */
77
- interface CreateBuiltInActionsOptions {
78
- /**
79
- * The {@link @backstage/backend-plugin-api#UrlReaderService} interface that will be used in the default actions.
80
- */
81
- reader: UrlReaderService;
82
- /**
83
- * The {@link @backstage/integrations#ScmIntegrations} that will be used in the default actions.
84
- */
85
- integrations: ScmIntegrations;
86
- /**
87
- * The {@link @backstage/catalog-client#CatalogApi} that will be used in the default actions.
88
- */
89
- catalogClient: CatalogApi;
90
- /**
91
- * The {@link @backstage/backend-plugin-api#AuthService} that will be used in the default actions.
92
- */
93
- auth?: AuthService;
94
- /**
95
- * The {@link @backstage/config#Config} that will be used in the default actions.
96
- */
97
- config: Config;
98
- /**
99
- * Additional custom filters that will be passed to the nunjucks template engine for use in
100
- * Template Manifests and also template skeleton files when using `fetch:template`.
101
- */
102
- additionalTemplateFilters?: Record<string, TemplateFilter>;
103
- additionalTemplateGlobals?: Record<string, TemplateGlobal>;
104
- }
105
- /**
106
- * A function to generate create a list of default actions that the scaffolder provides.
107
- * Is called internally in the default setup, but can be used when adding your own actions or overriding the default ones
108
- *
109
- * TODO(blam): version 2 of the scaffolder shouldn't ship with the additional modules. We should ship the basics, and let people install
110
- * modules for the providers they want to use.
111
- * @public
112
- * @returns A list of actions that can be used in the scaffolder
113
- *
114
- */
115
- declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction[];
116
-
117
80
  /**
118
81
  * Writes a message into the log or lists all files in the workspace
119
82
  *
@@ -124,7 +87,12 @@ declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => Te
124
87
  *
125
88
  * @public
126
89
  */
127
- declare function createDebugLogAction(): _backstage_plugin_scaffolder_node.TemplateAction<any, any, "v1">;
90
+ declare function createDebugLogAction(): _backstage_plugin_scaffolder_node.TemplateAction<{
91
+ message?: string | undefined;
92
+ listWorkspace?: boolean | "with-contents" | "with-filenames" | undefined;
93
+ }, {
94
+ [x: string]: any;
95
+ }, "v2">;
128
96
 
129
97
  /**
130
98
  * Waits for a certain period of time.
@@ -138,7 +106,13 @@ declare function createDebugLogAction(): _backstage_plugin_scaffolder_node.Templ
138
106
  */
139
107
  declare function createWaitAction(options?: {
140
108
  maxWaitTime?: Duration | HumanDuration;
141
- }): _backstage_plugin_scaffolder_node.TemplateAction<HumanDuration, _backstage_types.JsonObject, "v1">;
109
+ }): _backstage_plugin_scaffolder_node.TemplateAction<{
110
+ minutes?: number | undefined;
111
+ seconds?: number | undefined;
112
+ milliseconds?: number | undefined;
113
+ }, {
114
+ [x: string]: any;
115
+ }, "v2">;
142
116
 
143
117
  /**
144
118
  * Downloads content and places it in the workspace, or optionally
@@ -150,13 +124,14 @@ declare function createFetchPlainAction(options: {
150
124
  integrations: ScmIntegrations;
151
125
  }): _backstage_plugin_scaffolder_node.TemplateAction<{
152
126
  url: string;
153
- targetPath?: string;
154
- token?: string;
155
- }, _backstage_types.JsonObject, "v1">;
127
+ targetPath?: string | undefined;
128
+ token?: string | undefined;
129
+ }, {
130
+ [x: string]: any;
131
+ }, "v2">;
156
132
 
157
133
  /**
158
- * Downloads content and places it in the workspace, or optionally
159
- * in a subdirectory specified by the 'targetPath' input option.
134
+ * Downloads a single file and places it in the workspace.
160
135
  * @public
161
136
  */
162
137
  declare function createFetchPlainFileAction(options: {
@@ -165,8 +140,10 @@ declare function createFetchPlainFileAction(options: {
165
140
  }): _backstage_plugin_scaffolder_node.TemplateAction<{
166
141
  url: string;
167
142
  targetPath: string;
168
- token?: string;
169
- }, _backstage_types.JsonObject, "v1">;
143
+ token?: string | undefined;
144
+ }, {
145
+ [x: string]: any;
146
+ }, "v2">;
170
147
 
171
148
  /**
172
149
  * Downloads a skeleton, templates variables into file and directory names and content.
@@ -182,16 +159,19 @@ declare function createFetchTemplateAction(options: {
182
159
  additionalTemplateGlobals?: Record<string, TemplateGlobal>;
183
160
  }): _backstage_plugin_scaffolder_node.TemplateAction<{
184
161
  url: string;
185
- targetPath?: string;
186
- values: any;
187
- templateFileExtension?: string | boolean;
188
- copyWithoutTemplating?: string[];
189
- cookiecutterCompat?: boolean;
190
- replace?: boolean;
191
- trimBlocks?: boolean;
192
- lstripBlocks?: boolean;
193
- token?: string;
194
- }, _backstage_types.JsonObject, "v1">;
162
+ targetPath?: string | undefined;
163
+ values?: Record<string, any> | undefined;
164
+ copyWithoutRender?: string[] | undefined;
165
+ copyWithoutTemplating?: string[] | undefined;
166
+ cookiecutterCompat?: boolean | undefined;
167
+ templateFileExtension?: string | boolean | undefined;
168
+ replace?: boolean | undefined;
169
+ trimBlocks?: boolean | undefined;
170
+ lstripBlocks?: boolean | undefined;
171
+ token?: string | undefined;
172
+ }, {
173
+ [x: string]: any;
174
+ }, "v2">;
195
175
 
196
176
  /**
197
177
  * Downloads a single file and templates variables into file.
@@ -207,13 +187,15 @@ declare function createFetchTemplateFileAction(options: {
207
187
  }): _backstage_plugin_scaffolder_node.TemplateAction<{
208
188
  url: string;
209
189
  targetPath: string;
210
- values: any;
211
- cookiecutterCompat?: boolean;
212
- replace?: boolean;
213
- trimBlocks?: boolean;
214
- lstripBlocks?: boolean;
215
- token?: string;
216
- }, _backstage_types.JsonObject, "v1">;
190
+ values?: Record<string, any> | undefined;
191
+ cookiecutterCompat?: boolean | undefined;
192
+ replace?: boolean | undefined;
193
+ trimBlocks?: boolean | undefined;
194
+ lstripBlocks?: boolean | undefined;
195
+ token?: string | undefined;
196
+ }, {
197
+ [x: string]: any;
198
+ }, "v2">;
217
199
 
218
200
  /**
219
201
  * Creates new action that enables deletion of files and directories in the workspace.
@@ -221,27 +203,31 @@ declare function createFetchTemplateFileAction(options: {
221
203
  */
222
204
  declare const createFilesystemDeleteAction: () => _backstage_plugin_scaffolder_node.TemplateAction<{
223
205
  files: string[];
224
- }, _backstage_types.JsonObject, "v1">;
206
+ }, {
207
+ [x: string]: any;
208
+ }, "v2">;
225
209
 
226
210
  /**
227
211
  * Creates a new action that allows renames of files and directories in the workspace.
228
212
  * @public
229
213
  */
230
214
  declare const createFilesystemRenameAction: () => _backstage_plugin_scaffolder_node.TemplateAction<{
231
- files: Array<{
215
+ files: {
232
216
  from: string;
233
217
  to: string;
234
- overwrite?: boolean;
235
- }>;
236
- }, _backstage_types.JsonObject, "v1">;
218
+ overwrite?: boolean | undefined;
219
+ }[];
220
+ }, {
221
+ [x: string]: any;
222
+ }, "v2">;
237
223
 
238
224
  /**
239
225
  * Creates new action that enables reading directories in the workspace.
240
226
  * @public
241
227
  */
242
228
  declare const createFilesystemReadDirAction: () => _backstage_plugin_scaffolder_node.TemplateAction<{
243
- recursive: boolean;
244
229
  paths: string[];
230
+ recursive: boolean;
245
231
  }, {
246
232
  files: {
247
233
  name: string;
@@ -253,7 +239,7 @@ declare const createFilesystemReadDirAction: () => _backstage_plugin_scaffolder_
253
239
  path: string;
254
240
  fullPath: string;
255
241
  }[];
256
- }, "v1">;
242
+ }, "v2">;
257
243
 
258
244
  /**
259
245
  * Registry of all registered template actions.
@@ -534,7 +520,7 @@ declare class TaskManager implements TaskContext {
534
520
  private readonly auth?;
535
521
  private isDone;
536
522
  private heartbeatTimeoutId?;
537
- static create(task: CurrentClaimedTask, storage: TaskStore, abortSignal: AbortSignal, logger: Logger, auth?: AuthService, config?: Config, additionalWorkspaceProviders?: Record<string, WorkspaceProvider>): TaskManager;
523
+ static create(task: CurrentClaimedTask, storage: TaskStore, abortSignal: AbortSignal, logger: LoggerService, auth?: AuthService, config?: Config, additionalWorkspaceProviders?: Record<string, WorkspaceProvider>): TaskManager;
538
524
  private constructor();
539
525
  get spec(): _backstage_plugin_scaffolder_common.TaskSpecV1beta3;
540
526
  get cancelSignal(): AbortSignal;
@@ -609,7 +595,7 @@ type CreateWorkerOptions = {
609
595
  actionRegistry: TemplateActionRegistry;
610
596
  integrations: ScmIntegrations;
611
597
  workingDirectory: string;
612
- logger: Logger;
598
+ logger: LoggerService;
613
599
  auditor?: AuditorService;
614
600
  additionalTemplateFilters?: Record<string, TemplateFilter>;
615
601
  /**
@@ -659,4 +645,4 @@ type TemplatePermissionRuleInput<TParams extends PermissionRuleParams = Permissi
659
645
  */
660
646
  type ActionPermissionRuleInput<TParams extends PermissionRuleParams = PermissionRuleParams> = PermissionRule<TemplateEntityStepV1beta3 | TemplateParametersV1beta3, {}, typeof RESOURCE_TYPE_SCAFFOLDER_ACTION, TParams>;
661
647
 
662
- export { type ActionPermissionRuleInput, type CreateBuiltInActionsOptions, type CreateWorkerOptions, type CurrentClaimedTask, DatabaseTaskStore, type DatabaseTaskStoreOptions, TaskManager, type TaskStore, type TaskStoreCreateTaskOptions, type TaskStoreCreateTaskResult, type TaskStoreEmitOptions, type TaskStoreListEventsOptions, type TaskStoreRecoverTaskOptions, type TaskStoreShutDownTaskOptions, TaskWorker, TemplateActionRegistry, type TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFetchTemplateFileAction, createFilesystemDeleteAction, createFilesystemReadDirAction, createFilesystemRenameAction, createWaitAction, scaffolderPlugin as default };
648
+ export { type ActionPermissionRuleInput, type CreateWorkerOptions, type CurrentClaimedTask, DatabaseTaskStore, type DatabaseTaskStoreOptions, TaskManager, type TaskStore, type TaskStoreCreateTaskOptions, type TaskStoreCreateTaskResult, type TaskStoreEmitOptions, type TaskStoreListEventsOptions, type TaskStoreRecoverTaskOptions, type TaskStoreShutDownTaskOptions, TaskWorker, TemplateActionRegistry, type TemplatePermissionRuleInput, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFetchTemplateFileAction, createFilesystemDeleteAction, createFilesystemReadDirAction, createFilesystemRenameAction, createWaitAction, scaffolderPlugin as default };
@@ -6,7 +6,7 @@ var fetch_examples = require('./fetch.examples.cjs.js');
6
6
 
7
7
  const id = "catalog:fetch";
8
8
  function createFetchCatalogEntityAction(options) {
9
- const { catalogClient, auth } = options;
9
+ const { catalog } = options;
10
10
  return pluginScaffolderNode.createTemplateAction({
11
11
  id,
12
12
  description: "Returns entity or entities from the catalog by entity reference(s)",
@@ -45,17 +45,13 @@ function createFetchCatalogEntityAction(options) {
45
45
  }
46
46
  throw new Error("Missing entity reference or references");
47
47
  }
48
- const { token } = await auth?.getPluginRequestToken({
49
- onBehalfOf: await ctx.getInitiatorCredentials(),
50
- targetPluginId: "catalog"
51
- }) ?? { token: ctx.secrets?.backstageToken };
52
48
  if (entityRef) {
53
- const entity = await catalogClient.getEntityByRef(
49
+ const entity = await catalog.getEntityByRef(
54
50
  catalogModel.stringifyEntityRef(
55
51
  catalogModel.parseEntityRef(entityRef, { defaultKind, defaultNamespace })
56
52
  ),
57
53
  {
58
- token
54
+ credentials: await ctx.getInitiatorCredentials()
59
55
  }
60
56
  );
61
57
  if (!entity && !optional) {
@@ -64,7 +60,7 @@ function createFetchCatalogEntityAction(options) {
64
60
  ctx.output("entity", entity ?? null);
65
61
  }
66
62
  if (entityRefs) {
67
- const entities = await catalogClient.getEntitiesByRefs(
63
+ const entities = await catalog.getEntitiesByRefs(
68
64
  {
69
65
  entityRefs: entityRefs.map(
70
66
  (ref) => catalogModel.stringifyEntityRef(
@@ -72,9 +68,7 @@ function createFetchCatalogEntityAction(options) {
72
68
  )
73
69
  )
74
70
  },
75
- {
76
- token
77
- }
71
+ { credentials: await ctx.getInitiatorCredentials() }
78
72
  );
79
73
  const finalEntities = entities.items.map((e, i) => {
80
74
  if (!e && !optional) {
@@ -1 +1 @@
1
- {"version":3,"file":"fetch.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/fetch.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { CatalogApi } from '@backstage/catalog-client';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { parseEntityRef, stringifyEntityRef } from '@backstage/catalog-model';\nimport { examples } from './fetch.examples';\nimport { AuthService } from '@backstage/backend-plugin-api';\n\nconst id = 'catalog:fetch';\n\n/**\n * Returns entity or entities from the catalog by entity reference(s).\n *\n * @public\n */\nexport function createFetchCatalogEntityAction(options: {\n catalogClient: CatalogApi;\n auth?: AuthService;\n}) {\n const { catalogClient, auth } = options;\n\n return createTemplateAction({\n id,\n description:\n 'Returns entity or entities from the catalog by entity reference(s)',\n examples,\n supportsDryRun: true,\n schema: {\n input: {\n entityRef: z =>\n z\n .string({\n description: 'Entity reference of the entity to get',\n })\n .optional(),\n entityRefs: z =>\n z\n .array(z.string(), {\n description: 'Entity references of the entities to get',\n })\n .optional(),\n optional: z =>\n z\n .boolean({\n description:\n 'Allow the entity or entities to optionally exist. Default: false',\n })\n .optional(),\n defaultKind: z =>\n z.string({ description: 'The default kind' }).optional(),\n defaultNamespace: z =>\n z.string({ description: 'The default namespace' }).optional(),\n },\n output: {\n entity: z =>\n z\n .any({\n description:\n 'Object containing same values used in the Entity schema. Only when used with `entityRef` parameter.',\n })\n .optional(),\n entities: z =>\n z\n .array(\n z.any({\n description:\n 'Array containing objects with same values used in the Entity schema. Only when used with `entityRefs` parameter.',\n }),\n )\n .optional(),\n },\n },\n async handler(ctx) {\n const { entityRef, entityRefs, optional, defaultKind, defaultNamespace } =\n ctx.input;\n\n if (!entityRef && !entityRefs) {\n if (optional) {\n return;\n }\n throw new Error('Missing entity reference or references');\n }\n\n const { token } = (await auth?.getPluginRequestToken({\n onBehalfOf: await ctx.getInitiatorCredentials(),\n targetPluginId: 'catalog',\n })) ?? { token: ctx.secrets?.backstageToken };\n\n if (entityRef) {\n const entity = await catalogClient.getEntityByRef(\n stringifyEntityRef(\n parseEntityRef(entityRef, { defaultKind, defaultNamespace }),\n ),\n {\n token,\n },\n );\n\n if (!entity && !optional) {\n throw new Error(`Entity ${entityRef} not found`);\n }\n ctx.output('entity', entity ?? null);\n }\n\n if (entityRefs) {\n const entities = await catalogClient.getEntitiesByRefs(\n {\n entityRefs: entityRefs.map(ref =>\n stringifyEntityRef(\n parseEntityRef(ref, { defaultKind, defaultNamespace }),\n ),\n ),\n },\n {\n token,\n },\n );\n\n const finalEntities = entities.items.map((e, i) => {\n if (!e && !optional) {\n throw new Error(`Entity ${entityRefs[i]} not found`);\n }\n return e ?? null;\n });\n\n ctx.output('entities', finalEntities);\n }\n },\n });\n}\n"],"names":["createTemplateAction","examples","stringifyEntityRef","parseEntityRef"],"mappings":";;;;;;AAsBA,MAAM,EAAK,GAAA,eAAA;AAOJ,SAAS,+BAA+B,OAG5C,EAAA;AACD,EAAM,MAAA,EAAE,aAAe,EAAA,IAAA,EAAS,GAAA,OAAA;AAEhC,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WACE,EAAA,oEAAA;AAAA,cACFC,uBAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,SAAA,EAAW,CACT,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,YAAY,CACV,CAAA,KAAA,CAAA,CACG,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UACjB,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,QAAA,EAAU,CACR,CAAA,KAAA,CAAA,CACG,OAAQ,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,WAAA,EAAa,OACX,CAAE,CAAA,MAAA,CAAO,EAAE,WAAa,EAAA,kBAAA,EAAoB,CAAA,CAAE,QAAS,EAAA;AAAA,QACzD,gBAAA,EAAkB,OAChB,CAAE,CAAA,MAAA,CAAO,EAAE,WAAa,EAAA,uBAAA,EAAyB,CAAA,CAAE,QAAS;AAAA,OAChE;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,MAAA,EAAQ,CACN,CAAA,KAAA,CAAA,CACG,GAAI,CAAA;AAAA,UACH,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,QAAA,EAAU,OACR,CACG,CAAA,KAAA;AAAA,UACC,EAAE,GAAI,CAAA;AAAA,YACJ,WACE,EAAA;AAAA,WACH;AAAA,UAEF,QAAS;AAAA;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,SAAW,EAAA,UAAA,EAAY,UAAU,WAAa,EAAA,gBAAA,KACpD,GAAI,CAAA,KAAA;AAEN,MAAI,IAAA,CAAC,SAAa,IAAA,CAAC,UAAY,EAAA;AAC7B,QAAA,IAAI,QAAU,EAAA;AACZ,UAAA;AAAA;AAEF,QAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA;AAAA;AAG1D,MAAA,MAAM,EAAE,KAAA,EAAW,GAAA,MAAM,MAAM,qBAAsB,CAAA;AAAA,QACnD,UAAA,EAAY,MAAM,GAAA,CAAI,uBAAwB,EAAA;AAAA,QAC9C,cAAgB,EAAA;AAAA,OACjB,CAAM,IAAA,EAAE,KAAO,EAAA,GAAA,CAAI,SAAS,cAAe,EAAA;AAE5C,MAAA,IAAI,SAAW,EAAA;AACb,QAAM,MAAA,MAAA,GAAS,MAAM,aAAc,CAAA,cAAA;AAAA,UACjCC,+BAAA;AAAA,YACEC,2BAAe,CAAA,SAAA,EAAW,EAAE,WAAA,EAAa,kBAAkB;AAAA,WAC7D;AAAA,UACA;AAAA,YACE;AAAA;AACF,SACF;AAEA,QAAI,IAAA,CAAC,MAAU,IAAA,CAAC,QAAU,EAAA;AACxB,UAAA,MAAM,IAAI,KAAA,CAAM,CAAU,OAAA,EAAA,SAAS,CAAY,UAAA,CAAA,CAAA;AAAA;AAEjD,QAAI,GAAA,CAAA,MAAA,CAAO,QAAU,EAAA,MAAA,IAAU,IAAI,CAAA;AAAA;AAGrC,MAAA,IAAI,UAAY,EAAA;AACd,QAAM,MAAA,QAAA,GAAW,MAAM,aAAc,CAAA,iBAAA;AAAA,UACnC;AAAA,YACE,YAAY,UAAW,CAAA,GAAA;AAAA,cAAI,CACzB,GAAA,KAAAD,+BAAA;AAAA,gBACEC,2BAAe,CAAA,GAAA,EAAK,EAAE,WAAA,EAAa,kBAAkB;AAAA;AACvD;AACF,WACF;AAAA,UACA;AAAA,YACE;AAAA;AACF,SACF;AAEA,QAAA,MAAM,gBAAgB,QAAS,CAAA,KAAA,CAAM,GAAI,CAAA,CAAC,GAAG,CAAM,KAAA;AACjD,UAAI,IAAA,CAAC,CAAK,IAAA,CAAC,QAAU,EAAA;AACnB,YAAA,MAAM,IAAI,KAAM,CAAA,CAAA,OAAA,EAAU,UAAW,CAAA,CAAC,CAAC,CAAY,UAAA,CAAA,CAAA;AAAA;AAErD,UAAA,OAAO,CAAK,IAAA,IAAA;AAAA,SACb,CAAA;AAED,QAAI,GAAA,CAAA,MAAA,CAAO,YAAY,aAAa,CAAA;AAAA;AACtC;AACF,GACD,CAAA;AACH;;;;"}
1
+ {"version":3,"file":"fetch.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/fetch.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { parseEntityRef, stringifyEntityRef } from '@backstage/catalog-model';\nimport { examples } from './fetch.examples';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\n\nconst id = 'catalog:fetch';\n\n/**\n * Returns entity or entities from the catalog by entity reference(s).\n *\n * @public\n */\nexport function createFetchCatalogEntityAction(options: {\n catalog: CatalogService;\n}) {\n const { catalog } = options;\n\n return createTemplateAction({\n id,\n description:\n 'Returns entity or entities from the catalog by entity reference(s)',\n examples,\n supportsDryRun: true,\n schema: {\n input: {\n entityRef: z =>\n z\n .string({\n description: 'Entity reference of the entity to get',\n })\n .optional(),\n entityRefs: z =>\n z\n .array(z.string(), {\n description: 'Entity references of the entities to get',\n })\n .optional(),\n optional: z =>\n z\n .boolean({\n description:\n 'Allow the entity or entities to optionally exist. Default: false',\n })\n .optional(),\n defaultKind: z =>\n z.string({ description: 'The default kind' }).optional(),\n defaultNamespace: z =>\n z.string({ description: 'The default namespace' }).optional(),\n },\n output: {\n entity: z =>\n z\n .any({\n description:\n 'Object containing same values used in the Entity schema. Only when used with `entityRef` parameter.',\n })\n .optional(),\n entities: z =>\n z\n .array(\n z.any({\n description:\n 'Array containing objects with same values used in the Entity schema. Only when used with `entityRefs` parameter.',\n }),\n )\n .optional(),\n },\n },\n async handler(ctx) {\n const { entityRef, entityRefs, optional, defaultKind, defaultNamespace } =\n ctx.input;\n\n if (!entityRef && !entityRefs) {\n if (optional) {\n return;\n }\n throw new Error('Missing entity reference or references');\n }\n\n if (entityRef) {\n const entity = await catalog.getEntityByRef(\n stringifyEntityRef(\n parseEntityRef(entityRef, { defaultKind, defaultNamespace }),\n ),\n {\n credentials: await ctx.getInitiatorCredentials(),\n },\n );\n\n if (!entity && !optional) {\n throw new Error(`Entity ${entityRef} not found`);\n }\n ctx.output('entity', entity ?? null);\n }\n\n if (entityRefs) {\n const entities = await catalog.getEntitiesByRefs(\n {\n entityRefs: entityRefs.map(ref =>\n stringifyEntityRef(\n parseEntityRef(ref, { defaultKind, defaultNamespace }),\n ),\n ),\n },\n { credentials: await ctx.getInitiatorCredentials() },\n );\n\n const finalEntities = entities.items.map((e, i) => {\n if (!e && !optional) {\n throw new Error(`Entity ${entityRefs[i]} not found`);\n }\n return e ?? null;\n });\n\n ctx.output('entities', finalEntities);\n }\n },\n });\n}\n"],"names":["createTemplateAction","examples","stringifyEntityRef","parseEntityRef"],"mappings":";;;;;;AAqBA,MAAM,EAAK,GAAA,eAAA;AAOJ,SAAS,+BAA+B,OAE5C,EAAA;AACD,EAAM,MAAA,EAAE,SAAY,GAAA,OAAA;AAEpB,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WACE,EAAA,oEAAA;AAAA,cACFC,uBAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,SAAA,EAAW,CACT,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,YAAY,CACV,CAAA,KAAA,CAAA,CACG,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UACjB,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,QAAA,EAAU,CACR,CAAA,KAAA,CAAA,CACG,OAAQ,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,WAAA,EAAa,OACX,CAAE,CAAA,MAAA,CAAO,EAAE,WAAa,EAAA,kBAAA,EAAoB,CAAA,CAAE,QAAS,EAAA;AAAA,QACzD,gBAAA,EAAkB,OAChB,CAAE,CAAA,MAAA,CAAO,EAAE,WAAa,EAAA,uBAAA,EAAyB,CAAA,CAAE,QAAS;AAAA,OAChE;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,MAAA,EAAQ,CACN,CAAA,KAAA,CAAA,CACG,GAAI,CAAA;AAAA,UACH,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,QAAA,EAAU,OACR,CACG,CAAA,KAAA;AAAA,UACC,EAAE,GAAI,CAAA;AAAA,YACJ,WACE,EAAA;AAAA,WACH;AAAA,UAEF,QAAS;AAAA;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,SAAW,EAAA,UAAA,EAAY,UAAU,WAAa,EAAA,gBAAA,KACpD,GAAI,CAAA,KAAA;AAEN,MAAI,IAAA,CAAC,SAAa,IAAA,CAAC,UAAY,EAAA;AAC7B,QAAA,IAAI,QAAU,EAAA;AACZ,UAAA;AAAA;AAEF,QAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA;AAAA;AAG1D,MAAA,IAAI,SAAW,EAAA;AACb,QAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,cAAA;AAAA,UAC3BC,+BAAA;AAAA,YACEC,2BAAe,CAAA,SAAA,EAAW,EAAE,WAAA,EAAa,kBAAkB;AAAA,WAC7D;AAAA,UACA;AAAA,YACE,WAAA,EAAa,MAAM,GAAA,CAAI,uBAAwB;AAAA;AACjD,SACF;AAEA,QAAI,IAAA,CAAC,MAAU,IAAA,CAAC,QAAU,EAAA;AACxB,UAAA,MAAM,IAAI,KAAA,CAAM,CAAU,OAAA,EAAA,SAAS,CAAY,UAAA,CAAA,CAAA;AAAA;AAEjD,QAAI,GAAA,CAAA,MAAA,CAAO,QAAU,EAAA,MAAA,IAAU,IAAI,CAAA;AAAA;AAGrC,MAAA,IAAI,UAAY,EAAA;AACd,QAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,iBAAA;AAAA,UAC7B;AAAA,YACE,YAAY,UAAW,CAAA,GAAA;AAAA,cAAI,CACzB,GAAA,KAAAD,+BAAA;AAAA,gBACEC,2BAAe,CAAA,GAAA,EAAK,EAAE,WAAA,EAAa,kBAAkB;AAAA;AACvD;AACF,WACF;AAAA,UACA,EAAE,WAAA,EAAa,MAAM,GAAA,CAAI,yBAA0B;AAAA,SACrD;AAEA,QAAA,MAAM,gBAAgB,QAAS,CAAA,KAAA,CAAM,GAAI,CAAA,CAAC,GAAG,CAAM,KAAA;AACjD,UAAI,IAAA,CAAC,CAAK,IAAA,CAAC,QAAU,EAAA;AACnB,YAAA,MAAM,IAAI,KAAM,CAAA,CAAA,OAAA,EAAU,UAAW,CAAA,CAAC,CAAC,CAAY,UAAA,CAAA,CAAA;AAAA;AAErD,UAAA,OAAO,CAAK,IAAA,IAAA;AAAA,SACb,CAAA;AAED,QAAI,GAAA,CAAA,MAAA,CAAO,YAAY,aAAa,CAAA;AAAA;AACtC;AACF,GACD,CAAA;AACH;;;;"}