lunibee 0.2.2 → 0.2.4

package/dist/managers/base.d.ts

@@ -1,10 +1,17 @@
 import { Collection } from "@lunibee/collection";
+/** Splits the audit-log `reason` off an options object, so it becomes a header, not a body field. */
+export declare function splitReason<T extends {
+    reason?: string;
+}>(options: T): [Omit<T, "reason">, string | undefined];
 /** Generic cache manager. @typeParam K Cache key type. @typeParam V Cached value type. */
 export declare class Manager<K, V> {
     #private;
-    /** Authoritative resource state. Entries never expire: see {@link Manager.set}. */ readonly cache: Collection<K, V>;
-    /** Gets a cached value. @param id Cache key. @returns Cached value. */ get(id: K): V | undefined;
-    /** Checks whether a value is cached. @param id Cache key. @returns True when cached. */ has(id: K): boolean;
+    /** Authoritative resource state. Entries never expire: see {@link Manager.set}. */
+    readonly cache: Collection<K, V>;
+    /** Gets a cached value. @param id Cache key. @returns Cached value. */
+    get(id: K): V | undefined;
+    /** Checks whether a value is cached. @param id Cache key. @returns True when cached. */
+    has(id: K): boolean;
     /**
      * Runs a REST load for one key. Concurrent loads of that key share a
      * single request. If the key is written (e.g. by a Gateway update) or
@@ -14,17 +21,22 @@ export declare class Manager<K, V> {
      * @param store Stores a fresh result and returns the canonical instance.
      */
     protected fetchOnce(id: K, load: () => Promise<V>, store?: (value: V) => V): Promise<V>;
-    /** Stores a resource with `setWithoutTTL()`, so it leaves only on an explicit delete (e.g. a Gateway `*_DELETE`), never through TTL. @param id Cache key. @param value Value. @returns This manager. */ set(id: K, value: V): this;
-    /** Deletes a cached value. @param id Cache key. @returns True when deleted. */ delete(id: K): boolean;
-    /** Clears the cache. @returns Nothing. */ clear(): void;
-    /** Gets cache size. @returns Number of cached values. */ get size(): number;
-    /** Gets the first cached value. @returns First value. */ first(): V | undefined;
-    /** Returns cached values. @returns Array of values. */ values(): V[];
-    /** Finds a cached value. @param predicate Predicate. @returns Matching value. */ find(predicate: (value: V, key: K) => boolean): V | undefined;
-    /** Iterates cached entries. @returns Cache iterator. */ [Symbol.iterator](): IterableIterator<[
-        K,
-        V
-    ]>;
+    /** Stores a resource with `setWithoutTTL()`, so it leaves only on an explicit delete (e.g. a Gateway `*_DELETE`), never through TTL. @param id Cache key. @param value Value. @returns This manager. */
+    set(id: K, value: V): this;
+    /** Deletes a cached value. @param id Cache key. @returns True when deleted. */
+    delete(id: K): boolean;
+    /** Clears the cache. @returns Nothing. */
+    clear(): void;
+    /** Gets cache size. @returns Number of cached values. */
+    get size(): number;
+    /** Gets the first cached value. @returns First value. */
+    first(): V | undefined;
+    /** Returns cached values. @returns Array of values. */
+    values(): V[];
+    /** Finds a cached value. @param predicate Predicate. @returns Matching value. */
+    find(predicate: (value: V, key: K) => boolean): V | undefined;
+    /** Iterates cached entries. @returns Cache iterator. */
+    [Symbol.iterator](): IterableIterator<[K, V]>;
 }
 /** Generic REST-backed resource manager. @typeParam K Resource key type. @typeParam V Resource type. */
 export declare class ResourceManager<K, V> extends Manager<K, V> {

package/dist/managers/emoji.d.ts

@@ -3,6 +3,8 @@ import { Emoji } from "@lunibee/structures";
 import { type REST } from "@lunibee/rest";
 /** Strict payload for creating a custom guild emoji. */
 export interface EmojiCreateOptions {
+    /** Audit-log reason. */
+    reason?: string;
     /** Emoji name (1-32 chars, alphanumeric + underscores). */
     name: string;
     /** Base64-encoded 128x128 image data URI. */
@@ -12,6 +14,8 @@ export interface EmojiCreateOptions {
 }
 /** Strict payload for editing a custom guild emoji. */
 export interface EmojiEditOptions {
+    /** Audit-log reason. */
+    reason?: string;
     /** New emoji name. */
     name?: string;
     /** Role IDs allowed to use the emoji. */
@@ -29,7 +33,9 @@ export declare class EmojiManager extends Manager<string, Emoji> {
     create(options: EmojiCreateOptions): Promise<Emoji>;
     /** Edits an existing custom emoji. */
     edit(emojiId: string, options: EmojiEditOptions): Promise<Emoji>;
-    /** Deletes a custom emoji. */
+    /** Deletes a custom emoji. @param reason Audit-log reason. */
+    remove(emojiId: string, reason?: string): Promise<void>;
+    /** @deprecated Use {@link EmojiManager.remove}, which also takes an audit-log reason. Removed in 0.3.0. */
     deleteEmoji(emojiId: string): Promise<void>;
     /** Upserts an emoji into the manager cache. Custom emojis are keyed by their
      * snowflake ID; unicode emojis (no ID) are keyed by `unicode:${name}` so repeated

package/dist/managers/guild-resources.d.ts

@@ -32,7 +32,10 @@ export declare class GuildBanManager extends Manager<string, APIBan> {
     remove(userId: string, reason?: string): Promise<void>;
 }
 /** Fields accepted when creating or editing a scheduled event. */
-export type GuildScheduledEventOptions = Partial<Omit<APIGuildScheduledEvent, "id" | "guild_id" | "creator" | "user_count">> & Record<string, unknown>;
+export type GuildScheduledEventOptions = Partial<Omit<APIGuildScheduledEvent, "id" | "guild_id" | "creator" | "user_count">> & Record<string, unknown> & {
+    /** Audit-log reason. */
+    reason?: string;
+};
 /** Manages a guild's scheduled events, cached by event ID. Discord.js-familiar. */
 export declare class GuildScheduledEventManager extends Manager<string, APIGuildScheduledEvent> {
     #private;
@@ -50,8 +53,8 @@ export declare class GuildScheduledEventManager extends Manager<string, APIGuild
     create(options: GuildScheduledEventOptions, reason?: string): Promise<APIGuildScheduledEvent>;
     /** Edits an event. */
     edit(eventId: string, options: GuildScheduledEventOptions, reason?: string): Promise<APIGuildScheduledEvent>;
-    /** Deletes an event. */
-    remove(eventId: string): Promise<void>;
+    /** Deletes an event. @param reason Audit-log reason. */
+    remove(eventId: string, reason?: string): Promise<void>;
     /** Fetches users subscribed to an event (`limit` 1-100). */
     fetchSubscribers(eventId: string, options?: {
         limit?: number;
@@ -65,6 +68,8 @@ export declare class GuildScheduledEventManager extends Manager<string, APIGuild
 }
 /** Options for creating a stage instance. */
 export interface StageInstanceCreateOptions {
+    /** Audit-log reason. */
+    reason?: string;
     topic: string;
     privacyLevel?: number;
     sendStartNotification?: boolean;
@@ -82,6 +87,7 @@ export declare class StageInstanceManager extends Manager<string, APIStageInstan
     edit(channelId: string, options: {
         topic?: string;
         privacyLevel?: number;
+        reason?: string;
     }, reason?: string): Promise<APIStageInstance>;
     /** Ends a stage instance. */
     remove(channelId: string, reason?: string): Promise<void>;
@@ -90,6 +96,8 @@ export declare class StageInstanceManager extends Manager<string, APIStageInstan
 export type PermissionOverwriteTargetType = 0 | 1;
 /** Permission values accepted by {@link PermissionOverwriteManager.edit}. */
 export interface PermissionOverwriteOptions {
+    /** Audit-log reason. */
+    reason?: string;
     /** Target type: 0 = role, 1 = member. */
     type: PermissionOverwriteTargetType;
     /** Allowed permission bits. */

package/dist/managers/guild.d.ts

@@ -12,6 +12,8 @@ export interface GuildCreateOptions extends Record<string, unknown> {
     name: string;
 }
 export interface GuildEditOptions extends Record<string, unknown> {
+    /** Audit-log reason. */
+    reason?: string;
 }
 export declare class GuildManager extends ResourceManager<string, Guild> {
     #private;
@@ -46,7 +48,9 @@ export declare class GuildManager extends ResourceManager<string, Guild> {
     create(options: GuildCreateOptions): Promise<Guild>;
     /** Modifies a guild's settings. */
     edit(id: string, options: GuildEditOptions): Promise<Guild>;
-    /** Deletes a guild permanently. User must be the owner. */
+    /** Deletes a guild permanently. The bot must own it. */
+    remove(id: string): Promise<void>;
+    /** @deprecated Use {@link GuildManager.remove}. Removed in 0.3.0. */
     deleteGuild(id: string): Promise<void>;
     /** Fetches a guild's preview (even if the bot is not in the guild). */
     fetchPreview(id: string): Promise<APIGuildPreview>;
@@ -87,11 +91,15 @@ export declare class GuildManager extends ResourceManager<string, Guild> {
     /** Fetches a single auto moderation rule. */
     fetchAutoModerationRule(guildId: string, ruleId: string): Promise<AutoModerationRule>;
     /** Creates a new auto moderation rule. */
-    createAutoModerationRule(guildId: string, options: Record<string, unknown>): Promise<AutoModerationRule>;
+    createAutoModerationRule(guildId: string, options: Record<string, unknown> & {
+        reason?: string;
+    }): Promise<AutoModerationRule>;
     /** Modifies an existing auto moderation rule. */
-    editAutoModerationRule(guildId: string, ruleId: string, options: Record<string, unknown>): Promise<AutoModerationRule>;
-    /** Deletes an auto moderation rule. */
-    deleteAutoModerationRule(guildId: string, ruleId: string): Promise<void>;
+    editAutoModerationRule(guildId: string, ruleId: string, options: Record<string, unknown> & {
+        reason?: string;
+    }): Promise<AutoModerationRule>;
+    /** Deletes an auto moderation rule. @param reason Audit-log reason. */
+    deleteAutoModerationRule(guildId: string, ruleId: string, reason?: string): Promise<void>;
 }
 /** A single audit log entry as returned by the Discord API. */
 export interface AuditLogEntry {

package/dist/managers/index.d.ts

@@ -3,6 +3,7 @@ export { Manager, ResourceManager } from "./base.js";
 /** Discord.js-familiar alias for {@link ResourceManager}. */
 export { ResourceManager as CachedManager } from "./base.js";
 import { REST } from "@lunibee/rest";
+import type { AllowedMentions } from "@lunibee/types";
 import { Channel, Message, User } from "@lunibee/structures";
 import { MessageManager, type MessageCacheOptions, type MessageCreateOptions as ManagerMessageCreateOptions } from "./message.js";
 import { ThreadManager } from "./thread.js";
@@ -33,12 +34,17 @@ export interface ReactionFetchOptions {
     after?: string;
 }
 export interface ChannelCreateOptions extends Record<string, unknown> {
+    /** Audit-log reason. */
+    reason?: string;
     name: string;
     type: number;
     guild_id?: string;
     parent_id?: string | null;
 }
-export type ChannelEditOptions = Record<string, unknown>;
+export type ChannelEditOptions = Record<string, unknown> & {
+    /** Audit-log reason. */
+    reason?: string;
+};
 import { PermissionOverwriteManager } from "./guild-resources.js";
 export declare class ChannelManager extends Manager<string, Channel> {
     #private;
@@ -48,7 +54,7 @@ export declare class ChannelManager extends Manager<string, Channel> {
      */
     constructor(rest: REST, options?: {
         messageCache?: MessageCacheOptions;
-        allowedMentions?: unknown;
+        allowedMentions?: AllowedMentions;
     });
     messages(channelId: string): MessageManager;
     /** Permission overwrite manager for a channel. */
@@ -77,27 +83,32 @@ export declare class ChannelManager extends Manager<string, Channel> {
     cachedMessages(channelId: string): MessageManager | undefined;
     create(guildId: string, options: ChannelCreateOptions): Promise<Channel>;
     edit(channelId: string, options: ChannelEditOptions): Promise<Channel>;
+    /** Deletes a channel (or closes a DM). @param reason Audit-log reason. */
+    remove(channelId: string, reason?: string): Promise<void>;
+    /** @deprecated Use {@link ChannelManager.remove}, which also takes an audit-log reason. Removed in 0.3.0. */
     deleteChannel(channelId: string): Promise<void>;
     /** Evicts a channel, dropping its per-channel message manager with it.
      * Overrides {@link Manager.delete} so cache eviction driven by a Gateway
      * `CHANNEL_DELETE`/`THREAD_DELETE` — which calls `delete` rather than
-     * {@link deleteChannel} — releases the message manager and its cached
+     * {@link remove} — releases the message manager and its cached
      * messages too, instead of retaining them for the client's lifetime. */
     delete(channelId: string): boolean;
     send(channelId: string, options: MessageCreateOptions): Promise<Message>;
+    /** @deprecated Use {@link ChannelManager.send}. Removed in 0.3.0. */
     sendMessage(channelId: string, options: MessageCreateOptions): Promise<Message>;
     fetchMessage(channelId: string, messageId: string, options?: MessageFetchOptions): Promise<Message>;
     fetchMessages(channelId: string, query: MessageQueryOptions | Iterable<string>): Promise<Message[]>;
     upsertMessage(data: ConstructorParameters<typeof Message>[0]): Message;
     editMessage(channelId: string, messageId: string, options: MessageEditOptions): Promise<Message>;
-    deleteMessage(channelId: string, messageId: string): Promise<void>;
+    /** Deletes a message. @param reason Audit-log reason (shown when deleting someone else's message). */
+    deleteMessage(channelId: string, messageId: string, reason?: string): Promise<void>;
     deleteCachedMessage(channelId: string, messageId: string): boolean;
     crosspostMessage(channelId: string, messageId: string): Promise<Message>;
     /** Bulk-deletes messages in a channel. Duplicate IDs are ignored and a
      * single ID falls back to a normal delete.
      * @throws {RangeError} If no IDs or more than 100 are provided, or any
      * message is older than 14 days (Discord refuses to bulk-delete those). */
-    bulkDeleteMessages(channelId: string, messageIds: Iterable<string>): Promise<void>;
+    bulkDeleteMessages(channelId: string, messageIds: Iterable<string>, reason?: string): Promise<void>;
     /**
      * Iterates a channel's history newest-first, 100 messages per request,
      * starting before `before` (or the latest message) and stopping after
@@ -112,9 +123,18 @@ export declare class ChannelManager extends Manager<string, Channel> {
     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>;
+    /** Fetches the newest pinned messages (one page, up to 50, like the endpoint it replaces). */
     fetchPinnedMessages(channelId: string): Promise<Message[]>;
-    pinMessage(channelId: string, messageId: string): Promise<void>;
-    unpinMessage(channelId: string, messageId: string): Promise<void>;
+    /** Pins a message. @param reason Audit-log reason. */
+    pinMessage(channelId: string, messageId: string, reason?: string): Promise<void>;
+    /** Unpins a message. @param reason Audit-log reason. */
+    unpinMessage(channelId: string, messageId: string, reason?: string): Promise<void>;
+    /** Creates a webhook in a channel. @param options Name, optional avatar data URI, and audit-log `reason`. */
+    createWebhook(channelId: string, options: {
+        name: string;
+        avatar?: string | null;
+        reason?: string;
+    }): Promise<import("@lunibee/types").APIWebhook>;
     createThreadFromMessage(channelId: string, messageId: string, options: MessageThreadOptions): Promise<Channel>;
     /**
      * Fetches a page of messages with cursor metadata.
@@ -128,13 +148,7 @@ export declare class ChannelManager extends Manager<string, Channel> {
         after?: string;
         hasMore: boolean;
     }>;
-    /**
-     * Bulk-deletes 2–100 messages from a channel.
-     * Only messages younger than 14 days are accepted by Discord.
-     * @param channelId Channel to delete from.
-     * @param messageIds Array of message IDs to delete.
-     * @throws {RangeError} If fewer than 2 or more than 100 IDs are provided.
-     */
+    /** @deprecated Use {@link ChannelManager.bulkDeleteMessages}, which also takes an audit-log reason. Removed in 0.3.0. */
     bulkDelete(channelId: string, messageIds: string[]): Promise<void>;
     clear(): void;
 }