mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-22 16:00:37 +01:00
Compare commits
95 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
07693009f8 | ||
|
|
dceade155c | ||
|
|
4012249f09 | ||
|
|
38eda2c4d6 | ||
|
|
9468af75f4 | ||
|
|
ea24a67a6d | ||
|
|
5e8d04741c | ||
|
|
1032e65a0d | ||
|
|
f261d3feeb | ||
|
|
b1ca09e986 | ||
|
|
b804429fc0 | ||
|
|
7df64296ff | ||
|
|
a53d823f5e | ||
|
|
feef3dde6b | ||
|
|
82ee2ce672 | ||
|
|
f62a13766a | ||
|
|
c7888e81ed | ||
|
|
c77eb68f5d | ||
|
|
333539569c | ||
|
|
e5c40f183b | ||
|
|
977a9e1465 | ||
|
|
2620379e02 | ||
|
|
e4f42d5322 | ||
|
|
ad28a9124e | ||
|
|
273bda980b | ||
|
|
9c8509f79c | ||
|
|
2ce29137ce | ||
|
|
e9c5307e23 | ||
|
|
bbdabf544c | ||
|
|
aed10ac5b8 | ||
|
|
4b2c714658 | ||
|
|
43e9fefdbd | ||
|
|
dabda23976 | ||
|
|
af89f32275 | ||
|
|
1f27b871fb | ||
|
|
281e4c05a0 | ||
|
|
38ac520b97 | ||
|
|
96ebff619e | ||
|
|
f668e4a9b4 | ||
|
|
58b0165557 | ||
|
|
3b5e35ef68 | ||
|
|
48152ead8d | ||
|
|
7f44e049c0 | ||
|
|
5a71bbf1fe | ||
|
|
285487e9bf | ||
|
|
2cfa64fcc6 | ||
|
|
eea5733dcd | ||
|
|
71bbbf2b86 | ||
|
|
2b57ab8791 | ||
|
|
f8edd769f0 | ||
|
|
419ef34de6 | ||
|
|
30c76b5859 | ||
|
|
2575beae5d | ||
|
|
b09d1af30d | ||
|
|
610e441db7 | ||
|
|
959b370729 | ||
|
|
c1c4e67694 | ||
|
|
779221d9e6 | ||
|
|
986b661e99 | ||
|
|
77325a6699 | ||
|
|
6dcb4ce8a6 | ||
|
|
c95d46f43a | ||
|
|
2844cc0bbd | ||
|
|
aeb2e1b8e3 | ||
|
|
68d9eb2461 | ||
|
|
109a07a42d | ||
|
|
7775e59b0c | ||
|
|
c23af214a3 | ||
|
|
7851846ad5 | ||
|
|
f9b0aa002e | ||
|
|
eb1bd0c700 | ||
|
|
47ba58c0b7 | ||
|
|
a458ed9b3f | ||
|
|
09d043d49b | ||
|
|
3e47e2a389 | ||
|
|
f8d82c4af1 | ||
|
|
e31578bf97 | ||
|
|
88c77f6e8f | ||
|
|
eafc476544 | ||
|
|
dc86c0252e | ||
|
|
a3dadb9e50 | ||
|
|
5331535237 | ||
|
|
ae0abd2b45 | ||
|
|
273215c9e1 | ||
|
|
812ceda4a0 | ||
|
|
c48556e24e | ||
|
|
f3e0165dd8 | ||
|
|
87ed453425 | ||
|
|
d890633cb1 | ||
|
|
a48ee2551e | ||
|
|
899369a0a6 | ||
|
|
08857b0f45 | ||
|
|
5b94433b8f | ||
|
|
38fb3edf22 | ||
|
|
4f2f88bea2 |
48
README.md
48
README.md
@@ -4,6 +4,17 @@
|
|||||||
|
|
||||||
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">
|
||||||
|
<figure>
|
||||||
|
<img src="https://i.imgur.com/AjmNUxj.gif" alt="Demo" />
|
||||||
|
<figcaption>
|
||||||
|
<p align="center">
|
||||||
|
The client above is <strong>not</strong> importing any code from the server, only its type declarations.
|
||||||
|
</p>
|
||||||
|
</figcaption>
|
||||||
|
</figure>
|
||||||
|
</p>
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -18,10 +29,10 @@ export default defineNuxtConfig({
|
|||||||
modules: ['trpc-nuxt'],
|
modules: ['trpc-nuxt'],
|
||||||
trpc: {
|
trpc: {
|
||||||
baseURL: 'http://localhost:3000', // defaults to http://localhost:3000
|
baseURL: 'http://localhost:3000', // defaults to http://localhost:3000
|
||||||
trpcURL: '/api/trpc', // defaults to /api/trpc
|
endpoint: '/trpc', // defaults to /trpc
|
||||||
},
|
},
|
||||||
typescript: {
|
typescript: {
|
||||||
strict: true // set this to true to make input/output types work
|
strict: true // required to make input/output types work
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
@@ -63,11 +74,9 @@ const client = useClient() // auto-imported
|
|||||||
|
|
||||||
const users = await client.query('getUsers')
|
const users = await client.query('getUsers')
|
||||||
|
|
||||||
const addUser = async () => {
|
const newUser = await client.mutation('createUser', {
|
||||||
const mutate = await client.mutation('createUser', {
|
name: 'wagmi'
|
||||||
name: 'wagmi'
|
})
|
||||||
})
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## useAsyncQuery
|
## useAsyncQuery
|
||||||
@@ -86,13 +95,28 @@ const {
|
|||||||
refresh
|
refresh
|
||||||
} = await useAsyncQuery(['getUser', { id: 69 }], {
|
} = await useAsyncQuery(['getUser', { id: 69 }], {
|
||||||
// pass useAsyncData options here
|
// pass useAsyncData options here
|
||||||
server: true
|
lazy: false
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## useClientHeaders
|
||||||
|
|
||||||
|
A composable that lets you add additional properties to pass to the tRPC Client. It uses `useStorage` from [@vueuse/core](https://vueuse.org/core/usestorage).
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const headers = useClientHeaders()
|
||||||
|
|
||||||
|
const { data: token } = await useAsyncQuery(['auth.login', { username, password }])
|
||||||
|
|
||||||
|
headers.value.Authorization = `Bearer ${token}`
|
||||||
|
|
||||||
|
// All client calls will now include the Authorization header.
|
||||||
|
// For SSR, please follow this link https://github.com/trpc/trpc/discussions/1686
|
||||||
|
```
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
trpc-nuxt accepts the following options exposed under `~/server/trpc.index.ts`:
|
trpc-nuxt accepts the following options exposed under `~/server/trpc/index.ts`:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import * as trpc from '@trpc/server'
|
import * as trpc from '@trpc/server'
|
||||||
@@ -131,11 +155,17 @@ export const onError = (payload: OnErrorPayload<typeof router>) => {
|
|||||||
|
|
||||||
- [Validation](/recipes/validation.md)
|
- [Validation](/recipes/validation.md)
|
||||||
- [Authorization](/recipes/authorization.md)
|
- [Authorization](/recipes/authorization.md)
|
||||||
|
- [Merging Routers](/recipes/merging-routers.md)
|
||||||
- [Error Handling](/recipes/error-handling.md)
|
- [Error Handling](/recipes/error-handling.md)
|
||||||
- [Error Formatting](/recipes/error-formatting.md)
|
- [Error Formatting](/recipes/error-formatting.md)
|
||||||
|
- [Inference Helpers](/recipes/inference-helpers.md)
|
||||||
|
|
||||||
Learn more about tRPC.io [here](https://trpc.io/docs).
|
Learn more about tRPC.io [here](https://trpc.io/docs).
|
||||||
|
|
||||||
|
## Recommended IDE Setup
|
||||||
|
|
||||||
|
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|||||||
40
package.json
40
package.json
@@ -1,11 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "trpc-nuxt",
|
"name": "trpc-nuxt",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"version": "0.1.0",
|
"version": "0.2.2",
|
||||||
"publishConfig": {
|
"packageManager": "pnpm@7.1.1",
|
||||||
"directory": "package"
|
|
||||||
},
|
|
||||||
"packageManager": "pnpm@7.1.0",
|
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "./dist/module.cjs",
|
"main": "./dist/module.cjs",
|
||||||
"types": "./dist/types.d.ts",
|
"types": "./dist/types.d.ts",
|
||||||
@@ -24,26 +21,25 @@
|
|||||||
"dist",
|
"dist",
|
||||||
"*.d.ts"
|
"*.d.ts"
|
||||||
],
|
],
|
||||||
"clean-publish": {
|
|
||||||
"withoutPublish": true,
|
|
||||||
"tempDir": "package"
|
|
||||||
},
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"prepublishOnly": "rimraf ./package && nr build && clean-publish",
|
"prepublishOnly": "nr build",
|
||||||
"postpublish": "rimraf ./package",
|
|
||||||
"build": "nuxt-module-build",
|
"build": "nuxt-module-build",
|
||||||
"play": "nr build && nuxi dev playground",
|
"play": "nr build && nuxi dev playground",
|
||||||
|
"build:playground": "nuxi build playground",
|
||||||
"lint": "eslint .",
|
"lint": "eslint .",
|
||||||
"lint:fix": "eslint . --fix",
|
"lint:fix": "eslint . --fix",
|
||||||
"release": "bumpp --commit --push --tag && pnpm publish",
|
"release": "bumpp --commit --push --tag && pnpm publish",
|
||||||
"prepare": "nuxi prepare playground"
|
"prepare": "nuxi prepare playground"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@nuxt/kit": "^3.0.0-rc.3",
|
"@nuxt/kit": "^3.0.0-rc.4",
|
||||||
"@trpc/client": "^9.23.3",
|
"@trpc/client": "^9.25.2",
|
||||||
"@trpc/server": "^9.23.2",
|
"@trpc/server": "^9.25.2",
|
||||||
"fs-extra": "^10.1.0",
|
"@vueuse/core": "^8.6.0",
|
||||||
"h3": "^0.7.8",
|
"@vueuse/nuxt": "^8.6.0",
|
||||||
|
"dedent": "^0.7.0",
|
||||||
|
"defu": "^6.0.0",
|
||||||
|
"h3": "^0.7.9",
|
||||||
"pathe": "^0.3.0",
|
"pathe": "^0.3.0",
|
||||||
"ufo": "^0.8.4"
|
"ufo": "^0.8.4"
|
||||||
},
|
},
|
||||||
@@ -51,18 +47,18 @@
|
|||||||
"@antfu/eslint-config": "^0.23.1",
|
"@antfu/eslint-config": "^0.23.1",
|
||||||
"@antfu/ni": "^0.16.2",
|
"@antfu/ni": "^0.16.2",
|
||||||
"@nuxt/module-builder": "latest",
|
"@nuxt/module-builder": "latest",
|
||||||
"@types/fs-extra": "^9.0.13",
|
|
||||||
"bumpp": "^7.1.1",
|
"bumpp": "^7.1.1",
|
||||||
"clean-publish": "^4.0.0",
|
|
||||||
"eslint": "^8.14.0",
|
"eslint": "^8.14.0",
|
||||||
"nuxt": "^3.0.0-rc.3",
|
"nuxt": "3.0.0-rc.4",
|
||||||
"ohash": "^0.1.0",
|
"ohash": "^0.1.0",
|
||||||
"pnpm": "^7.1.0",
|
"pnpm": "^7.1.1",
|
||||||
"superjson": "^1.9.1",
|
|
||||||
"trpc-nuxt": "workspace:*",
|
"trpc-nuxt": "workspace:*",
|
||||||
"zod": "^3.16.0"
|
"zod": "^3.16.0"
|
||||||
},
|
},
|
||||||
"eslintConfig": {
|
"eslintConfig": {
|
||||||
"extends": "@antfu"
|
"extends": "@antfu",
|
||||||
|
"rules": {
|
||||||
|
"no-console": "warn"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
51
package/.gitignore
vendored
51
package/.gitignore
vendored
@@ -1,51 +0,0 @@
|
|||||||
# Dependencies
|
|
||||||
node_modules
|
|
||||||
|
|
||||||
# Logs
|
|
||||||
*.log*
|
|
||||||
|
|
||||||
# Temp directories
|
|
||||||
.temp
|
|
||||||
.tmp
|
|
||||||
.cache
|
|
||||||
|
|
||||||
# Yarn
|
|
||||||
**/.yarn/cache
|
|
||||||
**/.yarn/*state*
|
|
||||||
|
|
||||||
# Generated dirs
|
|
||||||
dist
|
|
||||||
|
|
||||||
# Nuxt
|
|
||||||
.nuxt
|
|
||||||
.output
|
|
||||||
.vercel_build_output
|
|
||||||
.build-*
|
|
||||||
.env
|
|
||||||
.netlify
|
|
||||||
|
|
||||||
# Env
|
|
||||||
.env
|
|
||||||
|
|
||||||
# Testing
|
|
||||||
reports
|
|
||||||
coverage
|
|
||||||
*.lcov
|
|
||||||
.nyc_output
|
|
||||||
|
|
||||||
# VSCode
|
|
||||||
.vscode
|
|
||||||
|
|
||||||
# Intellij idea
|
|
||||||
*.iml
|
|
||||||
.idea
|
|
||||||
|
|
||||||
# OSX
|
|
||||||
.DS_Store
|
|
||||||
.AppleDouble
|
|
||||||
.LSOverride
|
|
||||||
.AppleDB
|
|
||||||
.AppleDesktop
|
|
||||||
Network Trash Folder
|
|
||||||
Temporary Items
|
|
||||||
.apdisk
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
ignore-workspace-root-check=true
|
|
||||||
shamefully-hoist=true
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) 2022 Robert Soriano <https://github.com/wobsoriano>
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
@@ -1,141 +0,0 @@
|
|||||||
# tRPC-Nuxt
|
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/trpc-nuxt)
|
|
||||||
|
|
||||||
End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm i trpc-nuxt
|
|
||||||
```
|
|
||||||
|
|
||||||
```ts
|
|
||||||
// nuxt.config.ts
|
|
||||||
import { defineNuxtConfig } from 'nuxt'
|
|
||||||
|
|
||||||
export default defineNuxtConfig({
|
|
||||||
modules: ['trpc-nuxt'],
|
|
||||||
trpc: {
|
|
||||||
baseURL: 'http://localhost:3000', // defaults to http://localhost:3000
|
|
||||||
trpcURL: '/api/trpc', // defaults to /api/trpc
|
|
||||||
},
|
|
||||||
typescript: {
|
|
||||||
strict: true // set this to true 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 addUser = async () => {
|
|
||||||
const mutate = 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
|
|
||||||
server: true
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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 { CompatibilityEvent } from 'h3'
|
|
||||||
import type { OnErrorPayload } from 'trpc-nuxt/api'
|
|
||||||
|
|
||||||
export const router = trpc.router<inferAsyncReturnType<typeof createContext>>()
|
|
||||||
|
|
||||||
// Optional
|
|
||||||
// https://trpc.io/docs/context
|
|
||||||
export const createContext = (event: CompatibilityEvent) => {
|
|
||||||
// ...
|
|
||||||
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)
|
|
||||||
- [Error Handling](/recipes/error-handling.md)
|
|
||||||
- [Error Formatting](/recipes/error-formatting.md)
|
|
||||||
|
|
||||||
Learn more about tRPC.io [here](https://trpc.io/docs).
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT
|
|
||||||
1
package/api.d.ts
vendored
1
package/api.d.ts
vendored
@@ -1 +0,0 @@
|
|||||||
export * from './dist/runtime/api'
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "trpc-nuxt",
|
|
||||||
"type": "module",
|
|
||||||
"version": "0.0.3",
|
|
||||||
"publishConfig": {
|
|
||||||
"directory": "package"
|
|
||||||
},
|
|
||||||
"packageManager": "pnpm@7.1.0",
|
|
||||||
"license": "MIT",
|
|
||||||
"main": "./dist/module.cjs",
|
|
||||||
"types": "./dist/types.d.ts",
|
|
||||||
"exports": {
|
|
||||||
"./package.json": "./package.json",
|
|
||||||
".": {
|
|
||||||
"import": "./dist/module.mjs",
|
|
||||||
"require": "./dist/module.cjs"
|
|
||||||
},
|
|
||||||
"./api": {
|
|
||||||
"import": "./dist/runtime/api.mjs",
|
|
||||||
"types": "./dist/runtime/api.d.ts"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"dist",
|
|
||||||
"*.d.ts"
|
|
||||||
],
|
|
||||||
"dependencies": {
|
|
||||||
"@nuxt/kit": "^3.0.0-rc.3",
|
|
||||||
"@trpc/client": "^9.23.3",
|
|
||||||
"@trpc/server": "^9.23.2",
|
|
||||||
"fs-extra": "^10.1.0",
|
|
||||||
"h3": "^0.7.8",
|
|
||||||
"pathe": "^0.3.0",
|
|
||||||
"ufo": "^0.8.4"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"postpublish": "rimraf ./package"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
7
package/playground/.gitignore
vendored
7
package/playground/.gitignore
vendored
@@ -1,7 +0,0 @@
|
|||||||
node_modules
|
|
||||||
*.log*
|
|
||||||
.nuxt
|
|
||||||
.nitro
|
|
||||||
.cache
|
|
||||||
.output
|
|
||||||
.env
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
# dev playground
|
|
||||||
|
|
||||||
## Setup
|
|
||||||
|
|
||||||
Make sure to install the dependencies:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm install
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development Server
|
|
||||||
|
|
||||||
Start the development server on http://localhost:3000
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm dev
|
|
||||||
```
|
|
||||||
|
|
||||||
## Production
|
|
||||||
|
|
||||||
Build the application for production:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm build
|
|
||||||
```
|
|
||||||
|
|
||||||
Locally preview production build:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm preview
|
|
||||||
```
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
const { data, error } = await useAsyncQuery(['getUser', { username: 'jcena' }], {
|
|
||||||
lazy: true,
|
|
||||||
})
|
|
||||||
|
|
||||||
const client = useClient()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div>
|
|
||||||
<div v-if="data">
|
|
||||||
{{ JSON.stringify(data, null, 2) }}
|
|
||||||
</div>
|
|
||||||
<div v-else-if="error">
|
|
||||||
asdx {{ JSON.stringify(error, null, 2) }}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
import { defineNuxtConfig } from 'nuxt'
|
|
||||||
import Module from '..'
|
|
||||||
|
|
||||||
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
|
||||||
export default defineNuxtConfig({
|
|
||||||
modules: [Module],
|
|
||||||
runtimeConfig: {
|
|
||||||
baseURL: 'http://localhost:3000',
|
|
||||||
},
|
|
||||||
typescript: {
|
|
||||||
strict: true,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "playground",
|
|
||||||
"private": true
|
|
||||||
}
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
// ~/server/trpc/index.ts
|
|
||||||
import { ZodError, z } from 'zod'
|
|
||||||
import * as trpc from '@trpc/server'
|
|
||||||
import type { inferAsyncReturnType } from '@trpc/server'
|
|
||||||
import type { CompatibilityEvent } from 'h3'
|
|
||||||
import type { ResponseMetaFnPayload } from 'trpc-nuxt/api'
|
|
||||||
// import superjson from 'superjson'
|
|
||||||
|
|
||||||
const fakeUsers = [
|
|
||||||
{ id: 1, username: 'jcena' },
|
|
||||||
{ id: 2, username: 'dbatista' },
|
|
||||||
{ id: 3, username: 'jbiden' },
|
|
||||||
]
|
|
||||||
|
|
||||||
export const router = trpc
|
|
||||||
.router<inferAsyncReturnType<typeof createContext>>()
|
|
||||||
.formatError(({ shape, error }) => {
|
|
||||||
return {
|
|
||||||
...shape,
|
|
||||||
data: {
|
|
||||||
...shape.data,
|
|
||||||
zodError:
|
|
||||||
error.code === 'BAD_REQUEST'
|
|
||||||
&& error.cause instanceof ZodError
|
|
||||||
? error.cause.flatten()
|
|
||||||
: null,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.query('getUsers', {
|
|
||||||
resolve() {
|
|
||||||
return fakeUsers
|
|
||||||
},
|
|
||||||
})
|
|
||||||
.query('getUser', {
|
|
||||||
// validate input with Zod
|
|
||||||
input: z.object({
|
|
||||||
username: z.string().min(5),
|
|
||||||
}),
|
|
||||||
resolve(req) {
|
|
||||||
return fakeUsers.find(i => i.username === req.input.username) ?? null
|
|
||||||
},
|
|
||||||
})
|
|
||||||
.mutation('createUser', {
|
|
||||||
input: z.object({ username: z.string().min(5) }),
|
|
||||||
resolve(req) {
|
|
||||||
const newUser = {
|
|
||||||
id: fakeUsers.length + 1,
|
|
||||||
username: req.input.username,
|
|
||||||
}
|
|
||||||
fakeUsers.push(newUser)
|
|
||||||
return newUser
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
export const createContext = (event: CompatibilityEvent) => {
|
|
||||||
event.res.setHeader('x-ssr', 1)
|
|
||||||
return {}
|
|
||||||
}
|
|
||||||
|
|
||||||
export const responseMeta = (opts: ResponseMetaFnPayload<any>) => {
|
|
||||||
// const nuxtApp = useNuxtApp()
|
|
||||||
// const client = useClient()
|
|
||||||
// console.log(opts)
|
|
||||||
|
|
||||||
// if (nuxtApp.nuxtState) {
|
|
||||||
// nuxtApp.nuxtState.trpc = client.runtime.transformer.serialize({
|
|
||||||
// ctx: opts.ctx,
|
|
||||||
// errors: opts.errors,
|
|
||||||
// })
|
|
||||||
// }
|
|
||||||
// else {
|
|
||||||
// nuxtApp.nuxtState = {
|
|
||||||
// trpc: client.runtime.transformer.serialize({
|
|
||||||
// ctx: opts.ctx,
|
|
||||||
// errors: opts.errors,
|
|
||||||
// }),
|
|
||||||
// }
|
|
||||||
// }
|
|
||||||
|
|
||||||
return {}
|
|
||||||
}
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
packages:
|
|
||||||
- playground/*
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
## 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 { CompatibilityEvent } from 'h3'
|
|
||||||
import { decodeAndVerifyJwtToken } from '~/somewhere/in/your/app/utils'
|
|
||||||
|
|
||||||
// The app's context - is generated for each incoming request
|
|
||||||
export async function createContext({ req }: CompatibilityEvent) {
|
|
||||||
// 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).
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
## 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).
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
## 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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
## 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,61 +0,0 @@
|
|||||||
import { fileURLToPath } from 'url'
|
|
||||||
import { dirname, join } from 'pathe'
|
|
||||||
|
|
||||||
import { addServerHandler, defineNuxtModule } from '@nuxt/kit'
|
|
||||||
import fs from 'fs-extra'
|
|
||||||
|
|
||||||
export interface ModuleOptions {
|
|
||||||
baseURL: string
|
|
||||||
trpcURL: string
|
|
||||||
}
|
|
||||||
|
|
||||||
export default defineNuxtModule<ModuleOptions>({
|
|
||||||
meta: {
|
|
||||||
name: 'trpc-nuxt',
|
|
||||||
configKey: 'trpc',
|
|
||||||
},
|
|
||||||
defaults: {
|
|
||||||
baseURL: 'http://localhost:3000',
|
|
||||||
trpcURL: '/api/trpc',
|
|
||||||
},
|
|
||||||
async setup(options, nuxt) {
|
|
||||||
const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
|
|
||||||
nuxt.options.build.transpile.push(runtimeDir)
|
|
||||||
|
|
||||||
const clientPath = join(nuxt.options.buildDir, 'trpc-client.ts')
|
|
||||||
const handlerPath = join(nuxt.options.buildDir, 'trpc-handler.ts')
|
|
||||||
|
|
||||||
addServerHandler({
|
|
||||||
route: `${options.trpcURL}/*`,
|
|
||||||
handler: handlerPath,
|
|
||||||
})
|
|
||||||
|
|
||||||
nuxt.hook('autoImports:extend', (imports) => {
|
|
||||||
imports.push(
|
|
||||||
{ name: 'useClient', from: clientPath },
|
|
||||||
{ name: 'useAsyncQuery', from: join(runtimeDir, 'client') },
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
await fs.ensureDir(dirname(clientPath))
|
|
||||||
|
|
||||||
await fs.writeFile(clientPath, `
|
|
||||||
import * as trpc from '@trpc/client'
|
|
||||||
import type { router } from '~/server/trpc'
|
|
||||||
|
|
||||||
const client = trpc.createTRPCClient<typeof router>({
|
|
||||||
url: '${options.baseURL}${options.trpcURL}',
|
|
||||||
})
|
|
||||||
|
|
||||||
export const useClient = () => client
|
|
||||||
`)
|
|
||||||
|
|
||||||
await fs.writeFile(handlerPath, `
|
|
||||||
import { createTRPCHandler } from 'trpc-nuxt/api'
|
|
||||||
import * as functions from '~/server/trpc'
|
|
||||||
|
|
||||||
export default createTRPCHandler(functions)
|
|
||||||
`)
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
@@ -1,92 +0,0 @@
|
|||||||
import { resolveHTTPResponse } from '@trpc/server'
|
|
||||||
import type {
|
|
||||||
AnyRouter,
|
|
||||||
ProcedureType,
|
|
||||||
ResponseMeta,
|
|
||||||
TRPCError,
|
|
||||||
inferRouterContext,
|
|
||||||
inferRouterError,
|
|
||||||
} from '@trpc/server'
|
|
||||||
import { createURL } from 'ufo'
|
|
||||||
import type { CompatibilityEvent } from 'h3'
|
|
||||||
import { defineEventHandler, isMethod, useBody } from 'h3'
|
|
||||||
import type { TRPCResponse } from '@trpc/server/dist/declarations/src/rpc'
|
|
||||||
|
|
||||||
type MaybePromise<T> = T | Promise<T>
|
|
||||||
|
|
||||||
export type CreateContextFn<TRouter extends AnyRouter> = (event: CompatibilityEvent) => MaybePromise<inferRouterContext<TRouter>>
|
|
||||||
|
|
||||||
export 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: CompatibilityEvent['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,
|
|
||||||
}: {
|
|
||||||
router: Router
|
|
||||||
createContext?: CreateContextFn<Router>
|
|
||||||
responseMeta?: ResponseMetaFn<Router>
|
|
||||||
onError?: OnErrorFn<Router>
|
|
||||||
}) {
|
|
||||||
const url = '/api/trpc'
|
|
||||||
|
|
||||||
return defineEventHandler(async (event) => {
|
|
||||||
const {
|
|
||||||
req,
|
|
||||||
res,
|
|
||||||
} = event
|
|
||||||
|
|
||||||
const $url = createURL(req.url)
|
|
||||||
|
|
||||||
event.context.hello = 'world'
|
|
||||||
|
|
||||||
const httpResponse = await resolveHTTPResponse({
|
|
||||||
router,
|
|
||||||
req: {
|
|
||||||
method: req.method,
|
|
||||||
headers: req.headers,
|
|
||||||
body: isMethod(event, 'GET') ? null : await useBody(event),
|
|
||||||
query: $url.searchParams,
|
|
||||||
},
|
|
||||||
path: $url.pathname.substring(url.length + 1),
|
|
||||||
createContext: async () => createContext?.(event),
|
|
||||||
responseMeta,
|
|
||||||
onError: (o) => {
|
|
||||||
onError?.({
|
|
||||||
...o,
|
|
||||||
req,
|
|
||||||
})
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
const { status, headers, body } = httpResponse
|
|
||||||
|
|
||||||
res.statusCode = status
|
|
||||||
|
|
||||||
Object.keys(headers).forEach((key) => {
|
|
||||||
res.setHeader(key, headers[key])
|
|
||||||
})
|
|
||||||
|
|
||||||
return body
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
import type {
|
|
||||||
AsyncData,
|
|
||||||
AsyncDataOptions,
|
|
||||||
KeyOfRes,
|
|
||||||
PickFrom,
|
|
||||||
_Transform,
|
|
||||||
} from 'nuxt/dist/app/composables/asyncData'
|
|
||||||
import type { ProcedureRecord, inferHandlerInput, inferProcedureInput, inferProcedureOutput } from '@trpc/server'
|
|
||||||
import type { TRPCClientErrorLike } from '@trpc/client'
|
|
||||||
import { objectHash } from 'ohash'
|
|
||||||
// @ts-expect-error: Resolved by Nuxt
|
|
||||||
import { useAsyncData, useState } from '#imports'
|
|
||||||
// @ts-expect-error: Resolved by Nuxt
|
|
||||||
import { useClient } from '#build/trpc-client'
|
|
||||||
// @ts-expect-error: Resolved by Nuxt
|
|
||||||
import type { router } from '~/server/trpc'
|
|
||||||
|
|
||||||
type AppRouter = typeof router
|
|
||||||
|
|
||||||
type inferProcedures<
|
|
||||||
TObj extends ProcedureRecord<any, any, any, any, any, any>,
|
|
||||||
> = {
|
|
||||||
[TPath in keyof TObj]: {
|
|
||||||
input: inferProcedureInput<TObj[TPath]>
|
|
||||||
output: inferProcedureOutput<TObj[TPath]>
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
type TQueries = AppRouter['_def']['queries']
|
|
||||||
type TError = TRPCClientErrorLike<AppRouter>
|
|
||||||
|
|
||||||
type TQueryValues = inferProcedures<AppRouter['_def']['queries']>
|
|
||||||
|
|
||||||
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 = useClient()
|
|
||||||
const key = `${pathAndInput[0]}-${objectHash(pathAndInput[1] ? JSON.stringify(pathAndInput[1]) : '')}`
|
|
||||||
const serverError = useState<TError | null>(`error-${key}`, () => null)
|
|
||||||
const { error, data, ...rest } = await useAsyncData(
|
|
||||||
key,
|
|
||||||
() => client.query(...pathAndInput),
|
|
||||||
options,
|
|
||||||
)
|
|
||||||
|
|
||||||
// @ts-expect-error: Resolved by Nuxt
|
|
||||||
if (process.server && error.value && !serverError.value)
|
|
||||||
serverError.value = error.value as any
|
|
||||||
|
|
||||||
if (data.value)
|
|
||||||
serverError.value = null
|
|
||||||
|
|
||||||
return {
|
|
||||||
...rest,
|
|
||||||
data,
|
|
||||||
error: serverError,
|
|
||||||
} as any
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "./playground/.nuxt/tsconfig.json"
|
|
||||||
}
|
|
||||||
@@ -1,18 +1,5 @@
|
|||||||
<script setup lang="ts">
|
|
||||||
const { data, error } = await useAsyncQuery(['getUser', { username: 'jcena' }], {
|
|
||||||
lazy: true,
|
|
||||||
})
|
|
||||||
|
|
||||||
const client = useClient()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div>
|
<div>
|
||||||
<div v-if="data">
|
<NuxtPage />
|
||||||
{{ JSON.stringify(data, null, 2) }}
|
|
||||||
</div>
|
|
||||||
<div v-else-if="error">
|
|
||||||
asdx {{ JSON.stringify(error, null, 2) }}
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import { defineNuxtConfig } from 'nuxt'
|
import { defineNuxtConfig } from 'nuxt'
|
||||||
import Module from '..'
|
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({
|
||||||
|
|||||||
19
playground/pages/cookie.vue
Normal file
19
playground/pages/cookie.vue
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
const counter = useCookie('counter')
|
||||||
|
counter.value = counter.value || Math.round(Math.random() * 1000)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div>
|
||||||
|
<h1> Counter: {{ counter || '-' }}</h1>
|
||||||
|
<button @click="counter = null">
|
||||||
|
reset
|
||||||
|
</button>
|
||||||
|
<button @click="counter--">
|
||||||
|
-
|
||||||
|
</button>
|
||||||
|
<button @click="counter++">
|
||||||
|
+
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
64
playground/pages/index.vue
Normal file
64
playground/pages/index.vue
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
const client = useClient()
|
||||||
|
const headers = useClientHeaders()
|
||||||
|
const { data: todos, pending, error, refresh } = await useAsyncQuery(['getTodos'])
|
||||||
|
|
||||||
|
const addHeader = () => {
|
||||||
|
// headers.value.cookie = 'counter=69'
|
||||||
|
console.log(headers.value)
|
||||||
|
}
|
||||||
|
|
||||||
|
const addTodo = async () => {
|
||||||
|
const title = Math.random().toString(36).slice(2, 7)
|
||||||
|
|
||||||
|
try {
|
||||||
|
const result = await client.mutation('addTodo', {
|
||||||
|
id: Date.now(),
|
||||||
|
userId: 69,
|
||||||
|
title,
|
||||||
|
completed: false,
|
||||||
|
})
|
||||||
|
console.log('Todo: ', result)
|
||||||
|
}
|
||||||
|
catch (e) {
|
||||||
|
console.log(e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div v-if="pending">
|
||||||
|
Loading...
|
||||||
|
</div>
|
||||||
|
<div v-else-if="error?.data?.code">
|
||||||
|
Error: {{ error.data.code }}
|
||||||
|
</div>
|
||||||
|
<div v-else-if="todos">
|
||||||
|
<ul>
|
||||||
|
<li v-for="t in todos.slice(0, 10)" :key="t.id">
|
||||||
|
<NuxtLink :class="{ completed: t.completed }" :to="`/todo/${t.id}`">
|
||||||
|
Title: {{ t.title }}
|
||||||
|
</NuxtLink>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<button @click="addTodo">
|
||||||
|
Add Todo
|
||||||
|
</button>
|
||||||
|
<button @click="() => refresh()">
|
||||||
|
Refresh
|
||||||
|
</button>
|
||||||
|
<button @click="addHeader">
|
||||||
|
Add header
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.completed {
|
||||||
|
text-decoration: line-through;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
18
playground/pages/todo/[id].vue
Normal file
18
playground/pages/todo/[id].vue
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
const route = useRoute()
|
||||||
|
const { data: todo, pending, error } = await useAsyncQuery(['getTodo', Number(route.params.id)])
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div v-if="pending">
|
||||||
|
Loading...
|
||||||
|
</div>
|
||||||
|
<div v-else-if="error?.data?.code">
|
||||||
|
{{ error.data.code }}
|
||||||
|
</div>
|
||||||
|
<div v-else>
|
||||||
|
ID: {{ todo.id }} <br>
|
||||||
|
Title: {{ todo.title }} <br>
|
||||||
|
Completed: {{ todo.completed }}
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
@@ -1,82 +1,53 @@
|
|||||||
// ~/server/trpc/index.ts
|
|
||||||
import { ZodError, z } from 'zod'
|
|
||||||
import * as trpc from '@trpc/server'
|
import * as trpc from '@trpc/server'
|
||||||
import type { inferAsyncReturnType } from '@trpc/server'
|
import type { inferAsyncReturnType } from '@trpc/server'
|
||||||
|
import { z } from 'zod'
|
||||||
import type { CompatibilityEvent } from 'h3'
|
import type { CompatibilityEvent } from 'h3'
|
||||||
import type { ResponseMetaFnPayload } from 'trpc-nuxt/api'
|
|
||||||
// import superjson from 'superjson'
|
|
||||||
|
|
||||||
const fakeUsers = [
|
const baseURL = 'https://jsonplaceholder.typicode.com'
|
||||||
{ id: 1, username: 'jcena' },
|
|
||||||
{ id: 2, username: 'dbatista' },
|
|
||||||
{ id: 3, username: 'jbiden' },
|
|
||||||
]
|
|
||||||
|
|
||||||
export const router = trpc
|
const TodoShape = z.object({
|
||||||
.router<inferAsyncReturnType<typeof createContext>>()
|
userId: z.number(),
|
||||||
.formatError(({ shape, error }) => {
|
id: z.number(),
|
||||||
return {
|
title: z.string(),
|
||||||
...shape,
|
completed: z.boolean(),
|
||||||
data: {
|
})
|
||||||
...shape.data,
|
|
||||||
zodError:
|
export type Todo = z.infer<typeof TodoShape>
|
||||||
error.code === 'BAD_REQUEST'
|
|
||||||
&& error.cause instanceof ZodError
|
export const router = trpc.router<Context>()
|
||||||
? error.cause.flatten()
|
.query('getTodos', {
|
||||||
: null,
|
async resolve() {
|
||||||
},
|
return await $fetch<Todo[]>(`${baseURL}/todos`)
|
||||||
}
|
|
||||||
})
|
|
||||||
.query('getUsers', {
|
|
||||||
resolve() {
|
|
||||||
return fakeUsers
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
.query('getUser', {
|
.query('getTodo', {
|
||||||
// validate input with Zod
|
input: z.number(),
|
||||||
input: z.object({
|
async resolve(req) {
|
||||||
username: z.string().min(5),
|
return await $fetch<Todo>(`${baseURL}/todos/${req.input}`)
|
||||||
}),
|
|
||||||
resolve(req) {
|
|
||||||
return fakeUsers.find(i => i.username === req.input.username) ?? null
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
.mutation('createUser', {
|
.mutation('addTodo', {
|
||||||
input: z.object({ username: z.string().min(5) }),
|
input: TodoShape,
|
||||||
resolve(req) {
|
async resolve(req) {
|
||||||
const newUser = {
|
console.log(req.input)
|
||||||
id: fakeUsers.length + 1,
|
return await $fetch<Todo>(`${baseURL}/todos`, {
|
||||||
username: req.input.username,
|
method: 'POST',
|
||||||
}
|
body: req.input,
|
||||||
fakeUsers.push(newUser)
|
})
|
||||||
return newUser
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
export const createContext = (event: CompatibilityEvent) => {
|
export async function createContext(event: CompatibilityEvent) {
|
||||||
event.res.setHeader('x-ssr', 1)
|
// Create your context based on the request object
|
||||||
return {}
|
// Will be available as `ctx` in all your resolvers
|
||||||
|
|
||||||
|
// This is just an example of something you'd might want to do in your ctx fn
|
||||||
|
// const x = useCookies(event)
|
||||||
|
console.log(event.req.headers)
|
||||||
|
|
||||||
|
return {
|
||||||
|
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export const responseMeta = (opts: ResponseMetaFnPayload<any>) => {
|
type Context = inferAsyncReturnType<typeof createContext>
|
||||||
// const nuxtApp = useNuxtApp()
|
|
||||||
// const client = useClient()
|
|
||||||
// console.log(opts)
|
|
||||||
|
|
||||||
// if (nuxtApp.nuxtState) {
|
|
||||||
// nuxtApp.nuxtState.trpc = client.runtime.transformer.serialize({
|
|
||||||
// ctx: opts.ctx,
|
|
||||||
// errors: opts.errors,
|
|
||||||
// })
|
|
||||||
// }
|
|
||||||
// else {
|
|
||||||
// nuxtApp.nuxtState = {
|
|
||||||
// trpc: client.runtime.transformer.serialize({
|
|
||||||
// ctx: opts.ctx,
|
|
||||||
// errors: opts.errors,
|
|
||||||
// }),
|
|
||||||
// }
|
|
||||||
// }
|
|
||||||
|
|
||||||
return {}
|
|
||||||
}
|
|
||||||
|
|||||||
2132
pnpm-lock.yaml
generated
2132
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
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>
|
||||||
|
```
|
||||||
@@ -1,12 +1,14 @@
|
|||||||
import { fileURLToPath } from 'url'
|
import { fileURLToPath } from 'url'
|
||||||
import { dirname, join } from 'pathe'
|
import { join, resolve } from 'pathe'
|
||||||
|
import { defu } from 'defu'
|
||||||
|
// @ts-expect-error: No types
|
||||||
|
import dedent from 'dedent'
|
||||||
|
|
||||||
import { addServerHandler, defineNuxtModule } from '@nuxt/kit'
|
import { addAutoImport, addPlugin, addServerHandler, addTemplate, defineNuxtModule } from '@nuxt/kit'
|
||||||
import fs from 'fs-extra'
|
|
||||||
|
|
||||||
export interface ModuleOptions {
|
export interface ModuleOptions {
|
||||||
baseURL: string
|
baseURL: string
|
||||||
trpcURL: string
|
endpoint: string
|
||||||
}
|
}
|
||||||
|
|
||||||
export default defineNuxtModule<ModuleOptions>({
|
export default defineNuxtModule<ModuleOptions>({
|
||||||
@@ -16,46 +18,53 @@ export default defineNuxtModule<ModuleOptions>({
|
|||||||
},
|
},
|
||||||
defaults: {
|
defaults: {
|
||||||
baseURL: 'http://localhost:3000',
|
baseURL: 'http://localhost:3000',
|
||||||
trpcURL: '/api/trpc',
|
endpoint: '/trpc',
|
||||||
},
|
},
|
||||||
async setup(options, nuxt) {
|
async setup(options, nuxt) {
|
||||||
const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
|
const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
|
||||||
nuxt.options.build.transpile.push(runtimeDir)
|
nuxt.options.build.transpile.push(runtimeDir, '#build/trpc-handler')
|
||||||
|
|
||||||
const clientPath = join(nuxt.options.buildDir, 'trpc-client.ts')
|
|
||||||
const handlerPath = join(nuxt.options.buildDir, 'trpc-handler.ts')
|
const handlerPath = join(nuxt.options.buildDir, 'trpc-handler.ts')
|
||||||
|
const trpcOptionsPath = join(nuxt.options.srcDir, 'server/trpc')
|
||||||
|
|
||||||
|
// Add vueuse
|
||||||
|
nuxt.options.modules.push('@vueuse/nuxt')
|
||||||
|
|
||||||
|
// Final resolved configuration
|
||||||
|
const finalConfig = nuxt.options.runtimeConfig.public.trpc = defu(nuxt.options.runtimeConfig.public.trpc, {
|
||||||
|
baseURL: options.baseURL,
|
||||||
|
endpoint: options.endpoint,
|
||||||
|
})
|
||||||
|
|
||||||
|
addAutoImport([
|
||||||
|
{ name: 'useClient', from: join(runtimeDir, 'client') },
|
||||||
|
{ name: 'useAsyncQuery', from: join(runtimeDir, 'client') },
|
||||||
|
{ name: 'useClientHeaders', from: join(runtimeDir, 'client') },
|
||||||
|
{ name: 'getQueryKey', from: join(runtimeDir, 'client') },
|
||||||
|
])
|
||||||
|
|
||||||
addServerHandler({
|
addServerHandler({
|
||||||
route: `${options.trpcURL}/*`,
|
route: `${finalConfig.endpoint}/*`,
|
||||||
handler: handlerPath,
|
handler: handlerPath,
|
||||||
})
|
})
|
||||||
|
|
||||||
nuxt.hook('autoImports:extend', (imports) => {
|
addPlugin(resolve(runtimeDir, 'plugin'))
|
||||||
imports.push(
|
|
||||||
{ name: 'useClient', from: clientPath },
|
|
||||||
{ name: 'useAsyncQuery', from: join(runtimeDir, 'client') },
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
await fs.ensureDir(dirname(clientPath))
|
addTemplate({
|
||||||
|
filename: 'trpc-handler.ts',
|
||||||
await fs.writeFile(clientPath, `
|
write: true,
|
||||||
import * as trpc from '@trpc/client'
|
getContents() {
|
||||||
import type { router } from '~/server/trpc'
|
return dedent`
|
||||||
|
import { createTRPCHandler } from 'trpc-nuxt/api'
|
||||||
const client = trpc.createTRPCClient<typeof router>({
|
import * as functions from '${trpcOptionsPath}'
|
||||||
url: '${options.baseURL}${options.trpcURL}',
|
|
||||||
})
|
|
||||||
|
|
||||||
export const useClient = () => client
|
export default createTRPCHandler({
|
||||||
`)
|
...functions,
|
||||||
|
endpoint: '${finalConfig.endpoint}'
|
||||||
await fs.writeFile(handlerPath, `
|
})
|
||||||
import { createTRPCHandler } from 'trpc-nuxt/api'
|
`
|
||||||
import * as functions from '~/server/trpc'
|
},
|
||||||
|
})
|
||||||
export default createTRPCHandler(functions)
|
|
||||||
`)
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -42,33 +42,31 @@ export function createTRPCHandler<Router extends AnyRouter>({
|
|||||||
createContext,
|
createContext,
|
||||||
responseMeta,
|
responseMeta,
|
||||||
onError,
|
onError,
|
||||||
|
endpoint,
|
||||||
}: {
|
}: {
|
||||||
router: Router
|
router: Router
|
||||||
createContext?: CreateContextFn<Router>
|
createContext?: CreateContextFn<Router>
|
||||||
responseMeta?: ResponseMetaFn<Router>
|
responseMeta?: ResponseMetaFn<Router>
|
||||||
onError?: OnErrorFn<Router>
|
onError?: OnErrorFn<Router>
|
||||||
|
endpoint: string
|
||||||
}) {
|
}) {
|
||||||
const url = '/api/trpc'
|
|
||||||
|
|
||||||
return defineEventHandler(async (event) => {
|
return defineEventHandler(async (event) => {
|
||||||
const {
|
const {
|
||||||
req,
|
req,
|
||||||
res,
|
res,
|
||||||
} = event
|
} = event
|
||||||
|
|
||||||
const $url = createURL(req.url)
|
const $url = createURL(req.url!)
|
||||||
|
|
||||||
event.context.hello = 'world'
|
|
||||||
|
|
||||||
const httpResponse = await resolveHTTPResponse({
|
const httpResponse = await resolveHTTPResponse({
|
||||||
router,
|
router,
|
||||||
req: {
|
req: {
|
||||||
method: req.method,
|
method: req.method!,
|
||||||
headers: req.headers,
|
headers: req.headers,
|
||||||
body: isMethod(event, 'GET') ? null : await useBody(event),
|
body: isMethod(event, 'GET') ? null : await useBody(event),
|
||||||
query: $url.searchParams,
|
query: $url.searchParams,
|
||||||
},
|
},
|
||||||
path: $url.pathname.substring(url.length + 1),
|
path: $url.pathname.substring(endpoint.length + 1),
|
||||||
createContext: async () => createContext?.(event),
|
createContext: async () => createContext?.(event),
|
||||||
responseMeta,
|
responseMeta,
|
||||||
onError: (o) => {
|
onError: (o) => {
|
||||||
@@ -83,8 +81,8 @@ export function createTRPCHandler<Router extends AnyRouter>({
|
|||||||
|
|
||||||
res.statusCode = status
|
res.statusCode = status
|
||||||
|
|
||||||
Object.keys(headers).forEach((key) => {
|
headers && Object.keys(headers).forEach((key) => {
|
||||||
res.setHeader(key, headers[key])
|
res.setHeader(key, headers[key]!)
|
||||||
})
|
})
|
||||||
|
|
||||||
return body
|
return body
|
||||||
|
|||||||
@@ -6,18 +6,18 @@ import type {
|
|||||||
_Transform,
|
_Transform,
|
||||||
} from 'nuxt/dist/app/composables/asyncData'
|
} from 'nuxt/dist/app/composables/asyncData'
|
||||||
import type { ProcedureRecord, inferHandlerInput, inferProcedureInput, inferProcedureOutput } from '@trpc/server'
|
import type { ProcedureRecord, inferHandlerInput, inferProcedureInput, inferProcedureOutput } from '@trpc/server'
|
||||||
import type { TRPCClientErrorLike } from '@trpc/client'
|
import type { TRPCClient, TRPCClientErrorLike } from '@trpc/client'
|
||||||
import { objectHash } from 'ohash'
|
import { objectHash } from 'ohash'
|
||||||
// @ts-expect-error: Resolved by Nuxt
|
import type { Ref } from 'vue'
|
||||||
import { useAsyncData, useState } from '#imports'
|
import { useStorage } from '@vueuse/core'
|
||||||
// @ts-expect-error: Resolved by Nuxt
|
import { useAsyncData, useNuxtApp, useState } from '#app'
|
||||||
import { useClient } from '#build/trpc-client'
|
|
||||||
// @ts-expect-error: Resolved by Nuxt
|
|
||||||
import type { router } from '~/server/trpc'
|
import type { router } from '~/server/trpc'
|
||||||
|
|
||||||
|
type MaybeRef<T> = T | Ref<T>
|
||||||
|
|
||||||
type AppRouter = typeof router
|
type AppRouter = typeof router
|
||||||
|
|
||||||
type inferProcedures<
|
export type inferProcedures<
|
||||||
TObj extends ProcedureRecord<any, any, any, any, any, any>,
|
TObj extends ProcedureRecord<any, any, any, any, any, any>,
|
||||||
> = {
|
> = {
|
||||||
[TPath in keyof TObj]: {
|
[TPath in keyof TObj]: {
|
||||||
@@ -26,10 +26,20 @@ type inferProcedures<
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
type TQueries = AppRouter['_def']['queries']
|
export type TQueries = AppRouter['_def']['queries']
|
||||||
type TError = TRPCClientErrorLike<AppRouter>
|
export type TError = TRPCClientErrorLike<AppRouter>
|
||||||
|
|
||||||
type TQueryValues = inferProcedures<AppRouter['_def']['queries']>
|
export type TQueryValues = inferProcedures<AppRouter['_def']['queries']>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calculates the key used for `useAsyncData` call
|
||||||
|
* @param pathAndInput
|
||||||
|
*/
|
||||||
|
export function getQueryKey<
|
||||||
|
TPath extends keyof TQueryValues & string,
|
||||||
|
>(pathAndInput: [path: TPath, ...args: inferHandlerInput<TQueries[TPath]>]) {
|
||||||
|
return `${pathAndInput[0]}-${objectHash(pathAndInput[1] ? JSON.stringify(pathAndInput[1]) : '')}`
|
||||||
|
}
|
||||||
|
|
||||||
export async function useAsyncQuery<
|
export async function useAsyncQuery<
|
||||||
TPath extends keyof TQueryValues & string,
|
TPath extends keyof TQueryValues & string,
|
||||||
@@ -40,16 +50,16 @@ export async function useAsyncQuery<
|
|||||||
pathAndInput: [path: TPath, ...args: inferHandlerInput<TQueries[TPath]>],
|
pathAndInput: [path: TPath, ...args: inferHandlerInput<TQueries[TPath]>],
|
||||||
options: AsyncDataOptions<TOutput, Transform, PickKeys> = {},
|
options: AsyncDataOptions<TOutput, Transform, PickKeys> = {},
|
||||||
): Promise<AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TError>> {
|
): Promise<AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TError>> {
|
||||||
const client = useClient()
|
const { $client } = useNuxtApp()
|
||||||
const key = `${pathAndInput[0]}-${objectHash(pathAndInput[1] ? JSON.stringify(pathAndInput[1]) : '')}`
|
const key = getQueryKey(pathAndInput)
|
||||||
const serverError = useState<TError | null>(`error-${key}`, () => null)
|
const serverError = useState<TError | null>(`error-${key}`, () => null)
|
||||||
const { error, data, ...rest } = await useAsyncData(
|
const { error, data, ...rest } = await useAsyncData(
|
||||||
key,
|
key,
|
||||||
() => client.query(...pathAndInput),
|
() => $client.query(...pathAndInput),
|
||||||
|
// @ts-expect-error: Internal
|
||||||
options,
|
options,
|
||||||
)
|
)
|
||||||
|
|
||||||
// @ts-expect-error: Resolved by Nuxt
|
|
||||||
if (process.server && error.value && !serverError.value)
|
if (process.server && error.value && !serverError.value)
|
||||||
serverError.value = error.value as any
|
serverError.value = error.value as any
|
||||||
|
|
||||||
@@ -62,3 +72,12 @@ export async function useAsyncQuery<
|
|||||||
error: serverError,
|
error: serverError,
|
||||||
} as any
|
} as any
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function useClient(): TRPCClient<AppRouter> {
|
||||||
|
const { $client } = useNuxtApp()
|
||||||
|
return $client
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useClientHeaders(initialValue: MaybeRef<Record<string, any>> = {}): Ref<Record<string, any>> {
|
||||||
|
return useStorage('trpc-nuxt-header', initialValue)
|
||||||
|
}
|
||||||
|
|||||||
30
src/runtime/plugin.ts
Normal file
30
src/runtime/plugin.ts
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
import * as trpc from '@trpc/client'
|
||||||
|
import { unref } from 'vue'
|
||||||
|
import { useClientHeaders } from './client'
|
||||||
|
import { defineNuxtPlugin, useRequestHeaders, useRuntimeConfig } from '#app'
|
||||||
|
import type { router } from '~/server/trpc'
|
||||||
|
|
||||||
|
declare type AppRouter = typeof router
|
||||||
|
|
||||||
|
export default defineNuxtPlugin((nuxtApp) => {
|
||||||
|
const config = useRuntimeConfig().public.trpc
|
||||||
|
const headers = useRequestHeaders()
|
||||||
|
const otherHeaders = useClientHeaders()
|
||||||
|
const client = trpc.createTRPCClient<AppRouter>({
|
||||||
|
url: `${config.baseURL}${config.endpoint}`,
|
||||||
|
headers: () => {
|
||||||
|
return {
|
||||||
|
...unref(otherHeaders),
|
||||||
|
...headers,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
nuxtApp.provide('client', client)
|
||||||
|
})
|
||||||
|
|
||||||
|
declare module '#app' {
|
||||||
|
interface NuxtApp {
|
||||||
|
$client: trpc.TRPCClient<AppRouter>
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user