orpc-nuxt 0.3.0 → 0.3.1

package/README.md

@@ -454,34 +454,22 @@ Each procedure leaf in `procedures` has a `.handle()` method that registers a ty
 // test/nuxt/setup.ts
 import { mockNuxtImport } from "@nuxt/test-utils/runtime"
 import type { RouterClient } from "@orpc/server"
-import { QueryClient } from "@tanstack/vue-query"
 import { createTestORPCClient } from "orpc-nuxt/testing"
 import { afterEach } from "vitest"
 
 import type { router } from "~~/server/rpc/router"
 
-const queryClient = new QueryClient({
-  // Report a failing procedure instead of retrying it until the test times out.
-  defaultOptions: { queries: { retry: false } },
-})
-
-export const { client, procedures, reset } = createTestORPCClient<RouterClient<typeof router>>({
-  queryClient,
-})
+export const { client, procedures, reset } = createTestORPCClient<RouterClient<typeof router>>()
 
 // Return the composable itself; Vitest hoists this factory before the setup file runs.
 mockNuxtImport("useOrpc", () => () => client)
 
-afterEach(() => {
-  reset() // Remove registered handlers.
-  queryClient.clear() // Remove cached responses.
-})
+afterEach(reset)
 ```
 
 `orpc-nuxt/testing` does not import `nuxt/app`, so the hoisted `mockNuxtImport()` factory can load it safely.
-The explicit QueryClient keeps the test cache isolated and lets the setup clear it after each test.
-To use the application's QueryClient instead, omit the option and configure its defaults through `orpc.queryClient`.
-In that mode, import `useOrpcQueryClient()` only from a module that the hoisted factory cannot reach.
+The client owns a QueryClient that never retries, so a failing procedure fails the test instead of timing out, and `reset()` removes the registered handlers together with the cached responses.
+Reach that cache as `queryClient` to seed or inspect it, or pass your own to `createTestORPCClient()`; `reset()` clears that one as well.
 
 Register the required handlers before mounting; `mountSuspended()` waits for awaited queries before assertions:
 

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": "^3.14.1592 || ^4.0.1"
   },
-  "version": "0.3.0",
+  "version": "0.3.1",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "3.6.1"

package/dist/runtime/testing.d.ts

@@ -1,4 +1,5 @@
 import type { AnyNestedClient, Client } from "@orpc/client";
+import { QueryClient } from "@tanstack/vue-query";
 import type { Mock } from "vitest";
 import type { ORPCNuxtClient, ORPCNuxtClientOptions } from "./types.js";
 type MaybePromise<T> = T | Promise<T>;
@@ -19,7 +20,9 @@ export interface TestORPCClient<T extends AnyNestedClient> {
     client: ORPCNuxtClient<T>;
     /** Register typed implementations and receive Vitest mocks for call assertions. */
     procedures: TestORPCProcedures<T>;
-    /** Remove every registered procedure implementation. */
+    /** The cache the client reads and writes, to seed or inspect from a test. */
+    queryClient: QueryClient;
+    /** Remove every registered procedure implementation and clear the query cache. */
     reset: () => void;
 }
 /**
@@ -27,8 +30,11 @@ export interface TestORPCClient<T extends AnyNestedClient> {
  * The entrypoint has no Nuxt runtime dependency.
  * A shared setup file can therefore import it when Vitest hoists `mockNuxtImport()`.
  *
- * @param options - Cache key prefix and an optional test-owned QueryClient.
- * @returns A decorated client, its typed registration tree and a registration reset function.
+ * Without a `queryClient` the client owns one that never retries, so a failing procedure fails
+ * the test instead of retrying until it times out.
+ *
+ * @param options - Cache key prefix and a QueryClient to use instead of the owned one.
+ * @returns A decorated client, its typed registration tree, its cache and a reset function.
  */
 export declare function createTestORPCClient<T extends AnyNestedClient>(options?: ORPCNuxtClientOptions): TestORPCClient<T>;
 export {};

package/dist/runtime/testing.js

@@ -1,8 +1,15 @@
 import { createORPCClient } from "@orpc/client";
+import { QueryClient } from "@tanstack/vue-query";
 import { vi } from "vitest";
 import { createORPCNuxtClient } from "./client/create.js";
 export function createTestORPCClient(options = {}) {
   const registrations = /* @__PURE__ */ new Map();
+  const queryClient = options.queryClient ?? new QueryClient({
+    defaultOptions: {
+      // Retries turn a failing procedure into a test timeout instead of a reported failure.
+      queries: { retry: false }
+    }
+  });
   function registerHandler(path, handler) {
     const mock = vi.fn(handler);
     registrations.set(path, mock);
@@ -20,7 +27,7 @@ export function createTestORPCClient(options = {}) {
       return await callHandler(path.join("."), input);
     }
   };
-  const client = createORPCNuxtClient(createORPCClient(link), options);
+  const client = createORPCNuxtClient(createORPCClient(link), { ...options, queryClient });
   const procedures = createRecursiveProxy([], (path, args) => {
     if (path.at(-1) !== "handle") {
       throw new Error(`Unknown test procedure call: ${path.join(".")}`);
@@ -36,7 +43,11 @@ export function createTestORPCClient(options = {}) {
   return {
     client,
     procedures,
-    reset: () => registrations.clear()
+    queryClient,
+    reset: () => {
+      registrations.clear();
+      queryClient.clear();
+    }
   };
 }
 function createRecursiveProxy(path, call) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orpc-nuxt",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "oRPC integration for Nuxt with TanStack Vue Query composables.",
   "homepage": "https://github.com/IlyaSemenov/orpc-nuxt#readme",
   "bugs": "https://github.com/IlyaSemenov/orpc-nuxt/issues",