Merge pull request #33 from janglad/bug/type-bugs-docs

update doc, add and fix exposed types

.changeset/nervous-chicken-prove.md

@@ -0,0 +1,8 @@
+---
+"safe-fn": patch
+---
+
+- Add InferActionErrError and InferActionOkData types
+- Add InferAsyncOkData and InferAsyncErrError types
+- Rename some types for clarity
+- Improve type docs

.gitignore

@@ -7,4 +7,31 @@ coverage
 sandbox.ts
 .turbo
 dist/
-.env
+.env
+
+
+#From Fumadocs
+# generated content
+.contentlayer
+.content-collections
+.source
+
+# test & build
+.next
+.next
+/out/
+/build
+*.tsbuildinfo
+
+# misc
+*.pem
+/.pnp
+.pnp.js
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# others
+.env*.local
+.vercel
+next-env.d.ts

packages/safe-fn-react/src/useServerAction.ts

@@ -25,7 +25,7 @@ export const useServerAction = <TAction extends AnySafeFnAction>(
 ): UseServerActionReturn<TAction> => {
   type ActionArgs = InferSafeFnActionArgs<TAction>;
   /** Original `ActionResult<T,E>` */
-  type ActionActionResult = InferSafeFnActionReturn<TAction>;
+  type ActionActionResult = Awaited<InferSafeFnActionReturn<TAction>>;
   /** Converted `ActionResult<T,E>` -\> `Result<T,E>` to be returned to the user  */
   type ActionResult = ActionResultToResult<ActionActionResult>;
 

packages/safe-fn/src/index.ts

@@ -1,10 +1,14 @@
 import type { Err, Ok, Result } from "./result";
 import {
-  type ActionResult,
-  type ActionResultToResult,
   actionResultToResult,
   err,
   ok,
+  type ActionErr,
+  type ActionOk,
+  type ActionResult,
+  type ActionResultToResult,
+  type InferActionErrError,
+  type InferActionOkData,
 } from "./result";
 import { SafeFnBuilder } from "./safe-fn-builder";
 
@@ -14,14 +18,14 @@ import type {
   AnySafeFnThrownHandler,
   InferInputSchema,
   InferOutputSchema,
-  InferReturn,
-  InferReturnData,
-  InferReturnError,
-  InferRunArgs,
   InferSafeFnActionArgs,
   InferSafeFnActionError,
   InferSafeFnActionOkData,
   InferSafeFnActionReturn,
+  InferSafeFnArgs,
+  InferSafeFnErrError,
+  InferSafeFnOkData,
+  InferSafeFnReturn,
   InferUnparsedInput,
   SafeFnAction,
   SafeFnActionArgs,
@@ -36,30 +40,34 @@ import type {
 
 export { actionResultToResult, err, ok, SafeFnBuilder as SafeFn };
 export type {
+  ActionErr,
+  ActionOk,
   ActionResult,
   ActionResultToResult,
   AnyRunnableSafeFn,
   AnySafeFnAction,
   AnySafeFnThrownHandler,
   Err,
+  InferActionErrError,
+  InferActionOkData,
   InferInputSchema,
   InferOutputSchema,
-  InferReturn,
-  InferReturnData,
-  InferReturnError,
-  InferRunArgs,
   InferSafeFnActionArgs,
   InferSafeFnActionError,
   InferSafeFnActionOkData,
   InferSafeFnActionReturn,
+  InferSafeFnArgs,
+  InferSafeFnErrError,
+  InferSafeFnOkData,
+  InferSafeFnReturn,
   InferUnparsedInput,
   Ok,
   Result,
   SafeFnAction,
   SafeFnActionArgs,
   SafeFnActionReturn,
   SafeFnAsyncGeneratorHandlerFn,
-  SafeFnRegularHandlerFn as SafeFnHandlerFn,
+  SafeFnRegularHandlerFn,
   SafeFnReturn,
   SafeFnReturnData,
   SafeFnReturnError,

packages/safe-fn/src/result.ts

@@ -6,12 +6,16 @@ export type AnyResult = Result<any, any>;
 
 export type Ok<TData, TError = never> = NT.Ok<TData, TError>;
 export type InferOkData<T> = T extends Result<infer TData, any> ? TData : never;
+export type InferAsyncOkData<T> =
+  T extends ResultAsync<infer TData, any> ? TData : never;
 
 export const ok = <const TData>(data: TData): Ok<TData, never> => NT.ok(data);
 
 export type Err<TData = never, TError = unknown> = NT.Err<TData, TError>;
 export type InferErrError<T> =
   T extends Result<any, infer TError> ? TError : never;
+export type InferAsyncErrError<T> =
+  T extends ResultAsync<any, infer TError> ? TError : never;
 
 export type AnyErr = Err<never, any>;
 export const err = <const TError>(error: TError): Err<never, TError> =>
@@ -43,13 +47,16 @@ export type ActionOk<T> = {
   value: T;
 };
 export const actionOk = <T>(value: T): ActionOk<T> => ({ ok: true, value });
+export type InferActionOkData<T> =
+  T extends ActionOk<infer TData> ? TData : never;
 
 export type ActionErr<E> = {
   ok: false;
   error: E;
 };
 export const actionErr = <E>(error: E): ActionErr<E> => ({ ok: false, error });
-
+export type InferActionErrError<T> =
+  T extends ActionErr<infer TError> ? TError : never;
 /**
  * Converts a `ResultAsync<T,E>` to a `Promise<Result<T,E>>`.
  */