auth0-deploy-cli 7.5.2 → 7.7.1

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

@@ -13,9 +13,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.order = void 0;
-const ValidationError_1 = __importDefault(require("../../ValidationError"));
+const validationError_1 = __importDefault(require("../../validationError"));
 const logger_1 = __importDefault(require("../../logger"));
 const utils_1 = require("../../utils");
+const calculateChanges_1 = require("../../calculateChanges");
 function order(value) {
     return function decorator(t, n, descriptor) {
         descriptor.value.order = value; // eslint-disable-line
@@ -23,7 +24,7 @@ function order(value) {
     };
 }
 exports.order = order;
-class DefaultHandler {
+class APIHandler {
     constructor(options) {
         this.config = options.config;
         this.type = options.type;
@@ -32,11 +33,8 @@ class DefaultHandler {
         this.existing = null;
         this.identifiers = options.identifiers || ['id', 'name'];
         this.objectFields = options.objectFields || [];
-        this.stripUpdateFields = [
-            ...options.stripUpdateFields || [],
-            this.id
-        ];
-        this.functions = Object.assign({ getAll: 'getAll', create: 'create', update: 'update', delete: 'delete' }, options.functions || {});
+        this.stripUpdateFields = [...(options.stripUpdateFields || []), this.id];
+        this.functions = Object.assign({ getAll: 'getAll', create: 'create', delete: 'delete', update: 'update' }, (options.functions || {}));
         this.updated = 0;
         this.created = 0;
         this.deleted = 0;
@@ -58,7 +56,7 @@ class DefaultHandler {
         logger_1.default.info(`Updated [${this.type}]: ${this.objString(item)}`);
     }
     objString(item) {
-        return (0, utils_1.dumpJSON)(item);
+        return (0, utils_1.convertJsonToString)(item);
     }
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -79,10 +77,21 @@ class DefaultHandler {
             const typeAssets = assets[this.type];
             // Do nothing if not set
             if (!typeAssets)
-                return {};
+                return {
+                    del: [],
+                    create: [],
+                    conflicts: [],
+                    update: [],
+                };
             const existing = yield this.getType();
             // Figure out what needs to be updated vs created
-            return (0, utils_1.calcChanges)(this, typeAssets, existing, this.identifiers);
+            return (0, calculateChanges_1.calculateChanges)({
+                handler: this,
+                assets: typeAssets,
+                //@ts-ignore TODO: investigate what happens when `existing` is null
+                existing,
+                identifiers: this.identifiers,
+            });
         });
     }
     validate(assets) {
@@ -96,16 +105,16 @@ class DefaultHandler {
             const duplicateNames = (0, utils_1.duplicateItems)(typeAssets, 'name');
             if (duplicateNames.length > 0) {
                 const formatted = duplicateNames.map((dups) => dups.map((d) => `${d.name}`));
-                throw new ValidationError_1.default(`There are multiple ${this.type} with the same name combinations
-      ${(0, utils_1.dumpJSON)(formatted)}.
+                throw new validationError_1.default(`There are multiple ${this.type} with the same name combinations
+      ${(0, utils_1.convertJsonToString)(formatted)}.
        Names must be unique.`);
             }
             // Do not allow items with same id
             const duplicateIDs = (0, utils_1.duplicateItems)(typeAssets, this.id);
             if (duplicateIDs.length > 0) {
                 const formatted = duplicateIDs.map((dups) => dups.map((d) => `${d[this.id]}`));
-                throw new ValidationError_1.default(`There are multiple ${this.type} for the following stage-order combinations
-      ${(0, utils_1.dumpJSON)(formatted)}.
+                throw new validationError_1.default(`There are multiple ${this.type} for the following stage-order combinations
+      ${(0, utils_1.convertJsonToString)(formatted)}.
        Only one rule must be defined for the same order number in a stage.`);
             }
         });
@@ -123,7 +132,8 @@ class DefaultHandler {
             // Process Deleted
             if (del.length > 0) {
                 const allowDelete = this.config('AUTH0_ALLOW_DELETE') === 'true' || this.config('AUTH0_ALLOW_DELETE') === true;
-                const byExtension = this.config('EXTENSION_SECRET') && (this.type === 'rules' || this.type === 'resourceServers');
+                const byExtension = this.config('EXTENSION_SECRET') &&
+                    (this.type === 'rules' || this.type === 'resourceServers');
                 const shouldDelete = allowDelete || byExtension;
                 if (!shouldDelete) {
                     logger_1.default.warn(`Detected the following ${this.type} should be deleted. Doing so may be destructive.\nYou can enable deletes by setting 'AUTH0_ALLOW_DELETE' to true in the config
@@ -131,7 +141,8 @@ class DefaultHandler {
          `);
                 }
                 else {
-                    yield this.client.pool.addEachTask({
+                    yield this.client.pool
+                        .addEachTask({
                         data: del || [],
                         generator: (delItem) => {
                             const delFunction = this.getClientFN(this.functions.delete);
@@ -143,12 +154,14 @@ class DefaultHandler {
                                 .catch((err) => {
                                 throw new Error(`Problem deleting ${this.type} ${this.objString(delItem)}\n${err}`);
                             });
-                        }
-                    }).promise();
+                        },
+                    })
+                        .promise();
                 }
             }
             // Process Renaming Entries Temp due to conflicts in names
-            yield this.client.pool.addEachTask({
+            yield this.client.pool
+                .addEachTask({
                 data: conflicts || [],
                 generator: (updateItem) => {
                     const updateFN = this.getClientFN(this.functions.update);
@@ -159,10 +172,12 @@ class DefaultHandler {
                         .catch((err) => {
                         throw new Error(`Problem updating ${this.type} ${this.objString(updateItem)}\n${err}`);
                     });
-                }
-            }).promise();
+                },
+            })
+                .promise();
             // Process Creations
-            yield this.client.pool.addEachTask({
+            yield this.client.pool
+                .addEachTask({
                 data: create || [],
                 generator: (createItem) => {
                     const createFunction = this.getClientFN(this.functions.create);
@@ -174,10 +189,12 @@ class DefaultHandler {
                         .catch((err) => {
                         throw new Error(`Problem creating ${this.type} ${this.objString(createItem)}\n${err}`);
                     });
-                }
-            }).promise();
+                },
+            })
+                .promise();
             // Process Updates and strip fields not allowed in updates
-            yield this.client.pool.addEachTask({
+            yield this.client.pool
+                .addEachTask({
                 data: update || [],
                 generator: (updateItem) => {
                     const updateFN = this.getClientFN(this.functions.update);
@@ -191,9 +208,10 @@ class DefaultHandler {
                         .catch((err) => {
                         throw new Error(`Problem updating ${this.type} ${this.objString(updateItem)}\n${err}`);
                     });
-                }
-            }).promise();
+                },
+            })
+                .promise();
         });
     }
 }
-exports.default = DefaultHandler;
+exports.default = APIHandler;

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

@@ -44,19 +44,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = exports.supportedTemplates = void 0;
 const default_1 = __importStar(require("./default"));
 const constants_1 = __importDefault(require("../../constants"));
-exports.supportedTemplates = constants_1.default.EMAIL_TEMPLATES_NAMES
-    .filter((p) => p.includes('.json'))
-    .map((p) => p.replace('.json', ''));
+exports.supportedTemplates = constants_1.default.EMAIL_TEMPLATES_NAMES.filter((p) => p.includes('.json')).map((p) => p.replace('.json', ''));
 exports.schema = {
     type: 'array',
     items: {
         type: 'object',
         properties: {
             template: { type: 'string', enum: exports.supportedTemplates },
-            body: { type: 'string', default: '' }
+            body: { type: 'string', default: '' },
         },
-        required: ['template']
-    }
+        required: ['template'],
+    },
 };
 class EmailTemplateHandler extends default_1.default {
     constructor(options) {
@@ -64,11 +62,10 @@ class EmailTemplateHandler extends default_1.default {
     }
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
-            const emailTemplates = [];
-            yield Promise.all(constants_1.default.EMAIL_TEMPLATES_TYPES.map((name) => __awaiter(this, void 0, void 0, function* () {
+            const emailTemplates = yield Promise.all(constants_1.default.EMAIL_TEMPLATES_TYPES.map((name) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     const template = yield this.client.emailTemplates.get({ name });
-                    emailTemplates.push(template);
+                    return template;
                 }
                 catch (err) {
                     // Ignore if not found, else throw error
@@ -77,7 +74,8 @@ class EmailTemplateHandler extends default_1.default {
                     }
                 }
             })));
-            return emailTemplates;
+            const nonEmptyTemplates = emailTemplates.filter((template) => !!template);
+            return nonEmptyTemplates;
         });
     }
     updateOrCreate(emailTemplate) {

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

@@ -27,10 +27,10 @@ exports.schema = {
         type: 'object',
         properties: {
             name: { type: 'string', enum: constants_1.default.GUARDIAN_FACTORS },
-            provider: { type: 'string', enum: mappings.map((p) => p.provider) }
+            provider: { type: 'string', enum: mappings.map((p) => p.provider) },
         },
-        required: ['name', 'provider']
-    }
+        required: ['name', 'provider'],
+    },
 };
 class GuardianFactorProvidersHandler extends default_1.default {
     constructor(options) {

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

@@ -20,10 +20,10 @@ exports.schema = {
     items: {
         type: 'object',
         properties: {
-            name: { type: 'string', enum: constants_1.default.GUARDIAN_FACTOR_TEMPLATES }
+            name: { type: 'string', enum: constants_1.default.GUARDIAN_FACTOR_TEMPLATES },
         },
-        required: ['name']
-    }
+        required: ['name'],
+    },
 };
 class GuardianFactorTemplatesHandler extends default_1.default {
     constructor(options) {

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

@@ -20,10 +20,10 @@ exports.schema = {
     items: {
         type: 'object',
         properties: {
-            name: { type: 'string', enum: constants_1.default.GUARDIAN_FACTORS }
+            name: { type: 'string', enum: constants_1.default.GUARDIAN_FACTORS },
         },
-        required: ['name']
-    }
+        required: ['name'],
+    },
 };
 class GuardianFactorsHandler extends default_1.default {
     constructor(options) {

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

@@ -22,22 +22,22 @@ exports.schema = {
             type: 'array',
             items: {
                 type: 'string',
-                enum: constants_1.default.GUARDIAN_PHONE_MESSAGE_TYPES
-            }
-        }
+                enum: constants_1.default.GUARDIAN_PHONE_MESSAGE_TYPES,
+            },
+        },
     },
-    additionalProperties: false
+    additionalProperties: false,
 };
 const isFeatureUnavailableError = (err) => {
     if (err.statusCode === 404) {
         // Older Management API version where the endpoint is not available.
         return true;
     }
-    if (err.statusCode === 403
-        && err.originalError
-        && err.originalError.response
-        && err.originalError.response.body
-        && err.originalError.response.body.errorCode === 'voice_mfa_not_allowed') {
+    if (err.statusCode === 403 &&
+        err.originalError &&
+        err.originalError.response &&
+        err.originalError.response.body &&
+        err.originalError.response.body.errorCode === 'voice_mfa_not_allowed') {
         // Recent Management API version, but with feature explicitly disabled.
         return true;
     }
@@ -50,7 +50,8 @@ class GuardianPhoneMessageTypesHandler extends default_1.default {
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
             // in case client version does not support the operation
-            if (!this.client.guardian || typeof this.client.guardian.getPhoneFactorMessageTypes !== 'function') {
+            if (!this.client.guardian ||
+                typeof this.client.guardian.getPhoneFactorMessageTypes !== 'function') {
                 return {};
             }
             if (this.existing)

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

@@ -20,21 +20,21 @@ exports.schema = {
     properties: {
         provider: {
             type: 'string',
-            enum: constants_1.default.GUARDIAN_PHONE_PROVIDERS
-        }
+            enum: constants_1.default.GUARDIAN_PHONE_PROVIDERS,
+        },
     },
-    additionalProperties: false
+    additionalProperties: false,
 };
 const isFeatureUnavailableError = (err) => {
     if (err.statusCode === 404) {
         // Older Management API version where the endpoint is not available.
         return true;
     }
-    if (err.statusCode === 403
-        && err.originalError
-        && err.originalError.response
-        && err.originalError.response.body
-        && err.originalError.response.body.errorCode === 'hooks_not_allowed') {
+    if (err.statusCode === 403 &&
+        err.originalError &&
+        err.originalError.response &&
+        err.originalError.response.body &&
+        err.originalError.response.body.errorCode === 'hooks_not_allowed') {
         // Recent Management API version, but with feature explicitly disabled.
         return true;
     }
@@ -47,7 +47,8 @@ class GuardianPhoneSelectedProviderHandler extends default_1.default {
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
             // in case client version does not support the operation
-            if (!this.client.guardian || typeof this.client.guardian.getPhoneFactorSelectedProvider !== 'function') {
+            if (!this.client.guardian ||
+                typeof this.client.guardian.getPhoneFactorSelectedProvider !== 'function') {
                 return {};
             }
             if (this.existing)

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

@@ -22,16 +22,17 @@ exports.schema = {
             type: 'array',
             items: {
                 type: 'string',
-                enum: constants_1.default.GUARDIAN_POLICIES
-            }
-        }
+                enum: constants_1.default.GUARDIAN_POLICIES,
+            },
+        },
     },
-    additionalProperties: false
+    additionalProperties: false,
 };
 class GuardianPoliciesHandler extends default_1.default {
     constructor(options) {
         super(Object.assign(Object.assign({}, options), { type: 'guardianPolicies' }));
     }
+    //TODO: standardize empty object literal with more intentional empty indicator
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
             // in case client version does not support the operation

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

@@ -15,10 +15,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = exports.excludeSchema = void 0;
 const default_1 = __importDefault(require("./default"));
 const constants_1 = __importDefault(require("../../constants"));
-const ALLOWED_TRIGGER_IDS = ['credentials-exchange', 'pre-user-registration', 'post-user-registration', 'post-change-password', 'send-phone-message'];
+const ALLOWED_TRIGGER_IDS = [
+    'credentials-exchange',
+    'pre-user-registration',
+    'post-user-registration',
+    'post-change-password',
+    'send-phone-message',
+];
 exports.excludeSchema = {
     type: 'array',
-    items: { type: 'string' }
+    items: { type: 'string' },
 };
 exports.schema = {
     type: 'array',
@@ -28,37 +34,37 @@ exports.schema = {
         properties: {
             script: {
                 type: 'string',
-                description: 'A script that contains the hook\'s code',
-                default: ''
+                description: "A script that contains the hook's code",
+                default: '',
             },
             name: {
                 type: 'string',
-                description: 'The name of the hook. Can only contain alphanumeric characters, spaces and \'-\'. Can neither start nor end with \'-\' or spaces',
-                pattern: '^[^-\\s][a-zA-Z0-9-\\s]+[^-\\s]$'
+                description: "The name of the hook. Can only contain alphanumeric characters, spaces and '-'. Can neither start nor end with '-' or spaces",
+                pattern: '^[^-\\s][a-zA-Z0-9-\\s]+[^-\\s]$',
             },
             enabled: {
                 type: 'boolean',
                 description: 'true if the hook is active, false otherwise',
-                default: false
+                default: false,
             },
             triggerId: {
                 type: 'string',
-                description: 'The hooks\'s trigger ID',
-                enum: ALLOWED_TRIGGER_IDS
+                description: "The hooks's trigger ID",
+                enum: ALLOWED_TRIGGER_IDS,
             },
             secrets: {
                 type: 'object',
                 description: 'List of key-value pairs containing secrets available to the hook.',
-                default: {}
+                default: {},
             },
             dependencies: {
                 type: 'object',
                 default: {},
-                description: 'List of key-value pairs of NPM dependencies available to the hook.'
-            }
+                description: 'List of key-value pairs of NPM dependencies available to the hook.',
+            },
         },
-        required: ['script', 'name', 'triggerId']
-    }
+        required: ['script', 'name', 'triggerId'],
+    },
 };
 const getCertainHook = (hooks, name, triggerId) => {
     let result = null;
@@ -89,11 +95,13 @@ class HooksHandler extends default_1.default {
             const changes = {
                 create: [],
                 update: [],
-                del: []
+                del: [],
+                conflicts: [],
             };
             hooks.forEach((hook) => {
                 const current = getCertainHook(allHooks, hook.name, hook.triggerId);
-                if (current) { // if the hook was deleted we don't care about its secrets
+                if (current) {
+                    // if the hook was deleted we don't care about its secrets
                     const oldSecrets = current.secrets || {};
                     const newSecrets = hook.secrets || {};
                     const create = {};
@@ -131,6 +139,7 @@ class HooksHandler extends default_1.default {
             })));
         });
     }
+    //@ts-ignore because hooks use a special reload argument
     getType(reload) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.existing && !reload) {
@@ -143,8 +152,10 @@ class HooksHandler extends default_1.default {
             try {
                 const hooks = yield this.client.hooks.getAll({ paginate: true, include_totals: true });
                 // hooks.getAll does not return code and secrets, we have to fetch hooks one-by-one
-                this.existing = yield Promise.all(hooks.map((hook) => this.client.hooks.get({ id: hook.id })
-                    .then((hookWithCode) => this.client.hooks.getSecrets({ id: hook.id })
+                this.existing = yield Promise.all(hooks.map((hook) => this.client.hooks
+                    .get({ id: hook.id })
+                    .then((hookWithCode) => this.client.hooks
+                    .getSecrets({ id: hook.id })
                     .then((secrets) => (Object.assign(Object.assign({}, hookWithCode), { secrets }))))));
                 return this.existing;
             }
@@ -168,7 +179,7 @@ class HooksHandler extends default_1.default {
                 del,
                 update: stripSecrets(update),
                 create: stripSecrets(create),
-                conflicts: stripSecrets(conflicts)
+                conflicts: stripSecrets(conflicts),
             };
         });
     }
@@ -183,9 +194,11 @@ class HooksHandler extends default_1.default {
                 return;
             const activeHooks = getActive(hooks);
             ALLOWED_TRIGGER_IDS.forEach((type) => {
-                if (activeHooks[type].length > 1) { // There can be only one!
+                if (activeHooks[type].length > 1) {
+                    // There can be only one!
                     const conflict = activeHooks[type].map((h) => h.name).join(', ');
                     const err = new Error(`Only one active hook allowed for "${type}" extensibility point. Conflicting hooks: ${conflict}`);
+                    //@ts-ignore need to investigate if appending status actually works here
                     err.status = 409;
                     throw err;
                 }
@@ -208,7 +221,7 @@ class HooksHandler extends default_1.default {
                 del: changes.del,
                 create: changes.create,
                 update: changes.update,
-                conflicts: changes.conflicts
+                conflicts: changes.conflicts,
             });
             yield this.processSecrets(hooks);
         });

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

@@ -23,56 +23,60 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attackProtection = exports.organizations = exports.triggers = exports.actions = exports.migrations = exports.prompts = exports.branding = exports.roles = exports.guardianPhoneFactorMessageTypes = exports.guardianPhoneFactorSelectedProvider = exports.guardianPolicies = exports.guardianFactorTemplates = exports.guardianFactorProviders = exports.guardianFactors = exports.clientGrants = exports.emailTemplates = exports.emailProvider = exports.tenant = exports.connections = exports.databases = exports.clients = exports.resourceServers = exports.pages = exports.hooks = exports.rulesConfigs = exports.rules = void 0;
+//TODO:
 const rules = __importStar(require("./rules"));
-exports.rules = rules;
 const rulesConfigs = __importStar(require("./rulesConfigs"));
-exports.rulesConfigs = rulesConfigs;
 const hooks = __importStar(require("./hooks"));
-exports.hooks = hooks;
 const pages = __importStar(require("./pages"));
-exports.pages = pages;
 const resourceServers = __importStar(require("./resourceServers"));
-exports.resourceServers = resourceServers;
 const databases = __importStar(require("./databases"));
-exports.databases = databases;
 const connections = __importStar(require("./connections"));
-exports.connections = connections;
 const clients = __importStar(require("./clients"));
-exports.clients = clients;
 const tenant = __importStar(require("./tenant"));
-exports.tenant = tenant;
 const emailProvider = __importStar(require("./emailProvider"));
-exports.emailProvider = emailProvider;
 const emailTemplates = __importStar(require("./emailTemplates"));
-exports.emailTemplates = emailTemplates;
 const clientGrants = __importStar(require("./clientGrants"));
-exports.clientGrants = clientGrants;
 const guardianFactors = __importStar(require("./guardianFactors"));
-exports.guardianFactors = guardianFactors;
 const guardianFactorProviders = __importStar(require("./guardianFactorProviders"));
-exports.guardianFactorProviders = guardianFactorProviders;
 const guardianFactorTemplates = __importStar(require("./guardianFactorTemplates"));
-exports.guardianFactorTemplates = guardianFactorTemplates;
 const guardianPolicies = __importStar(require("./guardianPolicies"));
-exports.guardianPolicies = guardianPolicies;
 const guardianPhoneFactorSelectedProvider = __importStar(require("./guardianPhoneFactorSelectedProvider"));
-exports.guardianPhoneFactorSelectedProvider = guardianPhoneFactorSelectedProvider;
 const guardianPhoneFactorMessageTypes = __importStar(require("./guardianPhoneFactorMessageTypes"));
-exports.guardianPhoneFactorMessageTypes = guardianPhoneFactorMessageTypes;
 const roles = __importStar(require("./roles"));
-exports.roles = roles;
 const branding = __importStar(require("./branding"));
-exports.branding = branding;
 const prompts = __importStar(require("./prompts"));
-exports.prompts = prompts;
 const migrations = __importStar(require("./migrations"));
-exports.migrations = migrations;
 const actions = __importStar(require("./actions"));
-exports.actions = actions;
 const triggers = __importStar(require("./triggers"));
-exports.triggers = triggers;
 const organizations = __importStar(require("./organizations"));
-exports.organizations = organizations;
 const attackProtection = __importStar(require("./attackProtection"));
-exports.attackProtection = attackProtection;
+const auth0ApiHandlers = {
+    rules,
+    rulesConfigs,
+    hooks,
+    pages,
+    resourceServers,
+    clients,
+    databases,
+    connections,
+    tenant,
+    emailProvider,
+    emailTemplates,
+    clientGrants,
+    guardianFactors,
+    guardianFactorProviders,
+    guardianFactorTemplates,
+    guardianPolicies,
+    guardianPhoneFactorSelectedProvider,
+    guardianPhoneFactorMessageTypes,
+    roles,
+    branding,
+    //@ts-ignore because prompts have not been universally implemented yet
+    prompts,
+    migrations,
+    actions,
+    triggers,
+    organizations,
+    attackProtection,
+};
+exports.default = auth0ApiHandlers; // TODO: apply stronger types to schema properties

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

@@ -46,12 +46,13 @@ const default_1 = __importStar(require("./default"));
 const logger_1 = __importDefault(require("../../logger"));
 exports.schema = {
     type: 'object',
-    additionalProperties: { type: 'boolean' }
+    additionalProperties: { type: 'boolean' },
 };
 class MigrationsHandler extends default_1.default {
     constructor(options) {
         super(Object.assign(Object.assign({}, options), { type: 'migrations' }));
     }
+    //TODO: standardize empty object literal with more intentional empty indicator
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
             try {