@znemz/cfn-include 2.1.23 → 4.0.0

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,196 @@
+#!/usr/bin/env node
+import { execSync } from 'node:child_process';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { readFileSync } from 'node:fs';
+import _ from 'lodash';
+import include from './index.js';
+import * as yaml from './lib/yaml.js';
+import Client from './lib/cfnclient.js';
+import replaceEnv from './lib/replaceEnv.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+// Read package.json using fs instead of import assertion
+const pkg = JSON.parse(readFileSync(path.join(__dirname, '../package.json'), 'utf8'));
+const { env } = process;
+const { default: yargs } = await import('yargs');
+const { hideBin } = await import('yargs/helpers');
+const opts = yargs(hideBin(process.argv))
+    .version(false)
+    .command('$0 [path] [options]', pkg.description, (y) => y.positional('path', {
+    positional: true,
+    desc: 'location of template. Either path to a local file, URL or file on an S3 bucket (e.g. s3://bucket-name/example.template)',
+    required: false,
+}))
+    .options({
+    minimize: {
+        desc: 'minimize JSON output',
+        default: false,
+        boolean: true,
+        alias: 'm',
+    },
+    metadata: {
+        desc: 'add build metadata to output',
+        default: false,
+        boolean: true,
+    },
+    validate: {
+        desc: 'validate compiled template',
+        default: false,
+        boolean: true,
+        alias: 't',
+    },
+    yaml: {
+        desc: 'output yaml instead of json',
+        default: false,
+        boolean: true,
+        alias: 'y',
+    },
+    lineWidth: {
+        desc: 'output yaml line width',
+        default: 200,
+        number: true,
+        alias: 'l',
+    },
+    bucket: {
+        desc: 'bucket name required for templates larger than 50k',
+    },
+    context: {
+        desc: 'template full path. only utilized for stdin when the template is piped to this script',
+        required: false,
+        string: true,
+    },
+    prefix: {
+        desc: 'prefix for templates uploaded to the bucket',
+        default: 'cfn-include',
+    },
+    enable: {
+        string: true,
+        desc: `enable different options: ['env','eval'] or a combination of both via comma.`,
+        choices: ['', 'env', 'env,eval', 'eval,env', 'eval'],
+        default: '',
+    },
+    inject: {
+        alias: 'i',
+        string: true,
+        desc: `JSON string payload to use for template injection.`,
+        coerce: (valStr) => JSON.parse(valStr),
+    },
+    doLog: {
+        boolean: true,
+        desc: `console log out include options in recurse step`,
+    },
+    'ref-now-ignore-missing': {
+        boolean: true,
+        desc: 'do not fail if Fn::RefNow reference cannot be resolved',
+    },
+    'ref-now-ignores': {
+        string: true,
+        desc: 'comma-separated list of reference names to ignore if not found',
+    },
+    version: {
+        boolean: true,
+        desc: 'print version and exit',
+        callback() {
+            console.log(pkg.version);
+            process.exit(0);
+        },
+    },
+})
+    .parse();
+// make enable an array
+const enableOptions = opts.enable.split(',');
+// Parse ref-now-ignores into an array
+const refNowIgnores = opts['ref-now-ignores'] ? opts['ref-now-ignores'].split(',').map((s) => s.trim()) : [];
+let promise;
+if (opts.path) {
+    let location;
+    const protocol = opts.path.match(/^\w+:\/\//);
+    if (protocol)
+        location = opts.path;
+    else if (path.parse(opts.path).root)
+        location = `file://${opts.path}`;
+    else
+        location = `file://${path.join(process.cwd(), opts.path)}`;
+    promise = include({
+        url: location,
+        doEnv: enableOptions.includes('env'),
+        doEval: enableOptions.includes('eval'),
+        inject: opts.inject,
+        doLog: opts.doLog,
+        refNowIgnoreMissing: opts['ref-now-ignore-missing'],
+        refNowIgnores: refNowIgnores,
+    });
+}
+else {
+    promise = new Promise((resolve, reject) => {
+        process.stdin.setEncoding('utf8');
+        const rawData = [];
+        process.stdin.on('data', (chunk) => rawData.push(chunk));
+        process.stdin.on('error', (err) => reject(err));
+        process.stdin.on('end', () => resolve(rawData.join('')));
+    }).then((template) => {
+        if (template.length === 0) {
+            console.error('empty template received from stdin');
+            process.exit(1);
+        }
+        const location = opts.context ? path.resolve(opts.context) : path.join(process.cwd(), 'template.yml');
+        const processedTemplate = enableOptions.includes('env') ? replaceEnv(template) : template;
+        return include({
+            template: yaml.load(processedTemplate),
+            url: `file://${location}`,
+            doEnv: enableOptions.includes('env'),
+            doEval: enableOptions.includes('eval'),
+            inject: opts.inject,
+            doLog: opts.doLog,
+            refNowIgnoreMissing: opts['ref-now-ignore-missing'],
+            refNowIgnores: refNowIgnores,
+        }).catch((err) => console.error(err));
+    });
+}
+promise
+    .then(function (template) {
+    if (opts.metadata) {
+        let stdout;
+        try {
+            stdout = execSync('git log -n 1 --pretty=%H', {
+                stdio: [0, 'pipe', 'ignore'],
+            })
+                .toString()
+                .trim();
+        }
+        catch {
+            // ignore git errors
+        }
+        _.defaultsDeep(template, {
+            Metadata: {
+                CfnInclude: {
+                    GitCommit: stdout,
+                    BuildDate: new Date().toISOString(),
+                },
+            },
+        });
+    }
+    if (opts.validate) {
+        const cfn = new Client({
+            region: env.AWS_REGION || env.AWS_DEFAULT_REGION || 'us-east-1',
+            bucket: opts.bucket,
+            prefix: opts.prefix,
+        });
+        return cfn.validateTemplate(JSON.stringify(template)).then(() => template);
+    }
+    return template;
+})
+    .then((template) => {
+    console.log(opts.yaml ? yaml.dump(template, { lineWidth: opts.lineWidth }) : JSON.stringify(template, null, opts.minimize ? null : 2));
+})
+    .catch(function (err) {
+    if (typeof err?.toString === 'function')
+        console.error(err.toString());
+    else
+        console.error(err);
+    if (err?.stack)
+        console.log(err.stack);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,CAAC,MAAM,QAAQ,CAAC;AAEvB,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAE3C,yDAAyD;AACzD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAEtF,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;AAmBxB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;AACjD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC;AAElD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACtC,OAAO,CAAC,KAAK,CAAC;KACd,OAAO,CAAC,qBAAqB,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAM,EAAE,EAAE,CAC1D,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE;IACnB,UAAU,EAAE,IAAI;IAChB,IAAI,EAAE,yHAAyH;IAC/H,QAAQ,EAAE,KAAK;CAChB,CAAC,CACH;KACA,OAAO,CAAC;IACP,QAAQ,EAAE;QACR,IAAI,EAAE,sBAAsB;QAC5B,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,GAAG;KACX;IACD,QAAQ,EAAE;QACR,IAAI,EAAE,8BAA8B;QACpC,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,IAAI;KACd;IACD,QAAQ,EAAE;QACR,IAAI,EAAE,4BAA4B;QAClC,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,GAAG;KACX;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,6BAA6B;QACnC,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,GAAG;KACX;IACD,SAAS,EAAE;QACT,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,GAAG;QACZ,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,GAAG;KACX;IACD,MAAM,EAAE;QACN,IAAI,EAAE,oDAAoD;KAC3D;IACD,OAAO,EAAE;QACP,IAAI,EAAE,uFAAuF;QAC7F,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,IAAI;KACb;IACD,MAAM,EAAE;QACN,IAAI,EAAE,6CAA6C;QACnD,OAAO,EAAE,aAAa;KACvB;IACD,MAAM,EAAE;QACN,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,8EAA8E;QACpF,OAAO,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC;QACpD,OAAO,EAAE,EAAE;KACZ;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,oDAAoD;QAC1D,MAAM,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;KAC/C;IACD,KAAK,EAAE;QACL,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,iDAAiD;KACxD;IACD,wBAAwB,EAAE;QACxB,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,wDAAwD;KAC/D;IACD,iBAAiB,EAAE;QACjB,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,gEAAgE;KACvE;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,wBAAwB;QAC9B,QAAQ;YACN,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;KACF;CACF,CAAC;KACD,KAAK,EAAqC,CAAC;AAE9C,uBAAuB;AACvB,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAE7C,sCAAsC;AACtC,MAAM,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAE7G,IAAI,OAAqB,CAAC;AAC1B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,IAAI,QAAgB,CAAC;IACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC9C,IAAI,QAAQ;QAAE,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;SAC9B,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI;QAAE,QAAQ,GAAG,UAAU,IAAI,CAAC,IAAI,EAAE,CAAC;;QACjE,QAAQ,GAAG,UAAU,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IAChE,OAAO,GAAG,OAAO,CAAC;QAChB,GAAG,EAAE,QAAQ;QACb,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;QACpC,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtC,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,mBAAmB,EAAE,IAAI,CAAC,wBAAwB,CAAC;QACnD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;AACL,CAAC;KAAM,CAAC;IACN,OAAO,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAChD,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACjE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAChD,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnB,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;YACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;QAEtG,MAAM,iBAAiB,GAAG,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE1F,OAAO,OAAO,CAAC;YACb,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,iBAA2B,CAAQ;YACvD,GAAG,EAAE,UAAU,QAAQ,EAAE;YACzB,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;YACpC,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC;YACtC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,mBAAmB,EAAE,IAAI,CAAC,wBAAwB,CAAC;YACnD,aAAa,EAAE,aAAa;SAC7B,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,OAAO;KACJ,IAAI,CAAC,UAAU,QAAa;IAC3B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,IAAI,MAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,GAAG,QAAQ,CAAC,0BAA0B,EAAE;gBAC5C,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC;aAC7B,CAAC;iBACC,QAAQ,EAAE;iBACV,IAAI,EAAE,CAAC;QACZ,CAAC;QAAC,MAAM,CAAC;YACP,oBAAoB;QACtB,CAAC;QACD,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE;YACvB,QAAQ,EAAE;gBACR,UAAU,EAAE;oBACV,SAAS,EAAE,MAAM;oBACjB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;iBACpC;aACF;SACF,CAAC,CAAC;IACL,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC;YACrB,MAAM,EAAE,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,kBAAkB,IAAI,WAAW;YAC/D,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;KACD,IAAI,CAAC,CAAC,QAAa,EAAE,EAAE;IACtB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACzI,CAAC,CAAC;KACD,KAAK,CAAC,UAAU,GAAQ;IACvB,IAAI,OAAO,GAAG,EAAE,QAAQ,KAAK,UAAU;QAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;;QAClE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxB,IAAI,GAAG,EAAE,KAAK;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACvC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import type { IncludeOptions as TypeIncludeOptions, Scope, TemplateValue, TemplateDocument } from './types/index.js';
+export type { TypeIncludeOptions as IncludeOptions, TemplateDocument, TemplateValue };
+interface MainIncludeOptions {
+    template?: TemplateValue;
+    url: string;
+    scope?: Scope;
+    doEnv?: boolean;
+    doEval?: boolean;
+    inject?: Record<string, string>;
+    doLog?: boolean;
+    refNowIgnores?: string[];
+    refNowIgnoreMissing?: boolean;
+    refNowReturnType?: 'arn' | 'name';
+}
+/**
+ * Main entry point for cfn-include template processing
+ */
+export default function include(options: MainIncludeOptions): Promise<any>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,EACV,cAAc,IAAI,kBAAkB,EAEpC,KAAK,EACL,aAAa,EACb,gBAAgB,EAGjB,MAAM,kBAAkB,CAAC;AAG1B,YAAY,EAAE,kBAAkB,IAAI,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC;AAGtF,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,gBAAgB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACnC;AAyBD;;GAEG;AACH,wBAA8B,OAAO,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CA0B/E"}