@roadiehq/scaffolder-backend-module-utils 0.1.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,194 @@
+# scaffolder-backend-module-utils actions package
+
+Welcome to the roadie `utils` actions for the `scaffolder-backend`.
+
+This contains a collection of actions: 
+ - `roadiehq:utils:zip`
+ - `roadiehq:utils:sleep`
+ - `roadiehq:utils:fs:write`
+ - `roadiehq:utils:fs:append`
+
+## Getting started
+
+Create your Backstage application using the Backstage CLI as described here:
+https://backstage.io/docs/getting-started/create-an-app
+
+> Note: If you are using this plugin in a Backstage monorepo that contains the code for `@backstage/plugin-scaffolder-backend`, you need to modify your internal build processes to transpile files from the `node_modules` folder as well.
+
+You need to configure the action in your backend:
+
+## From your Backstage root directory
+
+```
+cd packages/backend
+yarn add @roadiehq/scaffolder-backend-module-utils
+```
+
+Configure the action:
+(you can check the [docs](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) to see all options):
+
+Here you can pick the actions that you'd like to register to your backstage instance.
+
+```typescript
+// packages/backend/src/plugins/scaffolder.ts
+import { createZipAction, createWriteFileAction, createAppendFileAction, createSleepAction } from '@roadiehq/scaffolder-backend-module-utils';
+...
+
+const actions = [
+  createFileAction(),
+  createSleepAction(),
+  createZipAction(),
+  createAppendFileAction(),
+  ...createBuiltinActions({
+    containerRunner,
+    integrations,
+    config,
+    catalogClient,
+    reader,
+  }),
+];
+
+return await createRouter({
+  containerRunner,
+  logger,
+  config,
+  database,
+  catalogClient,
+  reader,
+  actions,
+});
+```
+
+### Example of using zip action
+
+```yaml
+---
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: zip-dummy
+  title: My custom zip action
+  description: scaffolder action to zip the current context?
+spec:
+  owner: roadie
+  type: service
+
+  parameters:
+    - title: Zip
+      properties:
+        path:
+          title: Path
+          type: string
+          description: Workspace path to zip
+        outputPath:
+          title: Path
+          type: string
+          description: The path of the zip file
+
+  steps:
+    - id: zip
+      name: Zip
+      action: roadiehq:utils:zip
+      input:
+        path: ${{ parameters.path }}
+        outputPath: ${{ parameters.outputPath }}
+
+  output:
+    path: ${{ steps.zip.output.path }}
+```
+### Example of using sleep action
+
+```yaml
+---
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: sleep-dummy
+  title: Sleep template
+  description: A template with only one sleep example action that will ask for a user input for the amount of seconds it should sleep
+spec:
+  owner: roadie
+  type: service
+
+  parameters:
+    - title: Sleep
+      properties:
+        amount:
+          title: Amount to sleep
+          type: number
+          description: Will sleep for this amount of seconds
+
+  steps:
+    - id: sleep
+      name: sleep
+      action: roadiehq:utils:sleep
+      input:
+        path: ${{ parameters.amount }}
+```
+### Example of using writeFile action
+
+```yaml
+---
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: create-file-template
+  title: Create File template
+  description: Example temaplte to create a file with on the given path with the given content in the workspace.
+spec:
+  owner: roadie
+  type: service
+
+  parameters:
+    - title: Create File
+      properties:
+        path:
+          title: Path
+          type: string
+          description: The path to the desired new file
+        content:
+          title: Content
+          type: string
+          description: The content of the newly created file
+  steps:
+    - id: writeFile
+      name: Create File
+      action: roadiehq:utils:fs:write
+      input:
+        path: ${{ parameters.path }}
+        content: ${{ parameters.content }}
+```
+### Example of using appendFile action
+
+```yaml
+---
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: append-file-template
+  title: Append To File template
+  description: Example temaplte to append to a file with on the given path with the given content in the workspace.
+spec:
+  owner: roadie
+  type: service
+
+  parameters:
+    - title: Append To File
+      properties:
+        path:
+          title: Path
+          type: string
+          description: The path to the file
+        content:
+          title: Content
+          type: string
+          description: The content to append to the file
+  steps:
+    - id: appendFile
+      name: Append To File
+      action: roadiehq:utils:fs:append
+      input:
+        path: ${{ parameters.path }}
+        content: ${{ parameters.content }}
+```
+

package/dist/index.cjs.js

@@ -0,0 +1,179 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendCommon = require('@backstage/backend-common');
+var pluginScaffolderBackend = require('@backstage/plugin-scaffolder-backend');
+var errors = require('@backstage/errors');
+var AdmZip = require('adm-zip');
+var fs = require('fs-extra');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var AdmZip__default = /*#__PURE__*/_interopDefaultLegacy(AdmZip);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+
+function createZipAction() {
+  return pluginScaffolderBackend.createTemplateAction({
+    id: "roadiehq:utils:zip",
+    description: "Zips the content of the path",
+    schema: {
+      input: {
+        required: ["path"],
+        type: "object",
+        properties: {
+          path: {
+            title: "Path",
+            description: "Relative path you would like to zip",
+            type: "string"
+          },
+          outputPath: {
+            title: "Output Path",
+            description: "The name of the result of the zip command",
+            type: "string"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          outputPath: {
+            title: "Zip Path",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const zip = new AdmZip__default["default"]();
+      const sourceFilepath = backendCommon.resolveSafeChildPath(ctx.workspacePath, ctx.input.path);
+      const destFilepath = backendCommon.resolveSafeChildPath(ctx.workspacePath, ctx.input.outputPath);
+      if (!fs__default["default"].existsSync(sourceFilepath)) {
+        throw new errors.InputError(`File ${ctx.input.path} does not exist. Can't zip it.`);
+      }
+      if (fs__default["default"].lstatSync(sourceFilepath).isDirectory()) {
+        zip.addLocalFolder(sourceFilepath);
+      } else if (fs__default["default"].lstatSync(sourceFilepath).isFile()) {
+        zip.addLocalFile(sourceFilepath);
+      }
+      zip.writeZip(destFilepath);
+      ctx.output("outputPath", ctx.input.outputPath);
+    }
+  });
+}
+
+function createWriteFileAction() {
+  return pluginScaffolderBackend.createTemplateAction({
+    id: "roadiehq:utils:fs:write",
+    description: "Creates a file with the content on the given path",
+    schema: {
+      input: {
+        required: ["path", "content"],
+        type: "object",
+        properties: {
+          path: {
+            title: "Path",
+            description: "Relative path",
+            type: "string"
+          },
+          content: {
+            title: "Content",
+            description: "This will be the content of the file",
+            type: "string"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          path: {
+            title: "Path",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const destFilepath = backendCommon.resolveSafeChildPath(ctx.workspacePath, ctx.input.path);
+      fs__default["default"].outputFileSync(destFilepath, ctx.input.content);
+      ctx.output("path", destFilepath);
+    }
+  });
+}
+
+function createAppendFileAction() {
+  return pluginScaffolderBackend.createTemplateAction({
+    id: "roadiehq:utils:fs:append",
+    description: "Append content to the end of the given file, it will create the file if it does not exist.",
+    schema: {
+      input: {
+        type: "object",
+        required: ["content", "path"],
+        properties: {
+          path: {
+            title: "Path",
+            description: "Path to existing file to append.",
+            type: "string"
+          },
+          content: {
+            title: "Content",
+            description: "This will be appended to the file",
+            type: "string"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          path: {
+            title: "Path",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const sourceFilepath = backendCommon.resolveSafeChildPath(ctx.workspacePath, ctx.input.path);
+      fs__default["default"].appendFileSync(sourceFilepath, ctx.input.content);
+      ctx.output("path", sourceFilepath);
+    }
+  });
+}
+
+function createSleepAction(options) {
+  return pluginScaffolderBackend.createTemplateAction({
+    id: "roadiehq:utils:sleep",
+    description: "Halts the scaffolding for the given amount of seconds",
+    schema: {
+      input: {
+        type: "object",
+        required: ["amount"],
+        properties: {
+          amount: {
+            title: "Sleep Amount",
+            description: "How much seconds should this step take.",
+            type: "number"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      var _a;
+      if (isNaN((_a = ctx.input) == null ? void 0 : _a.amount)) {
+        throw new errors.InputError("amount must be a number");
+      } else if ((options == null ? void 0 : options.maxSleep) && ctx.input.amount > options.maxSleep) {
+        throw new errors.InputError(`sleep amount can not be greater than maxSleep. amount: ${ctx.input.amount}, maxSleep: ${options.maxSleep}`);
+      }
+      ctx.logger.info(`Waiting ${ctx.input.amount} seconds`);
+      await new Promise((resolve) => {
+        setTimeout(resolve, ctx.input.amount * 1e3);
+      });
+    }
+  });
+}
+
+exports.createAppendFileAction = createAppendFileAction;
+exports.createSleepAction = createSleepAction;
+exports.createWriteFileAction = createWriteFileAction;
+exports.createZipAction = createZipAction;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/actions/zip.ts","../src/actions/fs/writeFile.ts","../src/actions/fs/appendFile.ts","../src/actions/sleep.ts"],"sourcesContent":["/*\n * Copyright 2021 Larder Software Limited\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 { resolveSafeChildPath } from '@backstage/backend-common';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-backend';\nimport { InputError } from '@backstage/errors';\nimport AdmZip from 'adm-zip';\nimport fs from 'fs-extra';\n\nexport function createZipAction() {\n  return createTemplateAction<{ path: string; outputPath: string }>({\n    id: 'roadiehq:utils:zip',\n    description: 'Zips the content of the path',\n    schema: {\n      input: {\n        required: ['path'],\n        type: 'object',\n        properties: {\n          path: {\n            title: 'Path',\n            description: 'Relative path you would like to zip',\n            type: 'string',\n          },\n\n          outputPath: {\n            title: 'Output Path',\n            description: 'The name of the result of the zip command',\n            type: 'string',\n          },\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          outputPath: {\n            title: 'Zip Path',\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const zip = new AdmZip();\n      const sourceFilepath = resolveSafeChildPath(\n        ctx.workspacePath,\n        ctx.input.path,\n      );\n      const destFilepath = resolveSafeChildPath(\n        ctx.workspacePath,\n        ctx.input.outputPath,\n      );\n\n      if (!fs.existsSync(sourceFilepath)) {\n        throw new InputError(\n          `File ${ctx.input.path} does not exist. Can't zip it.`,\n        );\n      }\n      if (fs.lstatSync(sourceFilepath).isDirectory()) {\n        zip.addLocalFolder(sourceFilepath);\n      } else if (fs.lstatSync(sourceFilepath).isFile()) {\n        zip.addLocalFile(sourceFilepath);\n      }\n      zip.writeZip(destFilepath);\n      ctx.output('outputPath', ctx.input.outputPath);\n    },\n  });\n}\n","/*\n * Copyright 2021 Larder Software Limited\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-backend';\nimport { resolveSafeChildPath } from '@backstage/backend-common';\nimport fs from 'fs-extra';\n\nexport function createWriteFileAction() {\n  return createTemplateAction<{ path: string; content: string }>({\n    id: 'roadiehq:utils:fs:write',\n    description: 'Creates a file with the content on the given path',\n    schema: {\n      input: {\n        required: ['path', 'content'],\n        type: 'object',\n        properties: {\n          path: {\n            title: 'Path',\n            description: 'Relative path',\n            type: 'string',\n          },\n          content: {\n            title: 'Content',\n            description: 'This will be the content of the file',\n            type: 'string',\n          },\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          path: {\n            title: 'Path',\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const destFilepath = resolveSafeChildPath(\n        ctx.workspacePath,\n        ctx.input.path,\n      );\n\n      fs.outputFileSync(destFilepath, ctx.input.content);\n      ctx.output('path', destFilepath);\n    },\n  });\n}\n","/*\n * Copyright 2021 Larder Software Limited\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-backend';\nimport { resolveSafeChildPath } from '@backstage/backend-common';\nimport fs from 'fs-extra';\n\nexport function createAppendFileAction() {\n  return createTemplateAction<{ path: string; content: string }>({\n    id: 'roadiehq:utils:fs:append',\n    description:\n      'Append content to the end of the given file, it will create the file if it does not exist.',\n    schema: {\n      input: {\n        type: 'object',\n        required: ['content', 'path'],\n        properties: {\n          path: {\n            title: 'Path',\n            description: 'Path to existing file to append.',\n            type: 'string',\n          },\n          content: {\n            title: 'Content',\n            description: 'This will be appended to the file',\n            type: 'string',\n          },\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          path: {\n            title: 'Path',\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const sourceFilepath = resolveSafeChildPath(\n        ctx.workspacePath,\n        ctx.input.path,\n      );\n\n      fs.appendFileSync(sourceFilepath, ctx.input.content);\n      ctx.output('path', sourceFilepath);\n    },\n  });\n}\n","/*\n * Copyright 2021 Larder Software Limited\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-backend';\nimport { InputError } from '@backstage/errors';\n\nexport function createSleepAction(options?: { maxSleep?: number }) {\n  return createTemplateAction<{ amount: number }>({\n    id: 'roadiehq:utils:sleep',\n    description: 'Halts the scaffolding for the given amount of seconds',\n    schema: {\n      input: {\n        type: 'object',\n        required: ['amount'],\n        properties: {\n          amount: {\n            title: 'Sleep Amount',\n            description: 'How much seconds should this step take.',\n            type: 'number',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      if (isNaN(ctx.input?.amount)) {\n        throw new InputError('amount must be a number');\n      } else if (options?.maxSleep && ctx.input.amount > options.maxSleep) {\n        throw new InputError(\n          `sleep amount can not be greater than maxSleep. amount: ${ctx.input.amount}, maxSleep: ${options.maxSleep}`,\n        );\n      }\n      ctx.logger.info(`Waiting ${ctx.input.amount} seconds`);\n\n      await new Promise(resolve => {\n        setTimeout(resolve, ctx.input.amount * 1000);\n      });\n    },\n  });\n}\n"],"names":["createTemplateAction","AdmZip","resolveSafeChildPath","fs","InputError"],"mappings":";;;;;;;;;;;;;;;2BAsBkC;AAChC,SAAOA,6CAA2D;AAAA,IAChE,IAAI;AAAA,IACJ,aAAa;AAAA,IACb,QAAQ;AAAA,MACN,OAAO;AAAA,QACL,UAAU,CAAC;AAAA,QACX,MAAM;AAAA,QACN,YAAY;AAAA,UACV,MAAM;AAAA,YACJ,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA,UAGR,YAAY;AAAA,YACV,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA;AAAA;AAAA,MAIZ,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,YAAY;AAAA,YACV,OAAO;AAAA,YACP,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AACjB,YAAM,MAAM,IAAIC;AAChB,YAAM,iBAAiBC,mCACrB,IAAI,eACJ,IAAI,MAAM;AAEZ,YAAM,eAAeA,mCACnB,IAAI,eACJ,IAAI,MAAM;AAGZ,UAAI,CAACC,uBAAG,WAAW,iBAAiB;AAClC,cAAM,IAAIC,kBACR,QAAQ,IAAI,MAAM;AAAA;AAGtB,UAAID,uBAAG,UAAU,gBAAgB,eAAe;AAC9C,YAAI,eAAe;AAAA,iBACVA,uBAAG,UAAU,gBAAgB,UAAU;AAChD,YAAI,aAAa;AAAA;AAEnB,UAAI,SAAS;AACb,UAAI,OAAO,cAAc,IAAI,MAAM;AAAA;AAAA;AAAA;;iCCxDD;AACtC,SAAOH,6CAAwD;AAAA,IAC7D,IAAI;AAAA,IACJ,aAAa;AAAA,IACb,QAAQ;AAAA,MACN,OAAO;AAAA,QACL,UAAU,CAAC,QAAQ;AAAA,QACnB,MAAM;AAAA,QACN,YAAY;AAAA,UACV,MAAM;AAAA,YACJ,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA,UAER,SAAS;AAAA,YACP,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA;AAAA;AAAA,MAIZ,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,MAAM;AAAA,YACJ,OAAO;AAAA,YACP,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AACjB,YAAM,eAAeE,mCACnB,IAAI,eACJ,IAAI,MAAM;AAGZ,6BAAG,eAAe,cAAc,IAAI,MAAM;AAC1C,UAAI,OAAO,QAAQ;AAAA;AAAA;AAAA;;kCCtCgB;AACvC,SAAOF,6CAAwD;AAAA,IAC7D,IAAI;AAAA,IACJ,aACE;AAAA,IACF,QAAQ;AAAA,MACN,OAAO;AAAA,QACL,MAAM;AAAA,QACN,UAAU,CAAC,WAAW;AAAA,QACtB,YAAY;AAAA,UACV,MAAM;AAAA,YACJ,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA,UAER,SAAS;AAAA,YACP,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA;AAAA;AAAA,MAIZ,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,MAAM;AAAA,YACJ,OAAO;AAAA,YACP,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AACjB,YAAM,iBAAiBE,mCACrB,IAAI,eACJ,IAAI,MAAM;AAGZ,6BAAG,eAAe,gBAAgB,IAAI,MAAM;AAC5C,UAAI,OAAO,QAAQ;AAAA;AAAA;AAAA;;2BCxCS,SAAiC;AACjE,SAAOF,6CAAyC;AAAA,IAC9C,IAAI;AAAA,IACJ,aAAa;AAAA,IACb,QAAQ;AAAA,MACN,OAAO;AAAA,QACL,MAAM;AAAA,QACN,UAAU,CAAC;AAAA,QACX,YAAY;AAAA,UACV,QAAQ;AAAA,YACN,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AApCvB;AAqCM,UAAI,MAAM,UAAI,UAAJ,mBAAW,SAAS;AAC5B,cAAM,IAAII,kBAAW;AAAA,iBACZ,oCAAS,aAAY,IAAI,MAAM,SAAS,QAAQ,UAAU;AACnE,cAAM,IAAIA,kBACR,0DAA0D,IAAI,MAAM,qBAAqB,QAAQ;AAAA;AAGrG,UAAI,OAAO,KAAK,WAAW,IAAI,MAAM;AAErC,YAAM,IAAI,QAAQ,aAAW;AAC3B,mBAAW,SAAS,IAAI,MAAM,SAAS;AAAA;AAAA;AAAA;AAAA;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import * as _backstage_plugin_scaffolder_backend from '@backstage/plugin-scaffolder-backend';
+
+declare function createZipAction(): _backstage_plugin_scaffolder_backend.TemplateAction<{
+    path: string;
+    outputPath: string;
+}>;
+
+declare function createWriteFileAction(): _backstage_plugin_scaffolder_backend.TemplateAction<{
+    path: string;
+    content: string;
+}>;
+
+declare function createAppendFileAction(): _backstage_plugin_scaffolder_backend.TemplateAction<{
+    path: string;
+    content: string;
+}>;
+
+declare function createSleepAction(options?: {
+    maxSleep?: number;
+}): _backstage_plugin_scaffolder_backend.TemplateAction<{
+    amount: number;
+}>;
+
+export { createAppendFileAction, createSleepAction, createWriteFileAction, createZipAction };

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@roadiehq/scaffolder-backend-module-utils",
+  "version": "0.1.2",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github:RoadieHQ/roadie-backstage-plugins",
+    "directory": "plugins/scaffolder-actions/scaffolder-backend-module-utils"
+  },
+  "bugs": {
+    "url": "https://github.com/RoadieHQ/roadie-backstage-plugins/issues",
+    "email": "support@roadie.io"
+  },
+  "scripts": {
+    "start": "backstage-cli backend:dev",
+    "build": "backstage-cli backend:build",
+    "lint": "backstage-cli lint",
+    "test": "backstage-cli test",
+    "prepack": "backstage-cli prepack",
+    "postpack": "backstage-cli postpack",
+    "clean": "backstage-cli clean"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.10.1",
+    "@backstage/config": "^0.1.8",
+    "@backstage/errors": "^0.2.0",
+    "@backstage/plugin-scaffolder-backend": "^0.16.1",
+    "adm-zip": "^0.5.9",
+    "cross-fetch": "^3.1.4",
+    "fs-extra": "^10.0.0",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.14.0",
+    "@types/adm-zip": "^0.4.34",
+    "@types/fs-extra": "^9.0.13",
+    "@types/jest": "^26.0.7",
+    "@types/mock-fs": "^4.13.1",
+    "mock-fs": "^5.1.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "gitHead": "ed592176aa1cb9ee324ae7948103480ca9e2a9c9"
+}