useQuery via object

Author: ianmacartney

npm-packages/convex/src/react/client.ts

@@ -28,6 +28,8 @@ import {
   Logger,
 } from "../browser/logging.js";
 import { ConvexQueryOptions } from "../browser/query_options.js";
+import type { Preloaded } from "./hydration.js";
+import { parsePreloaded } from "./preloaded_utils.js";
 
 // When no arguments are passed, extend subscriptions (for APIs that do this by default)
 // for this amount after the subscription would otherwise be dropped.
@@ -642,6 +644,95 @@ export type OptionalRestArgsOrSkip<FuncRef extends FunctionReference<any>> =
     ? [args?: EmptyObject | "skip"]
     : [args: FuncRef["_args"] | "skip"];
 
+/**
+ * Options for the object-based {@link useQuery} overload.
+ *
+ * @public
+ */
+export type UseQueryOptions<Query extends FunctionReference<"query">> = {
+  /**
+   * The query function to run.
+   */
+  query: Query;
+  /**
+   * Whether to throw an error if the query fails.
+   * If false, the error will be returned in the `error` field.
+   * @defaultValue false
+   */
+  throwOnError?: boolean;
+  /**
+   * An initial value to use before the query result is available.
+   * @defaultValue undefined
+   */
+  initialValue?: Query["_returnType"];
+  /**
+   * When true, the query will not be subscribed and it will behave the same as
+   * if it was loading.
+   * @defaultValue false
+   */
+  skip?: boolean;
+} & (FunctionArgs<Query> extends EmptyObject
+  ? {
+      /**
+       * The arguments to the query function.
+       * Optional for queries with no arguments.
+       */
+      args?: FunctionArgs<Query>;
+    }
+  : {
+      /**
+       * The arguments to the query function.
+       */
+      args: FunctionArgs<Query>;
+    });
+
+/**
+ * Options for the object-based {@link useQuery} overload with a preloaded query.
+ *
+ * @public
+ */
+export type UseQueryPreloadedOptions<Query extends FunctionReference<"query">> =
+  {
+    /**
+     * A preloaded query result from a Server Component.
+     */
+    preloaded: Preloaded<Query>;
+    /**
+     * Whether to throw an error if the query fails.
+     * If false, the error will be returned in the `error` field.
+     * @defaultValue false
+     */
+    throwOnError?: boolean;
+    /**
+     * When true, the query will not be subscribed and it will behave the same as
+     * if it was loading.
+     * @defaultValue false
+     */
+    skip?: boolean;
+  };
+
+/**
+ * Result type for the object-based {@link useQuery} overload.
+ *
+ * @public
+ */
+export type UseQueryResult<T> =
+  | {
+      status: "success";
+      value: T;
+      error: undefined;
+    }
+  | {
+      status: "error";
+      value: undefined;
+      error: Error;
+    }
+  | {
+      status: "loading";
+      value: undefined;
+      error: undefined;
+    };
+
 /**
  * Load a reactive query within a React component.
  *
@@ -661,20 +752,84 @@ export type OptionalRestArgsOrSkip<FuncRef extends FunctionReference<any>> =
 export function useQuery<Query extends FunctionReference<"query">>(
   query: Query,
   ...args: OptionalRestArgsOrSkip<Query>
-): Query["_returnType"] | undefined {
-  const skip = args[0] === "skip";
-  const argsObject = args[0] === "skip" ? {} : parseArgs(args[0]);
+): Query["_returnType"] | undefined;
 
-  const queryReference =
-    typeof query === "string"
-      ? makeFunctionReference<"query", any, any>(query)
-      : query;
+/**
+ * Load a reactive query within a React component using an options object.
+ *
+ * This overload returns an object with `status`, `error`, and `value` fields
+ * instead of throwing errors or returning undefined.
+ *
+ * This React hook contains internal state that will cause a rerender
+ * whenever the query result changes.
+ *
+ * Throws an error if not used under {@link ConvexProvider}.
+ *
+ * @param options - An options object or the string "skip" to skip the query.
+ * @returns An object with `status`, `error`, and `value` fields.
+ *
+ * @public
+ */
+export function useQuery<Query extends FunctionReference<"query">>(
+  options: UseQueryOptions<Query> | UseQueryPreloadedOptions<Query> | "skip",
+): UseQueryResult<Query["_returnType"]>;
 
-  const queryName = getFunctionName(queryReference);
+export function useQuery<Query extends FunctionReference<"query">>(
+  queryOrOptions:
+    | Query
+    | UseQueryOptions<Query>
+    | UseQueryPreloadedOptions<Query>
+    | "skip",
+  ...args: OptionalRestArgsOrSkip<Query>
+): Query["_returnType"] | undefined | UseQueryResult<Query["_returnType"]> {
+  const isObjectOptions =
+    typeof queryOrOptions === "object" &&
+    queryOrOptions !== null &&
+    ("query" in queryOrOptions || "preloaded" in queryOrOptions);
+  const isObjectSkip =
+    queryOrOptions === "skip" || (isObjectOptions && !!queryOrOptions.skip);
+  const isLegacy = !isObjectOptions && !isObjectSkip;
+  const legacySkip = isLegacy && args[0] === "skip";
+  const isObjectReturn = isObjectOptions || isObjectSkip;
+
+  let queryReference: Query | undefined;
+  let argsObject: Record<string, Value> = {};
+  let throwOnError = false;
+  let initialValue: Query["_returnType"] | undefined;
+  let preloadedResult: Query["_returnType"] | undefined;
+
+  if (isObjectOptions) {
+    if ("preloaded" in queryOrOptions) {
+      const parsed = parsePreloaded(queryOrOptions.preloaded);
+      queryReference = parsed.queryReference;
+      argsObject = parsed.argsObject;
+      preloadedResult = parsed.preloadedResult;
+      throwOnError = queryOrOptions.throwOnError ?? false;
+    } else {
+      const query = queryOrOptions.query;
+      queryReference =
+        typeof query === "string"
+          ? (makeFunctionReference<"query", any, any>(query) as Query)
+          : query;
+      argsObject = queryOrOptions.args ?? ({} as Record<string, Value>);
+      throwOnError = queryOrOptions.throwOnError ?? false;
+      initialValue = queryOrOptions.initialValue;
+    }
+  } else if (isLegacy) {
+    const query = queryOrOptions as Query;
+    queryReference =
+      typeof query === "string"
+        ? (makeFunctionReference<"query", any, any>(query) as Query)
+        : query;
+    argsObject = legacySkip ? {} : parseArgs(args[0] as Query["_args"]);
+  }
+
+  const skip = isObjectSkip || legacySkip;
+  const queryName = queryReference ? getFunctionName(queryReference) : "";
 
   const queries = useMemo(
     () =>
-      skip
+      skip || !queryReference
         ? ({} as RequestForQueries)
         : { query: { query: queryReference, args: argsObject } },
     // Stringify args so args that are semantically the same don't trigger a
@@ -685,10 +840,46 @@ export function useQuery<Query extends FunctionReference<"query">>(
 
   const results = useQueries(queries);
   const result = results["query"];
+
+  if (!isObjectReturn) {
+    if (result instanceof Error) {
+      throw result;
+    }
+    return result;
+  }
+
   if (result instanceof Error) {
-    throw result;
+    if (throwOnError) {
+      throw result;
+    }
+    return {
+      status: "error",
+      value: undefined,
+      error: result,
+    } satisfies UseQueryResult<Query["_returnType"]>;
   }
-  return result;
+
+  if (result === undefined) {
+    const fallbackValue = preloadedResult ?? initialValue;
+    if (fallbackValue !== undefined) {
+      return {
+        status: "success",
+        value: fallbackValue,
+        error: undefined,
+      } satisfies UseQueryResult<Query["_returnType"]>;
+    }
+    return {
+      status: "loading",
+      value: undefined,
+      error: undefined,
+    } satisfies UseQueryResult<Query["_returnType"]>;
+  }
+
+  return {
+    status: "success",
+    value: result,
+    error: undefined,
+  } satisfies UseQueryResult<Query["_returnType"]>;
 }
 
 /**

npm-packages/convex/src/react/hydration.tsx

@@ -1,7 +1,7 @@
 import { useMemo } from "react";
 import { useQuery } from "../react/client.js";
-import { FunctionReference, makeFunctionReference } from "../server/api.js";
-import { jsonToConvex } from "../values/index.js";
+import { FunctionReference } from "../server/api.js";
+import { parsePreloaded } from "./preloaded_utils.js";
 
 /**
  * The preloaded query payload, which should be passed to a client component
@@ -34,17 +34,10 @@ export type Preloaded<Query extends FunctionReference<"query">> = {
 export function usePreloadedQuery<Query extends FunctionReference<"query">>(
   preloadedQuery: Preloaded<Query>,
 ): Query["_returnType"] {
-  const args = useMemo(
-    () => jsonToConvex(preloadedQuery._argsJSON),
-    [preloadedQuery._argsJSON],
-  ) as Query["_args"];
-  const preloadedResult = useMemo(
-    () => jsonToConvex(preloadedQuery._valueJSON),
-    [preloadedQuery._valueJSON],
+  const parsed = useMemo(
+    () => parsePreloaded(preloadedQuery),
+    [preloadedQuery],
   );
-  const result = useQuery(
-    makeFunctionReference(preloadedQuery._name) as Query,
-    args,
-  );
-  return result === undefined ? preloadedResult : result;
+  const result = useQuery(parsed.queryReference, parsed.argsObject);
+  return result === undefined ? parsed.preloadedResult : result;
 }

npm-packages/convex/src/react/index.ts

@@ -76,6 +76,9 @@ export {
   type MutationOptions,
   type ConvexReactClientOptions,
   type OptionalRestArgsOrSkip,
+  type UseQueryOptions,
+  type UseQueryPreloadedOptions,
+  type UseQueryResult,
   ConvexReactClient,
   useConvex,
   ConvexProvider,

npm-packages/convex/src/react/preloaded_utils.ts

@@ -0,0 +1,29 @@
+import {
+  FunctionArgs,
+  FunctionReference,
+  makeFunctionReference,
+} from "../server/api.js";
+import { jsonToConvex } from "../values/index.js";
+import type { Preloaded } from "./hydration.js";
+
+/**
+ * Parse a preloaded query payload into its constituent parts.
+ *
+ * This is a hook-free helper that can be used by both `useQuery` and
+ * `usePreloadedQuery` to avoid duplicating the parsing logic.
+ *
+ * @internal
+ */
+export function parsePreloaded<Query extends FunctionReference<"query">>(
+  preloaded: Preloaded<Query>,
+): {
+  queryReference: Query;
+  argsObject: FunctionArgs<Query>;
+  preloadedResult: Query["_returnType"];
+} {
+  return {
+    queryReference: makeFunctionReference(preloaded._name) as Query,
+    argsObject: jsonToConvex(preloaded._argsJSON) as FunctionArgs<Query>,
+    preloadedResult: jsonToConvex(preloaded._valueJSON) as Query["_returnType"],
+  };
+}