appflare 0.2.3 → 0.2.4

package/Documentation.md

@@ -604,13 +604,9 @@ import { useMutation } from "appflare/react";
 import { appflare } from "./appflare-client";
 
 export function CreatePostButton() {
-	const mutation = useMutation(
-		appflare.mutations.test.newTest,
-		{},
-		{
-			onSuccess: (data) => console.log("created", data),
-		},
-	);
+	const mutation = useMutation(appflare.mutations.test.newTest, {
+		onSuccess: (data) => console.log("created", data),
+	});
 
 	return (
 		<button onClick={() => mutation.mutate()} disabled={mutation.isPending}>

package/cli/templates/core/client/handlers/index.ts

@@ -142,9 +142,9 @@ function renderRouteFactory(operation: HttpOperation): string {
 	runtime: RequestRuntime,
 ): AppflareQueryRouteClient<typeof ${operation.schemaConst}, ${outputType}> => {
 	const run: AppflareQueryRouteClient<typeof ${operation.schemaConst}, ${outputType}>["run"] = async (
-		args: ${inputType},
-		options?: AppflareResultRouteCallOptions,
+		...params: AppflareRunParams<${inputType}>
 	) => {
+		const { args, options } = resolveRunParams<${inputType}>(params);
 		const mergedOptions = mergeRouteOptions(runtime.options, options);
 		const resultOptions: AppflareRouteCallOptions<"return"> = {
 			...(mergedOptions ?? {}),
@@ -168,9 +168,7 @@ function renderRouteFactory(operation: HttpOperation): string {
 		signal,
 	}: AppflareQuerySubscribeOptions<${inputType}, ${outputType}>): AppflareRealtimeSubscription => {
 		const mergedOptions = mergeRouteOptions(runtime.options, requestOptions);
-		const parsedArgs = ${operation.schemaConst}.parse(
-			(args ?? {}) as ${inputType},
-		) as ${inputType};
+		const parsedArgs = ${operation.schemaConst}.parse(normalizeRouteInput(args));
 		const requestAuthToken = resolveRealtimeAuthToken(authToken, mergedOptions?.headers);
 
 		let removed = false;
@@ -307,9 +305,9 @@ function renderRouteFactory(operation: HttpOperation): string {
 	runtime: RequestRuntime,
 ): AppflareRouteClient<typeof ${operation.schemaConst}, ${outputType}> => {
 	const run: AppflareRouteClient<typeof ${operation.schemaConst}, ${outputType}>["run"] = async (
-		args: ${inputType},
-		options?: AppflareResultRouteCallOptions,
+		...params: AppflareRunParams<${inputType}>
 	) => {
+		const { args, options } = resolveRunParams<${inputType}>(params);
 		const mergedOptions = mergeRouteOptions(runtime.options, options);
 		const resultOptions: AppflareRouteCallOptions<"return"> = {
 			...(mergedOptions ?? {}),
@@ -385,6 +383,7 @@ import type {
 	AppflareResultRouteCallOptions,
 	AppflareRouteCallOptions,
 	AppflareRouteClient,
+	AppflareRunParams,
 } from "./types";
 ${imports ? `\n${imports}` : ""}
 
@@ -429,6 +428,25 @@ function mergeRouteOptions(
 	};
 }
 
+function normalizeRouteInput<TInput extends Record<string, unknown>>(
+	input: TInput | undefined,
+): TInput {
+	return (input ?? {}) as TInput;
+}
+
+function resolveRunParams<TInput extends Record<string, unknown>>(
+	params: AppflareRunParams<TInput>,
+): {
+	args: TInput;
+	options?: AppflareResultRouteCallOptions;
+} {
+	const [args, options] = params;
+	return {
+		args: normalizeRouteInput(args),
+		options,
+	};
+}
+
 function readHeaderCaseInsensitive(
 	headers: HeadersInit | undefined,
 	headerName: string,

package/cli/templates/core/client/types.ts

@@ -52,15 +52,30 @@ export type AppflareResultRouteCallOptions = Omit<
 	"errorMode"
 >;
 
+export type AppflareRouteInput<
+	TSchema extends import("zod").ZodObject<import("zod").ZodRawShape>,
+> = import("zod").input<TSchema>;
+
+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;
+
+export type AppflareRunParams<TInput extends Record<string, unknown>> =
+	AppflareHasRequiredInputKeys<TInput> extends true
+		? [args: TInput, options?: AppflareResultRouteCallOptions]
+		: [args?: TInput, options?: AppflareResultRouteCallOptions];
+
 export type AppflareRouteClient<
 	TSchema extends import("zod").ZodObject<import("zod").ZodRawShape>,
 	TOutput,
 > = {
 	schema: TSchema;
-	run(
-		args: import("zod").input<TSchema>,
-		options?: AppflareResultRouteCallOptions,
-	): Promise<AppflareRequestResult<TOutput>>;
+	run(...params: AppflareRunParams<AppflareRouteInput<TSchema>>): Promise<
+		AppflareRequestResult<TOutput>
+	>;
 };
 
 export type AppflareRealtimeSubscription = {
@@ -100,12 +115,10 @@ export type InferRouteSchema<TRoute> = TRoute extends {
 	? TSchema
 	: never;
 
-export type InferRouteInput<TRoute> = TRoute extends {
-	run: (...args: infer TArgs) => Promise<unknown>;
-}
-	? TArgs extends [infer TInput, ...unknown[]]
-		? TInput
-		: never
+export type InferRouteInput<TRoute> = InferRouteSchema<TRoute> extends import("zod").ZodObject<
+	import("zod").ZodRawShape
+>
+	? AppflareRouteInput<InferRouteSchema<TRoute>>
 	: never;
 
 export type InferRouteResult<TRoute> = TRoute extends {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "appflare",
-	"version": "0.2.3",
+	"version": "0.2.4",
 	"bin": {
 		"appflare": "./cli/index.ts"
 	},

package/react/use-infinite-query.ts

@@ -1,4 +1,5 @@
 import {
+	hashKey,
 	type InfiniteData,
 	type QueryKey,
 	type UseInfiniteQueryOptions,
@@ -6,7 +7,7 @@ import {
 	useInfiniteQuery as useTanstackInfiniteQuery,
 	useQueryClient,
 } from "@tanstack/react-query";
-import { useEffect, useMemo } from "react";
+import { useEffect, useMemo, useRef } from "react";
 
 type AppflareRequestErrorLike = {
 	message: string;
@@ -31,10 +32,24 @@ type AppflareRealtimeQueryUpdateLike<TData> = {
 	};
 };
 
-type AppflareQueryLike<TArgs, 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: (
-		args: TArgs,
-		options?: any,
+		...params: AppflareRouteRunArgs<TArgs>
 	) => Promise<AppflareRequestResultLike<TData>>;
 	subscribe?: (options: {
 		args?: TArgs;
@@ -50,7 +65,7 @@ type AppflareQueryLike<TArgs, TData> = {
 };
 
 export type UseAppflareInfiniteQueryOptions<
-	TArgs,
+	TArgs extends Record<string, unknown>,
 	TData,
 	TPageParam,
 	TSelected = InfiniteData<TData, TPageParam>,
@@ -76,6 +91,35 @@ export type UseAppflareInfiniteQueryOptions<
 	};
 };
 
+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) {
@@ -85,23 +129,32 @@ function toError(error: AppflareRequestErrorLike): Error {
 }
 
 export function useInfiniteQuery<
-	TArgs,
+	TArgs extends Record<string, unknown>,
 	TData,
 	TPageParam = unknown,
 	TSelected = InfiniteData<TData, TPageParam>,
 	TKey extends QueryKey = QueryKey,
 >(
 	query: AppflareQueryLike<TArgs, TData>,
-	args: TArgs,
-	options?: UseAppflareInfiniteQueryOptions<
+	...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 ??
@@ -109,6 +162,18 @@ export function useInfiniteQuery<
 		);
 	}, [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,
@@ -159,13 +224,13 @@ export function useInfiniteQuery<
 						};
 					},
 				);
-				options.realtime?.onChange?.(
+				realtimeOnChangeRef.current?.(
 					data as TData,
 					update as AppflareRealtimeQueryUpdateLike<TData>,
 				);
 			},
 			onError: (error) => {
-				options.realtime?.onError?.(error);
+				realtimeOnErrorRef.current?.(error);
 			},
 		});
 
@@ -174,16 +239,13 @@ export function useInfiniteQuery<
 			subscription.remove();
 		};
 	}, [
-		args,
+		realtimeArgsHash,
 		options?.realtime?.authToken,
 		options?.realtime?.enabled,
-		options?.realtime?.onChange,
-		options?.realtime?.onError,
-		options?.realtime?.requestOptions,
-		query,
+		realtimeRequestOptionsHash,
 		query.subscribe,
 		queryClient,
-		resolvedQueryKey,
+		resolvedQueryKeyHash,
 	]);
 
 	return result;

package/react/use-mutation.ts

@@ -14,10 +14,27 @@ type AppflareRequestResultLike<TData> = {
 	error: AppflareRequestErrorLike | null;
 };
 
-type AppflareMutationLike<TArgs, 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 AppflareMutationVariables<TArgs extends Record<string, unknown>> =
+	AppflareHasRequiredInputKeys<TArgs> extends true ? TArgs : TArgs | void;
+
+type AppflareMutationLike<TArgs extends Record<string, unknown>, TData> = {
 	run: (
-		args: TArgs,
-		options?: any,
+		...params: AppflareRouteRunArgs<TArgs>
 	) => Promise<AppflareRequestResultLike<TData>>;
 };
 
@@ -29,21 +46,39 @@ function toError(error: AppflareRequestErrorLike): Error {
 	return next;
 }
 
-export function useMutation<TArgs, TData, TContext = unknown>(
+export function useMutation<
+	TArgs extends Record<string, unknown>,
+	TData,
+	TContext = unknown,
+>(
 	mutation: AppflareMutationLike<TArgs, TData>,
-	args: TArgs,
 	mutationOptions?: Omit<
-		UseMutationOptions<TData, Error, void, TContext>,
+		UseMutationOptions<
+			TData,
+			Error,
+			AppflareMutationVariables<TArgs>,
+			TContext
+		>,
 		"mutationFn"
 	>,
-): UseMutationResult<TData, Error, void, TContext> {
-	return useTanstackMutation<TData, Error, void, TContext>({
+): UseMutationResult<TData, Error, AppflareMutationVariables<TArgs>, TContext> {
+	return useTanstackMutation<
+		TData,
+		Error,
+		AppflareMutationVariables<TArgs>,
+		TContext
+	>({
 		...(mutationOptions as Omit<
-			UseMutationOptions<TData, Error, void, TContext>,
+			UseMutationOptions<
+				TData,
+				Error,
+				AppflareMutationVariables<TArgs>,
+				TContext
+			>,
 			"mutationFn"
 		>),
-		mutationFn: async () => {
-			const response = await mutation.run(args);
+		mutationFn: async (args: AppflareMutationVariables<TArgs>) => {
+			const response = await mutation.run((args ?? {}) as TArgs);
 			if (response.error) {
 				throw toError(response.error);
 			}

package/react/use-query.ts

@@ -1,11 +1,12 @@
 import {
+	hashKey,
 	type QueryKey,
 	type UseQueryOptions,
 	type UseQueryResult,
 	useQuery as useTanstackQuery,
 	useQueryClient,
 } from "@tanstack/react-query";
-import { useEffect, useMemo } from "react";
+import { useEffect, useMemo, useRef } from "react";
 
 type AppflareRequestErrorLike = {
 	message: string;
@@ -30,10 +31,24 @@ type AppflareRealtimeQueryUpdateLike<TData> = {
 	};
 };
 
-type AppflareQueryLike<TArgs, 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: (
-		args: TArgs,
-		options?: any,
+		...params: AppflareRouteRunArgs<TArgs>
 	) => Promise<AppflareRequestResultLike<TData>>;
 	subscribe?: (options: {
 		args?: TArgs;
@@ -49,7 +64,7 @@ type AppflareQueryLike<TArgs, TData> = {
 };
 
 export type UseAppflareQueryOptions<
-	TArgs,
+	TArgs extends Record<string, unknown>,
 	TData,
 	TSelected = TData,
 	TKey extends QueryKey = QueryKey,
@@ -73,6 +88,22 @@ export type UseAppflareQueryOptions<
 	};
 };
 
+type UseQueryCallParams<
+	TArgs extends Record<string, unknown>,
+	TData,
+	TSelected,
+	TKey extends QueryKey,
+> =
+	AppflareHasRequiredInputKeys<TArgs> extends true
+		? [
+				args: TArgs,
+				options?: UseAppflareQueryOptions<TArgs, TData, TSelected, TKey>,
+			]
+		: [
+				args?: TArgs,
+				options?: UseAppflareQueryOptions<TArgs, TData, TSelected, TKey>,
+			];
+
 function toError(error: AppflareRequestErrorLike): Error {
 	const next = new Error(error.message);
 	if (error.status !== undefined) {
@@ -82,16 +113,25 @@ function toError(error: AppflareRequestErrorLike): Error {
 }
 
 export function useQuery<
-	TArgs,
+	TArgs extends Record<string, unknown>,
 	TData,
 	TSelected = TData,
 	TKey extends QueryKey = QueryKey,
 >(
 	query: AppflareQueryLike<TArgs, TData>,
-	args: TArgs,
-	options?: UseAppflareQueryOptions<TArgs, TData, TSelected, TKey>,
+	...params: UseQueryCallParams<TArgs, TData, TSelected, TKey>
 ): UseQueryResult<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 ??
@@ -99,6 +139,18 @@ export function useQuery<
 		);
 	}, [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 = useTanstackQuery<TData, Error, TSelected, TKey>({
 		...(options?.queryOptions as Omit<
 			UseQueryOptions<TData, Error, TSelected, TKey>,
@@ -127,13 +179,13 @@ export function useQuery<
 			signal: controller.signal,
 			onChange: (data, update) => {
 				queryClient.setQueryData<TData>(resolvedQueryKey, data as TData);
-				options.realtime?.onChange?.(
+				realtimeOnChangeRef.current?.(
 					data as TData,
 					update as AppflareRealtimeQueryUpdateLike<TData>,
 				);
 			},
 			onError: (error) => {
-				options.realtime?.onError?.(error);
+				realtimeOnErrorRef.current?.(error);
 			},
 		});
 
@@ -142,16 +194,13 @@ export function useQuery<
 			subscription.remove();
 		};
 	}, [
-		args,
+		realtimeArgsHash,
 		options?.realtime?.authToken,
 		options?.realtime?.enabled,
-		options?.realtime?.onChange,
-		options?.realtime?.onError,
-		options?.realtime?.requestOptions,
-		query,
+		realtimeRequestOptionsHash,
 		query.subscribe,
 		queryClient,
-		resolvedQueryKey,
+		resolvedQueryKeyHash,
 	]);
 
 	return result;