orpc-nuxt 0.1.0 → 0.1.1

package/README.md

@@ -165,7 +165,29 @@ Invalidation marks matching queries as stale and refetches active ones.
 Inactive queries can refresh when used again.
 Create the decorated client inside your app plugin so callbacks use that app's QueryClient.
 
-## Updating cached data
+## Direct calls and oRPC utilities
+
+Use `.call()` when you just need a procedure's response, without query state or caching:
+
+```ts
+const post = await orpc.blog.posts.get.call({ id: 1 })
+```
+
+The client also exposes oRPC's utilities:
+
+- `.key()` builds a cache key prefix for a procedure or router branch.
+- `.queryKey()` builds a query key for a specific input.
+- `.queryOptions()` builds options for Vue Query's `useQuery`.
+- `.mutationOptions()` builds options for Vue Query's `useMutation`.
+- `.infiniteOptions()` builds options for Vue Query's `useInfiniteQuery` for pagination.
+
+Subscription composables are not available yet.
+Procedures that return streams keep the oRPC utilities but do not get this package's `useQuery` or `useMutation` methods.
+The module does not automatically transfer streamed query results from server to browser.
+
+## Query data
+
+### Updating cached data
 
 Assigning a new response to `data.value` updates the shared cache for the query's current input.
 Other components reading the same query see the update too.
@@ -173,19 +195,19 @@ Nested properties are readonly unless you enable `clone: true`.
 
 ```ts
 const { data } = await orpc.blog.posts.get.useQuery({ id: 1 })
-const savePost = orpc.blog.posts.update.useMutation()
 
-const response = await savePost.mutateAsync({
+const response = await orpc.blog.posts.update.call({
   id: 1,
   title: "Updated title",
 })
+
 data.value = response
 ```
 
 Treat the original `response` as readonly after assigning it to `data.value`.
 The assignment passes it to the cache without a defensive copy, so changing `response.title` could modify cached data directly.
 
-## Editing drafts
+### Mutable data
 
 With `clone: true`, `data.value` contains a reactive local copy that you can edit, for example in a form.
 There are two ways to change it:
@@ -197,14 +219,12 @@ There are two ways to change it:
 const id = 1
 const { data } = await orpc.blog.posts.get.useQuery({ id }, { clone: true })
 
-const savePost = orpc.blog.posts.update.useMutation()
-
 if (data.value) {
   // Only this query's local copy changes.
   data.value.title = "Local draft"
 
   // Save the draft, then share the server's response with other components.
-  data.value = await savePost.mutateAsync({
+  data.value = await orpc.blog.posts.update.call({
     id,
     title: data.value.title,
   })
@@ -219,21 +239,6 @@ Keep a separate form draft if it must survive these updates.
 
 You cannot combine `clone: true` with `select`; selected results are readonly.
 
-## Direct calls and oRPC utilities
-
-Use `.call()` when you just need a procedure's response, without query state or caching:
-
-```ts
-const post = await orpc.blog.posts.get.call({ id: 1 })
-```
-
-The client also exposes oRPC's `.key()`, `.queryKey()`, `.queryOptions()`, `.mutationOptions()`, and `.infiniteOptions()` utilities.
-You can pass their options to Vue Query composables, for example `.infiniteOptions()` to `useInfiniteQuery` for pagination.
-
-Subscription composables are not available yet.
-Procedures that return streams keep the oRPC utilities but do not get this package's `useQuery` or `useMutation` methods.
-The module does not automatically transfer streamed query results from server to browser.
-
 ## Advanced
 
 ### Separate API service
@@ -442,6 +447,6 @@ Install dependencies with `bun install`, then run `bun run build`, `bun run type
 To try the package in a Nuxt app, build it and run `bunx nuxt dev tests/fixtures/nuxt`.
 The example app uses the built package, so rebuild after changing its source.
 
-Run `bunx playwright install chromium`, then `bun run test:nuxt` to check the packed npm archive with Nuxt 3.17.5 and Nuxt 4.5.2.
+Run `bunx playwright install chromium`, then `bun run test:nuxt` to check the packed npm archive with the oldest and newest supported Nuxt 3 and Nuxt 4 releases.
 Each version is checked with both module-managed and app-managed QueryClients, including types, SSR, and hydration in development and production.
-To check one version, use `bun run test:nuxt 3.17.5`.
+To check one version, use `bun run test:nuxt 3.14.1592`.

package/dist/module.json

@@ -2,9 +2,9 @@
   "name": "orpc-nuxt",
   "configKey": "orpc",
   "compatibility": {
-    "nuxt": "^3.17.5 || ^4.0.0"
+    "nuxt": "^3.14.1592 || ^4.0.1"
   },
-  "version": "0.1.0",
+  "version": "0.1.1",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -5,7 +5,7 @@ const module$1 = defineNuxtModule({
   meta: {
     name: "orpc-nuxt",
     configKey: "orpc",
-    compatibility: { nuxt: "^3.17.5 || ^4.0.0" }
+    compatibility: { nuxt: "^3.14.1592 || ^4.0.1" }
   },
   defaults: { queryClient: true },
   setup(options, nuxt) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "orpc-nuxt",
-  "version": "0.1.0",
-  "description": "oRPC integration for Nuxt.",
+  "version": "0.1.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",
   "license": "MIT",
@@ -50,8 +50,8 @@
     "types": "tsc --noEmit && tsc --noEmit -p tests/tsconfig.json && nuxt typecheck tests/fixtures/nuxt"
   },
   "dependencies": {
-    "@nuxt/kit": "^4.5.2",
-    "devalue": "^5.9.2",
+    "@nuxt/kit": "^3.14.1592 || ^4.0.1",
+    "devalue": "^5.0.0",
     "es-toolkit": "^1.52.0"
   },
   "devDependencies": {
@@ -75,7 +75,7 @@
     "@orpc/client": "2.0.0-beta.35",
     "@orpc/tanstack-query": "2.0.0-beta.35",
     "@tanstack/vue-query": "^5.102.8",
-    "nuxt": "^3.17.5 || ^4.0.0",
+    "nuxt": "^3.14.1592 || ^4.0.1",
     "vue": "^3.5.0"
   },
   "packageManager": "bun@1.3.14"