@hylid/call 0.0.2-dev.1

package/README.md

@@ -0,0 +1,17 @@
+# @hylid/env
+
+## Install
+
+```bash
+npm i @hylid/env --save
+```
+
+## API
+
+```ts
+import { appName, platform, appEnv, platformEnv, APP, PLATFORM } from '@hylid/env';
+```
+
+## License
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="miniprogram" />
+import { MPApi, PickMPArgs, PickMpReturns, Callback } from '@hylid/types';
+import { mpCall } from './mpCall';
+import { mpWebCall, mpWebCallAsync } from './mpWebCall';
+import { webCall, webCallAsync } from './webCall';
+import { notFound } from './notFound';
+import { Config } from './types';
+export declare function call<T extends keyof MPApi>(name: T | ({} & string), options?: PickMPArgs<T> | Common | Callback<PickMpReturns<T>>, config?: Config): any;
+export declare function callAsync<T = any>(apiName: string, options?: AsyncCallback<T> & any, config?: {
+    timeout: number;
+    isSync?: boolean;
+}): Promise<any>;
+export declare function createWebviewSrc(url: string): string;
+export { WebViewBridge } from './webviewBridge';
+export { mpCall, mpWebCall, webCall, notFound, mpWebCallAsync, webCallAsync };
+export { promisify } from './promisify';

package/lib/index.js

@@ -0,0 +1,37 @@
+var _a, _b;
+import { platform, PLATFORM } from '@hylid/env';
+import { mpCall } from "./mpCall";
+import { mpWebCall, mpWebCallAsync } from "./mpWebCall";
+import { webCall, webCallAsync } from "./webCall";
+import { notFound } from "./notFound";
+var callMap = (_a = {}, _a[PLATFORM.MP] = mpCall, _a[PLATFORM.MPWEB] = mpWebCall, _a[PLATFORM.WEB] = webCall, _a);
+var callMapAsync = (_b = {}, _b[PLATFORM.MPWEB] = mpWebCallAsync, _b[PLATFORM.WEB] = webCallAsync, _b);
+export function call(name, options, config) {
+  if (platform) {
+    return callMap[platform](name, options, config);
+  } else {
+    return notFound(options, config);
+  }
+}
+export function callAsync(apiName, options, config) {
+  if (platform) {
+    return callMapAsync[platform](apiName, options, config);
+  } else {
+    return Promise.reject(notFound(options, config));
+  }
+}
+export function createWebviewSrc(url) {
+  var app = my.getSystemInfoSync().app;
+  var hashIndex = url.indexOf('#');
+  var hash = '';
+  if (hashIndex !== -1) {
+    hash = url.slice(hashIndex);
+    url = url.slice(0, hashIndex);
+  }
+  var separator = url.includes('?') ? '&' : '?';
+  var newUrl = url + separator + '__app__=' + app + hash;
+  return newUrl;
+}
+export { WebViewBridge } from "./webviewBridge";
+export { mpCall, mpWebCall, webCall, notFound, mpWebCallAsync, webCallAsync };
+export { promisify } from "./promisify";

package/lib/mpCall.d.ts

@@ -0,0 +1,3 @@
+import { MPApi, PickMPArgs, Callback, PickMpReturns } from '@hylid/types';
+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/mpCall.js

@@ -0,0 +1,26 @@
+export function mpCall(apiName, options, config) {
+  var _a = (config || {}).type,
+    type = _a === void 0 ? 'async' : _a;
+  if (type === 'sync' || (config === null || config === void 0 ? void 0 : config.isSync)) {
+    // @ts-ignore
+    return my[apiName](options);
+  }
+  if (type === 'async') {
+    // @ts-ignore
+    if (my[apiName]) {
+      // @ts-ignore
+      my[apiName](options);
+    } else {
+      // @ts-ignore
+      my.call(apiName, options);
+    }
+  }
+  if (type === 'callback') {
+    // @ts-ignore
+    my[apiName](options);
+  }
+  if (type === 'attribute') {
+    // @ts-ignore
+    return my[apiName];
+  }
+}

package/lib/mpWebBridge.d.ts

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

package/lib/mpWebBridge.js

@@ -0,0 +1,30 @@
+import { alipayJSBridge } from "./webCall";
+var isListening = false;
+var MESSAGE_HANDLER = [];
+export function mpWebOnMessage(cb) {
+  MESSAGE_HANDLER.push(cb);
+  return function () {
+    MESSAGE_HANDLER = MESSAGE_HANDLER.filter(function (o) {
+      return o !== cb;
+    });
+  };
+}
+export function mpWebPostMessage(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

@@ -0,0 +1,16 @@
+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;
+}
+export declare const mpWebCallAsync: <T = any>(apiName: string, options?: any, config?: {
+    /** 超时时长，默认 20000, 0 表示不判断超时 */
+    timeout: number;
+    isSync?: boolean;
+}) => Promise<any>;

package/lib/mpWebCall.js

@@ -0,0 +1,274 @@
+var __assign = this && this.__assign || function () {
+  __assign = Object.assign || function (t) {
+    for (var s, i = 1, n = arguments.length; i < n; i++) {
+      s = arguments[i];
+      for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+    }
+    return t;
+  };
+  return __assign.apply(this, arguments);
+};
+import { mpWebOnMessage, mpWebPostMessage } from "./mpWebBridge";
+import { createError } from "./utils";
+import { alipayJSBridge } from "./webCall";
+// 关联 postMessage 和 onMessage，根据 serialId 执行回调
+var callMap = {};
+// 注册 jsapi 的 message 处理器
+mpWebOnMessage(function (msg) {
+  var _a;
+  var message = msg;
+  var serialId = message.serialId;
+  // 不是 jsapi 的调用的消息
+  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 _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_);
+    complete === null || complete === void 0 ? void 0 : complete(_data_);
+  } else {
+    // 下面兼容老版本(老版本消息识别不明确，导致 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);
+    }
+    complete === null || complete === void 0 ? void 0 : complete(data);
+  }
+  delete callMap[serialId];
+});
+export function mpWebCall(api, options, config) {
+  config = __assign({
+    timeout: 20000
+  }, config);
+  var random = Math.floor(Math.random() * 1000000);
+  var serialId = api + '_' + random;
+  // 只调用，没有参数，不需要接收 jsapi 执行结果
+  if (options) {
+    callMap[serialId] = options;
+  }
+  var message = {
+    source: 'hylid',
+    type: 'apiCall',
+    api: api,
+    serialId: serialId,
+    options: options,
+    config: config,
+    isSync: config === null || config === void 0 ? void 0 : config.isSync
+  };
+  mpWebPostMessage(message);
+  // 设置 jsapi 通信超时时间
+  var _options = options;
+  if ((config === null || config === void 0 ? void 0 : config.timeout) && (_options === null || _options === void 0 ? void 0 : _options.fail)) {
+    setTimeout(function () {
+      if (!callMap[serialId]) return;
+      delete callMap[serialId];
+      _options.fail(createError('TIMEOUT'));
+    }, config.timeout);
+  }
+}
+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;
+var callbackFn = function callbackFn(res, callback) {
+  var _a = callback || {},
+    success = _a.success,
+    fail = _a.fail,
+    complete = _a.complete;
+  // @ts-ignore
+  if (res === null || res === void 0 ? void 0 : res.error) {
+    fail === null || fail === void 0 ? void 0 : fail(res);
+  } else {
+    success === null || success === void 0 ? void 0 : success(res);
+  }
+  complete === null || complete === void 0 ? void 0 : complete(res);
+};
+export var mpWebCallAsync = function () {
+  var callMap = {};
+  var isListening = false;
+  function onMessage() {
+    var messageHandler = function messageHandler(message) {
+      var _a;
+      var serialId = message.serialId;
+      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;
+      if (type === 'callback') {
+        var _b = data || {},
+          _data_2 = _b._data_,
+          _type_2 = _b._type_;
+        if (_type_2 === 'success') return callback(_data_2);
+        return callback(undefined, _data_2);
+      }
+      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_);
+        complete === null || complete === void 0 ? void 0 : complete(_data_);
+      } else {
+        // 下面兼容老版本(老版本消息识别不明确，导致 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);
+        }
+        complete === null || complete === void 0 ? void 0 : complete(data);
+      }
+      delete callMap[serialId];
+    };
+    // 代码参考：https://alex.alipay.com/antcode/qianyu.fzy/af-appx/blob/r20191223-1.24.0/src/web-view/embed/index.tsx
+    document.addEventListener('onToWebViewMessage', function (e) {
+      var res = e.data.res;
+      if (res.type === 'message') {
+        messageHandler(JSON.parse(res.data));
+      }
+      // TODO: 参考的代码中还有 response 的类型，需要考虑一下是否实现，对应 api 为 'navigateTo','navigateBack','switchTab','reLaunch','redirectTo',
+    });
+  }
+  function fireMessage(_a) {
+    var _b;
+    var apiName = _a.apiName,
+      options = _a.options,
+      isSync = _a.isSync;
+    var env = window;
+    var random = Math.floor(Math.random() * 1000000);
+    var serialId = "".concat(apiName, "_").concat(random);
+    if (options) {
+      callMap[serialId] = options;
+    }
+    var params = {
+      type: 'apiCall',
+      api: apiName,
+      serialId: serialId,
+      options: options,
+      isSync: isSync,
+      source: 'hylid'
+    };
+    (_b = env.AlipayJSBridge) === null || _b === void 0 ? void 0 : _b.call('postWebViewMessage', {
+      type: 'message',
+      detail: params
+    });
+  }
+  return function mpWebCall(apiName, options, config) {
+    return new Promise(function (resolve, reject) {
+      var _a = options || {},
+        _success = _a.success,
+        _fail = _a.fail;
+      var _b = config || {},
+        _c = _b.timeout,
+        timeout = _c === void 0 ? 20000 : _c,
+        isSync = _b.isSync;
+      var timer;
+      if (timeout > 0) {
+        timer = setTimeout(function () {
+          var err = {
+            error: -101,
+            errorMessage: "[".concat(apiName, "]: Timeout")
+          };
+          reject(err);
+          _fail === null || _fail === void 0 ? void 0 : _fail(err);
+        }, timeout);
+      }
+      var params = {
+        apiName: apiName,
+        options: __assign(__assign({}, options), {
+          success: function success(res) {
+            if (timer) {
+              clearTimeout(timer);
+            }
+            resolve(res);
+            _success === null || _success === void 0 ? void 0 : _success(res);
+          },
+          fail: function fail(err) {
+            if (timer) {
+              clearTimeout(timer);
+            }
+            reject(err);
+            _fail === null || _fail === void 0 ? void 0 : _fail(err);
+          }
+        }),
+        isSync: isSync
+      };
+      alipayJSBridge(function () {
+        if (!isListening) {
+          onMessage();
+          isListening = true;
+        }
+        fireMessage(params);
+      });
+    });
+  };
+}();

package/lib/notFound.d.ts

@@ -0,0 +1 @@
+export declare const notFound: any;

package/lib/notFound.js

@@ -0,0 +1,17 @@
+import { createError } from "./utils";
+export var notFound = function notFound(name, opt, config) {
+  var _a;
+  if (config === void 0) {
+    config = {};
+  }
+  var _b = config.type,
+    type = _b === void 0 ? 'async' : _b;
+  var response = createError('NOTFOUND', name);
+  if (type === 'sync') return response;
+  if (type === 'callback') {
+    opt === null || opt === void 0 ? void 0 : opt(response);
+  }
+  if (type === 'async') {
+    (_a = opt === null || opt === void 0 ? void 0 : opt.fail) === null || _a === void 0 ? void 0 : _a.call(opt, response);
+  }
+};

package/lib/promisify.d.ts

@@ -0,0 +1,5 @@
+export interface Options {
+    success?: (res: any) => void;
+    fail?: (res: any) => void;
+}
+export declare const promisify: <T extends Options, P = Parameters<Required<Options> & T["success"]>[0]>(fn: (opt: T) => void) => (args?: T | undefined) => Promise<P>;

package/lib/promisify.js

@@ -0,0 +1,29 @@
+var __assign = this && this.__assign || function () {
+  __assign = Object.assign || function (t) {
+    for (var s, i = 1, n = arguments.length; i < n; i++) {
+      s = arguments[i];
+      for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+    }
+    return t;
+  };
+  return __assign.apply(this, arguments);
+};
+export var promisify = function promisify(fn) {
+  return function (args) {
+    return new Promise(function (resolve, reject) {
+      var options = __assign(__assign({}, args), {
+        success: function success(opt) {
+          var _a;
+          resolve(opt);
+          (_a = args === null || args === void 0 ? void 0 : args.success) === null || _a === void 0 ? void 0 : _a.call(args, opt);
+        },
+        fail: function fail(opt) {
+          var _a;
+          reject(opt);
+          (_a = args === null || args === void 0 ? void 0 : args.fail) === null || _a === void 0 ? void 0 : _a.call(args, opt);
+        }
+      });
+      fn(options);
+    });
+  };
+};

package/lib/types.d.ts

@@ -0,0 +1,63 @@
+import { JsApiType, MPApi, PickMPArgs, PickMpReturns } from '@hylid/types';
+export declare type JsApi = keyof MPApi;
+export interface JsApiConfig {
+    type?: JsApiType;
+    /**
+     * @deprecated 优先使用 type = "sync" 配置
+     */
+    isSync?: boolean;
+    /**
+     * 套壳 jsapi 调用，通信超时时间。type = "callback" 时不生效
+     */
+    timeout?: number;
+}
+export declare type Config = JsApiConfig;
+export interface MpWebMessageResult<T = any> {
+    _type_: 'success' | 'fail';
+    _data_: T;
+}
+export interface MpWebJsApiMessage {
+    source: 'hylid';
+    type: 'apiCall';
+    api: string;
+    serialId: string;
+    options: any;
+    config?: JsApiConfig;
+    result?: MpWebMessageResult;
+    /**
+     * @deprecated 优先使用 config.type = "sync" 配置
+     */
+    isSync?: boolean;
+}
+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/types.js

@@ -0,0 +1 @@
+export {};

package/lib/utils.d.ts

@@ -0,0 +1,34 @@
+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;
+    };
+    TIMEOUT: {
+        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,60 @@
+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");
+    }
+  },
+  TIMEOUT: {
+    code: -6,
+    message: function message(name) {
+      return "".concat(name, " exec fail, timeout");
+    }
+  }
+};
+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

@@ -0,0 +1,7 @@
+import { AliJsApi, AsyncCallback } from '@hylid/types';
+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;
+export declare function webCallAsync<T = any>(apiName: string, options?: AsyncCallback<T> & any, config?: {
+    timeout?: number;
+}): Promise<any>;