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
package/src/ids.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { Effect } from "effect"
1
2
  import { brandedStringId, type Codec, NonEmptyString255, StringId, type StringIdBrand, withDefaultMake } from "effect-app/Schema"
2
3
  import type { B } from "effect-app/Schema/schema"
3
4
  import type { Simplify } from "effect/Types"
@@ -17,12 +18,12 @@ export const RequestId = extendM(
17
18
  const make = StringId.make as () => NonEmptyString255
18
19
  return ({
19
20
  make,
20
- withDefault: s.pipe(S.withDefaultConstructor(make))
21
+ withDefault: S.withConstructorDefault(Effect.sync(make))(s as typeof s & S.WithoutConstructorDefault)
21
22
  })
22
23
  }
23
24
  )
24
25
  .pipe(withDefaultMake)
25
26
 
26
27
  export interface UserProfileIdBrand extends Simplify<B.Brand<"UserProfileId"> & StringIdBrand> {}
27
- export type UserProfileId = StringId & UserProfileIdBrand
28
+ export type UserProfileId = string & UserProfileIdBrand
28
29
  export const UserProfileId = brandedStringId<UserProfileId>()
package/src/index.ts CHANGED
@@ -1,24 +1,18 @@
1
+ // eslint-disable-next-line import/no-unassigned-import
1
2
  import "./builtin.js"
2
3
 
3
- import * as ServiceMap from "./ServiceMap.js"
4
-
5
4
  export * as Fnc from "./Function.js"
6
5
  export * as Utils from "./utils.js"
7
6
 
8
7
  export * as Array from "./Array.js"
8
+ export * as Config from "./Config.js"
9
+ export * as ConfigProvider from "./ConfigProvider.js"
10
+ export * as Context from "./Context.js"
9
11
  export * as Effect from "./Effect.js"
10
12
  export * as Layer from "./Layer.js"
11
13
  export * as NonEmptySet from "./NonEmptySet.js"
12
- export * as ServiceMap from "./ServiceMap.js"
13
14
  export * as Set from "./Set.js"
14
15
 
15
- export {
16
- /**
17
- * @deprecated use ServiceMap directly instead
18
- */
19
- ServiceMap as Context
20
- }
21
-
22
16
  export { type NonEmptyArray, type NonEmptyReadonlyArray } from "./Array.js"
23
17
 
24
18
  export * from "effect"
@@ -26,5 +20,6 @@ export * from "effect"
26
20
  export type * as Types from "./Types.js"
27
21
 
28
22
  export * as SecretURL from "./Config/SecretURL.js"
23
+ export * as RpcX from "./rpc.js"
29
24
  export * as S from "./Schema.js"
30
25
  export { copy } from "./utils.js"
package/src/middleware.ts CHANGED
@@ -1,21 +1,25 @@
1
1
  /* eslint-disable @typescript-eslint/no-explicit-any */
2
- import { ServiceMap } from "effect-app"
3
- import { RpcX } from "./rpc.js"
2
+ import { Context } from "effect-app"
3
+ import { RpcMiddleware } from "./rpc.js"
4
4
 
5
- export class DevMode extends ServiceMap.Reference("DevMode", { defaultValue: () => false }) {}
5
+ export class DevMode extends Context.Reference("DevMode", { defaultValue: () => false }) {}
6
6
 
7
- export class RequestCacheMiddleware
8
- extends RpcX.RpcMiddleware.Tag<RequestCacheMiddleware>()("RequestCacheMiddleware")
9
- {}
7
+ export class RequestCacheMiddleware extends RpcMiddleware.Tag<RequestCacheMiddleware>()("RequestCacheMiddleware") {}
10
8
 
11
9
  export class ConfigureInterruptibilityMiddleware
12
- extends RpcX.RpcMiddleware.Tag<ConfigureInterruptibilityMiddleware>()("ConfigureInterruptibilityMiddleware")
10
+ extends RpcMiddleware.Tag<ConfigureInterruptibilityMiddleware>()("ConfigureInterruptibilityMiddleware")
13
11
  {}
14
12
 
15
- export class LoggerMiddleware extends RpcX.RpcMiddleware.Tag<LoggerMiddleware>()("LoggerMiddleware") {}
13
+ export class LoggerMiddleware extends RpcMiddleware.Tag<LoggerMiddleware>()("LoggerMiddleware") {}
16
14
 
17
- export class DevModeMiddleware extends RpcX.RpcMiddleware.Tag<DevModeMiddleware>()("DevModeMiddleware") {}
15
+ export class DevModeMiddleware extends RpcMiddleware.Tag<DevModeMiddleware>()("DevModeMiddleware") {}
18
16
 
17
+ /**
18
+ * Generic middlewares attached by `makeRouter` to every request.
19
+ *
20
+ * Invalidation key wrap/unwrap is handled by the routing layer (server) and the
21
+ * api client factory (client) directly — there is no middleware tag for it.
22
+ */
19
23
  export const DefaultGenericMiddlewares = [
20
24
  RequestCacheMiddleware,
21
25
  ConfigureInterruptibilityMiddleware,
@@ -0,0 +1,226 @@
1
+ import * as Ref from "effect/Ref"
2
+ import { Rpc } from "effect/unstable/rpc"
3
+ import * as Context from "../Context.js"
4
+ import * as Effect from "../Effect.js"
5
+ import * as S from "../Schema.js"
6
+
7
+ /**
8
+ * A single segment within an `InvalidationKey` array.
9
+ * Accepts any JSON-compatible value: string, number, boolean, null,
10
+ * arrays and objects recursively — matching TanStack Query's `queryKey` element type.
11
+ */
12
+ export const InvalidationKeySegment = S.Json
13
+ export type InvalidationKeySegment = S.Schema.Type<typeof InvalidationKeySegment>
14
+
15
+ /** Schema for a single invalidation key – an array of segments compatible with TanStack Query `queryKey`. */
16
+ export const InvalidationKey = S.Array(InvalidationKeySegment)
17
+ export type InvalidationKey = S.Schema.Type<typeof InvalidationKey>
18
+
19
+ /** Schema for the full set of invalidation keys – an array of `InvalidationKey`. */
20
+ export const InvalidationKeys = S.Array(InvalidationKey)
21
+ export type InvalidationKeys = S.Schema.Type<typeof InvalidationKeys>
22
+
23
+ /** Metadata included in every command response for server-driven cache invalidation. */
24
+ export const CommandMetaData = S.Struct({ invalidateQueries: InvalidationKeys })
25
+ export type CommandMetaData = S.Schema.Type<typeof CommandMetaData>
26
+
27
+ /**
28
+ * Wraps a command's success schema so that the wire format carries both the `payload`
29
+ * (the handler's actual return value) and `metadata` (server-driven cache invalidation keys).
30
+ * Transparent to users: the server handler returns the plain payload and the client receives
31
+ * the plain payload — wrapping/unwrapping is handled internally by the routing layer.
32
+ */
33
+ export const CommandResponseWithMetaData = <S extends S.Top>(success: S) =>
34
+ S.Struct({ payload: success, metadata: CommandMetaData })
35
+
36
+ /**
37
+ * Wraps a command's failure schema so that the wire format carries both the `error`
38
+ * (the handler's actual failure value) and `metadata` (server-driven cache invalidation keys
39
+ * accumulated thus far before the failure occurred).
40
+ * Transparent to users: the server handler fails with the plain error and the client receives
41
+ * the plain error — wrapping/unwrapping is handled internally by the routing layer.
42
+ */
43
+ export const CommandFailureWithMetaData = <E extends S.Top>(error: E) =>
44
+ S.Struct({ _tag: S.Literal("CommandFailureWithMetaData"), error, metadata: CommandMetaData })
45
+
46
+ /**
47
+ * Stream chunk schema for stream responses with metadata.
48
+ * Each item is either a data value, an intermediate "metadata" signal carrying cache
49
+ * invalidation keys accumulated since the previous drain, or a final "done" signal.
50
+ * Transparent to users: stream handlers return plain values and clients receive plain values —
51
+ * wrapping/unwrapping is handled internally by the routing layer.
52
+ *
53
+ * The "done" chunk is always the last item in the stream and carries any remaining invalidation
54
+ * keys. An optional "metadata" chunk may appear after any "value" chunk and carries keys
55
+ * accumulated since the last drain (V3: mid-stream invalidation).
56
+ */
57
+ export const StreamResponseChunk = <S extends S.Top>(success: S) =>
58
+ S.Union([
59
+ S.Struct({ _tag: S.Literal("value"), value: success }),
60
+ S.Struct({ _tag: S.Literal("metadata"), metadata: CommandMetaData }),
61
+ S.Struct({ _tag: S.Literal("done"), metadata: CommandMetaData })
62
+ ])
63
+
64
+ export type StreamResponseChunk<A> =
65
+ | { readonly _tag: "value"; readonly value: A }
66
+ | { readonly _tag: "metadata"; readonly metadata: CommandMetaData }
67
+ | { readonly _tag: "done"; readonly metadata: CommandMetaData }
68
+
69
+ /**
70
+ * Stream chunk schema for stream failures with metadata.
71
+ * Used to signal a stream failure while still carrying cache invalidation keys
72
+ * accumulated thus far.
73
+ */
74
+ export const StreamFailureChunk = <E extends S.Top>(error: E) =>
75
+ S.Struct({ _tag: S.Literal("error"), error, metadata: CommandMetaData })
76
+
77
+ export type StreamFailureChunk<E> = { readonly _tag: "error"; readonly error: E; readonly metadata: CommandMetaData }
78
+
79
+ /**
80
+ * Context annotation for declaring static cache invalidation keys on a low-level `Rpc` definition.
81
+ * These keys are always included in the command response metadata, regardless of the handler logic.
82
+ *
83
+ * Prefer using `makeQueryKey` over raw string arrays to stay in sync with the actual query
84
+ * definitions without manual string maintenance:
85
+ *
86
+ * ```ts
87
+ * import { makeQueryKey } from "effect-app/client"
88
+ * import { Invalidation } from "effect-app/rpc"
89
+ * import * as UserRsc from "../User/index.js" // separate module to avoid circular deps
90
+ *
91
+ * class UpdateProfile extends Rpc.make("UpdateProfile", { ... })
92
+ * .annotate(Invalidation.Invalidates, [makeQueryKey(UserRsc.GetMe), makeQueryKey(UserRsc.GetProfile)]) {}
93
+ * ```
94
+ *
95
+ * **Circular dependency note:** if mutations and queries live in the same file you may hit a
96
+ * circular reference at evaluation time. The idiomatic fix is to move mutations into their own
97
+ * module (e.g. `User/mutations.ts`) that directly imports the relevant query classes rather than
98
+ * re-exporting them through a barrel.
99
+ *
100
+ * For the higher-level `Command`/`Query` builders from `makeRpcClient`, use the
101
+ * `invalidatesQueries` callback argument instead (it receives the same query keys at runtime).
102
+ */
103
+ export const Invalidates = Context.Reference<ReadonlyArray<InvalidationKey>>(
104
+ "effect-app/rpc/Invalidates",
105
+ { defaultValue: () => [] }
106
+ )
107
+ export type Invalidates = typeof Invalidates
108
+
109
+ /** The shape of the per-request service that accumulates invalidation keys. */
110
+ export interface InvalidationSetService {
111
+ readonly add: (key: InvalidationKey) => Effect.Effect<void>
112
+ readonly get: Effect.Effect<ReadonlyArray<InvalidationKey>>
113
+ /**
114
+ * V3: Reads all currently accumulated keys and resets the bucket to empty.
115
+ * Used by the stream routing layer to emit intermediate "metadata" chunks
116
+ * without re-sending keys that have already been forwarded to the client.
117
+ */
118
+ readonly drain: Effect.Effect<ReadonlyArray<InvalidationKey>>
119
+ }
120
+
121
+ /**
122
+ * Request-scoped service for accumulating invalidation keys dynamically inside a handler.
123
+ * Provided by `InvalidationMiddlewareLive` for every RPC call; has a no-op default so it is
124
+ * safe to use even when the HTTP middleware is absent (tests, workers, etc.).
125
+ *
126
+ * Use `InvalidationSet.use(_ => _.add(key))` (or `.useSync` for non-Effect callbacks) as a
127
+ * shorthand instead of yielding the service manually.
128
+ *
129
+ * Prefer `makeQueryKey` over raw string arrays so invalidation keys stay in sync with the
130
+ * actual query definitions automatically:
131
+ *
132
+ * ```ts
133
+ * import { makeQueryKey } from "effect-app/client"
134
+ * import { Effect } from "effect"
135
+ * import { Invalidation } from "effect-app/rpc"
136
+ * import * as CartRsc from "../Cart/queries.js"
137
+ * import * as UserRsc from "../User/queries.js"
138
+ *
139
+ * const handler = Effect.fnUntraced(function*(req: UpdateCartRequest) {
140
+ * const cart = yield* CartRepo.save(req.cart)
141
+ *
142
+ * // Stage 1 – unconditional: always invalidate after saving
143
+ * yield* Invalidation.InvalidationSet.use(_ => _.add(makeQueryKey(UserRsc.GetMe)))
144
+ *
145
+ * // Stage 2 – conditional: only if the cart changed state
146
+ * if (cart.isCheckedOut) {
147
+ * yield* Invalidation.InvalidationSet.use(_ => _.add(makeQueryKey(CartRsc.GetCartStats)))
148
+ * }
149
+ *
150
+ * return cart
151
+ * })
152
+ * ```
153
+ *
154
+ * You can combine static (`Invalidates` annotation) and dynamic (`InvalidationSet.use`) keys:
155
+ * the annotation pre-populates the set before the handler runs; dynamic additions accumulate
156
+ * throughout the handler. All keys are included in the command response metadata.
157
+ */
158
+ export const InvalidationSet = Context.Reference<InvalidationSetService>(
159
+ "effect-app/rpc/InvalidationSet",
160
+ {
161
+ defaultValue: () => ({
162
+ add: (_key: InvalidationKey) => Effect.void,
163
+ get: Effect.succeed([] as ReadonlyArray<InvalidationKey>),
164
+ drain: Effect.succeed([] as ReadonlyArray<InvalidationKey>)
165
+ })
166
+ }
167
+ )
168
+ export type InvalidationSet = typeof InvalidationSet
169
+
170
+ /** Creates a fresh `InvalidationSet` implementation backed by a `Ref`. */
171
+ export const makeInvalidationSet = (ref: Ref.Ref<ReadonlyArray<InvalidationKey>>): InvalidationSetService => ({
172
+ add: (key) => Ref.update(ref, (keys) => [...keys, key]),
173
+ get: Ref.get(ref),
174
+ drain: Ref.getAndSet(ref, [])
175
+ })
176
+
177
+ /**
178
+ * `Rpc.Custom` definition for command RPCs that wrap the success/error schemas
179
+ * with `CommandResponseWithMetaData` / `CommandFailureWithMetaData`. The wrap
180
+ * lets server forward accumulated invalidation keys on both success and
181
+ * handler-thrown failure paths. Middleware-thrown errors bypass the wrap
182
+ * (the handler never ran, so no metadata) and flow raw at the Cause level —
183
+ * the client decodes them via the `rpc.middlewares[*].error` failure-union
184
+ * channel of `Rpc.exitSchema`.
185
+ */
186
+ // eslint-disable-next-line import/namespace
187
+ export interface CommandRpc extends Rpc.Custom {
188
+ readonly out: Rpc.Custom.Out<
189
+ ReturnType<typeof CommandResponseWithMetaData<this["success"] & S.Top>>,
190
+ ReturnType<typeof CommandFailureWithMetaData<this["error"] & S.Top>>
191
+ >
192
+ }
193
+
194
+ /**
195
+ * Custom Rpc constructor for command RPCs.
196
+ * Wraps the success schema with `CommandResponseWithMetaData` and the error
197
+ * schema with `CommandFailureWithMetaData`.
198
+ */
199
+ export const makeCommandRpc = Rpc.custom<CommandRpc>(({ defect, error, success }) => ({
200
+ success: CommandResponseWithMetaData(success),
201
+ error: CommandFailureWithMetaData(error),
202
+ defect
203
+ }))
204
+
205
+ /**
206
+ * `Rpc.Custom` definition for stream RPCs that wrap the success/error schemas
207
+ * with `StreamResponseChunk` / `StreamFailureChunk`.
208
+ */
209
+ // eslint-disable-next-line import/namespace
210
+ export interface StreamRpc extends Rpc.Custom {
211
+ readonly out: Rpc.Custom.Out<
212
+ ReturnType<typeof StreamResponseChunk<this["success"] & S.Top>>,
213
+ ReturnType<typeof StreamFailureChunk<this["error"] & S.Top>>
214
+ >
215
+ }
216
+
217
+ /**
218
+ * Custom Rpc constructor for stream RPCs.
219
+ * Wraps the success schema with `StreamResponseChunk` and
220
+ * the error schema with `StreamFailureChunk`.
221
+ */
222
+ export const makeStreamRpc = Rpc.custom<StreamRpc>(({ defect, error, success }) => ({
223
+ success: StreamResponseChunk(success),
224
+ error: StreamFailureChunk(error),
225
+ defect
226
+ }))
@@ -1,14 +1,12 @@
1
1
  /* eslint-disable @typescript-eslint/no-explicit-any */
2
- import { Effect, Layer, type Schema, Schema as S, type Scope, ServiceMap } from "effect"
2
+ import { Effect, Layer, type Schema, Schema as S, type Scope } from "effect"
3
3
  import { type NonEmptyArray, type NonEmptyReadonlyArray } from "effect/Array"
4
4
  import { type Simplify } from "effect/Types"
5
5
  import { Rpc, type RpcGroup, type RpcSchema } from "effect/unstable/rpc"
6
6
  import { type HandlersFrom } from "effect/unstable/rpc/RpcGroup"
7
- import { type RequestId } from "effect/unstable/rpc/RpcMessage"
8
- import { type HttpHeaders } from "../http.js"
7
+ import * as Context from "../Context.js"
9
8
  import { PreludeLogger } from "../logger.js"
10
9
  import { type TypeTestId } from "../TypeTest.js"
11
- import { typedValuesOf } from "../utils.js"
12
10
  import { type GetContextConfig, type RequestContextMapTagAny, type RpcContextMap } from "./RpcContextMap.js"
13
11
  import { type AddMiddleware, type AnyDynamic, type RpcDynamic, type RpcMiddlewareV4, type TagClassAny } from "./RpcMiddleware.js"
14
12
  import * as RpcMiddlewareX from "./RpcMiddleware.js"
@@ -61,13 +59,13 @@ export interface MiddlewareMaker<
61
59
  }
62
60
  >
63
61
  {
64
- readonly layer: Layer.Layer<Self, never, ServiceMap.Service.Identifier<MiddlewareProviders[number]>>
62
+ readonly layer: Layer.Layer<Self, never, Context.Service.Identifier<MiddlewareProviders[number]>>
65
63
  readonly requestContext: RequestContextTag<RequestContextMap>
66
64
  readonly requestContextMap: RequestContextMap
67
65
  }
68
66
 
69
67
  export interface RequestContextTag<RequestContextMap extends Record<string, RpcContextMap.Any>>
70
- extends ServiceMap.Service<"RequestContextConfig", GetContextConfig<RequestContextMap>>
68
+ extends Context.Service<"RequestContextConfig", GetContextConfig<RequestContextMap>>
71
69
  {}
72
70
 
73
71
  export namespace MiddlewareMaker {
@@ -258,10 +256,10 @@ export type MiddlewaresBuilder<
258
256
  : { new(_: never): {} }
259
257
  : { new(_: never): {} })
260
258
 
261
- const middlewareMaker = <
259
+ const middlewareMaker = Effect.fnUntraced(function*<
262
260
  MiddlewareProviders extends ReadonlyArray<MiddlewareMaker.Any>
263
- >(middlewares: MiddlewareProviders): Effect.Effect<
264
- RpcMiddlewareV4<
261
+ >(middlewares: MiddlewareProviders) {
262
+ type Middleware = RpcMiddlewareV4<
265
263
  MiddlewareMaker.ManyProvided<MiddlewareProviders>,
266
264
  MiddlewareMaker.ManyErrors<MiddlewareProviders>,
267
265
  Exclude<
@@ -270,42 +268,32 @@ const middlewareMaker = <
270
268
  > extends never ? never
271
269
  : Exclude<MiddlewareMaker.ManyRequired<MiddlewareProviders>, MiddlewareMaker.ManyProvided<MiddlewareProviders>>
272
270
  >
273
- > => {
271
+ type Next = Parameters<Middleware>[0]
272
+ type Options = Parameters<Middleware>[1]
273
+
274
274
  // we want to run them in reverse order because latter middlewares will provide context to former ones
275
- middlewares = middlewares.toReversed() as any
276
-
277
- return Effect.gen(function*() {
278
- const context = yield* Effect.services()
279
-
280
- // returns a Effect/RpcMiddlewareV4 with Scope.Scope in requirements
281
- // v4: wrap middleware takes (effect, options) as two params instead of a single options bag
282
- return (
283
- next: Effect.Effect<any, any, any>,
284
- options: {
285
- readonly clientId: number
286
- readonly requestId: RequestId
287
- readonly rpc: Rpc.AnyWithProps
288
- readonly payload: unknown
289
- readonly headers: HttpHeaders.Headers
290
- }
291
- ) => {
292
- // we start with the actual handler
293
- let handler = next
294
-
295
- // inspired from Effect/RpcMiddleware
296
- for (const tag of middlewares) {
297
- // use the tag to get the middleware from context
298
- const middleware = ServiceMap.getUnsafe(context, tag)
299
-
300
- // wrap the current handler, allowing the middleware to run before and after it
301
- handler = PreludeLogger.logDebug("Applying middleware wrap " + tag.key).pipe(
302
- Effect.andThen(middleware(handler, options))
303
- ) as any
304
- }
305
- return handler
275
+ const reversed = middlewares.toReversed()
276
+ const context = yield* Effect.context()
277
+
278
+ // returns a Effect/RpcMiddlewareV4 with Scope.Scope in requirements
279
+ // v4: wrap middleware takes (effect, options) as two params instead of a single options bag
280
+ return (next: Next, options: Options) => {
281
+ // we start with the actual handler
282
+ let handler = next
283
+
284
+ // inspired from Effect/RpcMiddleware
285
+ for (const tag of reversed) {
286
+ // use the tag to get the middleware from context
287
+ const middleware = Context.getUnsafe(context, tag)
288
+
289
+ // wrap the current handler, allowing the middleware to run before and after it
290
+ handler = PreludeLogger.logDebug("Applying middleware wrap " + tag.key).pipe(
291
+ Effect.andThen(middleware(handler, options))
292
+ ) as any
306
293
  }
307
- }) as any
308
- }
294
+ return handler
295
+ }
296
+ })
309
297
 
310
298
  const makeMiddlewareBasic = <Self>() =>
311
299
  // by setting RequestContextMap beforehand, execute contextual typing does not fuck up itself to anys
@@ -321,7 +309,26 @@ const makeMiddlewareBasic = <Self>() =>
321
309
  // reverse middlewares and wrap one after the other
322
310
  const middleware = middlewareMaker(make)
323
311
 
324
- const failures = make.map((_) => _.error).filter(Boolean)
312
+ // Per-middleware error: union of the static `error` on the tag (if any) AND
313
+ // the rcm config entry pointed at by the middleware's `dynamic.key` (if any).
314
+ // Reason: middlewares declared with `dynamic: RequestContextMap.get("foo")`
315
+ // don't set a static `error` field — at runtime their `.error` defaults to
316
+ // `Schema.Never`. Without pulling from rcm, the composite middleware's
317
+ // `.error` collapses to `Never`, and `Rpc.exitSchema` (which walks
318
+ // `rpc.middlewares[*].error` to build the wire failure union) can't decode
319
+ // the actual middleware-thrown error type. Critical for stream rpcs whose
320
+ // top-level `errorSchema` is force-set to `Never` by effect-rpc.
321
+ const isMeaningfulError = (e: S.Top | undefined): e is S.Top => e !== undefined && e !== null && e !== S.Never
322
+ const rcmRecord = rcm as Record<string, RpcContextMap.Any>
323
+ const failures: Array<S.Top> = make.flatMap((_) => {
324
+ const out: Array<S.Top> = []
325
+ if (isMeaningfulError(_.error)) out.push(_.error)
326
+ const key = _.dynamic?.key as string | undefined
327
+ if (key && rcmRecord[key] && isMeaningfulError(rcmRecord[key].error)) {
328
+ out.push(rcmRecord[key].error)
329
+ }
330
+ return out
331
+ })
325
332
  const provides = make.flatMap((_) => !_.provides ? [] : Array.isArray(_.provides) ? _.provides : [_.provides])
326
333
  const requires = make
327
334
  .flatMap((_) => !_.requires ? [] : Array.isArray(_.requires) ? _.requires : [_.requires])
@@ -357,17 +364,18 @@ const makeMiddlewareBasic = <Self>() =>
357
364
  .effect(
358
365
  MiddlewareMaker,
359
366
  middleware as Effect.Effect<
360
- any,
361
- Effect.Error<typeof middleware>,
362
- Effect.Services<typeof middleware>
367
+ any
363
368
  >
369
+ // todo; they dont change the type..
370
+ // Effect.Error<typeof middleware>,
371
+ // Effect.Services<typeof middleware>
364
372
  )
365
373
 
366
374
  // add to the tag a default implementation
367
375
  return Object.assign(MiddlewareMaker, {
368
376
  layer,
369
377
  // tag to be used to retrieve the RequestContextConfig from Rpc annotations
370
- requestContext: ServiceMap.Service<"RequestContextConfig", GetContextConfig<RequestContextMap>>(
378
+ requestContext: Context.Service<"RequestContextConfig", GetContextConfig<RequestContextMap>>(
371
379
  "RequestContextConfig"
372
380
  ),
373
381
  requestContextMap: rcm
@@ -379,8 +387,8 @@ export const Tag = <Self>() =>
379
387
  const Id extends string,
380
388
  RequestContextMap extends RequestContextMapTagAny
381
389
  >(id: Id, rcm: RequestContextMap): MiddlewaresBuilder<Self, Id, RequestContextMap["config"]> => {
382
- let allMiddleware: MiddlewareMaker.Any[] = []
383
- const requestContext = ServiceMap.Service<"RequestContextConfig", GetContextConfig<RequestContextMap["config"]>>(
390
+ const allMiddleware: MiddlewareMaker.Any[] = []
391
+ const requestContext = Context.Service<"RequestContextConfig", GetContextConfig<RequestContextMap["config"]>>(
384
392
  "RequestContextConfig"
385
393
  )
386
394
  const it = {
@@ -415,19 +423,16 @@ export const Tag = <Self>() =>
415
423
  {
416
424
  const config = options?.config ?? {} as Config
417
425
 
418
- // based on the config, we must enhance (union) or set failures.
419
- // TODO: we should only include errors that are relevant based on the middleware config.ks
420
- const error = options?.error
421
- const errors = typedValuesOf(rcm.config).map((_) => _.error).filter((_) => _ && _ !== S.Never) // TODO: only the errors relevant based on config
422
- const allErrors = error ? [error, ...errors] : errors
423
- const [firstError, ...restErrors] = allErrors
424
- const newError = firstError ? S.Union([firstError, ...restErrors]) : S.Never
425
-
426
+ // The rpc's `error` schema carries ONLY the request's own declared errors.
427
+ // Middleware errors (rcm-derived) reach the wire via the middleware tag
428
+ // attached to the rpc group later (`RpcGroup.middleware(...)` at the
429
+ // routing/client level), and are unioned into the failure schema by
430
+ // `Rpc.exitSchema`'s `rpc.middlewares[*].error` walk.
426
431
  // @ts-expect-error — TypeScript can't prove Simplify<T> ≡ { [K in keyof T]: T[K] } for unresolved generics (primaryKey)
427
432
  const rpc = Rpc.make(tag, {
428
433
  ...options?.payload !== undefined ? { payload: options.payload } : {},
429
434
  ...options?.success !== undefined ? { success: options.success } : {},
430
- error: newError,
435
+ ...options?.error !== undefined ? { error: options.error } : {},
431
436
  ...options?.stream !== undefined ? { stream: options.stream } : {},
432
437
  ...options?.primaryKey !== undefined ? { primaryKey: options.primaryKey } : {}
433
438
  }) as any
@@ -437,7 +442,7 @@ export const Tag = <Self>() =>
437
442
  middleware: (...middlewares: any[]) => {
438
443
  for (const mw of middlewares) {
439
444
  // recall that we run middlewares in reverse order
440
- allMiddleware = [mw, ...allMiddleware]
445
+ allMiddleware.unshift(mw)
441
446
  }
442
447
  return allMiddleware.filter((m) => !!m.dynamic).length !== Object.keys(rcm.config).length
443
448
  // for sure, until all the dynamic middlewares are provided it's non sensical to call makeMiddlewareBasic
package/src/rpc/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  The extensions use V4 format of RPC middleware:
4
4
 
5
5
  - supports `requires` besides `provides`
6
- - `requires` and `provides` should be set as second generic argument: `Tag<Self, Config>`.
6
+ - `requires` and `provides` should be set as second generic argument: `Tag<Self, Config>`.
7
7
  - `wrap: true` is the default, there is no classic `provides: Tag`
8
8
 
9
9
  ## Features
@@ -34,7 +34,7 @@ NOTE: perhaps not as useful anymore if support for dynamic middleware gets integ
34
34
 
35
35
  ## Examples
36
36
 
37
- See [tests](../../../infra/test/rpc-multi-middleware.test.ts)
37
+ See [tests](../../../infra/test/rpc-multi-middleware.test.ts)
38
38
 
39
39
  ## Future
40
40
 
@@ -2,14 +2,15 @@
2
2
  /* eslint-disable @typescript-eslint/no-unsafe-return */
3
3
  /* eslint-disable @typescript-eslint/no-explicit-any */
4
4
 
5
- import { type Schema as S, ServiceMap } from "effect"
5
+ import { type Schema as S } from "effect"
6
6
  import { type AnyWithProps } from "effect/unstable/rpc/Rpc"
7
+ import * as Context from "../Context.js"
7
8
  import { type RpcDynamic } from "./RpcMiddleware.js"
8
9
 
9
10
  type Values<T extends Record<any, any>> = T[keyof T]
10
11
 
11
12
  /**
12
- * Middleware is inactivate by default, the Key is optional in route context, and the service is optionally provided as Effect ServiceMap.
13
+ * Middleware is inactivate by default, the Key is optional in route context, and the service is optionally provided as Effect Context.
13
14
  * Unless explicitly configured as `true`.
14
15
  */
15
16
  export type RpcContextMap<Service, E> = {
@@ -22,7 +23,7 @@ export type RpcContextMap<Service, E> = {
22
23
 
23
24
  export declare namespace RpcContextMap {
24
25
  /**
25
- * Middleware is active by default, and provides the Service at Key in route context, and the Service is provided as Effect ServiceMap.
26
+ * Middleware is active by default, and provides the Service at Key in route context, and the Service is provided as Effect Context.
26
27
  * Unless explicitly omitted.
27
28
  */
28
29
  export type Inverted<Service, E> = {
@@ -97,7 +98,7 @@ export type GetEffectError<RequestContextMap extends Record<string, RpcContextMa
97
98
  }
98
99
  >
99
100
 
100
- const tag = ServiceMap.Service("RequestContextConfig")
101
+ const tag = Context.Service("RequestContextConfig")
101
102
 
102
103
  export const makeMap = <const Config extends Record<string, RpcContextMap.Any>>(config: Config) => {
103
104
  const cls = class {
@@ -109,7 +110,7 @@ export const makeMap = <const Config extends Record<string, RpcContextMap.Any>>(
109
110
  return Object.assign(cls, {
110
111
  config, /** Retrieves RequestContextConfig out of the Rpc annotations */
111
112
  getConfig: (rpc: AnyWithProps): GetContextConfig<Config> => {
112
- return ServiceMap.getOrElse(rpc.annotations, tag as any, () => ({}))
113
+ return Context.getOrElse(rpc.annotations, tag as any, () => ({}))
113
114
  },
114
115
  /** Adapter used when setting the dynamic prop on a middleware implementation */
115
116
  get: <
@@ -1,10 +1,11 @@
1
1
  /* eslint-disable @typescript-eslint/no-unsafe-assignment */
2
2
  /* eslint-disable @typescript-eslint/no-unsafe-return */
3
3
  /* eslint-disable @typescript-eslint/no-explicit-any */
4
- import { type Effect, type Schema, type Schema as S, type Scope, type ServiceMap, type Stream } from "effect"
4
+ import { type Effect, type Schema, type Schema as S, type Scope, type Stream } from "effect"
5
5
  import { type NonEmptyReadonlyArray } from "effect/Array"
6
6
  import { type Rpc, RpcMiddleware } from "effect/unstable/rpc"
7
7
  import { type TypeId } from "effect/unstable/rpc/RpcMiddleware"
8
+ import type * as Context from "../Context.js"
8
9
  import { type GetEffectContext, type RpcContextMap } from "./RpcContextMap.js"
9
10
 
10
11
  export type RpcMiddlewareV4<Provides, E, Requires> = RpcMiddleware.RpcMiddleware<Provides, E, Requires>
@@ -102,8 +103,8 @@ export declare namespace TagClass {
102
103
  requires?: any
103
104
  provides?: any
104
105
  }
105
- > extends ServiceMap.Service<Self, Service> {
106
- new(_: never): ServiceMap.ServiceClass.Shape<Name, Service>
106
+ > extends Context.Service<Self, Service> {
107
+ new(_: never): Context.ServiceClass.Shape<Name, Service>
107
108
  readonly [TypeId]: TypeId
108
109
  readonly optional: Optional<Options>
109
110
  readonly error: FailureSchema<Options>
@@ -226,7 +227,7 @@ export type ExtractProvides<R extends Rpc.Any, Tag extends string> = R extends
226
227
  Rpc.Rpc<Tag, infer _Payload, infer _Success, infer _Error, infer _Middleware, infer _Requires> ? _Middleware extends {
227
228
  readonly provides: infer _P
228
229
  } ? [_P] extends [never] ? never
229
- : _P /*_P extends ServiceMap.Service<infer _I, infer _S> ? _I
230
+ : _P /*_P extends Context.Service<infer _I, infer _S> ? _I
230
231
  : never */
231
232
  : never
232
233
  : never
package/src/rpc.ts CHANGED
@@ -1,4 +1,4 @@
1
- export * as RpcX from "./rpc.js"
1
+ export * as Invalidation from "./rpc/Invalidation.js"
2
2
  export * as MiddlewareMaker from "./rpc/MiddlewareMaker.js"
3
3
  export * as RpcContextMap from "./rpc/RpcContextMap.js"
4
4
  export * as RpcMiddleware from "./rpc/RpcMiddleware.js"
package/src/transform.ts CHANGED
@@ -51,8 +51,8 @@ const encodeOptsAsNullable_ = (value: any, cacheMap: Map<any, any>): any => {
51
51
 
52
52
  if (
53
53
  value instanceof Date
54
- || value instanceof Function
55
- || value instanceof Promise
54
+ || typeof value === "function"
55
+ || (typeof value === "object" && value !== null && "then" in value && typeof value.then === "function")
56
56
  ) {
57
57
  return value
58
58
  }
package/src/utils/gen.ts CHANGED
@@ -15,7 +15,7 @@ export namespace EffectGenUtils {
15
15
  : EG extends (..._: infer _3) => Generator<Yieldable<any, infer _, infer E, infer _R>, infer _A, infer _2> ? E
16
16
  : never
17
17
 
18
- export type ServiceMap<EG> = EG extends Effect<infer _A, infer _E, infer R> ? R
18
+ export type Context<EG> = EG extends Effect<infer _A, infer _E, infer R> ? R
19
19
  // there could be a case where the generator function does not yield anything, so we need to handle that
20
20
  : EG extends (..._: infer _3) => Generator<never, infer _A, infer _2> ? never
21
21
  // v4: generators can yield Yieldable (Effect, Service, etc.), all have asEffect()