@effect-app/vue 4.0.0-beta.29 → 4.0.0-beta.291
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/CHANGELOG.md +2167 -0
- package/dist/atomQuery.d.ts +107 -0
- package/dist/atomQuery.d.ts.map +1 -0
- package/dist/atomQuery.js +345 -0
- package/dist/commander.d.ts +634 -0
- package/dist/commander.d.ts.map +1 -0
- package/dist/commander.js +1070 -0
- package/dist/{experimental/confirm.d.ts → confirm.d.ts} +6 -4
- package/dist/confirm.d.ts.map +1 -0
- package/dist/confirm.js +26 -0
- package/dist/dependencyMetadata.d.ts +10 -0
- package/dist/dependencyMetadata.d.ts.map +1 -0
- package/dist/dependencyMetadata.js +29 -0
- package/dist/errorReporter.d.ts +6 -4
- package/dist/errorReporter.d.ts.map +1 -1
- package/dist/errorReporter.js +14 -19
- package/dist/form.d.ts +14 -5
- package/dist/form.d.ts.map +1 -1
- package/dist/form.js +46 -13
- package/dist/internal/tanstackQuery.d.ts +9 -0
- package/dist/internal/tanstackQuery.d.ts.map +1 -0
- package/dist/internal/tanstackQuery.js +194 -0
- package/dist/intl.d.ts +15 -0
- package/dist/intl.d.ts.map +1 -0
- package/dist/intl.js +9 -0
- package/dist/lib.d.ts +7 -9
- package/dist/lib.d.ts.map +1 -1
- package/dist/lib.js +35 -10
- package/dist/makeClient.d.ts +212 -336
- package/dist/makeClient.d.ts.map +1 -1
- package/dist/makeClient.js +388 -411
- package/dist/makeContext.d.ts.map +1 -1
- package/dist/makeIntl.d.ts.map +1 -1
- package/dist/{experimental/makeUseCommand.d.ts → makeUseCommand.d.ts} +4 -3
- package/dist/makeUseCommand.d.ts.map +1 -0
- package/dist/makeUseCommand.js +13 -0
- package/dist/mutate.d.ts +108 -40
- package/dist/mutate.d.ts.map +1 -1
- package/dist/mutate.js +211 -58
- package/dist/query.d.ts +139 -45
- package/dist/query.d.ts.map +1 -1
- package/dist/query.js +325 -122
- package/dist/routeParams.d.ts +4 -4
- package/dist/routeParams.d.ts.map +1 -1
- package/dist/routeParams.js +4 -3
- package/dist/runtime.d.ts +1 -14
- package/dist/runtime.d.ts.map +1 -1
- package/dist/runtime.js +2 -26
- package/dist/suspense.d.ts +19 -0
- package/dist/suspense.d.ts.map +1 -0
- package/dist/suspense.js +38 -0
- package/dist/toast.d.ts +2 -0
- package/dist/toast.d.ts.map +1 -0
- package/dist/toast.js +2 -0
- package/dist/withToast.d.ts +2 -0
- package/dist/withToast.d.ts.map +1 -0
- package/dist/withToast.js +2 -0
- package/docs/atom-query-api-redesign.md +207 -0
- package/docs/query-key-invalidation.md +106 -0
- package/examples/streamMutation.ts +72 -0
- package/package.json +30 -94
- package/src/atomQuery.ts +466 -0
- package/src/commander.ts +3413 -0
- package/src/{experimental/confirm.ts → confirm.ts} +13 -15
- package/src/dependencyMetadata.ts +38 -0
- package/src/errorReporter.ts +65 -75
- package/src/form.ts +61 -18
- package/src/index.ts +7 -7
- package/src/internal/tanstackQuery.ts +289 -0
- package/src/intl.ts +12 -0
- package/src/lib.ts +49 -21
- package/src/makeClient.ts +930 -1159
- package/src/makeIntl.ts +2 -2
- package/src/{experimental/makeUseCommand.ts → makeUseCommand.ts} +9 -6
- package/src/mutate.ts +372 -152
- package/src/query.ts +683 -260
- package/src/routeParams.ts +7 -7
- package/src/runtime.ts +1 -31
- package/src/suspense.ts +43 -0
- package/src/toast.ts +1 -0
- package/src/withToast.ts +1 -0
- package/test/Mutation.test.ts +181 -24
- package/test/dependencyInvalidation.test.ts +352 -0
- package/test/dist/dependencyInvalidation.test.d.ts.map +1 -0
- package/test/dist/form.test.d.ts.map +1 -1
- package/test/dist/lib.test.d.ts.map +1 -0
- package/test/dist/query-span.test.d.ts.map +1 -0
- package/test/dist/streamFinal.test.d.ts.map +1 -0
- package/test/dist/streamFn.test.d.ts.map +1 -0
- package/test/dist/stubs.d.ts +3756 -122
- package/test/dist/stubs.d.ts.map +1 -1
- package/test/dist/stubs.js +192 -32
- package/test/dist/suspense-regression.test.d.ts.map +1 -0
- package/test/dist/suspense.test.d.ts.map +1 -0
- package/test/form-validation-errors.test.ts +25 -20
- package/test/form.test.ts +22 -3
- package/test/lib.test.ts +240 -0
- package/test/makeClient.test.ts +437 -38
- package/test/query-span.test.ts +92 -0
- package/test/streamFinal.test.ts +64 -0
- package/test/streamFn.test.ts +457 -0
- package/test/stubs.ts +228 -43
- package/test/suspense-regression.test.ts +168 -0
- package/test/suspense.test.ts +160 -0
- package/tsconfig.examples.json +20 -0
- package/tsconfig.json +3 -1
- package/tsconfig.src.json +34 -34
- package/tsconfig.test.json +2 -2
- package/vitest.config.ts +5 -5
- package/dist/experimental/commander.d.ts +0 -359
- package/dist/experimental/commander.d.ts.map +0 -1
- package/dist/experimental/commander.js +0 -557
- package/dist/experimental/confirm.d.ts.map +0 -1
- package/dist/experimental/confirm.js +0 -28
- package/dist/experimental/intl.d.ts +0 -16
- package/dist/experimental/intl.d.ts.map +0 -1
- package/dist/experimental/intl.js +0 -5
- package/dist/experimental/makeUseCommand.d.ts.map +0 -1
- package/dist/experimental/makeUseCommand.js +0 -13
- package/dist/experimental/toast.d.ts +0 -47
- package/dist/experimental/toast.d.ts.map +0 -1
- package/dist/experimental/toast.js +0 -41
- package/dist/experimental/withToast.d.ts +0 -25
- package/dist/experimental/withToast.d.ts.map +0 -1
- package/dist/experimental/withToast.js +0 -45
- package/eslint.config.mjs +0 -24
- package/src/experimental/commander.ts +0 -1835
- package/src/experimental/intl.ts +0 -9
- package/src/experimental/toast.ts +0 -66
- package/src/experimental/withToast.ts +0 -99
- package/tsconfig.json.bak +0 -12
package/src/makeClient.ts
CHANGED
|
@@ -1,162 +1,324 @@
|
|
|
1
1
|
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
2
|
-
import { type InvalidateOptions, type InvalidateQueryFilters, isCancelledError, type QueryObserverResult, type RefetchOptions, type UseQueryReturnType } from "@tanstack/vue-query"
|
|
3
2
|
import { camelCase } from "change-case"
|
|
4
|
-
import { Cause, Data, Effect, Exit, Layer, type ManagedRuntime, Match, Option, S, ServiceMap, Struct } from "effect-app"
|
|
5
3
|
import { type ApiClientFactory, type Req } from "effect-app/client"
|
|
6
|
-
import type {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
9
|
-
import
|
|
10
|
-
import
|
|
4
|
+
import type { ExtractModuleName, HandlerInput, RequestHandlers, RequestHandlerWithInput, RequestsAny, RequestStreamHandlerWithInput } from "effect-app/client/clientFor"
|
|
5
|
+
import type { CauseException } from "effect-app/client/errors"
|
|
6
|
+
import type { InvalidationCallback } from "effect-app/client/makeClient"
|
|
7
|
+
import * as Context from "effect-app/Context"
|
|
8
|
+
import * as Effect from "effect-app/Effect"
|
|
9
|
+
import * as Layer from "effect-app/Layer"
|
|
10
|
+
import * as S from "effect-app/Schema"
|
|
11
|
+
import * as Exit from "effect/Exit"
|
|
11
12
|
import { type Fiber } from "effect/Fiber"
|
|
12
|
-
import * as
|
|
13
|
-
import
|
|
14
|
-
import
|
|
15
|
-
import
|
|
16
|
-
import
|
|
17
|
-
import
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
21
|
-
import {
|
|
22
|
-
import { type
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
13
|
+
import * as Hash from "effect/Hash"
|
|
14
|
+
import type * as ManagedRuntime from "effect/ManagedRuntime"
|
|
15
|
+
import type * as Stream from "effect/Stream"
|
|
16
|
+
import * as Struct from "effect/Struct"
|
|
17
|
+
import type * as AsyncResult from "effect/unstable/reactivity/AsyncResult"
|
|
18
|
+
import * as Reactivity from "effect/unstable/reactivity/Reactivity"
|
|
19
|
+
import { type ComputedRef, effectScope, onBeforeUnmount, onScopeDispose, ref, type WatchSource } from "vue"
|
|
20
|
+
import { type AtomClientRuntime, invalidateAndAwait, makeAtomClientRuntime } from "./atomQuery.ts"
|
|
21
|
+
import { type Commander, CommanderStatic, type Progress } from "./commander.ts"
|
|
22
|
+
import { makeTanstackQuery, makeTanstackQueryCacheUpdater, makeTanstackQueryClient, makeTanstackQueryInvalidator } from "./internal/tanstackQuery.ts"
|
|
23
|
+
import { type I18n } from "./intl.ts"
|
|
24
|
+
import { type CommanderResolved, makeUseCommand } from "./makeUseCommand.ts"
|
|
25
|
+
import { atomQueryInvalidator, combineQueryInvalidators, type InvalidationEntry, makeMutation, makeStreamMutation2, type MutationOptionsBase, type QueryInvalidator, useMakeMutation } from "./mutate.ts"
|
|
26
|
+
import { atomQueryCacheUpdater, type AtomQueryNewOptions, combineQueryCacheUpdaters, type CustomUndefinedInitialQueryOptions, makeQuery, makeQueryAtom, makeQueryFamily, makeQueryNew, makeStreamQuery, makeStreamQueryAtom, makeStreamQueryFamily, makeStreamQueryNew, optionalAtomQueryCacheUpdater, type QueryObserverResult, type RefetchOptions, setQueryCacheUpdater, type StreamQueryAtomFamily, type SuspenseQueryView, type UseQueryReturnType } from "./query.ts"
|
|
27
|
+
import { makeRunPromise } from "./runtime.ts"
|
|
28
|
+
import { latestDefined } from "./suspense.ts"
|
|
29
|
+
import { type Toast } from "./toast.ts"
|
|
30
|
+
|
|
31
|
+
export type { Progress }
|
|
32
|
+
|
|
33
|
+
const useScopedSuspenseSetup = <A>(setup: () => A) => {
|
|
34
|
+
const scope = effectScope()
|
|
35
|
+
const controller = new AbortController()
|
|
36
|
+
const value = scope.run(setup)
|
|
37
|
+
if (value === undefined) {
|
|
38
|
+
throw new Error("Internal Error: suspense setup scope did not initialize")
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
const isMounted = ref(true)
|
|
42
|
+
let stopped = false
|
|
43
|
+
const stop = () => {
|
|
44
|
+
if (stopped) return
|
|
45
|
+
stopped = true
|
|
46
|
+
isMounted.value = false
|
|
47
|
+
controller.abort()
|
|
48
|
+
scope.stop()
|
|
49
|
+
}
|
|
50
|
+
onBeforeUnmount(stop)
|
|
51
|
+
onScopeDispose(stop)
|
|
52
|
+
|
|
53
|
+
return [value, isMounted, controller.signal] as const
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// TODO: optimize - work from encoded shape directly
|
|
57
|
+
const projectHandler = <
|
|
58
|
+
I,
|
|
59
|
+
A,
|
|
60
|
+
E,
|
|
61
|
+
R,
|
|
62
|
+
SuccessSchema extends S.Top & { readonly "EncodingServices": R },
|
|
63
|
+
ProjSchema extends S.Top & { readonly "DecodingServices": R }
|
|
64
|
+
>(
|
|
65
|
+
handler: (i: I) => Effect.Effect<A, E, R>,
|
|
66
|
+
successSchema: SuccessSchema,
|
|
67
|
+
projectionSchema: ProjSchema
|
|
68
|
+
) => {
|
|
69
|
+
const encode = S.encodeUnknownEffect(successSchema)
|
|
70
|
+
const decode = S.decodeUnknownEffect(projectionSchema)
|
|
71
|
+
return (i: I) => handler(i).pipe(Effect.flatMap(encode), Effect.flatMap(decode))
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
const projectionSchemaHash = (schema: S.Top) => String(Hash.hash(schema.ast))
|
|
75
|
+
|
|
76
|
+
export interface CommandRequestExtensions<RT, Id extends string, I, A, E, R> {
|
|
30
77
|
/** Defines a Command based on this call, taking the `id` of the call as the `id` of the Command.
|
|
31
78
|
* The Request function will be taken as the first member of the Command, the Command required input will be the Request input.
|
|
32
79
|
* see Command.wrap for details */
|
|
33
|
-
wrap:
|
|
80
|
+
wrap: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
81
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
82
|
+
) => Commander.CommanderWrap<RT, Id, I18nKey, State, I, A, E, R>
|
|
34
83
|
/** Defines a Command based on this call, taking the `id` of the call as the `id` of the Command.
|
|
35
84
|
* see Command.fn for details */
|
|
36
|
-
fn:
|
|
85
|
+
fn: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
86
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
87
|
+
) => Commander.CommanderFn<RT, Id, I18nKey, State>
|
|
37
88
|
}
|
|
38
89
|
|
|
39
90
|
/** my other doc */
|
|
40
|
-
export interface
|
|
91
|
+
export interface RequestExt<
|
|
41
92
|
RT,
|
|
42
93
|
Id extends string,
|
|
43
94
|
I,
|
|
44
95
|
A,
|
|
45
96
|
E,
|
|
46
97
|
R
|
|
47
|
-
> extends
|
|
98
|
+
> extends
|
|
99
|
+
Commander.CommandContextLocal<Id, Id>,
|
|
100
|
+
Commander.CommanderWrap<RT, Id, Id, undefined, I, A, E, R>,
|
|
101
|
+
CommandRequestExtensions<RT, Id, I, A, E, R>
|
|
102
|
+
{
|
|
48
103
|
/**
|
|
49
|
-
*
|
|
104
|
+
* Send the request to the endpoint and return the raw Effect response.
|
|
105
|
+
* This does not perform query cache invalidation.
|
|
50
106
|
*/
|
|
51
|
-
(i: I)
|
|
107
|
+
request: (i: I) => Effect.Effect<A, E, R>
|
|
52
108
|
}
|
|
53
109
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
>
|
|
64
|
-
Commander.CommandContextLocal<Id, Id>,
|
|
65
|
-
Commander.CommanderWrap<RT, Id, Id, undefined, void, A, E, R>,
|
|
66
|
-
RequestExtensions<RT, Id, void, A, E, R>,
|
|
67
|
-
Effect.Effect<A, E, R>
|
|
68
|
-
{
|
|
110
|
+
export type CommandRequestWithExtensions<RT, Req> = Req extends
|
|
111
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer Id> ? RequestExt<RT, Id, I, A, E, R>
|
|
112
|
+
: never
|
|
113
|
+
|
|
114
|
+
export interface QueryExtensions<I, A, E, R> {
|
|
115
|
+
/**
|
|
116
|
+
* Send the request to the endpoint and return the raw Effect response.
|
|
117
|
+
* This does not set up query state tracking.
|
|
118
|
+
*/
|
|
119
|
+
request: (i: I) => Effect.Effect<A, E, R>
|
|
69
120
|
}
|
|
70
121
|
|
|
71
|
-
export type
|
|
72
|
-
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer
|
|
73
|
-
|
|
74
|
-
|
|
122
|
+
export type QueryRequestWithExtensions<Req> = Req extends
|
|
123
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer _Id> ? QueryExtensions<I, A, E, R>
|
|
124
|
+
: never
|
|
125
|
+
|
|
126
|
+
type QueryHandler<Req> = Req extends
|
|
127
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
|
|
128
|
+
? Request["type"] extends "query" ? RequestHandlerWithInput<I, A, E, R, Request, Id> : never
|
|
129
|
+
: never
|
|
130
|
+
|
|
131
|
+
type CommandHandler<Req> = Req extends
|
|
132
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
|
|
133
|
+
? Request["type"] extends "command" ? RequestHandlerWithInput<I, A, E, R, Request, Id> : never
|
|
134
|
+
: never
|
|
135
|
+
|
|
136
|
+
type QueryStreamHandler<Req> = Req extends
|
|
137
|
+
RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id, infer Final>
|
|
138
|
+
? [Request["stream"], Request["type"]] extends [true, "query"]
|
|
139
|
+
? RequestStreamHandlerWithInput<I, A, E, R, Request, Id, Final>
|
|
140
|
+
: never
|
|
141
|
+
: never
|
|
142
|
+
|
|
143
|
+
type CommandStreamHandler<Req> = Req extends
|
|
144
|
+
RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id, infer Final>
|
|
145
|
+
? [Request["stream"], Request["type"]] extends [true, "command"]
|
|
146
|
+
? RequestStreamHandlerWithInput<I, A, E, R, Request, Id, Final>
|
|
147
|
+
: never
|
|
75
148
|
: never
|
|
76
149
|
|
|
77
150
|
export interface MutationExtensions<RT, Id extends string, I, A, E, R> {
|
|
78
151
|
/** Defines a Command based on this mutation, taking the `id` of the mutation as the `id` of the Command.
|
|
79
152
|
* The Mutation function will be taken as the first member of the Command, the Command required input will be the Mutation input.
|
|
80
153
|
* see Command.wrap for details */
|
|
81
|
-
wrap:
|
|
82
|
-
|
|
154
|
+
wrap: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
155
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
156
|
+
) => Commander.CommanderWrap<RT, Id, I18nKey, State, I, A, E, R>
|
|
157
|
+
/** Defines a Command based on this call, taking the `id` of the mutation as the `id` of the Command.
|
|
83
158
|
* see Command.fn for details */
|
|
84
|
-
fn:
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
/** my other doc */
|
|
88
|
-
export interface MutationExtWithInput<
|
|
89
|
-
RT,
|
|
90
|
-
Id extends string,
|
|
91
|
-
I,
|
|
92
|
-
A,
|
|
93
|
-
E,
|
|
94
|
-
R
|
|
95
|
-
> extends Commander.CommandContextLocal<Id, Id>, MutationExtensions<RT, Id, I, A, E, R> {
|
|
96
|
-
/**
|
|
97
|
-
* Call the endpoint with input
|
|
98
|
-
* Invalidate queries based on namespace of this mutation.
|
|
99
|
-
* Do not use for queries.
|
|
100
|
-
*/
|
|
101
|
-
(i: I): Effect.Effect<A, E, R>
|
|
159
|
+
fn: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
160
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
161
|
+
) => Commander.CommanderFn<RT, Id, I18nKey, State>
|
|
102
162
|
}
|
|
103
163
|
|
|
104
164
|
/**
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
165
|
+
* Send the request to the endpoint and return the raw Effect response.
|
|
166
|
+
* Also invalidates query caches using the request namespace by default.
|
|
167
|
+
* Namespace invalidation targets parent namespace keys
|
|
168
|
+
* (for example `$project/$configuration.get` invalidates `$project`).
|
|
169
|
+
* Override invalidation in client options via `queryInvalidation`.
|
|
170
|
+
*
|
|
171
|
+
* Pass `options` to attach a `select` Effect that runs after the mutation
|
|
172
|
+
* succeeds (its output is returned to the caller) and/or override the default
|
|
173
|
+
* `queryInvalidation`.
|
|
174
|
+
*
|
|
175
|
+
* When `I = void` the input argument may be omitted.
|
|
108
176
|
*/
|
|
109
177
|
export interface MutationExt<
|
|
110
178
|
RT,
|
|
111
179
|
Id extends string,
|
|
180
|
+
I,
|
|
112
181
|
A,
|
|
113
182
|
E,
|
|
114
|
-
R
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
183
|
+
R,
|
|
184
|
+
EA = unknown
|
|
185
|
+
> extends MutationExtensions<RT, Id, I, A, E, R> {
|
|
186
|
+
<B = A, E2 = never, R2 = never>(
|
|
187
|
+
input: I,
|
|
188
|
+
options?: MutationOptionsBase<A, B, E2, R2>
|
|
189
|
+
): Effect.Effect<B, E | E2, R | R2>
|
|
190
|
+
|
|
191
|
+
project: <ProjSchema extends S.Top>(
|
|
192
|
+
schema: EA extends ProjSchema["Encoded"] ? ProjSchema : never
|
|
193
|
+
) => MutationExt<
|
|
194
|
+
RT,
|
|
195
|
+
Id,
|
|
196
|
+
I,
|
|
197
|
+
ProjSchema["Type"],
|
|
198
|
+
E | S.SchemaError,
|
|
199
|
+
R | ProjSchema["DecodingServices"],
|
|
200
|
+
ProjSchema["Encoded"]
|
|
201
|
+
>
|
|
121
202
|
}
|
|
122
203
|
|
|
123
204
|
export type MutationWithExtensions<RT, Req> = Req extends
|
|
124
|
-
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer
|
|
125
|
-
?
|
|
126
|
-
:
|
|
205
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
|
|
206
|
+
? MutationExt<RT, Id, I, A, E, R, Request["success"]["Encoded"]>
|
|
207
|
+
: never
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* The `streamFn` builder for a stream-type request handler, using the stream-specific overloads.
|
|
211
|
+
*/
|
|
212
|
+
export type StreamFnStreamExtension<RT, Req> = Req extends
|
|
213
|
+
RequestStreamHandlerWithInput<infer _I, infer _A, infer _E, infer _R, infer _Request, infer Id, infer _Final>
|
|
214
|
+
? <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
215
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
216
|
+
) => Commander.StreamGen<RT, Id, I18nKey, State> & Commander.NonGenStream<RT, Id, I18nKey, State>
|
|
217
|
+
: never
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* `mutate` factory — wraps per-invocation invalidation scaffolding
|
|
221
|
+
* into the stream itself (via `Stream.unwrap`) for use with `streamFn` combinators.
|
|
222
|
+
*/
|
|
223
|
+
export type StreamMutation2WithExtensions<RT, Req> = Req extends
|
|
224
|
+
RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer Id, infer _Final> ?
|
|
225
|
+
& ((input: I) => Stream.Stream<A, E, R>)
|
|
226
|
+
& {
|
|
227
|
+
readonly id: Id
|
|
228
|
+
readonly wrap: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
229
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
230
|
+
) => Commander.StreamerWrap<RT, Id, I18nKey, State, I, A, E, R>
|
|
231
|
+
}
|
|
127
232
|
: never
|
|
128
233
|
|
|
129
234
|
// we don't really care about the RT, as we are in charge of ensuring runtime safety anyway
|
|
130
235
|
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
131
236
|
declare const useQuery_: QueryImpl<any>["useQuery"]
|
|
132
237
|
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
238
|
+
declare const useQueryNew_: QueryImpl<any>["useQueryNew"]
|
|
239
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
240
|
+
declare const useQueryAtom_: QueryImpl<any>["useQueryAtom"]
|
|
241
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
242
|
+
declare const useQueryFamily_: QueryImpl<any>["useQueryFamily"]
|
|
243
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
244
|
+
declare const useSuspenseQueryNew_: QueryImpl<any>["useSuspenseQueryNew"]
|
|
245
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
133
246
|
declare const useSuspenseQuery_: QueryImpl<any>["useSuspenseQuery"]
|
|
247
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
248
|
+
declare const useStreamQuery_: QueryImpl<any>["useStreamQuery"]
|
|
249
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
250
|
+
declare const useStreamQueryFamily_: QueryImpl<any>["useStreamQueryFamily"]
|
|
251
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
252
|
+
declare const useStreamQueryAtom_: QueryImpl<any>["useStreamQueryAtom"]
|
|
253
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
254
|
+
declare const useStreamQueryNew_: QueryImpl<any>["useStreamQueryNew"]
|
|
255
|
+
|
|
256
|
+
export interface ProjectResult<RT, I, B, E, R, Request extends Req, Id extends string> {
|
|
257
|
+
request: (i: I) => Effect.Effect<B, E, R>
|
|
258
|
+
family: Exclude<R, RT> extends never ? ReturnType<typeof useQueryFamily_<I, E, B, Request, Id>>
|
|
259
|
+
: MissingDependencies<RT, R> & {}
|
|
260
|
+
query: Exclude<R, RT> extends never ? ReturnType<typeof useQuery_<I, E, B, Request, Id>>
|
|
261
|
+
: MissingDependencies<RT, R> & {}
|
|
262
|
+
queryNew: Exclude<R, RT> extends never ? ReturnType<typeof useQueryNew_<I, E, B, Request, Id>>
|
|
263
|
+
: MissingDependencies<RT, R> & {}
|
|
264
|
+
suspense: Exclude<R, RT> extends never ? ReturnType<typeof useSuspenseQuery_<I, E, B, Request, Id>>
|
|
265
|
+
: MissingDependencies<RT, R> & {}
|
|
266
|
+
suspenseNew: Exclude<R, RT> extends never ? ReturnType<typeof useSuspenseQueryNew_<I, E, B, Request, Id>>
|
|
267
|
+
: MissingDependencies<RT, R> & {}
|
|
268
|
+
atom: Exclude<R, RT> extends never ? ReturnType<typeof useQueryAtom_<I, E, B, Request, Id>>
|
|
269
|
+
: MissingDependencies<RT, R> & {}
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
export type QueryProjection<RT, HandlerReq> = HandlerReq extends
|
|
273
|
+
RequestHandlerWithInput<infer I, infer _A, infer E, infer R, infer Request, infer Id>
|
|
274
|
+
? Request["type"] extends "query" ? {
|
|
275
|
+
project: <ProjSchema extends S.Top>(
|
|
276
|
+
schema: Request["success"]["Encoded"] extends ProjSchema["Encoded"] ? ProjSchema : never
|
|
277
|
+
) => ProjectResult<
|
|
278
|
+
RT,
|
|
279
|
+
I,
|
|
280
|
+
ProjSchema["Type"],
|
|
281
|
+
E | S.SchemaError,
|
|
282
|
+
R | ProjSchema["DecodingServices"],
|
|
283
|
+
Request,
|
|
284
|
+
Id
|
|
285
|
+
>
|
|
286
|
+
}
|
|
287
|
+
: {}
|
|
288
|
+
: {}
|
|
134
289
|
|
|
135
|
-
export interface
|
|
290
|
+
export interface QueryResultExtensions<Request extends Req, Id extends string, I, A, E> {
|
|
136
291
|
/**
|
|
137
|
-
*
|
|
292
|
+
* Read helper for query requests.
|
|
293
|
+
* Runs as a tracked Vue Query and returns reactive state.
|
|
294
|
+
* Queries read state and should not be used to mutate it.
|
|
295
|
+
* When `I = void` the input argument may be omitted.
|
|
138
296
|
*/
|
|
139
297
|
query: ReturnType<typeof useQuery_<I, E, A, Request, Id>>
|
|
298
|
+
/**
|
|
299
|
+
* Atom-native query helper with object return shape.
|
|
300
|
+
* Additive migration surface; `.query()` remains the compatibility tuple API.
|
|
301
|
+
*/
|
|
302
|
+
queryNew: ReturnType<typeof useQueryNew_<I, E, A, Request, Id>>
|
|
140
303
|
// TODO or suspense as Option?
|
|
141
304
|
/**
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* So that Suspense and error boundaries can be used.
|
|
305
|
+
* Like `.query`, but returns a Promise for setup-time awaiting.
|
|
306
|
+
* Use this when integrating with Vue Suspense / error boundaries.
|
|
145
307
|
*/
|
|
146
308
|
suspense: ReturnType<typeof useSuspenseQuery_<I, E, A, Request, Id>>
|
|
147
|
-
}
|
|
148
|
-
export interface QueriesWithoutInput<Request extends Req, Id extends string, A, E> {
|
|
149
309
|
/**
|
|
150
|
-
*
|
|
310
|
+
* Promise-based setup helper with object return shape.
|
|
311
|
+
* Additive migration surface; `.suspense()` remains the compatibility tuple API.
|
|
151
312
|
*/
|
|
152
|
-
|
|
153
|
-
// TODO or suspense as Option?
|
|
313
|
+
suspenseNew: ReturnType<typeof useSuspenseQueryNew_<I, E, A, Request, Id>>
|
|
154
314
|
/**
|
|
155
|
-
*
|
|
156
|
-
|
|
157
|
-
|
|
315
|
+
* Raw query atom for composition outside Vue refs.
|
|
316
|
+
*/
|
|
317
|
+
atom: ReturnType<typeof useQueryAtom_<I, E, A, Request, Id>>
|
|
318
|
+
/**
|
|
319
|
+
* Raw query atom family for composing query graphs before choosing a Vue observer.
|
|
158
320
|
*/
|
|
159
|
-
|
|
321
|
+
family: ReturnType<typeof useQueryFamily_<I, E, A, Request, Id>>
|
|
160
322
|
}
|
|
161
323
|
|
|
162
324
|
export type MissingDependencies<RT, R> = {
|
|
@@ -166,184 +328,59 @@ export type MissingDependencies<RT, R> = {
|
|
|
166
328
|
|
|
167
329
|
export type Queries<RT, Req> = Req extends
|
|
168
330
|
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
|
|
169
|
-
? Exclude<R, RT> extends never ?
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
331
|
+
? Request["type"] extends "query" ? Exclude<R, RT> extends never ? QueryResultExtensions<Request, Id, I, A, E>
|
|
332
|
+
: {
|
|
333
|
+
atom: MissingDependencies<RT, R> & {}
|
|
334
|
+
family: MissingDependencies<RT, R> & {}
|
|
335
|
+
query: MissingDependencies<RT, R> & {}
|
|
336
|
+
queryNew: MissingDependencies<RT, R> & {}
|
|
337
|
+
suspense: MissingDependencies<RT, R> & {}
|
|
338
|
+
suspenseNew: MissingDependencies<RT, R> & {}
|
|
339
|
+
}
|
|
340
|
+
: never
|
|
177
341
|
: never
|
|
178
342
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
E2 = E,
|
|
195
|
-
R2 = R,
|
|
196
|
-
ESuccess = never,
|
|
197
|
-
RSuccess = never,
|
|
198
|
-
EError = never,
|
|
199
|
-
RError = never,
|
|
200
|
-
EDefect = never,
|
|
201
|
-
RDefect = never
|
|
202
|
-
> extends MutationOptions<A, E, R, A2, E2, R2, I> {
|
|
203
|
-
/** set to `undefined` to use default message */
|
|
204
|
-
successMessage?: ((a: A2, i: I) => Effect.Effect<string | undefined, ESuccess, RSuccess>) | undefined
|
|
205
|
-
/** set to `undefined` to use default message */
|
|
206
|
-
failMessage?: ((e: E2, i: I) => Effect.Effect<string | undefined, EError, RError>) | undefined
|
|
207
|
-
/** set to `undefined` to use default message */
|
|
208
|
-
defectMessage?: ((e: Cause.Cause<E2>, i: I) => Effect.Effect<string | undefined, EDefect, RDefect>) | undefined
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
export interface LowOpts<
|
|
212
|
-
A,
|
|
213
|
-
E,
|
|
214
|
-
I = void,
|
|
215
|
-
ESuccess = never,
|
|
216
|
-
RSuccess = never,
|
|
217
|
-
EError = never,
|
|
218
|
-
RError = never,
|
|
219
|
-
EDefect = never,
|
|
220
|
-
RDefect = never
|
|
221
|
-
> {
|
|
222
|
-
onSuccess: (a: A, i: I) => Effect.Effect<void, ESuccess, RSuccess>
|
|
223
|
-
onFail: (e: E, i: I) => Effect.Effect<void, EError, RError>
|
|
224
|
-
onDefect: (e: Cause.Cause<E>, i: I) => Effect.Effect<void, EDefect, RDefect>
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
export interface LowOptsOptional<
|
|
228
|
-
A,
|
|
229
|
-
E,
|
|
230
|
-
R,
|
|
231
|
-
I = void,
|
|
232
|
-
A2 = A,
|
|
233
|
-
E2 = E,
|
|
234
|
-
R2 = R,
|
|
235
|
-
ESuccess = never,
|
|
236
|
-
RSuccess = never,
|
|
237
|
-
EError = never,
|
|
238
|
-
RError = never,
|
|
239
|
-
EDefect = never,
|
|
240
|
-
RDefect = never
|
|
241
|
-
> extends MutationOptions<A, E, R, A2, E2, R2, I> {
|
|
242
|
-
onSuccess?: (a: A, i: I) => Effect.Effect<void, ESuccess, RSuccess>
|
|
243
|
-
onFail?: (e: E, i: I) => Effect.Effect<void, EError, RError>
|
|
244
|
-
onDefect?: (e: Cause.Cause<E>, i: I) => Effect.Effect<void, EDefect, RDefect>
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
type WithAction<A> = A & {
|
|
248
|
-
action: string
|
|
343
|
+
export interface StreamQueryExtensions<Request extends Req, Id extends string, I, A, E> {
|
|
344
|
+
atom: ReturnType<typeof useStreamQueryAtom_<I, E, A, Request, Id>>
|
|
345
|
+
family: StreamQueryAtomFamily<I, A, E>
|
|
346
|
+
/**
|
|
347
|
+
* Stream helper for query-stream requests.
|
|
348
|
+
* Legacy compatibility helper. Collects the whole stream into an array before
|
|
349
|
+
* publishing data.
|
|
350
|
+
* When `I = void` the input argument may be omitted.
|
|
351
|
+
*/
|
|
352
|
+
query: ReturnType<typeof useStreamQuery_<I, E, A, Request, Id>>
|
|
353
|
+
/**
|
|
354
|
+
* Atom-native stream query helper. Exposes incremental pull state and a `pull`
|
|
355
|
+
* command instead of collecting the whole stream first.
|
|
356
|
+
*/
|
|
357
|
+
queryNew: ReturnType<typeof useStreamQueryNew_<I, E, A, Request, Id>>
|
|
249
358
|
}
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
type ActResp<A, E, R, V = ComputedRef<Res<A, E>>> = readonly [
|
|
260
|
-
V,
|
|
261
|
-
WithAction<Effect.Effect<Exit.Exit<A, E>, never, R>>
|
|
262
|
-
]
|
|
263
|
-
|
|
264
|
-
export const suppressToast = constant(Effect.succeed(undefined))
|
|
265
|
-
|
|
266
|
-
/** handles errors as specified and reports defects */
|
|
267
|
-
function handleRequest<
|
|
268
|
-
E extends ResponseErrors,
|
|
269
|
-
A,
|
|
270
|
-
R,
|
|
271
|
-
I = void,
|
|
272
|
-
ESuccess = never,
|
|
273
|
-
RSuccess = never,
|
|
274
|
-
EError = never,
|
|
275
|
-
RError = never,
|
|
276
|
-
EDefect = never,
|
|
277
|
-
RDefect = never
|
|
278
|
-
>(
|
|
279
|
-
f: Effect.Effect<Exit.Exit<A, E>, never, R> | ((i: I) => Effect.Effect<Exit.Exit<A, E>, never, R>),
|
|
280
|
-
id: string,
|
|
281
|
-
action: string,
|
|
282
|
-
options: {
|
|
283
|
-
onSuccess: (a: A, i: I) => Effect.Effect<void, ESuccess, RSuccess>
|
|
284
|
-
onFail: (e: E, i: I) => Effect.Effect<void, EError, RError>
|
|
285
|
-
onDefect: (e: Cause.Cause<E>, i: I) => Effect.Effect<void, EDefect, RDefect>
|
|
359
|
+
export type StreamQueries<RT, HandlerReq> = HandlerReq extends
|
|
360
|
+
RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id, infer _Final>
|
|
361
|
+
? Exclude<R, RT> extends never ? StreamQueryExtensions<Request, Id, I, A, E>
|
|
362
|
+
: {
|
|
363
|
+
atom: MissingDependencies<RT, R> & {}
|
|
364
|
+
family: MissingDependencies<RT, R> & {}
|
|
365
|
+
query: MissingDependencies<RT, R> & {}
|
|
366
|
+
queryNew: MissingDependencies<RT, R> & {}
|
|
286
367
|
}
|
|
287
|
-
|
|
288
|
-
const handleEffect = (i: any) => (self: Effect.Effect<Exit.Exit<A, E>, never, R>) =>
|
|
289
|
-
self.pipe(
|
|
290
|
-
Effect.tap(
|
|
291
|
-
Effect.matchCauseEffect({
|
|
292
|
-
onSuccess: (r) => options.onSuccess(r, i),
|
|
293
|
-
onFailure: (cause) =>
|
|
294
|
-
Effect.gen(function*() {
|
|
295
|
-
if (Cause.hasInterruptsOnly(cause)) {
|
|
296
|
-
console.info(`Interrupted while trying to ${action}`)
|
|
297
|
-
return
|
|
298
|
-
}
|
|
299
|
-
|
|
300
|
-
const fail = Cause.findErrorOption(cause)
|
|
301
|
-
if (Option.isSome(fail)) {
|
|
302
|
-
if (fail.value._tag === "SuppressErrors") {
|
|
303
|
-
console.info(`Suppressed error trying to ${action}`, fail.value)
|
|
304
|
-
return
|
|
305
|
-
}
|
|
306
|
-
const message = `Failure trying to ${action}`
|
|
307
|
-
yield* reportMessage(message, { action, error: fail.value })
|
|
308
|
-
yield* options.onFail(fail.value, i)
|
|
309
|
-
return
|
|
310
|
-
}
|
|
368
|
+
: never
|
|
311
369
|
|
|
312
|
-
|
|
313
|
-
action,
|
|
314
|
-
message: `Unexpected Error trying to ${action}`
|
|
315
|
-
}
|
|
316
|
-
yield* reportRuntimeError(cause, extra)
|
|
370
|
+
const _useMutation = makeMutation(atomQueryInvalidator)
|
|
317
371
|
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
Effect.withSpan(`mutation ${id}`, {}, { captureStackTrace: false })
|
|
323
|
-
)
|
|
324
|
-
return Object.assign(
|
|
325
|
-
Effect.isEffect(f)
|
|
326
|
-
? pipe(
|
|
327
|
-
f,
|
|
328
|
-
handleEffect(void 0)
|
|
329
|
-
)
|
|
330
|
-
: (i: I) =>
|
|
331
|
-
pipe(
|
|
332
|
-
f(i),
|
|
333
|
-
handleEffect(i)
|
|
334
|
-
),
|
|
335
|
-
{ action }
|
|
336
|
-
)
|
|
372
|
+
const wrapWithSpan = (self: { id: string }, mut: any) => {
|
|
373
|
+
const span = (eff: Effect.Effect<any, any, any>) =>
|
|
374
|
+
Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })(eff)
|
|
375
|
+
return (input: any, options?: MutationOptionsBase) => span(mut(input, options))
|
|
337
376
|
}
|
|
338
377
|
|
|
339
|
-
const _useMutation = makeMutation()
|
|
340
|
-
|
|
341
378
|
/**
|
|
342
379
|
* Pass an Effect or a function that returns an Effect, e.g from a client action
|
|
343
380
|
* Executes query cache invalidation based on default rules or provided option.
|
|
344
381
|
* adds a span with the mutation id
|
|
345
382
|
*/
|
|
346
|
-
export const useMutation: typeof _useMutation = <
|
|
383
|
+
export const useMutation: typeof _useMutation = (<
|
|
347
384
|
I,
|
|
348
385
|
E,
|
|
349
386
|
A,
|
|
@@ -351,25 +388,21 @@ export const useMutation: typeof _useMutation = <
|
|
|
351
388
|
Request extends Req,
|
|
352
389
|
Name extends string
|
|
353
390
|
>(
|
|
354
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
355
|
-
options?: MutationOptionsBase
|
|
391
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
356
392
|
) =>
|
|
357
393
|
Object.assign(
|
|
358
|
-
|
|
359
|
-
_useMutation(self as any, options),
|
|
360
|
-
Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })
|
|
361
|
-
) as any,
|
|
394
|
+
wrapWithSpan(self, _useMutation(self as any)),
|
|
362
395
|
{ id: self.id }
|
|
363
|
-
)
|
|
396
|
+
)) as any
|
|
364
397
|
|
|
365
398
|
/**
|
|
366
399
|
* Pass an Effect or a function that returns an Effect, e.g from a client action
|
|
367
400
|
* Executes query cache invalidation based on default rules or provided option.
|
|
368
401
|
* adds a span with the mutation id
|
|
369
402
|
*/
|
|
370
|
-
export const useMutationInt = (): typeof _useMutation => {
|
|
371
|
-
const _useMutation = useMakeMutation()
|
|
372
|
-
return <
|
|
403
|
+
export const useMutationInt = (queryInvalidator: QueryInvalidator): typeof _useMutation => {
|
|
404
|
+
const _useMutation = useMakeMutation(queryInvalidator)
|
|
405
|
+
return (<
|
|
373
406
|
I,
|
|
374
407
|
E,
|
|
375
408
|
A,
|
|
@@ -377,721 +410,65 @@ export const useMutationInt = (): typeof _useMutation => {
|
|
|
377
410
|
Request extends Req,
|
|
378
411
|
Name extends string
|
|
379
412
|
>(
|
|
380
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
381
|
-
options?: MutationOptionsBase
|
|
413
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
382
414
|
) =>
|
|
383
415
|
Object.assign(
|
|
384
|
-
|
|
385
|
-
_useMutation(self as any, options),
|
|
386
|
-
Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })
|
|
387
|
-
) as any,
|
|
416
|
+
wrapWithSpan(self, _useMutation(self as any)),
|
|
388
417
|
{ id: self.id }
|
|
389
|
-
)
|
|
418
|
+
)) as any
|
|
390
419
|
}
|
|
391
420
|
|
|
392
|
-
export
|
|
393
|
-
constructor(
|
|
394
|
-
private readonly getRuntime: () => ServiceMap.ServiceMap<RT>,
|
|
395
|
-
private readonly toast: Toast,
|
|
396
|
-
private readonly intl: I18n
|
|
397
|
-
) {}
|
|
398
|
-
|
|
399
|
-
/**
|
|
400
|
-
* Effect results are converted to Exit, so errors are ignored by default.
|
|
401
|
-
* you should use the result ref to render errors!
|
|
402
|
-
* @deprecated use `Command.fn` and friends instead
|
|
403
|
-
*/
|
|
404
|
-
readonly useSafeMutation: {
|
|
405
|
-
/**
|
|
406
|
-
* Effect results are converted to Exit, so errors are ignored by default.
|
|
407
|
-
* you should use the result ref to render errors!
|
|
408
|
-
* @deprecated use `Command.fn` and friends instead
|
|
409
|
-
*/
|
|
410
|
-
<I, E, A, R, Request extends Req, Name extends string, A2 = A, E2 = E, R2 = R>(
|
|
411
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>,
|
|
412
|
-
options?: MutationOptions<A, E, R, A2, E2, R2, I>
|
|
413
|
-
): readonly [
|
|
414
|
-
ComputedRef<AsyncResult.AsyncResult<A2, E2>>,
|
|
415
|
-
(i: I) => Effect.Effect<Exit.Exit<A2, E2>, never, R2>
|
|
416
|
-
]
|
|
417
|
-
/**
|
|
418
|
-
* Effect results are converted to Exit, so errors are ignored by default.
|
|
419
|
-
* you should use the result ref to render errors!
|
|
420
|
-
* @deprecated use `Command.fn` and friends instead
|
|
421
|
-
*/
|
|
422
|
-
<E, A, R, Request extends Req, Name extends string, A2 = A, E2 = E, R2 = R>(
|
|
423
|
-
self: RequestHandler<A, E, R, Request, Name>,
|
|
424
|
-
options?: MutationOptions<A, E, R, A2, E2, R2>
|
|
425
|
-
): readonly [
|
|
426
|
-
ComputedRef<AsyncResult.AsyncResult<A2, E2>>,
|
|
427
|
-
Effect.Effect<Exit.Exit<A2, E2>, never, R2>
|
|
428
|
-
]
|
|
429
|
-
} = <I, E, A, R, Request extends Req, Name extends string, A2 = A, E2 = E, R2 = R>(
|
|
430
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name> | RequestHandler<A, E, R, Request, Name>,
|
|
431
|
-
options?: MutationOptions<A, E, R, A2, E2, R2, I>
|
|
432
|
-
) => {
|
|
433
|
-
const unsafe = _useMutation(self as any, options)
|
|
434
|
-
|
|
435
|
-
type MH = NonNullable<NonNullable<typeof options>["mapHandler"]>
|
|
436
|
-
const mh = options?.mapHandler ?? identity as MH
|
|
437
|
-
|
|
438
|
-
const [a, b] = asResult(
|
|
439
|
-
mapHandler(
|
|
440
|
-
mapHandler(unsafe as any, mh),
|
|
441
|
-
Effect.tapCauseIf(Cause.hasDies, (cause) => reportRuntimeError(cause))
|
|
442
|
-
) as any
|
|
443
|
-
)
|
|
444
|
-
return [
|
|
445
|
-
a,
|
|
446
|
-
mapHandler(
|
|
447
|
-
b,
|
|
448
|
-
Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })
|
|
449
|
-
)
|
|
450
|
-
] as const as any
|
|
451
|
-
}
|
|
452
|
-
|
|
453
|
-
/** handles errors as toasts and reports defects
|
|
454
|
-
* @deprecated use `Command.fn` and friends instead
|
|
455
|
-
*/
|
|
456
|
-
readonly useHandleRequestWithToast = () => {
|
|
457
|
-
// eslint-disable-next-line @typescript-eslint/no-this-alias
|
|
458
|
-
const self = this
|
|
459
|
-
return handleRequestWithToast
|
|
460
|
-
/**
|
|
461
|
-
* Pass a function that returns a Promise.
|
|
462
|
-
* Returns an execution function which reports errors as Toast.
|
|
463
|
-
*/
|
|
464
|
-
function handleRequestWithToast<
|
|
465
|
-
A,
|
|
466
|
-
E extends ResponseErrors,
|
|
467
|
-
R,
|
|
468
|
-
I = void,
|
|
469
|
-
A2 = A,
|
|
470
|
-
E2 extends ResponseErrors = E,
|
|
471
|
-
R2 = R,
|
|
472
|
-
ESuccess = never,
|
|
473
|
-
RSuccess = never,
|
|
474
|
-
EError = never,
|
|
475
|
-
RError = never,
|
|
476
|
-
EDefect = never,
|
|
477
|
-
RDefect = never
|
|
478
|
-
>(
|
|
479
|
-
f: Effect.Effect<Exit.Exit<A2, E2>, never, R2> | ((i: I) => Effect.Effect<Exit.Exit<A2, E2>, never, R2>),
|
|
480
|
-
id: string,
|
|
481
|
-
action: string,
|
|
482
|
-
options: Opts<A, E, R, I, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect> = {}
|
|
483
|
-
) {
|
|
484
|
-
const actionMessage = self.intl.formatMessage({ id: `action.${action}`, defaultMessage: action })
|
|
485
|
-
const defaultWarnMessage = self.intl.formatMessage(
|
|
486
|
-
{ id: "handle.with_warnings" },
|
|
487
|
-
{ action: actionMessage }
|
|
488
|
-
)
|
|
489
|
-
const defaultSuccessMessage = self.intl.formatMessage(
|
|
490
|
-
{ id: "handle.success" },
|
|
491
|
-
{ action: actionMessage }
|
|
492
|
-
)
|
|
493
|
-
const defaultErrorMessage = self.intl.formatMessage(
|
|
494
|
-
{ id: "handle.with_errors" },
|
|
495
|
-
{ action: actionMessage }
|
|
496
|
-
)
|
|
497
|
-
|
|
498
|
-
return handleRequest<E2, A2, R2, any, ESuccess, RSuccess, EError, RError, EDefect, RDefect>(f, id, action, {
|
|
499
|
-
onSuccess: Effect.fnUntraced(function*(a, i) {
|
|
500
|
-
const message = options.successMessage ? yield* options.successMessage(a, i) : defaultSuccessMessage
|
|
501
|
-
+ (S.is(OperationSuccess)(a) && a.message
|
|
502
|
-
? "\n" + a.message
|
|
503
|
-
: "")
|
|
504
|
-
if (message) {
|
|
505
|
-
yield* self.toast.success(message)
|
|
506
|
-
}
|
|
507
|
-
}),
|
|
508
|
-
onFail: Effect.fnUntraced(function*(e, i) {
|
|
509
|
-
if (!options.failMessage && e._tag === "OperationFailure") {
|
|
510
|
-
yield* self.toast.warning(
|
|
511
|
-
defaultWarnMessage + e.message
|
|
512
|
-
? "\n" + e.message
|
|
513
|
-
: ""
|
|
514
|
-
)
|
|
515
|
-
return
|
|
516
|
-
}
|
|
517
|
-
|
|
518
|
-
const message = options.failMessage
|
|
519
|
-
? yield* options.failMessage(e, i)
|
|
520
|
-
: `${defaultErrorMessage}:\n` + renderError(e)
|
|
521
|
-
if (message) {
|
|
522
|
-
yield* self.toast.error(message)
|
|
523
|
-
}
|
|
524
|
-
}),
|
|
525
|
-
onDefect: Effect.fnUntraced(function*(cause, i) {
|
|
526
|
-
const message = options.defectMessage
|
|
527
|
-
? yield* options.defectMessage(cause, i)
|
|
528
|
-
: self.intl.formatMessage(
|
|
529
|
-
{ id: "handle.unexpected_error" },
|
|
530
|
-
{
|
|
531
|
-
action: actionMessage,
|
|
532
|
-
error: Cause.pretty(cause)
|
|
533
|
-
}
|
|
534
|
-
)
|
|
535
|
-
if (message) {
|
|
536
|
-
yield* self.toast.error(message)
|
|
537
|
-
}
|
|
538
|
-
})
|
|
539
|
-
})
|
|
540
|
-
}
|
|
541
|
-
|
|
542
|
-
function renderError(e: ResponseErrors): string {
|
|
543
|
-
return Match.value(e as any).pipe(
|
|
544
|
-
Match.tags({
|
|
545
|
-
// HttpErrorRequest: e =>
|
|
546
|
-
// this.intl.value.formatMessage(
|
|
547
|
-
// { id: "handle.request_error" },
|
|
548
|
-
// { error: `${e.error}` },
|
|
549
|
-
// ),
|
|
550
|
-
// HttpErrorResponse: e =>
|
|
551
|
-
// e.response.status >= 500 ||
|
|
552
|
-
// e.response.body._tag !== "Some" ||
|
|
553
|
-
// !e.response.body.value
|
|
554
|
-
// ? this.intl.value.formatMessage(
|
|
555
|
-
// { id: "handle.error_response" },
|
|
556
|
-
// {
|
|
557
|
-
// error: `${
|
|
558
|
-
// e.response.body._tag === "Some" && e.response.body.value
|
|
559
|
-
// ? parseError(e.response.body.value)
|
|
560
|
-
// : "Unknown"
|
|
561
|
-
// } (${e.response.status})`,
|
|
562
|
-
// },
|
|
563
|
-
// )
|
|
564
|
-
// : this.intl.value.formatMessage(
|
|
565
|
-
// { id: "handle.unexpected_error" },
|
|
566
|
-
// {
|
|
567
|
-
// error:
|
|
568
|
-
// JSON.stringify(e.response.body, undefined, 2) +
|
|
569
|
-
// "( " +
|
|
570
|
-
// e.response.status +
|
|
571
|
-
// ")",
|
|
572
|
-
// },
|
|
573
|
-
// ),
|
|
574
|
-
// ResponseError: e =>
|
|
575
|
-
// this.intl.value.formatMessage(
|
|
576
|
-
// { id: "handle.response_error" },
|
|
577
|
-
// { error: `${e.error}` },
|
|
578
|
-
// ),
|
|
579
|
-
SchemaError: (e: any) => {
|
|
580
|
-
console.warn(e.toString())
|
|
581
|
-
return self.intl.formatMessage({ id: "validation.failed" })
|
|
582
|
-
}
|
|
583
|
-
}),
|
|
584
|
-
Match.orElse((e: any) => `${e.message ?? e._tag ?? e}`)
|
|
585
|
-
)
|
|
586
|
-
}
|
|
587
|
-
}
|
|
421
|
+
export type ClientFrom<M extends RequestsAny> = RequestHandlers<never, never, M, ExtractModuleName<M>>
|
|
588
422
|
|
|
423
|
+
export interface MakeClientOptions {
|
|
589
424
|
/**
|
|
590
|
-
*
|
|
591
|
-
*
|
|
592
|
-
* @deprecated use `Command.fn` and friends instead
|
|
425
|
+
* Selects the engine behind legacy `.query()` / `.suspense()` helpers.
|
|
426
|
+
* Atom-native `.atom()` / `.family()` / `.queryNew()` / `.suspenseNew()` always use Atom.
|
|
593
427
|
*/
|
|
594
|
-
readonly
|
|
595
|
-
|
|
596
|
-
* Pass a function that returns an Effect, e.g from a client action, give it a name.
|
|
597
|
-
* Returns a tuple with raw Result and execution function which reports success and errors as Toast.
|
|
598
|
-
* @deprecated use `Command.fn` and friends instead
|
|
599
|
-
*/
|
|
600
|
-
<
|
|
601
|
-
I,
|
|
602
|
-
E extends ResponseErrors,
|
|
603
|
-
A,
|
|
604
|
-
R,
|
|
605
|
-
Request extends Req,
|
|
606
|
-
Name extends string,
|
|
607
|
-
A2 = A,
|
|
608
|
-
E2 extends ResponseErrors = E,
|
|
609
|
-
R2 = R,
|
|
610
|
-
ESuccess = never,
|
|
611
|
-
RSuccess = never,
|
|
612
|
-
EError = never,
|
|
613
|
-
RError = never,
|
|
614
|
-
EDefect = never,
|
|
615
|
-
RDefect = never
|
|
616
|
-
>(
|
|
617
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>,
|
|
618
|
-
action: string,
|
|
619
|
-
options?: Opts<A, E, R, I, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
620
|
-
): Resp<I, A2, E2, R2, ComputedRef<AsyncResult.AsyncResult<A2, E2>>>
|
|
621
|
-
/**
|
|
622
|
-
* Pass a function that returns an Effect, e.g from a client action, give it a name.
|
|
623
|
-
* Returns a tuple with raw Result and execution function which reports success and errors as Toast.
|
|
624
|
-
* @deprecated use `Command.fn` and friends instead
|
|
625
|
-
*/
|
|
626
|
-
<
|
|
627
|
-
E extends ResponseErrors,
|
|
628
|
-
A,
|
|
629
|
-
R,
|
|
630
|
-
Request extends Req,
|
|
631
|
-
Name extends string,
|
|
632
|
-
A2 = A,
|
|
633
|
-
E2 extends ResponseErrors = E,
|
|
634
|
-
R2 = R,
|
|
635
|
-
ESuccess = never,
|
|
636
|
-
RSuccess = never,
|
|
637
|
-
EError = never,
|
|
638
|
-
RError = never,
|
|
639
|
-
EDefect = never,
|
|
640
|
-
RDefect = never
|
|
641
|
-
>(
|
|
642
|
-
self: RequestHandler<A, E, R, Request, Name>,
|
|
643
|
-
action: string,
|
|
644
|
-
options?: Opts<A, E, R, void, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
645
|
-
): ActResp<A2, E2, R2, ComputedRef<AsyncResult.AsyncResult<A2, E2>>>
|
|
646
|
-
} = <E extends ResponseErrors, A, R, Request extends Req, Name extends string, I>(
|
|
647
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name> | RequestHandler<A, E, R, Request, Name>,
|
|
648
|
-
action: any,
|
|
649
|
-
options?: Opts<any, any, any, any, any, any, any, any, any, any, any, any, any>
|
|
650
|
-
): any => {
|
|
651
|
-
const handleRequestWithToast = this.useHandleRequestWithToast()
|
|
652
|
-
const handler = self.handler
|
|
653
|
-
const unsafe = _useMutation({
|
|
654
|
-
...self,
|
|
655
|
-
handler: Effect.isEffect(handler)
|
|
656
|
-
? (pipe(
|
|
657
|
-
Effect.annotateCurrentSpan({ action }),
|
|
658
|
-
Effect.andThen(handler)
|
|
659
|
-
) as any)
|
|
660
|
-
: (...args: [any]) =>
|
|
661
|
-
pipe(
|
|
662
|
-
Effect.annotateCurrentSpan({ action }),
|
|
663
|
-
Effect.andThen(handler(...args))
|
|
664
|
-
)
|
|
665
|
-
}, options ? dropUndefinedT(options) : undefined)
|
|
666
|
-
|
|
667
|
-
type MH = NonNullable<NonNullable<typeof options>["mapHandler"]>
|
|
668
|
-
const mh = options?.mapHandler ?? identity as MH
|
|
669
|
-
|
|
670
|
-
// Effect.tapDefect(reportRuntimeError) handled in toast handler,
|
|
671
|
-
const [a, b] = asResult(mapHandler(unsafe, mh) as any)
|
|
428
|
+
readonly legacyQueryEngine?: "atom" | "tanstack"
|
|
429
|
+
}
|
|
672
430
|
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
handleRequestWithToast(b as any, self.id, action, options)
|
|
676
|
-
)
|
|
677
|
-
}
|
|
678
|
-
//
|
|
431
|
+
export class QueryImpl<R> {
|
|
432
|
+
readonly getRuntime: () => Context.Context<R>
|
|
679
433
|
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
I,
|
|
695
|
-
E extends ResponseErrors,
|
|
696
|
-
A,
|
|
697
|
-
R,
|
|
698
|
-
Request extends Req,
|
|
699
|
-
Name extends string,
|
|
700
|
-
A2 = A,
|
|
701
|
-
E2 extends ResponseErrors = E,
|
|
702
|
-
R2 = R,
|
|
703
|
-
ESuccess = never,
|
|
704
|
-
RSuccess = never,
|
|
705
|
-
EError = never,
|
|
706
|
-
RError = never,
|
|
707
|
-
EDefect = never,
|
|
708
|
-
RDefect = never
|
|
709
|
-
>(
|
|
710
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>,
|
|
711
|
-
action: string,
|
|
712
|
-
options?: Opts<A, E, R, I, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
713
|
-
): Resp<I, A2, E2, R2>
|
|
714
|
-
/**
|
|
715
|
-
* Pass a function that returns an Effect, e.g from a client action, give it a name.
|
|
716
|
-
* Returns a tuple with state ref and execution function which reports success and errors as Toast.
|
|
717
|
-
*
|
|
718
|
-
* @deprecated use `Command.fn` and friends instead
|
|
719
|
-
*/
|
|
720
|
-
<
|
|
721
|
-
E extends ResponseErrors,
|
|
722
|
-
A,
|
|
723
|
-
R,
|
|
724
|
-
Request extends Req,
|
|
725
|
-
Name extends string,
|
|
726
|
-
A2 = A,
|
|
727
|
-
E2 extends ResponseErrors = E,
|
|
728
|
-
R2 = R,
|
|
729
|
-
ESuccess = never,
|
|
730
|
-
RSuccess = never,
|
|
731
|
-
EError = never,
|
|
732
|
-
RError = never,
|
|
733
|
-
EDefect = never,
|
|
734
|
-
RDefect = never
|
|
735
|
-
>(
|
|
736
|
-
self: RequestHandler<A, E, R, Request, Name>,
|
|
737
|
-
action: string,
|
|
738
|
-
options?: Opts<A, E, R, void, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
739
|
-
): ActResp<A2, E2, R2>
|
|
740
|
-
} = (
|
|
741
|
-
self: any,
|
|
742
|
-
action: any,
|
|
743
|
-
options?: Opts<any, any, any, any, any, any, any, any, any, any, any, any, any>
|
|
744
|
-
): any => {
|
|
745
|
-
const [a, b] = this.useAndHandleMutationResult(self, action, options)
|
|
746
|
-
|
|
747
|
-
return tuple(
|
|
748
|
-
computed(() => mutationResultToVue(a.value)),
|
|
749
|
-
b
|
|
750
|
-
)
|
|
434
|
+
constructor(
|
|
435
|
+
getRuntime: () => Context.Context<R>,
|
|
436
|
+
getAtomRt: () => AtomClientRuntime,
|
|
437
|
+
legacyUseQuery?: ReturnType<typeof makeQuery<R>>
|
|
438
|
+
) {
|
|
439
|
+
this.getRuntime = getRuntime
|
|
440
|
+
this.useQuery = legacyUseQuery ?? makeQuery(this.getRuntime, getAtomRt)
|
|
441
|
+
this.useQueryNew = makeQueryNew(this.getRuntime, getAtomRt)
|
|
442
|
+
this.useQueryAtom = makeQueryAtom(this.getRuntime, getAtomRt)
|
|
443
|
+
this.useQueryFamily = makeQueryFamily(this.getRuntime, getAtomRt)
|
|
444
|
+
this.useStreamQuery = makeStreamQuery(this.getRuntime, getAtomRt)
|
|
445
|
+
this.useStreamQueryFamily = makeStreamQueryFamily(this.getRuntime, getAtomRt)
|
|
446
|
+
this.useStreamQueryAtom = makeStreamQueryAtom(this.getRuntime, getAtomRt)
|
|
447
|
+
this.useStreamQueryNew = makeStreamQueryNew(this.getRuntime, getAtomRt)
|
|
751
448
|
}
|
|
752
|
-
|
|
753
|
-
/** @deprecated use `Command.fn` and friends instead */
|
|
754
|
-
readonly makeUseAndHandleMutation = (
|
|
755
|
-
defaultOptions?: Opts<any, any, any, any, any, any, any, any, any>
|
|
756
|
-
) =>
|
|
757
|
-
((self: any, action: any, options: any) => {
|
|
758
|
-
return this.useAndHandleMutation(
|
|
759
|
-
self,
|
|
760
|
-
action,
|
|
761
|
-
{ ...defaultOptions, ...options }
|
|
762
|
-
)
|
|
763
|
-
}) as unknown as {
|
|
764
|
-
<
|
|
765
|
-
I,
|
|
766
|
-
E extends ResponseErrors,
|
|
767
|
-
A,
|
|
768
|
-
R,
|
|
769
|
-
Request extends Req,
|
|
770
|
-
Name extends string,
|
|
771
|
-
A2 = A,
|
|
772
|
-
E2 extends ResponseErrors = E,
|
|
773
|
-
R2 = R,
|
|
774
|
-
ESuccess = never,
|
|
775
|
-
RSuccess = never,
|
|
776
|
-
EError = never,
|
|
777
|
-
RError = never,
|
|
778
|
-
EDefect = never,
|
|
779
|
-
RDefect = never
|
|
780
|
-
>(
|
|
781
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>,
|
|
782
|
-
action: string,
|
|
783
|
-
options?: Opts<A, E, R, I, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
784
|
-
): Resp<I, A2, E2, R2>
|
|
785
|
-
<
|
|
786
|
-
E extends ResponseErrors,
|
|
787
|
-
A,
|
|
788
|
-
R,
|
|
789
|
-
Request extends Req,
|
|
790
|
-
Name extends string,
|
|
791
|
-
A2 = A,
|
|
792
|
-
E2 extends ResponseErrors = E,
|
|
793
|
-
R2 = R,
|
|
794
|
-
ESuccess = never,
|
|
795
|
-
RSuccess = never,
|
|
796
|
-
EError = never,
|
|
797
|
-
RError = never,
|
|
798
|
-
EDefect = never,
|
|
799
|
-
RDefect = never
|
|
800
|
-
>(
|
|
801
|
-
self: RequestHandler<A, E, R, Request, Name>,
|
|
802
|
-
action: string,
|
|
803
|
-
options?: Opts<A, E, R, void, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
804
|
-
): ActResp<A2, E2, R2>
|
|
805
|
-
}
|
|
806
|
-
|
|
807
449
|
/**
|
|
808
|
-
*
|
|
809
|
-
*
|
|
810
|
-
* @deprecated use `Command.fn` and friends instead
|
|
811
|
-
*/
|
|
812
|
-
readonly useAndHandleMutationSilently: {
|
|
813
|
-
/**
|
|
814
|
-
* The same as @see useAndHandleMutation, but does not display any toasts by default.
|
|
815
|
-
* Messages for success, error and defect toasts can be provided in the Options.
|
|
816
|
-
* @deprecated use `Command.fn` and friends instead
|
|
817
|
-
*/
|
|
818
|
-
<
|
|
819
|
-
I,
|
|
820
|
-
E extends ResponseErrors,
|
|
821
|
-
A,
|
|
822
|
-
R,
|
|
823
|
-
Request extends Req,
|
|
824
|
-
Name extends string,
|
|
825
|
-
A2 = A,
|
|
826
|
-
E2 extends ResponseErrors = E,
|
|
827
|
-
R2 = R,
|
|
828
|
-
ESuccess = never,
|
|
829
|
-
RSuccess = never,
|
|
830
|
-
EError = never,
|
|
831
|
-
RError = never,
|
|
832
|
-
EDefect = never,
|
|
833
|
-
RDefect = never
|
|
834
|
-
>(
|
|
835
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>,
|
|
836
|
-
action: string,
|
|
837
|
-
options?: Opts<A, E, R, I, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
838
|
-
): Resp<I, A2, E2, R>
|
|
839
|
-
/**
|
|
840
|
-
* The same as @see useAndHandleMutation, but does not display any toasts by default.
|
|
841
|
-
* Messages for success, error and defect toasts can be provided in the Options.
|
|
842
|
-
* @deprecated use `Command.fn` and friends instead
|
|
843
|
-
*/
|
|
844
|
-
<
|
|
845
|
-
E extends ResponseErrors,
|
|
846
|
-
A,
|
|
847
|
-
R,
|
|
848
|
-
Request extends Req,
|
|
849
|
-
Name extends string,
|
|
850
|
-
A2 = A,
|
|
851
|
-
E2 extends ResponseErrors = E,
|
|
852
|
-
R2 = R,
|
|
853
|
-
ESuccess = never,
|
|
854
|
-
RSuccess = never,
|
|
855
|
-
EError = never,
|
|
856
|
-
RError = never,
|
|
857
|
-
EDefect = never,
|
|
858
|
-
RDefect = never
|
|
859
|
-
>(
|
|
860
|
-
self: RequestHandler<A, E, R, Request, Name>,
|
|
861
|
-
action: string,
|
|
862
|
-
options?: Opts<A, E, R, void, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
863
|
-
): ActResp<void, never, R>
|
|
864
|
-
} = this.makeUseAndHandleMutation({
|
|
865
|
-
successMessage: suppressToast,
|
|
866
|
-
failMessage: suppressToast,
|
|
867
|
-
defectMessage: suppressToast
|
|
868
|
-
}) as any
|
|
869
|
-
|
|
870
|
-
/**
|
|
871
|
-
* The same as @see useAndHandleMutation, but does not act on success, error or defect by default.
|
|
872
|
-
* Actions for success, error and defect can be provided in the Options.
|
|
873
|
-
* @deprecated use `Command.fn` and friends instead
|
|
450
|
+
* Effect results are passed to the caller, including errors.
|
|
451
|
+
* @deprecated use client helpers instead (.query())
|
|
874
452
|
*/
|
|
875
|
-
readonly
|
|
876
|
-
/**
|
|
877
|
-
* The same as @see useAndHandleMutation, but does not act on success, error or defect by default.
|
|
878
|
-
* Actions for success, error and defect can be provided in the Options.
|
|
879
|
-
* @deprecated use `Command.fn` and friends instead
|
|
880
|
-
*/
|
|
881
|
-
<
|
|
882
|
-
I,
|
|
883
|
-
E extends ResponseErrors,
|
|
884
|
-
A,
|
|
885
|
-
R,
|
|
886
|
-
Request extends Req,
|
|
887
|
-
Name extends string,
|
|
888
|
-
A2 = A,
|
|
889
|
-
E2 extends ResponseErrors = E,
|
|
890
|
-
R2 = R,
|
|
891
|
-
ESuccess = never,
|
|
892
|
-
RSuccess = never,
|
|
893
|
-
EError = never,
|
|
894
|
-
RError = never,
|
|
895
|
-
EDefect = never,
|
|
896
|
-
RDefect = never
|
|
897
|
-
>(
|
|
898
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>,
|
|
899
|
-
action: string,
|
|
900
|
-
options?: LowOptsOptional<A, E, R, I, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
901
|
-
): Resp<I, A2, E2, R2>
|
|
902
|
-
/**
|
|
903
|
-
* The same as @see useAndHandleMutation, but does not act on success, error or defect by default.
|
|
904
|
-
* Actions for success, error and defect can be provided in the Options.
|
|
905
|
-
* @deprecated use `Command.fn` and friends instead
|
|
906
|
-
*/
|
|
907
|
-
<
|
|
908
|
-
E extends ResponseErrors,
|
|
909
|
-
A,
|
|
910
|
-
R,
|
|
911
|
-
Request extends Req,
|
|
912
|
-
Name extends string,
|
|
913
|
-
A2 = A,
|
|
914
|
-
E2 extends ResponseErrors = E,
|
|
915
|
-
R2 = R,
|
|
916
|
-
ESuccess = never,
|
|
917
|
-
RSuccess = never,
|
|
918
|
-
EError = never,
|
|
919
|
-
RError = never,
|
|
920
|
-
EDefect = never,
|
|
921
|
-
RDefect = never
|
|
922
|
-
>(
|
|
923
|
-
self: RequestHandler<A, E, R, Request, Name>,
|
|
924
|
-
action: string,
|
|
925
|
-
options?: LowOptsOptional<A, E, R, void, A2, E2, R2, ESuccess, RSuccess, EError, RError, EDefect, RDefect>
|
|
926
|
-
): ActResp<A2, E2, R2>
|
|
927
|
-
} = (self: any, action: string, options: any) => {
|
|
928
|
-
const unsafe = _useMutation({
|
|
929
|
-
...self,
|
|
930
|
-
handler: Effect.isEffect(self.handler)
|
|
931
|
-
? (pipe(
|
|
932
|
-
Effect.annotateCurrentSpan({ action }),
|
|
933
|
-
Effect.andThen(self.handler)
|
|
934
|
-
) as any)
|
|
935
|
-
: (...args: any[]) =>
|
|
936
|
-
pipe(
|
|
937
|
-
Effect.annotateCurrentSpan({ action }),
|
|
938
|
-
Effect.andThen(self.handler(...args))
|
|
939
|
-
)
|
|
940
|
-
}, options ? dropUndefinedT(options) : undefined)
|
|
453
|
+
readonly useQuery: ReturnType<typeof makeQuery<R>>
|
|
941
454
|
|
|
942
|
-
|
|
943
|
-
const mh = options?.mapHandler ?? identity as MH
|
|
455
|
+
readonly useQueryNew: ReturnType<typeof makeQueryNew<R>>
|
|
944
456
|
|
|
945
|
-
|
|
946
|
-
mapHandler(
|
|
947
|
-
mapHandler(unsafe as any, mh),
|
|
948
|
-
Effect.tapCauseIf(Cause.hasDies, (cause) => reportRuntimeError(cause))
|
|
949
|
-
) as any
|
|
950
|
-
)
|
|
457
|
+
readonly useQueryAtom: ReturnType<typeof makeQueryAtom<R>>
|
|
951
458
|
|
|
952
|
-
|
|
953
|
-
computed(() => mutationResultToVue(a.value)),
|
|
954
|
-
handleRequest(b as any, self.id, action, {
|
|
955
|
-
onSuccess: suppressToast,
|
|
956
|
-
onDefect: suppressToast,
|
|
957
|
-
onFail: suppressToast,
|
|
958
|
-
...options
|
|
959
|
-
})
|
|
960
|
-
) as any
|
|
961
|
-
}
|
|
459
|
+
readonly useQueryFamily: ReturnType<typeof makeQueryFamily<R>>
|
|
962
460
|
|
|
963
461
|
/**
|
|
964
|
-
*
|
|
965
|
-
*
|
|
966
|
-
* @deprecated use `Command.fn` and friends instead
|
|
462
|
+
* Stream results are accumulated as an array of chunks and returned as reactive state.
|
|
463
|
+
* @deprecated use client helpers instead (.query())
|
|
967
464
|
*/
|
|
968
|
-
readonly
|
|
969
|
-
/**
|
|
970
|
-
* Effect results are converted to Exit, so errors are ignored by default.
|
|
971
|
-
* you should use the result ref to render errors!
|
|
972
|
-
* @deprecated use `Command.fn` and friends instead
|
|
973
|
-
*/
|
|
974
|
-
<I, E, A, R, Request extends Req, Name extends string, A2 = A, E2 = E, R2 = R>(
|
|
975
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>,
|
|
976
|
-
options?: MutationOptions<A, E, R, A2, E2, R2, I>
|
|
977
|
-
): readonly [
|
|
978
|
-
ComputedRef<Res<A, E>>,
|
|
979
|
-
(i: I) => Effect.Effect<Exit.Exit<A2, E2>, never, R2>
|
|
980
|
-
]
|
|
981
|
-
/**
|
|
982
|
-
* Effect results are converted to Exit, so errors are ignored by default.
|
|
983
|
-
* you should use the result ref to render errors!
|
|
984
|
-
* @deprecated use `Command.fn` and friends instead
|
|
985
|
-
*/
|
|
986
|
-
<E, A, R, Request extends Req, Name extends string, A2 = A, E2 = E, R2 = R>(
|
|
987
|
-
self: RequestHandler<A, E, R, Request, Name>,
|
|
988
|
-
options?: MutationOptions<A, E, R, A2, E2, R2>
|
|
989
|
-
): readonly [
|
|
990
|
-
ComputedRef<Res<A, E>>,
|
|
991
|
-
Effect.Effect<Exit.Exit<A2, E2>, never, R2>
|
|
992
|
-
]
|
|
993
|
-
} = <I, E, A, R, Request extends Req, Name extends string, A2 = A, E2 = E, R2 = R>(
|
|
994
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name> | RequestHandler<A, E, R, Request, Name>,
|
|
995
|
-
options?: MutationOptions<A, E, R, A2, E2, R2, I>
|
|
996
|
-
) => {
|
|
997
|
-
const [a, b] = this.useSafeMutation(self as any, options)
|
|
465
|
+
readonly useStreamQuery: ReturnType<typeof makeStreamQuery<R>>
|
|
998
466
|
|
|
999
|
-
|
|
1000
|
-
computed(() => mutationResultToVue(a.value)),
|
|
1001
|
-
b
|
|
1002
|
-
) as any
|
|
1003
|
-
}
|
|
467
|
+
readonly useStreamQueryFamily: ReturnType<typeof makeStreamQueryFamily<R>>
|
|
1004
468
|
|
|
1005
|
-
|
|
1006
|
-
readonly buildFormFromSchema = <
|
|
1007
|
-
From extends Record<PropertyKey, any>,
|
|
1008
|
-
To extends Record<PropertyKey, any>,
|
|
1009
|
-
C extends Record<PropertyKey, any>,
|
|
1010
|
-
OnSubmitA
|
|
1011
|
-
>(
|
|
1012
|
-
s:
|
|
1013
|
-
& S.Codec<To>
|
|
1014
|
-
& { new(c: C): any; extend: any; fields: S.Struct.Fields },
|
|
1015
|
-
state: Ref<Omit<From, "_tag">>,
|
|
1016
|
-
onSubmit: (a: To) => Effect.Effect<OnSubmitA, never, RT>
|
|
1017
|
-
) => {
|
|
1018
|
-
const fields = buildFieldInfoFromFieldsRoot(s).fields
|
|
1019
|
-
const schema = S.Struct(Struct.omit(s.fields, ["_tag"])) as unknown as S.Codec<any> & {
|
|
1020
|
-
readonly DecodingServices: never
|
|
1021
|
-
}
|
|
1022
|
-
const parse = S.decodeUnknownSync(schema)
|
|
1023
|
-
const isDirty = ref(false)
|
|
1024
|
-
const isValid = ref(true)
|
|
1025
|
-
const isLoading = ref(false)
|
|
1026
|
-
const runPromise = Effect.runPromiseWith(this.getRuntime())
|
|
1027
|
-
|
|
1028
|
-
const submit1 =
|
|
1029
|
-
(onSubmit: (a: To) => Effect.Effect<OnSubmitA, never, never>) =>
|
|
1030
|
-
async <T extends Promise<{ valid: boolean }>>(e: T) => {
|
|
1031
|
-
isLoading.value = true
|
|
1032
|
-
try {
|
|
1033
|
-
const r = await e
|
|
1034
|
-
if (!r.valid) return
|
|
1035
|
-
return await runPromise(onSubmit(new (s as any)(await runPromise(parse(state.value)))) as any)
|
|
1036
|
-
} finally {
|
|
1037
|
-
isLoading.value = false
|
|
1038
|
-
}
|
|
1039
|
-
}
|
|
1040
|
-
const submit = submit1(onSubmit as any)
|
|
1041
|
-
|
|
1042
|
-
watch(
|
|
1043
|
-
state,
|
|
1044
|
-
(v) => {
|
|
1045
|
-
// TODO: do better
|
|
1046
|
-
isDirty.value = JSON.stringify(v) !== JSON.stringify(state.value)
|
|
1047
|
-
},
|
|
1048
|
-
{ deep: true }
|
|
1049
|
-
)
|
|
1050
|
-
|
|
1051
|
-
const submitFromState = Effect.gen(function*() {
|
|
1052
|
-
return yield* (onSubmit(yield* parse(state.value)) as any)
|
|
1053
|
-
})
|
|
1054
|
-
|
|
1055
|
-
const submitFromStatePromise = () => runPromise(submitFromState as any)
|
|
1056
|
-
|
|
1057
|
-
return {
|
|
1058
|
-
fields,
|
|
1059
|
-
/** optimized for Vuetify v-form submit callback */
|
|
1060
|
-
submit,
|
|
1061
|
-
/** optimized for Native form submit callback or general use */
|
|
1062
|
-
submitFromState,
|
|
1063
|
-
submitFromStatePromise,
|
|
1064
|
-
isDirty,
|
|
1065
|
-
isValid,
|
|
1066
|
-
isLoading
|
|
1067
|
-
}
|
|
1068
|
-
}
|
|
1069
|
-
}
|
|
1070
|
-
|
|
1071
|
-
// @effect-diagnostics-next-line missingEffectServiceDependency:off
|
|
1072
|
-
export class LegacyMutation extends ServiceMap.Service<LegacyMutation>()("LegacyMutation", {
|
|
1073
|
-
make: Effect.gen(function*() {
|
|
1074
|
-
const intl = yield* I18n
|
|
1075
|
-
const toast = yield* Toast
|
|
469
|
+
readonly useStreamQueryAtom: ReturnType<typeof makeStreamQueryAtom<R>>
|
|
1076
470
|
|
|
1077
|
-
|
|
1078
|
-
})
|
|
1079
|
-
}) {
|
|
1080
|
-
static readonly DefaultWithoutDependencies = Layer.effect(this, this.make)
|
|
1081
|
-
static readonly Default = this.DefaultWithoutDependencies
|
|
1082
|
-
}
|
|
1083
|
-
|
|
1084
|
-
export type ClientFrom<M extends Requests> = RequestHandlers<never, never, M, M["meta"]["moduleName"]>
|
|
1085
|
-
|
|
1086
|
-
export class QueryImpl<R> {
|
|
1087
|
-
constructor(readonly getRuntime: () => ServiceMap.ServiceMap<R>) {
|
|
1088
|
-
this.useQuery = makeQuery(this.getRuntime)
|
|
1089
|
-
}
|
|
1090
|
-
/**
|
|
1091
|
-
* Effect results are passed to the caller, including errors.
|
|
1092
|
-
* @deprecated use client helpers instead (.query())
|
|
1093
|
-
*/
|
|
1094
|
-
readonly useQuery: ReturnType<typeof makeQuery<R>>
|
|
471
|
+
readonly useStreamQueryNew: ReturnType<typeof makeStreamQueryNew<R>>
|
|
1095
472
|
|
|
1096
473
|
/**
|
|
1097
474
|
* The difference with useQuery is that this function will return a Promise you can await in the Setup,
|
|
@@ -1104,22 +481,21 @@ export class QueryImpl<R> {
|
|
|
1104
481
|
* The difference with useQuery is that this function will return a Promise you can await in the Setup,
|
|
1105
482
|
* which ensures that either there always is a latest value, or an error occurs on load.
|
|
1106
483
|
* So that Suspense and error boundaries can be used.
|
|
1107
|
-
*
|
|
484
|
+
* When `I = void` the input argument may be omitted.
|
|
1108
485
|
*/
|
|
1109
486
|
<
|
|
487
|
+
I,
|
|
1110
488
|
E,
|
|
1111
489
|
A,
|
|
1112
490
|
Request extends Req,
|
|
1113
491
|
Name extends string
|
|
1114
492
|
>(
|
|
1115
|
-
self:
|
|
493
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
1116
494
|
): {
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
*/
|
|
1122
|
-
<TData = A>(options?: CustomUndefinedInitialQueryOptions<A, E, TData>): Promise<
|
|
495
|
+
<TData = A>(
|
|
496
|
+
arg: I | WatchSource<I>,
|
|
497
|
+
options?: CustomUndefinedInitialQueryOptions<A, CauseException<E>, TData>
|
|
498
|
+
): Promise<
|
|
1123
499
|
readonly [
|
|
1124
500
|
ComputedRef<AsyncResult.AsyncResult<TData, E>>,
|
|
1125
501
|
ComputedRef<TData>,
|
|
@@ -1130,221 +506,523 @@ export class QueryImpl<R> {
|
|
|
1130
506
|
]
|
|
1131
507
|
>
|
|
1132
508
|
}
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
509
|
+
} = <I, E, A, Request extends Req, Name extends string>(
|
|
510
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
511
|
+
) => {
|
|
512
|
+
const runPromise = makeRunPromise(this.getRuntime())
|
|
513
|
+
const q = this.useQuery(self)
|
|
514
|
+
return <TData = A>(
|
|
515
|
+
argOrOptions: I | WatchSource<I>,
|
|
516
|
+
options?: CustomUndefinedInitialQueryOptions<A, CauseException<E>, TData>
|
|
517
|
+
) => {
|
|
518
|
+
const [
|
|
519
|
+
[resultRef, latestDefinedRef, fetch, uqrt],
|
|
520
|
+
isMounted,
|
|
521
|
+
signal
|
|
522
|
+
] = useScopedSuspenseSetup(() => {
|
|
523
|
+
const [resultRef, latestRef, fetch, uqrt] = q<TData>(argOrOptions, options)
|
|
524
|
+
const latestDefinedRef = latestDefined(() => latestRef.value, "suspense")
|
|
525
|
+
return [resultRef, latestDefinedRef, fetch, uqrt] as const
|
|
526
|
+
})
|
|
527
|
+
|
|
528
|
+
// @effect-diagnostics effect/missingEffectError:off
|
|
529
|
+
const eff = Effect.gen(function*() {
|
|
530
|
+
const exit = yield* uqrt.awaitResult().pipe(Effect.exit)
|
|
531
|
+
if (!isMounted.value) {
|
|
532
|
+
return yield* Effect.interrupt
|
|
533
|
+
}
|
|
534
|
+
if (Exit.isFailure(exit)) {
|
|
535
|
+
return yield* Exit.failCause(exit.cause)
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
return [resultRef, latestDefinedRef, fetch, uqrt] as const
|
|
539
|
+
})
|
|
540
|
+
|
|
541
|
+
return runPromise(eff, { signal })
|
|
542
|
+
}
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
readonly useSuspenseQueryNew: {
|
|
1138
546
|
<
|
|
1139
|
-
|
|
547
|
+
I,
|
|
1140
548
|
E,
|
|
1141
549
|
A,
|
|
1142
550
|
Request extends Req,
|
|
1143
551
|
Name extends string
|
|
1144
552
|
>(
|
|
1145
|
-
self: RequestHandlerWithInput<
|
|
553
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
1146
554
|
): {
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
*/
|
|
1152
|
-
<TData = A>(arg: Arg | WatchSource<Arg>, options?: CustomUndefinedInitialQueryOptions<A, E, TData>): Promise<
|
|
1153
|
-
readonly [
|
|
1154
|
-
ComputedRef<AsyncResult.AsyncResult<TData, E>>,
|
|
1155
|
-
ComputedRef<TData>,
|
|
1156
|
-
(
|
|
1157
|
-
options?: RefetchOptions
|
|
1158
|
-
) => Effect.Effect<QueryObserverResult<TData, E>>,
|
|
1159
|
-
UseQueryReturnType<any, any>
|
|
1160
|
-
]
|
|
1161
|
-
>
|
|
555
|
+
<TData = A>(
|
|
556
|
+
arg: I | WatchSource<I>,
|
|
557
|
+
options?: AtomQueryNewOptions<A, TData>
|
|
558
|
+
): Promise<SuspenseQueryView<TData, E>>
|
|
1162
559
|
}
|
|
1163
|
-
} = <
|
|
1164
|
-
self: RequestHandlerWithInput<
|
|
560
|
+
} = <I, E, A, Request extends Req, Name extends string>(
|
|
561
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
1165
562
|
) => {
|
|
1166
|
-
const runPromise =
|
|
1167
|
-
const q = this.
|
|
1168
|
-
return
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
const isMounted =
|
|
1173
|
-
|
|
1174
|
-
|
|
563
|
+
const runPromise = makeRunPromise(this.getRuntime())
|
|
564
|
+
const q = this.useQueryNew(self)
|
|
565
|
+
return <TData = A>(
|
|
566
|
+
argOrOptions: I | WatchSource<I>,
|
|
567
|
+
options?: AtomQueryNewOptions<A, TData>
|
|
568
|
+
) => {
|
|
569
|
+
const [{ view, data }, isMounted, signal] = useScopedSuspenseSetup(() => {
|
|
570
|
+
const view = q<TData>(argOrOptions, options)
|
|
571
|
+
const data = latestDefined(() => view.data.value, "suspenseNew")
|
|
572
|
+
return { view, data }
|
|
1175
573
|
})
|
|
1176
574
|
|
|
1177
575
|
// @effect-diagnostics effect/missingEffectError:off
|
|
1178
576
|
const eff = Effect.gen(function*() {
|
|
1179
|
-
|
|
1180
|
-
// what's the difference with just calling `fetch` ?
|
|
1181
|
-
// we will receive a CancelledError which we will have to ignore in our ErrorBoundary, otherwise the user ends up on an error page even if the user e.g cancelled a navigation
|
|
1182
|
-
const r = yield* Effect.tryPromise(() => uqrt.suspense()).pipe(
|
|
1183
|
-
Effect.catchTag("UnknownError", (err) =>
|
|
1184
|
-
isCancelledError(err.cause)
|
|
1185
|
-
? Effect.interrupt
|
|
1186
|
-
: Effect.die(err.cause))
|
|
1187
|
-
)
|
|
577
|
+
const exit = yield* view.awaitResult().pipe(Effect.exit)
|
|
1188
578
|
if (!isMounted.value) {
|
|
1189
579
|
return yield* Effect.interrupt
|
|
1190
580
|
}
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
console.error("Internal Error: Promise should be resolved already", {
|
|
1194
|
-
self,
|
|
1195
|
-
argOrOptions,
|
|
1196
|
-
options,
|
|
1197
|
-
r,
|
|
1198
|
-
resultRef
|
|
1199
|
-
})
|
|
1200
|
-
return yield* Effect.die(
|
|
1201
|
-
"Internal Error: Promise should be resolved already"
|
|
1202
|
-
)
|
|
1203
|
-
}
|
|
1204
|
-
if (AsyncResult.isFailure(result)) {
|
|
1205
|
-
return yield* Exit.failCause(result.cause)
|
|
581
|
+
if (Exit.isFailure(exit)) {
|
|
582
|
+
return yield* Exit.failCause(exit.cause)
|
|
1206
583
|
}
|
|
1207
584
|
|
|
1208
|
-
|
|
585
|
+
const fetch = (_options?: RefetchOptions) => view.refetch()
|
|
586
|
+
const handle = {
|
|
587
|
+
awaitResult: view.awaitResult,
|
|
588
|
+
refetch: view.refetch,
|
|
589
|
+
refresh: view.refresh,
|
|
590
|
+
registry: view.registry,
|
|
591
|
+
atom: view.atom
|
|
592
|
+
}
|
|
593
|
+
return Object.assign(
|
|
594
|
+
[
|
|
595
|
+
view.result,
|
|
596
|
+
data,
|
|
597
|
+
fetch,
|
|
598
|
+
handle
|
|
599
|
+
] as const,
|
|
600
|
+
{
|
|
601
|
+
...view,
|
|
602
|
+
data
|
|
603
|
+
}
|
|
604
|
+
)
|
|
1209
605
|
})
|
|
1210
606
|
|
|
1211
|
-
return runPromise(eff)
|
|
607
|
+
return runPromise(eff, { signal })
|
|
1212
608
|
}
|
|
1213
609
|
}
|
|
1214
610
|
}
|
|
1215
611
|
|
|
1216
612
|
// somehow mrt.runtimeEffect doesnt work sync, but this workaround works fine? not sure why though as the layers are generally only sync
|
|
1217
|
-
const managedRuntimeRt = <A, E>(mrt: ManagedRuntime.ManagedRuntime<A, E>) => mrt.runSync(Effect.
|
|
613
|
+
const managedRuntimeRt = <A, E>(mrt: ManagedRuntime.ManagedRuntime<A, E>) => mrt.runSync(Effect.context<A>())
|
|
1218
614
|
|
|
1219
615
|
type Base = I18n | Toast
|
|
1220
|
-
type Mix = ApiClientFactory | Commander |
|
|
616
|
+
type Mix = ApiClientFactory | Commander | Base
|
|
617
|
+
|
|
618
|
+
type InvalidationResources = Record<string, Record<string, unknown>>
|
|
619
|
+
type UnionToIntersection<U> = (U extends unknown ? (arg: U) => void : never) extends ((arg: infer I) => void) ? I
|
|
620
|
+
: never
|
|
621
|
+
|
|
622
|
+
type CommandInvalidationResources<Req> = Req extends {
|
|
623
|
+
readonly type: "command"
|
|
624
|
+
readonly "~invalidationResources"?: infer Resources
|
|
625
|
+
} ? NonNullable<Resources> extends InvalidationResources ? NonNullable<Resources> : never
|
|
626
|
+
: Req extends {
|
|
627
|
+
readonly type: "command"
|
|
628
|
+
readonly config?: infer Config
|
|
629
|
+
} ? Config extends {
|
|
630
|
+
readonly invalidationResources?: infer LegacyResources
|
|
631
|
+
} ? NonNullable<LegacyResources> extends InvalidationResources ? NonNullable<LegacyResources> : never
|
|
632
|
+
: Config extends {
|
|
633
|
+
readonly invalidatesQueries?: InvalidationCallback<infer LegacyResources, any, any, any>
|
|
634
|
+
} ? NonNullable<LegacyResources> extends InvalidationResources ? NonNullable<LegacyResources> : never
|
|
635
|
+
: never
|
|
636
|
+
: never
|
|
637
|
+
|
|
638
|
+
type InvalidationResourcesForUnion<M extends RequestsAny> = {
|
|
639
|
+
[K in keyof M]: CommandInvalidationResources<M[K]>
|
|
640
|
+
}[keyof M]
|
|
641
|
+
|
|
642
|
+
type InvalidationResourcesFor<M extends RequestsAny> = [InvalidationResourcesForUnion<M>] extends [never] ? never
|
|
643
|
+
: UnionToIntersection<InvalidationResourcesForUnion<M>> extends infer R ? R extends InvalidationResources ? R
|
|
644
|
+
: never
|
|
645
|
+
: never
|
|
646
|
+
|
|
647
|
+
type QueryInvalidationFactory<M extends RequestsAny> = (client: ClientFrom<M>) => QueryInvalidation<M>
|
|
648
|
+
|
|
649
|
+
type StrictResourcesArg<Shape, Actual extends Shape = Shape> =
|
|
650
|
+
& Actual
|
|
651
|
+
& Record<Exclude<keyof Actual, keyof Shape>, never>
|
|
652
|
+
|
|
653
|
+
type ClientForArgs<
|
|
654
|
+
M extends RequestsAny,
|
|
655
|
+
Resources extends InvalidationResourcesFor<M> = InvalidationResourcesFor<M>
|
|
656
|
+
> = [InvalidationResourcesFor<M>] extends [never] ? [
|
|
657
|
+
queryInvalidation?: QueryInvalidationFactory<M>,
|
|
658
|
+
invalidationResources?: StrictResourcesArg<
|
|
659
|
+
InvalidationResourcesFor<M>,
|
|
660
|
+
Resources
|
|
661
|
+
>
|
|
662
|
+
]
|
|
663
|
+
: [
|
|
664
|
+
queryInvalidation: QueryInvalidationFactory<M> | undefined,
|
|
665
|
+
invalidationResources: StrictResourcesArg<
|
|
666
|
+
InvalidationResourcesFor<M>,
|
|
667
|
+
Resources
|
|
668
|
+
>
|
|
669
|
+
]
|
|
670
|
+
|
|
671
|
+
const makeResolvedAtomQueryInvalidator = <R>(getContext: () => Context.Context<R>): QueryInvalidator => {
|
|
672
|
+
let reactivity: Context.Service.Shape<typeof Reactivity.Reactivity> | undefined
|
|
673
|
+
const getReactivity = () => {
|
|
674
|
+
if (reactivity !== undefined) return reactivity
|
|
675
|
+
const service = Context.getOrUndefined(getContext(), Reactivity.Reactivity)
|
|
676
|
+
if (service === undefined) {
|
|
677
|
+
throw new Error("Reactivity service is missing from the client runtime")
|
|
678
|
+
}
|
|
679
|
+
return reactivity = service
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
return {
|
|
683
|
+
invalidateAndAwait: (keys) =>
|
|
684
|
+
invalidateAndAwait(keys).pipe(
|
|
685
|
+
Effect.provideService(Reactivity.Reactivity, getReactivity())
|
|
686
|
+
)
|
|
687
|
+
}
|
|
688
|
+
}
|
|
689
|
+
|
|
1221
690
|
export const makeClient = <RT_, RTHooks>(
|
|
1222
691
|
// global, but only accessible after startup has completed
|
|
1223
692
|
getBaseMrt: () => ManagedRuntime.ManagedRuntime<RT_ | Mix, never>,
|
|
1224
693
|
clientFor_: ReturnType<typeof ApiClientFactory["makeFor"]>,
|
|
1225
|
-
rtHooks: Layer.Layer<RTHooks, never, Mix
|
|
694
|
+
rtHooks: Layer.Layer<RTHooks, never, Mix>,
|
|
695
|
+
options?: MakeClientOptions
|
|
1226
696
|
) => {
|
|
1227
697
|
type RT = RT_ | Mix
|
|
1228
|
-
const getRt = Effect.services<RT>()
|
|
1229
698
|
const getBaseRt = () => managedRuntimeRt(getBaseMrt())
|
|
1230
699
|
const makeCommand = makeUseCommand<RT, RTHooks>(rtHooks)
|
|
1231
|
-
const makeMutation = Effect.gen(function*() {
|
|
1232
|
-
const mut = yield* LegacyMutation
|
|
1233
|
-
|
|
1234
|
-
return mut(() => getBaseMrt().runSync(getRt))
|
|
1235
|
-
})
|
|
1236
700
|
let cmd: Effect.Success<typeof makeCommand>
|
|
1237
701
|
const useCommand = () => cmd ??= getBaseMrt().runSync(makeCommand)
|
|
1238
|
-
let mut: Effect.Success<typeof makeMutation>
|
|
1239
|
-
const getMutation = () => mut ??= getBaseMrt().runSync(makeMutation)
|
|
1240
702
|
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
const
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
}) as any
|
|
1262
|
-
return prev
|
|
1263
|
-
},
|
|
1264
|
-
{} as Pick<LegacyMutationImpl<RT>, typeof keys[number]>
|
|
703
|
+
// one AtomRuntime for the query engine, built lazily from the live app context;
|
|
704
|
+
// shares the ManagedRuntime memoMap so layers + Reactivity are the same instances.
|
|
705
|
+
let atomRt: AtomClientRuntime | undefined
|
|
706
|
+
const getAtomRt =
|
|
707
|
+
() => (atomRt ??= makeAtomClientRuntime(() => Layer.succeedContext(getBaseRt()), getBaseMrt().memoMap))
|
|
708
|
+
|
|
709
|
+
const legacyQueryEngine = options?.legacyQueryEngine ?? "tanstack"
|
|
710
|
+
let tanstackQueryClient: ReturnType<typeof makeTanstackQueryClient> | undefined
|
|
711
|
+
const getTanstackQueryClient = () => tanstackQueryClient ??= makeTanstackQueryClient()
|
|
712
|
+
const atomInvalidator = makeResolvedAtomQueryInvalidator(getBaseRt)
|
|
713
|
+
const queryInvalidator = legacyQueryEngine === "tanstack"
|
|
714
|
+
? combineQueryInvalidators(atomInvalidator, makeTanstackQueryInvalidator(getTanstackQueryClient()))
|
|
715
|
+
: atomInvalidator
|
|
716
|
+
setQueryCacheUpdater(
|
|
717
|
+
legacyQueryEngine === "tanstack"
|
|
718
|
+
? combineQueryCacheUpdaters(
|
|
719
|
+
makeTanstackQueryCacheUpdater(getTanstackQueryClient()),
|
|
720
|
+
optionalAtomQueryCacheUpdater
|
|
721
|
+
)
|
|
722
|
+
: atomQueryCacheUpdater
|
|
1265
723
|
)
|
|
1266
724
|
|
|
1267
|
-
|
|
725
|
+
let m: ReturnType<typeof useMutationInt>
|
|
726
|
+
const useMutation = () => m ??= useMutationInt(queryInvalidator)
|
|
727
|
+
|
|
728
|
+
let sm2: ReturnType<typeof makeStreamMutation2>
|
|
729
|
+
const useStreamMutation2 = () => sm2 ??= makeStreamMutation2(queryInvalidator)
|
|
730
|
+
|
|
731
|
+
const legacyUseQuery = legacyQueryEngine === "tanstack"
|
|
732
|
+
? makeTanstackQuery(getBaseRt, getTanstackQueryClient())
|
|
733
|
+
: undefined
|
|
734
|
+
const query = new QueryImpl(getBaseRt, getAtomRt, legacyUseQuery)
|
|
1268
735
|
const useQuery = query.useQuery
|
|
736
|
+
const useQueryNew = query.useQueryNew
|
|
737
|
+
const useQueryAtom = query.useQueryAtom
|
|
738
|
+
const useQueryFamily = query.useQueryFamily
|
|
1269
739
|
const useSuspenseQuery = query.useSuspenseQuery
|
|
740
|
+
const useSuspenseQueryNew = query.useSuspenseQueryNew
|
|
741
|
+
const useStreamQuery = query.useStreamQuery
|
|
742
|
+
const useStreamQueryFamily = query.useStreamQueryFamily
|
|
743
|
+
const useStreamQueryAtom = query.useStreamQueryAtom
|
|
744
|
+
const useStreamQueryNew = query.useStreamQueryNew
|
|
745
|
+
|
|
746
|
+
const isQueryHandler = <H extends { readonly Request: Req }>(handler: H): handler is QueryHandler<H> =>
|
|
747
|
+
handler.Request.type === "query" && !handler.Request.stream
|
|
748
|
+
|
|
749
|
+
const isStreamQueryHandler = <H extends { readonly Request: Req }>(handler: H): handler is QueryStreamHandler<H> =>
|
|
750
|
+
handler.Request.type === "query" && handler.Request.stream
|
|
751
|
+
|
|
752
|
+
const queryHelpersFor = <I, A, E, Request extends Req, Name extends string>(
|
|
753
|
+
handler: RequestHandlerWithInput<I, A, E, RT, Request, Name>
|
|
754
|
+
) => ({
|
|
755
|
+
family: useQueryFamily(handler),
|
|
756
|
+
atom: useQueryAtom(handler),
|
|
757
|
+
query: useQuery(handler),
|
|
758
|
+
queryNew: useQueryNew(handler),
|
|
759
|
+
suspense: useSuspenseQuery(handler),
|
|
760
|
+
suspenseNew: useSuspenseQueryNew(handler)
|
|
761
|
+
})
|
|
762
|
+
|
|
763
|
+
const streamQueryHelpersFor = <I, A, E, Request extends Req, Name extends string>(
|
|
764
|
+
handler: RequestStreamHandlerWithInput<I, A, E, RT, Request, Name>
|
|
765
|
+
) => ({
|
|
766
|
+
family: useStreamQueryFamily(handler),
|
|
767
|
+
atom: useStreamQueryAtom(handler),
|
|
768
|
+
query: useStreamQuery(handler),
|
|
769
|
+
queryNew: useStreamQueryNew(handler)
|
|
770
|
+
})
|
|
771
|
+
|
|
772
|
+
const projectQueryFor = <
|
|
773
|
+
I,
|
|
774
|
+
A,
|
|
775
|
+
E,
|
|
776
|
+
Request extends Req & { readonly success: S.Top & { readonly "EncodingServices": RT } },
|
|
777
|
+
Name extends string
|
|
778
|
+
>(
|
|
779
|
+
handler: RequestHandlerWithInput<I, A, E, RT, Request, Name>
|
|
780
|
+
) =>
|
|
781
|
+
<ProjSchema extends S.Top & { readonly "DecodingServices": RT }>(projectionSchema: ProjSchema) => {
|
|
782
|
+
const successSchema = handler.Request.success
|
|
783
|
+
const projectionHash = projectionSchemaHash(projectionSchema)
|
|
784
|
+
const projected = projectHandler(handler.handler, successSchema, projectionSchema)
|
|
785
|
+
const projectedHandler = {
|
|
786
|
+
handler: projected,
|
|
787
|
+
id: handler.id,
|
|
788
|
+
Request: handler.Request,
|
|
789
|
+
queryKeyProjectionHash: projectionHash
|
|
790
|
+
}
|
|
791
|
+
if (handler.options) {
|
|
792
|
+
return {
|
|
793
|
+
request: projected,
|
|
794
|
+
...queryHelpersFor({ ...projectedHandler, options: handler.options })
|
|
795
|
+
}
|
|
796
|
+
}
|
|
797
|
+
return {
|
|
798
|
+
request: projected,
|
|
799
|
+
...queryHelpersFor(projectedHandler)
|
|
800
|
+
}
|
|
801
|
+
}
|
|
802
|
+
|
|
803
|
+
const mergeInvalidation = (
|
|
804
|
+
a?: MutationOptionsBase["queryInvalidation"],
|
|
805
|
+
b?: MutationOptionsBase["queryInvalidation"]
|
|
806
|
+
): MutationOptionsBase["queryInvalidation"] | undefined => {
|
|
807
|
+
if (!a && !b) {
|
|
808
|
+
return undefined
|
|
809
|
+
}
|
|
810
|
+
return (defaultKey, name, input, output) => [
|
|
811
|
+
...(a?.(defaultKey, name, input, output) ?? []),
|
|
812
|
+
...(b?.(defaultKey, name, input, output) ?? [])
|
|
813
|
+
]
|
|
814
|
+
}
|
|
815
|
+
|
|
816
|
+
const withDefaultInvalidation = (
|
|
817
|
+
mut: any,
|
|
818
|
+
defaultInvalidation?: MutationOptionsBase["queryInvalidation"]
|
|
819
|
+
) => {
|
|
820
|
+
if (!defaultInvalidation) return mut
|
|
821
|
+
const apply = (callerOpts?: MutationOptionsBase) => ({
|
|
822
|
+
...callerOpts,
|
|
823
|
+
queryInvalidation: callerOpts?.queryInvalidation
|
|
824
|
+
? mergeInvalidation(defaultInvalidation, callerOpts.queryInvalidation)
|
|
825
|
+
: defaultInvalidation
|
|
826
|
+
})
|
|
827
|
+
return (input: any, callerOpts?: MutationOptionsBase) => mut(input, apply(callerOpts))
|
|
828
|
+
}
|
|
1270
829
|
|
|
1271
|
-
const
|
|
830
|
+
const makeQueryResources = <Resources extends InvalidationResources>(resources: Resources | undefined) => {
|
|
831
|
+
if (!resources) {
|
|
832
|
+
return {} as Record<string, Record<string, unknown>>
|
|
833
|
+
}
|
|
834
|
+
return resources as Record<string, Record<string, unknown>>
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
const mapQuery = <M extends RequestsAny>(
|
|
1272
838
|
client: ClientFrom<M>
|
|
1273
839
|
) => {
|
|
1274
840
|
const queries = Struct.keys(client).reduce(
|
|
1275
841
|
(acc, key) => {
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
842
|
+
const handler = client[key]
|
|
843
|
+
if (isQueryHandler(handler)) {
|
|
844
|
+
Object.assign(acc, {
|
|
845
|
+
[camelCase(key) + "QueryFamily"]: Object.assign(useQueryFamily(handler), {
|
|
846
|
+
id: client[key].id
|
|
847
|
+
})
|
|
848
|
+
})
|
|
849
|
+
;(acc as any)[camelCase(key) + "Query"] = Object.assign(useQuery(handler), {
|
|
850
|
+
id: client[key].id
|
|
851
|
+
})
|
|
852
|
+
;(acc as any)[camelCase(key) + "QueryNew"] = Object.assign(useQueryNew(handler), {
|
|
853
|
+
id: client[key].id
|
|
854
|
+
})
|
|
855
|
+
;(acc as any)[camelCase(key) + "SuspenseQuery"] = Object.assign(useSuspenseQuery(handler), {
|
|
856
|
+
id: client[key].id
|
|
857
|
+
})
|
|
858
|
+
;(acc as any)[camelCase(key) + "SuspenseQueryNew"] = Object.assign(
|
|
859
|
+
useSuspenseQueryNew(handler),
|
|
860
|
+
{
|
|
861
|
+
id: client[key].id
|
|
862
|
+
}
|
|
863
|
+
)
|
|
864
|
+
} else if (isStreamQueryHandler(handler)) {
|
|
865
|
+
const streamHelpers = streamQueryHelpersFor(handler)
|
|
866
|
+
Object.assign(acc, {
|
|
867
|
+
[camelCase(key) + "QueryFamily"]: Object.assign(streamHelpers.family, {
|
|
868
|
+
id: client[key].id
|
|
869
|
+
}),
|
|
870
|
+
[camelCase(key) + "Query"]: Object.assign(streamHelpers.query, {
|
|
871
|
+
id: client[key].id
|
|
872
|
+
}),
|
|
873
|
+
[camelCase(key) + "QueryNew"]: Object.assign(streamHelpers.queryNew, {
|
|
874
|
+
id: client[key].id
|
|
875
|
+
})
|
|
876
|
+
})
|
|
877
|
+
}
|
|
1282
878
|
return acc
|
|
1283
879
|
},
|
|
1284
880
|
{} as
|
|
881
|
+
& {
|
|
882
|
+
[
|
|
883
|
+
Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
|
|
884
|
+
: `${ToCamel<string & Key>}QueryFamily`
|
|
885
|
+
]: Queries<RT, QueryHandler<typeof client[Key]>>["family"]
|
|
886
|
+
}
|
|
1285
887
|
& {
|
|
1286
888
|
// apparently can't get JSDoc in here..
|
|
1287
|
-
[
|
|
889
|
+
[
|
|
890
|
+
Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
|
|
891
|
+
: `${ToCamel<string & Key>}Query`
|
|
892
|
+
]: Queries<RT, QueryHandler<typeof client[Key]>>["query"]
|
|
893
|
+
}
|
|
894
|
+
& {
|
|
895
|
+
[
|
|
896
|
+
Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
|
|
897
|
+
: `${ToCamel<string & Key>}QueryNew`
|
|
898
|
+
]: Queries<RT, QueryHandler<typeof client[Key]>>["queryNew"]
|
|
1288
899
|
}
|
|
1289
900
|
// todo: or suspense as an Option?
|
|
1290
901
|
& {
|
|
1291
902
|
// apparently can't get JSDoc in here..
|
|
1292
|
-
[
|
|
903
|
+
[
|
|
904
|
+
Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
|
|
905
|
+
: `${ToCamel<string & Key>}SuspenseQuery`
|
|
906
|
+
]: Queries<
|
|
1293
907
|
RT,
|
|
1294
|
-
typeof client[Key]
|
|
908
|
+
QueryHandler<typeof client[Key]>
|
|
1295
909
|
>["suspense"]
|
|
1296
910
|
}
|
|
911
|
+
& {
|
|
912
|
+
[
|
|
913
|
+
Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
|
|
914
|
+
: `${ToCamel<string & Key>}SuspenseQueryNew`
|
|
915
|
+
]: Queries<
|
|
916
|
+
RT,
|
|
917
|
+
QueryHandler<typeof client[Key]>
|
|
918
|
+
>["suspenseNew"]
|
|
919
|
+
}
|
|
920
|
+
& {
|
|
921
|
+
[
|
|
922
|
+
Key in keyof typeof client as QueryStreamHandler<typeof client[Key]> extends never ? never
|
|
923
|
+
: `${ToCamel<string & Key>}QueryFamily`
|
|
924
|
+
]: StreamQueries<RT, QueryStreamHandler<typeof client[Key]>>["family"]
|
|
925
|
+
}
|
|
926
|
+
& {
|
|
927
|
+
[
|
|
928
|
+
Key in keyof typeof client as QueryStreamHandler<typeof client[Key]> extends never ? never
|
|
929
|
+
: `${ToCamel<string & Key>}Query`
|
|
930
|
+
]: StreamQueries<RT, QueryStreamHandler<typeof client[Key]>>["query"]
|
|
931
|
+
}
|
|
932
|
+
& {
|
|
933
|
+
[
|
|
934
|
+
Key in keyof typeof client as QueryStreamHandler<typeof client[Key]> extends never ? never
|
|
935
|
+
: `${ToCamel<string & Key>}QueryNew`
|
|
936
|
+
]: StreamQueries<RT, QueryStreamHandler<typeof client[Key]>>["queryNew"]
|
|
937
|
+
}
|
|
1297
938
|
)
|
|
1298
939
|
return queries
|
|
1299
940
|
}
|
|
1300
941
|
|
|
1301
|
-
const mapRequest = <M extends
|
|
942
|
+
const mapRequest = <M extends RequestsAny>(
|
|
1302
943
|
client: ClientFrom<M>
|
|
1303
944
|
) => {
|
|
1304
945
|
const Command = useCommand()
|
|
1305
946
|
const mutations = Struct.keys(client).reduce(
|
|
1306
947
|
(acc, key) => {
|
|
948
|
+
if (!(client[key].Request.type === "command" && !client[key].Request.stream)) {
|
|
949
|
+
return acc
|
|
950
|
+
}
|
|
1307
951
|
const mut = client[key].handler
|
|
1308
|
-
const
|
|
1309
|
-
const
|
|
952
|
+
const request = mut
|
|
953
|
+
const fn = (options?: any) => Command.fn(client[key].id, options)
|
|
954
|
+
const wrap = (options?: any) => Command.wrap({ mutate: request, id: client[key].id }, options)
|
|
1310
955
|
;(acc as any)[camelCase(key) + "Request"] = Object.assign(
|
|
1311
956
|
mut,
|
|
1312
|
-
fn, // to get the i18n key etc.
|
|
1313
|
-
{ wrap, fn }
|
|
957
|
+
Command.fn(client[key].id), // to get the i18n key etc.
|
|
958
|
+
{ wrap, fn, request }
|
|
1314
959
|
)
|
|
1315
960
|
return acc
|
|
1316
961
|
},
|
|
1317
962
|
{} as {
|
|
1318
|
-
[
|
|
963
|
+
[
|
|
964
|
+
Key in keyof typeof client as CommandHandler<typeof client[Key]> extends never ? never
|
|
965
|
+
: `${ToCamel<string & Key>}Request`
|
|
966
|
+
]: CommandRequestWithExtensions<
|
|
1319
967
|
RT | RTHooks,
|
|
1320
|
-
typeof client[Key]
|
|
968
|
+
CommandHandler<typeof client[Key]>
|
|
1321
969
|
>
|
|
1322
970
|
}
|
|
1323
971
|
)
|
|
1324
972
|
return mutations
|
|
1325
973
|
}
|
|
1326
974
|
|
|
1327
|
-
const mapMutation = <M extends
|
|
1328
|
-
client: ClientFrom<M
|
|
975
|
+
const mapMutation = <M extends RequestsAny>(
|
|
976
|
+
client: ClientFrom<M>,
|
|
977
|
+
queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>,
|
|
978
|
+
invalidationResources?: InvalidationResourcesFor<M>
|
|
1329
979
|
) => {
|
|
1330
980
|
const Command = useCommand()
|
|
1331
981
|
const mutation = useMutation()
|
|
982
|
+
const invalidation = queryInvalidation?.(client)
|
|
983
|
+
const queryResources = makeQueryResources(invalidationResources)
|
|
1332
984
|
const mutations = Struct.keys(client).reduce(
|
|
1333
985
|
(acc, key) => {
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
986
|
+
if (!(client[key].Request.type === "command" && !client[key].Request.stream)) {
|
|
987
|
+
return acc
|
|
988
|
+
}
|
|
989
|
+
const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
|
|
990
|
+
| InvalidationCallback<InvalidationResourcesFor<M>>
|
|
991
|
+
| undefined
|
|
992
|
+
const fromRequest = fromRequestConfig
|
|
993
|
+
? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
|
|
994
|
+
fromRequestConfig(
|
|
995
|
+
defaultKey,
|
|
996
|
+
queryResources as never,
|
|
997
|
+
input as never,
|
|
998
|
+
output as never
|
|
999
|
+
) as InvalidationEntry[])
|
|
1000
|
+
: undefined
|
|
1001
|
+
const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
|
|
1002
|
+
const makeProjectedMutation = (handler: any): any => {
|
|
1003
|
+
const mut: any = withDefaultInvalidation(mutation(handler), mergedInvalidation)
|
|
1004
|
+
return Object.assign(mut, {
|
|
1005
|
+
wrap: (options?: any) => Command.wrap({ mutate: mut, id: client[key].id }, options),
|
|
1006
|
+
fn: (options?: any) => Command.fn(client[key].id, options),
|
|
1007
|
+
project: (projectionSchema: any) => {
|
|
1008
|
+
const projected = {
|
|
1009
|
+
...handler,
|
|
1010
|
+
handler: projectHandler(handler.handler, client[key].Request.success, projectionSchema)
|
|
1011
|
+
}
|
|
1012
|
+
return makeProjectedMutation(projected)
|
|
1013
|
+
}
|
|
1014
|
+
})
|
|
1015
|
+
}
|
|
1016
|
+
;(acc as any)[camelCase(key) + "Mutation"] = makeProjectedMutation(client[key] as any)
|
|
1342
1017
|
return acc
|
|
1343
1018
|
},
|
|
1344
1019
|
{} as {
|
|
1345
|
-
[
|
|
1020
|
+
[
|
|
1021
|
+
Key in keyof typeof client as CommandHandler<typeof client[Key]> extends never ? never
|
|
1022
|
+
: `${ToCamel<string & Key>}Mutation`
|
|
1023
|
+
]: MutationWithExtensions<
|
|
1346
1024
|
RT | RTHooks,
|
|
1347
|
-
typeof client[Key]
|
|
1025
|
+
CommandHandler<typeof client[Key]>
|
|
1348
1026
|
>
|
|
1349
1027
|
}
|
|
1350
1028
|
)
|
|
@@ -1353,8 +1031,9 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1353
1031
|
|
|
1354
1032
|
// make available .query, .suspense and .mutate for each operation
|
|
1355
1033
|
// and a .helpers with all mutations and queries
|
|
1356
|
-
const mapClient = <M extends
|
|
1357
|
-
queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M
|
|
1034
|
+
const mapClient = <M extends RequestsAny>(
|
|
1035
|
+
queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>,
|
|
1036
|
+
invalidationResources?: InvalidationResourcesFor<M>
|
|
1358
1037
|
) =>
|
|
1359
1038
|
(
|
|
1360
1039
|
client: ClientFrom<M>
|
|
@@ -1362,71 +1041,167 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1362
1041
|
const Command = useCommand()
|
|
1363
1042
|
const mutation = useMutation()
|
|
1364
1043
|
const invalidation = queryInvalidation?.(client)
|
|
1044
|
+
const queryResources = makeQueryResources(invalidationResources)
|
|
1365
1045
|
const extended = Struct.keys(client).reduce(
|
|
1366
1046
|
(acc, key) => {
|
|
1047
|
+
const handler = client[key]
|
|
1048
|
+
const requestType = handler.Request.type
|
|
1049
|
+
const isStream = handler.Request.stream
|
|
1367
1050
|
const fn = Command.fn(client[key].id)
|
|
1368
|
-
const
|
|
1369
|
-
|
|
1370
|
-
client[key] as any,
|
|
1371
|
-
invalidation?.[key] ? { queryInvalidation: invalidation[key] } : undefined
|
|
1372
|
-
),
|
|
1373
|
-
(mutate) =>
|
|
1374
|
-
Object.assign(
|
|
1375
|
-
mutate,
|
|
1376
|
-
fn, // to get the i18n key etc.
|
|
1377
|
-
{
|
|
1378
|
-
wrap: Command.wrap({ mutate: Effect.isEffect(mutate) ? () => mutate : mutate, id: client[key].id }),
|
|
1379
|
-
fn
|
|
1380
|
-
}
|
|
1381
|
-
)
|
|
1382
|
-
)
|
|
1383
|
-
|
|
1384
|
-
const h_ = client[key].handler
|
|
1385
|
-
const h = Effect.isEffect(h_)
|
|
1386
|
-
? () => h_
|
|
1387
|
-
: (...args: [any]) => h_(...args)
|
|
1051
|
+
const h_ = handler.handler
|
|
1052
|
+
const request = h_
|
|
1388
1053
|
;(acc as any)[key] = Object.assign(
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1054
|
+
isQueryHandler(handler)
|
|
1055
|
+
? {
|
|
1056
|
+
...handler,
|
|
1057
|
+
request,
|
|
1058
|
+
...queryHelpersFor(handler),
|
|
1059
|
+
project: projectQueryFor(handler)
|
|
1060
|
+
}
|
|
1061
|
+
: isStreamQueryHandler(handler)
|
|
1062
|
+
? {
|
|
1063
|
+
...client[key],
|
|
1064
|
+
request,
|
|
1065
|
+
...streamQueryHelpersFor(handler)
|
|
1066
|
+
}
|
|
1067
|
+
: requestType === "command" && isStream
|
|
1068
|
+
? (() => {
|
|
1069
|
+
const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
|
|
1070
|
+
| InvalidationCallback<InvalidationResourcesFor<M>>
|
|
1071
|
+
| undefined
|
|
1072
|
+
const fromRequest = fromRequestConfig
|
|
1073
|
+
? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
|
|
1074
|
+
fromRequestConfig(
|
|
1075
|
+
defaultKey,
|
|
1076
|
+
queryResources as never,
|
|
1077
|
+
input as never,
|
|
1078
|
+
output as never
|
|
1079
|
+
) as InvalidationEntry[])
|
|
1080
|
+
: undefined
|
|
1081
|
+
const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
|
|
1082
|
+
const streamCmd = useCommand()
|
|
1083
|
+
return {
|
|
1084
|
+
...client[key],
|
|
1085
|
+
request,
|
|
1086
|
+
query: useStreamQuery(client[key] as any),
|
|
1087
|
+
fn: (options?: any) => streamCmd.streamFn(client[key].id as any, options),
|
|
1088
|
+
mutate: (() => {
|
|
1089
|
+
const sm2Act = useStreamMutation2()(client[key] as any, mergedInvalidation)
|
|
1090
|
+
const sm2Handler = (input: any, _ctx: any) => (sm2Act as (i: any) => any)(input)
|
|
1091
|
+
return Object.assign(sm2Act, {
|
|
1092
|
+
id: client[key].id,
|
|
1093
|
+
wrap: (options?: any) => streamCmd.streamWrap(sm2Handler, client[key].id as any, options)
|
|
1094
|
+
})
|
|
1095
|
+
})()
|
|
1096
|
+
}
|
|
1097
|
+
})()
|
|
1098
|
+
: {
|
|
1099
|
+
mutate: ((handler: any) => {
|
|
1100
|
+
const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
|
|
1101
|
+
| InvalidationCallback<InvalidationResourcesFor<M>>
|
|
1102
|
+
| undefined
|
|
1103
|
+
const fromRequest = fromRequestConfig
|
|
1104
|
+
? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
|
|
1105
|
+
fromRequestConfig(
|
|
1106
|
+
defaultKey,
|
|
1107
|
+
queryResources as never,
|
|
1108
|
+
input as never,
|
|
1109
|
+
output as never
|
|
1110
|
+
) as InvalidationEntry[])
|
|
1111
|
+
: undefined
|
|
1112
|
+
const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
|
|
1113
|
+
const makeProjectedMutation = (h: any): any => {
|
|
1114
|
+
const mutate = withDefaultInvalidation(mutation(h), mergedInvalidation)
|
|
1115
|
+
return Object.assign(
|
|
1116
|
+
mutate,
|
|
1117
|
+
{
|
|
1118
|
+
wrap: (options?: any) =>
|
|
1119
|
+
Command.wrap({
|
|
1120
|
+
mutate,
|
|
1121
|
+
id: client[key].id
|
|
1122
|
+
}, options),
|
|
1123
|
+
fn: (options?: any) => Command.fn(client[key].id, options),
|
|
1124
|
+
project: (projectionSchema: any) => {
|
|
1125
|
+
const projected = {
|
|
1126
|
+
...h,
|
|
1127
|
+
handler: projectHandler(h.handler, client[key].Request.success, projectionSchema)
|
|
1128
|
+
}
|
|
1129
|
+
return makeProjectedMutation(projected)
|
|
1130
|
+
}
|
|
1131
|
+
}
|
|
1132
|
+
)
|
|
1133
|
+
}
|
|
1134
|
+
return makeProjectedMutation(handler)
|
|
1135
|
+
})(client[key] as any),
|
|
1136
|
+
...client[key],
|
|
1137
|
+
...fn, // to get the i18n key etc.
|
|
1138
|
+
request,
|
|
1139
|
+
fn: (options?: any) => Command.fn(client[key].id, options),
|
|
1140
|
+
wrap: (options?: any) => Command.wrap({ mutate: h_, id: client[key].id }, options)
|
|
1141
|
+
}
|
|
1399
1142
|
)
|
|
1400
1143
|
return acc
|
|
1401
1144
|
},
|
|
1402
1145
|
{} as {
|
|
1403
1146
|
[Key in keyof typeof client]:
|
|
1404
1147
|
& typeof client[Key]
|
|
1405
|
-
&
|
|
1406
|
-
|
|
1407
|
-
|
|
1148
|
+
& (QueryHandler<typeof client[Key]> extends never ? {}
|
|
1149
|
+
:
|
|
1150
|
+
& QueryRequestWithExtensions<QueryHandler<typeof client[Key]>>
|
|
1151
|
+
& Queries<RT, QueryHandler<typeof client[Key]>>
|
|
1152
|
+
& QueryProjection<RT, QueryHandler<typeof client[Key]>>)
|
|
1153
|
+
& (QueryStreamHandler<typeof client[Key]> extends never ? {}
|
|
1154
|
+
: StreamQueries<RT, QueryStreamHandler<typeof client[Key]>>)
|
|
1155
|
+
& (CommandHandler<typeof client[Key]> extends never ? {}
|
|
1156
|
+
: CommandRequestWithExtensions<RT | RTHooks, CommandHandler<typeof client[Key]>>)
|
|
1157
|
+
& (CommandHandler<typeof client[Key]> extends never ? {}
|
|
1158
|
+
: { mutate: MutationWithExtensions<RT | RTHooks, CommandHandler<typeof client[Key]>> })
|
|
1159
|
+
& (CommandStreamHandler<typeof client[Key]> extends never ? {}
|
|
1160
|
+
: {
|
|
1161
|
+
fn: StreamFnStreamExtension<RT | RTHooks, CommandStreamHandler<typeof client[Key]>>
|
|
1162
|
+
mutate: StreamMutation2WithExtensions<RT | RTHooks, CommandStreamHandler<typeof client[Key]>>
|
|
1163
|
+
})
|
|
1164
|
+
& {
|
|
1165
|
+
Input: typeof client[Key] extends RequestStreamHandlerWithInput<infer I, any, any, any, any, any, any> ? I
|
|
1166
|
+
: typeof client[Key] extends RequestHandlerWithInput<infer I, any, any, any, any, any> ? I
|
|
1167
|
+
: never
|
|
1168
|
+
}
|
|
1408
1169
|
}
|
|
1409
1170
|
)
|
|
1410
|
-
return Object.assign(extended, {
|
|
1171
|
+
return Object.assign(extended, {
|
|
1172
|
+
helpers: {
|
|
1173
|
+
...mapRequest(client),
|
|
1174
|
+
...mapMutation(client, queryInvalidation, invalidationResources),
|
|
1175
|
+
...mapQuery(client)
|
|
1176
|
+
}
|
|
1177
|
+
})
|
|
1411
1178
|
}
|
|
1412
1179
|
|
|
1413
1180
|
// TODO: Clean up this delay initialisation messs
|
|
1414
1181
|
// TODO; invalidateQueries should perhaps be configured in the Request impl themselves?
|
|
1415
|
-
const clientFor__ = <M extends
|
|
1182
|
+
const clientFor__ = <M extends RequestsAny>(
|
|
1416
1183
|
m: M,
|
|
1417
|
-
queryInvalidation?:
|
|
1418
|
-
|
|
1184
|
+
queryInvalidation?: QueryInvalidationFactory<M>,
|
|
1185
|
+
invalidationResources?: InvalidationResourcesFor<M>
|
|
1186
|
+
) => getBaseMrt().runSync(clientFor_(m).pipe(Effect.map(mapClient(queryInvalidation, invalidationResources))))
|
|
1419
1187
|
|
|
1420
1188
|
// delay client creation until first access
|
|
1421
1189
|
// the idea is that we don't need the useNuxtApp().$runtime (only available at later initialisation stage)
|
|
1422
1190
|
// until we are at a place where it is available..
|
|
1423
|
-
const clientFor = <
|
|
1191
|
+
const clientFor = <
|
|
1192
|
+
M extends RequestsAny,
|
|
1193
|
+
Resources extends InvalidationResourcesFor<M> = InvalidationResourcesFor<M>
|
|
1194
|
+
>(
|
|
1424
1195
|
m: M,
|
|
1425
|
-
|
|
1196
|
+
...args: ClientForArgs<M, Resources>
|
|
1426
1197
|
) => {
|
|
1198
|
+
const [queryInvalidation, invalidationResources] = args as [
|
|
1199
|
+
QueryInvalidationFactory<M> | undefined,
|
|
1200
|
+
InvalidationResourcesFor<M> | undefined
|
|
1201
|
+
]
|
|
1427
1202
|
type Client = ReturnType<typeof clientFor__<M>>
|
|
1428
1203
|
let client: Client | undefined = undefined
|
|
1429
|
-
const getOrMakeClient = () => (client ??= clientFor__(m, queryInvalidation))
|
|
1204
|
+
const getOrMakeClient = () => (client ??= clientFor__(m, queryInvalidation, invalidationResources))
|
|
1430
1205
|
|
|
1431
1206
|
// initialize on first use..
|
|
1432
1207
|
const proxy = Struct.keys(m).concat(["helpers"]).reduce((acc, key) => {
|
|
@@ -1444,16 +1219,12 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1444
1219
|
return proxy
|
|
1445
1220
|
}
|
|
1446
1221
|
|
|
1447
|
-
const legacy: Legacy<RT> = {
|
|
1448
|
-
...mutations,
|
|
1449
|
-
...query
|
|
1450
|
-
}
|
|
1451
|
-
|
|
1452
1222
|
const Command: CommanderResolved<RT, RTHooks> = {
|
|
1453
1223
|
...{
|
|
1454
1224
|
// delay initialisation until first use...
|
|
1455
1225
|
fn: (...args: [any]) => useCommand().fn(...args),
|
|
1456
1226
|
wrap: (...args: [any]) => useCommand().wrap(...args),
|
|
1227
|
+
streamFn: (...args: [any]) => useCommand().streamFn(...args),
|
|
1457
1228
|
alt: (...args: [any]) => useCommand().alt(...args),
|
|
1458
1229
|
alt2: (...args: [any]) => useCommand().alt2(...args)
|
|
1459
1230
|
} as ReturnType<typeof useCommand>,
|
|
@@ -1464,21 +1235,17 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1464
1235
|
Command,
|
|
1465
1236
|
useCommand,
|
|
1466
1237
|
clientFor,
|
|
1467
|
-
|
|
1238
|
+
tanstackQueryClient: getTanstackQueryClient()
|
|
1468
1239
|
}
|
|
1469
1240
|
}
|
|
1470
1241
|
|
|
1471
|
-
export interface Legacy<R>
|
|
1472
|
-
extends
|
|
1473
|
-
Pick<QueryImpl<R>, "useQuery" | "useSuspenseQuery">,
|
|
1474
|
-
Omit<LegacyMutationImpl<R>, "getRuntime" | "toast" | "intl">
|
|
1475
|
-
{}
|
|
1476
|
-
|
|
1477
1242
|
export type QueryInvalidation<M> = {
|
|
1478
|
-
[K in keyof M]?: (
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1243
|
+
[K in keyof M]?: (
|
|
1244
|
+
defaultKey: string[],
|
|
1245
|
+
name: string,
|
|
1246
|
+
input?: unknown,
|
|
1247
|
+
output?: Exit.Exit<unknown, unknown>
|
|
1248
|
+
) => InvalidationEntry[]
|
|
1482
1249
|
}
|
|
1483
1250
|
|
|
1484
1251
|
export type ToCamel<S extends string | number | symbol> = S extends string
|
|
@@ -1486,17 +1253,21 @@ export type ToCamel<S extends string | number | symbol> = S extends string
|
|
|
1486
1253
|
: Uncapitalize<S>
|
|
1487
1254
|
: never
|
|
1488
1255
|
|
|
1489
|
-
export interface CommandBase<I = void, A = void> {
|
|
1256
|
+
export interface CommandBase<I = void, A = void, RA = unknown, RE = unknown> {
|
|
1490
1257
|
handle: (input: I) => A
|
|
1491
1258
|
waiting: boolean
|
|
1492
1259
|
blocked: boolean
|
|
1493
1260
|
allowed: boolean
|
|
1494
1261
|
action: string
|
|
1495
1262
|
label: string
|
|
1263
|
+
/** formatted progress info for current `running` state, when `progress` was supplied */
|
|
1264
|
+
progress?: Progress | undefined
|
|
1265
|
+
/** reactive result state, available on stream-backed commands */
|
|
1266
|
+
result?: AsyncResult.AsyncResult<RA, RE>
|
|
1496
1267
|
}
|
|
1497
1268
|
|
|
1498
|
-
export interface EffectCommand<I = void, A = unknown, E = unknown> extends CommandBase<I, Fiber<A, E
|
|
1269
|
+
export interface EffectCommand<I = void, A = unknown, E = unknown> extends CommandBase<I, Fiber<A, E>, A, E> {}
|
|
1499
1270
|
|
|
1500
|
-
export interface CommandFromRequest<I extends
|
|
1501
|
-
extends EffectCommand<
|
|
1271
|
+
export interface CommandFromRequest<I extends { readonly make: (...args: any[]) => any }, A = unknown, E = unknown>
|
|
1272
|
+
extends EffectCommand<HandlerInput<I>, A, E>
|
|
1502
1273
|
{}
|