@znemz/cfn-include 1.6.4 → 2.0.0

package/lib/cfnclient.js

@@ -1,13 +1,22 @@
-const { CloudFormation, S3 } = require('aws-sdk-proxy');
+const {
+  CloudFormationClient,
+  ValidateTemplateCommand,
+} = require('@aws-sdk/client-cloudformation');
+const { S3Client, PutObjectCommand, DeleteObjectCommand } = require('@aws-sdk/client-s3');
+const { addProxyToClient } = require('aws-sdk-v3-proxy');
+
 const { posix: path } = require('path');
 const crypto = require('crypto');
 
+const S3 = (opts = {}) => addProxyToClient(new S3Client(opts));
+const CloudFormation = (opts = {}) => addProxyToClient(new CloudFormationClient(opts));
+
 class Client {
   constructor({ region = 'us-east-1', bucket, prefix }) {
-    this.client = new CloudFormation({
+    this.client = CloudFormation({
       region,
     });
-    this.s3 = new S3();
+    this.s3 = S3();
     this.bucket = bucket;
     this.prefix = prefix;
     this.region = region;
@@ -21,22 +30,28 @@ class Client {
 
   async uploadTemplate(tpl, callback) {
     const key = path.join(this.prefix, `${this.digest(tpl)}.json`);
-    await this.s3.putObject({
-      Body: tpl,
-      Bucket: this.bucket,
-      Key: key,
-    }).promise();
+    await this.s3.Send(
+      new PutObjectCommand({
+        Body: tpl,
+        Bucket: this.bucket,
+        Key: key,
+      })
+    );
 
     let res, err;
     try {
       res = await callback(key);
-    } catch(e) {
+    } catch (e) {
       err = e;
     }
-    await this.s3.deleteObject({
-      Bucket: this.bucket,
-      Key: key,
-    }).promise().catch(() => {});
+    await this.s3
+      .send(
+        new DeleteObjectCommand({
+          Bucket: this.bucket,
+          Key: key,
+        })
+      )
+      .catch(() => {});
     if (err) throw err;
     return res;
   }
@@ -50,14 +65,22 @@ class Client {
       throw 'Template exceeds maximum size of 450k';
     }
     if (needsUpload) {
-      return this.uploadTemplate(tpl, (key) => this.client.validateTemplate({
-        TemplateURL: `https://s3.${this.region}.amazonaws.com/${this.bucket}/${key}`,
-      }).promise());
+      return this.uploadTemplate(tpl, (key) =>
+        this.client
+          .send(
+            new ValidateTemplateCommand({
+              TemplateURL: `https://s3.${this.region}.amazonaws.com/${this.bucket}/${key}`,
+            })
+          )
+          .promise()
+      );
     }
 
-    return this.client.validateTemplate({
-      TemplateBody: tpl,
-    }).promise();
+    return this.client.send(
+      new ValidateTemplateCommand({
+        TemplateBody: tpl,
+      })
+    );
   }
 }
 

package/lib/include/api.js

@@ -1,11 +1,10 @@
 var _ = require('lodash'),
   AWS = require('aws-sdk-proxy'),
-  jmespath = require('jmespath')
-  { getParser } = require('./query');
+  jmespath = require('jmespath');
 
 module.exports = function(args) {
   var service = new AWS[args.service](args.region ? { region: args.region } : null);
   return service[args.action](args.parameters ? args.parameters : {}).promise().then(function(res) {
-    return args.query ? getParser(args.parser)(res, args.query) : res;
+    return args.query ? jmespath.search(res, args.query) : res;
   });
 }

package/lib/parselocation.js

@@ -1,13 +1,17 @@
-var _ = require('lodash');
+var { isUndefined } = require('lodash');
 
 module.exports = function parseLocation(location) {
   if(!location) return {};
+  if (!location.match) {
+    console.error('location.match is not a function', location);
+  }
   var parsed = location.match(/^(((\w+):)?\/\/)?(.*?)([\\\/](.*))?$/);
+
   return {
     protocol: parsed[3],
     host: parsed[4],
     path: parsed[5],
-    relative: _.isUndefined(parsed[1]) ? true : false,
+    relative: isUndefined(parsed[1]),
     raw: location,
   };
 }

package/lib/promise.js

@@ -1,26 +1,21 @@
+const Promise = require('bluebird');
+const _ = require('lodash');
 
-module.exports = {
-  map: (arr, fn) => {
-    return arr.then(res => {
-      return Promise.all(res.map(fn));
-    });
-  },
-  // https://github.com/expo/promise-props
-  props: obj => {
-    var awaitables = [];
-    var keys = Object.keys(obj);
-    for (var i = 0; i < keys.length; i++) {
-      var key = keys[i];
-      var a$ = obj[key];
-      awaitables.push(a$);
-    }
-    return Promise.all(awaitables).then(function (results) {
-      var byName = {};
-      for (var i = 0; i < keys.length; i++) {
-        var key = keys[i];
-        byName[key] = results[i];
+/*
+  Maps over objects or iterables just like lodash.
+*/
+const mapWhatever = (promises, cb) =>
+  Promise.try(() =>
+    Promise.resolve(promises).then((arrayOrObject) => {
+      if (_.isArray(arrayOrObject)) {
+        return Promise.map(arrayOrObject, cb);
       }
-      return byName;
-    });
-  }
-}
+      const size = Object.values(arrayOrObject).length;
+      return Promise.all(_.map(arrayOrObject, (value, key) => cb(value, key, size)));
+    })
+  );
+
+module.exports = {
+  mapWhatever,
+  mapX: mapWhatever,
+};

package/lib/replaceEnv.js

@@ -1,25 +1,31 @@
-function replaceEnv(template, env = process.env) {
-  if (!template || typeof template != "string") {
-    return template
+const passThrough = (template) => template
+const replaceProcessEnv = (template) => replaceEnv(template, process.env, false)
+
+const replaceEnv = (template, inject = {}, doEnv) => {
+  processTemplate = doEnv ? replaceProcessEnv : passThrough;
+
+  if (!template || typeof template !== "string") {
+    // return template;
+    return processTemplate(template)
   };
 
-  const keys = Object.keys(env);
+  const keys = Object.keys(inject);
 
   for (let i = 0; i < keys.length; i++) {
     const key = keys[i];
-    let val = env[key];
-
-    if (!val) {
-      // we have an empty key fill it w/ an empty value
-      val = `""`;
-    }
+    let val = inject[key];
 
     template = template
       .replace(new RegExp(`\\$${key}`, "g"), val)
       .replace(new RegExp(`\\$\{${key}}`, "g"), val);
   }
 
-  return template;
+  // return template;
+  return processTemplate(template);
 }
 
+const IsRegExVar = (str) =>  /\$\w+/.test(str) || /\$\{\w+\}/.test(str)
+
+replaceEnv.IsRegExVar = IsRegExVar; // hack to be backward compat
+
 module.exports = replaceEnv;

package/lib/schema.js

@@ -1,5 +1,5 @@
 var yaml = require('js-yaml'),
-_ = require('lodash');
+  _ = require('lodash');
 
 var tags = [
   { short: 'Include', full: 'Fn::Include', type: 'scalar' },
@@ -9,6 +9,8 @@ var tags = [
   { short: 'Map', full: 'Fn::Map', type: 'sequence' },
   { short: 'Length', full: 'Fn::Length', type: 'sequence' },
   { short: 'Flatten', full: 'Fn::Flatten', type: 'sequence' },
+  { short: 'FlattenDeep', full: 'Fn::FlattenDeep', type: 'sequence' },
+  { short: 'Uniq', full: 'Fn::Uniq', type: 'sequence' },
   { short: 'GetEnv', full: 'Fn::GetEnv', type: 'sequence' },
   { short: 'GetEnv', full: 'Fn::GetEnv', type: 'scalar' },
   { short: 'Merge', full: 'Fn::Merge', type: 'sequence' },
@@ -16,6 +18,24 @@ var tags = [
   { short: 'LowerCamelCase', full: 'Fn::LowerCamelCase', type: 'scalar' },
   { short: 'UpperCamelCase', full: 'Fn::UpperCamelCase', type: 'scalar' },
   { short: 'Sequence', full: 'Fn::Sequence', type: 'sequence' },
+  { short: 'DeepMerge', full: 'Fn::DeepMerge', type: 'sequence' },
+  { short: 'Compact', full: 'Fn::Compact', type: 'sequence' },
+  { short: 'Concat', full: 'Fn::Concat', type: 'sequence' },
+  { short: 'Sort', full: 'Fn::Sort', type: 'sequence' },
+  { short: 'SortedUniq', full: 'Fn::SortedUniq', type: 'sequence' },
+  { short: 'SortBy', full: 'Fn::SortBy', type: 'mapping' },
+  { short: 'SortObject', full: 'Fn::SortObject', type: 'mapping' },
+  { short: 'ObjectKeys', full: 'Fn::ObjectKeys', type: 'sequence' },
+  { short: 'ObjectValues', full: 'Fn::ObjectValues', type: 'sequence' },
+  { short: 'Filenames', full: 'Fn::Filenames', type: 'sequence' },
+  { short: 'Without', full: 'Fn::Without', type: 'sequence' },
+  { short: 'Omit', full: 'Fn::Omit', type: 'sequence' },
+  { short: 'Omit', full: 'Fn::Omit', type: 'mapping' },
+  { short: 'OmitEmpty', full: 'Fn::OmitEmpty', type: 'mapping' },
+  { short: 'Eval', full: 'Fn::Eval', type: 'sequence' },
+  { short: 'IfEval', full: 'Fn::IfEval', type: 'mapping' },
+  { short: 'JoinNow', full: 'Fn::JoinNow', type: 'scalar' },
+  { short: 'ApplyTags', full: 'Fn::ApplyTags', type: 'mapping' },
 
   // http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html
   { short: 'Base64', full: 'Fn::Base64', type: 'scalar' },
@@ -45,21 +65,50 @@ var tags = [
   { short: 'Not', full: 'Fn::Not', type: 'sequence' },
   { short: 'Or', full: 'Fn::Or', type: 'sequence' },
   { short: 'Condition', full: 'Condition', type: 'scalar' },
-
-
-].map(function(fn) {
+].map(function (fn) {
   return new yaml.Type('!' + fn.short, {
     kind: fn.type,
-    construct: function(obj) {
-      if(fn.dotSyntax && _.isString(obj)) {
+    construct: function (obj) {
+      if (fn.dotSyntax && _.isString(obj)) {
         var indexOfDot = obj.indexOf('.');
-        if(indexOfDot != -1)
-          obj = [obj.substr(0, indexOfDot), obj.substr(indexOfDot + 1)];
+        if (indexOfDot != -1) obj = [obj.substr(0, indexOfDot), obj.substr(indexOfDot + 1)];
         else obj = [obj];
       }
       return _.fromPairs([[fn.full, obj]]);
-    }
+    },
   });
 });
 
+// build array of strings of all Amazon Intrinsic functions
+const BANG_AMAZON_FUNCS = [
+  'Base64',
+  'FindInMap',
+  'GetAtt',
+  'GetAZs',
+  'ImportValue',
+  'Join',
+  'Select',
+  'Split',
+  'Sub',
+  'Ref',
+  'Cidr',
+  'GetParam',
+  'And',
+  'Equals',
+  'If',
+  'Not',
+  'Or',
+  'Condition',
+];
+
+const EXPLICIT_AMAZON_FUNCS = BANG_AMAZON_FUNCS.map((f) => `Fn::${f}`);
+
 module.exports = yaml.Schema.create(tags);
+
+module.exports.EXPLICIT_AMAZON_FUNCS = EXPLICIT_AMAZON_FUNCS;
+module.exports.BANG_AMAZON_FUNCS = BANG_AMAZON_FUNCS;
+
+// Test the function key to make sure it's something
+// we should process.
+module.exports.isOurExplicitFunction = (testKeyForFunc) =>
+  /Fn::.*/.test(testKeyForFunc) && EXPLICIT_AMAZON_FUNCS.indexOf(testKeyForFunc) === -1;

package/lib/yaml.js

@@ -1,26 +1,22 @@
-var jsmin = require('jsmin').jsmin,
-  yaml = require('js-yaml'),
-  yamlSchema = require('./schema');
+const minify = require('jsonminify');
+const yaml = require('js-yaml');
+const yamlSchema = require('./schema');
 
 module.exports = {
-  load: function (res) {
-    var json;
+  load: (res) => {
+    let json;
     try {
       json = yaml.safeLoad(res, { schema: yamlSchema });
-    } catch(yamlErr) {
+    } catch (yamlErr) {
       try {
-        json = JSON.parse(jsmin(res));
-      } catch(jsonErr) {
-        var err = new Error([yamlErr, jsonErr]);
+        json = JSON.parse(minify(res));
+      } catch (jsonErr) {
+        const err = new Error([yamlErr, jsonErr]);
         err.name = 'SyntaxError';
         throw err;
       }
     }
     return json;
   },
-  dump: function(obj) {
-    return yaml.safeDump(obj, {
-      sortKeys: true,
-    })
-  }
-}
+  dump: (obj, opts) => yaml.safeDump(obj, { sortKeys: true, ...opts }),
+};

package/package.json

@@ -1,60 +1,84 @@
 {
   "name": "@znemz/cfn-include",
-  "version": "1.6.4",
+  "version": "2.0.0",
   "description": "Preprocessor for CloudFormation templates with support for loops and flexible include statements",
-  "main": "index.js",
-  "scripts": {
-    "test": "mocha --timeout 20000 --bail t/include.js t/cli.js t/replaceEnv.js"
-  },
-  "bin": {
-    "cfn-include": "bin/cli.js"
-  },
-  "files": [
-    "index.js",
-    "bin/",
-    "lib/"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/nmccready/cfn-include.git"
-  },
   "keywords": [
     "aws",
     "cfn",
     "cloudformation",
     "include"
   ],
-  "author": {
-    "name": "Nicholas McCready",
-    "email": "nemtcan@gmail.com"
+  "homepage": "https://github.com/nmccready/cfn-include#readme",
+  "bugs": {
+    "url": "https://github.com/nmccready/cfn-include/issues"
   },
-  "originalAuthor": {
-    "name": "Moritz Onken",
-    "email": "onken@netcubed.de"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nmccready/cfn-include.git"
   },
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/nmccready/cfn-include/issues"
+  "author": {
+    "name": "Nicholas McCready",
+    "email": "nemtcan@gmail.com"
   },
-  "homepage": "https://github.com/nmccready/cfn-include#readme",
-  "engines": {
-    "node": ">=8"
+  "main": "index.js",
+  "bin": {
+    "cfn-include": "bin/cli.js"
   },
-  "peerDependencies": {
-    "aws-sdk": "^2.205.0"
+  "files": [
+    "index.js",
+    "bin/",
+    "lib/"
+  ],
+  "scripts": {
+    "better-audit": "better-npm-audit audit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "prepare": "sort-package-json",
+    "serve": "serve ./t/fixtures -l 9999",
+    "test": "npm run test:this",
+    "test:this": "run-p -r serve test:run",
+    "test:run": "sleep 1 && mocha --timeout 20000 --bail t/include.js t/cli.js t/replaceEnv.js"
   },
   "dependencies": {
-    "aws-sdk-proxy": "^1.0.0",
+    "@aws-sdk/client-cloudformation": "^3.637.0",
+    "@aws-sdk/client-s3": "^3.637.0",
+    "@znemz/cft-utils": "0.1.1",
+    "@znemz/sort-object": "^3.0.4",
+    "aws-sdk-v3-proxy": "2.1.2",
+    "bluebird": "^3.7.2",
     "deepmerge": "^4.2.2",
-    "jmespath": "^0.15.0",
+    "glob": "^11.0.0",
+    "jmespath": "^0.16.0",
     "js-yaml": "^3.14.0",
-    "jsmin": "1.0.1",
-    "lodash": "^4.17.20",
-    "path-parse": "^1.0.5",
-    "yargs": "^15.4.1"
+    "jsonminify": "^0.4.1",
+    "lodash": "^4.17.21",
+    "path-parse": "~1.0.7",
+    "proxy-agent": "6.3.1",
+    "yargs": "17"
   },
   "devDependencies": {
-    "mocha": "^7.2.0",
-    "proxy-agent": "^3.1.1"
+    "@commitlint/cli": "^19",
+    "@commitlint/config-conventional": "^19",
+    "better-npm-audit": "3.7.3",
+    "commit-and-tag-version": "12",
+    "commitlint": "19",
+    "eslint": "8",
+    "eslint-config-prettier": "9",
+    "eslint-config-standard": "17",
+    "eslint-plugin-mocha": "10",
+    "eslint-plugin-prettier": "5",
+    "mocha": "10.2.0",
+    "npm-run-all": "4.1.5",
+    "prettier": "3",
+    "serve": "14.2.1",
+    "sort-package-json": "2.10.1"
+  },
+  "engines": {
+    "node": ">=8"
+  },
+  "originalAuthor": {
+    "name": "Moritz Onken",
+    "email": "onken@netcubed.de"
   }
 }