nodejs-order-book 8.0.1 → 9.0.0

package/dist/types/types.d.ts

@@ -88,7 +88,6 @@ export interface InternalStopLimitOrderOptions extends ILimitOrderOptions {
  * Specific options for oco order.
  */
 export interface OCOOrderOptions extends StopLimitOrderOptions {
-    stopPrice: number;
     stopLimitPrice: number;
     stopLimitTimeInForce?: TimeInForce;
 }
@@ -141,22 +140,25 @@ export interface IStopLimitOrder {
     stopPrice: number;
     timeInForce: TimeInForce;
     time: number;
+    isOCO: boolean;
 }
 /**
  * Represents an order in the order book.
  */
 export type OrderOptions = InternalMarketOrderOptions | InternalLimitOrderOptions | InternalStopLimitOrderOptions | InternalStopMarketOrderOptions;
 export type StopOrderOptions = StopMarketOrderOptions | StopLimitOrderOptions | OCOOrderOptions;
+export type IStopOrder = IStopLimitOrder | IStopMarketOrder;
+export type IOrder = ILimitOrder | IStopOrder;
 /**
  * Represents the result of processing an order.
  */
 export interface IProcessOrder {
     /** Array of fully processed orders. */
-    done: Order[];
+    done: IOrder[];
     /** Array of activated (stop limit or stop market) orders */
-    activated: StopOrder[];
+    activated: IStopOrder[];
     /** The partially processed order, if any. */
-    partial: LimitOrder | null;
+    partial: ILimitOrder | null;
     /** The quantity that has been processed in the partial order. */
     partialQuantityProcessed: number;
     /** The remaining quantity that needs to be processed. */
@@ -185,19 +187,10 @@ export interface CancelOrderOptions {
     /** Unique identifier of the order. */
     orderID: string;
 }
-/**
- * Represents a cancel order operation.
- */
-export interface ICancelOrder {
-    order: LimitOrder;
-    stopOrder?: StopOrder;
-    /** Optional log related to the order cancellation. */
-    log?: CancelOrderJournalLog;
-}
 /**
  * Represents a log entry for a market order operation.
  */
-export interface MarketOrderJournalLog {
+interface MarketOrderJournalLog {
     /** Incremental ID of the operation */
     opId: number;
     /** Timestamp of the operation. */
@@ -210,7 +203,7 @@ export interface MarketOrderJournalLog {
 /**
  * Represents a log entry for a limit order operation.
  */
-export interface LimitOrderJournalLog {
+interface LimitOrderJournalLog {
     /** Incremental ID of the operation */
     opId: number;
     /** Timestamp of the operation. */
@@ -220,10 +213,49 @@ export interface LimitOrderJournalLog {
     /** Specific options for the limit order. */
     o: LimitOrderOptions;
 }
+/**
+ * Represents a log entry for a stop_market order operation.
+ */
+interface StopMarketOrderJournalLog {
+    /** Incremental ID of the operation */
+    opId: number;
+    /** Timestamp of the operation. */
+    ts: number;
+    /** Operation type: 'sm' for stop_market order. */
+    op: "sm";
+    /** Specific options for the stop_market order. */
+    o: StopMarketOrderOptions;
+}
+/**
+ * Represents a log entry for a stop_limit order operation.
+ */
+interface StopLimitOrderJournalLog {
+    /** Incremental ID of the operation */
+    opId: number;
+    /** Timestamp of the operation. */
+    ts: number;
+    /** Operation type: 'l' for stop_limit order. */
+    op: "sl";
+    /** Specific options for the stop_limit order. */
+    o: StopLimitOrderOptions;
+}
+/**
+ * Represents a log entry for a oco order operation.
+ */
+interface OCOOrderJournalLog {
+    /** Incremental ID of the operation */
+    opId: number;
+    /** Timestamp of the operation. */
+    ts: number;
+    /** Operation type: 'l' for oco order. */
+    op: "oco";
+    /** Specific options for the oco order. */
+    o: OCOOrderOptions;
+}
 /**
  * Represents a log entry for an order modification operation.
  */
-export interface ModifyOrderJournalLog {
+interface ModifyOrderJournalLog {
     /** Incremental ID of the operation */
     opId: number;
     /** Timestamp of the operation. */
@@ -236,7 +268,7 @@ export interface ModifyOrderJournalLog {
 /**
  * Represents a log entry for an order cancellation operation.
  */
-export interface CancelOrderJournalLog {
+interface CancelOrderJournalLog {
     /** Incremental ID of the operation */
     opId: number;
     /** Timestamp of the operation. */
@@ -249,7 +281,7 @@ export interface CancelOrderJournalLog {
 /**
  * Discriminated union of all journaling log types.
  */
-export type JournalLog = MarketOrderJournalLog | LimitOrderJournalLog | ModifyOrderJournalLog | CancelOrderJournalLog;
+export type JournalLog = MarketOrderJournalLog | LimitOrderJournalLog | StopMarketOrderJournalLog | StopLimitOrderJournalLog | OCOOrderJournalLog | ModifyOrderJournalLog | CancelOrderJournalLog;
 export type CreateOrderOptions = ({
     type: OrderType.MARKET;
 } & MarketOrderOptions) | ({
@@ -261,6 +293,15 @@ export type CreateOrderOptions = ({
 } & StopLimitOrderOptions) | ({
     type: OrderType.OCO;
 } & OCOOrderOptions);
+/**
+ * Represents a cancel order operation.
+ */
+export interface ICancelOrder {
+    order: ILimitOrder;
+    stopOrder?: IStopOrder;
+    /** Optional log related to the order cancellation. */
+    log?: CancelOrderJournalLog;
+}
 /**
  * Options for configuring the order book.
  */
@@ -307,14 +348,14 @@ export interface Snapshot {
         /** Price of the ask order */
         price: number;
         /** List of orders associated with this price */
-        orders: LimitOrder[];
+        orders: ILimitOrder[];
     }>;
     /** List of bid orders, each with a price and a list of associated orders */
     bids: Array<{
         /** Price of the bid order */
         price: number;
         /** List of orders associated with this price */
-        orders: LimitOrder[];
+        orders: ILimitOrder[];
     }>;
     /** Unix timestamp representing when the snapshot was taken */
     ts: number;

package/dist/types/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const safeStringify: (value: any) => string | null;
+export declare const safeParse: <T>(value: string) => T | null;