@nkzw/fate 1.5.2 → 1.6.1
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 +56 -168
- package/docs/api/classes/FateClient.md +35 -35
- package/docs/api/functions/clientRoot.md +1 -1
- package/docs/api/functions/createClient.md +1 -1
- package/docs/api/functions/createGraphQLTransport.md +1 -1
- package/docs/api/functions/createHTTPTransport.md +1 -1
- package/docs/api/functions/createTRPCTransport.md +1 -1
- package/docs/api/functions/defer.md +1 -1
- package/docs/api/functions/getDeferredMetadata.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 +1 -1
- package/docs/api/functions/isDeferred.md +1 -1
- 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/interfaces/FateThenable.md +3 -3
- package/docs/api/interfaces/Persistence.md +1 -1
- package/docs/api/interfaces/PersistenceSession.md +9 -9
- package/docs/api/interfaces/Transport.md +8 -8
- 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/Deferred.md +1 -1
- package/docs/api/type-aliases/DeferredMetadata.md +1 -1
- package/docs/api/type-aliases/DeferredSelection.md +1 -1
- package/docs/api/type-aliases/DeferredSnapshot.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 +1 -1
- 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 +1 -1
- package/docs/api/type-aliases/GraphQLMutationInput.md +1 -1
- package/docs/api/type-aliases/GraphQLMutationMap.md +1 -1
- package/docs/api/type-aliases/GraphQLMutationOutput.md +1 -1
- package/docs/api/type-aliases/GraphQLTransportOptions.md +12 -12
- package/docs/api/type-aliases/HydrateOptions.md +1 -1
- package/docs/api/type-aliases/HydrationLimits.md +1 -1
- 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/MutationIdentity.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/PersistedMutationStatus.md +1 -1
- package/docs/api/type-aliases/PersistenceSnapshot.md +1 -1
- 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/RequestPersistenceOptions.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/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/api/variables/DeferTag.md +1 -1
- package/docs/api/variables/DeferredTag.md +1 -1
- package/docs/guide/getting-started.md +1 -9
- package/docs/integrations/cloudflare.md +21 -139
- package/docs/integrations/graphql.md +2 -2
- package/docs/integrations/void.md +35 -21
- package/lib/{executor-oPTYqgQV.d.mts → executor-C3JLgeJ_.d.mts} +1 -1
- package/lib/{graphqlTransport-CGYE4NdD.d.mts → graphqlTransport-D7IPm9wQ.d.mts} +1 -1
- package/lib/graphqlTransport.d.mts +1 -1
- package/lib/{idempotency-types-DuqJ7KSd.d.mts → idempotency-types-jgGOlHFl.d.mts} +1 -1
- package/lib/idempotency.d.mts +2 -2
- package/lib/index.d.mts +4 -4
- package/lib/index.mjs +1 -1
- package/lib/{list-5hrTVoiB.d.mts → list-Dj7P-fay.d.mts} +1 -1
- package/lib/list.d.mts +1 -1
- package/lib/persistence.d.mts +1 -1
- package/lib/persistence.mjs +1 -1
- package/lib/{record-Dxjvpsep.d.mts → record-DmyMlWdZ.d.mts} +3 -3
- package/lib/server/drizzle.d.mts +2 -2
- package/lib/server/prisma.d.mts +2 -2
- package/lib/server.d.mts +3 -3
- package/lib/{store-CakBBzWG.mjs → store-Dl_OPES3.mjs} +1 -95
- package/lib/{transport-DR0fwleU.d.mts → transport-c5vvbtDC.d.mts} +4 -4
- package/lib/vite.d.mts +1 -1
- package/lib/vite.mjs +7 -27
- package/package.json +4 -4
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **DataViewResult**\<`V`\> = `Serializable`\<`RawDataViewResult`\<`V`\>\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/dataView.ts:294](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/dataView.ts:294](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/dataView.ts#L294)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **Entity**\<`TView`, `Name`, `Replacements`\> = `WithTypename`\<`Omit`\<[`DataViewResult`](DataViewResult.md)\<`TView`\>, keyof `Replacements`\> & `Replacements`, `Name`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/dataView.ts:301](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/dataView.ts:301](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/dataView.ts#L301)
|
|
6
6
|
|
|
7
7
|
Resolved entity type from a data view for client use.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateServer**\<`API`, `AdapterContext`\> = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/http.ts:234](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/http.ts:234](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L234)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -20,7 +20,7 @@ Defined in: [fate/src/server/http.ts:234](https://github.com/nkzw-tech/fate/blob
|
|
|
20
20
|
|
|
21
21
|
> `readonly` `optional` **\_\_api?**: `API`
|
|
22
22
|
|
|
23
|
-
Defined in: [fate/src/server/http.ts:235](https://github.com/nkzw-tech/fate/blob/
|
|
23
|
+
Defined in: [fate/src/server/http.ts:235](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L235)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [fate/src/server/http.ts:235](https://github.com/nkzw-tech/fate/blob
|
|
|
28
28
|
|
|
29
29
|
> `readonly` **manifest**: [`FateServerManifest`](FateServerManifest.md)
|
|
30
30
|
|
|
31
|
-
Defined in: [fate/src/server/http.ts:238](https://github.com/nkzw-tech/fate/blob/
|
|
31
|
+
Defined in: [fate/src/server/http.ts:238](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L238)
|
|
32
32
|
|
|
33
33
|
## Methods
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [fate/src/server/http.ts:238](https://github.com/nkzw-tech/fate/blob
|
|
|
36
36
|
|
|
37
37
|
> **handleLiveRequest**(`request`, `adapterContext?`): `Promise`\<`Response`\>
|
|
38
38
|
|
|
39
|
-
Defined in: [fate/src/server/http.ts:236](https://github.com/nkzw-tech/fate/blob/
|
|
39
|
+
Defined in: [fate/src/server/http.ts:236](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L236)
|
|
40
40
|
|
|
41
41
|
#### Parameters
|
|
42
42
|
|
|
@@ -58,7 +58,7 @@ Defined in: [fate/src/server/http.ts:236](https://github.com/nkzw-tech/fate/blob
|
|
|
58
58
|
|
|
59
59
|
> **handleRequest**(`request`, `adapterContext?`): `Promise`\<`Response`\>
|
|
60
60
|
|
|
61
|
-
Defined in: [fate/src/server/http.ts:237](https://github.com/nkzw-tech/fate/blob/
|
|
61
|
+
Defined in: [fate/src/server/http.ts:237](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L237)
|
|
62
62
|
|
|
63
63
|
#### Parameters
|
|
64
64
|
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateServerManifest** = `Readonly`\<\{ `lists`: `Record`\<`string`, \{ `type`: `string`; \}\>; `live`: `Record`\<`string`, `true`\>; `mutations`: `Record`\<`string`, \{ `type`: `string`; \}\>; `queries`: `Record`\<`string`, \{ `type`: `string`; \}\>; `types`: `Record`\<`string`, `true`\>; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/http.ts:243](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/http.ts:243](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L243)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **FieldSelection** = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/dataView.ts:28](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/dataView.ts:28](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/dataView.ts#L28)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [fate/src/server/dataView.ts:28](https://github.com/nkzw-tech/fate/b
|
|
|
10
10
|
|
|
11
11
|
> **kind**: `"field"`
|
|
12
12
|
|
|
13
|
-
Defined in: [fate/src/server/dataView.ts:29](https://github.com/nkzw-tech/fate/blob/
|
|
13
|
+
Defined in: [fate/src/server/dataView.ts:29](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/dataView.ts#L29)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,4 +18,4 @@ Defined in: [fate/src/server/dataView.ts:29](https://github.com/nkzw-tech/fate/b
|
|
|
18
18
|
|
|
19
19
|
> **path**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [fate/src/server/dataView.ts:30](https://github.com/nkzw-tech/fate/blob/
|
|
21
|
+
Defined in: [fate/src/server/dataView.ts:30](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/dataView.ts#L30)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **LiveConnectionEventType** = `"appendEdge"` \| `"appendNode"` \| `"deleteEdge"` \| `"insertEdgeAfter"` \| `"insertEdgeBefore"` \| `"invalidate"` \| `"prependEdge"` \| `"prependNode"`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/live.ts:6](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/live.ts:6](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/live.ts#L6)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **LiveConnectionSourceEvent** = `Readonly`\<\{ `cursor?`: `string`; `eventId?`: `string`; `id?`: `string` \| `number`; `node?`: `unknown`; `nodeType?`: `string`; `targetCursor?`: `string`; `type`: [`LiveConnectionEventType`](LiveConnectionEventType.md); \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/live.ts:24](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/live.ts:24](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/live.ts#L24)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **LiveEventBus** = `Readonly`\<\{ `connection`: (`procedure`, `args?`) => `LiveConnectionHandle`; `delete`: (`type`, `id`, `options?`) => `void`; `emit`: (`type`, `id`, `options?`) => `void`; `listen?`: (`type`, `id`, `handler`, `options?`) => () => `void`; `listenConnection?`: (`target`, `handler`, `options?`) => () => `void`; `subscribe`: (`type`, `id`, `options?`) => `AsyncIterable`\<readonly \[[`LiveSourceEvent`](LiveSourceEvent.md)\]\>; `subscribeConnection`: (`target`, `options?`) => `AsyncIterable`\<readonly \[[`LiveConnectionSourceEvent`](LiveConnectionSourceEvent.md)\]\>; `update`: (`type`, `id`, `options?`) => `void`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/live.ts:72](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/live.ts:72](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/live.ts#L72)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **LiveEventType** = `"delete"` \| `"update"`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/live.ts:4](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/live.ts:4](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/live.ts#L4)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **LiveSourceEvent** = `Readonly`\<\{ `changed?`: `ReadonlyArray`\<`string`\>; `data?`: `unknown`; `eventId?`: `string`; `id`: `string` \| `number`; `type`: [`LiveEventType`](LiveEventType.md); \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/live.ts:16](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/live.ts:16](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/live.ts#L16)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **NativeFateAPI**\<`Roots`, `Queries`, `Lists`, `Mutations`\> = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/http.ts:223](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/http.ts:223](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L223)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -28,7 +28,7 @@ Defined in: [fate/src/server/http.ts:223](https://github.com/nkzw-tech/fate/blob
|
|
|
28
28
|
|
|
29
29
|
> **lists**: `RootLists`\<`Roots`\> & `ListAPI`\<`Lists`\>
|
|
30
30
|
|
|
31
|
-
Defined in: [fate/src/server/http.ts:229](https://github.com/nkzw-tech/fate/blob/
|
|
31
|
+
Defined in: [fate/src/server/http.ts:229](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L229)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [fate/src/server/http.ts:229](https://github.com/nkzw-tech/fate/blob
|
|
|
36
36
|
|
|
37
37
|
> **mutations**: `MutationAPI`\<`Mutations`\>
|
|
38
38
|
|
|
39
|
-
Defined in: [fate/src/server/http.ts:230](https://github.com/nkzw-tech/fate/blob/
|
|
39
|
+
Defined in: [fate/src/server/http.ts:230](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L230)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,4 +44,4 @@ Defined in: [fate/src/server/http.ts:230](https://github.com/nkzw-tech/fate/blob
|
|
|
44
44
|
|
|
45
45
|
> **queries**: `RootQueries`\<`Roots`\> & `QueryAPI`\<`Queries`\>
|
|
46
46
|
|
|
47
|
-
Defined in: [fate/src/server/http.ts:231](https://github.com/nkzw-tech/fate/blob/
|
|
47
|
+
Defined in: [fate/src/server/http.ts:231](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/http.ts#L231)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **OrderDirection** = `"asc"` \| `"desc"`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/source.ts:14](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:14](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L14)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceConfig**\<`Item`, `Adapter`\> = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/source.ts:79](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:79](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L79)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -20,7 +20,7 @@ Defined in: [fate/src/server/source.ts:79](https://github.com/nkzw-tech/fate/blo
|
|
|
20
20
|
|
|
21
21
|
> `optional` **adapter?**: `Adapter`
|
|
22
22
|
|
|
23
|
-
Defined in: [fate/src/server/source.ts:80](https://github.com/nkzw-tech/fate/blob/
|
|
23
|
+
Defined in: [fate/src/server/source.ts:80](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L80)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [fate/src/server/source.ts:80](https://github.com/nkzw-tech/fate/blo
|
|
|
28
28
|
|
|
29
29
|
> `optional` **id?**: `string`
|
|
30
30
|
|
|
31
|
-
Defined in: [fate/src/server/source.ts:81](https://github.com/nkzw-tech/fate/blob/
|
|
31
|
+
Defined in: [fate/src/server/source.ts:81](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L81)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [fate/src/server/source.ts:81](https://github.com/nkzw-tech/fate/blo
|
|
|
36
36
|
|
|
37
37
|
> `optional` **orderBy?**: [`SourceOrder`](SourceOrder.md)
|
|
38
38
|
|
|
39
|
-
Defined in: [fate/src/server/source.ts:82](https://github.com/nkzw-tech/fate/blob/
|
|
39
|
+
Defined in: [fate/src/server/source.ts:82](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L82)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,7 +44,7 @@ Defined in: [fate/src/server/source.ts:82](https://github.com/nkzw-tech/fate/blo
|
|
|
44
44
|
|
|
45
45
|
> `optional` **relations?**: `Record`\<`string`, [`SourceRelationConfig`](SourceRelationConfig.md)\>
|
|
46
46
|
|
|
47
|
-
Defined in: [fate/src/server/source.ts:83](https://github.com/nkzw-tech/fate/blob/
|
|
47
|
+
Defined in: [fate/src/server/source.ts:83](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L83)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -52,4 +52,4 @@ Defined in: [fate/src/server/source.ts:83](https://github.com/nkzw-tech/fate/blo
|
|
|
52
52
|
|
|
53
53
|
> **view**: `DataView`\<`Item`\>
|
|
54
54
|
|
|
55
|
-
Defined in: [fate/src/server/source.ts:84](https://github.com/nkzw-tech/fate/blob/
|
|
55
|
+
Defined in: [fate/src/server/source.ts:84](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L84)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceDefinition**\<`Item`, `Adapter`\> = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/source.ts:71](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:71](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L71)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -20,7 +20,7 @@ Defined in: [fate/src/server/source.ts:71](https://github.com/nkzw-tech/fate/blo
|
|
|
20
20
|
|
|
21
21
|
> `optional` **adapter?**: `Adapter`
|
|
22
22
|
|
|
23
|
-
Defined in: [fate/src/server/source.ts:72](https://github.com/nkzw-tech/fate/blob/
|
|
23
|
+
Defined in: [fate/src/server/source.ts:72](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L72)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [fate/src/server/source.ts:72](https://github.com/nkzw-tech/fate/blo
|
|
|
28
28
|
|
|
29
29
|
> **id**: `string`
|
|
30
30
|
|
|
31
|
-
Defined in: [fate/src/server/source.ts:73](https://github.com/nkzw-tech/fate/blob/
|
|
31
|
+
Defined in: [fate/src/server/source.ts:73](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L73)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [fate/src/server/source.ts:73](https://github.com/nkzw-tech/fate/blo
|
|
|
36
36
|
|
|
37
37
|
> `optional` **orderBy?**: [`SourceOrder`](SourceOrder.md)
|
|
38
38
|
|
|
39
|
-
Defined in: [fate/src/server/source.ts:74](https://github.com/nkzw-tech/fate/blob/
|
|
39
|
+
Defined in: [fate/src/server/source.ts:74](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L74)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,7 +44,7 @@ Defined in: [fate/src/server/source.ts:74](https://github.com/nkzw-tech/fate/blo
|
|
|
44
44
|
|
|
45
45
|
> `optional` **relations?**: `Record`\<`string`, [`SourceRelation`](SourceRelation.md)\<[`FateRecord`](../../type-aliases/FateRecord.md), `Adapter`\>\>
|
|
46
46
|
|
|
47
|
-
Defined in: [fate/src/server/source.ts:75](https://github.com/nkzw-tech/fate/blob/
|
|
47
|
+
Defined in: [fate/src/server/source.ts:75](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L75)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -52,4 +52,4 @@ Defined in: [fate/src/server/source.ts:75](https://github.com/nkzw-tech/fate/blo
|
|
|
52
52
|
|
|
53
53
|
> **view**: `DataView`\<`Item`\>
|
|
54
54
|
|
|
55
|
-
Defined in: [fate/src/server/source.ts:76](https://github.com/nkzw-tech/fate/blob/
|
|
55
|
+
Defined in: [fate/src/server/source.ts:76](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L76)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceOrder** = [`SourceOrderField`](SourceOrderField.md)[]
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/source.ts:21](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:21](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L21)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **SourceOrderField** = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/server/source.ts:16](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:16](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L16)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [fate/src/server/source.ts:16](https://github.com/nkzw-tech/fate/blo
|
|
|
10
10
|
|
|
11
11
|
> **direction**: [`OrderDirection`](OrderDirection.md)
|
|
12
12
|
|
|
13
|
-
Defined in: [fate/src/server/source.ts:17](https://github.com/nkzw-tech/fate/blob/
|
|
13
|
+
Defined in: [fate/src/server/source.ts:17](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/server/source.ts#L17)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,4 +18,4 @@ Defined in: [fate/src/server/source.ts:17](https://github.com/nkzw-tech/fate/blo
|
|
|
18
18
|
|
|
19
19
|
> **field**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [fate/src/server/source.ts:18](https://github.com/nkzw-tech/fate/blob/
|
|
21
|
+
Defined in: [fate/src/server/source.ts:18](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/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: [fate/src/server/source.ts:93](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:93](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/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: [fate/src/server/source.ts:87](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:87](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/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: [fate/src/server/executor.ts:52](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/executor.ts:52](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/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: [fate/src/server/source.ts:33](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:33](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/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: [fate/src/server/source.ts:63](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/source.ts:63](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/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: [fate/src/server/input.ts:4](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/input.ts:4](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/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: [fate/src/server/connection.ts:102](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/server/connection.ts:102](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/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: [fate/src/types.ts:89](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:89](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L89)
|
|
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: [fate/src/types.ts:138](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:138](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L138)
|
|
6
6
|
|
|
7
7
|
Ref for a connection, including pagination metadata.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **Deferred**\<`T`\> = `Readonly`\<\{ `[DeferredTag]`: [`DeferredMetadata`](DeferredMetadata.md); \}\> & `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/types.ts:161](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:161](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L161)
|
|
6
6
|
|
|
7
7
|
A deferred value returned from a masked view. Existing view hooks resolve it when read.
|
|
8
8
|
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **DeferredMetadata** = `Readonly`\<\{ `field`: `string`; `id`: `string` \| `number`; `owner`: [`EntityId`](EntityId.md); `selection`: `unknown`; `type`: `string`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/types.ts:152](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:152](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L152)
|
|
6
6
|
|
|
7
7
|
Runtime metadata used by the client to resolve a deferred field.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **DeferredSelection**\<`S`\> = `Readonly`\<\{ `[DeferTag]`: `S`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/types.ts:147](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:147](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L147)
|
|
6
6
|
|
|
7
7
|
Selection wrapper created by `defer(...)`.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **DeferredSnapshot**\<`T`\> = `Readonly`\<\{ `coverage`: `ReadonlyArray`\<readonly \[[`EntityId`](EntityId.md), `ReadonlySet`\<`string`\>\]\>; `data`: `T`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/client.ts:113](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/client.ts:113](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/client.ts#L113)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **Entity** = `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/types.ts:166](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:166](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L166)
|
|
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: [fate/src/types.ts:166](https://github.com/nkzw-tech/fate/blob/
|
|
15
|
+
Defined in: [fate/src/types.ts:166](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L166)
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **EntityId** = `string`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/types.ts:7](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:7](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L7)
|
|
6
6
|
|
|
7
7
|
Globally unique identifier for an entity in the normalized cache (`<TypeName>:<id>` format).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateDehydratedState**\<`Scope`\> = `Readonly`\<\{ `[hydrationScopeBrand]?`: `Scope`; `data`: `FateSerializedValue`; `scope`: `Scope`; `version`: `1`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/hydration.ts:17](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/hydration.ts:17](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/hydration.ts#L17)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -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: [fate/src/protocol.ts:58](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/protocol.ts:58](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/protocol.ts#L58)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateLiveEvent** = `FateLiveDataEvent` \| `FateLiveDeleteEvent`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/protocol.ts:56](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/protocol.ts:56](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/protocol.ts#L56)
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateMutations** = `Record`\<`string`, [`MutationDefinition`](MutationDefinition.md)\<`any`, `any`, `any`\>\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/mutation.ts:95](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/mutation.ts:95](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/mutation.ts#L95)
|
|
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`; `mutation?`: [`MutationIdentity`](MutationIdentity.md); `name?`: `string`; `select`: `string`[]; `type?`: `string`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/protocol.ts:9](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/protocol.ts:9](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/protocol.ts#L9)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateProtocolRequest** = `Readonly`\<\{ `operations`: [`FateOperation`](FateOperation.md)[]; `version`: `FateProtocolVersion`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/protocol.ts:33](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/protocol.ts:33](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/protocol.ts#L33)
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateProtocolResponse** = `Readonly`\<\{ `results`: `FateOperationResult`[]; `version`: `FateProtocolVersion`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/protocol.ts:38](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/protocol.ts:38](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/protocol.ts#L38)
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
> **FateRecord** = `Record`\<`string`, `unknown`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/types.ts:70](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:70](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L70)
|
|
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: [fate/src/types.ts:456](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/types.ts:456](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/types.ts#L456)
|
|
6
6
|
|
|
7
7
|
Minimal root description used for typing root maps.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **GraphQLMutationDefinition**\<`T`, `Input`, `Output`\> = `Readonly`\<\{ `__fateGraphQLMutation?`: \{ `input`: `Input`; `output`: `Output`; \}; `entity`: `T`\[`"__typename"`\]; `field`: `string`; `inputArg?`: `false` \| `string`; \}\>
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/graphqlTransport.ts:26](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/graphqlTransport.ts:26](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/graphqlTransport.ts#L26)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **GraphQLMutationInput**\<`Definition`\> = `Definition` *extends* [`GraphQLMutationDefinition`](GraphQLMutationDefinition.md)\<`any`, infer Input, `any`\> ? `Input` : `never`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/graphqlTransport.ts:40](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/graphqlTransport.ts:40](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/graphqlTransport.ts#L40)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **GraphQLMutationMap**\<`Mutations`\> = `Mutations` *extends* `Record`\<`string`, [`GraphQLMutationDefinition`](GraphQLMutationDefinition.md)\> ? `{ [K in keyof Mutations]: { input: GraphQLMutationInput<Mutations[K]>; output: GraphQLMutationOutput<Mutations[K]> } }` : `EmptyTransportMutations`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/graphqlTransport.ts:46](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/graphqlTransport.ts:46](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/graphqlTransport.ts#L46)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **GraphQLMutationOutput**\<`Definition`\> = `Definition` *extends* [`GraphQLMutationDefinition`](GraphQLMutationDefinition.md)\<`any`, `any`, infer Output\> ? `Output` : `never`
|
|
4
4
|
|
|
5
|
-
Defined in: [fate/src/graphqlTransport.ts:43](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [fate/src/graphqlTransport.ts:43](https://github.com/nkzw-tech/fate/blob/773f575cc13a2695a877106a1b35db101b2e431d/packages/fate/src/graphqlTransport.ts#L43)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|