guilds.js 0.0.2 → 0.0.4

package/dist/index.d.cts

@@ -1,5 +1,61 @@
+declare namespace api_types_d_exports {
+  export { AvatarDecorationData, Collectible, Nameplate, PrimaryGuild, User$1 as User };
+}
+interface AvatarDecorationData {
+  asset: string;
+  sku_id: string;
+}
+interface Collectible {
+  nameplate?: Nameplate;
+}
+interface Nameplate {
+  sku_id: string;
+  asset: string;
+  label: string;
+  palette: string;
+}
+interface PrimaryGuild {
+  badge?: string;
+  identity_enabled?: boolean;
+  identity_guild_id?: string;
+  tag?: string;
+}
+interface User$1 {
+  accent_color?: number;
+  avatar?: string;
+  avatar_decoration_data?: AvatarDecorationData;
+  banner?: string;
+  bot?: boolean;
+  collectibles?: Collectible;
+  discriminator: string;
+  email?: string;
+  flags?: number;
+  global_name: string;
+  id: string;
+  locale?: string;
+  mfa_enabled?: boolean;
+  premium_type?: number;
+  primary_guild?: PrimaryGuild;
+  public_flags?: number;
+  system?: boolean;
+  username: string;
+  verified?: boolean;
+}
+//#endregion
+//#region src/utils/color-convert.d.ts
+/**
+ * Converts an integer color to a hex color string
+ * @returns Hex string or null
+ */
+declare function colorIntToHex(color: number | null, addHashSymbol?: boolean): string | null;
+/**
+ * Converts a hex color string to an integer color
+ * @returns Color integer or null
+ */
+declare function hexToColorInt(hex: string | null): number | null;
+//#endregion
 //#region src/utils/constants.d.ts
-declare const activityTypes: {
+declare const ActivityTypes: {
   readonly Competing: 5;
   readonly Custom: 4;
   readonly Listening: 2;
@@ -8,99 +64,284 @@ declare const activityTypes: {
   readonly Watching: 3;
 };
 declare const baseApiUrl = "https://discord.com/api/v10";
-declare const errorCodes: readonly ["ClientIntentsError", "ClientPropsError", "ClientTokenError", "DiscordAPIError", "GatewayError", "WebSocketError"];
-declare const opCodes: {
-  readonly Dispatch: 0;
-  readonly Heartbeat: 1;
-  readonly HeartbeatACK: 11;
-  readonly Hello: 10;
-  readonly Identify: 2;
-  readonly InvalidSession: 9;
-  readonly PresenceUpdate: 3;
-  readonly Reconnect: 7;
-  readonly RequestGuildMembers: 8;
-  readonly RequestSoundboardSounds: 12;
-  readonly Resume: 6;
+declare const GatewayIntents: {
+  readonly AutoModerationConfiguration: number;
+  readonly AutoModerationExecution: number;
+  readonly DirectMessagePolls: number;
+  readonly DirectMessageReactions: number;
+  readonly DirectMessages: number;
+  readonly DirectMessageTyping: number;
+  readonly GuildExpressions: number;
+  readonly GuildIntegrations: number;
+  readonly GuildInvites: number;
+  readonly GuildMembers: number;
+  readonly GuildMessagePolls: number;
+  readonly GuildMessageReactions: number;
+  readonly GuildMessages: number;
+  readonly GuildMessageTyping: number;
+  readonly GuildModeration: number;
+  readonly GuildPresences: number;
+  readonly Guilds: number;
+  readonly GuildScheduledEvents: number;
+  readonly GuildVoiceStates: number;
+  readonly GuildWebhooks: number;
+  readonly MessageContent: number;
+};
+declare const GatewayOpcodes: {
+  /** Receive */readonly Dispatch: 0; /** Send or Receive */
+  readonly Heartbeat: 1; /** Receive */
+  readonly HeartbeatACK: 11; /** Receive */
+  readonly Hello: 10; /** Send */
+  readonly Identify: 2; /** Receive */
+  readonly InvalidSession: 9; /** Send */
+  readonly PresenceUpdate: 3; /** Receive */
+  readonly Reconnect: 7; /** Send */
+  readonly RequestGuildMembers: 8; /** Send */
+  readonly RequestSoundboardSounds: 12; /** Send */
+  readonly Resume: 6; /** Send */
   readonly VoiceStateUpdate: 3;
 };
 //#endregion
+//#region src/utils/endpoints.d.ts
+/** Discord's API v10 endpoints */
+declare const Endpoints: {
+  /**
+   * - GET `/gateway`
+   */
+  gateway(): "https://discord.com/api/v10/gateway";
+  /**
+   * - GET `/gateway/bot`
+   * - POST `/gateway/bot`
+   */
+  gatewayBot(): "https://discord.com/api/v10/gateway/bot";
+  /**
+   * - GET `/users/{userId}`
+   * @param userId User ID (default: "@me")
+   */
+  user(userId?: string): `https://discord.com/api/v10/users/${string}`;
+};
+//#endregion
+//#region src/utils/parse-intents.d.ts
+/**
+ * Parse intents into bitfield
+ * @param intents Intents resolvable
+ * @returns Parsed intents as a bitfield
+ */
+declare function parseIntents(intents: IntentsResolvable): number;
+//#endregion
 //#region src/classes/EventHandler.d.ts
+/** Class representing a type-safe EventEmitter */
 declare class EventHandler<Events extends Record<string, any[]>> {
   #private;
+  /**
+   * Add a new event listener
+   * @param event Event name
+   * @param listener Listener callback
+   */
   on<K extends keyof Events>(event: K, listener: (...args: Events[K]) => any): this;
+  /**
+   * Add a new event listener which only runs once
+   * @param event Event name
+   * @param listener Listener callback
+   */
   once<K extends keyof Events>(event: K, listener: (...args: Events[K]) => any): this;
+  /**
+   * Remove an event name
+   * @param event Event name
+   * @param listener Listener callback
+   */
   off<K extends keyof Events>(event: K, listener: (...args: Events[K]) => any): this;
+  /**
+   * Emit an event
+   * @param event Event name
+   * @param args Event arguments
+   */
   emit<K extends keyof Events>(event: K, ...args: Events[K]): Promise<boolean>;
 }
 //#endregion
 //#region src/classes/GuildsError.d.ts
+/** Class representing a library-related error */
 declare class GuildsError extends Error {
   static name: string;
-  readonly scope?: ErrorCode;
+  readonly scope?: ErrorScope;
   get name(): string;
-  constructor(message: string, scope?: ErrorCode);
+  constructor(message: string, scope?: ErrorScope);
 }
 //#endregion
-//#region src/classes/Routes.d.ts
-declare class Routes {
-  static gateway(bot?: boolean): "https://discord.com/api/v10/gateway/bot" | "https://discord.com/api/v10/gateway";
-  static user(userId?: string): `https://discord.com/api/v10/users/${string}`;
+//#region src/classes/RESTManager.d.ts
+/** Class representing a Discord REST API manager */
+declare class RESTManager {
+  #private;
+  /**
+   * Instantiate a new Discord API manager
+   * @param token Client token
+   */
+  constructor(token: string);
+  /**
+   * Create a HTTP DELETE request
+   * @param endpoint Endpoint URI
+   * @param init Request data
+   */
+  delete<T = any>(endpoint: string, init?: RequestInit): Promise<Response & {
+    data: T;
+  }>;
+  /**
+   * Create a HTTP GET request
+   * @param endpoint Endpoint URI
+   * @param init Request data
+   */
+  get<T = any>(endpoint: string, init?: RequestInit): Promise<Response & {
+    data: T;
+  }>;
+  /**
+   * Create a HTTP PATCH request
+   * @param endpoint Endpoint URI
+   * @param init Request data
+   */
+  patch<T = any>(endpoint: string, init?: RequestInit): Promise<Response & {
+    data: T;
+  }>;
+  /**
+   * Create a HTTP POST request
+   * @param endpoint Endpoint URI
+   * @param init Request data
+   */
+  post<T = any>(endpoint: string, init?: RequestInit): Promise<Response & {
+    data: T;
+  }>;
+  /**
+   * Create a HTTP PUT request
+   * @param endpoint Endpoint URI
+   * @param init Request data
+   */
+  put<T = any>(endpoint: string, init?: RequestInit): Promise<Response & {
+    data: T;
+  }>;
 }
 //#endregion
-//#region src/classes/DiscordAPI.d.ts
-declare class DiscordAPI {
+//#region src/classes/User.d.ts
+/**
+ * Class representing a Discord user
+ * @see https://docs.discord.com/developers/resources/user
+ */
+declare class User {
   #private;
-  constructor(token: string);
-  get token(): string;
-  get(input: string | URL | Request, init?: RequestInit): Promise<Response>;
+  /** The user's banner color as a color integer */
+  accentColor?: number;
+  /** The user's banner color as a hex color*/
+  accentColorHex: string | null;
+  /** The user's about me (client only) */
+  bio: string | null;
+  /** Whether the user is an application (bot) */
+  bot: boolean;
+  /** The user's discriminator, or "0" if they have none */
+  discriminator: string;
+  /** The user's display name or bot's application name */
+  displayName?: string;
+  /** The user's email (user clients only) */
+  email?: string;
+  /** The user's ID snowflake */
+  id: string;
+  /** Whether the user has two factor authentication enabled (user clients only) */
+  mfaEnabled?: boolean;
+  /** The data from Discord's API provided as-is */
+  rawData: User$1;
+  /** Whether the user is a Discord system account */
+  system: boolean;
+  /** The user's username (not to be confused with display name or tag) */
+  username: string;
+  /** Whether the user's email is verified (user clients only) */
+  verified?: boolean;
+  constructor(client: Client, data: User$1);
+  /** The client associated with this user */
+  get client(): Client;
+  /** Get the user's avatar as an image URL */
+  avatarURL(props: AvatarURLProps): string | null;
+  /** `username#0000` or just `username` (if no discriminator) */
+  get tag(): string;
+  /** User mention as a string, e.g. <@123456789> */
+  toString(): string;
 }
 //#endregion
 //#region src/classes/Client.d.ts
-declare class Client<Ready extends boolean = false> extends EventHandler<ClientEvents> {
+/** Class representing a Discord client */
+declare class Client extends EventHandler<ClientEvents> {
   #private;
-  get token(): string;
-  get intents(): number;
-  get heartbeatInterval(): NodeJS.Timeout | undefined;
-  get presence(): ClientPresence;
-  isReady(): this is Client<true>;
+  /** Gateway heartbeat inteval */
+  heartbeatInterval?: NodeJS.Timeout;
+  /** Last received sequence number */
+  sequenceNumber: number | null;
+  /** Gateway session ID */
+  sessionId?: string;
+  /** REST manager instance to handle API calls */
+  rest: RESTManager;
+  /** Client intents bitfield */
+  intents: number;
+  /** Whether the client is ready */
+  ready: boolean;
+  /** WebSocket connection */
+  ws?: WebSocket;
+  /** Client user, or null if not ready */
+  user: User | null;
+  /** Current presence information */
+  presence: ClientPresenceProps;
+  /**
+   * Instantiate a new Client
+   * @param props Client options
+   */
   constructor(props: ClientProps);
-  connect(): Promise<Client<true>>;
-  setPresence(presence: Partial<ClientPresence>): this;
-  disconnect(): Promise<void>;
+  /** The client's token */
+  get token(): string;
+  /** Start the connection to Discord's gateway */
+  connect(): Promise<Client>;
+  destroyed: boolean;
+  lastHeartbeatAck: boolean;
+  /** Update the client's user presence */
+  setPresence(presence: Partial<ClientPresenceProps>): this;
+  /** Destroy the connection to Discord's gateway */
+  disconnect(): void;
 }
 //#endregion
-//#region src/types.d.ts
-type ActivityType = keyof typeof activityTypes | (typeof activityTypes)[keyof typeof activityTypes];
+//#region src/typings/index.d.ts
+interface AvatarURLProps {
+  size: 128 | 256 | 512 | 1024 | 2048 | 4096;
+  format?: "webp" | "png" | "jpg" | "gif";
+}
 type ClientEvents = {
   debug: [message: string];
   error: [error: any];
-  ready: [readyClient: Client<true>];
+  ready: [client: Client];
 };
-interface ClientPresence {
-  activities: ClientActivity[];
+interface ClientPresenceProps {
+  activities: UserActivity[];
   platform: "desktop" | "mobile";
   status: UserStatus;
 }
-interface ClientActivity {
-  name: string;
-  state?: string;
-  type: ActivityType;
-  url?: string;
-}
-interface ClientPresence {}
 interface ClientProps {
   token: string;
-  intents: number;
-  presence?: Partial<ClientPresence>;
+  intents: IntentsResolvable;
+  presence?: Partial<ClientPresenceProps>;
 }
-type ErrorCode = (typeof errorCodes)[keyof typeof errorCodes];
+declare const errorScopes: readonly ["ClientIntentsError", "ClientPropsError", "ClientTokenError", "DiscordAPIError", "GatewayError", "WebSocketError"];
+type ErrorScope = (typeof errorScopes)[keyof typeof errorScopes];
+type GatewayIntent = keyof typeof GatewayIntents | (typeof GatewayIntents)[keyof typeof GatewayIntents];
+type GatewayOpcode = (typeof GatewayOpcodes)[keyof typeof GatewayOpcodes];
 interface GatewayPayload {
-  op: (typeof opCodes)[keyof typeof opCodes];
+  op: GatewayOpcode;
   d?: any;
   s?: number | null;
   t?: string | null;
 }
+type HTTPRequestMethod = "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
 type If<Condition extends boolean, Then, Else = never> = Condition extends true ? Then : Else;
+type IntentsResolvable = number | number[] | GatewayIntent[];
+interface UserActivity {
+  name: string;
+  state?: string;
+  type: UserActivityType;
+  url?: string;
+}
+type UserActivityType = keyof typeof ActivityTypes | (typeof ActivityTypes)[keyof typeof ActivityTypes];
 type UserStatus = "online" | "idle" | "dnd" | "offline";
 //#endregion
-export { ActivityType, Client, ClientActivity, ClientEvents, ClientPresence, ClientProps, DiscordAPI, ErrorCode, EventHandler, GatewayPayload, GuildsError, If, Routes, UserStatus, activityTypes, baseApiUrl, errorCodes, opCodes };
+export { ActivityTypes, AvatarURLProps, Client, ClientEvents, ClientPresenceProps, ClientProps, type api_types_d_exports as DiscordAPI, Endpoints, ErrorScope, EventHandler, GatewayIntent, GatewayIntents, GatewayOpcode, GatewayOpcodes, GatewayPayload, GuildsError, HTTPRequestMethod, If, IntentsResolvable, RESTManager, User, UserActivity, UserActivityType, UserStatus, baseApiUrl, colorIntToHex, hexToColorInt, parseIntents };