@tuyau/react-query 1.0.0-beta.2 → 1.0.0-beta.3

package/README.md

@@ -0,0 +1,11 @@
+# @tuyau/react-query
+
+Tanstack Query integration for Tuyau. Provides hooks and utilities to use Tuyau with React Query.
+
+## Documentation
+
+Available soon.
+
+## License
+
+MIT

package/build/index.d.ts

@@ -1,6 +1,6 @@
-import { SchemaEndpoint, RawRequestArgs, TuyauRegistry, InferTree, AdonisEndpoint, InferRoutes } from '@tuyau/core/types';
+import { SchemaEndpoint, RawRequestArgs, BaseRequestOptions, TuyauRegistry, InferTree, AdonisEndpoint, InferRoutes } from '@tuyau/core/types';
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { SkipToken, DataTag, QueryFilters, WithRequired as WithRequired$1, UseMutationOptions, InfiniteData, InfiniteQueryObserverOptions, DefinedInitialDataOptions, UndefinedInitialDataOptions, UnusedSkipTokenOptions } from '@tanstack/react-query';
+import { SkipToken, DataTag, QueryFilters, WithRequired as WithRequired$1, UseMutationOptions, InfiniteData, UnusedSkipTokenInfiniteOptions, DefinedInitialDataInfiniteOptions, UndefinedInitialDataInfiniteOptions, DefinedInitialDataOptions, UndefinedInitialDataOptions, UnusedSkipTokenOptions } from '@tanstack/react-query';
 import { Tuyau } from '@tuyau/core/client';
 
 type Response$2<E extends SchemaEndpoint> = E['types']['response'];
@@ -55,10 +55,11 @@ interface TuyauMutationOptionsOptions {
 declare function tuyauMutationOptions(options: TuyauMutationOptionsOptions): _tanstack_react_query.WithRequired<UseMutationOptions<unknown, any, any, any>, "mutationKey">;
 
 type Response<E extends SchemaEndpoint> = E['types']['response'];
+type ReservedInfiniteQueryOptions = 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash';
 /**
- * Infinite query options input type
+ * Base infinite query options with Tuyau-specific options
  */
-interface TuyauInfiniteQueryOptionsIn<TQueryFnData, TError, TData> extends DistributiveOmit<InfiniteQueryObserverOptions<TQueryFnData, TError, TData>, 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash'>, TuyauQueryBaseOptions {
+interface TuyauInfiniteQueryBaseOptionsIn {
     /**
      * The key that will be used for the page parameter in the request.
      * For example, if your API expects ?page=1, set this to 'page'.
@@ -67,17 +68,61 @@ interface TuyauInfiniteQueryOptionsIn<TQueryFnData, TError, TData> extends Distr
     pageParamKey?: string;
 }
 /**
- * Infinite query options output type
+ * Infinite query options when initialData is undefined (default case)
  */
-interface TuyauInfiniteQueryOptionsOut<TQueryFnData, TError, TData> extends Omit<InfiniteQueryObserverOptions<TQueryFnData, TError, TData>, 'queryKey'> {
+interface UndefinedTuyauInfiniteQueryOptionsIn<TQueryFnData, TError, TData> extends DistributiveOmit<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TuyauQueryKey, unknown>, ReservedInfiniteQueryOptions>, TuyauQueryBaseOptions, TuyauInfiniteQueryBaseOptionsIn {
+}
+/**
+ * Output type when initialData is undefined - queryFn can be SkipToken
+ */
+interface UndefinedTuyauInfiniteQueryOptionsOut<TQueryFnData, TError, TData> extends DistributiveOmit<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TuyauQueryKey, unknown>, 'queryKey'> {
     queryKey: DataTag<TuyauQueryKey, TData>;
 }
 /**
- * Type definition for infinite query options
+ * Infinite query options when initialData is defined
+ */
+interface DefinedTuyauInfiniteQueryOptionsIn<TQueryFnData, TError, TData> extends DistributiveOmit<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TuyauQueryKey, unknown>, ReservedInfiniteQueryOptions>, TuyauQueryBaseOptions, TuyauInfiniteQueryBaseOptionsIn {
+}
+/**
+ * Output type when initialData is defined - queryFn can be SkipToken
+ */
+interface DefinedTuyauInfiniteQueryOptionsOut<TQueryFnData, TError, TData> extends DistributiveOmit<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TuyauQueryKey, unknown>, 'queryKey'> {
+    queryKey: DataTag<TuyauQueryKey, TData>;
+}
+/**
+ * Infinite query options when SkipToken is NOT used as input.
+ * This makes the result compatible with useSuspenseInfiniteQuery.
+ */
+interface UnusedSkipTokenTuyauInfiniteQueryOptionsIn<TQueryFnData, TError, TData> extends DistributiveOmit<UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TuyauQueryKey, unknown>, ReservedInfiniteQueryOptions>, TuyauQueryBaseOptions, TuyauInfiniteQueryBaseOptionsIn {
+}
+/**
+ * Output type when SkipToken is NOT used - queryFn excludes SkipToken.
+ * This makes it compatible with useSuspenseInfiniteQuery.
+ */
+interface UnusedSkipTokenTuyauInfiniteQueryOptionsOut<TQueryFnData, TError, TData> extends DistributiveOmit<UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TuyauQueryKey, unknown>, 'queryKey'> {
+    queryKey: DataTag<TuyauQueryKey, TData>;
+}
+/**
+ * Type definition for infinite query options with proper overloads.
+ *
+ * Three overloads handle different cases:
+ * 1. Input without SkipToken => Returns type compatible with useSuspenseInfiniteQuery
+ * 2. Input with SkipToken + defined initialData => Returns type with SkipToken possible
+ * 3. Input with SkipToken (default) => Returns type with SkipToken possible
  */
 interface TuyauReactInfiniteQueryOptions<EDef extends SchemaEndpoint> {
-    <TData = InfiniteData<Response<EDef>>>(input: RawRequestArgs<EDef> | SkipToken, opts: TuyauInfiniteQueryOptionsIn<Response<EDef>, unknown, TData>): TuyauInfiniteQueryOptionsOut<Response<EDef>, unknown, TData>;
-    <TData = InfiniteData<Response<EDef>>>(input?: RawRequestArgs<EDef> | SkipToken, opts?: TuyauInfiniteQueryOptionsIn<Response<EDef>, unknown, TData>): TuyauInfiniteQueryOptionsOut<Response<EDef>, unknown, TData>;
+    /**
+     * Overload 1: When input is NOT SkipToken, return options compatible with useSuspenseInfiniteQuery
+     */
+    <TData = InfiniteData<Response<EDef>>>(input: RawRequestArgs<EDef>, opts: UnusedSkipTokenTuyauInfiniteQueryOptionsIn<Response<EDef>, unknown, TData>): UnusedSkipTokenTuyauInfiniteQueryOptionsOut<Response<EDef>, unknown, TData>;
+    /**
+     * Overload 2: When initialData is defined
+     */
+    <TData = InfiniteData<Response<EDef>>>(input: RawRequestArgs<EDef> | SkipToken, opts: DefinedTuyauInfiniteQueryOptionsIn<Response<EDef>, unknown, TData>): DefinedTuyauInfiniteQueryOptionsOut<Response<EDef>, unknown, TData>;
+    /**
+     * Overload 3: Default case - input may be SkipToken, initialData undefined
+     */
+    <TData = InfiniteData<Response<EDef>>>(input?: RawRequestArgs<EDef> | SkipToken, opts?: UndefinedTuyauInfiniteQueryOptionsIn<Response<EDef>, unknown, TData>): UndefinedTuyauInfiniteQueryOptionsOut<Response<EDef>, unknown, TData>;
 }
 /**
  * Decorate query endpoints with infinite query capabilities
@@ -142,16 +187,19 @@ interface UnusedSkipTokenTuyauQueryOptionsOut<TQueryFnData, TData, TError> exten
 /**
  * Tuyau-specific request options for React Query integration
  */
-interface TuyauReactRequestOptions {
+interface TuyauReactRequestOptions extends BaseRequestOptions {
     /**
      * Opt out or into aborting request on unmount
      */
     abortOnUnmount?: boolean;
 }
 /**
- * Base options for Tuyau queries
+ * Base options for Tuyau queries and mutations
  */
 interface TuyauQueryBaseOptions {
+    /**
+     * Tuyau-specific options including Ky request options (timeout, retry, headers, etc.)
+     */
     tuyau?: TuyauReactRequestOptions;
 }
 interface DecorateRouterKeyable {

package/build/index.js

@@ -38,6 +38,11 @@ function buildKey(opts) {
     }
   ];
 }
+function extractKyOptions(tuyauOpts) {
+  if (!tuyauOpts) return {};
+  const { abortOnUnmount, ...kyOptions } = tuyauOpts;
+  return kyOptions;
+}
 
 // src/query.ts
 import { queryOptions, skipToken as skipToken2 } from "@tanstack/react-query";
@@ -47,8 +52,10 @@ function tuyauQueryOptions(options) {
     if (request === skipToken2) return skipToken2;
     return async (queryFnContext) => {
       const effectiveAbortOnUnmount = opts?.tuyau?.abortOnUnmount ?? globalOptions?.abortOnUnmount ?? false;
+      const kyOptions = extractKyOptions(opts?.tuyau);
       return await client.request(routeName, {
         ...request,
+        ...kyOptions,
         retry: 0,
         ...effectiveAbortOnUnmount ? { signal: queryFnContext.signal } : {}
       });
@@ -66,6 +73,7 @@ function tuyauInfiniteQueryOptions(options) {
     return async (queryFnContext) => {
       const { pageParam } = queryFnContext;
       const effectiveAbortOnUnmount = opts?.tuyau?.abortOnUnmount ?? globalOptions?.abortOnUnmount ?? false;
+      const kyOptions = extractKyOptions(opts?.tuyau);
       const pageParamKey = opts?.pageParamKey || "page";
       let requestArgs;
       if (typeof request === "object" && request !== null) {
@@ -82,6 +90,7 @@ function tuyauInfiniteQueryOptions(options) {
       }
       return await client.request(routeName, {
         ...requestArgs,
+        ...kyOptions,
         retry: 0,
         ...effectiveAbortOnUnmount ? { signal: queryFnContext.signal } : {}
       });
@@ -106,9 +115,10 @@ function getMutationKeyInternal(options) {
 function tuyauMutationOptions(options) {
   const { opts, routeName, client } = options;
   const mutationKey = getMutationKeyInternal({ segments: routeName.split(".") });
+  const kyOptions = extractKyOptions(opts?.tuyau);
   const mutationFn = async (request) => {
     const requestArgs = request || {};
-    return await client.request(routeName, { ...requestArgs, retry: 0 });
+    return await client.request(routeName, { ...requestArgs, ...kyOptions, retry: 0 });
   };
   return mutationOptions({ ...opts, mutationKey, mutationFn });
 }

package/package.json

@@ -1,11 +1,27 @@
 {
   "name": "@tuyau/react-query",
   "type": "module",
-  "version": "1.0.0-beta.2",
-  "description": "React Query plugin for Tuyau",
+  "version": "1.0.0-beta.3",
+  "description": "Tanstack Query integration for Tuyau",
   "author": "Julien Ripouteau <julien@ripouteau.com>",
-  "license": "ISC",
-  "keywords": [],
+  "license": "MIT",
+  "homepage": "https://github.com/Julien-R44/tuyau#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Julien-R44/tuyau.git",
+    "directory": "packages/react-query"
+  },
+  "bugs": {
+    "url": "https://github.com/Julien-R44/tuyau/issues"
+  },
+  "keywords": [
+    "adonisjs",
+    "typescript",
+    "typesafe",
+    "react-query",
+    "tanstack-query",
+    "tuyau"
+  ],
   "exports": {
     ".": "./build/index.js"
   },
@@ -18,18 +34,18 @@
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.74.7",
-    "@tuyau/core": "1.0.0-beta.2"
+    "@tuyau/core": "^1.0.0-beta.9"
   },
   "devDependencies": {
-    "@adonisjs/core": "^7.0.0-next.13",
+    "@adonisjs/core": "^7.0.0-next.16",
     "@faker-js/faker": "^10.1.0",
     "@happy-dom/global-registrator": "^20.0.11",
-    "@tanstack/react-query": "^5.90.12",
-    "@testing-library/react": "^16.3.0",
+    "@tanstack/react-query": "^5.90.14",
+    "@testing-library/react": "^16.3.1",
     "@types/react": "^19.2.7",
-    "@vinejs/vine": "^4.1.0",
-    "react": "^19.2.1",
-    "@tuyau/core": "1.0.0-beta.6"
+    "@vinejs/vine": "^4.2.0",
+    "react": "^19.2.3",
+    "@tuyau/core": "1.0.0-beta.9"
   },
   "tsup": {
     "entry": [