@codady/utils 0.0.38 → 0.0.39

package/src/ajax.js

@@ -0,0 +1,363 @@
+/**
+ * @since Last modified: 2026/01/20 16:38:21
+ * Sends an asynchronous HTTP request (AJAX).
+ * @function ajax
+ * @param {AjaxOptions} options - Configuration for the request.
+ * @returns {Promise<AjaxResponse>} Returns a promise that resolves with the response context.
+ * @example
+ * ajax({ url: '/api/data', method: 'GET' }).then(res => console.log(res.content));
+ */
+'use strict';
+import isEmpty from './isEmpty';
+import getDataType from './getDataType';
+import getBodyHTML from './getBodyHTML';
+import getUrlHash from './getUrlHash';
+import capitalize from './capitalize';
+import buildUrl from './buildUrl';
+import cleanQueryString from './cleanQueryString';
+const ajax = (options) => {
+    // Validation
+    if (isEmpty(options)) {
+        return Promise.reject(new Error('Options are required'));
+    }
+    if (!options.url || typeof options.url !== 'string') {
+        return Promise.reject(new Error('URL is required and must be a string'));
+    }
+    // Default configuration
+    const config = {
+        url: '',
+        method: 'POST',
+        async: true,
+        selector: '',
+        data: null,
+        timeout: 3600000,
+        headers: {},
+        responseType: '',
+        catchError: false,
+        signal: null,
+        xhrFields: {},
+        cacheBustKey: '_t',
+        //
+        onAbort: null,
+        onTimeout: null,
+        //
+        onBeforeSend: null,
+        //
+        onCreated: null,
+        onOpened: null,
+        onHeadersReceived: null,
+        onLoading: null,
+        //
+        onSuccess: null,
+        onFailure: null,
+        onInformation: null,
+        onRedirection: null,
+        onClientError: null,
+        onServerError: null,
+        onUnknownError: null,
+        onError: null,
+        onFinish: null,
+        //
+        onDownload: null,
+        onUpload: null,
+        onComplete: null,
+    };
+    //合并参数
+    Object.assign(config, options);
+    //
+    const method = config.method.toUpperCase() || 'POST', methodsWithoutBody = ['GET', 'HEAD', 'TRACE'];
+    //创建XMLHttpRequest
+    let xhr = new XMLHttpRequest(), 
+    //设置发送数据和预设请求头
+    requestData = null, headerContentType = config?.headers?.['Content-Type'] || config?.headers?.['content-type'], removeHeader = () => {
+        if (headerContentType) {
+            delete config.headers['Content-Type'];
+            delete config.headers['content-type'];
+        }
+    };
+    if (!isEmpty(config.data)) {
+        let dataType = getDataType(config.data);
+        if (dataType === 'FormData') {
+            //如果是new FormData格式，直接相等
+            requestData = config.data;
+            // 不需要手动设置Content-Type，浏览器会自动设置
+            //config.contType = 'multipart/form-data';
+            removeHeader();
+        }
+        else if (dataType === 'Object') {
+            //如果是对象格式{name:'',age:''}
+            //并且此时已经设置了contType
+            if (!headerContentType) {
+                //如果未设置则默认设为如下contType
+                //Content-Type=application/x-www-form-urlencoded
+                /* for (let k in config.data) {
+                    requestData += '&' + k + '=' + config.data[k];
+                } */
+                requestData = new URLSearchParams(config.data).toString();
+                //URLSearchParams.toString => `a=1&b=3`
+                //非get、head方法修正content-type
+                if (!methodsWithoutBody.includes(method)) {
+                    config.headers['Content-Type'] = 'application/x-www-form-urlencoded';
+                }
+            }
+            else if (headerContentType?.includes('application/json')) {
+                //Content-Type=application/json或contentType=application/json
+                requestData = JSON.stringify(config.data);
+            }
+            else {
+                requestData = config.data;
+            }
+        }
+        else if (dataType === 'String') {
+            //未设置或，已经设置了Content-Type=application/x-www-form-urlencoded
+            if (!headerContentType || headerContentType.includes('urlencoded')) {
+                //如果是name=''&age=''字符串
+                //?name=''&age=''或&name=''&age=''统一去掉第一个&/?
+                requestData = cleanQueryString(config.data.trim());
+                //非get、head方法修正content-type
+                if (!methodsWithoutBody.includes(method) && !headerContentType) {
+                    config.headers['Content-Type'] = 'application/x-www-form-urlencoded';
+                }
+            }
+            else {
+                requestData = config.data;
+            }
+        }
+        else {
+            requestData = config.data;
+        }
+    }
+    //设置超时时间
+    xhr.timeout = config.timeout;
+    // 响应类型
+    if (config.responseType) {
+        xhr.responseType = config.responseType;
+    }
+    //返回promise
+    const result = new Promise((resolve, reject) => {
+        //超时监听
+        const timeoutHandler = () => {
+            cleanup();
+            let resp = { ...context, status: xhr.status, content: xhr.response, type: 'timeout' };
+            //回调，status和content在此确认
+            config?.onTimeout?.(resp);
+            //reject只能接受一个参数
+            config.catchError ? reject(resp) : resolve(resp);
+        }, 
+        //报错监听
+        errorHandler = (resp) => {
+            //这几个错误来自xhr.onreadystatechange
+            if (resp.type === 'client-error') {
+                config?.onClientError?.({ ...context });
+            }
+            else if (resp.type === 'server-error') {
+                config?.onServerError?.({ ...context });
+            }
+            else if (resp.type === 'unknown-error') {
+                config?.onUnknownError?.({ ...context });
+            }
+            //此外还会有xhr.onerror的错误，所以需要统一使用onError监听
+            config?.onError?.(resp);
+            //reject只能接受一个参数
+            config.catchError ? reject(resp) : resolve(resp);
+        }, 
+        //取消监听
+        abortHandler = () => {
+            cleanup();
+            const resp = { ...context, status: xhr.status, type: 'abort' };
+            config.catchError ? reject(resp) : resolve(resp);
+            //回调，status和content在此确认
+            config?.onAbort?.(resp);
+        }, abortHandlerWithSignal = () => {
+            //先中止请求，防止触发其他 readystate 事件
+            xhr.abort();
+            abortHandler();
+        }, 
+        //成功监听
+        successHandler = (resp) => {
+            //成功回调
+            config?.onSuccess?.(resp);
+            //resolve只能接受一个参数
+            resolve(resp);
+        }, 
+        //统一处理abort
+        cleanup = () => {
+            // 如果使用了AbortSignal，则移除它的事件监听器
+            config.signal && config.signal.removeEventListener('abort', abortHandlerWithSignal);
+            // 移除各类事件监听器
+            config.onError && xhr.removeEventListener('error', errorHandler);
+            config.onTimeout && xhr.removeEventListener('timeout', timeoutHandler);
+            // 解绑上传/下载进度事件
+            config.onUpload && xhr.upload.removeEventListener('progress', uploadProgressHandler);
+            config.onDownload && xhr.removeEventListener('progress', downloadProgressHandler);
+            //销毁
+            xhr.onreadystatechange = null;
+        }, 
+        // Context object to track state
+        context = {
+            //原始xhr
+            xhr,
+            //发送的数据
+            data: requestData,
+            //可取消的函数
+            abort: abortHandler,
+            //xhr.status
+            status: '',
+            //响应的内容
+            content: null,
+            //0~4阶段编号
+            stage: 0,
+            //阶段名称
+            type: 'unset',
+            //上传和下载进度
+            progress: {}
+        }, 
+        //定义进度函数
+        progressHandler = (name, data, callback) => {
+            if (data.lengthComputable) {
+                const resp = { ...context, status: xhr.status }, ratio = data.loaded / data.total;
+                resp.progress = {
+                    name,
+                    loaded: data.loaded,
+                    total: data.total,
+                    timestamp: (new Date(data.timeStamp)).getTime(),
+                    ratio,
+                    percent: Math.round(ratio * 100),
+                };
+                callback?.(resp);
+                //到达100%执行complete
+                if (resp.progress.percent >= 100) {
+                    resp.progress.percent = 100;
+                    config?.onComplete?.(resp);
+                }
+            }
+        }, uploadProgressHandler = (data) => {
+            progressHandler('upload', data, (resp) => config.onUpload(resp));
+        }, downloadProgressHandler = (data) => {
+            progressHandler('download', data, (resp) => config.onDownload(resp));
+        };
+        //使用AbortSignal
+        if (config.signal) {
+            if (config.signal.aborted)
+                return abortHandlerWithSignal();
+            config.signal.addEventListener('abort', abortHandlerWithSignal);
+        }
+        //监听上传进度
+        config.onUpload && xhr.upload.addEventListener('progress', uploadProgressHandler);
+        //监听下载进度
+        config.onDownload && xhr.addEventListener('progress', downloadProgressHandler);
+        // 事件监听器
+        config.onError && xhr.addEventListener('error', errorHandler);
+        config.onTimeout && xhr.addEventListener('timeout', timeoutHandler);
+        config.onAbort && xhr.addEventListener('abort', abortHandler);
+        // 手动触发 Created 状态
+        config.onCreated?.({ ...context, type: 'created' });
+        //状态判断
+        xhr.onreadystatechange = function () {
+            context.stage = xhr.readyState;
+            context.status = xhr.status;
+            const statusMap = { 1: 'opened', 2: 'headersReceived', 3: 'loading' };
+            //0=created放在外侧确保能触发，如果放在.onreadystatechange可能触发不了
+            if (xhr.readyState < 4) {
+                if (!xhr.readyState)
+                    return;
+                context.type = statusMap[xhr.readyState];
+                config[`on${capitalize(context.type)}`]?.({ ...context });
+                return;
+            }
+            //已经请求成功，不会有timeout事件，也不需要abort了，所以移除abort事件
+            cleanup();
+            const isInformation = xhr.status >= 100 && xhr.status < 200, isSuccess = (xhr.status >= 200 && xhr.status < 300) || xhr.status === 304, isRedirection = xhr.status >= 300 && xhr.status < 400, isClientError = xhr.status >= 400 && xhr.status < 500, isServerError = xhr.status >= 500 && xhr.status < 600;
+            //已经获得返回数据
+            if (isSuccess) {
+                if (!config.responseType || xhr.responseType === 'text') {
+                    //可能返回字符串类型的对象，wordpress的REST API
+                    let trim = xhr.responseText.trim(), content = '';
+                    if ((trim.startsWith('[') && trim.endsWith(']')) || (trim.startsWith('{') && trim.endsWith('}'))) {
+                        //通过判断开头字符是{或[来确定异步页面是否是JSON内容，如果是则转成JSON对象
+                        try {
+                            content = JSON.parse(trim);
+                        }
+                        catch {
+                            console.warn('Malformed JSON detected, falling back to text.');
+                            content = xhr.responseText;
+                        }
+                    }
+                    else if (/(<\/html>|<\/body>)/i.test(trim)) {
+                        //请求了一个HTML页面
+                        //返回文本类型DOMstring
+                        let urlHash = getUrlHash(config.url);
+                        content = getBodyHTML(trim, config.selector || urlHash);
+                    }
+                    else {
+                        //普通文本，不做任何处理
+                        content = xhr.responseText;
+                    }
+                    //content=文本字符串/json
+                    context.content = content;
+                }
+                else {
+                    //content=json、blob、document、arraybuffer等类型，如果知道服务器返回的XML， xhr.responseType应该为document
+                    context.content = xhr.response;
+                }
+                context.type = 'success';
+                successHandler({ ...context });
+            }
+            else {
+                //失败回调
+                context.content = xhr.response;
+                context.type = isInformation ? 'infomation' : isRedirection ? 'redirection' : isClientError ? 'client-error' : isServerError ? 'server-error' : 'unknown-error';
+                //
+                if (isInformation) {
+                    config?.onInformation?.({ ...context });
+                }
+                else if (isRedirection) {
+                    config?.onRedirection?.({ ...context });
+                }
+                else {
+                    errorHandler({ ...context });
+                }
+                //
+                config?.onFailure?.({ ...context });
+            }
+            config?.onFinish?.({ ...context });
+        };
+        //发送异步请求
+        let openParams = [method, config.url, config.async];
+        if (methodsWithoutBody.includes(method)) {
+            // 拼接url => xxx.com?a=0&b=1#hello
+            const url = buildUrl({
+                url: config.url,
+                data: requestData,
+                cacheBustKey: config.cacheBustKey,
+                appendCacheBust: true,
+            });
+            openParams = [method, url, config.async];
+        }
+        //设置xhr其他字段
+        for (let k in config.xhrFields) {
+            config.xhrFields.hasOwnProperty(k) && (xhr[k] = config.xhrFields[k]);
+        }
+        //与服务器建立连接
+        xhr.open(...openParams);
+        //有则设置，仅跳过空内容
+        for (let k in config.headers) {
+            config.headers.hasOwnProperty(k) && !isEmpty(config.headers[k]) && xhr.setRequestHeader(k, config.headers[k]);
+        }
+        config?.onBeforeSend?.(({ ...context, status: xhr.status, type: 'beforeSend' }));
+        //发送请求，get和head不需要发送数据
+        xhr.send(methodsWithoutBody.includes(method) ? null : (requestData || null));
+        //open和send阶段已经是异步了，无法使用try+catch捕获错误
+    });
+    //绑定xhr和abort
+    result.xhr = xhr;
+    result.abort = () => xhr.abort();
+    return result;
+};
+// Static Helper Methods
+//get、head、trace是不需要发送数据的，data将被转为url参数处理
+['post', 'put', 'delete', 'patch', 'options', 'get', 'head', 'trace'].forEach(method => {
+    ajax[method] = (url, data, options = { url: '' }) => ajax({ ...options, method, url, data });
+});
+ajax.all = (requests) => Promise.all(requests.map(ajax));
+export default ajax;