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

package/README.md

@@ -4,10 +4,12 @@
 
 **A clean-room TeamSpeak client protocol library written in pure TypeScript.**
 
-Compatible with TeamSpeak 3, 5 & 6. No proprietary SDK. No copy-pasted code.
+Works with TeamSpeak 3 and TeamSpeak 6 servers. No proprietary SDK, no copied code.
 
 [![CI](https://github.com/honeybbq/teamspeak-js/actions/workflows/ci.yml/badge.svg)](https://github.com/honeybbq/teamspeak-js/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/@honeybbq/teamspeak-client)](https://www.npmjs.com/package/@honeybbq/teamspeak-client)
+[![npm beta](https://img.shields.io/npm/v/@honeybbq/teamspeak-client/beta?label=beta)](https://www.npmjs.com/package/@honeybbq/teamspeak-client?activeTab=versions)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/HoneyBBQ/teamspeak-js/badge)](https://scorecard.dev/viewer/?uri=github.com/HoneyBBQ/teamspeak-js)
 [![Node Version](https://img.shields.io/node/v/@honeybbq/teamspeak-client)](package.json)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
@@ -28,20 +30,23 @@ Upgrading from 0.x? See the [migration guide](https://github.com/HoneyBBQ/teamsp
 - **Identity management** — Generate, import/export, and upgrade security level of identities
 - **Full command set** — 111 typed functions covering every command the voice protocol answers
 - **Reconnection** — Opt-in retry with backoff, tuned for TeamSpeak's antiflood ban
-- **Server capabilities** — Reports the server version and the uid hash it uses (SHA-1 on TS3, SHA-256 on TS6)
+- **Server capabilities** — Reports the server version and the uid hash it uses (SHA-1 on TS3, SHA-256 on TS6), and the server's name, icon, banner and welcome message
 - **Custom transports** — Supply your own socket, for proxies, tunnels or tests
 - **ESM with types** — Ships ES modules with full TypeScript declarations
 - **Zero native deps** — Pure TypeScript, no native addons required
 
 ## Installation
 
+1.0 is in beta, published under the `beta` tag. A plain `npm install` still
+gets 0.3, so ask for the beta:
+
 ```bash
-npm install @honeybbq/teamspeak-client
+npm install @honeybbq/teamspeak-client@beta
 # or
-pnpm add @honeybbq/teamspeak-client
+pnpm add @honeybbq/teamspeak-client@beta
 ```
 
-Requires **Node.js 20.19** or later.
+Everything in this README is the 1.0 API. You need Node.js 22.12 or newer.
 
 ## Quick Start
 
@@ -152,7 +157,15 @@ for await (const msg of client.events("textMessage", { signal })) {
 ```
 
 `notification` delivers every notification as it arrived, for the ones the SDK
-does not model.
+does not model. `NotificationName` names them:
+
+```typescript
+import { NotificationName } from "@honeybbq/teamspeak-client";
+
+client.on("notification", (n) => {
+  if (n.name === NotificationName.ChannelEdited) console.log(n.params);
+});
+```
 
 ### Commands
 
@@ -176,6 +189,7 @@ import {
   addServerGroupPermission,
   iterateClientDatabase,
   permissionByName,
+  PermissionName,
   asClientID,
   Codec,
   Reason,
@@ -195,7 +209,7 @@ await sendChannelMessage(client, "hello");
 await kickClient(client, someone, Reason.KickChannel, { reasonMessage: "take a break" });
 
 await addServerGroupPermission(client, sgid, {
-  permission: permissionByName("i_client_talk_power"),
+  permission: permissionByName(PermissionName.ClientTalkPower),
   value: 50,
 });
 
@@ -215,7 +229,8 @@ and only the fields you set are sent: an unset field leaves the setting alone,
 while `""` sends it empty — `editChannel(client, cid, { password: "" })` clears
 a password. A key an options type does not name is never sent. The exceptions
 are `editServer` and `editInstance`, which take the raw `virtualserver_*` and
-`serverinstance_*` properties as `getServerInfo` reports them.
+`serverinstance_*` properties as `getServerInfo` reports them; `PropertyName` names
+the keys.
 
 Results are camelCase too. Timestamps are `Date`s (`undefined` where the server
 sends 0 for "never"), durations are milliseconds with an `Ms` suffix
@@ -397,7 +412,11 @@ const client = new Client(identity, "ts.example.com", "Bot", {
 
 ```typescript
 const caps = client.serverCapabilities;
-// { version: "6.0.0-beta13.1", major: 6, family: "ts6", uidAlgorithm: "sha256" }
+// {
+//   version: "6.0.0-beta13.1 [Build: 1790080330]", major: 6, family: "ts6",
+//   uidAlgorithm: "sha256", name: "TeamSpeak 6 Server", iconID: undefined,
+//   hostBannerImageURL: undefined, welcomeMessage: "…"
+// }
 ```
 
 Read from `initserver` during the handshake, so it costs no extra round trip.

package/dist/client.d.ts

@@ -77,7 +77,7 @@ export declare class Client implements CommandExecutor, AsyncDisposable {
      * Send a raw command line and return the rows that answer it: the escape
      * hatch for a command the typed functions do not cover. The line is sent as
      * given, so its values must already be escaped and any channel password
-     * already hashed.
+     * already hashed. `CommandName` lists the command names.
      *
      * Rejects with a NotConnectedError unless the client is connected: while it
      * is still connecting, the session's keys may not exist yet.
@@ -85,7 +85,8 @@ export declare class Client implements CommandExecutor, AsyncDisposable {
     exec(command: string, options?: CommandOptions): Promise<Record<string, string>[]>;
     /**
      * Send a raw command line without waiting for an answer, for the few
-     * commands the server answers with nothing at all.
+     * commands the server answers with nothing at all. `CommandName` lists
+     * the command names.
      *
      * Commands are paced by a flood throttle; aborting `signal` while this waits
      * for its turn rejects with the signal's reason and sends nothing. Rejects

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,aAAa,EAKlB,KAAK,QAAQ,EAGb,KAAK,WAAW,EAChB,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,KAAK,SAAS,EACd,KAAK,QAAQ,EACb,KAAK,KAAK,EAEV,KAAK,cAAc,EACnB,KAAK,GAAG,EAQT,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,QAAQ,EAAS,MAAM,mBAAmB,CAAC;AAgBpD,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAMhF,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGjF,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEtD,OAAO,EAA6B,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAUvF,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB;;;;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;CAC7C;AAgJD;;;;;;GAMG;AACH,qBAAa,MAAO,YAAW,eAAe,EAAE,eAAe;;IAuE7D,YAAY,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,EA+D1F;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,CAwCxF;IAED;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB3F;IAyBD,gEAAgE;IAChE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAErC;IAID;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAErF;IAED;;;;;;;OAOG;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;IACH,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAE7F;IAsED;;;;;;;;;OASG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,CAmBzE;IAED,uDAAuD;IACvD,IAAI,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,CAM3E;IAED;;;;;;;;;;;;;OAaG;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,CA0DpC;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,8EAA8E;IAC9E,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAGtF;IAED;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAG9C;IAID;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,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;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAC1D,OAAO,CAAC,IAAI,CAAC,CAKf;CA0hBF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,aAAa,EAGlB,KAAK,QAAQ,EAGb,KAAK,WAAW,EAChB,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,KAAK,SAAS,EAEd,KAAK,QAAQ,EACb,KAAK,KAAK,EAGV,KAAK,cAAc,EACnB,KAAK,GAAG,EAQT,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,QAAQ,EAAS,MAAM,mBAAmB,CAAC;AAgBpD,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAMhF,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGjF,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEtD,OAAO,EAA6B,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAUvF,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB;;;;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;CAC7C;AAgJD;;;;;;GAMG;AACH,qBAAa,MAAO,YAAW,eAAe,EAAE,eAAe;;IAuE7D,YAAY,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,EA+D1F;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,CAwCxF;IAED;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB3F;IAyBD,gEAAgE;IAChE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAErC;IAID;;;;;;;;OAQG;IACH,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;IACH,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAE7F;IAsED;;;;;;;;;OASG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,CAmBzE;IAED,uDAAuD;IACvD,IAAI,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,CAM3E;IAED;;;;;;;;;;;;;OAaG;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,CA0DpC;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,8EAA8E;IAC9E,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAGtF;IAED;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAG9C;IAID;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,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;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAO,GAC1D,OAAO,CAAC,IAAI,CAAC,CAKf;CA0hBF"}

package/dist/handshake.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handshake.d.ts","sourceRoot":"","sources":["../src/handshake.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,mEAAmE;AACnE,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC7B,IAAI,CAQN;AAED,sEAAsE;AACtE,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC7B,IAAI,CAYN;AAED,2DAA2D;AAC3D,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CA0B9F;AAwBD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAG5D"}
+{"version":3,"file":"handshake.d.ts","sourceRoot":"","sources":["../src/handshake.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,mEAAmE;AACnE,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC7B,IAAI,CASN;AAED,sEAAsE;AACtE,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC7B,IAAI,CAYN;AAED,2DAA2D;AAC3D,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CA0B9F;AAwBD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAG5D"}

package/dist/index.d.ts

@@ -7,7 +7,7 @@
  */
 export * from "@honeybbq/teamspeak-core";
 export { Client, ClientStatus } from "./client.js";
-export type { TextMessageEvent, ClientMovedEvent, ClientLeaveEvent, KickedEvent, NotificationEvent, ClientEnterEvent, PokeEvent, VoiceDataEvent, EventMap, EventMiddleware, Listener, ServerEvent, ServerEventName, Unsubscribe, AddrResolver, ClientOptions, ResolvedAddr, DatagramSocket, SocketFactory, FileTransferSocketFactory, } from "./types.js";
+export type { EventMap, EventMiddleware, Listener, ServerEvent, ServerEventName, Unsubscribe, AddrResolver, ClientOptions, ResolvedAddr, DatagramSocket, SocketFactory, FileTransferSocketFactory, } from "./types.js";
 export { AlreadyConnectedError, FileTransferError, CryptoInitError, InvalidAddressError, InvalidIdentityError, RemovedError, ConnectionTimeoutError, } from "./errors.js";
 export * from "./api/voice.js";
 export { dialFileTransfer, uploadFileData, downloadFileData } from "./transfer.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,0BAA0B,CAAC;AAGzC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEnD,YAAY,EACV,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,QAAQ,EACR,eAAe,EACf,QAAQ,EACR,WAAW,EACX,eAAe,EACf,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,cAAc,EACd,aAAa,EACb,yBAAyB,GAC1B,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAGrB,cAAc,gBAAgB,CAAC;AAG/B,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACnF,YAAY,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAG1E,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGlE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACxF,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAGtE,OAAO,EACL,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,0BAA0B,CAAC;AAGzC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEnD,YAAY,EACV,QAAQ,EACR,eAAe,EACf,QAAQ,EACR,WAAW,EACX,eAAe,EACf,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,cAAc,EACd,aAAa,EACb,yBAAyB,GAC1B,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAGrB,cAAc,gBAAgB,CAAC;AAG/B,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACnF,YAAY,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAG1E,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGlE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACxF,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAGtE,OAAO,EACL,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -1220,10 +1220,30 @@ var GenerationWindow = class {
 		if (maxOffset < this.#mod) return mappedValue >= this.#mappedBaseOffset && mappedValue < maxOffset;
 		return mappedValue >= this.#mappedBaseOffset || mappedValue < maxOffset - this.#mod;
 	}
+	/**
+	* The offset from the window base: negative means stale, `receiveWindow` or
+	* more too far ahead. An id up to `receiveWindow` behind the base across the
+	* last wrap, which reads as a high number, is stale too.
+	*/
 	mappedToIndex(mappedValue) {
 		if (this.#isNextGen(mappedValue)) return mappedValue + this.#mod - this.#mappedBaseOffset;
-		return mappedValue - this.#mappedBaseOffset;
+		const index = mappedValue - this.#mappedBaseOffset;
+		return this.#isBehindAcrossWrap(index) ? index - this.#mod : index;
+	}
+	/**
+	* Whether an id `index` past the base is really up to `receiveWindow` behind
+	* it, in the generation before: the base has wrapped since, so the id reads as
+	* nearly a whole generation ahead. Before the first wrap no id lies behind the
+	* base across it.
+	*/
+	#isBehindAcrossWrap(index) {
+		return this.#generation > 0 && index >= this.#receiveWindow && index >= this.#mod - this.#receiveWindow;
 	}
+	/**
+	* Whether the id is before the receive window: a packet whose acknowledgement
+	* was lost is sent again after the window has moved past it, also when the
+	* move wrapped the 16-bit id.
+	*/
 	isOldPacket(mappedValue) {
 		return this.mappedToIndex(mappedValue) < 0;
 	}
@@ -1233,8 +1253,14 @@ var GenerationWindow = class {
 	#isNextGen(mappedValue) {
 		return this.#mappedBaseOffset > this.#mod - this.#receiveWindow && mappedValue < this.#mappedBaseOffset + this.#receiveWindow - this.#mod;
 	}
+	/**
+	* The generation the id belongs to: one past the current generation if the id
+	* has already wrapped, one before it if the id is just behind the base across
+	* the last wrap.
+	*/
 	getGeneration(mappedValue) {
 		if (this.#isNextGen(mappedValue)) return this.#generation + 1;
+		if (this.#isBehindAcrossWrap(mappedValue - this.#mappedBaseOffset)) return this.#generation - 1;
 		return this.#generation;
 	}
 	reset() {
@@ -1529,6 +1555,12 @@ var PacketHandler = class {
 	/** The bytes held in both command queues; see MAX_QUEUED_BYTES. */
 	#queuedBytes = 0;
 	#ackManager = /* @__PURE__ */ new Map();
+	/**
+	* The last Init1 packet the client sent, resent until the handshake's final
+	* acknowledgement. Init1 packets are not acknowledged one by one: each step
+	* the client sends replaces it, and only `receivedFinalInitAck` clears it.
+	* Receiving an Init1 does not, as the client may have nothing to answer with.
+	*/
 	#initPacketCheck = null;
 	/**
 	* Command packets sent under the dummy key, before crypto init completed:
@@ -1633,6 +1665,13 @@ var PacketHandler = class {
 		const resendTimer = setInterval(() => this.#checkResends(), RESEND_LOOP_INTERVAL_MS);
 		this.#stopResend = () => clearInterval(resendTimer);
 	}
+	/**
+	* Stop resending the last Init1 packet the client sent. Until this is called,
+	* the latest step stays pending whatever the server sends in between: a step
+	* the client does not answer, an unknown one or a second RSA challenge, must
+	* not stop the resending of its own. The server's `initivexpand2` command
+	* acknowledges the last step, not an Init1 reply.
+	*/
 	receivedFinalInitAck() {
 		this.#initPacketCheck = null;
 	}
@@ -1937,7 +1976,6 @@ var PacketHandler = class {
 		let totalSize = 0;
 		let currID = nextID;
 		let startSeen = false;
-		let complete = false;
 		while (true) {
 			const frag = queue.get(currID);
 			if (!frag) return null;
@@ -1954,17 +1992,10 @@ var PacketHandler = class {
 			const fragmented = (packetFlags(frag) & PacketFlags.Fragmented) !== 0;
 			if (!startSeen) {
 				startSeen = true;
-				if (!fragmented) {
-					complete = true;
-					break;
-				}
-			} else if (fragmented) {
-				complete = true;
-				break;
-			}
+				if (!fragmented) break;
+			} else if (fragmented) break;
 			currID = currID + 1 & 65535;
 		}
-		if (!complete) return null;
 		const combined = new Uint8Array(totalSize);
 		let pos = 0;
 		for (const frag of fragments) {
@@ -1995,10 +2026,6 @@ var PacketHandler = class {
 	}
 	#updatePostReceiveState(p) {
 		const pType = packetType(p);
-		if (pType === PacketType.Init1) {
-			this.#initPacketCheck = null;
-			return;
-		}
 		if ((pType === PacketType.Ack || pType === PacketType.AckLow) && p.data.length >= 2) {
 			const ackID = new DataView(p.data.buffer, p.data.byteOffset).getUint16(0, false);
 			const key = (pType === PacketType.Ack ? PacketType.Command : PacketType.CommandLow) << 16 | ackID;
@@ -2589,6 +2616,7 @@ function handleHandshakeInitIV(client, params) {
 	const alpha = params["alpha"] ?? "";
 	const beta = params["beta"] ?? "";
 	const omega = params["omega"] ?? "";
+	client.handler.receivedFinalInitAck();
 	client.crypt.initCrypto(alpha, beta, omega);
 	client.logger.info("crypto initialized (P-256 path), sending clientinit");
 	sendClientInit(client);
@@ -3265,7 +3293,7 @@ var Client = class {
 	* Send a raw command line and return the rows that answer it: the escape
 	* hatch for a command the typed functions do not cover. The line is sent as
 	* given, so its values must already be escaped and any channel password
-	* already hashed.
+	* already hashed. `CommandName` lists the command names.
 	*
 	* Rejects with a NotConnectedError unless the client is connected: while it
 	* is still connecting, the session's keys may not exist yet.
@@ -3275,7 +3303,8 @@ var Client = class {
 	}
 	/**
 	* Send a raw command line without waiting for an answer, for the few
-	* commands the server answers with nothing at all.
+	* commands the server answers with nothing at all. `CommandName` lists
+	* the command names.
 	*
 	* Commands are paced by a flood throttle; aborting `signal` while this waits
 	* for its turn rejects with the signal's reason and sends nothing. Rejects