@effect-app/vue 4.0.0-beta.22 → 4.0.0-beta.221
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 +1613 -0
- package/dist/commander.d.ts +634 -0
- package/dist/commander.d.ts.map +1 -0
- package/dist/commander.js +1070 -0
- package/dist/confirm.d.ts +21 -0
- package/dist/confirm.d.ts.map +1 -0
- package/dist/confirm.js +26 -0
- package/dist/errorReporter.d.ts +7 -5
- package/dist/errorReporter.d.ts.map +1 -1
- package/dist/errorReporter.js +14 -19
- package/dist/form.d.ts +15 -6
- package/dist/form.d.ts.map +1 -1
- package/dist/form.js +46 -13
- package/dist/index.d.ts +1 -1
- 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 +8 -10
- package/dist/lib.d.ts.map +1 -1
- package/dist/lib.js +35 -10
- package/dist/makeClient.d.ts +156 -339
- package/dist/makeClient.d.ts.map +1 -1
- package/dist/makeClient.js +225 -376
- package/dist/makeContext.d.ts +1 -1
- package/dist/makeContext.d.ts.map +1 -1
- package/dist/makeIntl.d.ts +1 -1
- package/dist/makeIntl.d.ts.map +1 -1
- package/dist/makeUseCommand.d.ts +9 -0
- package/dist/makeUseCommand.d.ts.map +1 -0
- package/dist/makeUseCommand.js +13 -0
- package/dist/mutate.d.ts +54 -34
- package/dist/mutate.d.ts.map +1 -1
- package/dist/mutate.js +139 -46
- package/dist/query.d.ts +20 -39
- package/dist/query.d.ts.map +1 -1
- package/dist/query.js +133 -72
- package/dist/routeParams.d.ts +3 -2
- package/dist/routeParams.d.ts.map +1 -1
- package/dist/routeParams.js +4 -3
- package/dist/runtime.d.ts +10 -6
- package/dist/runtime.d.ts.map +1 -1
- package/dist/runtime.js +32 -18
- package/dist/toast.d.ts +51 -0
- package/dist/toast.d.ts.map +1 -0
- package/dist/toast.js +34 -0
- package/dist/withToast.d.ts +30 -0
- package/dist/withToast.d.ts.map +1 -0
- package/dist/withToast.js +64 -0
- package/examples/streamMutation.ts +72 -0
- package/package.json +48 -50
- package/src/commander.ts +3406 -0
- package/src/{experimental/confirm.ts → confirm.ts} +12 -14
- package/src/errorReporter.ts +65 -75
- package/src/form.ts +61 -18
- package/src/intl.ts +12 -0
- package/src/lib.ts +48 -20
- package/src/makeClient.ts +574 -1134
- package/src/{experimental/makeUseCommand.ts → makeUseCommand.ts} +8 -5
- package/src/mutate.ts +268 -127
- package/src/query.ts +203 -183
- package/src/routeParams.ts +3 -2
- package/src/runtime.ts +46 -21
- package/src/{experimental/toast.ts → toast.ts} +15 -27
- package/src/{experimental/withToast.ts → withToast.ts} +46 -12
- package/test/Mutation.test.ts +181 -24
- package/test/dist/form.test.d.ts.map +1 -1
- package/test/dist/lib.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 +3531 -122
- package/test/dist/stubs.d.ts.map +1 -1
- package/test/dist/stubs.js +187 -32
- 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 +292 -38
- package/test/streamFinal.test.ts +64 -0
- package/test/streamFn.test.ts +457 -0
- package/test/stubs.ts +223 -43
- package/tsconfig.examples.json +20 -0
- package/tsconfig.json +0 -1
- package/tsconfig.json.bak +5 -2
- 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 +0 -19
- 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 +0 -8
- 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/makeClient.ts
CHANGED
|
@@ -1,129 +1,200 @@
|
|
|
1
1
|
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
2
2
|
import { type InvalidateOptions, type InvalidateQueryFilters, isCancelledError, type QueryObserverResult, type RefetchOptions, type UseQueryReturnType } from "@tanstack/vue-query"
|
|
3
3
|
import { camelCase } from "change-case"
|
|
4
|
-
import { Cause, Data, Effect, Exit, Layer, type ManagedRuntime, Match, Option, S, ServiceMap, Struct } from "effect-app"
|
|
5
4
|
import { type ApiClientFactory, type Req } from "effect-app/client"
|
|
6
|
-
import type {
|
|
7
|
-
import {
|
|
8
|
-
import
|
|
9
|
-
import
|
|
10
|
-
import
|
|
5
|
+
import type { ExtractModuleName, HandlerInput, RequestHandlers, RequestHandlerWithInput, RequestsAny, RequestStreamHandlerWithInput } from "effect-app/client/clientFor"
|
|
6
|
+
import type { InvalidationCallback } from "effect-app/client/makeClient"
|
|
7
|
+
import type * as Context from "effect-app/Context"
|
|
8
|
+
import * as Effect from "effect-app/Effect"
|
|
9
|
+
import type * 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"
|
|
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"
|
|
12
17
|
import * as AsyncResult from "effect/unstable/reactivity/AsyncResult"
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import { type
|
|
16
|
-
import {
|
|
17
|
-
import { type
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
18
|
+
import { type ComputedRef, onBeforeUnmount, ref, type WatchSource } from "vue"
|
|
19
|
+
import { type Commander, CommanderStatic, type Progress } from "./commander.js"
|
|
20
|
+
import { type I18n } from "./intl.js"
|
|
21
|
+
import { type CommanderResolved, makeUseCommand } from "./makeUseCommand.js"
|
|
22
|
+
import { makeMutation, makeStreamMutation2, type MutationOptionsBase, useMakeMutation } from "./mutate.js"
|
|
23
|
+
import { type CustomUndefinedInitialQueryOptions, makeQuery, makeStreamQuery } from "./query.js"
|
|
24
|
+
import { makeRunPromise } from "./runtime.js"
|
|
25
|
+
import { type Toast } from "./toast.js"
|
|
26
|
+
|
|
27
|
+
export type { Progress }
|
|
28
|
+
|
|
29
|
+
// TODO: optimize - work from encoded shape directly
|
|
30
|
+
const projectHandler = (
|
|
31
|
+
handler: (i: any) => Effect.Effect<any, any, any>,
|
|
32
|
+
successSchema: S.Top,
|
|
33
|
+
projectionSchema: S.Top
|
|
34
|
+
) => {
|
|
35
|
+
const encode = S.encodeEffect(successSchema)
|
|
36
|
+
const decode = S.decodeEffectConcurrently(projectionSchema)
|
|
37
|
+
return (i: any) => handler(i).pipe(Effect.flatMap(encode), Effect.flatMap(decode))
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
const projectionSchemaHash = (schema: S.Top) => String(Hash.hash(schema.ast))
|
|
41
|
+
|
|
42
|
+
export interface CommandRequestExtensions<RT, Id extends string, I, A, E, R> {
|
|
30
43
|
/** Defines a Command based on this call, taking the `id` of the call as the `id` of the Command.
|
|
31
44
|
* The Request function will be taken as the first member of the Command, the Command required input will be the Request input.
|
|
32
45
|
* see Command.wrap for details */
|
|
33
|
-
wrap:
|
|
46
|
+
wrap: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
47
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
48
|
+
) => Commander.CommanderWrap<RT, Id, I18nKey, State, I, A, E, R>
|
|
34
49
|
/** Defines a Command based on this call, taking the `id` of the call as the `id` of the Command.
|
|
35
50
|
* see Command.fn for details */
|
|
36
|
-
fn:
|
|
51
|
+
fn: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
52
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
53
|
+
) => Commander.CommanderFn<RT, Id, I18nKey, State>
|
|
37
54
|
}
|
|
38
55
|
|
|
39
56
|
/** my other doc */
|
|
40
|
-
export interface
|
|
57
|
+
export interface RequestExt<
|
|
41
58
|
RT,
|
|
42
59
|
Id extends string,
|
|
43
60
|
I,
|
|
44
61
|
A,
|
|
45
62
|
E,
|
|
46
63
|
R
|
|
47
|
-
> extends
|
|
64
|
+
> extends
|
|
65
|
+
Commander.CommandContextLocal<Id, Id>,
|
|
66
|
+
Commander.CommanderWrap<RT, Id, Id, undefined, I, A, E, R>,
|
|
67
|
+
CommandRequestExtensions<RT, Id, I, A, E, R>
|
|
68
|
+
{
|
|
48
69
|
/**
|
|
49
|
-
*
|
|
70
|
+
* Send the request to the endpoint and return the raw Effect response.
|
|
71
|
+
* This does not perform query cache invalidation.
|
|
50
72
|
*/
|
|
51
|
-
(i: I)
|
|
73
|
+
request: (i: I) => Effect.Effect<A, E, R>
|
|
52
74
|
}
|
|
53
75
|
|
|
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
|
-
{
|
|
76
|
+
export type CommandRequestWithExtensions<RT, Req> = Req extends
|
|
77
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer Id> ? RequestExt<RT, Id, I, A, E, R>
|
|
78
|
+
: never
|
|
79
|
+
|
|
80
|
+
export interface QueryExtensions<I, A, E, R> {
|
|
81
|
+
/**
|
|
82
|
+
* Send the request to the endpoint and return the raw Effect response.
|
|
83
|
+
* This does not set up query state tracking.
|
|
84
|
+
*/
|
|
85
|
+
request: (i: I) => Effect.Effect<A, E, R>
|
|
69
86
|
}
|
|
70
87
|
|
|
71
|
-
export type
|
|
72
|
-
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer
|
|
73
|
-
|
|
74
|
-
|
|
88
|
+
export type QueryRequestWithExtensions<Req> = Req extends
|
|
89
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer _Id> ? QueryExtensions<I, A, E, R>
|
|
90
|
+
: never
|
|
91
|
+
|
|
92
|
+
type QueryHandler<Req> = Req extends
|
|
93
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
|
|
94
|
+
? Request["type"] extends "query" ? RequestHandlerWithInput<I, A, E, R, Request, Id> : never
|
|
95
|
+
: never
|
|
96
|
+
|
|
97
|
+
type CommandHandler<Req> = Req extends
|
|
98
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
|
|
99
|
+
? Request["type"] extends "command" ? RequestHandlerWithInput<I, A, E, R, Request, Id> : never
|
|
100
|
+
: never
|
|
101
|
+
|
|
102
|
+
type QueryStreamHandler<Req> = Req extends
|
|
103
|
+
RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id, infer Final>
|
|
104
|
+
? [Request["stream"], Request["type"]] extends [true, "query"]
|
|
105
|
+
? RequestStreamHandlerWithInput<I, A, E, R, Request, Id, Final>
|
|
106
|
+
: never
|
|
107
|
+
: never
|
|
108
|
+
|
|
109
|
+
type CommandStreamHandler<Req> = Req extends
|
|
110
|
+
RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id, infer Final>
|
|
111
|
+
? [Request["stream"], Request["type"]] extends [true, "command"]
|
|
112
|
+
? RequestStreamHandlerWithInput<I, A, E, R, Request, Id, Final>
|
|
113
|
+
: never
|
|
75
114
|
: never
|
|
76
115
|
|
|
77
116
|
export interface MutationExtensions<RT, Id extends string, I, A, E, R> {
|
|
78
117
|
/** Defines a Command based on this mutation, taking the `id` of the mutation as the `id` of the Command.
|
|
79
118
|
* The Mutation function will be taken as the first member of the Command, the Command required input will be the Mutation input.
|
|
80
119
|
* see Command.wrap for details */
|
|
81
|
-
wrap:
|
|
82
|
-
|
|
120
|
+
wrap: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
121
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
122
|
+
) => Commander.CommanderWrap<RT, Id, I18nKey, State, I, A, E, R>
|
|
123
|
+
/** Defines a Command based on this call, taking the `id` of the mutation as the `id` of the Command.
|
|
83
124
|
* 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>
|
|
125
|
+
fn: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
126
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
127
|
+
) => Commander.CommanderFn<RT, Id, I18nKey, State>
|
|
102
128
|
}
|
|
103
129
|
|
|
104
130
|
/**
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
131
|
+
* Send the request to the endpoint and return the raw Effect response.
|
|
132
|
+
* Also invalidates query caches using the request namespace by default.
|
|
133
|
+
* Namespace invalidation targets parent namespace keys
|
|
134
|
+
* (for example `$project/$configuration.get` invalidates `$project`).
|
|
135
|
+
* Override invalidation in client options via `queryInvalidation`.
|
|
136
|
+
*
|
|
137
|
+
* Pass `options` to attach a `select` Effect that runs after the mutation
|
|
138
|
+
* succeeds (its output is returned to the caller) and/or override the default
|
|
139
|
+
* `queryInvalidation`.
|
|
140
|
+
*
|
|
141
|
+
* When `I = void` the input argument may be omitted.
|
|
108
142
|
*/
|
|
109
143
|
export interface MutationExt<
|
|
110
144
|
RT,
|
|
111
145
|
Id extends string,
|
|
146
|
+
I,
|
|
112
147
|
A,
|
|
113
148
|
E,
|
|
114
|
-
R
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
149
|
+
R,
|
|
150
|
+
EA = unknown
|
|
151
|
+
> extends MutationExtensions<RT, Id, I, A, E, R> {
|
|
152
|
+
<B = A, E2 = never, R2 = never>(
|
|
153
|
+
input: I,
|
|
154
|
+
options?: MutationOptionsBase<A, B, E2, R2>
|
|
155
|
+
): Effect.Effect<B, E | E2, R | R2>
|
|
156
|
+
|
|
157
|
+
project: <ProjSchema extends S.Top>(
|
|
158
|
+
schema: EA extends ProjSchema["Encoded"] ? ProjSchema : never
|
|
159
|
+
) => MutationExt<
|
|
160
|
+
RT,
|
|
161
|
+
Id,
|
|
162
|
+
I,
|
|
163
|
+
S.Schema.Type<ProjSchema>,
|
|
164
|
+
E | S.SchemaError,
|
|
165
|
+
R | S.Codec.DecodingServices<ProjSchema>,
|
|
166
|
+
S.Codec.Encoded<ProjSchema>
|
|
167
|
+
>
|
|
121
168
|
}
|
|
122
169
|
|
|
123
170
|
export type MutationWithExtensions<RT, Req> = Req extends
|
|
124
|
-
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer
|
|
125
|
-
?
|
|
126
|
-
:
|
|
171
|
+
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
|
|
172
|
+
? MutationExt<RT, Id, I, A, E, R, S.Codec.Encoded<Request["success"]>>
|
|
173
|
+
: never
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* The `streamFn` builder for a stream-type request handler, using the stream-specific overloads.
|
|
177
|
+
*/
|
|
178
|
+
export type StreamFnStreamExtension<RT, Req> = Req extends
|
|
179
|
+
RequestStreamHandlerWithInput<infer _I, infer _A, infer _E, infer _R, infer _Request, infer Id, infer _Final>
|
|
180
|
+
? <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
181
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
182
|
+
) => Commander.StreamGen<RT, Id, I18nKey, State> & Commander.NonGenStream<RT, Id, I18nKey, State>
|
|
183
|
+
: never
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* `mutate` factory — wraps per-invocation invalidation scaffolding
|
|
187
|
+
* into the stream itself (via `Stream.unwrap`) for use with `streamFn` combinators.
|
|
188
|
+
*/
|
|
189
|
+
export type StreamMutation2WithExtensions<RT, Req> = Req extends
|
|
190
|
+
RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer Id, infer _Final> ?
|
|
191
|
+
& ((input: I) => Stream.Stream<A, E, R>)
|
|
192
|
+
& {
|
|
193
|
+
readonly id: Id
|
|
194
|
+
readonly wrap: <I18nKey extends string = Id, State extends Commander.IntlRecord | undefined = undefined>(
|
|
195
|
+
options?: Commander.FnOptions<Id, I18nKey, State>
|
|
196
|
+
) => Commander.StreamerWrap<RT, Id, I18nKey, State, I, A, E, R>
|
|
197
|
+
}
|
|
127
198
|
: never
|
|
128
199
|
|
|
129
200
|
// we don't really care about the RT, as we are in charge of ensuring runtime safety anyway
|
|
@@ -131,33 +202,50 @@ export type MutationWithExtensions<RT, Req> = Req extends
|
|
|
131
202
|
declare const useQuery_: QueryImpl<any>["useQuery"]
|
|
132
203
|
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
133
204
|
declare const useSuspenseQuery_: QueryImpl<any>["useSuspenseQuery"]
|
|
205
|
+
// eslint-disable-next-line unused-imports/no-unused-vars
|
|
206
|
+
declare const useStreamQuery_: QueryImpl<any>["useStreamQuery"]
|
|
207
|
+
|
|
208
|
+
export interface ProjectResult<RT, I, B, E, R, Request extends Req, Id extends string> {
|
|
209
|
+
request: (i: I) => Effect.Effect<B, E, R>
|
|
210
|
+
query: Exclude<R, RT> extends never ? ReturnType<typeof useQuery_<I, E, B, Request, Id>>
|
|
211
|
+
: MissingDependencies<RT, R> & {}
|
|
212
|
+
suspense: Exclude<R, RT> extends never ? ReturnType<typeof useSuspenseQuery_<I, E, B, Request, Id>>
|
|
213
|
+
: MissingDependencies<RT, R> & {}
|
|
214
|
+
}
|
|
134
215
|
|
|
135
|
-
export
|
|
216
|
+
export type QueryProjection<RT, HandlerReq> = HandlerReq extends
|
|
217
|
+
RequestHandlerWithInput<infer I, infer _A, infer E, infer R, infer Request, infer Id>
|
|
218
|
+
? Request["type"] extends "query" ? {
|
|
219
|
+
project: <ProjSchema extends S.Top>(
|
|
220
|
+
schema: S.Codec.Encoded<Request["success"]> extends ProjSchema["Encoded"] ? ProjSchema : never
|
|
221
|
+
) => ProjectResult<
|
|
222
|
+
RT,
|
|
223
|
+
I,
|
|
224
|
+
S.Schema.Type<ProjSchema>,
|
|
225
|
+
E | S.SchemaError,
|
|
226
|
+
R | S.Codec.DecodingServices<ProjSchema>,
|
|
227
|
+
Request,
|
|
228
|
+
Id
|
|
229
|
+
>
|
|
230
|
+
}
|
|
231
|
+
: {}
|
|
232
|
+
: {}
|
|
233
|
+
|
|
234
|
+
export interface QueryResultExtensions<Request extends Req, Id extends string, I, A, E> {
|
|
136
235
|
/**
|
|
137
|
-
*
|
|
236
|
+
* Read helper for query requests.
|
|
237
|
+
* Runs as a tracked Vue Query and returns reactive state.
|
|
238
|
+
* Queries read state and should not be used to mutate it.
|
|
239
|
+
* When `I = void` the input argument may be omitted.
|
|
138
240
|
*/
|
|
139
241
|
query: ReturnType<typeof useQuery_<I, E, A, Request, Id>>
|
|
140
242
|
// TODO or suspense as Option?
|
|
141
243
|
/**
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* So that Suspense and error boundaries can be used.
|
|
244
|
+
* Like `.query`, but returns a Promise for setup-time awaiting.
|
|
245
|
+
* Use this when integrating with Vue Suspense / error boundaries.
|
|
145
246
|
*/
|
|
146
247
|
suspense: ReturnType<typeof useSuspenseQuery_<I, E, A, Request, Id>>
|
|
147
248
|
}
|
|
148
|
-
export interface QueriesWithoutInput<Request extends Req, Id extends string, A, E> {
|
|
149
|
-
/**
|
|
150
|
-
* Effect results are passed to the caller, including errors.
|
|
151
|
-
*/
|
|
152
|
-
query: ReturnType<typeof useQuery_<E, A, Request, Id>>
|
|
153
|
-
// TODO or suspense as Option?
|
|
154
|
-
/**
|
|
155
|
-
* The difference with useQuery is that this function will return a Promise you can await in the Setup,
|
|
156
|
-
* which ensures that either there always is a latest value, or an error occurs on load.
|
|
157
|
-
* So that Suspense and error boundaries can be used.
|
|
158
|
-
*/
|
|
159
|
-
suspense: ReturnType<typeof useSuspenseQuery_<E, A, Request, Id>>
|
|
160
|
-
}
|
|
161
249
|
|
|
162
250
|
export type MissingDependencies<RT, R> = {
|
|
163
251
|
message: "Dependencies required that are not provided by the runtime"
|
|
@@ -166,184 +254,40 @@ export type MissingDependencies<RT, R> = {
|
|
|
166
254
|
|
|
167
255
|
export type Queries<RT, Req> = Req extends
|
|
168
256
|
RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
|
|
169
|
-
? Exclude<R, RT> extends never ?
|
|
170
|
-
: {
|
|
171
|
-
query: MissingDependencies<RT, R> & {}
|
|
172
|
-
suspense: MissingDependencies<RT, R> & {}
|
|
173
|
-
}
|
|
174
|
-
: Req extends RequestHandler<infer A, infer E, infer R, infer Request, infer Id>
|
|
175
|
-
? Exclude<R, RT> extends never ? QueriesWithoutInput<Request, Id, A, E>
|
|
257
|
+
? Request["type"] extends "query" ? Exclude<R, RT> extends never ? QueryResultExtensions<Request, Id, I, A, E>
|
|
176
258
|
: { query: MissingDependencies<RT, R> & {}; suspense: MissingDependencies<RT, R> & {} }
|
|
177
259
|
: never
|
|
260
|
+
: never
|
|
178
261
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
export interface Opts<
|
|
189
|
-
A,
|
|
190
|
-
E,
|
|
191
|
-
R,
|
|
192
|
-
I = void,
|
|
193
|
-
A2 = A,
|
|
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
|
|
262
|
+
export interface StreamQueryExtensions<Request extends Req, Id extends string, I, A, E> {
|
|
263
|
+
/**
|
|
264
|
+
* Stream helper for query-stream requests.
|
|
265
|
+
* Runs as a tracked Vue Query and returns reactive state with accumulated chunks.
|
|
266
|
+
* Data is an array of all chunks received so far.
|
|
267
|
+
* When `I = void` the input argument may be omitted.
|
|
268
|
+
*/
|
|
269
|
+
query: ReturnType<typeof useStreamQuery_<I, E, A, Request, Id>>
|
|
249
270
|
}
|
|
271
|
+
export type StreamQueries<RT, HandlerReq> = HandlerReq extends
|
|
272
|
+
RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id, infer _Final>
|
|
273
|
+
? Exclude<R, RT> extends never ? StreamQueryExtensions<Request, Id, I, A, E>
|
|
274
|
+
: { query: MissingDependencies<RT, R> & {} }
|
|
275
|
+
: never
|
|
250
276
|
|
|
251
|
-
|
|
252
|
-
// object for the returned value from the getter.
|
|
253
|
-
|
|
254
|
-
type Resp<I, A, E, R, V = ComputedRef<Res<A, E>>> = readonly [
|
|
255
|
-
V,
|
|
256
|
-
WithAction<(I: I) => Effect.Effect<Exit.Exit<A, E>, never, R>>
|
|
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>
|
|
286
|
-
}
|
|
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
|
-
}
|
|
311
|
-
|
|
312
|
-
const extra = {
|
|
313
|
-
action,
|
|
314
|
-
message: `Unexpected Error trying to ${action}`
|
|
315
|
-
}
|
|
316
|
-
yield* reportRuntimeError(cause, extra)
|
|
277
|
+
const _useMutation = makeMutation()
|
|
317
278
|
|
|
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
|
-
)
|
|
279
|
+
const wrapWithSpan = (self: { id: string }, mut: any) => {
|
|
280
|
+
const span = (eff: Effect.Effect<any, any, any>) =>
|
|
281
|
+
Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })(eff)
|
|
282
|
+
return (input: any, options?: MutationOptionsBase) => span(mut(input, options))
|
|
337
283
|
}
|
|
338
284
|
|
|
339
|
-
const _useMutation = makeMutation()
|
|
340
|
-
|
|
341
285
|
/**
|
|
342
286
|
* Pass an Effect or a function that returns an Effect, e.g from a client action
|
|
343
287
|
* Executes query cache invalidation based on default rules or provided option.
|
|
344
288
|
* adds a span with the mutation id
|
|
345
289
|
*/
|
|
346
|
-
export const useMutation: typeof _useMutation = <
|
|
290
|
+
export const useMutation: typeof _useMutation = (<
|
|
347
291
|
I,
|
|
348
292
|
E,
|
|
349
293
|
A,
|
|
@@ -351,16 +295,12 @@ export const useMutation: typeof _useMutation = <
|
|
|
351
295
|
Request extends Req,
|
|
352
296
|
Name extends string
|
|
353
297
|
>(
|
|
354
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
355
|
-
options?: MutationOptionsBase
|
|
298
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
356
299
|
) =>
|
|
357
300
|
Object.assign(
|
|
358
|
-
|
|
359
|
-
_useMutation(self as any, options),
|
|
360
|
-
Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })
|
|
361
|
-
) as any,
|
|
301
|
+
wrapWithSpan(self, _useMutation(self as any)),
|
|
362
302
|
{ id: self.id }
|
|
363
|
-
)
|
|
303
|
+
)) as any
|
|
364
304
|
|
|
365
305
|
/**
|
|
366
306
|
* Pass an Effect or a function that returns an Effect, e.g from a client action
|
|
@@ -369,7 +309,7 @@ export const useMutation: typeof _useMutation = <
|
|
|
369
309
|
*/
|
|
370
310
|
export const useMutationInt = (): typeof _useMutation => {
|
|
371
311
|
const _useMutation = useMakeMutation()
|
|
372
|
-
return <
|
|
312
|
+
return (<
|
|
373
313
|
I,
|
|
374
314
|
E,
|
|
375
315
|
A,
|
|
@@ -377,715 +317,20 @@ export const useMutationInt = (): typeof _useMutation => {
|
|
|
377
317
|
Request extends Req,
|
|
378
318
|
Name extends string
|
|
379
319
|
>(
|
|
380
|
-
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
381
|
-
options?: MutationOptionsBase
|
|
320
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
382
321
|
) =>
|
|
383
322
|
Object.assign(
|
|
384
|
-
|
|
385
|
-
_useMutation(self as any, options),
|
|
386
|
-
Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })
|
|
387
|
-
) as any,
|
|
323
|
+
wrapWithSpan(self, _useMutation(self as any)),
|
|
388
324
|
{ id: self.id }
|
|
389
|
-
)
|
|
390
|
-
}
|
|
391
|
-
|
|
392
|
-
export class LegacyMutationImpl<RT> {
|
|
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
|
-
}
|
|
588
|
-
|
|
589
|
-
/**
|
|
590
|
-
* Pass a function that returns an Effect, e.g from a client action, give it a name.
|
|
591
|
-
* Returns a tuple with raw Result and execution function which reports success and errors as Toast.
|
|
592
|
-
* @deprecated use `Command.fn` and friends instead
|
|
593
|
-
*/
|
|
594
|
-
readonly useAndHandleMutationResult: {
|
|
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)
|
|
672
|
-
|
|
673
|
-
return tuple(
|
|
674
|
-
a,
|
|
675
|
-
handleRequestWithToast(b as any, self.id, action, options)
|
|
676
|
-
)
|
|
677
|
-
}
|
|
678
|
-
//
|
|
679
|
-
|
|
680
|
-
/**
|
|
681
|
-
* Pass a function that returns an Effect, e.g from a client action, give it a name.
|
|
682
|
-
* Returns a tuple with state ref and execution function which reports success and errors as Toast.
|
|
683
|
-
*
|
|
684
|
-
* @deprecated use `Command.fn` and friends instead
|
|
685
|
-
*/
|
|
686
|
-
readonly useAndHandleMutation: {
|
|
687
|
-
/**
|
|
688
|
-
* Pass a function that returns an Effect, e.g from a client action, give it a name.
|
|
689
|
-
* Returns a tuple with state ref and execution function which reports success and errors as Toast.
|
|
690
|
-
*
|
|
691
|
-
* @deprecated use `Command.fn` and friends instead
|
|
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
|
-
)
|
|
751
|
-
}
|
|
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
|
-
/**
|
|
808
|
-
* The same as @see useAndHandleMutation, but does not display any toasts by default.
|
|
809
|
-
* Messages for success, error and defect toasts can be provided in the Options.
|
|
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
|
|
874
|
-
*/
|
|
875
|
-
readonly useAndHandleMutationCustom: {
|
|
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)
|
|
941
|
-
|
|
942
|
-
type MH = NonNullable<NonNullable<typeof options>["mapHandler"]>
|
|
943
|
-
const mh = options?.mapHandler ?? identity as MH
|
|
944
|
-
|
|
945
|
-
const [a, b] = asResult(
|
|
946
|
-
mapHandler(
|
|
947
|
-
mapHandler(unsafe as any, mh),
|
|
948
|
-
Effect.tapCauseIf(Cause.hasDies, (cause) => reportRuntimeError(cause))
|
|
949
|
-
) as any
|
|
950
|
-
)
|
|
951
|
-
|
|
952
|
-
return tuple(
|
|
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
|
-
}
|
|
962
|
-
|
|
963
|
-
/**
|
|
964
|
-
* Effect results are converted to Exit, so errors are ignored by default.
|
|
965
|
-
* you should use the result ref to render errors!
|
|
966
|
-
* @deprecated use `Command.fn` and friends instead
|
|
967
|
-
*/
|
|
968
|
-
readonly useSafeMutationWithState: {
|
|
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)
|
|
998
|
-
|
|
999
|
-
return tuple(
|
|
1000
|
-
computed(() => mutationResultToVue(a.value)),
|
|
1001
|
-
b
|
|
1002
|
-
) as any
|
|
1003
|
-
}
|
|
1004
|
-
|
|
1005
|
-
/** @deprecated use OmegaForm */
|
|
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
|
|
1076
|
-
|
|
1077
|
-
return <R>(getRuntime: () => ServiceMap.ServiceMap<R>) => new LegacyMutationImpl(getRuntime, toast, intl)
|
|
1078
|
-
})
|
|
1079
|
-
}) {
|
|
1080
|
-
static readonly DefaultWithoutDependencies = Layer.effect(this, this.make)
|
|
1081
|
-
static readonly Default = this.DefaultWithoutDependencies
|
|
325
|
+
)) as any
|
|
1082
326
|
}
|
|
1083
327
|
|
|
1084
|
-
export type ClientFrom<M extends
|
|
328
|
+
export type ClientFrom<M extends RequestsAny> = RequestHandlers<never, never, M, ExtractModuleName<M>>
|
|
1085
329
|
|
|
1086
330
|
export class QueryImpl<R> {
|
|
1087
|
-
constructor(readonly getRuntime: () =>
|
|
331
|
+
constructor(readonly getRuntime: () => Context.Context<R>) {
|
|
1088
332
|
this.useQuery = makeQuery(this.getRuntime)
|
|
333
|
+
this.useStreamQuery = makeStreamQuery(this.getRuntime)
|
|
1089
334
|
}
|
|
1090
335
|
/**
|
|
1091
336
|
* Effect results are passed to the caller, including errors.
|
|
@@ -1093,6 +338,12 @@ export class QueryImpl<R> {
|
|
|
1093
338
|
*/
|
|
1094
339
|
readonly useQuery: ReturnType<typeof makeQuery<R>>
|
|
1095
340
|
|
|
341
|
+
/**
|
|
342
|
+
* Stream results are accumulated as an array of chunks and returned as reactive state.
|
|
343
|
+
* @deprecated use client helpers instead (.query())
|
|
344
|
+
*/
|
|
345
|
+
readonly useStreamQuery: ReturnType<typeof makeStreamQuery<R>>
|
|
346
|
+
|
|
1096
347
|
/**
|
|
1097
348
|
* The difference with useQuery is that this function will return a Promise you can await in the Setup,
|
|
1098
349
|
* which ensures that either there always is a latest value, or an error occurs on load.
|
|
@@ -1104,52 +355,18 @@ export class QueryImpl<R> {
|
|
|
1104
355
|
* The difference with useQuery is that this function will return a Promise you can await in the Setup,
|
|
1105
356
|
* which ensures that either there always is a latest value, or an error occurs on load.
|
|
1106
357
|
* So that Suspense and error boundaries can be used.
|
|
1107
|
-
*
|
|
358
|
+
* When `I = void` the input argument may be omitted.
|
|
1108
359
|
*/
|
|
1109
360
|
<
|
|
361
|
+
I,
|
|
1110
362
|
E,
|
|
1111
363
|
A,
|
|
1112
364
|
Request extends Req,
|
|
1113
365
|
Name extends string
|
|
1114
366
|
>(
|
|
1115
|
-
self:
|
|
1116
|
-
): {
|
|
1117
|
-
/**
|
|
1118
|
-
* The difference with useQuery is that this function will return a Promise you can await in the Setup,
|
|
1119
|
-
* which ensures that either there always is a latest value, or an error occurs on load.
|
|
1120
|
-
* So that Suspense and error boundaries can be used.
|
|
1121
|
-
*/
|
|
1122
|
-
<TData = A>(options?: CustomUndefinedInitialQueryOptions<A, E, TData>): Promise<
|
|
1123
|
-
readonly [
|
|
1124
|
-
ComputedRef<AsyncResult.AsyncResult<TData, E>>,
|
|
1125
|
-
ComputedRef<TData>,
|
|
1126
|
-
(
|
|
1127
|
-
options?: RefetchOptions
|
|
1128
|
-
) => Effect.Effect<QueryObserverResult<TData, E>>,
|
|
1129
|
-
UseQueryReturnType<any, any>
|
|
1130
|
-
]
|
|
1131
|
-
>
|
|
1132
|
-
}
|
|
1133
|
-
/**
|
|
1134
|
-
* The difference with useQuery is that this function will return a Promise you can await in the Setup,
|
|
1135
|
-
* which ensures that either there always is a latest value, or an error occurs on load.
|
|
1136
|
-
* So that Suspense and error boundaries can be used.
|
|
1137
|
-
*/
|
|
1138
|
-
<
|
|
1139
|
-
Arg,
|
|
1140
|
-
E,
|
|
1141
|
-
A,
|
|
1142
|
-
Request extends Req,
|
|
1143
|
-
Name extends string
|
|
1144
|
-
>(
|
|
1145
|
-
self: RequestHandlerWithInput<Arg, A, E, R, Request, Name>
|
|
367
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
1146
368
|
): {
|
|
1147
|
-
|
|
1148
|
-
* The difference with useQuery is that this function will return a Promise you can await in the Setup,
|
|
1149
|
-
* which ensures that either there always is a latest value, or an error occurs on load.
|
|
1150
|
-
* So that Suspense and error boundaries can be used.
|
|
1151
|
-
*/
|
|
1152
|
-
<TData = A>(arg: Arg | WatchSource<Arg>, options?: CustomUndefinedInitialQueryOptions<A, E, TData>): Promise<
|
|
369
|
+
<TData = A>(arg: I | WatchSource<I>, options?: CustomUndefinedInitialQueryOptions<A, E, TData>): Promise<
|
|
1153
370
|
readonly [
|
|
1154
371
|
ComputedRef<AsyncResult.AsyncResult<TData, E>>,
|
|
1155
372
|
ComputedRef<TData>,
|
|
@@ -1160,10 +377,10 @@ export class QueryImpl<R> {
|
|
|
1160
377
|
]
|
|
1161
378
|
>
|
|
1162
379
|
}
|
|
1163
|
-
} = <
|
|
1164
|
-
self: RequestHandlerWithInput<
|
|
380
|
+
} = <I, E, A, Request extends Req, Name extends string>(
|
|
381
|
+
self: RequestHandlerWithInput<I, A, E, R, Request, Name>
|
|
1165
382
|
) => {
|
|
1166
|
-
const runPromise =
|
|
383
|
+
const runPromise = makeRunPromise(this.getRuntime())
|
|
1167
384
|
const q = this.useQuery(self as any) as any
|
|
1168
385
|
return (argOrOptions?: any, options?: any) => {
|
|
1169
386
|
const [resultRef, latestRef, fetch, uqrt] = q(argOrOptions, { ...options, suspense: true } // experimental_prefetchInRender: true }
|
|
@@ -1214,10 +431,64 @@ export class QueryImpl<R> {
|
|
|
1214
431
|
}
|
|
1215
432
|
|
|
1216
433
|
// 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.
|
|
434
|
+
const managedRuntimeRt = <A, E>(mrt: ManagedRuntime.ManagedRuntime<A, E>) => mrt.runSync(Effect.context<A>())
|
|
1218
435
|
|
|
1219
436
|
type Base = I18n | Toast
|
|
1220
|
-
type Mix = ApiClientFactory | Commander |
|
|
437
|
+
type Mix = ApiClientFactory | Commander | Base
|
|
438
|
+
|
|
439
|
+
type InvalidationResources = Record<string, Record<string, unknown>>
|
|
440
|
+
type UnionToIntersection<U> = (U extends unknown ? (arg: U) => void : never) extends ((arg: infer I) => void) ? I
|
|
441
|
+
: never
|
|
442
|
+
|
|
443
|
+
type CommandInvalidationResources<Req> = Req extends {
|
|
444
|
+
readonly type: "command"
|
|
445
|
+
readonly "~invalidationResources"?: infer Resources
|
|
446
|
+
} ? NonNullable<Resources> extends InvalidationResources ? NonNullable<Resources> : never
|
|
447
|
+
: Req extends {
|
|
448
|
+
readonly type: "command"
|
|
449
|
+
readonly config?: infer Config
|
|
450
|
+
} ? Config extends {
|
|
451
|
+
readonly invalidationResources?: infer LegacyResources
|
|
452
|
+
} ? NonNullable<LegacyResources> extends InvalidationResources ? NonNullable<LegacyResources> : never
|
|
453
|
+
: Config extends {
|
|
454
|
+
readonly invalidatesQueries?: InvalidationCallback<infer LegacyResources, any, any, any>
|
|
455
|
+
} ? NonNullable<LegacyResources> extends InvalidationResources ? NonNullable<LegacyResources> : never
|
|
456
|
+
: never
|
|
457
|
+
: never
|
|
458
|
+
|
|
459
|
+
type InvalidationResourcesForUnion<M extends RequestsAny> = {
|
|
460
|
+
[K in keyof M]: CommandInvalidationResources<M[K]>
|
|
461
|
+
}[keyof M]
|
|
462
|
+
|
|
463
|
+
type InvalidationResourcesFor<M extends RequestsAny> = [InvalidationResourcesForUnion<M>] extends [never] ? never
|
|
464
|
+
: UnionToIntersection<InvalidationResourcesForUnion<M>> extends infer R ? R extends InvalidationResources ? R
|
|
465
|
+
: never
|
|
466
|
+
: never
|
|
467
|
+
|
|
468
|
+
type QueryInvalidationFactory<M extends RequestsAny> = (client: ClientFrom<M>) => QueryInvalidation<M>
|
|
469
|
+
|
|
470
|
+
type StrictResourcesArg<Shape, Actual extends Shape = Shape> =
|
|
471
|
+
& Actual
|
|
472
|
+
& Record<Exclude<keyof Actual, keyof Shape>, never>
|
|
473
|
+
|
|
474
|
+
type ClientForArgs<
|
|
475
|
+
M extends RequestsAny,
|
|
476
|
+
Resources extends InvalidationResourcesFor<M> = InvalidationResourcesFor<M>
|
|
477
|
+
> = [InvalidationResourcesFor<M>] extends [never] ? [
|
|
478
|
+
queryInvalidation?: QueryInvalidationFactory<M>,
|
|
479
|
+
invalidationResources?: StrictResourcesArg<
|
|
480
|
+
InvalidationResourcesFor<M>,
|
|
481
|
+
Resources
|
|
482
|
+
>
|
|
483
|
+
]
|
|
484
|
+
: [
|
|
485
|
+
queryInvalidation: QueryInvalidationFactory<M> | undefined,
|
|
486
|
+
invalidationResources: StrictResourcesArg<
|
|
487
|
+
InvalidationResourcesFor<M>,
|
|
488
|
+
Resources
|
|
489
|
+
>
|
|
490
|
+
]
|
|
491
|
+
|
|
1221
492
|
export const makeClient = <RT_, RTHooks>(
|
|
1222
493
|
// global, but only accessible after startup has completed
|
|
1223
494
|
getBaseMrt: () => ManagedRuntime.ManagedRuntime<RT_ | Mix, never>,
|
|
@@ -1225,126 +496,188 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1225
496
|
rtHooks: Layer.Layer<RTHooks, never, Mix>
|
|
1226
497
|
) => {
|
|
1227
498
|
type RT = RT_ | Mix
|
|
1228
|
-
const getRt = Effect.services<RT>()
|
|
1229
499
|
const getBaseRt = () => managedRuntimeRt(getBaseMrt())
|
|
1230
500
|
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
501
|
let cmd: Effect.Success<typeof makeCommand>
|
|
1237
502
|
const useCommand = () => cmd ??= getBaseMrt().runSync(makeCommand)
|
|
1238
|
-
let mut: Effect.Success<typeof makeMutation>
|
|
1239
|
-
const getMutation = () => mut ??= getBaseMrt().runSync(makeMutation)
|
|
1240
503
|
|
|
1241
504
|
let m: ReturnType<typeof useMutationInt>
|
|
1242
505
|
const useMutation = () => m ??= useMutationInt()
|
|
1243
506
|
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
"useAndHandleMutation",
|
|
1247
|
-
"useAndHandleMutationResult",
|
|
1248
|
-
"useAndHandleMutationSilently",
|
|
1249
|
-
"useAndHandleMutationCustom",
|
|
1250
|
-
"makeUseAndHandleMutation",
|
|
1251
|
-
"useHandleRequestWithToast",
|
|
1252
|
-
"buildFormFromSchema",
|
|
1253
|
-
"useSafeMutation"
|
|
1254
|
-
] as const satisfies readonly (keyof ReturnType<typeof getMutation>)[]
|
|
1255
|
-
type mut = Pick<LegacyMutationImpl<RT>, typeof keys[number]>
|
|
1256
|
-
|
|
1257
|
-
const mutations = keys.reduce(
|
|
1258
|
-
(prev, cur) => {
|
|
1259
|
-
;(prev as any)[cur] = ((...args: [any]) => {
|
|
1260
|
-
return (getMutation() as any)[cur](...args)
|
|
1261
|
-
}) as any
|
|
1262
|
-
return prev
|
|
1263
|
-
},
|
|
1264
|
-
{} as Pick<LegacyMutationImpl<RT>, typeof keys[number]>
|
|
1265
|
-
)
|
|
507
|
+
let sm2: ReturnType<typeof makeStreamMutation2>
|
|
508
|
+
const useStreamMutation2 = () => sm2 ??= makeStreamMutation2()
|
|
1266
509
|
|
|
1267
510
|
const query = new QueryImpl(getBaseRt)
|
|
1268
511
|
const useQuery = query.useQuery
|
|
1269
512
|
const useSuspenseQuery = query.useSuspenseQuery
|
|
513
|
+
const useStreamQuery = query.useStreamQuery
|
|
514
|
+
|
|
515
|
+
const mergeInvalidation = (
|
|
516
|
+
a?: MutationOptionsBase["queryInvalidation"],
|
|
517
|
+
b?: MutationOptionsBase["queryInvalidation"]
|
|
518
|
+
): MutationOptionsBase["queryInvalidation"] | undefined => {
|
|
519
|
+
if (!a && !b) {
|
|
520
|
+
return undefined
|
|
521
|
+
}
|
|
522
|
+
return (defaultKey, name, input, output) => [
|
|
523
|
+
...(a?.(defaultKey, name, input, output) ?? []),
|
|
524
|
+
...(b?.(defaultKey, name, input, output) ?? [])
|
|
525
|
+
]
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
const withDefaultInvalidation = (
|
|
529
|
+
mut: any,
|
|
530
|
+
defaultInvalidation?: MutationOptionsBase["queryInvalidation"]
|
|
531
|
+
) => {
|
|
532
|
+
if (!defaultInvalidation) return mut
|
|
533
|
+
const apply = (callerOpts?: MutationOptionsBase) => ({
|
|
534
|
+
...callerOpts,
|
|
535
|
+
queryInvalidation: callerOpts?.queryInvalidation
|
|
536
|
+
? mergeInvalidation(defaultInvalidation, callerOpts.queryInvalidation)
|
|
537
|
+
: defaultInvalidation
|
|
538
|
+
})
|
|
539
|
+
return (input: any, callerOpts?: MutationOptionsBase) => mut(input, apply(callerOpts))
|
|
540
|
+
}
|
|
1270
541
|
|
|
1271
|
-
const
|
|
542
|
+
const makeQueryResources = <Resources extends InvalidationResources>(resources: Resources | undefined) => {
|
|
543
|
+
if (!resources) {
|
|
544
|
+
return {} as Record<string, Record<string, unknown>>
|
|
545
|
+
}
|
|
546
|
+
return resources as Record<string, Record<string, unknown>>
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
const mapQuery = <M extends RequestsAny>(
|
|
1272
550
|
client: ClientFrom<M>
|
|
1273
551
|
) => {
|
|
1274
552
|
const queries = Struct.keys(client).reduce(
|
|
1275
553
|
(acc, key) => {
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
554
|
+
const requestType = client[key].Request.type
|
|
555
|
+
const isStream = client[key].Request.stream
|
|
556
|
+
if (requestType === "query" && !isStream) {
|
|
557
|
+
;(acc as any)[camelCase(key) + "Query"] = Object.assign(useQuery(client[key] as any), {
|
|
558
|
+
id: client[key].id
|
|
559
|
+
})
|
|
560
|
+
;(acc as any)[camelCase(key) + "SuspenseQuery"] = Object.assign(useSuspenseQuery(client[key] as any), {
|
|
561
|
+
id: client[key].id
|
|
562
|
+
})
|
|
563
|
+
} else if (requestType === "query" && isStream) {
|
|
564
|
+
;(acc as any)[camelCase(key) + "Query"] = Object.assign(useStreamQuery(client[key] as any), {
|
|
565
|
+
id: client[key].id
|
|
566
|
+
})
|
|
567
|
+
}
|
|
1282
568
|
return acc
|
|
1283
569
|
},
|
|
1284
570
|
{} as
|
|
1285
571
|
& {
|
|
1286
572
|
// apparently can't get JSDoc in here..
|
|
1287
|
-
[
|
|
573
|
+
[
|
|
574
|
+
Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
|
|
575
|
+
: `${ToCamel<string & Key>}Query`
|
|
576
|
+
]: Queries<RT, QueryHandler<typeof client[Key]>>["query"]
|
|
1288
577
|
}
|
|
1289
578
|
// todo: or suspense as an Option?
|
|
1290
579
|
& {
|
|
1291
580
|
// apparently can't get JSDoc in here..
|
|
1292
|
-
[
|
|
581
|
+
[
|
|
582
|
+
Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
|
|
583
|
+
: `${ToCamel<string & Key>}SuspenseQuery`
|
|
584
|
+
]: Queries<
|
|
1293
585
|
RT,
|
|
1294
|
-
typeof client[Key]
|
|
586
|
+
QueryHandler<typeof client[Key]>
|
|
1295
587
|
>["suspense"]
|
|
1296
588
|
}
|
|
589
|
+
& {
|
|
590
|
+
[
|
|
591
|
+
Key in keyof typeof client as QueryStreamHandler<typeof client[Key]> extends never ? never
|
|
592
|
+
: `${ToCamel<string & Key>}Query`
|
|
593
|
+
]: StreamQueries<RT, QueryStreamHandler<typeof client[Key]>>["query"]
|
|
594
|
+
}
|
|
1297
595
|
)
|
|
1298
596
|
return queries
|
|
1299
597
|
}
|
|
1300
598
|
|
|
1301
|
-
const mapRequest = <M extends
|
|
599
|
+
const mapRequest = <M extends RequestsAny>(
|
|
1302
600
|
client: ClientFrom<M>
|
|
1303
601
|
) => {
|
|
1304
602
|
const Command = useCommand()
|
|
1305
603
|
const mutations = Struct.keys(client).reduce(
|
|
1306
604
|
(acc, key) => {
|
|
605
|
+
if (!(client[key].Request.type === "command" && !client[key].Request.stream)) {
|
|
606
|
+
return acc
|
|
607
|
+
}
|
|
1307
608
|
const mut = client[key].handler
|
|
1308
|
-
const
|
|
1309
|
-
const
|
|
609
|
+
const request = mut
|
|
610
|
+
const fn = (options?: any) => Command.fn(client[key].id, options)
|
|
611
|
+
const wrap = (options?: any) => Command.wrap({ mutate: request, id: client[key].id }, options)
|
|
1310
612
|
;(acc as any)[camelCase(key) + "Request"] = Object.assign(
|
|
1311
613
|
mut,
|
|
1312
|
-
fn, // to get the i18n key etc.
|
|
1313
|
-
{ wrap, fn }
|
|
614
|
+
Command.fn(client[key].id), // to get the i18n key etc.
|
|
615
|
+
{ wrap, fn, request }
|
|
1314
616
|
)
|
|
1315
617
|
return acc
|
|
1316
618
|
},
|
|
1317
619
|
{} as {
|
|
1318
|
-
[
|
|
620
|
+
[
|
|
621
|
+
Key in keyof typeof client as CommandHandler<typeof client[Key]> extends never ? never
|
|
622
|
+
: `${ToCamel<string & Key>}Request`
|
|
623
|
+
]: CommandRequestWithExtensions<
|
|
1319
624
|
RT | RTHooks,
|
|
1320
|
-
typeof client[Key]
|
|
625
|
+
CommandHandler<typeof client[Key]>
|
|
1321
626
|
>
|
|
1322
627
|
}
|
|
1323
628
|
)
|
|
1324
629
|
return mutations
|
|
1325
630
|
}
|
|
1326
631
|
|
|
1327
|
-
const mapMutation = <M extends
|
|
1328
|
-
client: ClientFrom<M
|
|
632
|
+
const mapMutation = <M extends RequestsAny>(
|
|
633
|
+
client: ClientFrom<M>,
|
|
634
|
+
queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>,
|
|
635
|
+
invalidationResources?: InvalidationResourcesFor<M>
|
|
1329
636
|
) => {
|
|
1330
637
|
const Command = useCommand()
|
|
1331
638
|
const mutation = useMutation()
|
|
639
|
+
const invalidation = queryInvalidation?.(client)
|
|
640
|
+
const queryResources = makeQueryResources(invalidationResources)
|
|
1332
641
|
const mutations = Struct.keys(client).reduce(
|
|
1333
642
|
(acc, key) => {
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
643
|
+
if (!(client[key].Request.type === "command" && !client[key].Request.stream)) {
|
|
644
|
+
return acc
|
|
645
|
+
}
|
|
646
|
+
const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
|
|
647
|
+
| InvalidationCallback<InvalidationResourcesFor<M>>
|
|
648
|
+
| undefined
|
|
649
|
+
const fromRequest = fromRequestConfig
|
|
650
|
+
? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
|
|
651
|
+
fromRequestConfig(defaultKey, queryResources as never, input as never, output as never).map((entry) => ({
|
|
652
|
+
filters: entry.filters,
|
|
653
|
+
options: entry.options
|
|
654
|
+
})))
|
|
655
|
+
: undefined
|
|
656
|
+
const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
|
|
657
|
+
const makeProjectedMutation = (handler: any): any => {
|
|
658
|
+
const mut: any = withDefaultInvalidation(mutation(handler), mergedInvalidation)
|
|
659
|
+
return Object.assign(mut, {
|
|
660
|
+
wrap: (options?: any) => Command.wrap({ mutate: mut, id: client[key].id }, options),
|
|
661
|
+
fn: (options?: any) => Command.fn(client[key].id, options),
|
|
662
|
+
project: (projectionSchema: any) => {
|
|
663
|
+
const projected = {
|
|
664
|
+
...handler,
|
|
665
|
+
handler: projectHandler(handler.handler, client[key].Request.success, projectionSchema)
|
|
666
|
+
}
|
|
667
|
+
return makeProjectedMutation(projected)
|
|
668
|
+
}
|
|
669
|
+
})
|
|
670
|
+
}
|
|
671
|
+
;(acc as any)[camelCase(key) + "Mutation"] = makeProjectedMutation(client[key] as any)
|
|
1342
672
|
return acc
|
|
1343
673
|
},
|
|
1344
674
|
{} as {
|
|
1345
|
-
[
|
|
675
|
+
[
|
|
676
|
+
Key in keyof typeof client as CommandHandler<typeof client[Key]> extends never ? never
|
|
677
|
+
: `${ToCamel<string & Key>}Mutation`
|
|
678
|
+
]: MutationWithExtensions<
|
|
1346
679
|
RT | RTHooks,
|
|
1347
|
-
typeof client[Key]
|
|
680
|
+
CommandHandler<typeof client[Key]>
|
|
1348
681
|
>
|
|
1349
682
|
}
|
|
1350
683
|
)
|
|
@@ -1353,8 +686,9 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1353
686
|
|
|
1354
687
|
// make available .query, .suspense and .mutate for each operation
|
|
1355
688
|
// and a .helpers with all mutations and queries
|
|
1356
|
-
const mapClient = <M extends
|
|
1357
|
-
queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M
|
|
689
|
+
const mapClient = <M extends RequestsAny>(
|
|
690
|
+
queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>,
|
|
691
|
+
invalidationResources?: InvalidationResourcesFor<M>
|
|
1358
692
|
) =>
|
|
1359
693
|
(
|
|
1360
694
|
client: ClientFrom<M>
|
|
@@ -1362,71 +696,179 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1362
696
|
const Command = useCommand()
|
|
1363
697
|
const mutation = useMutation()
|
|
1364
698
|
const invalidation = queryInvalidation?.(client)
|
|
699
|
+
const queryResources = makeQueryResources(invalidationResources)
|
|
1365
700
|
const extended = Struct.keys(client).reduce(
|
|
1366
701
|
(acc, key) => {
|
|
702
|
+
const requestType = client[key].Request.type
|
|
703
|
+
const isStream = client[key].Request.stream
|
|
1367
704
|
const fn = Command.fn(client[key].id)
|
|
1368
|
-
const mutate = extendM(
|
|
1369
|
-
mutation(
|
|
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
705
|
const h_ = client[key].handler
|
|
1385
|
-
const
|
|
1386
|
-
? () => h_
|
|
1387
|
-
: (...args: [any]) => h_(...args)
|
|
706
|
+
const request = h_
|
|
1388
707
|
;(acc as any)[key] = Object.assign(
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
708
|
+
requestType === "query" && !isStream
|
|
709
|
+
? {
|
|
710
|
+
...client[key],
|
|
711
|
+
request,
|
|
712
|
+
query: useQuery(client[key] as any),
|
|
713
|
+
suspense: useSuspenseQuery(client[key] as any),
|
|
714
|
+
project: (projectionSchema: any) => {
|
|
715
|
+
const successSchema = client[key].Request.success
|
|
716
|
+
const projectionHash = projectionSchemaHash(projectionSchema)
|
|
717
|
+
const projected = projectHandler(h_ as any, successSchema, projectionSchema)
|
|
718
|
+
const fakeHandler = {
|
|
719
|
+
handler: projected,
|
|
720
|
+
id: client[key].id,
|
|
721
|
+
Request: client[key].Request,
|
|
722
|
+
options: client[key].options,
|
|
723
|
+
queryKeyProjectionHash: projectionHash
|
|
724
|
+
}
|
|
725
|
+
return {
|
|
726
|
+
request: projected,
|
|
727
|
+
query: useQuery(fakeHandler as any),
|
|
728
|
+
suspense: useSuspenseQuery(fakeHandler as any)
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
: requestType === "query" && isStream
|
|
733
|
+
? {
|
|
734
|
+
...client[key],
|
|
735
|
+
request,
|
|
736
|
+
query: useStreamQuery(client[key] as any)
|
|
737
|
+
}
|
|
738
|
+
: requestType === "command" && isStream
|
|
739
|
+
? (() => {
|
|
740
|
+
const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
|
|
741
|
+
| InvalidationCallback<InvalidationResourcesFor<M>>
|
|
742
|
+
| undefined
|
|
743
|
+
const fromRequest = fromRequestConfig
|
|
744
|
+
? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
|
|
745
|
+
fromRequestConfig(defaultKey, queryResources as never, input as never, output as never).map((
|
|
746
|
+
entry
|
|
747
|
+
) => ({
|
|
748
|
+
filters: entry.filters,
|
|
749
|
+
options: entry.options
|
|
750
|
+
})))
|
|
751
|
+
: undefined
|
|
752
|
+
const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
|
|
753
|
+
const streamCmd = useCommand()
|
|
754
|
+
return {
|
|
755
|
+
...client[key],
|
|
756
|
+
request,
|
|
757
|
+
query: useStreamQuery(client[key] as any),
|
|
758
|
+
fn: (options?: any) => streamCmd.streamFn(client[key].id as any, options),
|
|
759
|
+
mutate: (() => {
|
|
760
|
+
const sm2Act = useStreamMutation2()(client[key] as any, mergedInvalidation)
|
|
761
|
+
const sm2Handler = (input: any, _ctx: any) => (sm2Act as (i: any) => any)(input)
|
|
762
|
+
return Object.assign(sm2Act, {
|
|
763
|
+
id: client[key].id,
|
|
764
|
+
wrap: (options?: any) => streamCmd.streamWrap(sm2Handler, client[key].id as any, options)
|
|
765
|
+
})
|
|
766
|
+
})()
|
|
767
|
+
}
|
|
768
|
+
})()
|
|
769
|
+
: {
|
|
770
|
+
mutate: ((handler: any) => {
|
|
771
|
+
const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
|
|
772
|
+
| InvalidationCallback<InvalidationResourcesFor<M>>
|
|
773
|
+
| undefined
|
|
774
|
+
const fromRequest = fromRequestConfig
|
|
775
|
+
? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
|
|
776
|
+
fromRequestConfig(defaultKey, queryResources as never, input as never, output as never).map((
|
|
777
|
+
entry
|
|
778
|
+
) => ({
|
|
779
|
+
filters: entry.filters,
|
|
780
|
+
options: entry.options
|
|
781
|
+
})))
|
|
782
|
+
: undefined
|
|
783
|
+
const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
|
|
784
|
+
const makeProjectedMutation = (h: any): any => {
|
|
785
|
+
const mutate = withDefaultInvalidation(mutation(h), mergedInvalidation)
|
|
786
|
+
return Object.assign(
|
|
787
|
+
mutate,
|
|
788
|
+
{
|
|
789
|
+
wrap: (options?: any) =>
|
|
790
|
+
Command.wrap({
|
|
791
|
+
mutate,
|
|
792
|
+
id: client[key].id
|
|
793
|
+
}, options),
|
|
794
|
+
fn: (options?: any) => Command.fn(client[key].id, options),
|
|
795
|
+
project: (projectionSchema: any) => {
|
|
796
|
+
const projected = {
|
|
797
|
+
...h,
|
|
798
|
+
handler: projectHandler(h.handler, client[key].Request.success, projectionSchema)
|
|
799
|
+
}
|
|
800
|
+
return makeProjectedMutation(projected)
|
|
801
|
+
}
|
|
802
|
+
}
|
|
803
|
+
)
|
|
804
|
+
}
|
|
805
|
+
return makeProjectedMutation(handler)
|
|
806
|
+
})(client[key] as any),
|
|
807
|
+
...client[key],
|
|
808
|
+
...fn, // to get the i18n key etc.
|
|
809
|
+
request,
|
|
810
|
+
fn: (options?: any) => Command.fn(client[key].id, options),
|
|
811
|
+
wrap: (options?: any) => Command.wrap({ mutate: h_, id: client[key].id }, options)
|
|
812
|
+
}
|
|
1399
813
|
)
|
|
1400
814
|
return acc
|
|
1401
815
|
},
|
|
1402
816
|
{} as {
|
|
1403
817
|
[Key in keyof typeof client]:
|
|
1404
818
|
& typeof client[Key]
|
|
1405
|
-
&
|
|
1406
|
-
|
|
1407
|
-
|
|
819
|
+
& (QueryHandler<typeof client[Key]> extends never ? {}
|
|
820
|
+
:
|
|
821
|
+
& QueryRequestWithExtensions<QueryHandler<typeof client[Key]>>
|
|
822
|
+
& Queries<RT, QueryHandler<typeof client[Key]>>
|
|
823
|
+
& QueryProjection<RT, QueryHandler<typeof client[Key]>>)
|
|
824
|
+
& (QueryStreamHandler<typeof client[Key]> extends never ? {}
|
|
825
|
+
: StreamQueries<RT, QueryStreamHandler<typeof client[Key]>>)
|
|
826
|
+
& (CommandHandler<typeof client[Key]> extends never ? {}
|
|
827
|
+
: CommandRequestWithExtensions<RT | RTHooks, CommandHandler<typeof client[Key]>>)
|
|
828
|
+
& (CommandHandler<typeof client[Key]> extends never ? {}
|
|
829
|
+
: { mutate: MutationWithExtensions<RT | RTHooks, CommandHandler<typeof client[Key]>> })
|
|
830
|
+
& (CommandStreamHandler<typeof client[Key]> extends never ? {}
|
|
831
|
+
: {
|
|
832
|
+
fn: StreamFnStreamExtension<RT | RTHooks, CommandStreamHandler<typeof client[Key]>>
|
|
833
|
+
mutate: StreamMutation2WithExtensions<RT | RTHooks, CommandStreamHandler<typeof client[Key]>>
|
|
834
|
+
})
|
|
835
|
+
& { Input: typeof client[Key] extends RequestHandlerWithInput<infer I, any, any, any, any, any> ? I : never }
|
|
1408
836
|
}
|
|
1409
837
|
)
|
|
1410
|
-
return Object.assign(extended, {
|
|
838
|
+
return Object.assign(extended, {
|
|
839
|
+
helpers: {
|
|
840
|
+
...mapRequest(client),
|
|
841
|
+
...mapMutation(client, queryInvalidation, invalidationResources),
|
|
842
|
+
...mapQuery(client)
|
|
843
|
+
}
|
|
844
|
+
})
|
|
1411
845
|
}
|
|
1412
846
|
|
|
1413
847
|
// TODO: Clean up this delay initialisation messs
|
|
1414
848
|
// TODO; invalidateQueries should perhaps be configured in the Request impl themselves?
|
|
1415
|
-
const clientFor__ = <M extends
|
|
849
|
+
const clientFor__ = <M extends RequestsAny>(
|
|
1416
850
|
m: M,
|
|
1417
|
-
queryInvalidation?:
|
|
1418
|
-
|
|
851
|
+
queryInvalidation?: QueryInvalidationFactory<M>,
|
|
852
|
+
invalidationResources?: InvalidationResourcesFor<M>
|
|
853
|
+
) => getBaseMrt().runSync(clientFor_(m).pipe(Effect.map(mapClient(queryInvalidation, invalidationResources))))
|
|
1419
854
|
|
|
1420
855
|
// delay client creation until first access
|
|
1421
856
|
// the idea is that we don't need the useNuxtApp().$runtime (only available at later initialisation stage)
|
|
1422
857
|
// until we are at a place where it is available..
|
|
1423
|
-
const clientFor = <
|
|
858
|
+
const clientFor = <
|
|
859
|
+
M extends RequestsAny,
|
|
860
|
+
Resources extends InvalidationResourcesFor<M> = InvalidationResourcesFor<M>
|
|
861
|
+
>(
|
|
1424
862
|
m: M,
|
|
1425
|
-
|
|
863
|
+
...args: ClientForArgs<M, Resources>
|
|
1426
864
|
) => {
|
|
865
|
+
const [queryInvalidation, invalidationResources] = args as [
|
|
866
|
+
QueryInvalidationFactory<M> | undefined,
|
|
867
|
+
InvalidationResourcesFor<M> | undefined
|
|
868
|
+
]
|
|
1427
869
|
type Client = ReturnType<typeof clientFor__<M>>
|
|
1428
870
|
let client: Client | undefined = undefined
|
|
1429
|
-
const getOrMakeClient = () => (client ??= clientFor__(m, queryInvalidation))
|
|
871
|
+
const getOrMakeClient = () => (client ??= clientFor__(m, queryInvalidation, invalidationResources))
|
|
1430
872
|
|
|
1431
873
|
// initialize on first use..
|
|
1432
874
|
const proxy = Struct.keys(m).concat(["helpers"]).reduce((acc, key) => {
|
|
@@ -1444,16 +886,12 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1444
886
|
return proxy
|
|
1445
887
|
}
|
|
1446
888
|
|
|
1447
|
-
const legacy: Legacy<RT> = {
|
|
1448
|
-
...mutations,
|
|
1449
|
-
...query
|
|
1450
|
-
}
|
|
1451
|
-
|
|
1452
889
|
const Command: CommanderResolved<RT, RTHooks> = {
|
|
1453
890
|
...{
|
|
1454
891
|
// delay initialisation until first use...
|
|
1455
892
|
fn: (...args: [any]) => useCommand().fn(...args),
|
|
1456
893
|
wrap: (...args: [any]) => useCommand().wrap(...args),
|
|
894
|
+
streamFn: (...args: [any]) => useCommand().streamFn(...args),
|
|
1457
895
|
alt: (...args: [any]) => useCommand().alt(...args),
|
|
1458
896
|
alt2: (...args: [any]) => useCommand().alt2(...args)
|
|
1459
897
|
} as ReturnType<typeof useCommand>,
|
|
@@ -1463,19 +901,17 @@ export const makeClient = <RT_, RTHooks>(
|
|
|
1463
901
|
return {
|
|
1464
902
|
Command,
|
|
1465
903
|
useCommand,
|
|
1466
|
-
clientFor
|
|
1467
|
-
legacy
|
|
904
|
+
clientFor
|
|
1468
905
|
}
|
|
1469
906
|
}
|
|
1470
907
|
|
|
1471
|
-
export interface Legacy<R>
|
|
1472
|
-
extends
|
|
1473
|
-
Pick<QueryImpl<R>, "useQuery" | "useSuspenseQuery">,
|
|
1474
|
-
Omit<LegacyMutationImpl<R>, "getRuntime" | "toast" | "intl">
|
|
1475
|
-
{}
|
|
1476
|
-
|
|
1477
908
|
export type QueryInvalidation<M> = {
|
|
1478
|
-
[K in keyof M]?: (
|
|
909
|
+
[K in keyof M]?: (
|
|
910
|
+
defaultKey: string[],
|
|
911
|
+
name: string,
|
|
912
|
+
input?: unknown,
|
|
913
|
+
output?: Exit.Exit<unknown, unknown>
|
|
914
|
+
) => {
|
|
1479
915
|
filters?: InvalidateQueryFilters | undefined
|
|
1480
916
|
options?: InvalidateOptions | undefined
|
|
1481
917
|
}[]
|
|
@@ -1486,17 +922,21 @@ export type ToCamel<S extends string | number | symbol> = S extends string
|
|
|
1486
922
|
: Uncapitalize<S>
|
|
1487
923
|
: never
|
|
1488
924
|
|
|
1489
|
-
export interface CommandBase<I = void, A = void> {
|
|
925
|
+
export interface CommandBase<I = void, A = void, RA = unknown, RE = unknown> {
|
|
1490
926
|
handle: (input: I) => A
|
|
1491
927
|
waiting: boolean
|
|
1492
928
|
blocked: boolean
|
|
1493
929
|
allowed: boolean
|
|
1494
930
|
action: string
|
|
1495
931
|
label: string
|
|
932
|
+
/** formatted progress info for current `running` state, when `progress` was supplied */
|
|
933
|
+
progress?: Progress | undefined
|
|
934
|
+
/** reactive result state, available on stream-backed commands */
|
|
935
|
+
result?: AsyncResult.AsyncResult<RA, RE>
|
|
1496
936
|
}
|
|
1497
937
|
|
|
1498
|
-
export interface EffectCommand<I = void, A = unknown, E = unknown> extends CommandBase<I, Fiber<A, E
|
|
938
|
+
export interface EffectCommand<I = void, A = unknown, E = unknown> extends CommandBase<I, Fiber<A, E>, A, E> {}
|
|
1499
939
|
|
|
1500
|
-
export interface CommandFromRequest<I extends
|
|
1501
|
-
extends EffectCommand<
|
|
940
|
+
export interface CommandFromRequest<I extends { readonly make: (...args: any[]) => any }, A = unknown, E = unknown>
|
|
941
|
+
extends EffectCommand<HandlerInput<I>, A, E>
|
|
1502
942
|
{}
|