fix: types (#83)

* fix: types compatibility

* chore: typo for warning

* chore: lint

Author: alvinhui

src/plugins/effectsStateApis.tsx

@@ -31,7 +31,7 @@ export default (): T.Plugin => {
       function useModelActionsState(name) {
         if (!warnedUseModelActionsState) {
           warnedUseModelActionsState = true;
-          warning('`useModelActionsState` API has been detected, please use `useModelEffectsState` instead. \n\n\n https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#usemodelactionsstate');
+          warning('`useModelActionsState` API has been detected, please use `useModelEffectsState` instead. \n\n\n Visit https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#usemodelactionsstate to learn about how to upgrade.');
         }
         return useModelEffectsState(name);
       }
@@ -41,7 +41,7 @@ export default (): T.Plugin => {
         return function(name: string, mapModelEffectsStateToProps?) {
           if (fieldSuffix === actionsSuffix && !warnedWithModelActionsState) {
             warnedWithModelActionsState = true;
-            warning('`withModelActionsState` API has been detected, please use `withModelEffectsState` instead. \n\n\n https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#withmodelactionsstate');
+            warning('`withModelActionsState` API has been detected, please use `withModelEffectsState` instead. \n\n\n Visit https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#withmodelactionsstate to learn about how to upgrade.');
           }
 
           mapModelEffectsStateToProps = (mapModelEffectsStateToProps || ((effectsState) => ({ [`${name}${fieldSuffix}`]: effectsState })));

src/plugins/modelApis.tsx

@@ -30,7 +30,7 @@ export default (): T.Plugin => {
       function useModelActions(name: string) {
         if (!warnedUseModelActions) {
           warnedUseModelActions = true;
-          warning('`useModelActions` API has been detected, please use `useModelDispatchers` instead. \n\n\n https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#usemodelactions');
+          warning('`useModelActions` API has been detected, please use `useModelDispatchers` instead. \n\n\n Visit https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#usemodelactions to learn about how to upgrade.');
         }
         return useModelDispatchers(name);
       }
@@ -66,7 +66,7 @@ export default (): T.Plugin => {
         return function withModelDispatchers(name: string, mapModelDispatchersToProps?) {
           if (fieldSuffix === actionsSuffix && !warnedWithModelActions) {
             warnedWithModelActions = true;
-            warning('`withModelActions` API has been detected, please use `withModelDispatchers` instead. \n\n\n https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#withmodelactions');
+            warning('`withModelActions` API has been detected, please use `withModelDispatchers` instead. \n\n\n Visit https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#withmodelactions to learn about how to upgrade.');
           }
           mapModelDispatchersToProps = (mapModelDispatchersToProps || ((dispatch) => ({ [`${name}${fieldSuffix}`]: dispatch })));
           return (Component) => {

src/plugins/provider.tsx

@@ -13,7 +13,7 @@ export default ({ context }: ProviderConfig): T.Plugin => {
       const Provider = function(props: { children; initialStates? }) {
         const { children, initialStates } = props;
         if (initialStates) {
-          warning('`initialStates` API has been detected, please use `createStore(model, { initialState })` instead. \n\n\n https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#initialstate');
+          warning('`initialStates` API has been detected, please use `createStore(model, { initialState })` instead. \n\n\n Visit https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#initialstate to learn about how to upgrade.');
           Object.keys(initialStates).forEach(name => {
             const initialState = initialStates[name];
             if (initialState && store.dispatch[name].setState) {

src/types.ts

@@ -57,7 +57,8 @@ export type ExtractIModelDispatchersFromEffects<
     : {}
   : effects extends ModelEffects<any>
     ? ExtractIModelDispatchersFromEffectsObject<effects>
-    : {}
+    : effects extends ConfigEffects<any> ?
+      OldModelEffects<any> : {};
 
 export type ExtractIModelDispatcherFromReducer<R> = R extends () => any
   ? IcestoreDispatcher<void, void>
@@ -221,9 +222,7 @@ export interface ModelPluginAPI<M extends Models = Models> {
 }
 
 export interface ProviderPluginAPI {
-  Provider: ({ children }: {
-    children: any;
-  }) => JSX.Element;
+  Provider: (props: { children: any; initialStates?: any }) => JSX.Element;
 }
 
 export type PresetIcestore<
@@ -281,10 +280,12 @@ export interface ModelConfig<S = any, SS = S> {
   name?: string;
   state: S;
   baseReducer?: (state: SS, action: Action) => SS;
-  reducers?: ModelReducers<S>;
+  reducers?: ModelReducers<S> | ConfigReducers;
   effects?:
   | ModelEffects<any>
-  | ((dispatch: IcestoreDispatch) => ModelEffects<any>);
+  | ((dispatch: IcestoreDispatch) => ModelEffects<any>)
+  | ConfigEffects;
+  actions?: ConfigActions<S>; // @deprecated
 }
 
 export interface PluginFactory extends Plugin {
@@ -385,9 +386,28 @@ declare global {
 }
 
 /** @deprecated */
-export type ConfigPropTypeState<M extends ModelConfig> = ExtractIModelStateFromModelConfig<M>;
-export type ConfigPropTypeEffects<M extends ModelConfig> = ExtractIModelEffectsFromModelConfig<M>;
-export type ConfigPropTypeReducers<M extends ModelConfig> = ExtractIModelReducersFromModelConfig<M>;
-export type ModelActions<M extends ModelConfig> = ExtractIModelDispatchersFromModelConfig<M>;
-export type ModelEffectsState<M extends ModelConfig> = ExtractIModelEffectsStateFromModelConfig<M>;
-export type UseModelValue<M extends ModelConfig> = ExtractIModelFromModelConfig<M>;
+export type ConfigAction<S = any> = (prevState: S, payload?: any, actions?: any, globalActions?: any) => S | Promise<S>;
+export type ConfigEffect<S = any> = (state: S, payload?: any, actions?: any, globalActions?: any) => void | Promise<void>;
+export type ConfigReducer<S = any> = (state: S, payload?: any,) => S;
+export interface ConfigEffects<S = any> {
+  [name: string]: ConfigEffect<S>;
+}
+export interface ConfigReducers<S = any> {
+  [name: string]: ConfigReducer<S>;
+}
+export interface ConfigActions<S = any> {
+  [name: string]: ConfigAction<S>;
+}
+export type Actions<A extends ConfigEffects> = {
+  [K in keyof A]: (payload?: Parameters<A[K]>[1]) => void;
+}
+export type ConfigPropTypeState<C extends ModelConfig> = PropType<C, 'state'>;
+export type ConfigPropTypeActions<C extends ModelConfig> = PropType<C, 'actions'>;
+export type ConfigPropTypeEffects<C extends ModelConfig> = PropType<C, 'effects'>;
+export type ConfigPropTypeReducers<C extends ModelConfig> = PropType<C, 'reducers'>;
+export type ConfigMergedEffects<C extends ModelConfig> = ConfigPropTypeActions<C> & ConfigPropTypeEffects<C>;
+export type OldModelEffects<C extends ModelConfig> = Actions<ConfigMergedEffects<C>>;;
+export type ModelActions<C extends ModelConfig> = Actions<ConfigPropTypeReducers<C> & ConfigPropTypeEffects<C>>;
+export type ModelEffectsState<C extends ModelConfig> = ExtractIModelEffectsStateFromModelConfig<C>;
+export type ModelValue<C extends ModelConfig> = [ ConfigPropTypeState<C>, ModelActions<C>, ModelEffectsState<C> ];
+export type UseModelValue<C extends ModelConfig> = [ ConfigPropTypeState<C>, ModelActions<C> ];

src/utils/converter.ts

@@ -14,7 +14,7 @@ export function convertEffects(originModels: any) {
     const model = originModels[name];
     const originEffects = model.effects;
     if (originEffects && !isFunction(originEffects)) {
-      warning(`Model(${name}): Defining effects as objects has been detected, please use \`{ effects: () => ({ effectName: () => {} }) }\` instead. \n\n\n https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#define-model-effects`);
+      warning(`Model(${name}): Defining effects as objects has been detected, please use \`{ effects: () => ({ effectName: () => {} }) }\` instead. \n\n\n Visit https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#define-model-effects to learn about how to upgrade.`);
       model.effects = (dispatch: any) => {
         const effects = {};
         Object.keys(originEffects).forEach(function(key) {
@@ -48,7 +48,7 @@ export function convertActions(originModels: any) {
     const model = originModels[name];
     const actions = model.actions;
     if (actions) {
-      warning(`Model(${name}): The actions field has been detected, please use \`reducers\` and \`effects\` instead.`);
+      warning(`Model(${name}): The actions field has been detected, please use \`reducers\` and \`effects\` instead. Visit https://github.com/ice-lab/icestore/blob/master/docs/upgrade-guidelines.md#define-model-actions to learn about how to upgrade.`);
       if (!model.reducers) {
         model.reducers = {};
       }