lunibee 0.1.7 → 0.2.0

package/dist/core/events.d.ts

@@ -1,3 +1,6 @@
+import type { APIEntitlement, APISoundboardSound } from "@lunibee/types";
+import type { APIAutoModerationActionExecution, APIAutoModerationRule, APIChannel, APIChannelPinsUpdate, APIGuild, APIGuildBanEvent, APIGuildEmojisUpdateEvent, APIGuildMember, APIGuildMembersChunk, APIGuildRoleDeleteEvent, APIGuildRoleEvent, APIGuildScheduledEvent, APIGuildScheduledEventUserEvent, APIGuildStickersUpdateEvent, APIInviteCreate, APIInviteDelete, APIMessageDeleteBulkEvent, APIMessageDeleteEvent, APIMessagePollVoteEvent, APIMessageReactionEvent, APIMessageReactionRemoveEmojiEvent, APIPresenceUpdate, APIStageInstance, APIThreadEvent, APIThreadListSync, APIThreadMember, APIThreadMembersUpdate, APITypingStart, APIVoiceServerUpdate, APIVoiceState, APIWebhooksUpdate, ClientUser } from "@lunibee/types";
+import type { Channel, Interaction, Message } from "@lunibee/structures";
 /** Names of events emitted by a Lunibee client. */
 export declare enum ClientEvent {
     Ready = "ready",
@@ -33,6 +36,13 @@ export declare enum ClientEvent {
     GuildRoleDelete = "guildRoleDelete",
     GuildEmojisUpdate = "guildEmojisUpdate",
     GuildStickersUpdate = "guildStickersUpdate",
+    EntitlementCreate = "entitlementCreate",
+    EntitlementUpdate = "entitlementUpdate",
+    EntitlementDelete = "entitlementDelete",
+    SoundboardSoundCreate = "soundboardSoundCreate",
+    SoundboardSoundUpdate = "soundboardSoundUpdate",
+    SoundboardSoundDelete = "soundboardSoundDelete",
+    SoundboardSoundsUpdate = "soundboardSoundsUpdate",
     GuildIntegrationsUpdate = "guildIntegrationsUpdate",
     GuildScheduledEventCreate = "guildScheduledEventCreate",
     GuildScheduledEventUpdate = "guildScheduledEventUpdate",
@@ -66,6 +76,106 @@ export declare enum ClientEvent {
     InteractionCreate = "interactionCreate"
 }
 /** Names of events emitted by a Lunibee client. */
-export type ClientEventName = keyof import("./index.js").ClientEvents;
+export type ClientEventName = keyof ClientEvents;
 /** Listener signature for a Lunibee client event. */
-export type ClientListener<K extends ClientEventName> = (...args: import("./index.js").ClientEvents[K]) => unknown;
+export type ClientListener<K extends ClientEventName> = (...args: ClientEvents[K]) => unknown;
+export type ClientEvents = {
+    ready: [user: ClientUser];
+    resumed: [];
+    invalidSession: [isRecoverable: boolean];
+    raw: [data: {
+        event: string;
+        data: unknown;
+    }];
+    error: [error: Error];
+    open: [];
+    close: [data: {
+        code: number;
+        action: string;
+    }];
+    messageCreate: [message: Message];
+    /** `previous` is the cached version, available when `messageCache` is enabled. */
+    messageUpdate: [message: Message, previous?: Message];
+    /** `message` is the cached message, available when `messageCache` is enabled. */
+    messageDelete: [data: APIMessageDeleteEvent, message?: Message];
+    /** `messages` are the cached messages that were deleted (empty without `messageCache`). */
+    messageDeleteBulk: [data: APIMessageDeleteBulkEvent, messages: Message[]];
+    messageReactionAdd: [data: APIMessageReactionEvent];
+    messageReactionRemove: [data: APIMessageReactionEvent];
+    messageReactionRemoveAll: [data: APIMessageDeleteEvent];
+    messageReactionRemoveEmoji: [data: APIMessageReactionRemoveEmojiEvent];
+    messagePollVoteAdd: [data: APIMessagePollVoteEvent];
+    messagePollVoteRemove: [data: APIMessagePollVoteEvent];
+    guildCreate: [data: APIGuild];
+    guildUpdate: [data: APIGuild];
+    guildDelete: [data: {
+        id: string;
+        unavailable?: boolean;
+    }];
+    guildAvailable: [data: APIGuild & {
+        unavailable?: boolean;
+    }];
+    guildUnavailable: [data: {
+        id: string;
+        unavailable?: boolean;
+    }];
+    guildMemberAdd: [member: APIGuildMember];
+    guildMemberUpdate: [member: APIGuildMember];
+    guildMemberRemove: [member: APIGuildMember];
+    guildMembersChunk: [data: APIGuildMembersChunk];
+    guildBanAdd: [data: APIGuildBanEvent];
+    guildBanRemove: [data: APIGuildBanEvent];
+    guildRoleCreate: [data: APIGuildRoleEvent];
+    guildRoleUpdate: [data: APIGuildRoleEvent];
+    guildRoleDelete: [data: APIGuildRoleDeleteEvent];
+    guildEmojisUpdate: [data: APIGuildEmojisUpdateEvent];
+    guildStickersUpdate: [data: APIGuildStickersUpdateEvent];
+    entitlementCreate: [entitlement: APIEntitlement];
+    entitlementUpdate: [entitlement: APIEntitlement];
+    entitlementDelete: [entitlement: APIEntitlement];
+    soundboardSoundCreate: [sound: APISoundboardSound];
+    soundboardSoundUpdate: [sound: APISoundboardSound];
+    soundboardSoundDelete: [data: {
+        sound_id: string;
+        guild_id: string;
+    }];
+    soundboardSoundsUpdate: [
+        data: {
+            guild_id: string;
+            soundboard_sounds: APISoundboardSound[];
+        }
+    ];
+    guildIntegrationsUpdate: [data: {
+        guild_id: string;
+    }];
+    guildScheduledEventCreate: [data: APIGuildScheduledEvent];
+    guildScheduledEventUpdate: [data: APIGuildScheduledEvent];
+    guildScheduledEventDelete: [data: APIGuildScheduledEvent];
+    guildScheduledEventUserAdd: [data: APIGuildScheduledEventUserEvent];
+    guildScheduledEventUserRemove: [data: APIGuildScheduledEventUserEvent];
+    autoModerationRuleCreate: [data: APIAutoModerationRule];
+    autoModerationRuleUpdate: [data: APIAutoModerationRule];
+    autoModerationRuleDelete: [data: APIAutoModerationRule];
+    autoModerationActionExecution: [data: APIAutoModerationActionExecution];
+    channelCreate: [channel: Channel];
+    channelUpdate: [channel: Channel];
+    channelDelete: [data: APIChannel];
+    channelPinsUpdate: [data: APIChannelPinsUpdate];
+    threadCreate: [channel: Channel];
+    threadUpdate: [channel: Channel];
+    threadDelete: [data: APIThreadEvent];
+    threadListSync: [data: APIThreadListSync];
+    threadMembersUpdate: [data: APIThreadMembersUpdate];
+    threadMemberUpdate: [data: APIThreadMember];
+    stageInstanceCreate: [data: APIStageInstance];
+    stageInstanceUpdate: [data: APIStageInstance];
+    stageInstanceDelete: [data: APIStageInstance];
+    inviteCreate: [data: APIInviteCreate];
+    inviteDelete: [data: APIInviteDelete];
+    webhooksUpdate: [data: APIWebhooksUpdate];
+    voiceStateUpdate: [data: APIVoiceState];
+    voiceServerUpdate: [data: APIVoiceServerUpdate];
+    presenceUpdate: [data: APIPresenceUpdate];
+    typingStart: [data: APITypingStart];
+    interactionCreate: [interaction: Interaction];
+};

package/dist/core/index.d.ts

@@ -1,12 +1,17 @@
-export { Permission, Permissions, PermissionFlagsBits, PermissionSet, PermissionsBitField, PermissionOverwriteType, type PermissionName, } from "./permissions.js";
-export { ClientEvent, type ClientEventName, type ClientListener, } from "./events.js";
+export { Permission, Permissions, PermissionFlagsBits, PermissionSet, PermissionsBitField, PermissionOverwriteType, computePermissions, type PermissionContext, type PermissionOverwrite, type PermissionRole, type PermissionName, } from "./permissions.js";
+export { ClientEvent, 
+/** Discord.js-familiar alias for {@link ClientEvent}. */
+ClientEvent as Events, type ClientEventName, type ClientEvents, type ClientListener, } from "./events.js";
 export { Collector, type CollectorOptions } from "./collector.js";
-export { GatewayIntentBits, IntentBits, Intents, resolveGatewayIntents, type GatewayIntentResolvable, } from "@lunibee/types";
-import { ApplicationCommandManager, ChannelManager, GuildManager, UserManager } from "@lunibee/managers";
+export { GatewayIntentBits, IntentBits, Intents, IntentsBitField, resolveGatewayIntents, type GatewayIntentResolvable, } from "@lunibee/types";
+import { ApplicationCommandManager, ChannelManager, GuildManager, MonetizationManager, StageInstanceManager, UserManager } from "@lunibee/managers";
 import { REST } from "@lunibee/rest";
-import { Channel, Message, Interaction, type InteractionClient } from "@lunibee/structures";
+import { type InteractionClient } from "@lunibee/structures";
 import { Gateway } from "@lunibee/ws";
-import type { APIChannel, APIGuild, APIGuildMember, APIGuildRoleEvent, APIGuildRoleDeleteEvent, APIGuildBanEvent, APIGuildEmojisUpdateEvent, APIGuildStickersUpdateEvent, APIMessageDeleteBulkEvent, APIMessageDeleteEvent, APIMessageReactionEvent, APIMessageReactionRemoveEmojiEvent, APIThreadEvent, APIThreadListSync, APIThreadMembersUpdate, APIVoiceState, APIVoiceServerUpdate, APIPresenceUpdate, APITypingStart, APIInviteCreate, APIInviteDelete, APIWebhooksUpdate, APIAutoModerationRule, APIAutoModerationActionExecution, APIGuildScheduledEvent, APIGuildScheduledEventUserEvent, APIStageInstance, APIChannelPinsUpdate, APIGuildMembersChunk, APIMessagePollVoteEvent, APIThreadMember, ClientOptions, ClientUser } from "@lunibee/types";
+import type { APISoundboardSound, ClientOptions, ClientUser } from "@lunibee/types";
+import { type ClientEvents } from "./events.js";
+import { Collector, type CollectorOptions } from "./collector.js";
+import { type PermissionSet } from "./permissions.js";
 /** Lifecycle state of a client. */
 export type ClientState = "idle" | "connecting" | "ready" | "destroyed";
 type Listener<T extends unknown[]> = (...args: T) => unknown;
@@ -31,9 +36,13 @@ export declare class Client extends EventEmitter<ClientEvents> implements Intera
     readonly users: UserManager;
     readonly guilds: GuildManager;
     readonly channels: ChannelManager;
+    /** Stage instances, cached by stage channel ID. */
+    readonly stageInstances: StageInstanceManager;
     readonly application: {
         commands: ApplicationCommandManager;
     };
+    /** SKUs, entitlements and subscriptions; available after READY (application ID known). */
+    monetization?: MonetizationManager;
     get ws(): Gateway;
     get gateway(): Gateway;
     user?: ClientUser;
@@ -56,12 +65,21 @@ export declare class Client extends EventEmitter<ClientEvents> implements Intera
     requestGuildMembers(data: Record<string, unknown>): boolean;
     constructor(options: ClientOptions);
     /**
-     * Convenience method to connect the bot to Discord.
-     * Optionally overrides the configured token.
-     * @param token Optional token override.
-     * @returns The token used to log in.
-     * @throws {TypeError} If the resulting token is empty.
+     * Collects the first argument of a client event until a limit, timeout,
+     * idle timeout, abort or `stop()`. The collector unsubscribes itself when
+     * it ends. Items are keyed by `options.key`, else their `id`, else order.
      */
+    createCollector<E extends keyof ClientEvents>(event: E, options?: CollectorOptions<ClientEvents[E][0]> & {
+        key?: (item: ClientEvents[E][0]) => string;
+    }): Collector<string, ClientEvents[E][0]>;
+    /**
+     * Resolves a member's permissions from cached state: guild-level for a
+     * guild ID, or channel-level (including overwrites) for a cached channel
+     * ID. Returns null when the guild or member is not cached.
+     */
+    permissionsFor(memberId: string, guildOrChannelId: string): PermissionSet | null;
+    /** Fetches Discord's default soundboard sounds. */
+    fetchDefaultSoundboardSounds(): Promise<APISoundboardSound[]>;
     login(token?: string): Promise<string>;
     /**
      * Destroys the client, permanently closing the Gateway connection.
@@ -71,6 +89,7 @@ export declare class Client extends EventEmitter<ClientEvents> implements Intera
     editInteractionReply(token: string, data: Record<string, unknown>): Promise<unknown>;
     deleteInteractionReply(token: string): Promise<void>;
     followUpInteraction(token: string, data: Record<string, unknown>): Promise<unknown>;
+    interactionWebhookMessage(method: "GET" | "PATCH" | "DELETE", applicationId: string, token: string, messageId: string, data?: Record<string, unknown>): Promise<unknown>;
     /** Fetches a webhook from Discord. */
     fetchWebhook(id: string, token?: string): Promise<Record<string, unknown>>;
     /** Fetches a guild preview from Discord. */
@@ -95,85 +114,3 @@ export declare class Client extends EventEmitter<ClientEvents> implements Intera
         permissions?: string | bigint;
     }): string;
 }
-export type ClientEvents = {
-    ready: [user: ClientUser];
-    resumed: [];
-    invalidSession: [isRecoverable: boolean];
-    raw: [data: {
-        event: string;
-        data: unknown;
-    }];
-    error: [error: Error];
-    open: [];
-    close: [data: {
-        code: number;
-        action: string;
-    }];
-    messageCreate: [message: Message];
-    messageUpdate: [message: Message];
-    messageDelete: [data: APIMessageDeleteEvent];
-    messageDeleteBulk: [data: APIMessageDeleteBulkEvent];
-    messageReactionAdd: [data: APIMessageReactionEvent];
-    messageReactionRemove: [data: APIMessageReactionEvent];
-    messageReactionRemoveAll: [data: APIMessageDeleteEvent];
-    messageReactionRemoveEmoji: [data: APIMessageReactionRemoveEmojiEvent];
-    messagePollVoteAdd: [data: APIMessagePollVoteEvent];
-    messagePollVoteRemove: [data: APIMessagePollVoteEvent];
-    guildCreate: [data: APIGuild];
-    guildUpdate: [data: APIGuild];
-    guildDelete: [data: {
-        id: string;
-        unavailable?: boolean;
-    }];
-    guildAvailable: [data: APIGuild & {
-        unavailable?: boolean;
-    }];
-    guildUnavailable: [data: {
-        id: string;
-        unavailable?: boolean;
-    }];
-    guildMemberAdd: [member: APIGuildMember];
-    guildMemberUpdate: [member: APIGuildMember];
-    guildMemberRemove: [member: APIGuildMember];
-    guildMembersChunk: [data: APIGuildMembersChunk];
-    guildBanAdd: [data: APIGuildBanEvent];
-    guildBanRemove: [data: APIGuildBanEvent];
-    guildRoleCreate: [data: APIGuildRoleEvent];
-    guildRoleUpdate: [data: APIGuildRoleEvent];
-    guildRoleDelete: [data: APIGuildRoleDeleteEvent];
-    guildEmojisUpdate: [data: APIGuildEmojisUpdateEvent];
-    guildStickersUpdate: [data: APIGuildStickersUpdateEvent];
-    guildIntegrationsUpdate: [data: {
-        guild_id: string;
-    }];
-    guildScheduledEventCreate: [data: APIGuildScheduledEvent];
-    guildScheduledEventUpdate: [data: APIGuildScheduledEvent];
-    guildScheduledEventDelete: [data: APIGuildScheduledEvent];
-    guildScheduledEventUserAdd: [data: APIGuildScheduledEventUserEvent];
-    guildScheduledEventUserRemove: [data: APIGuildScheduledEventUserEvent];
-    autoModerationRuleCreate: [data: APIAutoModerationRule];
-    autoModerationRuleUpdate: [data: APIAutoModerationRule];
-    autoModerationRuleDelete: [data: APIAutoModerationRule];
-    autoModerationActionExecution: [data: APIAutoModerationActionExecution];
-    channelCreate: [channel: Channel];
-    channelUpdate: [channel: Channel];
-    channelDelete: [data: APIChannel];
-    channelPinsUpdate: [data: APIChannelPinsUpdate];
-    threadCreate: [channel: Channel];
-    threadUpdate: [channel: Channel];
-    threadDelete: [data: APIThreadEvent];
-    threadListSync: [data: APIThreadListSync];
-    threadMembersUpdate: [data: APIThreadMembersUpdate];
-    threadMemberUpdate: [data: APIThreadMember];
-    stageInstanceCreate: [data: APIStageInstance];
-    stageInstanceUpdate: [data: APIStageInstance];
-    stageInstanceDelete: [data: APIStageInstance];
-    inviteCreate: [data: APIInviteCreate];
-    inviteDelete: [data: APIInviteDelete];
-    webhooksUpdate: [data: APIWebhooksUpdate];
-    voiceStateUpdate: [data: APIVoiceState];
-    voiceServerUpdate: [data: APIVoiceServerUpdate];
-    presenceUpdate: [data: APIPresenceUpdate];
-    typingStart: [data: APITypingStart];
-    interactionCreate: [interaction: Interaction];
-};