auth0-deploy-cli 7.5.2 → 7.6.0

package/lib/tools/auth0/handlers/roles.js

@@ -43,7 +43,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = void 0;
 const default_1 = __importStar(require("./default"));
-const utils_1 = require("../../utils");
+const calculateChanges_1 = require("../../calculateChanges");
 const logger_1 = __importDefault(require("../../logger"));
 exports.schema = {
     type: 'array',
@@ -188,7 +188,12 @@ class RoleHandler extends default_1.default {
                 return;
             // Gets roles from destination tenant
             const existing = yield this.getType();
-            const changes = (0, utils_1.calcChanges)(this, roles, existing, ['id', 'name']);
+            const changes = (0, calculateChanges_1.calculateChanges)({
+                handler: this,
+                assets: roles,
+                existing,
+                identifiers: ['id', 'name']
+            });
             logger_1.default.debug(`Start processChanges for roles [delete:${changes.del.length}] [update:${changes.update.length}], [create:${changes.create.length}]`);
             const myChanges = [{ del: changes.del }, { create: changes.create }, { update: changes.update }];
             yield Promise.all(myChanges.map((change) => __awaiter(this, void 0, void 0, function* () {

package/lib/tools/auth0/handlers/rules.js

@@ -17,6 +17,7 @@ const ValidationError_1 = __importDefault(require("../../ValidationError"));
 const utils_1 = require("../../utils");
 const default_1 = __importDefault(require("./default"));
 const logger_1 = __importDefault(require("../../logger"));
+const calculateChanges_1 = require("../../calculateChanges");
 exports.excludeSchema = {
     type: 'array',
     items: { type: 'string' }
@@ -84,7 +85,12 @@ class RulesHandler extends default_1.default {
                 existing = existing.filter((r) => !excludedRules.includes(r.name));
             }
             // Figure out what needs to be updated vs created
-            const { del, update, create, conflicts } = (0, utils_1.calcChanges)(this, rules, existing, ['id', 'name']);
+            const { del, update, create, conflicts } = (0, calculateChanges_1.calculateChanges)({
+                handler: this,
+                assets: rules,
+                existing,
+                identifiers: ['id', 'name']
+            });
             // Figure out the rules that need to be re-ordered
             const futureRules = [...create, ...update];
             const futureMaxOrder = Math.max(...futureRules.map((r) => r.order));

package/lib/tools/calculateChanges.js

@@ -0,0 +1,144 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateChanges = exports.processChangedObjectFields = void 0;
+const logger_1 = __importDefault(require("./logger"));
+/**
+ * @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 calculateChanges({ handler, assets, existing, identifiers = ['id', 'name'], allowDelete }) {
+    // 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('-');
+            }
+        }
+        return e[key] === value;
+    });
+    const processAssets = (id, arr) => {
+        arr.forEach((asset) => {
+            const assetIdValue = (() => {
+                if (Array.isArray(id)) {
+                    const values = id.map((i) => asset[i]);
+                    if (values.every((v) => v)) {
+                        return values.join('-');
+                    }
+                }
+                return asset[id];
+            })();
+            if (assetIdValue !== undefined) {
+                const found = findByKeyValue(id, assetIdValue, del);
+                if (found !== undefined) {
+                    // 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.calculateChanges = calculateChanges;

package/lib/tools/constants.js

@@ -141,12 +141,19 @@ constants.GUARDIAN_FACTOR_PROVIDERS = {
     sms: ['twilio'],
     'push-notification': ['sns']
 };
+constants.UNIVERSAL_LOGIN_TEMPLATE = 'universal_login';
+constants.SUPPORTED_BRANDING_TEMPLATES = [
+    constants.UNIVERSAL_LOGIN_TEMPLATE
+];
 constants.RESOURCE_SERVERS_DIRECTORY = 'resource-servers';
 constants.RESOURCE_SERVERS_CLIENT_NAME = 'resourceServers';
 constants.RESOURCE_SERVERS_MANAGEMENT_API_NAME = 'Auth0 Management API';
 constants.RESOURCE_SERVERS_ID_NAME = 'id';
 constants.CLIENTS_DIRECTORY = 'clients';
 constants.CLIENTS_GRANTS_DIRECTORY = 'grants';
+constants.BRANDING_DIRECTORY = 'branding';
+constants.BRANDING_TEMPLATES_DIRECTORY = 'templates';
+constants.BRANDING_TEMPLATES_YAML_DIRECTORY = 'branding_templates';
 constants.CLIENTS_CLIENT_NAME = 'clients';
 constants.CLIENTS_CLIENT_ID_NAME = 'client_id';
 constants.CONNECTIONS_DIRECTORY = 'connections';

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 = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.5.2",
+  "version": "7.6.0",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -10,7 +10,7 @@
     "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": "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",

package/tsconfig.json

@@ -9,6 +9,7 @@
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "strict": false,
+    "strictNullChecks": true,
     "skipLibCheck": true
   },
   "include": [