eden2query 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 eden2query contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,73 @@
1
+ # eden2query
2
+
3
+ Type-safe [Eden Treaty](https://elysiajs.com/eden/overview) to [React Query](https://tanstack.com/query) helpers. Two functions, zero runtime dependencies.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ bun add eden2query @elysiajs/eden @tanstack/react-query
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```ts
14
+ import { treaty } from "@elysiajs/eden";
15
+ import { treatyQueryOptions, treatyMutationOptions } from "eden2query";
16
+ import type { App } from "./server"; // your Elysia app type
17
+
18
+ const client = treaty<App>("localhost:3000");
19
+
20
+ // GET → queryOptions
21
+ const resourceQuery = treatyQueryOptions({
22
+ queryKey: ["resource"],
23
+ fn: client.api.resource.get,
24
+ });
25
+
26
+ // POST / PUT / DELETE → mutationOptions
27
+ const createResource = treatyMutationOptions({
28
+ fn: client.api.resource.post,
29
+ });
30
+
31
+ // Parameterised routes — bind params first
32
+ const updateResource = treatyMutationOptions({
33
+ fn: client.api.resource({ id: "some-id" }).put,
34
+ });
35
+ ```
36
+
37
+ Then use them with React Query as usual:
38
+
39
+ ```tsx
40
+ const { data } = useQuery(resourceQuery);
41
+ const mutation = useMutation(createResource);
42
+
43
+ mutation.mutate({ name: "New item" }); // fully typed input
44
+ ```
45
+
46
+ Works with `prefetchQuery`, `ensureQueryData`, `useSuspenseQuery`, etc.
47
+
48
+ You can also pass any standard React Query options alongside `fn`:
49
+
50
+ ```ts
51
+ const resourceQuery = treatyQueryOptions({
52
+ queryKey: ["resource"],
53
+ fn: client.api.resource.get,
54
+ refetchInterval: 1000,
55
+ });
56
+
57
+ const createResource = treatyMutationOptions({
58
+ fn: client.api.resource.post,
59
+ onSuccess: () => console.log("created!"),
60
+ });
61
+ ```
62
+
63
+ ## API
64
+
65
+ **`treatyQueryOptions({ queryKey, fn, ...queryOptions })`** — wraps an Eden GET function into `queryOptions`. Accepts all `queryOptions` fields except `queryFn`. Extracts `data` from the response and throws on `error`.
66
+
67
+ **`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.
68
+
69
+ Both infer data, error, and input types end-to-end from your Elysia route definitions. No manual generics needed.
70
+
71
+ ## License
72
+
73
+ MIT
@@ -0,0 +1,22 @@
1
+ import { Treaty } from "@elysiajs/eden";
2
+ import { mutationOptions, queryOptions } from "@tanstack/react-query";
3
+ type EdenFn<
4
+ I = any,
5
+ T extends Record<number, unknown> = Record<number, unknown>
6
+ > = (input: I) => Promise<Treaty.TreatyResponse<T>>;
7
+ declare function treatyMutationOptions<
8
+ T extends EdenFn,
9
+ P extends Parameters<T>,
10
+ R extends Awaited<ReturnType<T>>
11
+ >(params: {
12
+ fn: T;
13
+ } & Omit<Parameters<typeof mutationOptions<R["data"], R["error"], P[0]>>[0], "mutationFn">);
14
+ declare function treatyQueryOptions<
15
+ T extends EdenFn,
16
+ P extends Parameters<T>,
17
+ R extends Awaited<ReturnType<T>>
18
+ >(params: {
19
+ queryKey: string[];
20
+ fn: T;
21
+ } & Omit<Parameters<typeof queryOptions<R["data"], R["error"], P[0]>>[0], "queryFn">);
22
+ export { treatyQueryOptions, treatyMutationOptions };
package/dist/index.js ADDED
@@ -0,0 +1,34 @@
1
+ // src/lib.ts
2
+ import { mutationOptions, queryOptions } from "@tanstack/react-query";
3
+ function treatyMutationOptions(params) {
4
+ return mutationOptions({
5
+ mutationFn: async (variables) => {
6
+ const response = await params.fn(variables);
7
+ const { data, error } = response;
8
+ if (error) {
9
+ throw error;
10
+ }
11
+ return data;
12
+ },
13
+ ...params
14
+ });
15
+ }
16
+ function treatyQueryOptions(params) {
17
+ return queryOptions({
18
+ queryKey: params.queryKey,
19
+ queryFn: async (variables) => {
20
+ const { data, error } = await params.fn(variables);
21
+ if (error) {
22
+ throw error;
23
+ }
24
+ return data;
25
+ }
26
+ });
27
+ }
28
+ export {
29
+ treatyQueryOptions,
30
+ treatyMutationOptions
31
+ };
32
+
33
+ //# debugId=FB96D23A27CEDEEE64756E2164756E21
34
+ //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsic3JjXFxsaWIudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbCiAgICAiaW1wb3J0IHR5cGUgeyBUcmVhdHkgfSBmcm9tIFwiQGVseXNpYWpzL2VkZW5cIjtcclxuaW1wb3J0IHsgbXV0YXRpb25PcHRpb25zLCBxdWVyeU9wdGlvbnMsIHR5cGUgVXNlTXV0YXRpb25PcHRpb25zIH0gZnJvbSBcIkB0YW5zdGFjay9yZWFjdC1xdWVyeVwiO1xyXG5cclxudHlwZSBFZGVuRm48SSA9IGFueSwgVCBleHRlbmRzIFJlY29yZDxudW1iZXIsIHVua25vd24+ID0gUmVjb3JkPG51bWJlciwgdW5rbm93bj4+ID0gKGlucHV0OiBJKSA9PiBQcm9taXNlPFRyZWF0eS5UcmVhdHlSZXNwb25zZTxUPj47XHJcblxyXG5leHBvcnQgZnVuY3Rpb24gdHJlYXR5TXV0YXRpb25PcHRpb25zPFxyXG4gIFQgZXh0ZW5kcyBFZGVuRm4sXHJcbiAgUCBleHRlbmRzIFBhcmFtZXRlcnM8VD4sXHJcbiAgUiBleHRlbmRzIEF3YWl0ZWQ8UmV0dXJuVHlwZTxUPj5cclxuPihwYXJhbXM6IHtcclxuICBmbjogVCxcclxufSAmIE9taXQ8XHJcbiAgUGFyYW1ldGVyczx0eXBlb2YgbXV0YXRpb25PcHRpb25zPFJbXCJkYXRhXCJdLCBSW1wiZXJyb3JcIl0sIFBbMF0+PlswXSwgXHJcbiAgXCJtdXRhdGlvbkZuXCJcclxuPikge1xyXG4gIHJldHVybiBtdXRhdGlvbk9wdGlvbnM8UltcImRhdGFcIl0sIFJbXCJlcnJvclwiXSwgUFswXT4oe1xyXG4gICAgbXV0YXRpb25GbjogYXN5bmMgKHZhcmlhYmxlcykgPT4ge1xyXG4gICAgICBjb25zdCByZXNwb25zZSA9IGF3YWl0IHBhcmFtcy5mbih2YXJpYWJsZXMpO1xyXG4gICAgICBjb25zdCB7IGRhdGEsIGVycm9yIH0gPSByZXNwb25zZTtcclxuICAgICAgaWYgKGVycm9yKSB7XHJcbiAgICAgICAgdGhyb3cgZXJyb3I7XHJcbiAgICAgIH1cclxuICAgICAgcmV0dXJuIGRhdGE7XHJcbiAgICB9LFxyXG4gICAgLi4ucGFyYW1zLFxyXG4gIH0pO1xyXG59XHJcblxyXG5leHBvcnQgZnVuY3Rpb24gdHJlYXR5UXVlcnlPcHRpb25zPFxyXG4gIFQgZXh0ZW5kcyBFZGVuRm4sXHJcbiAgUCBleHRlbmRzIFBhcmFtZXRlcnM8VD4sXHJcbiAgUiBleHRlbmRzIEF3YWl0ZWQ8UmV0dXJuVHlwZTxUPj5cclxuPihwYXJhbXM6IHtcclxuICBxdWVyeUtleTogc3RyaW5nW107XHJcbiAgZm46IFRcclxufSAmIE9taXQ8XHJcbiAgUGFyYW1ldGVyczx0eXBlb2YgcXVlcnlPcHRpb25zPFJbXCJkYXRhXCJdLCBSW1wiZXJyb3JcIl0sIFBbMF0+PlswXSwgXHJcbiAgXCJxdWVyeUZuXCJcclxuPikge1xyXG4gIHJldHVybiBxdWVyeU9wdGlvbnM8UltcImRhdGFcIl0sIFJbXCJlcnJvclwiXSwgUFswXT4oe1xyXG4gICAgcXVlcnlLZXk6IHBhcmFtcy5xdWVyeUtleSxcclxuICAgIHF1ZXJ5Rm46IGFzeW5jICh2YXJpYWJsZXMpID0+IHtcclxuICAgICAgY29uc3QgeyBkYXRhLCBlcnJvciB9ID0gYXdhaXQgcGFyYW1zLmZuKHZhcmlhYmxlcyk7XHJcbiAgICAgIGlmIChlcnJvcikge1xyXG4gICAgICAgIHRocm93IGVycm9yO1xyXG4gICAgICB9XHJcbiAgICAgIHJldHVybiBkYXRhO1xyXG4gICAgfVxyXG4gIH0pO1xyXG59XHJcbiIKICBdLAogICJtYXBwaW5ncyI6ICI7QUFDQTtBQUlPLFNBQVMscUJBSWYsQ0FBQyxRQUtDO0FBQUEsRUFDRCxPQUFPLGdCQUE2QztBQUFBLElBQ2xELFlBQVksT0FBTyxjQUFjO0FBQUEsTUFDL0IsTUFBTSxXQUFXLE1BQU0sT0FBTyxHQUFHLFNBQVM7QUFBQSxNQUMxQyxRQUFRLE1BQU0sVUFBVTtBQUFBLE1BQ3hCLElBQUksT0FBTztBQUFBLFFBQ1QsTUFBTTtBQUFBLE1BQ1I7QUFBQSxNQUNBLE9BQU87QUFBQTtBQUFBLE9BRU47QUFBQSxFQUNMLENBQUM7QUFBQTtBQUdJLFNBQVMsa0JBSWYsQ0FBQyxRQU1DO0FBQUEsRUFDRCxPQUFPLGFBQTBDO0FBQUEsSUFDL0MsVUFBVSxPQUFPO0FBQUEsSUFDakIsU0FBUyxPQUFPLGNBQWM7QUFBQSxNQUM1QixRQUFRLE1BQU0sVUFBVSxNQUFNLE9BQU8sR0FBRyxTQUFTO0FBQUEsTUFDakQsSUFBSSxPQUFPO0FBQUEsUUFDVCxNQUFNO0FBQUEsTUFDUjtBQUFBLE1BQ0EsT0FBTztBQUFBO0FBQUEsRUFFWCxDQUFDO0FBQUE7IiwKICAiZGVidWdJZCI6ICJGQjk2RDIzQTI3Q0VERUVFNjQ3NTZFMjE2NDc1NkUyMSIsCiAgIm5hbWVzIjogW10KfQ==
package/package.json ADDED
@@ -0,0 +1,44 @@
1
+ {
2
+ "name": "eden2query",
3
+ "description": "Type-safe Eden Treaty to React Query helpers",
4
+ "version": "0.1.0",
5
+ "type": "module",
6
+ "files": [
7
+ "dist"
8
+ ],
9
+ "module": "./dist/index.js",
10
+ "types": "./dist/index.d.ts",
11
+ "exports": {
12
+ ".": {
13
+ "import": {
14
+ "types": "./dist/index.d.ts",
15
+ "default": "./dist/index.js"
16
+ }
17
+ },
18
+ "./package.json": "./package.json"
19
+ },
20
+ "license": "MIT",
21
+ "keywords": [
22
+ "elysia",
23
+ "eden",
24
+ "react-query",
25
+ "tanstack",
26
+ "typescript"
27
+ ],
28
+ "scripts": {
29
+ "build": "bunup",
30
+ "prepublishOnly": "bun run build"
31
+ },
32
+ "peerDependencies": {
33
+ "@elysiajs/eden": "^1.4.6",
34
+ "@tanstack/react-query": "^5.90.20",
35
+ "typescript": "^5"
36
+ },
37
+ "devDependencies": {
38
+ "@elysiajs/eden": "^1.4.6",
39
+ "@tanstack/react-query": "^5.90.20",
40
+ "@types/bun": "latest",
41
+ "bunup": "^0.16.22",
42
+ "elysia": "^1.4.22"
43
+ }
44
+ }