@binance/common 2.0.1 → 2.1.0

package/dist/index.d.mts

@@ -492,13 +492,15 @@ interface AxiosRequestArgs {
  * Represents the arguments for a request.
  * @property {string} endpoint - The endpoint for the request.
  * @property {'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH'} method - The HTTP method for the request.
- * @property {Record<string, unknown>} params - The parameters for the request.
+ * @property {Record<string, unknown>} queryParams - The query parameters for the request.
+ * @property {Record<string, unknown>} bodyParams - The body parameters for the request.
  * @property {TimeUnit} [timeUnit] - The optional time unit for the request.
  */
 interface RequestArgs {
   endpoint: string;
   method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH';
-  params: Record<string, unknown>;
+  queryParams: Record<string, unknown>;
+  bodyParams: Record<string, unknown>;
   timeUnit?: TimeUnit;
 }
 //#endregion
@@ -559,7 +561,7 @@ declare const getSignature: (configuration: {
   apiSecret?: string;
   privateKey?: string | Buffer;
   privateKeyPassphrase?: string;
-}, queryParams: Record<string, unknown>) => string;
+}, queryParams: Record<string, unknown>, bodyParams?: Record<string, unknown>) => string;
 /**
  * Asserts that a function parameter exists and is not null or undefined.
  *
@@ -641,7 +643,7 @@ declare const parseRateLimitHeaders: (headers: RawAxiosResponseHeaders | AxiosRe
  * @param options - Additional request options (isSigned).
  * @returns A promise resolving to the response data object.
  */
-declare const sendRequest: <T>(configuration: ConfigurationRestAPI, endpoint: string, method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH", params?: Record<string, unknown>, timeUnit?: TimeUnit, options?: {
+declare const sendRequest: <T>(configuration: ConfigurationRestAPI, endpoint: string, method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH", queryParams?: Record<string, unknown>, bodyParams?: Record<string, unknown>, timeUnit?: TimeUnit, options?: {
   isSigned?: boolean;
 }) => Promise<RestApiResponse<T>>;
 /**

package/dist/index.d.ts

@@ -492,13 +492,15 @@ interface AxiosRequestArgs {
  * Represents the arguments for a request.
  * @property {string} endpoint - The endpoint for the request.
  * @property {'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH'} method - The HTTP method for the request.
- * @property {Record<string, unknown>} params - The parameters for the request.
+ * @property {Record<string, unknown>} queryParams - The query parameters for the request.
+ * @property {Record<string, unknown>} bodyParams - The body parameters for the request.
  * @property {TimeUnit} [timeUnit] - The optional time unit for the request.
  */
 interface RequestArgs {
   endpoint: string;
   method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH';
-  params: Record<string, unknown>;
+  queryParams: Record<string, unknown>;
+  bodyParams: Record<string, unknown>;
   timeUnit?: TimeUnit;
 }
 //#endregion
@@ -559,7 +561,7 @@ declare const getSignature: (configuration: {
   apiSecret?: string;
   privateKey?: string | Buffer;
   privateKeyPassphrase?: string;
-}, queryParams: Record<string, unknown>) => string;
+}, queryParams: Record<string, unknown>, bodyParams?: Record<string, unknown>) => string;
 /**
  * Asserts that a function parameter exists and is not null or undefined.
  *
@@ -641,7 +643,7 @@ declare const parseRateLimitHeaders: (headers: RawAxiosResponseHeaders | AxiosRe
  * @param options - Additional request options (isSigned).
  * @returns A promise resolving to the response data object.
  */
-declare const sendRequest: <T>(configuration: ConfigurationRestAPI, endpoint: string, method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH", params?: Record<string, unknown>, timeUnit?: TimeUnit, options?: {
+declare const sendRequest: <T>(configuration: ConfigurationRestAPI, endpoint: string, method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH", queryParams?: Record<string, unknown>, bodyParams?: Record<string, unknown>, timeUnit?: TimeUnit, options?: {
   isSigned?: boolean;
 }) => Promise<RestApiResponse<T>>;
 /**

package/dist/index.js

@@ -74,8 +74,8 @@ var RequestSigner = class {
 		}
 		throw new Error("Either 'apiSecret' or 'privateKey' must be provided for signed requests.");
 	}
-	sign(queryParams) {
-		const params = buildQueryString(queryParams);
+	sign(queryParams, bodyParams) {
+		const params = buildQueryString(queryParams) + (bodyParams ? buildQueryString(bodyParams) : "");
 		if (this.apiSecret) return crypto.default.createHmac("sha256", this.apiSecret).update(params).digest("hex");
 		if (this.keyObject && this.keyType) {
 			const data = Buffer.from(params);
@@ -175,13 +175,13 @@ function getTimestamp() {
 * @param queryParams - The query parameters to be signed.
 * @returns A string representing the generated signature.
 */
-const getSignature = function(configuration, queryParams) {
+const getSignature = function(configuration, queryParams, bodyParams) {
 	let signer = signerCache.get(configuration);
 	if (!signer) {
 		signer = new RequestSigner(configuration);
 		signerCache.set(configuration, signer);
 	}
-	return signer.sign(queryParams);
+	return signer.sign(queryParams, bodyParams);
 };
 /**
 * Asserts that a function parameter exists and is not null or undefined.
@@ -425,19 +425,33 @@ const parseRateLimitHeaders = function(headers) {
 * @param options - Additional request options (isSigned).
 * @returns A promise resolving to the response data object.
 */
-const sendRequest = function(configuration, endpoint, method, params = {}, timeUnit, options = {}) {
+const sendRequest = function(configuration, endpoint, method, queryParams = {}, bodyParams = {}, timeUnit, options = {}) {
 	const localVarUrlObj = new URL(endpoint, configuration?.basePath);
 	const localVarRequestOptions = {
 		method,
 		...configuration?.baseOptions
 	};
-	const localVarQueryParameter = { ...normalizeScientificNumbers(params) };
+	const localVarQueryParameter = { ...normalizeScientificNumbers(queryParams) };
+	const localVarBodyParameter = { ...normalizeScientificNumbers(bodyParams) };
 	if (options.isSigned) {
 		localVarQueryParameter["timestamp"] = getTimestamp();
-		const signature = getSignature(configuration, localVarQueryParameter);
+		const signature = getSignature(configuration, localVarQueryParameter, localVarBodyParameter);
 		if (signature) localVarQueryParameter["signature"] = signature;
 	}
 	setSearchParams(localVarUrlObj, localVarQueryParameter);
+	if (Object.keys(localVarBodyParameter).length > 0) {
+		const searchParams = new URLSearchParams();
+		for (const [key, value] of Object.entries(localVarBodyParameter)) {
+			if (value === null || value === void 0) continue;
+			const serializedValue = serializeValue(value);
+			searchParams.append(key, serializedValue);
+		}
+		localVarRequestOptions.data = searchParams.toString();
+		localVarRequestOptions.headers = {
+			...localVarRequestOptions.headers || {},
+			"Content-Type": "application/x-www-form-urlencoded"
+		};
+	}
 	if (timeUnit && localVarRequestOptions.headers) {
 		const _timeUnit = validateTimeUnit(timeUnit);
 		localVarRequestOptions.headers = {