@nkzw/fate 0.1.3 → 1.0.0-rc.0

package/docs/api/server/type-aliases/Entity.md

@@ -0,0 +1,21 @@
+# Type Alias: Entity\<TView, Name, Replacements\>
+
+> **Entity**\<`TView`, `Name`, `Replacements`\> = `WithTypename`\<`Omit`\<[`DataViewResult`](DataViewResult.md)\<`TView`\>, keyof `Replacements`\> & `Replacements`, `Name`\>
+
+Defined in: [packages/fate/src/server/dataView.ts:301](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L301)
+
+Resolved entity type from a data view for client use.
+
+## Type Parameters
+
+### TView
+
+`TView` *extends* `DataView`\<[`FateRecord`](../../type-aliases/FateRecord.md)\>
+
+### Name
+
+`Name` *extends* `string`
+
+### Replacements
+
+`Replacements` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`never`, `never`\>

package/docs/api/server/type-aliases/FateServer.md

@@ -0,0 +1,75 @@
+# Type Alias: FateServer\<API, AdapterContext\>
+
+> **FateServer**\<`API`, `AdapterContext`\> = `object`
+
+Defined in: [packages/fate/src/server/http.ts:224](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L224)
+
+## Type Parameters
+
+### API
+
+`API`
+
+### AdapterContext
+
+`AdapterContext` = `unknown`
+
+## Properties
+
+### \_\_api?
+
+> `readonly` `optional` **\_\_api?**: `API`
+
+Defined in: [packages/fate/src/server/http.ts:225](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L225)
+
+***
+
+### manifest
+
+> `readonly` **manifest**: [`FateServerManifest`](FateServerManifest.md)
+
+Defined in: [packages/fate/src/server/http.ts:228](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L228)
+
+## Methods
+
+### handleLiveRequest()
+
+> **handleLiveRequest**(`request`, `adapterContext?`): `Promise`\<`Response`\>
+
+Defined in: [packages/fate/src/server/http.ts:226](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L226)
+
+#### Parameters
+
+##### request
+
+`Request`
+
+##### adapterContext?
+
+`AdapterContext`
+
+#### Returns
+
+`Promise`\<`Response`\>
+
+***
+
+### handleRequest()
+
+> **handleRequest**(`request`, `adapterContext?`): `Promise`\<`Response`\>
+
+Defined in: [packages/fate/src/server/http.ts:227](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L227)
+
+#### Parameters
+
+##### request
+
+`Request`
+
+##### adapterContext?
+
+`AdapterContext`
+
+#### Returns
+
+`Promise`\<`Response`\>

package/docs/api/server/type-aliases/FateServerManifest.md

@@ -0,0 +1,5 @@
+# Type Alias: FateServerManifest
+
+> **FateServerManifest** = `Readonly`\<\{ `lists`: `Record`\<`string`, \{ `type`: `string`; \}\>; `live`: `Record`\<`string`, `true`\>; `mutations`: `Record`\<`string`, \{ `type`: `string`; \}\>; `queries`: `Record`\<`string`, \{ `type`: `string`; \}\>; `types`: `Record`\<`string`, `true`\>; \}\>
+
+Defined in: [packages/fate/src/server/http.ts:233](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L233)

package/docs/api/server/type-aliases/FieldSelection.md

@@ -0,0 +1,21 @@
+# Type Alias: FieldSelection
+
+> **FieldSelection** = `object`
+
+Defined in: [packages/fate/src/server/dataView.ts:28](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L28)
+
+## Properties
+
+### kind
+
+> **kind**: `"field"`
+
+Defined in: [packages/fate/src/server/dataView.ts:29](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L29)
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [packages/fate/src/server/dataView.ts:30](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L30)

package/docs/api/server/type-aliases/LiveConnectionEventType.md

@@ -0,0 +1,5 @@
+# Type Alias: LiveConnectionEventType
+
+> **LiveConnectionEventType** = `"appendEdge"` \| `"appendNode"` \| `"deleteEdge"` \| `"insertEdgeAfter"` \| `"insertEdgeBefore"` \| `"invalidate"` \| `"prependEdge"` \| `"prependNode"`
+
+Defined in: [packages/fate/src/server/live.ts:6](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/live.ts#L6)

package/docs/api/server/type-aliases/LiveConnectionSourceEvent.md

@@ -0,0 +1,5 @@
+# Type Alias: LiveConnectionSourceEvent
+
+> **LiveConnectionSourceEvent** = `Readonly`\<\{ `cursor?`: `string`; `eventId?`: `string`; `id?`: `string` \| `number`; `node?`: `unknown`; `nodeType?`: `string`; `targetCursor?`: `string`; `type`: [`LiveConnectionEventType`](LiveConnectionEventType.md); \}\>
+
+Defined in: [packages/fate/src/server/live.ts:24](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/live.ts#L24)

package/docs/api/server/type-aliases/LiveEventBus.md

@@ -0,0 +1,5 @@
+# Type Alias: LiveEventBus
+
+> **LiveEventBus** = `Readonly`\<\{ `connection`: (`procedure`, `args?`) => `LiveConnectionHandle`; `delete`: (`type`, `id`, `options?`) => `void`; `emit`: (`type`, `id`, `options?`) => `void`; `listen?`: (`type`, `id`, `handler`, `options?`) => () => `void`; `listenConnection?`: (`target`, `handler`, `options?`) => () => `void`; `subscribe`: (`type`, `id`, `options?`) => `AsyncIterable`\<readonly \[[`LiveSourceEvent`](LiveSourceEvent.md)\]\>; `subscribeConnection`: (`target`, `options?`) => `AsyncIterable`\<readonly \[[`LiveConnectionSourceEvent`](LiveConnectionSourceEvent.md)\]\>; `update`: (`type`, `id`, `options?`) => `void`; \}\>
+
+Defined in: [packages/fate/src/server/live.ts:72](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/live.ts#L72)

package/docs/api/server/type-aliases/LiveEventType.md

@@ -0,0 +1,5 @@
+# Type Alias: LiveEventType
+
+> **LiveEventType** = `"delete"` \| `"update"`
+
+Defined in: [packages/fate/src/server/live.ts:4](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/live.ts#L4)

package/docs/api/server/type-aliases/LiveSourceEvent.md

@@ -0,0 +1,5 @@
+# Type Alias: LiveSourceEvent
+
+> **LiveSourceEvent** = `Readonly`\<\{ `changed?`: `ReadonlyArray`\<`string`\>; `data?`: `unknown`; `eventId?`: `string`; `id`: `string` \| `number`; `type`: [`LiveEventType`](LiveEventType.md); \}\>
+
+Defined in: [packages/fate/src/server/live.ts:16](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/live.ts#L16)

package/docs/api/server/type-aliases/NativeFateAPI.md

@@ -0,0 +1,47 @@
+# Type Alias: NativeFateAPI\<Roots, Queries, Lists, Mutations\>
+
+> **NativeFateAPI**\<`Roots`, `Queries`, `Lists`, `Mutations`\> = `object`
+
+Defined in: [packages/fate/src/server/http.ts:213](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L213)
+
+## Type Parameters
+
+### Roots
+
+`Roots` *extends* `RootMap`
+
+### Queries
+
+`Queries` *extends* `Record`\<`string`, `QueryDefinition`\<`any`, `any`, `any`\>\>
+
+### Lists
+
+`Lists` *extends* `Record`\<`string`, `ListDefinition`\<`any`, `any`, `any`\>\>
+
+### Mutations
+
+`Mutations` *extends* `Record`\<`string`, `MutationDefinition`\<`any`, `any`, `any`\>\>
+
+## Properties
+
+### lists
+
+> **lists**: `RootLists`\<`Roots`\> & `ListAPI`\<`Lists`\>
+
+Defined in: [packages/fate/src/server/http.ts:219](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L219)
+
+***
+
+### mutations
+
+> **mutations**: `MutationAPI`\<`Mutations`\>
+
+Defined in: [packages/fate/src/server/http.ts:220](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L220)
+
+***
+
+### queries
+
+> **queries**: `RootQueries`\<`Roots`\> & `QueryAPI`\<`Queries`\>
+
+Defined in: [packages/fate/src/server/http.ts:221](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L221)

package/docs/api/server/type-aliases/OrderDirection.md

@@ -0,0 +1,5 @@
+# Type Alias: OrderDirection
+
+> **OrderDirection** = `"asc"` \| `"desc"`
+
+Defined in: [packages/fate/src/server/source.ts:14](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L14)

package/docs/api/server/type-aliases/SourceConfig.md

@@ -0,0 +1,55 @@
+# Type Alias: SourceConfig\<Item, Adapter\>
+
+> **SourceConfig**\<`Item`, `Adapter`\> = `object`
+
+Defined in: [packages/fate/src/server/source.ts:79](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L79)
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md) = [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Adapter
+
+`Adapter` = `unknown`
+
+## Properties
+
+### adapter?
+
+> `optional` **adapter?**: `Adapter`
+
+Defined in: [packages/fate/src/server/source.ts:80](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L80)
+
+***
+
+### id?
+
+> `optional` **id?**: `string`
+
+Defined in: [packages/fate/src/server/source.ts:81](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L81)
+
+***
+
+### orderBy?
+
+> `optional` **orderBy?**: [`SourceOrder`](SourceOrder.md)
+
+Defined in: [packages/fate/src/server/source.ts:82](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L82)
+
+***
+
+### relations?
+
+> `optional` **relations?**: `Record`\<`string`, [`SourceRelationConfig`](SourceRelationConfig.md)\>
+
+Defined in: [packages/fate/src/server/source.ts:83](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L83)
+
+***
+
+### view
+
+> **view**: `DataView`\<`Item`\>
+
+Defined in: [packages/fate/src/server/source.ts:84](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L84)

package/docs/api/server/type-aliases/SourceDefinition.md

@@ -0,0 +1,55 @@
+# Type Alias: SourceDefinition\<Item, Adapter\>
+
+> **SourceDefinition**\<`Item`, `Adapter`\> = `object`
+
+Defined in: [packages/fate/src/server/source.ts:71](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L71)
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md) = [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Adapter
+
+`Adapter` = `unknown`
+
+## Properties
+
+### adapter?
+
+> `optional` **adapter?**: `Adapter`
+
+Defined in: [packages/fate/src/server/source.ts:72](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L72)
+
+***
+
+### id
+
+> **id**: `string`
+
+Defined in: [packages/fate/src/server/source.ts:73](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L73)
+
+***
+
+### orderBy?
+
+> `optional` **orderBy?**: [`SourceOrder`](SourceOrder.md)
+
+Defined in: [packages/fate/src/server/source.ts:74](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L74)
+
+***
+
+### relations?
+
+> `optional` **relations?**: `Record`\<`string`, [`SourceRelation`](SourceRelation.md)\<[`FateRecord`](../../type-aliases/FateRecord.md), `Adapter`\>\>
+
+Defined in: [packages/fate/src/server/source.ts:75](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L75)
+
+***
+
+### view
+
+> **view**: `DataView`\<`Item`\>
+
+Defined in: [packages/fate/src/server/source.ts:76](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L76)

package/docs/api/server/type-aliases/SourceOrder.md

@@ -0,0 +1,5 @@
+# Type Alias: SourceOrder
+
+> **SourceOrder** = [`SourceOrderField`](SourceOrderField.md)[]
+
+Defined in: [packages/fate/src/server/source.ts:21](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L21)

package/docs/api/server/type-aliases/SourceOrderField.md

@@ -0,0 +1,21 @@
+# Type Alias: SourceOrderField
+
+> **SourceOrderField** = `object`
+
+Defined in: [packages/fate/src/server/source.ts:16](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L16)
+
+## Properties
+
+### direction
+
+> **direction**: [`OrderDirection`](OrderDirection.md)
+
+Defined in: [packages/fate/src/server/source.ts:17](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L17)
+
+***
+
+### field
+
+> **field**: `string`
+
+Defined in: [packages/fate/src/server/source.ts:18](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L18)

package/docs/api/server/type-aliases/SourcePlan.md

@@ -0,0 +1,29 @@
+# Type Alias: SourcePlan\<Item, Context, Adapter\>
+
+> **SourcePlan**\<`Item`, `Context`, `Adapter`\> = `Omit`\<`ViewPlan`\<`Item`, `Context`\>, `"root"`\> & `object`
+
+Defined in: [packages/fate/src/server/source.ts:93](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L93)
+
+## Type Declaration
+
+### root
+
+> **root**: [`SourcePlanNode`](SourcePlanNode.md)\<`Context`, `Adapter`\>
+
+### source
+
+> **source**: [`SourceDefinition`](SourceDefinition.md)\<`Item`, `Adapter`\>
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md) = [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Context
+
+`Context` = `unknown`
+
+### Adapter
+
+`Adapter` = `unknown`

package/docs/api/server/type-aliases/SourcePlanNode.md

@@ -0,0 +1,29 @@
+# Type Alias: SourcePlanNode\<Context, Adapter\>
+
+> **SourcePlanNode**\<`Context`, `Adapter`\> = `ViewPlanNode`\<`Context`\> & `object`
+
+Defined in: [packages/fate/src/server/source.ts:87](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L87)
+
+## Type Declaration
+
+### orderBy
+
+> **orderBy**: [`SourceOrder`](SourceOrder.md)
+
+### relations
+
+> **relations**: `Map`\<`string`, `SourcePlanNode`\<`Context`, `Adapter`\>\>
+
+### source
+
+> **source**: [`SourceDefinition`](SourceDefinition.md)\<[`FateRecord`](../../type-aliases/FateRecord.md), `Adapter`\>
+
+## Type Parameters
+
+### Context
+
+`Context` = `unknown`
+
+### Adapter
+
+`Adapter` = `unknown`

package/docs/api/server/type-aliases/SourceRegistry.md

@@ -0,0 +1,11 @@
+# Type Alias: SourceRegistry\<Context\>
+
+> **SourceRegistry**\<`Context`\> = `Map`\<[`SourceDefinition`](SourceDefinition.md)\<[`FateRecord`](../../type-aliases/FateRecord.md), `unknown`\>, `SourceExecutor`\<`Context`, [`FateRecord`](../../type-aliases/FateRecord.md), `any`, `any`, `any`\>\>
+
+Defined in: [packages/fate/src/server/executor.ts:52](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/executor.ts#L52)
+
+## Type Parameters
+
+### Context
+
+`Context`

package/docs/api/server/type-aliases/SourceRelation.md

@@ -0,0 +1,15 @@
+# Type Alias: SourceRelation\<Item, Adapter\>
+
+> **SourceRelation**\<`Item`, `Adapter`\> = `SourceRelationBase`\<`Item`, `Adapter`\> & \{ `kind`: `"one"`; `orderBy?`: `never`; `through?`: `never`; \} \| \{ `kind`: `"many"`; `orderBy?`: [`SourceOrder`](SourceOrder.md); `through?`: `never`; \} \| \{ `kind`: `"manyToMany"`; `orderBy?`: [`SourceOrder`](SourceOrder.md); `through?`: \{ `foreignKey`: `string`; `localKey`: `string`; \}; \}
+
+Defined in: [packages/fate/src/server/source.ts:33](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L33)
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md) = [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Adapter
+
+`Adapter` = `unknown`

package/docs/api/server/type-aliases/SourceRelationConfig.md

@@ -0,0 +1,23 @@
+# Type Alias: SourceRelationConfig
+
+> **SourceRelationConfig** = `Partial`\<`SourceRelationKeyConfig`\> & `object`
+
+Defined in: [packages/fate/src/server/source.ts:63](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L63)
+
+## Type Declaration
+
+### orderBy?
+
+> `optional` **orderBy?**: [`SourceOrder`](SourceOrder.md)
+
+### through?
+
+> `optional` **through?**: `object`
+
+#### through.foreignKey
+
+> **foreignKey**: `string`
+
+#### through.localKey
+
+> **localKey**: `string`

package/docs/api/server/variables/byIdInput.md

@@ -0,0 +1,5 @@
+# Variable: byIdInput
+
+> `const` **byIdInput**: `ZodObject`\<\{ `args`: `ZodOptional`\<`ZodType`\<`Record`\<`string`, `unknown`\>, `unknown`, `$ZodTypeInternals`\<`Record`\<`string`, `unknown`\>, `unknown`\>\>\>; `ids`: `ZodArray`\<`ZodString`\>; `select`: `ZodArray`\<`ZodString`\>; \}, `$strip`\>
+
+Defined in: [packages/fate/src/server/input.ts:4](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/input.ts#L4)

package/docs/api/server/variables/connectionArgs.md

@@ -0,0 +1,7 @@
+# Variable: connectionArgs
+
+> `const` **connectionArgs**: `ZodOptional`\<`ZodType`\<`Record`\<`string`, `unknown`\>, `unknown`, `$ZodTypeInternals`\<`Record`\<`string`, `unknown`\>, `unknown`\>\>\>
+
+Defined in: [packages/fate/src/server/connection.ts:102](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/connection.ts#L102)
+
+Zod schema for connection args (`after`, `before`, `first`, `last`, etc.).

package/docs/api/type-aliases/ConnectionMetadata.md

@@ -0,0 +1,7 @@
+# Type Alias: ConnectionMetadata
+
+> **ConnectionMetadata** = `Readonly`\<\{ `args?`: [`FateRecord`](FateRecord.md); `field`: `string`; `hash?`: `string`; `key`: `string`; `live?`: `ConnectionLivePolicy`; `owner`: [`EntityId`](EntityId.md); `procedure`: `string`; `root?`: `boolean`; `type`: `string`; \}\>
+
+Defined in: [packages/fate/src/types.ts:83](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/types.ts#L83)
+
+Metadata stored alongside connection results to power pagination and cache updates.

package/docs/api/type-aliases/ConnectionRef.md

@@ -0,0 +1,13 @@
+# Type Alias: ConnectionRef\<TName\>
+
+> **ConnectionRef**\<`TName`\> = `Readonly`\<\{ `items`: `ReadonlyArray`\<\{ `cursor?`: `string`; `node`: [`ViewRef`](ViewRef.md)\<`TName`\>; \}\>; `pagination?`: [`Pagination`](Pagination.md); \}\>
+
+Defined in: [packages/fate/src/types.ts:132](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/types.ts#L132)
+
+Ref for a connection, including pagination metadata.
+
+## Type Parameters
+
+### TName
+
+`TName` *extends* `string`

package/docs/api/type-aliases/Entity.md

@@ -0,0 +1,15 @@
+# Type Alias: Entity
+
+> **Entity** = `object`
+
+Defined in: [packages/fate/src/types.ts:141](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/types.ts#L141)
+
+Base shape shared by all entities fetched by fate.
+
+## Properties
+
+### \_\_typename
+
+> **\_\_typename**: `string`
+
+Defined in: [packages/fate/src/types.ts:141](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/types.ts#L141)

package/docs/api/type-aliases/EntityId.md

@@ -0,0 +1,7 @@
+# Type Alias: EntityId
+
+> **EntityId** = `string`
+
+Defined in: [packages/fate/src/types.ts:8](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/types.ts#L8)
+
+Globally unique identifier for an entity in the normalized cache (`<TypeName>:<id>` format).

package/docs/api/type-aliases/FateLiveConnectionEvent.md

@@ -0,0 +1,5 @@
+# Type Alias: FateLiveConnectionEvent
+
+> **FateLiveConnectionEvent** = `Readonly`\<\{ `edge`: \{ `cursor?`: `string`; `node`: `unknown`; \}; `nodeType`: `string`; `targetCursor?`: `string`; `type`: `"appendEdge"` \| `"appendNode"` \| `"insertEdgeAfter"` \| `"insertEdgeBefore"` \| `"prependEdge"` \| `"prependNode"`; \}\> \| `Readonly`\<\{ `id`: `string` \| `number`; `nodeType`: `string`; `type`: `"deleteEdge"`; \}\> \| `Readonly`\<\{ `type`: `"invalidate"`; \}\>
+
+Defined in: [packages/fate/src/protocol.ts:55](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/protocol.ts#L55)

package/docs/api/type-aliases/FateLiveEvent.md

@@ -0,0 +1,5 @@
+# Type Alias: FateLiveEvent
+
+> **FateLiveEvent** = `FateLiveDataEvent` \| `FateLiveDeleteEvent`
+
+Defined in: [packages/fate/src/protocol.ts:53](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/protocol.ts#L53)

package/docs/api/type-aliases/FateMutations.md

@@ -0,0 +1,7 @@
+# Type Alias: FateMutations
+
+> **FateMutations** = `Record`\<`string`, [`MutationDefinition`](MutationDefinition.md)\<`any`, `any`, `any`\>\>
+
+Defined in: [packages/fate/src/mutation.ts:94](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/mutation.ts#L94)
+
+Base type for client mutations.

package/docs/api/type-aliases/FateOperation.md

@@ -0,0 +1,5 @@
+# Type Alias: FateOperation
+
+> **FateOperation** = `Readonly`\<\{ `args?`: `Record`\<`string`, `unknown`\>; `id`: `string`; `ids?`: (`string` \| `number`)[]; `input?`: `unknown`; `kind`: `FateOperationKind`; `name?`: `string`; `select`: `string`[]; `type?`: `string`; \}\>
+
+Defined in: [packages/fate/src/protocol.ts:7](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/protocol.ts#L7)

package/docs/api/type-aliases/FateProtocolRequest.md

@@ -0,0 +1,5 @@
+# Type Alias: FateProtocolRequest
+
+> **FateProtocolRequest** = `Readonly`\<\{ `operations`: [`FateOperation`](FateOperation.md)[]; `version`: `FateProtocolVersion`; \}\>
+
+Defined in: [packages/fate/src/protocol.ts:30](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/protocol.ts#L30)

package/docs/api/type-aliases/FateProtocolResponse.md

@@ -0,0 +1,5 @@
+# Type Alias: FateProtocolResponse
+
+> **FateProtocolResponse** = `Readonly`\<\{ `results`: `FateOperationResult`[]; `version`: `FateProtocolVersion`; \}\>
+
+Defined in: [packages/fate/src/protocol.ts:35](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/protocol.ts#L35)

package/docs/api/type-aliases/FateRecord.md

@@ -0,0 +1,7 @@
+# Type Alias: FateRecord
+
+> **FateRecord** = `Record`\<`string`, `unknown`\>
+
+Defined in: [packages/fate/src/types.ts:64](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/types.ts#L64)
+
+Alias for a loose record used throughout the fate's internals.

package/docs/api/type-aliases/FateRoots.md

@@ -0,0 +1,7 @@
+# Type Alias: FateRoots
+
+> **FateRoots** = `Record`\<`string`, `RootDefinition`\<`TypeName`, `unknown`\>\>
+
+Defined in: [packages/fate/src/types.ts:425](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/types.ts#L425)
+
+Minimal root description used for typing root maps.

package/docs/api/type-aliases/InferFateAPI.md

@@ -0,0 +1,11 @@
+# Type Alias: InferFateAPI\<Server\>
+
+> **InferFateAPI**\<`Server`\> = `Server` *extends* `object` ? `API` : `never`
+
+Defined in: [packages/fate/src/server/http.ts:231](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L231)
+
+## Type Parameters
+
+### Server
+
+`Server`

package/docs/api/type-aliases/List.md

@@ -0,0 +1,5 @@
+# Type Alias: List
+
+> **List** = `Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: `ReadonlyArray`\<`string` \| `undefined`\>; `forwardPageLimit?`: `number`; `ids`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; `liveAfterIds?`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; `liveBeforeIds?`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; `pagination?`: [`Pagination`](Pagination.md); `pendingAfterIds?`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; `pendingBeforeIds?`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; \}\>
+
+Defined in: [packages/fate/src/store.ts:14](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/store.ts#L14)

package/docs/api/type-aliases/ListEntry.md

@@ -0,0 +1,5 @@
+# Type Alias: ListEntry
+
+> **ListEntry** = `Readonly`\<\{ `cursor?`: `string`; `id`: [`EntityId`](EntityId.md); \}\>
+
+Defined in: [packages/fate/src/list.ts:4](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/list.ts#L4)

package/docs/api/type-aliases/ListItem.md

@@ -0,0 +1,13 @@
+# Type Alias: ListItem\<V\>
+
+> **ListItem**\<`V`\> = `Readonly`\<\{ `args?`: `Record`\<`string`, `unknown`\>; `list`: `V`; \}\>
+
+Defined in: [packages/fate/src/types.ts:316](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/types.ts#L316)
+
+Definition of a list request for fetching data from the backend.
+
+## Type Parameters
+
+### V
+
+`V` *extends* [`View`](View.md)\<`any`, `any`\>