@wildix/xbees-conversations-utils 4.0.2 → 4.1.0

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

@@ -1,28 +0,0 @@
-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_RETRY_AFTER_MS = 10000;
-export declare const DEFAULT_JITTER_MS = 150;
-export declare const RETRY_AFTER_BUFFER_MS = 1000;
-export declare const STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX = "stream-rate-limit-cooldown:";
-export declare const STREAM_BUDGET_COOLDOWN_KEY_PREFIX = "stream-budget-cooldown:";
-export declare const STREAM_RATE_LIMIT_OPTIONS_MARKER = "__xbsRateLimitOptions";
-export declare const STREAM_RATE_LIMIT_SOFT_COOLDOWN_KEY = "stream-rate-limit-soft-global";
-export declare const STREAM_RATE_LIMIT_METADATA_KEY_SUFFIX = ":meta";
-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 DEFAULT_OPTIONS: StreamRateLimitRetryOptions;

package/dist-types/streamRateLimitHandlingProxy/createRateLimitedStreamProxy.d.ts

@@ -1,11 +0,0 @@
-import { StreamChat } from 'stream-chat';
-import { StreamType } from '../stream';
-import { LoggerContext, MethodWithRateLimitOptions, RedisContext } from './types';
-export type RateLimited<T extends object> = {
-    [Key in keyof T]: MethodWithRateLimitOptions<T[Key]>;
-};
-/**
- * Creates a proxy around a Stream client that transparently applies rate-limit handling
- * to method calls and recursively wraps returned channel objects with the same behavior.
- */
-export declare function createRateLimitedStreamProxy(stream: StreamChat<StreamType>, context: LoggerContext & RedisContext): RateLimited<StreamChat<StreamType>>;

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

@@ -1,11 +0,0 @@
-/**
- * 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/streamRateLimitHandlingProxy/helpers/RedisCooldown.d.ts

@@ -1,11 +0,0 @@
-import { LoggerContext, RedisContext, RedisCooldownOptions } from '../types';
-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 getValue(cooldownKey: string, context: RedisContext & LoggerContext, options?: RedisCooldownOptions): Promise<string | undefined>;
-    static setValueWithRemainingMs(cooldownKey: string, value: string, cooldownMs: number, context: RedisContext & LoggerContext, options?: RedisCooldownOptions): Promise<void>;
-    static setRemainingMsWithValue(cooldownKey: string, valueKey: string, value: string, cooldownMs: number, context: RedisContext & LoggerContext, options?: RedisCooldownOptions): Promise<void>;
-    static clear(cooldownKey: string, context: RedisContext & LoggerContext, options?: RedisCooldownOptions): Promise<void>;
-}

package/dist-types/streamRateLimitHandlingProxy/helpers/createRateLimitExceededException.d.ts

@@ -1,10 +0,0 @@
-import { RateLimitExceededException } from '@wildix/xbees-conversations-client';
-import { RateLimitsInfo } from 'stream-chat';
-type Options = {
-    rateLimit?: RateLimitsInfo;
-    message?: string;
-    operation?: string;
-    retryAfterMs?: number;
-};
-export declare function createRateLimitExceededException(options?: Options): RateLimitExceededException;
-export {};

package/dist-types/streamRateLimitHandlingProxy/helpers/executeWithRateLimitHandling.d.ts

@@ -1,2 +0,0 @@
-import { LoggerContext, RedisContext, StreamOperationType, StreamRateLimitRetryOptions } from '../types';
-export declare function executeWithRateLimitHandling<T>(execute: () => Promise<T>, operation: StreamOperationType, context: LoggerContext & RedisContext, options: StreamRateLimitRetryOptions): Promise<T>;

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

@@ -1,4 +0,0 @@
-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/streamRateLimitHandlingProxy/helpers/isStreamChannelLike.d.ts

@@ -1,6 +0,0 @@
-/**
- * Detects Stream channel-like objects.
- * These objects should be correctly wrapped to keep rate-limit behavior
- * on methods returned from other proxied calls.
- */
-export declare function isStreamChannelLike(value: unknown): value is object;

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

@@ -1,9 +0,0 @@
-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 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/streamRateLimitHandlingProxy/helpers/processStreamRateLimitException.d.ts

@@ -1,3 +0,0 @@
-import { RateLimitExceededException } from '@wildix/xbees-conversations-client';
-import { Logger } from '@aws-lambda-powertools/logger';
-export declare function processStreamRateLimitException(error: unknown, logger: Logger): RateLimitExceededException | undefined;

package/dist-types/streamRateLimitHandlingProxy/helpers/processStreamRateLimitHeaders.d.ts

@@ -1,6 +0,0 @@
-import { LoggerContext, RedisContext, StreamHeaders } from '../types';
-/**
- * Applies soft global throttle from x-ratelimit-* headers to smooth bursts
- * before hard 429 throttling starts.
- */
-export declare function processStreamRateLimitHeaders(headers: StreamHeaders | undefined, context: LoggerContext & RedisContext): Promise<void>;

package/dist-types/streamRateLimitHandlingProxy/helpers/rateLimitSnapshot.d.ts

@@ -1,3 +0,0 @@
-import { StreamRateLimitSnapshot } from '../types';
-export declare function serializeRateLimitSnapshot(snapshot: StreamRateLimitSnapshot): string;
-export declare function parseRateLimitSnapshot(snapshot: string | null | undefined): StreamRateLimitSnapshot | undefined;

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

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

package/dist-types/streamRateLimitHandlingProxy/helpers/sleep.d.ts

@@ -1,2 +0,0 @@
-declare function sleep(ms: number): Promise<unknown>;
-export default sleep;

package/dist-types/streamRateLimitHandlingProxy/helpers/splitCallArgsAndOptions.d.ts

@@ -1,6 +0,0 @@
-import { ArgsAndOptions } from '../types';
-/**
- * Splits original call args and optional rate-limit options token.
- * If no token is provided, options fallback to an empty object.
- */
-export declare function splitCallArgsAndOptions(args: unknown[]): ArgsAndOptions;

package/dist-types/streamRateLimitHandlingProxy/index.d.ts

@@ -1,2 +0,0 @@
-export * from './createRateLimitedStreamProxy';
-export * from './withStreamRateLimitOptions';

package/dist-types/streamRateLimitHandlingProxy/types.d.ts

@@ -1,68 +0,0 @@
-import Redis from 'ioredis';
-import { StreamChat } from 'stream-chat';
-import { StreamChannel, StreamType } from '../stream';
-import { STREAM_RATE_LIMIT_OPTIONS_MARKER } from './constants';
-import { Logger } from '@aws-lambda-powertools/logger';
-export type StreamOperationType = keyof StreamChat<StreamType> | keyof StreamChannel;
-export interface StreamRateLimitRetryOptions {
-    enableCooldown: boolean;
-    maxAttempts: number;
-    maxDelayMs: number;
-    maxRetryableDelayMs: number;
-}
-export type StreamRateLimitOptionsToken = {
-    [STREAM_RATE_LIMIT_OPTIONS_MARKER]: Partial<StreamRateLimitRetryOptions>;
-};
-export type MethodWithRateLimitOptions<T> = T extends (...args: infer Args) => infer Result ? T & ((...args: [...Args, StreamRateLimitOptionsToken?]) => Result) : T;
-export type RedisContext = {
-    redis: Redis;
-};
-export type LoggerContext = {
-    logger: Logger;
-};
-export type ArgsAndOptions = {
-    callArgs: unknown[];
-    callOptions: Partial<StreamRateLimitRetryOptions>;
-};
-/** Optional Redis key namespace override for cooldown records. */
-export type RedisCooldownOptions = {
-    keyPrefix?: string;
-};
-/** Generic HTTP headers shape returned by the Stream SDK transport layer. */
-export type StreamHeaders = Record<string, unknown>;
-/** Parsed GetStream budget headers used to manage app-wide cooldown. */
-export type StreamBudgetHeaders = {
-    limitMs?: number;
-    remainingMs?: number;
-    usedMs?: number;
-};
-export type StreamRateLimitSnapshot = {
-    limit: number;
-    remaining: number;
-    reset: number;
-};
-/** Axios response shape used by budget interceptor. */
-export type StreamBudgetInterceptorResponse = {
-    headers?: StreamHeaders;
-};
-/** Axios error shape used by budget interceptor. */
-export type StreamBudgetInterceptorError = {
-    response?: StreamBudgetInterceptorResponse;
-};
-/** Minimal axios response interceptor manager contract required by this package. */
-export type AxiosResponseInterceptorManagerLike = {
-    use: (onFulfilled?: (response: StreamBudgetInterceptorResponse) => unknown | Promise<unknown>, onRejected?: (error: StreamBudgetInterceptorError) => unknown | Promise<unknown>) => unknown;
-};
-/** Minimal axios instance contract required to register budget interceptors. */
-export type AxiosLikeWithResponseInterceptors = {
-    interceptors?: {
-        response?: AxiosResponseInterceptorManagerLike;
-    };
-};
-/** Stream client variants where axios transport can be discovered. */
-export type StreamClientWithAxiosCandidates = {
-    axiosInstance?: unknown;
-    _client?: {
-        axiosInstance?: unknown;
-    };
-};

package/dist-types/streamRateLimitHandlingProxy/withStreamRateLimitOptions.d.ts

@@ -1,6 +0,0 @@
-import { StreamRateLimitOptionsToken, StreamRateLimitRetryOptions } from './types';
-/**
- * Creates a marker token that can be passed as the last argument to proxied Stream methods.
- * The proxy strips this token from original method args and uses it as per-call retry options.
- */
-export declare function withStreamRateLimitOptions(options: Partial<StreamRateLimitRetryOptions>): StreamRateLimitOptionsToken;