@backstage/plugin-scaffolder-backend-module-cookiecutter 0.3.11-next.2 → 0.3.12

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/plugin-scaffolder-backend-module-cookiecutter
 
+## 0.3.12
+
+### Patch Changes
+
+- d5a90c0: Fixing the typescript issue with using `z.unknown()`
+
+## 0.3.11
+
+### Patch Changes
+
+- 0b2bbf1: Migrate using new actions format
+- Updated dependencies
+  - @backstage/backend-defaults@0.11.0
+  - @backstage/plugin-scaffolder-node@0.9.0
+  - @backstage/backend-plugin-api@1.4.0
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/integration@1.17.0
+  - @backstage/types@1.2.1
+
 ## 0.3.11-next.2
 
 ### Patch Changes

package/dist/actions/fetch/cookiecutter.cjs.js

@@ -101,9 +101,12 @@ function createFetchCookiecutterAction(options) {
         targetPath: (z) => z.string({
           description: "Target path within the working directory to download the contents to."
         }).optional(),
-        values: (z) => z.record(z.unknown(), {
-          description: "Values to pass on to cookiecutter for templating"
-        }),
+        values: (z) => z.object(
+          {},
+          {
+            description: "Values to pass on to cookiecutter for templating"
+          }
+        ).passthrough(),
         copyWithoutRender: (z) => z.array(z.string(), {
           description: "Avoid rendering directories and files in the template"
         }).optional(),

package/dist/actions/fetch/cookiecutter.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"cookiecutter.cjs.js","sources":["../../../src/actions/fetch/cookiecutter.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 {\n  UrlReaderService,\n  resolveSafeChildPath,\n} from '@backstage/backend-plugin-api';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport commandExists from 'command-exists';\nimport fs from 'fs-extra';\nimport path, { resolve as resolvePath } from 'path';\nimport { PassThrough, Writable } from 'stream';\nimport {\n  createTemplateAction,\n  fetchContents,\n  executeShellCommand,\n} from '@backstage/plugin-scaffolder-node';\nimport { examples } from './cookiecutter.examples';\nimport { ContainerRunner } from './ContainerRunner';\n\nexport class CookiecutterRunner {\n  private readonly containerRunner?: ContainerRunner;\n\n  constructor({ containerRunner }: { containerRunner?: ContainerRunner }) {\n    this.containerRunner = containerRunner;\n  }\n\n  private async fetchTemplateCookieCutter(\n    directory: string,\n  ): Promise<Record<string, JsonValue>> {\n    try {\n      return await fs.readJSON(path.join(directory, 'cookiecutter.json'));\n    } catch (ex) {\n      if (ex.code !== 'ENOENT') {\n        throw ex;\n      }\n\n      return {};\n    }\n  }\n\n  public async run({\n    workspacePath,\n    values,\n    logStream,\n    imageName,\n    templateDir,\n    templateContentsDir,\n  }: {\n    workspacePath: string;\n    values: JsonObject;\n    logStream: Writable;\n    imageName?: string;\n    templateDir: string;\n    templateContentsDir: string;\n  }): Promise<void> {\n    const intermediateDir = path.join(workspacePath, 'intermediate');\n    await fs.ensureDir(intermediateDir);\n    const resultDir = path.join(workspacePath, 'result');\n\n    // First lets grab the default cookiecutter.json file\n    const cookieCutterJson = await this.fetchTemplateCookieCutter(\n      templateContentsDir,\n    );\n\n    const cookieInfo = {\n      ...cookieCutterJson,\n      ...values,\n    };\n\n    await fs.writeJSON(path.join(templateDir, 'cookiecutter.json'), cookieInfo);\n\n    // Directories to bind on container\n    const mountDirs = {\n      [templateDir]: '/input',\n      [intermediateDir]: '/output',\n    };\n\n    // the command-exists package returns `true` or throws an error\n    const cookieCutterInstalled = await commandExists('cookiecutter').catch(\n      () => false,\n    );\n    if (cookieCutterInstalled) {\n      await executeShellCommand({\n        command: 'cookiecutter',\n        args: ['--no-input', '-o', intermediateDir, templateDir, '--verbose'],\n        logStream,\n      });\n    } else {\n      if (this.containerRunner === undefined) {\n        throw new Error(\n          'Invalid state: containerRunner cannot be undefined when cookiecutter is not installed',\n        );\n      }\n      await this.containerRunner.runContainer({\n        imageName: imageName ?? 'spotify/backstage-cookiecutter',\n        command: 'cookiecutter',\n        args: ['--no-input', '-o', '/output', '/input', '--verbose'],\n        mountDirs,\n        workingDir: '/input',\n        // Set the home directory inside the container as something that applications can\n        // write to, otherwise they will just fail trying to write to /\n        envVars: { HOME: '/tmp' },\n        logStream,\n      });\n    }\n\n    // if cookiecutter was successful, intermediateDir will contain\n    // exactly one directory.\n\n    const [generated] = await fs.readdir(intermediateDir);\n\n    if (generated === undefined) {\n      throw new Error('No data generated by cookiecutter');\n    }\n\n    await fs.move(path.join(intermediateDir, generated), resultDir);\n  }\n}\n\n/**\n * Creates a `fetch:cookiecutter` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://cookiecutter.readthedocs.io/} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n * @param options - Templating configuration.\n * @public\n */\nexport function createFetchCookiecutterAction(options: {\n  reader: UrlReaderService;\n  integrations: ScmIntegrations;\n  containerRunner?: ContainerRunner;\n}) {\n  const { reader, containerRunner, integrations } = options;\n\n  return createTemplateAction({\n    id: 'fetch:cookiecutter',\n    description:\n      'Downloads a template from the given URL into the workspace, and runs cookiecutter on it.',\n    examples,\n    schema: {\n      input: {\n        url: z =>\n          z.string({\n            description:\n              'Relative path or absolute URL pointing to the directory tree to fetch',\n          }),\n        targetPath: z =>\n          z\n            .string({\n              description:\n                'Target path within the working directory to download the contents to.',\n            })\n            .optional(),\n        values: z =>\n          z.record(z.unknown(), {\n            description: 'Values to pass on to cookiecutter for templating',\n          }),\n        copyWithoutRender: z =>\n          z\n            .array(z.string(), {\n              description:\n                'Avoid rendering directories and files in the template',\n            })\n            .optional(),\n        extensions: z =>\n          z\n            .array(z.string(), {\n              description:\n                \"Jinja2 extensions to add filters, tests, globals or extend the parser. Extensions must be installed in the container or on the host where Cookiecutter executes. See the contrib directory in Backstage's repo for more information\",\n            })\n            .optional(),\n        imageName: z =>\n          z\n            .string({\n              description:\n                \"Specify a custom Docker image to run cookiecutter, to override the default: 'spotify/backstage-cookiecutter'. This can be used to execute cookiecutter with Template Extensions. Used only when a local cookiecutter is not found.\",\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      ctx.logger.info('Fetching and then templating using cookiecutter');\n      const workDir = await ctx.createTemporaryDirectory();\n      const templateDir = resolvePath(workDir, 'template');\n      const templateContentsDir = resolvePath(\n        templateDir,\n        \"{{cookiecutter and 'contents'}}\",\n      );\n      const resultDir = resolvePath(workDir, 'result');\n\n      if (\n        ctx.input.copyWithoutRender &&\n        !Array.isArray(ctx.input.copyWithoutRender)\n      ) {\n        throw new InputError(\n          'Fetch action input copyWithoutRender must be an Array',\n        );\n      }\n      if (ctx.input.extensions && !Array.isArray(ctx.input.extensions)) {\n        throw new InputError('Fetch action input extensions must be an Array');\n      }\n\n      await fetchContents({\n        reader,\n        integrations,\n        baseUrl: ctx.templateInfo?.baseUrl,\n        fetchUrl: ctx.input.url,\n        outputPath: templateContentsDir,\n      });\n\n      const cookiecutter = new CookiecutterRunner({ containerRunner });\n      const values = {\n        ...ctx.input.values,\n        _copy_without_render: ctx.input.copyWithoutRender,\n        _extensions: ctx.input.extensions,\n      };\n\n      const logStream = new PassThrough();\n      logStream.on('data', chunk => {\n        ctx.logger.info(chunk.toString());\n      });\n\n      // Will execute the template in ./template and put the result in ./result\n      await cookiecutter.run({\n        workspacePath: workDir,\n        logStream,\n        values: values,\n        imageName: ctx.input.imageName,\n        templateDir: templateDir,\n        templateContentsDir: templateContentsDir,\n      });\n\n      // Finally move the template result into the task workspace\n      const targetPath = ctx.input.targetPath ?? './';\n      const outputPath = resolveSafeChildPath(ctx.workspacePath, targetPath);\n      await fs.copy(resultDir, outputPath);\n    },\n  });\n}\n"],"names":["fs","path","commandExists","executeShellCommand","createTemplateAction","examples","resolvePath","InputError","fetchContents","PassThrough","resolveSafeChildPath"],"mappings":";;;;;;;;;;;;;;;;;AAmCO,MAAM,kBAAmB,CAAA;AAAA,EACb,eAAA;AAAA,EAEjB,WAAA,CAAY,EAAE,eAAA,EAA0D,EAAA;AACtE,IAAA,IAAA,CAAK,eAAkB,GAAA,eAAA;AAAA;AACzB,EAEA,MAAc,0BACZ,SACoC,EAAA;AACpC,IAAI,IAAA;AACF,MAAA,OAAO,MAAMA,mBAAG,CAAA,QAAA,CAASC,sBAAK,IAAK,CAAA,SAAA,EAAW,mBAAmB,CAAC,CAAA;AAAA,aAC3D,EAAI,EAAA;AACX,MAAI,IAAA,EAAA,CAAG,SAAS,QAAU,EAAA;AACxB,QAAM,MAAA,EAAA;AAAA;AAGR,MAAA,OAAO,EAAC;AAAA;AACV;AACF,EAEA,MAAa,GAAI,CAAA;AAAA,IACf,aAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,SAAA;AAAA,IACA,WAAA;AAAA,IACA;AAAA,GAQgB,EAAA;AAChB,IAAA,MAAM,eAAkB,GAAAA,qBAAA,CAAK,IAAK,CAAA,aAAA,EAAe,cAAc,CAAA;AAC/D,IAAM,MAAAD,mBAAA,CAAG,UAAU,eAAe,CAAA;AAClC,IAAA,MAAM,SAAY,GAAAC,qBAAA,CAAK,IAAK,CAAA,aAAA,EAAe,QAAQ,CAAA;AAGnD,IAAM,MAAA,gBAAA,GAAmB,MAAM,IAAK,CAAA,yBAAA;AAAA,MAClC;AAAA,KACF;AAEA,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,GAAG,gBAAA;AAAA,MACH,GAAG;AAAA,KACL;AAEA,IAAA,MAAMD,oBAAG,SAAU,CAAAC,qBAAA,CAAK,KAAK,WAAa,EAAA,mBAAmB,GAAG,UAAU,CAAA;AAG1E,IAAA,MAAM,SAAY,GAAA;AAAA,MAChB,CAAC,WAAW,GAAG,QAAA;AAAA,MACf,CAAC,eAAe,GAAG;AAAA,KACrB;AAGA,IAAA,MAAM,qBAAwB,GAAA,MAAMC,8BAAc,CAAA,cAAc,CAAE,CAAA,KAAA;AAAA,MAChE,MAAM;AAAA,KACR;AACA,IAAA,IAAI,qBAAuB,EAAA;AACzB,MAAA,MAAMC,wCAAoB,CAAA;AAAA,QACxB,OAAS,EAAA,cAAA;AAAA,QACT,MAAM,CAAC,YAAA,EAAc,IAAM,EAAA,eAAA,EAAiB,aAAa,WAAW,CAAA;AAAA,QACpE;AAAA,OACD,CAAA;AAAA,KACI,MAAA;AACL,MAAI,IAAA,IAAA,CAAK,oBAAoB,KAAW,CAAA,EAAA;AACtC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAEF,MAAM,MAAA,IAAA,CAAK,gBAAgB,YAAa,CAAA;AAAA,QACtC,WAAW,SAAa,IAAA,gCAAA;AAAA,QACxB,OAAS,EAAA,cAAA;AAAA,QACT,MAAM,CAAC,YAAA,EAAc,IAAM,EAAA,SAAA,EAAW,UAAU,WAAW,CAAA;AAAA,QAC3D,SAAA;AAAA,QACA,UAAY,EAAA,QAAA;AAAA;AAAA;AAAA,QAGZ,OAAA,EAAS,EAAE,IAAA,EAAM,MAAO,EAAA;AAAA,QACxB;AAAA,OACD,CAAA;AAAA;AAMH,IAAA,MAAM,CAAC,SAAS,CAAA,GAAI,MAAMH,mBAAA,CAAG,QAAQ,eAAe,CAAA;AAEpD,IAAA,IAAI,cAAc,KAAW,CAAA,EAAA;AAC3B,MAAM,MAAA,IAAI,MAAM,mCAAmC,CAAA;AAAA;AAGrD,IAAA,MAAMA,oBAAG,IAAK,CAAAC,qBAAA,CAAK,KAAK,eAAiB,EAAA,SAAS,GAAG,SAAS,CAAA;AAAA;AAElE;AAWO,SAAS,8BAA8B,OAI3C,EAAA;AACD,EAAA,MAAM,EAAE,MAAA,EAAQ,eAAiB,EAAA,YAAA,EAAiB,GAAA,OAAA;AAElD,EAAA,OAAOG,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,oBAAA;AAAA,IACJ,WACE,EAAA,0FAAA;AAAA,cACFC,8BAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,GAAA,EAAK,CACH,CAAA,KAAA,CAAA,CAAE,MAAO,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,CAAA;AAAA,QACH,UAAA,EAAY,CACV,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,QAAQ,CACN,CAAA,KAAA,CAAA,CAAE,MAAO,CAAA,CAAA,CAAE,SAAW,EAAA;AAAA,UACpB,WAAa,EAAA;AAAA,SACd,CAAA;AAAA,QACH,mBAAmB,CACjB,CAAA,KAAA,CAAA,CACG,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UACjB,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,YAAY,CACV,CAAA,KAAA,CAAA,CACG,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UACjB,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,SAAA,EAAW,CACT,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WACE,EAAA;AAAA,SACH,EACA,QAAS;AAAA;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,iDAAiD,CAAA;AACjE,MAAM,MAAA,OAAA,GAAU,MAAM,GAAA,CAAI,wBAAyB,EAAA;AACnD,MAAM,MAAA,WAAA,GAAcC,YAAY,CAAA,OAAA,EAAS,UAAU,CAAA;AACnD,MAAA,MAAM,mBAAsB,GAAAA,YAAA;AAAA,QAC1B,WAAA;AAAA,QACA;AAAA,OACF;AACA,MAAM,MAAA,SAAA,GAAYA,YAAY,CAAA,OAAA,EAAS,QAAQ,CAAA;AAE/C,MACE,IAAA,GAAA,CAAI,MAAM,iBACV,IAAA,CAAC,MAAM,OAAQ,CAAA,GAAA,CAAI,KAAM,CAAA,iBAAiB,CAC1C,EAAA;AACA,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR;AAAA,SACF;AAAA;AAEF,MAAI,IAAA,GAAA,CAAI,MAAM,UAAc,IAAA,CAAC,MAAM,OAAQ,CAAA,GAAA,CAAI,KAAM,CAAA,UAAU,CAAG,EAAA;AAChE,QAAM,MAAA,IAAIA,kBAAW,gDAAgD,CAAA;AAAA;AAGvE,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;AAAA,OACb,CAAA;AAED,MAAA,MAAM,YAAe,GAAA,IAAI,kBAAmB,CAAA,EAAE,iBAAiB,CAAA;AAC/D,MAAA,MAAM,MAAS,GAAA;AAAA,QACb,GAAG,IAAI,KAAM,CAAA,MAAA;AAAA,QACb,oBAAA,EAAsB,IAAI,KAAM,CAAA,iBAAA;AAAA,QAChC,WAAA,EAAa,IAAI,KAAM,CAAA;AAAA,OACzB;AAEA,MAAM,MAAA,SAAA,GAAY,IAAIC,kBAAY,EAAA;AAClC,MAAU,SAAA,CAAA,EAAA,CAAG,QAAQ,CAAS,KAAA,KAAA;AAC5B,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,CAAA;AAAA,OACjC,CAAA;AAGD,MAAA,MAAM,aAAa,GAAI,CAAA;AAAA,QACrB,aAAe,EAAA,OAAA;AAAA,QACf,SAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA,EAAW,IAAI,KAAM,CAAA,SAAA;AAAA,QACrB,WAAA;AAAA,QACA;AAAA,OACD,CAAA;AAGD,MAAM,MAAA,UAAA,GAAa,GAAI,CAAA,KAAA,CAAM,UAAc,IAAA,IAAA;AAC3C,MAAA,MAAM,UAAa,GAAAC,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,UAAU,CAAA;AACrE,MAAM,MAAAV,mBAAA,CAAG,IAAK,CAAA,SAAA,EAAW,UAAU,CAAA;AAAA;AACrC,GACD,CAAA;AACH;;;;;"}
+{"version":3,"file":"cookiecutter.cjs.js","sources":["../../../src/actions/fetch/cookiecutter.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 {\n  UrlReaderService,\n  resolveSafeChildPath,\n} from '@backstage/backend-plugin-api';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport commandExists from 'command-exists';\nimport fs from 'fs-extra';\nimport path, { resolve as resolvePath } from 'path';\nimport { PassThrough, Writable } from 'stream';\nimport {\n  createTemplateAction,\n  fetchContents,\n  executeShellCommand,\n} from '@backstage/plugin-scaffolder-node';\nimport { examples } from './cookiecutter.examples';\nimport { ContainerRunner } from './ContainerRunner';\n\nexport class CookiecutterRunner {\n  private readonly containerRunner?: ContainerRunner;\n\n  constructor({ containerRunner }: { containerRunner?: ContainerRunner }) {\n    this.containerRunner = containerRunner;\n  }\n\n  private async fetchTemplateCookieCutter(\n    directory: string,\n  ): Promise<Record<string, JsonValue>> {\n    try {\n      return await fs.readJSON(path.join(directory, 'cookiecutter.json'));\n    } catch (ex) {\n      if (ex.code !== 'ENOENT') {\n        throw ex;\n      }\n\n      return {};\n    }\n  }\n\n  public async run({\n    workspacePath,\n    values,\n    logStream,\n    imageName,\n    templateDir,\n    templateContentsDir,\n  }: {\n    workspacePath: string;\n    values: JsonObject;\n    logStream: Writable;\n    imageName?: string;\n    templateDir: string;\n    templateContentsDir: string;\n  }): Promise<void> {\n    const intermediateDir = path.join(workspacePath, 'intermediate');\n    await fs.ensureDir(intermediateDir);\n    const resultDir = path.join(workspacePath, 'result');\n\n    // First lets grab the default cookiecutter.json file\n    const cookieCutterJson = await this.fetchTemplateCookieCutter(\n      templateContentsDir,\n    );\n\n    const cookieInfo = {\n      ...cookieCutterJson,\n      ...values,\n    };\n\n    await fs.writeJSON(path.join(templateDir, 'cookiecutter.json'), cookieInfo);\n\n    // Directories to bind on container\n    const mountDirs = {\n      [templateDir]: '/input',\n      [intermediateDir]: '/output',\n    };\n\n    // the command-exists package returns `true` or throws an error\n    const cookieCutterInstalled = await commandExists('cookiecutter').catch(\n      () => false,\n    );\n    if (cookieCutterInstalled) {\n      await executeShellCommand({\n        command: 'cookiecutter',\n        args: ['--no-input', '-o', intermediateDir, templateDir, '--verbose'],\n        logStream,\n      });\n    } else {\n      if (this.containerRunner === undefined) {\n        throw new Error(\n          'Invalid state: containerRunner cannot be undefined when cookiecutter is not installed',\n        );\n      }\n      await this.containerRunner.runContainer({\n        imageName: imageName ?? 'spotify/backstage-cookiecutter',\n        command: 'cookiecutter',\n        args: ['--no-input', '-o', '/output', '/input', '--verbose'],\n        mountDirs,\n        workingDir: '/input',\n        // Set the home directory inside the container as something that applications can\n        // write to, otherwise they will just fail trying to write to /\n        envVars: { HOME: '/tmp' },\n        logStream,\n      });\n    }\n\n    // if cookiecutter was successful, intermediateDir will contain\n    // exactly one directory.\n\n    const [generated] = await fs.readdir(intermediateDir);\n\n    if (generated === undefined) {\n      throw new Error('No data generated by cookiecutter');\n    }\n\n    await fs.move(path.join(intermediateDir, generated), resultDir);\n  }\n}\n\n/**\n * Creates a `fetch:cookiecutter` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://cookiecutter.readthedocs.io/} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n * @param options - Templating configuration.\n * @public\n */\nexport function createFetchCookiecutterAction(options: {\n  reader: UrlReaderService;\n  integrations: ScmIntegrations;\n  containerRunner?: ContainerRunner;\n}) {\n  const { reader, containerRunner, integrations } = options;\n\n  return createTemplateAction({\n    id: 'fetch:cookiecutter',\n    description:\n      'Downloads a template from the given URL into the workspace, and runs cookiecutter on it.',\n    examples,\n    schema: {\n      input: {\n        url: z =>\n          z.string({\n            description:\n              'Relative path or absolute URL pointing to the directory tree to fetch',\n          }),\n        targetPath: z =>\n          z\n            .string({\n              description:\n                'Target path within the working directory to download the contents to.',\n            })\n            .optional(),\n        values: z =>\n          z\n            .object(\n              {},\n              {\n                description: 'Values to pass on to cookiecutter for templating',\n              },\n            )\n            .passthrough(),\n        copyWithoutRender: z =>\n          z\n            .array(z.string(), {\n              description:\n                'Avoid rendering directories and files in the template',\n            })\n            .optional(),\n        extensions: z =>\n          z\n            .array(z.string(), {\n              description:\n                \"Jinja2 extensions to add filters, tests, globals or extend the parser. Extensions must be installed in the container or on the host where Cookiecutter executes. See the contrib directory in Backstage's repo for more information\",\n            })\n            .optional(),\n        imageName: z =>\n          z\n            .string({\n              description:\n                \"Specify a custom Docker image to run cookiecutter, to override the default: 'spotify/backstage-cookiecutter'. This can be used to execute cookiecutter with Template Extensions. Used only when a local cookiecutter is not found.\",\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      ctx.logger.info('Fetching and then templating using cookiecutter');\n      const workDir = await ctx.createTemporaryDirectory();\n      const templateDir = resolvePath(workDir, 'template');\n      const templateContentsDir = resolvePath(\n        templateDir,\n        \"{{cookiecutter and 'contents'}}\",\n      );\n      const resultDir = resolvePath(workDir, 'result');\n\n      if (\n        ctx.input.copyWithoutRender &&\n        !Array.isArray(ctx.input.copyWithoutRender)\n      ) {\n        throw new InputError(\n          'Fetch action input copyWithoutRender must be an Array',\n        );\n      }\n      if (ctx.input.extensions && !Array.isArray(ctx.input.extensions)) {\n        throw new InputError('Fetch action input extensions must be an Array');\n      }\n\n      await fetchContents({\n        reader,\n        integrations,\n        baseUrl: ctx.templateInfo?.baseUrl,\n        fetchUrl: ctx.input.url,\n        outputPath: templateContentsDir,\n      });\n\n      const cookiecutter = new CookiecutterRunner({ containerRunner });\n      const values = {\n        ...ctx.input.values,\n        _copy_without_render: ctx.input.copyWithoutRender,\n        _extensions: ctx.input.extensions,\n      };\n\n      const logStream = new PassThrough();\n      logStream.on('data', chunk => {\n        ctx.logger.info(chunk.toString());\n      });\n\n      // Will execute the template in ./template and put the result in ./result\n      await cookiecutter.run({\n        workspacePath: workDir,\n        logStream,\n        values: values,\n        imageName: ctx.input.imageName,\n        templateDir: templateDir,\n        templateContentsDir: templateContentsDir,\n      });\n\n      // Finally move the template result into the task workspace\n      const targetPath = ctx.input.targetPath ?? './';\n      const outputPath = resolveSafeChildPath(ctx.workspacePath, targetPath);\n      await fs.copy(resultDir, outputPath);\n    },\n  });\n}\n"],"names":["fs","path","commandExists","executeShellCommand","createTemplateAction","examples","resolvePath","InputError","fetchContents","PassThrough","resolveSafeChildPath"],"mappings":";;;;;;;;;;;;;;;;;AAmCO,MAAM,kBAAmB,CAAA;AAAA,EACb,eAAA;AAAA,EAEjB,WAAA,CAAY,EAAE,eAAA,EAA0D,EAAA;AACtE,IAAA,IAAA,CAAK,eAAkB,GAAA,eAAA;AAAA;AACzB,EAEA,MAAc,0BACZ,SACoC,EAAA;AACpC,IAAI,IAAA;AACF,MAAA,OAAO,MAAMA,mBAAG,CAAA,QAAA,CAASC,sBAAK,IAAK,CAAA,SAAA,EAAW,mBAAmB,CAAC,CAAA;AAAA,aAC3D,EAAI,EAAA;AACX,MAAI,IAAA,EAAA,CAAG,SAAS,QAAU,EAAA;AACxB,QAAM,MAAA,EAAA;AAAA;AAGR,MAAA,OAAO,EAAC;AAAA;AACV;AACF,EAEA,MAAa,GAAI,CAAA;AAAA,IACf,aAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,SAAA;AAAA,IACA,WAAA;AAAA,IACA;AAAA,GAQgB,EAAA;AAChB,IAAA,MAAM,eAAkB,GAAAA,qBAAA,CAAK,IAAK,CAAA,aAAA,EAAe,cAAc,CAAA;AAC/D,IAAM,MAAAD,mBAAA,CAAG,UAAU,eAAe,CAAA;AAClC,IAAA,MAAM,SAAY,GAAAC,qBAAA,CAAK,IAAK,CAAA,aAAA,EAAe,QAAQ,CAAA;AAGnD,IAAM,MAAA,gBAAA,GAAmB,MAAM,IAAK,CAAA,yBAAA;AAAA,MAClC;AAAA,KACF;AAEA,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,GAAG,gBAAA;AAAA,MACH,GAAG;AAAA,KACL;AAEA,IAAA,MAAMD,oBAAG,SAAU,CAAAC,qBAAA,CAAK,KAAK,WAAa,EAAA,mBAAmB,GAAG,UAAU,CAAA;AAG1E,IAAA,MAAM,SAAY,GAAA;AAAA,MAChB,CAAC,WAAW,GAAG,QAAA;AAAA,MACf,CAAC,eAAe,GAAG;AAAA,KACrB;AAGA,IAAA,MAAM,qBAAwB,GAAA,MAAMC,8BAAc,CAAA,cAAc,CAAE,CAAA,KAAA;AAAA,MAChE,MAAM;AAAA,KACR;AACA,IAAA,IAAI,qBAAuB,EAAA;AACzB,MAAA,MAAMC,wCAAoB,CAAA;AAAA,QACxB,OAAS,EAAA,cAAA;AAAA,QACT,MAAM,CAAC,YAAA,EAAc,IAAM,EAAA,eAAA,EAAiB,aAAa,WAAW,CAAA;AAAA,QACpE;AAAA,OACD,CAAA;AAAA,KACI,MAAA;AACL,MAAI,IAAA,IAAA,CAAK,oBAAoB,KAAW,CAAA,EAAA;AACtC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAEF,MAAM,MAAA,IAAA,CAAK,gBAAgB,YAAa,CAAA;AAAA,QACtC,WAAW,SAAa,IAAA,gCAAA;AAAA,QACxB,OAAS,EAAA,cAAA;AAAA,QACT,MAAM,CAAC,YAAA,EAAc,IAAM,EAAA,SAAA,EAAW,UAAU,WAAW,CAAA;AAAA,QAC3D,SAAA;AAAA,QACA,UAAY,EAAA,QAAA;AAAA;AAAA;AAAA,QAGZ,OAAA,EAAS,EAAE,IAAA,EAAM,MAAO,EAAA;AAAA,QACxB;AAAA,OACD,CAAA;AAAA;AAMH,IAAA,MAAM,CAAC,SAAS,CAAA,GAAI,MAAMH,mBAAA,CAAG,QAAQ,eAAe,CAAA;AAEpD,IAAA,IAAI,cAAc,KAAW,CAAA,EAAA;AAC3B,MAAM,MAAA,IAAI,MAAM,mCAAmC,CAAA;AAAA;AAGrD,IAAA,MAAMA,oBAAG,IAAK,CAAAC,qBAAA,CAAK,KAAK,eAAiB,EAAA,SAAS,GAAG,SAAS,CAAA;AAAA;AAElE;AAWO,SAAS,8BAA8B,OAI3C,EAAA;AACD,EAAA,MAAM,EAAE,MAAA,EAAQ,eAAiB,EAAA,YAAA,EAAiB,GAAA,OAAA;AAElD,EAAA,OAAOG,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,oBAAA;AAAA,IACJ,WACE,EAAA,0FAAA;AAAA,cACFC,8BAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,GAAA,EAAK,CACH,CAAA,KAAA,CAAA,CAAE,MAAO,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,CAAA;AAAA,QACH,UAAA,EAAY,CACV,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,MAAA,EAAQ,OACN,CACG,CAAA,MAAA;AAAA,UACC,EAAC;AAAA,UACD;AAAA,YACE,WAAa,EAAA;AAAA;AACf,UAED,WAAY,EAAA;AAAA,QACjB,mBAAmB,CACjB,CAAA,KAAA,CAAA,CACG,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UACjB,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,YAAY,CACV,CAAA,KAAA,CAAA,CACG,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UACjB,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,SAAA,EAAW,CACT,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WACE,EAAA;AAAA,SACH,EACA,QAAS;AAAA;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,iDAAiD,CAAA;AACjE,MAAM,MAAA,OAAA,GAAU,MAAM,GAAA,CAAI,wBAAyB,EAAA;AACnD,MAAM,MAAA,WAAA,GAAcC,YAAY,CAAA,OAAA,EAAS,UAAU,CAAA;AACnD,MAAA,MAAM,mBAAsB,GAAAA,YAAA;AAAA,QAC1B,WAAA;AAAA,QACA;AAAA,OACF;AACA,MAAM,MAAA,SAAA,GAAYA,YAAY,CAAA,OAAA,EAAS,QAAQ,CAAA;AAE/C,MACE,IAAA,GAAA,CAAI,MAAM,iBACV,IAAA,CAAC,MAAM,OAAQ,CAAA,GAAA,CAAI,KAAM,CAAA,iBAAiB,CAC1C,EAAA;AACA,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR;AAAA,SACF;AAAA;AAEF,MAAI,IAAA,GAAA,CAAI,MAAM,UAAc,IAAA,CAAC,MAAM,OAAQ,CAAA,GAAA,CAAI,KAAM,CAAA,UAAU,CAAG,EAAA;AAChE,QAAM,MAAA,IAAIA,kBAAW,gDAAgD,CAAA;AAAA;AAGvE,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;AAAA,OACb,CAAA;AAED,MAAA,MAAM,YAAe,GAAA,IAAI,kBAAmB,CAAA,EAAE,iBAAiB,CAAA;AAC/D,MAAA,MAAM,MAAS,GAAA;AAAA,QACb,GAAG,IAAI,KAAM,CAAA,MAAA;AAAA,QACb,oBAAA,EAAsB,IAAI,KAAM,CAAA,iBAAA;AAAA,QAChC,WAAA,EAAa,IAAI,KAAM,CAAA;AAAA,OACzB;AAEA,MAAM,MAAA,SAAA,GAAY,IAAIC,kBAAY,EAAA;AAClC,MAAU,SAAA,CAAA,EAAA,CAAG,QAAQ,CAAS,KAAA,KAAA;AAC5B,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,CAAA;AAAA,OACjC,CAAA;AAGD,MAAA,MAAM,aAAa,GAAI,CAAA;AAAA,QACrB,aAAe,EAAA,OAAA;AAAA,QACf,SAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA,EAAW,IAAI,KAAM,CAAA,SAAA;AAAA,QACrB,WAAA;AAAA,QACA;AAAA,OACD,CAAA;AAGD,MAAM,MAAA,UAAA,GAAa,GAAI,CAAA,KAAA,CAAM,UAAc,IAAA,IAAA;AAC3C,MAAA,MAAM,UAAa,GAAAC,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,UAAU,CAAA;AACrE,MAAM,MAAAV,mBAAA,CAAG,IAAK,CAAA,SAAA,EAAW,UAAU,CAAA;AAAA;AACrC,GACD,CAAA;AACH;;;;;"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { Writable } from 'stream';
 import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
+import * as zod from 'zod';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { UrlReaderService } from '@backstage/backend-plugin-api';
 import { ScmIntegrations } from '@backstage/integration';
@@ -52,7 +53,7 @@ declare function createFetchCookiecutterAction(options: {
     containerRunner?: ContainerRunner;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     url: string;
-    values: Record<string, unknown>;
+    values: zod.objectOutputType<{}, zod.ZodTypeAny, "passthrough">;
     targetPath?: string | undefined;
     copyWithoutRender?: string[] | undefined;
     extensions?: string[] | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-cookiecutter",
-  "version": "0.3.11-next.2",
+  "version": "0.3.12",
   "description": "A module for the scaffolder backend that lets you template projects using cookiecutter",
   "backstage": {
     "role": "backend-plugin-module",
@@ -51,13 +51,13 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-defaults": "0.11.0-next.2",
-    "@backstage/backend-plugin-api": "1.4.0-next.1",
-    "@backstage/config": "1.3.2",
-    "@backstage/errors": "1.2.7",
-    "@backstage/integration": "1.17.0",
-    "@backstage/plugin-scaffolder-node": "0.9.0-next.2",
-    "@backstage/types": "1.2.1",
+    "@backstage/backend-defaults": "^0.11.0",
+    "@backstage/backend-plugin-api": "^1.4.0",
+    "@backstage/config": "^1.3.2",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/integration": "^1.17.0",
+    "@backstage/plugin-scaffolder-node": "^0.9.0",
+    "@backstage/types": "^1.2.1",
     "command-exists": "^1.2.9",
     "fs-extra": "^11.2.0",
     "winston": "^3.2.1",
@@ -65,9 +65,9 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.6.0-next.2",
-    "@backstage/cli": "0.33.0-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.3.0-next.2",
+    "@backstage/backend-test-utils": "^1.6.0",
+    "@backstage/cli": "^0.33.0",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.3.0",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^11.0.0"
   }