@drizzle-graphql-suite/schema 0.5.0 → 0.6.0

package/README.md

@@ -1,17 +1,41 @@
 # @drizzle-graphql-suite/schema
 
+> Part of [`drizzle-graphql-suite`](https://github.com/annexare/drizzle-graphql-suite).
+> See also: [`client`](https://github.com/annexare/drizzle-graphql-suite/tree/main/packages/client) | [`query`](https://github.com/annexare/drizzle-graphql-suite/tree/main/packages/query)
+
 Auto-generates a complete GraphQL schema with CRUD operations, relation-level filtering, and hooks from Drizzle PostgreSQL schemas.
 
+## Installation
+
+```bash
+bun add @drizzle-graphql-suite/schema
+```
+
+```bash
+npm install @drizzle-graphql-suite/schema
+```
+
+Or install the full suite:
+
+```bash
+bun add drizzle-graphql-suite
+```
+
+```bash
+npm install drizzle-graphql-suite
+```
+
 ## Motivation
 
 Inspired by [`drizzle-graphql`](https://github.com/drizzle-team/drizzle-graphql), this package is a purpose-built replacement focused on PostgreSQL. Key improvements:
 
+- **Small generated schema** — the generated schema stays compact even when supporting self-relations and deeply nested relations, thanks to configurable depth limiting (`limitRelationDepth`, `limitSelfRelationDepth`), per-relation pruning (`pruneRelations`), and per-table control (`tables.exclude`, per-table `queries`/`mutations` toggles) — up to 90% schema size reduction when tuned
+- **Native PostgreSQL JSON/JSONB support** — `json` and `jsonb` columns map to a custom `JSON` GraphQL scalar, so structured data passes through without manual type wiring
 - **Relation-level filtering** with EXISTS subqueries (`some`/`every`/`none` quantifiers)
 - **Per-operation hooks system** (before/after/resolve) for auth, audit, and custom logic
 - **Count queries** with full filter support
 - **`buildEntities()`** for composable schema building (avoids redundant schema validation)
 - **Configurable query/mutation suffixes** for naming customization
-- **Per-table schema control** — exclude tables, disable queries/mutations per table (up to 90% schema size reduction)
 - **Self-relation depth limiting** — separate from general depth, prevents exponential type growth
 - **Relation pruning** — `false`, `'leaf'`, or `{ only: [...] }` per relation
 - **`buildSchemaFromDrizzle()`** — no database connection needed (for codegen/introspection)
@@ -38,6 +62,37 @@ const { schema, entities } = buildSchema(db, {
 const yoga = createYoga({ schema })
 ```
 
+#### Framework Integration
+
+**Next.js App Router**
+
+```ts
+// app/api/graphql/route.ts
+import { createYoga } from 'graphql-yoga'
+import { schema } from '@/lib/schema' // from buildSchema() above
+
+const { handleRequest } = createYoga({
+  schema,
+  graphqlEndpoint: '/api/graphql',
+  fetchAPI: { Response },
+})
+
+export { handleRequest as GET, handleRequest as POST }
+```
+
+**ElysiaJS**
+
+```ts
+// server.ts
+import { Elysia } from 'elysia'
+import { yoga } from '@elysiajs/graphql-yoga'
+import { schema } from './schema' // from buildSchema() above
+
+new Elysia()
+  .use(yoga({ schema }))
+  .listen(3000)
+```
+
 ### `buildEntities(db, config?)`
 
 Returns `GeneratedEntities` only — queries, mutations, inputs, and types — without constructing a `GraphQLSchema`. Use this when composing into a larger schema (e.g., Pothos) to avoid redundant schema validation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drizzle-graphql-suite/schema",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "GraphQL schema builder with CRUD operations, relation filtering, and hooks from Drizzle ORM",
   "license": "MIT",
   "author": "https://github.com/dmythro",