@hylid/call 3.2.0-alpha.0 → 3.2.0-alpha.10

package/lib/mpCall.d.ts

@@ -1,4 +1,3 @@
 import { MPApi, PickMPArgs, Callback, PickMpReturns } from '@hylid/types';
-export declare function mpCall<T extends keyof MPApi>(apiName: T | ({} & string), options?: PickMPArgs<T> | Callback<PickMpReturns<T>>, config?: {
-    type?: string;
-}): any;
+import { JsApiConfig } from './types';
+export declare function mpCall<T extends keyof MPApi>(apiName: T | ({} & string), options?: PickMPArgs<T> | Callback<PickMpReturns<T>>, config?: JsApiConfig): any;

package/lib/mpWebBridge.d.ts

@@ -1,3 +1,3 @@
 import { Message, MessageHandler } from './types';
 export declare function mpWebOnMessage(cb: MessageHandler): () => void;
-export declare function mpWebPostMessage(message: Message): void;
+export declare function mpWebPostMessage(message: Message): any;

package/lib/mpWebBridge.js

@@ -1,75 +1,30 @@
-var __rest = this && this.__rest || function (s, e) {
-  var t = {};
-  for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p];
-  if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-    if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]];
-  }
-  return t;
-};
-/** 加载 appx 脚本 */
-var loadAppxBridge = function loadAppxBridge(cb) {
-  var _a;
-  try {
-    // umd 包用的 IFF 模式，会立即向 window.my 上注入 jsapi，所以不能使用 window.my 判断是否已经加载了 appx 脚本
-    // umd 版本和 modules 版本不能混用
-    if ((_a = window.my) === null || _a === void 0 ? void 0 : _a.__hy_mounted__) {
-      cb && cb("ready" /* BridgeReady.READY */);
-      return;
-    }
-    var hyMy_1 = window.my || {};
-    var script_1 = document.createElement('script');
-    script_1.src = 'https://appx/web-view.min.js';
-    script_1.onload = function onload() {
-      var readyState = script_1['readyState'];
-      if (typeof readyState === 'undefined' || /^(loaded|complete)$/.test(readyState)) {
-        script_1.onload = null;
-        // appx 脚本覆盖了 window 的 my 属性，这里再把 hylid-bridge 的 API 挂上去
-        var postMessage_1 = hyMy_1.postMessage,
-          api = __rest(hyMy_1, ["postMessage"]);
-        Object.assign(window.my, api, {
-          __hy_mounted__: true
-        });
-        cb && cb("loaded" /* BridgeReady.LOADED */);
-      }
-    };
-    var head = document.getElementsByTagName('head')[0] || document.body;
-    head.appendChild(script_1);
-  } catch (e) {
-    cb && cb(null);
-  }
-};
+import { alipayJSBridge } from "./webCall";
 var isListening = false;
-var WAITING_QUEUE = [];
 var MESSAGE_HANDLER = [];
 export function mpWebOnMessage(cb) {
   MESSAGE_HANDLER.push(cb);
   return function () {
-    var index = MESSAGE_HANDLER.indexOf(cb);
-    if (index > -1) {
-      MESSAGE_HANDLER.splice(index, 1);
-    }
+    MESSAGE_HANDLER = MESSAGE_HANDLER.filter(function (o) {
+      return o !== cb;
+    });
   };
 }
 export function mpWebPostMessage(message) {
-  return loadAppxBridge(function (bridgeReady) {
-    if (bridgeReady) {
-      if (!isListening) {
-        var messageHandler_1 = window.my.onMessage;
-        window.my.onMessage = function (message) {
-          MESSAGE_HANDLER.forEach(function (fn) {
-            return fn(message);
-          });
-          if (messageHandler_1) messageHandler_1(message);
-        };
-        isListening = true;
-      }
-      if (WAITING_QUEUE.length) {
-        WAITING_QUEUE.forEach(window.my.postMessage);
-        WAITING_QUEUE = [];
-      }
-      window.my.postMessage(message);
-    } else {
-      WAITING_QUEUE.push(message);
-    }
+  if (!isListening) {
+    document.addEventListener('onToWebViewMessage', function (e) {
+      var res = e.data.res;
+      if (!res || res.type !== 'message') return;
+      var data = JSON.parse(res.data);
+      MESSAGE_HANDLER.forEach(function (fn) {
+        return fn(data);
+      });
+    });
+    isListening = true;
+  }
+  return alipayJSBridge(function () {
+    window.AlipayJSBridge.call('postWebViewMessage', {
+      type: 'message',
+      detail: message
+    });
   });
 }

package/lib/mpWebCall.d.ts

@@ -1,5 +1,11 @@
-import { PickMPArgs, PickMpReturns, MPApi } from '@hylid/types';
-import { MpWebJsApiConfig } from './types';
-declare type Callback<T> = (result?: T) => void;
-export declare const mpWebCall: <T extends keyof MPApi>(api: ({} & string) | T, options?: PickMPArgs<T> | Callback<ReturnType<MPApi[T]>> | undefined, config?: MpWebJsApiConfig) => void;
-export {};
+import { MPApi } from '@hylid/types';
+import { JsApiConfig, MpWebJsApiOptions } from './types';
+import { mpWebOnMessage, mpWebPostMessage } from './mpWebBridge';
+export declare function mpWebCall<T extends keyof MPApi>(api: T | ({} & string), options?: MpWebJsApiOptions<T>, config?: JsApiConfig): void;
+export declare namespace mpWebCall {
+    var onMessage: typeof mpWebOnMessage;
+    var postMessage: typeof mpWebPostMessage;
+    var broadcastGlobalData: (key: string, result: any) => void;
+    var onReceiveGlobalData: (key: string, callback: (data: any, error: any, form: string) => void) => () => void;
+    var onPageEvent: (event: ({} & string) | "onShow" | "onHide" | "onTitleClick" | "onOptionMenuClick" | "onTabItemTap", callback: (data: any, err?: any) => void) => () => void;
+}

package/lib/mpWebCall.js

@@ -1,118 +1,111 @@
-var loadAppxBridge = function loadAppxBridge(cb) {
+import { mpWebOnMessage, mpWebPostMessage } from "./mpWebBridge";
+// 关联 postMessage 和 onMessage，根据 serialId 执行回调
+var callMap = {};
+// 注册 jsapi 的 message 处理器
+mpWebOnMessage(function (msg) {
   var _a;
-  try {
-    // umd 包用的 IFF 模式，会立即向 window.my 上注入 jsapi，所以不能使用 window.my 判断是否已经加载了 appx 脚本
-    // umd 版本和 modules 版本不能混用
-    if ((_a = window.my) === null || _a === void 0 ? void 0 : _a.__hy_mounted__) {
-      cb && cb("ready" /* BridgeReady.READY */);
-      return;
-    }
-    var hyMy_1 = window.my || {};
-    var script_1 = document.createElement('script');
-    script_1.src = 'https://appx/web-view.min.js';
-    script_1.onload = function onload() {
-      var readyState = script_1['readyState'];
-      if (typeof readyState === 'undefined' || /^(loaded|complete)$/.test(readyState)) {
-        script_1.onload = null;
-        Object.assign(window.my, hyMy_1, {
-          __hy_mounted__: true
-        });
-        cb && cb("loaded" /* BridgeReady.LOADED */);
-      }
-    };
-    var head = document.getElementsByTagName('head')[0] || document.body;
-    head.appendChild(script_1);
-  } catch (e) {
-    cb && cb(null);
+  var message = msg;
+  var serialId = message.serialId;
+  // 不是 jsapi 的调用的消息
+  if (message.type && message.type !== 'apiCall') return;
+  if (!serialId) return;
+  if (!callMap[serialId]) return;
+  var callback = callMap[serialId];
+  var data = message.result;
+  var type = (_a = message.config) === null || _a === void 0 ? void 0 : _a.type; // JsApi 的类型
+  if (type === 'callback') {
+    var _b = data || {},
+      _data_1 = _b._data_,
+      _type_1 = _b._type_;
+    if (_type_1 === 'success') return callback(_data_1);
+    return callback(undefined, _data_1);
   }
-};
-var callbackFn = function callbackFn(res, callback) {
-  var _a = callback || {},
-    success = _a.success,
-    fail = _a.fail,
-    complete = _a.complete;
-  var _b = res || {},
-    _data_ = _b._data_,
-    _type_ = _b._type_;
+  var _c = callback || {},
+    success = _c.success,
+    fail = _c.fail,
+    complete = _c.complete;
+  var _d = data || {},
+    _data_ = _d._data_,
+    _type_ = _d._type_;
   // 新版本协议
   if (_type_) {
     if (_type_ === 'success') success === null || success === void 0 ? void 0 : success(_data_);
     if (_type_ === 'fail') fail === null || fail === void 0 ? void 0 : fail(_data_);
-    return complete === null || complete === void 0 ? void 0 : complete(_data_);
-  }
-  // 下面兼容老版本(老版本消息识别不明确，导致 H5 中走 success/fail 逻辑可能岔了)
-  // @ts-ignore
-  if (res === null || res === void 0 ? void 0 : res.error) {
-    fail === null || fail === void 0 ? void 0 : fail(res);
+    complete === null || complete === void 0 ? void 0 : complete(_data_);
   } else {
-    success === null || success === void 0 ? void 0 : success(res);
-  }
-  complete === null || complete === void 0 ? void 0 : complete(res);
-};
-export var mpWebCall = function () {
-  var callMap = {};
-  var WAITING_QUEUE = [];
-  var isListening = false;
-  function onMessage() {
-    var messageHandler = window.my.onMessage;
-    window.my.onMessage = function (message) {
-      var _a;
-      var serialId = message.serialId;
-      var data = message.result;
-      var type = (_a = message.config) === null || _a === void 0 ? void 0 : _a.type; // JsApi 的类型
-      if (serialId) {
-        var callback = callMap[serialId];
-        if (!callback) return;
-        if (type === 'callback') {
-          callback(data);
-        } else {
-          callbackFn(data, callback);
-          delete callMap[serialId];
-        }
-      } else if (messageHandler) {
-        messageHandler(message);
-      }
-    };
-  }
-  function fireMessage(_a) {
-    var api = _a.api,
-      options = _a.options,
-      config = _a.config;
-    var random = Math.floor(Math.random() * 1000000);
-    var serialId = api + '_' + random;
-    if (options) {
-      callMap[serialId] = options;
+    // 下面兼容老版本(老版本消息识别不明确，导致 H5 中走 success/fail 逻辑可能岔了)
+    // @ts-ignore
+    if (data === null || data === void 0 ? void 0 : data.error) {
+      fail === null || fail === void 0 ? void 0 : fail(data);
+    } else {
+      success === null || success === void 0 ? void 0 : success(data);
     }
-    var params = {
-      source: 'hylid',
-      type: 'apiCall',
-      api: api,
-      serialId: serialId,
-      options: options,
-      config: config
-    };
-    window.my.postMessage(params);
+    complete === null || complete === void 0 ? void 0 : complete(data);
+  }
+  delete callMap[serialId];
+});
+export function mpWebCall(api, options, config) {
+  var random = Math.floor(Math.random() * 1000000);
+  var serialId = api + '_' + random;
+  // 只调用，没有参数，不需要接收 jsapi 执行结果
+  if (options) {
+    callMap[serialId] = options;
   }
-  return function call(api, options, config) {
-    loadAppxBridge(function (bridgeReady) {
-      var params = {
-        api: api,
-        options: options,
-        config: config
-      };
-      if (bridgeReady) {
-        if (!isListening) {
-          onMessage();
-          isListening = true;
-        }
-        if (WAITING_QUEUE.length) {
-          WAITING_QUEUE.forEach(fireMessage);
-          WAITING_QUEUE = [];
-        }
-        fireMessage(params);
-      } else {
-        WAITING_QUEUE.push(params);
-      }
-    });
+  var message = {
+    source: 'hylid',
+    type: 'apiCall',
+    api: api,
+    serialId: serialId,
+    options: options,
+    config: config
+  };
+  mpWebPostMessage(message);
+}
+function broadcastGlobalData(key, result) {
+  var message = {
+    source: 'hylid',
+    type: 'broadcast',
+    from: window.location.href,
+    key: key,
+    result: result
   };
-}();
+  mpWebPostMessage(message);
+}
+function onReceiveGlobalData(key, callback) {
+  return mpWebOnMessage(function (msg) {
+    var message = msg;
+    if (message.source !== 'hylid') return;
+    if (message.type !== 'broadcast') return;
+    // 不是接收的目标消息
+    if (message.key !== key) return;
+    var _a = message.result || {},
+      _data_ = _a._data_,
+      _type_ = _a._type_;
+    if (_type_ === 'success') return callback(_data_, undefined, message.from);
+    return callback(undefined, _data_, message.from);
+  });
+}
+function onPageEvent(event, callback) {
+  // 告诉小程序侧，监听 event 事件
+  mpWebPostMessage({
+    source: 'hylid',
+    type: 'pageEvent',
+    event: event
+  });
+  return mpWebOnMessage(function (msg) {
+    var message = msg;
+    if (message.source !== 'hylid') return;
+    if (message.type !== 'pageEvent') return;
+    if (message.event !== event) return;
+    var _a = message.result || {},
+      _data_ = _a._data_,
+      _type_ = _a._type_;
+    if (_type_ === 'success') return callback(_data_);
+    return callback(undefined, _data_);
+  });
+}
+mpWebCall.onMessage = mpWebOnMessage;
+mpWebCall.postMessage = mpWebPostMessage;
+mpWebCall.broadcastGlobalData = broadcastGlobalData;
+mpWebCall.onReceiveGlobalData = onReceiveGlobalData;
+mpWebCall.onPageEvent = onPageEvent;

package/lib/notFound.js

@@ -1,3 +1,4 @@
+import { createError } from "./utils";
 export var notFound = function notFound(name, opt, config) {
   var _a;
   if (config === void 0) {
@@ -5,10 +6,7 @@ export var notFound = function notFound(name, opt, config) {
   }
   var _b = config.type,
     type = _b === void 0 ? 'async' : _b;
-  var response = {
-    error: -1,
-    errorMessage: "".concat(name, " is not found")
-  };
+  var response = createError('NOTFOUND', name);
   if (type === 'sync') return response;
   if (type === 'callback') {
     opt === null || opt === void 0 ? void 0 : opt(response);

package/lib/types.d.ts

@@ -1,20 +1,51 @@
-import { JsApiType, MPApi } from '@hylid/types';
+import { JsApiType, MPApi, PickMPArgs, PickMpReturns } from '@hylid/types';
 export declare type JsApi = keyof MPApi;
-export interface MpWebJsApiConfig {
+export interface JsApiConfig {
     type?: JsApiType;
 }
-export declare type Config = MpWebJsApiConfig;
-export interface MpWebMessageResult {
+export declare type Config = JsApiConfig;
+export interface MpWebMessageResult<T = any> {
     _type_: 'success' | 'fail';
-    _data_: any;
+    _data_: T;
 }
-export interface MpWebMessage {
+export interface MpWebJsApiMessage {
     source: 'hylid';
     type: 'apiCall';
     api: string;
     serialId: string;
     options: any;
-    config?: MpWebJsApiConfig;
+    config?: JsApiConfig;
     result?: MpWebMessageResult;
 }
-export declare type JsApiInfo = Pick<MpWebMessage, 'api' | 'options' | 'config'>;
+export interface MpWebBroadcastMessage {
+    source: 'hylid';
+    type: 'broadcast';
+    from: string;
+    key: string;
+    result?: MpWebMessageResult;
+}
+export interface MpWebPageEventMessage {
+    source: 'hylid';
+    type: 'pageEvent';
+    event: 'onShow' | 'onHide' | 'onTitleClick' | 'onOptionMenuClick' | 'onTabItemTap' | ({} & string);
+    result?: MpWebMessageResult;
+}
+export declare type Message = MpWebJsApiMessage | MpWebBroadcastMessage | MpWebPageEventMessage;
+export declare type MessageHandler = (message: Message) => void;
+declare type Callback<T> = (result?: T) => void;
+export declare type MpWebJsApiOptions<T extends keyof MPApi> = PickMPArgs<T> | Callback<PickMpReturns<T>>;
+export interface WebviewBridgeConfig {
+    /** 允许调用 jsApi 的白名单 */
+    whitelist?: string[];
+    /** 禁止调用 jsApi 的黑名单 */
+    blacklist?: string[];
+    /** 自定义 jsApi [ 优先级比较高，可以覆盖原生的 jsApi ] */
+    customApi?: CustomApi;
+}
+export interface CustomApi {
+    [key: string]: (params: {
+        success(v: any): void;
+        fail(v: any): void;
+    }) => void;
+}
+export {};

package/lib/utils.d.ts

@@ -0,0 +1,30 @@
+import { MpWebMessageResult } from './types';
+declare const ERROR: {
+    NOTFOUND: {
+        code: number;
+        message: (name: string) => string;
+    };
+    NOTALLOWED: {
+        code: number;
+        message: (name: string) => string;
+    };
+    INVALID: {
+        code: number;
+        message: (name: string) => string;
+    };
+    NOTBIND: {
+        code: number;
+        message: (name: string) => string;
+    };
+    PARAMS_ERROR: {
+        code: number;
+        message: (name: string) => string;
+    };
+};
+export declare const createError: (type: keyof typeof ERROR, name?: string) => {
+    errorCode: number;
+    errorMessage: string;
+    errorSouce: string;
+};
+export declare function createMessage(message: any, type?: 'success' | 'fail'): MpWebMessageResult;
+export {};

package/lib/utils.js

@@ -0,0 +1,54 @@
+var ERROR = {
+  NOTFOUND: {
+    code: -1,
+    message: function message(name) {
+      return "".concat(name, " is not found");
+    }
+  },
+  NOTALLOWED: {
+    code: -2,
+    message: function message(name) {
+      return "".concat(name, " is not allowed");
+    }
+  },
+  INVALID: {
+    code: -3,
+    message: function message(name) {
+      return "".concat(name, " is invalid");
+    }
+  },
+  NOTBIND: {
+    code: -4,
+    message: function message(name) {
+      return "".concat(name, " exec fail, webviewBridge not bind context");
+    }
+  },
+  PARAMS_ERROR: {
+    code: -5,
+    message: function message(name) {
+      return "".concat(name, " exec fail, params error");
+    }
+  }
+};
+export var createError = function createError(type, name) {
+  if (name === void 0) {
+    name = '';
+  }
+  var _a = ERROR[type],
+    code = _a.code,
+    message = _a.message;
+  return {
+    errorCode: code,
+    errorMessage: message(name),
+    errorSouce: 'hylid'
+  };
+};
+export function createMessage(message, type) {
+  if (type === void 0) {
+    type = 'success';
+  }
+  return {
+    _type_: type,
+    _data_: message
+  };
+}

package/lib/webCall.d.ts

@@ -1,4 +1,4 @@
 import { AliJsApi } from '@hylid/types';
-export declare function webCall<T extends keyof AliJsApi.Api>(apiName: T | ({} & string), options?: any, config?: {
-    type?: string;
-}): void;
+import { JsApiConfig } from './types';
+export declare const alipayJSBridge: (cb: Function) => any;
+export declare function webCall<T extends keyof AliJsApi.Api>(apiName: T | ({} & string), options?: any, config?: JsApiConfig): void;

package/lib/webCall.js

@@ -1,11 +1,11 @@
-var alipayJSBridgeReady = function alipayJSBridgeReady(cb) {
+export var alipayJSBridge = function alipayJSBridge(cb) {
   if (window.AlipayJSBridge) return cb();
   document.addEventListener('AlipayJSBridgeReady', function () {
     return cb();
   }, false);
 };
 export function webCall(apiName, options, config) {
-  alipayJSBridgeReady(function () {
+  alipayJSBridge(function () {
     var _a = (config || {}).type,
       type = _a === void 0 ? 'async' : _a;
     if (type === 'async') {

package/lib/webviewBridge/index.d.ts

@@ -0,0 +1,26 @@
+import { Message, WebviewBridgeConfig } from '../types';
+interface WebViewContext {
+    postMessage(message: Message): void;
+}
+export declare class WebViewBridge {
+    private webview;
+    private config;
+    private context;
+    private MESSAGE_HANDLER;
+    /**
+     *
+     * @param webviewId webview 组件的 id，可传字符串，或者 my.createWebViewContext 创建出的实例
+     * @param config Config 配置
+     * @param context 页面上下文，传 this 即可。传入后，H5 侧可以使用广播、可以监听页面事件
+     */
+    constructor(webviewId: string | WebViewContext, config?: WebviewBridgeConfig, context?: any);
+    listen: (data: {
+        detail: Message;
+    }) => void;
+    private jsApiHandler;
+    private broadcastHandler;
+    private pageEventHandler;
+    private bindCtxEvent;
+    private sendMessage;
+}
+export {};