@filamind-app/core 0.1.1 → 0.1.3

package/README.md

@@ -16,7 +16,9 @@ The shared foundation of the FilaMind suite — **framework-agnostic TypeScript*
 | `state/printer.ts` | `PrinterState` — merge-patch from `notify_status_update`, **1 s coalescing + `motion_report` fast-path** |
 | `moonraker/connector.ts` | the backend-agnostic `Connector` seam (Moonraker first; remote/others later) |
 | `moonraker/client.ts` | `MoonrakerClient` — reconnecting JSON-RPC WS (**injectable socket**, backoff **+ jitter + max-attempts**), id-correlated, notify fan-out, re-subscribe on reconnect, **REST file channel** (`upload`/`download`) |
+| `moonraker/discovery.ts` | **zero-config endpoint discovery** — `resolveMoonrakerUrl()` races candidate endpoints (same-origin proxy / direct `:7125` / localhost) → first to open wins; runtime `override` short-circuits. Socket-injectable |
 | `moonraker/subscriptions.ts` | the **versioned** canonical subscription contract — `NARROW_STATUS` / `FULL_CONTROL` tiers + `tier()` |
+| `moonraker/rpc-types.ts` | **RPC type safety** — `RpcError` (keeps JSON-RPC `code`/`data`) · `MoonrakerMethods` typed-`call` result map · `NotifyEvent` + `parseNotifyEvent()` discriminated notify union |
 | `printer/klippy.ts` | the Klippy lifecycle (`ready`/`startup`/`shutdown`/`error`/`disconnected`) — tracked apart from the socket so a FIRMWARE_RESTART re-seeds instead of showing stale-as-live |
 | `printer/prompt-parser.ts` | parses Klipper's `// action:prompt_*` protocol into structured modal dialogs (`PromptParser`) |
 | `session/session.ts` | **`FilaMindSession`** — the orchestrator: staged init (identify → capabilities → query/seed → subscribe), routes `notify_*`, owns the Klippy-aware `live`/stale gate |

package/dist/index.d.ts

@@ -90,6 +90,85 @@ declare class Logger {
 /** A no-op logger for when none is supplied. */
 declare const NULL_LOGGER: Logger;
 
+/** A JSON-RPC error that keeps Moonraker's numeric `code` and optional `data` payload. */
+declare class RpcError extends Error {
+    readonly code?: number | undefined;
+    readonly data?: unknown | undefined;
+    constructor(message: string, code?: number | undefined, data?: unknown | undefined);
+}
+interface ServerInfo {
+    klippy_connected: boolean;
+    klippy_state: 'ready' | 'startup' | 'shutdown' | 'error' | 'disconnected';
+    components?: string[];
+    warnings?: string[];
+    [k: string]: unknown;
+}
+interface PrinterInfo {
+    state: 'ready' | 'startup' | 'shutdown' | 'error';
+    state_message: string;
+    hostname?: string;
+    software_version?: string;
+    [k: string]: unknown;
+}
+interface QueryResult {
+    eventtime: number;
+    status: Record<string, unknown>;
+}
+/** Result types for the methods the suite calls most. Unlisted methods still work via `call<T>()`. */
+interface MoonrakerMethods {
+    'server.info': ServerInfo;
+    'server.connection.identify': {
+        connection_id: number;
+    };
+    'printer.info': PrinterInfo;
+    'printer.objects.list': {
+        objects: string[];
+    };
+    'printer.objects.query': QueryResult;
+    'printer.objects.subscribe': QueryResult;
+    'printer.gcode.script': 'ok';
+    'printer.emergency_stop': 'ok';
+    'printer.restart': 'ok';
+    'printer.firmware_restart': 'ok';
+    'machine.system_info': {
+        system_info: Record<string, unknown>;
+    };
+    'machine.reboot': 'ok';
+    'machine.shutdown': 'ok';
+    'server.database.get_item': {
+        namespace: string;
+        key?: string;
+        value: unknown;
+    };
+    'server.database.post_item': {
+        namespace: string;
+        key?: string;
+        value: unknown;
+    };
+}
+/** A narrowed view of Moonraker's `notify_*` broadcasts (whose raw params are positional arrays). */
+type NotifyEvent = {
+    method: 'notify_status_update';
+    status: Record<string, unknown>;
+    eventtime: number;
+} | {
+    method: 'notify_gcode_response';
+    response: string;
+} | {
+    method: 'notify_klippy_ready';
+} | {
+    method: 'notify_klippy_shutdown';
+} | {
+    method: 'notify_klippy_disconnected';
+} | {
+    method: 'notify_agent_event';
+    agent: string;
+    event: string;
+    data: unknown;
+};
+/** Parse a raw (method, params) notify into a typed event, or null for an unhandled method. */
+declare function parseNotifyEvent(method: string, params: unknown): NotifyEvent | null;
+
 /** Minimal WebSocket surface the client uses — the DOM WebSocket satisfies it; tests fake it. */
 interface WebSocketLike {
     send(data: string): void;
@@ -130,6 +209,7 @@ declare class MoonrakerClient implements Connector {
     setCallbacks(cb: ConnectorCallbacks): void;
     connect(): Promise<void>;
     close(): void;
+    call<M extends keyof MoonrakerMethods>(method: M, params?: Record<string, unknown>): Promise<MoonrakerMethods[M]>;
     call<T = unknown>(method: string, params?: Record<string, unknown>): Promise<T>;
     subscribe(objects: SubscriptionMap): Promise<void>;
     upload(root: string, file: File, onProgress?: (pct: number) => void): Promise<void>;
@@ -143,6 +223,37 @@ declare class MoonrakerClient implements Connector {
     private onMessage;
 }
 
+/** A minimal view of `location` — the DOM Location satisfies it; tests pass a plain object. */
+interface LocationLike {
+    protocol?: string;
+    hostname?: string;
+}
+interface DiscoveryOptions {
+    /** Explicit runtime override (e.g. from settings). If set, it wins immediately — no probing. */
+    override?: string;
+    /** Candidate ws(s):// URLs to race. If omitted, they are derived from `location`. */
+    candidates?: string[];
+    /** Overall budget before discovery gives up (ms). Default 3000. */
+    timeoutMs?: number;
+    /** Injectable socket factory (tests / non-DOM). Default: `new WebSocket`. */
+    wsFactory?: (url: string) => WebSocketLike;
+    /** Source for deriving candidates. Default: `globalThis.location`. */
+    location?: LocationLike;
+}
+/**
+ * Ordered, de-duplicated candidate endpoints:
+ *  1. same-origin `/websocket` (the suite deploy reverse-proxies Moonraker here),
+ *  2. the page host on Moonraker's default `:7125` (direct, no proxy),
+ *  3. `localhost:7125` (on-printer / Tauri webview, whose origin is `tauri.localhost`).
+ */
+declare function deriveCandidates(location?: LocationLike): string[];
+/**
+ * Resolve a reachable Moonraker WebSocket URL. `override` wins immediately; otherwise the
+ * candidates are raced and the first socket to open wins (the rest are closed). Rejects if
+ * none open within `timeoutMs`.
+ */
+declare function resolveMoonrakerUrl(opts?: DiscoveryOptions): Promise<string>;
+
 declare const SUBSCRIPTION_CONTRACT_VERSION = 1;
 /** Status-only tier (farm overview / ambient screen): the minimum to show state + progress. */
 declare const NARROW_STATUS: SubscriptionMap;
@@ -512,4 +623,4 @@ declare function applySettings(s: UserSettings, el?: {
     dir: 'ltr' | 'rtl';
 };
 
-export { type AgentAllow, type AgentEvent, type BackendMessage, type Catalog, CommandSender, type CommandSenderOptions, type ConnectionState, type Connector, type ConnectorCallbacks, DEFAULT_LOCALE, DEFAULT_SETTINGS, DEFAULT_THEME, FILAMIND_COMMAND_EVENT, FULL_CONTROL, FilaMindSession, type IdentifyInfo, type KlippyState, LOCALES, type Listener, type LocaleMeta, type LogEntry, type LogLevel, Logger, MoonrakerClient, type MoonrakerClientOptions, NARROW_STATUS, NULL_LOGGER, Observable, type Params, type PluralCategory, type PrinterObjects, PrinterState, type PromptButton, type PromptDialog, type PromptEvent, PromptParser, REMOTE_MESSAGE_LEVELS, REMOTE_VIEWS, RTL_LOCALES, type RemoteCommand, type RemoteMessageLevel, type RemoteView, type RestorePoint, RestorePoints, type RestoreStore, SETTINGS_VERSION, SUBSCRIPTION_CONTRACT_VERSION, type SessionOptions, type SettingsPersistence, SettingsStore, type Source, type Stamped, type SubscriptionMap, type SubscriptionTier, type SurfaceTarget, type ThemeName, type ThemeTokens, Translator, UNKNOWN, type UserSettings, type WebSocketLike, type WidgetDefinition, WriteArbiter, type WriteGuard, WriteRefused, _resetRegistry, aggregateSubscriptions, applySettings, applyTheme, deepMerge, deriveKlippyState, deriveMachineId, fnv1a, freshness, getWidget, getWidgets, handleAgentCommand, isKlippyLive, isRtl, isStale, localStoragePersistence, localeMeta, memoryPersistence, memoryRestoreStore, mergeSubscriptions, migrate, moonrakerDbPersistence, parseAgentEvent, parseCommand, pluralCategory, registerWidget, resolveMessage, roamSettings, stamp, themeToCssVars, themes, tier, translate };
+export { type AgentAllow, type AgentEvent, type BackendMessage, type Catalog, CommandSender, type CommandSenderOptions, type ConnectionState, type Connector, type ConnectorCallbacks, DEFAULT_LOCALE, DEFAULT_SETTINGS, DEFAULT_THEME, type DiscoveryOptions, FILAMIND_COMMAND_EVENT, FULL_CONTROL, FilaMindSession, type IdentifyInfo, type KlippyState, LOCALES, type Listener, type LocaleMeta, type LocationLike, type LogEntry, type LogLevel, Logger, MoonrakerClient, type MoonrakerClientOptions, type MoonrakerMethods, NARROW_STATUS, NULL_LOGGER, type NotifyEvent, Observable, type Params, type PluralCategory, type PrinterInfo, type PrinterObjects, PrinterState, type PromptButton, type PromptDialog, type PromptEvent, PromptParser, type QueryResult, REMOTE_MESSAGE_LEVELS, REMOTE_VIEWS, RTL_LOCALES, type RemoteCommand, type RemoteMessageLevel, type RemoteView, type RestorePoint, RestorePoints, type RestoreStore, RpcError, SETTINGS_VERSION, SUBSCRIPTION_CONTRACT_VERSION, type ServerInfo, type SessionOptions, type SettingsPersistence, SettingsStore, type Source, type Stamped, type SubscriptionMap, type SubscriptionTier, type SurfaceTarget, type ThemeName, type ThemeTokens, Translator, UNKNOWN, type UserSettings, type WebSocketLike, type WidgetDefinition, WriteArbiter, type WriteGuard, WriteRefused, _resetRegistry, aggregateSubscriptions, applySettings, applyTheme, deepMerge, deriveCandidates, deriveKlippyState, deriveMachineId, fnv1a, freshness, getWidget, getWidgets, handleAgentCommand, isKlippyLive, isRtl, isStale, localStoragePersistence, localeMeta, memoryPersistence, memoryRestoreStore, mergeSubscriptions, migrate, moonrakerDbPersistence, parseAgentEvent, parseCommand, parseNotifyEvent, pluralCategory, registerWidget, resolveMessage, resolveMoonrakerUrl, roamSettings, stamp, themeToCssVars, themes, tier, translate };

package/dist/index.js

@@ -105,6 +105,51 @@ function deepMerge(target, patch) {
   return out;
 }
 
+// src/moonraker/rpc-types.ts
+var RpcError = class extends Error {
+  constructor(message, code, data) {
+    super(message);
+    this.code = code;
+    this.data = data;
+    this.name = "RpcError";
+  }
+  code;
+  data;
+};
+function parseNotifyEvent(method, params) {
+  const arr = Array.isArray(params) ? params : [];
+  switch (method) {
+    case "notify_status_update":
+      return {
+        method: "notify_status_update",
+        status: arr[0] ?? {},
+        eventtime: typeof arr[1] === "number" ? arr[1] : 0
+      };
+    case "notify_gcode_response":
+      return {
+        method: "notify_gcode_response",
+        response: typeof arr[0] === "string" ? arr[0] : ""
+      };
+    case "notify_klippy_ready":
+      return { method: "notify_klippy_ready" };
+    case "notify_klippy_shutdown":
+      return { method: "notify_klippy_shutdown" };
+    case "notify_klippy_disconnected":
+      return { method: "notify_klippy_disconnected" };
+    case "notify_agent_event": {
+      const e = arr[0] ?? {};
+      return {
+        method: "notify_agent_event",
+        agent: typeof e.agent === "string" ? e.agent : "",
+        event: typeof e.event === "string" ? e.event : "",
+        data: e.data
+      };
+    }
+    default:
+      return null;
+  }
+}
+
 // src/moonraker/client.ts
 var defaultWsFactory = (url) => new WebSocket(url);
 var MoonrakerClient = class {
@@ -169,7 +214,7 @@ var MoonrakerClient = class {
     return new Promise((resolve, reject) => {
       const timer = setTimeout(() => {
         this.pending.delete(id);
-        reject(new Error(`moonraker request timed out: ${method}`));
+        reject(new RpcError(`moonraker request timed out: ${method}`));
       }, this.opts.requestTimeoutMs ?? 1e4);
       this.pending.set(id, { resolve, reject, timer });
       this.send({ jsonrpc: "2.0", method, params, id });
@@ -246,7 +291,7 @@ var MoonrakerClient = class {
       if (!p) return;
       clearTimeout(p.timer);
       this.pending.delete(msg.id);
-      if (msg.error) p.reject(new Error(msg.error.message ?? "rpc error"));
+      if (msg.error) p.reject(new RpcError(msg.error.message ?? "rpc error", msg.error.code, msg.error.data));
       else p.resolve(msg.result);
       return;
     }
@@ -270,6 +315,85 @@ function xhrUpload(url, form, onProgress) {
   });
 }
 
+// src/moonraker/discovery.ts
+var defaultWsFactory2 = (url) => new WebSocket(url);
+function deriveCandidates(location) {
+  const loc = location ?? globalThis.location ?? {};
+  const wsProto = loc.protocol === "https:" ? "wss" : "ws";
+  const host = loc.hostname && loc.hostname.length > 0 ? loc.hostname : "localhost";
+  return [
+    .../* @__PURE__ */ new Set([
+      `${wsProto}://${host}/websocket`,
+      `${wsProto}://${host}:7125/websocket`,
+      `ws://localhost:7125/websocket`
+    ])
+  ];
+}
+function resolveMoonrakerUrl(opts = {}) {
+  const override = opts.override?.trim();
+  if (override) return Promise.resolve(override);
+  const candidates = opts.candidates ?? deriveCandidates(opts.location);
+  if (candidates.length === 0) {
+    return Promise.reject(new Error("moonraker discovery: no candidate endpoints"));
+  }
+  const makeWs = opts.wsFactory ?? defaultWsFactory2;
+  const timeoutMs = opts.timeoutMs ?? 3e3;
+  return new Promise((resolve, reject) => {
+    let settled = false;
+    let remaining = candidates.length;
+    const sockets = [];
+    const timer = setTimeout(finishFail, timeoutMs);
+    function cleanup() {
+      clearTimeout(timer);
+      for (const s of sockets) {
+        s.onopen = null;
+        s.onerror = null;
+        s.onclose = null;
+        try {
+          s.close();
+        } catch {
+        }
+      }
+    }
+    function finishOk(url) {
+      if (settled) return;
+      settled = true;
+      cleanup();
+      resolve(url);
+    }
+    function finishFail() {
+      if (settled) return;
+      settled = true;
+      cleanup();
+      reject(new Error(`moonraker discovery: no endpoint responded (${candidates.join(", ")})`));
+    }
+    function lose() {
+      remaining -= 1;
+      if (remaining <= 0) finishFail();
+    }
+    for (const url of candidates) {
+      let s;
+      try {
+        s = makeWs(url);
+      } catch {
+        lose();
+        continue;
+      }
+      sockets.push(s);
+      let done = false;
+      const fail = () => {
+        if (!done) {
+          done = true;
+          lose();
+        }
+      };
+      s.onopen = () => finishOk(url);
+      s.onerror = fail;
+      s.onclose = fail;
+    }
+  });
+}
+
 // src/moonraker/subscriptions.ts
 var SUBSCRIPTION_CONTRACT_VERSION = 1;
 var NARROW_STATUS = {
@@ -1160,6 +1284,7 @@ export {
   REMOTE_VIEWS,
   RTL_LOCALES,
   RestorePoints,
+  RpcError,
   SETTINGS_VERSION,
   SUBSCRIPTION_CONTRACT_VERSION,
   SettingsStore,
@@ -1172,6 +1297,7 @@ export {
   applySettings,
   applyTheme,
   deepMerge,
+  deriveCandidates,
   deriveKlippyState,
   deriveMachineId,
   fnv1a,
@@ -1191,9 +1317,11 @@ export {
   moonrakerDbPersistence,
   parseAgentEvent,
   parseCommand,
+  parseNotifyEvent,
   pluralCategory,
   registerWidget,
   resolveMessage,
+  resolveMoonrakerUrl,
   roamSettings,
   stamp,
   themeToCssVars,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@filamind-app/core",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Shared foundation for the FilaMind suite — Moonraker client, reactive printer state, provenance-stamped values, design tokens, and the widget/plugin registry. Framework-agnostic TypeScript.",
   "license": "GPL-3.0-or-later",
   "repository": {