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