cloudstorm 0.9.5 → 0.10.1

package/dist/index.d.ts

@@ -1,8 +1,10 @@
 import * as discord_api_types_v10 from 'discord-api-types/v10';
 import { GatewayReceivePayload, GatewayDispatchPayload, GatewayPresenceUpdateData, GatewaySendPayload, GatewayVoiceStateUpdateData, GatewayRequestGuildMembersData } from 'discord-api-types/v10';
 import * as snowtransfer from 'snowtransfer';
+import { LocalBucket } from 'snowtransfer';
 import * as events from 'events';
 import { EventEmitter } from 'events';
+import * as zlib from 'zlib';
 
 type IntentFlags = typeof flags;
 type IntentResolvable = number | Array<number> | keyof IntentFlags | Array<keyof IntentFlags>;
@@ -94,50 +96,6 @@ interface IClientWSOptions {
     encoding?: "etf" | "json";
 }
 
-/**
- * RatelimitBucket, used for ratelimiting the execution of functions.
- */
-declare class RatelimitBucket {
-    limit: number;
-    limitReset: number;
-    defaultReset?: number | undefined;
-    /** Functions waiting to be executed. */
-    fnQueue: Array<{
-        fn: () => unknown;
-        callback: () => unknown;
-        error: Error;
-    }>;
-    /** How many more functions can be executed before this bucket needs to wait to reset. */
-    remaining: number;
-    /** The Timeout that when executed, will reset this bucket's remaining to the limit. Null if remaining is the limit. */
-    resetTimeout: NodeJS.Timeout | null;
-    /**
-     * Create a new Bucket.
-     * @param limit Number of functions that may be executed during the timeframe set in limitReset.
-     * @param limitReset Timeframe in milliseconds until the ratelimit resets.
-     * @param defaultReset If the bucket info does not provide default values, but provides remaining, this is the reset to use after the initial reset.
-     */
-    constructor(limit?: number, limitReset?: number, defaultReset?: number | undefined);
-    /**
-     * Queue a function to be executed.
-     * @param fn Function to be executed.
-     * @returns Result of the function if any.
-     */
-    queue<T>(fn: () => T): Promise<T>;
-    /**
-     * Check if there are any functions in the queue that haven't been executed yet.
-     */
-    private checkQueue;
-    /**
-     * Reset the remaining tokens to the base limit.
-     */
-    private resetRemaining;
-    /**
-     * Clear the current queue of events to be sent.
-     */
-    dropQueue(): void;
-}
-
 interface BWSEvents {
     ws_open: [];
     ws_close: [number, string];
@@ -171,13 +129,19 @@ declare class BetterWs extends EventEmitter {
     /** If the messages sent/received are compressed with zlib. */
     compress: boolean;
     /** The ratelimit bucket for how many packets this ws can send within a time frame. */
-    wsBucket: RatelimitBucket;
+    wsBucket: LocalBucket;
     /** The ratelimit bucket for how many presence update specific packets this ws can send within a time frame. Is still affected by the overall packet send bucket. */
-    presenceBucket: RatelimitBucket;
+    presenceBucket: LocalBucket;
     /** The raw net.Socket retreived from upgrading the connection or null if not upgraded/closed. */
     private _socket;
     /** Internal properties that need a funny way to be referenced. */
-    private _internal;
+    _internal: {
+        openRejector: ((reason?: any) => void) | null;
+        /** A promise that resolves when the connection is fully closed or null if not closing the connection if any. */
+        closePromise: Promise<void> | null;
+        /** A zlib Inflate instance if messages sent/received are going to be compressed. Auto created on connect. */
+        zlib: zlib.Inflate | null;
+    };
     /** If a request is going through to initiate a WebSocket connection and hasn't been upgraded by the server yet. */
     private _connecting;
     /** Code received from frame op 8 */
@@ -320,7 +284,6 @@ declare class DiscordConnector extends EventEmitter {
     private _openToHeartbeatTimeout;
     /** A Timeout that, when triggered, sends the first heartbeat */
     private _initialHeartbeatTimeout;
-    static readonly default: typeof DiscordConnector;
     /**
      * Creates a new Discord Connector.
      * @param id id of the shard that created this class.
@@ -362,11 +325,11 @@ declare class DiscordConnector extends EventEmitter {
      * Clear the heart beat interval, set it to null and set the cached heartbeat_interval as 0.
      */
     private clearHeartBeat;
+    private _onHello;
     /**
-     * Send an OP 2 IDENTIFY to the gateway or an OP 6 RESUME if forceful identify is falsy.
-     * @param force Whether CloudStorm should send an OP 2 IDENTIFY even if there's a session that could be resumed.
+     * Send an OP 2 IDENTIFY to the gateway.
      */
-    identify(force?: boolean): Promise<void>;
+    identify(): Promise<void>;
     /**
      * Send an OP 6 RESUME to the gateway.
      */
@@ -522,9 +485,9 @@ declare class ShardManager {
         [id: number]: Shard;
     };
     /** The bucket used to identify a certain number of shards within a day. */
-    identifyBucket: RatelimitBucket;
+    identifyBucket: LocalBucket;
     /** The bucket used to identify x number of shards within 5 second intervals. Larger bots benefit from this, but doesn't change how many times per day any shards can identify. */
-    concurrencyBucket: RatelimitBucket | null;
+    concurrencyBucket: LocalBucket | null;
     /**
      * Create a new ShardManager.
      */
@@ -789,4 +752,4 @@ declare const Constants: {
     GATEWAY_VERSION: 10;
 };
 
-export { BetterWs, Client, Constants, IClientOptions, IClientWSOptions, IGatewayDispatch, IGatewayMessage, _default as Intents, Shard, ShardManager };
+export { BetterWs, Client, Constants, type IClientOptions, type IClientWSOptions, type IGatewayDispatch, type IGatewayMessage, _default as Intents, Shard, ShardManager };