@nkzw/fate 0.1.3 → 1.0.0

package/docs/api/functions/clientRoot.md

@@ -0,0 +1,27 @@
+# Function: clientRoot()
+
+> **clientRoot**\<`Result`, `Type`\>(`type`): `RootDefinition`\<`Type`, `Result`\>
+
+Defined in: [packages/fate/src/root.ts:7](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/root.ts#L7)
+
+Defines a root query for an entity type, capturing the response shape.
+
+## Type Parameters
+
+### Result
+
+`Result`
+
+### Type
+
+`Type` *extends* `string`
+
+## Parameters
+
+### type
+
+`Type`
+
+## Returns
+
+`RootDefinition`\<`Type`, `Result`\>

package/docs/api/functions/createClient.md

@@ -0,0 +1,21 @@
+# Function: createClient()
+
+> **createClient**\<`T`\>(`options`): [`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\]\>
+
+Defined in: [packages/fate/src/client.ts:3006](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/client.ts#L3006)
+
+## Type Parameters
+
+### T
+
+`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`\>\>\]
+
+## Parameters
+
+### options
+
+`FateClientOptions`\<`T`\[`0`\], `T`\[`1`\]\>
+
+## Returns
+
+[`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\]\>

package/docs/api/functions/createHTTPTransport.md

@@ -0,0 +1,51 @@
+# Function: createHTTPTransport()
+
+> **createHTTPTransport**\<`API`, `Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`Mutations`\>
+
+Defined in: [packages/fate/src/httpTransport.ts:265](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/httpTransport.ts#L265)
+
+## Type Parameters
+
+### API
+
+`API` *extends* `FateAPIShape`
+
+### Mutations
+
+`Mutations` *extends* `TransportMutations` = `MutationMapFromAPI`\<`API`\>
+
+## Parameters
+
+### \_\_namedParameters
+
+#### eventSource?
+
+`EventSourceConstructor`
+
+#### fetch?
+
+`FetchLike` = `defaultFetch`
+
+#### headers?
+
+`HeadersFactory`
+
+#### live?
+
+`boolean` \| `LiveConnector` = `true`
+
+#### liveRetryMs?
+
+`number` = `1000`
+
+#### liveUrl?
+
+`string` \| `URL`
+
+#### url
+
+`string` \| `URL`
+
+## Returns
+
+[`Transport`](../interfaces/Transport.md)\<`Mutations`\>

package/docs/api/functions/createTRPCTransport.md

@@ -0,0 +1,46 @@
+# Function: createTRPCTransport()
+
+> **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/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/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.
+
+## Type Parameters
+
+### AppRouter
+
+`AppRouter` *extends* `AnyRouter`
+
+### Mutations
+
+`Mutations` *extends* `TRPCMutationResolvers`\<`AppRouter`\> = `EmptyMutationResolvers`\<`AppRouter`\>
+
+## Parameters
+
+### \_\_namedParameters
+
+#### byId
+
+`TRPCByIdResolvers`\<`AppRouter`\>
+
+#### client
+
+`TRPCClient`\<`AppRouter`\>
+
+#### lists?
+
+`TRPCListResolvers`\<`AppRouter`\>
+
+#### mutations?
+
+`Mutations`
+
+#### queries?
+
+`TRPCQueryResolvers`\<`AppRouter`\>
+
+## Returns
+
+[`Transport`](../interfaces/Transport.md)\<`MutationMapFromResolvers`\<`Mutations`\>\>

package/docs/api/functions/getListEntries.md

@@ -0,0 +1,15 @@
+# Function: getListEntries()
+
+> **getListEntries**(`listState`): `Readonly`\<\{ `cursor?`: `string`; `id`: `string`; \}\>[]
+
+Defined in: [packages/fate/src/list.ts:6](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/list.ts#L6)
+
+## Parameters
+
+### listState
+
+`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`
+
+## Returns
+
+`Readonly`\<\{ `cursor?`: `string`; `id`: `string`; \}\>[]

package/docs/api/functions/getSelectionPlan.md

@@ -0,0 +1,36 @@
+# Function: getSelectionPlan()
+
+> **getSelectionPlan**\<`T`, `S`, `V`\>(`viewComposition`, `ref`): `SelectionPlan`
+
+Defined in: [packages/fate/src/selection.ts:37](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/selection.ts#L37)
+
+Flattens a view into a `SelectionPlan`, expanding composed views and
+partitioning nested args so the client can fetch exactly what is declared.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Entity`](../type-aliases/Entity.md)
+
+### S
+
+`S` *extends* [`Selection`](../type-aliases/Selection.md)\<`T`\>
+
+### V
+
+`V` *extends* [`View`](../type-aliases/View.md)\<`T`, `S`\>
+
+## Parameters
+
+### viewComposition
+
+`V`
+
+### ref
+
+`Readonly`\<\{ `__typename`: `T`\[`"__typename"`\]; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\> \| `null`
+
+## Returns
+
+`SelectionPlan`

package/docs/api/functions/isRecord.md

@@ -0,0 +1,15 @@
+# Function: isRecord()
+
+> **isRecord**(`value`): `value is FateRecord`
+
+Defined in: [packages/fate/src/record.ts:3](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/record.ts#L3)
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is FateRecord`

package/docs/api/functions/isViewTag.md

@@ -0,0 +1,17 @@
+# Function: isViewTag()
+
+> **isViewTag**(`key`): `` key is `__fate-view__${string}` ``
+
+Defined in: [packages/fate/src/types.ts:59](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/types.ts#L59)
+
+Determines whether a property key is a fate view tag.
+
+## Parameters
+
+### key
+
+`string`
+
+## Returns
+
+`` key is `__fate-view__${string}` ``

package/docs/api/functions/liveConnectionTopic.md

@@ -0,0 +1,19 @@
+# Function: liveConnectionTopic()
+
+> **liveConnectionTopic**(`procedure`, `args?`): `string`
+
+Defined in: [packages/fate/src/liveTopics.ts:20](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/liveTopics.ts#L20)
+
+## Parameters
+
+### procedure
+
+`string`
+
+### args?
+
+`Record`\<`string`, `unknown`\>
+
+## Returns
+
+`string`

package/docs/api/functions/liveEntityTopic.md

@@ -0,0 +1,19 @@
+# Function: liveEntityTopic()
+
+> **liveEntityTopic**(`type`, `id`): `string`
+
+Defined in: [packages/fate/src/liveTopics.ts:17](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/liveTopics.ts#L17)
+
+## Parameters
+
+### type
+
+`string`
+
+### id
+
+`string` \| `number`
+
+## Returns
+
+`string`

package/docs/api/functions/liveGlobalConnectionTopic.md

@@ -0,0 +1,15 @@
+# Function: liveGlobalConnectionTopic()
+
+> **liveGlobalConnectionTopic**(`procedure`): `string`
+
+Defined in: [packages/fate/src/liveTopics.ts:25](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/liveTopics.ts#L25)
+
+## Parameters
+
+### procedure
+
+`string`
+
+## Returns
+
+`string`

package/docs/api/functions/mutation.md

@@ -0,0 +1,32 @@
+# Function: mutation()
+
+> **mutation**\<`T`, `I`, `R`\>(`entity`): [`MutationDefinition`](../type-aliases/MutationDefinition.md)\<`T`, `I`, `R`\>
+
+Defined in: [packages/fate/src/mutation.ts:28](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/mutation.ts#L28)
+
+Defines a mutation for a given entity type, preserving the input and output
+types for transports.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Entity`](../type-aliases/Entity.md)
+
+### I
+
+`I`
+
+### R
+
+`R`
+
+## Parameters
+
+### entity
+
+`T`\[`"__typename"`\]
+
+## Returns
+
+[`MutationDefinition`](../type-aliases/MutationDefinition.md)\<`T`, `I`, `R`\>

package/docs/api/functions/toEntityId.md

@@ -0,0 +1,21 @@
+# Function: toEntityId()
+
+> **toEntityId**(`type`, `rawId`): `string`
+
+Defined in: [packages/fate/src/ref.ts:16](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/ref.ts#L16)
+
+Builds the canonical cache ID for an entity.
+
+## Parameters
+
+### type
+
+`string`
+
+### rawId
+
+`string` \| `number`
+
+## Returns
+
+`string`

package/docs/api/functions/view.md

@@ -0,0 +1,26 @@
+# Function: view()
+
+> **view**\<`T`\>(): \<`S`\>(`select`) => [`View`](../type-aliases/View.md)\<`T`, `S`\>
+
+Defined in: [packages/fate/src/view.ts:111](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/view.ts#L111)
+
+Creates a reusable view for an object using the declared selection.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Entity`](../type-aliases/Entity.md)
+
+## Returns
+
+\<`S`\>(`select`) => [`View`](../type-aliases/View.md)\<`T`, `S`\>
+
+## Example
+
+```ts
+const PostView = view<Post>()({
+  id: true,
+  title: true,
+});
+```

package/docs/api/index.md

@@ -0,0 +1,81 @@
+# @nkzw/fate
+
+The fate core library.
+
+## Example
+
+```ts
+import { view } from '@nkzw/fate';
+```
+
+## Classes
+
+- [FateClient](classes/FateClient.md)
+
+## Interfaces
+
+- [FateThenable](interfaces/FateThenable.md)
+- [Transport](interfaces/Transport.md)
+
+## Type Aliases
+
+- [ConnectionMetadata](type-aliases/ConnectionMetadata.md)
+- [ConnectionRef](type-aliases/ConnectionRef.md)
+- [Entity](type-aliases/Entity.md)
+- [EntityId](type-aliases/EntityId.md)
+- [FateLiveConnectionEvent](type-aliases/FateLiveConnectionEvent.md)
+- [FateLiveEvent](type-aliases/FateLiveEvent.md)
+- [FateMutations](type-aliases/FateMutations.md)
+- [FateOperation](type-aliases/FateOperation.md)
+- [FateProtocolRequest](type-aliases/FateProtocolRequest.md)
+- [FateProtocolResponse](type-aliases/FateProtocolResponse.md)
+- [FateRecord](type-aliases/FateRecord.md)
+- [FateRoots](type-aliases/FateRoots.md)
+- [InferFateAPI](type-aliases/InferFateAPI.md)
+- [List](type-aliases/List.md)
+- [ListEntry](type-aliases/ListEntry.md)
+- [ListItem](type-aliases/ListItem.md)
+- [Mask](type-aliases/Mask.md)
+- [MutationDefinition](type-aliases/MutationDefinition.md)
+- [MutationEntity](type-aliases/MutationEntity.md)
+- [MutationIdentifier](type-aliases/MutationIdentifier.md)
+- [MutationInput](type-aliases/MutationInput.md)
+- [MutationResult](type-aliases/MutationResult.md)
+- [NodesItem](type-aliases/NodesItem.md)
+- [Pagination](type-aliases/Pagination.md)
+- [Request](type-aliases/Request.md)
+- [RequestMode](type-aliases/RequestMode.md)
+- [RequestOptions](type-aliases/RequestOptions.md)
+- [RequestResult](type-aliases/RequestResult.md)
+- [Selection](type-aliases/Selection.md)
+- [Snapshot](type-aliases/Snapshot.md)
+- [TypeConfig](type-aliases/TypeConfig.md)
+- [View](type-aliases/View.md)
+- [ViewData](type-aliases/ViewData.md)
+- [ViewEntity](type-aliases/ViewEntity.md)
+- [ViewEntityName](type-aliases/ViewEntityName.md)
+- [ViewRef](type-aliases/ViewRef.md)
+- [ViewSelection](type-aliases/ViewSelection.md)
+- [ViewSnapshot](type-aliases/ViewSnapshot.md)
+- [ViewTag](type-aliases/ViewTag.md)
+
+## Variables
+
+- [ConnectionTag](variables/ConnectionTag.md)
+
+## Functions
+
+- [clientRoot](functions/clientRoot.md)
+- [createClient](functions/createClient.md)
+- [createHTTPTransport](functions/createHTTPTransport.md)
+- [createTRPCTransport](functions/createTRPCTransport.md)
+- [getListEntries](functions/getListEntries.md)
+- [getSelectionPlan](functions/getSelectionPlan.md)
+- [isRecord](functions/isRecord.md)
+- [isViewTag](functions/isViewTag.md)
+- [liveConnectionTopic](functions/liveConnectionTopic.md)
+- [liveEntityTopic](functions/liveEntityTopic.md)
+- [liveGlobalConnectionTopic](functions/liveGlobalConnectionTopic.md)
+- [mutation](functions/mutation.md)
+- [toEntityId](functions/toEntityId.md)
+- [view](functions/view.md)

package/docs/api/interfaces/FateThenable.md

@@ -0,0 +1,31 @@
+# Interface: FateThenable\<T\>
+
+Defined in: [packages/fate/src/types.ts:484](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/types.ts#L484)
+
+Promise-like value returned by cache reads that already have a resolved payload for React `use`.
+
+## Extends
+
+- `PromiseLike`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### status
+
+> **status**: `"fulfilled"`
+
+Defined in: [packages/fate/src/types.ts:485](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/types.ts#L485)
+
+***
+
+### value
+
+> **value**: `T`
+
+Defined in: [packages/fate/src/types.ts:486](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/types.ts#L486)

package/docs/api/interfaces/Transport.md

@@ -0,0 +1,199 @@
+# Interface: Transport\<Mutations\>
+
+Defined in: [packages/fate/src/transport.ts:52](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/transport.ts#L52)
+
+Contract the fate client expects from a network transport. The transport is
+responsible for fetching records by ID, fetching lists, and executing
+mutations with the provided selections.
+
+## Type Parameters
+
+### Mutations
+
+`Mutations` *extends* `TransportMutations` = `EmptyTransportMutations`
+
+## Methods
+
+### fetchById()
+
+> **fetchById**(`type`, `ids`, `select`, `args?`): `Promise`\<`unknown`[]\>
+
+Defined in: [packages/fate/src/transport.ts:53](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/transport.ts#L53)
+
+#### Parameters
+
+##### type
+
+`string`
+
+##### ids
+
+(`string` \| `number`)[]
+
+##### select
+
+`Iterable`\<`string`\>
+
+##### args?
+
+[`FateRecord`](../type-aliases/FateRecord.md)
+
+#### Returns
+
+`Promise`\<`unknown`[]\>
+
+***
+
+### fetchList()?
+
+> `optional` **fetchList**(`proc`, `select`, `args?`): `Promise`\<\{ `items`: `object`[]; `pagination`: [`Pagination`](../type-aliases/Pagination.md); \}\>
+
+Defined in: [packages/fate/src/transport.ts:59](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/transport.ts#L59)
+
+#### Parameters
+
+##### proc
+
+`string`
+
+##### select
+
+`Iterable`\<`string`\>
+
+##### args?
+
+[`FateRecord`](../type-aliases/FateRecord.md)
+
+#### Returns
+
+`Promise`\<\{ `items`: `object`[]; `pagination`: [`Pagination`](../type-aliases/Pagination.md); \}\>
+
+***
+
+### fetchQuery()?
+
+> `optional` **fetchQuery**(`proc`, `select`, `args?`): `Promise`\<`unknown`\>
+
+Defined in: [packages/fate/src/transport.ts:67](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/transport.ts#L67)
+
+#### Parameters
+
+##### proc
+
+`string`
+
+##### select
+
+`Iterable`\<`string`\>
+
+##### args?
+
+[`FateRecord`](../type-aliases/FateRecord.md)
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+***
+
+### mutate()?
+
+> `optional` **mutate**\<`K`\>(`proc`, `input`, `select`): `Promise`\<`Mutations`\[`K`\]\[`"output"`\]\>
+
+Defined in: [packages/fate/src/transport.ts:68](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/transport.ts#L68)
+
+#### Type Parameters
+
+##### K
+
+`K` *extends* `string`
+
+#### Parameters
+
+##### proc
+
+`K`
+
+##### input
+
+`Mutations`\[`K`\]\[`"input"`\]
+
+##### select
+
+`Set`\<`string`\>
+
+#### Returns
+
+`Promise`\<`Mutations`\[`K`\]\[`"output"`\]\>
+
+***
+
+### subscribeById()?
+
+> `optional` **subscribeById**(`type`, `id`, `select`, `args`, `handlers`): () => `void`
+
+Defined in: [packages/fate/src/transport.ts:73](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/transport.ts#L73)
+
+#### Parameters
+
+##### type
+
+`string`
+
+##### id
+
+`string` \| `number`
+
+##### select
+
+`Iterable`\<`string`\>
+
+##### args
+
+[`FateRecord`](../type-aliases/FateRecord.md) \| `undefined`
+
+##### handlers
+
+`LiveEventHandlers`
+
+#### Returns
+
+() => `void`
+
+***
+
+### subscribeConnection()?
+
+> `optional` **subscribeConnection**(`procedure`, `type`, `args`, `select`, `selectionArgs`, `handlers`): () => `void`
+
+Defined in: [packages/fate/src/transport.ts:80](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/transport.ts#L80)
+
+#### Parameters
+
+##### procedure
+
+`string`
+
+##### type
+
+`string`
+
+##### args
+
+[`FateRecord`](../type-aliases/FateRecord.md) \| `undefined`
+
+##### select
+
+`Iterable`\<`string`\>
+
+##### selectionArgs
+
+[`FateRecord`](../type-aliases/FateRecord.md) \| `undefined`
+
+##### handlers
+
+`LiveConnectionEventHandlers`
+
+#### Returns
+
+() => `void`