eden2query 0.1.1 → 0.2.0

package/README.md

@@ -12,26 +12,24 @@ bun add eden2query @elysiajs/eden @tanstack/react-query
 
 ```ts
 import { treaty } from "@elysiajs/eden";
-import { treatyQueryOptions, treatyMutationOptions } from "eden2query";
+import { edenQueryOptions, edenMutationOptions } from "eden2query";
 import type { App } from "./server"; // your Elysia app type
 
 const client = treaty<App>("localhost:3000");
 
-// GET → queryOptions (fn is a thunk that calls the Eden GET function)
-const resourceQuery = treatyQueryOptions({
-  queryKey: ["resource"],
-  fn: () => client.api.resource.get({ query: { q: "hello" } }),
-});
+// GET → queryOptions (first arg is a thunk that calls the Eden GET function)
+const resourceQuery = edenQueryOptions(
+  () => client.api.resource.get({ query: { q: "hello" } }),
+  { queryKey: ["resource"] },
+);
 
 // POST / PUT / DELETE → mutationOptions
-const createResource = treatyMutationOptions({
-  fn: client.api.resource.post,
-});
+const createResource = edenMutationOptions(client.api.resource.post);
 
 // Parameterised routes — bind params first
-const updateResource = treatyMutationOptions({
-  fn: client.api.resource({ id: "some-id" }).put,
-});
+const updateResource = edenMutationOptions(
+  client.api.resource({ id: "some-id" }).put,
+);
 ```
 
 Then use them with React Query as usual:
@@ -40,7 +38,7 @@ Then use them with React Query as usual:
 const { data } = useQuery(resourceQuery);
 const mutation = useMutation(createResource);
 
-mutation.mutate({ name: "New item" }); // fully typed input
+mutation.mutate({ body: { name: "New item" }, query: { q: "hello" } }); // fully typed input
 ```
 
 Works with `prefetchQuery`, `ensureQueryData`, `useSuspenseQuery`, etc:
@@ -50,28 +48,31 @@ const queryClient = new QueryClient();
 await queryClient.prefetchQuery(resourceQuery);
 ```
 
-You can also pass any standard React Query options alongside `fn`:
+You can also pass any standard React Query options as the second argument:
 
 ```ts
-const resourceQuery = treatyQueryOptions({
-  queryKey: ["resource"],
-  fn: () => client.api.resource.get({ query: { q: "hello" } }),
-  refetchInterval: 1000,
-});
-
-const createResource = treatyMutationOptions({
-  fn: client.api.resource.post,
-  onSuccess: () => console.log("created!"),
-});
+const resourceQuery = edenQueryOptions(
+  () => client.api.resource.get({ query: { q: "hello" } }),
+  { queryKey: ["resource"], refetchInterval: 1000 },
+);
+
+const createResource = edenMutationOptions(
+  client.api.resource.post,
+  { onSuccess: () => console.log("created!") },
+);
 ```
 
 ## API
 
-**`treatyQueryOptions({ queryKey, fn, ...queryOptions })`** — wraps an Eden GET call into `queryOptions`. `fn` is a **thunk** (zero-argument function) that calls the Eden GET function, e.g. `() => client.api.resource.get({ query: { ... } })`. This lets you bind query parameters, headers, or any other Eden options at definition time. Accepts all `queryOptions` fields except `queryFn`. Extracts `data` from the response and throws on `error`.
+**`edenQueryOptions(fn, queryOptions)`** — wraps an Eden GET call into `queryOptions`. `fn` is a **thunk** (zero-argument function) that calls the Eden GET function, e.g. `() => client.api.resource.get({ query: { ... } })`. This lets you bind query parameters, headers, or any other Eden options at definition time. The second argument accepts all `queryOptions` fields except `queryFn`. Extracts `data` from the response and throws on `error`.
 
-**`treatyMutationOptions({ fn, ...mutationOptions })`** — wraps an Eden mutation function into `mutationOptions`. Accepts all `mutationOptions` fields except `mutationFn` (e.g. `onSuccess`, `onSettled`, `onMutate`). The `mutate` call accepts the same input the Eden function expects.
+**`edenMutationOptions(fn, mutationOptions?)`** — wraps an Eden mutation function into `mutationOptions`. The optional second argument accepts all `mutationOptions` fields except `mutationFn` (e.g. `onSuccess`, `onSettled`, `onMutate`). The `mutate` call receives a single object with `body` and any other Eden options (like `query`) as the input.
 
-Both infer data, error, and input types end-to-end from your Elysia route definitions. No manual generics needed.
+**`InferQueryOptions<TFn>`** — extracts the full `UseQueryOptions` type for a given Eden GET thunk.
+
+**`InferMutationOptions<TFn>`** — extracts the full `UseMutationOptions` type for a given Eden mutation function.
+
+All helpers infer data, error, and input types end-to-end from your Elysia route definitions. No manual generics needed.
 
 ## License