@discordeno/gateway 19.0.0-next.fe00a6f → 19.0.0-next.ffdef6c
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -13
- package/dist/cjs/Shard.cjs +649 -0
- package/dist/cjs/index.cjs +22 -0
- package/dist/cjs/manager.cjs +503 -0
- package/dist/cjs/types.cjs +64 -0
- package/dist/esm/Shard.js +585 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/manager.js +488 -0
- package/dist/esm/types.js +43 -0
- package/dist/{Shard.d.ts → types/Shard.d.ts} +43 -95
- package/dist/types/Shard.d.ts.map +1 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/{manager.d.ts → types/manager.d.ts} +111 -12
- package/dist/types/manager.d.ts.map +1 -0
- package/dist/{types.d.ts → types/types.d.ts} +39 -5
- package/dist/types/types.d.ts.map +1 -0
- package/package.json +35 -28
- package/dist/Shard.d.ts.map +0 -1
- package/dist/Shard.js +0 -615
- package/dist/Shard.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -5
- package/dist/index.js.map +0 -1
- package/dist/manager.d.ts.map +0 -1
- package/dist/manager.js +0 -243
- package/dist/manager.js.map +0 -1
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -23
- package/dist/types.js.map +0 -1
- /package/dist/{index.d.ts → types/index.d.ts} +0 -0
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
export var ShardState = /*#__PURE__*/ function(ShardState) {
|
|
2
|
+
/** Shard is fully connected to the gateway and receiving events from Discord. */ ShardState[ShardState["Connected"] = 0] = "Connected";
|
|
3
|
+
/** Shard started to connect to the gateway. This is only used if the shard is not currently trying to identify or resume. */ ShardState[ShardState["Connecting"] = 1] = "Connecting";
|
|
4
|
+
/** Shard got disconnected and reconnection actions have been started. */ ShardState[ShardState["Disconnected"] = 2] = "Disconnected";
|
|
5
|
+
/** The shard is connected to the gateway but only heartbeating. At this state the shard has not been identified with discord. */ ShardState[ShardState["Unidentified"] = 3] = "Unidentified";
|
|
6
|
+
/** Shard is trying to identify with the gateway to create a new session. */ ShardState[ShardState["Identifying"] = 4] = "Identifying";
|
|
7
|
+
/** Shard is trying to resume a session with the gateway. */ ShardState[ShardState["Resuming"] = 5] = "Resuming";
|
|
8
|
+
/** Shard got shut down studied or due to a not (self) fixable error and may not attempt to reconnect on its own. */ ShardState[ShardState["Offline"] = 6] = "Offline";
|
|
9
|
+
return ShardState;
|
|
10
|
+
}({});
|
|
11
|
+
export var TransportCompression = /*#__PURE__*/ function(TransportCompression) {
|
|
12
|
+
/**
|
|
13
|
+
* ZLib-Stream Transport Compression.
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* Uses `node:zlib` to decompress the payloads
|
|
17
|
+
*
|
|
18
|
+
* @see https://discord.com/developers/docs/topics/gateway#zlibstream
|
|
19
|
+
*/ TransportCompression["zlib"] = "zlib-stream";
|
|
20
|
+
/**
|
|
21
|
+
* ZStd-Stream Transport Compression.
|
|
22
|
+
*
|
|
23
|
+
* @remarks
|
|
24
|
+
* Uses `fzstd` to decompress the payloads. `fzstd` is an optional dependency, it is required to be installed for this compression.
|
|
25
|
+
*
|
|
26
|
+
* @see https://discord.com/developers/docs/topics/gateway#zstdstream
|
|
27
|
+
*/ TransportCompression["zstd"] = "zstd-stream";
|
|
28
|
+
return TransportCompression;
|
|
29
|
+
}({});
|
|
30
|
+
export var ShardSocketCloseCodes = /*#__PURE__*/ function(ShardSocketCloseCodes) {
|
|
31
|
+
/** A regular Shard shutdown. */ ShardSocketCloseCodes[ShardSocketCloseCodes["Shutdown"] = 3000] = "Shutdown";
|
|
32
|
+
/** A resume has been requested and therefore the old connection needs to be closed. */ ShardSocketCloseCodes[ShardSocketCloseCodes["ResumeClosingOldConnection"] = 3024] = "ResumeClosingOldConnection";
|
|
33
|
+
/**
|
|
34
|
+
* Did not receive a heartbeat ACK in time.
|
|
35
|
+
* Closing the shard and creating a new session.
|
|
36
|
+
*/ ShardSocketCloseCodes[ShardSocketCloseCodes["ZombiedConnection"] = 3010] = "ZombiedConnection";
|
|
37
|
+
/** Discordeno's gateway tests hae been finished, therefore the Shard can be turned off. */ ShardSocketCloseCodes[ShardSocketCloseCodes["TestingFinished"] = 3064] = "TestingFinished";
|
|
38
|
+
/** Special close code reserved for Discordeno's zero-downtime resharding system. */ ShardSocketCloseCodes[ShardSocketCloseCodes["Resharded"] = 3065] = "Resharded";
|
|
39
|
+
/** Shard is re-identifying therefore the old connection needs to be closed. */ ShardSocketCloseCodes[ShardSocketCloseCodes["ReIdentifying"] = 3066] = "ReIdentifying";
|
|
40
|
+
return ShardSocketCloseCodes;
|
|
41
|
+
}({});
|
|
42
|
+
|
|
43
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { ActivityTypes, Camelize, DiscordActivity, DiscordGatewayPayload, GatewayOpcodes, PresenceStatus } from '@discordeno/types'\nimport type Shard from './Shard.js'\n\nexport enum ShardState {\n  /** Shard is fully connected to the gateway and receiving events from Discord. */\n  Connected = 0,\n  /** Shard started to connect to the gateway. This is only used if the shard is not currently trying to identify or resume. */\n  Connecting = 1,\n  /** Shard got disconnected and reconnection actions have been started. */\n  Disconnected = 2,\n  /** The shard is connected to the gateway but only heartbeating. At this state the shard has not been identified with discord. */\n  Unidentified = 3,\n  /** Shard is trying to identify with the gateway to create a new session. */\n  Identifying = 4,\n  /** Shard is trying to resume a session with the gateway. */\n  Resuming = 5,\n  /** Shard got shut down studied or due to a not (self) fixable error and may not attempt to reconnect on its own. */\n  Offline = 6,\n}\n\nexport enum TransportCompression {\n  /**\n   * ZLib-Stream Transport Compression.\n   *\n   * @remarks\n   * Uses `node:zlib` to decompress the payloads\n   *\n   * @see https://discord.com/developers/docs/topics/gateway#zlibstream\n   */\n  zlib = 'zlib-stream',\n  /**\n   * ZStd-Stream Transport Compression.\n   *\n   * @remarks\n   * Uses `fzstd` to decompress the payloads. `fzstd` is an optional dependency, it is required to be installed for this compression.\n   *\n   * @see https://discord.com/developers/docs/topics/gateway#zstdstream\n   */\n  zstd = 'zstd-stream',\n}\n\nexport interface ShardGatewayConfig {\n  /**\n   * Whatever to enable Payload compression.\n   *\n   * @remarks\n   * This is compatible with {@link transportCompression}\n   *\n   * @default false\n   *\n   * @see https://discord.com/developers/docs/topics/gateway#payload-compression\n   */\n  compress: boolean\n  /**\n   * What Transport Compression should be use\n   *\n   * @default null\n   *\n   * @see https://discord.com/developers/docs/topics/gateway#transport-compression\n   */\n  transportCompression: TransportCompression | null\n  /** The calculated intent value of the events which the shard should receive.\n   *\n   * @default 0\n   */\n  intents: number\n  /** Identify properties to use */\n  properties: {\n    /** Operating system the shard runs on.\n     *\n     * @default \"darwin\" | \"linux\" | \"windows\"\n     */\n    os: string\n    /** The \"browser\" where this shard is running on.\n     *\n     * @default \"Discordeno\"\n     */\n    browser: string\n    /** The device on which the shard is running.\n     *\n     * @default \"Discordeno\"\n     */\n    device: string\n  }\n  /** Bot token which is used to connect to Discord */\n  token: string\n  /** The URL of the gateway which should be connected to.\n   *\n   * @default \"wss://gateway.discord.gg\"\n   */\n  url: string\n  /** The gateway version which should be used.\n   *\n   * @default 10\n   */\n  version: number\n  /**\n   * The total number of shards to connect to across the entire bot.\n   * @default 1\n   */\n  totalShards: number\n}\n\nexport interface ShardHeart {\n  /** Whether or not the heartbeat was acknowledged by Discord in time. */\n  acknowledged: boolean\n  /** Interval between heartbeats requested by Discord. */\n  interval: number\n  /** Id of the interval, which is used for sending the heartbeats. */\n  intervalId?: NodeJS.Timeout\n  /** Unix (in milliseconds) timestamp when the last heartbeat ACK was received from Discord. */\n  lastAck?: number\n  /** Unix timestamp (in milliseconds) when the last heartbeat was sent. */\n  lastBeat?: number\n  /** Round trip time (in milliseconds) from Shard to Discord and back.\n   * Calculated using the heartbeat system.\n   * Note: this value is undefined until the first heartbeat to Discord has happened.\n   */\n  rtt?: number\n  /** Id of the timeout which is used for sending the first heartbeat to Discord since it's \"special\". */\n  timeoutId?: NodeJS.Timeout\n}\n\nexport interface ShardEvents {\n  /** A heartbeat has been send. */\n  heartbeat?: (shard: Shard) => unknown\n  /** A heartbeat ACK was received. */\n  heartbeatAck?: (shard: Shard) => unknown\n  /** Shard has received a Hello payload. */\n  hello?: (shard: Shard) => unknown\n  /** The Shards session has been invalidated. */\n  invalidSession?: (shard: Shard, resumable: boolean) => unknown\n  /** The shard has started a resume action. */\n  resuming?: (shard: Shard) => unknown\n  /** The shard has successfully resumed an old session. */\n  resumed?: (shard: Shard) => unknown\n  /** Discord has requested the Shard to reconnect. */\n  requestedReconnect?: (shard: Shard) => unknown\n  /** The shard started to connect to Discord's gateway. */\n  connecting?: (shard: Shard) => unknown\n  /** The shard is connected with Discord's gateway. */\n  connected?: (shard: Shard) => unknown\n  /** The shard has been disconnected from Discord's gateway. */\n  disconnected?: (shard: Shard) => unknown\n  /** The shard has started to identify itself to Discord. */\n  identifying?: (shard: Shard) => unknown\n  /** The shard has successfully been identified itself with Discord. */\n  identified?: (shard: Shard) => unknown\n  /** The shard has received a message from Discord. */\n  message?: (shard: Shard, payload: Camelize<DiscordGatewayPayload>) => unknown\n}\n\nexport enum ShardSocketCloseCodes {\n  /** A regular Shard shutdown. */\n  Shutdown = 3000,\n  /** A resume has been requested and therefore the old connection needs to be closed. */\n  ResumeClosingOldConnection = 3024,\n  /**\n   * Did not receive a heartbeat ACK in time.\n   * Closing the shard and creating a new session.\n   */\n  ZombiedConnection = 3010,\n  /** Discordeno's gateway tests hae been finished, therefore the Shard can be turned off. */\n  TestingFinished = 3064,\n  /** Special close code reserved for Discordeno's zero-downtime resharding system. */\n  Resharded = 3065,\n  /** Shard is re-identifying therefore the old connection needs to be closed. */\n  ReIdentifying = 3066,\n}\n\nexport interface ShardSocketRequest {\n  /** The OP-Code for the payload to send. */\n  op: GatewayOpcodes\n  /** Payload data. */\n  d: unknown\n}\n\n/** https://discord.com/developers/docs/topics/gateway-events#update-presence */\nexport interface BotStatusUpdate {\n  // /** Unix time (in milliseconds) of when the client went idle, or null if the client is not idle */\n  since: number | null\n  /** The user's activities */\n  activities: BotActivity[]\n  /** The user's new status */\n  status: keyof typeof PresenceStatus\n}\n\n/** https://discord.com/developers/docs/topics/gateway-events#activity-object */\nexport interface BotActivity {\n  name: string\n  type: ActivityTypes\n  url?: string\n}\n\n/** https://discord.com/developers/docs/topics/gateway#update-voice-state */\nexport interface UpdateVoiceState {\n  /** id of the guild */\n  guildId: string\n  /** id of the voice channel client wants to join (null if disconnecting) */\n  channelId: string | null\n  /** Is the client muted */\n  selfMute: boolean\n  /** Is the client deafened */\n  selfDeaf: boolean\n}\n\n/** https://discord.com/developers/docs/topics/gateway-events#update-presence */\nexport interface StatusUpdate {\n  // /** Unix time (in milliseconds) of when the client went idle, or null if the client is not idle */\n  // since: number | null;\n  /** The user's activities */\n  activities?: Camelize<Omit<DiscordActivity, 'created_at'>[]>\n  /** The user's new status */\n  status: keyof typeof PresenceStatus\n  // /** Whether or not the client is afk */\n  // afk: boolean;\n}\n"],"names":["ShardState","TransportCompression","ShardSocketCloseCodes"],"mappings":"AAGA,OAAO,IAAA,AAAKA,oCAAAA;IACV,+EAA+E;IAE/E,2HAA2H;IAE3H,uEAAuE;IAEvE,+HAA+H;IAE/H,0EAA0E;IAE1E,0DAA0D;IAE1D,kHAAkH;WAbxGA;MAeX;AAED,OAAO,IAAA,AAAKC,8CAAAA;IACV;;;;;;;GAOC;IAED;;;;;;;GAOC;WAjBSA;MAmBX;AAiHD,OAAO,IAAA,AAAKC,+CAAAA;IACV,8BAA8B;IAE9B,qFAAqF;IAErF;;;GAGC;IAED,yFAAyF;IAEzF,kFAAkF;IAElF,6EAA6E;WAdnEA;MAgBX"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import
|
|
2
|
-
import {
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import type {
|
|
6
|
-
import { ShardState } from './types.js';
|
|
1
|
+
import { Buffer } from 'node:buffer';
|
|
2
|
+
import { type Inflate } from 'node:zlib';
|
|
3
|
+
import type { DiscordGatewayPayload } from '@discordeno/types';
|
|
4
|
+
import { LeakyBucket, logger } from '@discordeno/utils';
|
|
5
|
+
import type { Decompress as ZstdDecompress } from 'fzstd';
|
|
6
|
+
import { type BotStatusUpdate, type ShardEvents, type ShardGatewayConfig, type ShardHeart, type ShardSocketRequest, ShardState } from './types.js';
|
|
7
7
|
export declare class DiscordenoShard {
|
|
8
8
|
/** The id of the shard */
|
|
9
9
|
id: number;
|
|
@@ -20,7 +20,7 @@ export declare class DiscordenoShard {
|
|
|
20
20
|
/** Current session id of the shard if present. */
|
|
21
21
|
sessionId?: string;
|
|
22
22
|
/** This contains the WebSocket connection to Discord, if currently connected. */
|
|
23
|
-
socket?:
|
|
23
|
+
socket?: WebSocket;
|
|
24
24
|
/** Current internal state of the this. */
|
|
25
25
|
state: ShardState;
|
|
26
26
|
/** The url provided by discord to use when resuming a connection for this this. */
|
|
@@ -28,27 +28,27 @@ export declare class DiscordenoShard {
|
|
|
28
28
|
/** The shard related event handlers. */
|
|
29
29
|
events: ShardEvents;
|
|
30
30
|
/** Cache for pending gateway requests which should have been send while the gateway went offline. */
|
|
31
|
-
offlineSendQueue:
|
|
31
|
+
offlineSendQueue: (() => void)[];
|
|
32
32
|
/** Resolve internal waiting states. Mapped by SelectedEvents => ResolveFunction */
|
|
33
33
|
resolves: Map<"READY" | "RESUMED" | "INVALID_SESSION", (payload: DiscordGatewayPayload) => void>;
|
|
34
34
|
/** Shard bucket. Only access this if you know what you are doing. Bucket for handling shard request rate limits. */
|
|
35
35
|
bucket: LeakyBucket;
|
|
36
|
-
/**
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
36
|
+
/** Logger for the bucket */
|
|
37
|
+
logger: Pick<typeof logger, 'debug' | 'info' | 'warn' | 'error' | 'fatal'>;
|
|
38
|
+
/** Text decoder used for compressed payloads */
|
|
39
|
+
textDecoder: TextDecoder;
|
|
40
|
+
/** ZLib Inflate instance for ZLib-stream transport payloads */
|
|
41
|
+
inflate?: Inflate;
|
|
42
|
+
/** ZLib inflate buffer */
|
|
43
|
+
inflateBuffer: Uint8Array | null;
|
|
44
|
+
/** ZStd Decompress instance for ZStd-stream transport payloads */
|
|
45
|
+
zstdDecompress?: ZstdDecompress;
|
|
46
|
+
/** Queue for compressed payloads for Zstd Decompress */
|
|
47
|
+
decompressionPromisesQueue: ((data: DiscordGatewayPayload) => void)[];
|
|
48
48
|
constructor(options: ShardCreateOptions);
|
|
49
49
|
/** The gateway configuration which is used to connect to Discord. */
|
|
50
50
|
get gatewayConfig(): ShardGatewayConfig;
|
|
51
|
-
/** The url to connect to.
|
|
51
|
+
/** The url to connect to. Initially this is the discord gateway url, and then is switched to resume gateway url once a READY is received. */
|
|
52
52
|
get connectionUrl(): string;
|
|
53
53
|
/** Calculate the amount of requests which can safely be made per rate limit interval, before the gateway gets disconnected due to an exceeded rate limit. */
|
|
54
54
|
calculateSafeRequests(): number;
|
|
@@ -63,26 +63,38 @@ export declare class DiscordenoShard {
|
|
|
63
63
|
isOpen(): boolean;
|
|
64
64
|
/** Attempt to resume the previous shards session with the gateway. */
|
|
65
65
|
resume(): Promise<void>;
|
|
66
|
-
/**
|
|
67
|
-
*
|
|
66
|
+
/**
|
|
67
|
+
* Send a message to Discord.
|
|
68
|
+
* @param highPriority - Whether this message should be send asap.
|
|
68
69
|
*/
|
|
69
70
|
send(message: ShardSocketRequest, highPriority?: boolean): Promise<void>;
|
|
70
71
|
/** Shutdown the this. Forcefully disconnect the shard from Discord. The shard may not attempt to reconnect with Discord. */
|
|
71
72
|
shutdown(): Promise<void>;
|
|
73
|
+
/** Handle a gateway connection error */
|
|
74
|
+
handleError(error: Event): void;
|
|
72
75
|
/** Handle a gateway connection close. */
|
|
73
|
-
handleClose(close:
|
|
76
|
+
handleClose(close: CloseEvent): Promise<void>;
|
|
77
|
+
/** Handle an incoming gateway message. */
|
|
78
|
+
handleMessage(message: MessageEvent): Promise<void>;
|
|
79
|
+
/**
|
|
80
|
+
* Decompress a zlib/zstd compressed packet
|
|
81
|
+
*
|
|
82
|
+
* @private
|
|
83
|
+
*/
|
|
84
|
+
decompressPacket(data: ArrayBuffer | Buffer): Promise<DiscordGatewayPayload | null>;
|
|
74
85
|
/** Handles a incoming gateway packet. */
|
|
75
86
|
handleDiscordPacket(packet: DiscordGatewayPayload): Promise<void>;
|
|
76
87
|
forwardToBot(packet: DiscordGatewayPayload): void;
|
|
77
|
-
/** Handle an incoming gateway message. */
|
|
78
|
-
handleMessage(message: NodeWebSocket.MessageEvent): Promise<void>;
|
|
79
88
|
/**
|
|
80
89
|
* Override in order to make the shards presence.
|
|
81
90
|
* async in case devs create the presence based on eg. database values.
|
|
82
91
|
* Passing the shard's id there to make it easier for the dev to use this function.
|
|
83
92
|
*/
|
|
84
93
|
makePresence(): Promise<BotStatusUpdate | undefined>;
|
|
85
|
-
/**
|
|
94
|
+
/**
|
|
95
|
+
* This function communicates with the management process, in order to know whether its free to identify.
|
|
96
|
+
* When this function resolves, this means that the shard is allowed to send an identify payload to discord.
|
|
97
|
+
*/
|
|
86
98
|
requestIdentify(): Promise<void>;
|
|
87
99
|
/** This function communicates with the management process, in order to tell it can identify the next shard. */
|
|
88
100
|
shardIsReady(): Promise<void>;
|
|
@@ -90,74 +102,6 @@ export declare class DiscordenoShard {
|
|
|
90
102
|
startHeartbeating(interval: number): void;
|
|
91
103
|
/** Stop the heartbeating process with discord. */
|
|
92
104
|
stopHeartbeating(): void;
|
|
93
|
-
/**
|
|
94
|
-
* Connects the bot user to a voice or stage channel.
|
|
95
|
-
*
|
|
96
|
-
* This function sends the _Update Voice State_ gateway command over the gateway behind the scenes.
|
|
97
|
-
*
|
|
98
|
-
* @param guildId - The ID of the guild the voice channel to leave is in.
|
|
99
|
-
* @param channelId - The ID of the channel you want to join.
|
|
100
|
-
*
|
|
101
|
-
* @remarks
|
|
102
|
-
* Requires the `CONNECT` permission.
|
|
103
|
-
*
|
|
104
|
-
* Fires a _Voice State Update_ gateway event.
|
|
105
|
-
*
|
|
106
|
-
* @see {@link https://discord.com/developers/docs/topics/gateway#update-voice-state}
|
|
107
|
-
*/
|
|
108
|
-
joinVoiceChannel(guildId: BigString, channelId: BigString, options?: AtLeastOne<Omit<UpdateVoiceState, 'guildId' | 'channelId'>>): Promise<void>;
|
|
109
|
-
/**
|
|
110
|
-
* Edits the bot status in all shards that this gateway manages.
|
|
111
|
-
*
|
|
112
|
-
* @param data The status data to set the bots status to.
|
|
113
|
-
* @returns Promise<void>
|
|
114
|
-
*/
|
|
115
|
-
editBotStatus(data: StatusUpdate): Promise<void>;
|
|
116
|
-
/**
|
|
117
|
-
* Edits the bot's status on one shard.
|
|
118
|
-
*
|
|
119
|
-
* @param shardId The shard id to edit the status for.
|
|
120
|
-
* @param data The status data to set the bots status to.
|
|
121
|
-
* @returns Promise<void>
|
|
122
|
-
*/
|
|
123
|
-
editShardStatus(data: StatusUpdate): Promise<void>;
|
|
124
|
-
/**
|
|
125
|
-
* Fetches the list of members for a guild over the gateway.
|
|
126
|
-
*
|
|
127
|
-
* @param guildId - The ID of the guild to get the list of members for.
|
|
128
|
-
* @param options - The parameters for the fetching of the members.
|
|
129
|
-
*
|
|
130
|
-
* @remarks
|
|
131
|
-
* If requesting the entire member list:
|
|
132
|
-
* - Requires the `GUILD_MEMBERS` intent.
|
|
133
|
-
*
|
|
134
|
-
* If requesting presences ({@link RequestGuildMembers.presences | presences} set to `true`):
|
|
135
|
-
* - Requires the `GUILD_PRESENCES` intent.
|
|
136
|
-
*
|
|
137
|
-
* If requesting a prefix ({@link RequestGuildMembers.query | query} non-`undefined`):
|
|
138
|
-
* - Returns a maximum of 100 members.
|
|
139
|
-
*
|
|
140
|
-
* If requesting a users by ID ({@link RequestGuildMembers.userIds | userIds} non-`undefined`):
|
|
141
|
-
* - Returns a maximum of 100 members.
|
|
142
|
-
*
|
|
143
|
-
* Fires a _Guild Members Chunk_ gateway event for every 1000 members fetched.
|
|
144
|
-
*
|
|
145
|
-
* @see {@link https://discord.com/developers/docs/topics/gateway#request-guild-members}
|
|
146
|
-
*/
|
|
147
|
-
requestMembers(guildId: BigString, options?: Omit<RequestGuildMembers, 'guildId'>): Promise<Camelize<DiscordMember[]>>;
|
|
148
|
-
/**
|
|
149
|
-
* Leaves the voice channel the bot user is currently in.
|
|
150
|
-
*
|
|
151
|
-
* This function sends the _Update Voice State_ gateway command over the gateway behind the scenes.
|
|
152
|
-
*
|
|
153
|
-
* @param guildId - The ID of the guild the voice channel to leave is in.
|
|
154
|
-
*
|
|
155
|
-
* @remarks
|
|
156
|
-
* Fires a _Voice State Update_ gateway event.
|
|
157
|
-
*
|
|
158
|
-
* @see {@link https://discord.com/developers/docs/topics/gateway#update-voice-state}
|
|
159
|
-
*/
|
|
160
|
-
leaveVoiceChannel(guildId: BigString): Promise<void>;
|
|
161
105
|
}
|
|
162
106
|
export interface ShardCreateOptions {
|
|
163
107
|
/** The shard id */
|
|
@@ -166,10 +110,14 @@ export interface ShardCreateOptions {
|
|
|
166
110
|
connection: ShardGatewayConfig;
|
|
167
111
|
/** The event handlers for events on the shard. */
|
|
168
112
|
events: ShardEvents;
|
|
113
|
+
/** The logger for the shard */
|
|
114
|
+
logger?: Pick<typeof logger, 'debug' | 'info' | 'warn' | 'error' | 'fatal'>;
|
|
169
115
|
/** The handler to request a space to make an identify request. */
|
|
170
116
|
requestIdentify?: () => Promise<void>;
|
|
171
117
|
/** The handler to alert the gateway manager that this shard has received a READY event. */
|
|
172
118
|
shardIsReady?: () => Promise<void>;
|
|
119
|
+
/** Function to create the bot status to send on Identify requests */
|
|
120
|
+
makePresence?: () => Promise<BotStatusUpdate | undefined>;
|
|
173
121
|
}
|
|
174
122
|
export default DiscordenoShard;
|
|
175
123
|
//# sourceMappingURL=Shard.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Shard.d.ts","sourceRoot":"","sources":["../../src/Shard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,KAAK,OAAO,EAA0D,MAAM,WAAW,CAAA;AAChG,OAAO,KAAK,EAAE,qBAAqB,EAA8B,MAAM,mBAAmB,CAAA;AAE1F,OAAO,EAAE,WAAW,EAAmB,MAAM,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,OAAO,CAAA;AAEzD,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,UAAU,EAEf,KAAK,kBAAkB,EACvB,UAAU,EAEX,MAAM,YAAY,CAAA;AAWnB,qBAAa,eAAe;IAC1B,0BAA0B;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,qFAAqF;IACrF,UAAU,EAAE,kBAAkB,CAAA;IAC9B,kDAAkD;IAClD,KAAK,EAAE,UAAU,CAAA;IACjB,4HAA4H;IAC5H,2BAA2B,EAAE,MAAM,CAAM;IACzC,4CAA4C;IAC5C,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAO;IAC5C,8EAA8E;IAC9E,sBAAsB,EAAE,MAAM,CAAQ;IACtC,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iFAAiF;IACjF,MAAM,CAAC,EAAE,SAAS,CAAA;IAClB,0CAA0C;IAC1C,KAAK,aAAqB;IAC1B,mFAAmF;IACnF,gBAAgB,EAAE,MAAM,CAAK;IAC7B,wCAAwC;IACxC,MAAM,EAAE,WAAW,CAAK;IACxB,qGAAqG;IACrG,gBAAgB,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAK;IACrC,mFAAmF;IACnF,QAAQ,yDAA8D,qBAAqB,KAAK,IAAI,EAAG;IACvG,oHAAoH;IACpH,MAAM,EAAE,WAAW,CAAA;IACnB,4BAA4B;IAC5B,MAAM,EAAE,IAAI,CAAC,OAAO,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,CAAA;IAC1E,gDAAgD;IAChD,WAAW,cAAoB;IAC/B,+DAA+D;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,0BAA0B;IAC1B,aAAa,EAAE,UAAU,GAAG,IAAI,CAAO;IACvC,kEAAkE;IAClE,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,wDAAwD;IACxD,0BAA0B,EAAE,CAAC,CAAC,IAAI,EAAE,qBAAqB,KAAK,IAAI,CAAC,EAAE,CAAK;gBAE9D,OAAO,EAAE,kBAAkB;IAuBvC,qEAAqE;IACrE,IAAI,aAAa,IAAI,kBAAkB,CAEtC;IAED,6IAA6I;IAC7I,IAAI,aAAa,IAAI,MAAM,CAG1B;IAED,6JAA6J;IAC7J,qBAAqB,IAAI,MAAM;IAOzB,YAAY,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAUxD,yDAAyD;IACzD,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAMzC,kHAAkH;IAC5G,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC;IA+FzC,4GAA4G;IACtG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAiD/B,iEAAiE;IACjE,MAAM,IAAI,OAAO;IAIjB,sEAAsE;IAChE,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAiD7B;;;OAGG;IACG,IAAI,CAAC,OAAO,EAAE,kBAAkB,EAAE,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAarF,4HAA4H;IACtH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAK/B,wCAAwC;IACxC,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAI/B,yCAAyC;IACnC,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA6EnD,0CAA0C;IACpC,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAYzD;;;;OAIG;IACG,gBAAgB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAsDzF,yCAAyC;IACnC,mBAAmB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IA4IvE,YAAY,CAAC,MAAM,EAAE,qBAAqB,GAAG,IAAI;IAMjD;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAI1D;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAEtC,+GAA+G;IACzG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAEnC,4EAA4E;IAC5E,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IA4EzC,kDAAkD;IAClD,gBAAgB,IAAI,IAAI;CAOzB;AAaD,MAAM,WAAW,kBAAkB;IACjC,mBAAmB;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,UAAU,EAAE,kBAAkB,CAAA;IAC9B,kDAAkD;IAClD,MAAM,EAAE,WAAW,CAAA;IACnB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,CAAA;IAC3E,kEAAkE;IAClE,eAAe,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAClC,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAAA;CAC1D;AAED,eAAe,eAAe,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import { Collection } from '@discordeno/utils';
|
|
1
|
+
import { type AtLeastOne, type BigString, type Camelize, type DiscordGetGatewayBot, type DiscordMemberWithUser, type RequestGuildMembers } from '@discordeno/types';
|
|
2
|
+
import { Collection, logger } from '@discordeno/utils';
|
|
3
3
|
import Shard from './Shard.js';
|
|
4
|
-
import type
|
|
4
|
+
import { type BotStatusUpdate, type ShardEvents, type ShardSocketRequest, type StatusUpdate, type TransportCompression, type UpdateVoiceState } from './types.js';
|
|
5
5
|
export declare function createGatewayManager(options: CreateGatewayManagerOptions): GatewayManager;
|
|
6
6
|
export interface CreateGatewayManagerOptions {
|
|
7
7
|
/**
|
|
@@ -46,6 +46,8 @@ export interface CreateGatewayManagerOptions {
|
|
|
46
46
|
* @default false
|
|
47
47
|
*/
|
|
48
48
|
compress?: boolean;
|
|
49
|
+
/** What transport compression should be used */
|
|
50
|
+
transportCompression?: TransportCompression | null;
|
|
49
51
|
/** The calculated intent value of the events which the shard should receive.
|
|
50
52
|
*
|
|
51
53
|
* @default 0
|
|
@@ -82,7 +84,7 @@ export interface CreateGatewayManagerOptions {
|
|
|
82
84
|
*/
|
|
83
85
|
version?: number;
|
|
84
86
|
/** The events handlers */
|
|
85
|
-
events
|
|
87
|
+
events?: ShardEvents;
|
|
86
88
|
/** This managers cache related settings. */
|
|
87
89
|
cache?: {
|
|
88
90
|
requestMembers?: {
|
|
@@ -91,10 +93,47 @@ export interface CreateGatewayManagerOptions {
|
|
|
91
93
|
* @default false
|
|
92
94
|
*/
|
|
93
95
|
enabled?: boolean;
|
|
94
|
-
/** The pending requests. */
|
|
95
|
-
pending: Collection<string, RequestMemberRequest>;
|
|
96
96
|
};
|
|
97
97
|
};
|
|
98
|
+
/**
|
|
99
|
+
* The logger that the gateway manager will use.
|
|
100
|
+
* @default logger // The logger exported by `@discordeno/utils`
|
|
101
|
+
*/
|
|
102
|
+
logger?: Pick<typeof logger, 'debug' | 'info' | 'warn' | 'error' | 'fatal'>;
|
|
103
|
+
/**
|
|
104
|
+
* Make the presence for when the bot connects to the gateway
|
|
105
|
+
*
|
|
106
|
+
* @remarks
|
|
107
|
+
* This function will be called each time a Shard is going to identify
|
|
108
|
+
*/
|
|
109
|
+
makePresence?: () => Promise<BotStatusUpdate | undefined>;
|
|
110
|
+
/** Options related to resharding. */
|
|
111
|
+
resharding?: {
|
|
112
|
+
/**
|
|
113
|
+
* Whether or not automated resharding should be enabled.
|
|
114
|
+
* @default true
|
|
115
|
+
*/
|
|
116
|
+
enabled: boolean;
|
|
117
|
+
/**
|
|
118
|
+
* The % of how full a shard is when resharding should be triggered.
|
|
119
|
+
*
|
|
120
|
+
* @remarks
|
|
121
|
+
* We use discord recommended shard value to get an **approximation** of the shard full percentage to compare with this value so the bot may not reshard at the exact percentage provided but may reshard when it is a bit higher than the provided percentage.
|
|
122
|
+
* For accurate calculation, you may override the `checkIfReshardingIsNeeded` function
|
|
123
|
+
*
|
|
124
|
+
* @default 80 as in 80%
|
|
125
|
+
*/
|
|
126
|
+
shardsFullPercentage: number;
|
|
127
|
+
/**
|
|
128
|
+
* The interval in milliseconds, of how often to check whether resharding is needed and reshard automatically. Set to -1 to disable auto resharding.
|
|
129
|
+
* @default 28800000 (8 hours)
|
|
130
|
+
*/
|
|
131
|
+
checkInterval: number;
|
|
132
|
+
/** Handler to get shard count and other session info. */
|
|
133
|
+
getSessionInfo?: () => Promise<Camelize<DiscordGetGatewayBot>>;
|
|
134
|
+
/** Handler to edit the shard id on any cached guilds. */
|
|
135
|
+
updateGuildsShardId?: (guildIds: string[], shardId: number) => Promise<void>;
|
|
136
|
+
};
|
|
98
137
|
}
|
|
99
138
|
export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
|
|
100
139
|
/** The max concurrency buckets. Those will be created when the `spawnShards` (which calls `prepareBuckets` under the hood) function gets called. */
|
|
@@ -108,6 +147,33 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
|
|
|
108
147
|
}>;
|
|
109
148
|
/** The shards that are created. */
|
|
110
149
|
shards: Map<number, Shard>;
|
|
150
|
+
/** The logger for the gateway manager. */
|
|
151
|
+
logger: Pick<typeof logger, 'debug' | 'info' | 'warn' | 'error' | 'fatal'>;
|
|
152
|
+
/** Everything related to resharding. */
|
|
153
|
+
resharding: CreateGatewayManagerOptions['resharding'] & {
|
|
154
|
+
/**
|
|
155
|
+
* The interval id of the check interval. This is used to clear the interval when the manager is shutdown.
|
|
156
|
+
*/
|
|
157
|
+
checkIntervalId?: NodeJS.Timeout | undefined;
|
|
158
|
+
/** Holds the shards that resharding has created. Once resharding is done, this replaces the gateway.shards */
|
|
159
|
+
shards: Collection<number, Shard>;
|
|
160
|
+
/** Holds the pending shards that have been created and are pending all shards finish loading. */
|
|
161
|
+
pendingShards: Collection<number, Shard>;
|
|
162
|
+
/** Handler to check if resharding is necessary. */
|
|
163
|
+
checkIfReshardingIsNeeded: () => Promise<{
|
|
164
|
+
needed: boolean;
|
|
165
|
+
info?: Camelize<DiscordGetGatewayBot>;
|
|
166
|
+
}>;
|
|
167
|
+
/** Handler to begin resharding. */
|
|
168
|
+
reshard: (info: Camelize<DiscordGetGatewayBot> & {
|
|
169
|
+
firstShardId?: number;
|
|
170
|
+
lastShardId?: number;
|
|
171
|
+
}) => Promise<void>;
|
|
172
|
+
/** Handler to communicate to a worker that a shard needs to be created. */
|
|
173
|
+
tellWorkerToPrepare: (workerId: number, shardId: number, bucketId: number) => Promise<void>;
|
|
174
|
+
/** Handler to alert the gateway that a shard(resharded) is online. It should now wait for all shards to be pending before shutting off old shards. */
|
|
175
|
+
shardIsPending: (shard: Shard) => Promise<void>;
|
|
176
|
+
};
|
|
111
177
|
/** Determine max number of shards to use based upon the max concurrency. */
|
|
112
178
|
calculateTotalShards: () => number;
|
|
113
179
|
/** Determine the id of the worker which is handling a shard. */
|
|
@@ -117,7 +183,8 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
|
|
|
117
183
|
/** Start identifying all the shards. */
|
|
118
184
|
spawnShards: () => Promise<void>;
|
|
119
185
|
/** Shutdown all shards. */
|
|
120
|
-
shutdown: (code: number, reason: string) => Promise<void>;
|
|
186
|
+
shutdown: (code: number, reason: string, clearReshardingInterval?: boolean) => Promise<void>;
|
|
187
|
+
sendPayload: (shardId: number, payload: ShardSocketRequest) => Promise<void>;
|
|
121
188
|
/** Allows users to hook in and change to communicate to different workers across different servers or anything they like. For example using redis pubsub to talk to other servers. */
|
|
122
189
|
tellWorkerToIdentify: (workerId: number, shardId: number, bucketId: number) => Promise<void>;
|
|
123
190
|
/** Tell the manager to identify a Shard. If this Shard is not already managed this will also add the Shard to the manager. */
|
|
@@ -148,7 +215,7 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
|
|
|
148
215
|
* Edits the bot status in all shards that this gateway manages.
|
|
149
216
|
*
|
|
150
217
|
* @param data The status data to set the bots status to.
|
|
151
|
-
* @returns
|
|
218
|
+
* @returns nothing
|
|
152
219
|
*/
|
|
153
220
|
editBotStatus: (data: StatusUpdate) => Promise<void>;
|
|
154
221
|
/**
|
|
@@ -156,7 +223,7 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
|
|
|
156
223
|
*
|
|
157
224
|
* @param shardId The shard id to edit the status for.
|
|
158
225
|
* @param data The status data to set the bots status to.
|
|
159
|
-
* @returns
|
|
226
|
+
* @returns nothing
|
|
160
227
|
*/
|
|
161
228
|
editShardStatus: (shardId: number, data: StatusUpdate) => Promise<void>;
|
|
162
229
|
/**
|
|
@@ -182,7 +249,7 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
|
|
|
182
249
|
*
|
|
183
250
|
* @see {@link https://discord.com/developers/docs/topics/gateway#request-guild-members}
|
|
184
251
|
*/
|
|
185
|
-
requestMembers: (guildId: BigString, options?: Omit<RequestGuildMembers, 'guildId'>) => Promise<Camelize<
|
|
252
|
+
requestMembers: (guildId: BigString, options?: Omit<RequestGuildMembers, 'guildId'>) => Promise<Camelize<DiscordMemberWithUser[]>>;
|
|
186
253
|
/**
|
|
187
254
|
* Leaves the voice channel the bot user is currently in.
|
|
188
255
|
*
|
|
@@ -196,13 +263,45 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
|
|
|
196
263
|
* @see {@link https://discord.com/developers/docs/topics/gateway#update-voice-state}
|
|
197
264
|
*/
|
|
198
265
|
leaveVoiceChannel: (guildId: BigString) => Promise<void>;
|
|
266
|
+
/**
|
|
267
|
+
* Used to request soundboard sounds for a list of guilds.
|
|
268
|
+
*
|
|
269
|
+
* This function sends multiple (see remarks) _Request Soundboard Sounds_ gateway command over the gateway behind the scenes.
|
|
270
|
+
*
|
|
271
|
+
* @param guildIds - The guilds to get the sounds from
|
|
272
|
+
*
|
|
273
|
+
* @remarks
|
|
274
|
+
* Fires a _Soundboard Sounds_ gateway event.
|
|
275
|
+
*
|
|
276
|
+
* ⚠️ Discord will send the _Soundboard Sounds_ for each of the guild ids
|
|
277
|
+
* however you may not receive the same number of events as the ids passed to _Request Soundboard Sounds_ for one of the following reasons:
|
|
278
|
+
* - The bot is not in the server provided
|
|
279
|
+
* - The shard the message has been sent from does not receive events for the specified guild
|
|
280
|
+
*
|
|
281
|
+
* To avoid this Discordeno will automatically try to group the ids based on what shard they will need to be sent, but this involves sending multiple messages in multiple shards
|
|
282
|
+
*
|
|
283
|
+
* @see {@link https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds}
|
|
284
|
+
*/
|
|
285
|
+
requestSoundboardSounds: (guildIds: BigString[]) => Promise<void>;
|
|
286
|
+
/** This managers cache related settings. */
|
|
287
|
+
cache: {
|
|
288
|
+
requestMembers: {
|
|
289
|
+
/**
|
|
290
|
+
* Whether or not request member requests should be cached.
|
|
291
|
+
* @default false
|
|
292
|
+
*/
|
|
293
|
+
enabled: boolean;
|
|
294
|
+
/** The pending requests. */
|
|
295
|
+
pending: Collection<string, RequestMemberRequest>;
|
|
296
|
+
};
|
|
297
|
+
};
|
|
199
298
|
}
|
|
200
299
|
export interface RequestMemberRequest {
|
|
201
300
|
/** The unique nonce for this request. */
|
|
202
301
|
nonce: string;
|
|
203
302
|
/** The resolver handler to run when all members arrive. */
|
|
204
|
-
resolve: (value: Camelize<
|
|
303
|
+
resolve: (value: Camelize<DiscordMemberWithUser[]> | PromiseLike<Camelize<DiscordMemberWithUser[]>>) => void;
|
|
205
304
|
/** The members that have already arrived for this request. */
|
|
206
|
-
members:
|
|
305
|
+
members: DiscordMemberWithUser[];
|
|
207
306
|
}
|
|
208
307
|
//# sourceMappingURL=manager.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../../src/manager.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,QAAQ,EACb,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAI1B,KAAK,mBAAmB,EACzB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,UAAU,EAAS,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,KAAK,MAAM,YAAY,CAAA;AAC9B,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,WAAW,EAEhB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACtB,MAAM,YAAY,CAAA;AAEnB,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,cAAc,CAujBzF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,oFAAoF;IACpF,UAAU,CAAC,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAAA;IAC3C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gDAAgD;IAChD,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAA;IAClD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,UAAU,CAAC,EAAE;QACX;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAA;QACf;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,4CAA4C;IAC5C,KAAK,CAAC,EAAE;QACN,cAAc,CAAC,EAAE;YACf;;;eAGG;YACH,OAAO,CAAC,EAAE,OAAO,CAAA;SAClB,CAAA;KACF,CAAA;IACD;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,CAAA;IAC3E;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAAA;IACzD,qCAAqC;IACrC,UAAU,CAAC,EAAE;QACX;;;WAGG;QACH,OAAO,EAAE,OAAO,CAAA;QAChB;;;;;;;;WAQG;QACH,oBAAoB,EAAE,MAAM,CAAA;QAC5B;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAA;QACrB,yDAAyD;QACzD,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAA;QAC9D,yDAAyD;QACzD,mBAAmB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAC7E,CAAA;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,QAAQ,CAAC,2BAA2B,CAAC;IAC3E,oJAAoJ;IACpJ,OAAO,EAAE,GAAG,CACV,MAAM,EACN;QACE,OAAO,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAA;QAC/C,wFAAwF;QACxF,gBAAgB,EAAE,KAAK,CAAC,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;KACnE,CACF,CAAA;IACD,mCAAmC;IACnC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC1B,0CAA0C;IAC1C,MAAM,EAAE,IAAI,CAAC,OAAO,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,CAAA;IAC1E,wCAAwC;IACxC,UAAU,EAAE,2BAA2B,CAAC,YAAY,CAAC,GAAG;QACtD;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAA;QAC5C,8GAA8G;QAC9G,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACjC,iGAAiG;QACjG,aAAa,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACxC,mDAAmD;QACnD,yBAAyB,EAAE,MAAM,OAAO,CAAC;YAAE,MAAM,EAAE,OAAO,CAAC;YAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAAA;SAAE,CAAC,CAAA;QACpG,mCAAmC;QACnC,OAAO,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;QAClH,2EAA2E;QAC3E,mBAAmB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3F,sJAAsJ;QACtJ,cAAc,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAChD,CAAA;IACD,4EAA4E;IAC5E,oBAAoB,EAAE,MAAM,MAAM,CAAA;IAClC,gEAAgE;IAChE,iBAAiB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;IAC9C,8EAA8E;IAC9E,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,wCAAwC;IACxC,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAChC,2BAA2B;IAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5F,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5E,sLAAsL;IACtL,oBAAoB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5F,8HAA8H;IAC9H,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5C,4GAA4G;IAC5G,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACxC,6FAA6F;IAC7F,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACnD,8EAA8E;IAC9E,gBAAgB,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IACtE;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,GAAG,WAAW,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACpJ;;;;;OAKG;IACH,aAAa,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACpD;;;;;;OAMG;IACH,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACvE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,mBAAmB,EAAE,SAAS,CAAC,KAAK,OAAO,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAA;IAClI;;;;;;;;;;;OAWG;IACH,iBAAiB,EAAE,CAAC,OAAO,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACxD;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAAuB,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACjE,4CAA4C;IAC5C,KAAK,EAAE;QACL,cAAc,EAAE;YACd;;;eAGG;YACH,OAAO,EAAE,OAAO,CAAA;YAChB,4BAA4B;YAC5B,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;SAClD,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAA;IACb,2DAA2D;IAC3D,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,qBAAqB,EAAE,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC5G,8DAA8D;IAC9D,OAAO,EAAE,qBAAqB,EAAE,CAAA;CACjC"}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
1
|
import type { ActivityTypes, Camelize, DiscordActivity, DiscordGatewayPayload, GatewayOpcodes, PresenceStatus } from '@discordeno/types';
|
|
3
2
|
import type Shard from './Shard.js';
|
|
4
3
|
export declare enum ShardState {
|
|
@@ -17,12 +16,46 @@ export declare enum ShardState {
|
|
|
17
16
|
/** Shard got shut down studied or due to a not (self) fixable error and may not attempt to reconnect on its own. */
|
|
18
17
|
Offline = 6
|
|
19
18
|
}
|
|
19
|
+
export declare enum TransportCompression {
|
|
20
|
+
/**
|
|
21
|
+
* ZLib-Stream Transport Compression.
|
|
22
|
+
*
|
|
23
|
+
* @remarks
|
|
24
|
+
* Uses `node:zlib` to decompress the payloads
|
|
25
|
+
*
|
|
26
|
+
* @see https://discord.com/developers/docs/topics/gateway#zlibstream
|
|
27
|
+
*/
|
|
28
|
+
zlib = "zlib-stream",
|
|
29
|
+
/**
|
|
30
|
+
* ZStd-Stream Transport Compression.
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* Uses `fzstd` to decompress the payloads. `fzstd` is an optional dependency, it is required to be installed for this compression.
|
|
34
|
+
*
|
|
35
|
+
* @see https://discord.com/developers/docs/topics/gateway#zstdstream
|
|
36
|
+
*/
|
|
37
|
+
zstd = "zstd-stream"
|
|
38
|
+
}
|
|
20
39
|
export interface ShardGatewayConfig {
|
|
21
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* Whatever to enable Payload compression.
|
|
42
|
+
*
|
|
43
|
+
* @remarks
|
|
44
|
+
* This is compatible with {@link transportCompression}
|
|
22
45
|
*
|
|
23
46
|
* @default false
|
|
47
|
+
*
|
|
48
|
+
* @see https://discord.com/developers/docs/topics/gateway#payload-compression
|
|
24
49
|
*/
|
|
25
50
|
compress: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* What Transport Compression should be use
|
|
53
|
+
*
|
|
54
|
+
* @default null
|
|
55
|
+
*
|
|
56
|
+
* @see https://discord.com/developers/docs/topics/gateway#transport-compression
|
|
57
|
+
*/
|
|
58
|
+
transportCompression: TransportCompression | null;
|
|
26
59
|
/** The calculated intent value of the events which the shard should receive.
|
|
27
60
|
*
|
|
28
61
|
* @default 0
|
|
@@ -70,7 +103,7 @@ export interface ShardHeart {
|
|
|
70
103
|
/** Interval between heartbeats requested by Discord. */
|
|
71
104
|
interval: number;
|
|
72
105
|
/** Id of the interval, which is used for sending the heartbeats. */
|
|
73
|
-
intervalId?: NodeJS.
|
|
106
|
+
intervalId?: NodeJS.Timeout;
|
|
74
107
|
/** Unix (in milliseconds) timestamp when the last heartbeat ACK was received from Discord. */
|
|
75
108
|
lastAck?: number;
|
|
76
109
|
/** Unix timestamp (in milliseconds) when the last heartbeat was sent. */
|
|
@@ -116,7 +149,8 @@ export declare enum ShardSocketCloseCodes {
|
|
|
116
149
|
Shutdown = 3000,
|
|
117
150
|
/** A resume has been requested and therefore the old connection needs to be closed. */
|
|
118
151
|
ResumeClosingOldConnection = 3024,
|
|
119
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* Did not receive a heartbeat ACK in time.
|
|
120
154
|
* Closing the shard and creating a new session.
|
|
121
155
|
*/
|
|
122
156
|
ZombiedConnection = 3010,
|
|
@@ -161,7 +195,7 @@ export interface UpdateVoiceState {
|
|
|
161
195
|
/** https://discord.com/developers/docs/topics/gateway-events#update-presence */
|
|
162
196
|
export interface StatusUpdate {
|
|
163
197
|
/** The user's activities */
|
|
164
|
-
activities?: Camelize<
|
|
198
|
+
activities?: Camelize<Omit<DiscordActivity, 'created_at'>[]>;
|
|
165
199
|
/** The user's new status */
|
|
166
200
|
status: keyof typeof PresenceStatus;
|
|
167
201
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,eAAe,EAAE,qBAAqB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACxI,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,oBAAY,UAAU;IACpB,iFAAiF;IACjF,SAAS,IAAI;IACb,6HAA6H;IAC7H,UAAU,IAAI;IACd,yEAAyE;IACzE,YAAY,IAAI;IAChB,iIAAiI;IACjI,YAAY,IAAI;IAChB,4EAA4E;IAC5E,WAAW,IAAI;IACf,4DAA4D;IAC5D,QAAQ,IAAI;IACZ,oHAAoH;IACpH,OAAO,IAAI;CACZ;AAED,oBAAY,oBAAoB;IAC9B;;;;;;;OAOG;IACH,IAAI,gBAAgB;IACpB;;;;;;;OAOG;IACH,IAAI,gBAAgB;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;OASG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB;;;;;;OAMG;IACH,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAA;IACjD;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IACf,iCAAiC;IACjC,UAAU,EAAE;QACV;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAA;QACf;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,wEAAwE;IACxE,YAAY,EAAE,OAAO,CAAA;IACrB,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAA;IAChB,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,CAAA;IAC3B,8FAA8F;IAC9F,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,uGAAuG;IACvG,SAAS,CAAC,EAAE,MAAM,CAAC,OAAO,CAAA;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,iCAAiC;IACjC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACrC,oCAAoC;IACpC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACxC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACjC,+CAA+C;IAC/C,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,KAAK,OAAO,CAAA;IAC9D,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACpC,yDAAyD;IACzD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACnC,oDAAoD;IACpD,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IAC9C,yDAAyD;IACzD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACtC,qDAAqD;IACrD,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACrC,8DAA8D;IAC9D,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACxC,2DAA2D;IAC3D,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACvC,sEAAsE;IACtE,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACtC,qDAAqD;IACrD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,qBAAqB,CAAC,KAAK,OAAO,CAAA;CAC9E;AAED,oBAAY,qBAAqB;IAC/B,gCAAgC;IAChC,QAAQ,OAAO;IACf,uFAAuF;IACvF,0BAA0B,OAAO;IACjC;;;OAGG;IACH,iBAAiB,OAAO;IACxB,2FAA2F;IAC3F,eAAe,OAAO;IACtB,oFAAoF;IACpF,SAAS,OAAO;IAChB,+EAA+E;IAC/E,aAAa,OAAO;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,2CAA2C;IAC3C,EAAE,EAAE,cAAc,CAAA;IAClB,oBAAoB;IACpB,CAAC,EAAE,OAAO,CAAA;CACX;AAED,gFAAgF;AAChF,MAAM,WAAW,eAAe;IAE9B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,4BAA4B;IAC5B,UAAU,EAAE,WAAW,EAAE,CAAA;IACzB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,OAAO,cAAc,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,aAAa,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,4EAA4E;AAC5E,MAAM,WAAW,gBAAgB;IAC/B,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,2EAA2E;IAC3E,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,0BAA0B;IAC1B,QAAQ,EAAE,OAAO,CAAA;IACjB,6BAA6B;IAC7B,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,gFAAgF;AAChF,MAAM,WAAW,YAAY;IAG3B,4BAA4B;IAC5B,UAAU,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,CAAC,CAAA;IAC5D,4BAA4B;IAC5B,MAAM,EAAE,MAAM,OAAO,cAAc,CAAA;CAGpC"}
|