beer-network 1.3.2 → 1.4.1

package/api.d.ts

@@ -1,3 +1,4 @@
+import type { CacheManager } from './cache-manager';
 /**
  * Json 响应通用实体.
  */
@@ -24,12 +25,13 @@ export type Option = {
      * 中止信号量.
      */
     signal?: AbortSignal;
-    /**
-     * NextJS 缓存.
-     */
-    next?: {
-        revalidate: number;
-    };
+};
+type RequestHeader = Record<string, string>;
+type RequestParams = Record<string, string>;
+type PageTableData<T> = T[] | {
+    records?: T[];
+    currentPage?: number;
+    totalSize?: number;
 };
 export default class Fetch {
     /**
@@ -37,14 +39,12 @@ export default class Fetch {
      */
     private readonly pathPrefix;
     /**
-     * 是否是NodeJS 环境.
+     * 缓存管理器.
      */
-    private readonly isNode;
-    /**
-     * 是否支持 NextJs 框架.
-     */
-    private isNextJS;
+    private readonly cacheManager;
     constructor(pathPrefix?: string);
+    private appendUrlSearchParams;
+    private preprocessing;
     private sendBody;
     private sendForm;
     private sendFormData;
@@ -56,7 +56,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    post<T>(path: string, params?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    post<T>(path: string, params?: RequestParams, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送POST/JSON 请求.
      * @param path 路径.
@@ -65,7 +65,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    postBody<T>(path: string, params?: any, body?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    postBody<T>(path: string, params?: RequestParams, body?: unknown, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送POST/Form 请求.
      * @param path 路径.
@@ -74,7 +74,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    postForm<T>(path: string, params?: any, form?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    postForm<T>(path: string, params?: RequestParams, form?: RequestParams, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送POST/FormData 请求.
      * @param path 路径.
@@ -83,7 +83,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    postFormData<T>(path: string, params?: any, formData?: FormData, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    postFormData<T>(path: string, params?: RequestParams, formData?: FormData, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送PUT 请求.
      * @param path 路径.
@@ -91,7 +91,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    put<T>(path: string, params?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    put<T>(path: string, params?: RequestParams, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送PUT/JSON 请求.
      * @param path 路径.
@@ -100,7 +100,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    putBody<T>(path: string, params?: any, body?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    putBody<T>(path: string, params?: RequestParams, body?: unknown, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送PUT/Form 请求.
      * @param path 路径.
@@ -109,7 +109,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    putForm<T>(path: string, params?: any, form?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    putForm<T>(path: string, params?: RequestParams, form?: RequestParams, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送PUT/FormData 请求.
      * @param path 路径.
@@ -118,7 +118,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    putFormData<T>(path: string, params?: any, formData?: FormData, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    putFormData<T>(path: string, params?: RequestParams, formData?: FormData, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送DELETE 请求.
      * @param path 路径.
@@ -126,7 +126,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    delete<T>(path: string, params?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    delete<T>(path: string, params?: RequestParams, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送DELETE/JSON 请求.
      * @param path 路径.
@@ -135,7 +135,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    deleteBody<T>(path: string, params?: any, body?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    deleteBody<T>(path: string, params?: RequestParams, body?: unknown, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送DELETE/Form 请求.
      * @param path 路径.
@@ -144,7 +144,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    deleteForm<T>(path: string, params?: any, form?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    deleteForm<T>(path: string, params?: RequestParams, form?: RequestParams, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送DELETE/FormData 请求.
      * @param path 路径.
@@ -153,7 +153,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    deleteFormData<T>(path: string, params?: any, formData?: FormData, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    deleteFormData<T>(path: string, params?: RequestParams, formData?: FormData, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 发送Get 请求.
      * @param path 路径.
@@ -161,7 +161,7 @@ export default class Fetch {
      * @param header 头部.
      * @param option 选项.
      */
-    get<T>(path: string, params?: any, header?: any, option?: Option): Promise<JsonResponse<T>>;
+    get<T>(path: string, params?: RequestParams, header?: RequestHeader, option?: Option): Promise<JsonResponse<T>>;
     /**
      * 缓存.
      * @param key 缓存Key.
@@ -173,15 +173,15 @@ export default class Fetch {
     /**
      * 默认授权方式.
      */
-    authorization(): Promise<{}>;
+    authorization(): Promise<RequestHeader>;
     /**
-     * 尝试获取头.
+     * 获取缓存管理器.
      */
-    private tryAuthorization;
+    createCacheManager(): CacheManager | undefined;
     /**
      * 默认请求头.
      */
-    headers(): Promise<{}>;
+    headers(): Promise<Record<string, string>>;
     /**
      * 默认响应数据解析方式.
      * @param response 响应数据.
@@ -191,7 +191,25 @@ export default class Fetch {
      * 获取路径前缀.
      */
     getPathPrefix(): string;
-    pageParams(params: any): any;
-    pageTable<T>(response: JsonResponse<any>): Promise<Partial<RequestData<T>>>;
+    /**
+     * 分页参数.
+     * @param params 入参.
+     */
+    pageParams<T extends {
+        current?: unknown;
+    }>(params: T): T & {
+        currentPage: T['current'];
+        current: undefined;
+    };
+    /**
+     * 分页参数.
+     * @param response 响应.
+     */
+    pageTable<T>(response: JsonResponse<PageTableData<T>>): Promise<Partial<RequestData<T>>>;
+    /**
+     * 休眠.
+     * @param value 时间戳.
+     */
     sleep(value: number): Promise<unknown>;
 }
+export {};

package/api.js

@@ -1,117 +1,134 @@
 import Session from './session';
-import { getNodeHeaders } from './next-headers';
 export default class Fetch {
     /**
      * 请求地址.
      */
     pathPrefix;
     /**
-     * 是否是NodeJS 环境.
+     * 缓存管理器.
      */
-    isNode;
-    /**
-     * 是否支持 NextJs 框架.
-     */
-    isNextJS = undefined;
+    cacheManager;
     constructor(pathPrefix) {
         this.pathPrefix = pathPrefix || '';
-        this.isNode = typeof process !== 'undefined' && !!process.versions?.node;
+        this.cacheManager = this.createCacheManager();
     }
-    async sendBody(method, path, params, body, header, option) {
-        const paramQuery = new URLSearchParams();
-        Object.keys(params || {})
-            .forEach(key => {
-            paramQuery.append(key, params[key]);
+    appendUrlSearchParams(searchParams, params) {
+        Object.keys(params ?? {}).forEach(key => {
+            const value = params?.[key];
+            if (value === '') {
+                return;
+            }
+            searchParams.append(key, value ?? '');
         });
-        const response = await fetch(this.getPathPrefix() + path + (paramQuery.toString() === '' ? '' : '?') + paramQuery.toString(), {
+    }
+    async preprocessing(method, path, params, header, body) {
+        const requestHeader = header ?? {};
+        const paramQuery = new URLSearchParams();
+        this.appendUrlSearchParams(paramQuery, params);
+        const paramQueryString = paramQuery.toString();
+        const { cacheManager } = this;
+        if (cacheManager === undefined) {
+            return {
+                paramQueryString,
+                requestHeader,
+                cacheManager,
+                cacheResponse: undefined
+            };
+        }
+        const cacheResponse = (await cacheManager.get(method, path, paramQueryString, requestHeader, body)) ?? undefined;
+        return {
+            paramQueryString,
+            requestHeader,
+            cacheManager,
+            cacheResponse
+        };
+    }
+    async sendBody(method, path, params, body, header, option) {
+        const { paramQueryString, requestHeader, cacheManager, cacheResponse } = await this.preprocessing(method, path, params, header, body);
+        if (cacheResponse !== undefined) {
+            return cacheResponse;
+        }
+        const response = await fetch(this.getPathPrefix() + path + (paramQueryString === '' ? '' : '?') + paramQueryString, {
             method,
             headers: {
                 ...(await this.authorization()),
                 ...(await this.headers()),
-                ...(header || {}),
+                ...requestHeader,
                 'Content-Type': 'application/json'
             },
-            body: JSON.stringify(body || {}),
-            signal: option?.signal || null,
-            next: option?.next
+            body: JSON.stringify(body ?? {}),
+            signal: option?.signal ?? null
         });
-        return this.responseJson(response);
+        const result = await this.responseJson(response);
+        if (cacheManager !== undefined) {
+            await cacheManager.put(method, path, paramQueryString, requestHeader, body, result);
+        }
+        return result;
     }
     async sendForm(method, path, params, form, header, option) {
-        const paramQuery = new URLSearchParams();
-        Object.keys(params || {})
-            .forEach(key => {
-            paramQuery.append(key, params[key]);
-        });
-        const formData = new FormData();
-        const appendFormData = (data, parentKey = '') => {
-            for (const key of data) {
-                const currentKey = parentKey ? `${parentKey}[${key}]` : key;
-                if (typeof data[key] === 'object' && data[key] !== null) {
-                    appendFormData(data[key], currentKey);
-                }
-                else if (Array.isArray(data[key])) {
-                    data[key].forEach((item, index) => {
-                        const arrayKey = `${currentKey}[${index}]`;
-                        appendFormData({ [arrayKey]: item });
-                    });
-                }
-                else {
-                    formData.append(currentKey, data[key]);
-                }
-            }
-        };
-        appendFormData(form);
-        const response = await fetch(this.getPathPrefix() + path + (paramQuery.toString() === '' ? '' : '?') + paramQuery.toString(), {
+        const { paramQueryString, requestHeader, cacheManager, cacheResponse } = await this.preprocessing(method, path, params, header);
+        if (cacheResponse !== undefined) {
+            return cacheResponse;
+        }
+        const formParams = new URLSearchParams();
+        this.appendUrlSearchParams(formParams, form);
+        const response = await fetch(this.getPathPrefix() + path + (paramQueryString === '' ? '' : '?') + paramQueryString, {
             method,
             headers: {
                 ...(await this.authorization()),
                 ...(await this.headers()),
-                ...(header || {}),
+                ...requestHeader,
                 'Content-Type': 'application/x-www-form-urlencoded'
             },
-            body: formData,
-            signal: option?.signal || null,
-            next: option?.next
+            body: formParams,
+            signal: option?.signal ?? null
         });
-        return this.responseJson(response);
+        const result = await this.responseJson(response);
+        if (cacheManager !== undefined) {
+            await cacheManager.put(method, path, paramQueryString, requestHeader, undefined, result);
+        }
+        return result;
     }
     async sendFormData(method, path, params, formData, header, option) {
-        const paramQuery = new URLSearchParams();
-        Object.keys(params || {})
-            .forEach(key => {
-            paramQuery.append(key, params[key]);
-        });
-        const response = await fetch(this.getPathPrefix() + path + (paramQuery.toString() === '' ? '' : '?') + paramQuery.toString(), {
+        const { paramQueryString, requestHeader, cacheManager, cacheResponse } = await this.preprocessing(method, path, params, header);
+        if (cacheResponse !== undefined) {
+            return cacheResponse;
+        }
+        const response = await fetch(this.getPathPrefix() + path + (paramQueryString === '' ? '' : '?') + paramQueryString, {
             method,
             headers: {
                 ...(await this.authorization()),
                 ...(await this.headers()),
-                ...(header || {})
+                ...requestHeader
             },
             body: formData,
-            signal: option?.signal || null,
-            next: option?.next
+            signal: option?.signal ?? null
         });
-        return this.responseJson(response);
+        const result = await this.responseJson(response);
+        if (cacheManager !== undefined) {
+            await cacheManager.put(method, path, paramQueryString, requestHeader, undefined, result);
+        }
+        return result;
     }
     async send(method, path, params, header, option) {
-        const paramQuery = new URLSearchParams();
-        Object.keys(params || {})
-            .forEach(key => {
-            paramQuery.append(key, params[key]);
-        });
-        const response = await fetch(this.getPathPrefix() + path + '?' + paramQuery.toString(), {
+        const { paramQueryString, requestHeader, cacheManager, cacheResponse } = await this.preprocessing(method, path, params, header);
+        if (cacheResponse !== undefined) {
+            return cacheResponse;
+        }
+        const response = await fetch(this.getPathPrefix() + path + '?' + paramQueryString, {
             method,
             headers: {
                 ...(await this.authorization()),
                 ...(await this.headers()),
-                ...(header || {})
+                ...requestHeader
             },
-            signal: option?.signal || null,
-            next: option?.next
+            signal: option?.signal ?? null
         });
-        return this.responseJson(response);
+        const result = await this.responseJson(response);
+        if (cacheManager !== undefined) {
+            await cacheManager.put(method, path, paramQueryString, requestHeader, undefined, result);
+        }
+        return result;
     }
     /**
      * 发送POST 请求.
@@ -272,9 +289,10 @@ export default class Fetch {
             }
         }
         const response = await callback();
-        if (response.code === '0') {
-            response.expireTime = new Date().getTime() + 60000 * minute;
-            localStorage.setItem(cacheKey, JSON.stringify(response));
+        const cacheResponse = response;
+        if (cacheResponse.code === '0') {
+            cacheResponse.expireTime = new Date().getTime() + 60000 * minute;
+            localStorage.setItem(cacheKey, JSON.stringify(cacheResponse));
         }
         return response;
     }
@@ -282,14 +300,6 @@ export default class Fetch {
      * 默认授权方式.
      */
     async authorization() {
-        if (this.isNode) {
-            // 非浏览器
-            const bearer = await this.tryAuthorization();
-            if (bearer === undefined || bearer === '') {
-                return {};
-            }
-            return { Authorization: 'Bearer ' + bearer };
-        }
         // 浏览器
         const bearer = Session.getBearer();
         if (bearer === undefined || bearer === '') {
@@ -298,31 +308,10 @@ export default class Fetch {
         return { Authorization: 'Bearer ' + bearer };
     }
     /**
-     * 尝试获取头.
+     * 获取缓存管理器.
      */
-    async tryAuthorization(index = 0) {
-        if (index > 2) {
-            return undefined;
-        }
-        if (this.isNextJS === true) {
-            const nodeHeaders = await getNodeHeaders();
-            return nodeHeaders.get('x-access-token')
-                ?? nodeHeaders.get('access-token')
-                ?? nodeHeaders.get('authorization')
-                ?? nodeHeaders.get('AccessToken')
-                ?? nodeHeaders.get('Authorization')
-                ?? '';
-        }
-        if (this.isNextJS === undefined) {
-            try {
-                await getNodeHeaders();
-                this.isNextJS = true;
-            }
-            catch {
-                this.isNextJS = false;
-            }
-        }
-        return this.tryAuthorization(index + 1);
+    createCacheManager() {
+        return undefined;
     }
     /**
      * 默认请求头.
@@ -341,7 +330,7 @@ export default class Fetch {
         }
         const redirect = encodeURIComponent(window.location.href);
         if (result?.code === '401') {
-            const link = (window?.authLogin || '/auth/login') + '?redirect=' + redirect;
+            const link = (window.authLogin || '/auth/login') + '?redirect=' + redirect;
             setTimeout(() => window.location.replace(link), 500);
             return result;
         }
@@ -353,6 +342,10 @@ export default class Fetch {
     getPathPrefix() {
         return this.pathPrefix || '';
     }
+    /**
+     * 分页参数.
+     * @param params 入参.
+     */
     pageParams(params) {
         return {
             ...params,
@@ -360,12 +353,18 @@ export default class Fetch {
             current: undefined
         };
     }
+    /**
+     * 分页参数.
+     * @param response 响应.
+     */
     async pageTable(response) {
         if (response.success) {
+            const responseData = response.data;
+            const records = Array.isArray(responseData) ? responseData : responseData.records || [];
             return {
-                data: response.data.records || response.data,
-                page: response.data.currentPage || 1,
-                total: response.data.totalSize || response.data.length,
+                data: records,
+                page: Array.isArray(responseData) ? 1 : responseData.currentPage || 1,
+                total: Array.isArray(responseData) ? responseData.length : responseData.totalSize || records.length,
                 success: true
             };
         }
@@ -376,6 +375,10 @@ export default class Fetch {
             success: true
         };
     }
+    /**
+     * 休眠.
+     * @param value 时间戳.
+     */
     async sleep(value) {
         return new Promise((resolve) => {
             setTimeout(() => {

package/cache-manager.d.ts

@@ -0,0 +1,23 @@
+import type { JsonResponse } from './api';
+export interface CacheManager {
+    /**
+     * 读取缓存.
+     * @param method 方法.
+     * @param path 路径.
+     * @param params 参数.
+     * @param header 头部参数.
+     * @param body 请求体.
+     * @returns 缓存数据.
+     */
+    get<T>(method: string, path: string, params: string, header: Record<string, string>, body?: unknown): Promise<JsonResponse<T>>;
+    /**
+     * 写入缓存.
+     * @param method 方法.
+     * @param path 路径.
+     * @param params 参数.
+     * @param header 头部参数.
+     * @param body 请求体.
+     * @param data 缓存数据.
+     */
+    put<T>(method: string, path: string, params: string, header: Record<string, string>, body: unknown, data: JsonResponse<T>): Promise<JsonResponse<T>>;
+}

package/cache-manager.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "beer-network",
   "private": false,
-  "version": "1.3.2",
+  "version": "1.4.1",
   "scripts": {
     "pub-w": "tsc && copy package.json .\\dist\\package.json && npm publish ./dist",
     "pub-m": "tsc && cp package.json ./dist/package.json && npm publish ./dist"

package/next-headers.d.ts

@@ -1,13 +0,0 @@
-type HeadersLike = {
-    get(name: string): string | null;
-};
-type CookiesLike = {
-    get(name: string): {
-        value: string;
-    } | undefined;
-    getAll?: () => Array<any>;
-    has?: (name: string) => boolean;
-};
-export declare function getNodeHeaders(): Promise<HeadersLike>;
-export declare function getNodeCookies(): CookiesLike;
-export {};

package/next-headers.js

@@ -1,45 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable no-eval */
-function loadNextHeadersModule() {
-    try {
-        const req = eval('require');
-        return req('next/headers');
-    }
-    catch {
-        return null;
-    }
-}
-function emptyHeaders() {
-    return {
-        get() {
-            return null;
-        }
-    };
-}
-function emptyCookies() {
-    return {
-        get() {
-            return undefined;
-        },
-        getAll() {
-            return [];
-        },
-        has() {
-            return false;
-        }
-    };
-}
-export async function getNodeHeaders() {
-    const mod = loadNextHeadersModule();
-    if (mod?.headers) {
-        return mod.headers();
-    }
-    return emptyHeaders();
-}
-export function getNodeCookies() {
-    const mod = loadNextHeadersModule();
-    if (mod?.cookies) {
-        return mod.cookies();
-    }
-    return emptyCookies();
-}