@emeryld/rrroutes-client 2.4.1 → 2.4.2

package/dist/routesV3.client.d.ts

@@ -0,0 +1,4 @@
+import type { AnyLeafLowProfile } from '@emeryld/rrroutes-contract';
+import type { RouteClient, RouteClientOptions, RouterBuilder } from './routesV3.client.types';
+export declare function createRouteClient<Names extends string = string>(opts: RouteClientOptions<Names>): RouteClient<Names>;
+export declare function buildRouter<Routes extends Record<PropertyKey, AnyLeafLowProfile>, Names extends string = string>(routeClient: RouteClient<Names>, routes: Routes): RouterBuilder<Routes, Names>;

package/dist/routesV3.client.get.d.ts

@@ -0,0 +1,15 @@
+import type { AnyLeafLowProfile } from '@emeryld/rrroutes-contract';
+import { type QueryClient } from '@tanstack/react-query';
+import type { BuiltQuery, Fetcher, QueryBuildOptionsFor, RouteClientDebugEvent } from './routesV3.client.types';
+type GetEnv = {
+    baseUrl: string;
+    validateResponses: boolean;
+    fetcher: Fetcher;
+    queryClient: QueryClient;
+    emit: (event: RouteClientDebugEvent) => void;
+    decorateDebugEvent: <T extends RouteClientDebugEvent>(event: T, details?: Partial<RouteClientDebugEvent>) => RouteClientDebugEvent;
+    isVerboseDebug: boolean;
+    leafLabel: string;
+};
+export declare function buildGetLeaf<L extends AnyLeafLowProfile>(leaf: L, rqOpts: QueryBuildOptionsFor<L> | undefined, env: GetEnv): BuiltQuery<L>;
+export {};

package/dist/routesV3.client.infiniteGet.d.ts

@@ -0,0 +1,15 @@
+import type { AnyLeafLowProfile } from '@emeryld/rrroutes-contract';
+import { type QueryClient } from '@tanstack/react-query';
+import type { BuiltInfinite, Fetcher, InfiniteBuildOptionsFor, RouteClientDebugEvent } from './routesV3.client.types';
+type InfiniteEnv = {
+    baseUrl: string;
+    validateResponses: boolean;
+    fetcher: Fetcher;
+    queryClient: QueryClient;
+    emit: (event: RouteClientDebugEvent) => void;
+    decorateDebugEvent: <T extends RouteClientDebugEvent>(event: T, details?: Partial<RouteClientDebugEvent>) => RouteClientDebugEvent;
+    isVerboseDebug: boolean;
+    leafLabel: string;
+};
+export declare function buildInfiniteGetLeaf<L extends AnyLeafLowProfile>(leaf: L, rqOpts: InfiniteBuildOptionsFor<L> | undefined, env: InfiniteEnv): BuiltInfinite<L>;
+export {};

package/dist/routesV3.client.mutation.d.ts

@@ -0,0 +1,15 @@
+import type { AnyLeafLowProfile } from '@emeryld/rrroutes-contract';
+import { type QueryClient } from '@tanstack/react-query';
+import type { BuiltMutation, Fetcher, MutationBuildOptionsFor, RouteClientDebugEvent } from './routesV3.client.types';
+type MutationEnv = {
+    baseUrl: string;
+    validateResponses: boolean;
+    fetcher: Fetcher;
+    queryClient: QueryClient;
+    emit: (event: RouteClientDebugEvent) => void;
+    decorateDebugEvent: <T extends RouteClientDebugEvent>(event: T, details?: Partial<RouteClientDebugEvent>) => RouteClientDebugEvent;
+    isVerboseDebug: boolean;
+    leafLabel: string;
+};
+export declare function buildMutationLeaf<L extends AnyLeafLowProfile>(leaf: L, rqOpts: MutationBuildOptionsFor<L> | undefined, env: MutationEnv): BuiltMutation<L>;
+export {};

package/dist/routesV3.client.shared.d.ts

@@ -0,0 +1,44 @@
+import type { AnyLeafLowProfile, HttpMethod, InferParams, InferQuery } from '@emeryld/rrroutes-contract';
+import type { ArgsFor, ArgsTuple, Cursor } from './routesV3.client.types';
+/**
+ * Convert an HTTP method to uppercase (as expected by fetch).
+ */
+export declare const toUpper: (m: HttpMethod) => Uppercase<HttpMethod>;
+/**
+ * Serialize a query object into a search string.
+ */
+export declare function toSearchString(query: Record<string, unknown> | undefined): string;
+/**
+ * Remove the given key from an object (used to drop cursors from cache keys).
+ */
+export declare function stripKey<Q extends Record<string, unknown> | undefined>(obj: Q, key: string): Q;
+/**
+ * Default cursor extractor used by infinite queries.
+ */
+export declare const defaultGetNextCursor: (p: unknown) => Cursor;
+/**
+ * Extract the optional argument object from a variadic tuple.
+ */
+export declare function extractArgs<L extends AnyLeafLowProfile>(args: ArgsTuple<L>): ArgsFor<L> | undefined;
+/**
+ * Convert an optional args object into the variadic tuple form.
+ */
+export declare function toArgsTuple<L extends AnyLeafLowProfile>(args: ArgsFor<L> | undefined): ArgsTuple<L>;
+/**
+ * Normalize params and query values, then construct a request URL for the given leaf.
+ */
+export declare function buildUrl<L extends AnyLeafLowProfile>(leaf: L, baseUrl: string, params: InferParams<L> | undefined, query: InferQuery<L> | undefined): {
+    url: string;
+    normalizedQuery: unknown;
+    normalizedParams: unknown;
+};
+export declare function toFormData(body: Record<string, any>): FormData;
+/**
+ * Validate that the query is a flat Record<string, string>.
+ * Throws if any value is non-string or the structure is not a plain object.
+ */
+export declare function normalizeFlatQuery(query: unknown): Record<string, string> | undefined;
+/**
+ * Validate path parameters against the path template and compile the path.
+ */
+export declare function compileRawPath(path: string, params: unknown): string;

package/dist/routesV3.client.types.d.ts

@@ -175,6 +175,21 @@ export type InfiniteBuildOptionsFor<L extends AnyLeafLowProfile> = Omit<UseInfin
     getNextPageParam?: (lastPage: InferOutput<L>) => Cursor;
     /** Hook invoked after a successful fetch + validation. */
     onReceive?: OnReceive<L>;
+    /**
+     * Maximum number of items per underlying HTTP request for a single infinite page.
+     * When provided, the client will:
+     *   - Look for a numeric page size in the query (using `splitPageSizeParam`, default "pageSize")
+     *   - If logical page size > splitPageSize, it will:
+     *       * Internally perform multiple HTTP requests, each with `splitPageSize`
+     *       * Merge the results into one logical React Query "page"
+     *       * Incrementally update the cache between requests
+     */
+    splitPageSize?: number;
+    /**
+     * Name of the query parameter that carries the logical page size.
+     * Defaults to "pageSize".
+     */
+    splitPageSizeParam?: string;
 };
 /** Build options for mutation leaves (non-GET). */
 export type MutationBuildOptionsFor<L extends AnyLeafLowProfile> = Omit<UseMutationOptions<InferOutput<L>, unknown, InferBody<L>, unknown>, 'mutationFn' | 'mutationKey'> & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emeryld/rrroutes-client",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "private": false,
   "type": "module",
   "main": "dist/index.cjs",

package/dist/routesV3.client.index.d.ts

@@ -1,15 +0,0 @@
-import type { AnyLeafLowProfile } from '@emeryld/rrroutes-contract';
-import type { RouteClient, RouteClientOptions, RouterBuilder } from './routesV3.client.types';
-/**
- * Construct typed React Query helpers backed by a routes-v3 registry leaf.
- * @param opts Route client configuration (query client, fetcher overrides, etc).
- * @returns Object that can build endpoint hooks/mutations from leaves.
- */
-export declare function createRouteClient<Names extends string = string>(opts: RouteClientOptions<Names>): RouteClient<Names>;
-/**
- * Curry a route client with a registry of leaves so callers can build endpoints by name.
- * @param routeClient The route client instance created via `createRouteClient`.
- * @param routes Object map of named leaves (e.g., a registry’s `byKey` or a curated subset).
- * @returns Function that builds endpoints by supplying the route name instead of the leaf itself.
- */
-export declare function buildRouter<Routes extends Record<PropertyKey, AnyLeafLowProfile>, Names extends string = string>(routeClient: RouteClient<Names>, routes: Routes): RouterBuilder<Routes, Names>;