@nkzw/fate 0.1.3 → 1.0.0-rc.0

package/docs/api/server/index.md

@@ -0,0 +1,109 @@
+# @nkzw/fate/server
+
+The fate server library.
+
+## Example
+
+```ts
+import { dataView } from '@nkzw/fate/server';
+```
+
+## Classes
+
+- [FateRequestError](classes/FateRequestError.md)
+
+## Type Aliases
+
+- [ComputedField](type-aliases/ComputedField.md)
+- [ComputedSelection](type-aliases/ComputedSelection.md)
+- [ConnectionItem](type-aliases/ConnectionItem.md)
+- [ConnectionPagination](type-aliases/ConnectionPagination.md)
+- [ConnectionResult](type-aliases/ConnectionResult.md)
+- [CountSelection](type-aliases/CountSelection.md)
+- [CountWhere](type-aliases/CountWhere.md)
+- [DataViewListOptions](type-aliases/DataViewListOptions.md)
+- [DataViewOrderBy](type-aliases/DataViewOrderBy.md)
+- [DataViewOrderDirection](type-aliases/DataViewOrderDirection.md)
+- [DataViewResult](type-aliases/DataViewResult.md)
+- [Entity](type-aliases/Entity.md)
+- [FateServer](type-aliases/FateServer.md)
+- [FateServerManifest](type-aliases/FateServerManifest.md)
+- [FieldSelection](type-aliases/FieldSelection.md)
+- [LiveConnectionEventType](type-aliases/LiveConnectionEventType.md)
+- [LiveConnectionSourceEvent](type-aliases/LiveConnectionSourceEvent.md)
+- [LiveEventBus](type-aliases/LiveEventBus.md)
+- [LiveEventType](type-aliases/LiveEventType.md)
+- [LiveSourceEvent](type-aliases/LiveSourceEvent.md)
+- [NativeFateAPI](type-aliases/NativeFateAPI.md)
+- [OrderDirection](type-aliases/OrderDirection.md)
+- [SourceConfig](type-aliases/SourceConfig.md)
+- [SourceDefinition](type-aliases/SourceDefinition.md)
+- [SourceOrder](type-aliases/SourceOrder.md)
+- [SourceOrderField](type-aliases/SourceOrderField.md)
+- [SourcePlan](type-aliases/SourcePlan.md)
+- [SourcePlanNode](type-aliases/SourcePlanNode.md)
+- [SourceRegistry](type-aliases/SourceRegistry.md)
+- [SourceRelation](type-aliases/SourceRelation.md)
+- [SourceRelationConfig](type-aliases/SourceRelationConfig.md)
+
+## Variables
+
+- [byIdInput](variables/byIdInput.md)
+- [connectionArgs](variables/connectionArgs.md)
+
+## Functions
+
+- [bindSourceProcedures](functions/bindSourceProcedures.md)
+- [computed](functions/computed.md)
+- [count](functions/count.md)
+- [createFateFetchHandler](functions/createFateFetchHandler.md)
+- [createFateServer](functions/createFateServer.md)
+- [createHonoFateHandler](functions/createHonoFateHandler.md)
+- [createLiveEventBus](functions/createLiveEventBus.md)
+- [createNestedSourcePlan](functions/createNestedSourcePlan.md)
+- [createResolver](functions/createResolver.md)
+- [createSourcePlan](functions/createSourcePlan.md)
+- [createSourceProcedures](functions/createSourceProcedures.md)
+- [dataView](functions/dataView.md)
+- [field](functions/field.md)
+- [getNestedSelection](functions/getNestedSelection.md)
+- [getScopedArgs](functions/getScopedArgs.md)
+- [hasNestedSelection](functions/hasNestedSelection.md)
+- [list](functions/list.md)
+- [refetchSourceById](functions/refetchSourceById.md)
+- [resolver](functions/resolver.md)
+- [resolveSourceById](functions/resolveSourceById.md)
+- [resolveSourceByIds](functions/resolveSourceByIds.md)
+- [resolveSourceConnection](functions/resolveSourceConnection.md)
+- [toPrismaSelect](functions/toPrismaSelect.md)
+- [withConnection](functions/withConnection.md)
+
+## References
+
+### InferFateAPI
+
+Re-exports [InferFateAPI](../type-aliases/InferFateAPI.md)
+
+***
+
+### isRecord
+
+Re-exports [isRecord](../functions/isRecord.md)
+
+***
+
+### liveConnectionTopic
+
+Re-exports [liveConnectionTopic](../functions/liveConnectionTopic.md)
+
+***
+
+### liveEntityTopic
+
+Re-exports [liveEntityTopic](../functions/liveEntityTopic.md)
+
+***
+
+### liveGlobalConnectionTopic
+
+Re-exports [liveGlobalConnectionTopic](../functions/liveGlobalConnectionTopic.md)

package/docs/api/server/prisma/functions/createPrismaFate.md

@@ -0,0 +1,435 @@
+# Function: createPrismaFate()
+
+> **createPrismaFate**\<`Context`, `Procedure`\>(`__namedParameters`): `object`
+
+Defined in: [packages/fate/src/server/prisma.ts:749](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/prisma.ts#L749)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+### Procedure
+
+`Procedure` *extends* `ProcedureLike`
+
+## Parameters
+
+### \_\_namedParameters
+
+`PrismaSourceAdapterOptions`\<`Context`\> & `object`
+
+## Returns
+
+`object`
+
+### connection
+
+> **connection**: \<`TItem`, `TNode`, `TAdditionalInput`\>(`options`) => `ConnectionProcedure`\<`ConnectionInputWithAdditional`\<`TAdditionalInput`\>, [`ConnectionResult`](../../type-aliases/ConnectionResult.md)\<`TNode`\>\>
+
+#### Type Parameters
+
+##### TItem
+
+`TItem`
+
+##### TNode
+
+`TNode` = `TItem`
+
+##### TAdditionalInput
+
+`TAdditionalInput` *extends* `AdditionalInputSchema` \| `undefined` = `undefined`
+
+#### Parameters
+
+##### options
+
+###### defaultSize?
+
+`number`
+
+###### getCursor?
+
+(`node`) => `string`
+
+###### input?
+
+`TAdditionalInput`
+
+###### map?
+
+`MapFn`\<`ProcedureContext`\<`Procedure`\>, `TItem`, `TNode`, `ConnectionInputWithAdditional`\<`TAdditionalInput`\>\>
+
+###### query
+
+`QueryFn`\<`ProcedureContext`\<`Procedure`\>, `TItem`, `ConnectionInputWithAdditional`\<`TAdditionalInput`\>\>
+
+#### Returns
+
+`ConnectionProcedure`\<`ConnectionInputWithAdditional`\<`TAdditionalInput`\>, [`ConnectionResult`](../../type-aliases/ConnectionResult.md)\<`TNode`\>\>
+
+### createPlan
+
+> **createPlan**: \<`Item`\>(`__namedParameters`) => `object`
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+`SourceInput` & `object`
+
+#### 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`, `unknown`\>
+
+##### selectedPaths
+
+> **selectedPaths**: `Set`\<`string`\>
+
+##### source
+
+> **source**: [`SourceDefinition`](../../type-aliases/SourceDefinition.md)\<`Item`, `unknown`\>
+
+##### view
+
+> **view**: `DataView`\<`Item`\>
+
+### fetchById
+
+> **fetchById**: \<`Item`\>(`__namedParameters`) => `Promise`\<`Item` \| `null`\>
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### ctx
+
+`Context`
+
+###### extra?
+
+[`FateRecord`](../../../type-aliases/FateRecord.md)
+
+###### id
+
+`string`
+
+###### plan
+
+[`SourcePlan`](../../type-aliases/SourcePlan.md)\<`Item`, `Context`\>
+
+#### Returns
+
+`Promise`\<`Item` \| `null`\>
+
+### fetchByIds
+
+> **fetchByIds**: \<`Item`\>(`__namedParameters`) => `Promise`\<`Item`[]\>
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### ctx
+
+`Context`
+
+###### extra?
+
+[`FateRecord`](../../../type-aliases/FateRecord.md)
+
+###### ids
+
+`string`[]
+
+###### plan
+
+[`SourcePlan`](../../type-aliases/SourcePlan.md)\<`Item`, `Context`\>
+
+#### Returns
+
+`Promise`\<`Item`[]\>
+
+### fetchConnection
+
+> **fetchConnection**: \<`Item`\>(`__namedParameters`) => `Promise`\<`Item`[]\>
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### ctx
+
+`Context`
+
+###### cursor?
+
+`string`
+
+###### direction
+
+`"forward"` \| `"backward"`
+
+###### extra?
+
+[`FateRecord`](../../../type-aliases/FateRecord.md)
+
+###### plan
+
+[`SourcePlan`](../../type-aliases/SourcePlan.md)\<`Item`, `Context`\>
+
+###### skip?
+
+`number`
+
+###### take
+
+`number`
+
+#### Returns
+
+`Promise`\<`Item`[]\>
+
+### getSource
+
+> **getSource**: \<`Item`\>(`target`) => [`SourceDefinition`](../../type-aliases/SourceDefinition.md)\<`Item`, `unknown`\>
+
+#### 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`\>
+
+### procedures
+
+> **procedures**: \<`Item`, `ById`, `List`\>(`input`) => `SourceProcedureResult`\<`ById`, `List`, `Procedure`, \<`TItem`, `TNode`, `TAdditionalInput`\>(`options`) => `ConnectionProcedure`\<`ConnectionInputWithAdditional`\<`TAdditionalInput`\>, [`ConnectionResult`](../../type-aliases/ConnectionResult.md)\<`TNode`\>\>\>
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+##### ById
+
+`ById` *extends* `boolean` \| `undefined` = `undefined`
+
+##### List
+
+`List` *extends* `boolean` \| `ListConfig` \| `undefined` = `undefined`
+
+#### Parameters
+
+##### input
+
+`ViewProcedureInput`\<`Item`, `ById`, `List`\>
+
+#### Returns
+
+`SourceProcedureResult`\<`ById`, `List`, `Procedure`, \<`TItem`, `TNode`, `TAdditionalInput`\>(`options`) => `ConnectionProcedure`\<`ConnectionInputWithAdditional`\<`TAdditionalInput`\>, [`ConnectionResult`](../../type-aliases/ConnectionResult.md)\<`TNode`\>\>\>
+
+### registry
+
+> **registry**: [`SourceRegistry`](../../type-aliases/SourceRegistry.md)\<`Context`\>
+
+### resolveById
+
+> **resolveById**: \<`Item`\>(`__namedParameters`) => `Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md) \| `null`\>
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### ctx
+
+`Context`
+
+###### extra?
+
+[`FateRecord`](../../../type-aliases/FateRecord.md)
+
+###### id
+
+`string`
+
+###### input
+
+`SourceInput`
+
+###### view
+
+`ViewTarget`\<`Item`\>
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md) \| `null`\>
+
+### resolveByIds
+
+> **resolveByIds**: \<`Item`\>(`__namedParameters`) => `Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### ctx
+
+`Context`
+
+###### extra?
+
+[`FateRecord`](../../../type-aliases/FateRecord.md)
+
+###### ids
+
+`string`[]
+
+###### input
+
+`SourceInput`
+
+###### view
+
+`ViewTarget`\<`Item`\>
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>
+
+### resolveConnection
+
+> **resolveConnection**: \<`Item`\>(`__namedParameters`) => `Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>
+
+#### Type Parameters
+
+##### Item
+
+`Item` *extends* [`FateRecord`](../../../type-aliases/FateRecord.md) = [`FateRecord`](../../../type-aliases/FateRecord.md)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### ctx
+
+`Context`
+
+###### cursor?
+
+`string`
+
+###### direction
+
+`"forward"` \| `"backward"`
+
+###### extra?
+
+[`FateRecord`](../../../type-aliases/FateRecord.md)
+
+###### input
+
+`SourceInput`
+
+###### skip?
+
+`number`
+
+###### take
+
+`number`
+
+###### view
+
+`ViewTarget`\<`Item`\>
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>

package/docs/api/server/prisma/functions/createPrismaSourceAdapter.md

@@ -0,0 +1,21 @@
+# Function: createPrismaSourceAdapter()
+
+> **createPrismaSourceAdapter**\<`Context`\>(`__namedParameters`): [`PrismaSourceAdapter`](../type-aliases/PrismaSourceAdapter.md)\<`Context`\>
+
+Defined in: [packages/fate/src/server/prisma.ts:350](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/prisma.ts#L350)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+## Parameters
+
+### \_\_namedParameters
+
+`PrismaSourceAdapterOptions`\<`Context`\>
+
+## Returns
+
+[`PrismaSourceAdapter`](../type-aliases/PrismaSourceAdapter.md)\<`Context`\>

package/docs/api/server/prisma/functions/createPrismaSourceRegistry.md

@@ -0,0 +1,21 @@
+# Function: createPrismaSourceRegistry()
+
+> **createPrismaSourceRegistry**\<`Context`\>(`options`): [`SourceRegistry`](../../type-aliases/SourceRegistry.md)\<`Context`\>
+
+Defined in: [packages/fate/src/server/prisma.ts:745](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/prisma.ts#L745)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+## Parameters
+
+### options
+
+`PrismaSourceAdapterOptions`\<`Context`\>
+
+## Returns
+
+[`SourceRegistry`](../../type-aliases/SourceRegistry.md)\<`Context`\>

package/docs/api/server/prisma/functions/prismaConnectionArgs.md

@@ -0,0 +1,57 @@
+# Function: prismaConnectionArgs()
+
+> **prismaConnectionArgs**(`__namedParameters`): `object`
+
+Defined in: [packages/fate/src/server/prisma.ts:288](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/server/prisma.ts#L288)
+
+## Parameters
+
+### \_\_namedParameters
+
+#### cursor?
+
+`string`
+
+#### direction
+
+`"forward"` \| `"backward"`
+
+#### node
+
+[`SourcePlanNode`](../../type-aliases/SourcePlanNode.md)\<`any`, `any`\>
+
+#### skip?
+
+`number`
+
+#### take
+
+`number`
+
+## Returns
+
+`object`
+
+### cursor?
+
+> `optional` **cursor?**: `object`
+
+#### cursor.id
+
+> **id**: `string` = `cursor`
+
+### orderBy
+
+> **orderBy**: `object`[]
+
+#### Index Signature
+
+\[`key`: `string`\]: [`OrderDirection`](../../type-aliases/OrderDirection.md)
+
+### skip?
+
+> `optional` **skip?**: `number`
+
+### take
+
+> **take**: `number`

package/docs/api/server/prisma/index.md

@@ -0,0 +1,23 @@
+# @nkzw/fate/server/prisma
+
+Fate's Prisma integration.
+
+## Example
+
+```ts
+import { createPrismaFate } from '@nkzw/fate/server/prisma';
+```
+
+## Type Aliases
+
+- [PrismaDelegate](type-aliases/PrismaDelegate.md)
+- [PrismaQueryExtra](type-aliases/PrismaQueryExtra.md)
+- [PrismaSourceAdapter](type-aliases/PrismaSourceAdapter.md)
+- [PrismaViewConfig](type-aliases/PrismaViewConfig.md)
+
+## Functions
+
+- [createPrismaFate](functions/createPrismaFate.md)
+- [createPrismaSourceAdapter](functions/createPrismaSourceAdapter.md)
+- [createPrismaSourceRegistry](functions/createPrismaSourceRegistry.md)
+- [prismaConnectionArgs](functions/prismaConnectionArgs.md)