auth0-deploy-cli 7.14.0 → 7.14.3

package/docs/configuring-the-deploy-cli.md

@@ -25,7 +25,7 @@ Example **config.json** file:
 
 By default, the Deploy CLI ingests environment variables, providing the ability to pass credentials and other configurations to the tool without needing to publish to the `config.json` file. Environment variables can either be used to augment the `config.json` file or replace it altogether depending on the project needs.
 
-Non-primitive configuration values like `AUTH0_KEYWORD_MAPPING` and `AUTH0_EXCLUDED` can also be passed in through environment variables so long as these values are properly serialized JSON.
+Non-primitive configuration values like `AUTH0_KEYWORD_REPLACE_MAPPINGS` and `AUTH0_EXCLUDED` can also be passed in through environment variables so long as these values are properly serialized JSON.
 
 To **disable** the consumption of environment variables for either the `import` or `export` commands, pass the `--env=false` argument.
 
@@ -34,8 +34,8 @@ To **disable** the consumption of environment variables for either the `import`
 ```shell
 # Deploying configuration for YAML formats without a config.json file
 export AUTH0_DOMAIN=<YOUR_AUTH0_DOMAIN>
-export AUTH0_CLIENT_ID=<YOUR_CLIENT_ID> 
-export AUTH0_CLIENT_SECRET=<YOUR_CLIENT_SECRET> 
+export AUTH0_CLIENT_ID=<YOUR_CLIENT_ID>
+export AUTH0_CLIENT_SECRET=<YOUR_CLIENT_SECRET>
 
 a0deploy import --input_file=local/tenant.yaml
 

package/docs/keyword-replacement.md

@@ -36,6 +36,28 @@ clients:
     allowed_logout_urls: @@ALLOWED_LOGOUTS@@
 ```
 
+## Array Concatenation
+
+You may encounter situations where you would want to concatenate values onto a static array through keyword replacement. There is no special syntax to support this case, however, it is possible to achieve this by escaping double quotes in a single string that contains the appropriate values and injecting with the `##` keyword syntax. This technique works for both the [YAML and directory formats](./available-resource-config-formats.md).
+
+### Example `config.json`
+
+```json
+{
+  "AUTH0_KEYWORD_REPLACE_MAPPINGS": {
+    "GLOBAL_WEB_ORIGINS": "\"http://local.me:8080\", \"http://localhost\", \"http://localhost:3000\""
+  }
+}
+```
+
+### Example `tenant.yaml`
+
+```yaml
+clients:
+  - name: Test App
+    web_origins: [ "http://production-app.com", "https://production-app.com", ##GLOBAL_WEB_ORIGINS## ]
+```
+
 ## Uni-directional Limitation
 
 Currently, the Deploy CLI only preserves keywords during import. Once added, keywords are overwritten with subsequent exports. For this reason, it is recommended that if a workflow heavily depends on keyword replacement, to only perform imports in perpetuity. This limitation is noted in [this Github issue](https://github.com/auth0/auth0-deploy-cli/issues/328).

package/examples/yaml/config.json.example

@@ -1,5 +1,5 @@
 {
-  "AUTH0_DOMAIN": "<YOUR_TENANT>.auth0.com",
+  "AUTH0_DOMAIN": "<YOUR_TENANT>.<YOUR_REGION>.auth0.com", 
   "AUTH0_CLIENT_ID": "<client_id>",
   "AUTH0_CLIENT_SECRET": "<client_secret>",
   "AUTH0_KEYWORD_REPLACE_MAPPINGS": {

package/lib/commands/import.d.ts

@@ -1,4 +1,2 @@
 import { ImportParams } from '../args';
-import { Assets } from '../types';
 export default function importCMD(params: ImportParams): Promise<void>;
-export declare const findUnreplacedKeywords: (assets: Assets) => void;

package/lib/commands/import.js

@@ -12,7 +12,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findUnreplacedKeywords = void 0;
 const nconf_1 = __importDefault(require("nconf"));
 const configFactory_1 = require("../configFactory");
 const tools_1 = require("../tools");
@@ -41,43 +40,9 @@ function importCMD(params) {
         yield context.load();
         const config = (0, configFactory_1.configFactory)();
         config.setProvider((key) => nconf_1.default.get(key));
-        (0, exports.findUnreplacedKeywords)(context.assets);
+        //@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');
     });
 }
 exports.default = importCMD;
-const findUnreplacedKeywords = (assets) => {
-    const recursiveFindUnreplacedKeywords = (target) => {
-        let unreplaced = [];
-        if (target === undefined || target === null)
-            return [];
-        if (Array.isArray(target)) {
-            target.forEach((child) => {
-                unreplaced.push(...recursiveFindUnreplacedKeywords(child));
-            });
-        }
-        else if (typeof target === 'object') {
-            Object.values(target).forEach((child) => {
-                unreplaced.push(...recursiveFindUnreplacedKeywords(child));
-            });
-        }
-        if (typeof target === 'string') {
-            const arrayMatches = target.match(/(?<=@@).*(?=@@)/g);
-            if (arrayMatches !== null) {
-                return arrayMatches;
-            }
-            const keywordMatches = target.match(/(?<=##).*(?=##)/g);
-            if (keywordMatches !== null) {
-                return keywordMatches;
-            }
-        }
-        return unreplaced;
-    };
-    const unreplacedKeywords = recursiveFindUnreplacedKeywords(assets);
-    if (unreplacedKeywords.length > 0) {
-        throw `Unreplaced keywords found: ${unreplacedKeywords.join(', ')}. Either correct these values or add to AUTH0_KEYWORD_REPLACE_MAPPINGS configuration.`;
-    }
-    return;
-};
-exports.findUnreplacedKeywords = findUnreplacedKeywords;

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/directory/handlers/pages.js

@@ -32,11 +32,16 @@ function parse(context) {
             acc[name].html = file;
         return acc;
     }, {});
-    const pages = Object.values(sorted).flatMap(({ meta, html }) => {
+    const pages = Object.keys(sorted).flatMap((key) => {
+        const { meta, html } = sorted[key];
         if (!meta) {
             logger_1.default.warn(`Skipping pages file ${html} as missing the corresponding '.json' file`);
             return [];
         }
+        if (!html && ['error_page', 'login'].includes(key)) {
+            //Error pages don't require an HTML template, it is valid to redirect errors to URL
+            return Object.assign(Object.assign({}, (0, utils_1.loadJSON)(meta, context.mappings)), { html: '' });
+        }
         if (!html) {
             logger_1.default.warn(`Skipping pages file ${meta} as missing corresponding '.html' file`);
             return [];
@@ -61,7 +66,7 @@ function dump(context) {
                 // Dump template 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);
                 metadata.html = `./${page.name}.html`;
             }
             // Dump page metadata

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

@@ -70,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>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.14.0",
+  "version": "7.14.3",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -10,11 +10,13 @@
     "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",
+    "prepublishOnly": "npm run build",
     "preversion": "kacl prerelease",
     "version": "kacl release && git add CHANGELOG.md"
   },
@@ -30,9 +32,6 @@
   "readme": "README.md",
   "homepage": "https://github.com/auth0/auth0-deploy-cli#readme",
   "dependencies": {
-    "@types/lodash": "^4.14.181",
-    "@types/nconf": "^0.10.2",
-    "@types/winston": "^2.4.4",
     "ajv": "^6.12.6",
     "auth0": "^2.42.0",
     "dot-prop": "^5.2.0",
@@ -44,18 +43,16 @@
     "nconf": "^0.12.0",
     "promise-pool-executor": "^1.1.1",
     "sanitize-filename": "^1.6.1",
-    "sinon": "^13.0.1",
-    "sinon-chai": "^3.7.0",
     "winston": "^3.7.2",
     "yargs": "^15.3.1"
   },
   "devDependencies": {
-    "@types/expect": "^24.3.0",
+    "@types/lodash": "^4.14.182",
     "@types/mocha": "^9.1.0",
-    "@typescript-eslint/parser": "^5.27.0",
+    "@types/nconf": "^0.10.3",
+    "@typescript-eslint/parser": "^5.30.3",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
-    "cross-env": "^3.1.4",
     "eslint": "^7.28.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-config-prettier": "^8.5.0",
@@ -63,13 +60,17 @@
     "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",
+    "sinon": "^13.0.2",
+    "sinon-chai": "^3.7.0",
     "ts-mocha": "^9.0.2",
-    "typescript": "^4.7.3"
+    "typescript": "^4.7.4",
+    "zlib": "^1.0.5"
   },
   "overrides": {
     "istanbul-reports": "3.1.4"