chore(release): v0.10.8

fix: make useQuery return data nullable (#113)

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: wobsoriano

CHANGELOG.md

@@ -0,0 +1,99 @@
+# Changelog
+
+
+## v0.10.8
+
+[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.7...v0.10.8)
+
+### 💅 Refactors
+
+- Use built-in getRequestURL from h3 instead of ufo ([252f610](https://github.com/wobsoriano/trpc-nuxt/commit/252f610))
+- Use stand-alone getErrorShape ([3db0b31](https://github.com/wobsoriano/trpc-nuxt/commit/3db0b31))
+
+### 📖 Documentation
+
+- Add handler param description ([f86ebcd](https://github.com/wobsoriano/trpc-nuxt/commit/f86ebcd))
+
+### 📦 Build
+
+- **deps:** Bump h3 to 1.8.0 ([3a395a7](https://github.com/wobsoriano/trpc-nuxt/commit/3a395a7))
+- Bump local deps ([dc317c2](https://github.com/wobsoriano/trpc-nuxt/commit/dc317c2))
+
+### ❤️  Contributors
+
+- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
+
+## v0.10.7
+
+[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.6...v0.10.7)
+
+### 🩹 Fixes
+
+- Make useQuery return data nullable ([120ebc5](https://github.com/wobsoriano/trpc-nuxt/commit/120ebc5))
+
+### 📖 Documentation
+
+- Update Server Side Calls docs ([1c638a8](https://github.com/wobsoriano/trpc-nuxt/commit/1c638a8))
+
+### ❤️  Contributors
+
+- Blechlawine <marczinser@gmx.de>
+- Colonel-Sandvich
+
+## v0.10.6
+
+[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.5...v0.10.6)
+
+### 🏡 Chore
+
+- **deps**:
+  - Bump h3 to 1.7.1 &nbsp;-&nbsp; by @wobsoriano [<samp>(12d8c)</samp>](https://github.com/wobsoriano/trpc-nuxt/commit/12d8c97f71bedb025b2e7914db13e69e5f62c8a2)
+  - Bump ofetch to 1.1.1 &nbsp;-&nbsp; by @wobsoriano [<samp>(811a6)</samp>](https://github.com/wobsoriano/trpc-nuxt/commit/811a6340107a2bea53f2cf488416bcec915f88b0)
+
+## v0.10.5
+
+[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.4...v0.10.5)
+
+
+### 🚀 Enhancements
+
+  - Pass input to watched sources if it's a ref ([892d167](https://github.com/wobsoriano/trpc-nuxt/commit/892d167))
+
+### ❤️  Contributors
+
+- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
+
+## v0.10.4
+
+[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.3...v0.10.4)
+
+
+### 🚀 Enhancements
+
+  - Add reactive inputs ([054fad9](https://github.com/wobsoriano/trpc-nuxt/commit/054fad9))
+
+### 📖 Documentation
+
+  - Update local deps ([7683499](https://github.com/wobsoriano/trpc-nuxt/commit/7683499))
+
+### 🏡 Chore
+
+  - Remove engines property ([e15a62a](https://github.com/wobsoriano/trpc-nuxt/commit/e15a62a))
+
+### ❤️  Contributors
+
+- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
+
+## v0.10.3
+
+[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.2...v0.10.3)
+
+
+### 🚀 Enhancements
+
+  - Export createH3ApiHandler for h3 apps ([18cd492](https://github.com/wobsoriano/trpc-nuxt/commit/18cd492))
+
+### ❤️  Contributors
+
+- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
+

README.md

@@ -1,3 +1,9 @@
+<p align="center">
+  <figure>
+    <img src="https://trpc-nuxt.vercel.app/cover.jpg" alt="trpc-nuxt cover image" />
+  </figure>
+</p>
+
 # tRPC-Nuxt
 
 End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
@@ -19,7 +25,11 @@ For version 3 of this module (tRPC v9, auto-imports, auto handlers), [go here](h
 
 ## Recommended IDE Setup
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+-   [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+
+## Acknowledgements
+
+Huge thanks to [Alex / KATT](https://github.com/KATT), the author of [tRPC](https://trpc.io/), for being the first sponsor of this project! 🎉 
 
 ## License
 

client.d.ts

@@ -0,0 +1 @@
+export * from './dist/client/index'

docs/app.config.ts

@@ -1,25 +1,38 @@
 export default defineAppConfig({
-  docus: {
+	docus: {
-    title: 'tRPC Nuxt',
+		title: "tRPC Nuxt",
-    image: 'https://og-image.vercel.app/tRPC-Nuxt',
+		description: "End-to-end typesafe APIs in Nuxt applications.",
-    alt: 'tRPC-Nuxt cover',
+		image: "https://og-image.vercel.app/tRPC-Nuxt",
-    url: 'https://trpc-nuxt.vercel.app',
+		alt: "tRPC-Nuxt cover",
-    debug: false,
+		url: "https://trpc-nuxt.vercel.app",
-    socials: {
+		debug: false,
-      github: 'wobsoriano/trpc-nuxt'
+		socials: {
-    },
+			github: "wobsoriano/trpc-nuxt"
-    aside: {
+		},
-      level: 1
+		cover: {
-    },
+			src: "/cover.jpg",
-    footer: {
+			alt: "tRPC-Nuxt module"
-      credits: true,
+		},
-      icons: [
+		header: {
-        {
+			logo: true
-          label: 'NuxtJS',
+		},
-          href: 'https://nuxtjs.org',
+		aside: {
-          component: 'IconNuxt'
+			level: 1
-        }
+		},
-      ]
+		footer: {
-    }
+			credits: {
-  }
+				icon: "IconDocus",
+				text: "Powered by Docus",
+				href: "https://docus.com"
+			},
+			iconLinks: [
+				{
+					label: "NuxtJS",
+					href: "https://nuxt.com",
+					// @ts-expect-error: IDK nuxt
+					component: "IconNuxtLabs"
+				}
+			]
+		}
+	}
 })

docs/components/Logo.vue

@@ -0,0 +1,99 @@
+<template>
+  <div class="logo">
+    <div v-if="$colorMode.value == 'dark'">
+      <svg
+        width="40"
+        height="40"
+        xmlns="http://www.w3.org/2000/svg"
+        viewBox="0 0 509 454.27"
+      >
+        <path
+          d="M363.3,307.79v.31l.28-.48Z"
+          fill="#fff"
+          stroke="#fff"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+        <path
+          d="M16.88,307.79v.3l.27-.46ZM83.1,350.1l.15.25.14-.08Z"
+          fill="#fff"
+          stroke="#fff"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+        <path
+          d="M433.22,259.49V139.58l-102-58.85V49.53L254.48,5.2,251.38,7,177.69,49.53V80.79L75.85,139.58V259.44L4.5,300.64v88.68l76.79,44.33,73.27-42.3,100,57.73,100-57.71,73.23,42.28,76.79-44.33V300.64ZM254.48,19.5l57.89,33.41L254,86.37C238.27,77,212.74,61.79,197.24,52.54Zm64.41,43.94v67.62l-58.22,33.61V96.81Zm-128.82-.75c13.83,8.23,44,26.24,58.22,34.69v67.29l-58.22-33.61ZM16.88,307.79l.27-.16-.27.46Zm58.22,108L16.88,382.16V313.8L75.1,348.49Zm5.7-78.29c.71.41-55.37-33-56.76-33.82L81.29,270.6,139.18,304Zm2.45,12.87-.15-.25.29.17Zm62.45,31.81-3.52,2-54.7,31.57V347.92l58.22-33.37Zm205.22-81.52v78.49l-96.39,55.65-96.45-55.69V300.64L88.23,260.32V146.73l89.46-51.65V138.2l76.79,44.33,76.79-44.33V95l89.57,51.71V260.27Zm12.66,7-.28.48v-.31Zm57.94,108.15-54.65-31.55-3.57-2.06V313.79l58.22,34.7Zm5.7-78.29-56.76-33.82,57.25-33.06L485.59,304Zm64.9,44.68L433.9,415.77V347.92l58.22-33.37Z"
+          fill="#fff"
+          stroke="#fff"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+        <path
+          d="M83.1,350.1l.15.25.14-.08Zm0,0,.15.25.14-.08Zm0,0,.15.25.14-.08Z"
+          fill="#fff"
+          stroke="#fff"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+        <path
+          d="M322.58,277.47l-34.44-57.86a9.2,9.2,0,0,0-3.4-3.3,9.47,9.47,0,0,0-12.67,3.3l-8.81,14.8L246,205.46c-3.46-6-12.61-6-16.07,0l-42.86,72a8.78,8.78,0,0,0,0,9,9.33,9.33,0,0,0,8,4.5h32.19c12.76,0,22.16-5.43,28.64-16,5.44-9.14,18.84-31.66,24.13-40.53l25.26,42.44H271.68L263.26,291h51.29C321.45,291.06,326.22,283.5,322.58,277.47Zm-79-10c-4.3,6.87-9.18,9.38-16.76,9.38H204.34L238,220.24l16.8,28.3Z"
+          fill="#fff"
+          stroke="#fff"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+      </svg>
+    </div>
+
+    <div v-else>
+      <svg
+        width="40"
+        height="40"
+        xmlns="http://www.w3.org/2000/svg"
+        viewBox="0 0 509 454.27"
+      >
+        <path
+          d="M363.3,307.79v.31l.28-.48Z"
+          stroke="#000"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+        <path
+          d="M16.88,307.79v.3l.27-.46ZM83.1,350.1l.15.25.14-.08Z"
+          stroke="#000"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+        <path
+          d="M433.22,259.49V139.58l-102-58.85V49.53L254.48,5.2,251.38,7,177.69,49.53V80.79L75.85,139.58V259.44L4.5,300.64v88.68l76.79,44.33,73.27-42.3,100,57.73,100-57.71,73.23,42.28,76.79-44.33V300.64ZM254.48,19.5l57.89,33.41L254,86.37C238.27,77,212.74,61.79,197.24,52.54Zm64.41,43.94v67.62l-58.22,33.61V96.81Zm-128.82-.75c13.83,8.23,44,26.24,58.22,34.69v67.29l-58.22-33.61ZM16.88,307.79l.27-.16-.27.46Zm58.22,108L16.88,382.16V313.8L75.1,348.49Zm5.7-78.29c.71.41-55.37-33-56.76-33.82L81.29,270.6,139.18,304Zm2.45,12.87-.15-.25.29.17Zm62.45,31.81-3.52,2-54.7,31.57V347.92l58.22-33.37Zm205.22-81.52v78.49l-96.39,55.65-96.45-55.69V300.64L88.23,260.32V146.73l89.46-51.65V138.2l76.79,44.33,76.79-44.33V95l89.57,51.71V260.27Zm12.66,7-.28.48v-.31Zm57.94,108.15-54.65-31.55-3.57-2.06V313.79l58.22,34.7Zm5.7-78.29-56.76-33.82,57.25-33.06L485.59,304Zm64.9,44.68L433.9,415.77V347.92l58.22-33.37Z"
+          stroke="#000"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+        <path
+          d="M83.1,350.1l.15.25.14-.08Zm0,0,.15.25.14-.08Zm0,0,.15.25.14-.08Z"
+          stroke="#000"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+        <path
+          d="M322.58,277.47l-34.44-57.86a9.2,9.2,0,0,0-3.4-3.3,9.47,9.47,0,0,0-12.67,3.3l-8.81,14.8L246,205.46c-3.46-6-12.61-6-16.07,0l-42.86,72a8.78,8.78,0,0,0,0,9,9.33,9.33,0,0,0,8,4.5h32.19c12.76,0,22.16-5.43,28.64-16,5.44-9.14,18.84-31.66,24.13-40.53l25.26,42.44H271.68L263.26,291h51.29C321.45,291.06,326.22,283.5,322.58,277.47Zm-79-10c-4.3,6.87-9.18,9.38-16.76,9.38H204.34L238,220.24l16.8,28.3Z"
+          stroke="#000"
+          stroke-miterlimit="10"
+          stroke-width="9"
+        />
+      </svg>
+    </div>
+	
+    <ProseStrong>tRPC Nuxt</ProseStrong>
+  </div>
+</template>
+
+<style scoped>
+	.logo {
+		display: flex;
+		align-items: center;
+		gap: 10px;
+		font-weight: 800;
+	}
+</style>

docs/content/1.get-started/1.installation.md

@@ -8,19 +8,27 @@ description: tRPC-Nuxt provides first class integration with tRPC.
 ::code-group
 
 ```bash [pnpm]
-pnpm add @trpc/server@next @trpc/client@next trpc-nuxt zod
+pnpm add @trpc/server @trpc/client trpc-nuxt zod
 ```
 
 ```bash [npm]
-npm install @trpc/server@next @trpc/client@next trpc-nuxt zod
+npm install @trpc/server @trpc/client trpc-nuxt zod
 ```
 
 ```bash [yarn]
-yarn add @trpc/server@next @trpc/client@next trpc-nuxt zod
+yarn add @trpc/server @trpc/client trpc-nuxt zod
 ```
 
 ::
 
+```ts [nuxt.config.ts]
+export default defineNuxtConfig({
+  build: {
+    transpile: ['trpc-nuxt']
+  }
+})
+```
+
 #### Why @trpc/server?
 
 For implementing tRPC endpoints and routers.

docs/content/1.get-started/2.usage/1.simple.md

@@ -0,0 +1,118 @@
+---
+title: Simple
+description: tRPC-Nuxt provides first class integration with tRPC.
+---
+
+# Simple Usage
+
+## 1. Create a tRPC router
+
+Initialize your tRPC backend using the `initTRPC` function and create your first router.
+
+::code-group
+
+```ts [server/trpc/trpc.ts]
+/**
+ * This is your entry point to setup the root configuration for tRPC on the server.
+ * - `initTRPC` should only be used once per app.
+ * - We export only the functionality that we use so we can enforce which base procedures should be used
+ *
+ * Learn how to create protected base procedures and other things below:
+ * @see https://trpc.io/docs/v10/router
+ * @see https://trpc.io/docs/v10/procedures
+ */
+import { initTRPC } from '@trpc/server'
+
+const t = initTRPC.create()
+
+/**
+ * Unprotected procedure
+ **/
+export const publicProcedure = t.procedure;
+
+export const router = t.router;
+export const middleware = t.middleware;
+```
+
+```ts [server/api/trpc/[trpc].ts]
+/**
+ * This is the API-handler of your app that contains all your API routes.
+ * On a bigger app, you will probably want to split this file up into multiple files.
+ */
+import { createNuxtApiHandler } from 'trpc-nuxt'
+import { publicProcedure, router } from '~/server/trpc/trpc'
+import { z } from 'zod'
+
+export const appRouter = router({
+  hello: publicProcedure
+    // This is the input schema of your procedure
+    .input(
+      z.object({
+        text: z.string().nullish(),
+      }),
+    )
+    .query(({ input }) => {
+      // This is what you're returning to your client
+      return {
+        greeting: `hello ${input?.text ?? 'world'}`,
+      }
+    }),
+})
+
+// export only the type definition of the API
+// None of the actual implementation is exposed to the client
+export type AppRouter = typeof appRouter;
+
+// export API handler
+export default createNuxtApiHandler({
+  router: appRouter,
+  createContext: () => ({}),
+})
+```
+
+::
+
+## 2. Create tRPC client plugin
+
+Create a strongly-typed plugin using your API's type signature.
+
+```ts [plugins/client.ts]
+import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
+import type { AppRouter } from '~/server/api/trpc/[trpc]'
+
+export default defineNuxtPlugin(() => {
+  /**
+   * createTRPCNuxtClient adds a `useQuery` composable
+   * built on top of `useAsyncData`.
+   */
+  const client = createTRPCNuxtClient<AppRouter>({
+    links: [
+      httpBatchLink({
+        url: '/api/trpc',
+      }),
+    ],
+  })
+
+  return {
+    provide: {
+      client,
+    },
+  }
+})
+```
+
+## 3. Make an API request
+
+```vue [pages/index.vue]
+<script setup lang="ts">
+const { $client } = useNuxtApp()
+
+const { data: hello } = await $client.hello.useQuery({ text: 'client' })
+</script>
+
+<template>
+  <div>
+    <p>{{ hello?.greeting }}</p>
+  </div>
+</template>
+```

docs/content/1.get-started/2.usage/2.recommended.md

@@ -1,13 +1,11 @@
 ---
-title: Usage
+title: Recommended
 description: tRPC-Nuxt provides first class integration with tRPC.
 ---
 
-# Usage
+# Recommended Usage
 
-## Recommended file structure
+Recommended but not enforced file structure.
-
-Recommended but not enforced file structure. This is what you get when starting from [the examples](../main/example-apps.md).
 
 ```graphql
 .
@@ -24,7 +22,7 @@ Recommended but not enforced file structure. This is what you get when starting
 │   │   ├── context.ts   # <-- create app context
 │   │   └── trpc.ts      # <-- procedure helpers
 ├── plugins
-│   ├── client.ts  # <-- tRPC Client as a plugin
+│   ├── client.ts  # <-- tRPC client plugin
 └── [..]
 ```
 
@@ -35,16 +33,26 @@ Initialize your tRPC backend using the `initTRPC` function and create your first
 ::code-group
 
 ```ts [server/trpc/trpc.ts]
+/**
+ * This is your entry point to setup the root configuration for tRPC on the server.
+ * - `initTRPC` should only be used once per app.
+ * - We export only the functionality that we use so we can enforce which base procedures should be used
+ *
+ * Learn how to create protected base procedures and other things below:
+ * @see https://trpc.io/docs/v10/router
+ * @see https://trpc.io/docs/v10/procedures
+ */
 import { initTRPC } from '@trpc/server'
+import { Context } from '~/server/trpc/context'
 
-// Avoid exporting the entire t-object since it's not very
+const t = initTRPC.context<Context>().create()
-// descriptive and can be confusing to newcomers used to t
-// meaning translation in i18n libraries.
-const t = initTRPC.create()
 
-// Base router and procedure helpers
+/**
-export const router = t.router
+ * Unprotected procedure
-export const publicProcedure = t.procedure
+ **/
+export const publicProcedure = t.procedure;
+export const router = t.router;
+export const middleware = t.middleware;
 ```
 
 ```ts [server/trpc/routers/index.ts]
@@ -71,15 +79,28 @@ export type AppRouter = typeof appRouter
 
 ```ts [server/api/trpc/[trpc].ts]
 import { createNuxtApiHandler } from 'trpc-nuxt'
-import { appRouter } from '@/server/trpc/routers'
+import { appRouter } from '~/server/trpc/routers'
+import { createContext } from '~/server/trpc/context'
 
 // export API handler
 export default createNuxtApiHandler({
   router: appRouter,
-  createContext: () => ({}),
+  createContext,
 })
 ```
 
+```ts [server/trpc/context.ts]
+import { inferAsyncReturnType } from '@trpc/server'
+
+/**
+ * Creates context for an incoming request
+ * @link https://trpc.io/docs/context
+ */
+export const createContext = () => ({})
+
+export type Context = inferAsyncReturnType<typeof createContext>;
+```
+
 ::
 
 ::alert{type=info}
@@ -91,18 +112,18 @@ If you need to split your router into several subrouters, you can implement them
 Create a strongly-typed plugin using your API's type signature.
 
 ```ts [plugins/client.ts]
-import { httpBatchLink, createTRPCProxyClient } from '@trpc/client'
+import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
-import type { AppRouter } from '@/server/trpc/routers'
+import type { AppRouter } from '~/server/trpc/routers'
 
 export default defineNuxtPlugin(() => {
-  const client = createTRPCProxyClient<AppRouter>({
+  /**
+   * createTRPCNuxtClient adds a `useQuery` composable
+   * built on top of `useAsyncData`.
+   */
+  const client = createTRPCNuxtClient<AppRouter>({
     links: [
       httpBatchLink({
-        /**
+        url: '/api/trpc',
-         * If you want to use SSR, you need to use the server's full URL
-         * @link https://trpc.io/docs/ssr
-         **/
-        url: 'http://localhost:3000/api/trpc',
       }),
     ],
   })
@@ -115,16 +136,18 @@ export default defineNuxtPlugin(() => {
 })
 ```
 
-## 3. Make API requests
+## 3. Make an API request
 
 ```vue [pages/index.vue]
 <script setup lang="ts">
 const { $client } = useNuxtApp()
 
-const data = await $client.hello.query({ text: 'client' })
+const hello = await $client.hello.useQuery({ text: 'client' })
 </script>
 
 <template>
-  <p>{{data?.greeting }}</p>
+  <div>
+    <p>{{ hello.data?.greeting }}</p>
+  </div>
 </template>
 ```

docs/content/1.get-started/3.client.md

@@ -0,0 +1,53 @@
+---
+title: Client
+description: tRPC-Nuxt provides first class integration with tRPC.
+---
+
+# Nuxt client
+
+The magic of tRPC is making strongly typed API calls without relying on code generation. With full-stack TypeScript projects, you can directly import types from the server into the client! This is a vital part of how tRPC works.
+
+## Initialize a tRPC client
+
+Create a typesafe client via a Nuxt [plugin](https://nuxt.com/docs/guide/directory-structure/plugins) with the `createTRPCNuxtClient` method from `trpc-nuxt/client`, and add a `links` array with a [terminating link](https://trpc.io/docs/links#the-terminating-link). If you want to learn more about tRPC links, check out the docs [here](https://trpc.io/docs/links):
+
+::alert{type="info"}
+`createTRPCNuxtClient` extends [createTRPCProxyClient](https://trpc.io/docs/vanilla#initialize-a-trpc-client) and adds a `useQuery` method built on top of [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data).
+::
+
+```ts [plugins/client.ts]
+import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
+import type { AppRouter } from '~/server/trpc/routers'
+
+export default defineNuxtPlugin(() => {
+  const client = createTRPCNuxtClient<AppRouter>({
+    links: [
+      httpBatchLink({
+        url: '/api/trpc',
+      }),
+    ],
+  })
+
+  return {
+    provide: {
+      client,
+    },
+  }
+})
+```
+
+As you can see, we passed `AppRouter` as a type argument of `createTRPCNuxtClient`. This returns a strongly typed `client` instance, a proxy that mirrors the structure of your `AppRouter` on the client:
+
+```vue [pages/index.vue]
+<script setup lang="ts">
+const { $client } = useNuxtApp()
+
+const getUser = await $client.getUser.useQuery('id_bilbo');
+// => { data: { id: 'id_bilbo', name: 'Bilbo' }, pending: false, error: false };
+
+const bilbo = await $client.getUser.query('id_bilbo');
+// => { id: 'id_bilbo', name: 'Bilbo' };
+const frodo = await $client.createUser.mutate({ name: 'Frodo' });
+// => { id: 'id_frodo', name: 'Frodo' };
+</script>
+```

docs/content/1.get-started/4.links/1.httpLink.md

@@ -0,0 +1,58 @@
+---
+title: HTTP Link
+description: httpLink is a terminating link that sends a tRPC operation to a tRPC procedure over HTTP.
+---
+
+# HTTP Link
+
+`httpLink` is a [terminating link](https://trpc.io/docs/links#the-terminating-link) that sends a tRPC operation to a tRPC procedure over HTTP.
+
+`httpLink` supports both POST and GET requests.
+
+::alert{type="info"}
+`httpLink` imported from `trpc-nuxt/client` is a convenience wrapper around the original `httpLink` that replaces regular `fetch` with a [`$fetch`](https://nuxt.com/docs/api/utils/dollarfetch) from Nuxt. It also sets the default headers using [`useRequestHeaders`](https://nuxt.com/docs/api/composables/use-request-headers#userequestheaders).
+::
+
+## Usage
+
+You can import and add the `httpLink` to the `links` array as such:
+
+```ts
+import { createTRPCNuxtClient, httpLink } from 'trpc-nuxt/client'
+import type { AppRouter } from '~/server/trpc/routers'
+
+const client = createTRPCNuxtClient<AppRouter>({
+  links: [
+    httpLink({
+      url: '/api/trpc',
+    }),
+  ],
+})
+```
+
+## `httpLink` Options
+
+The `httpLink` function takes an options object that has the `HTTPLinkOptions` shape.
+
+```ts
+export interface HTTPLinkOptions {
+  url: string;
+  /**
+   * Select headers to pass to `useRequestHeaders`.
+   */
+  pickHeaders?: string[];
+  /**
+   * Add ponyfill for fetch.
+   */
+  fetch?: typeof fetch;
+  /**
+   * Add ponyfill for AbortController
+   */
+  AbortController?: typeof AbortController | null;
+  /**
+   * Headers to be set on outgoing requests or a callback that of said headers
+   * @link http://trpc.io/docs/v10/header
+   */
+  headers?: HTTPHeaders | (() => HTTPHeaders | Promise<HTTPHeaders>);
+}
+```

docs/content/1.get-started/4.links/2.httpBatchLink.md

@@ -0,0 +1,88 @@
+---
+title: HTTP Batch Link
+description: httpBatchLink is a terminating link that batches an array of individual tRPC operations into a single HTTP request that's sent to a single tRPC procedure.
+---
+
+# HTTP Batch Link
+
+`httpBatchLink` is a [terminating link](https://trpc.io/docs/links#the-terminating-link) that batches an array of individual tRPC operations into a single HTTP request that's sent to a single tRPC procedure.
+
+::alert{type="info"}
+`httpBatchLink` imported from `trpc-nuxt/client` is a convenience wrapper around the original `httpBatchLink` that replaces regular `fetch` with a [`$fetch`](https://nuxt.com/docs/api/utils/dollarfetch) from Nuxt. It also sets the default headers using [`useRequestHeaders`](https://nuxt.com/docs/api/composables/use-request-headers#userequestheaders).
+::
+
+## Usage
+
+You can import and add the `httpBatchLink` to the `links` array as such:
+
+```ts
+import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
+import type { AppRouter } from '~/server/trpc/routers'
+
+const client = createTRPCNuxtClient<AppRouter>({
+  links: [
+    httpBatchLink({
+      url: '/api/trpc',
+    }),
+  ],
+})
+```
+
+After that, you can make use of batching by setting all your procedures in a `Promise.all`. The code below will produce exactly one HTTP request and on the server exactly `one` database query:
+
+```ts
+const somePosts = await Promise.all([
+  $client.post.byId.query(1);
+  $client.post.byId.query(2);
+  $client.post.byId.query(3);
+])
+```
+
+## `httpBatchLink` Options
+
+The `httpBatchLink` function takes an options object that has the `HTTPBatchLinkOptions` shape.
+
+```ts
+export interface HttpBatchLinkOptions extends HTTPLinkOptions {
+  maxURLLength?: number;
+}
+
+export interface HTTPLinkOptions {
+  url: string;
+  /**
+   * Select headers to pass to `useRequestHeaders`.
+   */
+  pickHeaders?: string[];
+  /**
+   * Add ponyfill for fetch.
+   */
+  fetch?: typeof fetch;
+  /**
+   * Add ponyfill for AbortController
+   */
+  AbortController?: typeof AbortController | null;
+  /**
+   * Headers to be set on outgoing requests or a callback that of said headers
+   * @link http://trpc.io/docs/v10/header
+   */
+  headers?: HTTPHeaders | (() => HTTPHeaders | Promise<HTTPHeaders>);
+}
+```
+
+## Setting a maximum URL length
+
+When sending batch requests, sometimes the URL can become too large causing HTTP errors like [413 Payload Too Large](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413), [414 URI Too Long](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414), and [404 Not Found](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404). The `maxURLLength` option will limit the number of requests that can be sent together in a batch.
+
+```ts
+import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client';
+import type { AppRouter } from '~/server/trpc/routers'
+
+const client = createTRPCNuxtClient<AppRouter>({
+  links: [
+    httpBatchLink({
+      url: '/api/trpc',
+      maxURLLength: 2083, // a suitable size
+    }),
+  ],
+});
+```

docs/content/1.get-started/5.tips/1.composables.md

@@ -6,6 +6,10 @@ title: Composables
 
 It is often useful to wrap functionality of your `@trpc/client` api within other functions. For this purpose, it's necessary to be able to infer input types and output types generated by your `@trpc/server` router.
 
+::alert{type="info"}
+[createTRPCNuxtClient](/get-started/client/create) already adds a `useQuery` method built on top of [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data/). You might not need this.
+::
+
 ## Inference Helpers
 
 `@trpc/server` exports the following helper types to assist with inferring these types from the `AppRouter` exported by your `@trpc/server` router:

docs/content/1.get-started/5.tips/2.headers.md

@@ -6,6 +6,10 @@ title: Headers
 
 We can use the built-in [useRequestHeaders](https://v3.nuxtjs.org/api/composables/use-request-headers/) to set outgoing request headers:
 
+::alert{type="info"}
+[createTRPCNuxtClient](/get-started/client/create) has this feature by default.
+::
+
 ```ts [plugins/client.ts]
 export default defineNuxtPlugin(() => {
   const headers = useRequestHeaders()

docs/content/1.get-started/5.tips/4.server-side-calls.md

@@ -27,11 +27,11 @@ export const router = t.router({
 ```
 
 ```ts [server/api/greeting.ts]
-import { router } from '@/server/trpc/trpc'
+import { appRouter } from '@/server/trpc/routers'
 
-export default eventHandler(async (event) => {
+export default defineEventHandler(async (event) => {
   const { name } = getQuery(event)
-  const caller = router.createCaller({})
+  const caller = appRouter.createCaller({})
 
   const greeting = await caller.greeting({ name })
 
@@ -67,11 +67,11 @@ export const router = t.router({
 ```
 
 ```ts [server/api/post.ts]
-import { router } from '@/server/trpc/trpc'
+import { appRouter } from '@/server/trpc/routers'
 
-export default eventHandler(async (event) => {
+export default defineEventHandler(async (event) => {
   const body = await getBody(event)
-  const caller = router.createCaller({})
+  const caller = appRouter.createCaller({})
 
   const post = await caller.post.add(body.post)
 

docs/content/index.md

@@ -27,5 +27,6 @@ End-to-end typesafe APIs in Nuxt applications.
   - Automatic typesafety 
   - Snappy DX
   - Autocompletion on the client, for inputs, outputs and errors
+  - Leverages [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data) and [$fetch](https://nuxt.com/docs/api/utils/dollarfetch)
   ::
 ::

docs/package.json

@@ -7,11 +7,9 @@
     "generate": "nuxi build",
     "preview": "nuxi preview"
   },
-  "dependencies": {
-    "nuxt": "^3.0.0"
-  },
   "devDependencies": {
-    "@nuxt-themes/docus": "^0.3.1",
+    "@nuxt-themes/docus": "^1.14.3",
-    "@nuxtlabs/github-module": "^1.5.3"
+    "@nuxtlabs/github-module": "^1.6.3",
+    "nuxt": "3.6.5"
   }
 }

examples/basic-example/.gitignore

@@ -0,0 +1,23 @@
+# Nuxt dev/build outputs
+.output
+.nuxt
+.nitro
+.cache
+dist
+
+# Node dependencies
+node_modules
+
+# Logs
+logs
+*.log
+
+# Misc
+.DS_Store
+.fleet
+.idea
+
+# Local env files
+.env
+.env.*
+!.env.example

examples/basic-example/.npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+strict-peer-dependencies=false

examples/basic-example/README.md

@@ -0,0 +1,63 @@
+# Nuxt 3 Minimal Starter
+
+Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+
+## Setup
+
+Make sure to install the dependencies:
+
+```bash
+# npm
+npm install
+
+# pnpm
+pnpm install
+
+# yarn
+yarn install
+```
+
+## Development Server
+
+Start the development server on `http://localhost:3000`:
+
+```bash
+# npm
+npm run dev
+
+# pnpm
+pnpm run dev
+
+# yarn
+yarn dev
+```
+
+## Production
+
+Build the application for production:
+
+```bash
+# npm
+npm run build
+
+# pnpm
+pnpm run build
+
+# yarn
+yarn build
+```
+
+Locally preview production build:
+
+```bash
+# npm
+npm run preview
+
+# pnpm
+pnpm run preview
+
+# yarn
+yarn preview
+```
+
+Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

examples/basic-example/app.vue

@@ -0,0 +1,127 @@
+<script setup lang="ts">
+const { $client } = useNuxtApp()
+const { data: product } = await $client.products.useQuery()
+
+function formatPrice(num: number) {
+  return `£ ${num.toFixed(2)}`
+}
+</script>
+
+<template>
+  <div class="product-page">
+    <header class="header">
+      <h1 class="header-title">
+        TRPC-Nuxt Basic Example
+      </h1>
+    </header>
+    <div class="card">
+      <div class="card-content">
+        <h3 class="card-title">
+          {{ product.title }}
+        </h3>
+        <p class="card-description">
+          {{ product.description }}
+        </p>
+        <p class="card-price">
+          {{ formatPrice(product.price) }}
+        </p>
+        <button class="card-button">
+          Add to Cart
+        </button>
+      </div>
+    </div>
+  </div>
+</template>
+
+<style>
+body {
+  margin: 0;
+}
+.product-page {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  height: 100vh;
+}
+
+.header {
+  width: 100%;
+  background-color: #41b883;
+  padding: 16px;
+  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+}
+
+.header-title {
+  margin: 0;
+  font-size: 24px;
+  font-weight: bold;
+  color: #fff;
+  text-align: center;
+  font-family: 'Roboto', sans-serif;
+}
+
+.card {
+  width: 300px;
+  border: 1px solid #eaeaea;
+  border-radius: 4px;
+  overflow: hidden;
+  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+  margin-top: 16px;
+
+}
+
+.card-image {
+  width: 100%;
+  height: auto;
+}
+
+.card-content {
+  padding: 16px;
+  background-color: #f9f9f9;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+}
+
+.card-title {
+  margin: 0;
+  font-size: 20px;
+  color: #333;
+  font-family: 'Roboto', sans-serif;
+}
+
+.card-description {
+  margin: 8px 0;
+  font-size: 14px;
+  color: #666;
+  font-family: 'Roboto', sans-serif;
+}
+
+.card-price {
+  margin: 8px 0;
+  font-size: 18px;
+  font-weight: bold;
+  color: #333;
+  font-family: 'Roboto', sans-serif;
+}
+
+.card-button {
+  display: block;
+  width: 100%;
+  padding: 8px;
+  margin-top: 16px;
+  font-size: 16px;
+  font-weight: bold;
+  text-align: center;
+  color: #fff;
+  background-color: #41b883;
+  border: none;
+  border-radius: 4px;
+  cursor: pointer;
+}
+
+.card-button:hover {
+  background-color: #399d7d;
+}
+</style>

examples/basic-example/nuxt.config.ts

@@ -0,0 +1,7 @@
+// https://nuxt.com/docs/api/configuration/nuxt-config
+export default defineNuxtConfig({
+  devtools: { enabled: true },
+  build: {
+    transpile: ['trpc-nuxt'],
+  },
+})

examples/basic-example/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "nuxt-app",
+  "private": true,
+  "scripts": {
+    "build": "nuxt build",
+    "dev": "nuxt dev",
+    "generate": "nuxt generate",
+    "preview": "nuxt preview",
+    "postinstall": "nuxt prepare"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "latest",
+    "@types/node": "^20.4.2",
+    "nuxt": "^3.6.5"
+  },
+  "dependencies": {
+    "@trpc/client": "^10.35.0",
+    "@trpc/server": "^10.35.0",
+    "trpc-nuxt": "workspace:*",
+    "zod": "^3.21.4"
+  }
+}

examples/basic-example/plugins/client.ts

@@ -0,0 +1,22 @@
+import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
+import type { AppRouter } from '~/server/trpc/routers'
+
+export default defineNuxtPlugin(() => {
+  /**
+   * createTRPCNuxtClient adds a `useQuery` composable
+   * built on top of `useAsyncData`.
+   */
+  const client = createTRPCNuxtClient<AppRouter>({
+    links: [
+      httpBatchLink({
+        url: '/api/trpc',
+      }),
+    ],
+  })
+
+  return {
+    provide: {
+      client,
+    },
+  }
+})

examples/basic-example/server/api/trpc/[trpc].ts

@@ -0,0 +1,9 @@
+import { createNuxtApiHandler } from 'trpc-nuxt'
+import { appRouter } from '../../trpc/routers'
+import { createContext } from '../../trpc/context'
+
+// export API handler
+export default createNuxtApiHandler({
+  router: appRouter,
+  createContext,
+})

examples/basic-example/server/trpc/context.ts

@@ -0,0 +1,9 @@
+import { inferAsyncReturnType } from '@trpc/server'
+
+/**
+ * Creates context for an incoming request
+ * @link https://trpc.io/docs/context
+ */
+export const createContext = () => ({})
+
+export type Context = inferAsyncReturnType<typeof createContext>

examples/basic-example/server/trpc/routers/index.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod'
+import { publicProcedure, router } from '../trpc'
+
+export const appRouter = router({
+  hello: publicProcedure
+    .input(
+      z.object({
+        text: z.string().nullish(),
+      })
+    )
+    .query(({ input }) => {
+      console.log(input)
+      return {
+        greeting: `hello ${input?.text ?? 'world'}`,
+      }
+    }),
+  products: publicProcedure.query(async () => {
+    return {
+      title: 'TRPC Nuxt',
+      price: 12.0,
+      description: 'Check out the trpc-nuxt repo',
+    }
+  }),
+})
+
+// export type definition of API
+export type AppRouter = typeof appRouter

examples/basic-example/server/trpc/trpc.ts

@@ -0,0 +1,20 @@
+/**
+ * This is your entry point to setup the root configuration for tRPC on the server.
+ * - `initTRPC` should only be used once per app.
+ * - We export only the functionality that we use so we can enforce which base procedures should be used
+ *
+ * Learn how to create protected base procedures and other things below:
+ * @see https://trpc.io/docs/v10/router
+ * @see https://trpc.io/docs/v10/procedures
+ */
+import { initTRPC } from '@trpc/server'
+import { Context } from '../trpc/context'
+
+const t = initTRPC.context<Context>().create()
+
+/**
+ * Unprotected procedure
+ **/
+export const publicProcedure = t.procedure
+export const router = t.router
+export const middleware = t.middleware

examples/basic-example/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}

examples/basic-example/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  // https://nuxt.com/docs/guide/concepts/typescript
+  "extends": "./.nuxt/tsconfig.json"
+}

package.json

@@ -2,53 +2,60 @@
   "name": "trpc-nuxt",
   "description": "End-to-end typesafe APIs in Nuxt applications.",
   "type": "module",
-  "version": "0.4.3",
+  "packageManager": "pnpm@8.6.9",
+  "version": "0.10.8",
   "license": "MIT",
   "sideEffects": false,
   "exports": {
     ".": {
       "require": "./dist/index.cjs",
       "import": "./dist/index.mjs"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "require": "./dist/client/index.cjs",
+      "import": "./dist/client/index.mjs"
     }
   },
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "client.d.ts"
   ],
   "scripts": {
-    "dev": "concurrently \"pnpm build -- --watch\" \"pnpm --filter playground dev\"",
+    "dev": "tsup --watch --onSuccess \"pnpm --filter playground dev\"",
     "dev:prepare": "pnpm build && nuxt prepare playground",
     "prepublishOnly": "pnpm build",
     "build": "tsup",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "release": "bumpp && npm publish"
+    "release": "changelogen --release && npm publish && git push --follow-tags",
+    "update-deps": "taze -w && pnpm i"
   },
   "peerDependencies": {
-    "@trpc/client": "^10.0.0",
+    "@trpc/client": "^10.26.0",
-    "@trpc/server": "^10.0.0"
+    "@trpc/server": "^10.26.0"
   },
   "dependencies": {
-    "h3": "^1.0.1",
+    "h3": "^1.8.0",
-    "nanoid": "^4.0.0",
+    "ofetch": "^1.1.1",
-    "ohash": "^1.0.0",
+    "ohash": "^1.1.2"
-    "ufo": "^1.0.0"
   },
   "devDependencies": {
-    "@nuxtjs/eslint-config-typescript": "^11.0.0",
+    "@nuxt/eslint-config": "^0.1.1",
-    "@trpc/client": "^10.1.0",
+    "@trpc/client": "^10.37.1",
-    "@trpc/server": "^10.1.0",
+    "@trpc/server": "^10.37.1",
-    "bumpp": "^8.2.1",
+    "changelogen": "^0.5.4",
-    "concurrently": "^7.5.0",
+    "eslint": "^8.45.0",
-    "eslint": "^8.25.0",
+    "taze": "^0.11.2",
-    "tsup": "6.4.0",
+    "tsup": "7.2.0",
-    "typescript": "^4.7.4"
+    "typescript": "^5.1.6"
   },
   "eslintConfig": {
     "extends": [
-      "@nuxtjs/eslint-config-typescript"
+      "@nuxt/eslint-config"
     ],
     "rules": {
       "@typescript-eslint/no-unused-vars": [
@@ -64,5 +71,12 @@
     "*.md",
     "dist",
     ".output"
-  ]
+  ],
-}
+  "pnpm": {
+    "overrides": {
+      "nuxt": "3.6.5",
+      "@trpc/client": "10.37.1",
+      "@trpc/server": "10.37.1"
+    }
+  }
+}

playground/nuxt.config.ts

@@ -1,3 +1,6 @@
 // https://v3.nuxtjs.org/api/configuration/nuxt.config
 export default defineNuxtConfig({
+  build: {
+    transpile: ['trpc-nuxt']
+  }
 })

playground/package.json

@@ -9,13 +9,14 @@
     "postinstall": "nuxt prepare"
   },
   "dependencies": {
-    "@trpc/client": "^10.1.0",
+    "@trpc/client": "^10.37.1",
-    "@trpc/server": "^10.1.0",
+    "@trpc/server": "^10.37.1",
-    "superjson": "^1.11.0",
+    "superjson": "^1.13.1",
     "trpc-nuxt": "workspace:*",
-    "zod": "^3.19.1"
+    "zod": "^3.21.4"
   },
   "devDependencies": {
-    "nuxt": "^3.0.0"
+    "@types/node": "^20.4.2",
+    "nuxt": "3.6.5"
   }
 }

playground/pages/index.vue

@@ -1,8 +1,4 @@
 <script setup lang="ts">
-import { TRPCClientError } from '@trpc/client';
-import type { inferRouterOutputs } from '@trpc/server';
-import type { AppRouter } from '~~/server/trpc/routers';
-
 const { $client } = useNuxtApp()
 
 const addTodo = async () => {
@@ -21,10 +17,7 @@ const addTodo = async () => {
   }
 }
 
-type RouterOutput = inferRouterOutputs<AppRouter>;
+const { data: todos, pending, error, refresh } = await $client.todo.getTodos.useQuery()
-type ErrorOutput = TRPCClientError<AppRouter>
-
-const { data: todos, pending, error, refresh } = await useAsyncData<RouterOutput['todo']['getTodos'], ErrorOutput>(() => $client.todo.getTodos.query())
 </script>
 
 <template>
@@ -37,8 +30,14 @@ const { data: todos, pending, error, refresh } = await useAsyncData<RouterOutput
     </div>
     <div v-else>
       <ul>
-        <li v-for="t in todos?.slice(0, 10)" :key="t.id">
+        <li
-          <NuxtLink :class="{ completed: t.completed }" :to="`/todo/${t.id}`">
+          v-for="t in todos?.slice(0, 10)"
+          :key="t.id"
+        >
+          <NuxtLink
+            :class="{ completed: t.completed }"
+            :to="`/todo/${t.id}`"
+          >
             Title: {{ t.title }}
           </NuxtLink>
         </li>

playground/pages/reactive.vue

@@ -0,0 +1,27 @@
+<script setup lang="ts">
+const route = useRoute()
+const { $client } = useNuxtApp()
+const id = ref(1)
+// const { data: todo, pending, error } = await useAsyncData(() => $client.todo.getTodo.query(id.value), {
+//   watch: [id]
+// })
+
+const { data: todo, pending, error, refresh } = await $client.todo.getTodo.useQuery(id)
+</script>
+
+<template>
+  <div v-if="pending">
+    Loading...
+  </div>
+  <div v-else-if="error?.data?.code">
+    Error: {{ error.data.code }}
+  </div>
+  <div v-else>
+    ID: {{ todo?.id }} <br>
+    Title: {{ todo?.title }} <br>
+    Completed: {{ todo?.completed }}
+  </div>
+  <button @click="id++">
+    Next Todo
+  </button>
+</template>

playground/pages/todo/[id].vue

@@ -8,8 +8,8 @@ const { data: todo, pending, error } = await useAsyncData(() => $client.todo.get
   <div v-if="pending">
     Loading...
   </div>
-  <div v-else-if="error?.data?.code">
+  <div v-else-if="error">
-    {{ error.data.code }}
+    {{ error.message }} - {{ error.cause }}
   </div>
   <div v-else>
     ID: {{ todo?.id }} <br>

playground/plugins/trpc-client.ts

@@ -1,10 +1,10 @@
-import { createTRPCProxyClient, httpBatchLink, loggerLink } from '@trpc/client'
+import { loggerLink } from '@trpc/client'
 import superjson from 'superjson'
+import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
 import type { AppRouter } from '~~/server/trpc/routers'
 
 export default defineNuxtPlugin(() => {
-  const headers = useRequestHeaders()
+  const client = createTRPCNuxtClient<AppRouter>({
-  const client = createTRPCProxyClient<AppRouter>({
     transformer: superjson,
     links: [
       // adds pretty logs to your console in development and logs errors in production
@@ -13,12 +13,7 @@ export default defineNuxtPlugin(() => {
           process.env.NODE_ENV === 'development' ||
           (opts.direction === 'down' && opts.result instanceof Error)
       }),
-      httpBatchLink({
+      httpBatchLink()
-        url: 'http://localhost:3000/api/trpc',
-        headers () {
-          return headers
-        }
-      })
     ]
   })
 

playground/server/trpc/context.ts

@@ -12,7 +12,7 @@ export function createContext (
   event: H3Event
 ) {
   // for API-response caching see https://trpc.io/docs/caching
-  console.log('cookies', parseCookies(event))
+  // console.log('cookies', parseCookies(event))
   
   return {}
 }

pnpm-workspace.yaml

@@ -1,3 +1,4 @@
 packages:
   - playground
+  - examples/*
   - docs

src/client/index.ts

@@ -0,0 +1,84 @@
+import { type CreateTRPCClientOptions, type inferRouterProxyClient, createTRPCProxyClient } from '@trpc/client'
+import { type AnyRouter } from '@trpc/server'
+import { createFlatProxy, createRecursiveProxy } from '@trpc/server/shared'
+import { hash } from 'ohash'
+import { type DecoratedProcedureRecord } from './types'
+// @ts-expect-error: Nuxt auto-imports
+import { getCurrentInstance, onScopeDispose, useAsyncData, unref, isRef } from '#imports'
+
+/**
+ * Calculates the key used for `useAsyncData` call.
+ *
+ * @example
+ *
+ * ```ts
+ * import { getQueryKey } from 'trpc-nuxt/client'
+ *
+ * $client.todo.getTodo(1)
+ * 
+ * const queryKey = getQueryKey('todo.getTodo', 1)
+ * ```
+ */
+export function getQueryKey (
+  path: string,
+  input: unknown
+): string {
+  return input === undefined ? path : `${path}-${hash(input || '')}`
+}
+
+export function createNuxtProxyDecoration<TRouter extends AnyRouter> (name: string, client: inferRouterProxyClient<TRouter>) {
+  return createRecursiveProxy((opts) => {
+    const args = opts.args
+
+    const pathCopy = [name, ...opts.path]
+
+    // The last arg is for instance `.useMutation` or `.useQuery()`
+    const lastArg = pathCopy.pop()!
+
+    // The `path` ends up being something like `post.byId`
+    const path = pathCopy.join('.')
+
+    const [input, otherOptions] = args
+
+    if (lastArg === 'useQuery') {
+      const { trpc, ...asyncDataOptions } = otherOptions || {} as any
+
+      let controller: AbortController
+
+      if (trpc?.abortOnUnmount) {
+        if (getCurrentInstance()) {
+          onScopeDispose(() => {
+            controller?.abort?.()
+          })
+        }
+        controller = typeof AbortController !== 'undefined' ? new AbortController() : {} as AbortController
+      }
+
+      const queryKey = getQueryKey(path, unref(input))
+      return useAsyncData(queryKey, () => (client as any)[path].query(unref(input), {
+        signal: controller?.signal,
+        ...trpc
+      }), {
+        ...asyncDataOptions,
+        watch: isRef(input) ? [...(asyncDataOptions.watch || []), input] : asyncDataOptions.watch
+      })
+    }
+
+    return (client as any)[path][lastArg](...args)
+  })
+}
+
+export function createTRPCNuxtClient<TRouter extends AnyRouter> (opts: CreateTRPCClientOptions<TRouter>) {
+  const client = createTRPCProxyClient<TRouter>(opts)
+
+  const decoratedClient = createFlatProxy((key) => {
+    return createNuxtProxyDecoration(key, client as any)
+  }) as DecoratedProcedureRecord<TRouter['_def']['record'], TRouter>
+
+  return decoratedClient
+}
+
+export {
+  httpBatchLink,
+  httpLink
+} from './links'

src/client/links.ts

@@ -0,0 +1,80 @@
+import { httpLink as _httpLink, httpBatchLink as _httpBatchLink } from '@trpc/client'
+import { type AnyRouter } from '@trpc/server'
+import { FetchError } from 'ofetch'
+// @ts-expect-error: Nuxt auto-imports
+import { useRequestHeaders } from '#imports'
+import { type HTTPLinkOptions as _HTTPLinkOptions } from '@trpc/client/dist/links/httpLink'
+import { type FetchEsque } from '@trpc/client/dist/internals/types'
+
+function customFetch(input: RequestInfo | URL, init?: RequestInit & { method: 'GET' })  {
+  return globalThis.$fetch.raw(input.toString(), init)
+    .catch((e) => {
+      if (e instanceof FetchError && e.response) { return e.response }
+      throw e
+    })
+    .then(response => ({
+      ...response,
+      json: () => Promise.resolve(response._data)
+    }))
+}
+
+export interface HTTPLinkOptions extends _HTTPLinkOptions {
+  /**
+   * Select headers to pass to `useRequestHeaders`.
+   */
+  pickHeaders?: string[] 
+}
+
+/**
+ * This is a convenience wrapper around the original httpLink
+ * that replaces regular `fetch` with a `$fetch` from Nuxt. It
+ * also sets the default headers based on `useRequestHeaders` values.
+ *
+ * During server-side rendering, calling $fetch to fetch your internal API routes
+ * will directly call the relevant function (emulating the request),
+ * saving an additional API call.
+ *
+ * @see https://nuxt.com/docs/api/utils/dollarfetch
+ */
+export function httpLink<TRouter extends AnyRouter>(opts?: HTTPLinkOptions) {
+  const headers = useRequestHeaders(opts?.pickHeaders)
+
+  return _httpLink<TRouter>({
+    url: '/api/trpc',
+    headers () {
+      return headers
+    },
+    fetch: customFetch as FetchEsque,
+    ...opts,
+  })
+}
+
+export interface HttpBatchLinkOptions extends HTTPLinkOptions {
+  maxURLLength?: number;
+}
+
+
+/**
+ * This is a convenience wrapper around the original httpBatchLink
+ * that replaces regular `fetch` with a `$fetch` from Nuxt. It
+ * also sets the default headers based on `useRequestHeaders` values.
+ *
+ * During server-side rendering, calling $fetch to fetch your internal API routes
+ * will directly call the relevant function (emulating the request),
+ * saving an additional API call.
+ *
+ * @see https://nuxt.com/docs/api/utils/dollarfetch
+ */
+export function httpBatchLink<TRouter extends AnyRouter>(opts?: HttpBatchLinkOptions) {
+  const headers = useRequestHeaders(opts?.pickHeaders)
+
+  return _httpBatchLink<TRouter>({
+    url: '/api/trpc',
+    // @ts-expect-error: Missing property from batchLink. Fix this later.
+    headers () {
+      return headers
+    },
+    fetch: customFetch as FetchEsque,
+    ...opts,
+  })
+}

src/client/types.ts

@@ -0,0 +1,83 @@
+import type { TRPCClientErrorLike, TRPCRequestOptions as _TRPCRequestOptions } from '@trpc/client'
+import { type TRPCSubscriptionObserver } from '@trpc/client/dist/internals/TRPCUntypedClient'
+import type {
+  AnyMutationProcedure,
+  AnyProcedure,
+  AnyQueryProcedure,
+  AnyRouter,
+  ProcedureRouterRecord,
+  inferProcedureInput,
+  inferProcedureOutput,
+  ProcedureArgs,
+  AnySubscriptionProcedure
+} from '@trpc/server'
+import { type inferObservableValue, type Unsubscribable } from '@trpc/server/observable'
+import { inferTransformedProcedureOutput } from '@trpc/server/shared'
+import type {
+  AsyncData,
+  AsyncDataOptions,
+  KeysOf,
+  PickFrom,
+} from 'nuxt/dist/app/composables/asyncData'
+import type { Ref } from 'vue'
+
+interface TRPCRequestOptions extends _TRPCRequestOptions {
+  abortOnUnmount?: boolean
+}
+
+type Resolver<TProcedure extends AnyProcedure> = (
+  ...args: ProcedureArgs<TProcedure['_def']>
+) => Promise<inferTransformedProcedureOutput<TProcedure>>;
+
+type SubscriptionResolver<
+  TProcedure extends AnyProcedure,
+  TRouter extends AnyRouter,
+> = (
+  ...args: [
+    input: ProcedureArgs<TProcedure['_def']>[0],
+    opts: ProcedureArgs<TProcedure['_def']>[1] &
+    Partial<
+        TRPCSubscriptionObserver<
+          inferObservableValue<inferProcedureOutput<TProcedure>>,
+          TRPCClientErrorLike<TRouter>
+        >
+      >,
+  ]
+) => Unsubscribable
+
+type MaybeRef<T> = T | Ref<T>
+
+type DecorateProcedure<
+  TProcedure extends AnyProcedure,
+  TRouter extends AnyRouter,
+> = TProcedure extends AnyQueryProcedure
+  ? {
+      useQuery: <
+      ResT = inferTransformedProcedureOutput<TProcedure>,
+      DataE = TRPCClientErrorLike<TProcedure>,
+      DataT = ResT,
+      PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
+     >(
+        input: MaybeRef<inferProcedureInput<TProcedure>>,
+        opts?: AsyncDataOptions<ResT, DataT, PickKeys> & { trpc?: TRPCRequestOptions },
+      ) => AsyncData<PickFrom<DataT, PickKeys> | null, DataE>,
+      query: Resolver<TProcedure>
+    } : TProcedure extends AnyMutationProcedure ? {
+      mutate: Resolver<TProcedure>
+    } : TProcedure extends AnySubscriptionProcedure ? {
+      subscribe: SubscriptionResolver<TProcedure, TRouter>
+    } : never
+
+/**
+* @internal
+*/
+export type DecoratedProcedureRecord<
+  TProcedures extends ProcedureRouterRecord,
+  TRouter extends AnyRouter,
+> = {
+  [TKey in keyof TProcedures]: TProcedures[TKey] extends AnyRouter
+    ? DecoratedProcedureRecord<TProcedures[TKey]['_def']['record'], TRouter>
+    : TProcedures[TKey] extends AnyProcedure
+      ? DecorateProcedure<TProcedures[TKey], TRouter>
+      : never;
+}

src/index.ts

@@ -9,10 +9,10 @@ import type {
 import {
   TRPCError
 } from '@trpc/server'
-import { createURL } from 'ufo'
 import type { H3Event } from 'h3'
-import { createError, defineEventHandler, isMethod, readBody } from 'h3'
+import { createError, defineEventHandler, getRequestURL, isMethod, readBody } from 'h3'
 import type { TRPCResponse } from '@trpc/server/rpc'
+import { getErrorShape } from '@trpc/server/shared'
 
 type MaybePromise<T> = T | Promise<T>
 
@@ -40,9 +40,25 @@ export interface OnErrorPayload<TRouter extends AnyRouter> {
 export type OnErrorFn<TRouter extends AnyRouter> = (opts: OnErrorPayload<TRouter>) => void
 
 export interface ResolveHTTPRequestOptions<TRouter extends AnyRouter> {
+  /**
+   * The tRPC router to use.
+   * @see https://trpc.io/docs/router
+   */
   router: TRouter
+  /**
+   * An async function that returns the tRPC context.
+   * @see https://trpc.io/docs/context
+   */
   createContext?: CreateContextFn<TRouter>
+  /**
+   * A function that returns the response meta.
+   * @see https://trpc.io/docs/caching#using-responsemeta-to-cache-responses
+   */
   responseMeta?: ResponseMetaFn<TRouter>
+  /**
+   * A function that is called when an error occurs.
+   * @see https://trpc.io/docs/error-handling#handling-errors
+   */
   onError?: OnErrorFn<TRouter>
   batching?: {
     enabled: boolean
@@ -50,9 +66,13 @@ export interface ResolveHTTPRequestOptions<TRouter extends AnyRouter> {
 }
 
 function getPath (event: H3Event): string | null {
-  if (typeof event.context.params.trpc === 'string') { return event.context.params.trpc }
+  const { params } = event.context
 
-  if (Array.isArray(event.context.params.trpc)) { return event.context.params.trpc.join('/') }
+  if (typeof params?.trpc === 'string') { return params.trpc }
+
+  if (params?.trpc && Array.isArray(params.trpc)) {
+    return (params.trpc as string[]).join('/')
+  }
 
   return null
 }
@@ -70,15 +90,16 @@ export function createNuxtApiHandler<TRouter extends AnyRouter> ({
       res
     } = event.node
 
-    const $url = createURL(req.url!)
+    const $url = getRequestURL(event)
 
     const path = getPath(event)
 
     if (path === null) {
-      const error = router.getErrorShape({
+      const error = getErrorShape({
+        config: router._def._config,
         error: new TRPCError({
           message:
-            'Param "trpc" not found - is the file named `[trpc]`.ts or `[...trpc].ts`?',
+            'Query "trpc" not found - is the file named `[trpc]`.ts or `[...trpc].ts`?',
           code: 'INTERNAL_SERVER_ERROR'
         }),
         type: 'unknown',
@@ -124,3 +145,5 @@ export function createNuxtApiHandler<TRouter extends AnyRouter> ({
     return body
   })
 }
+
+export const createH3ApiHandler = createNuxtApiHandler

tsup.config.ts

@@ -1,11 +1,11 @@
 import { defineConfig } from 'tsup'
 
 export default defineConfig({
-  entry: ['src/index.ts'],
+  entry: ['src/index.ts', 'src/client/index.ts'],
   format: ['cjs', 'esm'],
   splitting: false,
   clean: true,
-  external: ['#app', '#imports'],
+  external: ['#app', '#imports', /@trpc\/client/, /@trpc\/server/],
   dts: true,
   outExtension ({ format }) {
     return {