@honeybbq/teamspeak-client 0.3.1 → 1.0.0-beta.1

package/dist/types.d.ts

@@ -1,122 +1,302 @@
-/** A TS3-escaped string. Obtained only via escape(). */
-export type EscapedString = string & {
-    readonly __escaped: unique symbol;
-};
-export interface TextMessage {
-    invokerName: string;
-    invokerUID: string;
-    message: string;
-    invokerGroups: string[];
-    targetMode: number;
-    targetID: bigint;
-    invokerID: number;
+import type { ChannelID, ClientEntry, ClientID, CommandMiddleware, Logger, ServerGroupID, UID } from "@honeybbq/teamspeak-core";
+import type { Duplex } from "node:stream";
+import type { ReconnectOptions } from "./reconnect.js";
+/** A text message, sent privately, to a channel, or to the whole server. */
+export interface TextMessageEvent {
+    /** The sender's nickname. */
+    readonly invokerName: string;
+    /** The sender's unique identifier. */
+    readonly invokerUID: UID;
+    /** The message, unescaped. */
+    readonly message: string;
+    /** The sender's server groups, as this client last saw them. */
+    readonly invokerGroups: readonly ServerGroupID[];
+    /**
+     * Private, channel or server; compare it with `TextMessageTarget`. A plain
+     * number, since a server may send a mode that table does not name.
+     */
+    readonly targetMode: number;
+    /**
+     * The client a private message was sent to. Channel and server messages
+     * carry no target, so it is 0 for them.
+     */
+    readonly targetID: ClientID;
+    /** The sender. */
+    readonly invokerID: ClientID;
 }
+/** A client changing channel, of its own accord or moved by someone. */
 export interface ClientMovedEvent {
-    invokerName: string;
-    invokerUID: string;
-    targetChannelID: bigint;
-    reasonID: number;
-    id: number;
-    invokerID: number;
-}
-export interface ClientLeftViewEvent {
-    reasonMsg: string;
-    reasonID: number;
-    id: number;
-    targetID: number;
-}
-export interface ClientInfo {
-    nickname: string;
-    uid: string;
-    serverGroups: string[];
-    channelID: bigint;
-    type: number;
-    id: number;
-}
-export interface ChannelInfo {
-    name: string;
-    description: string;
-    id: bigint;
-    parentID: bigint;
-    /** ID of the sibling channel this one is sorted after; 0 means first. */
-    order: bigint;
+    /** Who moved the client; the client itself for a move of its own. */
+    readonly invokerName: string;
+    /** The mover's unique identifier. */
+    readonly invokerUID: UID;
+    /** The channel the client is now in. */
+    readonly targetChannelID: ChannelID;
+    /** Why the client moved; compare it with `Reason`. */
+    readonly reason: number;
+    /** The client that moved. */
+    readonly clientID: ClientID;
+    /** The mover. */
+    readonly invokerID: ClientID;
 }
-export interface FileUploadInfo {
-    fileTransferKey: string;
-    seekPosition: bigint;
-    clientFileTransferID: number;
-    serverFileTransferID: number;
-    port: number;
+/**
+ * A client going out of view: leaving the server, kicked or banned from it, or
+ * in a channel that stopped being subscribed.
+ */
+export interface ClientLeaveEvent {
+    /** The reason given for a kick or a ban, or the client's own parting message. */
+    readonly reasonMessage: string;
+    /** Why the client left; compare it with `Reason`. */
+    readonly reason: number;
+    /** The client that left. */
+    readonly clientID: ClientID;
+    /** Who kicked or banned the client; empty otherwise. */
+    readonly invokerName: string;
+    /** The kicker's unique identifier; empty unless kicked or banned. */
+    readonly invokerUID: UID;
+    /** The kicker; 0 unless kicked or banned. */
+    readonly invokerID: ClientID;
 }
-export interface FileDownloadInfo {
-    fileTransferKey: string;
-    size: bigint;
-    clientFileTransferID: number;
-    serverFileTransferID: number;
-    port: number;
-}
-export interface FileTransferStatusInfo {
-    message: string;
-    status: number;
-    clientFileTransferID: number;
+/** This client being kicked from its channel or the server. */
+export interface KickedEvent {
+    /** The reason the invoker gave. */
+    readonly reasonMessage: string;
+    /** `Reason.KickChannel`, `Reason.KickServer` or `Reason.KickServerBan`. */
+    readonly reason: number;
+    /** Who kicked this client. */
+    readonly invokerName: string;
+    /** The kicker's unique identifier. */
+    readonly invokerUID: UID;
+    /** The kicker. */
+    readonly invokerID: ClientID;
 }
+/**
+ * A client coming into view: the same record `listClients` returns, so one
+ * type describes a client however it was learned of; its own id is `id`, as
+ * in every record. The fields only `clientlist -times` reports are undefined
+ * here.
+ */
+export type ClientEnterEvent = ClientEntry;
+/** This client being poked. */
 export interface PokeEvent {
-    invokerName: string;
-    invokerUID: string;
-    invokerID: number;
-    message: string;
+    /** Who poked. */
+    readonly invokerName: string;
+    /** The poker's unique identifier. */
+    readonly invokerUID: UID;
+    /** The poker. */
+    readonly invokerID: ClientID;
+    /** The poke's message, unescaped. */
+    readonly message: string;
+}
+/** Audio from another client, in the channel or whispered. */
+export interface VoiceDataEvent {
+    /** Who is speaking. */
+    readonly clientID: ClientID;
+    /**
+     * How the audio is encoded; compare it with `Codec`. A plain number, since a
+     * server may relay a codec that table does not name.
+     */
+    readonly codec: number;
+    /** One encoded frame, copied: it stays valid after the listener returns. */
+    readonly data: Uint8Array;
 }
-export interface VoiceData {
-    clientId: number;
-    codec: number;
-    data: Uint8Array;
+/**
+ * A notification from the server, as it arrived: the escape hatch for one the
+ * SDK does not model.
+ */
+export interface NotificationEvent {
+    /** The notification's name, such as `notifyserveredited`. */
+    readonly name: string;
+    /** Its parameters, unescaped. */
+    readonly params: Readonly<Record<string, string>>;
 }
+/**
+ * The events `Client.on()` takes, and what each delivers. May gain events in a
+ * minor release; code that handles every event generically should expect
+ * names it does not know.
+ */
 export interface EventMap {
-    textMessage: TextMessage;
-    clientEnter: ClientInfo;
-    clientLeave: ClientLeftViewEvent;
+    /** A text message to this client, its channel or the server. */
+    textMessage: TextMessageEvent;
+    /** A client coming into view, including every client already there on connecting. */
+    clientEnter: ClientEnterEvent;
+    /** A client going out of view. */
+    clientLeave: ClientLeaveEvent;
+    /** A client changing channel. */
     clientMoved: ClientMovedEvent;
+    /** This client being poked. */
     poked: PokeEvent;
-    voiceData: VoiceData;
+    /**
+     * Audio from another client. Only decoded with a listener or event
+     * middleware. Voice is dropped, counted and reported in a warning at most
+     * every ten seconds, while more than 256 deliveries are waiting: a listener
+     * that cannot keep up loses audio rather than memory.
+     */
+    voiceData: VoiceDataEvent;
+    /**
+     * Every notification the server sends, modelled or not, after any event it
+     * produces.
+     */
+    notification: NotificationEvent;
+    /** The handshake completing, on `connect()` and on every reconnection. */
     connected: void;
+    /**
+     * `undefined` after `disconnect()`, and the cause otherwise: a failed
+     * handshake, a `ConnectionTimeoutError`, or a `RemovedError` for a kick, a
+     * ban or a server stopping.
+     */
     disconnected: Error | undefined;
-    kicked: string;
+    /** A kick from the server also ends the connection, which `disconnected` reports. */
+    kicked: KickedEvent;
 }
-export declare const enum ClientStatus {
-    Disconnected = 0,
-    Connecting = 1,
-    Connected = 2
+/**
+ * The events that come from the server, and so pass through event middleware.
+ * May gain members in a minor release: a `switch` over an event's name needs
+ * a default case.
+ */
+export type ServerEventName = "textMessage" | "clientEnter" | "clientLeave" | "clientMoved" | "poked" | "voiceData" | "notification";
+/** A server event as event middleware sees it. */
+export type ServerEvent = {
+    [K in ServerEventName]: {
+        readonly name: K;
+        readonly payload: EventMap[K];
+    };
+}[ServerEventName];
+/** A listener for one event. */
+export type Listener<K extends keyof EventMap> = EventMap[K] extends void ? () => void : (payload: EventMap[K]) => void;
+/** Removes a listener; calling it again does nothing. Also a `Disposable`, for `using`. */
+export type Unsubscribe = (() => void) & Disposable;
+/**
+ * The part of a UDP socket the client uses. A `node:dgram` socket is one; so
+ * is anything else with these methods, such as a tunnel or a test double.
+ *
+ * Should a later release use more of a socket, the new members will be
+ * optional here, so an implementation of this interface keeps compiling.
+ */
+export interface DatagramSocket {
+    /** Fix the peer, then call `callback`; failure is reported as an `error` event. */
+    connect(port: number, address: string, callback: () => void): void;
+    /** Send one datagram to the peer. */
+    send(data: Uint8Array, callback: (error: Error | null) => void): void;
+    /** Close the socket; it then emits `close`. */
+    close(): void;
+    /** Listen for each datagram received. */
+    on(event: "message", listener: (message: Uint8Array) => void): unknown;
+    /** Listen for a failure, which ends the connection. */
+    on(event: "error", listener: (error: Error) => void): unknown;
+    /** Listen for the socket closing. */
+    on(event: "close", listener: () => void): unknown;
+    /** Listen for the next failure only, while connecting. */
+    once(event: "error", listener: (error: Error) => void): unknown;
+    /** Stop listening for failures. */
+    off(event: "error", listener: (error: Error) => void): unknown;
 }
-export type CommandMiddleware = (next: (cmd: string) => Promise<void>) => (cmd: string) => Promise<void>;
-export type EventMiddleware = (next: (evt: EventMap[keyof EventMap]) => void) => (evt: EventMap[keyof EventMap]) => void;
-export interface Logger {
-    debug(msg: string, ...args: unknown[]): void;
-    info(msg: string, ...args: unknown[]): void;
-    warn(msg: string, ...args: unknown[]): void;
-    error(msg: string, ...args: unknown[]): void;
-}
-/** A no-op logger that discards all messages. */
-export declare const noopLogger: Logger;
-/** A console-backed logger. */
-export declare const consoleLogger: Logger;
+/** Creates the UDP socket the client talks through, for the given address family. */
+export type SocketFactory = (family: 4 | 6) => DatagramSocket;
+/**
+ * Opens the connection a file transfer runs over, to `host:port`. A
+ * `node:net` socket is one, as is the socket a SOCKS or HTTP proxy library
+ * returns. It may still be connecting when returned: the transfer waits for
+ * it.
+ */
+export type FileTransferSocketFactory = (host: string, port: number) => Duplex;
+/** The values of the table below, before freezing. */
+declare const clientStatusValues: {
+    /** Not connected: before `connect()`, after `disconnect()`, or after a drop. */
+    readonly Disconnected: "disconnected";
+    /** Connecting: `connect()` is waiting for the handshake. */
+    readonly Connecting: "connecting";
+    /** Connected: the handshake completed and commands can be sent. */
+    readonly Connected: "connected";
+};
+/** Where a client is in its connection's life. */
+export declare const ClientStatus: typeof clientStatusValues;
+/**
+ * One of {@link ClientStatus}. May gain members in a minor release: a
+ * `switch` over it needs a default case.
+ */
+export type ClientStatus = (typeof ClientStatus)[keyof typeof ClientStatus];
+/** Wraps the delivery of server events; it may observe, alter or drop them. */
+export type EventMiddleware = (next: (event: ServerEvent) => void) => (event: ServerEvent) => void;
+/**
+ * An address a server's name resolved to. Only `addr` is needed to connect;
+ * the rest describes the answer.
+ */
 export interface ResolvedAddr {
-    addr: string;
-    source: string;
-    expiry: Date;
+    /** The endpoint, as `host:port`. */
+    readonly addr: string;
+    /** How it was found, such as `SRV`, `TSDNS-SRV`, `TSDNS-Direct` or `Direct`. */
+    readonly source?: string | undefined;
+    /** When the answer stops being valid; unset for no stated lifetime. */
+    readonly expiry?: Date | undefined;
 }
+/**
+ * Turns the address a client was given — a host, `host:port`, or a TeamSpeak
+ * name — into endpoints to connect to. The default follows SRV records and
+ * TSDNS, as the TeamSpeak application does.
+ */
 export interface AddrResolver {
-    resolve(addr: string, signal?: AbortSignal): Promise<ResolvedAddr[]>;
+    /**
+     * The endpoints for `addr`, best first. An empty answer falls back to `addr`
+     * itself. `signal` aborts when the connection attempt is given up, or once
+     * resolution has taken 10 seconds, after which the client connects to
+     * `addr` as given; a resolver that ignores it is abandoned all the same.
+     */
+    resolve(addr: string, options?: {
+        readonly signal?: AbortSignal | undefined;
+    }): Promise<readonly ResolvedAddr[]>;
 }
+/** How a `Client` connects, logs and behaves; every field is optional. */
 export interface ClientOptions {
-    logger?: Logger;
-    resolver?: AddrResolver;
-    commandMiddleware?: CommandMiddleware[];
-    eventMiddleware?: EventMiddleware[];
+    /** Where the client logs. Silent unless set: a library has no business writing to the console. */
+    readonly logger?: Logger | undefined;
+    /**
+     * Creates the UDP socket the client talks through, given the address family
+     * the server's address resolved to.
+     *
+     * Supplying one lets an application route traffic through a proxy or tunnel,
+     * or drive the client from something other than a real socket. It is the only
+     * seam into the transport: without it the SDK always creates its own.
+     */
+    readonly socketFactory?: SocketFactory | undefined;
+    /**
+     * Reconnect after a dropped connection.
+     *
+     * Off by default: a silent reconnect makes an outage look like an ordinary
+     * session. An explicit `disconnect()` never reconnects regardless.
+     */
+    readonly reconnect?: ReconnectOptions | undefined;
+    /**
+     * Creates the TCP socket a file transfer runs over.
+     *
+     * Separate from `socketFactory` because file transfer dials its own
+     * connection to a different port, on demand. Set both to route everything
+     * through a proxy.
+     */
+    readonly fileTransferSocketFactory?: FileTransferSocketFactory | undefined;
+    /**
+     * Look a dot-less address up as a server nickname at named.myteamspeak.com,
+     * as the TeamSpeak application does. Off by default, since it sends the name
+     * to a third party; without it a dot-less name is resolved like any host.
+     * Ignored with a custom `resolver`.
+     */
+    readonly resolveNicknames?: boolean | undefined;
+    /** Replaces the SRV and TSDNS resolution `connect()` performs. */
+    readonly resolver?: AddrResolver | undefined;
+    /**
+     * Wraps every typed command, outermost first; see `CommandMiddleware`. Raw
+     * lines sent with `exec` and `execNoWait` do not pass through it. Fixed for
+     * the client's life.
+     */
+    readonly commandMiddleware?: readonly CommandMiddleware[] | undefined;
+    /** Wraps the delivery of every server event, outermost first. Fixed for the client's life. */
+    readonly eventMiddleware?: readonly EventMiddleware[] | undefined;
     /** Server password sent during the initial `clientinit` handshake. */
-    serverPassword?: string;
+    readonly serverPassword?: string | undefined;
     /** Default channel name to join during the initial `clientinit` handshake. */
-    defaultChannel?: string;
+    readonly defaultChannel?: string | undefined;
     /** Password for `defaultChannel`, sent during the initial `clientinit` handshake. */
-    defaultChannelPassword?: string;
+    readonly defaultChannelPassword?: string | undefined;
 }
+export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,wDAAwD;AACxD,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,SAAS,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAI3E,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,UAAU,CAAC;CAClB;AAID,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,UAAU,CAAC;IACxB,WAAW,EAAE,mBAAmB,CAAC;IACjC,WAAW,EAAE,gBAAgB,CAAC;IAC9B,KAAK,EAAE,SAAS,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;IAChB,YAAY,EAAE,KAAK,GAAG,SAAS,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB;AAID,0BAAkB,YAAY;IAC5B,YAAY,IAAI;IAChB,UAAU,IAAI;IACd,SAAS,IAAI;CACd;AAID,MAAM,MAAM,iBAAiB,GAAG,CAC9B,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,KACjC,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEpC,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,QAAQ,CAAC,KAAK,IAAI,KAC1C,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,QAAQ,CAAC,KAAK,IAAI,CAAC;AAI7C,MAAM,WAAW,MAAM;IACrB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC7C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC5C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC5C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;CAC9C;AAED,iDAAiD;AACjD,eAAO,MAAM,UAAU,EAAE,MAKxB,CAAC;AAEF,+BAA+B;AAC/B,eAAO,MAAM,aAAa,EAAE,MAK3B,CAAC;AAIF,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;CACd;AAID,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;CACtE;AAID,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,iBAAiB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACxC,eAAe,CAAC,EAAE,eAAe,EAAE,CAAC;IACpC,sEAAsE;IACtE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,8EAA8E;IAC9E,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qFAAqF;IACrF,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,QAAQ,EACR,iBAAiB,EACjB,MAAM,EACN,aAAa,EACb,GAAG,EACJ,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAIvD,4EAA4E;AAC5E,MAAM,WAAW,gBAAgB;IAC/B,6BAA6B;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,sCAAsC;IACtC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,8BAA8B;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,QAAQ,CAAC,aAAa,EAAE,SAAS,aAAa,EAAE,CAAC;IACjD;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,kBAAkB;IAClB,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC;CAC9B;AAED,wEAAwE;AACxE,MAAM,WAAW,gBAAgB;IAC/B,qEAAqE;IACrE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,wCAAwC;IACxC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC;IACpC,sDAAsD;IACtD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,6BAA6B;IAC7B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,iBAAiB;IACjB,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,qDAAqD;IACrD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,wDAAwD;IACxD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qEAAqE;IACrE,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,6CAA6C;IAC7C,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC;CAC9B;AAED,+DAA+D;AAC/D,MAAM,WAAW,WAAW;IAC1B,mCAAmC;IACnC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,8BAA8B;IAC9B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,sCAAsC;IACtC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,kBAAkB;IAClB,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAE3C,+BAA+B;AAC/B,MAAM,WAAW,SAAS;IACxB,iBAAiB;IACjB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,iBAAiB;IACjB,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,8DAA8D;AAC9D,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,gEAAgE;IAChE,WAAW,EAAE,gBAAgB,CAAC;IAC9B,qFAAqF;IACrF,WAAW,EAAE,gBAAgB,CAAC;IAC9B,kCAAkC;IAClC,WAAW,EAAE,gBAAgB,CAAC;IAC9B,iCAAiC;IACjC,WAAW,EAAE,gBAAgB,CAAC;IAC9B,+BAA+B;IAC/B,KAAK,EAAE,SAAS,CAAC;IACjB;;;;;OAKG;IACH,SAAS,EAAE,cAAc,CAAC;IAC1B;;;OAGG;IACH,YAAY,EAAE,iBAAiB,CAAC;IAChC,0EAA0E;IAC1E,SAAS,EAAE,IAAI,CAAC;IAChB;;;;OAIG;IACH,YAAY,EAAE,KAAK,GAAG,SAAS,CAAC;IAChC,qFAAqF;IACrF,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GACvB,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,OAAO,GACP,WAAW,GACX,cAAc,CAAC;AAEnB,kDAAkD;AAClD,MAAM,MAAM,WAAW,GAAG;KACvB,CAAC,IAAI,eAAe,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;KAAE;CAC5E,CAAC,eAAe,CAAC,CAAC;AAEnB,gCAAgC;AAChC,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,SAAS,IAAI,GACrE,MAAM,IAAI,GACV,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEnC,2FAA2F;AAC3F,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,UAAU,CAAC;AAIpD;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,mFAAmF;IACnF,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IACnE,qCAAqC;IACrC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,KAAK,IAAI,GAAG,IAAI,CAAC;IACtE,+CAA+C;IAC/C,KAAK,IAAI,IAAI,CAAC;IACd,yCAAyC;IACzC,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,IAAI,GAAG,OAAO,CAAC;IACvE,uDAAuD;IACvD,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;IAC9D,qCAAqC;IACrC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC;IAClD,0DAA0D;IAC1D,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;IAChE,mCAAmC;IACnC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;CAChE;AAED,qFAAqF;AACrF,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,cAAc,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAI/E,sDAAsD;AACtD,QAAA,MAAM,kBAAkB;IACtB,gFAAgF;aAChF,YAAY,EAAE,cAAc;IAC5B,4DAA4D;aAC5D,UAAU,EAAE,YAAY;IACxB,mEAAmE;aACnE,SAAS,EAAE,WAAW;CACd,CAAC;AACX,kDAAkD;AAClD,eAAO,MAAM,YAAY,EAAE,OAAO,kBACiB,CAAC;AACpD;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,+EAA+E;AAC/E,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;AAInG;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gFAAgF;IAChF,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,uEAAuE;IACvE,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACpC;AAID;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE,GACtD,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC,CAAC;CACrC;AAID,0EAA0E;AAC1E,MAAM,WAAW,aAAa;IAC5B,kGAAkG;IAClG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC;;;;;;;OAOG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACnD;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAClD;;;;;;OAMG;IACH,QAAQ,CAAC,yBAAyB,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAC3E;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChD,kEAAkE;IAClE,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,SAAS,iBAAiB,EAAE,GAAG,SAAS,CAAC;IACtE,8FAA8F;IAC9F,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,eAAe,EAAE,GAAG,SAAS,CAAC;IAClE,sEAAsE;IACtE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,8EAA8E;IAC9E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,qFAAqF;IACrF,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACtD"}

package/package.json

@@ -1,86 +1,51 @@
 {
   "name": "@honeybbq/teamspeak-client",
-  "version": "0.3.1",
-  "description": "TeamSpeak 3 client SDK for Node.js — a clean-room TypeScript port of the Go reference implementation",
+  "version": "1.0.0-beta.1",
+  "description": "A clean-room TeamSpeak client for Node.js, speaking the voice protocol the way the TeamSpeak application does",
   "keywords": [
     "client",
     "sdk",
     "teamspeak",
     "ts3",
+    "ts6",
     "voip"
   ],
   "license": "MIT",
   "author": "honeybbq",
   "repository": {
     "type": "git",
-    "url": "https://github.com/HoneyBBQ/teamspeak-js"
+    "url": "git+https://github.com/HoneyBBQ/teamspeak-js.git",
+    "directory": "packages/client"
   },
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/testing",
+    "LICENSE"
   ],
   "type": "module",
+  "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
-    },
-    "./crypto": {
-      "types": "./dist/crypto/index.d.ts",
-      "import": "./dist/crypto/index.mjs",
-      "require": "./dist/crypto/index.cjs"
-    },
-    "./transport": {
-      "types": "./dist/transport/index.d.ts",
-      "import": "./dist/transport/index.mjs",
-      "require": "./dist/transport/index.cjs"
-    },
-    "./discovery": {
-      "types": "./dist/discovery/index.d.ts",
-      "import": "./dist/discovery/index.mjs",
-      "require": "./dist/discovery/index.cjs"
-    },
-    "./command": {
-      "types": "./dist/command/index.d.ts",
-      "import": "./dist/command/index.mjs",
-      "require": "./dist/command/index.cjs"
-    },
-    "./handshake": {
-      "types": "./dist/handshake/index.d.ts",
-      "import": "./dist/handshake/index.mjs",
-      "require": "./dist/handshake/index.cjs"
+      "default": "./dist/index.js"
     }
   },
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "vite build && tsc -p tsconfig.build.json --emitDeclarationOnly",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "oxlint .",
-    "fmt": "oxfmt .",
-    "fmt:check": "oxfmt --check .",
-    "typecheck": "tsc --noEmit",
-    "check": "pnpm typecheck && pnpm lint && pnpm fmt:check",
-    "prepublishOnly": "pnpm run build",
-    "example": "tsx examples/connect.ts",
-    "test:integration": "TEAMSPEAK_ADDR=chenkr.cn vitest run src/integration.test.ts --reporter=verbose"
-  },
   "dependencies": {
-    "@noble/curves": "^2.0.1"
-  },
-  "devDependencies": {
-    "@types/node": "^26.1.1",
-    "oxfmt": "^0.71.0",
-    "oxlint": "^1.59.0",
-    "tsx": "^4.21.0",
-    "typescript": "^7.0.2",
-    "vite": "^8.0.8",
-    "vitest": "^5.0.0"
+    "@noble/curves": "^2.0.1",
+    "@honeybbq/teamspeak-core": "1.0.0-beta.1"
   },
   "engines": {
     "node": ">=20.19"
   },
-  "packageManager": "pnpm@10.32.1"
-}
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "example": "tsx examples/connect.ts"
+  },
+  "types": "./dist/index.d.ts"
+}

package/src/abort.ts

@@ -0,0 +1,24 @@
+/** The reason an aborted signal gives, as an error. */
+export function abortReason(signal: AbortSignal): unknown {
+  return signal.reason ?? new DOMException("This operation was aborted", "AbortError");
+}
+
+/** Settle with `promise`, or reject as soon as `signal` aborts, whichever is first. */
+export function abortable<T>(promise: Promise<T>, signal: AbortSignal | undefined): Promise<T> {
+  if (!signal) return promise;
+  if (signal.aborted) return Promise.reject(abortReason(signal));
+  return new Promise<T>((resolve, reject) => {
+    const onAbort = (): void => reject(abortReason(signal));
+    signal.addEventListener("abort", onAbort, { once: true });
+    promise.then(
+      (value) => {
+        signal.removeEventListener("abort", onAbort);
+        resolve(value);
+      },
+      (error: unknown) => {
+        signal.removeEventListener("abort", onAbort);
+        reject(error);
+      },
+    );
+  });
+}

package/src/address.ts

@@ -0,0 +1,74 @@
+import { isIP } from "node:net";
+import { InvalidAddressError } from "./errors.js";
+
+export interface HostPort {
+  host: string;
+  port: string;
+}
+
+/** Parse a TeamSpeak address without confusing an IPv6 colon for a port separator. */
+export function splitHostPort(address: string, defaultPort = "9987"): HostPort {
+  const input = address.trim();
+  if (input.startsWith("[")) {
+    const closingBracket = input.indexOf("]");
+    if (closingBracket > 0) {
+      const host = input.slice(1, closingBracket);
+      const suffix = input.slice(closingBracket + 1);
+      if (suffix.startsWith(":") && /^\d+$/.test(suffix.slice(1))) {
+        return { host, port: suffix.slice(1) };
+      }
+      if (!suffix) return { host, port: defaultPort };
+    }
+  }
+
+  // A raw IPv6 literal has no unambiguous port separator. Internal callers
+  // normally use bracket notation, but accepting the literal with the default
+  // port prevents a final IPv6 segment from being mistaken for a port.
+  if (isIP(input) === 6) return { host: input, port: defaultPort };
+
+  const lastColon = input.lastIndexOf(":");
+  if (lastColon < 0) return { host: input, port: defaultPort };
+  const candidatePort = input.slice(lastColon + 1);
+  if (/^\d+$/.test(candidatePort) && input.indexOf(":") === lastColon) {
+    return { host: input.slice(0, lastColon), port: candidatePort };
+  }
+  return { host: input, port: defaultPort };
+}
+
+/** Characters no host name or IP address contains, whitespace among them. */
+const NOT_IN_A_HOST = /[\s\p{Cc}/?#@[\]\\]/u;
+
+/**
+ * Parse an address to connect to, and check it can be one: a host, which
+ * contains nothing a host name or IP address cannot, and a port from 1 to
+ * 65535. Throws an InvalidAddressError otherwise.
+ */
+export function parseConnectAddress(address: string): HostPort & { portNumber: number } {
+  const { host, port } = splitHostPort(address);
+  if (host === "") throw new InvalidAddressError(address, "no host");
+  // A colon is left only in an IPv6 literal; anywhere else it is a port that
+  // is not a number, which splitHostPort keeps as part of the host.
+  if (NOT_IN_A_HOST.test(host) || (host.includes(":") && isIP(host) !== 6)) {
+    throw new InvalidAddressError(address, "not a host name, IP address or host:port");
+  }
+  const portNumber = Number(port);
+  if (!Number.isInteger(portNumber) || portNumber < 1 || portNumber > 65535) {
+    throw new InvalidAddressError(address, `port ${port} is not from 1 to 65535`);
+  }
+  return { host, port, portNumber };
+}
+
+export function joinHostPort(host: string, port: string): string {
+  const normalizedHost = stripBrackets(host);
+  return isIP(normalizedHost) === 6 || normalizedHost.includes(":")
+    ? `[${normalizedHost}]:${port}`
+    : `${normalizedHost}:${port}`;
+}
+
+export function isIpAddress(host: string): boolean {
+  return isIP(stripBrackets(host)) !== 0;
+}
+
+function stripBrackets(host: string): string {
+  return host.startsWith("[") && host.endsWith("]") ? host.slice(1, -1) : host;
+}