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

package/dist/notifications.d.ts

@@ -1,32 +1,24 @@
-import type { Command } from "./command/command.js";
-import type { ClientInfo, ClientLeftViewEvent, ClientMovedEvent, TextMessage, PokeEvent, FileUploadInfo, FileDownloadInfo, FileTransferStatusInfo } from "./types.js";
+import type { Command } from "@honeybbq/teamspeak-core/internal";
+import type { ClientEnterEvent, ClientLeaveEvent, ClientMovedEvent, TextMessageEvent, PokeEvent } from "./types.js";
 export type NotificationResult = {
     kind: "clientEnter";
-    info: ClientInfo;
+    info: ClientEnterEvent;
 } | {
     kind: "clientLeave";
-    event: ClientLeftViewEvent;
+    event: ClientLeaveEvent;
     isSelf: boolean;
 } | {
     kind: "clientMoved";
     event: ClientMovedEvent;
+    reasonMessage: string;
 } | {
     kind: "textMessage";
-    message: TextMessage;
+    message: TextMessageEvent;
 } | {
     kind: "poked";
     event: PokeEvent;
-} | {
-    kind: "startUpload";
-    info: FileUploadInfo;
-} | {
-    kind: "startDownload";
-    info: FileDownloadInfo;
-} | {
-    kind: "fileTransferStatus";
-    info: FileTransferStatusInfo;
 } | {
     kind: "unknown";
 };
-export declare function handleNotification(cmd: Command, selfCLID: number, clients: Map<number, ClientInfo>, nickname: string): NotificationResult;
+export declare function handleNotification(cmd: Command, selfCLID: number, clients: Map<number, ClientEnterEvent>, _nickname: string): NotificationResult;
 //# sourceMappingURL=notifications.d.ts.map

package/dist/notifications.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../src/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,KAAK,EACV,UAAU,EACV,mBAAmB,EACnB,gBAAgB,EAChB,WAAW,EACX,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,YAAY,CAAC;AAGpB,MAAM,MAAM,kBAAkB,GAC1B;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAE,GACzC;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,mBAAmB,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,GACpE;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,gBAAgB,CAAA;CAAE,GAChD;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,OAAO,EAAE,WAAW,CAAA;CAAE,GAC7C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,cAAc,CAAA;CAAE,GAC7C;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,IAAI,EAAE,sBAAsB,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,OAAO,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAChC,QAAQ,EAAE,MAAM,GACf,kBAAkB,CAqBpB"}
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../src/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AACjE,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,SAAS,EACV,MAAM,YAAY,CAAC;AASpB,MAAM,MAAM,kBAAkB,GAC1B;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,GAC/C;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,GACjE;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,gBAAgB,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,GACvE;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,OAAO,EAAE,gBAAgB,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,OAAO,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,EACtC,SAAS,EAAE,MAAM,GAChB,kBAAkB,CAepB"}

package/dist/reconnect.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Reconnection policy.
+ *
+ * A dropped connection is normal on a UDP voice session, so a bot that cannot
+ * recover is not usable unattended. Reconnecting is opt-in rather than
+ * automatic: a silent reconnect makes a dropped session look like a healthy
+ * one, and a caller that wanted to know about the drop never finds out.
+ *
+ * Backoff is not a nicety here. TeamSpeak bans an IP that opens several
+ * connections in quick succession — measured at roughly three, after which the
+ * server answers `error id=3329` and refuses everything. A reconnect loop
+ * without a delay therefore bans itself, and the ban outlasts the outage it was
+ * recovering from.
+ */
+/** How long to wait before each attempt. */
+export interface BackoffPolicy {
+    /** Delay before the first retry, in milliseconds. */
+    readonly initialDelayMs: number;
+    /** Ceiling for the delay; it never grows past this. */
+    readonly maxDelayMs: number;
+    /** Multiplier applied after each failed attempt. */
+    readonly factor: number;
+    /**
+     * Fraction of the delay to randomise, 0 to 1.
+     *
+     * A fleet of bots that drop together would otherwise retry in lockstep and
+     * hit the server in a burst. Jitter spreads them out.
+     */
+    readonly jitter: number;
+    /** Give up after this many consecutive failures. 0 means never give up. */
+    readonly maxAttempts: number;
+}
+/** One second, doubling, capped at a minute, with 20% jitter, never giving up. */
+export declare const defaultBackoffPolicy: Readonly<BackoffPolicy>;
+/**
+ * How a client reconnects after its connection drops. Supplying it, even as
+ * `{}`, turns reconnecting on; a deliberate `disconnect()` never reconnects.
+ */
+export interface ReconnectOptions {
+    /** Tuning for the retry delays; unset fields keep {@link defaultBackoffPolicy}'s. */
+    readonly backoff?: {
+        readonly [K in keyof BackoffPolicy]?: BackoffPolicy[K] | undefined;
+    } | undefined;
+    /**
+     * Decide whether a given failure is worth retrying. Returning false stops the
+     * loop. Defaults to {@link defaultShouldRetry}.
+     */
+    readonly shouldRetry?: ((error: Error | undefined, attempt: number) => boolean) | undefined;
+}
+/**
+ * Compute the delay before an attempt.
+ *
+ * `attempt` is 1-based: the delay before the first retry is `initialDelayMs`,
+ * give or take the jitter, and the delay never grows past `maxDelayMs`.
+ */
+export declare function backoffDelay(policy: Readonly<BackoffPolicy>, attempt: number): number;
+/**
+ * Whether a failure is worth another attempt.
+ *
+ * Transport failures are retried; so is a server that stopped, and a server
+ * error other than the known refusals — a ban, flooding, a wrong server or
+ * channel password, missing permissions — since some, such as 521 "too many
+ * clones" right after a drop, clear by themselves. A kick or a ban is not:
+ * someone removed the client on purpose. Nor is an AlreadyConnectedError: the
+ * client was connected by other means; nor an InvalidAddressError.
+ */
+export declare function defaultShouldRetry(error: Error | undefined): boolean;
+export declare function resolveBackoffPolicy(options: ReconnectOptions): BackoffPolicy;
+//# sourceMappingURL=reconnect.d.ts.map

package/dist/reconnect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reconnect.d.ts","sourceRoot":"","sources":["../src/reconnect.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAKH,4CAA4C;AAC5C,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,uDAAuD;IACvD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,kFAAkF;AAClF,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC,aAAa,CAMvD,CAAC;AAEH;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qFAAqF;IACrF,QAAQ,CAAC,OAAO,CAAC,EACb;QAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,aAAa,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS;KAAE,GACtE,SAAS,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;CAC7F;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAErF;AA0CD;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,CASpE;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,gBAAgB,GAAG,aAAa,CAO7E"}

package/dist/throttle.d.ts

@@ -1,11 +1,20 @@
 /**
  * Token-bucket limiter for outbound TS3 commands.
  * Mirrors Go's commandThrottle.
+ *
+ * Waiters are released in the order they arrived: each used to poll for a
+ * token on its own timer, so a command that came later could take the turn of
+ * one that had waited longer, and the commands went out of order.
  */
 export declare class CommandThrottle {
     #private;
     static readonly TOKEN_RATE = 4;
     static readonly TOKEN_MAX = 8;
+    /**
+     * Wait for a token, behind every earlier waiter. Aborting `signal` rejects
+     * with its reason and gives the place in line up; the abort listener is
+     * removed however the wait ends.
+     */
     wait(signal?: AbortSignal): Promise<void>;
 }
 //# sourceMappingURL=throttle.d.ts.map

package/dist/throttle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"throttle.d.ts","sourceRoot":"","sources":["../src/throttle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,eAAe;;IAC1B,MAAM,CAAC,QAAQ,CAAC,UAAU,KAAO;IACjC,MAAM,CAAC,QAAQ,CAAC,SAAS,KAAO;IAK1B,IAAI,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAkChD"}
+{"version":3,"file":"throttle.d.ts","sourceRoot":"","sources":["../src/throttle.ts"],"names":[],"mappings":"AAMA;;;;;;;GAOG;AACH,qBAAa,eAAe;;IAC1B,MAAM,CAAC,QAAQ,CAAC,UAAU,KAAO;IACjC,MAAM,CAAC,QAAQ,CAAC,SAAS,KAAO;IAOhC;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAsBxC;CAyCF"}

package/dist/transfer.d.ts

@@ -1,30 +1,32 @@
-import type { Readable, Writable } from "node:stream";
-import type { FileUploadInfo, FileDownloadInfo } from "./types.js";
-import { FileTransferError, FileTransferTimeoutError } from "./errors.js";
-type FtNotification = FileUploadInfo | FileDownloadInfo | import("./types.js").FileTransferStatusInfo;
-export declare class FileTransferTracker {
-    #private;
-    register(): [cftid: number, promise: Promise<FtNotification>];
-    unregister(cftid: number): void;
-    notify(cftid: number, value: FtNotification): void;
-    reset(): void;
-}
-/**
- * Open a TCP connection to the TS3 file transfer port and perform the
- * ftkey handshake. The caller is responsible for closing the socket.
- */
-export declare function dialFileTransfer(host: string, port: number, key: string): Promise<import("node:net").Socket>;
-/** Upload data via a TS3 file transfer connection. */
-export declare function uploadFileData(host: string, info: FileUploadInfo, data: Readable): Promise<void>;
-/** Download data via a TS3 file transfer connection. */
-export declare function downloadFileData(host: string, info: FileDownloadInfo, dest: Writable): Promise<void>;
 /**
- * Build a ftinitupload command string.
+ * File transfer data.
+ *
+ * Negotiating a transfer is a command (`initFileUpload`, `initFileDownload`);
+ * the bytes then go over a separate TCP connection to the server's file
+ * transfer port, opened with the key the negotiation returned.
  */
-export declare function buildFtInitUpload(channelID: bigint, path: string, password: string, size: bigint, cftid: number, overwrite: boolean): string;
+import type { Duplex, Readable, Writable } from "node:stream";
+import type { FileUploadInfo, FileDownloadInfo } from "@honeybbq/teamspeak-core";
+import type { FileTransferSocketFactory } from "./types.js";
+import { FileTransferError } from "./errors.js";
+/** Options for a file transfer. */
+export interface FileTransferOptions {
+    /** Abandons the transfer; it then rejects with the signal's reason. */
+    readonly signal?: AbortSignal | undefined;
+    /**
+     * Opens the connection instead of a direct TCP dial, to route the transfer
+     * through a proxy or tunnel.
+     */
+    readonly socketFactory?: FileTransferSocketFactory | undefined;
+}
 /**
- * Build a ftinitdownload command string.
+ * Open a connection to the file transfer port and send the transfer key.
+ * The caller owns the returned stream and must end or destroy it.
  */
-export declare function buildFtInitDownload(channelID: bigint, path: string, password: string, cftid: number): string;
-export { FileTransferError, FileTransferTimeoutError };
+export declare function dialFileTransfer(host: string, port: number, key: string, options?: FileTransferOptions): Promise<Duplex>;
+/** Upload `data` over a negotiated transfer. Resolves once every byte is sent. */
+export declare function uploadFileData(host: string, info: FileUploadInfo, data: Readable, options?: FileTransferOptions): Promise<void>;
+/** Download a negotiated transfer into `dest`. Resolves once the file is written. */
+export declare function downloadFileData(host: string, info: FileDownloadInfo, dest: Writable, options?: FileTransferOptions): Promise<void>;
+export { FileTransferError };
 //# sourceMappingURL=transfer.d.ts.map

package/dist/transfer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transfer.d.ts","sourceRoot":"","sources":["../src/transfer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAG1E,KAAK,cAAc,GACf,cAAc,GACd,gBAAgB,GAChB,OAAO,YAAY,EAAE,sBAAsB,CAAC;AAEhD,qBAAa,mBAAmB;;IAI9B,QAAQ,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAU7D,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/B,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,GAAG,IAAI;IAKlD,KAAK,IAAI,IAAI;CAId;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,OAAO,UAAU,EAAE,MAAM,CAAC,CAmBpC;AAED,sDAAsD;AACtD,wBAAsB,cAAc,CAClC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,QAAQ,GACb,OAAO,CAAC,IAAI,CAAC,CAOf;AAED,wDAAwD;AACxD,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,gBAAgB,EACtB,IAAI,EAAE,QAAQ,GACb,OAAO,CAAC,IAAI,CAAC,CAQf;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,OAAO,GACjB,MAAM,CAWR;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,MAAM,CASR;AAED,OAAO,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,CAAC"}
+{"version":3,"file":"transfer.d.ts","sourceRoot":"","sources":["../src/transfer.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAKhD,mCAAmC;AACnC,MAAM,WAAW,mBAAmB;IAClC,uEAAuE;IACvE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC1C;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAC;CAChE;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,MAAM,CAAC,CA2BjB;AAuCD,kFAAkF;AAClF,wBAAsB,cAAc,CAClC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,IAAI,CAAC,CAGf;AAED,qFAAqF;AACrF,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,gBAAgB,EACtB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,IAAI,CAAC,CAGf;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/transport/generation-window.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generation-window.d.ts","sourceRoot":"","sources":["../../src/transport/generation-window.ts"],"names":[],"mappings":"AAAA,qBAAa,gBAAgB;;gBAMf,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAK3C,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAU7B,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAM5C,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAMjC,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAQxC,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAO1C,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAIzC,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAW5C,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAK1C,KAAK,IAAI,IAAI;CAId"}
+{"version":3,"file":"generation-window.d.ts","sourceRoot":"","sources":["../../src/transport/generation-window.ts"],"names":[],"mappings":"AAAA,qBAAa,gBAAgB;;IAM3B,YAAY,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAG1C;IAED,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAQ5B;IAED,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAI3C;IAED,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAIhC;IAED,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAMvC;IAED,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAKzC;IAED,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAExC;IAED,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAE3C;IASD,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAGzC;IAED,KAAK,IAAI,IAAI,CAGZ;CACF"}

package/dist/transport/handler.d.ts

@@ -1,20 +1,52 @@
-import { type Socket as UdpSocket } from "node:dgram";
 import type { Crypt } from "../crypto/crypt.js";
-import type { Logger } from "../types.js";
+import type { DatagramSocket, SocketFactory } from "../types.js";
+import type { Logger } from "@honeybbq/teamspeak-core";
 import { type Packet, PacketType } from "./packet.js";
+/**
+ * The largest datagram taken. TeamSpeak's packets are at most 500 bytes; a
+ * larger one is no packet of the protocol's, and is dropped before anything
+ * is decrypted or held.
+ */
+export declare const MAX_DATAGRAM_SIZE: number;
+/**
+ * The most command bytes held, across both receive queues, waiting for the
+ * packets before them. A server's in-order traffic drains at once and a full
+ * window of real packets is under a megabyte; past this, a packet is dropped
+ * unacknowledged, so the server sends it again once there is room.
+ */
+export declare const MAX_QUEUED_BYTES: number;
 export declare class PacketHandler {
     #private;
     onPacket: ((p: Packet) => void) | null;
     onClosed: ((err: Error | null) => void) | null;
-    constructor(crypt: Crypt, logger?: Logger);
+    /**
+     * A received datagram could not be handled: it was malformed, or handling it
+     * threw. The datagram is dropped either way; the owner decides whether that
+     * ends the connection. Without an owner the error is logged.
+     */
+    onReceiveError: ((error: unknown) => void) | null;
+    constructor(crypt: Crypt, logger?: Logger, socketFactory?: SocketFactory);
     setClientID(id: number): void;
-    connect(addr: string): Promise<void>;
-    start(conn: UdpSocket): void;
+    /**
+     * Resolve `addr`, open a socket to it and start the handshake.
+     *
+     * Aborting `signal`, or closing the handler, while this runs abandons it: the
+     * lookup's answer is ignored, and a socket that finishes connecting
+     * afterwards is closed rather than started, so no handshake begins after
+     * the connection was given up.
+     */
+    connect(addr: string, signal?: AbortSignal): Promise<void>;
+    /** Take over a connected socket and start the handshake on it. A closed handler closes it instead. */
+    start(conn: DatagramSocket): void;
     receivedFinalInitAck(): void;
     sendPacket(pType: PacketType, data: Uint8Array, flags: number): void;
     sendVoicePacket(data: Uint8Array, codec: number): void;
     /** Send an unencrypted TeamSpeak voice whisper packet to up to 32 clients. */
     sendWhisperPacket(data: Uint8Array, targetClientIds: number[], codec: number): void;
+    /** How many packets have been sent again for want of an acknowledgement. */
+    get resends(): number;
+    /** Whether there is a live socket to send on. */
+    get isOpen(): boolean;
     close(): void;
 }
 //# sourceMappingURL=handler.d.ts.map

package/dist/transport/handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/transport/handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,MAAM,IAAI,SAAS,EAAE,MAAM,YAAY,CAAC;AAGpE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EACL,KAAK,MAAM,EACX,UAAU,EAMX,MAAM,aAAa,CAAC;AAyBrB,qBAAa,aAAa;;IACxB,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAC9C,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;gBAyB1C,KAAK,EAAE,KAAK,EAAE,MAAM,GAAE,MAAmB;IAKrD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAI7B,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBpC,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;IAkC5B,oBAAoB,IAAI,IAAI;IAI5B,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IASpE,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IA+BtD,8EAA8E;IAC9E,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IA0CnF,KAAK,IAAI,IAAI;CA8cd"}
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/transport/handler.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EACL,KAAK,MAAM,EACX,UAAU,EAMX,MAAM,aAAa,CAAC;AA4BrB;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAa,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAgB,CAAC;AA4BhD,qBAAa,aAAa;;IACxB,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAC9C,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IACtD;;;;OAIG;IACH,cAAc,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAoCzD,YAAY,KAAK,EAAE,KAAK,EAAE,MAAM,GAAE,MAAmB,EAAE,aAAa,CAAC,EAAE,aAAa,EAInF;IAED,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAE5B;IAED;;;;;;;OAOG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAwD/D;IAOD,sGAAsG;IACtG,KAAK,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CA2ChC;IAED,oBAAoB,IAAI,IAAI,CAE3B;IAED,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAOnE;IAED,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CA6BrD;IAED,8EAA8E;IAC9E,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAwClF;IAED,4EAA4E;IAC5E,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,iDAAiD;IACjD,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,KAAK,IAAI,IAAI,CAmBZ;CAigBF"}

package/dist/transport/quicklz.d.ts

@@ -1,3 +1,22 @@
+/**
+ * The largest decompressed command accepted. A command is reassembled from at
+ * most a receive window of fragments, and the largest real answers (a full
+ * permission list, the welcome channel list of a big server) are a few
+ * hundred kilobytes; a header declaring more is refused before anything is
+ * allocated.
+ */
+export declare const MAX_DECOMPRESSED_SIZE: number;
+/** A QuickLZ block that cannot be decompressed: truncated, oversized or inconsistent. */
+export declare class QuickLZError extends Error {
+    constructor(message: string);
+}
+/**
+ * QuickLZ level 1 decompression, as the server compresses large commands.
+ *
+ * The input comes from the network, so every read and every back-reference is
+ * checked, and malformed input throws a QuickLZError rather than reading out
+ * of range or producing a partly filled buffer.
+ */
 export declare class Qlz {
     #private;
     decompress(data: Uint8Array): Uint8Array;

package/dist/transport/quicklz.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"quicklz.d.ts","sourceRoot":"","sources":["../../src/transport/quicklz.ts"],"names":[],"mappings":"AASA,qBAAa,GAAG;;IAGd,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU;CA+HzC"}
+{"version":3,"file":"quicklz.d.ts","sourceRoot":"","sources":["../../src/transport/quicklz.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAgB,CAAC;AAiBrD,yFAAyF;AACzF,qBAAa,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF;AAED;;;;;;GAMG;AACH,qBAAa,GAAG;;IAGd,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAoCvC;CAoGF"}