@edium/halifax 2.2.0 → 2.2.1

package/README.md

@@ -65,69 +65,40 @@ Halifax ships as two packages from the same repository:
 | [`@edium/halifax`](https://www.npmjs.com/package/@edium/halifax)               | Server — auto-CRUD engine, adapters, auth, caching, OpenAPI                 |
 | [`@edium/halifax-client`](https://www.npmjs.com/package/@edium/halifax-client) | Browser/Node client — typed CRUD, query builder, TanStack Query integration |
 
-## Browser Client — React & Vue
+## Browser Client
 
 [`@edium/halifax-client`](https://www.npmjs.com/package/@edium/halifax-client) is the companion
 frontend package. It ships a fully-typed resource client, a fluent query builder, and **built-in
 TanStack Query option factories** so list/detail queries and mutations wire up in a few lines —
-with automatic cache invalidation on writes.
+with automatic cache invalidation on writes. Five HTTP transports ship out of the box: `fetch`
+(default), `axios`, `ky`, `ofetch`, and `superagent` — swap with one line.
 
 ```bash
 pnpm add @edium/halifax-client
-
-# add whichever TanStack Query adapter your framework uses
 pnpm add @tanstack/react-query   # React
 pnpm add @tanstack/vue-query     # Vue
 ```
 
-**React**
-
-```tsx
-import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query'
-import { HalifaxClient } from '@edium/halifax-client'
+```ts
+import { HalifaxClient, QueryBuilder, SqlComparison } from '@edium/halifax-client'
 
 const client = new HalifaxClient({ baseUrl: '/api/v1' })
-const posts = client.resource<Post, NewPost, PatchPost>('posts')
-
-// Paginated list — queryKey is managed for you
-function usePostList(page: number) {
-  return useQuery(posts.getManyOptions({ limit: 20, offset: page * 20 }))
-}
+const posts = client.resource<Post, Omit<Post, 'id'>, Partial<Omit<Post, 'id'>>>('posts')
 
-// Create with automatic list invalidation
-function useCreatePost() {
-  const qc = useQueryClient()
-  return useMutation({
-    ...posts.createOneMutation(),
-    onSuccess: () => qc.invalidateQueries({ queryKey: posts.queryKey() })
-  })
-}
-```
+// CRUD
+const { results, count } = await posts.getMany({ limit: 20 })
+const post = await posts.getOne(1)
+await posts.createOne({ title: 'Hello', published: false })
 
-**Vue**
+// Query builder — sends to POST /posts/query
+const q = new QueryBuilder().where('published', SqlComparison.Equal, true).limit(10)
+const { results: published } = await posts.query(q)
 
-```ts
-import { computed, ref } from 'vue'
-import { useQuery, useMutation, useQueryClient } from '@tanstack/vue-query'
-import { HalifaxClient } from '@edium/halifax-client'
-
-const client = new HalifaxClient({ baseUrl: '/api/v1' })
-const posts = client.resource<Post, NewPost, PatchPost>('posts')
-
-// Reactive query — re-fetches automatically when page changes
-const page = ref(0)
-const postList = useQuery(computed(() => posts.getManyOptions({ limit: 20, offset: page.value * 20 })))
-
-// Mutation with cache invalidation
-const qc = useQueryClient()
-const createPost = useMutation({
-  ...posts.createOneMutation(),
-  onSuccess: () => qc.invalidateQueries({ queryKey: posts.queryKey() })
-})
+// React — queryKey + queryFn wired automatically
+const { data } = useQuery(posts.getManyOptions({ limit: 20 }))
 ```
 
-Five HTTP transports are included out of the box: `fetch` (default), `axios`, `ky`, `ofetch`, and
-`superagent` — swap with one line. Full docs: [README_CLIENT.md](./README_CLIENT.md).
+Full docs: [README_CLIENT.md](./README_CLIENT.md) · [npm](https://www.npmjs.com/package/@edium/halifax-client)
 
 ---
 
@@ -188,7 +159,7 @@ app.listen(3000)
 
 | Guide                                                | Contents                                                                                                 |
 | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| [README_CLIENT.md](./README_CLIENT.md)               | `@edium/halifax-client` — install, transports, query builder, React & Vue TanStack Query examples       |
+| [README_CLIENT.md](./README_CLIENT.md) · [npm](https://www.npmjs.com/package/@edium/halifax-client) | `@edium/halifax-client` — install, transports, query builder, React & Vue TanStack Query examples |
 | [README_AUTOCRUD.md](./README_AUTOCRUD.md)           | Resource definitions, field flags, ID types, pagination, query-string filtering, error shapes            |
 | [README_REPO_ADAPTERS.md](./README_REPO_ADAPTERS.md) | Prisma 7 (and 6) setup, `PrismaAdapter`, `DrizzleAdapter`, capabilities, custom repositories             |
 | [README_HTTP_ADAPTERS.md](./README_HTTP_ADAPTERS.md) | Express, Fastify, HyperExpress & Ultimate Express adapters, and custom HTTP adapters                     |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edium/halifax",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Auto-generate type-safe REST CRUD APIs from your data models. Adapter-driven: Express/Fastify/HyperExpress, Prisma (PostgreSQL, MySQL, MariaDB, SQL Server, CockroachDB, SQLite), JWT/API-key auth, multi-tenancy, a dynamic query builder, and pluggable Redis caching.",
   "author": "David LaTour <david@edium.com>",
   "homepage": "https://github.com/splayfee/halifax#readme",
@@ -166,7 +166,7 @@
   ],
   "dependencies": {
     "uuid": "^14.0.0",
-    "@edium/halifax-types": "0.1.0"
+    "@edium/halifax-types": "2.2.1"
   },
   "scripts": {
     "preinstall": "node -e \"const ua = process.env.npm_config_user_agent; if (ua && !ua.startsWith('pnpm')) { console.error('\\nERROR: This repo requires pnpm. Run: pnpm install\\n'); process.exit(1); }\"",