@questpie/tanstack-query 3.14.0 → 3.15.1

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { DefaultError, QueryKey, UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
 import { ApplyQuery, CollectionRelations, CollectionSelect, FindManyOptions, FindOneOptionsBase, FindResult, GetCollection, GetGlobal, GlobalRelations, GlobalSelect, QuestpieApp, QuestpieClient, RealtimeAPI, ResolveRelationsDeep, TopicConfig, With, buildCollectionTopic, buildGlobalTopic } from "questpie/client";
+import { AnyChannelDefinition, ChannelParamsOf, ChannelPresenceOf } from "questpie/channels";
 
 //#region src/index.d.ts
 type QuestpieQueryErrorMap = (error: unknown) => unknown;
@@ -20,8 +21,8 @@ type QueryBuilder<TFn extends AnyAsyncFn> = HasArgs<TFn> extends false ? () => U
 type RealtimeQueryConfig = {
   /**
    * Subscribe the query to live snapshots over the multiplexed SSE stream.
-   * Initial data comes from a normal fetch; afterwards the server pushes
-   * full snapshots on every matching change (via `experimental_streamedQuery`).
+   * The server supplies both the initial value and later full snapshots through
+   * the same stream (via `experimental_streamedQuery`).
    */
   realtime?: boolean;
 };
@@ -37,6 +38,23 @@ type MutationBuilder<TVariables, TData> = () => UseMutationOptions<TData, Defaul
 type CollectionKeys<TApp extends QuestpieApp> = Extract<keyof QuestpieClient<TApp>["collections"], string>;
 /** Extract global keys from QuestpieClient */
 type GlobalKeys<TApp extends QuestpieApp> = Extract<keyof QuestpieClient<TApp>["globals"], string>;
+/** Extract generated channel registry keys without client control properties. */
+type ChannelKeys<TApp extends QuestpieApp> = Extract<keyof NonNullable<TApp["channels"]>, string>;
+type ChannelIter<TApp extends QuestpieApp, K$1 extends ChannelKeys<TApp>> = QuestpieClient<TApp>["channels"][K$1] extends {
+  iter: infer TIter;
+} ? TIter extends ((...args: infer _TArgs) => AsyncGenerator<unknown, void, unknown>) ? TIter : never : never;
+type ChannelIterMessage<TIter> = TIter extends ((...args: infer _TArgs) => AsyncGenerator<infer TMessage, void, unknown>) ? TMessage : never;
+type ChannelDefinition<TApp extends QuestpieApp, K$1 extends ChannelKeys<TApp>> = NonNullable<TApp["channels"]>[K$1] extends AnyChannelDefinition ? NonNullable<TApp["channels"]>[K$1] : never;
+type ChannelPresenceOptionsAPI<TApp extends QuestpieApp, K$1 extends ChannelKeys<TApp>> = [ChannelPresenceOf<ChannelDefinition<TApp, K$1>>] extends [never] ? {} : keyof ChannelParamsOf<ChannelDefinition<TApp, K$1>> extends never ? {
+  presence: () => UseQueryOptions<readonly ChannelPresenceOf<ChannelDefinition<TApp, K$1>>[]>;
+} : {
+  presence: (params: ChannelParamsOf<ChannelDefinition<TApp, K$1>>) => UseQueryOptions<readonly ChannelPresenceOf<ChannelDefinition<TApp, K$1>>[]>;
+};
+type ChannelSubscriptionOptionsAPI<TApp extends QuestpieApp, K$1 extends ChannelKeys<TApp>> = (keyof ChannelParamsOf<ChannelDefinition<TApp, K$1>> extends never ? {
+  subscription: () => UseQueryOptions<readonly ChannelIterMessage<ChannelIter<TApp, K$1>>[]>;
+} : {
+  subscription: (params: ChannelParamsOf<ChannelDefinition<TApp, K$1>>) => UseQueryOptions<readonly ChannelIterMessage<ChannelIter<TApp, K$1>>[]>;
+}) & ChannelPresenceOptionsAPI<TApp, K$1>;
 type CollectionSelectOf<TApp extends QuestpieApp, K$1 extends CollectionKeys<TApp>> = CollectionSelect<GetCollection<TApp["collections"], K$1>>;
 type CollectionRelationsOf<TApp extends QuestpieApp, K$1 extends CollectionKeys<TApp>> = ResolveRelationsDeep<CollectionRelations<GetCollection<TApp["collections"], K$1>>, TApp["collections"]>;
 type GlobalSelectOf<TApp extends QuestpieApp, K$1 extends GlobalKeys<TApp>> = GlobalSelect<GetGlobal<NonNullable<TApp["globals"]>, K$1>>;
@@ -120,6 +138,7 @@ type GlobalQueryOptionsAPI<TApp extends QuestpieApp, K$1 extends GlobalKeys<TApp
 type QuestpieQueryOptionsProxy<TApp extends QuestpieApp = QuestpieApp> = {
   collections: { [K in CollectionKeys<TApp>]: CollectionQueryOptionsAPI<TApp, K> };
   globals: { [K in GlobalKeys<TApp>]: GlobalQueryOptionsAPI<TApp, K> };
+  channels: { [K in ChannelKeys<TApp>]: ChannelSubscriptionOptionsAPI<TApp, K> };
   routes: RoutesQueryOptionsAPI<QuestpieClient<TApp>["routes"]>;
   custom: {
     query: <TData>(config: {

package/dist/index.mjs

@@ -39,37 +39,11 @@ const wrapMutationFn = (mutationFn, errorMap) => {
 	};
 };
 async function* streamRealtimeQuery(options) {
-	const { initialFetch, realtime, topic, signal, errorMap } = options;
-	const queue = [];
-	let resolveNext = null;
-	const notify = () => {
-		resolveNext?.();
-		resolveNext = null;
-	};
-	const handleAbort = () => notify();
-	const unsubscribe = realtime.subscribe(topic, (data) => {
-		queue.push(data);
-		notify();
-	}, signal);
-	signal?.addEventListener("abort", handleAbort, { once: true });
+	const { realtime, topic, signal, errorMap } = options;
 	try {
-		try {
-			yield await initialFetch();
-		} catch (error) {
-			throw errorMap(error);
-		}
-		while (!signal?.aborted) {
-			while (queue.length > 0) yield queue.shift();
-			if (signal?.aborted) break;
-			await new Promise((resolve) => {
-				resolveNext = resolve;
-			});
-			resolveNext = null;
-		}
-	} finally {
-		signal?.removeEventListener("abort", handleAbort);
-		unsubscribe();
-		resolveNext = null;
+		for await (const snapshot of realtime.stream(topic, signal)) yield snapshot;
+	} catch (error) {
+		throw errorMap(error);
 	}
 }
 /**
@@ -118,7 +92,6 @@ function createQuestpieQueryOptions(client, config = {}) {
 						queryKey: qKey,
 						queryFn: experimental_streamedQuery({
 							streamFn: ({ signal }) => streamRealtimeQuery({
-								initialFetch: () => collection.find(options),
 								realtime: client.realtime,
 								topic,
 								signal,
@@ -144,18 +117,17 @@ function createQuestpieQueryOptions(client, config = {}) {
 					normalizeQueryKeyOptions(options)
 				]);
 				if (queryConfig?.realtime && client.realtime) {
-					const topic = buildCollectionTopic$1(collectionName, options);
+					const topic = buildCollectionTopic$1(collectionName, options, "count");
 					return queryOptions({
 						queryKey: qKey,
 						queryFn: experimental_streamedQuery({
 							streamFn: ({ signal }) => streamRealtimeQuery({
-								initialFetch: () => collection.count(options),
 								realtime: client.realtime,
 								topic,
 								signal,
 								errorMap
 							}),
-							reducer: (_, chunk) => typeof chunk?.totalDocs === "number" ? chunk.totalDocs : chunk,
+							reducer: (_, chunk) => chunk,
 							initialValue: void 0,
 							refetchMode: "append"
 						})
@@ -306,7 +278,6 @@ function createQuestpieQueryOptions(client, config = {}) {
 						queryKey: qKey,
 						queryFn: experimental_streamedQuery({
 							streamFn: ({ signal }) => streamRealtimeQuery({
-								initialFetch: () => global.get(options),
 								realtime: client.realtime,
 								topic,
 								signal,
@@ -377,6 +348,44 @@ function createQuestpieQueryOptions(client, config = {}) {
 			})
 		};
 	} });
+	const channels = new Proxy({}, { get: (_target, channelName) => {
+		if (typeof channelName !== "string") return void 0;
+		const channel = Reflect.get(client.channels, channelName);
+		return {
+			subscription: (...args) => {
+				return queryOptions({
+					queryKey: buildKey(keyPrefix, [
+						"channels",
+						channelName,
+						"subscription",
+						normalizeQueryKeyOptions(args)
+					]),
+					queryFn: experimental_streamedQuery({
+						streamFn: ({ signal }) => channel.iter(...args, { signal }),
+						reducer: (messages, message) => [...messages, message],
+						initialValue: [],
+						refetchMode: "reset"
+					})
+				});
+			},
+			presence: (...args) => {
+				return queryOptions({
+					queryKey: buildKey(keyPrefix, [
+						"channels",
+						channelName,
+						"presence",
+						normalizeQueryKeyOptions(args)
+					]),
+					queryFn: experimental_streamedQuery({
+						streamFn: ({ signal }) => channel.presenceIter(...args, { signal }),
+						reducer: (_roster, snapshot) => snapshot,
+						initialValue: [],
+						refetchMode: "reset"
+					})
+				});
+			}
+		};
+	} });
 	/**
 	* Resolve a nested route caller from the client by traversing dot segments.
 	*/
@@ -422,6 +431,7 @@ function createQuestpieQueryOptions(client, config = {}) {
 	return {
 		collections,
 		globals,
+		channels,
 		routes: new Proxy({}, { get: (_target, prop) => {
 			if (typeof prop !== "string") return void 0;
 			return createRouteNodeProxy([prop]);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@questpie/tanstack-query",
-	"version": "3.14.0",
+	"version": "3.15.1",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/questpie/questpie.git",
@@ -36,7 +36,8 @@
 	},
 	"devDependencies": {
 		"bun-types": "latest",
-		"tsdown": "^0.18.3"
+		"tsdown": "^0.18.3",
+		"zod": "^4.2.1"
 	},
 	"peerDependencies": {
 		"@tanstack/react-query": "^5.0.0",