@emeryld/rrroutes-client 2.6.12 → 2.7.0

package/dist/routesV3.client.types.d.ts

@@ -198,7 +198,21 @@ export type MutationBuildOptionsFor<L extends AnyLeafLowProfile> = Omit<UseMutat
 };
 /** Build options narrowed to the method/feed shape of the leaf. */
 export type BuildOptionsFor<L extends AnyLeafLowProfile> = L['method'] extends 'get' ? L['cfg']['feed'] extends true ? InfiniteBuildOptionsFor<L> : QueryBuildOptionsFor<L> : MutationBuildOptionsFor<L>;
-export type UseEndpointArgs<L extends AnyLeafLowProfile> = ArgsTuple<L>;
+/** React Query call options for `useEndpoint` on plain GET leaves. */
+export type QueryUseEndpointOptionsFor<L extends AnyLeafLowProfile> = Omit<UseQueryOptions<InferOutput<L>, unknown, InferOutput<L>, QueryKey>, 'queryKey' | 'queryFn'> & {
+    onReceive?: OnReceive<L>;
+};
+/** React Query call options for `useEndpoint` on feed GET leaves. */
+export type InfiniteUseEndpointOptionsFor<L extends AnyLeafLowProfile> = Omit<UseInfiniteQueryOptions<InferOutput<L>, unknown, InfiniteData<InferOutput<L>>, QueryKey, Cursor>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'initialPageParam'> & {
+    onReceive?: OnReceive<L>;
+};
+/** React Query call options for `useEndpoint` on mutation leaves. */
+export type MutationUseEndpointOptionsFor<L extends AnyLeafLowProfile> = Omit<UseMutationOptions<InferOutput<L>, unknown, InferBodyInput<L>, unknown>, 'mutationFn' | 'mutationKey'> & {
+    onReceive?: OnReceive<L>;
+};
+/** Runtime hook options narrowed to the method/feed shape of the leaf. */
+export type UseEndpointOptionsFor<L extends AnyLeafLowProfile> = L['method'] extends 'get' ? L['cfg']['feed'] extends true ? InfiniteUseEndpointOptionsFor<L> : QueryUseEndpointOptionsFor<L> : MutationUseEndpointOptionsFor<L>;
+export type UseEndpointArgs<L extends AnyLeafLowProfile> = keyof ArgsFor<L> extends never ? [options?: UseEndpointOptionsFor<L>] : [args: ArgsFor<L>, options?: UseEndpointOptionsFor<L>];
 export type QueryUseEndpointResultFor<L extends AnyLeafLowProfile> = UseEndpointResult<L, UseQueryResult<InferOutput<L>, unknown>>;
 export type InfiniteUseEndpointResultFor<L extends AnyLeafLowProfile> = UseEndpointResult<L, UseInfiniteQueryResult<InfiniteData<InferOutput<L>>, unknown>>;
 export type MutationUseEndpointResultFor<L extends AnyLeafLowProfile> = UseEndpointResult<L, UseMutationResult<InferOutput<L>, unknown, InferBodyInput<L>, unknown>>;
@@ -226,7 +240,7 @@ export type BuiltCommon<L extends AnyLeafLowProfile> = {
 export type BuiltQuery<L extends AnyLeafLowProfile> = BuiltCommon<L> & {
     /**
      * React hook bound to the GET leaf.
-     * @param args Optional params/query tuple for the leaf.
+     * @param args Optional params/query args, followed by optional React Query options.
      */
     useEndpoint: (...args: UseEndpointArgs<L>) => QueryUseEndpointResultFor<L>;
     /**
@@ -239,7 +253,7 @@ export type BuiltQuery<L extends AnyLeafLowProfile> = BuiltCommon<L> & {
 export type BuiltInfinite<L extends AnyLeafLowProfile> = BuiltCommon<L> & {
     /**
      * React hook bound to an infinite GET leaf.
-     * @param args Optional params/query tuple for the leaf.
+     * @param args Optional params/query args, followed by optional React Query options.
      */
     useEndpoint: (...args: UseEndpointArgs<L>) => InfiniteUseEndpointResultFor<L>;
     /**
@@ -252,7 +266,7 @@ export type BuiltInfinite<L extends AnyLeafLowProfile> = BuiltCommon<L> & {
 export type BuiltMutation<L extends AnyLeafLowProfile> = BuiltCommon<L> & {
     /**
      * React hook bound to a mutation leaf.
-     * @param args Optional params/query tuple for the leaf.
+     * @param args Optional params/query args, followed by optional React Query options.
      */
     useEndpoint: (...args: UseEndpointArgs<L>) => MutationUseEndpointResultFor<L>;
     /**

package/dist/sockets/socketedRoute/socket.client.helper.route.d.ts

@@ -1,5 +1,5 @@
 import type { AnyLeafLowProfile, EventMap, SocketConnectionConfigOutput, SocketEvent } from '@emeryld/rrroutes-contract';
-import type { BuiltInfinite, BuiltQuery, DataShape, InfiniteUseEndpointResultFor, QueryUseEndpointResultFor, UseEndpointArgs } from '../../routesV3.client.types';
+import type { ArgsFor, BuiltInfinite, BuiltQuery, DataShape, InfiniteUseEndpointResultFor, QueryUseEndpointResultFor, UseEndpointArgs } from '../../routesV3.client.types';
 import type { ClientCtx, ServerEnvelope, SocketClient } from '../socket.client.core';
 import { type SocketedRouteDebugOptions } from './socket.client.helper.debug';
 import { type ToRoomsMapper } from './socket.client.helper.rooms';
@@ -10,10 +10,10 @@ export type SocketedRouteResult<L extends AnyLeafLowProfile> = (L['cfg']['feed']
 export type ApplySocket<L extends AnyLeafLowProfile, S extends SocketEvent> = (args: {
     prev: DataShape<L> | undefined;
     payload: S['__out'];
+    args: ArgsFor<L> | undefined;
     meta: {
         envelope?: ServerEnvelope<S['__out']>;
         ctx?: ClientCtx;
-        args: UseEndpointArgs<L>;
     };
 }) => DataShape<L> | undefined | null;
 export type SocketedRouteOptions<L extends AnyLeafLowProfile, Events extends EventMap, C extends SocketConnectionConfigOutput> = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emeryld/rrroutes-client",
-  "version": "2.6.12",
+  "version": "2.7.0",
   "private": false,
   "type": "module",
   "main": "dist/index.cjs",