@laplace.live/ws 7.1.8 → 7.1.10

package/dist/ws-mjTot1Nb.d.ts

@@ -1,301 +0,0 @@
-import { BilibiliInternal } from '@laplace.live/internal';
-
-/**
- * Platform-specific inflate/decompress implementations injected into the
- * decoder at construction time.
- *
- * - **Node / Bun**: backed by `node:zlib` (`inflate` + `brotliDecompress`).
- * - **Browser**: backed by native `DecompressionStream` (inflate) + a bundled JS Brotli decoder.
- */
-type Inflates = {
-    inflateAsync: (b: Uint8Array<ArrayBuffer>) => Uint8Array | Promise<Uint8Array>;
-    brotliDecompressAsync: (b: Uint8Array<ArrayBuffer>) => Uint8Array | Promise<Uint8Array>;
-};
-
-/**
- * A typed {@link Event} that carries an arbitrary data payload.
- *
- * Used throughout the library to deliver structured messages such as
- * heartbeat counts, danmaku payloads, and other server-pushed data.
- *
- * Also used internally with `LaplaceRawEvent<Event>` as a catch-all meta-event
- * (type `"event"`) to forward all events through {@link KeepLive}.
- *
- * @typeParam T - The type of the data payload attached to this event.
- *
- * @example
- * ```ts
- * live.addEventListener('heartbeat', (e) => {
- *   console.log('online:', e.data)
- * })
- * ```
- */
-declare class LaplaceRawEvent<T> extends Event {
-    data: T;
-    constructor(type: string, data: T);
-}
-/**
- * Maps known event names to their event types for typed `addEventListener`.
- *
- * - Built-in lifecycle events (`open`, `live`, `close`, etc.) map to plain `Event`.
- * - `heartbeat` maps to `LaplaceRawEvent<number>` (online viewer count).
- * - `msg` maps to `LaplaceRawEvent<unknown>` (any server command).
- * - Bilibili commands map to `LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.*>`.
- * - Unknown/dynamic events fall through to a generic overload on `addEventListener`.
- */
-interface LiveEventMap {
-    open: Event;
-    live: Event;
-    close: Event;
-    error: Event;
-    heartbeat: LaplaceRawEvent<number>;
-    msg: LaplaceRawEvent<unknown>;
-    event: LaplaceRawEvent<Event>;
-    DANMU_MSG: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.DANMU_MSG>;
-    RECALL_DANMU_MSG: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.RECALL_DANMU_MSG>;
-    INTERACT_WORD: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.INTERACT_WORD>;
-    ENTRY_EFFECT: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ENTRY_EFFECT>;
-    USER_TOAST_MSG: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.USER_TOAST_MSG>;
-    USER_TOAST_MSG_V2: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.USER_TOAST_MSG_V2>;
-    SEND_GIFT: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.SEND_GIFT>;
-    SEND_GIFT_V2: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.SEND_GIFT_V2>;
-    INTERACT_WORD_V2: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.INTERACT_WORD_V2>;
-    SUPER_CHAT_MESSAGE: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.SUPER_CHAT_MESSAGE>;
-    SUPER_CHAT_MESSAGE_DELETE: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.SUPER_CHAT_MESSAGE_DELETE>;
-    USER_VIRTUAL_MVP: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.USER_VIRTUAL_MVP>;
-    LIKE_INFO_V3_CLICK: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.LIKE_INFO_V3_CLICK>;
-    POPULARITY_RED_POCKET_START: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.POPULARITY_RED_POCKET_START>;
-    POPULARITY_RED_POCKET_V2_START: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.POPULARITY_RED_POCKET_V2_START>;
-    POPULARITY_RED_POCKET_WINNER_LIST: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.POPULARITY_RED_POCKET_WINNER_LIST>;
-    POPULARITY_RED_POCKET_V2_WINNER_LIST: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.POPULARITY_RED_POCKET_V2_WINNER_LIST>;
-    ANCHOR_LOT_START: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ANCHOR_LOT_START>;
-    ANCHOR_LOT_AWARD: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ANCHOR_LOT_AWARD>;
-    COMMON_NOTICE_DANMAKU: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.COMMON_NOTICE_DANMAKU>;
-    EFFECT_DANMAKU_MSG: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.EFFECT_DANMAKU_MSG>;
-    DANMU_ACTIVITY_CONFIG: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.DANMU_ACTIVITY_CONFIG>;
-    ROOM_CHANGE: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ROOM_CHANGE>;
-    ROOM_SILENT_ON: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ROOM_SILENT_ON>;
-    ROOM_SILENT_OFF: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ROOM_SILENT_OFF>;
-    WATCHED_CHANGE: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.WATCHED_CHANGE>;
-    LIKE_INFO_V3_UPDATE: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.LIKE_INFO_V3_UPDATE>;
-    ONLINE_RANK_COUNT: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ONLINE_RANK_COUNT>;
-    ONLINE_RANK_V2: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ONLINE_RANK_V2>;
-    ONLINE_RANK_V3: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ONLINE_RANK_V3>;
-    ROOM_REAL_TIME_MESSAGE_UPDATE: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ROOM_REAL_TIME_MESSAGE_UPDATE>;
-    ROOM_REAL_TIME_MESSAGE_UPDATE_V2: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ROOM_REAL_TIME_MESSAGE_UPDATE_V2>;
-    LIVE: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.LIVE>;
-    PREPARING: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.PREPARING>;
-    WARNING: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.WARNING>;
-    CUT_OFF: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.CUT_OFF>;
-    ROOM_BLOCK_MSG: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ROOM_BLOCK_MSG>;
-    ROOM_ADMINS: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ROOM_ADMINS>;
-    room_admin_entrance: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.room_admin_entrance>;
-    ROOM_ADMIN_REVOKE: LaplaceRawEvent<BilibiliInternal.WebSocket.Prod.ROOM_ADMIN_REVOKE>;
-    LIVE_OPEN_PLATFORM_DM: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_DM>;
-    LIVE_OPEN_PLATFORM_SEND_GIFT: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_SEND_GIFT>;
-    LIVE_OPEN_PLATFORM_SUPER_CHAT: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_SUPER_CHAT>;
-    LIVE_OPEN_PLATFORM_GUARD: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_GUARD>;
-    LIVE_OPEN_PLATFORM_LIKE: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_LIKE>;
-    LIVE_OPEN_PLATFORM_LIVE_ROOM_ENTER: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_LIVE_ROOM_ENTER>;
-    LIVE_OPEN_PLATFORM_LIVE_START: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_LIVE_START>;
-    LIVE_OPEN_PLATFORM_LIVE_END: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_LIVE_END>;
-    LIVE_OPEN_PLATFORM_INTERACTION_END: LaplaceRawEvent<BilibiliInternal.WebSocket.OpenPlatform.LIVE_OPEN_PLATFORM_INTERACTION_END>;
-}
-/**
- * Typed {@link EventTarget} base class for live connections.
- *
- * Provides typed `addEventListener` / `removeEventListener` via
- * {@link LiveEventMap} and a `dispatchEvent` override that emits a
- * catch-all `"event"` meta-event for every dispatched event.
- *
- * Extend this instead of `EventTarget` when building wrappers around
- * `LiveWS` / `KeepLiveWS` to inherit typed event signatures
- * automatically — no `declare` duplication required.
- *
- * @example
- * ```ts
- * import { LaplaceEventTarget, LaplaceRawEvent } from '@laplace.live/ws'
- *
- * class MyWrapper extends LaplaceEventTarget {
- *   // addEventListener is already typed — no extra `declare` needed
- * }
- * ```
- */
-declare class LaplaceEventTarget extends EventTarget {
-    dispatchEvent(event: Event): boolean;
-    addEventListener: {
-        <K extends keyof LiveEventMap>(type: K, listener: (ev: LiveEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
-        <T = unknown>(type: string, listener: (ev: LaplaceRawEvent<T>) => void, options?: boolean | AddEventListenerOptions): void;
-    };
-    removeEventListener: {
-        <K extends keyof LiveEventMap>(type: K, listener: (ev: LiveEventMap[K]) => void, options?: boolean | EventListenerOptions): void;
-        (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
-    };
-}
-
-/**
- * Options for configuring the Bilibili live connection authentication.
- *
- * When {@link authBody} is provided it takes precedence over all other
- * fields and is sent as the join payload verbatim.
- */
-type LiveOptions = {
-    /** Protocol version. Defaults to `3` (brotli-compressed). */
-    protover?: 1 | 2 | 3;
-    /** Authentication token obtained from the danmaku info API. */
-    key?: string;
-    /**
-     * Pre-built authentication body. When supplied as a `Uint8Array` it is
-     * sent raw; when supplied as an object it is JSON-encoded before sending.
-     * Takes precedence over {@link key}, {@link uid}, and {@link buvid}.
-     */
-    authBody?: Uint8Array | Record<string, unknown>;
-    /** User ID. Defaults to `0` (anonymous). */
-    uid?: number;
-    /** Browser unique visitor ID used for risk-control tracking. */
-    buvid?: string;
-};
-/**
- * Base class for a single Bilibili live room connection.
- *
- * Extends {@link LaplaceEventTarget} and emits the following events:
- *
- * | Event         | Payload            | Description                                      |
- * |---------------|--------------------|--------------------------------------------------|
- * | `open`        | —                  | Underlying transport connected.                  |
- * | `live`        | —                  | Server acknowledged the join (room entered).     |
- * | `heartbeat`   | `LaplaceRawEvent<number>`| Online viewer count received from server.        |
- * | `msg`         | `LaplaceRawEvent<any>`   | Any server command message.                      |
- * | `DANMU_MSG`   | `LaplaceRawEvent<any>`   | Danmaku (chat) message.                          |
- * | `close`       | —                  | Connection closed.                               |
- * | `error`       | —                  | Unrecoverable error (connection is closed).      |
- * | `event`       | `LaplaceRawEvent<Event>` | Meta-event wrapping every dispatched event.      |
- *
- * Subclasses ({@link LiveWSBase}, {@link LiveTCPBase}) provide the concrete
- * transport and supply `send` / `close` callbacks to this constructor.
- *
- * @param inflates - Platform-specific inflate + brotli decompressors.
- * @param roomid   - Numeric Bilibili live room ID.
- * @param options  - Transport callbacks and authentication options.
- *
- * @throws {Error} If `roomid` is not a finite number.
- */
-declare class Live extends LaplaceEventTarget {
-    /** The live room ID this instance is connected to. */
-    roomid: number;
-    /** Latest known online viewer count, updated on each heartbeat. */
-    online: number;
-    /** `true` after the server acknowledges the join (`welcome` packet). */
-    live: boolean;
-    /** `true` after {@link close} has been called. */
-    closed: boolean;
-    /** @internal Handle for the heartbeat interval timer. */
-    timeout: ReturnType<typeof setTimeout>;
-    /** Send raw binary data over the underlying transport. */
-    send: (data: Uint8Array) => void;
-    /** Gracefully close the connection and set {@link closed} to `true`. */
-    close: () => void;
-    constructor(inflates: Inflates, roomid: number, { send, close, protover, key, authBody, uid, buvid, }: {
-        send: (data: Uint8Array) => void;
-        close: () => void;
-    } & LiveOptions);
-    /** Send a heartbeat packet to the server. */
-    heartbeat(): void;
-    /**
-     * Send a heartbeat and resolve with the online viewer count from the
-     * next heartbeat response.
-     * @returns A promise that resolves with the current online count.
-     */
-    getOnline(): Promise<number>;
-}
-
-/**
- * Auto-reconnecting wrapper around a {@link Live} subclass.
- *
- * `KeepLive` maintains a persistent connection to a Bilibili live room by
- * automatically re-creating the underlying {@link Live} instance whenever
- * the connection drops or a heartbeat timeout is reached. All events from
- * the inner connection are forwarded to this instance.
- *
- * @typeParam T - The concrete {@link Live} instance type being managed.
- *
- * @example
- * ```ts
- * const keep = new KeepLiveWS(12345, { key: '...' })
- * keep.addEventListener('heartbeat', (e) => console.log('online:', e.data))
- * keep.addEventListener('DANMU_MSG', ({ data }) => console.log('danmaku:', data.msg_id))
- * ```
- */
-declare class KeepLive<T extends Live> extends LaplaceEventTarget {
-    /** @internal Factory that creates a fresh connection with the original arguments. */
-    private createConnection;
-    /** `true` after {@link close} has been called; prevents further reconnects. */
-    closed: boolean;
-    /** Delay in milliseconds before attempting a reconnect. */
-    interval: number;
-    /** Maximum milliseconds to wait for a heartbeat before forcing a reconnect. */
-    timeout: number;
-    /** The current underlying connection instance. */
-    connection: T;
-    constructor(createConnection: () => T);
-    /**
-     * Wire up event forwarding and timeout handling on the current connection.
-     * When `reconnect` is `true`, the previous connection is closed and a fresh
-     * one is created via the factory.
-     *
-     * @param reconnect - Whether to tear down and recreate the connection first.
-     */
-    connect(reconnect?: boolean): void;
-    /** Latest known online viewer count from the underlying connection. */
-    get online(): number;
-    /** The live room ID. */
-    get roomid(): number;
-    /** Permanently close the connection and stop reconnecting. */
-    close(): void;
-    /** Send a heartbeat packet to the server. */
-    heartbeat(): void;
-    /**
-     * Send a heartbeat and resolve with the online viewer count from the
-     * next heartbeat response.
-     * @returns A promise that resolves with the current online count.
-     */
-    getOnline(): Promise<number>;
-    /**
-     * Send raw binary data through the underlying connection.
-     * @param data - The binary packet to send.
-     */
-    send(data: Uint8Array): void;
-}
-
-/**
- * Configuration options for WebSocket-based live connections.
- * Extends {@link LiveOptions} with an optional WebSocket server address.
- */
-type WSOptions = LiveOptions & {
-    /** WebSocket server URL. Defaults to `wss://broadcastlv.chat.bilibili.com/sub`. */
-    address?: string;
-    /** Factory to create the WebSocket (e.g. for runtime-specific options like Bun's proxy). */
-    createWebSocket?: (address: string) => WebSocket;
-};
-/**
- * WebSocket transport for Bilibili live room connections.
- *
- * Wraps a native {@link WebSocket}, wiring its lifecycle events (`open`,
- * `message`, `close`, `error`) into the {@link Live} event system. Binary
- * frames are forwarded as `LaplaceRawEvent<Uint8Array>` for protocol decoding.
- *
- * Not typically instantiated directly — use {@link LiveWS} (server) or the
- * browser-specific `LiveWS` which inject the appropriate inflate
- * implementation.
- *
- * @param inflates - Platform-specific inflate/brotli decompressors.
- * @param roomid   - Numeric Bilibili live room ID.
- * @param options  - WebSocket address and authentication options.
- */
-declare class LiveWSBase extends Live {
-    /** The underlying native WebSocket instance. */
-    ws: WebSocket;
-    constructor(inflates: Inflates, roomid: number, { address, createWebSocket, ...options }?: WSOptions);
-}
-
-export { type Inflates as I, KeepLive as K, Live as L, type WSOptions as W, type LiveOptions as a, LiveWSBase as b, LaplaceEventTarget as c, LaplaceRawEvent as d, type LiveEventMap as e };