chapterjs 0.1.2 → 0.1.4

package/dist/structures/guild.d.ts

@@ -0,0 +1,348 @@
+import type { CacheStore } from '../cache/store.js';
+import { type ImageOptions } from '../discord/cdn.js';
+import { Permissions } from '../discord/permissions.js';
+import type { GetGuildAuditLogQuery, RawAuditLog, RawAuditLogEntry } from '../discord/types/audit-log.js';
+import type { RawAutoModerationRule } from '../discord/types/auto-moderation.js';
+import type { Locale, Snowflake } from '../discord/types/common.js';
+import type { RawGuildCreateExtra } from '../discord/types/gateway-events.js';
+import type { CreateGuildScheduledEventJSONParams, RawGuildScheduledEvent } from '../discord/types/guild-scheduled-event.js';
+import type { CreateGuildChannelJSONParams, CreateGuildRoleJSONParams, GuildFeature, ModifyGuildJSONParams, PremiumTier, RawGuild, VerificationLevel } from '../discord/types/guild.js';
+import type { RawSticker } from '../discord/types/sticker.js';
+import type { RawVoiceState } from '../discord/types/voice.js';
+import { type Camelize } from '../util/case.js';
+import { IdStructure } from './base.js';
+import type { GuildChannel, ThreadChannel, VoiceChannel } from './channel.js';
+import type { Context } from './context.js';
+import type { GuildEmoji } from './emoji.js';
+import type { Invite } from './invite.js';
+import { type BanOptions, type GuildMember } from './member.js';
+import type { Role } from './role.js';
+import type { User } from './user.js';
+import type { Webhook } from './webhook.js';
+import type { VoiceConnection } from '../voice/connection.js';
+/** What a server stores itself; its roles, emojis... live in its stores. */
+export type GuildData = Omit<RawGuild, 'roles' | 'emojis' | 'stickers'> & Partial<Pick<RawGuildCreateExtra, 'joined_at' | 'large' | 'member_count'>> & {
+    unavailable?: boolean;
+};
+/** What belongs to a server: forgotten with it. */
+export interface GuildStores {
+    roles: CacheStore<Snowflake, Role>;
+    members: CacheStore<Snowflake, GuildMember>;
+    channels: CacheStore<Snowflake, GuildChannel | ThreadChannel>;
+    emojis: CacheStore<Snowflake, GuildEmoji>;
+    /**
+     * Who is in a voice channel, by user id: what the voice events compare
+     * with. Only filled when Discord sends voice states, which is when a
+     * file listens to them.
+     */
+    voiceStates: CacheStore<Snowflake, VoiceEntry>;
+}
+/** What the voice state of one person holds, without its member. */
+export type VoiceStateData = Omit<RawVoiceState, 'member' | 'guild_id'>;
+/** Someone in a voice channel: their state, and the channel they are in. */
+export interface VoiceEntry {
+    state: VoiceStateData;
+    /** Kept with the state, so a channel deleted meanwhile is still known. */
+    channel: VoiceChannel;
+}
+/**
+ * Where someone is in voice, and how: muted, deafened, streaming...
+ * @see https://docs.discord.com/developers/resources/voice#voice-state-object
+ */
+export type VoiceState = Camelize<VoiceStateData>;
+/** Only the framework writes to the stores of a server. */
+export declare let storesOf: (guild: Guild) => GuildStores;
+/**
+ * What `edit()` takes on a server: only what is passed changes. Images are
+ * data URIs (`data:image/png;base64,...`).
+ * @see https://docs.discord.com/developers/resources/guild#modify-guild-json-params
+ */
+export type GuildEditOptions = Camelize<ModifyGuildJSONParams>;
+/**
+ * What `createChannel()` takes: a name, a type, and the settings of that
+ * kind of channel.
+ * @see https://docs.discord.com/developers/resources/guild#create-guild-channel-json-params
+ */
+export type ChannelCreateOptions = Camelize<CreateGuildChannelJSONParams>;
+/**
+ * What `createRole()` takes. Permissions are given by name, as a list of
+ * names or as a `Permissions` set.
+ * @see https://docs.discord.com/developers/resources/guild#create-guild-role-json-params
+ */
+export type RoleCreateOptions = Camelize<Omit<CreateGuildRoleJSONParams, 'permissions'>> & {
+    permissions?: Permissions | ConstructorParameters<typeof Permissions>[0];
+};
+/** A ban of a server. */
+export interface Ban {
+    /** Who is banned. */
+    user: User;
+    /** Why, when a reason was given. */
+    reason: string | null;
+}
+/**
+ * What moderators and bots did in a server: its entries, newest first, and
+ * what they refer to.
+ * @see https://docs.discord.com/developers/resources/audit-log#audit-log-object-audit-log-structure
+ */
+export type AuditLog = Camelize<RawAuditLog>;
+/**
+ * One thing a moderator or a bot did in a server: what, by whom, on what,
+ * and what changed.
+ * @see https://docs.discord.com/developers/resources/audit-log#audit-log-entry-object-audit-log-entry-structure
+ */
+export type AuditLogEntry = Camelize<RawAuditLogEntry>;
+/**
+ * An event scheduled in a server: when it happens, where, and how often.
+ * @see https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure
+ */
+export type ScheduledEvent = Camelize<RawGuildScheduledEvent>;
+/**
+ * A rule Discord applies by itself to the messages of a server: what
+ * triggers it, and what it does then.
+ * @see https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-rule-object-auto-moderation-rule-structure
+ */
+export type AutoModerationRule = Camelize<RawAutoModerationRule>;
+/**
+ * A sticker: one of a server, or a standard one from a pack.
+ * @see https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-structure
+ */
+export type Sticker = Camelize<RawSticker>;
+/**
+ * A server ("guild" is the name Discord gives servers in its API).
+ * @see https://docs.discord.com/developers/resources/guild#guild-object
+ */
+export declare class Guild extends IdStructure<GuildData> {
+    #private;
+    constructor(ctx: Context, data: GuildData);
+    /** The name of the server. */
+    get name(): string;
+    /** The description of the server, when it has one. */
+    get description(): string | null;
+    /** The id of the user who owns the server. */
+    get ownerId(): Snowflake;
+    /** `false` during an outage of Discord: the data may be out of date. */
+    get available(): boolean;
+    /**
+     * How many members the server has. Exact when the bot receives member
+     * events, approximate otherwise; `null` when Discord never said it.
+     */
+    get memberCount(): number | null;
+    /**
+     * What the server has enabled or unlocked (`COMMUNITY`, `VANITY_URL`...).
+     * @see https://docs.discord.com/developers/resources/guild#guild-object-guild-features
+     */
+    get features(): readonly GuildFeature[];
+    /** What Discord asks of new members before they can write. */
+    get verificationLevel(): VerificationLevel;
+    /** The boost level of the server. */
+    get premiumTier(): PremiumTier;
+    /** How many boosts the server has. */
+    get boostCount(): number;
+    /** The language of the server, used for what Discord sends to it. */
+    get preferredLocale(): Locale;
+    /** The code of the custom invite link of the server, when it has one. */
+    get vanityUrlCode(): string | null;
+    /** The id of the channel where Discord posts welcome messages. */
+    get systemChannelId(): Snowflake | null;
+    /** The id of the channel that shows the rules, in a community server. */
+    get rulesChannelId(): Snowflake | null;
+    /** The id of the voice channel inactive members are moved to. */
+    get afkChannelId(): Snowflake | null;
+    /** When the bot joined the server, when Discord said it. */
+    get joinedAt(): Date | null;
+    /** The roles of the server, @everyone included. */
+    get roles(): ReadonlyMap<Snowflake, Role>;
+    /**
+     * The members of the server the bot knows: the ones seen the most
+     * recently, not all of them.
+     */
+    get members(): ReadonlyMap<Snowflake, GuildMember>;
+    /** The channels and active threads of the server. */
+    get channels(): ReadonlyMap<Snowflake, GuildChannel | ThreadChannel>;
+    /** The custom emojis of the server. */
+    get emojis(): ReadonlyMap<Snowflake, GuildEmoji>;
+    /**
+     * The bot in voice in this server, to play or leave; `null` when it is
+     * in no voice channel here.
+     */
+    get voice(): VoiceConnection | null;
+    /** The @everyone role, which every member has. */
+    get everyoneRole(): Role;
+    /** The bot as a member of this server. */
+    get me(): GuildMember;
+    /** The URL of the icon of the server, when it has one. */
+    iconURL(options?: ImageOptions): string | null;
+    /** The URL of the banner of the server, when it has one. */
+    bannerURL(options?: ImageOptions): string | null;
+    /** The URL of the invite background of the server, when it has one. */
+    splashURL(options?: ImageOptions): string | null;
+    /**
+     * Asks Discord for the latest data of the server.
+     * @see https://docs.discord.com/developers/resources/guild#get-guild
+     */
+    fetch(): Promise<Guild>;
+    /**
+     * Changes the settings of the server.
+     * @see https://docs.discord.com/developers/resources/guild#modify-guild
+     */
+    edit(options: GuildEditOptions, reason?: string): Promise<Guild>;
+    /**
+     * Makes the bot leave the server.
+     * @see https://docs.discord.com/developers/resources/user#leave-guild
+     */
+    leave(): Promise<void>;
+    /**
+     * A member of the server: from what the bot remembers, or else from Discord.
+     * @see https://docs.discord.com/developers/resources/guild#get-guild-member
+     */
+    fetchMember(user: Snowflake | {
+        id: Snowflake;
+    }, { force }?: {
+        force?: boolean;
+    }): Promise<GuildMember>;
+    /**
+     * Members of the server, by pages of 1000 at most, ordered by id. Needs
+     * the Server Members intent to be enabled for the bot.
+     * @see https://docs.discord.com/developers/resources/guild#list-guild-members
+     */
+    fetchMembers(options?: {
+        limit?: number;
+        after?: Snowflake | {
+            id: Snowflake;
+        };
+    }): Promise<GuildMember[]>;
+    /**
+     * Members whose username or nickname starts with the given text.
+     * @see https://docs.discord.com/developers/resources/guild#search-guild-members
+     */
+    searchMembers(query: string, limit?: number): Promise<GuildMember[]>;
+    /** The member who owns the server. */
+    fetchOwner(): Promise<GuildMember>;
+    /**
+     * Removes a member from the server; they can come back with an invite.
+     * @see https://docs.discord.com/developers/resources/guild#remove-guild-member
+     */
+    kick(user: Snowflake | {
+        id: Snowflake;
+    }, reason?: string): Promise<void>;
+    /**
+     * Bans a user from the server, member or not.
+     * @see https://docs.discord.com/developers/resources/guild#create-guild-ban
+     */
+    ban(user: Snowflake | {
+        id: Snowflake;
+    }, options?: BanOptions): Promise<void>;
+    /**
+     * Bans up to 200 users at once.
+     * @returns the ids of the users that were banned, and of those that could not be
+     * @see https://docs.discord.com/developers/resources/guild#bulk-guild-ban
+     */
+    bulkBan(users: readonly (Snowflake | {
+        id: Snowflake;
+    })[], options?: BanOptions): Promise<{
+        bannedUsers: Snowflake[];
+        failedUsers: Snowflake[];
+    }>;
+    /**
+     * Lifts the ban of a user.
+     * @see https://docs.discord.com/developers/resources/guild#remove-guild-ban
+     */
+    unban(user: Snowflake | {
+        id: Snowflake;
+    }, reason?: string): Promise<void>;
+    /**
+     * The ban of a user; `null` when they are not banned.
+     * @see https://docs.discord.com/developers/resources/guild#get-guild-ban
+     */
+    fetchBan(user: Snowflake | {
+        id: Snowflake;
+    }): Promise<Ban | null>;
+    /**
+     * The bans of the server, by pages of 1000 at most.
+     * @see https://docs.discord.com/developers/resources/guild#get-guild-bans
+     */
+    fetchBans(options?: {
+        limit?: number;
+        before?: Snowflake;
+        after?: Snowflake;
+    }): Promise<Ban[]>;
+    /**
+     * Asks Discord for the roles of the server.
+     * @see https://docs.discord.com/developers/resources/guild#get-guild-roles
+     */
+    fetchRoles(): Promise<Role[]>;
+    /**
+     * Creates a role.
+     * @see https://docs.discord.com/developers/resources/guild#create-guild-role
+     */
+    createRole(options?: RoleCreateOptions, reason?: string): Promise<Role>;
+    /**
+     * The channels of the server (threads are not included).
+     * @see https://docs.discord.com/developers/resources/guild#get-guild-channels
+     */
+    fetchChannels(): Promise<GuildChannel[]>;
+    /**
+     * Creates a channel.
+     * @see https://docs.discord.com/developers/resources/guild#create-guild-channel
+     */
+    createChannel(options: ChannelCreateOptions, reason?: string): Promise<GuildChannel>;
+    /**
+     * The threads of the server that are not archived.
+     * @see https://docs.discord.com/developers/resources/guild#list-active-guild-threads
+     */
+    fetchActiveThreads(): Promise<ThreadChannel[]>;
+    /**
+     * Asks Discord for the custom emojis of the server.
+     * @see https://docs.discord.com/developers/resources/emoji#list-guild-emojis
+     */
+    fetchEmojis(): Promise<GuildEmoji[]>;
+    /**
+     * Adds a custom emoji to the server.
+     * @param options.image the image as a data URI (`data:image/png;base64,...`)
+     * @see https://docs.discord.com/developers/resources/emoji#create-guild-emoji
+     */
+    createEmoji(options: {
+        name: string;
+        image: string;
+        roles?: (Snowflake | {
+            id: Snowflake;
+        })[];
+    }, reason?: string): Promise<GuildEmoji>;
+    /**
+     * The invites of the server, with how many times each was used.
+     * @see https://docs.discord.com/developers/resources/guild#get-guild-invites
+     */
+    fetchInvites(): Promise<Invite[]>;
+    /**
+     * The webhooks of every channel of the server.
+     * @see https://docs.discord.com/developers/resources/webhook#get-guild-webhooks
+     */
+    fetchWebhooks(): Promise<Webhook[]>;
+    /**
+     * What moderators and bots did in the server.
+     * @see https://docs.discord.com/developers/resources/audit-log#get-guild-audit-log
+     */
+    fetchAuditLog(options?: Camelize<GetGuildAuditLogQuery>): Promise<AuditLog>;
+    /**
+     * The scheduled events of the server.
+     * @see https://docs.discord.com/developers/resources/guild-scheduled-event#list-scheduled-events-for-guild
+     */
+    fetchScheduledEvents(): Promise<ScheduledEvent[]>;
+    /**
+     * Schedules an event in the server.
+     * @see https://docs.discord.com/developers/resources/guild-scheduled-event#create-guild-scheduled-event
+     */
+    createScheduledEvent(options: Camelize<CreateGuildScheduledEventJSONParams>, reason?: string): Promise<ScheduledEvent>;
+    /**
+     * The auto moderation rules of the server.
+     * @see https://docs.discord.com/developers/resources/auto-moderation#list-auto-moderation-rules-for-guild
+     */
+    fetchAutoModerationRules(): Promise<AutoModerationRule[]>;
+    /**
+     * The custom stickers of the server.
+     * @see https://docs.discord.com/developers/resources/sticker#list-guild-stickers
+     */
+    fetchStickers(): Promise<Sticker[]>;
+    /** The name of the server. */
+    toString(): string;
+}