graphql-suite 0.8.3 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -18
- package/client.d.ts +1 -0
- package/client.js +1 -0
- package/package.json +26 -5
- package/query.d.ts +1 -0
- package/query.js +1 -0
- package/schema.d.ts +1 -0
- package/schema.js +1 -0
package/README.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
[](https://www.npmjs.com/package/graphql-suite)
|
|
2
|
+
[](https://www.npmjs.com/package/graphql-suite)
|
|
3
|
+
[](https://github.com/annexare/graphql-suite/actions/workflows/ci.yml)
|
|
4
4
|
|
|
5
|
-
#
|
|
5
|
+
# graphql-suite
|
|
6
6
|
|
|
7
7
|
Auto-generated GraphQL CRUD, type-safe clients, and React Query hooks from Drizzle PostgreSQL schemas.
|
|
8
8
|
|
|
9
9
|
## Overview
|
|
10
10
|
|
|
11
|
-
`
|
|
11
|
+
`graphql-suite` is a three-layer toolkit that turns your Drizzle ORM schema into a fully working GraphQL API with end-to-end type safety:
|
|
12
12
|
|
|
13
13
|
1. **Schema builder** — generates a complete GraphQL schema with CRUD operations, relation-level filtering, per-operation hooks, and runtime permissions from Drizzle table definitions.
|
|
14
14
|
2. **Client** — provides a type-safe GraphQL client that infers query/mutation types directly from your Drizzle schema, with full TypeScript support for filters, relations, and results.
|
|
@@ -20,18 +20,18 @@ Inspired by [`drizzle-graphql`](https://github.com/drizzle-team/drizzle-graphql)
|
|
|
20
20
|
|
|
21
21
|
| Subpath | Package | Description |
|
|
22
22
|
|---------|---------|-------------|
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
23
|
+
| `graphql-suite/schema` | [`@graphql-suite/schema`](packages/schema/README.md) | GraphQL schema builder with CRUD, filtering, hooks, permissions, and codegen |
|
|
24
|
+
| `graphql-suite/client` | [`@graphql-suite/client`](packages/client/README.md) | Type-safe GraphQL client with full Drizzle type inference |
|
|
25
|
+
| `graphql-suite/query` | [`@graphql-suite/query`](packages/query/README.md) | TanStack React Query hooks for the client |
|
|
26
26
|
|
|
27
27
|
## Installation
|
|
28
28
|
|
|
29
29
|
```bash
|
|
30
|
-
bun add
|
|
30
|
+
bun add graphql-suite
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
|
-
npm install
|
|
34
|
+
npm install graphql-suite
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
## Peer Dependencies
|
|
@@ -49,7 +49,7 @@ Each subpath import has its own peer dependency requirements:
|
|
|
49
49
|
### 1. Server — Build GraphQL Schema
|
|
50
50
|
|
|
51
51
|
```ts
|
|
52
|
-
import { buildSchema } from '
|
|
52
|
+
import { buildSchema } from 'graphql-suite/schema'
|
|
53
53
|
import { createYoga } from 'graphql-yoga'
|
|
54
54
|
import { createServer } from 'node:http'
|
|
55
55
|
import { db } from './db'
|
|
@@ -75,7 +75,7 @@ server.listen(4000)
|
|
|
75
75
|
#### Per-Role Schemas (Optional)
|
|
76
76
|
|
|
77
77
|
```ts
|
|
78
|
-
import { permissive, restricted, readOnly } from '
|
|
78
|
+
import { permissive, restricted, readOnly } from 'graphql-suite/schema'
|
|
79
79
|
|
|
80
80
|
// Cached per id — call withPermissions on each request
|
|
81
81
|
const schemas = {
|
|
@@ -88,7 +88,7 @@ const schemas = {
|
|
|
88
88
|
### 2. Client — Type-Safe Queries
|
|
89
89
|
|
|
90
90
|
```ts
|
|
91
|
-
import { createDrizzleClient } from '
|
|
91
|
+
import { createDrizzleClient } from 'graphql-suite/client'
|
|
92
92
|
import * as schema from './db/schema'
|
|
93
93
|
|
|
94
94
|
const client = createDrizzleClient({
|
|
@@ -111,7 +111,7 @@ const users = await client.entity('user').query({
|
|
|
111
111
|
### 3. React — Query Hooks
|
|
112
112
|
|
|
113
113
|
```tsx
|
|
114
|
-
import { GraphQLProvider, useEntity, useEntityList } from '
|
|
114
|
+
import { GraphQLProvider, useEntity, useEntityList } from 'graphql-suite/query'
|
|
115
115
|
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
|
|
116
116
|
|
|
117
117
|
const queryClient = new QueryClient()
|
|
@@ -147,7 +147,7 @@ function UserList() {
|
|
|
147
147
|
```ts
|
|
148
148
|
// app/api/graphql/route.ts
|
|
149
149
|
import { createYoga } from 'graphql-yoga'
|
|
150
|
-
import { buildSchema } from '
|
|
150
|
+
import { buildSchema } from 'graphql-suite/schema'
|
|
151
151
|
import { db } from '@/db'
|
|
152
152
|
|
|
153
153
|
const { schema } = buildSchema(db)
|
|
@@ -167,7 +167,7 @@ export { handleRequest as GET, handleRequest as POST }
|
|
|
167
167
|
// server.ts
|
|
168
168
|
import { Elysia } from 'elysia'
|
|
169
169
|
import { yoga } from '@elysiajs/graphql-yoga'
|
|
170
|
-
import { buildSchema } from '
|
|
170
|
+
import { buildSchema } from 'graphql-suite/schema'
|
|
171
171
|
import { db } from './db'
|
|
172
172
|
|
|
173
173
|
const { schema } = buildSchema(db)
|
|
@@ -182,8 +182,8 @@ new Elysia()
|
|
|
182
182
|
This repo includes a [skills.sh](https://skills.sh) skill that provides AI coding agents (Claude Code, Cursor, etc.) with accurate, up-to-date guidance for all three packages.
|
|
183
183
|
|
|
184
184
|
```bash
|
|
185
|
-
bunx skills add annexare/
|
|
186
|
-
# or: npx skills add annexare/
|
|
185
|
+
bunx skills add annexare/graphql-suite
|
|
186
|
+
# or: npx skills add annexare/graphql-suite
|
|
187
187
|
```
|
|
188
188
|
|
|
189
189
|
## License
|
package/client.d.ts
CHANGED
package/client.js
CHANGED
package/package.json
CHANGED
|
@@ -1,13 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "graphql-suite",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"description": "Auto-generated GraphQL CRUD, type-safe clients, and React Query hooks from Drizzle PostgreSQL schemas",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "https://github.com/dmythro",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "https://github.com/annexare/
|
|
9
|
+
"url": "https://github.com/annexare/graphql-suite.git"
|
|
10
10
|
},
|
|
11
|
+
"keywords": [
|
|
12
|
+
"drizzle",
|
|
13
|
+
"graphql",
|
|
14
|
+
"orm",
|
|
15
|
+
"postgresql",
|
|
16
|
+
"postgres",
|
|
17
|
+
"typescript",
|
|
18
|
+
"crud",
|
|
19
|
+
"react",
|
|
20
|
+
"react-query",
|
|
21
|
+
"tanstack",
|
|
22
|
+
"type-safe",
|
|
23
|
+
"schema",
|
|
24
|
+
"api"
|
|
25
|
+
],
|
|
11
26
|
"type": "module",
|
|
12
27
|
"publishConfig": {
|
|
13
28
|
"access": "public"
|
|
@@ -37,8 +52,14 @@
|
|
|
37
52
|
}
|
|
38
53
|
},
|
|
39
54
|
"dependencies": {
|
|
40
|
-
"@graphql-suite/schema": "0.
|
|
41
|
-
"@graphql-suite/client": "0.
|
|
42
|
-
"@graphql-suite/query": "0.
|
|
55
|
+
"@graphql-suite/schema": "0.9.0",
|
|
56
|
+
"@graphql-suite/client": "0.9.0",
|
|
57
|
+
"@graphql-suite/query": "0.9.0"
|
|
58
|
+
},
|
|
59
|
+
"peerDependencies": {
|
|
60
|
+
"drizzle-orm": ">=0.44.0",
|
|
61
|
+
"graphql": ">=16.3.0",
|
|
62
|
+
"@tanstack/react-query": ">=5.0.0",
|
|
63
|
+
"react": ">=18.0.0"
|
|
43
64
|
}
|
|
44
65
|
}
|
package/query.d.ts
CHANGED
package/query.js
CHANGED
package/schema.d.ts
CHANGED
package/schema.js
CHANGED