seyfert 0.1.0

package/lib/api/CDN.js

@@ -0,0 +1,236 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CDN = void 0;
+/* eslint-disable jsdoc/check-param-names */
+const index_js_1 = require("../common/index.js");
+const constants_js_1 = require("./utils/constants.js");
+const utils_js_1 = require("./utils/utils.js");
+let deprecationEmittedForEmoji = false;
+/**
+ * The CDN link builder
+ */
+class CDN {
+    base;
+    constructor(base = index_js_1.CDN_URL) {
+        this.base = base;
+    }
+    /**
+     * Generates an app asset URL for a client's asset.
+     *
+     * @param clientId - The client id that has the asset
+     * @param assetHash - The hash provided by Discord for this asset
+     * @param options - Optional options for the asset
+     */
+    appAsset(clientId, assetHash, options) {
+        return this.makeURL(`/app-assets/${clientId}/${assetHash}`, options);
+    }
+    /**
+     * Generates an app icon URL for a client's icon.
+     *
+     * @param clientId - The client id that has the icon
+     * @param iconHash - The hash provided by Discord for this icon
+     * @param options - Optional options for the icon
+     */
+    appIcon(clientId, iconHash, options) {
+        return this.makeURL(`/app-icons/${clientId}/${iconHash}`, options);
+    }
+    /**
+     * Generates an avatar URL, e.g. for a user or a webhook.
+     *
+     * @param id - The id that has the icon
+     * @param avatarHash - The hash provided by Discord for this avatar
+     * @param options - Optional options for the avatar
+     */
+    avatar(id, avatarHash, options) {
+        return this.dynamicMakeURL(`/avatars/${id}/${avatarHash}`, avatarHash, options);
+    }
+    /**
+     * Generates a user avatar decoration URL.
+     *
+     * @param userId - The id of the user
+     * @param userAvatarDecoration - The hash provided by Discord for this avatar decoration
+     * @param options - Optional options for the avatar decoration
+     */
+    avatarDecoration(userId, userAvatarDecoration, options) {
+        return this.makeURL(`/avatar-decorations/${userId}/${userAvatarDecoration}`, options);
+    }
+    /**
+     * Generates a banner URL, e.g. for a user or a guild.
+     *
+     * @param id - The id that has the banner splash
+     * @param bannerHash - The hash provided by Discord for this banner
+     * @param options - Optional options for the banner
+     */
+    banner(id, bannerHash, options) {
+        return this.dynamicMakeURL(`/banners/${id}/${bannerHash}`, bannerHash, options);
+    }
+    /**
+     * Generates an icon URL for a channel, e.g. a group DM.
+     *
+     * @param channelId - The channel id that has the icon
+     * @param iconHash - The hash provided by Discord for this channel
+     * @param options - Optional options for the icon
+     */
+    channelIcon(channelId, iconHash, options) {
+        return this.makeURL(`/channel-icons/${channelId}/${iconHash}`, options);
+    }
+    /**
+     * Generates a default avatar URL
+     *
+     * @param index - The default avatar index
+     * @remarks
+     * To calculate the index for a user do `(userId >> 22) % 6`,
+     * or `discriminator % 5` if they're using the legacy username system.
+     */
+    defaultAvatar(index) {
+        return this.makeURL(`/embed/avatars/${index}`, { extension: 'png' });
+    }
+    /**
+     * Generates a discovery splash URL for a guild's discovery splash.
+     *
+     * @param guildId - The guild id that has the discovery splash
+     * @param splashHash - The hash provided by Discord for this splash
+     * @param options - Optional options for the splash
+     */
+    discoverySplash(guildId, splashHash, options) {
+        return this.makeURL(`/discovery-splashes/${guildId}/${splashHash}`, options);
+    }
+    emoji(emojiId, options) {
+        let resolvedOptions;
+        if (typeof options === 'string') {
+            if (!deprecationEmittedForEmoji) {
+                (0, utils_js_1.deprecationWarning)('Passing a string for the second parameter of CDN#emoji() is deprecated. Use an object instead.');
+                deprecationEmittedForEmoji = true;
+            }
+            resolvedOptions = { extension: options };
+        }
+        else {
+            resolvedOptions = options;
+        }
+        return this.makeURL(`/emojis/${emojiId}`, resolvedOptions);
+    }
+    /**
+     * Generates a guild member avatar URL.
+     *
+     * @param guildId - The id of the guild
+     * @param userId - The id of the user
+     * @param avatarHash - The hash provided by Discord for this avatar
+     * @param options - Optional options for the avatar
+     */
+    guildMemberAvatar(guildId, userId, avatarHash, options) {
+        return this.dynamicMakeURL(`/guilds/${guildId}/users/${userId}/avatars/${avatarHash}`, avatarHash, options);
+    }
+    /**
+     * Generates a guild member banner URL.
+     *
+     * @param guildId - The id of the guild
+     * @param userId - The id of the user
+     * @param bannerHash - The hash provided by Discord for this banner
+     * @param options - Optional options for the banner
+     */
+    guildMemberBanner(guildId, userId, bannerHash, options) {
+        return this.dynamicMakeURL(`/guilds/${guildId}/users/${userId}/banner`, bannerHash, options);
+    }
+    /**
+     * Generates an icon URL, e.g. for a guild.
+     *
+     * @param id - The id that has the icon splash
+     * @param iconHash - The hash provided by Discord for this icon
+     * @param options - Optional options for the icon
+     */
+    icon(id, iconHash, options) {
+        return this.dynamicMakeURL(`/icons/${id}/${iconHash}`, iconHash, options);
+    }
+    /**
+     * Generates a URL for the icon of a role
+     *
+     * @param roleId - The id of the role that has the icon
+     * @param roleIconHash - The hash provided by Discord for this role icon
+     * @param options - Optional options for the role icon
+     */
+    roleIcon(roleId, roleIconHash, options) {
+        return this.makeURL(`/role-icons/${roleId}/${roleIconHash}`, options);
+    }
+    /**
+     * Generates a guild invite splash URL for a guild's invite splash.
+     *
+     * @param guildId - The guild id that has the invite splash
+     * @param splashHash - The hash provided by Discord for this splash
+     * @param options - Optional options for the splash
+     */
+    splash(guildId, splashHash, options) {
+        return this.makeURL(`/splashes/${guildId}/${splashHash}`, options);
+    }
+    /**
+     * Generates a sticker URL.
+     *
+     * @param stickerId - The sticker id
+     * @param extension - The extension of the sticker
+     * @privateRemarks
+     * Stickers cannot have a `.webp` extension, so we default to a `.png`
+     */
+    sticker(stickerId, extension = 'png') {
+        return this.makeURL(`/stickers/${stickerId}`, { allowedExtensions: constants_js_1.ALLOWED_STICKER_EXTENSIONS, extension });
+    }
+    /**
+     * Generates a sticker pack banner URL.
+     *
+     * @param bannerId - The banner id
+     * @param options - Optional options for the banner
+     */
+    stickerPackBanner(bannerId, options) {
+        return this.makeURL(`/app-assets/710982414301790216/store/${bannerId}`, options);
+    }
+    /**
+     * Generates a team icon URL for a team's icon.
+     *
+     * @param teamId - The team id that has the icon
+     * @param iconHash - The hash provided by Discord for this icon
+     * @param options - Optional options for the icon
+     */
+    teamIcon(teamId, iconHash, options) {
+        return this.makeURL(`/team-icons/${teamId}/${iconHash}`, options);
+    }
+    /**
+     * Generates a cover image for a guild scheduled event.
+     *
+     * @param scheduledEventId - The scheduled event id
+     * @param coverHash - The hash provided by discord for this cover image
+     * @param options - Optional options for the cover image
+     */
+    guildScheduledEventCover(scheduledEventId, coverHash, options) {
+        return this.makeURL(`/guild-events/${scheduledEventId}/${coverHash}`, options);
+    }
+    /**
+     * Constructs the URL for the resource, checking whether or not `hash` starts with `a_` if `dynamic` is set to `true`.
+     *
+     * @param route - The base cdn route
+     * @param hash - The hash provided by Discord for this icon
+     * @param options - Optional options for the link
+     */
+    dynamicMakeURL(route, hash, { forceStatic = false, ...options } = {}) {
+        return this.makeURL(route, !forceStatic && hash.startsWith('a_') ? { ...options, extension: 'gif' } : options);
+    }
+    /**
+     * Constructs the URL for the resource
+     *
+     * @param route - The base cdn route
+     * @param options - The extension/size options for the link
+     */
+    makeURL(route, { allowedExtensions = constants_js_1.ALLOWED_EXTENSIONS, extension = 'webp', size } = {}) {
+        // eslint-disable-next-line no-param-reassign
+        extension = String(extension).toLowerCase();
+        if (!allowedExtensions.includes(extension)) {
+            throw new RangeError(`Invalid extension provided: ${extension}\nMust be one of: ${allowedExtensions.join(', ')}`);
+        }
+        if (size && !constants_js_1.ALLOWED_SIZES.includes(size)) {
+            throw new RangeError(`Invalid size provided: ${size}\nMust be one of: ${constants_js_1.ALLOWED_SIZES.join(', ')}`);
+        }
+        const url = new URL(`${this.base}${route}.${extension}`);
+        if (size) {
+            url.searchParams.set('size', String(size));
+        }
+        return url.toString();
+    }
+}
+exports.CDN = CDN;

package/lib/api/REST.d.ts

@@ -0,0 +1,127 @@
+import type { Dispatcher } from 'undici-types';
+import { Collection } from '../collection';
+import { Logger } from '../common/it/logger';
+import { CDN } from './CDN';
+import type { ProxyRequestMethod } from './Router';
+import type { IHandler } from './interfaces/Handler';
+import type { HashData, InternalRequest, RESTConstructorOptions, RESTOptions, RawFile, RequestData, ResponseLike } from './utils/types';
+/**
+ * Represents the class that manages handlers for endpoints
+ */
+export declare class REST {
+    #private;
+    /**
+     * The {@link https://undici.nodejs.org/#/docs/api/Agent | Agent} for all requests
+     * performed by this manager.
+     */
+    agent: Dispatcher | null;
+    /**
+     * The number of requests remaining in the global bucket
+     */
+    globalRemaining: number;
+    /**
+     * The promise used to wait out the global rate limit
+     */
+    globalDelay: Promise<void> | null;
+    /**
+     * The timestamp at which the global bucket resets
+     */
+    globalReset: number;
+    /**
+     * API bucket hashes that are cached from provided routes
+     */
+    readonly hashes: Collection<string, HashData>;
+    /**
+     * Request handlers created from the bucket hash and the major parameters
+     */
+    readonly handlers: Collection<string, IHandler>;
+    readonly cdn: CDN;
+    private hashTimer;
+    private handlerTimer;
+    readonly options: RESTOptions;
+    debugger?: Logger;
+    constructor(options: RESTConstructorOptions);
+    private setupSweepers;
+    /**
+     * Runs a get request from the api
+     *
+     * @param route - The full route to query
+     * @param options - Optional request options
+     */
+    get<T>(route: string, options?: RequestObject<ProxyRequestMethod.Get>): Promise<T>;
+    /**
+     * Runs a delete request from the api
+     *
+     * @param route - The full route to query
+     * @param options - Optional request options
+     */
+    delete<T>(route: string, options?: RequestObject<ProxyRequestMethod.Delete>): Promise<T>;
+    /**
+     * Runs a post request from the api
+     *
+     * @param route - The full route to query
+     * @param options - Optional request options
+     */
+    post<T>(route: string, body?: RequestObject<ProxyRequestMethod.Post>): Promise<T>;
+    /**
+     * Runs a put request from the api
+     *
+     * @param route - The full route to query
+     * @param options - Optional request options
+     */
+    put<T>(route: string, body?: RequestObject<ProxyRequestMethod.Put>): Promise<T>;
+    /**
+     * Runs a patch request from the api
+     *
+     * @param route - The full route to query
+     * @param options - Optional request options
+     */
+    patch<T>(route: string, body?: RequestObject<ProxyRequestMethod.Patch>): Promise<T>;
+    /**
+     * Runs a request from the api
+     *
+     * @param options - Request options
+     */
+    request(options: InternalRequest): Promise<unknown>;
+    /**
+     * Sets the default agent to use for requests performed by this manager
+     *
+     * @param agent - The agent to use
+     */
+    setAgent(agent: Dispatcher): this;
+    /**
+     * Sets the authorization token that should be used for requests
+     *
+     * @param token - The authorization token to use
+     */
+    setToken(token: string): this;
+    /**
+     * Queues a request to be sent
+     *
+     * @param request - All the information needed to make a request
+     * @returns The response from the api request
+     */
+    queueRequest(request: InternalRequest): Promise<ResponseLike>;
+    /**
+     * Formats the request data to a usable format for fetch
+     *
+     * @param request - The request data
+     */
+    private resolveRequest;
+    /**
+     * Stops the hash sweeping interval
+     */
+    clearHashSweeper(): void;
+    /**
+     * Stops the request handler sweeping interval
+     */
+    clearHandlerSweeper(): void;
+}
+export type RequestOptions = Pick<RequestData, 'passThroughBody' | 'reason' | 'auth' | 'appendToFormData'>;
+export type RequestObject<M extends ProxyRequestMethod, B = Record<string, any>, Q = Record<string, any>, F extends RawFile[] = RawFile[]> = {
+    query?: Q;
+} & RequestOptions & (M extends `${ProxyRequestMethod.Get}` ? unknown : {
+    body?: B;
+    files?: F;
+});
+export type RestArguments<M extends ProxyRequestMethod, B = any, Q extends never | Record<string, any> = any, F extends RawFile[] = RawFile[]> = M extends ProxyRequestMethod.Get ? Q extends never ? RequestObject<M, never, B, never> : never : RequestObject<M, B, Q, F>;