Merge pull request #10 from react-gx/dev

ADD: Adding Async State to GX

Author: dilane3

.eslintrc.json

@@ -0,0 +1,18 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": ["standard-with-typescript", "plugin:react/recommended"],
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": ["react", "immutable"],
+    "rules": {
+        "immutable/no-mutation": "error",
+        "no-console": "error"
+    },
+    "ignorePatterns": ["node_modules/*", "dist/*", "/src/tests/*"] // Add the files or folders you want to exclude here
+}

.npmignore

@@ -1,3 +1,6 @@
 node_modules
 src
 tsconfig.json
+.babelrc
+yarn.lock
+.eslintrc.json

dist/contexts/index.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="react" />
-import { GXContextType } from "./types.js";
+import { type GXContextType } from './types.js';
 declare const GXContext: import("react").Context<GXContextType>;
 export default GXContext;

dist/contexts/index.js

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

dist/contexts/index.js.map

@@ -0,0 +1,8 @@
+import { type CreateAsyncActionProp, type 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 { type CreateSignalOptionType } from './types.js';
+import { type GXActionType, type GXAsyncActionType, type 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;