effect-app 4.0.0-beta.21 → 4.0.0-beta.210

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 (219) hide show
  1. package/CHANGELOG.md +952 -0
  2. package/dist/Array.d.ts +1 -1
  3. package/dist/Chunk.d.ts +1 -1
  4. package/dist/Chunk.d.ts.map +1 -1
  5. package/dist/Config/SecretURL.d.ts +1 -1
  6. package/dist/Config/SecretURL.d.ts.map +1 -1
  7. package/dist/Config/SecretURL.js +2 -2
  8. package/dist/Config/internal/configSecretURL.d.ts +1 -1
  9. package/dist/Config/internal/configSecretURL.d.ts.map +1 -1
  10. package/dist/Config.d.ts +7 -0
  11. package/dist/Config.d.ts.map +1 -0
  12. package/dist/Config.js +6 -0
  13. package/dist/ConfigProvider.d.ts +39 -0
  14. package/dist/ConfigProvider.d.ts.map +1 -0
  15. package/dist/ConfigProvider.js +42 -0
  16. package/dist/Context.d.ts +40 -0
  17. package/dist/Context.d.ts.map +1 -0
  18. package/dist/Context.js +67 -0
  19. package/dist/Effect.d.ts +9 -10
  20. package/dist/Effect.d.ts.map +1 -1
  21. package/dist/Effect.js +3 -6
  22. package/dist/Function.d.ts +1 -1
  23. package/dist/Function.d.ts.map +1 -1
  24. package/dist/Inputify.type.d.ts +1 -1
  25. package/dist/Layer.d.ts +7 -6
  26. package/dist/Layer.d.ts.map +1 -1
  27. package/dist/Layer.js +1 -1
  28. package/dist/NonEmptySet.d.ts +1 -1
  29. package/dist/NonEmptySet.d.ts.map +1 -1
  30. package/dist/Option.d.ts +1 -1
  31. package/dist/Option.d.ts.map +1 -1
  32. package/dist/Pure.d.ts +5 -5
  33. package/dist/Pure.d.ts.map +1 -1
  34. package/dist/Pure.js +13 -13
  35. package/dist/Schema/Class.d.ts +66 -20
  36. package/dist/Schema/Class.d.ts.map +1 -1
  37. package/dist/Schema/Class.js +189 -22
  38. package/dist/Schema/FastCheck.d.ts +1 -1
  39. package/dist/Schema/FastCheck.d.ts.map +1 -1
  40. package/dist/Schema/Methods.d.ts +1 -1
  41. package/dist/Schema/SchemaParser.d.ts +5 -0
  42. package/dist/Schema/SchemaParser.d.ts.map +1 -0
  43. package/dist/Schema/SchemaParser.js +6 -0
  44. package/dist/Schema/SpecialJsonSchema.d.ts +33 -0
  45. package/dist/Schema/SpecialJsonSchema.d.ts.map +1 -0
  46. package/dist/Schema/SpecialJsonSchema.js +122 -0
  47. package/dist/Schema/SpecialOpenApi.d.ts +32 -0
  48. package/dist/Schema/SpecialOpenApi.d.ts.map +1 -0
  49. package/dist/Schema/SpecialOpenApi.js +123 -0
  50. package/dist/Schema/brand.d.ts +4 -2
  51. package/dist/Schema/brand.d.ts.map +1 -1
  52. package/dist/Schema/brand.js +1 -1
  53. package/dist/Schema/email.d.ts +1 -1
  54. package/dist/Schema/email.d.ts.map +1 -1
  55. package/dist/Schema/email.js +7 -4
  56. package/dist/Schema/ext.d.ts +117 -45
  57. package/dist/Schema/ext.d.ts.map +1 -1
  58. package/dist/Schema/ext.js +131 -42
  59. package/dist/Schema/moreStrings.d.ts +37 -25
  60. package/dist/Schema/moreStrings.d.ts.map +1 -1
  61. package/dist/Schema/moreStrings.js +15 -16
  62. package/dist/Schema/numbers.d.ts +15 -15
  63. package/dist/Schema/numbers.d.ts.map +1 -1
  64. package/dist/Schema/numbers.js +10 -12
  65. package/dist/Schema/phoneNumber.d.ts +1 -1
  66. package/dist/Schema/phoneNumber.d.ts.map +1 -1
  67. package/dist/Schema/phoneNumber.js +6 -3
  68. package/dist/Schema/schema.d.ts +1 -1
  69. package/dist/Schema/strings.d.ts +5 -5
  70. package/dist/Schema/strings.d.ts.map +1 -1
  71. package/dist/Schema/strings.js +1 -5
  72. package/dist/Schema.d.ts +147 -15
  73. package/dist/Schema.d.ts.map +1 -1
  74. package/dist/Schema.js +131 -16
  75. package/dist/Set.d.ts +1 -1
  76. package/dist/Set.d.ts.map +1 -1
  77. package/dist/TypeTest.d.ts +1 -1
  78. package/dist/Types.d.ts +1 -1
  79. package/dist/Widen.type.d.ts +1 -1
  80. package/dist/_ext/Array.d.ts +1 -1
  81. package/dist/_ext/Array.d.ts.map +1 -1
  82. package/dist/_ext/date.d.ts +1 -1
  83. package/dist/_ext/misc.d.ts +1 -1
  84. package/dist/_ext/ord.ext.d.ts +1 -1
  85. package/dist/_ext/ord.ext.d.ts.map +1 -1
  86. package/dist/builtin.d.ts +1 -1
  87. package/dist/builtin.d.ts.map +1 -1
  88. package/dist/client/InvalidationKeys.d.ts +29 -0
  89. package/dist/client/InvalidationKeys.d.ts.map +1 -0
  90. package/dist/client/InvalidationKeys.js +33 -0
  91. package/dist/client/apiClientFactory.d.ts +20 -32
  92. package/dist/client/apiClientFactory.d.ts.map +1 -1
  93. package/dist/client/apiClientFactory.js +95 -32
  94. package/dist/client/clientFor.d.ts +51 -17
  95. package/dist/client/clientFor.d.ts.map +1 -1
  96. package/dist/client/clientFor.js +9 -1
  97. package/dist/client/errors.d.ts +49 -25
  98. package/dist/client/errors.d.ts.map +1 -1
  99. package/dist/client/errors.js +43 -17
  100. package/dist/client/makeClient.d.ts +481 -33
  101. package/dist/client/makeClient.d.ts.map +1 -1
  102. package/dist/client/makeClient.js +66 -24
  103. package/dist/client.d.ts +2 -1
  104. package/dist/client.d.ts.map +1 -1
  105. package/dist/client.js +2 -1
  106. package/dist/faker.d.ts +1 -1
  107. package/dist/faker.d.ts.map +1 -1
  108. package/dist/http/Request.d.ts +2 -2
  109. package/dist/http/Request.d.ts.map +1 -1
  110. package/dist/http/internal/lib.d.ts +1 -1
  111. package/dist/http.d.ts +1 -1
  112. package/dist/ids.d.ts +12 -12
  113. package/dist/ids.d.ts.map +1 -1
  114. package/dist/ids.js +3 -2
  115. package/dist/index.d.ts +5 -8
  116. package/dist/index.d.ts.map +1 -1
  117. package/dist/index.js +6 -8
  118. package/dist/logger.d.ts +1 -1
  119. package/dist/middleware.d.ts +14 -8
  120. package/dist/middleware.d.ts.map +1 -1
  121. package/dist/middleware.js +14 -8
  122. package/dist/rpc/Invalidation.d.ts +402 -0
  123. package/dist/rpc/Invalidation.d.ts.map +1 -0
  124. package/dist/rpc/Invalidation.js +150 -0
  125. package/dist/rpc/MiddlewareMaker.d.ts +5 -4
  126. package/dist/rpc/MiddlewareMaker.d.ts.map +1 -1
  127. package/dist/rpc/MiddlewareMaker.js +57 -37
  128. package/dist/rpc/RpcContextMap.d.ts +3 -3
  129. package/dist/rpc/RpcContextMap.d.ts.map +1 -1
  130. package/dist/rpc/RpcContextMap.js +4 -4
  131. package/dist/rpc/RpcMiddleware.d.ts +5 -4
  132. package/dist/rpc/RpcMiddleware.d.ts.map +1 -1
  133. package/dist/rpc/RpcMiddleware.js +1 -1
  134. package/dist/rpc.d.ts +2 -2
  135. package/dist/rpc.d.ts.map +1 -1
  136. package/dist/rpc.js +2 -2
  137. package/dist/transform.d.ts +1 -1
  138. package/dist/transform.d.ts.map +1 -1
  139. package/dist/transform.js +3 -3
  140. package/dist/utils/effectify.d.ts +1 -1
  141. package/dist/utils/extend.d.ts +1 -1
  142. package/dist/utils/extend.d.ts.map +1 -1
  143. package/dist/utils/gen.d.ts +2 -2
  144. package/dist/utils/gen.d.ts.map +1 -1
  145. package/dist/utils/logLevel.d.ts +2 -2
  146. package/dist/utils/logLevel.d.ts.map +1 -1
  147. package/dist/utils/logger.d.ts +3 -3
  148. package/dist/utils/logger.d.ts.map +1 -1
  149. package/dist/utils/logger.js +3 -3
  150. package/dist/utils.d.ts +31 -38
  151. package/dist/utils.d.ts.map +1 -1
  152. package/dist/utils.js +12 -25
  153. package/dist/validation/validators.d.ts +1 -1
  154. package/dist/validation/validators.d.ts.map +1 -1
  155. package/dist/validation.d.ts +1 -1
  156. package/dist/validation.d.ts.map +1 -1
  157. package/package.json +46 -24
  158. package/src/Config/SecretURL.ts +2 -1
  159. package/src/Config.ts +14 -0
  160. package/src/ConfigProvider.ts +48 -0
  161. package/src/{ServiceMap.ts → Context.ts} +52 -59
  162. package/src/Effect.ts +12 -14
  163. package/src/Layer.ts +6 -5
  164. package/src/Pure.ts +17 -18
  165. package/src/Schema/Class.ts +268 -62
  166. package/src/Schema/SchemaParser.ts +12 -0
  167. package/src/Schema/SpecialJsonSchema.ts +137 -0
  168. package/src/Schema/SpecialOpenApi.ts +130 -0
  169. package/src/Schema/brand.ts +21 -1
  170. package/src/Schema/email.ts +7 -2
  171. package/src/Schema/ext.ts +204 -72
  172. package/src/Schema/moreStrings.ts +40 -37
  173. package/src/Schema/numbers.ts +14 -16
  174. package/src/Schema/phoneNumber.ts +5 -1
  175. package/src/Schema/strings.ts +4 -8
  176. package/src/Schema.ts +314 -20
  177. package/src/client/InvalidationKeys.ts +50 -0
  178. package/src/client/apiClientFactory.ts +223 -129
  179. package/src/client/clientFor.ts +95 -29
  180. package/src/client/errors.ts +52 -26
  181. package/src/client/makeClient.ts +572 -71
  182. package/src/client.ts +1 -0
  183. package/src/ids.ts +3 -2
  184. package/src/index.ts +5 -10
  185. package/src/middleware.ts +13 -9
  186. package/src/rpc/Invalidation.ts +226 -0
  187. package/src/rpc/MiddlewareMaker.ts +65 -60
  188. package/src/rpc/README.md +2 -2
  189. package/src/rpc/RpcContextMap.ts +6 -5
  190. package/src/rpc/RpcMiddleware.ts +5 -4
  191. package/src/rpc.ts +1 -1
  192. package/src/transform.ts +2 -2
  193. package/src/utils/gen.ts +1 -1
  194. package/src/utils/logger.ts +2 -2
  195. package/src/utils.ts +50 -132
  196. package/test/dist/rpc.test.d.ts.map +1 -1
  197. package/test/dist/secretURL.test.d.ts.map +1 -0
  198. package/test/dist/special.test.d.ts.map +1 -0
  199. package/test/dist/stream-error.types.d.ts +2 -0
  200. package/test/dist/stream-error.types.d.ts.map +1 -0
  201. package/test/dist/stream-error.types.js +27 -0
  202. package/test/rpc.test.ts +45 -6
  203. package/test/schema.test.ts +581 -7
  204. package/test/secretURL.test.ts +157 -0
  205. package/test/special.test.ts +1023 -0
  206. package/test/utils.test.ts +6 -6
  207. package/tsconfig.base.json +3 -4
  208. package/tsconfig.json +0 -1
  209. package/tsconfig.json.bak +2 -2
  210. package/tsconfig.src.json +29 -29
  211. package/tsconfig.test.json +2 -2
  212. package/dist/Operations.d.ts +0 -123
  213. package/dist/Operations.d.ts.map +0 -1
  214. package/dist/Operations.js +0 -29
  215. package/dist/ServiceMap.d.ts +0 -44
  216. package/dist/ServiceMap.d.ts.map +0 -1
  217. package/dist/ServiceMap.js +0 -91
  218. package/eslint.config.mjs +0 -26
  219. package/src/Operations.ts +0 -55
@@ -1,19 +1,22 @@
1
1
  /* eslint-disable @typescript-eslint/no-explicit-any */
2
- import * as Config from "effect/Config"
3
- import { flow } from "effect/Function"
2
+ import { constant, flow } from "effect/Function"
4
3
  import * as Layer from "effect/Layer"
5
4
  import * as ManagedRuntime from "effect/ManagedRuntime"
5
+ import * as Option from "effect/Option"
6
6
  import * as Predicate from "effect/Predicate"
7
7
  import * as Schema from "effect/Schema"
8
+ import * as Stream from "effect/Stream"
8
9
  import * as Struct from "effect/Struct"
9
10
  import { Rpc, RpcClient, RpcGroup, RpcSerialization } from "effect/unstable/rpc"
11
+ import * as Config from "../Config.js"
12
+ import * as Context from "../Context.js"
10
13
  import * as Effect from "../Effect.js"
11
14
  import { HttpClient, HttpClientRequest } from "../http.js"
12
- import * as Option from "../Option.js"
15
+ import { Invalidation } from "../rpc.js"
13
16
  import type * as S from "../Schema.js"
14
- import * as ServiceMap from "../ServiceMap.js"
15
17
  import { typedKeysOf, typedValuesOf } from "../utils.js"
16
- import type { Client, ClientForOptions, Requests, RequestsAny } from "./clientFor.js"
18
+ import type { Client, ClientForOptions, ExtractModuleName, RequestsAny } from "./clientFor.js"
19
+ import { InvalidationKeysFromServer } from "./InvalidationKeys.js"
17
20
 
18
21
  export interface ApiConfig {
19
22
  url: string
@@ -31,16 +34,22 @@ export const DefaultApiConfig = Config.all({
31
34
  })
32
35
 
33
36
  export type Req = S.Top & {
34
- new(...args: any[]): any
37
+ readonly make: (...args: any[]) => any
35
38
  _tag: string
36
39
  fields: S.Struct.Fields
37
40
  success: S.Top
38
41
  error: S.Top
42
+ /** Optional final-value schema for stream requests. When set, the execute effect resolves with the last stream value decoded to this type. */
43
+ final?: S.Top
39
44
  config?: Record<string, any>
40
- readonly "~decodingServices"?: unknown
45
+ readonly id: string
46
+ readonly moduleName: string
47
+ readonly type: "command" | "query"
48
+ readonly stream: boolean
49
+ readonly middleware?: unknown
41
50
  }
42
51
 
43
- class RequestName extends ServiceMap.Reference("RequestName", {
52
+ class RequestName extends Context.Reference("RequestName", {
44
53
  defaultValue: () => ({ requestName: "Unspecified", moduleName: "Error" })
45
54
  }) {}
46
55
 
@@ -84,7 +93,7 @@ type RpcHandlers<M extends RequestsAny> = {
84
93
  [K in keyof M]: Rpc.Rpc<M[K]["_tag"], M[K], M[K]["success"], M[K]["error"]>
85
94
  }
86
95
 
87
- const getFiltered = <M extends Requests>(resource: M) => {
96
+ const getFiltered = <M extends RequestsAny>(resource: M) => {
88
97
  type Filtered = {
89
98
  [K in keyof M as M[K] extends Req ? K : never]: M[K] extends Req ? M[K] : never
90
99
  }
@@ -102,44 +111,60 @@ const getFiltered = <M extends Requests>(resource: M) => {
102
111
  return filtered as unknown as Filtered
103
112
  }
104
113
 
105
- export const getMeta = <M extends Requests>(resource: M) => {
106
- const meta = (resource as any).meta as { moduleName: string }
107
- if (!meta) throw new Error("No meta defined in Resource!")
108
- return meta as M["meta"]
114
+ export const getMeta = <M extends RequestsAny>(
115
+ resource: M
116
+ ): { moduleName: ExtractModuleName<M>; middleware?: unknown } => {
117
+ const first = typedValuesOf(getFiltered(resource))[0]
118
+ if (first && "moduleName" in first) return { moduleName: first.moduleName, middleware: (first as any).middleware }
119
+ throw new Error("No moduleName on requests!")
109
120
  }
110
121
 
111
- export const makeRpcGroupFromRequestsAndModuleName = <M extends Requests, const ModuleName extends string>(
122
+ export const makeRpcGroupFromRequestsAndModuleName = <M extends RequestsAny, const ModuleName extends string>(
112
123
  resource: M,
113
- moduleName: ModuleName
124
+ moduleName: ModuleName,
125
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
126
+ middleware?: any
114
127
  ) => {
115
128
  const filtered = getFiltered(resource)
116
129
  type newM = typeof filtered
117
- const rpcs = RpcGroup
130
+ const baseRpcs = RpcGroup
118
131
  .make(
119
132
  ...typedValuesOf(filtered).map((_) => {
120
- return Rpc.make((_ as any)._tag, { payload: _ as any, success: (_ as any).success, error: (_ as any).error })
133
+ const r = _ as any
134
+ const isStream = r.stream
135
+ const isCommand = r.type === "command"
136
+ return (isCommand
137
+ ? isStream
138
+ ? Invalidation.makeStreamRpc(r._tag, {
139
+ payload: r,
140
+ success: r.success,
141
+ error: r.error,
142
+ stream: true as const
143
+ })
144
+ : Invalidation.makeCommandRpc(r._tag, { payload: r, success: r.success, error: r.error })
145
+ : Rpc.make(r._tag, { payload: r, success: r.success, error: r.error, stream: isStream })) as any
121
146
  })
122
147
  )
123
- .prefix(`${moduleName}.`) as unknown as RpcGroup.RpcGroup<
124
- Rpc.Prefixed<RpcHandlers<newM>[keyof newM], `${ModuleName}.`>
125
- >
148
+ .prefix(`${moduleName}.`)
149
+ // Attach the middleware tag (schema-only on the client — no Live invoked)
150
+ // so its declared `error` joins the rpc failure union via
151
+ // `Rpc.exitSchema`'s `rpc.middlewares[*].error` walk. Required for stream
152
+ // rpcs whose top-level `errorSchema` is forced to `Never` by effect-rpc;
153
+ // without it, middleware-thrown errors fail client decode.
154
+ const rpcs = (middleware ? baseRpcs.middleware(middleware) : baseRpcs) as unknown as RpcGroup.RpcGroup<
155
+ Rpc.Prefixed<RpcHandlers<newM>[keyof newM], `${ModuleName}.`>
156
+ >
126
157
  return rpcs
127
158
  }
128
159
 
129
- export const makeRpcGroup = <
130
- M extends Requests,
131
- const ModuleName extends string
132
- >(
133
- resource: M & { meta: { moduleName: ModuleName } }
134
- ) => makeRpcGroupFromRequestsAndModuleName(resource, resource.meta.moduleName)
135
-
136
- const makeRpcTag = <M extends Requests>(resource: M) => {
160
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
161
+ const makeRpcTag = <M extends RequestsAny>(resource: M, middleware?: any) => {
137
162
  const meta = getMeta(resource)
138
- const rpcs = makeRpcGroupFromRequestsAndModuleName(resource, meta.moduleName)
163
+ const rpcs = makeRpcGroupFromRequestsAndModuleName(resource, meta.moduleName, middleware)
139
164
 
140
165
  // Use Object.assign instead of class extension to avoid TS2509 with complex generic return types.
141
166
  // The first type arg is `any` because this is a dynamically created tag — its identity is the string key.
142
- const TheClient = ServiceMap.Opaque<
167
+ const TheClient = Context.Opaque<
143
168
  any,
144
169
  RpcClient.RpcClient<RpcGroup.Rpcs<typeof rpcs>>
145
170
  >()(`RpcClient.${meta.moduleName}`)
@@ -153,125 +178,194 @@ const makeRpcTag = <M extends Requests>(resource: M) => {
153
178
 
154
179
  const makeApiClientFactory = Effect
155
180
  .gen(function*() {
156
- const ctx = yield* Effect.services<RpcSerialization.RpcSerialization | HttpClient.HttpClient>()
157
- const makeClientFor = <M extends Requests>(
181
+ const ctx = yield* Effect.context<RpcSerialization.RpcSerialization | HttpClient.HttpClient>()
182
+ const makeClientFor = Effect.fnUntraced(function*<M extends RequestsAny>(
158
183
  resource: M,
159
184
  requestLevelLayers = Layer.empty,
160
185
  options?: ClientForOptions
161
- ) =>
162
- Effect.gen(function*() {
163
- const TheClient = makeRpcTag(resource)
164
-
165
- const meta = getMeta(resource)
166
-
167
- // TODO: somehow we need a protocol per REQUEST kind of it seems ...
168
- // otherwise it locks up on the client, navigation remains empty...
169
- const clientLayer = TheClient.layer.pipe(
170
- // add ApiClientFactory for nested schemas
171
- // eslint-disable-next-line @typescript-eslint/no-use-before-define
172
- Layer.provide(Layer.succeed(ApiClientFactory, makeClientForCached as any)),
173
- Layer.provide(
174
- RpcClient
175
- .layerProtocolHttp({
176
- url: "" // why not here set meta.moduleName as root?
186
+ ) {
187
+ const meta = getMeta(resource)
188
+
189
+ const TheClient = makeRpcTag(resource, meta.middleware)
190
+
191
+ // TODO: somehow we need a protocol per REQUEST kind of it seems ...
192
+ // otherwise it locks up on the client, navigation remains empty...
193
+ const clientLayer = TheClient.layer.pipe(
194
+ // add ApiClientFactory for nested schemas
195
+ // eslint-disable-next-line @typescript-eslint/no-use-before-define
196
+ Layer.provide(Layer.succeed(ApiClientFactory, makeClientForCached as any)),
197
+ Layer.provide(
198
+ RpcClient
199
+ .layerProtocolHttp({ url: "" }) // why not here set meta.moduleName as root?
200
+ .pipe(
201
+ Layer.provideMerge(Layer.succeedContext(ctx))
202
+ )
203
+ )
204
+ )
205
+ const mr = ManagedRuntime.make(clientLayer)
206
+
207
+ const filtered = getFiltered(resource)
208
+
209
+ // Unwrap `CommandResponseWithMetaData` (success) and `CommandFailureWithMetaData`
210
+ // (handler-thrown failure): forward accumulated invalidation keys to
211
+ // `InvalidationKeysFromServer` and yield the raw payload / re-fail with the raw
212
+ // error. Middleware-thrown failures arrive raw on the Cause already (no wrap to
213
+ // strip) — the `else` branch passes them through.
214
+ const unwrapCommand = (eff: Effect.Effect<any, any, any>): Effect.Effect<any, any, any> =>
215
+ eff.pipe(
216
+ Effect.flatMap((result: any) =>
217
+ Effect.gen(function*() {
218
+ const keys: ReadonlyArray<Invalidation.InvalidationKey> = result?.metadata?.invalidateQueries ?? []
219
+ const invalidationKeys = yield* InvalidationKeysFromServer
220
+ yield* Effect.forEach(keys, (key) => invalidationKeys.add(key), { discard: true })
221
+ return result.payload
222
+ })
223
+ ),
224
+ Effect.catch((result: any) =>
225
+ result?._tag === "CommandFailureWithMetaData"
226
+ ? Effect.gen(function*() {
227
+ const keys: ReadonlyArray<Invalidation.InvalidationKey> = result.metadata?.invalidateQueries ?? []
228
+ const invalidationKeys = yield* InvalidationKeysFromServer
229
+ yield* Effect.forEach(keys, (key) => invalidationKeys.add(key), { discard: true })
230
+ return yield* Effect.fail(result.error)
177
231
  })
178
- .pipe(
179
- Layer.provideMerge(Layer.succeedServices(ctx))
180
- )
232
+ : Effect.fail(result)
181
233
  )
182
234
  )
183
- const mr = ManagedRuntime.make(clientLayer)
184
235
 
185
- const filtered = getFiltered(resource)
186
- return {
187
- mr,
188
- client: typedKeysOf(filtered)
189
- .reduce((prev, cur) => {
190
- const h = filtered[cur]!
191
-
192
- const Request = h
236
+ return {
237
+ mr,
238
+ client: typedKeysOf(filtered)
239
+ .reduce((prev, cur) => {
240
+ const h = filtered[cur]!
241
+
242
+ const Request = h
243
+
244
+ const id = `${meta.moduleName}.${cur as string}`
245
+ .replaceAll(".js", "")
246
+
247
+ const requestMeta = {
248
+ Request,
249
+ id,
250
+ options
251
+ }
252
+
253
+ const requestNameLayer = Layer.succeed(RequestName, {
254
+ requestName: cur as string,
255
+ moduleName: meta.moduleName
256
+ })
257
+
258
+ const layers = requestLevelLayers.pipe(Layer.provideMerge(requestNameLayer))
259
+
260
+ const fields = Struct.omit(Request.fields, ["_tag"] as const)
261
+ const requestAttr = `${meta.moduleName}.${h._tag}`
262
+ const isCommand = h.type === "command"
263
+ const isStream = h.stream
264
+
265
+ const buildEffect = (input: any) =>
266
+ mr.contextEffect.pipe(
267
+ Effect.flatMap((svcs) => {
268
+ const rpcEffect = TheClient
269
+ .use((client) => (client as any)[requestAttr]!(Request.make(input)) as Effect.Effect<any, any>)
270
+ .pipe(
271
+ Effect.provide(layers),
272
+ Effect.provide(svcs)
273
+ )
274
+ return isCommand ? unwrapCommand(rpcEffect) : rpcEffect
275
+ })
276
+ )
193
277
 
194
- const id = `${meta.moduleName}.${cur as string}`
195
- .replaceAll(".js", "")
278
+ const buildStream = (input: any) =>
279
+ Stream.unwrap(
280
+ mr.contextEffect.pipe(
281
+ Effect.flatMap((svcs) =>
282
+ TheClient
283
+ .useSync((client) => {
284
+ const rpcStream = (client as any)[requestAttr]!(
285
+ Request.make(input)
286
+ ) as Stream.Stream<any, any, any>
287
+ return rpcStream.pipe(
288
+ // Collect server invalidation keys from the "done" chunk, then discard it.
289
+ Stream.tap((item: any) =>
290
+ item._tag === "done" || item._tag === "metadata"
291
+ ? InvalidationKeysFromServer.use((svc) =>
292
+ Effect.forEach(
293
+ (item.metadata as Invalidation.CommandMetaData).invalidateQueries,
294
+ svc.add,
295
+ { discard: true }
296
+ )
297
+ )
298
+ : Effect.void
299
+ ),
300
+ Stream.filter((item: any) => item._tag === "value"),
301
+ Stream.map((item: any) => item.value),
302
+ // V2: unwrap StreamFailureChunk — forward keys from failures too,
303
+ // then re-fail with the original error so callers see the unmodified
304
+ // error type.
305
+ Stream.catch((err: any) =>
306
+ err?._tag === "error" && err?.metadata
307
+ ? Stream.fromEffect(
308
+ InvalidationKeysFromServer.use((svc) =>
309
+ Effect
310
+ .forEach(
311
+ (err.metadata as Invalidation.CommandMetaData).invalidateQueries,
312
+ svc.add,
313
+ { discard: true }
314
+ )
315
+ .pipe(Effect.flatMap(() => Effect.fail(err.error)))
316
+ )
317
+ )
318
+ : Stream.fail(err)
319
+ ),
320
+ Stream.provide(layers),
321
+ Stream.provide(svcs)
322
+ )
323
+ })
324
+ .pipe(Effect.provide(svcs))
325
+ )
326
+ )
327
+ )
196
328
 
197
- const requestMeta = {
198
- Request,
199
- id,
200
- options
329
+ // @ts-expect-error doc
330
+ prev[cur] = Object.keys(fields).length === 0
331
+ ? {
332
+ handler: isStream ? constant(buildStream({})) : constant(buildEffect({})),
333
+ ...requestMeta
334
+ }
335
+ : {
336
+ handler: isStream
337
+ ? (req: any) => buildStream(req)
338
+ : (req: any) => buildEffect(req),
339
+ ...requestMeta
201
340
  }
202
341
 
203
- const requestNameLayer = Layer.succeed(RequestName, {
204
- requestName: cur as string,
205
- moduleName: meta.moduleName
206
- })
207
-
208
- const layers = requestLevelLayers.pipe(Layer.provideMerge(requestNameLayer))
209
-
210
- const fields = Struct.omit(Request.fields, ["_tag"] as const)
211
- const requestAttr = `${meta.moduleName}.${h._tag}`
212
- // @ts-expect-error doc
213
- prev[cur] = Object.keys(fields).length === 0
214
- ? {
215
- handler: mr.servicesEffect.pipe(
216
- Effect.flatMap((svcs) =>
217
- TheClient
218
- .use((client) => (client as any)[requestAttr]!(new Request()) as Effect.Effect<any, any, never>)
219
- .pipe(
220
- Effect.provide(layers),
221
- Effect.provide(svcs)
222
- )
223
- )
224
- ),
225
- ...requestMeta
226
- }
227
- : {
228
- handler: (req: any) =>
229
- mr.servicesEffect.pipe(
230
- Effect.flatMap((svcs) =>
231
- TheClient
232
- .use((client) =>
233
- (client as any)[requestAttr]!(new Request(req)) as Effect.Effect<any, any, never>
234
- )
235
- .pipe(
236
- Effect.provide(layers),
237
- Effect.provide(svcs)
238
- )
239
- )
240
- ),
241
-
242
- ...requestMeta
243
- }
244
-
245
- return prev
246
- }, {} as Client<M, M["meta"]["moduleName"]>)
247
- }
248
- })
342
+ return prev
343
+ }, {} as Client<M, ExtractModuleName<M>>)
344
+ }
345
+ })
249
346
 
250
347
  const register: ManagedRuntime.ManagedRuntime<any, any>[] = []
251
348
  yield* Effect.addFinalizer(() => Effect.forEach(register, (mr) => mr.disposeEffect))
252
349
 
253
350
  const cacheL = new Map<any, Map<any, Client<any, any>>>()
254
351
 
255
- function makeClientForCached(requestLevelLayers: Layer.Layer<never, never, never>, options?: ClientForOptions) {
352
+ function makeClientForCached(requestLevelLayers: Layer.Layer<never>, options?: ClientForOptions) {
256
353
  let cache = cacheL.get(requestLevelLayers)
257
354
  if (!cache) {
258
355
  cache = new Map<any, Client<any, any>>()
259
356
  cacheL.set(requestLevelLayers, cache)
260
357
  }
261
358
 
262
- return <M extends Requests>(
263
- models: M
264
- ): Effect.Effect<Client<M, M["meta"]["moduleName"]>> =>
265
- Effect.gen(function*() {
266
- const found = cache.get(models)
267
- if (found) {
268
- return found
269
- }
270
- const m = yield* makeClientFor(models, requestLevelLayers, options)
271
- cache.set(models, m.client)
272
- register.push(m.mr)
273
- return m.client
274
- })
359
+ return Effect.fnUntraced(function*<M extends RequestsAny>(models: M) {
360
+ const found = cache.get(models) as Client<M, ExtractModuleName<M>> | undefined
361
+ if (found) {
362
+ return found
363
+ }
364
+ const m = yield* makeClientFor(models, requestLevelLayers, options)
365
+ cache.set(models, m.client)
366
+ register.push(m.mr)
367
+ return m.client
368
+ })
275
369
  }
276
370
 
277
371
  return makeClientForCached
@@ -281,7 +375,7 @@ const makeApiClientFactory = Effect
281
375
  * Used to create clients for resource modules.
282
376
  */
283
377
  export class ApiClientFactory
284
- extends ServiceMap.Opaque<ApiClientFactory, Effect.Success<typeof makeApiClientFactory>>()("ApiClientFactory")
378
+ extends Context.Opaque<ApiClientFactory, Effect.Success<typeof makeApiClientFactory>>()("ApiClientFactory")
285
379
  {
286
380
  static readonly layer = (config: ApiConfig) =>
287
381
  ApiClientFactory.toLayer(makeApiClientFactory).pipe(Layer.provide(RpcSerializationLayer(config)))
@@ -293,8 +387,8 @@ export class ApiClientFactory
293
387
  )
294
388
 
295
389
  static readonly makeFor =
296
- (requestLevelLayers: Layer.Layer<never, never, never>, options?: ClientForOptions) =>
297
- <M extends Requests>(
390
+ (requestLevelLayers: Layer.Layer<never>, options?: ClientForOptions) =>
391
+ <M extends RequestsAny>(
298
392
  resource: M
299
393
  ) =>
300
394
  ApiClientFactory.use((apiClientFactory) => {
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable @typescript-eslint/no-explicit-any */
3
3
 
4
4
  import * as Record from "effect/Record"
5
- import type * as Request from "effect/Request"
5
+ import type * as Stream from "effect/Stream"
6
6
  import type { Path } from "path-parser"
7
7
  import qs from "query-string"
8
8
  import type * as Effect from "../Effect.js"
@@ -48,9 +48,14 @@ export function makePathWithBody(
48
48
  return path.build(pars, { ignoreSearch: true, ignoreConstraints: true })
49
49
  }
50
50
 
51
- export type Requests<ModuleName extends string = string> = { meta: { moduleName: ModuleName } } & RequestsAny
51
+ export type Requests = RequestsAny
52
52
  export type RequestsAny = Record<string, any>
53
53
 
54
+ export type ExtractModuleName<M extends RequestsAny> =
55
+ { [K in keyof M]: M[K] extends { moduleName: infer N extends string } ? N : never }[keyof M] extends
56
+ infer R extends string ? R
57
+ : string
58
+
54
59
  export type Client<M extends RequestsAny, ModuleName extends string> = RequestHandlers<
55
60
  never,
56
61
  never,
@@ -66,48 +71,109 @@ export type ExtractEResponse<T> = T extends S.Codec<any> ? S.Codec.Encoded<T>
66
71
  : T extends unknown ? void
67
72
  : never
68
73
 
69
- type IsEmpty<T> = keyof T extends never ? true
70
- : false
71
-
72
- // v4: Request.RequestTypeId, S.symbolSerializable, S.symbolWithResult removed — use keyof Request to filter internal props
73
- type Cruft = "_tag" | keyof Request.Request<any, any, any>
74
-
75
74
  export interface ClientForOptions {
76
75
  readonly skipQueryKey?: readonly string[]
76
+ /**
77
+ * Middleware tag to attach to every rpc on the client. Schema-only — the
78
+ * client never invokes the middleware (no Live impl required), but its
79
+ * declared `error` schema joins the rpc failure union via
80
+ * `Rpc.exitSchema`'s `rpc.middlewares[*].error` walk. Required when
81
+ * middleware can throw errors that aren't part of the resource's declared
82
+ * error union (e.g. auth middleware throwing `NotLoggedInError`); without
83
+ * it the client decode would fail with a `SchemaError` for stream rpcs.
84
+ */
77
85
  }
78
86
 
79
- export interface RequestHandler<A, E, R, Request extends Req, Id extends string> {
80
- handler: Effect.Effect<A, E, R>
87
+ // $Project/$Configuration.Index
88
+ // -> "$Project", "$Configuration", "Index"
89
+ export const makeQueryKey = ({ id, options }: { id: string; options?: ClientForOptions }) =>
90
+ id
91
+ .split("/")
92
+ .filter((segment: string) => !options || !options.skipQueryKey?.includes(segment))
93
+ .map((segment: string) => "$" + segment)
94
+ .join(".")
95
+ .split(".")
96
+
97
+ export interface RequestHandlerWithInput<I, A, E, R, Request extends Req, Id extends string> {
98
+ handler: (i: I) => Effect.Effect<A, E, R>
81
99
  id: Id
82
100
  options?: ClientForOptions
83
101
  Request: Request
84
102
  }
85
103
 
86
- export interface RequestHandlerWithInput<I, A, E, R, Request extends Req, Id extends string> {
87
- handler: (i: I) => Effect.Effect<A, E, R>
104
+ /** Type alias: a no-input handler is simply `RequestHandlerWithInput<void, …>`. */
105
+ export type RequestHandler<A, E, R, Request extends Req, Id extends string> = RequestHandlerWithInput<
106
+ void,
107
+ A,
108
+ E,
109
+ R,
110
+ Request,
111
+ Id
112
+ >
113
+
114
+ export interface RequestStreamHandlerWithInput<I, A, E, R, Request extends Req, Id extends string, Final = A> {
115
+ handler: (i: I) => Stream.Stream<A, E, R>
88
116
  id: Id
89
117
  options?: ClientForOptions
90
118
  Request: Request
119
+ /**
120
+ * Phantom type property (never set at runtime) that carries the `Final` type to
121
+ * `StreamMutationWithExtensions`. The tilde prefix follows the Effect convention for
122
+ * phantom/virtual properties and prevents accidental runtime access.
123
+ * Stream failures bubble through the execute effect's typed error channel `E`;
124
+ * the reactive `AsyncResult` ref also mirrors the failure for live progress UI.
125
+ */
126
+ readonly "~final"?: Final
91
127
  }
92
128
 
129
+ /** Type alias: a no-input stream handler is simply `RequestStreamHandlerWithInput<void, …>`. */
130
+ export type RequestStreamHandler<A, E, R, Request extends Req, Id extends string, Final = A> =
131
+ RequestStreamHandlerWithInput<void, A, E, R, Request, Id, Final>
132
+
93
133
  // make sure this is exported or d.ts of apiClientFactory breaks?!
94
- type ReqDecodingServices<M> = M extends { readonly "~decodingServices": infer DS } ? DS : never
134
+ export type RequestInputFromMake<I extends { readonly make: (...args: any[]) => any }> = Parameters<I["make"]> extends
135
+ [] ? void : Parameters<I["make"]>[0]
136
+
137
+ // Has no input only when the request schema declares no payload fields (the auto-added
138
+ // `_tag` field is ignored). Any payload fields (even all-optional) produce a function handler.
139
+ type HasNoFields<I> = I extends { readonly fields: infer F extends S.Struct.Fields }
140
+ ? [Exclude<keyof F, "_tag">] extends [never] ? true : false
141
+ : false
142
+
143
+ type RequestInput<I extends { readonly make: (...args: any[]) => any }> = Parameters<I["make"]>[0]
144
+
145
+ /**
146
+ * Caller-facing input type for a request. `void` when the request schema has no fields;
147
+ * otherwise `make`'s first param type.
148
+ */
149
+ export type HandlerInput<I extends { readonly make: (...args: any[]) => any }> = HasNoFields<I> extends true ? void
150
+ : RequestInput<I>
151
+
152
+ /** Extracts the final-value type from a stream request. Defaults to the success type when no `final` schema is set. */
153
+ type FinalTypeOf<T extends Req> = T extends { readonly final: infer F extends S.Top } ? S.Schema.Type<F>
154
+ : S.Schema.Type<T["success"]>
155
+
156
+ type RequestHandlerFor<R, E, T extends Req, Id extends string> = T["stream"] extends true
157
+ ? RequestStreamHandlerWithInput<
158
+ HandlerInput<T>,
159
+ S.Schema.Type<T["success"]>,
160
+ S.Schema.Type<T["error"]> | E,
161
+ R | S.Codec.DecodingServices<T["success"]> | S.Codec.DecodingServices<T["error"]>,
162
+ T,
163
+ Id,
164
+ FinalTypeOf<T>
165
+ >
166
+ : RequestHandlerWithInput<
167
+ HandlerInput<T>,
168
+ S.Schema.Type<T["success"]>,
169
+ S.Schema.Type<T["error"]> | E,
170
+ R | S.Codec.DecodingServices<T["success"]> | S.Codec.DecodingServices<T["error"]>,
171
+ T,
172
+ Id
173
+ >
95
174
 
96
175
  export type RequestHandlers<R, E, M extends RequestsAny, ModuleName extends string> = {
97
- [K in keyof M as M[K] extends Req ? K : never]: IsEmpty<Omit<S.Schema.Type<M[K]>, Cruft>> extends true
98
- ? RequestHandler<
99
- S.Schema.Type<M[K]["success"]>,
100
- S.Schema.Type<M[K]["error"]> | E,
101
- R | ReqDecodingServices<M[K]>,
102
- M[K],
103
- `${ModuleName}.${K & string}`
104
- >
105
- : RequestHandlerWithInput<
106
- Omit<S.Schema.Type<M[K]>, Cruft>,
107
- S.Schema.Type<M[K]["success"]>,
108
- S.Schema.Type<M[K]["error"]> | E,
109
- R | ReqDecodingServices<M[K]>,
110
- M[K],
111
- `${ModuleName}.${K & string}`
112
- >
176
+ [K in keyof M as M[K] extends Req ? K : never]: Extract<M[K], Req> extends infer T extends Req
177
+ ? RequestHandlerFor<R, E, T, `${ModuleName}.${K & string}`>
178
+ : never
113
179
  }