lunibee 0.1.5 → 0.1.7

package/dist/structures/base.d.ts

@@ -1,75 +1,158 @@
 /** Common Discord snowflake-backed structure. */
 export declare class BaseStructure {
-    /** Discord resource ID. */
     readonly id: string;
-    /** Creates a structure from an ID. @param id Discord snowflake identifier. @throws {TypeError} If the ID is invalid. */
     constructor(id: string);
-    /** Returns the resource ID. @returns Discord snowflake identifier. */
+    /** Returns the snowflake ID as a string. */
     toString(): string;
+    /** Returns the timestamp this snowflake was created at. */
+    get createdAt(): Date;
 }
-/** Context used by structures to delegate resource operations to the owning client. */
 export interface ResourceContext {
-    /** Sends a message through the owning channel manager. @param channelId Channel identifier. @param options Message payload. @returns The created message. */
-    sendMessage(channelId: string, options: {
+    sendMessage(channelId: string, options: Record<string, unknown> & {
         content?: string;
     }): Promise<import("./index.js").Message>;
-    /** Edits a message through the owning channel manager. @param channelId Channel identifier. @param messageId Message identifier. @param options Edit payload. @returns The updated message. */
-    editMessage(channelId: string, messageId: string, options: {
+    editMessage(channelId: string, messageId: string, options: Record<string, unknown> & {
         content?: string;
     }): Promise<import("./index.js").Message>;
-    /** Deletes a message through the owning channel manager. @param channelId Channel identifier. @param messageId Message identifier. @returns A promise fulfilled after deletion. */
     deleteMessage(channelId: string, messageId: string): Promise<void>;
-    /** Crossposts a message through the owning channel manager. @param channelId Channel identifier. @param messageId Message identifier. @returns The crossposted message. */
     crosspostMessage(channelId: string, messageId: string): Promise<import("./index.js").Message>;
+    editChannel?(channelId: string, options: Record<string, unknown>): Promise<import("./base.js").Channel>;
+    deleteChannel?(channelId: string): Promise<void>;
+    addReaction?(channelId: string, messageId: string, emoji: string): Promise<void>;
+    removeOwnReaction?(channelId: string, messageId: string, emoji: string): Promise<void>;
+    removeReaction?(channelId: string, messageId: string, emoji: string, userId: string): Promise<void>;
+    removeAllReactions?(channelId: string, messageId: string): Promise<void>;
+    pinMessage?(channelId: string, messageId: string): Promise<void>;
+    unpinMessage?(channelId: string, messageId: string): Promise<void>;
 }
-/** Represents a Discord user. */
+export declare const CDN_BASE = "https://cdn.discordapp.com";
+/** Options for CDN image URLs. */
+export interface ImageURLOptions {
+    extension?: "png" | "jpg" | "webp" | "gif" | "jpeg";
+    size?: 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;
+    forceStatic?: boolean;
+}
+/** Builds a Discord CDN asset URL from a directory path and asset hash, applying
+ * animated-hash (`a_`) gif detection, extension and size options. Shared by all
+ * hash-backed asset accessors (user/member/role/webhook) to avoid duplicating the logic.
+ * @param path CDN directory path, e.g. `/role-icons/{id}`. @param hash Asset hash. @param options Image URL options. */
+export declare function cdnURL(path: string, hash: string, options?: ImageURLOptions): string;
 export declare class User extends BaseStructure {
-    /** User name. */ username: string;
-    /** Global display name. */ globalName: string | null;
-    /** Avatar hash. */ avatar: string | null;
-    /** Whether the user is a bot. */ bot: boolean;
-    /** Whether the account is a Discord system user. */ system: boolean;
-    /** Public user flags. */ flags: number;
-    /** Creates a user from Discord API data. @param data User payload. @throws {TypeError} If required data is invalid. */
+    username: string;
+    globalName: string | null;
+    avatar: string | null;
+    bot: boolean;
+    system: boolean;
+    flags: number;
+    discriminator: string | null;
     constructor(data: import("@lunibee/types").UserData);
-    /** Gets the effective display name. @returns Global display name or username. */
+    /** Effective display name — global name, falling back to username. */
     get displayName(): string;
-    /** Creates an avatar CDN URL. @param options URL format options. @returns Avatar URL, or null when no custom avatar exists. */
-    avatarURL(options?: {
-        extension?: "png" | "jpg" | "webp" | "gif";
-        size?: number;
-    }): string | null;
-    /** Creates the default avatar URL. @returns Discord default avatar URL. */
+    /** Returns the user's avatar URL, or null if they have no avatar. */
+    avatarURL(options?: ImageURLOptions): string | null;
+    /** Returns the default avatar URL based on the user's discriminator/snowflake. */
     defaultAvatarURL(): string;
-    /** Creates an avatar URL with default fallback. @param options URL format options. @returns Avatar or default avatar URL. */
-    displayAvatarURL(options?: {
-        extension?: "png" | "jpg" | "webp" | "gif";
-        size?: number;
-    }): string;
+    /** Returns the avatar URL if available, falling back to the default avatar URL. */
+    displayAvatarURL(options?: ImageURLOptions): string;
+    /** Returns the Discord mention string. Used automatically in template literals. */
+    toString(): string;
 }
-/** Represents a Discord channel. */
 export declare class Channel extends BaseStructure {
     #private;
-    /** Discord channel type. */ type: number;
-    /** Channel name. */ name?: string | null;
-    /** Guild containing the channel. */ guildId?: string;
-    /** Creates a channel from Discord API data. @param data Channel payload. @param context Optional owning resource context. @throws {TypeError|RangeError} If required channel data is invalid. */
+    type: number;
+    name?: string | null;
+    guildId?: string;
+    topic?: string | null;
+    parentId?: string | null;
+    nsfw?: boolean;
+    rateLimitPerUser?: number;
+    position?: number;
+    /** Creates a channel structure from Discord channel data. */
     constructor(data: import("@lunibee/types").APIChannel, context?: ResourceContext);
-    /** Sends a message through the owning manager. @param options Message payload. @returns The created message. @throws {Error} If this channel is detached from a client. */
-    sendMessage(options: {
+    /** Sends a message to this channel. @param options Message payload. @returns The created message. @throws {Error} If the channel is not attached to a client. */
+    sendMessage(options: Record<string, unknown> & {
+        content?: string;
+    }): Promise<import("./index.js").Message>;
+    /** Sends a message using Lunibee's concise channel API. @param options Message payload. @returns The created message. @throws {Error} If the channel is not attached to a client. */
+    send(options: Record<string, unknown> & {
         content?: string;
     }): Promise<import("./index.js").Message>;
+    /** Edits this channel. @param options Channel fields to change. @returns The updated channel. @throws {Error} If the channel is not attached to a client. */
+    edit(options: Record<string, unknown>): Promise<Channel>;
+    /** Changes only this channel's name. @param name New channel name. @returns The updated channel. @throws {TypeError} If the name is empty. @throws {Error} If the channel is not attached to a client. */
+    editName(name: string): Promise<Channel>;
+    /** Changes only this channel's topic. @param topic New topic, or null to clear it. @returns The updated channel. @throws {Error} If the channel is not attached to a client. */
+    editTopic(topic: string | null): Promise<Channel>;
+    /** Moves this channel to another parent category. @param parentId Parent category ID, or null to remove the parent. @returns The updated channel. @throws {Error} If the channel is not attached to a client. */
+    editParent(parentId: string | null): Promise<Channel>;
+    /** Deletes this channel. @returns A promise fulfilled when Discord confirms deletion. @throws {Error} If the channel is not attached to a client. */
+    delete(): Promise<void>;
+    /** Updates this channel using the same resource operation as edit. @param options Channel fields to change. @returns The updated channel. @throws {Error} If the channel is not attached to a client. */
+    update(options: Record<string, unknown>): Promise<Channel>;
+    /** Returns the Discord channel mention string. Used automatically in template literals. */
+    toString(): string;
 }
-/** Represents a Discord guild. */
 export declare class Guild extends BaseStructure {
-    /** Guild name. */ name: string;
-    /** Preferred guild locale. */ preferredLocale?: string;
-    /** Guild owner ID. */ ownerId?: string;
-    /** Creates a guild from Discord API data. @param data Guild payload. @throws {TypeError} If required data is invalid. */
-    constructor(data: {
-        id: string;
-        name: string;
-        preferred_locale?: string;
-        owner_id?: string;
-    });
+    name: string;
+    icon: string | null;
+    splash: string | null;
+    banner: string | null;
+    description: string | null;
+    preferredLocale: string;
+    ownerId?: string;
+    features: string[];
+    verificationLevel: number;
+    premiumTier: number;
+    premiumSubscriptionCount: number;
+    memberCount?: number;
+    approximateMemberCount?: number;
+    approximatePresenceCount?: number;
+    vanityUrlCode: string | null;
+    nsfwLevel: number;
+    discoverySplash: string | null;
+    /** ID of the rules channel for Community guilds. */
+    rulesChannelId: string | null;
+    /** ID of the system messages channel. */
+    systemChannelId: string | null;
+    /** Bitfield of system channel flags. */
+    systemChannelFlags: number;
+    /** Maximum number of members the guild can have. */
+    maxMembers: number;
+    /** Required MFA level for administrators. */
+    mfaLevel: number;
+    /** Explicit content filter level. */
+    explicitContentFilter: number;
+    /** Default notification level for new members. */
+    defaultMessageNotifications: number;
+    constructor(data: import("@lunibee/types").APIGuild);
+    /** Returns the guild icon URL, or null if no icon is set. */
+    iconURL(options?: ImageURLOptions): string | null;
+    /** Returns the guild splash URL, or null if none. */
+    splashURL(options?: ImageURLOptions): string | null;
+    /** Returns the guild banner URL, or null if none. */
+    bannerURL(options?: ImageURLOptions): string | null;
+    /** Returns the guild discovery splash URL, or null if none. */
+    discoverySplashURL(options?: ImageURLOptions): string | null;
+    /** Returns a widget image URL for the guild.
+     * @param style Widget style: shield (default), banner1, banner2, banner3, banner4.
+     */
+    widgetImageURL(style?: "shield" | "banner1" | "banner2" | "banner3" | "banner4"): string;
+    /** Whether the guild has a given feature flag. @param feature Feature string, e.g. "COMMUNITY". */
+    hasFeature(feature: string): boolean;
+    /** Whether the guild is a Community server. */
+    get isCommunity(): boolean;
+    /** Whether the guild is an official Discord Partner. */
+    get isPartnered(): boolean;
+    /** Whether the guild is verified by Discord. */
+    get isVerified(): boolean;
+    /** Whether the guild has any active boost subscriptions. */
+    get isBoosted(): boolean;
+    /** Alias for premiumTier — the guild's current Nitro boost level (0–3). */
+    get boostLevel(): number;
+    /** Whether the guild has a vanity URL. */
+    get hasVanityUrl(): boolean;
+    /** Returns the guild's vanity invite URL, or null if none. */
+    get vanityURL(): string | null;
+    /** Returns a human-readable string representation. */
+    toString(): string;
 }

package/dist/structures/embed.d.ts

@@ -0,0 +1,65 @@
+import type { APIEmbed, APIEmbedAuthor, APIEmbedField, APIEmbedFooter, APIEmbedMedia } from "@lunibee/types";
+/**
+ * A rich Embed structure that wraps a Discord API embed object.
+ * Provides typed accessors and a fluent builder interface.
+ */
+export declare class Embed {
+    #private;
+    /** Creates an Embed from raw Discord API data, or starts a blank embed. */
+    constructor(data?: APIEmbed);
+    /** Embed title. */
+    get title(): string | undefined;
+    /** Embed description. */
+    get description(): string | undefined;
+    /** Embed URL. */
+    get url(): string | undefined;
+    /** Embed color as an integer. */
+    get color(): number | undefined;
+    /** Embed timestamp ISO 8601 string. */
+    get timestamp(): string | undefined;
+    /** Embed timestamp as a Date object, or undefined. */
+    get createdAt(): Date | undefined;
+    /** Embed footer. */
+    get footer(): APIEmbedFooter | undefined;
+    /** Embed image. */
+    get image(): APIEmbedMedia | undefined;
+    /** Embed thumbnail. */
+    get thumbnail(): APIEmbedMedia | undefined;
+    /** Embed video. */
+    get video(): APIEmbedMedia | undefined;
+    /** Embed author. */
+    get author(): APIEmbedAuthor | undefined;
+    /** Embed fields (read-only copy). */
+    get fields(): readonly APIEmbedField[];
+    /** Sets the embed title. @param title Embed title text (max 256 chars). @throws {TypeError} If title exceeds 256 characters. */
+    setTitle(title: string): this;
+    /** Sets the embed description. @param description Embed description (max 4096 chars). @throws {TypeError} If description exceeds 4096 characters. */
+    setDescription(description: string): this;
+    /** Sets the embed URL. @param url A valid URL string. */
+    setURL(url: string): this;
+    /** Sets the embed color. Accepts a hex number (0xff0000), decimal integer, or hex string ("#ff0000"). @param color Color value. */
+    setColor(color: number | string): this;
+    /** Sets the embed timestamp. Accepts a Date, ISO string, or number (ms since epoch). Defaults to now. */
+    setTimestamp(timestamp?: Date | string | number): this;
+    /** Sets the embed footer. @param text Footer text (max 2048 chars). @param iconURL Optional footer icon URL. */
+    setFooter(text: string, iconURL?: string): this;
+    /** Sets the embed image. @param url Image URL. */
+    setImage(url: string): this;
+    /** Sets the embed thumbnail. @param url Thumbnail URL. */
+    setThumbnail(url: string): this;
+    /** Sets the embed author. @param name Author name (max 256 chars). @param options Optional URL and icon URL. */
+    setAuthor(name: string, options?: {
+        url?: string;
+        iconURL?: string;
+    }): this;
+    /** Adds one or more fields to the embed. @param fields Fields to add (max 25 total). @throws {TypeError} If adding exceeds 25 fields. */
+    addFields(...fields: APIEmbedField[]): this;
+    /** Removes all fields from the embed. */
+    clearFields(): this;
+    /** Splices the fields array, replacing, inserting, or deleting fields. @param index Start index. @param deleteCount Number of fields to remove. @param fields Replacement fields. */
+    spliceFields(index: number, deleteCount: number, ...fields: APIEmbedField[]): this;
+    /** Returns the raw Discord API embed payload. */
+    toJSON(): APIEmbed;
+    /** Creates an Embed from an existing raw API embed object. */
+    static from(data: APIEmbed): Embed;
+}

package/dist/structures/index.d.ts

@@ -1,39 +1,87 @@
+/** Resource structures for Discord messages and related entities. */
 import { BaseStructure, Channel, User } from "./base.js";
 import type { ResourceContext } from "./base.js";
-/** Common Discord structure exports. */
 export { BaseStructure, Channel, Guild, User } from "./base.js";
 export type { ResourceContext } from "./base.js";
-/** Represents a Discord message. */
 export declare class Message extends BaseStructure {
     #private;
-    /** Message content. */ content: string;
-    /** Message author. */ author: User;
-    /** Channel ID containing the message. */ channelId: string;
-    /** Channel containing the message. */ readonly channel: Channel;
-    /** Guild ID containing the message. */ guildId?: string;
-    /** Message flags. */ flags: number;
-    /** Message creation time. */ readonly createdAt: Date;
-    /** Message attachments. */ readonly attachments: import("@lunibee/types").APIAttachment[];
-    /** Message embeds. */ readonly embeds: import("@lunibee/types").APIEmbed[];
-    /** Mentioned users. */ readonly mentions: User[];
-    /** Mentioned role IDs. */ readonly mentionRoles: string[];
-    /** Whether the message is pinned. */ pinned: boolean;
-    /** Whether the message mentions everyone. */ mentionEveryone: boolean;
-    /** Discord message type. */ type: number;
-    /** Message reference (reply chain data). */ readonly reference?: import("@lunibee/types").APIMessageReference;
-    /** The referenced/replied-to message, if included by Discord. */ readonly referencedMessage?: Message | null;
-    /** Creates a message from Discord API data. @param data Message payload. @param context Optional owning resource context. @throws {TypeError} If required message identifiers are invalid. */
+    content: string;
+    author: User;
+    channelId: string;
+    readonly channel: Channel;
+    guildId?: string;
+    flags: number;
+    /** Message creation timestamp (from timestamp field or snowflake). */
+    readonly timestamp: Date;
+    readonly attachments: import("@lunibee/types").APIAttachment[];
+    readonly embeds: import("@lunibee/types").APIEmbed[];
+    readonly mentions: User[];
+    readonly mentionRoles: string[];
+    pinned: boolean;
+    mentionEveryone: boolean;
+    type: number;
+    readonly reference?: import("@lunibee/types").APIMessageReference;
+    readonly components: import("@lunibee/types").APIMessageComponent[];
+    readonly referencedMessage?: Message | null;
+    /** Creates a message structure from Discord message data. */
     constructor(data: import("@lunibee/types").APIMessage, context?: ResourceContext);
-    /** Whether embeds are suppressed. @returns True when the suppress-embeds flag is set. */ get embedsSuppressed(): boolean;
-    /** Edits this message. @param options Edit payload. @returns Updated message. @throws {Error} If detached from a client. */ edit(options: {
+    /** Whether embeds are suppressed on this message. */
+    get embedsSuppressed(): boolean;
+    /** Unix timestamp (ms) at which the message was created — discord.js parity.
+     * Derived from the message `timestamp`, which itself falls back to the id snowflake. */
+    get createdTimestamp(): number;
+    /** Date at which the message was created — discord.js parity. Overrides the
+     * snowflake-only `BaseStructure.createdAt` to honour the message `timestamp`. */
+    get createdAt(): Date;
+    /** Edits this message. @param options Message fields to change. @returns The updated message. @throws {Error} If the message is not attached to a client. */
+    edit(options: Record<string, unknown> & {
         content?: string;
     }): Promise<Message>;
-    /** Deletes this message. @returns Nothing. @throws {Error} If detached from a client. */ delete(): Promise<void>;
-    /** Crossposts this message. @returns Crossposted message. @throws {Error} If detached from a client. */ crosspost(): Promise<Message>;
-    /** Replies in this message's channel, auto-populating message_reference. @param options Message content or payload. @returns Created reply. @throws {Error} If detached from a client. */ reply(options: string | {
+    /** Updates this message using the same resource operation as edit. @param options Message fields to change. @returns The updated message. @throws {Error} If the message is not attached to a client. */
+    update(options: Record<string, unknown> & {
         content?: string;
-        [key: string]: unknown;
     }): Promise<Message>;
+    /** Deletes this message. @returns A promise fulfilled when Discord confirms deletion. @throws {Error} If the message is not attached to a client. */
+    delete(): Promise<void>;
+    /** Replies to this message. @param options Message content or payload. @returns The created reply message. @throws {Error} If the message is not attached to a client. */
+    reply(options: string | (Record<string, unknown> & {
+        content?: string;
+    })): Promise<Message>;
+    /** Crossposts this message. @returns The resulting message. @throws {Error} If the message is not attached to a client. */
+    crosspost(): Promise<Message>;
+    /** Adds a reaction to this message. @param emoji Emoji identifier. @returns A promise fulfilled when the reaction is added. @throws {Error} If reactions are unavailable. */
+    react(emoji: string): Promise<void>;
+    /** Removes a reaction from this message. @param emoji Emoji identifier. @param userId User whose reaction should be removed; omit to remove the current user's reaction. @returns A promise fulfilled when the reaction is removed. @throws {Error} If reaction operations are unavailable. */
+    removeReaction(emoji: string, userId?: string): Promise<void>;
+    /** Removes all reactions from this message. @returns A promise fulfilled when reactions are removed. @throws {Error} If reaction operations are unavailable. */
+    removeAllReactions(): Promise<void>;
+    /** Pins this message. @returns A promise fulfilled when the message is pinned. @throws {Error} If pin operations are unavailable. */
+    pin(): Promise<void>;
+    /** Unpins this message. @returns A promise fulfilled when the message is unpinned. @throws {Error} If pin operations are unavailable. */
+    unpin(): Promise<void>;
+    /** Whether this message was sent ephemerally (only visible to the recipient). */
+    get isEphemeral(): boolean;
+    /** Whether this message is currently pinned in its channel. */
+    get isPinned(): boolean;
+    /** Whether this is a system-generated message (join, boost, etc). Mirrors
+     * discord.js: a message is "system" unless its type is one of the user-authored
+     * types — Default (0), Reply (19), ChatInputCommand (20) or ContextMenuCommand (23). */
+    get isSystemMessage(): boolean;
+    /** Whether this message was crossposted from an announcement channel. */
+    get isCrosspost(): boolean;
+    /** Whether this message has file attachments. */
+    get hasAttachments(): boolean;
+    /** Whether this message contains embeds. */
+    get hasEmbeds(): boolean;
+    /** Whether this message contains interactive components. */
+    get hasComponents(): boolean;
+    /** Edits this message to suppress its embeds. @returns The updated message. */
+    suppressEmbeds(): Promise<Message>;
+    /** Returns a plain-object snapshot of all message fields. */
+    toJSON(): Record<string, unknown>;
 }
-export { GuildMember, Role, TextChannel } from "./resources.js";
+export { GuildMember, Role, TextChannel, Invite, Webhook, WebhookType, Emoji, AutoModerationRule, WelcomeScreenChannel, GuildWelcomeScreen, OnboardingPromptOption, OnboardingPrompt, GuildOnboarding, } from "./resources.js";
 export * from "./interactions.js";
+export { Embed } from "./embed.js";
+export { AuditLog, AuditLogEntry } from "./audit-log.js";
+export { PermissionsBitField } from "@lunibee/core";