auth0-deploy-cli 7.6.0 → 7.8.0

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

@@ -44,7 +44,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const default_1 = __importStar(require("./default"));
-const logger_1 = __importDefault(require("../../logger"));
+const logger_1 = __importDefault(require("../../../logger"));
 const utils_1 = require("../../utils");
 const MAX_ACTION_DEPLOY_RETRY = 60;
 // With this schema, we can only validate property types but not valid properties on per type basis
@@ -65,9 +65,9 @@ exports.schema = {
                     properties: {
                         name: { type: 'string' },
                         version: { type: 'string' },
-                        registry_url: { type: 'string' }
-                    }
-                }
+                        registry_url: { type: 'string' },
+                    },
+                },
             },
             secrets: {
                 type: 'array',
@@ -76,9 +76,9 @@ exports.schema = {
                     properties: {
                         name: { type: 'string' },
                         value: { type: 'string' },
-                        updated_at: { type: 'string', format: 'date-time' }
-                    }
-                }
+                        updated_at: { type: 'string', format: 'date-time' },
+                    },
+                },
             },
             name: { type: 'string', default: '' },
             supported_triggers: {
@@ -88,31 +88,28 @@ exports.schema = {
                     properties: {
                         id: { type: 'string', default: '' },
                         version: { type: 'string' },
-                        url: { type: 'string' }
-                    }
-                }
+                        url: { type: 'string' },
+                    },
+                },
             },
             deployed: { type: 'boolean' },
-            status: { type: 'string' }
-        }
-    }
+            status: { type: 'string' },
+        },
+    },
 };
 function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
 function isActionsDisabled(err) {
     const errorBody = lodash_1.default.get(err, 'originalError.response.body') || {};
-    return (err.statusCode === 403 && errorBody.errorCode === 'feature_not_enabled');
+    return err.statusCode === 403 && errorBody.errorCode === 'feature_not_enabled';
 }
 class ActionHandler extends default_1.default {
     constructor(options) {
         super(Object.assign(Object.assign({}, options), { type: 'actions', functions: {
                 create: (action) => this.createAction(action),
-                delete: (action) => this.deleteAction(action)
-            }, stripUpdateFields: [
-                'deployed',
-                'status'
-            ] }));
+                delete: (action) => this.deleteAction(action),
+            }, stripUpdateFields: ['deployed', 'status'] }));
     }
     createAction(action) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -148,7 +145,7 @@ class ActionHandler extends default_1.default {
                 })
                     .catch((err) => {
                     throw new Error(`Problem Deploying ${this.type} ${this.objString(action)}\n${err}`);
-                })
+                }),
             })
                 .promise();
         });
@@ -160,7 +157,7 @@ class ActionHandler extends default_1.default {
             }
             catch (err) {
                 // Retry if pending build.
-                if (err.message && err.message.includes('must be in the \'built\' state')) {
+                if (err.message && err.message.includes("must be in the 'built' state")) {
                     if (!action.retry_count) {
                         logger_1.default.info(`[${this.type}]: Waiting for build to complete ${this.objString(action)}`);
                         action.retry_count = 1;
@@ -237,9 +234,10 @@ class ActionHandler extends default_1.default {
             const changes = yield this.calcChanges(assets);
             yield _super.processChanges.call(this, assets, changes);
             // Deploy actions
-            const deployActions = [];
-            deployActions.push(...changes.create.filter((action) => action.deployed));
-            deployActions.push(...changes.update.filter((action) => action.deployed));
+            const deployActions = [
+                ...changes.create.filter((action) => action.deployed),
+                ...changes.update.filter((action) => action.deployed),
+            ];
             yield this.deployActions(deployActions);
         });
     }

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

@@ -0,0 +1,28 @@
+import DefaultAPIHandler from './default';
+import { Asset, Assets } from '../../../types';
+export declare const schema: {
+    type: string;
+    properties: {
+        breachedPasswordDetection: {
+            type: string;
+        };
+        bruteForceProtection: {
+            type: string;
+        };
+        suspiciousIpThrottling: {
+            type: string;
+        };
+    };
+    additionalProperties: boolean;
+};
+export default class AttackProtectionHandler extends DefaultAPIHandler {
+    existing: {
+        breachedPasswordDetection: any;
+        bruteForceProtection: any;
+        suspiciousIpThrottling: any;
+    } | null;
+    constructor(config: DefaultAPIHandler);
+    objString(item: Asset): string;
+    getType(): Promise<Asset>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -18,16 +18,16 @@ exports.schema = {
     type: 'object',
     properties: {
         breachedPasswordDetection: {
-            type: 'object'
+            type: 'object',
         },
         bruteForceProtection: {
-            type: 'object'
+            type: 'object',
         },
         suspiciousIpThrottling: {
-            type: 'object'
-        }
+            type: 'object',
+        },
     },
-    additionalProperties: false
+    additionalProperties: false,
 };
 class AttackProtectionHandler extends default_1.default {
     constructor(config) {
@@ -36,14 +36,14 @@ class AttackProtectionHandler extends default_1.default {
     objString(item) {
         return super.objString({
             'breached-password-protection': {
-                enabled: item.breachedPasswordDetection.enabled
+                enabled: item.breachedPasswordDetection.enabled,
             },
             'brute-force-protection': {
-                enabled: item.bruteForceProtection.enabled
+                enabled: item.bruteForceProtection.enabled,
             },
             'suspicious-ip-throttling': {
-                enabled: item.suspiciousIpThrottling.enabled
-            }
+                enabled: item.suspiciousIpThrottling.enabled,
+            },
         });
     }
     getType() {
@@ -54,12 +54,12 @@ class AttackProtectionHandler extends default_1.default {
             const [breachedPasswordDetection, bruteForceProtection, suspiciousIpThrottling] = yield Promise.all([
                 this.client.attackProtection.getBreachedPasswordDetectionConfig(),
                 this.client.attackProtection.getBruteForceConfig(),
-                this.client.attackProtection.getSuspiciousIpThrottlingConfig()
+                this.client.attackProtection.getSuspiciousIpThrottlingConfig(),
             ]);
             this.existing = {
                 breachedPasswordDetection,
                 bruteForceProtection,
-                suspiciousIpThrottling
+                suspiciousIpThrottling,
             };
             return this.existing;
         });
@@ -71,12 +71,9 @@ class AttackProtectionHandler extends default_1.default {
                 return;
             }
             Promise.all([
-                this.client.attackProtection
-                    .updateBreachedPasswordDetectionConfig({}, attackProtection.breachedPasswordDetection),
-                this.client.attackProtection
-                    .updateSuspiciousIpThrottlingConfig({}, attackProtection.suspiciousIpThrottling),
-                this.client.attackProtection
-                    .updateBruteForceConfig({}, attackProtection.bruteForceProtection)
+                this.client.attackProtection.updateBreachedPasswordDetectionConfig({}, attackProtection.breachedPasswordDetection),
+                this.client.attackProtection.updateSuspiciousIpThrottlingConfig({}, attackProtection.suspiciousIpThrottling),
+                this.client.attackProtection.updateBruteForceConfig({}, attackProtection.bruteForceProtection),
             ]);
             this.updated += 1;
             this.didUpdate(attackProtection);

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

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

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

@@ -25,11 +25,11 @@ exports.schema = {
                 type: 'object',
                 properties: {
                     template: { type: 'string' },
-                    body: { type: 'string' }
-                }
-            }
-        }
-    }
+                    body: { type: 'string' },
+                },
+            },
+        },
+    },
 };
 class BrandingHandler extends default_1.default {
     constructor(options) {
@@ -52,8 +52,8 @@ class BrandingHandler extends default_1.default {
                         branding.templates = [
                             {
                                 template: constants_1.default.UNIVERSAL_LOGIN_TEMPLATE,
-                                body: payload.body
-                            }
+                                body: payload.body,
+                            },
                         ];
                     }
                 }
@@ -88,10 +88,14 @@ class BrandingHandler extends default_1.default {
             }
             // handle templates
             if (branding.templates && branding.templates.length) {
-                const unknownTemplates = branding.templates.filter((t) => !constants_1.default.SUPPORTED_BRANDING_TEMPLATES.includes(t.template)).map((t) => t.template);
+                const unknownTemplates = branding.templates
+                    .filter((t) => !constants_1.default.SUPPORTED_BRANDING_TEMPLATES.includes(t.template))
+                    .map((t) => t.template);
                 if (unknownTemplates.length) {
                     // throw a helpful warning for unknown templates, the context handlers are unaware of which are supported, that's all handled here.
-                    logger_1.default.warn(`Found unknown branding template(s): ${unknownTemplates.join().toString()}. Supported branding templates are: ${constants_1.default.SUPPORTED_BRANDING_TEMPLATES.join()}.`);
+                    logger_1.default.warn(`Found unknown branding template(s): ${unknownTemplates
+                        .join()
+                        .toString()}. Supported branding templates are: ${constants_1.default.SUPPORTED_BRANDING_TEMPLATES.join()}.`);
                 }
                 const templateDefinition = branding.templates.find((t) => t.template === constants_1.default.UNIVERSAL_LOGIN_TEMPLATE);
                 if (templateDefinition && templateDefinition.body) {

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

@@ -0,0 +1,32 @@
+import DefaultHandler from './default';
+import { Asset, Assets } from '../../../types';
+import DefaultAPIHandler from './default';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            client_id: {
+                type: string;
+            };
+            audience: {
+                type: string;
+            };
+            scope: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                uniqueItems: boolean;
+            };
+        };
+        required: string[];
+    };
+};
+export default class ClientGrantsHandler extends DefaultHandler {
+    existing: Asset[] | null;
+    constructor(config: DefaultAPIHandler);
+    objString(item: any): string;
+    getType(): Promise<Asset>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -51,15 +51,17 @@ exports.schema = {
             scope: {
                 type: 'array',
                 items: { type: 'string' },
-                uniqueItems: true
-            }
+                uniqueItems: true,
+            },
         },
-        required: ['client_id', 'scope', 'audience']
-    }
+        required: ['client_id', 'scope', 'audience'],
+    },
 };
-class ClientHandler extends default_1.default {
+class ClientGrantsHandler extends default_1.default {
     constructor(config) {
-        super(Object.assign(Object.assign({}, config), { type: 'clientGrants', id: 'id', identifiers: ['id', ['client_id', 'audience']], stripUpdateFields: ['audience', 'client_id'] }));
+        super(Object.assign(Object.assign({}, config), { type: 'clientGrants', id: 'id', 
+            //@ts-ignore because not sure why two-dimensional array passed in
+            identifiers: ['id', ['client_id', 'audience']], stripUpdateFields: ['audience', 'client_id'] }));
     }
     objString(item) {
         return super.objString({ id: item.id, client_id: item.client_id, audience: item.audience });
@@ -103,15 +105,20 @@ class ClientHandler extends default_1.default {
             const { del, update, create, conflicts } = yield this.calcChanges(Object.assign(Object.assign({}, assets), { clientGrants: formatted }));
             const filterGrants = (list) => {
                 if (excludedClients.length) {
-                    return list.filter((item) => item.client_id !== currentClient && ![...excludedClientsByNames, ...excludedClients].includes(item.client_id));
+                    return list.filter((item) => item.client_id !== currentClient &&
+                        ![...excludedClientsByNames, ...excludedClients].includes(item.client_id));
                 }
                 return list.filter((item) => item.client_id !== currentClient);
             };
             const changes = {
+                //@ts-ignore because this expects `client_id` and that's not yet typed on Asset
                 del: filterGrants(del),
+                //@ts-ignore because this expects `client_id` and that's not yet typed on Asset
                 update: filterGrants(update),
+                //@ts-ignore because this expects `client_id` and that's not yet typed on Asset
                 create: filterGrants(create),
-                conflicts: filterGrants(conflicts)
+                //@ts-ignore because this expects `client_id` and that's not yet typed on Asset
+                conflicts: filterGrants(conflicts),
             };
             yield _super.processChanges.call(this, assets, Object.assign({}, changes));
         });
@@ -119,5 +126,5 @@ class ClientHandler extends default_1.default {
 }
 __decorate([
     (0, default_1.order)('60')
-], ClientHandler.prototype, "processChanges", null);
-exports.default = ClientHandler;
+], ClientGrantsHandler.prototype, "processChanges", null);
+exports.default = ClientGrantsHandler;

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

@@ -0,0 +1,23 @@
+import { Asset, Assets } from '../../../types';
+import DefaultAPIHandler from './default';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+                minLength: number;
+                pattern: string;
+            };
+        };
+        required: string[];
+    };
+};
+export default class ClientHandler extends DefaultAPIHandler {
+    existing: Asset[] | null;
+    constructor(config: DefaultAPIHandler);
+    objString(item: any): string;
+    processChanges(assets: Assets): Promise<void>;
+    getType(): Promise<Asset[]>;
+}

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

@@ -19,16 +19,20 @@ exports.schema = {
     items: {
         type: 'object',
         properties: {
-            name: { type: 'string', minLength: 1, pattern: '[^<>]+' }
+            name: { type: 'string', minLength: 1, pattern: '[^<>]+' },
         },
-        required: ['name']
-    }
+        required: ['name'],
+    },
 };
 class ClientHandler extends default_1.default {
     constructor(config) {
         super(Object.assign(Object.assign({}, config), { type: 'clients', id: 'client_id', identifiers: ['client_id', 'name'], objectFields: ['client_metadata'], stripUpdateFields: [
                 // Fields not allowed during updates
-                'callback_url_template', 'signing_keys', 'global', 'tenant', 'jwt_configuration.secret_encoded'
+                'callback_url_template',
+                'signing_keys',
+                'global',
+                'tenant',
+                'jwt_configuration.secret_encoded',
             ] }));
     }
     objString(item) {
@@ -58,17 +62,20 @@ class ClientHandler extends default_1.default {
                 del: filterClients(del),
                 update: filterClients(update),
                 create: filterClients(create),
-                conflicts: filterClients(conflicts)
+                conflicts: filterClients(conflicts),
             };
             yield _super.processChanges.call(this, assets, Object.assign({}, changes));
         });
     }
     getType() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.existing) {
+            if (this.existing)
                 return this.existing;
-            }
-            this.existing = yield this.client.clients.getAll({ paginate: true, include_totals: true, is_global: false });
+            this.existing = yield this.client.clients.getAll({
+                paginate: true,
+                include_totals: true,
+                is_global: false,
+            });
             return this.existing;
         });
     }

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

@@ -0,0 +1,54 @@
+import DefaultAPIHandler from './default';
+import { CalculatedChanges, Asset, Assets } from '../../../types';
+import { ConfigFunction } from '../../../configFactory';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+            };
+            strategy: {
+                type: string;
+            };
+            options: {
+                type: string;
+            };
+            enabled_clients: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            realms: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            metadata: {
+                type: string;
+            };
+        };
+        required: string[];
+    };
+};
+export declare const addExcludedConnectionPropertiesToChanges: ({ proposedChanges, existingConnections, config, }: {
+    proposedChanges: CalculatedChanges;
+    existingConnections: Asset[];
+    config: ConfigFunction;
+}) => CalculatedChanges;
+export default class ConnectionsHandler extends DefaultAPIHandler {
+    existing: Asset[] | null;
+    constructor(config: DefaultAPIHandler);
+    objString(connection: any): string;
+    getFormattedOptions(connection: any, clients: any): {
+        options: any;
+    } | {
+        options?: undefined;
+    };
+    getType(): Promise<Asset[] | null>;
+    calcChanges(assets: Assets): Promise<CalculatedChanges>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -56,19 +56,20 @@ exports.schema = {
             options: { type: 'object' },
             enabled_clients: { type: 'array', items: { type: 'string' } },
             realms: { type: 'array', items: { type: 'string' } },
-            metadata: { type: 'object' }
+            metadata: { type: 'object' },
         },
-        required: ['name', 'strategy']
-    }
+        required: ['name', 'strategy'],
+    },
 };
 // addExcludedConnectionPropertiesToChanges superimposes excluded properties on the `options` object. The Auth0 API
 // will overwrite the options property when updating connections, so it is necessary to add excluded properties back in to prevent those excluded properties from being deleted.
 // This use case is common because organizations may not want to expose sensitive connection details, but want to preserve them in the tenant.
 // exported only for unit testing purposes
-const addExcludedConnectionPropertiesToChanges = ({ proposedChanges, existingConnections, config }) => {
+const addExcludedConnectionPropertiesToChanges = ({ proposedChanges, existingConnections, config, }) => {
     var _a, _b;
     if (proposedChanges.update.length === 0)
         return proposedChanges;
+    //@ts-ignore because this expects a parameter to be passed
     const excludedFields = ((_b = (_a = config()) === null || _a === void 0 ? void 0 : _a.EXCLUDED_PROPS) === null || _b === void 0 ? void 0 : _b.connections) || [];
     if (excludedFields.length === 0)
         return proposedChanges;
@@ -84,7 +85,9 @@ const addExcludedConnectionPropertiesToChanges = ({ proposedChanges, existingCon
             const currentExcludedFieldValue = dot_prop_1.default.get(currConnection, excludedField);
             dot_prop_1.default.set(agg, excludedField, currentExcludedFieldValue);
             return agg;
-        }, {});
+        }, {
+            options: {},
+        });
         return Object.assign(Object.assign({}, proposedConnection), { options: Object.assign(Object.assign({}, proposedConnection.options), currentExcludedPropertyValues.options) });
     });
     return Object.assign(Object.assign({}, proposedChanges), { update: newProposedUpdates });
@@ -100,7 +103,7 @@ class ConnectionsHandler extends default_1.default {
     getFormattedOptions(connection, clients) {
         try {
             return {
-                options: Object.assign(Object.assign({}, connection.options), { idpinitiated: Object.assign(Object.assign({}, connection.options.idpinitiated), { client_id: (0, utils_1.convertClientNameToId)(connection.options.idpinitiated.client_id, clients) }) })
+                options: Object.assign(Object.assign({}, connection.options), { idpinitiated: Object.assign(Object.assign({}, connection.options.idpinitiated), { client_id: (0, utils_1.convertClientNameToId)(connection.options.idpinitiated.client_id, clients) }) }),
             };
         }
         catch (e) {
@@ -111,9 +114,14 @@ class ConnectionsHandler extends default_1.default {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.existing)
                 return this.existing;
-            const connections = yield this.client.connections.getAll({ paginate: true, include_totals: true });
+            const connections = yield this.client.connections.getAll({
+                paginate: true,
+                include_totals: true,
+            });
             // Filter out database connections
             this.existing = connections.filter((c) => c.strategy !== 'auth0');
+            if (this.existing === null)
+                return [];
             return this.existing;
         });
     }
@@ -125,13 +133,25 @@ class ConnectionsHandler extends default_1.default {
             const { connections } = assets;
             // Do nothing if not set
             if (!connections)
-                return {};
+                return {
+                    del: [],
+                    create: [],
+                    update: [],
+                    conflicts: [],
+                };
             // Convert enabled_clients by name to the id
             const clients = yield this.client.clients.getAll({ paginate: true, include_totals: true });
-            const existingConnections = yield this.client.connections.getAll({ paginate: true, include_totals: true });
+            const existingConnections = yield this.client.connections.getAll({
+                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 proposedChanges = yield _super.calcChanges.call(this, Object.assign(Object.assign({}, assets), { connections: formatted }));
-            const proposedChangesWithExcludedProperties = (0, exports.addExcludedConnectionPropertiesToChanges)({ proposedChanges, existingConnections, config: this.config });
+            const proposedChangesWithExcludedProperties = (0, exports.addExcludedConnectionPropertiesToChanges)({
+                proposedChanges,
+                existingConnections,
+                config: this.config,
+            });
             return proposedChangesWithExcludedProperties;
         });
     }

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

@@ -0,0 +1,36 @@
+import DefaultAPIHandler from './default';
+import { CalculatedChanges, Assets } from '../../../types';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            strategy: {
+                type: string;
+                enum: string[];
+                default: string;
+            };
+            name: {
+                type: string;
+            };
+            options: {
+                type: string;
+                properties: {
+                    customScripts: {
+                        type: string;
+                        properties: {};
+                    };
+                };
+            };
+        };
+        required: string[];
+    };
+};
+export default class DatabaseHandler extends DefaultAPIHandler {
+    constructor(config: DefaultAPIHandler);
+    objString(db: any): string;
+    getClientFN(fn: 'create' | 'delete' | 'getAll' | 'update'): Function;
+    getType(): Promise<import("../../../types").Asset>;
+    calcChanges(assets: Assets): Promise<CalculatedChanges>;
+    processChanges(assets: Assets): Promise<void>;
+}