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

package/dist/index.cjs.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var errors = require('@backstage/errors');
 var catalogModel = require('@backstage/catalog-model');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
 var yaml = require('yaml');
 var fs = require('fs-extra');
 var backendCommon = require('@backstage/backend-common');
@@ -78,10 +79,6 @@ var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
 var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
-const createTemplateAction = (templateAction) => {
-  return templateAction;
-};
-
 const id$3 = "catalog:register";
 const examples$3 = [
   {
@@ -102,7 +99,7 @@ const examples$3 = [
 ];
 function createCatalogRegisterAction(options) {
   const { catalogClient, integrations } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: id$3,
     description: "Registers entities from a catalog descriptor file in the workspace into the software catalog.",
     examples: examples$3,
@@ -254,7 +251,7 @@ const examples$2 = [
   }
 ];
 function createCatalogWriteAction() {
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Writes the catalog-info.yaml for your template",
     examples: examples$2,
@@ -308,7 +305,7 @@ const examples$1 = [
 ];
 function createFetchCatalogEntityAction(options) {
   const { catalogClient } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: id$1,
     description: "Returns entity from the catalog by entity reference",
     examples: examples$1,
@@ -392,7 +389,7 @@ const examples = [
   }
 ];
 function createDebugLogAction() {
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Writes a message into the log or lists all files in the workspace.",
     examples,
@@ -480,7 +477,7 @@ async function fetchContents(options) {
 
 function createFetchPlainAction(options) {
   const { reader, integrations } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "fetch:plain",
     description: "Downloads content and places it in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
     schema: {
@@ -665,7 +662,7 @@ function createFetchTemplateAction(options) {
     additionalTemplateFilters,
     additionalTemplateGlobals
   } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "fetch:template",
     description: "Downloads a skeleton, templates variables into file and directory names and content, and places the result in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
     schema: {
@@ -713,6 +710,11 @@ function createFetchTemplateAction(options) {
             title: "Template File Extension",
             description: "If set, only files with the given extension will be templated. If set to `true`, the default extension `.njk` is used.",
             type: ["string", "boolean"]
+          },
+          replace: {
+            title: "Replace files",
+            description: "If set, replace files in targetPath instead of skipping existing ones.",
+            type: "boolean"
           }
         }
       }
@@ -821,7 +823,7 @@ function createFetchTemplateAction(options) {
           continue;
         }
         const outputPath = backendCommon.resolveSafeChildPath(outputDir, localOutputPath);
-        if (fs__default["default"].existsSync(outputPath)) {
+        if (fs__default["default"].existsSync(outputPath) && !ctx.input.replace) {
           continue;
         }
         if (!renderContents && !extension) {
@@ -865,7 +867,7 @@ function containsSkippedContent(localOutputPath) {
 }
 
 const createFilesystemDeleteAction = () => {
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "fs:delete",
     description: "Deletes files and directories from the workspace",
     schema: {
@@ -905,7 +907,7 @@ const createFilesystemDeleteAction = () => {
 };
 
 const createFilesystemRenameAction = () => {
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "fs:rename",
     description: "Renames files and directories within the workspace",
     schema: {
@@ -1428,7 +1430,7 @@ function extractCollaboratorName(collaborator) {
 
 function createGithubActionsDispatchAction(options) {
   const { integrations, githubCredentialsProvider } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "github:actions:dispatch",
     description: "Dispatches a GitHub Action workflow for a given branch or tag",
     schema: {
@@ -1501,7 +1503,7 @@ function createGithubActionsDispatchAction(options) {
 
 function createGithubIssuesLabelAction(options) {
   const { integrations, githubCredentialsProvider } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "github:issues:label",
     description: "Adds labels to a pull request or issue on GitHub.",
     schema: {
@@ -1814,7 +1816,7 @@ const repoContentsUrl = {
 
 function createGithubRepoCreateAction(options) {
   const { integrations, githubCredentialsProvider } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
     schema: {
@@ -1919,7 +1921,7 @@ function createGithubRepoCreateAction(options) {
 
 function createGithubRepoPushAction(options) {
   const { integrations, config, githubCredentialsProvider } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:push",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
     schema: {
@@ -2024,7 +2026,7 @@ function createGithubRepoPushAction(options) {
 function createGithubWebhookAction(options) {
   const { integrations, defaultWebhookSecret, githubCredentialsProvider } = options;
   const eventNames = webhooks.emitterEventNames.filter((event) => !event.includes("."));
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "github:webhook",
     description: "Creates webhook for a repository on GitHub.",
     schema: {
@@ -2141,7 +2143,7 @@ function createGithubWebhookAction(options) {
 
 function createPublishAzureAction(options) {
   const { integrations, config } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:azure",
     description: "Initializes a git repository of the content in the workspace, and publishes it to Azure.",
     schema: {
@@ -2404,7 +2406,7 @@ const performEnableLFS$1 = async (opts) => {
 };
 function createPublishBitbucketAction(options) {
   const { integrations, config } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:bitbucket",
     description: "Initializes a git repository of the content in the workspace, and publishes it to Bitbucket.",
     schema: {
@@ -2631,7 +2633,7 @@ const getAuthorizationHeader = (config) => {
 };
 function createPublishBitbucketCloudAction(options) {
   const { integrations, config } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:bitbucketCloud",
     description: "Initializes a git repository of the content in the workspace, and publishes it to Bitbucket Cloud.",
     schema: {
@@ -2825,7 +2827,7 @@ const performEnableLFS = async (opts) => {
 };
 function createPublishBitbucketServerAction(options) {
   const { integrations, config } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:bitbucketServer",
     description: "Initializes a git repository of the content in the workspace, and publishes it to Bitbucket Server.",
     schema: {
@@ -3005,7 +3007,7 @@ Change-Id: I${changeId}`;
 };
 function createPublishGerritAction(options) {
   const { integrations, config } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:gerrit",
     description: "Initializes a git repository of the content in the workspace, and publishes it to Gerrit.",
     schema: {
@@ -3124,7 +3126,7 @@ const generateGerritChangeId = () => {
 };
 function createPublishGerritReviewAction(options) {
   const { integrations, config } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:gerrit:review",
     description: "Creates a new Gerrit review.",
     schema: {
@@ -3229,7 +3231,7 @@ Change-Id: ${changeId}`;
 
 function createPublishGithubAction(options) {
   const { integrations, config, githubCredentialsProvider } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:github",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
     schema: {
@@ -3478,7 +3480,7 @@ const createPublishGithubPullRequestAction = ({
   githubCredentialsProvider,
   clientFactory = defaultClientFactory
 }) => {
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:github:pull-request",
     schema: {
       input: {
@@ -3680,7 +3682,7 @@ const createPublishGithubPullRequestAction = ({
 
 function createPublishGitlabAction(options) {
   const { integrations, config } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:gitlab",
     description: "Initializes a git repository of the content in the workspace, and publishes it to GitLab.",
     schema: {
@@ -3837,7 +3839,7 @@ function createPublishGitlabAction(options) {
 
 const createPublishGitlabMergeRequestAction = (options) => {
   const { integrations } = options;
-  return createTemplateAction({
+  return pluginScaffolderNode.createTemplateAction({
     id: "publish:gitlab:merge-request",
     schema: {
       input: {
@@ -5055,7 +5057,7 @@ function createDryRunner(options) {
     const workflowRunner = new NunjucksWorkflowRunner({
       ...options,
       actionRegistry: new DecoratedActionsRegistry(options.actionRegistry, [
-        createTemplateAction({
+        pluginScaffolderNode.createTemplateAction({
           id: "dry-run:extract",
           supportsDryRun: true,
           async handler(ctx) {
@@ -5620,9 +5622,9 @@ class ScaffolderEntitiesProcessor {
   }
 }
 
-const scaffolderCatalogModule = backendPluginApi.createBackendModule({
+const catalogModuleTemplateKind = backendPluginApi.createBackendModule({
   moduleId: "scaffolder",
-  pluginId: "catalog",
+  pluginId: "templateKind",
   register(env) {
     env.registerInit({
       deps: {
@@ -5661,16 +5663,13 @@ class ScaffolderActionsExtensionPointImpl {
   }
 }
 _actions = new WeakMap();
-const scaffolderActionsExtensionPoint = backendPluginApi.createExtensionPoint({
-  id: "scaffolder.actions"
-});
 const scaffolderPlugin = backendPluginApi.createBackendPlugin(
   (options) => ({
     id: "scaffolder",
     register(env) {
       const actionsExtensions = new ScaffolderActionsExtensionPointImpl();
       env.registerExtensionPoint(
-        scaffolderActionsExtensionPoint,
+        pluginScaffolderNode.scaffolderActionsExtensionPoint,
         actionsExtensions
       );
       env.registerInit({
@@ -5732,11 +5731,14 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin(
   })
 );
 
+const createTemplateAction = pluginScaffolderNode.createTemplateAction;
+
 exports.DatabaseTaskStore = DatabaseTaskStore;
 exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
 exports.TaskManager = TaskManager;
 exports.TaskWorker = TaskWorker;
 exports.TemplateActionRegistry = TemplateActionRegistry;
+exports.catalogModuleTemplateKind = catalogModuleTemplateKind;
 exports.createBuiltinActions = createBuiltinActions;
 exports.createCatalogRegisterAction = createCatalogRegisterAction;
 exports.createCatalogWriteAction = createCatalogWriteAction;
@@ -5765,6 +5767,5 @@ exports.createRouter = createRouter;
 exports.createTemplateAction = createTemplateAction;
 exports.executeShellCommand = executeShellCommand;
 exports.fetchContents = fetchContents;
-exports.scaffolderCatalogModule = scaffolderCatalogModule;
 exports.scaffolderPlugin = scaffolderPlugin;
 //# sourceMappingURL=index.cjs.js.map