@wildix/xbees-conversations-utils 1.1.75 → 1.1.77

package/dist-es/rateLimits/helpers/processStreamRateLimitHeaders.js

@@ -1,31 +1,6 @@
 import { SOFT_THROTTLE_DELAY_HIGH_MS, SOFT_THROTTLE_DELAY_LOW_MS, SOFT_THROTTLE_DELAY_MEDIUM_MS, SOFT_THROTTLE_USAGE_HIGH, SOFT_THROTTLE_USAGE_LOW, SOFT_THROTTLE_USAGE_MEDIUM, STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX, STREAM_RATE_LIMIT_SOFT_COOLDOWN_KEY, } from '../constants';
+import { parseHeaderNumber } from './headerUtils';
 import { RedisCooldown } from './RedisCooldown';
-function parseHeaderNumber(value) {
-    if (typeof value === 'number' && Number.isFinite(value)) {
-        return value;
-    }
-    if (typeof value === 'string') {
-        const parsed = Number(value);
-        if (Number.isFinite(parsed)) {
-            return parsed;
-        }
-    }
-}
-function getHeaderCaseInsensitive(headers, key) {
-    if (!headers) {
-        return;
-    }
-    const direct = headers[key];
-    if (direct !== undefined) {
-        return direct;
-    }
-    const normalizedKey = key.toLowerCase();
-    for (const [headerKey, headerValue] of Object.entries(headers)) {
-        if (headerKey.toLowerCase() === normalizedKey) {
-            return headerValue;
-        }
-    }
-}
 function computeSoftThrottleDelayMs(limit, remaining) {
     if (limit <= 0) {
         return 0;
@@ -44,8 +19,8 @@ function computeSoftThrottleDelayMs(limit, remaining) {
 }
 export async function processStreamRateLimitHeaders(headers, context) {
     const { logger } = context;
-    const limit = parseHeaderNumber(getHeaderCaseInsensitive(headers, 'x-ratelimit-limit'));
-    const remaining = parseHeaderNumber(getHeaderCaseInsensitive(headers, 'x-ratelimit-remaining'));
+    const limit = parseHeaderNumber(headers ?? {}, 'x-ratelimit-limit');
+    const remaining = parseHeaderNumber(headers ?? {}, 'x-ratelimit-remaining');
     if (limit === undefined || remaining === undefined) {
         return;
     }
@@ -67,4 +42,5 @@ export async function processStreamRateLimitHeaders(headers, context) {
     await RedisCooldown.clear(STREAM_RATE_LIMIT_SOFT_COOLDOWN_KEY, context, {
         keyPrefix: STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX,
     });
+    logger.debug('Clearing soft stream rate-limit cooldown');
 }

package/dist-es/rateLimits/helpers/registerStreamInterceptors.js

@@ -0,0 +1,44 @@
+import { processStreamBudgetHeaders } from './processStreamBudgetHeaders';
+import { processStreamRateLimitHeaders } from './processStreamRateLimitHeaders';
+const attachedInterceptors = new WeakSet();
+function hasResponseInterceptors(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        typeof value.interceptors?.response?.use === 'function');
+}
+function resolveAxiosInstance(stream) {
+    if (hasResponseInterceptors(stream)) {
+        return stream;
+    }
+    if (typeof stream !== 'object' || stream === null) {
+        return;
+    }
+    const maybeStream = stream;
+    if (hasResponseInterceptors(maybeStream.axiosInstance)) {
+        return maybeStream.axiosInstance;
+    }
+    if (hasResponseInterceptors(maybeStream._client?.axiosInstance)) {
+        return maybeStream._client?.axiosInstance;
+    }
+}
+export function registerStreamInterceptors(stream, context) {
+    const { logger } = context;
+    const axiosInstance = resolveAxiosInstance(stream);
+    if (!axiosInstance || !axiosInstance.interceptors?.response?.use) {
+        logger.warn('Unable to register stream budget & rate limit interceptors: axios instance not found');
+        return;
+    }
+    if (attachedInterceptors.has(axiosInstance)) {
+        return;
+    }
+    axiosInstance.interceptors.response.use(async (response) => {
+        await processStreamBudgetHeaders(response?.headers, context);
+        await processStreamRateLimitHeaders(response?.headers, context);
+        return response;
+    }, async (error) => {
+        await processStreamBudgetHeaders(error?.response?.headers, context);
+        await processStreamRateLimitHeaders(error?.response?.headers, context);
+        return Promise.reject(error);
+    });
+    attachedInterceptors.add(axiosInstance);
+}

package/dist-types/rateLimits/constants.d.ts

@@ -1,4 +1,5 @@
 import { StreamRateLimitRetryOptions } from './types';
+export { CHANNEL_METHOD_NAMES, CHANNEL_SYNC_METHOD_NAMES, CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES, STREAM_CHANNEL_RESULT_METHOD_NAMES, STREAM_METHOD_NAMES, STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES, STREAM_SYNC_METHOD_NAMES, } from './generatedMethodNames';
 export declare const DEFAULT_MAX_DELAY_MS = 5000;
 export declare const DEFAULT_RETRY_AFTER_MS = 10000;
 export declare const DEFAULT_JITTER_MS = 150;
@@ -11,14 +12,17 @@ export declare const STREAM_BUDGET_COOLDOWN_KEY = "stream-budget-global";
 export declare const BUDGET_THRESHOLD = 0.8;
 export declare const BUDGET_DELAY_MIN_MS = 30000;
 export declare const BUDGET_DELAY_MAX_MS = 60000;
+export declare const BUDGET_CLEAR_USAGE_THRESHOLD = 0.6;
+export declare const BUDGET_RELAXED_USAGE_THRESHOLD = 0.7;
+export declare const BUDGET_RELAXED_DELAY_MIN_MS = 5000;
+export declare const BUDGET_RELAXED_DELAY_MAX_MS = 10000;
+export declare const BUDGET_MINIMAL_DELAY_MIN_MS = 1000;
+export declare const BUDGET_MINIMAL_DELAY_MAX_MS = 2000;
+export declare const BUDGET_COOLDOWN_SLEEP_CHUNK_MS = 3000;
 export declare const SOFT_THROTTLE_USAGE_LOW = 0.7;
 export declare const SOFT_THROTTLE_USAGE_MEDIUM = 0.85;
 export declare const SOFT_THROTTLE_USAGE_HIGH = 0.95;
 export declare const SOFT_THROTTLE_DELAY_LOW_MS = 500;
 export declare const SOFT_THROTTLE_DELAY_MEDIUM_MS = 1500;
 export declare const SOFT_THROTTLE_DELAY_HIGH_MS = 3000;
-export declare const STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES: readonly ["channel", "getChannelById", "getChannelByMembers", "hydrateActiveChannels"];
-export declare const STREAM_SYNC_METHOD_NAMES: readonly ["_addChannelConfig", "_buildWSPayload", "_callClientListeners", "_deleteUserMessageReference", "_enrichAxiosOptions", "_getConnectionID", "_getToken", "_handleClientEvent", "_handleUserEvent", "_hasConnectionID", "_isUsingServerAuth", "_logApiError", "_logApiRequest", "_logApiResponse", "_muteStatus", "_normalizeDate", "_normalizeExpiration", "_sayHi", "_setUser", "_startCleaning", "_updateMemberWatcherReferences", "_updateUserMessageReferences", "_updateUserReferences", "_validateAndGetMessageId", "createAbortControllerForNextRequest", "createToken", "devToken", "dispatchEvent", "errorFromResponse", "getAuthType", "getUserAgent", "handleEvent", "handleResponse", "off", "on", "setBaseURL", "setLocalDevice", "setUserAgent", "userMuteStatus", "verifyWebhook"];
-export declare const CHANNEL_SYNC_METHOD_NAMES: readonly ["_channelURL", "countUnread", "countUnreadMentions", "getConfig", "lastMessage", "lastRead", "muteStatus", "off", "on"];
-export declare const CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES: readonly ["getClient"];
 export declare const DEFAULT_OPTIONS: StreamRateLimitRetryOptions;

package/dist-types/rateLimits/generatedMethodNames.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file is auto-generated by `scripts/generateRateLimitMethodNames.mjs`.
+ * Do not edit manually.
+ */
+export declare const STREAM_METHOD_NAMES: readonly ["_addChannelConfig", "_buildWSPayload", "_callClientListeners", "_createImport", "_createImportURL", "_deleteUserMessageReference", "_enrichAxiosOptions", "_getConnectionID", "_getImport", "_getToken", "_handleClientEvent", "_handleUserEvent", "_hasConnectionID", "_isUsingServerAuth", "_listImports", "_logApiError", "_logApiRequest", "_logApiResponse", "_muteStatus", "_normalizeDate", "_normalizeExpiration", "_queryFlagReports", "_queryFlags", "_reviewFlagReport", "_sayHi", "_setToken", "_setupConnection", "_setUser", "_startCleaning", "_unblockMessage", "_updateMemberWatcherReferences", "_updateUserMessageReferences", "_updateUserReferences", "_validateAndGetMessageId", "addDevice", "banUser", "channel", "closeConnection", "commitMessage", "connect", "connectAnonymousUser", "connectUser", "createAbortControllerForNextRequest", "createBlockList", "createCampaign", "createChannelType", "createCommand", "createPermission", "createRole", "createSegment", "createToken", "deactivateUser", "deactivateUsers", "delete", "deleteBlockList", "deleteCampaign", "deleteChannels", "deleteChannelType", "deleteCommand", "deleteMessage", "deletePermission", "deletePushProvider", "deleteRole", "deleteSegment", "deleteUser", "deleteUsers", "devToken", "disconnect", "disconnectUser", "dispatchEvent", "doAxiosRequest", "enrichURL", "errorFromResponse", "exportChannel", "exportChannels", "exportUser", "exportUsers", "flagMessage", "flagUser", "get", "getAppSettings", "getAuthType", "getBlockList", "getCallToken", "getChannelById", "getChannelByMembers", "getChannelType", "getCommand", "getDevices", "getExportChannelStatus", "getMessage", "getPermission", "getRateLimits", "getTask", "getUnreadCount", "getUserAgent", "handleEvent", "handleResponse", "hydrateActiveChannels", "listBlockLists", "listChannelTypes", "listCommands", "listPermissions", "listPushProviders", "listRoles", "markAllRead", "markChannelsRead", "muteUser", "off", "on", "openConnection", "partialUpdateMessage", "partialUpdateUser", "partialUpdateUsers", "patch", "pinMessage", "post", "put", "queryBannedUsers", "queryCampaigns", "queryChannels", "queryMessageFlags", "queryRecipients", "querySegments", "queryUsers", "reactivateUser", "reactivateUsers", "recoverState", "removeDevice", "removeShadowBan", "restoreUsers", "resumeCampaign", "revokeTokens", "revokeUsersToken", "revokeUserToken", "scheduleCampaign", "search", "sendFile", "sendUserCustomEvent", "setAnonymousUser", "setBaseURL", "setGuestUser", "setLocalDevice", "setUser", "setUserAgent", "shadowBan", "stopCampaign", "sync", "testCampaign", "testPushSettings", "testSQSSettings", "translateMessage", "unbanUser", "unblockMessage", "unflagMessage", "unflagUser", "unmuteUser", "unpinMessage", "updateAppSettings", "updateBlockList", "updateCampaign", "updateChannelType", "updateCommand", "updateMessage", "updatePermission", "updateSegment", "updateUser", "updateUsers", "upsertPushProvider", "upsertUser", "upsertUsers", "userMuteStatus", "verifyWebhook"];
+export declare const STREAM_SYNC_METHOD_NAMES: readonly ["_addChannelConfig", "_buildWSPayload", "_callClientListeners", "_deleteUserMessageReference", "_enrichAxiosOptions", "_getConnectionID", "_getToken", "_handleClientEvent", "_handleUserEvent", "_hasConnectionID", "_isUsingServerAuth", "_logApiError", "_logApiRequest", "_logApiResponse", "_muteStatus", "_normalizeDate", "_normalizeExpiration", "_sayHi", "_setUser", "_startCleaning", "_updateMemberWatcherReferences", "_updateUserMessageReferences", "_updateUserReferences", "_validateAndGetMessageId", "createAbortControllerForNextRequest", "createToken", "devToken", "dispatchEvent", "errorFromResponse", "getAuthType", "getUserAgent", "handleEvent", "handleResponse", "off", "on", "setBaseURL", "setLocalDevice", "setUserAgent", "userMuteStatus", "verifyWebhook"];
+export declare const STREAM_CHANNEL_RESULT_METHOD_NAMES: readonly ["channel", "getChannelById", "getChannelByMembers", "hydrateActiveChannels", "queryChannels"];
+export declare const STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES: readonly ["channel", "getChannelById", "getChannelByMembers", "hydrateActiveChannels"];
+export declare const CHANNEL_METHOD_NAMES: readonly ["_callChannelListeners", "_channelURL", "_checkInitialized", "_countMessageAsUnread", "_disconnect", "_extendEventWithOwnReactions", "_handleChannelEvent", "_initializeState", "_update", "acceptInvite", "addMembers", "addModerators", "assignRoles", "banUser", "clean", "countUnread", "countUnreadMentions", "create", "createCall", "delete", "deleteFile", "deleteImage", "deleteReaction", "demoteModerators", "disableSlowMode", "enableSlowMode", "getClient", "getConfig", "getMessagesById", "getPinnedMessages", "getReactions", "getReplies", "hide", "inviteMembers", "keystroke", "lastMessage", "lastRead", "markRead", "markUnread", "mute", "muteStatus", "off", "on", "query", "queryMembers", "rejectInvite", "removeMembers", "removeShadowBan", "search", "sendAction", "sendEvent", "sendFile", "sendImage", "sendMessage", "sendReaction", "shadowBan", "show", "stopTyping", "stopWatching", "truncate", "unbanUser", "unmute", "update", "updatePartial", "watch"];
+export declare const CHANNEL_SYNC_METHOD_NAMES: readonly ["_callChannelListeners", "_channelURL", "_checkInitialized", "_countMessageAsUnread", "_disconnect", "_extendEventWithOwnReactions", "_handleChannelEvent", "_initializeState", "clean", "countUnread", "countUnreadMentions", "getConfig", "lastMessage", "lastRead", "muteStatus", "off", "on"];
+export declare const CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES: readonly ["getClient"];

package/dist-types/rateLimits/helpers/RedisCooldown.d.ts

@@ -3,5 +3,6 @@ export declare class RedisCooldown {
     private static resolveRedisKey;
     static getRemainingMs(cooldownKey: string, context: RedisContext & LoggerContext, options?: RedisCooldownOptions): Promise<number>;
     static setRemainingMs(cooldownKey: string, cooldownMs: number, context: RedisContext & LoggerContext, options?: RedisCooldownOptions): Promise<void>;
+    static setRemainingMsExact(cooldownKey: string, cooldownMs: number, context: RedisContext & LoggerContext, options?: RedisCooldownOptions): Promise<void>;
     static clear(cooldownKey: string, context: RedisContext & LoggerContext, options?: RedisCooldownOptions): Promise<void>;
 }

package/dist-types/rateLimits/helpers/headerUtils.d.ts

@@ -0,0 +1,4 @@
+import { StreamHeaders } from '../types';
+export declare function getHeaderCaseInsensitive(headers: StreamHeaders | Record<string, unknown> | undefined, key: string): unknown;
+export declare function parseHeaderNumber(headers: StreamHeaders | Record<string, unknown>, key: string): number | undefined;
+export declare function normalizeResetToEpochMs(reset: number): number;

package/dist-types/rateLimits/helpers/processStreamBudgetHeaders.d.ts

@@ -2,7 +2,8 @@ import { LoggerContext, RedisContext, StreamHeaders } from '../types';
 /**
  * Updates app-wide Stream budget cooldown in Redis based on x-budget-* headers.
  * - If budget usage reaches the threshold (>=80%), enables cooldown for 30-60s.
- * - If headers indicate usage is below threshold, disables existing cooldown.
+ * - If usage is between 60% and 80%, keeps a shorter cooldown.
+ * - If usage drops below 60%, clears cooldown.
  * - If headers are missing/invalid, leaves current cooldown unchanged.
  */
 export declare function processStreamBudgetHeaders(headers: StreamHeaders | undefined, context: LoggerContext & RedisContext): Promise<void>;

package/dist-types/rateLimits/helpers/registerStreamInterceptors.d.ts

@@ -0,0 +1,2 @@
+import { LoggerContext, RedisContext } from '../types';
+export declare function registerStreamInterceptors(stream: unknown, context: LoggerContext & RedisContext): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-conversations-utils",
-  "version": "1.1.75",
+  "version": "1.1.77",
   "description": "",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -14,6 +14,7 @@
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "build:api-extractor": "mkdir -p etc && api-extractor run --local --verbose",
     "check-types": "tsc --noemit",
+    "generate:rate-limit-method-names": "node ./scripts/generateRateLimitMethodNames.mjs",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
     "lint": "eslint . && npm run check-types",
     "lint:fix": "eslint . --fix",