devframe 0.9.8 → 0.9.9

package/dist/{validation-YrZH6atx.mjs → validation-BOy8IoFZ.mjs}

@@ -1,4 +1,4 @@
-import { t as diagnostics } from "./diagnostics-CD8nlgll.mjs";
+import { t as diagnostics } from "./diagnostics-D0EVm5M6.mjs";
 import { createHash } from "node:crypto";
 //#region ../../node_modules/.pnpm/ohash@2.0.12/node_modules/ohash/dist/_chunks/is-equal.mjs
 function serialize(input) {
@@ -220,7 +220,7 @@ async function validateRpcArgs(name, argsSchema, args) {
 /**
 * Validate a handler's resolved return value against its declared schema.
 * Throws `DF0039` when the value fails the schema, otherwise returns the
-* original value unchanged (guard-only, never rewriting the payload — see
+* original value unchanged (guard-only, never rewriting the payload; see
 * {@link validateRpcArgs}). Passes through when no return schema is set.
 *
 * @internal

package/dist/{wire-codec-0K-o5MYW.mjs → wire-codec-dcCeXcSo.mjs}

@@ -1,4 +1,4 @@
-import { n as strictJsonStringify } from "./serialization-BGzEwAdr.mjs";
+import { n as strictJsonStringify } from "./serialization-DTZnPQ1-.mjs";
 import { n as structuredCloneStringify, t as structuredCloneParse } from "./structured-clone-CbAV5rFI.mjs";
 //#region src/rpc/wire-codec.ts
 const EMPTY_WIRE_DEFS = /* @__PURE__ */ new Map();
@@ -8,7 +8,7 @@ const EMPTY_WIRE_DEFS = /* @__PURE__ */ new Map();
 * JSON (methods declared `jsonSerializable: true`) and `s:`-prefixed
 * structured-clone (everything else, including all error envelopes), with a
 * request-id → method map so a response independently picks the same
-* encoder as its request. One codec per connection — request-id spaces
+* encoder as its request. One codec per connection; request-id spaces
 * don't collide across connections.
 *
 * @internal
@@ -35,7 +35,7 @@ function createRpcWireCodec(definitions = EMPTY_WIRE_DEFS) {
 }
 /**
 * Peek at a wire frame's birpc envelope without engaging a codec's
-* request-id bookkeeping — used by the SSE transport to route a frame
+* request-id bookkeeping; used by the SSE transport to route a frame
 * (park a POST for its response / answer with a bare 202) before it is
 * handed to birpc proper.
 *

package/dist/{ws-client-7_lZi-B9.d.mts → ws-client-Xpxt0oPA.d.mts}

@@ -1,4 +1,4 @@
-import { v as RpcFunctionDefinitionAny } from "./types-CMdPYhOx.mjs";
+import { v as RpcFunctionDefinitionAny } from "./types-Dq4i156u.mjs";
 import { ChannelOptions } from "birpc";
 //#region src/rpc/transports/ws-client.d.ts
 interface WsRpcChannelOptions {
@@ -10,7 +10,7 @@ interface WsRpcChannelOptions {
   /**
    * RPC function definitions (or just the `jsonSerializable` flag per
    * method) used to dispatch the per-call wire serializer. Pass an
-   * empty / partial map on clients that don't have the full registry —
+   * empty / partial map on clients that don't have the full registry;
    * encoding falls back to structured-clone (the safer superset) and
    * decoding still routes correctly via the wire prefix.
    */
@@ -20,7 +20,7 @@ interface WsRpcChannelOptions {
  * Build a birpc `ChannelOptions` object backed by a browser `WebSocket`.
  * Pass the result straight to `createRpcClient`'s `channel` option.
  *
- * Also returns `close()`, closing the underlying socket — mirroring the server transport's
+ * Also returns `close()`, closing the underlying socket, mirroring the server transport's
  * existing `WsRpcTransport.close()`. `birpc`'s own `ChannelOptions` has no teardown of its own.
  */
 declare function createWsRpcChannel(options: WsRpcChannelOptions): ChannelOptions & {

package/dist/{ws-server-VyHlanzy.d.mts → ws-server-D2nv68Hg.d.mts}

@@ -1,4 +1,4 @@
-import { v as RpcFunctionDefinitionAny } from "./types-CMdPYhOx.mjs";
+import { v as RpcFunctionDefinitionAny } from "./types-Dq4i156u.mjs";
 import { BirpcGroup, ChannelOptions } from "birpc";
 import { Hooks, Peer } from "crossws";
 import { NodeAdapter } from "crossws/adapters/node";
@@ -16,8 +16,8 @@ import { Duplex } from "node:stream";
  */
 type DevframeRpcTransportKind = 'websocket' | 'sse';
 /**
- * Structural view of the connect-time HTTP request behind an RPC connection
- * — the WS upgrade request, or the request opening an SSE stream. Shaped to
+ * Structural view of the connect-time HTTP request behind an RPC connection:
+ * the WS upgrade request, or the request opening an SSE stream. Shaped to
  * match both the web `Request` a crossws peer exposes and a plain
  * `node:http` request wrapper, so auth hooks can read the bearer-token
  * query param and the `Origin` header without caring which transport (or
@@ -38,7 +38,7 @@ interface DevframeRpcConnectionRequest {
  * (`onPeerConnect` / `onPeerDisconnect`, {@link DevframeAuthHandler.onConnect}).
  */
 interface DevframeRpcConnection {
-  /** Session id — the same value as the session meta's `id`. */
+  /** Session id, the same value as the session meta's `id`. */
   id: number;
   /** The transport carrying this connection. */
   transport: DevframeRpcTransportKind;
@@ -49,7 +49,7 @@ interface DevframeRpcConnection {
   /** Terminate the connection from the server side. */
   close?: (code?: number, reason?: string) => void;
   /**
-   * The crossws peer backing a `websocket` connection — the WS-specific
+   * The crossws peer backing a `websocket` connection: the WS-specific
    * escape hatch (pub/sub, raw socket access). Absent on other transports.
    */
   peer?: Peer;
@@ -81,7 +81,7 @@ interface WsRpcTransportOptions {
    * Attach to an existing HTTP(S) server, sharing its port. Combine with
    * `path` to bind the WS endpoint to a single route so it coexists with
    * other upgrade handlers on the same server (e.g. a Vite dev server's HMR
-   * socket). The shared server's lifecycle is owned by the caller — closing
+   * socket). The shared server's lifecycle is owned by the caller; closing
    * this transport detaches the upgrade listener without closing the server.
    */
   server?: Server | Server$1;
@@ -130,7 +130,7 @@ interface WsRpcTransportOptions {
    * dispatch between strict-JSON and structured-clone encoding based
    * on each function's `jsonSerializable` flag.
    *
-   * When omitted, all messages fall back to structured-clone — safe but
+   * When omitted, all messages fall back to structured-clone: safe but
    * loses dev-time validation for `jsonSerializable: true` declarations.
    */
   definitions?: ReadonlyMap<string, Pick<RpcFunctionDefinitionAny, 'jsonSerializable'>>;
@@ -164,7 +164,7 @@ interface WsOriginRegistry {
 declare function createWsOriginRegistry(options?: CreateWsOriginRegistryOptions): WsOriginRegistry;
 interface WsRpcTransport {
   /**
-   * The crossws node adapter driving the socket — exposes the connected
+   * The crossws node adapter driving the socket; exposes the connected
    * `peers` and pub/sub. See https://crossws.h3.dev.
    */
   ws: NodeAdapter;
@@ -175,15 +175,15 @@ interface WsRpcTransport {
   /**
    * Complete a `node:http` `upgrade` event on this transport, applying the
    * same `path` filter and origin gate the transport's own listener uses.
-   * Wire it into a host server directly — `server.on('upgrade',
-   * transport.handleUpgrade)` — or call it from an existing listener.
+   * Wire it into a host server directly (`server.on('upgrade',
+   * transport.handleUpgrade)`) or call it from an existing listener.
    */
   handleUpgrade: (req: IncomingMessage, socket: Duplex, head: Buffer) => void;
   /**
    * Route a server's `upgrade` events to this transport, returning a detach
    * function. Use it to bind an `unbound` transport once the host server
    * exists; {@link WsRpcTransport.close} detaches every server attached this
-   * way (without closing them — the caller owns their lifecycle).
+   * way (without closing them, since the caller owns their lifecycle).
    */
   attach: (server: Server | Server$1) => () => void;
   /** Remove the upgrade listener from a shared `server` (a no-op otherwise). */
@@ -195,36 +195,12 @@ interface WsRpcTransport {
    */
   close: () => Promise<void>;
 }
-/**
- * Whether `hostname` names a loopback host: `localhost` (or any `*.localhost`
- * subdomain), the IPv6 loopback `::1`, or an IPv4 literal inside the
- * `127.0.0.0/8` loopback block.
- *
- * The IPv4 case is matched **structurally** — the whole hostname must be a
- * canonical dotted-decimal IPv4 literal whose first octet is `127`. A bare
- * `startsWith('127.')` prefix check would also accept an attacker-controlled
- * DNS name that merely *begins* with `127.` (`127.attacker.example`,
- * `127.0.0.1.attacker.example`), letting a cross-origin browser page defeat
- * the loopback origin gate that guards the RPC/MCP surface (a DNS-rebinding /
- * cross-site WebSocket-hijacking bypass). Requiring a real IPv4 literal keeps
- * genuine loopback addresses (`127.0.0.1`, `127.5.5.5`) allowed while rejecting
- * those DNS names.
- */
-declare function isLoopbackHostname(hostname: string): boolean;
-/**
- * Default origin policy for a localhost dev tool: allow requests with no
- * `Origin` header (native, non-browser clients), allow any loopback origin
- * (so cross-port localhost dev setups keep working), and allow explicitly
- * configured origins. Everything else — a real remote page in the dev's
- * browser — is rejected.
- */
-declare function isAllowedOrigin(origin: string | undefined, allowedOrigins: readonly string[]): boolean;
 /**
  * The per-peer lifecycle hooks driving a devframe RPC WebSocket, shaped for
  * any [crossws](https://crossws.h3.dev) adapter. {@link attachWsRpcTransport}
  * feeds them to the Node adapter; runtime-specific attachments (e.g. Bun's
  * fetch-upgrade adapter) reuse the same hooks so every transport speaks the
- * identical wire protocol — one birpc channel per peer, per-method
+ * identical wire protocol: one birpc channel per peer, per-method
  * `jsonSerializable` dispatch between strict JSON and structured-clone.
  */
 declare function createWsRpcPeerHooks<ClientFunctions extends object, ServerFunctions extends object>(rpcGroup: BirpcGroup<ClientFunctions, ServerFunctions, false>, options?: Pick<WsRpcTransportOptions, 'onConnected' | 'onDisconnected' | 'definitions' | 'serialize' | 'deserialize'>): Partial<Hooks>;
@@ -240,4 +216,4 @@ declare function createWsRpcPeerHooks<ClientFunctions extends object, ServerFunc
  */
 declare function attachWsRpcTransport<ClientFunctions extends object, ServerFunctions extends object>(rpcGroup: BirpcGroup<ClientFunctions, ServerFunctions, false>, options?: WsRpcTransportOptions): WsRpcTransport;
 //#endregion
-export { attachWsRpcTransport as a, isAllowedOrigin as c, DevframeRpcConnection as d, DevframeRpcConnectionRequest as f, WsRpcTransportOptions as i, isLoopbackHostname as l, WsOriginRegistry as n, createWsOriginRegistry as o, DevframeRpcTransportKind as p, WsRpcTransport as r, createWsRpcPeerHooks as s, CreateWsOriginRegistryOptions as t, DevframeNodeRpcSessionMeta as u };
+export { attachWsRpcTransport as a, DevframeNodeRpcSessionMeta as c, DevframeRpcTransportKind as d, WsRpcTransportOptions as i, DevframeRpcConnection as l, WsOriginRegistry as n, createWsOriginRegistry as o, WsRpcTransport as r, createWsRpcPeerHooks as s, CreateWsOriginRegistryOptions as t, DevframeRpcConnectionRequest as u };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "devframe",
   "type": "module",
-  "version": "0.9.8",
+  "version": "0.9.9",
   "description": "Framework for building one portable devtool integration that runs in any viewer.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -56,6 +56,7 @@
     "./utils/nanoid": "./dist/utils/nanoid.mjs",
     "./utils/nostics": "./dist/utils/nostics.mjs",
     "./utils/open": "./dist/utils/open.mjs",
+    "./utils/origin": "./dist/utils/origin.mjs",
     "./utils/remote-assets": "./dist/utils/remote-assets.mjs",
     "./utils/simple-schema": "./dist/utils/simple-schema.mjs",
     "./utils/serve-static": "./dist/utils/serve-static.mjs",

package/dist/ws-server-Y_AumUQH.mjs

@@ -1,294 +0,0 @@
-import "./constants.mjs";
-import { t as createRpcWireCodec } from "./wire-codec-0K-o5MYW.mjs";
-import { n as randomToken, r as timingSafeEqual } from "./crypto-token-XCqTSMg9.mjs";
-import { createServer } from "node:http";
-import { createServer as createServer$1 } from "node:https";
-import crossws from "crossws/adapters/node";
-//#region src/rpc/transports/session.ts
-let sessionId = 0;
-/**
-* Mint the per-connection session meta every transport binding shares —
-* one id space across transports, so session bookkeeping (streaming
-* subscriptions, shared-state sync, auth trust) never collides between a
-* WS peer and an SSE session on the same server.
-*/
-function createRpcSessionMeta() {
-	return {
-		id: sessionId++,
-		subscribedStates: /* @__PURE__ */ new Set()
-	};
-}
-//#endregion
-//#region src/rpc/transports/ws-server.ts
-/**
-* Create a live, token-protected origin allowlist for external browser
-* viewers. Pass it to {@link WsRpcTransportOptions.allowedOrigins}, then use
-* `registerFromUrl()` in the connection metadata handler to authorize a
-* viewer without sharing a mutable array or disabling DNS-rebinding protection.
-*/
-function createWsOriginRegistry(options = {}) {
-	const token = randomToken();
-	const origins = new Set(options.allowedOrigins ?? []);
-	function normalizeOrigin(origin) {
-		if (!origin) return;
-		try {
-			const url = new URL(origin);
-			const normalized = url.origin === "null" ? `${url.protocol}//${url.host}` : url.origin;
-			return origin === normalized ? normalized : void 0;
-		} catch {}
-	}
-	function registerOrigin(origin, candidateToken) {
-		const normalized = normalizeOrigin(origin);
-		if (!normalized || !candidateToken || !timingSafeEqual(token, candidateToken)) return false;
-		if (options.validateOrigin && !options.validateOrigin(normalized)) return false;
-		origins.add(normalized);
-		return true;
-	}
-	return {
-		token,
-		registerFromUrl(url) {
-			let parsed;
-			try {
-				parsed = new URL(url, "http://localhost");
-			} catch {
-				return;
-			}
-			const origin = parsed.searchParams.get("devframe_viewer_origin") ?? void 0;
-			return registerOrigin(origin, parsed.searchParams.get("devframe_viewer_origin_token") ?? void 0) ? origin : void 0;
-		},
-		isAllowed(origin) {
-			return isAllowedOrigin(origin, [...origins]);
-		}
-	};
-}
-const EMPTY_DEFS = /* @__PURE__ */ new Map();
-function NOOP() {}
-function listen(server, port, host) {
-	return new Promise((resolve, reject) => {
-		const onError = (error) => reject(error);
-		server.once("error", onError);
-		try {
-			server.listen(port, host, () => {
-				server.off("error", onError);
-				resolve();
-			});
-		} catch (error) {
-			server.off("error", onError);
-			reject(error);
-		}
-	});
-}
-/** Compare two URL paths ignoring a trailing slash. */
-function pathMatches(a, b) {
-	const strip = (p) => p.length > 1 && p.endsWith("/") ? p.slice(0, -1) : p;
-	return strip(a) === strip(b);
-}
-/**
-* Whether `hostname` names a loopback host: `localhost` (or any `*.localhost`
-* subdomain), the IPv6 loopback `::1`, or an IPv4 literal inside the
-* `127.0.0.0/8` loopback block.
-*
-* The IPv4 case is matched **structurally** — the whole hostname must be a
-* canonical dotted-decimal IPv4 literal whose first octet is `127`. A bare
-* `startsWith('127.')` prefix check would also accept an attacker-controlled
-* DNS name that merely *begins* with `127.` (`127.attacker.example`,
-* `127.0.0.1.attacker.example`), letting a cross-origin browser page defeat
-* the loopback origin gate that guards the RPC/MCP surface (a DNS-rebinding /
-* cross-site WebSocket-hijacking bypass). Requiring a real IPv4 literal keeps
-* genuine loopback addresses (`127.0.0.1`, `127.5.5.5`) allowed while rejecting
-* those DNS names.
-*/
-function isLoopbackHostname(hostname) {
-	const h = hostname.replace(/^\[|\]$/g, "");
-	if (h === "localhost" || h.endsWith(".localhost") || h === "::1") return true;
-	return isLoopbackIPv4(h);
-}
-/** A canonical dotted-decimal IPv4 literal in `127.0.0.0/8`. */
-function isLoopbackIPv4(hostname) {
-	const octets = hostname.split(".");
-	if (octets.length !== 4 || !octets.every(isDecimalOctet)) return false;
-	return Number(octets[0]) === 127;
-}
-/** A single canonical IPv4 octet: 1–3 digits, no leading zero, value 0–255. */
-function isDecimalOctet(part) {
-	if (!/^\d{1,3}$/.test(part) || part.length > 1 && part[0] === "0") return false;
-	return Number(part) <= 255;
-}
-/**
-* Default origin policy for a localhost dev tool: allow requests with no
-* `Origin` header (native, non-browser clients), allow any loopback origin
-* (so cross-port localhost dev setups keep working), and allow explicitly
-* configured origins. Everything else — a real remote page in the dev's
-* browser — is rejected.
-*/
-function isAllowedOrigin(origin, allowedOrigins) {
-	if (!origin) return true;
-	if (allowedOrigins.includes(origin)) return true;
-	try {
-		return isLoopbackHostname(new URL(origin).hostname);
-	} catch {
-		return false;
-	}
-}
-function isWsOriginRegistry(value) {
-	return !!value && !Array.isArray(value);
-}
-/**
-* Build the `upgrade` listener that hands a request to the crossws adapter,
-* optionally filtered to a single `path`. Non-matching requests are left
-* untouched so other upgrade listeners (e.g. a Vite dev server's HMR socket)
-* can claim them, unless `destroyUnmatched` is set.
-*/
-function createUpgradeListener(ws, path, destroyUnmatched, allowedOrigins) {
-	return (req, socket, head) => {
-		socket.on("error", () => {});
-		if (path) {
-			let pathname = req.url ?? "/";
-			try {
-				pathname = new URL(req.url ?? "/", "http://localhost").pathname;
-			} catch {}
-			if (!pathMatches(pathname, path)) {
-				if (destroyUnmatched) {
-					socket.write("HTTP/1.1 400 Bad Request\r\nConnection: close\r\n\r\n");
-					socket.destroy();
-				}
-				return;
-			}
-		}
-		const originAllowed = isWsOriginRegistry(allowedOrigins) ? allowedOrigins.isAllowed(req.headers.origin) : isAllowedOrigin(req.headers.origin, allowedOrigins || []);
-		if (allowedOrigins !== false && !originAllowed) {
-			socket.write("HTTP/1.1 403 Forbidden\r\nConnection: close\r\n\r\n");
-			socket.destroy();
-			return;
-		}
-		ws.handleUpgrade(req, socket, head);
-	};
-}
-/**
-* The per-peer lifecycle hooks driving a devframe RPC WebSocket, shaped for
-* any [crossws](https://crossws.h3.dev) adapter. {@link attachWsRpcTransport}
-* feeds them to the Node adapter; runtime-specific attachments (e.g. Bun's
-* fetch-upgrade adapter) reuse the same hooks so every transport speaks the
-* identical wire protocol — one birpc channel per peer, per-method
-* `jsonSerializable` dispatch between strict JSON and structured-clone.
-*/
-function createWsRpcPeerHooks(rpcGroup, options = {}) {
-	const { onConnected = NOOP, onDisconnected = NOOP, definitions = EMPTY_DEFS, serialize: serializeOverride, deserialize: deserializeOverride } = options;
-	const states = /* @__PURE__ */ new WeakMap();
-	return {
-		open: (peer) => {
-			const meta = createRpcSessionMeta();
-			meta.peer = peer;
-			const connection = {
-				id: meta.id,
-				transport: "websocket",
-				request: peer.request,
-				send: (data) => peer.send(data),
-				close: (code, reason) => peer.close(code, reason),
-				peer
-			};
-			const codec = createRpcWireCodec(definitions);
-			const state = {
-				meta,
-				connection,
-				channel: void 0
-			};
-			const channel = {
-				post: (data) => {
-					peer.send(data);
-				},
-				on: (fn) => {
-					state.onMessage = fn;
-				},
-				serialize: serializeOverride ?? codec.serialize,
-				deserialize: deserializeOverride ?? codec.deserialize,
-				meta
-			};
-			state.channel = channel;
-			states.set(peer, state);
-			rpcGroup.updateChannels((channels) => {
-				channels.push(channel);
-			});
-			onConnected(connection, meta);
-		},
-		message: (peer, message) => {
-			states.get(peer)?.onMessage?.(message.text());
-		},
-		close: (peer) => {
-			const state = states.get(peer);
-			if (!state) return;
-			states.delete(peer);
-			rpcGroup.updateChannels((channels) => {
-				const index = channels.indexOf(state.channel);
-				if (index >= 0) channels.splice(index, 1);
-			});
-			onDisconnected(state.connection, state.meta);
-		}
-	};
-}
-/**
-* Attach a WebSocket transport to an existing RPC group, powered by
-* [crossws](https://crossws.h3.dev). Either attach to an existing HTTP(S)
-* `server` (sharing its port, optionally scoped to a `path`), or let this
-* helper create a standalone server from `port` / `host` / `https`.
-*
-* Returns the crossws node adapter, standalone-server readiness/address
-* accessors, `detach` (remove the upgrade listener from a shared `server`),
-* and `close` (full deterministic teardown).
-*/
-function attachWsRpcTransport(rpcGroup, options = {}) {
-	const { server, port, host = "localhost", path, destroyUnmatched = false, unbound, https, allowedOrigins } = options;
-	const ws = crossws({ hooks: createWsRpcPeerHooks(rpcGroup, options) });
-	const sharedUpgradeListener = createUpgradeListener(ws, path, destroyUnmatched, allowedOrigins);
-	const ownedUpgradeListener = createUpgradeListener(ws, path, true, allowedOrigins);
-	/** Bind a server's `upgrade` events, tracked so `close()` detaches them. */
-	const attachments = /* @__PURE__ */ new Set();
-	function attachTo(target, listener) {
-		target.on("upgrade", listener);
-		const detachOne = () => {
-			target.off("upgrade", listener);
-			attachments.delete(detachOne);
-		};
-		attachments.add(detachOne);
-		return detachOne;
-	}
-	let ready = Promise.resolve();
-	let ownedServer;
-	if (unbound) {} else if (server) attachTo(server, sharedUpgradeListener);
-	else if (https) {
-		ownedServer = createServer$1(https);
-		attachTo(ownedServer, ownedUpgradeListener);
-		ready = listen(ownedServer, port ?? 0, host);
-	} else {
-		ownedServer = createServer((_req, res) => {
-			res.writeHead(426, { "content-type": "text/plain" });
-			res.end("Upgrade Required");
-		});
-		attachTo(ownedServer, ownedUpgradeListener);
-		ready = listen(ownedServer, port ?? 0, host);
-	}
-	const activeServer = server ?? ownedServer;
-	function detachAll() {
-		for (const detachOne of [...attachments]) detachOne();
-	}
-	return {
-		ws,
-		ready,
-		address: () => activeServer?.address() ?? null,
-		handleUpgrade: sharedUpgradeListener,
-		attach: (target) => attachTo(target, sharedUpgradeListener),
-		detach: detachAll,
-		async close() {
-			detachAll();
-			ws.closeAll(void 0, void 0, true);
-			if (ownedServer) {
-				const srv = ownedServer;
-				await ready.catch(() => {});
-				if (!srv.listening) return;
-				await new Promise((r) => srv.close(() => r()));
-			}
-		}
-	};
-}
-//#endregion
-export { isLoopbackHostname as a, isAllowedOrigin as i, createWsOriginRegistry as n, createRpcSessionMeta as o, createWsRpcPeerHooks as r, attachWsRpcTransport as t };