jmri-client 4.2.0-beta.2 → 5.1.0

package/dist/esm/managers/system-connections-manager.js

@@ -1,24 +0,0 @@
-/**
- * System connections manager — discovers available JMRI hardware connection prefixes
- */
-export class SystemConnectionsManager {
-    constructor(client) {
-        this.client = client;
-    }
-    /**
-     * List all available JMRI system connections and their prefixes.
-     * Use the returned prefix values with power and throttle commands to
-     * target a specific hardware connection when multiple are configured.
-     */
-    async getSystemConnections() {
-        const message = {
-            type: 'systemConnections',
-            method: 'list'
-        };
-        const response = await this.client.request(message);
-        if (!response.data) {
-            return [];
-        }
-        return Array.isArray(response.data) ? response.data : [response.data];
-    }
-}

package/dist/esm/managers/throttle-manager.js

@@ -1,229 +0,0 @@
-/**
- * Throttle control manager
- */
-import { EventEmitter } from 'eventemitter3';
-import { isThrottleFunctionKey, isValidSpeed } from '../types/throttle.js';
-/**
- * Manages multiple throttles
- */
-export class ThrottleManager extends EventEmitter {
-    constructor(client) {
-        super();
-        this.throttles = new Map();
-        this.client = client;
-        // Generate a unique client ID
-        this.clientId = `jmri-client-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
-        // Listen for throttle updates
-        this.client.on('update', (message) => {
-            if (message.type === 'throttle') {
-                this.handleThrottleUpdate(message);
-            }
-        });
-        // Clean up throttles on disconnect
-        this.client.on('disconnected', () => {
-            this.handleDisconnect();
-        });
-    }
-    /**
-     * Acquire a throttle for a locomotive
-     */
-    async acquireThrottle(options) {
-        // Generate a unique throttle name using client ID and address
-        const throttleName = `${this.clientId}-${options.address}`;
-        const message = {
-            type: 'throttle',
-            data: {
-                name: throttleName,
-                address: options.address,
-                ...(options.prefix !== undefined && { prefix: options.prefix })
-            }
-        };
-        const response = await this.client.request(message);
-        // JMRI returns the throttle ID in the "throttle" field, or we can use our name
-        const throttleId = response.data?.throttle || throttleName;
-        if (!throttleId) {
-            throw new Error('Failed to acquire throttle: no throttle ID returned');
-        }
-        // Initialize throttle state
-        const state = {
-            id: throttleId,
-            address: options.address,
-            speed: 0,
-            forward: true,
-            functions: new Map(),
-            acquired: true
-        };
-        this.throttles.set(throttleId, state);
-        this.emit('throttle:acquired', throttleId);
-        return throttleId;
-    }
-    /**
-     * Release a throttle
-     */
-    async releaseThrottle(throttleId) {
-        const state = this.throttles.get(throttleId);
-        if (!state) {
-            throw new Error(`Throttle not found: ${throttleId}`);
-        }
-        const message = {
-            type: 'throttle',
-            data: {
-                throttle: throttleId,
-                release: null
-            }
-        };
-        await this.client.request(message);
-        this.throttles.delete(throttleId);
-        this.emit('throttle:released', throttleId);
-    }
-    /**
-     * Set throttle speed (0.0 to 1.0)
-     */
-    async setSpeed(throttleId, speed) {
-        const state = this.throttles.get(throttleId);
-        if (!state) {
-            throw new Error(`Throttle not found: ${throttleId}`);
-        }
-        if (!isValidSpeed(speed)) {
-            throw new Error(`Invalid speed: ${speed}. Must be between 0.0 and 1.0`);
-        }
-        const message = {
-            type: 'throttle',
-            data: {
-                throttle: throttleId,
-                speed
-            }
-        };
-        // JMRI doesn't send responses for throttle control commands, just send
-        this.client.send(message);
-        state.speed = speed;
-        this.emit('throttle:updated', throttleId, { speed });
-    }
-    /**
-     * Set throttle direction
-     */
-    async setDirection(throttleId, forward) {
-        const state = this.throttles.get(throttleId);
-        if (!state) {
-            throw new Error(`Throttle not found: ${throttleId}`);
-        }
-        const message = {
-            type: 'throttle',
-            data: {
-                throttle: throttleId,
-                forward
-            }
-        };
-        // JMRI doesn't send responses for throttle control commands, just send
-        this.client.send(message);
-        state.forward = forward;
-        this.emit('throttle:updated', throttleId, { forward });
-    }
-    /**
-     * Set throttle function (F0-F28)
-     */
-    async setFunction(throttleId, functionKey, value) {
-        const state = this.throttles.get(throttleId);
-        if (!state) {
-            throw new Error(`Throttle not found: ${throttleId}`);
-        }
-        if (!isThrottleFunctionKey(functionKey)) {
-            throw new Error(`Invalid function key: ${functionKey}`);
-        }
-        const data = {
-            throttle: throttleId,
-            [functionKey]: value
-        };
-        const message = {
-            type: 'throttle',
-            data
-        };
-        // JMRI doesn't send responses for throttle control commands, just send
-        this.client.send(message);
-        state.functions.set(functionKey, value);
-        this.emit('throttle:updated', throttleId, { [functionKey]: value });
-    }
-    /**
-     * Emergency stop for a throttle (speed to 0)
-     */
-    async emergencyStop(throttleId) {
-        await this.setSpeed(throttleId, 0);
-    }
-    /**
-     * Set throttle to idle (speed to 0, maintain direction)
-     */
-    async idle(throttleId) {
-        await this.setSpeed(throttleId, 0);
-    }
-    /**
-     * Get throttle state
-     */
-    getThrottleState(throttleId) {
-        return this.throttles.get(throttleId);
-    }
-    /**
-     * Get all throttle IDs
-     */
-    getThrottleIds() {
-        return Array.from(this.throttles.keys());
-    }
-    /**
-     * Get all throttle states
-     */
-    getAllThrottles() {
-        return Array.from(this.throttles.values());
-    }
-    /**
-     * Release all throttles
-     */
-    async releaseAllThrottles() {
-        const throttleIds = this.getThrottleIds();
-        for (const throttleId of throttleIds) {
-            try {
-                await this.releaseThrottle(throttleId);
-            }
-            catch (error) {
-                // Continue releasing others even if one fails
-                this.emit('error', error);
-            }
-        }
-    }
-    /**
-     * Handle unsolicited throttle updates from JMRI
-     */
-    handleThrottleUpdate(message) {
-        const throttleId = message.data?.throttle;
-        if (!throttleId) {
-            return;
-        }
-        const state = this.throttles.get(throttleId);
-        if (!state) {
-            // Unknown throttle, possibly lost
-            this.emit('throttle:lost', throttleId);
-            return;
-        }
-        // Update state from message
-        if (message.data.speed !== undefined) {
-            state.speed = message.data.speed;
-        }
-        if (message.data.forward !== undefined) {
-            state.forward = message.data.forward;
-        }
-        // Update functions
-        for (let i = 0; i <= 28; i++) {
-            const key = `F${i}`;
-            if (message.data[key] !== undefined) {
-                state.functions.set(key, message.data[key]);
-            }
-        }
-        this.emit('throttle:updated', throttleId, message.data);
-    }
-    /**
-     * Handle disconnect - mark all throttles as not acquired
-     */
-    handleDisconnect() {
-        for (const state of this.throttles.values()) {
-            state.acquired = false;
-        }
-    }
-}

package/dist/esm/managers/turnout-manager.js

@@ -1,107 +0,0 @@
-/**
- * Turnout (switch) manager
- */
-import { EventEmitter } from 'eventemitter3';
-import { TurnoutState } from '../types/jmri-messages.js';
-/**
- * Manages JMRI turnout (track switch) state
- */
-export class TurnoutManager extends EventEmitter {
-    constructor(client) {
-        super();
-        this.turnouts = new Map();
-        this.client = client;
-        this.client.on('update', (message) => {
-            if (message.type === 'turnout') {
-                this.handleTurnoutUpdate(message);
-            }
-        });
-    }
-    /**
-     * Get the current state of a turnout.
-     * Also registers a server-side listener so subsequent changes are pushed.
-     */
-    async getTurnout(name) {
-        const message = {
-            type: 'turnout',
-            data: { name }
-        };
-        const response = await this.client.request(message);
-        const state = response.data?.state ?? TurnoutState.UNKNOWN;
-        this.turnouts.set(name, state);
-        return state;
-    }
-    /**
-     * Set a turnout to the given state
-     */
-    async setTurnout(name, state) {
-        const message = {
-            type: 'turnout',
-            method: 'post',
-            data: { name, state }
-        };
-        await this.client.request(message);
-        const oldState = this.turnouts.get(name);
-        this.turnouts.set(name, state);
-        if (oldState !== state) {
-            this.emit('turnout:changed', name, state);
-        }
-    }
-    /**
-     * Throw a turnout (diverging route)
-     */
-    async throwTurnout(name) {
-        return this.setTurnout(name, TurnoutState.THROWN);
-    }
-    /**
-     * Close a turnout (straight through / normal)
-     */
-    async closeTurnout(name) {
-        return this.setTurnout(name, TurnoutState.CLOSED);
-    }
-    /**
-     * List all turnouts known to JMRI
-     */
-    async listTurnouts() {
-        const message = {
-            type: 'turnout',
-            method: 'list'
-        };
-        const response = await this.client.request(message);
-        const entries = Array.isArray(response?.data)
-            ? response.data.map((r) => r.data ?? r)
-            : [];
-        for (const entry of entries) {
-            if (entry.name && entry.state !== undefined) {
-                this.turnouts.set(entry.name, entry.state);
-            }
-        }
-        return entries;
-    }
-    /**
-     * Get cached turnout state without a network request
-     */
-    getTurnoutState(name) {
-        return this.turnouts.get(name);
-    }
-    /**
-     * Get all cached turnout states
-     */
-    getCachedTurnouts() {
-        return new Map(this.turnouts);
-    }
-    /**
-     * Handle unsolicited turnout state updates from JMRI
-     */
-    handleTurnoutUpdate(message) {
-        const name = message.data?.name;
-        const state = message.data?.state;
-        if (!name || state === undefined)
-            return;
-        const oldState = this.turnouts.get(name);
-        this.turnouts.set(name, state);
-        if (oldState !== state) {
-            this.emit('turnout:changed', name, state);
-        }
-    }
-}

package/dist/esm/mocks/index.js

@@ -1,6 +0,0 @@
-/**
- * Mock system exports
- */
-export { MockResponseManager, mockResponseManager } from './mock-response-manager.js';
-// Re-export mock data for direct access if needed
-export { mockData } from './mock-data.js';

package/dist/esm/mocks/mock-data.js

@@ -1,234 +0,0 @@
-/**
- * Mock data for JMRI responses
- * Used for testing and demo mode
- */
-export const mockData = {
-    "hello": {
-        "type": "hello",
-        "data": {
-            "JMRI": "5.9.2",
-            "json": "5.0",
-            "version": "v5",
-            "heartbeat": 13500,
-            "railroad": "Demo Railroad",
-            "node": "jmri-server",
-            "activeProfile": "Demo Profile"
-        }
-    },
-    "power": {
-        "get": {
-            "on": {
-                "type": "power",
-                "data": {
-                    "state": 2
-                }
-            },
-            "off": {
-                "type": "power",
-                "data": {
-                    "state": 4
-                }
-            }
-        },
-        "post": {
-            "success": {
-                "type": "power",
-                "data": {
-                    "state": 2
-                }
-            }
-        }
-    },
-    "roster": {
-        "list": [
-            {
-                "type": "rosterEntry",
-                "data": {
-                    "name": "CSX754",
-                    "address": "754",
-                    "isLongAddress": true,
-                    "road": "CSX",
-                    "number": "754",
-                    "mfg": "Athearn",
-                    "decoderModel": "DH163D",
-                    "decoderFamily": "Digitrax DH163",
-                    "model": "GP38-2",
-                    "comment": "Blue and yellow scheme",
-                    "maxSpeedPct": 100,
-                    "image": null,
-                    "icon": "/roster/CSX754/icon",
-                    "shuntingFunction": "",
-                    "owner": "",
-                    "dateModified": "2026-02-10T00:00:00.000+00:00",
-                    "functionKeys": [
-                        { "name": "F0", "label": "Headlight", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F1", "label": "Bell", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F2", "label": "Horn", "lockable": false, "icon": null, "selectedIcon": null },
-                        { "name": "F3", "label": null, "lockable": false, "icon": null, "selectedIcon": null },
-                        { "name": "F4", "label": "Dynamic Brake", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F5", "label": null, "lockable": false, "icon": null, "selectedIcon": null }
-                    ],
-                    "attributes": [],
-                    "rosterGroups": []
-                },
-                "id": 1
-            },
-            {
-                "type": "rosterEntry",
-                "data": {
-                    "name": "UP3985",
-                    "address": "3985",
-                    "isLongAddress": true,
-                    "road": "Union Pacific",
-                    "number": "3985",
-                    "mfg": "Rivarossi",
-                    "decoderModel": "Sound decoder",
-                    "decoderFamily": "ESU LokSound",
-                    "model": "Challenger 4-6-6-4",
-                    "comment": "Steam locomotive",
-                    "maxSpeedPct": 100,
-                    "image": null,
-                    "icon": "/roster/UP3985/icon",
-                    "shuntingFunction": "",
-                    "owner": "",
-                    "dateModified": "2026-02-10T00:00:00.000+00:00",
-                    "functionKeys": [
-                        { "name": "F0", "label": "Headlight", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F1", "label": "Bell", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F2", "label": "Whistle", "lockable": false, "icon": null, "selectedIcon": null },
-                        { "name": "F3", "label": "Steam", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F4", "label": null, "lockable": false, "icon": null, "selectedIcon": null }
-                    ],
-                    "attributes": [],
-                    "rosterGroups": []
-                },
-                "id": 2
-            },
-            {
-                "type": "rosterEntry",
-                "data": {
-                    "name": "BNSF5240",
-                    "address": "5240",
-                    "isLongAddress": true,
-                    "road": "BNSF",
-                    "number": "5240",
-                    "mfg": "Kato",
-                    "decoderModel": "DCC Sound",
-                    "decoderFamily": "Kato",
-                    "model": "SD40-2",
-                    "comment": "Heritage II paint",
-                    "maxSpeedPct": 100,
-                    "image": null,
-                    "icon": "/roster/BNSF5240/icon",
-                    "shuntingFunction": "",
-                    "owner": "",
-                    "dateModified": "2026-02-10T00:00:00.000+00:00",
-                    "functionKeys": [
-                        { "name": "F0", "label": "Headlight", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F1", "label": "Bell", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F2", "label": "Horn", "lockable": false, "icon": null, "selectedIcon": null },
-                        { "name": "F3", "label": "Dynamic Brake", "lockable": true, "icon": null, "selectedIcon": null },
-                        { "name": "F4", "label": null, "lockable": false, "icon": null, "selectedIcon": null },
-                        { "name": "F5", "label": "Mars Light", "lockable": true, "icon": null, "selectedIcon": null }
-                    ],
-                    "attributes": [],
-                    "rosterGroups": []
-                },
-                "id": 3
-            }
-        ]
-    },
-    "throttle": {
-        "acquire": {
-            "success": {
-                "type": "throttle",
-                "data": {
-                    "throttle": "{THROTTLE_ID}",
-                    "address": "{ADDRESS}",
-                    "speed": 0,
-                    "forward": true,
-                    "F0": false,
-                    "F1": false,
-                    "F2": false,
-                    "F3": false,
-                    "F4": false
-                }
-            }
-        },
-        "release": {
-            "success": {
-                "type": "throttle",
-                "data": {}
-            }
-        },
-        "control": {
-            "speed": {
-                "type": "throttle",
-                "data": {
-                    "throttle": "{THROTTLE_ID}",
-                    "speed": "{SPEED}"
-                }
-            },
-            "direction": {
-                "type": "throttle",
-                "data": {
-                    "throttle": "{THROTTLE_ID}",
-                    "forward": "{FORWARD}"
-                }
-            },
-            "function": {
-                "type": "throttle",
-                "data": {
-                    "throttle": "{THROTTLE_ID}",
-                    "{FUNCTION}": "{VALUE}"
-                }
-            }
-        }
-    },
-    "light": {
-        "list": [
-            { "type": "light", "data": { "name": "IL1", "userName": "Yard Light", "comment": null, "properties": [], "state": 4 } },
-            { "type": "light", "data": { "name": "IL2", "userName": "Platform Light", "comment": null, "properties": [], "state": 4 } },
-            { "type": "light", "data": { "name": "IL3", "userName": "Signal Lamp", "comment": null, "properties": [], "state": 2 } }
-        ]
-    },
-    "turnout": {
-        "list": [
-            { "type": "turnout", "data": { "name": "LT1", "userName": "Main Diverge", "state": 2 } },
-            { "type": "turnout", "data": { "name": "LT2", "userName": "Yard Lead", "state": 2 } },
-            { "type": "turnout", "data": { "name": "LT3", "userName": "Siding Entry", "state": 4 } }
-        ]
-    },
-    "ping": {
-        "type": "ping"
-    },
-    "pong": {
-        "type": "pong"
-    },
-    "goodbye": {
-        "type": "goodbye"
-    },
-    "error": {
-        "throttleNotFound": {
-            "type": "error",
-            "data": {
-                "code": 404,
-                "message": "Throttle not found"
-            }
-        },
-        "invalidSpeed": {
-            "type": "error",
-            "data": {
-                "code": 400,
-                "message": "Invalid speed value"
-            }
-        },
-        "connectionError": {
-            "type": "error",
-            "data": {
-                "code": 500,
-                "message": "Connection error"
-            }
-        }
-    }
-};