seyfert 1.5.0 → 2.1.0

package/lib/types/payloads/gateway.d.ts

@@ -0,0 +1,373 @@
+/**
+ * Types extracted from
+ *  - https://discord.com/developers/docs/topics/gateway
+ *  - https://discord.com/developers/docs/topics/gateway-events
+ */
+import type { Snowflake } from '../index';
+import type { APIChannel, APIThreadMember } from './channel';
+import type { APIEmoji } from './emoji';
+import type { APIUser } from './user';
+/**
+ * https://discord.com/developers/docs/topics/gateway#get-gateway
+ */
+export interface APIGatewayInfo {
+    /**
+     * The WSS URL that can be used for connecting to the gateway
+     */
+    url: string;
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway#get-gateway-bot
+ */
+export interface APIGatewayBotInfo extends APIGatewayInfo {
+    /**
+     * The recommended number of shards to use when connecting
+     *
+     * See https://discord.com/developers/docs/topics/gateway#sharding
+     */
+    shards: number;
+    /**
+     * Information on the current session start limit
+     *
+     * See https://discord.com/developers/docs/topics/gateway#session-start-limit-object
+     */
+    session_start_limit: APIGatewaySessionStartLimit;
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway#session-start-limit-object
+ */
+export interface APIGatewaySessionStartLimit {
+    /**
+     * The total number of session starts the current user is allowed
+     */
+    total: number;
+    /**
+     * The remaining number of session starts the current user is allowed
+     */
+    remaining: number;
+    /**
+     * The number of milliseconds after which the limit resets
+     */
+    reset_after: number;
+    /**
+     * The number of identify requests allowed per 5 seconds
+     */
+    max_concurrency: number;
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields
+ */
+export interface GatewayPresenceUpdate {
+    /**
+     * The user presence is being updated for
+     *
+     * **The user object within this event can be partial, the only field which must be sent is the `id` field,
+     * everything else is optional.**
+     *
+     * See https://discord.com/developers/docs/resources/user#user-object
+     */
+    user: Partial<APIUser> & Pick<APIUser, 'id'>;
+    /**
+     * ID of the guild
+     */
+    guild_id: Snowflake;
+    /**
+     * Either "idle", "dnd", "online", or "offline"
+     */
+    status?: PresenceUpdateReceiveStatus;
+    /**
+     * User's current activities
+     *
+     * See https://discord.com/developers/docs/topics/gateway-events#activity-object
+     */
+    activities?: GatewayActivity[];
+    /**
+     * User's platform-dependent status
+     *
+     * See https://discord.com/developers/docs/topics/gateway-events#client-status-object
+     */
+    client_status?: GatewayPresenceClientStatus;
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#update-presence-status-types
+ */
+export declare enum PresenceUpdateStatus {
+    Online = "online",
+    DoNotDisturb = "dnd",
+    Idle = "idle",
+    /**
+     * Invisible and shown as offline
+     */
+    Invisible = "invisible",
+    Offline = "offline"
+}
+export type PresenceUpdateReceiveStatus = Exclude<PresenceUpdateStatus, PresenceUpdateStatus.Invisible>;
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#client-status-object
+ */
+export interface GatewayPresenceClientStatus {
+    /**
+     * The user's status set for an active desktop (Windows, Linux, Mac) application session
+     */
+    desktop?: PresenceUpdateReceiveStatus;
+    /**
+     * The user's status set for an active mobile (iOS, Android) application session
+     */
+    mobile?: PresenceUpdateReceiveStatus;
+    /**
+     * The user's status set for an active web (browser, bot account) application session
+     */
+    web?: PresenceUpdateReceiveStatus;
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure
+ */
+export interface GatewayActivity {
+    /**
+     * The activity's id
+     *
+     * @unstable
+     */
+    id: string;
+    /**
+     * The activity's name
+     */
+    name: string;
+    /**
+     * Activity type
+     *
+     * See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
+     */
+    type: ActivityType;
+    /**
+     * Stream url, is validated when type is `1`
+     */
+    url?: string | null;
+    /**
+     * Unix timestamp of when the activity was added to the user's session
+     */
+    created_at: number;
+    /**
+     * Unix timestamps for start and/or end of the game
+     */
+    timestamps?: GatewayActivityTimestamps;
+    /**
+     * The Spotify song id
+     *
+     * @unstable
+     */
+    sync_id?: string;
+    /**
+     * The platform this activity is being done on
+     *
+     * @unstable You can use {@link ActivityPlatform} as a stepping stone, but this might be inaccurate
+     */
+    platform?: string;
+    /**
+     * Application id for the game
+     */
+    application_id?: Snowflake;
+    /**
+     * What the player is currently doing
+     */
+    details?: string | null;
+    /**
+     * The user's current party status, or the text used for a custom status
+     */
+    state?: string | null;
+    /**
+     * The emoji used for a custom status
+     *
+     * See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
+     */
+    emoji?: GatewayActivityEmoji;
+    /**
+     * @unstable
+     */
+    session_id?: string;
+    /**
+     * Information for the current party of the player
+     *
+     * See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
+     */
+    party?: GatewayActivityParty;
+    /**
+     * Images for the presence and their hover texts
+     *
+     * See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
+     */
+    assets?: GatewayActivityAssets;
+    /**
+     * Secrets for Rich Presence joining and spectating
+     *
+     * See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
+     */
+    secrets?: GatewayActivitySecrets;
+    /**
+     * Whether or not the activity is an instanced game session
+     */
+    instance?: boolean;
+    /**
+     * Activity flags `OR`d together, describes what the payload includes
+     *
+     * See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
+     *
+     * See https://en.wikipedia.org/wiki/Bit_field
+     */
+    flags?: ActivityFlags;
+    /**
+     * The custom buttons shown in the Rich Presence (max 2)
+     */
+    buttons?: GatewayActivityButton[] | string[];
+}
+/**
+ * @unstable This enum is currently not documented by Discord but has known values which we will try to keep up to date.
+ * Values might be added or removed without a major version bump.
+ */
+export declare enum ActivityPlatform {
+    Desktop = "desktop",
+    Xbox = "xbox",
+    Samsung = "samsung",
+    IOS = "ios",
+    Android = "android",
+    Embedded = "embedded",
+    PS4 = "ps4",
+    PS5 = "ps5"
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
+ */
+export declare enum ActivityType {
+    /**
+     * Playing {game}
+     */
+    Playing = 0,
+    /**
+     * Streaming {details}
+     */
+    Streaming = 1,
+    /**
+     * Listening to {name}
+     */
+    Listening = 2,
+    /**
+     * Watching {details}
+     */
+    Watching = 3,
+    /**
+     * {emoji} {state}
+     */
+    Custom = 4,
+    /**
+     * Competing in {name}
+     */
+    Competing = 5
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-timestamps
+ */
+export interface GatewayActivityTimestamps {
+    /**
+     * Unix time (in milliseconds) of when the activity started
+     */
+    start?: number;
+    /**
+     * Unix time (in milliseconds) of when the activity ends
+     */
+    end?: number;
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
+ */
+export type GatewayActivityEmoji = Partial<Pick<APIEmoji, 'animated' | 'id'>> & Pick<APIEmoji, 'name'>;
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
+ */
+export interface GatewayActivityParty {
+    /**
+     * The id of the party
+     */
+    id?: string;
+    /**
+     * Used to show the party's current and maximum size
+     */
+    size?: [current_size: number, max_size: number];
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
+ */
+export type GatewayActivityAssets = Partial<Record<'large_image' | 'large_text' | 'small_image' | 'small_text', string>>;
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
+ */
+export type GatewayActivitySecrets = Partial<Record<'join' | 'match' | 'spectate', string>>;
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
+ */
+export declare enum ActivityFlags {
+    Instance = 1,
+    Join = 2,
+    Spectate = 4,
+    JoinRequest = 8,
+    Sync = 16,
+    Play = 32,
+    PartyPrivacyFriends = 64,
+    PartyPrivacyVoiceChannel = 128,
+    Embedded = 256
+}
+export interface GatewayActivityButton {
+    /**
+     * The text shown on the button (1-32 characters)
+     */
+    label: string;
+    /**
+     * The url opened when clicking the button (1-512 characters)
+     */
+    url: string;
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#thread-list-sync-thread-list-sync-event-fields
+ */
+export interface GatewayThreadListSync {
+    /**
+     * ID of the guild
+     */
+    guild_id: Snowflake;
+    /**
+     * The ids of all the parent channels whose threads are being synced, otherwise the entire guild
+     */
+    channel_ids?: Snowflake[];
+    /**
+     * Array of the synced threads
+     */
+    threads: APIChannel[];
+    /**
+     * The member objects for the client user in each joined thread that was synced
+     */
+    members: APIThreadMember[];
+}
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#thread-members-update-thread-members-update-event-fields
+ */
+export interface GatewayThreadMembersUpdate {
+    /**
+     * The id of the thread for which members are being synced
+     */
+    id: Snowflake;
+    /**
+     * The id of the guild that the thread is in
+     */
+    guild_id: Snowflake;
+    /**
+     * The approximate member count of the thread, does not count above 50 even if there are more members
+     */
+    member_count: number;
+    /**
+     * The members that were added to the thread
+     */
+    added_members?: APIThreadMember[];
+    /**
+     * The ids of the members that were removed from the thread
+     */
+    removed_member_ids?: Snowflake[];
+}

package/lib/types/payloads/gateway.js

@@ -0,0 +1,82 @@
+"use strict";
+/**
+ * Types extracted from
+ *  - https://discord.com/developers/docs/topics/gateway
+ *  - https://discord.com/developers/docs/topics/gateway-events
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityFlags = exports.ActivityType = exports.ActivityPlatform = exports.PresenceUpdateStatus = void 0;
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#update-presence-status-types
+ */
+var PresenceUpdateStatus;
+(function (PresenceUpdateStatus) {
+    PresenceUpdateStatus["Online"] = "online";
+    PresenceUpdateStatus["DoNotDisturb"] = "dnd";
+    PresenceUpdateStatus["Idle"] = "idle";
+    /**
+     * Invisible and shown as offline
+     */
+    PresenceUpdateStatus["Invisible"] = "invisible";
+    PresenceUpdateStatus["Offline"] = "offline";
+})(PresenceUpdateStatus || (exports.PresenceUpdateStatus = PresenceUpdateStatus = {}));
+/**
+ * @unstable This enum is currently not documented by Discord but has known values which we will try to keep up to date.
+ * Values might be added or removed without a major version bump.
+ */
+var ActivityPlatform;
+(function (ActivityPlatform) {
+    ActivityPlatform["Desktop"] = "desktop";
+    ActivityPlatform["Xbox"] = "xbox";
+    ActivityPlatform["Samsung"] = "samsung";
+    ActivityPlatform["IOS"] = "ios";
+    ActivityPlatform["Android"] = "android";
+    ActivityPlatform["Embedded"] = "embedded";
+    ActivityPlatform["PS4"] = "ps4";
+    ActivityPlatform["PS5"] = "ps5";
+})(ActivityPlatform || (exports.ActivityPlatform = ActivityPlatform = {}));
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
+ */
+var ActivityType;
+(function (ActivityType) {
+    /**
+     * Playing {game}
+     */
+    ActivityType[ActivityType["Playing"] = 0] = "Playing";
+    /**
+     * Streaming {details}
+     */
+    ActivityType[ActivityType["Streaming"] = 1] = "Streaming";
+    /**
+     * Listening to {name}
+     */
+    ActivityType[ActivityType["Listening"] = 2] = "Listening";
+    /**
+     * Watching {details}
+     */
+    ActivityType[ActivityType["Watching"] = 3] = "Watching";
+    /**
+     * {emoji} {state}
+     */
+    ActivityType[ActivityType["Custom"] = 4] = "Custom";
+    /**
+     * Competing in {name}
+     */
+    ActivityType[ActivityType["Competing"] = 5] = "Competing";
+})(ActivityType || (exports.ActivityType = ActivityType = {}));
+/**
+ * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
+ */
+var ActivityFlags;
+(function (ActivityFlags) {
+    ActivityFlags[ActivityFlags["Instance"] = 1] = "Instance";
+    ActivityFlags[ActivityFlags["Join"] = 2] = "Join";
+    ActivityFlags[ActivityFlags["Spectate"] = 4] = "Spectate";
+    ActivityFlags[ActivityFlags["JoinRequest"] = 8] = "JoinRequest";
+    ActivityFlags[ActivityFlags["Sync"] = 16] = "Sync";
+    ActivityFlags[ActivityFlags["Play"] = 32] = "Play";
+    ActivityFlags[ActivityFlags["PartyPrivacyFriends"] = 64] = "PartyPrivacyFriends";
+    ActivityFlags[ActivityFlags["PartyPrivacyVoiceChannel"] = 128] = "PartyPrivacyVoiceChannel";
+    ActivityFlags[ActivityFlags["Embedded"] = 256] = "Embedded";
+})(ActivityFlags || (exports.ActivityFlags = ActivityFlags = {}));