auth0-deploy-cli 7.5.2 → 7.6.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.6.0] - 2022-03-25
+### Added
+- New branding template feature support [#438]
+
+### Fixed
+- Colliding `e` parameter alias between `export_ids` and `env` [#453]
+
 ## [7.5.2] - 2022-03-15
 ### Fixed
 - Resetting this version to be latest on NPM
@@ -456,8 +463,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#430]: https://github.com/auth0/auth0-deploy-cli/issues/430
 [#432]: https://github.com/auth0/auth0-deploy-cli/issues/432
 [#436]: https://github.com/auth0/auth0-deploy-cli/issues/436
+[#438]: https://github.com/auth0/auth0-deploy-cli/issues/438
+[#453]: https://github.com/auth0/auth0-deploy-cli/issues/453
 
-[Unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.5.2...HEAD
+[Unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.6.0...HEAD
+[7.6.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.5.2...v7.6.0
 [7.5.2]: https://github.com/auth0/auth0-deploy-cli/compare/v7.5.1...v7.5.2
 [7.5.1]: https://github.com/auth0/auth0-deploy-cli/compare/v7.5.0...v7.5.1
 [7.5.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.4.0...v7.5.0

package/lib/args.js

@@ -33,7 +33,6 @@ function getParams() {
             type: 'string'
         },
         env: {
-            alias: 'e',
             describe: 'Override the mappings in config with environment variables.',
             boolean: true,
             default: true
@@ -69,7 +68,6 @@ function getParams() {
             type: 'string'
         },
         env: {
-            alias: 'e',
             describe: 'Override the mappings in config with environment variables.',
             boolean: true,
             default: false

package/lib/commands/import.js

@@ -40,6 +40,7 @@ function importCMD(params) {
         yield context.load();
         const config = (0, configFactory_1.default)();
         config.setProvider((key) => nconf_1.default.get(key));
+        //@ts-ignore because context and assets still need to be typed TODO: type assets and type context
         yield (0, tools_1.deploy)(context.assets, context.mgmtClient, config);
         logger_1.default.info('Import Successful');
     });

package/lib/context/directory/handlers/actions.js

@@ -83,7 +83,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const actionsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = actionsHandler;

package/lib/context/directory/handlers/attackProtection.js

@@ -53,7 +53,8 @@ function dump(context) {
         (0, utils_1.dumpJSON)(files.suspiciousIpThrottling, attackProtection.suspiciousIpThrottling);
     });
 }
-exports.default = {
+const attackProtectionHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = attackProtectionHandler;

package/lib/context/directory/handlers/branding.js

@@ -0,0 +1,59 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const tools_1 = require("../../../tools");
+const utils_1 = require("../../../utils");
+function parse(context) {
+    const brandingTemplatesFolder = path_1.default.join(context.filePath, tools_1.constants.BRANDING_DIRECTORY, tools_1.constants.BRANDING_TEMPLATES_DIRECTORY);
+    if (!(0, utils_1.existsMustBeDir)(brandingTemplatesFolder))
+        return { branding: context.branding };
+    const templatesDefinitionFiles = (0, utils_1.getFiles)(brandingTemplatesFolder, ['.json']);
+    const templates = templatesDefinitionFiles.map((templateDefinitionFile) => {
+        const definition = (0, utils_1.loadJSON)(templateDefinitionFile, context.mappings);
+        definition.body = (0, tools_1.loadFileAndReplaceKeywords)(path_1.default.join(brandingTemplatesFolder, definition.body), context.mappings);
+        return definition;
+    }, {});
+    return {
+        branding: {
+            templates
+        }
+    };
+}
+function dump(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { branding } = context.assets;
+        if (!branding || !branding.templates || !branding.templates)
+            return; // Skip, nothing to dump
+        const brandingTemplatesFolder = path_1.default.join(context.filePath, tools_1.constants.BRANDING_DIRECTORY, tools_1.constants.BRANDING_TEMPLATES_DIRECTORY);
+        fs_extra_1.default.ensureDirSync(brandingTemplatesFolder);
+        branding.templates.forEach((templateDefinition) => {
+            const markup = templateDefinition.body;
+            try {
+                fs_extra_1.default.writeFileSync(path_1.default.join(brandingTemplatesFolder, `${templateDefinition.template}.html`), markup);
+            }
+            catch (e) {
+                throw new Error(`Error writing template file: ${templateDefinition.template}, because: ${e.message}`);
+            }
+            // save the location as relative file.
+            templateDefinition.body = `.${path_1.default.sep}${templateDefinition.template}.html`;
+            (0, utils_1.dumpJSON)(path_1.default.join(brandingTemplatesFolder, `${templateDefinition.template}.json`), templateDefinition);
+        });
+    });
+}
+exports.default = {
+    parse,
+    dump
+};

package/lib/context/directory/handlers/clientGrants.js

@@ -44,7 +44,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const clientGrantsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = clientGrantsHandler;

package/lib/context/directory/handlers/clients.js

@@ -59,7 +59,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const clientsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = clientsHandler;

package/lib/context/directory/handlers/connections.js

@@ -64,7 +64,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const connectionsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = connectionsHandler;

package/lib/context/directory/handlers/databases.js

@@ -19,22 +19,20 @@ const logger_1 = __importDefault(require("../../../logger"));
 const utils_1 = require("../../../utils");
 function getDatabase(folder, mappings) {
     const metaFile = path_1.default.join(folder, 'database.json');
-    let metaData = {};
-    // First load database.json
-    try {
-        metaData = (0, utils_1.loadJSON)(metaFile, mappings);
-    }
-    catch (err) {
-        logger_1.default.warn(`Skipping database folder ${folder} as cannot find or read ${metaFile}`);
-        return {};
-    }
+    const metaData = (() => {
+        try {
+            return (0, utils_1.loadJSON)(metaFile, mappings);
+        }
+        catch (err) {
+            logger_1.default.warn(`Skipping database folder ${folder} as cannot find or read ${metaFile}`);
+            return {};
+        }
+    })();
     if (!metaData) {
         logger_1.default.warn(`Skipping database folder ${folder} as ${metaFile} is empty`);
         return {};
     }
-    const database = Object.assign(Object.assign({}, metaData), { options: Object.assign(Object.assign({}, metaData.options), (metaData.customScripts && {
-            customScripts: metaData.customScripts
-        })) });
+    const database = Object.assign(Object.assign({}, metaData), { options: Object.assign(Object.assign({}, metaData.options), (metaData.customScripts && { customScripts: metaData.customScripts })) });
     // If any customScripts configured then load content of files
     if (database.options.customScripts) {
         Object.entries(database.options.customScripts).forEach(([name, script]) => {
@@ -43,7 +41,9 @@ function getDatabase(folder, mappings) {
                 logger_1.default.warn('Skipping invalid database configuration: ' + name);
             }
             else {
-                database.options.customScripts[name] = (0, tools_1.loadFileAndReplaceKeywords)(path_1.default.join(folder, script), mappings);
+                database.options.customScripts[name] = (0, tools_1.loadFileAndReplaceKeywords)(
+                //@ts-ignore
+                path_1.default.join(folder, script), mappings);
             }
         });
     }
@@ -72,12 +72,13 @@ function dump(context) {
         databases.forEach((database) => {
             const dbFolder = path_1.default.join(databasesFolder, (0, utils_1.sanitize)(database.name));
             fs_extra_1.default.ensureDirSync(dbFolder);
-            const sortCustomScripts = ([name1], [name2]) => {
+            const sortCustomScripts = (name1, name2) => {
                 if (name1 === name2)
                     return 0;
                 return name1 > name2 ? 1 : -1;
             };
             const formatted = Object.assign(Object.assign(Object.assign({}, database), (database.enabled_clients && { enabled_clients: (0, utils_1.mapClientID2NameSorted)(database.enabled_clients, context.assets.clientsOrig) })), { options: Object.assign(Object.assign({}, database.options), (database.options.customScripts && {
+                    //@ts-ignore
                     customScripts: Object.entries(database.options.customScripts).sort(sortCustomScripts).reduce((scripts, [name, script]) => {
                         // Dump custom script to file
                         const scriptName = (0, utils_1.sanitize)(`${name}.js`);
@@ -93,7 +94,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const databasesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = databasesHandler;

package/lib/context/directory/handlers/emailProvider.js

@@ -45,7 +45,8 @@ function dump(context) {
         (0, utils_1.dumpJSON)(emailProviderFile, emailProvider);
     });
 }
-exports.default = {
+const emailProviderHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = emailProviderHandler;

package/lib/context/directory/handlers/emailTemplates.js

@@ -32,16 +32,17 @@ function parse(context) {
         if (ext === '.html')
             sorted[name].html = file;
     });
-    const emailTemplates = [];
-    Object.values(sorted).forEach((data) => {
-        if (!data.meta) {
-            logger_1.default.warn(`Skipping email template file ${data.html} as missing the corresponding '.json' file`);
+    const emailTemplates = Object.values(sorted).flatMap(({ meta, html }) => {
+        if (!meta) {
+            logger_1.default.warn(`Skipping email template file ${html} as missing the corresponding '.json' file`);
+            return [];
         }
-        else if (!data.html) {
-            logger_1.default.warn(`Skipping email template file ${data.meta} as missing corresponding '.html' file`);
+        else if (!html) {
+            logger_1.default.warn(`Skipping email template file ${meta} as missing corresponding '.html' file`);
+            return [];
         }
         else {
-            emailTemplates.push(Object.assign(Object.assign({}, (0, utils_1.loadJSON)(data.meta, context.mappings)), { body: (0, tools_1.loadFileAndReplaceKeywords)(data.html, context.mappings) }));
+            return Object.assign(Object.assign({}, (0, utils_1.loadJSON)(meta, context.mappings)), { body: (0, tools_1.loadFileAndReplaceKeywords)(html, context.mappings) });
         }
     });
     return {
@@ -67,7 +68,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const emailTemplatesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = emailTemplatesHandler;

package/lib/context/directory/handlers/guardianFactorProviders.js

@@ -40,7 +40,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const guardianFactorProvidersHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = guardianFactorProvidersHandler;

package/lib/context/directory/handlers/guardianFactorTemplates.js

@@ -40,7 +40,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const guardianFactorTemplatesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = guardianFactorTemplatesHandler;

package/lib/context/directory/handlers/guardianFactors.js

@@ -40,7 +40,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const guardianFactorsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = guardianFactorsHandler;

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

@@ -39,7 +39,8 @@ function dump(context) {
         (0, utils_1.dumpJSON)(file, guardianPhoneFactorMessageTypes);
     });
 }
-exports.default = {
+const guardianFactorMessageTypesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = guardianFactorMessageTypesHandler;

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

@@ -39,7 +39,8 @@ function dump(context) {
         (0, utils_1.dumpJSON)(file, guardianPhoneFactorSelectedProvider);
     });
 }
-exports.default = {
+const guardianFactorSelectedProviderHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = guardianFactorSelectedProviderHandler;

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

@@ -39,7 +39,8 @@ function dump(context) {
         (0, utils_1.dumpJSON)(file, guardianPolicies);
     });
 }
-exports.default = {
+const guardianPoliciesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = guardianPoliciesHandler;

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

@@ -56,7 +56,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const hooksHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = hooksHandler;

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

@@ -27,6 +27,7 @@ const actions_1 = __importDefault(require("./actions"));
 const organizations_1 = __importDefault(require("./organizations"));
 const triggers_1 = __importDefault(require("./triggers"));
 const attackProtection_1 = __importDefault(require("./attackProtection"));
+const branding_1 = __importDefault(require("./branding"));
 exports.default = {
     rules: rules_1.default,
     rulesConfigs: rulesConfigs_1.default,
@@ -51,5 +52,6 @@ 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
 };

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

@@ -19,12 +19,11 @@ function parse(context) {
     if (!(0, utils_1.existsMustBeDir)(baseFolder))
         return {}; // Skip
     const migrationsFile = path_1.default.join(baseFolder, 'migrations.json');
-    if ((0, utils_1.isFile)(migrationsFile)) {
-        /* eslint-disable camelcase */
-        const migrations = (0, utils_1.loadJSON)(migrationsFile, context.mappings);
-        return { migrations };
-    }
-    return {};
+    if (!(0, utils_1.isFile)(migrationsFile))
+        return {};
+    /* eslint-disable camelcase */
+    const migrations = (0, utils_1.loadJSON)(migrationsFile, context.mappings);
+    return { migrations };
 }
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -35,7 +34,8 @@ function dump(context) {
         (0, utils_1.dumpJSON)(migrationsFile, migrations);
     });
 }
-exports.default = {
+const migrationsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = migrationsHandler;

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

@@ -54,7 +54,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const organizationsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = organizationsHandler;

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

@@ -22,27 +22,26 @@ function parse(context) {
     if (!(0, utils_1.existsMustBeDir)(pagesFolder))
         return { pages: undefined }; // Skip
     const files = (0, utils_1.getFiles)(pagesFolder, ['.json', '.html']);
-    const sorted = {};
-    files.forEach((file) => {
+    const sorted = files.reduce((acc, file) => {
         const { ext, name } = path_1.default.parse(file);
-        if (!sorted[name])
-            sorted[name] = {};
+        if (!acc[name])
+            acc[name] = {};
         if (ext === '.json')
-            sorted[name].meta = file;
+            acc[name].meta = file;
         if (ext === '.html')
-            sorted[name].html = file;
-    });
-    const pages = [];
-    Object.values(sorted).forEach((data) => {
-        if (!data.meta) {
-            logger_1.default.warn(`Skipping pages file ${data.html} as missing the corresponding '.json' file`);
-        }
-        else if (!data.html) {
-            logger_1.default.warn(`Skipping pages file ${data.meta} as missing corresponding '.html' file`);
+            acc[name].html = file;
+        return acc;
+    }, {});
+    const pages = Object.values(sorted).flatMap(({ meta, html }) => {
+        if (!meta) {
+            logger_1.default.warn(`Skipping pages file ${html} as missing the corresponding '.json' file`);
+            return [];
         }
-        else {
-            pages.push(Object.assign(Object.assign({}, (0, utils_1.loadJSON)(data.meta, context.mappings)), { html: (0, tools_1.loadFileAndReplaceKeywords)(data.html, context.mappings) }));
+        if (!html) {
+            logger_1.default.warn(`Skipping pages file ${meta} as missing corresponding '.html' file`);
+            return [];
         }
+        return Object.assign(Object.assign({}, (0, utils_1.loadJSON)(meta, context.mappings)), { html: (0, tools_1.loadFileAndReplaceKeywords)(html, context.mappings) });
     });
     return {
         pages
@@ -71,7 +70,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const pagesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = pagesHandler;

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

@@ -40,7 +40,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const resourceServersHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = resourceServersHandler;

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

@@ -49,7 +49,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const rolesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = rolesHandler;

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

@@ -53,7 +53,8 @@ function dump(context) {
         });
     });
 }
-exports.default = {
+const rulesHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = rulesHandler;

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

@@ -29,10 +29,11 @@ function parse(context) {
 function dump() {
     return __awaiter(this, void 0, void 0, function* () {
         // do not export rulesConfigs as its values cannot be extracted
-        return null;
+        return;
     });
 }
-exports.default = {
+const rulesConfigsHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = rulesConfigsHandler;

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

@@ -35,7 +35,7 @@ function parse(context) {
         const _a = (0, utils_1.loadJSON)(tenantFile, context.mappings), { session_lifetime, idle_session_lifetime } = _a, tenant = __rest(_a, ["session_lifetime", "idle_session_lifetime"]);
         (0, utils_1.clearTenantFlags)(tenant);
         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), { session_lifetime_in_minutes: (0, utils_1.hoursAsInteger)('session_lifetime', session_lifetime)['session_lifetime_in_minutes'], idle_session_lifetime_in_minutes: (0, utils_1.hoursAsInteger)('idle_session_lifetime', idle_session_lifetime)['idle_session_lifetime_in_minutes'] })
         };
         /* eslint-enable camelcase */
     }
@@ -49,9 +49,11 @@ function dump(context) {
         (0, utils_1.clearTenantFlags)(tenant);
         const tenantFile = path_1.default.join(context.filePath, 'tenant.json');
         (0, utils_1.dumpJSON)(tenantFile, tenant);
+        return;
     });
 }
-exports.default = {
+const tenantHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = tenantHandler;

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

@@ -38,7 +38,8 @@ function dump(context) {
         fs_extra_1.default.writeFileSync(triggerFile, JSON.stringify(triggers, null, 2));
     });
 }
-exports.default = {
+const triggersHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = triggersHandler;

package/lib/context/directory/index.js

@@ -96,6 +96,7 @@ class default_1 {
             this.assets = (0, readonly_1.default)(this.assets, this.config);
             // Copy clients to be used by handlers which require converting client_id to the name
             // Must copy as the client_id will be stripped if AUTH0_EXPORT_IDENTIFIERS is false
+            //@ts-ignore because assets haven't been typed yet TODO: type assets
             this.assets.clientsOrig = [...this.assets.clients];
             // Optionally Strip identifiers
             if (!this.config.AUTH0_EXPORT_IDENTIFIERS) {
@@ -103,10 +104,7 @@ class default_1 {
             }
             yield Promise.all(Object.entries(handlers_1.default).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}`);
-                    }
+                    yield handler.dump(this);
                 }
                 catch (err) {
                     logger_1.default.debug(err.stack);

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

@@ -58,9 +58,9 @@ function mapActionCode(basePath, action) {
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
         const { actions } = context.assets;
-        // Nothing to do
+        //@ts-ignore but need to investigate why returning void here when other handlers do not
         if (!actions)
-            return;
+            return; // Nothing to do
         return {
             actions: actions.map((action) => ({
                 name: action.name,
@@ -75,7 +75,8 @@ function dump(context) {
         };
     });
 }
-exports.default = {
+const ActionsHandler = {
     parse,
     dump
 };
+exports.default = ActionsHandler;

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

@@ -9,21 +9,15 @@ 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* () {
         return {
             attackProtection: context.assets.attackProtection || {}
         };
     });
 }
-function dump(context) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return {
-            attackProtection: context.assets.attackProtection || {}
-        };
-    });
-}
-exports.default = {
-    parse,
-    dump
+const attackProtectionHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
 };
+exports.default = attackProtectionHandler;