@nkzw/fate 1.0.2 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +354 -2
- package/docs/api/classes/FateClient.md +110 -40
- package/docs/api/functions/clientRoot.md +1 -1
- package/docs/api/functions/createClient.md +8 -4
- package/docs/api/functions/createGraphQLTransport.md +21 -0
- package/docs/api/functions/createHTTPTransport.md +1 -1
- package/docs/api/functions/createTRPCTransport.md +1 -1
- package/docs/api/functions/getListEntries.md +1 -1
- package/docs/api/functions/getSelectionPlan.md +1 -1
- package/docs/api/functions/graphqlMutation.md +39 -0
- package/docs/api/functions/isRecord.md +1 -1
- package/docs/api/functions/isViewTag.md +1 -1
- package/docs/api/functions/liveConnectionTopic.md +1 -1
- package/docs/api/functions/liveEntityTopic.md +1 -1
- package/docs/api/functions/liveGlobalConnectionTopic.md +1 -1
- package/docs/api/functions/mutation.md +1 -1
- package/docs/api/functions/toEntityId.md +1 -1
- package/docs/api/functions/view.md +1 -1
- package/docs/api/index.md +10 -0
- package/docs/api/interfaces/FateThenable.md +3 -3
- package/docs/api/interfaces/Transport.md +7 -7
- package/docs/api/server/classes/FateRequestError.md +5 -5
- package/docs/api/server/drizzle/functions/createDrizzleFate.md +1 -1
- package/docs/api/server/drizzle/functions/createDrizzleSourceAdapter.md +1 -1
- package/docs/api/server/drizzle/functions/createDrizzleSourceRegistry.md +1 -1
- package/docs/api/server/drizzle/type-aliases/DrizzleManyToManyConfig.md +1 -1
- package/docs/api/server/drizzle/type-aliases/DrizzleManyToManyInput.md +1 -1
- package/docs/api/server/drizzle/type-aliases/DrizzleQueryExtra.md +3 -3
- package/docs/api/server/drizzle/type-aliases/DrizzleSourceAdapter.md +9 -9
- package/docs/api/server/drizzle/type-aliases/DrizzleViewConfig.md +1 -1
- package/docs/api/server/functions/bindSourceProcedures.md +1 -1
- package/docs/api/server/functions/computed.md +1 -1
- package/docs/api/server/functions/count.md +1 -1
- package/docs/api/server/functions/createFateFetchHandler.md +1 -1
- package/docs/api/server/functions/createFateServer.md +1 -1
- package/docs/api/server/functions/createHonoFateHandler.md +1 -1
- package/docs/api/server/functions/createLiveEventBus.md +1 -1
- package/docs/api/server/functions/createNestedSourcePlan.md +1 -1
- package/docs/api/server/functions/createResolver.md +1 -1
- package/docs/api/server/functions/createSourcePlan.md +1 -1
- package/docs/api/server/functions/createSourceProcedures.md +1 -1
- package/docs/api/server/functions/dataView.md +1 -1
- package/docs/api/server/functions/field.md +1 -1
- package/docs/api/server/functions/getNestedSelection.md +1 -1
- package/docs/api/server/functions/getScopedArgs.md +1 -1
- package/docs/api/server/functions/hasNestedSelection.md +1 -1
- package/docs/api/server/functions/list.md +1 -1
- package/docs/api/server/functions/refetchSourceById.md +1 -1
- package/docs/api/server/functions/resolveSourceById.md +1 -1
- package/docs/api/server/functions/resolveSourceByIds.md +1 -1
- package/docs/api/server/functions/resolveSourceConnection.md +1 -1
- package/docs/api/server/functions/resolver.md +1 -1
- package/docs/api/server/functions/toPrismaSelect.md +1 -1
- package/docs/api/server/functions/withConnection.md +1 -1
- package/docs/api/server/prisma/functions/createPrismaFate.md +1 -1
- package/docs/api/server/prisma/functions/createPrismaSourceAdapter.md +1 -1
- package/docs/api/server/prisma/functions/createPrismaSourceRegistry.md +1 -1
- package/docs/api/server/prisma/functions/prismaConnectionArgs.md +1 -1
- package/docs/api/server/prisma/type-aliases/PrismaDelegate.md +4 -4
- package/docs/api/server/prisma/type-aliases/PrismaQueryExtra.md +1 -1
- package/docs/api/server/prisma/type-aliases/PrismaSourceAdapter.md +9 -9
- package/docs/api/server/prisma/type-aliases/PrismaViewConfig.md +1 -1
- package/docs/api/server/type-aliases/ComputedField.md +5 -5
- package/docs/api/server/type-aliases/ComputedSelection.md +1 -1
- package/docs/api/server/type-aliases/ConnectionItem.md +3 -3
- package/docs/api/server/type-aliases/ConnectionPagination.md +5 -5
- package/docs/api/server/type-aliases/ConnectionResult.md +3 -3
- package/docs/api/server/type-aliases/CountSelection.md +4 -4
- package/docs/api/server/type-aliases/CountWhere.md +1 -1
- package/docs/api/server/type-aliases/DataViewListOptions.md +2 -2
- package/docs/api/server/type-aliases/DataViewOrderBy.md +1 -1
- package/docs/api/server/type-aliases/DataViewOrderDirection.md +1 -1
- package/docs/api/server/type-aliases/DataViewResult.md +1 -1
- package/docs/api/server/type-aliases/Entity.md +1 -1
- package/docs/api/server/type-aliases/FateServer.md +5 -5
- package/docs/api/server/type-aliases/FateServerManifest.md +1 -1
- package/docs/api/server/type-aliases/FieldSelection.md +3 -3
- package/docs/api/server/type-aliases/LiveConnectionEventType.md +1 -1
- package/docs/api/server/type-aliases/LiveConnectionSourceEvent.md +1 -1
- package/docs/api/server/type-aliases/LiveEventBus.md +1 -1
- package/docs/api/server/type-aliases/LiveEventType.md +1 -1
- package/docs/api/server/type-aliases/LiveSourceEvent.md +1 -1
- package/docs/api/server/type-aliases/NativeFateAPI.md +4 -4
- package/docs/api/server/type-aliases/OrderDirection.md +1 -1
- package/docs/api/server/type-aliases/SourceConfig.md +6 -6
- package/docs/api/server/type-aliases/SourceDefinition.md +6 -6
- package/docs/api/server/type-aliases/SourceOrder.md +1 -1
- package/docs/api/server/type-aliases/SourceOrderField.md +3 -3
- package/docs/api/server/type-aliases/SourcePlan.md +1 -1
- package/docs/api/server/type-aliases/SourcePlanNode.md +1 -1
- package/docs/api/server/type-aliases/SourceRegistry.md +1 -1
- package/docs/api/server/type-aliases/SourceRelation.md +1 -1
- package/docs/api/server/type-aliases/SourceRelationConfig.md +1 -1
- package/docs/api/server/variables/byIdInput.md +1 -1
- package/docs/api/server/variables/connectionArgs.md +1 -1
- package/docs/api/type-aliases/ConnectionMetadata.md +1 -1
- package/docs/api/type-aliases/ConnectionRef.md +1 -1
- package/docs/api/type-aliases/Entity.md +2 -2
- package/docs/api/type-aliases/EntityId.md +1 -1
- package/docs/api/type-aliases/FateDehydratedState.md +11 -0
- package/docs/api/type-aliases/FateLiveConnectionEvent.md +1 -1
- package/docs/api/type-aliases/FateLiveEvent.md +1 -1
- package/docs/api/type-aliases/FateMutations.md +1 -1
- package/docs/api/type-aliases/FateOperation.md +1 -1
- package/docs/api/type-aliases/FateProtocolRequest.md +1 -1
- package/docs/api/type-aliases/FateProtocolResponse.md +1 -1
- package/docs/api/type-aliases/FateRecord.md +1 -1
- package/docs/api/type-aliases/FateRoots.md +1 -1
- package/docs/api/type-aliases/GraphQLMutationDefinition.md +19 -0
- package/docs/api/type-aliases/GraphQLMutationInput.md +11 -0
- package/docs/api/type-aliases/GraphQLMutationMap.md +11 -0
- package/docs/api/type-aliases/GraphQLMutationOutput.md +11 -0
- package/docs/api/type-aliases/GraphQLTransportOptions.md +119 -0
- package/docs/api/type-aliases/HydrateOptions.md +7 -0
- package/docs/api/type-aliases/HydrationLimits.md +7 -0
- package/docs/api/type-aliases/InferFateAPI.md +1 -1
- package/docs/api/type-aliases/List.md +1 -1
- package/docs/api/type-aliases/ListEntry.md +1 -1
- package/docs/api/type-aliases/ListItem.md +1 -1
- package/docs/api/type-aliases/Mask.md +1 -1
- package/docs/api/type-aliases/MutationDefinition.md +1 -1
- package/docs/api/type-aliases/MutationEntity.md +1 -1
- package/docs/api/type-aliases/MutationIdentifier.md +1 -1
- package/docs/api/type-aliases/MutationInput.md +1 -1
- package/docs/api/type-aliases/MutationResult.md +1 -1
- package/docs/api/type-aliases/NodesItem.md +1 -1
- package/docs/api/type-aliases/Pagination.md +5 -5
- package/docs/api/type-aliases/Request.md +1 -1
- package/docs/api/type-aliases/RequestMode.md +1 -1
- package/docs/api/type-aliases/RequestOptions.md +1 -1
- package/docs/api/type-aliases/RequestResult.md +1 -1
- package/docs/api/type-aliases/Selection.md +1 -1
- package/docs/api/type-aliases/Snapshot.md +1 -1
- package/docs/api/type-aliases/TypeConfig.md +4 -4
- package/docs/api/type-aliases/View.md +1 -1
- package/docs/api/type-aliases/ViewData.md +1 -1
- package/docs/api/type-aliases/ViewEntity.md +1 -1
- package/docs/api/type-aliases/ViewEntityName.md +1 -1
- package/docs/api/type-aliases/ViewRef.md +1 -1
- package/docs/api/type-aliases/ViewSelection.md +1 -1
- package/docs/api/type-aliases/ViewSnapshot.md +1 -1
- package/docs/api/type-aliases/ViewTag.md +1 -1
- package/docs/api/variables/ConnectionTag.md +1 -1
- package/docs/guide/getting-started.md +1 -1
- package/docs/guide/graphql-integration.md +298 -0
- package/docs/guide/requests.md +52 -0
- package/docs/guide/server-integration.md +2 -1
- package/lib/{executor-BqwHdN3n.d.mts → executor-sLcAqDMs.d.mts} +1 -1
- package/lib/graphqlTransport-DbRHbYtb.d.mts +74 -0
- package/lib/graphqlTransport-IFgmY-Qq.mjs +499 -0
- package/lib/graphqlTransport.d.mts +2 -0
- package/lib/graphqlTransport.mjs +2 -0
- package/lib/index.d.mts +5 -4
- package/lib/index.mjs +501 -89
- package/lib/{list-4wRNSVgI.d.mts → list-CMQOQGdn.d.mts} +1 -1
- package/lib/list.d.mts +1 -1
- package/lib/list.mjs +1 -1
- package/lib/{liveTopics-DzNtJaBD.mjs → liveTopics-JIDh3t3P.mjs} +1 -1
- package/lib/{record-CirbfZWX.d.mts → record-BtdKzEGI.d.mts} +2 -2
- package/lib/server/drizzle.d.mts +6 -8
- package/lib/server/drizzle.mjs +2 -2
- package/lib/server/prisma.d.mts +6 -8
- package/lib/server/prisma.mjs +2 -2
- package/lib/server.d.mts +3 -3
- package/lib/server.mjs +3 -3
- package/lib/{sourceRouter-C22uFcZg.mjs → sourceRouter-N9Vp0Cj6.mjs} +1 -1
- package/lib/{types-Dz46PXr3.d.mts → transport-BTgtSwOM.d.mts} +211 -143
- package/lib/vite.d.mts +1 -1
- package/lib/vite.mjs +150 -3
- package/package.json +11 -3
- /package/lib/{list-C_mi6GnE.mjs → list-_6fXYLtJ.mjs} +0 -0
- /package/lib/{record-AeZJC9fd.mjs → record-B07VwXd-.mjs} +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceDefinition**\<`Item`, `Adapter`\> = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/source.ts:71](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/source.ts:71](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L71)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -20,7 +20,7 @@ Defined in: [packages/fate/src/server/source.ts:71](https://github.com/nkzw-tech
|
|
|
20
20
|
|
|
21
21
|
> `optional` **adapter?**: `Adapter`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/fate/src/server/source.ts:72](https://github.com/nkzw-tech/fate/blob/
|
|
23
|
+
Defined in: [packages/fate/src/server/source.ts:72](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L72)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/fate/src/server/source.ts:72](https://github.com/nkzw-tech
|
|
|
28
28
|
|
|
29
29
|
> **id**: `string`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/fate/src/server/source.ts:73](https://github.com/nkzw-tech/fate/blob/
|
|
31
|
+
Defined in: [packages/fate/src/server/source.ts:73](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L73)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [packages/fate/src/server/source.ts:73](https://github.com/nkzw-tech
|
|
|
36
36
|
|
|
37
37
|
> `optional` **orderBy?**: [`SourceOrder`](SourceOrder.md)
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/fate/src/server/source.ts:74](https://github.com/nkzw-tech/fate/blob/
|
|
39
|
+
Defined in: [packages/fate/src/server/source.ts:74](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L74)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/fate/src/server/source.ts:74](https://github.com/nkzw-tech
|
|
|
44
44
|
|
|
45
45
|
> `optional` **relations?**: `Record`\<`string`, [`SourceRelation`](SourceRelation.md)\<[`FateRecord`](../../type-aliases/FateRecord.md), `Adapter`\>\>
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/fate/src/server/source.ts:75](https://github.com/nkzw-tech/fate/blob/
|
|
47
|
+
Defined in: [packages/fate/src/server/source.ts:75](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L75)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -52,4 +52,4 @@ Defined in: [packages/fate/src/server/source.ts:75](https://github.com/nkzw-tech
|
|
|
52
52
|
|
|
53
53
|
> **view**: `DataView`\<`Item`\>
|
|
54
54
|
|
|
55
|
-
Defined in: [packages/fate/src/server/source.ts:76](https://github.com/nkzw-tech/fate/blob/
|
|
55
|
+
Defined in: [packages/fate/src/server/source.ts:76](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L76)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceOrder** = [`SourceOrderField`](SourceOrderField.md)[]
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/source.ts:21](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/source.ts:21](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L21)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceOrderField** = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/source.ts:16](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/source.ts:16](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L16)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/fate/src/server/source.ts:16](https://github.com/nkzw-tech
|
|
|
10
10
|
|
|
11
11
|
> **direction**: [`OrderDirection`](OrderDirection.md)
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/fate/src/server/source.ts:17](https://github.com/nkzw-tech/fate/blob/
|
|
13
|
+
Defined in: [packages/fate/src/server/source.ts:17](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L17)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,4 +18,4 @@ Defined in: [packages/fate/src/server/source.ts:17](https://github.com/nkzw-tech
|
|
|
18
18
|
|
|
19
19
|
> **field**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/fate/src/server/source.ts:18](https://github.com/nkzw-tech/fate/blob/
|
|
21
|
+
Defined in: [packages/fate/src/server/source.ts:18](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L18)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourcePlan**\<`Item`, `Context`, `Adapter`\> = `Omit`\<`ViewPlan`\<`Item`, `Context`\>, `"root"`\> & `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/source.ts:93](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/source.ts:93](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L93)
|
|
6
6
|
|
|
7
7
|
## Type Declaration
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourcePlanNode**\<`Context`, `Adapter`\> = `ViewPlanNode`\<`Context`\> & `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/source.ts:87](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/source.ts:87](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L87)
|
|
6
6
|
|
|
7
7
|
## Type Declaration
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceRegistry**\<`Context`\> = `Map`\<[`SourceDefinition`](SourceDefinition.md)\<[`FateRecord`](../../type-aliases/FateRecord.md), `unknown`\>, `SourceExecutor`\<`Context`, [`FateRecord`](../../type-aliases/FateRecord.md), `any`, `any`, `any`\>\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/executor.ts:52](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/executor.ts:52](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/executor.ts#L52)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceRelation**\<`Item`, `Adapter`\> = `SourceRelationBase`\<`Item`, `Adapter`\> & \{ `kind`: `"one"`; `orderBy?`: `never`; `through?`: `never`; \} \| \{ `kind`: `"many"`; `orderBy?`: [`SourceOrder`](SourceOrder.md); `through?`: `never`; \} \| \{ `kind`: `"manyToMany"`; `orderBy?`: [`SourceOrder`](SourceOrder.md); `through?`: \{ `foreignKey`: `string`; `localKey`: `string`; \}; \}
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/source.ts:33](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/source.ts:33](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L33)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceRelationConfig** = `Partial`\<`SourceRelationKeyConfig`\> & `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/source.ts:63](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/source.ts:63](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/source.ts#L63)
|
|
6
6
|
|
|
7
7
|
## Type Declaration
|
|
8
8
|
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> `const` **byIdInput**: `ZodObject`\<\{ `args`: `ZodOptional`\<`ZodType`\<`Record`\<`string`, `unknown`\>, `unknown`, `$ZodTypeInternals`\<`Record`\<`string`, `unknown`\>, `unknown`\>\>\>; `ids`: `ZodArray`\<`ZodString`\>; `select`: `ZodArray`\<`ZodString`\>; \}, `$strip`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/input.ts:4](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/input.ts:4](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/input.ts#L4)
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> `const` **connectionArgs**: `ZodOptional`\<`ZodType`\<`Record`\<`string`, `unknown`\>, `unknown`, `$ZodTypeInternals`\<`Record`\<`string`, `unknown`\>, `unknown`\>\>\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/connection.ts:102](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/connection.ts:102](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/connection.ts#L102)
|
|
6
6
|
|
|
7
7
|
Zod schema for connection args (`after`, `before`, `first`, `last`, etc.).
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **ConnectionMetadata** = `Readonly`\<\{ `args?`: [`FateRecord`](FateRecord.md); `field`: `string`; `hash?`: `string`; `key`: `string`; `live?`: `ConnectionLivePolicy`; `owner`: [`EntityId`](EntityId.md); `procedure`: `string`; `root?`: `boolean`; `type`: `string`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:83](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:83](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L83)
|
|
6
6
|
|
|
7
7
|
Metadata stored alongside connection results to power pagination and cache updates.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **ConnectionRef**\<`TName`\> = `Readonly`\<\{ `items`: `ReadonlyArray`\<\{ `cursor?`: `string`; `node`: [`ViewRef`](ViewRef.md)\<`TName`\>; \}\>; `pagination?`: [`Pagination`](Pagination.md); \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:132](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:132](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L132)
|
|
6
6
|
|
|
7
7
|
Ref for a connection, including pagination metadata.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **Entity** = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:141](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:141](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L141)
|
|
6
6
|
|
|
7
7
|
Base shape shared by all entities fetched by fate.
|
|
8
8
|
|
|
@@ -12,4 +12,4 @@ Base shape shared by all entities fetched by fate.
|
|
|
12
12
|
|
|
13
13
|
> **\_\_typename**: `string`
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/fate/src/types.ts:141](https://github.com/nkzw-tech/fate/blob/
|
|
15
|
+
Defined in: [packages/fate/src/types.ts:141](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L141)
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **EntityId** = `string`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:8](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:8](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L8)
|
|
6
6
|
|
|
7
7
|
Globally unique identifier for an entity in the normalized cache (`<TypeName>:<id>` format).
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Type Alias: FateDehydratedState\<Scope\>
|
|
2
|
+
|
|
3
|
+
> **FateDehydratedState**\<`Scope`\> = `Readonly`\<\{ `[hydrationScopeBrand]?`: `Scope`; `data`: `FateSerializedValue`; `scope`: `Scope`; `version`: `1`; \}\>
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/fate/src/hydration.ts:17](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/hydration.ts#L17)
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### Scope
|
|
10
|
+
|
|
11
|
+
`Scope` *extends* `string` = `string`
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateLiveConnectionEvent** = `Readonly`\<\{ `edge`: \{ `cursor?`: `string`; `node`: `unknown`; \}; `nodeType`: `string`; `targetCursor?`: `string`; `type`: `"appendEdge"` \| `"appendNode"` \| `"insertEdgeAfter"` \| `"insertEdgeBefore"` \| `"prependEdge"` \| `"prependNode"`; \}\> \| `Readonly`\<\{ `id`: `string` \| `number`; `nodeType`: `string`; `type`: `"deleteEdge"`; \}\> \| `Readonly`\<\{ `type`: `"invalidate"`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/protocol.ts:55](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/protocol.ts:55](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/protocol.ts#L55)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateLiveEvent** = `FateLiveDataEvent` \| `FateLiveDeleteEvent`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/protocol.ts:53](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/protocol.ts:53](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/protocol.ts#L53)
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateMutations** = `Record`\<`string`, [`MutationDefinition`](MutationDefinition.md)\<`any`, `any`, `any`\>\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/mutation.ts:94](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/mutation.ts:94](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/mutation.ts#L94)
|
|
6
6
|
|
|
7
7
|
Base type for client mutations.
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateOperation** = `Readonly`\<\{ `args?`: `Record`\<`string`, `unknown`\>; `id`: `string`; `ids?`: (`string` \| `number`)[]; `input?`: `unknown`; `kind`: `FateOperationKind`; `name?`: `string`; `select`: `string`[]; `type?`: `string`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/protocol.ts:7](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/protocol.ts:7](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/protocol.ts#L7)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateProtocolRequest** = `Readonly`\<\{ `operations`: [`FateOperation`](FateOperation.md)[]; `version`: `FateProtocolVersion`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/protocol.ts:30](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/protocol.ts:30](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/protocol.ts#L30)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateProtocolResponse** = `Readonly`\<\{ `results`: `FateOperationResult`[]; `version`: `FateProtocolVersion`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/protocol.ts:35](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/protocol.ts:35](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/protocol.ts#L35)
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateRecord** = `Record`\<`string`, `unknown`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:64](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:64](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L64)
|
|
6
6
|
|
|
7
7
|
Alias for a loose record used throughout the fate's internals.
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateRoots** = `Record`\<`string`, `RootDefinition`\<`TypeName`, `unknown`\>\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:425](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:425](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L425)
|
|
6
6
|
|
|
7
7
|
Minimal root description used for typing root maps.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Type Alias: GraphQLMutationDefinition\<T, Input, Output\>
|
|
2
|
+
|
|
3
|
+
> **GraphQLMutationDefinition**\<`T`, `Input`, `Output`\> = `Readonly`\<\{ `__fateGraphQLMutation?`: \{ `input`: `Input`; `output`: `Output`; \}; `entity`: `T`\[`"__typename"`\]; `field`: `string`; `inputArg?`: `false` \| `string`; \}\>
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:26](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L26)
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### T
|
|
10
|
+
|
|
11
|
+
`T` *extends* [`Entity`](Entity.md) = [`Entity`](Entity.md)
|
|
12
|
+
|
|
13
|
+
### Input
|
|
14
|
+
|
|
15
|
+
`Input` = `unknown`
|
|
16
|
+
|
|
17
|
+
### Output
|
|
18
|
+
|
|
19
|
+
`Output` = `unknown`
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Type Alias: GraphQLMutationInput\<Definition\>
|
|
2
|
+
|
|
3
|
+
> **GraphQLMutationInput**\<`Definition`\> = `Definition` *extends* [`GraphQLMutationDefinition`](GraphQLMutationDefinition.md)\<`any`, infer Input, `any`\> ? `Input` : `never`
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:40](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L40)
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### Definition
|
|
10
|
+
|
|
11
|
+
`Definition`
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Type Alias: GraphQLMutationMap\<Mutations\>
|
|
2
|
+
|
|
3
|
+
> **GraphQLMutationMap**\<`Mutations`\> = `Mutations` *extends* `Record`\<`string`, [`GraphQLMutationDefinition`](GraphQLMutationDefinition.md)\> ? `{ [K in keyof Mutations]: { input: GraphQLMutationInput<Mutations[K]>; output: GraphQLMutationOutput<Mutations[K]> } }` : `EmptyTransportMutations`
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:46](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L46)
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### Mutations
|
|
10
|
+
|
|
11
|
+
`Mutations`
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Type Alias: GraphQLMutationOutput\<Definition\>
|
|
2
|
+
|
|
3
|
+
> **GraphQLMutationOutput**\<`Definition`\> = `Definition` *extends* [`GraphQLMutationDefinition`](GraphQLMutationDefinition.md)\<`any`, `any`, infer Output\> ? `Output` : `never`
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:43](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L43)
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### Definition
|
|
10
|
+
|
|
11
|
+
`Definition`
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Type Alias: GraphQLTransportOptions\<Mutations\>
|
|
2
|
+
|
|
3
|
+
> **GraphQLTransportOptions**\<`Mutations`\> = `object`
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:69](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L69)
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### Mutations
|
|
10
|
+
|
|
11
|
+
`Mutations` *extends* `TransportMutations` = `EmptyTransportMutations`
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### decodeNodeId?
|
|
16
|
+
|
|
17
|
+
> `optional` **decodeNodeId?**: (`type`, `id`) => `string` \| `number`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:72](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L72)
|
|
20
|
+
|
|
21
|
+
#### Parameters
|
|
22
|
+
|
|
23
|
+
##### type
|
|
24
|
+
|
|
25
|
+
`string`
|
|
26
|
+
|
|
27
|
+
##### id
|
|
28
|
+
|
|
29
|
+
`string` \| `number`
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
`string` \| `number`
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### encodeNodeId?
|
|
38
|
+
|
|
39
|
+
> `optional` **encodeNodeId?**: (`type`, `id`) => `string` \| `number`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:73](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L73)
|
|
42
|
+
|
|
43
|
+
#### Parameters
|
|
44
|
+
|
|
45
|
+
##### type
|
|
46
|
+
|
|
47
|
+
`string`
|
|
48
|
+
|
|
49
|
+
##### id
|
|
50
|
+
|
|
51
|
+
`string` \| `number`
|
|
52
|
+
|
|
53
|
+
#### Returns
|
|
54
|
+
|
|
55
|
+
`string` \| `number`
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### eventSource?
|
|
60
|
+
|
|
61
|
+
> `optional` **eventSource?**: `EventSourceConstructor`
|
|
62
|
+
|
|
63
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:74](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L74)
|
|
64
|
+
|
|
65
|
+
***
|
|
66
|
+
|
|
67
|
+
### fetch?
|
|
68
|
+
|
|
69
|
+
> `optional` **fetch?**: `FetchLike`
|
|
70
|
+
|
|
71
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:75](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L75)
|
|
72
|
+
|
|
73
|
+
***
|
|
74
|
+
|
|
75
|
+
### headers?
|
|
76
|
+
|
|
77
|
+
> `optional` **headers?**: `HeadersFactory`
|
|
78
|
+
|
|
79
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:76](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L76)
|
|
80
|
+
|
|
81
|
+
***
|
|
82
|
+
|
|
83
|
+
### live?
|
|
84
|
+
|
|
85
|
+
> `optional` **live?**: `boolean` \| `GraphQLLiveOptions`
|
|
86
|
+
|
|
87
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:77](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L77)
|
|
88
|
+
|
|
89
|
+
***
|
|
90
|
+
|
|
91
|
+
### mutations?
|
|
92
|
+
|
|
93
|
+
> `optional` **mutations?**: `Record`\<`Extract`\<keyof `Mutations`, `string`\>, `GraphQLMutationRuntimeConfig`\>
|
|
94
|
+
|
|
95
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:78](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L78)
|
|
96
|
+
|
|
97
|
+
***
|
|
98
|
+
|
|
99
|
+
### roots?
|
|
100
|
+
|
|
101
|
+
> `optional` **roots?**: `Record`\<`string`, `GraphQLRootConfig`\>
|
|
102
|
+
|
|
103
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:79](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L79)
|
|
104
|
+
|
|
105
|
+
***
|
|
106
|
+
|
|
107
|
+
### types
|
|
108
|
+
|
|
109
|
+
> **types**: `ReadonlyArray`\<`Omit`\<[`TypeConfig`](TypeConfig.md), `"getId"`\> & `Partial`\<`Pick`\<[`TypeConfig`](TypeConfig.md), `"getId"`\>\>\>
|
|
110
|
+
|
|
111
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:80](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L80)
|
|
112
|
+
|
|
113
|
+
***
|
|
114
|
+
|
|
115
|
+
### url
|
|
116
|
+
|
|
117
|
+
> **url**: `string` \| `URL`
|
|
118
|
+
|
|
119
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:81](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L81)
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Type Alias: HydrateOptions
|
|
2
|
+
|
|
3
|
+
> **HydrateOptions** = `Readonly`\<\{ `merge?`: `"preserve-existing"` \| `"replace"`; \}\>
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/fate/src/hydration.ts:25](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/hydration.ts#L25)
|
|
6
|
+
|
|
7
|
+
Controls how `FateClient.hydrate()` reconciles a snapshot with browser cache state.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Type Alias: HydrationLimits
|
|
2
|
+
|
|
3
|
+
> **HydrationLimits** = `Readonly`\<\{ `maxCollectionLength`: `number`; `maxNodes`: `number`; `maxStringLength`: `number`; \}\>
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/fate/src/hydration.ts:36](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/hydration.ts#L36)
|
|
6
|
+
|
|
7
|
+
Resource limits applied while encoding and decoding hydration snapshots.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **InferFateAPI**\<`Server`\> = `Server` *extends* `object` ? `API` : `never`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/http.ts:235](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/server/http.ts:235](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/server/http.ts#L235)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **List** = `Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: `ReadonlyArray`\<`string` \| `undefined`\>; `forwardPageLimit?`: `number`; `ids`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; `liveAfterIds?`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; `liveBeforeIds?`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; `pagination?`: [`Pagination`](Pagination.md); `pendingAfterIds?`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; `pendingBeforeIds?`: `ReadonlyArray`\<[`EntityId`](EntityId.md)\>; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/store.ts:
|
|
5
|
+
Defined in: [packages/fate/src/store.ts:15](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/store.ts#L15)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **ListEntry** = `Readonly`\<\{ `cursor?`: `string`; `id`: [`EntityId`](EntityId.md); \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/list.ts:4](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/list.ts:4](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/list.ts#L4)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **ListItem**\<`V`\> = `Readonly`\<\{ `args?`: `Record`\<`string`, `unknown`\>; `list`: `V`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:316](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:316](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L316)
|
|
6
6
|
|
|
7
7
|
Definition of a list request for fetching data from the backend.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **Mask**\<`T`, `S`\> = `WithNullish`\<`T`, `MaskNonNullish`\<`NonNullish`\<`T`\>, `S`\>\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:300](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:300](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L300)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **MutationDefinition**\<`T`, `I`, `R`\> = `Readonly`\<\{ `__fate__mutation`: `true`; `entity`: `T`\[`"__typename"`\]; \}\> & `__MutationEntityAnchor`\<`T`\> & `__MutationInputAnchor`\<`I`\> & `__MutationResultAnchor`\<`R`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:434](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:434](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L434)
|
|
6
6
|
|
|
7
7
|
Metadata describing a mutation for a particular entity, input, and output.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **MutationEntity**\<`M`\> = `M` *extends* `__MutationEntityAnchor`\<infer E\> ? `E` : `never`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:452](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:452](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L452)
|
|
6
6
|
|
|
7
7
|
Extracts the entity type from a mutation definition or identifier.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **MutationIdentifier**\<`T`, `I`, `R`\> = [`MutationDefinition`](MutationDefinition.md)\<`T`, `I`, `R`\> & `Readonly`\<\{ `key`: `string`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:442](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:442](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L442)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **MutationInput**\<`M`\> = `M` *extends* `__MutationInputAnchor`\<infer I\> ? `I` : `never`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:446](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:446](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L446)
|
|
6
6
|
|
|
7
7
|
Extracts the input type from a mutation definition or identifier.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **MutationResult**\<`M`\> = `M` *extends* `__MutationResultAnchor`\<infer R\> ? `R` : `never`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:449](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:449](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L449)
|
|
6
6
|
|
|
7
7
|
Extracts the result type from a mutation definition or identifier.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **NodesItem**\<`V`\> = `Readonly`\<\{ `ids`: `ReadonlyArray`\<`string` \| `number`\>; `view`: `V`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:334](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:334](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L334)
|
|
6
6
|
|
|
7
7
|
Definition of a node request with explicit IDs for fetching data from the backend.
|
|
8
8
|
|