jmri-client 3.7.1 → 4.0.0

package/README.md

@@ -19,6 +19,7 @@ WebSocket client for [JMRI](http://jmri.sourceforge.net/) with real-time updates
 - ✅ **Heartbeat monitoring** - Automatic ping/pong keepalive
 - ✅ **TypeScript** - Full type definitions included
 - ✅ **Dual module support** - ESM and CommonJS
+- ✅ **Extensible** - Subclass `JmriClient` to add support for additional JMRI object types
 
 ## Installation
 
@@ -105,6 +106,37 @@ client.on('reconnecting', (attempt, delay) => {
 });
 ```
 
+### Extending JmriClient
+
+`JmriClient` exposes its `wsClient` as `protected`, so you can subclass it to add support for JMRI object types not yet built in (e.g., sensors, lights, routes, blocks):
+
+```typescript
+import { JmriClient } from 'jmri-client';
+import type { PartialClientOptions } from 'jmri-client';
+
+class MyExtendedClient extends JmriClient {
+  constructor(options?: PartialClientOptions) {
+    super(options);
+
+    // this.wsClient is available — use it to send/receive JMRI JSON messages
+    this.wsClient.on('update', (message: any) => {
+      if (message.type === 'sensor') {
+        this.emit('sensor:changed', message.data.name, message.data.state);
+      }
+    });
+  }
+
+  async listSensors() {
+    const response = await this.wsClient.request({ type: 'sensor', method: 'list' });
+    return Array.isArray(response?.data)
+      ? response.data.map((r: any) => r.data ?? r)
+      : [];
+  }
+}
+```
+
+`WebSocketClient` is also exported for direct use if you need it. See its `send()`, `request()`, and `on('update', ...)` API for low-level messaging.
+
 ## Testing
 
 **Unit Tests** (no hardware required):

package/dist/browser/jmri-client.js

@@ -2242,6 +2242,7 @@ export {
   MockResponseManager,
   PowerState,
   TurnoutState,
+  WebSocketClient,
   isThrottleFunctionKey,
   isValidSpeed,
   mockData,

package/dist/cjs/index.js

@@ -4,9 +4,11 @@
  * WebSocket client for JMRI with real-time updates and throttle control
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mockData = exports.mockResponseManager = exports.MockResponseManager = exports.turnoutStateToString = exports.powerStateToString = exports.isValidSpeed = exports.isThrottleFunctionKey = exports.ConnectionState = exports.TurnoutState = exports.PowerState = exports.JmriClient = void 0;
+exports.mockData = exports.mockResponseManager = exports.MockResponseManager = exports.turnoutStateToString = exports.powerStateToString = exports.isValidSpeed = exports.isThrottleFunctionKey = exports.ConnectionState = exports.TurnoutState = exports.PowerState = exports.WebSocketClient = exports.JmriClient = void 0;
 var client_js_1 = require("./client.js");
 Object.defineProperty(exports, "JmriClient", { enumerable: true, get: function () { return client_js_1.JmriClient; } });
+var websocket_client_js_1 = require("./core/websocket-client.js");
+Object.defineProperty(exports, "WebSocketClient", { enumerable: true, get: function () { return websocket_client_js_1.WebSocketClient; } });
 // Export types
 var index_js_1 = require("./types/index.js");
 // JMRI message types

package/dist/esm/index.js

@@ -3,6 +3,7 @@
  * WebSocket client for JMRI with real-time updates and throttle control
  */
 export { JmriClient } from './client.js';
+export { WebSocketClient } from './core/websocket-client.js';
 // Export types
 export { 
 // JMRI message types

package/dist/types/client.d.ts

@@ -2,6 +2,7 @@
  * Main JMRI client class
  */
 import { EventEmitter } from 'eventemitter3';
+import { WebSocketClient } from './core/websocket-client.js';
 import { PartialClientOptions } from './types/client-options.js';
 import { PowerState, RosterEntryWrapper, TurnoutState, TurnoutData } from './types/jmri-messages.js';
 import { ConnectionState } from './types/events.js';
@@ -12,7 +13,7 @@ import { ThrottleAcquireOptions, ThrottleFunctionKey, ThrottleState } from './ty
  */
 export declare class JmriClient extends EventEmitter {
     private options;
-    private wsClient;
+    protected wsClient: WebSocketClient;
     private powerManager;
     private rosterManager;
     private throttleManager;

package/dist/types/index.d.ts

@@ -3,6 +3,7 @@
  * WebSocket client for JMRI with real-time updates and throttle control
  */
 export { JmriClient } from './client.js';
+export { WebSocketClient } from './core/websocket-client.js';
 export { JmriClientOptions, PartialClientOptions, ReconnectionOptions, HeartbeatOptions, MockOptions, PowerState, TurnoutState, RosterEntry, TurnoutData, JmriMessage, PowerMessage, TurnoutMessage, ThrottleMessage, RosterMessage, ConnectionState, EventPayloads, ThrottleAcquireOptions, ThrottleFunctionKey, ThrottleState } from './types/index.js';
 export { isThrottleFunctionKey, isValidSpeed } from './types/throttle.js';
 export { powerStateToString, turnoutStateToString } from './types/jmri-messages.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmri-client",
-  "version": "3.7.1",
+  "version": "4.0.0",
   "description": "WebSocket client for JMRI with real-time updates and throttle control - works in both Node.js and browsers",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",