@mauroandre/velojs 0.0.26 → 0.0.27

package/dist/hooks.js

@@ -1,116 +1,176 @@
-import { signal as v, useSignal as c } from "@preact/signals";
-import { useEffect as h, useRef as p } from "preact/hooks";
-import { useLocation as w, useParams as g } from "wouter-preact";
-const S = v(!1);
-function L(e) {
+import { signal as g, useSignal as h } from "@preact/signals";
+import { useEffect as D, useRef as E } from "preact/hooks";
+import { useLocation as L, useParams as A } from "wouter-preact";
+const b = g(!1);
+function O(e) {
   e.value !== null && typeof e.value == "object" && (e.value = { ...e.value });
 }
-function m(e) {
-  const o = v(!1);
+function C(e) {
+  const c = g(!1);
   if (typeof window > "u")
     return { data: {
       get value() {
         return e ? globalThis.__veloServerData?.getStore?.()?.[e] ?? null : null;
       }
-    }, loading: o };
+    }, loading: c };
   const t = window.__PAGE_DATA__, r = e && t?.[e] ? t[e] : null;
-  return { data: v(r), loading: o };
+  return { data: g(r), loading: c };
 }
-function A(e, o) {
+function U(e, c) {
   let t, r;
-  Array.isArray(e) ? r = e : (t = e, r = o);
-  let n = null;
+  Array.isArray(e) ? r = e : (t = e, r = c);
+  let a = null;
   if (typeof window > "u" && t) {
-    const i = globalThis.__veloServerData?.getStore?.();
-    i?.[t] && (n = i[t]);
+    const _ = globalThis.__veloServerData?.getStore?.();
+    _?.[t] && (a = _[t]);
   }
   if (typeof window < "u" && t) {
-    const a = window.__PAGE_DATA__;
-    a?.[t] && (n = a[t], delete a[t]);
+    const n = window.__PAGE_DATA__;
+    n?.[t] && (a = n[t], delete n[t]);
   }
-  const u = c(n), s = c(!1), _ = () => {
+  const o = h(a), s = h(!1), f = () => {
     if (typeof window > "u" || !t) return;
-    const a = window.location.pathname;
+    const n = window.location.pathname;
     s.value = !0;
-    const f = typeof __VELO_STATIC__ < "u" && __VELO_STATIC__ ? `${a === "/" ? "" : a}/index.json` : (() => {
+    const p = typeof __VELO_STATIC__ < "u" && __VELO_STATIC__ ? `${n === "/" ? "" : n}/index.json` : (() => {
       const l = new URLSearchParams(window.location.search);
-      return l.set("_data", "1"), `${a}?${l.toString()}`;
+      return l.set("_data", "1"), `${n}?${l.toString()}`;
     })();
-    fetch(f, { cache: "no-cache" }).then((l) => l.json()).then((l) => {
-      typeof __VELO_BUILD_HASH__ < "u" && l.__buildHash && l.__buildHash !== __VELO_BUILD_HASH__ && (S.value = !0), u.value = l[t], s.value = !1;
+    fetch(p, { cache: "no-cache" }).then((l) => l.json()).then((l) => {
+      typeof __VELO_BUILD_HASH__ < "u" && l.__buildHash && l.__buildHash !== __VELO_BUILD_HASH__ && (b.value = !0), o.value = l[t], s.value = !1;
     }).catch(() => {
       s.value = !1;
     });
-  }, d = p(n !== null);
-  return h(() => {
-    if (d.current) {
-      d.current = !1;
+  }, y = E(a !== null);
+  return D(() => {
+    if (y.current) {
+      y.current = !1;
       return;
     }
-    _();
-  }, r ?? []), { data: u, loading: s, refetch: _ };
+    f();
+  }, r ?? []), { data: o, loading: s, refetch: f };
 }
-function P() {
-  const [, e] = w();
+function k() {
+  const [, e] = L();
   return e;
 }
-function T() {
-  return typeof window > "u" ? globalThis.__veloServerData?.getStore?.()?.__params ?? {} : g();
+function H() {
+  return typeof window > "u" ? globalThis.__veloServerData?.getStore?.()?.__params ?? {} : A();
 }
-function b() {
+function R() {
   if (typeof window > "u")
     return globalThis.__veloServerData?.getStore?.()?.__query ?? {};
   const e = window.__PAGE_DATA__;
   if (e?.__query)
     return e.__query;
-  const o = new URLSearchParams(window.location.search), t = {};
-  return o.forEach((r, n) => {
-    t[n] = r;
+  const c = new URLSearchParams(window.location.search), t = {};
+  return c.forEach((r, a) => {
+    t[a] = r;
   }), t;
 }
-function H() {
-  return typeof window > "u" ? globalThis.__veloServerData?.getStore?.()?.__pathname ?? "/" : (w(), window.location.pathname);
+function G() {
+  return typeof window > "u" ? globalThis.__veloServerData?.getStore?.()?.__pathname ?? "/" : (L(), window.location.pathname);
 }
-function U(e, o = {}) {
-  const t = c(null), r = c(null), n = c(!1), u = c(null), { channel: s, enabled: _ = !0 } = o;
-  return h(() => {
-    if (typeof window > "u" || !_) return;
+function W(e, c = {}) {
+  const t = h(null), r = h(null), a = h(!1), o = h(null), { channel: s, enabled: f = !0 } = c;
+  return D(() => {
+    if (typeof window > "u" || !f) return;
     if (!e.__path) {
       console.warn("[velojs] useEventStream: stream has no __path");
       return;
     }
-    t.value = null, r.value = null, n.value = !1, u.value = null;
-    const d = s ? `${e.__path}?channel=${encodeURIComponent(s)}` : e.__path, a = new EventSource(d);
-    return a.addEventListener("snapshot", (i) => {
+    t.value = null, r.value = null, a.value = !1, o.value = null;
+    const y = s ? `${e.__path}?channel=${encodeURIComponent(s)}` : e.__path, n = new EventSource(y);
+    return n.addEventListener("snapshot", (_) => {
       try {
-        r.value = JSON.parse(i.data);
-      } catch (f) {
-        u.value = f;
+        r.value = JSON.parse(_.data);
+      } catch (p) {
+        o.value = p;
       }
-    }), a.addEventListener("message", (i) => {
+    }), n.addEventListener("message", (_) => {
       try {
-        t.value = JSON.parse(i.data);
-      } catch (f) {
-        u.value = f;
+        t.value = JSON.parse(_.data);
+      } catch (p) {
+        o.value = p;
       }
-    }), a.addEventListener("heartbeat", () => {
-    }), a.addEventListener("close", () => {
-      n.value = !0, a.close();
-    }), a.addEventListener("error", () => {
-      a.readyState === EventSource.CLOSED && (n.value = !0);
+    }), n.addEventListener("heartbeat", () => {
+    }), n.addEventListener("close", () => {
+      a.value = !0, n.close();
+    }), n.addEventListener("error", () => {
+      n.readyState === EventSource.CLOSED && (a.value = !0);
+    }), () => {
+      n.close();
+    };
+  }, [e, s, f]), { data: t, snapshot: r, closed: a, error: o };
+}
+function q(e, c = {}) {
+  const t = h("connecting"), r = h(null), a = h(null), o = E(null), s = E([]), { channel: f, onMessage: y, onOpen: n, onClose: _, onError: p, enabled: l = !0 } = c;
+  return D(() => {
+    if (typeof window > "u" || !l) return;
+    if (!e.__path) {
+      console.warn("[velojs] useSocket: stub has no __path");
+      return;
+    }
+    t.value = "connecting", r.value = null, a.value = null;
+    const v = `${window.location.protocol === "https:" ? "wss:" : "ws:"}//${window.location.host}`, i = f ? `${v}${e.__path}?channel=${encodeURIComponent(f)}` : `${v}${e.__path}`, d = new WebSocket(i);
+    return d.binaryType = "arraybuffer", o.current = d, d.addEventListener("open", () => {
+      t.value = "open";
+      const u = s.current;
+      s.current = [];
+      for (const S of u)
+        try {
+          d.send(S);
+        } catch {
+        }
+      n?.();
+    }), d.addEventListener("message", (u) => {
+      let S;
+      if (typeof u.data == "string")
+        S = u.data;
+      else if (u.data instanceof ArrayBuffer)
+        S = new Uint8Array(u.data);
+      else
+        return;
+      r.value = S, y?.(S);
+    }), d.addEventListener("close", (u) => {
+      t.value = "closed", o.current = null, _?.(u);
+    }), d.addEventListener("error", (u) => {
+      a.value = u, p?.(u);
     }), () => {
-      a.close();
+      o.current = null;
+      try {
+        (d.readyState === WebSocket.OPEN || d.readyState === WebSocket.CONNECTING) && d.close();
+      } catch {
+      }
     };
-  }, [e, s, _]), { data: t, snapshot: r, closed: n, error: u };
+  }, [e.__path, f, l]), { send: (w) => {
+    let v;
+    typeof w == "string" || w instanceof Uint8Array ? v = w : v = JSON.stringify(w);
+    const i = o.current;
+    if (i && i.readyState === WebSocket.OPEN)
+      try {
+        i.send(v);
+      } catch {
+      }
+    else i && i.readyState === WebSocket.CONNECTING && s.current.push(v);
+  }, close: (w, v) => {
+    const i = o.current;
+    if (i)
+      try {
+        i.close(w, v);
+      } catch {
+      }
+  }, status: t, lastMessage: r, error: a };
 }
 export {
-  m as Loader,
-  S as __veloUpdatePending,
-  L as touch,
-  U as useEventStream,
-  A as useLoader,
-  P as useNavigate,
-  T as useParams,
-  H as usePathname,
-  b as useQuery
+  C as Loader,
+  b as __veloUpdatePending,
+  O as touch,
+  W as useEventStream,
+  U as useLoader,
+  k as useNavigate,
+  H as useParams,
+  G as usePathname,
+  R as useQuery,
+  q as useSocket
 };

package/dist/index.d.ts

@@ -3,5 +3,6 @@ export type { VeloConfig } from "./config.js";
 export { defineConfig } from "./config.js";
 export { Scripts, Link } from "./components.js";
 export { createEventStream, poll } from "./events.js";
-export type { EventStream, EventStreamConfig, EmitFn, EmitOptions, SourceFn, PerChannelSourceFn, ChannelResolver, } from "./events.js";
+export type { EventStream, EventStreamConfig, EmitFn, EmitOptions, SourceFn, PerChannelSourceFn, StreamPipeFn, StreamPipeArgs, ChannelResolver, } from "./events.js";
+export type { SocketHandler, SocketHandlerArgs, SocketStub, } from "./sockets.js";
 export type { Context, MiddlewareHandler, Next } from "hono";

package/dist/server.js

@@ -1,39 +1,40 @@
 import { jsx as g } from "preact/jsx-runtime";
-import { Hono as R } from "hono";
-import { logger as b } from "hono/logger";
-import { trimTrailingSlash as T } from "hono/trailing-slash";
-import { render as j } from "preact-render-to-string";
+import { Hono as q } from "hono";
+import { logger as T } from "hono/logger";
+import { trimTrailingSlash as j } from "hono/trailing-slash";
+import { render as k } from "preact-render-to-string";
 import { Router as A } from "wouter-preact";
 import { AsyncLocalStorage as C } from "node:async_hooks";
 import { getAppContext as v } from "./app-context.js";
-import { flushPendingStreamRoutes as $, registerStreamHandler as k } from "./events.js";
-const y = new C();
-globalThis.__veloServerData = y;
-let _ = null;
-function z(e) {
-  if (_) {
-    e(_);
+import { flushPendingStreamRoutes as $, registerStreamHandler as D } from "./events.js";
+import { registerSocketRoutes as I, injectWebSocketServer as y } from "./sockets.js";
+const S = new C();
+globalThis.__veloServerData = S;
+let w = null;
+function Y(e) {
+  if (w) {
+    e(w);
     return;
   }
   v().serverCallbacks.push(e);
 }
-function S(e) {
-  _ = e;
+function P(e) {
+  w = e;
   const t = v();
   for (const s of t.serverCallbacks) s(e);
   t.serverCallbacks.length = 0;
 }
-function Q(e) {
+function Z(e) {
   v().pendingRoutes.push(e);
 }
-const D = (e, t, s) => {
+const N = (e, t, s) => {
   if (e.req.query("_data") === "1") {
     const r = globalThis.__veloBuildHash || void 0, i = s ? { ...s, __buildHash: r } : { __buildHash: r };
     return e.json(i);
   }
-  const a = e.req.path, o = y.run(
+  const a = e.req.path, o = S.run(
     s ?? {},
-    () => j(/* @__PURE__ */ g(A, { ssrPath: a, children: t }))
+    () => k(/* @__PURE__ */ g(A, { ssrPath: a, children: t }))
   );
   if (e.header("Cache-Control", "no-cache"), !s)
     return e.html(o);
@@ -41,7 +42,7 @@ const D = (e, t, s) => {
     s
   )}<\/script>`;
   return e.html(o.replace("</head>", `${n}</head>`));
-}, I = async (e, t) => {
+}, O = async (e, t) => {
   const s = t.req.param(), a = t.req.query(), o = { params: s, query: a, c: t }, n = await Promise.all(
     e.map(async (i) => {
       if (!i.loader) return null;
@@ -59,7 +60,7 @@ const D = (e, t, s) => {
     components: e.map((i) => i.Component),
     data: r
   };
-}, N = (e) => {
+}, G = (e) => {
   if (e.length === 0) return null;
   const t = e.filter(Boolean);
   if (t.length === 0) return null;
@@ -69,10 +70,10 @@ const D = (e, t, s) => {
   }
   const s = t[t.length - 1];
   return t.slice(0, -1).reduceRight((o, n) => /* @__PURE__ */ g(n, { children: o }), /* @__PURE__ */ g(s, {}));
-}, w = (e, t, s = [], a = []) => {
+}, _ = (e, t, s = [], a = []) => {
   for (const o of t) {
     if (o.handler && !o.module) {
-      o.children && w(
+      o.children && _(
         e,
         o.children,
         s,
@@ -85,7 +86,7 @@ const D = (e, t, s) => {
       ...o.middlewares || []
     ];
     if (o.children)
-      w(
+      _(
         e,
         o.children,
         n,
@@ -100,14 +101,14 @@ const D = (e, t, s) => {
         continue;
       }
       const l = async (c) => {
-        const { components: u, data: h } = await I(n, c), d = N(u);
-        return D(c, d, h);
+        const { components: u, data: h } = await O(n, c), d = G(u);
+        return N(c, d, h);
       };
       r.length > 0 ? e.on(["GET"], [i], ...r, l) : e.on(["GET"], [i], l);
     } else
       continue;
   }
-}, P = (e, t, s = []) => {
+}, E = (e, t, s = []) => {
   for (const a of t) {
     const o = a.module?.metadata?.moduleId, n = [
       ...s,
@@ -136,8 +137,8 @@ const D = (e, t, s) => {
               const p = await c(f);
               return d.json(p ?? { ok: !0 });
             } catch (p) {
-              const q = p instanceof Error ? p.message : "Action failed";
-              return d.json({ error: q }, 500);
+              const b = p instanceof Error ? p.message : "Action failed";
+              return d.json({ error: b }, 500);
             }
           };
           n.length > 0 ? e.on(
@@ -149,9 +150,9 @@ const D = (e, t, s) => {
         }
       }
     }
-    a.children && P(e, a.children, n);
+    a.children && E(e, a.children, n);
   }
-}, O = async (e, t, s = []) => {
+}, H = async (e, t, s = []) => {
   const a = (o, n) => {
     for (const r of o) {
       const i = r.module?.metadata?.moduleId, l = [
@@ -166,7 +167,7 @@ const D = (e, t, s) => {
           const h = u.replace("stream_", ""), d = r.module[u];
           if (d?.__isVeloEventStream) {
             const m = `/_event/${i}/${h}`;
-            d.__path = m, k(
+            d.__path = m, D(
               e,
               m,
               d,
@@ -179,7 +180,7 @@ const D = (e, t, s) => {
     }
   };
   a(t, s);
-}, G = (e, t) => t ? t.startsWith("/") ? e + t : e ? e + "/" + t : "/" + t : e || "", H = (e) => {
+}, x = (e, t) => t ? t.startsWith("/") ? e + t : e ? e + "/" + t : "/" + t : e || "", V = (e) => {
   const t = /* @__PURE__ */ new Set(), s = (a) => {
     for (const o of a) {
       if (o.module && !o.children) {
@@ -190,9 +191,9 @@ const D = (e, t, s) => {
     }
   };
   return s(e), t;
-}, E = (e, t, s, a = "", o = []) => {
+}, R = (e, t, s, a = "", o = []) => {
   for (const n of t) {
-    const r = G(a, n.path), i = [
+    const r = x(a, n.path), i = [
       ...o,
       ...n.middlewares || []
     ], l = !!n.handler, c = !!n.method;
@@ -216,7 +217,7 @@ const D = (e, t, s) => {
       });
       i.length > 0 ? e.on([h], [r], ...i, m) : e.on([h], [r], m);
     }
-    n.children && E(
+    n.children && R(
       e,
       n.children,
       s,
@@ -224,34 +225,34 @@ const D = (e, t, s) => {
       i
     );
   }
-}, x = async (e) => {
-  const t = new R();
-  t.use(T()), process.env.NODE_ENV !== "production" && t.use("*", b());
+}, W = async (e) => {
+  const t = new q();
+  t.use(j()), process.env.NODE_ENV !== "production" && t.use("*", T());
   const a = v().pendingRoutes.splice(0);
   for (const n of a)
     await n(t);
-  w(t, e), P(t, e), await O(t, e);
-  const o = H(e);
-  if (E(t, e, o), $(t), process.env.NODE_ENV !== "production" && !_) {
+  _(t, e), E(t, e), await H(t, e);
+  const o = V(e);
+  if (R(t, e, o), await I(t, e), $(t), process.env.NODE_ENV !== "production" && !w) {
     const n = globalThis.__veloDevServer;
-    n && S(n);
+    n && (P(n), await y(t, n));
   }
   return t;
-}, X = async (e) => {
-  const { routes: t, port: s = Number(process.env.SERVER_PORT) || 3e3 } = e, a = await x(t);
+}, ee = async (e) => {
+  const { routes: t, port: s = Number(process.env.SERVER_PORT) || 3e3 } = e, a = await W(t);
   if (process.env.NODE_ENV === "production" && !process.env.VELO_STATIC) {
     const { serve: o } = await import("@hono/node-server"), { serveStatic: n } = await import("@hono/node-server/serve-static"), { join: r } = await import("node:path"), i = r(process.cwd(), "dist/client");
     (process.env.STATIC_BASE_URL || "").startsWith("http") || a.use("/*", n({ root: i })), console.log(`Server running on http://localhost:${s}`);
     const c = o({ fetch: a.fetch, port: s });
-    S(c);
+    await y(a, c), P(c);
   }
   return a;
 };
 export {
-  Q as addRoutes,
-  x as createApp,
-  x as default,
-  z as onServer,
-  y as serverDataStorage,
-  X as startServer
+  Z as addRoutes,
+  W as createApp,
+  W as default,
+  Y as onServer,
+  S as serverDataStorage,
+  ee as startServer
 };

package/dist/sockets.d.ts

@@ -0,0 +1,94 @@
+/**
+ * VeloJS Sockets — declarative WebSocket convention.
+ *
+ * Dev pattern: export `socket_<name>` from a page/layout module.
+ *
+ * ```typescript
+ * // app/workers/WorkerTerminal.tsx
+ * export const socket_terminal = async ({
+ *     incoming, send, keepOpen, close, abortSignal, c, params, query,
+ * }) => {
+ *     const user = c.get("user");
+ *     const session = await createTerminal(params.workerId);
+ *     session.on("data", (d) => send({ type: "data", data: d.toString() }));
+ *     abortSignal.addEventListener("abort", () => session.destroy());
+ *     keepOpen();
+ *     for await (const raw of incoming) {
+ *         const msg = JSON.parse(typeof raw === "string" ? raw : "");
+ *         if (msg.type === "resize") session.resize(msg.cols, msg.rows);
+ *         else if (msg.type === "data") session.write(msg.data);
+ *     }
+ * };
+ * ```
+ *
+ * The plugin strips `socket_*` bodies from the client bundle and replaces them
+ * with a stub carrying `__path`. On the client, use `useSocket(socket_terminal)`.
+ */
+import type { Context, Hono, MiddlewareHandler } from "hono";
+import type { RouteNode } from "./types.js";
+export interface SocketHandlerArgs {
+    /** Raw message frames from the client. Text frames → `string`, binary → `Uint8Array`. */
+    incoming: AsyncIterable<string | Uint8Array>;
+    /** Send a message. Objects are auto-serialized with `JSON.stringify`. */
+    send: (msg: string | Uint8Array | object) => void;
+    /** Close the socket imperatively. Accepts an optional WS close code + reason. */
+    close: (code?: number, reason?: string) => void;
+    /**
+     * Mark the socket as long-running. If the handler returns without calling
+     * `keepOpen()`, the framework closes the socket. When `keepOpen()` is set,
+     * the socket stays open until the abort signal fires.
+     *
+     * `for await (const msg of incoming)` naturally keeps the handler alive
+     * while messages flow — `keepOpen()` is redundant in that case but not
+     * harmful.
+     */
+    keepOpen: () => void;
+    /** Fires when the client disconnects, the server aborts, or `app.close()` is called. */
+    abortSignal: AbortSignal;
+    /** Hono Context — use `c.get("user")` etc. for middleware-provided values. */
+    c: Context;
+    /** URL params (e.g. `/:workerId`). */
+    params: Record<string, string>;
+    /** Query-string values. */
+    query: Record<string, string>;
+}
+export type SocketHandler = (args: SocketHandlerArgs) => void | Promise<void>;
+/** Client-side stub shape — what the Vite plugin replaces `socket_*` with on the client bundle. */
+export interface SocketStub {
+    readonly __isVeloSocket: true;
+    readonly __path: string;
+}
+/**
+ * Wraps a raw `incoming` iterable so each frame is JSON-parsed. Invalid JSON
+ * frames are skipped with a console warning (not thrown). Use when all client
+ * messages are JSON objects.
+ *
+ * ```typescript
+ * for await (const msg of parseJson<TerminalMsg>(incoming)) {
+ *     if (msg.type === "resize") session.resize(msg.cols, msg.rows);
+ * }
+ * ```
+ */
+export declare function parseJson<T = unknown>(incoming: AsyncIterable<string | Uint8Array>): AsyncIterable<T>;
+interface RegisteredSocket {
+    path: string;
+    handler: SocketHandler;
+    middlewares: MiddlewareHandler[];
+}
+/** @internal Used by the testing toolkit so `app.close()` aborts in-memory sessions too. */
+export declare function trackSocketSession(app: Hono, ctrl: AbortController): () => void;
+/** @internal Abort every open socket session on `app`. Called by testing toolkit + disposers. */
+export declare function abortAllSocketSessions(app: Hono): void;
+/** @internal Returns registered sockets for `app` (used by the testing toolkit). */
+export declare function getAppSockets(app: Hono): ReadonlyMap<string, RegisteredSocket>;
+export declare function registerSocketHandler(app: Hono, path: string, handler: SocketHandler, middlewares?: MiddlewareHandler[]): Promise<void>;
+/** Walks the route tree and registers every `socket_*` export. */
+export declare function registerSocketRoutes(app: Hono, nodes: RouteNode[], parentMiddlewares?: MiddlewareHandler[]): Promise<void>;
+/**
+ * Inject the WebSocket adapter into an HTTP server. Call after `serve()`
+ * returns (prod) or with Vite's dev http server (dev).
+ *
+ * No-op when no sockets are registered on `app`.
+ */
+export declare function injectWebSocketServer(app: Hono, server: any): Promise<void>;
+export {};