@karmaniverous/get-dotenv 2.4.4 → 2.6.0

package/README.md

@@ -85,6 +85,7 @@ dotenv files. You can:
   arguments for other options.
 * Specify the token that identifies dotenv files (e.g. '.env').
 * Specify the token that identifies private vatiables (e.g. '.local').
+* Load AWS SSO session credentials from an AWS Toolkit profile.
 
 Options:
   -p, --paths <strings...>            space-delimited paths to dotenv directory (default './')
@@ -103,6 +104,7 @@ Options:
   -t, --dotenv-token <string>         token indicating a dotenv file (default: '.env')
   -i, --private-token <string>        token indicating private variables (default: 'local')
   -q, --quit-on-error                 terminate sequential process on error (default: false)
+  -a, --aws-sso-profile <string>      local AWS SSO profile (follows dotenv-expand rules)
   -h, --help                          display help for command
 ```
 

package/bin/getdotenv/index.js

@@ -2,20 +2,19 @@
 
 // Import npm packages.
 import spawn from 'cross-spawn';
-import _ from 'lodash';
 import { parseArgsStringToArgv } from 'string-argv';
 
 // Import package exports.
-import { getDotenv, parseBranch } from '@karmaniverous/get-dotenv';
+import {
+  dotenvExpand,
+  getAwsSsoCredentials,
+  getDotenv,
+  parseBranch,
+} from '@karmaniverous/get-dotenv';
 
 // Create CLI.
 import { program } from 'commander';
 
-const envMerge = (value) =>
-  !_.isUndefined(value) && value.startsWith('$')
-    ? process.env[value.slice(1)]
-    : value;
-
 // CLI description.
 program
   .name('getdotenv')
@@ -40,6 +39,7 @@ program
       `  arguments for other options.`,
       `* Specify the token that identifies dotenv files (e.g. '.env').`,
       `* Specify the token that identifies private vatiables (e.g. '.local').`,
+      `* Load AWS SSO session credentials from an AWS Toolkit profile.`,
     ].join('\n')
   );
 
@@ -57,17 +57,17 @@ program
   .option(
     '-d, --default-environment <string>',
     'default environment (prefix with $ to use environment variable)',
-    envMerge
+    dotenvExpand
   )
   .option(
     '-b, --branch-to-default',
     'derive default environment from the current git branch (default: false)',
-    envMerge
+    dotenvExpand
   )
   .option(
     '-e, --environment <string>',
     'designated environment (prefix with $ to use environment variable)',
-    envMerge
+    dotenvExpand
   )
   .option(
     '-n, --exclude-env',
@@ -93,11 +93,16 @@ program
   .option(
     '-q, --quit-on-error',
     'terminate sequential process on error (default: false)'
+  )
+  .option(
+    '-a, --aws-sso-profile <string>',
+    'local AWS SSO profile (follows dotenv-expand rules)'
   );
 
 // Parse CLI options from command line.
 program.parse();
 const {
+  awsSsoProfile,
   branchToDefault,
   command,
   defaultEnvironment,
@@ -140,6 +145,9 @@ await getDotenv({
   privateToken,
 });
 
+// Get AWS SSO credentials.
+if (awsSsoProfile) getAwsSsoCredentials(dotenvExpand(awsSsoProfile));
+
 // Execute shell command.
 if (command || program.args.length) {
   const argvs = (command ?? program.args.join(' '))

package/dist/default/lib/dotenvExpand.js

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.dotenvExpand = void 0;
+// like String.prototype.search but returns the last index
+const _searchLast = (str, rgx) => {
+  const matches = Array.from(str.matchAll(rgx));
+  return matches.length > 0 ? matches.slice(-1)[0].index : -1;
+};
+const _interpolate = envValue => {
+  // find the last unescaped dollar sign in the
+  // value so that we can evaluate it
+  const lastUnescapedDollarSignIndex = _searchLast(envValue, /(?!(?<=\\))\$/g);
+
+  // If we couldn't match any unescaped dollar sign
+  // let's return the string as is
+  if (lastUnescapedDollarSignIndex === -1) return envValue;
+
+  // This is the right-most group of variables in the string
+  const rightMostGroup = envValue.slice(lastUnescapedDollarSignIndex);
+
+  /**
+   * This finds the inner most variable/group divided
+   * by variable name and default value (if present)
+   * (
+   *   (?!(?<=\\))\$        // only match dollar signs that are not escaped
+   *   {?                   // optional opening curly brace
+   *     ([\w]+)            // match the variable name
+   *     (?::-([^}\\]*))?   // match an optional default value
+   *   }?                   // optional closing curly brace
+   * )
+   */
+  const matchGroup = /((?!(?<=\\))\${?([\w]+)(?::-([^}\\]*))?}?)/;
+  const match = rightMostGroup.match(matchGroup);
+  if (match != null) {
+    const [, group, variableName, defaultValue] = match;
+    return _interpolate(envValue.replace(group, process.env[variableName] || defaultValue || ''));
+  }
+  return envValue;
+};
+const _resolveEscapeSequences = value => {
+  return value.replace(/\\\$/g, '$');
+};
+const dotenvExpand = value => _resolveEscapeSequences(_interpolate(value));
+exports.dotenvExpand = dotenvExpand;

package/dist/default/lib/getAwsSsoCredentials.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAwsSsoCredentials = void 0;
+var _crossSpawn = _interopRequireDefault(require("cross-spawn"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// npm imports
+
+const getAwsSsoCredentials = localProfile => {
+  if (!localProfile) {
+    delete process.env.AWS_ACCESS_KEY_ID;
+    delete process.env.AWS_SECRET_ACCESS_KEY;
+    delete process.env.AWS_SESSION_TOKEN;
+    return;
+  }
+  const {
+    status,
+    stderr,
+    stdout
+  } = _crossSpawn.default.sync('aws', ['configure', 'export-credentials', '--profile', localProfile]);
+  if (status) throw new Error(stderr.toString());
+  const {
+    AccessKeyId,
+    SecretAccessKey,
+    SessionToken
+  } = JSON.parse(stdout.toString());
+  process.env.AWS_ACCESS_KEY_ID = AccessKeyId;
+  process.env.AWS_SECRET_ACCESS_KEY = SecretAccessKey;
+  process.env.AWS_SESSION_TOKEN = SessionToken;
+};
+exports.getAwsSsoCredentials = getAwsSsoCredentials;

package/dist/default/lib/index.js

@@ -3,6 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "dotenvExpand", {
+  enumerable: true,
+  get: function () {
+    return _dotenvExpand.dotenvExpand;
+  }
+});
+Object.defineProperty(exports, "getAwsSsoCredentials", {
+  enumerable: true,
+  get: function () {
+    return _getAwsSsoCredentials.getAwsSsoCredentials;
+  }
+});
 Object.defineProperty(exports, "getDotenv", {
   enumerable: true,
   get: function () {
@@ -21,5 +33,7 @@ Object.defineProperty(exports, "parseBranch", {
     return _parseBranch.parseBranch;
   }
 });
+var _dotenvExpand = require("./dotenvExpand.js");
+var _getAwsSsoCredentials = require("./getAwsSsoCredentials.js");
 var _getDotenv = require("./getDotenv.js");
 var _parseBranch = require("./parseBranch.js");

package/lib/dotenvExpand.js

@@ -0,0 +1,49 @@
+// like String.prototype.search but returns the last index
+const _searchLast = (str, rgx) => {
+  const matches = Array.from(str.matchAll(rgx));
+  return matches.length > 0 ? matches.slice(-1)[0].index : -1;
+};
+
+const _interpolate = (envValue) => {
+  // find the last unescaped dollar sign in the
+  // value so that we can evaluate it
+  const lastUnescapedDollarSignIndex = _searchLast(envValue, /(?!(?<=\\))\$/g);
+
+  // If we couldn't match any unescaped dollar sign
+  // let's return the string as is
+  if (lastUnescapedDollarSignIndex === -1) return envValue;
+
+  // This is the right-most group of variables in the string
+  const rightMostGroup = envValue.slice(lastUnescapedDollarSignIndex);
+
+  /**
+   * This finds the inner most variable/group divided
+   * by variable name and default value (if present)
+   * (
+   *   (?!(?<=\\))\$        // only match dollar signs that are not escaped
+   *   {?                   // optional opening curly brace
+   *     ([\w]+)            // match the variable name
+   *     (?::-([^}\\]*))?   // match an optional default value
+   *   }?                   // optional closing curly brace
+   * )
+   */
+  const matchGroup = /((?!(?<=\\))\${?([\w]+)(?::-([^}\\]*))?}?)/;
+  const match = rightMostGroup.match(matchGroup);
+
+  if (match != null) {
+    const [, group, variableName, defaultValue] = match;
+
+    return _interpolate(
+      envValue.replace(group, process.env[variableName] || defaultValue || '')
+    );
+  }
+
+  return envValue;
+};
+
+const _resolveEscapeSequences = (value) => {
+  return value.replace(/\\\$/g, '$');
+};
+
+export const dotenvExpand = (value) =>
+  _resolveEscapeSequences(_interpolate(value));

package/lib/getAwsSsoCredentials.js

@@ -0,0 +1,28 @@
+// npm imports
+import spawn from 'cross-spawn';
+
+export const getAwsSsoCredentials = (localProfile) => {
+  if (!localProfile) {
+    delete process.env.AWS_ACCESS_KEY_ID;
+    delete process.env.AWS_SECRET_ACCESS_KEY;
+    delete process.env.AWS_SESSION_TOKEN;
+    return;
+  }
+
+  const { status, stderr, stdout } = spawn.sync('aws', [
+    'configure',
+    'export-credentials',
+    '--profile',
+    localProfile,
+  ]);
+
+  if (status) throw new Error(stderr.toString());
+
+  const { AccessKeyId, SecretAccessKey, SessionToken } = JSON.parse(
+    stdout.toString()
+  );
+
+  process.env.AWS_ACCESS_KEY_ID = AccessKeyId;
+  process.env.AWS_SECRET_ACCESS_KEY = SecretAccessKey;
+  process.env.AWS_SESSION_TOKEN = SessionToken;
+};

package/lib/index.js

@@ -1,2 +1,4 @@
+export { dotenvExpand } from './dotenvExpand.js';
+export { getAwsSsoCredentials } from './getAwsSsoCredentials.js';
 export { getDotenv, getDotenvSync } from './getDotenv.js';
 export { parseBranch } from './parseBranch.js';

package/package.json

@@ -3,7 +3,7 @@
   "bin": {
     "getdotenv": "bin/getdotenv/index.js"
   },
-  "version": "2.4.4",
+  "version": "2.6.0",
   "publishConfig": {
     "access": "public"
   },
@@ -85,12 +85,12 @@
   },
   "scripts": {
     "cli": "node ./bin/getdotenv",
-    "lint": "eslint lib/** bin/**",
-    "test": "mocha",
     "build": "babel lib -d dist/default/lib --delete-dir-on-start --config-file ./dist/default/.babelrc",
     "doc": "jsdoc2md -c doc/jsdoc.config.json -f lib/**/*.* -t doc/api-template.hbs > doc/3-api.jsdoc2.md && concat-md doc --hide-anchor-links > README.md",
-    "package": "npm run lint && npm run test && npm run build && npm run doc",
-    "release": "npm run package && node ./bin/getdotenv -- release-it"
+    "lint": "eslint lib/** bin/**",
+    "prerelease": "npm run lint && npm run test && npm run build && npm run doc",
+    "release": "release-it",
+    "test": "mocha"
   },
   "type": "module"
 }