@nkzw/fate 0.1.2 → 1.0.0-rc.0

package/docs/api/server/drizzle/type-aliases/DrizzleSourceAdapter.md

@@ -0,0 +1,337 @@
+# Type Alias: DrizzleSourceAdapter\<Context\>
+
+> **DrizzleSourceAdapter**\<`Context`\> = `object`
+
+Defined in: [packages/fate/src/server/drizzle.ts:132](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L132)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+## Properties
+
+### fetchById
+
+> **fetchById**: \<`Item`\>(`{
+    ctx,
+    extra,
+    id,
+    plan,
+  }`) => `Promise`\<`Item` \| `null`\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:133](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L133)
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \{
+    ctx,
+    extra,
+    id,
+    plan,
+  \}
+
+###### ctx?
+
+`Context`
+
+###### extra?
+
+[`DrizzleQueryExtra`](DrizzleQueryExtra.md)
+
+###### id
+
+`string`
+
+###### plan
+
+[`SourcePlan`](../../type-aliases/SourcePlan.md)\<`Item`, `Context`\>
+
+#### Returns
+
+`Promise`\<`Item` \| `null`\>
+
+***
+
+### fetchByIds
+
+> **fetchByIds**: \<`Item`\>(`{
+    ctx,
+    extra,
+    ids,
+    plan,
+  }`) => `Promise`\<`Item`[]\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:144](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L144)
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \{
+    ctx,
+    extra,
+    ids,
+    plan,
+  \}
+
+###### ctx?
+
+`Context`
+
+###### extra?
+
+[`DrizzleQueryExtra`](DrizzleQueryExtra.md)
+
+###### ids
+
+`string`[]
+
+###### plan
+
+[`SourcePlan`](../../type-aliases/SourcePlan.md)\<`Item`, `Context`\>
+
+#### Returns
+
+`Promise`\<`Item`[]\>
+
+***
+
+### fetchConnection
+
+> **fetchConnection**: \<`Item`\>(`{
+    ctx,
+    cursor,
+    direction,
+    extra,
+    plan,
+    take,
+  }`) => `Promise`\<`Item`[]\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:155](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L155)
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \{
+    ctx,
+    cursor,
+    direction,
+    extra,
+    plan,
+    take,
+  \}
+
+###### ctx?
+
+`Context`
+
+###### cursor?
+
+`string`
+
+###### direction
+
+`"backward"` \| `"forward"`
+
+###### extra?
+
+[`DrizzleQueryExtra`](DrizzleQueryExtra.md)
+
+###### plan
+
+[`SourcePlan`](../../type-aliases/SourcePlan.md)\<`Item`, `Context`\>
+
+###### take
+
+`number`
+
+#### Returns
+
+`Promise`\<`Item`[]\>
+
+***
+
+### getSource
+
+> **getSource**: \<`Item`\>(`target`) => [`SourceDefinition`](../../type-aliases/SourceDefinition.md)\<`Item`, `unknown`\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:170](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L170)
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### target
+
+`SourceTarget`\<`Item`\>
+
+#### Returns
+
+[`SourceDefinition`](../../type-aliases/SourceDefinition.md)\<`Item`, `unknown`\>
+
+***
+
+### registry
+
+> **registry**: [`SourceRegistry`](../../type-aliases/SourceRegistry.md)\<`Context`\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:173](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L173)
+
+***
+
+### resolveById
+
+> **resolveById**: \<`Item`\>(`options`) => `Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md) \| `null`\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:174](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L174)
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### options
+
+###### ctx
+
+`Context`
+
+###### extra?
+
+[`DrizzleQueryExtra`](DrizzleQueryExtra.md)
+
+###### id
+
+`string`
+
+###### input
+
+`SourceInput`
+
+###### view
+
+`ViewTarget`\<`Item`\>
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md) \| `null`\>
+
+***
+
+### resolveByIds
+
+> **resolveByIds**: \<`Item`\>(`options`) => `Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:181](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L181)
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### options
+
+###### ctx
+
+`Context`
+
+###### extra?
+
+[`DrizzleQueryExtra`](DrizzleQueryExtra.md)
+
+###### ids
+
+`string`[]
+
+###### input
+
+`SourceInput`
+
+###### view
+
+`ViewTarget`\<`Item`\>
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>
+
+***
+
+### resolveConnection
+
+> **resolveConnection**: \<`Item`\>(`options`) => `Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:188](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L188)
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### options
+
+###### ctx
+
+`Context`
+
+###### cursor?
+
+`string`
+
+###### direction
+
+`"backward"` \| `"forward"`
+
+###### extra?
+
+[`DrizzleQueryExtra`](DrizzleQueryExtra.md)
+
+###### input
+
+`SourceInput`
+
+###### skip?
+
+`number`
+
+###### take
+
+`number`
+
+###### view
+
+`ViewTarget`\<`Item`\>
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>

package/docs/api/server/drizzle/type-aliases/DrizzleViewConfig.md

@@ -0,0 +1,29 @@
+# Type Alias: DrizzleViewConfig\<Item, TTable\>
+
+> **DrizzleViewConfig**\<`Item`, `TTable`\> = [`SourceConfig`](../../type-aliases/SourceConfig.md)\<`Item`, `unknown`\> & `object`
+
+Defined in: [packages/fate/src/server/drizzle.ts:109](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/drizzle.ts#L109)
+
+## Type Declaration
+
+### columns?
+
+> `optional` **columns?**: `ColumnMap`
+
+### manyToMany?
+
+> `optional` **manyToMany?**: `Record`\<`string`, [`DrizzleManyToManyInput`](DrizzleManyToManyInput.md)\>
+
+### table
+
+> **table**: `TTable`
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+### TTable
+
+`TTable` *extends* `DrizzleTable` = `DrizzleTable`

package/docs/api/server/functions/bindSourceProcedures.md

@@ -0,0 +1,32 @@
+# Function: bindSourceProcedures()
+
+> **bindSourceProcedures**\<`Context`, `Procedure`, `ConnectionProcedure`\>(`defaults`): \<`Item`, `ById`, `List`\>(`input`) => `SourceProcedureResult`\<`ById`, `List`, `Procedure`, `ConnectionProcedure`\>
+
+Defined in: [packages/fate/src/server/sourceRouter.ts:183](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/sourceRouter.ts#L183)
+
+Binds the app-specific tRPC pieces once and returns a compact helper for
+source procedures.
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+### Procedure
+
+`Procedure` *extends* `ProcedureLike`
+
+### ConnectionProcedure
+
+`ConnectionProcedure` *extends* `ConnectionProcedureLike` \| `undefined` = `ConnectionProcedureLike` \| `undefined`
+
+## Parameters
+
+### defaults
+
+`SourceProcedureFactoryDefaults`\<`Context`, `Procedure`, `ConnectionProcedure`\>
+
+## Returns
+
+\<`Item`, `ById`, `List`\>(`input`) => `SourceProcedureResult`\<`ById`, `List`, `Procedure`, `ConnectionProcedure`\>

package/docs/api/server/functions/computed.md

@@ -0,0 +1,43 @@
+# Function: computed()
+
+> **computed**\<`Item`, `Result`, `Context`, `Select`\>(`config`): [`ComputedField`](../type-aliases/ComputedField.md)\<`Item`, `Result`, `Context`, `Select`\>
+
+Defined in: [packages/fate/src/server/dataView.ts:218](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L218)
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Result
+
+`Result` = `unknown`
+
+### Context
+
+`Context` = `unknown`
+
+### Select
+
+`Select` *extends* `Record`\<`string`, [`ComputedSelection`](../type-aliases/ComputedSelection.md)\> \| `undefined` = `Record`\<`string`, [`ComputedSelection`](../type-aliases/ComputedSelection.md)\>
+
+## Parameters
+
+### config
+
+#### authorize?
+
+`ResolverAuthorize`\<`Item`, `Context`\>
+
+#### resolve
+
+`ComputedResolve`\<`Item`, `Result`, `Select`, `Context`\>
+
+#### select?
+
+`Select`
+
+## Returns
+
+[`ComputedField`](../type-aliases/ComputedField.md)\<`Item`, `Result`, `Context`, `Select`\>

package/docs/api/server/functions/count.md

@@ -0,0 +1,21 @@
+# Function: count()
+
+> **count**(`relation`, `options?`): [`CountSelection`](../type-aliases/CountSelection.md)
+
+Defined in: [packages/fate/src/server/dataView.ts:212](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L212)
+
+## Parameters
+
+### relation
+
+`string`
+
+### options?
+
+#### where?
+
+[`CountWhere`](../type-aliases/CountWhere.md)
+
+## Returns
+
+[`CountSelection`](../type-aliases/CountSelection.md)

package/docs/api/server/functions/createFateFetchHandler.md

@@ -0,0 +1,21 @@
+# Function: createFateFetchHandler()
+
+> **createFateFetchHandler**\<`AdapterContext`\>(`server`): (`request`, `adapterContext?`) => `Promise`\<`Response`\>
+
+Defined in: [packages/fate/src/server/http.ts:1413](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L1413)
+
+## Type Parameters
+
+### AdapterContext
+
+`AdapterContext`
+
+## Parameters
+
+### server
+
+[`FateServer`](../type-aliases/FateServer.md)\<`unknown`, `AdapterContext`\>
+
+## Returns
+
+(`request`, `adapterContext?`) => `Promise`\<`Response`\>

package/docs/api/server/functions/createFateServer.md

@@ -0,0 +1,41 @@
+# Function: createFateServer()
+
+> **createFateServer**\<`Context`, `Roots`, `Queries`, `Lists`, `Mutations`, `AdapterContext`\>(`__namedParameters`): [`FateServer`](../type-aliases/FateServer.md)\<[`NativeFateAPI`](../type-aliases/NativeFateAPI.md)\<`Roots`, `Queries`, `Lists`, `Mutations`\>, `AdapterContext`\>
+
+Defined in: [packages/fate/src/server/http.ts:606](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L606)
+
+## Type Parameters
+
+### Context
+
+`Context` = `unknown`
+
+### Roots
+
+`Roots` *extends* `RootMap` = `RootMap`
+
+### Queries
+
+`Queries` *extends* `Record`\<`string`, `QueryDefinition`\<`Context`, `any`, `any`\>\> = `Record`\<`never`, `never`\>
+
+### Lists
+
+`Lists` *extends* `Record`\<`string`, `ListDefinition`\<`Context`, `any`, `any`\>\> = `Record`\<`never`, `never`\>
+
+### Mutations
+
+`Mutations` *extends* `Record`\<`string`, `MutationDefinition`\<`Context`, `any`, `any`\>\> = `Record`\<`never`, `never`\>
+
+### AdapterContext
+
+`AdapterContext` = `unknown`
+
+## Parameters
+
+### \_\_namedParameters
+
+`FateServerOptions`\<`Context`, `Roots`, `Queries`, `Lists`, `Mutations`, `AdapterContext`\>
+
+## Returns
+
+[`FateServer`](../type-aliases/FateServer.md)\<[`NativeFateAPI`](../type-aliases/NativeFateAPI.md)\<`Roots`, `Queries`, `Lists`, `Mutations`\>, `AdapterContext`\>

package/docs/api/server/functions/createHonoFateHandler.md

@@ -0,0 +1,21 @@
+# Function: createHonoFateHandler()
+
+> **createHonoFateHandler**\<`Context`\>(`server`): (`context`) => `Promise`\<`Response`\>
+
+Defined in: [packages/fate/src/server/http.ts:1424](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/http.ts#L1424)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+## Parameters
+
+### server
+
+[`FateServer`](../type-aliases/FateServer.md)\<`unknown`, `Context`\>
+
+## Returns
+
+(`context`) => `Promise`\<`Response`\>

package/docs/api/server/functions/createLiveEventBus.md

@@ -0,0 +1,17 @@
+# Function: createLiveEventBus()
+
+> **createLiveEventBus**(): [`LiveEventBus`](../type-aliases/LiveEventBus.md)
+
+Defined in: [packages/fate/src/server/live.ts:195](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/live.ts#L195)
+
+Creates a small in-memory event bus for Fate live view subscriptions.
+
+The bus signals that an entity changed and can optionally include changed
+field paths. The native live handler refetches the selected record, or only
+the changed selected fields when paths are provided, before sending it to
+clients. It does not persist events or replay events after reconnects; provide
+a durable custom bus for lossless `lastEventId` resume behavior.
+
+## Returns
+
+[`LiveEventBus`](../type-aliases/LiveEventBus.md)

package/docs/api/server/functions/createNestedSourcePlan.md

@@ -0,0 +1,103 @@
+# Function: createNestedSourcePlan()
+
+> **createNestedSourcePlan**\<`Item`, `Context`, `Adapter`\>(`__namedParameters`): `object`
+
+Defined in: [packages/fate/src/server/source.ts:403](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L403)
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Context
+
+`Context` = `unknown`
+
+### Adapter
+
+`Adapter` = `unknown`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### ctx?
+
+`Context`
+
+#### field
+
+`string`
+
+#### input
+
+\{ `args?`: `Record`\<`string`, `unknown`\>; `select`: `Iterable`\<`string`\>; \}
+
+#### input.args?
+
+`Record`\<`string`, `unknown`\>
+
+#### input.select
+
+`Iterable`\<`string`\>
+
+#### source
+
+[`SourceDefinition`](../type-aliases/SourceDefinition.md)\<`Item`, `Adapter`\>
+
+## Returns
+
+`object`
+
+### args
+
+> **args**: [`FateRecord`](../../type-aliases/FateRecord.md) \| `undefined`
+
+### ctx
+
+> **ctx**: `Context` \| `undefined`
+
+### resolve
+
+> **resolve**: (`item`) => `Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)\>
+
+#### Parameters
+
+##### item
+
+`Item`
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)\>
+
+### resolveMany
+
+> **resolveMany**: (`items`) => `Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)[]\>
+
+#### Parameters
+
+##### items
+
+[`FateRecord`](../../type-aliases/FateRecord.md)[]
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)[]\>
+
+### root
+
+> **root**: [`SourcePlanNode`](../type-aliases/SourcePlanNode.md)\<`unknown`, `Adapter`\>
+
+### selectedPaths
+
+> **selectedPaths**: `Set`\<`string`\>
+
+### source
+
+> **source**: [`SourceDefinition`](../type-aliases/SourceDefinition.md)\<`Item`, `Adapter`\>
+
+### view
+
+> **view**: `DataView`\<`Item`\>