auth0-deploy-cli 7.5.1 → 7.7.0

package/lib/tools/deploy.js

@@ -28,7 +28,7 @@ function deploy(assets, client, config) {
             accum[h.type] = {
                 deleted: h.deleted,
                 created: h.created,
-                updated: h.updated
+                updated: h.updated,
             };
             return accum;
         }, {});

package/lib/tools/index.js

@@ -18,5 +18,5 @@ exports.default = {
     deploy: deploy_1.default,
     keywordReplace: utils_1.keywordReplace,
     loadFileAndReplaceKeywords: utils_1.loadFileAndReplaceKeywords,
-    Auth0: auth0_1.default
+    Auth0: auth0_1.default,
 };

package/lib/tools/logger.js

@@ -1,15 +1,21 @@
-const winston = require('winston');
-winston.emitErrs = true;
-const logger = new winston.Logger({
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const winston_1 = __importDefault(require("winston"));
+//@ts-ignore because emitErrs is still supported
+winston_1.default.emitErrs = true;
+const logger = new winston_1.default.Logger({
     transports: [
-        new winston.transports.Console({
+        new winston_1.default.transports.Console({
             timestamp: true,
             level: 'info',
             handleExceptions: true,
             json: false,
-            colorize: true
-        })
+            colorize: true,
+        }),
     ],
-    exitOnError: false
+    exitOnError: false,
 });
-module.exports = logger;
+exports.default = logger;

package/lib/tools/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.areArraysEquals = exports.filterExcluded = exports.duplicateItems = exports.getEnabledClients = exports.stripFields = exports.calcChanges = exports.processChangedObjectFields = exports.dumpJSON = exports.flatten = exports.loadFileAndReplaceKeywords = exports.convertClientNamesToIds = exports.convertClientNameToId = exports.keywordReplace = exports.keywordStringReplace = exports.keywordArrayReplace = void 0;
+exports.areArraysEquals = exports.filterExcluded = exports.duplicateItems = exports.getEnabledClients = exports.stripFields = exports.dumpJSON = exports.flatten = exports.loadFileAndReplaceKeywords = exports.convertClientNamesToIds = exports.convertClientNameToId = exports.keywordReplace = exports.keywordStringReplace = exports.keywordArrayReplace = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const dot_prop_1 = __importDefault(require("dot-prop"));
@@ -80,147 +80,6 @@ function dumpJSON(obj, spacing = 0) {
     return JSON.stringify(obj, null, spacing);
 }
 exports.dumpJSON = dumpJSON;
-/**
- * @template T
- * @param {typeof import('./auth0/handlers/default').default} handler
- * @param {T} desiredAssetState
- * @param {T} currentAssetState
- * @param {string[]} [objectFields=[]]
- * @param {boolean} [allowDelete=false]
- * @returns T
- */
-function processChangedObjectFields({ handler, desiredAssetState, currentAssetState, allowDelete = false }) {
-    const desiredAssetStateWithChanges = Object.assign({}, desiredAssetState);
-    // eslint-disable-next-line no-restricted-syntax
-    for (const fieldName of handler.objectFields) {
-        const areDesiredStateAndCurrentStateEmpty = Object.keys(desiredAssetState[fieldName] || {}).length === 0 && Object.keys(currentAssetState[fieldName] || {}).length === 0;
-        if (areDesiredStateAndCurrentStateEmpty) {
-            // If both the desired state and current state for a given object is empty, it is a no-op and can skip
-            // eslint-disable-next-line no-continue
-            continue;
-        }
-        // A desired state that omits the objectField OR that has it as an empty object should
-        // signal that all fields should be removed (subject to ALLOW_DELETE).
-        if (desiredAssetState[fieldName] && Object.keys(desiredAssetState[fieldName]).length) {
-            // Both the current and desired state have the object field. Here's where we need to map
-            // to the APIv2 protocol of setting `null` values for deleted fields.
-            // For new and modified properties of the object field, we can just pass them through to
-            // APIv2.
-            if (currentAssetState[fieldName]) {
-                // eslint-disable-next-line no-restricted-syntax
-                for (const currentObjectFieldPropertyName of Object.keys(currentAssetState[fieldName])) {
-                    // Loop through each object property that exists currently
-                    if (desiredAssetState[fieldName][currentObjectFieldPropertyName] === undefined) {
-                        // If the object has a property that exists now but doesn't exist in the proposed state
-                        if (allowDelete) {
-                            desiredAssetStateWithChanges[fieldName][currentObjectFieldPropertyName] = null;
-                        }
-                        else {
-                            // If deletes aren't allowed, do outright delete the property within the object
-                            logger_1.default.warn(`Detected that the ${fieldName} of the following ${handler.name || handler.id || ''} should be deleted. Doing so may be destructive.\nYou can enable deletes by setting 'AUTH0_ALLOW_DELETE' to true in the config\n${handler.objString(currentAssetState)}`);
-                        }
-                    }
-                }
-            }
-        }
-        else if (allowDelete) {
-            // If the desired state does not have the object field and the current state does, we
-            // should mark *all* properties for deletion by specifying an empty object.
-            //
-            // See: https://auth0.com/docs/users/metadata/manage-metadata-api#delete-user-metadata
-            desiredAssetStateWithChanges[fieldName] = {};
-        }
-        else {
-            delete desiredAssetStateWithChanges[fieldName];
-            logger_1.default.warn(`Detected that the ${fieldName} of the following ${handler.name || handler.id || ''} should be emptied. Doing so may be destructive.\nYou can enable deletes by setting 'AUTH0_ALLOW_DELETE' to true in the config\n${handler.objString(currentAssetState)}`);
-        }
-    }
-    return desiredAssetStateWithChanges;
-}
-exports.processChangedObjectFields = processChangedObjectFields;
-function calcChanges(handler, assets, existing, identifiers = ['id', 'name'], allowDelete = false) {
-    // Calculate the changes required between two sets of assets.
-    const update = [];
-    let del = [...existing];
-    let create = [...assets];
-    const conflicts = [];
-    const findByKeyValue = (key, value, arr) => arr.find((e) => {
-        if (Array.isArray(key)) {
-            const values = key.map((k) => e[k]);
-            if (values.every((v) => v)) {
-                return value === values.join('-');
-            }
-        }
-        else {
-            return e[key] === value;
-        }
-        return false;
-    });
-    const processAssets = (id, arr) => {
-        arr.forEach((asset) => {
-            let assetIdValue;
-            if (Array.isArray(id)) {
-                const values = id.map((i) => asset[i]);
-                if (values.every((v) => v)) {
-                    assetIdValue = values.join('-');
-                }
-            }
-            else {
-                assetIdValue = asset[id];
-            }
-            if (assetIdValue) {
-                const found = findByKeyValue(id, assetIdValue, del);
-                if (found) {
-                    // Delete from existing
-                    del = del.filter((e) => e !== found);
-                    // Delete from create as it's an update
-                    create = create.filter((e) => e !== asset);
-                    // Append identifiers to asset
-                    update.push(Object.assign(Object.assign({}, identifiers.reduce((obj, i) => {
-                        if (found[i])
-                            obj[i] = found[i];
-                        return obj;
-                    }, {})), (handler.objectFields.length
-                        ? processChangedObjectFields({
-                            handler, desiredAssetState: asset, currentAssetState: found, allowDelete
-                        })
-                        : asset)));
-                }
-            }
-        });
-    };
-    // Loop through identifiers (in order) to try match assets to existing
-    // If existing then update if not create
-    // The remainder will be deleted
-    for (const id of identifiers) { // eslint-disable-line
-        processAssets(id, [...create]);
-    }
-    // Check if there are assets with names that will conflict with existing names during the update process
-    // This will rename those assets to a temp random name first
-    // This assumes the first identifiers is the unique identifier
-    if (identifiers.includes('name')) {
-        const uniqueID = identifiers[0];
-        const futureAssets = [...create, ...update];
-        futureAssets.forEach((a) => {
-            // If the conflicting item is going to be deleted then skip
-            const inDeleted = del.filter((e) => e.name === a.name && e[uniqueID] !== a[uniqueID])[0];
-            if (!inDeleted) {
-                const conflict = existing.filter((e) => e.name === a.name && e[uniqueID] !== a[uniqueID])[0];
-                if (conflict) {
-                    const temp = Math.random().toString(36).substr(2, 5);
-                    conflicts.push(Object.assign(Object.assign({}, conflict), { name: `${conflict.name}-${temp}` }));
-                }
-            }
-        });
-    }
-    return {
-        del,
-        update,
-        conflicts,
-        create
-    };
-}
-exports.calcChanges = calcChanges;
 function stripFields(obj, fields) {
     // Strip object fields supporting dot notation (ie: a.deep.field)
     const stripped = [];
@@ -243,7 +102,7 @@ function getEnabledClients(assets, connection, existing, clients) {
     const excludedClientsByNames = (assets.exclude && assets.exclude.clients) || [];
     const excludedClients = convertClientNamesToIds(excludedClientsByNames, clients);
     const enabledClients = [
-        ...convertClientNamesToIds(connection.enabled_clients || [], clients).filter((item) => ![...excludedClientsByNames, ...excludedClients].includes(item))
+        ...convertClientNamesToIds(connection.enabled_clients || [], clients).filter((item) => ![...excludedClientsByNames, ...excludedClients].includes(item)),
     ];
     // If client is excluded and in the existing connection this client is enabled, it should keep enabled
     // If client is excluded and in the existing connection this client is disabled, it should keep disabled
@@ -283,7 +142,7 @@ function filterExcluded(changes, exclude) {
         del: filter(del),
         update: filter(update),
         create: filter(create),
-        conflicts: filter(conflicts)
+        conflicts: filter(conflicts),
     };
 }
 exports.filterExcluded = filterExcluded;

package/lib/tools/{ValidationError.js → validationError.js}

@@ -1,3 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 function ValidationError(message) {
     Error.call(this, message);
     if (process.env.NODE_ENV !== 'production') {
@@ -9,4 +11,4 @@ function ValidationError(message) {
 }
 ValidationError.prototype = Object.create(Error.prototype);
 ValidationError.prototype.constructor = ValidationError;
-module.exports = ValidationError;
+exports.default = ValidationError;

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils.js

@@ -3,7 +3,7 @@ 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;
+exports.mapClientID2NameSorted = exports.convertClientIdToName = exports.clearClientArrays = exports.ensureProp = exports.clearTenantFlags = exports.recordsSorter = exports.formatResults = 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"));
@@ -12,8 +12,7 @@ const tools_1 = require("./tools");
 const logger_1 = __importDefault(require("./logger"));
 function isDirectory(f) {
     try {
-        return fs_extra_1.default.statSync(path_1.default.resolve(f))
-            .isDirectory();
+        return fs_extra_1.default.statSync(path_1.default.resolve(f)).isDirectory();
     }
     catch (err) {
         return false;
@@ -22,8 +21,7 @@ function isDirectory(f) {
 exports.isDirectory = isDirectory;
 function isFile(f) {
     try {
-        return fs_extra_1.default.statSync(path_1.default.resolve(f))
-            .isFile();
+        return fs_extra_1.default.statSync(path_1.default.resolve(f)).isFile();
     }
     catch (err) {
         return false;
@@ -32,7 +30,8 @@ function isFile(f) {
 exports.isFile = isFile;
 function getFiles(folder, exts) {
     if (isDirectory(folder)) {
-        return fs_extra_1.default.readdirSync(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)));
     }
@@ -84,7 +83,7 @@ function stripIdentifiers(auth0, assets) {
         'emailTemplates',
         'guardianFactors',
         'guardianFactorProviders',
-        'guardianFactorTemplates'
+        'guardianFactorTemplates',
     ];
     // Optionally Strip identifiers
     auth0.handlers.forEach((h) => {
@@ -107,12 +106,6 @@ function sanitize(str) {
     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) };
-}
-exports.hoursAsInteger = hoursAsInteger;
 function formatResults(item) {
     if (typeof item !== 'object') {
         return item;
@@ -126,10 +119,12 @@ function formatResults(item) {
         strategy: null,
         script: null,
         stage: null,
-        id: null
+        id: null,
     };
     const result = Object.assign({}, importantFields);
-    Object.entries(item).sort().forEach(([key, value]) => {
+    Object.entries(item)
+        .sort()
+        .forEach(([key, value]) => {
         result[key] = value;
     });
     Object.keys(importantFields).forEach((key) => {
@@ -140,12 +135,7 @@ function formatResults(item) {
 }
 exports.formatResults = formatResults;
 function recordsSorter(a, b) {
-    const importantFields = [
-        'name',
-        'key',
-        'client_id',
-        'template'
-    ];
+    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]) {
@@ -189,7 +179,7 @@ function convertClientIdToName(clientId, knownClients = []) {
 exports.convertClientIdToName = convertClientIdToName;
 function mapClientID2NameSorted(enabledClients, knownClients) {
     return [
-        ...(enabledClients || []).map((clientId) => convertClientIdToName(clientId, knownClients))
+        ...(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.5.1",
+  "version": "7.7.0",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -9,8 +9,9 @@
   "scripts": {
     "lint:fix": "eslint --fix --ignore-path .eslintignore --ignore-pattern webpack . && kacl lint",
     "lint": "eslint --ignore-path .eslintignore --ignore-pattern webpack . && kacl lint",
+    "format": "npx prettier --write .",
     "pretest": "rimraf ./.nyc_output",
-    "test": "ts-mocha -p tsconfig.json --recursive 'test/**/*.test.*'",
+    "test": "ts-mocha -p tsconfig.json --recursive 'test/**/*.test*'",
     "build": "rimraf ./lib && npx tsc",
     "dev": "npx tsc --watch",
     "prepare": "npm run build",
@@ -29,6 +30,9 @@
   "readme": "README.md",
   "homepage": "https://github.com/auth0/auth0-deploy-cli#readme",
   "dependencies": {
+    "@types/lodash": "^4.14.181",
+    "@types/nconf": "^0.10.2",
+    "@types/winston": "^2.4.4",
     "ajv": "^6.12.6",
     "auth0": "^2.40.0",
     "dot-prop": "^5.2.0",
@@ -52,11 +56,14 @@
     "cross-env": "^3.1.4",
     "eslint": "^7.28.0",
     "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.20.2",
     "husky": "^7.0.4",
     "kacl": "^1.1.1",
     "mocha": "^9.1.3",
     "nyc": "^15.0.1",
+    "prettier": "^2.6.1",
+    "pretty-quick": "^3.1.3",
     "rimraf": "^3.0.2",
     "rmdir-sync": "^1.0.1",
     "ts-mocha": "^9.0.2",

package/tsconfig.json

@@ -9,9 +9,8 @@
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "strict": false,
+    "strictNullChecks": true,
     "skipLibCheck": true
   },
-  "include": [
-    "src/**/*"
-  ]
+  "include": ["src/**/*"]
 }

package/typescript-migration-progress.sh

@@ -17,6 +17,6 @@ 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 "${numTsFiles} of ${totalNumFiles} (${percentFilesMigrated}%) files migrated to Typescript"
 
 echo "- - - - - - - - - - - - - - - - - - - - - -"