convex 1.42.2-alpha.0 → 1.42.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "convex",
   "description": "Client for the Convex Cloud",
-  "version": "1.42.2-alpha.0",
+  "version": "1.42.3",
   "author": "Convex, Inc. <no-reply@convex.dev>",
   "homepage": "https://convex.dev",
   "repository": {

package/src/browser/index.ts

@@ -24,6 +24,8 @@ export type {
   ConnectionState,
   AuthTokenFetcher,
 } from "./sync/client.js";
+/** @internal */
+export type { BaseConvexClientInterface } from "./sync/client.js";
 export type { PaginationStatus } from "./sync/pagination.js";
 export type { ConvexClientOptions } from "./simple_client.js";
 export { ConvexClient } from "./simple_client.js";

package/src/browser/sync/client.test.ts

@@ -4,9 +4,16 @@
 
 import { test, expect } from "vitest";
 
-import { BaseConvexClient } from "./client.js";
+import { BaseConvexClient, BaseConvexClientInterface } from "./client.js";
 import { anyApi } from "../../server/api.js";
 
+// Compile-time assertion that `BaseConvexClient` satisfies
+// `BaseConvexClientInterface`. We can't use an `implements` clause on the class
+// because `BaseConvexClientInterface` is `@internal`: that would leak the
+// interface name into the public `.d.ts` where it has been stripped.
+const _assertBaseConvexClientImplementsInterface: BaseConvexClientInterface =
+  undefined as unknown as BaseConvexClient;
+
 test("localQueryResult reflects optimistic results", async () => {
   const client = new BaseConvexClient("http://127.0.0.1:8000", () => {
     // ignore updates.

package/src/browser/sync/client.ts

@@ -1126,3 +1126,66 @@ export class BaseConvexClient {
       });
   }
 }
+
+/**
+ * The public API of {@link BaseConvexClient}.
+ *
+ * @internal
+ */
+export interface BaseConvexClientInterface {
+  addOnTransitionHandler(fn: (transition: Transition) => void): () => void;
+
+  setAuth(
+    fetchToken: AuthTokenFetcher,
+    onChange: (isAuthenticated: boolean) => void,
+    onRefreshChange?: (isRefreshing: boolean) => void,
+  ): void;
+
+  /** @internal */
+  setAdminAuth(value: string, fakeUserIdentity?: UserIdentityAttributes): void;
+
+  clearAuth(): void;
+
+  subscribe(
+    name: string,
+    args?: Record<string, Value>,
+    options?: SubscribeOptions,
+  ): { queryToken: QueryToken; unsubscribe: () => void };
+
+  localQueryResult(
+    udfPath: string,
+    args?: Record<string, Value>,
+  ): Value | undefined;
+
+  localQueryResultByToken(queryToken: QueryToken): Value | undefined;
+
+  hasLocalQueryResultByToken(queryToken: QueryToken): boolean;
+
+  localQueryLogs(
+    udfPath: string,
+    args?: Record<string, Value>,
+  ): string[] | undefined;
+
+  queryJournal(
+    name: string,
+    args?: Record<string, Value>,
+  ): QueryJournal | undefined;
+
+  connectionState(): ConnectionState;
+
+  subscribeToConnectionState(
+    cb: (connectionState: ConnectionState) => void,
+  ): () => void;
+
+  mutation(
+    name: string,
+    args?: Record<string, Value>,
+    options?: MutationOptions,
+  ): Promise<any>;
+
+  action(name: string, args?: Record<string, Value>): Promise<any>;
+
+  close(): Promise<void>;
+
+  readonly url: string;
+}

package/src/browser/sync/paginated_query_client.ts

@@ -17,7 +17,7 @@ import {
   serializePaginatedPathAndArgs,
   canonicalizeUdfPath,
 } from "./udf_path_utils.js";
-import { BaseConvexClient, Transition } from "./client.js";
+import { BaseConvexClientInterface, Transition } from "./client.js";
 import {
   PaginatedQueryResult,
   PaginationStatus,
@@ -74,6 +74,7 @@ export type ExtendedTransition = Transition & {
   }>;
 };
 
+/** @internal */
 export class PaginatedQueryClient {
   private paginatedQuerySet: Map<PaginatedQueryToken, LocalPaginatedQuery> =
     new Map();
@@ -81,7 +82,7 @@ export class PaginatedQueryClient {
   private lastTransitionTs: TS;
 
   constructor(
-    private client: BaseConvexClient,
+    private client: BaseConvexClientInterface,
     private onTransition: (transition: ExtendedTransition) => void,
   ) {
     // Nonsense initial value to construct synthetic Transitions

package/src/cli/codegen_templates/common.test.ts

@@ -0,0 +1,52 @@
+import { describe, test, expect } from "vitest";
+import { compareModulePaths } from "./common.js";
+
+describe("compareModulePaths", () => {
+  test("matches default sort order for forward slash paths", () => {
+    const paths = ["fooBaz.ts", "foo/bar.ts", "foo.ts"];
+    expect([...paths].sort(compareModulePaths)).toEqual([...paths].sort());
+  });
+
+  test("orders Windows paths identically to their POSIX equivalents", () => {
+    const posixPaths = ["fooBaz.ts", "foo/bar.ts", "foo.ts"];
+    const windowsPaths = posixPaths.map((p) => p.replace(/\//g, "\\"));
+
+    const sortedPosix = [...posixPaths].sort(compareModulePaths);
+    const sortedWindows = [...windowsPaths].sort(compareModulePaths);
+
+    expect(sortedPosix).toEqual(["foo.ts", "foo/bar.ts", "fooBaz.ts"]);
+    expect(sortedWindows.map((p) => p.replace(/\\/g, "/"))).toEqual(
+      sortedPosix,
+    );
+  });
+
+  test("default sort diverges on this input, demonstrating the bug", () => {
+    // "/" (0x2F) sorts before letters while "\" (0x5C) sorts after them,
+    // so the OS-native forms of the same file set sort differently.
+    const windowsPaths = ["fooBaz.ts", "foo\\bar.ts", "foo.ts"];
+    expect([...windowsPaths].sort()).toEqual([
+      "foo.ts",
+      "fooBaz.ts",
+      "foo\\bar.ts",
+    ]);
+    expect([...windowsPaths].sort(compareModulePaths)).toEqual([
+      "foo.ts",
+      "foo\\bar.ts",
+      "fooBaz.ts",
+    ]);
+  });
+
+  test("sorts nested directories before longer sibling file names", () => {
+    const paths = ["a/b/c.ts", "aZ.ts", "a.ts", "a/b.ts"];
+    expect([...paths].sort(compareModulePaths)).toEqual([
+      "a.ts",
+      "a/b.ts",
+      "a/b/c.ts",
+      "aZ.ts",
+    ]);
+    const windows = paths.map((p) => p.replace(/\//g, "\\"));
+    expect(
+      [...windows].sort(compareModulePaths).map((p) => p.replace(/\\/g, "/")),
+    ).toEqual(["a.ts", "a/b.ts", "a/b/c.ts", "aZ.ts"]);
+  });
+});

package/src/cli/codegen_templates/common.ts

@@ -43,3 +43,20 @@ const collator = new Intl.Collator("en-US", {
 export function compareStrings(a: string, b: string): number {
   return collator.compare(a, b);
 }
+
+/**
+ * Comparison function for sorting module paths in codegen output.
+ *
+ * Compares the forward slash normalized form of each path so the resulting
+ * order is identical on every platform. Sorting OS-native paths directly
+ * diverges on Windows because "\" (0x5C) sorts after letters while "/"
+ * (0x2F) sorts before them. Uses plain code unit comparison to match the
+ * default Array.prototype.sort() order these paths sorted with on POSIX.
+ *
+ * Usage: modulePaths.sort(compareModulePaths)
+ */
+export function compareModulePaths(a: string, b: string): number {
+  const aNormalized = a.replace(/\\/g, "/");
+  const bNormalized = b.replace(/\\/g, "/");
+  return aNormalized < bNormalized ? -1 : aNormalized > bNormalized ? 1 : 0;
+}

package/src/cli/codegen_templates/component_api.ts

@@ -9,7 +9,12 @@ import {
 } from "../lib/components/definition/directoryStructure.js";
 import { StartPushResponse } from "../lib/deployApi/startPush.js";
 import { importPath, moduleIdentifier } from "./api.js";
-import { apiComment, compareStrings, header } from "./common.js";
+import {
+  apiComment,
+  compareModulePaths,
+  compareStrings,
+  header,
+} from "./common.js";
 import {
   ComponentExports,
   EvaluatedComponentDefinition,
@@ -346,7 +351,7 @@ async function* codegenDynamicApiObjects(
   const absModulePaths = await entryPoints(ctx, componentDirectory.path);
   const modulePaths = absModulePaths
     .map((p) => path.relative(componentDirectory.path, p))
-    .sort();
+    .sort(compareModulePaths);
   for (const modulePath of modulePaths) {
     const ident = moduleIdentifier(modulePath);
     const path = importPath(modulePath);
@@ -382,7 +387,7 @@ async function* codegenDynamicApiObjectsTS(
   const absModulePaths = await entryPoints(ctx, componentDirectory.path);
   const modulePaths = absModulePaths
     .map((p) => path.relative(componentDirectory.path, p))
-    .sort();
+    .sort(compareModulePaths);
   for (const modulePath of modulePaths) {
     const ident = moduleIdentifier(modulePath);
     const path = importPath(modulePath);

package/src/cli/lib/codegen.ts

@@ -4,6 +4,7 @@ import { withTmpDir, TempDir } from "../../bundler/fs.js";
 import { entryPoints } from "../../bundler/index.js";
 import { apiCodegen } from "../codegen_templates/api.js";
 import { apiCjsCodegen } from "../codegen_templates/api_cjs.js";
+import { compareModulePaths } from "../codegen_templates/common.js";
 import {
   dynamicDataModelDTS,
   dynamicDataModelTS,
@@ -846,7 +847,7 @@ async function doApiCodegen(
   const absModulePaths = await entryPoints(ctx, functionsDir);
   const modulePaths = absModulePaths
     .map((p) => path.relative(functionsDir, p))
-    .sort();
+    .sort(compareModulePaths);
 
   const writtenFiles: string[] = [];
 

package/src/index.ts

@@ -1 +1 @@
-export const version = "1.42.2-alpha.0";
+export const version = "1.42.3";

package/src/react/ConvexAuthState.test.tsx

@@ -10,6 +10,10 @@ import {
   ConvexReactClient,
   useConvexAuth,
 } from "./index.js";
+import {
+  BaseConvexClient,
+  BaseConvexClientInterface,
+} from "../browser/index.js";
 
 vi.useFakeTimers();
 
@@ -18,6 +22,16 @@ const flushPromises = async () => {
   await act(() => new Promise((timers as any).setImmediate));
 };
 
+// Test helpers reach into `BaseConvexClient`'s private internals; the tests
+// only ever construct `ConvexReactClient` without a `baseClient` override, so
+// `sync` is always a real `BaseConvexClient` under the hood.
+const syncAsBaseConvexClient = (sync: BaseConvexClientInterface) => {
+  if (!(sync instanceof BaseConvexClient)) {
+    throw new Error("Expected `sync` to be a `BaseConvexClient`");
+  }
+  return sync;
+};
+
 test("setAuth legacy signature typechecks and doesn't throw", async () => {
   const convex = new ConvexReactClient("https://127.0.0.1:3001");
   // We're moving towards removing the Promise, but for backwards compatibility
@@ -201,8 +215,10 @@ function mockServerConfirmsAuth(
   clientClockSkew?: number,
 ) {
   act(() => {
-    const querySetVersion = client.sync["remoteQuerySet"]["version"];
-    client.sync["authenticationManager"].onTransition({
+    const querySetVersion = syncAsBaseConvexClient(client.sync)[
+      "remoteQuerySet"
+    ]["version"];
+    syncAsBaseConvexClient(client.sync)["authenticationManager"].onTransition({
       type: "Transition",
       startVersion: {
         ...querySetVersion,
@@ -311,7 +327,7 @@ test("isRefreshing reflects reauthentication in React tree", async () => {
 
   // Server rejects a token mid-session, triggering reauthentication.
   act(() => {
-    convex.sync["authenticationManager"].onAuthError({
+    syncAsBaseConvexClient(convex.sync)["authenticationManager"].onAuthError({
       type: "AuthError",
       error: "token expired",
       baseVersion: 2,
@@ -362,7 +378,7 @@ test("isRefreshing becomes false when reauth fetch fails", async () => {
 
   // Server rejects the token; tryToReauthenticate runs but the fetcher
   // returns null on its retry.
-  client.sync["authenticationManager"].onAuthError({
+  syncAsBaseConvexClient(client.sync)["authenticationManager"].onAuthError({
     type: "AuthError",
     error: "token expired",
     baseVersion: 1,
@@ -435,7 +451,7 @@ test("isFromOutdatedConfig during reauth resets isRefreshing via resetAuthState"
   onRefreshChange.mockClear();
 
   // Server rejects the token, kicking off tryToReauthenticate.
-  client.sync["authenticationManager"].onAuthError({
+  syncAsBaseConvexClient(client.sync)["authenticationManager"].onAuthError({
     type: "AuthError",
     error: "token expired",
     baseVersion: 1,
@@ -482,7 +498,7 @@ test("isRefreshing is true during reauthentication after auth error", async () =
 
   // Simulate auth error from server
   act(() => {
-    client.sync["authenticationManager"].onAuthError({
+    syncAsBaseConvexClient(client.sync)["authenticationManager"].onAuthError({
       type: "AuthError",
       error: "token expired",
       baseVersion: 1,
@@ -527,7 +543,7 @@ test("stop() during reauth notifies isRefreshing false", async () => {
   onRefreshChange.mockClear();
 
   // Server rejects the token so isRefreshing becomes true.
-  client.sync["authenticationManager"].onAuthError({
+  syncAsBaseConvexClient(client.sync)["authenticationManager"].onAuthError({
     type: "AuthError",
     error: "token expired",
     baseVersion: 1,
@@ -564,7 +580,7 @@ test("initialAuthTokenReuse: sends only one Authenticate", async () => {
   );
 
   const sendMessageSpy = vi.spyOn(
-    client.sync["webSocketManager"],
+    syncAsBaseConvexClient(client.sync)["webSocketManager"],
     "sendMessage",
   );
 

package/src/react/auth_websocket.test.tsx

@@ -8,6 +8,7 @@ import {
   withInMemoryWebSocket,
 } from "../browser/sync/client_node_test_helpers.js";
 import { ConvexReactClient, ConvexReactClientOptions } from "./index.js";
+import { BaseConvexClient } from "../browser/index.js";
 import waitForExpect from "wait-for-expect";
 import { anyApi } from "../server/index.js";
 import { Long } from "../vendor/long.js";
@@ -17,12 +18,21 @@ import {
   WireServerMessage,
 } from "../browser/sync/protocol.js";
 
-const testReactClient = (address: string, options?: ConvexReactClientOptions) =>
-  new ConvexReactClient(address, {
+const testReactClient = (
+  address: string,
+  options?: ConvexReactClientOptions,
+) => {
+  const client = new ConvexReactClient(address, {
     webSocketConstructor: nodeWebSocket,
     unsavedChangesWarning: false,
     ...options,
   });
+  const baseClient = client.sync;
+  if (!(baseClient instanceof BaseConvexClient)) {
+    throw new Error("Expected `sync` to be a `BaseConvexClient`");
+  }
+  return { client, baseClient };
+};
 
 // Disabled due to flakes in CI
 // https://linear.app/convex/issue/ENG-7052/re-enable-auth-websocket-client-tests
@@ -33,7 +43,7 @@ describe.sequential.skip("auth websocket tests", () => {
   // with a constant token provider.
   test("Authenticate via valid static token", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send }) => {
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
 
       const tokenFetcher = vi.fn(async () =>
         jwtEncode({ iat: 1234500, exp: 1244500 }, "secret"),
@@ -45,7 +55,7 @@ describe.sequential.skip("auth websocket tests", () => {
       expect((await receive()).type).toEqual("Authenticate");
       expect((await receive()).type).toEqual("ModifyQuerySet");
 
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       send({
         type: "Transition",
@@ -73,7 +83,7 @@ describe.sequential.skip("auth websocket tests", () => {
   // This happens when a user opens a page after their cached token expired
   test("Reauthenticate after token expiration with versioning", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send, close }) => {
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
 
       let token = jwtEncode({ iat: 1234500, exp: 1244500 }, "wobabloobla");
       const fetchToken = async () => token;
@@ -106,7 +116,7 @@ describe.sequential.skip("auth websocket tests", () => {
         token: token,
       });
 
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       // Server accepts new token
       send({
@@ -138,7 +148,7 @@ describe.sequential.skip("auth websocket tests", () => {
   // fetch from a cache (say due to Prevent Cross Site tracking)
   test("Reauthenticate after token cache failure", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send }) => {
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
 
       const freshToken = jwtEncode({ iat: 1234500, exp: 1244500 }, "secret");
       const tokenFetcher = vi.fn(
@@ -158,7 +168,7 @@ describe.sequential.skip("auth websocket tests", () => {
         token: freshToken,
       });
 
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       // Server accepts new token
       send({
@@ -189,7 +199,7 @@ describe.sequential.skip("auth websocket tests", () => {
   // This is usually a misconfigured server rejecting any token
   test("Fail when tokens are always rejected", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send, close }) => {
-      const client = testReactClient(address);
+      const { client } = testReactClient(address);
 
       const consoleSpy = vi
         .spyOn(global.console, "error")
@@ -287,7 +297,7 @@ describe.sequential.skip("auth websocket tests", () => {
   // it's authed but it cannot fetch a token at all.
   test("Fail when tokens cannot be fetched", async () => {
     await withInMemoryWebSocket(async ({ address, receive }) => {
-      const client = testReactClient(address);
+      const { client } = testReactClient(address);
       const tokenFetcher = vi.fn(async () => null);
       const onAuthChange = vi.fn();
       void client.setAuth(tokenFetcher, onAuthChange);
@@ -307,7 +317,7 @@ describe.sequential.skip("auth websocket tests", () => {
 
   test("Client is protected against token rejection race", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send, close }) => {
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
 
       const badToken = jwtEncode({ iat: 1234500, exp: 1244500 }, "wobalooba");
       const badTokenFetcher = vi.fn(async () => badToken);
@@ -319,7 +329,7 @@ describe.sequential.skip("auth websocket tests", () => {
         token: badToken,
       });
 
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       const goodToken = jwtEncode({ iat: 1234500, exp: 1244500 }, "secret");
       const goodTokenFetcher = vi.fn(async () => goodToken);
@@ -379,7 +389,7 @@ describe.sequential.skip("auth websocket tests", () => {
   // comes back while the client is waiting for server validation of the new token.
   test("Client ignores non-auth responses for token validation", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send, close }) => {
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
       const ts = Math.ceil(Date.now() / 1000);
       const initialToken = jwtEncode({ iat: ts, exp: ts + 1000 }, "token1");
       const freshToken = jwtEncode({ iat: ts, exp: ts + 1000 }, "token2");
@@ -398,7 +408,7 @@ describe.sequential.skip("auth websocket tests", () => {
         token: initialToken,
       });
 
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       send({
         type: "Transition",
@@ -445,7 +455,7 @@ describe.sequential.skip("auth websocket tests", () => {
         token: freshToken,
       });
 
-      const querySetVersion2 = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion2 = baseClient["remoteQuerySet"]["version"];
 
       send({
         type: "Transition",
@@ -478,7 +488,7 @@ describe.sequential.skip("auth websocket tests", () => {
   test("Client maintains connection when refetch occurs during reauth attempt", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send, close }) => {
       vi.useFakeTimers();
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
       // In this test we're going to simulate `fetchToken` taking a long time (1s)
       // so we can test race conditions, so the issued time will be 1s after the
       // fetched time.
@@ -543,7 +553,7 @@ describe.sequential.skip("auth websocket tests", () => {
         baseVersion: 0,
         token: initialToken,
       });
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       send({
         type: "Transition",
@@ -659,7 +669,7 @@ describe.sequential.skip("auth websocket tests", () => {
   // unauthenticated state.
   test("Client retries token validation on error", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send, close }) => {
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
       const ts = Math.ceil(Date.now() / 1000);
       const token1 = jwtEncode({ iat: ts, exp: ts + 60 }, "token1");
       const token2 = jwtEncode({ iat: ts, exp: ts + 60 }, "token2");
@@ -674,7 +684,7 @@ describe.sequential.skip("auth websocket tests", () => {
         token: token1,
       });
 
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       send({
         type: "Transition",
@@ -751,7 +761,7 @@ describe.sequential.skip("auth websocket tests", () => {
 
   test("Authentication runs first", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send }) => {
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
 
       const token1 = jwtEncode({ iat: 1234500, exp: 1244500 }, "secret");
       const tokenFetcher = vi.fn(async () => token1);
@@ -762,7 +772,7 @@ describe.sequential.skip("auth websocket tests", () => {
         token: token1,
       });
 
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       send({
         type: "Transition",
@@ -792,7 +802,7 @@ describe.sequential.skip("auth websocket tests", () => {
 
   test("Auth pause doesn't prevent unsubscribing from queries", async () => {
     await withInMemoryWebSocket(async ({ address, receive, send }) => {
-      const client = testReactClient(address);
+      const { client, baseClient } = testReactClient(address);
 
       const token1 = jwtEncode({ iat: 1234500, exp: 1244500 }, "secret");
       const tokenFetcher = vi.fn(async () => token1);
@@ -807,7 +817,7 @@ describe.sequential.skip("auth websocket tests", () => {
         token: token1,
       });
 
-      const querySetVersion = client.sync["remoteQuerySet"]["version"];
+      const querySetVersion = baseClient["remoteQuerySet"]["version"];
 
       send({
         type: "Transition",
@@ -829,7 +839,7 @@ describe.sequential.skip("auth websocket tests", () => {
       });
 
       await waitForExpect(() => {
-        expect(client.sync["remoteQuerySet"]["version"].identity).toEqual(1);
+        expect(baseClient["remoteQuerySet"]["version"].identity).toEqual(1);
       });
 
       let resolve: (value: string) => void;
@@ -882,7 +892,7 @@ describe.sequential.skip("auth websocket tests", () => {
 
   test("Local state resume doesn't cause duplicate AddQuery", async () => {
     await withInMemoryWebSocket(async ({ address, receive }) => {
-      const client = testReactClient(address);
+      const { client } = testReactClient(address);
 
       // First we subscribe
       client.watchQuery(anyApi.myQuery.default).onUpdate(() => {});
@@ -923,7 +933,7 @@ describe.sequential.skip("auth websocket tests", () => {
 
   test("Local state resume doesn't send both Add and Remove", async () => {
     await withInMemoryWebSocket(async ({ address, receive }) => {
-      const client = testReactClient(address);
+      const { client } = testReactClient(address);
 
       // First we subscribe to kick off connect.
       client.watchQuery(anyApi.myQuery.default).onUpdate(() => {});
@@ -978,7 +988,7 @@ describe.sequential.skip("auth websocket tests", () => {
 
   test("Local state resume refcounts", async () => {
     await withInMemoryWebSocket(async ({ address, receive }) => {
-      const client = testReactClient(address);
+      const { client } = testReactClient(address);
 
       // First we subscribe to kick off connect.
       client.watchQuery(anyApi.myQuery.default).onUpdate(() => {});
@@ -1034,7 +1044,7 @@ describe.sequential.skip("auth websocket tests", () => {
 
   test("Local state restart doesn't send both Add and Remove", async () => {
     await withInMemoryWebSocket(async ({ address, receive }) => {
-      const client = testReactClient(address);
+      const { client } = testReactClient(address);
 
       // Set slow auth, causing pause while connecting
       let resolve: (value: string) => void;
@@ -1073,7 +1083,7 @@ describe.sequential.skip("auth websocket tests", () => {
 describe.sequential("authMode WebSocket", () => {
   test.each([false, true])("expectAuth: %s", async (expectAuth: boolean) => {
     await withInMemoryWebSocket(async ({ address, receive, close }) => {
-      const client = testReactClient(
+      const { client } = testReactClient(
         address,
         expectAuth ? { expectAuth: true } : {},
       );

package/src/react/client.ts

@@ -12,6 +12,7 @@ import {
   AuthTokenFetcher,
   BaseConvexClientOptions,
   ConnectionState,
+  BaseConvexClientInterface,
 } from "../browser/sync/client.js";
 import type { UserIdentityAttributes } from "../browser/sync/protocol.js";
 import { RequestForQueries, useQueries } from "./use_queries.js";
@@ -295,7 +296,7 @@ export interface ConvexReactClientOptions extends BaseConvexClientOptions {
    *
    * @internal
    */
-  baseClient?: BaseConvexClient;
+  baseClient?: BaseConvexClientInterface;
 
   // FIXME: Ideally we define `ConvexReactClientOptions` as
   // `type ConvexReactClientOptions = BaseConvexClientOptions | { baseClient: BaseConvexClient }`
@@ -313,7 +314,7 @@ export interface ConvexReactClientOptions extends BaseConvexClientOptions {
  */
 export class ConvexReactClient {
   private address: string;
-  private cachedSync?: BaseConvexClient | undefined;
+  private cachedSync?: BaseConvexClientInterface | undefined;
   private cachedPaginatedQueryClient?: PaginatedQueryClient | undefined;
   private listeners: Map<QueryToken | PaginatedQueryToken, Set<() => void>>;
   private options: ConvexReactClientOptions;