@stoatx/client 0.4.0 → 0.6.0

package/dist/index.d.cts

@@ -1,5 +1,9 @@
 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 * as stoatApi from 'stoat-api';
+export { stoatApi as API };
 import * as util from 'node:util';
+import util__default from 'node:util';
 
 declare class GatewayManager {
     private client;
@@ -40,6 +44,18 @@ declare class AttachmentBuilder {
     upload(rest: RESTManager, tag: CDNTag): Promise<string>;
 }
 
+type ValidPath<M extends APIRoutes["method"]> = Extract<APIRoutes, {
+    method: M;
+}>["path"];
+type RouteResponse<M extends APIRoutes["method"], P extends string> = Extract<APIRoutes, {
+    method: M;
+    path: P;
+}>["response"];
+type RouteParams<M extends APIRoutes["method"], P extends string> = Extract<APIRoutes, {
+    method: M;
+    path: P;
+}>["params"];
+
 /**
  * Custom Error class for Stoat API failures
  */
@@ -63,17 +79,17 @@ declare class RESTManager {
      * Generates a local identifier for the bucket based on method and path.
      */
     private getRouteKey;
-    makeRequest(method: string, endpoint: string, body?: any): Promise<any>;
+    makeRequest<M extends APIRoutes["method"], P extends ValidPath<M>>(method: M, endpoint: P, params?: RouteParams<M, P>): Promise<RouteResponse<M, P>>;
     private execute;
     /**
      * Uploads a file to Stoat's CDN and returns the File ID
      */
     uploadFile(tag: CDNTag, fileBuffer: Buffer | Blob, filename?: string): Promise<string>;
-    get(endpoint: string): Promise<any>;
-    post(endpoint: string, body?: any): Promise<any>;
-    patch(endpoint: string, body?: any): Promise<any>;
-    delete(endpoint: string, body?: any): Promise<any>;
-    put(endpoint: string, body?: any): Promise<any>;
+    get<P extends ValidPath<"get">>(endpoint: P, params?: RouteParams<"get", P>): Promise<RouteResponse<"get", P>>;
+    post<P extends ValidPath<"post">>(endpoint: P, params?: RouteParams<"post", P>): Promise<RouteResponse<"post", P>>;
+    patch<P extends ValidPath<"patch">>(endpoint: P, params?: RouteParams<"patch", P>): Promise<RouteResponse<"patch", P>>;
+    delete<P extends ValidPath<"delete">>(endpoint: P, params?: RouteParams<"delete", P>): Promise<RouteResponse<"delete", P>>;
+    put<P extends ValidPath<"put">>(endpoint: P, params?: RouteParams<"put", P>): Promise<RouteResponse<"put", P>>;
 }
 
 /**
@@ -83,7 +99,7 @@ declare abstract class Base {
     readonly id: string;
     cachedAt: number;
     protected readonly client: Client;
-    constructor(client: Client, data: {
+    protected constructor(client: Client, data: {
         _id: string;
     });
     /**
@@ -110,8 +126,8 @@ type AttachmentMetadata = {
     type: "Image";
     width: number;
     height: number;
-    thumbhash?: number[];
-    animated?: boolean;
+    thumbhash?: number[] | null;
+    animated?: boolean | null;
 } | {
     type: "Video";
     width: number;
@@ -126,11 +142,11 @@ declare class Attachment extends Base {
     size: number;
     deleted?: boolean;
     reported?: boolean;
-    messageId?: string;
-    userId?: string;
-    serverId?: string;
-    objectId?: string;
-    constructor(client: Client, data: any);
+    messageId?: string | null | undefined;
+    userId?: string | null | undefined;
+    serverId?: string | null | undefined;
+    objectId?: string | null | undefined;
+    constructor(client: Client, data: File);
     /**
      * Automatically constructs the direct CDN URL for this file
      */
@@ -141,29 +157,12 @@ declare class Attachment extends Base {
     get isImage(): boolean;
 }
 
-declare enum UserRelationship {
-    None = "None",
-    User = "User",
-    Friend = "Friend",
-    Outgoing = "Outgoing",
-    Incoming = "Incoming",
-    Blocked = "Blocked",
-    BlockedOther = "BlockedOther"
-}
-declare enum UserPresence {
-    Online = "Online",
-    Idle = "Idle",
-    Focus = "Focus",
-    Busy = "Busy",
-    Invisible = "Invisible"
-}
+type UserRelationShip = "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
 interface BotInformation {
     owner: string;
 }
-interface UserStatus {
-    presence: UserPresence;
-    text?: string | null;
-}
+type UserStatus = NonNullable<User$1["status"]>;
+type UserPresence = NonNullable<UserStatus["presence"]>;
 interface UserProfile {
     background?: string | null;
     content?: string | null;
@@ -171,7 +170,7 @@ interface UserProfile {
 declare class User extends Base {
     discriminator: string;
     online: boolean;
-    relationship: UserRelationship;
+    relationship: UserRelationShip;
     username: string;
     avatar?: Attachment | null;
     badges?: number;
@@ -180,8 +179,8 @@ declare class User extends Base {
     flags?: number;
     privileged?: boolean;
     status?: UserStatus | null;
-    constructor(client: Client, data: any);
-    _patch(data: any, clear?: string[]): void;
+    constructor(client: Client, data: User$1);
+    _patch(data: User$1, clear?: string[]): void;
     /**
      * Convenience getter to return the user's tag (username#discriminator)
      */
@@ -271,7 +270,8 @@ interface MemberBanOptions {
     deleteMessageSeconds?: number;
 }
 interface FetchMembersOptions {
-    exclude_offline?: boolean;
+    /** Whether to exclude offline users from the fetch */
+    excludeOffline?: boolean;
 }
 declare class MemberManager extends BaseManager<string, Member> {
     server: Server;
@@ -280,12 +280,12 @@ declare class MemberManager extends BaseManager<string, Member> {
      * Tell BaseManager how to handle Revolt's Member IDs
      * @internal
      */
-    protected extractId(data: any): string;
+    protected extractId(data: Member$1): string;
     /**
      * Tell BaseManager how to build a Member
      * @internal
      */
-    protected construct(data: any): Member;
+    protected construct(data: Member$1): Member;
     /**
      * Resolve a string or mention to Member
      * @param member The MemberResolvable to resolve
@@ -552,14 +552,20 @@ declare class Permissions extends BitField {
     remove(...bits: PermissionResolvable[]): this;
 }
 
+type RawDMChannel = Extract<Channel, {
+    channel_type: "DirectMessage";
+}>;
 declare class DMChannel extends BaseChannel {
     active: boolean;
     recipients: string[];
     lastMessageId: string | null;
-    constructor(client: any, data: any);
-    _patch(data: any): void;
+    constructor(client: Client, data: RawDMChannel);
+    _patch(data: RawDMChannel): void;
 }
 
+type RawGroupChannel = Extract<Channel, {
+    channel_type: "Group";
+}>;
 declare class GroupChannel extends BaseChannel {
     name: string;
     ownerId: string;
@@ -568,8 +574,8 @@ declare class GroupChannel extends BaseChannel {
     icon: Attachment | null;
     lastMessageId?: string | null;
     nsfw: boolean;
-    constructor(client: Client, data: any);
-    _patch(data: any, clear?: string[]): void;
+    constructor(client: Client, data: RawGroupChannel);
+    _patch(data: RawGroupChannel, clear?: string[]): 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 */
@@ -600,11 +606,11 @@ declare class UserManager extends BaseManager<string, User> {
     /**
      * Tell BaseManager how to find the ID for Users
      */
-    protected extractId(data: any): string;
+    protected extractId(data: User$1): string;
     /**
      * Tell BaseManager how to build a User
      */
-    protected construct(data: any): User;
+    protected construct(data: User$1): User;
     /**
      * Resolves a UserResolvable to a User object from the cache.
      */
@@ -704,11 +710,11 @@ declare class MessageManager extends BaseManager<string, Message> {
     /**
      * Tell BaseManager how to find the ID for Messages
      */
-    protected extractId(data: any): string;
+    protected extractId(data: Message$1): string;
     /**
      * Tell BaseManager how to build a Message
      */
-    protected construct(data: any): Message;
+    protected construct(data: Message$1): Message;
     fetch(id: string): Promise<Message>;
     /**
      * Fetches multiple messages from the channel using specific filter parameters.
@@ -815,8 +821,8 @@ declare class ChannelManager extends BaseManager<string, BaseChannel> {
      * @param limit The maximum number of channels to hold in the cache.
      */
     constructor(client: Client, limit?: number);
-    protected extractId(data: any): string;
-    protected construct(data: any): BaseChannel;
+    protected extractId(data: Channel): string;
+    protected construct(data: Channel): BaseChannel;
     /**
      * Resolves a ChannelResolvable to a cached BaseChannel object.
      * @param channel The ChannelResolvable to resolve.
@@ -920,21 +926,24 @@ declare class ChannelManager extends BaseManager<string, BaseChannel> {
     bulkDelete(id: string, messages: MessageResolvable[]): Promise<void>;
 }
 
+type RawTextChannel = Extract<Channel, {
+    channel_type: "TextChannel";
+}>;
 declare class TextChannel extends BaseChannel {
     name: string;
     serverId: string;
     defaultPermissions?: {
         a: number;
         d: number;
-    };
-    description?: string | null;
+    } | null | undefined;
+    description?: string | null | undefined;
     icon?: Attachment | null;
-    lastMessageId?: string | null;
+    lastMessageId?: string | null | undefined;
     nsfw?: boolean;
     slowmode?: number;
     voice?: any;
-    constructor(client: Client, data: any);
-    _patch(data: any, clear?: string[]): void;
+    constructor(client: Client, data: RawTextChannel);
+    _patch(data: RawTextChannel, clear?: string[]): void;
     /**
      * Updates the permission overrides for the channel.
      * @param roleId The raw string ID of the role to update.
@@ -1128,11 +1137,7 @@ declare class MessageCollector extends Collector<string, Message> {
     endReason(): string | null;
 }
 
-declare enum ChannelType {
-    TEXT = "TextChannel",
-    DM = "DirectMessage",
-    GROUP = "Group"
-}
+type ChannelType = "SavedMessages" | "DirectMessage" | "Group" | "TextChannel";
 interface ChannelCreateOptions {
     name: string;
     type: "Text" | "Voice";
@@ -1145,7 +1150,7 @@ interface ChannelCreateOptions {
 declare abstract class BaseChannel extends Base {
     type: ChannelType;
     messages: MessageManager;
-    protected constructor(client: Client, data: any);
+    protected constructor(client: Client, data: Channel);
     /**
      * Sends a message to this channel.
      * @param contentOrOptions The string content or message options payload.
@@ -1258,17 +1263,17 @@ declare class ServerChannelManager {
 declare class Role extends Base {
     serverId: string;
     name: string;
-    color: string | null;
+    color: string | null | undefined;
     hoist: boolean;
     rank: number;
     icon: Attachment | null;
     private _permissions;
-    constructor(client: Client, data: any, serverId: string);
+    constructor(client: Client, data: Role$1, serverId: string);
     /**
      * Updates the role instance with new data without losing the object reference.
      * @internal
      */
-    _patch(data: any): void;
+    _patch(data: Role$1): void;
     /**
      * The server this role belongs to.
      * Pulls dynamically from the cache to prevent massive memory duplication.
@@ -1427,11 +1432,11 @@ declare class RoleManager extends BaseManager<string, Role> {
     /**
      * Tell BaseManager how to find the ID for Roles
      */
-    protected extractId(data: any): string;
+    protected extractId(data: Role$1): string;
     /**
      * Tell BaseManager how to build a Role
      */
-    protected construct(data: any): Role;
+    protected construct(data: Role$1): Role;
     /**
      * Adds or updates a role in the local cache.
      * @internal
@@ -1439,7 +1444,7 @@ declare class RoleManager extends BaseManager<string, Role> {
      * @param idParam An optional ID parameter if the payload wraps the role object.
      * @returns The newly created or updated Role object.
      */
-    _add(data: any, idParam?: string): Role;
+    _add(data: Role$1, idParam?: string): Role;
     [util.inspect.custom](): Collection<string, Role>;
     /**
      * Resolves a RoleResolvable to a Role object from the cache.
@@ -1554,15 +1559,15 @@ declare class ServerInvite {
     code: string;
     creatorId: string;
     channelId: string;
-    constructor(data: any);
-    _patch(data: any): void;
+    constructor(data: Invite);
+    _patch(data: Invite): void;
 }
 
 declare class ServerInviteManager extends BaseManager<string, ServerInvite> {
     server: Server;
     constructor(client: Client, server: Server, limit?: number);
-    protected extractId(data: any): string;
-    protected construct(data: any): ServerInvite;
+    protected extractId(data: Invite): string;
+    protected construct(data: Invite): ServerInvite;
     /**
      * Fetches all active invites for this server.
      */
@@ -1572,8 +1577,8 @@ declare class ServerInviteManager extends BaseManager<string, ServerInvite> {
 declare class ServerBan {
     userId: string;
     reason: string | null;
-    constructor(data: any);
-    _patch(data: any): void;
+    constructor(data: ServerBan$1);
+    _patch(data: ServerBan$1): void;
 }
 
 declare class ServerBanManager extends BaseManager<string, ServerBan> {
@@ -1618,11 +1623,11 @@ declare class ServerManager extends BaseManager<string, Server> {
     /**
      * Tell BaseManager how to find the ID for Servers
      */
-    protected extractId(data: any): string;
+    protected extractId(data: Server$1): string;
     /**
      * Tell BaseManager how to build a Server
      */
-    protected construct(data: any): Server;
+    protected construct(data: Server$1): Server;
     /**
      * Fetches a server from the API.
      * @param id The server ID.
@@ -1633,18 +1638,20 @@ declare class ServerManager extends BaseManager<string, Server> {
     [util.inspect.custom](): Collection<string, Server>;
 }
 
-interface EmojiParent {
-    id: string;
+type EmojiParent = {
     type: "Server";
-}
+    id: string;
+} | {
+    type: "Detached";
+};
 declare class Emoji extends Base {
     creatorId: string;
     name: string;
     parent: EmojiParent;
     animated: boolean;
     nsfw: boolean;
-    constructor(client: Client, data: any);
-    _patch(data: any): void;
+    constructor(client: Client, data: Emoji$1);
+    _patch(data: Emoji$1): void;
 }
 
 declare class EmojiManager extends BaseManager<string, Emoji> {
@@ -1662,11 +1669,6 @@ declare class EmojiManager extends BaseManager<string, Emoji> {
     [util.inspect.custom](): Collection<string, Emoji>;
 }
 
-interface Categories {
-    channels: string[];
-    id: string;
-    title: string;
-}
 declare class Server extends Base {
     channelIds: string[];
     defaultPermissions: bigint;
@@ -1674,7 +1676,7 @@ declare class Server extends Base {
     ownerId: string;
     analytics: boolean;
     banner: Attachment | null;
-    categories: Categories[];
+    categories: Category[] | null;
     description: string | null;
     discoverable: boolean;
     flags: number;
@@ -1686,11 +1688,11 @@ declare class Server extends Base {
     bans: ServerBanManager;
     invites: ServerInviteManager;
     emojis: EmojiManager;
-    constructor(client: Client, data: any);
+    constructor(client: Client, data: Server$1);
     /**
      * Updates the server instance with new data without losing the object reference.
      */
-    _patch(data: any, clear?: string[]): void;
+    _patch(data: Server$1, clear?: string[]): void;
     /**
      * Edits this server.
      * @param options The fields to update.
@@ -1699,7 +1701,7 @@ declare class Server extends Base {
     /**
      * Leaves the server
      */
-    leave(): Promise<any>;
+    leave(): Promise<never>;
     /**
      * Fetches multiple members from this server.
      * @param options Filter options for the fetch request.
@@ -1757,8 +1759,8 @@ declare class Member extends Base {
     canPublish: boolean;
     canRecieve: boolean;
     roles: MemberRoleManager;
-    constructor(client: Client, data: any);
-    _patch(data: any): void;
+    constructor(client: Client, data: Member$1, serverId?: string);
+    _patch(data: Member$1): void;
     /**
      * Get member role IDs
      */
@@ -1903,6 +1905,30 @@ declare class ReactionCollector extends Collector<string, MessageReaction> {
     endReason(): string | null;
 }
 
+declare class MessageMentions {
+    private readonly client;
+    private readonly message;
+    /** Raw user IDs from the API */
+    readonly userIds: string[];
+    /** Raw role IDs from the API */
+    readonly roleIds: string[];
+    /** Raw channel IDs parsed from message content */
+    readonly channelIds: string[];
+    constructor(client: Client, message: Message, userIds: string[] | null, roleIds: string[] | null);
+    /** Mentioned users resolved from cache */
+    get users(): Collection<string, User>;
+    /** Mentioned members resolved from cache (only in server channels) */
+    get members(): Collection<string, Member>;
+    /** Mentioned roles resolved from cache */
+    get roles(): Collection<string, Role>;
+    /** Mentioned channels resolved from cache */
+    get channels(): Collection<string, BaseChannel>;
+    /** Whether the given user ID is mentioned */
+    has(userId: string): boolean;
+    private static parseChannelIds;
+    [util__default.inspect.custom](depth: number, options: util__default.InspectOptions, inspect: typeof util__default.inspect): string;
+}
+
 interface MessageOptions {
     content?: string;
     embeds?: (TextEmbedData | EmbedBuilder)[];
@@ -1913,9 +1939,9 @@ interface MessageOptions {
     replies?: ReplyIntent[];
 }
 interface Masquerade {
-    avatar?: string;
-    name?: string;
-    colour?: string;
+    avatar?: string | null;
+    name?: string | null;
+    colour?: string | null;
 }
 interface ReplyIntent {
     id: string;
@@ -1930,19 +1956,18 @@ declare class Message extends Base {
     content: string | null;
     authorId: string;
     channelId: string;
-    embeds: any[];
+    embeds: Embed[] | null;
     attachments: Attachment[];
     editedAt: Date | null;
     createdAt: Date | null;
     flags: number;
     interactions: Interaction | null;
     masquerade: Masquerade | null;
-    mentions: string[];
-    pinned: boolean;
+    mentions: MessageMentions;
+    pinned: null | boolean;
     reactions: Record<string, string[]>;
-    replies: string[];
-    role_mentions: string[];
-    constructor(client: Client, data: any);
+    replies: string[] | null;
+    constructor(client: Client, data: Message$1);
     reply(contentOrOptions: string | MessageOptions): Promise<Message>;
     /**
      * Edits this message.
@@ -2024,7 +2049,7 @@ declare class Message extends Base {
     get serverId(): string | undefined;
     /** Gets the Server object from cache */
     get server(): Server | undefined;
-    _patch(data: any): void;
+    _patch(data: Message$1): void;
     [util.inspect.custom](depth: number, options: util.InspectOptions, inspect: typeof util.inspect): string;
 }
 
@@ -2032,7 +2057,7 @@ declare class Message extends Base {
  * Represents the authenticated bot's user object.
  */
 declare class ClientUser extends User {
-    constructor(client: Client, data: any);
+    constructor(client: Client, data: User$1);
 }
 
 interface SweeperOptions {
@@ -2082,7 +2107,18 @@ interface ClientEvents {
     serverDelete: [server: Server | string];
     userUpdate: [oldUser: User, newUser: User];
     serverMemberJoin: [member: Member];
-    serverMemberLeave: [member: Member];
+    serverMemberLeave: [member: Member | {
+        serverId: string;
+        userId: string;
+    }];
+    serverBanAdd: [member: Member | {
+        serverId: string;
+        userId: string;
+    }];
+    serverMemberKick: [member: Member | {
+        serverId: string;
+        userId: string;
+    }];
 }
 interface ClientOptions {
     sweepers?: SweeperOptions;
@@ -2117,7 +2153,7 @@ declare class Client extends EventEmitter {
  * A fallback class for channel types that are not yet officially supported by the library.
  */
 declare class UnknownChannel extends BaseChannel {
-    constructor(client: Client, data: any);
+    constructor(client: Client, data: Channel);
 }
 
-export { Attachment, AttachmentBuilder, type AttachmentMetadata, Base, BaseChannel, BitField, type BitFieldResolvable, type BotInformation, type CDNTag, type Categories, type ChannelCreateOptions, type ChannelEditOptions, ChannelManager, type ChannelResolvable, type ChannelRolePermissionOptions, ChannelType, Client, type ClientEvents, type ClientOptions, ClientUser, Collection, Collector, type CollectorOptions, DMChannel, EmbedBuilder, Emoji, EmojiManager, type EmojiParent, type FetchMembersOptions, GatewayManager, 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, 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, UserPresence, type UserProfile, UserRelationship, type UserResolvable, type UserStatus };
+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, EmojiManager, type EmojiParent, 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 };