Guilded-Bot-Docs/classes_client_webSocket.js.html at master · Guilded-Bot-NPM/Guilded-Bot-Docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>classes/client/webSocket.js - Documentation</title>

    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
  <div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Tutorials</li><li class="nav-item"><a href="tutorial-example-bot.html">Example Bot</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Client.html">Client</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Client.html#login">login</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ClientWebSocket.html">ClientWebSocket</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ClientWebSocket.html#connect">connect</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Member.html">Member</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="MemberBan.html">MemberBan</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="MemberRemove.html">MemberRemove</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="MemberUpdated.html">MemberUpdated</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Message.html">Message</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Message.html#delete">delete</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Message.html#edit">edit</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Message.html#getMember">getMember</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Message.html#getUser">getUser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Message.html#react">react</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Message.html#reply">reply</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="MessageEmbed.html">MessageEmbed</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#addField">addField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setAuthor">setAuthor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setColor">setColor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setDescription">setDescription</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setFields">setFields</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setFooter">setFooter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setImage">setImage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setThumbnail">setThumbnail</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setTimestamp">setTimestamp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setTitle">setTitle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="MessageEmbed.html#setURL">setURL</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Reaction.html">Reaction</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="User.html">User</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#getAvatarURL">getAvatarURL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#getBannerURL">getBannerURL</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="UserSummary.html">UserSummary</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Webhook.html">Webhook</a></span></li><li class="nav-heading">Events</li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:closed">closed</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:debug">debug</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:destroy">destroy</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:error">error</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:memberBan">memberBan</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:memberJoin">memberJoin</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:memberLeave">memberLeave</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:memberRoleUpdate">memberRoleUpdate</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:memberUnban">memberUnban</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:memberUpdate">memberUpdate</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:message">message</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:messageDelete">messageDelete</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:messageUpdate">messageUpdate</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:reactionAdd">reactionAdd</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:reactionRemove">reactionRemove</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:ready">ready</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:webhookCreate">webhookCreate</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Client.html#event:webhookUpdate">webhookUpdate</a></span></li>
</nav>

<div id="main">

    <h1 class="page-title">classes/client/webSocket.js</h1>


    <section>
        <article>
            <pre class="prettyprint source linenums"><code>const { EventEmitter } = require("events");
const { WebSocket } = require("ws");
const Message = require("../structures/message.js");
const User = require("../structures/user/user.js");
const Member = require("../structures/member/member.js");
const MemberRemoved = require("../structures/member/memberRemove.js");
const MemberBan = require("../structures/member/memberBan.js");
const Webhook = require("../structures/webhook.js");
const Reaction = require("../structures/reaction.js");
const MemberUpdated = require("../structures/member/memberUpdated.js");
const RolesUpdated = require("../structures/roles/rolesUpdated.js");

const { version } = require("../../../package.json");

/**
 * The ClientWebSocket class
 * @class ClientWebSocket
 * @extends EventEmitter
 * @param {Client} client The client object
 * @returns {ClientWebSocket} The ClientWebSocket object
 * @constructor
 * @private
 */
class ClientWebSocket extends EventEmitter {
  /**
   * Create a new WebSocket connection
   * @param {Client} client
   * @returns {ClientWebSocket}
   * @constructor
   * @private
   */
  constructor(client) {
    super();

    /**
     * The WebSocket connection
     * @type {WebSocket}
     * @private
     */
    this.ws = null;

    /**
     * The client object
     * @type {Client}
     * @private
     */
    this.client = client;

    /**
     * The heartbeat interval
     * @type {Number}
     * @private
     */
    this.heartbeatInterval = null;

    /**
     * The last heartbeat sent
     * @type {Number}
     * @private
     * @readonly
     */
    this.lastHeartbeat = null;

    /**
     * The last heartbeat acknowledged
     * @type {Number}
     * @private
     * @readonly
     */
    this.lastHeartbeatAck = null;

    /**
     * The last heartbeat received
     * @type {Number}
     * @private
     * @readonly
     */
    this.lastHeartbeatReceived = null;

    /**
     * Number of max tries to reconnect
     * @type {Number}
     * @private
     * @readonly
     * @default Infinity
     */
    this.reconnectTries = client.options?.maxReconnectTries || Infinity;

    /**
     * The current number of tries to reconnect
     * @type {Number}
     * @private
     * @readonly
     */
    this.currentReconnectTries = 0;

    //The version of the library
    this.client.version = version;
    // The platform the bot is running on, convert like this: process.platform === 'win32' ? 'Windows' : process.platform === 'darwin' ? 'MacOS' : 'Linux'
    this.client.platform =
      process.platform === "win32"
        ? "Windows"
        : process.platform === "darwin"
        ? "MacOS"
        : "Linux";

    /**
     * Whether the WebSocket is connected or not
     * @type {boolean}
     * @private
     * @readonly
     */
    this.connected = false;

    /**
     * The bot's ID
     * @type {string}
     * @private
     */
    this.botID = null;

    global.cache = new Map();
    global.cache.users = new Map();
    global.cache.members = new Map();

    /**
     * The bot cache object
     * @type {Map}
     * @private
     */
    this.client.cache = global.cache;
  }

  /**
   * Connects the bot to the Guilded API
   * @returns {Promise&lt;void>}
   * @private
   * @example
   * client.ws.connect();
   * @example
   * client.ws.connect().then(() => {
   *   console.log('Bot is ready!');
   * });
   */
  async connect() {
    const token = this.client.token;

    try {
      this.ws = new WebSocket(`wss://www.guilded.gg/websocket/v1`, {
        headers: {
          Authorization: `Bearer ${token}`,
          "User-Agent": `Guilded-Bot/${this.client.version} (${this.client.platform}) Node.js (${process.version})`,
        },
      });
    } catch (err) {
      //If the error is the link being invalid, throw a new error
      if (err.message === "Invalid WebSocket frame: invalid status code 400")
        throw new Error(
          "Invalid token! Please make sure you are using a valid token."
        );
      //If the error is the token being invalid, throw a new error
      if (err.message === "Invalid WebSocket frame: invalid status code 401")
        throw new Error(
          "Invalid token! Please make sure you are using a valid token."
        );
      this.emit("clientDebug", "[WS] Error connecting to Guilded WebSocket");
      this.emit("clientError", err);

      // return this.connect(); wait for the new reconnect system

      await new Promise((resolve) => setTimeout(resolve, this.currentReconnectTries * 5000));

      this.currentReconnectTries++;

      if (this.currentReconnectTries >= this.reconnectTries) {
        this.emit("clientDebug", "[WS] Max reconnect tries reached");
        this.emit("clientError", err);
        return;
      }

      this.emit("clientDebug", "[WS] Reconnecting...");
      this.connect();
    }

    this.ws.on("open", () => {
      this.emit("clientDebug", "[WS] Connected to the Guilded API");
      this.connected = true;
    });

    this.ws.on("message", (data) => {
      if (JSON.parse(data).op === 1) {
        this.client.user = JSON.parse(data).d.user;
        this.client.readyAt = new Date().getTime();

        this.client.uptime = () => {
          return Math.round(
            (new Date().getTime() - this.client.readyAt) / 1000
          );
        };

        let allData = JSON.parse(data).d;
        let bot_data = JSON.parse(data).d.user;
        this.botID = toString(bot_data.id);
        bot_data.user = new User(bot_data, this.client);
        this.heartbeatInterval = allData.heartbeatIntervalMs;
        this.emit("clientDebug", "[WS] Received bot data");
        this.emit("clientDebug", "[WS] Sending first heartbeat");
        this.ws.ping(
          JSON.stringify({
            op: 1,
            d: {
              heartbeatIntervalMs: this.heartbeatInterval,
            }
          })
        );
        this.lastHeartbeat = new Date().getTime();
        this.lastHeartbeatAck = new Date().getTime();
        this.emit("clientReady", allData);
        const heartbeat = setInterval(async () => {
          if (!this.lastHeartbeatAck &amp;&amp; !this.heartbeatInterval) return;
          if (
            new Date().getTime() - this.lastHeartbeat >
            this.heartbeatInterval + 2500
          ) {
            this.emit("clientDebug", "[WS] No heartbeat ack");
            this.emit("clientDebug", "[WS] Reconnecting");
            clearInterval(heartbeat);
            this.heartbeatInterval = null;
            this.connected = false;
            this.ws.close();

            // Wait the this.currentReconnectTries * 5000 before reconnecting
            if (this.currentReconnectTries &lt; this.reconnectTries) {
              this.currentReconnectTries++;
              await new Promise((r) => setTimeout(r, this.currentReconnectTries * 5000));
              this.connect();
            } else {
              this.emit("clientDebug", "[WS] Max reconnect tries reached");
              this.emit("clientError", new Error("Max reconnect tries reached"));
              return;
            }
          }

          this.emit("clientDebug", "[WS] Sending heartbeat");
          this.ws.ping(
            JSON.stringify({
              op: 1,
              d: null,
            })
          );
          this.lastHeartbeat = new Date().getTime();
          this.lastHeartbeatAck = null;
        }, this.heartbeatInterval);
      }
    });

    this.ws.on("message", (data) => {
      const { t: eventType, d: eventData } = JSON.parse(data);

      switch (eventType) {
        case "ChatMessageCreated":
          if (eventData.message.createdBy === this.botID) break;
          this.emit(
            "messageCreated",
            new Message(eventData.message, this.client)
          );
          break;
        case "ChatMessageUpdated":
          if (eventData.message.createdBy === this.botID) break;
          this.emit(
            "messageUpdated",
            new Message(eventData.message, this.client)
          );
          break;
        case "ChatMessageDeleted":
          if (eventData.message.createdBy === this.botID) break;
          this.emit(
            "messageDeleted",
            new Message(eventData.message, this.client)
          );
          break;
        case "TeamMemberJoined":
          eventData.member.serverId = eventData.serverId;
          this.emit("memberAdded", new Member(eventData.member, this.client));
          break;
        case "TeamMemberRemoved":
          this.emit("memberRemoved", new MemberRemoved(eventData, this.client));
          break;
        case "TeamMemberBanned":
          this.emit("memberBanned", new MemberBan(eventData, this.client));
          break;
        case "TeamMemberUnbanned":
          this.emit("memberUnbanned", new MemberBan(eventData, this.client));
          break;
        case "TeamMemberUpdated":
          this.emit("memberUpdated", new MemberUpdated(eventData, this.client));
          break;
        case "teamRolesUpdated":
          this.emit("memberRolesUpdated", new RolesUpdated(eventData, this.client));
          break;
        case "TeamWebhookCreated":
          this.emit("webhookCreated", new Webhook(eventData));
          break;
        case "TeamWebhookUpdated":
          this.emit("webhookUpdated", new Webhook(eventData));
          break;
        case "ChannelMessageReactionCreated":
          this.emit("messageReactionCreated", new Reaction(eventData));
        case "ChannelMessageReactionDeleted":
          this.emit("messageReactionDeleted", new Reaction(eventData));
      }
    });

    this.ws.on("pong", (response) => {
      const r = JSON.parse(response);
      if (r.op === 1) {
        this.emit("clientDebug", "[WS] Received heartbeat");
        this.lastHeartbeatAck = new Date().getTime();
      }

      if (r.op === 8) {
        this.emit("clientDebug", "[WS] Failed to send heartbeat");
        this.emit("clientError", new Error("Failed to send heartbeat"));
      }
    });

    this.ws.on("close", () => {
      this.connected = false;
      this.emit("debug", "[WS] Disconnected from the Guilded API");
      // Try to reconnect
      this.emit("debug", "[WS] Attempting to reconnect...");
      this.connect();
    });

    this.ws.on("error", (error) => {
      this.emit("clientError", error);
    });
  }
}

module.exports = ClientWebSocket;
</code></pre>
        </article>
    </section>


</div>

<br class="clear">

<footer>
    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Oct 08 2022 01:54:14 GMT-0500 (hora estándar de Colombia) using the Minami theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>