detritus-client-socket/lib/constants.d.ts

A TypeScript NodeJS library to interact with Discord's Gateway

export declare const Package: Readonly<{
    URL: string;
    VERSION: string;
}>;
export declare const ApiVersions: Readonly<{
    GATEWAY: number;
    MEDIA_GATEWAY: number;
}>;
export declare enum CompressTypes {
    NONE = "none",
    PAYLOAD = "payload",
    ZLIB = "zlib-stream"
}
export declare const COMPRESS_TYPES: readonly CompressTypes[];
export declare enum CryptoModules {
    LIBSODIUM_WRAPPERS = "libsodium-wrappers",
    SODIUM = "sodium",
    TWEETNACL = "tweetnacl"
}
export declare const DEFAULT_SHARD_COUNT = 1;
export declare const DEFAULT_SHARD_LAUNCH_DELAY = 5000;
export declare const DEFAULT_VOICE_TIMEOUT = 30000;
export declare enum EncodingTypes {
    ETF = "etf",
    JSON = "json"
}
export declare enum GatewayActivityActionTypes {
    JOIN = 1,
    SPECTATE = 2,
    LISTEN = 3,
    WATCH = 4,
    JOIN_REQUEST = 5
}
export declare enum GatewayActivityFlags {
    INSTANCE = 1,
    JOIN = 2,
    SPECTATE = 4,
    JOIN_REQUEST = 8,
    SYNC = 16,
    PLAY = 32,
    PARTY_PRIVACY_FRIENDS = 64,
    PARTY_PRIVACY_VOICE_CHANNEL = 128,
    PARTY_EMBEDDED = 256
}
export declare enum GatewayActivityTypes {
    PLAYING = 0,
    STREAMING = 1,
    LISTENING = 2,
    WATCHING = 3,
    CUSTOM_STATUS = 4
}
export declare enum GatewayDispatchEvents {
    READY = "READY",
    RESUMED = "RESUMED",
    ACTIVITY_JOIN_INVITE = "ACTIVITY_JOIN_INVITE",
    ACTIVITY_JOIN_REQUEST = "ACTIVITY_JOIN_REQUEST",
    ACTIVITY_START = "ACTIVITY_START",
    APPLICATION_COMMAND_CREATE = "APPLICATION_COMMAND_CREATE",
    APPLICATION_COMMAND_DELETE = "APPLICATION_COMMAND_DELETE",
    APPLICATION_COMMAND_UPDATE = "APPLICATION_COMMAND_UPDATE",
    BRAINTREE_POPUP_BRIDGE_CALLBACK = "BRAINTREE_POPUP_BRIDGE_CALLBACK",
    CALL_CREATE = "CALL_CREATE",
    CALL_DELETE = "CALL_DELETE",
    CALL_UPDATE = "CALL_UPDATE",
    CHANNEL_CREATE = "CHANNEL_CREATE",
    CHANNEL_DELETE = "CHANNEL_DELETE",
    CHANNEL_UPDATE = "CHANNEL_UPDATE",
    CHANNEL_PINS_ACK = "CHANNEL_PINS_ACK",
    CHANNEL_PINS_UPDATE = "CHANNEL_PINS_UPDATE",
    CHANNEL_RECIPIENT_ADD = "CHANNEL_RECIPIENT_ADD",
    CHANNEL_RECIPIENT_REMOVE = "CHANNEL_RECIPIENT_REMOVE",
    ENTITLEMENT_CREATE = "ENTITLEMENT_CREATE",
    ENTITLEMENT_DELETE = "ENTITLEMENT_DELETE",
    ENTITLEMENT_UPDATE = "ENTITLEMENT_UPDATE",
    FRIEND_SUGGESTION_CREATE = "FRIEND_SUGGESTION_CREATE",
    FRIEND_SUGGESTION_DELETE = "FRIEND_SUGGESTION_DELETE",
    GIFT_CODE_UPDATE = "GIFT_CODE_UPDATE",
    GUILD_APPLICATION_COMMANDS_UPDATE = "GUILD_APPLICATION_COMMANDS_UPDATE",
    GUILD_BAN_ADD = "GUILD_BAN_ADD",
    GUILD_BAN_REMOVE = "GUILD_BAN_REMOVE",
    GUILD_CREATE = "GUILD_CREATE",
    GUILD_DELETE = "GUILD_DELETE",
    GUILD_UPDATE = "GUILD_UPDATE",
    GUILD_EMOJIS_UPDATE = "GUILD_EMOJIS_UPDATE",
    GUILD_INTEGRATIONS_UPDATE = "GUILD_INTEGRATIONS_UPDATE",
    GUILD_MEMBER_ADD = "GUILD_MEMBER_ADD",
    GUILD_MEMBER_LIST_UPDATE = "GUILD_MEMBER_LIST_UPDATE",
    GUILD_MEMBER_REMOVE = "GUILD_MEMBER_REMOVE",
    GUILD_MEMBER_UPDATE = "GUILD_MEMBER_UPDATE",
    GUILD_MEMBERS_CHUNK = "GUILD_MEMBERS_CHUNK",
    GUILD_ROLE_CREATE = "GUILD_ROLE_CREATE",
    GUILD_ROLE_DELETE = "GUILD_ROLE_DELETE",
    GUILD_ROLE_UPDATE = "GUILD_ROLE_UPDATE",
    GUILD_STICKERS_UPDATE = "GUILD_STICKERS_UPDATE",
    INTEGRATION_CREATE = "INTEGRATION_CREATE",
    INTEGRATION_DELETE = "INTEGRATION_DELETE",
    INTEGRATION_UPDATE = "INTEGRATION_UPDATE",
    INTERACTION_CREATE = "INTERACTION_CREATE",
    INVITE_CREATE = "INVITE_CREATE",
    INVITE_DELETE = "INVITE_DELETE",
    LIBRARY_APPLICATION_UPDATE = "LIBRARY_APPLICATION_UPDATE",
    LOBBY_CREATE = "LOBBY_CREATE",
    LOBBY_DELETE = "LOBBY_DELETE",
    LOBBY_UPDATE = "LOBBY_UPDATE",
    LOBBY_MEMBER_CONNECT = "LOBBY_MEMBER_CONNECT",
    LOBBY_MEMBER_DISCONNECT = "LOBBY_MEMBER_DISCONNECT",
    LOBBY_MEMBER_UPDATE = "LOBBY_MEMBER_UPDATE",
    LOBBY_MESSAGE = "LOBBY_MESSAGE",
    LOBBY_VOICE_SERVER_UPDATE = "LOBBY_VOICE_SERVER_UPDATE",
    LOBBY_VOICE_STATE_UPDATE = "LOBBY_VOICE_STATE_UPDATE",
    MESSAGE_ACK = "MESSAGE_ACK",
    MESSAGE_CREATE = "MESSAGE_CREATE",
    MESSAGE_DELETE = "MESSAGE_DELETE",
    MESSAGE_DELETE_BULK = "MESSAGE_DELETE_BULK",
    MESSAGE_REACTION_ADD = "MESSAGE_REACTION_ADD",
    MESSAGE_REACTION_REMOVE = "MESSAGE_REACTION_REMOVE",
    MESSAGE_REACTION_REMOVE_ALL = "MESSAGE_REACTION_REMOVE_ALL",
    MESSAGE_REACTION_REMOVE_EMOJI = "MESSAGE_REACTION_REMOVE_EMOJI",
    MESSAGE_UPDATE = "MESSAGE_UPDATE",
    OAUTH2_TOKEN_REMOVE = "OAUTH2_TOKEN_REMOVE",
    PRESENCES_REPLACE = "PRESENCES_REPLACE",
    PRESENCE_UPDATE = "PRESENCE_UPDATE",
    RECENT_MENTION_DELETE = "RECENT_MENTION_DELETE",
    RELATIONSHIP_ADD = "RELATIONSHIP_ADD",
    RELATIONSHIP_REMOVE = "RELATIONSHIP_REMOVE",
    SESSIONS_REPLACE = "SESSIONS_REPLACE",
    STAGE_INSTANCE_CREATE = "STAGE_INSTANCE_CREATE",
    STAGE_INSTANCE_DELETE = "STAGE_INSTANCE_DELETE",
    STAGE_INSTANCE_UPDATE = "STAGE_INSTANCE_UPDATE",
    STREAM_CREATE = "STREAM_CREATE",
    STREAM_DELETE = "STREAM_DELETE",
    STREAM_SERVER_UPDATE = "STREAM_SERVER_UPDATE",
    STREAM_UPDATE = "STREAM_UPDATE",
    THREAD_CREATE = "THREAD_CREATE",
    THREAD_DELETE = "THREAD_DELETE",
    THREAD_LIST_SYNC = "THREAD_LIST_SYNC",
    THREAD_MEMBER_UPDATE = "THREAD_MEMBER_UPDATE",
    THREAD_MEMBERS_UPDATE = "THREAD_MEMBERS_UPDATE",
    THREAD_UPDATE = "THREAD_UPDATE",
    TYPING_START = "TYPING_START",
    USER_ACHIEVEMENT_UPDATE = "USER_ACHIEVEMENT_UPDATE",
    USER_CONNECTIONS_UPDATE = "USER_CONNECTIONS_UPDATE",
    USER_FEED_SETTINGS_UPDATE = "USER_FEED_SETTINGS_UPDATE",
    USER_GUILD_SETTINGS_UPDATE = "USER_GUILD_SETTINGS_UPDATE",
    USER_NOTE_UPDATE = "USER_NOTE_UPDATE",
    USER_PAYMENT_SOURCES_UPDATE = "USER_PAYMENT_SOURCES_UPDATE",
    USER_PAYMENTS_UPDATE = "USER_PAYMENTS_UPDATE",
    USER_PREMIUM_GUILD_SUBSCRIPTION_SLOT_CREATE = "USER_PREMIUM_GUILD_SUBSCRIPTION_SLOT_CREATE",
    USER_PREMIUM_GUILD_SUBSCRIPTION_SLOT_UPDATE = "USER_PREMIUM_GUILD_SUBSCRIPTION_SLOT_UPDATE",
    USER_REQUIRED_ACTION_UPDATE = "USER_REQUIRED_ACTION_UPDATE",
    USER_SETTINGS_UPDATE = "USER_SETTINGS_UPDATE",
    USER_SUBSCRIPTIONS_UPDATE = "USER_SUBSCRIPTIONS_UPDATE",
    USER_STICKER_PACK_UPDATE = "USER_STICKER_PACK_UPDATE",
    USER_UPDATE = "USER_UPDATE",
    VOICE_SERVER_UPDATE = "VOICE_SERVER_UPDATE",
    VOICE_STATE_UPDATE = "VOICE_STATE_UPDATE",
    WEBHOOKS_UPDATE = "WEBHOOKS_UPDATE"
}
export declare enum GatewayIntents {
    GUILDS = 1,
    GUILD_MEMBERS = 2,
    GUILD_BANS = 4,
    GUILD_EMOJIS = 8,
    GUILD_INTEGRATIONS = 16,
    GUILD_WEBHOOKS = 32,
    GUILD_INVITES = 64,
    GUILD_VOICE_STATES = 128,
    GUILD_PRESENCES = 256,
    GUILD_MESSAGES = 512,
    GUILD_MESSAGE_REACTIONS = 1024,
    GUILD_MESSAGE_TYPING = 2048,
    DIRECT_MESSAGES = 4096,
    DIRECT_MESSAGE_REACTIONS = 8192,
    DIRECT_MESSAGE_TYPING = 16384
}
export declare const GATEWAY_INTENTS_ALL: GatewayIntents;
export declare const GATEWAY_INTENTS_ALL_UNPRIVILEGED: GatewayIntents;
export declare const GATEWAY_INTENTS_ALL_DIRECT_MESSAGES: GatewayIntents;
export declare const GATEWAY_INTENTS_ALL_GUILD: GatewayIntents;
export declare enum GatewayOpCodes {
    DISPATCH = 0,
    HEARTBEAT = 1,
    IDENTIFY = 2,
    PRESENCE_UPDATE = 3,
    VOICE_STATE_UPDATE = 4,
    VOICE_SERVER_PING = 5,
    RESUME = 6,
    RECONNECT = 7,
    REQUEST_GUILD_MEMBERS = 8,
    INVALID_SESSION = 9,
    HELLO = 10,
    HEARTBEAT_ACK = 11,
    SYNC_GUILD = 12,
    CALL_CONNECT = 13,
    GUILD_SUBSCRIPTIONS = 14,
    LOBBY_CONNECT = 15,
    LOBBY_DISCONNECT = 16,
    LOBBY_VOICE_STATES_UPDATE = 17,
    STREAM_CREATE = 18,
    STREAM_DELETE = 19,
    STREAM_WATCH = 20,
    STREAM_PING = 21,
    STREAM_SET_PAUSED = 22,
    REQUEST_APPLICATION_COMMANDS = 24
}
export declare enum GatewayPresenceStatuses {
    ONLINE = "online",
    DND = "dnd",
    IDLE = "idle",
    INVISIBLE = "invisible",
    OFFLINE = "offline"
}
export declare const MaxNumbers: Readonly<{
    UINT8: number;
    UINT16: number;
    UINT32: number;
}>;
export declare enum MediaCodecTypes {
    AUDIO = "audio",
    VIDEO = "video"
}
export declare enum MediaCodecs {
    OPUS = "opus",
    H264 = "H264",
    VP8 = "VP8",
    VP9 = "VP9",
    RTX = "rtx"
}
export declare const MEDIA_CODECS_AUDIO: MediaCodecs[];
export declare const MEDIA_CODECS_VIDEO: MediaCodecs[];
export declare enum MediaEncryptionModes {
    AEAD_AES256_GCM = "aead_aes256_gcm",
    AEAD_AES256_GCM_RTPSIZE = "aead_aes256_gcm_rtpsize",
    XSALSA20_POLY1305 = "xsalsa20_poly1305",
    XSALSA20_POLY1305_LITE = "xsalsa20_poly1305_lite",
    XSALSA20_POLY1305_LITE_RTPSIZE = "xsalsa20_poly1305_lite_rtpsize",
    XSALSA20_POLY1305_SUFFIX = "xsalsa20_poly1305_suffix"
}
export declare const MEDIA_ENCRYPTION_MODES: readonly MediaEncryptionModes[];
export declare enum MediaOpCodes {
    IDENTIFY = 0,
    SELECT_PROTOCOL = 1,
    READY = 2,
    HEARTBEAT = 3,
    SELECT_PROTOCOL_ACK = 4,
    SPEAKING = 5,
    HEARTBEAT_ACK = 6,
    RESUME = 7,
    HELLO = 8,
    RESUMED = 9,
    SIGNAL = 10,
    CLIENT_CONNECT = 12,
    CLIENT_DISCONNECT = 13,
    SESSION_UPDATE = 14,
    VIDEO_SINK_WANTS = 15
}
export declare enum MediaProtocols {
    UDP = "udp",
    WEBRTC = "webrtc"
}
export declare const MEDIA_PROTOCOLS: readonly MediaProtocols[];
export declare const MediaReceivedVideoQuality: Readonly<{
    OFF: string;
    FULL: string;
}>;
export declare const MediaSilencePacket: number[];
export declare enum MediaSpeakingFlags {
    NONE = 0,
    VOICE = 1,
    SOUNDSHARE = 2,
    PRIORITY = 4
}
export declare enum MediaSSRCTypes {
    AUDIO = "audio",
    VIDEO = "video"
}
export declare enum SocketEvents {
    CLOSE = "close",
    KILLED = "killed",
    LOG = "log",
    OPEN = "open",
    PACKET = "packet",
    READY = "ready",
    RECONNECTING = "reconnecting",
    SOCKET = "socket",
    STATE = "state",
    TRANSPORT = "transport",
    TRANSPORT_READY = "transportReady",
    WARN = "warn"
}
export declare enum SocketEventsBase {
    CLOSE = "close",
    ERROR = "error",
    MESSAGE = "message",
    OPEN = "open",
    PING = "ping",
    PONG = "pong"
}
export declare enum SocketCloseCodes {
    NORMAL = 1000,
    GOING_AWAY = 1001,
    PROTOCOL_ERROR = 1002,
    UNSUPPORTED_DATA = 1003,
    ABNORMAL_CLOSURE = 1006,
    INVALID_FRAME = 1007,
    POLICY_VIOLATION = 1008,
    MESSAGE_TOO_BIG = 1009,
    MISSING_EXTENSION = 1010,
    INTERNAL_ERROR = 1011,
    SERVICE_RESTART = 1012,
    TRY_AGAIN_LATER = 1013,
    BAD_GATEWAY = 1014
}
export declare enum SocketInternalCloseCodes {
    CONNECTION_ERROR = -1,
    INVALID_DATA = 4800,
    RECONNECTING = 4801,
    HEARTBEAT_ACK = 4802,
    HEARTBEAT_ACK_NONCE = 4803,
    OTHER_SOCKET_MESSAGE = 4804,
    OTHER_SOCKET_OPEN = 4805
}
export declare const SocketInternalCloseReasons: Readonly<{
    [-1]: string;
    4800: string;
    4801: string;
    4802: string;
    4803: string;
    4804: string;
    4805: string;
}>;
export declare enum SocketGatewayCloseCodes {
    UNKNOWN_ERROR = 4000,
    UNKNOWN_OPCODE = 4001,
    DECODE_ERROR = 4002,
    NOT_AUTHENTICATED = 4003,
    AUTHENTICATION_FAILED = 4004,
    ALREADY_AUTHENTICATED = 4005,
    INVALID_SEQUENCE = 4007,
    RATE_LIMITED = 4008,
    SESSION_TIMEOUT = 4009,
    INVALID_SHARD = 4010,
    SHARDING_REQUIRED = 4011,
    INVALID_VERSION = 4012,
    INVALID_INTENTS = 4013,
    DISALLOWED_INTENTS = 4014
}
export declare enum SocketMediaCloseCodes {
    UNKNOWN_ERROR = 4000,
    UNKNOWN_OPCODE = 4001,
    DECODE_ERROR = 4002,
    NOT_AUTHENTICATED = 4003,
    AUTHENTICATION_FAILED = 4004,
    ALREADY_AUTHENTICATED = 4005,
    SESSION_NO_LONGER_VALID = 4006,
    SESSION_TIMEOUT = 4009,
    SERVER_NOT_FOUND = 4011,
    UNKNOWN_PROTOCOL = 4012,
    DISCONNECTED = 4014,
    VOICE_SERVER_CRASHED = 4015,
    UNKNOWN_ENCRYPTION_MODE = 4016
}
export declare enum SocketStates {
    CLOSED = "CLOSED",
    CONNECTING = "CONNECTING",
    IDENTIFYING = "IDENTIFYING",
    OPEN = "OPEN",
    READY = "READY",
    RESUMING = "RESUMING"
}
export declare const RTP_HEADER_VERSION = 128;
export declare enum RTPPayloadTypes {
    OPUS = 120,
    VP8 = 101,
    VP9 = 103,
    H264 = 105
}
export declare const RTP_PAYLOAD_TYPES: readonly (string | RTPPayloadTypes)[];
export declare const RTCP_HEADER_VERSION = 128;
export declare enum RTCPPacketTypes {
    SENDER_REPORT = 200,
    RECEIVER_REPORT = 201,
    SOURCE_DESCRIPTION = 202,
    BYE = 203,
    APP = 204,
    RTPFB = 205,
    PSFB = 206
}
export declare const RTCP_PACKET_TYPES: readonly (string | RTCPPacketTypes)[];
export declare const RTPHeaderExtensionOneByte: Readonly<{
    HEADER: number[];
    LOCAL_IDENTIFER: number;
}>;
export declare const RTPHeaderExtensionTwoByte: Readonly<{
    HEADER: number[];
}>;
export declare const ZLIB_SUFFIX: number[];