auth0-deploy-cli 7.13.1 → 7.14.2

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

@@ -29,9 +29,10 @@ function parse(context) {
         if (connection.strategy === 'email') {
             (0, utils_1.ensureProp)(connection, 'options.email.body');
             const htmlFileName = path_1.default.join(connectionsFolder, connection.options.email.body);
-            if ((0, utils_1.isFile)(htmlFileName)) {
-                connection.options.email.body = (0, tools_1.loadFileAndReplaceKeywords)(htmlFileName, context.mappings);
+            if (!(0, utils_1.isFile)(htmlFileName)) {
+                throw new Error(`Passwordless email template purportedly located at ${htmlFileName} does not exist for connection. Ensure the existence of this file to proceed with deployment.`);
             }
+            connection.options.email.body = (0, tools_1.loadFileAndReplaceKeywords)(htmlFileName, context.mappings);
         }
         return connection;
     })

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

@@ -30,9 +30,12 @@ function parse(context) {
                     if (connection.strategy === 'email') {
                         (0, utils_1.ensureProp)(connection, 'options.email.body');
                         const htmlFileName = path_1.default.join(connectionsFolder, connection.options.email.body);
-                        if ((0, utils_1.isFile)(htmlFileName)) {
-                            connection.options.email.body = context.loadFile(htmlFileName);
+                        if (!(0, utils_1.isFile)(htmlFileName)) {
+                            const missingTemplateErrorMessage = `Passwordless email template purportedly located at ${htmlFileName} does not exist for connection. Ensure the existence of this file to proceed with deployment.`;
+                            logger_1.default.error(missingTemplateErrorMessage);
+                            throw new Error(missingTemplateErrorMessage);
                         }
+                        connection.options.email.body = context.loadFile(htmlFileName);
                     }
                     return connection;
                 }),

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

@@ -44,7 +44,7 @@ function dump(context) {
             // Dump html to file
             const htmlFile = path_1.default.join(pagesFolder, `${page.name}.html`);
             logger_1.default.info(`Writing ${htmlFile}`);
-            fs_extra_1.default.writeFileSync(htmlFile, page.html);
+            fs_extra_1.default.writeFileSync(htmlFile, page.html || '');
             return Object.assign(Object.assign({}, page), { html: `./pages/${page.name}.html` });
         });
         return { pages };

package/lib/tools/auth0/handlers/tenant.d.ts

@@ -1,11 +1,22 @@
 import DefaultHandler from './default';
-import { Asset, Assets } from '../../../types';
+import { Asset, Assets, Language } from '../../../types';
 export declare const schema: {
     type: string;
 };
+export declare type Tenant = Asset & {
+    enabled_locales: Language[];
+    flags: {
+        [key: string]: boolean;
+    };
+};
 export default class TenantHandler extends DefaultHandler {
+    existing: Tenant;
     constructor(options: DefaultHandler);
     getType(): Promise<Asset>;
     validate(assets: Assets): Promise<void>;
     processChanges(assets: Assets): Promise<void>;
 }
+export declare const sanitizeMigrationFlags: ({ existingFlags, proposedFlags, }: {
+    existingFlags: Tenant['flags'];
+    proposedFlags: Tenant['flags'];
+}) => Tenant['flags'];

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

@@ -41,7 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.schema = void 0;
+exports.sanitizeMigrationFlags = exports.schema = void 0;
 const validationError_1 = __importDefault(require("../../validationError"));
 const default_1 = __importStar(require("./default"));
 const pages_1 = require("./pages");
@@ -61,6 +61,7 @@ class TenantHandler extends default_1.default {
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
             const tenant = yield this.client.tenant.getSettings();
+            this.existing = tenant;
             blockPageKeys.forEach((key) => {
                 if (tenant[key])
                     delete tenant[key];
@@ -84,10 +85,18 @@ class TenantHandler extends default_1.default {
     processChanges(assets) {
         return __awaiter(this, void 0, void 0, function* () {
             const { tenant } = assets;
-            if (tenant && Object.keys(tenant).length > 0) {
-                yield this.client.tenant.updateSettings(tenant);
+            // Do nothing if not set
+            if (!tenant)
+                return;
+            const existingTenant = this.existing || (yield this.getType());
+            const updatedTenant = Object.assign(Object.assign({}, tenant), { flags: (0, exports.sanitizeMigrationFlags)({
+                    existingFlags: existingTenant.flags,
+                    proposedFlags: tenant.flags,
+                }) });
+            if (updatedTenant && Object.keys(updatedTenant).length > 0) {
+                yield this.client.tenant.updateSettings(updatedTenant);
                 this.updated += 1;
-                this.didUpdate(tenant);
+                this.didUpdate(updatedTenant);
             }
         });
     }
@@ -96,3 +105,29 @@ __decorate([
     (0, default_1.order)('100')
 ], TenantHandler.prototype, "processChanges", null);
 exports.default = TenantHandler;
+const sanitizeMigrationFlags = ({ existingFlags = {}, proposedFlags = {}, }) => {
+    /*
+    Tenants can only update migration flags that are already configured.
+    If moving configuration from one tenant to another, there may be instances
+    where different migration flags exist and cause an error on update. This
+    function removes any migration flags that aren't already present on the target
+    tenant. See: https://github.com/auth0/auth0-deploy-cli/issues/374
+    */
+    const tenantMigrationFlags = [
+        'disable_clickjack_protection_headers',
+        'enable_mgmt_api_v1',
+        'trust_azure_adfs_email_verified_connection_property',
+        'include_email_in_reset_pwd_redirect',
+        'include_email_in_verify_email_redirect',
+    ];
+    return Object.keys(proposedFlags).reduce((acc, proposedKey) => {
+        const isMigrationFlag = tenantMigrationFlags.includes(proposedKey);
+        if (!isMigrationFlag)
+            return Object.assign(Object.assign({}, acc), { [proposedKey]: proposedFlags[proposedKey] });
+        const keyCurrentlyExists = existingFlags[proposedKey] !== undefined;
+        if (keyCurrentlyExists)
+            return Object.assign(Object.assign({}, acc), { [proposedKey]: proposedFlags[proposedKey] });
+        return acc;
+    }, {});
+};
+exports.sanitizeMigrationFlags = sanitizeMigrationFlags;

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

@@ -66,13 +66,21 @@ class ThemesHandler extends default_1.default {
                 logger_1.default.warn('Only one theme is supported per tenant');
             }
             const currentThemes = yield this.getThemes();
+            const themeReqPayload = (() => {
+                // Removing themeId from update and create payloads, otherwise API will error
+                // Theme ID may be required to handle if `--export_ids=true`
+                const payload = themes[0];
+                //@ts-ignore to quell non-optional themeId property, but we know that it's ok to delete
+                delete payload.themeId;
+                return payload;
+            })();
             if (currentThemes === null || currentThemes.length === 0) {
-                yield this.client.branding.createTheme(themes[0]);
+                yield this.client.branding.createTheme(themeReqPayload);
             }
             else {
                 const currentTheme = currentThemes[0];
                 // if theme exists, overwrite it otherwise create it
-                yield this.client.branding.updateTheme({ id: currentTheme.themeId }, themes[0]);
+                yield this.client.branding.updateTheme({ id: currentTheme.themeId }, themeReqPayload);
             }
             this.updated += 1;
             this.didUpdate(themes[0]);
@@ -102,7 +110,7 @@ exports.default = ThemesHandler;
 exports.schema = {
     type: 'array',
     items: {
-        additionalProperties: false,
+        additionalProperties: true,
         properties: {
             borders: {
                 additionalProperties: false,

package/lib/types.d.ts

@@ -1,4 +1,5 @@
 import { PromptTypes, ScreenTypes, Prompts, PromptsCustomText, PromptSettings } from './tools/auth0/handlers/prompts';
+import { Tenant } from './tools/auth0/handlers/tenant';
 import { Theme } from './tools/auth0/handlers/themes';
 declare type SharedPaginationParams = {
     checkpoint?: boolean;
@@ -69,8 +70,8 @@ export declare type BaseAuth0APIClient = {
         getDefaultTheme: () => Promise<Theme>;
         updateTheme: (arg0: {
             id: string;
-        }, Theme: any) => Promise<Omit<Theme, 'themeId'>>;
-        createTheme: (arg0: Theme) => Promise<Omit<Theme, 'themeId'>>;
+        }, arg1: Omit<Theme, 'themeId'>) => Promise<Omit<Theme, 'themeId'>>;
+        createTheme: (arg0: Omit<Theme, 'themeId'>) => Promise<Omit<Theme, 'themeId'>>;
         deleteTheme: (arg0: {
             id: string;
         }) => Promise<void>;
@@ -173,10 +174,8 @@ export declare type BaseAuth0APIClient = {
         getAll: () => Promise<Asset[]>;
     };
     tenant: APIClientBaseFunctions & {
-        getSettings: () => Promise<Asset & {
-            enabled_locales: Language[];
-        }>;
-        updateSettings: (arg0: Asset) => Promise<void>;
+        getSettings: () => Promise<Tenant>;
+        updateSettings: (arg0: Partial<Tenant>) => Promise<Tenant>;
     };
     triggers: APIClientBaseFunctions & {
         getTriggerBindings: () => Promise<Asset>;
@@ -266,7 +265,7 @@ export declare type Assets = Partial<{
     roles: Asset[] | null;
     rules: Asset[] | null;
     rulesConfigs: Asset[] | null;
-    tenant: Asset | null;
+    tenant: Tenant | null;
     triggers: Asset[] | null;
     exclude?: {
         [key: string]: string[];

package/lib/utils.d.ts

@@ -91,7 +91,7 @@ export declare function stripIdentifiers(auth0: Auth0, assets: Assets): {
     roles?: Asset[] | null | undefined;
     rules?: Asset[] | null | undefined;
     rulesConfigs?: Asset[] | null | undefined;
-    tenant?: Asset | null | undefined;
+    tenant?: import("./tools/auth0/handlers/tenant").Tenant | null | undefined;
     triggers?: Asset[] | null | undefined;
     exclude?: {
         [key: string]: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.13.1",
+  "version": "7.14.2",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -10,8 +10,10 @@
     "lint:fix": "eslint --fix --ignore-path .eslintignore --ignore-pattern webpack . && kacl lint",
     "lint": "eslint --ignore-path .eslintignore --ignore-pattern webpack . && kacl lint",
     "format": "npx prettier --write .",
-    "pretest": "rimraf ./.nyc_output",
-    "test": "ts-mocha -p tsconfig.json --recursive 'test/**/*.test*' --timeout 5000",
+    "test": "ts-mocha -p tsconfig.json --recursive 'test/**/*.test*' --exclude 'test/e2e/*' --timeout 5000",
+    "test:e2e:node-module": "ts-mocha -p tsconfig.json --recursive 'test/e2e/*.test*' --timeout 120000",
+    "test:e2e:cli": "sh ./test/e2e/e2e-cli.sh",
+    "test:coverage": "nyc npm run test; nyc report --reporter=lcov",
     "build": "rimraf ./lib && npx tsc",
     "dev": "npx tsc --watch",
     "prepare": "npm run build",
@@ -32,6 +34,7 @@
   "dependencies": {
     "@types/lodash": "^4.14.181",
     "@types/nconf": "^0.10.2",
+    "@types/nock": "^11.1.0",
     "@types/winston": "^2.4.4",
     "ajv": "^6.12.6",
     "auth0": "^2.42.0",
@@ -46,13 +49,14 @@
     "sanitize-filename": "^1.6.1",
     "sinon": "^13.0.1",
     "sinon-chai": "^3.7.0",
+    "ts-node": "^10.9.1",
     "winston": "^3.7.2",
     "yargs": "^15.3.1"
   },
   "devDependencies": {
     "@types/expect": "^24.3.0",
     "@types/mocha": "^9.1.0",
-    "@typescript-eslint/parser": "^5.18.0",
+    "@typescript-eslint/parser": "^5.30.3",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^3.1.4",
@@ -63,13 +67,15 @@
     "husky": "^7.0.4",
     "kacl": "^1.1.1",
     "mocha": "^9.2.2",
+    "nock": "^13.2.9",
     "nyc": "^15.0.1",
     "prettier": "^2.6.2",
     "pretty-quick": "^3.1.3",
     "rimraf": "^3.0.2",
     "rmdir-sync": "^1.0.1",
     "ts-mocha": "^9.0.2",
-    "typescript": "^4.6.4"
+    "typescript": "^4.7.4",
+    "zlib": "^1.0.5"
   },
   "overrides": {
     "istanbul-reports": "3.1.4"