mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-18 22:11:42 +01:00
Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0bb648bb08 | ||
|
|
ca2344ad86 | ||
|
|
004e655194 | ||
|
|
fca82a027e | ||
|
|
7995e892db | ||
|
|
8168a46985 | ||
|
|
2a23f4303d | ||
|
|
ff4bbebb0b | ||
|
|
354bf5d707 | ||
|
|
e7d160ee48 | ||
|
|
9bf6d57c2c | ||
|
|
6bca1e621d |
1
.github/FUNDING.yml
vendored
1
.github/FUNDING.yml
vendored
@@ -1 +0,0 @@
|
|||||||
github: wobsoriano
|
|
||||||
2
.nuxtrc
Normal file
2
.nuxtrc
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
imports.autoImport=false
|
||||||
|
typescript.includeWorkspace=true
|
||||||
165
CHANGELOG.md
165
CHANGELOG.md
@@ -1,165 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
|
|
||||||
## v0.10.12
|
|
||||||
|
|
||||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.11...v0.10.12)
|
|
||||||
|
|
||||||
### 🩹 Fixes
|
|
||||||
|
|
||||||
- Expect ofetch missing error response type ([8f9e398](https://github.com/wobsoriano/trpc-nuxt/commit/8f9e398))
|
|
||||||
|
|
||||||
### 💅 Refactors
|
|
||||||
|
|
||||||
- Explicitly copy headers to custom fetcher ([0fec55a](https://github.com/wobsoriano/trpc-nuxt/commit/0fec55a))
|
|
||||||
|
|
||||||
### 📖 Documentation
|
|
||||||
|
|
||||||
- Add response caching page ([9808375](https://github.com/wobsoriano/trpc-nuxt/commit/9808375))
|
|
||||||
- Fix missing title ([057c8f8](https://github.com/wobsoriano/trpc-nuxt/commit/057c8f8))
|
|
||||||
- Fix incorrect syntax ([230422b](https://github.com/wobsoriano/trpc-nuxt/commit/230422b))
|
|
||||||
|
|
||||||
### 📦 Build
|
|
||||||
|
|
||||||
- **deps:** Bump ofetch to 1.3.2 ([092e349](https://github.com/wobsoriano/trpc-nuxt/commit/092e349))
|
|
||||||
|
|
||||||
### ❤️ Contributors
|
|
||||||
|
|
||||||
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
|
||||||
|
|
||||||
## v0.10.11
|
|
||||||
|
|
||||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.10...v0.10.11)
|
|
||||||
|
|
||||||
### 🩹 Fixes
|
|
||||||
|
|
||||||
- Add missing useLazyQuery type ([299ae55](https://github.com/wobsoriano/trpc-nuxt/commit/299ae55))
|
|
||||||
|
|
||||||
### 📖 Documentation
|
|
||||||
|
|
||||||
- Bump @nuxt-themes/docus to 1.14.6 ([f7eeb10](https://github.com/wobsoriano/trpc-nuxt/commit/f7eeb10))
|
|
||||||
|
|
||||||
### ❤️ Contributors
|
|
||||||
|
|
||||||
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
|
||||||
|
|
||||||
## v0.10.10
|
|
||||||
|
|
||||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.9...v0.10.10)
|
|
||||||
|
|
||||||
### 🚀 Enhancements
|
|
||||||
|
|
||||||
- Add useLazyQuery composable ([93cb442](https://github.com/wobsoriano/trpc-nuxt/commit/93cb442))
|
|
||||||
|
|
||||||
### ❤️ Contributors
|
|
||||||
|
|
||||||
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
|
||||||
|
|
||||||
## v0.10.9
|
|
||||||
|
|
||||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.8...v0.10.9)
|
|
||||||
|
|
||||||
### 🚀 Enhancements
|
|
||||||
|
|
||||||
- Add custom query key option ([f2bcf9b](https://github.com/wobsoriano/trpc-nuxt/commit/f2bcf9b))
|
|
||||||
|
|
||||||
### ❤️ Contributors
|
|
||||||
|
|
||||||
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
|
||||||
|
|
||||||
## 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 - by @wobsoriano [<samp>(12d8c)</samp>](https://github.com/wobsoriano/trpc-nuxt/commit/12d8c97f71bedb025b2e7914db13e69e5f62c8a2)
|
|
||||||
- Bump ofetch to 1.1.1 - 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))
|
|
||||||
|
|
||||||
165
README.md
165
README.md
@@ -1,16 +1,12 @@
|
|||||||
<p align="center">
|
|
||||||
<figure>
|
|
||||||
<img src="https://trpc-nuxt.vercel.app/cover.jpg" alt="trpc-nuxt cover image" />
|
|
||||||
</figure>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
# tRPC-Nuxt
|
# tRPC-Nuxt
|
||||||
|
|
||||||
|
[](https://www.npmjs.com/package/trpc-nuxt)
|
||||||
|
|
||||||
End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<figure>
|
<figure>
|
||||||
<img src="https://i.imgur.com/3AZlBZH.gif" alt="Demo" />
|
<img src="https://i.imgur.com/AjmNUxj.gif" alt="Demo" />
|
||||||
<figcaption>
|
<figcaption>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
The client above is <strong>not</strong> importing any code from the server, only its type declarations.
|
The client above is <strong>not</strong> importing any code from the server, only its type declarations.
|
||||||
@@ -19,17 +15,158 @@ End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
|||||||
</figure>
|
</figure>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Docs: https://trpc-nuxt.vercel.app
|
## Install
|
||||||
|
|
||||||
For version 3 of this module (tRPC v9, auto-imports, auto handlers), [go here](https://github.com/wobsoriano/trpc-nuxt/tree/v3).
|
```bash
|
||||||
|
npm i trpc-nuxt@0.3
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// nuxt.config.ts
|
||||||
|
import { defineNuxtConfig } from 'nuxt'
|
||||||
|
|
||||||
|
export default defineNuxtConfig({
|
||||||
|
modules: ['trpc-nuxt'],
|
||||||
|
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 // required to make input/output types work
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Expose your tRPC [routes](https://trpc.io/docs/router) under `~/server/trpc/index.ts`:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/index.ts
|
||||||
|
import type { inferAsyncReturnType } from '@trpc/server'
|
||||||
|
import * as trpc from '@trpc/server'
|
||||||
|
import { z } from 'zod' // yup/superstruct/zod/myzod/custom
|
||||||
|
|
||||||
|
export const router = trpc.router()
|
||||||
|
// queries and mutations...
|
||||||
|
.query('getUsers', {
|
||||||
|
async resolve(req) {
|
||||||
|
// use your ORM of choice
|
||||||
|
return await UserModel.all()
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.mutation('createUser', {
|
||||||
|
// validate input with Zod
|
||||||
|
input: z.object({ name: z.string().min(5) }),
|
||||||
|
async resolve(req) {
|
||||||
|
// use your ORM of choice
|
||||||
|
return await UserModel.create({
|
||||||
|
data: req.input,
|
||||||
|
})
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Use the client like so:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const client = useClient() // auto-imported
|
||||||
|
|
||||||
|
const users = await client.query('getUsers')
|
||||||
|
|
||||||
|
const newUser = await client.mutation('createUser', {
|
||||||
|
name: 'wagmi'
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## useAsyncQuery
|
||||||
|
|
||||||
|
A thin wrapper around [`useAsyncData`](https://v3.nuxtjs.org/api/composables/use-async-data/) and `client.query()`.
|
||||||
|
|
||||||
|
The first argument is a `[path, input]`-tuple - if the `input` is optional, you can omit the, `input`-part.
|
||||||
|
|
||||||
|
You'll notice that you get autocompletion on the `path` and automatic typesafety on the `input`.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const {
|
||||||
|
data,
|
||||||
|
pending,
|
||||||
|
error,
|
||||||
|
refresh
|
||||||
|
} = await useAsyncQuery(['getUser', { id: 69 }], {
|
||||||
|
// pass useAsyncData options here
|
||||||
|
lazy: false
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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`:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import * as trpc from '@trpc/server'
|
||||||
|
import type { inferAsyncReturnType } from '@trpc/server'
|
||||||
|
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: H3Event) => {
|
||||||
|
// ...
|
||||||
|
return {
|
||||||
|
/** context data */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Optional
|
||||||
|
// https://trpc.io/docs/caching#using-responsemeta--to-cache-responses
|
||||||
|
export const responseMeta = () => {
|
||||||
|
// ...
|
||||||
|
return {
|
||||||
|
// { headers: ... }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Optional
|
||||||
|
// https://trpc.io/docs/error-handling#handling-errors
|
||||||
|
export const onError = (payload: OnErrorPayload<typeof router>) => {
|
||||||
|
// Do whatever here like send to bug reporting and stuff
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Recipes
|
||||||
|
|
||||||
|
- [Validation](/recipes/validation.md)
|
||||||
|
- [Authorization](/recipes/authorization.md)
|
||||||
|
- [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/v9).
|
||||||
|
|
||||||
## Recommended IDE Setup
|
## 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
|
## License
|
||||||
|
|
||||||
|
|||||||
1
client.d.ts
vendored
1
client.d.ts
vendored
@@ -1 +0,0 @@
|
|||||||
export * from './dist/client/index'
|
|
||||||
1
docs/.gitignore
vendored
1
docs/.gitignore
vendored
@@ -1 +0,0 @@
|
|||||||
.vercel
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
docs
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
export default defineAppConfig({
|
|
||||||
docus: {
|
|
||||||
title: "tRPC Nuxt",
|
|
||||||
description: "End-to-end typesafe APIs in Nuxt applications.",
|
|
||||||
image: "https://og-image.vercel.app/tRPC-Nuxt",
|
|
||||||
alt: "tRPC-Nuxt cover",
|
|
||||||
url: "https://trpc-nuxt.vercel.app",
|
|
||||||
debug: false,
|
|
||||||
socials: {
|
|
||||||
github: "wobsoriano/trpc-nuxt"
|
|
||||||
},
|
|
||||||
cover: {
|
|
||||||
src: "/cover.jpg",
|
|
||||||
alt: "tRPC-Nuxt module"
|
|
||||||
},
|
|
||||||
header: {
|
|
||||||
logo: true
|
|
||||||
},
|
|
||||||
aside: {
|
|
||||||
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"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
---
|
|
||||||
title: Installation
|
|
||||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
::code-group
|
|
||||||
|
|
||||||
```bash [pnpm]
|
|
||||||
pnpm add @trpc/server @trpc/client trpc-nuxt zod
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash [npm]
|
|
||||||
npm install @trpc/server @trpc/client trpc-nuxt zod
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash [yarn]
|
|
||||||
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.
|
|
||||||
|
|
||||||
#### Why @trpc/client?
|
|
||||||
|
|
||||||
For making typesafe API calls from your client.
|
|
||||||
|
|
||||||
#### Why zod?
|
|
||||||
|
|
||||||
Most examples use [Zod](https://github.com/colinhacks/zod) for input validation and tRPC.io highly recommends it, though it isn't required.
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
Now that you've installed the required dependencies, you are ready to start building your application.
|
|
||||||
@@ -1,118 +0,0 @@
|
|||||||
---
|
|
||||||
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>
|
|
||||||
```
|
|
||||||
@@ -1,153 +0,0 @@
|
|||||||
---
|
|
||||||
title: Recommended
|
|
||||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Recommended Usage
|
|
||||||
|
|
||||||
Recommended but not enforced file structure.
|
|
||||||
|
|
||||||
```graphql
|
|
||||||
.
|
|
||||||
├── server
|
|
||||||
│ ├── api
|
|
||||||
│ │ └── trpc
|
|
||||||
│ │ └── [trpc].ts # <-- tRPC HTTP handler
|
|
||||||
│ │ └── [..]
|
|
||||||
│ ├── trpc
|
|
||||||
│ │ ├── routers
|
|
||||||
│ │ │ ├── index.ts # <-- main app router
|
|
||||||
│ │ │ ├── todo.ts # <-- sub routers
|
|
||||||
│ │ │ └── [..]
|
|
||||||
│ │ ├── context.ts # <-- create app context
|
|
||||||
│ │ └── trpc.ts # <-- procedure helpers
|
|
||||||
├── plugins
|
|
||||||
│ ├── client.ts # <-- tRPC client plugin
|
|
||||||
└── [..]
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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'
|
|
||||||
import { Context } from '~/server/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;
|
|
||||||
```
|
|
||||||
|
|
||||||
```ts [server/trpc/routers/index.ts]
|
|
||||||
import { z } from 'zod'
|
|
||||||
import { publicProcedure, router } from '../trpc'
|
|
||||||
|
|
||||||
export const appRouter = router({
|
|
||||||
hello: publicProcedure
|
|
||||||
.input(
|
|
||||||
z.object({
|
|
||||||
text: z.string().nullish(),
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
.query(({ input }) => {
|
|
||||||
return {
|
|
||||||
greeting: `hello ${input?.text ?? 'world'}`,
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
})
|
|
||||||
|
|
||||||
// export type definition of API
|
|
||||||
export type AppRouter = typeof appRouter
|
|
||||||
```
|
|
||||||
|
|
||||||
```ts [server/api/trpc/[trpc].ts]
|
|
||||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
|
||||||
import { appRouter } from '~/server/trpc/routers'
|
|
||||||
import { createContext } from '~/server/trpc/context'
|
|
||||||
|
|
||||||
// export API handler
|
|
||||||
export default createNuxtApiHandler({
|
|
||||||
router: appRouter,
|
|
||||||
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}
|
|
||||||
If you need to split your router into several subrouters, you can implement them in the `server/trpc/routers` directory and import and [merge them](https://trpc.io/docs/v10/merging-routers) to a single root `appRouter`.
|
|
||||||
::
|
|
||||||
|
|
||||||
## 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/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,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## 3. Make an API request
|
|
||||||
|
|
||||||
```vue [pages/index.vue]
|
|
||||||
<script setup lang="ts">
|
|
||||||
const { $client } = useNuxtApp()
|
|
||||||
|
|
||||||
const hello = await $client.hello.useQuery({ text: 'client' })
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div>
|
|
||||||
<p>{{ hello.data?.greeting }}</p>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
---
|
|
||||||
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>
|
|
||||||
```
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
---
|
|
||||||
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>);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
---
|
|
||||||
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
|
|
||||||
}),
|
|
||||||
],
|
|
||||||
});
|
|
||||||
```
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
---
|
|
||||||
title: Composables
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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:
|
|
||||||
|
|
||||||
- `inferRouterInputs<TRouter>`
|
|
||||||
- `inferRouterOutputs<TRouter>`
|
|
||||||
|
|
||||||
Let's assume we have this example query wrapped within Nuxt's [useAsyncData](https://v3.nuxtjs.org/api/composables/use-async-data/):
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const { data, error } = await useAsyncData(() => $client.todo.getTodos.query())
|
|
||||||
```
|
|
||||||
|
|
||||||
We can wrap this in a composable and also set the client error types:
|
|
||||||
|
|
||||||
```ts [composables/useGetTodos.ts]
|
|
||||||
import { TRPCClientError } from '@trpc/client'
|
|
||||||
import type { inferRouterOutputs } from '@trpc/server'
|
|
||||||
import type { AppRouter } from '@/server/trpc/routers'
|
|
||||||
|
|
||||||
type RouterOutput = inferRouterOutputs<AppRouter>
|
|
||||||
type GetTodosOutput = RouterOutput['todo']['getTodos']
|
|
||||||
|
|
||||||
type ErrorOutput = TRPCClientError<AppRouter>
|
|
||||||
|
|
||||||
export default function useGetTodos() {
|
|
||||||
const { $client } = useNuxtApp()
|
|
||||||
return useAsyncData<GetTodosOutput, ErrorOutput>(() => $client.todo.getTodos.query())
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Now, we have a fully-typed composable.
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
---
|
|
||||||
title: Headers
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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()
|
|
||||||
|
|
||||||
const client = createTRPCProxyClient<AppRouter>({
|
|
||||||
links: [
|
|
||||||
httpBatchLink({
|
|
||||||
// headers need to be a function so it gets called dynamically
|
|
||||||
// every HTTP request
|
|
||||||
headers() {
|
|
||||||
// You can add more custom headers here
|
|
||||||
return headers
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
],
|
|
||||||
})
|
|
||||||
|
|
||||||
return {
|
|
||||||
provide: {
|
|
||||||
client,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
```ts [server/trpc/context.ts]
|
|
||||||
export function createContext (event: H3Event) {
|
|
||||||
console.log('cookies', parseCookies(event))
|
|
||||||
|
|
||||||
return {}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@@ -1,103 +0,0 @@
|
|||||||
---
|
|
||||||
title: Authorization
|
|
||||||
---
|
|
||||||
|
|
||||||
# Authorization
|
|
||||||
|
|
||||||
The `createContext` function is called for each incoming request so here you can add contextual information about the calling user from the request object.
|
|
||||||
|
|
||||||
::alert{type="warning"}
|
|
||||||
Before you can access request headers in any context or middleware, you need to set the outgoing request headers. See [here](/get-started/tips/headers).
|
|
||||||
::
|
|
||||||
|
|
||||||
## Create context from request headers
|
|
||||||
|
|
||||||
```ts [server/trpc/context.ts]
|
|
||||||
import { inferAsyncReturnType } from '@trpc/server'
|
|
||||||
import { decodeAndVerifyJwtToken } from './somewhere/in/your/app/utils'
|
|
||||||
|
|
||||||
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 might want to do in your ctx fn
|
|
||||||
const authorization = getRequestHeader(event, 'authorization')
|
|
||||||
async function getUserFromHeader() {
|
|
||||||
if (authorization) {
|
|
||||||
const user = await decodeAndVerifyJwtToken(authorization.split(' ')[1])
|
|
||||||
return user
|
|
||||||
}
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
const user = await getUserFromHeader()
|
|
||||||
|
|
||||||
return {
|
|
||||||
user,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
type Context = inferAsyncReturnType<typeof createContext>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Option 1: Authorize using resolver
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import { TRPCError, initTRPC } from '@trpc/server'
|
|
||||||
import type { Context } from '../context'
|
|
||||||
|
|
||||||
export const t = initTRPC.context<Context>().create()
|
|
||||||
|
|
||||||
const appRouter = t.router({
|
|
||||||
// open for anyone
|
|
||||||
hello: t.procedure
|
|
||||||
.input(z.string().nullish())
|
|
||||||
.query(({ input, ctx }) => `hello ${input ?? ctx.user?.name ?? 'world'}`),
|
|
||||||
// checked in resolver
|
|
||||||
secret: t.procedure.query(({ ctx }) => {
|
|
||||||
if (!ctx.user) {
|
|
||||||
throw new TRPCError({ code: 'UNAUTHORIZED' })
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
secret: 'sauce',
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## Option 2: Authorize using middleware
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import { TRPCError, initTRPC } from '@trpc/server'
|
|
||||||
|
|
||||||
export const t = initTRPC.context<Context>().create()
|
|
||||||
|
|
||||||
const isAuthed = t.middleware(({ next, ctx }) => {
|
|
||||||
if (!ctx.user?.isAdmin) {
|
|
||||||
throw new TRPCError({ code: 'UNAUTHORIZED' })
|
|
||||||
}
|
|
||||||
return next({
|
|
||||||
ctx: {
|
|
||||||
user: ctx.user,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
// you can reuse this for any procedure
|
|
||||||
export const protectedProcedure = t.procedure.use(isAuthed)
|
|
||||||
|
|
||||||
t.router({
|
|
||||||
// this is accessible for everyone
|
|
||||||
hello: t.procedure
|
|
||||||
.input(z.string().nullish())
|
|
||||||
.query(({ input, ctx }) => `hello ${input ?? ctx.user?.name ?? 'world'}`),
|
|
||||||
admin: t.router({
|
|
||||||
// this is accessible only to admins
|
|
||||||
secret: protectedProcedure.query(({ ctx }) => {
|
|
||||||
return {
|
|
||||||
secret: 'sauce',
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
This page is entirely based on [authorization docs](https://trpc.io/docs/v10/authorization) of tRPC with a minimal change made to work with Nuxt.
|
|
||||||
@@ -1,84 +0,0 @@
|
|||||||
---
|
|
||||||
title: Server Side Calls
|
|
||||||
---
|
|
||||||
|
|
||||||
# Server Side Calls
|
|
||||||
|
|
||||||
You may need to call your procedure(s) directly from the server, `createCaller()` function returns you an instance of `RouterCaller` able to execute queries and mutations.
|
|
||||||
|
|
||||||
## Input query example
|
|
||||||
|
|
||||||
We create the router with a input query and then we call the asynchronous `greeting` procedure to get the result.
|
|
||||||
|
|
||||||
::code-group
|
|
||||||
|
|
||||||
```ts [server/trpc/trpc.ts]
|
|
||||||
import { initTRPC } from '@trpc/server'
|
|
||||||
import { z } from 'zod'
|
|
||||||
|
|
||||||
const t = initTRPC.create()
|
|
||||||
|
|
||||||
export const router = t.router({
|
|
||||||
// Create procedure at path 'greeting'
|
|
||||||
greeting: t.procedure
|
|
||||||
.input(z.object({ name: z.string() }))
|
|
||||||
.query(({ input }) => `Hello ${input.name}`),
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
```ts [server/api/greeting.ts]
|
|
||||||
import { appRouter } from '@/server/trpc/routers'
|
|
||||||
|
|
||||||
export default defineEventHandler(async (event) => {
|
|
||||||
const { name } = getQuery(event)
|
|
||||||
const caller = appRouter.createCaller({})
|
|
||||||
|
|
||||||
const greeting = await caller.greeting({ name })
|
|
||||||
|
|
||||||
return {
|
|
||||||
greeting
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
## Mutation example
|
|
||||||
|
|
||||||
We create the router with a mutation and then we call the asynchronous `post` procedure to get the result.
|
|
||||||
|
|
||||||
::code-group
|
|
||||||
|
|
||||||
```ts [server/trpc/trpc.ts]
|
|
||||||
import { initTRPC } from '@trpc/server'
|
|
||||||
import { z } from 'zod'
|
|
||||||
|
|
||||||
const posts = ['One', 'Two', 'Three']
|
|
||||||
|
|
||||||
const t = initTRPC.create()
|
|
||||||
export const router = t.router({
|
|
||||||
post: t.router({
|
|
||||||
add: t.procedure.input(z.string()).mutation(({ input }) => {
|
|
||||||
posts.push(input)
|
|
||||||
return posts
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
```ts [server/api/post.ts]
|
|
||||||
import { appRouter } from '@/server/trpc/routers'
|
|
||||||
|
|
||||||
export default defineEventHandler(async (event) => {
|
|
||||||
const body = await getBody(event)
|
|
||||||
const caller = appRouter.createCaller({})
|
|
||||||
|
|
||||||
const post = await caller.post.add(body.post)
|
|
||||||
|
|
||||||
return {
|
|
||||||
post
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
::
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
---
|
|
||||||
title: Aborting Procedures
|
|
||||||
---
|
|
||||||
|
|
||||||
# Aborting Procedures
|
|
||||||
|
|
||||||
tRPC adheres to the industry standard when it comes to aborting procedures. All you have to do is pass an `AbortSignal` to the query-options and then call its parent `AbortController`'s `abort` method.
|
|
||||||
|
|
||||||
```ts [composables/useGetTodo.ts]
|
|
||||||
export default function useGetTodo(id: number) {
|
|
||||||
const { $client } = useNuxtApp()
|
|
||||||
const ac = new AbortController()
|
|
||||||
|
|
||||||
onScopeDispose(() => {
|
|
||||||
ac.abort()
|
|
||||||
})
|
|
||||||
|
|
||||||
return useAsyncData(() => {
|
|
||||||
return $client.todo.getTodo.query(id, {
|
|
||||||
signal: ac.signal
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
---
|
|
||||||
title: Response Caching
|
|
||||||
---
|
|
||||||
|
|
||||||
## Response Caching
|
|
||||||
|
|
||||||
Your server responses must [satisfy some criteria](https://vercel.com/docs/concepts/functions/serverless-functions/edge-caching) in order for them to be cached (i.e. by Vercel's Edge Network). Please refer to [this section of the tRPC.io documentation](https://trpc.io/docs/caching) for more information.
|
|
||||||
|
|
||||||
The `createNuxtApiHandler` function conveniently allows you to specify a `responseMeta` function.
|
|
||||||
|
|
||||||
```ts [server/api/trpc/[trpc].ts]
|
|
||||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
|
||||||
import { appRouter } from '~/server/trpc/routers'
|
|
||||||
|
|
||||||
export default createNuxtApiHandler({
|
|
||||||
router: appRouter,
|
|
||||||
/**
|
|
||||||
* @link https://trpc.io/docs/caching#api-response-caching
|
|
||||||
*/
|
|
||||||
responseMeta(opts) {
|
|
||||||
// cache request for 1 day + revalidate once every second
|
|
||||||
const ONE_DAY_IN_SECONDS = 60 * 60 * 24;
|
|
||||||
|
|
||||||
return {
|
|
||||||
headers: {
|
|
||||||
'cache-control': `s-maxage=1, stale-while-revalidate=${ONE_DAY_IN_SECONDS}`,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
},
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also take advantage of Nitro's [Cache API](https://nitro.unjs.io/guide/cache#cache-api) if doing server-side calls:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import { appRouter } from '@/server/trpc/routers'
|
|
||||||
|
|
||||||
const caller = appRouter.createCaller({})
|
|
||||||
|
|
||||||
export default cachedEventHandler(async (event) => {
|
|
||||||
const { name } = getQuery(event)
|
|
||||||
|
|
||||||
const greeting = await caller.greeting({ name })
|
|
||||||
|
|
||||||
return {
|
|
||||||
greeting
|
|
||||||
}
|
|
||||||
}, {
|
|
||||||
swr: true, maxAge: 10
|
|
||||||
})
|
|
||||||
```
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
---
|
|
||||||
navigation: false
|
|
||||||
redirect: /get-started/installation
|
|
||||||
---
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
title: Basic
|
|
||||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Basic Example
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
title: Multiple Routers
|
|
||||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Multi Routers
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
---
|
|
||||||
title: "tRPC Nuxt"
|
|
||||||
description: "End-to-end typesafe APIs in Nuxt applications."
|
|
||||||
navigation: false
|
|
||||||
layout: page
|
|
||||||
---
|
|
||||||
|
|
||||||
::block-hero
|
|
||||||
---
|
|
||||||
cta:
|
|
||||||
- Get Started
|
|
||||||
- /get-started/installation
|
|
||||||
secondary:
|
|
||||||
- Star on GitHub ->
|
|
||||||
- https://github.com/wobsoriano/trpc-nuxt
|
|
||||||
snippet: npm install trpc-nuxt
|
|
||||||
---
|
|
||||||
|
|
||||||
#title
|
|
||||||
tRPC [Nuxt]{.text-primary-500}
|
|
||||||
|
|
||||||
#description
|
|
||||||
End-to-end typesafe APIs in Nuxt applications.
|
|
||||||
|
|
||||||
#extra
|
|
||||||
::list
|
|
||||||
- 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)
|
|
||||||
::
|
|
||||||
::
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
export default defineNuxtConfig({
|
|
||||||
app: {
|
|
||||||
pageTransition: false,
|
|
||||||
layoutTransition: false
|
|
||||||
},
|
|
||||||
modules: ['@nuxtlabs/github-module'],
|
|
||||||
extends: process.env.DOCUS_THEME_PATH || '@nuxt-themes/docus',
|
|
||||||
github: {
|
|
||||||
owner: 'wobsoriano',
|
|
||||||
repo: 'trpc-nuxt',
|
|
||||||
branch: 'next'
|
|
||||||
},
|
|
||||||
colorMode: {
|
|
||||||
preference: 'dark'
|
|
||||||
},
|
|
||||||
build: {
|
|
||||||
transpile: [/content-edge/, /github-module/]
|
|
||||||
},
|
|
||||||
nitro: {
|
|
||||||
preset: 'vercel'
|
|
||||||
}
|
|
||||||
})
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "docs",
|
|
||||||
"description": "Docs for TRPC-Nuxt",
|
|
||||||
"scripts": {
|
|
||||||
"dev": "nuxi dev",
|
|
||||||
"build": "nuxi build",
|
|
||||||
"generate": "nuxi build",
|
|
||||||
"preview": "nuxi preview"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@nuxt-themes/docus": "^1.14.6",
|
|
||||||
"@nuxtlabs/github-module": "^1.6.3",
|
|
||||||
"nuxt": "3.6.5"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB |
@@ -1,18 +0,0 @@
|
|||||||
import { defineTheme } from 'pinceau'
|
|
||||||
|
|
||||||
export default defineTheme({
|
|
||||||
colors: {
|
|
||||||
primary: {
|
|
||||||
50: '#BFEDFC',
|
|
||||||
100: '#B0E9FB',
|
|
||||||
200: '#93DEFA',
|
|
||||||
300: '#76D4F9',
|
|
||||||
400: '#58C8F7',
|
|
||||||
500: '#3BBBF6',
|
|
||||||
600: '#0BA6F3',
|
|
||||||
700: '#0981C2',
|
|
||||||
800: '#075E91',
|
|
||||||
900: '#043D61'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "./.nuxt/tsconfig.json"
|
|
||||||
}
|
|
||||||
23
examples/basic-example/.gitignore
vendored
23
examples/basic-example/.gitignore
vendored
@@ -1,23 +0,0 @@
|
|||||||
# 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
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
shamefully-hoist=true
|
|
||||||
strict-peer-dependencies=false
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
# 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.
|
|
||||||
@@ -1,127 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
// https://nuxt.com/docs/api/configuration/nuxt-config
|
|
||||||
export default defineNuxtConfig({
|
|
||||||
devtools: { enabled: true },
|
|
||||||
build: {
|
|
||||||
transpile: ['trpc-nuxt'],
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "nuxt-app",
|
|
||||||
"private": true,
|
|
||||||
"scripts": {
|
|
||||||
"build": "nuxi build",
|
|
||||||
"dev": "nuxi dev",
|
|
||||||
"generate": "nuxi generate",
|
|
||||||
"preview": "nuxi preview",
|
|
||||||
"postinstall": "nuxi prepare"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@nuxt/devtools": "latest",
|
|
||||||
"@types/node": "20.5.7",
|
|
||||||
"nuxt": "^3.7.0"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"@trpc/client": "^10.38.1",
|
|
||||||
"@trpc/server": "^10.38.1",
|
|
||||||
"trpc-nuxt": "workspace:*",
|
|
||||||
"zod": "^3.22.2"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
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,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
})
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 4.2 KiB |
@@ -1,9 +0,0 @@
|
|||||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
|
||||||
import { appRouter } from '../../trpc/routers'
|
|
||||||
import { createContext } from '../../trpc/context'
|
|
||||||
|
|
||||||
// export API handler
|
|
||||||
export default createNuxtApiHandler({
|
|
||||||
router: appRouter,
|
|
||||||
createContext,
|
|
||||||
})
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
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>
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
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
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
/**
|
|
||||||
* 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
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "../.nuxt/tsconfig.server.json"
|
|
||||||
}
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
// https://nuxt.com/docs/guide/concepts/typescript
|
|
||||||
"extends": "./.nuxt/tsconfig.json"
|
|
||||||
}
|
|
||||||
94
package.json
94
package.json
@@ -1,82 +1,66 @@
|
|||||||
{
|
{
|
||||||
"name": "trpc-nuxt",
|
"name": "trpc-nuxt",
|
||||||
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"packageManager": "pnpm@8.6.9",
|
"version": "0.3.7",
|
||||||
"version": "0.10.12",
|
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"sideEffects": false,
|
|
||||||
"exports": {
|
"exports": {
|
||||||
|
"./package.json": "./package.json",
|
||||||
".": {
|
".": {
|
||||||
"require": "./dist/index.cjs",
|
"require": "./dist/module.cjs",
|
||||||
"import": "./dist/index.mjs"
|
"import": "./dist/module.mjs"
|
||||||
},
|
},
|
||||||
"./client": {
|
"./api": {
|
||||||
"types": "./dist/client/index.d.ts",
|
"types": "./dist/runtime/api.d.ts",
|
||||||
"require": "./dist/client/index.cjs",
|
"import": "./dist/runtime/api.mjs"
|
||||||
"import": "./dist/client/index.mjs"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"main": "./dist/index.mjs",
|
"main": "./dist/module.cjs",
|
||||||
"module": "./dist/index.mjs",
|
"types": "./dist/types.d.ts",
|
||||||
"types": "./dist/index.d.ts",
|
|
||||||
"files": [
|
"files": [
|
||||||
"dist",
|
"dist",
|
||||||
"client.d.ts"
|
"*.d.ts"
|
||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "tsup --watch --onSuccess \"pnpm --filter playground dev\"",
|
"build": "nuxt-module-build",
|
||||||
"dev:prepare": "pnpm build && nuxt prepare playground",
|
"dev": "nuxi dev playground",
|
||||||
"prepublishOnly": "pnpm build",
|
"dev:build": "nuxi build playground",
|
||||||
"build": "tsup",
|
"dev:preview": "nuxi preview playground",
|
||||||
|
"dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
|
||||||
"lint": "eslint .",
|
"lint": "eslint .",
|
||||||
"lint:fix": "eslint . --fix",
|
"lint:fix": "eslint . --fix",
|
||||||
"release": "changelogen --release && npm publish && git push --follow-tags",
|
"release": "bumpp --commit --push --tag && npm publish",
|
||||||
"update-deps": "taze -w && pnpm i"
|
"prepare": "nuxi prepare playground",
|
||||||
|
"prepublishOnly": "pnpm build"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@trpc/client": "^10.38.1",
|
"@trpc/client": "<10.0.0",
|
||||||
"@trpc/server": "^10.38.1"
|
"@trpc/server": "<10.0.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"h3": "^1.8.1",
|
"@nuxt/kit": "3.0.0",
|
||||||
"ofetch": "^1.3.3",
|
"@trpc/client": "^9.27.4",
|
||||||
"ohash": "^1.1.3"
|
"@trpc/server": "^9.27.4",
|
||||||
|
"dedent": "^0.7.0",
|
||||||
|
"defu": "^6.1.1",
|
||||||
|
"h3": "^1.0.2",
|
||||||
|
"ofetch": "^1.0.0",
|
||||||
|
"ohash": "^1.0.0",
|
||||||
|
"pathe": "^1.0.0",
|
||||||
|
"ufo": "^1.0.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@nuxt/eslint-config": "^0.2.0",
|
"@antfu/eslint-config": "^0.34.0",
|
||||||
"@trpc/client": "^10.38.1",
|
"@nuxt/module-builder": "^0.2.1",
|
||||||
"@trpc/server": "^10.38.1",
|
"@types/dedent": "^0.7.0",
|
||||||
"changelogen": "^0.5.5",
|
"bumpp": "^8.2.1",
|
||||||
"eslint": "^8.48.0",
|
"eslint": "^8.25.0",
|
||||||
"taze": "^0.11.2",
|
"nuxt": "3.0.0",
|
||||||
"tsup": "7.2.0",
|
"zod": "^3.20.2"
|
||||||
"typescript": "^5.2.2"
|
|
||||||
},
|
},
|
||||||
"eslintConfig": {
|
"eslintConfig": {
|
||||||
"extends": [
|
"extends": "@antfu",
|
||||||
"@nuxt/eslint-config"
|
|
||||||
],
|
|
||||||
"rules": {
|
"rules": {
|
||||||
"@typescript-eslint/no-unused-vars": [
|
"no-console": "warn"
|
||||||
"off"
|
|
||||||
],
|
|
||||||
"vue/multi-word-component-names": "off",
|
|
||||||
"vue/no-multiple-template-root": "off"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"eslintIgnore": [
|
|
||||||
"*.json",
|
|
||||||
"node_modules",
|
|
||||||
"*.md",
|
|
||||||
"dist",
|
|
||||||
".output"
|
|
||||||
],
|
|
||||||
"pnpm": {
|
|
||||||
"overrides": {
|
|
||||||
"nuxt": "3.7.0",
|
|
||||||
"@trpc/client": "10.38.1",
|
|
||||||
"@trpc/server": "10.38.1"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
|
import Module from '../src/module'
|
||||||
|
|
||||||
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
||||||
export default defineNuxtConfig({
|
export default defineNuxtConfig({
|
||||||
build: {
|
modules: [Module],
|
||||||
transpile: ['trpc-nuxt']
|
runtimeConfig: {
|
||||||
}
|
baseURL: '',
|
||||||
|
},
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,22 +1,4 @@
|
|||||||
{
|
{
|
||||||
"name": "playground",
|
"name": "playground",
|
||||||
"private": true,
|
"private": true
|
||||||
"scripts": {
|
|
||||||
"build": "nuxi build",
|
|
||||||
"dev": "nuxi dev",
|
|
||||||
"generate": "nuxi generate",
|
|
||||||
"preview": "nuxi preview",
|
|
||||||
"postinstall": "nuxi prepare"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"@trpc/client": "10.38.1",
|
|
||||||
"@trpc/server": "10.38.1",
|
|
||||||
"superjson": "^1.13.1",
|
|
||||||
"trpc-nuxt": "workspace:*",
|
|
||||||
"zod": "^3.22.2"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@types/node": "20.5.7",
|
|
||||||
"nuxt": "3.7.0"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,54 +1,56 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
const { $client } = useNuxtApp()
|
import { useAsyncQuery, useClient, useClientHeaders } 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 addTodo = async () => {
|
||||||
const title = Math.random().toString(36).slice(2, 7)
|
const title = Math.random().toString(36).slice(2, 7)
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const x = await $client.todo.addTodo.mutate({
|
const result = await client.mutation('addTodo', {
|
||||||
id: Date.now(),
|
id: Date.now(),
|
||||||
userId: 69,
|
userId: 69,
|
||||||
title,
|
title,
|
||||||
completed: false
|
completed: false,
|
||||||
})
|
})
|
||||||
console.log(x)
|
console.log('Todo: ', result)
|
||||||
} catch (e) {
|
}
|
||||||
|
catch (e) {
|
||||||
console.log(e)
|
console.log(e)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const { data: todos, pending, error, refresh } = await $client.todo.getTodos.useLazyQuery()
|
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div>
|
<div v-if="pending">
|
||||||
<div v-if="pending">
|
Loading...
|
||||||
Loading...
|
</div>
|
||||||
</div>
|
<div v-else-if="error?.data?.code">
|
||||||
<div v-else-if="error?.data?.code">
|
Error: {{ error.data.code }}
|
||||||
Error: {{ error.data.code }}
|
</div>
|
||||||
</div>
|
<div v-else-if="todos">
|
||||||
<div v-else>
|
<ul>
|
||||||
<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)"
|
Title: {{ t.title }}
|
||||||
:key="t.id"
|
</NuxtLink>
|
||||||
>
|
</li>
|
||||||
<NuxtLink
|
</ul>
|
||||||
:class="{ completed: t.completed }"
|
<button @click="addTodo">
|
||||||
:to="`/todo/${t.id}`"
|
Add Todo
|
||||||
>
|
</button>
|
||||||
Title: {{ t.title }}
|
<button @click="() => refresh()">
|
||||||
</NuxtLink>
|
Refresh
|
||||||
</li>
|
</button>
|
||||||
</ul>
|
<button @click="addHeader">
|
||||||
<button @click="addTodo">
|
Add header
|
||||||
Add Todo
|
</button>
|
||||||
</button>
|
|
||||||
<button @click="() => refresh()">
|
|
||||||
Refresh
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
|
|||||||
@@ -1,27 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,15 +1,15 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
|
import { useAsyncQuery, useRoute } from '#imports'
|
||||||
const route = useRoute()
|
const route = useRoute()
|
||||||
const { $client } = useNuxtApp()
|
const { data: todo, pending, error } = await useAsyncQuery(['getTodo', Number(route.params.id)])
|
||||||
const { data: todo, pending, error } = await useAsyncData(() => $client.todo.getTodo.query(Number(route.params.id)))
|
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div v-if="pending">
|
<div v-if="pending">
|
||||||
Loading...
|
Loading...
|
||||||
</div>
|
</div>
|
||||||
<div v-else-if="error">
|
<div v-else-if="error?.data?.code">
|
||||||
{{ error.message }} - {{ error.cause }}
|
{{ error.data.code }}
|
||||||
</div>
|
</div>
|
||||||
<div v-else>
|
<div v-else>
|
||||||
ID: {{ todo?.id }} <br>
|
ID: {{ todo?.id }} <br>
|
||||||
|
|||||||
@@ -1,25 +0,0 @@
|
|||||||
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 client = createTRPCNuxtClient<AppRouter>({
|
|
||||||
transformer: superjson,
|
|
||||||
links: [
|
|
||||||
// adds pretty logs to your console in development and logs errors in production
|
|
||||||
loggerLink({
|
|
||||||
enabled: opts =>
|
|
||||||
process.env.NODE_ENV === 'development' ||
|
|
||||||
(opts.direction === 'down' && opts.result instanceof Error)
|
|
||||||
}),
|
|
||||||
httpBatchLink()
|
|
||||||
]
|
|
||||||
})
|
|
||||||
|
|
||||||
return {
|
|
||||||
provide: {
|
|
||||||
client
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
|
||||||
import { appRouter } from '../../trpc/routers'
|
|
||||||
import { createContext } from '../../trpc/context'
|
|
||||||
|
|
||||||
export default createNuxtApiHandler({
|
|
||||||
router: appRouter,
|
|
||||||
/**
|
|
||||||
* @link https://trpc.io/docs/context
|
|
||||||
*/
|
|
||||||
createContext,
|
|
||||||
onError ({ error }) {
|
|
||||||
if (error.code === 'INTERNAL_SERVER_ERROR') {
|
|
||||||
// send to bug reporting
|
|
||||||
console.error('Something went wrong', error)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* @link https://trpc.io/docs/caching#api-response-caching
|
|
||||||
*/
|
|
||||||
// responseMeta() {
|
|
||||||
// // ...
|
|
||||||
// },
|
|
||||||
})
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
||||||
import type { inferAsyncReturnType } from '@trpc/server'
|
|
||||||
import type { H3Event } from 'h3'
|
|
||||||
|
|
||||||
export type Context = inferAsyncReturnType<typeof createContext>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates context for an incoming request
|
|
||||||
* @link https://trpc.io/docs/context
|
|
||||||
*/
|
|
||||||
export function createContext (
|
|
||||||
event: H3Event
|
|
||||||
) {
|
|
||||||
// for API-response caching see https://trpc.io/docs/caching
|
|
||||||
// console.log('cookies', parseCookies(event))
|
|
||||||
|
|
||||||
return {}
|
|
||||||
}
|
|
||||||
52
playground/server/trpc/index.ts
Normal file
52
playground/server/trpc/index.ts
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import * as trpc from '@trpc/server'
|
||||||
|
import type { inferAsyncReturnType } from '@trpc/server'
|
||||||
|
import { z } from 'zod'
|
||||||
|
import type { H3Event } from 'h3'
|
||||||
|
|
||||||
|
const baseURL = 'https://jsonplaceholder.typicode.com'
|
||||||
|
|
||||||
|
const TodoShape = z.object({
|
||||||
|
userId: z.number(),
|
||||||
|
id: z.number(),
|
||||||
|
title: z.string(),
|
||||||
|
completed: z.boolean(),
|
||||||
|
})
|
||||||
|
|
||||||
|
export type Todo = z.infer<typeof TodoShape>
|
||||||
|
|
||||||
|
export const router = trpc.router<Context>()
|
||||||
|
.query('getTodos', {
|
||||||
|
async resolve() {
|
||||||
|
return await $fetch<Todo[]>(`${baseURL}/todos`)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.query('getTodo', {
|
||||||
|
input: z.number(),
|
||||||
|
async resolve(req) {
|
||||||
|
return await $fetch<Todo>(`${baseURL}/todos/${req.input}`)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.mutation('addTodo', {
|
||||||
|
input: TodoShape,
|
||||||
|
async resolve(req) {
|
||||||
|
return await $fetch<Todo>(`${baseURL}/todos`, {
|
||||||
|
method: 'POST',
|
||||||
|
body: req.input,
|
||||||
|
})
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
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(event.node.req.headers)
|
||||||
|
|
||||||
|
return {
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type Context = inferAsyncReturnType<typeof createContext>
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
import { router } from '../trpc'
|
|
||||||
import { todoRouter } from './todo'
|
|
||||||
import { userRouter } from './user'
|
|
||||||
|
|
||||||
export const appRouter = router({
|
|
||||||
todo: todoRouter,
|
|
||||||
user: userRouter
|
|
||||||
})
|
|
||||||
|
|
||||||
export type AppRouter = typeof appRouter
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
import { z } from 'zod'
|
|
||||||
import { publicProcedure, router } from '../trpc'
|
|
||||||
import { $fetch } from 'ofetch'
|
|
||||||
|
|
||||||
const baseURL = 'https://jsonplaceholder.typicode.com'
|
|
||||||
|
|
||||||
const TodoShape = z.object({
|
|
||||||
userId: z.number(),
|
|
||||||
id: z.number(),
|
|
||||||
title: z.string(),
|
|
||||||
completed: z.boolean()
|
|
||||||
})
|
|
||||||
|
|
||||||
export type Todo = z.infer<typeof TodoShape>
|
|
||||||
|
|
||||||
export const todoRouter = router({
|
|
||||||
getTodos: publicProcedure
|
|
||||||
.query(() => {
|
|
||||||
return $fetch<Todo[]>(`${baseURL}/todos`)
|
|
||||||
}),
|
|
||||||
getTodo: publicProcedure
|
|
||||||
.input(z.number())
|
|
||||||
.query((req) => {
|
|
||||||
return $fetch<Todo>(`${baseURL}/todos/${req.input}`)
|
|
||||||
}),
|
|
||||||
addTodo: publicProcedure
|
|
||||||
.input(TodoShape)
|
|
||||||
.mutation((req) => {
|
|
||||||
return $fetch<Todo>(`${baseURL}/todos`, {
|
|
||||||
method: 'POST',
|
|
||||||
body: req.input
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
import { z } from 'zod'
|
|
||||||
import { publicProcedure, router } from '../trpc'
|
|
||||||
|
|
||||||
const baseURL = 'https://jsonplaceholder.typicode.com'
|
|
||||||
|
|
||||||
const UserShape = z.object({
|
|
||||||
id: z.number(),
|
|
||||||
name: z.string(),
|
|
||||||
username: z.string(),
|
|
||||||
email: z.string()
|
|
||||||
})
|
|
||||||
|
|
||||||
export type User = z.infer<typeof UserShape>
|
|
||||||
|
|
||||||
export const userRouter = router({
|
|
||||||
getUsers: publicProcedure
|
|
||||||
.query(() => {
|
|
||||||
return $fetch<User[]>(`${baseURL}/users`)
|
|
||||||
}),
|
|
||||||
getUser: publicProcedure
|
|
||||||
.input(z.number())
|
|
||||||
.query((req) => {
|
|
||||||
return $fetch<User>(`${baseURL}/users/${req.input}`)
|
|
||||||
}),
|
|
||||||
addUser: publicProcedure
|
|
||||||
.input(UserShape)
|
|
||||||
.mutation((req) => {
|
|
||||||
return $fetch<User>(`${baseURL}/users`, {
|
|
||||||
method: 'POST',
|
|
||||||
body: req.input
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
import { initTRPC } from '@trpc/server'
|
|
||||||
import superjson from 'superjson'
|
|
||||||
import { ZodError } from 'zod'
|
|
||||||
import type { Context } from './context'
|
|
||||||
|
|
||||||
const t = initTRPC.context<Context>().create({
|
|
||||||
transformer: superjson,
|
|
||||||
errorFormatter ({ shape, error }) {
|
|
||||||
return {
|
|
||||||
...shape,
|
|
||||||
data: {
|
|
||||||
...shape.data,
|
|
||||||
zodError:
|
|
||||||
error.code === 'BAD_REQUEST' &&
|
|
||||||
error.cause instanceof ZodError
|
|
||||||
? error.cause!.flatten()
|
|
||||||
: null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a router
|
|
||||||
* @see https://trpc.io/docs/v10/router
|
|
||||||
*/
|
|
||||||
export const router = t.router
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create an unprotected procedure
|
|
||||||
* @see https://trpc.io/docs/v10/procedures
|
|
||||||
**/
|
|
||||||
export const publicProcedure = t.procedure
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @see https://trpc.io/docs/v10/middlewares
|
|
||||||
*/
|
|
||||||
export const middleware = t.middleware
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @see https://trpc.io/docs/v10/merging-routers
|
|
||||||
*/
|
|
||||||
export const mergeRouters = t.mergeRouters
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "../.nuxt/tsconfig.server.json"
|
|
||||||
}
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
// https://v3.nuxtjs.org/concepts/typescript
|
|
||||||
"extends": "./.nuxt/tsconfig.json"
|
|
||||||
}
|
|
||||||
11550
pnpm-lock.yaml
generated
11550
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,4 +1,2 @@
|
|||||||
packages:
|
packages:
|
||||||
- playground
|
- playground
|
||||||
- examples/*
|
|
||||||
- docs
|
|
||||||
|
|||||||
102
recipes/authorization.md
Normal file
102
recipes/authorization.md
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
## Authorization
|
||||||
|
|
||||||
|
The `createContext`-function is called for each incoming request so here you can add contextual information about the calling user from the request object.
|
||||||
|
|
||||||
|
### Create context from request headers
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/index.ts
|
||||||
|
import type { inferAsyncReturnType } from '@trpc/server'
|
||||||
|
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 }: 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
|
||||||
|
async function getUserFromHeader() {
|
||||||
|
if (req.headers.authorization) {
|
||||||
|
const user = await decodeAndVerifyJwtToken(req.headers.authorization.split(' ')[1])
|
||||||
|
return user
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
const user = await getUserFromHeader()
|
||||||
|
|
||||||
|
return {
|
||||||
|
user,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type Context = inferAsyncReturnType<typeof createContext>
|
||||||
|
|
||||||
|
// [..] Define API handler and app router
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option 1: Authorize using resolver
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { TRPCError } from '@trpc/server'
|
||||||
|
|
||||||
|
export const router = trpc
|
||||||
|
.router<Context>()
|
||||||
|
// open for anyone
|
||||||
|
.query('hello', {
|
||||||
|
input: z.string().nullish(),
|
||||||
|
resolve: ({ input, ctx }) => {
|
||||||
|
return `hello ${input ?? ctx.user?.name ?? 'world'}`
|
||||||
|
},
|
||||||
|
})
|
||||||
|
// checked in resolver
|
||||||
|
.query('secret', {
|
||||||
|
resolve: ({ ctx }) => {
|
||||||
|
if (!ctx.user)
|
||||||
|
throw new TRPCError({ code: 'UNAUTHORIZED' })
|
||||||
|
|
||||||
|
return {
|
||||||
|
secret: 'sauce',
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option 2: Authorize using middleware
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import * as trpc from '@trpc/server'
|
||||||
|
import { TRPCError } from '@trpc/server'
|
||||||
|
|
||||||
|
// Merging routers: https://trpc.io/docs/merging-routers
|
||||||
|
|
||||||
|
export const router = trpc
|
||||||
|
.router<Context>()
|
||||||
|
// this is accessible for everyone
|
||||||
|
.query('hello', {
|
||||||
|
input: z.string().nullish(),
|
||||||
|
resolve: ({ input, ctx }) => {
|
||||||
|
return `hello ${input ?? ctx.user?.name ?? 'world'}`
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.merge(
|
||||||
|
'admin.',
|
||||||
|
trpc.router<Context>()
|
||||||
|
// this protects all procedures defined next in this router
|
||||||
|
.middleware(async ({ ctx, next }) => {
|
||||||
|
if (!ctx.user?.isAdmin)
|
||||||
|
throw new TRPCError({ code: 'UNAUTHORIZED' })
|
||||||
|
|
||||||
|
return next()
|
||||||
|
})
|
||||||
|
.query('secret', {
|
||||||
|
resolve: ({ ctx }) => {
|
||||||
|
return {
|
||||||
|
secret: 'sauce',
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
Learn more about authorization [here](https://trpc.io/docs/authorization).
|
||||||
41
recipes/error-formatting.md
Normal file
41
recipes/error-formatting.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
## Error Formatting
|
||||||
|
|
||||||
|
The error formatting in your router will be inferred all the way to your client (& Vue components).
|
||||||
|
|
||||||
|
### Adding custom formatting
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/index.ts
|
||||||
|
import * as trpc from '@trpc/server'
|
||||||
|
|
||||||
|
export const router = trpc.router<Context>()
|
||||||
|
.formatError(({ shape, error }) => {
|
||||||
|
return {
|
||||||
|
...shape,
|
||||||
|
data: {
|
||||||
|
...shape.data,
|
||||||
|
zodError:
|
||||||
|
error.code === 'BAD_REQUEST'
|
||||||
|
&& error.cause instanceof ZodError
|
||||||
|
? error.cause.flatten()
|
||||||
|
: null,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Usage in Vue
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script setup lang="ts">
|
||||||
|
const { error } = await useAsyncQuery(['getUser', { id: 69 }])
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<pre v-if="error?.data?.zodError">
|
||||||
|
{{ JSON.stringify(error.data.zodError, null, 2) }}
|
||||||
|
</pre>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
Learn more about error formatting [here](https://trpc.io/docs/error-formatting).
|
||||||
15
recipes/error-handling.md
Normal file
15
recipes/error-handling.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
## Handling errors
|
||||||
|
|
||||||
|
All errors that occur in a procedure go through the `onError` method before being sent to the client. Here you can handle or change errors.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/index.ts
|
||||||
|
import * as trpc from '@trpc/server'
|
||||||
|
|
||||||
|
export function onError({ error, type, path, input, ctx, req }) {
|
||||||
|
console.error('Error:', error)
|
||||||
|
if (error.code === 'INTERNAL_SERVER_ERROR') {
|
||||||
|
// send to bug reporting
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
80
recipes/inference-helpers.md
Normal file
80
recipes/inference-helpers.md
Normal file
@@ -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]>
|
||||||
|
```
|
||||||
46
recipes/merging-routers.md
Normal file
46
recipes/merging-routers.md
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
# Merging Routers
|
||||||
|
|
||||||
|
Writing all API-code in your code in the same file is not a great idea. It's easy to merge routers with other routers.
|
||||||
|
|
||||||
|
Define your routes:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/routes/posts.ts
|
||||||
|
export const posts = trpc.router()
|
||||||
|
.query('list', {
|
||||||
|
resolve() {
|
||||||
|
// ..
|
||||||
|
return []
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/routes/users.ts
|
||||||
|
export const users = trpc.router()
|
||||||
|
.query('list', {
|
||||||
|
resolve() {
|
||||||
|
// ..
|
||||||
|
return []
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/index.ts
|
||||||
|
import { users } from './routes/users'
|
||||||
|
import { posts } from './routes/posts'
|
||||||
|
|
||||||
|
export const router = trpc.router()
|
||||||
|
.merge('user.', users) // prefix user procedures with "user."
|
||||||
|
.merge('post.', posts) // prefix post procedures with "post."
|
||||||
|
```
|
||||||
|
|
||||||
|
and use it like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script setup lang="ts">
|
||||||
|
const { data: users } = await useAsyncQuery(['user.list'])
|
||||||
|
const { data: posts } = await useAsyncQuery(['post.list'])
|
||||||
|
</script>
|
||||||
|
```
|
||||||
49
recipes/validation.md
Normal file
49
recipes/validation.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
## Validation
|
||||||
|
|
||||||
|
tRPC works out-of-the-box with yup/superstruct/zod/myzod/custom validators.
|
||||||
|
|
||||||
|
### Input Validation
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/index.ts
|
||||||
|
import { z } from 'zod'
|
||||||
|
|
||||||
|
export const router = trpc
|
||||||
|
.router()
|
||||||
|
.mutation('createUser', {
|
||||||
|
// validate input with Zod
|
||||||
|
input: z.object({
|
||||||
|
name: z.string().min(5)
|
||||||
|
}),
|
||||||
|
async resolve(req) {
|
||||||
|
// use your ORM of choice
|
||||||
|
return await UserModel.create({
|
||||||
|
data: req.input,
|
||||||
|
})
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Output Validation
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ~/server/trpc/index.ts
|
||||||
|
import { z } from 'zod'
|
||||||
|
|
||||||
|
export const router = trpc
|
||||||
|
.router()
|
||||||
|
.query('hello', {
|
||||||
|
// validate output with Zod
|
||||||
|
output: z.object({
|
||||||
|
greeting: z.string()
|
||||||
|
}),
|
||||||
|
// expects return type of { greeting: string }
|
||||||
|
resolve() {
|
||||||
|
return {
|
||||||
|
greeting: 'hello!',
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Learn more about input validation [here](https://trpc.io/docs/router#input-validation).
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
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 (['useQuery', 'useLazyQuery'].includes(lastArg)) {
|
|
||||||
const { trpc, queryKey: customQueryKey, ...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 = customQueryKey || getQueryKey(path, unref(input))
|
|
||||||
const watch = isRef(input) ? [...(asyncDataOptions.watch || []), input] : asyncDataOptions.watch
|
|
||||||
const isLazy = lastArg === 'useLazyQuery' ? true : (asyncDataOptions.lazy || false)
|
|
||||||
|
|
||||||
return useAsyncData(queryKey, () => (client as any)[path].query(unref(input), {
|
|
||||||
signal: controller?.signal,
|
|
||||||
...trpc
|
|
||||||
}), {
|
|
||||||
...asyncDataOptions,
|
|
||||||
watch,
|
|
||||||
lazy: isLazy
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
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'
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
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,
|
|
||||||
headers: response.headers,
|
|
||||||
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,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
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
|
|
||||||
/**
|
|
||||||
* The custom unique key to use.
|
|
||||||
* @see https://nuxt.com/docs/api/composables/use-async-data#params
|
|
||||||
*/
|
|
||||||
queryKey?: string
|
|
||||||
},
|
|
||||||
) => AsyncData<PickFrom<DataT, PickKeys> | null, DataE>,
|
|
||||||
useLazyQuery: <
|
|
||||||
ResT = inferTransformedProcedureOutput<TProcedure>,
|
|
||||||
DataE = TRPCClientErrorLike<TProcedure>,
|
|
||||||
DataT = ResT,
|
|
||||||
PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
|
|
||||||
>(
|
|
||||||
input: MaybeRef<inferProcedureInput<TProcedure>>,
|
|
||||||
opts?: Omit<AsyncDataOptions<ResT, DataT, PickKeys>, 'lazy'> & {
|
|
||||||
trpc?: TRPCRequestOptions
|
|
||||||
/**
|
|
||||||
* The custom unique key to use.
|
|
||||||
* @see https://nuxt.com/docs/api/composables/use-async-data#params
|
|
||||||
*/
|
|
||||||
queryKey?: string
|
|
||||||
},
|
|
||||||
) => 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;
|
|
||||||
}
|
|
||||||
149
src/index.ts
149
src/index.ts
@@ -1,149 +0,0 @@
|
|||||||
import type { ResponseMeta } from '@trpc/server/http'
|
|
||||||
import { resolveHTTPResponse } from '@trpc/server/http'
|
|
||||||
import type {
|
|
||||||
AnyRouter,
|
|
||||||
ProcedureType,
|
|
||||||
inferRouterContext,
|
|
||||||
inferRouterError
|
|
||||||
} from '@trpc/server'
|
|
||||||
import {
|
|
||||||
TRPCError
|
|
||||||
} from '@trpc/server'
|
|
||||||
import type { H3Event } 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>
|
|
||||||
|
|
||||||
export type CreateContextFn<TRouter extends AnyRouter> = (event: H3Event) => MaybePromise<inferRouterContext<TRouter>>
|
|
||||||
|
|
||||||
export interface ResponseMetaFnPayload<TRouter extends AnyRouter> {
|
|
||||||
data: TRPCResponse<unknown, inferRouterError<TRouter>>[]
|
|
||||||
ctx?: inferRouterContext<TRouter>
|
|
||||||
paths?: string[]
|
|
||||||
type: ProcedureType | 'unknown'
|
|
||||||
errors: TRPCError[]
|
|
||||||
}
|
|
||||||
|
|
||||||
export type ResponseMetaFn<TRouter extends AnyRouter> = (opts: ResponseMetaFnPayload<TRouter>) => ResponseMeta
|
|
||||||
|
|
||||||
export interface OnErrorPayload<TRouter extends AnyRouter> {
|
|
||||||
error: TRPCError
|
|
||||||
type: ProcedureType | 'unknown'
|
|
||||||
path: string | undefined
|
|
||||||
req: H3Event['node']['req']
|
|
||||||
input: unknown
|
|
||||||
ctx: undefined | inferRouterContext<TRouter>
|
|
||||||
}
|
|
||||||
|
|
||||||
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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function getPath (event: H3Event): string | null {
|
|
||||||
const { params } = event.context
|
|
||||||
|
|
||||||
if (typeof params?.trpc === 'string') { return params.trpc }
|
|
||||||
|
|
||||||
if (params?.trpc && Array.isArray(params.trpc)) {
|
|
||||||
return (params.trpc as string[]).join('/')
|
|
||||||
}
|
|
||||||
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
|
|
||||||
export function createNuxtApiHandler<TRouter extends AnyRouter> ({
|
|
||||||
router,
|
|
||||||
createContext,
|
|
||||||
responseMeta,
|
|
||||||
onError,
|
|
||||||
batching
|
|
||||||
}: ResolveHTTPRequestOptions<TRouter>) {
|
|
||||||
return defineEventHandler(async (event) => {
|
|
||||||
const {
|
|
||||||
req,
|
|
||||||
res
|
|
||||||
} = event.node
|
|
||||||
|
|
||||||
const $url = getRequestURL(event)
|
|
||||||
|
|
||||||
const path = getPath(event)
|
|
||||||
|
|
||||||
if (path === null) {
|
|
||||||
const error = getErrorShape({
|
|
||||||
config: router._def._config,
|
|
||||||
error: new TRPCError({
|
|
||||||
message:
|
|
||||||
'Query "trpc" not found - is the file named `[trpc]`.ts or `[...trpc].ts`?',
|
|
||||||
code: 'INTERNAL_SERVER_ERROR'
|
|
||||||
}),
|
|
||||||
type: 'unknown',
|
|
||||||
ctx: undefined,
|
|
||||||
path: undefined,
|
|
||||||
input: undefined
|
|
||||||
})
|
|
||||||
|
|
||||||
throw createError({
|
|
||||||
statusCode: 500,
|
|
||||||
statusMessage: JSON.stringify(error)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
const httpResponse = await resolveHTTPResponse({
|
|
||||||
batching,
|
|
||||||
router,
|
|
||||||
req: {
|
|
||||||
method: req.method!,
|
|
||||||
headers: req.headers,
|
|
||||||
body: isMethod(event, 'GET') ? null : await readBody(event),
|
|
||||||
query: $url.searchParams
|
|
||||||
},
|
|
||||||
path,
|
|
||||||
createContext: async () => await createContext?.(event),
|
|
||||||
responseMeta,
|
|
||||||
onError: (o) => {
|
|
||||||
onError?.({
|
|
||||||
...o,
|
|
||||||
req
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
const { status, headers, body } = httpResponse
|
|
||||||
|
|
||||||
res.statusCode = status
|
|
||||||
|
|
||||||
headers && Object.keys(headers).forEach((key) => {
|
|
||||||
res.setHeader(key, headers[key]!)
|
|
||||||
})
|
|
||||||
|
|
||||||
return body
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
export const createH3ApiHandler = createNuxtApiHandler
|
|
||||||
79
src/module.ts
Normal file
79
src/module.ts
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
import { fileURLToPath } from 'url'
|
||||||
|
import { join, resolve } from 'pathe'
|
||||||
|
import { defu } from 'defu'
|
||||||
|
import dedent from 'dedent'
|
||||||
|
|
||||||
|
import { addImports, addPlugin, addServerHandler, addTemplate, defineNuxtModule, useLogger } from '@nuxt/kit'
|
||||||
|
|
||||||
|
export interface ModuleOptions {
|
||||||
|
baseURL: string
|
||||||
|
endpoint: string
|
||||||
|
installPlugin?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
const metaName = 'trpc-nuxt'
|
||||||
|
|
||||||
|
export default defineNuxtModule<ModuleOptions>({
|
||||||
|
meta: {
|
||||||
|
name: metaName,
|
||||||
|
configKey: 'trpc',
|
||||||
|
},
|
||||||
|
defaults: {
|
||||||
|
baseURL: '',
|
||||||
|
endpoint: '/trpc',
|
||||||
|
installPlugin: true,
|
||||||
|
},
|
||||||
|
async setup(options, nuxt) {
|
||||||
|
const logger = useLogger(metaName)
|
||||||
|
|
||||||
|
const handlerPath = join(nuxt.options.buildDir, 'trpc-handler.ts')
|
||||||
|
const trpcOptionsPath = join(nuxt.options.srcDir, 'server/trpc')
|
||||||
|
|
||||||
|
const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
|
||||||
|
nuxt.options.build.transpile.push(runtimeDir, handlerPath)
|
||||||
|
|
||||||
|
// Final resolved configuration
|
||||||
|
const finalConfig = nuxt.options.runtimeConfig.public.trpc = defu(nuxt.options.runtimeConfig.public.trpc, {
|
||||||
|
baseURL: options.baseURL,
|
||||||
|
endpoint: options.endpoint,
|
||||||
|
installPlugin: options.installPlugin,
|
||||||
|
})
|
||||||
|
|
||||||
|
addServerHandler({
|
||||||
|
route: `${finalConfig.endpoint}/*`,
|
||||||
|
handler: handlerPath,
|
||||||
|
})
|
||||||
|
|
||||||
|
addTemplate({
|
||||||
|
filename: 'trpc-handler.ts',
|
||||||
|
write: true,
|
||||||
|
getContents() {
|
||||||
|
return dedent`
|
||||||
|
import { createTRPCHandler } from ${JSON.stringify(join(runtimeDir, 'api'))};
|
||||||
|
import * as functions from ${JSON.stringify(trpcOptionsPath)};
|
||||||
|
|
||||||
|
export default createTRPCHandler({
|
||||||
|
...functions,
|
||||||
|
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.')
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
90
src/runtime/api.ts
Normal file
90
src/runtime/api.ts
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
import { resolveHTTPResponse } from '@trpc/server'
|
||||||
|
import type {
|
||||||
|
AnyRouter,
|
||||||
|
ProcedureType,
|
||||||
|
ResponseMeta,
|
||||||
|
TRPCError,
|
||||||
|
inferRouterContext,
|
||||||
|
inferRouterError,
|
||||||
|
} from '@trpc/server'
|
||||||
|
import { createURL } from 'ufo'
|
||||||
|
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: H3Event) => MaybePromise<inferRouterContext<TRouter>>
|
||||||
|
|
||||||
|
export interface ResponseMetaFnPayload<TRouter extends AnyRouter> {
|
||||||
|
data: TRPCResponse<unknown, inferRouterError<TRouter>>[]
|
||||||
|
ctx?: inferRouterContext<TRouter>
|
||||||
|
paths?: string[]
|
||||||
|
type: ProcedureType | 'unknown'
|
||||||
|
errors: TRPCError[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ResponseMetaFn<TRouter extends AnyRouter> = (opts: ResponseMetaFnPayload<TRouter>) => ResponseMeta
|
||||||
|
|
||||||
|
export interface OnErrorPayload<TRouter extends AnyRouter> {
|
||||||
|
error: TRPCError
|
||||||
|
type: ProcedureType | 'unknown'
|
||||||
|
path: string | undefined
|
||||||
|
req: H3Event['node']['req']
|
||||||
|
input: unknown
|
||||||
|
ctx: undefined | inferRouterContext<TRouter>
|
||||||
|
}
|
||||||
|
|
||||||
|
export type OnErrorFn<TRouter extends AnyRouter> = (opts: OnErrorPayload<TRouter>) => void
|
||||||
|
|
||||||
|
export function createTRPCHandler<Router extends AnyRouter>({
|
||||||
|
router,
|
||||||
|
createContext,
|
||||||
|
responseMeta,
|
||||||
|
onError,
|
||||||
|
endpoint,
|
||||||
|
}: {
|
||||||
|
router: Router
|
||||||
|
createContext?: CreateContextFn<Router>
|
||||||
|
responseMeta?: ResponseMetaFn<Router>
|
||||||
|
onError?: OnErrorFn<Router>
|
||||||
|
endpoint: string
|
||||||
|
}) {
|
||||||
|
return defineEventHandler(async (event) => {
|
||||||
|
const {
|
||||||
|
req,
|
||||||
|
res,
|
||||||
|
} = event.node
|
||||||
|
|
||||||
|
const $url = createURL(req.url!)
|
||||||
|
|
||||||
|
const httpResponse = await resolveHTTPResponse({
|
||||||
|
router,
|
||||||
|
req: {
|
||||||
|
method: req.method!,
|
||||||
|
headers: req.headers,
|
||||||
|
body: isMethod(event, 'GET') ? null : await readBody(event),
|
||||||
|
query: $url.searchParams,
|
||||||
|
},
|
||||||
|
path: $url.pathname.substring(endpoint.length + 1),
|
||||||
|
createContext: async () => createContext?.(event),
|
||||||
|
responseMeta,
|
||||||
|
onError: (o) => {
|
||||||
|
onError?.({
|
||||||
|
...o,
|
||||||
|
req,
|
||||||
|
})
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
const { status, headers, body } = httpResponse
|
||||||
|
|
||||||
|
res.statusCode = status
|
||||||
|
|
||||||
|
headers && Object.keys(headers).forEach((key) => {
|
||||||
|
res.setHeader(key, headers[key]!)
|
||||||
|
})
|
||||||
|
|
||||||
|
return body
|
||||||
|
})
|
||||||
|
}
|
||||||
71
src/runtime/client.ts
Normal file
71
src/runtime/client.ts
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
import type {
|
||||||
|
AsyncData,
|
||||||
|
AsyncDataOptions,
|
||||||
|
KeyOfRes,
|
||||||
|
PickFrom,
|
||||||
|
_Transform,
|
||||||
|
} from 'nuxt/dist/app/composables/asyncData'
|
||||||
|
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 '#imports'
|
||||||
|
import type { router } from '~/server/trpc'
|
||||||
|
|
||||||
|
type MaybeRef<T> = T | Ref<T>
|
||||||
|
|
||||||
|
type AppRouter = typeof router
|
||||||
|
|
||||||
|
export type inferProcedures<
|
||||||
|
TObj extends ProcedureRecord<any, any, any, any, any, any>,
|
||||||
|
> = {
|
||||||
|
[TPath in keyof TObj]: {
|
||||||
|
input: inferProcedureInput<TObj[TPath]>
|
||||||
|
output: inferProcedureOutput<TObj[TPath]>
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TQueries = AppRouter['_def']['queries']
|
||||||
|
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'],
|
||||||
|
Transform extends _Transform<TOutput> = _Transform<TOutput, TOutput>,
|
||||||
|
PickKeys extends KeyOfRes<Transform> = KeyOfRes<Transform>,
|
||||||
|
>(
|
||||||
|
pathAndInput: [path: TPath, ...args: inferHandlerInput<TQueries[TPath]>],
|
||||||
|
options: AsyncDataOptions<TOutput, Transform, PickKeys> = {},
|
||||||
|
): Promise<AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TError>> {
|
||||||
|
const { $client } = useNuxtApp()
|
||||||
|
const key = getQueryKey(pathAndInput)
|
||||||
|
const result = await useAsyncData(
|
||||||
|
key,
|
||||||
|
() => $client.query(...pathAndInput),
|
||||||
|
// @ts-expect-error: Internal
|
||||||
|
options,
|
||||||
|
)
|
||||||
|
|
||||||
|
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)
|
||||||
|
}
|
||||||
45
src/runtime/plugin.ts
Normal file
45
src/runtime/plugin.ts
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
import * as trpc from '@trpc/client'
|
||||||
|
import { unref } from 'vue'
|
||||||
|
import { FetchError } from 'ofetch'
|
||||||
|
import { useClientHeaders } from './client'
|
||||||
|
import { defineNuxtPlugin, useRequestHeaders, useRuntimeConfig } from '#imports'
|
||||||
|
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 baseURL = process.server ? '' : config.baseURL
|
||||||
|
const client = trpc.createTRPCClient<AppRouter>({
|
||||||
|
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),
|
||||||
|
})),
|
||||||
|
})
|
||||||
|
|
||||||
|
nuxtApp.provide('client', client)
|
||||||
|
})
|
||||||
|
|
||||||
|
declare module '#app' {
|
||||||
|
interface NuxtApp {
|
||||||
|
$client: trpc.TRPCClient<AppRouter>
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,16 +1,3 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"extends": "./playground/.nuxt/tsconfig.json"
|
||||||
"target": "es2020",
|
|
||||||
"module": "esnext",
|
|
||||||
"strict": true,
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"moduleResolution": "node",
|
|
||||||
"skipLibCheck": true,
|
|
||||||
"noUnusedLocals": true,
|
|
||||||
"noImplicitAny": true,
|
|
||||||
"allowJs": true,
|
|
||||||
"noEmit": true,
|
|
||||||
"resolveJsonModule": true,
|
|
||||||
"skipDefaultLibCheck": true
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
import { defineConfig } from 'tsup'
|
|
||||||
|
|
||||||
export default defineConfig({
|
|
||||||
entry: ['src/index.ts', 'src/client/index.ts'],
|
|
||||||
format: ['cjs', 'esm'],
|
|
||||||
splitting: false,
|
|
||||||
clean: true,
|
|
||||||
external: ['#app', '#imports', /@trpc\/client/, /@trpc\/server/],
|
|
||||||
dts: true,
|
|
||||||
outExtension ({ format }) {
|
|
||||||
return {
|
|
||||||
js: format === 'esm' ? '.mjs' : `.${format}`
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
Reference in New Issue
Block a user