trpc-nuxt-module 4.2.0 → 4.3.1

package/dist/runtime/client/services/useProcedureSubscription.d.ts

@@ -0,0 +1,8 @@
+import { UseSubscriptionOptions } from "../models/UseSubscriptionOptions.js";
+import { UseSubscriptionReturn } from "../models/UseSubscriptionReturn.js";
+import { MaybeRefOrGetter } from "vue";
+import { TRPCClientError, TRPCResolverDef, TRPCUntypedClient } from "@trpc/client";
+import { AnyTRPCRouter } from "@trpc/server";
+//#region src/runtime/client/services/useProcedureSubscription.d.ts
+export declare const useProcedureSubscription: (client: TRPCUntypedClient<AnyTRPCRouter>, path: string, input: MaybeRefOrGetter<unknown>, { enabled, ...options }?: UseSubscriptionOptions<TRPCResolverDef>) => UseSubscriptionReturn<unknown, TRPCClientError<AnyTRPCRouter>>;
+//#endregion

package/dist/runtime/client/services/useProcedureSubscription.js

@@ -0,0 +1,68 @@
+import { SubscriptionStatus } from "../models/SubscriptionStatus.js";
+import { getCurrentScope, onScopeDispose, shallowRef, toValue, watch } from "vue";
+import { checkIsServer } from "@esposter/shared";
+//#region src/runtime/client/services/useProcedureSubscription.ts
+const ConnectionStateSubscriptionStatusMap = {
+	connecting: SubscriptionStatus.Connecting,
+	idle: SubscriptionStatus.Idle,
+	pending: SubscriptionStatus.Pending
+};
+const useProcedureSubscription = (client, path, input, { enabled = true, ...options } = {}) => {
+	const data = shallowRef();
+	const error = shallowRef();
+	const status = shallowRef(SubscriptionStatus.Idle);
+	let unsubscribable;
+	const unsubscribe = () => {
+		unsubscribable?.unsubscribe();
+		unsubscribable = void 0;
+		status.value = SubscriptionStatus.Idle;
+	};
+	const subscribe = () => {
+		unsubscribable?.unsubscribe();
+		error.value = void 0;
+		status.value = SubscriptionStatus.Connecting;
+		unsubscribable = client.subscription(path, toValue(input), {
+			...options,
+			onComplete: () => {
+				status.value = SubscriptionStatus.Idle;
+				options.onComplete?.();
+			},
+			onConnectionStateChange: (state) => {
+				status.value = state.error ? SubscriptionStatus.Error : ConnectionStateSubscriptionStatusMap[state.state];
+				options.onConnectionStateChange?.(state);
+			},
+			onData: (value) => {
+				data.value = value;
+				options.onData?.(value);
+			},
+			onError: (newError) => {
+				error.value = newError;
+				status.value = SubscriptionStatus.Error;
+				options.onError?.(newError);
+			},
+			onStarted: (startedOptions) => {
+				status.value = SubscriptionStatus.Pending;
+				options.onStarted?.(startedOptions);
+			}
+		});
+	};
+	if (!checkIsServer()) watch([() => toValue(input), () => toValue(enabled)], ([, isEnabled]) => {
+		if (isEnabled) subscribe();
+		else unsubscribe();
+	}, { immediate: true });
+	if (getCurrentScope()) onScopeDispose(() => {
+		unsubscribe();
+	});
+	return {
+		data,
+		error,
+		reset: () => {
+			data.value = void 0;
+			unsubscribe();
+			if (toValue(enabled)) subscribe();
+		},
+		status
+	};
+};
+//#endregion
+export { useProcedureSubscription };

package/dist/runtime/client/services/useTrpcServerFetch.d.ts

@@ -0,0 +1,4 @@
+import { TrpcServerFetch } from "../../../models/TrpcServerFetch.js";
+//#region src/runtime/client/services/useTrpcServerFetch.d.ts
+export declare const useTrpcServerFetch: () => TrpcServerFetch;
+//#endregion

package/dist/runtime/client/services/useTrpcServerFetch.js

@@ -0,0 +1,8 @@
+//#region src/runtime/client/services/useTrpcServerFetch.ts
+const useTrpcServerFetch = () => async (resource, init, context) => {
+	if (!import.meta.server) throw new TypeError("The in-process tRPC fetch exists on the server only");
+	const { serverFetch } = await import("nitro/app");
+	return serverFetch(resource, init, context);
+};
+//#endregion
+export { useTrpcServerFetch };

package/dist/runtime/constants.d.ts

@@ -0,0 +1,6 @@
+//#region src/runtime/constants.d.ts
+export declare const DEFAULT_ENDPOINT = "/api/trpc";
+export declare const MODULE_NAME = "trpc-nuxt-module";
+export declare const WEBSOCKET_CLOSE_HOOK: `${typeof MODULE_NAME}:webSocket:close`;
+export declare const WEBSOCKET_OPEN_HOOK: `${typeof MODULE_NAME}:webSocket:open`;
+//#endregion

package/dist/runtime/constants.js

@@ -0,0 +1,7 @@
+//#region src/runtime/constants.ts
+const DEFAULT_ENDPOINT = "/api/trpc";
+const MODULE_NAME = "trpc-nuxt-module";
+const WEBSOCKET_CLOSE_HOOK = `${MODULE_NAME}:webSocket:close`;
+const WEBSOCKET_OPEN_HOOK = `${MODULE_NAME}:webSocket:open`;
+//#endregion
+export { DEFAULT_ENDPOINT, MODULE_NAME, WEBSOCKET_CLOSE_HOOK, WEBSOCKET_OPEN_HOOK };

package/dist/runtime/server/createTRPCEventHandler.d.ts

@@ -0,0 +1,6 @@
+import { TRPCEventHandlerOptions } from "./models/TRPCEventHandlerOptions.js";
+import { AnyTRPCRouter } from "@trpc/server";
+import { EventHandler } from "nitro/h3";
+//#region src/runtime/server/createTRPCEventHandler.d.ts
+export declare const createTRPCEventHandler: <TRouter extends AnyTRPCRouter>({ createContext, endpoint, ...options }: TRPCEventHandlerOptions<TRouter>) => EventHandler;
+//#endregion

package/dist/runtime/server/createTRPCEventHandler.js

@@ -0,0 +1,31 @@
+import { DEFAULT_ENDPOINT } from "../constants.js";
+import { defineHandler } from "nitro/h3";
+import { fetchRequestHandler } from "@trpc/server/adapters/fetch";
+//#region src/runtime/server/createTRPCEventHandler.ts
+const NULL_BODY_STATUSES = /* @__PURE__ */ new Set([
+	204,
+	205,
+	304
+]);
+const createTRPCEventHandler = ({ createContext, endpoint = DEFAULT_ENDPOINT, ...options }) => defineHandler(async (event) => {
+	const response = await fetchRequestHandler({
+		...options,
+		createContext: createContext && ((fetchCreateContextOptions) => createContext(event, fetchCreateContextOptions)),
+		endpoint,
+		req: event.req
+	});
+	const { status } = event.res;
+	if (!status) return response;
+	else if (!NULL_BODY_STATUSES.has(status)) return new Response(response.body, {
+		headers: response.headers,
+		status
+	});
+	const headers = new Headers(response.headers);
+	headers.delete("content-length");
+	return new Response(null, {
+		headers,
+		status
+	});
+});
+//#endregion
+export { createTRPCEventHandler };

package/dist/runtime/server/createTRPCWebSocketHandler.d.ts

@@ -0,0 +1,6 @@
+import { TRPCWebSocketHandler } from "./models/TRPCWebSocketHandler.js";
+import { TRPCWebSocketHandlerOptions } from "./models/TRPCWebSocketHandlerOptions.js";
+import { AnyTRPCRouter } from "@trpc/server";
+//#region src/runtime/server/createTRPCWebSocketHandler.d.ts
+export declare const createTRPCWebSocketHandler: <TRouter extends AnyTRPCRouter>({ createContext, onClose, onOpen, ...options }: TRPCWebSocketHandlerOptions<TRouter>) => TRPCWebSocketHandler;
+//#endregion

package/dist/runtime/server/createTRPCWebSocketHandler.js

@@ -0,0 +1,63 @@
+import { PeerWebSocketAdapter } from "./models/PeerWebSocketAdapter.js";
+import { WebSocketServerAdapter } from "./models/WebSocketServerAdapter.js";
+import { toIncomingMessage } from "./services/toIncomingMessage.js";
+import { applyWSSHandler } from "@trpc/server/adapters/ws";
+//#region src/runtime/server/createTRPCWebSocketHandler.ts
+const createTRPCWebSocketHandler = ({ createContext, onClose, onOpen, ...options }) => {
+	const webSocketServer = new WebSocketServerAdapter();
+	const { broadcastReconnectNotification } = applyWSSHandler({
+		...options,
+		createContext,
+		wss: webSocketServer
+	});
+	const peerConnections = /* @__PURE__ */ new Map();
+	return {
+		broadcastReconnectNotification,
+		hooks: {
+			close: async (peer, { code, reason }) => {
+				const peerConnection = peerConnections.get(peer.id);
+				if (!peerConnection) return;
+				peerConnections.delete(peer.id);
+				peerConnection.client.receiveClose(code, reason);
+				await onClose?.({
+					context: await peerConnection.context,
+					peer
+				});
+			},
+			error: (peer, error) => {
+				peerConnections.get(peer.id)?.client.receiveError(error);
+			},
+			message: (peer, message) => {
+				peerConnections.get(peer.id)?.client.receiveMessage(message.text());
+			},
+			open: async (peer) => {
+				const client = new PeerWebSocketAdapter(peer);
+				const request = toIncomingMessage(peer);
+				const context = Promise.resolve(createContext({
+					info: {
+						accept: null,
+						calls: [],
+						connectionParams: null,
+						isBatchCall: false,
+						signal: new AbortController().signal,
+						type: "unknown",
+						url: new URL(peer.request.url)
+					},
+					req: request,
+					res: client
+				}));
+				peerConnections.set(peer.id, {
+					client,
+					context
+				});
+				webSocketServer.addConnection(client, request);
+				await onOpen?.({
+					context: await context,
+					peer
+				});
+			}
+		}
+	};
+};
+//#endregion
+export { createTRPCWebSocketHandler };

package/dist/runtime/server/models/PeerWebSocketAdapter.d.ts

@@ -0,0 +1,19 @@
+import { EventEmitter } from "node:events";
+import { Peer } from "crossws";
+//#region src/runtime/server/models/PeerWebSocketAdapter.d.ts
+export declare class PeerWebSocketAdapter extends EventEmitter {
+  #private;
+  readonly CLOSED: number;
+  readonly CLOSING: number;
+  readonly CONNECTING: number;
+  readonly OPEN: number;
+  readyState: number;
+  constructor(peer: Peer);
+  close(code?: number, reason?: string): void;
+  receiveClose(code?: number, reason?: string): void;
+  receiveError(error: unknown): void;
+  receiveMessage(message: string): void;
+  send(data: string): void;
+  terminate(): void;
+}
+//#endregion

package/dist/runtime/server/models/PeerWebSocketAdapter.js

@@ -0,0 +1,37 @@
+import { EventEmitter } from "node:events";
+//#region src/runtime/server/models/PeerWebSocketAdapter.ts
+var PeerWebSocketAdapter = class extends EventEmitter {
+	CLOSED = WebSocket.CLOSED;
+	CLOSING = WebSocket.CLOSING;
+	CONNECTING = WebSocket.CONNECTING;
+	OPEN = WebSocket.OPEN;
+	readyState = WebSocket.OPEN;
+	#peer;
+	constructor(peer) {
+		super();
+		this.#peer = peer;
+	}
+	close(code, reason) {
+		this.readyState = WebSocket.CLOSING;
+		this.#peer.close(code, reason);
+	}
+	receiveClose(code, reason) {
+		this.readyState = WebSocket.CLOSED;
+		this.emit("close", code, reason);
+	}
+	receiveError(error) {
+		this.emit("error", error);
+	}
+	receiveMessage(message) {
+		this.emit("message", Buffer.from(message), false);
+	}
+	send(data) {
+		this.#peer.send(data);
+	}
+	terminate() {
+		this.readyState = WebSocket.CLOSING;
+		this.#peer.terminate();
+	}
+};
+//#endregion
+export { PeerWebSocketAdapter };

package/dist/runtime/server/models/TRPCEventHandlerOptions.d.ts

@@ -0,0 +1,11 @@
+import { AnyTRPCRouter, inferRouterContext } from "@trpc/server";
+import { H3Event } from "nitro/h3";
+import { FetchCreateContextFnOptions } from "@trpc/server/adapters/fetch";
+import { Promisable } from "type-fest";
+import { HTTPBaseHandlerOptions } from "@trpc/server/http";
+//#region src/runtime/server/models/TRPCEventHandlerOptions.d.ts
+export type TRPCEventHandlerOptions<TRouter extends AnyTRPCRouter> = HTTPBaseHandlerOptions<TRouter, Request> & {
+  createContext?: (event: H3Event, options: FetchCreateContextFnOptions) => Promisable<inferRouterContext<TRouter>>;
+  endpoint?: string;
+};
+//#endregion

package/dist/runtime/server/models/TRPCEventHandlerOptions.js

@@ -0,0 +1 @@
+export {};

package/dist/runtime/server/models/TRPCWebSocketConnection.d.ts

@@ -0,0 +1,7 @@
+import { Peer } from "crossws";
+//#region src/runtime/server/models/TRPCWebSocketConnection.d.ts
+export interface TRPCWebSocketConnection<TContext> {
+  context: TContext;
+  peer: Peer;
+}
+//#endregion

package/dist/runtime/server/models/TRPCWebSocketConnection.js

@@ -0,0 +1 @@
+export {};

package/dist/runtime/server/models/TRPCWebSocketHandler.d.ts

@@ -0,0 +1,7 @@
+import { Hooks } from "crossws";
+//#region src/runtime/server/models/TRPCWebSocketHandler.d.ts
+export interface TRPCWebSocketHandler {
+  broadcastReconnectNotification: () => void;
+  hooks: Partial<Hooks>;
+}
+//#endregion

package/dist/runtime/server/models/TRPCWebSocketHandler.js

@@ -0,0 +1 @@
+export {};

package/dist/runtime/server/models/TRPCWebSocketHandlerOptions.d.ts

@@ -0,0 +1,13 @@
+import { TRPCWebSocketConnection } from "./TRPCWebSocketConnection.js";
+import { AnyTRPCRouter, inferRouterContext } from "@trpc/server";
+import { IncomingMessage } from "node:http";
+import { CreateWSSContextFnOptions, WSSHandlerOptions } from "@trpc/server/adapters/ws";
+import { Promisable } from "type-fest";
+import { BaseHandlerOptions } from "@trpc/server/http";
+//#region src/runtime/server/models/TRPCWebSocketHandlerOptions.d.ts
+export type TRPCWebSocketHandlerOptions<TRouter extends AnyTRPCRouter> = BaseHandlerOptions<TRouter, IncomingMessage> & Pick<WSSHandlerOptions<TRouter>, "dangerouslyDisablePong" | "experimental_encoder" | "keepAlive" | "prefix"> & {
+  createContext: (options: CreateWSSContextFnOptions) => Promisable<inferRouterContext<TRouter>>;
+  onClose?: (connection: TRPCWebSocketConnection<inferRouterContext<TRouter>>) => Promisable<void>;
+  onOpen?: (connection: TRPCWebSocketConnection<inferRouterContext<TRouter>>) => Promisable<void>;
+};
+//#endregion

package/dist/runtime/server/models/TRPCWebSocketHandlerOptions.js

@@ -0,0 +1 @@
+export {};

package/dist/runtime/server/models/WebSocketServerAdapter.d.ts

@@ -0,0 +1,8 @@
+import { EventEmitter } from "node:events";
+import { IncomingMessage } from "node:http";
+//#region src/runtime/server/models/WebSocketServerAdapter.d.ts
+export declare class WebSocketServerAdapter<TClient extends EventEmitter> extends EventEmitter {
+  readonly clients: Set<TClient>;
+  addConnection(client: TClient, request: IncomingMessage): void;
+}
+//#endregion

package/dist/runtime/server/models/WebSocketServerAdapter.js

@@ -0,0 +1,14 @@
+import { EventEmitter } from "node:events";
+//#region src/runtime/server/models/WebSocketServerAdapter.ts
+var WebSocketServerAdapter = class extends EventEmitter {
+	clients = /* @__PURE__ */ new Set();
+	addConnection(client, request) {
+		this.clients.add(client);
+		client.once("close", () => {
+			this.clients.delete(client);
+		});
+		this.emit("connection", client, request);
+	}
+};
+//#endregion
+export { WebSocketServerAdapter };

package/dist/runtime/server/services/toIncomingMessage.d.ts

@@ -0,0 +1,5 @@
+import { IncomingMessage } from "node:http";
+import { Peer } from "crossws";
+//#region src/runtime/server/services/toIncomingMessage.d.ts
+export declare const toIncomingMessage: ({ request }: Peer) => IncomingMessage;
+//#endregion

package/dist/runtime/server/services/toIncomingMessage.js

@@ -0,0 +1,12 @@
+import { IncomingMessage } from "node:http";
+import { Socket } from "node:net";
+//#region src/runtime/server/services/toIncomingMessage.ts
+const toIncomingMessage = ({ request }) => {
+	const incomingMessage = new IncomingMessage(new Socket());
+	const { pathname, search } = new URL(request.url);
+	incomingMessage.url = `${pathname}${search}`;
+	incomingMessage.headers = Object.fromEntries(request.headers);
+	return incomingMessage;
+};
+//#endregion
+export { toIncomingMessage };

package/dist/services/getEventHandlerTemplate.js

@@ -0,0 +1,11 @@
+import { MODULE_NAME } from "../runtime/constants.js";
+import { getImportStatement } from "./getImportStatement.js";
+//#region src/services/getEventHandlerTemplate.ts
+const getEventHandlerTemplate = (router, endpoint, createContext) => [
+	`import { createTRPCEventHandler } from "${MODULE_NAME}/runtime/server/createTRPCEventHandler";`,
+	getImportStatement(router, "router"),
+	...createContext ? [getImportStatement(createContext, "createContext")] : [],
+	`export default createTRPCEventHandler({ ${createContext ? "createContext, " : ""}endpoint: ${JSON.stringify(endpoint)}, router });`
+].join("\n");
+//#endregion
+export { getEventHandlerTemplate };

package/dist/services/getImportStatement.js

@@ -0,0 +1,4 @@
+//#region src/services/getImportStatement.ts
+const getImportStatement = ({ from, name }, localName) => `import { ${name} as ${localName} } from ${JSON.stringify(from)};`;
+//#endregion
+export { getImportStatement };

package/dist/services/getWebSocketHandlerTemplate.js

@@ -0,0 +1,23 @@
+import { MODULE_NAME } from "../runtime/constants.js";
+import { getImportStatement } from "./getImportStatement.js";
+//#region src/services/getWebSocketHandlerTemplate.ts
+const getWebSocketHandlerTemplate = (router, { keepAlive }, createContext) => [
+	`import { useNitroHooks } from "nitro/app";`,
+	`import { defineWebSocketHandler } from "nitro/h3";`,
+	`import { WEBSOCKET_CLOSE_HOOK, WEBSOCKET_OPEN_HOOK } from "${MODULE_NAME}/runtime/constants";`,
+	`import { createTRPCWebSocketHandler } from "${MODULE_NAME}/runtime/server/createTRPCWebSocketHandler";`,
+	getImportStatement(router, "router"),
+	createContext ? getImportStatement(createContext, "createContext") : "const createContext = () => ({});",
+	`const nitroHooks = useNitroHooks();`,
+	`const { broadcastReconnectNotification, hooks } = createTRPCWebSocketHandler({`,
+	`  createContext,`,
+	`  keepAlive: ${JSON.stringify(keepAlive)},`,
+	`  onClose: (connection) => nitroHooks.callHook(WEBSOCKET_CLOSE_HOOK, connection),`,
+	`  onOpen: (connection) => nitroHooks.callHook(WEBSOCKET_OPEN_HOOK, connection),`,
+	`  router,`,
+	`});`,
+	`nitroHooks.hook("close", broadcastReconnectNotification);`,
+	`export default defineWebSocketHandler(hooks);`
+].join("\n");
+//#endregion
+export { getWebSocketHandlerTemplate };

package/dist/services/getWebSocketHooksTypeTemplate.js

@@ -0,0 +1,18 @@
+import { MODULE_NAME, WEBSOCKET_CLOSE_HOOK, WEBSOCKET_OPEN_HOOK } from "../runtime/constants.js";
+//#region src/services/getWebSocketHooksTypeTemplate.ts
+const getWebSocketHooksTypeTemplate = ({ from, name }) => {
+	const connectionType = `TRPCWebSocketConnection<inferRouterContext<typeof import(${JSON.stringify(from)})[${JSON.stringify(name)}]>>`;
+	return [
+		`import type { inferRouterContext } from "@trpc/server";`,
+		`import type { TRPCWebSocketConnection } from "${MODULE_NAME}/runtime/server/models/TRPCWebSocketConnection";`,
+		`declare module "nitro/types" {`,
+		`  interface NitroRuntimeHooks {`,
+		`    ${JSON.stringify(WEBSOCKET_CLOSE_HOOK)}: (connection: ${connectionType}) => Promise<void> | void;`,
+		`    ${JSON.stringify(WEBSOCKET_OPEN_HOOK)}: (connection: ${connectionType}) => Promise<void> | void;`,
+		`  }`,
+		`}`,
+		`export {};`
+	].join("\n");
+};
+//#endregion
+export { getWebSocketHooksTypeTemplate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trpc-nuxt-module",
-  "version": "4.2.0",
+  "version": "4.3.1",
   "description": "tRPC for Nuxt — a Nuxt module that registers your router's HTTP and WebSocket handlers, fetches through the request event during SSR, and decorates the typed client with useQuery, useMutation and useSubscription over useAsyncData.",
   "keywords": [
     "nitro",
@@ -74,41 +74,36 @@
   "scripts": {
     "bench": "vitest bench --run",
     "build": "tsdown",
-    "format": "oxfmt",
-    "format:check": "oxfmt --check",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "vitest",
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@esposter/shared": "4.2.0",
+    "@esposter/shared": "4.3.1",
     "@nuxt/kit": "npm:@nuxt/kit-nightly@5x",
     "@nuxt/schema": "npm:@nuxt/schema-nightly@5x",
     "ohash": "^2.0.12",
     "type-fest": "^5.10.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/core": "^0.18.5",
-    "@esposter/configuration": "4.2.0",
-    "@esposter/shared-node": "4.2.0",
+    "@esposter/configuration": "4.3.1",
+    "@esposter/shared-node": "4.3.1",
     "@nuxt/nitro-server": "npm:@nuxt/nitro-server-nightly@5x",
-    "@nuxt/test-utils": "^4.3.3",
+    "@nuxt/test-utils": "^4.3.4",
     "@types/node": "^26.6.5",
-    "happy-dom": "^21.0.1",
-    "publint": "^0.3.25",
+    "happy-dom": "^21.0.4",
     "superjson": "^2.2.6",
     "tsdown": "^0.23.1",
-    "vitest": "^5.0.4",
     "zod": "^4.6.7"
   },
   "peerDependencies": {
     "@trpc/client": "^11.19.0",
     "@trpc/server": "^11.19.0",
     "crossws": "^0.4.15",
-    "nitro": "npm:nitro-nightly@latest",
+    "nitro": "npm:nitro-nightly@3.0.1-20261018-005730-bb9894fe",
     "nuxt": "npm:nuxt-nightly@5x",
     "vue": "^3.5.44"
   },
-  "gitHead": "fef4971cf6a621a2c1850f32fcec19ee4ec0de99"
+  "gitHead": "777a39636b789c13af33ed13370246ccf6dbaf31"
 }