appflare 0.2.41 → 0.2.43

package/react/use-infinite-query.ts

@@ -1,252 +1,255 @@
-import {
-	hashKey,
-	type InfiniteData,
-	type QueryKey,
-	type UseInfiniteQueryOptions,
-	type UseInfiniteQueryResult,
-	useInfiniteQuery as useTanstackInfiniteQuery,
-	useQueryClient,
-} from "@tanstack/react-query";
-import { useEffect, useMemo, useRef } from "react";
-
-type AppflareRequestErrorLike = {
-	message: string;
-	status?: number;
-};
-
-type AppflareRequestResultLike<TData> = {
-	data: TData | null;
-	error: AppflareRequestErrorLike | null;
-};
-
-type AppflareRealtimeSubscriptionLike = {
-	remove: () => void;
-};
-
-type AppflareRealtimeQueryUpdateLike<TData> = {
-	event: "query:update";
-	payload: {
-		queryName: string;
-		signature: string;
-		data: TData;
-	};
-};
-
-type AppflareRequiredInputKeys<TInput extends Record<string, unknown>> = {
-	[K in keyof TInput]-?: undefined extends TInput[K] ? never : K;
-}[keyof TInput];
-
-type AppflareHasRequiredInputKeys<TInput extends Record<string, unknown>> = [
-	AppflareRequiredInputKeys<TInput>,
-] extends [never]
-	? false
-	: true;
-
-type AppflareRouteRunArgs<TInput extends Record<string, unknown>> =
-	AppflareHasRequiredInputKeys<TInput> extends true
-		? [args: TInput, options?: any]
-		: [args?: TInput, options?: any];
-
-type AppflareQueryLike<TArgs extends Record<string, unknown>, TData> = {
-	run: (
-		...params: AppflareRouteRunArgs<TArgs>
-	) => Promise<AppflareRequestResultLike<TData>>;
-	subscribe?: (options: {
-		args?: TArgs;
-		authToken?: string;
-		requestOptions?: any;
-		signal?: AbortSignal;
-		onChange: (
-			data: TData,
-			update: AppflareRealtimeQueryUpdateLike<TData>,
-		) => void;
-		onError?: (error: unknown) => void;
-	}) => AppflareRealtimeSubscriptionLike;
-};
-
-export type UseAppflareInfiniteQueryOptions<
-	TArgs extends Record<string, unknown>,
-	TData,
-	TPageParam,
-	TSelected = InfiniteData<TData, TPageParam>,
-	TKey extends QueryKey = QueryKey,
-> = {
-	realtime?: {
-		enabled?: boolean;
-		authToken?: string;
-		requestOptions?: any;
-		onChange?: (
-			data: TData,
-			update: AppflareRealtimeQueryUpdateLike<TData>,
-		) => void;
-		onError?: (error: unknown) => void;
-	};
-	requestOptions?: any;
-	pageParamToArgs?: (baseArgs: TArgs, pageParam: TPageParam) => TArgs;
-	queryOptions?: Omit<
-		UseInfiniteQueryOptions<TData, Error, TSelected, TKey, TPageParam>,
-		"queryFn" | "queryKey"
-	> & {
-		queryKey?: TKey;
-	};
-};
-
-type UseInfiniteQueryCallParams<
-	TArgs extends Record<string, unknown>,
-	TData,
-	TPageParam,
-	TSelected,
-	TKey extends QueryKey,
-> =
-	AppflareHasRequiredInputKeys<TArgs> extends true
-		? [
-				args: TArgs,
-				options?: UseAppflareInfiniteQueryOptions<
-					TArgs,
-					TData,
-					TPageParam,
-					TSelected,
-					TKey
-				>,
-			]
-		: [
-				args?: TArgs,
-				options?: UseAppflareInfiniteQueryOptions<
-					TArgs,
-					TData,
-					TPageParam,
-					TSelected,
-					TKey
-				>,
-			];
-
-function toError(error: AppflareRequestErrorLike): Error {
-	const next = new Error(error.message);
-	if (error.status !== undefined) {
-		(next as Error & { status?: number }).status = error.status;
-	}
-	return next;
-}
-
-export function useInfiniteQuery<
-	TArgs extends Record<string, unknown>,
-	TData,
-	TPageParam = unknown,
-	TSelected = InfiniteData<TData, TPageParam>,
-	TKey extends QueryKey = QueryKey,
->(
-	query: AppflareQueryLike<TArgs, TData>,
-	...params: UseInfiniteQueryCallParams<
-		TArgs,
-		TData,
-		TPageParam,
-		TSelected,
-		TKey
-	>
-): UseInfiniteQueryResult<TSelected, Error> {
-	const args = (params[0] ?? {}) as TArgs;
-	const options = params[1];
-	const queryClient = useQueryClient();
-	const realtimeOnChangeRef = useRef(options?.realtime?.onChange);
-	const realtimeOnErrorRef = useRef(options?.realtime?.onError);
-
-	useEffect(() => {
-		realtimeOnChangeRef.current = options?.realtime?.onChange;
-		realtimeOnErrorRef.current = options?.realtime?.onError;
-	}, [options?.realtime?.onChange, options?.realtime?.onError]);
-
-	const resolvedQueryKey = useMemo(() => {
-		return (
-			options?.queryOptions?.queryKey ??
-			(["appflare", "infinite-query", query, args] as unknown as TKey)
-		);
-	}, [args, options?.queryOptions?.queryKey, query]);
-
-	const resolvedQueryKeyHash = useMemo(
-		() => hashKey(resolvedQueryKey as QueryKey),
-		[resolvedQueryKey],
-	);
-
-	const realtimeArgsHash = useMemo(() => hashKey([args] as QueryKey), [args]);
-
-	const realtimeRequestOptionsHash = useMemo(
-		() => hashKey([options?.realtime?.requestOptions] as QueryKey),
-		[options?.realtime?.requestOptions],
-	);
-
-	const result = useTanstackInfiniteQuery<
-		TData,
-		Error,
-		TSelected,
-		TKey,
-		TPageParam
-	>({
-		...(options?.queryOptions as Omit<
-			UseInfiniteQueryOptions<TData, Error, TSelected, TKey, TPageParam>,
-			"queryFn" | "queryKey"
-		>),
-		queryKey: resolvedQueryKey,
-		queryFn: async ({ pageParam }) => {
-			const nextArgs =
-				pageParam === undefined || !options?.pageParamToArgs
-					? args
-					: options.pageParamToArgs(args, pageParam as TPageParam);
-			const response = await query.run(nextArgs, options?.requestOptions);
-			if (response.error) {
-				throw toError(response.error);
-			}
-			return response.data as TData;
-		},
-	});
-
-	useEffect(() => {
-		if (options?.realtime?.enabled === false || !query.subscribe) {
-			return;
-		}
-
-		const controller = new AbortController();
-		const subscription = query.subscribe({
-			args,
-			authToken: options?.realtime?.authToken,
-			requestOptions: options?.realtime?.requestOptions,
-			signal: controller.signal,
-			onChange: (data, update) => {
-				queryClient.setQueryData<InfiniteData<TData, TPageParam>>(
-					resolvedQueryKey,
-					(previous) => {
-						if (!previous || previous.pages.length === 0) {
-							return previous;
-						}
-
-						return {
-							...previous,
-							pages: [data as TData, ...previous.pages.slice(1)],
-						};
-					},
-				);
-				realtimeOnChangeRef.current?.(
-					data as TData,
-					update as AppflareRealtimeQueryUpdateLike<TData>,
-				);
-			},
-			onError: (error) => {
-				realtimeOnErrorRef.current?.(error);
-			},
-		});
-
-		return () => {
-			controller.abort();
-			subscription.remove();
-		};
-	}, [
-		realtimeArgsHash,
-		options?.realtime?.authToken,
-		options?.realtime?.enabled,
-		realtimeRequestOptionsHash,
-		query.subscribe,
-		queryClient,
-		resolvedQueryKeyHash,
-	]);
-
-	return result;
-}
+import {
+	hashKey,
+	type InfiniteData,
+	type QueryKey,
+	type UseInfiniteQueryOptions,
+	type UseInfiniteQueryResult,
+	useInfiniteQuery as useTanstackInfiniteQuery,
+	useQueryClient,
+} from "@tanstack/react-query";
+import { useEffect, useMemo, useRef } from "react";
+
+type AppflareRequestErrorLike = {
+	message: string;
+	status?: number;
+};
+
+type AppflareRequestResultLike<TData> = {
+	data: TData | null;
+	error: AppflareRequestErrorLike | null;
+};
+
+type AppflareRealtimeSubscriptionLike = {
+	remove: () => void;
+};
+
+type AppflareRealtimeQueryUpdateLike<TData> = {
+	event: "query:update";
+	payload: {
+		queryName: string;
+		signature: string;
+		data: TData;
+	};
+};
+
+type AppflareRequiredInputKeys<TInput extends Record<string, unknown>> = {
+	[K in keyof TInput]-?: undefined extends TInput[K] ? never : K;
+}[keyof TInput];
+
+type AppflareHasRequiredInputKeys<TInput extends Record<string, unknown>> = [
+	AppflareRequiredInputKeys<TInput>,
+] extends [never]
+	? false
+	: true;
+
+type AppflareRouteRunArgs<TInput extends Record<string, unknown>> =
+	AppflareHasRequiredInputKeys<TInput> extends true
+		? [args: TInput, options?: any]
+		: [args?: TInput, options?: any];
+
+type AppflareQueryLike<TArgs extends Record<string, unknown>, TData> = {
+	run: (
+		...params: AppflareRouteRunArgs<TArgs>
+	) => Promise<AppflareRequestResultLike<TData>>;
+	subscribe?: (options: {
+		args?: TArgs;
+		authToken?: string;
+		requestOptions?: any;
+		signal?: AbortSignal;
+		onChange: (
+			data: TData,
+			update: AppflareRealtimeQueryUpdateLike<TData>,
+		) => void;
+		onError?: (error: unknown) => void;
+	}) => AppflareRealtimeSubscriptionLike;
+	queryKey?: (args?: TArgs) => QueryKey;
+};
+
+export type UseAppflareInfiniteQueryOptions<
+	TArgs extends Record<string, unknown>,
+	TData,
+	TPageParam,
+	TSelected = InfiniteData<TData, TPageParam>,
+	TKey extends QueryKey = QueryKey,
+> = {
+	realtime?: {
+		enabled?: boolean;
+		authToken?: string;
+		requestOptions?: any;
+		onChange?: (
+			data: TData,
+			update: AppflareRealtimeQueryUpdateLike<TData>,
+		) => void;
+		onError?: (error: unknown) => void;
+	};
+	requestOptions?: any;
+	pageParamToArgs?: (baseArgs: TArgs, pageParam: TPageParam) => TArgs;
+	queryOptions?: Omit<
+		UseInfiniteQueryOptions<TData, Error, TSelected, TKey, TPageParam>,
+		"queryFn" | "queryKey"
+	> & {
+		queryKey?: TKey;
+	};
+};
+
+type UseInfiniteQueryCallParams<
+	TArgs extends Record<string, unknown>,
+	TData,
+	TPageParam,
+	TSelected,
+	TKey extends QueryKey,
+> =
+	AppflareHasRequiredInputKeys<TArgs> extends true
+		? [
+				args: TArgs,
+				options?: UseAppflareInfiniteQueryOptions<
+					TArgs,
+					TData,
+					TPageParam,
+					TSelected,
+					TKey
+				>,
+			]
+		: [
+				args?: TArgs,
+				options?: UseAppflareInfiniteQueryOptions<
+					TArgs,
+					TData,
+					TPageParam,
+					TSelected,
+					TKey
+				>,
+			];
+
+function toError(error: AppflareRequestErrorLike): Error {
+	const next = new Error(error.message);
+	if (error.status !== undefined) {
+		(next as Error & { status?: number }).status = error.status;
+	}
+	return next;
+}
+
+export function useInfiniteQuery<
+	TArgs extends Record<string, unknown>,
+	TData,
+	TPageParam = unknown,
+	TSelected = InfiniteData<TData, TPageParam>,
+	TKey extends QueryKey = QueryKey,
+>(
+	query: AppflareQueryLike<TArgs, TData>,
+	...params: UseInfiniteQueryCallParams<
+		TArgs,
+		TData,
+		TPageParam,
+		TSelected,
+		TKey
+	>
+): UseInfiniteQueryResult<TSelected, Error> {
+	const args = (params[0] ?? {}) as TArgs;
+	const options = params[1];
+	const queryClient = useQueryClient();
+	const realtimeOnChangeRef = useRef(options?.realtime?.onChange);
+	const realtimeOnErrorRef = useRef(options?.realtime?.onError);
+
+	useEffect(() => {
+		realtimeOnChangeRef.current = options?.realtime?.onChange;
+		realtimeOnErrorRef.current = options?.realtime?.onError;
+	}, [options?.realtime?.onChange, options?.realtime?.onError]);
+
+	const resolvedQueryKey = useMemo(() => {
+		return (
+			options?.queryOptions?.queryKey ??
+			(query.queryKey
+				? query.queryKey(args)
+				: (["appflare", "infinite-query", query, args] as unknown as TKey))
+		) as TKey
+	}, [args, options?.queryOptions?.queryKey, query]);
+
+	const resolvedQueryKeyHash = useMemo(
+		() => hashKey(resolvedQueryKey as QueryKey),
+		[resolvedQueryKey],
+	);
+
+	const realtimeArgsHash = useMemo(() => hashKey([args] as QueryKey), [args]);
+
+	const realtimeRequestOptionsHash = useMemo(
+		() => hashKey([options?.realtime?.requestOptions] as QueryKey),
+		[options?.realtime?.requestOptions],
+	);
+
+	const result = useTanstackInfiniteQuery<
+		TData,
+		Error,
+		TSelected,
+		TKey,
+		TPageParam
+	>({
+		...(options?.queryOptions as Omit<
+			UseInfiniteQueryOptions<TData, Error, TSelected, TKey, TPageParam>,
+			"queryFn" | "queryKey"
+		>),
+		queryKey: resolvedQueryKey,
+		queryFn: async ({ pageParam }) => {
+			const nextArgs =
+				pageParam === undefined || !options?.pageParamToArgs
+					? args
+					: options.pageParamToArgs(args, pageParam as TPageParam);
+			const response = await query.run(nextArgs, options?.requestOptions);
+			if (response.error) {
+				throw toError(response.error);
+			}
+			return response.data as TData;
+		},
+	});
+
+	useEffect(() => {
+		if (options?.realtime?.enabled === false || !query.subscribe) {
+			return;
+		}
+
+		const controller = new AbortController();
+		const subscription = query.subscribe({
+			args,
+			authToken: options?.realtime?.authToken,
+			requestOptions: options?.realtime?.requestOptions,
+			signal: controller.signal,
+			onChange: (data, update) => {
+				queryClient.setQueryData<InfiniteData<TData, TPageParam>>(
+					resolvedQueryKey,
+					(previous) => {
+						if (!previous || previous.pages.length === 0) {
+							return previous;
+						}
+
+						return {
+							...previous,
+							pages: [data as TData, ...previous.pages.slice(1)],
+						};
+					},
+				);
+				realtimeOnChangeRef.current?.(
+					data as TData,
+					update as AppflareRealtimeQueryUpdateLike<TData>,
+				);
+			},
+			onError: (error) => {
+				realtimeOnErrorRef.current?.(error);
+			},
+		});
+
+		return () => {
+			controller.abort();
+			subscription.remove();
+		};
+	}, [
+		realtimeArgsHash,
+		options?.realtime?.authToken,
+		options?.realtime?.enabled,
+		realtimeRequestOptionsHash,
+		query.subscribe,
+		queryClient,
+		resolvedQueryKeyHash,
+	]);
+
+	return result;
+}