cloudstorm 0.5.8 → 0.6.1

package/dist/Client.js

@@ -1,196 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const version = require("../package.json").version;
-const events_1 = require("events");
-const Constants_1 = __importDefault(require("./Constants"));
-const snowtransfer_1 = require("snowtransfer");
-const ShardManager_1 = __importDefault(require("./ShardManager"));
-const RatelimitBucket_1 = __importDefault(require("./structures/RatelimitBucket"));
-/**
- * Main class used for receiving events and interacting with the Discord gateway.
- */
-class Client extends events_1.EventEmitter {
-    /**
-     * Create a new Client to connect to the Discord gateway.
-     * @param token Token received from creating a discord bot user, which will be used to connect to the gateway.
-     */
-    constructor(token, options = {}) {
-        super();
-        if (!token)
-            throw new Error("Missing token!");
-        this.options = {
-            largeGuildThreshold: 250,
-            shards: "auto",
-            reconnect: true,
-            intents: 0,
-            token: "",
-            ws: {
-                compress: true,
-                encoding: "json"
-            }
-        };
-        this._restClient = options.snowtransferInstance ? options.snowtransferInstance : new snowtransfer_1.SnowTransfer(token);
-        delete options.snowtransferInstance;
-        this.token = token.startsWith("Bot ") ? token.substring(4) : token;
-        Object.assign(this.options, options);
-        this.options.token = token;
-        this.shardManager = new ShardManager_1.default(this);
-        this.version = version;
-    }
-    /**
-     * Create one or more connections (depending on the selected amount of shards) to the Discord gateway.
-     * @returns This function returns a promise which is solely used for awaiting the getGateway() method's return value.
-     */
-    async connect() {
-        const initial = await this.fetchConnectInfo();
-        if (this.options.shards === "auto")
-            this.options.totalShards = initial;
-        this.shardManager.spawn();
-    }
-    /**
-     * Method to grab initial connection info from Discord.
-     * Should only be called automatically by the lib unless you are a large bot with a max_concurrency not equal to 1.
-     * If you are a large bot, you should call this method at a rate of your own discretion to update your max_concurrency cached value to have up to date bucket info.
-     * @returns The amount of shards the bot should spawn if set to auto.
-     */
-    async fetchConnectInfo() {
-        const gateway = await this.getGatewayBot();
-        this._updateEndpoint(gateway.url);
-        const oldQueueConcurrency = [];
-        const oldQueueIdentify = [];
-        if (this.shardManager.concurrencyBucket && this.shardManager.concurrencyBucket.fnQueue.length) {
-            oldQueueConcurrency.push(...this.shardManager.concurrencyBucket.fnQueue.map(i => [i.fn, i.callback]));
-            this.shardManager.concurrencyBucket.dropQueue();
-        }
-        if (this.shardManager.identifyBucket.fnQueue.length)
-            oldQueueIdentify.push(...this.shardManager.identifyBucket.fnQueue.map(i => [i.fn, i.callback]));
-        this.shardManager.identifyBucket.dropQueue();
-        this.shardManager.concurrencyBucket = new RatelimitBucket_1.default(gateway.session_start_limit.max_concurrency, 5000);
-        this.shardManager.identifyBucket.remaining = gateway.session_start_limit.remaining;
-        this.shardManager.identifyBucket.limitReset = gateway.session_start_limit.reset_after;
-        for (const [fn, callback] of oldQueueConcurrency) {
-            this.shardManager.concurrencyBucket.queue(fn).then(callback);
-        }
-        for (const [fn, callback] of oldQueueIdentify) {
-            this.shardManager.identifyBucket.queue(fn).then(callback);
-        }
-        return gateway.shards;
-    }
-    /**
-     * Get the gateway endpoint to connect to.
-     * @returns String url with the Gateway Endpoint to connect to.
-     */
-    async getGateway() {
-        const gatewayData = await this._restClient.bot.getGateway();
-        return gatewayData.url;
-    }
-    /**
-     * Get the GatewayData including recommended amount of shards and other helpful info.
-     * @returns Object with url and shards to use to connect to discord.
-     */
-    async getGatewayBot() {
-        return this._restClient.bot.getGatewayBot();
-    }
-    /**
-     * Disconnect the bot gracefully,
-     * you will receive a 'disconnected' event once the ShardManager successfully closes all shard websocket connections.
-     */
-    disconnect() {
-        return this.shardManager.disconnect();
-    }
-    /**
-     * Send an OP 3 PRESENCE_UPDATE to Discord, which updates the status of all shards facilitated by this client's ShardManager.
-     * @returns Promise that's resolved once all shards have sent the websocket payload.
-     *
-     * @example
-     * // Connect to Discord and set status to do not disturb and game to "Memes are Dreams".
-     * const CloudStorm = require("cloudstorm"); // CloudStorm also supports import statements.
-     * const token = "token";
-     * const client = new CloudStorm.Client(token);
-     * client.connect();
-     * client.once("ready", () => {
-     * 	// Client is connected to Discord and is ready, so we can update the status.
-     * 	client.presenceUpdate({ status: "dnd", game: { name: "Memes are Dreams" } });
-     * });
-     */
-    async presenceUpdate(data) {
-        return this.shardManager.presenceUpdate(data);
-    }
-    /**
-     * Send an OP 3 PRESENCE_UPDATE to Discord, which updates the status of a single shard facilitated by this client's ShardManager.
-     * @param shardId id of the shard that should update it's status.
-     * @param data Presence data to send.
-     * @returns Promise that's resolved once the shard has sent the websocket payload.
-     *
-     * @example
-     * // Connect to Discord and set status to do not disturb and game to "Im shard 0".
-     * const CloudStorm = require("cloudstorm"); // CloudStorm also supports import statements.
-     * const token = "token";
-     * const client = new CloudStorm.Client(token);
-     * client.connect();
-     * client.once("ready", () => {
-     * 	// Client is connected to Discord and is ready, so we can update the status of shard 0.
-     * 	client.shardPresenceUpdate(0, { status: "dnd", game: { name: "Im shard 0" } });
-     * });
-     */
-    shardStatusUpdate(shardId, data) {
-        return this.shardManager.shardPresenceUpdate(shardId, data);
-    }
-    /**
-     * Send an OP 4 VOICE_STATE_UPDATE to Discord. this does **not** allow you to send audio with CloudStorm itself,
-     * it just provides the necessary data for another application to send audio data to Discord.
-     * @param shardId id of the shard that should send the payload.
-     * @param data Voice state update data to send.
-     * @returns Promise that's resolved once the payload was sent to Discord.
-     *
-     * @example
-     * // Connect to Discord and join a voice channel
-     * const CloudStorm = require("cloudstorm"); // CloudStorm also supports import statements.
-     * const token = "token";
-     * const client = new CloudStorm.Client(token);
-     * client.connect();
-     * client.once("ready", () => {
-     * 	// Client is connected to Discord and is ready, so we can join a voice channel.
-     * 	// We will use shard 0 as the shard to send the payload.
-     * 	client.voiceStateUpdate(0, { guild_id: "id", channel_id: "id", self_mute: false, self_deaf: false });
-     * });
-     */
-    voiceStateUpdate(shardId, data) {
-        return this.shardManager.voiceStateUpdate(shardId, data);
-    }
-    /**
-     * Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.
-     * @param shardId id of the shard that should send the payload.
-     * @param data Request guild members data to send.
-     * @returns Promise that's resolved once the payload was send to Discord.
-     *
-     * @example
-     * // Connect to Discord and request guild members.
-     * const CloudStorm = require("cloudstorm"); // CloudStorm also supports import statements.
-     * const token = "token";
-     * const client = new CloudStorm.Client(token);
-     * client.connect();
-     * client.once("ready", () => {
-     * 	// Client is connected to Discord and is ready, so we can send the request guild members payload.
-     * 	// We will use shard 0 as the shard to send the payload.
-     * 	client.requestGuildMembers(0, { guild_id: "id" });
-     * });
-     */
-    requestGuildMembers(shardId, data) {
-        if (!data.guild_id)
-            throw new Error("You need to pass a guild_id");
-        return this.shardManager.requestGuildMembers(shardId, data);
-    }
-    /**
-     * Update the endpoint shard websockets will connect to.
-     * @param gatewayUrl Base gateway wss url to update the cached endpoint to.
-     */
-    _updateEndpoint(gatewayUrl) {
-        var _a, _b;
-        this.options.endpoint = `${gatewayUrl}?v=${Constants_1.default.GATEWAY_VERSION}&encoding=${((_a = this.options.ws) === null || _a === void 0 ? void 0 : _a.encoding) === "etf" ? "etf" : "json"}${((_b = this.options.ws) === null || _b === void 0 ? void 0 : _b.compress) ? "&compress=zlib-stream" : ""}`;
-    }
-}
-Client.default = Client;
-module.exports = Client;

package/dist/Constants.d.ts

@@ -1,49 +0,0 @@
-export declare const GATEWAY_OP_CODES: {
-    /**
-     * Receive.
-     */
-    DISPATCH: 0;
-    /**
-     * Send/Receive.
-     */
-    HEARTBEAT: 1;
-    /**
-     * Send.
-     */
-    IDENTIFY: 2;
-    /**
-     * Send.
-     */
-    PRESENCE_UPDATE: 3;
-    /**
-     * Send.
-     */
-    VOICE_STATE_UPDATE: 4;
-    /**
-     * Send.
-     */
-    RESUME: 6;
-    /**
-     * Receive.
-     */
-    RECONNECT: 7;
-    /**
-     * Send.
-     */
-    REQUEST_GUILD_MEMBERS: 8;
-    /**
-     * Receive.
-     */
-    INVALID_SESSION: 9;
-    /**
-     * Receive.
-     */
-    HELLO: 10;
-    /**
-     * Receive.
-     */
-    HEARTBEAT_ACK: 11;
-};
-export declare const GATEWAY_VERSION = 10;
-declare const _default: typeof import("./Constants");
-export default _default;

package/dist/Constants.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GATEWAY_VERSION = exports.GATEWAY_OP_CODES = void 0;
-exports.GATEWAY_OP_CODES = {
-    /**
-     * Receive.
-     */
-    DISPATCH: 0,
-    /**
-     * Send/Receive.
-     */
-    HEARTBEAT: 1,
-    /**
-     * Send.
-     */
-    IDENTIFY: 2,
-    /**
-     * Send.
-     */
-    PRESENCE_UPDATE: 3,
-    /**
-     * Send.
-     */
-    VOICE_STATE_UPDATE: 4,
-    /**
-     * Send.
-     */
-    RESUME: 6,
-    /**
-     * Receive.
-     */
-    RECONNECT: 7,
-    /**
-     * Send.
-     */
-    REQUEST_GUILD_MEMBERS: 8,
-    /**
-     * Receive.
-     */
-    INVALID_SESSION: 9,
-    /**
-     * Receive.
-     */
-    HELLO: 10,
-    /**
-     * Receive.
-     */
-    HEARTBEAT_ACK: 11
-};
-exports.GATEWAY_VERSION = 10;
-exports.default = exports;

package/dist/Intents.d.ts

@@ -1,25 +0,0 @@
-export declare const flags: {
-    GUILDS: number;
-    GUILD_MEMBERS: number;
-    GUILD_BANS: number;
-    GUILD_EMOJIS_AND_STICKERS: number;
-    GUILD_INTEGRATIONS: number;
-    GUILD_WEBHOOKS: number;
-    GUILD_INVITES: number;
-    GUILD_VOICE_STATES: number;
-    GUILD_PRESENCES: number;
-    GUILD_MESSAGES: number;
-    GUILD_MESSAGE_REACTIONS: number;
-    GUILD_MESSAGE_TYPING: number;
-    DIRECT_MESSAGES: number;
-    DIRECT_MESSAGE_REACTIONS: number;
-    DIRECT_MESSAGE_TYPING: number;
-    MESSAGE_CONTENT: number;
-    GUILD_SCHEDULED_EVENTS: number;
-};
-export declare const privileged: number;
-export declare const all: number;
-export declare const non_privileged: number;
-export declare function resolve(bit?: import("./Types").IntentResolvable): number;
-declare const _default: typeof import("./Intents");
-export default _default;

package/dist/Intents.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolve = exports.non_privileged = exports.all = exports.privileged = exports.flags = void 0;
-exports.flags = {
-    GUILDS: 1 << 0,
-    GUILD_MEMBERS: 1 << 1,
-    GUILD_BANS: 1 << 2,
-    GUILD_EMOJIS_AND_STICKERS: 1 << 3,
-    GUILD_INTEGRATIONS: 1 << 4,
-    GUILD_WEBHOOKS: 1 << 5,
-    GUILD_INVITES: 1 << 6,
-    GUILD_VOICE_STATES: 1 << 7,
-    GUILD_PRESENCES: 1 << 8,
-    GUILD_MESSAGES: 1 << 9,
-    GUILD_MESSAGE_REACTIONS: 1 << 10,
-    GUILD_MESSAGE_TYPING: 1 << 11,
-    DIRECT_MESSAGES: 1 << 12,
-    DIRECT_MESSAGE_REACTIONS: 1 << 13,
-    DIRECT_MESSAGE_TYPING: 1 << 14,
-    MESSAGE_CONTENT: 1 << 15,
-    GUILD_SCHEDULED_EVENTS: 1 >> 16
-};
-exports.privileged = exports.flags.GUILD_MEMBERS | exports.flags.GUILD_PRESENCES | exports.flags.MESSAGE_CONTENT;
-exports.all = Object.values(exports.flags).reduce((acc, p) => acc | p, 0);
-exports.non_privileged = exports.all & ~exports.privileged;
-function resolve(bit = 0) {
-    if (typeof bit === "number" && bit >= 0)
-        return bit;
-    if (typeof bit === "string" && exports.flags[bit])
-        return exports.flags[bit] | 0;
-    if (Array.isArray(bit))
-        return bit.map((p) => resolve(p)).reduce((prev, p) => prev | p, 0);
-    throw new RangeError("BITFIELD_INVALID");
-}
-exports.resolve = resolve;
-exports.default = exports;

package/dist/Shard.d.ts

@@ -1,74 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from "events";
-import DiscordConnector from "./connector/DiscordConnector";
-interface ShardEvents {
-    disconnect: [number, string, boolean];
-    ready: [boolean];
-    queueIdentify: [number];
-}
-interface Shard {
-    addListener<E extends keyof ShardEvents>(event: E, listener: (...args: ShardEvents[E]) => any): this;
-    emit<E extends keyof ShardEvents>(event: E, ...args: ShardEvents[E]): boolean;
-    eventNames(): Array<keyof ShardEvents>;
-    listenerCount(event: keyof ShardEvents): number;
-    listeners(event: keyof ShardEvents): Array<(...args: Array<any>) => any>;
-    off<E extends keyof ShardEvents>(event: E, listener: (...args: ShardEvents[E]) => any): this;
-    on<E extends keyof ShardEvents>(event: E, listener: (...args: ShardEvents[E]) => any): this;
-    once<E extends keyof ShardEvents>(event: E, listener: (...args: ShardEvents[E]) => any): this;
-    prependListener<E extends keyof ShardEvents>(event: E, listener: (...args: ShardEvents[E]) => any): this;
-    prependOnceListener<E extends keyof ShardEvents>(event: E, listener: (...args: ShardEvents[E]) => any): this;
-    rawListeners(event: keyof ShardEvents): Array<(...args: Array<any>) => any>;
-    removeAllListeners(event?: keyof ShardEvents): this;
-    removeListener<E extends keyof ShardEvents>(event: E, listener: (...args: ShardEvents[E]) => any): this;
-}
-/**
- * Shard class, which provides a wrapper around the DiscordConnector with metadata like the id of the shard.
- *
- * This class is automatically instantiated by the library and is documented for reference.
- */
-declare class Shard extends EventEmitter {
-    id: number;
-    client: import("./Client");
-    ready: boolean;
-    connector: DiscordConnector;
-    static readonly default: typeof Shard;
-    /**
-     * Create a new Shard.
-     * @param id id of the shard.
-     * @param client Main class used for forwarding events.
-     */
-    constructor(id: number, client: import("./Client"));
-    /**
-     * Time in ms it took for Discord to ackknowledge an OP 1 HEARTBEAT.
-     */
-    get latency(): number;
-    /**
-     * Create a new connection to Discord.
-     */
-    connect(): void;
-    /**
-     * Close the current connection to Discord.
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Send an OP 3 PRESENCE_UPDATE to Discord.
-     * @param data Data to send.
-     */
-    presenceUpdate(data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
-    /**
-     * Send an OP 4 VOICE_STATE_UPDATE to Discord.
-     * @param data Data to send
-     */
-    voiceStateUpdate(data: import("discord-typings").VoiceStateUpdatePayload & {
-        self_deaf?: boolean;
-        self_mute?: boolean;
-    }): Promise<void>;
-    /**
-     * Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.
-     * @param data Data to send.
-     */
-    requestGuildMembers(data: import("discord-typings").GuildRequestMembersPayload & {
-        limit?: number;
-    }): Promise<void>;
-}
-export = Shard;

package/dist/Shard.js

@@ -1,87 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const events_1 = require("events");
-const DiscordConnector_1 = __importDefault(require("./connector/DiscordConnector"));
-const Constants_1 = require("./Constants");
-/**
- * Shard class, which provides a wrapper around the DiscordConnector with metadata like the id of the shard.
- *
- * This class is automatically instantiated by the library and is documented for reference.
- */
-class Shard extends events_1.EventEmitter {
-    /**
-     * Create a new Shard.
-     * @param id id of the shard.
-     * @param client Main class used for forwarding events.
-     */
-    constructor(id, client) {
-        super();
-        this.id = id;
-        this.client = client;
-        this.ready = false;
-        this.connector = new DiscordConnector_1.default(id, client);
-        this.connector.on("event", (event) => {
-            const newEvent = Object.assign(event, { shard_id: this.id });
-            this.client.emit("event", newEvent);
-            switch (event.op) {
-                case Constants_1.GATEWAY_OP_CODES.DISPATCH:
-                    this.client.emit("dispatch", newEvent);
-                    break;
-                case Constants_1.GATEWAY_OP_CODES.VOICE_STATE_UPDATE:
-                    this.client.emit("voiceStateUpdate", newEvent);
-                    break;
-                default:
-                    break;
-            }
-        });
-        this.connector.on("disconnect", (...args) => {
-            this.ready = false;
-            this.emit("disconnect", ...args);
-        });
-        this.connector.on("ready", (resume) => this.emit("ready", resume));
-        this.connector.on("queueIdentify", () => this.emit("queueIdentify", this.id));
-    }
-    /**
-     * Time in ms it took for Discord to ackknowledge an OP 1 HEARTBEAT.
-     */
-    get latency() {
-        return this.connector.latency;
-    }
-    /**
-     * Create a new connection to Discord.
-     */
-    connect() {
-        this.connector.connect();
-    }
-    /**
-     * Close the current connection to Discord.
-     */
-    disconnect() {
-        return this.connector.disconnect();
-    }
-    /**
-     * Send an OP 3 PRESENCE_UPDATE to Discord.
-     * @param data Data to send.
-     */
-    presenceUpdate(data) {
-        return this.connector.presenceUpdate(data);
-    }
-    /**
-     * Send an OP 4 VOICE_STATE_UPDATE to Discord.
-     * @param data Data to send
-     */
-    voiceStateUpdate(data) {
-        return this.connector.voiceStateUpdate(data);
-    }
-    /**
-     * Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.
-     * @param data Data to send.
-     */
-    requestGuildMembers(data) {
-        return this.connector.requestGuildMembers(data);
-    }
-}
-Shard.default = Shard;
-module.exports = Shard;

package/dist/ShardManager.d.ts

@@ -1,71 +0,0 @@
-import Shard from "./Shard";
-import RatelimitBucket from "./structures/RatelimitBucket";
-/**
- * Class used for managing shards for the user.
- *
- * This class is automatically instantiated by the library and is documented for reference.
- */
-declare class ShardManager {
-    client: import("./Client");
-    options: import("./Client")["options"];
-    shards: {
-        [id: number]: Shard;
-    };
-    identifyBucket: RatelimitBucket;
-    concurrencyBucket: RatelimitBucket | null;
-    static readonly default: typeof ShardManager;
-    /**
-     * Create a new ShardManager.
-     */
-    constructor(client: import("./Client"));
-    /**
-     * Create shard instances and add them to the connection queue.
-     */
-    spawn(): void;
-    /**
-     * Disconnect all shards facilitated by this manager.
-     */
-    disconnect(): void;
-    /**
-     * Add event listeners to a shard to that the manager can act on received events.
-     * @param shard Shard to add the event listeners to.
-     */
-    private _addListener;
-    /**
-     * Checks if all shards spawned by this manager are ready.
-     */
-    private _checkReady;
-    /**
-     * Checks if all shards spawned by this manager are disconnected.
-     */
-    private _checkDisconnect;
-    /**
-     * Update the status of all currently connected shards which have been spawned by this manager.
-     * @param data Data to send.
-     */
-    presenceUpdate(data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
-    /**
-     * Update the status of a single connected shard which has been spawned by this manager.
-     * @param shardId id of the shard.
-     * @param data Data to send.
-     */
-    shardPresenceUpdate(shardId: number, data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
-    /**
-     * Send an OP 4 VOICE_STATE_UPDATE with a certain shard.
-     * @param shardId id of the shard.
-     * @param data Data to send.
-     */
-    voiceStateUpdate(shardId: number, data: import("discord-typings").VoiceStateUpdatePayload & {
-        self_deaf?: boolean;
-        self_mute?: boolean;
-    }): Promise<void>;
-    /**
-     * Send an OP 8 REQUEST_GUILD_MEMBERS with a certain shard.
-     * @param shardId id of the shard.
-     * @param data Data to send.
-     */
-    requestGuildMembers(shardId: number, data: import("discord-typings").GuildRequestMembersPayload & {
-        limit?: number;
-    }): Promise<void>;
-}
-export = ShardManager;