@ai-matrx/desktop-protocol 0.1.0

package/dist/react.js

@@ -0,0 +1,109 @@
+"use client";
+
+// src/react.ts
+import { createContext, createElement, useCallback, useContext, useEffect, useRef, useState, useSyncExternalStore } from "react";
+
+// src/error.ts
+var DesktopProtocolError = class extends Error {
+  code;
+  retryable;
+  data;
+  constructor(code, message, options = {}) {
+    super(message, options.cause === void 0 ? void 0 : { cause: options.cause });
+    this.name = "DesktopProtocolError";
+    this.code = code;
+    this.retryable = options.retryable ?? false;
+    this.data = options.data;
+  }
+  /** The wire body (ProtocolErrorBody) — what a core or relay sends for this error. */
+  toBody() {
+    return this.data === void 0 ? { code: this.code, message: this.message, retryable: this.retryable } : { code: this.code, message: this.message, retryable: this.retryable, data: this.data };
+  }
+};
+
+// src/react.ts
+var CONTEXT_SLOT = /* @__PURE__ */ Symbol.for("ai-matrx.desktop-protocol.client-context");
+function clientContext() {
+  const slot = globalThis;
+  return slot[CONTEXT_SLOT] ??= createContext(null);
+}
+function DesktopClientProvider(props) {
+  return createElement(clientContext().Provider, { value: props.client }, props.children);
+}
+function useDesktopClient(client) {
+  const fromContext = useContext(clientContext());
+  const resolved = client ?? fromContext;
+  if (!resolved) throw new Error("useDesktopClient: wrap the tree in <DesktopClientProvider client={\u2026}> or pass a client");
+  return resolved;
+}
+function useDesktopConnection(client) {
+  const c = useDesktopClient(client);
+  const state = useSyncExternalStore(c.subscribe, c.getState, c.getState);
+  useEffect(() => {
+    if (c.getState().status === "idle") c.connect();
+  }, [c]);
+  return state;
+}
+function useDesktopRequest(op, params, options = {}) {
+  const c = useDesktopClient(options.client);
+  const enabled = options.enabled ?? true;
+  const key = JSON.stringify(params);
+  const [data, setData] = useState(void 0);
+  const [error, setError] = useState(void 0);
+  const [loading, setLoading] = useState(enabled);
+  const paramsRef = useRef(params);
+  paramsRef.current = params;
+  const runRef = useRef(0);
+  const abortRef = useRef(null);
+  const timeoutMs = options.timeoutMs;
+  const run = useCallback(async () => {
+    const runId = ++runRef.current;
+    abortRef.current?.abort();
+    const abort = new AbortController();
+    abortRef.current = abort;
+    setLoading(true);
+    try {
+      const result = await c.request(op, paramsRef.current, timeoutMs === void 0 ? { signal: abort.signal } : { signal: abort.signal, timeoutMs });
+      if (runId === runRef.current) {
+        setData(result);
+        setError(void 0);
+      }
+      return result;
+    } catch (caught) {
+      const err = caught instanceof DesktopProtocolError ? caught : new DesktopProtocolError("INTERNAL", String(caught), { cause: caught });
+      if (runId === runRef.current && err.code !== "CANCELLED") setError(err);
+      return void 0;
+    } finally {
+      if (runId === runRef.current) setLoading(false);
+    }
+  }, [c, op, key, timeoutMs]);
+  useEffect(() => {
+    if (!enabled) {
+      setLoading(false);
+      return;
+    }
+    void run();
+    return () => {
+      abortRef.current?.abort();
+    };
+  }, [enabled, run]);
+  const status = useSyncExternalStore(c.subscribe, () => c.getState().status, () => c.getState().status);
+  useEffect(() => {
+    if (enabled && status === "open" && error?.retryable) void run();
+  }, [status]);
+  return { data, error, loading, refetch: run };
+}
+function useDesktopEvent(name, handler, options = {}) {
+  const c = useDesktopClient(options.client);
+  const handlerRef = useRef(handler);
+  handlerRef.current = handler;
+  useEffect(() => c.on(name, ((payload, resourceId) => handlerRef.current(payload, resourceId))), [c, name]);
+}
+export {
+  DesktopClientProvider,
+  useDesktopClient,
+  useDesktopConnection,
+  useDesktopEvent,
+  useDesktopRequest
+};
+//# sourceMappingURL=react.js.map

package/dist/react.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/react.ts","../src/error.ts"],"sourcesContent":["/**\n * `@ai-matrx/desktop-protocol/react` — hooks over the client: provider, connection state, typed\n * one-shot requests, events. The client owns every hard part (reconnect, reattach, credits); these\n * hooks only bind it to React's lifecycle.\n */\nimport { createContext, createElement, useCallback, useContext, useEffect, useRef, useState, useSyncExternalStore } from \"react\";\nimport type { Context, ReactNode } from \"react\";\nimport type { DesktopClient, DesktopClientState, EventHandler, EventName, RequestOptions } from \"./client/types\";\nimport { DesktopProtocolError } from \"./error\";\nimport type { OpName, OpParams, OpResult } from \"./schema/registry\";\n\n// The context lives on globalThis: an ESM and a CJS copy of this entry in one app (Next.js\n// does this) would otherwise create two contexts and a provider the hooks cannot see.\nconst CONTEXT_SLOT = Symbol.for(\"ai-matrx.desktop-protocol.client-context\");\nfunction clientContext(): Context<DesktopClient | null> {\n  const slot = globalThis as { [CONTEXT_SLOT]?: Context<DesktopClient | null> };\n  return (slot[CONTEXT_SLOT] ??= createContext<DesktopClient | null>(null));\n}\n\nexport function DesktopClientProvider(props: { client: DesktopClient; children?: ReactNode }): ReactNode {\n  return createElement(clientContext().Provider, { value: props.client }, props.children);\n}\n\n/** The client from the nearest provider (or the one passed in). Throws when there is neither. */\nexport function useDesktopClient(client?: DesktopClient): DesktopClient {\n  const fromContext = useContext(clientContext());\n  const resolved = client ?? fromContext;\n  if (!resolved) throw new Error(\"useDesktopClient: wrap the tree in <DesktopClientProvider client={…}> or pass a client\");\n  return resolved;\n}\n\n/** Live connection state (status, welcome, attempts, retryInMs, lastError). Connects on mount when idle. */\nexport function useDesktopConnection(client?: DesktopClient): DesktopClientState {\n  const c = useDesktopClient(client);\n  const state = useSyncExternalStore(c.subscribe, c.getState, c.getState);\n  useEffect(() => {\n    if (c.getState().status === \"idle\") c.connect();\n  }, [c]);\n  return state;\n}\n\nexport interface DesktopRequestState<N extends OpName> {\n  data: OpResult<N> | undefined;\n  error: DesktopProtocolError | undefined;\n  loading: boolean;\n  /** Re-run now; resolves with the fresh result. */\n  refetch: () => Promise<OpResult<N> | undefined>;\n}\n\nexport interface UseDesktopRequestOptions extends Omit<RequestOptions, \"signal\"> {\n  /** Default true. False = do not run until refetch() or enabled flips true. */\n  enabled?: boolean;\n  client?: DesktopClient;\n}\n\n/**\n * Run a unary op and keep its latest result. Re-runs when `op` or the params' JSON changes, and\n * after a reconnect if the last attempt failed with a retryable error. Aborts on unmount.\n */\nexport function useDesktopRequest<N extends OpName>(op: N, params: OpParams<N>, options: UseDesktopRequestOptions = {}): DesktopRequestState<N> {\n  const c = useDesktopClient(options.client);\n  const enabled = options.enabled ?? true;\n  const key = JSON.stringify(params);\n  const [data, setData] = useState<OpResult<N> | undefined>(undefined);\n  const [error, setError] = useState<DesktopProtocolError | undefined>(undefined);\n  const [loading, setLoading] = useState<boolean>(enabled);\n  const paramsRef = useRef(params);\n  paramsRef.current = params;\n  const runRef = useRef(0);\n  const abortRef = useRef<AbortController | null>(null);\n  const timeoutMs = options.timeoutMs;\n\n  const run = useCallback(async (): Promise<OpResult<N> | undefined> => {\n    const runId = ++runRef.current;\n    abortRef.current?.abort();\n    const abort = new AbortController();\n    abortRef.current = abort;\n    setLoading(true);\n    try {\n      const result = await c.request(op, paramsRef.current, timeoutMs === undefined ? { signal: abort.signal } : { signal: abort.signal, timeoutMs });\n      if (runId === runRef.current) {\n        setData(result);\n        setError(undefined);\n      }\n      return result;\n    } catch (caught) {\n      const err = caught instanceof DesktopProtocolError ? caught : new DesktopProtocolError(\"INTERNAL\", String(caught), { cause: caught });\n      if (runId === runRef.current && err.code !== \"CANCELLED\") setError(err);\n      return undefined;\n    } finally {\n      if (runId === runRef.current) setLoading(false);\n    }\n    // `key` stands for the params' content: a new object with equal JSON is not a new request.\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [c, op, key, timeoutMs]);\n\n  useEffect(() => {\n    if (!enabled) {\n      setLoading(false);\n      return;\n    }\n    void run();\n    return () => {\n      abortRef.current?.abort();\n    };\n  }, [enabled, run]);\n\n  // A retryable failure (device offline, connection lost) re-runs once the client is open again.\n  const status = useSyncExternalStore(c.subscribe, () => c.getState().status, () => c.getState().status);\n  useEffect(() => {\n    if (enabled && status === \"open\" && error?.retryable) void run();\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [status]);\n\n  return { data, error, loading, refetch: run };\n}\n\n/** Subscribe to one protocol event (fs.changed, exec.exited, relay.device_status, …) for the component's life. */\nexport function useDesktopEvent<E extends EventName>(name: E, handler: EventHandler<E>, options: { client?: DesktopClient } = {}): void {\n  const c = useDesktopClient(options.client);\n  const handlerRef = useRef(handler);\n  handlerRef.current = handler;\n  useEffect(() => c.on(name, ((payload, resourceId) => handlerRef.current(payload, resourceId)) as EventHandler<E>), [c, name]);\n}\n","/**\n * The one error type every package entry throws. It carries the wire ErrorCode (SPEC §5), so a\n * caller branches on `code`/`retryable`/`data.reason` and never parses a message. Zod-free on\n * purpose: `./frame` (the relay hot path) throws it without pulling the schema graph.\n */\nimport type { ErrorCodeName, ErrorData } from \"./types\";\n\nexport class DesktopProtocolError extends Error {\n  readonly code: ErrorCodeName;\n  readonly retryable: boolean;\n  readonly data: ErrorData | undefined;\n\n  constructor(code: ErrorCodeName, message: string, options: { retryable?: boolean; data?: ErrorData; cause?: unknown } = {}) {\n    super(message, options.cause === undefined ? undefined : { cause: options.cause });\n    this.name = \"DesktopProtocolError\";\n    this.code = code;\n    this.retryable = options.retryable ?? false;\n    this.data = options.data;\n  }\n\n  /** The wire body (ProtocolErrorBody) — what a core or relay sends for this error. */\n  toBody(): { code: ErrorCodeName; message: string; retryable: boolean; data?: ErrorData } {\n    return this.data === undefined\n      ? { code: this.code, message: this.message, retryable: this.retryable }\n      : { code: this.code, message: this.message, retryable: this.retryable, data: this.data };\n  }\n}\n\nexport function isDesktopProtocolError(value: unknown): value is DesktopProtocolError {\n  return value instanceof DesktopProtocolError || (value instanceof Error && value.name === \"DesktopProtocolError\" && \"code\" in value);\n}\n"],"mappings":";;;AAKA,SAAS,eAAe,eAAe,aAAa,YAAY,WAAW,QAAQ,UAAU,4BAA4B;;;ACElH,IAAM,uBAAN,cAAmC,MAAM;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EAET,YAAY,MAAqB,SAAiB,UAAsE,CAAC,GAAG;AAC1H,UAAM,SAAS,QAAQ,UAAU,SAAY,SAAY,EAAE,OAAO,QAAQ,MAAM,CAAC;AACjF,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,YAAY,QAAQ,aAAa;AACtC,SAAK,OAAO,QAAQ;AAAA,EACtB;AAAA;AAAA,EAGA,SAAyF;AACvF,WAAO,KAAK,SAAS,SACjB,EAAE,MAAM,KAAK,MAAM,SAAS,KAAK,SAAS,WAAW,KAAK,UAAU,IACpE,EAAE,MAAM,KAAK,MAAM,SAAS,KAAK,SAAS,WAAW,KAAK,WAAW,MAAM,KAAK,KAAK;AAAA,EAC3F;AACF;;;ADbA,IAAM,eAAe,uBAAO,IAAI,0CAA0C;AAC1E,SAAS,gBAA+C;AACtD,QAAM,OAAO;AACb,SAAQ,KAAK,YAAY,MAAM,cAAoC,IAAI;AACzE;AAEO,SAAS,sBAAsB,OAAmE;AACvG,SAAO,cAAc,cAAc,EAAE,UAAU,EAAE,OAAO,MAAM,OAAO,GAAG,MAAM,QAAQ;AACxF;AAGO,SAAS,iBAAiB,QAAuC;AACtE,QAAM,cAAc,WAAW,cAAc,CAAC;AAC9C,QAAM,WAAW,UAAU;AAC3B,MAAI,CAAC,SAAU,OAAM,IAAI,MAAM,6FAAwF;AACvH,SAAO;AACT;AAGO,SAAS,qBAAqB,QAA4C;AAC/E,QAAM,IAAI,iBAAiB,MAAM;AACjC,QAAM,QAAQ,qBAAqB,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ;AACtE,YAAU,MAAM;AACd,QAAI,EAAE,SAAS,EAAE,WAAW,OAAQ,GAAE,QAAQ;AAAA,EAChD,GAAG,CAAC,CAAC,CAAC;AACN,SAAO;AACT;AAoBO,SAAS,kBAAoC,IAAO,QAAqB,UAAoC,CAAC,GAA2B;AAC9I,QAAM,IAAI,iBAAiB,QAAQ,MAAM;AACzC,QAAM,UAAU,QAAQ,WAAW;AACnC,QAAM,MAAM,KAAK,UAAU,MAAM;AACjC,QAAM,CAAC,MAAM,OAAO,IAAI,SAAkC,MAAS;AACnE,QAAM,CAAC,OAAO,QAAQ,IAAI,SAA2C,MAAS;AAC9E,QAAM,CAAC,SAAS,UAAU,IAAI,SAAkB,OAAO;AACvD,QAAM,YAAY,OAAO,MAAM;AAC/B,YAAU,UAAU;AACpB,QAAM,SAAS,OAAO,CAAC;AACvB,QAAM,WAAW,OAA+B,IAAI;AACpD,QAAM,YAAY,QAAQ;AAE1B,QAAM,MAAM,YAAY,YAA8C;AACpE,UAAM,QAAQ,EAAE,OAAO;AACvB,aAAS,SAAS,MAAM;AACxB,UAAM,QAAQ,IAAI,gBAAgB;AAClC,aAAS,UAAU;AACnB,eAAW,IAAI;AACf,QAAI;AACF,YAAM,SAAS,MAAM,EAAE,QAAQ,IAAI,UAAU,SAAS,cAAc,SAAY,EAAE,QAAQ,MAAM,OAAO,IAAI,EAAE,QAAQ,MAAM,QAAQ,UAAU,CAAC;AAC9I,UAAI,UAAU,OAAO,SAAS;AAC5B,gBAAQ,MAAM;AACd,iBAAS,MAAS;AAAA,MACpB;AACA,aAAO;AAAA,IACT,SAAS,QAAQ;AACf,YAAM,MAAM,kBAAkB,uBAAuB,SAAS,IAAI,qBAAqB,YAAY,OAAO,MAAM,GAAG,EAAE,OAAO,OAAO,CAAC;AACpI,UAAI,UAAU,OAAO,WAAW,IAAI,SAAS,YAAa,UAAS,GAAG;AACtE,aAAO;AAAA,IACT,UAAE;AACA,UAAI,UAAU,OAAO,QAAS,YAAW,KAAK;AAAA,IAChD;AAAA,EAGF,GAAG,CAAC,GAAG,IAAI,KAAK,SAAS,CAAC;AAE1B,YAAU,MAAM;AACd,QAAI,CAAC,SAAS;AACZ,iBAAW,KAAK;AAChB;AAAA,IACF;AACA,SAAK,IAAI;AACT,WAAO,MAAM;AACX,eAAS,SAAS,MAAM;AAAA,IAC1B;AAAA,EACF,GAAG,CAAC,SAAS,GAAG,CAAC;AAGjB,QAAM,SAAS,qBAAqB,EAAE,WAAW,MAAM,EAAE,SAAS,EAAE,QAAQ,MAAM,EAAE,SAAS,EAAE,MAAM;AACrG,YAAU,MAAM;AACd,QAAI,WAAW,WAAW,UAAU,OAAO,UAAW,MAAK,IAAI;AAAA,EAEjE,GAAG,CAAC,MAAM,CAAC;AAEX,SAAO,EAAE,MAAM,OAAO,SAAS,SAAS,IAAI;AAC9C;AAGO,SAAS,gBAAqC,MAAS,SAA0B,UAAsC,CAAC,GAAS;AACtI,QAAM,IAAI,iBAAiB,QAAQ,MAAM;AACzC,QAAM,aAAa,OAAO,OAAO;AACjC,aAAW,UAAU;AACrB,YAAU,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,eAAe,WAAW,QAAQ,SAAS,UAAU,EAAqB,GAAG,CAAC,GAAG,IAAI,CAAC;AAC9H;","names":[]}