@kizunajs/tanstack-query 2.0.0-beta.12 → 2.0.0-beta.14

package/README.md

@@ -1,6 +1,6 @@
 # @kizunajs/tanstack-query
 
-`@kizunajs/tanstack-query` provides `new KizunaTanstackQuery()`, which builds TanStack Query options from a Kizuna api. Query keys, caching, and invalidation come from the routes you already wrote.
+`@kizunajs/tanstack-query` provides `new KizunaTanstackQuery()`, which builds TanStack Query options from a generated Kizuna fetch client. Query keys, caching, and invalidation come from the routes you already wrote.
 
 ## Installation
 
@@ -13,9 +13,13 @@ pnpm add @kizunajs/tanstack-query
 ```ts
 import { useQuery } from '@tanstack/react-query';
 import { KizunaTanstackQuery } from '@kizunajs/tanstack-query';
-import { apiClient } from './api-client';
+import { createClient } from './api-client.generated';
 
-const api = new KizunaTanstackQuery(apiClient);
+const api = new KizunaTanstackQuery(
+    createClient({
+        baseUrl: 'http://localhost:3000',
+    })
+);
 
 const { data } = useQuery(
     api.users.getUser.queryOptions({

package/dist/index.cjs

@@ -1,7 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 let _tanstack_query_core = require("@tanstack/query-core");
-let kizunajs = require("kizunajs");
-let _kizunajs_fetch = require("@kizunajs/fetch");
 //#region src/errors.ts
 /**
 * Thrown when a route returns a status the api does not declare. Declared
@@ -57,10 +55,9 @@ const buildQueryKey = (segments, input, type) => {
 const buildPathKey = (segments) => [segments];
 //#endregion
 //#region src/proxy.ts
-const declaresStatus = (route, status) => {
-	if (Object.hasOwn(route.responses, String(status))) return true;
-	return status === 400 && ("body" in route || "query" in route);
-};
+const routeOf = (value) => typeof value === "function" ? value["~route"] : void 0;
+const declaresStatus = (route, status) => Object.hasOwn(route.responses, status);
+const streamsStatus = (route, status) => route.responses[status]?.stream === true;
 const withSignal = (args, signal) => {
 	if (signal === void 0) return args;
 	const { fetchOptions, ...rest } = args ?? {};
@@ -81,7 +78,7 @@ const isQueryMethod = (route) => route.method === "GET" || route.method === "HEA
 const buildProcedure = (segments, route, clientFn) => {
 	const routeKey = segments.join(".");
 	const call = (args) => clientFn(args);
-	if ((0, kizunajs.routeStreams)(route)) return {
+	if (route.streams) return {
 		streamOptions: (options) => {
 			const { input, refetchMode, ...rest } = options;
 			const skipped = input === _tanstack_query_core.skipToken;
@@ -90,7 +87,7 @@ const buildProcedure = (segments, route, clientFn) => {
 				queryFn: skipped ? _tanstack_query_core.skipToken : (0, _tanstack_query_core.experimental_streamedQuery)({
 					streamFn: async ({ signal }) => {
 						const result = await runRoute(clientFn, route, routeKey, input, signal);
-						if (!(0, kizunajs.streamStatuses)(route).includes(result.status)) throw new NonStreamResponseError(routeKey, result.status, result.body, result.headers);
+						if (!streamsStatus(route, result.status)) throw new NonStreamResponseError(routeKey, result.status, result.body, result.headers);
 						return result.body;
 					},
 					...refetchMode === void 0 ? {} : { refetchMode }
@@ -146,7 +143,7 @@ const buildNode = (segments, clientNode) => {
 	for (const routeName of Object.keys(clientNode)) {
 		const child = clientNode[routeName];
 		const childSegments = [...segments, routeName];
-		const route = (0, _kizunajs_fetch.routeOf)(child);
+		const route = routeOf(child);
 		if (route) node[routeName] = buildProcedure(childSegments, route, child);
 		else if (child && typeof child === "object") node[routeName] = buildNode(childSegments, child);
 	}
@@ -156,15 +153,19 @@ function buildQueryProxy(client) {
 	return buildNode([], client);
 }
 /**
-* Builds TanStack Query options from a fetch client. Every client method
-* carries the route it answers, so the client is the only argument.
+* Builds TanStack Query options from a generated fetch client. Every client
+* method carries the route it answers, so the client is the only argument.
 *
 * ```ts
 * import { useQuery } from '@tanstack/react-query';
 * import { KizunaTanstackQuery } from '@kizunajs/tanstack-query';
-* import { apiClient } from './api-client.js';
+* import { createClient } from './api-client.generated.js';
 *
-* const api = new KizunaTanstackQuery(apiClient);
+* const api = new KizunaTanstackQuery(
+*     createClient({
+*         baseUrl: 'http://localhost:3000',
+*     })
+* );
 *
 * useQuery(
 *     api.users.listUsers.queryOptions({

package/dist/index.d.cts

@@ -1,6 +1,4 @@
 import { DataTag, DefaultError, InfiniteData, InfiniteQueryObserverOptions, MutationObserverOptions, QueryFunction, QueryFunctionContext, QueryObserverOptions, SkipToken } from "@tanstack/query-core";
-import { RouteDefinition, Routes, StreamResponseDefinition } from "kizunajs";
-import { Client, ClientArgs, ClientMethod, ClientResponse } from "@kizunajs/fetch";
 
 //#region src/types.d.ts
 type KizunaQueryKeyType = 'query' | 'infinite' | 'stream';
@@ -151,43 +149,50 @@ interface StreamProcedure<Args, Result> {
   key: () => KizunaPathKey;
   call: CallFn<Args, Result>;
 }
-type HasStream<R extends RouteDefinition> = { [Status in keyof R['responses']]: R['responses'][Status] extends StreamResponseDefinition ? true : never }[keyof R['responses']] extends never ? false : true;
+/**
+ * A method on a client `@kizunajs/fetch` generates. Its `'~route'` names the
+ * HTTP method it sends and whether its response streams, which is all the
+ * proxy needs to choose its factories.
+ */
+type ClientMethod<Method extends string, Streams extends boolean, Args, Result> = ({} extends Args ? (args?: Args) => Promise<Result> : (args: Args) => Promise<Result>) & {
+  readonly '~route': {
+    readonly method: Method;
+    readonly streams: Streams;
+  };
+};
 /**
  * Which factories a route gets: a streamed response takes `streamOptions`, a
  * `GET` or `HEAD` takes the query factories, and everything else mutates.
  */
 type ProcedureFor<Method, Streams, Args, Result> = Streams extends true ? StreamProcedure<Args, Result> : Method extends 'GET' | 'HEAD' ? QueryProcedure<Args, Result> : MutationProcedure<Args, Result>;
-type Procedure<R extends RouteDefinition, Codes extends string> = ProcedureFor<R['method'], HasStream<R>, ClientArgs<R>, ClientResponse<R, Codes>>;
 /**
- * The route tree, each route carrying its query or mutation factories.
+ * The client's tree, each method carrying its query, mutation, or stream
+ * factories and each group its partial key.
  */
-type KizunaQueryProxy<T extends Routes, Codes extends string = never> = { [K in keyof T as K extends string ? K : never]: T[K] extends RouteDefinition ? Procedure<T[K], Codes> : T[K] extends Routes ? KizunaQueryProxy<T[K], Codes> & PathProcedures : never };
-/**
- * The same tree, read off a generated client instead of off the routes. Each of
- * its methods carries the method it calls and whether that response streams, so
- * the client alone says which factories every route gets.
- */
-type GeneratedQueryProxy<C> = { [K in keyof C as K extends string ? K : never]: C[K] extends ClientMethod<infer Method, infer Streams, infer Args, infer Result> ? ProcedureFor<Method, Streams, Args, Result> : C[K] extends object ? GeneratedQueryProxy<C[K]> & PathProcedures : never };
+type KizunaQueryProxy<C> = { [K in keyof C as K extends string ? K : never]: C[K] extends ClientMethod<infer Method, infer Streams, infer Args, infer Result> ? ProcedureFor<Method, Streams, Args, Result> : C[K] extends object ? KizunaQueryProxy<C[K]> & PathProcedures : never };
 interface KizunaTanstackQueryConstructor {
   /**
-   * The client is the only argument: each of its methods carries the route it
-   * answers, so nothing has to hand over the api a second time.
+   * The generated client is the only argument: each of its methods carries
+   * the route it answers.
    */
-  new <T extends Routes, Codes extends string = never>(client: Client<T, Codes>): KizunaQueryProxy<T, Codes> & PathProcedures;
-  new <C extends object>(client: C): GeneratedQueryProxy<C> & PathProcedures;
+  new <C extends object>(client: C): KizunaQueryProxy<C> & PathProcedures;
 }
 //#endregion
 //#region src/proxy.d.ts
 /**
- * Builds TanStack Query options from a fetch client. Every client method
- * carries the route it answers, so the client is the only argument.
+ * Builds TanStack Query options from a generated fetch client. Every client
+ * method carries the route it answers, so the client is the only argument.
  *
  * ```ts
  * import { useQuery } from '@tanstack/react-query';
  * import { KizunaTanstackQuery } from '@kizunajs/tanstack-query';
- * import { apiClient } from './api-client.js';
+ * import { createClient } from './api-client.generated.js';
  *
- * const api = new KizunaTanstackQuery(apiClient);
+ * const api = new KizunaTanstackQuery(
+ *     createClient({
+ *         baseUrl: 'http://localhost:3000',
+ *     })
+ * );
  *
  * useQuery(
  *     api.users.listUsers.queryOptions({

package/dist/index.d.mts

@@ -1,6 +1,4 @@
 import { DataTag, DefaultError, InfiniteData, InfiniteQueryObserverOptions, MutationObserverOptions, QueryFunction, QueryFunctionContext, QueryObserverOptions, SkipToken } from "@tanstack/query-core";
-import { RouteDefinition, Routes, StreamResponseDefinition } from "kizunajs";
-import { Client, ClientArgs, ClientMethod, ClientResponse } from "@kizunajs/fetch";
 
 //#region src/types.d.ts
 type KizunaQueryKeyType = 'query' | 'infinite' | 'stream';
@@ -151,43 +149,50 @@ interface StreamProcedure<Args, Result> {
   key: () => KizunaPathKey;
   call: CallFn<Args, Result>;
 }
-type HasStream<R extends RouteDefinition> = { [Status in keyof R['responses']]: R['responses'][Status] extends StreamResponseDefinition ? true : never }[keyof R['responses']] extends never ? false : true;
+/**
+ * A method on a client `@kizunajs/fetch` generates. Its `'~route'` names the
+ * HTTP method it sends and whether its response streams, which is all the
+ * proxy needs to choose its factories.
+ */
+type ClientMethod<Method extends string, Streams extends boolean, Args, Result> = ({} extends Args ? (args?: Args) => Promise<Result> : (args: Args) => Promise<Result>) & {
+  readonly '~route': {
+    readonly method: Method;
+    readonly streams: Streams;
+  };
+};
 /**
  * Which factories a route gets: a streamed response takes `streamOptions`, a
  * `GET` or `HEAD` takes the query factories, and everything else mutates.
  */
 type ProcedureFor<Method, Streams, Args, Result> = Streams extends true ? StreamProcedure<Args, Result> : Method extends 'GET' | 'HEAD' ? QueryProcedure<Args, Result> : MutationProcedure<Args, Result>;
-type Procedure<R extends RouteDefinition, Codes extends string> = ProcedureFor<R['method'], HasStream<R>, ClientArgs<R>, ClientResponse<R, Codes>>;
 /**
- * The route tree, each route carrying its query or mutation factories.
+ * The client's tree, each method carrying its query, mutation, or stream
+ * factories and each group its partial key.
  */
-type KizunaQueryProxy<T extends Routes, Codes extends string = never> = { [K in keyof T as K extends string ? K : never]: T[K] extends RouteDefinition ? Procedure<T[K], Codes> : T[K] extends Routes ? KizunaQueryProxy<T[K], Codes> & PathProcedures : never };
-/**
- * The same tree, read off a generated client instead of off the routes. Each of
- * its methods carries the method it calls and whether that response streams, so
- * the client alone says which factories every route gets.
- */
-type GeneratedQueryProxy<C> = { [K in keyof C as K extends string ? K : never]: C[K] extends ClientMethod<infer Method, infer Streams, infer Args, infer Result> ? ProcedureFor<Method, Streams, Args, Result> : C[K] extends object ? GeneratedQueryProxy<C[K]> & PathProcedures : never };
+type KizunaQueryProxy<C> = { [K in keyof C as K extends string ? K : never]: C[K] extends ClientMethod<infer Method, infer Streams, infer Args, infer Result> ? ProcedureFor<Method, Streams, Args, Result> : C[K] extends object ? KizunaQueryProxy<C[K]> & PathProcedures : never };
 interface KizunaTanstackQueryConstructor {
   /**
-   * The client is the only argument: each of its methods carries the route it
-   * answers, so nothing has to hand over the api a second time.
+   * The generated client is the only argument: each of its methods carries
+   * the route it answers.
    */
-  new <T extends Routes, Codes extends string = never>(client: Client<T, Codes>): KizunaQueryProxy<T, Codes> & PathProcedures;
-  new <C extends object>(client: C): GeneratedQueryProxy<C> & PathProcedures;
+  new <C extends object>(client: C): KizunaQueryProxy<C> & PathProcedures;
 }
 //#endregion
 //#region src/proxy.d.ts
 /**
- * Builds TanStack Query options from a fetch client. Every client method
- * carries the route it answers, so the client is the only argument.
+ * Builds TanStack Query options from a generated fetch client. Every client
+ * method carries the route it answers, so the client is the only argument.
  *
  * ```ts
  * import { useQuery } from '@tanstack/react-query';
  * import { KizunaTanstackQuery } from '@kizunajs/tanstack-query';
- * import { apiClient } from './api-client.js';
+ * import { createClient } from './api-client.generated.js';
  *
- * const api = new KizunaTanstackQuery(apiClient);
+ * const api = new KizunaTanstackQuery(
+ *     createClient({
+ *         baseUrl: 'http://localhost:3000',
+ *     })
+ * );
  *
  * useQuery(
  *     api.users.listUsers.queryOptions({

package/dist/index.mjs

@@ -1,6 +1,4 @@
 import { experimental_streamedQuery, skipToken } from "@tanstack/query-core";
-import { routeStreams, streamStatuses } from "kizunajs";
-import { routeOf } from "@kizunajs/fetch";
 //#region src/errors.ts
 /**
 * Thrown when a route returns a status the api does not declare. Declared
@@ -56,10 +54,9 @@ const buildQueryKey = (segments, input, type) => {
 const buildPathKey = (segments) => [segments];
 //#endregion
 //#region src/proxy.ts
-const declaresStatus = (route, status) => {
-	if (Object.hasOwn(route.responses, String(status))) return true;
-	return status === 400 && ("body" in route || "query" in route);
-};
+const routeOf = (value) => typeof value === "function" ? value["~route"] : void 0;
+const declaresStatus = (route, status) => Object.hasOwn(route.responses, status);
+const streamsStatus = (route, status) => route.responses[status]?.stream === true;
 const withSignal = (args, signal) => {
 	if (signal === void 0) return args;
 	const { fetchOptions, ...rest } = args ?? {};
@@ -80,7 +77,7 @@ const isQueryMethod = (route) => route.method === "GET" || route.method === "HEA
 const buildProcedure = (segments, route, clientFn) => {
 	const routeKey = segments.join(".");
 	const call = (args) => clientFn(args);
-	if (routeStreams(route)) return {
+	if (route.streams) return {
 		streamOptions: (options) => {
 			const { input, refetchMode, ...rest } = options;
 			const skipped = input === skipToken;
@@ -89,7 +86,7 @@ const buildProcedure = (segments, route, clientFn) => {
 				queryFn: skipped ? skipToken : experimental_streamedQuery({
 					streamFn: async ({ signal }) => {
 						const result = await runRoute(clientFn, route, routeKey, input, signal);
-						if (!streamStatuses(route).includes(result.status)) throw new NonStreamResponseError(routeKey, result.status, result.body, result.headers);
+						if (!streamsStatus(route, result.status)) throw new NonStreamResponseError(routeKey, result.status, result.body, result.headers);
 						return result.body;
 					},
 					...refetchMode === void 0 ? {} : { refetchMode }
@@ -155,15 +152,19 @@ function buildQueryProxy(client) {
 	return buildNode([], client);
 }
 /**
-* Builds TanStack Query options from a fetch client. Every client method
-* carries the route it answers, so the client is the only argument.
+* Builds TanStack Query options from a generated fetch client. Every client
+* method carries the route it answers, so the client is the only argument.
 *
 * ```ts
 * import { useQuery } from '@tanstack/react-query';
 * import { KizunaTanstackQuery } from '@kizunajs/tanstack-query';
-* import { apiClient } from './api-client.js';
+* import { createClient } from './api-client.generated.js';
 *
-* const api = new KizunaTanstackQuery(apiClient);
+* const api = new KizunaTanstackQuery(
+*     createClient({
+*         baseUrl: 'http://localhost:3000',
+*     })
+* );
 *
 * useQuery(
 *     api.users.listUsers.queryOptions({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kizunajs/tanstack-query",
-  "version": "2.0.0-beta.12",
+  "version": "2.0.0-beta.14",
   "description": "TanStack Query client for Kizuna.js",
   "keywords": [
     "kizunajs",
@@ -56,10 +56,7 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@tanstack/query-core": "^5.69.0",
-    "zod": "^4.0.0",
-    "kizunajs": "2.0.0-beta.12",
-    "@kizunajs/fetch": "2.0.0-beta.12"
+    "@tanstack/query-core": "^5.69.0"
   },
   "devDependencies": {
     "@tanstack/query-core": "^5.101.0",
@@ -73,11 +70,11 @@
     "typescript": "^6.0.3",
     "vue": "^3.5.0",
     "zod": "^4.0.0",
-    "kizunajs": "2.0.0-beta.12",
-    "@kizunajs/fetch": "2.0.0-beta.12"
+    "kizunajs": "2.0.0-beta.14",
+    "@kizunajs/fetch": "2.0.0-beta.14"
   },
   "scripts": {
-    "build": "tsdown src/index.ts --format esm,cjs --dts --clean --external kizunajs --external @kizunajs/fetch --external @tanstack/query-core --external zod",
+    "build": "tsdown src/index.ts --format esm,cjs --dts --clean --external @tanstack/query-core",
     "typecheck": "tsc --noEmit"
   }
 }