@glade-chat/glade.js 0.1.0 → 0.1.1

package/README.md

@@ -12,14 +12,13 @@ A powerful, fully-typed Node.js library for the [Glade](https://glade.chat) API
 
 ## About
 
-glade.js is an object-oriented library that makes it easy to interact with Glade — Houses,
-Rooms, Messages, Members, Roles, DMs, friends, presence, and voice — over REST and the
+glade.js is an object-oriented library that makes it easy to interact with Glade - Houses,
+Rooms, Messages, Members, Roles, DMs, friends, presence, and voice - over REST and the
 real-time gateway.
 
 - Object-oriented
 - Cache-backed and event-driven
 - Handles login and token refresh for you
-- First-class TypeScript types, zero build step (pure ESM)
 
 ## Installation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glade-chat/glade.js",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A powerful Node.js library for interacting with the Glade (glade.chat) API and real-time gateway.",
   "type": "module",
   "publishConfig": {

package/src/client/Client.js

@@ -83,6 +83,7 @@ export class Client extends EventEmitter {
       onDisconnect: (reason) => this.emit(Events.Disconnect, reason),
       onError: (err) => this.#emitError(err),
       ws: this.options.ws,
+      heartbeatMs: this.options.heartbeatMs,
       debug,
     });
 

package/src/gateway/Gateway.js

@@ -21,6 +21,7 @@ export class Gateway {
    * @param {(err: Error) => void} [opts.onError]
    * @param {(msg: string) => void} [opts.debug]
    * @param {object} [opts.ws] Extra socket.io-client options.
+   * @param {number} [opts.heartbeatMs] Presence heartbeat interval; <=0 disables it.
    */
   constructor(opts) {
     this.url = opts.url;
@@ -42,6 +43,10 @@ export class Gateway {
     this._handshakeRefreshAttempts = 0;
     /** Cap on consecutive handshake refreshes to avoid a reconnect loop. */
     this._maxHandshakeRefresh = opts.maxHandshakeRefresh ?? 5;
+    /** Presence heartbeat interval (ms); the server offlines us without it. */
+    this._heartbeatMs = opts.heartbeatMs ?? 30_000;
+    /** @type {ReturnType<typeof setInterval> | null} */
+    this._heartbeatTimer = null;
   }
 
   /** Whether the underlying socket is currently connected. */
@@ -71,11 +76,13 @@ export class Gateway {
       this.id = this.socket.id;
       this._handshakeRefreshAttempts = 0;
       this.#debug(`Connected (socket ${this.id})`);
+      this.#startHeartbeat();
       this.onConnect();
     });
 
     this.socket.on('disconnect', (reason) => {
       this.#debug(`Disconnected: ${reason}`);
+      this.#stopHeartbeat();
       this.onDisconnect(reason);
     });
 
@@ -113,6 +120,7 @@ export class Gateway {
 
   /** Closes the gateway connection. */
   disconnect() {
+    this.#stopHeartbeat();
     if (this.socket) {
       this.socket.disconnect();
       this.socket = null;
@@ -120,6 +128,24 @@ export class Gateway {
     }
   }
 
+  /** Periodically tell the server we're alive so it keeps us marked online. */
+  #startHeartbeat() {
+    this.#stopHeartbeat();
+    if (!(this._heartbeatMs > 0)) return;
+    this._heartbeatTimer = setInterval(() => {
+      if (this.socket?.connected) this.socket.emit('presence:heartbeat');
+    }, this._heartbeatMs);
+    // Don't let the heartbeat keep the process alive on its own.
+    if (typeof this._heartbeatTimer.unref === 'function') this._heartbeatTimer.unref();
+  }
+
+  #stopHeartbeat() {
+    if (this._heartbeatTimer) {
+      clearInterval(this._heartbeatTimer);
+      this._heartbeatTimer = null;
+    }
+  }
+
   /**
    * Emits an event to the server without waiting for an acknowledgement.
    * @param {string} event

package/src/util/Constants.js

@@ -18,6 +18,11 @@ export const DefaultOptions = {
    * Keeps a long-running gateway connection authenticated.
    */
   refreshSkewMs: 60_000,
+  /**
+   * How often (ms) to send a presence heartbeat so the server keeps the
+   * connection marked online. Must stay below the server's liveness TTL.
+   */
+  heartbeatMs: 30_000,
   /** Whether to cache structures received from REST and the gateway. */
   cache: true,
   /**
@@ -132,6 +137,7 @@ export const GatewayCommand = {
   TypingStart: 'typing:start',
   TypingStop: 'typing:stop',
   PresenceSet: 'presence:set',
+  PresenceHeartbeat: 'presence:heartbeat',
   VoiceJoin: 'voice:join',
   VoiceLeave: 'voice:leave',
   VoiceSync: 'voice:sync',

package/types/index.d.ts

@@ -51,6 +51,8 @@ export interface ClientOptions {
   autoRefresh?: boolean;
   /** Ms before token expiry to refresh proactively. Default `60000`. */
   refreshSkewMs?: number;
+  /** Presence heartbeat interval in ms; keeps the connection marked online. Default `30000`. */
+  heartbeatMs?: number;
   /** Cache structures from REST/gateway. Default `true`. */
   cache?: boolean;
   /** Auto-subscribe to cached rooms' realtime events on ready. Default `true`. */
@@ -232,6 +234,7 @@ export class Gateway {
     debug?: (msg: string) => void;
     ws?: Record<string, unknown>;
     maxHandshakeRefresh?: number;
+    heartbeatMs?: number;
   });
   socket: Socket | null;
   id: string | null;