auth0-deploy-cli 7.3.6 → 7.5.0

package/lib/utils.js

@@ -1,218 +1,195 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isDirectory = isDirectory;
-exports.isFile = isFile;
-exports.getFiles = getFiles;
-exports.loadJSON = loadJSON;
-exports.dumpJSON = dumpJSON;
-exports.existsMustBeDir = existsMustBeDir;
-exports.toConfigFn = toConfigFn;
-exports.stripIdentifiers = stripIdentifiers;
-exports.sanitize = sanitize;
-exports.hoursAsInteger = hoursAsInteger;
-exports.formatResults = formatResults;
-exports.recordsSorter = recordsSorter;
-exports.clearTenantFlags = clearTenantFlags;
-exports.ensureProp = ensureProp;
-exports.clearClientArrays = clearClientArrays;
-exports.convertClientIdToName = convertClientIdToName;
-exports.mapClientID2NameSorted = mapClientID2NameSorted;
-
-var _fsExtra = require("fs-extra");
-
-var _fsExtra2 = _interopRequireDefault(_fsExtra);
-
-var _path = require("path");
-
-var _path2 = _interopRequireDefault(_path);
-
-var _sanitizeFilename = require("sanitize-filename");
-
-var _sanitizeFilename2 = _interopRequireDefault(_sanitizeFilename);
-
-var _dotProp = require("dot-prop");
-
-var _dotProp2 = _interopRequireDefault(_dotProp);
-
-var _tools = require("./tools");
-
-var _logger = require("./logger");
-
-var _logger2 = _interopRequireDefault(_logger);
-
-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.mapClientID2NameSorted = exports.convertClientIdToName = exports.clearClientArrays = exports.ensureProp = exports.clearTenantFlags = exports.recordsSorter = exports.formatResults = exports.hoursAsInteger = exports.sanitize = exports.stripIdentifiers = exports.toConfigFn = exports.existsMustBeDir = exports.dumpJSON = exports.loadJSON = exports.getFiles = exports.isFile = exports.isDirectory = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
+const dot_prop_1 = __importDefault(require("dot-prop"));
+const tools_1 = require("./tools");
+const logger_1 = __importDefault(require("./logger"));
 function isDirectory(f) {
-  try {
-    return _fsExtra2.default.statSync(_path2.default.resolve(f)).isDirectory();
-  } catch (err) {
-    return false;
-  }
+    try {
+        return fs_extra_1.default.statSync(path_1.default.resolve(f))
+            .isDirectory();
+    }
+    catch (err) {
+        return false;
+    }
 }
-
+exports.isDirectory = isDirectory;
 function isFile(f) {
-  try {
-    return _fsExtra2.default.statSync(_path2.default.resolve(f)).isFile();
-  } catch (err) {
-    return false;
-  }
+    try {
+        return fs_extra_1.default.statSync(path_1.default.resolve(f))
+            .isFile();
+    }
+    catch (err) {
+        return false;
+    }
 }
-
+exports.isFile = isFile;
 function getFiles(folder, exts) {
-  if (isDirectory(folder)) {
-    return _fsExtra2.default.readdirSync(folder).map(f => _path2.default.join(folder, f)).filter(f => isFile(f) && exts.includes(_path2.default.extname(f)));
-  }
-
-  return [];
+    if (isDirectory(folder)) {
+        return fs_extra_1.default.readdirSync(folder)
+            .map((f) => path_1.default.join(folder, f))
+            .filter((f) => isFile(f) && exts.includes(path_1.default.extname(f)));
+    }
+    return [];
 }
-
+exports.getFiles = getFiles;
 function loadJSON(file, mappings) {
-  try {
-    const content = (0, _tools.loadFile)(file, mappings);
-    return JSON.parse(content);
-  } catch (e) {
-    throw new Error(`Error parsing JSON from metadata file: ${file}, because: ${e.message}`);
-  }
-}
-
+    try {
+        const content = (0, tools_1.loadFileAndReplaceKeywords)(file, mappings);
+        return JSON.parse(content);
+    }
+    catch (e) {
+        throw new Error(`Error parsing JSON from metadata file: ${file}, because: ${e.message}`);
+    }
+}
+exports.loadJSON = loadJSON;
 function dumpJSON(file, mappings) {
-  try {
-    _logger2.default.info(`Writing ${file}`);
-
-    const jsonBody = JSON.stringify(mappings, null, 2);
-
-    _fsExtra2.default.writeFileSync(file, jsonBody.endsWith('\n') ? jsonBody : `${jsonBody}\n`);
-  } catch (e) {
-    throw new Error(`Error writing JSON to metadata file: ${file}, because: ${e.message}`);
-  }
-}
-
+    try {
+        logger_1.default.info(`Writing ${file}`);
+        const jsonBody = JSON.stringify(mappings, null, 2);
+        fs_extra_1.default.writeFileSync(file, jsonBody.endsWith('\n') ? jsonBody : `${jsonBody}\n`);
+    }
+    catch (e) {
+        throw new Error(`Error writing JSON to metadata file: ${file}, because: ${e.message}`);
+    }
+}
+exports.dumpJSON = dumpJSON;
 function existsMustBeDir(folder) {
-  if (_fsExtra2.default.existsSync(folder)) {
-    if (!isDirectory(folder)) {
-      throw new Error(`Expected ${folder} to be a folder but got a file?`);
+    if (fs_extra_1.default.existsSync(folder)) {
+        if (!isDirectory(folder)) {
+            throw new Error(`Expected ${folder} to be a folder but got a file?`);
+        }
+        return true;
     }
-
-    return true;
-  }
-
-  return false;
+    return false;
 }
-
+exports.existsMustBeDir = existsMustBeDir;
 function toConfigFn(data) {
-  return key => data[key];
+    return (key) => data[key];
 }
-
+exports.toConfigFn = toConfigFn;
 function stripIdentifiers(auth0, assets) {
-  const updated = { ...assets
-  };
-  const ignore = ['actions', 'rulesConfigs', 'emailTemplates', 'guardianFactors', 'guardianFactorProviders', 'guardianFactorTemplates'];
-  auth0.handlers.forEach(h => {
-    if (ignore.includes(h.type)) return;
-    const exist = updated[h.type];
-
-    if (Array.isArray(exist)) {
-      updated[h.type] = exist.map(o => {
-        const newObj = { ...o
-        };
-        delete newObj[h.id];
-        return newObj;
-      });
-    }
-  });
-  return updated;
-}
-
+    const updated = Object.assign({}, assets);
+    // Some of the object identifiers are required to perform updates.
+    // Don't strip these object id's
+    const ignore = [
+        'actions',
+        'rulesConfigs',
+        'emailTemplates',
+        'guardianFactors',
+        'guardianFactorProviders',
+        'guardianFactorTemplates'
+    ];
+    // Optionally Strip identifiers
+    auth0.handlers.forEach((h) => {
+        if (ignore.includes(h.type))
+            return;
+        const exist = updated[h.type];
+        // All objects with the identifier field is an array. This could change in future.
+        if (Array.isArray(exist)) {
+            updated[h.type] = exist.map((o) => {
+                const newObj = Object.assign({}, o);
+                delete newObj[h.id];
+                return newObj;
+            });
+        }
+    });
+    return updated;
+}
+exports.stripIdentifiers = stripIdentifiers;
 function sanitize(str) {
-  return (0, _sanitizeFilename2.default)(str, {
-    replacement: '-'
-  });
+    return (0, sanitize_filename_1.default)(str, { replacement: '-' });
 }
-
+exports.sanitize = sanitize;
 function hoursAsInteger(property, hours) {
-  if (Number.isInteger(hours)) return {
-    [property]: hours
-  };
-  return {
-    [`${property}_in_minutes`]: Math.round(hours * 60)
-  };
-}
-
+    if (Number.isInteger(hours))
+        return { [property]: hours };
+    return { [`${property}_in_minutes`]: Math.round(hours * 60) };
+}
+exports.hoursAsInteger = hoursAsInteger;
 function formatResults(item) {
-  if (typeof item !== 'object') {
-    return item;
-  }
-
-  const importantFields = {
-    name: null,
-    client_id: null,
-    audience: null,
-    template: null,
-    identifier: null,
-    strategy: null,
-    script: null,
-    stage: null,
-    id: null
-  };
-  const result = { ...importantFields
-  };
-  Object.entries(item).sort().forEach(([key, value]) => {
-    result[key] = value;
-  });
-  Object.keys(importantFields).forEach(key => {
-    if (result[key] === null) delete result[key];
-  });
-  return result;
-}
-
+    if (typeof item !== 'object') {
+        return item;
+    }
+    const importantFields = {
+        name: null,
+        client_id: null,
+        audience: null,
+        template: null,
+        identifier: null,
+        strategy: null,
+        script: null,
+        stage: null,
+        id: null
+    };
+    const result = Object.assign({}, importantFields);
+    Object.entries(item).sort().forEach(([key, value]) => {
+        result[key] = value;
+    });
+    Object.keys(importantFields).forEach((key) => {
+        if (result[key] === null)
+            delete result[key];
+    });
+    return result;
+}
+exports.formatResults = formatResults;
 function recordsSorter(a, b) {
-  const importantFields = ['name', 'key', 'client_id', 'template'];
-
-  for (let i = 0; i < importantFields.length; i += 1) {
-    const key = importantFields[i];
-
-    if (a[key] && b[key]) {
-      return a[key] > b[key] ? 1 : -1;
-    }
-  }
-
-  return 0;
-}
-
+    const importantFields = [
+        'name',
+        'key',
+        'client_id',
+        'template'
+    ];
+    for (let i = 0; i < importantFields.length; i += 1) {
+        const key = importantFields[i];
+        if (a[key] && b[key]) {
+            return a[key] > b[key] ? 1 : -1;
+        }
+    }
+    return 0;
+}
+exports.recordsSorter = recordsSorter;
 function clearTenantFlags(tenant) {
-  if (tenant.flags && !Object.keys(tenant.flags).length) {
-    delete tenant.flags;
-  }
+    if (tenant.flags && !Object.keys(tenant.flags).length) {
+        delete tenant.flags;
+    }
 }
-
+exports.clearTenantFlags = clearTenantFlags;
 function ensureProp(obj, props, value = '') {
-  if (!_dotProp2.default.has(obj, props)) {
-    _dotProp2.default.set(obj, props, value);
-  }
+    if (!dot_prop_1.default.has(obj, props)) {
+        dot_prop_1.default.set(obj, props, value);
+    }
 }
-
+exports.ensureProp = ensureProp;
 function clearClientArrays(client) {
-  const propsToClear = ['allowed_clients', 'allowed_logout_urls', 'allowed_origins', 'callbacks'];
-  Object.keys(client).forEach(prop => {
-    if (propsToClear.indexOf(prop) >= 0 && !client[prop]) {
-      client[prop] = [];
-    }
-  });
-  return client;
+    const propsToClear = ['allowed_clients', 'allowed_logout_urls', 'allowed_origins', 'callbacks'];
+    Object.keys(client).forEach((prop) => {
+        if (propsToClear.indexOf(prop) >= 0 && !client[prop]) {
+            client[prop] = [];
+        }
+    });
+    return client;
 }
-
+exports.clearClientArrays = clearClientArrays;
 function convertClientIdToName(clientId, knownClients = []) {
-  try {
-    const found = knownClients.find(c => c.client_id === clientId);
-    return found && found.name || clientId;
-  } catch (e) {
-    return clientId;
-  }
-}
-
+    try {
+        const found = knownClients.find((c) => c.client_id === clientId);
+        return (found && found.name) || clientId;
+    }
+    catch (e) {
+        return clientId;
+    }
+}
+exports.convertClientIdToName = convertClientIdToName;
 function mapClientID2NameSorted(enabledClients, knownClients) {
-  return [...(enabledClients || []).map(clientId => convertClientIdToName(clientId, knownClients))].sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()));
-}
+    return [
+        ...(enabledClients || []).map((clientId) => convertClientIdToName(clientId, knownClients))
+    ].sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()));
+}
+exports.mapClientID2NameSorted = mapClientID2NameSorted;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.3.6",
+  "version": "7.5.0",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -11,7 +11,8 @@
     "lint": "eslint --ignore-path .eslintignore --ignore-pattern webpack . && kacl lint",
     "pretest": "rimraf ./.nyc_output",
     "test": "cross-env NODE_ENV=test nyc mocha --recursive --require @babel/register test",
-    "build": "rimraf ./lib && babel src -d lib",
+    "build": "rimraf ./lib && npx tsc",
+    "dev": "npx tsc --watch",
     "prepare": "npm run build",
     "preversion": "kacl prerelease",
     "version": "kacl release && git add CHANGELOG.md"
@@ -29,7 +30,7 @@
   "homepage": "https://github.com/auth0/auth0-deploy-cli#readme",
   "dependencies": {
     "ajv": "^6.12.6",
-    "auth0": "2.37.0",
+    "auth0": "^2.40.0",
     "dot-prop": "^5.2.0",
     "fs-extra": "^7.0.0",
     "global-agent": "^2.1.12",
@@ -39,6 +40,7 @@
     "nconf": "^0.11.0",
     "promise-pool-executor": "^1.1.1",
     "sanitize-filename": "^1.6.1",
+    "typescript": "^4.5.5",
     "winston": "^2.3.0",
     "yargs": "^15.3.1"
   },
@@ -60,6 +62,7 @@
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-import-resolver-babel-module": "^5.1.2",
     "eslint-plugin-import": "^2.20.2",
+    "husky": "^7.0.4",
     "kacl": "^1.1.1",
     "mocha": "^9.1.3",
     "nyc": "^15.0.1",

package/tsconfig.json

@@ -0,0 +1,96 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+    /* Language and Environment */
+    "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    /* Modules */
+    "module": "commonjs", /* Specify what module code is generated. */
+    "rootDir": "./src", /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+    /* JavaScript Support */
+    "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./lib", /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    "strict": false, /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  },
+  "include": [
+    "src/**/*"
+  ]
+}

package/typescript-migration-progress.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Script providing insight into the progress of migrating Deploy CLI source code to Typescript. See: DXCDT-70
+# This can be deleted once migration from JS => TS is complete
+
+echo "- - - - - Typescript Migration - - - - - -"
+
+locJs=$( (find ./src -name "*.js" -print0 | xargs -0 cat) | wc -l | xargs)
+locTs=$( (find ./src -name "*.ts" -print0 | xargs -0 cat) | wc -l | xargs)
+totalLoc=$(expr ${locJs} + ${locTs})
+percentLocMigrated=$(expr $(expr ${locTs} \* 100) / ${totalLoc})
+
+echo "${locTs} of ${totalLoc} (${percentLocMigrated}%) lines of code migrated to Typescript"
+
+numTsFiles=$(find ./src -name "*.ts" | wc -l | xargs)
+numJsFiles=$(find ./src -name "*.js" | wc -l | xargs)
+totalNumFiles=$(expr ${numTsFiles} + ${numJsFiles})
+percentFilesMigrated=$(expr $(expr ${numTsFiles} \* 100) / ${totalNumFiles})
+
+echo "${numTsFiles} of ${numJsFiles} (${percentFilesMigrated}%) files migrated to Typescript"
+
+echo "- - - - - - - - - - - - - - - - - - - - - -"