@mpxjs/core 2.7.18 → 2.7.29

package/@types/index.d.ts

@@ -7,6 +7,8 @@
 /// <reference path="./mpx-store.d.ts" />
 /// <reference path="./global.d.ts" />
 /// <reference path="./node.d.ts" />
+
+// @ts-ignore
 import VueI18n from 'vue-i18n'
 
 declare module 'vue-i18n' {

package/@types/mpx-store.d.ts

@@ -1,6 +1,11 @@
 declare namespace MpxStore {
   type UnboxDepField<D, F> = F extends keyof D ? D[F] : {}
 
+  interface  compContext{
+    __mpxProxy: object;
+    [key: string]: any
+  }
+
   interface Deps {
     [key: string]: Store | StoreWithThis
   }
@@ -88,7 +93,21 @@ declare namespace MpxStore {
     mapActions(depPath: string, maps: string[]): {
       [key: string]: (...payloads: any[]) => any
     }
+    // 下面是新增的异步store的接口类型
+    mapStateToInstance<K extends keyof S>(maps: K[], context: compContext): void
+    mapStateToInstance(depPath: string, maps: string[], context: compContext): void
+
+    // mapState support object
+    mapStateToInstance<T extends { [key: string]: keyof GetAllMapKeys<S, D, 'state'> }>(obj: T, context: compContext): void
+
+    mapGettersToInstance<K extends keyof G>(maps: K[], context: compContext): void
+    mapGettersToInstance(depPath: string, maps: string[], context: compContext): void
+
+    mapMutationsToInstance<K extends keyof M>(maps: K[], context: compContext): Pick<GetMutations<M>, K>
+    mapMutationsToInstance(depPath: string, maps: string[], context: compContext): void
 
+    mapActionsToInstance<K extends keyof A>(maps: K[], context: compContext): Pick<GetActions<A>, K>
+    mapActionsToInstance(depPath: string, maps: string[], context: compContext): void
   }
   type GetComputedSetKeys<T> = {
     [K in keyof T]: T[K] extends {
@@ -273,6 +292,32 @@ declare namespace MpxStore {
     mapActions<T extends { [key: string]: string }>(obj: T): {
       [I in keyof T]: (...payloads: any[]) => any
     }
+    // 异步store api
+    mapStateToInstance<K extends keyof S>(maps: K[], context: compContext): void
+    mapStateToInstance<T extends string, P extends string>(depPath: P, maps: readonly T[], context: compContext):void
+    mapStateToInstance<T extends mapStateFunctionType<S & UnboxDepsField<D, 'state'>, GetComputedType<G> & UnboxDepsField<D, 'getters'>>>(obj: ThisType<any> & T, context: compContext): void
+    // Support chain derivation
+    mapStateToInstance<T extends { [key: string]: keyof GetAllMapKeys<S, D, 'state'> }>(obj: T, context: compContext): void
+    mapStateToInstance<T extends { [key: string]: keyof S }>(obj: T, context: compContext): void
+    mapStateToInstance<T extends { [key: string]: string }>(obj: T, context: compContext): void
+
+    mapGettersToInstance<K extends keyof G>(maps: K[], context: compContext): void
+    mapGettersToInstance<T extends string, P extends string>(depPath: P, maps: readonly T[], context: compContext): void
+    // Support chain derivation
+    mapGettersToInstance<T extends { [key: string]: keyof GetAllMapKeys<GetComputedType<G>, D, 'getters'> }>(obj: T, context: compContext): void
+    mapGettersToInstance<T extends { [key: string]: keyof G }>(obj: T, context: compContext): void
+    // When importing js in ts file, use this method to be compatible
+    mapGettersToInstance<T extends { [key: string]: string }>(obj: T, context: compContext): void
+
+    mapMutationsToInstance<K extends keyof M>(maps: K[], context: compContext): void
+    mapMutationsToInstance<T extends string, P extends string>(depPath: P, maps: readonly T[], context: compContext): void
+    mapMutationsToInstance<T extends { [key: string]: keyof M }>(obj: T, context: compContext): void
+    mapMutationsToInstance<T extends { [key: string]: string }>(obj: T, context: compContext): void
+
+    mapActionsToInstance<K extends keyof A>(maps: K[], context: compContext): void
+    mapActionsToInstance<T extends string, P extends string>(depPath: P, maps: readonly T[], context: compContext): void
+    mapActionsToInstance<T extends { [key: string]: keyof A }>(obj: T, context: compContext): void
+    mapActionsToInstance<T extends { [key: string]: string }>(obj: T, context: compContext): void
   }
 
   type StoreWithThis<S = {}, G = {}, M = {}, A = {}, D extends Deps = {}> = IStoreWithThis<S, G, M, A, D> & CompatibleDispatch

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpxjs/core",
-  "version": "2.7.18",
+  "version": "2.7.29",
   "description": "mpx runtime core",
   "keywords": [
     "miniprogram",
@@ -41,5 +41,5 @@
     "url": "https://github.com/didi/mpx/issues"
   },
   "sideEffects": false,
-  "gitHead": "5cca51d77d97143319c895dab301ef9a789ce40f"
+  "gitHead": "36f20ba8f22e0a1506679237d1e16df5a2e322b6"
 }

package/src/core/mapStore.js

@@ -3,52 +3,92 @@ import {
   getByPath
 } from '../helper/utils'
 
-import { warn } from '../helper/log'
+import { warn, error } from '../helper/log'
 
 function mapFactory (type, store) {
   return function (depPath, maps) {
     maps = normalizeMap(depPath, maps)
     const result = {}
-    for (let key in maps) {
+    Object.entries(maps).forEach(([key, value]) => {
       result[key] = function (payload) {
-        const value = maps[key]
-        if (type === 'mutations') {
-          return store.commit(value, payload)
-        } else if (type === 'actions') {
-          return store.dispatch(value, payload)
-        } else {
-          let getterVal = getByPath(store.getters, value, '', '__NOTFOUND__')
-          if (getterVal === '__NOTFOUND__') {
-            warn(`Unknown getter named [${value}].`)
-            getterVal = ''
-          }
-          return getterVal
+        switch (type) {
+          case 'state':
+            if (typeof value === 'function') {
+              return value.call(this, store.state, store.getters)
+            } else {
+              let stateVal = getByPath(store.state, value, '', '__NOTFOUND__')
+              if (stateVal === '__NOTFOUND__') {
+                warn(`Unknown state named [${value}].`)
+                stateVal = ''
+              }
+              return stateVal
+            }
+          case 'getters':
+            let getterVal = getByPath(store.getters, value, '', '__NOTFOUND__')
+            if (getterVal === '__NOTFOUND__') {
+              warn(`Unknown getter named [${value}].`)
+              getterVal = ''
+            }
+            return getterVal
+          case 'mutations':
+            return store.commit(value, payload)
+          case 'actions':
+            return store.dispatch(value, payload)
         }
       }
-    }
+    })
     return result
   }
 }
 
+function checkMapInstance (args) {
+  const context = args[args.length - 1]
+  const isValid = context && typeof context === 'object' && context.__mpxProxy
+  if (!isValid) {
+    error(`调用map**ToInstance时必须传入当前component实例this`)
+  }
+
+  args.splice(-1)
+
+  return {
+    restParams: args,
+    context
+  }
+}
+
 export default function (store) {
   return {
     mapGetters: mapFactory('getters', store),
     mapMutations: mapFactory('mutations', store),
     mapActions: mapFactory('actions', store),
-    mapState: (depPath, maps) => {
-      maps = normalizeMap(depPath, maps)
-      const result = {}
-      Object.keys(maps).forEach(key => {
-        const value = maps[key]
-        result[key] = function () {
-          if (typeof value === 'function') {
-            return value.call(this, store.state, store.getters)
-          } else if (typeof value === 'string') {
-            return getByPath(store.state, value)
-          }
-        }
-      })
-      return result
+    mapState: mapFactory('state', store),
+    // 以下是map**ToInstance用于异步store的,参数args：depPath, maps, context
+    mapStateToInstance: (...args) => {
+      const { context, restParams } = checkMapInstance(args)
+      const mapStateFun = mapFactory('state', store)
+      const result = mapStateFun(...restParams)
+      // 将result挂载到mpxProxy实例属性上
+      context.__mpxProxy.options.computed = context.__mpxProxy.options.computed || {}
+      Object.assign(context.__mpxProxy.options.computed, result)
+    },
+    mapGettersToInstance: (...args) => {
+      const { context, restParams } = checkMapInstance(args)
+      const mapGetFun = mapFactory('getters', store)
+      const result = mapGetFun(...restParams)
+      context.__mpxProxy.options.computed = context.__mpxProxy.options.computed || {}
+      Object.assign(context.__mpxProxy.options.computed, result)
+    },
+    mapMutationsToInstance: (...args) => {
+      const { context, restParams } = checkMapInstance(args)
+      const mapMutationFun = mapFactory('mutations', store)
+      const result = mapMutationFun(...restParams)
+      Object.assign(context, result)
+    },
+    mapActionsToInstance: (...args) => {
+      const { context, restParams } = checkMapInstance(args)
+      const mapActionFun = mapFactory('actions', store)
+      const result = mapActionFun(...restParams)
+      Object.assign(context, result)
     }
   }
 }

package/src/core/proxy.js

@@ -41,13 +41,14 @@ export default class MPXProxy {
     this.uid = uid++
     this.name = options.name || ''
     this.options = options
-    // initial -> created -> mounted -> destroyed
-    this.state = 'initial'
+    // beforeCreate -> created -> mounted -> destroyed
+    this.state = BEFORECREATE
     this.lockTask = asyncLock()
     this.ignoreProxyMap = makeMap(EXPORT_MPX.config.ignoreProxyWhiteList)
     if (__mpx_mode__ !== 'web') {
       this._watchers = []
       this._namedWatchers = {}
+      this._computedWatchers = {}
       this._watcher = null
       this.localKeysMap = {} // 非props key
       this.renderData = {} // 渲染函数中收集的数据
@@ -62,13 +63,27 @@ export default class MPXProxy {
     this.initApi()
     this.callUserHook(BEFORECREATE)
     if (__mpx_mode__ !== 'web') {
-      this.initState(this.options)
+      this.initState()
     }
     this.state = CREATED
     this.callUserHook(CREATED, params)
     if (__mpx_mode__ !== 'web') {
-      // 强制走小程序原生渲染逻辑
-      this.options.__nativeRender__ ? this.doRender() : this.initRender()
+      this.initRender()
+    }
+  }
+
+  reCreated (params) {
+    const options = this.options
+    this.state = BEFORECREATE
+    this.callUserHook(BEFORECREATE)
+    if (__mpx_mode__ !== 'web') {
+      this.initComputed(options.computed, true)
+      this.initWatch(options.watch)
+    }
+    this.state = CREATED
+    this.callUserHook(CREATED, params)
+    if (__mpx_mode__ !== 'web') {
+      this.initRender()
     }
   }
 
@@ -118,6 +133,10 @@ export default class MPXProxy {
     this.callUserHook(DESTROYED)
   }
 
+  isDestroyed () {
+    return this.state === DESTROYED
+  }
+
   initApi () {
     // 挂载扩展属性到实例上
     proxy(this.target, this.options.proto, Object.keys(this.options.proto), true, (key) => {
@@ -168,10 +187,15 @@ export default class MPXProxy {
     this.initWatch(options.watch)
   }
 
-  initComputed (computedOpt) {
+  initComputed (computedOpt, reInit) {
     if (computedOpt) {
-      this.collectLocalKeys(computedOpt)
-      initComputed(this, this.data, computedOpt)
+      if (reInit) {
+        // target传递null以跳过computed挂载，仅重新初始化watchers
+        initComputed(this, null, computedOpt)
+      } else {
+        this.collectLocalKeys(computedOpt)
+        initComputed(this, this.data, computedOpt)
+      }
     }
   }
 
@@ -194,7 +218,9 @@ export default class MPXProxy {
       })
       Object.assign(this.data, dataFn.call(this.target))
     }
+    // 此时data中不包括props数据
     this.collectLocalKeys(this.data)
+    // 将props数据合并到data中
     Object.keys(initialData).forEach((key) => {
       if (!hasOwn(this.data, key)) {
         // 除了data函数返回的数据外深拷贝切断引用关系，避免后续watch由于小程序内部对data赋值重复触发watch
@@ -263,6 +289,7 @@ export default class MPXProxy {
     while (i--) {
       this._watchers[i].teardown()
     }
+    this._watchers.length = 0
   }
 
   render () {
@@ -414,9 +441,10 @@ export default class MPXProxy {
   }
 
   initRender () {
-    let renderWatcher
+    if (this.options.__nativeRender__) return this.doRender()
+
     if (this.target.__injectedRender) {
-      renderWatcher = new Watcher(this, () => {
+      this._watcher = new Watcher(this, () => {
         try {
           return this.target.__injectedRender()
         } catch (e) {
@@ -425,11 +453,10 @@ export default class MPXProxy {
         }
       }, noop, { pausable: true })
     } else {
-      renderWatcher = new Watcher(this, () => {
+      this._watcher = new Watcher(this, () => {
         this.render()
       }, noop, { pausable: true })
     }
-    this._watcher = renderWatcher
   }
 
   forceUpdate (data, options, callback) {

package/src/core/transferOptions.js

@@ -17,7 +17,7 @@ export default function transferOptions (options, type) {
   }
   if (currentInject && currentInject.injectComputed) {
     // 编译计算属性注入
-    options.computed = Object.assign({}, options.computed, currentInject.injectComputed)
+    options.computed = Object.assign({}, currentInject.injectComputed, options.computed)
   }
   if (currentInject && currentInject.injectOptions) {
     // 编译option注入,优先微信中的单独配置

package/src/observer/computed.js

@@ -20,10 +20,12 @@ export function initComputed (vm, target, computed) {
       noop,
       { lazy: true }
     )
-    if (!(key in target)) {
-      defineComputed(vm, target, key, userDef)
-    } else {
-      error(`The computed key [${key}] is duplicated with data/props, please check.`, vm.options.mpxFileResource)
+    if (target) {
+      if (!(key in target)) {
+        defineComputed(vm, target, key, userDef)
+      } else {
+        error(`The computed key [${key}] is duplicated with data/props, please check.`, vm.options.mpxFileResource)
+      }
     }
   }
 }

package/src/observer/watch.js

@@ -20,6 +20,19 @@ export function watch (vm, expOrFn, cb, options) {
 
   options = options || {}
   options.user = true
+
+  if (options.once) {
+    const _cb = cb
+    const onceCb = typeof options.once === 'function'
+      ? options.once
+      : function () { return true }
+    cb = function (...args) {
+      const res = onceCb.apply(this, args)
+      if (res) watcher.teardown()
+      _cb.apply(this, args)
+    }
+  }
+
   const watcher = new Watcher(vm, expOrFn, cb, options)
   if (!vm._namedWatchers) vm._namedWatchers = {}
   const name = options.name

package/src/platform/patch/ali/getDefaultOptions.js

@@ -84,23 +84,24 @@ function filterOptions (options, type) {
 }
 
 function initProxy (context, rawOptions, currentInject, params) {
-  // 提供代理对象需要的api
-  transformApiForProxy(context, currentInject)
-  // 缓存options
-  context.$rawOptions = rawOptions
-  // 创建proxy对象
-  const mpxProxy = new MPXProxy(rawOptions, context)
-  context.__mpxProxy = mpxProxy
-  context.__mpxProxy.created(params)
+  if (!context.__mpxProxy) {
+    // 提供代理对象需要的api
+    transformApiForProxy(context, currentInject)
+    // 缓存options
+    context.$rawOptions = rawOptions
+    // 创建proxy对象
+    context.__mpxProxy = new MPXProxy(rawOptions, context)
+    context.__mpxProxy.created(params)
+  } else if (context.__mpxProxy.isDestroyed()) {
+    context.__mpxProxy.reCreated(params)
+  }
 }
 
 export function getDefaultOptions (type, { rawOptions = {}, currentInject }) {
   const hookNames = type === 'component' ? ['onInit', 'didMount', 'didUnmount'] : ['onLoad', 'onReady', 'onUnload']
   const rootMixins = [{
     [hookNames[0]] (...params) {
-      if (!this.__mpxProxy) {
-        initProxy(this, rawOptions, currentInject, params)
-      }
+      initProxy(this, rawOptions, currentInject, params)
     },
     deriveDataFromProps (nextProps) {
       if (this.__mpxProxy && this.__mpxProxy.isMounted() && nextProps && nextProps !== this.props) {
@@ -130,6 +131,7 @@ export function getDefaultOptions (type, { rawOptions = {}, currentInject }) {
     },
     didUpdate () {
       if (this.__mpxProxy) {
+        // todo: lockTask必要性待验证，属性更新触发自身setData时，updated执行与wx对齐，updated触发机制也考虑与wx对齐（props update && setData callback）
         this.__mpxProxy.lockTask(() => {
           this.__mpxProxy.updated()
         })
@@ -143,7 +145,7 @@ export function getDefaultOptions (type, { rawOptions = {}, currentInject }) {
       }
     },
     [hookNames[2]] () {
-      this.__mpxProxy && this.__mpxProxy.destroyed()
+      if (this.__mpxProxy) this.__mpxProxy.destroyed()
     }
   }]
   rawOptions.mixins = rawOptions.mixins ? rootMixins.concat(rawOptions.mixins) : rootMixins

package/src/platform/patch/swan/getDefaultOptions.js

@@ -10,24 +10,20 @@ export function getDefaultOptions (type, { rawOptions = {}, currentInject }) {
 
   const rootMixin = {
     [hookNames[0]] (...params) {
-      if (!this.__mpxProxy) {
-        initProxy(this, rawOptions, currentInject, params)
-      }
+      initProxy(this, rawOptions, currentInject, params)
     },
     [hookNames[1]] () {
-      this.__mpxProxy && this.__mpxProxy.mounted()
+      if (this.__mpxProxy) this.__mpxProxy.mounted()
     },
     [hookNames[2]] () {
-      this.__mpxProxy && this.__mpxProxy.destroyed()
+      if (this.__mpxProxy) this.__mpxProxy.destroyed()
     }
   }
 
   // 如构造页面，优先使用onInit进行初始化
   if (type === 'page') {
     rootMixin.onInit = function (...params) {
-      if (!this.__mpxProxy) {
-        initProxy(this, rawOptions, currentInject, params)
-      }
+      initProxy(this, rawOptions, currentInject, params)
     }
   }
 

package/src/platform/patch/web/getDefaultOptions.js

@@ -24,31 +24,33 @@ function filterOptions (options) {
 }
 
 function initProxy (context, rawOptions, params) {
-  // 缓存options
-  context.$rawOptions = rawOptions
-  // 创建proxy对象
-  const mpxProxy = new MPXProxy(rawOptions, context)
-  context.__mpxProxy = mpxProxy
-  context.__mpxProxy.created(params)
+  if (!context.__mpxProxy) {
+    // 缓存options
+    context.$rawOptions = rawOptions
+    // 创建proxy对象
+    context.__mpxProxy = new MPXProxy(rawOptions, context)
+    context.__mpxProxy.created(params)
+  } else if (context.__mpxProxy.isDestroyed()) {
+    context.__mpxProxy.reCreated(params)
+  }
 }
 
 export function getDefaultOptions (type, { rawOptions = {} }) {
   const rootMixins = [{
     created () {
-      if (!this.__mpxProxy) {
-        const query = (global.__mpxRouter && global.__mpxRouter.currentRoute && global.__mpxRouter.currentRoute.query) || {}
-        initProxy(this, rawOptions, [query])
-        this.onLoad && this.onLoad(query)
-      }
+      const query = (global.__mpxRouter && global.__mpxRouter.currentRoute && global.__mpxRouter.currentRoute.query) || {}
+      initProxy(this, rawOptions, [query])
+      // web中单独触发onLoad
+      this.onLoad && this.onLoad(query)
     },
     mounted () {
-      this.__mpxProxy && this.__mpxProxy.mounted()
+      if (this.__mpxProxy) this.__mpxProxy.mounted()
     },
     updated () {
-      this.__mpxProxy && this.__mpxProxy.updated()
+      if (this.__mpxProxy) this.__mpxProxy.updated()
     },
     destroyed () {
-      this.__mpxProxy && this.__mpxProxy.destroyed()
+      if (this.__mpxProxy) this.__mpxProxy.destroyed()
     }
   }]
   // 为了在builtMixin中可以使用某些rootMixin实现的特性（如数据响应等），此处builtInMixin在rootMixin之后执行，但是当builtInMixin使用存在对应内建生命周期的目标平台声明周期写法时，可能会出现用户生命周期比builtInMixin中的生命周期先执行的情况，为了避免这种情况发生，builtInMixin应该尽可能使用内建生命周期来编写

package/src/platform/patch/wx/getDefaultOptions.js

@@ -117,14 +117,17 @@ export function filterOptions (options) {
 }
 
 export function initProxy (context, rawOptions, currentInject, params) {
-  // 提供代理对象需要的api
-  transformApiForProxy(context, currentInject)
-  // 缓存options
-  context.$rawOptions = rawOptions
-  // 创建proxy对象
-  const mpxProxy = new MPXProxy(rawOptions, context)
-  context.__mpxProxy = mpxProxy
-  context.__mpxProxy.created(params)
+  if (!context.__mpxProxy) {
+    // 提供代理对象需要的api
+    transformApiForProxy(context, currentInject)
+    // 缓存options
+    context.$rawOptions = rawOptions
+    // 创建proxy对象
+    context.__mpxProxy = new MPXProxy(rawOptions, context)
+    context.__mpxProxy.created(params)
+  } else if (context.__mpxProxy.isDestroyed()) {
+    context.__mpxProxy.reCreated(params)
+  }
 }
 
 export function getDefaultOptions (type, { rawOptions = {}, currentInject }) {
@@ -135,15 +138,13 @@ export function getDefaultOptions (type, { rawOptions = {}, currentInject }) {
   }
   const rootMixins = [{
     [hookNames[0]] (...params) {
-      if (!this.__mpxProxy) {
-        initProxy(this, rawOptions, currentInject, params)
-      }
+      initProxy(this, rawOptions, currentInject, params)
     },
     [hookNames[1]] () {
-      this.__mpxProxy && this.__mpxProxy.mounted()
+      if (this.__mpxProxy) this.__mpxProxy.mounted()
     },
     [hookNames[2]] () {
-      this.__mpxProxy && this.__mpxProxy.destroyed()
+      if (this.__mpxProxy) this.__mpxProxy.destroyed()
     }
   }]
   rawOptions.mixins = rawOptions.mixins ? rootMixins.concat(rawOptions.mixins) : rootMixins