ez-saga 17.0.9 → 17.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ez-saga",
-  "version": "17.0.9",
+  "version": "17.1.1",
   "description": "The ez-saga project is a project that imitates dva-js",
   "main": "src/index.js",
   "sideEffects": false,
@@ -49,7 +49,7 @@
     "babel-loader": "^9.1.3",
     "babel-plugin-dynamic-import-webpack": "^1.1.0",
     "babel-plugin-import": "^1.13.8",
-    "chalk": "^5.3.0",
+    "chalk": "^4.1.2",
     "copy-webpack-plugin": "^12.0.2",
     "core-js": "^3.35.1",
     "cross-env": "^7.0.3",
@@ -67,7 +67,9 @@
     "webpack-bundle-analyzer": "^4.10.1",
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^4.15.1",
-    "webpack-merge": "^5.10.0"
+    "webpack-merge": "^5.10.0",
+    "ts-loader": "^9.5.1",
+    "typescript": "^5.3.3"
   },
   "engines": {
     "node": ">= 14.0.0",
@@ -83,6 +85,8 @@
     "dist",
     "lib",
     "src",
-    "index.js"
+    "index.js",
+    "tysconfig.json",
+    "typing.d.ts"
   ]
 }

package/src/index.d.ts

@@ -1 +1 @@
-export { PayloadAction, EffectTool, Effect, ModelReducer, ModelEffect, ReduxModel, ReduxApp } from './redux/createApp';
+export { PayloadAction, EffectTool, Effect, ModelReducer, ModelEffect, ReduxModel, ReduxApp } from './redux/typeDeclare';

package/src/index.ts

@@ -1,4 +1,4 @@
-export { PayloadAction, EffectTool, Effect, ModelReducer, ModelEffect, ReduxModel, ReduxApp } from './redux/createApp';
+export { PayloadAction, EffectTool, Effect, ModelReducer, ModelEffect, ReduxModel, ReduxApp } from './redux/typeDeclare';
 import createApp from './redux/createApp';
 export default {
   createApp: createApp

package/src/redux/PromiseMiddleware.ts

@@ -0,0 +1,41 @@
+import { Dispatch, Middleware, MiddlewareAPI, Action } from 'redux';
+import { RegistedModel } from './typeDeclare';
+import { PayloadAction } from './typeDeclare';
+/** 
+ * 创建中间层
+ * @param registedModel 已注册model
+ */
+function createPromiseMiddleware<D extends Dispatch>(registedModel: RegistedModel): Middleware<any, any, any> {
+  function isEffect(type: string) {
+    if (!type || typeof type !== 'string') return false;
+    const [modelName, effect] = type.split('/');
+    const model = registedModel[modelName];
+    if (model) {
+      if (model.effects && model.effects[effect]) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  return (api: MiddlewareAPI<D, any>) => (next: (action: PayloadAction) => any) => (action: PayloadAction) => {
+    let exeEffect = false;
+    if ((action as Action)?.type !== undefined) {
+      const { type } = action as Action;
+      exeEffect = isEffect(type);
+    }
+    if (exeEffect) {
+      return new Promise((resolve, reject) => {
+        next({
+          _dy_resolve: resolve,
+          _dy_reject: reject,
+          ...action as Action,
+        });
+      });
+    } else {
+      return next(action);
+    }
+  };
+}
+
+export default createPromiseMiddleware;

package/src/redux/createApp.ts

@@ -1,106 +1,12 @@
 import { legacy_createStore as createStore, applyMiddleware, compose, Action as ReduxAction, Store } from 'redux';
 import { createSlice, combineReducers } from '@reduxjs/toolkit';
-import createSagaMiddleware, { Action, SagaMiddleware } from 'redux-saga';
-import { PutEffect, SelectEffect } from 'redux-saga/effects';
+import createSagaMiddleware, { SagaMiddleware } from 'redux-saga';
 import { call, put, select, takeEvery, putResolve } from 'redux-saga/effects';
 import win from 'global/window';
-import { Reducer, AnyAction } from 'redux';
-
-const saveState: Reducer<any, AnyAction> = (state: any, action: AnyAction) => {
-  if (!action.payload) {
-    return state;
-  }
-  let newStat = {
-    ...state,
-    ...action.payload
-  };
-  return newStat;
-}
-
-/** payload action类型 */
-export interface PayloadAction extends Action<string>, ReduxAction<string> {
-  payload: any
-}
-
-/** 工具 */
-export interface EffectTool {
-  call: (...args: any[]) => any,
-  put: <A extends Action>(action: A) => PutEffect<A>,
-  select: ((selectFunc: (state: any) => any) => SelectEffect) | (() => SelectEffect)
-}
-
-/** Effect函数类型 */
-export interface Effect {
-  (action: PayloadAction, tool: EffectTool): Generator | any;
-}
-
-/** ModelReducer定义 */
-export interface ModelReducer {
-  [key: string]: Reducer<any, AnyAction>;
-}
-
-
-/** ModelEffect定义 */
-export interface ModelEffect {
-  [key: string]: Effect;
-}
-
-export interface ReduxModel {
-  name: string,
-  state?: any;
-  reducers?: ModelReducer
-  effects?: ModelEffect;
-}
-
-interface ReduxSagaModel extends ReduxModel {
-  initialState: any,
-  reducers: ModelReducer
-}
-
-export interface RegistedModel {
-  [key: string]: ReduxModel;
-}
-
-/** app */
-export interface ReduxApp {
-  store: Store<any, ReduxAction>,
-  sagaMiddleware: SagaMiddleware<object>;
-  regist: (model: ReduxModel) => void
-}
-
-/** 
- * 创建中间层
- * @param registedModel 已注册model
- */
-function createPromiseMiddleware(registedModel: RegistedModel) {
-  function isEffect(type: string) {
-    if (!type || typeof type !== 'string') return false;
-    const [modelName, effect] = type.split('/');
-    const model = registedModel[modelName];
-    if (model) {
-      if (model.effects && model.effects[effect]) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  return () => (next: (arg: any) => any) => (action: ReduxAction) => {
-    const { type } = action;
-    if (isEffect(type)) {
-      return new Promise((resolve, reject) => {
-        next({
-          _dy_resolve: resolve,
-          _dy_reject: reject,
-          ...action,
-        });
-      });
-    } else {
-      return next(action);
-    }
-  };
-}
-
+import { Reducer, Action } from 'redux';
+import { ReduxModel, ReduxApp, RegistedModel, ReduxSagaModel, EffectTool, PayloadAction } from './typeDeclare';
+import saveState from './defaultReducer';
+import createPromiseMiddleware from './PromiseMiddleware';
 
 /** 
  * 获取注册model函数
@@ -111,7 +17,7 @@ function createPromiseMiddleware(registedModel: RegistedModel) {
  * @returns 返回function regist(model)
  */
 function getRegistModelFunc(store: Store<any, ReduxAction>, registedModel: RegistedModel,
-  allReducers: { [x: string]: Reducer<any, AnyAction>; },
+  allReducers: { [x: string]: Reducer<any, Action>; },
   sagaMiddleware: SagaMiddleware<object>): (model: ReduxModel) => void {
   /** model函数注册函数
    * @param model 模块, 其格式为
@@ -154,7 +60,7 @@ function getRegistModelFunc(store: Store<any, ReduxAction>, registedModel: Regis
     for (let effect in model.effects) {
       let type: string = `${model.name}/${effect}`;
       let execFun = model.effects[effect];
-      function* loading(opFun: any, action: any) {
+      function* loading(opFun: EffectTool, action: PayloadAction) {
         // 开始异步任务设置loading状态
         yield putResolve({ type: `${model.name}/saveState`, payload: { loading: true } });
         let ret = yield call(execFun, action, opFun);

package/src/redux/defaultReducer.ts

@@ -0,0 +1,16 @@
+/** 默认reducer */
+import { Reducer } from 'redux';
+import { PayloadAction } from './typeDeclare';
+
+const saveState: Reducer<any, PayloadAction> = (state: any, action: PayloadAction) => {
+  if (!action.payload) {
+    return state;
+  }
+  let newStat = {
+    ...state,
+    ...action.payload
+  };
+  return newStat;
+};
+
+export default saveState;

package/src/redux/typeDeclare.ts

@@ -0,0 +1,73 @@
+/** 类型申明 */
+import {
+  Action as ReduxAction, Store, Reducer, AnyAction
+} from 'redux';
+import { Action, SagaMiddleware } from 'redux-saga';
+import { PutEffect, SelectEffect } from 'redux-saga/effects';
+
+/** payload action类型 */
+export interface PayloadAction extends AnyAction, ReduxAction<string> {
+  /** 类型 */
+  type: string,
+  /** 载体 */
+  payload?: any,
+  [extraProps: string]: any;
+}
+
+/** 工具 */
+export interface EffectTool {
+  /** 调用异步函数, 并获得该异步函数的结果 */
+  call: (...args: any[]) => any,
+  /** 分发异步action */
+  put: <A extends Action>(action: A) => PutEffect<A>,
+  /** 分发同步action */
+  putResolve: <A extends Action>(action: A) => PutEffect<A>,
+  /** 从store从获取状态 */
+  select: ((selectFunc: (state: any) => any) => SelectEffect) | (() => SelectEffect)
+}
+
+/** Effect函数类型 */
+export interface Effect {
+  (action: PayloadAction, tool: EffectTool): Generator | any;
+}
+
+/** ModelReducer定义 */
+export interface ModelReducer {
+  [key: string]: Reducer<any, PayloadAction>;
+}
+
+
+/** ModelEffect定义 */
+export interface ModelEffect {
+  [key: string]: Effect;
+}
+
+export interface ReduxModel {
+  name: string,
+  state?: any;
+  reducers?: ModelReducer
+  effects?: ModelEffect;
+}
+
+export interface ReduxSagaModel extends ReduxModel {
+  initialState: any,
+  reducerPath: string
+  reducers: ModelReducer
+}
+
+export interface RegistedModel {
+  [key: string]: ReduxModel
+}
+
+/** app */
+export interface ReduxApp {
+  store: Store<any, ReduxAction>,
+  sagaMiddleware: SagaMiddleware<object>;
+  regist: (model: ReduxModel) => void
+}
+
+
+export interface ReduxSagaModel extends ReduxModel {
+  initialState: any,
+  reducers: ModelReducer
+}