index.js 18.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
import Vue from 'vue';

const _toString = Object.prototype.toString;
const hasOwnProperty = Object.prototype.hasOwnProperty;

function isFn (fn) {
  return typeof fn === 'function'
}

function isStr (str) {
  return typeof str === 'string'
}

function isPlainObject (obj) {
  return _toString.call(obj) === '[object Object]'
}

function hasOwn (obj, key) {
  return hasOwnProperty.call(obj, key)
}

function noop () {}

fxy060608's avatar
fxy060608 已提交
24
const SYNC_API_RE = /requireNativePlugin|upx2px|hideKeyboard|canIUse|^create|Sync$|Manager$/;
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

const CONTEXT_API_RE = /^create|Manager$/;

const CALLBACK_API_RE = /^on/;

function isContextApi (name) {
  return CONTEXT_API_RE.test(name)
}
function isSyncApi (name) {
  return SYNC_API_RE.test(name)
}

function isCallbackApi (name) {
  return CALLBACK_API_RE.test(name)
}

function handlePromise (promise) {
  return promise.then(data => {
    return [null, data]
  })
    .catch(err => [err])
}

function shouldPromise (name) {
  if (isSyncApi(name)) {
    return false
  }
  if (isCallbackApi(name)) {
    return false
  }
  return true
}

function promisify (name, api) {
  if (!shouldPromise(name)) {
    return api
  }
  return function promiseApi (options = {}, ...params) {
    if (isFn(options.success) || isFn(options.fail) || isFn(options.complete)) {
      return api(options, ...params)
    }
    return handlePromise(new Promise((resolve, reject) => {
      api(Object.assign({}, options, {
        success: resolve,
        fail: reject
      }), ...params);
      /* eslint-disable no-extend-native */
      Promise.prototype.finally = function (callback) {
        const promise = this.constructor;
        return this.then(
          value => promise.resolve(callback()).then(() => value),
          reason => promise.resolve(callback()).then(() => {
            throw reason
          })
        )
      };
    }))
  }
}

const EPS = 1e-4;
const BASE_DEVICE_WIDTH = 750;
let isIOS = false;
let deviceWidth = 0;
let deviceDPR = 0;

function checkDeviceWidth () {
  const {
    platform,
    pixelRatio,
    windowWidth
  } = wx.getSystemInfoSync(); // uni=>wx runtime 编译目标是 uni 对象,内部不允许直接使用 uni

  deviceWidth = windowWidth;
  deviceDPR = pixelRatio;
  isIOS = platform === 'ios';
}

function upx2px (number, newDeviceWidth) {
  if (deviceWidth === 0) {
    checkDeviceWidth();
  }

  number = Number(number);
  if (number === 0) {
    return 0
  }
  let result = (number / BASE_DEVICE_WIDTH) * (newDeviceWidth || deviceWidth);
  if (result < 0) {
    result = -result;
  }
  result = Math.floor(result + EPS);
  if (result === 0) {
    if (deviceDPR === 1 || !isIOS) {
      return 1
    } else {
      return 0.5
    }
  }
  return number < 0 ? -result : result
}

var protocols = {};

const CALLBACKS = ['success', 'fail', 'cancel', 'complete'];

function processCallback (methodName, method, returnValue) {
  return function (res) {
    return method(processReturnValue(methodName, res, returnValue))
  }
}

function processArgs (methodName, fromArgs, argsOption = {}, returnValue = {}, keepFromArgs = false) {
  if (isPlainObject(fromArgs)) { // 一般 api 的参数解析
    const toArgs = keepFromArgs === true ? fromArgs : {}; // returnValue 为 false 时,说明是格式化返回值,直接在返回值对象上修改赋值
    if (isFn(argsOption)) {
      argsOption = argsOption(fromArgs, toArgs) || {};
    }
    for (let key in fromArgs) {
      if (hasOwn(argsOption, key)) {
        let keyOption = argsOption[key];
        if (isFn(keyOption)) {
          keyOption = keyOption(fromArgs[key], fromArgs, toArgs);
        }
        if (!keyOption) { // 不支持的参数
          console.warn(`app-plus ${methodName}暂不支持${key}`);
        } else if (isStr(keyOption)) { // 重写参数 key
          toArgs[keyOption] = fromArgs[key];
        } else if (isPlainObject(keyOption)) { // {name:newName,value:value}可重新指定参数 key:value
          toArgs[keyOption.name ? keyOption.name : key] = keyOption.value;
        }
      } else if (CALLBACKS.includes(key)) {
        toArgs[key] = processCallback(methodName, fromArgs[key], returnValue);
      } else {
        if (!keepFromArgs) {
          toArgs[key] = fromArgs[key];
        }
      }
    }
    return toArgs
  } else if (isFn(fromArgs)) {
    fromArgs = processCallback(methodName, fromArgs, returnValue);
  }
  return fromArgs
}

function processReturnValue (methodName, res, returnValue, keepReturnValue = false) {
  if (isFn(protocols.returnValue)) { // 处理通用 returnValue
    res = protocols.returnValue(methodName, res);
  }
  return processArgs(methodName, res, returnValue, {}, keepReturnValue)
}

function wrapper (methodName, method) {
  if (hasOwn(protocols, methodName)) {
    const protocol = protocols[methodName];
    if (!protocol) { // 暂不支持的 api
      return function () {
        console.error(`app-plus 暂不支持${methodName}`);
      }
    }
    return function (arg1, arg2) { // 目前 api 最多两个参数
      let options = protocol;
      if (isFn(protocol)) {
        options = protocol(arg1);
      }

      arg1 = processArgs(methodName, arg1, options.args, options.returnValue);

      const returnValue = wx[options.name || methodName](arg1, arg2);
      if (isSyncApi(methodName)) { // 同步 api
        return processReturnValue(methodName, returnValue, options.returnValue, isContextApi(methodName))
      }
      return returnValue
    }
  }
  return method
}

const todoApis = Object.create(null);

const TODOS = [
  'subscribePush',
  'unsubscribePush',
  'onPush',
  'offPush',
  'share'
];

function createTodoApi (name) {
  return function todoApi ({
    fail,
    complete
  }) {
    const res = {
      errMsg: `${name}:fail:暂不支持 ${name} 方法`
    };
    isFn(fail) && fail(res);
    isFn(complete) && complete(res);
  }
}

TODOS.forEach(function (name) {
  todoApis[name] = createTodoApi(name);
});

231 232 233 234 235
function requireNativePlugin (pluginName) {
  /* eslint-disable no-undef */
  if (typeof weex !== 'undefined') {
    return weex.requireModule(pluginName)
  }
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
  /* eslint-disable no-undef */
  return __requireNativePlugin__(pluginName)
}

var api = /*#__PURE__*/Object.freeze({
  requireNativePlugin: requireNativePlugin
});

const MOCKS = ['__route__', '__wxExparserNodeId__', '__wxWebviewId__'];

function initMocks (vm) {
  const mpInstance = vm.$mp[vm.mpType];
  MOCKS.forEach(mock => {
    if (hasOwn(mpInstance, mock)) {
      vm[mock] = mpInstance[mock];
    }
  });
}

255
function initHooks (mpOptions, hooks) {
256 257
  hooks.forEach(hook => {
    mpOptions[hook] = function (args) {
258
      return this.$vm.__call_hook(hook, args)
259 260 261 262
    };
  });
}

fxy060608's avatar
fxy060608 已提交
263
function getData (vueOptions, context) {
264 265 266
  let data = vueOptions.data || {};
  const methods = vueOptions.methods || {};

267 268
  if (typeof data === 'function') {
    try {
fxy060608's avatar
fxy060608 已提交
269
      data = data.call(context); // 支持 Vue.prototype 上挂的数据
270
    } catch (e) {
271 272 273
      if (process.env.VUE_APP_DEBUG) {
        console.warn('根据 Vue 的 data 函数初始化小程序 data 失败,请尽量确保 data 函数中不访问 vm 对象,否则可能影响首次数据渲染速度。', data);
      }
274
    }
fxy060608's avatar
fxy060608 已提交
275 276 277 278 279
  } else {
    try {
      // 对 data 格式化
      data = JSON.parse(JSON.stringify(data));
    } catch (e) {}
280
  }
281

fxy060608's avatar
fxy060608 已提交
282 283 284 285 286 287 288
  Object.keys(methods).forEach(methodName => {
    if (!hasOwn(data, methodName)) {
      data[methodName] = methods[methodName];
    }
  });

  return data
289 290 291 292
}

const PROP_TYPES = [String, Number, Boolean, Object, Array, null];

293 294 295 296 297 298 299 300
function createObserver (name) {
  return function observer (newVal, oldVal) {
    if (this.$vm) {
      this.$vm[name] = newVal; // 为了触发其他非 render watcher
    }
  }
}

301
function getProperties (props) {
fxy060608's avatar
fxy060608 已提交
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
  const properties = {
    vueSlots: { // 小程序不能直接定义 $slots 的 props,所以通过 vueSlots 转换到 $slots
      type: null,
      value: [],
      observer: function (newVal, oldVal) {
        const $slots = Object.create(null);
        newVal.forEach(slotName => {
          $slots[slotName] = true;
        });
        this.setData({
          $slots
        });
      }
    }
  };
317 318
  if (Array.isArray(props)) { // ['title']
    props.forEach(key => {
319 320 321 322
      properties[key] = {
        type: null,
        observer: createObserver(key)
      };
323 324 325 326 327 328 329 330 331 332 333
    });
  } else if (isPlainObject(props)) { // {title:{type:String,default:''},content:String}
    Object.keys(props).forEach(key => {
      const opts = props[key];
      if (isPlainObject(opts)) { // title:{type:String,default:''}
        let value = opts['default'];
        if (isFn(value)) {
          value = value();
        }
        properties[key] = {
          type: PROP_TYPES.includes(opts.type) ? opts.type : null,
334 335
          value,
          observer: createObserver(key)
336 337
        };
      } else { // content:String
338 339 340 341
        properties[key] = {
          type: PROP_TYPES.includes(opts) ? opts : null,
          observer: createObserver(key)
        };
342 343 344 345 346 347 348 349 350 351 352 353
      }
    });
  }
  return properties
}

function wrapper$1 (event) {
  event.stopPropagation = noop;
  event.preventDefault = noop;

  event.target = event.target || {};
  event.detail = event.detail || {};
354

355 356 357 358 359 360
  // TODO 又得兼容 mpvue 的 mp 对象
  event.mp = event;
  event.target = Object.assign({}, event.target, event.detail);
  return event
}

361
function processEventArgs (event, args = [], isCustom, methodName) {
362
  if (isCustom && !args.length) { // 无参数,直接传入 detail 数组
363 364 365
    if (!Array.isArray(event.detail)) { // 应该是使用了 wxcomponent 原生组件,为了向前兼容,传递原始 event 对象
      return [event]
    }
366 367 368 369 370
    return event.detail
  }
  const ret = [];
  args.forEach(arg => {
    if (arg === '$event') {
371 372 373 374 375
      if (methodName === '__set_model' && !isCustom) { // input v-model value
        ret.push(event.target.value);
      } else {
        ret.push(isCustom ? event.detail[0] : event);
      }
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
    } else {
      ret.push(arg);
    }
  });

  return ret
}

const ONCE = '~';
const CUSTOM = '^';

function handleEvent (event) {
  event = wrapper$1(event);

  // [['tap',[['handle',[1,2,a]],['handle1',[1,2,a]]]]]
  const eventOpts = (event.currentTarget || event.target).dataset.eventOpts;
  if (!eventOpts) {
    return console.warn(`事件信息不存在`)
  }

  // [['handle',[1,2,a]],['handle1',[1,2,a]]]
  const eventType = event.type;
  eventOpts.forEach(eventOpt => {
    let type = eventOpt[0];
    const eventsArray = eventOpt[1];

    const isCustom = type.charAt(0) === CUSTOM;
    type = isCustom ? type.slice(1) : type;
    const isOnce = type.charAt(0) === ONCE;
    type = isOnce ? type.slice(1) : type;

    if (eventsArray && eventType === type) {
      eventsArray.forEach(eventArray => {
409 410
        const methodName = eventArray[0];
        const handler = this.$vm[methodName];
411
        if (!isFn(handler)) {
412
          throw new Error(` _vm.${methodName} is not a function`)
413
        }
414 415 416 417 418 419
        if (isOnce) {
          if (handler.once) {
            return
          }
          handler.once = true;
        }
420
        handler.apply(this.$vm, processEventArgs(event, eventArray[1], isCustom, methodName));
421 422 423 424 425 426 427 428 429 430
      });
    }
  });
}

function initRefs (vm) {
  const mpInstance = vm.$mp[vm.mpType];
  Object.defineProperty(vm, '$refs', {
    get () {
      const $refs = Object.create(null);
431
      const components = mpInstance.selectAllComponents('.vue-ref');
432
      components.forEach(component => {
fxy060608's avatar
fxy060608 已提交
433 434
        const ref = component.dataset.ref;
        $refs[ref] = component.$vm;
435
      });
436
      const forComponents = mpInstance.selectAllComponents('.vue-ref-in-for');
437
      forComponents.forEach(component => {
fxy060608's avatar
fxy060608 已提交
438 439 440
        const ref = component.dataset.ref;
        if (!$refs[ref]) {
          $refs[ref] = [];
441
        }
fxy060608's avatar
fxy060608 已提交
442
        $refs[ref].push(component.$vm);
443 444 445 446 447 448 449 450 451 452 453 454 455
      });
      return $refs
    }
  });
}

const hooks = [
  'onShow',
  'onHide',
  'onError',
  'onPageNotFound'
];

456
function createApp (vm) {
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
  // 外部初始化时 Vue 还未初始化,放到 createApp 内部初始化 mixin
  Vue.mixin({
    beforeCreate () {
      if (!this.$options.mpType) {
        return
      }
      this.mpType = this.$options.mpType;
      this.$mp = {
        data: {},
        [this.mpType]: this.$options.mpInstance
      };
      delete this.$options.mpType;
      delete this.$options.mpInstance;

      if (this.mpType !== 'app') {
        initRefs(this);
        initMocks(this);
      }
fxy060608's avatar
fxy060608 已提交
475 476 477 478
    },
    created () { // 处理 injections
      this.__init_injections(this);
      this.__init_provide(this);
479 480
    }
  });
481 482 483

  const appOptions = {
    onLaunch (args) {
484
      this.$vm = vm;
485

486 487 488 489
      this.$vm._isMounted = true;
      this.$vm.__call_hook('mounted');

      this.$vm.__call_hook('onLaunch', args);
490 491 492
    }
  };

493
  initHooks(appOptions, hooks); // 延迟执行,因为 App 的注册在 main.js 之前,可能导致生命周期内 Vue 原型上开发者注册的属性无法访问
494 495 496

  App(appOptions);

497
  return vm
498 499
}

fxy060608's avatar
fxy060608 已提交
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
function triggerLink (mpInstance, vueOptions) {
  mpInstance.triggerEvent('__l', mpInstance.$vm || vueOptions, {
    bubbles: true,
    composed: true
  });
}

function handleLink (event) {
  if (event.detail.$mp) { // vm
    if (!event.detail.$parent) {
      event.detail.$parent = this.$vm;
      event.detail.$parent.$children.push(event.detail);

      event.detail.$root = this.$vm.$root;
    }
  } else { // vueOptions
    if (!event.detail.parent) {
      event.detail.parent = this.$vm;
    }
  }
}

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
const hooks$1 = [
  'onShow',
  'onHide',
  'onPullDownRefresh',
  'onReachBottom',
  'onShareAppMessage',
  'onPageScroll',
  'onResize',
  'onTabItemTap',
  'onBackPress',
  'onNavigationBarButtonTap',
  'onNavigationBarSearchInputChanged',
  'onNavigationBarSearchInputConfirmed',
  'onNavigationBarSearchInputClicked'
];

function createPage (vueOptions) {
  vueOptions = vueOptions.default || vueOptions;
540 541 542 543 544 545 546
  let VueComponent;
  if (isFn(vueOptions)) {
    VueComponent = vueOptions;
    vueOptions = VueComponent.extendOptions;
  } else {
    VueComponent = Vue.extend(vueOptions);
  }
547
  const pageOptions = {
548 549 550 551
    options: {
      multipleSlots: true,
      addGlobalClass: true
    },
fxy060608's avatar
fxy060608 已提交
552
    data: getData(vueOptions, Vue.prototype),
553 554
    lifetimes: { // 当页面作为组件时
      attached () {
555

556 557 558 559
        this.$vm = new VueComponent({
          mpType: 'page',
          mpInstance: this
        });
560

561 562 563 564 565 566 567 568 569 570
        this.$vm.__call_hook('created');
        this.$vm.$mount();
      },
      ready () {
        this.$vm.__call_hook('beforeMount');
        this.$vm._isMounted = true;
        this.$vm.__call_hook('mounted');
        this.$vm.__call_hook('onReady');
      },
      detached () {
571 572
        this.$vm.$destroy();
      }
573
    },
574 575 576 577 578 579 580 581 582 583 584
    methods: { // 作为页面时
      onLoad (args) {
        this.$vm.$mp.query = args; // 又要兼容 mpvue
        this.$vm.__call_hook('onLoad', args); // 开发者可能会在 onLoad 时赋值,提前到 mount 之前
      },
      onUnload () {
        this.$vm.__call_hook('onUnload');
      },
      __e: handleEvent,
      __l: handleLink
    }
585 586
  };

587 588 589 590 591 592 593
  initHooks(pageOptions.methods, hooks$1);

  {
    pageOptions.methods.$getAppWebview = function () {
      return plus.webview.getWebviewById(`${this.__wxWebviewId__}`)
    };
  }
594

595
  return Component(pageOptions)
596 597
}

fxy060608's avatar
fxy060608 已提交
598
function initVueComponent (mpInstace, VueComponent, extraOptions = {}) {
599 600 601 602
  if (mpInstace.$vm) {
    return
  }

fxy060608's avatar
fxy060608 已提交
603
  const options = Object.assign({
604 605 606
    mpType: 'component',
    mpInstance: mpInstace,
    propsData: mpInstace.properties
fxy060608's avatar
fxy060608 已提交
607
  }, extraOptions);
608 609 610
  // 初始化 vue 实例
  mpInstace.$vm = new VueComponent(options);

fxy060608's avatar
fxy060608 已提交
611 612 613 614 615 616 617 618 619
  // 处理$slots,$scopedSlots(暂不支持动态变化$slots)
  const vueSlots = mpInstace.properties.vueSlots;
  if (Array.isArray(vueSlots) && vueSlots.length) {
    const $slots = Object.create(null);
    vueSlots.forEach(slotName => {
      $slots[slotName] = true;
    });
    mpInstace.$vm.$scopedSlots = mpInstace.$vm.$slots = $slots;
  }
fxy060608's avatar
fxy060608 已提交
620 621 622
  // 性能优先,mount 提前到 attached 中,保证组件首次渲染数据被合并
  // 导致与标准 Vue 的差异,data 和 computed 中不能使用$parent,provide等组件属性
  mpInstace.$vm.$mount();
623 624
}

625 626 627 628 629 630 631 632 633 634 635 636
function createComponent (vueOptions) {
  vueOptions = vueOptions.default || vueOptions;

  const properties = getProperties(vueOptions.props);

  const VueComponent = Vue.extend(vueOptions);

  const componentOptions = {
    options: {
      multipleSlots: true,
      addGlobalClass: true
    },
fxy060608's avatar
fxy060608 已提交
637
    data: getData(vueOptions, Vue.prototype),
638
    properties,
639 640 641 642 643 644
    lifetimes: {
      attached () {
        initVueComponent(this, VueComponent);
      },
      ready () {
        initVueComponent(this, VueComponent); // 目前发现部分情况小程序 attached 不触发
fxy060608's avatar
fxy060608 已提交
645
        triggerLink(this); // 处理 parent,children
646

fxy060608's avatar
fxy060608 已提交
647
        // 补充生命周期
fxy060608's avatar
fxy060608 已提交
648
        this.$vm.__call_hook('created');
fxy060608's avatar
fxy060608 已提交
649
        this.$vm.__call_hook('beforeMount');
650 651 652 653 654 655 656
        this.$vm._isMounted = true;
        this.$vm.__call_hook('mounted');
        this.$vm.__call_hook('onReady');
      },
      detached () {
        this.$vm.$destroy();
      }
657 658 659 660 661 662
    },
    pageLifetimes: {
      show (args) {
        this.$vm.__call_hook('onPageShow', args);
      },
      hide () {
fxy060608's avatar
fxy060608 已提交
663
        this.$vm && this.$vm.__call_hook('onPageHide');
664 665
      },
      resize (size) {
fxy060608's avatar
fxy060608 已提交
666
        this.$vm && this.$vm.__call_hook('onPageResize', size);
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
      }
    },
    methods: {
      __e: handleEvent,
      __l: handleLink
    }
  };

  return Component(componentOptions)
}

let uni = {};

if (typeof Proxy !== 'undefined') {
  uni = new Proxy({}, {
    get (target, name) {
      if (name === 'upx2px') {
        return upx2px
      }
      if (api[name]) {
        return promisify(name, api[name])
fxy060608's avatar
fxy060608 已提交
688
      }
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
      if (!hasOwn(wx, name) && !hasOwn(protocols, name)) {
        return
      }
      return promisify(name, wrapper(name, wx[name]))
    }
  });
} else {
  uni.upx2px = upx2px;

  Object.keys(api).forEach(name => {
    uni[name] = promisify(name, api[name]);
  });

  Object.keys(wx).forEach(name => {
    if (hasOwn(wx, name) || hasOwn(protocols, name)) {
      uni[name] = promisify(name, wrapper(name, wx[name]));
    }
  });
}

var uni$1 = uni;

export default uni$1;
export { createApp, createPage, createComponent };