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

package/src/client/transport/handler.ts

@@ -435,6 +435,11 @@ export class PacketHandler {
   }
 
   /** How many packets have been sent again for want of an acknowledgement. */
+  /** Whether clientek, sent under the dummy key, has not been acknowledged yet. */
+  get clientEkPending(): boolean {
+    return this.#dummyCommandIDs.size > 0;
+  }
+
   get resends(): number {
     return this.#resends;
   }

package/src/client/types.ts

@@ -4,6 +4,7 @@ import type {
   ChannelSubscribedEvent,
   ChannelUnsubscribedEvent,
   ClientChannelGroupChangedEvent,
+  ClientChatClosedEvent,
   ClientChatComposingEvent,
   ClientID,
   ServerGroupID,
@@ -122,6 +123,11 @@ export interface EventMap extends ServerEventMap, SessionEventMap {
    * sends. Only the target receives it.
    */
   clientChatComposing: ClientChatComposingEvent;
+  /**
+   * A client closing its private chat with this client, which `closePrivateChat`
+   * sends. Only a client the sender has messaged privately is told.
+   */
+  clientChatClosed: ClientChatClosedEvent;
 }
 
 /**
@@ -251,6 +257,8 @@ const eventNameValues = {
   PluginCommand: "pluginCommand",
   /** A client typing a private message to this client. */
   ClientChatComposing: "clientChatComposing",
+  /** A client closing its private chat with this client. */
+  ClientChatClosed: "clientChatClosed",
   /** The view being complete; see `ServerView`. */
   ViewReady: "viewReady",
   /** The view changing; see `ServerView`. */
@@ -318,6 +326,7 @@ export type ServerEventName =
   | "channelUnsubscribed"
   | "pluginCommand"
   | "clientChatComposing"
+  | "clientChatClosed"
   | "poked"
   | "voiceData"
   | "notification";

package/src/client/view.ts

@@ -9,7 +9,6 @@ import {
   type ChannelEditedEvent,
   type ChannelID,
   type ChannelMovedEvent,
-  type ClientEnterEvent,
   type ClientEntry,
   type ChannelGroup,
   type ChannelGroupID,
@@ -186,7 +185,7 @@ export interface ServerView {
  * The clients a client knows, by id. Every change to it, whoever makes it, is
  * a change to the view, so it counts them.
  */
-export class Roster extends Map<number, ClientEnterEvent> {
+export class Roster extends Map<number, ClientEntry> {
   #changed: () => void = () => {};
 
   /** Call `changed` after each change from now on. */
@@ -194,7 +193,7 @@ export class Roster extends Map<number, ClientEnterEvent> {
     this.#changed = changed;
   }
 
-  override set(id: number, entry: ClientEnterEvent): this {
+  override set(id: number, entry: ClientEntry): this {
     super.set(id, entry);
     this.#changed();
     return this;

package/src/core/api/channels.ts

@@ -101,6 +101,10 @@ export interface ChannelSettings {
   readonly deleteDelayMs?: number | undefined;
   /** How the name is pronounced, for text-to-speech (`channel_name_phonetic`). */
   readonly namePhonetic?: string | undefined;
+  /** The URL of the channel's banner image (`channel_banner_gfx_url`); needs `b_channel_modify_banner`. */
+  readonly bannerURL?: string | undefined;
+  /** How the banner is scaled (`channel_banner_mode`); needs `b_channel_modify_banner`. */
+  readonly bannerMode?: number | undefined;
 }
 
 const settingNames: WireNames<ChannelSettings> = {
@@ -124,6 +128,8 @@ const settingNames: WireNames<ChannelSettings> = {
   isDefault: "channel_flag_default",
   deleteDelayMs: ["channel_delete_delay", inSeconds],
   namePhonetic: "channel_name_phonetic",
+  bannerURL: "channel_banner_gfx_url",
+  bannerMode: "channel_banner_mode",
 };
 
 /** A new channel's settings. Only `name` is required; see {@link ChannelSettings}. */
@@ -251,9 +257,9 @@ const listFlags: ReadonlyArray<readonly [string, true]> = [
  * All channels on the server, in the server's own sort order.
  *
  * Always asks for the topic, flags, voice, limits, icon, seconds empty and
- * banners, which a bare `channellist` leaves out. The last two are asked for
- * and not read: `Channel` has no field for them yet. `description` and `uid` are not part of
- * `channellist` and stay empty; `getChannelInfo` has them.
+ * banners, which a bare `channellist` leaves out. `description`, `uid` and
+ * `filePath` are not part of `channellist` and stay empty or undefined;
+ * `getChannelInfo` has them.
  */
 export async function listChannels(
   client: CommandExecutor,

package/src/core/api/clients.ts

@@ -22,6 +22,7 @@ import {
   str,
   big,
   num,
+  optNum,
   date,
 } from "./command.js";
 import type { PagingOptions, Params, PermissionEntry, WireNames } from "./command.js";
@@ -108,6 +109,11 @@ export interface ClientEntry {
    * the request (`client_talk_request`); any non-zero value is true. No flag.
    */
   readonly isRequestingTalk?: boolean | undefined;
+  /**
+   * When the client asked to talk (`client_talk_request`, a unix time; 0 on
+   * the wire when there is no request, which reads as undefined); no flag.
+   */
+  readonly talkRequestedAt?: Date | undefined;
   /** The message sent with a talk request (`client_talk_request_msg`); no flag. */
   readonly talkRequestMessage?: string | undefined;
   /** The client's description (`client_description`); no flag. */
@@ -116,7 +122,7 @@ export interface ClientEntry {
   readonly metaData?: string | undefined;
   /** The MD5 of the client's avatar (`client_flag_avatar`); "" for none; no flag. */
   readonly avatar?: string | undefined;
-  /** The client's icon (`client_icon_id`); undefined for none as well as for absent; no flag. */
+  /** The client's icon (`client_icon_id`), with `icon`; undefined for none as well as for absent. */
   readonly iconID?: IconID | undefined;
   /** How the nickname is pronounced (`client_nickname_phonetic`); no flag. */
   readonly nicknamePhonetic?: string | undefined;
@@ -178,6 +184,11 @@ export function applyClientChanges(entry: ClientEntry, changes: ClientChanges):
   for (const [key, value] of Object.entries(changes)) {
     if (value !== undefined) next[key] = value;
   }
+  // A withdrawn request is a 0 on the wire, which reads as no time and so is
+  // never in `changes`; the flag going false is what says so.
+  if (changes.isRequestingTalk === false && !("talkRequestedAt" in changes)) {
+    delete next["talkRequestedAt"];
+  }
   return next as unknown as ClientEntry;
 }
 
@@ -205,6 +216,8 @@ export interface ClientListOptions extends CommandOptions {
   readonly ip?: boolean | undefined;
   /** The client's badges (`-badges`). */
   readonly badges?: boolean | undefined;
+  /** The client's icon (`-icon`), which fills `ClientEntry.iconID`. */
+  readonly icon?: boolean | undefined;
 }
 
 const listFlags: WireNames<ClientListOptions> = {
@@ -217,6 +230,7 @@ const listFlags: WireNames<ClientListOptions> = {
   country: "-country",
   ip: "-ip",
   badges: "-badges",
+  icon: "-icon",
 };
 
 /** Every client currently connected. */
@@ -723,6 +737,37 @@ export async function getClientUIDByID(
   return asUID(str(firstRow(rows, "clientgetuidfromclid", "cluid"), "cluid"));
 }
 
+/** What `clientgetuidfromclid` says about a connected client. */
+export interface ClientUIDInfo {
+  /** The client's id (`clid`). */
+  readonly clientID: ClientID;
+  /** The client's unique identifier (`cluid`). */
+  readonly uid: UID;
+  /** The client's nickname (`nickname`). */
+  readonly nickname: string;
+  /** The client's myTeamSpeak id (`mytsid`); "" for none, as TS3 3.13.8 and TS6 6.0.0-beta13.1 sent it for a client without one. */
+  readonly mytsid: string;
+}
+
+/**
+ * The uid, nickname and myTeamSpeak id of a connected client.
+ * {@link getClientUIDByID} is the same command, keeping only the uid.
+ */
+export async function getClientUIDInfoByID(
+  client: CommandExecutor,
+  clid: ClientID,
+  options?: CommandOptions,
+): Promise<ClientUIDInfo> {
+  const rows = await query(client, "clientgetuidfromclid", [["clid", clid]], options);
+  const row = firstRow(rows, "clientgetuidfromclid", "cluid");
+  return {
+    clientID: asClientID(uint(row, "clid", U16)),
+    uid: asUID(str(row, "cluid")),
+    nickname: str(row, "nickname"),
+    mytsid: str(row, "mytsid"),
+  };
+}
+
 /** The persistent database id behind a uid. */
 export async function getClientDBIDByUID(
   client: CommandExecutor,
@@ -739,10 +784,16 @@ export interface ClientDatabaseName {
   readonly databaseID: ClientDBID;
   /** The nickname the client last used. */
   readonly name: string;
+  /** The client's unique identifier (`cluid`); "" when the server sent none. */
+  readonly uid: UID;
 }
 
 function parseDatabaseName(row: Record<string, string>): ClientDatabaseName {
-  return { databaseID: asClientDBID(big(row, "cldbid")), name: str(row, "name") };
+  return {
+    databaseID: asClientDBID(big(row, "cldbid")),
+    name: str(row, "name"),
+    uid: asUID(str(row, "cluid")),
+  };
 }
 
 /** The database id and nickname recorded for a database id. */
@@ -805,8 +856,22 @@ export interface ClientDatabaseEntry {
   readonly description: string;
   /** The address the client last connected from. */
   readonly lastIP: string;
+  /** The client's query account name (`client_login_name`); "" for none; `clientdblist` rows only. */
+  readonly loginName?: string | undefined;
+  /** The MD5 of the client's avatar (`client_flag_avatar`), "" for none; `getClientDatabaseInfo` only. */
+  readonly avatarHash?: string | undefined;
+  /** Bytes the client has uploaded in all (`client_total_bytes_uploaded`); `getClientDatabaseInfo` only. */
+  readonly totalBytesUploaded?: number | undefined;
+  /** Bytes the client has downloaded in all (`client_total_bytes_downloaded`); `getClientDatabaseInfo` only. */
+  readonly totalBytesDownloaded?: number | undefined;
+  /** Bytes the client has uploaded this month (`client_month_bytes_uploaded`); `getClientDatabaseInfo` only. */
+  readonly monthBytesUploaded?: number | undefined;
+  /** Bytes the client has downloaded this month (`client_month_bytes_downloaded`); `getClientDatabaseInfo` only. */
+  readonly monthBytesDownloaded?: number | undefined;
 }
 
+const optStr = (row: Record<string, string>, key: string): string | undefined => row[key];
+
 const parseDatabaseEntry = (row: Record<string, string>): ClientDatabaseEntry => ({
   databaseID: asClientDBID(big(row, "cldbid")),
   uid: asUID(str(row, "client_unique_identifier")),
@@ -816,6 +881,12 @@ const parseDatabaseEntry = (row: Record<string, string>): ClientDatabaseEntry =>
   totalConnections: num(row, "client_totalconnections"),
   description: str(row, "client_description"),
   lastIP: str(row, "client_lastip"),
+  loginName: optStr(row, "client_login_name"),
+  avatarHash: optStr(row, "client_flag_avatar"),
+  totalBytesUploaded: optNum(row, "client_total_bytes_uploaded"),
+  totalBytesDownloaded: optNum(row, "client_total_bytes_downloaded"),
+  monthBytesUploaded: optNum(row, "client_month_bytes_uploaded"),
+  monthBytesDownloaded: optNum(row, "client_month_bytes_downloaded"),
 });
 
 /** Which slice of the client database {@link listClientDatabase} reads. */

package/src/core/api/command.ts

@@ -367,7 +367,7 @@ const date = (row: Record<string, string>, key: string): Date | undefined => {
 const durationMs = (row: Record<string, string>, key: string, unitMs: number): number =>
   num(row, key) * unitMs;
 
-export { str, big, num, uint, U16, U32, bool, icon, date, durationMs };
+export { str, big, num, optNum, uint, U16, U32, bool, icon, date, durationMs };
 
 // ---- Read tables ------------------------------------------------------------
 
@@ -611,6 +611,21 @@ export interface Channel {
   readonly bannerURL?: string | undefined;
   /** How the banner is scaled (`channel_banner_mode`). */
   readonly bannerMode?: number | undefined;
+  /**
+   * How long the channel has had no client, in milliseconds (`seconds_empty`,
+   * which the wire carries in seconds), as of the answer. Undefined for a
+   * channel with a client in it: both TS3 3.13.8 and TS6 6.0.0-beta13.1 send
+   * -1 for it, which is not a duration. `listChannels` and `getChannelInfo`
+   * report it; a notification never does.
+   */
+  readonly emptyForMs?: number | undefined;
+  /**
+   * The channel's file storage quota (`channel_storage_quota`); TS6 only.
+   * TS6 6.0.0-beta13.1 sent 4294967295 for a channel with none set.
+   */
+  readonly storageQuota?: number | undefined;
+  /** The channel's directory on the server (`channel_filepath`); `getChannelInfo` only. */
+  readonly filePath?: string | undefined;
 }
 
 /**
@@ -681,6 +696,12 @@ export const channelFields: {
   isForcedSilence: { keys: ["channel_forced_silence"], read: bool },
   bannerURL: { keys: ["channel_banner_gfx_url"], read: str },
   bannerMode: { keys: ["channel_banner_mode"], read: num },
+  emptyForMs: {
+    keys: ["seconds_empty"],
+    read: (row, key) => (num(row, key) < 0 ? undefined : durationMs(row, key, SECOND)),
+  },
+  storageQuota: { keys: ["channel_storage_quota"], read: num },
+  filePath: { keys: ["channel_filepath"], read: str },
 };
 
 function parseChannel(row: Record<string, string>): Channel {

package/src/core/api/instance.ts

@@ -60,6 +60,14 @@ export interface VirtualServer {
   readonly machineID: string | undefined;
   /** Its unique identifier, with `uid`; "" otherwise (`virtualserver_unique_identifier`). */
   readonly uid: string;
+  /** Its UUID, with `uid`; TS6 only (`virtualserver_uuid`). */
+  readonly uuid?: string | undefined;
+  /** Whether guests may create channels; TS6 only (`guest_can_create_channels`). */
+  readonly guestCanCreateChannels?: boolean | undefined;
+  /** Whether guests may create a homebase; TS6 only (`guest_can_create_homebase`). */
+  readonly guestCanCreateHomebase?: boolean | undefined;
+  /** Whether the server is on the public server list; TS6 only (`virtualserver_weblist_enabled`). */
+  readonly weblistEnabled?: boolean | undefined;
 }
 
 const optional = <T>(row: Record<string, string>, key: string, read: () => T): T | undefined =>
@@ -83,6 +91,16 @@ const parseVirtualServer = (row: Record<string, string>): VirtualServer => ({
   autoStart: optional(row, "virtualserver_autostart", () => bool(row, "virtualserver_autostart")),
   machineID: row["virtualserver_machine_id"],
   uid: str(row, "virtualserver_unique_identifier"),
+  uuid: row["virtualserver_uuid"],
+  guestCanCreateChannels: optional(row, "guest_can_create_channels", () =>
+    bool(row, "guest_can_create_channels"),
+  ),
+  guestCanCreateHomebase: optional(row, "guest_can_create_homebase", () =>
+    bool(row, "guest_can_create_homebase"),
+  ),
+  weblistEnabled: optional(row, "virtualserver_weblist_enabled", () =>
+    bool(row, "virtualserver_weblist_enabled"),
+  ),
 });
 
 /** Which servers {@link listServers} reports, and with what. */
@@ -109,8 +127,8 @@ const serverListFlags: WireNames<ServerListOptions> = {
  *
  * Needs `b_serverinstance_virtualserver_list`, which a voice client's Server
  * Admin lacks (error 2568). TS6 also reports `guest_can_create_channels`,
- * `guest_can_create_homebase` and `virtualserver_weblist_enabled`, which are
- * not read here.
+ * `guest_can_create_homebase` and `virtualserver_weblist_enabled`, and its
+ * UUID with `uid`; TS3 sends none of them.
  */
 export async function listServers(
   client: CommandExecutor,

package/src/core/api/moderation.ts

@@ -247,6 +247,13 @@ export async function addBan(
  * uid, and on TS6 its myTeamSpeak id — and over ServerQuery answers one
  * `banid` row for each; returning the first left the others to be found by
  * hand. The voice protocol reports no ids, so there this resolves to `[]`.
+ *
+ * Measured on TS3 3.13.8 and TS6 beta13.1: two bans, one for the uid and one
+ * for the address. TS6 has also answered with no `banid` at all though both
+ * bans were made (about once in a hundred calls over SSH and WebQuery), so an
+ * empty result does not mean no ban. A caller that must undo the ban lists the
+ * bans before and after and removes what is new: a ban on the address refuses
+ * every later connection from it.
  */
 export async function banClient(
   client: CommandExecutor,

package/src/core/api/parse.ts

@@ -89,6 +89,7 @@ export const clientFields: {
   talkPower: { keys: ["client_talk_power"], read: num },
   // The wire value is when the request was made; any non-zero is a request.
   isRequestingTalk: flag("client_talk_request"),
+  talkRequestedAt: { keys: ["client_talk_request"], read: date },
   talkRequestMessage: text("client_talk_request_msg"),
   description: text("client_description"),
   metaData: text("client_meta_data"),

package/src/core/api/server.ts

@@ -250,6 +250,10 @@ export interface WhoAmI {
    * it.
    */
   readonly uid: UID;
+  /** The virtual server's UUID (`virtualserver_uuid`); TS6 only, undefined when not sent. */
+  readonly serverUUID?: string | undefined;
+  /** The server this client first connected to (`client_origin_server_id`); 0 when not sent. */
+  readonly originServerID: ServerID;
 }
 
 /** Which server and client this connection is, as the server sees it. */
@@ -266,6 +270,8 @@ export async function whoAmI(client: CommandExecutor, options?: CommandOptions):
     databaseID: asClientDBID(big(row, "client_database_id")),
     loginName: str(row, "client_login_name"),
     uid: asUID(str(row, "client_unique_identifier")),
+    serverUUID: row["virtualserver_uuid"],
+    originServerID: asServerID(big(row, "client_origin_server_id")),
   };
 }
 
@@ -674,6 +680,11 @@ export interface TempPassword {
   readonly endsAt: Date | undefined;
   /** The channel a client joining with it lands in, or 0 for the default channel. */
   readonly targetChannelID: ChannelID;
+  /**
+   * That channel's password, in cleartext (`tcpw`); "" for none. A secret like
+   * `password`: store it where it is needed, and do not log it.
+   */
+  readonly targetChannelPassword: string;
 }
 
 /** The server's temporary passwords. */
@@ -690,6 +701,7 @@ export async function listTempPasswords(
     startsAt: date(row, "start"),
     endsAt: date(row, "end"),
     targetChannelID: asChannelID(big(row, "tcid")),
+    targetChannelPassword: str(row, "tcpw"),
   }));
 }
 

package/src/core/command/responses.ts

@@ -88,6 +88,7 @@ const fileTransfer = (answer: string): ResponseSpec => ({
 export const RESPONSES: Readonly<Record<string, ResponseSpec>> = {
   apikeyadd: inline("notifyapikeyadd"),
   apikeylist: inline("notifyapikeylist"),
+  banfind: inline("notifybanfind"),
   banlist: inline("notifybanlist"),
   channelclientpermlist: inline("notifychannelclientpermlist"),
   channelcreate: { notifications: ["notifychannelcreated"], ownRowsOnly: true },

package/src/core/events.ts

@@ -44,6 +44,11 @@ export interface ClientMovedEvent {
   readonly invokerUID: UID;
   /** The channel the client is now in. */
   readonly targetChannelID: ChannelID;
+  /**
+   * The channel the client came from (`cfid`). Absent when the server sends
+   * none: TS3 3.13.8 sends no `cfid` on a move, TS6 6.0.0-beta13.1 does.
+   */
+  readonly fromChannelID?: ChannelID | undefined;
   /** Why the client moved; compare it with `Reason`. */
   readonly reason: number;
   /** The message that came with the move, such as a channel kick's reason; "" when none. */
@@ -65,6 +70,16 @@ export interface ClientLeaveEvent {
   readonly reason: number;
   /** The client that left. */
   readonly clientID: ClientID;
+  /**
+   * The channel the client was in (`cfid`); absent when the server sent none.
+   * Both servers sent it on every leave measured.
+   */
+  readonly fromChannelID?: ChannelID | undefined;
+  /**
+   * The channel the client went to (`ctid`), named as on the move event; 0
+   * when it left the server, and absent when the server sent none.
+   */
+  readonly targetChannelID?: ChannelID | undefined;
   /** Who kicked or banned the client; empty otherwise. */
   readonly invokerName: string;
   /** The kicker's unique identifier; empty unless kicked or banned. */
@@ -96,12 +111,28 @@ export interface KickedEvent {
 }
 
 /**
- * A client coming into view: the same record `listClients` returns, so one
- * type describes a client however it was learned of; its own id is `id`, as
- * in every record. The fields only `clientlist -times` reports are undefined
- * here.
+ * A client coming into view: the record `listClients` returns, so one type
+ * describes a client however it was learned of, with what only the
+ * notification says. Its own id is `id`, as in every record. The fields only
+ * `clientlist -times` reports are undefined here.
+ *
+ * `fromChannelID` and `reason` belong to the event: the roster and
+ * `view.clients` keep the record without them.
  */
-export type ClientEnterEvent = ClientEntry;
+export interface ClientEnterEvent extends ClientEntry {
+  /**
+   * The channel the client came from (`cfid`); 0 for a client that joined the
+   * server, and absent when the server sent none. Measured on TS3 3.13.8 and
+   * TS6 6.0.0-beta13.1: 0 on a join and on a client listed by a subscription.
+   */
+  readonly fromChannelID?: ChannelID | undefined;
+  /**
+   * Why the client came into view (`reasonid`); compare it with `Reason`.
+   * Measured on both servers: 0 on a join, 2 (`Reason.Subscription`) for a
+   * client that was already there and came into view by a subscription.
+   */
+  readonly reason?: number | undefined;
+}
 
 /** This client being poked. */
 export interface PokeEvent {
@@ -311,6 +342,18 @@ export interface ClientChatComposingEvent {
   readonly uid: UID;
 }
 
+/**
+ * A client closed its private chat with this client. It is delivered only to a
+ * client the sender has sent a private message to. Delivered by the voice
+ * client only.
+ */
+export interface ClientChatClosedEvent {
+  /** The client that closed the chat. */
+  readonly clientID: ClientID;
+  /** Its unique identifier. */
+  readonly uid: UID;
+}
+
 /** Audio from another client, in the channel or whispered. */
 export interface VoiceDataEvent {
   /** Who is speaking. */

package/src/core/index.ts

@@ -88,7 +88,7 @@ export { NotificationName } from "./notification-name.js";
 export { PropertyName } from "./property-name.js";
 export type { Permission } from "./permission.js";
 
-export { noopLogger, consoleLogger, ClientStatus } from "./types.js";
+export { noopLogger, consoleLogger, ClientStatus, serverFamilyForVersion } from "./types.js";
 export type {
   ClientVersion,
   Listener,
@@ -118,6 +118,7 @@ export type {
   ChannelUnsubscribedEvent,
   PluginCommandEvent,
   ClientChatComposingEvent,
+  ClientChatClosedEvent,
   ClientUpdatedEvent,
   ClientServerGroupEvent,
   ClientServerGroupAddedEvent,

package/src/core/notification-name.ts

@@ -17,8 +17,12 @@ const notificationNameValues = {
   APIKeyAdd: "notifyapikeyadd",
   /** `notifyapikeylist`: Reply to apikeylist: one row per API key. */
   APIKeyList: "notifyapikeylist",
+  /** `notifybanfind`: Reply to banfind: one row per ban rule that matches. */
+  BanFind: "notifybanfind",
   /** `notifybanlist`: Reply to banlist: one row per ban rule on the virtual server. */
   BanList: "notifybanlist",
+  /** `notifybanupdate`: A ban changed; sent to a ServerQuery connection registered for `bans`. An addition carries the ban row, a deletion its `banid`, a delete-all neither (TS6 6.0.0-beta13.1, `op` says which). */
+  BanUpdate: "notifybanupdate",
   /** `notifychannelchanged`: A channel's properties changed and this client should fetch them again. */
   ChannelChanged: "notifychannelchanged",
   /** `notifychannelclientpermlist`: Reply to channelclientpermlist: one row per permission set for a client in a channel. */