@tarojs/taro-h5 3.4.0-beta.2 → 3.4.0-beta.3

package/dist/api/network/request/index.js

@@ -0,0 +1,125 @@
+import Taro from '@tarojs/api';
+import 'whatwg-fetch';
+import jsonpRetry from 'jsonp-retry';
+import { serializeParams } from '../../utils';
+// @ts-ignore
+const { Link } = Taro;
+function generateRequestUrlWithParams(url, params) {
+    params = typeof params === 'string' ? params : serializeParams(params);
+    if (params) {
+        url += (~url.indexOf('?') ? '&' : '?') + params;
+    }
+    url = url.replace('?&', '?');
+    return url;
+}
+// FIXME 移除 any 标注
+function _request(options) {
+    options = options || {};
+    if (typeof options === 'string') {
+        options = {
+            url: options
+        };
+    }
+    const { success, complete, fail } = options;
+    let url = options.url;
+    const params = {};
+    const res = {};
+    if (options.jsonp) {
+        Object.assign(params, options);
+        params.params = options.data;
+        params.cache = options.jsonpCache;
+        if (typeof options.jsonp === 'string') {
+            params.name = options.jsonp;
+        }
+        delete params.jsonp;
+        return jsonpRetry(url, params)
+            .then(data => {
+            res.statusCode = 200;
+            res.data = data;
+            typeof success === 'function' && success(res);
+            typeof complete === 'function' && complete(res);
+            return res;
+        })
+            .catch(err => {
+            typeof fail === 'function' && fail(err);
+            typeof complete === 'function' && complete(res);
+            return Promise.reject(err);
+        });
+    }
+    params.method = options.method || 'GET';
+    const methodUpper = params.method.toUpperCase();
+    params.cache = options.cache || 'default';
+    if (methodUpper === 'GET' || methodUpper === 'HEAD') {
+        url = generateRequestUrlWithParams(url, options.data);
+    }
+    else if (typeof options.data === 'object') {
+        options.header = options.header || {};
+        const keyOfContentType = Object.keys(options.header).find(item => item.toLowerCase() === 'content-type');
+        if (!keyOfContentType) {
+            options.header['Content-Type'] = 'application/json';
+        }
+        const contentType = options.header[keyOfContentType || 'Content-Type'];
+        if (contentType.indexOf('application/json') >= 0) {
+            params.body = JSON.stringify(options.data);
+        }
+        else if (contentType.indexOf('application/x-www-form-urlencoded') >= 0) {
+            params.body = serializeParams(options.data);
+        }
+        else {
+            params.body = options.data;
+        }
+    }
+    else {
+        params.body = options.data;
+    }
+    if (options.header) {
+        params.headers = options.header;
+    }
+    if (options.mode) {
+        params.mode = options.mode;
+    }
+    if (options.signal) {
+        params.signal = options.signal;
+    }
+    params.credentials = options.credentials;
+    return fetch(url, params)
+        .then(response => {
+        res.statusCode = response.status;
+        res.header = {};
+        for (const key of response.headers.keys()) {
+            res.header[key] = response.headers.get(key);
+        }
+        if (!response.ok) {
+            throw response;
+        }
+        if (options.responseType === 'arraybuffer') {
+            return response.arrayBuffer();
+        }
+        if (res.statusCode !== 204) {
+            if (options.dataType === 'json' || typeof options.dataType === 'undefined') {
+                return response.json();
+            }
+        }
+        if (options.responseType === 'text' || options.dataType === 'text') {
+            return response.text();
+        }
+        return Promise.resolve(null);
+    })
+        .then(data => {
+        res.data = data;
+        typeof success === 'function' && success(res);
+        typeof complete === 'function' && complete(res);
+        return res;
+    })
+        .catch(err => {
+        typeof fail === 'function' && fail(err);
+        typeof complete === 'function' && complete(res);
+        return Promise.reject(err);
+    });
+}
+function taroInterceptor(chain) {
+    return _request(chain.requestParams);
+}
+const link = new Link(taroInterceptor);
+export const request = link.request.bind(link);
+export const addInterceptor = link.addInterceptor.bind(link);

package/dist/api/network/tcp.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// TCP 通信
+export const createTCPSocket = temporarilyNotSupport('createTCPSocket');

package/dist/api/network/udp.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// UDP 通信
+export const createUDPSocket = temporarilyNotSupport('createUDPSocket');

package/dist/api/network/upload.js

@@ -0,0 +1,151 @@
+import { temporarilyNotSupport } from '../utils';
+import { CallbackManager } from '../utils/handler';
+import { convertObjectUrlToBlob, NETWORK_TIMEOUT, setHeader, XHR_STATS } from './utils';
+const createUploadTask = ({ url, filePath, formData, name, header, timeout, fileName, success, error }) => {
+    let timeoutInter;
+    let formKey;
+    const apiName = 'uploadFile';
+    const xhr = new XMLHttpRequest();
+    const form = new FormData();
+    const callbackManager = {
+        headersReceived: new CallbackManager(),
+        progressUpdate: new CallbackManager()
+    };
+    xhr.open('POST', url);
+    setHeader(xhr, header);
+    for (formKey in formData) {
+        form.append(formKey, formData[formKey]);
+    }
+    xhr.upload.onprogress = e => {
+        const { loaded, total } = e;
+        callbackManager.progressUpdate.trigger({
+            progress: Math.round(loaded / total * 100),
+            totalBytesSent: loaded,
+            totalBytesExpectedToSent: total
+        });
+    };
+    xhr.onreadystatechange = () => {
+        if (xhr.readyState !== XHR_STATS.HEADERS_RECEIVED)
+            return;
+        callbackManager.headersReceived.trigger({
+            header: xhr.getAllResponseHeaders()
+        });
+    };
+    xhr.onload = () => {
+        const status = xhr.status;
+        clearTimeout(timeoutInter);
+        success({
+            errMsg: `${apiName}:ok`,
+            statusCode: status,
+            data: xhr.responseText || xhr.response
+        });
+    };
+    xhr.onabort = () => {
+        clearTimeout(timeoutInter);
+        error({
+            errMsg: `${apiName}:fail abort`
+        });
+    };
+    xhr.onerror = (e) => {
+        clearTimeout(timeoutInter);
+        error({
+            errMsg: `${apiName}:fail ${e.message}`
+        });
+    };
+    /**
+     * 中断任务
+     */
+    const abort = () => {
+        clearTimeout(timeoutInter);
+        xhr.abort();
+    };
+    const send = () => {
+        xhr.send(form);
+        timeoutInter = setTimeout(() => {
+            xhr.onabort = null;
+            xhr.onload = null;
+            xhr.upload.onprogress = null;
+            xhr.onreadystatechange = null;
+            xhr.onerror = null;
+            abort();
+            error({
+                errMsg: `${apiName}:fail timeout`
+            });
+        }, timeout || NETWORK_TIMEOUT);
+    };
+    convertObjectUrlToBlob(filePath)
+        .then((fileObj) => {
+        if (!fileName) {
+            fileName = typeof fileObj !== 'string' && fileObj.name;
+        }
+        form.append(name, fileObj, fileName || `file-${Date.now()}`);
+        send();
+    })
+        .catch(e => {
+        error({
+            errMsg: `${apiName}:fail ${e.message}`
+        });
+    });
+    /**
+     * 监听 HTTP Response Header 事件。会比请求完成事件更早
+     * @param {HeadersReceivedCallback} callback HTTP Response Header 事件的回调函数
+     */
+    const onHeadersReceived = callbackManager.headersReceived.add;
+    /**
+     * 取消监听 HTTP Response Header 事件
+     * @param {HeadersReceivedCallback} callback HTTP Response Header 事件的回调函数
+     */
+    const offHeadersReceived = callbackManager.headersReceived.remove;
+    /**
+     * 监听进度变化事件
+     * @param {ProgressUpdateCallback} callback HTTP Response Header 事件的回调函数
+     */
+    const onProgressUpdate = callbackManager.progressUpdate.add;
+    /**
+     * 取消监听进度变化事件
+     * @param {ProgressUpdateCallback} callback HTTP Response Header 事件的回调函数
+     */
+    const offProgressUpdate = callbackManager.progressUpdate.remove;
+    const headersReceived = temporarilyNotSupport('UploadTask.headersReceived');
+    const progress = temporarilyNotSupport('UploadTask.progress');
+    return {
+        abort,
+        onHeadersReceived,
+        offHeadersReceived,
+        onProgressUpdate,
+        offProgressUpdate,
+        headersReceived,
+        progress
+    };
+};
+/**
+ * 将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data。使用前请注意阅读相关说明。
+ */
+export const uploadFile = ({ url, filePath, name, header, formData, timeout, fileName, success, fail, complete }) => {
+    let task;
+    const result = new Promise((resolve, reject) => {
+        task = createUploadTask({
+            url,
+            header,
+            name,
+            filePath,
+            formData,
+            timeout,
+            fileName,
+            success: res => {
+                success && success(res);
+                complete && complete(res);
+                resolve(res);
+            },
+            error: res => {
+                fail && fail(res);
+                complete && complete(res);
+                reject(res);
+            }
+        });
+    });
+    result.headersReceive = task.onHeadersReceived;
+    result.progress = task.onProgressUpdate;
+    result.abort = task.abort;
+    return result;
+};

package/dist/api/network/utils.js

@@ -0,0 +1,65 @@
+/**
+ * HTTP Response Header 事件回调函数的参数
+ * @typedef {Object} HeadersReceivedParam
+ * @property {Object} header 开发者服务器返回的 HTTP Response Header
+ */
+/**
+ * HTTP Response Header 事件的回调函数
+ * @callback HeadersReceivedCallback
+ * @param {HeadersReceivedParam} res 参数
+ */
+/**
+ * 进度变化回调函数的参数
+ * @typedef {Object} ProgressUpdateParam
+ * @property {number} progress 进度百分比
+ * @property {number} [totalBytesWritten] 已经下载的数据长度，单位 Bytes
+ * @property {number} [totalBytesSent] 已经上传的数据长度，单位 Bytes
+ * @property {number} [totalBytesExpectedToWrite] 预期需要下载的数据总长度，单位 Bytes
+ * @property {number} [totalBytesExpectedToSend] 预期需要上传的数据总长度，单位 Bytes
+ */
+/**
+ * 进度变化事件的回调函数
+ * @callback ProgressUpdateCallback
+ * @param {ProgressUpdateParam} res 参数
+ */
+export const NETWORK_TIMEOUT = 60000;
+export const XHR_STATS = {
+    UNSENT: 0,
+    OPENED: 1,
+    HEADERS_RECEIVED: 2,
+    LOADING: 3,
+    DONE: 4 // The operation is complete.
+};
+/**
+ * 设置xhr的header
+ * @param {XMLHttpRequest} xhr
+ * @param {Object} header
+ */
+export const setHeader = (xhr, header) => {
+    let headerKey;
+    for (headerKey in header) {
+        xhr.setRequestHeader(headerKey, header[headerKey]);
+    }
+};
+/**
+ * 将 blob url 转化为文件
+ * @param {string} url 要转换的 blob url
+ * @returns {Promise<File>}
+ */
+export const convertObjectUrlToBlob = url => {
+    return new Promise((resolve, reject) => {
+        const xhr = new XMLHttpRequest();
+        xhr.open('GET', url, true);
+        xhr.responseType = 'blob';
+        xhr.onload = function () {
+            if (this.status === 200) {
+                resolve(this.response);
+            }
+            else {
+                /* eslint-disable prefer-promise-reject-errors */
+                reject({ status: this.status });
+            }
+        };
+        xhr.send();
+    });
+};

package/dist/api/network/websocket/index.js

@@ -0,0 +1,70 @@
+import { SocketTask } from './socketTask';
+import { shouldBeObject, getParameterError } from '../../utils';
+import { MethodHandler } from '../../utils/handler';
+let socketTasks = [];
+let socketsCounter = 1;
+export function sendSocketMessage() {
+    console.warn('Deprecated.Please use socketTask.send instead.');
+}
+export function onSocketOpen() {
+    console.warn('Deprecated.Please use socketTask.onOpen instead.');
+}
+export function onSocketMessage() {
+    console.warn('Deprecated.Please use socketTask.onMessage instead.');
+}
+export function onSocketError() {
+    console.warn('Deprecated.Please use socketTask.onError instead.');
+}
+export function onSocketClose() {
+    console.warn('Deprecated.Please use socketTask.onClose instead.');
+}
+export function connectSocket(options) {
+    const name = 'connectSocket';
+    return new Promise((resolve, reject) => {
+        // options must be an Object
+        const isObject = shouldBeObject(options);
+        if (!isObject.flag) {
+            const res = { errMsg: `${name}:fail ${isObject.msg}` };
+            console.error(res.errMsg);
+            return reject(res);
+        }
+        const { url, protocols, success, fail, complete } = options;
+        const handle = new MethodHandler({ name, success, fail, complete });
+        // options.url must be String
+        if (typeof url !== 'string') {
+            return handle.fail({
+                errMsg: getParameterError({
+                    para: 'url',
+                    correct: 'String',
+                    wrong: url
+                })
+            }, reject);
+        }
+        // options.url must be invalid
+        if (!url.startsWith('ws://') && !url.startsWith('wss://')) {
+            return handle.fail({
+                errMsg: `request:fail invalid url "${url}"`
+            }, reject);
+        }
+        // protocols must be array
+        const _protocols = Array.isArray(protocols) ? protocols : null;
+        // 2 connection at most
+        if (socketTasks.length > 1) {
+            return handle.fail({
+                errMsg: '同时最多发起 2 个 socket 请求，更多请参考文档。'
+            }, reject);
+        }
+        const task = new SocketTask(url, _protocols);
+        task._destroyWhenClose = function () {
+            socketTasks = socketTasks.filter(socketTask => socketTask !== this);
+        };
+        socketTasks.push(task);
+        handle.success({
+            socketTaskId: socketsCounter++
+        });
+        return resolve(task);
+    });
+}
+export function closeSocket() {
+    console.warn('Deprecated.Please use socketTask.close instead.');
+}

package/dist/api/network/websocket/socketTask.js

@@ -0,0 +1,63 @@
+export class SocketTask {
+    constructor(url, protocols) {
+        if (protocols && protocols.length) {
+            this.ws = new WebSocket(url, protocols);
+        }
+        else {
+            this.ws = new WebSocket(url);
+        }
+        this.CONNECTING = 0;
+        this.OPEN = 1;
+        this.CLOSING = 2;
+        this.CLOSED = 3;
+    }
+    get readyState() {
+        return this.ws.readyState;
+    }
+    send(opts = {}) {
+        if (typeof opts !== 'object' || !opts)
+            opts = {};
+        const { data = '', success, fail, complete } = opts;
+        if (this.readyState !== 1) {
+            const res = { errMsg: 'SocketTask.send:fail SocketTask.readState is not OPEN' };
+            console.error(res.errMsg);
+            typeof fail === 'function' && fail(res);
+            typeof complete === 'function' && complete(res);
+            return Promise.reject(res);
+        }
+        this.ws.send(data);
+        const res = { errMsg: 'sendSocketMessage:ok' };
+        typeof success === 'function' && success(res);
+        typeof complete === 'function' && complete(res);
+        return Promise.resolve(res);
+    }
+    close(opts = {}) {
+        if (typeof opts !== 'object' || !opts)
+            opts = {};
+        const { code = 1000, reason = 'server complete,close', success, complete } = opts;
+        this.closeDetail = { code, reason };
+        // 主动断开时需要重置链接数
+        this._destroyWhenClose && this._destroyWhenClose();
+        this.ws.close();
+        const res = { errMsg: 'closeSocket:ok' };
+        typeof success === 'function' && success(res);
+        typeof complete === 'function' && complete(res);
+        return Promise.resolve(res);
+    }
+    onOpen(func) {
+        this.ws.onopen = func;
+    }
+    onMessage(func) {
+        this.ws.onmessage = func;
+    }
+    onClose(func) {
+        this.ws.onclose = () => {
+            // 若服务器方断掉也需要重置链接数
+            this._destroyWhenClose && this._destroyWhenClose();
+            func(this.closeDetail || { code: 1006, reason: 'abnormal closure' });
+        };
+    }
+    onError(func) {
+        this.ws.onerror = func;
+    }
+}

package/dist/api/open-api/account.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// 帐号信息
+export const getAccountInfoSync = temporarilyNotSupport('getAccountInfoSync');

package/dist/api/open-api/address.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// 收货地址
+export const chooseAddress = temporarilyNotSupport('chooseAddress');

package/dist/api/open-api/authorize.js

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils';
+// 授权
+export const authorizeForMiniProgram = temporarilyNotSupport('authorizeForMiniProgram');
+export const authorize = temporarilyNotSupport('authorize');

package/dist/api/open-api/card.js

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils';
+// 卡券
+export const openCard = temporarilyNotSupport('openCard');
+export const addCard = temporarilyNotSupport('addCard');

package/dist/api/open-api/channels-live.js

@@ -0,0 +1,8 @@
+import { temporarilyNotSupport } from '../utils';
+// 视频号
+export const reserveChannelsLive = temporarilyNotSupport('reserveChannelsLive');
+export const openChannelsLive = temporarilyNotSupport('openChannelsLive');
+export const openChannelsEvent = temporarilyNotSupport('openChannelsEvent');
+export const openChannelsActivity = temporarilyNotSupport('openChannelsActivity');
+export const getChannelsLiveNoticeInfo = temporarilyNotSupport('getChannelsLiveNoticeInfo');
+export const getChannelsLiveInfo = temporarilyNotSupport('getChannelsLiveInfo');

package/dist/api/open-api/customer-service.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// 微信客服
+export const openCustomerServiceChat = temporarilyNotSupport('openCustomerServiceChat');

package/dist/api/open-api/facial.js

@@ -0,0 +1,6 @@
+import { temporarilyNotSupport } from '../utils';
+// 过往接口
+export const checkIsSupportFacialRecognition = temporarilyNotSupport('checkIsSupportFacialRecognition');
+export const startFacialRecognitionVerify = temporarilyNotSupport('startFacialRecognitionVerify');
+export const startFacialRecognitionVerifyAndUploadVideo = temporarilyNotSupport('startFacialRecognitionVerifyAndUploadVideo');
+export const faceVerifyForPay = temporarilyNotSupport('faceVerifyForPay');

package/dist/api/open-api/favorites.js

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils';
+// 收藏
+export const addVideoToFavorites = temporarilyNotSupport('addVideoToFavorites');
+export const addFileToFavorites = temporarilyNotSupport('addFileToFavorites');

package/dist/api/open-api/group.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// 微信群
+export const getGroupEnterInfo = temporarilyNotSupport('getGroupEnterInfo');

package/dist/api/open-api/index.js

@@ -0,0 +1,18 @@
+export * from './account';
+export * from './address';
+export * from './authorize';
+export * from './card';
+export * from './channels-live';
+export * from './customer-service';
+export * from './facial';
+export * from './favorites';
+export * from './group';
+export * from './invoice';
+export * from './license-plate';
+export * from './login';
+export * from './red-package';
+export * from './settings';
+export * from './soter';
+export * from './subscribe-message';
+export * from './user-info';
+export * from './werun';

package/dist/api/open-api/invoice.js

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils';
+// 发票
+export const chooseInvoiceTitle = temporarilyNotSupport('chooseInvoiceTitle');
+export const chooseInvoice = temporarilyNotSupport('chooseInvoice');

package/dist/api/open-api/license-plate.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// 车牌
+export const chooseLicensePlate = temporarilyNotSupport('chooseLicensePlate');

package/dist/api/open-api/login.js

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils';
+// 帐号信息
+export const pluginLogin = temporarilyNotSupport('pluginLogin');
+export const login = temporarilyNotSupport('login');
+export const checkSession = temporarilyNotSupport('checkSession');

package/dist/api/open-api/red-package.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// 微信红包
+export const showRedPackage = temporarilyNotSupport('showRedPackage');

package/dist/api/open-api/settings.js

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils';
+// 设置
+export const openSetting = temporarilyNotSupport('openSetting');
+export const getSetting = temporarilyNotSupport('getSetting');

package/dist/api/open-api/soter.js

@@ -0,0 +1,5 @@
+import { temporarilyNotSupport } from '../utils';
+// 生物认证
+export const startSoterAuthentication = temporarilyNotSupport('startSoterAuthentication');
+export const checkIsSupportSoterAuthentication = temporarilyNotSupport('checkIsSupportSoterAuthentication');
+export const checkIsSoterEnrolledInDevice = temporarilyNotSupport('checkIsSoterEnrolledInDevice');

package/dist/api/open-api/subscribe-message.js

@@ -0,0 +1,3 @@
+import { temporarilyNotSupport } from '../utils';
+// 订阅消息
+export const requestSubscribeMessage = temporarilyNotSupport('requestSubscribeMessage');

package/dist/api/open-api/user-info.js

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils';
+// 用户信息
+export const getUserProfile = temporarilyNotSupport('getUserProfile');
+export const getUserInfo = temporarilyNotSupport('getUserInfo');

package/dist/api/open-api/werun.js

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils';
+// 微信运动
+export const shareToWeRun = temporarilyNotSupport('shareToWeRun');
+export const getWeRunData = temporarilyNotSupport('getWeRunData');

package/dist/api/payment/index.js

@@ -0,0 +1,4 @@
+import { temporarilyNotSupport } from '../utils';
+// 支付
+export const requestPayment = temporarilyNotSupport('requestPayment');
+export const requestOrderPayment = temporarilyNotSupport('requestOrderPayment');

package/dist/api/route/index.js

@@ -0,0 +1,3 @@
+// 路由
+export { switchTab, reLaunch, redirectTo, navigateTo, navigateBack } from '@tarojs/router';
+// FIXME 方法导出类型未对齐，后续修复

package/dist/api/share/index.js

@@ -0,0 +1,12 @@
+import { temporarilyNotSupport } from '../utils';
+// 转发
+export const updateShareMenu = temporarilyNotSupport('updateShareMenu');
+export const showShareMenu = temporarilyNotSupport('showShareMenu');
+export const showShareImageMenu = temporarilyNotSupport('showShareImageMenu');
+export const shareVideoMessage = temporarilyNotSupport('shareVideoMessage');
+export const shareFileMessage = temporarilyNotSupport('shareFileMessage');
+export const onCopyUrl = temporarilyNotSupport('onCopyUrl');
+export const offCopyUrl = temporarilyNotSupport('offCopyUrl');
+export const hideShareMenu = temporarilyNotSupport('hideShareMenu');
+export const getShareInfo = temporarilyNotSupport('getShareInfo');
+export const authPrivateMessage = temporarilyNotSupport('authPrivateMessage');

package/dist/api/storage/background-fetch.js

@@ -0,0 +1,6 @@
+import { temporarilyNotSupport } from '../utils';
+// 周期性更新
+export const setBackgroundFetchToken = temporarilyNotSupport('setBackgroundFetchToken');
+export const onBackgroundFetchData = temporarilyNotSupport('onBackgroundFetchData');
+export const getBackgroundFetchToken = temporarilyNotSupport('getBackgroundFetchToken');
+export const getBackgroundFetchData = temporarilyNotSupport('getBackgroundFetchData');