Compare commits

..

107 Commits

Author SHA1 Message Date
wobsoriano
0f9d26ab60 chore: release v0.4.0 2022-11-12 18:01:55 -08:00
wobsoriano
e6b4386bd8 remove tag 2022-11-12 18:01:10 -08:00
wobsoriano
813b9ff7d7 move eslint config to package.json 2022-11-12 17:55:32 -08:00
wobsoriano
5dce1f4681 update readme 2022-11-12 17:54:17 -08:00
wobsoriano
470ba96be2 transpile github module 2022-11-12 16:32:18 -08:00
wobsoriano
4532add2a7 docs: patch vueuse/head 2022-11-12 16:26:43 -08:00
wobsoriano
876ed1d8d2 bump local trpc deps to rc.7 2022-11-08 09:30:58 -08:00
wobsoriano
611e22d205 delete merge conflicts 2022-11-08 09:27:22 -08:00
wobsoriano
c1857f1079 eslint fix 2022-11-08 09:25:21 -08:00
wobsoriano
796fa43a83 fix lockfile 2022-11-08 09:23:14 -08:00
wobsoriano
e3ce0bcaae merge conflicts 2022-11-08 09:22:30 -08:00
wobsoriano
e916f17d60 update docs 2022-11-08 09:06:08 -08:00
wobsoriano
0fdb9e0e17 update colors 2022-11-08 09:05:36 -08:00
wobsoriano
5bd5756d26 update og image 2022-11-08 09:00:41 -08:00
wobsoriano
67f95756ab fix docs 2022-11-08 08:59:32 -08:00
wobsoriano
1fc4d9d0d0 Revert "feat: add file routing option"
This reverts commit 750783e860.
2022-11-05 21:24:24 -07:00
wobsoriano
c11a5cfa8a remove examples folder 2022-11-05 20:13:48 -07:00
wobsoriano
92c9f6390c disable file routing by default 2022-11-05 20:06:02 -07:00
wobsoriano
3a6c5b659b update function names 2022-11-05 19:50:39 -07:00
wobsoriano
750783e860 feat: add file routing option 2022-11-05 19:22:19 -07:00
wobsoriano
d9c8f877d3 eslint fixes 2022-11-05 12:57:45 -07:00
wobsoriano
e359702c41 eslint fixes 2022-11-05 11:56:14 -07:00
wobsoriano
e9081d00ad replace eslint config 2022-11-05 11:49:46 -07:00
wobsoriano
83f98e34fa more eslint fixes 2022-11-04 08:04:58 -07:00
wobsoriano
512a0ae7b1 more eslint fixes 2022-11-04 08:04:46 -07:00
wobsoriano
c89f8747ea bump local deps 2022-11-04 08:04:28 -07:00
wobsoriano
3e8a2de6e5 more eslint fixes 2022-11-04 08:02:52 -07:00
wobsoriano
5d98873cc3 eslint fix 2022-11-04 08:01:24 -07:00
wobsoriano
a8e5538b05 release v0.3.3 2022-11-04 07:58:20 -07:00
wobsoriano
24ecb41429 eslint fix 2022-11-04 07:58:16 -07:00
wobsoriano
e8bf427d2b fix types 2022-11-04 07:57:38 -07:00
wobsoriano
347d49482f reinstall deps 2022-11-04 07:55:39 -07:00
wobsoriano
2f7a1276ad feat(deps): bump @nuxt/kit to 3.0.0-rc.13 2022-11-04 07:53:42 -07:00
wobsoriano
f6db0c78cd add .vercel to .gitignore 2022-11-04 07:51:44 -07:00
wobsoriano
d6012eb5c8 feat: import vue functions from #imports 2022-11-04 07:49:37 -07:00
wobsoriano
c1ab3ecf77 update scripts 2022-11-04 07:44:09 -07:00
wobsoriano
0e8f6cf9f6 update playground 2022-11-04 07:41:27 -07:00
wobsoriano
0f5c09c7e0 update docs 2022-11-04 07:40:49 -07:00
wobsoriano
5080e9a4a7 bump local trpc deps to 10.0.0-rc.4 2022-11-04 07:39:50 -07:00
wobsoriano
7490dbd090 chore: bump to 0.4.0-beta.15 2022-11-04 07:37:49 -07:00
wobsoriano
1dc0ca7808 feat: remove custom async data error handler 2022-11-04 07:37:08 -07:00
wobsoriano
ffb692a168 feat(deps): bump nuxt to 3.0.0-rc.13 2022-11-04 07:34:47 -07:00
wobsoriano
d3203f0536 remove docs 2022-11-02 09:43:35 -07:00
wobsoriano
83e2b2810d release v0.3.2 2022-11-02 09:42:08 -07:00
wobsoriano
2b4fff9faa feat(deps): bump h3 to 0.8.6 2022-11-02 09:41:39 -07:00
wobsoriano
752fe721a2 feat(deps): lock @trpc/server and @trpc/client to version 9 2022-11-02 09:40:48 -07:00
wobsoriano
808cac4756 eslint fixes 2022-11-02 09:38:14 -07:00
wobsoriano
0c44f73c9f log info about plugin installation 2022-11-02 09:34:16 -07:00
wobsoriano
182875a781 feat: add option to specify if plugin should be installed 2022-11-02 09:30:40 -07:00
wobsoriano
0298f836b8 more eslint fixes 2022-11-02 09:21:15 -07:00
wobsoriano
ea50430945 eslint fixes 2022-11-02 09:18:17 -07:00
wobsoriano
0e240663ca remove local pnpm deps 2022-11-02 09:18:00 -07:00
wobsoriano
bb5e02383e remove unused moduile 2022-11-02 08:59:55 -07:00
wobsoriano
c01dddea02 remove local pnpm 2022-11-02 08:56:58 -07:00
wobsoriano
f92aec5b91 feat(deps): bump h3 to 0.8.6 2022-11-02 08:55:52 -07:00
wobsoriano
b6f92d954c update local trpc dependencies to 10.0.0-rc.3 2022-11-02 08:54:58 -07:00
wobsoriano
9108dcbb1d feat: never cache mutation 2022-10-31 22:39:40 -07:00
Robert Soriano
07f415640f bump to 0.4.0-beta.14 2022-10-31 10:09:07 -07:00
Robert Soriano
d5d211d2a8 feat: add subscription types 2022-10-31 10:06:41 -07:00
Robert Soriano
3bfd3585b3 remove unused types 2022-10-31 09:58:51 -07:00
Robert Soriano
8ba8d79114 remove unused generic type 2022-10-31 09:55:00 -07:00
Robert Soriano
b7f72eac0a feat: respect user added abort signal 2022-10-31 09:53:00 -07:00
Robert Soriano
4c8a6d7b35 feat: add abortOnUnmount option 2022-10-31 09:50:15 -07:00
Robert Soriano
76619ac541 bump to 0.4.0-beta.13 2022-10-31 01:01:44 -07:00
Robert Soriano
d5384cef02 add .vercel to ignored 2022-10-31 00:50:10 -07:00
Robert Soriano
fb3a0a834e add vercel static output to ignored 2022-10-31 00:43:08 -07:00
Robert Soriano
b58d662edc update docs 2022-10-31 00:37:45 -07:00
Robert Soriano
5d560867bb update http handler params 2022-10-30 22:24:49 -07:00
Robert Soriano
ac7fbf3998 update trpc param error handler 2022-10-30 22:21:08 -07:00
Robert Soriano
45fbab4c5f update docs 2022-10-30 21:40:20 -07:00
Robert Soriano
05ad1f96f6 export server types 2022-10-30 21:31:57 -07:00
Robert Soriano
41e6117113 add zod error formatting for playground 2022-10-30 21:30:07 -07:00
Robert Soriano
81c7608fb0 add batching and other opts 2022-10-30 21:25:37 -07:00
Robert Soriano
a614bc588e allow passing of other client options 2022-10-30 21:13:54 -07:00
Robert Soriano
3b0609e395 allow passing of other client options 2022-10-30 21:09:42 -07:00
Robert Soriano
0819c21b94 eslint fix 2022-10-30 18:19:32 -07:00
Robert Soriano
deea70b743 check trpc path via h3 context params 2022-10-30 18:17:14 -07:00
Robert Soriano
0ee322c8a2 run dev playground with concurrently 2022-10-30 17:35:23 -07:00
Robert Soriano
fc225ced0a bump to beta.12 2022-10-30 17:06:43 -07:00
Robert Soriano
b1d00c1f88 update compat 2022-10-30 17:06:35 -07:00
Robert Soriano
e0a6bb3576 bump to beta.11 2022-10-30 17:03:59 -07:00
Robert Soriano
fcd6cb1546 fix module compat 2022-10-30 17:03:49 -07:00
Robert Soriano
471ac30040 bump to beta.10 2022-10-30 17:00:27 -07:00
Robert Soriano
a7013db712 add module helper 2022-10-30 17:00:19 -07:00
Robert Soriano
bdcff360f0 bump to beta.9 2022-10-30 14:24:50 -07:00
Robert Soriano
1490790edc import composables from nuxt/app 2022-10-30 14:24:39 -07:00
Robert Soriano
4c5e6812b1 bump to beta.8 2022-10-30 13:36:28 -07:00
Robert Soriano
23d2954aae import composables from #imports 2022-10-30 13:35:58 -07:00
Robert Soriano
3c39746fa2 bump to beta.7 2022-10-30 13:31:04 -07:00
Robert Soriano
5fb7a9d444 import composables from nuxt/app 2022-10-30 13:30:57 -07:00
Robert Soriano
a2275567e8 bump to beta.6 2022-10-30 13:25:11 -07:00
Robert Soriano
c040db4308 update esm extensions to mjs 2022-10-30 13:24:39 -07:00
Robert Soriano
72755315a5 bump to beta.5 2022-10-30 13:09:58 -07:00
Robert Soriano
3d49810641 switch package type to module 2022-10-30 13:09:45 -07:00
Robert Soriano
ebb6637238 chore: release v0.4.0-beta.4 2022-10-30 13:02:11 -07:00
Robert Soriano
0c83ade918 update release script 2022-10-30 13:02:01 -07:00
Robert Soriano
97d9b3ddf8 import useAsyncData and useState from #app 2022-10-30 12:57:57 -07:00
Robert Soriano
eaa61f3700 bump local pnpm to 7.14.1 2022-10-30 12:35:30 -07:00
Robert Soriano
a5a9f430d5 chore: release v0.4.0-beta.3 2022-10-30 12:34:40 -07:00
Robert Soriano
94f59c396a update local deps 2022-10-30 12:30:03 -07:00
Robert Soriano
fe4c10ae25 remove outDir 2022-10-30 12:29:01 -07:00
Robert Soriano
7a97127353 update directory structure 2022-10-30 12:25:28 -07:00
Robert Soriano
0c4a43ec19 update playground 2022-10-30 12:19:57 -07:00
Robert Soriano
da6d738406 update docs 2022-10-30 12:00:21 -07:00
Robert Soriano
70c0b35c48 complete usage docs 2022-10-30 11:18:57 -07:00
Robert Soriano
da52b350ba add initial docs 2022-10-30 11:00:09 -07:00
Robert Soriano
b45c613ce7 immediately execute mutations 2022-10-30 01:52:20 -07:00
47 changed files with 4476 additions and 1769 deletions

2
.gitignore vendored
View File

@@ -49,3 +49,5 @@ coverage
Network Trash Folder
Temporary Items
.apdisk
.vercel

View File

@@ -1,10 +1,10 @@
# tRPC-Nuxt
[![Version](https://img.shields.io/npm/v/trpc-nuxt?style=flat&colorA=000000&colorB=000000)](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).
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

1
docs/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
.vercel

1
docs/README.md Normal file
View File

@@ -0,0 +1 @@
docs

5
docs/app.config.ts Normal file
View File

@@ -0,0 +1,5 @@
export default defineAppConfig({
docus: {
title: 'tRPC Nuxt'
}
})

View File

@@ -0,0 +1,52 @@
---
title: Installation
description: tRPC-Nuxt provides first class integration with tRPC.
---
# Installation
## 1. Add to existing Nuxt project
::code-group
```bash [pnpm]
pnpm add @trpc/server@next @trpc/client@next trpc-nuxt@beta zod
```
```bash [npm]
npm install @trpc/server@next @trpc/client@next trpc-nuxt@beta zod
```
```bash [yarn]
yarn add @trpc/server@next @trpc/client@next trpc-nuxt@beta 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.
## 2. Install module
This will transpile `trpc-nuxt` and exclude `trpc-nuxt/client` from optimized dependencies by Vite.
```ts [nuxt.config.ts]
export default defineNuxtConfig({
modules: ['trpc-nuxt/module']
})
```
::
## Next Steps
Now that you've installed the required dependencies, you are ready to start building your application.

View File

@@ -0,0 +1,140 @@
---
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 set of strongly-typed composables using your API's type signature.
```ts [plugins/client.ts]
import { httpBatchLink } from '@trpc/client'
import { createTRPCNuxtProxyClient } from 'trpc-nuxt/client'
import type { AppRouter } from '@/server/trpc/routers'
export default defineNuxtPlugin(() => {
const client = createTRPCNuxtProxyClient<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()
// query and mutate uses useAsyncData under the hood
const { data, pending, error } = await $client.hello.query({ text: 'client' })
</script>
<template>
<div v-if="pending">
Loading...
</div>
<div v-else-if="error?.data?.code">
Error: {{ error.data.code }}
</div>
<div v-else>
<p>{{ hello.data?.greeting }}</p>
</div>
</template>
```

View File

@@ -0,0 +1,6 @@
---
title: Basic
description: tRPC-Nuxt provides first class integration with tRPC.
---
# Basic Example

View 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
View File

@@ -0,0 +1,31 @@
---
title: "tRPC Nuxt"
description: "A supa simple wrapper arousnd supabase-js to enable usage and integration within Nuxt."
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@beta
---
#title
tRPC [Nuxt]{.text-primary-500}
#description
End-to-end typesafe APIs in Nuxt applications.
#extra
::list
- Automatic typesafety
- Snappy DX
- Autocompletion
::
::

26
docs/nuxt.config.ts Normal file
View File

@@ -0,0 +1,26 @@
export default defineNuxtConfig({
app: {
pageTransition: false,
layoutTransition: false
},
modules: ['@nuxtlabs/github-module'],
extends: process.env.DOCUS_THEME_PATH || '@nuxt-themes/docus',
github: {
owner: 'nuxt',
repo: 'content',
branch: 'main'
},
colorMode: {
preference: 'dark'
},
build: {
transpile: [/content-edge/, /github-module/]
},
nitro: {
prerender: {
crawlLinks: true,
routes: ['/']
},
preset: 'vercel'
}
})

19
docs/package.json Normal file
View File

@@ -0,0 +1,19 @@
{
"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-rc.13",
"@nuxtjs/tailwindcss": "^6.1.3"
},
"devDependencies": {
"@nuxt-themes/docus": "npm:@nuxt-themes/docus-edge@latest",
"@nuxtlabs/github-module": "npm:@nuxtlabs/github-module-edge@latest"
},
"packageManager": "yarn@1.22.19"
}

26
docs/tokens.config.ts Normal file
View File

@@ -0,0 +1,26 @@
import { defineTheme } from 'pinceau'
export default defineTheme({
title: 'tRPC-Nuxt',
cover: {
src: 'https://og-image.vercel.app/tRPC-Nuxt',
alt: 'tRPC-Nuxt conver'
},
aside: {
level: 1
},
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
View File

@@ -0,0 +1,3 @@
{
"extends": "./.nuxt/tsconfig.json"
}

17
module.mjs Normal file
View File

@@ -0,0 +1,17 @@
import { defineNuxtModule } from '@nuxt/kit'
export default defineNuxtModule({
meta: {
name: 'trpc-nuxt',
configKey: 'trpc',
compatibility: {
nuxt: '^3.0.0-rc.13'
}
},
setup (_moduleOptions, nuxt) {
nuxt.options.build.transpile.push('trpc-nuxt')
nuxt.options.vite.optimizeDeps = nuxt.options.vite.optimizeDeps || {}
nuxt.options.vite.optimizeDeps.exclude = nuxt.options.vite.optimizeDeps.exclude || []
nuxt.options.vite.optimizeDeps.exclude.push('trpc-nuxt/client')
}
})

View File

@@ -1,20 +1,82 @@
{
"name": "trpc-nuxt-workspace",
"packageManager": "pnpm@7.5.0",
"name": "trpc-nuxt",
"type": "module",
"version": "0.4.0",
"license": "MIT",
"sideEffects": false,
"exports": {
"./package.json": "./package.json",
".": {
"require": "./dist/index.cjs",
"import": "./dist/index.mjs"
},
"./client": {
"require": "./dist/client/index.cjs",
"import": "./dist/client/index.mjs"
},
"./module": {
"import": "./module.mjs"
}
},
"main": "./dist/index.mjs",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"files": [
"dist",
"client.d.ts",
"module.mjs"
],
"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-proxy-beta.21",
"@trpc/server": "^10.0.0-proxy-beta.21"
},
"dependencies": {
"h3": "^0.8.6",
"nanoid": "^4.0.0",
"nuxt": "^3.0.0-rc.13",
"ohash": "^0.1.5",
"ufo": "^0.8.6"
},
"devDependencies": {
"@antfu/eslint-config": "^0.27.0",
"@antfu/ni": "^0.18.3",
"@nuxt/kit": "3.0.0-rc.13",
"@nuxtjs/eslint-config-typescript": "^11.0.0",
"@trpc/client": "10.0.0-rc.7",
"@trpc/server": "10.0.0-rc.7",
"bumpp": "^8.2.1",
"concurrently": "^7.5.0",
"eslint": "^8.25.0",
"pnpm": "^7.5.0"
"tsup": "6.4.0",
"typescript": "^4.7.4"
},
"pnpm": {
"patchedDependencies": {
"nuxt@3.0.0-rc.13": "patches/nuxt@3.0.0-rc.13.patch"
}
},
"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"
]
}

View File

@@ -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,
},
}
})

View File

@@ -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"
}
}
}

View File

@@ -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),
}))
}

View File

@@ -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;
}

View File

@@ -1,3 +0,0 @@
{
"extends": "../../tsconfig.json"
}

View File

@@ -0,0 +1,22 @@
diff --git a/dist/head/runtime/lib/vueuse-head.plugin.mjs b/dist/head/runtime/lib/vueuse-head.plugin.mjs
index a3278e56986d8e8efb099c502c82d9661a36d846..148a8879ba433072cecd15995cfd5b1b69941124 100644
--- a/dist/head/runtime/lib/vueuse-head.plugin.mjs
+++ b/dist/head/runtime/lib/vueuse-head.plugin.mjs
@@ -4,7 +4,7 @@ import { defineNuxtPlugin, useRouter } from "#app";
import { appHead } from "#build/nuxt.config.mjs";
export default defineNuxtPlugin((nuxtApp) => {
const head = createHead();
- head.addEntry(appHead, { resolved: true });
+ head.addHeadObjs(appHead, { resolved: true });
nuxtApp.vueApp.use(head);
if (process.client) {
let pauseDOMUpdates = true;
@@ -25,7 +25,7 @@ export default defineNuxtPlugin((nuxtApp) => {
}
nuxtApp._useHead = (_meta, options) => {
if (process.server) {
- head.addEntry(_meta, options);
+ head.addHeadObjs(_meta, options);
return;
}
const cleanUp = head.addReactiveEntry(_meta, options);

View File

@@ -1,9 +1,4 @@
// https://v3.nuxtjs.org/api/configuration/nuxt.config
export default defineNuxtConfig({
runtimeConfig: {
baseURL: '',
},
typescript: {
strict: true,
},
modules: ['trpc-nuxt/module']
})

View File

@@ -9,11 +9,13 @@
"postinstall": "nuxt prepare"
},
"dependencies": {
"@trpc/client": "10.0.0-rc.7",
"@trpc/server": "10.0.0-rc.7",
"superjson": "^1.11.0",
"trpc-nuxt": "workspace:*",
"zod": "^3.19.1"
},
"devDependencies": {
"nuxt": "3.0.0-rc.12"
"nuxt": "^3.0.0-rc.13"
}
}

View File

@@ -11,21 +11,23 @@ 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.data.value)
} catch (e) {
console.log(e)
}
}
const { data: todos, pending, error, refresh } = await $client.todo.getTodos.query()
const { data: todos, pending, error, refresh } = await $client.todo.getTodos.query(undefined, {
trpc: {
abortOnUnmount: true
}
})
</script>
<template>

View File

@@ -0,0 +1,27 @@
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(() => {
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'
})
]
})
return {
provide: {
client
}
}
})

View File

@@ -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
*/

View File

@@ -8,8 +8,8 @@ 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 (
opts: H3Event
) {
// for API-response caching see https://trpc.io/docs/caching

View File

@@ -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

View File

@@ -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
})
}),
})
})

View File

@@ -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
})
}),
})
})

View File

@@ -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
}
}
}
})
/**

5196
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,2 +1,3 @@
packages:
- packages/*
- playground
- docs

66
src/client/index.ts Normal file
View File

@@ -0,0 +1,66 @@
import type { CreateTRPCClientOptions, inferRouterProxyClient } from '@trpc/client'
import { createTRPCProxyClient } from '@trpc/client'
import type {
AnyRouter
} from '@trpc/server'
import { createFlatProxy, createRecursiveProxy } from '@trpc/server/shared'
import { hash } from 'ohash'
import { nanoid } from 'nanoid'
import type { DecoratedProcedureRecord } from './types'
// @ts-expect-error: Nuxt auto-imports
import { getCurrentInstance, onScopeDispose, useAsyncData } from '#imports'
/**
* Calculates the key used for `useAsyncData` call
*/
export function getQueryKey (
path: string,
input: unknown
): string {
return input === undefined ? path : `${path}-${hash(input || '')}`
}
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()`
const lastArg = pathCopy.pop()!
const path = pathCopy.join('.')
const [input, otherOptions] = args
const queryKey = lastArg === 'mutate' ? nanoid() : getQueryKey(path, input)
const { trpc, ...asyncDataOptions } = otherOptions || {} as any
let controller: AbortController
if (trpc?.abortOnUnmount) {
if (getCurrentInstance()) {
onScopeDispose(() => {
controller?.abort?.()
})
}
controller = typeof AbortController !== 'undefined' ? new AbortController() : {} as AbortController
}
return useAsyncData(queryKey, () => (client as any)[path][lastArg](input, {
signal: controller?.signal,
...trpc
}), asyncDataOptions)
})
}
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'], TRouter>
return decoratedClient
}

85
src/client/types.ts Normal file
View File

@@ -0,0 +1,85 @@
import type { TRPCClientErrorLike, TRPCRequestOptions } from '@trpc/client'
import type { TRPCSubscriptionObserver } from '@trpc/client/dist/internals/TRPCClient'
import type {
AnyMutationProcedure,
AnyProcedure,
AnyQueryProcedure,
AnyRouter,
AnySubscriptionProcedure,
ProcedureArgs,
ProcedureRouterRecord,
inferProcedureInput,
inferProcedureOutput
} from '@trpc/server'
import type { Unsubscribable, inferObservableValue } from '@trpc/server/observable'
import type {
AsyncData,
AsyncDataOptions,
KeyOfRes,
PickFrom,
_Transform
} from 'nuxt/dist/app/composables/asyncData'
// Modified @trpc/client and @trpc/react-query types
// https://github.com/trpc/trpc/blob/next/packages/client/src/createTRPCClientProxy.ts
// https://github.com/trpc/trpc/blob/next/packages/react-query/src/createTRPCReact.tsx
interface TRPCOptions extends TRPCRequestOptions {
abortOnUnmount?: boolean
}
type SubscriptionResolver<
TProcedure extends AnyProcedure,
TRouter extends AnyRouter,
> = (
...args: [
input: ProcedureArgs<TProcedure['_def']>[0],
opts: ProcedureArgs<TProcedure['_def']>[1] &
Partial<
TRPCSubscriptionObserver<
inferObservableValue<inferProcedureOutput<TProcedure>>,
TRPCClientErrorLike<TRouter>
>
>,
]
) => Unsubscribable
type DecorateProcedure<
TProcedure extends AnyProcedure,
TRouter extends AnyRouter,
> = 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> & { trpc: TRPCOptions },
) => 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> & { trpc: TRPCOptions },
) => AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TRPCClientErrorLike<TProcedure>>
} : TProcedure extends AnySubscriptionProcedure ? {
subscribe: SubscriptionResolver<TProcedure, TRouter>
} : never
/**
* @internal
*/
export type DecoratedProcedureRecord<
TProcedures extends ProcedureRouterRecord,
TRouter extends AnyRouter,
> = {
[TKey in keyof TProcedures]: TProcedures[TKey] extends AnyRouter
? DecoratedProcedureRecord<TProcedures[TKey]['_def']['record'], TRouter>
: TProcedures[TKey] extends AnyProcedure
? DecorateProcedure<TProcedures[TKey], TRouter>
: never;
}

View File

@@ -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>
@@ -37,44 +39,78 @@ export interface OnErrorPayload<TRouter extends AnyRouter> {
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,
res
} = event
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

View File

@@ -10,7 +10,7 @@
"noImplicitAny": true,
"allowJs": true,
"noEmit": true,
"outDir": "dist",
"resolveJsonModule": true
"resolveJsonModule": true,
"skipDefaultLibCheck": true
}
}

View File

@@ -5,6 +5,11 @@ export default defineConfig({
format: ['cjs', 'esm'],
splitting: false,
clean: true,
external: ['#app'],
external: ['#app', '#imports'],
dts: true,
outExtension({ format }) {
return {
js: format === 'esm' ? '.mjs' : `.${format}`,
}
},
})