chapterjs 0.1.2 → 0.2.0

package/dist/discord/cdn.js

@@ -0,0 +1,100 @@
+// Image URLs, built from the ids and hashes Discord sends.
+// https://docs.discord.com/developers/reference#image-formatting
+import { CDN_BASE_URL, MEDIA_BASE_URL } from './api.js';
+import { StickerFormatType } from './types/sticker.js';
+const FORMATS = new Set([
+    'png',
+    'jpg',
+    'jpeg',
+    'webp',
+    'gif',
+]);
+function isSize(size) {
+    return (typeof size === 'number' &&
+        Number.isInteger(size) &&
+        size >= 16 &&
+        size <= 4096 &&
+        (size & (size - 1)) === 0);
+}
+/**
+ * Builds the URL of an image. In the case of endpoints that support GIFs,
+ * the hash begins with `a_` when the image is animated: those are requested
+ * as animated WebP with `?animated=true`.
+ */
+function image(path, hash, { format = 'webp', size, animated = true } = {}, supportsGif = true) {
+    if (!FORMATS.has(format)) {
+        throw new RangeError(`"${format}" is not an image format. Use png, jpg, webp or gif.`);
+    }
+    if (size !== undefined && !isSize(size)) {
+        throw new RangeError(`${size} is not an image size. Use a power of two between 16 and 4096 (64, 128, 256...).`);
+    }
+    const isAnimated = supportsGif && hash !== null && hash.startsWith('a_');
+    if (format === 'gif' && !isAnimated)
+        format = 'png';
+    const query = new URLSearchParams();
+    if (size !== undefined)
+        query.set('size', String(size));
+    if (isAnimated && animated && format === 'webp')
+        query.set('animated', 'true');
+    const search = query.size > 0 ? `?${query}` : '';
+    return `${CDN_BASE_URL}/${path}.${format}${search}`;
+}
+/** @see https://docs.discord.com/developers/reference#image-formatting-cdn-endpoints */
+export const cdn = {
+    /** Custom Emoji */
+    emoji: (emojiId, animated, options) => image(`emojis/${emojiId}`, animated ? 'a_' : '', options),
+    /** Guild Icon */
+    guildIcon: (guildId, hash, options) => image(`icons/${guildId}/${hash}`, hash, options),
+    /** Guild Splash */
+    guildSplash: (guildId, hash, options) => image(`splashes/${guildId}/${hash}`, hash, options, false),
+    /** Guild Discovery Splash */
+    guildDiscoverySplash: (guildId, hash, options) => image(`discovery-splashes/${guildId}/${hash}`, hash, options, false),
+    /** Guild Banner */
+    guildBanner: (guildId, hash, options) => image(`banners/${guildId}/${hash}`, hash, options),
+    /** User Banner */
+    userBanner: (userId, hash, options) => image(`banners/${userId}/${hash}`, hash, options),
+    /**
+     * Default User Avatar: always a PNG of a fixed size. The index is
+     * `(user_id >> 22) % 6` for users on the new username system and
+     * `discriminator % 5` for the others.
+     */
+    defaultUserAvatar: (userId, discriminator) => {
+        const legacy = discriminator !== '0' && discriminator !== '';
+        const index = legacy
+            ? Number(discriminator) % 5
+            : Number((BigInt(userId) >> 22n) % 6n);
+        return `${CDN_BASE_URL}/embed/avatars/${index}.png`;
+    },
+    /** User Avatar */
+    userAvatar: (userId, hash, options) => image(`avatars/${userId}/${hash}`, hash, options),
+    /** Guild Member Avatar */
+    memberAvatar: (guildId, userId, hash, options) => image(`guilds/${guildId}/users/${userId}/avatars/${hash}`, hash, options),
+    /** Guild Member Banner */
+    memberBanner: (guildId, userId, hash, options) => image(`guilds/${guildId}/users/${userId}/banners/${hash}`, hash, options),
+    /** Avatar Decoration: always a PNG. */
+    avatarDecoration: (asset) => `${CDN_BASE_URL}/avatar-decoration-presets/${asset}.png`,
+    /** Application Icon */
+    applicationIcon: (applicationId, hash, options) => image(`app-icons/${applicationId}/${hash}`, hash, options, false),
+    /** Application Cover */
+    applicationCover: (applicationId, hash, options) => image(`app-icons/${applicationId}/${hash}`, hash, options, false),
+    /** Team Icon */
+    teamIcon: (teamId, hash, options) => image(`team-icons/${teamId}/${hash}`, hash, options, false),
+    /**
+     * Sticker: a PNG if its format is PNG or APNG, a Lottie file (`.json`) if
+     * it is LOTTIE, and a GIF served by another host if it is GIF. The size
+     * is fixed.
+     */
+    sticker: (stickerId, format) => {
+        if (format === StickerFormatType.Gif) {
+            return `${MEDIA_BASE_URL}/stickers/${stickerId}.gif`;
+        }
+        const extension = format === StickerFormatType.Lottie ? 'json' : 'png';
+        return `${CDN_BASE_URL}/stickers/${stickerId}.${extension}`;
+    },
+    /** Role Icon */
+    roleIcon: (roleId, hash, options) => image(`role-icons/${roleId}/${hash}`, hash, options, false),
+    /** Guild Scheduled Event Cover */
+    scheduledEventCover: (eventId, hash, options) => image(`guild-events/${eventId}/${hash}`, hash, options, false),
+    /** Guild Tag Badge */
+    guildTagBadge: (guildId, hash, options) => image(`guild-tag-badges/${guildId}/${hash}`, hash, options, false),
+};

package/dist/discord/codes.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Gateway Opcodes
+ * @see https://docs.discord.com/developers/topics/opcodes-and-status-codes#gateway-gateway-opcodes
+ */
+export declare const GatewayOpcode: {
+    /** An event was dispatched. */
+    readonly Dispatch: 0;
+    /** Fired periodically by the client to keep the connection alive. */
+    readonly Heartbeat: 1;
+    /** Starts a new session during the initial handshake. */
+    readonly Identify: 2;
+    /** Update the client's presence. */
+    readonly PresenceUpdate: 3;
+    /** Used to join/leave or move between voice channels. */
+    readonly VoiceStateUpdate: 4;
+    /** Resume a previous session that was disconnected. */
+    readonly Resume: 6;
+    /** You should attempt to reconnect and resume immediately. */
+    readonly Reconnect: 7;
+    /** Request information about offline guild members in a large guild. */
+    readonly RequestGuildMembers: 8;
+    /** The session has been invalidated. You should reconnect and identify/resume accordingly. */
+    readonly InvalidSession: 9;
+    /** Sent immediately after connecting, contains the `heartbeat_interval` to use. */
+    readonly Hello: 10;
+    /** Sent in response to receiving a heartbeat to acknowledge that it has been received. */
+    readonly HeartbeatAck: 11;
+    /** Request information about soundboard sounds in a set of guilds. */
+    readonly RequestSoundboardSounds: 31;
+    /** Request ephemeral channel data for channels in a guild. */
+    readonly RequestChannelInfo: 43;
+};
+export type GatewayOpcode = (typeof GatewayOpcode)[keyof typeof GatewayOpcode];
+/**
+ * Gateway Close Event Codes
+ * @see https://docs.discord.com/developers/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes
+ */
+export declare const GatewayCloseCode: {
+    readonly UnknownError: 4000;
+    readonly UnknownOpcode: 4001;
+    readonly DecodeError: 4002;
+    readonly NotAuthenticated: 4003;
+    readonly AuthenticationFailed: 4004;
+    readonly AlreadyAuthenticated: 4005;
+    readonly InvalidSeq: 4007;
+    readonly RateLimited: 4008;
+    readonly SessionTimedOut: 4009;
+    readonly InvalidShard: 4010;
+    readonly ShardingRequired: 4011;
+    readonly InvalidApiVersion: 4012;
+    readonly InvalidIntents: 4013;
+    readonly DisallowedIntents: 4014;
+};
+export type GatewayCloseCode = (typeof GatewayCloseCode)[keyof typeof GatewayCloseCode];
+/**
+ * Close codes after which reconnecting is pointless: the "Reconnect" column
+ * of the table says `false`.
+ * @see https://docs.discord.com/developers/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes
+ */
+export declare const FATAL_GATEWAY_CLOSE_CODES: ReadonlySet<number>;
+/**
+ * Voice Opcodes
+ * @see https://docs.discord.com/developers/topics/opcodes-and-status-codes#voice-voice-opcodes
+ */
+export declare const VoiceOpcode: {
+    /** Begin a voice websocket connection. */
+    readonly Identify: 0;
+    /** Select the voice protocol. */
+    readonly SelectProtocol: 1;
+    /** Complete the websocket handshake. */
+    readonly Ready: 2;
+    /** Keep the websocket connection alive. */
+    readonly Heartbeat: 3;
+    /** Describe the session. */
+    readonly SessionDescription: 4;
+    /** Indicate which users are speaking. */
+    readonly Speaking: 5;
+    /** Sent to acknowledge a received client heartbeat. */
+    readonly HeartbeatAck: 6;
+    /** Resume a connection. */
+    readonly Resume: 7;
+    /** Time to wait between sending heartbeats in milliseconds. */
+    readonly Hello: 8;
+    /** Acknowledge a successful session resume. */
+    readonly Resumed: 9;
+    /** One or more clients have connected to the voice channel */
+    readonly ClientsConnect: 11;
+    /** A client has disconnected from the voice channel */
+    readonly ClientDisconnect: 13;
+    /** A downgrade from the DAVE protocol is upcoming */
+    readonly DavePrepareTransition: 21;
+    /** Execute a previously announced protocol transition */
+    readonly DaveExecuteTransition: 22;
+    /** Acknowledge readiness previously announced transition */
+    readonly DaveTransitionReady: 23;
+    /** A DAVE protocol version or group change is upcoming */
+    readonly DavePrepareEpoch: 24;
+    /** Credential and public key for MLS external sender */
+    readonly DaveMlsExternalSender: 25;
+    /** MLS Key Package for pending group member */
+    readonly DaveMlsKeyPackage: 26;
+    /** MLS Proposals to be appended or revoked */
+    readonly DaveMlsProposals: 27;
+    /** MLS Commit with optional MLS Welcome messages */
+    readonly DaveMlsCommitWelcome: 28;
+    /** MLS Commit to be processed for upcoming transition */
+    readonly DaveMlsAnnounceCommitTransition: 29;
+    /** MLS Welcome to group for upcoming transition */
+    readonly DaveMlsWelcome: 30;
+    /** Flag invalid commit or welcome, request re-add */
+    readonly DaveMlsInvalidCommitWelcome: 31;
+};
+export type VoiceOpcode = (typeof VoiceOpcode)[keyof typeof VoiceOpcode];
+/**
+ * Voice Close Event Codes
+ * @see https://docs.discord.com/developers/topics/opcodes-and-status-codes#voice-voice-close-event-codes
+ */
+export declare const VoiceCloseCode: {
+    readonly UnknownOpcode: 4001;
+    readonly FailedToDecodePayload: 4002;
+    readonly NotAuthenticated: 4003;
+    readonly AuthenticationFailed: 4004;
+    readonly AlreadyAuthenticated: 4005;
+    readonly SessionNoLongerValid: 4006;
+    readonly SessionTimeout: 4009;
+    readonly ServerNotFound: 4011;
+    readonly UnknownProtocol: 4012;
+    readonly Disconnected: 4014;
+    readonly VoiceServerCrashed: 4015;
+    readonly UnknownEncryptionMode: 4016;
+    readonly E2eeDaveProtocolRequired: 4017;
+    readonly BadRequest: 4020;
+    readonly DisconnectedRateLimited: 4021;
+    readonly DisconnectedCallTerminated: 4022;
+};
+export type VoiceCloseCode = (typeof VoiceCloseCode)[keyof typeof VoiceCloseCode];
+/**
+ * HTTP Response Codes
+ * @see https://docs.discord.com/developers/topics/opcodes-and-status-codes#http-http-response-codes
+ */
+export declare const HttpStatus: {
+    /** The request completed successfully. */
+    readonly Ok: 200;
+    /** The entity was created successfully. */
+    readonly Created: 201;
+    /** The request completed successfully but returned no content. */
+    readonly NoContent: 204;
+    /** The entity was not modified (no action was taken). */
+    readonly NotModified: 304;
+    /** The request was improperly formatted, or the server couldn't understand it. */
+    readonly BadRequest: 400;
+    /** The `Authorization` header was missing or invalid. */
+    readonly Unauthorized: 401;
+    /** The `Authorization` token you passed did not have permission to the resource. */
+    readonly Forbidden: 403;
+    /** The resource at the location specified doesn't exist. */
+    readonly NotFound: 404;
+    /** The HTTP method used is not valid for the location specified. */
+    readonly MethodNotAllowed: 405;
+    /** You are being rate limited, see Rate Limits. */
+    readonly TooManyRequests: 429;
+    /** There was not a gateway available to process your request. Wait a bit and retry. */
+    readonly GatewayUnavailable: 502;
+};
+export type HttpStatus = (typeof HttpStatus)[keyof typeof HttpStatus];
+/**
+ * JSON Error Codes: the `code` of an error response, with what Discord says
+ * it means.
+ * @see https://docs.discord.com/developers/topics/opcodes-and-status-codes#json-json-error-codes
+ */
+export declare const JSON_ERROR_CODES: Readonly<Record<number, string>>;