chore: release v0.3.4

fix: don't discard error in client

.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}}

.gitignore

@@ -49,3 +49,5 @@ coverage
 Network Trash Folder
 Temporary Items
 .apdisk
+
+.vercel

.nuxtrc

@@ -0,0 +1,2 @@
+imports.autoImport=false
+typescript.includeWorkspace=true

README.md

@@ -18,7 +18,7 @@ End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
 ## Install
 
 ```bash
-npm i trpc-nuxt
+npm i trpc-nuxt@0.3
 ```
 
 ```ts
@@ -28,11 +28,12 @@ import { defineNuxtConfig } from 'nuxt'
 export default defineNuxtConfig({
   modules: ['trpc-nuxt'],
   trpc: {
-    baseURL: 'http://localhost:3000', // defaults to http://localhost:3000
-    trpcURL: '/api/trpc', // defaults to /api/trpc
+    baseURL: '', // Set empty string (default) to make requests by relative address
+    endpoint: '/trpc', // defaults to /trpc
+    installPlugin: true, // defaults to true. Add @trpc/client plugin and composables
   },
   typescript: {
-    strict: true // set this to true to make input/output types work
+    strict: true // required to make input/output types work
   }
 })
 ```
@@ -99,6 +100,22 @@ const {
 })
 ```
 
+## useClientHeaders
+
+A composable that lets you add additional properties to pass to the tRPC Client. It uses `useState` from [nuxt 3](https://v3.nuxtjs.org/api/composables/use-state).
+
+```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.
+```
+
+If your app needs transformers and other option that needs to be passed in `@trpc/client`, you will need to opt-out of the plugin by setting `installPlugin` to false in your `nuxt.config.ts` file and create your own. You can just copy the contents of the client plugin [here](https://github.com/wobsoriano/trpc-nuxt/blob/master/src/runtime/client.ts).
+
 ## Options
 
 trpc-nuxt accepts the following options exposed under `~/server/trpc/index.ts`:
@@ -106,14 +123,14 @@ trpc-nuxt accepts the following options exposed under `~/server/trpc/index.ts`:
 ```ts
 import * as trpc from '@trpc/server'
 import type { inferAsyncReturnType } from '@trpc/server'
-import type { CompatibilityEvent } from 'h3'
+import type { H3Event } from 'h3'
 import type { OnErrorPayload } from 'trpc-nuxt/api'
 
 export const router = trpc.router<inferAsyncReturnType<typeof createContext>>()
 
 // Optional
 // https://trpc.io/docs/context
-export const createContext = (event: CompatibilityEvent) => {
+export const createContext = (event: H3Event) => {
   // ...
   return {
     /** context data */
@@ -145,7 +162,7 @@ export const onError = (payload: OnErrorPayload<typeof router>) => {
 - [Error Formatting](/recipes/error-formatting.md)
 - [Inference Helpers](/recipes/inference-helpers.md)
 
-Learn more about tRPC.io [here](https://trpc.io/docs).
+Learn more about tRPC.io [here](https://trpc.io/docs/v9).
 
 ## Recommended IDE Setup
 

package.json

@@ -1,20 +1,19 @@
 {
   "name": "trpc-nuxt",
   "type": "module",
-  "version": "0.1.15",
-  "packageManager": "pnpm@7.1.1",
+  "version": "0.3.4",
   "license": "MIT",
   "main": "./dist/module.cjs",
   "types": "./dist/types.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": "./dist/module.mjs",
-      "require": "./dist/module.cjs"
+      "require": "./dist/module.cjs",
+      "import": "./dist/module.mjs"
     },
     "./api": {
-      "import": "./dist/runtime/api.mjs",
-      "types": "./dist/runtime/api.d.ts"
+      "types": "./dist/runtime/api.d.ts",
+      "import": "./dist/runtime/api.mjs"
     }
   },
   "files": [
@@ -22,38 +21,44 @@
     "*.d.ts"
   ],
   "scripts": {
-    "prepublishOnly": "nr build",
     "build": "nuxt-module-build",
-    "play": "nr build && nuxi dev playground",
-    "build:playground": "nuxi build playground",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:preview": "nuxi preview playground",
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "release": "bumpp --commit --push --tag && pnpm publish",
+    "release": "bumpp --commit --push --tag && npm publish",
     "prepare": "nuxi prepare playground"
   },
+  "peerDependencies": {
+    "@trpc/client": "<10.0.0",
+    "@trpc/server": "<10.0.0"
+  },
   "dependencies": {
-    "@nuxt/kit": "^3.0.0-rc.3",
-    "@trpc/client": "^9.23.3",
-    "@trpc/server": "^9.23.2",
-    "defu": "^6.0.0",
-    "h3": "^0.7.8",
-    "pathe": "^0.3.0",
-    "ufo": "^0.8.4"
+    "@nuxt/kit": "3.0.0",
+    "@trpc/client": "^9.27.4",
+    "@trpc/server": "^9.27.4",
+    "dedent": "^0.7.0",
+    "defu": "^6.1.1",
+    "h3": "^1.0.2",
+    "ohash": "^1.0.0",
+    "pathe": "^1.0.0",
+    "ufo": "^1.0.1"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.23.1",
-    "@antfu/ni": "^0.16.2",
-    "@nuxt/module-builder": "latest",
-    "bumpp": "^7.1.1",
-    "eslint": "^8.14.0",
-    "nuxt": "^3.0.0-rc.3",
-    "ohash": "^0.1.0",
-    "pnpm": "^7.1.1",
-    "superjson": "^1.9.1",
-    "trpc-nuxt": "workspace:*",
-    "zod": "^3.16.0"
+    "@antfu/eslint-config": "^0.34.0",
+    "@nuxt/module-builder": "^0.2.1",
+    "@types/dedent": "^0.7.0",
+    "bumpp": "^8.2.1",
+    "eslint": "^8.25.0",
+    "nuxt": "3.0.0",
+    "zod": "^3.20.2"
   },
   "eslintConfig": {
-    "extends": "@antfu"
+    "extends": "@antfu",
+    "rules": {
+      "no-console": "warn"
+    }
   }
 }

playground/nuxt.config.ts

@@ -1,13 +1,9 @@
-import { defineNuxtConfig } from 'nuxt'
 import Module from '../src/module'
 
 // https://v3.nuxtjs.org/api/configuration/nuxt.config
 export default defineNuxtConfig({
   modules: [Module],
   runtimeConfig: {
-    baseURL: 'http://localhost:3000',
-  },
-  typescript: {
-    strict: true,
+    baseURL: '',
   },
 })

playground/pages/cookie.vue

@@ -1,19 +0,0 @@
-<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,12 +1,19 @@
 <script setup lang="ts">
-const { $client } = useNuxtApp()
+import { useClient, useClientHeaders, useAsyncQuery } from '#imports'
+const client = useClient()
+const headers = useClientHeaders()
 const { data: todos, pending, error, refresh } = await useAsyncQuery(['getTodos'])
 
+const addHeader = () => {
+  headers.value.authorization = 'Bearer abcdefghijklmnop'
+  console.log(headers.value)
+}
+
 const addTodo = async () => {
   const title = Math.random().toString(36).slice(2, 7)
 
   try {
-    const result = await $client.mutation('addTodo', {
+    const result = await client.mutation('addTodo', {
       id: Date.now(),
       userId: 69,
       title,
@@ -27,7 +34,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 +48,9 @@ const addTodo = async () => {
     <button @click="() => refresh()">
       Refresh
     </button>
+    <button @click="addHeader">
+      Add header
+    </button>
   </div>
 </template>
 

playground/pages/todo/[id].vue

@@ -1,4 +1,5 @@
 <script setup lang="ts">
+import { useRoute, useAsyncQuery } from '#imports'
 const route = useRoute()
 const { data: todo, pending, error } = await useAsyncQuery(['getTodo', Number(route.params.id)])
 </script>
@@ -11,8 +12,8 @@ const { data: todo, pending, error } = await useAsyncQuery(['getTodo', Number(ro
     {{ error.data.code }}
   </div>
   <div v-else>
-    ID: {{ todo.id }} <br>
-    Title: {{ todo.title }} <br>
-    Completed: {{ todo.completed }}
+    ID: {{ todo?.id }} <br>
+    Title: {{ todo?.title }} <br>
+    Completed: {{ todo?.completed }}
   </div>
 </template>

playground/server/trpc/index.ts

@@ -1,8 +1,7 @@
 import * as trpc from '@trpc/server'
 import type { inferAsyncReturnType } from '@trpc/server'
 import { z } from 'zod'
-import type { CompatibilityEvent } from 'h3'
-import { useCookies } from 'h3'
+import type { H3Event } from 'h3'
 
 const baseURL = 'https://jsonplaceholder.typicode.com'
 
@@ -30,6 +29,7 @@ export const router = trpc.router<Context>()
   .mutation('addTodo', {
     input: TodoShape,
     async resolve(req) {
+      console.log(req.input)
       return await $fetch<Todo>(`${baseURL}/todos`, {
         method: 'POST',
         body: req.input,
@@ -37,13 +37,13 @@ export const router = trpc.router<Context>()
     },
   })
 
-export async function createContext(event: CompatibilityEvent) {
+export async function createContext(event: H3Event) {
   // 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(x)
+  // const x = useCookies(event)
+  console.log(event.req.headers)
 
   return {
 

pnpm-workspace.yaml

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

recipes/authorization.md

@@ -7,11 +7,11 @@ The `createContext`-function is called for each incoming request so here you can
 ```ts
 // ~/server/trpc/index.ts
 import type { inferAsyncReturnType } from '@trpc/server'
-import type { CompatibilityEvent } from 'h3'
+import type { H3Event } from 'h3'
 import { decodeAndVerifyJwtToken } from '~/somewhere/in/your/app/utils'
 
 // The app's context - is generated for each incoming request
-export async function createContext({ req }: CompatibilityEvent) {
+export async function createContext({ req }: H3Event) {
   // Create your context based on the request object
   // Will be available as `ctx` in all your resolvers
 

src/module.ts

@@ -1,68 +1,80 @@
 import { fileURLToPath } from 'url'
 import { join, resolve } from 'pathe'
 import { defu } from 'defu'
+import dedent from 'dedent'
 
-import { addPlugin, addServerHandler, addTemplate, defineNuxtModule } from '@nuxt/kit'
+import { addImports, addPlugin, addServerHandler, addTemplate, defineNuxtModule, useLogger } from '@nuxt/kit'
 
 export interface ModuleOptions {
   baseURL: string
-  trpcURL: string
+  endpoint: string
+  installPlugin?: boolean
 }
 
+const metaName = 'trpc-nuxt'
+
 export default defineNuxtModule<ModuleOptions>({
   meta: {
-    name: 'trpc-nuxt',
+    name: metaName,
     configKey: 'trpc',
   },
   defaults: {
-    baseURL: 'http://localhost:3000',
-    trpcURL: '/api/trpc',
+    baseURL: '',
+    endpoint: '/trpc',
+    installPlugin: true,
   },
   async setup(options, nuxt) {
+    const logger = useLogger(metaName)
+
     const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
-    nuxt.options.build.transpile.push(runtimeDir, '#build/trpc-handler')
+    nuxt.options.build.transpile.push(runtimeDir)
 
     const handlerPath = join(nuxt.options.buildDir, 'trpc-handler.ts')
-    const trpcOptionsPath = join(nuxt.options.rootDir, 'server/trpc')
+    const trpcOptionsPath = join(nuxt.options.srcDir, 'server/trpc')
 
     // Final resolved configuration
     const finalConfig = nuxt.options.runtimeConfig.public.trpc = defu(nuxt.options.runtimeConfig.public.trpc, {
       baseURL: options.baseURL,
-      trpcURL: options.trpcURL,
-    })
-
-    nuxt.hook('autoImports:extend', (imports) => {
-      imports.push(
-        { name: 'useClient', from: join(runtimeDir, 'client') },
-        { name: 'useAsyncQuery', from: join(runtimeDir, 'client') },
-      )
+      endpoint: options.endpoint,
+      installPlugin: options.installPlugin,
     })
 
     addServerHandler({
-      route: `${finalConfig.trpcURL}/*`,
+      route: `${finalConfig.endpoint}/*`,
       handler: handlerPath,
     })
 
-    addPlugin(resolve(runtimeDir, 'plugin'))
-
     addTemplate({
       filename: 'trpc-handler.ts',
       write: true,
       getContents() {
-        return `
-          import { createTRPCHandler } from 'trpc-nuxt/api'
-          import { useRuntimeConfig } from '#imports'
+        return dedent`
+          import { createTRPCHandler } from ${JSON.stringify(join(runtimeDir, 'api'))}
           import * as functions from '${trpcOptionsPath}'
     
-          const { trpc: { trpcURL } } = useRuntimeConfig().public
-    
           export default createTRPCHandler({
             ...functions,
-            trpcURL 
+            endpoint: '${finalConfig.endpoint}'
           })
         `
       },
     })
+
+    if (finalConfig.installPlugin) {
+      addImports([
+        { name: 'useClient', from: join(runtimeDir, 'client') },
+        { name: 'useAsyncQuery', from: join(runtimeDir, 'client') },
+        { name: 'useClientHeaders', from: join(runtimeDir, 'client') },
+        { name: 'getQueryKey', from: join(runtimeDir, 'client') },
+      ])
+
+      addPlugin(resolve(runtimeDir, 'plugin'))
+
+      logger.success('Plugin successfully installed.')
+    }
+    else {
+      logger.info('Plugin not installed. Create your own @trpc/client client plugin and composables.')
+    }
   },
 })
 

src/runtime/api.ts

@@ -8,13 +8,13 @@ import type {
   inferRouterError,
 } from '@trpc/server'
 import { createURL } from 'ufo'
-import type { CompatibilityEvent } from 'h3'
-import { defineEventHandler, isMethod, useBody } from 'h3'
+import type { H3Event } from 'h3'
+import { defineEventHandler, isMethod, readBody } from 'h3'
 import type { TRPCResponse } from '@trpc/server/dist/declarations/src/rpc'
 
 type MaybePromise<T> = T | Promise<T>
 
-export type CreateContextFn<TRouter extends AnyRouter> = (event: CompatibilityEvent) => MaybePromise<inferRouterContext<TRouter>>
+export type CreateContextFn<TRouter extends AnyRouter> = (event: H3Event) => MaybePromise<inferRouterContext<TRouter>>
 
 export interface ResponseMetaFnPayload<TRouter extends AnyRouter> {
   data: TRPCResponse<unknown, inferRouterError<TRouter>>[]
@@ -30,7 +30,7 @@ export interface OnErrorPayload<TRouter extends AnyRouter> {
   error: TRPCError
   type: ProcedureType | 'unknown'
   path: string | undefined
-  req: CompatibilityEvent['req']
+  req: H3Event['node']['req']
   input: unknown
   ctx: undefined | inferRouterContext<TRouter>
 }
@@ -42,31 +42,31 @@ 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 {
       req,
       res,
-    } = event
+    } = event.node
 
-    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),
+        body: isMethod(event, 'GET') ? null : await readBody(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

@@ -8,10 +8,12 @@ import type {
 import type { ProcedureRecord, inferHandlerInput, inferProcedureInput, inferProcedureOutput } from '@trpc/server'
 import type { TRPCClient, TRPCClientErrorLike } from '@trpc/client'
 import { objectHash } from 'ohash'
+import type { Ref } from 'vue'
 import { useAsyncData, useNuxtApp, useState } from '#app'
-// @ts-expect-error: Resolved by Nuxt
 import type { router } from '~/server/trpc'
 
+type MaybeRef<T> = T | Ref<T>
+
 type AppRouter = typeof router
 
 export type inferProcedures<
@@ -28,6 +30,16 @@ export type TError = TRPCClientErrorLike<AppRouter>
 
 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,
   TOutput extends TQueryValues[TPath]['output'] = TQueryValues[TPath]['output'],
@@ -38,28 +50,22 @@ export async function useAsyncQuery<
   options: AsyncDataOptions<TOutput, Transform, PickKeys> = {},
 ): Promise<AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TError>> {
   const { $client } = useNuxtApp()
-  const key = `${pathAndInput[0]}-${objectHash(pathAndInput[1] ? JSON.stringify(pathAndInput[1]) : '')}`
-  const serverError = useState<TError | null>(`error-${key}`, () => null)
-  const { error, data, ...rest } = await useAsyncData(
+  const key = getQueryKey(pathAndInput)
+  const result = await useAsyncData(
     key,
     () => $client.query(...pathAndInput),
+    // @ts-expect-error: Internal
     options,
   )
 
-  if (process.server && error.value && !serverError.value)
-    serverError.value = error.value as any
-
-  if (data.value)
-    serverError.value = null
-
-  return {
-    ...rest,
-    data,
-    error: serverError,
-  } as any
+  return result 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 useState('trpc-nuxt-header', () => initialValue)
+}

src/runtime/plugin.ts

@@ -1,22 +1,41 @@
 import * as trpc from '@trpc/client'
-// @ts-expect-error: Resolved by Nuxt
+import { unref } from 'vue'
+import { FetchError } from 'ohmyfetch'
+import { useClientHeaders } from './client'
 import { defineNuxtPlugin, useRequestHeaders, useRuntimeConfig } from '#app'
 import type { router } from '~/server/trpc'
 
 declare type AppRouter = typeof router
 
-export default defineNuxtPlugin(() => {
+export default defineNuxtPlugin((nuxtApp) => {
   const config = useRuntimeConfig().public.trpc
+  const headers = useRequestHeaders()
+  const otherHeaders = useClientHeaders()
+
+  const baseURL = process.server ? '' : config.baseURL
   const client = trpc.createTRPCClient<AppRouter>({
-    url: `${config.baseURL}${config.trpcURL}`,
-    headers: useRequestHeaders(),
+    url: `${baseURL}${config.endpoint}`,
+    headers: () => {
+      return {
+        ...unref(otherHeaders),
+        ...headers,
+      }
+    },
+    fetch: (input, options) =>
+      globalThis.$fetch.raw(input.toString(), options)
+        .catch((e) => {
+          if (e instanceof FetchError && e.response)
+            return e.response
+
+          throw e
+        })
+        .then(response => ({
+          ...response,
+          json: () => Promise.resolve(response._data),
+        })),
   })
 
-  return {
-    provide: {
-      client,
-    },
-  }
+  nuxtApp.provide('client', client)
 })
 
 declare module '#app' {