@fluxerjs/core 1.1.1 → 1.1.2

package/dist/index.d.ts

@@ -1,12 +1,12 @@
 import * as _fluxerjs_types from '@fluxerjs/types';
-import { APIEmbed, APIWebhook, APIWebhookUpdateRequest, APIWebhookTokenUpdateRequest, APIChannelOverwrite, APIChannel, APIChannelPartial, ChannelType, GatewayReactionEmoji, GatewayMessageReactionAddDispatchData, GatewayMessageReactionRemoveDispatchData, APIMessageAttachment, MessageType, APIMessageSticker, APIMessageReaction, APIMessageReference, APIMessageSnapshot, APIMessageCall, APIMessage, APIUserPartial, APIGuildMember, APIRole, APIBan, GuildFeature, GuildVerificationLevel, DefaultMessageNotifications, GuildExplicitContentFilter, GuildMFALevel, APIGuild, APIGuildAuditLog, APIGuildPartial, APIInvite, GatewayPresenceUpdateData, GatewayMessageReactionRemoveAllDispatchData, GatewayMessageReactionRemoveEmojiDispatchData, GatewayVoiceStateUpdateDispatchData, GatewayVoiceServerUpdateDispatchData, GatewayGuildEmojisUpdateDispatchData, GatewayGuildStickersUpdateDispatchData, GatewayGuildIntegrationsUpdateDispatchData, GatewayGuildScheduledEventCreateDispatchData, GatewayGuildScheduledEventUpdateDispatchData, GatewayGuildScheduledEventDeleteDispatchData, GatewayChannelPinsUpdateDispatchData, GatewayPresenceUpdateDispatchData, GatewayWebhooksUpdateDispatchData, GatewaySendPayload, Routes, APIEmoji, APISticker } from '@fluxerjs/types';
+import { APIEmbed, APIWebhook, APIWebhookUpdateRequest, APIWebhookTokenUpdateRequest, APIChannelOverwrite, APIChannel, APIChannelPartial, ChannelType, GatewayReactionEmoji, GatewayMessageReactionAddDispatchData, GatewayMessageReactionRemoveDispatchData, APIMessageAttachment, MessageType, APIMessageSticker, APIMessageReaction, APIMessageReference, APIMessageSnapshot, APIMessageCall, APIMessage, APIUserPartial, APIGuildMember, APIRole, RESTUpdateRoleBody, APIBan, GuildFeature, GuildVerificationLevel, DefaultMessageNotifications, GuildExplicitContentFilter, GuildMFALevel, APIGuild, RESTCreateRoleBody, APIGuildAuditLog, APIGuildPartial, APIInvite, GatewayPresenceUpdateData, APIProfileResponse, GatewayMessageReactionRemoveAllDispatchData, GatewayMessageReactionRemoveEmojiDispatchData, GatewayVoiceStateUpdateDispatchData, GatewayVoiceServerUpdateDispatchData, GatewayGuildEmojisUpdateDispatchData, GatewayGuildStickersUpdateDispatchData, GatewayGuildIntegrationsUpdateDispatchData, GatewayGuildScheduledEventCreateDispatchData, GatewayGuildScheduledEventUpdateDispatchData, GatewayGuildScheduledEventDeleteDispatchData, GatewayChannelPinsUpdateDispatchData, GatewayPresenceUpdateDispatchData, GatewayWebhooksUpdateDispatchData, GatewaySendPayload, Routes, APIEmoji, APISticker } from '@fluxerjs/types';
 export { GatewayOpcodes, MessageAttachmentFlags, Routes } from '@fluxerjs/types';
+import { PermissionResolvable } from '@fluxerjs/util';
+export { PermissionFlags, PermissionResolvable, PermissionString, PermissionsBitField, UserFlagsBitField, UserFlagsBits, UserFlagsResolvable, UserFlagsString, resolvePermissionsToBitfield, resolveTenorToImageUrl } from '@fluxerjs/util';
 import { Collection } from '@fluxerjs/collection';
 import { EmbedBuilder } from '@fluxerjs/builders';
 export { AttachmentBuilder, EmbedBuilder, MessagePayload } from '@fluxerjs/builders';
 import { EventEmitter } from 'events';
-import { PermissionResolvable } from '@fluxerjs/util';
-export { PermissionFlags, PermissionResolvable, PermissionString, PermissionsBitField, resolveTenorToImageUrl } from '@fluxerjs/util';
 import { REST } from '@fluxerjs/rest';
 import { WebSocketManager } from '@fluxerjs/ws';
 
@@ -715,6 +715,36 @@ declare class GuildMember extends Base {
     private _computeBasePermissions;
 }
 
+/**
+ * Manages guild members with a Collection-like API.
+ * Extends Collection so you can use .get(), .set(), .filter(), etc.
+ * Provides guild.members.me for Discord.js parity.
+ */
+declare class GuildMemberManager extends Collection<string, GuildMember> {
+    private readonly guild;
+    constructor(guild: Guild);
+    /**
+     * The current bot user as a GuildMember in this guild.
+     * Returns null if the bot's member is not cached or client.user is null.
+     * Use fetchMe() to load the bot's member when not cached.
+     *
+     * @example
+     * const perms = guild.members.me?.permissions;
+     * if (perms?.has(PermissionFlags.BanMembers)) { ... }
+     */
+    get me(): GuildMember | null;
+    /**
+     * Fetch the current bot user as a GuildMember in this guild.
+     * Caches the result in guild.members.
+     *
+     * @throws Error if client.user is null (client not ready)
+     * @example
+     * const me = await guild.members.fetchMe();
+     * console.log(me.displayName);
+     */
+    fetchMe(): Promise<GuildMember>;
+}
+
 /** Represents a role in a guild. */
 declare class Role extends Base {
     readonly client: Client;
@@ -733,6 +763,8 @@ declare class Role extends Base {
     /** @param data - API role from GET /guilds/{id}/roles or gateway role events */
     /** @param guildId - The guild this role belongs to */
     constructor(client: Client, data: APIRole, guildId: string);
+    /** Update mutable fields from fresh API data. Used by edit and gateway events. */
+    _patch(data: Partial<APIRole>): void;
     /** Returns a mention string (e.g. `<@&123456>`). */
     toString(): string;
     /**
@@ -744,6 +776,22 @@ declare class Role extends Base {
      * if (role.has('ManageChannels')) { ... }
      */
     has(permission: PermissionResolvable): boolean;
+    /**
+     * Edit this role.
+     * Requires Manage Roles permission.
+     * @param options - Role updates (permissions accepts PermissionResolvable for convenience)
+     * @returns This role (updated in place)
+     * @example
+     * await role.edit({ name: 'Moderator', permissions: ['BanMembers', 'KickMembers'] });
+     */
+    edit(options: RESTUpdateRoleBody & {
+        permissions?: string | PermissionResolvable;
+    }): Promise<Role>;
+    /**
+     * Delete this role.
+     * Requires Manage Roles permission.
+     */
+    delete(): Promise<void>;
 }
 
 /** Represents a ban in a guild. */
@@ -800,7 +848,7 @@ declare class Guild extends Base {
     splashWidth?: number | null;
     /** Splash image height. Optional. */
     splashHeight?: number | null;
-    members: Collection<string, GuildMember>;
+    members: GuildMemberManager;
     channels: Collection<string, GuildChannel>;
     roles: Collection<string, Role>;
     /** @param data - API guild from GET /guilds/{id} or gateway GUILD_CREATE */
@@ -834,6 +882,29 @@ declare class Guild extends Base {
      * Requires Manage Roles permission.
      */
     removeRoleFromMember(userId: string, roleId: string): Promise<void>;
+    /**
+     * Create a role in this guild.
+     * Requires Manage Roles permission.
+     * @param options - Role data (permissions accepts PermissionResolvable for convenience)
+     * @returns The created role
+     * @example
+     * const role = await guild.createRole({ name: 'Mod', permissions: ['KickMembers', 'BanMembers'] });
+     */
+    createRole(options: RESTCreateRoleBody & {
+        permissions?: string | PermissionResolvable;
+    }): Promise<Role>;
+    /**
+     * Fetch all roles in this guild.
+     * @returns Array of Role objects (cached in guild.roles)
+     */
+    fetchRoles(): Promise<Role[]>;
+    /**
+     * Fetch a role by ID.
+     * @param roleId - The role ID to fetch
+     * @returns The role
+     * @throws FluxerError with ROLE_NOT_FOUND if role does not exist (404)
+     */
+    fetchRole(roleId: string): Promise<Role>;
     /**
      * Resolve a role ID from an argument (role mention, raw ID, or name).
      * Fetches guild roles if name is provided.
@@ -1106,6 +1177,62 @@ declare const Events: {
     readonly Debug: "debug";
 };
 
+/** Result of {@link UsersManager.fetchWithProfile}. */
+interface FetchedUserWithProfile {
+    /** The user (cached in client.users). */
+    user: User;
+    /** Raw user data from GET /users/{id}. */
+    userData: APIUserPartial;
+    /** Global profile (bio, pronouns, mutual guilds, etc.). Null if unavailable. */
+    globalProfile: APIProfileResponse | null;
+    /** Server-specific profile when guildId was provided. Null if unavailable. */
+    serverProfile: APIProfileResponse | null;
+    /** Guild member when guildId was provided and user is in the guild. Null otherwise. */
+    member: GuildMember | null;
+    /** Raw member data when member exists (for premium_since, etc.). */
+    memberData: (APIGuildMember & {
+        user: {
+            id: string;
+        };
+    }) | null;
+}
+/**
+ * Manages users with fetch and profile helpers.
+ * Extends Collection so you can use .get(), .set(), .filter(), etc.
+ */
+declare class UsersManager extends Collection<string, User> {
+    private readonly client;
+    constructor(client: Client);
+    /**
+     * Fetch a user by ID from the API.
+     * Updates cache if user already exists.
+     * @param userId - Snowflake of the user
+     * @returns The user
+     * @throws FluxerError (or REST error) if user not found
+     * @example
+     * const user = await client.users.fetch(userId);
+     * console.log(user.username);
+     */
+    fetch(userId: string): Promise<User>;
+    /**
+     * Fetch a user with full profile and optional guild context.
+     * Returns user, global profile, server profile (when guildId), and member (when guildId).
+     * Ideal for userinfo commands.
+     * @param userId - Snowflake of the user
+     * @param options - Optional guildId for server profile and member data
+     * @returns User, raw data, profiles, and member (when in guild)
+     * @throws FluxerError (or REST error) if user not found
+     * @example
+     * const { user, globalProfile, serverProfile, member } = await client.users.fetchWithProfile(
+     *   userId,
+     *   { guildId: message.guildId ?? undefined },
+     * );
+     */
+    fetchWithProfile(userId: string, options?: {
+        guildId?: string | null;
+    }): Promise<FetchedUserWithProfile>;
+}
+
 /**
  * Callback parameter types for client events. Use with client.on(Events.X, handler).
  * @see Events
@@ -1197,7 +1324,7 @@ declare class Client extends EventEmitter {
     readonly rest: REST;
     readonly guilds: GuildManager;
     readonly channels: ChannelManager;
-    readonly users: Collection<string, User>;
+    readonly users: UsersManager;
     /** Typed event handlers. Use client.events.MessageReactionAdd((reaction, user, messageId, channelId, emoji, userId) => {...}) or client.on(Events.MessageReactionAdd, ...). */
     readonly events: ClientEventMethods;
     /** The authenticated bot user. Null until READY is received. */
@@ -1338,6 +1465,7 @@ declare const ErrorCodes: {
     readonly MessageNotFound: "MESSAGE_NOT_FOUND";
     readonly GuildNotFound: "GUILD_NOT_FOUND";
     readonly MemberNotFound: "MEMBER_NOT_FOUND";
+    readonly RoleNotFound: "ROLE_NOT_FOUND";
 };
 
 interface CdnUrlOptions {
@@ -1401,4 +1529,4 @@ declare function cdnMemberBannerURL(guildId: string, userId: string, bannerHash:
  */
 declare function cdnDefaultAvatarURL(discriminatorIndex?: number): string;
 
-export { Base, CategoryChannel, type CdnUrlOptions, Channel, ChannelManager, Client, type ClientEventMethods, type ClientEvents, ClientUser, type CollectedReaction, DMChannel, ErrorCodes, Events, FluxerError, type FluxerErrorOptions, Guild, GuildBan, GuildChannel, GuildEmoji, GuildMember, GuildSticker, Invite, LinkChannel, Message, MessageCollector, type MessageCollectorEndReason, type MessageCollectorOptions, type MessageEditOptions, MessageManager, MessageReaction, type MessageSendOptions, type PartialMessage, ReactionCollector, type ReactionCollectorEndReason, type ReactionCollectorOptions, Role, TextChannel, User, VoiceChannel, Webhook, type WebhookSendOptions, cdnAvatarURL, cdnBannerURL, cdnDefaultAvatarURL, cdnDisplayAvatarURL, cdnMemberAvatarURL, cdnMemberBannerURL };
+export { Base, CategoryChannel, type CdnUrlOptions, Channel, ChannelManager, Client, type ClientEventMethods, type ClientEvents, ClientUser, type CollectedReaction, DMChannel, ErrorCodes, Events, type FetchedUserWithProfile, FluxerError, type FluxerErrorOptions, Guild, GuildBan, GuildChannel, GuildEmoji, GuildMember, GuildMemberManager, GuildSticker, Invite, LinkChannel, Message, MessageCollector, type MessageCollectorEndReason, type MessageCollectorOptions, type MessageEditOptions, MessageManager, MessageReaction, type MessageSendOptions, type PartialMessage, ReactionCollector, type ReactionCollectorEndReason, type ReactionCollectorOptions, Role, TextChannel, User, UsersManager, VoiceChannel, Webhook, type WebhookSendOptions, cdnAvatarURL, cdnBannerURL, cdnDefaultAvatarURL, cdnDisplayAvatarURL, cdnMemberAvatarURL, cdnMemberBannerURL };