@mpxjs/core 2.7.16 → 2.7.26

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.16",
+  "version": "2.7.26",
   "description": "mpx runtime core",
   "keywords": [
     "miniprogram",
@@ -41,5 +41,5 @@
     "url": "https://github.com/didi/mpx/issues"
   },
   "sideEffects": false,
-  "gitHead": "7a2b5ae385cbd035172ec11bc0bfba84eff10243"
+  "gitHead": "bfad123d02a216278c122135148ba2a3977121d0"
 }

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/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/index.js

@@ -104,13 +104,6 @@ if (__mpx_mode__ === 'web') {
   watch = vm.$watch.bind(vm)
   const set = Vue.set.bind(Vue)
   const del = Vue.delete.bind(Vue)
-  const remove = function (...args) {
-    if (process.env.NODE_ENV !== 'production') {
-      error('$remove will be removed in next minor version, please use $delete instead!', this.$rawOptions && this.$rawOptions.mpxFileResource)
-    }
-    return del.apply(this, args)
-  }
-  // todo 补齐web必要api
   APIs = {
     createApp,
     createPage,
@@ -124,15 +117,10 @@ if (__mpx_mode__ === 'web') {
     watch,
     use,
     set,
-    remove,
     delete: del,
     getMixin,
     implement
   }
-
-  InstanceAPIs = {
-    $remove: remove
-  }
 } else {
   observable = function (obj) {
     observe(obj)
@@ -140,18 +128,10 @@ if (__mpx_mode__ === 'web') {
   }
 
   const vm = {}
-
   watch = function (expOrFn, cb, options) {
     return watchWithVm(vm, expOrFn, cb, options)
   }
 
-  const remove = function (...args) {
-    if (process.env.NODE_ENV !== 'production') {
-      error('$remove will be removed in next minor version, please use $delete instead!', this.$rawOptions && this.$rawOptions.mpxFileResource)
-    }
-    return del.apply(this, args)
-  }
-
   APIs = {
     createApp,
     createPage,
@@ -165,7 +145,6 @@ if (__mpx_mode__ === 'web') {
     watch,
     use,
     set,
-    remove,
     delete: del,
     getMixin,
     implement
@@ -173,7 +152,6 @@ if (__mpx_mode__ === 'web') {
 
   InstanceAPIs = {
     $set: set,
-    $remove: remove,
     $delete: del
   }
 }

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