@tarojs/plugin-http 3.6.0-beta.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.MD

@@ -0,0 +1,59 @@
+# @tarojs/plugin-http
+
+`Taro` 运行时扩展插件， 扩展了 `web` 开发中网络请求相关的能力,让 `taro` 可以使用 [axios](https://github.com/axios/axios) 等网络请求封装库。
+
+> 本插件需搭配 taro 3.6.0 及其以上版本使用
+
+### XMLHttpRequest
+
+在小程序端模仿浏览器的 `XMLHttpRequest` 实现的对象，在浏览器环境中返回浏览器本身的 `XMLHttpRequest`。此对象通过 Webpack 的 [ProvidePlugin](https://webpack.js.org/plugins/provide-plugin/) 注入到全局对象以供第三方库调用。
+
+### document.cookie
+
+在小程序端通过本地存储模仿浏览器的 `document.cookie` 实现的对象，在浏览器环境中返回浏览器本身的 `document.cookie`。
+
+### 其他影响
+
+1.为了能正常使用 [axios](https://github.com/axios/axios) 库， 本插件会通过 Webpack 的 [ProvidePlugin](https://webpack.js.org/plugins/provide-plugin/)功能，在编译小程序时将全局的 `FormData`、 `Blob` 对象替换成 `undefined`，这样使用 `axios` 时不会有 `FormData is not defined` 这类异常，相应的代价是 `axios` 的上传文件的功能也将不可用， 考虑到小程序有自己的独特上传API，这是可以接受的。
+
+如果需要改变上述行为，可以通过传入选项 `disabledFormData` 、 `disabledBlob`：
+```js
+// config/index.js
+config = {
+  // ...
+  plugins: [
+    ['@tarojs/plugin-http', {
+        disabledFormData: false,
+        disabledBlob: false
+    }]
+  ],
+}
+```
+
+2.[axios](https://github.com/axios/axios) 中使用了`document.createElement("a")` 动态创建 `a` 标签设置 `href` 属性，然后读取 `protocol`、`host` 等属性来判断是否同源跨域；@tarojs/runtime 3.6.0 版本中支持了动态创建 `a` 标签， 并导出了一些公共函数，因此本插件需要配合 `taro 3.6.0及其以上版本` 使用  
+
+### 安装
+
+```
+npm i @tarojs/plugin-http
+```
+
+### 使用
+
+```js
+// config/index.js
+config = {
+  // ...
+  plugins: ['@tarojs/plugin-http'],
+}
+```
+
+插件提供了3个参数：
+
+
+| 参数名 | 默认值 | 说明 |
+| :--- | :--- | :--- |
+| enableCookie | false | (是否)注入相关代码，支持 `document.cookie` 、 通过后端返回 `Set-Cookie` 响应头来设置 `cookie`  |
+| disabledFormData | true | (是否)禁用掉 FormData 全局对象 |
+| disabledBlob | true | (是否)禁用掉 Blob 全局对象 |
+

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { IPluginContext } from '@tarojs/service';
+interface IOptions {
+    /** 支持 document.cookie 和 http 设置 cookie (默认false) */
+    enableCookie?: boolean;
+    /** 禁用掉 FormData 全局对象 (默认true禁用) */
+    disabledFormData?: boolean;
+    /** 禁用掉 Blob 全局对象 (默认true禁用) */
+    disabledBlob?: boolean;
+}
+declare const _default: (ctx: IPluginContext, options: IOptions) => void;
+export { _default as default };

package/dist/index.js

@@ -0,0 +1,45 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var shared = require('@tarojs/shared');
+var path = require('path');
+
+var name = "@tarojs/plugin-http";
+
+var index = (ctx, options) => {
+    if (!['h5', 'rn'].includes(ctx.runOpts.options.platform)) {
+        ctx.modifyWebpackChain(({ chain }) => {
+            chain.plugin('definePlugin').tap((args) => {
+                var _a;
+                args[0].ENABLE_COOKIE = (_a = options.enableCookie) !== null && _a !== void 0 ? _a : false;
+                return args;
+            });
+            const runtimeAlia = `${name}/dist/runtime`;
+            chain.resolve.alias.set(runtimeAlia, path.join(__dirname, 'runtime.js'));
+            // 注入相关全局BOM对象
+            chain.plugin('providerPlugin').tap((args) => {
+                var _a, _b;
+                var _c, _d;
+                args[0].XMLHttpRequest = [runtimeAlia, 'XMLHttpRequest'];
+                ((_a = options.disabledFormData) !== null && _a !== void 0 ? _a : true) && ((_c = args[0]).FormData || (_c.FormData = [runtimeAlia, 'FormData']));
+                ((_b = options.disabledBlob) !== null && _b !== void 0 ? _b : true) && ((_d = args[0]).Blob || (_d.Blob = [runtimeAlia, 'Blob']));
+                return args;
+            });
+        });
+        ctx.registerMethod({
+            name: 'onSetupClose',
+            fn(platform) {
+                const injectedPath = `post:${name}/dist/runtime`;
+                if (shared.isArray(platform.runtimePath)) {
+                    platform.runtimePath.push(injectedPath);
+                }
+                else if (shared.isString(platform.runtimePath)) {
+                    platform.runtimePath = [platform.runtimePath, injectedPath];
+                }
+            },
+        });
+    }
+};
+
+exports.default = index;

package/dist/runtime.d.ts

@@ -0,0 +1,94 @@
+import { document, Events } from '@tarojs/runtime';
+declare class Cookie {
+    #private;
+    constructor();
+    static parse(cookieStr: string): {
+        key: string;
+        value: string;
+        path: string | null;
+        domain: string | null;
+        expires: number | null;
+        maxAge: number | null;
+        secure: boolean;
+        httpOnly: boolean;
+    } | null;
+    /**
+     * 判断 domain
+     */
+    $_checkDomain(host: any, cookieDomain: any): boolean;
+    /**
+     * 判断 path
+     */
+    $_checkPath(path: any, cookiePath: any): boolean;
+    /**
+     * 判断过期
+     */
+    $_checkExpires(cookie: any): boolean;
+    /**
+     * 设置 cookie
+     */
+    setCookie(cookie: any, url: any): void;
+    /**
+     * 拉取 cookie
+     */
+    getCookie(url: string, includeHttpOnly?: boolean): string;
+    /**
+     * 序列化
+     */
+    serialize(): string;
+    /**
+     * 反序列化
+     */
+    deserialize(str: any): void;
+}
+// https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest
+declare class XMLHttpRequest extends Events {
+    #private;
+    static readonly UNSENT = 0;
+    static readonly OPENED = 1;
+    static readonly HEADERS_RECEIVED = 2;
+    static readonly LOADING = 3;
+    static readonly DONE = 4;
+    // 欺骗一些库让其认为是原生的xhr
+    static toString(): string;
+    toString(): string;
+    // 事件
+    /** 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时 */
+    onabort: (() => void) | null;
+    /** 当 request 遭遇错误时触发 */
+    onerror: ((err: any) => void) | null;
+    /** 接收到响应数据时触发 */
+    onloadstart: (() => void) | null;
+    /** 请求成功完成时触发 */
+    onload: (() => void) | null;
+    /** 当请求结束时触发，无论请求成功 ( load) 还是失败 (abort 或 error)。 */
+    onloadend: (() => void) | null;
+    /** 在预设时间内没有接收到响应时触发 */
+    ontimeout: (() => void) | null;
+    /** 当 readyState 属性发生变化时，调用的事件处理器 */
+    onreadystatechange: (() => void) | null;
+    constructor();
+    addEventListener(event: string, callback: (arg: any) => void): void;
+    removeEventListener(event: string, callback: (arg: any) => void): void;
+    /**
+     * 对外属性和方法
+     */
+    get timeout(): number;
+    set timeout(timeout: number);
+    get status(): number;
+    get statusText(): any;
+    get readyState(): number;
+    get responseType(): string;
+    set responseType(value: string);
+    get responseText(): null;
+    get response(): null;
+    get withCredentials(): boolean;
+    set withCredentials(value: boolean);
+    abort(): void;
+    getAllResponseHeaders(): string;
+    getResponseHeader(name: any): string | null;
+    open(method: any, url: any): void;
+    setRequestHeader(header: any, value: any): void;
+    send(data: any): void;
+}
+export { Cookie, document, XMLHttpRequest };