@emeryld/rrroutes-client 1.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/README.md ADDED
@@ -0,0 +1,51 @@
1
+ # @emeryld/rrroutes-client
2
+
3
+ React Query helpers that sit on top of an RRRoutes contract. This package consumes finalized leaves from `@emeryld/rrroutes-contract` and produces typed fetch helpers (`useEndpoint`, `useInfinite`, `useMutation`, cache key utilities, etc.).
4
+
5
+ ## Installation
6
+
7
+ ```sh
8
+ pnpm add @emeryld/rrroutes-client @tanstack/react-query
9
+ # or
10
+ npm install @emeryld/rrroutes-client @tanstack/react-query
11
+ ```
12
+
13
+ The client already depends on `@emeryld/rrroutes-contract` and `zod`. You only need to provide React Query as a peer dependency.
14
+
15
+ ## Usage
16
+
17
+ ```ts
18
+ import { createRouteClient } from '@emeryld/rrroutes-client';
19
+ import { QueryClient } from '@tanstack/react-query';
20
+ import { registry } from '../routes';
21
+
22
+ const routeClient = createRouteClient({
23
+ queryClient: new QueryClient(),
24
+ baseUrl: '/api',
25
+ });
26
+
27
+ const listUsers = routeClient.build(registry.byKey['GET /v1/users']);
28
+
29
+ function Users() {
30
+ const { data, isLoading } = listUsers.useEndpoint({ query: { search: 'emery' } });
31
+ if (isLoading) return <p>Loading…</p>;
32
+ return <pre>{JSON.stringify(data)}</pre>;
33
+ }
34
+ ```
35
+
36
+ ## Scripts
37
+
38
+ ```sh
39
+ pnpm install
40
+ pnpm --filter @emeryld/rrroutes-client build
41
+ pnpm --filter @emeryld/rrroutes-client test
42
+ ```
43
+
44
+ ## Publishing
45
+
46
+ ```sh
47
+ cd packages/client
48
+ npm publish --access public
49
+ ```
50
+
51
+ Always bump `packages/client/package.json` before publishing so consumers can pick up the new release.
package/dist/index.cjs ADDED
@@ -0,0 +1,240 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
+
20
+ // src/index.ts
21
+ var index_exports = {};
22
+ __export(index_exports, {
23
+ createRouteClient: () => createRouteClient,
24
+ defaultFetcher: () => defaultFetcher
25
+ });
26
+ module.exports = __toCommonJS(index_exports);
27
+
28
+ // src/routesV3.client.fetch.ts
29
+ var logger = {
30
+ debug: (...args) => {
31
+ console.log("[routesV3.client.fetch]", ...args);
32
+ }
33
+ };
34
+ var defaultFetcher = async (req) => {
35
+ const headers = { ...req.headers ?? {} };
36
+ const isFormData = typeof FormData !== "undefined" && req.body instanceof FormData;
37
+ if (!isFormData) {
38
+ headers["Content-Type"] || (headers["Content-Type"] = "application/json");
39
+ headers["Accept"] || (headers["Accept"] = "application/json");
40
+ }
41
+ logger.debug("fetch", req.method, req.url, isFormData ? "FormData" : req.body);
42
+ const res = await fetch(req.url, {
43
+ method: req.method,
44
+ headers,
45
+ body: isFormData ? req.body : req.body == null ? void 0 : JSON.stringify(req.body)
46
+ });
47
+ const text = await res.text();
48
+ if (!res.ok) {
49
+ const snippet = text.slice(0, 400);
50
+ throw new Error(`[${res.status}] ${res.statusText} \u2014 ${snippet}`);
51
+ }
52
+ try {
53
+ return JSON.parse(text);
54
+ } catch {
55
+ return text;
56
+ }
57
+ };
58
+
59
+ // src/routesV3.client.index.ts
60
+ var import_react_query = require("@tanstack/react-query");
61
+ var import_rrroutes_contract = require("@emeryld/rrroutes-contract");
62
+ var toUpper = (m) => m.toUpperCase();
63
+ function zParse(value, schema) {
64
+ return schema ? schema.parse(value) : value;
65
+ }
66
+ function toSearchString(query) {
67
+ if (!query) return "";
68
+ const params = new URLSearchParams();
69
+ for (const [k, v] of Object.entries(query)) {
70
+ if (v == null) continue;
71
+ if (Array.isArray(v)) {
72
+ v.forEach((x) => {
73
+ if (x == null) return;
74
+ if (typeof x === "object") {
75
+ params.append(k, JSON.stringify(x));
76
+ } else {
77
+ params.append(k, String(x));
78
+ }
79
+ });
80
+ continue;
81
+ }
82
+ if (typeof v === "object") {
83
+ params.set(k, JSON.stringify(v));
84
+ continue;
85
+ }
86
+ params.set(k, String(v));
87
+ }
88
+ const s = params.toString();
89
+ return s ? `?${s}` : "";
90
+ }
91
+ function stripKey(obj, key) {
92
+ if (!obj) return obj;
93
+ const { [key]: _omit, ...rest } = obj;
94
+ return rest;
95
+ }
96
+ var defaultGetNextCursor = (p) => p && typeof p === "object" && "nextCursor" in p ? p.nextCursor : void 0;
97
+ function extractArgs(args) {
98
+ return args[0];
99
+ }
100
+ function buildUrl(leaf, baseUrl, params, query) {
101
+ const normalizedParams = zParse(params, leaf.cfg.paramsSchema);
102
+ const normalizedQuery = zParse(query, leaf.cfg.querySchema);
103
+ const path = (0, import_rrroutes_contract.compilePath)(leaf.path, normalizedParams ?? {});
104
+ const url = `${baseUrl ?? ""}${path}${toSearchString(normalizedQuery)}`;
105
+ return { url, normalizedQuery };
106
+ }
107
+ function createRouteClient(opts) {
108
+ const queryClient = opts.queryClient;
109
+ const fetcher = opts.fetcher ?? defaultFetcher;
110
+ const baseUrl = opts.baseUrl;
111
+ const cursorParam = opts.cursorParam ?? "cursor";
112
+ const getNextCursor = opts.getNextCursor ?? defaultGetNextCursor;
113
+ async function invalidate(prefix, exact = false) {
114
+ await queryClient.invalidateQueries({ queryKey: prefix, exact });
115
+ }
116
+ function buildInternal(leaf, rqOpts) {
117
+ const isGet = leaf.method === "get";
118
+ const isFeed = !!leaf.cfg.feed;
119
+ const key = (...tuple) => {
120
+ const a = extractArgs(tuple);
121
+ const params = a?.params;
122
+ const query = a?.query;
123
+ const qForKey = isGet && isFeed ? stripKey(query, cursorParam) : query;
124
+ return (0, import_rrroutes_contract.buildCacheKey)({ leaf, params, query: qForKey });
125
+ };
126
+ const invalidateExact = (...tuple) => queryClient.invalidateQueries({ queryKey: key(...tuple), exact: true });
127
+ const setData = (...args) => {
128
+ const [updater, ...rest] = args;
129
+ const k = key(...rest);
130
+ if (isGet && isFeed) {
131
+ queryClient.setQueryData(
132
+ k,
133
+ (prev) => typeof updater === "function" ? updater(prev) : updater
134
+ );
135
+ } else {
136
+ queryClient.setQueryData(
137
+ k,
138
+ (prev) => typeof updater === "function" ? updater(prev) : updater
139
+ );
140
+ }
141
+ };
142
+ if (isGet && isFeed) {
143
+ const useEndpoint2 = (...tuple) => {
144
+ const a = extractArgs(tuple);
145
+ const params = a?.params;
146
+ const query = a?.query;
147
+ const { normalizedQuery } = buildUrl(leaf, baseUrl, params, query);
148
+ return (0, import_react_query.useInfiniteQuery)({
149
+ ...rqOpts,
150
+ queryKey: key(...tuple),
151
+ initialPageParam: void 0,
152
+ getNextPageParam: (lastPage) => getNextCursor(lastPage),
153
+ placeholderData: import_react_query.keepPreviousData,
154
+ queryFn: async ({ pageParam }) => {
155
+ const pageQuery = {
156
+ ...normalizedQuery,
157
+ ...pageParam ? { [cursorParam]: pageParam } : {}
158
+ };
159
+ const { url } = buildUrl(leaf, baseUrl, params, pageQuery);
160
+ const out = await fetcher({ url, method: toUpper(leaf.method) });
161
+ return zParse(out, leaf.cfg.outputSchema);
162
+ }
163
+ // NOTE: TData is InfiniteData<T>, so we don't need a select here.
164
+ });
165
+ };
166
+ return {
167
+ key,
168
+ invalidate: invalidateExact,
169
+ setData,
170
+ useEndpoint: useEndpoint2
171
+ };
172
+ }
173
+ if (isGet) {
174
+ const useEndpoint2 = (...tuple) => {
175
+ const a = extractArgs(tuple);
176
+ const params = a?.params;
177
+ const query = a?.query;
178
+ const { url } = buildUrl(leaf, baseUrl, params, query);
179
+ return (0, import_react_query.useQuery)({
180
+ ...rqOpts,
181
+ queryKey: key(...tuple),
182
+ placeholderData: import_react_query.keepPreviousData,
183
+ queryFn: async () => {
184
+ const out = await fetcher({ url, method: toUpper(leaf.method) });
185
+ return zParse(out, leaf.cfg.outputSchema);
186
+ }
187
+ });
188
+ };
189
+ return {
190
+ key,
191
+ invalidate: invalidateExact,
192
+ setData,
193
+ useEndpoint: useEndpoint2
194
+ };
195
+ }
196
+ const useEndpoint = (...tuple) => {
197
+ const a = extractArgs(tuple);
198
+ const params = a?.params;
199
+ const query = a?.query;
200
+ const { url } = buildUrl(leaf, baseUrl, params, query);
201
+ return (0, import_react_query.useMutation)({
202
+ ...rqOpts,
203
+ mutationKey: key(...tuple),
204
+ mutationFn: async (body) => {
205
+ const normalizedBody = zParse(body, leaf.cfg.bodySchema);
206
+ const isMultipart = Array.isArray(leaf.cfg.bodyFiles) && leaf.cfg.bodyFiles.length > 0;
207
+ const payload = isMultipart ? toFormData(normalizedBody) : normalizedBody;
208
+ const out = await fetcher({ url, method: toUpper(leaf.method), body: payload });
209
+ return zParse(out, leaf.cfg.outputSchema);
210
+ }
211
+ });
212
+ };
213
+ return {
214
+ key,
215
+ invalidate: invalidateExact,
216
+ setData,
217
+ useEndpoint
218
+ };
219
+ }
220
+ return {
221
+ queryClient,
222
+ invalidate,
223
+ build: buildInternal
224
+ };
225
+ }
226
+ function toFormData(body) {
227
+ const fd = new FormData();
228
+ for (const [k, v] of Object.entries(body ?? {})) {
229
+ if (v == null) continue;
230
+ if (Array.isArray(v)) v.forEach((item, i) => fd.append(`${k}[${i}]`, item));
231
+ else fd.append(k, v);
232
+ }
233
+ return fd;
234
+ }
235
+ // Annotate the CommonJS export names for ESM import in node:
236
+ 0 && (module.exports = {
237
+ createRouteClient,
238
+ defaultFetcher
239
+ });
240
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/routesV3.client.fetch.ts","../src/routesV3.client.index.ts"],"sourcesContent":["export * from './routesV3.client.types';\nexport * from './routesV3.client.fetch';\nexport * from './routesV3.client.index';\n","// routesV3.client.fetch.ts\n\nimport { Fetcher, FetchInput } from './routesV3.client.types';\n\nconst logger = {\n debug: (...args: any[]) => {\n // Uncomment to enable debug logging\n console.log('[routesV3.client.fetch]', ...args);\n },\n};\n\n/**\n * Default fetch implementation used by the route client helper.\n * @param req Normalized request information (URL, method, body, headers).\n * @returns Parsed JSON (or text fallback) from the server response.\n */\nexport const defaultFetcher: Fetcher = async <T>(req: FetchInput): Promise<T> => {\n const headers: Record<string, string> = { ...(req.headers ?? {}) };\n const isFormData = typeof FormData !== 'undefined' && req.body instanceof FormData;\n if (!isFormData) {\n headers['Content-Type'] ||= 'application/json';\n headers['Accept'] ||= 'application/json';\n }\n\n logger.debug('fetch', req.method, req.url, isFormData ? 'FormData' : req.body);\n const res = await fetch(req.url, {\n method: req.method,\n headers,\n body: isFormData ? (req.body as any) : req.body == null ? undefined : JSON.stringify(req.body),\n });\n\n const text = await res.text();\n if (!res.ok) {\n const snippet = text.slice(0, 400);\n throw new Error(`[${res.status}] ${res.statusText} — ${snippet}`);\n }\n\n try {\n return JSON.parse(text) as T;\n } catch {\n return text as unknown as T;\n }\n};\n","// routesV3.client.ts\nimport {\n keepPreviousData,\n useInfiniteQuery,\n useMutation,\n useQuery,\n type InfiniteData,\n type QueryKey,\n} from '@tanstack/react-query';\nimport type { ZodType } from 'zod';\nimport {\n HttpMethod,\n buildCacheKey,\n compilePath,\n} from '@emeryld/rrroutes-contract';\nimport type {\n AnyLeaf,\n InferBody,\n InferOutput,\n InferParams,\n InferQuery,\n} from '@emeryld/rrroutes-contract';\nimport { defaultFetcher } from './routesV3.client.fetch';\nimport type {\n ArgsFor,\n ArgsTuple,\n BuiltForLeaf,\n BuiltInfinite,\n BuiltMutation,\n BuiltQuery,\n Cursor,\n DataShape,\n InfiniteBuildOptionsFor,\n MutationBuildOptionsFor,\n QueryBuildOptionsFor,\n RouteClient,\n RouteClientOptions,\n Updater,\n} from './routesV3.client.types';\n\n// -------------------------------------------------------------------------------------\n// Tiny helpers\n// -------------------------------------------------------------------------------------\n/**\n * Convert an HTTP method to uppercase (as expected by fetch).\n * @param m Lowercase HTTP method.\n * @returns Uppercase method string.\n */\nconst toUpper = (m: HttpMethod): Uppercase<HttpMethod> => m.toUpperCase() as Uppercase<HttpMethod>;\n\n/**\n * Parse the given value with the supplied schema (if present).\n * @param value Raw value to validate.\n * @param schema Optional Zod schema used for validation/coercion.\n * @returns The validated or original value.\n */\nfunction zParse<T>(value: unknown, schema?: ZodType): T {\n return schema ? (schema.parse(value) as T) : (value as T);\n}\n\n/**\n * Serialize a query object into a search string.\n * @param query Query params object (possibly undefined).\n * @returns Query string prefixed with `?`, or empty string.\n */\nfunction toSearchString(query: Record<string, unknown> | undefined) {\n if (!query) return '';\n const params = new URLSearchParams();\n for (const [k, v] of Object.entries(query)) {\n if (v == null) continue;\n if (Array.isArray(v)) {\n v.forEach((x) => {\n if (x == null) return;\n if (typeof x === 'object') {\n params.append(k, JSON.stringify(x));\n } else {\n params.append(k, String(x));\n }\n });\n continue;\n }\n if (typeof v === 'object') {\n params.set(k, JSON.stringify(v));\n continue;\n }\n params.set(k, String(v));\n }\n const s = params.toString();\n return s ? `?${s}` : '';\n}\n\n/**\n * Remove the given key from an object (used to drop cursors from cache keys).\n * @param obj Source object.\n * @param key Property name to omit.\n * @returns Copy of the object without the specified key.\n */\nfunction stripKey<Q extends Record<string, unknown> | undefined>(obj: Q, key: string): Q {\n if (!obj) return obj;\n const { [key]: _omit, ...rest } = obj as any;\n return rest as Q;\n}\n\n/**\n * Default cursor extractor used by infinite queries.\n * @param p Page result returned from the server.\n * @returns Next cursor string, if present.\n */\nconst defaultGetNextCursor = (p: unknown): Cursor =>\n p && typeof p === 'object' && 'nextCursor' in p ? (p as any).nextCursor : undefined;\n\n// Split the variadic tuple at runtime\n/**\n * Extract the optional argument object from a variadic tuple.\n * @param args Tuple passed to a built endpoint helper.\n * @returns The argument object if present.\n */\nfunction extractArgs<L extends AnyLeaf>(args: ArgsTuple<L>): ArgsFor<L> | undefined {\n // At runtime ArgsTuple<L> is either [] or [obj]; we just pick the first if present.\n return (args as unknown as any[])[0] as any;\n}\n\n/**\n * Normalize params and query values, then construct a request URL for the given leaf.\n * @param leaf Leaf describing the endpoint.\n * @param baseUrl Optional base URL prepended to the path.\n * @param params Route parameters supplied by the caller.\n * @param query Query parameters supplied by the caller.\n * @returns Object containing the composed URL and normalized query payload.\n */\nfunction buildUrl<L extends AnyLeaf>(\n leaf: L,\n baseUrl: string,\n params: InferParams<L> | undefined,\n query: InferQuery<L> | undefined,\n) {\n const normalizedParams = zParse<InferParams<L>>(params, leaf.cfg.paramsSchema);\n const normalizedQuery = zParse<InferQuery<L>>(query, leaf.cfg.querySchema);\n const path = compilePath<L['path']>(leaf.path, (normalizedParams ?? {}) as any);\n const url = `${baseUrl ?? ''}${path}${toSearchString(normalizedQuery as any)}`;\n return { url, normalizedQuery };\n}\n\n// -------------------------------------------------------------------------------------\n// Client factory\n// -------------------------------------------------------------------------------------\n/**\n * Construct typed React Query helpers backed by a routes-v3 registry leaf.\n * @param opts Route client configuration (query client, fetcher overrides, etc).\n * @returns Object that can build endpoint hooks/mutations from leaves.\n */\nexport function createRouteClient(opts: RouteClientOptions): RouteClient {\n const queryClient = opts.queryClient;\n const fetcher = opts.fetcher ?? defaultFetcher;\n const baseUrl = opts.baseUrl;\n const cursorParam = opts.cursorParam ?? 'cursor';\n const getNextCursor = opts.getNextCursor ?? defaultGetNextCursor;\n\n /**\n * Invalidate a set of queries sharing the given prefix.\n * @param prefix Key parts shared by matching endpoints.\n * @param exact When true, invalidate only exact key matches.\n */\n async function invalidate(prefix: string[], exact = false) {\n await queryClient.invalidateQueries({ queryKey: prefix as unknown as QueryKey, exact });\n }\n\n /**\n * Build the client surface for a single leaf (query/mutation/infinite query).\n * @param leaf Leaf describing the endpoint.\n * @param rqOpts Optional React Query configuration.\n * @returns Helper object exposing key/invalidate/setData/useEndpoint.\n */\n function buildInternal<L extends AnyLeaf>(\n leaf: L,\n rqOpts?: QueryBuildOptionsFor<L> | InfiniteBuildOptionsFor<L> | MutationBuildOptionsFor<L>,\n ): BuiltForLeaf<L> {\n const isGet = leaf.method === 'get';\n const isFeed = !!leaf.cfg.feed;\n\n // --- key/invalidate/setData shared helpers ---\n const key = (...tuple: ArgsTuple<L>): QueryKey => {\n const a = extractArgs<L>(tuple);\n const params = (a as any)?.params as InferParams<L> | undefined;\n const query = (a as any)?.query as InferQuery<L> | undefined;\n const qForKey = isGet && isFeed ? stripKey(query as any, cursorParam) : (query as any);\n return buildCacheKey({ leaf, params: params as any, query: qForKey }) as unknown as QueryKey;\n };\n\n /**\n * Invalidate the React Query cache for this exact leaf invocation.\n * @param tuple Optional params/query tuple.\n */\n const invalidateExact = (...tuple: ArgsTuple<L>) =>\n queryClient.invalidateQueries({ queryKey: key(...tuple), exact: true });\n\n /**\n * Update the cache entries for this leaf.\n * @param args Tuple whose first entry is the updater and optional params/query follow.\n */\n const setData = (...args: [Updater<DataShape<L>>, ...rest: ArgsTuple<L>]) => {\n const [updater, ...rest] = args;\n const k = key(...(rest as ArgsTuple<L>));\n if (isGet && isFeed) {\n queryClient.setQueryData<InfiniteData<InferOutput<L>> | undefined>(k, (prev) =>\n typeof updater === 'function' ? (updater as any)(prev) : (updater as any),\n );\n } else {\n queryClient.setQueryData<InferOutput<L> | undefined>(k, (prev) =>\n typeof updater === 'function' ? (updater as any)(prev) : (updater as any),\n );\n }\n };\n\n // --- Infinite GET ---\n if (isGet && isFeed) {\n const useEndpoint: BuiltInfinite<L>['useEndpoint'] = (...tuple) => {\n const a = extractArgs<L>(tuple);\n const params = (a as any)?.params as InferParams<L> | undefined;\n const query = (a as any)?.query as InferQuery<L> | undefined;\n\n // Normalize once; we’ll inject the cursor per page below.\n const { normalizedQuery } = buildUrl(leaf, baseUrl, params, query);\n return useInfiniteQuery<\n InferOutput<L>, // TQueryFnData (per page)\n unknown, // TError\n InfiniteData<InferOutput<L>>, // TData (returned by the hook)\n QueryKey,\n Cursor\n >({\n ...(rqOpts as InfiniteBuildOptionsFor<L>),\n queryKey: key(...tuple),\n initialPageParam: undefined,\n getNextPageParam: (lastPage) => getNextCursor(lastPage),\n placeholderData: keepPreviousData,\n queryFn: async ({ pageParam }) => {\n const pageQuery = {\n ...(normalizedQuery as any),\n ...(pageParam ? { [cursorParam]: pageParam } : {}),\n };\n const { url } = buildUrl(leaf, baseUrl, params, pageQuery);\n const out = await fetcher<unknown>({ url, method: toUpper(leaf.method) });\n return zParse<InferOutput<L>>(out, leaf.cfg.outputSchema);\n },\n // NOTE: TData is InfiniteData<T>, so we don't need a select here.\n });\n };\n\n return {\n key,\n invalidate: invalidateExact,\n setData: setData as any,\n useEndpoint,\n } as BuiltForLeaf<L>;\n }\n\n // --- Plain GET ---\n if (isGet) {\n const useEndpoint: BuiltQuery<L>['useEndpoint'] = (...tuple) => {\n const a = extractArgs<L>(tuple);\n const params = (a as any)?.params as InferParams<L> | undefined;\n const query = (a as any)?.query as InferQuery<L> | undefined;\n\n const { url } = buildUrl(leaf, baseUrl, params, query);\n return useQuery<InferOutput<L>, unknown, InferOutput<L>, QueryKey>({\n ...(rqOpts as QueryBuildOptionsFor<L>),\n queryKey: key(...tuple),\n placeholderData: keepPreviousData,\n queryFn: async () => {\n const out = await fetcher<unknown>({ url, method: toUpper(leaf.method) });\n return zParse<InferOutput<L>>(out, leaf.cfg.outputSchema);\n },\n });\n };\n\n return {\n key,\n invalidate: invalidateExact,\n setData: setData as any,\n useEndpoint,\n } as BuiltForLeaf<L>;\n }\n\n // --- Mutation (POST/PUT/PATCH/DELETE) ---\n const useEndpoint: BuiltMutation<L>['useEndpoint'] = (...tuple) => {\n const a = extractArgs<L>(tuple);\n const params = (a as any)?.params as InferParams<L> | undefined;\n const query = (a as any)?.query as InferQuery<L> | undefined;\n\n const { url } = buildUrl(leaf, baseUrl, params, query);\n return useMutation<InferOutput<L>, unknown, InferBody<L>, unknown>({\n ...(rqOpts as MutationBuildOptionsFor<L>),\n mutationKey: key(...tuple),\n mutationFn: async (body: InferBody<L>) => {\n const normalizedBody = zParse<InferBody<L>>(body, leaf.cfg.bodySchema);\n\n // Optional: switch to FormData if your method declares bodyFiles\n const isMultipart = Array.isArray(leaf.cfg.bodyFiles) && leaf.cfg.bodyFiles.length > 0;\n const payload = isMultipart ? toFormData(normalizedBody as any) : normalizedBody;\n\n const out = await fetcher<unknown>({ url, method: toUpper(leaf.method), body: payload });\n return zParse<InferOutput<L>>(out, leaf.cfg.outputSchema);\n },\n });\n };\n\n return {\n key,\n invalidate: invalidateExact,\n setData: setData as any,\n useEndpoint,\n } as BuiltForLeaf<L>;\n }\n\n return {\n queryClient,\n invalidate,\n build: buildInternal as RouteClient['build'],\n };\n}\n\n// -------------------------------------------------------------------------------------\n// Multipart helper\n// -------------------------------------------------------------------------------------\nfunction toFormData(body: Record<string, any>): FormData {\n const fd = new FormData();\n for (const [k, v] of Object.entries(body ?? {})) {\n if (v == null) continue;\n if (Array.isArray(v)) v.forEach((item, i) => fd.append(`${k}[${i}]`, item as any));\n else fd.append(k, v as any);\n }\n return fd;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACIA,IAAM,SAAS;AAAA,EACb,OAAO,IAAI,SAAgB;AAEzB,YAAQ,IAAI,2BAA2B,GAAG,IAAI;AAAA,EAChD;AACF;AAOO,IAAM,iBAA0B,OAAU,QAAgC;AAC/E,QAAM,UAAkC,EAAE,GAAI,IAAI,WAAW,CAAC,EAAG;AACjE,QAAM,aAAa,OAAO,aAAa,eAAe,IAAI,gBAAgB;AAC1E,MAAI,CAAC,YAAY;AACf,0DAA4B;AAC5B,8CAAsB;AAAA,EACxB;AAEA,SAAO,MAAM,SAAS,IAAI,QAAQ,IAAI,KAAK,aAAa,aAAa,IAAI,IAAI;AAC7E,QAAM,MAAM,MAAM,MAAM,IAAI,KAAK;AAAA,IAC/B,QAAQ,IAAI;AAAA,IACZ;AAAA,IACA,MAAM,aAAc,IAAI,OAAe,IAAI,QAAQ,OAAO,SAAY,KAAK,UAAU,IAAI,IAAI;AAAA,EAC/F,CAAC;AAED,QAAM,OAAO,MAAM,IAAI,KAAK;AAC5B,MAAI,CAAC,IAAI,IAAI;AACX,UAAM,UAAU,KAAK,MAAM,GAAG,GAAG;AACjC,UAAM,IAAI,MAAM,IAAI,IAAI,MAAM,KAAK,IAAI,UAAU,WAAM,OAAO,EAAE;AAAA,EAClE;AAEA,MAAI;AACF,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB,QAAQ;AACN,WAAO;AAAA,EACT;AACF;;;ACzCA,yBAOO;AAEP,+BAIO;AAkCP,IAAM,UAAU,CAAC,MAAyC,EAAE,YAAY;AAQxE,SAAS,OAAU,OAAgB,QAAqB;AACtD,SAAO,SAAU,OAAO,MAAM,KAAK,IAAW;AAChD;AAOA,SAAS,eAAe,OAA4C;AAClE,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,SAAS,IAAI,gBAAgB;AACnC,aAAW,CAAC,GAAG,CAAC,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1C,QAAI,KAAK,KAAM;AACf,QAAI,MAAM,QAAQ,CAAC,GAAG;AACpB,QAAE,QAAQ,CAAC,MAAM;AACf,YAAI,KAAK,KAAM;AACf,YAAI,OAAO,MAAM,UAAU;AACzB,iBAAO,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC;AAAA,QACpC,OAAO;AACL,iBAAO,OAAO,GAAG,OAAO,CAAC,CAAC;AAAA,QAC5B;AAAA,MACF,CAAC;AACD;AAAA,IACF;AACA,QAAI,OAAO,MAAM,UAAU;AACzB,aAAO,IAAI,GAAG,KAAK,UAAU,CAAC,CAAC;AAC/B;AAAA,IACF;AACA,WAAO,IAAI,GAAG,OAAO,CAAC,CAAC;AAAA,EACzB;AACA,QAAM,IAAI,OAAO,SAAS;AAC1B,SAAO,IAAI,IAAI,CAAC,KAAK;AACvB;AAQA,SAAS,SAAwD,KAAQ,KAAgB;AACvF,MAAI,CAAC,IAAK,QAAO;AACjB,QAAM,EAAE,CAAC,GAAG,GAAG,OAAO,GAAG,KAAK,IAAI;AAClC,SAAO;AACT;AAOA,IAAM,uBAAuB,CAAC,MAC5B,KAAK,OAAO,MAAM,YAAY,gBAAgB,IAAK,EAAU,aAAa;AAQ5E,SAAS,YAA+B,MAA4C;AAElF,SAAQ,KAA0B,CAAC;AACrC;AAUA,SAAS,SACP,MACA,SACA,QACA,OACA;AACA,QAAM,mBAAmB,OAAuB,QAAQ,KAAK,IAAI,YAAY;AAC7E,QAAM,kBAAkB,OAAsB,OAAO,KAAK,IAAI,WAAW;AACzE,QAAM,WAAO,sCAAuB,KAAK,MAAO,oBAAoB,CAAC,CAAS;AAC9E,QAAM,MAAM,GAAG,WAAW,EAAE,GAAG,IAAI,GAAG,eAAe,eAAsB,CAAC;AAC5E,SAAO,EAAE,KAAK,gBAAgB;AAChC;AAUO,SAAS,kBAAkB,MAAuC;AACvE,QAAM,cAAc,KAAK;AACzB,QAAM,UAAU,KAAK,WAAW;AAChC,QAAM,UAAU,KAAK;AACrB,QAAM,cAAc,KAAK,eAAe;AACxC,QAAM,gBAAgB,KAAK,iBAAiB;AAO5C,iBAAe,WAAW,QAAkB,QAAQ,OAAO;AACzD,UAAM,YAAY,kBAAkB,EAAE,UAAU,QAA+B,MAAM,CAAC;AAAA,EACxF;AAQA,WAAS,cACP,MACA,QACiB;AACjB,UAAM,QAAQ,KAAK,WAAW;AAC9B,UAAM,SAAS,CAAC,CAAC,KAAK,IAAI;AAG1B,UAAM,MAAM,IAAI,UAAkC;AAChD,YAAM,IAAI,YAAe,KAAK;AAC9B,YAAM,SAAU,GAAW;AAC3B,YAAM,QAAS,GAAW;AAC1B,YAAM,UAAU,SAAS,SAAS,SAAS,OAAc,WAAW,IAAK;AACzE,iBAAO,wCAAc,EAAE,MAAM,QAAuB,OAAO,QAAQ,CAAC;AAAA,IACtE;AAMA,UAAM,kBAAkB,IAAI,UAC1B,YAAY,kBAAkB,EAAE,UAAU,IAAI,GAAG,KAAK,GAAG,OAAO,KAAK,CAAC;AAMxE,UAAM,UAAU,IAAI,SAAyD;AAC3E,YAAM,CAAC,SAAS,GAAG,IAAI,IAAI;AAC3B,YAAM,IAAI,IAAI,GAAI,IAAqB;AACvC,UAAI,SAAS,QAAQ;AACnB,oBAAY;AAAA,UAAuD;AAAA,UAAG,CAAC,SACrE,OAAO,YAAY,aAAc,QAAgB,IAAI,IAAK;AAAA,QAC5D;AAAA,MACF,OAAO;AACL,oBAAY;AAAA,UAAyC;AAAA,UAAG,CAAC,SACvD,OAAO,YAAY,aAAc,QAAgB,IAAI,IAAK;AAAA,QAC5D;AAAA,MACF;AAAA,IACF;AAGA,QAAI,SAAS,QAAQ;AACnB,YAAMA,eAA+C,IAAI,UAAU;AACjE,cAAM,IAAI,YAAe,KAAK;AAC9B,cAAM,SAAU,GAAW;AAC3B,cAAM,QAAS,GAAW;AAG1B,cAAM,EAAE,gBAAgB,IAAI,SAAS,MAAM,SAAS,QAAQ,KAAK;AACjE,mBAAO,qCAML;AAAA,UACA,GAAI;AAAA,UACJ,UAAU,IAAI,GAAG,KAAK;AAAA,UACtB,kBAAkB;AAAA,UAClB,kBAAkB,CAAC,aAAa,cAAc,QAAQ;AAAA,UACtD,iBAAiB;AAAA,UACjB,SAAS,OAAO,EAAE,UAAU,MAAM;AAChC,kBAAM,YAAY;AAAA,cAChB,GAAI;AAAA,cACJ,GAAI,YAAY,EAAE,CAAC,WAAW,GAAG,UAAU,IAAI,CAAC;AAAA,YAClD;AACA,kBAAM,EAAE,IAAI,IAAI,SAAS,MAAM,SAAS,QAAQ,SAAS;AACzD,kBAAM,MAAM,MAAM,QAAiB,EAAE,KAAK,QAAQ,QAAQ,KAAK,MAAM,EAAE,CAAC;AACxE,mBAAO,OAAuB,KAAK,KAAK,IAAI,YAAY;AAAA,UAC1D;AAAA;AAAA,QAEF,CAAC;AAAA,MACH;AAEA,aAAO;AAAA,QACL;AAAA,QACA,YAAY;AAAA,QACZ;AAAA,QACA,aAAAA;AAAA,MACF;AAAA,IACF;AAGA,QAAI,OAAO;AACT,YAAMA,eAA4C,IAAI,UAAU;AAC9D,cAAM,IAAI,YAAe,KAAK;AAC9B,cAAM,SAAU,GAAW;AAC3B,cAAM,QAAS,GAAW;AAE1B,cAAM,EAAE,IAAI,IAAI,SAAS,MAAM,SAAS,QAAQ,KAAK;AACrD,mBAAO,6BAA4D;AAAA,UACjE,GAAI;AAAA,UACJ,UAAU,IAAI,GAAG,KAAK;AAAA,UACtB,iBAAiB;AAAA,UACjB,SAAS,YAAY;AACnB,kBAAM,MAAM,MAAM,QAAiB,EAAE,KAAK,QAAQ,QAAQ,KAAK,MAAM,EAAE,CAAC;AACxE,mBAAO,OAAuB,KAAK,KAAK,IAAI,YAAY;AAAA,UAC1D;AAAA,QACF,CAAC;AAAA,MACH;AAEA,aAAO;AAAA,QACL;AAAA,QACA,YAAY;AAAA,QACZ;AAAA,QACA,aAAAA;AAAA,MACF;AAAA,IACF;AAGA,UAAM,cAA+C,IAAI,UAAU;AACjE,YAAM,IAAI,YAAe,KAAK;AAC9B,YAAM,SAAU,GAAW;AAC3B,YAAM,QAAS,GAAW;AAE1B,YAAM,EAAE,IAAI,IAAI,SAAS,MAAM,SAAS,QAAQ,KAAK;AACrD,iBAAO,gCAA4D;AAAA,QACjE,GAAI;AAAA,QACJ,aAAa,IAAI,GAAG,KAAK;AAAA,QACzB,YAAY,OAAO,SAAuB;AACxC,gBAAM,iBAAiB,OAAqB,MAAM,KAAK,IAAI,UAAU;AAGrE,gBAAM,cAAc,MAAM,QAAQ,KAAK,IAAI,SAAS,KAAK,KAAK,IAAI,UAAU,SAAS;AACrF,gBAAM,UAAU,cAAc,WAAW,cAAqB,IAAI;AAElE,gBAAM,MAAM,MAAM,QAAiB,EAAE,KAAK,QAAQ,QAAQ,KAAK,MAAM,GAAG,MAAM,QAAQ,CAAC;AACvF,iBAAO,OAAuB,KAAK,KAAK,IAAI,YAAY;AAAA,QAC1D;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,MACL;AAAA,MACA,YAAY;AAAA,MACZ;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,OAAO;AAAA,EACT;AACF;AAKA,SAAS,WAAW,MAAqC;AACvD,QAAM,KAAK,IAAI,SAAS;AACxB,aAAW,CAAC,GAAG,CAAC,KAAK,OAAO,QAAQ,QAAQ,CAAC,CAAC,GAAG;AAC/C,QAAI,KAAK,KAAM;AACf,QAAI,MAAM,QAAQ,CAAC,EAAG,GAAE,QAAQ,CAAC,MAAM,MAAM,GAAG,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,IAAW,CAAC;AAAA,QAC5E,IAAG,OAAO,GAAG,CAAQ;AAAA,EAC5B;AACA,SAAO;AACT;","names":["useEndpoint"]}
@@ -0,0 +1,3 @@
1
+ export * from './routesV3.client.types';
2
+ export * from './routesV3.client.fetch';
3
+ export * from './routesV3.client.index';
package/dist/index.js ADDED
@@ -0,0 +1,220 @@
1
+ // src/routesV3.client.fetch.ts
2
+ var logger = {
3
+ debug: (...args) => {
4
+ console.log("[routesV3.client.fetch]", ...args);
5
+ }
6
+ };
7
+ var defaultFetcher = async (req) => {
8
+ const headers = { ...req.headers ?? {} };
9
+ const isFormData = typeof FormData !== "undefined" && req.body instanceof FormData;
10
+ if (!isFormData) {
11
+ headers["Content-Type"] || (headers["Content-Type"] = "application/json");
12
+ headers["Accept"] || (headers["Accept"] = "application/json");
13
+ }
14
+ logger.debug("fetch", req.method, req.url, isFormData ? "FormData" : req.body);
15
+ const res = await fetch(req.url, {
16
+ method: req.method,
17
+ headers,
18
+ body: isFormData ? req.body : req.body == null ? void 0 : JSON.stringify(req.body)
19
+ });
20
+ const text = await res.text();
21
+ if (!res.ok) {
22
+ const snippet = text.slice(0, 400);
23
+ throw new Error(`[${res.status}] ${res.statusText} \u2014 ${snippet}`);
24
+ }
25
+ try {
26
+ return JSON.parse(text);
27
+ } catch {
28
+ return text;
29
+ }
30
+ };
31
+
32
+ // src/routesV3.client.index.ts
33
+ import {
34
+ keepPreviousData,
35
+ useInfiniteQuery,
36
+ useMutation,
37
+ useQuery
38
+ } from "@tanstack/react-query";
39
+ import {
40
+ buildCacheKey,
41
+ compilePath
42
+ } from "@emeryld/rrroutes-contract";
43
+ var toUpper = (m) => m.toUpperCase();
44
+ function zParse(value, schema) {
45
+ return schema ? schema.parse(value) : value;
46
+ }
47
+ function toSearchString(query) {
48
+ if (!query) return "";
49
+ const params = new URLSearchParams();
50
+ for (const [k, v] of Object.entries(query)) {
51
+ if (v == null) continue;
52
+ if (Array.isArray(v)) {
53
+ v.forEach((x) => {
54
+ if (x == null) return;
55
+ if (typeof x === "object") {
56
+ params.append(k, JSON.stringify(x));
57
+ } else {
58
+ params.append(k, String(x));
59
+ }
60
+ });
61
+ continue;
62
+ }
63
+ if (typeof v === "object") {
64
+ params.set(k, JSON.stringify(v));
65
+ continue;
66
+ }
67
+ params.set(k, String(v));
68
+ }
69
+ const s = params.toString();
70
+ return s ? `?${s}` : "";
71
+ }
72
+ function stripKey(obj, key) {
73
+ if (!obj) return obj;
74
+ const { [key]: _omit, ...rest } = obj;
75
+ return rest;
76
+ }
77
+ var defaultGetNextCursor = (p) => p && typeof p === "object" && "nextCursor" in p ? p.nextCursor : void 0;
78
+ function extractArgs(args) {
79
+ return args[0];
80
+ }
81
+ function buildUrl(leaf, baseUrl, params, query) {
82
+ const normalizedParams = zParse(params, leaf.cfg.paramsSchema);
83
+ const normalizedQuery = zParse(query, leaf.cfg.querySchema);
84
+ const path = compilePath(leaf.path, normalizedParams ?? {});
85
+ const url = `${baseUrl ?? ""}${path}${toSearchString(normalizedQuery)}`;
86
+ return { url, normalizedQuery };
87
+ }
88
+ function createRouteClient(opts) {
89
+ const queryClient = opts.queryClient;
90
+ const fetcher = opts.fetcher ?? defaultFetcher;
91
+ const baseUrl = opts.baseUrl;
92
+ const cursorParam = opts.cursorParam ?? "cursor";
93
+ const getNextCursor = opts.getNextCursor ?? defaultGetNextCursor;
94
+ async function invalidate(prefix, exact = false) {
95
+ await queryClient.invalidateQueries({ queryKey: prefix, exact });
96
+ }
97
+ function buildInternal(leaf, rqOpts) {
98
+ const isGet = leaf.method === "get";
99
+ const isFeed = !!leaf.cfg.feed;
100
+ const key = (...tuple) => {
101
+ const a = extractArgs(tuple);
102
+ const params = a?.params;
103
+ const query = a?.query;
104
+ const qForKey = isGet && isFeed ? stripKey(query, cursorParam) : query;
105
+ return buildCacheKey({ leaf, params, query: qForKey });
106
+ };
107
+ const invalidateExact = (...tuple) => queryClient.invalidateQueries({ queryKey: key(...tuple), exact: true });
108
+ const setData = (...args) => {
109
+ const [updater, ...rest] = args;
110
+ const k = key(...rest);
111
+ if (isGet && isFeed) {
112
+ queryClient.setQueryData(
113
+ k,
114
+ (prev) => typeof updater === "function" ? updater(prev) : updater
115
+ );
116
+ } else {
117
+ queryClient.setQueryData(
118
+ k,
119
+ (prev) => typeof updater === "function" ? updater(prev) : updater
120
+ );
121
+ }
122
+ };
123
+ if (isGet && isFeed) {
124
+ const useEndpoint2 = (...tuple) => {
125
+ const a = extractArgs(tuple);
126
+ const params = a?.params;
127
+ const query = a?.query;
128
+ const { normalizedQuery } = buildUrl(leaf, baseUrl, params, query);
129
+ return useInfiniteQuery({
130
+ ...rqOpts,
131
+ queryKey: key(...tuple),
132
+ initialPageParam: void 0,
133
+ getNextPageParam: (lastPage) => getNextCursor(lastPage),
134
+ placeholderData: keepPreviousData,
135
+ queryFn: async ({ pageParam }) => {
136
+ const pageQuery = {
137
+ ...normalizedQuery,
138
+ ...pageParam ? { [cursorParam]: pageParam } : {}
139
+ };
140
+ const { url } = buildUrl(leaf, baseUrl, params, pageQuery);
141
+ const out = await fetcher({ url, method: toUpper(leaf.method) });
142
+ return zParse(out, leaf.cfg.outputSchema);
143
+ }
144
+ // NOTE: TData is InfiniteData<T>, so we don't need a select here.
145
+ });
146
+ };
147
+ return {
148
+ key,
149
+ invalidate: invalidateExact,
150
+ setData,
151
+ useEndpoint: useEndpoint2
152
+ };
153
+ }
154
+ if (isGet) {
155
+ const useEndpoint2 = (...tuple) => {
156
+ const a = extractArgs(tuple);
157
+ const params = a?.params;
158
+ const query = a?.query;
159
+ const { url } = buildUrl(leaf, baseUrl, params, query);
160
+ return useQuery({
161
+ ...rqOpts,
162
+ queryKey: key(...tuple),
163
+ placeholderData: keepPreviousData,
164
+ queryFn: async () => {
165
+ const out = await fetcher({ url, method: toUpper(leaf.method) });
166
+ return zParse(out, leaf.cfg.outputSchema);
167
+ }
168
+ });
169
+ };
170
+ return {
171
+ key,
172
+ invalidate: invalidateExact,
173
+ setData,
174
+ useEndpoint: useEndpoint2
175
+ };
176
+ }
177
+ const useEndpoint = (...tuple) => {
178
+ const a = extractArgs(tuple);
179
+ const params = a?.params;
180
+ const query = a?.query;
181
+ const { url } = buildUrl(leaf, baseUrl, params, query);
182
+ return useMutation({
183
+ ...rqOpts,
184
+ mutationKey: key(...tuple),
185
+ mutationFn: async (body) => {
186
+ const normalizedBody = zParse(body, leaf.cfg.bodySchema);
187
+ const isMultipart = Array.isArray(leaf.cfg.bodyFiles) && leaf.cfg.bodyFiles.length > 0;
188
+ const payload = isMultipart ? toFormData(normalizedBody) : normalizedBody;
189
+ const out = await fetcher({ url, method: toUpper(leaf.method), body: payload });
190
+ return zParse(out, leaf.cfg.outputSchema);
191
+ }
192
+ });
193
+ };
194
+ return {
195
+ key,
196
+ invalidate: invalidateExact,
197
+ setData,
198
+ useEndpoint
199
+ };
200
+ }
201
+ return {
202
+ queryClient,
203
+ invalidate,
204
+ build: buildInternal
205
+ };
206
+ }
207
+ function toFormData(body) {
208
+ const fd = new FormData();
209
+ for (const [k, v] of Object.entries(body ?? {})) {
210
+ if (v == null) continue;
211
+ if (Array.isArray(v)) v.forEach((item, i) => fd.append(`${k}[${i}]`, item));
212
+ else fd.append(k, v);
213
+ }
214
+ return fd;
215
+ }
216
+ export {
217
+ createRouteClient,
218
+ defaultFetcher
219
+ };
220
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/routesV3.client.fetch.ts","../src/routesV3.client.index.ts"],"sourcesContent":["// routesV3.client.fetch.ts\n\nimport { Fetcher, FetchInput } from './routesV3.client.types';\n\nconst logger = {\n debug: (...args: any[]) => {\n // Uncomment to enable debug logging\n console.log('[routesV3.client.fetch]', ...args);\n },\n};\n\n/**\n * Default fetch implementation used by the route client helper.\n * @param req Normalized request information (URL, method, body, headers).\n * @returns Parsed JSON (or text fallback) from the server response.\n */\nexport const defaultFetcher: Fetcher = async <T>(req: FetchInput): Promise<T> => {\n const headers: Record<string, string> = { ...(req.headers ?? {}) };\n const isFormData = typeof FormData !== 'undefined' && req.body instanceof FormData;\n if (!isFormData) {\n headers['Content-Type'] ||= 'application/json';\n headers['Accept'] ||= 'application/json';\n }\n\n logger.debug('fetch', req.method, req.url, isFormData ? 'FormData' : req.body);\n const res = await fetch(req.url, {\n method: req.method,\n headers,\n body: isFormData ? (req.body as any) : req.body == null ? undefined : JSON.stringify(req.body),\n });\n\n const text = await res.text();\n if (!res.ok) {\n const snippet = text.slice(0, 400);\n throw new Error(`[${res.status}] ${res.statusText} — ${snippet}`);\n }\n\n try {\n return JSON.parse(text) as T;\n } catch {\n return text as unknown as T;\n }\n};\n","// routesV3.client.ts\nimport {\n keepPreviousData,\n useInfiniteQuery,\n useMutation,\n useQuery,\n type InfiniteData,\n type QueryKey,\n} from '@tanstack/react-query';\nimport type { ZodType } from 'zod';\nimport {\n HttpMethod,\n buildCacheKey,\n compilePath,\n} from '@emeryld/rrroutes-contract';\nimport type {\n AnyLeaf,\n InferBody,\n InferOutput,\n InferParams,\n InferQuery,\n} from '@emeryld/rrroutes-contract';\nimport { defaultFetcher } from './routesV3.client.fetch';\nimport type {\n ArgsFor,\n ArgsTuple,\n BuiltForLeaf,\n BuiltInfinite,\n BuiltMutation,\n BuiltQuery,\n Cursor,\n DataShape,\n InfiniteBuildOptionsFor,\n MutationBuildOptionsFor,\n QueryBuildOptionsFor,\n RouteClient,\n RouteClientOptions,\n Updater,\n} from './routesV3.client.types';\n\n// -------------------------------------------------------------------------------------\n// Tiny helpers\n// -------------------------------------------------------------------------------------\n/**\n * Convert an HTTP method to uppercase (as expected by fetch).\n * @param m Lowercase HTTP method.\n * @returns Uppercase method string.\n */\nconst toUpper = (m: HttpMethod): Uppercase<HttpMethod> => m.toUpperCase() as Uppercase<HttpMethod>;\n\n/**\n * Parse the given value with the supplied schema (if present).\n * @param value Raw value to validate.\n * @param schema Optional Zod schema used for validation/coercion.\n * @returns The validated or original value.\n */\nfunction zParse<T>(value: unknown, schema?: ZodType): T {\n return schema ? (schema.parse(value) as T) : (value as T);\n}\n\n/**\n * Serialize a query object into a search string.\n * @param query Query params object (possibly undefined).\n * @returns Query string prefixed with `?`, or empty string.\n */\nfunction toSearchString(query: Record<string, unknown> | undefined) {\n if (!query) return '';\n const params = new URLSearchParams();\n for (const [k, v] of Object.entries(query)) {\n if (v == null) continue;\n if (Array.isArray(v)) {\n v.forEach((x) => {\n if (x == null) return;\n if (typeof x === 'object') {\n params.append(k, JSON.stringify(x));\n } else {\n params.append(k, String(x));\n }\n });\n continue;\n }\n if (typeof v === 'object') {\n params.set(k, JSON.stringify(v));\n continue;\n }\n params.set(k, String(v));\n }\n const s = params.toString();\n return s ? `?${s}` : '';\n}\n\n/**\n * Remove the given key from an object (used to drop cursors from cache keys).\n * @param obj Source object.\n * @param key Property name to omit.\n * @returns Copy of the object without the specified key.\n */\nfunction stripKey<Q extends Record<string, unknown> | undefined>(obj: Q, key: string): Q {\n if (!obj) return obj;\n const { [key]: _omit, ...rest } = obj as any;\n return rest as Q;\n}\n\n/**\n * Default cursor extractor used by infinite queries.\n * @param p Page result returned from the server.\n * @returns Next cursor string, if present.\n */\nconst defaultGetNextCursor = (p: unknown): Cursor =>\n p && typeof p === 'object' && 'nextCursor' in p ? (p as any).nextCursor : undefined;\n\n// Split the variadic tuple at runtime\n/**\n * Extract the optional argument object from a variadic tuple.\n * @param args Tuple passed to a built endpoint helper.\n * @returns The argument object if present.\n */\nfunction extractArgs<L extends AnyLeaf>(args: ArgsTuple<L>): ArgsFor<L> | undefined {\n // At runtime ArgsTuple<L> is either [] or [obj]; we just pick the first if present.\n return (args as unknown as any[])[0] as any;\n}\n\n/**\n * Normalize params and query values, then construct a request URL for the given leaf.\n * @param leaf Leaf describing the endpoint.\n * @param baseUrl Optional base URL prepended to the path.\n * @param params Route parameters supplied by the caller.\n * @param query Query parameters supplied by the caller.\n * @returns Object containing the composed URL and normalized query payload.\n */\nfunction buildUrl<L extends AnyLeaf>(\n leaf: L,\n baseUrl: string,\n params: InferParams<L> | undefined,\n query: InferQuery<L> | undefined,\n) {\n const normalizedParams = zParse<InferParams<L>>(params, leaf.cfg.paramsSchema);\n const normalizedQuery = zParse<InferQuery<L>>(query, leaf.cfg.querySchema);\n const path = compilePath<L['path']>(leaf.path, (normalizedParams ?? {}) as any);\n const url = `${baseUrl ?? ''}${path}${toSearchString(normalizedQuery as any)}`;\n return { url, normalizedQuery };\n}\n\n// -------------------------------------------------------------------------------------\n// Client factory\n// -------------------------------------------------------------------------------------\n/**\n * Construct typed React Query helpers backed by a routes-v3 registry leaf.\n * @param opts Route client configuration (query client, fetcher overrides, etc).\n * @returns Object that can build endpoint hooks/mutations from leaves.\n */\nexport function createRouteClient(opts: RouteClientOptions): RouteClient {\n const queryClient = opts.queryClient;\n const fetcher = opts.fetcher ?? defaultFetcher;\n const baseUrl = opts.baseUrl;\n const cursorParam = opts.cursorParam ?? 'cursor';\n const getNextCursor = opts.getNextCursor ?? defaultGetNextCursor;\n\n /**\n * Invalidate a set of queries sharing the given prefix.\n * @param prefix Key parts shared by matching endpoints.\n * @param exact When true, invalidate only exact key matches.\n */\n async function invalidate(prefix: string[], exact = false) {\n await queryClient.invalidateQueries({ queryKey: prefix as unknown as QueryKey, exact });\n }\n\n /**\n * Build the client surface for a single leaf (query/mutation/infinite query).\n * @param leaf Leaf describing the endpoint.\n * @param rqOpts Optional React Query configuration.\n * @returns Helper object exposing key/invalidate/setData/useEndpoint.\n */\n function buildInternal<L extends AnyLeaf>(\n leaf: L,\n rqOpts?: QueryBuildOptionsFor<L> | InfiniteBuildOptionsFor<L> | MutationBuildOptionsFor<L>,\n ): BuiltForLeaf<L> {\n const isGet = leaf.method === 'get';\n const isFeed = !!leaf.cfg.feed;\n\n // --- key/invalidate/setData shared helpers ---\n const key = (...tuple: ArgsTuple<L>): QueryKey => {\n const a = extractArgs<L>(tuple);\n const params = (a as any)?.params as InferParams<L> | undefined;\n const query = (a as any)?.query as InferQuery<L> | undefined;\n const qForKey = isGet && isFeed ? stripKey(query as any, cursorParam) : (query as any);\n return buildCacheKey({ leaf, params: params as any, query: qForKey }) as unknown as QueryKey;\n };\n\n /**\n * Invalidate the React Query cache for this exact leaf invocation.\n * @param tuple Optional params/query tuple.\n */\n const invalidateExact = (...tuple: ArgsTuple<L>) =>\n queryClient.invalidateQueries({ queryKey: key(...tuple), exact: true });\n\n /**\n * Update the cache entries for this leaf.\n * @param args Tuple whose first entry is the updater and optional params/query follow.\n */\n const setData = (...args: [Updater<DataShape<L>>, ...rest: ArgsTuple<L>]) => {\n const [updater, ...rest] = args;\n const k = key(...(rest as ArgsTuple<L>));\n if (isGet && isFeed) {\n queryClient.setQueryData<InfiniteData<InferOutput<L>> | undefined>(k, (prev) =>\n typeof updater === 'function' ? (updater as any)(prev) : (updater as any),\n );\n } else {\n queryClient.setQueryData<InferOutput<L> | undefined>(k, (prev) =>\n typeof updater === 'function' ? (updater as any)(prev) : (updater as any),\n );\n }\n };\n\n // --- Infinite GET ---\n if (isGet && isFeed) {\n const useEndpoint: BuiltInfinite<L>['useEndpoint'] = (...tuple) => {\n const a = extractArgs<L>(tuple);\n const params = (a as any)?.params as InferParams<L> | undefined;\n const query = (a as any)?.query as InferQuery<L> | undefined;\n\n // Normalize once; we’ll inject the cursor per page below.\n const { normalizedQuery } = buildUrl(leaf, baseUrl, params, query);\n return useInfiniteQuery<\n InferOutput<L>, // TQueryFnData (per page)\n unknown, // TError\n InfiniteData<InferOutput<L>>, // TData (returned by the hook)\n QueryKey,\n Cursor\n >({\n ...(rqOpts as InfiniteBuildOptionsFor<L>),\n queryKey: key(...tuple),\n initialPageParam: undefined,\n getNextPageParam: (lastPage) => getNextCursor(lastPage),\n placeholderData: keepPreviousData,\n queryFn: async ({ pageParam }) => {\n const pageQuery = {\n ...(normalizedQuery as any),\n ...(pageParam ? { [cursorParam]: pageParam } : {}),\n };\n const { url } = buildUrl(leaf, baseUrl, params, pageQuery);\n const out = await fetcher<unknown>({ url, method: toUpper(leaf.method) });\n return zParse<InferOutput<L>>(out, leaf.cfg.outputSchema);\n },\n // NOTE: TData is InfiniteData<T>, so we don't need a select here.\n });\n };\n\n return {\n key,\n invalidate: invalidateExact,\n setData: setData as any,\n useEndpoint,\n } as BuiltForLeaf<L>;\n }\n\n // --- Plain GET ---\n if (isGet) {\n const useEndpoint: BuiltQuery<L>['useEndpoint'] = (...tuple) => {\n const a = extractArgs<L>(tuple);\n const params = (a as any)?.params as InferParams<L> | undefined;\n const query = (a as any)?.query as InferQuery<L> | undefined;\n\n const { url } = buildUrl(leaf, baseUrl, params, query);\n return useQuery<InferOutput<L>, unknown, InferOutput<L>, QueryKey>({\n ...(rqOpts as QueryBuildOptionsFor<L>),\n queryKey: key(...tuple),\n placeholderData: keepPreviousData,\n queryFn: async () => {\n const out = await fetcher<unknown>({ url, method: toUpper(leaf.method) });\n return zParse<InferOutput<L>>(out, leaf.cfg.outputSchema);\n },\n });\n };\n\n return {\n key,\n invalidate: invalidateExact,\n setData: setData as any,\n useEndpoint,\n } as BuiltForLeaf<L>;\n }\n\n // --- Mutation (POST/PUT/PATCH/DELETE) ---\n const useEndpoint: BuiltMutation<L>['useEndpoint'] = (...tuple) => {\n const a = extractArgs<L>(tuple);\n const params = (a as any)?.params as InferParams<L> | undefined;\n const query = (a as any)?.query as InferQuery<L> | undefined;\n\n const { url } = buildUrl(leaf, baseUrl, params, query);\n return useMutation<InferOutput<L>, unknown, InferBody<L>, unknown>({\n ...(rqOpts as MutationBuildOptionsFor<L>),\n mutationKey: key(...tuple),\n mutationFn: async (body: InferBody<L>) => {\n const normalizedBody = zParse<InferBody<L>>(body, leaf.cfg.bodySchema);\n\n // Optional: switch to FormData if your method declares bodyFiles\n const isMultipart = Array.isArray(leaf.cfg.bodyFiles) && leaf.cfg.bodyFiles.length > 0;\n const payload = isMultipart ? toFormData(normalizedBody as any) : normalizedBody;\n\n const out = await fetcher<unknown>({ url, method: toUpper(leaf.method), body: payload });\n return zParse<InferOutput<L>>(out, leaf.cfg.outputSchema);\n },\n });\n };\n\n return {\n key,\n invalidate: invalidateExact,\n setData: setData as any,\n useEndpoint,\n } as BuiltForLeaf<L>;\n }\n\n return {\n queryClient,\n invalidate,\n build: buildInternal as RouteClient['build'],\n };\n}\n\n// -------------------------------------------------------------------------------------\n// Multipart helper\n// -------------------------------------------------------------------------------------\nfunction toFormData(body: Record<string, any>): FormData {\n const fd = new FormData();\n for (const [k, v] of Object.entries(body ?? {})) {\n if (v == null) continue;\n if (Array.isArray(v)) v.forEach((item, i) => fd.append(`${k}[${i}]`, item as any));\n else fd.append(k, v as any);\n }\n return fd;\n}\n"],"mappings":";AAIA,IAAM,SAAS;AAAA,EACb,OAAO,IAAI,SAAgB;AAEzB,YAAQ,IAAI,2BAA2B,GAAG,IAAI;AAAA,EAChD;AACF;AAOO,IAAM,iBAA0B,OAAU,QAAgC;AAC/E,QAAM,UAAkC,EAAE,GAAI,IAAI,WAAW,CAAC,EAAG;AACjE,QAAM,aAAa,OAAO,aAAa,eAAe,IAAI,gBAAgB;AAC1E,MAAI,CAAC,YAAY;AACf,0DAA4B;AAC5B,8CAAsB;AAAA,EACxB;AAEA,SAAO,MAAM,SAAS,IAAI,QAAQ,IAAI,KAAK,aAAa,aAAa,IAAI,IAAI;AAC7E,QAAM,MAAM,MAAM,MAAM,IAAI,KAAK;AAAA,IAC/B,QAAQ,IAAI;AAAA,IACZ;AAAA,IACA,MAAM,aAAc,IAAI,OAAe,IAAI,QAAQ,OAAO,SAAY,KAAK,UAAU,IAAI,IAAI;AAAA,EAC/F,CAAC;AAED,QAAM,OAAO,MAAM,IAAI,KAAK;AAC5B,MAAI,CAAC,IAAI,IAAI;AACX,UAAM,UAAU,KAAK,MAAM,GAAG,GAAG;AACjC,UAAM,IAAI,MAAM,IAAI,IAAI,MAAM,KAAK,IAAI,UAAU,WAAM,OAAO,EAAE;AAAA,EAClE;AAEA,MAAI;AACF,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB,QAAQ;AACN,WAAO;AAAA,EACT;AACF;;;ACzCA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAEP;AAAA,EAEE;AAAA,EACA;AAAA,OACK;AAkCP,IAAM,UAAU,CAAC,MAAyC,EAAE,YAAY;AAQxE,SAAS,OAAU,OAAgB,QAAqB;AACtD,SAAO,SAAU,OAAO,MAAM,KAAK,IAAW;AAChD;AAOA,SAAS,eAAe,OAA4C;AAClE,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,SAAS,IAAI,gBAAgB;AACnC,aAAW,CAAC,GAAG,CAAC,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1C,QAAI,KAAK,KAAM;AACf,QAAI,MAAM,QAAQ,CAAC,GAAG;AACpB,QAAE,QAAQ,CAAC,MAAM;AACf,YAAI,KAAK,KAAM;AACf,YAAI,OAAO,MAAM,UAAU;AACzB,iBAAO,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC;AAAA,QACpC,OAAO;AACL,iBAAO,OAAO,GAAG,OAAO,CAAC,CAAC;AAAA,QAC5B;AAAA,MACF,CAAC;AACD;AAAA,IACF;AACA,QAAI,OAAO,MAAM,UAAU;AACzB,aAAO,IAAI,GAAG,KAAK,UAAU,CAAC,CAAC;AAC/B;AAAA,IACF;AACA,WAAO,IAAI,GAAG,OAAO,CAAC,CAAC;AAAA,EACzB;AACA,QAAM,IAAI,OAAO,SAAS;AAC1B,SAAO,IAAI,IAAI,CAAC,KAAK;AACvB;AAQA,SAAS,SAAwD,KAAQ,KAAgB;AACvF,MAAI,CAAC,IAAK,QAAO;AACjB,QAAM,EAAE,CAAC,GAAG,GAAG,OAAO,GAAG,KAAK,IAAI;AAClC,SAAO;AACT;AAOA,IAAM,uBAAuB,CAAC,MAC5B,KAAK,OAAO,MAAM,YAAY,gBAAgB,IAAK,EAAU,aAAa;AAQ5E,SAAS,YAA+B,MAA4C;AAElF,SAAQ,KAA0B,CAAC;AACrC;AAUA,SAAS,SACP,MACA,SACA,QACA,OACA;AACA,QAAM,mBAAmB,OAAuB,QAAQ,KAAK,IAAI,YAAY;AAC7E,QAAM,kBAAkB,OAAsB,OAAO,KAAK,IAAI,WAAW;AACzE,QAAM,OAAO,YAAuB,KAAK,MAAO,oBAAoB,CAAC,CAAS;AAC9E,QAAM,MAAM,GAAG,WAAW,EAAE,GAAG,IAAI,GAAG,eAAe,eAAsB,CAAC;AAC5E,SAAO,EAAE,KAAK,gBAAgB;AAChC;AAUO,SAAS,kBAAkB,MAAuC;AACvE,QAAM,cAAc,KAAK;AACzB,QAAM,UAAU,KAAK,WAAW;AAChC,QAAM,UAAU,KAAK;AACrB,QAAM,cAAc,KAAK,eAAe;AACxC,QAAM,gBAAgB,KAAK,iBAAiB;AAO5C,iBAAe,WAAW,QAAkB,QAAQ,OAAO;AACzD,UAAM,YAAY,kBAAkB,EAAE,UAAU,QAA+B,MAAM,CAAC;AAAA,EACxF;AAQA,WAAS,cACP,MACA,QACiB;AACjB,UAAM,QAAQ,KAAK,WAAW;AAC9B,UAAM,SAAS,CAAC,CAAC,KAAK,IAAI;AAG1B,UAAM,MAAM,IAAI,UAAkC;AAChD,YAAM,IAAI,YAAe,KAAK;AAC9B,YAAM,SAAU,GAAW;AAC3B,YAAM,QAAS,GAAW;AAC1B,YAAM,UAAU,SAAS,SAAS,SAAS,OAAc,WAAW,IAAK;AACzE,aAAO,cAAc,EAAE,MAAM,QAAuB,OAAO,QAAQ,CAAC;AAAA,IACtE;AAMA,UAAM,kBAAkB,IAAI,UAC1B,YAAY,kBAAkB,EAAE,UAAU,IAAI,GAAG,KAAK,GAAG,OAAO,KAAK,CAAC;AAMxE,UAAM,UAAU,IAAI,SAAyD;AAC3E,YAAM,CAAC,SAAS,GAAG,IAAI,IAAI;AAC3B,YAAM,IAAI,IAAI,GAAI,IAAqB;AACvC,UAAI,SAAS,QAAQ;AACnB,oBAAY;AAAA,UAAuD;AAAA,UAAG,CAAC,SACrE,OAAO,YAAY,aAAc,QAAgB,IAAI,IAAK;AAAA,QAC5D;AAAA,MACF,OAAO;AACL,oBAAY;AAAA,UAAyC;AAAA,UAAG,CAAC,SACvD,OAAO,YAAY,aAAc,QAAgB,IAAI,IAAK;AAAA,QAC5D;AAAA,MACF;AAAA,IACF;AAGA,QAAI,SAAS,QAAQ;AACnB,YAAMA,eAA+C,IAAI,UAAU;AACjE,cAAM,IAAI,YAAe,KAAK;AAC9B,cAAM,SAAU,GAAW;AAC3B,cAAM,QAAS,GAAW;AAG1B,cAAM,EAAE,gBAAgB,IAAI,SAAS,MAAM,SAAS,QAAQ,KAAK;AACjE,eAAO,iBAML;AAAA,UACA,GAAI;AAAA,UACJ,UAAU,IAAI,GAAG,KAAK;AAAA,UACtB,kBAAkB;AAAA,UAClB,kBAAkB,CAAC,aAAa,cAAc,QAAQ;AAAA,UACtD,iBAAiB;AAAA,UACjB,SAAS,OAAO,EAAE,UAAU,MAAM;AAChC,kBAAM,YAAY;AAAA,cAChB,GAAI;AAAA,cACJ,GAAI,YAAY,EAAE,CAAC,WAAW,GAAG,UAAU,IAAI,CAAC;AAAA,YAClD;AACA,kBAAM,EAAE,IAAI,IAAI,SAAS,MAAM,SAAS,QAAQ,SAAS;AACzD,kBAAM,MAAM,MAAM,QAAiB,EAAE,KAAK,QAAQ,QAAQ,KAAK,MAAM,EAAE,CAAC;AACxE,mBAAO,OAAuB,KAAK,KAAK,IAAI,YAAY;AAAA,UAC1D;AAAA;AAAA,QAEF,CAAC;AAAA,MACH;AAEA,aAAO;AAAA,QACL;AAAA,QACA,YAAY;AAAA,QACZ;AAAA,QACA,aAAAA;AAAA,MACF;AAAA,IACF;AAGA,QAAI,OAAO;AACT,YAAMA,eAA4C,IAAI,UAAU;AAC9D,cAAM,IAAI,YAAe,KAAK;AAC9B,cAAM,SAAU,GAAW;AAC3B,cAAM,QAAS,GAAW;AAE1B,cAAM,EAAE,IAAI,IAAI,SAAS,MAAM,SAAS,QAAQ,KAAK;AACrD,eAAO,SAA4D;AAAA,UACjE,GAAI;AAAA,UACJ,UAAU,IAAI,GAAG,KAAK;AAAA,UACtB,iBAAiB;AAAA,UACjB,SAAS,YAAY;AACnB,kBAAM,MAAM,MAAM,QAAiB,EAAE,KAAK,QAAQ,QAAQ,KAAK,MAAM,EAAE,CAAC;AACxE,mBAAO,OAAuB,KAAK,KAAK,IAAI,YAAY;AAAA,UAC1D;AAAA,QACF,CAAC;AAAA,MACH;AAEA,aAAO;AAAA,QACL;AAAA,QACA,YAAY;AAAA,QACZ;AAAA,QACA,aAAAA;AAAA,MACF;AAAA,IACF;AAGA,UAAM,cAA+C,IAAI,UAAU;AACjE,YAAM,IAAI,YAAe,KAAK;AAC9B,YAAM,SAAU,GAAW;AAC3B,YAAM,QAAS,GAAW;AAE1B,YAAM,EAAE,IAAI,IAAI,SAAS,MAAM,SAAS,QAAQ,KAAK;AACrD,aAAO,YAA4D;AAAA,QACjE,GAAI;AAAA,QACJ,aAAa,IAAI,GAAG,KAAK;AAAA,QACzB,YAAY,OAAO,SAAuB;AACxC,gBAAM,iBAAiB,OAAqB,MAAM,KAAK,IAAI,UAAU;AAGrE,gBAAM,cAAc,MAAM,QAAQ,KAAK,IAAI,SAAS,KAAK,KAAK,IAAI,UAAU,SAAS;AACrF,gBAAM,UAAU,cAAc,WAAW,cAAqB,IAAI;AAElE,gBAAM,MAAM,MAAM,QAAiB,EAAE,KAAK,QAAQ,QAAQ,KAAK,MAAM,GAAG,MAAM,QAAQ,CAAC;AACvF,iBAAO,OAAuB,KAAK,KAAK,IAAI,YAAY;AAAA,QAC1D;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,MACL;AAAA,MACA,YAAY;AAAA,MACZ;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,OAAO;AAAA,EACT;AACF;AAKA,SAAS,WAAW,MAAqC;AACvD,QAAM,KAAK,IAAI,SAAS;AACxB,aAAW,CAAC,GAAG,CAAC,KAAK,OAAO,QAAQ,QAAQ,CAAC,CAAC,GAAG;AAC/C,QAAI,KAAK,KAAM;AACf,QAAI,MAAM,QAAQ,CAAC,EAAG,GAAE,QAAQ,CAAC,MAAM,MAAM,GAAG,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,IAAW,CAAC;AAAA,QAC5E,IAAG,OAAO,GAAG,CAAQ;AAAA,EAC5B;AACA,SAAO;AACT;","names":["useEndpoint"]}
@@ -0,0 +1,7 @@
1
+ import { Fetcher } from './routesV3.client.types';
2
+ /**
3
+ * Default fetch implementation used by the route client helper.
4
+ * @param req Normalized request information (URL, method, body, headers).
5
+ * @returns Parsed JSON (or text fallback) from the server response.
6
+ */
7
+ export declare const defaultFetcher: Fetcher;
@@ -0,0 +1,7 @@
1
+ import type { RouteClient, RouteClientOptions } from './routesV3.client.types';
2
+ /**
3
+ * Construct typed React Query helpers backed by a routes-v3 registry leaf.
4
+ * @param opts Route client configuration (query client, fetcher overrides, etc).
5
+ * @returns Object that can build endpoint hooks/mutations from leaves.
6
+ */
7
+ export declare function createRouteClient(opts: RouteClientOptions): RouteClient;
@@ -0,0 +1,128 @@
1
+ import type { InfiniteData, QueryClient, QueryKey, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
2
+ import type { AnyLeaf, HttpMethod, InferBody, InferOutput, InferParams, InferQuery } from '@emeryld/rrroutes-contract';
3
+ /** Helper type used when setting React Query cache data. */
4
+ export type Updater<T> = T | ((prev: T | undefined) => T);
5
+ /** Cursor string extracted from paginated endpoints. */
6
+ export type Cursor = string | undefined;
7
+ /** Runtime request details consumed by a `Fetcher` implementation. */
8
+ export type FetchInput = {
9
+ /** Fully qualified URL that will be requested. */
10
+ url: string;
11
+ /** HTTP method (always uppercase). */
12
+ method: Uppercase<HttpMethod>;
13
+ /** Optional request body (already normalized by the client). */
14
+ body?: unknown;
15
+ /** Additional headers merged into the request. */
16
+ headers?: Record<string, string>;
17
+ };
18
+ /** Default signature for HTTP fetch implementations. */
19
+ export type Fetcher = <T>(req: FetchInput) => Promise<T>;
20
+ /** Configuration passed to `createRouteClient`. */
21
+ export type RouteClientOptions = {
22
+ /** Base URL prepended to every route (optional). */
23
+ baseUrl: string;
24
+ /** Custom fetch implementation; defaults to `defaultFetcher`. */
25
+ fetcher?: Fetcher;
26
+ /** Shared React Query client used for caching/invalidation. */
27
+ queryClient: QueryClient;
28
+ /** Query string key used for pagination cursors (default: "cursor"). */
29
+ cursorParam?: string;
30
+ /** Function that extracts the next cursor from an infinite query page. */
31
+ getNextCursor?: (page: unknown) => Cursor;
32
+ };
33
+ type OutputOf<L extends AnyLeaf> = InferOutput<L>;
34
+ type ParamsOf<L extends AnyLeaf> = InferParams<L>;
35
+ type QueryOf<L extends AnyLeaf> = InferQuery<L>;
36
+ type BodyOf<L extends AnyLeaf> = InferBody<L>;
37
+ /** Object shape the user passes to hooks and helpers (params/query are optional). */
38
+ export type ArgsFor<L extends AnyLeaf> = (ParamsOf<L> extends never ? {} : {
39
+ params: ParamsOf<L>;
40
+ }) & (QueryOf<L> extends never ? {} : {
41
+ query: QueryOf<L>;
42
+ });
43
+ /** Variadic tuple representation that omits the argument entirely when not needed. */
44
+ export type ArgsTuple<L extends AnyLeaf> = keyof ArgsFor<L> extends never ? [] : [args: ArgsFor<L>];
45
+ /** Cache data shape for setData(...) */
46
+ export type DataShape<L extends AnyLeaf> = L['method'] extends 'get' ? L['cfg']['feed'] extends true ? InfiniteData<OutputOf<L>> : OutputOf<L> : OutputOf<L>;
47
+ /** React Query build options specialized for a plain GET leaf. */
48
+ export type QueryBuildOptionsFor<L extends AnyLeaf> = Omit<UseQueryOptions<OutputOf<L>, unknown, OutputOf<L>, QueryKey>, 'queryKey' | 'queryFn'>;
49
+ /** Build options for feed-style GET leaves (`cfg.feed === true`). */
50
+ export type InfiniteBuildOptionsFor<L extends AnyLeaf> = Omit<UseInfiniteQueryOptions<OutputOf<L>, unknown, InfiniteData<OutputOf<L>>, QueryKey, Cursor>, 'queryKey' | 'queryFn' | 'initialPageParam' | 'getNextPageParam'>;
51
+ /** Build options for mutation leaves (non-GET). */
52
+ export type MutationBuildOptionsFor<L extends AnyLeaf> = Omit<UseMutationOptions<OutputOf<L>, unknown, BodyOf<L>, unknown>, 'mutationFn' | 'mutationKey'>;
53
+ /** Shared capabilities exposed by every built endpoint helper. */
54
+ export type BuiltCommon<L extends AnyLeaf> = {
55
+ /**
56
+ * Deterministic key (infinite keys omit the cursor by design).
57
+ * @param args Optional params/query tuple for the leaf.
58
+ * @returns Query key tuple.
59
+ */
60
+ key: (...args: ArgsTuple<L>) => QueryKey;
61
+ /**
62
+ * Invalidate exactly this endpoint instance.
63
+ * @param args Optional params/query tuple for the leaf.
64
+ */
65
+ invalidate: (...args: ArgsTuple<L>) => Promise<void>;
66
+ /**
67
+ * Directly update the cache for this endpoint. Handles infinite vs regular.
68
+ * @param updater New value or function applied to existing cache data.
69
+ * @param rest Optional params/query tuple for the leaf.
70
+ */
71
+ setData: (...args: [updater: Updater<DataShape<L>>, ...rest: ArgsTuple<L>]) => void;
72
+ };
73
+ /** Hook+helpers for a standard GET endpoint. */
74
+ export type BuiltQuery<L extends AnyLeaf> = BuiltCommon<L> & {
75
+ /**
76
+ * React hook bound to the GET leaf.
77
+ * @param args Optional params/query tuple for the leaf.
78
+ */
79
+ useEndpoint: (...args: ArgsTuple<L>) => UseQueryResult<OutputOf<L>, unknown>;
80
+ };
81
+ /** Hook+helpers for a cursor-paginated GET endpoint. */
82
+ export type BuiltInfinite<L extends AnyLeaf> = BuiltCommon<L> & {
83
+ /**
84
+ * React hook bound to an infinite GET leaf.
85
+ * @param args Optional params/query tuple for the leaf.
86
+ */
87
+ useEndpoint: (...args: ArgsTuple<L>) => UseInfiniteQueryResult<InfiniteData<OutputOf<L>>, unknown>;
88
+ };
89
+ /** Hook+helpers for non-GET endpoints (mutations). */
90
+ export type BuiltMutation<L extends AnyLeaf> = BuiltCommon<L> & {
91
+ /**
92
+ * React hook bound to a mutation leaf.
93
+ * @param args Optional params/query tuple for the leaf.
94
+ */
95
+ useEndpoint: (...args: ArgsTuple<L>) => UseMutationResult<OutputOf<L>, unknown, BodyOf<L>, unknown>;
96
+ };
97
+ /** Type-safe union that resolves to the correct built helper for a leaf. */
98
+ export type BuiltForLeaf<L extends AnyLeaf> = L['method'] extends 'get' ? L['cfg']['feed'] extends true ? BuiltInfinite<L> : BuiltQuery<L> : BuiltMutation<L>;
99
+ /** Public surface returned by `createRouteClient`. */
100
+ export type RouteClient = {
101
+ /**
102
+ * Invalidate by a key prefix (e.g., ['get','api','users']).
103
+ * @param prefix Key parts shared by matching endpoints.
104
+ * @param exact When true, invalidate only exact key matches.
105
+ */
106
+ invalidate: (prefix: string[], exact?: boolean) => Promise<void>;
107
+ /** Build a typed endpoint from a leaf. */
108
+ build: {
109
+ <L extends AnyLeaf & {
110
+ method: 'get';
111
+ cfg: {
112
+ feed: true;
113
+ };
114
+ }>(leaf: L, opts?: InfiniteBuildOptionsFor<L>): BuiltInfinite<L>;
115
+ <L extends AnyLeaf & {
116
+ method: 'get';
117
+ cfg: {
118
+ feed?: false | undefined;
119
+ };
120
+ }>(leaf: L, opts?: QueryBuildOptionsFor<L>): BuiltQuery<L>;
121
+ <L extends AnyLeaf & {
122
+ method: Exclude<HttpMethod, 'get'>;
123
+ }>(leaf: L, opts?: MutationBuildOptionsFor<L>): BuiltMutation<L>;
124
+ };
125
+ /** Underlying React Query client (exposed for advanced scenarios). */
126
+ queryClient: QueryClient;
127
+ };
128
+ export {};
package/package.json ADDED
@@ -0,0 +1,36 @@
1
+ {
2
+ "name": "@emeryld/rrroutes-client",
3
+ "version": "1.1.0",
4
+ "private": false,
5
+ "type": "module",
6
+ "main": "dist/index.cjs",
7
+ "module": "dist/index.mjs",
8
+ "types": "dist/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "types": "./dist/index.d.ts",
12
+ "import": "./dist/index.mjs",
13
+ "require": "./dist/index.cjs"
14
+ }
15
+ },
16
+ "files": [
17
+ "dist"
18
+ ],
19
+ "dependencies": {
20
+ "@emeryld/rrroutes-contract": "^1.0.1",
21
+ "zod": "^4.1.8"
22
+ },
23
+ "peerDependencies": {
24
+ "@tanstack/react-query": "^5.87.4"
25
+ },
26
+ "devDependencies": {
27
+ "@jest/globals": "^30.2.0"
28
+ },
29
+ "scripts": {
30
+ "clean": "rimraf dist",
31
+ "build": "pnpm run clean && pnpm run build:js && pnpm run build:types",
32
+ "build:js": "tsup src/index.ts --sourcemap --format esm,cjs --out-dir dist",
33
+ "build:types": "tsc -p tsconfig.build.json",
34
+ "typecheck": "tsc -p tsconfig.json --noEmit"
35
+ }
36
+ }