auth0-deploy-cli 7.14.2 → 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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.14.2",
+  "version": "7.14.3",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -16,7 +16,7 @@
     "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"
   },
@@ -32,10 +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/nock": "^11.1.0",
-    "@types/winston": "^2.4.4",
     "ajv": "^6.12.6",
     "auth0": "^2.42.0",
     "dot-prop": "^5.2.0",
@@ -47,19 +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",
-    "ts-node": "^10.9.1",
     "winston": "^3.7.2",
     "yargs": "^15.3.1"
   },
   "devDependencies": {
-    "@types/expect": "^24.3.0",
+    "@types/lodash": "^4.14.182",
     "@types/mocha": "^9.1.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",
@@ -73,6 +66,8 @@
     "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.4",
     "zlib": "^1.0.5"

package/.nyc_output/processinfo/1b0a2de3-0dae-4f80-9af7-f45cabfd5e99.json

@@ -1 +0,0 @@
-{"parent":"50c50e87-6b9d-4f9f-b6bb-a462368ff653","pid":719,"argv":["/home/circleci/.nvm/versions/node/v16.16.0/bin/node","/home/circleci/repo/node_modules/mocha/bin/mocha","-r","/home/circleci/repo/node_modules/ts-mocha/src/index.js","--recursive","test/**/*.test*","--exclude","test/e2e/*","--timeout","5000"],"execArgv":[],"cwd":"/home/circleci/repo","time":1659374822700,"ppid":712,"coverageFilename":"/home/circleci/repo/.nyc_output/1b0a2de3-0dae-4f80-9af7-f45cabfd5e99.json","externalId":"","uuid":"1b0a2de3-0dae-4f80-9af7-f45cabfd5e99","files":["/home/circleci/repo/src/logger.ts","/home/circleci/repo/src/context/index.ts","/home/circleci/repo/src/context/yaml/index.ts","/home/circleci/repo/src/tools/index.ts","/home/circleci/repo/src/tools/constants.ts","/home/circleci/repo/src/tools/deploy.ts","/home/circleci/repo/src/tools/auth0/index.ts","/home/circleci/repo/src/tools/auth0/client.ts","/home/circleci/repo/src/tools/utils.ts","/home/circleci/repo/src/tools/auth0/schema.ts","/home/circleci/repo/src/tools/auth0/handlers/index.ts","/home/circleci/repo/src/tools/auth0/handlers/rules.ts","/home/circleci/repo/src/tools/validationError.ts","/home/circleci/repo/src/tools/auth0/handlers/default.ts","/home/circleci/repo/src/tools/calculateChanges.ts","/home/circleci/repo/src/tools/auth0/handlers/rulesConfigs.ts","/home/circleci/repo/src/tools/auth0/handlers/hooks.ts","/home/circleci/repo/src/tools/auth0/handlers/pages.ts","/home/circleci/repo/src/tools/auth0/handlers/resourceServers.ts","/home/circleci/repo/src/tools/auth0/handlers/databases.ts","/home/circleci/repo/src/tools/auth0/handlers/connections.ts","/home/circleci/repo/src/tools/auth0/handlers/clients.ts","/home/circleci/repo/src/tools/auth0/handlers/tenant.ts","/home/circleci/repo/src/tools/auth0/handlers/emailProvider.ts","/home/circleci/repo/src/tools/auth0/handlers/emailTemplates.ts","/home/circleci/repo/src/tools/auth0/handlers/clientGrants.ts","/home/circleci/repo/src/tools/auth0/handlers/guardianFactors.ts","/home/circleci/repo/src/tools/auth0/handlers/guardianFactorProviders.ts","/home/circleci/repo/src/tools/auth0/handlers/guardianFactorTemplates.ts","/home/circleci/repo/src/tools/auth0/handlers/guardianPolicies.ts","/home/circleci/repo/src/tools/auth0/handlers/guardianPhoneFactorSelectedProvider.ts","/home/circleci/repo/src/tools/auth0/handlers/guardianPhoneFactorMessageTypes.ts","/home/circleci/repo/src/tools/auth0/handlers/roles.ts","/home/circleci/repo/src/tools/auth0/handlers/branding.ts","/home/circleci/repo/src/tools/auth0/handlers/prompts.ts","/home/circleci/repo/src/types.ts","/home/circleci/repo/src/tools/auth0/handlers/migrations.ts","/home/circleci/repo/src/tools/auth0/handlers/actions.ts","/home/circleci/repo/src/tools/auth0/handlers/triggers.ts","/home/circleci/repo/src/tools/auth0/handlers/organizations.ts","/home/circleci/repo/src/tools/auth0/handlers/attackProtection.ts","/home/circleci/repo/src/tools/auth0/handlers/logStreams.ts","/home/circleci/repo/src/tools/auth0/handlers/customDomains.ts","/home/circleci/repo/src/tools/auth0/handlers/themes.ts","/home/circleci/repo/src/utils.ts","/home/circleci/repo/src/context/yaml/handlers/index.ts","/home/circleci/repo/src/context/yaml/handlers/pages.ts","/home/circleci/repo/src/context/yaml/handlers/rules.ts","/home/circleci/repo/src/context/yaml/handlers/hooks.ts","/home/circleci/repo/src/context/yaml/handlers/clients.ts","/home/circleci/repo/src/context/yaml/handlers/tenant.ts","/home/circleci/repo/src/sessionDurationsToMinutes.ts","/home/circleci/repo/src/context/yaml/handlers/emailProvider.ts","/home/circleci/repo/src/context/defaults.ts","/home/circleci/repo/src/context/yaml/handlers/connections.ts","/home/circleci/repo/src/context/yaml/handlers/databases.ts","/home/circleci/repo/src/context/yaml/handlers/emailTemplates.ts","/home/circleci/repo/src/context/yaml/handlers/clientGrants.ts","/home/circleci/repo/src/context/yaml/handlers/rulesConfigs.ts","/home/circleci/repo/src/context/yaml/handlers/resourceServers.ts","/home/circleci/repo/src/context/yaml/handlers/guardianFactors.ts","/home/circleci/repo/src/context/yaml/handlers/guardianFactorProviders.ts","/home/circleci/repo/src/context/yaml/handlers/guardianFactorTemplates.ts","/home/circleci/repo/src/context/yaml/handlers/guardianPhoneFactorMessageTypes.ts","/home/circleci/repo/src/context/yaml/handlers/guardianPhoneFactorSelectedProvider.ts","/home/circleci/repo/src/context/yaml/handlers/guardianPolicies.ts","/home/circleci/repo/src/context/yaml/handlers/roles.ts","/home/circleci/repo/src/context/yaml/handlers/organizations.ts","/home/circleci/repo/src/context/yaml/handlers/migrations.ts","/home/circleci/repo/src/context/yaml/handlers/actions.ts","/home/circleci/repo/src/context/yaml/handlers/triggers.ts","/home/circleci/repo/src/context/yaml/handlers/attackProtection.ts","/home/circleci/repo/src/context/yaml/handlers/branding.ts","/home/circleci/repo/src/context/yaml/handlers/logStreams.ts","/home/circleci/repo/src/context/yaml/handlers/prompts.ts","/home/circleci/repo/src/context/yaml/handlers/customDomains.ts","/home/circleci/repo/src/context/yaml/handlers/themes.ts","/home/circleci/repo/src/readonly.ts","/home/circleci/repo/src/context/directory/index.ts","/home/circleci/repo/src/context/directory/handlers/index.ts","/home/circleci/repo/src/context/directory/handlers/pages.ts","/home/circleci/repo/src/context/directory/handlers/rules.ts","/home/circleci/repo/src/context/directory/handlers/hooks.ts","/home/circleci/repo/src/context/directory/handlers/clients.ts","/home/circleci/repo/src/context/directory/handlers/tenant.ts","/home/circleci/repo/src/context/directory/handlers/emailProvider.ts","/home/circleci/repo/src/context/directory/handlers/connections.ts","/home/circleci/repo/src/context/directory/handlers/databases.ts","/home/circleci/repo/src/context/directory/handlers/emailTemplates.ts","/home/circleci/repo/src/context/directory/handlers/clientGrants.ts","/home/circleci/repo/src/context/directory/handlers/rulesConfigs.ts","/home/circleci/repo/src/context/directory/handlers/resourceServers.ts","/home/circleci/repo/src/context/directory/handlers/guardianFactors.ts","/home/circleci/repo/src/context/directory/handlers/guardianFactorProviders.ts","/home/circleci/repo/src/context/directory/handlers/guardianFactorTemplates.ts","/home/circleci/repo/src/context/directory/handlers/guardianPhoneFactorMessageTypes.ts","/home/circleci/repo/src/context/directory/handlers/guardianPhoneFactorSelectedProvider.ts","/home/circleci/repo/src/context/directory/handlers/guardianPolicies.ts","/home/circleci/repo/src/context/directory/handlers/roles.ts","/home/circleci/repo/src/context/directory/handlers/migrations.ts","/home/circleci/repo/src/context/directory/handlers/actions.ts","/home/circleci/repo/src/context/directory/handlers/organizations.ts","/home/circleci/repo/src/context/directory/handlers/triggers.ts","/home/circleci/repo/src/context/directory/handlers/attackProtection.ts","/home/circleci/repo/src/context/directory/handlers/branding.ts","/home/circleci/repo/src/context/directory/handlers/logStreams.ts","/home/circleci/repo/src/context/directory/handlers/prompts.ts","/home/circleci/repo/src/context/directory/handlers/customDomains.ts","/home/circleci/repo/src/context/directory/handlers/themes.ts","/home/circleci/repo/src/index.ts","/home/circleci/repo/src/args.ts","/home/circleci/repo/src/commands/import.ts","/home/circleci/repo/src/configFactory.ts","/home/circleci/repo/src/commands/export.ts"]}

package/.nyc_output/processinfo/50c50e87-6b9d-4f9f-b6bb-a462368ff653.json

@@ -1 +0,0 @@
-{"parent":"cd0c5bb1-9480-4de3-b099-e95349d10f89","pid":712,"argv":["/home/circleci/.nvm/versions/node/v16.16.0/bin/node","/home/circleci/repo/node_modules/.bin/ts-mocha","-p","tsconfig.json","--recursive","test/**/*.test*","--exclude","test/e2e/*","--timeout","5000"],"execArgv":[],"cwd":"/home/circleci/repo","time":1659374822594,"ppid":711,"coverageFilename":"/home/circleci/repo/.nyc_output/50c50e87-6b9d-4f9f-b6bb-a462368ff653.json","externalId":"","uuid":"50c50e87-6b9d-4f9f-b6bb-a462368ff653","files":[]}

package/.nyc_output/processinfo/cd0c5bb1-9480-4de3-b099-e95349d10f89.json

@@ -1 +0,0 @@
-{"parent":null,"pid":700,"argv":["/home/circleci/.nvm/versions/node/v16.16.0/bin/node","/home/circleci/.nvm/versions/node/v16.16.0/bin/npm","run","test"],"execArgv":[],"cwd":"/home/circleci/repo","time":1659374822249,"ppid":689,"coverageFilename":"/home/circleci/repo/.nyc_output/cd0c5bb1-9480-4de3-b099-e95349d10f89.json","externalId":"","uuid":"cd0c5bb1-9480-4de3-b099-e95349d10f89","files":[]}