auth0-deploy-cli 7.3.7 → 7.5.1

package/.circleci/config.yml

@@ -47,6 +47,15 @@ jobs:
       - run:
           name: Publish package
           command: npm publish
+          
+  ts_migration_progress:
+    machine:
+      image: ubuntu-2004:202111-02
+    steps:
+      - checkout
+      - run :    
+          name: Typescript Migration Progress
+          command: sh typescript-migration-progress.sh
 
 workflows:
   version: 2
@@ -77,3 +86,9 @@ workflows:
               ignore: /.*/
             tags:
               only: /^v.*/
+  ts_migration:
+    jobs:
+      - ts_migration_progress:
+          filters:
+            tags:
+              ignore: /.*/

package/.eslintrc

@@ -1,5 +1,5 @@
 {
-  "parser": "@babel/eslint-parser",
+  "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 2020
   },
@@ -15,20 +15,40 @@
   },
   "settings": {
     "import/resolver": {
-      "babel-module": {}
+      "node": {
+        "extensions": [
+          ".js",
+          ".ts"
+        ]
+      }
     }
   },
   "rules": {
     "max-len": 0,
     "react/display-name": 0,
-    "array-bracket-spacing": [2, "always"],
+    "array-bracket-spacing": [
+      2,
+      "always"
+    ],
     "class-methods-use-this": 0,
-    "comma-dangle": [2, "never"],
+    "comma-dangle": [
+      2,
+      "never"
+    ],
     "eol-last": 2,
-    "indent": [2, 2, {
-      "SwitchCase": 1
-    }],
-    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
+    "indent": [
+      2,
+      2,
+      {
+        "SwitchCase": 1
+      }
+    ],
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        "devDependencies": true
+      }
+    ],
     "import/no-dynamic-require": 0,
     "prefer-arrow-callback": 0,
     "object-shorthand": 0,
@@ -38,17 +58,46 @@
     "no-await-in-loop": 0,
     "no-param-reassign": 0,
     "no-multiple-empty-lines": 2,
-    "no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
+    "no-plusplus": [
+      "error",
+      {
+        "allowForLoopAfterthoughts": true
+      }
+    ],
     "no-unused-vars": 2,
     "no-var": 0,
-    "object-curly-spacing": [2, "always"],
-    "quotes": [2, "single", "avoid-escape"],
-    "semi": [2, "always"],
+    "object-curly-spacing": [
+      2,
+      "always"
+    ],
+    "quotes": [
+      2,
+      "single",
+      "avoid-escape"
+    ],
+    "semi": [
+      2,
+      "always"
+    ],
     "strict": 0,
-    "space-before-blocks": [2, "always"],
-    "space-before-function-paren": [2, {
-      "anonymous": "never",
-      "named": "never"
-    }]
+    "space-before-blocks": [
+      2,
+      "always"
+    ],
+    "space-before-function-paren": [
+      2,
+      {
+        "anonymous": "never",
+        "named": "never"
+      }
+    ],
+    "import/extensions": [
+      "error",
+      "ignorePackages",
+      {
+        "js": "never",
+        "ts": "never"
+      }
+    ]
   }
 }

package/.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @auth0/dx-customer-dev-tools-engineer

package/.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint:fix
+
+/bin/bash ./typescript-migration-progress.sh

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run test && npm run lint

package/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.5.1] - 2022-03-11
+### Fixed
+- Updating dead link in logging output [#436]
+- Fixing `--env` flag to properly dictate environment variable inheritance [#432]
+
+## [7.5.0] - 2022-03-08
+### Added
+- Support for attack protection configuration management [#428]
+
+### Fixed
+- Excluded connection properties from getting deleted upon update [#430]
+- Organizations in YAML format are skipped when not defined [#388]
+
+## [7.4.0] - 2022-02-24
+### Added
+- Allowing @@ array variable replacement to work when wrapped in quotes [#421]
+
+### Fixed
+- Eliminated benign `client_metadata` warnings on import [#416]
+- Fixing request abstraction from losing function scope, enabling Auth0 Node SDK updates [#412]
+
+### Security
+- Updating Auth0 Node SDK to 2.40.0 which fixes minor dependency vulnerability
+
 ## [7.3.7] - 2022-02-03
 ### Fixed
 - Expose errors that may be silently missed in Actions [#408]
@@ -415,13 +439,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#364]: https://github.com/auth0/auth0-deploy-cli/issues/364
 [#367]: https://github.com/auth0/auth0-deploy-cli/issues/367
 [#379]: https://github.com/auth0/auth0-deploy-cli/issues/379
+[#388]: https://github.com/auth0/auth0-deploy-cli/issues/388
 [#400]: https://github.com/auth0/auth0-deploy-cli/issues/400
 [#401]: https://github.com/auth0/auth0-deploy-cli/issues/401
 [#403]: https://github.com/auth0/auth0-deploy-cli/issues/403
 [#406]: https://github.com/auth0/auth0-deploy-cli/issues/406
 [#408]: https://github.com/auth0/auth0-deploy-cli/issues/408
-
-[Unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.3.7...HEAD
+[#412]: https://github.com/auth0/auth0-deploy-cli/issues/412
+[#416]: https://github.com/auth0/auth0-deploy-cli/issues/416
+[#421]: https://github.com/auth0/auth0-deploy-cli/issues/421
+[#428]: https://github.com/auth0/auth0-deploy-cli/issues/428
+[#430]: https://github.com/auth0/auth0-deploy-cli/issues/430
+[#432]: https://github.com/auth0/auth0-deploy-cli/issues/432
+[#436]: https://github.com/auth0/auth0-deploy-cli/issues/436
+
+[Unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.5.1...HEAD
+[7.5.1]: https://github.com/auth0/auth0-deploy-cli/compare/v7.5.0...v7.5.1
+[7.5.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.4.0...v7.5.0
+[7.4.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.3.7...v7.4.0
 [7.3.7]: https://github.com/auth0/auth0-deploy-cli/compare/v7.3.6...v7.3.7
 [7.3.6]: https://github.com/auth0/auth0-deploy-cli/compare/v7.3.5...v7.3.6
 [7.3.5]: https://github.com/auth0/auth0-deploy-cli/compare/v7.3.4...v7.3.5

package/lib/args.js

@@ -1,86 +1,99 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getParams = undefined;
-
-var _yargs = require("yargs");
-
-var _yargs2 = _interopRequireDefault(_yargs);
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getParams = void 0;
+const yargs_1 = __importDefault(require("yargs"));
 function getParams() {
-  const args = _yargs2.default.demandCommand(1, 'A command is required').usage('Auth0 Deploy CLI').option('debug', {
-    alias: 'd',
-    describe: 'Dump extra debug information.',
-    type: 'boolean',
-    default: false
-  }).option('proxy_url', {
-    alias: 'p',
-    describe: 'A url for proxying requests, only set this if you are behind a proxy.',
-    type: 'string'
-  }).command(['import', 'deploy'], 'Deploy Configuration', {
-    input_file: {
-      alias: 'i',
-      describe: 'The updates to deploy. Either a JSON file, or directory that contains the correct file layout. See README and online for more info.',
-      type: 'string',
-      demandOption: true
-    },
-    config_file: {
-      alias: 'c',
-      describe: 'The JSON configuration file.',
-      type: 'string'
-    },
-    env: {
-      alias: 'e',
-      describe: 'Override the mappings in config with process.env environment variables.',
-      type: 'string',
-      boolean: true,
-      default: true
-    },
-    secret: {
-      alias: 'x',
-      describe: 'The client secret, this allows you to encrypt the secret in your build configuration instead of storing it in a config file',
-      type: 'string'
-    }
-  }).command(['export', 'dump'], 'Export Auth0 Tenant Configuration', {
-    output_folder: {
-      alias: 'o',
-      describe: 'The output directory.',
-      type: 'string',
-      demandOption: true
-    },
-    format: {
-      alias: 'f',
-      describe: 'The output format.',
-      type: 'string',
-      choices: ['yaml', 'directory'],
-      demandOption: true
-    },
-    config_file: {
-      alias: 'c',
-      describe: 'The JSON configuration file.',
-      type: 'string'
-    },
-    secret: {
-      alias: 'x',
-      describe: 'The client secret, this allows you to encrypt the secret in your build configuration instead of storing it in a config file',
-      type: 'string'
-    },
-    export_ids: {
-      alias: 'e',
-      describe: 'Export identifier field for each object type.',
-      type: 'boolean',
-      default: false
-    }
-  }).example('$0 export -c config.json -f yaml -o path/to/export', 'Dump Auth0 config to folder in YAML format').example('$0 export -c config.json -f directory -o path/to/export', 'Dump Auth0 config to folder in directory format').example('$0 import -c config.json -i tenant.yaml', 'Deploy Auth0 via YAML').example('$0 import -c config.json -i path/to/files', 'Deploy Auth0 via Path').example('$0 dump -c config.json -f yaml -o path/to/export', 'Dump Auth0 config to folder in YAML format').example('$0 dump -c config.json -f directory -o path/to/export', 'Dump Auth0 config to folder in directory format').example('$0 deploy -c config.json -i tenant.yaml', 'Deploy Auth0 via YAML').example('$0 deploy -c config.json -i path/to/files', 'Deploy Auth0 via Path').epilogue('See README (https://github.com/auth0/auth0-deploy-cli) for more in-depth information on configuration and setup.').wrap(null);
-
-  return args.argv;
+    const args = yargs_1.default
+        .demandCommand(1, 'A command is required')
+        .usage('Auth0 Deploy CLI')
+        .option('debug', {
+        alias: 'd',
+        describe: 'Dump extra debug information.',
+        type: 'boolean',
+        default: false
+    })
+        .option('proxy_url', {
+        alias: 'p',
+        describe: 'A url for proxying requests, only set this if you are behind a proxy.',
+        type: 'string'
+    })
+        .command(['import', 'deploy'], 'Deploy Configuration', {
+        input_file: {
+            alias: 'i',
+            describe: 'The updates to deploy. Either a JSON file, or directory that contains the correct file layout. See README and online for more info.',
+            type: 'string',
+            demandOption: true
+        },
+        config_file: {
+            alias: 'c',
+            describe: 'The JSON configuration file.',
+            type: 'string'
+        },
+        env: {
+            alias: 'e',
+            describe: 'Override the mappings in config with environment variables.',
+            boolean: true,
+            default: true
+        },
+        secret: {
+            alias: 'x',
+            describe: 'The client secret, this allows you to encrypt the secret in your build configuration instead of storing it in a config file',
+            type: 'string'
+        }
+    })
+        .command(['export', 'dump'], 'Export Auth0 Tenant Configuration', {
+        output_folder: {
+            alias: 'o',
+            describe: 'The output directory.',
+            type: 'string',
+            demandOption: true
+        },
+        format: {
+            alias: 'f',
+            describe: 'The output format.',
+            type: 'string',
+            choices: ['yaml', 'directory'],
+            demandOption: true
+        },
+        config_file: {
+            alias: 'c',
+            describe: 'The JSON configuration file.',
+            type: 'string'
+        },
+        secret: {
+            alias: 'x',
+            describe: 'The client secret, this allows you to encrypt the secret in your build configuration instead of storing it in a config file',
+            type: 'string'
+        },
+        env: {
+            alias: 'e',
+            describe: 'Override the mappings in config with environment variables.',
+            boolean: true,
+            default: false
+        },
+        export_ids: {
+            alias: 'e',
+            describe: 'Export identifier field for each object type.',
+            type: 'boolean',
+            default: false
+        }
+    })
+        .example('$0 export -c config.json -f yaml -o path/to/export', 'Dump Auth0 config to folder in YAML format')
+        .example('$0 export -c config.json -f directory -o path/to/export', 'Dump Auth0 config to folder in directory format')
+        .example('$0 import -c config.json -i tenant.yaml', 'Deploy Auth0 via YAML')
+        .example('$0 import -c config.json -i path/to/files', 'Deploy Auth0 via Path')
+        .example('$0 dump -c config.json -f yaml -o path/to/export', 'Dump Auth0 config to folder in YAML format')
+        .example('$0 dump -c config.json -f directory -o path/to/export', 'Dump Auth0 config to folder in directory format')
+        .example('$0 deploy -c config.json -i tenant.yaml', 'Deploy Auth0 via YAML')
+        .example('$0 deploy -c config.json -i path/to/files', 'Deploy Auth0 via Path')
+        .epilogue('See README (https://github.com/auth0/auth0-deploy-cli) for more in-depth information on configuration and setup.')
+        .wrap(null);
+    return args.argv;
 }
-
+exports.getParams = getParams;
 exports.default = {
-  getParams
+    getParams
 };
-exports.getParams = getParams;

package/lib/commands/export.js

@@ -1,79 +1,55 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = deploy;
-
-var _path = require("path");
-
-var _path2 = _interopRequireDefault(_path);
-
-var _nconf = require("nconf");
-
-var _nconf2 = _interopRequireDefault(_nconf);
-
-var _mkdirp = require("mkdirp");
-
-var _mkdirp2 = _interopRequireDefault(_mkdirp);
-
-var _logger = require("../logger");
-
-var _logger2 = _interopRequireDefault(_logger);
-
-var _utils = require("../utils");
-
-var _context = require("../context");
-
-var _context2 = _interopRequireDefault(_context);
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-async function deploy(params) {
-  const {
-    output_folder: outputFolder,
-    base_path: basePath,
-    config_file: configFile,
-    config: configObj,
-    export_ids: exportIds,
-    secret
-  } = params;
-
-  _nconf2.default.env().use('memory');
-
-  if (configFile) {
-    _nconf2.default.file(configFile);
-  }
-
-  const overrides = {
-    AUTH0_INPUT_FILE: outputFolder,
-    AUTH0_BASE_PATH: basePath,
-    AUTH0_CONFIG_FILE: configFile,
-    ...(configObj || {})
-  };
-
-  if (secret) {
-    overrides.AUTH0_CLIENT_SECRET = secret;
-  }
-
-  if (exportIds) {
-    overrides.AUTH0_EXPORT_IDENTIFIERS = exportIds;
-  }
-
-  if (!(0, _utils.isDirectory)(outputFolder)) {
-    _logger2.default.info(`Creating ${outputFolder}`);
-
-    _mkdirp2.default.sync(outputFolder);
-  }
-
-  if (params.format === 'yaml') {
-    overrides.AUTH0_INPUT_FILE = _path2.default.join(outputFolder, 'tenant.yaml');
-  }
-
-  _nconf2.default.overrides(overrides);
-
-  const context = await (0, _context2.default)(_nconf2.default.get());
-  await context.dump();
-
-  _logger2.default.info('Export Successful');
-}
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const nconf_1 = __importDefault(require("nconf"));
+const mkdirp_1 = __importDefault(require("mkdirp"));
+const logger_1 = __importDefault(require("../logger"));
+const utils_1 = require("../utils");
+const context_1 = __importDefault(require("../context"));
+function exportCMD(params) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { output_folder: outputFolder, base_path: basePath, config_file: configFile, config: configObj, export_ids: exportIds, secret: clientSecret, env: shouldInheritEnv = false, } = params;
+        if (shouldInheritEnv) {
+            nconf_1.default.env().use('memory');
+        }
+        if (configFile) {
+            nconf_1.default.file(configFile);
+        }
+        const overrides = Object.assign({ AUTH0_INPUT_FILE: outputFolder, AUTH0_BASE_PATH: basePath, AUTH0_CONFIG_FILE: configFile }, configObj || {});
+        // Prepare configuration by initializing nconf, then passing that as the provider to the config object
+        // Allow passed in secret to override the configured one
+        if (clientSecret) {
+            overrides.AUTH0_CLIENT_SECRET = clientSecret;
+        }
+        // Allow passed in export_ids to override the configured one
+        if (exportIds) {
+            overrides.AUTH0_EXPORT_IDENTIFIERS = exportIds;
+        }
+        // Check output folder
+        if (!(0, utils_1.isDirectory)(outputFolder)) {
+            logger_1.default.info(`Creating ${outputFolder}`);
+            mkdirp_1.default.sync(outputFolder);
+        }
+        if (params.format === 'yaml') {
+            overrides.AUTH0_INPUT_FILE = path_1.default.join(outputFolder, 'tenant.yaml');
+        }
+        nconf_1.default.overrides(overrides);
+        // Setup context and load
+        const context = yield (0, context_1.default)(nconf_1.default.get());
+        yield context.dump();
+        logger_1.default.info('Export Successful');
+    });
+}
+exports.default = exportCMD;

package/lib/commands/import.js

@@ -1,71 +1,47 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = deploy;
-
-var _nconf = require("nconf");
-
-var _nconf2 = _interopRequireDefault(_nconf);
-
-var _configFactory = require("../configFactory");
-
-var _configFactory2 = _interopRequireDefault(_configFactory);
-
-var _tools = require("../tools");
-
-var _logger = require("../logger");
-
-var _logger2 = _interopRequireDefault(_logger);
-
-var _context = require("../context");
-
-var _context2 = _interopRequireDefault(_context);
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-async function deploy(params) {
-  const {
-    input_file: inputFile,
-    base_path: basePath,
-    config_file: configFile,
-    config: configObj,
-    env,
-    secret
-  } = params;
-
-  _nconf2.default.env().use('memory');
-
-  if (configFile) {
-    _nconf2.default.file(configFile);
-  }
-
-  const overrides = {
-    AUTH0_INPUT_FILE: inputFile,
-    AUTH0_BASE_PATH: basePath,
-    AUTH0_CONFIG_FILE: configFile,
-    AUTH0_KEYWORD_REPLACE_MAPPINGS: {},
-    ...(configObj || {})
-  };
-
-  if (secret) {
-    overrides.AUTH0_CLIENT_SECRET = secret;
-  }
-
-  if (env) {
-    const mappings = _nconf2.default.get('AUTH0_KEYWORD_REPLACE_MAPPINGS') || {};
-
-    _nconf2.default.set('AUTH0_KEYWORD_REPLACE_MAPPINGS', Object.assign(mappings, process.env));
-  }
-
-  _nconf2.default.overrides(overrides);
-
-  const context = await (0, _context2.default)(_nconf2.default.get());
-  await context.load();
-  const config = (0, _configFactory2.default)();
-  config.setProvider(key => _nconf2.default.get(key));
-  await (0, _tools.deploy)(context.assets, context.mgmtClient, config);
-
-  _logger2.default.info('Import Successful');
-}
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const nconf_1 = __importDefault(require("nconf"));
+const configFactory_1 = __importDefault(require("../configFactory"));
+const tools_1 = require("../tools");
+const logger_1 = __importDefault(require("../logger"));
+const context_1 = __importDefault(require("../context"));
+function importCMD(params) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { input_file: inputFile, base_path: basePath, config_file: configFile, config: configObj, env: shouldInheritEnv = false, secret: clientSecret } = params;
+        if (shouldInheritEnv) {
+            nconf_1.default.env().use('memory');
+            const mappings = nconf_1.default.get('AUTH0_KEYWORD_REPLACE_MAPPINGS') || {};
+            nconf_1.default.set('AUTH0_KEYWORD_REPLACE_MAPPINGS', Object.assign(mappings, process.env));
+        }
+        if (configFile) {
+            nconf_1.default.file(configFile);
+        }
+        const overrides = Object.assign({ AUTH0_INPUT_FILE: inputFile, AUTH0_BASE_PATH: basePath, AUTH0_CONFIG_FILE: configFile, AUTH0_KEYWORD_REPLACE_MAPPINGS: {} }, configObj || {});
+        // Prepare configuration by initializing nconf, then passing that as the provider to the config object
+        // Allow passed in secret to override the configured one
+        if (clientSecret) {
+            overrides.AUTH0_CLIENT_SECRET = clientSecret;
+        }
+        nconf_1.default.overrides(overrides);
+        // Setup context and load
+        const context = yield (0, context_1.default)(nconf_1.default.get());
+        yield context.load();
+        const config = (0, configFactory_1.default)();
+        config.setProvider((key) => nconf_1.default.get(key));
+        yield (0, tools_1.deploy)(context.assets, context.mgmtClient, config);
+        logger_1.default.info('Import Successful');
+    });
+}
+exports.default = importCMD;