lunibee 0.3.1 → 0.3.3

package/dist/structures/options.d.ts

@@ -1,3 +1,4 @@
+import type { UserData } from "@lunibee/types";
 /** Raw Discord application command interaction data option. */
 export interface APIInteractionDataOption {
     name: string;
@@ -36,8 +37,8 @@ export declare class CommandOptions {
     getBoolean(name: string, required?: false): boolean | null;
     getBoolean(name: string, required: true): boolean;
     /** Gets the raw resolved user data for a user option. @param name Option name. @param required If true, throws when missing. */
-    getUser(name: string, required?: false): Record<string, unknown> | null;
-    getUser(name: string, required: true): Record<string, unknown>;
+    getUser(name: string, required?: false): (UserData & Record<string, unknown>) | null;
+    getUser(name: string, required: true): UserData & Record<string, unknown>;
     /** Gets the raw resolved channel data for a channel option. @param name Option name. @param required If true, throws when missing. */
     getChannel(name: string, required?: false): Record<string, unknown> | null;
     getChannel(name: string, required: true): Record<string, unknown>;

package/dist/structures/permissions.d.ts

@@ -0,0 +1,409 @@
+/** Permission overwrite target types. */
+export declare enum PermissionOverwriteEnum {
+    Role = 0,
+    Member = 1
+}
+/** Lunibee idiomatic camelCase permission bitflags. */
+export declare const Permission: {
+    readonly createInstantInvite: bigint;
+    readonly kickMembers: bigint;
+    readonly banMembers: bigint;
+    readonly administrator: bigint;
+    readonly manageChannels: bigint;
+    readonly manageGuild: bigint;
+    readonly addReactions: bigint;
+    readonly viewAuditLog: bigint;
+    readonly prioritySpeaker: bigint;
+    readonly stream: bigint;
+    readonly viewChannel: bigint;
+    readonly sendMessages: bigint;
+    readonly sendTTSMessages: bigint;
+    readonly manageMessages: bigint;
+    readonly embedLinks: bigint;
+    readonly attachFiles: bigint;
+    readonly readMessageHistory: bigint;
+    readonly mentionEveryone: bigint;
+    readonly useExternalEmojis: bigint;
+    readonly viewGuildInsights: bigint;
+    readonly connect: bigint;
+    readonly speak: bigint;
+    readonly muteMembers: bigint;
+    readonly deafenMembers: bigint;
+    readonly moveMembers: bigint;
+    readonly useVAD: bigint;
+    readonly changeNickname: bigint;
+    readonly manageNicknames: bigint;
+    readonly manageRoles: bigint;
+    readonly manageWebhooks: bigint;
+    readonly manageGuildExpressions: bigint;
+    readonly useApplicationCommands: bigint;
+    readonly requestToSpeak: bigint;
+    readonly manageEvents: bigint;
+    readonly manageThreads: bigint;
+    readonly createPublicThreads: bigint;
+    readonly createPrivateThreads: bigint;
+    readonly useExternalStickers: bigint;
+    readonly sendMessagesInThreads: bigint;
+    readonly useEmbeddedActivities: bigint;
+    readonly moderateMembers: bigint;
+    readonly viewCreatorMonetizationAnalytics: bigint;
+    readonly useSoundboard: bigint;
+    readonly createGuildExpressions: bigint;
+    readonly createEvents: bigint;
+    readonly useExternalSounds: bigint;
+    readonly sendVoiceMessages: bigint;
+    readonly setVoiceChannelStatus: bigint;
+    readonly sendPolls: bigint;
+    readonly useExternalApps: bigint;
+    readonly pinMessages: bigint;
+    readonly bypassSlowmode: bigint;
+};
+/** Canonical PascalCase permission constants. */
+export declare const Permissions: {
+    readonly CreateInstantInvite: bigint;
+    readonly KickMembers: bigint;
+    readonly BanMembers: bigint;
+    readonly Administrator: bigint;
+    readonly ManageChannels: bigint;
+    readonly ManageGuild: bigint;
+    readonly AddReactions: bigint;
+    readonly ViewAuditLog: bigint;
+    readonly PrioritySpeaker: bigint;
+    readonly Stream: bigint;
+    readonly ViewChannel: bigint;
+    readonly SendMessages: bigint;
+    readonly SendTTSMessages: bigint;
+    readonly ManageMessages: bigint;
+    readonly EmbedLinks: bigint;
+    readonly AttachFiles: bigint;
+    readonly ReadMessageHistory: bigint;
+    readonly MentionEveryone: bigint;
+    readonly UseExternalEmojis: bigint;
+    readonly ViewGuildInsights: bigint;
+    readonly Connect: bigint;
+    readonly Speak: bigint;
+    readonly MuteMembers: bigint;
+    readonly DeafenMembers: bigint;
+    readonly MoveMembers: bigint;
+    readonly UseVAD: bigint;
+    readonly ChangeNickname: bigint;
+    readonly ManageNicknames: bigint;
+    readonly ManageRoles: bigint;
+    readonly ManageWebhooks: bigint;
+    readonly ManageGuildExpressions: bigint;
+    readonly UseApplicationCommands: bigint;
+    readonly RequestToSpeak: bigint;
+    readonly ManageEvents: bigint;
+    readonly ManageThreads: bigint;
+    readonly CreatePublicThreads: bigint;
+    readonly CreatePrivateThreads: bigint;
+    readonly UseExternalStickers: bigint;
+    readonly SendMessagesInThreads: bigint;
+    readonly UseEmbeddedActivities: bigint;
+    readonly ModerateMembers: bigint;
+    readonly ViewCreatorMonetizationAnalytics: bigint;
+    readonly UseSoundboard: bigint;
+    readonly CreateGuildExpressions: bigint;
+    readonly CreateEvents: bigint;
+    readonly UseExternalSounds: bigint;
+    readonly SendVoiceMessages: bigint;
+    readonly SetVoiceChannelStatus: bigint;
+    readonly SendPolls: bigint;
+    readonly UseExternalApps: bigint;
+    readonly PinMessages: bigint;
+    readonly BypassSlowmode: bigint;
+};
+/**
+ * Permission flag bits with **bigint** values matching Discord's permission bit
+ * positions. Mirrors discord.js's `PermissionFlagsBits`, so bitwise composition
+ * (`Flags.A | Flags.B`) OR-s the bits instead of concatenating strings.
+ *
+ * The same object as {@link Permissions}, under the discord.js name. It is a
+ * `const` object rather than a TS `enum` because enums cannot hold bigint
+ * members; the same-named union type below preserves usage as a type.
+ */
+export declare const PermissionFlagsBits: {
+    readonly CreateInstantInvite: bigint;
+    readonly KickMembers: bigint;
+    readonly BanMembers: bigint;
+    readonly Administrator: bigint;
+    readonly ManageChannels: bigint;
+    readonly ManageGuild: bigint;
+    readonly AddReactions: bigint;
+    readonly ViewAuditLog: bigint;
+    readonly PrioritySpeaker: bigint;
+    readonly Stream: bigint;
+    readonly ViewChannel: bigint;
+    readonly SendMessages: bigint;
+    readonly SendTTSMessages: bigint;
+    readonly ManageMessages: bigint;
+    readonly EmbedLinks: bigint;
+    readonly AttachFiles: bigint;
+    readonly ReadMessageHistory: bigint;
+    readonly MentionEveryone: bigint;
+    readonly UseExternalEmojis: bigint;
+    readonly ViewGuildInsights: bigint;
+    readonly Connect: bigint;
+    readonly Speak: bigint;
+    readonly MuteMembers: bigint;
+    readonly DeafenMembers: bigint;
+    readonly MoveMembers: bigint;
+    readonly UseVAD: bigint;
+    readonly ChangeNickname: bigint;
+    readonly ManageNicknames: bigint;
+    readonly ManageRoles: bigint;
+    readonly ManageWebhooks: bigint;
+    readonly ManageGuildExpressions: bigint;
+    readonly UseApplicationCommands: bigint;
+    readonly RequestToSpeak: bigint;
+    readonly ManageEvents: bigint;
+    readonly ManageThreads: bigint;
+    readonly CreatePublicThreads: bigint;
+    readonly CreatePrivateThreads: bigint;
+    readonly UseExternalStickers: bigint;
+    readonly SendMessagesInThreads: bigint;
+    readonly UseEmbeddedActivities: bigint;
+    readonly ModerateMembers: bigint;
+    readonly ViewCreatorMonetizationAnalytics: bigint;
+    readonly UseSoundboard: bigint;
+    readonly CreateGuildExpressions: bigint;
+    readonly CreateEvents: bigint;
+    readonly UseExternalSounds: bigint;
+    readonly SendVoiceMessages: bigint;
+    readonly SetVoiceChannelStatus: bigint;
+    readonly SendPolls: bigint;
+    readonly UseExternalApps: bigint;
+    readonly PinMessages: bigint;
+    readonly BypassSlowmode: bigint;
+};
+/** Union of {@link PermissionFlagsBits} values (all bigint). */
+export type PermissionFlagsBits = (typeof PermissionFlagsBits)[keyof typeof PermissionFlagsBits];
+/** A permission flag name, such as `"BanMembers"`, accepted wherever a permission can be given by name. */
+export type PermissionName = keyof typeof Permission | keyof typeof Permissions | keyof typeof PermissionFlagsBits;
+/** Anything accepted as permissions: a bit, a name, a `PermissionSet`, or an array of these. */
+export type PermissionResolvable = bigint | number | string | PermissionName | PermissionFlagsBits | PermissionSet | PermissionResolvable[];
+/** Immutable permission bitfield with direct boolean getters. */
+export declare class PermissionSet {
+    #private;
+    /** Permission bitfield. */
+    readonly bitfield: bigint;
+    /** Creates a permission set. @param value Initial permission bitfield or array of permissions. @throws {RangeError} If the value is negative. @throws {TypeError} If the value is not a valid integer. */
+    constructor(value?: PermissionResolvable);
+    get createInstantInvite(): boolean;
+    get kickMembers(): boolean;
+    get banMembers(): boolean;
+    get administrator(): boolean;
+    get manageChannels(): boolean;
+    get manageGuild(): boolean;
+    get addReactions(): boolean;
+    get viewAuditLog(): boolean;
+    get prioritySpeaker(): boolean;
+    get stream(): boolean;
+    get viewChannel(): boolean;
+    get sendMessages(): boolean;
+    get sendTTSMessages(): boolean;
+    get manageMessages(): boolean;
+    get embedLinks(): boolean;
+    get attachFiles(): boolean;
+    get readMessageHistory(): boolean;
+    get mentionEveryone(): boolean;
+    get useExternalEmojis(): boolean;
+    get viewGuildInsights(): boolean;
+    get connect(): boolean;
+    get speak(): boolean;
+    get muteMembers(): boolean;
+    get deafenMembers(): boolean;
+    get moveMembers(): boolean;
+    get useVAD(): boolean;
+    get changeNickname(): boolean;
+    get manageNicknames(): boolean;
+    get manageRoles(): boolean;
+    get manageWebhooks(): boolean;
+    get manageGuildExpressions(): boolean;
+    get useApplicationCommands(): boolean;
+    get requestToSpeak(): boolean;
+    get manageEvents(): boolean;
+    get manageThreads(): boolean;
+    get createPublicThreads(): boolean;
+    get createPrivateThreads(): boolean;
+    get useExternalStickers(): boolean;
+    get sendMessagesInThreads(): boolean;
+    get useEmbeddedActivities(): boolean;
+    get moderateMembers(): boolean;
+    get viewCreatorMonetizationAnalytics(): boolean;
+    get useSoundboard(): boolean;
+    get createGuildExpressions(): boolean;
+    get createEvents(): boolean;
+    get useExternalSounds(): boolean;
+    get sendVoiceMessages(): boolean;
+    get sendPolls(): boolean;
+    get useExternalApps(): boolean;
+    get setVoiceChannelStatus(): boolean;
+    get pinMessages(): boolean;
+    get bypassSlowmode(): boolean;
+    /** Checks whether all supplied permissions are present (AND). @param permissions Permission names or raw bits. @returns True when every requested permission is present. */
+    has(...permissions: PermissionResolvable[]): boolean;
+    /** Checks whether any supplied permission is present (OR). @param permissions Permission names or raw bits. @returns True when at least one requested permission is present. */
+    any(...permissions: PermissionResolvable[]): boolean;
+    /** Returns the known permission names from `permissions` that this set lacks. @param permissions Permission names or raw bits. */
+    missing(...permissions: PermissionResolvable[]): PermissionName[];
+    /** Returns a new set with permissions added. @param permissions Permission names or raw bits. @returns A new permission set. */
+    add(...permissions: PermissionResolvable[]): PermissionSet;
+    /** Returns a new set with permissions removed. @param permissions Permission names or raw bits. @returns A new permission set. */
+    remove(...permissions: PermissionResolvable[]): PermissionSet;
+    /** Checks equality with another permission set or raw bitfield. @param other Permission set or raw bitfield. @returns True when both values are equal. */
+    equals(other: PermissionSet | bigint | number | string): boolean;
+    /** Returns the decimal permission representation. @returns Decimal permission bitfield. */
+    toString(): string;
+    /** Returns known permission names contained in this set. @returns Names of all enabled known permissions. */
+    toArray(): PermissionName[];
+}
+/** Permissions bitfield alias. */
+export declare class PermissionsBitField extends PermissionSet {
+    /** Permission flags bits enum. */
+    static readonly Flags: {
+        readonly CreateInstantInvite: bigint;
+        readonly KickMembers: bigint;
+        readonly BanMembers: bigint;
+        readonly Administrator: bigint;
+        readonly ManageChannels: bigint;
+        readonly ManageGuild: bigint;
+        readonly AddReactions: bigint;
+        readonly ViewAuditLog: bigint;
+        readonly PrioritySpeaker: bigint;
+        readonly Stream: bigint;
+        readonly ViewChannel: bigint;
+        readonly SendMessages: bigint;
+        readonly SendTTSMessages: bigint;
+        readonly ManageMessages: bigint;
+        readonly EmbedLinks: bigint;
+        readonly AttachFiles: bigint;
+        readonly ReadMessageHistory: bigint;
+        readonly MentionEveryone: bigint;
+        readonly UseExternalEmojis: bigint;
+        readonly ViewGuildInsights: bigint;
+        readonly Connect: bigint;
+        readonly Speak: bigint;
+        readonly MuteMembers: bigint;
+        readonly DeafenMembers: bigint;
+        readonly MoveMembers: bigint;
+        readonly UseVAD: bigint;
+        readonly ChangeNickname: bigint;
+        readonly ManageNicknames: bigint;
+        readonly ManageRoles: bigint;
+        readonly ManageWebhooks: bigint;
+        readonly ManageGuildExpressions: bigint;
+        readonly UseApplicationCommands: bigint;
+        readonly RequestToSpeak: bigint;
+        readonly ManageEvents: bigint;
+        readonly ManageThreads: bigint;
+        readonly CreatePublicThreads: bigint;
+        readonly CreatePrivateThreads: bigint;
+        readonly UseExternalStickers: bigint;
+        readonly SendMessagesInThreads: bigint;
+        readonly UseEmbeddedActivities: bigint;
+        readonly ModerateMembers: bigint;
+        readonly ViewCreatorMonetizationAnalytics: bigint;
+        readonly UseSoundboard: bigint;
+        readonly CreateGuildExpressions: bigint;
+        readonly CreateEvents: bigint;
+        readonly UseExternalSounds: bigint;
+        readonly SendVoiceMessages: bigint;
+        readonly SetVoiceChannelStatus: bigint;
+        readonly SendPolls: bigint;
+        readonly UseExternalApps: bigint;
+        readonly PinMessages: bigint;
+        readonly BypassSlowmode: bigint;
+    };
+    /** Permission flags constants. */
+    static readonly All: {
+        readonly createInstantInvite: bigint;
+        readonly kickMembers: bigint;
+        readonly banMembers: bigint;
+        readonly administrator: bigint;
+        readonly manageChannels: bigint;
+        readonly manageGuild: bigint;
+        readonly addReactions: bigint;
+        readonly viewAuditLog: bigint;
+        readonly prioritySpeaker: bigint;
+        readonly stream: bigint;
+        readonly viewChannel: bigint;
+        readonly sendMessages: bigint;
+        readonly sendTTSMessages: bigint;
+        readonly manageMessages: bigint;
+        readonly embedLinks: bigint;
+        readonly attachFiles: bigint;
+        readonly readMessageHistory: bigint;
+        readonly mentionEveryone: bigint;
+        readonly useExternalEmojis: bigint;
+        readonly viewGuildInsights: bigint;
+        readonly connect: bigint;
+        readonly speak: bigint;
+        readonly muteMembers: bigint;
+        readonly deafenMembers: bigint;
+        readonly moveMembers: bigint;
+        readonly useVAD: bigint;
+        readonly changeNickname: bigint;
+        readonly manageNicknames: bigint;
+        readonly manageRoles: bigint;
+        readonly manageWebhooks: bigint;
+        readonly manageGuildExpressions: bigint;
+        readonly useApplicationCommands: bigint;
+        readonly requestToSpeak: bigint;
+        readonly manageEvents: bigint;
+        readonly manageThreads: bigint;
+        readonly createPublicThreads: bigint;
+        readonly createPrivateThreads: bigint;
+        readonly useExternalStickers: bigint;
+        readonly sendMessagesInThreads: bigint;
+        readonly useEmbeddedActivities: bigint;
+        readonly moderateMembers: bigint;
+        readonly viewCreatorMonetizationAnalytics: bigint;
+        readonly useSoundboard: bigint;
+        readonly createGuildExpressions: bigint;
+        readonly createEvents: bigint;
+        readonly useExternalSounds: bigint;
+        readonly sendVoiceMessages: bigint;
+        readonly setVoiceChannelStatus: bigint;
+        readonly sendPolls: bigint;
+        readonly useExternalApps: bigint;
+        readonly pinMessages: bigint;
+        readonly bypassSlowmode: bigint;
+    };
+    /** Creates a permissions bitfield. @param value Initial permission bitfield or array of permissions. */
+    constructor(value?: PermissionResolvable);
+}
+/** A role as needed for permission resolution. */
+export interface PermissionRole {
+    id: string;
+    permissions: PermissionResolvable;
+}
+/** A channel permission overwrite (Discord's `permission_overwrites` entry). */
+export interface PermissionOverwrite {
+    id: string;
+    type: PermissionOverwriteEnum | number;
+    allow: PermissionResolvable;
+    deny: PermissionResolvable;
+}
+/** Everything needed to resolve a member's permissions. */
+export interface PermissionContext {
+    guildId: string;
+    /** Guild owner ID; the owner has every permission. */
+    ownerId?: string;
+    memberId: string;
+    memberRoleIds: readonly string[];
+    /** Guild roles, including `@everyone` (whose ID is the guild ID). */
+    roles: readonly PermissionRole[];
+    /** Channel overwrites; omit for guild-level permissions. */
+    overwrites?: readonly PermissionOverwrite[];
+    /** When the member's timeout ends; while it is in the future the member keeps only View Channel and Read Message History. */
+    timedOutUntil?: Date | number | null;
+}
+/**
+ * Resolves a member's effective permissions the way Discord does: base
+ * permissions from `@everyone` and the member's roles (owner and
+ * administrator get everything), then the channel's `@everyone` overwrite,
+ * the combined role overwrites, and finally the member overwrite. A member
+ * whose timeout has not ended keeps only View Channel and Read Message History.
+ */
+export declare function computePermissions(context: PermissionContext): PermissionSet;

package/dist/structures/resources.d.ts

@@ -1,5 +1,5 @@
 import { BaseStructure, Channel, User } from "./base.js";
-import { PermissionsBitField } from "@lunibee/core";
+import { PermissionsBitField } from "./permissions.js";
 import type { ImageURLOptions, ResourceContext } from "./base.js";
 /** A Discord guild member. */
 export declare class GuildMember {
@@ -52,6 +52,9 @@ export declare class GuildMember {
      * resolved for the channel); anywhere else they are computed at guild
      * level from the cached roles each time they are read, so they follow role
      * changes. Empty when the guild's roles are not cached.
+     *
+     * Interaction permissions are used as Discord sent them: Discord computes
+     * them, so the local timeout mask is not applied on top.
      */
     get permissions(): PermissionsBitField;
     /** The member's permissions in a channel, with its overwrites. Null when the channel or guild is not cached. @param channelId Channel ID. */

package/dist/types/gateway.d.ts

@@ -186,6 +186,8 @@ export interface ClientOptions {
         emojis?: boolean;
         /** Keep each member's latest presence (needs the `GuildPresences` intent). Off by default: it is a lot of data. */
         presences?: boolean;
+        /** Most members kept per guild (least recently used leave first). Default: unbounded, so a big guild's member list stays whole. */
+        maxMembers?: number;
     };
     /**
      * Default `allowed_mentions` for every message the client sends (channel
@@ -205,6 +207,8 @@ export interface AllowedMentions {
 /** Gateway connection configuration. */
 export interface GatewayOptions {
     intents?: GatewayIntentResolvable;
+    /** zlib-stream transport compression; `ClientOptions.compress` is shorthand for this. */
+    compress?: boolean;
     reconnect?: boolean;
     maxReconnectAttempts?: number;
     reconnectBaseDelay?: number;

package/dist/types/index.d.ts

@@ -281,6 +281,14 @@ export interface MessageFile {
     name: string;
     data: Blob | Uint8Array | ArrayBuffer | string;
     contentType?: string;
+    /** Alt text, sent as the attachment's `description`. */
+    description?: string;
+}
+/** A file whose bytes are read when the message is sent, such as a `CreateAttachment`. */
+export interface MessageFileSource {
+    name: string;
+    description?: string;
+    toBuffer(): Promise<Uint8Array>;
 }
 /** A poll to send; Discord fills in `results` and `expiry` when it is read back. */
 export interface MessagePoll {
@@ -302,7 +310,7 @@ export interface MessagePoll {
 /** What `send()` takes. */
 export interface MessageCreateOptions extends MessagePayload {
     /** Files to upload; the message is sent as multipart. */
-    files?: MessageFile[];
+    files?: (MessageFile | MessageFileSource)[];
     /** Reply to or forward another message. */
     message_reference?: APIMessageReference;
     poll?: MessagePoll;
@@ -313,13 +321,13 @@ export interface MessageCreateOptions extends MessagePayload {
 }
 /** What `edit()` takes: the fields Discord lets you change after sending. */
 export interface MessageEditOptions extends MessagePayload {
-    files?: MessageFile[];
+    files?: (MessageFile | MessageFileSource)[];
 }
 /** What a reply, edit-reply, follow-up or update to an interaction takes. */
 export interface InteractionReplyOptions extends MessagePayload {
     /** Only the person who ran the command sees it. */
     ephemeral?: boolean;
-    files?: MessageFile[];
+    files?: (MessageFile | MessageFileSource)[];
     poll?: MessagePoll;
     /** On `reply()` / `update()`: return the created message (one request, no `fetchReply()`). */
     withResponse?: boolean;
@@ -721,6 +729,7 @@ export declare const ActivityEnum: {
 };
 /** One {@link ActivityEnum} value, usable as a type. */
 export type ActivityEnum = (typeof ActivityEnum)[keyof typeof ActivityEnum];
+/** An activity in a presence (playing, streaming, listening, a custom status…). */
 export interface APIActivity {
     name: string;
     type: number;
@@ -987,7 +996,8 @@ export interface APIApplicationCommand {
 /** Data for creating/overwriting an application command. */
 export interface ApplicationCommandData {
     name: string;
-    description: string;
+    /** Required for slash commands; user and message context-menu commands have none. */
+    description?: string;
     type?: number;
     options?: APIApplicationCommandOption[];
     default_member_permissions?: string | null;