@honeybbq/teamspeak 0.0.1 → 1.0.0-beta.7

package/dist/core/property-name.js

@@ -0,0 +1,405 @@
+/**
+ * The properties a TeamSpeak server reports, by name: the keys of the records
+ * `getServerInfo`, `getInstanceInfo`, `getHostInfo` and `getClientProperties` return,
+ * and of the settings `editServer` and `editInstance` take:
+ *
+ * ```ts
+ * const info = await getServerInfo(client);
+ * console.log(info[PropertyName.VirtualServerName]);
+ * ```
+ *
+ * They are grouped by the command that reports them, and a property that
+ * several report is listed under the first. These are the names measured on
+ * TeamSpeak 3.13 and 6; the ones marked TeamSpeak 3 only or TeamSpeak 6 only
+ * are missing on the other. A server may send keys this table does not name.
+ */
+const propertyNameValues = {
+    // Virtual server: serverinfo, and serveredit for those marked editable.
+    /** `virtualserver_unique_identifier`: The server's unique id, a base64 string that stays the same when the server moves. */
+    VirtualServerUniqueIdentifier: "virtualserver_unique_identifier",
+    /** `virtualserver_name`: The name of the virtual server. Editable. */
+    VirtualServerName: "virtualserver_name",
+    /** `virtualserver_welcomemessage`: The welcome message of the server. Editable. */
+    VirtualServerWelcomeMessage: "virtualserver_welcomemessage",
+    /** `virtualserver_platform`: Operating system the server runs on, such as Linux. */
+    VirtualServerPlatform: "virtualserver_platform",
+    /** `virtualserver_version`: Server version and build, for example 3.13.8 [Build: 1779874471]. */
+    VirtualServerVersion: "virtualserver_version",
+    /** `virtualserver_maxclients`: The maximum number of clients to allow. Editable. */
+    VirtualServerMaxClients: "virtualserver_maxclients",
+    /** `virtualserver_password`: The password required to enter. Editable. */
+    VirtualServerPassword: "virtualserver_password",
+    /** `virtualserver_clientsonline`: Number of clients online, voice and ServerQuery clients together. */
+    VirtualServerClientsOnline: "virtualserver_clientsonline",
+    /** `virtualserver_channelsonline`: Number of channels on the server. */
+    VirtualServerChannelsOnline: "virtualserver_channelsonline",
+    /** `virtualserver_created`: When the virtual server was created, as a Unix timestamp in seconds. */
+    VirtualServerCreated: "virtualserver_created",
+    /** `virtualserver_uptime`: Seconds since the virtual server started. */
+    VirtualServerUptime: "virtualserver_uptime",
+    /** `virtualserver_codec_encryption_mode`: The global codec encryption mode of the virtual server. Editable. */
+    VirtualServerCodecEncryptionMode: "virtualserver_codec_encryption_mode",
+    /** `virtualserver_hostmessage`: The host message of the server. Editable. */
+    VirtualServerHostMessage: "virtualserver_hostmessage",
+    /** `virtualserver_hostmessage_mode`: The host message mode of the server (0 for None, 1 for message in chatlog, 2 for message as a modal, 3 for modal dialog and then quit). Editable. */
+    VirtualServerHostMessageMode: "virtualserver_hostmessage_mode",
+    /** `virtualserver_filebase`: Path of the server's file storage, relative to the server's working directory. */
+    VirtualServerFileBase: "virtualserver_filebase",
+    /** `virtualserver_default_server_group`: The default server group to use. Editable. */
+    VirtualServerDefaultServerGroup: "virtualserver_default_server_group",
+    /** `virtualserver_default_channel_group`: The default channel group to use. Editable. */
+    VirtualServerDefaultChannelGroup: "virtualserver_default_channel_group",
+    /** `virtualserver_flag_password`: 1 if the server has a password, 0 if it does not. */
+    VirtualServerFlagPassword: "virtualserver_flag_password",
+    /** `virtualserver_default_channel_admin_group`: The default channel administrator group to use. Editable. */
+    VirtualServerDefaultChannelAdminGroup: "virtualserver_default_channel_admin_group",
+    /** `virtualserver_max_download_total_bandwidth`: The max bandwidth for outgoing file transfers on the virtual server (Bytes/s). Editable. */
+    VirtualServerMaxDownloadTotalBandwidth: "virtualserver_max_download_total_bandwidth",
+    /** `virtualserver_max_upload_total_bandwidth`: The max bandwidth for incoming file transfers on the virtual server (Bytes/s). Editable. */
+    VirtualServerMaxUploadTotalBandwidth: "virtualserver_max_upload_total_bandwidth",
+    /** `virtualserver_hostbanner_url`: URL for the host banner. Editable. */
+    VirtualServerHostBannerURL: "virtualserver_hostbanner_url",
+    /** `virtualserver_hostbanner_gfx_url`: URL for the host banner image. Editable. */
+    VirtualServerHostBannerGFXURL: "virtualserver_hostbanner_gfx_url",
+    /** `virtualserver_hostbanner_gfx_interval`: Refresh time for the host banner image on the client side (in seconds). Editable. */
+    VirtualServerHostBannerGFXInterval: "virtualserver_hostbanner_gfx_interval",
+    /** `virtualserver_complain_autoban_count`: The number of complaints about a client we will tolerate before a ban. Editable. */
+    VirtualServerComplainAutoBanCount: "virtualserver_complain_autoban_count",
+    /** `virtualserver_complain_autoban_time`: The amount of time (in seconds) an autobanned client will be banned for. Editable. */
+    VirtualServerComplainAutoBanTime: "virtualserver_complain_autoban_time",
+    /** `virtualserver_complain_remove_time`: The amount of time (in seconds) before a complaint is deleted automatically. Editable. */
+    VirtualServerComplainRemoveTime: "virtualserver_complain_remove_time",
+    /** `virtualserver_min_clients_in_channel_before_forced_silence`: Number of clients in the same channel needed to force silence. Editable. */
+    VirtualServerMinClientsInChannelBeforeForcedSilence: "virtualserver_min_clients_in_channel_before_forced_silence",
+    /** `virtualserver_priority_speaker_dimm_modificator`: Client volume lowered automatically while a priority speaker is talking. Editable. */
+    VirtualServerPrioritySpeakerDimmModificator: "virtualserver_priority_speaker_dimm_modificator",
+    /** `virtualserver_id`: The virtual server's id, as used by use sid=. */
+    VirtualServerID: "virtualserver_id",
+    /** `virtualserver_antiflood_points_tick_reduce`: Anti-flood points removed from a client for being good. Editable. */
+    VirtualServerAntiFloodPointsTickReduce: "virtualserver_antiflood_points_tick_reduce",
+    /** `virtualserver_antiflood_points_needed_command_block`: Anti-flood points needed to block commands being executed by the client. Editable. */
+    VirtualServerAntiFloodPointsNeededCommandBlock: "virtualserver_antiflood_points_needed_command_block",
+    /** `virtualserver_antiflood_points_needed_ip_block`: Anti-flood points needed to block incoming connections from the client. Editable. */
+    VirtualServerAntiFloodPointsNeededIPBlock: "virtualserver_antiflood_points_needed_ip_block",
+    /** `virtualserver_client_connections`: Number of voice client connections made since the server started. */
+    VirtualServerClientConnections: "virtualserver_client_connections",
+    /** `virtualserver_query_client_connections`: Number of ServerQuery connections made since the server started. */
+    VirtualServerQueryClientConnections: "virtualserver_query_client_connections",
+    /** `virtualserver_hostbutton_tooltip`: Text used for the tooltip of the host button on client-side. Editable. */
+    VirtualServerHostButtonTooltip: "virtualserver_hostbutton_tooltip",
+    /** `virtualserver_hostbutton_url`: URL opened on click on the host button. Editable. */
+    VirtualServerHostButtonURL: "virtualserver_hostbutton_url",
+    /** `virtualserver_hostbutton_gfx_url`: URL for the host button on client-side. Editable. */
+    VirtualServerHostButtonGFXURL: "virtualserver_hostbutton_gfx_url",
+    /** `virtualserver_queryclientsonline`: Number of ServerQuery clients online. */
+    VirtualServerQueryClientsOnline: "virtualserver_queryclientsonline",
+    /** `virtualserver_download_quota`: Download quota for the virtual server (MByte). Editable. */
+    VirtualServerDownloadQuota: "virtualserver_download_quota",
+    /** `virtualserver_upload_quota`: Upload quota for the virtual server (MByte). Editable. */
+    VirtualServerUploadQuota: "virtualserver_upload_quota",
+    /** `virtualserver_month_bytes_downloaded`: Bytes of file transfer downloads this month. */
+    VirtualServerMonthBytesDownloaded: "virtualserver_month_bytes_downloaded",
+    /** `virtualserver_month_bytes_uploaded`: Bytes of file transfer uploads this month. */
+    VirtualServerMonthBytesUploaded: "virtualserver_month_bytes_uploaded",
+    /** `virtualserver_total_bytes_downloaded`: Bytes of file transfer downloads in total. */
+    VirtualServerTotalBytesDownloaded: "virtualserver_total_bytes_downloaded",
+    /** `virtualserver_total_bytes_uploaded`: Bytes of file transfer uploads in total. */
+    VirtualServerTotalBytesUploaded: "virtualserver_total_bytes_uploaded",
+    /** `virtualserver_port`: UDP port the virtual server is listening on. Editable. */
+    VirtualServerPort: "virtualserver_port",
+    /** `virtualserver_autostart`: 1 if started automatically with the instance, or 0 otherwise. Editable. */
+    VirtualServerAutoStart: "virtualserver_autostart",
+    /** `virtualserver_machine_id`: Machine id that tells servers on one machine apart when they share a database; empty if unset. */
+    VirtualServerMachineID: "virtualserver_machine_id",
+    /** `virtualserver_needed_identity_security_level`: Minimum client identity security level required to connect to the virtual server. Editable. */
+    VirtualServerNeededIdentitySecurityLevel: "virtualserver_needed_identity_security_level",
+    /** `virtualserver_log_client`: Indicates whether the server logs events related to clients or not. Editable. */
+    VirtualServerLogClient: "virtualserver_log_client",
+    /** `virtualserver_log_query`: Indicates whether the server logs events related to ServerQuery clients or not. Editable. */
+    VirtualServerLogQuery: "virtualserver_log_query",
+    /** `virtualserver_log_channel`: Indicates whether the server logs events related to channels or not. Editable. */
+    VirtualServerLogChannel: "virtualserver_log_channel",
+    /** `virtualserver_log_permissions`: Indicates whether the server logs events related to permissions or not. Editable. */
+    VirtualServerLogPermissions: "virtualserver_log_permissions",
+    /** `virtualserver_log_server`: Indicates whether the server logs events related to server changes or not. Editable. */
+    VirtualServerLogServer: "virtualserver_log_server",
+    /** `virtualserver_log_filetransfer`: Indicates whether the server logs events related to file transfers or not. Editable. */
+    VirtualServerLogFileTransfer: "virtualserver_log_filetransfer",
+    /** `virtualserver_min_client_version`: Minimal desktop client version required to connect (a build number). Editable. */
+    VirtualServerMinClientVersion: "virtualserver_min_client_version",
+    /** `virtualserver_name_phonetic`: Phonetic name of the virtual server. Editable. */
+    VirtualServerNamePhonetic: "virtualserver_name_phonetic",
+    /** `virtualserver_icon_id`: CRC32 checksum of the virtual server icon. Editable. */
+    VirtualServerIconID: "virtualserver_icon_id",
+    /** `virtualserver_reserved_slots`: Number of reserved slots available on the virtual server. Editable. */
+    VirtualServerReservedSlots: "virtualserver_reserved_slots",
+    /** `virtualserver_total_packetloss_speech`: Average packet loss of voice packets, as a fraction between 0 and 1. */
+    VirtualServerTotalPacketLossSpeech: "virtualserver_total_packetloss_speech",
+    /** `virtualserver_total_packetloss_keepalive`: Average packet loss of keepalive packets, as a fraction between 0 and 1. */
+    VirtualServerTotalPacketLossKeepAlive: "virtualserver_total_packetloss_keepalive",
+    /** `virtualserver_total_packetloss_control`: Average packet loss of control packets, as a fraction between 0 and 1. */
+    VirtualServerTotalPacketLossControl: "virtualserver_total_packetloss_control",
+    /** `virtualserver_total_packetloss_total`: Average packet loss over all packets, as a fraction between 0 and 1. */
+    VirtualServerTotalPacketLossTotal: "virtualserver_total_packetloss_total",
+    /** `virtualserver_total_ping`: Average ping of all clients, in milliseconds. */
+    VirtualServerTotalPing: "virtualserver_total_ping",
+    /** `virtualserver_ip`: IP addresses the virtual server listens on, separated by commas. */
+    VirtualServerIP: "virtualserver_ip",
+    /** `virtualserver_weblist_enabled`: Indicates whether the server appears in the global web server list or not. Editable. */
+    VirtualServerWebListEnabled: "virtualserver_weblist_enabled",
+    /** `virtualserver_ask_for_privilegekey`: 1 if clients are asked for a privilege key on their first connection to an unclaimed server, 0 if not. */
+    VirtualServerAskForPrivilegeKey: "virtualserver_ask_for_privilegekey",
+    /** `virtualserver_hostbanner_mode`: The display mode for the virtual servers hostbanner. Editable. */
+    VirtualServerHostBannerMode: "virtualserver_hostbanner_mode",
+    /** `virtualserver_channel_temp_delete_delay_default`: Default delay, in seconds, before an empty temporary channel is deleted. */
+    VirtualServerChannelTempDeleteDelayDefault: "virtualserver_channel_temp_delete_delay_default",
+    /** `virtualserver_min_android_version`: Minimal Android client version required to connect. Editable. */
+    VirtualServerMinAndroidVersion: "virtualserver_min_android_version",
+    /** `virtualserver_min_ios_version`: Minimal iOS client version required to connect. Editable. */
+    VirtualServerMinIOSVersion: "virtualserver_min_ios_version",
+    /** `virtualserver_nickname`: Nickname the server uses when it speaks, for example in server messages; empty uses the default. */
+    VirtualServerNickname: "virtualserver_nickname",
+    /** `virtualserver_antiflood_points_needed_plugin_block`: Anti-flood points needed to block plugin commands from the client; if set to 0, the same as virtualserver_antiflood_points_needed_command_block is used. Editable. */
+    VirtualServerAntiFloodPointsNeededPluginBlock: "virtualserver_antiflood_points_needed_plugin_block",
+    /** `virtualserver_capability_extensions`: Optional protocol features the server supports, separated by commas. */
+    VirtualServerCapabilityExtensions: "virtualserver_capability_extensions",
+    /** `virtualserver_file_storage_class`: Storage backend of the server's files; empty for the local disk. TeamSpeak 3 only. */
+    VirtualServerFileStorageClass: "virtualserver_file_storage_class",
+    /** `virtualserver_status`: Status of the virtual server (online | virtual online | offline | booting up | shutting down). Editable. */
+    VirtualServerStatus: "virtualserver_status",
+    /** `connection_filetransfer_bandwidth_sent`: Current file transfer upload speed, in bytes per second. Also in hostinfo and clientinfo. */
+    ConnectionFileTransferBandwidthSent: "connection_filetransfer_bandwidth_sent",
+    /** `connection_filetransfer_bandwidth_received`: Current file transfer download speed, in bytes per second. Also in hostinfo and clientinfo. */
+    ConnectionFileTransferBandwidthReceived: "connection_filetransfer_bandwidth_received",
+    /** `connection_filetransfer_bytes_sent_total`: Total bytes sent by file transfers since the server started. Also in hostinfo. */
+    ConnectionFileTransferBytesSentTotal: "connection_filetransfer_bytes_sent_total",
+    /** `connection_filetransfer_bytes_received_total`: Total bytes received by file transfers since the server started. Also in hostinfo. */
+    ConnectionFileTransferBytesReceivedTotal: "connection_filetransfer_bytes_received_total",
+    /** `connection_packets_sent_speech`: Voice packets sent since the server started. */
+    ConnectionPacketsSentSpeech: "connection_packets_sent_speech",
+    /** `connection_bytes_sent_speech`: Bytes of voice packets sent since the server started. */
+    ConnectionBytesSentSpeech: "connection_bytes_sent_speech",
+    /** `connection_packets_received_speech`: Voice packets received since the server started. */
+    ConnectionPacketsReceivedSpeech: "connection_packets_received_speech",
+    /** `connection_bytes_received_speech`: Bytes of voice packets received since the server started. */
+    ConnectionBytesReceivedSpeech: "connection_bytes_received_speech",
+    /** `connection_packets_sent_keepalive`: Keepalive packets sent since the server started. */
+    ConnectionPacketsSentKeepAlive: "connection_packets_sent_keepalive",
+    /** `connection_bytes_sent_keepalive`: Bytes of keepalive packets sent since the server started. */
+    ConnectionBytesSentKeepAlive: "connection_bytes_sent_keepalive",
+    /** `connection_packets_received_keepalive`: Keepalive packets received since the server started. */
+    ConnectionPacketsReceivedKeepAlive: "connection_packets_received_keepalive",
+    /** `connection_bytes_received_keepalive`: Bytes of keepalive packets received since the server started. */
+    ConnectionBytesReceivedKeepAlive: "connection_bytes_received_keepalive",
+    /** `connection_packets_sent_control`: Control (command) packets sent since the server started. */
+    ConnectionPacketsSentControl: "connection_packets_sent_control",
+    /** `connection_bytes_sent_control`: Bytes of control packets sent since the server started. */
+    ConnectionBytesSentControl: "connection_bytes_sent_control",
+    /** `connection_packets_received_control`: Control packets received since the server started. */
+    ConnectionPacketsReceivedControl: "connection_packets_received_control",
+    /** `connection_bytes_received_control`: Bytes of control packets received since the server started. */
+    ConnectionBytesReceivedControl: "connection_bytes_received_control",
+    /** `connection_packets_sent_total`: All packets sent since the server started. Also in hostinfo and clientinfo. */
+    ConnectionPacketsSentTotal: "connection_packets_sent_total",
+    /** `connection_bytes_sent_total`: All bytes sent since the server started. Also in hostinfo and clientinfo. */
+    ConnectionBytesSentTotal: "connection_bytes_sent_total",
+    /** `connection_packets_received_total`: All packets received since the server started. Also in hostinfo and clientinfo. */
+    ConnectionPacketsReceivedTotal: "connection_packets_received_total",
+    /** `connection_bytes_received_total`: All bytes received since the server started. Also in hostinfo and clientinfo. */
+    ConnectionBytesReceivedTotal: "connection_bytes_received_total",
+    /** `connection_bandwidth_sent_last_second_total`: Bytes per second sent, averaged over the last second. Also in hostinfo and clientinfo. */
+    ConnectionBandwidthSentLastSecondTotal: "connection_bandwidth_sent_last_second_total",
+    /** `connection_bandwidth_sent_last_minute_total`: Bytes per second sent, averaged over the last minute. Also in hostinfo and clientinfo. */
+    ConnectionBandwidthSentLastMinuteTotal: "connection_bandwidth_sent_last_minute_total",
+    /** `connection_bandwidth_received_last_second_total`: Bytes per second received, averaged over the last second. Also in hostinfo and clientinfo. */
+    ConnectionBandwidthReceivedLastSecondTotal: "connection_bandwidth_received_last_second_total",
+    /** `connection_bandwidth_received_last_minute_total`: Bytes per second received, averaged over the last minute. Also in hostinfo and clientinfo. */
+    ConnectionBandwidthReceivedLastMinuteTotal: "connection_bandwidth_received_last_minute_total",
+    /** `virtualserver_address`: Public address of the server. TeamSpeak 6 only. */
+    VirtualServerAddress: "virtualserver_address",
+    /** `virtualserver_administrative_domain`: Administrative domain of the server. TeamSpeak 6 only. */
+    VirtualServerAdministrativeDomain: "virtualserver_administrative_domain",
+    /** `virtualserver_canonical_name`: Canonical name of the server. TeamSpeak 6 only. */
+    VirtualServerCanonicalName: "virtualserver_canonical_name",
+    /** `virtualserver_homebase_storage_quota`: Storage quota for homebase data, in bytes; 4294967295 means unlimited. TeamSpeak 6 only. */
+    VirtualServerHomeBaseStorageQuota: "virtualserver_homebase_storage_quota",
+    /** `virtualserver_homebases`: Number of homebase users on this server. TeamSpeak 6 only. */
+    VirtualServerHomeBases: "virtualserver_homebases",
+    /** `virtualserver_max_homebases`: Maximum number of homebase users this server accepts. TeamSpeak 6 only. */
+    VirtualServerMaxHomeBases: "virtualserver_max_homebases",
+    /** `virtualserver_mytsid_connect_only`: 1 if only clients with a MyTeamSpeak id may connect, 0 if not. TeamSpeak 6 only. */
+    VirtualServerMyTSIDConnectOnly: "virtualserver_mytsid_connect_only",
+    /** `virtualserver_sfu_endpoint`: Address of the server's SFU endpoint; empty if none. TeamSpeak 6 only. */
+    VirtualServerSFUEndpoint: "virtualserver_sfu_endpoint",
+    /** `virtualserver_storage_quota`: Total file storage quota of the server, in bytes; 4294967295 means unlimited. TeamSpeak 6 only. */
+    VirtualServerStorageQuota: "virtualserver_storage_quota",
+    /** `virtualserver_version_sign`: Signature that proves the server's version string is genuine, base64. TeamSpeak 6 only. */
+    VirtualServerVersionSign: "virtualserver_version_sign",
+    // Server instance: instanceinfo, and instanceedit for those marked editable.
+    /** `serverinstance_database_version`: Revision of the server database schema. */
+    ServerInstanceDatabaseVersion: "serverinstance_database_version",
+    /** `serverinstance_filetransfer_port`: TCP port of the file transfer service. Editable. */
+    ServerInstanceFileTransferPort: "serverinstance_filetransfer_port",
+    /** `serverinstance_max_download_total_bandwidth`: Maximum bandwidth of file transfer downloads for the whole instance, in bytes per second. Editable. */
+    ServerInstanceMaxDownloadTotalBandwidth: "serverinstance_max_download_total_bandwidth",
+    /** `serverinstance_max_upload_total_bandwidth`: Maximum bandwidth of file transfer uploads for the whole instance, in bytes per second. Editable. */
+    ServerInstanceMaxUploadTotalBandwidth: "serverinstance_max_upload_total_bandwidth",
+    /** `serverinstance_guest_serverquery_group`: Id of the server group given to ServerQuery clients that have not logged in. Editable. */
+    ServerInstanceGuestServerQueryGroup: "serverinstance_guest_serverquery_group",
+    /** `serverinstance_serverquery_flood_commands`: Commands a ServerQuery client may send within the flood time before it is banned. Editable. */
+    ServerInstanceServerQueryFloodCommands: "serverinstance_serverquery_flood_commands",
+    /** `serverinstance_serverquery_flood_time`: Time window, in seconds, in which ServerQuery commands are counted against the flood limit. Editable. */
+    ServerInstanceServerQueryFloodTime: "serverinstance_serverquery_flood_time",
+    /** `serverinstance_serverquery_ban_time`: How long, in seconds, a ServerQuery client is banned for flooding. Editable. */
+    ServerInstanceServerQueryBanTime: "serverinstance_serverquery_ban_time",
+    /** `serverinstance_template_serveradmin_group`: Id of the template server group used for server admins of new virtual servers. Editable. */
+    ServerInstanceTemplateServerAdminGroup: "serverinstance_template_serveradmin_group",
+    /** `serverinstance_template_serverdefault_group`: Id of the template server group used as the default group of new virtual servers. Editable. */
+    ServerInstanceTemplateServerDefaultGroup: "serverinstance_template_serverdefault_group",
+    /** `serverinstance_template_channeladmin_group`: Id of the template channel group used for channel admins of new virtual servers. Editable. */
+    ServerInstanceTemplateChannelAdminGroup: "serverinstance_template_channeladmin_group",
+    /** `serverinstance_template_channeldefault_group`: Id of the template channel group used as the default channel group of new virtual servers. Editable. */
+    ServerInstanceTemplateChannelDefaultGroup: "serverinstance_template_channeldefault_group",
+    /** `serverinstance_permissions_version`: Revision of the permission set the server knows. */
+    ServerInstancePermissionsVersion: "serverinstance_permissions_version",
+    /** `serverinstance_pending_connections_per_ip`: Connections an IP address may have waiting to finish connecting; 0 means no limit. Editable. */
+    ServerInstancePendingConnectionsPerIP: "serverinstance_pending_connections_per_ip",
+    /** `serverinstance_serverquery_max_connections_per_ip`: ServerQuery connections one IP address may hold open at the same time. Editable. */
+    ServerInstanceServerQueryMaxConnectionsPerIP: "serverinstance_serverquery_max_connections_per_ip",
+    /** `serverinstance_max_homebases`: Maximum number of homebase users across the instance; -1 means unlimited. Editable. TeamSpeak 6 only. */
+    ServerInstanceMaxHomeBases: "serverinstance_max_homebases",
+    // Host: hostinfo.
+    /** `instance_uptime`: Seconds since the server instance started. */
+    InstanceUptime: "instance_uptime",
+    /** `host_timestamp_utc`: The server's current time, as a Unix timestamp in seconds. */
+    HostTimestampUTC: "host_timestamp_utc",
+    /** `virtualservers_running_total`: Number of virtual servers running. */
+    VirtualServersRunningTotal: "virtualservers_running_total",
+    /** `virtualservers_total_maxclients`: Sum of the client limits of all running virtual servers. */
+    VirtualServersTotalMaxClients: "virtualservers_total_maxclients",
+    /** `virtualservers_total_clients_online`: Clients online across all virtual servers. */
+    VirtualServersTotalClientsOnline: "virtualservers_total_clients_online",
+    /** `virtualservers_total_channels_online`: Channels across all virtual servers. */
+    VirtualServersTotalChannelsOnline: "virtualservers_total_channels_online",
+    /** `virtualservers_total_homebases`: Number of homebase users across all virtual servers. TeamSpeak 6 only. */
+    VirtualServersTotalHomeBases: "virtualservers_total_homebases",
+    /** `virtualservers_total_max_homebases`: Maximum number of homebase users across all virtual servers; -1 means unlimited. TeamSpeak 6 only. */
+    VirtualServersTotalMaxHomeBases: "virtualservers_total_max_homebases",
+    // Client: clientinfo.
+    /** `cid`: Id of the channel the client is in. */
+    CID: "cid",
+    /** `client_idle_time`: Milliseconds since the client was last active. */
+    ClientIdleTime: "client_idle_time",
+    /** `client_unique_identifier`: The client's unique id, derived from its identity; a ServerQuery client has its login name. */
+    ClientUniqueIdentifier: "client_unique_identifier",
+    /** `client_nickname`: Nickname of the client. Editable. */
+    ClientNickname: "client_nickname",
+    /** `client_version`: Client version and build as the client reports it. */
+    ClientVersion: "client_version",
+    /** `client_platform`: Operating system the client reports, such as Windows. */
+    ClientPlatform: "client_platform",
+    /** `client_input_muted`: 1 if the client's microphone is muted, 0 if not. */
+    ClientInputMuted: "client_input_muted",
+    /** `client_output_muted`: 1 if the client's speakers are muted, 0 if not. */
+    ClientOutputMuted: "client_output_muted",
+    /** `client_outputonly_muted`: 1 if the client has muted all other clients' sound but not its own, 0 if not. */
+    ClientOutputOnlyMuted: "client_outputonly_muted",
+    /** `client_input_hardware`: 1 if the client has a working capture device, 0 if not. */
+    ClientInputHardware: "client_input_hardware",
+    /** `client_output_hardware`: 1 if the client has a working playback device, 0 if not. */
+    ClientOutputHardware: "client_output_hardware",
+    /** `client_default_channel`: Path of the channel the client asked to join first; empty for none. */
+    ClientDefaultChannel: "client_default_channel",
+    /** `client_meta_data`: Free-form data the client attaches to itself. */
+    ClientMetaData: "client_meta_data",
+    /** `client_is_recording`: 1 if the client is recording the conversation, 0 if not. */
+    ClientIsRecording: "client_is_recording",
+    /** `client_version_sign`: Signature that proves the client's version string is genuine, base64. */
+    ClientVersionSign: "client_version_sign",
+    /** `client_security_hash`: The client's security hash; empty if it sent none. */
+    ClientSecurityHash: "client_security_hash",
+    /** `client_is_streaming`: 1 if the client is streaming, 0 if not. TeamSpeak 6 only. */
+    ClientIsStreaming: "client_is_streaming",
+    /** `client_login_name`: ServerQuery login name the client logged in with; empty for voice clients. */
+    ClientLoginName: "client_login_name",
+    /** `client_database_id`: The client's id in the server database. */
+    ClientDatabaseID: "client_database_id",
+    /** `client_channel_group_id`: Id of the client's channel group in its current channel. */
+    ClientChannelGroupID: "client_channel_group_id",
+    /** `client_servergroups`: Ids of the client's server groups, separated by commas. */
+    ClientServerGroups: "client_servergroups",
+    /** `client_created`: When the client first connected, as a Unix timestamp in seconds. */
+    ClientCreated: "client_created",
+    /** `client_lastconnected`: When the client last connected, as a Unix timestamp in seconds. */
+    ClientLastConnected: "client_lastconnected",
+    /** `client_totalconnections`: How many times the client has connected. */
+    ClientTotalConnections: "client_totalconnections",
+    /** `client_away`: 1 if the client is away, 0 if not. */
+    ClientAway: "client_away",
+    /** `client_away_message`: The client's away message. */
+    ClientAwayMessage: "client_away_message",
+    /** `client_type`: 0 for a voice client, 1 for a ServerQuery client. */
+    ClientType: "client_type",
+    /** `client_flag_avatar`: Checksum of the client's avatar file; empty if it has none. */
+    ClientFlagAvatar: "client_flag_avatar",
+    /** `client_talk_power`: The client's talk power in its channel. */
+    ClientTalkPower: "client_talk_power",
+    /** `client_talk_request`: Nonzero if the client has asked for talk power in a moderated channel, 0 if not. */
+    ClientTalkRequest: "client_talk_request",
+    /** `client_talk_request_msg`: Message that came with the client's request for talk power. */
+    ClientTalkRequestMsg: "client_talk_request_msg",
+    /** `client_description`: Brief description of the client (max 200 chars). Editable. */
+    ClientDescription: "client_description",
+    /** `client_is_talker`: Indicates whether the client is able to talk or not. Editable. */
+    ClientIsTalker: "client_is_talker",
+    /** `client_month_bytes_uploaded`: Bytes of file transfer uploads by the client this month. */
+    ClientMonthBytesUploaded: "client_month_bytes_uploaded",
+    /** `client_month_bytes_downloaded`: Bytes of file transfer downloads by the client this month. */
+    ClientMonthBytesDownloaded: "client_month_bytes_downloaded",
+    /** `client_total_bytes_uploaded`: Bytes of file transfer uploads by the client in total. */
+    ClientTotalBytesUploaded: "client_total_bytes_uploaded",
+    /** `client_total_bytes_downloaded`: Bytes of file transfer downloads by the client in total. */
+    ClientTotalBytesDownloaded: "client_total_bytes_downloaded",
+    /** `client_is_priority_speaker`: 1 if the client is a priority speaker, 0 if not. */
+    ClientIsPrioritySpeaker: "client_is_priority_speaker",
+    /** `client_unread_messages`: Number of offline messages the client has not read. */
+    ClientUnreadMessages: "client_unread_messages",
+    /** `client_nickname_phonetic`: Phonetic spelling of the client's nickname. */
+    ClientNicknamePhonetic: "client_nickname_phonetic",
+    /** `client_needed_serverquery_view_power`: Power a ServerQuery client needs to see this client. */
+    ClientNeededServerQueryViewPower: "client_needed_serverquery_view_power",
+    /** `client_default_token`: Privilege key the client used to connect, if any. */
+    ClientDefaultToken: "client_default_token",
+    /** `client_icon_id`: CRC32 checksum of the client icon. Editable. */
+    ClientIconID: "client_icon_id",
+    /** `client_is_channel_commander`: Indicates whether the client is a channel commander or not. Editable. */
+    ClientIsChannelCommander: "client_is_channel_commander",
+    /** `client_country`: Two-letter country code of the client; empty if unknown. */
+    ClientCountry: "client_country",
+    /** `client_channel_group_inherited_channel_id`: Id of the channel the client's channel group applies from, which is an ancestor when the group is inherited. */
+    ClientChannelGroupInheritedChannelID: "client_channel_group_inherited_channel_id",
+    /** `client_badges`: Badges the client shows, as a string. */
+    ClientBadges: "client_badges",
+    /** `client_myteamspeak_id`: The client's MyTeamSpeak id; empty if it is not logged in. */
+    ClientMyTeamSpeakID: "client_myteamspeak_id",
+    /** `client_integrations`: Integrations the client has linked to its MyTeamSpeak account; empty for none. */
+    ClientIntegrations: "client_integrations",
+    /** `client_myteamspeak_avatar`: Checksum of the client's MyTeamSpeak avatar; empty for none. */
+    ClientMyTeamSpeakAvatar: "client_myteamspeak_avatar",
+    /** `client_signed_badges`: Badges the client shows, signed by TeamSpeak. */
+    ClientSignedBadges: "client_signed_badges",
+    /** `client_user_tag`: Free-form tag the user has set for itself. TeamSpeak 6 only. */
+    ClientUserTag: "client_user_tag",
+    /** `client_public_key_raw`: The client's raw public key, base64. TeamSpeak 6 only. */
+    ClientPublicKeyRaw: "client_public_key_raw",
+    /** `client_base64HashClientUID`: The client's unique id hashed and re-encoded with the letters a to p, the form the TeamSpeak client uses to name its avatar files. */
+    ClientBase64HashClientUID: "client_base64HashClientUID",
+    /** `connection_connected_time`: Milliseconds since the client connected. */
+    ConnectionConnectedTime: "connection_connected_time",
+    /** `connection_client_ip`: The client's IP address. */
+    ConnectionClientIP: "connection_client_ip",
+};
+/** The property names; see {@link PropertyName}'s entries for what each holds. */
+export const PropertyName = 
+/* @__PURE__ */ Object.freeze(propertyNameValues);
+//# sourceMappingURL=property-name.js.map

package/dist/core/property-name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"property-name.js","sourceRoot":"","sources":["../../src/core/property-name.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,MAAM,kBAAkB,GAAG;IACzB,wEAAwE;IACxE,4HAA4H;IAC5H,6BAA6B,EAAE,iCAAiC;IAChE,sEAAsE;IACtE,iBAAiB,EAAE,oBAAoB;IACvC,mFAAmF;IACnF,2BAA2B,EAAE,8BAA8B;IAC3D,oFAAoF;IACpF,qBAAqB,EAAE,wBAAwB;IAC/C,iGAAiG;IACjG,oBAAoB,EAAE,uBAAuB;IAC7C,oFAAoF;IACpF,uBAAuB,EAAE,0BAA0B;IACnD,0EAA0E;IAC1E,qBAAqB,EAAE,wBAAwB;IAC/C,uGAAuG;IACvG,0BAA0B,EAAE,6BAA6B;IACzD,wEAAwE;IACxE,2BAA2B,EAAE,8BAA8B;IAC3D,oGAAoG;IACpG,oBAAoB,EAAE,uBAAuB;IAC7C,wEAAwE;IACxE,mBAAmB,EAAE,sBAAsB;IAC3C,+GAA+G;IAC/G,gCAAgC,EAAE,qCAAqC;IACvE,6EAA6E;IAC7E,wBAAwB,EAAE,2BAA2B;IACrD,0LAA0L;IAC1L,4BAA4B,EAAE,gCAAgC;IAC9D,+GAA+G;IAC/G,qBAAqB,EAAE,wBAAwB;IAC/C,uFAAuF;IACvF,+BAA+B,EAAE,oCAAoC;IACrE,yFAAyF;IACzF,gCAAgC,EAAE,qCAAqC;IACvE,uFAAuF;IACvF,yBAAyB,EAAE,6BAA6B;IACxD,6GAA6G;IAC7G,qCAAqC,EAAE,2CAA2C;IAClF,6IAA6I;IAC7I,sCAAsC,EAAE,4CAA4C;IACpF,2IAA2I;IAC3I,oCAAoC,EAAE,0CAA0C;IAChF,yEAAyE;IACzE,0BAA0B,EAAE,8BAA8B;IAC1D,mFAAmF;IACnF,6BAA6B,EAAE,kCAAkC;IACjE,iIAAiI;IACjI,kCAAkC,EAAE,uCAAuC;IAC3E,+HAA+H;IAC/H,iCAAiC,EAAE,sCAAsC;IACzE,gIAAgI;IAChI,gCAAgC,EAAE,qCAAqC;IACvE,mIAAmI;IACnI,+BAA+B,EAAE,oCAAoC;IACrE,6IAA6I;IAC7I,mDAAmD,EACjD,4DAA4D;IAC9D,4IAA4I;IAC5I,2CAA2C,EAAE,iDAAiD;IAC9F,wEAAwE;IACxE,eAAe,EAAE,kBAAkB;IACnC,sHAAsH;IACtH,sCAAsC,EAAE,4CAA4C;IACpF,gJAAgJ;IAChJ,8CAA8C,EAC5C,qDAAqD;IACvD,0IAA0I;IAC1I,yCAAyC,EAAE,gDAAgD;IAC3F,4GAA4G;IAC5G,8BAA8B,EAAE,kCAAkC;IAClE,iHAAiH;IACjH,mCAAmC,EAAE,wCAAwC;IAC7E,iHAAiH;IACjH,8BAA8B,EAAE,kCAAkC;IAClE,wFAAwF;IACxF,0BAA0B,EAAE,8BAA8B;IAC1D,4FAA4F;IAC5F,6BAA6B,EAAE,kCAAkC;IACjE,gFAAgF;IAChF,+BAA+B,EAAE,kCAAkC;IACnE,+FAA+F;IAC/F,0BAA0B,EAAE,8BAA8B;IAC1D,2FAA2F;IAC3F,wBAAwB,EAAE,4BAA4B;IACtD,2FAA2F;IAC3F,iCAAiC,EAAE,sCAAsC;IACzE,uFAAuF;IACvF,+BAA+B,EAAE,oCAAoC;IACrE,yFAAyF;IACzF,iCAAiC,EAAE,sCAAsC;IACzE,qFAAqF;IACrF,+BAA+B,EAAE,oCAAoC;IACrE,mFAAmF;IACnF,iBAAiB,EAAE,oBAAoB;IACvC,yGAAyG;IACzG,sBAAsB,EAAE,yBAAyB;IACjD,iIAAiI;IACjI,sBAAsB,EAAE,0BAA0B;IAClD,kJAAkJ;IAClJ,wCAAwC,EAAE,8CAA8C;IACxF,gHAAgH;IAChH,sBAAsB,EAAE,0BAA0B;IAClD,2HAA2H;IAC3H,qBAAqB,EAAE,yBAAyB;IAChD,kHAAkH;IAClH,uBAAuB,EAAE,2BAA2B;IACpD,yHAAyH;IACzH,2BAA2B,EAAE,+BAA+B;IAC5D,uHAAuH;IACvH,sBAAsB,EAAE,0BAA0B;IAClD,6HAA6H;IAC7H,4BAA4B,EAAE,gCAAgC;IAC9D,yHAAyH;IACzH,6BAA6B,EAAE,kCAAkC;IACjE,oFAAoF;IACpF,yBAAyB,EAAE,6BAA6B;IACxD,oFAAoF;IACpF,mBAAmB,EAAE,uBAAuB;IAC5C,0GAA0G;IAC1G,0BAA0B,EAAE,8BAA8B;IAC1D,oHAAoH;IACpH,kCAAkC,EAAE,uCAAuC;IAC3E,2HAA2H;IAC3H,qCAAqC,EAAE,0CAA0C;IACjF,uHAAuH;IACvH,mCAAmC,EAAE,wCAAwC;IAC7E,mHAAmH;IACnH,iCAAiC,EAAE,sCAAsC;IACzE,gFAAgF;IAChF,sBAAsB,EAAE,0BAA0B;IAClD,2FAA2F;IAC3F,eAAe,EAAE,kBAAkB;IACnC,4HAA4H;IAC5H,2BAA2B,EAAE,+BAA+B;IAC5D,mJAAmJ;IACnJ,+BAA+B,EAAE,oCAAoC;IACrE,sGAAsG;IACtG,2BAA2B,EAAE,+BAA+B;IAC5D,kIAAkI;IAClI,0CAA0C,EAAE,iDAAiD;IAC7F,yGAAyG;IACzG,8BAA8B,EAAE,mCAAmC;IACnE,iGAAiG;IACjG,0BAA0B,EAAE,+BAA+B;IAC3D,iIAAiI;IACjI,qBAAqB,EAAE,wBAAwB;IAC/C,+NAA+N;IAC/N,6CAA6C,EAC3C,oDAAoD;IACtD,kHAAkH;IAClH,iCAAiC,EAAE,qCAAqC;IACxE,6HAA6H;IAC7H,6BAA6B,EAAE,kCAAkC;IACjE,uIAAuI;IACvI,mBAAmB,EAAE,sBAAsB;IAC3C,0IAA0I;IAC1I,mCAAmC,EAAE,wCAAwC;IAC7E,gJAAgJ;IAChJ,uCAAuC,EAAE,4CAA4C;IACrF,iIAAiI;IACjI,oCAAoC,EAAE,0CAA0C;IAChF,yIAAyI;IACzI,wCAAwC,EAAE,8CAA8C;IACxF,qFAAqF;IACrF,2BAA2B,EAAE,gCAAgC;IAC7D,4FAA4F;IAC5F,yBAAyB,EAAE,8BAA8B;IACzD,6FAA6F;IAC7F,+BAA+B,EAAE,oCAAoC;IACrE,oGAAoG;IACpG,6BAA6B,EAAE,kCAAkC;IACjE,4FAA4F;IAC5F,8BAA8B,EAAE,mCAAmC;IACnE,mGAAmG;IACnG,4BAA4B,EAAE,iCAAiC;IAC/D,oGAAoG;IACpG,kCAAkC,EAAE,uCAAuC;IAC3E,2GAA2G;IAC3G,gCAAgC,EAAE,qCAAqC;IACvE,kGAAkG;IAClG,4BAA4B,EAAE,iCAAiC;IAC/D,+FAA+F;IAC/F,0BAA0B,EAAE,+BAA+B;IAC3D,gGAAgG;IAChG,gCAAgC,EAAE,qCAAqC;IACvE,uGAAuG;IACvG,8BAA8B,EAAE,mCAAmC;IACnE,mHAAmH;IACnH,0BAA0B,EAAE,+BAA+B;IAC3D,+GAA+G;IAC/G,wBAAwB,EAAE,6BAA6B;IACvD,2HAA2H;IAC3H,8BAA8B,EAAE,mCAAmC;IACnE,uHAAuH;IACvH,4BAA4B,EAAE,iCAAiC;IAC/D,4IAA4I;IAC5I,sCAAsC,EAAE,6CAA6C;IACrF,4IAA4I;IAC5I,sCAAsC,EAAE,6CAA6C;IACrF,oJAAoJ;IACpJ,0CAA0C,EAAE,iDAAiD;IAC7F,oJAAoJ;IACpJ,0CAA0C,EAAE,iDAAiD;IAC7F,+EAA+E;IAC/E,oBAAoB,EAAE,uBAAuB;IAC7C,oGAAoG;IACpG,iCAAiC,EAAE,qCAAqC;IACxE,sFAAsF;IACtF,0BAA0B,EAAE,8BAA8B;IAC1D,uIAAuI;IACvI,iCAAiC,EAAE,sCAAsC;IACzE,4FAA4F;IAC5F,sBAAsB,EAAE,yBAAyB;IACjD,6GAA6G;IAC7G,yBAAyB,EAAE,6BAA6B;IACxD,4HAA4H;IAC5H,8BAA8B,EAAE,mCAAmC;IACnE,2GAA2G;IAC3G,wBAAwB,EAAE,4BAA4B;IACtD,qIAAqI;IACrI,yBAAyB,EAAE,6BAA6B;IACxD,4HAA4H;IAC5H,wBAAwB,EAAE,4BAA4B;IACtD,6EAA6E;IAC7E,iFAAiF;IACjF,6BAA6B,EAAE,iCAAiC;IAChE,2FAA2F;IAC3F,8BAA8B,EAAE,kCAAkC;IAClE,yJAAyJ;IACzJ,uCAAuC,EAAE,6CAA6C;IACtF,qJAAqJ;IACrJ,qCAAqC,EAAE,2CAA2C;IAClF,uIAAuI;IACvI,mCAAmC,EAAE,wCAAwC;IAC7E,+IAA+I;IAC/I,sCAAsC,EAAE,2CAA2C;IACnF,qJAAqJ;IACrJ,kCAAkC,EAAE,uCAAuC;IAC3E,0HAA0H;IAC1H,gCAAgC,EAAE,qCAAqC;IACvE,4IAA4I;IAC5I,sCAAsC,EAAE,2CAA2C;IACnF,iJAAiJ;IACjJ,wCAAwC,EAAE,6CAA6C;IACvF,+IAA+I;IAC/I,uCAAuC,EAAE,4CAA4C;IACrF,2JAA2J;IAC3J,yCAAyC,EAAE,8CAA8C;IACzF,6FAA6F;IAC7F,gCAAgC,EAAE,oCAAoC;IACtE,gJAAgJ;IAChJ,qCAAqC,EAAE,2CAA2C;IAClF,4IAA4I;IAC5I,4CAA4C,EAAE,mDAAmD;IACjG,4IAA4I;IAC5I,0BAA0B,EAAE,8BAA8B;IAC1D,kBAAkB;IAClB,oEAAoE;IACpE,cAAc,EAAE,iBAAiB;IACjC,uFAAuF;IACvF,gBAAgB,EAAE,oBAAoB;IACtC,yEAAyE;IACzE,0BAA0B,EAAE,8BAA8B;IAC1D,kGAAkG;IAClG,6BAA6B,EAAE,iCAAiC;IAChE,wFAAwF;IACxF,gCAAgC,EAAE,qCAAqC;IACvE,mFAAmF;IACnF,iCAAiC,EAAE,sCAAsC;IACzE,+GAA+G;IAC/G,4BAA4B,EAAE,gCAAgC;IAC9D,+IAA+I;IAC/I,+BAA+B,EAAE,oCAAoC;IACrE,sBAAsB;IACtB,iDAAiD;IACjD,GAAG,EAAE,KAAK;IACV,yEAAyE;IACzE,cAAc,EAAE,kBAAkB;IAClC,8HAA8H;IAC9H,sBAAsB,EAAE,0BAA0B;IAClD,2DAA2D;IAC3D,cAAc,EAAE,iBAAiB;IACjC,2EAA2E;IAC3E,aAAa,EAAE,gBAAgB;IAC/B,+EAA+E;IAC/E,cAAc,EAAE,iBAAiB;IACjC,6EAA6E;IAC7E,gBAAgB,EAAE,oBAAoB;IACtC,6EAA6E;IAC7E,iBAAiB,EAAE,qBAAqB;IACxC,+GAA+G;IAC/G,qBAAqB,EAAE,yBAAyB;IAChD,uFAAuF;IACvF,mBAAmB,EAAE,uBAAuB;IAC5C,yFAAyF;IACzF,oBAAoB,EAAE,wBAAwB;IAC9C,oGAAoG;IACpG,oBAAoB,EAAE,wBAAwB;IAC9C,wEAAwE;IACxE,cAAc,EAAE,kBAAkB;IAClC,sFAAsF;IACtF,iBAAiB,EAAE,qBAAqB;IACxC,mGAAmG;IACnG,iBAAiB,EAAE,qBAAqB;IACxC,iFAAiF;IACjF,kBAAkB,EAAE,sBAAsB;IAC1C,uFAAuF;IACvF,iBAAiB,EAAE,qBAAqB;IACxC,sGAAsG;IACtG,eAAe,EAAE,mBAAmB;IACpC,oEAAoE;IACpE,gBAAgB,EAAE,oBAAoB;IACtC,0FAA0F;IAC1F,oBAAoB,EAAE,yBAAyB;IAC/C,qFAAqF;IACrF,kBAAkB,EAAE,qBAAqB;IACzC,yFAAyF;IACzF,aAAa,EAAE,gBAAgB;IAC/B,8FAA8F;IAC9F,mBAAmB,EAAE,sBAAsB;IAC3C,0EAA0E;IAC1E,sBAAsB,EAAE,yBAAyB;IACjD,wDAAwD;IACxD,UAAU,EAAE,aAAa;IACzB,wDAAwD;IACxD,iBAAiB,EAAE,qBAAqB;IACxC,uEAAuE;IACvE,UAAU,EAAE,aAAa;IACzB,wFAAwF;IACxF,gBAAgB,EAAE,oBAAoB;IACtC,mEAAmE;IACnE,eAAe,EAAE,mBAAmB;IACpC,8GAA8G;IAC9G,iBAAiB,EAAE,qBAAqB;IACxC,6FAA6F;IAC7F,oBAAoB,EAAE,yBAAyB;IAC/C,uFAAuF;IACvF,iBAAiB,EAAE,oBAAoB;IACvC,yFAAyF;IACzF,cAAc,EAAE,kBAAkB;IAClC,8FAA8F;IAC9F,wBAAwB,EAAE,6BAA6B;IACvD,kGAAkG;IAClG,0BAA0B,EAAE,+BAA+B;IAC3D,4FAA4F;IAC5F,wBAAwB,EAAE,6BAA6B;IACvD,gGAAgG;IAChG,0BAA0B,EAAE,+BAA+B;IAC3D,qFAAqF;IACrF,uBAAuB,EAAE,4BAA4B;IACrD,oFAAoF;IACpF,oBAAoB,EAAE,wBAAwB;IAC9C,8EAA8E;IAC9E,sBAAsB,EAAE,0BAA0B;IAClD,mGAAmG;IACnG,gCAAgC,EAAE,sCAAsC;IACxE,gFAAgF;IAChF,kBAAkB,EAAE,sBAAsB;IAC1C,qEAAqE;IACrE,YAAY,EAAE,gBAAgB;IAC9B,2GAA2G;IAC3G,wBAAwB,EAAE,6BAA6B;IACvD,iFAAiF;IACjF,aAAa,EAAE,gBAAgB;IAC/B,gKAAgK;IAChK,oCAAoC,EAAE,2CAA2C;IACjF,6DAA6D;IAC7D,YAAY,EAAE,eAAe;IAC7B,0FAA0F;IAC1F,mBAAmB,EAAE,uBAAuB;IAC5C,4GAA4G;IAC5G,kBAAkB,EAAE,qBAAqB;IACzC,gGAAgG;IAChG,uBAAuB,EAAE,2BAA2B;IACpD,4EAA4E;IAC5E,kBAAkB,EAAE,sBAAsB;IAC1C,sFAAsF;IACtF,aAAa,EAAE,iBAAiB;IAChC,sFAAsF;IACtF,kBAAkB,EAAE,uBAAuB;IAC3C,uKAAuK;IACvK,yBAAyB,EAAE,4BAA4B;IACvD,4EAA4E;IAC5E,uBAAuB,EAAE,2BAA2B;IACpD,uDAAuD;IACvD,kBAAkB,EAAE,sBAAsB;CAClC,CAAC;AAEX,kFAAkF;AAClF,MAAM,CAAC,MAAM,YAAY;AACvB,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC"}

package/dist/core/reason.d.ts

@@ -0,0 +1,39 @@
+/** The values of the table below, before freezing. */
+declare const reasonValues: {
+    /** A client joining, or moving of its own accord. */
+    readonly None: 0;
+    /** A client moved by someone else. */
+    readonly Moved: 1;
+    /** A client coming into or out of view because a channel was (un)subscribed. */
+    readonly Subscription: 2;
+    /** A client that timed out. */
+    readonly LostConnection: 3;
+    /** A client kicked from its channel. */
+    readonly KickChannel: 4;
+    /** A client kicked from the server. */
+    readonly KickServer: 5;
+    /** A client banned from the server. */
+    readonly KickServerBan: 6;
+    /** The virtual server stopping. */
+    readonly ServerStop: 7;
+    /** A client that left the server. */
+    readonly Disconnect: 8;
+    /** A change to a channel the client can see. */
+    readonly ChannelUpdate: 9;
+    /** A channel edited by someone. */
+    readonly ChannelEdit: 10;
+    /** The server instance shutting down. */
+    readonly ServerShutdown: 11;
+};
+/**
+ * Why a client moved or left view, as the server reports it (`reasonid`).
+ *
+ * The names are the ones `Reason` has in teamspeak-go.
+ * Events carry the reason as a plain number, since a server may send one this
+ * table does not name.
+ */
+export declare const Reason: typeof reasonValues;
+/** A known reason. */
+export type Reason = (typeof Reason)[keyof typeof Reason];
+export {};
+//# sourceMappingURL=reason.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reason.d.ts","sourceRoot":"","sources":["../../src/core/reason.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,QAAA,MAAM,YAAY;IAChB,qDAAqD;aACrD,IAAI,EAAE,CAAC;IACP,sCAAsC;aACtC,KAAK,EAAE,CAAC;IACR,gFAAgF;aAChF,YAAY,EAAE,CAAC;IACf,+BAA+B;aAC/B,cAAc,EAAE,CAAC;IACjB,wCAAwC;aACxC,WAAW,EAAE,CAAC;IACd,uCAAuC;aACvC,UAAU,EAAE,CAAC;IACb,uCAAuC;aACvC,aAAa,EAAE,CAAC;IAChB,mCAAmC;aACnC,UAAU,EAAE,CAAC;IACb,qCAAqC;aACrC,UAAU,EAAE,CAAC;IACb,gDAAgD;aAChD,aAAa,EAAE,CAAC;IAChB,mCAAmC;aACnC,WAAW,EAAE,EAAE;IACf,yCAAyC;aACzC,cAAc,EAAE,EAAE;CACV,CAAC;AACX;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,YAA0D,CAAC;AAEvF,sBAAsB;AACtB,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC"}

package/dist/core/reason.js

@@ -0,0 +1,36 @@
+/** The values of the table below, before freezing. */
+const reasonValues = {
+    /** A client joining, or moving of its own accord. */
+    None: 0,
+    /** A client moved by someone else. */
+    Moved: 1,
+    /** A client coming into or out of view because a channel was (un)subscribed. */
+    Subscription: 2,
+    /** A client that timed out. */
+    LostConnection: 3,
+    /** A client kicked from its channel. */
+    KickChannel: 4,
+    /** A client kicked from the server. */
+    KickServer: 5,
+    /** A client banned from the server. */
+    KickServerBan: 6,
+    /** The virtual server stopping. */
+    ServerStop: 7,
+    /** A client that left the server. */
+    Disconnect: 8,
+    /** A change to a channel the client can see. */
+    ChannelUpdate: 9,
+    /** A channel edited by someone. */
+    ChannelEdit: 10,
+    /** The server instance shutting down. */
+    ServerShutdown: 11,
+};
+/**
+ * Why a client moved or left view, as the server reports it (`reasonid`).
+ *
+ * The names are the ones `Reason` has in teamspeak-go.
+ * Events carry the reason as a plain number, since a server may send one this
+ * table does not name.
+ */
+export const Reason = /* @__PURE__ */ Object.freeze(reasonValues);
+//# sourceMappingURL=reason.js.map

package/dist/core/reason.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reason.js","sourceRoot":"","sources":["../../src/core/reason.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,MAAM,YAAY,GAAG;IACnB,qDAAqD;IACrD,IAAI,EAAE,CAAC;IACP,sCAAsC;IACtC,KAAK,EAAE,CAAC;IACR,gFAAgF;IAChF,YAAY,EAAE,CAAC;IACf,+BAA+B;IAC/B,cAAc,EAAE,CAAC;IACjB,wCAAwC;IACxC,WAAW,EAAE,CAAC;IACd,uCAAuC;IACvC,UAAU,EAAE,CAAC;IACb,uCAAuC;IACvC,aAAa,EAAE,CAAC;IAChB,mCAAmC;IACnC,UAAU,EAAE,CAAC;IACb,qCAAqC;IACrC,UAAU,EAAE,CAAC;IACb,gDAAgD;IAChD,aAAa,EAAE,CAAC;IAChB,mCAAmC;IACnC,WAAW,EAAE,EAAE;IACf,yCAAyC;IACzC,cAAc,EAAE,EAAE;CACV,CAAC;AACX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAwB,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC"}

package/dist/core/reconnect.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Reconnection policy.
+ *
+ * A dropped connection is normal on a UDP voice session, so a bot that cannot
+ * recover is not usable unattended. Reconnecting is opt-in rather than
+ * automatic: a silent reconnect makes a dropped session look like a healthy
+ * one, and a caller that wanted to know about the drop never finds out.
+ *
+ * Backoff is not a nicety here. TeamSpeak bans an IP that opens several
+ * connections in quick succession — measured at roughly three, after which the
+ * server answers `error id=3329` and refuses everything. A reconnect loop
+ * without a delay therefore bans itself, and the ban outlasts the outage it was
+ * recovering from.
+ */
+/** How long to wait before each attempt. */
+export interface BackoffPolicy {
+    /** Delay before the first retry, in milliseconds. */
+    readonly initialDelayMs: number;
+    /** Ceiling for the delay; it never grows past this. */
+    readonly maxDelayMs: number;
+    /** Multiplier applied after each failed attempt. */
+    readonly factor: number;
+    /**
+     * Fraction of the delay to randomise, 0 to 1.
+     *
+     * A fleet of bots that drop together would otherwise retry in lockstep and
+     * hit the server in a burst. Jitter spreads them out.
+     */
+    readonly jitter: number;
+    /** Give up after this many consecutive failures. 0 means never give up. */
+    readonly maxAttempts: number;
+}
+/** One second, doubling, capped at a minute, with 20% jitter, never giving up. */
+export declare const defaultBackoffPolicy: Readonly<BackoffPolicy>;
+/**
+ * How a client reconnects after its connection drops. Supplying it, even as
+ * `{}`, turns reconnecting on; a deliberate `disconnect()` never reconnects.
+ */
+export interface ReconnectOptions {
+    /** Tuning for the retry delays; unset fields keep {@link defaultBackoffPolicy}'s. */
+    readonly backoff?: {
+        readonly [K in keyof BackoffPolicy]?: BackoffPolicy[K] | undefined;
+    } | undefined;
+    /**
+     * Decide whether a given failure is worth retrying. Returning false stops the
+     * loop. Each client provides its own default; the voice client's is
+     * `defaultShouldRetry` in `@honeybbq/teamspeak/client`.
+     */
+    readonly shouldRetry?: ((error: Error | undefined, attempt: number) => boolean) | undefined;
+}
+/**
+ * Compute the delay before an attempt.
+ *
+ * `attempt` is 1-based: the delay before the first retry is `initialDelayMs`,
+ * give or take the jitter, and the delay never grows past `maxDelayMs`.
+ */
+export declare function backoffDelay(policy: Readonly<BackoffPolicy>, attempt: number): number;
+export declare function resolveBackoffPolicy(options: ReconnectOptions): BackoffPolicy;
+//# sourceMappingURL=reconnect.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reconnect.d.ts","sourceRoot":"","sources":["../../src/core/reconnect.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,4CAA4C;AAC5C,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,uDAAuD;IACvD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,kFAAkF;AAClF,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC,aAAa,CAMvD,CAAC;AAEH;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qFAAqF;IACrF,QAAQ,CAAC,OAAO,CAAC,EACb;QAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,aAAa,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS;KAAE,GACtE,SAAS,CAAC;IACd;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;CAC7F;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAErF;AAsBD,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,gBAAgB,GAAG,aAAa,CAO7E"}