convex 1.35.0 → 1.35.1

package/package.json

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

package/src/browser/index.ts

@@ -40,6 +40,3 @@ export type { QueryJournal } from "./sync/protocol.js";
 /** @internal */
 export type { UserIdentityAttributes } from "./sync/protocol.js";
 export type { FunctionResult } from "./sync/function_result.js";
-/** @internal */
-export { convexQueryOptions } from "./query_options.js";
-export type { QueryOptions } from "./query_options.js";

package/src/browser/query_options.test.ts

@@ -1,6 +1,7 @@
 import { test } from "vitest";
 import { makeFunctionReference } from "../server/index.js";
 import { EmptyObject } from "../server/registration.js";
+import { ConvexReactClient } from "../react/client.js";
 import { convexQueryOptions } from "./query_options.js";
 
 const apiQueryFuncWithArgs = makeFunctionReference<
@@ -41,3 +42,11 @@ test("convexQueryOptions", async () => {
     args: { name: "hey" },
   });
 });
+
+test("prewarmQuery types", async () => {
+  const client = {
+    prewarmQuery: () => {},
+  } as unknown as ConvexReactClient;
+
+  client.prewarmQuery({ query: apiQueryFuncWithArgs, args: { name: "hi" } });
+});

package/src/browser/query_options.ts

@@ -1,47 +1,26 @@
-// Inspired by https://tanstack.com/query/v5/docs/framework/react/guides/query-options
+/**
+ * Query options are a potential new API for a variety of functions, but in particular a new overload of the React hook for queries.
+ *
+ * Inspired by https://tanstack.com/query/v5/docs/framework/react/guides/query-options
+ */
 import type { FunctionArgs, FunctionReference } from "../server/api.js";
 
+// TODO if this type can encompass all use cases we can add not requiring args for queries
+// that don't take arguments. Goal would be that queryOptions allows leaving out args,
+// but queryOptions returns an object that always contains args. Helpers, "middleware,"
+// anything that intercepts these arguments
 /**
- * Options for a Convex query: the query function reference and its arguments.
- *
- * Used with the object-form overload of {@link useQuery}.
- *
- * @public
+ * Query options.
  */
-export type QueryOptions<Query extends FunctionReference<"query">> = {
-  /**
-   * The query function to run.
-   */
+export type ConvexQueryOptions<Query extends FunctionReference<"query">> = {
   query: Query;
-  /**
-   * The arguments to the query function.
-   */
   args: FunctionArgs<Query>;
+  extendSubscriptionFor?: number;
 };
 
-/**
- * Creates a type-safe {@link QueryOptions} object for a Convex query.
- *
- * This is an identity function that exists to provide type inference — passing
- * your query and args through this helper ensures TypeScript infers the correct
- * `Query` type parameter, which enables precise return types on hooks like
- * {@link useQuery}.
- *
- * ```typescript
- * const opts = convexQueryOptions({
- *   query: api.users.getById,
- *   args: { id: userId },
- * });
- * // opts is typed as QueryOptions<typeof api.users.getById>
- * client.prewarmQuery(opts);
- * ```
- *
- * @param options - The query and its arguments.
- * @returns The same object, typed as `QueryOptions<Query>`.
- * @internal
- */
+// This helper helps more once we have more inference happening.
 export function convexQueryOptions<Query extends FunctionReference<"query">>(
-  options: QueryOptions<Query>,
-): QueryOptions<Query> {
+  options: ConvexQueryOptions<Query>,
+): ConvexQueryOptions<Query> {
   return options;
 }

package/src/cli/codegen_templates/readme.ts

@@ -37,20 +37,7 @@ export const myQueryFunction = query({
 Using this query function in a React component looks like:
 
 \`\`\`ts
-const state = useQuery({
-  query: api.myFunctions.myQueryFunction,
-  args: { first: 10, second: "hello" },
-});
-
-if (state.status === "pending") {
-  return <div>Loading...</div>;
-}
-
-if (state.status === "error") {
-  return <div>Error: {state.error.message}</div>;
-}
-
-const data = state.data;
+const data = useQuery(api.myFunctions.myQueryFunction, { first: 10, second: "hello" });
 \`\`\`
 
 

package/src/cli/deploy.ts

@@ -49,7 +49,7 @@ export const deploy = new Command("deploy")
   .addOption(
     new Option(
       "--preview-create <name>",
-      "The name to associate with this deployment if deploying to a newly created preview deployment. Defaults to the current Git branch name in Vercel, Netlify and GitHub CI. This parameter can only be used with a preview deploy key (when used with another type of key, the command will return an error).",
+      "The name to associate with this deployment if deploying to a newly created preview deployment. Defaults to the current Git branch name in Vercel, Netlify, Cloudflare Pages and GitHub CI. This parameter can only be used with a preview deploy key (when used with another type of key, the command will return an error).",
     ).conflicts("preview-name"),
   )
   .addOption(

package/src/cli/lib/envvars.ts

@@ -433,7 +433,9 @@ export function getBuildEnvironment(): string | false {
     ? "Vercel"
     : process.env.NETLIFY
       ? "Netlify"
-      : false;
+      : process.env.CF_PAGES || process.env.WORKERS_CI
+        ? "Cloudflare"
+        : false;
 }
 
 export function gitBranchFromEnvironment(): string | null {
@@ -445,6 +447,11 @@ export function gitBranchFromEnvironment(): string | null {
     // https://docs.netlify.com/configure-builds/environment-variables/
     return process.env.HEAD ?? null;
   }
+  if (process.env.CF_PAGES || process.env.WORKERS_CI) {
+    // https://developers.cloudflare.com/pages/configuration/build-configuration/#environment-variables
+    // https://developers.cloudflare.com/workers/ci-cd/builds/configuration/#environment-variables
+    return process.env.CF_PAGES_BRANCH ?? process.env.WORKERS_CI_BRANCH ?? null;
+  }
 
   if (process.env.CI) {
     // https://docs.github.com/en/actions/learn-github-actions/variables
@@ -466,5 +473,13 @@ export function isNonProdBuildEnvironment(): boolean {
     // https://docs.netlify.com/configure-builds/environment-variables/
     return process.env.CONTEXT !== "production";
   }
+  if (process.env.CF_PAGES || process.env.WORKERS_CI) {
+    // https://developers.cloudflare.com/pages/configuration/build-configuration/#environment-variables
+    // https://developers.cloudflare.com/workers/ci-cd/builds/configuration/#environment-variables
+    // Branch !== "main" is the closest heuristic; Cloudflare Pages
+    // does not expose a dedicated production/preview flag.
+    const branch = process.env.CF_PAGES_BRANCH ?? process.env.WORKERS_CI_BRANCH;
+    return branch !== "main";
+  }
   return false;
 }

package/src/index.ts

@@ -1 +1 @@
-export const version = "1.35.0";
+export const version = "1.35.1";

package/src/react/client.test.tsx

@@ -5,7 +5,6 @@ import { test, expect, describe, vi } from "vitest";
 import ws from "ws";
 
 import { ConvexReactClient, createMutation, useQuery } from "./client.js";
-import { convexQueryOptions } from "../browser/query_options.js";
 import { ConvexProvider } from "./index.js";
 import React from "react";
 import { renderHook } from "@testing-library/react";
@@ -114,46 +113,6 @@ describe("useQuery", () => {
     expect(result.current).toStrictEqual(undefined);
   });
 
-  test("object form returns success result", () => {
-    const client = createClientWithQuery();
-    const wrapper = ({ children }: any) => (
-      <ConvexProvider client={client}>{children}</ConvexProvider>
-    );
-    const { result } = renderHook(
-      () =>
-        useQuery({
-          query: anyApi.myQuery.default,
-          args: {},
-        }),
-      { wrapper },
-    );
-    expect(result.current).toStrictEqual({
-      data: "queryResult",
-      error: undefined,
-      status: "success",
-    });
-  });
-
-  test("object form returns pending when skipped", () => {
-    const client = createClientWithQuery();
-    const wrapper = ({ children }: any) => (
-      <ConvexProvider client={client}>{children}</ConvexProvider>
-    );
-    const { result } = renderHook(
-      () =>
-        useQuery({
-          query: anyApi.myQuery.default,
-          args: "skip",
-        }),
-      { wrapper },
-    );
-    expect(result.current).toStrictEqual({
-      data: undefined,
-      error: undefined,
-      status: "pending",
-    });
-  });
-
   test("Optimistic update handlers can’t be async", () => {
     const client = testConvexReactClient();
     const mutation = createMutation(
@@ -233,27 +192,3 @@ describe("async query fetch", () => {
     expect(await queryResult).toStrictEqual("queryResult");
   });
 });
-
-describe("prewarmQuery types", () => {
-  test("accepts QueryOptions shape", () => {
-    const client = testConvexReactClient();
-    const opts = convexQueryOptions({
-      query: makeFunctionReference<"query", { name: string }, string>(
-        "myQuery",
-      ),
-      args: { name: "hi" },
-    });
-    client.prewarmQuery(opts);
-  });
-
-  test("accepts extendSubscriptionFor on prewarmQuery", () => {
-    const client = testConvexReactClient();
-    client.prewarmQuery({
-      query: makeFunctionReference<"query", { name: string }, string>(
-        "myQuery",
-      ),
-      args: { name: "hi" },
-      extendSubscriptionFor: 10_000,
-    });
-  });
-});

package/src/react/client.ts

@@ -32,7 +32,7 @@ import {
   instantiateNoopLogger,
   Logger,
 } from "../browser/logging.js";
-import type { QueryOptions } from "../browser/query_options.js";
+import { ConvexQueryOptions } from "../browser/query_options.js";
 import { LoadMoreOfPaginatedQuery } from "../browser/sync/pagination.js";
 import {
   PaginatedQueryClient,
@@ -537,7 +537,9 @@ export class ConvexReactClient {
    * an optional extendSubscriptionFor for how long to subscribe to the query.
    */
   prewarmQuery<Query extends FunctionReference<"query">>(
-    queryOptions: QueryOptions<Query> & { extendSubscriptionFor?: number },
+    queryOptions: ConvexQueryOptions<Query> & {
+      extendSubscriptionFor?: number;
+    },
   ) {
     const extendSubscriptionFor =
       queryOptions.extendSubscriptionFor ?? DEFAULT_EXTEND_SUBSCRIPTION_FOR;
@@ -799,34 +801,6 @@ export type OptionalRestArgsOrSkip<FuncRef extends FunctionReference<any>> =
     ? [args?: EmptyObject | "skip"]
     : [args: FuncRef["_args"] | "skip"];
 
-/**
- * Result returned by object-form {@link useQuery}.
- *
- * @public
- */
-export type UseQueryResult<QueryResult> =
-  | {
-      data: QueryResult;
-      error: undefined;
-      status: "success";
-    }
-  | {
-      data: undefined;
-      error: Error;
-      status: "error";
-    }
-  | {
-      data: undefined;
-      error: undefined;
-      status: "pending";
-    };
-
-type UseQueryOptions<Query extends FunctionReference<"query">> = {
-  query: Query;
-  args: FunctionArgs<Query> | "skip";
-  throwOnError?: boolean;
-};
-
 /**
  * Load a reactive query within a React component.
  *
@@ -873,82 +847,20 @@ type UseQueryOptions<Query extends FunctionReference<"query">> = {
 export function useQuery<Query extends FunctionReference<"query">>(
   query: Query,
   ...args: OptionalRestArgsOrSkip<Query>
-): Query["_returnType"] | undefined;
-
-/**
- * Load a reactive query within a React component using an options object.
- *
- * This is an alternative form of {@link useQuery} that accepts a single
- * {@link UseQueryOptions} object instead of positional arguments.
- * Errors are returned in the result object unless `throwOnError` is set.
- *
- * @example
- * ```tsx
- * import { useQuery } from "convex/react";
- * import { api } from "../convex/_generated/api";
- *
- * function TaskList() {
- *   const state = useQuery({ query: api.tasks.list, args: { completed: false } });
- *
- *   if (state.status === "pending") return <div>Loading...</div>;
- *   if (state.status === "error") return <div>Error: {state.error.message}</div>;
- *   return state.data.map((task) => <div key={task._id}>{task.text}</div>);
- * }
- * ```
- *
- * @param options - Query options. Pass `args: "skip"` to disable the query.
- * @returns the current query state as a {@link UseQueryResult} object.
- *
- * @see https://docs.convex.dev/client/react#fetching-data
- * @public
- */
-export function useQuery<Query extends FunctionReference<"query">>(
-  options: UseQueryOptions<Query>,
-): UseQueryResult<Query["_returnType"]>;
+): Query["_returnType"] | undefined {
+  const skip = args[0] === "skip";
+  const argsObject = args[0] === "skip" ? {} : parseArgs(args[0]);
 
-export function useQuery<Query extends FunctionReference<"query">>(
-  queryOrOptions: Query | UseQueryOptions<Query>,
-  ...args: OptionalRestArgsOrSkip<Query>
-): Query["_returnType"] | undefined | UseQueryResult<Query["_returnType"]> {
-  const isObjectOptions =
-    typeof queryOrOptions === "object" &&
-    queryOrOptions !== null &&
-    "query" in queryOrOptions;
-  const throwOnError = isObjectOptions
-    ? (queryOrOptions.throwOnError ?? false)
-    : true;
-
-  let queryReference: Query | undefined;
-  let argsObject: Record<string, Value> = {};
-
-  if (isObjectOptions) {
-    const query = queryOrOptions.query;
-    queryReference =
-      typeof query === "string"
-        ? (makeFunctionReference<"query", any, any>(query) as Query)
-        : query;
-    if (queryOrOptions.args !== "skip") {
-      argsObject = parseArgs(queryOrOptions.args as Record<string, Value>);
-    }
-  } else {
-    const query = queryOrOptions;
-    queryReference =
-      typeof query === "string"
-        ? (makeFunctionReference<"query", any, any>(query) as Query)
-        : query;
-    argsObject = args[0] === "skip" ? {} : parseArgs(args[0] as Query["_args"]);
-  }
+  const queryReference =
+    typeof query === "string"
+      ? makeFunctionReference<"query", any, any>(query)
+      : query;
 
-  const queryName = queryReference
-    ? getFunctionName(queryReference)
-    : undefined;
-  const skip =
-    (isObjectOptions && queryOrOptions.args === "skip") ||
-    (!isObjectOptions && args[0] === "skip");
+  const queryName = getFunctionName(queryReference);
 
   const queries = useMemo(
     () =>
-      skip || !queryReference
+      skip
         ? ({} as RequestForQueries)
         : { query: { query: queryReference, args: argsObject } },
     // Stringify args so args that are semantically the same don't trigger a
@@ -959,34 +871,6 @@ export function useQuery<Query extends FunctionReference<"query">>(
 
   const results = useQueries(queries);
   const result = results["query"];
-
-  if (isObjectOptions) {
-    if (result instanceof Error) {
-      if (throwOnError) {
-        throw result;
-      }
-      return {
-        data: undefined,
-        error: result,
-        status: "error",
-      };
-    }
-
-    if (result === undefined) {
-      return {
-        data: undefined,
-        error: undefined,
-        status: "pending",
-      };
-    }
-
-    return {
-      data: result,
-      error: undefined,
-      status: "success",
-    };
-  }
-
   if (result instanceof Error) {
     throw result;
   }

package/src/react/index.ts

@@ -53,11 +53,7 @@
  * import { api } from "../convex/_generated/api";
  *
  * function App() {
- *   const counter = useQuery({
- *     query: api.getCounter.default,
- *     args: {},
- *     throwOnError: true,
- *   }).data;
+ *   const counter = useQuery(api.getCounter.default);
  *   const increment = useMutation(api.incrementCounter.default);
  *   // Your component here!
  * }
@@ -82,7 +78,6 @@ export {
   type MutationOptions,
   type ConvexReactClientOptions,
   type OptionalRestArgsOrSkip,
-  type UseQueryResult,
   ConvexReactClient,
   useConvex,
   ConvexProvider,
@@ -91,6 +86,3 @@ export {
   useAction,
   useConvexConnectionState,
 } from "./client.js";
-/** @internal */
-export { convexQueryOptions } from "../browser/query_options.js";
-export type { QueryOptions } from "../browser/query_options.js";

package/src/server/api.ts

@@ -39,11 +39,7 @@ export type FunctionType = "query" | "mutation" | "action";
  * Function references can be used to invoke functions from the client. For
  * example, in React you can pass references to the {@link react.useQuery} hook:
  * ```js
- * const result = useQuery({
- *   query: api.myModule.myFunction,
- *   args: {},
- *   throwOnError: true,
- * }).data;
+ * const result = useQuery(api.myModule.myFunction);
  * ```
  *
  * @typeParam Type - The type of the function ("query", "mutation", or "action").

package/dist/cjs-types/react/use_query_object_options.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * @vitest-environment custom-vitest-environment.ts
- */
-export {};
-//# sourceMappingURL=use_query_object_options.test.d.ts.map

package/dist/cjs-types/react/use_query_object_options.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"use_query_object_options.test.d.ts","sourceRoot":"","sources":["../../../src/react/use_query_object_options.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/cjs-types/react/use_query_result.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * @vitest-environment custom-vitest-environment.ts
- */
-export {};
-//# sourceMappingURL=use_query_result.test.d.ts.map

package/dist/cjs-types/react/use_query_result.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"use_query_result.test.d.ts","sourceRoot":"","sources":["../../../src/react/use_query_result.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/esm-types/react/use_query_object_options.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * @vitest-environment custom-vitest-environment.ts
- */
-export {};
-//# sourceMappingURL=use_query_object_options.test.d.ts.map

package/dist/esm-types/react/use_query_object_options.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"use_query_object_options.test.d.ts","sourceRoot":"","sources":["../../../src/react/use_query_object_options.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/esm-types/react/use_query_result.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * @vitest-environment custom-vitest-environment.ts
- */
-export {};
-//# sourceMappingURL=use_query_result.test.d.ts.map

package/dist/esm-types/react/use_query_result.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"use_query_result.test.d.ts","sourceRoot":"","sources":["../../../src/react/use_query_result.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/src/react/use_query_object_options.test.ts

@@ -1,50 +0,0 @@
-/**
- * @vitest-environment custom-vitest-environment.ts
- */
-
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { test, describe } from "vitest";
-import { anyApi } from "../server/api.js";
-
-import type { ApiFromModules, QueryBuilder } from "../server/index.js";
-import { useQuery as useQueryReal } from "./client.js";
-
-const useQuery = (() => {}) as unknown as typeof useQueryReal;
-const query: QueryBuilder<any, "public"> = (() => {}) as any;
-
-const module = {
-  noArgs: query(() => "result"),
-  args: query((_ctx, { _arg }: { _arg: string }) => "result"),
-};
-type API = ApiFromModules<{ module: typeof module }>;
-const api = anyApi as unknown as API;
-
-describe("useQuery object options", () => {
-  test("supports object options and skip sentinel", () => {
-    useQuery({
-      query: api.module.noArgs,
-      args: {},
-    });
-
-    useQuery({
-      query: api.module.args,
-      args: { _arg: "asdf" },
-    });
-
-    const _arg: string | undefined = undefined;
-    useQuery({
-      query: api.module.args,
-      args: _arg ? { _arg } : "skip",
-    });
-
-    useQuery({
-      query: api.module.args,
-      args: { _arg: "asdf" },
-    });
-
-    useQuery({
-      query: api.module.noArgs,
-      args: "skip",
-    });
-  });
-});

package/src/react/use_query_result.test.ts

@@ -1,41 +0,0 @@
-/**
- * @vitest-environment custom-vitest-environment.ts
- */
-
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { test, describe } from "vitest";
-import { anyApi } from "../server/api.js";
-
-import type { ApiFromModules, QueryBuilder } from "../server/index.js";
-import { useQuery as useQueryReal } from "./client.js";
-
-const useQuery = (() => {}) as unknown as typeof useQueryReal;
-const query: QueryBuilder<any, "public"> = (() => {}) as any;
-
-const module = {
-  noArgs: query(() => "result"),
-  args: query((_ctx, { _arg }: { _arg: string }) => "result"),
-};
-type API = ApiFromModules<{ module: typeof module }>;
-const api = anyApi as unknown as API;
-
-describe("useQuery object-form result types", () => {
-  test("supports object-form result usage", () => {
-    useQuery({
-      query: api.module.args,
-      args: { _arg: "asdf" },
-    });
-
-    useQuery({
-      query: api.module.args,
-      args: { _arg: "asdf" },
-      throwOnError: true,
-    });
-
-    const _arg: string | undefined = undefined;
-    useQuery({
-      query: api.module.args,
-      args: _arg ? { _arg } : "skip",
-    });
-  });
-});