mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-14 20:19:33 +01:00
Compare commits
29 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
- [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
|
||||
|
||||
|
||||
@@ -1,25 +1,38 @@
|
||||
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'
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
docus: {
|
||||
title: "tRPC Nuxt",
|
||||
description: "End-to-end typesafe APIs in Nuxt applications.",
|
||||
image: "https://og-image.vercel.app/tRPC-Nuxt",
|
||||
alt: "tRPC-Nuxt cover",
|
||||
url: "https://trpc-nuxt.vercel.app",
|
||||
debug: false,
|
||||
socials: {
|
||||
github: "wobsoriano/trpc-nuxt"
|
||||
},
|
||||
cover: {
|
||||
src: "/cover.jpg",
|
||||
alt: "tRPC-Nuxt module"
|
||||
},
|
||||
header: {
|
||||
logo: true
|
||||
},
|
||||
aside: {
|
||||
level: 1
|
||||
},
|
||||
footer: {
|
||||
credits: {
|
||||
icon: "IconDocus",
|
||||
text: "Powered by Docus",
|
||||
href: "https://docus.com"
|
||||
},
|
||||
iconLinks: [
|
||||
{
|
||||
label: "NuxtJS",
|
||||
href: "https://nuxt.com",
|
||||
// @ts-expect-error: IDK nuxt
|
||||
component: "IconNuxtLabs"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
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]
|
||||
export default defineNuxtConfig({
|
||||
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]
|
||||
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(() => {
|
||||
/**
|
||||
@@ -107,12 +107,12 @@ export default defineNuxtPlugin(() => {
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
|
||||
const hello = await $client.hello.useQuery({ text: 'client' })
|
||||
const { data: hello } = await $client.hello.useQuery({ text: 'client' })
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div>
|
||||
<p>{{ hello.data?.greeting }}</p>
|
||||
<p>{{ hello?.greeting }}</p>
|
||||
</div>
|
||||
</template>
|
||||
```
|
||||
|
||||
@@ -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.
|
||||
|
||||
::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
|
||||
|
||||
@@ -27,5 +27,6 @@ End-to-end typesafe APIs in Nuxt applications.
|
||||
- Automatic typesafety
|
||||
- Snappy DX
|
||||
- Autocompletion on the client, for inputs, outputs and errors
|
||||
- Leverages [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data) and [$fetch](https://nuxt.com/docs/api/utils/dollarfetch)
|
||||
::
|
||||
::
|
||||
|
||||
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 |
25
package.json
25
package.json
@@ -3,7 +3,7 @@
|
||||
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
||||
"type": "module",
|
||||
"packageManager": "pnpm@7.18.2",
|
||||
"version": "0.4.4",
|
||||
"version": "0.6.0",
|
||||
"license": "MIT",
|
||||
"sideEffects": false,
|
||||
"exports": {
|
||||
@@ -25,33 +25,34 @@
|
||||
"client.d.ts"
|
||||
],
|
||||
"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",
|
||||
"prepublishOnly": "pnpm build",
|
||||
"build": "tsup",
|
||||
"lint": "eslint .",
|
||||
"lint:fix": "eslint . --fix",
|
||||
"release": "bumpp && npm publish"
|
||||
"release": "bumpp && npm publish",
|
||||
"update-deps": "taze -w && pnpm i"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@trpc/client": "^10.0.0",
|
||||
"@trpc/server": "^10.0.0"
|
||||
"@trpc/client": "^10.10.0",
|
||||
"@trpc/server": "^10.10.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"h3": "^1.0.2",
|
||||
"h3": "^1.1.0",
|
||||
"ofetch": "^1.0.0",
|
||||
"ohash": "^1.0.0",
|
||||
"ufo": "^1.0.0"
|
||||
"ufo": "^1.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nuxt/eslint-config": "^0.1.1",
|
||||
"@trpc/client": "^10.5.0",
|
||||
"@trpc/server": "^10.5.0",
|
||||
"@trpc/client": "^10.10.0",
|
||||
"@trpc/server": "^10.10.0",
|
||||
"bumpp": "^8.2.1",
|
||||
"concurrently": "^7.5.0",
|
||||
"eslint": "^8.25.0",
|
||||
"eslint": "^8.33.0",
|
||||
"taze": "^0.8.5",
|
||||
"tsup": "6.4.0",
|
||||
"typescript": "^4.7.4"
|
||||
"typescript": "^4.9.5"
|
||||
},
|
||||
"eslintConfig": {
|
||||
"extends": [
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
||||
export default defineNuxtConfig({
|
||||
build: {
|
||||
transpile: ['trpc-nuxt/client']
|
||||
transpile: ['trpc-nuxt']
|
||||
}
|
||||
})
|
||||
|
||||
@@ -9,11 +9,11 @@
|
||||
"postinstall": "nuxt prepare"
|
||||
},
|
||||
"dependencies": {
|
||||
"@trpc/client": "^10.5.0",
|
||||
"@trpc/server": "^10.5.0",
|
||||
"superjson": "^1.11.0",
|
||||
"@trpc/client": "^10.8.1",
|
||||
"@trpc/server": "^10.8.1",
|
||||
"superjson": "^1.12.1",
|
||||
"trpc-nuxt": "workspace:*",
|
||||
"zod": "^3.19.1"
|
||||
"zod": "^3.20.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"nuxt": "^3.0.0"
|
||||
|
||||
@@ -12,7 +12,7 @@ export function createContext (
|
||||
event: H3Event
|
||||
) {
|
||||
// for API-response caching see https://trpc.io/docs/caching
|
||||
console.log('cookies', parseCookies(event))
|
||||
// console.log('cookies', parseCookies(event))
|
||||
|
||||
return {}
|
||||
}
|
||||
|
||||
2090
pnpm-lock.yaml
generated
2090
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -7,7 +7,17 @@ import { type DecoratedProcedureRecord } from './types'
|
||||
import { getCurrentInstance, onScopeDispose, useAsyncData } 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 (
|
||||
path: string,
|
||||
@@ -59,7 +69,7 @@ export function createTRPCNuxtClient<TRouter extends AnyRouter> (opts: CreateTRP
|
||||
const client = createTRPCProxyClient<TRouter>(opts)
|
||||
|
||||
const decoratedClient = createFlatProxy((key) => {
|
||||
return createNuxtProxyDecoration(key, client)
|
||||
return createNuxtProxyDecoration(key, client as any)
|
||||
}) as DecoratedProcedureRecord<TRouter['_def']['record'], TRouter>
|
||||
|
||||
return decoratedClient
|
||||
|
||||
@@ -4,6 +4,7 @@ import { FetchError } from 'ofetch'
|
||||
// @ts-expect-error: Nuxt auto-imports
|
||||
import { useRequestHeaders } from '#imports'
|
||||
import { type HTTPLinkOptions as _HTTPLinkOptions } from '@trpc/client/dist/links/internals/httpUtils'
|
||||
import { type FetchEsque } from '@trpc/client/dist/internals/types'
|
||||
|
||||
function customFetch(input: RequestInfo | URL, init?: RequestInit) {
|
||||
return globalThis.$fetch.raw(input.toString(), init)
|
||||
@@ -43,7 +44,7 @@ export function httpLink<TRouter extends AnyRouter>(opts?: HTTPLinkOptions) {
|
||||
headers () {
|
||||
return headers
|
||||
},
|
||||
fetch: customFetch,
|
||||
fetch: customFetch as FetchEsque,
|
||||
...opts,
|
||||
})
|
||||
}
|
||||
@@ -72,7 +73,7 @@ export function httpBatchLink<TRouter extends AnyRouter>(opts?: HttpBatchLinkOpt
|
||||
headers () {
|
||||
return headers
|
||||
},
|
||||
fetch: customFetch,
|
||||
fetch: customFetch as FetchEsque,
|
||||
...opts,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
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 {
|
||||
AnyMutationProcedure,
|
||||
AnyProcedure,
|
||||
|
||||
Reference in New Issue
Block a user