@honeybbq/teamspeak 0.0.1 → 1.0.0-beta.7

package/dist/core/api/server.js

@@ -0,0 +1,290 @@
+/**
+ * Server and instance commands.
+ *
+ * "Server" here means the virtual server a client is connected to; "instance"
+ * means the process hosting it. The distinction matters because the setting
+ * names differ (`virtualserver_*` versus `serverinstance_*`) and the two are
+ * easy to mix up.
+ */
+import { nonEmpty, uint, U16, firstRow, exec, query, list, encodeFields, inSeconds, parsePermission, permissionParam, createdGroupID, str, big, num, bool, icon, date, durationMs, SECOND, } from "./command.js";
+import { asChannelID, asClientDBID, asClientID, asServerGroupID, asServerID, asUID, } from "../command/ids.js";
+const parseServerGroup = (row) => ({
+    id: asServerGroupID(big(row, "sgid")),
+    name: str(row, "name"),
+    type: num(row, "type"),
+    iconID: icon(row, "iconid"),
+    savedInDatabase: bool(row, "savedb"),
+    sortID: num(row, "sortid"),
+    nameMode: num(row, "namemode"),
+    modifyPower: num(row, "n_modifyp"),
+    memberAddPower: num(row, "n_member_addp"),
+    memberRemovePower: num(row, "n_member_removep"),
+});
+/** Every server group. */
+export async function listServerGroups(client, options) {
+    return (await list(client, "servergrouplist", [], options)).map(parseServerGroup);
+}
+/**
+ * The virtual server's settings, as `serverinfo` reports them.
+ *
+ * Raw rather than parsed: `serverinfo` carries well over a hundred
+ * `virtualserver_*` fields, which ones appear depends on the server version and
+ * on the caller's permissions, and a typed subset would drop the rest. The
+ * keys are named in `PropertyName`.
+ */
+export async function getServerInfo(client, options) {
+    return firstRow(await query(client, "serverinfo", [], options), "serverinfo");
+}
+/** Raw wire properties, sent as given. */
+const rawProperties = (settings) => Object.entries(settings).filter((entry) => typeof entry[1] === "string");
+/**
+ * Change the virtual server's settings. Only the properties you pass are sent.
+ *
+ * Unlike every other options object, these are the raw `virtualserver_*`
+ * wire properties from `serverinfo`, passed through as given rather than
+ * enumerated: there are well over a hundred, they are version-dependent, and a
+ * value read back from {@link getServerInfo} should be writable straight back.
+ * The values are strings, as `getServerInfo` returns them. The editable keys
+ * are marked in `PropertyName`.
+ */
+export async function editServer(client, settings, options) {
+    await exec(client, "serveredit", rawProperties(settings), options);
+}
+/**
+ * The host process's settings, as `hostinfo` reports them, raw.
+ *
+ * Needs an instance-level permission (`b_serverinstance_*`), which not even the
+ * Server Admin group holds by default — expect error 2568 until it is granted.
+ * Granted, it works over the voice protocol like any other query. The keys are
+ * named in `PropertyName`.
+ */
+export async function getHostInfo(client, options) {
+    return firstRow(await query(client, "hostinfo", [], options), "hostinfo");
+}
+/**
+ * The server instance's settings, as `instanceinfo` reports them, raw.
+ *
+ * Needs an instance-level permission (`b_serverinstance_*`), which not even the
+ * Server Admin group holds by default — expect error 2568 until it is granted.
+ * Granted, it works over the voice protocol like any other query. The keys are
+ * named in `PropertyName`.
+ */
+export async function getInstanceInfo(client, options) {
+    return firstRow(await query(client, "instanceinfo", [], options), "instanceinfo");
+}
+/**
+ * Change the server instance's settings: raw `serverinstance_*` properties,
+ * passed through as given, for the same reasons as {@link editServer}. The
+ * editable keys are marked in `PropertyName`.
+ */
+export async function editInstance(client, settings, options) {
+    await exec(client, "instanceedit", rawProperties(settings), options);
+}
+/**
+ * Active IP bindings, when the instance is multi-homed.
+ *
+ * Needs an instance-level permission (`b_serverinstance_*`), which not even the
+ * Server Admin group holds by default — expect error 2568 until it is granted.
+ * Granted, it works over the voice protocol like any other query.
+ */
+export async function listBindings(client, options = {}) {
+    const subsystem = options.subsystem || "voice";
+    const rows = await list(client, "bindinglist", [["subsystem", nonEmpty(options.subsystem ?? "")]], options);
+    return rows.map((row) => ({
+        subsystem: str(row, "subsystem") || subsystem,
+        ip: str(row, "ip"),
+        port: row["port"] === undefined ? undefined : num(row, "port"),
+    }));
+}
+/** The server's build version. */
+export async function getVersion(client, options) {
+    const row = firstRow(await query(client, "version", [], options), "version");
+    return { version: str(row, "version"), build: num(row, "build"), platform: str(row, "platform") };
+}
+/** Which server and client this connection is, as the server sees it. */
+export async function whoAmI(client, options) {
+    const row = firstRow(await query(client, "whoami", [], options), "whoami");
+    return {
+        serverStatus: str(row, "virtualserver_status"),
+        serverID: asServerID(big(row, "virtualserver_id")),
+        serverUID: str(row, "virtualserver_unique_identifier"),
+        serverPort: num(row, "virtualserver_port"),
+        clientID: asClientID(uint(row, "client_id", U16)),
+        channelID: asChannelID(big(row, "client_channel_id")),
+        nickname: str(row, "client_nickname"),
+        databaseID: asClientDBID(big(row, "client_database_id")),
+        loginName: str(row, "client_login_name"),
+        uid: asUID(str(row, "client_unique_identifier")),
+    };
+}
+/**
+ * The virtual server's traffic statistics — not this connection's, as the
+ * command's name suggests.
+ */
+export async function getConnectionInfo(client, options) {
+    const row = firstRow(await query(client, "serverrequestconnectioninfo", [], options), "serverrequestconnectioninfo");
+    return {
+        fileTransferBandwidthSent: num(row, "connection_filetransfer_bandwidth_sent"),
+        fileTransferBandwidthReceived: num(row, "connection_filetransfer_bandwidth_received"),
+        fileTransferBytesSent: num(row, "connection_filetransfer_bytes_sent_total"),
+        fileTransferBytesReceived: num(row, "connection_filetransfer_bytes_received_total"),
+        packetsSent: num(row, "connection_packets_sent_total"),
+        bytesSent: num(row, "connection_bytes_sent_total"),
+        packetsReceived: num(row, "connection_packets_received_total"),
+        bytesReceived: num(row, "connection_bytes_received_total"),
+        bandwidthSentLastSecond: num(row, "connection_bandwidth_sent_last_second_total"),
+        bandwidthSentLastMinute: num(row, "connection_bandwidth_sent_last_minute_total"),
+        bandwidthReceivedLastSecond: num(row, "connection_bandwidth_received_last_second_total"),
+        bandwidthReceivedLastMinute: num(row, "connection_bandwidth_received_last_minute_total"),
+        connectedTimeMs: durationMs(row, "connection_connected_time", SECOND),
+        packetLoss: num(row, "connection_packetloss_total"),
+        pingMs: num(row, "connection_ping"),
+    };
+}
+/**
+ * The numeric id of the virtual server listening on `port`.
+ *
+ * Needs an instance-level permission (`b_serverinstance_*`), which not even the
+ * Server Admin group holds by default — expect error 2568 until it is granted.
+ * Granted, it works over the voice protocol like any other query.
+ */
+export async function getServerIDByPort(client, port, options) {
+    const rows = await query(client, "serveridgetbyport", [["virtualserver_port", port]], options);
+    return asServerID(big(firstRow(rows, "serveridgetbyport", "server_id"), "server_id"));
+}
+// ---- Server groups ----------------------------------------------------------
+/**
+ * Create a server group.
+ *
+ * `type` is required, and always sent: the server's own default is
+ * `GroupType.Regular`, while the type's first value is `Template`, so leaving
+ * it to a default on either side is a trap.
+ */
+export async function createServerGroup(client, name, type, options) {
+    const rows = await query(client, "servergroupadd", [
+        ["name", name],
+        ["type", type],
+    ], options);
+    return asServerGroupID(createdGroupID(rows, "sgid", name, "servergroupadd"));
+}
+/** Delete a server group. */
+export async function deleteServerGroup(client, sgid, options = {}) {
+    await exec(client, "servergroupdel", [
+        ["sgid", sgid],
+        ["force", options.force ?? false],
+    ], options);
+}
+/** Rename a server group. */
+export async function renameServerGroup(client, sgid, name, options) {
+    await exec(client, "servergrouprename", [
+        ["sgid", sgid],
+        ["name", name],
+    ], options);
+}
+/**
+ * Copy a server group's permissions onto another; a `targetGroupID` of 0 makes
+ * the server create a new group named `name`, of `type`.
+ */
+export async function copyServerGroup(client, sourceGroupID, targetGroupID, name, type, options) {
+    const rows = await query(client, "servergroupcopy", [
+        ["ssgid", sourceGroupID],
+        ["tsgid", targetGroupID],
+        ["name", name],
+        ["type", type],
+    ], options);
+    // Copying onto an existing group keeps that group's id.
+    if (targetGroupID !== 0n)
+        return targetGroupID;
+    return asServerGroupID(createdGroupID(rows, "sgid", name, "servergroupcopy"));
+}
+/** Add a client to a server group. */
+export async function addClientToServerGroup(client, sgid, cldbid, options) {
+    await exec(client, "servergroupaddclient", [
+        ["sgid", sgid],
+        ["cldbid", cldbid],
+    ], options);
+}
+/** Remove a client from a server group. */
+export async function removeClientFromServerGroup(client, sgid, cldbid, options) {
+    await exec(client, "servergroupdelclient", [
+        ["sgid", sgid],
+        ["cldbid", cldbid],
+    ], options);
+}
+const memberFlags = { names: "-names", uids: "-uid" };
+/** Members of a server group, optionally with their nicknames and uids. */
+export async function listServerGroupClients(client, sgid, options = {}) {
+    const rows = await list(client, "servergroupclientlist", [["sgid", sgid], ...encodeFields(options, memberFlags)], options);
+    return rows.map((row) => ({
+        databaseID: asClientDBID(big(row, "cldbid")),
+        nickname: str(row, "client_nickname"),
+        uid: asUID(str(row, "client_unique_identifier")),
+    }));
+}
+/** Server groups a client belongs to. */
+export async function getServerGroupsByClient(client, cldbid, options) {
+    const rows = await list(client, "servergroupsbyclientid", [["cldbid", cldbid]], options);
+    return rows.map((row) => ({ id: asServerGroupID(big(row, "sgid")), name: str(row, "name") }));
+}
+/** Permissions set on a server group. */
+export async function listServerGroupPermissions(client, sgid, options) {
+    return (await list(client, "servergrouppermlist", [["sgid", sgid]], options)).map(parsePermission);
+}
+/** Set a permission on a server group. */
+export async function addServerGroupPermission(client, sgid, permission, value, options = {}) {
+    await exec(client, "servergroupaddperm", [
+        ["sgid", sgid],
+        permissionParam(permission),
+        ["permvalue", value],
+        ["permnegated", options.negated ?? false],
+        ["permskip", options.skip ?? false],
+    ], options);
+}
+/** Remove a permission from a server group. */
+export async function deleteServerGroupPermission(client, sgid, permission, options) {
+    await exec(client, "servergroupdelperm", [["sgid", sgid], permissionParam(permission)], options);
+}
+/** The server's temporary passwords. */
+export async function listTempPasswords(client, options) {
+    const rows = await list(client, "servertemppasswordlist", [], options);
+    return rows.map((row) => ({
+        password: str(row, "pw_clear"),
+        description: str(row, "desc"),
+        creatorNickname: str(row, "nickname"),
+        creatorUID: asUID(str(row, "uid")),
+        startsAt: date(row, "start"),
+        endsAt: date(row, "end"),
+        targetChannelID: asChannelID(big(row, "tcid")),
+    }));
+}
+const tempPasswordNames = {
+    password: "pw",
+    description: "desc",
+    durationMs: ["duration", inSeconds],
+    targetChannelID: "tcid",
+    targetChannelPassword: "tcpw",
+};
+/**
+ * Create a temporary server password.
+ *
+ * The server reports nothing back — the password is the one passed in.
+ */
+export async function addTempPassword(client, temp, options) {
+    if (typeof temp.password !== "string" || temp.password === "") {
+        throw new TypeError("a temporary password cannot be empty");
+    }
+    // tcid and tcpw are required on the wire, even for the default channel.
+    const fields = {
+        ...temp,
+        targetChannelID: temp.targetChannelID ?? asChannelID(0),
+        targetChannelPassword: temp.targetChannelPassword ?? "",
+    };
+    await exec(client, "servertemppasswordadd", encodeFields(fields, tempPasswordNames), options, [
+        "tcpw",
+    ]);
+}
+/** Delete a temporary password. */
+export async function deleteTempPassword(client, password, options) {
+    await exec(client, "servertemppassworddel", [["pw", password]], options);
+}
+//# sourceMappingURL=server.js.map

package/dist/core/api/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/core/api/server.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACL,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,YAAY,EACZ,SAAS,EACT,eAAe,EACf,eAAe,EACf,cAAc,EACd,GAAG,EACH,GAAG,EACH,GAAG,EACH,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,UAAU,EACV,MAAM,GACP,MAAM,cAAc,CAAC;AAYtB,OAAO,EACL,WAAW,EACX,YAAY,EACZ,UAAU,EACV,eAAe,EACf,UAAU,EACV,KAAK,GACN,MAAM,mBAAmB,CAAC;AA6B3B,MAAM,gBAAgB,GAAG,CAAC,GAA2B,EAAe,EAAE,CAAC,CAAC;IACtE,EAAE,EAAE,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACrC,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC;IAC3B,eAAe,EAAE,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC;IACpC,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC;IAC1B,QAAQ,EAAE,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC;IAC9B,WAAW,EAAE,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC;IAClC,cAAc,EAAE,GAAG,CAAC,GAAG,EAAE,eAAe,CAAC;IACzC,iBAAiB,EAAE,GAAG,CAAC,GAAG,EAAE,kBAAkB,CAAC;CAChD,CAAC,CAAC;AAEH,0BAA0B;AAC1B,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAuB,EACvB,OAAwB;IAExB,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;AACpF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAuB,EACvB,OAAwB;IAExB,OAAO,QAAQ,CAAC,MAAM,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC;AAChF,CAAC;AAED,0CAA0C;AAC1C,MAAM,aAAa,GAAG,CAAC,QAA0C,EAAU,EAAE,CAC3E,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAC7B,CAAC,KAAK,EAA6B,EAAE,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CACnE,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuB,EACvB,QAA0C,EAC1C,OAAwB;IAExB,MAAM,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAuB,EACvB,OAAwB;IAExB,OAAO,QAAQ,CAAC,MAAM,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAuB,EACvB,OAAwB;IAExB,OAAO,QAAQ,CAAC,MAAM,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC;AACpF,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuB,EACvB,QAA0C,EAC1C,OAAwB;IAExB,MAAM,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;AACvE,CAAC;AAsBD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuB,EACvB,OAAO,GAAuB,EAAE;IAEhC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC;IAC/C,MAAM,IAAI,GAAG,MAAM,IAAI,CACrB,MAAM,EACN,aAAa,EACb,CAAC,CAAC,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC,EAClD,OAAO,CACR,CAAC;IACF,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACxB,SAAS,EAAE,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,SAAS;QAC7C,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC;QAClB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC;KAC/D,CAAC,CAAC,CAAC;AACN,CAAC;AAYD,kCAAkC;AAClC,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuB,EACvB,OAAwB;IAExB,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;IAC7E,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,EAAE,CAAC;AACpG,CAAC;AA8BD,yEAAyE;AACzE,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,MAAuB,EAAE,OAAwB;IAC5E,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3E,OAAO;QACL,YAAY,EAAE,GAAG,CAAC,GAAG,EAAE,sBAAsB,CAAC;QAC9C,QAAQ,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;QAClD,SAAS,EAAE,GAAG,CAAC,GAAG,EAAE,iCAAiC,CAAC;QACtD,UAAU,EAAE,GAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC;QAC1C,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;QACjD,SAAS,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;QACrD,QAAQ,EAAE,GAAG,CAAC,GAAG,EAAE,iBAAiB,CAAC;QACrC,UAAU,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;QACxD,SAAS,EAAE,GAAG,CAAC,GAAG,EAAE,mBAAmB,CAAC;QACxC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,0BAA0B,CAAC,CAAC;KACjD,CAAC;AACJ,CAAC;AA2CD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuB,EACvB,OAAwB;IAExB,MAAM,GAAG,GAAG,QAAQ,CAClB,MAAM,KAAK,CAAC,MAAM,EAAE,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,EAC/D,6BAA6B,CAC9B,CAAC;IACF,OAAO;QACL,yBAAyB,EAAE,GAAG,CAAC,GAAG,EAAE,wCAAwC,CAAC;QAC7E,6BAA6B,EAAE,GAAG,CAAC,GAAG,EAAE,4CAA4C,CAAC;QACrF,qBAAqB,EAAE,GAAG,CAAC,GAAG,EAAE,0CAA0C,CAAC;QAC3E,yBAAyB,EAAE,GAAG,CAAC,GAAG,EAAE,8CAA8C,CAAC;QACnF,WAAW,EAAE,GAAG,CAAC,GAAG,EAAE,+BAA+B,CAAC;QACtD,SAAS,EAAE,GAAG,CAAC,GAAG,EAAE,6BAA6B,CAAC;QAClD,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,mCAAmC,CAAC;QAC9D,aAAa,EAAE,GAAG,CAAC,GAAG,EAAE,iCAAiC,CAAC;QAC1D,uBAAuB,EAAE,GAAG,CAAC,GAAG,EAAE,6CAA6C,CAAC;QAChF,uBAAuB,EAAE,GAAG,CAAC,GAAG,EAAE,6CAA6C,CAAC;QAChF,2BAA2B,EAAE,GAAG,CAAC,GAAG,EAAE,iDAAiD,CAAC;QACxF,2BAA2B,EAAE,GAAG,CAAC,GAAG,EAAE,iDAAiD,CAAC;QACxF,eAAe,EAAE,UAAU,CAAC,GAAG,EAAE,2BAA2B,EAAE,MAAM,CAAC;QACrE,UAAU,EAAE,GAAG,CAAC,GAAG,EAAE,6BAA6B,CAAC;QACnD,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,iBAAiB,CAAC;KACpC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuB,EACvB,IAAY,EACZ,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/F,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;AACxF,CAAC;AAED,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuB,EACvB,IAAY,EACZ,IAAe,EACf,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,KAAK,CACtB,MAAM,EACN,gBAAgB,EAChB;QACE,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,CAAC,MAAM,EAAE,IAAI,CAAC;KACf,EACD,OAAO,CACR,CAAC;IACF,OAAO,eAAe,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,6BAA6B;AAC7B,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuB,EACvB,IAAmB,EACnB,OAAO,GAAuB,EAAE;IAEhC,MAAM,IAAI,CACR,MAAM,EACN,gBAAgB,EAChB;QACE,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;KAClC,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED,6BAA6B;AAC7B,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuB,EACvB,IAAmB,EACnB,IAAY,EACZ,OAAwB;IAExB,MAAM,IAAI,CACR,MAAM,EACN,mBAAmB,EACnB;QACE,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,CAAC,MAAM,EAAE,IAAI,CAAC;KACf,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAuB,EACvB,aAA4B,EAC5B,aAA4B,EAC5B,IAAY,EACZ,IAAe,EACf,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,KAAK,CACtB,MAAM,EACN,iBAAiB,EACjB;QACE,CAAC,OAAO,EAAE,aAAa,CAAC;QACxB,CAAC,OAAO,EAAE,aAAa,CAAC;QACxB,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,CAAC,MAAM,EAAE,IAAI,CAAC;KACf,EACD,OAAO,CACR,CAAC;IACF,wDAAwD;IACxD,IAAI,aAAa,KAAK,EAAE;QAAE,OAAO,aAAa,CAAC;IAC/C,OAAO,eAAe,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,sCAAsC;AACtC,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAuB,EACvB,IAAmB,EACnB,MAAkB,EAClB,OAAwB;IAExB,MAAM,IAAI,CACR,MAAM,EACN,sBAAsB,EACtB;QACE,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,CAAC,QAAQ,EAAE,MAAM,CAAC;KACnB,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED,2CAA2C;AAC3C,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,MAAuB,EACvB,IAAmB,EACnB,MAAkB,EAClB,OAAwB;IAExB,MAAM,IAAI,CACR,MAAM,EACN,sBAAsB,EACtB;QACE,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,CAAC,QAAQ,EAAE,MAAM,CAAC;KACnB,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAUD,MAAM,WAAW,GAA4C,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAY/F,2EAA2E;AAC3E,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAuB,EACvB,IAAmB,EACnB,OAAO,GAAiC,EAAE;IAE1C,MAAM,IAAI,GAAG,MAAM,IAAI,CACrB,MAAM,EACN,uBAAuB,EACvB,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,EACvD,OAAO,CACR,CAAC;IACF,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACxB,UAAU,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC5C,QAAQ,EAAE,GAAG,CAAC,GAAG,EAAE,iBAAiB,CAAC;QACrC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,0BAA0B,CAAC,CAAC;KACjD,CAAC,CAAC,CAAC;AACN,CAAC;AAUD,yCAAyC;AACzC,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,MAAuB,EACvB,MAAkB,EAClB,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,wBAAwB,EAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACzF,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AAChG,CAAC;AAED,yCAAyC;AACzC,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,MAAuB,EACvB,IAAmB,EACnB,OAAwB;IAExB,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAC/E,eAAe,CAChB,CAAC;AACJ,CAAC;AAUD,0CAA0C;AAC1C,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,MAAuB,EACvB,IAAmB,EACnB,UAAsB,EACtB,KAAa,EACb,OAAO,GAAiC,EAAE;IAE1C,MAAM,IAAI,CACR,MAAM,EACN,oBAAoB,EACpB;QACE,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,eAAe,CAAC,UAAU,CAAC;QAC3B,CAAC,WAAW,EAAE,KAAK,CAAC;QACpB,CAAC,aAAa,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC;QACzC,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;KACpC,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED,+CAA+C;AAC/C,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,MAAuB,EACvB,IAAmB,EACnB,UAAsB,EACtB,OAAwB;IAExB,MAAM,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AACnG,CAAC;AAsBD,wCAAwC;AACxC,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuB,EACvB,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,wBAAwB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACxB,QAAQ,EAAE,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC;QAC9B,WAAW,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC;QAC7B,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC;QACrC,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;QAC5B,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC;QACxB,eAAe,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;KAC/C,CAAC,CAAC,CAAC;AACN,CAAC;AAsBD,MAAM,iBAAiB,GAAmC;IACxD,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,MAAM;IACnB,UAAU,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC;IACnC,eAAe,EAAE,MAAM;IACvB,qBAAqB,EAAE,MAAM;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAuB,EACvB,IAAyB,EACzB,OAAwB;IAExB,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;QAC9D,MAAM,IAAI,SAAS,CAAC,sCAAsC,CAAC,CAAC;IAC9D,CAAC;IACD,wEAAwE;IACxE,MAAM,MAAM,GAAwB;QAClC,GAAG,IAAI;QACP,eAAe,EAAE,IAAI,CAAC,eAAe,IAAI,WAAW,CAAC,CAAC,CAAC;QACvD,qBAAqB,EAAE,IAAI,CAAC,qBAAqB,IAAI,EAAE;KACxD,CAAC;IACF,MAAM,IAAI,CAAC,MAAM,EAAE,uBAAuB,EAAE,YAAY,CAAC,MAAM,EAAE,iBAAiB,CAAC,EAAE,OAAO,EAAE;QAC5F,MAAM;KACP,CAAC,CAAC;AACL,CAAC;AAED,mCAAmC;AACnC,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAuB,EACvB,QAAgB,EAChB,OAAwB;IAExB,MAAM,IAAI,CAAC,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC"}

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

@@ -0,0 +1,20 @@
+/**
+ * Escape a value for the command line: the characters that delimit a command
+ * (space, `|`, `/`, the backslash itself, control characters) become their
+ * two-character escapes.
+ */
+export declare function escape(s: string): string;
+/** Undo {@link escape}, in one pass so that `\\s` comes back as `\s`, not a space. */
+export declare function unescape(s: string): string;
+/** A command line, parsed. */
+export interface Command {
+    /** The command's name, or `""` for a data row, which carries no name. */
+    readonly name: string;
+    /** Its parameters, unescaped. A flag such as `-uid` maps to `""`. */
+    readonly params: Readonly<Record<string, string>>;
+}
+/** Build a command line from a parameter map; keys and values are escaped alike. */
+export declare function buildCommand(cmd: string, params: Readonly<Record<string, string>>): string;
+/** Build a TS3 command string preserving parameter order. */
+export declare function buildCommandOrdered(cmd: string, params: ReadonlyArray<readonly [string, string]>): string;
+//# sourceMappingURL=command.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../../src/core/command/command.ts"],"names":[],"mappings":"AAcA;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAMxC;AAED,sFAAsF;AACtF,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAgE1C;AAED,8BAA8B;AAC9B,MAAM,WAAW,OAAO;IACtB,yEAAyE;IACzE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,qEAAqE;IACrE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACnD;AAED,oFAAoF;AACpF,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAM1F;AAED,6DAA6D;AAC7D,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAC/C,MAAM,CASR"}

package/dist/core/command/command.js

@@ -0,0 +1,112 @@
+const ESCAPE_MAP = [
+    ["\\", "\\\\"],
+    ["/", "\\/"],
+    [" ", "\\s"],
+    ["|", "\\p"],
+    ["\x07", "\\a"],
+    ["\x08", "\\b"],
+    ["\x0C", "\\f"],
+    ["\n", "\\n"],
+    ["\r", "\\r"],
+    ["\t", "\\t"],
+    ["\x0B", "\\v"],
+];
+/**
+ * Escape a value for the command line: the characters that delimit a command
+ * (space, `|`, `/`, the backslash itself, control characters) become their
+ * two-character escapes.
+ */
+export function escape(s) {
+    let result = s;
+    for (const [from, to] of ESCAPE_MAP) {
+        result = result.split(from).join(to);
+    }
+    return result;
+}
+/** Undo {@link escape}, in one pass so that `\\s` comes back as `\s`, not a space. */
+export function unescape(s) {
+    // Process escape sequences in a single pass to avoid double-substitution
+    let result = "";
+    let i = 0;
+    while (i < s.length) {
+        if (s[i] === "\\" && i + 1 < s.length) {
+            const next = s[i + 1];
+            switch (next) {
+                case "\\":
+                    result += "\\";
+                    i += 2;
+                    break;
+                case "/":
+                    result += "/";
+                    i += 2;
+                    break;
+                case "s":
+                    result += " ";
+                    i += 2;
+                    break;
+                case "p":
+                    result += "|";
+                    i += 2;
+                    break;
+                case "a":
+                    result += "\x07";
+                    i += 2;
+                    break;
+                case "b":
+                    result += "\x08";
+                    i += 2;
+                    break;
+                case "f":
+                    result += "\x0C";
+                    i += 2;
+                    break;
+                case "n":
+                    result += "\n";
+                    i += 2;
+                    break;
+                case "r":
+                    result += "\r";
+                    i += 2;
+                    break;
+                case "t":
+                    result += "\t";
+                    i += 2;
+                    break;
+                case "v":
+                    result += "\x0B";
+                    i += 2;
+                    break;
+                case undefined:
+                default:
+                    result += s[i] ?? "";
+                    i++;
+                    break;
+            }
+        }
+        else {
+            result += s[i] ?? "";
+            i++;
+        }
+    }
+    return result;
+}
+/** Build a command line from a parameter map; keys and values are escaped alike. */
+export function buildCommand(cmd, params) {
+    const parts = [escape(cmd)];
+    for (const [k, v] of Object.entries(params)) {
+        parts.push(`${escape(k)}=${escape(v)}`);
+    }
+    return parts.join(" ");
+}
+/** Build a TS3 command string preserving parameter order. */
+export function buildCommandOrdered(cmd, params) {
+    const parts = [escape(cmd)];
+    for (const [k, v] of params) {
+        // A flag such as `-uid` is a bare switch. `-uid=1` happens to be accepted
+        // over the voice protocol, but it is not the documented form and nothing
+        // promises another transport tolerates it.
+        parts.push(k.startsWith("-") && v === "" ? escape(k) : `${escape(k)}=${escape(v)}`);
+    }
+    return parts.join(" ");
+}
+//# sourceMappingURL=command.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../../src/core/command/command.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,GAA4B;IAC1C,CAAC,IAAI,EAAE,MAAM,CAAC;IACd,CAAC,GAAG,EAAE,KAAK,CAAC;IACZ,CAAC,GAAG,EAAE,KAAK,CAAC;IACZ,CAAC,GAAG,EAAE,KAAK,CAAC;IACZ,CAAC,MAAM,EAAE,KAAK,CAAC;IACf,CAAC,MAAM,EAAE,KAAK,CAAC;IACf,CAAC,MAAM,EAAE,KAAK,CAAC;IACf,CAAC,IAAI,EAAE,KAAK,CAAC;IACb,CAAC,IAAI,EAAE,KAAK,CAAC;IACb,CAAC,IAAI,EAAE,KAAK,CAAC;IACb,CAAC,MAAM,EAAE,KAAK,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,CAAS;IAC9B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;QACpC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,QAAQ,CAAC,CAAS;IAChC,yEAAyE;IACzE,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QACpB,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACtB,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,IAAI;oBACP,MAAM,IAAI,IAAI,CAAC;oBACf,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,GAAG,CAAC;oBACd,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,GAAG,CAAC;oBACd,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,GAAG,CAAC;oBACd,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,MAAM,CAAC;oBACjB,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,MAAM,CAAC;oBACjB,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,MAAM,CAAC;oBACjB,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,IAAI,CAAC;oBACf,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,IAAI,CAAC;oBACf,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,IAAI,CAAC;oBACf,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,GAAG;oBACN,MAAM,IAAI,MAAM,CAAC;oBACjB,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,KAAK,SAAS,CAAC;gBACf;oBACE,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;oBACrB,CAAC,EAAE,CAAC;oBACJ,MAAM;YACV,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC,EAAE,CAAC;QACN,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAUD,oFAAoF;AACpF,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,MAAwC;IAChF,MAAM,KAAK,GAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,mBAAmB,CACjC,GAAW,EACX,MAAgD;IAEhD,MAAM,KAAK,GAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;QAC5B,0EAA0E;QAC1E,yEAAyE;QACzE,2CAA2C;QAC3C,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC"}

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

@@ -0,0 +1,125 @@
+/**
+ * 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.
+ */
+/** A channel (`cid`). */
+export type ChannelID = bigint & {
+    readonly __brand: "ChannelID";
+};
+/**
+ * A connected client (`clid`): an id for this connection only, assigned anew
+ * every time the client connects.
+ */
+export type ClientID = number & {
+    readonly __brand: "ClientID";
+};
+/**
+ * A client's database record (`cldbid`): stable across connections, unlike its
+ * ClientID.
+ */
+export type ClientDBID = bigint & {
+    readonly __brand: "ClientDBID";
+};
+/** A server group (`sgid`). */
+export type ServerGroupID = bigint & {
+    readonly __brand: "ServerGroupID";
+};
+/** A channel group (`cgid`). */
+export type ChannelGroupID = bigint & {
+    readonly __brand: "ChannelGroupID";
+};
+/** A permission's numeric id (`permid`), a 32-bit value assigned by the server build. */
+export type PermissionID = number & {
+    readonly __brand: "PermissionID";
+};
+/**
+ * An icon: the unsigned CRC32 of the icon file, which also names the file
+ * (`/icon_<id>`) in the server's file area.
+ */
+export type IconID = number & {
+    readonly __brand: "IconID";
+};
+/** A ban (`banid`). */
+export type BanID = bigint & {
+    readonly __brand: "BanID";
+};
+/** An offline message (`msgid`). */
+export type MessageID = bigint & {
+    readonly __brand: "MessageID";
+};
+/** A virtual server on an instance (`sid`, `virtualserver_id`). */
+export type ServerID = bigint & {
+    readonly __brand: "ServerID";
+};
+/** The client's id for a file transfer (`clientftfid`), a 16-bit value it chooses. */
+export type ClientFileTransferID = number & {
+    readonly __brand: "ClientFileTransferID";
+};
+/** The server's id for a file transfer (`serverftfid`), a 16-bit value. */
+export type ServerFileTransferID = number & {
+    readonly __brand: "ServerFileTransferID";
+};
+/** Brand a ban id, an integer from 0 to 2^64-1, from a number or a bigint. */
+export declare const asBanID: (v: bigint | number) => BanID;
+/** Brand an offline message id, an integer from 0 to 2^64-1. */
+export declare const asMessageID: (v: bigint | number) => MessageID;
+/** Brand a virtual server id, an integer from 0 to 2^64-1. */
+export declare const asServerID: (v: bigint | number) => ServerID;
+/** Brand the client's id for a file transfer, an integer from 0 to 65535. */
+export declare const asClientFileTransferID: (v: number) => ClientFileTransferID;
+/** Brand the server's id for a file transfer, an integer from 0 to 65535. */
+export declare const asServerFileTransferID: (v: number) => ServerFileTransferID;
+/** Brand a channel id, an integer from 0 to 2^64-1, from a number or a bigint. */
+export declare const asChannelID: (v: bigint | number) => ChannelID;
+/** Brand a client id, an integer from 0 to 65535: the voice protocol's width. */
+export declare const asClientID: (v: number) => ClientID;
+/** Brand a client database id, an integer from 0 to 2^64-1. */
+export declare const asClientDBID: (v: bigint | number) => ClientDBID;
+/** Brand a server group id, an integer from 0 to 2^64-1. */
+export declare const asServerGroupID: (v: bigint | number) => ServerGroupID;
+/** Brand a channel group id, an integer from 0 to 2^64-1. */
+export declare const asChannelGroupID: (v: bigint | number) => ChannelGroupID;
+/** Brand a permission id, an integer from 0 to 2^32-1. */
+export declare const asPermissionID: (v: number) => PermissionID;
+/**
+ * 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 declare const asIconID: (v: number) => IconID;
+/**
+ * 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 declare function parseIconID(raw: string | undefined): IconID | undefined;
+/**
+ * A unique identifier: `base64(SHA-1(publicKey))` on TeamSpeak 3 and
+ * `base64(SHA-256(publicKey))` on TeamSpeak 6.
+ *
+ * The length differs between versions, so treat it as opaque bytes rather than
+ * assuming either width.
+ */
+export type UID = string & {
+    readonly __brand: "UID";
+};
+/** Brand a unique identifier. */
+export declare const asUID: (v: string) => UID;
+/**
+ * A channel's unique identifier (`channel_unique_identifier`), which TS6
+ * gives every channel and TS3 does not send. Opaque text, and not a client's
+ * {@link UID}.
+ */
+export type ChannelUID = string & {
+    readonly __brand: "ChannelUID";
+};
+/** Brand a channel's unique identifier. */
+export declare const asChannelUID: (v: string) => ChannelUID;
+//# sourceMappingURL=ids.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../../../src/core/command/ids.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,yBAAyB;AACzB,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAAE,CAAC;AACnE;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAA;CAAE,CAAC;AACjE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAA;CAAE,CAAC;AACrE,+BAA+B;AAC/B,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;CAAE,CAAC;AAC3E,gCAAgC;AAChC,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAA;CAAE,CAAC;AAC7E,yFAAyF;AACzF,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAA;CAAE,CAAC;AACzE;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC;AAE7D,uBAAuB;AACvB,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAC3D,oCAAoC;AACpC,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAAE,CAAC;AACnE,mEAAmE;AACnE,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAA;CAAE,CAAC;AACjE,sFAAsF;AACtF,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAA;CAAE,CAAC;AACzF,2EAA2E;AAC3E,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAA;CAAE,CAAC;AA4BzF,8EAA8E;AAC9E,eAAO,MAAM,OAAO,MAAO,MAAM,GAAG,MAAM,KAAG,KAAuC,CAAC;AACrF,gEAAgE;AAChE,eAAO,MAAM,WAAW,MAAO,MAAM,GAAG,MAAM,KAAG,SACT,CAAC;AACzC,8DAA8D;AAC9D,eAAO,MAAM,UAAU,MAAO,MAAM,GAAG,MAAM,KAAG,QAAgD,CAAC;AACjG,6EAA6E;AAC7E,eAAO,MAAM,sBAAsB,MAAO,MAAM,KAAG,oBAC8B,CAAC;AAClF,6EAA6E;AAC7E,eAAO,MAAM,sBAAsB,MAAO,MAAM,KAAG,oBAC8B,CAAC;AAElF,kFAAkF;AAClF,eAAO,MAAM,WAAW,MAAO,MAAM,GAAG,MAAM,KAAG,SACT,CAAC;AACzC,iFAAiF;AACjF,eAAO,MAAM,UAAU,MAAO,MAAM,KAAG,QACgB,CAAC;AACxD,+DAA+D;AAC/D,eAAO,MAAM,YAAY,MAAO,MAAM,GAAG,MAAM,KAAG,UACD,CAAC;AAClD,4DAA4D;AAC5D,eAAO,MAAM,eAAe,MAAO,MAAM,GAAG,MAAM,KAAG,aACJ,CAAC;AAClD,6DAA6D;AAC7D,eAAO,MAAM,gBAAgB,MAAO,MAAM,GAAG,MAAM,KAAG,cACH,CAAC;AACpD,0DAA0D;AAC1D,eAAO,MAAM,cAAc,MAAO,MAAM,KAAG,YACoB,CAAC;AAChE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,MAAO,MAAM,KAAG,MAKpC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAMvE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAA;CAAE,CAAC;AACvD,iCAAiC;AACjC,eAAO,MAAM,KAAK,MAAO,MAAM,KAAG,GAAe,CAAC;AAElD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAA;CAAE,CAAC;AACrE,2CAA2C;AAC3C,eAAO,MAAM,YAAY,MAAO,MAAM,KAAG,UAA6B,CAAC"}