convex-route-query 0.0.1 → 0.1.0

package/README.md

@@ -1,72 +1,297 @@
 # convex-route-query
 
-Type-safe Convex query helpers for TanStack Router loaders and React Query Suspense.
+Type-safe Convex query helpers for TanStack Router loaders and React Query
+Suspense.
+
+`convex-route-query` lets a route preload a Convex query once, return the typed
+query args as loader data, and then read the same query from the route component
+without rebuilding params or search state.
 
 ```ts
-import { createConvexRouteQuery } from "convex-route-query";
+import { createFileRoute } from "@tanstack/react-router";
+import { createConvexRouteQueries } from "convex-route-query";
 import { api } from "../convex/_generated/api";
 
-const listExperiences = createConvexRouteQuery(
-  api.resume.queries.listExperiences,
-);
+const { listExperiences } = createConvexRouteQueries({
+  listExperiences: api.resume.queries.listExperiences,
+});
 
 export const Route = createFileRoute("/experience/")({
-  loader: async ({ context }) => {
-    await listExperiences.prefetchQuery(context.queryClient);
-  },
+  loader: async (ctx) => ({
+    ...(await listExperiences.prefetchRoute(ctx)),
+  }),
   component: ExperiencePage,
 });
 
 function ExperiencePage() {
-  const { data } = listExperiences.useSuspenseQuery();
+  const { data } = listExperiences.useSuspenseRouteQuery(Route);
 
   return <ExperienceList experiences={data} />;
 }
 ```
 
-Queries with arguments infer their argument object from the Convex function reference.
+## Why this exists
+
+Convex, TanStack Router, and TanStack Query fit together beautifully, but route
+data loading can still get repetitive:
+
+- The loader has the route params, validated search params, and `QueryClient`.
+- The component needs the same Convex args again to call `useSuspenseQuery`.
+- Convex query args should stay inferred from the generated `api`.
+- `queryKey`, `queryFn`, and `staleTime` should come from `convexQuery(...)`, not
+  be rewritten by hand.
+
+This package gives each query a stable typed route key:
+
+```ts
+const getPost = createConvexRouteQuery("getPost", api.blog.queries.getPost);
+```
+
+The loader returns the key by spreading `prefetchRoute(...)`, and the component
+uses that key with `useSuspenseRouteQuery(Route)`. TypeScript makes sure those
+two sides match.
+
+## Table of contents
+
+- [Install](#install)
+- [Before you start](#before-you-start)
+- [Basic usage](#basic-usage)
+- [Search params](#search-params)
+- [Path params and loader work](#path-params-and-loader-work)
+- [Non-suspense usage](#non-suspense-usage)
+- [API reference](#api-reference)
+- [Notes](#notes)
+
+## Install
+
+```sh
+bun add convex-route-query
+```
+
+```sh
+npm install convex-route-query
+```
+
+`convex-route-query` expects these peer dependencies to be installed in your app:
+
+```sh
+bun add @convex-dev/react-query @tanstack/react-query convex react
+```
+
+## Before you start
+
+This package assumes Convex is already configured with TanStack Query and that
+your TanStack Router context exposes a `queryClient` to route loaders.
+
+If you have not wired that up yet, start with the official Convex docs:
+
+- [Convex with TanStack Query](https://docs.convex.dev/client/tanstack/tanstack-query/)
+- [TanStack Start quickstart](https://docs.convex.dev/quickstart/tanstack-start)
+- [TanStack Start with Convex](https://docs.convex.dev/client/tanstack/tanstack-start/)
+
+Once that setup is in place, `convex-route-query` gives you route-level helpers
+on top of it.
+
+## Basic usage
+
+Use `createConvexRouteQueries(...)` when you want keys inferred from object
+property names.
+
+```ts
+import { createFileRoute } from "@tanstack/react-router";
+import { createConvexRouteQueries } from "convex-route-query";
+import { api } from "../convex/_generated/api";
+
+const { listPosts } = createConvexRouteQueries({
+  listPosts: api.blog.queries.listPosts,
+});
+
+export const Route = createFileRoute("/blog/")({
+  loader: async (ctx) => ({
+    ...(await listPosts.prefetchRoute(ctx)),
+  }),
+  component: BlogIndexPage,
+});
+
+function BlogIndexPage() {
+  const { data: posts } = listPosts.useSuspenseRouteQuery(Route);
+
+  return <PostList posts={posts} />;
+}
+```
+
+`prefetchRoute(ctx)` warms the TanStack Query cache and returns a small typed
+loader-data fragment. `useSuspenseRouteQuery(Route)` reads that fragment from
+`Route.useLoaderData()` and subscribes to the same Convex query.
+
+## Search params
+
+When search params drive the query, put the exact Convex args in
+`loaderDeps`. TanStack Router will reload when those deps change, and
+`prefetchRoute(ctx)` can use `ctx.deps` automatically.
 
 ```ts
-const getPost = createConvexRouteQuery(api.blog.queries.getPost);
+import { createFileRoute } from "@tanstack/react-router";
+import { z } from "zod";
+import { createConvexRouteQueries } from "convex-route-query";
+import { api } from "../convex/_generated/api";
+
+const postsSearchSchema = z.object({
+  page: z.number().catch(1),
+  tag: z.string().catch("all"),
+});
+
+const { listPosts } = createConvexRouteQueries({
+  listPosts: api.blog.queries.listPosts,
+});
+
+export const Route = createFileRoute("/blog/")({
+  validateSearch: postsSearchSchema,
+  loaderDeps: ({ search }) => ({
+    page: search.page,
+    tag: search.tag,
+  }),
+  loader: async (ctx) => ({
+    ...(await listPosts.prefetchRoute(ctx)),
+  }),
+  component: BlogIndexPage,
+});
+
+function BlogIndexPage() {
+  const { data: posts } = listPosts.useSuspenseRouteQuery(Route);
+
+  return <PostList posts={posts} />;
+}
+```
+
+The component does not call `Route.useSearch()` or rebuild the query args. The
+loader already serialized the typed query args for this route match.
+
+## Path params and loader work
+
+Use an explicit key when you only need one query, or when you prefer to name it
+directly.
+
+```ts
+const getPost = createConvexRouteQuery("getPost", api.blog.queries.getPost);
+```
+
+For path params, or any loader that needs to combine params with other data, pass
+the Convex args to `fetchRoute` or `prefetchRoute` explicitly. The component
+still reads them from loader data.
+
+```ts
+import { createFileRoute, notFound } from "@tanstack/react-router";
+import { createConvexRouteQuery } from "convex-route-query";
+import { api } from "../convex/_generated/api";
+
+const getPost = createConvexRouteQuery("getPost", api.blog.queries.getPost);
 
 export const Route = createFileRoute("/blog/$slug")({
-  loader: async ({ context, params }) => {
-    const post = await getPost.fetchQuery(context.queryClient, {
-      slug: params.slug,
+  loader: async (ctx) => {
+    const post = await getPost.fetchRoute(ctx, {
+      slug: ctx.params.slug,
     });
 
-    if (!post) {
+    if (!post.data) {
       throw notFound();
     }
 
-    return { post };
+    return {
+      ...post.routeData,
+      title: post.data.title,
+    };
   },
   component: BlogPostPage,
 });
 
 function BlogPostPage() {
-  const { slug } = Route.useParams();
-  const { data: post } = getPost.useSuspenseQuery({ slug });
+  const { data: post } = getPost.useSuspenseRouteQuery(Route);
+  const { title } = Route.useLoaderData();
 
-  return <Post post={post} />;
+  return <Post post={post} title={title} />;
 }
 ```
 
-## Install
+Your loader can keep doing normal loader work: auth, redirects, extra prefetches,
+metadata, and anything else. Just include the route data returned by
+`prefetchRoute(...)` or `fetchRoute(...).routeData`.
 
-```sh
-bun add convex-route-query
+## Non-suspense usage
+
+Use `useQuery` when a component should render its own pending state.
+
+```ts
+function DraftPostPage() {
+  const { slug } = Route.useParams();
+  const { data: post, isPending } = getPost.useQuery(
+    { slug },
+    { enabled: Boolean(slug) },
+  );
+
+  if (isPending) {
+    return <Spinner />;
+  }
+
+  return <PostEditor post={post} />;
+}
 ```
 
-## API
+`useQuery` accepts normal TanStack Query options except the generated Convex
+options owned by this package: `queryKey`, `queryFn`, and `staleTime`.
+
+## API reference
 
 ### `createConvexRouteQuery(query)`
 
-Returns an object with:
+```ts
+const query = createConvexRouteQuery(api.someModule.someQuery);
+```
+
+Creates the low-level helper. The runtime route key is derived from the Convex
+function name, but TypeScript only sees a general `string` key.
+
+### `createConvexRouteQuery(id, query)`
+
+```ts
+const getPost = createConvexRouteQuery("getPost", api.blog.queries.getPost);
+```
+
+Creates a route-aware helper with an explicit typed key.
+
+### `createConvexRouteQueries(queries)`
+
+```ts
+const { getPost, listPosts } = createConvexRouteQueries({
+  getPost: api.blog.queries.getPost,
+  listPosts: api.blog.queries.listPosts,
+});
+```
+
+Creates route-aware helpers whose typed keys are inferred from the object keys.
+
+### Helpers
+
+| Helper                                | Use it when                                                    | Returns                              |
+| ------------------------------------- | -------------------------------------------------------------- | ------------------------------------ |
+| `options(...args)`                    | You need the underlying `convexQuery(...)` options.            | Convex query options                 |
+| `fetchQuery(queryClient, ...args)`    | A loader or utility needs the query result directly.           | `Promise<FunctionReturnType<Query>>` |
+| `prefetchQuery(queryClient, ...args)` | A loader or utility should warm the cache directly.            | `Promise<void>`                      |
+| `fetchRoute(ctx, ...args?)`           | A loader needs the result and a typed route-data fragment.     | `{ data, routeData }`                |
+| `prefetchRoute(ctx, ...args?)`        | A loader should warm the cache and return route data.          | Typed route-data fragment            |
+| `useSuspenseRouteQuery(Route)`        | A route component should read the query args from loader data. | Suspense query result                |
+| `useQuery(...args, queryOptions)`     | A component wants non-suspense query state.                    | Query result                         |
+| `useSuspenseQuery(...args)`           | A component already has the args available.                    | Suspense query result                |
+
+The route helpers need `ctx.context.queryClient`. If no args are passed to
+`fetchRoute` or `prefetchRoute`, the helper uses `ctx.deps`.
 
-- `options(...args)` - the underlying `convexQuery(...)` options.
-- `fetchQuery(queryClient, ...args)` - calls `queryClient.fetchQuery(...)`.
-- `prefetchQuery(queryClient, ...args)` - calls `queryClient.prefetchQuery(...)`.
-- `useSuspenseQuery(...args)` - calls React Query's `useSuspenseQuery(...)`.
+## Notes
 
-The loader helpers need a `QueryClient` because loaders run outside React context. The hook reads the `QueryClient` from React context.
+- This package is intentionally small. It wraps Convex queries for route loading
+  and component reads; mutations and actions should use the normal Convex and
+  TanStack Query APIs.
+- The internal loader-data key is stable and typed from your explicit key or from
+  `createConvexRouteQueries(...)` object keys.
+- Convex query options are generated by `@convex-dev/react-query`, including the
+  query key and infinite stale time.

package/dist/index.cjs

@@ -1,10 +1,21 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 let _convex_dev_react_query = require("@convex-dev/react-query");
 let _tanstack_react_query = require("@tanstack/react-query");
+let convex_server = require("convex/server");
 //#region src/index.ts
-function createConvexRouteQuery(query) {
+const routeDataKeyPrefix = "__convexRouteQuery:";
+function createConvexRouteQuery(idOrQuery, maybeQuery) {
+	const query = maybeQuery ?? idOrQuery;
+	const id = typeof idOrQuery === "string" ? idOrQuery : (0, convex_server.getFunctionName)(idOrQuery);
+	const loaderDataKey = `${routeDataKeyPrefix}${id}`;
 	const createOptions = _convex_dev_react_query.convexQuery;
 	const options = (...args) => createOptions(query, ...args);
+	const createLoaderData = (args) => Object.fromEntries([[loaderDataKey, args]]);
+	const getRouteArgs = (routeContext, args) => args.length > 0 ? args[0] : "deps" in routeContext && routeContext.deps !== void 0 ? routeContext.deps : {};
+	const getLoaderDataArgs = (loaderData) => {
+		if (typeof loaderData !== "object" || loaderData === null || !(loaderDataKey in loaderData)) throw new Error(`Missing convex-route-query loader data for "${String(id)}". Return the result of prefetchRoute(...) from this route's loader.`);
+		return loaderData[loaderDataKey];
+	};
 	return {
 		options,
 		fetchQuery(queryClient, ...args) {
@@ -13,12 +24,38 @@ function createConvexRouteQuery(query) {
 		prefetchQuery(queryClient, ...args) {
 			return queryClient.prefetchQuery(options(...args));
 		},
+		async fetchRoute(routeContext, ...args) {
+			const queryArgs = getRouteArgs(routeContext, args);
+			return {
+				data: await routeContext.context.queryClient.fetchQuery(options(...[queryArgs])),
+				routeData: createLoaderData(queryArgs)
+			};
+		},
+		async prefetchRoute(routeContext, ...args) {
+			const queryArgs = getRouteArgs(routeContext, args);
+			await routeContext.context.queryClient.prefetchQuery(options(...[queryArgs]));
+			return createLoaderData(queryArgs);
+		},
+		useQuery(...args) {
+			const [queryArgs, queryOptions] = args;
+			return (0, _tanstack_react_query.useQuery)({
+				...queryOptions,
+				...options(...[queryArgs])
+			});
+		},
+		useSuspenseRouteQuery(route) {
+			return (0, _tanstack_react_query.useSuspenseQuery)(options(...[getLoaderDataArgs(route.useLoaderData())]));
+		},
 		useSuspenseQuery(...args) {
 			return (0, _tanstack_react_query.useSuspenseQuery)(options(...args));
 		}
 	};
 }
+function createConvexRouteQueries(queries) {
+	return Object.fromEntries(Object.entries(queries).map(([id, query]) => [id, createConvexRouteQuery(id, query)]));
+}
 //#endregion
+exports.createConvexRouteQueries = createConvexRouteQueries;
 exports.createConvexRouteQuery = createConvexRouteQuery;
 
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["convexQuery"],"sources":["../src/index.ts"],"sourcesContent":["import { convexQuery } from \"@convex-dev/react-query\";\nimport {\n  useSuspenseQuery as useTanStackSuspenseQuery,\n  type UseSuspenseQueryResult,\n} from \"@tanstack/react-query\";\nimport type {\n  FunctionArgs,\n  FunctionReference,\n  FunctionReturnType,\n  OptionalRestArgs,\n} from \"convex/server\";\n\nexport type ConvexRouteQueryOptions<Query extends FunctionReference<\"query\">> =\n  {\n    queryKey: [\"convexQuery\", Query, FunctionArgs<Query>];\n    staleTime: number;\n  };\n\nexport type ConvexRouteQuery<Query extends FunctionReference<\"query\">> = {\n  options: (...args: OptionalRestArgs<Query>) => ConvexRouteQueryOptions<Query>;\n  fetchQuery: (\n    queryClient: ConvexRouteQueryClient<Query>,\n    ...args: OptionalRestArgs<Query>\n  ) => Promise<FunctionReturnType<Query>>;\n  prefetchQuery: (\n    queryClient: ConvexRouteQueryClient<Query>,\n    ...args: OptionalRestArgs<Query>\n  ) => Promise<void>;\n  useSuspenseQuery: (\n    ...args: OptionalRestArgs<Query>\n  ) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;\n};\n\nexport type ConvexRouteQueryClient<Query extends FunctionReference<\"query\">> = {\n  fetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<unknown>;\n  prefetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<void>;\n};\n\ntype CreateConvexQueryOptions<Query extends FunctionReference<\"query\">> = (\n  query: Query,\n  ...args: OptionalRestArgs<Query>\n) => ConvexRouteQueryOptions<Query>;\n\nexport function createConvexRouteQuery<\n  Query extends FunctionReference<\"query\">,\n>(query: Query): ConvexRouteQuery<Query> {\n  const createOptions =\n    convexQuery as unknown as CreateConvexQueryOptions<Query>;\n  const options = (...args: OptionalRestArgs<Query>) =>\n    createOptions(query, ...args);\n\n  return {\n    options,\n    fetchQuery(queryClient, ...args) {\n      return queryClient.fetchQuery(options(...args)) as Promise<\n        FunctionReturnType<Query>\n      >;\n    },\n    prefetchQuery(queryClient, ...args) {\n      return queryClient.prefetchQuery(options(...args));\n    },\n    useSuspenseQuery(...args) {\n      return useTanStackSuspenseQuery(options(...args));\n    },\n  };\n}\n"],"mappings":";;;;AA2CA,SAAgB,uBAEd,OAAuC;CACvC,MAAM,gBACJA,wBAAAA;CACF,MAAM,WAAW,GAAG,SAClB,cAAc,OAAO,GAAG,IAAI;CAE9B,OAAO;EACL;EACA,WAAW,aAAa,GAAG,MAAM;GAC/B,OAAO,YAAY,WAAW,QAAQ,GAAG,IAAI,CAAC;EAGhD;EACA,cAAc,aAAa,GAAG,MAAM;GAClC,OAAO,YAAY,cAAc,QAAQ,GAAG,IAAI,CAAC;EACnD;EACA,iBAAiB,GAAG,MAAM;GACxB,QAAA,GAAA,sBAAA,iBAAA,CAAgC,QAAQ,GAAG,IAAI,CAAC;EAClD;CACF;AACF"}
+{"version":3,"file":"index.cjs","names":["convexQuery","routeArgs"],"sources":["../src/index.ts"],"sourcesContent":["import { convexQuery } from \"@convex-dev/react-query\";\nimport {\n  useQuery as useTanStackQuery,\n  useSuspenseQuery as useTanStackSuspenseQuery,\n  type UseQueryOptions,\n  type UseQueryResult,\n  type UseSuspenseQueryResult,\n} from \"@tanstack/react-query\";\nimport {\n  getFunctionName,\n  type ArgsAndOptions,\n  type FunctionArgs,\n  type FunctionReference,\n  type FunctionReturnType,\n  type OptionalRestArgs,\n} from \"convex/server\";\n\nconst routeDataKeyPrefix = \"__convexRouteQuery:\";\n\nexport type ConvexRouteQueryLoaderKey<Id extends string> =\n  `${typeof routeDataKeyPrefix}${Id}`;\n\nexport type ConvexRouteQueryLoaderData<\n  Id extends string,\n  Query extends FunctionReference<\"query\">,\n> = Record<ConvexRouteQueryLoaderKey<Id>, FunctionArgs<Query>>;\n\nexport type ConvexRouteQueryOptions<Query extends FunctionReference<\"query\">> =\n  {\n    queryKey: [\"convexQuery\", Query, FunctionArgs<Query>];\n    staleTime: number;\n  };\n\nexport type ConvexRouteUseQueryOptions<\n  Query extends FunctionReference<\"query\">,\n  Data = FunctionReturnType<Query>,\n> = Omit<\n  UseQueryOptions<\n    FunctionReturnType<Query>,\n    Error,\n    Data,\n    ConvexRouteQueryOptions<Query>[\"queryKey\"]\n  >,\n  \"queryKey\" | \"queryFn\" | \"staleTime\"\n>;\n\nexport type ConvexRouteQuery<\n  Query extends FunctionReference<\"query\">,\n  Id extends string = string,\n> = {\n  options: (...args: OptionalRestArgs<Query>) => ConvexRouteQueryOptions<Query>;\n  fetchQuery: (\n    queryClient: ConvexRouteQueryClient<Query>,\n    ...args: OptionalRestArgs<Query>\n  ) => Promise<FunctionReturnType<Query>>;\n  prefetchQuery: (\n    queryClient: ConvexRouteQueryClient<Query>,\n    ...args: OptionalRestArgs<Query>\n  ) => Promise<void>;\n  fetchRoute: {\n    (\n      routeContext: ConvexRouteQueryRouteContext<Query>,\n    ): Promise<ConvexRouteQueryFetchRouteResult<Id, Query>>;\n    (\n      routeContext: ConvexRouteQueryClientContext<Query>,\n      ...args: OptionalRestArgs<Query>\n    ): Promise<ConvexRouteQueryFetchRouteResult<Id, Query>>;\n  };\n  prefetchRoute: {\n    (\n      routeContext: ConvexRouteQueryRouteContext<Query>,\n    ): Promise<ConvexRouteQueryLoaderData<Id, Query>>;\n    (\n      routeContext: ConvexRouteQueryClientContext<Query>,\n      ...args: OptionalRestArgs<Query>\n    ): Promise<ConvexRouteQueryLoaderData<Id, Query>>;\n  };\n  useQuery: <Data = FunctionReturnType<Query>>(\n    ...args: ArgsAndOptions<Query, ConvexRouteUseQueryOptions<Query, Data>>\n  ) => UseQueryResult<Data, Error>;\n  useSuspenseRouteQuery: (\n    route: ConvexRouteQueryRoute<Id, Query>,\n  ) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;\n  useSuspenseQuery: (\n    ...args: OptionalRestArgs<Query>\n  ) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;\n};\n\nexport type ConvexRouteQueryClient<Query extends FunctionReference<\"query\">> = {\n  fetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<unknown>;\n  prefetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<void>;\n};\n\nexport type ConvexRouteQueryClientContext<\n  Query extends FunctionReference<\"query\">,\n> = {\n  context: {\n    queryClient: ConvexRouteQueryClient<Query>;\n  };\n};\n\ntype ConvexRouteQueryRouteDeps<Query extends FunctionReference<\"query\">> =\n  keyof FunctionArgs<Query> extends never\n    ? {\n        deps?: FunctionArgs<Query>;\n      }\n    : {\n        deps: FunctionArgs<Query>;\n      };\n\nexport type ConvexRouteQueryRouteContext<\n  Query extends FunctionReference<\"query\">,\n> = ConvexRouteQueryClientContext<Query> & ConvexRouteQueryRouteDeps<Query>;\n\nexport type ConvexRouteQueryFetchRouteResult<\n  Id extends string,\n  Query extends FunctionReference<\"query\">,\n> = {\n  data: FunctionReturnType<Query>;\n  routeData: ConvexRouteQueryLoaderData<Id, Query>;\n};\n\nexport type ConvexRouteQueryRoute<\n  Id extends string,\n  Query extends FunctionReference<\"query\">,\n> = {\n  useLoaderData: () => ConvexRouteQueryLoaderData<Id, Query>;\n};\n\ntype CreateConvexQueryOptions<Query extends FunctionReference<\"query\">> = (\n  query: Query,\n  ...args: OptionalRestArgs<Query>\n) => ConvexRouteQueryOptions<Query>;\n\nexport function createConvexRouteQuery<\n  Query extends FunctionReference<\"query\">,\n>(query: Query): ConvexRouteQuery<Query>;\nexport function createConvexRouteQuery<\n  const Id extends string,\n  Query extends FunctionReference<\"query\">,\n>(id: Id, query: Query): ConvexRouteQuery<Query, Id>;\nexport function createConvexRouteQuery<\n  const Id extends string,\n  Query extends FunctionReference<\"query\">,\n>(\n  idOrQuery: Id | Query,\n  maybeQuery?: Query,\n): ConvexRouteQuery<Query, Id | string> {\n  const query = (maybeQuery ?? idOrQuery) as Query;\n  const id =\n    typeof idOrQuery === \"string\"\n      ? idOrQuery\n      : getFunctionName(idOrQuery as Query);\n  const loaderDataKey =\n    `${routeDataKeyPrefix}${id}` as ConvexRouteQueryLoaderKey<Id | string>;\n  const createOptions =\n    convexQuery as unknown as CreateConvexQueryOptions<Query>;\n  const options = (...args: OptionalRestArgs<Query>) =>\n    createOptions(query, ...args);\n  const createLoaderData = (args: FunctionArgs<Query>) =>\n    Object.fromEntries([\n      [loaderDataKey, args],\n    ]) as unknown as ConvexRouteQueryLoaderData<Id | string, Query>;\n  const getRouteArgs = (\n    routeContext:\n      | ConvexRouteQueryClientContext<Query>\n      | ConvexRouteQueryRouteContext<Query>,\n    args: OptionalRestArgs<Query>,\n  ) =>\n    (args.length > 0\n      ? args[0]\n      : \"deps\" in routeContext && routeContext.deps !== undefined\n        ? routeContext.deps\n        : {}) as FunctionArgs<Query>;\n  const getLoaderDataArgs = (\n    loaderData: ConvexRouteQueryLoaderData<Id, Query>,\n  ) => {\n    if (\n      typeof loaderData !== \"object\" ||\n      loaderData === null ||\n      !(loaderDataKey in loaderData)\n    ) {\n      throw new Error(\n        `Missing convex-route-query loader data for \"${String(id)}\". Return the result of prefetchRoute(...) from this route's loader.`,\n      );\n    }\n\n    return loaderData[\n      loaderDataKey as keyof typeof loaderData\n    ] as FunctionArgs<Query>;\n  };\n\n  return {\n    options,\n    fetchQuery(queryClient, ...args) {\n      return queryClient.fetchQuery(options(...args)) as Promise<\n        FunctionReturnType<Query>\n      >;\n    },\n    prefetchQuery(queryClient, ...args) {\n      return queryClient.prefetchQuery(options(...args));\n    },\n    async fetchRoute(routeContext, ...args) {\n      const routeArgs = args as OptionalRestArgs<Query>;\n      const queryArgs = getRouteArgs(routeContext, routeArgs);\n      const data = await routeContext.context.queryClient.fetchQuery(\n        options(...([queryArgs] as OptionalRestArgs<Query>)),\n      );\n\n      return {\n        data: data as FunctionReturnType<Query>,\n        routeData: createLoaderData(queryArgs),\n      };\n    },\n    async prefetchRoute(routeContext, ...args) {\n      const routeArgs = args as OptionalRestArgs<Query>;\n      const queryArgs = getRouteArgs(routeContext, routeArgs);\n\n      await routeContext.context.queryClient.prefetchQuery(\n        options(...([queryArgs] as OptionalRestArgs<Query>)),\n      );\n\n      return createLoaderData(queryArgs);\n    },\n    useQuery(...args) {\n      const [queryArgs, queryOptions] = args;\n\n      return useTanStackQuery({\n        ...queryOptions,\n        ...options(...([queryArgs] as OptionalRestArgs<Query>)),\n      });\n    },\n    useSuspenseRouteQuery(route) {\n      const loaderData = route.useLoaderData();\n      const queryArgs = getLoaderDataArgs(loaderData);\n\n      return useTanStackSuspenseQuery(\n        options(...([queryArgs] as OptionalRestArgs<Query>)),\n      );\n    },\n    useSuspenseQuery(...args) {\n      return useTanStackSuspenseQuery(options(...args));\n    },\n  };\n}\n\nexport function createConvexRouteQueries<\n  const Queries extends Record<string, FunctionReference<\"query\">>,\n>(\n  queries: Queries,\n): {\n  [Id in keyof Queries & string]: ConvexRouteQuery<Queries[Id], Id>;\n} {\n  return Object.fromEntries(\n    Object.entries(queries).map(([id, query]) => [\n      id,\n      createConvexRouteQuery(id, query),\n    ]),\n  ) as unknown as {\n    [Id in keyof Queries & string]: ConvexRouteQuery<Queries[Id], Id>;\n  };\n}\n"],"mappings":";;;;;AAiBA,MAAM,qBAAqB;AA4H3B,SAAgB,uBAId,WACA,YACsC;CACtC,MAAM,QAAS,cAAc;CAC7B,MAAM,KACJ,OAAO,cAAc,WACjB,aAAA,GAAA,cAAA,gBAAA,CACgB,SAAkB;CACxC,MAAM,gBACJ,GAAG,qBAAqB;CAC1B,MAAM,gBACJA,wBAAAA;CACF,MAAM,WAAW,GAAG,SAClB,cAAc,OAAO,GAAG,IAAI;CAC9B,MAAM,oBAAoB,SACxB,OAAO,YAAY,CACjB,CAAC,eAAe,IAAI,CACtB,CAAC;CACH,MAAM,gBACJ,cAGA,SAEC,KAAK,SAAS,IACX,KAAK,KACL,UAAU,gBAAgB,aAAa,SAAS,KAAA,IAC9C,aAAa,OACb,CAAC;CACT,MAAM,qBACJ,eACG;EACH,IACE,OAAO,eAAe,YACtB,eAAe,QACf,EAAE,iBAAiB,aAEnB,MAAM,IAAI,MACR,+CAA+C,OAAO,EAAE,EAAE,qEAC5D;EAGF,OAAO,WACL;CAEJ;CAEA,OAAO;EACL;EACA,WAAW,aAAa,GAAG,MAAM;GAC/B,OAAO,YAAY,WAAW,QAAQ,GAAG,IAAI,CAAC;EAGhD;EACA,cAAc,aAAa,GAAG,MAAM;GAClC,OAAO,YAAY,cAAc,QAAQ,GAAG,IAAI,CAAC;EACnD;EACA,MAAM,WAAW,cAAc,GAAG,MAAM;GAEtC,MAAM,YAAY,aAAa,cAAcC,IAAS;GAKtD,OAAO;IACL,MAAM,MALW,aAAa,QAAQ,YAAY,WAClD,QAAQ,GAAI,CAAC,SAAS,CAA6B,CACrD;IAIE,WAAW,iBAAiB,SAAS;GACvC;EACF;EACA,MAAM,cAAc,cAAc,GAAG,MAAM;GAEzC,MAAM,YAAY,aAAa,cAAcA,IAAS;GAEtD,MAAM,aAAa,QAAQ,YAAY,cACrC,QAAQ,GAAI,CAAC,SAAS,CAA6B,CACrD;GAEA,OAAO,iBAAiB,SAAS;EACnC;EACA,SAAS,GAAG,MAAM;GAChB,MAAM,CAAC,WAAW,gBAAgB;GAElC,QAAA,GAAA,sBAAA,SAAA,CAAwB;IACtB,GAAG;IACH,GAAG,QAAQ,GAAI,CAAC,SAAS,CAA6B;GACxD,CAAC;EACH;EACA,sBAAsB,OAAO;GAI3B,QAAA,GAAA,sBAAA,iBAAA,CACE,QAAQ,GAAI,CAHI,kBADC,MAAM,cACoB,CAGtB,CAAC,CAA6B,CACrD;EACF;EACA,iBAAiB,GAAG,MAAM;GACxB,QAAA,GAAA,sBAAA,iBAAA,CAAgC,QAAQ,GAAG,IAAI,CAAC;EAClD;CACF;AACF;AAEA,SAAgB,yBAGd,SAGA;CACA,OAAO,OAAO,YACZ,OAAO,QAAQ,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,WAAW,CAC3C,IACA,uBAAuB,IAAI,KAAK,CAClC,CAAC,CACH;AAGF"}

package/dist/index.d.cts

@@ -1,22 +1,56 @@
-import { UseSuspenseQueryResult } from "@tanstack/react-query";
-import { FunctionArgs, FunctionReference, FunctionReturnType, OptionalRestArgs } from "convex/server";
+import { UseQueryOptions, UseQueryResult, UseSuspenseQueryResult } from "@tanstack/react-query";
+import { ArgsAndOptions, FunctionArgs, FunctionReference, FunctionReturnType, OptionalRestArgs } from "convex/server";
 
 //#region src/index.d.ts
+declare const routeDataKeyPrefix = "__convexRouteQuery:";
+type ConvexRouteQueryLoaderKey<Id extends string> = `${typeof routeDataKeyPrefix}${Id}`;
+type ConvexRouteQueryLoaderData<Id extends string, Query extends FunctionReference<"query">> = Record<ConvexRouteQueryLoaderKey<Id>, FunctionArgs<Query>>;
 type ConvexRouteQueryOptions<Query extends FunctionReference<"query">> = {
   queryKey: ["convexQuery", Query, FunctionArgs<Query>];
   staleTime: number;
 };
-type ConvexRouteQuery<Query extends FunctionReference<"query">> = {
+type ConvexRouteUseQueryOptions<Query extends FunctionReference<"query">, Data = FunctionReturnType<Query>> = Omit<UseQueryOptions<FunctionReturnType<Query>, Error, Data, ConvexRouteQueryOptions<Query>["queryKey"]>, "queryKey" | "queryFn" | "staleTime">;
+type ConvexRouteQuery<Query extends FunctionReference<"query">, Id extends string = string> = {
   options: (...args: OptionalRestArgs<Query>) => ConvexRouteQueryOptions<Query>;
   fetchQuery: (queryClient: ConvexRouteQueryClient<Query>, ...args: OptionalRestArgs<Query>) => Promise<FunctionReturnType<Query>>;
   prefetchQuery: (queryClient: ConvexRouteQueryClient<Query>, ...args: OptionalRestArgs<Query>) => Promise<void>;
+  fetchRoute: {
+    (routeContext: ConvexRouteQueryRouteContext<Query>): Promise<ConvexRouteQueryFetchRouteResult<Id, Query>>;
+    (routeContext: ConvexRouteQueryClientContext<Query>, ...args: OptionalRestArgs<Query>): Promise<ConvexRouteQueryFetchRouteResult<Id, Query>>;
+  };
+  prefetchRoute: {
+    (routeContext: ConvexRouteQueryRouteContext<Query>): Promise<ConvexRouteQueryLoaderData<Id, Query>>;
+    (routeContext: ConvexRouteQueryClientContext<Query>, ...args: OptionalRestArgs<Query>): Promise<ConvexRouteQueryLoaderData<Id, Query>>;
+  };
+  useQuery: <Data = FunctionReturnType<Query>>(...args: ArgsAndOptions<Query, ConvexRouteUseQueryOptions<Query, Data>>) => UseQueryResult<Data, Error>;
+  useSuspenseRouteQuery: (route: ConvexRouteQueryRoute<Id, Query>) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;
   useSuspenseQuery: (...args: OptionalRestArgs<Query>) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;
 };
 type ConvexRouteQueryClient<Query extends FunctionReference<"query">> = {
   fetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<unknown>;
   prefetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<void>;
 };
+type ConvexRouteQueryClientContext<Query extends FunctionReference<"query">> = {
+  context: {
+    queryClient: ConvexRouteQueryClient<Query>;
+  };
+};
+type ConvexRouteQueryRouteDeps<Query extends FunctionReference<"query">> = keyof FunctionArgs<Query> extends never ? {
+  deps?: FunctionArgs<Query>;
+} : {
+  deps: FunctionArgs<Query>;
+};
+type ConvexRouteQueryRouteContext<Query extends FunctionReference<"query">> = ConvexRouteQueryClientContext<Query> & ConvexRouteQueryRouteDeps<Query>;
+type ConvexRouteQueryFetchRouteResult<Id extends string, Query extends FunctionReference<"query">> = {
+  data: FunctionReturnType<Query>;
+  routeData: ConvexRouteQueryLoaderData<Id, Query>;
+};
+type ConvexRouteQueryRoute<Id extends string, Query extends FunctionReference<"query">> = {
+  useLoaderData: () => ConvexRouteQueryLoaderData<Id, Query>;
+};
 declare function createConvexRouteQuery<Query extends FunctionReference<"query">>(query: Query): ConvexRouteQuery<Query>;
+declare function createConvexRouteQuery<const Id extends string, Query extends FunctionReference<"query">>(id: Id, query: Query): ConvexRouteQuery<Query, Id>;
+declare function createConvexRouteQueries<const Queries extends Record<string, FunctionReference<"query">>>(queries: Queries): { [Id in keyof Queries & string]: ConvexRouteQuery<Queries[Id], Id> };
 //#endregion
-export { ConvexRouteQuery, ConvexRouteQueryClient, ConvexRouteQueryOptions, createConvexRouteQuery };
+export { ConvexRouteQuery, ConvexRouteQueryClient, ConvexRouteQueryClientContext, ConvexRouteQueryFetchRouteResult, ConvexRouteQueryLoaderData, ConvexRouteQueryLoaderKey, ConvexRouteQueryOptions, ConvexRouteQueryRoute, ConvexRouteQueryRouteContext, ConvexRouteUseQueryOptions, createConvexRouteQueries, createConvexRouteQuery };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;KAYY,uBAAA,eAAsC,iBAAA;EAE9C,QAAA,kBAA0B,KAAA,EAAO,YAAA,CAAa,KAAA;EAC9C,SAAA;AAAA;AAAA,KAGQ,gBAAA,eAA+B,iBAAA;EACzC,OAAA,MAAa,IAAA,EAAM,gBAAA,CAAiB,KAAA,MAAW,uBAAA,CAAwB,KAAA;EACvE,UAAA,GACE,WAAA,EAAa,sBAAA,CAAuB,KAAA,MACjC,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;EAChC,aAAA,GACE,WAAA,EAAa,sBAAA,CAAuB,KAAA,MACjC,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,OAAA;EACL,gBAAA,MACK,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,sBAAA,CAAuB,kBAAA,CAAmB,KAAA,GAAQ,KAAA;AAAA;AAAA,KAG7C,sBAAA,eAAqC,iBAAA;EAC/C,UAAA,GAAa,OAAA,EAAS,uBAAA,CAAwB,KAAA,MAAW,OAAA;EACzD,aAAA,GAAgB,OAAA,EAAS,uBAAA,CAAwB,KAAA,MAAW,OAAA;AAAA;AAAA,iBAQ9C,sBAAA,eACA,iBAAA,WACd,KAAA,EAAO,KAAA,GAAQ,gBAAA,CAAiB,KAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;cAiBM,kBAAA;AAAA,KAEM,yBAAA,gCACA,kBAAA,GAAqB,EAAE;AAAA,KAEvB,0BAAA,kCAEI,iBAAA,aACZ,MAAA,CAAO,yBAAA,CAA0B,EAAA,GAAK,YAAA,CAAa,KAAA;AAAA,KAE3C,uBAAA,eAAsC,iBAAA;EAE9C,QAAA,kBAA0B,KAAA,EAAO,YAAA,CAAa,KAAA;EAC9C,SAAA;AAAA;AAAA,KAGQ,0BAAA,eACI,iBAAA,kBACP,kBAAA,CAAmB,KAAA,KACxB,IAAA,CACF,eAAA,CACE,kBAAA,CAAmB,KAAA,GACnB,KAAA,EACA,IAAA,EACA,uBAAA,CAAwB,KAAA;AAAA,KAKhB,gBAAA,eACI,iBAAA;EAGd,OAAA,MAAa,IAAA,EAAM,gBAAA,CAAiB,KAAA,MAAW,uBAAA,CAAwB,KAAA;EACvE,UAAA,GACE,WAAA,EAAa,sBAAA,CAAuB,KAAA,MACjC,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;EAChC,aAAA,GACE,WAAA,EAAa,sBAAA,CAAuB,KAAA,MACjC,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,OAAA;EACL,UAAA;IAAA,CAEI,YAAA,EAAc,4BAAA,CAA6B,KAAA,IAC1C,OAAA,CAAQ,gCAAA,CAAiC,EAAA,EAAI,KAAA;IAAA,CAE9C,YAAA,EAAc,6BAAA,CAA8B,KAAA,MACzC,IAAA,EAAM,gBAAA,CAAiB,KAAA,IACzB,OAAA,CAAQ,gCAAA,CAAiC,EAAA,EAAI,KAAA;EAAA;EAElD,aAAA;IAAA,CAEI,YAAA,EAAc,4BAAA,CAA6B,KAAA,IAC1C,OAAA,CAAQ,0BAAA,CAA2B,EAAA,EAAI,KAAA;IAAA,CAExC,YAAA,EAAc,6BAAA,CAA8B,KAAA,MACzC,IAAA,EAAM,gBAAA,CAAiB,KAAA,IACzB,OAAA,CAAQ,0BAAA,CAA2B,EAAA,EAAI,KAAA;EAAA;EAE5C,QAAA,UAAkB,kBAAA,CAAmB,KAAA,MAChC,IAAA,EAAM,cAAA,CAAe,KAAA,EAAO,0BAAA,CAA2B,KAAA,EAAO,IAAA,OAC9D,cAAA,CAAe,IAAA,EAAM,KAAA;EAC1B,qBAAA,GACE,KAAA,EAAO,qBAAA,CAAsB,EAAA,EAAI,KAAA,MAC9B,sBAAA,CAAuB,kBAAA,CAAmB,KAAA,GAAQ,KAAA;EACvD,gBAAA,MACK,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,sBAAA,CAAuB,kBAAA,CAAmB,KAAA,GAAQ,KAAA;AAAA;AAAA,KAG7C,sBAAA,eAAqC,iBAAA;EAC/C,UAAA,GAAa,OAAA,EAAS,uBAAA,CAAwB,KAAA,MAAW,OAAA;EACzD,aAAA,GAAgB,OAAA,EAAS,uBAAA,CAAwB,KAAA,MAAW,OAAA;AAAA;AAAA,KAGlD,6BAAA,eACI,iBAAA;EAEd,OAAA;IACE,WAAA,EAAa,sBAAA,CAAuB,KAAA;EAAA;AAAA;AAAA,KAInC,yBAAA,eAAwC,iBAAA,mBACrC,YAAA,CAAa,KAAA;EAEb,IAAA,GAAO,YAAA,CAAa,KAAA;AAAA;EAGpB,IAAA,EAAM,YAAA,CAAa,KAAA;AAAA;AAAA,KAGf,4BAAA,eACI,iBAAA,aACZ,6BAAA,CAA8B,KAAA,IAAS,yBAAA,CAA0B,KAAA;AAAA,KAEzD,gCAAA,kCAEI,iBAAA;EAEd,IAAA,EAAM,kBAAA,CAAmB,KAAA;EACzB,SAAA,EAAW,0BAAA,CAA2B,EAAA,EAAI,KAAA;AAAA;AAAA,KAGhC,qBAAA,kCAEI,iBAAA;EAEd,aAAA,QAAqB,0BAAA,CAA2B,EAAA,EAAI,KAAA;AAAA;AAAA,iBAQtC,sBAAA,eACA,iBAAA,WACd,KAAA,EAAO,KAAA,GAAQ,gBAAA,CAAiB,KAAA;AAAA,iBAClB,sBAAA,wCAEA,iBAAA,WACd,EAAA,EAAI,EAAA,EAAI,KAAA,EAAO,KAAA,GAAQ,gBAAA,CAAiB,KAAA,EAAO,EAAA;AAAA,iBA0GjC,wBAAA,uBACQ,MAAA,SAAe,iBAAA,YAErC,OAAA,EAAS,OAAA,kBAEI,OAAA,YAAmB,gBAAA,CAAiB,OAAA,CAAQ,EAAA,GAAK,EAAA"}

package/dist/index.d.mts

@@ -1,22 +1,56 @@
-import { UseSuspenseQueryResult } from "@tanstack/react-query";
-import { FunctionArgs, FunctionReference, FunctionReturnType, OptionalRestArgs } from "convex/server";
+import { UseQueryOptions, UseQueryResult, UseSuspenseQueryResult } from "@tanstack/react-query";
+import { ArgsAndOptions, FunctionArgs, FunctionReference, FunctionReturnType, OptionalRestArgs } from "convex/server";
 
 //#region src/index.d.ts
+declare const routeDataKeyPrefix = "__convexRouteQuery:";
+type ConvexRouteQueryLoaderKey<Id extends string> = `${typeof routeDataKeyPrefix}${Id}`;
+type ConvexRouteQueryLoaderData<Id extends string, Query extends FunctionReference<"query">> = Record<ConvexRouteQueryLoaderKey<Id>, FunctionArgs<Query>>;
 type ConvexRouteQueryOptions<Query extends FunctionReference<"query">> = {
   queryKey: ["convexQuery", Query, FunctionArgs<Query>];
   staleTime: number;
 };
-type ConvexRouteQuery<Query extends FunctionReference<"query">> = {
+type ConvexRouteUseQueryOptions<Query extends FunctionReference<"query">, Data = FunctionReturnType<Query>> = Omit<UseQueryOptions<FunctionReturnType<Query>, Error, Data, ConvexRouteQueryOptions<Query>["queryKey"]>, "queryKey" | "queryFn" | "staleTime">;
+type ConvexRouteQuery<Query extends FunctionReference<"query">, Id extends string = string> = {
   options: (...args: OptionalRestArgs<Query>) => ConvexRouteQueryOptions<Query>;
   fetchQuery: (queryClient: ConvexRouteQueryClient<Query>, ...args: OptionalRestArgs<Query>) => Promise<FunctionReturnType<Query>>;
   prefetchQuery: (queryClient: ConvexRouteQueryClient<Query>, ...args: OptionalRestArgs<Query>) => Promise<void>;
+  fetchRoute: {
+    (routeContext: ConvexRouteQueryRouteContext<Query>): Promise<ConvexRouteQueryFetchRouteResult<Id, Query>>;
+    (routeContext: ConvexRouteQueryClientContext<Query>, ...args: OptionalRestArgs<Query>): Promise<ConvexRouteQueryFetchRouteResult<Id, Query>>;
+  };
+  prefetchRoute: {
+    (routeContext: ConvexRouteQueryRouteContext<Query>): Promise<ConvexRouteQueryLoaderData<Id, Query>>;
+    (routeContext: ConvexRouteQueryClientContext<Query>, ...args: OptionalRestArgs<Query>): Promise<ConvexRouteQueryLoaderData<Id, Query>>;
+  };
+  useQuery: <Data = FunctionReturnType<Query>>(...args: ArgsAndOptions<Query, ConvexRouteUseQueryOptions<Query, Data>>) => UseQueryResult<Data, Error>;
+  useSuspenseRouteQuery: (route: ConvexRouteQueryRoute<Id, Query>) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;
   useSuspenseQuery: (...args: OptionalRestArgs<Query>) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;
 };
 type ConvexRouteQueryClient<Query extends FunctionReference<"query">> = {
   fetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<unknown>;
   prefetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<void>;
 };
+type ConvexRouteQueryClientContext<Query extends FunctionReference<"query">> = {
+  context: {
+    queryClient: ConvexRouteQueryClient<Query>;
+  };
+};
+type ConvexRouteQueryRouteDeps<Query extends FunctionReference<"query">> = keyof FunctionArgs<Query> extends never ? {
+  deps?: FunctionArgs<Query>;
+} : {
+  deps: FunctionArgs<Query>;
+};
+type ConvexRouteQueryRouteContext<Query extends FunctionReference<"query">> = ConvexRouteQueryClientContext<Query> & ConvexRouteQueryRouteDeps<Query>;
+type ConvexRouteQueryFetchRouteResult<Id extends string, Query extends FunctionReference<"query">> = {
+  data: FunctionReturnType<Query>;
+  routeData: ConvexRouteQueryLoaderData<Id, Query>;
+};
+type ConvexRouteQueryRoute<Id extends string, Query extends FunctionReference<"query">> = {
+  useLoaderData: () => ConvexRouteQueryLoaderData<Id, Query>;
+};
 declare function createConvexRouteQuery<Query extends FunctionReference<"query">>(query: Query): ConvexRouteQuery<Query>;
+declare function createConvexRouteQuery<const Id extends string, Query extends FunctionReference<"query">>(id: Id, query: Query): ConvexRouteQuery<Query, Id>;
+declare function createConvexRouteQueries<const Queries extends Record<string, FunctionReference<"query">>>(queries: Queries): { [Id in keyof Queries & string]: ConvexRouteQuery<Queries[Id], Id> };
 //#endregion
-export { ConvexRouteQuery, ConvexRouteQueryClient, ConvexRouteQueryOptions, createConvexRouteQuery };
+export { ConvexRouteQuery, ConvexRouteQueryClient, ConvexRouteQueryClientContext, ConvexRouteQueryFetchRouteResult, ConvexRouteQueryLoaderData, ConvexRouteQueryLoaderKey, ConvexRouteQueryOptions, ConvexRouteQueryRoute, ConvexRouteQueryRouteContext, ConvexRouteUseQueryOptions, createConvexRouteQueries, createConvexRouteQuery };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;KAYY,uBAAA,eAAsC,iBAAA;EAE9C,QAAA,kBAA0B,KAAA,EAAO,YAAA,CAAa,KAAA;EAC9C,SAAA;AAAA;AAAA,KAGQ,gBAAA,eAA+B,iBAAA;EACzC,OAAA,MAAa,IAAA,EAAM,gBAAA,CAAiB,KAAA,MAAW,uBAAA,CAAwB,KAAA;EACvE,UAAA,GACE,WAAA,EAAa,sBAAA,CAAuB,KAAA,MACjC,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;EAChC,aAAA,GACE,WAAA,EAAa,sBAAA,CAAuB,KAAA,MACjC,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,OAAA;EACL,gBAAA,MACK,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,sBAAA,CAAuB,kBAAA,CAAmB,KAAA,GAAQ,KAAA;AAAA;AAAA,KAG7C,sBAAA,eAAqC,iBAAA;EAC/C,UAAA,GAAa,OAAA,EAAS,uBAAA,CAAwB,KAAA,MAAW,OAAA;EACzD,aAAA,GAAgB,OAAA,EAAS,uBAAA,CAAwB,KAAA,MAAW,OAAA;AAAA;AAAA,iBAQ9C,sBAAA,eACA,iBAAA,WACd,KAAA,EAAO,KAAA,GAAQ,gBAAA,CAAiB,KAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;cAiBM,kBAAA;AAAA,KAEM,yBAAA,gCACA,kBAAA,GAAqB,EAAE;AAAA,KAEvB,0BAAA,kCAEI,iBAAA,aACZ,MAAA,CAAO,yBAAA,CAA0B,EAAA,GAAK,YAAA,CAAa,KAAA;AAAA,KAE3C,uBAAA,eAAsC,iBAAA;EAE9C,QAAA,kBAA0B,KAAA,EAAO,YAAA,CAAa,KAAA;EAC9C,SAAA;AAAA;AAAA,KAGQ,0BAAA,eACI,iBAAA,kBACP,kBAAA,CAAmB,KAAA,KACxB,IAAA,CACF,eAAA,CACE,kBAAA,CAAmB,KAAA,GACnB,KAAA,EACA,IAAA,EACA,uBAAA,CAAwB,KAAA;AAAA,KAKhB,gBAAA,eACI,iBAAA;EAGd,OAAA,MAAa,IAAA,EAAM,gBAAA,CAAiB,KAAA,MAAW,uBAAA,CAAwB,KAAA;EACvE,UAAA,GACE,WAAA,EAAa,sBAAA,CAAuB,KAAA,MACjC,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;EAChC,aAAA,GACE,WAAA,EAAa,sBAAA,CAAuB,KAAA,MACjC,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,OAAA;EACL,UAAA;IAAA,CAEI,YAAA,EAAc,4BAAA,CAA6B,KAAA,IAC1C,OAAA,CAAQ,gCAAA,CAAiC,EAAA,EAAI,KAAA;IAAA,CAE9C,YAAA,EAAc,6BAAA,CAA8B,KAAA,MACzC,IAAA,EAAM,gBAAA,CAAiB,KAAA,IACzB,OAAA,CAAQ,gCAAA,CAAiC,EAAA,EAAI,KAAA;EAAA;EAElD,aAAA;IAAA,CAEI,YAAA,EAAc,4BAAA,CAA6B,KAAA,IAC1C,OAAA,CAAQ,0BAAA,CAA2B,EAAA,EAAI,KAAA;IAAA,CAExC,YAAA,EAAc,6BAAA,CAA8B,KAAA,MACzC,IAAA,EAAM,gBAAA,CAAiB,KAAA,IACzB,OAAA,CAAQ,0BAAA,CAA2B,EAAA,EAAI,KAAA;EAAA;EAE5C,QAAA,UAAkB,kBAAA,CAAmB,KAAA,MAChC,IAAA,EAAM,cAAA,CAAe,KAAA,EAAO,0BAAA,CAA2B,KAAA,EAAO,IAAA,OAC9D,cAAA,CAAe,IAAA,EAAM,KAAA;EAC1B,qBAAA,GACE,KAAA,EAAO,qBAAA,CAAsB,EAAA,EAAI,KAAA,MAC9B,sBAAA,CAAuB,kBAAA,CAAmB,KAAA,GAAQ,KAAA;EACvD,gBAAA,MACK,IAAA,EAAM,gBAAA,CAAiB,KAAA,MACvB,sBAAA,CAAuB,kBAAA,CAAmB,KAAA,GAAQ,KAAA;AAAA;AAAA,KAG7C,sBAAA,eAAqC,iBAAA;EAC/C,UAAA,GAAa,OAAA,EAAS,uBAAA,CAAwB,KAAA,MAAW,OAAA;EACzD,aAAA,GAAgB,OAAA,EAAS,uBAAA,CAAwB,KAAA,MAAW,OAAA;AAAA;AAAA,KAGlD,6BAAA,eACI,iBAAA;EAEd,OAAA;IACE,WAAA,EAAa,sBAAA,CAAuB,KAAA;EAAA;AAAA;AAAA,KAInC,yBAAA,eAAwC,iBAAA,mBACrC,YAAA,CAAa,KAAA;EAEb,IAAA,GAAO,YAAA,CAAa,KAAA;AAAA;EAGpB,IAAA,EAAM,YAAA,CAAa,KAAA;AAAA;AAAA,KAGf,4BAAA,eACI,iBAAA,aACZ,6BAAA,CAA8B,KAAA,IAAS,yBAAA,CAA0B,KAAA;AAAA,KAEzD,gCAAA,kCAEI,iBAAA;EAEd,IAAA,EAAM,kBAAA,CAAmB,KAAA;EACzB,SAAA,EAAW,0BAAA,CAA2B,EAAA,EAAI,KAAA;AAAA;AAAA,KAGhC,qBAAA,kCAEI,iBAAA;EAEd,aAAA,QAAqB,0BAAA,CAA2B,EAAA,EAAI,KAAA;AAAA;AAAA,iBAQtC,sBAAA,eACA,iBAAA,WACd,KAAA,EAAO,KAAA,GAAQ,gBAAA,CAAiB,KAAA;AAAA,iBAClB,sBAAA,wCAEA,iBAAA,WACd,EAAA,EAAI,EAAA,EAAI,KAAA,EAAO,KAAA,GAAQ,gBAAA,CAAiB,KAAA,EAAO,EAAA;AAAA,iBA0GjC,wBAAA,uBACQ,MAAA,SAAe,iBAAA,YAErC,OAAA,EAAS,OAAA,kBAEI,OAAA,YAAmB,gBAAA,CAAiB,OAAA,CAAQ,EAAA,GAAK,EAAA"}

package/dist/index.mjs

@@ -1,9 +1,20 @@
 import { convexQuery } from "@convex-dev/react-query";
-import { useSuspenseQuery } from "@tanstack/react-query";
+import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
+import { getFunctionName } from "convex/server";
 //#region src/index.ts
-function createConvexRouteQuery(query) {
+const routeDataKeyPrefix = "__convexRouteQuery:";
+function createConvexRouteQuery(idOrQuery, maybeQuery) {
+	const query = maybeQuery ?? idOrQuery;
+	const id = typeof idOrQuery === "string" ? idOrQuery : getFunctionName(idOrQuery);
+	const loaderDataKey = `${routeDataKeyPrefix}${id}`;
 	const createOptions = convexQuery;
 	const options = (...args) => createOptions(query, ...args);
+	const createLoaderData = (args) => Object.fromEntries([[loaderDataKey, args]]);
+	const getRouteArgs = (routeContext, args) => args.length > 0 ? args[0] : "deps" in routeContext && routeContext.deps !== void 0 ? routeContext.deps : {};
+	const getLoaderDataArgs = (loaderData) => {
+		if (typeof loaderData !== "object" || loaderData === null || !(loaderDataKey in loaderData)) throw new Error(`Missing convex-route-query loader data for "${String(id)}". Return the result of prefetchRoute(...) from this route's loader.`);
+		return loaderData[loaderDataKey];
+	};
 	return {
 		options,
 		fetchQuery(queryClient, ...args) {
@@ -12,12 +23,37 @@ function createConvexRouteQuery(query) {
 		prefetchQuery(queryClient, ...args) {
 			return queryClient.prefetchQuery(options(...args));
 		},
+		async fetchRoute(routeContext, ...args) {
+			const queryArgs = getRouteArgs(routeContext, args);
+			return {
+				data: await routeContext.context.queryClient.fetchQuery(options(...[queryArgs])),
+				routeData: createLoaderData(queryArgs)
+			};
+		},
+		async prefetchRoute(routeContext, ...args) {
+			const queryArgs = getRouteArgs(routeContext, args);
+			await routeContext.context.queryClient.prefetchQuery(options(...[queryArgs]));
+			return createLoaderData(queryArgs);
+		},
+		useQuery(...args) {
+			const [queryArgs, queryOptions] = args;
+			return useQuery({
+				...queryOptions,
+				...options(...[queryArgs])
+			});
+		},
+		useSuspenseRouteQuery(route) {
+			return useSuspenseQuery(options(...[getLoaderDataArgs(route.useLoaderData())]));
+		},
 		useSuspenseQuery(...args) {
 			return useSuspenseQuery(options(...args));
 		}
 	};
 }
+function createConvexRouteQueries(queries) {
+	return Object.fromEntries(Object.entries(queries).map(([id, query]) => [id, createConvexRouteQuery(id, query)]));
+}
 //#endregion
-export { createConvexRouteQuery };
+export { createConvexRouteQueries, createConvexRouteQuery };
 
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["useTanStackSuspenseQuery"],"sources":["../src/index.ts"],"sourcesContent":["import { convexQuery } from \"@convex-dev/react-query\";\nimport {\n  useSuspenseQuery as useTanStackSuspenseQuery,\n  type UseSuspenseQueryResult,\n} from \"@tanstack/react-query\";\nimport type {\n  FunctionArgs,\n  FunctionReference,\n  FunctionReturnType,\n  OptionalRestArgs,\n} from \"convex/server\";\n\nexport type ConvexRouteQueryOptions<Query extends FunctionReference<\"query\">> =\n  {\n    queryKey: [\"convexQuery\", Query, FunctionArgs<Query>];\n    staleTime: number;\n  };\n\nexport type ConvexRouteQuery<Query extends FunctionReference<\"query\">> = {\n  options: (...args: OptionalRestArgs<Query>) => ConvexRouteQueryOptions<Query>;\n  fetchQuery: (\n    queryClient: ConvexRouteQueryClient<Query>,\n    ...args: OptionalRestArgs<Query>\n  ) => Promise<FunctionReturnType<Query>>;\n  prefetchQuery: (\n    queryClient: ConvexRouteQueryClient<Query>,\n    ...args: OptionalRestArgs<Query>\n  ) => Promise<void>;\n  useSuspenseQuery: (\n    ...args: OptionalRestArgs<Query>\n  ) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;\n};\n\nexport type ConvexRouteQueryClient<Query extends FunctionReference<\"query\">> = {\n  fetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<unknown>;\n  prefetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<void>;\n};\n\ntype CreateConvexQueryOptions<Query extends FunctionReference<\"query\">> = (\n  query: Query,\n  ...args: OptionalRestArgs<Query>\n) => ConvexRouteQueryOptions<Query>;\n\nexport function createConvexRouteQuery<\n  Query extends FunctionReference<\"query\">,\n>(query: Query): ConvexRouteQuery<Query> {\n  const createOptions =\n    convexQuery as unknown as CreateConvexQueryOptions<Query>;\n  const options = (...args: OptionalRestArgs<Query>) =>\n    createOptions(query, ...args);\n\n  return {\n    options,\n    fetchQuery(queryClient, ...args) {\n      return queryClient.fetchQuery(options(...args)) as Promise<\n        FunctionReturnType<Query>\n      >;\n    },\n    prefetchQuery(queryClient, ...args) {\n      return queryClient.prefetchQuery(options(...args));\n    },\n    useSuspenseQuery(...args) {\n      return useTanStackSuspenseQuery(options(...args));\n    },\n  };\n}\n"],"mappings":";;;AA2CA,SAAgB,uBAEd,OAAuC;CACvC,MAAM,gBACJ;CACF,MAAM,WAAW,GAAG,SAClB,cAAc,OAAO,GAAG,IAAI;CAE9B,OAAO;EACL;EACA,WAAW,aAAa,GAAG,MAAM;GAC/B,OAAO,YAAY,WAAW,QAAQ,GAAG,IAAI,CAAC;EAGhD;EACA,cAAc,aAAa,GAAG,MAAM;GAClC,OAAO,YAAY,cAAc,QAAQ,GAAG,IAAI,CAAC;EACnD;EACA,iBAAiB,GAAG,MAAM;GACxB,OAAOA,iBAAyB,QAAQ,GAAG,IAAI,CAAC;EAClD;CACF;AACF"}
+{"version":3,"file":"index.mjs","names":["routeArgs","useTanStackQuery","useTanStackSuspenseQuery"],"sources":["../src/index.ts"],"sourcesContent":["import { convexQuery } from \"@convex-dev/react-query\";\nimport {\n  useQuery as useTanStackQuery,\n  useSuspenseQuery as useTanStackSuspenseQuery,\n  type UseQueryOptions,\n  type UseQueryResult,\n  type UseSuspenseQueryResult,\n} from \"@tanstack/react-query\";\nimport {\n  getFunctionName,\n  type ArgsAndOptions,\n  type FunctionArgs,\n  type FunctionReference,\n  type FunctionReturnType,\n  type OptionalRestArgs,\n} from \"convex/server\";\n\nconst routeDataKeyPrefix = \"__convexRouteQuery:\";\n\nexport type ConvexRouteQueryLoaderKey<Id extends string> =\n  `${typeof routeDataKeyPrefix}${Id}`;\n\nexport type ConvexRouteQueryLoaderData<\n  Id extends string,\n  Query extends FunctionReference<\"query\">,\n> = Record<ConvexRouteQueryLoaderKey<Id>, FunctionArgs<Query>>;\n\nexport type ConvexRouteQueryOptions<Query extends FunctionReference<\"query\">> =\n  {\n    queryKey: [\"convexQuery\", Query, FunctionArgs<Query>];\n    staleTime: number;\n  };\n\nexport type ConvexRouteUseQueryOptions<\n  Query extends FunctionReference<\"query\">,\n  Data = FunctionReturnType<Query>,\n> = Omit<\n  UseQueryOptions<\n    FunctionReturnType<Query>,\n    Error,\n    Data,\n    ConvexRouteQueryOptions<Query>[\"queryKey\"]\n  >,\n  \"queryKey\" | \"queryFn\" | \"staleTime\"\n>;\n\nexport type ConvexRouteQuery<\n  Query extends FunctionReference<\"query\">,\n  Id extends string = string,\n> = {\n  options: (...args: OptionalRestArgs<Query>) => ConvexRouteQueryOptions<Query>;\n  fetchQuery: (\n    queryClient: ConvexRouteQueryClient<Query>,\n    ...args: OptionalRestArgs<Query>\n  ) => Promise<FunctionReturnType<Query>>;\n  prefetchQuery: (\n    queryClient: ConvexRouteQueryClient<Query>,\n    ...args: OptionalRestArgs<Query>\n  ) => Promise<void>;\n  fetchRoute: {\n    (\n      routeContext: ConvexRouteQueryRouteContext<Query>,\n    ): Promise<ConvexRouteQueryFetchRouteResult<Id, Query>>;\n    (\n      routeContext: ConvexRouteQueryClientContext<Query>,\n      ...args: OptionalRestArgs<Query>\n    ): Promise<ConvexRouteQueryFetchRouteResult<Id, Query>>;\n  };\n  prefetchRoute: {\n    (\n      routeContext: ConvexRouteQueryRouteContext<Query>,\n    ): Promise<ConvexRouteQueryLoaderData<Id, Query>>;\n    (\n      routeContext: ConvexRouteQueryClientContext<Query>,\n      ...args: OptionalRestArgs<Query>\n    ): Promise<ConvexRouteQueryLoaderData<Id, Query>>;\n  };\n  useQuery: <Data = FunctionReturnType<Query>>(\n    ...args: ArgsAndOptions<Query, ConvexRouteUseQueryOptions<Query, Data>>\n  ) => UseQueryResult<Data, Error>;\n  useSuspenseRouteQuery: (\n    route: ConvexRouteQueryRoute<Id, Query>,\n  ) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;\n  useSuspenseQuery: (\n    ...args: OptionalRestArgs<Query>\n  ) => UseSuspenseQueryResult<FunctionReturnType<Query>, Error>;\n};\n\nexport type ConvexRouteQueryClient<Query extends FunctionReference<\"query\">> = {\n  fetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<unknown>;\n  prefetchQuery: (options: ConvexRouteQueryOptions<Query>) => Promise<void>;\n};\n\nexport type ConvexRouteQueryClientContext<\n  Query extends FunctionReference<\"query\">,\n> = {\n  context: {\n    queryClient: ConvexRouteQueryClient<Query>;\n  };\n};\n\ntype ConvexRouteQueryRouteDeps<Query extends FunctionReference<\"query\">> =\n  keyof FunctionArgs<Query> extends never\n    ? {\n        deps?: FunctionArgs<Query>;\n      }\n    : {\n        deps: FunctionArgs<Query>;\n      };\n\nexport type ConvexRouteQueryRouteContext<\n  Query extends FunctionReference<\"query\">,\n> = ConvexRouteQueryClientContext<Query> & ConvexRouteQueryRouteDeps<Query>;\n\nexport type ConvexRouteQueryFetchRouteResult<\n  Id extends string,\n  Query extends FunctionReference<\"query\">,\n> = {\n  data: FunctionReturnType<Query>;\n  routeData: ConvexRouteQueryLoaderData<Id, Query>;\n};\n\nexport type ConvexRouteQueryRoute<\n  Id extends string,\n  Query extends FunctionReference<\"query\">,\n> = {\n  useLoaderData: () => ConvexRouteQueryLoaderData<Id, Query>;\n};\n\ntype CreateConvexQueryOptions<Query extends FunctionReference<\"query\">> = (\n  query: Query,\n  ...args: OptionalRestArgs<Query>\n) => ConvexRouteQueryOptions<Query>;\n\nexport function createConvexRouteQuery<\n  Query extends FunctionReference<\"query\">,\n>(query: Query): ConvexRouteQuery<Query>;\nexport function createConvexRouteQuery<\n  const Id extends string,\n  Query extends FunctionReference<\"query\">,\n>(id: Id, query: Query): ConvexRouteQuery<Query, Id>;\nexport function createConvexRouteQuery<\n  const Id extends string,\n  Query extends FunctionReference<\"query\">,\n>(\n  idOrQuery: Id | Query,\n  maybeQuery?: Query,\n): ConvexRouteQuery<Query, Id | string> {\n  const query = (maybeQuery ?? idOrQuery) as Query;\n  const id =\n    typeof idOrQuery === \"string\"\n      ? idOrQuery\n      : getFunctionName(idOrQuery as Query);\n  const loaderDataKey =\n    `${routeDataKeyPrefix}${id}` as ConvexRouteQueryLoaderKey<Id | string>;\n  const createOptions =\n    convexQuery as unknown as CreateConvexQueryOptions<Query>;\n  const options = (...args: OptionalRestArgs<Query>) =>\n    createOptions(query, ...args);\n  const createLoaderData = (args: FunctionArgs<Query>) =>\n    Object.fromEntries([\n      [loaderDataKey, args],\n    ]) as unknown as ConvexRouteQueryLoaderData<Id | string, Query>;\n  const getRouteArgs = (\n    routeContext:\n      | ConvexRouteQueryClientContext<Query>\n      | ConvexRouteQueryRouteContext<Query>,\n    args: OptionalRestArgs<Query>,\n  ) =>\n    (args.length > 0\n      ? args[0]\n      : \"deps\" in routeContext && routeContext.deps !== undefined\n        ? routeContext.deps\n        : {}) as FunctionArgs<Query>;\n  const getLoaderDataArgs = (\n    loaderData: ConvexRouteQueryLoaderData<Id, Query>,\n  ) => {\n    if (\n      typeof loaderData !== \"object\" ||\n      loaderData === null ||\n      !(loaderDataKey in loaderData)\n    ) {\n      throw new Error(\n        `Missing convex-route-query loader data for \"${String(id)}\". Return the result of prefetchRoute(...) from this route's loader.`,\n      );\n    }\n\n    return loaderData[\n      loaderDataKey as keyof typeof loaderData\n    ] as FunctionArgs<Query>;\n  };\n\n  return {\n    options,\n    fetchQuery(queryClient, ...args) {\n      return queryClient.fetchQuery(options(...args)) as Promise<\n        FunctionReturnType<Query>\n      >;\n    },\n    prefetchQuery(queryClient, ...args) {\n      return queryClient.prefetchQuery(options(...args));\n    },\n    async fetchRoute(routeContext, ...args) {\n      const routeArgs = args as OptionalRestArgs<Query>;\n      const queryArgs = getRouteArgs(routeContext, routeArgs);\n      const data = await routeContext.context.queryClient.fetchQuery(\n        options(...([queryArgs] as OptionalRestArgs<Query>)),\n      );\n\n      return {\n        data: data as FunctionReturnType<Query>,\n        routeData: createLoaderData(queryArgs),\n      };\n    },\n    async prefetchRoute(routeContext, ...args) {\n      const routeArgs = args as OptionalRestArgs<Query>;\n      const queryArgs = getRouteArgs(routeContext, routeArgs);\n\n      await routeContext.context.queryClient.prefetchQuery(\n        options(...([queryArgs] as OptionalRestArgs<Query>)),\n      );\n\n      return createLoaderData(queryArgs);\n    },\n    useQuery(...args) {\n      const [queryArgs, queryOptions] = args;\n\n      return useTanStackQuery({\n        ...queryOptions,\n        ...options(...([queryArgs] as OptionalRestArgs<Query>)),\n      });\n    },\n    useSuspenseRouteQuery(route) {\n      const loaderData = route.useLoaderData();\n      const queryArgs = getLoaderDataArgs(loaderData);\n\n      return useTanStackSuspenseQuery(\n        options(...([queryArgs] as OptionalRestArgs<Query>)),\n      );\n    },\n    useSuspenseQuery(...args) {\n      return useTanStackSuspenseQuery(options(...args));\n    },\n  };\n}\n\nexport function createConvexRouteQueries<\n  const Queries extends Record<string, FunctionReference<\"query\">>,\n>(\n  queries: Queries,\n): {\n  [Id in keyof Queries & string]: ConvexRouteQuery<Queries[Id], Id>;\n} {\n  return Object.fromEntries(\n    Object.entries(queries).map(([id, query]) => [\n      id,\n      createConvexRouteQuery(id, query),\n    ]),\n  ) as unknown as {\n    [Id in keyof Queries & string]: ConvexRouteQuery<Queries[Id], Id>;\n  };\n}\n"],"mappings":";;;;AAiBA,MAAM,qBAAqB;AA4H3B,SAAgB,uBAId,WACA,YACsC;CACtC,MAAM,QAAS,cAAc;CAC7B,MAAM,KACJ,OAAO,cAAc,WACjB,YACA,gBAAgB,SAAkB;CACxC,MAAM,gBACJ,GAAG,qBAAqB;CAC1B,MAAM,gBACJ;CACF,MAAM,WAAW,GAAG,SAClB,cAAc,OAAO,GAAG,IAAI;CAC9B,MAAM,oBAAoB,SACxB,OAAO,YAAY,CACjB,CAAC,eAAe,IAAI,CACtB,CAAC;CACH,MAAM,gBACJ,cAGA,SAEC,KAAK,SAAS,IACX,KAAK,KACL,UAAU,gBAAgB,aAAa,SAAS,KAAA,IAC9C,aAAa,OACb,CAAC;CACT,MAAM,qBACJ,eACG;EACH,IACE,OAAO,eAAe,YACtB,eAAe,QACf,EAAE,iBAAiB,aAEnB,MAAM,IAAI,MACR,+CAA+C,OAAO,EAAE,EAAE,qEAC5D;EAGF,OAAO,WACL;CAEJ;CAEA,OAAO;EACL;EACA,WAAW,aAAa,GAAG,MAAM;GAC/B,OAAO,YAAY,WAAW,QAAQ,GAAG,IAAI,CAAC;EAGhD;EACA,cAAc,aAAa,GAAG,MAAM;GAClC,OAAO,YAAY,cAAc,QAAQ,GAAG,IAAI,CAAC;EACnD;EACA,MAAM,WAAW,cAAc,GAAG,MAAM;GAEtC,MAAM,YAAY,aAAa,cAAcA,IAAS;GAKtD,OAAO;IACL,MAAM,MALW,aAAa,QAAQ,YAAY,WAClD,QAAQ,GAAI,CAAC,SAAS,CAA6B,CACrD;IAIE,WAAW,iBAAiB,SAAS;GACvC;EACF;EACA,MAAM,cAAc,cAAc,GAAG,MAAM;GAEzC,MAAM,YAAY,aAAa,cAAcA,IAAS;GAEtD,MAAM,aAAa,QAAQ,YAAY,cACrC,QAAQ,GAAI,CAAC,SAAS,CAA6B,CACrD;GAEA,OAAO,iBAAiB,SAAS;EACnC;EACA,SAAS,GAAG,MAAM;GAChB,MAAM,CAAC,WAAW,gBAAgB;GAElC,OAAOC,SAAiB;IACtB,GAAG;IACH,GAAG,QAAQ,GAAI,CAAC,SAAS,CAA6B;GACxD,CAAC;EACH;EACA,sBAAsB,OAAO;GAI3B,OAAOC,iBACL,QAAQ,GAAI,CAHI,kBADC,MAAM,cACoB,CAGtB,CAAC,CAA6B,CACrD;EACF;EACA,iBAAiB,GAAG,MAAM;GACxB,OAAOA,iBAAyB,QAAQ,GAAG,IAAI,CAAC;EAClD;CACF;AACF;AAEA,SAAgB,yBAGd,SAGA;CACA,OAAO,OAAO,YACZ,OAAO,QAAQ,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,WAAW,CAC3C,IACA,uBAAuB,IAAI,KAAK,CAClC,CAAC,CACH;AAGF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "convex-route-query",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Type-safe Convex query helpers for TanStack Router loaders and React Query Suspense.",
   "type": "module",
   "sideEffects": false,
@@ -26,7 +26,8 @@
     "build": "concurrently --raw --names tsdown \"bun run build:tsdown\"",
     "build:tsdown": "tsdown",
     "ci": "bun run ci:test && bun run build && bun run lint:pkg",
-    "ci:test": "concurrently --raw --names runtime,types,xo \"bun run ci:test:runtime\" \"bun run ci:test:types\" \"bun run ci:test:xo\"",
+    "ci:test": "concurrently --raw --names runtime,types,e2e,xo \"bun run ci:test:runtime\" \"bun run ci:test:types\" \"bun run ci:test:e2e\" \"bun run ci:test:xo\"",
+    "ci:test:e2e": "bun run test:e2e:tanstack-start",
     "ci:test:runtime": "vitest run",
     "ci:test:types": "tsc --noEmit",
     "ci:test:xo": "xo",
@@ -37,7 +38,8 @@
     "lint:pkg:publint": "publint",
     "prepublishOnly": "bun run ci",
     "release": "bun run build && changeset publish",
-    "test": "concurrently --raw --names runtime,types,xo \"bun run test:runtime\" \"bun run test:types\" \"bun run test:xo\"",
+    "test": "concurrently --raw --names runtime,types,e2e,xo \"bun run test:runtime\" \"bun run test:types\" \"bun run test:e2e:tanstack-start\" \"bun run test:xo\"",
+    "test:e2e:tanstack-start": "tsc -p e2e/tanstack-start/tsconfig.json --noEmit",
     "test:runtime": "vitest run",
     "test:types": "tsc --noEmit",
     "test:xo": "xo",
@@ -63,7 +65,8 @@
     "url": "https://github.com/ludicroushq/convex-route-query/issues"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "engines": {
     "node": ">=20.0.0"
@@ -80,7 +83,11 @@
     "@changesets/cli": "^2.31.0",
     "@convex-dev/react-query": "^0.1.0",
     "@tanstack/react-query": "^5.101.0",
+    "@tanstack/react-router": "^1.170.17",
+    "@tanstack/react-start": "^1.168.27",
     "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^6.0.3",
     "concurrently": "^10.0.3",
     "convex": "^1.41.0",
     "expect-type": "^1.3.0",
@@ -88,9 +95,12 @@
     "prettier": "^3.8.4",
     "publint": "^0.3.21",
     "react": "^19.2.7",
+    "react-dom": "^19.2.7",
     "tsdown": "^0.22.2",
     "typescript": "^6.0.3",
+    "vite": "^8.1.4",
     "vitest": "^4.1.8",
-    "xo": "^2.0.2"
+    "xo": "^2.0.2",
+    "zod": "^4.4.3"
   }
 }