@synapticon/motion-master-client 2.3.0-beta.0 → 6.0.0-alpha.22

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Synapticon GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/client.d.ts

@@ -0,0 +1,20 @@
+import { Api } from './generated/Api.js';
+import type { ApiConfig } from './generated/http-client.js';
+import { type MmpdFile } from './mmpd.js';
+import { WebSocketConnection, type WebSocketConstructor } from './web-socket-connection.js';
+export interface MotionMasterClientOptions {
+    baseUrl?: string;
+    wsUrl?: string;
+    WebSocket?: WebSocketConstructor;
+    webSocketOptions?: unknown;
+    customFetch?: ApiConfig['customFetch'];
+}
+export declare class MotionMasterClient {
+    readonly api: Api;
+    readonly ws: WebSocketConnection;
+    private readonly httpBaseUrl;
+    private readonly customFetch?;
+    constructor(options?: MotionMasterClientOptions);
+    fetchProcessDataDump(signal?: AbortSignal): Promise<MmpdFile>;
+    close(): void;
+}

package/dist/client.js

@@ -0,0 +1,37 @@
+// The MotionMasterClient facade: a single connection object that composes the generated HTTP API
+// (`client.api.*`, flat — e.g. `client.api.getVersion()`) with the WebSocket connection
+// (`client.ws`). It is a *connection, not a model*: it holds no mutable device/parameter/AL state
+// — the HTTP API and the monitoring stream are the source of truth. Isomorphic: pass `WebSocket`
+// (and `customFetch`) to run under Node; both default to the platform globals in the browser.
+import { Api } from './generated/Api.js';
+import { API_BASE_URL, WS_URL } from './constants.js';
+import { fetchProcessDataDump } from './mmpd.js';
+import { WebSocketConnection } from './web-socket-connection.js';
+export class MotionMasterClient {
+    /// The generated HTTP API client. Flat method surface: `client.api.getVersion()`,
+    /// `client.api.scan()`, `client.api.sdoUpload(...)`, ...
+    api;
+    /// The WebSocket connection: `client.ws.subscribe(topic, cb)`,
+    /// `client.ws.onNotification(cb)`, `client.ws.onProgress(cb)`. Connects lazily.
+    ws;
+    httpBaseUrl;
+    customFetch;
+    constructor(options = {}) {
+        this.httpBaseUrl = options.baseUrl ?? API_BASE_URL;
+        this.customFetch = options.customFetch;
+        this.api = new Api({ baseUrl: this.httpBaseUrl, customFetch: options.customFetch });
+        this.ws = new WebSocketConnection({
+            url: options.wsUrl ?? WS_URL,
+            WebSocket: options.WebSocket,
+            protocolsOrOptions: options.webSocketOptions,
+        });
+    }
+    /// Fetches and parses the live recorder dump (`GET /api/process-data/dump`) as an `MmpdFile`.
+    fetchProcessDataDump(signal) {
+        return fetchProcessDataDump(this.httpBaseUrl, { fetch: this.customFetch, signal });
+    }
+    /// Closes the WebSocket connection (and cancels reconnection). The HTTP API needs no teardown.
+    close() {
+        this.ws.close();
+    }
+}

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const API_BASE_URL = "https://local.motion-master.synapticon.com:61447";
+export declare const WS_URL = "wss://local.motion-master.synapticon.com:62281";

package/dist/constants.js

@@ -0,0 +1,8 @@
+// Default endpoints for a Motion Master instance running on the same machine as the client. The
+// bundled Let's Encrypt cert is for `local.motion-master.synapticon.com`, which resolves to
+// 127.0.0.1, so these work out of the box for a localhost install. Override both via
+// `MotionMasterClient` options for a remote/LAN deployment.
+export const API_BASE_URL = 'https://local.motion-master.synapticon.com:61447';
+// The WebSocket connection runs on its own port/loop (separate from the HTTP API) so a slow HTTP
+// request can never stall the monitoring/notification stream.
+export const WS_URL = 'wss://local.motion-master.synapticon.com:62281';