auth0-deploy-cli 7.12.0 → 7.12.3

package/.circleci/config.yml

@@ -47,16 +47,6 @@ jobs:
       - run:
           name: Publish package
           command: npm publish
-          
-  ts_migration_progress:
-    machine:
-      image: ubuntu-2004:202111-02
-    steps:
-      - checkout
-      - run :    
-          name: Typescript Migration Progress
-          command: sh typescript-migration-progress.sh
-
 workflows:
   version: 2
   test:
@@ -66,7 +56,7 @@ workflows:
           v: "lts"
       - test:
           name: test_current
-          v: "current"
+          v: "18.0.0"
   test_and_deploy:
     jobs:
       - test:
@@ -86,9 +76,3 @@ workflows:
               ignore: /.*/
             tags:
               only: /^v.*/
-  ts_migration:
-    jobs:
-      - ts_migration_progress:
-          filters:
-            tags:
-              ignore: /.*/

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"

package/.husky/pre-commit

@@ -6,5 +6,3 @@ npm run lint:fix
 npx pretty-quick --staged
 
 npx tsc --noEmit # Ensure that code compiles
-
-/bin/bash ./typescript-migration-progress.sh

package/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.12.3] - 2022-05-24
+
+### Fixed
+
+- Resource exclusion respected during import even if resource configuration exists [#545]
+- Environment variables ingested by default [#553]
+
+## [7.12.2] - 2022-05-17
+
+### Fixed
+
+- Properly handle all screen types within a prompt grouping [#541]
+- Gracefully ignoring custom domains if not supported by tenant [#542]
+
+## [7.12.1] - 2022-05-11
+
+### Fixed
+
+- Unable to deploy without branding settings feature [#532]
+
 ## [7.12.0] - 2022-05-10
 
 ### Added
@@ -732,7 +752,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#526]: https://github.com/auth0/auth0-deploy-cli/issues/526
 [#527]: https://github.com/auth0/auth0-deploy-cli/issues/527
 [#530]: https://github.com/auth0/auth0-deploy-cli/issues/530
-[unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.12.0...HEAD
+[#532]: https://github.com/auth0/auth0-deploy-cli/issues/532
+[#541]: https://github.com/auth0/auth0-deploy-cli/issues/541
+[#542]: https://github.com/auth0/auth0-deploy-cli/issues/542
+[#545]: https://github.com/auth0/auth0-deploy-cli/issues/545
+[#553]: https://github.com/auth0/auth0-deploy-cli/issues/553
+[unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.12.3...HEAD
+[7.12.3]: https://github.com/auth0/auth0-deploy-cli/compare/v7.12.2...v7.12.3
+[7.12.2]: https://github.com/auth0/auth0-deploy-cli/compare/v7.12.1...v7.12.2
+[7.12.1]: https://github.com/auth0/auth0-deploy-cli/compare/v7.12.0...v7.12.1
 [7.12.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.11.1...v7.12.0
 [7.11.1]: https://github.com/auth0/auth0-deploy-cli/compare/v7.11.0...v7.11.1
 [7.11.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.10.0...v7.11.0

package/README.md

@@ -19,7 +19,7 @@ Supported Auth0 Management API resources
 - [x] [Log Streams](https://auth0.com/docs/api/management/v2#!/Log_Streams/get_log_streams)
 - [ ] [Logs](https://auth0.com/docs/api/management/v2#!/Logs/get_logs)
 - [x] [Organizations](https://auth0.com/docs/api/management/v2#!/Organizations/get_organizations)
-- [ ] [Prompts](https://auth0.com/docs/api/management/v2#!/Prompts/get_prompts)
+- [x] [Prompts](https://auth0.com/docs/api/management/v2#!/Prompts/get_prompts)
 - [x] [Resource Servers (APIs)](https://auth0.com/docs/api/management/v2#!/Resource_Servers/get_resource_servers)
 - [x] [Roles](https://auth0.com/docs/api/management/v2#!/Roles)
 - [x] [Rules](https://auth0.com/docs/api/management/v2#!/Rules/get_rules)

package/lib/args.js

@@ -70,7 +70,7 @@ function getParams() {
         env: {
             describe: 'Override the mappings in config with environment variables.',
             boolean: true,
-            default: false,
+            default: true,
         },
         export_ids: {
             alias: 'e',

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

@@ -18,12 +18,18 @@ const tools_1 = require("../../../tools");
 const utils_1 = require("../../../utils");
 function parse(context) {
     const brandingDirectory = path_1.default.join(context.filePath, tools_1.constants.BRANDING_DIRECTORY);
+    const brandingFile = path_1.default.join(brandingDirectory, 'branding.json');
     if (!(0, utils_1.existsMustBeDir)(brandingDirectory))
         return { branding: null };
-    const branding = (0, utils_1.loadJSON)(path_1.default.join(brandingDirectory, 'branding.json'), context.mappings);
+    const brandingSettings = (() => {
+        if ((0, utils_1.isFile)(brandingFile)) {
+            return (0, utils_1.loadJSON)(brandingFile, context.mappings);
+        }
+        return null;
+    })();
     const brandingTemplatesFolder = path_1.default.join(brandingDirectory, tools_1.constants.BRANDING_TEMPLATES_DIRECTORY);
     if (!(0, utils_1.existsMustBeDir)(brandingTemplatesFolder))
-        return { branding: null };
+        return { branding: brandingSettings };
     const templatesDefinitionFiles = (0, utils_1.getFiles)(brandingTemplatesFolder, ['.json']);
     const templates = templatesDefinitionFiles.map((templateDefinitionFile) => {
         const definition = (0, utils_1.loadJSON)(templateDefinitionFile, context.mappings);
@@ -31,7 +37,7 @@ function parse(context) {
         return definition;
     }, {});
     return {
-        branding: Object.assign(Object.assign({}, branding), { templates }),
+        branding: Object.assign(Object.assign({}, brandingSettings), { templates }),
     };
 }
 function dump(context) {

package/lib/context/directory/index.js

@@ -73,7 +73,12 @@ class DirectoryContext {
             if ((0, utils_1.isDirectory)(this.filePath)) {
                 /* If this is a directory, look for each file in the directory */
                 logger_1.default.info(`Processing directory ${this.filePath}`);
-                Object.values(handlers_1.default).forEach((handler) => {
+                Object.entries(handlers_1.default)
+                    .filter(([handlerName]) => {
+                    const excludedAssetTypes = this.config.AUTH0_EXCLUDED || [];
+                    return !excludedAssetTypes.includes(handlerName);
+                })
+                    .forEach(([_name, handler]) => {
                     const parsed = handler.parse(this);
                     Object.entries(parsed).forEach(([k, v]) => {
                         this.assets[k] = v;

package/lib/context/yaml/index.js

@@ -69,6 +69,13 @@ class YAMLContext {
                     throw new Error(`Problem loading ${this.configFile}\n${err}`);
                 }
             }
+            const excludedAssetsFiltered = Object.keys(this.assets).reduce((acc, key) => {
+                const excludedAssetTypes = this.config.AUTH0_EXCLUDED || [];
+                if (excludedAssetTypes.includes(key))
+                    return acc;
+                return Object.assign(Object.assign({}, acc), { [key]: this.assets[key] });
+            }, {});
+            this.assets = excludedAssetsFiltered;
             // 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();

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

@@ -83,7 +83,7 @@ export declare const schema: {
 };
 export default class ActionHandler extends DefaultAPIHandler {
     existing: Asset[] | null;
-    constructor(options: any);
+    constructor(options: DefaultAPIHandler);
     createAction(action: any): Promise<Asset>;
     deleteAction(action: any): Promise<void | never[]>;
     objString(action: any): string;

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

@@ -38,6 +38,6 @@ export default class CustomDomainsHadnler extends DefaultAPIHandler {
     existing: Asset[] | null;
     constructor(config: DefaultAPIHandler);
     objString(item: Asset): string;
-    getType(): Promise<Asset>;
+    getType(): Promise<Asset | null>;
     processChanges(assets: Assets): Promise<void>;
 }

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

@@ -37,10 +37,7 @@ exports.schema = {
 class CustomDomainsHadnler extends default_1.default {
     constructor(config) {
         super(Object.assign(Object.assign({}, config), { type: 'customDomains', id: 'custom_domain_id', identifiers: ['domain'], stripCreateFields: ['status', 'primary', 'verification'], functions: {
-                //@ts-ignore
-                delete: (args) => {
-                    return this.client.customDomains.delete({ id: args.custom_domain_id });
-                },
+                delete: (args) => this.client.customDomains.delete({ id: args.custom_domain_id }),
             } }));
     }
     objString(item) {
@@ -48,12 +45,22 @@ class CustomDomainsHadnler extends default_1.default {
     }
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.existing) {
-                return this.existing;
+            try {
+                if (this.existing) {
+                    return this.existing;
+                }
+                const customDomains = yield this.client.customDomains.getAll({ paginate: false });
+                this.existing = customDomains;
+                return customDomains;
+            }
+            catch (err) {
+                if (err.statusCode === 403 &&
+                    err.message ===
+                        'The account is not allowed to perform this operation, please contact our support team') {
+                    return null;
+                }
+                throw err;
             }
-            const customDomains = yield this.client.customDomains.getAll({ paginate: false });
-            this.existing = customDomains;
-            return customDomains;
         });
     }
     processChanges(assets) {

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

@@ -1,6 +1,7 @@
 import { Asset, Assets, Auth0APIClient, CalculatedChanges } from '../../../types';
 import { ConfigFunction } from '../../../configFactory';
 export declare function order(value: any): (t: any, n: any, descriptor: any) => any;
+declare type ApiMethodOverride = string | Function;
 export default class APIHandler {
     config: ConfigFunction;
     id: string;
@@ -17,10 +18,10 @@ export default class APIHandler {
     stripCreateFields: string[];
     name?: string;
     functions: {
-        getAll: string;
-        update: string;
-        create: string;
-        delete: string;
+        getAll: ApiMethodOverride;
+        update: ApiMethodOverride;
+        create: ApiMethodOverride;
+        delete: ApiMethodOverride;
     };
     constructor(options: {
         id?: APIHandler['id'];
@@ -33,13 +34,13 @@ export default class APIHandler {
         sensitiveFieldsToObfuscate?: APIHandler['sensitiveFieldsToObfuscate'];
         stripCreateFields?: APIHandler['stripCreateFields'];
         functions: {
-            getAll?: string;
-            update?: string;
-            create?: string;
-            delete?: string;
+            getAll?: ApiMethodOverride;
+            update?: ApiMethodOverride;
+            create?: ApiMethodOverride;
+            delete?: ApiMethodOverride;
         };
     });
-    getClientFN(fn: string | Function): Function;
+    getClientFN(fn: ApiMethodOverride): Function;
     didDelete(item: Asset): void;
     didCreate(item: Asset): void;
     didUpdate(item: Asset): void;
@@ -52,3 +53,4 @@ export default class APIHandler {
     validate(assets: Assets): Promise<void>;
     processChanges(assets: Assets, changes: CalculatedChanges): Promise<void>;
 }
+export {};

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

@@ -1,6 +1,9 @@
 import DefaultHandler from './default';
 import { Assets, Language } from '../../../types';
-declare const promptScreenTypes: readonly ["login", "login-id", "login-password", "login-email-verification", "signup", "signup-id", "signup-password", "reset-password", "consent", "mfa-push", "mfa-otp", "mfa-voice", "mfa-phone", "mfa-webauthn", "mfa-sms", "mfa-email", "mfa-recovery-code", "mfa", "status", "device-flow", "email-verification", "email-otp-challenge", "organizations", "invitation", "common"];
+declare const promptTypes: readonly ["login", "login-id", "login-password", "login-email-verification", "signup", "signup-id", "signup-password", "reset-password", "consent", "mfa-push", "mfa-otp", "mfa-voice", "mfa-phone", "mfa-webauthn", "mfa-sms", "mfa-email", "mfa-recovery-code", "mfa", "status", "device-flow", "email-verification", "email-otp-challenge", "organizations", "invitation", "common"];
+export declare type PromptTypes = typeof promptTypes[number];
+declare const screenTypes: readonly ["login", "login-id", "login-password", "login-email-verification", "signup", "signup-id", "signup-password", "reset-password-request", "reset-password-email", "reset-password", "reset-password-success", "reset-password-error", "consent", "status", "mfa-detect-browser-capabilities", "mfa-enroll-result", "mfa-login-options", "mfa-begin-enroll-options", "mfa-otp-enrollment-qr", "mfa-otp-enrollment-code", "mfa-otp-challenge", "mfa-voice-challenge", "mfa-sms-challenge", "mfa-recovery-code-enrollment", "mfa-recovery-code-challenge", "mfa-country-codes", "mfa-sms-enrollment", "mfa-voice-enrollment", "mfa-phone-challenge", "mfa-phone-enrollment", "mfa-webauthn-roaming-enrollment", "mfa-webauthn-platform-enrollment", "mfa-webauthn-platform-challenge", "mfa-webauthn-roaming-challenge", "mfa-webauthn-change-key-nickname", "mfa-webauthn-enrollment-success", "mfa-webauthn-error", "mfa-webauthn-not-available-error", "mfa-sms-list", "mfa-email-challenge", "mfa-email-list", "mfa-push-welcome", "mfa-push-list", "mfa-push-enrollment-qr", "mfa-push-enrollment-code", "mfa-push-success", "mfa-push-challenge-push", "device-code-activation", "device-code-activation-allowed", "device-code-activation-denied", "device-code-confirmation", "email-verification-result", "email-otp-challenge", "redeem-ticket", "organization-selection", "accept-invitation"];
+export declare type ScreenTypes = typeof screenTypes[number];
 export declare const schema: {
     type: string;
     properties: {
@@ -20,16 +23,17 @@ export declare const schema: {
         };
     };
 };
-export declare type PromptScreenTypes = typeof promptScreenTypes[number];
 export declare type PromptSettings = {
     universal_login_experience?: 'new' | 'classic';
     webauthn_platform_first_factor?: boolean;
     identifier_first?: boolean;
 };
 export declare type PromptsCustomText = {
-    [key in PromptScreenTypes]: {
-        [key: string]: string;
-    };
+    [key in PromptTypes]: Partial<{
+        [key in ScreenTypes]: {
+            [key: string]: string;
+        };
+    }>;
 };
 export declare type Prompts = Partial<PromptSettings & {
     customText: AllPromptsByLanguage;

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

@@ -27,7 +27,7 @@ exports.schema = void 0;
 const default_1 = __importDefault(require("./default"));
 const types_1 = require("../../../types");
 const lodash_1 = require("lodash");
-const promptScreenTypes = [
+const promptTypes = [
     'login',
     'login-id',
     'login-password',
@@ -54,6 +54,64 @@ const promptScreenTypes = [
     'invitation',
     'common',
 ];
+const screenTypes = [
+    'login',
+    'login-id',
+    'login-password',
+    'login-email-verification',
+    'signup',
+    'signup-id',
+    'signup-password',
+    'reset-password-request',
+    'reset-password-email',
+    'reset-password',
+    'reset-password-success',
+    'reset-password-error',
+    'consent',
+    'status',
+    'mfa-detect-browser-capabilities',
+    'mfa-enroll-result',
+    'mfa-login-options',
+    'mfa-begin-enroll-options',
+    'mfa-otp-enrollment-qr',
+    'mfa-otp-enrollment-code',
+    'mfa-otp-challenge',
+    'mfa-voice-challenge',
+    'mfa-sms-challenge',
+    'mfa-recovery-code-enrollment',
+    'mfa-recovery-code-challenge',
+    'mfa-country-codes',
+    'mfa-sms-enrollment',
+    'mfa-voice-enrollment',
+    'mfa-phone-challenge',
+    'mfa-phone-enrollment',
+    'mfa-webauthn-roaming-enrollment',
+    'mfa-webauthn-platform-enrollment',
+    'mfa-webauthn-platform-challenge',
+    'mfa-webauthn-roaming-challenge',
+    'mfa-webauthn-change-key-nickname',
+    'mfa-webauthn-enrollment-success',
+    'mfa-webauthn-error',
+    'mfa-webauthn-not-available-error',
+    'mfa-sms-list',
+    'mfa-email-challenge',
+    'mfa-email-list',
+    'mfa-push-welcome',
+    'mfa-push-list',
+    'mfa-push-enrollment-qr',
+    'mfa-push-enrollment-code',
+    'mfa-push-success',
+    'mfa-push-challenge-push',
+    'device-code-activation',
+    'device-code-activation-allowed',
+    'device-code-activation-denied',
+    'device-code-confirmation',
+    'email-verification-result',
+    'email-otp-challenge',
+    'redeem-ticket',
+    'organization-selection',
+    'accept-invitation',
+];
 exports.schema = {
     type: 'object',
     properties: {
@@ -72,9 +130,14 @@ exports.schema = {
             properties: types_1.languages.reduce((acc, language) => {
                 return Object.assign(Object.assign({}, acc), { [language]: {
                         type: 'object',
-                        properties: promptScreenTypes.reduce((acc, screenType) => {
-                            return Object.assign(Object.assign({}, acc), { [screenType]: {
+                        properties: promptTypes.reduce((acc, promptTypes) => {
+                            return Object.assign(Object.assign({}, acc), { [promptTypes]: {
                                     type: 'object',
+                                    properties: screenTypes.reduce((acc, screenTypes) => {
+                                        return Object.assign(Object.assign({}, acc), { [screenTypes]: {
+                                                type: 'object',
+                                            } });
+                                    }, {}),
                                 } });
                         }, {}),
                     } });
@@ -102,16 +165,19 @@ class PromptsHandler extends default_1.default {
                 .getSettings()
                 .then(({ enabled_locales }) => enabled_locales);
             const data = yield Promise.all(supportedLanguages.flatMap((language) => {
-                return promptScreenTypes.map((screenType) => {
+                return promptTypes.map((promptType) => {
                     return this.client.prompts
                         .getCustomTextByLanguage({
-                        prompt: screenType,
+                        prompt: promptType,
                         language,
                     })
                         .then((customTextData) => {
                         if ((0, lodash_1.isEmpty)(customTextData))
                             return null;
-                        return Object.assign({ language }, customTextData);
+                        return {
+                            language,
+                            [promptType]: Object.assign({}, customTextData),
+                        };
                     });
                 });
             })).then((customTextData) => {
@@ -156,14 +222,11 @@ class PromptsHandler extends default_1.default {
                 if (!languageScreenTypes)
                     return [];
                 return Object.keys(languageScreenTypes).map((prompt) => {
-                    const body = languageScreenTypes[prompt];
+                    const body = languageScreenTypes[prompt] || {};
                     return this.client.prompts.updateCustomTextByLanguage({
                         prompt,
                         language,
-                        //@ts-ignore
-                        body: {
-                            [prompt]: languageScreenTypes[prompt],
-                        } || {},
+                        body,
                     });
                 });
             }));

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import { PromptScreenTypes, Prompts, PromptsCustomText, PromptSettings } from './tools/auth0/handlers/prompts';
+import { PromptTypes, ScreenTypes, Prompts, PromptsCustomText, PromptSettings } from './tools/auth0/handlers/prompts';
 declare type SharedPaginationParams = {
     checkpoint?: boolean;
     paginate?: boolean;
@@ -129,14 +129,16 @@ export declare type BaseAuth0APIClient = {
     };
     prompts: {
         updateCustomTextByLanguage: (arg0: {
-            prompt: PromptScreenTypes;
+            prompt: PromptTypes;
             language: Language;
-            body: {
-                [key: string]: string;
-            };
+            body: Partial<{
+                [key in ScreenTypes]: {
+                    [key: string]: string;
+                };
+            }>;
         }) => Promise<void>;
         getCustomTextByLanguage: (arg0: {
-            prompt: PromptScreenTypes;
+            prompt: PromptTypes;
             language: Language;
         }) => Promise<Partial<PromptsCustomText>>;
         getSettings: () => Promise<PromptSettings>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.12.0",
+  "version": "7.12.3",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -11,7 +11,7 @@
     "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*'",
+    "test": "ts-mocha -p tsconfig.json --recursive 'test/**/*.test*' --timeout 5000",
     "build": "rimraf ./lib && npx tsc",
     "dev": "npx tsc --watch",
     "prepare": "npm run build",
@@ -36,11 +36,11 @@
     "ajv": "^6.12.6",
     "auth0": "^2.40.0",
     "dot-prop": "^5.2.0",
-    "fs-extra": "^7.0.0",
+    "fs-extra": "^10.1.0",
     "global-agent": "^2.1.12",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.20",
-    "mkdirp": "^0.5.6",
+    "mkdirp": "^1.0.4",
     "nconf": "^0.12.0",
     "promise-pool-executor": "^1.1.1",
     "sanitize-filename": "^1.6.1",

package/typescript-migration-progress.sh

@@ -1,22 +0,0 @@
-#!/bin/bash
-
-# Script providing insight into the progress of migrating Deploy CLI source code to Typescript. See: DXCDT-70
-# This can be deleted once migration from JS => TS is complete
-
-echo "- - - - - Typescript Migration - - - - - -"
-
-locJs=$( (find ./src -name "*.js" -print0 | xargs -0 cat) | wc -l | xargs)
-locTs=$( (find ./src -name "*.ts" -print0 | xargs -0 cat) | wc -l | xargs)
-totalLoc=$(expr ${locJs} + ${locTs})
-percentLocMigrated=$(expr $(expr ${locTs} \* 100) / ${totalLoc})
-
-echo "${locTs} of ${totalLoc} (${percentLocMigrated}%) lines of code migrated to Typescript"
-
-numTsFiles=$(find ./src -name "*.ts" | wc -l | xargs)
-numJsFiles=$(find ./src -name "*.js" | wc -l | xargs)
-totalNumFiles=$(expr ${numTsFiles} + ${numJsFiles})
-percentFilesMigrated=$(expr $(expr ${numTsFiles} \* 100) / ${totalNumFiles})
-
-echo "${numTsFiles} of ${totalNumFiles} (${percentFilesMigrated}%) files migrated to Typescript"
-
-echo "- - - - - - - - - - - - - - - - - - - - - -"