@clownlee/http 1.0.1

package/README.md

@@ -0,0 +1,81 @@
+# @fly/request
+
+Axios 公共通用库，提供统一的 HTTP 请求能力和自动 token 刷新功能。
+
+## 功能特性
+
+- ✅ TypeScript 支持
+- ✅ baseUrl、headers 等配置封装
+- ✅ 请求拦截器和响应拦截器
+- ✅ 支持所有 HTTP 方法（get、post、put、patch、delete 等）
+- ✅ 手动终止请求功能
+- ✅ 自动添加 Bearer token
+- ✅ 401 时自动刷新 token（通过 refreshToken）
+
+## 安装
+
+```bash
+npm install @fly/request
+```
+
+## 使用示例
+
+```typescript
+import { init } from '@fly/request'
+import { useUserStore } from '@/stores/user'
+
+const userStore = useUserStore()
+
+const http = init({
+  store: userStore, // pinia 实例
+  baseUrl: 'https://api.example.com',
+  timeout: 10000,
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  refresh: {
+    baseUrl: 'https://api.example.com', // 一般情况 = 最外层的 baseUrl
+    path: '/api/v1/auth/refresh',
+    name: 'Authorization', // 请求头名称
+    token: userStore.refreshToken // 通过 pinia localStorage 存储的 refreshToken 值
+  }
+})
+
+// 使用 HTTP 方法
+const data = await http.get('/api/users')
+const result = await http.post('/api/users', { name: 'John' })
+await http.put('/api/users/1', { name: 'Jane' })
+await http.patch('/api/users/1', { name: 'Jane' })
+await http.delete('/api/users/1')
+```
+
+## API
+
+### init(config)
+
+初始化 HTTP 实例。
+
+#### 参数
+
+- `config.store`: Pinia store 实例，用于存储和获取 token
+- `config.baseUrl`: 接口域名
+- `config.timeout`: 超时时间（毫秒）
+- `config.headers`: 请求头信息
+- `config.refresh`: Token 刷新配置
+  - `refresh.baseUrl`: 刷新接口域名
+  - `refresh.path`: 刷新接口路径
+  - `refresh.name`: 请求头名称（默认为 'Authorization'）
+  - `refresh.token`: refreshToken 值
+
+#### 返回值
+
+返回 HTTP 实例，包含以下方法：
+- `get(url, params?, config?)`
+- `post(url, data?, config?)`
+- `put(url, data?, config?)`
+- `patch(url, data?, config?)`
+- `delete(url, config?)`
+- `request(config)`
+- `createCancelToken()`: 创建取消令牌
+- `cancelRequest(cancelToken, message?)`: 手动终止请求
+

package/dist/http/index.d.ts

@@ -0,0 +1,5 @@
+import { RequestInitConfig, RefreshConfig, HttpRequestConfig, HttpResponse, HttpInstance, TokenResponse } from './types/request.types';
+import { init } from './services/request.service';
+
+export type { RequestInitConfig, RefreshConfig, HttpRequestConfig, HttpResponse, HttpInstance, TokenResponse, };
+export default init;

package/dist/http/services/request.service.d.ts

@@ -0,0 +1,6 @@
+import { RequestInitConfig, HttpInstance } from '../types/request.types';
+
+/**
+ * 创建并初始化 HTTP 实例
+ */
+export declare function init(config: RequestInitConfig): HttpInstance;

package/dist/http/types/request.types.d.ts

@@ -0,0 +1,118 @@
+import { AxiosRequestConfig, AxiosResponse, CancelToken, CancelTokenSource, InternalAxiosRequestConfig } from 'axios';
+import { Store } from 'pinia';
+
+/**
+ * Token 刷新配置
+ */
+export interface RefreshConfig {
+    /** 刷新接口域名 */
+    baseUrl: string;
+    /** 刷新接口路径 */
+    path: string;
+    /** 请求头名称（默认为 'Authorization'） */
+    name?: string;
+    /** refreshToken 值（通过 pinia localStorage 存储） */
+    token: string;
+    /** refreshToken 值 添加前缀（默认为 'Bearer'） */
+    prefix?: 'Bearer' | 'Basic' | 'Digest' | 'Token' | 'OAuth' | 'Custom';
+}
+/**
+ * 请求初始化配置
+ */
+export interface RequestInitConfig {
+    /** Pinia store 实例，用于存储和获取 token */
+    store: Store;
+    /** 接口域名 */
+    baseUrl: string;
+    /** 超时时间（毫秒） */
+    timeout?: number;
+    /** 请求头信息 */
+    headers?: Record<string, string>;
+    /** Token 刷新配置 */
+    refresh: RefreshConfig;
+}
+/**
+ * HTTP 请求配置
+ */
+export interface HttpRequestConfig extends Omit<AxiosRequestConfig, 'cancelToken' | 'headers'> {
+    /** 请求 URL */
+    url: string;
+    /** 请求方法 */
+    method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+    /** 查询参数 */
+    params?: Record<string, any>;
+    /** 请求体数据 */
+    data?: any;
+    /** 请求头 */
+    headers?: Record<string, string>;
+    /** 超时时间 */
+    timeout?: number;
+    /** 取消令牌（支持 CancelTokenSource 或 CancelToken） */
+    cancelToken?: CancelTokenSource | CancelToken;
+}
+/**
+ * HTTP 响应数据模型
+ */
+export interface HttpResponse<T = any> extends Omit<AxiosResponse<T>, 'config'> {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    config: HttpRequestConfig;
+}
+/**
+ * HTTP 实例接口
+ */
+export interface HttpInstance {
+    /**
+     * GET 请求
+     */
+    get<T = any>(url: string, params?: Record<string, any> | null, config?: AxiosRequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * POST 请求
+     */
+    post<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * PUT 请求
+     */
+    put<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * PATCH 请求
+     */
+    patch<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * DELETE 请求
+     */
+    delete<T = any>(url: string, config?: AxiosRequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * 通用请求方法
+     */
+    request<T = any>(config: HttpRequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * 创建取消令牌
+     */
+    createCancelToken(): CancelTokenSource;
+    /**
+     * 手动终止请求
+     */
+    cancelRequest(cancelToken: CancelTokenSource, message?: string): void;
+}
+/**
+ * 内部请求配置（包含刷新配置）
+ */
+export interface InternalRequestConfig extends InternalAxiosRequestConfig {
+    _refreshConfig?: RefreshConfig;
+    _store?: Store;
+    _baseUrl?: string;
+    _retry?: boolean;
+}
+/**
+ * Token 响应数据模型
+ */
+export interface TokenResponse {
+    accessToken: string;
+    refreshToken?: string;
+    tokenType?: string;
+    expiresIn?: number;
+    [key: string]: any;
+}

package/dist/http/utils/request-interceptor.d.ts

@@ -0,0 +1,9 @@
+import { InternalAxiosRequestConfig } from 'axios';
+import { Store } from 'pinia';
+import { InternalRequestConfig, RefreshConfig } from '../types/request.types';
+
+/**
+ * 处理请求拦截器
+ * 自动添加 Bearer token
+ */
+export declare function handleRequestInterceptor(config: InternalRequestConfig, store: Store, refreshConfig: RefreshConfig): InternalAxiosRequestConfig;

package/dist/http/utils/response-interceptor.d.ts

@@ -0,0 +1,12 @@
+import { AxiosError, AxiosResponse } from 'axios';
+import { RefreshConfig } from '../types/request.types';
+import { Store } from 'pinia';
+
+/**
+ * 处理响应拦截器（成功响应）
+ */
+export declare function handleResponseInterceptor<T = any>(response: AxiosResponse<T>, store: Store, refreshConfig: RefreshConfig): Promise<AxiosResponse<T>>;
+/**
+ * 处理响应错误拦截器
+ */
+export declare function handleResponseError(error: AxiosError): Promise<any>;

package/dist/http/utils/token-refresh.d.ts

@@ -0,0 +1,7 @@
+import { Store } from 'pinia';
+import { RefreshConfig } from '../types/request.types';
+
+/**
+ * 处理 Token 刷新
+ */
+export declare function handleTokenRefresh(refreshConfig: RefreshConfig, store: Store, refreshTokenFromResponse: string | undefined, retryFn: () => Promise<any>): Promise<any>;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { init } from './http/services/request.service';
+
+export type { RequestInitConfig, RefreshConfig, HttpRequestConfig, HttpResponse, HttpInstance, TokenResponse, } from './http';
+export default init;

package/dist/index.js

@@ -0,0 +1,368 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+import axios from "axios";
+function getAccessTokenFromStore(store) {
+  const state = store.$state;
+  if (state && typeof state.accessToken === "string") {
+    return state.accessToken;
+  }
+  if (store.accessToken && typeof store.accessToken === "string") {
+    return store.accessToken;
+  }
+  try {
+    const stored = localStorage.getItem("accessToken");
+    if (stored) {
+      try {
+        return JSON.parse(stored);
+      } catch {
+        return stored;
+      }
+    }
+  } catch {
+  }
+  return null;
+}
+function handleRequestInterceptor(config, store, refreshConfig) {
+  if (store) {
+    const accessToken = getAccessTokenFromStore(store);
+    if (accessToken) {
+      const headerName = (refreshConfig == null ? void 0 : refreshConfig.name) || "Authorization";
+      config.headers = config.headers || {};
+      config.headers[headerName] = `Bearer ${accessToken}`;
+    }
+  }
+  return config;
+}
+let isRefreshing = false;
+let refreshPromise = null;
+let failedQueue = [];
+function getRefreshTokenFromStore(store, refreshConfig, name = "refreshToken") {
+  const state = store.$state;
+  if (state && typeof state[name] === "string") {
+    return state[name];
+  }
+  if (store[name] && typeof store[name] === "string") {
+    return store[name];
+  }
+  try {
+    const stored = localStorage.getItem(name);
+    if (stored) {
+      try {
+        return JSON.parse(stored);
+      } catch {
+        return stored;
+      }
+    }
+  } catch {
+  }
+  if (name === "refreshToken" && refreshConfig.token) {
+    return refreshConfig.token;
+  }
+  return null;
+}
+function updateAccessTokenInStore(store, accessToken) {
+  const state = store.$state;
+  if (state && typeof state.accessToken !== "undefined") {
+    state.accessToken = accessToken;
+  }
+  if (typeof store.setAccessToken === "function") {
+    store.setAccessToken(accessToken);
+  }
+  if (typeof store.updateToken === "function") {
+    store.updateToken({ accessToken });
+  }
+  try {
+    localStorage.setItem("accessToken", JSON.stringify(accessToken));
+  } catch {
+  }
+}
+async function refreshTokenApi(refreshConfig, prefix, refreshToken) {
+  const { baseUrl, path, name = "Authorization" } = refreshConfig;
+  const url = path.startsWith("http") ? path : `${baseUrl}${path}`;
+  const response = await axios.post(
+    url,
+    {},
+    {
+      headers: {
+        [name]: `${prefix} ${refreshToken}`
+      }
+    }
+  );
+  return response.data;
+}
+async function handleTokenRefresh(refreshConfig, store, refreshTokenFromResponse, retryFn) {
+  let refreshToken = refreshTokenFromResponse;
+  if (!refreshToken) {
+    const tokenFromStore = getRefreshTokenFromStore(store, refreshConfig);
+    refreshToken = tokenFromStore || void 0;
+  }
+  let prefix = getRefreshTokenFromStore(store, refreshConfig, "prefix") || "Bearer";
+  if (!refreshToken) {
+    throw new Error("Refresh token not found");
+  }
+  if (isRefreshing && refreshPromise) {
+    try {
+      const newToken = await refreshPromise;
+      if (newToken.accessToken) {
+        updateAccessTokenInStore(store, newToken.accessToken);
+      }
+      failedQueue.forEach(({ resolve }) => {
+        resolve();
+      });
+      failedQueue = [];
+      return await retryFn();
+    } catch (refreshError) {
+      failedQueue.forEach(({ reject }) => {
+        reject(refreshError);
+      });
+      failedQueue = [];
+      throw refreshError;
+    }
+  }
+  isRefreshing = true;
+  refreshPromise = refreshTokenApi(refreshConfig, prefix, refreshToken);
+  try {
+    const newToken = await refreshPromise;
+    if (newToken.accessToken) {
+      updateAccessTokenInStore(store, newToken.accessToken);
+    }
+    if (newToken.refreshToken) {
+      const state = store.$state;
+      if (state && typeof state.refreshToken !== "undefined") {
+        state.refreshToken = newToken.refreshToken;
+      }
+      try {
+        localStorage.setItem("refreshToken", JSON.stringify(newToken.refreshToken));
+      } catch {
+      }
+    }
+    isRefreshing = false;
+    refreshPromise = null;
+    failedQueue.forEach(({ resolve }) => {
+      resolve();
+    });
+    failedQueue = [];
+    return await retryFn();
+  } catch (refreshError) {
+    isRefreshing = false;
+    refreshPromise = null;
+    failedQueue.forEach(({ reject }) => {
+      reject(refreshError);
+    });
+    failedQueue = [];
+    throw refreshError;
+  }
+}
+async function handleResponseInterceptor(response, store, refreshConfig) {
+  var _a, _b;
+  const responseData = response == null ? void 0 : response.data;
+  const code = responseData == null ? void 0 : responseData.code;
+  if ([2006, 2007, 2003, 2004, 2e3].includes(code)) {
+    if (!response.request.responseURL.endsWith("login") && !response.request.responseURL.endsWith("register") && !response.request.responseURL.endsWith("register/tenants")) {
+      window.parent.postMessage({
+        type: "error",
+        data: JSON.stringify({
+          code: responseData == null ? void 0 : responseData.code,
+          message: responseData == null ? void 0 : responseData.message,
+          action: "toLogin"
+        })
+      }, "*");
+    }
+    throw new Error(responseData == null ? void 0 : responseData.message);
+  } else if (code === 2001) {
+    const config = response.config;
+    if (!refreshConfig || !store) {
+      return response;
+    }
+    config._retry = true;
+    const newAccessToken = (_a = responseData == null ? void 0 : responseData.data) == null ? void 0 : _a.accessToken;
+    const refreshToken = (_b = responseData == null ? void 0 : responseData.data) == null ? void 0 : _b.refreshToken;
+    const retryFn = async () => {
+      const originalRequest = {
+        ...config,
+        headers: {
+          ...config.headers
+        }
+      };
+      if (newAccessToken) {
+        const headerName = (refreshConfig == null ? void 0 : refreshConfig.name) || "Authorization";
+        originalRequest.headers[headerName] = `Bearer ${newAccessToken}`;
+      }
+      return axios(originalRequest);
+    };
+    try {
+      return await handleTokenRefresh(refreshConfig, store, refreshToken, retryFn);
+    } catch (refreshError) {
+      throw refreshError;
+    }
+  } else if (code > 0) {
+    throw new Error(responseData == null ? void 0 : responseData.message);
+  }
+  return responseData;
+}
+async function handleResponseError(error) {
+  throw error;
+}
+class RequestServiceClass {
+  constructor() {
+    __publicField(this, "instance", null);
+    __publicField(this, "config", null);
+  }
+  /**
+   * 初始化 HTTP 实例
+   */
+  init(config) {
+    this.config = config;
+    this.instance = axios.create({
+      baseURL: config.baseUrl,
+      timeout: config.timeout || 1e4,
+      headers: config.headers || {}
+    });
+    this.instance.interceptors.request.use(
+      (config2) => {
+        const internalConfig = config2;
+        return handleRequestInterceptor(internalConfig, this.config.store, this.config.refresh);
+      },
+      (error) => {
+        return Promise.reject(error);
+      }
+    );
+    this.instance.interceptors.response.use(
+      async (response) => {
+        try {
+          return await handleResponseInterceptor(response, this.config.store, this.config.refresh);
+        } catch (error) {
+          return handleResponseError(error);
+        }
+      },
+      async (error) => {
+        return handleResponseError(error);
+      }
+    );
+  }
+  /**
+   * 重置 HTTP 实例
+   */
+  reset(config) {
+    this.config = config;
+    this.instance = axios.create({
+      baseURL: config.baseUrl,
+      timeout: config.timeout || 1e4,
+      headers: config.headers || {}
+    });
+    this.instance.interceptors.request.use(
+      (config2) => {
+        const internalConfig = config2;
+        return handleRequestInterceptor(internalConfig, this.config.store, this.config.refresh);
+      },
+      (error) => {
+        return Promise.reject(error);
+      }
+    );
+    this.instance.interceptors.response.use(
+      async (response) => {
+        return handleResponseInterceptor(response, this.config.store, this.config.refresh);
+      },
+      async (error) => {
+        return handleResponseError(error);
+      }
+    );
+  }
+  /**
+   * 获取 Axios 实例
+   */
+  getInstance() {
+    if (!this.instance) {
+      throw new Error("HTTP instance not initialized. Please call init() first.");
+    }
+    return this.instance;
+  }
+  /**
+   * 通用请求方法
+   */
+  async request(config) {
+    const instance = this.getInstance();
+    const axiosConfig = {
+      ...config,
+      // 如果 cancelToken 是 CancelTokenSource，提取其 token 属性
+      cancelToken: config.cancelToken && "token" in config.cancelToken ? config.cancelToken.token : config.cancelToken
+    };
+    const response = await instance.request(axiosConfig);
+    return response;
+  }
+  /**
+   * GET 请求
+   */
+  async get(url, params, config) {
+    return this.request({
+      ...config,
+      url,
+      method: "GET",
+      params: params ?? void 0
+    });
+  }
+  /**
+   * POST 请求
+   */
+  async post(url, data, config) {
+    return this.request({
+      ...config,
+      url,
+      method: "POST",
+      data
+    });
+  }
+  /**
+   * PUT 请求
+   */
+  async put(url, data, config) {
+    return this.request({
+      ...config,
+      url,
+      method: "PUT",
+      data
+    });
+  }
+  /**
+   * PATCH 请求
+   */
+  async patch(url, data, config) {
+    return this.request({
+      ...config,
+      url,
+      method: "PATCH",
+      data
+    });
+  }
+  /**
+   * DELETE 请求
+   */
+  async delete(url, config) {
+    return this.request({
+      ...config,
+      url,
+      method: "DELETE"
+    });
+  }
+  /**
+   * 创建取消令牌
+   */
+  createCancelToken() {
+    return axios.CancelToken.source();
+  }
+  /**
+   * 手动终止请求
+   */
+  cancelRequest(cancelToken, message) {
+    cancelToken.cancel(message);
+  }
+}
+function init(config) {
+  const service = new RequestServiceClass();
+  service.init(config);
+  return service;
+}
+export {
+  init as default
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@clownlee/http",
+  "version": "1.0.1",
+  "description": "公共 HTTP 请求库，提供统一的 HTTP 请求能力和自动 token 刷新功能",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "type-check": "vue-tsc --noEmit"
+  },
+  "keywords": [
+    "fly",
+    "business",
+    "package"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.0",
+    "pinia": "^2.1.7",
+    "vue": "^3.5.25"
+  },
+  "peerDependencies": {
+    "@element-plus/icons-vue": "^2.3.0",
+    "element-plus": "^2.12.0",
+    "vue-router": "^4.2.0"
+  },
+  "devDependencies": {
+    "@element-plus/icons-vue": "^2.3.0",
+    "@unocss/preset-uno": "^0.58.0",
+    "@unocss/vite": "^0.58.0",
+    "@types/jquery": "^3.5.33",
+    "@vitejs/plugin-vue": "^5.0.0",
+    "element-plus": "^2.12.0",
+    "sass": "^1.96.0",
+    "terser": "^5.31.0",
+    "typescript": "^5.3.0",
+    "unocss": "^0.58.0",
+    "unplugin-auto-import": "^0.17.0",
+    "unplugin-vue-components": "^0.27.0",
+    "vite": "^5.0.0",
+    "vite-plugin-css-injected-by-js": "^3.5.0",
+    "vite-plugin-dts": "^3.9.0",
+    "vue-router": "^4.2.0",
+    "vue-tsc": "^2.1.10"
+  }
+}