auth0-deploy-cli 7.4.0 → 7.5.2

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.loadFileAndReplaceKeywords)(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.4.0",
+  "version": "7.5.2",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -10,9 +10,9 @@
     "lint:fix": "eslint --fix --ignore-path .eslintignore --ignore-pattern webpack . && kacl lint",
     "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",
-    "dev": "npm run build -- --watch",
+    "test": "ts-mocha -p tsconfig.json --recursive 'test/**/*.test.*'",
+    "build": "rimraf ./lib && npx tsc",
+    "dev": "npx tsc --watch",
     "prepare": "npm run build",
     "preversion": "kacl prerelease",
     "version": "kacl release && git add CHANGELOG.md"
@@ -44,28 +44,22 @@
     "yargs": "^15.3.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.5",
-    "@babel/core": "^7.9.6",
-    "@babel/eslint-parser": "^7.14.5",
-    "@babel/plugin-proposal-decorators": "^7.8.3",
-    "@babel/preset-env": "^7.9.6",
-    "@babel/register": "^7.9.0",
-    "babel-eslint": "^10.0.0",
-    "babel-plugin-dynamic-import-node": "^2.3.3",
-    "babel-plugin-module-resolver": "^4.0.0",
-    "babel-preset-env": "^1.7.0",
+    "@types/expect": "^24.3.0",
+    "@types/mocha": "^9.1.0",
+    "@typescript-eslint/parser": "^5.14.0",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^3.1.4",
     "eslint": "^7.28.0",
     "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",
     "rimraf": "^3.0.2",
-    "rmdir-sync": "^1.0.1"
+    "rmdir-sync": "^1.0.1",
+    "ts-mocha": "^9.0.2",
+    "typescript": "^4.6.2"
   }
 }

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "experimentalDecorators": true,
+    "module": "commonjs",
+    "rootDir": "./src",
+    "allowJs": true,
+    "outDir": "./lib",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": false,
+    "skipLibCheck": true
+  },
+  "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 "- - - - - - - - - - - - - - - - - - - - - -"

package/.babelrc

@@ -1,17 +0,0 @@
-{
-  "comments": false,
-  "presets": [
-    [
-      "env",
-      {
-        "targets": {
-          "node": "8"
-        }
-      }
-    ]
-  ],
-  "plugins": [
-    ["@babel/plugin-proposal-decorators", { "legacy": true }],
-    "dynamic-import-node"
-  ]
-}