@upbit-official/upbit-sdk 0.9.0 → 1.1.0

package/src/resources/ws-public/ws-public.ts

@@ -1,11 +1,460 @@
-
 import { APIResource } from '../../core/resource';
 
 export class WsPublic extends APIResource {}
 
 /**
- * WebSocket public client event — subscription request sent to server
+ * Subscription query response in DEFAULT or JSON_LIST format.
  */
+export interface ListSubscriptionsResponse {
+  method: 'LIST_SUBSCRIPTIONS';
+
+  /** Current subscriptions. Additional fields depend on the subscription type. */
+  result: Array<ListSubscriptionsResponse.Result>;
+
+  /** Ticket returned by the server. */
+  ticket: string;
+}
+
+export namespace ListSubscriptionsResponse {
+  export interface Result {
+    /** Subscribed stream type. */
+    type: string;
+
+    [key: string]: unknown;
+  }
+}
+
+/**
+ * Subscription query response in the requested WebSocket format.
+ */
+export type ListSubscriptionsServerResponse = ListSubscriptionsResponse | SimpleListSubscriptionsResponse;
+
+export interface SimpleCandle {
+  /**
+   * Data type (candle.{interval}). Examples: candle.1s, candle.1m, candle.240m
+   */
+  ty:
+    | 'candle.1s'
+    | 'candle.1m'
+    | 'candle.3m'
+    | 'candle.5m'
+    | 'candle.10m'
+    | 'candle.15m'
+    | 'candle.30m'
+    | 'candle.60m'
+    | 'candle.240m';
+
+  /**
+   * Accumulated trade value
+   */
+  catp?: string;
+
+  /**
+   * Accumulated trade volume
+   */
+  catv?: string;
+
+  /**
+   * Market code
+   */
+  cd?: string;
+
+  /**
+   * Candle base time (KST, yyyy-MM-dd'T'HH:mm:ss)
+   */
+  cdttmk?: string;
+
+  /**
+   * Candle base time (UTC, yyyy-MM-dd'T'HH:mm:ss)
+   */
+  cdttmu?: string;
+
+  /**
+   * High price
+   */
+  hp?: string;
+
+  /**
+   * Low price
+   */
+  lp?: string;
+
+  /**
+   * Opening price
+   */
+  op?: string;
+
+  /**
+   * Stream type (snapshot or realtime)
+   */
+  st?: 'SNAPSHOT' | 'REALTIME';
+
+  /**
+   * Timestamp (ms)
+   */
+  tms?: number;
+
+  /**
+   * Closing price (current price)
+   */
+  tp?: string;
+}
+
+/**
+ * Subscription query response in SIMPLE or SIMPLE_LIST format.
+ */
+export interface SimpleListSubscriptionsResponse {
+  mthd: 'LIST_SUBSCRIPTIONS';
+
+  /** Current subscriptions with abbreviated keys. */
+  rslt: Array<SimpleListSubscriptionsResponse.Result>;
+
+  /** Ticket returned by the server. */
+  tckt: string;
+}
+
+export namespace SimpleListSubscriptionsResponse {
+  export interface Result {
+    /** Subscribed stream type. */
+    ty: string;
+
+    [key: string]: unknown;
+  }
+}
+
+export interface SimpleOrderbook {
+  /**
+   * Data type
+   */
+  ty: 'orderbook';
+
+  /**
+   * Market code
+   */
+  cd?: string;
+
+  /**
+   * Orderbook grouping unit. 0 means default unit. KRW markets only.
+   */
+  lv?: string;
+
+  /**
+   * List of orderbook units (default 30; adjustable via .count in codes)
+   */
+  obu?: Array<SimpleOrderbook.Obu>;
+
+  /**
+   * Stream type (snapshot or realtime)
+   */
+  st?: 'SNAPSHOT' | 'REALTIME';
+
+  /**
+   * Total ask quantity in orderbook
+   */
+  tas?: string;
+
+  /**
+   * Total bid quantity in orderbook
+   */
+  tbs?: string;
+
+  /**
+   * Timestamp (ms)
+   */
+  tms?: number;
+}
+
+export namespace SimpleOrderbook {
+  /**
+   * Orderbook unit entry
+   */
+  export interface Obu {
+    /**
+     * Ask price
+     */
+    ap?: string;
+
+    /**
+     * Ask quantity
+     */
+    as?: string;
+
+    /**
+     * Bid price
+     */
+    bp?: string;
+
+    /**
+     * Bid quantity
+     */
+    bs?: string;
+  }
+}
+
+export type SimplePublicServerEvent = SimpleTicker | SimpleTrade | SimpleOrderbook | SimpleCandle;
+
+export interface SimpleTicker {
+  /**
+   * Data type
+   */
+  ty: 'ticker';
+
+  /**
+   * Accumulated ask volume
+   */
+  aav?: string;
+
+  /**
+   * Ask/bid side
+   */
+  ab?: 'ASK' | 'BID';
+
+  /**
+   * Accumulated bid volume
+   */
+  abv?: string;
+
+  /**
+   * Accumulated trade value (since UTC 00:00)
+   */
+  atp?: string;
+
+  /**
+   * 24-hour accumulated trade value
+   */
+  atp24h?: string;
+
+  /**
+   * Accumulated trade volume (since UTC 00:00)
+   */
+  atv?: string;
+
+  /**
+   * 24-hour accumulated trade volume
+   */
+  atv24h?: string;
+
+  /**
+   * Price change direction relative to previous close
+   */
+  c?: 'RISE' | 'EVEN' | 'FALL';
+
+  /**
+   * Market code
+   */
+  cd?: string;
+
+  /**
+   * Absolute price change from previous close
+   */
+  cp?: string;
+
+  /**
+   * Absolute change rate from previous close
+   */
+  cr?: string;
+
+  /**
+   * Delisting date (only present when delisting is scheduled)
+   */
+  dd?: SimpleTicker.Dd | null;
+
+  /**
+   * Date of 52-week high (yyyy-MM-dd)
+   */
+  h52wdt?: string;
+
+  /**
+   * 52-week high price
+   */
+  h52wp?: string;
+
+  /**
+   * High price
+   */
+  hp?: string;
+
+  /**
+   * Date of 52-week low (yyyy-MM-dd)
+   */
+  l52wdt?: string;
+
+  /**
+   * 52-week low price
+   */
+  l52wp?: string;
+
+  /**
+   * Low price
+   */
+  lp?: string;
+
+  /**
+   * Market trading status
+   */
+  ms?: 'PREVIEW' | 'ACTIVE' | 'DELISTED';
+
+  /**
+   * Opening price
+   */
+  op?: string;
+
+  /**
+   * Previous day closing price
+   */
+  pcp?: string;
+
+  /**
+   * Signed price change from previous close
+   */
+  scp?: string;
+
+  /**
+   * Signed change rate from previous close
+   */
+  scr?: string;
+
+  /**
+   * Stream type (snapshot or realtime)
+   */
+  st?: 'SNAPSHOT' | 'REALTIME';
+
+  /**
+   * Most recent trade date (UTC, yyyyMMdd)
+   */
+  tdt?: string;
+
+  /**
+   * Timestamp (ms)
+   */
+  tms?: number;
+
+  /**
+   * Current price (closing price)
+   */
+  tp?: string;
+
+  /**
+   * Most recent trade time (UTC, HHmmss)
+   */
+  ttm?: string;
+
+  /**
+   * Trade timestamp (ms)
+   */
+  ttms?: number;
+
+  /**
+   * Most recent trade volume
+   */
+  tv?: string;
+}
+
+export namespace SimpleTicker {
+  /**
+   * Delisting date (only present when delisting is scheduled)
+   */
+  export interface Dd {
+    day?: number;
+
+    month?: number;
+
+    year?: number;
+  }
+}
+
+export interface SimpleTrade {
+  /**
+   * Data type
+   */
+  ty: 'trade';
+
+  /**
+   * Ask/bid side
+   */
+  ab?: 'ASK' | 'BID';
+
+  /**
+   * Best ask price
+   */
+  bap?: string;
+
+  /**
+   * Best ask quantity
+   */
+  bas?: string;
+
+  /**
+   * Best bid price
+   */
+  bbp?: string;
+
+  /**
+   * Best bid quantity
+   */
+  bbs?: string;
+
+  /**
+   * Price change direction relative to previous close
+   */
+  c?: 'RISE' | 'EVEN' | 'FALL';
+
+  /**
+   * Market code
+   */
+  cd?: string;
+
+  /**
+   * Absolute price change from previous close
+   */
+  cp?: string;
+
+  /**
+   * Previous day closing price
+   */
+  pcp?: string;
+
+  /**
+   * Unique trade ID. Used to determine trade uniqueness; order is not guaranteed.
+   */
+  sid?: number;
+
+  /**
+   * Stream type (snapshot or realtime)
+   */
+  st?: 'SNAPSHOT' | 'REALTIME';
+
+  /**
+   * Trade date (UTC, yyyy-MM-dd)
+   */
+  td?: string;
+
+  /**
+   * Timestamp (ms)
+   */
+  tms?: number;
+
+  /**
+   * Trade price
+   */
+  tp?: string;
+
+  /**
+   * Trade time (UTC, HH:mm:ss)
+   */
+  ttm?: string;
+
+  /**
+   * Trade timestamp (ms)
+   */
+  ttms?: number;
+
+  /**
+   * Trade volume
+   */
+  tv?: string;
+}
+
 export type ConnectPublicClientEvent =
   | Array<
       | ConnectPublicClientEvent.WsTicketField
@@ -128,9 +577,6 @@ export namespace ConnectPublicClientEvent {
   }
 }
 
-/**
- * WebSocket public server event — stream message received from server
- */
 export type ConnectPublicServerEvent =
   | ConnectPublicServerEvent.Ticker
   | ConnectPublicServerEvent.Trade
@@ -555,6 +1001,14 @@ export namespace ConnectPublicServerEvent {
 
 export declare namespace WsPublic {
   export {
+    type ListSubscriptionsResponse as ListSubscriptionsResponse,
+    type ListSubscriptionsServerResponse as ListSubscriptionsServerResponse,
+    type SimpleListSubscriptionsResponse as SimpleListSubscriptionsResponse,
+    type SimpleCandle as SimpleCandle,
+    type SimpleOrderbook as SimpleOrderbook,
+    type SimplePublicServerEvent as SimplePublicServerEvent,
+    type SimpleTicker as SimpleTicker,
+    type SimpleTrade as SimpleTrade,
     type ConnectPublicClientEvent as ConnectPublicClientEvent,
     type ConnectPublicServerEvent as ConnectPublicServerEvent,
   };

package/src/resources/ws-public/ws.ts

@@ -1,12 +1,11 @@
-
 import * as WS from 'ws';
 import { WsPublicEmitter, WsPublicStreamMessage, WebSocketError, buildURL } from './internal-base';
 import { InternalEventEmitter } from '../../core/EventEmitter';
 import { sleep } from '../../internal/utils/sleep';
 import { isRecoverableClose, type ReconnectingEvent, type ReconnectingOverrides } from '../../internal/ws';
-import * as WsPublicAPI from './ws-public';
-import { Upbit } from '../../client';
-import { jsonParseFloat } from '../../lib/jsonParseFloat';
+import type * as WsPublicAPI from './ws-public';
+import type { Upbit } from '../../client';
+import { isRecord, parseWebSocketValue } from '../../internal/ws-parser';
 
 export interface WsPublicWSReconnectOptions {
   /**
@@ -69,7 +68,7 @@ export class WsPublicWS extends WsPublicEmitter {
   ) {
     super();
     this._client = client;
-    this._parameters = undefined;
+    this._parameters = parameters;
     const { reconnect, ...wsOptions } = options ?? {};
     this._wsOptions = wsOptions;
     this._reconnectOptions = reconnect ?? null;
@@ -147,7 +146,7 @@ export class WsPublicWS extends WsPublicEmitter {
       push({ type: 'message', message: event });
     };
 
-    // All errors (API + socket) funnel through _onError → 'error' event
+    // Connection and transport errors funnel through _onError → 'error' event
     const onEmitterError = (err: WebSocketError) => {
       push({ type: 'error', error: err });
     };
@@ -272,27 +271,20 @@ export class WsPublicWS extends WsPublicEmitter {
 
     const socket = new WS.WebSocket(this.url, {
       ...this._wsOptions,
-      headers: {
-        ...this._authHeaders(),
-        ...this._wsOptions?.headers,
-      },
+      headers: this._client._buildWebSocketHandshakeHeaders(this._authHeaders(), this._wsOptions?.headers),
     });
 
     socket.on('message', (wsEvent) => {
-      const event = (() => {
-        try {
-          return jsonParseFloat(wsEvent.toString()) as WsPublicAPI.ConnectPublicServerEvent;
-        } catch (err) {
-          this._onError(null, 'could not parse websocket event', err);
-          return null;
-        }
-      })();
-
-      if (event) {
-        this._emit('event', event);
-
-        // @ts-ignore TS isn't smart enough to get the relationship right here
-        this._emit(event.type, event);
+      let event: unknown;
+      try {
+        event = parseWebSocketValue(wsEvent.toString());
+      } catch (error) {
+        this._onError(null, 'could not parse WebSocket message', new SyntaxError('Invalid WebSocket JSON'));
+        return;
+      }
+      this._emit('event', event as WsPublicAPI.ConnectPublicServerEvent);
+      if (isRecord(event) && typeof event['type'] === 'string') {
+        this._emit(event['type'] as any, event as any);
       }
     });
 

package/src/resources/ws-public.ts

@@ -1,2 +1 @@
-
 export * from './ws-public/index';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.9.0';
+export const VERSION = '1.1.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.9.0";
+export declare const VERSION = "1.1.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.9.0";
+export declare const VERSION = "1.1.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.9.0';
+exports.VERSION = '1.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.9.0';
+export const VERSION = '1.1.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}