@effect-app/vue 4.0.0-beta.18 → 4.0.0-beta.180

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.
Files changed (100) hide show
  1. package/CHANGELOG.md +1224 -0
  2. package/dist/commander.d.ts +370 -0
  3. package/dist/commander.d.ts.map +1 -0
  4. package/dist/commander.js +591 -0
  5. package/dist/confirm.d.ts +19 -0
  6. package/dist/confirm.d.ts.map +1 -0
  7. package/dist/confirm.js +24 -0
  8. package/dist/errorReporter.d.ts +4 -4
  9. package/dist/errorReporter.d.ts.map +1 -1
  10. package/dist/errorReporter.js +12 -18
  11. package/dist/form.d.ts +13 -4
  12. package/dist/form.d.ts.map +1 -1
  13. package/dist/form.js +41 -12
  14. package/dist/index.d.ts +1 -1
  15. package/dist/intl.d.ts +15 -0
  16. package/dist/intl.d.ts.map +1 -0
  17. package/dist/intl.js +9 -0
  18. package/dist/lib.d.ts +6 -8
  19. package/dist/lib.d.ts.map +1 -1
  20. package/dist/lib.js +34 -7
  21. package/dist/makeClient.d.ts +148 -290
  22. package/dist/makeClient.d.ts.map +1 -1
  23. package/dist/makeClient.js +205 -361
  24. package/dist/makeContext.d.ts +1 -1
  25. package/dist/makeContext.d.ts.map +1 -1
  26. package/dist/makeIntl.d.ts +1 -1
  27. package/dist/makeIntl.d.ts.map +1 -1
  28. package/dist/makeUseCommand.d.ts +8 -0
  29. package/dist/makeUseCommand.d.ts.map +1 -0
  30. package/dist/makeUseCommand.js +13 -0
  31. package/dist/mutate.d.ts +57 -25
  32. package/dist/mutate.d.ts.map +1 -1
  33. package/dist/mutate.js +160 -33
  34. package/dist/query.d.ts +11 -15
  35. package/dist/query.d.ts.map +1 -1
  36. package/dist/query.js +19 -27
  37. package/dist/routeParams.d.ts +1 -1
  38. package/dist/runtime.d.ts +5 -2
  39. package/dist/runtime.d.ts.map +1 -1
  40. package/dist/runtime.js +27 -17
  41. package/dist/toast.d.ts +46 -0
  42. package/dist/toast.d.ts.map +1 -0
  43. package/dist/toast.js +32 -0
  44. package/dist/withToast.d.ts +26 -0
  45. package/dist/withToast.d.ts.map +1 -0
  46. package/dist/withToast.js +49 -0
  47. package/eslint.config.mjs +2 -2
  48. package/examples/streamMutation.ts +83 -0
  49. package/package.json +48 -48
  50. package/src/{experimental/commander.ts → commander.ts} +930 -255
  51. package/src/{experimental/confirm.ts → confirm.ts} +10 -14
  52. package/src/errorReporter.ts +62 -74
  53. package/src/form.ts +55 -16
  54. package/src/intl.ts +12 -0
  55. package/src/lib.ts +46 -13
  56. package/src/makeClient.ts +570 -1038
  57. package/src/{experimental/makeUseCommand.ts → makeUseCommand.ts} +3 -3
  58. package/src/mutate.ts +306 -72
  59. package/src/query.ts +39 -50
  60. package/src/runtime.ts +39 -18
  61. package/src/{experimental/toast.ts → toast.ts} +11 -25
  62. package/src/{experimental/withToast.ts → withToast.ts} +15 -6
  63. package/test/Mutation.test.ts +130 -10
  64. package/test/dist/form.test.d.ts.map +1 -1
  65. package/test/dist/lib.test.d.ts.map +1 -0
  66. package/test/dist/streamFinal.test.d.ts.map +1 -0
  67. package/test/dist/stubs.d.ts +3144 -117
  68. package/test/dist/stubs.d.ts.map +1 -1
  69. package/test/dist/stubs.js +132 -25
  70. package/test/form-validation-errors.test.ts +23 -19
  71. package/test/form.test.ts +20 -2
  72. package/test/lib.test.ts +240 -0
  73. package/test/makeClient.test.ts +241 -38
  74. package/test/streamFinal.test.ts +110 -0
  75. package/test/stubs.ts +172 -42
  76. package/tsconfig.examples.json +20 -0
  77. package/tsconfig.json +0 -1
  78. package/tsconfig.json.bak +5 -2
  79. package/tsconfig.src.json +34 -34
  80. package/tsconfig.test.json +2 -2
  81. package/vitest.config.ts +5 -5
  82. package/dist/experimental/commander.d.ts +0 -359
  83. package/dist/experimental/commander.d.ts.map +0 -1
  84. package/dist/experimental/commander.js +0 -557
  85. package/dist/experimental/confirm.d.ts +0 -19
  86. package/dist/experimental/confirm.d.ts.map +0 -1
  87. package/dist/experimental/confirm.js +0 -28
  88. package/dist/experimental/intl.d.ts +0 -16
  89. package/dist/experimental/intl.d.ts.map +0 -1
  90. package/dist/experimental/intl.js +0 -5
  91. package/dist/experimental/makeUseCommand.d.ts +0 -8
  92. package/dist/experimental/makeUseCommand.d.ts.map +0 -1
  93. package/dist/experimental/makeUseCommand.js +0 -13
  94. package/dist/experimental/toast.d.ts +0 -47
  95. package/dist/experimental/toast.d.ts.map +0 -1
  96. package/dist/experimental/toast.js +0 -41
  97. package/dist/experimental/withToast.d.ts +0 -25
  98. package/dist/experimental/withToast.d.ts.map +0 -1
  99. package/dist/experimental/withToast.js +0 -45
  100. package/src/experimental/intl.ts +0 -9
package/src/makeClient.ts CHANGED
@@ -1,32 +1,45 @@
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"
4
+ import { type Context, Effect, Exit, Hash, type Layer, type ManagedRuntime, S, Struct } from "effect-app"
5
5
  import { type ApiClientFactory, type Req } from "effect-app/client"
6
- import type { RequestHandler, RequestHandlers, RequestHandlerWithInput, Requests } from "effect-app/client/clientFor"
7
- import { ErrorSilenced, type SupportedErrors } from "effect-app/client/errors"
8
- import { constant, identity, pipe, tuple } from "effect-app/Function"
9
- import { type OperationFailure, OperationSuccess } from "effect-app/Operations"
10
- import { dropUndefinedT, extendM } from "effect-app/utils"
6
+ import type { ExtractModuleName, RequestHandler, RequestHandlers, RequestHandlerWithInput, RequestInputFromMake, RequestsAny, RequestStreamHandler, RequestStreamHandlerWithInput } from "effect-app/client/clientFor"
7
+ import type { InvalidationCallback } from "effect-app/client/makeClient"
8
+ import type * as ExitResult from "effect/Exit"
11
9
  import { type Fiber } from "effect/Fiber"
12
10
  import * as AsyncResult from "effect/unstable/reactivity/AsyncResult"
13
- import { computed, type ComputedRef, onBeforeUnmount, type Ref, ref, watch, type WatchSource } from "vue"
14
- import { reportMessage } from "./errorReporter.js"
15
- import { type Commander, CommanderStatic } from "./experimental/commander.js"
16
- import { I18n } from "./experimental/intl.js"
17
- import { type CommanderResolved, makeUseCommand } from "./experimental/makeUseCommand.js"
18
- import { Toast } from "./experimental/toast.js"
19
- import { buildFieldInfoFromFieldsRoot } from "./form.js"
20
- import { reportRuntimeError } from "./lib.js"
21
- import { asResult, makeMutation, type MutationOptions, type MutationOptionsBase, mutationResultToVue, type Res, useMakeMutation } from "./mutate.js"
11
+ import { type ComputedRef, onBeforeUnmount, ref, type WatchSource } from "vue"
12
+ import { type Commander, CommanderStatic } from "./commander.js"
13
+ import { type I18n } from "./intl.js"
14
+ import { type CommanderResolved, makeUseCommand } from "./makeUseCommand.js"
15
+ import { makeMutation, makeStreamMutation, type MutationOptionsBase, useMakeMutation } from "./mutate.js"
22
16
  import { type CustomUndefinedInitialQueryOptions, makeQuery } from "./query.js"
17
+ import { makeRunPromise } from "./runtime.js"
18
+ import { type Toast } from "./toast.js"
23
19
 
24
20
  const mapHandler = <A, E, R, I = void, A2 = A, E2 = E, R2 = R>(
25
21
  handler: Effect.Effect<A, E, R> | ((i: I) => Effect.Effect<A, E, R>),
26
22
  map: (self: Effect.Effect<A, E, R>, i: I) => Effect.Effect<A2, E2, R2>
27
23
  ) => Effect.isEffect(handler) ? map(handler, undefined as any) : (i: I) => map(handler(i), i)
28
24
 
29
- export interface RequestExtensions<RT, Id extends string, I, A, E, R> {
25
+ // TODO: optimize - work from encoded shape directly
26
+ const projectHandler = (
27
+ handler: Effect.Effect<any, any, any> | ((i: any) => Effect.Effect<any, any, any>),
28
+ successSchema: S.Top,
29
+ projectionSchema: S.Top
30
+ ) => {
31
+ const encode = S.encodeEffect(successSchema)
32
+ const decode = S.decodeEffectConcurrently(projectionSchema)
33
+ return mapHandler(handler, (self) =>
34
+ self.pipe(
35
+ Effect.flatMap(encode),
36
+ Effect.flatMap(decode)
37
+ ))
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 */
@@ -44,16 +57,14 @@ export interface RequestExtWithInput<
44
57
  A,
45
58
  E,
46
59
  R
47
- > extends Commander.CommandContextLocal<Id, Id>, RequestExtensions<RT, Id, I, A, E, R> {
60
+ > extends Commander.CommandContextLocal<Id, Id>, CommandRequestExtensions<RT, Id, I, A, E, R> {
48
61
  /**
49
- * Request the endpoint with input
62
+ * Send the request to the endpoint and return the raw Effect response.
63
+ * This does not perform query cache invalidation.
50
64
  */
51
- (i: I): Effect.Effect<A, E, R>
65
+ request: (i: I) => Effect.Effect<A, E, R>
52
66
  }
53
67
 
54
- /**
55
- * Request the endpoint
56
- */
57
68
  export interface RequestExt<
58
69
  RT,
59
70
  Id extends string,
@@ -63,25 +74,69 @@ export interface RequestExt<
63
74
  > extends
64
75
  Commander.CommandContextLocal<Id, Id>,
65
76
  Commander.CommanderWrap<RT, Id, Id, undefined, void, A, E, R>,
66
- RequestExtensions<RT, Id, void, A, E, R>,
67
- Effect.Effect<A, E, R>
77
+ CommandRequestExtensions<RT, Id, void, A, E, R>
68
78
  {
79
+ /**
80
+ * Send the request to the endpoint and return the raw Effect response.
81
+ * This does not perform query cache invalidation.
82
+ */
83
+ request: Effect.Effect<A, E, R>
69
84
  }
70
85
 
71
- export type RequestWithExtensions<RT, Req> = Req extends
86
+ export type CommandRequestWithExtensions<RT, Req> = Req extends
72
87
  RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer Id>
73
88
  ? RequestExtWithInput<RT, Id, I, A, E, R>
74
89
  : Req extends RequestHandler<infer A, infer E, infer R, infer _Request, infer Id> ? RequestExt<RT, Id, A, E, R>
75
90
  : never
76
91
 
92
+ export interface QueryExtensionsWithInput<I, A, E, R> {
93
+ /**
94
+ * Send the request to the endpoint and return the raw Effect response.
95
+ * This does not set up query state tracking.
96
+ */
97
+ request: (i: I) => Effect.Effect<A, E, R>
98
+ }
99
+
100
+ export interface QueryExtensions<A, E, R> {
101
+ /**
102
+ * Send the request to the endpoint and return the raw Effect response.
103
+ * This does not set up query state tracking.
104
+ */
105
+ request: Effect.Effect<A, E, R>
106
+ }
107
+
108
+ export type QueryRequestWithExtensions<Req> = Req extends
109
+ RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer _Id>
110
+ ? QueryExtensionsWithInput<I, A, E, R>
111
+ : Req extends RequestHandler<infer A, infer E, infer R, infer _Request, infer _Id> ? QueryExtensions<A, E, R>
112
+ : never
113
+
114
+ type QueryHandler<Req> = Req extends
115
+ RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
116
+ ? Request["type"] extends "query" ? RequestHandlerWithInput<I, A, E, R, Request, Id> : never
117
+ : Req extends RequestHandler<infer A, infer E, infer R, infer Request, infer Id>
118
+ ? Request["type"] extends "query" ? RequestHandler<A, E, R, Request, Id> : never
119
+ : never
120
+
121
+ type CommandHandler<Req> = Req extends
122
+ RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
123
+ ? Request["type"] extends "command" ? RequestHandlerWithInput<I, A, E, R, Request, Id> : never
124
+ : Req extends RequestHandler<infer A, infer E, infer R, infer Request, infer Id>
125
+ ? Request["type"] extends "command" ? RequestHandler<A, E, R, Request, Id> : never
126
+ : never
127
+
128
+ type StreamHandler<Req> = Req extends
129
+ RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id, infer Final>
130
+ ? Request["type"] extends "stream" ? RequestStreamHandlerWithInput<I, A, E, R, Request, Id, Final> : never
131
+ : Req extends RequestStreamHandler<infer A, infer E, infer R, infer Request, infer Id, infer Final>
132
+ ? Request["type"] extends "stream" ? RequestStreamHandler<A, E, R, Request, Id, Final> : never
133
+ : never
134
+
77
135
  export interface MutationExtensions<RT, Id extends string, I, A, E, R> {
78
136
  /** Defines a Command based on this mutation, taking the `id` of the mutation as the `id` of the Command.
79
137
  * The Mutation function will be taken as the first member of the Command, the Command required input will be the Mutation input.
80
138
  * see Command.wrap for details */
81
139
  wrap: Commander.CommanderWrap<RT, Id, Id, undefined, I, A, E, R>
82
- /** Defines a Command based on this mutation, taking the `id` of the mutation as the `id` of the Command.
83
- * see Command.fn for details */
84
- fn: Commander.CommanderFn<RT, Id, Id, undefined>
85
140
  }
86
141
 
87
142
  /** my other doc */
@@ -91,39 +146,95 @@ export interface MutationExtWithInput<
91
146
  I,
92
147
  A,
93
148
  E,
94
- R
95
- > extends Commander.CommandContextLocal<Id, Id>, MutationExtensions<RT, Id, I, A, E, R> {
149
+ R,
150
+ EA = unknown
151
+ > extends MutationExtensions<RT, Id, I, A, E, R> {
96
152
  /**
97
- * Call the endpoint with input
98
- * Invalidate queries based on namespace of this mutation.
99
- * Do not use for queries.
153
+ * Send the request to the endpoint and return the raw Effect response.
154
+ * Also invalidates query caches using the request namespace by default.
155
+ * Namespace invalidation targets parent namespace keys
156
+ * (for example `$project/$configuration.get` invalidates `$project`).
157
+ * Override invalidation in client options via `queryInvalidation`.
158
+ *
159
+ * Pass `options` to attach a `select` Effect that runs after the mutation
160
+ * succeeds (its output is returned to the caller) and/or override the default
161
+ * `queryInvalidation`.
100
162
  */
101
- (i: I): Effect.Effect<A, E, R>
163
+ <B = A, E2 = never, R2 = never>(
164
+ input: I,
165
+ options?: MutationOptionsBase<A, B, E2, R2>
166
+ ): Effect.Effect<B, E | E2, R | R2>
167
+
168
+ project: <ProjSchema extends S.Top>(
169
+ schema: EA extends ProjSchema["Encoded"] ? ProjSchema : never
170
+ ) => MutationExtWithInput<
171
+ RT,
172
+ Id,
173
+ I,
174
+ S.Schema.Type<ProjSchema>,
175
+ E | S.SchemaError,
176
+ R | S.Codec.DecodingServices<ProjSchema>,
177
+ S.Codec.Encoded<ProjSchema>
178
+ >
102
179
  }
103
180
 
104
181
  /**
105
- * Call the endpoint
106
- * Invalidate queries based on namespace of this mutation.
107
- * Do not use for queries.
182
+ * Send the request to the endpoint and return the raw Effect response.
183
+ * Also invalidates query caches using the request namespace by default.
184
+ * Namespace invalidation targets parent namespace keys
185
+ * (for example `$project/$configuration.get` invalidates `$project`).
186
+ * Override invalidation in client options via `queryInvalidation`.
108
187
  */
109
188
  export interface MutationExt<
110
189
  RT,
111
190
  Id extends string,
112
191
  A,
113
192
  E,
114
- R
115
- > extends
116
- Commander.CommandContextLocal<Id, Id>,
117
- Commander.CommanderWrap<RT, Id, Id, undefined, void, A, E, R>,
118
- MutationExtensions<RT, Id, void, A, E, R>,
119
- Effect.Effect<A, E, R>
120
- {
193
+ R,
194
+ EA = unknown
195
+ > extends MutationExtensions<RT, Id, void, A, E, R> {
196
+ /**
197
+ * Send the request to the endpoint and return the raw Effect response.
198
+ * Also invalidates query caches using the request namespace by default.
199
+ *
200
+ * Pass `options` to attach a `select` Effect that runs after the mutation
201
+ * succeeds (its output is returned to the caller) and/or override the default
202
+ * `queryInvalidation`.
203
+ */
204
+ <B = A, E2 = never, R2 = never>(
205
+ options?: MutationOptionsBase<A, B, E2, R2>
206
+ ): Effect.Effect<B, E | E2, R | R2>
207
+
208
+ project: <ProjSchema extends S.Top>(
209
+ schema: EA extends ProjSchema["Encoded"] ? ProjSchema : never
210
+ ) => MutationExt<
211
+ RT,
212
+ Id,
213
+ S.Schema.Type<ProjSchema>,
214
+ E | S.SchemaError,
215
+ R | S.Codec.DecodingServices<ProjSchema>,
216
+ S.Codec.Encoded<ProjSchema>
217
+ >
121
218
  }
122
219
 
123
220
  export type MutationWithExtensions<RT, Req> = Req extends
124
- RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer Id>
125
- ? MutationExtWithInput<RT, Id, I, A, E, R>
126
- : Req extends RequestHandler<infer A, infer E, infer R, infer _Request, infer Id> ? MutationExt<RT, Id, A, E, R>
221
+ RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
222
+ ? MutationExtWithInput<RT, Id, I, A, E, R, S.Codec.Encoded<Request["success"]>>
223
+ : Req extends RequestHandler<infer A, infer E, infer R, infer Request, infer Id>
224
+ ? MutationExt<RT, Id, A, E, R, S.Codec.Encoded<Request["success"]>>
225
+ : never
226
+
227
+ /**
228
+ * The `mutateStream` tuple for a stream-type request handler:
229
+ * `[resultRef, execute]` where `execute` updates the ref live with each emitted value.
230
+ * When the request declares a `final` schema, `execute` resolves with the last emitted value
231
+ * typed as `Final`; otherwise it resolves with `void`.
232
+ */
233
+ export type StreamMutationWithExtensions<Req> = Req extends
234
+ RequestStreamHandlerWithInput<infer I, infer A, infer E, infer R, infer _Request, infer _Id, infer Final>
235
+ ? readonly [ComputedRef<AsyncResult.AsyncResult<A, E>>, (input: I) => Effect.Effect<Final, never, R>]
236
+ : Req extends RequestStreamHandler<infer A, infer E, infer R, infer _Request, infer _Id, infer Final>
237
+ ? readonly [ComputedRef<AsyncResult.AsyncResult<A, E>>, Effect.Effect<Final, never, R>]
127
238
  : never
128
239
 
129
240
  // we don't really care about the RT, as we are in charge of ensuring runtime safety anyway
@@ -132,29 +243,72 @@ declare const useQuery_: QueryImpl<any>["useQuery"]
132
243
  // eslint-disable-next-line unused-imports/no-unused-vars
133
244
  declare const useSuspenseQuery_: QueryImpl<any>["useSuspenseQuery"]
134
245
 
246
+ export interface ProjectResult<RT, I, B, E, R, Request extends Req, Id extends string> {
247
+ request: (i: I) => Effect.Effect<B, E, R>
248
+ query: Exclude<R, RT> extends never ? ReturnType<typeof useQuery_<I, E, B, Request, Id>>
249
+ : MissingDependencies<RT, R> & {}
250
+ suspense: Exclude<R, RT> extends never ? ReturnType<typeof useSuspenseQuery_<I, E, B, Request, Id>>
251
+ : MissingDependencies<RT, R> & {}
252
+ }
253
+
254
+ export type QueryProjection<RT, HandlerReq> = HandlerReq extends
255
+ RequestHandlerWithInput<infer I, infer _A, infer E, infer R, infer Request, infer Id>
256
+ ? Request["type"] extends "query" ? {
257
+ project: <ProjSchema extends S.Top>(
258
+ schema: S.Codec.Encoded<Request["success"]> extends ProjSchema["Encoded"] ? ProjSchema : never
259
+ ) => ProjectResult<
260
+ RT,
261
+ I,
262
+ S.Schema.Type<ProjSchema>,
263
+ E | S.SchemaError,
264
+ R | S.Codec.DecodingServices<ProjSchema>,
265
+ Request,
266
+ Id
267
+ >
268
+ }
269
+ : {}
270
+ : HandlerReq extends RequestHandler<infer _A, infer E, infer R, infer Request, infer Id>
271
+ ? Request["type"] extends "query" ? {
272
+ project: <ProjSchema extends S.Top>(
273
+ schema: S.Codec.Encoded<Request["success"]> extends ProjSchema["Encoded"] ? ProjSchema : never
274
+ ) => ProjectResult<
275
+ RT,
276
+ void,
277
+ S.Schema.Type<ProjSchema>,
278
+ E | S.SchemaError,
279
+ R | S.Codec.DecodingServices<ProjSchema>,
280
+ Request,
281
+ Id
282
+ >
283
+ }
284
+ : {}
285
+ : {}
286
+
135
287
  export interface QueriesWithInput<Request extends Req, Id extends string, I, A, E> {
136
288
  /**
137
- * Effect results are passed to the caller, including errors.
289
+ * Read helper for query requests.
290
+ * Runs as a tracked Vue Query and returns reactive state.
291
+ * Queries read state and should not be used to mutate it.
138
292
  */
139
293
  query: ReturnType<typeof useQuery_<I, E, A, Request, Id>>
140
294
  // TODO or suspense as Option?
141
295
  /**
142
- * The difference with useQuery is that this function will return a Promise you can await in the Setup,
143
- * which ensures that either there always is a latest value, or an error occurs on load.
144
- * So that Suspense and error boundaries can be used.
296
+ * Like `.query`, but returns a Promise for setup-time awaiting.
297
+ * Use this when integrating with Vue Suspense / error boundaries.
145
298
  */
146
299
  suspense: ReturnType<typeof useSuspenseQuery_<I, E, A, Request, Id>>
147
300
  }
148
301
  export interface QueriesWithoutInput<Request extends Req, Id extends string, A, E> {
149
302
  /**
150
- * Effect results are passed to the caller, including errors.
303
+ * Read helper for query requests.
304
+ * Runs as a tracked Vue Query and returns reactive state.
305
+ * Queries read state and should not be used to mutate it.
151
306
  */
152
307
  query: ReturnType<typeof useQuery_<E, A, Request, Id>>
153
308
  // TODO or suspense as Option?
154
309
  /**
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.
310
+ * Like `.query`, but returns a Promise for setup-time awaiting.
311
+ * Use this when integrating with Vue Suspense / error boundaries.
158
312
  */
159
313
  suspense: ReturnType<typeof useSuspenseQuery_<E, A, Request, Id>>
160
314
  }
@@ -166,184 +320,34 @@ export type MissingDependencies<RT, R> = {
166
320
 
167
321
  export type Queries<RT, Req> = Req extends
168
322
  RequestHandlerWithInput<infer I, infer A, infer E, infer R, infer Request, infer Id>
169
- ? Exclude<R, RT> extends never ? QueriesWithInput<Request, Id, I, A, E>
170
- : {
171
- query: MissingDependencies<RT, R> & {}
172
- suspense: MissingDependencies<RT, R> & {}
173
- }
323
+ ? Request["type"] extends "query" ? Exclude<R, RT> extends never ? QueriesWithInput<Request, Id, I, A, E>
324
+ : {
325
+ query: MissingDependencies<RT, R> & {}
326
+ suspense: MissingDependencies<RT, R> & {}
327
+ }
328
+ : never
174
329
  : Req extends RequestHandler<infer A, infer E, infer R, infer Request, infer Id>
175
- ? Exclude<R, RT> extends never ? QueriesWithoutInput<Request, Id, A, E>
176
- : { query: MissingDependencies<RT, R> & {}; suspense: MissingDependencies<RT, R> & {} }
330
+ ? Request["type"] extends "query" ? Exclude<R, RT> extends never ? QueriesWithoutInput<Request, Id, A, E>
331
+ : { query: MissingDependencies<RT, R> & {}; suspense: MissingDependencies<RT, R> & {} }
332
+ : never
177
333
  : never
178
334
 
179
- /**
180
- * Use this after handling an error yourself, still continueing on the Error track, but the error will not be reported.
181
- */
182
- export class SuppressErrors extends Data.TaggedError("SuppressErrors")<{}> {
183
- readonly [ErrorSilenced] = true as const
184
- }
185
-
186
- export type ResponseErrors = S.SchemaError | SupportedErrors | SuppressErrors | OperationFailure
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
249
- }
250
-
251
- // computed() takes a getter function and returns a readonly reactive ref
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)
335
+ const _useMutation = makeMutation()
317
336
 
318
- yield* options.onDefect(cause, i)
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
- )
337
+ const wrapWithSpan = (self: { id: string; handler: any }, mut: any) => {
338
+ const span = (eff: Effect.Effect<any, any, any>) =>
339
+ Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })(eff)
340
+ return Effect.isEffect(self.handler)
341
+ ? (options?: MutationOptionsBase) => span(mut(options))
342
+ : (input: any, options?: MutationOptionsBase) => span(mut(input, options))
337
343
  }
338
344
 
339
- const _useMutation = makeMutation()
340
-
341
345
  /**
342
346
  * Pass an Effect or a function that returns an Effect, e.g from a client action
343
347
  * Executes query cache invalidation based on default rules or provided option.
344
348
  * adds a span with the mutation id
345
349
  */
346
- export const useMutation: typeof _useMutation = <
350
+ export const useMutation: typeof _useMutation = (<
347
351
  I,
348
352
  E,
349
353
  A,
@@ -351,16 +355,12 @@ export const useMutation: typeof _useMutation = <
351
355
  Request extends Req,
352
356
  Name extends string
353
357
  >(
354
- self: RequestHandlerWithInput<I, A, E, R, Request, Name> | RequestHandler<A, E, R, Request, Name>,
355
- options?: MutationOptionsBase
358
+ self: RequestHandlerWithInput<I, A, E, R, Request, Name> | RequestHandler<A, E, R, Request, Name>
356
359
  ) =>
357
360
  Object.assign(
358
- mapHandler(
359
- _useMutation(self as any, options),
360
- Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })
361
- ) as any,
361
+ wrapWithSpan(self, _useMutation(self as any)),
362
362
  { id: self.id }
363
- )
363
+ )) as any
364
364
 
365
365
  /**
366
366
  * Pass an Effect or a function that returns an Effect, e.g from a client action
@@ -369,7 +369,7 @@ export const useMutation: typeof _useMutation = <
369
369
  */
370
370
  export const useMutationInt = (): typeof _useMutation => {
371
371
  const _useMutation = useMakeMutation()
372
- return <
372
+ return (<
373
373
  I,
374
374
  E,
375
375
  A,
@@ -377,714 +377,18 @@ export const useMutationInt = (): typeof _useMutation => {
377
377
  Request extends Req,
378
378
  Name extends string
379
379
  >(
380
- self: RequestHandlerWithInput<I, A, E, R, Request, Name> | RequestHandler<A, E, R, Request, Name>,
381
- options?: MutationOptionsBase
380
+ self: RequestHandlerWithInput<I, A, E, R, Request, Name> | RequestHandler<A, E, R, Request, Name>
382
381
  ) =>
383
382
  Object.assign(
384
- mapHandler(
385
- _useMutation(self as any, options),
386
- Effect.withSpan(`mutation ${self.id}`, {}, { captureStackTrace: false })
387
- ) as any,
383
+ wrapWithSpan(self, _useMutation(self as any)),
388
384
  { id: self.id }
389
- )
385
+ )) as any
390
386
  }
391
387
 
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
1082
- }
1083
-
1084
- export type ClientFrom<M extends Requests> = RequestHandlers<never, never, M, M["meta"]["moduleName"]>
388
+ export type ClientFrom<M extends RequestsAny> = RequestHandlers<never, never, M, ExtractModuleName<M>>
1085
389
 
1086
390
  export class QueryImpl<R> {
1087
- constructor(readonly getRuntime: () => ServiceMap.ServiceMap<R>) {
391
+ constructor(readonly getRuntime: () => Context.Context<R>) {
1088
392
  this.useQuery = makeQuery(this.getRuntime)
1089
393
  }
1090
394
  /**
@@ -1163,7 +467,7 @@ export class QueryImpl<R> {
1163
467
  } = <Arg, E, A, Request extends Req, Name extends string>(
1164
468
  self: RequestHandlerWithInput<Arg, A, E, R, Request, Name> | RequestHandler<A, E, R, Request, Name>
1165
469
  ) => {
1166
- const runPromise = Effect.runPromiseWith(this.getRuntime())
470
+ const runPromise = makeRunPromise(this.getRuntime())
1167
471
  const q = this.useQuery(self as any) as any
1168
472
  return (argOrOptions?: any, options?: any) => {
1169
473
  const [resultRef, latestRef, fetch, uqrt] = q(argOrOptions, { ...options, suspense: true } // experimental_prefetchInRender: true }
@@ -1214,10 +518,64 @@ export class QueryImpl<R> {
1214
518
  }
1215
519
 
1216
520
  // 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.services<A>())
521
+ const managedRuntimeRt = <A, E>(mrt: ManagedRuntime.ManagedRuntime<A, E>) => mrt.runSync(Effect.context<A>())
1218
522
 
1219
523
  type Base = I18n | Toast
1220
- type Mix = ApiClientFactory | Commander | LegacyMutation | Base
524
+ type Mix = ApiClientFactory | Commander | Base
525
+
526
+ type InvalidationResources = Record<string, Record<string, unknown>>
527
+ type UnionToIntersection<U> = (U extends unknown ? (arg: U) => void : never) extends ((arg: infer I) => void) ? I
528
+ : never
529
+
530
+ type CommandInvalidationResources<Req> = Req extends {
531
+ readonly type: "command"
532
+ readonly "~invalidationResources"?: infer Resources
533
+ } ? NonNullable<Resources> extends InvalidationResources ? NonNullable<Resources> : never
534
+ : Req extends {
535
+ readonly type: "command"
536
+ readonly config?: infer Config
537
+ } ? Config extends {
538
+ readonly invalidationResources?: infer LegacyResources
539
+ } ? NonNullable<LegacyResources> extends InvalidationResources ? NonNullable<LegacyResources> : never
540
+ : Config extends {
541
+ readonly invalidatesQueries?: InvalidationCallback<infer LegacyResources, any, any, any>
542
+ } ? NonNullable<LegacyResources> extends InvalidationResources ? NonNullable<LegacyResources> : never
543
+ : never
544
+ : never
545
+
546
+ type InvalidationResourcesForUnion<M extends RequestsAny> = {
547
+ [K in keyof M]: CommandInvalidationResources<M[K]>
548
+ }[keyof M]
549
+
550
+ type InvalidationResourcesFor<M extends RequestsAny> = [InvalidationResourcesForUnion<M>] extends [never] ? never
551
+ : UnionToIntersection<InvalidationResourcesForUnion<M>> extends infer R ? R extends InvalidationResources ? R
552
+ : never
553
+ : never
554
+
555
+ type QueryInvalidationFactory<M extends RequestsAny> = (client: ClientFrom<M>) => QueryInvalidation<M>
556
+
557
+ type StrictResourcesArg<Shape, Actual extends Shape = Shape> =
558
+ & Actual
559
+ & Record<Exclude<keyof Actual, keyof Shape>, never>
560
+
561
+ type ClientForArgs<
562
+ M extends RequestsAny,
563
+ Resources extends InvalidationResourcesFor<M> = InvalidationResourcesFor<M>
564
+ > = [InvalidationResourcesFor<M>] extends [never] ? [
565
+ queryInvalidation?: QueryInvalidationFactory<M>,
566
+ invalidationResources?: StrictResourcesArg<
567
+ InvalidationResourcesFor<M>,
568
+ Resources
569
+ >
570
+ ]
571
+ : [
572
+ queryInvalidation: QueryInvalidationFactory<M> | undefined,
573
+ invalidationResources: StrictResourcesArg<
574
+ InvalidationResourcesFor<M>,
575
+ Resources
576
+ >
577
+ ]
578
+
1221
579
  export const makeClient = <RT_, RTHooks>(
1222
580
  // global, but only accessible after startup has completed
1223
581
  getBaseMrt: () => ManagedRuntime.ManagedRuntime<RT_ | Mix, never>,
@@ -1225,54 +583,66 @@ export const makeClient = <RT_, RTHooks>(
1225
583
  rtHooks: Layer.Layer<RTHooks, never, Mix>
1226
584
  ) => {
1227
585
  type RT = RT_ | Mix
1228
- const getRt = Effect.services<RT>()
1229
586
  const getBaseRt = () => managedRuntimeRt(getBaseMrt())
1230
587
  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
588
  let cmd: Effect.Success<typeof makeCommand>
1237
589
  const useCommand = () => cmd ??= getBaseMrt().runSync(makeCommand)
1238
- let mut: Effect.Success<typeof makeMutation>
1239
- const getMutation = () => mut ??= getBaseMrt().runSync(makeMutation)
1240
590
 
1241
591
  let m: ReturnType<typeof useMutationInt>
1242
592
  const useMutation = () => m ??= useMutationInt()
1243
593
 
1244
- const keys = [
1245
- "useSafeMutationWithState",
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
- )
594
+ let sm: ReturnType<typeof makeStreamMutation>
595
+ const useStreamMutation = () => sm ??= makeStreamMutation()
1266
596
 
1267
597
  const query = new QueryImpl(getBaseRt)
1268
598
  const useQuery = query.useQuery
1269
599
  const useSuspenseQuery = query.useSuspenseQuery
1270
600
 
1271
- const mapQuery = <M extends Requests>(
601
+ const mergeInvalidation = (
602
+ a?: MutationOptionsBase["queryInvalidation"],
603
+ b?: MutationOptionsBase["queryInvalidation"]
604
+ ): MutationOptionsBase["queryInvalidation"] | undefined => {
605
+ if (!a && !b) {
606
+ return undefined
607
+ }
608
+ return (defaultKey, name, input, output) => [
609
+ ...(a?.(defaultKey, name, input, output) ?? []),
610
+ ...(b?.(defaultKey, name, input, output) ?? [])
611
+ ]
612
+ }
613
+
614
+ const withDefaultInvalidation = (
615
+ mut: any,
616
+ isWithInput: boolean,
617
+ defaultInvalidation?: MutationOptionsBase["queryInvalidation"]
618
+ ) => {
619
+ if (!defaultInvalidation) return mut
620
+ const apply = (callerOpts?: MutationOptionsBase) => ({
621
+ ...callerOpts,
622
+ queryInvalidation: callerOpts?.queryInvalidation
623
+ ? mergeInvalidation(defaultInvalidation, callerOpts.queryInvalidation)
624
+ : defaultInvalidation
625
+ })
626
+ return isWithInput
627
+ ? (input: any, callerOpts?: MutationOptionsBase) => mut(input, apply(callerOpts))
628
+ : (callerOpts?: MutationOptionsBase) => mut(apply(callerOpts))
629
+ }
630
+
631
+ const makeQueryResources = <Resources extends InvalidationResources>(resources: Resources | undefined) => {
632
+ if (!resources) {
633
+ return {} as Record<string, Record<string, unknown>>
634
+ }
635
+ return resources as Record<string, Record<string, unknown>>
636
+ }
637
+
638
+ const mapQuery = <M extends RequestsAny>(
1272
639
  client: ClientFrom<M>
1273
640
  ) => {
1274
641
  const queries = Struct.keys(client).reduce(
1275
642
  (acc, key) => {
643
+ if (client[key].Request.type !== "query") {
644
+ return acc
645
+ }
1276
646
  ;(acc as any)[camelCase(key) + "Query"] = Object.assign(useQuery(client[key] as any), {
1277
647
  id: client[key].id
1278
648
  })
@@ -1284,26 +654,35 @@ export const makeClient = <RT_, RTHooks>(
1284
654
  {} as
1285
655
  & {
1286
656
  // apparently can't get JSDoc in here..
1287
- [Key in keyof typeof client as `${ToCamel<string & Key>}Query`]: Queries<RT, typeof client[Key]>["query"]
657
+ [
658
+ Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
659
+ : `${ToCamel<string & Key>}Query`
660
+ ]: Queries<RT, QueryHandler<typeof client[Key]>>["query"]
1288
661
  }
1289
662
  // todo: or suspense as an Option?
1290
663
  & {
1291
664
  // apparently can't get JSDoc in here..
1292
- [Key in keyof typeof client as `${ToCamel<string & Key>}SuspenseQuery`]: Queries<
665
+ [
666
+ Key in keyof typeof client as QueryHandler<typeof client[Key]> extends never ? never
667
+ : `${ToCamel<string & Key>}SuspenseQuery`
668
+ ]: Queries<
1293
669
  RT,
1294
- typeof client[Key]
670
+ QueryHandler<typeof client[Key]>
1295
671
  >["suspense"]
1296
672
  }
1297
673
  )
1298
674
  return queries
1299
675
  }
1300
676
 
1301
- const mapRequest = <M extends Requests>(
677
+ const mapRequest = <M extends RequestsAny>(
1302
678
  client: ClientFrom<M>
1303
679
  ) => {
1304
680
  const Command = useCommand()
1305
681
  const mutations = Struct.keys(client).reduce(
1306
682
  (acc, key) => {
683
+ if (client[key].Request.type !== "command") {
684
+ return acc
685
+ }
1307
686
  const mut = client[key].handler
1308
687
  const fn = Command.fn(client[key].id)
1309
688
  const wrap = Command.wrap({ mutate: Effect.isEffect(mut) ? () => mut : mut, id: client[key].id })
@@ -1315,118 +694,278 @@ export const makeClient = <RT_, RTHooks>(
1315
694
  return acc
1316
695
  },
1317
696
  {} as {
1318
- [Key in keyof typeof client as `${ToCamel<string & Key>}Request`]: RequestWithExtensions<
697
+ [
698
+ Key in keyof typeof client as CommandHandler<typeof client[Key]> extends never ? never
699
+ : `${ToCamel<string & Key>}Request`
700
+ ]: CommandRequestWithExtensions<
1319
701
  RT | RTHooks,
1320
- typeof client[Key]
702
+ CommandHandler<typeof client[Key]>
1321
703
  >
1322
704
  }
1323
705
  )
1324
706
  return mutations
1325
707
  }
1326
708
 
1327
- const mapMutation = <M extends Requests>(
1328
- client: ClientFrom<M>
709
+ const mapMutation = <M extends RequestsAny>(
710
+ client: ClientFrom<M>,
711
+ queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>,
712
+ invalidationResources?: InvalidationResourcesFor<M>
1329
713
  ) => {
1330
714
  const Command = useCommand()
1331
715
  const mutation = useMutation()
716
+ const invalidation = queryInvalidation?.(client)
717
+ const queryResources = makeQueryResources(invalidationResources)
1332
718
  const mutations = Struct.keys(client).reduce(
1333
719
  (acc, key) => {
1334
- const mut: any = mutation(client[key] as any)
1335
- const fn = Command.fn(client[key].id)
1336
- const wrap = Command.wrap({ mutate: Effect.isEffect(mut) ? () => mut : mut, id: client[key].id })
1337
- ;(acc as any)[camelCase(key) + "Mutation"] = Object.assign(
1338
- mut,
1339
- fn, // to get the i18n key etc.
1340
- { wrap, fn }
1341
- )
720
+ if (client[key].Request.type !== "command") {
721
+ return acc
722
+ }
723
+ const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
724
+ | InvalidationCallback<InvalidationResourcesFor<M>>
725
+ | undefined
726
+ const fromRequest = fromRequestConfig
727
+ ? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
728
+ fromRequestConfig(defaultKey, queryResources as never, input as never, output as never).map((entry) => ({
729
+ filters: entry.filters,
730
+ options: entry.options
731
+ })))
732
+ : undefined
733
+ const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
734
+ const makeProjectedMutation = (handler: any): any => {
735
+ const isWithInput = !Effect.isEffect(handler.handler)
736
+ const mut: any = withDefaultInvalidation(mutation(handler), isWithInput, mergedInvalidation)
737
+ const wrap = Command.wrap({ mutate: mut, id: client[key].id })
738
+ return Object.assign(mut, {
739
+ wrap,
740
+ project: (projectionSchema: any) => {
741
+ const projected = {
742
+ ...handler,
743
+ handler: projectHandler(handler.handler, client[key].Request.success, projectionSchema)
744
+ }
745
+ return makeProjectedMutation(projected)
746
+ }
747
+ })
748
+ }
749
+ ;(acc as any)[camelCase(key) + "Mutation"] = makeProjectedMutation(client[key] as any)
1342
750
  return acc
1343
751
  },
1344
752
  {} as {
1345
- [Key in keyof typeof client as `${ToCamel<string & Key>}Mutation`]: MutationWithExtensions<
753
+ [
754
+ Key in keyof typeof client as CommandHandler<typeof client[Key]> extends never ? never
755
+ : `${ToCamel<string & Key>}Mutation`
756
+ ]: MutationWithExtensions<
1346
757
  RT | RTHooks,
1347
- typeof client[Key]
758
+ CommandHandler<typeof client[Key]>
1348
759
  >
1349
760
  }
1350
761
  )
1351
762
  return mutations
1352
763
  }
1353
764
 
765
+ const mapStreamMutation = <M extends RequestsAny>(
766
+ client: ClientFrom<M>,
767
+ queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>,
768
+ invalidationResources?: InvalidationResourcesFor<M>
769
+ ) => {
770
+ const streamMutation = useStreamMutation()
771
+ const invalidation = queryInvalidation?.(client)
772
+ const queryResources = makeQueryResources(invalidationResources)
773
+ const streams = Struct.keys(client).reduce(
774
+ (acc, key) => {
775
+ if (client[key].Request.type !== "stream") {
776
+ return acc
777
+ }
778
+ const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
779
+ | InvalidationCallback<InvalidationResourcesFor<M>>
780
+ | undefined
781
+ const fromRequest = fromRequestConfig
782
+ ? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
783
+ fromRequestConfig(defaultKey, queryResources as never, input as never, output as never).map((entry) => ({
784
+ filters: entry.filters,
785
+ options: entry.options
786
+ })))
787
+ : undefined
788
+ const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
789
+ ;(acc as any)[camelCase(key) + "Stream"] = streamMutation(client[key] as any, mergedInvalidation)
790
+ return acc
791
+ },
792
+ {} as {
793
+ [
794
+ Key in keyof typeof client as StreamHandler<typeof client[Key]> extends never ? never
795
+ : `${ToCamel<string & Key>}Stream`
796
+ ]: StreamMutationWithExtensions<StreamHandler<typeof client[Key]>>
797
+ }
798
+ )
799
+ return streams
800
+ }
801
+
1354
802
  // make available .query, .suspense and .mutate for each operation
1355
803
  // and a .helpers with all mutations and queries
1356
- const mapClient = <M extends Requests>(
1357
- queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>
804
+ const mapClient = <M extends RequestsAny>(
805
+ queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>,
806
+ invalidationResources?: InvalidationResourcesFor<M>
1358
807
  ) =>
1359
808
  (
1360
809
  client: ClientFrom<M>
1361
810
  ) => {
1362
811
  const Command = useCommand()
1363
812
  const mutation = useMutation()
813
+ const streamMutation = useStreamMutation()
1364
814
  const invalidation = queryInvalidation?.(client)
815
+ const queryResources = makeQueryResources(invalidationResources)
1365
816
  const extended = Struct.keys(client).reduce(
1366
817
  (acc, key) => {
818
+ const requestType = client[key].Request.type
1367
819
  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
820
  const h_ = client[key].handler
1385
- const h = Effect.isEffect(h_)
821
+ const wrapInput = Effect.isEffect(h_)
1386
822
  ? () => h_
1387
823
  : (...args: [any]) => h_(...args)
824
+ const request = Effect.isEffect(h_) ? h_ : wrapInput
1388
825
  ;(acc as any)[key] = Object.assign(
1389
- h,
1390
- client[key],
1391
- fn, // to get the i18n key etc.
1392
- {
1393
- mutate,
1394
- query: useQuery(client[key] as any),
1395
- suspense: useSuspenseQuery(client[key] as any),
1396
- wrap: Command.wrap({ mutate: h, id: client[key].id }),
1397
- fn
1398
- }
826
+ requestType === "query"
827
+ ? {
828
+ ...client[key],
829
+ request,
830
+ query: useQuery(client[key] as any),
831
+ suspense: useSuspenseQuery(client[key] as any),
832
+ project: (projectionSchema: any) => {
833
+ const successSchema = client[key].Request.success
834
+ const projectionHash = projectionSchemaHash(projectionSchema)
835
+ const projected = projectHandler(h_ as any, successSchema, projectionSchema)
836
+ const fakeHandler = {
837
+ handler: projected,
838
+ id: client[key].id,
839
+ Request: client[key].Request,
840
+ options: client[key].options,
841
+ queryKeyProjectionHash: projectionHash
842
+ }
843
+ return {
844
+ request: projected,
845
+ query: useQuery(fakeHandler as any),
846
+ suspense: useSuspenseQuery(fakeHandler as any)
847
+ }
848
+ }
849
+ }
850
+ : requestType === "stream"
851
+ ? (() => {
852
+ const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
853
+ | InvalidationCallback<InvalidationResourcesFor<M>>
854
+ | undefined
855
+ const fromRequest = fromRequestConfig
856
+ ? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
857
+ fromRequestConfig(defaultKey, queryResources as never, input as never, output as never).map((
858
+ entry
859
+ ) => ({
860
+ filters: entry.filters,
861
+ options: entry.options
862
+ })))
863
+ : undefined
864
+ const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
865
+ return {
866
+ ...client[key],
867
+ request: h_,
868
+ mutateStream: streamMutation(client[key] as any, mergedInvalidation)
869
+ }
870
+ })()
871
+ : {
872
+ mutate: ((handler: any) => {
873
+ const fromRequestConfig = client[key].Request.config?.["invalidatesQueries"] as
874
+ | InvalidationCallback<InvalidationResourcesFor<M>>
875
+ | undefined
876
+ const fromRequest = fromRequestConfig
877
+ ? ((defaultKey: string[], _name: string, input?: unknown, output?: unknown) =>
878
+ fromRequestConfig(defaultKey, queryResources as never, input as never, output as never).map((
879
+ entry
880
+ ) => ({
881
+ filters: entry.filters,
882
+ options: entry.options
883
+ })))
884
+ : undefined
885
+ const mergedInvalidation = mergeInvalidation(fromRequest, invalidation?.[key])
886
+ const makeProjectedMutation = (h: any): any => {
887
+ const isWithInput = !Effect.isEffect(h.handler)
888
+ const mutate = withDefaultInvalidation(mutation(h), isWithInput, mergedInvalidation)
889
+ return Object.assign(
890
+ mutate,
891
+ {
892
+ wrap: Command.wrap({
893
+ mutate,
894
+ id: client[key].id
895
+ }),
896
+ project: (projectionSchema: any) => {
897
+ const projected = {
898
+ ...h,
899
+ handler: projectHandler(h.handler, client[key].Request.success, projectionSchema)
900
+ }
901
+ return makeProjectedMutation(projected)
902
+ }
903
+ }
904
+ )
905
+ }
906
+ return makeProjectedMutation(handler)
907
+ })(client[key] as any),
908
+ ...client[key],
909
+ ...fn, // to get the i18n key etc.
910
+ request,
911
+ fn,
912
+ wrap: Command.wrap({ mutate: wrapInput, id: client[key].id })
913
+ }
1399
914
  )
1400
915
  return acc
1401
916
  },
1402
917
  {} as {
1403
918
  [Key in keyof typeof client]:
1404
919
  & typeof client[Key]
1405
- & RequestWithExtensions<RT | RTHooks, typeof client[Key]>
1406
- & { mutate: MutationWithExtensions<RT | RTHooks, typeof client[Key]> }
1407
- & Queries<RT, typeof client[Key]>
920
+ & (QueryHandler<typeof client[Key]> extends never ? {}
921
+ :
922
+ & QueryRequestWithExtensions<QueryHandler<typeof client[Key]>>
923
+ & Queries<RT, QueryHandler<typeof client[Key]>>
924
+ & QueryProjection<RT, QueryHandler<typeof client[Key]>>)
925
+ & (CommandHandler<typeof client[Key]> extends never ? {}
926
+ : CommandRequestWithExtensions<RT | RTHooks, CommandHandler<typeof client[Key]>>)
927
+ & (CommandHandler<typeof client[Key]> extends never ? {}
928
+ : { mutate: MutationWithExtensions<RT | RTHooks, CommandHandler<typeof client[Key]>> })
929
+ & (StreamHandler<typeof client[Key]> extends never ? {}
930
+ : { mutateStream: StreamMutationWithExtensions<StreamHandler<typeof client[Key]>> })
931
+ & { Input: typeof client[Key] extends RequestHandlerWithInput<infer I, any, any, any, any, any> ? I : never }
1408
932
  }
1409
933
  )
1410
- return Object.assign(extended, { helpers: { ...mapRequest(client), ...mapMutation(client), ...mapQuery(client) } })
934
+ return Object.assign(extended, {
935
+ helpers: {
936
+ ...mapRequest(client),
937
+ ...mapMutation(client, queryInvalidation, invalidationResources),
938
+ ...mapStreamMutation(client, queryInvalidation, invalidationResources),
939
+ ...mapQuery(client)
940
+ }
941
+ })
1411
942
  }
1412
943
 
1413
944
  // TODO: Clean up this delay initialisation messs
1414
945
  // TODO; invalidateQueries should perhaps be configured in the Request impl themselves?
1415
- const clientFor__ = <M extends Requests>(
946
+ const clientFor__ = <M extends RequestsAny>(
1416
947
  m: M,
1417
- queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>
1418
- ) => getBaseMrt().runSync(clientFor_(m).pipe(Effect.map(mapClient(queryInvalidation))))
948
+ queryInvalidation?: QueryInvalidationFactory<M>,
949
+ invalidationResources?: InvalidationResourcesFor<M>
950
+ ) => getBaseMrt().runSync(clientFor_(m).pipe(Effect.map(mapClient(queryInvalidation, invalidationResources))))
1419
951
 
1420
952
  // delay client creation until first access
1421
953
  // the idea is that we don't need the useNuxtApp().$runtime (only available at later initialisation stage)
1422
954
  // until we are at a place where it is available..
1423
- const clientFor = <M extends Requests>(
955
+ const clientFor = <
956
+ M extends RequestsAny,
957
+ Resources extends InvalidationResourcesFor<M> = InvalidationResourcesFor<M>
958
+ >(
1424
959
  m: M,
1425
- queryInvalidation?: (client: ClientFrom<M>) => QueryInvalidation<M>
960
+ ...args: ClientForArgs<M, Resources>
1426
961
  ) => {
962
+ const [queryInvalidation, invalidationResources] = args as [
963
+ QueryInvalidationFactory<M> | undefined,
964
+ InvalidationResourcesFor<M> | undefined
965
+ ]
1427
966
  type Client = ReturnType<typeof clientFor__<M>>
1428
967
  let client: Client | undefined = undefined
1429
- const getOrMakeClient = () => (client ??= clientFor__(m, queryInvalidation))
968
+ const getOrMakeClient = () => (client ??= clientFor__(m, queryInvalidation, invalidationResources))
1430
969
 
1431
970
  // initialize on first use..
1432
971
  const proxy = Struct.keys(m).concat(["helpers"]).reduce((acc, key) => {
@@ -1444,11 +983,6 @@ export const makeClient = <RT_, RTHooks>(
1444
983
  return proxy
1445
984
  }
1446
985
 
1447
- const legacy: Legacy<RT> = {
1448
- ...mutations,
1449
- ...query
1450
- }
1451
-
1452
986
  const Command: CommanderResolved<RT, RTHooks> = {
1453
987
  ...{
1454
988
  // delay initialisation until first use...
@@ -1463,19 +997,17 @@ export const makeClient = <RT_, RTHooks>(
1463
997
  return {
1464
998
  Command,
1465
999
  useCommand,
1466
- clientFor,
1467
- legacy
1000
+ clientFor
1468
1001
  }
1469
1002
  }
1470
1003
 
1471
- export interface Legacy<R>
1472
- extends
1473
- Pick<QueryImpl<R>, "useQuery" | "useSuspenseQuery">,
1474
- Omit<LegacyMutationImpl<R>, "getRuntime" | "toast" | "intl">
1475
- {}
1476
-
1477
1004
  export type QueryInvalidation<M> = {
1478
- [K in keyof M]?: (defaultKey: string[], name: string) => {
1005
+ [K in keyof M]?: (
1006
+ defaultKey: string[],
1007
+ name: string,
1008
+ input?: unknown,
1009
+ output?: ExitResult.Exit<unknown, unknown>
1010
+ ) => {
1479
1011
  filters?: InvalidateQueryFilters | undefined
1480
1012
  options?: InvalidateOptions | undefined
1481
1013
  }[]
@@ -1497,6 +1029,6 @@ export interface CommandBase<I = void, A = void> {
1497
1029
 
1498
1030
  export interface EffectCommand<I = void, A = unknown, E = unknown> extends CommandBase<I, Fiber<A, E>> {}
1499
1031
 
1500
- export interface CommandFromRequest<I extends abstract new(...args: any) => any, A = unknown, E = unknown>
1501
- extends EffectCommand<ConstructorParameters<I>[0], A, E>
1032
+ export interface CommandFromRequest<I extends { readonly make: (...args: any[]) => any }, A = unknown, E = unknown>
1033
+ extends EffectCommand<RequestInputFromMake<I>, A, E>
1502
1034
  {}