@discordeno/gateway 19.0.0-next.fbd26f4 → 19.0.0-next.fc13bdf

package/README.md

@@ -53,7 +53,7 @@ This WS service is meant for ADVANCED DEVELOPERS ONLY!
 ```ts
 createGatewayManager({
   // TODO: (docs) Fill this out
-});
+})
 ```
 
 ## API/Docs

package/dist/Shard.d.ts

@@ -1,8 +1,10 @@
-import type { DiscordGatewayPayload } from '@discordeno/types';
+import type { AtLeastOne, BigString, Camelize, DiscordGatewayPayload, DiscordMember, RequestGuildMembers } from '@discordeno/types';
+import { Collection } from '@discordeno/utils';
 import WebSocket from 'ws';
-import type { BotStatusUpdate, ShardEvents, ShardGatewayConfig, ShardHeart, ShardSocketRequest } from './types.js';
+import type { RequestMemberRequest } from './manager.js';
+import type { BotStatusUpdate, ShardEvents, ShardGatewayConfig, ShardHeart, ShardSocketRequest, StatusUpdate, UpdateVoiceState } from './types.js';
 import { ShardState } from './types.js';
-export declare class Shard {
+export declare class DiscordenoShard {
     /** The id of the shard */
     id: number;
     /** The connection config details that this shard will used to connect to discord. */
@@ -31,6 +33,18 @@ export declare class Shard {
     resolves: Map<"READY" | "RESUMED" | "INVALID_SESSION", (payload: DiscordGatewayPayload) => void>;
     /** Shard bucket. Only access this if you know what you are doing. Bucket for handling shard request rate limits. */
     bucket: import("@discordeno/utils").LeakyBucket;
+    /** This managers cache related settings. */
+    cache: {
+        requestMembers: {
+            /**
+             * Whether or not request member requests should be cached.
+             * @default false
+             */
+            enabled: boolean;
+            /** The pending requests. */
+            pending: Collection<string, RequestMemberRequest>;
+        };
+    };
     constructor(options: ShardCreateOptions);
     /** The gateway configuration which is used to connect to Discord. */
     get gatewayConfig(): ShardGatewayConfig;
@@ -40,7 +54,7 @@ export declare class Shard {
     /** Close the socket connection to discord if present. */
     close(code: number, reason: string): void;
     /** Connect the shard with the gateway and start heartbeating. This will not identify the shard to the gateway. */
-    connect(): Promise<Shard>;
+    connect(): Promise<DiscordenoShard>;
     /** Identify the shard to the gateway. If not connected, this will also connect the shard to the gateway. */
     identify(): Promise<void>;
     /** Check whether the connection to Discord is currently open. */
@@ -55,6 +69,8 @@ export declare class Shard {
     shutdown(): Promise<void>;
     /** Handle a gateway connection close. */
     handleClose(close: WebSocket.CloseEvent): Promise<void>;
+    /** Handles a incoming gateway packet. */
+    handleDiscordPacket(packet: DiscordGatewayPayload): Promise<void>;
     /** Handle an incoming gateway message. */
     handleMessage(message: WebSocket.MessageEvent): Promise<void>;
     /**
@@ -69,6 +85,74 @@ export declare class Shard {
     startHeartbeating(interval: number): void;
     /** Stop the heartbeating process with discord. */
     stopHeartbeating(): void;
+    /**
+     * Connects the bot user to a voice or stage channel.
+     *
+     * This function sends the _Update Voice State_ gateway command over the gateway behind the scenes.
+     *
+     * @param guildId - The ID of the guild the voice channel to leave is in.
+     * @param channelId - The ID of the channel you want to join.
+     *
+     * @remarks
+     * Requires the `CONNECT` permission.
+     *
+     * Fires a _Voice State Update_ gateway event.
+     *
+     * @see {@link https://discord.com/developers/docs/topics/gateway#update-voice-state}
+     */
+    joinVoiceChannel(guildId: BigString, channelId: BigString, options?: AtLeastOne<Omit<UpdateVoiceState, 'guildId' | 'channelId'>>): Promise<void>;
+    /**
+     * Edits the bot status in all shards that this gateway manages.
+     *
+     * @param data The status data to set the bots status to.
+     * @returns Promise<void>
+     */
+    editBotStatus(data: StatusUpdate): Promise<void>;
+    /**
+     * Edits the bot's status on one shard.
+     *
+     * @param shardId The shard id to edit the status for.
+     * @param data The status data to set the bots status to.
+     * @returns Promise<void>
+     */
+    editShardStatus(data: StatusUpdate): Promise<void>;
+    /**
+     * Fetches the list of members for a guild over the gateway.
+     *
+     * @param guildId - The ID of the guild to get the list of members for.
+     * @param options - The parameters for the fetching of the members.
+     *
+     * @remarks
+     * If requesting the entire member list:
+     * - Requires the `GUILD_MEMBERS` intent.
+     *
+     * If requesting presences ({@link RequestGuildMembers.presences | presences} set to `true`):
+     * - Requires the `GUILD_PRESENCES` intent.
+     *
+     * If requesting a prefix ({@link RequestGuildMembers.query | query} non-`undefined`):
+     * - Returns a maximum of 100 members.
+     *
+     * If requesting a users by ID ({@link RequestGuildMembers.userIds | userIds} non-`undefined`):
+     * - Returns a maximum of 100 members.
+     *
+     * Fires a _Guild Members Chunk_ gateway event for every 1000 members fetched.
+     *
+     * @see {@link https://discord.com/developers/docs/topics/gateway#request-guild-members}
+     */
+    requestMembers(guildId: BigString, options?: Omit<RequestGuildMembers, 'guildId'>): Promise<Camelize<DiscordMember[]>>;
+    /**
+     * Leaves the voice channel the bot user is currently in.
+     *
+     * This function sends the _Update Voice State_ gateway command over the gateway behind the scenes.
+     *
+     * @param guildId - The ID of the guild the voice channel to leave is in.
+     *
+     * @remarks
+     * Fires a _Voice State Update_ gateway event.
+     *
+     * @see {@link https://discord.com/developers/docs/topics/gateway#update-voice-state}
+     */
+    leaveVoiceChannel(guildId: BigString): Promise<void>;
 }
 export interface ShardCreateOptions {
     /** The shard id */
@@ -78,5 +162,5 @@ export interface ShardCreateOptions {
     /** The event handlers for events on the shard. */
     events: ShardEvents;
 }
-export default Shard;
+export default DiscordenoShard;
 //# sourceMappingURL=Shard.d.ts.map

package/dist/Shard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Shard.d.ts","sourceRoot":"","sources":["../src/Shard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAA8B,MAAM,mBAAmB,CAAA;AAI1F,OAAO,SAAS,MAAM,IAAI,CAAA;AAC1B,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAClH,OAAO,EAAyB,UAAU,EAAE,MAAM,YAAY,CAAA;AAE9D,qBAAa,KAAK;IAChB,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,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC,CAAK;IACnD,mFAAmF;IACnF,QAAQ,yDAA8D,qBAAqB,KAAK,IAAI,EAAG;IACvG,oHAAoH;IACpH,MAAM,0CAIJ;gBAEU,OAAO,EAAE,kBAAkB;IAWvC,qEAAqE;IACrE,IAAI,aAAa,IAAI,kBAAkB,CAEtC;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,KAAK,CAAC;IA2C/B,4GAA4G;IACtG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAmD/B,iEAAiE;IACjE,MAAM,IAAI,OAAO;IAIjB,sEAAsE;IAChE,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAiD7B;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,kBAAkB,EAAE,YAAY,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAa5E,4HAA4H;IACtH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAK/B,yCAAyC;IACnC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA6D7D,0CAA0C;IACpC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAiJnE;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAK1D,uNAAuN;IACjN,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtC,4EAA4E;IAC5E,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAgEzC,kDAAkD;IAClD,gBAAgB,IAAI,IAAI;CAOzB;AAED,MAAM,WAAW,kBAAkB;IACjC,mBAAmB;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,UAAU,EAAE,kBAAkB,CAAA;IAC9B,kDAAkD;IAClD,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,eAAe,KAAK,CAAA"}
+{"version":3,"file":"Shard.d.ts","sourceRoot":"","sources":["../src/Shard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,QAAQ,EACR,qBAAqB,EAErB,aAAa,EAEb,mBAAmB,EACpB,MAAM,mBAAmB,CAAA;AAE1B,OAAO,EAAY,UAAU,EAAoC,MAAM,mBAAmB,CAAA;AAE1F,OAAO,SAAS,MAAM,IAAI,CAAA;AAC1B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,kBAAkB,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClJ,OAAO,EAAyB,UAAU,EAAE,MAAM,YAAY,CAAA;AAE9D,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,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC,CAAK;IACnD,mFAAmF;IACnF,QAAQ,yDAA8D,qBAAqB,KAAK,IAAI,EAAG;IACvG,oHAAoH;IACpH,MAAM,0CAIJ;IAEF,4CAA4C;IAC5C,KAAK;;YAED;;;eAGG;;YAEH,4BAA4B;;;MAG/B;gBAEW,OAAO,EAAE,kBAAkB;IAWvC,qEAAqE;IACrE,IAAI,aAAa,IAAI,kBAAkB,CAEtC;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;IA2CzC,4GAA4G;IACtG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAmD/B,iEAAiE;IACjE,MAAM,IAAI,OAAO;IAIjB,sEAAsE;IAChE,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAiD7B;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,kBAAkB,EAAE,YAAY,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAa5E,4HAA4H;IACtH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAK/B,yCAAyC;IACnC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA6D7D,yCAAyC;IACnC,mBAAmB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoIvE,0CAA0C;IACpC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAenE;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAK1D,uNAAuN;IACjN,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtC,4EAA4E;IAC5E,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAgEzC,kDAAkD;IAClD,gBAAgB,IAAI,IAAI;IAQxB;;;;;;;;;;;;;;OAcG;IACG,gBAAgB,CACpB,OAAO,EAAE,SAAS,EAClB,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,GAAG,WAAW,CAAC,CAAC,GACpE,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;OAKG;IACG,aAAa,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtD;;;;;;OAMG;IACG,eAAe,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,mBAAmB,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;IAmD5H;;;;;;;;;;;OAWG;IACG,iBAAiB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAY3D;AAED,MAAM,WAAW,kBAAkB;IACjC,mBAAmB;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,UAAU,EAAE,kBAAkB,CAAA;IAC9B,kDAAkD;IAClD,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,eAAe,eAAe,CAAA"}