@confect/js 6.0.0 → 8.0.0
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 +145 -0
- package/dist/HttpClient.d.ts +9 -9
- package/dist/HttpClient.d.ts.map +1 -1
- package/dist/HttpClient.js +4 -12
- package/dist/HttpClient.js.map +1 -1
- package/dist/WebSocketClient.d.ts +12 -12
- package/dist/WebSocketClient.d.ts.map +1 -1
- package/dist/WebSocketClient.js +6 -13
- package/dist/WebSocketClient.js.map +1 -1
- package/package.json +5 -5
- package/src/HttpClient.ts +23 -18
- package/src/WebSocketClient.ts +31 -21
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,150 @@
|
|
|
1
1
|
# @confect/js
|
|
2
2
|
|
|
3
|
+
## 8.0.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 4bb2722: Bump Effect ecosystem to latest. `@effect/platform` is now `^0.96.1` and `@effect/platform-node` is now `^0.106.0` in `@confect/server`'s peer dependencies; `effect` peer is now `^3.21.2` across packages. Consumers must upgrade `@effect/platform`, `@effect/platform-node`, and `effect` in lockstep when bumping `@confect/server`.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 40c1cff: Switch sibling `@confect/*` peer-dependency specifiers from `workspace:*` to `workspace:^`. Published peer ranges are now caret-based (e.g. `^7.0.0`) instead of exact-pinned, so non-major upgrades of one `@confect/*` package no longer fall out of range for its peer dependents.
|
|
12
|
+
|
|
13
|
+
Paired with the Changesets `onlyUpdatePeerDependentsWhenOutOfRange` flag, this prevents the entire `@confect/*` family from being promoted to a major bump on every release when only minor/patch changes are present.
|
|
14
|
+
|
|
15
|
+
`@confect/cli` additionally moves `@effect/platform` from `peerDependencies` to `dependencies`, since the CLI consumes it as an internal implementation detail (for `FileSystem`/`Path`) rather than exposing it in its public API. Consumers no longer need to install `@effect/platform` themselves to use the CLI.
|
|
16
|
+
|
|
17
|
+
- Updated dependencies [4bb2722]
|
|
18
|
+
- Updated dependencies [40c1cff]
|
|
19
|
+
- @confect/core@8.0.0
|
|
20
|
+
|
|
21
|
+
## 7.0.0
|
|
22
|
+
|
|
23
|
+
### Minor Changes
|
|
24
|
+
|
|
25
|
+
- 90094d0: Add typed errors to Confect functions (queries, mutations, and actions). Declare an optional `error` schema in `FunctionSpec` and recover it as a typed value at every call site—`useQuery`, `useMutation`, `useAction`, `HttpClient`, `WebSocketClient`, and `TestConfect`—without paying for it on functions that don't fail.
|
|
26
|
+
|
|
27
|
+
Typed errors travel across the function boundary as Convex's native [`ConvexError`](https://docs.convex.dev/functions/error-handling/application-errors#throwing-application-errors): the encoded error sits in `ConvexError.data`, leaving the `returns` channel unsullied and preserving native Convex semantics for non-Confect callers of the same API.
|
|
28
|
+
|
|
29
|
+
### Authoring a function with typed errors
|
|
30
|
+
|
|
31
|
+
`FunctionSpec` constructors now accept an optional `error` schema. To support multiple error shapes, combine them with `Schema.Union`.
|
|
32
|
+
|
|
33
|
+
```ts
|
|
34
|
+
import { FunctionSpec, GenericId, GroupSpec } from "@confect/core";
|
|
35
|
+
import { Schema } from "effect";
|
|
36
|
+
|
|
37
|
+
export class NoteNotFound extends Schema.TaggedError<NoteNotFound>()(
|
|
38
|
+
"NoteNotFound",
|
|
39
|
+
{ noteId: GenericId.GenericId("notes") },
|
|
40
|
+
) {}
|
|
41
|
+
|
|
42
|
+
export const notes = GroupSpec.make("notes").addFunction(
|
|
43
|
+
FunctionSpec.publicQuery({
|
|
44
|
+
name: "getOrFail",
|
|
45
|
+
args: Schema.Struct({ noteId: GenericId.GenericId("notes") }),
|
|
46
|
+
returns: Notes.Doc,
|
|
47
|
+
error: NoteNotFound,
|
|
48
|
+
}),
|
|
49
|
+
);
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
The `FunctionImpl` for that ref can now `Effect.fail` (or `mapError` to) any value matching the declared schema. Whichever invocation path the caller takes—`useQuery`/`useMutation`/`useAction`, `HttpClient`, `WebSocketClient`, or `TestConfect`—Confect encodes the failure, transports it via `ConvexError`, and surfaces the decoded value in the appropriate channel for that call site.
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
import { FunctionImpl } from "@confect/server";
|
|
56
|
+
import { Effect } from "effect";
|
|
57
|
+
import api from "../_generated/api";
|
|
58
|
+
import { DatabaseReader } from "../_generated/services";
|
|
59
|
+
import { NoteNotFound } from "./notes.spec";
|
|
60
|
+
|
|
61
|
+
const getOrFail = FunctionImpl.make(api, "notes", "getOrFail", ({ noteId }) =>
|
|
62
|
+
Effect.gen(function* () {
|
|
63
|
+
const reader = yield* DatabaseReader;
|
|
64
|
+
return yield* reader
|
|
65
|
+
.table("notes")
|
|
66
|
+
.get(noteId)
|
|
67
|
+
.pipe(Effect.mapError(() => new NoteNotFound({ noteId })));
|
|
68
|
+
}),
|
|
69
|
+
);
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Consuming a typed error
|
|
73
|
+
|
|
74
|
+
`@confect/js` (`HttpClient`, `WebSocketClient`) and `@confect/test` (`TestConfect`) surface the decoded error in the `Effect` error channel alongside the existing `HttpClientError`/`WebSocketClientError`/`ParseError`:
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
HttpClient.query(refs.public.notes.getOrFail, { noteId });
|
|
78
|
+
// Effect.Effect<Note, NoteNotFound | HttpClientError | ParseError>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### `@confect/react`—breaking changes
|
|
82
|
+
|
|
83
|
+
`useQuery`, `useMutation`, and `useAction` now expose typed errors, and `useQuery` returns a tagged result type instead of `Returns | undefined`.
|
|
84
|
+
|
|
85
|
+
**`useQuery` now returns `QueryResult<A, E>`.** Loading and (when an `error` schema is declared) failure are reified as variants alongside success. Match on the result with `QueryResult.match`:
|
|
86
|
+
|
|
87
|
+
Before:
|
|
88
|
+
|
|
89
|
+
```tsx
|
|
90
|
+
const notes = useQuery(refs.public.notes.list, {});
|
|
91
|
+
if (notes === undefined) return <p>Loading…</p>;
|
|
92
|
+
return <NoteList notes={notes} />;
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
After:
|
|
96
|
+
|
|
97
|
+
```tsx
|
|
98
|
+
import { QueryResult, useQuery } from "@confect/react";
|
|
99
|
+
|
|
100
|
+
const notes = useQuery(refs.public.notes.list, {});
|
|
101
|
+
return QueryResult.match(notes, {
|
|
102
|
+
onLoading: (skipped) => (skipped ? null : <p>Loading…</p>),
|
|
103
|
+
onSuccess: (notes) => <NoteList notes={notes} />,
|
|
104
|
+
});
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
The `Loading` variant carries a `skipped: boolean` flag, exposed as the argument to `onLoading`. It distinguishes a query that is genuinely in flight (`skipped: false`) from one that is sitting idle because `"skip"` was passed as its args (`skipped: true`)—a distinction `convex/react`'s plain `undefined` return value cannot make. Use it to render a loading indicator only when work is actually happening, and an empty/placeholder state otherwise.
|
|
108
|
+
|
|
109
|
+
When the ref declares an `error` schema, `onFailure` becomes required and receives the decoded typed error:
|
|
110
|
+
|
|
111
|
+
```tsx
|
|
112
|
+
const lookup = useQuery(refs.public.notes.getOrFail, { noteId });
|
|
113
|
+
QueryResult.match(lookup, {
|
|
114
|
+
onLoading: (skipped) => (skipped ? null : "Looking up…"),
|
|
115
|
+
onSuccess: (note) => `Found: ${note.text}`,
|
|
116
|
+
onFailure: (error) => `Note ${error.noteId} not found.`,
|
|
117
|
+
});
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
`QueryResult` is a Confect-native type exported from `@confect/react`.
|
|
121
|
+
|
|
122
|
+
**`useMutation` and `useAction` return `Promise<Either<A, E>>` when the ref declares an `error` schema.** Refs without an `error` schema continue to resolve to `Promise<A>`, matching the prior shape and `convex/react`'s behavior.
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
const deleteOrFail = useMutation(refs.public.notes.deleteOrFail);
|
|
126
|
+
const result = await deleteOrFail({ noteId });
|
|
127
|
+
// Either.Either<null, NoteNotFound | Forbidden>
|
|
128
|
+
Either.match(result, {
|
|
129
|
+
onLeft: (error) => /* typed error */,
|
|
130
|
+
onRight: (value) => /* success */,
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
const deleteNote = useMutation(refs.public.notes.delete_); // no `error` schema
|
|
134
|
+
await deleteNote({ noteId }); // Promise<null>, as before
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Unspecified failures continue to reject the promise.
|
|
138
|
+
|
|
139
|
+
### Migration
|
|
140
|
+
- For each `useQuery` call site, replace `result === undefined` checks and direct property access with `QueryResult.match` (or the lower-level `QueryResult.isLoading`/`isSuccess`/`isFailure` predicates).
|
|
141
|
+
- For each `useMutation`/`useAction` call site whose ref now declares an `error` schema, unwrap the resolved `Either` (e.g. with `Either.match`); call sites against refs without an `error` schema need no change.
|
|
142
|
+
|
|
143
|
+
### Patch Changes
|
|
144
|
+
|
|
145
|
+
- Updated dependencies [90094d0]
|
|
146
|
+
- @confect/core@7.0.0
|
|
147
|
+
|
|
3
148
|
## 6.0.0
|
|
4
149
|
|
|
5
150
|
### Patch Changes
|
package/dist/HttpClient.d.ts
CHANGED
|
@@ -19,25 +19,25 @@ declare const HttpClient: Context.Tag<{
|
|
|
19
19
|
url: string;
|
|
20
20
|
setAuth: (token: string) => Effect.Effect<void, never, never>;
|
|
21
21
|
clearAuth: Effect.Effect<void, never, never>;
|
|
22
|
-
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, HttpClientError | ParseResult.ParseError>;
|
|
23
|
-
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, HttpClientError | ParseResult.ParseError>;
|
|
24
|
-
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, HttpClientError | ParseResult.ParseError>;
|
|
22
|
+
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, Ref.Error<Query> | HttpClientError | ParseResult.ParseError>;
|
|
23
|
+
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, Ref.Error<Mutation> | HttpClientError | ParseResult.ParseError>;
|
|
24
|
+
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, Ref.Error<Action> | HttpClientError | ParseResult.ParseError>;
|
|
25
25
|
}, {
|
|
26
26
|
url: string;
|
|
27
27
|
setAuth: (token: string) => Effect.Effect<void, never, never>;
|
|
28
28
|
clearAuth: Effect.Effect<void, never, never>;
|
|
29
|
-
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, HttpClientError | ParseResult.ParseError>;
|
|
30
|
-
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, HttpClientError | ParseResult.ParseError>;
|
|
31
|
-
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, HttpClientError | ParseResult.ParseError>;
|
|
29
|
+
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, Ref.Error<Query> | HttpClientError | ParseResult.ParseError>;
|
|
30
|
+
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, Ref.Error<Mutation> | HttpClientError | ParseResult.ParseError>;
|
|
31
|
+
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, Ref.Error<Action> | HttpClientError | ParseResult.ParseError>;
|
|
32
32
|
}>;
|
|
33
33
|
type HttpClient = typeof HttpClient.Identifier;
|
|
34
34
|
declare const layer: (address: string, options?: ConstructorParameters<typeof ConvexHttpClient>[1]) => Layer.Layer<{
|
|
35
35
|
url: string;
|
|
36
36
|
setAuth: (token: string) => Effect.Effect<void, never, never>;
|
|
37
37
|
clearAuth: Effect.Effect<void, never, never>;
|
|
38
|
-
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, HttpClientError | ParseResult.ParseError>;
|
|
39
|
-
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, HttpClientError | ParseResult.ParseError>;
|
|
40
|
-
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, HttpClientError | ParseResult.ParseError>;
|
|
38
|
+
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, Ref.Error<Query> | HttpClientError | ParseResult.ParseError>;
|
|
39
|
+
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, Ref.Error<Mutation> | HttpClientError | ParseResult.ParseError>;
|
|
40
|
+
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, Ref.Error<Action> | HttpClientError | ParseResult.ParseError>;
|
|
41
41
|
}, never, never>;
|
|
42
42
|
//#endregion
|
|
43
43
|
export { HttpClient_d_exports };
|
package/dist/HttpClient.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpClient.d.ts","names":[],"sources":["../src/HttpClient.ts"],"mappings":";;;;;;;;cAGwD,oBAAA;;;;;cAE3C,eAAA,SAAwB,oBAAA;AAFmB;;;AAAA,
|
|
1
|
+
{"version":3,"file":"HttpClient.d.ts","names":[],"sources":["../src/HttpClient.ts"],"mappings":";;;;;;;;cAGwD,oBAAA;;;;;cAE3C,eAAA,SAAwB,oBAAA;AAFmB;;;AAAA,cA4F3C,UAAA,EAAU,OAAA,CAAA,GAAA;;8BA3ES,MAAA,CAAA,MAAA;;wBAWD,GAAA,CAAI,cAAA,EAAc,GAAA,EACxC,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,eAAA,GAAkB,WAAA,CAAY,UAAA;8BAYhB,GAAA,CAAI,iBAAA,EAAiB,GAAA,EACjD,QAAA,KAAQ,IAAA,EACJ,GAAA,CAAI,YAAA,CAAa,QAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,QAAA,GACZ,GAAA,CAAI,KAAA,CAAM,QAAA,IAAY,eAAA,GAAkB,WAAA,CAAY,UAAA;0BAYvB,GAAA,CAAI,eAAA,EAAe,GAAA,EAC3C,MAAA,KAAM,IAAA,EACF,GAAA,CAAI,YAAA,CAAa,MAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,MAAA,GACZ,GAAA,CAAI,KAAA,CAAM,MAAA,IAAU,eAAA,GAAkB,WAAA,CAAY,UAAA;AAAA;;8BAlDtB,MAAA,CAAA,MAAA;;wBAWD,GAAA,CAAI,cAAA,EAAc,GAAA,EACxC,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,eAAA,GAAkB,WAAA,CAAY,UAAA;8BAYhB,GAAA,CAAI,iBAAA,EAAiB,GAAA,EACjD,QAAA,KAAQ,IAAA,EACJ,GAAA,CAAI,YAAA,CAAa,QAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,QAAA,GACZ,GAAA,CAAI,KAAA,CAAM,QAAA,IAAY,eAAA,GAAkB,WAAA,CAAY,UAAA;0BAYvB,GAAA,CAAI,eAAA,EAAe,GAAA,EAC3C,MAAA,KAAM,IAAA,EACF,GAAA,CAAI,YAAA,CAAa,MAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,MAAA,GACZ,GAAA,CAAI,KAAA,CAAM,MAAA,IAAU,eAAA,GAAkB,WAAA,CAAY,UAAA;AAAA;AAAA,KA6B1C,UAAA,UAAoB,UAAA,CAAW,UAAA;AAAA,cAE9B,KAAA,GACX,OAAA,UACA,OAAA,GAAU,qBAAA,QAA6B,gBAAA,SAAoB,KAAA,CAAA,KAAA;;8BAnF7B,MAAA,CAAA,MAAA;;wBAWD,GAAA,CAAI,cAAA,EAAc,GAAA,EACxC,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,eAAA,GAAkB,WAAA,CAAY,UAAA;8BAYhB,GAAA,CAAI,iBAAA,EAAiB,GAAA,EACjD,QAAA,KAAQ,IAAA,EACJ,GAAA,CAAI,YAAA,CAAa,QAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,QAAA,GACZ,GAAA,CAAI,KAAA,CAAM,QAAA,IAAY,eAAA,GAAkB,WAAA,CAAY,UAAA;0BAYvB,GAAA,CAAI,eAAA,EAAe,GAAA,EAC3C,MAAA,KAAM,IAAA,EACF,GAAA,CAAI,YAAA,CAAa,MAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,MAAA,GACZ,GAAA,CAAI,KAAA,CAAM,MAAA,IAAU,eAAA,GAAkB,WAAA,CAAY,UAAA;AAAA"}
|
package/dist/HttpClient.js
CHANGED
|
@@ -19,26 +19,18 @@ const make = (address, options) => {
|
|
|
19
19
|
const clearAuth = Effect.sync(() => {
|
|
20
20
|
client.clearAuth();
|
|
21
21
|
});
|
|
22
|
+
const mapUnknownError = (cause) => new HttpClientError({ cause });
|
|
22
23
|
const query = (ref, ...rest) => {
|
|
23
24
|
const args = rest[0] ?? {};
|
|
24
|
-
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) =>
|
|
25
|
-
try: () => client.query(functionReference, encodedArgs),
|
|
26
|
-
catch: (cause) => new HttpClientError({ cause })
|
|
27
|
-
}));
|
|
25
|
+
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) => client.query(functionReference, encodedArgs), mapUnknownError);
|
|
28
26
|
};
|
|
29
27
|
const mutation = (ref, ...rest) => {
|
|
30
28
|
const args = rest[0] ?? {};
|
|
31
|
-
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) =>
|
|
32
|
-
try: () => client.mutation(functionReference, encodedArgs),
|
|
33
|
-
catch: (cause) => new HttpClientError({ cause })
|
|
34
|
-
}));
|
|
29
|
+
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) => client.mutation(functionReference, encodedArgs), mapUnknownError);
|
|
35
30
|
};
|
|
36
31
|
const action = (ref, ...rest) => {
|
|
37
32
|
const args = rest[0] ?? {};
|
|
38
|
-
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) =>
|
|
39
|
-
try: () => client.action(functionReference, encodedArgs),
|
|
40
|
-
catch: (cause) => new HttpClientError({ cause })
|
|
41
|
-
}));
|
|
33
|
+
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) => client.action(functionReference, encodedArgs), mapUnknownError);
|
|
42
34
|
};
|
|
43
35
|
return {
|
|
44
36
|
url,
|
package/dist/HttpClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpClient.js","names":[],"sources":["../src/HttpClient.ts"],"sourcesContent":["import * as Ref from \"@confect/core/Ref\";\nimport { ConvexHttpClient } from \"convex/browser\";\nimport type { ParseResult } from \"effect\";\nimport { Context, Effect, Layer, Schema } from \"effect\";\n\nexport class HttpClientError extends Schema.TaggedError<HttpClientError>()(\n \"HttpClientError\",\n {\n cause: Schema.Unknown,\n },\n) {}\n\nconst make = (\n address: string,\n options?: ConstructorParameters<typeof ConvexHttpClient>[1],\n) => {\n const client = new ConvexHttpClient(address, options);\n\n const url = client.url;\n\n const setAuth = (token: string) =>\n Effect.sync(() => {\n client.setAuth(token);\n });\n\n const clearAuth = Effect.sync(() => {\n client.clearAuth();\n });\n\n const query = <Query extends Ref.AnyPublicQuery>(\n ref: Query,\n ...rest: Ref.OptionalArgs<Query>\n ): Effect.Effect<\n Ref.Returns<Query>,\n HttpClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Query>;\n return Ref.runWithCodec(ref
|
|
1
|
+
{"version":3,"file":"HttpClient.js","names":[],"sources":["../src/HttpClient.ts"],"sourcesContent":["import * as Ref from \"@confect/core/Ref\";\nimport { ConvexHttpClient } from \"convex/browser\";\nimport type { ParseResult } from \"effect\";\nimport { Context, Effect, Layer, Schema } from \"effect\";\n\nexport class HttpClientError extends Schema.TaggedError<HttpClientError>()(\n \"HttpClientError\",\n {\n cause: Schema.Unknown,\n },\n) {}\n\nconst make = (\n address: string,\n options?: ConstructorParameters<typeof ConvexHttpClient>[1],\n) => {\n const client = new ConvexHttpClient(address, options);\n\n const url = client.url;\n\n const setAuth = (token: string) =>\n Effect.sync(() => {\n client.setAuth(token);\n });\n\n const clearAuth = Effect.sync(() => {\n client.clearAuth();\n });\n\n const mapUnknownError = (cause: unknown) => new HttpClientError({ cause });\n\n const query = <Query extends Ref.AnyPublicQuery>(\n ref: Query,\n ...rest: Ref.OptionalArgs<Query>\n ): Effect.Effect<\n Ref.Returns<Query>,\n Ref.Error<Query> | HttpClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Query>;\n return Ref.runWithCodec(\n ref,\n args,\n (functionReference, encodedArgs) =>\n client.query(functionReference, encodedArgs),\n mapUnknownError,\n );\n };\n\n const mutation = <Mutation extends Ref.AnyPublicMutation>(\n ref: Mutation,\n ...rest: Ref.OptionalArgs<Mutation>\n ): Effect.Effect<\n Ref.Returns<Mutation>,\n Ref.Error<Mutation> | HttpClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Mutation>;\n return Ref.runWithCodec(\n ref,\n args,\n (functionReference, encodedArgs) =>\n client.mutation(functionReference, encodedArgs),\n mapUnknownError,\n );\n };\n\n const action = <Action extends Ref.AnyPublicAction>(\n ref: Action,\n ...rest: Ref.OptionalArgs<Action>\n ): Effect.Effect<\n Ref.Returns<Action>,\n Ref.Error<Action> | HttpClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Action>;\n return Ref.runWithCodec(\n ref,\n args,\n (functionReference, encodedArgs) =>\n client.action(functionReference, encodedArgs),\n mapUnknownError,\n );\n };\n\n return {\n url,\n setAuth,\n clearAuth,\n query,\n mutation,\n action,\n };\n};\n\n/**\n * A Confect client which uses HTTP to communicate with your Convex backend. Works in any JS runtime that supports `fetch`. Wraps [ConvexHttpClient](https://docs.convex.dev/api/classes/browser.ConvexHttpClient).\n */\nexport const HttpClient = Context.GenericTag<ReturnType<typeof make>>(\n \"@confect/js/HttpClient\",\n);\n\nexport type HttpClient = typeof HttpClient.Identifier;\n\nexport const layer = (\n address: string,\n options?: ConstructorParameters<typeof ConvexHttpClient>[1],\n) => Layer.sync(HttpClient, () => make(address, options));\n"],"mappings":";;;;;;;;;;;AAKA,IAAa,kBAAb,cAAqC,OAAO,aAA8B,CACxE,mBACA,EACE,OAAO,OAAO,SACf,CACF,CAAC;AAEF,MAAM,QACJ,SACA,YACG;CACH,MAAM,SAAS,IAAI,iBAAiB,SAAS,QAAQ;CAErD,MAAM,MAAM,OAAO;CAEnB,MAAM,WAAW,UACf,OAAO,WAAW;AAChB,SAAO,QAAQ,MAAM;GACrB;CAEJ,MAAM,YAAY,OAAO,WAAW;AAClC,SAAO,WAAW;GAClB;CAEF,MAAM,mBAAmB,UAAmB,IAAI,gBAAgB,EAAE,OAAO,CAAC;CAE1E,MAAM,SACJ,KACA,GAAG,SAIA;EACH,MAAM,OAAQ,KAAK,MAAM,EAAE;AAC3B,SAAO,IAAI,aACT,KACA,OACC,mBAAmB,gBAClB,OAAO,MAAM,mBAAmB,YAAY,EAC9C,gBACD;;CAGH,MAAM,YACJ,KACA,GAAG,SAIA;EACH,MAAM,OAAQ,KAAK,MAAM,EAAE;AAC3B,SAAO,IAAI,aACT,KACA,OACC,mBAAmB,gBAClB,OAAO,SAAS,mBAAmB,YAAY,EACjD,gBACD;;CAGH,MAAM,UACJ,KACA,GAAG,SAIA;EACH,MAAM,OAAQ,KAAK,MAAM,EAAE;AAC3B,SAAO,IAAI,aACT,KACA,OACC,mBAAmB,gBAClB,OAAO,OAAO,mBAAmB,YAAY,EAC/C,gBACD;;AAGH,QAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACD;;;;;AAMH,MAAa,aAAa,QAAQ,WAChC,yBACD;AAID,MAAa,SACX,SACA,YACG,MAAM,KAAK,kBAAkB,KAAK,SAAS,QAAQ,CAAC"}
|
|
@@ -20,19 +20,19 @@ declare const WebSocketClient: Context.Tag<{
|
|
|
20
20
|
setAuth: (fetchToken: (args: {
|
|
21
21
|
forceRefreshToken: boolean;
|
|
22
22
|
}) => Effect.Effect<string | null | undefined>, onChange?: (isAuthenticated: boolean) => Effect.Effect<void>) => Effect.Effect<void, never, never>;
|
|
23
|
-
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, WebSocketClientError | ParseResult.ParseError>;
|
|
24
|
-
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, WebSocketClientError | ParseResult.ParseError>;
|
|
25
|
-
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, WebSocketClientError | ParseResult.ParseError>;
|
|
26
|
-
reactiveQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Stream.Stream<Ref.Returns<Query>, WebSocketClientError | ParseResult.ParseError>;
|
|
23
|
+
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError>;
|
|
24
|
+
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, Ref.Error<Mutation> | WebSocketClientError | ParseResult.ParseError>;
|
|
25
|
+
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, Ref.Error<Action> | WebSocketClientError | ParseResult.ParseError>;
|
|
26
|
+
reactiveQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Stream.Stream<Ref.Returns<Query>, Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError>;
|
|
27
27
|
}, {
|
|
28
28
|
url: string;
|
|
29
29
|
setAuth: (fetchToken: (args: {
|
|
30
30
|
forceRefreshToken: boolean;
|
|
31
31
|
}) => Effect.Effect<string | null | undefined>, onChange?: (isAuthenticated: boolean) => Effect.Effect<void>) => Effect.Effect<void, never, never>;
|
|
32
|
-
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, WebSocketClientError | ParseResult.ParseError>;
|
|
33
|
-
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, WebSocketClientError | ParseResult.ParseError>;
|
|
34
|
-
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, WebSocketClientError | ParseResult.ParseError>;
|
|
35
|
-
reactiveQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Stream.Stream<Ref.Returns<Query>, WebSocketClientError | ParseResult.ParseError>;
|
|
32
|
+
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError>;
|
|
33
|
+
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, Ref.Error<Mutation> | WebSocketClientError | ParseResult.ParseError>;
|
|
34
|
+
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, Ref.Error<Action> | WebSocketClientError | ParseResult.ParseError>;
|
|
35
|
+
reactiveQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Stream.Stream<Ref.Returns<Query>, Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError>;
|
|
36
36
|
}>;
|
|
37
37
|
type WebSocketClient = typeof WebSocketClient.Identifier;
|
|
38
38
|
declare const layer: (address: string, options?: ConstructorParameters<typeof ConvexClient>[1]) => Layer.Layer<{
|
|
@@ -40,10 +40,10 @@ declare const layer: (address: string, options?: ConstructorParameters<typeof Co
|
|
|
40
40
|
setAuth: (fetchToken: (args: {
|
|
41
41
|
forceRefreshToken: boolean;
|
|
42
42
|
}) => Effect.Effect<string | null | undefined>, onChange?: (isAuthenticated: boolean) => Effect.Effect<void>) => Effect.Effect<void, never, never>;
|
|
43
|
-
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, WebSocketClientError | ParseResult.ParseError>;
|
|
44
|
-
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, WebSocketClientError | ParseResult.ParseError>;
|
|
45
|
-
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, WebSocketClientError | ParseResult.ParseError>;
|
|
46
|
-
reactiveQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Stream.Stream<Ref.Returns<Query>, WebSocketClientError | ParseResult.ParseError>;
|
|
43
|
+
query: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Effect.Effect<Ref.Returns<Query>, Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError>;
|
|
44
|
+
mutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation, ...rest: Ref.OptionalArgs<Mutation>) => Effect.Effect<Ref.Returns<Mutation>, Ref.Error<Mutation> | WebSocketClientError | ParseResult.ParseError>;
|
|
45
|
+
action: <Action extends Ref.AnyPublicAction>(ref: Action, ...rest: Ref.OptionalArgs<Action>) => Effect.Effect<Ref.Returns<Action>, Ref.Error<Action> | WebSocketClientError | ParseResult.ParseError>;
|
|
46
|
+
reactiveQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: Ref.OptionalArgs<Query>) => Stream.Stream<Ref.Returns<Query>, Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError>;
|
|
47
47
|
}, never, never>;
|
|
48
48
|
//#endregion
|
|
49
49
|
export { WebSocketClient_d_exports };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WebSocketClient.d.ts","names":[],"sources":["../src/WebSocketClient.ts"],"mappings":";;;;;;;;cAGgE,yBAAA;;;;;cAEnD,oBAAA,SAA6B,yBAAA;AAFsB;;;AAAA,
|
|
1
|
+
{"version":3,"file":"WebSocketClient.d.ts","names":[],"sources":["../src/WebSocketClient.ts"],"mappings":";;;;;;;;cAGgE,yBAAA;;;;;cAEnD,oBAAA,SAA6B,yBAAA;AAFsB;;;AAAA,cAqJnD,eAAA,EAAe,OAAA,CAAA,GAAA;;yBAhIP,IAAA;IACX,iBAAA;EAAA,MACI,MAAA,CAAO,MAAA,6BAAiC,QAAA,IAClC,eAAA,cAA6B,MAAA,CAAO,MAAA,WAAY,MAAA,CAAA,MAAA;wBAiBjC,GAAA,CAAI,cAAA,EAAc,GAAA,EACxC,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,oBAAA,GAAuB,WAAA,CAAY,UAAA;8BAYrB,GAAA,CAAI,iBAAA,EAAiB,GAAA,EACjD,QAAA,KAAQ,IAAA,EACJ,GAAA,CAAI,YAAA,CAAa,QAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,QAAA,GACZ,GAAA,CAAI,KAAA,CAAM,QAAA,IAAY,oBAAA,GAAuB,WAAA,CAAY,UAAA;0BAY5B,GAAA,CAAI,eAAA,EAAe,GAAA,EAC3C,MAAA,KAAM,IAAA,EACF,GAAA,CAAI,YAAA,CAAa,MAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,MAAA,GACZ,GAAA,CAAI,KAAA,CAAM,MAAA,IAAU,oBAAA,GAAuB,WAAA,CAAY,UAAA;gCAYpB,GAAA,CAAI,cAAA,EAAc,GAAA,EAChD,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,oBAAA,GAAuB,WAAA,CAAY,UAAA;AAAA;;yBA5EzC,IAAA;IACX,iBAAA;EAAA,MACI,MAAA,CAAO,MAAA,6BAAiC,QAAA,IAClC,eAAA,cAA6B,MAAA,CAAO,MAAA,WAAY,MAAA,CAAA,MAAA;wBAiBjC,GAAA,CAAI,cAAA,EAAc,GAAA,EACxC,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,oBAAA,GAAuB,WAAA,CAAY,UAAA;8BAYrB,GAAA,CAAI,iBAAA,EAAiB,GAAA,EACjD,QAAA,KAAQ,IAAA,EACJ,GAAA,CAAI,YAAA,CAAa,QAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,QAAA,GACZ,GAAA,CAAI,KAAA,CAAM,QAAA,IAAY,oBAAA,GAAuB,WAAA,CAAY,UAAA;0BAY5B,GAAA,CAAI,eAAA,EAAe,GAAA,EAC3C,MAAA,KAAM,IAAA,EACF,GAAA,CAAI,YAAA,CAAa,MAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,MAAA,GACZ,GAAA,CAAI,KAAA,CAAM,MAAA,IAAU,oBAAA,GAAuB,WAAA,CAAY,UAAA;gCAYpB,GAAA,CAAI,cAAA,EAAc,GAAA,EAChD,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,oBAAA,GAAuB,WAAA,CAAY,UAAA;AAAA;AAAA,KAwDlD,eAAA,UAAyB,eAAA,CAAgB,UAAA;AAAA,cAExC,KAAA,GACX,OAAA,UACA,OAAA,GAAU,qBAAA,QAA6B,YAAA,SAAgB,KAAA,CAAA,KAAA;;yBAxIpC,IAAA;IACX,iBAAA;EAAA,MACI,MAAA,CAAO,MAAA,6BAAiC,QAAA,IAClC,eAAA,cAA6B,MAAA,CAAO,MAAA,WAAY,MAAA,CAAA,MAAA;wBAiBjC,GAAA,CAAI,cAAA,EAAc,GAAA,EACxC,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,oBAAA,GAAuB,WAAA,CAAY,UAAA;8BAYrB,GAAA,CAAI,iBAAA,EAAiB,GAAA,EACjD,QAAA,KAAQ,IAAA,EACJ,GAAA,CAAI,YAAA,CAAa,QAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,QAAA,GACZ,GAAA,CAAI,KAAA,CAAM,QAAA,IAAY,oBAAA,GAAuB,WAAA,CAAY,UAAA;0BAY5B,GAAA,CAAI,eAAA,EAAe,GAAA,EAC3C,MAAA,KAAM,IAAA,EACF,GAAA,CAAI,YAAA,CAAa,MAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,MAAA,GACZ,GAAA,CAAI,KAAA,CAAM,MAAA,IAAU,oBAAA,GAAuB,WAAA,CAAY,UAAA;gCAYpB,GAAA,CAAI,cAAA,EAAc,GAAA,EAChD,KAAA,KAAK,IAAA,EACD,GAAA,CAAI,YAAA,CAAa,KAAA,MACzB,MAAA,CAAO,MAAA,CACR,GAAA,CAAI,OAAA,CAAQ,KAAA,GACZ,GAAA,CAAI,KAAA,CAAM,KAAA,IAAS,oBAAA,GAAuB,WAAA,CAAY,UAAA;AAAA"}
|
package/dist/WebSocketClient.js
CHANGED
|
@@ -15,37 +15,30 @@ const make = (address, options) => Effect.acquireRelease(Effect.sync(() => new C
|
|
|
15
15
|
const setAuth = (fetchToken, onChange) => Effect.sync(() => {
|
|
16
16
|
convexClient.setAuth((args) => Effect.runPromise(fetchToken(args)), ...onChange ? [(isAuthenticated) => Effect.runFork(onChange(isAuthenticated))] : []);
|
|
17
17
|
});
|
|
18
|
+
const mapUnknownError = (cause) => new WebSocketClientError({ cause });
|
|
18
19
|
const query = (ref, ...rest) => {
|
|
19
20
|
const args = rest[0] ?? {};
|
|
20
|
-
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) =>
|
|
21
|
-
try: () => convexClient.query(functionReference, encodedArgs),
|
|
22
|
-
catch: (cause) => new WebSocketClientError({ cause })
|
|
23
|
-
}));
|
|
21
|
+
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) => convexClient.query(functionReference, encodedArgs), mapUnknownError);
|
|
24
22
|
};
|
|
25
23
|
const mutation = (ref, ...rest) => {
|
|
26
24
|
const args = rest[0] ?? {};
|
|
27
|
-
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) =>
|
|
28
|
-
try: () => convexClient.mutation(functionReference, encodedArgs),
|
|
29
|
-
catch: (cause) => new WebSocketClientError({ cause })
|
|
30
|
-
}));
|
|
25
|
+
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) => convexClient.mutation(functionReference, encodedArgs), mapUnknownError);
|
|
31
26
|
};
|
|
32
27
|
const action = (ref, ...rest) => {
|
|
33
28
|
const args = rest[0] ?? {};
|
|
34
|
-
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) =>
|
|
35
|
-
try: () => convexClient.action(functionReference, encodedArgs),
|
|
36
|
-
catch: (cause) => new WebSocketClientError({ cause })
|
|
37
|
-
}));
|
|
29
|
+
return Ref.runWithCodec(ref, args, (functionReference, encodedArgs) => convexClient.action(functionReference, encodedArgs), mapUnknownError);
|
|
38
30
|
};
|
|
39
31
|
const reactiveQuery = (ref, ...rest) => {
|
|
40
32
|
const args = rest[0] ?? {};
|
|
41
33
|
const functionReference = Ref.getFunctionReference(ref);
|
|
34
|
+
const onError = Ref.decodeErrorOrElse(ref, mapUnknownError);
|
|
42
35
|
return Stream.unwrapScoped(Effect.gen(function* () {
|
|
43
36
|
const encodedArgs = yield* Ref.encodeArgs(ref, args);
|
|
44
37
|
return Stream.asyncScoped((emit) => Effect.gen(function* () {
|
|
45
38
|
const unsubscribe = convexClient.onUpdate(functionReference, encodedArgs, (result) => {
|
|
46
39
|
emit.single(result);
|
|
47
40
|
}, (error) => {
|
|
48
|
-
emit.fail(
|
|
41
|
+
emit.fail(onError(error));
|
|
49
42
|
});
|
|
50
43
|
yield* Effect.addFinalizer(() => Effect.sync(() => unsubscribe()));
|
|
51
44
|
}));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WebSocketClient.js","names":[],"sources":["../src/WebSocketClient.ts"],"sourcesContent":["import * as Ref from \"@confect/core/Ref\";\nimport { ConvexClient } from \"convex/browser\";\nimport type { ParseResult } from \"effect\";\nimport { Context, Effect, Layer, Schema, Stream } from \"effect\";\n\nexport class WebSocketClientError extends Schema.TaggedError<WebSocketClientError>()(\n \"WebSocketClientError\",\n {\n cause: Schema.Unknown,\n },\n) {}\n\nconst make = (\n address: string,\n options?: ConstructorParameters<typeof ConvexClient>[1],\n) =>\n Effect.acquireRelease(\n Effect.sync(() => new ConvexClient(address, options)),\n (convexClient) => Effect.promise(() => convexClient.close()),\n ).pipe(\n Effect.map((convexClient) => {\n const url = address;\n\n const setAuth = (\n fetchToken: (args: {\n forceRefreshToken: boolean;\n }) => Effect.Effect<string | null | undefined>,\n onChange?: (isAuthenticated: boolean) => Effect.Effect<void>,\n ) =>\n Effect.sync(() => {\n convexClient.setAuth(\n (args) => Effect.runPromise(fetchToken(args)),\n ...(onChange\n ? [\n (isAuthenticated: boolean) =>\n Effect.runFork(onChange(isAuthenticated)),\n ]\n : []),\n );\n });\n\n const query = <Query extends Ref.AnyPublicQuery>(\n ref: Query,\n ...rest: Ref.OptionalArgs<Query>\n ): Effect.Effect<\n Ref.Returns<Query>,\n WebSocketClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Query>;\n return Ref.runWithCodec(ref
|
|
1
|
+
{"version":3,"file":"WebSocketClient.js","names":[],"sources":["../src/WebSocketClient.ts"],"sourcesContent":["import * as Ref from \"@confect/core/Ref\";\nimport { ConvexClient } from \"convex/browser\";\nimport type { ParseResult } from \"effect\";\nimport { Context, Effect, Layer, Schema, Stream } from \"effect\";\n\nexport class WebSocketClientError extends Schema.TaggedError<WebSocketClientError>()(\n \"WebSocketClientError\",\n {\n cause: Schema.Unknown,\n },\n) {}\n\nconst make = (\n address: string,\n options?: ConstructorParameters<typeof ConvexClient>[1],\n) =>\n Effect.acquireRelease(\n Effect.sync(() => new ConvexClient(address, options)),\n (convexClient) => Effect.promise(() => convexClient.close()),\n ).pipe(\n Effect.map((convexClient) => {\n const url = address;\n\n const setAuth = (\n fetchToken: (args: {\n forceRefreshToken: boolean;\n }) => Effect.Effect<string | null | undefined>,\n onChange?: (isAuthenticated: boolean) => Effect.Effect<void>,\n ) =>\n Effect.sync(() => {\n convexClient.setAuth(\n (args) => Effect.runPromise(fetchToken(args)),\n ...(onChange\n ? [\n (isAuthenticated: boolean) =>\n Effect.runFork(onChange(isAuthenticated)),\n ]\n : []),\n );\n });\n\n const mapUnknownError = (cause: unknown) =>\n new WebSocketClientError({ cause });\n\n const query = <Query extends Ref.AnyPublicQuery>(\n ref: Query,\n ...rest: Ref.OptionalArgs<Query>\n ): Effect.Effect<\n Ref.Returns<Query>,\n Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Query>;\n return Ref.runWithCodec(\n ref,\n args,\n (functionReference, encodedArgs) =>\n convexClient.query(functionReference, encodedArgs),\n mapUnknownError,\n );\n };\n\n const mutation = <Mutation extends Ref.AnyPublicMutation>(\n ref: Mutation,\n ...rest: Ref.OptionalArgs<Mutation>\n ): Effect.Effect<\n Ref.Returns<Mutation>,\n Ref.Error<Mutation> | WebSocketClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Mutation>;\n return Ref.runWithCodec(\n ref,\n args,\n (functionReference, encodedArgs) =>\n convexClient.mutation(functionReference, encodedArgs),\n mapUnknownError,\n );\n };\n\n const action = <Action extends Ref.AnyPublicAction>(\n ref: Action,\n ...rest: Ref.OptionalArgs<Action>\n ): Effect.Effect<\n Ref.Returns<Action>,\n Ref.Error<Action> | WebSocketClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Action>;\n return Ref.runWithCodec(\n ref,\n args,\n (functionReference, encodedArgs) =>\n convexClient.action(functionReference, encodedArgs),\n mapUnknownError,\n );\n };\n\n const reactiveQuery = <Query extends Ref.AnyPublicQuery>(\n ref: Query,\n ...rest: Ref.OptionalArgs<Query>\n ): Stream.Stream<\n Ref.Returns<Query>,\n Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError\n > => {\n const args = (rest[0] ?? {}) as Ref.Args<Query>;\n const functionReference = Ref.getFunctionReference(ref);\n const onError = Ref.decodeErrorOrElse(ref, mapUnknownError);\n\n return Stream.unwrapScoped(\n Effect.gen(function* () {\n const encodedArgs = yield* Ref.encodeArgs(ref, args);\n\n return Stream.asyncScoped<\n unknown,\n Ref.Error<Query> | WebSocketClientError\n >((emit) =>\n Effect.gen(function* () {\n const unsubscribe = convexClient.onUpdate(\n functionReference,\n encodedArgs,\n (result) => {\n emit.single(result);\n },\n (error) => {\n emit.fail(onError(error));\n },\n );\n yield* Effect.addFinalizer(() =>\n Effect.sync(() => unsubscribe()),\n );\n }),\n );\n }),\n ).pipe(\n Stream.mapEffect((encodedReturns) =>\n Ref.decodeReturns(ref, encodedReturns),\n ),\n );\n };\n\n return {\n url,\n setAuth,\n query,\n mutation,\n action,\n reactiveQuery,\n };\n }),\n );\n\n/**\n * A Confect client which uses a WebSocket to communicate with your Convex backend and supports reactive query subscriptions. The WebSocket connection is managed by the layer's scope and closed automatically when the scope ends. Wraps [ConvexClient](https://docs.convex.dev/api/classes/browser.ConvexClient).\n */\nexport const WebSocketClient = Context.GenericTag<\n Effect.Effect.Success<ReturnType<typeof make>>\n>(\"@confect/js/WebSocketClient\");\n\nexport type WebSocketClient = typeof WebSocketClient.Identifier;\n\nexport const layer = (\n address: string,\n options?: ConstructorParameters<typeof ConvexClient>[1],\n) => Layer.scoped(WebSocketClient, make(address, options));\n"],"mappings":";;;;;;;;;;;AAKA,IAAa,uBAAb,cAA0C,OAAO,aAAmC,CAClF,wBACA,EACE,OAAO,OAAO,SACf,CACF,CAAC;AAEF,MAAM,QACJ,SACA,YAEA,OAAO,eACL,OAAO,WAAW,IAAI,aAAa,SAAS,QAAQ,CAAC,GACpD,iBAAiB,OAAO,cAAc,aAAa,OAAO,CAAC,CAC7D,CAAC,KACA,OAAO,KAAK,iBAAiB;CAC3B,MAAM,MAAM;CAEZ,MAAM,WACJ,YAGA,aAEA,OAAO,WAAW;AAChB,eAAa,SACV,SAAS,OAAO,WAAW,WAAW,KAAK,CAAC,EAC7C,GAAI,WACA,EACG,oBACC,OAAO,QAAQ,SAAS,gBAAgB,CAAC,CAC5C,GACD,EAAE,CACP;GACD;CAEJ,MAAM,mBAAmB,UACvB,IAAI,qBAAqB,EAAE,OAAO,CAAC;CAErC,MAAM,SACJ,KACA,GAAG,SAIA;EACH,MAAM,OAAQ,KAAK,MAAM,EAAE;AAC3B,SAAO,IAAI,aACT,KACA,OACC,mBAAmB,gBAClB,aAAa,MAAM,mBAAmB,YAAY,EACpD,gBACD;;CAGH,MAAM,YACJ,KACA,GAAG,SAIA;EACH,MAAM,OAAQ,KAAK,MAAM,EAAE;AAC3B,SAAO,IAAI,aACT,KACA,OACC,mBAAmB,gBAClB,aAAa,SAAS,mBAAmB,YAAY,EACvD,gBACD;;CAGH,MAAM,UACJ,KACA,GAAG,SAIA;EACH,MAAM,OAAQ,KAAK,MAAM,EAAE;AAC3B,SAAO,IAAI,aACT,KACA,OACC,mBAAmB,gBAClB,aAAa,OAAO,mBAAmB,YAAY,EACrD,gBACD;;CAGH,MAAM,iBACJ,KACA,GAAG,SAIA;EACH,MAAM,OAAQ,KAAK,MAAM,EAAE;EAC3B,MAAM,oBAAoB,IAAI,qBAAqB,IAAI;EACvD,MAAM,UAAU,IAAI,kBAAkB,KAAK,gBAAgB;AAE3D,SAAO,OAAO,aACZ,OAAO,IAAI,aAAa;GACtB,MAAM,cAAc,OAAO,IAAI,WAAW,KAAK,KAAK;AAEpD,UAAO,OAAO,aAGX,SACD,OAAO,IAAI,aAAa;IACtB,MAAM,cAAc,aAAa,SAC/B,mBACA,cACC,WAAW;AACV,UAAK,OAAO,OAAO;QAEpB,UAAU;AACT,UAAK,KAAK,QAAQ,MAAM,CAAC;MAE5B;AACD,WAAO,OAAO,mBACZ,OAAO,WAAW,aAAa,CAAC,CACjC;KACD,CACH;IACD,CACH,CAAC,KACA,OAAO,WAAW,mBAChB,IAAI,cAAc,KAAK,eAAe,CACvC,CACF;;AAGH,QAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACD;EACD,CACH;;;;AAKH,MAAa,kBAAkB,QAAQ,WAErC,8BAA8B;AAIhC,MAAa,SACX,SACA,YACG,MAAM,OAAO,iBAAiB,KAAK,SAAS,QAAQ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@confect/js",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "8.0.0",
|
|
4
4
|
"description": "JavaScript client bindings for any JS runtime",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -34,10 +34,10 @@
|
|
|
34
34
|
"author": "RJ Dellecese",
|
|
35
35
|
"license": "ISC",
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"@effect/vitest": "0.
|
|
37
|
+
"@effect/vitest": "0.29.0",
|
|
38
38
|
"@eslint/js": "10.0.1",
|
|
39
39
|
"@types/node": "25.3.3",
|
|
40
|
-
"effect": "3.
|
|
40
|
+
"effect": "3.21.2",
|
|
41
41
|
"eslint": "10.0.2",
|
|
42
42
|
"prettier": "3.8.1",
|
|
43
43
|
"tsdown": "0.20.3",
|
|
@@ -47,8 +47,8 @@
|
|
|
47
47
|
},
|
|
48
48
|
"peerDependencies": {
|
|
49
49
|
"convex": "^1.30.0",
|
|
50
|
-
"effect": "^3.
|
|
51
|
-
"@confect/core": "
|
|
50
|
+
"effect": "^3.21.2",
|
|
51
|
+
"@confect/core": "^8.0.0"
|
|
52
52
|
},
|
|
53
53
|
"engines": {
|
|
54
54
|
"node": ">=22",
|
package/src/HttpClient.ts
CHANGED
|
@@ -27,19 +27,22 @@ const make = (
|
|
|
27
27
|
client.clearAuth();
|
|
28
28
|
});
|
|
29
29
|
|
|
30
|
+
const mapUnknownError = (cause: unknown) => new HttpClientError({ cause });
|
|
31
|
+
|
|
30
32
|
const query = <Query extends Ref.AnyPublicQuery>(
|
|
31
33
|
ref: Query,
|
|
32
34
|
...rest: Ref.OptionalArgs<Query>
|
|
33
35
|
): Effect.Effect<
|
|
34
36
|
Ref.Returns<Query>,
|
|
35
|
-
HttpClientError | ParseResult.ParseError
|
|
37
|
+
Ref.Error<Query> | HttpClientError | ParseResult.ParseError
|
|
36
38
|
> => {
|
|
37
39
|
const args = (rest[0] ?? {}) as Ref.Args<Query>;
|
|
38
|
-
return Ref.runWithCodec(
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
40
|
+
return Ref.runWithCodec(
|
|
41
|
+
ref,
|
|
42
|
+
args,
|
|
43
|
+
(functionReference, encodedArgs) =>
|
|
44
|
+
client.query(functionReference, encodedArgs),
|
|
45
|
+
mapUnknownError,
|
|
43
46
|
);
|
|
44
47
|
};
|
|
45
48
|
|
|
@@ -48,14 +51,15 @@ const make = (
|
|
|
48
51
|
...rest: Ref.OptionalArgs<Mutation>
|
|
49
52
|
): Effect.Effect<
|
|
50
53
|
Ref.Returns<Mutation>,
|
|
51
|
-
HttpClientError | ParseResult.ParseError
|
|
54
|
+
Ref.Error<Mutation> | HttpClientError | ParseResult.ParseError
|
|
52
55
|
> => {
|
|
53
56
|
const args = (rest[0] ?? {}) as Ref.Args<Mutation>;
|
|
54
|
-
return Ref.runWithCodec(
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
57
|
+
return Ref.runWithCodec(
|
|
58
|
+
ref,
|
|
59
|
+
args,
|
|
60
|
+
(functionReference, encodedArgs) =>
|
|
61
|
+
client.mutation(functionReference, encodedArgs),
|
|
62
|
+
mapUnknownError,
|
|
59
63
|
);
|
|
60
64
|
};
|
|
61
65
|
|
|
@@ -64,14 +68,15 @@ const make = (
|
|
|
64
68
|
...rest: Ref.OptionalArgs<Action>
|
|
65
69
|
): Effect.Effect<
|
|
66
70
|
Ref.Returns<Action>,
|
|
67
|
-
HttpClientError | ParseResult.ParseError
|
|
71
|
+
Ref.Error<Action> | HttpClientError | ParseResult.ParseError
|
|
68
72
|
> => {
|
|
69
73
|
const args = (rest[0] ?? {}) as Ref.Args<Action>;
|
|
70
|
-
return Ref.runWithCodec(
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
74
|
+
return Ref.runWithCodec(
|
|
75
|
+
ref,
|
|
76
|
+
args,
|
|
77
|
+
(functionReference, encodedArgs) =>
|
|
78
|
+
client.action(functionReference, encodedArgs),
|
|
79
|
+
mapUnknownError,
|
|
75
80
|
);
|
|
76
81
|
};
|
|
77
82
|
|
package/src/WebSocketClient.ts
CHANGED
|
@@ -39,19 +39,23 @@ const make = (
|
|
|
39
39
|
);
|
|
40
40
|
});
|
|
41
41
|
|
|
42
|
+
const mapUnknownError = (cause: unknown) =>
|
|
43
|
+
new WebSocketClientError({ cause });
|
|
44
|
+
|
|
42
45
|
const query = <Query extends Ref.AnyPublicQuery>(
|
|
43
46
|
ref: Query,
|
|
44
47
|
...rest: Ref.OptionalArgs<Query>
|
|
45
48
|
): Effect.Effect<
|
|
46
49
|
Ref.Returns<Query>,
|
|
47
|
-
WebSocketClientError | ParseResult.ParseError
|
|
50
|
+
Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError
|
|
48
51
|
> => {
|
|
49
52
|
const args = (rest[0] ?? {}) as Ref.Args<Query>;
|
|
50
|
-
return Ref.runWithCodec(
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
53
|
+
return Ref.runWithCodec(
|
|
54
|
+
ref,
|
|
55
|
+
args,
|
|
56
|
+
(functionReference, encodedArgs) =>
|
|
57
|
+
convexClient.query(functionReference, encodedArgs),
|
|
58
|
+
mapUnknownError,
|
|
55
59
|
);
|
|
56
60
|
};
|
|
57
61
|
|
|
@@ -60,14 +64,15 @@ const make = (
|
|
|
60
64
|
...rest: Ref.OptionalArgs<Mutation>
|
|
61
65
|
): Effect.Effect<
|
|
62
66
|
Ref.Returns<Mutation>,
|
|
63
|
-
WebSocketClientError | ParseResult.ParseError
|
|
67
|
+
Ref.Error<Mutation> | WebSocketClientError | ParseResult.ParseError
|
|
64
68
|
> => {
|
|
65
69
|
const args = (rest[0] ?? {}) as Ref.Args<Mutation>;
|
|
66
|
-
return Ref.runWithCodec(
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
70
|
+
return Ref.runWithCodec(
|
|
71
|
+
ref,
|
|
72
|
+
args,
|
|
73
|
+
(functionReference, encodedArgs) =>
|
|
74
|
+
convexClient.mutation(functionReference, encodedArgs),
|
|
75
|
+
mapUnknownError,
|
|
71
76
|
);
|
|
72
77
|
};
|
|
73
78
|
|
|
@@ -76,14 +81,15 @@ const make = (
|
|
|
76
81
|
...rest: Ref.OptionalArgs<Action>
|
|
77
82
|
): Effect.Effect<
|
|
78
83
|
Ref.Returns<Action>,
|
|
79
|
-
WebSocketClientError | ParseResult.ParseError
|
|
84
|
+
Ref.Error<Action> | WebSocketClientError | ParseResult.ParseError
|
|
80
85
|
> => {
|
|
81
86
|
const args = (rest[0] ?? {}) as Ref.Args<Action>;
|
|
82
|
-
return Ref.runWithCodec(
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
+
return Ref.runWithCodec(
|
|
88
|
+
ref,
|
|
89
|
+
args,
|
|
90
|
+
(functionReference, encodedArgs) =>
|
|
91
|
+
convexClient.action(functionReference, encodedArgs),
|
|
92
|
+
mapUnknownError,
|
|
87
93
|
);
|
|
88
94
|
};
|
|
89
95
|
|
|
@@ -92,16 +98,20 @@ const make = (
|
|
|
92
98
|
...rest: Ref.OptionalArgs<Query>
|
|
93
99
|
): Stream.Stream<
|
|
94
100
|
Ref.Returns<Query>,
|
|
95
|
-
WebSocketClientError | ParseResult.ParseError
|
|
101
|
+
Ref.Error<Query> | WebSocketClientError | ParseResult.ParseError
|
|
96
102
|
> => {
|
|
97
103
|
const args = (rest[0] ?? {}) as Ref.Args<Query>;
|
|
98
104
|
const functionReference = Ref.getFunctionReference(ref);
|
|
105
|
+
const onError = Ref.decodeErrorOrElse(ref, mapUnknownError);
|
|
99
106
|
|
|
100
107
|
return Stream.unwrapScoped(
|
|
101
108
|
Effect.gen(function* () {
|
|
102
109
|
const encodedArgs = yield* Ref.encodeArgs(ref, args);
|
|
103
110
|
|
|
104
|
-
return Stream.asyncScoped<
|
|
111
|
+
return Stream.asyncScoped<
|
|
112
|
+
unknown,
|
|
113
|
+
Ref.Error<Query> | WebSocketClientError
|
|
114
|
+
>((emit) =>
|
|
105
115
|
Effect.gen(function* () {
|
|
106
116
|
const unsubscribe = convexClient.onUpdate(
|
|
107
117
|
functionReference,
|
|
@@ -110,7 +120,7 @@ const make = (
|
|
|
110
120
|
emit.single(result);
|
|
111
121
|
},
|
|
112
122
|
(error) => {
|
|
113
|
-
emit.fail(
|
|
123
|
+
emit.fail(onError(error));
|
|
114
124
|
},
|
|
115
125
|
);
|
|
116
126
|
yield* Effect.addFinalizer(() =>
|