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

package/dist/alpha.d.ts

@@ -0,0 +1,31 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { TemplateAction } from '@backstage/plugin-scaffolder-node';
+import { TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-scaffolder-backend';
+
+/**
+ * Registers support for the Template kind to the catalog backend plugin.
+ *
+ * @alpha
+ */
+declare const catalogModuleTemplateKind: () => _backstage_backend_plugin_api.BackendFeature;
+
+/**
+ * Catalog plugin options
+ *
+ * @alpha
+ */
+declare type ScaffolderPluginOptions = {
+    actions?: TemplateAction<any>[];
+    taskWorkers?: number;
+    taskBroker?: TaskBroker;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
+};
+/**
+ * Catalog plugin
+ *
+ * @alpha
+ */
+declare const scaffolderPlugin: (options: ScaffolderPluginOptions) => _backstage_backend_plugin_api.BackendFeature;
+
+export { ScaffolderPluginOptions, catalogModuleTemplateKind, scaffolderPlugin };

package/dist/index.cjs.js

@@ -8,6 +8,7 @@ var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
 var yaml = require('yaml');
 var fs = require('fs-extra');
 var backendCommon = require('@backstage/backend-common');
+var zod = require('zod');
 var integration = require('@backstage/integration');
 var path = require('path');
 var globby = require('globby');
@@ -36,12 +37,9 @@ var promClient = require('prom-client');
 var pluginScaffolderCommon = require('@backstage/plugin-scaffolder-common');
 var express = require('express');
 var Router = require('express-promise-router');
-var zod = require('zod');
 var url = require('url');
 var os = require('os');
 var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
-var backendPluginApi = require('@backstage/backend-plugin-api');
-var pluginCatalogNode = require('@backstage/plugin-catalog-node');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -254,24 +252,16 @@ function createCatalogWriteAction() {
   return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Writes the catalog-info.yaml for your template",
-    examples: examples$2,
     schema: {
-      input: {
-        type: "object",
-        properties: {
-          filePath: {
-            title: "Catalog file path",
-            description: "Defaults to catalog-info.yaml",
-            type: "string"
-          },
-          entity: {
-            title: "Entity info to write catalog-info.yaml",
-            description: "You can provide the same values used in the Entity schema.",
-            type: "object"
-          }
-        }
-      }
+      input: zod.z.object({
+        filePath: zod.z.string().optional().describe("Defaults to catalog-info.yaml"),
+        // TODO: this should reference an zod entity validator if it existed.
+        entity: zod.z.object({}).describe(
+          "You can provide the same values used in the Entity schema."
+        )
+      })
     },
+    examples: examples$2,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -350,6 +340,9 @@ function createFetchCatalogEntityAction(options) {
           throw e;
         }
       }
+      if (!entity && !optional) {
+        throw new Error(`Entity ${entityRef} not found`);
+      }
       ctx.output("entity", entity != null ? entity : null);
     }
   });
@@ -5640,115 +5633,6 @@ class ScaffolderEntitiesProcessor {
   }
 }
 
-const catalogModuleTemplateKind = backendPluginApi.createBackendModule({
-  moduleId: "scaffolder",
-  pluginId: "templateKind",
-  register(env) {
-    env.registerInit({
-      deps: {
-        catalog: pluginCatalogNode.catalogProcessingExtensionPoint
-      },
-      async init({ catalog }) {
-        catalog.addProcessor(new ScaffolderEntitiesProcessor());
-      }
-    });
-  }
-});
-
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var _actions;
-class ScaffolderActionsExtensionPointImpl {
-  constructor() {
-    __privateAdd(this, _actions, new Array());
-  }
-  addActions(...actions) {
-    __privateGet(this, _actions).push(...actions);
-  }
-  get actions() {
-    return __privateGet(this, _actions);
-  }
-}
-_actions = new WeakMap();
-const scaffolderPlugin = backendPluginApi.createBackendPlugin(
-  (options) => ({
-    pluginId: "scaffolder",
-    register(env) {
-      const actionsExtensions = new ScaffolderActionsExtensionPointImpl();
-      env.registerExtensionPoint(
-        pluginScaffolderNode.scaffolderActionsExtensionPoint,
-        actionsExtensions
-      );
-      env.registerInit({
-        deps: {
-          logger: backendPluginApi.coreServices.logger,
-          config: backendPluginApi.coreServices.config,
-          reader: backendPluginApi.coreServices.urlReader,
-          permissions: backendPluginApi.coreServices.permissions,
-          database: backendPluginApi.coreServices.database,
-          httpRouter: backendPluginApi.coreServices.httpRouter,
-          catalogClient: pluginCatalogNode.catalogServiceRef
-        },
-        async init({
-          logger,
-          config,
-          reader,
-          database,
-          httpRouter,
-          catalogClient
-        }) {
-          const {
-            additionalTemplateFilters,
-            taskBroker,
-            taskWorkers,
-            additionalTemplateGlobals
-          } = options;
-          const log = backendCommon.loggerToWinstonLogger(logger);
-          const actions = options.actions || [
-            ...actionsExtensions.actions,
-            ...createBuiltinActions({
-              integrations: integration.ScmIntegrations.fromConfig(config),
-              catalogClient,
-              reader,
-              config,
-              additionalTemplateFilters,
-              additionalTemplateGlobals
-            })
-          ];
-          const actionIds = actions.map((action) => action.id).join(", ");
-          log.info(
-            `Starting scaffolder with the following actions enabled ${actionIds}`
-          );
-          const router = await createRouter({
-            logger: log,
-            config,
-            database,
-            catalogClient,
-            reader,
-            actions,
-            taskBroker,
-            taskWorkers,
-            additionalTemplateFilters,
-            additionalTemplateGlobals
-          });
-          httpRouter.use(router);
-        }
-      });
-    }
-  })
-);
-
 const createTemplateAction = pluginScaffolderNode.createTemplateAction;
 
 exports.DatabaseTaskStore = DatabaseTaskStore;
@@ -5756,7 +5640,6 @@ exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
 exports.TaskManager = TaskManager;
 exports.TaskWorker = TaskWorker;
 exports.TemplateActionRegistry = TemplateActionRegistry;
-exports.catalogModuleTemplateKind = catalogModuleTemplateKind;
 exports.createBuiltinActions = createBuiltinActions;
 exports.createCatalogRegisterAction = createCatalogRegisterAction;
 exports.createCatalogWriteAction = createCatalogWriteAction;
@@ -5785,5 +5668,4 @@ exports.createRouter = createRouter;
 exports.createTemplateAction = createTemplateAction;
 exports.executeShellCommand = executeShellCommand;
 exports.fetchContents = fetchContents;
-exports.scaffolderPlugin = scaffolderPlugin;
 //# sourceMappingURL=index.cjs.js.map