@confect/test 6.0.0 → 7.0.0

package/CHANGELOG.md

@@ -1,5 +1,133 @@
 # @confect/test
 
+## 7.0.0
+
+### Minor Changes
+
+- 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.
+
+  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.
+
+  ### Authoring a function with typed errors
+
+  `FunctionSpec` constructors now accept an optional `error` schema. To support multiple error shapes, combine them with `Schema.Union`.
+
+  ```ts
+  import { FunctionSpec, GenericId, GroupSpec } from "@confect/core";
+  import { Schema } from "effect";
+
+  export class NoteNotFound extends Schema.TaggedError<NoteNotFound>()(
+    "NoteNotFound",
+    { noteId: GenericId.GenericId("notes") },
+  ) {}
+
+  export const notes = GroupSpec.make("notes").addFunction(
+    FunctionSpec.publicQuery({
+      name: "getOrFail",
+      args: Schema.Struct({ noteId: GenericId.GenericId("notes") }),
+      returns: Notes.Doc,
+      error: NoteNotFound,
+    }),
+  );
+  ```
+
+  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.
+
+  ```ts
+  import { FunctionImpl } from "@confect/server";
+  import { Effect } from "effect";
+  import api from "../_generated/api";
+  import { DatabaseReader } from "../_generated/services";
+  import { NoteNotFound } from "./notes.spec";
+
+  const getOrFail = FunctionImpl.make(api, "notes", "getOrFail", ({ noteId }) =>
+    Effect.gen(function* () {
+      const reader = yield* DatabaseReader;
+      return yield* reader
+        .table("notes")
+        .get(noteId)
+        .pipe(Effect.mapError(() => new NoteNotFound({ noteId })));
+    }),
+  );
+  ```
+
+  ### Consuming a typed error
+
+  `@confect/js` (`HttpClient`, `WebSocketClient`) and `@confect/test` (`TestConfect`) surface the decoded error in the `Effect` error channel alongside the existing `HttpClientError`/`WebSocketClientError`/`ParseError`:
+
+  ```ts
+  HttpClient.query(refs.public.notes.getOrFail, { noteId });
+  // Effect.Effect<Note, NoteNotFound | HttpClientError | ParseError>
+  ```
+
+  ### `@confect/react`—breaking changes
+
+  `useQuery`, `useMutation`, and `useAction` now expose typed errors, and `useQuery` returns a tagged result type instead of `Returns | undefined`.
+
+  **`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`:
+
+  Before:
+
+  ```tsx
+  const notes = useQuery(refs.public.notes.list, {});
+  if (notes === undefined) return <p>Loading…</p>;
+  return <NoteList notes={notes} />;
+  ```
+
+  After:
+
+  ```tsx
+  import { QueryResult, useQuery } from "@confect/react";
+
+  const notes = useQuery(refs.public.notes.list, {});
+  return QueryResult.match(notes, {
+    onLoading: (skipped) => (skipped ? null : <p>Loading…</p>),
+    onSuccess: (notes) => <NoteList notes={notes} />,
+  });
+  ```
+
+  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.
+
+  When the ref declares an `error` schema, `onFailure` becomes required and receives the decoded typed error:
+
+  ```tsx
+  const lookup = useQuery(refs.public.notes.getOrFail, { noteId });
+  QueryResult.match(lookup, {
+    onLoading: (skipped) => (skipped ? null : "Looking up…"),
+    onSuccess: (note) => `Found: ${note.text}`,
+    onFailure: (error) => `Note ${error.noteId} not found.`,
+  });
+  ```
+
+  `QueryResult` is a Confect-native type exported from `@confect/react`.
+
+  **`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.
+
+  ```ts
+  const deleteOrFail = useMutation(refs.public.notes.deleteOrFail);
+  const result = await deleteOrFail({ noteId });
+  // Either.Either<null, NoteNotFound | Forbidden>
+  Either.match(result, {
+    onLeft: (error) => /* typed error */,
+    onRight: (value) => /* success */,
+  });
+
+  const deleteNote = useMutation(refs.public.notes.delete_); // no `error` schema
+  await deleteNote({ noteId }); // Promise<null>, as before
+  ```
+
+  Unspecified failures continue to reject the promise.
+
+  ### Migration
+  - 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).
+  - 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.
+
+### Patch Changes
+
+- Updated dependencies [90094d0]
+  - @confect/core@7.0.0
+  - @confect/server@7.0.0
+
 ## 6.0.0
 
 ### Minor Changes

package/dist/TestConfect.d.ts

@@ -9,9 +9,9 @@ declare namespace TestConfect_d_exports {
   export { TestConfect, TestConfectWithoutIdentity, layer };
 }
 type TestConfectWithoutIdentity<ConfectSchema extends DatabaseSchema.AnyWithProps> = {
-  query: <QueryRef extends Ref.AnyQuery>(queryRef: QueryRef, ...args: Ref.OptionalArgs<QueryRef>) => Effect.Effect<Ref.Returns<QueryRef>, ParseResult.ParseError>;
-  mutation: <MutationRef extends Ref.AnyMutation>(mutationRef: MutationRef, ...args: Ref.OptionalArgs<MutationRef>) => Effect.Effect<Ref.Returns<MutationRef>, ParseResult.ParseError>;
-  action: <ActionRef extends Ref.AnyAction>(actionRef: ActionRef, ...args: Ref.OptionalArgs<ActionRef>) => Effect.Effect<Ref.Returns<ActionRef>, ParseResult.ParseError>;
+  query: <QueryRef extends Ref.AnyQuery>(queryRef: QueryRef, ...args: Ref.OptionalArgs<QueryRef>) => Effect.Effect<Ref.Returns<QueryRef>, Ref.Error<QueryRef> | ParseResult.ParseError>;
+  mutation: <MutationRef extends Ref.AnyMutation>(mutationRef: MutationRef, ...args: Ref.OptionalArgs<MutationRef>) => Effect.Effect<Ref.Returns<MutationRef>, Ref.Error<MutationRef> | ParseResult.ParseError>;
+  action: <ActionRef extends Ref.AnyAction>(actionRef: ActionRef, ...args: Ref.OptionalArgs<ActionRef>) => Effect.Effect<Ref.Returns<ActionRef>, Ref.Error<ActionRef> | ParseResult.ParseError>;
   run: {
     <E>(handler: Effect.Effect<void, E, RegisteredConvexFunction.MutationServices<ConfectSchema>>): Effect.Effect<void>;
     <A, B extends Value, E>(handler: Effect.Effect<A, E, RegisteredConvexFunction.MutationServices<ConfectSchema>>, returns: Schema.Schema<A, B>): Effect.Effect<A, ParseResult.ParseError>;

package/dist/TestConfect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TestConfect.d.ts","names":[],"sources":["../src/TestConfect.ts"],"mappings":";;;;;;;;;;KAaY,0BAAA,uBACY,cAAA,CAAe,YAAA;EAErC,KAAA,oBAAyB,GAAA,CAAI,QAAA,EAC3B,QAAA,EAAU,QAAA,KACP,IAAA,EAAM,GAAA,CAAI,YAAA,CAAa,QAAA,MACvB,MAAA,CAAO,MAAA,CAAO,GAAA,CAAI,OAAA,CAAQ,QAAA,GAAW,WAAA,CAAY,UAAA;EACtD,QAAA,uBAA+B,GAAA,CAAI,WAAA,EACjC,WAAA,EAAa,WAAA,KACV,IAAA,EAAM,GAAA,CAAI,YAAA,CAAa,WAAA,MACvB,MAAA,CAAO,MAAA,CAAO,GAAA,CAAI,OAAA,CAAQ,WAAA,GAAc,WAAA,CAAY,UAAA;EACzD,MAAA,qBAA2B,GAAA,CAAI,SAAA,EAC7B,SAAA,EAAW,SAAA,KACR,IAAA,EAAM,GAAA,CAAI,YAAA,CAAa,SAAA,MACvB,MAAA,CAAO,MAAA,CAAO,GAAA,CAAI,OAAA,CAAQ,SAAA,GAAY,WAAA,CAAY,UAAA;EACvD,GAAA;IAAA,IAEI,OAAA,EAAS,MAAA,CAAO,MAAA,OAEd,CAAA,EACA,wBAAA,CAAyB,gBAAA,CAAiB,aAAA,KAE3C,MAAA,CAAO,MAAA;IAAA,cACI,KAAA,KACZ,OAAA,EAAS,MAAA,CAAO,MAAA,CACd,CAAA,EACA,CAAA,EACA,wBAAA,CAAyB,gBAAA,CAAiB,aAAA,IAE5C,OAAA,EAAS,MAAA,CAAO,MAAA,CAAO,CAAA,EAAG,CAAA,IACzB,MAAA,CAAO,MAAA,CAAO,CAAA,EAAG,WAAA,CAAY,UAAA;EAAA;EAElC,KAAA,GACE,iBAAA,UACA,IAAA,GAAO,WAAA,KACJ,MAAA,CAAO,MAAA,CAAO,QAAA;EACnB,kCAAA,QAA0C,MAAA,CAAO,MAAA;EACjD,2BAAA,GACE,aAAA,iBACG,MAAA,CAAO,MAAA;AAAA;AAAA,KAGF,WAAA,uBAAkC,cAAA,CAAe,YAAA;EAC3D,YAAA,GACE,YAAA,EAAc,OAAA,CAAQ,YAAA,MACnB,0BAAA,CAA2B,aAAA;AAAA,IAC9B,0BAAA,CAA2B,aAAA;AAAA,cAElB,WAAA,yBACW,cAAA,CAAe,YAAA,OAAY,OAAA,CAAA,GAAA,CAAA,WAAA,CAAA,aAAA,GAAA,WAAA,CAAA,aAAA;AAAA,cA0KtC,KAAA,2BACc,cAAA,CAAe,YAAA,EACtC,cAAA,EAAgB,eAAA,EAChB,OAAA,EAAS,MAAA,eAAqB,OAAA,iBAE5B,KAAA,CAAM,KAAA,CAAM,WAAA,CAAY,eAAA"}
+{"version":3,"file":"TestConfect.d.ts","names":[],"sources":["../src/TestConfect.ts"],"mappings":";;;;;;;;;;KAaY,0BAAA,uBACY,cAAA,CAAe,YAAA;EAErC,KAAA,oBAAyB,GAAA,CAAI,QAAA,EAC3B,QAAA,EAAU,QAAA,KACP,IAAA,EAAM,GAAA,CAAI,YAAA,CAAa,QAAA,MACvB,MAAA,CAAO,MAAA,CACV,GAAA,CAAI,OAAA,CAAQ,QAAA,GACZ,GAAA,CAAI,KAAA,CAAM,QAAA,IAAY,WAAA,CAAY,UAAA;EAEpC,QAAA,uBAA+B,GAAA,CAAI,WAAA,EACjC,WAAA,EAAa,WAAA,KACV,IAAA,EAAM,GAAA,CAAI,YAAA,CAAa,WAAA,MACvB,MAAA,CAAO,MAAA,CACV,GAAA,CAAI,OAAA,CAAQ,WAAA,GACZ,GAAA,CAAI,KAAA,CAAM,WAAA,IAAe,WAAA,CAAY,UAAA;EAEvC,MAAA,qBAA2B,GAAA,CAAI,SAAA,EAC7B,SAAA,EAAW,SAAA,KACR,IAAA,EAAM,GAAA,CAAI,YAAA,CAAa,SAAA,MACvB,MAAA,CAAO,MAAA,CACV,GAAA,CAAI,OAAA,CAAQ,SAAA,GACZ,GAAA,CAAI,KAAA,CAAM,SAAA,IAAa,WAAA,CAAY,UAAA;EAErC,GAAA;IAAA,IAEI,OAAA,EAAS,MAAA,CAAO,MAAA,OAEd,CAAA,EACA,wBAAA,CAAyB,gBAAA,CAAiB,aAAA,KAE3C,MAAA,CAAO,MAAA;IAAA,cACI,KAAA,KACZ,OAAA,EAAS,MAAA,CAAO,MAAA,CACd,CAAA,EACA,CAAA,EACA,wBAAA,CAAyB,gBAAA,CAAiB,aAAA,IAE5C,OAAA,EAAS,MAAA,CAAO,MAAA,CAAO,CAAA,EAAG,CAAA,IACzB,MAAA,CAAO,MAAA,CAAO,CAAA,EAAG,WAAA,CAAY,UAAA;EAAA;EAElC,KAAA,GACE,iBAAA,UACA,IAAA,GAAO,WAAA,KACJ,MAAA,CAAO,MAAA,CAAO,QAAA;EACnB,kCAAA,QAA0C,MAAA,CAAO,MAAA;EACjD,2BAAA,GACE,aAAA,iBACG,MAAA,CAAO,MAAA;AAAA;AAAA,KAGF,WAAA,uBAAkC,cAAA,CAAe,YAAA;EAC3D,YAAA,GACE,YAAA,EAAc,OAAA,CAAQ,YAAA,MACnB,0BAAA,CAA2B,aAAA;AAAA,IAC9B,0BAAA,CAA2B,aAAA;AAAA,cAElB,WAAA,yBACW,cAAA,CAAe,YAAA,OAAY,OAAA,CAAA,GAAA,CAAA,WAAA,CAAA,aAAA,GAAA,WAAA,CAAA,aAAA;AAAA,cAmLtC,KAAA,2BACc,cAAA,CAAe,YAAA,EACtC,cAAA,EAAgB,eAAA,EAChB,OAAA,EAAS,MAAA,eAAqB,OAAA,iBAE5B,KAAA,CAAM,KAAA,CAAM,WAAA,CAAY,eAAA"}

package/dist/TestConfect.js.map

@@ -1 +1 @@
-{"version":3,"file":"TestConfect.js","names":[],"sources":["../src/TestConfect.ts"],"sourcesContent":["import { Ref } from \"@confect/core\";\nimport type { DatabaseSchema, DataModel } from \"@confect/server\";\nimport { RegisteredConvexFunction } from \"@confect/server\";\nimport type {\n  TestConvexForDataModel,\n  TestConvexForDataModelAndIdentity,\n} from \"convex-test\";\nimport { convexTest } from \"convex-test\";\nimport type { GenericMutationCtx, UserIdentity } from \"convex/server\";\nimport type { Value } from \"convex/values\";\nimport type { ParseResult } from \"effect\";\nimport { Context, Effect, Layer, Schema } from \"effect\";\n\nexport type TestConfectWithoutIdentity<\n  ConfectSchema extends DatabaseSchema.AnyWithProps,\n> = {\n  query: <QueryRef extends Ref.AnyQuery>(\n    queryRef: QueryRef,\n    ...args: Ref.OptionalArgs<QueryRef>\n  ) => Effect.Effect<Ref.Returns<QueryRef>, ParseResult.ParseError>;\n  mutation: <MutationRef extends Ref.AnyMutation>(\n    mutationRef: MutationRef,\n    ...args: Ref.OptionalArgs<MutationRef>\n  ) => Effect.Effect<Ref.Returns<MutationRef>, ParseResult.ParseError>;\n  action: <ActionRef extends Ref.AnyAction>(\n    actionRef: ActionRef,\n    ...args: Ref.OptionalArgs<ActionRef>\n  ) => Effect.Effect<Ref.Returns<ActionRef>, ParseResult.ParseError>;\n  run: {\n    <E>(\n      handler: Effect.Effect<\n        void,\n        E,\n        RegisteredConvexFunction.MutationServices<ConfectSchema>\n      >,\n    ): Effect.Effect<void>;\n    <A, B extends Value, E>(\n      handler: Effect.Effect<\n        A,\n        E,\n        RegisteredConvexFunction.MutationServices<ConfectSchema>\n      >,\n      returns: Schema.Schema<A, B>,\n    ): Effect.Effect<A, ParseResult.ParseError>;\n  };\n  fetch: (\n    pathQueryFragment: string,\n    init?: RequestInit,\n  ) => Effect.Effect<Response>;\n  finishInProgressScheduledFunctions: () => Effect.Effect<void>;\n  finishAllScheduledFunctions: (\n    advanceTimers: () => void,\n  ) => Effect.Effect<void>;\n};\n\nexport type TestConfect<ConfectSchema extends DatabaseSchema.AnyWithProps> = {\n  withIdentity: (\n    userIdentity: Partial<UserIdentity>,\n  ) => TestConfectWithoutIdentity<ConfectSchema>;\n} & TestConfectWithoutIdentity<ConfectSchema>;\n\nexport const TestConfect = <\n  ConfectSchema extends DatabaseSchema.AnyWithProps,\n>() =>\n  Context.GenericTag<TestConfect<ConfectSchema>>(\"@confect/test/TestConfect\");\n\nclass TestConfectImplWithoutIdentity<\n  ConfectSchema extends DatabaseSchema.AnyWithProps,\n> implements TestConfectWithoutIdentity<ConfectSchema> {\n  constructor(\n    private confectSchema: ConfectSchema,\n    private testConvex: TestConvexForDataModel<\n      DataModel.ToConvex<DataModel.FromSchema<ConfectSchema>>\n    >,\n  ) {}\n\n  readonly query = <QueryRef extends Ref.AnyQuery>(\n    queryRef: QueryRef,\n    ...args: Ref.OptionalArgs<QueryRef>\n  ): Effect.Effect<Ref.Returns<QueryRef>, ParseResult.ParseError> =>\n    Ref.runWithCodec(\n      queryRef,\n      (args[0] ?? {}) as Ref.Args<QueryRef>,\n      (functionReference, encodedArgs) =>\n        this.testConvex.query(functionReference, encodedArgs),\n    );\n\n  readonly mutation = <MutationRef extends Ref.AnyMutation>(\n    mutationRef: MutationRef,\n    ...args: Ref.OptionalArgs<MutationRef>\n  ): Effect.Effect<Ref.Returns<MutationRef>, ParseResult.ParseError> =>\n    Ref.runWithCodec(\n      mutationRef,\n      (args[0] ?? {}) as Ref.Args<MutationRef>,\n      (functionReference, encodedArgs) =>\n        this.testConvex.mutation(functionReference, encodedArgs),\n    );\n\n  readonly action = <ActionRef extends Ref.AnyAction>(\n    actionRef: ActionRef,\n    ...args: Ref.OptionalArgs<ActionRef>\n  ): Effect.Effect<Ref.Returns<ActionRef>, ParseResult.ParseError> =>\n    Ref.runWithCodec(\n      actionRef,\n      (args[0] ?? {}) as Ref.Args<ActionRef>,\n      (functionReference, encodedArgs) =>\n        this.testConvex.action(functionReference, encodedArgs),\n    );\n\n  readonly run: TestConfectWithoutIdentity<ConfectSchema>[\"run\"] = (<\n    A,\n    B extends Value,\n    E,\n  >(\n    handler: Effect.Effect<\n      A,\n      E,\n      RegisteredConvexFunction.MutationServices<ConfectSchema>\n    >,\n    returns?: Schema.Schema<A, B>,\n  ): Effect.Effect<void> | Effect.Effect<A, ParseResult.ParseError> => {\n    const makeMutationLayer = (\n      mutationCtx: GenericMutationCtx<\n        DataModel.ToConvex<DataModel.FromSchema<ConfectSchema>>\n      >,\n    ): Layer.Layer<RegisteredConvexFunction.MutationServices<ConfectSchema>> =>\n      RegisteredConvexFunction.mutationLayer(\n        this.confectSchema,\n        mutationCtx,\n      ) as Layer.Layer<\n        RegisteredConvexFunction.MutationServices<ConfectSchema>\n      >;\n\n    return returns === undefined\n      ? Effect.promise(() =>\n          this.testConvex.run((mutationCtx) =>\n            Effect.runPromise(\n              handler.pipe(\n                Effect.asVoid,\n                Effect.provide(makeMutationLayer(mutationCtx)),\n              ),\n            ),\n          ),\n        )\n      : Effect.promise(() =>\n          this.testConvex.run((mutationCtx) =>\n            Effect.runPromise(\n              handler.pipe(\n                Effect.andThen(Schema.encode(returns)),\n                Effect.provide(makeMutationLayer(mutationCtx)),\n              ),\n            ),\n          ),\n        ).pipe(Effect.andThen(Schema.decode(returns)));\n  }) as TestConfectWithoutIdentity<ConfectSchema>[\"run\"];\n\n  readonly fetch = <PathQueryFragment extends string>(\n    pathQueryFragment: PathQueryFragment,\n    init?: RequestInit,\n  ) => Effect.promise(() => this.testConvex.fetch(pathQueryFragment, init));\n\n  readonly finishInProgressScheduledFunctions = () =>\n    Effect.promise(() => this.testConvex.finishInProgressScheduledFunctions());\n\n  readonly finishAllScheduledFunctions = (advanceTimers: () => void) =>\n    Effect.promise(() =>\n      this.testConvex.finishAllScheduledFunctions(advanceTimers),\n    );\n}\n\nclass TestConfectImpl<\n  ConfectSchema extends DatabaseSchema.AnyWithProps,\n> implements TestConfect<ConfectSchema> {\n  private readonly testConfectImplWithoutIdentity: TestConfectImplWithoutIdentity<ConfectSchema>;\n\n  constructor(\n    private confectSchema: ConfectSchema,\n    private testConvex: TestConvexForDataModelAndIdentity<\n      DataModel.ToConvex<DataModel.FromSchema<ConfectSchema>>\n    >,\n  ) {\n    this.testConvex = testConvex;\n    this.testConfectImplWithoutIdentity = new TestConfectImplWithoutIdentity(\n      confectSchema,\n      testConvex,\n    );\n  }\n\n  readonly withIdentity = (userIdentity: Partial<UserIdentity>) =>\n    new TestConfectImplWithoutIdentity(\n      this.confectSchema,\n      this.testConvex.withIdentity(userIdentity),\n    );\n\n  readonly query = <QueryRef extends Ref.AnyQuery>(\n    queryRef: QueryRef,\n    ...args: Ref.OptionalArgs<QueryRef>\n  ) => this.testConfectImplWithoutIdentity.query(queryRef, ...args);\n\n  readonly mutation = <MutationRef extends Ref.AnyMutation>(\n    mutationRef: MutationRef,\n    ...args: Ref.OptionalArgs<MutationRef>\n  ) => this.testConfectImplWithoutIdentity.mutation(mutationRef, ...args);\n\n  readonly action = <ActionRef extends Ref.AnyAction>(\n    actionRef: ActionRef,\n    ...args: Ref.OptionalArgs<ActionRef>\n  ) => this.testConfectImplWithoutIdentity.action(actionRef, ...args);\n\n  readonly run: TestConfect<ConfectSchema>[\"run\"] = ((\n    handler: any,\n    returns?: any,\n  ) =>\n    this.testConfectImplWithoutIdentity.run(\n      handler,\n      returns,\n    )) as TestConfect<ConfectSchema>[\"run\"];\n\n  readonly fetch = <PathQueryFragment extends string>(\n    pathQueryFragment: PathQueryFragment,\n    init?: RequestInit,\n  ) => this.testConfectImplWithoutIdentity.fetch(pathQueryFragment, init);\n\n  readonly finishInProgressScheduledFunctions = () =>\n    this.testConfectImplWithoutIdentity.finishInProgressScheduledFunctions();\n\n  readonly finishAllScheduledFunctions = (advanceTimers: () => void) =>\n    this.testConfectImplWithoutIdentity.finishAllScheduledFunctions(\n      advanceTimers,\n    );\n}\n\nexport const layer =\n  <DatabaseSchema_ extends DatabaseSchema.AnyWithProps>(\n    databaseSchema: DatabaseSchema_,\n    modules: Record<string, () => Promise<any>>,\n  ) =>\n  (): Layer.Layer<TestConfect<DatabaseSchema_>> =>\n    Layer.sync(\n      TestConfect<DatabaseSchema_>(),\n      () =>\n        new TestConfectImpl(\n          databaseSchema,\n          convexTest(\n            databaseSchema.convexSchemaDefinition,\n            modules,\n          ) as unknown as TestConvexForDataModelAndIdentity<\n            DataModel.ToConvex<DataModel.FromSchema<DatabaseSchema_>>\n          >,\n        ),\n    );\n"],"mappings":";;;;;;;;;;;AA6DA,MAAa,oBAGX,QAAQ,WAAuC,4BAA4B;AAE7E,IAAM,iCAAN,MAEuD;CACrD,YACE,AAAQ,eACR,AAAQ,YAGR;EAJQ;EACA;;CAKV,AAAS,SACP,UACA,GAAG,SAEH,IAAI,aACF,UACC,KAAK,MAAM,EAAE,GACb,mBAAmB,gBAClB,KAAK,WAAW,MAAM,mBAAmB,YAAY,CACxD;CAEH,AAAS,YACP,aACA,GAAG,SAEH,IAAI,aACF,aACC,KAAK,MAAM,EAAE,GACb,mBAAmB,gBAClB,KAAK,WAAW,SAAS,mBAAmB,YAAY,CAC3D;CAEH,AAAS,UACP,WACA,GAAG,SAEH,IAAI,aACF,WACC,KAAK,MAAM,EAAE,GACb,mBAAmB,gBAClB,KAAK,WAAW,OAAO,mBAAmB,YAAY,CACzD;CAEH,AAAS,QAKP,SAKA,YACmE;EACnE,MAAM,qBACJ,gBAIA,yBAAyB,cACvB,KAAK,eACL,YACD;AAIH,SAAO,YAAY,SACf,OAAO,cACL,KAAK,WAAW,KAAK,gBACnB,OAAO,WACL,QAAQ,KACN,OAAO,QACP,OAAO,QAAQ,kBAAkB,YAAY,CAAC,CAC/C,CACF,CACF,CACF,GACD,OAAO,cACL,KAAK,WAAW,KAAK,gBACnB,OAAO,WACL,QAAQ,KACN,OAAO,QAAQ,OAAO,OAAO,QAAQ,CAAC,EACtC,OAAO,QAAQ,kBAAkB,YAAY,CAAC,CAC/C,CACF,CACF,CACF,CAAC,KAAK,OAAO,QAAQ,OAAO,OAAO,QAAQ,CAAC,CAAC;;CAGpD,AAAS,SACP,mBACA,SACG,OAAO,cAAc,KAAK,WAAW,MAAM,mBAAmB,KAAK,CAAC;CAEzE,AAAS,2CACP,OAAO,cAAc,KAAK,WAAW,oCAAoC,CAAC;CAE5E,AAAS,+BAA+B,kBACtC,OAAO,cACL,KAAK,WAAW,4BAA4B,cAAc,CAC3D;;AAGL,IAAM,kBAAN,MAEwC;CACtC,AAAiB;CAEjB,YACE,AAAQ,eACR,AAAQ,YAGR;EAJQ;EACA;AAIR,OAAK,aAAa;AAClB,OAAK,iCAAiC,IAAI,+BACxC,eACA,WACD;;CAGH,AAAS,gBAAgB,iBACvB,IAAI,+BACF,KAAK,eACL,KAAK,WAAW,aAAa,aAAa,CAC3C;CAEH,AAAS,SACP,UACA,GAAG,SACA,KAAK,+BAA+B,MAAM,UAAU,GAAG,KAAK;CAEjE,AAAS,YACP,aACA,GAAG,SACA,KAAK,+BAA+B,SAAS,aAAa,GAAG,KAAK;CAEvE,AAAS,UACP,WACA,GAAG,SACA,KAAK,+BAA+B,OAAO,WAAW,GAAG,KAAK;CAEnE,AAAS,QACP,SACA,YAEA,KAAK,+BAA+B,IAClC,SACA,QACD;CAEH,AAAS,SACP,mBACA,SACG,KAAK,+BAA+B,MAAM,mBAAmB,KAAK;CAEvE,AAAS,2CACP,KAAK,+BAA+B,oCAAoC;CAE1E,AAAS,+BAA+B,kBACtC,KAAK,+BAA+B,4BAClC,cACD;;AAGL,MAAa,SAET,gBACA,kBAGA,MAAM,KACJ,aAA8B,QAE5B,IAAI,gBACF,gBACA,WACE,eAAe,wBACf,QACD,CAGF,CACJ"}
+{"version":3,"file":"TestConfect.js","names":[],"sources":["../src/TestConfect.ts"],"sourcesContent":["import { Ref } from \"@confect/core\";\nimport type { DatabaseSchema, DataModel } from \"@confect/server\";\nimport { RegisteredConvexFunction } from \"@confect/server\";\nimport type {\n  TestConvexForDataModel,\n  TestConvexForDataModelAndIdentity,\n} from \"convex-test\";\nimport { convexTest } from \"convex-test\";\nimport type { GenericMutationCtx, UserIdentity } from \"convex/server\";\nimport type { Value } from \"convex/values\";\nimport type { ParseResult } from \"effect\";\nimport { Context, Effect, Layer, Schema } from \"effect\";\n\nexport type TestConfectWithoutIdentity<\n  ConfectSchema extends DatabaseSchema.AnyWithProps,\n> = {\n  query: <QueryRef extends Ref.AnyQuery>(\n    queryRef: QueryRef,\n    ...args: Ref.OptionalArgs<QueryRef>\n  ) => Effect.Effect<\n    Ref.Returns<QueryRef>,\n    Ref.Error<QueryRef> | ParseResult.ParseError\n  >;\n  mutation: <MutationRef extends Ref.AnyMutation>(\n    mutationRef: MutationRef,\n    ...args: Ref.OptionalArgs<MutationRef>\n  ) => Effect.Effect<\n    Ref.Returns<MutationRef>,\n    Ref.Error<MutationRef> | ParseResult.ParseError\n  >;\n  action: <ActionRef extends Ref.AnyAction>(\n    actionRef: ActionRef,\n    ...args: Ref.OptionalArgs<ActionRef>\n  ) => Effect.Effect<\n    Ref.Returns<ActionRef>,\n    Ref.Error<ActionRef> | ParseResult.ParseError\n  >;\n  run: {\n    <E>(\n      handler: Effect.Effect<\n        void,\n        E,\n        RegisteredConvexFunction.MutationServices<ConfectSchema>\n      >,\n    ): Effect.Effect<void>;\n    <A, B extends Value, E>(\n      handler: Effect.Effect<\n        A,\n        E,\n        RegisteredConvexFunction.MutationServices<ConfectSchema>\n      >,\n      returns: Schema.Schema<A, B>,\n    ): Effect.Effect<A, ParseResult.ParseError>;\n  };\n  fetch: (\n    pathQueryFragment: string,\n    init?: RequestInit,\n  ) => Effect.Effect<Response>;\n  finishInProgressScheduledFunctions: () => Effect.Effect<void>;\n  finishAllScheduledFunctions: (\n    advanceTimers: () => void,\n  ) => Effect.Effect<void>;\n};\n\nexport type TestConfect<ConfectSchema extends DatabaseSchema.AnyWithProps> = {\n  withIdentity: (\n    userIdentity: Partial<UserIdentity>,\n  ) => TestConfectWithoutIdentity<ConfectSchema>;\n} & TestConfectWithoutIdentity<ConfectSchema>;\n\nexport const TestConfect = <\n  ConfectSchema extends DatabaseSchema.AnyWithProps,\n>() =>\n  Context.GenericTag<TestConfect<ConfectSchema>>(\"@confect/test/TestConfect\");\n\nclass TestConfectImplWithoutIdentity<\n  ConfectSchema extends DatabaseSchema.AnyWithProps,\n> implements TestConfectWithoutIdentity<ConfectSchema> {\n  constructor(\n    private confectSchema: ConfectSchema,\n    private testConvex: TestConvexForDataModel<\n      DataModel.ToConvex<DataModel.FromSchema<ConfectSchema>>\n    >,\n  ) {}\n\n  readonly query = <QueryRef extends Ref.AnyQuery>(\n    queryRef: QueryRef,\n    ...args: Ref.OptionalArgs<QueryRef>\n  ): Effect.Effect<\n    Ref.Returns<QueryRef>,\n    Ref.Error<QueryRef> | ParseResult.ParseError\n  > =>\n    Ref.runWithCodec(\n      queryRef,\n      (args[0] ?? {}) as Ref.Args<QueryRef>,\n      (functionReference, encodedArgs) =>\n        this.testConvex.query(functionReference as any, encodedArgs),\n    );\n\n  readonly mutation = <MutationRef extends Ref.AnyMutation>(\n    mutationRef: MutationRef,\n    ...args: Ref.OptionalArgs<MutationRef>\n  ): Effect.Effect<\n    Ref.Returns<MutationRef>,\n    Ref.Error<MutationRef> | ParseResult.ParseError\n  > =>\n    Ref.runWithCodec(\n      mutationRef,\n      (args[0] ?? {}) as Ref.Args<MutationRef>,\n      (functionReference, encodedArgs) =>\n        this.testConvex.mutation(functionReference as any, encodedArgs),\n    );\n\n  readonly action = <ActionRef extends Ref.AnyAction>(\n    actionRef: ActionRef,\n    ...args: Ref.OptionalArgs<ActionRef>\n  ): Effect.Effect<\n    Ref.Returns<ActionRef>,\n    Ref.Error<ActionRef> | ParseResult.ParseError\n  > =>\n    Ref.runWithCodec(\n      actionRef,\n      (args[0] ?? {}) as Ref.Args<ActionRef>,\n      (functionReference, encodedArgs) =>\n        this.testConvex.action(functionReference as any, encodedArgs),\n    );\n\n  readonly run: TestConfectWithoutIdentity<ConfectSchema>[\"run\"] = (<\n    A,\n    B extends Value,\n    E,\n  >(\n    handler: Effect.Effect<\n      A,\n      E,\n      RegisteredConvexFunction.MutationServices<ConfectSchema>\n    >,\n    returns?: Schema.Schema<A, B>,\n  ): Effect.Effect<void> | Effect.Effect<A, ParseResult.ParseError> => {\n    const makeMutationLayer = (\n      mutationCtx: GenericMutationCtx<\n        DataModel.ToConvex<DataModel.FromSchema<ConfectSchema>>\n      >,\n    ): Layer.Layer<RegisteredConvexFunction.MutationServices<ConfectSchema>> =>\n      RegisteredConvexFunction.mutationLayer(\n        this.confectSchema,\n        mutationCtx,\n      ) as Layer.Layer<\n        RegisteredConvexFunction.MutationServices<ConfectSchema>\n      >;\n\n    return returns === undefined\n      ? Effect.promise(() =>\n          this.testConvex.run((mutationCtx) =>\n            Effect.runPromise(\n              handler.pipe(\n                Effect.asVoid,\n                Effect.provide(makeMutationLayer(mutationCtx)),\n              ),\n            ),\n          ),\n        )\n      : Effect.promise(() =>\n          this.testConvex.run((mutationCtx) =>\n            Effect.runPromise(\n              handler.pipe(\n                Effect.andThen(Schema.encode(returns)),\n                Effect.provide(makeMutationLayer(mutationCtx)),\n              ),\n            ),\n          ),\n        ).pipe(Effect.andThen(Schema.decode(returns)));\n  }) as TestConfectWithoutIdentity<ConfectSchema>[\"run\"];\n\n  readonly fetch = <PathQueryFragment extends string>(\n    pathQueryFragment: PathQueryFragment,\n    init?: RequestInit,\n  ) => Effect.promise(() => this.testConvex.fetch(pathQueryFragment, init));\n\n  readonly finishInProgressScheduledFunctions = () =>\n    Effect.promise(() => this.testConvex.finishInProgressScheduledFunctions());\n\n  readonly finishAllScheduledFunctions = (advanceTimers: () => void) =>\n    Effect.promise(() =>\n      this.testConvex.finishAllScheduledFunctions(advanceTimers),\n    );\n}\n\nclass TestConfectImpl<\n  ConfectSchema extends DatabaseSchema.AnyWithProps,\n> implements TestConfect<ConfectSchema> {\n  private readonly testConfectImplWithoutIdentity: TestConfectImplWithoutIdentity<ConfectSchema>;\n\n  constructor(\n    private confectSchema: ConfectSchema,\n    private testConvex: TestConvexForDataModelAndIdentity<\n      DataModel.ToConvex<DataModel.FromSchema<ConfectSchema>>\n    >,\n  ) {\n    this.testConvex = testConvex;\n    this.testConfectImplWithoutIdentity = new TestConfectImplWithoutIdentity(\n      confectSchema,\n      testConvex,\n    );\n  }\n\n  readonly withIdentity = (userIdentity: Partial<UserIdentity>) =>\n    new TestConfectImplWithoutIdentity(\n      this.confectSchema,\n      this.testConvex.withIdentity(userIdentity),\n    );\n\n  readonly query = <QueryRef extends Ref.AnyQuery>(\n    queryRef: QueryRef,\n    ...args: Ref.OptionalArgs<QueryRef>\n  ) => this.testConfectImplWithoutIdentity.query(queryRef, ...args);\n\n  readonly mutation = <MutationRef extends Ref.AnyMutation>(\n    mutationRef: MutationRef,\n    ...args: Ref.OptionalArgs<MutationRef>\n  ) => this.testConfectImplWithoutIdentity.mutation(mutationRef, ...args);\n\n  readonly action = <ActionRef extends Ref.AnyAction>(\n    actionRef: ActionRef,\n    ...args: Ref.OptionalArgs<ActionRef>\n  ) => this.testConfectImplWithoutIdentity.action(actionRef, ...args);\n\n  readonly run: TestConfect<ConfectSchema>[\"run\"] = ((\n    handler: any,\n    returns?: any,\n  ) =>\n    this.testConfectImplWithoutIdentity.run(\n      handler,\n      returns,\n    )) as TestConfect<ConfectSchema>[\"run\"];\n\n  readonly fetch = <PathQueryFragment extends string>(\n    pathQueryFragment: PathQueryFragment,\n    init?: RequestInit,\n  ) => this.testConfectImplWithoutIdentity.fetch(pathQueryFragment, init);\n\n  readonly finishInProgressScheduledFunctions = () =>\n    this.testConfectImplWithoutIdentity.finishInProgressScheduledFunctions();\n\n  readonly finishAllScheduledFunctions = (advanceTimers: () => void) =>\n    this.testConfectImplWithoutIdentity.finishAllScheduledFunctions(\n      advanceTimers,\n    );\n}\n\nexport const layer =\n  <DatabaseSchema_ extends DatabaseSchema.AnyWithProps>(\n    databaseSchema: DatabaseSchema_,\n    modules: Record<string, () => Promise<any>>,\n  ) =>\n  (): Layer.Layer<TestConfect<DatabaseSchema_>> =>\n    Layer.sync(\n      TestConfect<DatabaseSchema_>(),\n      () =>\n        new TestConfectImpl(\n          databaseSchema,\n          convexTest(databaseSchema.convexSchemaDefinition, modules) as any,\n        ),\n    );\n"],"mappings":";;;;;;;;;;;AAsEA,MAAa,oBAGX,QAAQ,WAAuC,4BAA4B;AAE7E,IAAM,iCAAN,MAEuD;CACrD,YACE,AAAQ,eACR,AAAQ,YAGR;EAJQ;EACA;;CAKV,AAAS,SACP,UACA,GAAG,SAKH,IAAI,aACF,UACC,KAAK,MAAM,EAAE,GACb,mBAAmB,gBAClB,KAAK,WAAW,MAAM,mBAA0B,YAAY,CAC/D;CAEH,AAAS,YACP,aACA,GAAG,SAKH,IAAI,aACF,aACC,KAAK,MAAM,EAAE,GACb,mBAAmB,gBAClB,KAAK,WAAW,SAAS,mBAA0B,YAAY,CAClE;CAEH,AAAS,UACP,WACA,GAAG,SAKH,IAAI,aACF,WACC,KAAK,MAAM,EAAE,GACb,mBAAmB,gBAClB,KAAK,WAAW,OAAO,mBAA0B,YAAY,CAChE;CAEH,AAAS,QAKP,SAKA,YACmE;EACnE,MAAM,qBACJ,gBAIA,yBAAyB,cACvB,KAAK,eACL,YACD;AAIH,SAAO,YAAY,SACf,OAAO,cACL,KAAK,WAAW,KAAK,gBACnB,OAAO,WACL,QAAQ,KACN,OAAO,QACP,OAAO,QAAQ,kBAAkB,YAAY,CAAC,CAC/C,CACF,CACF,CACF,GACD,OAAO,cACL,KAAK,WAAW,KAAK,gBACnB,OAAO,WACL,QAAQ,KACN,OAAO,QAAQ,OAAO,OAAO,QAAQ,CAAC,EACtC,OAAO,QAAQ,kBAAkB,YAAY,CAAC,CAC/C,CACF,CACF,CACF,CAAC,KAAK,OAAO,QAAQ,OAAO,OAAO,QAAQ,CAAC,CAAC;;CAGpD,AAAS,SACP,mBACA,SACG,OAAO,cAAc,KAAK,WAAW,MAAM,mBAAmB,KAAK,CAAC;CAEzE,AAAS,2CACP,OAAO,cAAc,KAAK,WAAW,oCAAoC,CAAC;CAE5E,AAAS,+BAA+B,kBACtC,OAAO,cACL,KAAK,WAAW,4BAA4B,cAAc,CAC3D;;AAGL,IAAM,kBAAN,MAEwC;CACtC,AAAiB;CAEjB,YACE,AAAQ,eACR,AAAQ,YAGR;EAJQ;EACA;AAIR,OAAK,aAAa;AAClB,OAAK,iCAAiC,IAAI,+BACxC,eACA,WACD;;CAGH,AAAS,gBAAgB,iBACvB,IAAI,+BACF,KAAK,eACL,KAAK,WAAW,aAAa,aAAa,CAC3C;CAEH,AAAS,SACP,UACA,GAAG,SACA,KAAK,+BAA+B,MAAM,UAAU,GAAG,KAAK;CAEjE,AAAS,YACP,aACA,GAAG,SACA,KAAK,+BAA+B,SAAS,aAAa,GAAG,KAAK;CAEvE,AAAS,UACP,WACA,GAAG,SACA,KAAK,+BAA+B,OAAO,WAAW,GAAG,KAAK;CAEnE,AAAS,QACP,SACA,YAEA,KAAK,+BAA+B,IAClC,SACA,QACD;CAEH,AAAS,SACP,mBACA,SACG,KAAK,+BAA+B,MAAM,mBAAmB,KAAK;CAEvE,AAAS,2CACP,KAAK,+BAA+B,oCAAoC;CAE1E,AAAS,+BAA+B,kBACtC,KAAK,+BAA+B,4BAClC,cACD;;AAGL,MAAa,SAET,gBACA,kBAGA,MAAM,KACJ,aAA8B,QAE5B,IAAI,gBACF,gBACA,WAAW,eAAe,wBAAwB,QAAQ,CAC3D,CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@confect/test",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "Utilities for testing Confect apps without a live Convex backend",
   "repository": {
     "type": "git",
@@ -51,10 +51,10 @@
   },
   "peerDependencies": {
     "convex": "^1.30.0",
-    "convex-test": "^0.0.38",
+    "convex-test": "^0.0.50",
     "effect": "^3.19.16",
-    "@confect/core": "6.0.0",
-    "@confect/server": "6.0.0"
+    "@confect/core": "7.0.0",
+    "@confect/server": "7.0.0"
   },
   "engines": {
     "node": ">=22",

package/src/TestConfect.ts

@@ -17,15 +17,24 @@ export type TestConfectWithoutIdentity<
   query: <QueryRef extends Ref.AnyQuery>(
     queryRef: QueryRef,
     ...args: Ref.OptionalArgs<QueryRef>
-  ) => Effect.Effect<Ref.Returns<QueryRef>, ParseResult.ParseError>;
+  ) => Effect.Effect<
+    Ref.Returns<QueryRef>,
+    Ref.Error<QueryRef> | ParseResult.ParseError
+  >;
   mutation: <MutationRef extends Ref.AnyMutation>(
     mutationRef: MutationRef,
     ...args: Ref.OptionalArgs<MutationRef>
-  ) => Effect.Effect<Ref.Returns<MutationRef>, ParseResult.ParseError>;
+  ) => Effect.Effect<
+    Ref.Returns<MutationRef>,
+    Ref.Error<MutationRef> | ParseResult.ParseError
+  >;
   action: <ActionRef extends Ref.AnyAction>(
     actionRef: ActionRef,
     ...args: Ref.OptionalArgs<ActionRef>
-  ) => Effect.Effect<Ref.Returns<ActionRef>, ParseResult.ParseError>;
+  ) => Effect.Effect<
+    Ref.Returns<ActionRef>,
+    Ref.Error<ActionRef> | ParseResult.ParseError
+  >;
   run: {
     <E>(
       handler: Effect.Effect<
@@ -77,34 +86,43 @@ class TestConfectImplWithoutIdentity<
   readonly query = <QueryRef extends Ref.AnyQuery>(
     queryRef: QueryRef,
     ...args: Ref.OptionalArgs<QueryRef>
-  ): Effect.Effect<Ref.Returns<QueryRef>, ParseResult.ParseError> =>
+  ): Effect.Effect<
+    Ref.Returns<QueryRef>,
+    Ref.Error<QueryRef> | ParseResult.ParseError
+  > =>
     Ref.runWithCodec(
       queryRef,
       (args[0] ?? {}) as Ref.Args<QueryRef>,
       (functionReference, encodedArgs) =>
-        this.testConvex.query(functionReference, encodedArgs),
+        this.testConvex.query(functionReference as any, encodedArgs),
     );
 
   readonly mutation = <MutationRef extends Ref.AnyMutation>(
     mutationRef: MutationRef,
     ...args: Ref.OptionalArgs<MutationRef>
-  ): Effect.Effect<Ref.Returns<MutationRef>, ParseResult.ParseError> =>
+  ): Effect.Effect<
+    Ref.Returns<MutationRef>,
+    Ref.Error<MutationRef> | ParseResult.ParseError
+  > =>
     Ref.runWithCodec(
       mutationRef,
       (args[0] ?? {}) as Ref.Args<MutationRef>,
       (functionReference, encodedArgs) =>
-        this.testConvex.mutation(functionReference, encodedArgs),
+        this.testConvex.mutation(functionReference as any, encodedArgs),
     );
 
   readonly action = <ActionRef extends Ref.AnyAction>(
     actionRef: ActionRef,
     ...args: Ref.OptionalArgs<ActionRef>
-  ): Effect.Effect<Ref.Returns<ActionRef>, ParseResult.ParseError> =>
+  ): Effect.Effect<
+    Ref.Returns<ActionRef>,
+    Ref.Error<ActionRef> | ParseResult.ParseError
+  > =>
     Ref.runWithCodec(
       actionRef,
       (args[0] ?? {}) as Ref.Args<ActionRef>,
       (functionReference, encodedArgs) =>
-        this.testConvex.action(functionReference, encodedArgs),
+        this.testConvex.action(functionReference as any, encodedArgs),
     );
 
   readonly run: TestConfectWithoutIdentity<ConfectSchema>["run"] = (<
@@ -241,11 +259,6 @@ export const layer =
       () =>
         new TestConfectImpl(
           databaseSchema,
-          convexTest(
-            databaseSchema.convexSchemaDefinition,
-            modules,
-          ) as unknown as TestConvexForDataModelAndIdentity<
-            DataModel.ToConvex<DataModel.FromSchema<DatabaseSchema_>>
-          >,
+          convexTest(databaseSchema.convexSchemaDefinition, modules) as any,
         ),
     );