gateio-api 1.1.11 → 1.2.0

package/dist/mjs/lib/websocket/WsStore.types.js

@@ -6,6 +6,6 @@ export var WsConnectionStateEnum;
     WsConnectionStateEnum[WsConnectionStateEnum["CLOSING"] = 3] = "CLOSING";
     WsConnectionStateEnum[WsConnectionStateEnum["RECONNECTING"] = 4] = "RECONNECTING";
     // ERROR_RECONNECTING = 5,
-    // ERROR = 5,
+    WsConnectionStateEnum[WsConnectionStateEnum["ERROR"] = 5] = "ERROR";
 })(WsConnectionStateEnum || (WsConnectionStateEnum = {}));
 //# sourceMappingURL=WsStore.types.js.map

package/dist/mjs/lib/websocket/WsStore.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"WsStore.types.js","sourceRoot":"","sources":["../../../../src/lib/websocket/WsStore.types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,6EAAc,CAAA;IACd,2EAAa,CAAA;IACb,uEAAW,CAAA;IACX,iFAAgB,CAAA;IAChB,0BAA0B;IAC1B,aAAa;AACf,CAAC,EARW,qBAAqB,KAArB,qBAAqB,QAQhC"}
+{"version":3,"file":"WsStore.types.js","sourceRoot":"","sources":["../../../../src/lib/websocket/WsStore.types.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,6EAAc,CAAA;IACd,2EAAa,CAAA;IACb,uEAAW,CAAA;IACX,iFAAgB,CAAA;IAChB,0BAA0B;IAC1B,mEAAS,CAAA;AACX,CAAC,EARW,qBAAqB,KAArB,qBAAqB,QAQhC"}

package/dist/mjs/types/websockets/wsAPI.d.ts

@@ -1,9 +1,8 @@
 import { WsKey } from '../../lib/websocket/websocket-util.js';
-import { GetFuturesOrdersReq, SubmitFuturesOrderReq, UpdateFuturesOrderReq } from '../request/futures.js';
-import { CancelSpotBatchOrdersReq, DeleteSpotOrderReq, GetSpotOrderReq, SubmitSpotOrderReq, UpdateSpotOrderReq } from '../request/spot.js';
-export type SpotWSAPITopic = 'spot.login' | 'spot.order_place' | 'spot.order_cancel' | 'spot.order_cancel_ids' | 'spot.order_cancel_cp' | 'spot.order_amend' | 'spot.order_status';
-export type FuturesWSAPITopic = 'futures.login' | 'futures.order_place' | 'futures.order_batch_place' | 'futures.order_cancel' | 'futures.order_cancel_cp' | 'futures.order_amend' | 'futures.order_list' | 'futures.order_status';
+export type SpotWSAPITopic = 'spot.login' | 'spot.order_place' | 'spot.order_cancel' | 'spot.order_cancel_ids' | 'spot.order_cancel_cp' | 'spot.order_amend' | 'spot.order_status' | 'spot.order_list';
+export type FuturesWSAPITopic = 'futures.login' | 'futures.order_place' | 'futures.order_batch_place' | 'futures.order_cancel' | 'futures.order_cancel_cp' | 'futures.order_amend' | 'futures.order_list' | 'futures.order_status' | 'futures.order_cancel_ids';
 export type WSAPITopic = SpotWSAPITopic | FuturesWSAPITopic;
+export type WSAPIWsKey = keyof WsAPIWsKeyTopicMap;
 export interface WsAPIWsKeyTopicMap {
     spotV4: SpotWSAPITopic;
     perpFuturesUSDTV4: FuturesWSAPITopic;
@@ -14,26 +13,21 @@ export interface WsAPIWsKeyTopicMap {
 export interface WsAPITopicRequestParamMap {
     'spot.login': undefined;
     'futures.login': undefined;
-    'spot.order_place': SubmitSpotOrderReq;
-    'spot.order_cancel': DeleteSpotOrderReq;
-    'spot.order_cancel_ids': CancelSpotBatchOrdersReq[];
-    'spot.order_cancel_cp': DeleteSpotOrderReq[];
-    'spot.order_amend': UpdateSpotOrderReq;
-    'spot.order_status': GetSpotOrderReq;
-    'futures.order_place': Omit<SubmitFuturesOrderReq, 'settle'>;
-    'futures.order_batch_place': Omit<SubmitFuturesOrderReq, 'settle'>[];
-    'futures.order_cancel': {
-        order_id: string;
-    };
-    'futures.order_cancel_cp': {
-        contract: string;
-        side?: 'ask' | 'bid';
-    };
-    'futures.order_amend': Omit<UpdateFuturesOrderReq, 'settle'>;
-    'futures.order_list': Omit<GetFuturesOrdersReq, 'settle'>;
-    'futures.order_status': {
-        order_id: string;
-    };
+    'spot.order_place': WSAPISpotOrderPlaceReq;
+    'spot.order_cancel': WSAPISpotOrderCancelReq;
+    'spot.order_cancel_ids': WSAPISpotOrderCancelIdsReq[];
+    'spot.order_cancel_cp': WSAPISpotOrderCancelCPReq;
+    'spot.order_amend': WSAPISpotOrderAmendReq;
+    'spot.order_status': WSAPISpotOrderStatusReq;
+    'spot.order_list': WSAPISpotOrderListReq;
+    'futures.order_place': WSAPIFuturesOrderPlaceReq;
+    'futures.order_batch_place': WSAPIFuturesOrderPlaceReq[];
+    'futures.order_cancel': WSAPIFuturesOrderCancelReq;
+    'futures.order_cancel_ids': string[];
+    'futures.order_cancel_cp': WSAPIFuturesOrderCancelCPReq;
+    'futures.order_amend': WSAPIFuturesOrderAmendReq;
+    'futures.order_list': WSAPIFuturesOrderListReq;
+    'futures.order_status': WSAPIFuturesOrderStatusReq;
 }
 export type WsAPITopicRequestParams = WsAPITopicRequestParamMap[keyof WsAPITopicRequestParamMap];
 export interface WSAPIResponseHeader<TChannel extends WSAPITopic> {
@@ -73,22 +67,24 @@ export interface WSAPIOrderStatusResponse {
     create_time_ms: number;
 }
 export type WSAPIResponseData = WSAPILoginResponse | WSAPIOrderStatusResponse;
-export interface WsAPITopicResponseMap<TResponseType extends object = object> {
+export interface WsAPITopicResponseMap {
     'spot.login': WSAPIResponse<WSAPILoginResponse, 'spot.login'>;
     'futures.login': WSAPIResponse<WSAPILoginResponse, 'futures.login'>;
-    'spot.order_place': WSAPIResponse<TResponseType, 'spot.order_place'>;
-    'spot.order_cancel': WSAPIResponse<TResponseType, 'spot.order_cancel'>;
-    'spot.order_cancel_ids': WSAPIResponse<TResponseType, 'spot.order_cancel_ids'>;
-    'spot.order_cancel_cp': WSAPIResponse<TResponseType, 'spot.order_cancel_cp'>;
-    'spot.order_amend': WSAPIResponse<TResponseType, 'spot.order_amend'>;
-    'spot.order_status': WSAPIResponse<WSAPIOrderStatusResponse, 'spot.order_status'>;
-    'futures.order_place': WSAPIResponse<TResponseType[], 'futures.order_place'>;
-    'futures.order_batch_place': WSAPIResponse<TResponseType[], 'futures.order_batch_place'>;
-    'futures.order_cancel': WSAPIResponse<TResponseType, 'futures.order_cancel'>;
-    'futures.order_cancel_cp': WSAPIResponse<TResponseType, 'futures.order_cancel_cp'>;
-    'futures.order_amend': WSAPIResponse<TResponseType, 'futures.order_amend'>;
-    'futures.order_list': WSAPIResponse<TResponseType[], 'futures.order_list'>;
-    'futures.order_status': WSAPIResponse<WSAPIOrderStatusResponse, 'futures.order_status'>;
+    'spot.order_place': WSAPIResponse<WSAPISpotOrder, 'spot.order_place'>;
+    'spot.order_cancel': WSAPIResponse<WSAPISpotOrder, 'spot.order_cancel'>;
+    'spot.order_cancel_ids': WSAPIResponse<WSAPISpotOrderCancelIdsRespItem[], 'spot.order_cancel_ids'>;
+    'spot.order_cancel_cp': WSAPIResponse<WSAPISpotOrder[], 'spot.order_cancel_cp'>;
+    'spot.order_amend': WSAPIResponse<WSAPISpotOrder, 'spot.order_amend'>;
+    'spot.order_status': WSAPIResponse<WSAPISpotOrder, 'spot.order_status'>;
+    'spot.order_list': WSAPIResponse<WSAPISpotOrder[], 'spot.order_list'>;
+    'futures.order_place': WSAPIResponse<WSAPIFuturesOrder, 'futures.order_place'>;
+    'futures.order_batch_place': WSAPIResponse<WSAPIFuturesOrderBatchPlaceRespItem[], 'futures.order_batch_place'>;
+    'futures.order_cancel': WSAPIResponse<WSAPIFuturesOrder, 'futures.order_cancel'>;
+    'futures.order_cancel_ids': WSAPIResponse<WSAPIFuturesOrderCancelIdsRespItem[], 'futures.order_cancel_ids'>;
+    'futures.order_cancel_cp': WSAPIResponse<WSAPIFuturesOrder[], 'futures.order_cancel_cp'>;
+    'futures.order_amend': WSAPIResponse<WSAPIFuturesOrder, 'futures.order_amend'>;
+    'futures.order_list': WSAPIResponse<WSAPIFuturesOrder[], 'futures.order_list'>;
+    'futures.order_status': WSAPIResponse<WSAPIFuturesOrder, 'futures.order_status'>;
 }
 export interface WSAPIResponse<TResponseData extends object = WSAPIResponseData | object, TChannel extends WSAPITopic = WSAPITopic> {
     wsKey: WsKey;
@@ -99,3 +95,162 @@ export interface WSAPIResponse<TResponseData extends object = WSAPIResponseData
     /** Auto-generated */
     request_id: string;
 }
+export interface WSAPISpotOrderPlaceReq {
+    text?: string;
+    currency_pair: string;
+    type?: 'limit' | 'market';
+    account?: 'spot' | 'margin' | 'unified' | 'cross_margin';
+    side: 'buy' | 'sell';
+    amount: string;
+    price?: string;
+    time_in_force?: 'gtc' | 'ioc' | 'poc' | 'fok';
+    iceberg?: string;
+    auto_borrow?: boolean;
+    auto_repay?: boolean;
+    stp_act?: 'cn' | 'co' | 'cb';
+    action_mode?: 'ACK' | 'RESULT' | 'FULL';
+}
+export interface WSAPISpotOrderCancelReq {
+    order_id: string;
+    currency_pair: string;
+    account?: string;
+}
+export interface WSAPISpotOrderCancelIdsReq {
+    currency_pair: string;
+    id: string;
+    account?: string;
+}
+export interface WSAPISpotOrderCancelCPReq {
+    currency_pair: string;
+    side?: 'buy' | 'sell';
+    account?: string;
+}
+export interface WSAPISpotOrderAmendReq {
+    amount?: string;
+    price?: string;
+    amend_text?: string;
+    order_id: string;
+    currency_pair: string;
+    account?: string;
+}
+export interface WSAPISpotOrderStatusReq {
+    order_id: string;
+    currency_pair: string;
+    account?: string;
+}
+export interface WSAPISpotOrderListReq {
+    currency_pair: string;
+    status: 'open' | 'finished';
+    page?: number;
+    limit?: number;
+    account?: string;
+    from?: number;
+    to?: number;
+    side?: 'buy' | 'sell';
+}
+export interface WSAPIFuturesOrderPlaceReq {
+    contract: string;
+    size: number;
+    iceberg?: number;
+    price?: string;
+    close?: boolean;
+    reduce_only?: boolean;
+    tif?: 'gtc' | 'ioc' | 'poc' | 'fok';
+    text?: string;
+    auto_size?: 'close_long' | 'close_short';
+    stp_act?: 'cn' | 'co' | 'cb';
+}
+export interface WSAPIFuturesOrderCancelReq {
+    order_id: string;
+}
+export interface WSAPIFuturesOrderCancelCPReq {
+    contract: string;
+    side?: 'bid' | 'ask';
+}
+export interface WSAPIFuturesOrderAmendReq {
+    order_id: string;
+    price?: string;
+    size?: number;
+    amend_text?: string;
+}
+export interface WSAPIFuturesOrderListReq {
+    contract: string;
+    status: 'open' | 'finished';
+    limit?: number;
+    offset?: number;
+    last_id?: string;
+    count_total?: number;
+}
+export interface WSAPIFuturesOrderStatusReq {
+    order_id: string;
+}
+export interface WSAPISpotOrder {
+    id: string;
+    text: string;
+    amend_text: string;
+    create_time: string;
+    update_time: string;
+    create_time_ms: number;
+    update_time_ms: number;
+    status: string;
+    currency_pair: string;
+    type: string;
+    account: string;
+    side: string;
+    amount: string;
+    price: string;
+    time_in_force: string;
+    iceberg: string;
+    left: string;
+    fill_price?: string;
+    filled_amount?: string;
+    filled_total: string;
+    avg_deal_price?: string;
+    fee: string;
+    fee_currency: string;
+    point_fee: string;
+    gt_fee: string;
+    gt_maker_fee?: string;
+    gt_taker_fee?: string;
+    gt_discount?: boolean;
+    rebated_fee: string;
+    rebated_fee_currency: string;
+    stp_id?: number;
+    stp_act?: string;
+    finish_as: string;
+}
+export interface WSAPISpotOrderCancelIdsRespItem {
+    currency_pair: string;
+    id: string;
+    succeeded: boolean;
+}
+export interface WSAPIFuturesOrder {
+    id: number;
+    user: number;
+    create_time: number;
+    finish_time?: number;
+    update_time?: number;
+    finish_as?: string;
+    status: string;
+    contract: string;
+    size: number;
+    price: string;
+    tif: string;
+    left?: number;
+    fill_price: string;
+    text: string;
+    tkfr: string;
+    mkfr: string;
+    stp_id?: number;
+    stp_act?: string;
+    amend_text?: string;
+}
+export interface WSAPIFuturesOrderBatchPlaceRespItem extends WSAPIFuturesOrder {
+    succeeded: boolean;
+}
+export interface WSAPIFuturesOrderCancelIdsRespItem {
+    id: string;
+    user_id: number;
+    succeeded?: boolean;
+    message?: string;
+}

package/dist/mjs/types/websockets/wsAPI.js

@@ -1,7 +1,2 @@
 export {};
-// export interface WsAPIResponseMap<TChannel extends WSAPITopic = WSAPITopic> {
-//   'spot.login': WSAPIResponse<WSAPILoginResponse, TChannel>;
-//   'futures.login': WSAPIResponse<WSAPILoginResponse, TChannel>;
-//   string: object;
-// }
 //# sourceMappingURL=wsAPI.js.map

package/dist/mjs/types/websockets/wsAPI.js.map

@@ -1 +1 @@
-{"version":3,"file":"wsAPI.js","sourceRoot":"","sources":["../../../../src/types/websockets/wsAPI.ts"],"names":[],"mappings":";AAiKA,gFAAgF;AAChF,+DAA+D;AAC/D,kEAAkE;AAClE,oBAAoB;AACpB,IAAI"}
+{"version":3,"file":"wsAPI.js","sourceRoot":"","sources":["../../../../src/types/websockets/wsAPI.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gateio-api",
-  "version": "1.1.11",
-  "description": "Complete & robust Node.js SDK for Gate.io's REST APIs, WebSockets & WebSocket APIs, with TypeScript declarations.",
+  "version": "1.2.0",
+  "description": "Complete & Robust Node.js SDK for Gate.com's REST APIs, WebSockets & WebSocket APIs, with TypeScript declarations.",
   "scripts": {
     "clean": "rm -rf dist/*",
     "build": "rm -fr dist/* && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && bash ./postBuild.sh",
@@ -49,12 +49,16 @@
   "keywords": [
     "Gate",
     "Gate.io",
+    "Gate.com",
     "Gate api",
     "Gate.io api",
+    "Gate.com api",
     "Gate nodejs",
     "Gate javascript",
+    "Gate javascript websocket api",
     "Gate typescript",
     "Gate js",
+    "Gate ts",
     "Gate api node",
     "Gate sdk javascript",
     "algo trading",