@emeryld/rrroutes-client 2.6.6 → 2.6.8

package/README.md

@@ -1,7 +1,7 @@
 <!--
 Summary:
 - Added comprehensive usage for `createRouteClient`, built endpoints (GET/feeds/mutations), cache helpers, invalidation, debug modes, custom fetchers, and React Query integration.
-- Added new sections for router helpers, infinite/feeds, FormData uploads, and socket utilities (SocketClient, provider hooks, socketed routes).
+- Added new sections for router helpers, batched branches (`buildBranch`), infinite/feeds, FormData uploads, and socket utilities (SocketClient, provider hooks, socketed routes).
 - Removed the sparse README and outdated publishing script focus; future additions should cover server-side Socket.IO envelope expectations and testing recipes for hooks.
 -->
 
@@ -220,7 +220,53 @@ const listUsers = buildRoute('listUsers') // builds from routes.listUsers
 const updateUser = buildRoute('updateUser', {}, { name: 'profile' }) // debug name filtering
 ```
 
-### 8) File uploads (FormData)
+### 8) Batch multiple built endpoints (`buildBranch`)
+
+`buildBranch` lets you batch already-built endpoints behind one batch path.
+
+```ts
+const getUser = client.build(registry.byKey['GET /v1/users/:userId'])
+const updateUser = client.build(registry.byKey['PATCH /v1/users/:userId'])
+
+const userBatch = client.buildBranch(
+  { getUser, updateUser },
+  { path: '/v1/batch', method: 'post' }, // method defaults to POST
+)
+
+const result = await userBatch.fetch({
+  getUser: {
+    args: { params: { userId: 'u_1' } },
+  },
+  updateUser: {
+    args: { params: { userId: 'u_1' } },
+    body: { name: 'Emery' }, // required for mutation leaves
+  },
+})
+
+// result keys map back to your aliases:
+// { getUser: ..., updateUser: ... }
+```
+
+The request body sent to `/v1/batch` is keyed by URL-encoded leaf keys:
+
+```ts
+{
+  [encodeURIComponent('GET /v1/users/:userId')]: { params: { userId: 'u_1' } },
+  [encodeURIComponent('PATCH /v1/users/:userId')]: {
+    params: { userId: 'u_1' },
+    body: { name: 'Emery' },
+  },
+}
+```
+
+`buildBranch` also provides:
+
+- `useEndpoint(input, options?)` for a single React Query hook over the batched response.
+- `getQueryKeys(input?)` to derive per-alias keys.
+- `invalidate(input?)` to invalidate each leaf alias exactly.
+- `setData(input)` to write cache per alias.
+
+### 9) File uploads (FormData)
 
 If a leaf has `bodyFiles` set in its contract, the client automatically converts the body to `FormData`.
 For each declared file field name, pass files using `file${name}` in the input body.
@@ -251,7 +297,7 @@ await uploadAvatar.fetch(
 )
 ```
 
-### 9) Debug logging
+### 10) Debug logging
 
 ```ts
 const client = createRouteClient({