@honeybbq/teamspeak 0.0.1 → 1.0.0-beta.8

package/dist/core/command/ids.js

@@ -0,0 +1,85 @@
+/**
+ * Branded identifiers.
+ *
+ * TeamSpeak uses one 64-bit integer space for several unrelated kinds of id, so
+ * a `bigint` alone cannot tell a channel from a client. Branding makes the
+ * mistake a compile error instead of a silent move-to-the-wrong-place, and the
+ * brands cost nothing at runtime.
+ *
+ * The ids the protocol defines as 32 bits or narrower — a clid, a permission,
+ * an icon — are `number` brands; the 64-bit ones are `bigint` brands.
+ */
+const MAX_UINT16 = 0xffff;
+const MAX_UINT32 = 0xffff_ffff;
+const MAX_UINT64 = (1n << 64n) - 1n;
+/** `v` if it is an integer from 0 to `max`; a RangeError otherwise. */
+function uintInRange(v, max, what) {
+    if (typeof v !== "number" || !Number.isInteger(v) || v < 0 || v > max) {
+        throw new RangeError(`${what} is an integer from 0 to ${max}, not ${String(v)}`);
+    }
+    return v;
+}
+/** `v` as a bigint if it is an integer from 0 to 2^64-1; a RangeError otherwise. */
+function uint64(v, what) {
+    const integer = typeof v === "bigint" || (typeof v === "number" && Number.isInteger(v));
+    const value = integer ? BigInt(v) : -1n;
+    if (value < 0n || value > MAX_UINT64) {
+        throw new RangeError(`${what} is an integer from 0 to 2^64-1, not ${String(v)}`);
+    }
+    return value;
+}
+// Every constructor checks its value against the id's wire width and throws a
+// RangeError for anything else — a fraction, a negative, a value too wide —
+// rather than brand a value no server could mean.
+/** Brand a ban id, an integer from 0 to 2^64-1, from a number or a bigint. */
+export const asBanID = (v) => uint64(v, "a ban id");
+/** Brand an offline message id, an integer from 0 to 2^64-1. */
+export const asMessageID = (v) => uint64(v, "a message id");
+/** Brand a virtual server id, an integer from 0 to 2^64-1. */
+export const asServerID = (v) => uint64(v, "a server id");
+/** Brand the client's id for a file transfer, an integer from 0 to 65535. */
+export const asClientFileTransferID = (v) => uintInRange(v, MAX_UINT16, "a client file transfer id");
+/** Brand the server's id for a file transfer, an integer from 0 to 65535. */
+export const asServerFileTransferID = (v) => uintInRange(v, MAX_UINT16, "a server file transfer id");
+/** Brand a channel id, an integer from 0 to 2^64-1, from a number or a bigint. */
+export const asChannelID = (v) => uint64(v, "a channel id");
+/** Brand a client id, an integer from 0 to 65535: the voice protocol's width. */
+export const asClientID = (v) => uintInRange(v, MAX_UINT16, "a client id");
+/** Brand a client database id, an integer from 0 to 2^64-1. */
+export const asClientDBID = (v) => uint64(v, "a client database id");
+/** Brand a server group id, an integer from 0 to 2^64-1. */
+export const asServerGroupID = (v) => uint64(v, "a server group id");
+/** Brand a channel group id, an integer from 0 to 2^64-1. */
+export const asChannelGroupID = (v) => uint64(v, "a channel group id");
+/** Brand a permission id, an integer from 0 to 2^32-1. */
+export const asPermissionID = (v) => uintInRange(v, MAX_UINT32, "a permission id");
+/**
+ * Brand an icon id, an integer from -2^31 to 2^32-1. A negative value is taken
+ * as the signed form of the same CRC32, which is how the server sometimes
+ * sends one, and stored unsigned.
+ */
+export const asIconID = (v) => {
+    if (typeof v !== "number" || !Number.isInteger(v) || v < -(2 ** 31) || v > MAX_UINT32) {
+        throw new RangeError(`an icon id is an integer from -2^31 to 2^32-1, not ${String(v)}`);
+    }
+    return (v >>> 0);
+};
+/**
+ * Read an icon id as the server sends it: the CRC32, sometimes as a negative
+ * 32-bit number, sometimes unsigned. Both name the same icon, so both come back
+ * as the unsigned value; 0, garbage and out-of-range values mean no icon.
+ */
+export function parseIconID(raw) {
+    const text = raw?.trim() ?? "";
+    if (!/^-?\d{1,10}$/.test(text))
+        return undefined;
+    const value = Number(text);
+    if (value < -(2 ** 31) || value >= 2 ** 32 || value === 0)
+        return undefined;
+    return asIconID(value);
+}
+/** Brand a unique identifier. */
+export const asUID = (v) => v;
+/** Brand a channel's unique identifier. */
+export const asChannelUID = (v) => v;
+//# sourceMappingURL=ids.js.map

package/dist/core/command/ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.js","sourceRoot":"","sources":["../../../src/core/command/ids.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAqCH,MAAM,UAAU,GAAG,MAAM,CAAC;AAC1B,MAAM,UAAU,GAAG,WAAW,CAAC;AAC/B,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;AAEpC,uEAAuE;AACvE,SAAS,WAAW,CAAC,CAAS,EAAE,GAAW,EAAE,IAAY;IACvD,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACtE,MAAM,IAAI,UAAU,CAAC,GAAG,IAAI,4BAA4B,GAAG,SAAS,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,oFAAoF;AACpF,SAAS,MAAM,CAAC,CAAkB,EAAE,IAAY;IAC9C,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IACxF,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxC,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,UAAU,EAAE,CAAC;QACrC,MAAM,IAAI,UAAU,CAAC,GAAG,IAAI,wCAAwC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,8EAA8E;AAC9E,4EAA4E;AAC5E,kDAAkD;AAElD,8EAA8E;AAC9E,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAkB,EAAS,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAU,CAAC;AACrF,gEAAgE;AAChE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAkB,EAAa,EAAE,CAC3D,MAAM,CAAC,CAAC,EAAE,cAAc,CAAc,CAAC;AACzC,8DAA8D;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAkB,EAAY,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,aAAa,CAAa,CAAC;AACjG,6EAA6E;AAC7E,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAS,EAAwB,EAAE,CACxE,WAAW,CAAC,CAAC,EAAE,UAAU,EAAE,2BAA2B,CAAyB,CAAC;AAClF,6EAA6E;AAC7E,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAS,EAAwB,EAAE,CACxE,WAAW,CAAC,CAAC,EAAE,UAAU,EAAE,2BAA2B,CAAyB,CAAC;AAElF,kFAAkF;AAClF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAkB,EAAa,EAAE,CAC3D,MAAM,CAAC,CAAC,EAAE,cAAc,CAAc,CAAC;AACzC,iFAAiF;AACjF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAS,EAAY,EAAE,CAChD,WAAW,CAAC,CAAC,EAAE,UAAU,EAAE,aAAa,CAAa,CAAC;AACxD,+DAA+D;AAC/D,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAkB,EAAc,EAAE,CAC7D,MAAM,CAAC,CAAC,EAAE,sBAAsB,CAAe,CAAC;AAClD,4DAA4D;AAC5D,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAkB,EAAiB,EAAE,CACnE,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAkB,CAAC;AAClD,6DAA6D;AAC7D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAkB,EAAkB,EAAE,CACrE,MAAM,CAAC,CAAC,EAAE,oBAAoB,CAAmB,CAAC;AACpD,0DAA0D;AAC1D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAS,EAAgB,EAAE,CACxD,WAAW,CAAC,CAAC,EAAE,UAAU,EAAE,iBAAiB,CAAiB,CAAC;AAChE;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAU,EAAE;IAC5C,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,UAAU,EAAE,CAAC;QACtF,MAAM,IAAI,UAAU,CAAC,sDAAsD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,CAAC,CAAC,KAAK,CAAC,CAAW,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,GAAuB;IACjD,MAAM,IAAI,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC/B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC5E,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;AACzB,CAAC;AAUD,iCAAiC;AACjC,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAS,EAAO,EAAE,CAAC,CAAQ,CAAC;AAQlD,2CAA2C;AAC3C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAc,EAAE,CAAC,CAAe,CAAC"}

package/dist/core/command/parser.d.ts

@@ -0,0 +1,17 @@
+import type { Command } from "./command.js";
+/**
+ * Whether a token is a command name.
+ *
+ * A command name is a run of ASCII alphanumerics — the rule tsproto-packets
+ * uses (CommandParser::new). Everything that splits or parses a line asks this
+ * one function, so the parser and the row splitter cannot disagree about where
+ * a command's data begins.
+ */
+export declare function isCommandName(token: string): boolean;
+/**
+ * Parse one command line, or one row of it. Returns null for an empty line.
+ * A line whose first token is not a command name is a data row, with `name`
+ * `""`.
+ */
+export declare function parseCommand(s: string): Command | null;
+//# sourceMappingURL=parser.d.ts.map

package/dist/core/command/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../../src/core/command/parser.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CA+CtD"}

package/dist/core/command/parser.js

@@ -0,0 +1,65 @@
+import { unescape } from "./command.js";
+/**
+ * Whether a token is a command name.
+ *
+ * A command name is a run of ASCII alphanumerics — the rule tsproto-packets
+ * uses (CommandParser::new). Everything that splits or parses a line asks this
+ * one function, so the parser and the row splitter cannot disagree about where
+ * a command's data begins.
+ */
+export function isCommandName(token) {
+    return /^[A-Za-z0-9]+$/.test(token);
+}
+/**
+ * Parse one command line, or one row of it. Returns null for an empty line.
+ * A line whose first token is not a command name is a data row, with `name`
+ * `""`.
+ */
+export function parseCommand(s) {
+    if (s === "")
+        return null;
+    // Skip leading non-printable bytes (< 0x20 or > 0x7E)
+    let startIndex = 0;
+    for (let i = 0; i < s.length; i++) {
+        const code = s.charCodeAt(i);
+        if (code >= 32 && code <= 126) {
+            startIndex = i;
+            break;
+        }
+    }
+    if (startIndex > 0) {
+        s = s.slice(startIndex);
+    }
+    const parts = s.split(" ");
+    if (parts.length === 0)
+        return null;
+    // A command name is a run of alphanumerics followed by a space — the rule
+    // tsproto-packets uses (CommandParser::new). Anything else means the line is
+    // not a command at all: response rows carry no name ("clid=6 cid=2 ..."),
+    // and negative feedback is "-1 id=2 ...", naming the *rejected* command id
+    // rather than a command of its own. Returning those as a nameless row keeps
+    // the data intact instead of folding the first field into a name, which is
+    // how a clientlist row used to arrive as name="clid=6" and lose its clid.
+    const first = parts[0] ?? "";
+    if (first === "")
+        return null;
+    // No prototype: a key is whatever the line says, and one named __proto__
+    // must be stored, not swallowed by Object.prototype's setter.
+    const params = Object.create(null);
+    const name = isCommandName(first) ? first : "";
+    const start = name === "" ? 0 : 1;
+    for (let i = start; i < parts.length; i++) {
+        const p = parts[i];
+        if (p === undefined || p === "")
+            continue;
+        const eqIdx = p.indexOf("=");
+        if (eqIdx >= 0) {
+            params[unescape(p.slice(0, eqIdx))] = unescape(p.slice(eqIdx + 1));
+        }
+        else {
+            params[unescape(p)] = "";
+        }
+    }
+    return { name, params };
+}
+//# sourceMappingURL=parser.js.map

package/dist/core/command/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../src/core/command/parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAGxC;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,CAAS;IACpC,IAAI,CAAC,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAE1B,sDAAsD;IACtD,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,IAAI,EAAE,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;YAC9B,UAAU,GAAG,CAAC,CAAC;YACf,MAAM;QACR,CAAC;IACH,CAAC;IACD,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnB,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC3B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEpC,0EAA0E;IAC1E,6EAA6E;IAC7E,0EAA0E;IAC1E,2EAA2E;IAC3E,4EAA4E;IAC5E,2EAA2E;IAC3E,0EAA0E;IAC1E,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAE9B,yEAAyE;IACzE,8DAA8D;IAC9D,MAAM,MAAM,GAA2B,MAAM,CAAC,MAAM,CAAC,IAAI,CAA2B,CAAC;IACrF,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/C,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,EAAE;YAAE,SAAS;QAC1C,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACf,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QACrE,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC1B,CAAC"}

package/dist/core/command/request.d.ts

@@ -0,0 +1,61 @@
+/**
+ * A command as the typed layer describes it, before a transport encodes it.
+ *
+ * The typed commands run on any connection that can execute a command — the
+ * voice client today, ServerQuery later — and the two disagree about how some
+ * values go on the wire. A channel password is the case that matters: the
+ * voice protocol expects `base64(sha1(password))`, while ServerQuery takes the
+ * password itself and hashes it server-side. So a request says *which*
+ * parameters are passwords and leaves their encoding to the transport.
+ */
+import type { CommandName } from "../command-name.js";
+/** A parameter value as a caller may supply it. */
+export type ParamValue = string | number | bigint | boolean | undefined;
+/** A command and its parameters, in the order they are sent. */
+export interface CommandRequest {
+    /** The command's name, such as `clientlist`; {@link CommandName} lists the known ones. */
+    readonly command: CommandName | (string & {});
+    /**
+     * Its parameters, as wire name and value pairs, in the order they are sent;
+     * an undefined value is omitted.
+     */
+    readonly params?: ReadonlyArray<readonly [string, ParamValue]> | undefined;
+    /**
+     * Further rows, for a command that takes a list: each is a group of
+     * parameters sent after a `|`, as `ftdeletefile cid=1 cpw= name=/a|name=/b`
+     * sends two names. The first row's parameters follow `params`.
+     */
+    readonly rows?: ReadonlyArray<ReadonlyArray<readonly [string, ParamValue]>> | undefined;
+    /** Names of the parameters that carry a channel password. */
+    readonly passwords?: readonly string[] | undefined;
+}
+/** How long a command may take, and how to abandon it. */
+export interface CommandOptions {
+    /** Abandons the command; it then rejects with the signal's reason. */
+    readonly signal?: AbortSignal | undefined;
+    /** Milliseconds to wait for the answer before failing with a CommandTimeoutError. */
+    readonly timeoutMs?: number | undefined;
+}
+/**
+ * A connection the typed commands can run on.
+ *
+ * It is deliberately this narrow. A caller implements it to run the typed
+ * commands over a transport of their own, and `CommandMiddleware` wraps its
+ * `send`, so a method added here would break every implementation and every
+ * middleware along with it: this interface gains no methods in a minor
+ * release. A new capability arrives as an interface, a function or an option
+ * of its own instead, and an implementer or a middleware author may rely on
+ * that.
+ */
+export interface CommandExecutor {
+    /** Send a command and return the rows that answer it. */
+    send(request: CommandRequest, options?: CommandOptions): Promise<Record<string, string>[]>;
+}
+/**
+ * Render a request as a command line.
+ *
+ * `encodePassword` is the transport's rule for password parameters. An empty
+ * password is sent as is: it means "no password", in every encoding.
+ */
+export declare function encodeRequest(request: CommandRequest, encodePassword: (password: string) => string): string;
+//# sourceMappingURL=request.d.ts.map

package/dist/core/command/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../src/core/command/request.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGtD,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAExE,gEAAgE;AAChE,MAAM,WAAW,cAAc;IAC7B,0FAA0F;IAC1F,QAAQ,CAAC,OAAO,EAAE,WAAW,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAC9C;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,GAAG,SAAS,CAAC;IAC3E;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACxF,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;CACpD;AAED,0DAA0D;AAC1D,MAAM,WAAW,cAAc;IAC7B,sEAAsE;IACtE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC1C,qFAAqF;IACrF,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,eAAe;IAC9B,yDAAyD;IAEzD,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;CAC5F;AAiBD;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,cAAc,EACvB,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAC3C,MAAM,CAWR"}

package/dist/core/command/request.js

@@ -0,0 +1,64 @@
+/**
+ * A command as the typed layer describes it, before a transport encodes it.
+ *
+ * The typed commands run on any connection that can execute a command — the
+ * voice client today, ServerQuery later — and the two disagree about how some
+ * values go on the wire. A channel password is the case that matters: the
+ * voice protocol expects `base64(sha1(password))`, while ServerQuery takes the
+ * password itself and hashes it server-side. So a request says *which*
+ * parameters are passwords and leaves their encoding to the transport.
+ */
+import { buildCommandOrdered } from "./command.js";
+/**
+ * Turn a value into its wire form.
+ *
+ * Returns undefined for values that should be omitted entirely — an unset
+ * optional field — because sending `foo=` is not the same as not sending it:
+ * for `channel_password` the first clears the password and the second leaves it
+ * alone. Callers distinguish "unset" from "empty string" by passing undefined
+ * versus "".
+ */
+function encodeValue(value) {
+    if (value === undefined)
+        return undefined;
+    if (typeof value === "boolean")
+        return value ? "1" : "0";
+    return String(value);
+}
+/**
+ * Render a request as a command line.
+ *
+ * `encodePassword` is the transport's rule for password parameters. An empty
+ * password is sent as is: it means "no password", in every encoding.
+ */
+export function encodeRequest(request, encodePassword) {
+    const passwords = request.passwords ?? [];
+    const encode = (params) => encodeParams(params, passwords, encodePassword);
+    const [first = [], ...rest] = request.rows ?? [];
+    const line = buildCommandOrdered(request.command, [
+        ...encode(request.params ?? []),
+        ...encode(first),
+    ]);
+    // A row is the parameters alone, with no command name before them.
+    return [line, ...rest.map((row) => buildCommandOrdered("", encode(row)).slice(1))].join("|");
+}
+function encodeParams(params, passwords, encodePassword) {
+    const out = [];
+    for (const [key, value] of params) {
+        // Flags (`-uid`) are switches: present when true, absent otherwise.
+        if (key.startsWith("-")) {
+            if (value === true)
+                out.push([key, ""]);
+            continue;
+        }
+        if (passwords.includes(key) && typeof value === "string" && value !== "") {
+            out.push([key, encodePassword(value)]);
+            continue;
+        }
+        const encoded = encodeValue(value);
+        if (encoded !== undefined)
+            out.push([key, encoded]);
+    }
+    return out;
+}
+//# sourceMappingURL=request.js.map

package/dist/core/command/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/core/command/request.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAiDnD;;;;;;;;GAQG;AACH,SAAS,WAAW,CAAC,KAAiB;IACpC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IACzD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAC3B,OAAuB,EACvB,cAA4C;IAE5C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;IAC1C,MAAM,MAAM,GAAG,CAAC,MAAoD,EAAE,EAAE,CACtE,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IAClD,MAAM,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;IACjD,MAAM,IAAI,GAAG,mBAAmB,CAAC,OAAO,CAAC,OAAO,EAAE;QAChD,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;QAC/B,GAAG,MAAM,CAAC,KAAK,CAAC;KACjB,CAAC,CAAC;IACH,mEAAmE;IACnE,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/F,CAAC;AAED,SAAS,YAAY,CACnB,MAAoD,EACpD,SAA4B,EAC5B,cAA4C;IAE5C,MAAM,GAAG,GAAqC,EAAE,CAAC;IACjD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;QAClC,oEAAoE;QACpE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,KAAK,KAAK,IAAI;gBAAE,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;YACxC,SAAS;QACX,CAAC;QACD,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACzE,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACvC,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,OAAO,KAAK,SAAS;YAAE,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/core/command/responses.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Where each command's answer actually arrives.
+ *
+ * ServerQuery answers a query with nameless rows followed by `error`. The voice
+ * protocol often does not: it answers `servergrouplist` with a named
+ * `notifyservergrouplist` command, `clientgetuidfromclid` with
+ * `notifyclientuidfromclid`, and so on. A client that only collects nameless
+ * rows reports an empty success for every one of those — which this SDK did,
+ * and documented as a property of the protocol.
+ *
+ * Notifications carry no return_code, so nothing on the wire ties one to the
+ * command that caused it. The pairing is a property of the command, and this
+ * table is where it lives. It was measured command by command
+ * against TS3 3.13.8 and TS6 6.0.0-beta13.1, which answer identically — see
+ * scripts/probe-response-shapes.mts to re-run that measurement.
+ *
+ * Commands not listed answer with nameless rows, or with nothing.
+ */
+/** How the voice protocol delivers one command's data. */
+export interface ResponseSpec {
+    /**
+     * Notifications carrying the data, sent before the command's `error`.
+     *
+     * Rows of these are attributed to the command whose `error` follows them.
+     * The same notification can also arrive unprompted — `notifyservergrouplist`
+     * after someone else edits a group — so they are still dispatched as events.
+     */
+    readonly notifications?: readonly string[];
+    /**
+     * Keep only rows whose `invokerid` is the client itself.
+     *
+     * `notifychannelcreated` is broadcast for every channel anyone creates; the
+     * one answering our `channelcreate` is the one we invoked.
+     */
+    readonly ownRowsOnly?: boolean;
+    /**
+     * Notifications that answer after the `error`, matched on a request field.
+     *
+     * File transfer negotiation reports its key once the command has already
+     * succeeded, echoing the `clientftfid` the request carried; that echo is the
+     * only link between the two.
+     */
+    readonly correlated?: {
+        readonly notifications: readonly string[];
+        /** Request parameter the answer echoes back. */
+        readonly key: string;
+        /**
+         * A notification that reports failure rather than data. Its `status` is an
+         * ordinary server error id: an `ftinitupload` refused for permissions
+         * answers `error id=0` and then this with `status=2568`.
+         */
+        readonly failure?: string;
+    };
+}
+/** The table behind {@link responseSpec}, by command name; exported for the tests that check it against the name tables. */
+export declare const RESPONSES: Readonly<Record<string, ResponseSpec>>;
+/** The response shape of a command, or undefined for plain rows. */
+export declare function responseSpec(command: string): ResponseSpec | undefined;
+//# sourceMappingURL=responses.d.ts.map

package/dist/core/command/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../src/core/command/responses.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3C;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE;QACpB,QAAQ,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;QAC1C,gDAAgD;QAChD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB;;;;WAIG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;CACH;AAYD,4HAA4H;AAC5H,eAAO,MAAM,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAyC5D,CAAC;AAEF,oEAAoE;AACpE,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAEtE"}

package/dist/core/command/responses.js

@@ -0,0 +1,74 @@
+/**
+ * Where each command's answer actually arrives.
+ *
+ * ServerQuery answers a query with nameless rows followed by `error`. The voice
+ * protocol often does not: it answers `servergrouplist` with a named
+ * `notifyservergrouplist` command, `clientgetuidfromclid` with
+ * `notifyclientuidfromclid`, and so on. A client that only collects nameless
+ * rows reports an empty success for every one of those — which this SDK did,
+ * and documented as a property of the protocol.
+ *
+ * Notifications carry no return_code, so nothing on the wire ties one to the
+ * command that caused it. The pairing is a property of the command, and this
+ * table is where it lives. It was measured command by command
+ * against TS3 3.13.8 and TS6 6.0.0-beta13.1, which answer identically — see
+ * scripts/probe-response-shapes.mts to re-run that measurement.
+ *
+ * Commands not listed answer with nameless rows, or with nothing.
+ */
+const inline = (...notifications) => ({ notifications });
+const fileTransfer = (answer) => ({
+    correlated: {
+        notifications: [answer, "notifystatusfiletransfer"],
+        key: "clientftfid",
+        failure: "notifystatusfiletransfer",
+    },
+});
+/** The table behind {@link responseSpec}, by command name; exported for the tests that check it against the name tables. */
+export const RESPONSES = {
+    banlist: inline("notifybanlist"),
+    channelclientpermlist: inline("notifychannelclientpermlist"),
+    channelcreate: { notifications: ["notifychannelcreated"], ownRowsOnly: true },
+    channelgetdescription: inline("notifychanneledited"),
+    channelgroupadd: inline("notifychannelgrouplist"),
+    channelgroupclientlist: inline("notifychannelgroupclientlist"),
+    channelgroupcopy: inline("notifychannelgrouplist"),
+    channelgrouplist: inline("notifychannelgrouplist"),
+    channelgrouppermlist: inline("notifychannelgrouppermlist"),
+    channelpermlist: inline("notifychannelpermlist"),
+    clientdbfind: inline("notifyclientdbfind"),
+    clientdblist: inline("notifyclientdblist"),
+    clientgetdbidfromuid: inline("notifyclientdbidfromuid"),
+    clientgetids: inline("notifyclientids"),
+    clientgetnamefromdbid: inline("notifyclientnamefromdbid"),
+    clientgetnamefromuid: inline("notifyclientnamefromuid"),
+    clientgetuidfromclid: inline("notifyclientuidfromclid"),
+    clientpermlist: inline("notifyclientpermlist"),
+    complainlist: inline("notifycomplainlist"),
+    ftgetfileinfo: inline("notifyfileinfo"),
+    ftgetfilelist: inline("notifyfilelist"),
+    ftinitdownload: fileTransfer("notifystartdownload"),
+    ftinitupload: fileTransfer("notifystartupload"),
+    ftlist: inline("notifyfiletransferlist"),
+    logview: inline("notifyserverlog"),
+    messageget: inline("notifymessage"),
+    messagelist: inline("notifymessagelist"),
+    permfind: inline("notifypermfind"),
+    permissionlist: inline("notifypermissionlist"),
+    permoverview: inline("notifypermoverview"),
+    privilegekeyadd: inline("notifytokenadd"),
+    privilegekeylist: inline("notifytokenlist"),
+    servergroupadd: inline("notifyservergrouplist"),
+    servergroupclientlist: inline("notifyservergroupclientlist"),
+    servergroupcopy: inline("notifyservergrouplist"),
+    servergrouplist: inline("notifyservergrouplist"),
+    servergrouppermlist: inline("notifyservergrouppermlist"),
+    servergroupsbyclientid: inline("notifyservergroupsbyclientid"),
+    serverrequestconnectioninfo: inline("notifyserverconnectioninfo"),
+    servertemppasswordlist: inline("notifyservertemppasswordlist"),
+};
+/** The response shape of a command, or undefined for plain rows. */
+export function responseSpec(command) {
+    return Object.hasOwn(RESPONSES, command) ? RESPONSES[command] : undefined;
+}
+//# sourceMappingURL=responses.js.map

package/dist/core/command/responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../../src/core/command/responses.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAuCH,MAAM,MAAM,GAAG,CAAC,GAAG,aAAuB,EAAgB,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;AAEjF,MAAM,YAAY,GAAG,CAAC,MAAc,EAAgB,EAAE,CAAC,CAAC;IACtD,UAAU,EAAE;QACV,aAAa,EAAE,CAAC,MAAM,EAAE,0BAA0B,CAAC;QACnD,GAAG,EAAE,aAAa;QAClB,OAAO,EAAE,0BAA0B;KACpC;CACF,CAAC,CAAC;AAEH,4HAA4H;AAC5H,MAAM,CAAC,MAAM,SAAS,GAA2C;IAC/D,OAAO,EAAE,MAAM,CAAC,eAAe,CAAC;IAChC,qBAAqB,EAAE,MAAM,CAAC,6BAA6B,CAAC;IAC5D,aAAa,EAAE,EAAE,aAAa,EAAE,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE;IAC7E,qBAAqB,EAAE,MAAM,CAAC,qBAAqB,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC,wBAAwB,CAAC;IACjD,sBAAsB,EAAE,MAAM,CAAC,8BAA8B,CAAC;IAC9D,gBAAgB,EAAE,MAAM,CAAC,wBAAwB,CAAC;IAClD,gBAAgB,EAAE,MAAM,CAAC,wBAAwB,CAAC;IAClD,oBAAoB,EAAE,MAAM,CAAC,4BAA4B,CAAC;IAC1D,eAAe,EAAE,MAAM,CAAC,uBAAuB,CAAC;IAChD,YAAY,EAAE,MAAM,CAAC,oBAAoB,CAAC;IAC1C,YAAY,EAAE,MAAM,CAAC,oBAAoB,CAAC;IAC1C,oBAAoB,EAAE,MAAM,CAAC,yBAAyB,CAAC;IACvD,YAAY,EAAE,MAAM,CAAC,iBAAiB,CAAC;IACvC,qBAAqB,EAAE,MAAM,CAAC,0BAA0B,CAAC;IACzD,oBAAoB,EAAE,MAAM,CAAC,yBAAyB,CAAC;IACvD,oBAAoB,EAAE,MAAM,CAAC,yBAAyB,CAAC;IACvD,cAAc,EAAE,MAAM,CAAC,sBAAsB,CAAC;IAC9C,YAAY,EAAE,MAAM,CAAC,oBAAoB,CAAC;IAC1C,aAAa,EAAE,MAAM,CAAC,gBAAgB,CAAC;IACvC,aAAa,EAAE,MAAM,CAAC,gBAAgB,CAAC;IACvC,cAAc,EAAE,YAAY,CAAC,qBAAqB,CAAC;IACnD,YAAY,EAAE,YAAY,CAAC,mBAAmB,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC,wBAAwB,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC,eAAe,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC,mBAAmB,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAClC,cAAc,EAAE,MAAM,CAAC,sBAAsB,CAAC;IAC9C,YAAY,EAAE,MAAM,CAAC,oBAAoB,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC,gBAAgB,CAAC;IACzC,gBAAgB,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAC3C,cAAc,EAAE,MAAM,CAAC,uBAAuB,CAAC;IAC/C,qBAAqB,EAAE,MAAM,CAAC,6BAA6B,CAAC;IAC5D,eAAe,EAAE,MAAM,CAAC,uBAAuB,CAAC;IAChD,eAAe,EAAE,MAAM,CAAC,uBAAuB,CAAC;IAChD,mBAAmB,EAAE,MAAM,CAAC,2BAA2B,CAAC;IACxD,sBAAsB,EAAE,MAAM,CAAC,8BAA8B,CAAC;IAC9D,2BAA2B,EAAE,MAAM,CAAC,4BAA4B,CAAC;IACjE,sBAAsB,EAAE,MAAM,CAAC,8BAA8B,CAAC;CAC/D,CAAC;AAEF,oEAAoE;AACpE,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5E,CAAC"}