@binance/common 2.1.0 → 2.1.1

package/dist/index.d.mts

@@ -529,6 +529,33 @@ declare function buildQueryString(params: Record<string, unknown>): string;
  * @returns A random string of 16 hexadecimal characters.
  */
 declare function randomString(): string;
+/**
+ * Generates a cryptographically secure random 32-bit unsigned integer.
+ *
+ * Uses the Web Crypto API to generate a random value between 0 and 4,294,967,295 (2^32 - 1).
+ *
+ * @returns A random 32-bit unsigned integer.
+ */
+declare function randomInteger(): number;
+/**
+ * Normalizes a stream ID to ensure it is valid, generating a random ID if needed.
+ *
+ * For string inputs:
+ * - Returns the input if it's a valid 32-character hexadecimal string (case-insensitive)
+ * - Otherwise, generates a new random hexadecimal string using `randomString()`
+ *
+ * For number inputs:
+ * - Returns the input if it's a finite, non-negative integer within the safe integer range
+ * - Otherwise, generates a new random integer using `randomInteger()`
+ *
+ * For null or undefined inputs:
+ * - Generates a new random hexadecimal string using `randomString()`
+ *
+ * @param id - The stream ID to normalize (string, number, null, or undefined).
+ * @param streamIdIsStrictlyNumber - Boolean forcing an id to be a number or not.
+ * @returns A valid stream ID as either a 32-character hexadecimal string or a safe integer.
+ */
+declare function normalizeStreamId(id: string | number | null | undefined, streamIdIsStrictlyNumber?: boolean): string | number;
 /**
  * Validates the provided time unit string and returns it if it is either 'MILLISECOND' or 'MICROSECOND'.
  *
@@ -968,6 +995,7 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
   private streamConnectionMap;
   protected configuration: ConfigurationWebsocketStreams;
   protected wsURL: string;
+  streamIdIsStrictlyNumber?: boolean;
   streamCallbackMap: Map<string, Set<(data: unknown) => void>>;
   logger: Logger;
   constructor(configuration: ConfigurationWebsocketStreams, connectionPool?: WebsocketConnection[]);
@@ -1040,7 +1068,7 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
    * @param id Optional subscription ID
    * @returns void
    */
-  subscribe(stream: string | string[], id?: string): void;
+  subscribe(stream: string | string[], id?: number | string): void;
   /**
    * Unsubscribes from one or multiple WebSocket streams
    * Handles both single and pool modes
@@ -1048,7 +1076,7 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
    * @param id Optional unsubscription ID
    * @returns void
    */
-  unsubscribe(stream: string | string[], id?: string): void;
+  unsubscribe(stream: string | string[], id?: number | string): void;
   /**
    * Checks if the specified stream is currently subscribed.
    * @param stream - The name of the stream to check.
@@ -1077,7 +1105,7 @@ interface WebsocketStream<T> {
  * @param {string} [id] Optional additional identifier
  * @returns {WebsocketStream<T>} A stream handler with methods to register callbacks and unsubscribe
  */
-declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: string): WebsocketStream<T>;
+declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: number | string): WebsocketStream<T>;
 //#endregion
-export { ALGO_REST_API_PROD_URL, AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL, MARGIN_TRADING_WS_STREAMS_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequestArgs, RequiredError, RestApiRateLimit, RestApiResponse, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, SendMessageOptions, ServerError, TimeUnit, TimerRecord, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketApiRateLimit, WebsocketApiResponse, WebsocketCommon, WebsocketConnection, WebsocketEventEmitter, WebsocketSendMsgConfig, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, parseCustomHeaders, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
+export { ALGO_REST_API_PROD_URL, AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL, MARGIN_TRADING_WS_STREAMS_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequestArgs, RequiredError, RestApiRateLimit, RestApiResponse, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, SendMessageOptions, ServerError, TimeUnit, TimerRecord, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketApiRateLimit, WebsocketApiResponse, WebsocketCommon, WebsocketConnection, WebsocketEventEmitter, WebsocketSendMsgConfig, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, normalizeStreamId, parseCustomHeaders, parseRateLimitHeaders, randomInteger, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.ts

@@ -529,6 +529,33 @@ declare function buildQueryString(params: Record<string, unknown>): string;
  * @returns A random string of 16 hexadecimal characters.
  */
 declare function randomString(): string;
+/**
+ * Generates a cryptographically secure random 32-bit unsigned integer.
+ *
+ * Uses the Web Crypto API to generate a random value between 0 and 4,294,967,295 (2^32 - 1).
+ *
+ * @returns A random 32-bit unsigned integer.
+ */
+declare function randomInteger(): number;
+/**
+ * Normalizes a stream ID to ensure it is valid, generating a random ID if needed.
+ *
+ * For string inputs:
+ * - Returns the input if it's a valid 32-character hexadecimal string (case-insensitive)
+ * - Otherwise, generates a new random hexadecimal string using `randomString()`
+ *
+ * For number inputs:
+ * - Returns the input if it's a finite, non-negative integer within the safe integer range
+ * - Otherwise, generates a new random integer using `randomInteger()`
+ *
+ * For null or undefined inputs:
+ * - Generates a new random hexadecimal string using `randomString()`
+ *
+ * @param id - The stream ID to normalize (string, number, null, or undefined).
+ * @param streamIdIsStrictlyNumber - Boolean forcing an id to be a number or not.
+ * @returns A valid stream ID as either a 32-character hexadecimal string or a safe integer.
+ */
+declare function normalizeStreamId(id: string | number | null | undefined, streamIdIsStrictlyNumber?: boolean): string | number;
 /**
  * Validates the provided time unit string and returns it if it is either 'MILLISECOND' or 'MICROSECOND'.
  *
@@ -968,6 +995,7 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
   private streamConnectionMap;
   protected configuration: ConfigurationWebsocketStreams;
   protected wsURL: string;
+  streamIdIsStrictlyNumber?: boolean;
   streamCallbackMap: Map<string, Set<(data: unknown) => void>>;
   logger: Logger;
   constructor(configuration: ConfigurationWebsocketStreams, connectionPool?: WebsocketConnection[]);
@@ -1040,7 +1068,7 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
    * @param id Optional subscription ID
    * @returns void
    */
-  subscribe(stream: string | string[], id?: string): void;
+  subscribe(stream: string | string[], id?: number | string): void;
   /**
    * Unsubscribes from one or multiple WebSocket streams
    * Handles both single and pool modes
@@ -1048,7 +1076,7 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
    * @param id Optional unsubscription ID
    * @returns void
    */
-  unsubscribe(stream: string | string[], id?: string): void;
+  unsubscribe(stream: string | string[], id?: number | string): void;
   /**
    * Checks if the specified stream is currently subscribed.
    * @param stream - The name of the stream to check.
@@ -1077,7 +1105,7 @@ interface WebsocketStream<T> {
  * @param {string} [id] Optional additional identifier
  * @returns {WebsocketStream<T>} A stream handler with methods to register callbacks and unsubscribe
  */
-declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: string): WebsocketStream<T>;
+declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: number | string): WebsocketStream<T>;
 //#endregion
-export { ALGO_REST_API_PROD_URL, AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL, MARGIN_TRADING_WS_STREAMS_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequestArgs, RequiredError, RestApiRateLimit, RestApiResponse, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, SendMessageOptions, ServerError, TimeUnit, TimerRecord, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketApiRateLimit, WebsocketApiResponse, WebsocketCommon, WebsocketConnection, WebsocketEventEmitter, WebsocketSendMsgConfig, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, parseCustomHeaders, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
+export { ALGO_REST_API_PROD_URL, AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL, MARGIN_TRADING_WS_STREAMS_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequestArgs, RequiredError, RestApiRateLimit, RestApiResponse, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, SendMessageOptions, ServerError, TimeUnit, TimerRecord, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketApiRateLimit, WebsocketApiResponse, WebsocketCommon, WebsocketConnection, WebsocketEventEmitter, WebsocketSendMsgConfig, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, normalizeStreamId, parseCustomHeaders, parseRateLimitHeaders, randomInteger, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -140,6 +140,42 @@ function randomString() {
 	return crypto.default.randomBytes(16).toString("hex");
 }
 /**
+* Generates a cryptographically secure random 32-bit unsigned integer.
+*
+* Uses the Web Crypto API to generate a random value between 0 and 4,294,967,295 (2^32 - 1).
+*
+* @returns A random 32-bit unsigned integer.
+*/
+function randomInteger() {
+	const array = new Uint32Array(1);
+	crypto.default.getRandomValues(array);
+	return array[0];
+}
+/**
+* Normalizes a stream ID to ensure it is valid, generating a random ID if needed.
+*
+* For string inputs:
+* - Returns the input if it's a valid 32-character hexadecimal string (case-insensitive)
+* - Otherwise, generates a new random hexadecimal string using `randomString()`
+*
+* For number inputs:
+* - Returns the input if it's a finite, non-negative integer within the safe integer range
+* - Otherwise, generates a new random integer using `randomInteger()`
+*
+* For null or undefined inputs:
+* - Generates a new random hexadecimal string using `randomString()`
+*
+* @param id - The stream ID to normalize (string, number, null, or undefined).
+* @param streamIdIsStrictlyNumber - Boolean forcing an id to be a number or not.
+* @returns A valid stream ID as either a 32-character hexadecimal string or a safe integer.
+*/
+function normalizeStreamId(id, streamIdIsStrictlyNumber) {
+	const isValidNumber = typeof id === "number" && Number.isFinite(id) && Number.isInteger(id) && id >= 0 && id <= Number.MAX_SAFE_INTEGER;
+	if (streamIdIsStrictlyNumber || typeof id === "number") return isValidNumber ? id : randomInteger();
+	if (typeof id === "string") return id && /^[0-9a-f]{32}$/i.test(id) ? id : randomString();
+	return randomString();
+}
+/**
 * Validates the provided time unit string and returns it if it is either 'MILLISECOND' or 'MICROSECOND'.
 *
 * @param timeUnit - The time unit string to be validated.
@@ -1446,6 +1482,7 @@ var WebsocketStreamsBase = class extends WebsocketCommon {
 	constructor(configuration, connectionPool = []) {
 		super(configuration, connectionPool);
 		this.streamConnectionMap = /* @__PURE__ */ new Map();
+		this.streamIdIsStrictlyNumber = false;
 		this.streamCallbackMap = /* @__PURE__ */ new Map();
 		this.logger = Logger.getInstance();
 		this.configuration = configuration;
@@ -1505,7 +1542,7 @@ var WebsocketStreamsBase = class extends WebsocketCommon {
 		const payload = {
 			method: "SUBSCRIBE",
 			params: streams,
-			id: id && /^[0-9a-f]{32}$/.test(id) ? id : randomString()
+			id: normalizeStreamId(id, this.streamIdIsStrictlyNumber)
 		};
 		this.logger.debug("SUBSCRIBE", payload);
 		this.send(JSON.stringify(payload), void 0, false, 0, connection);
@@ -1612,7 +1649,7 @@ var WebsocketStreamsBase = class extends WebsocketCommon {
 				const payload = {
 					method: "UNSUBSCRIBE",
 					params: [stream$1],
-					id: id && /^[0-9a-f]{32}$/.test(id) ? id : randomString()
+					id: normalizeStreamId(id, this.streamIdIsStrictlyNumber)
 				};
 				this.logger.debug("UNSUBSCRIBE", payload);
 				this.send(JSON.stringify(payload), void 0, false, 0, connection);
@@ -1742,8 +1779,10 @@ exports.getSignature = getSignature;
 exports.getTimestamp = getTimestamp;
 exports.httpRequestFunction = httpRequestFunction;
 exports.normalizeScientificNumbers = normalizeScientificNumbers;
+exports.normalizeStreamId = normalizeStreamId;
 exports.parseCustomHeaders = parseCustomHeaders;
 exports.parseRateLimitHeaders = parseRateLimitHeaders;
+exports.randomInteger = randomInteger;
 exports.randomString = randomString;
 exports.removeEmptyValue = removeEmptyValue;
 exports.replaceWebsocketStreamsPlaceholders = replaceWebsocketStreamsPlaceholders;