mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-14 20:19:33 +01:00
Compare commits
85 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bec300b750 | ||
|
|
7bbe767495 | ||
|
|
811a634010 | ||
|
|
12d8c97f71 | ||
|
|
ad85a78350 | ||
|
|
892d167ff1 | ||
|
|
e15ea6b5a3 | ||
|
|
054fad952a | ||
|
|
e15a62a5b2 | ||
|
|
3f399f0c58 | ||
|
|
247a6448cb | ||
|
|
5301221148 | ||
|
|
7683499953 | ||
|
|
2c28424ecd | ||
|
|
18cd492ffd | ||
|
|
c2ae94b4a7 | ||
|
|
94eb3c6257 | ||
|
|
e55670169e | ||
|
|
4f7fbbe108 | ||
|
|
c32fdf7893 | ||
|
|
10bc1d3a4d | ||
|
|
7bd62822d3 | ||
|
|
967271089f | ||
|
|
169c6aa534 | ||
|
|
2d025788ce | ||
|
|
4af2b2ef3f | ||
|
|
ae0b7824f4 | ||
|
|
4339bf5059 | ||
|
|
252e2261e9 | ||
|
|
40eaf44f39 | ||
|
|
ad827bb716 | ||
|
|
08125cbf0c | ||
|
|
fb5723b071 | ||
|
|
8c35279cc2 | ||
|
|
61a5bcd2ee | ||
|
|
eaeab1565d | ||
|
|
e7453bfc70 | ||
|
|
54ef27d524 | ||
|
|
38d83dac34 | ||
|
|
0f7e52248f | ||
|
|
be55641338 | ||
|
|
6ba6e70b92 | ||
|
|
b710f809c7 | ||
|
|
4f647afa36 | ||
|
|
1defbe5954 | ||
|
|
fa6ba65d35 | ||
|
|
d4af221e89 | ||
|
|
6595a1d306 | ||
|
|
b506cd5f14 | ||
|
|
7a69573fb9 | ||
|
|
8e26e781d4 | ||
|
|
8efb63e70c | ||
|
|
4f6c07b0a1 | ||
|
|
aa3fe5527d | ||
|
|
6f17913eab | ||
|
|
d6c60cb2b3 | ||
|
|
76fbd59525 | ||
|
|
57faf8749a | ||
|
|
9456342d58 | ||
|
|
f89c8e44ef | ||
|
|
7f156806d8 | ||
|
|
bd33589d2f | ||
|
|
16b6ed315a | ||
|
|
6e74e44233 | ||
|
|
6485aa42a7 | ||
|
|
051d5bb325 | ||
|
|
b7d4dc7642 | ||
|
|
abb351268a | ||
|
|
c1a791558e | ||
|
|
14a18a783e | ||
|
|
209c28513d | ||
|
|
6157d51d59 | ||
|
|
0effea5efc | ||
|
|
f6f79ddab4 | ||
|
|
b4eea4393e | ||
|
|
ec576865c1 | ||
|
|
83aeeb7332 | ||
|
|
fd977982ec | ||
|
|
e5178d1634 | ||
|
|
6191a1f925 | ||
|
|
c100ee171c | ||
|
|
949e122be7 | ||
|
|
410dcf8a11 | ||
|
|
a8138602a2 | ||
|
|
bb2d1ef8dd |
1
.github/FUNDING.yml
vendored
Normal file
1
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
github: wobsoriano
|
||||||
54
CHANGELOG.md
Normal file
54
CHANGELOG.md
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
|
||||||
|
## v0.10.6
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.5...v0.10.6)
|
||||||
|
|
||||||
|
## v0.10.5
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.4...v0.10.5)
|
||||||
|
|
||||||
|
|
||||||
|
### 🚀 Enhancements
|
||||||
|
|
||||||
|
- Pass input to watched sources if it's a ref ([892d167](https://github.com/wobsoriano/trpc-nuxt/commit/892d167))
|
||||||
|
|
||||||
|
### ❤️ Contributors
|
||||||
|
|
||||||
|
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||||
|
|
||||||
|
## v0.10.4
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.3...v0.10.4)
|
||||||
|
|
||||||
|
|
||||||
|
### 🚀 Enhancements
|
||||||
|
|
||||||
|
- Add reactive inputs ([054fad9](https://github.com/wobsoriano/trpc-nuxt/commit/054fad9))
|
||||||
|
|
||||||
|
### 📖 Documentation
|
||||||
|
|
||||||
|
- Update local deps ([7683499](https://github.com/wobsoriano/trpc-nuxt/commit/7683499))
|
||||||
|
|
||||||
|
### 🏡 Chore
|
||||||
|
|
||||||
|
- Remove engines property ([e15a62a](https://github.com/wobsoriano/trpc-nuxt/commit/e15a62a))
|
||||||
|
|
||||||
|
### ❤️ Contributors
|
||||||
|
|
||||||
|
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||||
|
|
||||||
|
## v0.10.3
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.2...v0.10.3)
|
||||||
|
|
||||||
|
|
||||||
|
### 🚀 Enhancements
|
||||||
|
|
||||||
|
- Export createH3ApiHandler for h3 apps ([18cd492](https://github.com/wobsoriano/trpc-nuxt/commit/18cd492))
|
||||||
|
|
||||||
|
### ❤️ Contributors
|
||||||
|
|
||||||
|
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||||
|
|
||||||
12
README.md
12
README.md
@@ -1,3 +1,9 @@
|
|||||||
|
<p align="center">
|
||||||
|
<figure>
|
||||||
|
<img src="https://trpc-nuxt.vercel.app/cover.jpg" alt="trpc-nuxt cover image" />
|
||||||
|
</figure>
|
||||||
|
</p>
|
||||||
|
|
||||||
# tRPC-Nuxt
|
# tRPC-Nuxt
|
||||||
|
|
||||||
End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
||||||
@@ -19,7 +25,11 @@ For version 3 of this module (tRPC v9, auto-imports, auto handlers), [go here](h
|
|||||||
|
|
||||||
## Recommended IDE Setup
|
## Recommended IDE Setup
|
||||||
|
|
||||||
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
||||||
|
|
||||||
|
## Acknowledgements
|
||||||
|
|
||||||
|
Huge thanks to [Alex / KATT](https://github.com/KATT), the author of [tRPC](https://trpc.io/), for being the first sponsor of this project! 🎉
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -1,25 +1,38 @@
|
|||||||
export default defineAppConfig({
|
export default defineAppConfig({
|
||||||
docus: {
|
docus: {
|
||||||
title: 'tRPC Nuxt',
|
title: "tRPC Nuxt",
|
||||||
image: 'https://og-image.vercel.app/tRPC-Nuxt',
|
description: "End-to-end typesafe APIs in Nuxt applications.",
|
||||||
alt: 'tRPC-Nuxt cover',
|
image: "https://og-image.vercel.app/tRPC-Nuxt",
|
||||||
url: 'https://trpc-nuxt.vercel.app',
|
alt: "tRPC-Nuxt cover",
|
||||||
debug: false,
|
url: "https://trpc-nuxt.vercel.app",
|
||||||
socials: {
|
debug: false,
|
||||||
github: 'wobsoriano/trpc-nuxt'
|
socials: {
|
||||||
},
|
github: "wobsoriano/trpc-nuxt"
|
||||||
aside: {
|
},
|
||||||
level: 1
|
cover: {
|
||||||
},
|
src: "/cover.jpg",
|
||||||
footer: {
|
alt: "tRPC-Nuxt module"
|
||||||
credits: true,
|
},
|
||||||
icons: [
|
header: {
|
||||||
{
|
logo: true
|
||||||
label: 'NuxtJS',
|
},
|
||||||
href: 'https://nuxtjs.org',
|
aside: {
|
||||||
component: 'IconNuxt'
|
level: 1
|
||||||
}
|
},
|
||||||
]
|
footer: {
|
||||||
}
|
credits: {
|
||||||
}
|
icon: "IconDocus",
|
||||||
|
text: "Powered by Docus",
|
||||||
|
href: "https://docus.com"
|
||||||
|
},
|
||||||
|
iconLinks: [
|
||||||
|
{
|
||||||
|
label: "NuxtJS",
|
||||||
|
href: "https://nuxt.com",
|
||||||
|
// @ts-expect-error: IDK nuxt
|
||||||
|
component: "IconNuxtLabs"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
99
docs/components/Logo.vue
Normal file
99
docs/components/Logo.vue
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
<template>
|
||||||
|
<div class="logo">
|
||||||
|
<div v-if="$colorMode.value == 'dark'">
|
||||||
|
<svg
|
||||||
|
width="40"
|
||||||
|
height="40"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
viewBox="0 0 509 454.27"
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d="M363.3,307.79v.31l.28-.48Z"
|
||||||
|
fill="#fff"
|
||||||
|
stroke="#fff"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M16.88,307.79v.3l.27-.46ZM83.1,350.1l.15.25.14-.08Z"
|
||||||
|
fill="#fff"
|
||||||
|
stroke="#fff"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M433.22,259.49V139.58l-102-58.85V49.53L254.48,5.2,251.38,7,177.69,49.53V80.79L75.85,139.58V259.44L4.5,300.64v88.68l76.79,44.33,73.27-42.3,100,57.73,100-57.71,73.23,42.28,76.79-44.33V300.64ZM254.48,19.5l57.89,33.41L254,86.37C238.27,77,212.74,61.79,197.24,52.54Zm64.41,43.94v67.62l-58.22,33.61V96.81Zm-128.82-.75c13.83,8.23,44,26.24,58.22,34.69v67.29l-58.22-33.61ZM16.88,307.79l.27-.16-.27.46Zm58.22,108L16.88,382.16V313.8L75.1,348.49Zm5.7-78.29c.71.41-55.37-33-56.76-33.82L81.29,270.6,139.18,304Zm2.45,12.87-.15-.25.29.17Zm62.45,31.81-3.52,2-54.7,31.57V347.92l58.22-33.37Zm205.22-81.52v78.49l-96.39,55.65-96.45-55.69V300.64L88.23,260.32V146.73l89.46-51.65V138.2l76.79,44.33,76.79-44.33V95l89.57,51.71V260.27Zm12.66,7-.28.48v-.31Zm57.94,108.15-54.65-31.55-3.57-2.06V313.79l58.22,34.7Zm5.7-78.29-56.76-33.82,57.25-33.06L485.59,304Zm64.9,44.68L433.9,415.77V347.92l58.22-33.37Z"
|
||||||
|
fill="#fff"
|
||||||
|
stroke="#fff"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M83.1,350.1l.15.25.14-.08Zm0,0,.15.25.14-.08Zm0,0,.15.25.14-.08Z"
|
||||||
|
fill="#fff"
|
||||||
|
stroke="#fff"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M322.58,277.47l-34.44-57.86a9.2,9.2,0,0,0-3.4-3.3,9.47,9.47,0,0,0-12.67,3.3l-8.81,14.8L246,205.46c-3.46-6-12.61-6-16.07,0l-42.86,72a8.78,8.78,0,0,0,0,9,9.33,9.33,0,0,0,8,4.5h32.19c12.76,0,22.16-5.43,28.64-16,5.44-9.14,18.84-31.66,24.13-40.53l25.26,42.44H271.68L263.26,291h51.29C321.45,291.06,326.22,283.5,322.58,277.47Zm-79-10c-4.3,6.87-9.18,9.38-16.76,9.38H204.34L238,220.24l16.8,28.3Z"
|
||||||
|
fill="#fff"
|
||||||
|
stroke="#fff"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div v-else>
|
||||||
|
<svg
|
||||||
|
width="40"
|
||||||
|
height="40"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
viewBox="0 0 509 454.27"
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d="M363.3,307.79v.31l.28-.48Z"
|
||||||
|
stroke="#000"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M16.88,307.79v.3l.27-.46ZM83.1,350.1l.15.25.14-.08Z"
|
||||||
|
stroke="#000"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M433.22,259.49V139.58l-102-58.85V49.53L254.48,5.2,251.38,7,177.69,49.53V80.79L75.85,139.58V259.44L4.5,300.64v88.68l76.79,44.33,73.27-42.3,100,57.73,100-57.71,73.23,42.28,76.79-44.33V300.64ZM254.48,19.5l57.89,33.41L254,86.37C238.27,77,212.74,61.79,197.24,52.54Zm64.41,43.94v67.62l-58.22,33.61V96.81Zm-128.82-.75c13.83,8.23,44,26.24,58.22,34.69v67.29l-58.22-33.61ZM16.88,307.79l.27-.16-.27.46Zm58.22,108L16.88,382.16V313.8L75.1,348.49Zm5.7-78.29c.71.41-55.37-33-56.76-33.82L81.29,270.6,139.18,304Zm2.45,12.87-.15-.25.29.17Zm62.45,31.81-3.52,2-54.7,31.57V347.92l58.22-33.37Zm205.22-81.52v78.49l-96.39,55.65-96.45-55.69V300.64L88.23,260.32V146.73l89.46-51.65V138.2l76.79,44.33,76.79-44.33V95l89.57,51.71V260.27Zm12.66,7-.28.48v-.31Zm57.94,108.15-54.65-31.55-3.57-2.06V313.79l58.22,34.7Zm5.7-78.29-56.76-33.82,57.25-33.06L485.59,304Zm64.9,44.68L433.9,415.77V347.92l58.22-33.37Z"
|
||||||
|
stroke="#000"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M83.1,350.1l.15.25.14-.08Zm0,0,.15.25.14-.08Zm0,0,.15.25.14-.08Z"
|
||||||
|
stroke="#000"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M322.58,277.47l-34.44-57.86a9.2,9.2,0,0,0-3.4-3.3,9.47,9.47,0,0,0-12.67,3.3l-8.81,14.8L246,205.46c-3.46-6-12.61-6-16.07,0l-42.86,72a8.78,8.78,0,0,0,0,9,9.33,9.33,0,0,0,8,4.5h32.19c12.76,0,22.16-5.43,28.64-16,5.44-9.14,18.84-31.66,24.13-40.53l25.26,42.44H271.68L263.26,291h51.29C321.45,291.06,326.22,283.5,322.58,277.47Zm-79-10c-4.3,6.87-9.18,9.38-16.76,9.38H204.34L238,220.24l16.8,28.3Z"
|
||||||
|
stroke="#000"
|
||||||
|
stroke-miterlimit="10"
|
||||||
|
stroke-width="9"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<ProseStrong>tRPC Nuxt</ProseStrong>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.logo {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 10px;
|
||||||
|
font-weight: 800;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
@@ -24,7 +24,7 @@ yarn add @trpc/server @trpc/client trpc-nuxt zod
|
|||||||
```ts [nuxt.config.ts]
|
```ts [nuxt.config.ts]
|
||||||
export default defineNuxtConfig({
|
export default defineNuxtConfig({
|
||||||
build: {
|
build: {
|
||||||
transpile: ['trpc-nuxt/client']
|
transpile: ['trpc-nuxt']
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -78,7 +78,7 @@ Create a strongly-typed plugin using your API's type signature.
|
|||||||
|
|
||||||
```ts [plugins/client.ts]
|
```ts [plugins/client.ts]
|
||||||
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
|
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
|
||||||
import type { AppRouter } from '~/server/trpc/routers'
|
import type { AppRouter } from '~/server/api/trpc/[trpc]'
|
||||||
|
|
||||||
export default defineNuxtPlugin(() => {
|
export default defineNuxtPlugin(() => {
|
||||||
/**
|
/**
|
||||||
@@ -107,12 +107,12 @@ export default defineNuxtPlugin(() => {
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
const { $client } = useNuxtApp()
|
const { $client } = useNuxtApp()
|
||||||
|
|
||||||
const hello = await $client.hello.useQuery({ text: 'client' })
|
const { data: hello } = await $client.hello.useQuery({ text: 'client' })
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div>
|
<div>
|
||||||
<p>{{ hello.data?.greeting }}</p>
|
<p>{{ hello?.greeting }}</p>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -96,7 +96,7 @@ import { inferAsyncReturnType } from '@trpc/server'
|
|||||||
* Creates context for an incoming request
|
* Creates context for an incoming request
|
||||||
* @link https://trpc.io/docs/context
|
* @link https://trpc.io/docs/context
|
||||||
*/
|
*/
|
||||||
export const createContext = () => {}
|
export const createContext = () => ({})
|
||||||
|
|
||||||
export type Context = inferAsyncReturnType<typeof createContext>;
|
export type Context = inferAsyncReturnType<typeof createContext>;
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ title: 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.
|
It is often useful to wrap functionality of your `@trpc/client` api within other functions. For this purpose, it's necessary to be able to infer input types and output types generated by your `@trpc/server` router.
|
||||||
|
|
||||||
::alert{type="info"}
|
::alert{type="info"}
|
||||||
[createTRPCNuxtClient](/get-started/client/create) adds a `useQuery` method built on top of [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data/).
|
[createTRPCNuxtClient](/get-started/client/create) already adds a `useQuery` method built on top of [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data/). You might not need this.
|
||||||
::
|
::
|
||||||
|
|
||||||
## Inference Helpers
|
## Inference Helpers
|
||||||
|
|||||||
@@ -27,5 +27,6 @@ End-to-end typesafe APIs in Nuxt applications.
|
|||||||
- Automatic typesafety
|
- Automatic typesafety
|
||||||
- Snappy DX
|
- Snappy DX
|
||||||
- Autocompletion on the client, for inputs, outputs and errors
|
- Autocompletion on the client, for inputs, outputs and errors
|
||||||
|
- Leverages [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data) and [$fetch](https://nuxt.com/docs/api/utils/dollarfetch)
|
||||||
::
|
::
|
||||||
::
|
::
|
||||||
|
|||||||
@@ -7,11 +7,9 @@
|
|||||||
"generate": "nuxi build",
|
"generate": "nuxi build",
|
||||||
"preview": "nuxi preview"
|
"preview": "nuxi preview"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
|
||||||
"nuxt": "^3.0.0"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@nuxt-themes/docus": "^1.1.10",
|
"@nuxt-themes/docus": "^1.13.1",
|
||||||
"@nuxtlabs/github-module": "^1.5.4"
|
"@nuxtlabs/github-module": "^1.6.3",
|
||||||
|
"nuxt": "3.6.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
BIN
docs/public/cover.jpg
Normal file
BIN
docs/public/cover.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/public/favicon.ico
Normal file
BIN
docs/public/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
42
package.json
42
package.json
@@ -2,8 +2,8 @@
|
|||||||
"name": "trpc-nuxt",
|
"name": "trpc-nuxt",
|
||||||
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"packageManager": "pnpm@7.18.2",
|
"packageManager": "pnpm@8.6.7",
|
||||||
"version": "0.4.4",
|
"version": "0.10.6",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"sideEffects": false,
|
"sideEffects": false,
|
||||||
"exports": {
|
"exports": {
|
||||||
@@ -25,33 +25,34 @@
|
|||||||
"client.d.ts"
|
"client.d.ts"
|
||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "concurrently \"pnpm build -- --watch\" \"pnpm --filter playground dev\"",
|
"dev": "tsup --watch --onSuccess \"pnpm --filter playground dev\"",
|
||||||
"dev:prepare": "pnpm build && nuxt prepare playground",
|
"dev:prepare": "pnpm build && nuxt prepare playground",
|
||||||
"prepublishOnly": "pnpm build",
|
"prepublishOnly": "pnpm build",
|
||||||
"build": "tsup",
|
"build": "tsup",
|
||||||
"lint": "eslint .",
|
"lint": "eslint .",
|
||||||
"lint:fix": "eslint . --fix",
|
"lint:fix": "eslint . --fix",
|
||||||
"release": "bumpp && npm publish"
|
"release": "changelogen --release && npm publish && git push --follow-tags",
|
||||||
|
"update-deps": "taze -w && pnpm i"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@trpc/client": "^10.0.0",
|
"@trpc/client": "^10.26.0",
|
||||||
"@trpc/server": "^10.0.0"
|
"@trpc/server": "^10.26.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"h3": "^1.0.2",
|
"h3": "^1.7.1",
|
||||||
"ofetch": "^1.0.0",
|
"ofetch": "^1.1.1",
|
||||||
"ohash": "^1.0.0",
|
"ohash": "^1.1.2",
|
||||||
"ufo": "^1.0.0"
|
"ufo": "^1.1.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@nuxt/eslint-config": "^0.1.1",
|
"@nuxt/eslint-config": "^0.1.1",
|
||||||
"@trpc/client": "^10.5.0",
|
"@trpc/client": "^10.34.0",
|
||||||
"@trpc/server": "^10.5.0",
|
"@trpc/server": "^10.34.0",
|
||||||
"bumpp": "^8.2.1",
|
"changelogen": "^0.5.4",
|
||||||
"concurrently": "^7.5.0",
|
"eslint": "^8.44.0",
|
||||||
"eslint": "^8.25.0",
|
"taze": "^0.11.2",
|
||||||
"tsup": "6.4.0",
|
"tsup": "7.1.0",
|
||||||
"typescript": "^4.7.4"
|
"typescript": "^5.1.6"
|
||||||
},
|
},
|
||||||
"eslintConfig": {
|
"eslintConfig": {
|
||||||
"extends": [
|
"extends": [
|
||||||
@@ -74,10 +75,7 @@
|
|||||||
],
|
],
|
||||||
"pnpm": {
|
"pnpm": {
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"nuxt": "3.0.0"
|
"nuxt": "3.6.2"
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": "^16.13.0 || ^18.12.0"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
||||||
export default defineNuxtConfig({
|
export default defineNuxtConfig({
|
||||||
build: {
|
build: {
|
||||||
transpile: ['trpc-nuxt/client']
|
transpile: ['trpc-nuxt']
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -9,13 +9,14 @@
|
|||||||
"postinstall": "nuxt prepare"
|
"postinstall": "nuxt prepare"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@trpc/client": "^10.5.0",
|
"@trpc/client": "^10.34.0",
|
||||||
"@trpc/server": "^10.5.0",
|
"@trpc/server": "^10.34.0",
|
||||||
"superjson": "^1.11.0",
|
"superjson": "^1.12.4",
|
||||||
"trpc-nuxt": "workspace:*",
|
"trpc-nuxt": "workspace:*",
|
||||||
"zod": "^3.19.1"
|
"zod": "^3.21.4"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"nuxt": "^3.0.0"
|
"@types/node": "^20.4.1",
|
||||||
|
"nuxt": "3.6.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
27
playground/pages/reactive.vue
Normal file
27
playground/pages/reactive.vue
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
const route = useRoute()
|
||||||
|
const { $client } = useNuxtApp()
|
||||||
|
const id = ref(1)
|
||||||
|
// const { data: todo, pending, error } = await useAsyncData(() => $client.todo.getTodo.query(id.value), {
|
||||||
|
// watch: [id]
|
||||||
|
// })
|
||||||
|
|
||||||
|
const { data: todo, pending, error, refresh } = await $client.todo.getTodo.useQuery(id)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div v-if="pending">
|
||||||
|
Loading...
|
||||||
|
</div>
|
||||||
|
<div v-else-if="error?.data?.code">
|
||||||
|
Error: {{ error.data.code }}
|
||||||
|
</div>
|
||||||
|
<div v-else>
|
||||||
|
ID: {{ todo?.id }} <br>
|
||||||
|
Title: {{ todo?.title }} <br>
|
||||||
|
Completed: {{ todo?.completed }}
|
||||||
|
</div>
|
||||||
|
<button @click="id++">
|
||||||
|
Next Todo
|
||||||
|
</button>
|
||||||
|
</template>
|
||||||
@@ -8,8 +8,8 @@ const { data: todo, pending, error } = await useAsyncData(() => $client.todo.get
|
|||||||
<div v-if="pending">
|
<div v-if="pending">
|
||||||
Loading...
|
Loading...
|
||||||
</div>
|
</div>
|
||||||
<div v-else-if="error?.data?.code">
|
<div v-else-if="error">
|
||||||
{{ error.data.code }}
|
{{ error.message }} - {{ error.cause }}
|
||||||
</div>
|
</div>
|
||||||
<div v-else>
|
<div v-else>
|
||||||
ID: {{ todo?.id }} <br>
|
ID: {{ todo?.id }} <br>
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ export function createContext (
|
|||||||
event: H3Event
|
event: H3Event
|
||||||
) {
|
) {
|
||||||
// for API-response caching see https://trpc.io/docs/caching
|
// for API-response caching see https://trpc.io/docs/caching
|
||||||
console.log('cookies', parseCookies(event))
|
// console.log('cookies', parseCookies(event))
|
||||||
|
|
||||||
return {}
|
return {}
|
||||||
}
|
}
|
||||||
|
|||||||
7966
pnpm-lock.yaml
generated
7966
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -4,10 +4,20 @@ import { createFlatProxy, createRecursiveProxy } from '@trpc/server/shared'
|
|||||||
import { hash } from 'ohash'
|
import { hash } from 'ohash'
|
||||||
import { type DecoratedProcedureRecord } from './types'
|
import { type DecoratedProcedureRecord } from './types'
|
||||||
// @ts-expect-error: Nuxt auto-imports
|
// @ts-expect-error: Nuxt auto-imports
|
||||||
import { getCurrentInstance, onScopeDispose, useAsyncData } from '#imports'
|
import { getCurrentInstance, onScopeDispose, useAsyncData, unref, isRef } from '#imports'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calculates the key used for `useAsyncData` call
|
* Calculates the key used for `useAsyncData` call.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
*
|
||||||
|
* ```ts
|
||||||
|
* import { getQueryKey } from 'trpc-nuxt/client'
|
||||||
|
*
|
||||||
|
* $client.todo.getTodo(1)
|
||||||
|
*
|
||||||
|
* const queryKey = getQueryKey('todo.getTodo', 1)
|
||||||
|
* ```
|
||||||
*/
|
*/
|
||||||
export function getQueryKey (
|
export function getQueryKey (
|
||||||
path: string,
|
path: string,
|
||||||
@@ -44,14 +54,17 @@ export function createNuxtProxyDecoration<TRouter extends AnyRouter> (name: stri
|
|||||||
controller = typeof AbortController !== 'undefined' ? new AbortController() : {} as AbortController
|
controller = typeof AbortController !== 'undefined' ? new AbortController() : {} as AbortController
|
||||||
}
|
}
|
||||||
|
|
||||||
const queryKey = getQueryKey(path, input)
|
const queryKey = getQueryKey(path, unref(input))
|
||||||
return useAsyncData(queryKey, () => (client as any)[path].query(input, {
|
return useAsyncData(queryKey, () => (client as any)[path].query(unref(input), {
|
||||||
signal: controller?.signal,
|
signal: controller?.signal,
|
||||||
...trpc
|
...trpc
|
||||||
}), asyncDataOptions)
|
}), {
|
||||||
|
...asyncDataOptions,
|
||||||
|
watch: isRef(input) ? [...(asyncDataOptions.watch || []), input] : asyncDataOptions.watch
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
return (client as any)[path][lastArg](input)
|
return (client as any)[path][lastArg](...args)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,7 +72,7 @@ export function createTRPCNuxtClient<TRouter extends AnyRouter> (opts: CreateTRP
|
|||||||
const client = createTRPCProxyClient<TRouter>(opts)
|
const client = createTRPCProxyClient<TRouter>(opts)
|
||||||
|
|
||||||
const decoratedClient = createFlatProxy((key) => {
|
const decoratedClient = createFlatProxy((key) => {
|
||||||
return createNuxtProxyDecoration(key, client)
|
return createNuxtProxyDecoration(key, client as any)
|
||||||
}) as DecoratedProcedureRecord<TRouter['_def']['record'], TRouter>
|
}) as DecoratedProcedureRecord<TRouter['_def']['record'], TRouter>
|
||||||
|
|
||||||
return decoratedClient
|
return decoratedClient
|
||||||
|
|||||||
@@ -3,9 +3,10 @@ import { type AnyRouter } from '@trpc/server'
|
|||||||
import { FetchError } from 'ofetch'
|
import { FetchError } from 'ofetch'
|
||||||
// @ts-expect-error: Nuxt auto-imports
|
// @ts-expect-error: Nuxt auto-imports
|
||||||
import { useRequestHeaders } from '#imports'
|
import { useRequestHeaders } from '#imports'
|
||||||
import { type HTTPLinkOptions as _HTTPLinkOptions } from '@trpc/client/dist/links/internals/httpUtils'
|
import { type HTTPLinkOptions as _HTTPLinkOptions } from '@trpc/client/dist/links/httpLink'
|
||||||
|
import { type FetchEsque } from '@trpc/client/dist/internals/types'
|
||||||
|
|
||||||
function customFetch(input: RequestInfo | URL, init?: RequestInit) {
|
function customFetch(input: RequestInfo | URL, init?: RequestInit & { method: 'GET' }) {
|
||||||
return globalThis.$fetch.raw(input.toString(), init)
|
return globalThis.$fetch.raw(input.toString(), init)
|
||||||
.catch((e) => {
|
.catch((e) => {
|
||||||
if (e instanceof FetchError && e.response) { return e.response }
|
if (e instanceof FetchError && e.response) { return e.response }
|
||||||
@@ -43,7 +44,7 @@ export function httpLink<TRouter extends AnyRouter>(opts?: HTTPLinkOptions) {
|
|||||||
headers () {
|
headers () {
|
||||||
return headers
|
return headers
|
||||||
},
|
},
|
||||||
fetch: customFetch,
|
fetch: customFetch as FetchEsque,
|
||||||
...opts,
|
...opts,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -69,10 +70,11 @@ export function httpBatchLink<TRouter extends AnyRouter>(opts?: HttpBatchLinkOpt
|
|||||||
|
|
||||||
return _httpBatchLink<TRouter>({
|
return _httpBatchLink<TRouter>({
|
||||||
url: '/api/trpc',
|
url: '/api/trpc',
|
||||||
|
// @ts-expect-error: Missing property from batchLink. Fix this later.
|
||||||
headers () {
|
headers () {
|
||||||
return headers
|
return headers
|
||||||
},
|
},
|
||||||
fetch: customFetch,
|
fetch: customFetch as FetchEsque,
|
||||||
...opts,
|
...opts,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import type { TRPCClientErrorLike, TRPCRequestOptions as _TRPCRequestOptions } from '@trpc/client'
|
import type { TRPCClientErrorLike, TRPCRequestOptions as _TRPCRequestOptions } from '@trpc/client'
|
||||||
import { type TRPCSubscriptionObserver } from '@trpc/client/dist/internals/TRPCClient'
|
import { type TRPCSubscriptionObserver } from '@trpc/client/dist/internals/TRPCUntypedClient'
|
||||||
import type {
|
import type {
|
||||||
AnyMutationProcedure,
|
AnyMutationProcedure,
|
||||||
AnyProcedure,
|
AnyProcedure,
|
||||||
@@ -16,10 +16,10 @@ import { inferTransformedProcedureOutput } from '@trpc/server/shared'
|
|||||||
import type {
|
import type {
|
||||||
AsyncData,
|
AsyncData,
|
||||||
AsyncDataOptions,
|
AsyncDataOptions,
|
||||||
KeyOfRes,
|
KeysOf,
|
||||||
PickFrom,
|
PickFrom,
|
||||||
_Transform
|
|
||||||
} from 'nuxt/dist/app/composables/asyncData'
|
} from 'nuxt/dist/app/composables/asyncData'
|
||||||
|
import type { Ref } from 'vue'
|
||||||
|
|
||||||
interface TRPCRequestOptions extends _TRPCRequestOptions {
|
interface TRPCRequestOptions extends _TRPCRequestOptions {
|
||||||
abortOnUnmount?: boolean
|
abortOnUnmount?: boolean
|
||||||
@@ -45,19 +45,22 @@ type SubscriptionResolver<
|
|||||||
]
|
]
|
||||||
) => Unsubscribable
|
) => Unsubscribable
|
||||||
|
|
||||||
|
type MaybeRef<T> = T | Ref<T>
|
||||||
|
|
||||||
type DecorateProcedure<
|
type DecorateProcedure<
|
||||||
TProcedure extends AnyProcedure,
|
TProcedure extends AnyProcedure,
|
||||||
TRouter extends AnyRouter,
|
TRouter extends AnyRouter,
|
||||||
> = TProcedure extends AnyQueryProcedure
|
> = TProcedure extends AnyQueryProcedure
|
||||||
? {
|
? {
|
||||||
useQuery: <
|
useQuery: <
|
||||||
TData = inferTransformedProcedureOutput<TProcedure>,
|
ResT = inferTransformedProcedureOutput<TProcedure>,
|
||||||
Transform extends _Transform<TData> = _Transform<TData, TData>,
|
DataE = TRPCClientErrorLike<TProcedure>,
|
||||||
PickKeys extends KeyOfRes<Transform> = KeyOfRes<Transform>,
|
DataT = ResT,
|
||||||
|
PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
|
||||||
>(
|
>(
|
||||||
input: inferProcedureInput<TProcedure>,
|
input: MaybeRef<inferProcedureInput<TProcedure>>,
|
||||||
opts?: AsyncDataOptions<TData, Transform, PickKeys> & { trpc?: TRPCRequestOptions },
|
opts?: AsyncDataOptions<ResT, DataT, PickKeys> & { trpc?: TRPCRequestOptions },
|
||||||
) => AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TRPCClientErrorLike<TProcedure>>,
|
) => AsyncData<PickFrom<DataT, PickKeys>, DataE>,
|
||||||
query: Resolver<TProcedure>
|
query: Resolver<TProcedure>
|
||||||
} : TProcedure extends AnyMutationProcedure ? {
|
} : TProcedure extends AnyMutationProcedure ? {
|
||||||
mutate: Resolver<TProcedure>
|
mutate: Resolver<TProcedure>
|
||||||
|
|||||||
10
src/index.ts
10
src/index.ts
@@ -50,9 +50,13 @@ export interface ResolveHTTPRequestOptions<TRouter extends AnyRouter> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function getPath (event: H3Event): string | null {
|
function getPath (event: H3Event): string | null {
|
||||||
if (typeof event.context.params.trpc === 'string') { return event.context.params.trpc }
|
const { params } = event.context
|
||||||
|
|
||||||
if (Array.isArray(event.context.params.trpc)) { return event.context.params.trpc.join('/') }
|
if (typeof params?.trpc === 'string') { return params.trpc }
|
||||||
|
|
||||||
|
if (params?.trpc && Array.isArray(params.trpc)) {
|
||||||
|
return (params.trpc as string[]).join('/')
|
||||||
|
}
|
||||||
|
|
||||||
return null
|
return null
|
||||||
}
|
}
|
||||||
@@ -124,3 +128,5 @@ export function createNuxtApiHandler<TRouter extends AnyRouter> ({
|
|||||||
return body
|
return body
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export const createH3ApiHandler = createNuxtApiHandler
|
||||||
|
|||||||
Reference in New Issue
Block a user