routesync 1.0.19 → 1.0.21

package/dist/react.mjs

@@ -1,13 +1,41 @@
 // packages/react/src/hooks/useQuery.ts
-import { useQuery } from "@tanstack/react-query";
-function useApiQuery(endpoint, options, queryOptions) {
-  const queryKey = options ? [...endpoint.$key, options] : endpoint.$key;
+import { useQuery, useSuspenseQuery, useInfiniteQuery } from "@tanstack/react-query";
+function useApiQuery(endpoint, ...args) {
+  const options = args[0];
+  const queryOptions = args[1];
+  const queryKey = endpoint.$queryKey(options);
   return useQuery({
     queryKey,
     queryFn: () => endpoint(options),
     ...queryOptions
   });
 }
+function useApiSuspenseQuery(endpoint, ...args) {
+  const options = args[0];
+  const queryOptions = args[1];
+  const queryKey = endpoint.$queryKey(options);
+  return useSuspenseQuery({
+    queryKey,
+    queryFn: () => endpoint(options),
+    ...queryOptions
+  });
+}
+function useApiInfiniteQuery(endpoint, ...args) {
+  const options = args[0];
+  const queryOptions = args.length > 1 ? args[1] : args[0];
+  const queryKey = endpoint.$queryKey(options);
+  return useInfiniteQuery({
+    queryKey,
+    queryFn: ({ pageParam }) => {
+      const fetchOptions = { ...options };
+      if (pageParam !== void 0) {
+        fetchOptions.query = { ...fetchOptions.query || {}, page: pageParam };
+      }
+      return endpoint(fetchOptions);
+    },
+    ...queryOptions
+  });
+}
 
 // packages/react/src/hooks/useMutation.ts
 import { useMutation, useQueryClient } from "@tanstack/react-query";
@@ -27,6 +55,47 @@ function useApiMutation(endpoint, options) {
   });
 }
 
+// packages/react/src/hooks/useQueryClient.ts
+import { useQueryClient as useQueryClient2 } from "@tanstack/react-query";
+function useApiQueryClient() {
+  const queryClient = useQueryClient2();
+  return {
+    queryClient,
+    /**
+     * Invalidate specific queries related to an endpoint.
+     * Optionally pass parameters to invalidate a more specific cache entry.
+     */
+    invalidateEndpoint: (endpoint, options) => {
+      return queryClient.invalidateQueries({
+        queryKey: endpoint.$queryKey(options)
+      });
+    },
+    /**
+     * Prefetch data for an endpoint into the cache.
+     * Useful for SSR, RSC hydration, or proactive prefetching.
+     */
+    prefetchEndpoint: (endpoint, options) => {
+      return queryClient.prefetchQuery({
+        queryKey: endpoint.$queryKey(options),
+        queryFn: () => endpoint(options)
+      });
+    },
+    /**
+     * Manually update the cache for a specific endpoint.
+     * Often used for optimistic updates in mutations.
+     */
+    setEndpointData: (endpoint, options, updater) => {
+      return queryClient.setQueryData(endpoint.$queryKey(options), updater);
+    },
+    /**
+     * Retrieve the current cached data for a specific endpoint.
+     */
+    getEndpointData: (endpoint, options) => {
+      return queryClient.getQueryData(endpoint.$queryKey(options));
+    }
+  };
+}
+
 // packages/react/src/hooks/createHooks.ts
 function createHooks(group) {
   const hooks = {};
@@ -41,8 +110,29 @@ function createHooks(group) {
   }
   return hooks;
 }
+
+// packages/react/src/utils/form.ts
+function setFormErrors(error, setError) {
+  if (error && typeof error === "object" && "status" in error && error.status === 422) {
+    const apiError = error;
+    const errors = apiError.errors;
+    if (errors && typeof errors === "object") {
+      for (const [field, messages] of Object.entries(errors)) {
+        if (Array.isArray(messages) && messages.length > 0) {
+          setError(field, { type: "server", message: String(messages[0]) });
+        } else if (typeof messages === "string") {
+          setError(field, { type: "server", message: messages });
+        }
+      }
+    }
+  }
+}
 export {
   createHooks,
+  setFormErrors,
+  useApiInfiniteQuery,
   useApiMutation,
-  useApiQuery
+  useApiQuery,
+  useApiQueryClient,
+  useApiSuspenseQuery
 };

package/dist/sdk.d.mts

@@ -7,6 +7,14 @@ interface ServiceConfig {
     timeout?: number;
     retry?: RetryConfig;
     cache?: boolean;
+    validateResponse?: boolean;
+    onValidationError?: (error: unknown, context: {
+        endpoint: string;
+        method: string;
+        path: string;
+        request: unknown;
+        response: unknown;
+    }) => void;
 }
 interface RetryConfig {
     attempts: number;
@@ -16,6 +24,7 @@ interface RetryConfig {
 
 declare class HttpClient {
     private client;
+    readonly config: ServiceConfig;
     constructor(config: ServiceConfig);
     private setupInterceptors;
     setToken(token: string): void;
@@ -56,11 +65,15 @@ interface RouteSchemaMap {
 }
 type RouteSchemaValue = RouteTransform | RouteParserSchema;
 type RouteSchema = RouteSchemaValue | RouteSchemaMap;
-interface RouteDefinition {
+interface ResponseSchema<T> {
+    parse(input: unknown): T;
+}
+interface RouteDefinition<TResponse = unknown, TParams = unknown, TBody = unknown> {
     method: HttpMethod;
     path: string;
     auth?: boolean;
     schema?: RouteSchema;
+    responseSchema?: ResponseSchema<TResponse>;
     mapper?: RouteMapper;
     headers?: Record<string, string>;
     cache?: unknown;
@@ -68,10 +81,13 @@ interface RouteDefinition {
     body?: Record<string, any>;
     params?: Record<string, any>;
     query?: Record<string, any>;
+    _typeResponse?: TResponse;
+    _typeParams?: TParams;
+    _typeBody?: TBody;
 }
 interface ApiDefinition {
     [group: string]: {
-        [action: string]: RouteDefinition;
+        [action: string]: RouteDefinition<any, any, any>;
     };
 }
 
@@ -99,21 +115,37 @@ declare class TokenManager {
     exists(): boolean;
 }
 
-type CallOptions = {
-    params?: Record<string, any>;
+type CallOptions<TParams = unknown, TBody = unknown> = {
+    params?: TParams;
     query?: Record<string, any>;
-    body?: Record<string, any>;
+    body?: TBody;
     headers?: Record<string, string>;
 };
-interface EndpointCallable {
-    <TResponse = unknown>(options?: CallOptions): Promise<TResponse>;
+type EndpointCallableOptions<TParams, TBody> = (unknown extends TParams ? {} : {
+    params: TParams;
+}) & (unknown extends TBody ? {} : {
+    body: TBody;
+}) & {
+    query?: Record<string, any>;
+    headers?: Record<string, string>;
+};
+type OptionalIfEmpty<T> = keyof Omit<T, 'query' | 'headers'> extends never ? [options?: T] : [options: T];
+interface ApiError {
+    message: string;
+    status?: number;
+    errors?: Record<string, string[]>;
+}
+interface EndpointCallable<TResponse = unknown, TParams = unknown, TBody = unknown> {
+    (...args: OptionalIfEmpty<EndpointCallableOptions<TParams, TBody>>): Promise<TResponse>;
     /** Original RouteDefinition — used by useApiQuery / useApiMutation */
-    $def: RouteDefinition;
+    $def: RouteDefinition<TResponse, TParams, TBody>;
     /** Stable TanStack query key: [group, action] */
     $key: string[];
+    /** Consistent query key builder that incorporates params/query if provided */
+    $queryKey: (...args: OptionalIfEmpty<EndpointCallableOptions<TParams, TBody>>) => unknown[];
 }
-type ApiGroupProxy<G extends Record<string, RouteDefinition>> = {
-    [K in keyof G]: EndpointCallable;
+type ApiGroupProxy<G extends Record<string, RouteDefinition<any, any, any>>> = {
+    [K in keyof G]: EndpointCallable<G[K] extends RouteDefinition<infer R, any, any> ? R : unknown, G[K] extends RouteDefinition<any, infer P, any> ? P : unknown, G[K] extends RouteDefinition<any, any, infer B> ? B : unknown>;
 };
 type ApiProxy<T extends ApiDefinition> = {
     [G in keyof T]: ApiGroupProxy<T[G]>;
@@ -139,7 +171,7 @@ type EndpointDefinition$1 = RouteDefinition;
  *   const { data } = useApiQuery(api.cart.list)
  *   const mutation = useApiMutation(api.cart.create)
  */
-declare function endpoint(def: RouteDefinition): RouteDefinition;
+declare function endpoint<TResponse = unknown, TParams = unknown, TBody = unknown>(def: RouteDefinition<TResponse, TParams, TBody>): RouteDefinition<TResponse, TParams, TBody>;
 
 type EndpointDefinition = RouteDefinition;
 interface ResourceConfig<TEndpoints extends Record<string, EndpointDefinition>> {
@@ -271,4 +303,4 @@ declare function mapKeysDeep<T>(value: T, keyCase: KeyCase): T;
 declare function toCamelCase<T>(value: T): T;
 declare function toSnakeCase<T>(value: T): T;
 
-export { type ApiDefinition, type ApiResponse, type CallOptions, type CamelCasedPropertiesDeep, type CamelToSnake, type EndpointCallable, type EndpointDefinition$1 as EndpointDefinition, GenericService, type GenericServiceOptions, type HttpMethod, type Id, type KeyCase, type ParseResult, type ParserSchema, type QueryParams, type ResourceConfig, type ResourceDefinition, type RouteDefinition, type RouteMapper, type RouteParserSchema, type RouteSchema, type RouteSchemaMap, type RouteSchemaValue, type RouteTransform, type RouteTransformMap, type SchemaLike, type ServiceConfig, type SnakeCasedPropertiesDeep, type SnakeToCamel, type UnknownRecord, camelToSnakeKey, createClient$1 as createClient, createClient as createHttpClient, createService, defineApi, endpoint, generateHooks, mapKeysDeep, parseWithSchema, resource, snakeToCamelKey, toCamelCase, toSnakeCase };
+export { type ApiDefinition, type ApiError, type ApiResponse, type CallOptions, type CamelCasedPropertiesDeep, type CamelToSnake, type EndpointCallable, type EndpointCallableOptions, type EndpointDefinition$1 as EndpointDefinition, GenericService, type GenericServiceOptions, type HttpMethod, type Id, type KeyCase, type OptionalIfEmpty, type ParseResult, type ParserSchema, type QueryParams, type ResourceConfig, type ResourceDefinition, type RouteDefinition, type RouteMapper, type RouteParserSchema, type RouteSchema, type RouteSchemaMap, type RouteSchemaValue, type RouteTransform, type RouteTransformMap, type SchemaLike, type ServiceConfig, type SnakeCasedPropertiesDeep, type SnakeToCamel, type UnknownRecord, camelToSnakeKey, createClient$1 as createClient, createClient as createHttpClient, createService, defineApi, endpoint, generateHooks, mapKeysDeep, parseWithSchema, resource, snakeToCamelKey, toCamelCase, toSnakeCase };

package/dist/sdk.d.ts

@@ -7,6 +7,14 @@ interface ServiceConfig {
     timeout?: number;
     retry?: RetryConfig;
     cache?: boolean;
+    validateResponse?: boolean;
+    onValidationError?: (error: unknown, context: {
+        endpoint: string;
+        method: string;
+        path: string;
+        request: unknown;
+        response: unknown;
+    }) => void;
 }
 interface RetryConfig {
     attempts: number;
@@ -16,6 +24,7 @@ interface RetryConfig {
 
 declare class HttpClient {
     private client;
+    readonly config: ServiceConfig;
     constructor(config: ServiceConfig);
     private setupInterceptors;
     setToken(token: string): void;
@@ -56,11 +65,15 @@ interface RouteSchemaMap {
 }
 type RouteSchemaValue = RouteTransform | RouteParserSchema;
 type RouteSchema = RouteSchemaValue | RouteSchemaMap;
-interface RouteDefinition {
+interface ResponseSchema<T> {
+    parse(input: unknown): T;
+}
+interface RouteDefinition<TResponse = unknown, TParams = unknown, TBody = unknown> {
     method: HttpMethod;
     path: string;
     auth?: boolean;
     schema?: RouteSchema;
+    responseSchema?: ResponseSchema<TResponse>;
     mapper?: RouteMapper;
     headers?: Record<string, string>;
     cache?: unknown;
@@ -68,10 +81,13 @@ interface RouteDefinition {
     body?: Record<string, any>;
     params?: Record<string, any>;
     query?: Record<string, any>;
+    _typeResponse?: TResponse;
+    _typeParams?: TParams;
+    _typeBody?: TBody;
 }
 interface ApiDefinition {
     [group: string]: {
-        [action: string]: RouteDefinition;
+        [action: string]: RouteDefinition<any, any, any>;
     };
 }
 
@@ -99,21 +115,37 @@ declare class TokenManager {
     exists(): boolean;
 }
 
-type CallOptions = {
-    params?: Record<string, any>;
+type CallOptions<TParams = unknown, TBody = unknown> = {
+    params?: TParams;
     query?: Record<string, any>;
-    body?: Record<string, any>;
+    body?: TBody;
     headers?: Record<string, string>;
 };
-interface EndpointCallable {
-    <TResponse = unknown>(options?: CallOptions): Promise<TResponse>;
+type EndpointCallableOptions<TParams, TBody> = (unknown extends TParams ? {} : {
+    params: TParams;
+}) & (unknown extends TBody ? {} : {
+    body: TBody;
+}) & {
+    query?: Record<string, any>;
+    headers?: Record<string, string>;
+};
+type OptionalIfEmpty<T> = keyof Omit<T, 'query' | 'headers'> extends never ? [options?: T] : [options: T];
+interface ApiError {
+    message: string;
+    status?: number;
+    errors?: Record<string, string[]>;
+}
+interface EndpointCallable<TResponse = unknown, TParams = unknown, TBody = unknown> {
+    (...args: OptionalIfEmpty<EndpointCallableOptions<TParams, TBody>>): Promise<TResponse>;
     /** Original RouteDefinition — used by useApiQuery / useApiMutation */
-    $def: RouteDefinition;
+    $def: RouteDefinition<TResponse, TParams, TBody>;
     /** Stable TanStack query key: [group, action] */
     $key: string[];
+    /** Consistent query key builder that incorporates params/query if provided */
+    $queryKey: (...args: OptionalIfEmpty<EndpointCallableOptions<TParams, TBody>>) => unknown[];
 }
-type ApiGroupProxy<G extends Record<string, RouteDefinition>> = {
-    [K in keyof G]: EndpointCallable;
+type ApiGroupProxy<G extends Record<string, RouteDefinition<any, any, any>>> = {
+    [K in keyof G]: EndpointCallable<G[K] extends RouteDefinition<infer R, any, any> ? R : unknown, G[K] extends RouteDefinition<any, infer P, any> ? P : unknown, G[K] extends RouteDefinition<any, any, infer B> ? B : unknown>;
 };
 type ApiProxy<T extends ApiDefinition> = {
     [G in keyof T]: ApiGroupProxy<T[G]>;
@@ -139,7 +171,7 @@ type EndpointDefinition$1 = RouteDefinition;
  *   const { data } = useApiQuery(api.cart.list)
  *   const mutation = useApiMutation(api.cart.create)
  */
-declare function endpoint(def: RouteDefinition): RouteDefinition;
+declare function endpoint<TResponse = unknown, TParams = unknown, TBody = unknown>(def: RouteDefinition<TResponse, TParams, TBody>): RouteDefinition<TResponse, TParams, TBody>;
 
 type EndpointDefinition = RouteDefinition;
 interface ResourceConfig<TEndpoints extends Record<string, EndpointDefinition>> {
@@ -271,4 +303,4 @@ declare function mapKeysDeep<T>(value: T, keyCase: KeyCase): T;
 declare function toCamelCase<T>(value: T): T;
 declare function toSnakeCase<T>(value: T): T;
 
-export { type ApiDefinition, type ApiResponse, type CallOptions, type CamelCasedPropertiesDeep, type CamelToSnake, type EndpointCallable, type EndpointDefinition$1 as EndpointDefinition, GenericService, type GenericServiceOptions, type HttpMethod, type Id, type KeyCase, type ParseResult, type ParserSchema, type QueryParams, type ResourceConfig, type ResourceDefinition, type RouteDefinition, type RouteMapper, type RouteParserSchema, type RouteSchema, type RouteSchemaMap, type RouteSchemaValue, type RouteTransform, type RouteTransformMap, type SchemaLike, type ServiceConfig, type SnakeCasedPropertiesDeep, type SnakeToCamel, type UnknownRecord, camelToSnakeKey, createClient$1 as createClient, createClient as createHttpClient, createService, defineApi, endpoint, generateHooks, mapKeysDeep, parseWithSchema, resource, snakeToCamelKey, toCamelCase, toSnakeCase };
+export { type ApiDefinition, type ApiError, type ApiResponse, type CallOptions, type CamelCasedPropertiesDeep, type CamelToSnake, type EndpointCallable, type EndpointCallableOptions, type EndpointDefinition$1 as EndpointDefinition, GenericService, type GenericServiceOptions, type HttpMethod, type Id, type KeyCase, type OptionalIfEmpty, type ParseResult, type ParserSchema, type QueryParams, type ResourceConfig, type ResourceDefinition, type RouteDefinition, type RouteMapper, type RouteParserSchema, type RouteSchema, type RouteSchemaMap, type RouteSchemaValue, type RouteTransform, type RouteTransformMap, type SchemaLike, type ServiceConfig, type SnakeCasedPropertiesDeep, type SnakeToCamel, type UnknownRecord, camelToSnakeKey, createClient$1 as createClient, createClient as createHttpClient, createService, defineApi, endpoint, generateHooks, mapKeysDeep, parseWithSchema, resource, snakeToCamelKey, toCamelCase, toSnakeCase };

package/dist/sdk.js

@@ -87,6 +87,7 @@ function snakeCaseKeys(obj) {
 var import_axios = __toESM(require("axios"));
 var HttpClient = class {
   constructor(config) {
+    this.config = config;
     this.client = import_axios.default.create({
       baseURL: config.baseURL,
       timeout: config.timeout ?? 1e4,
@@ -344,14 +345,35 @@ function defineApi(definition, config) {
         } else {
           response = await client[method](resolvedPath, body, requestConfig);
         }
+        if (client.config.validateResponse && route.responseSchema) {
+          try {
+            response = route.responseSchema.parse(response);
+          } catch (error) {
+            if (client.config.onValidationError) {
+              client.config.onValidationError(error, {
+                endpoint: action,
+                method: route.method,
+                path: resolvedPath,
+                request: { params, query, body, headers: requestConfig.headers },
+                response
+              });
+            }
+            throw error;
+          }
+        } else if (client.config.validateResponse) {
+          response = parseRouteSchema(route, "response", response);
+        }
         return applyMapper(
           route,
           "response",
-          parseRouteSchema(route, "response", response)
+          response
         );
       };
       callable.$def = route;
       callable.$key = [group, action];
+      callable.$queryKey = (options) => {
+        return options ? [group, action, options] : [group, action];
+      };
       groupProxy[action] = callable;
     }
     ;

package/dist/sdk.mjs

@@ -45,6 +45,7 @@ function snakeCaseKeys(obj) {
 import axios from "axios";
 var HttpClient = class {
   constructor(config) {
+    this.config = config;
     this.client = axios.create({
       baseURL: config.baseURL,
       timeout: config.timeout ?? 1e4,
@@ -302,14 +303,35 @@ function defineApi(definition, config) {
         } else {
           response = await client[method](resolvedPath, body, requestConfig);
         }
+        if (client.config.validateResponse && route.responseSchema) {
+          try {
+            response = route.responseSchema.parse(response);
+          } catch (error) {
+            if (client.config.onValidationError) {
+              client.config.onValidationError(error, {
+                endpoint: action,
+                method: route.method,
+                path: resolvedPath,
+                request: { params, query, body, headers: requestConfig.headers },
+                response
+              });
+            }
+            throw error;
+          }
+        } else if (client.config.validateResponse) {
+          response = parseRouteSchema(route, "response", response);
+        }
         return applyMapper(
           route,
           "response",
-          parseRouteSchema(route, "response", response)
+          response
         );
       };
       callable.$def = route;
       callable.$key = [group, action];
+      callable.$queryKey = (options) => {
+        return options ? [group, action, options] : [group, action];
+      };
       groupProxy[action] = callable;
     }
     ;

package/dist/vue.d.mts

@@ -9,6 +9,14 @@ interface ServiceConfig {
     timeout?: number;
     retry?: RetryConfig;
     cache?: boolean;
+    validateResponse?: boolean;
+    onValidationError?: (error: unknown, context: {
+        endpoint: string;
+        method: string;
+        path: string;
+        request: unknown;
+        response: unknown;
+    }) => void;
 }
 interface RetryConfig {
     attempts: number;
@@ -18,6 +26,7 @@ interface RetryConfig {
 
 declare class HttpClient {
     private client;
+    readonly config: ServiceConfig;
     constructor(config: ServiceConfig);
     private setupInterceptors;
     setToken(token: string): void;

package/dist/vue.d.ts

@@ -9,6 +9,14 @@ interface ServiceConfig {
     timeout?: number;
     retry?: RetryConfig;
     cache?: boolean;
+    validateResponse?: boolean;
+    onValidationError?: (error: unknown, context: {
+        endpoint: string;
+        method: string;
+        path: string;
+        request: unknown;
+        response: unknown;
+    }) => void;
 }
 interface RetryConfig {
     attempts: number;
@@ -18,6 +26,7 @@ interface RetryConfig {
 
 declare class HttpClient {
     private client;
+    readonly config: ServiceConfig;
     constructor(config: ServiceConfig);
     private setupInterceptors;
     setToken(token: string): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "routesync",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "description": "Laravel routes to typed frontend SDKs.",
   "main": "./dist/sdk.js",
   "module": "./dist/sdk.mjs",
@@ -61,7 +61,8 @@
     "@types/node": "^20.0.0",
     "tsup": "^8.0.0",
     "turbo": "^2.9.16",
-    "typescript": "^5.4.0"
+    "typescript": "^5.4.0",
+    "vitest": "^4.1.7"
   },
   "engines": {
     "node": ">=20.0.0"