Add: Async State v1

Author: dilane3

dist/contexts/index.js

@@ -1,24 +1,49 @@
 /// <reference types="react" />
+import IBuilderCase from "../interfaces/builderCase.js";
 import { GXAction } from "../providers/types.js";
+/**
+ * Type that represents a signal
+ */
 export type GXSignalType<T = any> = {
     name: string;
     state: T;
-    actions: GXActionType<T>[];
+    actions?: GXActionType<T>[];
     operations?: GXOperationType<T>[];
+    asyncActions?: GXAsyncActionType<T>[];
 };
+/**
+ * Type that represents Actions
+ */
 export type GXActionType<T, P = any> = {
     type: string;
     handler: (state: T, payload: P) => T;
 };
+/**
+ * Type that represents operations
+ */
 export type GXOperationType<T, P = any, Q = any> = {
     type: string;
     handler: (state: T, payload: P) => Q;
 };
+/**
+ * Type that represents async actions
+ */
+export type GXAsyncActionType<T, P = any> = {
+    type: string;
+    steps: IBuilderCase<T, P>;
+};
+/**
+ * Type of dispatched action
+ */
 export type DispatchedActionType = {
     type: string;
     payload: any;
 };
+/**
+ * Type of the signals context
+ */
 export type GXContextType = {
     signals: GXSignalType[];
     dispatch: React.Dispatch<GXAction>;
+    asyncDispatch: (action: GXAction) => any;
 };

dist/contexts/index.js.map

@@ -0,0 +1,8 @@
+import { CreateAsyncActionProp, CreateAsyncActionReturnType } from "./types.js";
+/**
+ * This function create an async action with different statuses
+ * @param handler Function that perform asynchronous task
+ * @returns
+ */
+declare const createAsyncAction: (handler: CreateAsyncActionProp) => CreateAsyncActionReturnType;
+export default createAsyncAction;

dist/contexts/types.d.ts

@@ -1,5 +1,5 @@
 import { CreateSignalOptionType } from "./types.js";
-import { GXActionType, GXOperationType } from "../contexts/types.js";
+import { GXActionType, GXAsyncActionType, GXOperationType } from "../contexts/types.js";
 /**
  * Create a signal with a state and actions for managing this state
  * @param options
@@ -10,5 +10,6 @@ declare const createSignal: <T>(options: CreateSignalOptionType<T>) => {
     state: T;
     actions: GXActionType<T, any>[];
     operations: GXOperationType<T, any, any>[];
+    asyncActions: GXAsyncActionType<T, any>[];
 };
 export default createSignal;

dist/helpers/createAsyncAction.d.ts

@@ -1,4 +1,9 @@
 import { GXSignalType } from "../contexts/types.js";
 import { CreateStoreType } from "./types.js";
+/**
+ * Function that create a store by collection a list of signals
+ * @param signals List of signals
+ * @returns
+ */
 declare const createStore: (signals: GXSignalType[]) => CreateStoreType;
 export default createStore;