auth0-deploy-cli 7.5.2 → 7.6.0

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

@@ -0,0 +1,65 @@
+"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");
+function parse(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Load the HTML file for each page
+        const { branding } = context.assets;
+        if (!branding || !branding.templates)
+            return { branding };
+        const templates = branding.templates.map((templateDefinition) => {
+            const markupFile = path_1.default.join(templateDefinition.body);
+            return {
+                template: templateDefinition.template,
+                body: (0, tools_1.loadFileAndReplaceKeywords)(markupFile, context.mappings)
+            };
+        });
+        return {
+            branding: Object.assign(Object.assign({}, branding), { templates })
+        };
+    });
+}
+function dump(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { branding } = context.assets || { branding: undefined };
+        branding.templates = branding.templates || [];
+        // create templates folder
+        if (branding.templates.length) {
+            const brandingTemplatesFolder = path_1.default.join(context.basePath, tools_1.constants.BRANDING_TEMPLATES_YAML_DIRECTORY);
+            fs_extra_1.default.ensureDirSync(brandingTemplatesFolder);
+            branding.templates = branding.templates.map((templateDefinition) => {
+                const file = `${templateDefinition.template}.html`;
+                const templateMarkupFile = path_1.default.join(brandingTemplatesFolder, file);
+                const markup = templateDefinition.body;
+                try {
+                    fs_extra_1.default.writeFileSync(templateMarkupFile, 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}${path_1.default.join(tools_1.constants.BRANDING_TEMPLATES_YAML_DIRECTORY, file)}`;
+                return templateDefinition;
+            });
+        }
+        return { branding };
+    });
+}
+exports.default = {
+    parse,
+    dump
+};

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -9,15 +9,7 @@ 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 {
-            guardianFactorProviders: [...context.assets.guardianFactorProviders || []]
-        };
-    });
-}
-function dump(context) {
+function parseAndDump(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // nothing to do, set default empty
         return {
@@ -25,7 +17,8 @@ function dump(context) {
         };
     });
 }
-exports.default = {
-    parse,
-    dump
+const guardianFactorProvidersHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
 };
+exports.default = guardianFactorProvidersHandler;

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

@@ -9,7 +9,7 @@ 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 {
@@ -17,15 +17,8 @@ function parse(context) {
         };
     });
 }
-function dump(context) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // nothing to do, set default empty
-        return {
-            guardianFactorTemplates: [...context.assets.guardianFactorTemplates || []]
-        };
-    });
-}
-exports.default = {
-    parse,
-    dump
+const guardianFactorTemplatesHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
 };
+exports.default = guardianFactorTemplatesHandler;

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

@@ -9,7 +9,7 @@ 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 {
@@ -17,15 +17,8 @@ function parse(context) {
         };
     });
 }
-function dump(context) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // nothing to do, set default empty
-        return {
-            guardianFactors: [...context.assets.guardianFactors || []]
-        };
-    });
-}
-exports.default = {
-    parse,
-    dump
+const guardianFactorsHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
 };
+exports.default = guardianFactorsHandler;

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

@@ -9,7 +9,7 @@ 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 {
@@ -17,15 +17,8 @@ function parse(context) {
         };
     });
 }
-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,15 +9,7 @@ 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 {
@@ -25,7 +17,8 @@ function dump(context) {
         };
     });
 }
-exports.default = {
-    parse,
-    dump
+const guardianPhoneFactorSelectedProviderHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
 };
+exports.default = guardianPhoneFactorSelectedProviderHandler;

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

@@ -9,7 +9,7 @@ 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 {
@@ -17,15 +17,8 @@ function parse(context) {
         };
     });
 }
-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

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

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

@@ -27,6 +27,7 @@ const migrations_1 = __importDefault(require("./migrations"));
 const actions_1 = __importDefault(require("./actions"));
 const triggers_1 = __importDefault(require("./triggers"));
 const attackProtection_1 = __importDefault(require("./attackProtection"));
+const branding_1 = __importDefault(require("./branding"));
 exports.default = {
     rules: rules_1.default,
     hooks: hooks_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/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

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

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

@@ -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

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

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

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

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

@@ -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

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

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

@@ -42,7 +42,8 @@ function dump(context) {
         return { tenant };
     });
 }
-exports.default = {
+const tenantHandler = {
     parse,
-    dump
+    dump,
 };
+exports.default = tenantHandler;

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

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

package/lib/context/yaml/index.js

@@ -39,6 +39,7 @@ class default_1 {
         };
         this.basePath = config.AUTH0_BASE_PATH;
         if (!this.basePath) {
+            //@ts-ignore because this looks to be a bug, but do not want to introduce regression; more investigation needed
             this.basePath = (typeof configFile === 'object') ? process.cwd() : path_1.default.dirname(this.configFile);
         }
     }
@@ -69,7 +70,7 @@ 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 {

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

@@ -14,25 +14,59 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = void 0;
 const default_1 = __importDefault(require("./default"));
-exports.schema = { type: 'object' };
+const constants_1 = __importDefault(require("../../constants"));
+const logger_1 = __importDefault(require("../../../logger"));
+exports.schema = {
+    type: 'object',
+    properties: {
+        templates: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    template: { type: 'string' },
+                    body: { type: 'string' }
+                }
+            }
+        }
+    }
+};
 class BrandingHandler extends default_1.default {
     constructor(options) {
         super(Object.assign(Object.assign({}, options), { type: 'branding' }));
     }
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
-            // in case client version does not support branding
-            if (!this.client.branding || typeof this.client.branding.getSettings !== 'function') {
-                return {};
-            }
+            let branding = {};
             try {
-                return yield this.client.branding.getSettings();
+                // in case client version does not support branding
+                if (this.client.branding && typeof this.client.branding.getSettings === 'function') {
+                    branding = yield this.client.branding.getSettings();
+                }
+                // in case client version does not custom domains
+                if (this.client.customDomains && typeof this.client.customDomains.getAll === 'function') {
+                    const customDomains = yield this.client.customDomains.getAll();
+                    // templates are only supported if there's custom domains.
+                    if (customDomains && customDomains.length) {
+                        const payload = yield this.client.branding.getUniversalLoginTemplate();
+                        branding.templates = [
+                            {
+                                template: constants_1.default.UNIVERSAL_LOGIN_TEMPLATE,
+                                body: payload.body
+                            }
+                        ];
+                    }
+                }
+                return branding;
             }
             catch (err) {
+                logger_1.default.debug(`Error calling branding API, ${err.message}, status code: ${err.statusCode}`);
+                if (err.statusCode === 403)
+                    return branding;
                 if (err.statusCode === 404)
-                    return {};
+                    return branding;
                 if (err.statusCode === 501)
-                    return {};
+                    return branding;
                 throw err;
             }
         });
@@ -40,12 +74,32 @@ class BrandingHandler extends default_1.default {
     processChanges(assets) {
         return __awaiter(this, void 0, void 0, function* () {
             const { branding } = assets;
-            // Do nothing if not set
-            if (!branding || !Object.keys(branding).length)
+            // quit early if there's no branding to process.
+            if (!branding)
                 return;
-            yield this.client.branding.updateSettings({}, branding);
-            this.updated += 1;
-            this.didUpdate(branding);
+            // remove templates, we only want top level branding settings for this API call
+            const brandingSettings = Object.assign({}, branding);
+            delete brandingSettings.templates;
+            // Do nothing if not set
+            if (brandingSettings && Object.keys(brandingSettings).length) {
+                yield this.client.branding.updateSettings({}, brandingSettings);
+                this.updated += 1;
+                this.didUpdate(brandingSettings);
+            }
+            // handle templates
+            if (branding.templates && branding.templates.length) {
+                const unknownTemplates = branding.templates.filter((t) => !constants_1.default.SUPPORTED_BRANDING_TEMPLATES.includes(t.template)).map((t) => t.template);
+                if (unknownTemplates.length) {
+                    // throw a helpful warning for unknown templates, the context handlers are unaware of which are supported, that's all handled here.
+                    logger_1.default.warn(`Found unknown branding template(s): ${unknownTemplates.join().toString()}. Supported branding templates are: ${constants_1.default.SUPPORTED_BRANDING_TEMPLATES.join()}.`);
+                }
+                const templateDefinition = branding.templates.find((t) => t.template === constants_1.default.UNIVERSAL_LOGIN_TEMPLATE);
+                if (templateDefinition && templateDefinition.body) {
+                    yield this.client.branding.setUniversalLoginTemplate({}, { template: templateDefinition.body });
+                    this.updated += 1;
+                    this.didUpdate(branding.templates);
+                }
+            }
         });
     }
 }

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

@@ -16,6 +16,7 @@ exports.order = void 0;
 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
@@ -82,7 +83,12 @@ class DefaultHandler {
                 return {};
             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,
+                existing,
+                identifiers: this.identifiers
+            });
         });
     }
     validate(assets) {

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

@@ -44,7 +44,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 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',
@@ -208,7 +208,12 @@ class OrganizationsHandler extends default_1.default {
                     return Object.assign(Object.assign({}, connection), { connection_id: (existingConnections.find((c) => c.name === name) || {}).id });
                 }).filter((connection) => !!connection.connection_id);
             });
-            const changes = (0, utils_1.calcChanges)(this, organizations, existing, ['id', 'name']);
+            const changes = (0, calculateChanges_1.calculateChanges)({
+                handler: this,
+                assets: organizations,
+                existing,
+                identifiers: ['id', 'name']
+            });
             logger_1.default.debug(`Start processChanges for organizations [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/resourceServers.js

@@ -16,7 +16,7 @@ exports.schema = exports.excludeSchema = void 0;
 const ValidationError_1 = __importDefault(require("../../ValidationError"));
 const constants_1 = __importDefault(require("../../constants"));
 const default_1 = __importDefault(require("./default"));
-const utils_1 = require("../../utils");
+const calculateChanges_1 = require("../../calculateChanges");
 exports.excludeSchema = {
     type: 'array',
     items: { type: 'string' }
@@ -71,7 +71,12 @@ class ResourceServersHandler extends default_1.default {
             // Filter excluded
             resourceServers = resourceServers.filter((r) => !excluded.includes(r.name));
             existing = existing.filter((r) => !excluded.includes(r.name));
-            return (0, utils_1.calcChanges)(this, resourceServers, existing, ['id', 'identifier']);
+            return (0, calculateChanges_1.calculateChanges)({
+                handler: this,
+                assets: resourceServers,
+                existing,
+                identifiers: ['id', 'identifier']
+            });
         });
     }
     validate(assets) {