auth0-deploy-cli 7.7.0 → 7.9.0

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

@@ -0,0 +1,15 @@
+import DefaultHandler from './default';
+import { Asset, Assets } from '../../../types';
+export declare const schema: {
+    type: string;
+    additionalProperties: {
+        type: string;
+    };
+};
+export default class MigrationsHandler extends DefaultHandler {
+    constructor(options: DefaultHandler);
+    getType(): Promise<Asset[] | {}>;
+    processChanges(assets: Assets): Promise<void>;
+    logUnavailableMigrations(ignoreUnavailableMigrations: boolean, ignoredMigrations: string[]): void;
+    removeUnavailableMigrations(migrations: Asset[]): Promise<Asset[]>;
+}

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

@@ -43,7 +43,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = void 0;
 const default_1 = __importStar(require("./default"));
-const logger_1 = __importDefault(require("../../logger"));
+const logger_1 = __importDefault(require("../../../logger"));
 exports.schema = {
     type: 'object',
     additionalProperties: { type: 'boolean' },

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

@@ -0,0 +1,51 @@
+import DefaultHandler from './default';
+import { Asset, Assets, CalculatedChanges } from '../../../types';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+            };
+            display_name: {
+                type: string;
+            };
+            branding: {
+                type: string;
+            };
+            metadata: {
+                type: string;
+            };
+            connections: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        connection_id: {
+                            type: string;
+                        };
+                        assign_membership_on_login: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
+        required: string[];
+    };
+};
+export default class OrganizationsHandler extends DefaultHandler {
+    existing: Asset[];
+    constructor(config: DefaultHandler);
+    deleteOrganization(org: any): Promise<void>;
+    deleteOrganizations(data: any): Promise<void>;
+    createOrganization(org: any): Promise<Asset>;
+    createOrganizations(creates: CalculatedChanges['create']): Promise<void>;
+    updateOrganization(org: any, organizations: any): Promise<{
+        id: any;
+    }>;
+    updateOrganizations(updates: CalculatedChanges['update'], orgs: Asset[]): Promise<void>;
+    getType(): Promise<Asset[]>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -45,7 +45,7 @@ exports.schema = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const default_1 = __importStar(require("./default"));
 const calculateChanges_1 = require("../../calculateChanges");
-const logger_1 = __importDefault(require("../../logger"));
+const logger_1 = __importDefault(require("../../../logger"));
 exports.schema = {
     type: 'array',
     items: {

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

@@ -0,0 +1,42 @@
+import DefaultHandler from './default';
+import { Asset, Assets } from '../../../types';
+export declare const supportedPages: string[];
+export declare const pageNameMap: {
+    guardian_multifactor: string;
+    password_reset: string;
+    error_page: string;
+};
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+                enum: string[];
+            };
+            html: {
+                type: string;
+                default: string;
+            };
+            url: {
+                type: string;
+            };
+            show_log_link: {
+                type: string;
+            };
+            enabled: {
+                type: string;
+            };
+        };
+        required: string[];
+    };
+};
+export default class PagesHandler extends DefaultHandler {
+    constructor(options: DefaultHandler);
+    objString(page: any): string;
+    updateLoginPage(page: any): Promise<void>;
+    updatePages(pages: Asset[]): Promise<void>;
+    getType(): Promise<Asset[]>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -0,0 +1,11 @@
+import DefaultHandler from './default';
+import { Asset, Assets } from '../../../types';
+export declare const schema: {
+    type: string;
+};
+export default class PromptsHandler extends DefaultHandler {
+    existing: Asset[];
+    constructor(options: DefaultHandler);
+    getType(): Promise<Asset[]>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -0,0 +1,51 @@
+import DefaultHandler from './default';
+import { Asset, Assets, CalculatedChanges } from '../../../types';
+export declare const excludeSchema: {
+    type: string;
+    items: {
+        type: string;
+    };
+};
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+            };
+            identifier: {
+                type: string;
+            };
+            scopes: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        name: {
+                            type: string;
+                        };
+                        description: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            enforce_policies: {
+                type: string;
+            };
+            token_dialect: {
+                type: string;
+            };
+        };
+        required: string[];
+    };
+};
+export default class ResourceServersHandler extends DefaultHandler {
+    existing: Asset[];
+    constructor(options: DefaultHandler);
+    objString(resourceServer: any): string;
+    getType(): Promise<Asset[]>;
+    calcChanges(assets: Assets): Promise<CalculatedChanges>;
+    validate(assets: Assets): Promise<void>;
+}

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

@@ -0,0 +1,48 @@
+import DefaultHandler from './default';
+import { Asset, Assets, CalculatedChanges } from '../../../types';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+            };
+            id: {
+                type: string;
+            };
+            description: {
+                type: string;
+            };
+            permissions: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        permission_name: {
+                            type: string;
+                        };
+                        resource_server_identifier: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
+        required: string[];
+    };
+};
+export default class RolesHandler extends DefaultHandler {
+    existing: Asset[];
+    constructor(config: DefaultHandler);
+    createRole(data: any): Promise<Asset>;
+    createRoles(creates: CalculatedChanges['create']): Promise<void>;
+    deleteRole(data: any): Promise<void>;
+    deleteRoles(dels: CalculatedChanges['del']): Promise<void>;
+    updateRole(data: any, roles: any): Promise<{
+        id: any;
+    }>;
+    updateRoles(updates: CalculatedChanges['update'], roles: any): Promise<void>;
+    getType(): Promise<Asset[]>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -44,7 +44,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = void 0;
 const default_1 = __importStar(require("./default"));
 const calculateChanges_1 = require("../../calculateChanges");
-const logger_1 = __importDefault(require("../../logger"));
+const logger_1 = __importDefault(require("../../../logger"));
 exports.schema = {
     type: 'array',
     items: {

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

@@ -0,0 +1,55 @@
+import DefaultHandler from './default';
+import { Asset, Assets, CalculatedChanges } from '../../../types';
+export declare const excludeSchema: {
+    type: string;
+    items: {
+        type: string;
+    };
+};
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        default: never[];
+        properties: {
+            script: {
+                type: string;
+                description: string;
+                default: string;
+            };
+            name: {
+                type: string;
+                description: string;
+                pattern: string;
+            };
+            order: {
+                type: string[];
+                description: string;
+                default: null;
+            };
+            enabled: {
+                type: string;
+                description: string;
+                default: boolean;
+            };
+            stage: {
+                type: string;
+                description: string;
+                default: string;
+                enum: string[];
+            };
+        };
+        required: string[];
+    };
+};
+export default class RulesHandler extends DefaultHandler {
+    existing: Asset[];
+    constructor(options: DefaultHandler);
+    getType(): Promise<Asset[]>;
+    objString(rule: any): string;
+    calcChanges(assets: any, includeExcluded?: boolean): Promise<CalculatedChanges & {
+        reOrder: Asset[];
+    }>;
+    validate(assets: Assets): Promise<void>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -16,7 +16,7 @@ exports.schema = exports.excludeSchema = void 0;
 const validationError_1 = __importDefault(require("../../validationError"));
 const utils_1 = require("../../utils");
 const default_1 = __importDefault(require("./default"));
-const logger_1 = __importDefault(require("../../logger"));
+const logger_1 = __importDefault(require("../../../logger"));
 const calculateChanges_1 = require("../../calculateChanges");
 exports.excludeSchema = {
     type: 'array',
@@ -141,7 +141,7 @@ class RulesHandler extends default_1.default {
             if (rulesSameOrder.length > 0) {
                 const formatted = rulesSameOrder.map((dups) => dups.map((d) => `${d.name}`));
                 throw new validationError_1.default(`There are multiple rules for the following stage-order combinations
-      ${(0, utils_1.dumpJSON)(formatted)}.
+      ${(0, utils_1.convertJsonToString)(formatted)}.
        Only one rule must be defined for the same order number in a stage.`);
             }
             // Detect Rules that are changing stage as it's not allowed.
@@ -154,7 +154,7 @@ class RulesHandler extends default_1.default {
                 .map((r) => r.name);
             if (stateChanged.length > 0) {
                 throw new validationError_1.default(`The following rules changed stage which is not allowed:
-      ${(0, utils_1.dumpJSON)(stateChanged)}.
+      ${(0, utils_1.convertJsonToString)(stateChanged)}.
       Rename the rules to recreate them and avoid this error.`);
             }
             yield _super.validate.call(this, assets);
@@ -184,7 +184,7 @@ class RulesHandler extends default_1.default {
                         order: rule.order,
                         id: rule.id,
                     };
-                    logger_1.default.info(`Temporally re-order Rule ${(0, utils_1.dumpJSON)(updated)}`);
+                    logger_1.default.info(`Temporally re-order Rule ${(0, utils_1.convertJsonToString)(updated)}`);
                 }),
             })
                 .promise();

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

@@ -0,0 +1,25 @@
+import { Assets, Asset, CalculatedChanges } from '../../../types';
+import DefaultHandler from './default';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            key: {
+                type: string;
+                pattern: string;
+            };
+            value: {
+                type: string;
+            };
+        };
+        required: string[];
+    };
+    additionalProperties: boolean;
+};
+export default class RulesConfigsHandler extends DefaultHandler {
+    constructor(options: DefaultHandler);
+    getType(): Promise<Asset[]>;
+    objString(item: any): string;
+    calcChanges(assets: Assets): Promise<CalculatedChanges>;
+}

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

@@ -0,0 +1,11 @@
+import DefaultHandler from './default';
+import { Asset, Assets } from '../../../types';
+export declare const schema: {
+    type: string;
+};
+export default class TenantHandler extends DefaultHandler {
+    constructor(options: DefaultHandler);
+    getType(): Promise<Asset>;
+    validate(assets: Assets): Promise<void>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -76,7 +76,7 @@ class TenantHandler extends default_1.default {
                 return;
             const pageKeys = Object.keys(tenant).filter((k) => blockPageKeys.includes(k));
             if (pageKeys.length > 0) {
-                throw new validationError_1.default(`The following pages ${(0, utils_1.dumpJSON)(pageKeys)} were found in tenant settings. Pages should be set separately. Please refer to the documentation.`);
+                throw new validationError_1.default(`The following pages ${(0, utils_1.convertJsonToString)(pageKeys)} were found in tenant settings. Pages should be set separately. Please refer to the documentation.`);
             }
         });
     }

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

@@ -0,0 +1,35 @@
+import DefaultHandler from './default';
+import { Assets } from '../../../types';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        additionalProperties: boolean;
+        properties: {
+            trigger_id: {
+                type: string;
+                properties: {
+                    action_name: {
+                        type: string;
+                        enum: string[];
+                    };
+                    display_name: {
+                        type: string;
+                        default: string;
+                    };
+                };
+            };
+        };
+    };
+};
+export default class TriggersHandler extends DefaultHandler {
+    existing: {
+        [key: string]: {
+            action_name: string;
+            display_name: string;
+        };
+    };
+    constructor(options: DefaultHandler);
+    getType(): Promise<DefaultHandler['existing']>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -45,7 +45,7 @@ exports.schema = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const default_1 = __importStar(require("./default"));
 const constants_1 = __importDefault(require("../../constants"));
-const logger_1 = __importDefault(require("../../logger"));
+const logger_1 = __importDefault(require("../../../logger"));
 exports.schema = {
     type: 'object',
     items: {

package/lib/tools/auth0/index.d.ts

@@ -0,0 +1,15 @@
+import { Assets, Auth0APIClient, BaseAuth0APIClient } from '../../types';
+import APIHandler from './handlers/default';
+import { ConfigFunction } from '../../configFactory';
+export declare type Stage = 'load' | 'validate' | 'processChanges';
+export default class Auth0 {
+    client: Auth0APIClient;
+    config: ConfigFunction;
+    assets: Assets;
+    handlers: APIHandler[];
+    constructor(client: BaseAuth0APIClient, assets: Assets, config: ConfigFunction);
+    runStage(stage: Stage): Promise<void>;
+    validate(): Promise<void>;
+    loadAll(): Promise<void>;
+    processChanges(): Promise<void>;
+}

package/lib/tools/auth0/schema.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    type: string;
+    $schema: string;
+    properties: {
+        exclude: {
+            type: string;
+            properties: {
+                [x: string]: Object;
+            };
+            default: {};
+        };
+    };
+    additionalProperties: boolean;
+};
+export default _default;

package/lib/tools/calculateChanges.d.ts

@@ -0,0 +1,26 @@
+import APIHandler from '../tools/auth0/handlers/default';
+import { Asset, CalculatedChanges } from '../types';
+/**
+ * @template T
+ * @param {typeof import('./auth0/handlers/default').default} handler
+ * @param {T} desiredAssetState
+ * @param {T} currentAssetState
+ * @param {string[]} [objectFields=[]]
+ * @param {boolean} [allowDelete=false]
+ * @returns T
+ */
+export declare function processChangedObjectFields({ handler, desiredAssetState, currentAssetState, allowDelete, }: {
+    handler: APIHandler;
+    desiredAssetState: Asset;
+    currentAssetState: Asset;
+    allowDelete?: boolean;
+}): {
+    [x: string]: any;
+};
+export declare function calculateChanges({ handler, assets, existing, identifiers, allowDelete, }: {
+    handler: APIHandler;
+    assets: Asset[];
+    existing: Asset[];
+    identifiers: string[];
+    allowDelete: boolean;
+}): CalculatedChanges;

package/lib/tools/calculateChanges.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.calculateChanges = exports.processChangedObjectFields = void 0;
-const logger_1 = __importDefault(require("./logger"));
+const logger_1 = __importDefault(require("../logger"));
 /**
  * @template T
  * @param {typeof import('./auth0/handlers/default').default} handler

package/lib/tools/constants.d.ts

@@ -0,0 +1,72 @@
+declare const constants: {
+    CONCURRENT_CALLS: number;
+    RULES_DIRECTORY: string;
+    RULES_STAGES: string[];
+    DEFAULT_RULE_STAGE: string;
+    HOOKS_HIDDEN_SECRET_VALUE: string;
+    OBFUSCATED_SECRET_VALUE: string;
+    HOOKS_DIRECTORY: string;
+    ACTIONS_DIRECTORY: string;
+    TRIGGERS_DIRECTORY: string;
+    RULES_CONFIGS_DIRECTORY: string;
+    PAGES_DIRECTORY: string;
+    PAGE_LOGIN: string;
+    PAGE_GUARDIAN_MULTIFACTOR: string;
+    PAGE_PASSWORD_RESET: string;
+    PAGE_ERROR: string;
+    DATABASE_CONNECTIONS_DIRECTORY: string;
+    DATABASE_SCRIPTS_CHANGE_EMAIL: string;
+    DATABASE_SCRIPTS_GET_USER: string;
+    EMAIL_TEMPLATES_TYPES: string[];
+    ACTIONS_TRIGGERS: string[];
+    EMAIL_TEMPLATES_DIRECTORY: string;
+    EMAIL_VERIFY: string;
+    EMAIL_VERIFY_BY_CODE: string;
+    EMAIL_RESET: string;
+    EMAIL_WELCOME: string;
+    EMAIL_BLOCKED: string;
+    EMAIL_STOLEN_CREDENTIALS: string;
+    EMAIL_ENROLLMENT: string;
+    EMAIL_CHANGE_PASSWORD: string;
+    EMAIL_PASSWORD_RESET: string;
+    EMAIL_MFA_OOB_CODE: string;
+    EMAIL_USER_INVITATION: string;
+    GUARDIAN_DIRECTORY: string;
+    GUARDIAN_FACTORS_DIRECTORY: string;
+    GUARDIAN_PROVIDERS_DIRECTORY: string;
+    GUARDIAN_TEMPLATES_DIRECTORY: string;
+    UNIVERSAL_LOGIN_TEMPLATE: string;
+    RESOURCE_SERVERS_DIRECTORY: string;
+    RESOURCE_SERVERS_CLIENT_NAME: string;
+    RESOURCE_SERVERS_MANAGEMENT_API_NAME: string;
+    RESOURCE_SERVERS_ID_NAME: string;
+    CLIENTS_DIRECTORY: string;
+    CLIENTS_GRANTS_DIRECTORY: string;
+    BRANDING_DIRECTORY: string;
+    BRANDING_TEMPLATES_DIRECTORY: string;
+    BRANDING_TEMPLATES_YAML_DIRECTORY: string;
+    CLIENTS_CLIENT_NAME: string;
+    CLIENTS_CLIENT_ID_NAME: string;
+    CONNECTIONS_DIRECTORY: string;
+    CONNECTIONS_CLIENT_NAME: string;
+    CONNECTIONS_ID_NAME: string;
+    ROLES_DIRECTORY: string;
+    ATTACK_PROTECTION_DIRECTORY: string;
+    GUARDIAN_FACTORS: string[];
+    GUARDIAN_POLICIES: string[];
+    GUARDIAN_PHONE_PROVIDERS: string[];
+    GUARDIAN_PHONE_MESSAGE_TYPES: string[];
+    GUARDIAN_FACTOR_TEMPLATES: string[];
+    GUARDIAN_FACTOR_PROVIDERS: {
+        sms: string[];
+        'push-notification': string[];
+    };
+    PAGE_NAMES: string[];
+    DATABASE_SCRIPTS: string[];
+    DATABASE_SCRIPTS_NO_IMPORT: string[];
+    DATABASE_SCRIPTS_IMPORT: string[];
+    EMAIL_TEMPLATES_NAMES: string[];
+    SUPPORTED_BRANDING_TEMPLATES: string[];
+    LOG_STREAMS_DIRECTORY: string;
+};
+export default constants;

package/lib/tools/constants.js

@@ -19,12 +19,14 @@ const EMAIL_PASSWORD_RESET = 'password_reset';
 const EMAIL_MFA_OOB_CODE = 'mfa_oob_code';
 const EMAIL_USER_INVITATION = 'user_invitation';
 const UNIVERSAL_LOGIN_TEMPLATE = 'universal_login';
+const OBFUSCATED_SECRET_VALUE = '_VALUE_NOT_SHOWN_';
 const constants = {
     CONCURRENT_CALLS: 5,
     RULES_DIRECTORY: 'rules',
     RULES_STAGES,
     DEFAULT_RULE_STAGE: RULES_STAGES[0],
-    HOOKS_HIDDEN_SECRET_VALUE: '_VALUE_NOT_SHOWN_',
+    HOOKS_HIDDEN_SECRET_VALUE: OBFUSCATED_SECRET_VALUE,
+    OBFUSCATED_SECRET_VALUE,
     HOOKS_DIRECTORY: 'hooks',
     ACTIONS_DIRECTORY: 'actions',
     TRIGGERS_DIRECTORY: 'triggers',
@@ -162,5 +164,6 @@ const constants = {
         `${EMAIL_USER_INVITATION}.html`,
     ],
     SUPPORTED_BRANDING_TEMPLATES: [UNIVERSAL_LOGIN_TEMPLATE],
+    LOG_STREAMS_DIRECTORY: 'log-streams',
 };
 exports.default = constants;

package/lib/tools/deploy.d.ts

@@ -0,0 +1,3 @@
+import { ConfigFunction } from '../configFactory';
+import { Assets, Auth0APIClient } from '../types';
+export default function deploy(assets: Assets, client: Auth0APIClient, config: ConfigFunction): Promise<{}>;

package/lib/tools/deploy.js

@@ -13,11 +13,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const auth0_1 = __importDefault(require("./auth0"));
-const logger_1 = __importDefault(require("./logger"));
+const logger_1 = __importDefault(require("../logger"));
 function deploy(assets, client, config) {
     return __awaiter(this, void 0, void 0, function* () {
         // Setup log level
-        logger_1.default.transports.console.level = process.env.AUTH0_DEBUG === 'true' ? 'debug' : 'info';
+        logger_1.default.level = process.env.AUTH0_DEBUG === 'true' ? 'debug' : 'info';
         logger_1.default.info('Getting access token for ' + config('AUTH0_CLIENT_ID') + '/' + config('AUTH0_DOMAIN'));
         const auth0 = new auth0_1.default(client, assets, config);
         // Validate Assets