@tuyau/react-query 0.0.1-next.0 → 0.0.1-next.2

package/build/index.d.ts

@@ -21,7 +21,7 @@ interface TuyauReactQueryOptions<EDef extends EndpointDef, TParams = Record<stri
     } | SkipToken, opts?: UndefinedTuyauQueryOptionsIn<UnionFromSuccessStatuses<EDef['response']>, TData, any>): UndefinedTuyauQueryOptionsOut<UnionFromSuccessStatuses<EDef['response']>, TData, any>;
 }
 /**
- * Interface for query function decorators (queryOptions, queryKey, queryFilter)
+ * Interface for query function decorators
  */
 interface DecorateQueryFn<EDef extends EndpointDef, TParams = Record<string, string | number>> extends TypeHelper<EDef> {
     queryOptions: TuyauReactQueryOptions<EDef, TParams>;
@@ -45,14 +45,17 @@ interface DecorateMutationFn<EDef extends EndpointDef, TParams = Record<string,
 /**
  * Output type for mutation options
  */
-interface TuyauMutationOptionsOut<TInput, TError, TOutput, TContext, TParams = Record<string, string | number>> extends UseMutationOptions<TOutput, TError, {
+interface TuyauMutationOptionsOut<TInput, TError, TOutput, TContext, TParams = Record<string, string | number>> extends UseMutationOptions<TOutput, TError, TInput extends undefined | {} | Record<string, never> | unknown ? {
+    payload?: TInput;
+    params?: TParams;
+} : {
     payload: TInput;
     params?: TParams;
 }, TContext> {
     mutationKey: TuyauMutationKey;
 }
 /**
- * Type definition for mutation options with params and payload support
+ * Type definition for mutation options
  */
 interface TuyauReactMutationOptions<TDef extends EndpointDef, TParams = Record<string, string | number>> {
     <TContext = unknown>(opts?: TuyauMutationOptionsIn<TDef['request'], any, UnionFromSuccessStatuses<TDef['response']>, TContext, TParams>): TuyauMutationOptionsOut<TDef['request'], any, UnionFromSuccessStatuses<TDef['response']>, TContext, TParams>;
@@ -95,38 +98,38 @@ type WithRequired<T, K extends keyof T> = T & Required<Pick<T, K>>;
 /**
  * Query options with defined initial data
  */
-interface DefinedTuyauQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<DefinedInitialDataOptions<TQueryFnData, TError, TData, TuyauQueryKey>, 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash'> {
+interface DefinedTuyauQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<DefinedInitialDataOptions<TQueryFnData, TError, TData, TuyauQueryKey>, 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash'>, TuyauQueryBaseOptions {
 }
 /**
  * Query options with undefined initial data
  */
-interface UndefinedTuyauQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TuyauQueryKey>, 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash'> {
+interface UndefinedTuyauQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TuyauQueryKey>, 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash'>, TuyauQueryBaseOptions {
 }
 /**
  * Query options with unused skip token
  */
-interface UnusedSkipTokenTuyauQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<UnusedSkipTokenOptions<TQueryFnData, TError, TData, TuyauQueryKey>, 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash'> {
+interface UnusedSkipTokenTuyauQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<UnusedSkipTokenOptions<TQueryFnData, TError, TData, TuyauQueryKey>, 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash'>, TuyauQueryBaseOptions {
 }
 /**
  * Output type for query options with defined initial data
  */
-interface DefinedTuyauQueryOptionsOut<TQueryFnData, TData, TError> extends DefinedInitialDataOptions<TQueryFnData, TError, TData, TuyauQueryKey> {
+interface DefinedTuyauQueryOptionsOut<TQueryFnData, TData, TError> extends DefinedInitialDataOptions<TQueryFnData, TError, TData, TuyauQueryKey>, TuyauQueryOptionsResult {
     queryKey: DataTag<TuyauQueryKey, TData, TError>;
 }
 /**
  * Output type for query options with undefined initial data
  */
-interface UndefinedTuyauQueryOptionsOut<TQueryFnData, TData, TError> extends UndefinedInitialDataOptions<TQueryFnData, TError, TData, TuyauQueryKey> {
+interface UndefinedTuyauQueryOptionsOut<TQueryFnData, TData, TError> extends UndefinedInitialDataOptions<TQueryFnData, TError, TData, TuyauQueryKey>, TuyauQueryOptionsResult {
     queryKey: DataTag<TuyauQueryKey, TData, TError>;
 }
 /**
  * Output type for query options with unused skip token
  */
-interface UnusedSkipTokenTuyauQueryOptionsOut<TQueryFnData, TData, TError> extends UnusedSkipTokenOptions<TQueryFnData, TError, TData, TuyauQueryKey> {
+interface UnusedSkipTokenTuyauQueryOptionsOut<TQueryFnData, TData, TError> extends UnusedSkipTokenOptions<TQueryFnData, TError, TData, TuyauQueryKey>, TuyauQueryOptionsResult {
     queryKey: DataTag<TuyauQueryKey, TData, TError>;
 }
 /**
- * Input type for mutation options with params and payload support
+ * Input type for mutation options
  */
 interface TuyauMutationOptionsIn<TInput, TError, TOutput, TContext, TParams = Record<string, string | number>> extends DistributiveOmit<UseMutationOptions<TOutput, TError, {
     payload: TInput;
@@ -160,7 +163,34 @@ type InferRequestType<Endpoint extends DecorateQueryFn<any> | DecorateMutationFn
 /**
  * Infer response type from an endpoint
  */
-type InferResponseType<Endpoint extends DecorateQueryFn<any> | DecorateMutationFn<any>> = Endpoint['~types']['response'];
+type InferResponseType<Endpoint extends DecorateQueryFn<any> | DecorateMutationFn<any>> = Endpoint['~types']['response']['200'];
+/**
+ * Tuyau-specific request options for React Query integration
+ */
+interface TuyauReactRequestOptions {
+    /**
+     * Opt out or into aborting request on unmount
+     */
+    abortOnUnmount?: boolean;
+}
+/**
+ * Base options for Tuyau queries
+ */
+interface TuyauQueryBaseOptions {
+    /**
+     * Tuyau-related options
+     */
+    tuyau?: TuyauReactRequestOptions;
+}
+/**
+ * Result interface for Tuyau query options
+ */
+interface TuyauQueryOptionsResult {
+    tuyau: {
+        path: string[];
+        type: 'query';
+    };
+}
 
 /**
  * Reserved infinite query options that should not be overridden
@@ -176,17 +206,21 @@ type TuyauInfiniteData<TData> = {
 /**
  * Infinite query options with undefined initial data
  */
-interface UndefinedTuyauInfiniteQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TuyauInfiniteData<TData>, TuyauQueryKey, unknown>, InfiniteQueryReservedOptions> {
+interface UndefinedTuyauInfiniteQueryOptionsIn<TQueryFnData, TData, TError, TRequest, TPageParamKey extends keyof TRequest> extends DistributiveOmit<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TuyauInfiniteData<TData>, TuyauQueryKey, ExtractPageParamType<TRequest, TPageParamKey> | null>, InfiniteQueryReservedOptions>, TuyauQueryBaseOptions {
+    pageParamKey: TPageParamKey;
 }
 /**
  * Infinite query options with defined initial data
  */
-interface DefinedTuyauInfiniteQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TuyauInfiniteData<TData>, TuyauQueryKey, unknown>, InfiniteQueryReservedOptions> {
+interface DefinedTuyauInfiniteQueryOptionsIn<TQueryFnData, TData, TError, TRequest, TPageParamKey extends keyof TRequest> extends DistributiveOmit<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TuyauInfiniteData<TData>, TuyauQueryKey, ExtractPageParamType<TRequest, TPageParamKey> | null>, InfiniteQueryReservedOptions>, TuyauQueryBaseOptions {
+    pageParamKey: TPageParamKey;
 }
+type ExtractPageParamType<TRequest, TPageParamKey extends keyof TRequest> = TRequest[TPageParamKey];
 /**
  * Infinite query options with unused skip token
  */
-interface UnusedSkipTokenTuyauInfiniteQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TuyauInfiniteData<TData>, TuyauQueryKey, unknown>, InfiniteQueryReservedOptions> {
+interface UnusedSkipTokenTuyauInfiniteQueryOptionsIn<TQueryFnData, TData, TError, TRequest, TPageParamKey extends keyof TRequest> extends DistributiveOmit<UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TuyauInfiniteData<TData>, TuyauQueryKey, ExtractPageParamType<TRequest, TPageParamKey>>, InfiniteQueryReservedOptions>, TuyauQueryBaseOptions {
+    pageParamKey: TPageParamKey;
 }
 /**
  * Output type for infinite query options with undefined initial data
@@ -222,18 +256,18 @@ interface UnusedSkipTokenTuyauInfiniteQueryOptionsOut<TQueryFnData, TData, TErro
  * Type definition for infinite query options with overloads for different scenarios
  */
 interface TuyauReactInfiniteQueryOptions<EDef extends EndpointDef, TParams = Record<string, string | number>> {
-    <TData = UnionFromSuccessStatuses<EDef['response']>>(input: {
-        payload?: EDef['request'];
+    <TData = UnionFromSuccessStatuses<EDef['response']>, TPageParamKey extends keyof EDef['request'] = string>(input: {
+        payload?: Omit<EDef['request'], TPageParamKey>;
         params?: TParams;
-    } | SkipToken, opts: DefinedTuyauInfiniteQueryOptionsIn<UnionFromSuccessStatuses<EDef['response']>, TData, any>): DefinedTuyauInfiniteQueryOptionsOut<UnionFromSuccessStatuses<EDef['response']>, TData, any>;
-    <TData = UnionFromSuccessStatuses<EDef['response']>>(input: {
-        payload?: EDef['request'];
+    } | SkipToken, opts: DefinedTuyauInfiniteQueryOptionsIn<UnionFromSuccessStatuses<EDef['response']>, TData, any, EDef['request'], TPageParamKey>): DefinedTuyauInfiniteQueryOptionsOut<UnionFromSuccessStatuses<EDef['response']>, TData, any>;
+    <TData = UnionFromSuccessStatuses<EDef['response']>, TPageParamKey extends keyof EDef['request'] = string>(input: {
+        payload?: Omit<EDef['request'], TPageParamKey>;
         params?: TParams;
-    }, opts: UnusedSkipTokenTuyauInfiniteQueryOptionsIn<UnionFromSuccessStatuses<EDef['response']>, TData, any>): UnusedSkipTokenTuyauInfiniteQueryOptionsOut<UnionFromSuccessStatuses<EDef['response']>, TData, any>;
-    <TData = UnionFromSuccessStatuses<EDef['response']>>(input?: {
-        payload?: EDef['request'];
+    }, opts: UnusedSkipTokenTuyauInfiniteQueryOptionsIn<UnionFromSuccessStatuses<EDef['response']>, TData, any, EDef['request'], TPageParamKey>): UnusedSkipTokenTuyauInfiniteQueryOptionsOut<UnionFromSuccessStatuses<EDef['response']>, TData, any>;
+    <TData = UnionFromSuccessStatuses<EDef['response']>, TPageParamKey extends keyof EDef['request'] = string>(input?: {
+        payload?: Omit<EDef['request'], TPageParamKey>;
         params?: TParams;
-    } | SkipToken, opts?: UndefinedTuyauInfiniteQueryOptionsIn<UnionFromSuccessStatuses<EDef['response']>, TData, any>): UndefinedTuyauInfiniteQueryOptionsOut<UnionFromSuccessStatuses<EDef['response']>, TData, any>;
+    } | SkipToken, opts?: UndefinedTuyauInfiniteQueryOptionsIn<UnionFromSuccessStatuses<EDef['response']>, TData, any, EDef['request'], TPageParamKey>): UndefinedTuyauInfiniteQueryOptionsOut<UnionFromSuccessStatuses<EDef['response']>, TData, any>;
 }
 /**
  * Interface for infinite query function decorators
@@ -251,12 +285,20 @@ interface DecorateInfiniteQueryFn<EDef extends EndpointDef, TParams = Record<str
 }
 
 /**
- * Create the Tuyau React Query client
+ * Options for configuring the Tuyau React Query client
  */
-declare function createTuyauReactQueryClient<D extends Record<string, any>, R extends GeneratedRoutes>(options: {
+interface TuyauReactQueryClientOptions<D extends Record<string, any>, R extends GeneratedRoutes> {
     client: TuyauClient<D, R>;
     queryClient: QueryClient | (() => QueryClient);
-}): TuyauReactQuery<D> & DecorateRouterKeyable;
+    /**
+     * Global Tuyau-specific request options
+     */
+    globalOptions?: TuyauReactRequestOptions;
+}
+/**
+ * Create the Tuyau React Query client
+ */
+declare function createTuyauReactQueryClient<D extends Record<string, any>, R extends GeneratedRoutes>(options: TuyauReactQueryClientOptions<D, R>): TuyauReactQuery<D> & DecorateRouterKeyable;
 /**
  * Main type for the Tuyau React Query client
  * Maps route definitions to appropriate query or mutation decorators
@@ -288,7 +330,7 @@ type CreateParamFunction<Route extends Record<string, any>, Path extends string,
  * Create the parameter property mappings
  */
 type CreateParamProperties<Route extends Record<string, any>, Path extends string, NotProvidedParams> = {
-    [K in keyof Route as K extends `:${string}` ? K : never]: TuyauReactQuery<Route[K], NotProvidedParams & PathParamToObject<Path>>;
+    [K in keyof Route as K extends `:${string}` ? K : never]: TuyauReactQuery<Route[K], NotProvidedParams & PathParamToObject<Path>> & DecorateRouterKeyable;
 };
 /**
  * Type for handling route parameters

package/build/index.js

@@ -69,11 +69,20 @@ function getQueryKeyInternal(path, input, type) {
   ];
 }
 function tuyauQueryOptions(options) {
-  const { input, opts, queryKey, path, client } = options;
+  const { input, opts, queryKey, path, client, globalOptions } = options;
   const inputIsSkipToken = input === skipToken;
-  const queryFn = inputIsSkipToken ? skipToken : async () => {
+  const queryFn = inputIsSkipToken ? skipToken : async (queryFnContext) => {
     const { payload, requestPath } = extractInputAndPath(input, path);
-    return await client.$fetch({ paths: requestPath, input: payload });
+    const effectiveAbortOnUnmount = opts?.tuyau?.abortOnUnmount ?? globalOptions?.abortOnUnmount ?? false;
+    const actualOpts = {
+      ...opts,
+      tuyau: {
+        ...globalOptions,
+        ...opts?.tuyau,
+        ...effectiveAbortOnUnmount ? { signal: queryFnContext.signal } : { signal: null }
+      }
+    };
+    return await client.$fetch({ paths: requestPath, input: payload, queryOptions: actualOpts });
   };
   return Object.assign(queryOptions({ ...opts, queryKey, queryFn }), {
     tuyau: { path, type: "query" }
@@ -93,21 +102,40 @@ import {
   infiniteQueryOptions,
   skipToken as skipToken2
 } from "@tanstack/react-query";
-function extractInfiniteInputAndPath(input, path) {
+function extractInfiniteInputAndPath(input, path, pageParamKey, pageParam) {
   if (typeof input !== "object" || input === null || !("payload" in input) && !("params" in input)) {
     const payload2 = typeof input === "object" && input !== null ? input : {};
-    return { payload: payload2, requestPath: path };
+    const enhancedPayload2 = { ...payload2, [pageParamKey]: pageParam };
+    return { payload: enhancedPayload2, requestPath: path };
   }
   const { payload, params } = input;
   const requestPath = buildRequestPath(path, params);
-  return { payload, requestPath };
+  const enhancedPayload = { ...payload, [pageParamKey]: pageParam };
+  return { payload: enhancedPayload, requestPath };
 }
 function tuyauInfiniteQueryOptions(options) {
-  const { input, opts, queryKey, path, client } = options;
+  const { input, opts, queryKey, path, client, globalOptions } = options;
   const inputIsSkipToken = input === skipToken2;
-  const queryFn = inputIsSkipToken ? skipToken2 : async () => {
-    const { payload, requestPath } = extractInfiniteInputAndPath(input, path);
-    return await client.$fetch({ paths: requestPath, input: payload });
+  if (!opts?.pageParamKey) {
+    throw new Error("pageParamKey is required for infinite queries");
+  }
+  const queryFn = inputIsSkipToken ? skipToken2 : async (queryFnContext) => {
+    const { payload, requestPath } = extractInfiniteInputAndPath(
+      input,
+      path,
+      opts.pageParamKey,
+      queryFnContext.pageParam
+    );
+    const effectiveAbortOnUnmount = opts?.tuyau?.abortOnUnmount ?? globalOptions?.abortOnUnmount ?? false;
+    const actualOpts = {
+      ...opts,
+      tuyau: {
+        ...globalOptions,
+        ...opts?.tuyau,
+        ...effectiveAbortOnUnmount ? { signal: queryFnContext.signal } : { signal: null }
+      }
+    };
+    return await client.$fetch({ paths: requestPath, input: payload, queryOptions: actualOpts });
   };
   return Object.assign(
     infiniteQueryOptions({
@@ -121,16 +149,13 @@ function tuyauInfiniteQueryOptions(options) {
 }
 
 // src/mutation.ts
+import {
+  mutationOptions
+} from "@tanstack/react-query";
 function getMutationKeyInternal(path) {
   const splitPath = path.flatMap((part) => part.toString().split("."));
   return splitPath.length ? [splitPath] : [];
 }
-function createTuyauOptionsResult(opts) {
-  return {
-    path: opts.path,
-    type: "mutation"
-  };
-}
 function tuyauMutationOptions(args) {
   const { opts, path, client, overrides } = args;
   const queryClient = unwrapLazyArg(args.queryClient);
@@ -143,23 +168,20 @@ function tuyauMutationOptions(args) {
     const requestPath = buildRequestPath(path, input.params);
     return await client.$fetch({ paths: requestPath, input: input.payload });
   };
-  return {
-    ...opts,
-    mutationKey,
-    mutationFn,
-    onSuccess(data, variables, context) {
-      const originalFn = () => {
-        if (opts?.onSuccess) return opts.onSuccess(data, variables, context);
-        if (defaultOpts?.onSuccess) return defaultOpts.onSuccess(data, variables, context);
-      };
-      return mutationSuccessOverride({
-        originalFn,
-        queryClient,
-        meta: opts?.meta ?? defaultOpts?.meta ?? {}
-      });
-    },
-    tuyau: createTuyauOptionsResult({ path })
+  const onSuccess = (data, variables, context) => {
+    const originalFn = () => {
+      if (opts?.onSuccess) return opts.onSuccess(data, variables, context);
+      if (defaultOpts?.onSuccess) return defaultOpts.onSuccess(data, variables, context);
+    };
+    return mutationSuccessOverride({
+      originalFn,
+      queryClient,
+      meta: opts?.meta ?? defaultOpts?.meta ?? {}
+    });
   };
+  return Object.assign(mutationOptions({ ...opts, mutationKey, mutationFn, onSuccess }), {
+    tuyau: { path, type: "mutation" }
+  });
 }
 
 // src/main.ts
@@ -176,7 +198,8 @@ function createTuyauReactQueryClient(options) {
         queryKey: getQueryKeyInternal(patternPath, arg1, "query"),
         queryClient: unwrapLazyArg(options.queryClient),
         client: options.client,
-        path
+        path,
+        globalOptions: options.globalOptions
       });
     }
     if (fnName === "infiniteQueryOptions") {
@@ -186,7 +209,8 @@ function createTuyauReactQueryClient(options) {
         queryKey: getQueryKeyInternal(patternPath, arg1, "infinite"),
         queryClient: unwrapLazyArg(options.queryClient),
         client: options.client,
-        path
+        path,
+        globalOptions: options.globalOptions
       });
     }
     if (fnName === "queryKey") return getQueryKeyInternal(patternPath, arg1, "query");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tuyau/react-query",
   "type": "module",
-  "version": "0.0.1-next.0",
+  "version": "0.0.1-next.2",
   "description": "React Query plugin for Tuyau",
   "author": "Julien Ripouteau <julien@ripouteau.com>",
   "license": "ISC",
@@ -21,15 +21,15 @@
     "@tuyau/utils": "0.0.9"
   },
   "devDependencies": {
-    "@adonisjs/core": "^6.18.0",
-    "@happy-dom/global-registrator": "^17.4.7",
-    "@tanstack/react-query": "^5.76.1",
+    "@adonisjs/core": "^6.19.0",
+    "@happy-dom/global-registrator": "^17.6.3",
+    "@tanstack/react-query": "^5.83.0",
     "@testing-library/react": "^16.3.0",
-    "@types/react": "^19.1.4",
+    "@types/react": "^19.1.8",
     "@vinejs/vine": "^3.0.1",
-    "nock": "^14.0.4",
+    "nock": "^14.0.6",
     "react": "^19.1.0",
-    "@tuyau/client": "0.2.11-next.0"
+    "@tuyau/client": "0.2.11-next.2"
   },
   "tsup": {
     "entry": [