@orpc/react 1.6.4 → 1.6.5

package/dist/hooks/index.d.mts

@@ -58,12 +58,22 @@ interface UseServerActionErrorResult<TInput, TOutput, TError> extends UseServerA
     status: 'error';
     executedAt: Date;
 }
+type UseServerActionResult<TInput, TOutput, TError> = UseServerActionIdleResult<TInput, TOutput, TError> | UseServerActionSuccessResult<TInput, TOutput, TError> | UseServerActionErrorResult<TInput, TOutput, TError> | UseServerActionPendingResult<TInput, TOutput, TError>;
 /**
  * Use a Server Action Hook
  *
  * @see {@link https://orpc.unnoq.com/docs/server-action#useserveraction-hook Server Action Hook Docs}
  */
-declare function useServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>>(action: ActionableClient<TInput, TOutput, TError>, options?: NoInfer<UseServerActionOptions<TInput, TOutput, UnactionableError<TError>>>): UseServerActionIdleResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionSuccessResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionErrorResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionPendingResult<TInput, TOutput, UnactionableError<TError>>;
+declare function useServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>>(action: ActionableClient<TInput, TOutput, TError>, options?: UseServerActionOptions<TInput, TOutput, UnactionableError<TError>>): UseServerActionResult<TInput, TOutput, UnactionableError<TError>>;
 
-export { useServerAction };
-export type { UseServerActionErrorResult, UseServerActionExecuteOptions, UseServerActionExecuteRest, UseServerActionIdleResult, UseServerActionOptions, UseServerActionPendingResult, UseServerActionResultBase, UseServerActionSuccessResult };
+interface UseOptimisticServerActionOptions<TInput, TOutput, TError, TOptimisticState> extends UseServerActionOptions<TInput, TOutput, TError> {
+    optimisticPassthrough: TOptimisticState;
+    optimisticReducer: (state: TOptimisticState, input: TInput) => TOptimisticState;
+}
+type UseOptimisticServerActionResult<TInput, TOutput, TError, TOptimisticState> = UseServerActionResult<TInput, TOutput, TError> & {
+    optimisticState: TOptimisticState;
+};
+declare function useOptimisticServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>, TOptimisticState>(action: ActionableClient<TInput, TOutput, TError>, options: UseOptimisticServerActionOptions<TInput, TOutput, UnactionableError<TError>, TOptimisticState>): UseOptimisticServerActionResult<TInput, TOutput, UnactionableError<TError>, TOptimisticState>;
+
+export { useOptimisticServerAction, useServerAction };
+export type { UseOptimisticServerActionOptions, UseOptimisticServerActionResult, UseServerActionErrorResult, UseServerActionExecuteOptions, UseServerActionExecuteRest, UseServerActionIdleResult, UseServerActionOptions, UseServerActionPendingResult, UseServerActionResult, UseServerActionResultBase, UseServerActionSuccessResult };

package/dist/hooks/index.d.ts

@@ -58,12 +58,22 @@ interface UseServerActionErrorResult<TInput, TOutput, TError> extends UseServerA
     status: 'error';
     executedAt: Date;
 }
+type UseServerActionResult<TInput, TOutput, TError> = UseServerActionIdleResult<TInput, TOutput, TError> | UseServerActionSuccessResult<TInput, TOutput, TError> | UseServerActionErrorResult<TInput, TOutput, TError> | UseServerActionPendingResult<TInput, TOutput, TError>;
 /**
  * Use a Server Action Hook
  *
  * @see {@link https://orpc.unnoq.com/docs/server-action#useserveraction-hook Server Action Hook Docs}
  */
-declare function useServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>>(action: ActionableClient<TInput, TOutput, TError>, options?: NoInfer<UseServerActionOptions<TInput, TOutput, UnactionableError<TError>>>): UseServerActionIdleResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionSuccessResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionErrorResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionPendingResult<TInput, TOutput, UnactionableError<TError>>;
+declare function useServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>>(action: ActionableClient<TInput, TOutput, TError>, options?: UseServerActionOptions<TInput, TOutput, UnactionableError<TError>>): UseServerActionResult<TInput, TOutput, UnactionableError<TError>>;
 
-export { useServerAction };
-export type { UseServerActionErrorResult, UseServerActionExecuteOptions, UseServerActionExecuteRest, UseServerActionIdleResult, UseServerActionOptions, UseServerActionPendingResult, UseServerActionResultBase, UseServerActionSuccessResult };
+interface UseOptimisticServerActionOptions<TInput, TOutput, TError, TOptimisticState> extends UseServerActionOptions<TInput, TOutput, TError> {
+    optimisticPassthrough: TOptimisticState;
+    optimisticReducer: (state: TOptimisticState, input: TInput) => TOptimisticState;
+}
+type UseOptimisticServerActionResult<TInput, TOutput, TError, TOptimisticState> = UseServerActionResult<TInput, TOutput, TError> & {
+    optimisticState: TOptimisticState;
+};
+declare function useOptimisticServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>, TOptimisticState>(action: ActionableClient<TInput, TOutput, TError>, options: UseOptimisticServerActionOptions<TInput, TOutput, UnactionableError<TError>, TOptimisticState>): UseOptimisticServerActionResult<TInput, TOutput, UnactionableError<TError>, TOptimisticState>;
+
+export { useOptimisticServerAction, useServerAction };
+export type { UseOptimisticServerActionOptions, UseOptimisticServerActionResult, UseServerActionErrorResult, UseServerActionExecuteOptions, UseServerActionExecuteRest, UseServerActionIdleResult, UseServerActionOptions, UseServerActionPendingResult, UseServerActionResult, UseServerActionResultBase, UseServerActionSuccessResult };

package/dist/hooks/index.mjs

@@ -1,6 +1,6 @@
+import { intercept, toArray, onStart } from '@orpc/shared';
+import { useState, useRef, useTransition, useCallback, useMemo, useOptimistic } from 'react';
 import { safe, createORPCErrorFromJson } from '@orpc/client';
-import { intercept, toArray } from '@orpc/shared';
-import { useState, useRef, useTransition, useCallback, useMemo } from 'react';
 
 const INITIAL_STATE = {
   data: void 0,
@@ -74,4 +74,18 @@ function useServerAction(action, options = {}) {
   return result;
 }
 
-export { useServerAction };
+function useOptimisticServerAction(action, options) {
+  const [optimisticState, addOptimistic] = useOptimistic(options.optimisticPassthrough, options.optimisticReducer);
+  const state = useServerAction(action, {
+    ...options,
+    interceptors: [
+      useCallback(onStart(({ input }) => {
+        addOptimistic(input);
+      }), [addOptimistic]),
+      ...toArray(options.interceptors)
+    ]
+  });
+  return useMemo(() => ({ ...state, optimisticState }), [state, optimisticState]);
+}
+
+export { useOptimisticServerAction, useServerAction };

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { AnySchema } from '@orpc/contract';
 import { Context, ErrorMap, Meta, Lazyable, Procedure, CreateProcedureClientOptions } from '@orpc/server';
-import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
+import { Interceptor, MaybeOptionalOptions, onStart, onSuccess, onError, onFinish } from '@orpc/shared';
 export { getIssueMessage, parseFormData } from '@orpc/openapi-client/standard';
 
 interface FormAction {
@@ -15,5 +15,22 @@ declare const orpcErrorToNextHttpFallbackInterceptor: Interceptor<any, Promise<a
  */
 declare function createFormAction<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): FormAction;
 
-export { createFormAction, orpcErrorToNextHttpFallbackInterceptor };
+/**
+ * Like `onStart`, but defers execution, useful for updating states.
+ */
+declare const onStartDeferred: typeof onStart;
+/**
+ * Like `onSuccess`, but defers execution, useful for updating states.
+ */
+declare const onSuccessDeferred: typeof onSuccess;
+/**
+ * Like `onError`, but defers execution, useful for updating states.
+ */
+declare const onErrorDeferred: typeof onError;
+/**
+ * Like `onFinish`, but defers execution, useful for updating states.
+ */
+declare const onFinishDeferred: typeof onFinish;
+
+export { createFormAction, onErrorDeferred, onFinishDeferred, onStartDeferred, onSuccessDeferred, orpcErrorToNextHttpFallbackInterceptor };
 export type { FormAction };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { AnySchema } from '@orpc/contract';
 import { Context, ErrorMap, Meta, Lazyable, Procedure, CreateProcedureClientOptions } from '@orpc/server';
-import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
+import { Interceptor, MaybeOptionalOptions, onStart, onSuccess, onError, onFinish } from '@orpc/shared';
 export { getIssueMessage, parseFormData } from '@orpc/openapi-client/standard';
 
 interface FormAction {
@@ -15,5 +15,22 @@ declare const orpcErrorToNextHttpFallbackInterceptor: Interceptor<any, Promise<a
  */
 declare function createFormAction<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): FormAction;
 
-export { createFormAction, orpcErrorToNextHttpFallbackInterceptor };
+/**
+ * Like `onStart`, but defers execution, useful for updating states.
+ */
+declare const onStartDeferred: typeof onStart;
+/**
+ * Like `onSuccess`, but defers execution, useful for updating states.
+ */
+declare const onSuccessDeferred: typeof onSuccess;
+/**
+ * Like `onError`, but defers execution, useful for updating states.
+ */
+declare const onErrorDeferred: typeof onError;
+/**
+ * Like `onFinish`, but defers execution, useful for updating states.
+ */
+declare const onFinishDeferred: typeof onFinish;
+
+export { createFormAction, onErrorDeferred, onFinishDeferred, onStartDeferred, onSuccessDeferred, orpcErrorToNextHttpFallbackInterceptor };
 export type { FormAction };

package/dist/index.mjs

@@ -2,7 +2,7 @@ import { ORPCError, createORPCErrorFromJson } from '@orpc/client';
 import { StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
 export { getIssueMessage, parseFormData } from '@orpc/openapi-client/standard';
 import { createProcedureClient } from '@orpc/server';
-import { onError, resolveMaybeOptionalOptions, toArray } from '@orpc/shared';
+import { onError, resolveMaybeOptionalOptions, toArray, onStart, onSuccess, onFinish } from '@orpc/shared';
 
 const orpcErrorToNextHttpFallbackInterceptor = onError((error) => {
   if (error instanceof ORPCError && [401, 403, 404].includes(error.status)) {
@@ -25,4 +25,33 @@ function createFormAction(lazyableProcedure, ...rest) {
   };
 }
 
-export { createFormAction, orpcErrorToNextHttpFallbackInterceptor };
+const onStartDeferred = (callback, ...rest) => {
+  return onStart((...args) => {
+    setTimeout(() => {
+      callback(...args);
+    }, 6);
+  }, ...rest);
+};
+const onSuccessDeferred = (callback, ...rest) => {
+  return onSuccess((...args) => {
+    setTimeout(() => {
+      callback(...args);
+    }, 6);
+  }, ...rest);
+};
+const onErrorDeferred = (callback, ...rest) => {
+  return onError((...args) => {
+    setTimeout(() => {
+      callback(...args);
+    }, 6);
+  }, ...rest);
+};
+const onFinishDeferred = (callback, ...rest) => {
+  return onFinish((...args) => {
+    setTimeout(() => {
+      callback(...args);
+    }, 6);
+  }, ...rest);
+};
+
+export { createFormAction, onErrorDeferred, onFinishDeferred, onStartDeferred, onSuccessDeferred, orpcErrorToNextHttpFallbackInterceptor };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/react",
   "type": "module",
-  "version": "1.6.4",
+  "version": "1.6.5",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -34,11 +34,11 @@
     "react": ">=18.0.0"
   },
   "dependencies": {
-    "@orpc/client": "1.6.4",
-    "@orpc/contract": "1.6.4",
-    "@orpc/openapi-client": "1.6.4",
-    "@orpc/shared": "1.6.4",
-    "@orpc/server": "1.6.4"
+    "@orpc/client": "1.6.5",
+    "@orpc/server": "1.6.5",
+    "@orpc/shared": "1.6.5",
+    "@orpc/contract": "1.6.5",
+    "@orpc/openapi-client": "1.6.5"
   },
   "devDependencies": {
     "react": "^19.1.0",