@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/types/webSocket/response/orders.d.ts

@@ -0,0 +1,355 @@
+import type * as katanaPerps from '#index';
+import type { MessageEventType, OrderSubType, OrderType } from '#types/enums/index';
+import type { OrderStateChange } from '#types/enums/response';
+import type { KatanaPerpsOrder } from '#types/rest/endpoints/GetOrders';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+import type { KatanaPerpsOrderFillEventData } from './ordersFill.js';
+/**
+ * - `orders` updates provided to the message handler when subscribed.
+ *
+ * @inheritDoc KatanaPerpsSubscriptionEventBase
+ *
+ * @category KatanaPerps - Get Orders
+ * @category WebSocket - Message Types
+ *
+ * @see {@link KatanaPerpsSubscriptionEventBase}
+ */
+export interface KatanaPerpsOrderEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof MessageEventType.orders;
+    /**
+     * @inheritDoc KatanaPerpsOrderEventData
+     *
+     * @example
+     * ```typescript
+     *  import { OrderEventType } from '@katanaperps/katana-perps-sdk';
+     *
+     *  // ...
+     *
+     *  const orderEventData = orderEvent.data
+     *
+     *  if (
+     *    orderEventData.type === OrderEventType.liquidation ||
+     *    orderEventData.type === OrderEventType.deleverage
+     *  ) {
+     *    // orderEventData is of type KatanaPerpsOrderEventDataLiquidation | KatanaPerpsOrderEventDataDeleverage
+     *  } else {
+     *   // orderEventData is of type KatanaPerpsOrderEventDataGeneral
+     *  }
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see type {@link KatanaPerpsOrderEventData}
+     */
+    readonly data: KatanaPerpsOrderEventData;
+}
+/**
+ * [[include:base.md]]
+ *
+ * @category Base Types
+ */
+export interface KatanaPerpsOrderEventDataBase extends Pick<KatanaPerpsOrder, 'market' | 'wallet' | 'side'> {
+    /**
+     * - When `undefined`, indicates the message is a `liquidation` or `deleverage`
+     *   where `fills` will include a single  {@link KatanaPerpsOrderFillEventData.type} of
+     *   {@link katanaPerps.FillTypeSystem FillTypeSystem}.
+     */
+    readonly type?: OrderType;
+    /**
+     * Timestamp of the most recent update
+     */
+    executionTime: number;
+    /**
+     * @inheritDoc KatanaPerpsOrderFillEventData
+     *
+     * @see type {@link KatanaPerpsOrderFillEventData}
+     */
+    readonly fills?: KatanaPerpsOrderFillEventData[];
+}
+/**
+ * {@link katanaPerps.KatanaPerpsOrderFillEventDataSystem KatanaPerpsOrderFillEventDataSystem} updates do not
+ * include many of the standard order update properties
+ *
+ * - Note that these types include a single {@link KatanaPerpsOrderFillEventDataSystem}.
+ *
+ * @category KatanaPerps - Get Orders
+ */
+export interface KatanaPerpsOrderEventDataSystemFill extends KatanaPerpsOrderEventDataBase {
+    readonly type?: undefined;
+    readonly fills: KatanaPerpsOrderFillEventData[];
+}
+/**
+ * All types other than {@link KatanaPerpsOrderEventDataSystemFill} include
+ * most properties from {@link KatanaPerpsOrder}
+ *
+ * @category KatanaPerps - Get Orders
+ */
+export interface KatanaPerpsOrderEventDataGeneral extends KatanaPerpsOrderEventDataBase, Omit<KatanaPerpsOrder, 'type' | 'fills' | 'market' | 'wallet' | 'side'> {
+    /**
+     * @inheritDoc
+     */
+    readonly type: OrderType;
+    /**
+     * @internal
+     */
+    readonly subType?: OrderSubType;
+    /**
+     * Type of order update
+     *
+     * @see enum {@link OrderStateChange}
+     */
+    update: OrderStateChange;
+    /**
+     * order book update sequence number, only included if update type triggers an order book update
+     *
+     * @see related {@link katanaPerps.KatanaPerpsOrderBook.sequence}
+     */
+    sequence?: katanaPerps.KatanaPerpsOrderBook['sequence'];
+    readonly fills?: KatanaPerpsOrderFillEventData[];
+}
+/**
+ * Order updates received from the WebSocket differ from orders retreived from the
+ * REST API in several ways.
+ *
+ * - In addition to the order types received when getting orders from the REST API, WebSocket update events
+ *   may also provide the following `undefined` type indicating a {@link KatanaPerpsOrderEventDataSystemFill}
+ *   where the `fills` property will include a {@link katanaPerps.FillTypeSystem FillTypeSystem} fill matching
+ *   {@link katanaPerps.KatanaPerpsOrderFillEventDataSystem KatanaPerpsOrderFillEventDataSystem}
+ * - It is best to narrow on the `type` property between these types and all the
+ *   others as shown in the example below.
+ *   - This is made easiest by using the {@link OrderType} enum as shown.
+ *
+ * @example
+ * ```typescript
+ *  import { OrderType } from '@katanaperps/katana-perps-sdk';
+ *
+ *  if (!orderEventData.type) {
+ *    // orderLong is of type IKatanaPerpsOrderEventDataSystemFill
+ *  } else {
+ *   // orderLong is of type KatanaPerpsOrderEventDataGeneral
+ *   switch(orderEventData.type) {
+ *    case OrderType.fill:
+ *      break;
+ *    // ...etc
+ *   }
+ *  }
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @category KatanaPerps - Get Orders
+ * @category WebSocket - Message Types
+ *
+ * @see union {@link KatanaPerpsOrderEventDataGeneral}
+ * @see union {@link KatanaPerpsOrderEventDataSystemFill}
+ * @see parent {@link KatanaPerpsOrderEvent}
+ */
+export type KatanaPerpsOrderEventData = KatanaPerpsOrderEventDataSystemFill | KatanaPerpsOrderEventDataGeneral;
+export interface WebSocketResponseSubscriptionMessageShortOrders extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.orders;
+    data: WebSocketResponseOrderShort;
+}
+export interface WebSocketResponseOrderShortBase {
+    /**
+     * @see related {@link KatanaPerpsOrder.type}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.type}
+     */
+    o?: KatanaPerpsOrderEventDataGeneral['type'];
+    /**
+     * @see related {@link KatanaPerpsOrder.market}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.market}
+     */
+    m: KatanaPerpsOrderEventDataBase['market'];
+    /**
+     * @see related {@link KatanaPerpsOrder.wallet}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.wallet}
+     */
+    w: KatanaPerpsOrderEventDataBase['wallet'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.executionTime}
+     */
+    t: KatanaPerpsOrderEventDataBase['executionTime'];
+    /**
+     * @see related {@link KatanaPerpsOrder.side}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.side}
+     */
+    s: KatanaPerpsOrderEventDataBase['side'];
+    /**
+     * @see related {@link KatanaPerpsOrder.fills}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.fills}
+     */
+    F?: katanaPerps.WebSocketResponseOrderFillShort[];
+    /**
+     * @see related {@link KatanaPerpsOrder.delegatedKey}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.delegatedKey}
+     */
+    dk?: KatanaPerpsOrderEventDataGeneral['delegatedKey'];
+}
+/**
+ * @internal
+ *
+ * `liquidation`, `deleverage`, and `closure` types do not include many of the
+ * properties of other order types
+ */
+export interface WebSocketResponseOrderShortSystem extends WebSocketResponseOrderShortBase {
+    /**
+     * @inheritDoc
+     */
+    readonly o?: undefined;
+    readonly F: katanaPerps.WebSocketResponseOrderFillShort[];
+}
+/**
+ * @internal
+ *
+ * The type for all order types other than `liquidation`
+ */
+export interface WebSocketResponseOrderShortGeneral extends WebSocketResponseOrderShortBase {
+    /**
+     * @inheritDoc
+     */
+    o: KatanaPerpsOrderEventDataGeneral['type'];
+    /**
+     * @internal
+     */
+    O?: KatanaPerpsOrderEventDataGeneral['subType'];
+    /**
+     * @see related {@link KatanaPerpsOrder.orderId}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.orderId}
+     */
+    i: KatanaPerpsOrderEventDataGeneral['orderId'];
+    /**
+     * @see related {@link KatanaPerpsOrder.clientOrderId}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.clientOrderId}
+     */
+    c: KatanaPerpsOrderEventDataGeneral['clientOrderId'];
+    /**
+     * @see related {@link KatanaPerpsOrder.time}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.time}
+     */
+    T: KatanaPerpsOrderEventDataGeneral['time'];
+    /**
+     * @see enum {@link katanaPerps.OrderStateChange}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.update}
+     */
+    x: KatanaPerpsOrderEventDataGeneral['update'];
+    /**
+     * @see related {@link KatanaPerpsOrder.status}
+     * @see enum {@link katanaPerps.OrderStatus}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.status}
+     */
+    X: KatanaPerpsOrderEventDataGeneral['status'];
+    /**
+     * @see related {@link KatanaPerpsOrderBook.sequence}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.sequence}
+     */
+    u?: KatanaPerpsOrderEventDataGeneral['sequence'];
+    /**
+     * @see related {@link KatanaPerpsOrder.errorCode}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.errorCode}
+     */
+    ec?: KatanaPerpsOrderEventDataGeneral['errorCode'];
+    /**
+     * @see related {@link KatanaPerpsOrder.errorMessage}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.errorMessage}
+     */
+    em?: KatanaPerpsOrderEventDataGeneral['errorMessage'];
+    /**
+     * @see related {@link KatanaPerpsOrder.originalQuantity}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.originalQuantity}
+     */
+    q: KatanaPerpsOrderEventDataGeneral['originalQuantity'];
+    /**
+     * @see related {@link KatanaPerpsOrder.executedQuantity}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.executedQuantity}
+     */
+    z: KatanaPerpsOrderEventDataGeneral['executedQuantity'];
+    /**
+     * @see related {@link KatanaPerpsOrder.cumulativeQuoteQuantity}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.cumulativeQuoteQuantity}
+     */
+    Z: KatanaPerpsOrderEventDataGeneral['cumulativeQuoteQuantity'];
+    /**
+     * @see related {@link KatanaPerpsOrder.avgExecutionPrice}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.avgExecutionPrice}
+     */
+    v?: KatanaPerpsOrderEventDataGeneral['avgExecutionPrice'];
+    /**
+     * @see related {@link KatanaPerpsOrder.price}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.price}
+     */
+    p?: KatanaPerpsOrderEventDataGeneral['price'];
+    /**
+     * @see related {@link KatanaPerpsOrder.triggerPrice}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.triggerPrice}
+     */
+    P?: KatanaPerpsOrderEventDataGeneral['triggerPrice'];
+    /**
+     * @see related {@link KatanaPerpsOrder.triggerType}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.triggerType}
+     */
+    tt?: KatanaPerpsOrderEventDataGeneral['triggerType'];
+    /**
+     * Only applicable to `trailingStopMarket` orders.
+     *
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.callbackRate}
+     */
+    cr?: KatanaPerpsOrderEventDataGeneral['callbackRate'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.conditionalOrderId}
+     */
+    ci?: KatanaPerpsOrderEventDataGeneral['conditionalOrderId'];
+    /**
+     * @see related {@link KatanaPerpsOrder.reduceOnly}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.reduceOnly}
+     */
+    r: KatanaPerpsOrderEventDataGeneral['reduceOnly'];
+    /**
+     * @see related {@link KatanaPerpsOrder.timeInForce}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.timeInForce}
+     */
+    f?: KatanaPerpsOrderEventDataGeneral['timeInForce'];
+    /**
+     * @see related {@link KatanaPerpsOrder.selfTradePrevention}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.selfTradePrevention}
+     */
+    V: KatanaPerpsOrderEventDataGeneral['selfTradePrevention'];
+    /**
+     * @see related {@link KatanaPerpsOrder.isLiquidationAcquisitionOnly}
+     * @see inflated {@link KatanaPerpsOrderEventDataGeneral.isLiquidationAcquisitionOnly}
+     */
+    la?: KatanaPerpsOrderEventDataGeneral['isLiquidationAcquisitionOnly'];
+}
+/**
+ * @internal
+ *
+ * WebSocket Response Order - Short (Deflated)
+ *
+ * An extended version used by WebSocket of {@link KatanaPerpsOrder},
+ *
+ * ## Discriminated Union
+ *
+ * This type is a discriminated union by property `o` of two types:
+ *  - {@link WebSocketResponseOrderShortGeneral}
+ *  - {@link WebSocketResponseOrderShortSystem}
+ *
+ * When `o` is `liquidation`, the type is {@link WebSocketResponseOrderShortSystem} and
+ * will not include many of the properties that are included when `o` is not `liquidation`.
+ *
+ * @example
+ * ```typescript
+ *  if (orderShort.o === 'liquidation') {
+ *    // orderShort is of type WebSocketResponseOrderShortLiquidation
+ *  } else {
+ *   // orderShort is of type WebSocketResponseOrderShortGeneral
+ *  }
+ * ```
+ */
+export type WebSocketResponseOrderShort = WebSocketResponseOrderShortGeneral | WebSocketResponseOrderShortSystem;
+//# sourceMappingURL=orders.d.ts.map

package/dist/types/webSocket/response/orders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/orders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACV,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAErE;;;;;;;;;GASG;AACH,MAAM,WAAW,qBACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,gBAAgB,CAAC,MAAM,CAAC;IAC9C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CAAC,IAAI,EAAE,yBAAyB,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,6BACf,SAAQ,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC5D;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,6BAA6B,EAAE,CAAC;CAClD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mCACf,SAAQ,6BAA6B;IACrC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,6BAA6B,EAAE,CAAC;CACjD;AAED;;;;;GAKG;AACH,MAAM,WAAW,gCACf,SAAQ,6BAA6B,EACnC,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IACzE;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAChC;;;;OAIG;IACH,MAAM,EAAE,gBAAgB,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IACxD,QAAQ,CAAC,KAAK,CAAC,EAAE,6BAA6B,EAAE,CAAC;CAClD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,MAAM,yBAAyB,GACjC,mCAAmC,GACnC,gCAAgC,CAAC;AAErC,MAAM,WAAW,+CACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,2BAA2B,CAAC;CACnC;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,CAAC,CAAC,EAAE,gCAAgC,CAAC,MAAM,CAAC,CAAC;IAC7C;;;OAGG;IACH,CAAC,EAAE,6BAA6B,CAAC,QAAQ,CAAC,CAAC;IAC3C;;;OAGG;IACH,CAAC,EAAE,6BAA6B,CAAC,QAAQ,CAAC,CAAC;IAC3C;;OAEG;IACH,CAAC,EAAE,6BAA6B,CAAC,eAAe,CAAC,CAAC;IAClD;;;OAGG;IACH,CAAC,EAAE,6BAA6B,CAAC,MAAM,CAAC,CAAC;IACzC;;;OAGG;IACH,CAAC,CAAC,EAAE,WAAW,CAAC,+BAA+B,EAAE,CAAC;IAClD;;;OAGG;IACH,EAAE,CAAC,EAAE,gCAAgC,CAAC,cAAc,CAAC,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,iCACf,SAAQ,+BAA+B;IACvC;;OAEG;IACH,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC;IACvB,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,+BAA+B,EAAE,CAAC;CAC3D;AAED;;;;GAIG;AACH,MAAM,WAAW,kCACf,SAAQ,+BAA+B;IACvC;;OAEG;IACH,CAAC,EAAE,gCAAgC,CAAC,MAAM,CAAC,CAAC;IAC5C;;OAEG;IACH,CAAC,CAAC,EAAE,gCAAgC,CAAC,SAAS,CAAC,CAAC;IAChD;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,SAAS,CAAC,CAAC;IAC/C;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,eAAe,CAAC,CAAC;IACrD;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,MAAM,CAAC,CAAC;IAC5C;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,QAAQ,CAAC,CAAC;IAC9C;;;;OAIG;IACH,CAAC,EAAE,gCAAgC,CAAC,QAAQ,CAAC,CAAC;IAC9C;;;OAGG;IACH,CAAC,CAAC,EAAE,gCAAgC,CAAC,UAAU,CAAC,CAAC;IACjD;;;OAGG;IACH,EAAE,CAAC,EAAE,gCAAgC,CAAC,WAAW,CAAC,CAAC;IACnD;;;OAGG;IACH,EAAE,CAAC,EAAE,gCAAgC,CAAC,cAAc,CAAC,CAAC;IACtD;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,kBAAkB,CAAC,CAAC;IACxD;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,kBAAkB,CAAC,CAAC;IACxD;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,yBAAyB,CAAC,CAAC;IAC/D;;;OAGG;IACH,CAAC,CAAC,EAAE,gCAAgC,CAAC,mBAAmB,CAAC,CAAC;IAC1D;;;OAGG;IACH,CAAC,CAAC,EAAE,gCAAgC,CAAC,OAAO,CAAC,CAAC;IAC9C;;;OAGG;IACH,CAAC,CAAC,EAAE,gCAAgC,CAAC,cAAc,CAAC,CAAC;IACrD;;;OAGG;IACH,EAAE,CAAC,EAAE,gCAAgC,CAAC,aAAa,CAAC,CAAC;IACrD;;;;OAIG;IACH,EAAE,CAAC,EAAE,gCAAgC,CAAC,cAAc,CAAC,CAAC;IACtD;;OAEG;IACH,EAAE,CAAC,EAAE,gCAAgC,CAAC,oBAAoB,CAAC,CAAC;IAC5D;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,YAAY,CAAC,CAAC;IAClD;;;OAGG;IACH,CAAC,CAAC,EAAE,gCAAgC,CAAC,aAAa,CAAC,CAAC;IACpD;;;OAGG;IACH,CAAC,EAAE,gCAAgC,CAAC,qBAAqB,CAAC,CAAC;IAE3D;;;OAGG;IACH,EAAE,CAAC,EAAE,gCAAgC,CAAC,8BAA8B,CAAC,CAAC;CACvE;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,iCAAiC,CAAC"}

package/dist/types/webSocket/response/orders.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/webSocket/response/ordersFill.d.ts

@@ -0,0 +1,138 @@
+import type { FillType, FillTypeOrder, FillTypeSystem } from '#types/enums/response';
+import type { KatanaPerpsOrderFill } from '#types/rest/index';
+/**
+ * [[include:base.md]]
+ *
+ * @category Base Types
+ */
+export interface KatanaPerpsOrderFillEventDataBase extends Omit<KatanaPerpsOrderFill, 'type' | 'makerSide' | 'sequence' | 'liquidity'> {
+    /**
+     * @inheritDoc
+     */
+    type: FillType;
+}
+/**
+ * Fills of type {@link FillTypeSystem}
+ *
+ * - These types of fills do not include values from {@link KatanaPerpsOrderFill}
+ *   that other fill types include:
+ *   - {@link KatanaPerpsOrderFill.makerSide makerSide}
+ *   - {@link KatanaPerpsOrderFill.sequence sequence}
+ *   - {@link KatanaPerpsOrderFill.liquidity liquidity}
+ *
+ * @see type {@link FillTypeSystem}
+ * @category KatanaPerps - Get Orders
+ */
+export interface KatanaPerpsOrderFillEventDataSystem extends KatanaPerpsOrderFillEventDataBase {
+    /**
+     * @inheritDoc
+     */
+    type: FillTypeSystem;
+}
+/**
+ * Non-liquidation Order Fill Type
+ *
+ * @see type {@link FillTypeOrder}
+ * @category KatanaPerps - Get Orders
+ */
+export interface KatanaPerpsOrderFillEventDataGeneral extends KatanaPerpsOrderFillEventDataBase, Pick<KatanaPerpsOrderFill, 'makerSide' | 'sequence' | 'liquidity'> {
+    /**
+     * @inheritDoc
+     */
+    type: FillTypeOrder;
+}
+/**
+ * An orders `fills` will potentially have a different shape
+ * dependent on the `type` property of the fill.
+ *
+ * @category KatanaPerps - Get Orders
+ */
+export type KatanaPerpsOrderFillEventData = KatanaPerpsOrderFillEventDataSystem | KatanaPerpsOrderFillEventDataGeneral;
+/**
+ * @internal
+ */
+export interface WebSocketResponseOrderFillShortBase {
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.type}
+     */
+    y: KatanaPerpsOrderFillEventDataBase['type'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.fillId}
+     */
+    i: KatanaPerpsOrderFillEventDataGeneral['fillId'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.price}
+     */
+    p: KatanaPerpsOrderFillEventDataGeneral['price'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.quantity}
+     */
+    q: KatanaPerpsOrderFillEventDataGeneral['quantity'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.quoteQuantity}
+     */
+    Q: KatanaPerpsOrderFillEventDataGeneral['quoteQuantity'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.realizedPnL}
+     */
+    rn: KatanaPerpsOrderFillEventDataGeneral['realizedPnL'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.time}
+     */
+    t: KatanaPerpsOrderFillEventDataGeneral['time'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.fee}
+     */
+    f?: KatanaPerpsOrderFillEventDataGeneral['fee'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.action}
+     */
+    a: KatanaPerpsOrderFillEventDataGeneral['action'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.position}
+     */
+    P: KatanaPerpsOrderFillEventDataGeneral['position'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.txId}
+     */
+    T: KatanaPerpsOrderFillEventDataGeneral['txId'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.txStatus}
+     */
+    S: KatanaPerpsOrderFillEventDataGeneral['txStatus'];
+}
+/**
+ * @internal
+ */
+export interface WebSocketResponseOrderFillShortSystem extends WebSocketResponseOrderFillShortBase {
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.type}
+     */
+    y: KatanaPerpsOrderFillEventDataSystem['type'];
+}
+/**
+ * @internal
+ */
+export interface WebSocketResponseOrderFillShortGeneral extends WebSocketResponseOrderFillShortBase {
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.type}
+     */
+    y: KatanaPerpsOrderFillEventDataGeneral['type'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.makerSide}
+     */
+    s: {} & KatanaPerpsOrderFillEventDataGeneral['makerSide'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.sequence}
+     */
+    u: {} & KatanaPerpsOrderFillEventDataGeneral['sequence'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderFillEventData.liquidity}
+     */
+    l: {} & KatanaPerpsOrderFillEventDataGeneral['liquidity'];
+}
+/**
+ * @internal
+ */
+export type WebSocketResponseOrderFillShort = WebSocketResponseOrderFillShortSystem | WebSocketResponseOrderFillShortGeneral;
+//# sourceMappingURL=ordersFill.d.ts.map

package/dist/types/webSocket/response/ordersFill.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordersFill.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/ordersFill.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,aAAa,EACb,cAAc,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAE9D;;;;GAIG;AACH,MAAM,WAAW,iCACf,SAAQ,IAAI,CACV,oBAAoB,EACpB,MAAM,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAChD;IACD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mCACf,SAAQ,iCAAiC;IACzC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oCACf,SAAQ,iCAAiC,EACvC,IAAI,CAAC,oBAAoB,EAAE,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;IACpE;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,6BAA6B,GACrC,mCAAmC,GACnC,oCAAoC,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,CAAC,EAAE,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAC7C;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,QAAQ,CAAC,CAAC;IAClD;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,OAAO,CAAC,CAAC;IACjD;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,UAAU,CAAC,CAAC;IACpD;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,eAAe,CAAC,CAAC;IACzD;;OAEG;IACH,EAAE,EAAE,oCAAoC,CAAC,aAAa,CAAC,CAAC;IACxD;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,MAAM,CAAC,CAAC;IAChD;;OAEG;IACH,CAAC,CAAC,EAAE,oCAAoC,CAAC,KAAK,CAAC,CAAC;IAChD;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,QAAQ,CAAC,CAAC;IAClD;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,UAAU,CAAC,CAAC;IACpD;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,MAAM,CAAC,CAAC;IAChD;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,UAAU,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,qCACf,SAAQ,mCAAmC;IAC3C;;OAEG;IACH,CAAC,EAAE,mCAAmC,CAAC,MAAM,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,sCACf,SAAQ,mCAAmC;IAC3C;;OAEG;IACH,CAAC,EAAE,oCAAoC,CAAC,MAAM,CAAC,CAAC;IAChD;;OAEG;IACH,CAAC,EAAE,EAAE,GAAG,oCAAoC,CAAC,WAAW,CAAC,CAAC;IAC1D;;OAEG;IACH,CAAC,EAAE,EAAE,GAAG,oCAAoC,CAAC,UAAU,CAAC,CAAC;IACzD;;OAEG;IACH,CAAC,EAAE,EAAE,GAAG,oCAAoC,CAAC,WAAW,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,qCAAqC,GACrC,sCAAsC,CAAC"}

package/dist/types/webSocket/response/ordersFill.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/webSocket/response/positions.d.ts

@@ -0,0 +1,120 @@
+import type { MessageEventType, PositionEventStatus } from '#types/enums/index';
+import type { KatanaPerpsPosition } from '#types/rest/endpoints/GetPositions';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * When the `positions` subscription provides an update
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Positions
+ */
+export interface KatanaPerpsPositionEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.positions;
+    /**
+     * @inheritDoc KatanaPerpsPositionEventData
+     *
+     * @see data {@link KatanaPerpsPositionEventData}
+     */
+    data: KatanaPerpsPositionEventData;
+}
+/**
+ * - Includes most properties from the REST API's {@link KatanaPerpsPosition} type.
+ * - Also includes
+ *   {@link KatanaPerpsPositionEventData.wallet wallet},
+ *   {@link KatanaPerpsPositionEventData.status status},
+ *   and {@link KatanaPerpsPositionEventData.quoteBalance quoteBalance} properties.
+ *
+ * @see parent {@link KatanaPerpsPositionEvent}
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Positions
+ */
+export interface KatanaPerpsPositionEventData extends Pick<KatanaPerpsPosition, 'market' | 'time' | 'quantity' | 'maximumQuantity' | 'entryPrice' | 'exitPrice' | 'realizedPnL' | 'totalFunding' | 'totalOpen' | 'totalClose' | 'openedByFillId' | 'lastFillId'> {
+    /**
+     * Wallet address
+     */
+    wallet: string;
+    /**
+     * - {@link PositionEventStatus.open open} if position is open.
+     * - {@link PositionEventStatus.closed closed} for the last update.
+     *
+     * @see enum {@link PositionEventStatus}
+     */
+    status: PositionEventStatus;
+    /**
+     * The total quote balance after the positions update
+     */
+    quoteBalance: string;
+}
+export interface WebSocketResponseSubscriptionMessageShortPositions extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.positions;
+    data: WebSocketResponsePositionsShort;
+}
+/**
+ * @internal
+ */
+export interface WebSocketResponsePositionsShort {
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.wallet}
+     */
+    w: KatanaPerpsPositionEventData['wallet'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.market}
+     */
+    m: KatanaPerpsPositionEventData['market'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.status}
+     */
+    X: KatanaPerpsPositionEventData['status'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.quantity}
+     */
+    q: KatanaPerpsPositionEventData['quantity'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.maximumQuantity}
+     */
+    mq: KatanaPerpsPositionEventData['maximumQuantity'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.entryPrice}
+     */
+    np: KatanaPerpsPositionEventData['entryPrice'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.exitPrice}
+     */
+    xp: KatanaPerpsPositionEventData['exitPrice'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.realizedPnL}
+     */
+    rn: KatanaPerpsPositionEventData['realizedPnL'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.totalFunding}
+     */
+    f: KatanaPerpsPositionEventData['totalFunding'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.totalOpen}
+     */
+    to: KatanaPerpsPositionEventData['totalOpen'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.totalClose}
+     */
+    tc: KatanaPerpsPositionEventData['totalClose'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.openedByFillId}
+     */
+    of: KatanaPerpsPositionEventData['openedByFillId'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.lastFillId}
+     */
+    lf: KatanaPerpsPositionEventData['lastFillId'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.quoteBalance}
+     */
+    qb: KatanaPerpsPositionEventData['quoteBalance'];
+    /**
+     * @see inflated {@link KatanaPerpsPositionEventData.time}
+     */
+    t: KatanaPerpsPositionEventData['time'];
+}
+//# sourceMappingURL=positions.d.ts.map

package/dist/types/webSocket/response/positions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"positions.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/positions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,WAAW,wBACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,SAAS,CAAC;IACxC;;;;OAIG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,4BACf,SAAQ,IAAI,CACV,mBAAmB,EACjB,QAAQ,GACR,MAAM,GACN,UAAU,GACV,iBAAiB,GACjB,YAAY,GACZ,WAAW,GACX,aAAa,GACb,cAAc,GACd,WAAW,GACX,YAAY,GACZ,gBAAgB,GAChB,YAAY,CACf;IACD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,SAAS,CAAC;IACxC,IAAI,EAAE,+BAA+B,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,CAAC,EAAE,4BAA4B,CAAC,QAAQ,CAAC,CAAC;IAC1C;;OAEG;IACH,CAAC,EAAE,4BAA4B,CAAC,QAAQ,CAAC,CAAC;IAC1C;;OAEG;IACH,CAAC,EAAE,4BAA4B,CAAC,QAAQ,CAAC,CAAC;IAC1C;;OAEG;IACH,CAAC,EAAE,4BAA4B,CAAC,UAAU,CAAC,CAAC;IAC5C;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;IACpD;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,YAAY,CAAC,CAAC;IAC/C;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,WAAW,CAAC,CAAC;IAC9C;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,aAAa,CAAC,CAAC;IAChD;;OAEG;IACH,CAAC,EAAE,4BAA4B,CAAC,cAAc,CAAC,CAAC;IAChD;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,WAAW,CAAC,CAAC;IAC9C;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,YAAY,CAAC,CAAC;IAC/C;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,gBAAgB,CAAC,CAAC;IACnD;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,YAAY,CAAC,CAAC;IAC/C;;OAEG;IACH,EAAE,EAAE,4BAA4B,CAAC,cAAc,CAAC,CAAC;IACjD;;OAEG;IACH,CAAC,EAAE,4BAA4B,CAAC,MAAM,CAAC,CAAC;CACzC"}

package/dist/types/webSocket/response/positions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });