better-convex 0.9.2 → 0.10.0

package/dist/react/index.js

@@ -4,9 +4,10 @@ import { c } from "react/compiler-runtime";
 import { ConvexProvider, ConvexReactClient, ConvexReactClient as ConvexReactClient$1, useAction, useConvex, useMutation } from "convex/react";
 import { createContext, useCallback, useContext, useEffect, useMemo, useRef, useState } from "react";
 import { jsx } from "react/jsx-runtime";
-import { hashKey, notifyManager, skipToken, useQueries, useQueryClient } from "@tanstack/react-query";
+import { notifyManager, skipToken, useQueries, useQueryClient } from "@tanstack/react-query";
 import { getFunctionName } from "convex/server";
 import { ConvexHttpClient } from "convex/browser";
+import { hashKey } from "@tanstack/query-core";
 import { convexToJson } from "convex/values";
 
 //#region src/shared/meta-utils.ts
@@ -140,6 +141,114 @@ var HttpClientError = class extends Error {
 	}
 };
 
+//#endregion
+//#region src/crpc/http-client.ts
+/**
+* HTTP Client Helpers
+*
+* Framework-agnostic utilities for executing HTTP requests
+* against Convex HTTP endpoints.
+*/
+/** Reserved keys that are not part of JSON body */
+const RESERVED_KEYS = new Set([
+	"params",
+	"searchParams",
+	"form",
+	"fetch",
+	"init",
+	"headers"
+]);
+/**
+* Replace URL path parameters with actual values.
+* e.g., '/users/:id' with { id: '123' } -> '/users/123'
+*/
+function replaceUrlParam(url, params) {
+	return url.replace(/:(\w+)/g, (_, key) => {
+		const value = params[key];
+		return value !== void 0 ? encodeURIComponent(value) : `:${key}`;
+	});
+}
+/**
+* Build URLSearchParams from query object.
+* Handles array values as multiple params with same key (like Hono).
+*/
+function buildSearchParams(query) {
+	const params = new URLSearchParams();
+	for (const [key, value] of Object.entries(query)) if (Array.isArray(value)) for (const v of value) params.append(key, v);
+	else if (value !== void 0 && value !== null) params.append(key, value);
+	return params;
+}
+/**
+* Hono-style HTTP request executor.
+* Processes args in the same way as Hono's ClientRequestImpl.fetch().
+*/
+async function executeHttpRequest(opts) {
+	const { method, path } = opts.route;
+	const args = opts.args ?? {};
+	let rBody;
+	let cType;
+	if (args.form) {
+		const form = new FormData();
+		for (const [k, v] of Object.entries(args.form)) if (Array.isArray(v)) for (const v2 of v) form.append(k, v2);
+		else form.append(k, v);
+		rBody = form;
+	} else {
+		const jsonBody = {};
+		for (const [key, value] of Object.entries(args)) if (!RESERVED_KEYS.has(key) && value !== void 0) jsonBody[key] = value;
+		if (Object.keys(jsonBody).length > 0) {
+			rBody = JSON.stringify(opts.transformer.input.serialize(jsonBody));
+			cType = "application/json";
+		}
+	}
+	const argsClientOpts = {};
+	if (args.fetch) argsClientOpts.fetch = args.fetch;
+	if (args.init) argsClientOpts.init = args.init;
+	if (args.headers) argsClientOpts.headers = args.headers;
+	const mergedClientOpts = {
+		...opts.clientOpts,
+		...argsClientOpts
+	};
+	const resolvedBaseHeaders = typeof opts.baseHeaders === "function" ? await opts.baseHeaders() : opts.baseHeaders;
+	const headerValues = { ...typeof mergedClientOpts.headers === "function" ? await mergedClientOpts.headers() : mergedClientOpts.headers };
+	if (cType) headerValues["Content-Type"] = cType;
+	const finalHeaders = {};
+	if (resolvedBaseHeaders) {
+		for (const [key, value] of Object.entries(resolvedBaseHeaders)) if (value !== void 0) finalHeaders[key] = value;
+	}
+	Object.assign(finalHeaders, headerValues);
+	let url = opts.convexSiteUrl + path;
+	if (args.params) url = opts.convexSiteUrl + replaceUrlParam(path, args.params);
+	if (args.searchParams) {
+		const queryString = buildSearchParams(args.searchParams).toString();
+		if (queryString) url = `${url}?${queryString}`;
+	}
+	const methodUpperCase = method.toUpperCase();
+	const setBody = !(methodUpperCase === "GET" || methodUpperCase === "HEAD");
+	const response = await (mergedClientOpts.fetch ?? opts.baseFetch ?? globalThis.fetch)(url, {
+		body: setBody ? rBody : void 0,
+		method: methodUpperCase,
+		headers: finalHeaders,
+		...mergedClientOpts.init
+	});
+	if (!response.ok) {
+		const errorData = await response.json().catch(() => ({ error: {
+			code: "UNKNOWN",
+			message: response.statusText
+		} }));
+		const errorCode = errorData?.error?.code || "UNKNOWN";
+		const errorMessage = errorData?.error?.message || response.statusText;
+		throw new HttpClientError({
+			code: errorCode,
+			status: response.status,
+			procedureName: opts.procedureName,
+			message: errorMessage
+		});
+	}
+	if (response.headers.get("content-length") === "0" || response.status === 204) return;
+	if ((response.headers.get("content-type") || "").includes("application/json")) return opts.transformer.output.deserialize(await response.json());
+	return response.text();
+}
+
 //#endregion
 //#region src/crpc/transformer.ts
 const isPlainObject = (value) => {
@@ -313,105 +422,6 @@ const getTransformer = (transformer) => {
 
 //#endregion
 //#region src/react/http-proxy.ts
-/** Reserved keys that are not part of JSON body */
-const RESERVED_KEYS = new Set([
-	"params",
-	"searchParams",
-	"form",
-	"fetch",
-	"init",
-	"headers"
-]);
-/**
-* Replace URL path parameters with actual values.
-* e.g., '/users/:id' with { id: '123' } -> '/users/123'
-*/
-function replaceUrlParam(url, params) {
-	return url.replace(/:(\w+)/g, (_, key) => {
-		const value = params[key];
-		return value !== void 0 ? encodeURIComponent(value) : `:${key}`;
-	});
-}
-/**
-* Build URLSearchParams from query object.
-* Handles array values as multiple params with same key (like Hono).
-*/
-function buildSearchParams(query) {
-	const params = new URLSearchParams();
-	for (const [key, value] of Object.entries(query)) if (Array.isArray(value)) for (const v of value) params.append(key, v);
-	else if (value !== void 0 && value !== null) params.append(key, value);
-	return params;
-}
-/**
-* Hono-style HTTP request executor.
-* Processes args in the same way as Hono's ClientRequestImpl.fetch().
-*/
-async function executeHttpRequest(opts) {
-	const { method, path } = opts.route;
-	const args = opts.args ?? {};
-	let rBody;
-	let cType;
-	if (args.form) {
-		const form = new FormData();
-		for (const [k, v] of Object.entries(args.form)) if (Array.isArray(v)) for (const v2 of v) form.append(k, v2);
-		else form.append(k, v);
-		rBody = form;
-	} else {
-		const jsonBody = {};
-		for (const [key, value] of Object.entries(args)) if (!RESERVED_KEYS.has(key) && value !== void 0) jsonBody[key] = value;
-		if (Object.keys(jsonBody).length > 0) {
-			rBody = JSON.stringify(opts.transformer.input.serialize(jsonBody));
-			cType = "application/json";
-		}
-	}
-	const argsClientOpts = {};
-	if (args.fetch) argsClientOpts.fetch = args.fetch;
-	if (args.init) argsClientOpts.init = args.init;
-	if (args.headers) argsClientOpts.headers = args.headers;
-	const mergedClientOpts = {
-		...opts.clientOpts,
-		...argsClientOpts
-	};
-	const resolvedBaseHeaders = typeof opts.baseHeaders === "function" ? await opts.baseHeaders() : opts.baseHeaders;
-	const headerValues = { ...typeof mergedClientOpts.headers === "function" ? await mergedClientOpts.headers() : mergedClientOpts.headers };
-	if (cType) headerValues["Content-Type"] = cType;
-	const finalHeaders = {};
-	if (resolvedBaseHeaders) {
-		for (const [key, value] of Object.entries(resolvedBaseHeaders)) if (value !== void 0) finalHeaders[key] = value;
-	}
-	Object.assign(finalHeaders, headerValues);
-	let url = opts.convexSiteUrl + path;
-	if (args.params) url = opts.convexSiteUrl + replaceUrlParam(path, args.params);
-	if (args.searchParams) {
-		const queryString = buildSearchParams(args.searchParams).toString();
-		if (queryString) url = `${url}?${queryString}`;
-	}
-	const methodUpperCase = method.toUpperCase();
-	const setBody = !(methodUpperCase === "GET" || methodUpperCase === "HEAD");
-	const response = await (mergedClientOpts.fetch ?? opts.baseFetch ?? globalThis.fetch)(url, {
-		body: setBody ? rBody : void 0,
-		method: methodUpperCase,
-		headers: finalHeaders,
-		...mergedClientOpts.init
-	});
-	if (!response.ok) {
-		const errorData = await response.json().catch(() => ({ error: {
-			code: "UNKNOWN",
-			message: response.statusText
-		} }));
-		const errorCode = errorData?.error?.code || "UNKNOWN";
-		const errorMessage = errorData?.error?.message || response.statusText;
-		throw new HttpClientError({
-			code: errorCode,
-			status: response.status,
-			procedureName: opts.procedureName,
-			message: errorMessage
-		});
-	}
-	if (response.headers.get("content-length") === "0" || response.status === 204) return;
-	if ((response.headers.get("content-type") || "").includes("application/json")) return opts.transformer.output.deserialize(await response.json());
-	return response.text();
-}
 /**
 * Create a recursive proxy for HTTP routes with TanStack Query integration.
 *
@@ -1637,7 +1647,12 @@ function createCRPCContext(options) {
 }
 
 //#endregion
-//#region src/react/auth-mutations.ts
+//#region src/crpc/auth-error.ts
+/**
+* Auth Mutation Error
+*
+* Framework-agnostic error class for Better Auth mutations.
+*/
 /**
 * Error thrown when a Better Auth mutation fails.
 * Contains the original error details from Better Auth.
@@ -1663,6 +1678,9 @@ var AuthMutationError = class extends Error {
 function isAuthMutationError(error) {
 	return error instanceof AuthMutationError;
 }
+
+//#endregion
+//#region src/react/auth-mutations.ts
 /** Poll until token is null (max 5s) */
 const waitForTokenClear = async (store, timeout = 5e3) => {
 	const start = Date.now();

package/dist/rsc/index.d.ts

@@ -1,29 +1,106 @@
-import { o as Simplify, r as DistributiveOmit } from "../types-BTb_4BaU.js";
+import { n as DeepPartial, o as Simplify, r as DistributiveOmit } from "../types-BTb_4BaU.js";
 import { C as HttpProcedure, G as DataTransformerOptions, V as UnsetMarker, d as CRPCHttpRouter, p as HttpRouterRecord } from "../http-types-BK7FuIcR.js";
-import { n as CRPCClient } from "../types-f53SgpBL.js";
-import { DefaultError, QueryFilters, UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
+import { A as HttpInputArgs, C as ReservedMutationOptions$1, S as ReservedInfiniteQueryOptions, T as StaticQueryOptsParam, _ as IsPaginated, b as PaginatedFnMeta, c as ConvexMutationKey, d as ConvexQueryMeta, f as EmptyObject, g as InfiniteQueryInput, l as ConvexQueryHookOptions, m as FUNC_REF_SYMBOL, o as ConvexActionKey, p as ExtractPaginatedItem, s as ConvexInfiniteQueryMeta, u as ConvexQueryKey, w as ReservedQueryOptions$1, y as MutationVariables } from "../types-7bF_8IjP.js";
+import { FunctionArgs, FunctionReference, FunctionReturnType } from "convex/server";
 import { z } from "zod";
+import { DefaultError, QueryFilters, SkipToken, UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
 
-//#region src/react/http-proxy.d.ts
-/** Form value types (matches Hono's FormValue) */
-type HttpFormValue = string | Blob;
-/**
- * Hybrid input args: JSON body fields at root, explicit params/searchParams/form.
- * - JSON body: spread at root level (tRPC-style)
- * - Path params: { params: { id: '123' } }
- * - Query params: { searchParams: { limit: '10' } }
- * - Form data: { form: { file: blob } } - typed via .form() builder
- * - Client options: { headers, fetch, init } - for per-call customization
- */
-type HttpInputArgs = {
-  /** Path parameters (e.g., :id in /users/:id) */params?: Record<string, string>; /** Query string parameters */
-  searchParams?: Record<string, string | string[]>; /** Form data body (Content-Type: multipart/form-data) - typed via .form() builder */
-  form?: Record<string, HttpFormValue | HttpFormValue[]>; /** Custom fetch function (per-call override) */
-  fetch?: typeof fetch; /** Standard RequestInit (per-call override) */
-  init?: RequestInit; /** Additional headers (per-call override) */
-  headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>); /** Any other properties are JSON body fields */
-  [key: string]: unknown;
+//#region src/react/crpc-types.d.ts
+/** Options returned by `convexQuery` factory */
+type ConvexQueryOptions<T extends FunctionReference<'query'>> = Pick<UseQueryOptions<FunctionReturnType<T>, Error, FunctionReturnType<T>, ConvexQueryKey<T>>, 'queryKey' | 'staleTime' | 'enabled'>;
+/** Options returned by `convexAction` factory */
+type ConvexActionOptions<T extends FunctionReference<'action'>> = Pick<UseQueryOptions<FunctionReturnType<T>, Error, FunctionReturnType<T>, ConvexActionKey<T>>, 'queryKey' | 'staleTime' | 'enabled'>;
+/** Query options parameter type */
+type QueryOptsParam<T extends FunctionReference<'query'>> = Simplify<ConvexQueryHookOptions & DistributiveOmit<UseQueryOptions<FunctionReturnType<T>, DefaultError>, ReservedQueryOptions$1>>;
+/** Query options return type */
+type QueryOptsReturn<T extends FunctionReference<'query'>> = ConvexQueryOptions<T> & {
+  meta: ConvexQueryMeta;
+};
+/** Action query options parameter type (actions don't support subscriptions) */
+type ActionQueryOptsParam<T extends FunctionReference<'action'>> = DistributiveOmit<UseQueryOptions<FunctionReturnType<T>, DefaultError>, ReservedQueryOptions$1>;
+/** Action query options return type */
+type ActionQueryOptsReturn<T extends FunctionReference<'action'>> = ConvexActionOptions<T>;
+/**
+ * Decorated query procedure with queryOptions, queryKey, and queryFilter methods.
+ * Args are optional when the function has no required parameters.
+ * Supports skipToken for type-safe conditional queries.
+ */
+type DecorateQuery<T extends FunctionReference<'query'>> = {
+  queryOptions: keyof FunctionArgs<T> extends never ? (args?: EmptyObject | SkipToken, opts?: QueryOptsParam<T>) => QueryOptsReturn<T> : EmptyObject extends FunctionArgs<T> ? (args?: FunctionArgs<T> | SkipToken, opts?: QueryOptsParam<T>) => QueryOptsReturn<T> : (args: FunctionArgs<T> | SkipToken, opts?: QueryOptsParam<T>) => QueryOptsReturn<T>; /** Static (non-hook) query options for event handlers and prefetching */
+  staticQueryOptions: keyof FunctionArgs<T> extends never ? (args?: EmptyObject | SkipToken, opts?: StaticQueryOptsParam) => ConvexQueryOptions<T> & {
+    meta: ConvexQueryMeta;
+  } : EmptyObject extends FunctionArgs<T> ? (args?: FunctionArgs<T> | SkipToken, opts?: StaticQueryOptsParam) => ConvexQueryOptions<T> & {
+    meta: ConvexQueryMeta;
+  } : (args: FunctionArgs<T> | SkipToken, opts?: StaticQueryOptsParam) => ConvexQueryOptions<T> & {
+    meta: ConvexQueryMeta;
+  }; /** Get query key for QueryClient methods (setQueryData, getQueryData, etc.) */
+  queryKey: (args?: DeepPartial<FunctionArgs<T>>) => ConvexQueryKey<T>; /** Get query filter for QueryClient methods (invalidateQueries, removeQueries, etc.) */
+  queryFilter: (args?: DeepPartial<FunctionArgs<T>>, filters?: DistributiveOmit<QueryFilters, 'queryKey'>) => QueryFilters;
+};
+/** Options for infinite query - extends TanStack Query options */
+type InfiniteQueryOptsParam<T extends FunctionReference<'query'> = FunctionReference<'query'>> = {
+  /** Items per page. Optional - server uses .paginated() default if not provided. */limit?: number; /** Skip query silently when unauthenticated */
+  skipUnauth?: boolean; /** Placeholder data shown while loading (item array, not pagination result) */
+  placeholderData?: ExtractPaginatedItem<FunctionReturnType<T>>[];
+} & DistributiveOmit<UseQueryOptions<FunctionReturnType<T>, DefaultError>, ReservedInfiniteQueryOptions>;
+/** Return type of infiniteQueryOptions - compatible with TanStack prefetch */
+type ConvexInfiniteQueryOptions<T extends FunctionReference<'query'>> = Pick<UseQueryOptions<FunctionReturnType<T>, Error, FunctionReturnType<T>, ConvexQueryKey<T>>, 'queryKey' | 'staleTime' | 'enabled'> & {
+  meta: ConvexInfiniteQueryMeta;
+  refetchInterval: false;
+  refetchOnMount: false;
+  refetchOnReconnect: false;
+  refetchOnWindowFocus: false; /** Placeholder data shown while loading (item array, not pagination result) */
+  placeholderData?: ExtractPaginatedItem<FunctionReturnType<T>>[];
+} & DistributiveOmit<UseQueryOptions<FunctionReturnType<T>, DefaultError>, ReservedInfiniteQueryOptions>;
+/** Infinite query options with attached function reference (client-only) */
+type ConvexInfiniteQueryOptionsWithRef<T extends FunctionReference<'query'>> = ConvexInfiniteQueryOptions<T> & {
+  [FUNC_REF_SYMBOL]: T;
+};
+/** Infinite query options return type */
+type InfiniteQueryOptsReturn<T extends FunctionReference<'query'>> = ConvexInfiniteQueryOptionsWithRef<T>;
+/**
+ * Decorated infinite query procedure.
+ * Only available on queries that have cursor/limit in their input (paginated).
+ * Supports skipToken for conditional queries.
+ * Args are optional when the function has no required parameters (besides cursor/limit).
+ */
+type DecorateInfiniteQuery<T extends FunctionReference<'query'>> = {
+  /** Create infinite query options for useInfiniteQuery and prefetch */infiniteQueryOptions: keyof InfiniteQueryInput<FunctionArgs<T>> extends never ? (args?: EmptyObject | SkipToken, opts?: InfiniteQueryOptsParam<T>) => InfiniteQueryOptsReturn<T> : EmptyObject extends InfiniteQueryInput<FunctionArgs<T>> ? (args?: InfiniteQueryInput<FunctionArgs<T>> | SkipToken, opts?: InfiniteQueryOptsParam<T>) => InfiniteQueryOptsReturn<T> : (args: InfiniteQueryInput<FunctionArgs<T>> | SkipToken, opts?: InfiniteQueryOptsParam<T>) => InfiniteQueryOptsReturn<T>; /** Get query key for infinite query (QueryClient methods like setQueryData, getQueryData) */
+  infiniteQueryKey: (args?: DeepPartial<InfiniteQueryInput<FunctionArgs<T>>>) => ConvexQueryKey<T>; /** Function metadata from server (auth, limit, rateLimit, role, type) */
+  meta: PaginatedFnMeta;
+};
+/**
+ * Decorated mutation procedure with mutationOptions and mutationKey methods.
+ */
+type DecorateMutation<T extends FunctionReference<'mutation'>> = {
+  mutationOptions: (opts?: DistributiveOmit<UseMutationOptions<FunctionReturnType<T>, DefaultError, MutationVariables<T>>, ReservedMutationOptions$1>) => UseMutationOptions<FunctionReturnType<T>, DefaultError, MutationVariables<T>>; /** Get mutation key for QueryClient methods */
+  mutationKey: () => ConvexMutationKey;
+};
+/**
+ * Decorated action procedure with queryOptions, mutationOptions, and key methods.
+ * Actions can be used as one-shot queries (no subscription) or as mutations.
+ * Supports skipToken for conditional queries.
+ */
+type DecorateAction<T extends FunctionReference<'action'>> = {
+  /** Use action as a one-shot query (no WebSocket subscription) */queryOptions: keyof FunctionArgs<T> extends never ? (args?: EmptyObject | SkipToken, opts?: ActionQueryOptsParam<T>) => ActionQueryOptsReturn<T> : EmptyObject extends FunctionArgs<T> ? (args?: FunctionArgs<T> | SkipToken, opts?: ActionQueryOptsParam<T>) => ActionQueryOptsReturn<T> : (args: FunctionArgs<T> | SkipToken, opts?: ActionQueryOptsParam<T>) => ActionQueryOptsReturn<T>; /** Static (non-hook) action query options for event handlers and prefetching */
+  staticQueryOptions: keyof FunctionArgs<T> extends never ? (args?: EmptyObject | SkipToken, opts?: StaticQueryOptsParam) => ConvexActionOptions<T> & {
+    meta: ConvexQueryMeta;
+  } : EmptyObject extends FunctionArgs<T> ? (args?: FunctionArgs<T> | SkipToken, opts?: StaticQueryOptsParam) => ConvexActionOptions<T> & {
+    meta: ConvexQueryMeta;
+  } : (args: FunctionArgs<T> | SkipToken, opts?: StaticQueryOptsParam) => ConvexActionOptions<T> & {
+    meta: ConvexQueryMeta;
+  }; /** Use action as a mutation */
+  mutationOptions: (opts?: DistributiveOmit<UseMutationOptions<FunctionReturnType<T>, DefaultError, MutationVariables<T>>, ReservedMutationOptions$1>) => UseMutationOptions<FunctionReturnType<T>, DefaultError, MutationVariables<T>>; /** Get mutation key for QueryClient methods */
+  mutationKey: () => ConvexMutationKey; /** Get query key for QueryClient methods */
+  queryKey: (args?: DeepPartial<FunctionArgs<T>>) => ConvexActionKey<T>; /** Get query filter for QueryClient methods */
+  queryFilter: (args?: DeepPartial<FunctionArgs<T>>, filters?: DistributiveOmit<QueryFilters, 'queryKey'>) => QueryFilters;
 };
+/**
+ * Recursively decorates all procedures in a Convex API object.
+ */
+type CRPCClient<TApi> = { [K in keyof TApi as K extends string ? K extends `_${string}` ? never : K : K]: TApi[K] extends FunctionReference<'query'> ? IsPaginated<FunctionArgs<TApi[K]>> extends true ? DecorateQuery<TApi[K]> & DecorateInfiniteQuery<TApi[K]> : DecorateQuery<TApi[K]> : TApi[K] extends FunctionReference<'mutation'> ? DecorateMutation<TApi[K]> : TApi[K] extends FunctionReference<'action'> ? DecorateAction<TApi[K]> : TApi[K] extends Record<string, unknown> ? CRPCClient<TApi[K]> : never };
+//#endregion
+//#region src/react/http-proxy.d.ts
 /** Infer schema type or return empty object if UnsetMarker */
 type InferSchemaOrEmpty<T> = T extends UnsetMarker ? object : T extends z.ZodTypeAny ? z.infer<T> : object;
 /** Infer merged input from HttpProcedure (flat - used internally) */

package/dist/rsc/index.js

@@ -5,7 +5,7 @@ import { n as convexInfiniteQueryOptions, r as convexQuery } from "../query-opti
 import { convexToJson } from "convex/values";
 import { getFunctionName } from "convex/server";
 import { fetchAction, fetchQuery } from "convex/nextjs";
-import { hashKey } from "@tanstack/react-query";
+import { hashKey } from "@tanstack/query-core";
 
 //#region src/rsc/http-server.ts
 /**