@honeybbq/teamspeak 0.0.1 → 1.0.0-beta.10

package/dist/client/abort.d.ts

@@ -0,0 +1,5 @@
+/** The reason an aborted signal gives, as an error. */
+export declare function abortReason(signal: AbortSignal): unknown;
+/** Settle with `promise`, or reject as soon as `signal` aborts, whichever is first. */
+export declare function abortable<T>(promise: Promise<T>, signal: AbortSignal | undefined): Promise<T>;
+//# sourceMappingURL=abort.d.ts.map

package/dist/client/abort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort.d.ts","sourceRoot":"","sources":["../../src/client/abort.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,wBAAgB,WAAW,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAExD;AAED,uFAAuF;AACvF,wBAAgB,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAiB7F"}

package/dist/client/abort.js

@@ -0,0 +1,23 @@
+/** The reason an aborted signal gives, as an error. */
+export function abortReason(signal) {
+    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(promise, signal) {
+    if (!signal)
+        return promise;
+    if (signal.aborted)
+        return Promise.reject(abortReason(signal));
+    return new Promise((resolve, reject) => {
+        const onAbort = () => reject(abortReason(signal));
+        signal.addEventListener("abort", onAbort, { once: true });
+        promise.then((value) => {
+            signal.removeEventListener("abort", onAbort);
+            resolve(value);
+        }, (error) => {
+            signal.removeEventListener("abort", onAbort);
+            reject(error);
+        });
+    });
+}
+//# sourceMappingURL=abort.js.map

package/dist/client/abort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort.js","sourceRoot":"","sources":["../../src/client/abort.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,MAAM,UAAU,WAAW,CAAC,MAAmB;IAC7C,OAAO,MAAM,CAAC,MAAM,IAAI,IAAI,YAAY,CAAC,4BAA4B,EAAE,YAAY,CAAC,CAAC;AACvF,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,SAAS,CAAI,OAAmB,EAAE,MAA+B;IAC/E,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC;IAC5B,IAAI,MAAM,CAAC,OAAO;QAAE,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/D,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,MAAM,OAAO,GAAG,GAAS,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;QACxD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CACV,CAAC,KAAK,EAAE,EAAE;YACR,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7C,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/client/address.d.ts

@@ -0,0 +1,17 @@
+export interface HostPort {
+    host: string;
+    port: string;
+}
+/** Parse a TeamSpeak address without confusing an IPv6 colon for a port separator. */
+export declare function splitHostPort(address: string, defaultPort?: string): HostPort;
+/**
+ * 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 declare function parseConnectAddress(address: string): HostPort & {
+    portNumber: number;
+};
+export declare function joinHostPort(host: string, port: string): string;
+export declare function isIpAddress(host: string): boolean;
+//# sourceMappingURL=address.d.ts.map

package/dist/client/address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../../src/client/address.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,sFAAsF;AACtF,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,SAAS,GAAG,QAAQ,CA0B7E;AAKD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,GAAG;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAatF;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAK/D;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD"}

package/dist/client/address.js

@@ -0,0 +1,66 @@
+import { isIP } from "node:net";
+import { InvalidAddressError } from "./errors.js";
+/** Parse a TeamSpeak address without confusing an IPv6 colon for a port separator. */
+export function splitHostPort(address, defaultPort = "9987") {
+    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) {
+    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, port) {
+    const normalizedHost = stripBrackets(host);
+    return isIP(normalizedHost) === 6 || normalizedHost.includes(":")
+        ? `[${normalizedHost}]:${port}`
+        : `${normalizedHost}:${port}`;
+}
+export function isIpAddress(host) {
+    return isIP(stripBrackets(host)) !== 0;
+}
+function stripBrackets(host) {
+    return host.startsWith("[") && host.endsWith("]") ? host.slice(1, -1) : host;
+}
+//# sourceMappingURL=address.js.map

package/dist/client/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../src/client/address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAOlD,sFAAsF;AACtF,MAAM,UAAU,aAAa,CAAC,OAAe,EAAE,WAAW,GAAG,MAAM;IACjE,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;YAC/C,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5D,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACzC,CAAC;YACD,IAAI,CAAC,MAAM;gBAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;QAClD,CAAC;IACH,CAAC;IAED,yEAAyE;IACzE,4EAA4E;IAC5E,qEAAqE;IACrE,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAEjE,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,SAAS,GAAG,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAC7D,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IACjD,IAAI,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;QACpE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;IAClE,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AAC5C,CAAC;AAED,6EAA6E;AAC7E,MAAM,aAAa,GAAG,sBAAsB,CAAC;AAE7C;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe;IACjD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9C,IAAI,IAAI,KAAK,EAAE;QAAE,MAAM,IAAI,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACnE,2EAA2E;IAC3E,kEAAkE;IAClE,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACzE,MAAM,IAAI,mBAAmB,CAAC,OAAO,EAAE,0CAA0C,CAAC,CAAC;IACrF,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,UAAU,GAAG,CAAC,IAAI,UAAU,GAAG,KAAK,EAAE,CAAC;QAC1E,MAAM,IAAI,mBAAmB,CAAC,OAAO,EAAE,QAAQ,IAAI,yBAAyB,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,IAAY;IACrD,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC;QAC/D,CAAC,CAAC,IAAI,cAAc,KAAK,IAAI,EAAE;QAC/B,CAAC,CAAC,GAAG,cAAc,IAAI,IAAI,EAAE,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/E,CAAC"}

package/dist/client/api/avatars.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Avatars and icons: the file transfers behind them.
+ *
+ * Both live in channel 0's file area, so each helper negotiates a transfer
+ * (`ftinitupload`, `ftinitdownload`) and moves the bytes over the client's own
+ * file transfer connection, as `Client.uploadFileData` does.
+ */
+import type { IconID, UID } from "@honeybbq/teamspeak";
+import type { Client } from "../client.js";
+import type { FileTransferOptions } from "../transfer.js";
+/** Options for the avatar and icon transfers. */
+export type AvatarTransferOptions = Pick<FileTransferOptions, "signal" | "trace">;
+/**
+ * Upload `data` as this client's avatar and set `client_flag_avatar` to its
+ * MD5, so that other clients see the change in a `clientUpdated` event.
+ *
+ * On the wire: `ftinitupload cid=0 name=/avatar_<md5 hex>` with `overwrite=1`,
+ * the bytes over the file transfer port, then
+ * `clientupdate client_flag_avatar=<md5>`. The server does not keep the file under the MD5
+ * name: it stores it as {@link avatarFileName} of the client's unique id (20
+ * bytes of SHA-1 on TeamSpeak 3, 32 of SHA-256 on TeamSpeak 6). Returns the
+ * MD5, lower-case hex.
+ *
+ * The size limit is the permission `i_client_max_avatar_filesize`, 200000
+ * bytes for a Server Admin; over it, the negotiation fails with a ServerError
+ * 2565 (invalid size) and nothing is sent or changed. A file of exactly the
+ * limit passes.
+ */
+export declare function uploadAvatar(client: Client, data: Uint8Array, options?: AvatarTransferOptions): Promise<string>;
+/**
+ * The bytes of the avatar of the client with this unique id, or undefined when
+ * the server has no avatar file for it (`ftinitdownload cid=0` with the name
+ * from {@link avatarFileName}; error 2051 on TeamSpeak 6, 2054 on
+ * TeamSpeak 3). Setting the flag empty alone leaves the file in place;
+ * `removeAvatar` deletes it.
+ */
+export declare function downloadAvatar(client: Client, uid: UID | string, options?: AvatarTransferOptions): Promise<Uint8Array | undefined>;
+/**
+ * Remove this client's own avatar: `ftdeletefile cid=0 name=/avatar_`, which,
+ * as measured on both servers, deletes the caller's stored avatar file and
+ * empties `client_flag_avatar`. Deleting the file by its stored name was
+ * refused with 1540, and TS6's `clientavatardeleted` (given `cluid`) answered
+ * OK without removing it; this is the removal that worked.
+ * Resolves with true when an avatar was removed, false when there was none
+ * (error 2054).
+ */
+export declare function removeAvatar(client: Client, options?: AvatarTransferOptions): Promise<boolean>;
+/**
+ * Upload `data` as an icon and return its id, the CRC-32 of the bytes
+ * ({@link iconIDOf}).
+ *
+ * On the wire: `ftinitupload cid=0 name=/icon_<id>` with `overwrite=1`, then
+ * the bytes; the server keeps it in channel 0's `icons` directory. The id is
+ * not checked by the server against the bytes, and the file does not
+ * reference anything by itself: pass the id to `setChannelIcon`, `setServerGroupIcon`,
+ * `setChannelGroupIcon`, `setClientIcon` or `setServerIcon`.
+ *
+ * Needs `b_icon_manage` (error 2568 without it). The size limit is
+ * `i_max_icon_filesize`, 8192 bytes for a Server Admin; over it, the
+ * negotiation fails with a ServerError 2565 (invalid size).
+ */
+export declare function uploadIcon(client: Client, data: Uint8Array, options?: AvatarTransferOptions): Promise<IconID>;
+/** The bytes of an icon, or undefined when the server has no file for the id. */
+export declare function downloadIcon(client: Client, id: IconID, options?: AvatarTransferOptions): Promise<Uint8Array | undefined>;
+//# sourceMappingURL=avatars.d.ts.map

package/dist/client/api/avatars.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"avatars.d.ts","sourceRoot":"","sources":["../../../src/client/api/avatars.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAgBH,OAAO,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAE1D,iDAAiD;AACjD,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC;AAiClF;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,UAAU,EAChB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,MAAM,CAAC,CASjB;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,GAAG,GAAG,MAAM,EACjB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,OAAO,CAAC,CAQlB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,UAAU,EAChB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,MAAM,CAAC,CAQjB;AAED,iFAAiF;AACjF,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAEjC"}

package/dist/client/api/avatars.js

@@ -0,0 +1,118 @@
+/**
+ * Avatars and icons: the file transfers behind them.
+ *
+ * Both live in channel 0's file area, so each helper negotiates a transfer
+ * (`ftinitupload`, `ftinitdownload`) and moves the bytes over the client's own
+ * file transfer connection, as `Client.uploadFileData` does.
+ */
+import { createHash } from "node:crypto";
+import { Readable, Writable } from "node:stream";
+import { ErrorCode, ServerError, asChannelID, avatarFileName, deleteFile, iconFileName, iconIDOf, initFileDownload, initFileUpload, updateClient, } from "@honeybbq/teamspeak";
+const CHANNEL_ZERO = asChannelID(0n);
+async function download(client, name, options) {
+    let info;
+    try {
+        info = await initFileDownload(client, CHANNEL_ZERO, name, options);
+    }
+    catch (error) {
+        // TeamSpeak 6 answers 2051 for a file that is not there, TeamSpeak 3 2054.
+        if (error instanceof ServerError &&
+            (error.code === ErrorCode.FileNotFound || error.code === ErrorCode.FileInvalidPath)) {
+            return undefined;
+        }
+        throw error;
+    }
+    const chunks = [];
+    const sink = new Writable({
+        write(chunk, _encoding, done) {
+            chunks.push(chunk);
+            done();
+        },
+    });
+    await client.downloadFileData(client.host, info, sink, options);
+    return new Uint8Array(Buffer.concat(chunks));
+}
+/**
+ * Upload `data` as this client's avatar and set `client_flag_avatar` to its
+ * MD5, so that other clients see the change in a `clientUpdated` event.
+ *
+ * On the wire: `ftinitupload cid=0 name=/avatar_<md5 hex>` with `overwrite=1`,
+ * the bytes over the file transfer port, then
+ * `clientupdate client_flag_avatar=<md5>`. The server does not keep the file under the MD5
+ * name: it stores it as {@link avatarFileName} of the client's unique id (20
+ * bytes of SHA-1 on TeamSpeak 3, 32 of SHA-256 on TeamSpeak 6). Returns the
+ * MD5, lower-case hex.
+ *
+ * The size limit is the permission `i_client_max_avatar_filesize`, 200000
+ * bytes for a Server Admin; over it, the negotiation fails with a ServerError
+ * 2565 (invalid size) and nothing is sent or changed. A file of exactly the
+ * limit passes.
+ */
+export async function uploadAvatar(client, data, options = {}) {
+    const md5 = createHash("md5").update(data).digest("hex");
+    const info = await initFileUpload(client, CHANNEL_ZERO, `/avatar_${md5}`, BigInt(data.length), {
+        overwrite: true,
+        ...(options.signal ? { signal: options.signal } : {}),
+    });
+    await client.uploadFileData(client.host, info, Readable.from([data]), options);
+    await updateClient(client, { avatar: md5 });
+    return md5;
+}
+/**
+ * The bytes of the avatar of the client with this unique id, or undefined when
+ * the server has no avatar file for it (`ftinitdownload cid=0` with the name
+ * from {@link avatarFileName}; error 2051 on TeamSpeak 6, 2054 on
+ * TeamSpeak 3). Setting the flag empty alone leaves the file in place;
+ * `removeAvatar` deletes it.
+ */
+export function downloadAvatar(client, uid, options = {}) {
+    return download(client, `/${avatarFileName(uid)}`, options);
+}
+/**
+ * Remove this client's own avatar: `ftdeletefile cid=0 name=/avatar_`, which,
+ * as measured on both servers, deletes the caller's stored avatar file and
+ * empties `client_flag_avatar`. Deleting the file by its stored name was
+ * refused with 1540, and TS6's `clientavatardeleted` (given `cluid`) answered
+ * OK without removing it; this is the removal that worked.
+ * Resolves with true when an avatar was removed, false when there was none
+ * (error 2054).
+ */
+export async function removeAvatar(client, options = {}) {
+    try {
+        await deleteFile(client, CHANNEL_ZERO, "/avatar_", options);
+        return true;
+    }
+    catch (error) {
+        if (error instanceof ServerError && error.code === ErrorCode.FileInvalidPath)
+            return false;
+        throw error;
+    }
+}
+/**
+ * Upload `data` as an icon and return its id, the CRC-32 of the bytes
+ * ({@link iconIDOf}).
+ *
+ * On the wire: `ftinitupload cid=0 name=/icon_<id>` with `overwrite=1`, then
+ * the bytes; the server keeps it in channel 0's `icons` directory. The id is
+ * not checked by the server against the bytes, and the file does not
+ * reference anything by itself: pass the id to `setChannelIcon`, `setServerGroupIcon`,
+ * `setChannelGroupIcon`, `setClientIcon` or `setServerIcon`.
+ *
+ * Needs `b_icon_manage` (error 2568 without it). The size limit is
+ * `i_max_icon_filesize`, 8192 bytes for a Server Admin; over it, the
+ * negotiation fails with a ServerError 2565 (invalid size).
+ */
+export async function uploadIcon(client, data, options = {}) {
+    const id = iconIDOf(data);
+    const info = await initFileUpload(client, CHANNEL_ZERO, iconFileName(id), BigInt(data.length), {
+        overwrite: true,
+        ...(options.signal ? { signal: options.signal } : {}),
+    });
+    await client.uploadFileData(client.host, info, Readable.from([data]), options);
+    return id;
+}
+/** The bytes of an icon, or undefined when the server has no file for the id. */
+export function downloadIcon(client, id, options = {}) {
+    return download(client, iconFileName(id), options);
+}
+//# sourceMappingURL=avatars.js.map

package/dist/client/api/avatars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avatars.js","sourceRoot":"","sources":["../../../src/client/api/avatars.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EACL,SAAS,EACT,WAAW,EACX,WAAW,EACX,cAAc,EACd,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,YAAY,GACb,MAAM,qBAAqB,CAAC;AAQ7B,MAAM,YAAY,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;AAErC,KAAK,UAAU,QAAQ,CACrB,MAAc,EACd,IAAY,EACZ,OAA8B;IAE9B,IAAI,IAAI,CAAC;IACT,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,2EAA2E;QAC3E,IACE,KAAK,YAAY,WAAW;YAC5B,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,eAAe,CAAC,EACnF,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IACD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC;QACxB,KAAK,CAAC,KAAa,EAAE,SAAS,EAAE,IAAI;YAClC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,IAAI,EAAE,CAAC;QACT,CAAC;KACF,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAChE,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAc,EACd,IAAgB,EAChB,OAAO,GAA0B,EAAE;IAEnC,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,WAAW,GAAG,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QAC7F,SAAS,EAAE,IAAI;QACf,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtD,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/E,MAAM,YAAY,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IAC5C,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAc,EACd,GAAiB,EACjB,OAAO,GAA0B,EAAE;IAEnC,OAAO,QAAQ,CAAC,MAAM,EAAE,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAc,EACd,OAAO,GAA0B,EAAE;IAEnC,IAAI,CAAC;QACH,MAAM,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,eAAe;YAAE,OAAO,KAAK,CAAC;QAC3F,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAc,EACd,IAAgB,EAChB,OAAO,GAA0B,EAAE;IAEnC,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QAC7F,SAAS,EAAE,IAAI;QACf,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtD,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/E,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,YAAY,CAC1B,MAAc,EACd,EAAU,EACV,OAAO,GAA0B,EAAE;IAEnC,OAAO,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC"}

package/dist/client/api/voice.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Commands only the voice protocol has.
+ *
+ * ServerQuery has no subscriptions — a query client hears every channel's
+ * events once it registers for them — and no `channelgetdescription`, since its
+ * `channelinfo` already carries the description. These run on the voice
+ * client alone, which is why they take one rather than any CommandExecutor.
+ */
+import type { Client } from "../client.js";
+import type { ChannelID, ClientID, CommandOptions } from "@honeybbq/teamspeak";
+/**
+ * The channel's description, which `listChannels` omits for bandwidth. The
+ * server answers with a `notifychanneledited` that the client does not report as
+ * a `channelEdited` event, since it is no edit.
+ */
+export declare function getChannelDescription(client: Client, cid: ChannelID, options?: CommandOptions): Promise<string>;
+/**
+ * Subscribe to a channel: receive its clients' events and voice without
+ * joining it.
+ */
+export declare function subscribeChannel(client: Client, cid: ChannelID, options?: CommandOptions): Promise<void>;
+/** Stop receiving a subscribed channel's events and voice. */
+export declare function unsubscribeChannel(client: Client, cid: ChannelID, options?: CommandOptions): Promise<void>;
+/** Subscribe to every channel on the server. */
+export declare function subscribeAllChannels(client: Client, options?: CommandOptions): Promise<void>;
+/** Unsubscribe from every channel on the server. */
+export declare function unsubscribeAllChannels(client: Client, options?: CommandOptions): Promise<void>;
+/**
+ * Whether `password` is the server's password (`verifyserverpassword`),
+ * without joining. The password is given in cleartext; the client hashes it
+ * on the wire. The server answers a match with plain success and a mismatch
+ * with error 1028 (`ErrorCode.ServerInvalidPassword`), which this turns into
+ * `false`; any other error is thrown. Measured on TeamSpeak 3 and 6.
+ */
+export declare function verifyServerPassword(client: Client, password: string, options?: CommandOptions): Promise<boolean>;
+/**
+ * Whether `password` is channel `cid`'s password (`verifychannelpassword`),
+ * without moving. The password is given in cleartext; the client hashes it
+ * on the wire, as `moveClient` does. A mismatch is error 781
+ * (`ErrorCode.ChannelInvalidPassword`) and answers `false`; a channel without
+ * a password accepts any value and answers `true`; an unknown channel is
+ * error 768, thrown. Measured on TeamSpeak 3 and 6.
+ */
+export declare function verifyChannelPassword(client: Client, cid: ChannelID, password: string, options?: CommandOptions): Promise<boolean>;
+/**
+ * Stop hearing the given clients (`clientmute`): the server no longer forwards
+ * their voice to this client. It is per listener, so everyone else still hears
+ * them, and it sends no notification and changes no client property. Several
+ * clients go in one command. The server accepts this client's own id and ids
+ * of clients that are not connected without an error. Undo it with
+ * `unmuteClients`. Measured on TeamSpeak 3 and 6.
+ */
+export declare function muteClients(client: Client, clientIDs: readonly ClientID[], options?: CommandOptions): Promise<void>;
+/**
+ * Hear the given clients again (`clientunmute`): the server resumes forwarding
+ * their voice to this client after `muteClients`. Measured on TeamSpeak 3 and 6.
+ */
+export declare function unmuteClients(client: Client, clientIDs: readonly ClientID[], options?: CommandOptions): Promise<void>;
+//# sourceMappingURL=voice.d.ts.map

package/dist/client/api/voice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"voice.d.ts","sourceRoot":"","sources":["../../../src/client/api/voice.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE/E;;;;GAIG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,SAAS,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,SAAS,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED,8DAA8D;AAC9D,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,SAAS,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED,gDAAgD;AAChD,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED,oDAAoD;AACpD,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAEf;AAaD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC,CAalB;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,SAAS,EACd,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC,CAgBlB;AAaD;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,QAAQ,EAAE,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,QAAQ,EAAE,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAEf"}

package/dist/client/api/voice.js

@@ -0,0 +1,110 @@
+/**
+ * Commands only the voice protocol has.
+ *
+ * ServerQuery has no subscriptions — a query client hears every channel's
+ * events once it registers for them — and no `channelgetdescription`, since its
+ * `channelinfo` already carries the description. These run on the voice
+ * client alone, which is why they take one rather than any CommandExecutor.
+ */
+import { ErrorCode, ServerError } from "@honeybbq/teamspeak";
+/**
+ * The channel's description, which `listChannels` omits for bandwidth. The
+ * server answers with a `notifychanneledited` that the client does not report as
+ * a `channelEdited` event, since it is no edit.
+ */
+export async function getChannelDescription(client, cid, options) {
+    const rows = await client.send({ command: "channelgetdescription", params: [["cid", cid]] }, options);
+    // The answer is the row that holds the text. Another `notifychanneledited`
+    // can arrive while the command waits, a real edit with other properties,
+    // and the first row is then not the answer.
+    const answer = rows.find((row) => row["cid"] === String(cid) && "channel_description" in row);
+    return answer?.["channel_description"] ?? "";
+}
+/**
+ * Subscribe to a channel: receive its clients' events and voice without
+ * joining it.
+ */
+export async function subscribeChannel(client, cid, options) {
+    await client.send({ command: "channelsubscribe", params: [["cid", cid]] }, options);
+}
+/** Stop receiving a subscribed channel's events and voice. */
+export async function unsubscribeChannel(client, cid, options) {
+    await client.send({ command: "channelunsubscribe", params: [["cid", cid]] }, options);
+}
+/** Subscribe to every channel on the server. */
+export async function subscribeAllChannels(client, options) {
+    await client.send({ command: "channelsubscribeall" }, options);
+}
+/** Unsubscribe from every channel on the server. */
+export async function unsubscribeAllChannels(client, options) {
+    await client.send({ command: "channelunsubscribeall" }, options);
+}
+/** Answers a password check: true for a match, false for the mismatch error, any other error rethrown. */
+async function passwordMatches(run, mismatch) {
+    try {
+        await run();
+        return true;
+    }
+    catch (error) {
+        if (error instanceof ServerError && error.code === mismatch)
+            return false;
+        throw error;
+    }
+}
+/**
+ * Whether `password` is the server's password (`verifyserverpassword`),
+ * without joining. The password is given in cleartext; the client hashes it
+ * on the wire. The server answers a match with plain success and a mismatch
+ * with error 1028 (`ErrorCode.ServerInvalidPassword`), which this turns into
+ * `false`; any other error is thrown. Measured on TeamSpeak 3 and 6.
+ */
+export function verifyServerPassword(client, password, options) {
+    return passwordMatches(() => client.send({
+        command: "verifyserverpassword",
+        params: [["password", password]],
+        passwords: ["password"],
+    }, options), ErrorCode.ServerInvalidPassword);
+}
+/**
+ * Whether `password` is channel `cid`'s password (`verifychannelpassword`),
+ * without moving. The password is given in cleartext; the client hashes it
+ * on the wire, as `moveClient` does. A mismatch is error 781
+ * (`ErrorCode.ChannelInvalidPassword`) and answers `false`; a channel without
+ * a password accepts any value and answers `true`; an unknown channel is
+ * error 768, thrown. Measured on TeamSpeak 3 and 6.
+ */
+export function verifyChannelPassword(client, cid, password, options) {
+    return passwordMatches(() => client.send({
+        command: "verifychannelpassword",
+        params: [
+            ["cid", cid],
+            ["password", password],
+        ],
+        passwords: ["password"],
+    }, options), ErrorCode.ChannelInvalidPassword);
+}
+/** The clients of a mute, one `clid` row each; an empty list sends nothing. */
+async function sendMute(client, command, clientIDs, options) {
+    if (clientIDs.length === 0)
+        return;
+    await client.send({ command, rows: clientIDs.map((clid) => [["clid", clid]]) }, options);
+}
+/**
+ * Stop hearing the given clients (`clientmute`): the server no longer forwards
+ * their voice to this client. It is per listener, so everyone else still hears
+ * them, and it sends no notification and changes no client property. Several
+ * clients go in one command. The server accepts this client's own id and ids
+ * of clients that are not connected without an error. Undo it with
+ * `unmuteClients`. Measured on TeamSpeak 3 and 6.
+ */
+export function muteClients(client, clientIDs, options) {
+    return sendMute(client, "clientmute", clientIDs, options);
+}
+/**
+ * Hear the given clients again (`clientunmute`): the server resumes forwarding
+ * their voice to this client after `muteClients`. Measured on TeamSpeak 3 and 6.
+ */
+export function unmuteClients(client, clientIDs, options) {
+    return sendMute(client, "clientunmute", clientIDs, options);
+}
+//# sourceMappingURL=voice.js.map

package/dist/client/api/voice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"voice.js","sourceRoot":"","sources":["../../../src/client/api/voice.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAG7D;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAAc,EACd,GAAc,EACd,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAC5B,EAAE,OAAO,EAAE,uBAAuB,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE,EAC5D,OAAO,CACR,CAAC;IACF,2EAA2E;IAC3E,yEAAyE;IACzE,4CAA4C;IAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,qBAAqB,IAAI,GAAG,CAAC,CAAC;IAC9F,OAAO,MAAM,EAAE,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAc,EACd,GAAc,EACd,OAAwB;IAExB,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AACtF,CAAC;AAED,8DAA8D;AAC9D,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAc,EACd,GAAc,EACd,OAAwB;IAExB,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AACxF,CAAC;AAED,gDAAgD;AAChD,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAc,EACd,OAAwB;IAExB,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;AACjE,CAAC;AAED,oDAAoD;AACpD,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAc,EACd,OAAwB;IAExB,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,EAAE,OAAO,CAAC,CAAC;AACnE,CAAC;AAED,0GAA0G;AAC1G,KAAK,UAAU,eAAe,CAAC,GAA2B,EAAE,QAAgB;IAC1E,IAAI,CAAC;QACH,MAAM,GAAG,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC1E,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAc,EACd,QAAgB,EAChB,OAAwB;IAExB,OAAO,eAAe,CACpB,GAAG,EAAE,CACH,MAAM,CAAC,IAAI,CACT;QACE,OAAO,EAAE,sBAAsB;QAC/B,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAChC,SAAS,EAAE,CAAC,UAAU,CAAC;KACxB,EACD,OAAO,CACR,EACH,SAAS,CAAC,qBAAqB,CAChC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAc,EACd,GAAc,EACd,QAAgB,EAChB,OAAwB;IAExB,OAAO,eAAe,CACpB,GAAG,EAAE,CACH,MAAM,CAAC,IAAI,CACT;QACE,OAAO,EAAE,uBAAuB;QAChC,MAAM,EAAE;YACN,CAAC,KAAK,EAAE,GAAG,CAAC;YACZ,CAAC,UAAU,EAAE,QAAQ,CAAC;SACvB;QACD,SAAS,EAAE,CAAC,UAAU,CAAC;KACxB,EACD,OAAO,CACR,EACH,SAAS,CAAC,sBAAsB,CACjC,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,KAAK,UAAU,QAAQ,CACrB,MAAc,EACd,OAAsC,EACtC,SAA8B,EAC9B,OAAwB;IAExB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IACnC,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AAC3F,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CACzB,MAAc,EACd,SAA8B,EAC9B,OAAwB;IAExB,OAAO,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAc,EACd,SAA8B,EAC9B,OAAwB;IAExB,OAAO,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAC9D,CAAC"}

package/dist/client/capabilities.d.ts

@@ -0,0 +1,68 @@
+/**
+ * What the connected server is, and what that means for the caller.
+ *
+ * TS3 and TS6 differ in ways that stay invisible until something breaks. The
+ * clearest: the server hashes a client's public key with SHA-1 on TS3 and
+ * SHA-256 on TS6, so a client that assumes either one computes a
+ * `client_unique_identifier` the other server never sends.
+ *
+ * Everything below comes from the handshake — `initserver` carries
+ * `virtualserver_version`, the one place the server names itself, along with
+ * its name, icon, banner and welcome message — so reading it costs no extra
+ * round trip.
+ */
+import { type IconID, type ServerFamily, type ServerID } from "@honeybbq/teamspeak";
+import { type UIDAlgorithm } from "./crypto/identity.js";
+/** What a server said about itself in the handshake. */
+export interface ServerCapabilities {
+    /** The `virtualserver_version` string, exactly as the server sent it. */
+    readonly version: string;
+    /** Major version number, or 0 when it could not be parsed. */
+    readonly major: number;
+    /** Which server generation this is. */
+    readonly family: ServerFamily;
+    /**
+     * The hash the server uses for `client_unique_identifier`.
+     *
+     * Read from the family rather than offered as a setting: the server decides
+     * this, and a client that picks differently never matches.
+     */
+    readonly uidAlgorithm: UIDAlgorithm;
+    /** The virtual server's name (`virtualserver_name`). */
+    readonly name: string;
+    /**
+     * The server's icon (`virtualserver_icon_id`), or `undefined` for none. The
+     * server sends the icon's CRC32, sometimes as a negative 32-bit number; this
+     * is the unsigned value, which names the icon file.
+     */
+    readonly iconID: IconID | undefined;
+    /** The host banner image's URL (`virtualserver_hostbanner_gfx_url`), if one is set. */
+    readonly hostBannerImageURL: string | undefined;
+    /** The welcome message shown on connecting (`virtualserver_welcomemessage`). */
+    readonly welcomeMessage: string;
+    /** The virtual server's ID (`virtualserver_id`); 0 when the server did not send it. */
+    readonly serverID: ServerID;
+    /** The virtual server's unique identifier (`virtualserver_unique_identifier`); empty when not sent. */
+    readonly serverUID: string;
+    /** The host message (`virtualserver_hostmessage`) the server wants shown on connecting. */
+    readonly hostMessage: string;
+    /**
+     * How the host message is to be shown (`virtualserver_hostmessage_mode`).
+     * Compare it with `HostMessageMode`; a server may send a value the table
+     * does not name.
+     */
+    readonly hostMessageMode: number;
+}
+/**
+ * Read what a server says about itself in `initserver`, or a version string
+ * alone, such as "6.0.0-beta13.1 [Build: 1]".
+ */
+export declare function parseServerCapabilities(initserver: string | Readonly<Record<string, string>>): ServerCapabilities;
+/**
+ * Capabilities of a server that has not been connected to yet.
+ *
+ * The family is `unknown` — nothing has said which server this is — and
+ * `uidAlgorithm` is SHA-1, the TS3 hash.
+ */
+export declare function unknownServerCapabilities(): ServerCapabilities;
+//# sourceMappingURL=capabilities.d.ts.map

package/dist/client/capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../src/client/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAc,KAAK,MAAM,EAAE,KAAK,YAAY,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEhG,OAAO,EAA0B,KAAK,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEjF,wDAAwD;AACxD,MAAM,WAAW,kBAAkB;IACjC,yEAAyE;IACzE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,uCAAuC;IACvC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,wDAAwD;IACxD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,uFAAuF;IACvF,QAAQ,CAAC,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAC;IAChD,gFAAgF;IAChF,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,uFAAuF;IACvF,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,uGAAuG;IACvG,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,2FAA2F;IAC3F,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GACpD,kBAAkB,CAyBpB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,kBAAkB,CAE9D"}