@tarojs/plugin-http 3.6.6 → 3.6.7-alpha.0

package/dist/runtime.d.ts

@@ -1,4 +1,4 @@
-import { document, Events } from '@tarojs/runtime';
+import { document, Events, TaroEvent } from '@tarojs/runtime';
 declare class Cookie {
     #private;
     constructor();
@@ -41,6 +41,12 @@ declare class Cookie {
      */
     deserialize(str: any): void;
 }
+interface XMLHttpRequestEvent extends TaroEvent {
+    target: XMLHttpRequest;
+    currentTarget: XMLHttpRequest;
+    loaded: number;
+    total: number;
+}
 // https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest
 declare class XMLHttpRequest extends Events {
     #private;
@@ -54,19 +60,19 @@ declare class XMLHttpRequest extends Events {
     toString(): string;
     // 事件
     /** 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时 */
-    onabort: (() => void) | null;
+    onabort: ((e: XMLHttpRequestEvent) => void) | null;
     /** 当 request 遭遇错误时触发 */
-    onerror: ((err: any) => void) | null;
+    onerror: ((e: XMLHttpRequestEvent) => void) | null;
     /** 接收到响应数据时触发 */
-    onloadstart: (() => void) | null;
+    onloadstart: ((e: XMLHttpRequestEvent) => void) | null;
     /** 请求成功完成时触发 */
-    onload: (() => void) | null;
+    onload: ((e: XMLHttpRequestEvent) => void) | null;
     /** 当请求结束时触发，无论请求成功 ( load) 还是失败 (abort 或 error)。 */
-    onloadend: (() => void) | null;
+    onloadend: ((e: XMLHttpRequestEvent) => void) | null;
     /** 在预设时间内没有接收到响应时触发 */
-    ontimeout: (() => void) | null;
+    ontimeout: ((e: XMLHttpRequestEvent) => void) | null;
     /** 当 readyState 属性发生变化时，调用的事件处理器 */
-    onreadystatechange: (() => void) | null;
+    onreadystatechange: ((e: XMLHttpRequestEvent) => void) | null;
     constructor();
     addEventListener(event: string, callback: (arg: any) => void): void;
     removeEventListener(event: string, callback: (arg: any) => void): void;
@@ -91,4 +97,4 @@ declare class XMLHttpRequest extends Events {
     setRequestHeader(header: any, value: any): void;
     send(data: any): void;
 }
-export { Cookie, document, XMLHttpRequest };
+export { Cookie, document, XMLHttpRequest, XMLHttpRequestEvent };

package/dist/runtime.js

@@ -1,4 +1,4 @@
-import { parseUrl, Events, window, document } from '@tarojs/runtime';
+import { parseUrl, Events, createEvent, window, document } from '@tarojs/runtime';
 export { document } from '@tarojs/runtime';
 import { isString, isFunction, isWebPlatform } from '@tarojs/shared';
 import { setStorage, getStorageSync, request } from '@tarojs/taro';
@@ -351,6 +351,34 @@ const STATUS_TEXT_MAP = {
     504: 'Gateway Timeout',
     505: 'HTTP Version Not Supported',
 };
+function createXMLHttpRequestEvent(event, target, loaded) {
+    const e = createEvent(event);
+    try {
+        Object.defineProperties(e, {
+            'currentTarget': {
+                enumerable: true,
+                value: target
+            },
+            'target': {
+                enumerable: true,
+                value: target
+            },
+            'loaded': {
+                enumerable: true,
+                value: loaded || 0
+            },
+            // 读 Content-Range 字段，目前来说作用不大,先和 loaded 保持一致
+            'total': {
+                enumerable: true,
+                value: loaded || 0
+            }
+        });
+    }
+    catch (err) {
+        // no handler
+    }
+    return e;
+}
 // https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest
 class XMLHttpRequest extends Events {
     // 欺骗一些库让其认为是原生的xhr
@@ -466,8 +494,9 @@ class XMLHttpRequest extends Events {
     abort() {
         if (__classPrivateFieldGet(this, _XMLHttpRequest_requestTask, "f")) {
             __classPrivateFieldGet(this, _XMLHttpRequest_requestTask, "f").abort();
-            this.trigger('abort');
-            isFunction(this.onabort) && this.onabort();
+            const abortEvent = createXMLHttpRequestEvent('abort', this, 0);
+            this.trigger('abort', abortEvent);
+            isFunction(this.onabort) && this.onabort(abortEvent);
         }
     }
     getAllResponseHeaders() {
@@ -512,8 +541,9 @@ _XMLHttpRequest_method = new WeakMap(), _XMLHttpRequest_url = new WeakMap(), _XM
     const hasChange = readyState !== __classPrivateFieldGet(this, _XMLHttpRequest_readyState, "f");
     __classPrivateFieldSet(this, _XMLHttpRequest_readyState, readyState, "f");
     if (hasChange) {
-        this.trigger('readystatechange');
-        isFunction(this.onreadystatechange) && this.onreadystatechange();
+        const readystatechangeEvent = createXMLHttpRequestEvent('readystatechange', this, 0);
+        this.trigger('readystatechange', readystatechangeEvent);
+        isFunction(this.onreadystatechange) && this.onreadystatechange(readystatechangeEvent);
     }
 }, _XMLHttpRequest_callRequest = function _XMLHttpRequest_callRequest() {
     if (!window || !window.document) {
@@ -527,8 +557,9 @@ _XMLHttpRequest_method = new WeakMap(), _XMLHttpRequest_url = new WeakMap(), _XM
                 if (__classPrivateFieldGet(this, _XMLHttpRequest_requestTask, "f"))
                     __classPrivateFieldGet(this, _XMLHttpRequest_requestTask, "f").abort();
                 __classPrivateFieldGet(this, _XMLHttpRequest_instances, "m", _XMLHttpRequest_callReadyStateChange).call(this, XMLHttpRequest.DONE);
-                this.trigger('timeout');
-                isFunction(this.ontimeout) && this.ontimeout();
+                const timeoutEvent = createXMLHttpRequestEvent('timeout', this, 0);
+                this.trigger('timeout', timeoutEvent);
+                isFunction(this.ontimeout) && this.ontimeout(timeoutEvent);
             }
         }, __classPrivateFieldGet(this, _XMLHttpRequest_timeout, "f"));
     }
@@ -600,23 +631,27 @@ _XMLHttpRequest_method = new WeakMap(), _XMLHttpRequest_url = new WeakMap(), _XM
     // 处理返回数据
     if (data) {
         __classPrivateFieldGet(this, _XMLHttpRequest_instances, "m", _XMLHttpRequest_callReadyStateChange).call(this, XMLHttpRequest.LOADING);
-        this.trigger('loadstart');
-        isFunction(this.onloadstart) && this.onloadstart();
+        const loadstartEvent = createXMLHttpRequestEvent('loadstart', this, header['Content-Length']);
+        this.trigger('loadstart', loadstartEvent);
+        isFunction(this.onloadstart) && this.onloadstart(loadstartEvent);
         __classPrivateFieldSet(this, _XMLHttpRequest_response, data, "f");
-        this.trigger('load');
-        isFunction(this.onload) && this.onload();
+        const loadEvent = createXMLHttpRequestEvent('load', this, header['Content-Length']);
+        this.trigger('load', loadEvent);
+        isFunction(this.onload) && this.onload(loadEvent);
     }
 }, _XMLHttpRequest_requestFail = function _XMLHttpRequest_requestFail(err) {
     __classPrivateFieldSet(this, _XMLHttpRequest_status, 0, "f");
     __classPrivateFieldSet(this, _XMLHttpRequest_statusText, err.errMsg, "f");
-    this.trigger('error');
-    isFunction(this.onerror) && this.onerror(err);
+    const errorEvent = createXMLHttpRequestEvent('error', this, 0);
+    this.trigger('error', errorEvent);
+    isFunction(this.onerror) && this.onerror(errorEvent);
 }, _XMLHttpRequest_requestComplete = function _XMLHttpRequest_requestComplete() {
     __classPrivateFieldSet(this, _XMLHttpRequest_requestTask, null, "f");
     __classPrivateFieldGet(this, _XMLHttpRequest_instances, "m", _XMLHttpRequest_callReadyStateChange).call(this, XMLHttpRequest.DONE);
     if (__classPrivateFieldGet(this, _XMLHttpRequest_status, "f")) {
-        this.trigger('loadend');
-        isFunction(this.onloadend) && this.onloadend();
+        const loadendEvent = createXMLHttpRequestEvent('loadend', this, __classPrivateFieldGet(this, _XMLHttpRequest_header, "f")['Content-Length']);
+        this.trigger('loadend', loadendEvent);
+        isFunction(this.onloadend) && this.onloadend(loadendEvent);
     }
 };
 XMLHttpRequest.UNSENT = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/plugin-http",
-  "version": "3.6.6",
+  "version": "3.6.7-alpha.0",
   "description": "Taro 小程序端支持使用 web 请求 的插件",
   "main": "index.js",
   "files": [
@@ -23,9 +23,9 @@
   },
   "homepage": "https://github.com/NervJS/taro#readme",
   "dependencies": {
-    "@tarojs/runtime": "3.6.6",
-    "@tarojs/service": "3.6.6",
-    "@tarojs/shared": "3.6.6"
+    "@tarojs/runtime": "3.6.7-alpha.0",
+    "@tarojs/service": "3.6.7-alpha.0",
+    "@tarojs/shared": "3.6.7-alpha.0"
   },
   "devDependencies": {
     "@rollup/plugin-json": "^4.1.0",

package/src/runtime/XMLHttpRequest.ts

@@ -1,4 +1,4 @@
-import { Events, parseUrl, window } from '@tarojs/runtime'
+import { createEvent, Events, parseUrl, TaroEvent, window } from '@tarojs/runtime'
 import { isFunction, isString } from '@tarojs/shared'
 import { request } from '@tarojs/taro'
 
@@ -51,6 +51,42 @@ const STATUS_TEXT_MAP = {
   504: 'Gateway Timeout',
   505: 'HTTP Version Not Supported',
 }
+
+export interface XMLHttpRequestEvent extends TaroEvent {
+  target: XMLHttpRequest
+  currentTarget: XMLHttpRequest
+  loaded: number
+  total: number
+}
+
+function createXMLHttpRequestEvent (event: string, target:XMLHttpRequest, loaded: number): XMLHttpRequestEvent {
+  const e = createEvent(event) as XMLHttpRequestEvent
+  try {
+    Object.defineProperties(e, {
+      'currentTarget': {
+        enumerable: true,
+        value: target
+      },
+      'target': {
+        enumerable: true,
+        value: target
+      },
+      'loaded': {
+        enumerable: true,
+        value: loaded || 0
+      },
+      // 读 Content-Range 字段，目前来说作用不大,先和 loaded 保持一致
+      'total': {
+        enumerable: true,
+        value: loaded || 0
+      }
+    })
+  } catch (err) {
+    // no handler
+  } 
+  return e
+}
+
 // https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest
 export class XMLHttpRequest extends Events {
   static readonly UNSENT = 0
@@ -85,25 +121,25 @@ export class XMLHttpRequest extends Events {
   // 事件
 
   /** 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时 */
-  onabort: (() => void) | null = null
+  onabort: ((e: XMLHttpRequestEvent) => void) | null = null
 
   /** 当 request 遭遇错误时触发 */
-  onerror: ((err: any) => void) | null = null
+  onerror: ((e: XMLHttpRequestEvent) => void) | null = null
 
   /** 接收到响应数据时触发 */
-  onloadstart: (() => void) | null = null
+  onloadstart: ((e: XMLHttpRequestEvent) => void) | null = null
 
   /** 请求成功完成时触发 */
-  onload: (() => void) | null = null
+  onload: ((e: XMLHttpRequestEvent) => void) | null = null
 
   /** 当请求结束时触发，无论请求成功 ( load) 还是失败 (abort 或 error)。 */
-  onloadend: (() => void) | null = null
+  onloadend: ((e: XMLHttpRequestEvent) => void) | null = null
 
   /** 在预设时间内没有接收到响应时触发 */
-  ontimeout: (() => void) | null = null
+  ontimeout: ((e: XMLHttpRequestEvent) => void) | null = null
 
   /** 当 readyState 属性发生变化时，调用的事件处理器 */
-  onreadystatechange: (() => void) | null = null
+  onreadystatechange: ((e: XMLHttpRequestEvent) => void) | null = null
 
   constructor () {
     super()
@@ -145,8 +181,9 @@ export class XMLHttpRequest extends Events {
     this.#readyState = readyState
 
     if (hasChange) {
-      this.trigger('readystatechange')
-      isFunction(this.onreadystatechange) && this.onreadystatechange()
+      const readystatechangeEvent = createXMLHttpRequestEvent('readystatechange', this, 0)
+      this.trigger('readystatechange', readystatechangeEvent)
+      isFunction(this.onreadystatechange) && this.onreadystatechange(readystatechangeEvent)
     }
   }
 
@@ -165,8 +202,9 @@ export class XMLHttpRequest extends Events {
           // 超时
           if (this.#requestTask) this.#requestTask.abort()
           this.#callReadyStateChange(XMLHttpRequest.DONE)
-          this.trigger('timeout')
-          isFunction(this.ontimeout) && this.ontimeout()
+          const timeoutEvent = createXMLHttpRequestEvent('timeout', this, 0)
+          this.trigger('timeout', timeoutEvent)
+          isFunction(this.ontimeout) && this.ontimeout(timeoutEvent)
         }
       }, this.#timeout)
     }
@@ -255,11 +293,14 @@ export class XMLHttpRequest extends Events {
     // 处理返回数据
     if (data) {
       this.#callReadyStateChange(XMLHttpRequest.LOADING)
-      this.trigger('loadstart')
-      isFunction(this.onloadstart) && this.onloadstart()
+      const loadstartEvent = createXMLHttpRequestEvent('loadstart', this, header['Content-Length'])
+      this.trigger('loadstart', loadstartEvent)
+      isFunction(this.onloadstart) && this.onloadstart(loadstartEvent)
       this.#response = data
-      this.trigger('load')
-      isFunction(this.onload) && this.onload()
+
+      const loadEvent = createXMLHttpRequestEvent('load', this, header['Content-Length'])
+      this.trigger('load', loadEvent)
+      isFunction(this.onload) && this.onload(loadEvent)
     }
   }
 
@@ -269,8 +310,9 @@ export class XMLHttpRequest extends Events {
   #requestFail (err) {
     this.#status = 0
     this.#statusText = err.errMsg
-    this.trigger('error')
-    isFunction(this.onerror) && this.onerror(err)
+    const errorEvent = createXMLHttpRequestEvent('error', this, 0)
+    this.trigger('error', errorEvent)
+    isFunction(this.onerror) && this.onerror(errorEvent)
   }
 
   /**
@@ -281,8 +323,9 @@ export class XMLHttpRequest extends Events {
     this.#callReadyStateChange(XMLHttpRequest.DONE)
 
     if (this.#status) {
-      this.trigger('loadend')
-      isFunction(this.onloadend) && this.onloadend()
+      const loadendEvent = createXMLHttpRequestEvent('loadend', this, this.#header['Content-Length'])
+      this.trigger('loadend', loadendEvent)
+      isFunction(this.onloadend) && this.onloadend(loadendEvent)
     }
   }
 
@@ -346,8 +389,9 @@ export class XMLHttpRequest extends Events {
   abort () {
     if (this.#requestTask) {
       this.#requestTask.abort()
-      this.trigger('abort')
-      isFunction(this.onabort) && this.onabort()
+      const abortEvent = createXMLHttpRequestEvent('abort', this, 0)
+      this.trigger('abort', abortEvent)
+      isFunction(this.onabort) && this.onabort(abortEvent)
     }
   }
 

package/src/runtime/index.ts

@@ -2,7 +2,7 @@ import { document, window } from '@tarojs/runtime'
 import { isWebPlatform } from '@tarojs/shared'
 
 import { Cookie, createCookieInstance } from './Cookie'
-import { XMLHttpRequest } from './XMLHttpRequest'
+import { type XMLHttpRequestEvent, XMLHttpRequest } from './XMLHttpRequest'
 
 declare const ENABLE_COOKIE: boolean
 
@@ -32,4 +32,4 @@ if (!isWebPlatform()) {
   window.XMLHttpRequest = XMLHttpRequest
 }
 
-export { Cookie, document, XMLHttpRequest }
+export { Cookie, document, XMLHttpRequest, XMLHttpRequestEvent }