Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/otahontas/trpc-rtk-query
Automatically generate RTK Query api endpoints from your tRPC setup
https://github.com/otahontas/trpc-rtk-query
react redux redux-toolkit rtk-query trpc typescript
Last synced: about 1 month ago
JSON representation
Automatically generate RTK Query api endpoints from your tRPC setup
- Host: GitHub
- URL: https://github.com/otahontas/trpc-rtk-query
- Owner: otahontas
- License: mit
- Created: 2023-06-14T07:19:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-01T13:37:56.000Z (about 2 months ago)
- Last Synced: 2024-08-01T14:57:33.609Z (about 2 months ago)
- Topics: react, redux, redux-toolkit, rtk-query, trpc, typescript
- Language: TypeScript
- Homepage:
- Size: 1.44 MB
- Stars: 33
- Watchers: 1
- Forks: 4
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
trpc-rtk-query
#### `trpc-rtk-query` is the tool for automatically generating RTK Query api endpoints from your tRPC setup!
---
## **[RTK Query](https://redux-toolkit.js.org/rtk-query/overview) support for [tRPC](https://trpc.io/)** 🧩
- Automatically generate **typesafe** `RTK Query hooks` (for react) from your `tRPC` procedures.
- Perfect for incremental adoption.
- Any feedback, issues, or pull requests are highly appreciated
```typescript
const api = enhanceApi({
api: rtkApi, /* Your api created with rtk query */
client: trpcClient, /* 👈 The trpc magic happens when passing in the typed client ✨ */
});
export { useUserListQuery } from api; // Automatically typed hooks thanks to the power of tRPC + RTK!
```
## Usage
### Installation
**1. Install `trpc-rtk-query` and peer dependencies.**
```bash
# npm
npm install trpc-rtk-query @reduxjs/toolkit @trpc/client @trpc/server
# yarn
yarn add trpc-rtk-query @reduxjs/toolkit @trpc/client @trpc/server
```
Note the minimum versions for packages, we only support trpc v10 and rtk query v2.
**2. Use your `tRPC router`.**
```typescript
/* server.ts */
import { initTRPC } from "@trpc/server";
import { z } from "zod";
import { db as database } from "./db";
const t = initTRPC.create();
export const publicProcedure = t.procedure;
const appRouter = t.router({
userList: publicProcedure
.input(z.object({ showAll: z.boolean() })) // <- type is { showAll: boolean }
.query(async () => {
// Retrieve users from a datasource, this is an imaginary database
return await database.user.findMany(); // <- returns type User[]
}),
});
export type AppRouter = typeof appRouter
```
**3. Create a new tRPC Client.**
Create your api [like normal](https://trpc.io/docs/client/vanilla):
```typescript
// client.ts
const client = createTRPCProxyClient({
links: [
httpBatchLink({
url: 'http://localhost:3000/trpc',
// You can pass any HTTP headers you wish here
async headers() {
return {
authorization: getAuthCookie(),
};
},
}),
],
});
```
**4. Create a trpc-rtk query api.**
```typescript
// api.ts
import { createApi } from "@reduxjs/toolkit/query/react";
import { enhanceApi } from "trpc-rtk-query";
// Use function provided by rtk to create your api
const rtkApi = createApi({
baseQuery: fetchBaseQuery({ baseUrl: "/" }),
endpoints: () => ({}),
})
// Enhance the api with hooks
export const api = enhanceApi({
client, // <- typed client from step 3
api: rtkApi // <- api from rtk
// pass in any endpoint specific options, such as providesTags or onQueryStarted for optimistic updates
endpointOptions: {
userList: {
providesTags: ["User"]
}
}
});
export { useUserListQuery } from api; // <- export your typed hooks!
```
You can also use `createEmptyApi` helper function as follows:
```typescript
// api.ts
import { createEmptyApi, enhanceApi } from "trpc-rtk-query";
// Enhance an empty api with hooks
export const api = enhanceApi({
client, // <- typed client from step 3
api: createEmptyApi(), // <- createEmptyApi generates base api without any endpoints.
// pass in any endpoint specific options, such as providesTags or onQueryStarted for optimistic updates
endpointOptions: {
userList: {
providesTags: ["User"]
}
}
});
export { useUserListQuery } from api; // <- export your typed hooks!
**5. Add the typesafe API to the store.**
This is the same step as you would [normally do](https://redux-toolkit.js.org/rtk-query/overview).
```typescript
// store.ts
import { configureStore } from '@reduxjs/toolkit'
import { api } from './api.ts'
export const store = configureStore({
reducer: {
[api.reducerPath]: api.reducer,
},
middleware: (getDefaultMiddleware) =>
getDefaultMiddleware().concat(api.middleware),
})
```
**6. Enjoy type-safe hooks.**
```typescript
// app.ts
import { useUserListQuery } from "./api.ts"
const App = () => {
const { data, isLoading } = useUserListQuery({ showAll: true })
// ^ Use your generated hooks! They are fully typed based on your trpc router.
if (isLoading) return
Loading...
if (!data) return No data!
return {JSON.strinfigy(data)}
// ^ type: User[]
}
```
# Development status
This library is currently in the alpha stage. 0.x.x versions are being published to npm for people to try this out, but you shouldn't consider it ready for production anytime soon. See the [project status](https://github.com/users/otahontas/projects/2) for what's under development and planned to be done before first major 1.0.0 will be released.