auth0-deploy-cli 8.38.0 → 8.40.0

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

@@ -74,6 +74,10 @@ const userAttributeProfiles = __importStar(require("./userAttributeProfiles"));
 const connectionProfiles = __importStar(require("./connectionProfiles"));
 const tokenExchangeProfiles = __importStar(require("./tokenExchangeProfiles"));
 const supplementalSignals = __importStar(require("./supplementalSignals"));
+const rateLimitPolicies = __importStar(require("./rateLimitPolicies"));
+const eventStreams = __importStar(require("./eventStreams"));
+const clientAuthCredentials = __importStar(require("./clientAuthCredentials"));
+const clientAuthCredentialsPre = __importStar(require("./clientAuthCredentialsPre"));
 const auth0ApiHandlers = {
     rules,
     rulesConfigs,
@@ -117,5 +121,11 @@ const auth0ApiHandlers = {
     connectionProfiles,
     tokenExchangeProfiles,
     supplementalSignals,
+    rateLimitPolicies,
+    eventStreams,
+    clientAuthCredentials,
+    // clientAuthCredentialsPre is a deploy-only pre-pass handler (order 40) — not a user-facing
+    // asset type so it is not in AssetTypes, but must be registered here to run during deploy.
+    ...{ clientAuthCredentialsPre },
 };
 exports.default = auth0ApiHandlers; // TODO: apply stronger types to schema properties

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

@@ -496,7 +496,7 @@ class PromptsHandler extends default_1.default {
             updatePayload = {
                 ...updatePrams,
                 rendering_mode: auth0_1.Management.AculRenderingModeEnum.Advanced,
-                default_head_tags_disabled: screenRenderer.default_head_tags_disabled || undefined,
+                default_head_tags_disabled: screenRenderer.default_head_tags_disabled ?? undefined,
                 head_tags: screenRenderer.head_tags,
             };
         }

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

@@ -0,0 +1,81 @@
+import { Management } from 'auth0';
+import DefaultAPIHandler from './default';
+import { Asset, Assets, CalculatedChanges } from '../../../types';
+export type RateLimitPolicyConfiguration = Management.RateLimitPolicyConfiguration;
+export type RateLimitPolicy = Management.RateLimitPolicy;
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            resource: {
+                type: string;
+                enum: "oauth_authentication_api"[];
+            };
+            consumer: {
+                type: string;
+                enum: "client"[];
+            };
+            consumer_selector: {
+                type: string;
+            };
+            configuration: {
+                type: string;
+                oneOf: ({
+                    required: string[];
+                    properties: {
+                        action: {
+                            type: string;
+                            enum: string[];
+                        };
+                        limit?: undefined;
+                        redirect_uri?: undefined;
+                    };
+                    additionalProperties: boolean;
+                } | {
+                    required: string[];
+                    properties: {
+                        action: {
+                            type: string;
+                            enum: string[];
+                        };
+                        limit: {
+                            type: string;
+                        };
+                        redirect_uri?: undefined;
+                    };
+                    additionalProperties: boolean;
+                } | {
+                    required: string[];
+                    properties: {
+                        action: {
+                            type: string;
+                            enum: string[];
+                        };
+                        limit: {
+                            type: string;
+                        };
+                        redirect_uri: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                })[];
+            };
+        };
+        required: string[];
+    };
+};
+export default class RateLimitPoliciesHandler extends DefaultAPIHandler {
+    existing: RateLimitPolicy[] | null;
+    constructor(config: DefaultAPIHandler);
+    objString(policy: RateLimitPolicy): string;
+    getType(): Promise<Asset | null>;
+    processChanges(assets: Assets): Promise<void>;
+    createRateLimitPolicy(policy: RateLimitPolicy): Promise<RateLimitPolicy>;
+    createRateLimitPolicies(creates: CalculatedChanges['create']): Promise<void>;
+    updateRateLimitPolicy(policy: RateLimitPolicy): Promise<void>;
+    updateRateLimitPolicies(updates: CalculatedChanges['update']): Promise<void>;
+    deleteRateLimitPolicy(policy: RateLimitPolicy): Promise<void>;
+    deleteRateLimitPolicies(data: Asset[]): Promise<void>;
+}

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

@@ -0,0 +1,203 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = void 0;
+const auth0_1 = require("auth0");
+const default_1 = __importDefault(require("./default"));
+const client_1 = require("../client");
+const utils_1 = require("../../utils");
+const logger_1 = __importDefault(require("../../../logger"));
+exports.schema = {
+    type: 'array',
+    items: {
+        type: 'object',
+        properties: {
+            resource: {
+                type: 'string',
+                enum: Object.values(auth0_1.Management.RateLimitPolicyResourceEnum),
+            },
+            consumer: {
+                type: 'string',
+                enum: Object.values(auth0_1.Management.RateLimitPolicyConsumerEnum),
+            },
+            consumer_selector: {
+                type: 'string',
+            },
+            configuration: {
+                type: 'object',
+                oneOf: [
+                    {
+                        required: ['action'],
+                        properties: {
+                            action: { type: 'string', enum: ['allow'] },
+                        },
+                        additionalProperties: false,
+                    },
+                    {
+                        required: ['action', 'limit'],
+                        properties: {
+                            action: { type: 'string', enum: ['block', 'log'] },
+                            limit: { type: 'number' },
+                        },
+                        additionalProperties: false,
+                    },
+                    {
+                        required: ['action', 'limit', 'redirect_uri'],
+                        properties: {
+                            action: { type: 'string', enum: ['redirect'] },
+                            limit: { type: 'number' },
+                            redirect_uri: { type: 'string' },
+                        },
+                        additionalProperties: false,
+                    },
+                ],
+            },
+        },
+        required: ['resource', 'consumer', 'consumer_selector', 'configuration'],
+    },
+};
+class RateLimitPoliciesHandler extends default_1.default {
+    constructor(config) {
+        super({
+            ...config,
+            type: 'rateLimitPolicies',
+            id: 'id',
+            identifiers: ['id', 'consumer_selector'],
+            stripCreateFields: ['id', 'created_at', 'updated_at'],
+            stripUpdateFields: [
+                'id',
+                'resource',
+                'consumer',
+                'consumer_selector',
+                'created_at',
+                'updated_at',
+            ],
+        });
+    }
+    objString(policy) {
+        return super.objString({
+            consumer_selector: policy.consumer_selector,
+            resource: policy.resource,
+        });
+    }
+    async getType() {
+        if (this.existing)
+            return this.existing;
+        try {
+            const rateLimitPolicies = await (0, client_1.paginate)(this.client.rateLimitPolicies.list, { checkpoint: true });
+            this.existing = rateLimitPolicies;
+            return this.existing;
+        }
+        catch (err) {
+            if (err.statusCode === 404 || err.statusCode === 501) {
+                return null;
+            }
+            if (err.statusCode === 403) {
+                logger_1.default.debug('Rate Limit Policies feature is not enabled for this tenant. Please contact Auth0 support to enable this feature.');
+                return null;
+            }
+            throw err;
+        }
+    }
+    async processChanges(assets) {
+        const { rateLimitPolicies } = assets;
+        if (!rateLimitPolicies)
+            return;
+        const { del, update, create } = await this.calcChanges(assets);
+        if ((0, utils_1.isDryRun)(this.config)) {
+            if (create.length === 0 && update.length === 0 && del.length === 0) {
+                return;
+            }
+        }
+        logger_1.default.debug(`Start processChanges for rateLimitPolicies [delete:${del.length}] [update:${update.length}], [create:${create.length}]`);
+        const changes = [{ del }, { create }, { update }];
+        await Promise.all(changes.map(async (change) => {
+            switch (true) {
+                case change.del && change.del.length > 0:
+                    await this.deleteRateLimitPolicies(change.del);
+                    break;
+                case change.create && change.create.length > 0:
+                    await this.createRateLimitPolicies(change.create);
+                    break;
+                case change.update && change.update.length > 0:
+                    await this.updateRateLimitPolicies(change.update);
+                    break;
+                default:
+                    break;
+            }
+        }));
+    }
+    async createRateLimitPolicy(policy) {
+        const created = await this.client.rateLimitPolicies.create(policy);
+        return created;
+    }
+    async createRateLimitPolicies(creates) {
+        await this.client.pool
+            .addEachTask({
+            data: creates || [],
+            generator: (item) => this.createRateLimitPolicy(item)
+                .then((data) => {
+                this.didCreate(data);
+                this.created += 1;
+            })
+                .catch((err) => {
+                throw new Error(`Problem creating ${this.type} ${this.objString(item)}\n${err}`);
+            }),
+        })
+            .promise();
+    }
+    async updateRateLimitPolicy(policy) {
+        const { id, configuration } = policy;
+        if (!id) {
+            throw new Error(`Missing id for ${this.type} ${this.objString(policy)}`);
+        }
+        await this.client.rateLimitPolicies.update(id, { configuration });
+    }
+    async updateRateLimitPolicies(updates) {
+        await this.client.pool
+            .addEachTask({
+            data: updates || [],
+            generator: (item) => this.updateRateLimitPolicy(item)
+                .then(() => {
+                this.didUpdate(item);
+                this.updated += 1;
+            })
+                .catch((err) => {
+                throw new Error(`Problem updating ${this.type} ${this.objString(item)}\n${err}`);
+            }),
+        })
+            .promise();
+    }
+    async deleteRateLimitPolicy(policy) {
+        if (!policy.id) {
+            throw new Error(`Missing id for ${this.type} ${this.objString(policy)}`);
+        }
+        await this.client.rateLimitPolicies.delete(policy.id);
+    }
+    async deleteRateLimitPolicies(data) {
+        if (this.config('AUTH0_ALLOW_DELETE') === 'true' ||
+            this.config('AUTH0_ALLOW_DELETE') === true) {
+            await this.client.pool
+                .addEachTask({
+                data: data || [],
+                generator: (item) => this.deleteRateLimitPolicy(item)
+                    .then(() => {
+                    this.didDelete(item);
+                    this.deleted += 1;
+                })
+                    .catch((err) => {
+                    throw new Error(`Problem deleting ${this.type} ${this.objString(item)}\n${err}`);
+                }),
+            })
+                .promise();
+        }
+        else {
+            logger_1.default.warn(`Detected the following ${this.type} should be deleted. Doing so may be destructive.\nYou can enable deletes by setting 'AUTH0_ALLOW_DELETE' to true in the config\n${data
+                .map((i) => this.objString(i))
+                .join('\n')}`);
+        }
+    }
+}
+exports.default = RateLimitPoliciesHandler;

package/lib/tools/constants.d.ts

@@ -90,5 +90,7 @@ declare const constants: {
     CONNECTION_PROFILES_DIRECTORY: string;
     TOKEN_EXCHANGE_PROFILES_DIRECTORY: string;
     SUPPLEMENTAL_SIGNALS_DIRECTORY: string;
+    RATE_LIMIT_POLICIES_DIRECTORY: string;
+    EVENT_STREAMS_DIRECTORY: string;
 };
 export default constants;

package/lib/tools/constants.js

@@ -220,5 +220,7 @@ const constants = {
     CONNECTION_PROFILES_DIRECTORY: 'connection-profiles',
     TOKEN_EXCHANGE_PROFILES_DIRECTORY: 'token-exchange-profiles',
     SUPPLEMENTAL_SIGNALS_DIRECTORY: 'supplemental-signals',
+    RATE_LIMIT_POLICIES_DIRECTORY: 'rate-limit-policies',
+    EVENT_STREAMS_DIRECTORY: 'event-streams',
 };
 exports.default = constants;

package/lib/types.d.ts

@@ -21,6 +21,8 @@ import { AttackProtection } from './tools/auth0/handlers/attackProtection';
 import { TokenExchangeProfile } from './tools/auth0/handlers/tokenExchangeProfiles';
 import { RiskAssessment } from './tools/auth0/handlers/riskAssessment';
 import { SupplementalSignals } from './tools/auth0/handlers/supplementalSignals';
+import { RateLimitPolicy } from './tools/auth0/handlers/rateLimitPolicies';
+import { EventStream } from './tools/auth0/handlers/eventStreams';
 type SharedPaginationParams = {
     checkpoint?: boolean;
     paginate?: boolean;
@@ -158,6 +160,8 @@ export type Assets = Partial<{
     userAttributeProfilesWithId: UserAttributeProfile[] | null;
     connectionProfiles: Asset[] | null;
     tokenExchangeProfiles: TokenExchangeProfile[] | null;
+    rateLimitPolicies: RateLimitPolicy[] | null;
+    eventStreams: EventStream[] | null;
 }>;
 export type CalculatedChanges = {
     del: Asset[];
@@ -178,7 +182,7 @@ export type DetailedDryRunChanges = {
         changes: DetailedDryRunChange[];
     };
 };
-export type AssetTypes = 'rules' | 'rulesConfigs' | 'hooks' | 'pages' | 'databases' | 'clientGrants' | 'resourceServers' | 'clients' | 'connections' | 'tenant' | 'emailProvider' | 'emailTemplates' | 'guardianFactors' | 'guardianFactorProviders' | 'guardianFactorTemplates' | 'guardianPhoneFactorMessageTypes' | 'guardianPhoneFactorSelectedProvider' | 'guardianPolicies' | 'roles' | 'actions' | 'actionModules' | 'organizations' | 'triggers' | 'attackProtection' | 'riskAssessment' | 'branding' | 'phoneProviders' | 'phoneTemplates' | 'logStreams' | 'prompts' | 'customDomains' | 'themes' | 'forms' | 'flows' | 'flowVaultConnections' | 'selfServiceProfiles' | 'networkACLs' | 'userAttributeProfiles' | 'connectionProfiles' | 'tokenExchangeProfiles' | 'supplementalSignals';
+export type AssetTypes = 'rules' | 'rulesConfigs' | 'hooks' | 'pages' | 'databases' | 'clientGrants' | 'resourceServers' | 'clients' | 'connections' | 'tenant' | 'emailProvider' | 'emailTemplates' | 'guardianFactors' | 'guardianFactorProviders' | 'guardianFactorTemplates' | 'guardianPhoneFactorMessageTypes' | 'guardianPhoneFactorSelectedProvider' | 'guardianPolicies' | 'roles' | 'actions' | 'actionModules' | 'organizations' | 'triggers' | 'attackProtection' | 'riskAssessment' | 'branding' | 'phoneProviders' | 'phoneTemplates' | 'logStreams' | 'prompts' | 'customDomains' | 'themes' | 'forms' | 'flows' | 'flowVaultConnections' | 'selfServiceProfiles' | 'networkACLs' | 'userAttributeProfiles' | 'connectionProfiles' | 'tokenExchangeProfiles' | 'supplementalSignals' | 'rateLimitPolicies' | 'eventStreams' | 'clientAuthCredentials';
 export type KeywordMappings = {
     [key: string]: (string | number)[] | string | number;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "8.38.0",
+  "version": "8.40.0",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {