Rename AsyncActionType to AsyncActionReponse and update the schema of that type

Author: dilane3

dist/helpers/types.d.ts

@@ -36,8 +36,10 @@ export interface CreateAsyncActionReturnType {
     rejected: AsyncActionStatusesType;
     handler: CreateAsyncActionProp;
 }
-export type AsyncActionReturn<T = null> = Promise<{
+export type AsyncActionResponse<P = any, T = null> = Promise<{
+    state: P;
     data: T;
+    error: Error | null;
     status: AsyncActionStatusesType;
 }>;
 export declare const AsyncActionStatuses: {

dist/helpers/types.js.map

@@ -1,7 +1,9 @@
 import { type AsyncActionStatusesType } from '../helpers/types';
 export type Actions = Record<string, (payload?: any) => void>;
 export type AsyncActions<T> = Record<string, (payload?: any) => Promise<{
-    data: T;
+    state: T;
+    data: any | null;
+    error: Error | null;
     status: AsyncActionStatusesType;
 }>>;
 export type Operations<P = any> = Record<string, (payload?: any) => P>;

dist/hooks/types.d.ts

@@ -1,3 +1,3 @@
 import { type AsyncActions } from "./types";
-declare const useAsyncActions: <T, P = AsyncActions<any>>(signalName: string, ...actions: string[]) => P;
+declare const useAsyncActions: <P = AsyncActions<any>>(signalName: string, ...actions: string[]) => P;
 export default useAsyncActions;

dist/hooks/useAsyncActions.d.ts

@@ -1,6 +1,6 @@
 import GXProvider from "./providers/index.js";
 import { AsyncActionStatuses } from "./helpers/types.js";
-import { type AsyncActionReturn } from "./helpers/types.js";
+import { type AsyncActionResponse } from "./helpers/types.js";
 import createSignal from "./helpers/createSignal.js";
 import createStore from "./helpers/createStore.js";
 import createAsyncAction from "./helpers/createAsyncAction.js";
@@ -11,4 +11,4 @@ import useAllSignals from "./hooks/useAllSignals.js";
 import useSignal from "./hooks/useSignal.js";
 import useOperations from "./hooks/useOperations.js";
 export default GXProvider;
-export { createSignal, createStore, createAsyncAction, useAction, useActions, useAsyncActions, useAllSignals, useSignal, useOperations, AsyncActionStatuses, AsyncActionReturn };
+export { createSignal, createStore, createAsyncAction, useAction, useActions, useAsyncActions, useAllSignals, useSignal, useOperations, AsyncActionStatuses, AsyncActionResponse };

dist/hooks/useAsyncActions.js

@@ -56,8 +56,10 @@ export interface CreateAsyncActionReturnType {
   handler: CreateAsyncActionProp;
 }
 
-export type AsyncActionReturn<T = null> = Promise<{
+export type AsyncActionResponse<P = any, T = null> = Promise<{
+  state: P;
   data: T;
+  error: Error | null;
   status: AsyncActionStatusesType;
 }>;
 

dist/hooks/useAsyncActions.js.map

@@ -3,7 +3,9 @@ import { type AsyncActionStatusesType } from '../helpers/types'
 export type Actions = Record<string, (payload?: any) => void>
 
 export type AsyncActions<T> = Record<string, (payload?: any) => Promise<{
-  data: T
+  state: T,
+  data: any | null,
+  error: Error | null,
   status: AsyncActionStatusesType
 }>>
 

dist/index.d.ts

@@ -12,7 +12,7 @@ import { type GXAsyncActionType } from "../contexts/types";
 import { AsyncActionStatuses } from "../helpers/types";
 import { BuilderCase } from "../interfaces/builderCase";
 
-const useAsyncActions = <T, P = AsyncActions<any>>(
+const useAsyncActions = <P = AsyncActions<any>>(
   signalName: string,
   ...actions: string[]
 ) => {
@@ -25,18 +25,31 @@ const useAsyncActions = <T, P = AsyncActions<any>>(
   // Get Global Context
   const { signals, asyncDispatch } = useContext(GXContext);
 
+  // Get state from signals
+  // Extract type from P generic type
+  type StateType = P extends AsyncActions<infer U> ? U : any;
+
+  const state = useMemo<StateType>(() => {
+    const signal = signals.find((signal) => signal.name === signalName);
+
+    if (signal) return signal.state;
+    else throw new Error(`Signal ${signalName} not found`);
+  }, [signals]);
+
   // Refs
   // Define a ref to block the execution of async action callback twice
-  const isAsyncActionCallbackRunning = useRef<{[key: string]: Boolean}>({});
+  const isAsyncActionCallbackRunning = useRef<{ [key: string]: Boolean }>({});
 
   // Async action callback
   const asyncActionCallback = useRef(
-    async (action: GXAsyncActionType<T>, payload?: any) => {
+    async (action: GXAsyncActionType<StateType>, payload?: any) => {
       // Prevent the execution of async action callback twice
       if (isAsyncActionCallbackRunning.current[action.type])
         return new Promise((resolve) => {
           resolve({
             status: AsyncActionStatuses.PENDING,
+            state,
+            error: null,
             data: null,
           });
         });
@@ -66,7 +79,9 @@ const useAsyncActions = <T, P = AsyncActions<any>>(
         });
 
         return {
-          data,
+          state: data,
+          data: response,
+          error: null,
           status: AsyncActionStatuses.FULFILLED,
         };
       } catch (error) {
@@ -79,8 +94,9 @@ const useAsyncActions = <T, P = AsyncActions<any>>(
         });
 
         return {
-          data,
-          error,
+          state: data,
+          data: null,
+          error: new Error(error),
           status: AsyncActionStatuses.REJECTED,
         };
       } finally {
@@ -103,7 +119,7 @@ const useAsyncActions = <T, P = AsyncActions<any>>(
     if (signal) {
       if (!actions || actions.length === 0) return signal.asyncActions || [];
 
-      const filteredActions: Array<GXAsyncActionType<T>> = [];
+      const filteredActions: Array<GXAsyncActionType<StateType>> = [];
 
       for (const action of actions) {
         const actionName = `${signalName}/${action}`;

dist/providers/reducer.js

@@ -5,7 +5,7 @@ import GXProvider from "./providers/index.js";
 import { AsyncActionStatuses } from "./helpers/types.js";
 
 // Types
-import { type AsyncActionReturn } from "./helpers/types.js";
+import { type AsyncActionResponse } from "./helpers/types.js";
 
 // Helpers functions
 import createSignal from "./helpers/createSignal.js";
@@ -33,7 +33,7 @@ export {
   useSignal,
   useOperations,
   AsyncActionStatuses,
-  AsyncActionReturn
+  AsyncActionResponse
 };
 
 // "build": "tsc && npx babel dist --out-dir cjs --extensions '.js' --source-maps inline --copy-files",