@honeybbq/teamspeak 1.0.0-beta.12 → 1.0.0-beta.14

package/README.md

@@ -296,7 +296,25 @@ sends a raw command line and resolves to the rows that answer it.
 
 ### File Transfers
 
-Negotiate with the `files` module, then move the bytes over TCP:
+`uploadFile` and `downloadFile` (from `@honeybbq/teamspeak/client`) negotiate the
+transfer and move the bytes in one call, and `listFilesRecursive` (from the
+package) lists a directory and everything under it, each entry with its full path:
+
+```typescript
+import { downloadFile, uploadFile } from "@honeybbq/teamspeak/client";
+import { listFilesRecursive } from "@honeybbq/teamspeak";
+
+await uploadFile(client, cid, "/docs/notes.txt", data);
+const bytes = await downloadFile(client, cid, "/docs/notes.txt");
+const tree = await listFilesRecursive(client, cid, "/", { maxDepth: 4 });
+```
+
+They work over a voice `Client`, and over a `QueryClient` on raw TCP or SSH when
+passed the file transfer host as `{ host }`; WebQuery refuses every file command.
+`downloadFile` takes `{ dest }` to stream into a `Writable` instead of holding
+the file, and refuses a file over `maxSize` (256 MiB) in memory.
+
+To control the two halves, negotiate with the `files` module, then move the bytes over TCP:
 
 ```typescript
 import { Readable } from "node:stream";
@@ -537,11 +555,11 @@ the way the voice protocol cannot: the same typed commands the core exports,
 plus the ones only an administrator may run, over the three transports a
 ServerQuery speaks.
 
-| Transport | Where        | Server           | Login             | Notifications |
-| --------- | ------------ | ---------------- | ----------------- | ------------- |
-| `tcp`     | 10011        | TeamSpeak 3 only | `transport.login` | yes           |
-| `ssh`     | 10022        | both             | the SSH login     | yes           |
-| `web`     | 10080 (HTTP) | both             | the api key       | **no**        |
+| Transport | Where                       | Server           | Login             | Notifications |
+| --------- | --------------------------- | ---------------- | ----------------- | ------------- |
+| `tcp`     | 10011                       | TeamSpeak 3 only | `transport.login` | yes           |
+| `ssh`     | 10022                       | both             | the SSH login     | yes           |
+| `web`     | 10080 (HTTP), 10443 (HTTPS) | both             | the api key       | **no**        |
 
 TeamSpeak 3 (3.12 and later for WebQuery, 3.3 and later for SSH) serves SSH and
 WebQuery as well as raw TCP, but only the raw port is on until
@@ -550,6 +568,41 @@ WebQuery as well as raw TCP, but only the raw port is on until
 WebQuery also answers a request with no api key as a guest; TeamSpeak 3 refuses
 one.
 
+WebQuery is reached over `http:` or `https:`, by the scheme of `url`. TeamSpeak 3
+serves HTTPS on 10443 once `query_protocols` lists `https` and
+`query_https_certificate_file` and `query_https_private_key_file` are set. The
+built-in `fetch` verifies the certificate against the trust store Node uses and
+never skips that. A certificate from a private CA, or a self-signed one, is
+trusted by starting Node with `NODE_EXTRA_CA_CERTS=ca.pem`, or by a `fetch`
+that trusts the CA:
+
+```typescript
+import { readFileSync } from "node:fs";
+import { Agent, request } from "node:https";
+
+const agent = new Agent({ ca: readFileSync("ca.pem") });
+const trusting = ((url: string, init: RequestInit) =>
+  new Promise<Response>((resolve, reject) => {
+    const req = request(
+      url,
+      { method: init.method, headers: init.headers as never, agent },
+      (res) => {
+        const chunks: Buffer[] = [];
+        res.on("data", (chunk: Buffer) => chunks.push(chunk));
+        res.on("end", () =>
+          resolve(new Response(Buffer.concat(chunks), { status: res.statusCode })),
+        );
+      },
+    );
+    req.on("error", reject);
+    req.end(init.body as string);
+  })) as typeof fetch;
+
+new QueryClient({
+  transport: { kind: "web", url: "https://ts.example.com:10443", apiKey, fetch: trusting },
+});
+```
+
 Only raw TCP and SSH carry notifications: the server pushes them down the same
 connection. WebQuery has no session to push to and refuses to register, so the
 client never tries, and a listener for a server event there throws rather than

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

@@ -0,0 +1,89 @@
+/**
+ * One-call file transfers: negotiate the transfer, move the bytes, and return.
+ *
+ * `initFileUpload` and `uploadFileData` (and the download twins) are the two
+ * halves of a transfer; these run both, over the connection that sends the
+ * commands. That is a voice `Client`, or a `QueryClient` over raw TCP or SSH:
+ * measured on TeamSpeak 3 3.13.8 (raw TCP, SSH, voice) and TeamSpeak 6
+ * beta13.1 (SSH, voice), the key a query connection negotiates opens the same
+ * file transfer port a voice client's does. WebQuery refuses every file command
+ * (error 5120), on both servers.
+ */
+import { Readable, Writable } from "node:stream";
+import type { ChannelID, CommandExecutor, FileDownloadOptions, FileUploadOptions } from "@honeybbq/teamspeak";
+import type { FileTransferOptions } from "../transfer.js";
+/**
+ * How {@link uploadFile} negotiates and moves the file: the options of
+ * `initFileUpload`, without `resume` (the whole file is sent), and those of
+ * `uploadFileData`. `signal` and `timeoutMs` apply to the negotiation, and the
+ * signal to the transfer too.
+ */
+export interface UploadFileOptions extends Omit<FileUploadOptions, "resume">, FileTransferOptions {
+    /**
+     * The host of the file transfer port. A voice client sends to the host it
+     * connected to, so it needs none; any other connection must name it. A host
+     * given here wins over the client's own, and so does `socketFactory`.
+     */
+    readonly host?: string | undefined;
+    /**
+     * The size in bytes of a stream passed as the data, which the server needs
+     * before it takes the file. Required for a `Readable`; for bytes it is their
+     * length, and a different value here is refused.
+     */
+    readonly size?: bigint | number | undefined;
+}
+/** How {@link downloadFile} negotiates and moves the file. */
+export interface DownloadFileOptions extends Omit<FileDownloadOptions, "seekPosition">, FileTransferOptions {
+    /** The host of the file transfer port, as for {@link UploadFileOptions}. */
+    readonly host?: string | undefined;
+    /**
+     * Write the file into this stream instead of returning its bytes. The stream
+     * is not ended, as for `downloadFileData`.
+     */
+    readonly dest?: Writable | undefined;
+    /**
+     * The largest file, in bytes, to hold in memory when no `dest` is given;
+     * 268435456 (256 MiB) by default. A larger file is refused with a
+     * {@link FileTransferError} before any byte is read; the transfer the server
+     * negotiated is left unused.
+     */
+    readonly maxSize?: number | undefined;
+}
+/**
+ * Upload a file into a channel's file area: negotiate the transfer
+ * (`initFileUpload`) and send the bytes (`uploadFileData`), in one call.
+ *
+ * `data` is the bytes, or a `Readable` with `options.size` the number of bytes
+ * it will give. An existing file is not replaced unless `overwrite` is set, and
+ * the directory the file goes in must exist (a missing one is refused with
+ * 2054, invalid file path): make it with `createDirectory` first. A refusal of
+ * the negotiation is thrown as the ServerError it is, before anything is sent;
+ * a failure of the connection to the file transfer port is a
+ * {@link FileTransferError}.
+ *
+ * Over a voice `Client` the bytes go through its own transfer sockets and to the
+ * host it connected to. Over any other connection, such as a `QueryClient`,
+ * name the host of the file transfer port in `options.host`.
+ */
+export declare function uploadFile(client: CommandExecutor, channelID: ChannelID, path: string, data: Uint8Array | Readable, options?: UploadFileOptions): Promise<void>;
+/**
+ * Download a file from a channel's file area into memory: negotiate the
+ * transfer (`initFileDownload`) and read the bytes (`downloadFileData`), in one
+ * call. With `options.dest` the bytes go into that stream instead and nothing
+ * is held, which is the way to fetch a large file.
+ *
+ * A file over `maxSize` (256 MiB unless set) is refused when no `dest` is given.
+ * A file that is not there is the ServerError of the negotiation: 2051 on TS3
+ * 3.13.8 and TS6 beta13.1. A path that names a directory is not refused by the
+ * server: it announces a size and sends nothing, so the call rejects with a
+ * {@link FileTransferError} for the bytes that never came.
+ *
+ * Over a voice `Client` the bytes come through its own transfer sockets from
+ * the host it connected to. Over any other connection, name the host of the
+ * file transfer port in `options.host`.
+ */
+export declare function downloadFile(client: CommandExecutor, channelID: ChannelID, path: string, options: DownloadFileOptions & {
+    readonly dest: Writable;
+}): Promise<void>;
+export declare function downloadFile(client: CommandExecutor, channelID: ChannelID, path: string, options?: DownloadFileOptions): Promise<Uint8Array>;
+//# sourceMappingURL=files.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/client/api/files.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEjD,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EAEf,mBAAmB,EAEnB,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,EAAE,mBAAmB;IAC/F;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CAC7C;AAED,8DAA8D;AAC9D,MAAM,WAAW,mBACf,SAAQ,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,EAAE,mBAAmB;IACtE,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAqFD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,eAAe,EACvB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,UAAU,GAAG,QAAQ,EAC3B,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAWf;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,eAAe,EACvB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,mBAAmB,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,GACzD,OAAO,CAAC,IAAI,CAAC,CAAC;AACjB,wBAAgB,YAAY,CAC1B,MAAM,EAAE,eAAe,EACvB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,UAAU,CAAC,CAAC"}

package/dist/client/api/files.js

@@ -0,0 +1,125 @@
+/**
+ * One-call file transfers: negotiate the transfer, move the bytes, and return.
+ *
+ * `initFileUpload` and `uploadFileData` (and the download twins) are the two
+ * halves of a transfer; these run both, over the connection that sends the
+ * commands. That is a voice `Client`, or a `QueryClient` over raw TCP or SSH:
+ * measured on TeamSpeak 3 3.13.8 (raw TCP, SSH, voice) and TeamSpeak 6
+ * beta13.1 (SSH, voice), the key a query connection negotiates opens the same
+ * file transfer port a voice client's does. WebQuery refuses every file command
+ * (error 5120), on both servers.
+ */
+import { Readable, Writable } from "node:stream";
+import { initFileDownload, initFileUpload } from "@honeybbq/teamspeak";
+import { FileTransferError } from "../errors.js";
+import { downloadFileData, uploadFileData } from "../transfer.js";
+function isTransferCapable(client) {
+    const candidate = client;
+    return (typeof candidate.host === "string" &&
+        typeof candidate.uploadFileData === "function" &&
+        typeof candidate.downloadFileData === "function");
+}
+/**
+ * How to move the bytes over this connection: through the client's own
+ * transfer sockets when it has them and the caller named neither a host nor a
+ * socket factory, else by dialling `options.host`.
+ */
+function routeFor(client, options) {
+    if (isTransferCapable(client) && options.host === undefined && !options.socketFactory) {
+        return {
+            upload: (info, data, o) => client.uploadFileData(client.host, info, data, o),
+            download: (info, dest, o) => client.downloadFileData(client.host, info, dest, o),
+        };
+    }
+    const host = options.host ?? (isTransferCapable(client) ? client.host : undefined);
+    if (host === undefined || host === "") {
+        throw new TypeError("the file transfer port is on a host this connection does not name: pass it as options.host");
+    }
+    return {
+        upload: (info, data, o) => uploadFileData(host, info, data, o),
+        download: (info, dest, o) => downloadFileData(host, info, dest, o),
+    };
+}
+/** The part of the options a transfer's data phase reads. */
+function transferOptions(options) {
+    return {
+        signal: options.signal,
+        socketFactory: options.socketFactory,
+        trace: options.trace,
+        idleTimeoutMs: options.idleTimeoutMs,
+    };
+}
+function sizeOf(data, declared) {
+    const size = declared === undefined ? undefined : BigInt(declared);
+    if (size !== undefined && (size < 0n || !Number.isInteger(Number(declared)))) {
+        throw new RangeError(`size is a non-negative whole number of bytes, not ${String(declared)}`);
+    }
+    if (data instanceof Uint8Array) {
+        if (size !== undefined && size !== BigInt(data.length)) {
+            throw new TypeError(`size says ${size} bytes and the data is ${data.length}`);
+        }
+        return BigInt(data.length);
+    }
+    if (size === undefined) {
+        throw new TypeError("a stream has no known length: pass options.size, in bytes");
+    }
+    return size;
+}
+/**
+ * Upload a file into a channel's file area: negotiate the transfer
+ * (`initFileUpload`) and send the bytes (`uploadFileData`), in one call.
+ *
+ * `data` is the bytes, or a `Readable` with `options.size` the number of bytes
+ * it will give. An existing file is not replaced unless `overwrite` is set, and
+ * the directory the file goes in must exist (a missing one is refused with
+ * 2054, invalid file path): make it with `createDirectory` first. A refusal of
+ * the negotiation is thrown as the ServerError it is, before anything is sent;
+ * a failure of the connection to the file transfer port is a
+ * {@link FileTransferError}.
+ *
+ * Over a voice `Client` the bytes go through its own transfer sockets and to the
+ * host it connected to. Over any other connection, such as a `QueryClient`,
+ * name the host of the file transfer port in `options.host`.
+ */
+export async function uploadFile(client, channelID, path, data, options = {}) {
+    const size = sizeOf(data, options.size);
+    const route = routeFor(client, options);
+    const info = await initFileUpload(client, channelID, path, size, {
+        password: options.password,
+        overwrite: options.overwrite,
+        signal: options.signal,
+        timeoutMs: options.timeoutMs,
+    });
+    const source = data instanceof Uint8Array ? Readable.from([data]) : data;
+    await route.upload(info, source, transferOptions(options));
+}
+export async function downloadFile(client, channelID, path, options = {}) {
+    const maxSize = options.maxSize ?? DEFAULT_MAX_SIZE;
+    if (!Number.isFinite(maxSize) || maxSize < 0) {
+        throw new RangeError(`maxSize is a non-negative number of bytes, not ${String(maxSize)}`);
+    }
+    const route = routeFor(client, options);
+    const info = await initFileDownload(client, channelID, path, {
+        password: options.password,
+        signal: options.signal,
+        timeoutMs: options.timeoutMs,
+    });
+    if (options.dest !== undefined) {
+        await route.download(info, options.dest, transferOptions(options));
+        return;
+    }
+    if (info.size > BigInt(maxSize)) {
+        throw new FileTransferError(`the file is ${info.size} bytes, over the ${maxSize} bytes maxSize allows in memory`);
+    }
+    const chunks = [];
+    const sink = new Writable({
+        write(chunk, _encoding, done) {
+            chunks.push(chunk);
+            done();
+        },
+    });
+    await route.download(info, sink, transferOptions(options));
+    return Buffer.concat(chunks);
+}
+const DEFAULT_MAX_SIZE = 256 * 1024 * 1024;
+//# sourceMappingURL=files.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/client/api/files.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AASvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AA4DlE,SAAS,iBAAiB,CAAC,MAAuB;IAChD,MAAM,SAAS,GAAG,MAAkC,CAAC;IACrD,OAAO,CACL,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ;QAClC,OAAO,SAAS,CAAC,cAAc,KAAK,UAAU;QAC9C,OAAO,SAAS,CAAC,gBAAgB,KAAK,UAAU,CACjD,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CACf,MAAuB,EACvB,OAA4F;IAK5F,IAAI,iBAAiB,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QACtF,OAAO;YACL,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5E,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;SACjF,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACnF,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,SAAS,CACjB,4FAA4F,CAC7F,CAAC;IACJ,CAAC;IACD,OAAO;QACL,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;KACnE,CAAC;AACJ,CAAC;AAED,6DAA6D;AAC7D,SAAS,eAAe,CAAC,OAA4B;IACnD,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,aAAa,EAAE,OAAO,CAAC,aAAa;KACrC,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,IAA2B,EAAE,QAAqC;IAChF,MAAM,IAAI,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnE,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7E,MAAM,IAAI,UAAU,CAAC,qDAAqD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAChG,CAAC;IACD,IAAI,IAAI,YAAY,UAAU,EAAE,CAAC;QAC/B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,SAAS,CAAC,aAAa,IAAI,0BAA0B,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuB,EACvB,SAAoB,EACpB,IAAY,EACZ,IAA2B,EAC3B,OAAO,GAAsB,EAAE;IAE/B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;QAC/D,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7D,CAAC;AA8BD,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuB,EACvB,SAAoB,EACpB,IAAY,EACZ,OAAO,GAAwB,EAAE;IAEjC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,gBAAgB,CAAC;IACpD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,UAAU,CAAC,kDAAkD,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE;QAC3D,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC,CAAC;IACH,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QACnE,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,iBAAiB,CACzB,eAAe,IAAI,CAAC,IAAI,oBAAoB,OAAO,iCAAiC,CACrF,CAAC;IACJ,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,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3D,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,gBAAgB,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC"}

package/dist/client/capabilities.d.ts

@@ -11,7 +11,7 @@
  * 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 { HostMessageMode, 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 {
@@ -48,10 +48,10 @@ export interface ServerCapabilities {
     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.
+     * A value the `HostMessageMode` table does not name is passed through as the
+     * server sent it.
      */
-    readonly hostMessageMode: number;
+    readonly hostMessageMode: HostMessageMode;
 }
 /**
  * Read what a server says about itself in `initserver`, or a version string

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

@@ -1 +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"}
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../src/client/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAEL,eAAe,EAEf,KAAK,MAAM,EACX,KAAK,YAAY,EACjB,KAAK,QAAQ,EACd,MAAM,qBAAqB,CAAC;AAE7B,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,eAAe,CAAC;CAC3C;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GACpD,kBAAkB,CAqBpB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,kBAAkB,CAE9D"}

package/dist/client/capabilities.js

@@ -11,7 +11,7 @@
  * its name, icon, banner and welcome message — so reading it costs no extra
  * round trip.
  */
-import { asServerID } from "@honeybbq/teamspeak";
+import { asServerID, HostMessageMode, serverFamilyForVersion, } from "@honeybbq/teamspeak";
 import { parseIconID, parseUint64 } from "../core/internal.js";
 import { uidAlgorithmForVersion } from "./crypto/identity.js";
 /**
@@ -23,15 +23,10 @@ export function parseServerCapabilities(initserver) {
     const version = params["virtualserver_version"] ?? "";
     const parsed = Number.parseInt(version, 10);
     const major = Number.isNaN(parsed) ? 0 : parsed;
-    let family = "unknown";
-    if (major === 3)
-        family = "ts3";
-    else if (major >= 6)
-        family = "ts6";
     return {
         version,
         major,
-        family,
+        family: serverFamilyForVersion(version),
         uidAlgorithm: uidAlgorithmForVersion(version),
         name: params["virtualserver_name"] ?? "",
         iconID: parseIconID(params["virtualserver_icon_id"]),
@@ -54,6 +49,6 @@ export function unknownServerCapabilities() {
 }
 function hostMessageMode(value) {
     const parsed = Number.parseInt(value ?? "", 10);
-    return Number.isNaN(parsed) ? 0 : parsed;
+    return (Number.isNaN(parsed) ? HostMessageMode.None : parsed);
 }
 //# sourceMappingURL=capabilities.js.map

package/dist/client/capabilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"capabilities.js","sourceRoot":"","sources":["../../src/client/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,UAAU,EAAiD,MAAM,qBAAqB,CAAC;AAChG,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,sBAAsB,EAAqB,MAAM,sBAAsB,CAAC;AA2CjF;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAqD;IAErD,MAAM,MAAM,GACV,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IACtF,MAAM,OAAO,GAAG,MAAM,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAEhD,IAAI,MAAM,GAAiB,SAAS,CAAC;IACrC,IAAI,KAAK,KAAK,CAAC;QAAE,MAAM,GAAG,KAAK,CAAC;SAC3B,IAAI,KAAK,IAAI,CAAC;QAAE,MAAM,GAAG,KAAK,CAAC;IAEpC,OAAO;QACL,OAAO;QACP,KAAK;QACL,MAAM;QACN,YAAY,EAAE,sBAAsB,CAAC,OAAO,CAAC;QAC7C,IAAI,EAAE,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE;QACxC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;QACpD,kBAAkB,EAAE,MAAM,CAAC,kCAAkC,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS;QACnF,cAAc,EAAE,MAAM,CAAC,8BAA8B,CAAC,IAAI,EAAE;QAC5D,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,SAAS,EAAE,MAAM,CAAC,iCAAiC,CAAC,IAAI,EAAE;QAC1D,WAAW,EAAE,MAAM,CAAC,2BAA2B,CAAC,IAAI,EAAE;QACtD,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC,gCAAgC,CAAC,CAAC;KAC3E,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB;IACvC,OAAO,uBAAuB,CAAC,EAAE,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,eAAe,CAAC,KAAyB;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAChD,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"capabilities.js","sourceRoot":"","sources":["../../src/client/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,UAAU,EACV,eAAe,EACf,sBAAsB,GAIvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,sBAAsB,EAAqB,MAAM,sBAAsB,CAAC;AA2CjF;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAqD;IAErD,MAAM,MAAM,GACV,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IACtF,MAAM,OAAO,GAAG,MAAM,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAEhD,OAAO;QACL,OAAO;QACP,KAAK;QACL,MAAM,EAAE,sBAAsB,CAAC,OAAO,CAAC;QACvC,YAAY,EAAE,sBAAsB,CAAC,OAAO,CAAC;QAC7C,IAAI,EAAE,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE;QACxC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;QACpD,kBAAkB,EAAE,MAAM,CAAC,kCAAkC,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS;QACnF,cAAc,EAAE,MAAM,CAAC,8BAA8B,CAAC,IAAI,EAAE;QAC5D,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,SAAS,EAAE,MAAM,CAAC,iCAAiC,CAAC,IAAI,EAAE;QAC1D,WAAW,EAAE,MAAM,CAAC,2BAA2B,CAAC,IAAI,EAAE;QACtD,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC,gCAAgC,CAAC,CAAC;KAC3E,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB;IACvC,OAAO,uBAAuB,CAAC,EAAE,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,eAAe,CAAC,KAAyB;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAoB,CAAC;AACnF,CAAC"}

package/dist/client/client.d.ts

@@ -225,11 +225,11 @@ export declare class Client implements CommandExecutor, AsyncDisposable {
      * Upload `data` over a negotiated transfer, through the client's
      * `fileTransferSocketFactory` if it has one.
      */
-    uploadFileData(host: string, info: FileUploadInfo, data: Readable, options?: Pick<FileTransferOptions, "signal" | "trace">): Promise<void>;
+    uploadFileData(host: string, info: FileUploadInfo, data: Readable, options?: Pick<FileTransferOptions, "signal" | "trace" | "idleTimeoutMs">): Promise<void>;
     /**
      * Download a negotiated transfer into `dest`, through the client's
      * `fileTransferSocketFactory` if it has one.
      */
-    downloadFileData(host: string, info: FileDownloadInfo, dest: Writable, options?: Pick<FileTransferOptions, "signal" | "trace">): Promise<void>;
+    downloadFileData(host: string, info: FileDownloadInfo, dest: Writable, options?: Pick<FileTransferOptions, "signal" | "trace" | "idleTimeoutMs">): Promise<void>;
 }
 //# sourceMappingURL=client.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAOnB,MAAM,YAAY,CAAC;AAIpB,OAAO,EACL,KAAK,SAAS,EAEd,KAAK,QAAQ,EACb,KAAK,KAAK,EAGV,KAAK,cAAc,EACnB,KAAK,GAAG,EAGR,KAAK,QAAQ,EAGb,KAAK,WAAW,EAGhB,YAAY,EAKb,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAclD,OAAO,EAAoC,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAW3F,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAa1F,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAG5E,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEtD,OAAO,EAA6B,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAIvF,OAAO,EAAa,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,0BAA0B,EAAE,MAAM,CAAC;IAC5C,+FAA+F;IAC/F,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,iGAAiG;IACjG,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;CACjC;AA8ND;;;;;;GAMG;AACH,qBAAa,MAAO,YAAW,eAAe,EAAE,eAAe;;IA2F7D,YAAY,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,EAyE1F;IAED;;;;;;OAMG;IACH,IAAI,IAAI,IAAI,UAAU,CAErB;IAED,oDAAoD;IACpD,IAAI,MAAM,IAAI,YAAY,CAEzB;IAID;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,OAAO,CAAC,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAExF;IAoGD;;;;;;;;;;;;;;;;;;OAkBG;IACG,UAAU,CACd,OAAO,GAAE;QACP,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;QAC1C,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KACxC,GACL,OAAO,CAAC,IAAI,CAAC,CA4Bf;IA+CD,gEAAgE;IAChE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAErC;IAID;;;;;;;;OAQG;IAEH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAErF;IAED;;;;;;;;OAQG;IACH,UAAU,CACR,OAAO,EAAE,MAAM,EACf,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAC1D,OAAO,CAAC,IAAI,CAAC,CAEf;IAwBD;;;;;;;OAOG;IAEH,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAE7F;IAuED;;;;;;;;;;;;;;;;OAgBG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,WAAW,CAmBnF;IAED,uDAAuD;IACvD,IAAI,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,WAAW,CAMrF;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,QAAQ,EAC7B,KAAK,EAAE,CAAC,EACR,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAC1D,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CA2EpC;IAID,8EAA8E;IAC9E,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED;;;;OAIG;IACH,IAAI,kBAAkB,IAAI,kBAAkB,CAE3C;IAED;;;;;;;OAOG;IACH,IAAI,GAAG,IAAI,GAAG,CAEb;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,8EAA8E;IAC9E,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAKzE;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,kBAAkB,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAIjF;IAED;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAKtE;IAID;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,CAAM,GAC1D,OAAO,CAAC,IAAI,CAAC,CAKf;IAED;;;OAGG;IACH,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,gBAAgB,EACtB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,CAAM,GAC1D,OAAO,CAAC,IAAI,CAAC,CAKf;CAm3BF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAOnB,MAAM,YAAY,CAAC;AAIpB,OAAO,EACL,KAAK,SAAS,EAEd,KAAK,QAAQ,EACb,KAAK,KAAK,EAGV,KAAK,cAAc,EACnB,KAAK,GAAG,EAGR,KAAK,QAAQ,EAGb,KAAK,WAAW,EAGhB,YAAY,EAKb,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAclD,OAAO,EAAoC,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAW3F,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAa1F,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAG5E,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEtD,OAAO,EAA6B,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAIvF,OAAO,EAAa,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,0BAA0B,EAAE,MAAM,CAAC;IAC5C,+FAA+F;IAC/F,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,iGAAiG;IACjG,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;CACjC;AAmPD;;;;;;GAMG;AACH,qBAAa,MAAO,YAAW,eAAe,EAAE,eAAe;;IA2F7D,YAAY,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,EAyE1F;IAED;;;;;;OAMG;IACH,IAAI,IAAI,IAAI,UAAU,CAErB;IAED,oDAAoD;IACpD,IAAI,MAAM,IAAI,YAAY,CAEzB;IAID;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,OAAO,CAAC,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAExF;IA8GD;;;;;;;;;;;;;;;;;;OAkBG;IACG,UAAU,CACd,OAAO,GAAE;QACP,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;QAC1C,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KACxC,GACL,OAAO,CAAC,IAAI,CAAC,CA4Bf;IA+CD,gEAAgE;IAChE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAErC;IAID;;;;;;;;OAQG;IAEH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAErF;IAED;;;;;;;;OAQG;IACH,UAAU,CACR,OAAO,EAAE,MAAM,EACf,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAC1D,OAAO,CAAC,IAAI,CAAC,CAEf;IAwBD;;;;;;;OAOG;IAEH,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAE7F;IAuED;;;;;;;;;;;;;;;;OAgBG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,WAAW,CAmBnF;IAED,uDAAuD;IACvD,IAAI,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,WAAW,CAMrF;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,QAAQ,EAC7B,KAAK,EAAE,CAAC,EACR,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAC1D,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CA2EpC;IAID,8EAA8E;IAC9E,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED;;;;OAIG;IACH,IAAI,kBAAkB,IAAI,kBAAkB,CAE3C;IAED;;;;;;;OAOG;IACH,IAAI,GAAG,IAAI,GAAG,CAEb;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,8EAA8E;IAC9E,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAKzE;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,kBAAkB,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAIjF;IAED;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAKtE;IAID;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,GAAG,eAAe,CAAM,GAC5E,OAAO,CAAC,IAAI,CAAC,CAKf;IAED;;;OAGG;IACH,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,gBAAgB,EACtB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,GAAG,eAAe,CAAM,GAC5E,OAAO,CAAC,IAAI,CAAC,CAKf;CA63BF"}

package/dist/client/client.js

@@ -83,6 +83,24 @@ const DEFAULT_COMMAND_TIMEOUT_MS = 10_000;
 const DISCONNECT_TIMEOUT_MS = 1_000;
 /** How long each reconnection attempt may take. */
 const RECONNECT_ATTEMPT_TIMEOUT_MS = 30_000;
+/** What an attempt is waiting for now, for the report of an attempt that ended. */
+function describeWaiting(trace, clientEkPending) {
+    if (trace.phase === ConnectPhase.Open) {
+        return trace.target === "" ? "the server address to resolve" : "the connection to open";
+    }
+    if (trace.phase === ConnectPhase.Join) {
+        return clientEkPending
+            ? "the server's answer to clientek"
+            : "the server's answer to clientinit";
+    }
+    if (trace.stage === "puzzleSolving")
+        return "the RSA puzzle to be solved";
+    if (trace.stage === "puzzleAnswered")
+        return "the server's answer to the RSA puzzle";
+    return trace.init1Step < 0
+        ? "the server's first answer to init1"
+        : `the server's init1 step after step ${trace.init1Step}`;
+}
 /** The `initserver` parameters a trace never sees, because they could carry a secret. */
 const SECRET_INITSERVER_PARAMS = new Set([
     "client_server_password",
@@ -364,16 +382,27 @@ export class Client {
             sessionStarted: false,
             welcomeDone: false,
             channels: 0,
+            stage: "init1",
+            init1Step: -1,
         };
         attempt.trace = trace;
-        attempt.onFail = (error) => this.#callHook(this.#trace?.attemptFailed, () => ({
-            attempt: trace.attempt,
-            reconnect: trace.reconnect,
-            phase: trace.phase,
-            error,
-            target: trace.target,
-            durationMs: performance.now() - trace.startedAt,
-        }));
+        attempt.onFail = (error) => {
+            const waitingFor = describeWaiting(trace, this.#handler.clientEkPending);
+            this.#logger.info("connection attempt ended", {
+                phase: trace.phase,
+                waitingFor,
+                error: String(error),
+            });
+            this.#callHook(this.#trace?.attemptFailed, () => ({
+                attempt: trace.attempt,
+                reconnect: trace.reconnect,
+                phase: trace.phase,
+                error,
+                target: trace.target,
+                waitingFor,
+                durationMs: performance.now() - trace.startedAt,
+            }));
+        };
         // The handshake may complete just as the signal fires, in which case
         // #failConnection leaves the session alone and the caller gets the
         // connection it made rather than one it would believe had failed.
@@ -1080,12 +1109,19 @@ export class Client {
                 return;
             const signal = this.#attempt.signal;
             const handler = this.#handler;
+            const trace = this.#attempt.trace;
+            const step = p.data[0] ?? 0x7f;
             const response = processInit1(this.#crypt, p.data, signal);
             if (response instanceof Promise) {
                 // The puzzle: solved in slices, so the loop keeps running meanwhile.
+                if (trace !== undefined)
+                    trace.stage = "puzzleSolving";
                 response.then((answer) => {
-                    if (answer && !signal.aborted)
+                    if (answer && !signal.aborted) {
                         handler.sendPacket(PacketType.Init1, answer, 0);
+                        if (trace !== undefined)
+                            trace.stage = "puzzleAnswered";
+                    }
                 }, (error) => {
                     // An attempt that ended did so for its own reason; the abandoned
                     // solve has nothing more to report.
@@ -1095,6 +1131,8 @@ export class Client {
             }
             else if (response) {
                 handler.sendPacket(PacketType.Init1, response, 0);
+                if (trace !== undefined)
+                    trace.init1Step = step === 0x7f ? -1 : step;
             }
             return;
         }
@@ -1433,6 +1471,9 @@ export class Client {
             case "clientChatComposing":
                 this.#emitServerEvent({ name: "clientChatComposing", payload: result.event });
                 break;
+            case "clientChatClosed":
+                this.#emitServerEvent({ name: "clientChatClosed", payload: result.event });
+                break;
             case "poked":
                 this.#emitServerEvent({ name: "poked", payload: result.event });
                 break;