release v0.2.4

fix: auto-import `getQueryKey`

.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - run: npx changelogithub
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

README.md

@@ -29,10 +29,10 @@ export default defineNuxtConfig({
   modules: ['trpc-nuxt'],
   trpc: {
     baseURL: 'http://localhost:3000', // defaults to http://localhost:3000
-    trpcURL: '/api/trpc', // defaults to /api/trpc
+    endpoint: '/trpc', // defaults to /trpc
   },
   typescript: {
-    strict: true // set this to true to make input/output types work
+    strict: true // required to make input/output types work
   }
 })
 ```
@@ -99,9 +99,23 @@ const {
 })
 ```
 
+## useClientHeaders
+
+A composable that lets you add additional properties to pass to the tRPC Client. It uses `useStorage` from [@vueuse/core](https://vueuse.org/core/usestorage).
+
+```ts
+const headers = useClientHeaders()
+
+const { data: token } = await useAsyncQuery(['auth.login', { username, password }])
+
+headers.value.Authorization = `Bearer ${token}`
+
+// All client calls will now include the Authorization header.
+```
+
 ## Options
 
-trpc-nuxt accepts the following options exposed under `~/server/trpc.index.ts`:
+trpc-nuxt accepts the following options exposed under `~/server/trpc/index.ts`:
 
 ```ts
 import * as trpc from '@trpc/server'
@@ -143,9 +157,14 @@ export const onError = (payload: OnErrorPayload<typeof router>) => {
 - [Merging Routers](/recipes/merging-routers.md)
 - [Error Handling](/recipes/error-handling.md)
 - [Error Formatting](/recipes/error-formatting.md)
+- [Inference Helpers](/recipes/inference-helpers.md)
 
 Learn more about tRPC.io [here](https://trpc.io/docs).
 
+## Recommended IDE Setup
+
+- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+
 ## License
 
 MIT

package.json

@@ -1,7 +1,7 @@
 {
   "name": "trpc-nuxt",
   "type": "module",
-  "version": "0.1.2",
+  "version": "0.2.4",
   "packageManager": "pnpm@7.1.1",
   "license": "MIT",
   "main": "./dist/module.cjs",
@@ -32,30 +32,34 @@
     "prepare": "nuxi prepare playground"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.0.0-rc.3",
-    "@trpc/client": "^9.23.3",
-    "@trpc/server": "^9.23.2",
+    "@nuxt/kit": "3.0.0-rc.5",
+    "@trpc/client": "^9.26.0",
+    "@trpc/server": "^9.26.0",
+    "@vueuse/core": "^8.9.3",
+    "@vueuse/nuxt": "^8.9.3",
+    "dedent": "^0.7.0",
     "defu": "^6.0.0",
-    "fs-extra": "^10.1.0",
-    "h3": "^0.7.8",
+    "h3": "^0.7.10",
     "pathe": "^0.3.0",
-    "ufo": "^0.8.4"
+    "ufo": "^0.8.5"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^0.23.1",
     "@antfu/ni": "^0.16.2",
     "@nuxt/module-builder": "latest",
-    "@types/fs-extra": "^9.0.13",
-    "bumpp": "^7.1.1",
+    "@types/dedent": "^0.7.0",
+    "bumpp": "^7.2.0",
     "eslint": "^8.14.0",
-    "nuxt": "^3.0.0-rc.3",
+    "nuxt": "3.0.0-rc.4",
     "ohash": "^0.1.0",
     "pnpm": "^7.1.1",
-    "superjson": "^1.9.1",
     "trpc-nuxt": "workspace:*",
     "zod": "^3.16.0"
   },
   "eslintConfig": {
-    "extends": "@antfu"
+    "extends": "@antfu",
+    "rules": {
+      "no-console": "warn"
+    }
   }
 }

playground/pages/cookie.vue

@@ -0,0 +1,19 @@
+<script setup lang="ts">
+const counter = useCookie('counter')
+counter.value = counter.value || Math.round(Math.random() * 1000)
+</script>
+
+<template>
+  <div>
+    <h1> Counter: {{ counter || '-' }}</h1>
+    <button @click="counter = null">
+      reset
+    </button>
+    <button @click="counter--">
+      -
+    </button>
+    <button @click="counter++">
+      +
+    </button>
+  </div>
+</template>

playground/pages/index.vue

@@ -1,7 +1,13 @@
 <script setup lang="ts">
 const client = useClient()
+const headers = useClientHeaders()
 const { data: todos, pending, error, refresh } = await useAsyncQuery(['getTodos'])
 
+const addHeader = () => {
+  // headers.value.cookie = 'counter=69'
+  console.log(headers.value)
+}
+
 const addTodo = async () => {
   const title = Math.random().toString(36).slice(2, 7)
 
@@ -27,7 +33,7 @@ const addTodo = async () => {
   <div v-else-if="error?.data?.code">
     Error: {{ error.data.code }}
   </div>
-  <div v-else>
+  <div v-else-if="todos">
     <ul>
       <li v-for="t in todos.slice(0, 10)" :key="t.id">
         <NuxtLink :class="{ completed: t.completed }" :to="`/todo/${t.id}`">
@@ -41,6 +47,9 @@ const addTodo = async () => {
     <button @click="() => refresh()">
       Refresh
     </button>
+    <button @click="addHeader">
+      Add header
+    </button>
   </div>
 </template>
 

playground/server/trpc/index.ts

@@ -1,5 +1,7 @@
 import * as trpc from '@trpc/server'
+import type { inferAsyncReturnType } from '@trpc/server'
 import { z } from 'zod'
+import type { CompatibilityEvent } from 'h3'
 
 const baseURL = 'https://jsonplaceholder.typicode.com'
 
@@ -12,7 +14,7 @@ const TodoShape = z.object({
 
 export type Todo = z.infer<typeof TodoShape>
 
-export const router = trpc.router()
+export const router = trpc.router<Context>()
   .query('getTodos', {
     async resolve() {
       return await $fetch<Todo[]>(`${baseURL}/todos`)
@@ -27,9 +29,25 @@ export const router = trpc.router()
   .mutation('addTodo', {
     input: TodoShape,
     async resolve(req) {
+      console.log(req.input)
       return await $fetch<Todo>(`${baseURL}/todos`, {
         method: 'POST',
         body: req.input,
       })
     },
   })
+
+export async function createContext(event: CompatibilityEvent) {
+  // Create your context based on the request object
+  // Will be available as `ctx` in all your resolvers
+
+  // This is just an example of something you'd might want to do in your ctx fn
+  // const x = useCookies(event)
+  console.log(event.req.headers)
+
+  return {
+
+  }
+}
+
+  type Context = inferAsyncReturnType<typeof createContext>

pnpm-workspace.yaml

@@ -1,2 +1,2 @@
 packages:
-  - playground/*
+  - playground

recipes/inference-helpers.md

@@ -0,0 +1,80 @@
+## Inference Helpers
+
+`@trpc/server` exports the following helper types to assist with inferring these types from the `router` exported in `~/server/trpc/index.ts`:
+
+- `inferProcedureOutput<TProcedure>`
+- `inferProcedureInput<TProcedure>`
+- `inferSubscriptionOutput<TRouter, TPath>`
+
+```ts
+// ~/utils/trpc.ts
+import type { router } from '~/server/trpc/index.ts'
+
+type AppRouter = typeof router
+
+/**
+ * Enum containing all api query paths
+ */
+export type TQuery = keyof AppRouter['_def']['queries']
+
+/**
+ * Enum containing all api mutation paths
+ */
+export type TMutation = keyof AppRouter['_def']['mutations']
+
+/**
+ * Enum containing all api subscription paths
+ */
+export type TSubscription = keyof AppRouter['_def']['subscriptions']
+
+/**
+ * This is a helper method to infer the output of a query resolver
+ * @example type HelloOutput = InferQueryOutput<'hello'>
+ */
+export type InferQueryOutput<TRouteKey extends TQuery> = inferProcedureOutput<
+  AppRouter['_def']['queries'][TRouteKey]
+>
+
+/**
+ * This is a helper method to infer the input of a query resolver
+ * @example type HelloInput = InferQueryInput<'hello'>
+ */
+export type InferQueryInput<TRouteKey extends TQuery> = inferProcedureInput<
+  AppRouter['_def']['queries'][TRouteKey]
+>
+
+/**
+ * This is a helper method to infer the output of a mutation resolver
+ * @example type HelloOutput = InferMutationOutput<'hello'>
+ */
+export type InferMutationOutput<TRouteKey extends TMutation> =
+  inferProcedureOutput<AppRouter['_def']['mutations'][TRouteKey]>
+
+/**
+ * This is a helper method to infer the input of a mutation resolver
+ * @example type HelloInput = InferMutationInput<'hello'>
+ */
+export type InferMutationInput<TRouteKey extends TMutation> =
+  inferProcedureInput<AppRouter['_def']['mutations'][TRouteKey]>
+
+/**
+ * This is a helper method to infer the output of a subscription resolver
+ * @example type HelloOutput = InferSubscriptionOutput<'hello'>
+ */
+export type InferSubscriptionOutput<TRouteKey extends TSubscription> =
+  inferProcedureOutput<AppRouter['_def']['subscriptions'][TRouteKey]>
+
+/**
+ * This is a helper method to infer the asynchronous output of a subscription resolver
+ * @example type HelloAsyncOutput = InferAsyncSubscriptionOutput<'hello'>
+ */
+export type InferAsyncSubscriptionOutput<TRouteKey extends TSubscription> =
+  inferSubscriptionOutput<AppRouter, TRouteKey>
+
+/**
+ * This is a helper method to infer the input of a subscription resolver
+ * @example type HelloInput = InferSubscriptionInput<'hello'>
+ */
+export type InferSubscriptionInput<TRouteKey extends TSubscription> =
+  inferProcedureInput<AppRouter['_def']['subscriptions'][TRouteKey]>
+```

src/module.ts

@@ -1,12 +1,13 @@
 import { fileURLToPath } from 'url'
-import { join } from 'pathe'
+import { join, resolve } from 'pathe'
 import { defu } from 'defu'
+import dedent from 'dedent'
 
-import { addServerHandler, addTemplate, defineNuxtModule } from '@nuxt/kit'
+import { addAutoImport, addPlugin, addServerHandler, addTemplate, defineNuxtModule } from '@nuxt/kit'
 
 export interface ModuleOptions {
   baseURL: string
-  trpcURL: string
+  endpoint: string
 }
 
 export default defineNuxtModule<ModuleOptions>({
@@ -16,64 +17,49 @@ export default defineNuxtModule<ModuleOptions>({
   },
   defaults: {
     baseURL: 'http://localhost:3000',
-    trpcURL: '/api/trpc',
+    endpoint: '/trpc',
   },
   async setup(options, nuxt) {
     const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
-    nuxt.options.build.transpile.push(runtimeDir, '#build/trpc-client', '#build/trpc-handler')
+    nuxt.options.build.transpile.push(runtimeDir, '#build/trpc-handler')
 
     const handlerPath = join(nuxt.options.buildDir, 'trpc-handler.ts')
-    nuxt.options.build.transpile.push(handlerPath)
+    const trpcOptionsPath = join(nuxt.options.srcDir, 'server/trpc')
+
+    // Add vueuse
+    nuxt.options.modules.push('@vueuse/nuxt')
 
     // Final resolved configuration
     const finalConfig = nuxt.options.runtimeConfig.public.trpc = defu(nuxt.options.runtimeConfig.public.trpc, {
       baseURL: options.baseURL,
-      trpcURL: options.trpcURL,
+      endpoint: options.endpoint,
     })
 
-    nuxt.hook('autoImports:extend', (imports) => {
-      imports.push(
-        { name: 'useClient', from: '#build/trpc-client' },
-        { name: 'useAsyncQuery', from: join(runtimeDir, 'client') },
-      )
-    })
+    addAutoImport([
+      { name: 'useClient', from: join(runtimeDir, 'client') },
+      { name: 'useAsyncQuery', from: join(runtimeDir, 'client') },
+      { name: 'useClientHeaders', from: join(runtimeDir, 'client') },
+      { name: 'getQueryKey', from: join(runtimeDir, 'client') },
+    ])
 
     addServerHandler({
-      route: `${finalConfig.trpcURL}/*`,
+      route: `${finalConfig.endpoint}/*`,
       handler: handlerPath,
     })
 
-    addTemplate({
-      filename: 'trpc-client.ts',
-      write: true,
-      getContents() {
-        return `
-          import * as trpc from '@trpc/client'
-          import type { router } from '~/server/trpc'
-    
-          const client = trpc.createTRPCClient<typeof router>({
-            url: '${finalConfig.baseURL}${finalConfig.trpcURL}',
-          })
-        
-          export const useClient = () => client
-        `
-      },
-    })
+    addPlugin(resolve(runtimeDir, 'plugin'))
 
     addTemplate({
       filename: 'trpc-handler.ts',
       write: true,
       getContents() {
-        return `
+        return dedent`
           import { createTRPCHandler } from 'trpc-nuxt/api'
-          import { useRuntimeConfig } from '#imports'
-          import * as functions from '~/server/trpc'
-    
-          const { trpc: { trpcURL } } = useRuntimeConfig().public
+          import * as functions from '${trpcOptionsPath}'
     
           export default createTRPCHandler({
             ...functions,
-            trpcURL 
+            endpoint: '${finalConfig.endpoint}'
           })
         `
       },

src/runtime/api.ts

@@ -42,13 +42,13 @@ export function createTRPCHandler<Router extends AnyRouter>({
   createContext,
   responseMeta,
   onError,
-  trpcURL,
+  endpoint,
 }: {
   router: Router
   createContext?: CreateContextFn<Router>
   responseMeta?: ResponseMetaFn<Router>
   onError?: OnErrorFn<Router>
-  trpcURL: string
+  endpoint: string
 }) {
   return defineEventHandler(async (event) => {
     const {
@@ -56,17 +56,17 @@ export function createTRPCHandler<Router extends AnyRouter>({
       res,
     } = event
 
-    const $url = createURL(req.url)
+    const $url = createURL(req.url!)
 
     const httpResponse = await resolveHTTPResponse({
       router,
       req: {
-        method: req.method,
+        method: req.method!,
         headers: req.headers,
         body: isMethod(event, 'GET') ? null : await useBody(event),
         query: $url.searchParams,
       },
-      path: $url.pathname.substring(trpcURL.length + 1),
+      path: $url.pathname.substring(endpoint.length + 1),
       createContext: async () => createContext?.(event),
       responseMeta,
       onError: (o) => {
@@ -81,8 +81,8 @@ export function createTRPCHandler<Router extends AnyRouter>({
 
     res.statusCode = status
 
-    Object.keys(headers).forEach((key) => {
-      res.setHeader(key, headers[key])
+    headers && Object.keys(headers).forEach((key) => {
+      res.setHeader(key, headers[key]!)
     })
 
     return body

src/runtime/client.ts

@@ -6,15 +6,18 @@ import type {
   _Transform,
 } from 'nuxt/dist/app/composables/asyncData'
 import type { ProcedureRecord, inferHandlerInput, inferProcedureInput, inferProcedureOutput } from '@trpc/server'
-import type { TRPCClientErrorLike } from '@trpc/client'
+import type { TRPCClient, TRPCClientErrorLike } from '@trpc/client'
 import { objectHash } from 'ohash'
-import { useAsyncData, useState } from '#app'
-import { useClient } from '#build/trpc-client'
+import type { Ref } from 'vue'
+import { useStorage } from '@vueuse/core'
+import { useAsyncData, useNuxtApp, useState } from '#app'
 import type { router } from '~/server/trpc'
 
+type MaybeRef<T> = T | Ref<T>
+
 type AppRouter = typeof router
 
-type inferProcedures<
+export type inferProcedures<
   TObj extends ProcedureRecord<any, any, any, any, any, any>,
 > = {
   [TPath in keyof TObj]: {
@@ -23,10 +26,20 @@ type inferProcedures<
   };
 }
 
-type TQueries = AppRouter['_def']['queries']
-type TError = TRPCClientErrorLike<AppRouter>
+export type TQueries = AppRouter['_def']['queries']
+export type TError = TRPCClientErrorLike<AppRouter>
 
-type TQueryValues = inferProcedures<AppRouter['_def']['queries']>
+export type TQueryValues = inferProcedures<AppRouter['_def']['queries']>
+
+/**
+ * Calculates the key used for `useAsyncData` call
+ * @param pathAndInput
+ */
+export function getQueryKey<
+    TPath extends keyof TQueryValues & string,
+    >(pathAndInput: [path: TPath, ...args: inferHandlerInput<TQueries[TPath]>]) {
+  return `${pathAndInput[0]}-${objectHash(pathAndInput[1] ? JSON.stringify(pathAndInput[1]) : '')}`
+}
 
 export async function useAsyncQuery<
   TPath extends keyof TQueryValues & string,
@@ -37,12 +50,13 @@ export async function useAsyncQuery<
   pathAndInput: [path: TPath, ...args: inferHandlerInput<TQueries[TPath]>],
   options: AsyncDataOptions<TOutput, Transform, PickKeys> = {},
 ): Promise<AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TError>> {
-  const client = useClient()
-  const key = `${pathAndInput[0]}-${objectHash(pathAndInput[1] ? JSON.stringify(pathAndInput[1]) : '')}`
+  const { $client } = useNuxtApp()
+  const key = getQueryKey(pathAndInput)
   const serverError = useState<TError | null>(`error-${key}`, () => null)
   const { error, data, ...rest } = await useAsyncData(
     key,
-    () => client.query(...pathAndInput),
+    () => $client.query(...pathAndInput),
+    // @ts-expect-error: Internal
     options,
   )
 
@@ -58,3 +72,12 @@ export async function useAsyncQuery<
     error: serverError,
   } as any
 }
+
+export function useClient(): TRPCClient<AppRouter> {
+  const { $client } = useNuxtApp()
+  return $client
+}
+
+export function useClientHeaders(initialValue: MaybeRef<Record<string, any>> = {}): Ref<Record<string, any>> {
+  return useStorage('trpc-nuxt-header', initialValue)
+}

src/runtime/plugin.ts

@@ -0,0 +1,33 @@
+import * as trpc from '@trpc/client'
+import { unref } from 'vue'
+import { useClientHeaders } from './client'
+import { defineNuxtPlugin, useRequestHeaders, useRuntimeConfig } from '#app'
+import type { router } from '~/server/trpc'
+
+declare type AppRouter = typeof router
+
+export default defineNuxtPlugin((nuxtApp) => {
+  const config = useRuntimeConfig().public.trpc
+  const headers = useRequestHeaders()
+  const otherHeaders = useClientHeaders()
+  const client = trpc.createTRPCClient<AppRouter>({
+    url: `${config.baseURL}${config.endpoint}`,
+    headers: () => {
+      if (nuxtApp.ssrContext) {
+        return {
+          ...unref(otherHeaders),
+          ...headers,
+        }
+      }
+      return {}
+    },
+  })
+
+  nuxtApp.provide('client', client)
+})
+
+declare module '#app' {
+  interface NuxtApp {
+    $client: trpc.TRPCClient<AppRouter>
+  }
+}