@nkzw/fate 0.1.3 → 1.0.0-rc.0

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

@@ -0,0 +1,74 @@
+# Function: createResolver()
+
+> **createResolver**\<`Item`, `Context`\>(`__namedParameters`): `object`
+
+Defined in: [packages/fate/src/server/dataView.ts:758](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L758)
+
+Builds a resolver that applies a client's selection to a server data view,
+filtering fields, running nested resolvers, and shaping Prisma selects.
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Context
+
+`Context` = `unknown`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### args?
+
+[`FateRecord`](../../type-aliases/FateRecord.md)
+
+#### ctx?
+
+`Context`
+
+#### select
+
+`Iterable`\<`string`\>
+
+#### view
+
+`DataView`\<`Item`\>
+
+## Returns
+
+`object`
+
+### resolve
+
+> **resolve**: (`item`) => `Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)\> = `plan.resolve`
+
+#### Parameters
+
+##### item
+
+`Item`
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)\>
+
+### resolveMany
+
+> **resolveMany**: (`items`) => `Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)[]\> = `plan.resolveMany`
+
+#### Parameters
+
+##### items
+
+[`FateRecord`](../../type-aliases/FateRecord.md)[]
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)[]\>
+
+### select
+
+> **select**: `AnyRecord`

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

@@ -0,0 +1,95 @@
+# Function: createSourcePlan()
+
+> **createSourcePlan**\<`Item`, `Context`, `Adapter`\>(`__namedParameters`): `object`
+
+Defined in: [packages/fate/src/server/source.ts:378](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L378)
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Context
+
+`Context` = `unknown`
+
+### Adapter
+
+`Adapter` = `unknown`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### args?
+
+`Record`\<`string`, `unknown`\>
+
+#### ctx?
+
+`Context`
+
+#### 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`\>

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

@@ -0,0 +1,46 @@
+# Function: createSourceProcedures()
+
+> **createSourceProcedures**\<`Context`, `Item`, `Procedure`, `ConnectionProcedure`, `ById`, `List`\>(`__namedParameters`): `SourceProcedureResult`\<`ById`, `List`, `Procedure`, `ConnectionProcedure`\>
+
+Defined in: [packages/fate/src/server/sourceRouter.ts:107](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/sourceRouter.ts#L107)
+
+Creates standard `byId` and `list` procedures for a Fate source.
+
+Use this when a router also has custom mutations or custom queries and you
+want to spread the generated source procedures into that router.
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Procedure
+
+`Procedure` *extends* `ProcedureLike`
+
+### ConnectionProcedure
+
+`ConnectionProcedure` *extends* `ConnectionProcedureLike` \| `undefined` = `ConnectionProcedureLike` \| `undefined`
+
+### ById
+
+`ById` *extends* `boolean` \| `undefined` = `undefined`
+
+### List
+
+`List` *extends* `boolean` \| `ListConfig` \| `undefined` = `undefined`
+
+## Parameters
+
+### \_\_namedParameters
+
+`SourceProcedureOptions`\<`Context`, `Item`, `Procedure`, `ConnectionProcedure`\> & `object`
+
+## Returns
+
+`SourceProcedureResult`\<`ById`, `List`, `Procedure`, `ConnectionProcedure`\>

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

@@ -0,0 +1,32 @@
+# Function: dataView()
+
+> **dataView**\<`Item`\>(`typeName`): \<`Fields`\>(`fields`) => `DataView`\<`Item`\> & `object`
+
+Defined in: [packages/fate/src/server/dataView.ts:164](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L164)
+
+Declares a server data view that exposes an object's available fields to the client.
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+## Parameters
+
+### typeName
+
+`string`
+
+## Returns
+
+\<`Fields`\>(`fields`) => `DataView`\<`Item`\> & `object`
+
+## Example
+
+```ts
+const Post = dataView<PostItem>('Post')({
+  id: true,
+  title: true,
+});
+```

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

@@ -0,0 +1,15 @@
+# Function: field()
+
+> **field**(`path`): [`FieldSelection`](../type-aliases/FieldSelection.md)
+
+Defined in: [packages/fate/src/server/dataView.ts:207](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L207)
+
+## Parameters
+
+### path
+
+`string`
+
+## Returns
+
+[`FieldSelection`](../type-aliases/FieldSelection.md)

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

@@ -0,0 +1,19 @@
+# Function: getNestedSelection()
+
+> **getNestedSelection**(`select`, `field`): `string`[]
+
+Defined in: [packages/fate/src/server/source.ts:312](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L312)
+
+## Parameters
+
+### select
+
+`Iterable`\<`string`\>
+
+### field
+
+`string`
+
+## Returns
+
+`string`[]

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

@@ -0,0 +1,21 @@
+# Function: getScopedArgs()
+
+> **getScopedArgs**(`args`, `path`): [`FateRecord`](../../type-aliases/FateRecord.md) \| `undefined`
+
+Defined in: [packages/fate/src/server/queryArgs.ts:30](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/queryArgs.ts#L30)
+
+Narrows nested args to the slice relevant for a particular selection path.
+
+## Parameters
+
+### args
+
+[`FateRecord`](../../type-aliases/FateRecord.md) \| `undefined`
+
+### path
+
+`string`
+
+## Returns
+
+[`FateRecord`](../../type-aliases/FateRecord.md) \| `undefined`

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

@@ -0,0 +1,19 @@
+# Function: hasNestedSelection()
+
+> **hasNestedSelection**(`select`, `field`): `boolean`
+
+Defined in: [packages/fate/src/server/source.ts:302](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/source.ts#L302)
+
+## Parameters
+
+### select
+
+`Iterable`\<`string`\>
+
+### field
+
+`string`
+
+## Returns
+
+`boolean`

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

@@ -0,0 +1,28 @@
+# Function: list()
+
+> **list**\<`Item`\>(`view`, `options?`): `DataView`\<`Item`\> & `DataViewInternals`\<`Item`\> & `object`
+
+Defined in: [packages/fate/src/server/dataView.ts:180](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L180)
+
+Marks a data view as a list resolver so the server can respond with
+connection information.
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+## Parameters
+
+### view
+
+`DataView`\<`Item`\>
+
+### options?
+
+[`DataViewListOptions`](../type-aliases/DataViewListOptions.md)
+
+## Returns
+
+`DataView`\<`Item`\> & `DataViewInternals`\<`Item`\> & `object`

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

@@ -0,0 +1,55 @@
+# Function: refetchSourceById()
+
+> **refetchSourceById**\<`Context`, `Item`\>(`__namedParameters`): `Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md) \| `null`\>
+
+Defined in: [packages/fate/src/server/executor.ts:208](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/executor.ts#L208)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+## Parameters
+
+### \_\_namedParameters
+
+#### ctx
+
+`Context`
+
+#### extra?
+
+`unknown`
+
+#### id
+
+`string`
+
+#### input
+
+\{ `args?`: `Record`\<`string`, `unknown`\>; `select`: `Iterable`\<`string`\>; \}
+
+#### input.args?
+
+`Record`\<`string`, `unknown`\>
+
+#### input.select
+
+`Iterable`\<`string`\>
+
+#### registry
+
+[`SourceRegistry`](../type-aliases/SourceRegistry.md)\<`Context`\>
+
+#### source
+
+[`SourceDefinition`](../type-aliases/SourceDefinition.md)\<`Item`, `unknown`\>
+
+## Returns
+
+`Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md) \| `null`\>

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

@@ -0,0 +1,55 @@
+# Function: resolveSourceById()
+
+> **resolveSourceById**\<`Context`, `Item`\>(`__namedParameters`): `Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md) \| `null`\>
+
+Defined in: [packages/fate/src/server/executor.ts:128](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/executor.ts#L128)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+## Parameters
+
+### \_\_namedParameters
+
+#### ctx
+
+`Context`
+
+#### extra?
+
+`unknown`
+
+#### id
+
+`string`
+
+#### input
+
+\{ `args?`: `Record`\<`string`, `unknown`\>; `select`: `Iterable`\<`string`\>; \}
+
+#### input.args?
+
+`Record`\<`string`, `unknown`\>
+
+#### input.select
+
+`Iterable`\<`string`\>
+
+#### registry
+
+[`SourceRegistry`](../type-aliases/SourceRegistry.md)\<`Context`\>
+
+#### source
+
+[`SourceDefinition`](../type-aliases/SourceDefinition.md)\<`Item`, `unknown`\>
+
+## Returns
+
+`Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md) \| `null`\>

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

@@ -0,0 +1,55 @@
+# Function: resolveSourceByIds()
+
+> **resolveSourceByIds**\<`Context`, `Item`\>(`__namedParameters`): `Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)[]\>
+
+Defined in: [packages/fate/src/server/executor.ts:92](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/executor.ts#L92)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+## Parameters
+
+### \_\_namedParameters
+
+#### ctx
+
+`Context`
+
+#### extra?
+
+`unknown`
+
+#### ids
+
+`string`[]
+
+#### input
+
+\{ `args?`: `Record`\<`string`, `unknown`\>; `select`: `Iterable`\<`string`\>; \}
+
+#### input.args?
+
+`Record`\<`string`, `unknown`\>
+
+#### input.select
+
+`Iterable`\<`string`\>
+
+#### registry
+
+[`SourceRegistry`](../type-aliases/SourceRegistry.md)\<`Context`\>
+
+#### source
+
+[`SourceDefinition`](../type-aliases/SourceDefinition.md)\<`Item`, `unknown`\>
+
+## Returns
+
+`Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)[]\>

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

@@ -0,0 +1,67 @@
+# Function: resolveSourceConnection()
+
+> **resolveSourceConnection**\<`Context`, `Item`\>(`__namedParameters`): `Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)[]\>
+
+Defined in: [packages/fate/src/server/executor.ts:163](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/executor.ts#L163)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+## Parameters
+
+### \_\_namedParameters
+
+#### ctx
+
+`Context`
+
+#### cursor?
+
+`string`
+
+#### direction
+
+`"forward"` \| `"backward"`
+
+#### extra?
+
+`unknown`
+
+#### input
+
+\{ `args?`: `Record`\<`string`, `unknown`\>; `select`: `Iterable`\<`string`\>; \}
+
+#### input.args?
+
+`Record`\<`string`, `unknown`\>
+
+#### input.select
+
+`Iterable`\<`string`\>
+
+#### registry
+
+[`SourceRegistry`](../type-aliases/SourceRegistry.md)\<`Context`\>
+
+#### skip?
+
+`number`
+
+#### source
+
+[`SourceDefinition`](../type-aliases/SourceDefinition.md)\<`Item`, `unknown`\>
+
+#### take
+
+`number`
+
+## Returns
+
+`Promise`\<[`FateRecord`](../../type-aliases/FateRecord.md)[]\>

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

@@ -0,0 +1,42 @@
+# Function: resolver()
+
+> **resolver**\<`Item`, `Result`, `Context`\>(`config`): `ResolverField`\<`Item`, `Result`, `Context`\>
+
+Defined in: [packages/fate/src/server/dataView.ts:196](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/dataView.ts#L196)
+
+Declares a resolver field inside a data view, optionally providing a
+selection for any data dependencies.
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* [`FateRecord`](../../type-aliases/FateRecord.md)
+
+### Result
+
+`Result` = `unknown`
+
+### Context
+
+`Context` = `unknown`
+
+## Parameters
+
+### config
+
+#### authorize?
+
+`ResolverAuthorize`\<`Item`, `Context`\>
+
+#### resolve
+
+`ResolverResolve`\<`Item`, `Result`, `Context`\>
+
+#### select?
+
+`ResolverSelect`\<`Context`\>
+
+## Returns
+
+`ResolverField`\<`Item`, `Result`, `Context`\>

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

@@ -0,0 +1,25 @@
+# Function: toPrismaSelect()
+
+> **toPrismaSelect**\<`Item`, `Context`\>(`plan`): `AnyRecord`
+
+Defined in: [packages/fate/src/server/prismaSelect.ts:279](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/prismaSelect.ts#L279)
+
+## Type Parameters
+
+### Item
+
+`Item` *extends* `AnyRecord`
+
+### Context
+
+`Context` = `unknown`
+
+## Parameters
+
+### plan
+
+`ViewPlan`\<`Item`, `Context`\>
+
+## Returns
+
+`AnyRecord`

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

@@ -0,0 +1,24 @@
+# Function: withConnection()
+
+> **withConnection**\<`TProcedure`\>(`procedure`): \<`TItem`, `TNode`, `TAdditionalInput`\>(`options`) => `ConnectionProcedure`\<`ConnectionInputWithAdditional`\<`TAdditionalInput`\>, [`ConnectionResult`](../type-aliases/ConnectionResult.md)\<`TNode`\>\>
+
+Defined in: [packages/fate/src/server/connection.ts:365](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/connection.ts#L365)
+
+Wraps a tRPC procedure to handle cursor-based pagination with consistent
+connection semantics.
+
+## Type Parameters
+
+### TProcedure
+
+`TProcedure` *extends* `ProcedureLike`
+
+## Parameters
+
+### procedure
+
+`TProcedure`
+
+## Returns
+
+\<`TItem`, `TNode`, `TAdditionalInput`\>(`options`) => `ConnectionProcedure`\<`ConnectionInputWithAdditional`\<`TAdditionalInput`\>, [`ConnectionResult`](../type-aliases/ConnectionResult.md)\<`TNode`\>\>