@nkzw/fate 0.1.3 → 1.0.0

package/docs/api/server/classes/FateRequestError.md

@@ -0,0 +1,67 @@
+# Class: FateRequestError
+
+Defined in: [packages/fate/src/protocol.ts:151](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/protocol.ts#L151)
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new FateRequestError**(`code`, `message`, `options?`): `FateRequestError`
+
+Defined in: [packages/fate/src/protocol.ts:156](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/protocol.ts#L156)
+
+#### Parameters
+
+##### code
+
+`FateProtocolErrorCode`
+
+##### message
+
+`string`
+
+##### options?
+
+###### issues?
+
+`unknown`
+
+###### status?
+
+`number`
+
+#### Returns
+
+`FateRequestError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### code
+
+> `readonly` **code**: `FateProtocolErrorCode`
+
+Defined in: [packages/fate/src/protocol.ts:152](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/protocol.ts#L152)
+
+***
+
+### issues?
+
+> `readonly` `optional` **issues?**: `unknown`
+
+Defined in: [packages/fate/src/protocol.ts:153](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/protocol.ts#L153)
+
+***
+
+### status
+
+> `readonly` **status**: `number`
+
+Defined in: [packages/fate/src/protocol.ts:154](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/protocol.ts#L154)

package/docs/api/server/drizzle/functions/createDrizzleFate.md

@@ -0,0 +1,431 @@
+# Function: createDrizzleFate()
+
+> **createDrizzleFate**\<`Context`, `Procedure`\>(`__namedParameters`): `object`
+
+Defined in: [packages/fate/src/server/drizzle.ts:1551](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/server/drizzle.ts#L1551)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+### Procedure
+
+`Procedure` *extends* `ProcedureLike`
+
+## Parameters
+
+### \_\_namedParameters
+
+`DrizzleSourceAdapterOptions`\<`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?
+
+[`DrizzleQueryExtra`](../type-aliases/DrizzleQueryExtra.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?
+
+[`DrizzleQueryExtra`](../type-aliases/DrizzleQueryExtra.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?
+
+[`DrizzleQueryExtra`](../type-aliases/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`\>
+
+#### 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?
+
+[`DrizzleQueryExtra`](../type-aliases/DrizzleQueryExtra.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?
+
+[`DrizzleQueryExtra`](../type-aliases/DrizzleQueryExtra.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?
+
+[`DrizzleQueryExtra`](../type-aliases/DrizzleQueryExtra.md)
+
+###### input
+
+`SourceInput`
+
+###### skip?
+
+`number`
+
+###### take
+
+`number`
+
+###### view
+
+`ViewTarget`\<`Item`\>
+
+#### Returns
+
+`Promise`\<[`FateRecord`](../../../type-aliases/FateRecord.md)[]\>

package/docs/api/server/drizzle/functions/createDrizzleSourceAdapter.md

@@ -0,0 +1,21 @@
+# Function: createDrizzleSourceAdapter()
+
+> **createDrizzleSourceAdapter**\<`Context`\>(`__namedParameters`): [`DrizzleSourceAdapter`](../type-aliases/DrizzleSourceAdapter.md)\<`Context`\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:719](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/server/drizzle.ts#L719)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+## Parameters
+
+### \_\_namedParameters
+
+`DrizzleSourceAdapterOptions`\<`Context`\>
+
+## Returns
+
+[`DrizzleSourceAdapter`](../type-aliases/DrizzleSourceAdapter.md)\<`Context`\>

package/docs/api/server/drizzle/functions/createDrizzleSourceRegistry.md

@@ -0,0 +1,21 @@
+# Function: createDrizzleSourceRegistry()
+
+> **createDrizzleSourceRegistry**\<`Context`\>(`options`): [`SourceRegistry`](../../type-aliases/SourceRegistry.md)\<`Context`\>
+
+Defined in: [packages/fate/src/server/drizzle.ts:1547](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/server/drizzle.ts#L1547)
+
+## Type Parameters
+
+### Context
+
+`Context`
+
+## Parameters
+
+### options
+
+`DrizzleSourceAdapterOptions`\<`Context`\>
+
+## Returns
+
+[`SourceRegistry`](../../type-aliases/SourceRegistry.md)\<`Context`\>

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

@@ -0,0 +1,23 @@
+# @nkzw/fate/server/drizzle
+
+Fate's Drizzle integration.
+
+## Example
+
+```ts
+import { createDrizzleFate } from '@nkzw/fate/server/drizzle';
+```
+
+## Type Aliases
+
+- [DrizzleManyToManyConfig](type-aliases/DrizzleManyToManyConfig.md)
+- [DrizzleManyToManyInput](type-aliases/DrizzleManyToManyInput.md)
+- [DrizzleQueryExtra](type-aliases/DrizzleQueryExtra.md)
+- [DrizzleSourceAdapter](type-aliases/DrizzleSourceAdapter.md)
+- [DrizzleViewConfig](type-aliases/DrizzleViewConfig.md)
+
+## Functions
+
+- [createDrizzleFate](functions/createDrizzleFate.md)
+- [createDrizzleSourceAdapter](functions/createDrizzleSourceAdapter.md)
+- [createDrizzleSourceRegistry](functions/createDrizzleSourceRegistry.md)

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

@@ -0,0 +1,15 @@
+# Type Alias: DrizzleManyToManyConfig
+
+> **DrizzleManyToManyConfig** = `DrizzleManyToManyColumns` & `object`
+
+Defined in: [packages/fate/src/server/drizzle.ts:102](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/server/drizzle.ts#L102)
+
+## Type Declaration
+
+### columns?
+
+> `optional` **columns?**: `ColumnMap`
+
+### table
+
+> **table**: `DrizzleTable`

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

@@ -0,0 +1,5 @@
+# Type Alias: DrizzleManyToManyInput
+
+> **DrizzleManyToManyInput** = [`DrizzleManyToManyConfig`](DrizzleManyToManyConfig.md) \| `DrizzleTable`
+
+Defined in: [packages/fate/src/server/drizzle.ts:107](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/server/drizzle.ts#L107)

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

@@ -0,0 +1,21 @@
+# Type Alias: DrizzleQueryExtra
+
+> **DrizzleQueryExtra** = `object`
+
+Defined in: [packages/fate/src/server/drizzle.ts:87](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/server/drizzle.ts#L87)
+
+## Properties
+
+### extraFields?
+
+> `optional` **extraFields?**: `string`[]
+
+Defined in: [packages/fate/src/server/drizzle.ts:88](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/server/drizzle.ts#L88)
+
+***
+
+### where?
+
+> `optional` **where?**: `SQLWrapper`
+
+Defined in: [packages/fate/src/server/drizzle.ts:89](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/fate/src/server/drizzle.ts#L89)