@honeybbq/teamspeak 0.0.1 → 1.0.0-beta.7

package/dist/client/types.js

@@ -0,0 +1,39 @@
+/** The values of the table below, before freezing. */
+const eventNameValues = {
+    /** A text message to this client, its channel or the server. */
+    TextMessage: "textMessage",
+    /** A client coming into view, including every client already there on connecting. */
+    ClientEnter: "clientEnter",
+    /** A client going out of view. */
+    ClientLeave: "clientLeave",
+    /** A client changing channel. */
+    ClientMoved: "clientMoved",
+    /** This client being poked. */
+    Poked: "poked",
+    /** Audio from another client. Only decoded with a listener or event middleware. */
+    VoiceData: "voiceData",
+    /**
+     * Every notification the server sends, modelled or not, after any event it
+     * produces; one with a typed event arrives here as well, not only there.
+     */
+    Notification: "notification",
+    /** The handshake completing, on `connect()` and on every reconnection. */
+    Connected: "connected",
+    /** The connection ending, with its cause and whether a reconnection follows. */
+    Disconnected: "disconnected",
+    /** A kick from the server, which also ends the connection. */
+    Kicked: "kicked",
+};
+/**
+ * The names of the events `Client.on()` takes, as constants. `on(EventName.TextMessage, ...)`
+ * and `on("textMessage", ...)` are the same call, and both give the listener
+ * the same payload type.
+ */
+export const EventName = /* @__PURE__ */ Object.freeze(eventNameValues);
+// Each direction fails to compile when `EventMap` and `EventName` drift: an
+// event without a name, and a name that is not an event.
+const eventNamesCoverEventMap = true;
+const eventMapCoversEventNames = true;
+void eventNamesCoverEventMap;
+void eventMapCoversEventNames;
+//# sourceMappingURL=types.js.map

package/dist/client/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/client/types.ts"],"names":[],"mappings":"AAmDA,sDAAsD;AACtD,MAAM,eAAe,GAAG;IACtB,gEAAgE;IAChE,WAAW,EAAE,aAAa;IAC1B,qFAAqF;IACrF,WAAW,EAAE,aAAa;IAC1B,kCAAkC;IAClC,WAAW,EAAE,aAAa;IAC1B,iCAAiC;IACjC,WAAW,EAAE,aAAa;IAC1B,+BAA+B;IAC/B,KAAK,EAAE,OAAO;IACd,mFAAmF;IACnF,SAAS,EAAE,WAAW;IACtB;;;OAGG;IACH,YAAY,EAAE,cAAc;IAC5B,0EAA0E;IAC1E,SAAS,EAAE,WAAW;IACtB,gFAAgF;IAChF,YAAY,EAAE,cAAc;IAC5B,8DAA8D;IAC9D,MAAM,EAAE,QAAQ;CACR,CAAC;AACX;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAA2B,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;AAOhG,4EAA4E;AAC5E,yDAAyD;AACzD,MAAM,uBAAuB,GAC3B,IAAI,CAAC;AACP,MAAM,wBAAwB,GAElB,IAAI,CAAC;AACjB,KAAK,uBAAuB,CAAC;AAC7B,KAAK,wBAAwB,CAAC"}

package/dist/core/api/channels.d.ts

@@ -0,0 +1,182 @@
+/**
+ * Channel commands.
+ *
+ * Channel settings are a wide, mostly-optional set. The options objects name
+ * them in camelCase without the `channel_` prefix (`codecQuality` for
+ * `channel_codec_quality`), and each options type has a table naming every
+ * field's wire parameter, so the mapping is written down once and a key the
+ * table does not know is never sent.
+ */
+import type { Channel, PermissionEntry } from "./command.js";
+import type { CommandExecutor, CommandOptions } from "../command/request.js";
+import type { ChannelID, ClientDBID } from "../command/ids.js";
+import type { Codec } from "../enums.js";
+import type { Permission } from "../permission.js";
+/**
+ * Channel settings, as `channelcreate` and `channeledit` take them.
+ *
+ * Only the fields you set are sent. An unset (undefined) field is omitted and
+ * leaves the setting alone; any other value is sent, so `""` sends an empty
+ * value — `password: ""` clears a channel's password, while leaving `password`
+ * unset keeps it.
+ */
+export interface ChannelSettings {
+    /** The topic shown under the name (`channel_topic`). */
+    readonly topic?: string | undefined;
+    /** The description (`channel_description`). */
+    readonly description?: string | undefined;
+    /**
+     * The channel password (`channel_password`), in cleartext: the voice client
+     * hashes it on the wire and ServerQuery sends it as is. `""` removes it.
+     */
+    readonly password?: string | undefined;
+    /**
+     * Whether the channel is password-protected (`channel_flag_password`). The
+     * server sets this itself when a password is set.
+     */
+    readonly hasPassword?: boolean | undefined;
+    /** The voice codec (`channel_codec`). */
+    readonly codec?: Codec | undefined;
+    /** The codec's quality, 0 to 10 (`channel_codec_quality`). */
+    readonly codecQuality?: number | undefined;
+    /** How many packets of voice to send at once, 1 to 10 (`channel_codec_latency_factor`). */
+    readonly codecLatencyFactor?: number | undefined;
+    /** Whether voice in the channel travels unencrypted (`channel_codec_is_unencrypted`). */
+    readonly isUnencrypted?: boolean | undefined;
+    /** How many clients may be in the channel (`channel_maxclients`). */
+    readonly maxClients?: number | undefined;
+    /**
+     * How many clients may be in the channel and those under it
+     * (`channel_maxfamilyclients`).
+     */
+    readonly maxFamilyClients?: number | undefined;
+    /** Whether `maxClients` is ignored (`channel_flag_maxclients_unlimited`). */
+    readonly isMaxClientsUnlimited?: boolean | undefined;
+    /** Whether `maxFamilyClients` is ignored (`channel_flag_maxfamilyclients_unlimited`). */
+    readonly isMaxFamilyClientsUnlimited?: boolean | undefined;
+    /**
+     * Whether the family limit is taken from the parent
+     * (`channel_flag_maxfamilyclients_inherited`).
+     */
+    readonly isMaxFamilyClientsInherited?: boolean | undefined;
+    /**
+     * The channel to sort this one after among its siblings; 0 sorts it first
+     * (`channel_order`).
+     */
+    readonly order?: ChannelID | undefined;
+    /** The talk power a client needs to speak here (`channel_needed_talk_power`). */
+    readonly neededTalkPower?: number | undefined;
+    /** Whether the channel survives a server restart (`channel_flag_permanent`). */
+    readonly isPermanent?: boolean | undefined;
+    /**
+     * Whether the channel survives its last client leaving, but not a restart
+     * (`channel_flag_semi_permanent`).
+     */
+    readonly isSemiPermanent?: boolean | undefined;
+    /** Whether new clients land here (`channel_flag_default`). */
+    readonly isDefault?: boolean | undefined;
+    /**
+     * How long a temporary channel survives its last client leaving, in
+     * milliseconds (`channel_delete_delay`). Sent in whole seconds.
+     */
+    readonly deleteDelayMs?: number | undefined;
+    /** How the name is pronounced, for text-to-speech (`channel_name_phonetic`). */
+    readonly namePhonetic?: string | undefined;
+}
+/** A new channel's settings. Only `name` is required; see {@link ChannelSettings}. */
+export interface ChannelCreateOptions extends ChannelSettings {
+    /** The channel's name (`channel_name`). */
+    readonly name: string;
+    /**
+     * The channel to create the new one under; unset or 0 is the top level, and
+     * either omits the parameter (`cpid`).
+     */
+    readonly parentID?: ChannelID | undefined;
+}
+/**
+ * Create a channel and return the id the server assigned.
+ *
+ * Over the voice protocol the server also moves the creator into the new
+ * channel.
+ *
+ * `channel` is what to send; the command's `signal` and `timeoutMs` go in
+ * `options`, a separate last argument — set among the fields, they are not
+ * read.
+ */
+export declare function createChannel(client: CommandExecutor, channel: ChannelCreateOptions, options?: CommandOptions): Promise<ChannelID>;
+/** A channel's changed settings; see {@link ChannelSettings}. */
+export interface ChannelEditOptions extends ChannelSettings {
+    /** The channel's new name (`channel_name`). */
+    readonly name?: string | undefined;
+}
+/**
+ * Change a channel's settings. Only the fields you set are sent.
+ *
+ * `settings` is what to send; the command's `signal` and `timeoutMs` go in
+ * `options`, a separate last argument — set among the fields, they are not
+ * read.
+ */
+export declare function editChannel(client: CommandExecutor, cid: ChannelID, settings: ChannelEditOptions, options?: CommandOptions): Promise<void>;
+/** How {@link deleteChannel} deletes. */
+export interface ChannelDeleteOptions extends CommandOptions {
+    /**
+     * Delete the channel even while clients are in it, moving them out; false
+     * by default, which the server then refuses for an occupied channel
+     * (`force`, always sent).
+     */
+    readonly force?: boolean | undefined;
+}
+/** Delete a channel. */
+export declare function deleteChannel(client: CommandExecutor, cid: ChannelID, options?: ChannelDeleteOptions): Promise<void>;
+/**
+ * All channels on the server, in the server's own sort order.
+ *
+ * Always asks for the topic, flags, voice, limits and icon, which a bare
+ * `channellist` leaves out. `description` and `uid` are not part of
+ * `channellist` and stay empty; `getChannelInfo` has them.
+ */
+export declare function listChannels(client: CommandExecutor, options?: CommandOptions): Promise<Channel[]>;
+/**
+ * One channel's full settings.
+ *
+ * `totalClients`, `totalFamilyClients` and `neededSubscribePower` are left
+ * undefined: `channelinfo` does not carry them. `listChannels` does.
+ *
+ * `channelinfo` answers with `pid` and the settings but no `cid` — the channel
+ * is whatever was asked for — so the id is taken from the argument rather than
+ * read from the row, where it would come back 0.
+ */
+export declare function getChannelInfo(client: CommandExecutor, cid: ChannelID, options?: CommandOptions): Promise<Channel>;
+/** A channel whose name matched a search. */
+export interface ChannelMatch {
+    /** The channel's id. */
+    readonly id: ChannelID;
+    /** The channel's name. */
+    readonly name: string;
+}
+/**
+ * Channels whose name contains `pattern`; none is an empty list. The server
+ * reports finding none as error 768 (invalid channelID), which this answers
+ * as `[]`.
+ */
+export declare function findChannels(client: CommandExecutor, pattern: string, options?: CommandOptions): Promise<ChannelMatch[]>;
+/** Where {@link moveChannel} sorts the channel among its new siblings. */
+export interface ChannelMoveOptions extends CommandOptions {
+    /** The sibling to sort after, 0 for first; unset leaves it to the server (`order`). */
+    readonly order?: ChannelID | undefined;
+}
+/** Move a channel under a new parent. */
+export declare function moveChannel(client: CommandExecutor, cid: ChannelID, parentID: ChannelID, options?: ChannelMoveOptions): Promise<void>;
+/** Set a permission on a channel. */
+export declare function addChannelPermission(client: CommandExecutor, cid: ChannelID, permission: Permission, value: number, options?: CommandOptions): Promise<void>;
+/** Remove a permission from a channel. */
+export declare function deleteChannelPermission(client: CommandExecutor, cid: ChannelID, permission: Permission, options?: CommandOptions): Promise<void>;
+/** Permissions set directly on a channel. */
+export declare function listChannelPermissions(client: CommandExecutor, cid: ChannelID, options?: CommandOptions): Promise<PermissionEntry[]>;
+/** Permissions granted to one client within one channel. */
+export declare function listChannelClientPermissions(client: CommandExecutor, cid: ChannelID, cldbid: ClientDBID, options?: CommandOptions): Promise<PermissionEntry[]>;
+/** Set a permission on one client within one channel. */
+export declare function addChannelClientPermission(client: CommandExecutor, cid: ChannelID, cldbid: ClientDBID, permission: Permission, value: number, options?: CommandOptions): Promise<void>;
+/** Remove a permission from one client within one channel. */
+export declare function deleteChannelClientPermission(client: CommandExecutor, cid: ChannelID, cldbid: ClientDBID, permission: Permission, options?: CommandOptions): Promise<void>;
+//# sourceMappingURL=channels.d.ts.map

package/dist/core/api/channels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channels.d.ts","sourceRoot":"","sources":["../../../src/core/api/channels.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAgBH,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAa,MAAM,cAAc,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAG/D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B,wDAAwD;IACxD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,+CAA+C;IAC/C,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,yCAAyC;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IACnC,8DAA8D;IAC9D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,2FAA2F;IAC3F,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjD,yFAAyF;IACzF,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,qEAAqE;IACrE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C,6EAA6E;IAC7E,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrD,yFAAyF;IACzF,QAAQ,CAAC,2BAA2B,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3D;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3D;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IACvC,iFAAiF;IACjF,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,gFAAgF;IAChF,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/C,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACzC;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,gFAAgF;IAChF,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5C;AAyBD,sFAAsF;AACtF,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CAC3C;AAQD;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,CAKpB;AAED,iEAAiE;AACjE,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,+CAA+C;IAC/C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAID;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAIf;AAED,yCAAyC;AACzC,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC;AAED,wBAAwB;AACxB,wBAAsB,aAAa,CACjC,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,IAAI,CAAC,CAUf;AAUD;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,EAAE,CAAC,CAEpB;AAED;;;;;;;;;GASG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC,CAGlB;AAED,6CAA6C;AAC7C,MAAM,WAAW,YAAY;IAC3B,wBAAwB;IACxB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC;IACvB,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,EAAE,CAAC,CAKzB;AAED,0EAA0E;AAC1E,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CACxC;AAED,yCAAyC;AACzC,wBAAsB,WAAW,CAC/B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,QAAQ,EAAE,SAAS,EACnB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAWf;AAID,qCAAqC;AACrC,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAOf;AAED,0CAA0C;AAC1C,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED,6CAA6C;AAC7C,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,EAAE,CAAC,CAE5B;AAED,4DAA4D;AAC5D,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,EAAE,CAAC,CAW5B;AAED,yDAAyD;AACzD,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAOf;AAED,8DAA8D;AAC9D,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAOf"}

package/dist/core/api/channels.js

@@ -0,0 +1,155 @@
+/**
+ * Channel commands.
+ *
+ * Channel settings are a wide, mostly-optional set. The options objects name
+ * them in camelCase without the `channel_` prefix (`codecQuality` for
+ * `channel_codec_quality`), and each options type has a table naming every
+ * field's wire parameter, so the mapping is written down once and a key the
+ * table does not know is never sent.
+ */
+import { nonZero, firstRow, exec, query, list, parseChannel, parsePermission, permissionParam, encodeFields, inSeconds, big, str, } from "./command.js";
+import { asChannelID } from "../command/ids.js";
+import { ErrorCode } from "../errorcode.js";
+const settingNames = {
+    topic: "channel_topic",
+    description: "channel_description",
+    password: "channel_password",
+    hasPassword: "channel_flag_password",
+    codec: "channel_codec",
+    codecQuality: "channel_codec_quality",
+    codecLatencyFactor: "channel_codec_latency_factor",
+    isUnencrypted: "channel_codec_is_unencrypted",
+    maxClients: "channel_maxclients",
+    maxFamilyClients: "channel_maxfamilyclients",
+    isMaxClientsUnlimited: "channel_flag_maxclients_unlimited",
+    isMaxFamilyClientsUnlimited: "channel_flag_maxfamilyclients_unlimited",
+    isMaxFamilyClientsInherited: "channel_flag_maxfamilyclients_inherited",
+    order: "channel_order",
+    neededTalkPower: "channel_needed_talk_power",
+    isPermanent: "channel_flag_permanent",
+    isSemiPermanent: "channel_flag_semi_permanent",
+    isDefault: "channel_flag_default",
+    deleteDelayMs: ["channel_delete_delay", inSeconds],
+    namePhonetic: "channel_name_phonetic",
+};
+const createNames = {
+    name: "channel_name",
+    parentID: ["cpid", nonZero],
+    ...settingNames,
+};
+/**
+ * Create a channel and return the id the server assigned.
+ *
+ * Over the voice protocol the server also moves the creator into the new
+ * channel.
+ *
+ * `channel` is what to send; the command's `signal` and `timeoutMs` go in
+ * `options`, a separate last argument — set among the fields, they are not
+ * read.
+ */
+export async function createChannel(client, channel, options) {
+    const rows = await query(client, "channelcreate", encodeFields(channel, createNames), options, [
+        "channel_password",
+    ]);
+    return asChannelID(big(firstRow(rows, "channelcreate", "cid"), "cid"));
+}
+const editNames = { name: "channel_name", ...settingNames };
+/**
+ * Change a channel's settings. Only the fields you set are sent.
+ *
+ * `settings` is what to send; the command's `signal` and `timeoutMs` go in
+ * `options`, a separate last argument — set among the fields, they are not
+ * read.
+ */
+export async function editChannel(client, cid, settings, options) {
+    await exec(client, "channeledit", [["cid", cid], ...encodeFields(settings, editNames)], options, [
+        "channel_password",
+    ]);
+}
+/** Delete a channel. */
+export async function deleteChannel(client, cid, options = {}) {
+    await exec(client, "channeldelete", [
+        ["cid", cid],
+        ["force", options.force ?? false],
+    ], options);
+}
+const listFlags = [
+    ["-topic", true],
+    ["-flags", true],
+    ["-voice", true],
+    ["-limits", true],
+    ["-icon", true],
+];
+/**
+ * All channels on the server, in the server's own sort order.
+ *
+ * Always asks for the topic, flags, voice, limits and icon, which a bare
+ * `channellist` leaves out. `description` and `uid` are not part of
+ * `channellist` and stay empty; `getChannelInfo` has them.
+ */
+export async function listChannels(client, options) {
+    return (await list(client, "channellist", listFlags, options)).map(parseChannel);
+}
+/**
+ * One channel's full settings.
+ *
+ * `totalClients`, `totalFamilyClients` and `neededSubscribePower` are left
+ * undefined: `channelinfo` does not carry them. `listChannels` does.
+ *
+ * `channelinfo` answers with `pid` and the settings but no `cid` — the channel
+ * is whatever was asked for — so the id is taken from the argument rather than
+ * read from the row, where it would come back 0.
+ */
+export async function getChannelInfo(client, cid, options) {
+    const rows = await query(client, "channelinfo", [["cid", cid]], options);
+    return { ...parseChannel(firstRow(rows, "channelinfo")), id: cid };
+}
+/**
+ * Channels whose name contains `pattern`; none is an empty list. The server
+ * reports finding none as error 768 (invalid channelID), which this answers
+ * as `[]`.
+ */
+export async function findChannels(client, pattern, options) {
+    const rows = await list(client, "channelfind", [["pattern", pattern]], options, {
+        noMatch: ErrorCode.ChannelInvalidID,
+    });
+    return rows.map((row) => ({ id: asChannelID(big(row, "cid")), name: str(row, "channel_name") }));
+}
+/** Move a channel under a new parent. */
+export async function moveChannel(client, cid, parentID, options = {}) {
+    await exec(client, "channelmove", [
+        ["cid", cid],
+        ["cpid", parentID],
+        ["order", options.order],
+    ], options);
+}
+// ---- Channel permissions ----------------------------------------------------
+/** Set a permission on a channel. */
+export async function addChannelPermission(client, cid, permission, value, options) {
+    await exec(client, "channeladdperm", [["cid", cid], permissionParam(permission), ["permvalue", value]], options);
+}
+/** Remove a permission from a channel. */
+export async function deleteChannelPermission(client, cid, permission, options) {
+    await exec(client, "channeldelperm", [["cid", cid], permissionParam(permission)], options);
+}
+/** Permissions set directly on a channel. */
+export async function listChannelPermissions(client, cid, options) {
+    return (await list(client, "channelpermlist", [["cid", cid]], options)).map(parsePermission);
+}
+/** Permissions granted to one client within one channel. */
+export async function listChannelClientPermissions(client, cid, cldbid, options) {
+    const rows = await list(client, "channelclientpermlist", [
+        ["cid", cid],
+        ["cldbid", cldbid],
+    ], options);
+    return rows.map(parsePermission);
+}
+/** Set a permission on one client within one channel. */
+export async function addChannelClientPermission(client, cid, cldbid, permission, value, options) {
+    await exec(client, "channelclientaddperm", [["cid", cid], ["cldbid", cldbid], permissionParam(permission), ["permvalue", value]], options);
+}
+/** Remove a permission from one client within one channel. */
+export async function deleteChannelClientPermission(client, cid, cldbid, permission, options) {
+    await exec(client, "channelclientdelperm", [["cid", cid], ["cldbid", cldbid], permissionParam(permission)], options);
+}
+//# sourceMappingURL=channels.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"channels.js","sourceRoot":"","sources":["../../../src/core/api/channels.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EACL,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,YAAY,EACZ,eAAe,EACf,eAAe,EACf,YAAY,EACZ,SAAS,EACT,GAAG,EACH,GAAG,GACJ,MAAM,cAAc,CAAC;AAItB,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AA4E5C,MAAM,YAAY,GAA+B;IAC/C,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,qBAAqB;IAClC,QAAQ,EAAE,kBAAkB;IAC5B,WAAW,EAAE,uBAAuB;IACpC,KAAK,EAAE,eAAe;IACtB,YAAY,EAAE,uBAAuB;IACrC,kBAAkB,EAAE,8BAA8B;IAClD,aAAa,EAAE,8BAA8B;IAC7C,UAAU,EAAE,oBAAoB;IAChC,gBAAgB,EAAE,0BAA0B;IAC5C,qBAAqB,EAAE,mCAAmC;IAC1D,2BAA2B,EAAE,yCAAyC;IACtE,2BAA2B,EAAE,yCAAyC;IACtE,KAAK,EAAE,eAAe;IACtB,eAAe,EAAE,2BAA2B;IAC5C,WAAW,EAAE,wBAAwB;IACrC,eAAe,EAAE,6BAA6B;IAC9C,SAAS,EAAE,sBAAsB;IACjC,aAAa,EAAE,CAAC,sBAAsB,EAAE,SAAS,CAAC;IAClD,YAAY,EAAE,uBAAuB;CACtC,CAAC;AAaF,MAAM,WAAW,GAAoC;IACnD,IAAI,EAAE,cAAc;IACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3B,GAAG,YAAY;CAChB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAuB,EACvB,OAA6B,EAC7B,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,eAAe,EAAE,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,OAAO,EAAE;QAC7F,kBAAkB;KACnB,CAAC,CAAC;IACH,OAAO,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;AACzE,CAAC;AAQD,MAAM,SAAS,GAAkC,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,YAAY,EAAE,CAAC;AAE3F;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAuB,EACvB,GAAc,EACd,QAA4B,EAC5B,OAAwB;IAExB,MAAM,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,YAAY,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE;QAC/F,kBAAkB;KACnB,CAAC,CAAC;AACL,CAAC;AAYD,wBAAwB;AACxB,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAuB,EACvB,GAAc,EACd,OAAO,GAAyB,EAAE;IAElC,MAAM,IAAI,CACR,MAAM,EACN,eAAe,EACf;QACE,CAAC,KAAK,EAAE,GAAG,CAAC;QACZ,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;KAClC,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED,MAAM,SAAS,GAA2C;IACxD,CAAC,QAAQ,EAAE,IAAI,CAAC;IAChB,CAAC,QAAQ,EAAE,IAAI,CAAC;IAChB,CAAC,QAAQ,EAAE,IAAI,CAAC;IAChB,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,OAAO,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuB,EACvB,OAAwB;IAExB,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AACnF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAuB,EACvB,GAAc,EACd,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,OAAO,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC;AACrE,CAAC;AAUD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuB,EACvB,OAAe,EACf,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE;QAC9E,OAAO,EAAE,SAAS,CAAC,gBAAgB;KACpC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;AACnG,CAAC;AAQD,yCAAyC;AACzC,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAuB,EACvB,GAAc,EACd,QAAmB,EACnB,OAAO,GAAuB,EAAE;IAEhC,MAAM,IAAI,CACR,MAAM,EACN,aAAa,EACb;QACE,CAAC,KAAK,EAAE,GAAG,CAAC;QACZ,CAAC,MAAM,EAAE,QAAQ,CAAC;QAClB,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;KACzB,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED,gFAAgF;AAEhF,qCAAqC;AACrC,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAuB,EACvB,GAAc,EACd,UAAsB,EACtB,KAAa,EACb,OAAwB;IAExB,MAAM,IAAI,CACR,MAAM,EACN,gBAAgB,EAChB,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,EACjE,OAAO,CACR,CAAC;AACJ,CAAC;AAED,0CAA0C;AAC1C,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,MAAuB,EACvB,GAAc,EACd,UAAsB,EACtB,OAAwB;IAExB,MAAM,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AAC7F,CAAC;AAED,6CAA6C;AAC7C,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAuB,EACvB,GAAc,EACd,OAAwB;IAExB,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;AAC/F,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,MAAuB,EACvB,GAAc,EACd,MAAkB,EAClB,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CACrB,MAAM,EACN,uBAAuB,EACvB;QACE,CAAC,KAAK,EAAE,GAAG,CAAC;QACZ,CAAC,QAAQ,EAAE,MAAM,CAAC;KACnB,EACD,OAAO,CACR,CAAC;IACF,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;AACnC,CAAC;AAED,yDAAyD;AACzD,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,MAAuB,EACvB,GAAc,EACd,MAAkB,EAClB,UAAsB,EACtB,KAAa,EACb,OAAwB;IAExB,MAAM,IAAI,CACR,MAAM,EACN,sBAAsB,EACtB,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,EACrF,OAAO,CACR,CAAC;AACJ,CAAC;AAED,8DAA8D;AAC9D,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,MAAuB,EACvB,GAAc,EACd,MAAkB,EAClB,UAAsB,EACtB,OAAwB;IAExB,MAAM,IAAI,CACR,MAAM,EACN,sBAAsB,EACtB,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,EAC/D,OAAO,CACR,CAAC;AACJ,CAAC"}