auth0-deploy-cli 7.10.0 → 7.11.0

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

@@ -11,17 +11,21 @@ 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
+        const { rulesConfigs } = context.assets;
+        if (!rulesConfigs)
+            return { rulesConfigs: null };
         return {
-            rulesConfigs: context.assets.rulesConfigs,
+            rulesConfigs,
         };
     });
 }
-function dump(_context) {
+function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        // do not export rulesConfigs as its values cannot be extracted
+        const { rulesConfigs } = context.assets;
+        if (!rulesConfigs)
+            return { rulesConfigs: null };
         return {
-            rulesConfigs: [],
+            rulesConfigs: [], // even if they exist, do not export rulesConfigs as its values cannot be extracted
         };
     });
 }

package/lib/context/yaml/handlers/tenant.d.ts

@@ -1,6 +1,5 @@
 import { YAMLHandler } from '.';
-declare type ParsedTenant = {
-    tenant: unknown[];
-} | {};
+import { Asset, ParsedAsset } from '../../../types';
+declare type ParsedTenant = ParsedAsset<'tenant', Asset>;
 declare const tenantHandler: YAMLHandler<ParsedTenant>;
 export default tenantHandler;

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

@@ -24,9 +24,8 @@ const utils_1 = require("../../../utils");
 const sessionDurationsToMinutes_1 = require("../../../sessionDurationsToMinutes");
 function parse(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        // Nothing to do
         if (!context.assets.tenant)
-            return {};
+            return { tenant: null };
         /* eslint-disable camelcase */
         const _a = context.assets.tenant, { session_lifetime, idle_session_lifetime } = _a, tenant = __rest(_a, ["session_lifetime", "idle_session_lifetime"]);
         (0, utils_1.clearTenantFlags)(tenant);
@@ -38,7 +37,9 @@ function parse(context) {
 }
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        const tenant = Object.assign({}, (context.assets.tenant || {}));
+        const tenant = context.assets.tenant;
+        if (!tenant)
+            return { tenant: null };
         (0, utils_1.clearTenantFlags)(tenant);
         return { tenant };
     });

package/lib/context/yaml/handlers/triggers.d.ts

@@ -1,6 +1,5 @@
 import { YAMLHandler } from '.';
-declare type ParsedTriggers = {
-    triggers: unknown[];
-} | {};
+import { Asset, ParsedAsset } from '../../../types';
+declare type ParsedTriggers = ParsedAsset<'triggers', Asset[]>;
 declare const triggersHandler: YAMLHandler<ParsedTriggers>;
 export default triggersHandler;

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

@@ -13,7 +13,7 @@ function parse(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // Load the script file for each action
         if (!context.assets.triggers)
-            return {};
+            return { triggers: null };
         return {
             triggers: context.assets.triggers,
         };
@@ -24,7 +24,7 @@ function dump(context) {
         const { triggers } = context.assets;
         // Nothing to do
         if (!triggers)
-            return {};
+            return { triggers: null };
         return {
             triggers: triggers,
         };

package/lib/context/yaml/index.js

@@ -111,7 +111,8 @@ class YAMLContext {
                 try {
                     const data = yield handler.dump(this);
                     if (data) {
-                        logger_1.default.info(`Exporting ${name}`);
+                        if (data[name] !== null)
+                            logger_1.default.info(`Exporting ${name}`);
                         Object.entries(data).forEach(([k, v]) => {
                             this.assets[k] = Array.isArray(v)
                                 ? v.map(utils_1.formatResults).sort(utils_1.recordsSorter)

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

@@ -211,12 +211,12 @@ class ActionHandler extends default_1.default {
                 return this.existing;
             }
             catch (err) {
-                if (err.statusCode === 403 || err.statusCode === 404 || err.statusCode === 501) {
-                    return [];
+                if (err.statusCode === 404 || err.statusCode === 501) {
+                    return null;
                 }
                 if (isActionsDisabled(err)) {
                     logger_1.default.info('Skipping actions because it is not enabled.');
-                    return [];
+                    return null;
                 }
                 throw err;
             }

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

@@ -1,5 +1,5 @@
 import DefaultHandler from './default';
-import { Asset } from '../../../types';
+import { Asset, Assets } from '../../../types';
 export declare const schema: {
     type: string;
     properties: {
@@ -23,5 +23,5 @@ export default class BrandingHandler extends DefaultHandler {
     existing: Asset;
     constructor(options: DefaultHandler);
     getType(): Promise<Asset>;
-    processChanges(assets: any): Promise<void>;
+    processChanges(assets: Assets): Promise<void>;
 }

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

@@ -93,7 +93,7 @@ class ClientGrantsHandler extends default_1.default {
             const excludedClientsByNames = (assets.exclude && assets.exclude.clients) || [];
             const excludedClients = (0, utils_1.convertClientNamesToIds)(excludedClientsByNames, clients);
             // Convert clients by name to the id
-            const formatted = assets.clientGrants.map((clientGrant) => {
+            const formatted = clientGrants.map((clientGrant) => {
                 const grant = Object.assign({}, clientGrant);
                 const found = clients.find((c) => c.name === grant.client_id);
                 if (found)

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

@@ -145,7 +145,7 @@ class ConnectionsHandler extends default_1.default {
                 paginate: true,
                 include_totals: true,
             });
-            const formatted = assets.connections.map((connection) => (Object.assign(Object.assign(Object.assign({}, connection), this.getFormattedOptions(connection, clients)), { enabled_clients: (0, utils_1.getEnabledClients)(assets, connection, existingConnections, clients) })));
+            const formatted = connections.map((connection) => (Object.assign(Object.assign(Object.assign({}, connection), this.getFormattedOptions(connection, clients)), { enabled_clients: (0, utils_1.getEnabledClients)(assets, connection, existingConnections, clients) })));
             const proposedChanges = yield _super.calcChanges.call(this, Object.assign(Object.assign({}, assets), { connections: formatted }));
             const proposedChangesWithExcludedProperties = (0, exports.addExcludedConnectionPropertiesToChanges)({
                 proposedChanges,

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

@@ -69,8 +69,15 @@ class APIHandler {
     load() {
         return __awaiter(this, void 0, void 0, function* () {
             // Load Asset from Tenant
-            logger_1.default.info(`Retrieving ${this.type} data from Auth0`);
-            const data = yield this.getType();
+            const data = yield (() => __awaiter(this, void 0, void 0, function* () {
+                const { data, hadSufficientScopes, requiredScopes } = yield (0, utils_1.detectInsufficientScopeError)(this.getType.bind(this));
+                if (!hadSufficientScopes) {
+                    logger_1.default.warn(`Cannot retrieve ${this.type} due to missing scopes: ${requiredScopes}`);
+                    return null;
+                }
+                logger_1.default.info(`Retrieving ${this.type} data from Auth0`);
+                return data;
+            }))();
             this.existing = (0, utils_1.obfuscateSensitiveValues)(data, this.sensitiveFieldsToObfuscate);
             return { [this.type]: this.existing };
         });

package/lib/tools/auth0/index.js

@@ -62,8 +62,11 @@ class Auth0 {
     }
     validate() {
         return __awaiter(this, void 0, void 0, function* () {
-            const ajv = new ajv_1.default({ useDefaults: true });
-            const valid = ajv.validate(schema_1.default, this.assets);
+            const ajv = new ajv_1.default({ useDefaults: true, nullable: true });
+            const nonNullAssets = Object.keys(this.assets)
+                .filter((k) => this.assets[k] != null)
+                .reduce((a, k) => (Object.assign(Object.assign({}, a), { [k]: this.assets[k] })), {});
+            const valid = ajv.validate(schema_1.default, nonNullAssets);
             if (!valid) {
                 throw new Error(`Schema validation failed loading ${JSON.stringify(ajv.errors, null, 4)}`);
             }

package/lib/tools/utils.d.ts

@@ -16,3 +16,12 @@ export declare function filterExcluded(changes: CalculatedChanges, exclude: stri
 export declare function areArraysEquals(x: any[], y: any[]): boolean;
 export declare const obfuscateSensitiveValues: (data: Asset | Asset[] | null, sensitiveFieldsToObfuscate: string[]) => Asset | Asset[] | null;
 export declare const stripObfuscatedFieldsFromPayload: (data: Asset | Asset[] | null, obfuscatedFields: string[]) => Asset | Asset[] | null;
+export declare const detectInsufficientScopeError: <T>(fn: Function) => Promise<{
+    hadSufficientScopes: true;
+    data: T;
+    requiredScopes: [];
+} | {
+    hadSufficientScopes: false;
+    requiredScopes: string[];
+    data: null;
+}>;

package/lib/tools/utils.js

@@ -22,11 +22,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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 });
-exports.stripObfuscatedFieldsFromPayload = exports.obfuscateSensitiveValues = exports.areArraysEquals = exports.filterExcluded = exports.duplicateItems = exports.getEnabledClients = exports.stripFields = exports.convertJsonToString = exports.flatten = exports.loadFileAndReplaceKeywords = exports.convertClientNamesToIds = exports.convertClientNameToId = exports.keywordReplace = exports.keywordStringReplace = exports.keywordArrayReplace = void 0;
+exports.detectInsufficientScopeError = exports.stripObfuscatedFieldsFromPayload = exports.obfuscateSensitiveValues = exports.areArraysEquals = exports.filterExcluded = exports.duplicateItems = exports.getEnabledClients = exports.stripFields = exports.convertJsonToString = exports.flatten = exports.loadFileAndReplaceKeywords = exports.convertClientNamesToIds = exports.convertClientNameToId = exports.keywordReplace = exports.keywordStringReplace = exports.keywordArrayReplace = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importStar(require("fs"));
 const dot_prop_1 = __importDefault(require("dot-prop"));
@@ -208,3 +217,26 @@ const stripObfuscatedFieldsFromPayload = (data, obfuscatedFields) => {
     return newAsset;
 };
 exports.stripObfuscatedFieldsFromPayload = stripObfuscatedFieldsFromPayload;
+const detectInsufficientScopeError = (fn) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    try {
+        const data = yield fn();
+        return {
+            hadSufficientScopes: true,
+            data,
+            requiredScopes: [],
+        };
+    }
+    catch (err) {
+        if (err.statusCode === 403 && err.message.includes('Insufficient scope')) {
+            const requiredScopes = (_b = (_a = err.message) === null || _a === void 0 ? void 0 : _a.split('Insufficient scope, expected any of: ')) === null || _b === void 0 ? void 0 : _b.slice(1);
+            return {
+                hadSufficientScopes: false,
+                requiredScopes,
+                data: null,
+            };
+        }
+        throw err;
+    }
+});
+exports.detectInsufficientScopeError = detectInsufficientScopeError;

package/lib/types.d.ts

@@ -208,42 +208,47 @@ export declare type Config = {
 export declare type Asset = {
     [key: string]: any;
 };
-export declare type Assets = {
-    actions: Asset[];
-    attackProtection: Asset;
-    branding: Asset;
-    clients: Asset[];
-    clientGrants: Asset[];
-    connections: Asset[];
-    databases: Asset[];
-    emailProvider: Asset;
-    emailTemplates: Asset[];
-    guardianFactorProviders: Asset[];
-    guardianFactors: Asset[];
-    guardianFactorTemplates: Asset[];
+export declare type Assets = Partial<{
+    actions: Asset[] | null;
+    attackProtection: Asset | null;
+    branding: {
+        templates?: {
+            template: string;
+            body: string;
+        }[] | null;
+    } | null;
+    clients: Asset[] | null;
+    clientGrants: Asset[] | null;
+    connections: Asset[] | null;
+    databases: Asset[] | null;
+    emailProvider: Asset | null;
+    emailTemplates: Asset[] | null;
+    guardianFactorProviders: Asset[] | null;
+    guardianFactors: Asset[] | null;
+    guardianFactorTemplates: Asset[] | null;
     guardianPhoneFactorMessageTypes: {
         message_types: Asset[];
-    };
-    guardianPhoneFactorSelectedProvider: Asset;
+    } | null;
+    guardianPhoneFactorSelectedProvider: Asset | null;
     guardianPolicies: {
         policies: Asset[];
-    };
-    hooks: Asset[];
-    logStreams: Asset[];
-    migrations: Asset[];
-    organizations: Asset[];
-    pages: Asset[];
-    resourceServers: Asset[];
-    roles: Asset[];
-    rules: Asset[];
-    rulesConfigs: Asset[];
-    tenant: Asset;
-    triggers: Asset[];
+    } | null;
+    hooks: Asset[] | null;
+    logStreams: Asset[] | null;
+    migrations: Asset[] | null;
+    organizations: Asset[] | null;
+    pages: Asset[] | null;
+    resourceServers: Asset[] | null;
+    roles: Asset[] | null;
+    rules: Asset[] | null;
+    rulesConfigs: Asset[] | null;
+    tenant: Asset | null;
+    triggers: Asset[] | null;
     exclude?: {
         [key: string]: string[];
     };
-    clientsOrig: Asset[];
-};
+    clientsOrig: Asset[] | null;
+}>;
 export declare type CalculatedChanges = {
     del: Asset[];
     update: Asset[];
@@ -254,4 +259,7 @@ export declare type AssetTypes = 'rules' | 'rulesConfigs' | 'hooks' | 'pages' |
 export declare type KeywordMappings = {
     [key: string]: (string | number)[] | string | number;
 };
+export declare type ParsedAsset<Key extends AssetTypes, T> = {
+    [key in Key]: T | null;
+};
 export {};

package/lib/utils.d.ts

@@ -10,40 +10,45 @@ export declare function dumpJSON(file: string, mappings: {
 export declare function existsMustBeDir(folder: string): boolean;
 export declare function toConfigFn(data: Config): (arg0: keyof Config) => any;
 export declare function stripIdentifiers(auth0: Auth0, assets: Assets): {
-    actions: Asset[];
-    attackProtection: Asset;
-    branding: Asset;
-    clients: Asset[];
-    clientGrants: Asset[];
-    connections: Asset[];
-    databases: Asset[];
-    emailProvider: Asset;
-    emailTemplates: Asset[];
-    guardianFactorProviders: Asset[];
-    guardianFactors: Asset[];
-    guardianFactorTemplates: Asset[];
-    guardianPhoneFactorMessageTypes: {
+    actions?: Asset[] | null | undefined;
+    attackProtection?: Asset | null | undefined;
+    branding?: {
+        templates?: {
+            template: string;
+            body: string;
+        }[] | null | undefined;
+    } | null | undefined;
+    clients?: Asset[] | null | undefined;
+    clientGrants?: Asset[] | null | undefined;
+    connections?: Asset[] | null | undefined;
+    databases?: Asset[] | null | undefined;
+    emailProvider?: Asset | null | undefined;
+    emailTemplates?: Asset[] | null | undefined;
+    guardianFactorProviders?: Asset[] | null | undefined;
+    guardianFactors?: Asset[] | null | undefined;
+    guardianFactorTemplates?: Asset[] | null | undefined;
+    guardianPhoneFactorMessageTypes?: {
         message_types: Asset[];
-    };
-    guardianPhoneFactorSelectedProvider: Asset;
-    guardianPolicies: {
+    } | null | undefined;
+    guardianPhoneFactorSelectedProvider?: Asset | null | undefined;
+    guardianPolicies?: {
         policies: Asset[];
-    };
-    hooks: Asset[];
-    logStreams: Asset[];
-    migrations: Asset[];
-    organizations: Asset[];
-    pages: Asset[];
-    resourceServers: Asset[];
-    roles: Asset[];
-    rules: Asset[];
-    rulesConfigs: Asset[];
-    tenant: Asset;
-    triggers: Asset[];
+    } | null | undefined;
+    hooks?: Asset[] | null | undefined;
+    logStreams?: Asset[] | null | undefined;
+    migrations?: Asset[] | null | undefined;
+    organizations?: Asset[] | null | undefined;
+    pages?: Asset[] | null | undefined;
+    resourceServers?: Asset[] | null | undefined;
+    roles?: Asset[] | null | undefined;
+    rules?: Asset[] | null | undefined;
+    rulesConfigs?: Asset[] | null | undefined;
+    tenant?: Asset | null | undefined;
+    triggers?: Asset[] | null | undefined;
     exclude?: {
         [key: string]: string[];
     } | undefined;
-    clientsOrig: Asset[];
+    clientsOrig?: Asset[] | null | undefined;
 };
 export declare function sanitize(str: string): string;
 declare type ImportantFields = {

package/lib/utils.js

@@ -107,7 +107,7 @@ function sanitize(str) {
 }
 exports.sanitize = sanitize;
 function formatResults(item) {
-    if (typeof item !== 'object') {
+    if (!item || typeof item !== 'object') {
         return item;
     }
     const importantFields = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.10.0",
+  "version": "7.11.0",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -41,12 +41,12 @@
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.20",
     "mkdirp": "^0.5.6",
-    "nconf": "^0.11.4",
+    "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.6.0",
+    "winston": "^3.7.2",
     "yargs": "^15.3.1"
   },
   "devDependencies": {
@@ -59,7 +59,7 @@
     "eslint": "^7.28.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-import": "^2.26.0",
     "husky": "^7.0.4",
     "kacl": "^1.1.1",
     "mocha": "^9.2.2",
@@ -70,5 +70,8 @@
     "rmdir-sync": "^1.0.1",
     "ts-mocha": "^9.0.2",
     "typescript": "^4.6.3"
+  },
+  "overrides": {
+    "istanbul-reports": "3.1.4"
   }
 }