@mpxjs/core 2.8.40-test → 2.8.40-test.2

package/@types/index.d.ts

@@ -24,25 +24,33 @@ type UnionToIntersection<U> = (U extends any
   ? (k: U) => void
   : never) extends ((k: infer I) => void)
   ? I
-  : never;
+  : never
 
-type ArrayType<T extends any[]> = T extends Array<infer R> ? R : never;
+type ArrayType<T extends any[]> = T extends Array<infer R> ? R : never
 
 // Mpx types
 type Data = object | (() => object)
 
-type PropConstructor<T = any> = {
-  new (...args: any[]): T & {};
-} | {
-  (): T;
-}
-
-export type PropType<T> = PropConstructor<T>
+export type PropType<T> = {
+  __type: T
+} & (
+  T extends String
+    ? StringConstructor
+    : T extends number
+      ? NumberConstructor
+      : T extends boolean
+        ? BooleanConstructor
+        : T extends any[]
+          ? ArrayConstructor
+          : T extends object
+            ? ObjectConstructor
+            : never
+  )
 
 type FullPropType<T> = {
-  type: PropType<T>;
-  value?: T;
-  optionalTypes?: PropType<T>[];
+  type: PropType<T>
+  value?: T
+  optionalTypes?: WechatMiniprogram.Component.ShortProperty[]
 }
 
 interface Properties {
@@ -75,27 +83,17 @@ interface WatchField {
 
 type GetDataType<T> = T extends () => any ? ReturnType<T> : T
 
-type PropValueType<Def> = Def extends {
-    type: (...args: any[]) => infer T;
-    optionalType?: ((...args: any[]) => infer T)[];
-    value?: infer T;
-  }
-  ? T
-  : Def extends (...args: any[]) => infer T
-    ? T
-    : Def extends FullPropType<infer T>
-      ? T
-      : Def extends PropType<infer T>
-        ? T
-        : any;
-
-type GetPropsType<T> = {
-  readonly [K in keyof T]: PropValueType<T[K]>
+type GetPropsType<T extends Properties> = {
+  readonly [K in keyof T]: T[K] extends FullPropType<infer V>
+    ? V
+    : T[K] extends PropType<infer V>
+      ? V
+      : WechatMiniprogram.Component.PropertyToData<T[K]>
 }
 
 type RequiredPropertyNames<T> = {
   [K in keyof T]-?: T[K] extends undefined ? never : K
-}[keyof T];
+}[keyof T]
 
 type RequiredPropertiesForUnion<T> = T extends object ? Pick<T, RequiredPropertyNames<T>> : never
 
@@ -126,7 +124,7 @@ interface Context {
   createIntersectionObserver: WechatMiniprogram.Component.InstanceMethods<Record<string, any>>['createIntersectionObserver']
 }
 
-interface ComponentOpt<D, P, C, M, Mi extends Array<any>, S extends Record<any, any>> extends Partial<WechatMiniprogram.Component.Lifetimes & WechatMiniprogram.Component.OtherOption> {
+interface ComponentOpt<D extends Data, P extends Properties, C, M extends Methods, Mi extends Array<any>, S extends Record<any, any>> extends Partial<WechatMiniprogram.Component.Lifetimes & WechatMiniprogram.Component.OtherOption> {
   data?: D
   properties?: P
   computed?: C
@@ -144,7 +142,7 @@ interface ComponentOpt<D, P, C, M, Mi extends Array<any>, S extends Record<any,
   [index: string]: any
 }
 
-type PageOpt<D, P, C, M, Mi extends Array<any>, S extends Record<any, any>> =
+type PageOpt<D extends Data, P extends Properties, C, M extends Methods, Mi extends Array<any>, S extends Record<any, any>> =
   ComponentOpt<D, P, C, M, Mi, S>
   & Partial<WechatMiniprogram.Page.ILifetime>
 
@@ -281,11 +279,11 @@ interface ImplementOptions {
 
 export function toPureObject<T extends object> (obj: T): T
 
-declare type PluginInstallFunction = (app: Mpx, ...options: any[]) => any;
+declare type PluginInstallFunction = (app: Mpx, ...options: any[]) => any
 
 export type Plugin = PluginInstallFunction | {
-  install: PluginInstallFunction;
-};
+  install: PluginInstallFunction
+}
 
 export interface Mpx {
   getMixin: typeof getMixin
@@ -670,7 +668,7 @@ export const ONHIDE: string
 export const ONRESIZE: string
 
 declare global {
-  const defineProps: (<T>(props: T) => Readonly<GetPropsType<T>>) & (<T>() => Readonly<T>)
+  const defineProps: (<T extends Properties = {}>(props: T) => Readonly<GetPropsType<T>>) & (<T>() => Readonly<T>)
   const defineOptions: <D extends Data = {}, P extends Properties = {}, C = {}, M extends Methods = {}, Mi extends Array<any> = [], S extends AnyObject = {}, O extends AnyObject = {}> (opt: ThisTypedComponentOpt<D, P, C, M, Mi, S, O>) => void
   const defineExpose: <E extends AnyObject = AnyObject>(exposed?: E) => void
   const useContext: () => Context

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@mpxjs/core",
-  "version": "2.8.40-test",
+  "version": "2.8.40-test.2",
   "description": "mpx runtime core",
   "keywords": [
     "miniprogram",
     "mpx"
   ],
   "author": "donghongping",
-  "license": "Apache",
+  "license": "Apache-2.0",
   "module": "src/index.js",
   "types": "@types/index.d.ts",
   "directories": {
@@ -19,15 +19,15 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@mpxjs/utils": "^2.8.40-test",
+    "@mpxjs/utils": "^2.8.40-test.2",
     "lodash": "^4.1.1",
     "miniprogram-api-typings": "^3.10.0"
   },
   "peerDependencies": {
-    "@mpxjs/api-proxy": "^2.7.44",
-    "@mpxjs/store": "^2.8.0",
+    "@mpxjs/api-proxy": "^2.9.0",
+    "@mpxjs/store": "^2.9.0",
     "vue": "^2.7.10",
-    "vue-demi": "^0.13.11",
+    "vue-demi": "^0.14.6",
     "vue-i18n": "^8.27.2",
     "vue-i18n-bridge": "^9.2.2"
   },
@@ -47,5 +47,5 @@
     "url": "https://github.com/didi/mpx/issues"
   },
   "sideEffects": false,
-  "gitHead": "8524f9b69ebcfb0667ebff2608cf6f675f14f141"
+  "gitHead": "7b1911025a2eb47eddc046775f17b6f1405fdd54"
 }

package/src/core/innerLifecycle.js

@@ -10,6 +10,7 @@ export const ONLOAD = '__onLoad__'
 export const ONSHOW = '__onShow__'
 export const ONHIDE = '__onHide__'
 export const ONRESIZE = '__onResize__'
+export const SERVERPREFETCH = '__serverPrefetch__'
 
 export const INNER_LIFECYCLES = [
   BEFORECREATE,
@@ -19,6 +20,7 @@ export const INNER_LIFECYCLES = [
   BEFOREUPDATE,
   UPDATED,
   BEFOREUNMOUNT,
+  SERVERPREFETCH,
   UNMOUNTED,
   ONLOAD,
   ONSHOW,

package/src/core/mergeOptions.js

@@ -314,17 +314,19 @@ export function mergeToArray (parent, child, key) {
 function composeHooks (target, includes) {
   Object.keys(target).forEach(key => {
     if (!includes || includes[key]) {
-      const hooksArr = target[key]
-      hooksArr && (target[key] = function (...args) {
-        let result
-        for (let i = 0; i < hooksArr.length; i++) {
-          if (typeof hooksArr[i] === 'function') {
-            const data = hooksArr[i].apply(this, args)
-            data !== undefined && (result = data)
+      const hooks = target[key]
+      if (Array.isArray(hooks)) {
+        target[key] = function (...args) {
+          let result
+          for (let i = 0; i < hooks.length; i++) {
+            if (typeof hooks[i] === 'function') {
+              const data = hooks[i].apply(this, args)
+              data !== undefined && (result = data)
+            }
           }
+          return result
         }
-        return result
-      })
+      }
     }
   })
 }
@@ -352,7 +354,7 @@ function transformHOOKS (options) {
     const componentHooksMap = makeMap(convertRule.lifecycle.component)
     for (const key in options) {
       // 使用Component创建page实例，页面专属生命周期&自定义方法需写在methods内部
-      if (typeof options[key] === 'function' && key !== 'dataFn' && key !== 'setup' && !componentHooksMap[key]) {
+      if (typeof options[key] === 'function' && key !== 'dataFn' && key !== 'setup' && key !== 'serverPrefetch' && !componentHooksMap[key]) {
         if (!options.methods) options.methods = {}
         options.methods[key] = options[key]
         delete options[key]

package/src/core/proxy.js

@@ -37,6 +37,7 @@ import {
   BEFOREUPDATE,
   UPDATED,
   BEFOREUNMOUNT,
+  SERVERPREFETCH,
   UNMOUNTED,
   ONLOAD,
   ONSHOW,
@@ -659,6 +660,7 @@ export const onLoad = createHook(ONLOAD)
 export const onShow = createHook(ONSHOW)
 export const onHide = createHook(ONHIDE)
 export const onResize = createHook(ONRESIZE)
+export const onServerPrefetch = createHook(SERVERPREFETCH)
 export const onPullDownRefresh = createHook('__onPullDownRefresh__')
 export const onReachBottom = createHook('__onReachBottom__')
 export const onShareAppMessage = createHook('__onShareAppMessage__')

package/src/index.js

@@ -29,6 +29,7 @@ export {
   UPDATED,
   BEFOREUNMOUNT,
   UNMOUNTED,
+  SERVERPREFETCH,
   ONLOAD,
   ONSHOW,
   ONHIDE,
@@ -42,6 +43,7 @@ export {
   onUpdated,
   onBeforeUnmount,
   onUnmounted,
+  onServerPrefetch,
   onLoad,
   onShow,
   onHide,

package/src/platform/builtInMixins/pageScrollMixin.web.js

@@ -41,6 +41,7 @@ export default function pageScrollMixin (mixinType) {
   return {
     mounted () {
       this.__lastScrollY = 0
+      this.__originalOverflow = document.body.style.overflow
     },
     activated () {
       if (!refreshMs()) {
@@ -72,19 +73,22 @@ export default function pageScrollMixin (mixinType) {
       }
     },
     deactivated () {
-      if (ms) {
+      if (ms) { // 保存滚动位置, 用于 keep-alive
         this.__lastScrollY = getScrollTop()
-        ms.destroy()
-        hideLoading(this)
       }
+      this.__uninstallMpxScroll()
     },
     beforeDestroy () {
-      if (ms) {
-        ms.destroy()
-        hideLoading(this)
-      }
+      this.__uninstallMpxScroll()
     },
     methods: {
+      __uninstallMpxScroll () {
+        if (ms) {
+          ms.destroy()
+          hideLoading(this)
+          document.body.style.overflow = this.__originalOverflow // 恢复原有 overflow, 避免影响其他页面
+        }
+      },
       __mpxPullDownHandler (autoStop = false, isRefresh = false) {
         this.__pullingDown = true
         // 同微信保持一致

package/src/platform/builtInMixins/pageStatusMixin.web.js

@@ -1,4 +1,5 @@
 import {
+  BEFORECREATE,
   CREATED,
   ONHIDE,
   ONSHOW,
@@ -47,6 +48,18 @@ if (isBrowser) {
   window.addEventListener('resize', onResize)
 }
 
+function getParentPage (vm) {
+  let parent = vm.$parent
+  while (parent) {
+    if (parent.route) {
+      return parent
+    } else if (parent.$page) {
+      return parent.$page
+    }
+    parent = parent.$parent
+  }
+}
+
 export default function pageStatusMixin (mixinType) {
   const mixin = {}
 
@@ -63,33 +76,44 @@ export default function pageStatusMixin (mixinType) {
       },
       created () {
         // onLoad应该在用户声明周期CREATED后再执行，故此处使用原生created声明周期来触发onLoad
-        const query = (global.__mpxRouter && global.__mpxRouter.currentRoute && global.__mpxRouter.currentRoute.query) || {}
+        const query = this.$root.$options?.router?.currentRoute?.query || {}
         this.__mpxProxy.callHook(ONLOAD, [query])
       }
     })
   }
 
+  // 创建组件时记录当前所属page，用于驱动pageLifetimes和onShow/onHide钩子
+  if (mixinType === 'component') {
+    Object.assign(mixin, {
+      [BEFORECREATE] () {
+        this.$page = getParentPage(this)
+      }
+    })
+  }
+
   Object.assign(mixin, {
     [CREATED] () {
-      const pageInstance = mixinType === 'page' ? this : getCurrentPageInstance()
-      if (pageInstance) {
-        this.$watch(() => pageInstance.mpxPageStatus, status => {
-          if (!status) return
-          if (status === 'show') this.__mpxProxy.callHook(ONSHOW)
-          if (status === 'hide') this.__mpxProxy.callHook(ONHIDE)
-          const pageLifetimes = this.__mpxProxy.options.pageLifetimes
-          if (pageLifetimes) {
-            if (/^resize/.test(status) && isFunction(pageLifetimes.resize)) {
-              // resize
-              pageLifetimes.resize.call(this, systemInfo)
-            } else if (isFunction(pageLifetimes[status])) {
-              // show & hide
-              pageLifetimes[status].call(this)
+      if (isBrowser) {
+        const pageInstance = mixinType === 'page' ? this : this.$page
+        if (pageInstance) {
+          this.$watch(() => pageInstance.mpxPageStatus, status => {
+            if (!status) return
+            if (status === 'show') this.__mpxProxy.callHook(ONSHOW)
+            if (status === 'hide') this.__mpxProxy.callHook(ONHIDE)
+            const pageLifetimes = this.__mpxProxy.options.pageLifetimes
+            if (pageLifetimes) {
+              if (/^resize/.test(status) && isFunction(pageLifetimes.resize)) {
+                // resize
+                pageLifetimes.resize.call(this, systemInfo)
+              } else if (isFunction(pageLifetimes[status])) {
+                // show & hide
+                pageLifetimes[status].call(this)
+              }
             }
-          }
-        }, {
-          sync: true
-        })
+          }, {
+            sync: true
+          })
+        }
       }
     }
   })

package/src/platform/builtInMixins/proxyEventMixin.js

@@ -35,7 +35,7 @@ export default function proxyEventMixin () {
       let fallbackType = ''
       if (type === 'begin' || type === 'end') {
         // 地图的 regionchange 事件会派发 e.type 为 begin 和 end 的事件
-        fallbackType = 'regionchange'
+        fallbackType = __mpx_mode__ === 'ali' ? 'regionChange' : 'regionchange'
       } else if (/-([a-z])/.test(type)) {
         fallbackType = dash2hump(type)
       } else if (__mpx_mode__ === 'ali') {

package/src/platform/createApp.js

@@ -1,11 +1,12 @@
 import transferOptions from '../core/transferOptions'
 import mergeOptions from '../core/mergeOptions'
 import builtInKeysMap from './patch/builtInKeysMap'
-import { makeMap, spreadProp } from '@mpxjs/utils'
+import { makeMap, spreadProp, isBrowser } from '@mpxjs/utils'
+import { mergeLifecycle } from '../convertor/mergeLifecycle'
 import * as webLifecycle from '../platform/patch/web/lifecycle'
 import Mpx from '../index'
 
-const webAppHooksMap = makeMap(webLifecycle.LIFECYCLE.APP_HOOKS)
+const webAppHooksMap = makeMap(mergeLifecycle(webLifecycle.LIFECYCLE).app)
 
 function filterOptions (options, appData) {
   const newOptions = {}
@@ -35,7 +36,7 @@ export default function createApp (option, config = {}) {
       created () {
         Object.assign(this, Mpx.prototype)
         Object.assign(this, appData)
-        const current = (global.__mpxRouter && global.__mpxRouter.currentRoute) || {}
+        const current = this.$root.$options?.router?.currentRoute || {}
         const options = {
           path: current.path && current.path.replace(/^\//, ''),
           query: current.query,
@@ -49,19 +50,24 @@ export default function createApp (option, config = {}) {
           hide: [],
           error: []
         }
-        if (this.$options.onShow) {
-          this.$options.onShow.call(this, options)
-          global.__mpxAppCbs.show.push(this.$options.onShow.bind(this))
-        }
-        if (this.$options.onHide) {
-          global.__mpxAppCbs.hide.push(this.$options.onHide.bind(this))
-        }
-        if (this.$options.onError) {
-          global.__mpxAppCbs.error.push(this.$options.onError.bind(this))
+        if (isBrowser) {
+          if (this.$options.onShow) {
+            this.$options.onShow.call(this, options)
+            global.__mpxAppCbs.show.push(this.$options.onShow.bind(this))
+          }
+          if (this.$options.onHide) {
+            global.__mpxAppCbs.hide.push(this.$options.onHide.bind(this))
+          }
+          if (this.$options.onError) {
+            global.__mpxAppCbs.error.push(this.$options.onError.bind(this))
+          }
         }
       }
     })
   } else {
+    if (option.onAppInit) {
+      option.onAppInit()
+    }
     builtInMixins.push({
       onLaunch () {
         Object.assign(this, Mpx.prototype)
@@ -77,6 +83,9 @@ export default function createApp (option, config = {}) {
     global.__mpxOptionsMap = global.__mpxOptionsMap || {}
     global.__mpxOptionsMap[global.currentModuleId] = defaultOptions
     global.getApp = function () {
+      if (!isBrowser) {
+        console.error('[Mpx runtime error]: Dangerous API! global.getApp method is running in non browser environments')
+      }
       return appData
     }
   } else {

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

@@ -3,7 +3,7 @@ import mergeOptions from '../../../core/mergeOptions'
 import { diffAndCloneA, hasOwn } from '@mpxjs/utils'
 import { getCurrentInstance as getCurrentVueInstance } from '../../export/index'
 import MpxProxy, { setCurrentInstance, unsetCurrentInstance } from '../../../core/proxy'
-import { BEFORECREATE, BEFOREUPDATE, UPDATED, BEFOREUNMOUNT, UNMOUNTED } from '../../../core/innerLifecycle'
+import { BEFORECREATE, BEFOREUPDATE, UPDATED, BEFOREUNMOUNT, UNMOUNTED, SERVERPREFETCH } from '../../../core/innerLifecycle'
 
 function filterOptions (options) {
   const newOptions = {}
@@ -79,6 +79,9 @@ export function getDefaultOptions (type, { rawOptions = {} }) {
     },
     destroyed () {
       if (this.__mpxProxy) this.__mpxProxy.callHook(UNMOUNTED)
+    },
+    serverPrefetch () {
+      if (this.__mpxProxy) return this.__mpxProxy.callHook(SERVERPREFETCH)
     }
   }]
   // 为了在builtMixin中可以使用某些rootMixin实现的特性（如数据响应等），此处builtInMixin在rootMixin之后执行，但是当builtInMixin使用存在对应内建生命周期的目标平台声明周期写法时，可能会出现用户生命周期比builtInMixin中的生命周期先执行的情况，为了避免这种情况发生，builtInMixin应该尽可能使用内建生命周期来编写

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

@@ -9,7 +9,8 @@ const COMPONENT_HOOKS = [
   'deactivated',
   'beforeDestroy',
   'destroyed',
-  'errorCaptured'
+  'errorCaptured',
+  'serverPrefetch'
 ]
 
 const PAGE_HOOKS = [
@@ -38,7 +39,9 @@ const APP_HOOKS = [
   'onError',
   'onPageNotFound',
   'onUnhandledRejection',
-  'onThemeChange'
+  'onThemeChange',
+  'onSSRAppCreated',
+  'onAppInit'
 ]
 
 export const LIFECYCLE = {

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

@@ -14,7 +14,8 @@ const APP_HOOKS = [
   'onError',
   'onPageNotFound',
   'onUnhandledRejection',
-  'onThemeChange'
+  'onThemeChange',
+  'onAppInit'
 ]
 
 const PAGE_HOOKS = [