@backstage/plugin-scaffolder-backend 1.15.2-next.0 → 1.15.2-next.2

package/dist/cjs/{ScaffolderEntitiesProcessor-b514f9e5.cjs.js → ScaffolderEntitiesProcessor-82f18a18.cjs.js}

@@ -20,8 +20,6 @@ var isbinaryfile = require('isbinaryfile');
 var isolatedVm = require('isolated-vm');
 var get = require('lodash/get');
 var octokit = require('octokit');
-var child_process = require('child_process');
-var stream = require('stream');
 var Sodium = require('libsodium-wrappers');
 var webhooks = require('@octokit/webhooks');
 var azureDevopsNodeApi = require('azure-devops-node-api');
@@ -36,6 +34,7 @@ var ObservableImpl = require('zen-observable');
 var PQueue = require('p-queue');
 var winston = require('winston');
 var nunjucks = require('nunjucks');
+var stream = require('stream');
 var lodash = require('lodash');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var promClient = require('prom-client');
@@ -82,14 +81,13 @@ var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
-const id$4 = "catalog:register";
-const examples$4 = [
+const examples$9 = [
   {
     description: "Register with the catalog",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$4,
+          action: "catalog:register",
           id: "register-with-catalog",
           name: "Register with the catalog",
           input: {
@@ -100,12 +98,14 @@ const examples$4 = [
     })
   }
 ];
+
+const id$4 = "catalog:register";
 function createCatalogRegisterAction(options) {
   const { catalogClient, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: id$4,
     description: "Registers entities from a catalog descriptor file in the workspace into the software catalog.",
-    examples: examples$4,
+    examples: examples$9,
     schema: {
       input: {
         oneOf: [
@@ -229,14 +229,13 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const id$3 = "catalog:write";
-const examples$3 = [
+const examples$8 = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
       steps: [
         {
-          action: id$3,
+          action: "catalog:write",
           id: "create-catalog-info-file",
           name: "Create catalog file",
           input: {
@@ -259,6 +258,8 @@ const examples$3 = [
     })
   }
 ];
+
+const id$3 = "catalog:write";
 function createCatalogWriteAction() {
   return pluginScaffolderNode.createTemplateAction({
     id: id$3,
@@ -272,7 +273,7 @@ function createCatalogWriteAction() {
         )
       })
     },
-    examples: examples$3,
+    examples: examples$8,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -286,14 +287,13 @@ function createCatalogWriteAction() {
   });
 }
 
-const id$2 = "catalog:fetch";
-const examples$2 = [
+const examples$7 = [
   {
     description: "Fetch entity by reference",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$2,
+          action: "catalog:fetch",
           id: "fetch",
           name: "Fetch catalog entity",
           input: {
@@ -304,11 +304,11 @@ const examples$2 = [
     })
   },
   {
-    description: "Fetch multiple entities by referencse",
+    description: "Fetch multiple entities by reference",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$2,
+          action: "catalog:fetch",
           id: "fetchMultiple",
           name: "Fetch catalog entities",
           input: {
@@ -319,12 +319,14 @@ const examples$2 = [
     })
   }
 ];
+
+const id$2 = "catalog:fetch";
 function createFetchCatalogEntityAction(options) {
   const { catalogClient } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Returns entity or entities from the catalog by entity reference(s)",
-    examples: examples$2,
+    examples: examples$7,
     supportsDryRun: true,
     schema: {
       input: zod.z.object({
@@ -399,14 +401,13 @@ function createFetchCatalogEntityAction(options) {
   });
 }
 
-const id$1 = "debug:log";
-const examples$1 = [
+const examples$6 = [
   {
     description: "Write a debug message",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$1,
+          action: "debug:log",
           id: "write-debug-line",
           name: 'Write "Hello Backstage!" log line',
           input: {
@@ -421,7 +422,7 @@ const examples$1 = [
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$1,
+          action: "debug:log",
           id: "write-workspace-directory",
           name: "List the workspace directory",
           input: {
@@ -432,11 +433,13 @@ const examples$1 = [
     })
   }
 ];
+
+const id$1 = "debug:log";
 function createDebugLogAction() {
   return pluginScaffolderNode.createTemplateAction({
     id: id$1,
     description: "Writes a message into the log or lists all files in the workspace.",
-    examples: examples$1,
+    examples: examples$6,
     schema: {
       input: {
         type: "object",
@@ -483,15 +486,28 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-const id = "debug:wait";
-const MAX_WAIT_TIME_IN_ISO = "T00:00:30";
-const examples = [
+const examples$5 = [
+  {
+    description: "Waiting for 50 milliseconds",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "debug:wait",
+          id: "wait-milliseconds",
+          name: "Waiting for 50 milliseconds",
+          input: {
+            milliseconds: 50
+          }
+        }
+      ]
+    })
+  },
   {
     description: "Waiting for 5 seconds",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id,
+          action: "debug:wait",
           id: "wait-5sec",
           name: "Waiting for 5 seconds",
           input: {
@@ -502,21 +518,24 @@ const examples = [
     })
   },
   {
-    description: "Waiting for 5 minutes",
+    description: "Waiting for 1 minutes",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id,
-          id: "wait-5min",
-          name: "Waiting for 5 minutes",
+          action: "debug:wait",
+          id: "wait-1min",
+          name: "Waiting for 1 minutes",
           input: {
-            minutes: 5
+            minutes: 1
           }
         }
       ]
     })
   }
 ];
+
+const id = "debug:wait";
+const MAX_WAIT_TIME_IN_ISO = "T00:00:30";
 function createWaitAction(options) {
   const toDuration = (maxWaitTime) => {
     if (maxWaitTime) {
@@ -530,7 +549,7 @@ function createWaitAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Waits for a certain period of time.",
-    examples,
+    examples: examples$5,
     schema: {
       input: {
         type: "object",
@@ -575,66 +594,46 @@ function createWaitAction(options) {
   });
 }
 
-async function fetchContents(options) {
-  const { reader, integrations, baseUrl, fetchUrl = ".", outputPath } = options;
-  const fetchUrlIsAbsolute = isFetchUrlAbsolute(fetchUrl);
-  if (!fetchUrlIsAbsolute && (baseUrl == null ? void 0 : baseUrl.startsWith("file://"))) {
-    const basePath = baseUrl.slice("file://".length);
-    const srcDir = backendCommon.resolveSafeChildPath(path__default["default"].dirname(basePath), fetchUrl);
-    await fs__default["default"].copy(srcDir, outputPath);
-  } else {
-    const readUrl = getReadUrl(fetchUrl, baseUrl, integrations);
-    const res = await reader.readTree(readUrl);
-    await fs__default["default"].ensureDir(outputPath);
-    await res.dir({ targetDir: outputPath });
-  }
-}
-async function fetchFile(options) {
-  const { reader, integrations, baseUrl, fetchUrl = ".", outputPath } = options;
-  const fetchUrlIsAbsolute = isFetchUrlAbsolute(fetchUrl);
-  if (!fetchUrlIsAbsolute && (baseUrl == null ? void 0 : baseUrl.startsWith("file://"))) {
-    const basePath = baseUrl.slice("file://".length);
-    const src = backendCommon.resolveSafeChildPath(path__default["default"].dirname(basePath), fetchUrl);
-    await fs__default["default"].copyFile(src, outputPath);
-  } else {
-    const readUrl = getReadUrl(fetchUrl, baseUrl, integrations);
-    const res = await reader.readUrl(readUrl);
-    await fs__default["default"].ensureDir(path__default["default"].dirname(outputPath));
-    const buffer = await res.buffer();
-    await fs__default["default"].outputFile(outputPath, buffer.toString());
-  }
-}
-function isFetchUrlAbsolute(fetchUrl) {
-  let fetchUrlIsAbsolute = false;
-  try {
-    new URL(fetchUrl);
-    fetchUrlIsAbsolute = true;
-  } catch {
-  }
-  return fetchUrlIsAbsolute;
-}
-function getReadUrl(fetchUrl, baseUrl, integrations) {
-  if (isFetchUrlAbsolute(fetchUrl)) {
-    return fetchUrl;
-  } else if (baseUrl) {
-    const integration = integrations.byUrl(baseUrl);
-    if (!integration) {
-      throw new errors.InputError(`No integration found for location ${baseUrl}`);
-    }
-    return integration.resolveUrl({
-      url: fetchUrl,
-      base: baseUrl
-    });
+const examples$4 = [
+  {
+    description: "Downloads content and places it in the workspace.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "fetch:plain",
+          id: "fetch-plain",
+          name: "Fetch plain",
+          input: {
+            url: "https://github.com/backstage/community/tree/main/backstage-community-sessions/assets"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Optionally, if you would prefer the data to be downloaded to a subdirectory in the workspace you may specify the \u2018targetPath\u2019 input option.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "fetch:plain",
+          id: "fetch-plain",
+          name: "Fetch plain",
+          input: {
+            url: "https://github.com/backstage/community/tree/main/backstage-community-sessions/assets",
+            targetPath: "fetched-data"
+          }
+        }
+      ]
+    })
   }
-  throw new errors.InputError(
-    `Failed to fetch, template location could not be determined and the fetch URL is relative, ${fetchUrl}`
-  );
-}
+];
 
+const ACTION_ID = "fetch:plain";
 function createFetchPlainAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
-    id: "fetch:plain",
+    id: ACTION_ID,
+    examples: examples$4,
     description: "Downloads content and places it in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
     schema: {
       input: {
@@ -660,7 +659,7 @@ function createFetchPlainAction(options) {
       ctx.logger.info("Fetching plain content from remote URL");
       const targetPath = (_a = ctx.input.targetPath) != null ? _a : "./";
       const outputPath = backendCommon.resolveSafeChildPath(ctx.workspacePath, targetPath);
-      await fetchContents({
+      await pluginScaffolderNode.fetchContents({
         reader,
         integrations,
         baseUrl: (_b = ctx.templateInfo) == null ? void 0 : _b.baseUrl,
@@ -671,11 +670,31 @@ function createFetchPlainAction(options) {
   });
 }
 
+const examples$3 = [
+  {
+    description: "Downloads a file and places it in the workspace.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "fetch:plain:file",
+          id: "fetch-plain-file",
+          name: "Fetch plain file",
+          input: {
+            url: "https://github.com/backstage/community/tree/main/backstage-community-sessions/assets/Backstage%20Community%20Sessions.png",
+            targetPath: "target-path"
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createFetchPlainFileAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "fetch:plain:file",
     description: "Downloads single file and places it in the workspace.",
+    examples: examples$3,
     schema: {
       input: {
         type: "object",
@@ -702,7 +721,7 @@ function createFetchPlainFileAction(options) {
         ctx.workspacePath,
         ctx.input.targetPath
       );
-      await fetchFile({
+      await pluginScaffolderNode.fetchFile({
         reader,
         integrations,
         baseUrl: (_a = ctx.templateInfo) == null ? void 0 : _a.baseUrl,
@@ -943,6 +962,31 @@ const createDefaultFilters = ({
   };
 };
 
+const examples$2 = [
+  {
+    description: "Downloads a skelaton 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
+            }
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createFetchTemplateAction(options) {
   const {
     reader,
@@ -954,6 +998,7 @@ function createFetchTemplateAction(options) {
   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: examples$2,
     schema: {
       input: {
         type: "object",
@@ -1050,7 +1095,7 @@ function createFetchTemplateAction(options) {
           extension = `.${extension}`;
         }
       }
-      await fetchContents({
+      await pluginScaffolderNode.fetchContents({
         reader,
         integrations,
         baseUrl: (_b = ctx.templateInfo) == null ? void 0 : _b.baseUrl,
@@ -1158,10 +1203,29 @@ function containsSkippedContent(localOutputPath) {
   return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
+const examples$1 = [
+  {
+    description: "Delete specified files",
+    example: yaml__namespace.stringify({
+      steps: [
+        {
+          action: "fs:delete",
+          id: "deleteFiles",
+          name: "Delete files",
+          input: {
+            files: ["file1.txt", "file2.txt"]
+          }
+        }
+      ]
+    })
+  }
+];
+
 const createFilesystemDeleteAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:delete",
     description: "Deletes files and directories from the workspace",
+    examples: examples$1,
     schema: {
       input: {
         required: ["files"],
@@ -1198,10 +1262,33 @@ const createFilesystemDeleteAction = () => {
   });
 };
 
+const examples = [
+  {
+    description: "Rename specified files ",
+    example: yaml__namespace.stringify({
+      steps: [
+        {
+          action: "fs:rename",
+          id: "renameFiles",
+          name: "Rename files",
+          input: {
+            files: [
+              { from: "file1.txt", to: "file1Renamed.txt" },
+              { from: "file2.txt", to: "file2Renamed.txt" },
+              { from: "file3.txt", to: "file3Renamed.txt", overwrite: true }
+            ]
+          }
+        }
+      ]
+    })
+  }
+];
+
 const createFilesystemRenameAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:rename",
     description: "Renames files and directories within the workspace",
+    examples,
     schema: {
       input: {
         required: ["files"],
@@ -1267,34 +1354,6 @@ const createFilesystemRenameAction = () => {
   });
 };
 
-const executeShellCommand = async (options) => {
-  const {
-    command,
-    args,
-    options: spawnOptions,
-    logStream = new stream.PassThrough()
-  } = options;
-  await new Promise((resolve, reject) => {
-    const process = child_process.spawn(command, args, spawnOptions);
-    process.stdout.on("data", (stream) => {
-      logStream.write(stream);
-    });
-    process.stderr.on("data", (stream) => {
-      logStream.write(stream);
-    });
-    process.on("error", (error) => {
-      return reject(error);
-    });
-    process.on("close", (code) => {
-      if (code !== 0) {
-        return reject(
-          new Error(`Command ${command} failed, exit code: ${code}`)
-        );
-      }
-      return resolve();
-    });
-  });
-};
 async function initRepoAndPush({
   dir,
   remoteUrl,
@@ -6801,8 +6860,6 @@ exports.createPublishGitlabAction = createPublishGitlabAction;
 exports.createPublishGitlabMergeRequestAction = createPublishGitlabMergeRequestAction;
 exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
-exports.executeShellCommand = executeShellCommand;
-exports.fetchContents = fetchContents;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=ScaffolderEntitiesProcessor-b514f9e5.cjs.js.map
+//# sourceMappingURL=ScaffolderEntitiesProcessor-82f18a18.cjs.js.map