Release/1.4.1 (#116)

* docs: language link for migration

* docs: add link for upgrade guidelines

* fix: immer error (#117)

* feat: set error & loading as blacklist for immer pulgin

* chore: lint

* chore: notice

Author: alvinhui

docs/migration.md

@@ -3,6 +3,8 @@ id: migration
 title: Migration
 ---
 
+English | [简体中文](./migration.zh-CN.md)
+
 ## Migrating From Redux
 
 We provide a gradual solution to allow your project to be partially migrated from Redux to icestore.

docs/migration.zh-CN.md

@@ -3,6 +3,8 @@ id: migration
 title: Migration
 ---
 
+[English](./migration.md) | 简体中文
+
 ## 从 Redux 迁移
 
 我们提供了渐进式的方案使得您的项目可以局部从 Redux 迁移到 icestore。

docs/upgrade-guidelines.zh-CN.md

@@ -7,7 +7,7 @@ title: Upgrade Guidelines
 
 ## 从 1.2.0 升级到 1.3.0
 
-1.3.0 是完全向下兼容的，但是我们推荐您在新增代码中使用最新的 API。
+1.3.0 是完全向下兼容的，但是我们推荐您在新增代码中使用最新的 API。1.2.x 有一些已知的[功能不完备](https://github.com/alibaba/ice/issues/3037)，您必须知晓。
 
 我们会在未来的版本中删除标记为「已过期」的 API。
 
@@ -128,7 +128,7 @@ export default withModelDispatchers('todos')(TodoList);
 
 ## 从 1.0.0 升级到 1.3.0
 
-1.3.0 是完全向下兼容的，但是我们推荐您在新增代码中使用最新的 API。
+1.3.0 是完全向下兼容的，但是我们推荐您在新增代码中使用最新的 API。1.0.x 有一些已知的[功能不完备](https://github.com/alibaba/ice/issues/3037)，您必须知晓。
 
 我们会在未来的版本中删除标记为「已过期」的 API。
 
@@ -246,7 +246,7 @@ export default withModelEffectsState('todos')(TodoList);
 
 从 0.x.x 到 1.x.x 是不兼容的。您可以选择性地进行升级。
 
-但 0.x.x 有一些已知的缺陷，您必须知晓：https://github.com/alibaba/ice/issues/3037
+但 0.x.x 有一些已知的[缺陷](https://github.com/alibaba/ice/issues/3037)，您必须知晓。
 
 ### Define Model
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ice/store",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Simple and friendly state for React",
   "main": "lib/index.js",
   "files": [

src/index.tsx

@@ -55,17 +55,19 @@ export const createStore = <M extends T.Models, C extends T.CreateStoreConfig<M>
   plugins.push(createReduxHooksPlugin({context}));
   plugins.push(createModelApisPlugin());
 
-  const loading = createLoadingPlugin();
-  const error = createErrorPlugin();
-  const immer = createImmerPlugin();
-  if (!disableImmer) {
-    plugins.push(immer);
-  }
+  // https://github.com/ice-lab/icestore/issues/94
+  // TODO: fix error & loading plugin immer problem
+  const immerBlacklist = [];
   if (!disableLoading) {
-    plugins.push(loading);
+    plugins.push(createLoadingPlugin());
+    immerBlacklist.push('loading');
   }
   if (!disableError) {
-    plugins.push(error);
+    plugins.push(createErrorPlugin());
+    immerBlacklist.push('error');
+  }
+  if (!disableImmer) {
+    plugins.push(createImmerPlugin({ blacklist: immerBlacklist }));
   }
 
   // compatibility handling

src/plugins/immer.ts

@@ -2,29 +2,35 @@ import produce from 'immer';
 import { combineReducers, ReducersMapObject } from 'redux';
 import * as T from '../types';
 
-function combineReducersWithImmer(reducers: ReducersMapObject) {
-  const reducersWithImmer: ReducersMapObject<any, T.Action<any>> = {};
-  // reducer must return value because literal don't support immer
+export interface ImmerConfig {
+  blacklist?: string[];
+}
+
+function createCombineReducersWithImmer(blacklist: string[] = []) {
+  return function(reducers: ReducersMapObject) {
+    const reducersWithImmer: ReducersMapObject<any, T.Action<any>> = {};
+    // reducer must return value because literal don't support immer
 
-  Object.keys(reducers).forEach((key) => {
-    const reducerFn = reducers[key];
-    reducersWithImmer[key] = (state, payload) =>
-      typeof state === 'object'
-        ? produce(state, (draft: T.Models) => {
-          const next = reducerFn(draft, payload);
-          if (typeof next === 'object') return next;
-        })
-        : reducerFn(state, payload);
-  });
+    Object.keys(reducers).forEach((key) => {
+      const reducerFn = reducers[key];
+      reducersWithImmer[key] = (state, payload) =>
+        typeof state === 'object' && !blacklist.includes(key)
+          ? produce(state, (draft: T.Models) => {
+            const next = reducerFn(draft, payload);
+            if (typeof next === 'object') return next;
+          })
+          : reducerFn(state, payload);
+    });
 
-  return combineReducers(reducersWithImmer);
+    return combineReducers(reducersWithImmer);
+  };
 }
 
 // icestore plugin
-const immerPlugin = (): T.Plugin => ({
+const immerPlugin = (config: ImmerConfig = {}): T.Plugin => ({
   config: {
     redux: {
-      combineReducers: combineReducersWithImmer,
+      combineReducers: createCombineReducersWithImmer(config.blacklist),
     },
   },
 });