bybit-api 3.8.0 → 3.8.1

package/lib/types/websocket.events.d.ts

@@ -1,5 +1,33 @@
 import { CategoryV5, OCOTriggerTypeV5, OrderRejectReasonV5, OrderSMPTypeV5, OrderSideV5, OrderStatusV5, OrderTimeInForceV5, OrderTriggerByV5, OrderTypeV5, StopOrderTypeV5, TPSLModeV5 } from './v5-shared';
 import { WsKey } from './websockets';
+export interface WSOrderbookEventV5 {
+    topic: string;
+    /** Event timestamp */
+    ts: number;
+    type: 'delta' | 'snapshot';
+    data: {
+        /** Symbol */
+        s: string;
+        /** [price, qty][] */
+        b: [string, string][];
+        /** [price, qty][] */
+        a: [string, string][];
+        /** Update ID */
+        u: number;
+        /**
+         * Cross sequence
+         */
+        seq: number;
+    };
+    /**
+     * matching engine timestamp (correlated with T from public trade channel)
+     */
+    cts: number;
+    /**
+     * Internal reference, can be used to determine if this is spot/linear/inverse/etc
+     */
+    wsKey: WsKey;
+}
 export interface WSAccountOrderV5 {
     qty: string;
     price: string;

package/lib/util/index.d.ts

@@ -1,5 +1,6 @@
 export * from './BaseRestClient';
-export * from './requestUtils';
-export * from './WsStore';
 export * from './logger';
+export * from './requestUtils';
+export * from './typeGuards';
 export * from './websocket-util';
+export * from './WsStore';

package/lib/util/index.js

@@ -11,8 +11,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BaseRestClient"), exports);
-__exportStar(require("./requestUtils"), exports);
-__exportStar(require("./WsStore"), exports);
 __exportStar(require("./logger"), exports);
+__exportStar(require("./requestUtils"), exports);
+__exportStar(require("./typeGuards"), exports);
 __exportStar(require("./websocket-util"), exports);
+__exportStar(require("./WsStore"), exports);
 //# sourceMappingURL=index.js.map

package/lib/util/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAiC;AACjC,iDAA+B;AAC/B,4CAA0B;AAC1B,2CAAyB;AACzB,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAiC;AACjC,2CAAyB;AACzB,iDAA+B;AAC/B,+CAA6B;AAC7B,mDAAiC;AACjC,4CAA0B"}

package/lib/util/typeGuards.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Use type guards to narrow down types with minimal efforts.
+ */
+import { WSOrderbookEventV5 } from '../types/websocket.events';
+/**
+ * Type guard to detect a V5 orderbook event (delta & snapshots)
+ *
+ * @param event
+ * @returns
+ */
+export declare function isWsOrderbookEventV5(event: unknown): event is WSOrderbookEventV5;

package/lib/util/typeGuards.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Use type guards to narrow down types with minimal efforts.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWsOrderbookEventV5 = void 0;
+/**
+ * Type guard to detect a V5 orderbook event (delta & snapshots)
+ *
+ * @param event
+ * @returns
+ */
+function isWsOrderbookEventV5(event) {
+    if (typeof event !== 'object' ||
+        !event ||
+        typeof event['topic'] !== 'string' ||
+        typeof event['type'] !== 'string') {
+        return false;
+    }
+    return (['delta', 'snapshot'].includes(event['type']) &&
+        event['topic'].startsWith('orderbook'));
+}
+exports.isWsOrderbookEventV5 = isWsOrderbookEventV5;
+//# sourceMappingURL=typeGuards.js.map

package/lib/util/typeGuards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeGuards.js","sourceRoot":"","sources":["../../src/util/typeGuards.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAIH;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK;QACN,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ;QAClC,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ,EACjC;QACA,OAAO,KAAK,CAAC;KACd;IAED,OAAO,CACL,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CACvC,CAAC;AACJ,CAAC;AAhBD,oDAgBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "3.8.0",
+  "version": "3.8.1",
   "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",