mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-14 20:19:33 +01:00
Compare commits
165 Commits
v0.4.0-bet
...
v0.4.3
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2c2df9e2bd | ||
|
|
5cf1acfa7e | ||
|
|
f67f7fc5f4 | ||
|
|
e11edc59eb | ||
|
|
e522a59a4c | ||
|
|
1d7be4642d | ||
|
|
3552017e4f | ||
|
|
de690a7914 | ||
|
|
d2666650de | ||
|
|
e3d35c6b04 | ||
|
|
b569afde50 | ||
|
|
d4f3942fff | ||
|
|
68003e9c3e | ||
|
|
b27938f108 | ||
|
|
9e443ac559 | ||
|
|
8ba002407a | ||
|
|
f061b0531f | ||
|
|
f08b724df7 | ||
|
|
4085d5fe26 | ||
|
|
13713343ce | ||
|
|
d6f11bb301 | ||
|
|
c5c1f1cdba | ||
|
|
0681dd554d | ||
|
|
e7a76694af | ||
|
|
da75c18ebe | ||
|
|
6289575900 | ||
|
|
ac212672e4 | ||
|
|
b8e2a83e26 | ||
|
|
fd98b0d414 | ||
|
|
20ab235856 | ||
|
|
7205c356f8 | ||
|
|
e14827e0c7 | ||
|
|
eea6406d5a | ||
|
|
2d3409a25b | ||
|
|
7a71a6e128 | ||
|
|
d8e89297cd | ||
|
|
6768205318 | ||
|
|
c20a092a31 | ||
|
|
64df8fb7ad | ||
|
|
d5567e5826 | ||
|
|
6b898e836c | ||
|
|
fd38c4f983 | ||
|
|
48d4c6342f | ||
|
|
297c3d52f4 | ||
|
|
0f9653d1a4 | ||
|
|
85998101c7 | ||
|
|
d6cb770154 | ||
|
|
c222008524 | ||
|
|
9cd21eb300 | ||
|
|
b4e83dbb0b | ||
|
|
0fa63c86ba | ||
|
|
7371dc4c10 | ||
|
|
77ab5f0dc6 | ||
|
|
ba15d15d67 | ||
|
|
7999039088 | ||
|
|
dc15500074 | ||
|
|
99a83562aa | ||
|
|
e04344d508 | ||
|
|
0f9d26ab60 | ||
|
|
e6b4386bd8 | ||
|
|
813b9ff7d7 | ||
|
|
5dce1f4681 | ||
|
|
470ba96be2 | ||
|
|
4532add2a7 | ||
|
|
876ed1d8d2 | ||
|
|
611e22d205 | ||
|
|
c1857f1079 | ||
|
|
796fa43a83 | ||
|
|
e3ce0bcaae | ||
|
|
e916f17d60 | ||
|
|
0fdb9e0e17 | ||
|
|
5bd5756d26 | ||
|
|
67f95756ab | ||
|
|
1fc4d9d0d0 | ||
|
|
c11a5cfa8a | ||
|
|
92c9f6390c | ||
|
|
3a6c5b659b | ||
|
|
750783e860 | ||
|
|
d9c8f877d3 | ||
|
|
e359702c41 | ||
|
|
e9081d00ad | ||
|
|
83f98e34fa | ||
|
|
512a0ae7b1 | ||
|
|
c89f8747ea | ||
|
|
3e8a2de6e5 | ||
|
|
5d98873cc3 | ||
|
|
a8e5538b05 | ||
|
|
24ecb41429 | ||
|
|
e8bf427d2b | ||
|
|
347d49482f | ||
|
|
2f7a1276ad | ||
|
|
f6db0c78cd | ||
|
|
d6012eb5c8 | ||
|
|
c1ab3ecf77 | ||
|
|
0e8f6cf9f6 | ||
|
|
0f5c09c7e0 | ||
|
|
5080e9a4a7 | ||
|
|
7490dbd090 | ||
|
|
1dc0ca7808 | ||
|
|
ffb692a168 | ||
|
|
d3203f0536 | ||
|
|
83e2b2810d | ||
|
|
2b4fff9faa | ||
|
|
752fe721a2 | ||
|
|
808cac4756 | ||
|
|
0c44f73c9f | ||
|
|
182875a781 | ||
|
|
0298f836b8 | ||
|
|
ea50430945 | ||
|
|
0e240663ca | ||
|
|
bb5e02383e | ||
|
|
c01dddea02 | ||
|
|
f92aec5b91 | ||
|
|
b6f92d954c | ||
|
|
9108dcbb1d | ||
|
|
07f415640f | ||
|
|
d5d211d2a8 | ||
|
|
3bfd3585b3 | ||
|
|
8ba8d79114 | ||
|
|
b7f72eac0a | ||
|
|
4c8a6d7b35 | ||
|
|
76619ac541 | ||
|
|
d5384cef02 | ||
|
|
fb3a0a834e | ||
|
|
b58d662edc | ||
|
|
5d560867bb | ||
|
|
ac7fbf3998 | ||
|
|
45fbab4c5f | ||
|
|
05ad1f96f6 | ||
|
|
41e6117113 | ||
|
|
81c7608fb0 | ||
|
|
a614bc588e | ||
|
|
3b0609e395 | ||
|
|
0819c21b94 | ||
|
|
deea70b743 | ||
|
|
0ee322c8a2 | ||
|
|
fc225ced0a | ||
|
|
b1d00c1f88 | ||
|
|
e0a6bb3576 | ||
|
|
fcd6cb1546 | ||
|
|
471ac30040 | ||
|
|
a7013db712 | ||
|
|
bdcff360f0 | ||
|
|
1490790edc | ||
|
|
4c5e6812b1 | ||
|
|
23d2954aae | ||
|
|
3c39746fa2 | ||
|
|
5fb7a9d444 | ||
|
|
a2275567e8 | ||
|
|
c040db4308 | ||
|
|
72755315a5 | ||
|
|
3d49810641 | ||
|
|
ebb6637238 | ||
|
|
0c83ade918 | ||
|
|
97d9b3ddf8 | ||
|
|
eaa61f3700 | ||
|
|
a5a9f430d5 | ||
|
|
94f59c396a | ||
|
|
fe4c10ae25 | ||
|
|
7a97127353 | ||
|
|
0c4a43ec19 | ||
|
|
da6d738406 | ||
|
|
70c0b35c48 | ||
|
|
da52b350ba | ||
|
|
b45c613ce7 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -49,3 +49,5 @@ coverage
|
||||
Network Trash Folder
|
||||
Temporary Items
|
||||
.apdisk
|
||||
|
||||
.vercel
|
||||
|
||||
26
README.md
Normal file
26
README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# tRPC-Nuxt
|
||||
|
||||
End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
||||
|
||||
<p align="center">
|
||||
<figure>
|
||||
<img src="https://i.imgur.com/3AZlBZH.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>
|
||||
|
||||
Docs: https://trpc-nuxt.vercel.app
|
||||
|
||||
For version 3 of this module (tRPC v9, auto-imports, auto handlers), [go here](https://github.com/wobsoriano/trpc-nuxt/tree/v3).
|
||||
|
||||
## Recommended IDE Setup
|
||||
|
||||
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
.vercel
|
||||
1
docs/README.md
Normal file
1
docs/README.md
Normal file
@@ -0,0 +1 @@
|
||||
docs
|
||||
25
docs/app.config.ts
Normal file
25
docs/app.config.ts
Normal file
@@ -0,0 +1,25 @@
|
||||
export default defineAppConfig({
|
||||
docus: {
|
||||
title: 'tRPC Nuxt',
|
||||
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'
|
||||
},
|
||||
aside: {
|
||||
level: 1
|
||||
},
|
||||
footer: {
|
||||
credits: true,
|
||||
icons: [
|
||||
{
|
||||
label: 'NuxtJS',
|
||||
href: 'https://nuxtjs.org',
|
||||
component: 'IconNuxt'
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
})
|
||||
38
docs/content/1.get-started/1.installation.md
Normal file
38
docs/content/1.get-started/1.installation.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: Installation
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
::code-group
|
||||
|
||||
```bash [pnpm]
|
||||
pnpm add @trpc/server@next @trpc/client@next trpc-nuxt zod
|
||||
```
|
||||
|
||||
```bash [npm]
|
||||
npm install @trpc/server@next @trpc/client@next trpc-nuxt zod
|
||||
```
|
||||
|
||||
```bash [yarn]
|
||||
yarn add @trpc/server@next @trpc/client@next trpc-nuxt zod
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
#### 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.
|
||||
130
docs/content/1.get-started/2.usage.md
Normal file
130
docs/content/1.get-started/2.usage.md
Normal file
@@ -0,0 +1,130 @@
|
||||
---
|
||||
title: Usage
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Usage
|
||||
|
||||
## Recommended file structure
|
||||
|
||||
Recommended but not enforced file structure. This is what you get when starting from [the examples](../main/example-apps.md).
|
||||
|
||||
```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 as a 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]
|
||||
import { initTRPC } from '@trpc/server'
|
||||
|
||||
// Avoid exporting the entire t-object since it's not very
|
||||
// descriptive and can be confusing to newcomers used to t
|
||||
// meaning translation in i18n libraries.
|
||||
const t = initTRPC.create()
|
||||
|
||||
// Base router and procedure helpers
|
||||
export const router = t.router
|
||||
export const publicProcedure = t.procedure
|
||||
```
|
||||
|
||||
```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'
|
||||
|
||||
// export API handler
|
||||
export default createNuxtApiHandler({
|
||||
router: appRouter,
|
||||
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 { httpBatchLink, createTRPCProxyClient } from '@trpc/client'
|
||||
import type { AppRouter } from '@/server/trpc/routers'
|
||||
|
||||
export default defineNuxtPlugin(() => {
|
||||
const client = createTRPCProxyClient<AppRouter>({
|
||||
links: [
|
||||
httpBatchLink({
|
||||
/**
|
||||
* If you want to use SSR, you need to use the server's full URL
|
||||
* @link https://trpc.io/docs/ssr
|
||||
**/
|
||||
url: 'http://localhost:3000/api/trpc',
|
||||
}),
|
||||
],
|
||||
})
|
||||
|
||||
return {
|
||||
provide: {
|
||||
client,
|
||||
},
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## 3. Make API requests
|
||||
|
||||
```vue [pages/index.vue]
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
|
||||
const data = await $client.hello.query({ text: 'client' })
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<p>{{data?.greeting }}</p>
|
||||
</template>
|
||||
```
|
||||
40
docs/content/1.get-started/3.tips/1.composables.md
Normal file
40
docs/content/1.get-started/3.tips/1.composables.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## 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.
|
||||
40
docs/content/1.get-started/3.tips/2.headers.md
Normal file
40
docs/content/1.get-started/3.tips/2.headers.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Headers
|
||||
---
|
||||
|
||||
# Headers
|
||||
|
||||
We can use the built-in [useRequestHeaders](https://v3.nuxtjs.org/api/composables/use-request-headers/) to set outgoing request headers:
|
||||
|
||||
```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 {}
|
||||
}
|
||||
```
|
||||
103
docs/content/1.get-started/3.tips/3.authorization.md
Normal file
103
docs/content/1.get-started/3.tips/3.authorization.md
Normal file
@@ -0,0 +1,103 @@
|
||||
---
|
||||
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.
|
||||
84
docs/content/1.get-started/3.tips/4.server-side-calls.md
Normal file
84
docs/content/1.get-started/3.tips/4.server-side-calls.md
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
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 { router } from '@/server/trpc/trpc'
|
||||
|
||||
export default eventHandler(async (event) => {
|
||||
const { name } = getQuery(event)
|
||||
const caller = router.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 { router } from '@/server/trpc/trpc'
|
||||
|
||||
export default eventHandler(async (event) => {
|
||||
const body = await getBody(event)
|
||||
const caller = router.createCaller({})
|
||||
|
||||
const post = await caller.post.add(body.post)
|
||||
|
||||
return {
|
||||
post
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
::
|
||||
24
docs/content/1.get-started/3.tips/5.aborting-procedures.md
Normal file
24
docs/content/1.get-started/3.tips/5.aborting-procedures.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
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
|
||||
})
|
||||
})
|
||||
}
|
||||
```
|
||||
4
docs/content/1.get-started/index.md
Normal file
4
docs/content/1.get-started/index.md
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
navigation: false
|
||||
redirect: /get-started/installation
|
||||
---
|
||||
6
docs/content/2.examples/1.basic.md
Normal file
6
docs/content/2.examples/1.basic.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Basic
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Basic Example
|
||||
6
docs/content/2.examples/2.multiple-routers.md
Normal file
6
docs/content/2.examples/2.multiple-routers.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Multiple Routers
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Multi Routers
|
||||
31
docs/content/index.md
Normal file
31
docs/content/index.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
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
|
||||
::
|
||||
::
|
||||
22
docs/nuxt.config.ts
Normal file
22
docs/nuxt.config.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
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'
|
||||
}
|
||||
})
|
||||
17
docs/package.json
Normal file
17
docs/package.json
Normal file
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"name": "docs",
|
||||
"description": "Docs for TRPC-Nuxt",
|
||||
"scripts": {
|
||||
"dev": "nuxi dev",
|
||||
"build": "nuxi build",
|
||||
"generate": "nuxi build",
|
||||
"preview": "nuxi preview"
|
||||
},
|
||||
"dependencies": {
|
||||
"nuxt": "^3.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nuxt-themes/docus": "^0.3.1",
|
||||
"@nuxtlabs/github-module": "^1.5.3"
|
||||
}
|
||||
}
|
||||
18
docs/tokens.config.ts
Normal file
18
docs/tokens.config.ts
Normal file
@@ -0,0 +1,18 @@
|
||||
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'
|
||||
}
|
||||
}
|
||||
})
|
||||
3
docs/tsconfig.json
Normal file
3
docs/tsconfig.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "./.nuxt/tsconfig.json"
|
||||
}
|
||||
66
package.json
66
package.json
@@ -1,20 +1,68 @@
|
||||
{
|
||||
"name": "trpc-nuxt-workspace",
|
||||
"packageManager": "pnpm@7.5.0",
|
||||
"name": "trpc-nuxt",
|
||||
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
||||
"type": "module",
|
||||
"version": "0.4.3",
|
||||
"license": "MIT",
|
||||
"sideEffects": false,
|
||||
"exports": {
|
||||
".": {
|
||||
"require": "./dist/index.cjs",
|
||||
"import": "./dist/index.mjs"
|
||||
}
|
||||
},
|
||||
"main": "./dist/index.mjs",
|
||||
"module": "./dist/index.mjs",
|
||||
"types": "./dist/index.d.ts",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"dev": "concurrently \"pnpm build -- --watch\" \"pnpm --filter playground dev\"",
|
||||
"dev:prepare": "pnpm build && nuxt prepare playground",
|
||||
"prepublishOnly": "pnpm build",
|
||||
"build": "tsup",
|
||||
"lint": "eslint .",
|
||||
"lint:fix": "eslint . --fix"
|
||||
"lint:fix": "eslint . --fix",
|
||||
"release": "bumpp && npm publish"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@trpc/client": "^10.0.0",
|
||||
"@trpc/server": "^10.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"h3": "^1.0.1",
|
||||
"nanoid": "^4.0.0",
|
||||
"ohash": "^1.0.0",
|
||||
"ufo": "^1.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@antfu/eslint-config": "^0.27.0",
|
||||
"@antfu/ni": "^0.18.3",
|
||||
"@nuxtjs/eslint-config-typescript": "^11.0.0",
|
||||
"@trpc/client": "^10.1.0",
|
||||
"@trpc/server": "^10.1.0",
|
||||
"bumpp": "^8.2.1",
|
||||
"concurrently": "^7.5.0",
|
||||
"eslint": "^8.25.0",
|
||||
"pnpm": "^7.5.0"
|
||||
"tsup": "6.4.0",
|
||||
"typescript": "^4.7.4"
|
||||
},
|
||||
"eslintConfig": {
|
||||
"extends": "@antfu",
|
||||
"extends": [
|
||||
"@nuxtjs/eslint-config-typescript"
|
||||
],
|
||||
"rules": {
|
||||
"no-console": "warn"
|
||||
"@typescript-eslint/no-unused-vars": [
|
||||
"off"
|
||||
],
|
||||
"vue/multi-word-component-names": "off",
|
||||
"vue/no-multiple-template-root": "off"
|
||||
}
|
||||
}
|
||||
},
|
||||
"eslintIgnore": [
|
||||
"*.json",
|
||||
"node_modules",
|
||||
"*.md",
|
||||
"dist",
|
||||
".output"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,50 +0,0 @@
|
||||
import { httpBatchLink, loggerLink } from '@trpc/client'
|
||||
import { createTRPCNuxtProxyClient } from 'trpc-nuxt/client'
|
||||
import superjson from 'superjson'
|
||||
import type { AppRouter } from '~~/server/trpc/routers'
|
||||
|
||||
export default defineNuxtPlugin((nuxtApp) => {
|
||||
const client = createTRPCNuxtProxyClient<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({
|
||||
url: 'http://localhost:3000/api/trpc',
|
||||
/**
|
||||
* Set custom request headers on every request from tRPC
|
||||
* @link https://trpc.io/docs/ssr
|
||||
*/
|
||||
headers() {
|
||||
if (nuxtApp.ssrContext?.event?.req) {
|
||||
// To use SSR properly, you need to forward the client's headers to the server
|
||||
// This is so you can pass through things like cookies when we're server-side rendering
|
||||
|
||||
// If you're using Node 18, omit the "connection" header
|
||||
const {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||
connection: _connection,
|
||||
...headers
|
||||
} = nuxtApp.ssrContext.event.req.headers
|
||||
return {
|
||||
...headers,
|
||||
// Optional: inform server that it's an SSR request
|
||||
'x-ssr': '1',
|
||||
}
|
||||
}
|
||||
return {}
|
||||
},
|
||||
}),
|
||||
],
|
||||
})
|
||||
|
||||
return {
|
||||
provide: {
|
||||
client,
|
||||
},
|
||||
}
|
||||
})
|
||||
@@ -1,15 +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.
|
||||
|
||||
Learn more about tRPC.io [here](https://trpc.io/docs/v10).
|
||||
|
||||
## Recommended IDE Setup
|
||||
|
||||
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
1
packages/trpc-nuxt/client.d.ts
vendored
1
packages/trpc-nuxt/client.d.ts
vendored
@@ -1 +0,0 @@
|
||||
export * from './dist/client/index'
|
||||
@@ -1,57 +0,0 @@
|
||||
{
|
||||
"name": "trpc-nuxt",
|
||||
"version": "0.4.0-beta.2",
|
||||
"packageManager": "pnpm@7.5.0",
|
||||
"license": "MIT",
|
||||
"sideEffects": false,
|
||||
"exports": {
|
||||
"./package.json": "./package.json",
|
||||
".": {
|
||||
"require": "./dist/index.js",
|
||||
"import": "./dist/index.mjs"
|
||||
},
|
||||
"./client": {
|
||||
"require": "./dist/client.js",
|
||||
"import": "./dist/client.mjs"
|
||||
}
|
||||
},
|
||||
"main": "./dist/index.js",
|
||||
"module": "./dist/index.mjs",
|
||||
"types": "./dist/index.d.ts",
|
||||
"files": [
|
||||
"dist",
|
||||
"client.d.ts"
|
||||
],
|
||||
"scripts": {
|
||||
"prepublishOnly": "nr build",
|
||||
"build": "tsup",
|
||||
"lint": "eslint .",
|
||||
"lint:fix": "eslint . --fix",
|
||||
"release": "bumpp --commit --push --tag && npm publish"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@trpc/client": "^10.0.0-proxy-beta.21",
|
||||
"@trpc/server": "^10.0.0-proxy-beta.21",
|
||||
"nuxt": "^3.0.0-rc.12"
|
||||
},
|
||||
"dependencies": {
|
||||
"h3": "^0.8.5",
|
||||
"ohash": "^0.1.5",
|
||||
"ohmyfetch": "^0.4.20",
|
||||
"ufo": "^0.8.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@trpc/client": "10.0.0-rc.1",
|
||||
"@trpc/server": "10.0.0-rc.1",
|
||||
"bumpp": "^8.2.1",
|
||||
"nuxt": "3.0.0-rc.12",
|
||||
"tsup": "6.0.1",
|
||||
"typescript": "^4.7.4"
|
||||
},
|
||||
"eslintConfig": {
|
||||
"extends": "@antfu",
|
||||
"rules": {
|
||||
"no-console": "warn"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,95 +0,0 @@
|
||||
import type { CreateTRPCClientOptions, inferRouterProxyClient } from '@trpc/client'
|
||||
import { createTRPCProxyClient } from '@trpc/client'
|
||||
import { FetchError } from 'ohmyfetch'
|
||||
import type {
|
||||
AnyRouter,
|
||||
} from '@trpc/server'
|
||||
import { createFlatProxy, createRecursiveProxy } from '@trpc/server/shared'
|
||||
import { hash } from 'ohash'
|
||||
import type { DecoratedProcedureRecord } from './types'
|
||||
|
||||
/**
|
||||
* Calculates the key used for `useAsyncData` call
|
||||
*/
|
||||
export function getQueryKey(
|
||||
path: string,
|
||||
input: unknown,
|
||||
): string {
|
||||
return input === undefined ? path : `${path}-${hash(input || '')}`
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
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 `.mutate` or `.query()`
|
||||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
||||
const lastArg = pathCopy.pop()!
|
||||
|
||||
const path = pathCopy.join('.')
|
||||
|
||||
const [input, asyncDataOptions] = args
|
||||
|
||||
const queryKey = getQueryKey(path, input)
|
||||
|
||||
if (lastArg === 'mutate') {
|
||||
return useAsyncDataWithError(queryKey, () => (client as any)[path][lastArg](input), {
|
||||
...asyncDataOptions as Record<string, any>,
|
||||
immediate: false,
|
||||
})
|
||||
}
|
||||
|
||||
return useAsyncDataWithError(queryKey, () => (client as any)[path][lastArg](input), asyncDataOptions)
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Custom useAsyncData to add server error to client
|
||||
*/
|
||||
async function useAsyncDataWithError(queryKey: string, cb: any, asyncDataOptions: any) {
|
||||
// @ts-ignore: nuxt internal
|
||||
const serverError = useState(`error-${queryKey}`, () => null)
|
||||
// @ts-ignore: nuxt internal
|
||||
const { error, data, ...rest } = await useAsyncData(queryKey, cb, asyncDataOptions)
|
||||
|
||||
if (error.value && !serverError.value)
|
||||
serverError.value = error.value as any
|
||||
|
||||
if (data.value)
|
||||
serverError.value = null
|
||||
|
||||
return {
|
||||
...rest,
|
||||
data,
|
||||
error: serverError,
|
||||
}
|
||||
}
|
||||
|
||||
export function createTRPCNuxtProxyClient<TRouter extends AnyRouter>(opts: CreateTRPCClientOptions<TRouter>) {
|
||||
const client = createTRPCProxyClient(opts)
|
||||
|
||||
const decoratedClient = createFlatProxy((key) => {
|
||||
return createNuxtProxyDecoration(key, client)
|
||||
}) as DecoratedProcedureRecord<TRouter['_def']['record']>
|
||||
|
||||
return decoratedClient
|
||||
}
|
||||
|
||||
export function customFetch(input: RequestInfo | URL, options?: RequestInit) {
|
||||
return 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),
|
||||
}))
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
import type { TRPCClientErrorLike } from '@trpc/client'
|
||||
import type {
|
||||
AnyMutationProcedure,
|
||||
AnyProcedure,
|
||||
AnyQueryProcedure,
|
||||
AnyRouter,
|
||||
ProcedureRouterRecord,
|
||||
inferProcedureInput,
|
||||
inferProcedureOutput,
|
||||
} from '@trpc/server'
|
||||
import type {
|
||||
AsyncData,
|
||||
AsyncDataOptions,
|
||||
KeyOfRes,
|
||||
PickFrom,
|
||||
_Transform,
|
||||
} from 'nuxt/dist/app/composables/asyncData'
|
||||
|
||||
// Inspired by trpc/react-query client types
|
||||
// https://github.com/trpc/trpc/blob/next/packages/react-query/src/createTRPCReact.tsx
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
export type DecorateProcedure<
|
||||
TProcedure extends AnyProcedure,
|
||||
TPath extends string,
|
||||
> = TProcedure extends AnyQueryProcedure
|
||||
? {
|
||||
query: <
|
||||
TData = inferProcedureOutput<TProcedure>,
|
||||
Transform extends _Transform<TData> = _Transform<TData, TData>,
|
||||
PickKeys extends KeyOfRes<Transform> = KeyOfRes<Transform>,
|
||||
>(
|
||||
input: inferProcedureInput<TProcedure>,
|
||||
opts?: AsyncDataOptions<TData, Transform, PickKeys>,
|
||||
) => AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TRPCClientErrorLike<TProcedure>>
|
||||
} : TProcedure extends AnyMutationProcedure ? {
|
||||
mutate: <
|
||||
TData = inferProcedureOutput<TProcedure>,
|
||||
Transform extends _Transform<TData> = _Transform<TData, TData>,
|
||||
PickKeys extends KeyOfRes<Transform> = KeyOfRes<Transform>,
|
||||
>(
|
||||
input: inferProcedureInput<TProcedure>,
|
||||
opts?: AsyncDataOptions<TData, Transform, PickKeys>,
|
||||
) => AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TRPCClientErrorLike<TProcedure>>
|
||||
} : never
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
export type DecoratedProcedureRecord<
|
||||
TProcedures extends ProcedureRouterRecord,
|
||||
TPath extends string = '',
|
||||
> = {
|
||||
[TKey in keyof TProcedures]: TProcedures[TKey] extends AnyRouter
|
||||
? DecoratedProcedureRecord<
|
||||
TProcedures[TKey]['_def']['record'],
|
||||
`${TPath}${TKey & string}.`
|
||||
>
|
||||
: TProcedures[TKey] extends AnyProcedure
|
||||
? DecorateProcedure<TProcedures[TKey], `${TPath}${TKey & string}`>
|
||||
: never;
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
export * from './server'
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json"
|
||||
}
|
||||
@@ -1,10 +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'],
|
||||
dts: true,
|
||||
})
|
||||
@@ -1,9 +1,3 @@
|
||||
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
||||
export default defineNuxtConfig({
|
||||
runtimeConfig: {
|
||||
baseURL: '',
|
||||
},
|
||||
typescript: {
|
||||
strict: true,
|
||||
},
|
||||
})
|
||||
@@ -9,11 +9,13 @@
|
||||
"postinstall": "nuxt prepare"
|
||||
},
|
||||
"dependencies": {
|
||||
"@trpc/client": "^10.1.0",
|
||||
"@trpc/server": "^10.1.0",
|
||||
"superjson": "^1.11.0",
|
||||
"trpc-nuxt": "workspace:*",
|
||||
"zod": "^3.19.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"nuxt": "3.0.0-rc.12"
|
||||
"nuxt": "^3.0.0"
|
||||
}
|
||||
}
|
||||
@@ -1,31 +1,30 @@
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
// const headers = useClientHeaders()
|
||||
import { TRPCClientError } from '@trpc/client';
|
||||
import type { inferRouterOutputs } from '@trpc/server';
|
||||
import type { AppRouter } from '~~/server/trpc/routers';
|
||||
|
||||
// const addHeader = () => {
|
||||
// headers.value.authorization = 'Bearer abcdefghijklmnop'
|
||||
// console.log(headers.value)
|
||||
// }
|
||||
const { $client } = useNuxtApp()
|
||||
|
||||
const addTodo = async () => {
|
||||
const title = Math.random().toString(36).slice(2, 7)
|
||||
|
||||
try {
|
||||
const result = await $client.todo.addTodo.mutate({
|
||||
const x = await $client.todo.addTodo.mutate({
|
||||
id: Date.now(),
|
||||
userId: 69,
|
||||
title,
|
||||
completed: false,
|
||||
completed: false
|
||||
})
|
||||
await result.execute()
|
||||
console.log('Todo: ', result.data.value)
|
||||
}
|
||||
catch (e) {
|
||||
console.log(x)
|
||||
} catch (e) {
|
||||
console.log(e)
|
||||
}
|
||||
}
|
||||
|
||||
const { data: todos, pending, error, refresh } = await $client.todo.getTodos.query()
|
||||
type RouterOutput = inferRouterOutputs<AppRouter>;
|
||||
type ErrorOutput = TRPCClientError<AppRouter>
|
||||
|
||||
const { data: todos, pending, error, refresh } = await useAsyncData<RouterOutput['todo']['getTodos'], ErrorOutput>(() => $client.todo.getTodos.query())
|
||||
</script>
|
||||
|
||||
<template>
|
||||
@@ -1,7 +1,7 @@
|
||||
<script setup lang="ts">
|
||||
const route = useRoute()
|
||||
const { $client } = useNuxtApp()
|
||||
const { data: todo, pending, error } = await $client.todo.getTodo.query(Number(route.params.id))
|
||||
const { data: todo, pending, error } = await useAsyncData(() => $client.todo.getTodo.query(Number(route.params.id)))
|
||||
</script>
|
||||
|
||||
<template>
|
||||
30
playground/plugins/trpc-client.ts
Normal file
30
playground/plugins/trpc-client.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
import { createTRPCProxyClient, httpBatchLink, loggerLink } from '@trpc/client'
|
||||
import superjson from 'superjson'
|
||||
import type { AppRouter } from '~~/server/trpc/routers'
|
||||
|
||||
export default defineNuxtPlugin(() => {
|
||||
const headers = useRequestHeaders()
|
||||
const client = createTRPCProxyClient<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({
|
||||
url: 'http://localhost:3000/api/trpc',
|
||||
headers () {
|
||||
return headers
|
||||
}
|
||||
})
|
||||
]
|
||||
})
|
||||
|
||||
return {
|
||||
provide: {
|
||||
client
|
||||
}
|
||||
}
|
||||
})
|
||||
@@ -1,6 +1,6 @@
|
||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
||||
import { appRouter } from '../../trpc/routers'
|
||||
import { createContext } from '~~/server/trpc/context'
|
||||
import { appRouter } from '@/server/trpc/routers'
|
||||
import { createContext } from '@/server/trpc/context'
|
||||
|
||||
export default createNuxtApiHandler({
|
||||
router: appRouter,
|
||||
@@ -8,12 +8,12 @@ export default createNuxtApiHandler({
|
||||
* @link https://trpc.io/docs/context
|
||||
*/
|
||||
createContext,
|
||||
onError({ error }) {
|
||||
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
|
||||
*/
|
||||
@@ -8,10 +8,11 @@ export type Context = inferAsyncReturnType<typeof createContext>
|
||||
* Creates context for an incoming request
|
||||
* @link https://trpc.io/docs/context
|
||||
*/
|
||||
export async function createContext(
|
||||
opts: H3Event,
|
||||
export function createContext (
|
||||
event: H3Event
|
||||
) {
|
||||
// for API-response caching see https://trpc.io/docs/caching
|
||||
|
||||
console.log('cookies', parseCookies(event))
|
||||
|
||||
return {}
|
||||
}
|
||||
@@ -1,10 +1,10 @@
|
||||
import { router } from '..'
|
||||
import { router } from '../trpc'
|
||||
import { todoRouter } from './todo'
|
||||
import { userRouter } from './user'
|
||||
|
||||
export const appRouter = router({
|
||||
todo: todoRouter,
|
||||
user: userRouter,
|
||||
user: userRouter
|
||||
})
|
||||
|
||||
export type AppRouter = typeof appRouter
|
||||
@@ -1,5 +1,5 @@
|
||||
import { z } from 'zod'
|
||||
import { publicProcedure, router } from '..'
|
||||
import { publicProcedure, router } from '../trpc'
|
||||
|
||||
const baseURL = 'https://jsonplaceholder.typicode.com'
|
||||
|
||||
@@ -7,7 +7,7 @@ const TodoShape = z.object({
|
||||
userId: z.number(),
|
||||
id: z.number(),
|
||||
title: z.string(),
|
||||
completed: z.boolean(),
|
||||
completed: z.boolean()
|
||||
})
|
||||
|
||||
export type Todo = z.infer<typeof TodoShape>
|
||||
@@ -27,7 +27,7 @@ export const todoRouter = router({
|
||||
.mutation((req) => {
|
||||
return $fetch<Todo>(`${baseURL}/todos`, {
|
||||
method: 'POST',
|
||||
body: req.input,
|
||||
body: req.input
|
||||
})
|
||||
}),
|
||||
})
|
||||
})
|
||||
@@ -1,5 +1,5 @@
|
||||
import { z } from 'zod'
|
||||
import { publicProcedure, router } from '..'
|
||||
import { publicProcedure, router } from '../trpc'
|
||||
|
||||
const baseURL = 'https://jsonplaceholder.typicode.com'
|
||||
|
||||
@@ -7,7 +7,7 @@ const UserShape = z.object({
|
||||
id: z.number(),
|
||||
name: z.string(),
|
||||
username: z.string(),
|
||||
email: z.string(),
|
||||
email: z.string()
|
||||
})
|
||||
|
||||
export type User = z.infer<typeof UserShape>
|
||||
@@ -27,7 +27,7 @@ export const userRouter = router({
|
||||
.mutation((req) => {
|
||||
return $fetch<User>(`${baseURL}/users`, {
|
||||
method: 'POST',
|
||||
body: req.input,
|
||||
body: req.input
|
||||
})
|
||||
}),
|
||||
})
|
||||
})
|
||||
@@ -1,9 +1,23 @@
|
||||
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
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
/**
|
||||
5047
pnpm-lock.yaml
generated
5047
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,2 +1,3 @@
|
||||
packages:
|
||||
- packages/*
|
||||
- playground
|
||||
- docs
|
||||
|
||||
@@ -3,13 +3,15 @@ import { resolveHTTPResponse } from '@trpc/server/http'
|
||||
import type {
|
||||
AnyRouter,
|
||||
ProcedureType,
|
||||
TRPCError,
|
||||
inferRouterContext,
|
||||
inferRouterError,
|
||||
inferRouterError
|
||||
} from '@trpc/server'
|
||||
import {
|
||||
TRPCError
|
||||
} from '@trpc/server'
|
||||
import { createURL } from 'ufo'
|
||||
import type { H3Event } from 'h3'
|
||||
import { defineEventHandler, isMethod, readBody } from 'h3'
|
||||
import { createError, defineEventHandler, isMethod, readBody } from 'h3'
|
||||
import type { TRPCResponse } from '@trpc/server/rpc'
|
||||
|
||||
type MaybePromise<T> = T | Promise<T>
|
||||
@@ -30,51 +32,85 @@ export interface OnErrorPayload<TRouter extends AnyRouter> {
|
||||
error: TRPCError
|
||||
type: ProcedureType | 'unknown'
|
||||
path: string | undefined
|
||||
req: H3Event['req']
|
||||
req: H3Event['node']['req']
|
||||
input: unknown
|
||||
ctx: undefined | inferRouterContext<TRouter>
|
||||
}
|
||||
|
||||
export type OnErrorFn<TRouter extends AnyRouter> = (opts: OnErrorPayload<TRouter>) => void
|
||||
|
||||
export function createNuxtApiHandler<TRouter extends AnyRouter>({
|
||||
router,
|
||||
createContext,
|
||||
responseMeta,
|
||||
onError,
|
||||
url = '/api/trpc',
|
||||
}: {
|
||||
export interface ResolveHTTPRequestOptions<TRouter extends AnyRouter> {
|
||||
router: TRouter
|
||||
createContext?: CreateContextFn<TRouter>
|
||||
responseMeta?: ResponseMetaFn<TRouter>
|
||||
onError?: OnErrorFn<TRouter>
|
||||
url?: string
|
||||
}) {
|
||||
batching?: {
|
||||
enabled: boolean
|
||||
}
|
||||
}
|
||||
|
||||
function getPath (event: H3Event): string | null {
|
||||
if (typeof event.context.params.trpc === 'string') { return event.context.params.trpc }
|
||||
|
||||
if (Array.isArray(event.context.params.trpc)) { return event.context.params.trpc.join('/') }
|
||||
|
||||
return null
|
||||
}
|
||||
|
||||
export function createNuxtApiHandler<TRouter extends AnyRouter> ({
|
||||
router,
|
||||
createContext,
|
||||
responseMeta,
|
||||
onError,
|
||||
batching
|
||||
}: ResolveHTTPRequestOptions<TRouter>) {
|
||||
return defineEventHandler(async (event) => {
|
||||
const {
|
||||
req,
|
||||
res,
|
||||
} = event
|
||||
res
|
||||
} = event.node
|
||||
|
||||
const $url = createURL(req.url!)
|
||||
|
||||
const path = getPath(event)
|
||||
|
||||
if (path === null) {
|
||||
const error = router.getErrorShape({
|
||||
error: new TRPCError({
|
||||
message:
|
||||
'Param "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,
|
||||
query: $url.searchParams
|
||||
},
|
||||
path: $url.pathname.substring(url.length + 1),
|
||||
createContext: async () => createContext?.(event),
|
||||
path,
|
||||
createContext: async () => await createContext?.(event),
|
||||
responseMeta,
|
||||
onError: (o) => {
|
||||
onError?.({
|
||||
...o,
|
||||
req,
|
||||
req
|
||||
})
|
||||
},
|
||||
}
|
||||
})
|
||||
|
||||
const { status, headers, body } = httpResponse
|
||||
@@ -10,7 +10,7 @@
|
||||
"noImplicitAny": true,
|
||||
"allowJs": true,
|
||||
"noEmit": true,
|
||||
"outDir": "dist",
|
||||
"resolveJsonModule": true
|
||||
"resolveJsonModule": true,
|
||||
"skipDefaultLibCheck": true
|
||||
}
|
||||
}
|
||||
|
||||
15
tsup.config.ts
Normal file
15
tsup.config.ts
Normal file
@@ -0,0 +1,15 @@
|
||||
import { defineConfig } from 'tsup'
|
||||
|
||||
export default defineConfig({
|
||||
entry: ['src/index.ts'],
|
||||
format: ['cjs', 'esm'],
|
||||
splitting: false,
|
||||
clean: true,
|
||||
external: ['#app', '#imports'],
|
||||
dts: true,
|
||||
outExtension ({ format }) {
|
||||
return {
|
||||
js: format === 'esm' ? '.mjs' : `.${format}`
|
||||
}
|
||||
}
|
||||
})
|
||||
Reference in New Issue
Block a user