gameglue 4.0.0 → 4.0.2

package/src/listener.js

@@ -1,193 +1,196 @@
-import EventEmitter from 'event-emitter';
-import { getGameSchema, normalizeTelemetry } from '@gameglue/schemas';
-
-export class Listener  {
-  constructor(socket, config) {
-    this._config = config;
-    this._socket = socket;
-    this._callbacks = [];
-    this._fields = config.fields ? [...config.fields] : null;
-    this._gameSchema = getGameSchema(config.gameId);
-  }
-
-  async establishConnection() {
-    if (!this._socket || !this._config.userId || !this._config.gameId) {
-      throw new Error('Missing arguments in establishConnection');
-    }
-    return new Promise((resolve) => {
-      // Use object format if fields are specified, otherwise use legacy string format
-      let listenPayload;
-      if (this._fields) {
-        listenPayload = {
-          userId: this._config.userId,
-          gameId: this._config.gameId,
-          fields: this._fields
-        };
-      } else {
-        listenPayload = `${this._config.userId}:${this._config.gameId}`;
-      }
-
-      this._socket.timeout(5000).emit('listen', listenPayload, (error, response) => {
-        if (error) {
-          return resolve({status: 'failed', reason: 'Listen request timed out.'});
-        }
-        if (response.status === 'success') {
-          return resolve({status: 'success'});
-        } else {
-          return resolve({status: 'failed', reason: response.reason});
-        }
-      });
-    });
-  }
-
-  setupEventListener() {
-    // Listen for telemetry updates
-    this._socket.on('update', (payload) => {
-      const rawData = payload?.data;
-
-      // Normalize telemetry to canonical field names
-      const normalizedData = rawData && this._gameSchema
-        ? normalizeTelemetry(rawData, this._gameSchema)
-        : rawData;
-
-      // Apply client-side field filtering on normalized data
-      let filteredData = normalizedData;
-      if (this._fields && this._fields.length > 0 && normalizedData) {
-        filteredData = {};
-        for (const field of this._fields) {
-          if (field in normalizedData) {
-            filteredData[field] = normalizedData[field];
-          }
-        }
-      }
-
-      // Emit with both raw and normalized data
-      this.emit('update', {
-        ...payload,
-        raw: rawData,
-        data: filteredData
-      });
-    });
-
-    // Listen for derived events (landing, takeoff, flight_phase, etc.)
-    this._socket.on('key-events', (payload) => {
-      const { gameId, eventType, data } = payload || {};
-
-      // Only emit events for our game
-      if (gameId !== this._config.gameId) {
-        return;
-      }
-
-      // Emit specific event type (landing, takeoff, flight_phase)
-      if (eventType && data) {
-        this.emit(eventType, data);
-      }
-    });
-
-    return this;
-  }
-
-  /**
-   * Subscribe to additional fields dynamically
-   * @param {string[]} fields - Array of field names to add
-   * @returns {Promise<{status: string, reason?: string}>}
-   */
-  async subscribe(fields) {
-    if (!Array.isArray(fields) || fields.length === 0) {
-      throw new Error('fields must be a non-empty array');
-    }
-
-    // Add new fields to existing list
-    if (!this._fields) {
-      this._fields = [...fields];
-    } else {
-      for (const field of fields) {
-        if (!this._fields.includes(field)) {
-          this._fields.push(field);
-        }
-      }
-    }
-
-    return this._updateSubscription();
-  }
-
-  /**
-   * Unsubscribe from specific fields
-   * @param {string[]} fields - Array of field names to remove
-   * @returns {Promise<{status: string, reason?: string}>}
-   */
-  async unsubscribe(fields) {
-    if (!Array.isArray(fields) || fields.length === 0) {
-      throw new Error('fields must be a non-empty array');
-    }
-
-    if (!this._fields) {
-      // Currently receiving all fields, create explicit list without these fields
-      throw new Error('Cannot unsubscribe when receiving all fields. Use subscribe() first to set explicit field list.');
-    }
-
-    this._fields = this._fields.filter(f => !fields.includes(f));
-
-    return this._updateSubscription();
-  }
-
-  /**
-   * Get the current list of subscribed fields
-   * @returns {string[]|null} - Array of field names, or null if receiving all fields
-   */
-  getFields() {
-    return this._fields ? [...this._fields] : null;
-  }
-
-  /**
-   * Send a command to the broadcaster (game client)
-   * @param {string} command - The canonical command name (e.g., 'gear_up', 'set_autopilot_heading')
-   * @param {any} value - The value to set (optional for toggle commands)
-   * @returns {Promise<{status: string, reason?: string}>}
-   */
-  async sendCommand(command, value) {
-    if (!command || typeof command !== 'string') {
-      throw new Error('command must be a non-empty string');
-    }
-
-    return new Promise((resolve) => {
-      const payload = {
-        userId: this._config.userId,
-        gameId: this._config.gameId,
-        data: {
-          fieldName: command,
-          value
-        }
-      };
-
-      this._socket.timeout(5000).emit('set', payload, (error, response) => {
-        if (error) {
-          return resolve({ status: 'failed', reason: 'Command request timed out.' });
-        }
-        return resolve(response);
-      });
-    });
-  }
-
-  /**
-   * Internal method to send subscription update to server
-   */
-  async _updateSubscription() {
-    return new Promise((resolve) => {
-      const payload = {
-        userId: this._config.userId,
-        gameId: this._config.gameId,
-        fields: this._fields
-      };
-
-      this._socket.timeout(5000).emit('listen-update', payload, (error, response) => {
-        if (error) {
-          return resolve({status: 'failed', reason: 'Update request timed out.'});
-        }
-        return resolve(response);
-      });
-    });
-  }
-}
-
-EventEmitter(Listener.prototype);
+import EventEmitter from 'event-emitter';
+import { getGameSchema, normalizeTelemetry } from '@gameglue/schemas';
+
+export class Listener  {
+  constructor(socket, config) {
+    this._config = config;
+    this._socket = socket;
+    this._callbacks = [];
+    this._fields = config.fields ? [...config.fields] : null;
+    this._gameSchema = getGameSchema(config.gameId);
+  }
+
+  async establishConnection() {
+    if (!this._socket || !this._config.userId || !this._config.gameId) {
+      throw new Error('Missing arguments in establishConnection');
+    }
+    return new Promise((resolve) => {
+      // Use object format if fields are specified, otherwise use legacy string format
+      let listenPayload;
+      if (this._fields) {
+        listenPayload = {
+          userId: this._config.userId,
+          gameId: this._config.gameId,
+          fields: this._fields
+        };
+      } else {
+        listenPayload = `${this._config.userId}:${this._config.gameId}`;
+      }
+
+      this._socket.timeout(5000).emit('listen', listenPayload, (error, response) => {
+        if (error) {
+          return resolve({status: 'failed', reason: 'Listen request timed out.'});
+        }
+        if (response.status === 'success') {
+          return resolve({status: 'success'});
+        } else {
+          return resolve({status: 'failed', reason: response.reason});
+        }
+      });
+    });
+  }
+
+  setupEventListener() {
+    // Listen for telemetry updates
+    this._socket.on('update', (payload) => {
+      // Filter events by gameId when present (multiple listeners share one socket)
+      if (payload?.gameId && payload.gameId !== this._config.gameId) return;
+
+      const rawData = payload?.data;
+
+      // Normalize telemetry to canonical field names
+      const normalizedData = rawData && this._gameSchema
+        ? normalizeTelemetry(rawData, this._gameSchema)
+        : rawData;
+
+      // Apply client-side field filtering on normalized data
+      let filteredData = normalizedData;
+      if (this._fields && this._fields.length > 0 && normalizedData) {
+        filteredData = {};
+        for (const field of this._fields) {
+          if (field in normalizedData) {
+            filteredData[field] = normalizedData[field];
+          }
+        }
+      }
+
+      // Emit with both raw and normalized data
+      this.emit('update', {
+        ...payload,
+        raw: rawData,
+        data: filteredData
+      });
+    });
+
+    // Listen for derived events (landing, takeoff, flight_phase, etc.)
+    this._socket.on('key-events', (payload) => {
+      const { gameId, eventType, data } = payload || {};
+
+      // Only emit events for our game
+      if (gameId !== this._config.gameId) {
+        return;
+      }
+
+      // Emit specific event type (landing, takeoff, flight_phase)
+      if (eventType && data) {
+        this.emit(eventType, data);
+      }
+    });
+
+    return this;
+  }
+
+  /**
+   * Subscribe to additional fields dynamically
+   * @param {string[]} fields - Array of field names to add
+   * @returns {Promise<{status: string, reason?: string}>}
+   */
+  async subscribe(fields) {
+    if (!Array.isArray(fields) || fields.length === 0) {
+      throw new Error('fields must be a non-empty array');
+    }
+
+    // Add new fields to existing list
+    if (!this._fields) {
+      this._fields = [...fields];
+    } else {
+      for (const field of fields) {
+        if (!this._fields.includes(field)) {
+          this._fields.push(field);
+        }
+      }
+    }
+
+    return this._updateSubscription();
+  }
+
+  /**
+   * Unsubscribe from specific fields
+   * @param {string[]} fields - Array of field names to remove
+   * @returns {Promise<{status: string, reason?: string}>}
+   */
+  async unsubscribe(fields) {
+    if (!Array.isArray(fields) || fields.length === 0) {
+      throw new Error('fields must be a non-empty array');
+    }
+
+    if (!this._fields) {
+      // Currently receiving all fields, create explicit list without these fields
+      throw new Error('Cannot unsubscribe when receiving all fields. Use subscribe() first to set explicit field list.');
+    }
+
+    this._fields = this._fields.filter(f => !fields.includes(f));
+
+    return this._updateSubscription();
+  }
+
+  /**
+   * Get the current list of subscribed fields
+   * @returns {string[]|null} - Array of field names, or null if receiving all fields
+   */
+  getFields() {
+    return this._fields ? [...this._fields] : null;
+  }
+
+  /**
+   * Send a command to the broadcaster (game client)
+   * @param {string} command - The canonical command name (e.g., 'gear_up', 'set_autopilot_heading')
+   * @param {any} value - The value to set (optional for toggle commands)
+   * @returns {Promise<{status: string, reason?: string}>}
+   */
+  async sendCommand(command, value) {
+    if (!command || typeof command !== 'string') {
+      throw new Error('command must be a non-empty string');
+    }
+
+    return new Promise((resolve) => {
+      const payload = {
+        userId: this._config.userId,
+        gameId: this._config.gameId,
+        data: {
+          fieldName: command,
+          value
+        }
+      };
+
+      this._socket.timeout(5000).emit('set', payload, (error, response) => {
+        if (error) {
+          return resolve({ status: 'failed', reason: 'Command request timed out.' });
+        }
+        return resolve(response);
+      });
+    });
+  }
+
+  /**
+   * Internal method to send subscription update to server
+   */
+  async _updateSubscription() {
+    return new Promise((resolve) => {
+      const payload = {
+        userId: this._config.userId,
+        gameId: this._config.gameId,
+        fields: this._fields
+      };
+
+      this._socket.timeout(5000).emit('listen-update', payload, (error, response) => {
+        if (error) {
+          return resolve({status: 'failed', reason: 'Update request timed out.'});
+        }
+        return resolve(response);
+      });
+    });
+  }
+}
+
+EventEmitter(Listener.prototype);