@wildix/xbees-conversations-utils 1.3.1 → 2.0.1

package/README.md

@@ -12,7 +12,3 @@ Utility helpers for working with x-bees conversations data.
   Shared Stream Chat types used by normalization helpers and downstream consumers.
 - `types`
   Localized conversation and presence-related TypeScript types.
-
-## Notes
-
-The Stream rate-limit handling proxy was moved into the dedicated `@wildix/stream-proxy` package.

package/dist-cjs/normalization.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeStreamChannelMembersUserPresencesToMap = exports.normalizeStreamChannelsUserPresencesToMap = exports.normalizeStreamChannelsUsers = exports.normalizeStreamChannelsUsersToMap = exports.normalizeStreamChannelUsersToMap = exports.normalizeStreamChannelUsers = exports.normalizeStreamChannelOwnReadIndicators = exports.normalizeStreamChannelReadIndicators = exports.normalizeStreamChannelReadIndicator = exports.localizeStreamChannel = exports.localizeStreamChannelsMembersToMapByChannelId = exports.localizeStreamChannelMembers = exports.localizeStreamMember = exports.normalizeStreamMember = exports.normalizeStreamChannel = exports.localizeStreamMessage = exports.normalizeStreamMessage = exports.normalizeStreamReaction = exports.localizeStreamUser = exports.normalizeStreamUser = void 0;
-const types_1 = require("./types");
 const xbees_conversations_client_1 = require("@wildix/xbees-conversations-client");
+const types_1 = require("./types");
 function normalizeStreamUser(streamUser) {
     return {
         id: streamUser.id,
@@ -60,7 +60,9 @@ function normalizeStreamMessage(streamMessage, channelId) {
         latestReactions,
         reactionCounts: reaction_counts || {},
         createdAt: streamMessage.created_at,
-        updatedAt: streamMessage.updated_at !== streamMessage.created_at && streamMessage.updated_at ? streamMessage.updated_at : undefined,
+        updatedAt: streamMessage.updated_at !== streamMessage.created_at && streamMessage.updated_at
+            ? streamMessage.updated_at
+            : undefined,
         user,
         quote,
         forward,
@@ -80,9 +82,13 @@ function localizeStreamMessage(streamMessage, channelId, userId) {
     const normalizedMessage = normalizeStreamMessage(streamMessage, channelId);
     const createdAt = new Date(normalizedMessage.createdAt);
     const updatedAt = normalizedMessage.updatedAt ? new Date(normalizedMessage.updatedAt) : undefined;
-    const latestReactions = streamMessage.latest_reactions ? streamMessage.latest_reactions.map(normalizeStreamReaction) : [];
+    const latestReactions = streamMessage.latest_reactions
+        ? streamMessage.latest_reactions.map(normalizeStreamReaction)
+        : [];
     const ownReactionsFromLatestReactions = latestReactions.filter((r) => userId === r.userId);
-    const ownReactions = streamMessage.own_reactions ? streamMessage.own_reactions.map(normalizeStreamReaction).filter((r) => userId === r.userId) : [];
+    const ownReactions = streamMessage.own_reactions
+        ? streamMessage.own_reactions.map(normalizeStreamReaction).filter((r) => userId === r.userId)
+        : [];
     ownReactionsFromLatestReactions.forEach((reaction) => {
         if (!ownReactions.find((ownReaction) => ownReaction.type === reaction.type)) {
             ownReactions.push(reaction);
@@ -112,7 +118,7 @@ function normalizeStreamChannel(channel) {
     if (!data) {
         throw new Error(`Illegal channel data`);
     }
-    let context = undefined;
+    let context;
     if (data.context) {
         try {
             if (typeof data.context === 'string') {
@@ -126,7 +132,7 @@ function normalizeStreamChannel(channel) {
             console.error('Context Issue: ', e);
         }
     }
-    let assignee = undefined;
+    let assignee;
     if (data.assignee) {
         assignee = data.assignee;
     }
@@ -188,7 +194,9 @@ exports.localizeStreamMember = localizeStreamMember;
 function localizeStreamChannelMembers(streamChannel) {
     const { state } = streamChannel;
     const wid = streamChannel.getClient().userID;
-    return Object.values(state.members).map(localizeStreamMember).filter((member) => member.id !== wid);
+    return Object.values(state.members)
+        .map(localizeStreamMember)
+        .filter((member) => member.id !== wid);
 }
 exports.localizeStreamChannelMembers = localizeStreamChannelMembers;
 function localizeStreamChannelsMembersToMapByChannelId(streamChannels) {
@@ -210,7 +218,9 @@ function localizeStreamChannel(streamChannel) {
     const userId = data?.type === xbees_conversations_client_1.ChannelType.DIRECT && members.length > 0 ? members[0].user_id : null;
     const unread = state.read[wid]?.unread_messages || 0;
     const lastMessage = streamChannel.lastMessage();
-    const normalizedLastMessage = lastMessage ? localizeStreamMessage(lastMessage, normalizedChannel.channelId, wid) : null;
+    const normalizedLastMessage = lastMessage
+        ? localizeStreamMessage(lastMessage, normalizedChannel.channelId, wid)
+        : null;
     const lastMessageAt = normalizedLastMessage ? normalizedLastMessage.createdAt : updatedAt || createdAt;
     const lastRead = state.read[wid]?.last_read || null;
     const role = state.membership.role || xbees_conversations_client_1.ChannelMemberRole.MEMBER;
@@ -245,7 +255,7 @@ function normalizeStreamChannelReadIndicator(channelReadStatus, channelId) {
 exports.normalizeStreamChannelReadIndicator = normalizeStreamChannelReadIndicator;
 function normalizeStreamChannelReadIndicators(streamChannel) {
     const wid = streamChannel.getClient().userID;
-    const { state: { read }, data } = streamChannel;
+    const { state: { read }, data, } = streamChannel;
     return Object.values(read)
         .filter(({ user }) => wid !== user.id)
         .map((readIndicator) => {
@@ -255,7 +265,7 @@ function normalizeStreamChannelReadIndicators(streamChannel) {
 exports.normalizeStreamChannelReadIndicators = normalizeStreamChannelReadIndicators;
 function normalizeStreamChannelOwnReadIndicators(streamChannel) {
     const wid = streamChannel.getClient().userID;
-    const { state: { read }, data } = streamChannel;
+    const { state: { read }, data, } = streamChannel;
     return Object.values(read)
         .filter(({ user }) => wid === user.id)
         .map((readIndicator) => {

package/dist-es/normalization.js

@@ -1,5 +1,5 @@
-import { MessageDirection, } from "./types";
-import { ChannelType, ChannelMemberRole, } from "@wildix/xbees-conversations-client";
+import { ChannelMemberRole, ChannelType, } from '@wildix/xbees-conversations-client';
+import { MessageDirection, } from './types';
 export function normalizeStreamUser(streamUser) {
     return {
         id: streamUser.id,
@@ -54,7 +54,9 @@ export function normalizeStreamMessage(streamMessage, channelId) {
         latestReactions,
         reactionCounts: reaction_counts || {},
         createdAt: streamMessage.created_at,
-        updatedAt: streamMessage.updated_at !== streamMessage.created_at && streamMessage.updated_at ? streamMessage.updated_at : undefined,
+        updatedAt: streamMessage.updated_at !== streamMessage.created_at && streamMessage.updated_at
+            ? streamMessage.updated_at
+            : undefined,
         user,
         quote,
         forward,
@@ -73,9 +75,13 @@ export function localizeStreamMessage(streamMessage, channelId, userId) {
     const normalizedMessage = normalizeStreamMessage(streamMessage, channelId);
     const createdAt = new Date(normalizedMessage.createdAt);
     const updatedAt = normalizedMessage.updatedAt ? new Date(normalizedMessage.updatedAt) : undefined;
-    const latestReactions = streamMessage.latest_reactions ? streamMessage.latest_reactions.map(normalizeStreamReaction) : [];
+    const latestReactions = streamMessage.latest_reactions
+        ? streamMessage.latest_reactions.map(normalizeStreamReaction)
+        : [];
     const ownReactionsFromLatestReactions = latestReactions.filter((r) => userId === r.userId);
-    const ownReactions = streamMessage.own_reactions ? streamMessage.own_reactions.map(normalizeStreamReaction).filter((r) => userId === r.userId) : [];
+    const ownReactions = streamMessage.own_reactions
+        ? streamMessage.own_reactions.map(normalizeStreamReaction).filter((r) => userId === r.userId)
+        : [];
     ownReactionsFromLatestReactions.forEach((reaction) => {
         if (!ownReactions.find((ownReaction) => ownReaction.type === reaction.type)) {
             ownReactions.push(reaction);
@@ -104,7 +110,7 @@ export function normalizeStreamChannel(channel) {
     if (!data) {
         throw new Error(`Illegal channel data`);
     }
-    let context = undefined;
+    let context;
     if (data.context) {
         try {
             if (typeof data.context === 'string') {
@@ -118,7 +124,7 @@ export function normalizeStreamChannel(channel) {
             console.error('Context Issue: ', e);
         }
     }
-    let assignee = undefined;
+    let assignee;
     if (data.assignee) {
         assignee = data.assignee;
     }
@@ -177,7 +183,9 @@ export function localizeStreamMember(member) {
 export function localizeStreamChannelMembers(streamChannel) {
     const { state } = streamChannel;
     const wid = streamChannel.getClient().userID;
-    return Object.values(state.members).map(localizeStreamMember).filter((member) => member.id !== wid);
+    return Object.values(state.members)
+        .map(localizeStreamMember)
+        .filter((member) => member.id !== wid);
 }
 export function localizeStreamChannelsMembersToMapByChannelId(streamChannels) {
     return streamChannels.reduce((accumulator, channel) => {
@@ -197,7 +205,9 @@ export function localizeStreamChannel(streamChannel) {
     const userId = data?.type === ChannelType.DIRECT && members.length > 0 ? members[0].user_id : null;
     const unread = state.read[wid]?.unread_messages || 0;
     const lastMessage = streamChannel.lastMessage();
-    const normalizedLastMessage = lastMessage ? localizeStreamMessage(lastMessage, normalizedChannel.channelId, wid) : null;
+    const normalizedLastMessage = lastMessage
+        ? localizeStreamMessage(lastMessage, normalizedChannel.channelId, wid)
+        : null;
     const lastMessageAt = normalizedLastMessage ? normalizedLastMessage.createdAt : updatedAt || createdAt;
     const lastRead = state.read[wid]?.last_read || null;
     const role = state.membership.role || ChannelMemberRole.MEMBER;
@@ -230,7 +240,7 @@ export function normalizeStreamChannelReadIndicator(channelReadStatus, channelId
 }
 export function normalizeStreamChannelReadIndicators(streamChannel) {
     const wid = streamChannel.getClient().userID;
-    const { state: { read }, data } = streamChannel;
+    const { state: { read }, data, } = streamChannel;
     return Object.values(read)
         .filter(({ user }) => wid !== user.id)
         .map((readIndicator) => {
@@ -239,7 +249,7 @@ export function normalizeStreamChannelReadIndicators(streamChannel) {
 }
 export function normalizeStreamChannelOwnReadIndicators(streamChannel) {
     const wid = streamChannel.getClient().userID;
-    const { state: { read }, data } = streamChannel;
+    const { state: { read }, data, } = streamChannel;
     return Object.values(read)
         .filter(({ user }) => wid === user.id)
         .map((readIndicator) => {

package/dist-types/normalization.d.ts

@@ -1,6 +1,6 @@
-import { StreamChannel, StreamMessageResponse, StreamReactionResponse, StreamUserResponse, StreamChannelResponse, StreamChannelMemberResponse, StreamReadIndicator } from "./stream";
-import { LocalizedMessage, LocalizedUser, LocalizedChannel, LocalizedChannelMember, LocalizedReadIndicator, UserPresence } from "./types";
-import { Channel, ChannelMember, Message, Reaction, User } from "@wildix/xbees-conversations-client";
+import { type Channel, type ChannelMember, type Message, type Reaction, type User } from '@wildix/xbees-conversations-client';
+import type { StreamChannel, StreamChannelMemberResponse, StreamChannelResponse, StreamMessageResponse, StreamReactionResponse, StreamReadIndicator, StreamUserResponse } from './stream';
+import { type LocalizedChannel, type LocalizedChannelMember, type LocalizedMessage, type LocalizedReadIndicator, type LocalizedUser, type UserPresence } from './types';
 export declare function normalizeStreamUser(streamUser: StreamUserResponse): User;
 export declare function localizeStreamUser(streamUser: StreamUserResponse): LocalizedUser;
 export declare function normalizeStreamReaction(streamReaction: StreamReactionResponse): Reaction;

package/dist-types/stream.d.ts

@@ -1,5 +1,5 @@
-import { Channel, ChannelData, ChannelState, ChannelFilters, ChannelMembership, ChannelMemberResponse, ChannelSort, ChannelResponse, Event, ExtendableGenerics, LiteralStringForUnion, Message, MessageResponse, ReactionResponse, SearchAPIResponse, SyncResponse, UR, UserResponse, GetRepliesAPIResponse, GetReactionsAPIResponse, OwnUserResponse, ChannelAPIResponse, User, Reaction, PartialMessageUpdate, UpdatedMessage, PartialUpdateChannel } from 'stream-chat';
-import { MessageQuote, MessageForward, MessageAttachment, MessageGiphy, User as NormalizedUser, ChannelAccess, MessageSmsStatus, MessageWhatsAppStatus, ChannelWhatsAppStatus, Element, ChannelContext } from "@wildix/xbees-conversations-client";
+import type { ChannelAccess, ChannelContext, ChannelWhatsAppStatus, Element, MessageAttachment, MessageForward, MessageGiphy, MessageQuote, MessageSmsStatus, MessageWhatsAppStatus, User as NormalizedUser } from '@wildix/xbees-conversations-client';
+import type { Channel, ChannelAPIResponse, ChannelData, ChannelFilters, ChannelMemberResponse, ChannelMembership, ChannelResponse, ChannelSort, ChannelState, Event, ExtendableGenerics, GetReactionsAPIResponse, GetRepliesAPIResponse, LiteralStringForUnion, Message, MessageResponse, OwnUserResponse, PartialMessageUpdate, PartialUpdateChannel, Reaction, ReactionResponse, SearchAPIResponse, SyncResponse, UpdatedMessage, UR, User, UserResponse } from 'stream-chat';
 export interface StreamChannelFields extends UR {
     subject?: string;
     description?: string;
@@ -114,4 +114,4 @@ export type StreamGetRepliesAPIResponse = GetRepliesAPIResponse<StreamType>;
 export type StreamOwnUserResponse = OwnUserResponse<StreamType>;
 export type StreamChannelState = ChannelState<StreamType>;
 export type StreamGetReactionsAPIResponse = GetReactionsAPIResponse<StreamType>;
-export type StreamReadIndicator = (StreamChannelState['read'])[keyof StreamChannelState['read']];
+export type StreamReadIndicator = StreamChannelState['read'][keyof StreamChannelState['read']];

package/dist-types/types.d.ts

@@ -1,4 +1,4 @@
-import { Channel, ChannelMember, ChannelMemberRole, Message, Reaction, User } from '@wildix/xbees-conversations-client';
+import type { Channel, ChannelMember, ChannelMemberRole, Message, Reaction, User } from '@wildix/xbees-conversations-client';
 export declare enum MessageDirection {
     INCOMING = "incoming",
     OUTGOING = "outgoing"

package/package.json

@@ -1,22 +1,22 @@
 {
   "name": "@wildix/xbees-conversations-utils",
-  "version": "1.3.1",
+  "version": "2.0.1",
   "description": "",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
   "scripts": {
-    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
+    "build": "concurrently 'pnpm run build:cjs' 'pnpm run build:es' 'pnpm run build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:es": "tsc -p tsconfig.es.json",
-    "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build",
+    "build:include:deps": "pnpm --filter \"$npm_package_name\"... run build",
     "build:types": "tsc -p tsconfig.types.json",
     "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",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
-    "lint": "eslint . && npm run check-types",
-    "lint:fix": "eslint . --fix",
+    "lint": "biome check . && pnpm run check-types",
+    "lint:fix": "biome check --write . && pnpm run check-types",
     "postpublish": "node ../../scripts/postpublish.js"
   },
   "engines": {
@@ -24,18 +24,16 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@wildix/xbees-conversations-client": "1.2.13",
+    "@wildix/xbees-conversations-client": "3.1.1",
     "stream-chat": "8.12.1",
-    "tslib": "2.5.0"
+    "tslib": "^2.6.2"
   },
   "devDependencies": {
     "@tsconfig/node18": "18.2.4",
     "@tsconfig/recommended": "1.0.1",
     "@types/uuid": "10.0.0",
-    "@wildix/eslint-config-style-guide": "1.2.1",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
-    "eslint": "8.57.1",
     "rimraf": "^3.0.0",
     "typescript": "~5.2.2"
   },

package/dist-cjs/rateLimits/RedisCooldown.js

@@ -1,66 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', {value: true});
-exports.RedisCooldown = void 0;
-const constants_1 = require('./constants');
-
-class RedisCooldown {
-  static async getRemainingMs(cooldownKey, context) {
-    const {redis, logger} = context;
-
-    try {
-      const ttlMs = await redis.pttl(`${constants_1.STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX}${cooldownKey}`);
-
-      if (ttlMs > 0) {
-        return ttlMs;
-      }
-    } catch (error) {
-      logger.warn('Failed to read stream rate-limit cooldown from Redis', {
-        cooldownKey,
-        error,
-      });
-    }
-
-    return 0;
-  }
-
-  static async setRemainingMs(cooldownKey, cooldownMs, context) {
-    if (cooldownMs <= 0) {
-      return;
-    }
-
-    const {redis, logger} = context;
-    const redisKey = `${constants_1.STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX}${cooldownKey}`;
-
-    try {
-      await redis.eval(
-        `
-        local key = KEYS[1]
-        local new_ttl = tonumber(ARGV[1])
-        local current_ttl = redis.call('PTTL', key)
-
-        if current_ttl == -2 then
-          redis.call('SET', key, '1', 'PX', new_ttl)
-          return 1
-        end
-
-        if current_ttl == -1 or current_ttl < new_ttl then
-          redis.call('PEXPIRE', key, new_ttl)
-          return 2
-        end
-
-        return 0
-      `,
-        1,
-        redisKey,
-        cooldownMs.toString(),
-      );
-    } catch (error) {
-      logger.warn('Failed to write stream rate-limit cooldown to Redis', {
-        cooldownKey,
-        cooldownMs,
-        error,
-      });
-    }
-  }
-}
-exports.RedisCooldown = RedisCooldown;

package/dist-cjs/rateLimits/constants.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_OPTIONS = exports.SOFT_THROTTLE_DELAY_HIGH_MS = exports.SOFT_THROTTLE_DELAY_MEDIUM_MS = exports.SOFT_THROTTLE_DELAY_LOW_MS = exports.SOFT_THROTTLE_USAGE_HIGH = exports.SOFT_THROTTLE_USAGE_MEDIUM = exports.SOFT_THROTTLE_USAGE_LOW = exports.BUDGET_COOLDOWN_SLEEP_CHUNK_MS = exports.BUDGET_MINIMAL_DELAY_MAX_MS = exports.BUDGET_MINIMAL_DELAY_MIN_MS = exports.BUDGET_RELAXED_DELAY_MAX_MS = exports.BUDGET_RELAXED_DELAY_MIN_MS = exports.BUDGET_RELAXED_USAGE_THRESHOLD = exports.BUDGET_CLEAR_USAGE_THRESHOLD = exports.BUDGET_DELAY_MAX_MS = exports.BUDGET_DELAY_MIN_MS = exports.BUDGET_THRESHOLD = exports.STREAM_BUDGET_COOLDOWN_KEY = exports.STREAM_RATE_LIMIT_METADATA_KEY_SUFFIX = exports.STREAM_RATE_LIMIT_SOFT_COOLDOWN_KEY = exports.STREAM_RATE_LIMIT_OPTIONS_MARKER = exports.STREAM_BUDGET_COOLDOWN_KEY_PREFIX = exports.STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX = exports.RETRY_AFTER_BUFFER_MS = exports.DEFAULT_JITTER_MS = exports.DEFAULT_RETRY_AFTER_MS = exports.DEFAULT_MAX_DELAY_MS = exports.STREAM_SYNC_METHOD_NAMES = exports.STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES = exports.STREAM_METHOD_NAMES = exports.STREAM_CHANNEL_RESULT_METHOD_NAMES = exports.CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES = exports.CHANNEL_SYNC_METHOD_NAMES = exports.CHANNEL_METHOD_NAMES = void 0;
-var generatedMethodNames_1 = require("./generatedMethodNames");
-Object.defineProperty(exports, "CHANNEL_METHOD_NAMES", { enumerable: true, get: function () { return generatedMethodNames_1.CHANNEL_METHOD_NAMES; } });
-Object.defineProperty(exports, "CHANNEL_SYNC_METHOD_NAMES", { enumerable: true, get: function () { return generatedMethodNames_1.CHANNEL_SYNC_METHOD_NAMES; } });
-Object.defineProperty(exports, "CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES", { enumerable: true, get: function () { return generatedMethodNames_1.CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES; } });
-Object.defineProperty(exports, "STREAM_CHANNEL_RESULT_METHOD_NAMES", { enumerable: true, get: function () { return generatedMethodNames_1.STREAM_CHANNEL_RESULT_METHOD_NAMES; } });
-Object.defineProperty(exports, "STREAM_METHOD_NAMES", { enumerable: true, get: function () { return generatedMethodNames_1.STREAM_METHOD_NAMES; } });
-Object.defineProperty(exports, "STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES", { enumerable: true, get: function () { return generatedMethodNames_1.STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES; } });
-Object.defineProperty(exports, "STREAM_SYNC_METHOD_NAMES", { enumerable: true, get: function () { return generatedMethodNames_1.STREAM_SYNC_METHOD_NAMES; } });
-exports.DEFAULT_MAX_DELAY_MS = 5000;
-exports.DEFAULT_RETRY_AFTER_MS = 10000;
-exports.DEFAULT_JITTER_MS = 150;
-exports.RETRY_AFTER_BUFFER_MS = 1000;
-exports.STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX = 'stream-rate-limit-cooldown:';
-exports.STREAM_BUDGET_COOLDOWN_KEY_PREFIX = 'stream-budget-cooldown:';
-exports.STREAM_RATE_LIMIT_OPTIONS_MARKER = '__xbsRateLimitOptions';
-exports.STREAM_RATE_LIMIT_SOFT_COOLDOWN_KEY = 'stream-rate-limit-soft-global';
-exports.STREAM_RATE_LIMIT_METADATA_KEY_SUFFIX = ':meta';
-exports.STREAM_BUDGET_COOLDOWN_KEY = 'stream-budget-global';
-exports.BUDGET_THRESHOLD = 0.8;
-exports.BUDGET_DELAY_MIN_MS = 30000;
-exports.BUDGET_DELAY_MAX_MS = 60000;
-exports.BUDGET_CLEAR_USAGE_THRESHOLD = 0.6;
-exports.BUDGET_RELAXED_USAGE_THRESHOLD = 0.7;
-exports.BUDGET_RELAXED_DELAY_MIN_MS = 5000;
-exports.BUDGET_RELAXED_DELAY_MAX_MS = 10000;
-exports.BUDGET_MINIMAL_DELAY_MIN_MS = 1000;
-exports.BUDGET_MINIMAL_DELAY_MAX_MS = 2000;
-exports.BUDGET_COOLDOWN_SLEEP_CHUNK_MS = 3000;
-exports.SOFT_THROTTLE_USAGE_LOW = 0.7;
-exports.SOFT_THROTTLE_USAGE_MEDIUM = 0.85;
-exports.SOFT_THROTTLE_USAGE_HIGH = 0.95;
-exports.SOFT_THROTTLE_DELAY_LOW_MS = 500;
-exports.SOFT_THROTTLE_DELAY_MEDIUM_MS = 1500;
-exports.SOFT_THROTTLE_DELAY_HIGH_MS = 3000;
-exports.DEFAULT_OPTIONS = {
-    maxAttempts: 3,
-    enableCooldown: true,
-    maxDelayMs: 5000,
-    maxRetryableDelayMs: 10000,
-};

package/dist-cjs/rateLimits/createRateLimitedStreamProxy.js

@@ -1,92 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRateLimitedStreamProxy = void 0;
-const constants_1 = require("./constants");
-const executeWithRateLimitHandling_1 = require("./helpers/executeWithRateLimitHandling");
-const isStreamChannelLike_1 = require("./helpers/isStreamChannelLike");
-const registerStreamInterceptors_1 = require("./helpers/registerStreamInterceptors");
-const splitCallArgsAndOptions_1 = require("./helpers/splitCallArgsAndOptions");
-const STREAM_SYNC_METHODS = new Set(constants_1.STREAM_SYNC_METHOD_NAMES);
-const STREAM_CHANNEL_RESULT_METHODS = new Set(constants_1.STREAM_CHANNEL_RESULT_METHOD_NAMES);
-const STREAM_SYNC_CHANNEL_RESULT_METHODS = new Set(constants_1.STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES);
-const CHANNEL_SYNC_METHODS = new Set(constants_1.CHANNEL_SYNC_METHOD_NAMES);
-const CHANNEL_SYNC_PROXY_RESULT_METHODS = new Set(constants_1.CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES);
-function wrapKnownChannelResult(result, dependencies) {
-    if (Array.isArray(result)) {
-        return result.map((item) => wrapKnownChannelResult(item, dependencies));
-    }
-    if (typeof result !== 'object' || result === null) {
-        return result;
-    }
-    return wrapTarget(result, dependencies);
-}
-function normalizeStreamCallResult(result, dependencies, wrapAsChannelResult = false) {
-    if (wrapAsChannelResult) {
-        return wrapKnownChannelResult(result, dependencies);
-    }
-    if (Array.isArray(result)) {
-        return result.map((item) => normalizeStreamCallResult(item, dependencies));
-    }
-    if (!(0, isStreamChannelLike_1.isStreamChannelLike)(result)) {
-        return result;
-    }
-    return wrapTarget(result, dependencies);
-}
-function createRateLimitedMethodWrapper(target, value, operation, dependencies, wrapAsChannelResult) {
-    return async (...args) => {
-        const { callArgs, callOptions } = (0, splitCallArgsAndOptions_1.splitCallArgsAndOptions)(args);
-        const result = await (0, executeWithRateLimitHandling_1.executeWithRateLimitHandling)(() => Reflect.apply(value, target, callArgs), operation, dependencies.context, {
-            ...constants_1.DEFAULT_OPTIONS,
-            ...callOptions,
-        });
-        return normalizeStreamCallResult(result, dependencies, wrapAsChannelResult);
-    };
-}
-function wrapTarget(target, dependencies) {
-    const cachedObject = dependencies.cache.get(target);
-    if (cachedObject) {
-        return cachedObject;
-    }
-    const proxy = new Proxy(target, {
-        get: (originalTarget, property, receiver) => {
-            const value = Reflect.get(originalTarget, property, receiver);
-            if (typeof property !== 'string' || typeof value !== 'function') {
-                return value;
-            }
-            if (STREAM_SYNC_CHANNEL_RESULT_METHODS.has(property)) {
-                return (...args) => {
-                    const { callArgs } = (0, splitCallArgsAndOptions_1.splitCallArgsAndOptions)(args);
-                    const result = Reflect.apply(value, originalTarget, callArgs);
-                    return normalizeStreamCallResult(result, dependencies, true);
-                };
-            }
-            if (CHANNEL_SYNC_PROXY_RESULT_METHODS.has(property)) {
-                return (...args) => {
-                    const { callArgs } = (0, splitCallArgsAndOptions_1.splitCallArgsAndOptions)(args);
-                    const result = Reflect.apply(value, originalTarget, callArgs);
-                    if (typeof result === 'object' && result !== null) {
-                        return wrapTarget(result, dependencies);
-                    }
-                    return result;
-                };
-            }
-            if (STREAM_SYNC_METHODS.has(property) || CHANNEL_SYNC_METHODS.has(property)) {
-                return (...args) => {
-                    const { callArgs } = (0, splitCallArgsAndOptions_1.splitCallArgsAndOptions)(args);
-                    return Reflect.apply(value, originalTarget, callArgs);
-                };
-            }
-            return createRateLimitedMethodWrapper(originalTarget, value, property, dependencies, STREAM_CHANNEL_RESULT_METHODS.has(property));
-        },
-    });
-    dependencies.cache.set(target, proxy);
-    return proxy;
-}
-function createRateLimitedStreamProxy(stream, context) {
-    (0, registerStreamInterceptors_1.registerStreamInterceptors)(stream, context);
-    return wrapTarget(stream, {
-        context,
-        cache: new WeakMap(),
-    });
-}
-exports.createRateLimitedStreamProxy = createRateLimitedStreamProxy;

package/dist-cjs/rateLimits/exception/createRateLimitExceededException.js

@@ -1,21 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', {value: true});
-exports.createRateLimitExceededException = void 0;
-const xbees_conversations_client_1 = require('@wildix/xbees-conversations-client');
-const constants_1 = require('../constants');
-
-function createRateLimitExceededException(options = {}) {
-  const {rateLimit, message, operation, retryAfterMs = constants_1.DEFAULT_RETRY_AFTER_MS} = options;
-  const defaultMessage = operation ? `Rate limit exceeded for ${operation}` : 'Rate limit exceeded';
-
-  return new xbees_conversations_client_1.RateLimitExceededException({
-    $metadata: {},
-    message: message || defaultMessage,
-    rateLimitRemaining: rateLimit?.remaining || 0,
-    retryAfter: rateLimit?.reset ? rateLimit.reset - Date.now() : retryAfterMs,
-    rateLimit: rateLimit?.limit?.toString() || 'unknown',
-    rateLimitReset: rateLimit?.reset || Date.now() + retryAfterMs,
-  });
-}
-
-exports.createRateLimitExceededException = createRateLimitExceededException;

package/dist-cjs/rateLimits/exception/processStreamRateLimitException.js

@@ -1,47 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', {value: true});
-exports.processStreamRateLimitException = void 0;
-const createRateLimitExceededException_1 = require('./createRateLimitExceededException');
-
-function isStreamException(error) {
-  return (
-    typeof error === 'object' &&
-    error !== null &&
-    'metadata' in error &&
-    typeof error.metadata === 'object' &&
-    error.metadata !== null &&
-    'responseCode' in error.metadata
-  );
-}
-
-function isStreamAPIException(error) {
-  return typeof error === 'object' && !!error.code;
-}
-
-function processStreamRateLimitException(error, logger) {
-  if (isStreamException(error) && error.metadata?.responseCode === 429) {
-    const rateLimit = error.metadata?.rateLimit;
-    logger.warn('Stream rate limit exceeded [StreamException]', {rateLimit});
-
-    return (0, createRateLimitExceededException_1.createRateLimitExceededException)({
-      rateLimit,
-      message: error.message || 'Rate limit exceeded',
-    });
-  }
-
-  if (isStreamAPIException(error) && (error.code === 429 || error.StatusCode === 429)) {
-    logger.warn('Stream rate limit exceeded [StreamAPIException]', {code: error.code, StatusCode: error.StatusCode});
-
-    return (0, createRateLimitExceededException_1.createRateLimitExceededException)({
-      message: error.message || 'Rate limit exceeded',
-    });
-  }
-
-  if (typeof error === 'object' && error !== null && 'status' in error && error.status === 429) {
-    logger.warn('Stream rate limit exceeded [error.status === 429]');
-
-    return (0, createRateLimitExceededException_1.createRateLimitExceededException)({message: 'Rate limit exceeded'});
-  }
-}
-
-exports.processStreamRateLimitException = processStreamRateLimitException;

package/dist-cjs/rateLimits/executeStreamRequestWithRateLimitHandling.js

@@ -1,94 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', {value: true});
-exports.executeStreamRequestWithRateLimitHandling = void 0;
-const promises_1 = require('node:timers/promises');
-const constants_1 = require('./constants');
-const createRateLimitExceededException_1 = require('./exception/createRateLimitExceededException');
-const processStreamRateLimitException_1 = require('./exception/processStreamRateLimitException');
-const RedisCooldown_1 = require('./RedisCooldown');
-
-function calculateRateLimitDelayMs(error, maxDelayMs) {
-  const retryAfterMs =
-    typeof error.retryAfter === 'number'
-      ? error.retryAfter + constants_1.RETRY_AFTER_BUFFER_MS
-      : constants_1.DEFAULT_RETRY_AFTER_MS;
-
-  if (retryAfterMs > 0) {
-    const jitterMs = Math.floor(Math.random() * constants_1.DEFAULT_JITTER_MS);
-
-    return Math.min(maxDelayMs, retryAfterMs + jitterMs);
-  }
-
-  return Math.min(maxDelayMs, constants_1.DEFAULT_FIXED_RATE_LIMIT_DELAY_MS);
-}
-
-async function executeStreamRequestWithRateLimitHandling(execute, operation, context, options = {}) {
-  const {logger, redis} = context;
-  const {enableCooldown, maxAttempts, maxDelayMs, maxRetryableDelayMs} = {
-    ...constants_1.DEFAULT_OPTS_1_ATTEMPT_NO_COOLDOWN,
-    ...options,
-  };
-  let attempt = 1;
-
-  if (enableCooldown) {
-    const cooldownMs = await RedisCooldown_1.RedisCooldown.getRemainingMs(operation, {redis, logger});
-
-    if (cooldownMs > 0) {
-      logger.warn('Skipping stream request due to active rate-limit cooldown', {
-        operation,
-        cooldown: cooldownMs,
-      });
-      throw (0, createRateLimitExceededException_1.createRateLimitExceededException)({
-        operation,
-        retryAfterMs: cooldownMs,
-      });
-    }
-  }
-
-  for (;;) {
-    try {
-      return await execute();
-    } catch (error) {
-      const rateLimitError = (0, processStreamRateLimitException_1.processStreamRateLimitException)(error, logger);
-
-      if (!rateLimitError) {
-        throw error;
-      }
-
-      const retryAfterMs = calculateRateLimitDelayMs(rateLimitError, maxDelayMs);
-
-      if (enableCooldown) {
-        await RedisCooldown_1.RedisCooldown.setRemainingMs(operation, retryAfterMs, {redis, logger});
-      }
-
-      if (attempt < maxAttempts && retryAfterMs <= maxRetryableDelayMs) {
-        logger.warn('Retrying stream request after rate limit', {
-          operation,
-          attempt,
-          maxAttempts,
-          retryAfterMs,
-          rateLimit: rateLimitError.rateLimit,
-          rateLimitRemaining: rateLimitError.rateLimitRemaining,
-          rateLimitReset: rateLimitError.rateLimitReset,
-        });
-        await (0, promises_1.setTimeout)(retryAfterMs);
-        attempt++;
-        continue;
-      }
-
-      logger.warn('Propagating stream rate limit w/o retry', {
-        operation,
-        attempt,
-        maxAttempts,
-        retryAfterMs,
-        maxRetryableDelayMs,
-        rateLimit: rateLimitError.rateLimit,
-        rateLimitRemaining: rateLimitError.rateLimitRemaining,
-        rateLimitReset: rateLimitError.rateLimitReset,
-      });
-      throw rateLimitError;
-    }
-  }
-}
-
-exports.executeStreamRequestWithRateLimitHandling = executeStreamRequestWithRateLimitHandling;