chapterjs 0.1.2 → 0.2.0

package/dist/discord/formatting.d.ts

@@ -0,0 +1,67 @@
+import type { Snowflake } from './types/common.js';
+/** `<@USER_ID>`: mentions a user. */
+export declare function userMention(userId: Snowflake): `<@${string}>`;
+/** `<#CHANNEL_ID>`: links a channel. */
+export declare function channelMention(channelId: Snowflake): `<#${string}>`;
+/** `<@&ROLE_ID>`: mentions a role. */
+export declare function roleMention(roleId: Snowflake): `<@&${string}>`;
+/**
+ * `</NAME:COMMAND_ID>`: a clickable slash command. The name includes the
+ * subcommand group and subcommand when there are some (`"foo group bar"`).
+ */
+export declare function commandMention(name: string, commandId: Snowflake): `</${string}:${string}>`;
+/** `<:NAME:ID>` or `<a:NAME:ID>`: a custom emoji. */
+export declare function emojiMention(name: string, emojiId: Snowflake, animated?: boolean): string;
+/**
+ * Timestamp Styles
+ * @see https://docs.discord.com/developers/reference#message-formatting-timestamp-styles
+ */
+export declare const TimestampStyle: {
+    /** 16:20 */
+    readonly ShortTime: 't';
+    /** 16:20:30 */
+    readonly MediumTime: 'T';
+    /** 20/04/2021 */
+    readonly ShortDate: 'd';
+    /** April 20, 2021 */
+    readonly LongDate: 'D';
+    /** April 20, 2021 at 16:20 (default) */
+    readonly LongDateShortTime: 'f';
+    /** Tuesday, April 20, 2021 at 16:20 */
+    readonly FullDateShortTime: 'F';
+    /** 20/04/2021, 16:20 */
+    readonly ShortDateShortTime: 's';
+    /** 20/04/2021, 16:20:30 */
+    readonly ShortDateMediumTime: 'S';
+    /** 4 years ago */
+    readonly Relative: 'R';
+};
+export type TimestampStyle = (typeof TimestampStyle)[keyof typeof TimestampStyle];
+/**
+ * `<t:TIMESTAMP>` or `<t:TIMESTAMP:STYLE>`: a date shown to each reader in
+ * their own timezone and language. Timestamps are expressed in seconds.
+ */
+export declare function timestamp(date: Date | number, style?: TimestampStyle): string;
+/**
+ * Guild Navigation Types: links to a tab of the current server.
+ * @see https://docs.discord.com/developers/reference#message-formatting-guild-navigation-types
+ */
+export declare const GuildNavigation: {
+    /** Channel & Roles tab with Onboarding prompts */
+    readonly Customize: '<id:customize>';
+    /** Browse Channels tab */
+    readonly Browse: '<id:browse>';
+    /** Server Guide tab */
+    readonly Guide: '<id:guide>';
+    /** Linked Roles tab */
+    readonly LinkedRoles: '<id:linked-roles>';
+};
+/**
+ * The emoji of a reaction as REST paths expect it: the emoji itself for a
+ * standard one, `name:id` for a custom one.
+ * @see https://docs.discord.com/developers/resources/message#create-reaction
+ */
+export declare function reactionEmoji(emoji: {
+    id?: Snowflake | null;
+    name?: string | null;
+}): string;

package/dist/discord/formatting.js

@@ -0,0 +1,87 @@
+// The text formats Discord turns into mentions, emojis and dates.
+// https://docs.discord.com/developers/reference#message-formatting
+/** `<@USER_ID>`: mentions a user. */
+export function userMention(userId) {
+    return `<@${userId}>`;
+}
+/** `<#CHANNEL_ID>`: links a channel. */
+export function channelMention(channelId) {
+    return `<#${channelId}>`;
+}
+/** `<@&ROLE_ID>`: mentions a role. */
+export function roleMention(roleId) {
+    return `<@&${roleId}>`;
+}
+/**
+ * `</NAME:COMMAND_ID>`: a clickable slash command. The name includes the
+ * subcommand group and subcommand when there are some (`"foo group bar"`).
+ */
+export function commandMention(name, commandId) {
+    return `</${name}:${commandId}>`;
+}
+/** `<:NAME:ID>` or `<a:NAME:ID>`: a custom emoji. */
+export function emojiMention(name, emojiId, animated = false) {
+    return `<${animated ? 'a' : ''}:${name}:${emojiId}>`;
+}
+/**
+ * Timestamp Styles
+ * @see https://docs.discord.com/developers/reference#message-formatting-timestamp-styles
+ */
+export const TimestampStyle = {
+    /** 16:20 */
+    ShortTime: 't',
+    /** 16:20:30 */
+    MediumTime: 'T',
+    /** 20/04/2021 */
+    ShortDate: 'd',
+    /** April 20, 2021 */
+    LongDate: 'D',
+    /** April 20, 2021 at 16:20 (default) */
+    LongDateShortTime: 'f',
+    /** Tuesday, April 20, 2021 at 16:20 */
+    FullDateShortTime: 'F',
+    /** 20/04/2021, 16:20 */
+    ShortDateShortTime: 's',
+    /** 20/04/2021, 16:20:30 */
+    ShortDateMediumTime: 'S',
+    /** 4 years ago */
+    Relative: 'R',
+};
+/**
+ * `<t:TIMESTAMP>` or `<t:TIMESTAMP:STYLE>`: a date shown to each reader in
+ * their own timezone and language. Timestamps are expressed in seconds.
+ */
+export function timestamp(date, style) {
+    const ms = Number(date);
+    if (!Number.isFinite(ms)) {
+        throw new TypeError('timestamp() needs a valid date.');
+    }
+    const seconds = Math.floor(ms / 1000);
+    return style ? `<t:${seconds}:${style}>` : `<t:${seconds}>`;
+}
+/**
+ * Guild Navigation Types: links to a tab of the current server.
+ * @see https://docs.discord.com/developers/reference#message-formatting-guild-navigation-types
+ */
+export const GuildNavigation = {
+    /** Channel & Roles tab with Onboarding prompts */
+    Customize: '<id:customize>',
+    /** Browse Channels tab */
+    Browse: '<id:browse>',
+    /** Server Guide tab */
+    Guide: '<id:guide>',
+    /** Linked Roles tab */
+    LinkedRoles: '<id:linked-roles>',
+};
+/**
+ * The emoji of a reaction as REST paths expect it: the emoji itself for a
+ * standard one, `name:id` for a custom one.
+ * @see https://docs.discord.com/developers/resources/message#create-reaction
+ */
+export function reactionEmoji(emoji) {
+    if (emoji.id)
+        return `${emoji.name ?? '_'}:${emoji.id}`;
+    if (!emoji.name)
+        throw new TypeError('An emoji needs a name or an id.');
+    return emoji.name;
+}

package/dist/discord/index.d.ts

@@ -0,0 +1,10 @@
+export * from './api.js';
+export * from './cdn.js';
+export * from './codes.js';
+export * from './endpoint.js';
+export * as Endpoints from './endpoints.js';
+export * from './formatting.js';
+export * from './intents.js';
+export * from './permissions.js';
+export * from './snowflake.js';
+export * from './types/index.js';

package/dist/discord/index.js

@@ -0,0 +1,13 @@
+// Everything the framework knows about Discord that never changes at
+// runtime: constants, payload types and pure helpers, each linked to the
+// page of the official documentation it comes from.
+export * from './api.js';
+export * from './cdn.js';
+export * from './codes.js';
+export * from './endpoint.js';
+export * as Endpoints from './endpoints.js';
+export * from './formatting.js';
+export * from './intents.js';
+export * from './permissions.js';
+export * from './snowflake.js';
+export * from './types/index.js';

package/dist/discord/intents.d.ts

@@ -0,0 +1,48 @@
+import type { GatewayDispatchEventName } from './types/gateway-events.js';
+/**
+ * Gateway Intents: which groups of events Discord sends to the bot.
+ * @see https://docs.discord.com/developers/events/gateway#list-of-intents
+ */
+export declare const GatewayIntent: {
+    readonly Guilds: number;
+    readonly GuildMembers: number;
+    readonly GuildModeration: number;
+    readonly GuildExpressions: number;
+    readonly GuildIntegrations: number;
+    readonly GuildWebhooks: number;
+    readonly GuildInvites: number;
+    readonly GuildVoiceStates: number;
+    readonly GuildPresences: number;
+    readonly GuildMessages: number;
+    readonly GuildMessageReactions: number;
+    readonly GuildMessageTyping: number;
+    readonly DirectMessages: number;
+    readonly DirectMessageReactions: number;
+    readonly DirectMessageTyping: number;
+    readonly MessageContent: number;
+    readonly GuildScheduledEvents: number;
+    readonly AutoModerationConfiguration: number;
+    readonly AutoModerationExecution: number;
+    readonly GuildMessagePolls: number;
+    readonly DirectMessagePolls: number;
+};
+export type GatewayIntent = (typeof GatewayIntent)[keyof typeof GatewayIntent];
+export type GatewayIntentName = keyof typeof GatewayIntent;
+/**
+ * Intents that must be enabled by hand in the Developer Portal.
+ * @see https://docs.discord.com/developers/events/gateway#privileged-intents
+ */
+export declare const PRIVILEGED_INTENTS: readonly GatewayIntentName[];
+/**
+ * The intents that make Discord send each event, exactly as the list of
+ * intents of the documentation groups them. An event listed under several
+ * intents is sent when any of them is set (the guild one for what happens in
+ * a server, the direct message one for DMs). An event that is not here needs
+ * no intent.
+ * @see https://docs.discord.com/developers/events/gateway#list-of-intents
+ */
+export declare const EVENT_INTENTS: Readonly<Partial<Record<GatewayDispatchEventName, readonly GatewayIntent[]>>>;
+/** Combines intents into the number sent when identifying. */
+export declare function combineIntents(intents: Iterable<GatewayIntent | GatewayIntentName>): number;
+/** The names of the intents set in a number, in the order of the docs. */
+export declare function intentNames(bits: number): GatewayIntentName[];

package/dist/discord/intents.js

@@ -0,0 +1,128 @@
+/**
+ * Gateway Intents: which groups of events Discord sends to the bot.
+ * @see https://docs.discord.com/developers/events/gateway#list-of-intents
+ */
+export const GatewayIntent = {
+    Guilds: 1 << 0,
+    GuildMembers: 1 << 1,
+    GuildModeration: 1 << 2,
+    GuildExpressions: 1 << 3,
+    GuildIntegrations: 1 << 4,
+    GuildWebhooks: 1 << 5,
+    GuildInvites: 1 << 6,
+    GuildVoiceStates: 1 << 7,
+    GuildPresences: 1 << 8,
+    GuildMessages: 1 << 9,
+    GuildMessageReactions: 1 << 10,
+    GuildMessageTyping: 1 << 11,
+    DirectMessages: 1 << 12,
+    DirectMessageReactions: 1 << 13,
+    DirectMessageTyping: 1 << 14,
+    MessageContent: 1 << 15,
+    GuildScheduledEvents: 1 << 16,
+    AutoModerationConfiguration: 1 << 20,
+    AutoModerationExecution: 1 << 21,
+    GuildMessagePolls: 1 << 24,
+    DirectMessagePolls: 1 << 25,
+};
+/**
+ * Intents that must be enabled by hand in the Developer Portal.
+ * @see https://docs.discord.com/developers/events/gateway#privileged-intents
+ */
+export const PRIVILEGED_INTENTS = [
+    'GuildPresences',
+    'GuildMembers',
+    'MessageContent',
+];
+const I = GatewayIntent;
+/**
+ * The intents that make Discord send each event, exactly as the list of
+ * intents of the documentation groups them. An event listed under several
+ * intents is sent when any of them is set (the guild one for what happens in
+ * a server, the direct message one for DMs). An event that is not here needs
+ * no intent.
+ * @see https://docs.discord.com/developers/events/gateway#list-of-intents
+ */
+export const EVENT_INTENTS = {
+    GUILD_CREATE: [I.Guilds],
+    GUILD_UPDATE: [I.Guilds],
+    GUILD_DELETE: [I.Guilds],
+    GUILD_ROLE_CREATE: [I.Guilds],
+    GUILD_ROLE_UPDATE: [I.Guilds],
+    GUILD_ROLE_DELETE: [I.Guilds],
+    CHANNEL_CREATE: [I.Guilds],
+    CHANNEL_UPDATE: [I.Guilds],
+    CHANNEL_DELETE: [I.Guilds],
+    CHANNEL_PINS_UPDATE: [I.Guilds, I.DirectMessages],
+    THREAD_CREATE: [I.Guilds],
+    THREAD_UPDATE: [I.Guilds],
+    THREAD_DELETE: [I.Guilds],
+    THREAD_LIST_SYNC: [I.Guilds],
+    THREAD_MEMBER_UPDATE: [I.Guilds],
+    THREAD_MEMBERS_UPDATE: [I.Guilds, I.GuildMembers],
+    STAGE_INSTANCE_CREATE: [I.Guilds],
+    STAGE_INSTANCE_UPDATE: [I.Guilds],
+    STAGE_INSTANCE_DELETE: [I.Guilds],
+    VOICE_CHANNEL_STATUS_UPDATE: [I.Guilds],
+    VOICE_CHANNEL_START_TIME_UPDATE: [I.Guilds],
+    GUILD_MEMBER_ADD: [I.GuildMembers],
+    GUILD_MEMBER_UPDATE: [I.GuildMembers],
+    GUILD_MEMBER_REMOVE: [I.GuildMembers],
+    GUILD_AUDIT_LOG_ENTRY_CREATE: [I.GuildModeration],
+    GUILD_BAN_ADD: [I.GuildModeration],
+    GUILD_BAN_REMOVE: [I.GuildModeration],
+    GUILD_EMOJIS_UPDATE: [I.GuildExpressions],
+    GUILD_STICKERS_UPDATE: [I.GuildExpressions],
+    GUILD_SOUNDBOARD_SOUND_CREATE: [I.GuildExpressions],
+    GUILD_SOUNDBOARD_SOUND_UPDATE: [I.GuildExpressions],
+    GUILD_SOUNDBOARD_SOUND_DELETE: [I.GuildExpressions],
+    GUILD_SOUNDBOARD_SOUNDS_UPDATE: [I.GuildExpressions],
+    GUILD_INTEGRATIONS_UPDATE: [I.GuildIntegrations],
+    INTEGRATION_CREATE: [I.GuildIntegrations],
+    INTEGRATION_UPDATE: [I.GuildIntegrations],
+    INTEGRATION_DELETE: [I.GuildIntegrations],
+    WEBHOOKS_UPDATE: [I.GuildWebhooks],
+    INVITE_CREATE: [I.GuildInvites],
+    INVITE_DELETE: [I.GuildInvites],
+    VOICE_CHANNEL_EFFECT_SEND: [I.GuildVoiceStates],
+    VOICE_STATE_UPDATE: [I.GuildVoiceStates],
+    PRESENCE_UPDATE: [I.GuildPresences],
+    MESSAGE_CREATE: [I.GuildMessages, I.DirectMessages],
+    MESSAGE_UPDATE: [I.GuildMessages, I.DirectMessages],
+    MESSAGE_DELETE: [I.GuildMessages, I.DirectMessages],
+    MESSAGE_DELETE_BULK: [I.GuildMessages],
+    MESSAGE_REACTION_ADD: [I.GuildMessageReactions, I.DirectMessageReactions],
+    MESSAGE_REACTION_REMOVE: [I.GuildMessageReactions, I.DirectMessageReactions],
+    MESSAGE_REACTION_REMOVE_ALL: [
+        I.GuildMessageReactions,
+        I.DirectMessageReactions,
+    ],
+    MESSAGE_REACTION_REMOVE_EMOJI: [
+        I.GuildMessageReactions,
+        I.DirectMessageReactions,
+    ],
+    TYPING_START: [I.GuildMessageTyping, I.DirectMessageTyping],
+    GUILD_SCHEDULED_EVENT_CREATE: [I.GuildScheduledEvents],
+    GUILD_SCHEDULED_EVENT_UPDATE: [I.GuildScheduledEvents],
+    GUILD_SCHEDULED_EVENT_DELETE: [I.GuildScheduledEvents],
+    GUILD_SCHEDULED_EVENT_USER_ADD: [I.GuildScheduledEvents],
+    GUILD_SCHEDULED_EVENT_USER_REMOVE: [I.GuildScheduledEvents],
+    AUTO_MODERATION_RULE_CREATE: [I.AutoModerationConfiguration],
+    AUTO_MODERATION_RULE_UPDATE: [I.AutoModerationConfiguration],
+    AUTO_MODERATION_RULE_DELETE: [I.AutoModerationConfiguration],
+    AUTO_MODERATION_ACTION_EXECUTION: [I.AutoModerationExecution],
+    MESSAGE_POLL_VOTE_ADD: [I.GuildMessagePolls, I.DirectMessagePolls],
+    MESSAGE_POLL_VOTE_REMOVE: [I.GuildMessagePolls, I.DirectMessagePolls],
+};
+/** Combines intents into the number sent when identifying. */
+export function combineIntents(intents) {
+    let bits = 0;
+    for (const intent of intents) {
+        bits |= typeof intent === 'number' ? intent : GatewayIntent[intent];
+    }
+    return bits;
+}
+/** The names of the intents set in a number, in the order of the docs. */
+export function intentNames(bits) {
+    return Object.keys(GatewayIntent).filter(name => (bits & GatewayIntent[name]) !== 0);
+}

package/dist/discord/permissions.d.ts

@@ -0,0 +1,94 @@
+import type { Snowflake } from './types/common.js';
+import { PermissionFlags } from './types/permissions.js';
+export type PermissionName = keyof typeof PermissionFlags;
+/** A permission, or several: by name, as bits, or as a set. */
+export type PermissionResolvable = PermissionName | bigint | Permissions | readonly (PermissionName | bigint)[];
+/** Every permission that exists, combined. */
+export declare const ALL_PERMISSIONS: bigint;
+/**
+ * Permissions that only make sense on a moderator: Discord asks for
+ * two-factor authentication to use them on servers that require it.
+ * @see https://docs.discord.com/developers/topics/permissions#permissions-bitwise-permission-flags
+ */
+export declare const ELEVATED_PERMISSIONS: readonly PermissionName[];
+/**
+ * A set of permissions that never changes: every operation returns a new
+ * set. Discord serializes permissions as text because they don't fit in a
+ * regular number.
+ * @see https://docs.discord.com/developers/topics/permissions
+ */
+export declare class Permissions {
+    /** The permissions as one number, each bit being a permission. */
+    readonly bits: bigint;
+    constructor(bits?: PermissionResolvable | string);
+    /**
+     * Whether every given permission is in the set. An administrator has
+     * every permission, unless `{ checkAdmin: false }` is passed.
+     */
+    has(permission: PermissionResolvable, { checkAdmin }?: {
+        checkAdmin?: boolean;
+    }): boolean;
+    /** Whether at least one of the given permissions is in the set. */
+    any(permission: PermissionResolvable, { checkAdmin }?: {
+        checkAdmin?: boolean;
+    }): boolean;
+    /** The given permissions that are not in the set, by name. */
+    missing(permission: PermissionResolvable): PermissionName[];
+    /** A new set with the given permissions added. */
+    add(permission: PermissionResolvable): Permissions;
+    /** A new set without the given permissions. */
+    remove(permission: PermissionResolvable): Permissions;
+    /** The names of the permissions in the set, in the order of the docs. */
+    toArray(): PermissionName[];
+    /** The text Discord expects in a request. */
+    toString(): string;
+    /** The text Discord expects in a request. */
+    toJSON(): string;
+}
+/** What the permission computation needs to know about a role. */
+export interface PermissionRole {
+    id: Snowflake;
+    permissions: bigint;
+}
+/** What the permission computation needs to know about an overwrite. */
+export interface PermissionOverwrite {
+    id: Snowflake;
+    allow: bigint;
+    deny: bigint;
+}
+/**
+ * The permissions of a member in a server, before channel overwrites:
+ * `compute_base_permissions` of the documentation.
+ * @see https://docs.discord.com/developers/topics/permissions#permission-overwrites
+ */
+export declare function computeBasePermissions(input: {
+    guildId: Snowflake;
+    ownerId: Snowflake;
+    userId: Snowflake;
+    /** The ids of the roles of the member (@everyone is implied). */
+    memberRoleIds: readonly Snowflake[];
+    /** Every role of the server, @everyone included. */
+    roles: Iterable<PermissionRole>;
+}): bigint;
+/**
+ * The permissions of a member in a channel, from their server permissions:
+ * `compute_overwrites` of the documentation.
+ * @see https://docs.discord.com/developers/topics/permissions#permission-overwrites
+ */
+export declare function computeOverwrites(basePermissions: bigint, input: {
+    guildId: Snowflake;
+    userId: Snowflake;
+    memberRoleIds: readonly Snowflake[];
+    overwrites: Iterable<PermissionOverwrite>;
+}): bigint;
+/**
+ * Removes what a member can't do in practice in a channel they can't see
+ * or can't write in.
+ * @see https://docs.discord.com/developers/topics/permissions#implicit-permissions
+ */
+export declare function applyImplicitPermissions(permissions: bigint): bigint;
+/**
+ * What is left of the permissions of a timed out member.
+ * @see https://docs.discord.com/developers/topics/permissions#permissions-for-timed-out-members
+ */
+export declare function applyTimeout(permissions: bigint): bigint;

package/dist/discord/permissions.js

@@ -0,0 +1,185 @@
+import { PermissionFlags } from './types/permissions.js';
+/** Every permission that exists, combined. */
+export const ALL_PERMISSIONS = Object.values(PermissionFlags).reduce((all, flag) => all | flag, 0n);
+/**
+ * Permissions that only make sense on a moderator: Discord asks for
+ * two-factor authentication to use them on servers that require it.
+ * @see https://docs.discord.com/developers/topics/permissions#permissions-bitwise-permission-flags
+ */
+export const ELEVATED_PERMISSIONS = [
+    'KickMembers',
+    'BanMembers',
+    'Administrator',
+    'ManageChannels',
+    'ManageGuild',
+    'ManageMessages',
+    'ManageRoles',
+    'ManageWebhooks',
+    'ManageGuildExpressions',
+    'ManageThreads',
+    'ViewCreatorMonetizationAnalytics',
+];
+function resolve(permission) {
+    if (typeof permission === 'bigint')
+        return permission;
+    if (permission instanceof Permissions)
+        return permission.bits;
+    if (typeof permission === 'string') {
+        const flag = PermissionFlags[permission];
+        if (flag === undefined) {
+            throw new TypeError(`"${permission}" is not a permission. Permissions are: ${Object.keys(PermissionFlags).join(', ')}.`);
+        }
+        return flag;
+    }
+    if (Array.isArray(permission)) {
+        return permission.reduce((bits, one) => bits | resolve(one), 0n);
+    }
+    throw new TypeError(`A permission is a name like "BanMembers", got ${typeof permission}.`);
+}
+/**
+ * A set of permissions that never changes: every operation returns a new
+ * set. Discord serializes permissions as text because they don't fit in a
+ * regular number.
+ * @see https://docs.discord.com/developers/topics/permissions
+ */
+export class Permissions {
+    /** The permissions as one number, each bit being a permission. */
+    bits;
+    constructor(bits = 0n) {
+        this.bits =
+            typeof bits === 'string' && /^\d+$/.test(bits)
+                ? BigInt(bits)
+                : resolve(bits);
+        Object.freeze(this);
+    }
+    /**
+     * Whether every given permission is in the set. An administrator has
+     * every permission, unless `{ checkAdmin: false }` is passed.
+     */
+    has(permission, { checkAdmin = true } = {}) {
+        if (checkAdmin && (this.bits & PermissionFlags.Administrator) !== 0n) {
+            return true;
+        }
+        const wanted = resolve(permission);
+        return (this.bits & wanted) === wanted;
+    }
+    /** Whether at least one of the given permissions is in the set. */
+    any(permission, { checkAdmin = true } = {}) {
+        if (checkAdmin && (this.bits & PermissionFlags.Administrator) !== 0n) {
+            return true;
+        }
+        return (this.bits & resolve(permission)) !== 0n;
+    }
+    /** The given permissions that are not in the set, by name. */
+    missing(permission) {
+        if ((this.bits & PermissionFlags.Administrator) !== 0n)
+            return [];
+        return new Permissions(resolve(permission) & ~this.bits).toArray();
+    }
+    /** A new set with the given permissions added. */
+    add(permission) {
+        return new Permissions(this.bits | resolve(permission));
+    }
+    /** A new set without the given permissions. */
+    remove(permission) {
+        return new Permissions(this.bits & ~resolve(permission));
+    }
+    /** The names of the permissions in the set, in the order of the docs. */
+    toArray() {
+        return Object.keys(PermissionFlags).filter(name => (this.bits & PermissionFlags[name]) !== 0n);
+    }
+    /** The text Discord expects in a request. */
+    toString() {
+        return this.bits.toString();
+    }
+    /** The text Discord expects in a request. */
+    toJSON() {
+        return this.toString();
+    }
+}
+/**
+ * The permissions of a member in a server, before channel overwrites:
+ * `compute_base_permissions` of the documentation.
+ * @see https://docs.discord.com/developers/topics/permissions#permission-overwrites
+ */
+export function computeBasePermissions(input) {
+    if (input.ownerId === input.userId)
+        return ALL_PERMISSIONS;
+    const owned = new Set(input.memberRoleIds);
+    let permissions = 0n;
+    for (const role of input.roles) {
+        // The @everyone role has the id of the server.
+        if (role.id === input.guildId || owned.has(role.id)) {
+            permissions |= role.permissions;
+        }
+    }
+    if ((permissions & PermissionFlags.Administrator) !== 0n) {
+        return ALL_PERMISSIONS;
+    }
+    return permissions;
+}
+/**
+ * The permissions of a member in a channel, from their server permissions:
+ * `compute_overwrites` of the documentation.
+ * @see https://docs.discord.com/developers/topics/permissions#permission-overwrites
+ */
+export function computeOverwrites(basePermissions, input) {
+    if ((basePermissions & PermissionFlags.Administrator) !== 0n) {
+        return ALL_PERMISSIONS;
+    }
+    const owned = new Set(input.memberRoleIds);
+    let everyone;
+    let member;
+    let allow = 0n;
+    let deny = 0n;
+    for (const overwrite of input.overwrites) {
+        if (overwrite.id === input.guildId)
+            everyone = overwrite;
+        else if (overwrite.id === input.userId)
+            member = overwrite;
+        else if (owned.has(overwrite.id)) {
+            allow |= overwrite.allow;
+            deny |= overwrite.deny;
+        }
+    }
+    let permissions = basePermissions;
+    if (everyone) {
+        permissions &= ~everyone.deny;
+        permissions |= everyone.allow;
+    }
+    permissions &= ~deny;
+    permissions |= allow;
+    if (member) {
+        permissions &= ~member.deny;
+        permissions |= member.allow;
+    }
+    return permissions;
+}
+/**
+ * Removes what a member can't do in practice in a channel they can't see
+ * or can't write in.
+ * @see https://docs.discord.com/developers/topics/permissions#implicit-permissions
+ */
+export function applyImplicitPermissions(permissions) {
+    if ((permissions & PermissionFlags.Administrator) !== 0n)
+        return permissions;
+    if ((permissions & PermissionFlags.ViewChannel) === 0n)
+        return 0n;
+    if ((permissions & PermissionFlags.SendMessages) === 0n) {
+        permissions &= ~(PermissionFlags.MentionEveryone |
+            PermissionFlags.SendTtsMessages |
+            PermissionFlags.AttachFiles |
+            PermissionFlags.EmbedLinks);
+    }
+    return permissions;
+}
+/**
+ * What is left of the permissions of a timed out member.
+ * @see https://docs.discord.com/developers/topics/permissions#permissions-for-timed-out-members
+ */
+export function applyTimeout(permissions) {
+    if ((permissions & PermissionFlags.Administrator) !== 0n)
+        return permissions;
+    return (permissions &
+        (PermissionFlags.ViewChannel | PermissionFlags.ReadMessageHistory));
+}

package/dist/discord/snowflake.d.ts

@@ -0,0 +1,21 @@
+import type { Snowflake } from './types/common.js';
+/**
+ * Whether a value looks like a Discord id: used to reject a wrong value
+ * (a name, a mention, a number) before it is sent to Discord.
+ * @see https://docs.discord.com/developers/reference#snowflakes
+ */
+export declare function isSnowflake(value: unknown): value is Snowflake;
+/**
+ * When the thing a snowflake identifies was created, in milliseconds since
+ * the Unix epoch: `(snowflake >> 22) + 1420070400000`.
+ * @see https://docs.discord.com/developers/reference#snowflake-id-format-structure-left-to-right
+ */
+export declare function snowflakeTimestamp(id: Snowflake): number;
+/**
+ * The smallest snowflake created at a given time: lets `before` / `after`
+ * pagination start from a date.
+ * @see https://docs.discord.com/developers/reference#snowflake-ids-in-pagination
+ */
+export declare function snowflakeFromTimestamp(timestamp: number | Date): Snowflake;
+/** Sorts ids from the oldest to the newest; as text they would sort wrong. */
+export declare function compareSnowflakes(a: Snowflake, b: Snowflake): number;