@nkzw/fate 1.0.3 → 1.2.0

package/docs/api/classes/FateClient.md

@@ -1,6 +1,6 @@
-# Class: FateClient\<Roots, Mutations\>
+# Class: FateClient\<Roots, Mutations, HydrationScope\>
 
-Defined in: [packages/fate/src/client.ts:361](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L361)
+Defined in: [packages/fate/src/client.ts:414](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L414)
 
 Core client that normalizes records, manages the view cache, and coordinates
 data fetching.
@@ -15,23 +15,27 @@ data fetching.
 
 `Mutations` *extends* [`FateMutations`](../type-aliases/FateMutations.md)
 
+### HydrationScope
+
+`HydrationScope` *extends* `string` = `string`
+
 ## Constructors
 
 ### Constructor
 
-> **new FateClient**\<`Roots`, `Mutations`\>(`options`): `FateClient`\<`Roots`, `Mutations`\>
+> **new FateClient**\<`Roots`, `Mutations`, `HydrationScope`\>(`options`): `FateClient`\<`Roots`, `Mutations`, `HydrationScope`\>
 
-Defined in: [packages/fate/src/client.ts:400](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L400)
+Defined in: [packages/fate/src/client.ts:461](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L461)
 
 #### Parameters
 
 ##### options
 
-`FateClientOptions`\<`Roots`, `Mutations`\>
+`FateClientOptions`\<`Roots`, `Mutations`, `HydrationScope`\>
 
 #### Returns
 
-`FateClient`\<`Roots`, `Mutations`\>
+`FateClient`\<`Roots`, `Mutations`, `HydrationScope`\>
 
 ## Properties
 
@@ -39,7 +43,7 @@ Defined in: [packages/fate/src/client.ts:400](https://github.com/nkzw-tech/fate/
 
 > `readonly` **actions**: `MutationTreeFromRecord`\<`Mutations`\>
 
-Defined in: [packages/fate/src/client.ts:396](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L396)
+Defined in: [packages/fate/src/client.ts:457](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L457)
 
 ***
 
@@ -47,7 +51,7 @@ Defined in: [packages/fate/src/client.ts:396](https://github.com/nkzw-tech/fate/
 
 > `readonly` **mutations**: `MutationTreeFromRecord`\<`Mutations`\>
 
-Defined in: [packages/fate/src/client.ts:397](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L397)
+Defined in: [packages/fate/src/client.ts:458](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L458)
 
 ***
 
@@ -55,7 +59,7 @@ Defined in: [packages/fate/src/client.ts:397](https://github.com/nkzw-tech/fate/
 
 > `readonly` **roots**: `Roots`
 
-Defined in: [packages/fate/src/client.ts:398](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L398)
+Defined in: [packages/fate/src/client.ts:459](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L459)
 
 ***
 
@@ -63,7 +67,7 @@ Defined in: [packages/fate/src/client.ts:398](https://github.com/nkzw-tech/fate/
 
 > `readonly` **store**: `Store`
 
-Defined in: [packages/fate/src/client.ts:389](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L389)
+Defined in: [packages/fate/src/client.ts:448](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L448)
 
 ## Methods
 
@@ -71,7 +75,7 @@ Defined in: [packages/fate/src/client.ts:389](https://github.com/nkzw-tech/fate/
 
 > **assertLiveConnectionSupport**(): `void`
 
-Defined in: [packages/fate/src/client.ts:845](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L845)
+Defined in: [packages/fate/src/client.ts:1098](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1098)
 
 #### Returns
 
@@ -83,7 +87,7 @@ Defined in: [packages/fate/src/client.ts:845](https://github.com/nkzw-tech/fate/
 
 > **assertLiveViewSupport**(): `void`
 
-Defined in: [packages/fate/src/client.ts:837](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L837)
+Defined in: [packages/fate/src/client.ts:1090](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1090)
 
 #### Returns
 
@@ -95,7 +99,7 @@ Defined in: [packages/fate/src/client.ts:837](https://github.com/nkzw-tech/fate/
 
 > **clearOptimisticUpdate**(`token`): `void`
 
-Defined in: [packages/fate/src/client.ts:1496](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1496)
+Defined in: [packages/fate/src/client.ts:1749](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1749)
 
 #### Parameters
 
@@ -109,11 +113,27 @@ Defined in: [packages/fate/src/client.ts:1496](https://github.com/nkzw-tech/fate
 
 ***
 
+### dehydrate()
+
+> **dehydrate**(): [`FateDehydratedState`](../type-aliases/FateDehydratedState.md)\<`HydrationScope`\>
+
+Defined in: [packages/fate/src/client.ts:553](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L553)
+
+Exports the durable normalized cache as an opaque JSON-safe value for SSR
+transfer or persistence. Runtime requests, subscriptions, retainers, and
+optimistic state are intentionally excluded.
+
+#### Returns
+
+[`FateDehydratedState`](../type-aliases/FateDehydratedState.md)\<`HydrationScope`\>
+
+***
+
 ### deleteRecord()
 
 > **deleteRecord**(`type`, `id`, `snapshots?`, `listSnapshots?`): `void`
 
-Defined in: [packages/fate/src/client.ts:650](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L650)
+Defined in: [packages/fate/src/client.ts:803](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L803)
 
 #### Parameters
 
@@ -143,7 +163,7 @@ Defined in: [packages/fate/src/client.ts:650](https://github.com/nkzw-tech/fate/
 
 > **executeMutation**(`key`, `input`, `select`, `options?`): `Promise`\<`unknown`\>
 
-Defined in: [packages/fate/src/client.ts:594](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L594)
+Defined in: [packages/fate/src/client.ts:745](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L745)
 
 #### Parameters
 
@@ -179,7 +199,7 @@ Defined in: [packages/fate/src/client.ts:594](https://github.com/nkzw-tech/fate/
 
 > **filterSelectionForPendingOptimistics**(`entityId`, `select`, `options?`): `Set`\<`string`\>
 
-Defined in: [packages/fate/src/client.ts:1559](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1559)
+Defined in: [packages/fate/src/client.ts:1812](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1812)
 
 #### Parameters
 
@@ -207,7 +227,7 @@ Defined in: [packages/fate/src/client.ts:1559](https://github.com/nkzw-tech/fate
 
 > **gc**(): `void`
 
-Defined in: [packages/fate/src/client.ts:1871](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1871)
+Defined in: [packages/fate/src/client.ts:2135](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2135)
 
 Removes records and lists that are not reachable from retained requests or
 the release buffer.
@@ -226,7 +246,7 @@ memory-management flows.
 
 > **getPendingOptimisticMask**(`entityId`, `options?`): `FieldMask` \| `null`
 
-Defined in: [packages/fate/src/client.ts:1518](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1518)
+Defined in: [packages/fate/src/client.ts:1771](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1771)
 
 #### Parameters
 
@@ -250,7 +270,7 @@ Defined in: [packages/fate/src/client.ts:1518](https://github.com/nkzw-tech/fate
 
 > **getRequestKey**(`request`): `string`
 
-Defined in: [packages/fate/src/client.ts:2089](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L2089)
+Defined in: [packages/fate/src/client.ts:2366](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2366)
 
 #### Parameters
 
@@ -268,7 +288,7 @@ Defined in: [packages/fate/src/client.ts:2089](https://github.com/nkzw-tech/fate
 
 > **getRequestResult**\<`R`\>(`request`): [`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>
 
-Defined in: [packages/fate/src/client.ts:2229](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L2229)
+Defined in: [packages/fate/src/client.ts:2506](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2506)
 
 #### Type Parameters
 
@@ -292,7 +312,7 @@ Defined in: [packages/fate/src/client.ts:2229](https://github.com/nkzw-tech/fate
 
 > **getTypeConfig**(`type`): [`TypeConfig`](../type-aliases/TypeConfig.md)
 
-Defined in: [packages/fate/src/client.ts:586](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L586)
+Defined in: [packages/fate/src/client.ts:737](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L737)
 
 #### Parameters
 
@@ -306,11 +326,37 @@ Defined in: [packages/fate/src/client.ts:586](https://github.com/nkzw-tech/fate/
 
 ***
 
+### hydrate()
+
+> **hydrate**(`state`, `options?`): `void`
+
+Defined in: [packages/fate/src/client.ts:580](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L580)
+
+Restores a durable normalized cache snapshot without restoring runtime
+request handles, retainers, subscriptions, or optimistic update state.
+Hydrate before rendering SSR content. Replaying the same snapshot is safe.
+
+#### Parameters
+
+##### state
+
+[`FateDehydratedState`](../type-aliases/FateDehydratedState.md)\<`HydrationScope`\>
+
+##### options?
+
+[`HydrateOptions`](../type-aliases/HydrateOptions.md) = `{}`
+
+#### Returns
+
+`void`
+
+***
+
 ### loadConnection()
 
 > **loadConnection**\<`V`\>(`view`, `connection`, `args`, `options?`): `Promise`\<`Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: readonly (`string` \| `undefined`)[]; `forwardPageLimit?`: `number`; `ids`: readonly `string`[]; `liveAfterIds?`: readonly `string`[]; `liveBeforeIds?`: readonly `string`[]; `pagination?`: [`Pagination`](../type-aliases/Pagination.md); `pendingAfterIds?`: readonly `string`[]; `pendingBeforeIds?`: readonly `string`[]; \}\> \| `undefined`\>
 
-Defined in: [packages/fate/src/client.ts:1583](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1583)
+Defined in: [packages/fate/src/client.ts:1836](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1836)
 
 #### Type Parameters
 
@@ -348,7 +394,7 @@ Defined in: [packages/fate/src/client.ts:1583](https://github.com/nkzw-tech/fate
 
 > **prepareRequestForRender**\<`R`\>(`request`, `options`): `Readonly`\<\{ `promise`: `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>; `requestKey`: `string`; \}\>
 
-Defined in: [packages/fate/src/client.ts:1753](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1753)
+Defined in: [packages/fate/src/client.ts:2017](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2017)
 
 #### Type Parameters
 
@@ -372,11 +418,35 @@ Defined in: [packages/fate/src/client.ts:1753](https://github.com/nkzw-tech/fate
 
 ***
 
+### readDeferred()
+
+> **readDeferred**\<`T`\>(`deferred`): `PromiseLike`\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: `T`; \}\>\>
+
+Defined in: [packages/fate/src/client.ts:993](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L993)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### deferred
+
+[`Deferred`](../type-aliases/Deferred.md)\<`T`\>
+
+#### Returns
+
+`PromiseLike`\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: `T`; \}\>\>
+
+***
+
 ### readView()
 
 > **readView**\<`T`, `S`, `V`\>(`view`, `ref`): [`FateThenable`](../interfaces/FateThenable.md)\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: [`ViewData`](../type-aliases/ViewData.md)\<`T`, `S`\>; \}\>\>
 
-Defined in: [packages/fate/src/client.ts:713](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L713)
+Defined in: [packages/fate/src/client.ts:866](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L866)
 
 #### Type Parameters
 
@@ -412,7 +482,7 @@ Defined in: [packages/fate/src/client.ts:713](https://github.com/nkzw-tech/fate/
 
 > **ref**\<`T`\>(`type`, `id`, `view`): [`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
 
-Defined in: [packages/fate/src/client.ts:700](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L700)
+Defined in: [packages/fate/src/client.ts:853](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L853)
 
 #### Type Parameters
 
@@ -444,7 +514,7 @@ Defined in: [packages/fate/src/client.ts:700](https://github.com/nkzw-tech/fate/
 
 > **registerOptimisticUpdate**(`entityId`, `select`): `number` \| `null`
 
-Defined in: [packages/fate/src/client.ts:1477](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1477)
+Defined in: [packages/fate/src/client.ts:1730](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1730)
 
 #### Parameters
 
@@ -466,7 +536,7 @@ Defined in: [packages/fate/src/client.ts:1477](https://github.com/nkzw-tech/fate
 
 > **registerPendingOptimisticMutation**(`entityId`, `promise`): `void`
 
-Defined in: [packages/fate/src/client.ts:1447](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1447)
+Defined in: [packages/fate/src/client.ts:1700](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1700)
 
 #### Parameters
 
@@ -488,7 +558,7 @@ Defined in: [packages/fate/src/client.ts:1447](https://github.com/nkzw-tech/fate
 
 > **releaseRequest**(`request`, `mode`): `void`
 
-Defined in: [packages/fate/src/client.ts:1810](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1810)
+Defined in: [packages/fate/src/client.ts:2074](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2074)
 
 #### Parameters
 
@@ -510,7 +580,7 @@ Defined in: [packages/fate/src/client.ts:1810](https://github.com/nkzw-tech/fate
 
 > **releaseRequestKey**(`requestKey`, `mode`): `void`
 
-Defined in: [packages/fate/src/client.ts:1814](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1814)
+Defined in: [packages/fate/src/client.ts:2078](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2078)
 
 #### Parameters
 
@@ -532,7 +602,7 @@ Defined in: [packages/fate/src/client.ts:1814](https://github.com/nkzw-tech/fate
 
 > **request**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
 
-Defined in: [packages/fate/src/client.ts:1736](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1736)
+Defined in: [packages/fate/src/client.ts:2000](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2000)
 
 #### Type Parameters
 
@@ -560,7 +630,7 @@ Defined in: [packages/fate/src/client.ts:1736](https://github.com/nkzw-tech/fate
 
 > **requestForRender**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
 
-Defined in: [packages/fate/src/client.ts:1746](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1746)
+Defined in: [packages/fate/src/client.ts:2010](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2010)
 
 #### Type Parameters
 
@@ -588,7 +658,7 @@ Defined in: [packages/fate/src/client.ts:1746](https://github.com/nkzw-tech/fate
 
 > **resolveOptimisticEntity**(`optimisticEntityId`, `resolvedEntityId`): `void`
 
-Defined in: [packages/fate/src/client.ts:1472](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1472)
+Defined in: [packages/fate/src/client.ts:1725](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1725)
 
 #### Parameters
 
@@ -610,7 +680,7 @@ Defined in: [packages/fate/src/client.ts:1472](https://github.com/nkzw-tech/fate
 
 > **restore**(`id`, `snapshot`): `void`
 
-Defined in: [packages/fate/src/client.ts:668](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L668)
+Defined in: [packages/fate/src/client.ts:821](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L821)
 
 #### Parameters
 
@@ -632,7 +702,7 @@ Defined in: [packages/fate/src/client.ts:668](https://github.com/nkzw-tech/fate/
 
 > **restoreList**(`name`, `list?`): `void`
 
-Defined in: [packages/fate/src/client.ts:673](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L673)
+Defined in: [packages/fate/src/client.ts:826](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L826)
 
 #### Parameters
 
@@ -654,7 +724,7 @@ Defined in: [packages/fate/src/client.ts:673](https://github.com/nkzw-tech/fate/
 
 > **retain**(`request`): `RetainHandle`
 
-Defined in: [packages/fate/src/client.ts:1845](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1845)
+Defined in: [packages/fate/src/client.ts:2109](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2109)
 
 Keeps the records and lists reachable from a request alive until the
 returned handle is disposed.
@@ -679,7 +749,7 @@ that must survive manual garbage collection.
 
 > **retainRequestKey**(`requestKey`, `mode?`): `RetainHandle`
 
-Defined in: [packages/fate/src/client.ts:1826](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L1826)
+Defined in: [packages/fate/src/client.ts:2090](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2090)
 
 #### Parameters
 
@@ -701,7 +771,7 @@ Defined in: [packages/fate/src/client.ts:1826](https://github.com/nkzw-tech/fate
 
 > **rootListRef**(`entityId`, `rootView`): `Readonly`\<\{ `__typename`: `string`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\>
 
-Defined in: [packages/fate/src/client.ts:708](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L708)
+Defined in: [packages/fate/src/client.ts:861](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L861)
 
 #### Parameters
 
@@ -723,7 +793,7 @@ Defined in: [packages/fate/src/client.ts:708](https://github.com/nkzw-tech/fate/
 
 > **subscribeLiveListView**\<`V`\>(`view`, `connection`): () => `void`
 
-Defined in: [packages/fate/src/client.ts:937](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L937)
+Defined in: [packages/fate/src/client.ts:1190](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1190)
 
 #### Type Parameters
 
@@ -751,7 +821,7 @@ Defined in: [packages/fate/src/client.ts:937](https://github.com/nkzw-tech/fate/
 
 > **subscribeLiveView**\<`T`, `S`, `V`\>(`view`, `ref`): () => `void`
 
-Defined in: [packages/fate/src/client.ts:853](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L853)
+Defined in: [packages/fate/src/client.ts:1106](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1106)
 
 #### Type Parameters
 
@@ -783,11 +853,35 @@ Defined in: [packages/fate/src/client.ts:853](https://github.com/nkzw-tech/fate/
 
 ***
 
+### trackPendingRequest()
+
+> **trackPendingRequest**\<`T`\>(`request`): `Promise`\<`T`\>
+
+Defined in: [packages/fate/src/client.ts:2323](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2323)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### request
+
+() => `Promise`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`\>
+
+***
+
 ### write()
 
 > **write**(`type`, `data`, `select`, `snapshots?`, `plan?`, `pathPrefix?`, `blockedMask?`, `insert?`, `listSnapshots?`): `string`
 
-Defined in: [packages/fate/src/client.ts:626](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L626)
+Defined in: [packages/fate/src/client.ts:779](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L779)
 
 #### Parameters
 

package/docs/api/functions/clientRoot.md

@@ -2,7 +2,7 @@
 
 > **clientRoot**\<`Result`, `Type`\>(`type`): `RootDefinition`\<`Type`, `Result`\>
 
-Defined in: [packages/fate/src/root.ts:7](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/root.ts#L7)
+Defined in: [packages/fate/src/root.ts:7](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/root.ts#L7)
 
 Defines a root query for an entity type, capturing the response shape.
 

package/docs/api/functions/createClient.md

@@ -1,8 +1,8 @@
 # Function: createClient()
 
-> **createClient**\<`T`\>(`options`): [`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\]\>
+> **createClient**\<`T`, `HydrationScope`\>(`options`): [`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\], `HydrationScope`\>
 
-Defined in: [packages/fate/src/client.ts:3009](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/client.ts#L3009)
+Defined in: [packages/fate/src/client.ts:3377](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L3377)
 
 ## Type Parameters
 
@@ -10,12 +10,16 @@ Defined in: [packages/fate/src/client.ts:3009](https://github.com/nkzw-tech/fate
 
 `T` *extends* \[[`FateRoots`](../type-aliases/FateRoots.md), [`FateMutations`](../type-aliases/FateMutations.md)\] = \[`Record`\<`never`, `RootDefinition`\<`any`, `any`\>\>, `Record`\<`never`, [`MutationDefinition`](../type-aliases/MutationDefinition.md)\<`any`, `any`, `any`\>\>\]
 
+### HydrationScope
+
+`HydrationScope` *extends* `string` = `string`
+
 ## Parameters
 
 ### options
 
-`FateClientOptions`\<`T`\[`0`\], `T`\[`1`\]\>
+`FateClientOptions`\<`T`\[`0`\], `T`\[`1`\], `HydrationScope`\>
 
 ## Returns
 
-[`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\]\>
+[`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\], `HydrationScope`\>

package/docs/api/functions/createGraphQLTransport.md

@@ -0,0 +1,21 @@
+# Function: createGraphQLTransport()
+
+> **createGraphQLTransport**\<`Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`Mutations`\>
+
+Defined in: [packages/fate/src/graphqlTransport.ts:578](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/graphqlTransport.ts#L578)
+
+## Type Parameters
+
+### Mutations
+
+`Mutations` *extends* `TransportMutations` = `EmptyTransportMutations`
+
+## Parameters
+
+### \_\_namedParameters
+
+[`GraphQLTransportOptions`](../type-aliases/GraphQLTransportOptions.md)\<`Mutations`\>
+
+## Returns
+
+[`Transport`](../interfaces/Transport.md)\<`Mutations`\>

package/docs/api/functions/createHTTPTransport.md

@@ -2,7 +2,7 @@
 
 > **createHTTPTransport**\<`API`, `Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`Mutations`\>
 
-Defined in: [packages/fate/src/httpTransport.ts:265](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/httpTransport.ts#L265)
+Defined in: [packages/fate/src/httpTransport.ts:265](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/httpTransport.ts#L265)
 
 ## Type Parameters
 

package/docs/api/functions/createTRPCTransport.md

@@ -2,7 +2,7 @@
 
 > **createTRPCTransport**\<`AppRouter`, `Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`MutationMapFromResolvers`\<`Mutations`\>\>
 
-Defined in: [packages/fate/src/transport.ts:149](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/transport.ts#L149)
+Defined in: [packages/fate/src/transport.ts:149](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/transport.ts#L149)
 
 Builds a `Transport` backed by a tRPC client using the configured resolvers
 for by-id queries, lists, and mutations.

package/docs/api/functions/defer.md

@@ -0,0 +1,21 @@
+# Function: defer()
+
+> **defer**\<`S`\>(`selection`): [`DeferredSelection`](../type-aliases/DeferredSelection.md)\<`S`\>
+
+Defined in: [packages/fate/src/defer.ts:9](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/defer.ts#L9)
+
+## Type Parameters
+
+### S
+
+`S`
+
+## Parameters
+
+### selection
+
+`S`
+
+## Returns
+
+[`DeferredSelection`](../type-aliases/DeferredSelection.md)\<`S`\>

package/docs/api/functions/getDeferredMetadata.md

@@ -0,0 +1,21 @@
+# Function: getDeferredMetadata()
+
+> **getDeferredMetadata**\<`T`\>(`deferred`): [`DeferredMetadata`](../type-aliases/DeferredMetadata.md)
+
+Defined in: [packages/fate/src/defer.ts:28](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/defer.ts#L28)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### deferred
+
+[`Deferred`](../type-aliases/Deferred.md)\<`T`\>
+
+## Returns
+
+[`DeferredMetadata`](../type-aliases/DeferredMetadata.md)

package/docs/api/functions/getListEntries.md

@@ -2,7 +2,7 @@
 
 > **getListEntries**(`listState`): `Readonly`\<\{ `cursor?`: `string`; `id`: `string`; \}\>[]
 
-Defined in: [packages/fate/src/list.ts:6](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/list.ts#L6)
+Defined in: [packages/fate/src/list.ts:6](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/list.ts#L6)
 
 ## Parameters
 

package/docs/api/functions/getSelectionPlan.md

@@ -2,7 +2,7 @@
 
 > **getSelectionPlan**\<`T`, `S`, `V`\>(`viewComposition`, `ref`): `SelectionPlan`
 
-Defined in: [packages/fate/src/selection.ts:37](https://github.com/nkzw-tech/fate/blob/a371a1ba3412f80c3471be587e73a3b0df92d690/packages/fate/src/selection.ts#L37)
+Defined in: [packages/fate/src/selection.ts:38](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/selection.ts#L38)
 
 Flattens a view into a `SelectionPlan`, expanding composed views and
 partitioning nested args so the client can fetch exactly what is declared.

package/docs/api/functions/graphqlMutation.md

@@ -0,0 +1,39 @@
+# Function: graphqlMutation()
+
+> **graphqlMutation**\<`T`, `Input`, `Output`\>(`entity`, `options`): [`GraphQLMutationDefinition`](../type-aliases/GraphQLMutationDefinition.md)\<`T`, `Input`, `Output`\>
+
+Defined in: [packages/fate/src/graphqlTransport.ts:567](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/graphqlTransport.ts#L567)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Entity`](../type-aliases/Entity.md)
+
+### Input
+
+`Input`
+
+### Output
+
+`Output`
+
+## Parameters
+
+### entity
+
+`T`\[`"__typename"`\]
+
+### options
+
+#### field
+
+`string`
+
+#### inputArg?
+
+`string` \| `false`
+
+## Returns
+
+[`GraphQLMutationDefinition`](../type-aliases/GraphQLMutationDefinition.md)\<`T`, `Input`, `Output`\>

package/docs/api/functions/isDeferred.md

@@ -0,0 +1,15 @@
+# Function: isDeferred()
+
+> **isDeferred**(`value`): `value is Deferred<unknown>`
+
+Defined in: [packages/fate/src/defer.ts:25](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/defer.ts#L25)
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is Deferred<unknown>`