@mpxjs/api-proxy 2.8.40 → 2.9.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpxjs/api-proxy",
-  "version": "2.8.40",
+  "version": "2.9.0-beta.1",
   "description": "convert miniprogram API at each end",
   "module": "src/index.js",
   "types": "@types/index.d.ts",
@@ -31,7 +31,7 @@
     "promise"
   ],
   "author": "httpsxiao",
-  "license": "ISC",
+  "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/didi/mpx/issues"
   },
@@ -39,5 +39,5 @@
   "dependencies": {
     "axios": "^0.21.1"
   },
-  "gitHead": "46a9b88c11f1ca2f0cfbc414e668b2f618ee6806"
+  "gitHead": "5e4b44c9b8132e9192cfd119f63196ecc6c4486c"
 }

package/src/common/js/utils.js

@@ -100,6 +100,9 @@ function makeMap (arr) {
 
 const isBrowser = typeof window !== 'undefined'
 
+function throwSSRWarning (info) {
+  console.error(`[Mpx runtime error]: Dangerous API! ${info}, It may cause some problems, please use this method with caution`)
+}
 export {
   changeOpts,
   handleSuccess,
@@ -110,5 +113,6 @@ export {
   noop,
   makeMap,
   isBrowser,
-  hasOwn
+  hasOwn,
+  throwSSRWarning
 }

package/src/index.web.js

@@ -1,12 +1,9 @@
 import * as allApi from './web/api'
-import { EventChannel } from './web/api/event-channel'
 import { genFromMap } from './common/js'
 
 export default function install (target) {
   const fromMap = genFromMap()
 
-  global.EventChannel = new EventChannel()
-
   Object.keys(allApi).forEach(api => {
     target[api] = function (...args) {
       if (args.length > 0) {

package/src/web/api/action-sheet/index.js

@@ -1,8 +1,13 @@
 import ActionSheet from './ActionSheet'
+import { isBrowser, throwSSRWarning } from '../../../common/js'
 
 let actionSheet = null
 
 function showActionSheet (options = { itemList: [] }) {
+  if (!isBrowser) {
+    throwSSRWarning('showActionSheet API is running in non browser environments')
+    return
+  }
   if (!actionSheet) { actionSheet = new ActionSheet() }
   return actionSheet.show(options)
 }

package/src/web/api/animation/animation.js

@@ -1,3 +1,5 @@
+import { isBrowser, throwSSRWarning } from '../../../common/js'
+
 class Animation {
   constructor (options) {
     this._actions = []
@@ -5,11 +7,15 @@ class Animation {
     this._options = options
   }
 
-  _processSize (size) {
+  _processSize (size, type) {
     if (typeof size === 'number') {
       return `${size}px`
     } else {
       if (size.indexOf('rpx') !== -1) {
+        if (!isBrowser) {
+          throwSSRWarning(`Animation's ${type} API cannot use rpx in non browser environments`)
+          return
+        }
         // 计算rpx折算回px
         const rs = parseInt(size, 10)
         const width = window.screen.width
@@ -29,7 +35,7 @@ class Animation {
       case 'bottom':
       case 'width':
       case 'height':
-        value = this._processSize(value)
+        value = this._processSize(value, type)
         this._propMaps[type] = {
           args: [type, value],
           type: 'style'

package/src/web/api/app/index.js

@@ -1,3 +1,4 @@
+import { isBrowser } from '../../../common/js'
 global.__mpxAppCbs = global.__mpxAppCbs || {
   show: [],
   hide: [],
@@ -6,7 +7,9 @@ global.__mpxAppCbs = global.__mpxAppCbs || {
 }
 
 function onError (callback) {
-  global.__mpxAppCbs.error.push(callback)
+  if (isBrowser) {
+    global.__mpxAppCbs.error.push(callback)
+  }
 }
 
 function offError (callback) {
@@ -16,7 +19,9 @@ function offError (callback) {
 }
 
 function onAppShow (callback) {
-  global.__mpxAppCbs.show.push(callback)
+  if (isBrowser) {
+    global.__mpxAppCbs.show.push(callback)
+  }
 }
 
 function offAppShow (callback) {
@@ -26,7 +31,9 @@ function offAppShow (callback) {
 }
 
 function onAppHide (callback) {
-  global.__mpxAppCbs.hide.push(callback)
+  if (isBrowser) {
+    global.__mpxAppCbs.hide.push(callback)
+  }
 }
 
 function offAppHide (callback) {

package/src/web/api/audio/index.js

@@ -1,4 +1,9 @@
+import { isBrowser, throwSSRWarning } from '../../../common/js'
 export const createInnerAudioContext = () => {
+  if (!isBrowser) {
+    throwSSRWarning('createInnerAudioContext API is running in non browser environments')
+    return
+  }
   // eslint-disable-next-line no-undef
   const audio = new Audio()
   const __audio = {}

package/src/web/api/create-intersection-observer/index.js

@@ -1,6 +1,11 @@
 import WebIntersectionObserver from './IntersectionObserver'
+import { isBrowser, throwSSRWarning } from '../../../common/js'
 
 function createIntersectionObserver (component, options) {
+  if (!isBrowser) {
+    throwSSRWarning('createIntersectionObserver API is running in non browser environments')
+    return
+  }
   return new WebIntersectionObserver(component, options)
 }
 

package/src/web/api/create-selector-query/index.js

@@ -1,6 +1,11 @@
 import SelectQuery from './SelectQuery'
+import { isBrowser, throwSSRWarning } from '../../../common/js'
 
 function createSelectorQuery () {
+  if (!isBrowser) {
+    throwSSRWarning('createSelectorQuery API is running in non browser environments')
+    return
+  }
   return new SelectQuery()
 }
 

package/src/web/api/device/network/getNetworkType.js

@@ -1,11 +1,15 @@
-import { webHandleSuccess, webHandleFail } from '../../../../common/js'
+import { webHandleSuccess, webHandleFail, isBrowser, throwSSRWarning } from '../../../../common/js'
 
 export function getNetworkType ({ success, fail = () => {}, complete = () => {} }) {
+  if (!isBrowser) {
+    throwSSRWarning('getNetworkType API is running in non browser environments')
+    return
+  }
   try {
     if (navigator.connection) {
       webHandleSuccess({ networkType: navigator.connection.effectiveType }, success, complete)
     } else {
-      webHandleSuccess({ networkType: 'unknow' }, success, complete)
+      webHandleSuccess({ networkType: 'unknown' }, success, complete)
     }
   } catch (err) {
     webHandleFail(err, fail, complete)

package/src/web/api/device/network/onNetworkStatusChange.js

@@ -1,4 +1,4 @@
-import { isBrowser } from '../../../../common/js/utils'
+import { isBrowser, throwSSRWarning } from '../../../../common/js/utils'
 const fnMap = new Map()
 
 const oldObserveList = new Set()
@@ -13,6 +13,10 @@ if (isBrowser) {
 }
 
 export function onNetworkStatusChange (callbackFn) {
+  if (!isBrowser) {
+    throwSSRWarning('onNetworkStatusChange API is running in non browser environments')
+    return
+  }
   if (navigator.connection) {
     const proxyCallback = evt => {
       const isConnected = navigator.onLine
@@ -29,6 +33,10 @@ export function onNetworkStatusChange (callbackFn) {
 }
 
 export function offNetworkStatusChange (callbackFn) {
+  if (!isBrowser) {
+    throwSSRWarning('offNetworkStatusChange API is running in non browser environments')
+    return
+  }
   if (navigator.connection) {
     navigator.connection.removeEventListener('change', fnMap.get(callbackFn))
   } else {

package/src/web/api/modal/index.js

@@ -1,8 +1,13 @@
 import Modal from './Modal'
+import { isBrowser, throwSSRWarning } from '../../../common/js'
 
 let modal = null
 
 function showModal (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('showModal API is running in non browser environments')
+    return
+  }
   if (!modal) { modal = new Modal() }
   return modal.show(options)
 }

package/src/web/api/page-scroll-to/index.js

@@ -1,7 +1,11 @@
-import { webHandleSuccess, webHandleFail } from '../../../common/js'
+import { webHandleSuccess, webHandleFail, isBrowser, throwSSRWarning } from '../../../common/js'
 import { nextTick } from '../next-tick'
 
 export function pageScrollTo (options) {
+  if (!isBrowser) {
+    throwSSRWarning('pageScrollTo API is running in non browser environments')
+    return
+  }
   nextTick(() => {
     const ms = global.__ms
     const { success, fail, complete } = options

package/src/web/api/pull-down/index.js

@@ -1,6 +1,10 @@
-import { webHandleSuccess, webHandleFail } from '../../../common/js'
+import { webHandleSuccess, webHandleFail, throwSSRWarning, isBrowser } from '../../../common/js'
 
 function stopPullDownRefresh (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('stopPullDownRefresh API is running in non browser environments')
+    return
+  }
   const router = global.__mpxRouter
   if (router) {
     let err
@@ -31,6 +35,10 @@ function stopPullDownRefresh (options = {}) {
 }
 
 function startPullDownRefresh (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('startPullDownRefresh API is running in non browser environments')
+    return
+  }
   const router = global.__mpxRouter
   if (router) {
     let err

package/src/web/api/route/index.js

@@ -1,7 +1,10 @@
-import { webHandleSuccess, webHandleFail, isTabBarPage } from '../../../common/js'
+import { webHandleSuccess, webHandleFail, isTabBarPage, throwSSRWarning, isBrowser } from '../../../common/js'
 import { EventChannel } from '../event-channel'
-
 function redirectTo (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('redirectTo API is running in non browser environments')
+    return
+  }
   const router = global.__mpxRouter
   if (router) {
     if (isTabBarPage(options.url, router)) {
@@ -31,6 +34,10 @@ function redirectTo (options = {}) {
 }
 
 function navigateTo (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('navigateTo API is running in non browser environments')
+    return
+  }
   const router = global.__mpxRouter
   if (router) {
     if (isTabBarPage(options.url, router)) {
@@ -67,6 +74,10 @@ function navigateTo (options = {}) {
 }
 
 function navigateBack (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('navigateBack API is running in non browser environments')
+    return
+  }
   const router = global.__mpxRouter
   if (router) {
     const delta = options.delta || 1
@@ -84,6 +95,10 @@ function navigateBack (options = {}) {
 let reLaunchCount = 0
 
 function reLaunch (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('reLaunch API is running in non browser environments')
+    return
+  }
   const router = global.__mpxRouter
   if (router) {
     if (reLaunchCount === 0 && router.currentRoute.query.reLaunchCount) reLaunchCount = router.currentRoute.query.reLaunchCount
@@ -127,6 +142,10 @@ function reLaunch (options = {}) {
 }
 
 function switchTab (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('switchTab API is running in non browser environments')
+    return
+  }
   const router = global.__mpxRouter
   if (router) {
     const toRoute = router.match(options.url, router.history.current)

package/src/web/api/set-navigation-bar/index.js

@@ -1,6 +1,10 @@
-import { webHandleSuccess } from '../../../common/js'
+import { isBrowser, throwSSRWarning, webHandleSuccess } from '../../../common/js'
 
 function setNavigationBarTitle (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('setNavigationBarTitle API is running in non browser environments')
+    return
+  }
   const { title, success, complete } = options
 
   if (document.title !== title) {
@@ -11,6 +15,10 @@ function setNavigationBarTitle (options = {}) {
 }
 
 function setNavigationBarColor (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('setNavigationBarColor API is running in non browser environments')
+    return
+  }
   const { backgroundColor, success, complete } = options
   const meta = document.createElement('meta')
   meta.setAttribute('name', 'theme-color')

package/src/web/api/socket/index.js

@@ -1,7 +1,11 @@
-import { warn, webHandleSuccess, webHandleFail } from '../../../common/js'
+import { warn, webHandleSuccess, webHandleFail, isBrowser, throwSSRWarning } from '../../../common/js'
 import SocketTask from './SocketTask'
 
 function connectSocket (options = { url: '' }) {
+  if (!isBrowser) {
+    throwSSRWarning('connectSocket API is running in non browser environments')
+    return
+  }
   const { url, protocols, success, fail, complete } = options
 
   try {

package/src/web/api/storage/index.js

@@ -1,6 +1,10 @@
-import { webHandleSuccess, webHandleFail, hasOwn } from '../../../common/js'
+import { webHandleSuccess, webHandleFail, hasOwn, isBrowser, throwSSRWarning } from '../../../common/js'
 
 function setStorage (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('setStorage API is running in non browser environments')
+    return
+  }
   const { key, data, success, fail, complete } = options
 
   try {
@@ -17,6 +21,10 @@ function setStorage (options = {}) {
 }
 
 function setStorageSync (key = '', data) {
+  if (!isBrowser) {
+    throwSSRWarning('setStorageSync API is running in non browser environments')
+    return
+  }
   let obj = {}
 
   if (typeof data === 'symbol') {
@@ -28,6 +36,10 @@ function setStorageSync (key = '', data) {
 }
 
 function getStorage (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('getStorage API is running in non browser environments')
+    return
+  }
   const { key, success, fail, complete } = options
   const { result, data } = getItem(key)
 
@@ -43,6 +55,10 @@ function getStorage (options = {}) {
 }
 
 function getStorageSync (key) {
+  if (!isBrowser) {
+    throwSSRWarning('getStorageSync API is running in non browser environments')
+    return
+  }
   const res = getItem(key)
   if (res.result) return res.data
 
@@ -64,6 +80,10 @@ function getItem (key) {
 }
 
 function getStorageInfo (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('getStorageInfo API is running in non browser environments')
+    return
+  }
   const { success, fail, complete } = options
 
   try {
@@ -80,6 +100,10 @@ function getStorageInfo (options = {}) {
 }
 
 function getStorageInfoSync () {
+  if (!isBrowser) {
+    throwSSRWarning('getStorageInfoSync API is running in non browser environments')
+    return
+  }
   return {
     keys: Object.keys(window.localStorage),
     limitSize: null,
@@ -88,6 +112,10 @@ function getStorageInfoSync () {
 }
 
 function removeStorage (options = { key: '' }) {
+  if (!isBrowser) {
+    throwSSRWarning('removeStorage API is running in non browser environments')
+    return
+  }
   const { key, success, fail, complete } = options
 
   try {
@@ -104,10 +132,18 @@ function removeStorage (options = { key: '' }) {
 }
 
 function removeStorageSync (key) {
+  if (!isBrowser) {
+    throwSSRWarning('getStorageInfoSync API is running in non browser environments')
+    return
+  }
   window.localStorage.removeItem(key)
 }
 
 function clearStorage (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('clearStorage API is running in non browser environments')
+    return
+  }
   const { success, fail, complete } = options
 
   try {
@@ -124,6 +160,10 @@ function clearStorage (options = {}) {
 }
 
 function clearStorageSync () {
+  if (!isBrowser) {
+    throwSSRWarning('clearStorageSync API is running in non browser environments')
+    return
+  }
   window.localStorage.clear()
 }
 

package/src/web/api/system/index.js

@@ -1,6 +1,10 @@
-import { webHandleSuccess } from '../../../common/js'
+import { isBrowser, throwSSRWarning, webHandleSuccess } from '../../../common/js'
 
 function getSystemInfoSync () {
+  if (!isBrowser) {
+    throwSSRWarning('getSystemInfoSync API is running in non browser environments')
+    return
+  }
   const ua = navigator.userAgent.split('(')[1].split(')')[0]
   const phones = new Map([
     ['iPhone', /iPhone|iPad|iPod|iOS/i],
@@ -66,6 +70,10 @@ function getSystemInfoSync () {
 }
 
 function getSystemInfo (options = {}) {
+  if (!isBrowser) {
+    throwSSRWarning('getSystemInfo API is running in non browser environments')
+    return
+  }
   const info = getSystemInfoSync()
   const res = Object.assign({ errMsg: 'getSystemInfo:ok' }, info)
   webHandleSuccess(res, options.success, options.complete)

package/src/web/api/toast/index.js

@@ -1,8 +1,13 @@
 import Toast from './Toast'
+import { isBrowser, throwSSRWarning } from '../../../common/js'
 
 let toast = null
 
 function showToast (options = { title: '' }) {
+  if (!isBrowser) {
+    throwSSRWarning('showToast API is running in non browser environments')
+    return
+  }
   if (!toast) { toast = new Toast() }
   return toast.show(options, 'toast')
 }
@@ -13,6 +18,10 @@ function hideToast (options = {}) {
 }
 
 function showLoading (options = { title: '' }) {
+  if (!isBrowser) {
+    throwSSRWarning('showLoading API is running in non browser environments')
+    return
+  }
   if (!toast) { toast = new Toast() }
   return toast.show(Object.assign({
     icon: 'loading',

package/src/web/api/video/index.js

@@ -1,5 +1,11 @@
+import { isBrowser, throwSSRWarning } from '../../../common/js'
+
 const allowPlaybackRate = [0.5, 0.8, 1.0, 1.25, 1.5, 2.0]
 export const createVideoContext = (id, context) => {
+  if (!isBrowser) {
+    throwSSRWarning('createVideoContext API is running in non browser environments')
+    return
+  }
   if (!id) {
     throw new Error('id为必传参数')
   }