auth0-deploy-cli 7.5.2 → 7.7.1

package/lib/context/yaml/handlers/guardianPhoneFactorMessageTypes.js

@@ -9,23 +9,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-function parse(context) {
+function parseAndDump(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // nothing to do, set default if empty
         return {
-            guardianPhoneFactorMessageTypes: Object.assign({}, context.assets.guardianPhoneFactorMessageTypes || {})
+            guardianPhoneFactorMessageTypes: Object.assign({}, (context.assets.guardianPhoneFactorMessageTypes || {})),
         };
     });
 }
-function dump(context) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // nothing to do, set default empty
-        return {
-            guardianPhoneFactorMessageTypes: Object.assign({}, context.assets.guardianPhoneFactorMessageTypes || {})
-        };
-    });
-}
-exports.default = {
-    parse,
-    dump
+const guardianPhoneFactorMessageTypesHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
 };
+exports.default = guardianPhoneFactorMessageTypesHandler;

package/lib/context/yaml/handlers/guardianPhoneFactorSelectedProvider.js

@@ -9,23 +9,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-function parse(context) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // nothing to do, set default if empty
-        return {
-            guardianPhoneFactorSelectedProvider: Object.assign({}, context.assets.guardianPhoneFactorSelectedProvider || {})
-        };
-    });
-}
-function dump(context) {
+function parseAndDump(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // nothing to do, set default empty
         return {
-            guardianPhoneFactorSelectedProvider: Object.assign({}, context.assets.guardianPhoneFactorSelectedProvider || {})
+            guardianPhoneFactorSelectedProvider: Object.assign({}, (context.assets.guardianPhoneFactorSelectedProvider || {})),
         };
     });
 }
-exports.default = {
-    parse,
-    dump
+const guardianPhoneFactorSelectedProviderHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
 };
+exports.default = guardianPhoneFactorSelectedProviderHandler;

package/lib/context/yaml/handlers/guardianPolicies.js

@@ -9,23 +9,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-function parse(context) {
+function parseAndDump(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // nothing to do, set default if empty
         return {
-            guardianPolicies: Object.assign({}, context.assets.guardianPolicies || {})
+            guardianPolicies: Object.assign({}, (context.assets.guardianPolicies || {})),
         };
     });
 }
-function dump(context) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // nothing to do, set default empty
-        return {
-            guardianPolicies: Object.assign({}, context.assets.guardianPolicies || {})
-        };
-    });
-}
-exports.default = {
-    parse,
-    dump
+const guardianPoliciesHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
 };
+exports.default = guardianPoliciesHandler;

package/lib/context/yaml/handlers/hooks.js

@@ -26,18 +26,19 @@ function parse(context) {
             hooks: [
                 ...context.assets.hooks.map((hook) => {
                     if (hook.script) {
+                        //@ts-ignore TODO: understand why two arguments are passed when context.loadFile only accepts one
                         hook.script = context.loadFile(hook.script, tools_1.constants.HOOKS_DIRECTORY);
                     }
                     hook.name = hook.name.toLowerCase().replace(/\s/g, '-');
                     return Object.assign({}, hook);
-                })
-            ]
+                }),
+            ],
         };
     });
 }
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        let hooks = [...context.assets.hooks || []];
+        let hooks = [...(context.assets.hooks || [])];
         if (hooks.length > 0) {
             // Create hooks folder
             const hooksFolder = path_1.default.join(context.basePath, 'hooks');
@@ -56,7 +57,8 @@ function dump(context) {
         return { hooks };
     });
 }
-exports.default = {
+const hooksHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = hooksHandler;

package/lib/context/yaml/handlers/index.js

@@ -27,7 +27,8 @@ const migrations_1 = __importDefault(require("./migrations"));
 const actions_1 = __importDefault(require("./actions"));
 const triggers_1 = __importDefault(require("./triggers"));
 const attackProtection_1 = __importDefault(require("./attackProtection"));
-exports.default = {
+const branding_1 = __importDefault(require("./branding"));
+const yamlHandlers = {
     rules: rules_1.default,
     hooks: hooks_1.default,
     rulesConfigs: rulesConfigs_1.default,
@@ -51,5 +52,7 @@ exports.default = {
     actions: actions_1.default,
     organizations: organizations_1.default,
     triggers: triggers_1.default,
-    attackProtection: attackProtection_1.default
+    attackProtection: attackProtection_1.default,
+    branding: branding_1.default,
 };
+exports.default = yamlHandlers;

package/lib/context/yaml/handlers/migrations.js

@@ -21,7 +21,8 @@ function dump(context) {
         return { migrations: migrations || {} };
     });
 }
-exports.default = {
+const migrationsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = migrationsHandler;

package/lib/context/yaml/handlers/organizations.js

@@ -13,7 +13,7 @@ function parse(context) {
     return __awaiter(this, void 0, void 0, function* () {
         const { organizations } = context.assets;
         return {
-            organizations: organizations
+            organizations: organizations,
         };
     });
 }
@@ -33,12 +33,13 @@ function dump(context) {
                         });
                     }
                     return org;
-                })
-            ]
+                }),
+            ],
         };
     });
 }
-exports.default = {
+const organizationsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = organizationsHandler;

package/lib/context/yaml/handlers/pages.js

@@ -22,14 +22,14 @@ function parse(context) {
             return {};
         return {
             pages: [
-                ...context.assets.pages.map((page) => (Object.assign(Object.assign({}, page), { html: page.html ? context.loadFile(page.html) : '' })))
-            ]
+                ...context.assets.pages.map((page) => (Object.assign(Object.assign({}, page), { html: page.html ? context.loadFile(page.html) : '' }))),
+            ],
         };
     });
 }
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        let pages = [...context.assets.pages || []];
+        let pages = [...(context.assets.pages || [])];
         if (pages.length > 0) {
             // Create Pages folder
             const pagesFolder = path_1.default.join(context.basePath, 'pages');
@@ -48,7 +48,8 @@ function dump(context) {
         return { pages };
     });
 }
-exports.default = {
+const pagesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = pagesHandler;

package/lib/context/yaml/handlers/resourceServers.js

@@ -13,7 +13,7 @@ function parse(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // nothing to do, set default if empty
         return {
-            resourceServers: context.assets.resourceServers
+            resourceServers: context.assets.resourceServers,
         };
     });
 }
@@ -21,11 +21,12 @@ function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // nothing to do, set default if empty
         return {
-            resourceServers: [...context.assets.resourceServers || []]
+            resourceServers: [...(context.assets.resourceServers || [])],
         };
     });
 }
-exports.default = {
+const resourceServersHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = resourceServersHandler;

package/lib/context/yaml/handlers/roles.js

@@ -13,7 +13,7 @@ function parse(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // nothing to do, set default empty
         return {
-            roles: context.assets.roles
+            roles: context.assets.roles,
         };
     });
 }
@@ -27,12 +27,13 @@ function dump(context) {
                         delete role.description;
                     }
                     return role;
-                })
-            ]
+                }),
+            ],
         };
     });
 }
-exports.default = {
+const rolesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = rolesHandler;

package/lib/context/yaml/handlers/rules.js

@@ -23,14 +23,14 @@ function parse(context) {
             return {};
         return {
             rules: [
-                ...context.assets.rules.map((rule) => (Object.assign(Object.assign({}, rule), { script: context.loadFile(rule.script) })))
-            ]
+                ...context.assets.rules.map((rule) => (Object.assign(Object.assign({}, rule), { script: context.loadFile(rule.script) }))),
+            ],
         };
     });
 }
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        let rules = [...context.assets.rules || []];
+        let rules = [...(context.assets.rules || [])];
         if (rules.length > 0) {
             // Create Rules folder
             const rulesFolder = path_1.default.join(context.basePath, 'rules');
@@ -47,7 +47,8 @@ function dump(context) {
         return { rules };
     });
 }
-exports.default = {
+const rulesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = rulesHandler;

package/lib/context/yaml/handlers/rulesConfigs.js

@@ -13,19 +13,20 @@ function parse(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // nothing to do, set default if empty
         return {
-            rulesConfigs: context.assets.rulesConfigs
+            rulesConfigs: context.assets.rulesConfigs,
         };
     });
 }
-function dump() {
+function dump(_context) {
     return __awaiter(this, void 0, void 0, function* () {
         // do not export rulesConfigs as its values cannot be extracted
         return {
-            rulesConfigs: []
+            rulesConfigs: [],
         };
     });
 }
-exports.default = {
+const rulesConfigsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = rulesConfigsHandler;

package/lib/context/yaml/handlers/tenant.js

@@ -21,6 +21,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
+const sessionDurationsToMinutes_1 = require("../../../sessionDurationsToMinutes");
 function parse(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // Nothing to do
@@ -29,20 +30,21 @@ function parse(context) {
         /* eslint-disable camelcase */
         const _a = context.assets.tenant, { session_lifetime, idle_session_lifetime } = _a, tenant = __rest(_a, ["session_lifetime", "idle_session_lifetime"]);
         (0, utils_1.clearTenantFlags)(tenant);
+        const sessionDurations = (0, sessionDurationsToMinutes_1.sessionDurationsToMinutes)({ session_lifetime, idle_session_lifetime });
         return {
-            tenant: Object.assign(tenant, session_lifetime && (0, utils_1.hoursAsInteger)('session_lifetime', session_lifetime), idle_session_lifetime && (0, utils_1.hoursAsInteger)('idle_session_lifetime', idle_session_lifetime))
+            tenant: Object.assign(Object.assign({}, tenant), sessionDurations),
         };
-        /* eslint-enable camelcase */
     });
 }
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        const tenant = Object.assign({}, context.assets.tenant || {});
+        const tenant = Object.assign({}, (context.assets.tenant || {}));
         (0, utils_1.clearTenantFlags)(tenant);
         return { tenant };
     });
 }
-exports.default = {
+const tenantHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = tenantHandler;

package/lib/context/yaml/handlers/triggers.js

@@ -15,7 +15,7 @@ function parse(context) {
         if (!context.assets.triggers)
             return {};
         return {
-            triggers: context.assets.triggers
+            triggers: context.assets.triggers,
         };
     });
 }
@@ -26,11 +26,12 @@ function dump(context) {
         if (!triggers)
             return {};
         return {
-            triggers: triggers
+            triggers: triggers,
         };
     });
 }
-exports.default = {
+const triggersHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = triggersHandler;

package/lib/context/yaml/index.js

@@ -20,27 +20,29 @@ const logger_1 = __importDefault(require("../../logger"));
 const utils_1 = require("../../utils");
 const handlers_1 = __importDefault(require("./handlers"));
 const readonly_1 = __importDefault(require("../../readonly"));
-class default_1 {
+class YAMLContext {
     constructor(config, mgmtClient) {
         this.configFile = config.AUTH0_INPUT_FILE;
         this.config = config;
-        this.mappings = config.AUTH0_KEYWORD_REPLACE_MAPPINGS;
+        this.mappings = config.AUTH0_KEYWORD_REPLACE_MAPPINGS || {};
         this.mgmtClient = mgmtClient;
+        //@ts-ignore because the assets property gets filled out throughout
+        this.assets = {};
         // Get excluded rules
-        this.assets = {
-            exclude: {
-                rules: config.AUTH0_EXCLUDED_RULES || [],
-                clients: config.AUTH0_EXCLUDED_CLIENTS || [],
-                databases: config.AUTH0_EXCLUDED_DATABASES || [],
-                connections: config.AUTH0_EXCLUDED_CONNECTIONS || [],
-                resourceServers: config.AUTH0_EXCLUDED_RESOURCE_SERVERS || [],
-                defaults: config.AUTH0_EXCLUDED_DEFAULTS || []
-            }
+        this.assets.exclude = {
+            rules: config.AUTH0_EXCLUDED_RULES || [],
+            clients: config.AUTH0_EXCLUDED_CLIENTS || [],
+            databases: config.AUTH0_EXCLUDED_DATABASES || [],
+            connections: config.AUTH0_EXCLUDED_CONNECTIONS || [],
+            resourceServers: config.AUTH0_EXCLUDED_RESOURCE_SERVERS || [],
+            defaults: config.AUTH0_EXCLUDED_DEFAULTS || [],
         };
-        this.basePath = config.AUTH0_BASE_PATH;
-        if (!this.basePath) {
-            this.basePath = (typeof configFile === 'object') ? process.cwd() : path_1.default.dirname(this.configFile);
-        }
+        this.basePath = (() => {
+            if (!!config.AUTH0_BASE_PATH)
+                return config.AUTH0_BASE_PATH;
+            //@ts-ignore because this looks to be a bug, but do not want to introduce regression; more investigation needed
+            return typeof configFile === 'object' ? process.cwd() : path_1.default.dirname(this.configFile);
+        })();
     }
     loadFile(f) {
         let toLoad = path_1.default.join(this.basePath, f);
@@ -69,13 +71,12 @@ class default_1 {
             }
             // Run initial schema check to ensure valid YAML
             const auth0 = new tools_1.Auth0(this.mgmtClient, this.assets, (0, utils_1.toConfigFn)(this.config));
-            yield auth0.validate('validate');
+            yield auth0.validate();
             // Allow handlers to process the assets such as loading files etc
             yield Promise.all(Object.entries(handlers_1.default).map(([name, handler]) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     const parsed = yield handler.parse(this);
-                    Object.entries(parsed)
-                        .forEach(([k, v]) => {
+                    Object.entries(parsed).forEach(([k, v]) => {
                         this.assets[k] = v;
                     });
                 }
@@ -96,17 +97,25 @@ class default_1 {
             }
             catch (err) {
                 const docUrl = 'https://auth0.com/docs/deploy/deploy-cli-tool/create-and-configure-the-deploy-cli-application#modify-deploy-cli-application-scopes';
-                const extraMessage = err.message.startsWith('Insufficient scope') ? `\nSee ${docUrl} for more information` : '';
+                const extraMessage = err.message.startsWith('Insufficient scope')
+                    ? `\nSee ${docUrl} for more information`
+                    : '';
                 throw new Error(`Problem loading tenant data from Auth0 ${err}${extraMessage}`);
             }
-            yield Promise.all(Object.entries(handlers_1.default).map(([name, handler]) => __awaiter(this, void 0, void 0, function* () {
+            yield Promise.all(Object.entries(handlers_1.default)
+                .filter(([handlerName]) => {
+                const excludedAssetTypes = this.config.AUTH0_EXCLUDED || [];
+                return !excludedAssetTypes.includes(handlerName);
+            })
+                .map(([name, handler]) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     const data = yield handler.dump(this);
                     if (data) {
                         logger_1.default.info(`Exporting ${name}`);
-                        Object.entries(data)
-                            .forEach(([k, v]) => {
-                            this.assets[k] = Array.isArray(v) ? v.map(utils_1.formatResults).sort(utils_1.recordsSorter) : (0, utils_1.formatResults)(v);
+                        Object.entries(data).forEach(([k, v]) => {
+                            this.assets[k] = Array.isArray(v)
+                                ? v.map(utils_1.formatResults).sort(utils_1.recordsSorter)
+                                : (0, utils_1.formatResults)(v);
                         });
                     }
                 }
@@ -130,4 +139,4 @@ class default_1 {
         });
     }
 }
-exports.default = default_1;
+exports.default = YAMLContext;

package/lib/index.js

@@ -15,13 +15,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const global_agent_1 = require("global-agent");
 const args_1 = require("./args");
-const commands_1 = __importDefault(require("./commands"));
 const logger_1 = __importDefault(require("./logger"));
 const tools_1 = __importDefault(require("./tools"));
+const import_1 = __importDefault(require("./commands/import"));
+const export_1 = __importDefault(require("./commands/export"));
 function run(params) {
     return __awaiter(this, void 0, void 0, function* () {
         // Run command
-        const cmd = commands_1.default[params._[0]];
+        const command = params._[0];
         const proxy = params.proxy_url;
         if (proxy) {
             const MAJOR_NODEJS_VERSION = parseInt(process.version.slice(1).split('.')[0], 10);
@@ -32,9 +33,14 @@ function run(params) {
             process.env.GLOBAL_AGENT_HTTP_PROXY = proxy;
             (0, global_agent_1.bootstrap)();
         }
-        logger_1.default.debug(`Start command ${params._[0]}`);
-        yield cmd(params);
-        logger_1.default.debug(`Finished command ${params._[0]}`);
+        logger_1.default.debug(`Start command ${command}`);
+        if (['deploy', 'import'].includes(command) && 'input_file' in params) {
+            yield (0, import_1.default)(params);
+        }
+        if (['dump', 'export'].includes(command) && 'output_folder' in params) {
+            yield (0, export_1.default)(params);
+        }
+        logger_1.default.debug(`Finished command ${command}`);
     });
 }
 // Only run if from command line
@@ -42,8 +48,6 @@ if (require.main === module) {
     // Load cli params
     const params = (0, args_1.getParams)();
     logger_1.default.debug('Starting Auth0 Deploy CLI Tool');
-    // Set log level
-    logger_1.default.transports.console.level = params.level;
     if (params.debug) {
         logger_1.default.transports.console.level = 'debug';
         // Set for tools
@@ -53,15 +57,16 @@ if (require.main === module) {
     run(params)
         .then(() => process.exit(0))
         .catch((error) => {
+        const command = params._[0];
         if (error.type || error.stage) {
-            logger_1.default.error(`Problem running command ${params._[0]} during stage ${error.stage} when processing type ${error.type}`);
+            logger_1.default.error(`Problem running command ${command} during stage ${error.stage} when processing type ${error.type}`);
         }
         else {
-            logger_1.default.error(`Problem running command ${params._[0]}`);
+            logger_1.default.error(`Problem running command ${command}`);
         }
         const msg = error.message || error.toString();
         logger_1.default.error(msg);
-        if (process.env.AUTH0_DEBUG === 'true') {
+        if (process.env.AUTH0_DEBUG === 'true' && error.stack) {
             logger_1.default.debug(error.stack);
         }
         if (typeof msg === 'string' && msg.includes('Payload validation error')) {
@@ -72,9 +77,9 @@ if (require.main === module) {
 }
 // Export commands to be used programmatically
 module.exports = {
-    deploy: commands_1.default.import,
-    dump: commands_1.default.export,
-    import: commands_1.default.import,
-    export: commands_1.default.export,
-    tools: tools_1.default
+    deploy: import_1.default,
+    dump: export_1.default,
+    import: import_1.default,
+    export: export_1.default,
+    tools: tools_1.default,
 };

package/lib/logger.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const winston_1 = __importDefault(require("winston"));
+//@ts-ignore because used version of Winston still supports emitErrs property
 winston_1.default.emitErrs = true;
 const log = new winston_1.default.Logger({
     transports: [
@@ -12,9 +13,9 @@ const log = new winston_1.default.Logger({
             level: process.env.AUTH0_LOG || 'info',
             handleExceptions: true,
             json: false,
-            colorize: true
-        })
+            colorize: true,
+        }),
     ],
-    exitOnError: false
+    exitOnError: false,
 });
 exports.default = log;

package/lib/readonly.js

@@ -6,24 +6,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const dot_prop_1 = __importDefault(require("dot-prop"));
 const lodash_1 = __importDefault(require("lodash"));
 // Filter out known read only fields during dump
-const readOnly = {
-    guardianFactors: [
-        'trial_expired'
-    ],
-    connections: [
-        'provisioning_ticket_url',
-        'realms'
-    ],
-    databases: [
-        'options.configuration'
-    ],
+const readOnlyFields = {
+    guardianFactors: ['trial_expired'],
+    connections: ['provisioning_ticket_url', 'realms'],
+    databases: ['options.configuration'],
     tenant: [
         'sandbox_version',
         'sandbox_versions_available',
         'flags.allow_changing_enable_sso',
         'flags.enable_sso',
         'flags.disable_impersonation',
-        'flags.remove_stale_idp_attributes'
+        'flags.remove_stale_idp_attributes',
     ],
     clients: [
         'client_secret',
@@ -33,11 +26,11 @@ const readOnly = {
         'tenant',
         'custom_login_page_preview',
         'config_route',
-        'owners'
-    ]
+        'owners',
+    ],
 };
 function getExcludedFields(config) {
-    const strippedFields = Object.assign({}, readOnly);
+    const strippedFields = Object.assign({}, readOnlyFields);
     let { EXCLUDED_PROPS: excluded, INCLUDED_PROPS: included } = config;
     if (typeof excluded !== 'object')
         excluded = {};
@@ -45,7 +38,7 @@ function getExcludedFields(config) {
         included = {};
     Object.entries(excluded).forEach(([name, fields]) => {
         // Do not allow same field to be included and excluded at the same time
-        const intersections = fields.filter((field) => included[name] && included[name].includes(field));
+        const intersections = fields.filter((field) => included && included[name] && included[name].includes(field));
         if (intersections.length > 0) {
             throw new Error(`EXCLUDED_PROPS should NOT have any intersections with INCLUDED_PROPS. Intersections found: ${name}: ${intersections.join(', ')}`);
         }
@@ -71,9 +64,11 @@ function cleanAssets(assets, config) {
         if (!obj)
             return;
         if (Array.isArray(obj)) {
+            //@ts-ignore because `message_types` and `policies` on guardianPhoneFactorMessageTypes and guardianPolicies don't adhere to the expect types
             cleaned[name] = obj.map((o) => deleteKeys(o, fields));
         }
         else {
+            //@ts-ignore because `message_types` and `policies` on guardianPhoneFactorMessageTypes and guardianPolicies don't adhere to the expect types
             cleaned[name] = deleteKeys(cleaned[name], fields);
         }
     });