@stoatx/client 0.7.0 → 0.9.0

package/dist/index.d.cts

@@ -1,9 +1,12 @@
 import { EventEmitter } from 'events';
-import { APIRoutes, File, User as User$1, Member as Member$1, Channel, Message as Message$1, Role as Role$1, Invite, ServerBan as ServerBan$1, Server as Server$1, Emoji as Emoji$1, Category, Embed } from 'stoat-api';
+import { APIRoutes, File, User as User$1, FieldsUser, Member as Member$1, Channel, FieldsChannel, Message as Message$1, Role as Role$1, FieldsRole, Invite, ServerBan as ServerBan$1, Server as Server$1, Emoji as Emoji$1, AuditLogEntryAction, AuditLogEntry as AuditLogEntry$1, Category, FieldsServer, FieldsMember, Embed } from 'stoat-api';
 import * as stoatApi from 'stoat-api';
 export { stoatApi as API };
 import * as util from 'node:util';
 import util__default from 'node:util';
+import { Readable } from 'node:stream';
+import { EventEmitter as EventEmitter$1 } from 'node:events';
+export { decodeTime } from 'ulid';
 
 declare class GatewayManager {
     private client;
@@ -184,8 +187,11 @@ declare class User extends Base {
     flags?: number;
     privileged?: boolean;
     status?: UserStatus | null;
+    createdAt: Date;
+    createdTimestamp: number;
+    pronouns?: string | null;
     constructor(client: Client, data: User$1);
-    _patch(data: User$1, clear?: string[]): void;
+    _patch(data: User$1, clear?: FieldsUser[]): void;
     /**
      * Convenience getter to return the user's tag (username#discriminator)
      */
@@ -241,8 +247,9 @@ declare class Collection<K, V> extends Map<K, V> {
 /**
  * @template K The type of the cache keys (usually string)
  * @template Holds The type of the Structure this manager holds
+ * @template RawData The raw API/gateway payload shape used to construct/patch `Holds`
  */
-declare abstract class BaseManager<K, Holds> {
+declare abstract class BaseManager<K, Holds, RawData = unknown> {
     cache: Collection<K, Holds>;
     client: Client;
     protected constructor(client: Client, limit?: number);
@@ -250,17 +257,18 @@ declare abstract class BaseManager<K, Holds> {
      * Defines how to extract the unique ID from a raw API payload.
      * @internal
      */
-    protected abstract extractId(data: any): K;
+    protected abstract extractId(data: RawData): K;
     /**
      * Defines how to construct a new instance of the Structure.
      * @internal
      */
-    protected abstract construct(data: any): Holds;
+    protected abstract construct(data: RawData): Holds;
     /**
      * Transforms raw data into a Structure, patches if existing, and saves to cache.
      * @internal
      */
-    _add(data: any): Holds;
+    _add(data: RawData): Holds;
+    private isPatchable;
 }
 
 type MemberResolvable = Member | User | string;
@@ -278,7 +286,7 @@ interface FetchMembersOptions {
     /** Whether to exclude offline users from the fetch */
     excludeOffline?: boolean;
 }
-declare class MemberManager extends BaseManager<string, Member> {
+declare class MemberManager extends BaseManager<string, Member, Member$1> {
     server: Server;
     constructor(client: Client, server: Server, limit?: number);
     /**
@@ -579,8 +587,10 @@ declare class GroupChannel extends BaseChannel {
     icon: Attachment | null;
     lastMessageId?: string | null;
     nsfw: boolean;
+    createdAt: Date;
+    createdTimestamp: number;
     constructor(client: Client, data: RawGroupChannel);
-    _patch(data: RawGroupChannel, clear?: string[]): void;
+    _patch(data: RawGroupChannel, clear?: FieldsChannel[]): void;
     /** Gets the User object of the person who owns this group */
     get owner(): User | undefined;
     /** Resolves the recipient IDs into an array of cached User objects */
@@ -606,7 +616,7 @@ interface UserEditOptions {
     profile?: UserProfile;
     status?: UserStatus;
 }
-declare class UserManager extends BaseManager<string, User> {
+declare class UserManager extends BaseManager<string, User, User$1> {
     constructor(client: Client, limit?: number);
     /**
      * Tell BaseManager how to find the ID for Users
@@ -709,7 +719,7 @@ interface MessageFetchOptions {
     nearby?: string;
     includeUsers?: boolean;
 }
-declare class MessageManager extends BaseManager<string, Message> {
+declare class MessageManager extends BaseManager<string, Message, Message$1> {
     channel: BaseChannel;
     constructor(client: Client, channel: BaseChannel, limit?: number);
     /**
@@ -819,7 +829,7 @@ interface ChannelRolePermissionOptions {
     allow?: PermissionResolvable;
     deny?: PermissionResolvable;
 }
-declare class ChannelManager extends BaseManager<string, BaseChannel> {
+declare class ChannelManager extends BaseManager<string, BaseChannel, Channel> {
     /**
      * Manages API methods and caching for all channels globally.
      * @param client The active Client instance.
@@ -947,8 +957,10 @@ declare class TextChannel extends BaseChannel {
     nsfw?: boolean;
     slowmode?: number;
     voice?: any;
+    createdAt: Date;
+    createdTimestamp: number;
     constructor(client: Client, data: RawTextChannel);
-    _patch(data: RawTextChannel, clear?: string[]): void;
+    _patch(data: RawTextChannel, clear?: FieldsChannel[]): void;
     /**
      * Updates the permission overrides for the channel.
      * @param roleId The raw string ID of the role to update.
@@ -1142,6 +1154,82 @@ declare class MessageCollector extends Collector<string, Message> {
     endReason(): string | null;
 }
 
+interface AudioResourceOptions {
+    volume?: number;
+    inputType?: string;
+}
+type AudioSource = string | Readable;
+declare class AudioResource {
+    readonly stream: Readable;
+    private constructor();
+    static from(source: AudioSource, options?: AudioResourceOptions): AudioResource;
+}
+
+type AudioPlayerStatus = "idle" | "buffering" | "playing" | "paused" | "stopped";
+interface AudioPlayerEvents {
+    stateChange: [oldStatus: AudioPlayerStatus, newStatus: AudioPlayerStatus];
+    idle: [];
+    error: [error: Error];
+}
+declare class AudioPlayer extends EventEmitter$1<AudioPlayerEvents> {
+    private _status;
+    private _resource;
+    /** Registered VoiceConnections subscribed to this player */
+    private readonly subscribers;
+    get status(): AudioPlayerStatus;
+    get resource(): AudioResource | null;
+    play(resource: AudioResource): void;
+    pause(): void;
+    resume(): void;
+    stop(): void;
+    /** @internal */
+    addSubscriber(conn: VoiceConnection): void;
+    /** @internal */
+    removeSubscriber(conn: VoiceConnection): void;
+    private feed;
+    private transition;
+}
+
+interface VoiceConnectionEvents {
+    ready: [];
+    disconnect: [];
+    error: [error: Error];
+}
+type VoiceConnectionStatus = "connecting" | "ready" | "disconnecting" | "disconnected";
+declare class VoiceConnection extends EventEmitter$1<VoiceConnectionEvents> {
+    readonly channelId: string;
+    readonly guildId: string | undefined;
+    private readonly room;
+    private _status;
+    private _player;
+    private _audioSource;
+    private _audioTrack;
+    constructor(channelId: string, guildId?: string);
+    get status(): VoiceConnectionStatus;
+    get player(): AudioPlayer | null;
+    /** @internal */
+    connect(url: string, token: string): Promise<void>;
+    subscribe(player: AudioPlayer): void;
+    unsubscribe(): void;
+    _feedStream(stream: Readable): Promise<void>;
+    disconnect(): Promise<void>;
+}
+
+declare class VoiceManager {
+    private readonly connections;
+    private readonly client;
+    constructor(client: Client);
+    join(channelId: string, guildId?: string): Promise<VoiceConnection>;
+    get(channelId: string): VoiceConnection | undefined;
+    leave(channelId: string): Promise<void>;
+    leaveAll(): Promise<void>;
+}
+
+declare class VoiceChannel extends TextChannel {
+    join(): Promise<VoiceConnection>;
+    leave(): Promise<void>;
+}
+
 type ChannelType = "SavedMessages" | "DirectMessage" | "Group" | "TextChannel";
 interface ChannelCreateOptions {
     name: string;
@@ -1249,6 +1337,7 @@ declare abstract class BaseChannel extends Base {
     isText(): this is TextChannel;
     isDM(): this is DMChannel;
     isGroup(): this is GroupChannel;
+    isVoice(): this is VoiceChannel;
 }
 
 declare class ServerChannelManager {
@@ -1273,12 +1362,14 @@ declare class Role extends Base {
     rank: number;
     icon: Attachment | null;
     private _permissions;
+    createdAt: Date;
+    createdTimestamp: number;
     constructor(client: Client, data: Role$1, serverId: string);
     /**
      * Updates the role instance with new data without losing the object reference.
      * @internal
      */
-    _patch(data: Role$1): void;
+    _patch(data: Role$1, clear?: FieldsRole[]): void;
     /**
      * The server this role belongs to.
      * Pulls dynamically from the cache to prevent massive memory duplication.
@@ -1428,7 +1519,7 @@ interface RolePermissionOptions {
     deny?: PermissionResolvable;
 }
 type RoleResolvable = Role | string;
-declare class RoleManager extends BaseManager<string, Role> {
+declare class RoleManager extends BaseManager<string, Role, Role$1> {
     server: Server;
     /**
      * Manages API methods and caching for server roles.
@@ -1568,7 +1659,7 @@ declare class ServerInvite {
     _patch(data: Invite): void;
 }
 
-declare class ServerInviteManager extends BaseManager<string, ServerInvite> {
+declare class ServerInviteManager extends BaseManager<string, ServerInvite, Invite> {
     server: Server;
     constructor(client: Client, server: Server, limit?: number);
     protected extractId(data: Invite): string;
@@ -1586,11 +1677,11 @@ declare class ServerBan {
     _patch(data: ServerBan$1): void;
 }
 
-declare class ServerBanManager extends BaseManager<string, ServerBan> {
+declare class ServerBanManager extends BaseManager<string, ServerBan, ServerBan$1> {
     server: Server;
     constructor(client: Client, server: Server, limit?: number);
-    protected extractId(data: any): string;
-    protected construct(data: any): ServerBan;
+    protected extractId(data: ServerBan$1): string;
+    protected construct(data: ServerBan$1): ServerBan;
     /**
      * Fetches all bans in this server.
      * Automatically caches the associated User objects globally!
@@ -1623,7 +1714,7 @@ interface ServerEditOptions {
     analytics?: boolean;
     owner?: string;
 }
-declare class ServerManager extends BaseManager<string, Server> {
+declare class ServerManager extends BaseManager<string, Server, Server$1> {
     constructor(client: Client, limit?: number);
     /**
      * Tell BaseManager how to find the ID for Servers
@@ -1653,6 +1744,8 @@ declare class Emoji extends Base {
     creatorId: string;
     name: string;
     parent: EmojiParent;
+    createdAt: Date;
+    createdTimestamp: number;
     animated: boolean;
     nsfw: boolean;
     constructor(client: Client, data: Emoji$1);
@@ -1697,7 +1790,7 @@ interface EmojiEditOptions {
     name: string;
 }
 type EmojiResolvable = string | Emoji;
-declare class EmojiManager extends BaseManager<string, Emoji> {
+declare class EmojiManager extends BaseManager<string, Emoji, Emoji$1> {
     server?: Server | undefined;
     constructor(client: Client, server?: Server | undefined, limit?: number);
     /**
@@ -1763,6 +1856,40 @@ declare class EmojiManager extends BaseManager<string, Emoji> {
     [util.inspect.custom](): Collection<string, Emoji>;
 }
 
+declare class AuditLogEntry extends Base {
+    serverId: string;
+    userId: string;
+    targetId: string | null;
+    reason: string | null;
+    action: AuditLogEntryAction;
+    constructor(client: Client, data: AuditLogEntry$1);
+    /** The action tag, e.g. "ChannelEdit" — narrow `entry.action` on this. */
+    get type(): AuditLogEntryAction["type"];
+    get server(): Server | undefined;
+    /** The user who performed this action, if cached. */
+    get executor(): User | undefined;
+    /**
+     * Best-effort resolve of `targetId` into the actual entity, picked by
+     * `action.type` since a bare id alone doesn't say whether it's a member,
+     * a role, a channel, etc.
+     */
+    get target(): User | Member | unknown | undefined;
+    /**
+     * Customizer for Node.js `console.log` and `util.inspect`.
+     * Hides the cyclic client reference for a cleaner output.
+     * @internal
+     */
+    [util.inspect.custom](): string;
+}
+
+interface FetchAuditLogsOptions {
+    user?: string;
+    target?: string;
+    type?: string[];
+    before?: string;
+    after?: string;
+    limit?: number;
+}
 declare class Server extends Base {
     channelIds: string[];
     defaultPermissions: bigint;
@@ -1782,11 +1909,13 @@ declare class Server extends Base {
     bans: ServerBanManager;
     invites: ServerInviteManager;
     emojis: EmojiManager;
+    createdAt: Date;
+    createdTimestamp: number;
     constructor(client: Client, data: Server$1);
     /**
      * Updates the server instance with new data without losing the object reference.
      */
-    _patch(data: Server$1, clear?: string[]): void;
+    _patch(data: Server$1, clear?: FieldsServer[]): void;
     /**
      * Edits this server.
      * @param options The fields to update.
@@ -1796,6 +1925,11 @@ declare class Server extends Base {
      * Leaves the server
      */
     leave(): Promise<never>;
+    /**
+     * Fetch audit logs for this server
+     * @param options Query params
+     */
+    fetchAuditLogs(options?: FetchAuditLogsOptions): Promise<Collection<string, AuditLogEntry>>;
     /**
      * Fetches multiple members from this server.
      * @param options Filter options for the fetch request.
@@ -1849,12 +1983,14 @@ declare class Member extends Base {
     /** @internal */
     private _roles;
     joinedAt: Date;
+    joinedTimestamp: number;
     timeout: Date | null;
     canPublish: boolean;
     canRecieve: boolean;
     roles: MemberRoleManager;
+    pronouns?: string | null;
     constructor(client: Client, data: Member$1, serverId?: string);
-    _patch(data: Member$1): void;
+    _patch(data: Member$1, clear?: FieldsMember[]): void;
     /**
      * Get member role IDs
      */
@@ -2056,7 +2192,8 @@ declare class Message extends Base {
     embeds: Embed[] | null;
     attachments: Attachment[];
     editedAt: Date | null;
-    createdAt: Date | null;
+    createdAt: Date;
+    createdTimestamp: number;
     flags: number;
     interactions: Interaction | null;
     masquerade: Masquerade | null;
@@ -2241,6 +2378,7 @@ declare class Client extends EventEmitter {
     emojis: EmojiManager;
     user: ClientUser | null;
     options: ClientOptions;
+    readonly voice: VoiceManager;
     constructor(options?: ClientOptions);
     /**
      * Connects the bot to the Stoat Gateway
@@ -2259,4 +2397,4 @@ declare class UnknownChannel extends BaseChannel {
     constructor(client: Client, data: Channel);
 }
 
-export { Attachment, AttachmentBuilder, type AttachmentMetadata, Base, BaseChannel, BitField, type BitFieldResolvable, type BotInformation, type CDNTag, type ChannelCreateOptions, type ChannelEditOptions, ChannelManager, type ChannelResolvable, type ChannelRolePermissionOptions, type ChannelType, Client, type ClientEvents, type ClientOptions, ClientUser, Collection, Collector, type CollectorOptions, DMChannel, EmbedBuilder, Emoji, type EmojiCreateOptions, type EmojiEditOptions, EmojiManager, type EmojiParent, type EmojiResolvable, type FetchMembersOptions, GatewayManager, GroupChannel, type Interaction, type Masquerade, Member, type MemberBanOptions, type MemberEditOptions, MemberManager, type MemberResolvable, Message, MessageCollector, type MessageCollectorOptions, type MessageFetchOptions, MessageManager, type MessageOptions, MessageReaction, type MessageResolvable, PermissionFlags, type PermissionResolvable, type PermissionString, Permissions, RESTManager, type RawDMChannel, type RawGroupChannel, type RawTextChannel, ReactionCollector, type ReactionCollectorOptions, type ReplyIntent, Role, type RoleCreateOptions, type RoleEditOptions, RoleManager, type RolePermissionOptions, type RoleResolvable, Server, ServerChannelManager, type ServerEditOptions, ServerManager, StoatAPIError, SweeperManager, type SweeperOptions, TextChannel, type TextEmbedData, UnknownChannel, User, type UserEditOptions, UserManager, type UserPresence, type UserProfile, type UserRelationShip, type UserResolvable, type UserStatus };
+export { Attachment, AttachmentBuilder, type AttachmentMetadata, AudioPlayer, type AudioPlayerEvents, type AudioPlayerStatus, AudioResource, type AudioResourceOptions, type AudioSource, Base, BaseChannel, BitField, type BitFieldResolvable, type BotInformation, type CDNTag, type ChannelCreateOptions, type ChannelEditOptions, ChannelManager, type ChannelResolvable, type ChannelRolePermissionOptions, type ChannelType, Client, type ClientEvents, type ClientOptions, ClientUser, Collection, Collector, type CollectorOptions, DMChannel, EmbedBuilder, Emoji, type EmojiCreateOptions, type EmojiEditOptions, EmojiManager, type EmojiParent, type EmojiResolvable, type FetchAuditLogsOptions, type FetchMembersOptions, GatewayManager, GroupChannel, type Interaction, type Masquerade, Member, type MemberBanOptions, type MemberEditOptions, MemberManager, type MemberResolvable, Message, MessageCollector, type MessageCollectorOptions, type MessageFetchOptions, MessageManager, type MessageOptions, MessageReaction, type MessageResolvable, PermissionFlags, type PermissionResolvable, type PermissionString, Permissions, RESTManager, type RawDMChannel, type RawGroupChannel, type RawTextChannel, ReactionCollector, type ReactionCollectorOptions, type ReplyIntent, Role, type RoleCreateOptions, type RoleEditOptions, RoleManager, type RolePermissionOptions, type RoleResolvable, Server, ServerChannelManager, type ServerEditOptions, ServerManager, StoatAPIError, SweeperManager, type SweeperOptions, TextChannel, type TextEmbedData, UnknownChannel, User, type UserEditOptions, UserManager, type UserPresence, type UserProfile, type UserRelationShip, type UserResolvable, type UserStatus, VoiceConnection, type VoiceConnectionEvents, type VoiceConnectionStatus, VoiceManager };