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

package/dist/scaffolder/actions/builtin/fetch/template.cjs.js

@@ -0,0 +1,241 @@
+'use strict';
+
+var path = require('path');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var errors = require('@backstage/errors');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var globby = require('globby');
+var fs = require('fs-extra');
+var isbinaryfile = require('isbinaryfile');
+var SecureTemplater = require('../../../../lib/templating/SecureTemplater.cjs.js');
+var filters = require('../../../../lib/templating/filters.cjs.js');
+var template_examples = require('./template.examples.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var globby__default = /*#__PURE__*/_interopDefaultCompat(globby);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+function createFetchTemplateAction(options) {
+  const {
+    reader,
+    integrations,
+    additionalTemplateFilters,
+    additionalTemplateGlobals
+  } = options;
+  const defaultTemplateFilters = filters.createDefaultFilters({ integrations });
+  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.",
+    examples: template_examples.examples,
+    schema: {
+      input: {
+        type: "object",
+        required: ["url"],
+        properties: {
+          url: {
+            title: "Fetch URL",
+            description: "Relative path or absolute URL pointing to the directory tree to fetch",
+            type: "string"
+          },
+          targetPath: {
+            title: "Target Path",
+            description: "Target path within the working directory to download the contents to. Defaults to the working directory root.",
+            type: "string"
+          },
+          values: {
+            title: "Template Values",
+            description: "Values to pass on to the templating engine",
+            type: "object"
+          },
+          copyWithoutRender: {
+            title: "[Deprecated] Copy Without Render",
+            description: "An array of glob patterns. Any files or directories which match are copied without being processed as templates.",
+            type: "array",
+            items: {
+              type: "string"
+            }
+          },
+          copyWithoutTemplating: {
+            title: "Copy Without Templating",
+            description: "An array of glob patterns. Contents of matched files or directories are copied without being processed, but paths are subject to rendering.",
+            type: "array",
+            items: {
+              type: "string"
+            }
+          },
+          cookiecutterCompat: {
+            title: "Cookiecutter compatibility mode",
+            description: "Enable features to maximise compatibility with templates built for fetch:cookiecutter",
+            type: "boolean"
+          },
+          templateFileExtension: {
+            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"
+          },
+          token: {
+            title: "Token",
+            description: "An optional token to use for authentication when reading the resources.",
+            type: "string"
+          }
+        }
+      }
+    },
+    supportsDryRun: true,
+    async handler(ctx) {
+      ctx.logger.info("Fetching template content from remote URL");
+      const workDir = await ctx.createTemporaryDirectory();
+      const templateDir = backendPluginApi.resolveSafeChildPath(workDir, "template");
+      const targetPath = ctx.input.targetPath ?? "./";
+      const outputDir = backendPluginApi.resolveSafeChildPath(ctx.workspacePath, targetPath);
+      if (ctx.input.copyWithoutRender && ctx.input.copyWithoutTemplating) {
+        throw new errors.InputError(
+          "Fetch action input copyWithoutRender and copyWithoutTemplating can not be used at the same time"
+        );
+      }
+      let copyOnlyPatterns;
+      let renderFilename;
+      if (ctx.input.copyWithoutRender) {
+        ctx.logger.warn(
+          "[Deprecated] copyWithoutRender is deprecated Please use copyWithoutTemplating instead."
+        );
+        copyOnlyPatterns = ctx.input.copyWithoutRender;
+        renderFilename = false;
+      } else {
+        copyOnlyPatterns = ctx.input.copyWithoutTemplating;
+        renderFilename = true;
+      }
+      if (copyOnlyPatterns && !Array.isArray(copyOnlyPatterns)) {
+        throw new errors.InputError(
+          "Fetch action input copyWithoutRender/copyWithoutTemplating must be an Array"
+        );
+      }
+      if (ctx.input.templateFileExtension && (copyOnlyPatterns || ctx.input.cookiecutterCompat)) {
+        throw new errors.InputError(
+          "Fetch action input extension incompatible with copyWithoutRender/copyWithoutTemplating and cookiecutterCompat"
+        );
+      }
+      let extension = false;
+      if (ctx.input.templateFileExtension) {
+        extension = ctx.input.templateFileExtension === true ? ".njk" : ctx.input.templateFileExtension;
+        if (!extension.startsWith(".")) {
+          extension = `.${extension}`;
+        }
+      }
+      await pluginScaffolderNode.fetchContents({
+        reader,
+        integrations,
+        baseUrl: ctx.templateInfo?.baseUrl,
+        fetchUrl: ctx.input.url,
+        outputPath: templateDir,
+        token: ctx.input.token
+      });
+      ctx.logger.info("Listing files and directories in template");
+      const allEntriesInTemplate = await globby__default.default(`**/*`, {
+        cwd: templateDir,
+        dot: true,
+        onlyFiles: false,
+        markDirectories: true,
+        followSymbolicLinks: false
+      });
+      const nonTemplatedEntries = new Set(
+        await globby__default.default(copyOnlyPatterns || [], {
+          cwd: templateDir,
+          dot: true,
+          onlyFiles: false,
+          markDirectories: true,
+          followSymbolicLinks: false
+        })
+      );
+      const { cookiecutterCompat, values } = ctx.input;
+      const context = {
+        [cookiecutterCompat ? "cookiecutter" : "values"]: values
+      };
+      ctx.logger.info(
+        `Processing ${allEntriesInTemplate.length} template files/directories with input values`,
+        ctx.input.values
+      );
+      const renderTemplate = await SecureTemplater.SecureTemplater.loadRenderer({
+        cookiecutterCompat: ctx.input.cookiecutterCompat,
+        templateFilters: {
+          ...defaultTemplateFilters,
+          ...additionalTemplateFilters
+        },
+        templateGlobals: additionalTemplateGlobals,
+        nunjucksConfigs: {
+          trimBlocks: ctx.input.trimBlocks,
+          lstripBlocks: ctx.input.lstripBlocks
+        }
+      });
+      for (const location of allEntriesInTemplate) {
+        let renderContents;
+        let localOutputPath = location;
+        if (extension) {
+          renderContents = path.extname(localOutputPath) === extension;
+          if (renderContents) {
+            localOutputPath = localOutputPath.slice(0, -extension.length);
+          }
+          localOutputPath = renderTemplate(localOutputPath, context);
+        } else {
+          renderContents = !nonTemplatedEntries.has(location);
+          if (renderFilename) {
+            localOutputPath = renderTemplate(localOutputPath, context);
+          } else {
+            localOutputPath = renderContents ? renderTemplate(localOutputPath, context) : localOutputPath;
+          }
+        }
+        if (containsSkippedContent(localOutputPath)) {
+          continue;
+        }
+        const outputPath = backendPluginApi.resolveSafeChildPath(outputDir, localOutputPath);
+        if (fs__default.default.existsSync(outputPath) && !ctx.input.replace) {
+          continue;
+        }
+        if (!renderContents && !extension) {
+          ctx.logger.info(
+            `Copying file/directory ${location} without processing.`
+          );
+        }
+        if (location.endsWith("/")) {
+          ctx.logger.info(
+            `Writing directory ${location} to template output path.`
+          );
+          await fs__default.default.ensureDir(outputPath);
+        } else {
+          const inputFilePath = backendPluginApi.resolveSafeChildPath(templateDir, location);
+          const stats = await fs__default.default.promises.lstat(inputFilePath);
+          if (stats.isSymbolicLink() || await isbinaryfile.isBinaryFile(inputFilePath)) {
+            ctx.logger.info(
+              `Copying file binary or symbolic link at ${location}, to template output path.`
+            );
+            await fs__default.default.copy(inputFilePath, outputPath);
+          } else {
+            const statsObj = await fs__default.default.stat(inputFilePath);
+            ctx.logger.info(
+              `Writing file ${location} to template output path with mode ${statsObj.mode}.`
+            );
+            const inputFileContents = await fs__default.default.readFile(inputFilePath, "utf-8");
+            await fs__default.default.outputFile(
+              outputPath,
+              renderContents ? renderTemplate(inputFileContents, context) : inputFileContents,
+              { mode: statsObj.mode }
+            );
+          }
+        }
+      }
+      ctx.logger.info(`Template result written to ${outputDir}`);
+    }
+  });
+}
+function containsSkippedContent(localOutputPath) {
+  return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
+}
+
+exports.createFetchTemplateAction = createFetchTemplateAction;
+//# sourceMappingURL=template.cjs.js.map

package/dist/scaffolder/actions/builtin/fetch/template.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/fetch/template.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 { extname } from 'path';\nimport { UrlReaderService } from '@backstage/backend-plugin-api';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport {\n  createTemplateAction,\n  fetchContents,\n  TemplateFilter,\n  TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport globby from 'globby';\nimport fs from 'fs-extra';\nimport { isBinaryFile } from 'isbinaryfile';\nimport { SecureTemplater } from '../../../../lib/templating/SecureTemplater';\nimport { createDefaultFilters } from '../../../../lib/templating/filters';\nimport { examples } from './template.examples';\n\n/**\n * Downloads a skeleton, templates variables into file and directory names and content.\n * Then places the result in the workspace, or optionally in a subdirectory\n * specified by the 'targetPath' input option.\n *\n * @public\n */\nexport function createFetchTemplateAction(options: {\n  reader: UrlReaderService;\n  integrations: ScmIntegrations;\n  additionalTemplateFilters?: Record<string, TemplateFilter>;\n  additionalTemplateGlobals?: Record<string, TemplateGlobal>;\n}) {\n  const {\n    reader,\n    integrations,\n    additionalTemplateFilters,\n    additionalTemplateGlobals,\n  } = options;\n\n  const defaultTemplateFilters = createDefaultFilters({ integrations });\n\n  return createTemplateAction<{\n    url: string;\n    targetPath?: string;\n    values: any;\n    templateFileExtension?: string | boolean;\n\n    // Cookiecutter compat options\n    /**\n     * @deprecated This field is deprecated in favor of copyWithoutTemplating.\n     */\n    copyWithoutRender?: string[];\n    copyWithoutTemplating?: string[];\n    cookiecutterCompat?: boolean;\n    replace?: boolean;\n    trimBlocks?: boolean;\n    lstripBlocks?: boolean;\n    token?: string;\n  }>({\n    id: 'fetch:template',\n    description:\n      '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.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['url'],\n        properties: {\n          url: {\n            title: 'Fetch URL',\n            description:\n              'Relative path or absolute URL pointing to the directory tree to fetch',\n            type: 'string',\n          },\n          targetPath: {\n            title: 'Target Path',\n            description:\n              'Target path within the working directory to download the contents to. Defaults to the working directory root.',\n            type: 'string',\n          },\n          values: {\n            title: 'Template Values',\n            description: 'Values to pass on to the templating engine',\n            type: 'object',\n          },\n          copyWithoutRender: {\n            title: '[Deprecated] Copy Without Render',\n            description:\n              'An array of glob patterns. Any files or directories which match are copied without being processed as templates.',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          copyWithoutTemplating: {\n            title: 'Copy Without Templating',\n            description:\n              'An array of glob patterns. Contents of matched files or directories are copied without being processed, but paths are subject to rendering.',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          cookiecutterCompat: {\n            title: 'Cookiecutter compatibility mode',\n            description:\n              'Enable features to maximise compatibility with templates built for fetch:cookiecutter',\n            type: 'boolean',\n          },\n          templateFileExtension: {\n            title: 'Template File Extension',\n            description:\n              'If set, only files with the given extension will be templated. If set to `true`, the default extension `.njk` is used.',\n            type: ['string', 'boolean'],\n          },\n          replace: {\n            title: 'Replace files',\n            description:\n              'If set, replace files in targetPath instead of skipping existing ones.',\n            type: 'boolean',\n          },\n          token: {\n            title: 'Token',\n            description:\n              'An optional token to use for authentication when reading the resources.',\n            type: 'string',\n          },\n        },\n      },\n    },\n    supportsDryRun: true,\n    async handler(ctx) {\n      ctx.logger.info('Fetching template content from remote URL');\n\n      const workDir = await ctx.createTemporaryDirectory();\n      const templateDir = resolveSafeChildPath(workDir, 'template');\n\n      const targetPath = ctx.input.targetPath ?? './';\n      const outputDir = resolveSafeChildPath(ctx.workspacePath, targetPath);\n      if (ctx.input.copyWithoutRender && ctx.input.copyWithoutTemplating) {\n        throw new InputError(\n          'Fetch action input copyWithoutRender and copyWithoutTemplating can not be used at the same time',\n        );\n      }\n\n      let copyOnlyPatterns: string[] | undefined;\n      let renderFilename: boolean;\n      if (ctx.input.copyWithoutRender) {\n        ctx.logger.warn(\n          '[Deprecated] copyWithoutRender is deprecated Please use copyWithoutTemplating instead.',\n        );\n        copyOnlyPatterns = ctx.input.copyWithoutRender;\n        renderFilename = false;\n      } else {\n        copyOnlyPatterns = ctx.input.copyWithoutTemplating;\n        renderFilename = true;\n      }\n\n      if (copyOnlyPatterns && !Array.isArray(copyOnlyPatterns)) {\n        throw new InputError(\n          'Fetch action input copyWithoutRender/copyWithoutTemplating must be an Array',\n        );\n      }\n\n      if (\n        ctx.input.templateFileExtension &&\n        (copyOnlyPatterns || ctx.input.cookiecutterCompat)\n      ) {\n        throw new InputError(\n          'Fetch action input extension incompatible with copyWithoutRender/copyWithoutTemplating and cookiecutterCompat',\n        );\n      }\n\n      let extension: string | false = false;\n      if (ctx.input.templateFileExtension) {\n        extension =\n          ctx.input.templateFileExtension === true\n            ? '.njk'\n            : ctx.input.templateFileExtension;\n        if (!extension.startsWith('.')) {\n          extension = `.${extension}`;\n        }\n      }\n\n      await fetchContents({\n        reader,\n        integrations,\n        baseUrl: ctx.templateInfo?.baseUrl,\n        fetchUrl: ctx.input.url,\n        outputPath: templateDir,\n        token: ctx.input.token,\n      });\n\n      ctx.logger.info('Listing files and directories in template');\n      const allEntriesInTemplate = await globby(`**/*`, {\n        cwd: templateDir,\n        dot: true,\n        onlyFiles: false,\n        markDirectories: true,\n        followSymbolicLinks: false,\n      });\n\n      const nonTemplatedEntries = new Set(\n        await globby(copyOnlyPatterns || [], {\n          cwd: templateDir,\n          dot: true,\n          onlyFiles: false,\n          markDirectories: true,\n          followSymbolicLinks: false,\n        }),\n      );\n\n      // Cookiecutter prefixes all parameters in templates with\n      // `cookiecutter.`. To replicate this, we wrap our parameters\n      // in an object with a `cookiecutter` property when compat\n      // mode is enabled.\n      const { cookiecutterCompat, values } = ctx.input;\n      const context = {\n        [cookiecutterCompat ? 'cookiecutter' : 'values']: values,\n      };\n\n      ctx.logger.info(\n        `Processing ${allEntriesInTemplate.length} template files/directories with input values`,\n        ctx.input.values,\n      );\n\n      const renderTemplate = await SecureTemplater.loadRenderer({\n        cookiecutterCompat: ctx.input.cookiecutterCompat,\n        templateFilters: {\n          ...defaultTemplateFilters,\n          ...additionalTemplateFilters,\n        },\n        templateGlobals: additionalTemplateGlobals,\n        nunjucksConfigs: {\n          trimBlocks: ctx.input.trimBlocks,\n          lstripBlocks: ctx.input.lstripBlocks,\n        },\n      });\n\n      for (const location of allEntriesInTemplate) {\n        let renderContents: boolean;\n\n        let localOutputPath = location;\n        if (extension) {\n          renderContents = extname(localOutputPath) === extension;\n          if (renderContents) {\n            localOutputPath = localOutputPath.slice(0, -extension.length);\n          }\n          // extension is mutual exclusive with copyWithoutRender/copyWithoutTemplating,\n          // therefore the output path is always rendered.\n          localOutputPath = renderTemplate(localOutputPath, context);\n        } else {\n          renderContents = !nonTemplatedEntries.has(location);\n          // The logic here is a bit tangled because it depends on two variables.\n          // If renderFilename is true, which means copyWithoutTemplating is used,\n          // then the path is always rendered.\n          // If renderFilename is false, which means copyWithoutRender is used,\n          // then matched file/directory won't be processed, same as before.\n          if (renderFilename) {\n            localOutputPath = renderTemplate(localOutputPath, context);\n          } else {\n            localOutputPath = renderContents\n              ? renderTemplate(localOutputPath, context)\n              : localOutputPath;\n          }\n        }\n\n        if (containsSkippedContent(localOutputPath)) {\n          continue;\n        }\n\n        const outputPath = resolveSafeChildPath(outputDir, localOutputPath);\n        if (fs.existsSync(outputPath) && !ctx.input.replace) {\n          continue;\n        }\n\n        if (!renderContents && !extension) {\n          ctx.logger.info(\n            `Copying file/directory ${location} without processing.`,\n          );\n        }\n\n        if (location.endsWith('/')) {\n          ctx.logger.info(\n            `Writing directory ${location} to template output path.`,\n          );\n          await fs.ensureDir(outputPath);\n        } else {\n          const inputFilePath = resolveSafeChildPath(templateDir, location);\n          const stats = await fs.promises.lstat(inputFilePath);\n\n          if (stats.isSymbolicLink() || (await isBinaryFile(inputFilePath))) {\n            ctx.logger.info(\n              `Copying file binary or symbolic link at ${location}, to template output path.`,\n            );\n            await fs.copy(inputFilePath, outputPath);\n          } else {\n            const statsObj = await fs.stat(inputFilePath);\n            ctx.logger.info(\n              `Writing file ${location} to template output path with mode ${statsObj.mode}.`,\n            );\n            const inputFileContents = await fs.readFile(inputFilePath, 'utf-8');\n            await fs.outputFile(\n              outputPath,\n              renderContents\n                ? renderTemplate(inputFileContents, context)\n                : inputFileContents,\n              { mode: statsObj.mode },\n            );\n          }\n        }\n      }\n\n      ctx.logger.info(`Template result written to ${outputDir}`);\n    },\n  });\n}\n\nfunction containsSkippedContent(localOutputPath: string): boolean {\n  // if the path is empty means that there is a file skipped in the root\n  // if the path starts with a separator it means that the root directory has been skipped\n  // if the path includes // means that there is a subdirectory skipped\n  // All paths returned are considered with / separator because of globby returning the linux separator for all os'.\n  return (\n    localOutputPath === '' ||\n    localOutputPath.startsWith('/') ||\n    localOutputPath.includes('//')\n  );\n}\n"],"names":["createDefaultFilters","createTemplateAction","examples","resolveSafeChildPath","InputError","fetchContents","globby","SecureTemplater","extname","fs","isBinaryFile"],"mappings":";;;;;;;;;;;;;;;;;;AAyCO,SAAS,0BAA0B,OAKvC,EAAA;AACD,EAAM,MAAA;AAAA,IACJ,MAAA;AAAA,IACA,YAAA;AAAA,IACA,yBAAA;AAAA,IACA,yBAAA;AAAA,GACE,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,sBAAyB,GAAAA,4BAAA,CAAqB,EAAE,YAAA,EAAc,CAAA,CAAA;AAEpE,EAAA,OAAOC,yCAiBJ,CAAA;AAAA,IACD,EAAI,EAAA,gBAAA;AAAA,IACJ,WACE,EAAA,0MAAA;AAAA,cACFC,0BAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,KAAK,CAAA;AAAA,QAChB,UAAY,EAAA;AAAA,UACV,GAAK,EAAA;AAAA,YACH,KAAO,EAAA,WAAA;AAAA,YACP,WACE,EAAA,uEAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WACE,EAAA,+GAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,iBAAA;AAAA,YACP,WAAa,EAAA,4CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,iBAAmB,EAAA;AAAA,YACjB,KAAO,EAAA,kCAAA;AAAA,YACP,WACE,EAAA,kHAAA;AAAA,YACF,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA,QAAA;AAAA,aACR;AAAA,WACF;AAAA,UACA,qBAAuB,EAAA;AAAA,YACrB,KAAO,EAAA,yBAAA;AAAA,YACP,WACE,EAAA,6IAAA;AAAA,YACF,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA,QAAA;AAAA,aACR;AAAA,WACF;AAAA,UACA,kBAAoB,EAAA;AAAA,YAClB,KAAO,EAAA,iCAAA;AAAA,YACP,WACE,EAAA,uFAAA;AAAA,YACF,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,UACA,qBAAuB,EAAA;AAAA,YACrB,KAAO,EAAA,yBAAA;AAAA,YACP,WACE,EAAA,wHAAA;AAAA,YACF,IAAA,EAAM,CAAC,QAAA,EAAU,SAAS,CAAA;AAAA,WAC5B;AAAA,UACA,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,eAAA;AAAA,YACP,WACE,EAAA,wEAAA;AAAA,YACF,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,OAAA;AAAA,YACP,WACE,EAAA,yEAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,2CAA2C,CAAA,CAAA;AAE3D,MAAM,MAAA,OAAA,GAAU,MAAM,GAAA,CAAI,wBAAyB,EAAA,CAAA;AACnD,MAAM,MAAA,WAAA,GAAcC,qCAAqB,CAAA,OAAA,EAAS,UAAU,CAAA,CAAA;AAE5D,MAAM,MAAA,UAAA,GAAa,GAAI,CAAA,KAAA,CAAM,UAAc,IAAA,IAAA,CAAA;AAC3C,MAAA,MAAM,SAAY,GAAAA,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,UAAU,CAAA,CAAA;AACpE,MAAA,IAAI,GAAI,CAAA,KAAA,CAAM,iBAAqB,IAAA,GAAA,CAAI,MAAM,qBAAuB,EAAA;AAClE,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,iGAAA;AAAA,SACF,CAAA;AAAA,OACF;AAEA,MAAI,IAAA,gBAAA,CAAA;AACJ,MAAI,IAAA,cAAA,CAAA;AACJ,MAAI,IAAA,GAAA,CAAI,MAAM,iBAAmB,EAAA;AAC/B,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,wFAAA;AAAA,SACF,CAAA;AACA,QAAA,gBAAA,GAAmB,IAAI,KAAM,CAAA,iBAAA,CAAA;AAC7B,QAAiB,cAAA,GAAA,KAAA,CAAA;AAAA,OACZ,MAAA;AACL,QAAA,gBAAA,GAAmB,IAAI,KAAM,CAAA,qBAAA,CAAA;AAC7B,QAAiB,cAAA,GAAA,IAAA,CAAA;AAAA,OACnB;AAEA,MAAA,IAAI,gBAAoB,IAAA,CAAC,KAAM,CAAA,OAAA,CAAQ,gBAAgB,CAAG,EAAA;AACxD,QAAA,MAAM,IAAIA,iBAAA;AAAA,UACR,6EAAA;AAAA,SACF,CAAA;AAAA,OACF;AAEA,MAAA,IACE,IAAI,KAAM,CAAA,qBAAA,KACT,gBAAoB,IAAA,GAAA,CAAI,MAAM,kBAC/B,CAAA,EAAA;AACA,QAAA,MAAM,IAAIA,iBAAA;AAAA,UACR,+GAAA;AAAA,SACF,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,SAA4B,GAAA,KAAA,CAAA;AAChC,MAAI,IAAA,GAAA,CAAI,MAAM,qBAAuB,EAAA;AACnC,QAAA,SAAA,GACE,IAAI,KAAM,CAAA,qBAAA,KAA0B,IAChC,GAAA,MAAA,GACA,IAAI,KAAM,CAAA,qBAAA,CAAA;AAChB,QAAA,IAAI,CAAC,SAAA,CAAU,UAAW,CAAA,GAAG,CAAG,EAAA;AAC9B,UAAA,SAAA,GAAY,IAAI,SAAS,CAAA,CAAA,CAAA;AAAA,SAC3B;AAAA,OACF;AAEA,MAAA,MAAMC,kCAAc,CAAA;AAAA,QAClB,MAAA;AAAA,QACA,YAAA;AAAA,QACA,OAAA,EAAS,IAAI,YAAc,EAAA,OAAA;AAAA,QAC3B,QAAA,EAAU,IAAI,KAAM,CAAA,GAAA;AAAA,QACpB,UAAY,EAAA,WAAA;AAAA,QACZ,KAAA,EAAO,IAAI,KAAM,CAAA,KAAA;AAAA,OAClB,CAAA,CAAA;AAED,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,2CAA2C,CAAA,CAAA;AAC3D,MAAM,MAAA,oBAAA,GAAuB,MAAMC,uBAAA,CAAO,CAAQ,IAAA,CAAA,EAAA;AAAA,QAChD,GAAK,EAAA,WAAA;AAAA,QACL,GAAK,EAAA,IAAA;AAAA,QACL,SAAW,EAAA,KAAA;AAAA,QACX,eAAiB,EAAA,IAAA;AAAA,QACjB,mBAAqB,EAAA,KAAA;AAAA,OACtB,CAAA,CAAA;AAED,MAAA,MAAM,sBAAsB,IAAI,GAAA;AAAA,QAC9B,MAAMA,uBAAA,CAAO,gBAAoB,IAAA,EAAI,EAAA;AAAA,UACnC,GAAK,EAAA,WAAA;AAAA,UACL,GAAK,EAAA,IAAA;AAAA,UACL,SAAW,EAAA,KAAA;AAAA,UACX,eAAiB,EAAA,IAAA;AAAA,UACjB,mBAAqB,EAAA,KAAA;AAAA,SACtB,CAAA;AAAA,OACH,CAAA;AAMA,MAAA,MAAM,EAAE,kBAAA,EAAoB,MAAO,EAAA,GAAI,GAAI,CAAA,KAAA,CAAA;AAC3C,MAAA,MAAM,OAAU,GAAA;AAAA,QACd,CAAC,kBAAA,GAAqB,cAAiB,GAAA,QAAQ,GAAG,MAAA;AAAA,OACpD,CAAA;AAEA,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,QACT,CAAA,WAAA,EAAc,qBAAqB,MAAM,CAAA,6CAAA,CAAA;AAAA,QACzC,IAAI,KAAM,CAAA,MAAA;AAAA,OACZ,CAAA;AAEA,MAAM,MAAA,cAAA,GAAiB,MAAMC,+BAAA,CAAgB,YAAa,CAAA;AAAA,QACxD,kBAAA,EAAoB,IAAI,KAAM,CAAA,kBAAA;AAAA,QAC9B,eAAiB,EAAA;AAAA,UACf,GAAG,sBAAA;AAAA,UACH,GAAG,yBAAA;AAAA,SACL;AAAA,QACA,eAAiB,EAAA,yBAAA;AAAA,QACjB,eAAiB,EAAA;AAAA,UACf,UAAA,EAAY,IAAI,KAAM,CAAA,UAAA;AAAA,UACtB,YAAA,EAAc,IAAI,KAAM,CAAA,YAAA;AAAA,SAC1B;AAAA,OACD,CAAA,CAAA;AAED,MAAA,KAAA,MAAW,YAAY,oBAAsB,EAAA;AAC3C,QAAI,IAAA,cAAA,CAAA;AAEJ,QAAA,IAAI,eAAkB,GAAA,QAAA,CAAA;AACtB,QAAA,IAAI,SAAW,EAAA;AACb,UAAiB,cAAA,GAAAC,YAAA,CAAQ,eAAe,CAAM,KAAA,SAAA,CAAA;AAC9C,UAAA,IAAI,cAAgB,EAAA;AAClB,YAAA,eAAA,GAAkB,eAAgB,CAAA,KAAA,CAAM,CAAG,EAAA,CAAC,UAAU,MAAM,CAAA,CAAA;AAAA,WAC9D;AAGA,UAAkB,eAAA,GAAA,cAAA,CAAe,iBAAiB,OAAO,CAAA,CAAA;AAAA,SACpD,MAAA;AACL,UAAiB,cAAA,GAAA,CAAC,mBAAoB,CAAA,GAAA,CAAI,QAAQ,CAAA,CAAA;AAMlD,UAAA,IAAI,cAAgB,EAAA;AAClB,YAAkB,eAAA,GAAA,cAAA,CAAe,iBAAiB,OAAO,CAAA,CAAA;AAAA,WACpD,MAAA;AACL,YAAA,eAAA,GAAkB,cACd,GAAA,cAAA,CAAe,eAAiB,EAAA,OAAO,CACvC,GAAA,eAAA,CAAA;AAAA,WACN;AAAA,SACF;AAEA,QAAI,IAAA,sBAAA,CAAuB,eAAe,CAAG,EAAA;AAC3C,UAAA,SAAA;AAAA,SACF;AAEA,QAAM,MAAA,UAAA,GAAaL,qCAAqB,CAAA,SAAA,EAAW,eAAe,CAAA,CAAA;AAClE,QAAA,IAAIM,oBAAG,UAAW,CAAA,UAAU,KAAK,CAAC,GAAA,CAAI,MAAM,OAAS,EAAA;AACnD,UAAA,SAAA;AAAA,SACF;AAEA,QAAI,IAAA,CAAC,cAAkB,IAAA,CAAC,SAAW,EAAA;AACjC,UAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,YACT,0BAA0B,QAAQ,CAAA,oBAAA,CAAA;AAAA,WACpC,CAAA;AAAA,SACF;AAEA,QAAI,IAAA,QAAA,CAAS,QAAS,CAAA,GAAG,CAAG,EAAA;AAC1B,UAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,YACT,qBAAqB,QAAQ,CAAA,yBAAA,CAAA;AAAA,WAC/B,CAAA;AACA,UAAM,MAAAA,mBAAA,CAAG,UAAU,UAAU,CAAA,CAAA;AAAA,SACxB,MAAA;AACL,UAAM,MAAA,aAAA,GAAgBN,qCAAqB,CAAA,WAAA,EAAa,QAAQ,CAAA,CAAA;AAChE,UAAA,MAAM,KAAQ,GAAA,MAAMM,mBAAG,CAAA,QAAA,CAAS,MAAM,aAAa,CAAA,CAAA;AAEnD,UAAA,IAAI,MAAM,cAAe,EAAA,IAAM,MAAMC,yBAAA,CAAa,aAAa,CAAI,EAAA;AACjE,YAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,cACT,2CAA2C,QAAQ,CAAA,0BAAA,CAAA;AAAA,aACrD,CAAA;AACA,YAAM,MAAAD,mBAAA,CAAG,IAAK,CAAA,aAAA,EAAe,UAAU,CAAA,CAAA;AAAA,WAClC,MAAA;AACL,YAAA,MAAM,QAAW,GAAA,MAAMA,mBAAG,CAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAC5C,YAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,cACT,CAAgB,aAAA,EAAA,QAAQ,CAAsC,mCAAA,EAAA,QAAA,CAAS,IAAI,CAAA,CAAA,CAAA;AAAA,aAC7E,CAAA;AACA,YAAA,MAAM,iBAAoB,GAAA,MAAMA,mBAAG,CAAA,QAAA,CAAS,eAAe,OAAO,CAAA,CAAA;AAClE,YAAA,MAAMA,mBAAG,CAAA,UAAA;AAAA,cACP,UAAA;AAAA,cACA,cACI,GAAA,cAAA,CAAe,iBAAmB,EAAA,OAAO,CACzC,GAAA,iBAAA;AAAA,cACJ,EAAE,IAAM,EAAA,QAAA,CAAS,IAAK,EAAA;AAAA,aACxB,CAAA;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAEA,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAAA,KAC3D;AAAA,GACD,CAAA,CAAA;AACH,CAAA;AAEA,SAAS,uBAAuB,eAAkC,EAAA;AAKhE,EACE,OAAA,eAAA,KAAoB,MACpB,eAAgB,CAAA,UAAA,CAAW,GAAG,CAC9B,IAAA,eAAA,CAAgB,SAAS,IAAI,CAAA,CAAA;AAEjC;;;;"}

package/dist/scaffolder/actions/builtin/fetch/template.examples.cjs.js

@@ -0,0 +1,35 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Downloads a skeleton directory that lives alongside the template file and fill it out with values.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "fetch:template",
+          id: "fetch-template",
+          name: "Fetch template",
+          input: {
+            url: "./skeleton",
+            targetPath: "./target",
+            values: {
+              name: "test-project",
+              count: 1234,
+              itemList: ["first", "second", "third"],
+              showDummyFile: false
+            }
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=template.examples.cjs.js.map

package/dist/scaffolder/actions/builtin/fetch/template.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.examples.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/fetch/template.examples.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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description:\n      'Downloads a skeleton directory that lives alongside the template file and fill it out with values.',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'fetch:template',\n          id: 'fetch-template',\n          name: 'Fetch template',\n          input: {\n            url: './skeleton',\n            targetPath: './target',\n            values: {\n              name: 'test-project',\n              count: 1234,\n              itemList: ['first', 'second', 'third'],\n              showDummyFile: false,\n            },\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WACE,EAAA,oGAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,gBAAA;AAAA,UACR,EAAI,EAAA,gBAAA;AAAA,UACJ,IAAM,EAAA,gBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,GAAK,EAAA,YAAA;AAAA,YACL,UAAY,EAAA,UAAA;AAAA,YACZ,MAAQ,EAAA;AAAA,cACN,IAAM,EAAA,cAAA;AAAA,cACN,KAAO,EAAA,IAAA;AAAA,cACP,QAAU,EAAA,CAAC,OAAS,EAAA,QAAA,EAAU,OAAO,CAAA;AAAA,cACrC,aAAe,EAAA,KAAA;AAAA,aACjB;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/scaffolder/actions/builtin/fetch/templateFile.cjs.js

@@ -0,0 +1,119 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var templateFile_examples = require('./templateFile.examples.cjs.js');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var SecureTemplater = require('../../../../lib/templating/SecureTemplater.cjs.js');
+var filters = require('../../../../lib/templating/filters.cjs.js');
+var path = require('path');
+var fs = require('fs-extra');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var path__default = /*#__PURE__*/_interopDefaultCompat(path);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+function createFetchTemplateFileAction(options) {
+  const {
+    reader,
+    integrations,
+    additionalTemplateFilters,
+    additionalTemplateGlobals
+  } = options;
+  const defaultTemplateFilters = filters.createDefaultFilters({ integrations });
+  return pluginScaffolderNode.createTemplateAction({
+    id: "fetch:template:file",
+    description: "Downloads single file and places it in the workspace.",
+    examples: templateFile_examples.examples,
+    schema: {
+      input: {
+        type: "object",
+        required: ["url", "targetPath"],
+        properties: {
+          url: {
+            title: "Fetch URL",
+            description: "Relative path or absolute URL pointing to the single file to fetch.",
+            type: "string"
+          },
+          targetPath: {
+            title: "Target Path",
+            description: "Target path within the working directory to download the file as.",
+            type: "string"
+          },
+          values: {
+            title: "Template Values",
+            description: "Values to pass on to the templating engine",
+            type: "object"
+          },
+          cookiecutterCompat: {
+            title: "Cookiecutter compatibility mode",
+            description: "Enable features to maximise compatibility with templates built for fetch:cookiecutter",
+            type: "boolean"
+          },
+          replace: {
+            title: "Replace file",
+            description: "If set, replace file in targetPath instead of overwriting existing one.",
+            type: "boolean"
+          },
+          token: {
+            title: "Token",
+            description: "An optional token to use for authentication when reading the resources.",
+            type: "string"
+          }
+        }
+      }
+    },
+    supportsDryRun: true,
+    async handler(ctx) {
+      ctx.logger.info("Fetching template file content from remote URL");
+      const workDir = await ctx.createTemporaryDirectory();
+      const tmpFilePath = path__default.default.join(workDir, "tmp");
+      const outputPath = backendPluginApi.resolveSafeChildPath(
+        ctx.workspacePath,
+        ctx.input.targetPath
+      );
+      if (fs__default.default.existsSync(outputPath) && !ctx.input.replace) {
+        ctx.logger.info(
+          `File ${ctx.input.targetPath} already exists in workspace, not replacing.`
+        );
+        return;
+      }
+      await pluginScaffolderNode.fetchFile({
+        reader,
+        integrations,
+        baseUrl: ctx.templateInfo?.baseUrl,
+        fetchUrl: ctx.input.url,
+        outputPath: tmpFilePath,
+        token: ctx.input.token
+      });
+      const { cookiecutterCompat, values } = ctx.input;
+      const context = {
+        [cookiecutterCompat ? "cookiecutter" : "values"]: values
+      };
+      ctx.logger.info(
+        `Processing template file with input values`,
+        ctx.input.values
+      );
+      const renderTemplate = await SecureTemplater.SecureTemplater.loadRenderer({
+        cookiecutterCompat,
+        templateFilters: {
+          ...defaultTemplateFilters,
+          ...additionalTemplateFilters
+        },
+        templateGlobals: additionalTemplateGlobals,
+        nunjucksConfigs: {
+          trimBlocks: ctx.input.trimBlocks,
+          lstripBlocks: ctx.input.lstripBlocks
+        }
+      });
+      const contents = await fs__default.default.readFile(tmpFilePath, "utf-8");
+      const result = renderTemplate(contents, context);
+      await fs__default.default.ensureDir(path__default.default.dirname(outputPath));
+      await fs__default.default.outputFile(outputPath, result);
+      ctx.logger.info(`Template file has been written to ${outputPath}`);
+    }
+  });
+}
+
+exports.createFetchTemplateFileAction = createFetchTemplateFileAction;
+//# sourceMappingURL=templateFile.cjs.js.map

package/dist/scaffolder/actions/builtin/fetch/templateFile.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateFile.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/fetch/templateFile.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { UrlReaderService } from '@backstage/backend-plugin-api';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { examples } from './templateFile.examples';\nimport {\n  createTemplateAction,\n  fetchFile,\n  TemplateFilter,\n  TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport { SecureTemplater } from '../../../../lib/templating/SecureTemplater';\nimport { createDefaultFilters } from '../../../../lib/templating/filters';\nimport path from 'path';\nimport fs from 'fs-extra';\n\n/**\n * Downloads a single file and templates variables into file.\n * Then places the result in the workspace, or optionally in a subdirectory\n * specified by the 'targetPath' input option.\n * @public\n */\nexport function createFetchTemplateFileAction(options: {\n  reader: UrlReaderService;\n  integrations: ScmIntegrations;\n  additionalTemplateFilters?: Record<string, TemplateFilter>;\n  additionalTemplateGlobals?: Record<string, TemplateGlobal>;\n}) {\n  const {\n    reader,\n    integrations,\n    additionalTemplateFilters,\n    additionalTemplateGlobals,\n  } = options;\n\n  const defaultTemplateFilters = createDefaultFilters({ integrations });\n\n  return createTemplateAction<{\n    url: string;\n    targetPath: string;\n    values: any;\n    cookiecutterCompat?: boolean;\n    replace?: boolean;\n    trimBlocks?: boolean;\n    lstripBlocks?: boolean;\n    token?: string;\n  }>({\n    id: 'fetch:template:file',\n    description: 'Downloads single file and places it in the workspace.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['url', 'targetPath'],\n        properties: {\n          url: {\n            title: 'Fetch URL',\n            description:\n              'Relative path or absolute URL pointing to the single file to fetch.',\n            type: 'string',\n          },\n          targetPath: {\n            title: 'Target Path',\n            description:\n              'Target path within the working directory to download the file as.',\n            type: 'string',\n          },\n          values: {\n            title: 'Template Values',\n            description: 'Values to pass on to the templating engine',\n            type: 'object',\n          },\n          cookiecutterCompat: {\n            title: 'Cookiecutter compatibility mode',\n            description:\n              'Enable features to maximise compatibility with templates built for fetch:cookiecutter',\n            type: 'boolean',\n          },\n          replace: {\n            title: 'Replace file',\n            description:\n              'If set, replace file in targetPath instead of overwriting existing one.',\n            type: 'boolean',\n          },\n          token: {\n            title: 'Token',\n            description:\n              'An optional token to use for authentication when reading the resources.',\n            type: 'string',\n          },\n        },\n      },\n    },\n    supportsDryRun: true,\n    async handler(ctx) {\n      ctx.logger.info('Fetching template file content from remote URL');\n\n      const workDir = await ctx.createTemporaryDirectory();\n      // Write to a tmp file, render the template, then copy to workspace.\n      const tmpFilePath = path.join(workDir, 'tmp');\n\n      const outputPath = resolveSafeChildPath(\n        ctx.workspacePath,\n        ctx.input.targetPath,\n      );\n\n      if (fs.existsSync(outputPath) && !ctx.input.replace) {\n        ctx.logger.info(\n          `File ${ctx.input.targetPath} already exists in workspace, not replacing.`,\n        );\n        return;\n      }\n\n      await fetchFile({\n        reader,\n        integrations,\n        baseUrl: ctx.templateInfo?.baseUrl,\n        fetchUrl: ctx.input.url,\n        outputPath: tmpFilePath,\n        token: ctx.input.token,\n      });\n\n      const { cookiecutterCompat, values } = ctx.input;\n      const context = {\n        [cookiecutterCompat ? 'cookiecutter' : 'values']: values,\n      };\n\n      ctx.logger.info(\n        `Processing template file with input values`,\n        ctx.input.values,\n      );\n\n      const renderTemplate = await SecureTemplater.loadRenderer({\n        cookiecutterCompat,\n        templateFilters: {\n          ...defaultTemplateFilters,\n          ...additionalTemplateFilters,\n        },\n        templateGlobals: additionalTemplateGlobals,\n        nunjucksConfigs: {\n          trimBlocks: ctx.input.trimBlocks,\n          lstripBlocks: ctx.input.lstripBlocks,\n        },\n      });\n\n      const contents = await fs.readFile(tmpFilePath, 'utf-8');\n      const result = renderTemplate(contents, context);\n      await fs.ensureDir(path.dirname(outputPath));\n      await fs.outputFile(outputPath, result);\n\n      ctx.logger.info(`Template file has been written to ${outputPath}`);\n    },\n  });\n}\n"],"names":["createDefaultFilters","createTemplateAction","examples","path","resolveSafeChildPath","fs","fetchFile","SecureTemplater"],"mappings":";;;;;;;;;;;;;;;AAqCO,SAAS,8BAA8B,OAK3C,EAAA;AACD,EAAM,MAAA;AAAA,IACJ,MAAA;AAAA,IACA,YAAA;AAAA,IACA,yBAAA;AAAA,IACA,yBAAA;AAAA,GACE,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,sBAAyB,GAAAA,4BAAA,CAAqB,EAAE,YAAA,EAAc,CAAA,CAAA;AAEpE,EAAA,OAAOC,yCASJ,CAAA;AAAA,IACD,EAAI,EAAA,qBAAA;AAAA,IACJ,WAAa,EAAA,uDAAA;AAAA,cACbC,8BAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,KAAA,EAAO,YAAY,CAAA;AAAA,QAC9B,UAAY,EAAA;AAAA,UACV,GAAK,EAAA;AAAA,YACH,KAAO,EAAA,WAAA;AAAA,YACP,WACE,EAAA,qEAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WACE,EAAA,mEAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,iBAAA;AAAA,YACP,WAAa,EAAA,4CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,kBAAoB,EAAA;AAAA,YAClB,KAAO,EAAA,iCAAA;AAAA,YACP,WACE,EAAA,uFAAA;AAAA,YACF,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,UACA,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,cAAA;AAAA,YACP,WACE,EAAA,yEAAA;AAAA,YACF,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,OAAA;AAAA,YACP,WACE,EAAA,yEAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,gDAAgD,CAAA,CAAA;AAEhE,MAAM,MAAA,OAAA,GAAU,MAAM,GAAA,CAAI,wBAAyB,EAAA,CAAA;AAEnD,MAAA,MAAM,WAAc,GAAAC,qBAAA,CAAK,IAAK,CAAA,OAAA,EAAS,KAAK,CAAA,CAAA;AAE5C,MAAA,MAAM,UAAa,GAAAC,qCAAA;AAAA,QACjB,GAAI,CAAA,aAAA;AAAA,QACJ,IAAI,KAAM,CAAA,UAAA;AAAA,OACZ,CAAA;AAEA,MAAA,IAAIC,oBAAG,UAAW,CAAA,UAAU,KAAK,CAAC,GAAA,CAAI,MAAM,OAAS,EAAA;AACnD,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,CAAA,KAAA,EAAQ,GAAI,CAAA,KAAA,CAAM,UAAU,CAAA,4CAAA,CAAA;AAAA,SAC9B,CAAA;AACA,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAMC,8BAAU,CAAA;AAAA,QACd,MAAA;AAAA,QACA,YAAA;AAAA,QACA,OAAA,EAAS,IAAI,YAAc,EAAA,OAAA;AAAA,QAC3B,QAAA,EAAU,IAAI,KAAM,CAAA,GAAA;AAAA,QACpB,UAAY,EAAA,WAAA;AAAA,QACZ,KAAA,EAAO,IAAI,KAAM,CAAA,KAAA;AAAA,OAClB,CAAA,CAAA;AAED,MAAA,MAAM,EAAE,kBAAA,EAAoB,MAAO,EAAA,GAAI,GAAI,CAAA,KAAA,CAAA;AAC3C,MAAA,MAAM,OAAU,GAAA;AAAA,QACd,CAAC,kBAAA,GAAqB,cAAiB,GAAA,QAAQ,GAAG,MAAA;AAAA,OACpD,CAAA;AAEA,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,QACT,CAAA,0CAAA,CAAA;AAAA,QACA,IAAI,KAAM,CAAA,MAAA;AAAA,OACZ,CAAA;AAEA,MAAM,MAAA,cAAA,GAAiB,MAAMC,+BAAA,CAAgB,YAAa,CAAA;AAAA,QACxD,kBAAA;AAAA,QACA,eAAiB,EAAA;AAAA,UACf,GAAG,sBAAA;AAAA,UACH,GAAG,yBAAA;AAAA,SACL;AAAA,QACA,eAAiB,EAAA,yBAAA;AAAA,QACjB,eAAiB,EAAA;AAAA,UACf,UAAA,EAAY,IAAI,KAAM,CAAA,UAAA;AAAA,UACtB,YAAA,EAAc,IAAI,KAAM,CAAA,YAAA;AAAA,SAC1B;AAAA,OACD,CAAA,CAAA;AAED,MAAA,MAAM,QAAW,GAAA,MAAMF,mBAAG,CAAA,QAAA,CAAS,aAAa,OAAO,CAAA,CAAA;AACvD,MAAM,MAAA,MAAA,GAAS,cAAe,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAC/C,MAAA,MAAMA,mBAAG,CAAA,SAAA,CAAUF,qBAAK,CAAA,OAAA,CAAQ,UAAU,CAAC,CAAA,CAAA;AAC3C,MAAM,MAAAE,mBAAA,CAAG,UAAW,CAAA,UAAA,EAAY,MAAM,CAAA,CAAA;AAEtC,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAqC,kCAAA,EAAA,UAAU,CAAE,CAAA,CAAA,CAAA;AAAA,KACnE;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/scaffolder/actions/builtin/fetch/templateFile.examples.cjs.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Downloads a template file and fill it out with values.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "fetch:template:file",
+          id: "fetch-template-file",
+          name: "Fetch template file",
+          input: {
+            url: "./skeleton.txt",
+            targetPath: "./target/skeleton.txt",
+            values: {
+              name: "test-project",
+              count: 1234,
+              itemList: ["first", "second", "third"]
+            }
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=templateFile.examples.cjs.js.map

package/dist/scaffolder/actions/builtin/fetch/templateFile.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateFile.examples.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/fetch/templateFile.examples.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Downloads a template file and fill it out with values.',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'fetch:template:file',\n          id: 'fetch-template-file',\n          name: 'Fetch template file',\n          input: {\n            url: './skeleton.txt',\n            targetPath: './target/skeleton.txt',\n            values: {\n              name: 'test-project',\n              count: 1234,\n              itemList: ['first', 'second', 'third'],\n            },\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,wDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,qBAAA;AAAA,UACR,EAAI,EAAA,qBAAA;AAAA,UACJ,IAAM,EAAA,qBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,GAAK,EAAA,gBAAA;AAAA,YACL,UAAY,EAAA,uBAAA;AAAA,YACZ,MAAQ,EAAA;AAAA,cACN,IAAM,EAAA,cAAA;AAAA,cACN,KAAO,EAAA,IAAA;AAAA,cACP,QAAU,EAAA,CAAC,OAAS,EAAA,QAAA,EAAU,OAAO,CAAA;AAAA,aACvC;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/scaffolder/actions/builtin/filesystem/delete.cjs.js

@@ -0,0 +1,54 @@
+'use strict';
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var errors = require('@backstage/errors');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var fs = require('fs-extra');
+var delete_examples = require('./delete.examples.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+const createFilesystemDeleteAction = () => {
+  return pluginScaffolderNode.createTemplateAction({
+    id: "fs:delete",
+    description: "Deletes files and directories from the workspace",
+    examples: delete_examples.examples,
+    schema: {
+      input: {
+        required: ["files"],
+        type: "object",
+        properties: {
+          files: {
+            title: "Files",
+            description: "A list of files and directories that will be deleted",
+            type: "array",
+            items: {
+              type: "string"
+            }
+          }
+        }
+      }
+    },
+    supportsDryRun: true,
+    async handler(ctx) {
+      if (!Array.isArray(ctx.input?.files)) {
+        throw new errors.InputError("files must be an Array");
+      }
+      for (const file of ctx.input.files) {
+        const filepath = backendPluginApi.resolveSafeChildPath(ctx.workspacePath, file);
+        try {
+          await fs__default.default.remove(filepath);
+          ctx.logger.info(`File ${filepath} deleted successfully`);
+        } catch (err) {
+          ctx.logger.error(`Failed to delete file ${filepath}:`, err);
+          throw err;
+        }
+      }
+    }
+  });
+};
+
+exports.createFilesystemDeleteAction = createFilesystemDeleteAction;
+//# sourceMappingURL=delete.cjs.js.map

package/dist/scaffolder/actions/builtin/filesystem/delete.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/filesystem/delete.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 { InputError } from '@backstage/errors';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport fs from 'fs-extra';\nimport { examples } from './delete.examples';\n\n/**\n * Creates new action that enables deletion of files and directories in the workspace.\n * @public\n */\nexport const createFilesystemDeleteAction = () => {\n  return createTemplateAction<{ files: string[] }>({\n    id: 'fs:delete',\n    description: 'Deletes files and directories from the workspace',\n    examples,\n    schema: {\n      input: {\n        required: ['files'],\n        type: 'object',\n        properties: {\n          files: {\n            title: 'Files',\n            description: 'A list of files and directories that will be deleted',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n        },\n      },\n    },\n    supportsDryRun: true,\n    async handler(ctx) {\n      if (!Array.isArray(ctx.input?.files)) {\n        throw new InputError('files must be an Array');\n      }\n\n      for (const file of ctx.input.files) {\n        const filepath = resolveSafeChildPath(ctx.workspacePath, file);\n\n        try {\n          await fs.remove(filepath);\n          ctx.logger.info(`File ${filepath} deleted successfully`);\n        } catch (err) {\n          ctx.logger.error(`Failed to delete file ${filepath}:`, err);\n          throw err;\n        }\n      }\n    },\n  });\n};\n"],"names":["createTemplateAction","examples","InputError","resolveSafeChildPath","fs"],"mappings":";;;;;;;;;;;;AA0BO,MAAM,+BAA+B,MAAM;AAChD,EAAA,OAAOA,yCAA0C,CAAA;AAAA,IAC/C,EAAI,EAAA,WAAA;AAAA,IACJ,WAAa,EAAA,kDAAA;AAAA,cACbC,wBAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAA,EAAU,CAAC,OAAO,CAAA;AAAA,QAClB,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,OAAA;AAAA,YACP,WAAa,EAAA,sDAAA;AAAA,YACb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA,QAAA;AAAA,aACR;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,GAAI,CAAA,KAAA,EAAO,KAAK,CAAG,EAAA;AACpC,QAAM,MAAA,IAAIC,kBAAW,wBAAwB,CAAA,CAAA;AAAA,OAC/C;AAEA,MAAW,KAAA,MAAA,IAAA,IAAQ,GAAI,CAAA,KAAA,CAAM,KAAO,EAAA;AAClC,QAAA,MAAM,QAAW,GAAAC,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,IAAI,CAAA,CAAA;AAE7D,QAAI,IAAA;AACF,UAAM,MAAAC,mBAAA,CAAG,OAAO,QAAQ,CAAA,CAAA;AACxB,UAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAQ,KAAA,EAAA,QAAQ,CAAuB,qBAAA,CAAA,CAAA,CAAA;AAAA,iBAChD,GAAK,EAAA;AACZ,UAAA,GAAA,CAAI,MAAO,CAAA,KAAA,CAAM,CAAyB,sBAAA,EAAA,QAAQ,KAAK,GAAG,CAAA,CAAA;AAC1D,UAAM,MAAA,GAAA,CAAA;AAAA,SACR;AAAA,OACF;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/scaffolder/actions/builtin/filesystem/delete.examples.cjs.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var yaml__namespace = /*#__PURE__*/_interopNamespaceCompat(yaml);
+
+const examples = [
+  {
+    description: "Delete specified files",
+    example: yaml__namespace.stringify({
+      steps: [
+        {
+          action: "fs:delete",
+          id: "deleteFiles",
+          name: "Delete files",
+          input: {
+            files: ["file1.txt", "file2.txt"]
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=delete.examples.cjs.js.map

package/dist/scaffolder/actions/builtin/filesystem/delete.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.examples.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/filesystem/delete.examples.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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport * as yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Delete specified files',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'fs:delete',\n          id: 'deleteFiles',\n          name: 'Delete files',\n          input: {\n            files: ['file1.txt', 'file2.txt'],\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,wBAAA;AAAA,IACb,OAAA,EAASA,gBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,WAAA;AAAA,UACR,EAAI,EAAA,aAAA;AAAA,UACJ,IAAM,EAAA,cAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,KAAA,EAAO,CAAC,WAAA,EAAa,WAAW,CAAA;AAAA,WAClC;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}