@ichaingo/request 1.1.0

package/README.md

@@ -0,0 +1,97 @@
+# request
+
+This library was generated with [Nx](https://nx.dev).
+
+一个基于 Axios 的 HTTP 请求库，提供了统一的请求拦截器和响应处理。
+
+## 功能特性
+
+- 基于 Axios 的 HTTP 客户端
+- 自动添加通用请求头
+- 统一的错误处理
+- 支持返回完整响应对象（包含 headers 信息）
+
+## 使用方法
+
+### 基本用法
+
+```typescript
+import axiosInstance from '@ichaingo/request';
+
+// 普通请求，返回 response.data
+const data = await axiosInstance.get('/api/users');
+console.log(data); // 直接是响应数据
+```
+
+### 获取完整响应对象
+
+当你需要访问响应头信息时，可以使用 `returnFullResponse` 选项：
+
+```typescript
+import axiosInstance from '@ichaingo/request';
+import { ApiRequestConfig } from '@ichaingo/request/types';
+
+const config: ApiRequestConfig = {
+  returnFullResponse: true // 返回完整的 response 对象
+};
+
+const response = await axiosInstance.get('/api/users', config);
+
+// 现在可以访问完整的响应信息
+console.log('状态码:', response.status);
+console.log('响应头:', response.headers);
+console.log('响应数据:', response.data);
+
+// 读取特定的 header 信息
+const contentType = response.headers['content-type'];
+const customHeader = response.headers['x-custom-header'];
+```
+
+### POST 请求示例
+
+```typescript
+const config: ApiRequestConfig = {
+  returnFullResponse: true,
+  headers: {
+    'Content-Type': 'application/json'
+  }
+};
+
+const response = await axiosInstance.post('/api/users', {
+  name: 'John Doe',
+  email: 'john@example.com'
+}, config);
+
+if (response.status === 201) {
+  console.log('用户创建成功');
+  console.log('Location header:', response.headers['location']);
+}
+```
+
+## API 配置选项
+
+### ApiRequestConfig
+
+继承自 Axios 的 `AxiosRequestConfig`，并添加了以下选项：
+
+- `withCredentials?: boolean` - 是否包含凭据
+- `returnFullResponse?: boolean` - 是否返回完整的响应对象（默认为 false）
+
+当 `returnFullResponse` 为 `true` 时，请求将返回完整的 Axios 响应对象，包含：
+- `data` - 响应数据
+- `status` - HTTP 状态码
+- `statusText` - HTTP 状态文本
+- `headers` - 响应头信息
+- `config` - 请求配置
+
+## Building
+
+Run `nx build request` to build the library.
+
+## Running unit tests
+
+Run `nx test request` to execute the unit tests via [Vitest](https://vitest.dev/).
+
+## 更多示例
+
+查看 `example.ts` 文件获取更多使用示例。

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { AxiosError } from 'axios';
+export interface ApiResponse<T> {
+    status: {
+        code: number;
+        msg: string;
+    };
+    data: T;
+}
+export interface ApiError extends AxiosError {
+    need?: boolean;
+}
+declare const axiosInstance: import('axios').AxiosInstance;
+export default axiosInstance;
+export type { ApiRequestConfig, Pagination, Status, IResponse, IFilters, IPageRequest, } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,UAAU,EAAE,MAAM,OAAO,CAAC;AAQ/C,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,QAAS,SAAQ,UAAU;IAC1C,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAGD,QAAA,MAAM,aAAa,+BASjB,CAAC;AASH,eAAe,aAAa,CAAC;AAE7B,YAAY,EACV,gBAAgB,EAChB,UAAU,EACV,MAAM,EACN,SAAS,EACT,QAAQ,EACR,YAAY,GACb,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -0,0 +1,153 @@
+import $, { isAxiosError as C, AxiosError as w } from "axios";
+import N from "qs";
+import x from "js-cookie";
+import { logger as R } from "@ichaingo/logger";
+import q, { isTokenExpired as O, getToken as b } from "@ichaingo/token";
+const B = () => /^(zh-hans|zh-cn|zh-sg|zh-my)$/.test(window == null ? void 0 : window.navigator.language.toLowerCase()), P = () => B() ? "zh-hans" : "";
+async function S(e) {
+  var n;
+  let t = "", o = "";
+  if (process.env.IS_SERVER) {
+    const c = await import("http");
+    e.httpAgent = new c.Agent({
+      keepAlive: !0
+    });
+    try {
+      const s = e.headers.get("Accept-Language");
+      e.headers["x-whistle-nohost-env"] = process.env.NO_HOST_ENV || "ichaingo";
+      const { cookies: a, headers: u } = await import("next/headers");
+      t = ((n = (await a()).get("access_token")) == null ? void 0 : n.value) || "";
+      const d = await u();
+      o = s || d.get("x-next-intl-locale") || "en";
+    } catch (s) {
+      console.error("Error accessing cookies in server component:", s);
+    }
+  } else
+    t = x.get("access_token") || "", o = x.get("NEXT_LOCALE") || P() || "en";
+  const i = e.headers.isRefreshToken;
+  return e.headers["Accept-Language"] = o, t && !i && (e.headers.Authorization = `Bearer ${t}`), e.headers.devicetype = 1, e;
+}
+function z(e) {
+  var g, r, T, y, L, h, f, _, I, v, k;
+  const t = (r = (g = e.config) == null ? void 0 : g.method) == null ? void 0 : r.toUpperCase(), o = ((T = e.config) == null ? void 0 : T.baseURL) || "", i = (y = e.config) != null && y.url ? `${o || ""}${e.config.url}` : "", n = (L = e.response) == null ? void 0 : L.status, c = (h = e.response) == null ? void 0 : h.statusText, s = (f = e.response) == null ? void 0 : f.data, a = ((I = (_ = e.response) == null ? void 0 : _.headers) == null ? void 0 : I["x-request-id"]) || ((v = s == null ? void 0 : s.status) == null ? void 0 : v.requestId), u = (s == null ? void 0 : s.message) || (s == null ? void 0 : s.msg) || ((k = s == null ? void 0 : s.status) == null ? void 0 : k.msg), m = [
+    n ? `HTTP ${n}` : "HTTP ERROR",
+    t,
+    i,
+    c
+  ].filter(Boolean).join(" | "), d = u ? `server: ${u}` : void 0, l = a ? `requestId=${a}` : void 0;
+  return [m, d, l].filter(Boolean).join(" | ");
+}
+function E(e) {
+  var c, s, a, u, m, d, l, g, r;
+  const t = e.config;
+  let o = t == null ? void 0 : t.data;
+  if (typeof o == "string")
+    try {
+      o = JSON.parse(o);
+    } catch {
+    }
+  const i = t == null ? void 0 : t.baseURL, n = t != null && t.url ? i ? `${i}${t.url}` : t.url : void 0;
+  return {
+    method: (c = t == null ? void 0 : t.method) == null ? void 0 : c.toUpperCase(),
+    url: n,
+    params: t == null ? void 0 : t.params,
+    data: o,
+    status: (s = e.response) == null ? void 0 : s.status,
+    statusText: (a = e.response) == null ? void 0 : a.statusText,
+    requestId: ((m = (u = e.response) == null ? void 0 : u.headers) == null ? void 0 : m["x-request-id"]) || ((g = (l = (d = e.response) == null ? void 0 : d.data) == null ? void 0 : l.status) == null ? void 0 : g.requestId),
+    responseData: (r = e.response) == null ? void 0 : r.data
+  };
+}
+function A(e) {
+  var n, c, s, a;
+  const t = C(e) ? e : new w(String(e));
+  if (t.code === "ECONNABORTED" || /timeout/i.test(t.message || "")) {
+    const u = (c = (n = t.config) == null ? void 0 : n.method) == null ? void 0 : c.toUpperCase(), m = ((s = t.config) == null ? void 0 : s.baseURL) || "", d = (a = t.config) != null && a.url ? `${m || ""}${t.config.url}` : "", l = ["TIMEOUT", u, d].filter(Boolean).join(" | ");
+    return t.summary = l, t.details = JSON.stringify(E(t)), R.error({ message: l, details: t.details, errType: "timeout" }), Promise.reject(t);
+  }
+  const i = z(t);
+  return t.summary = i, t.details = JSON.stringify(E(t)), R.error({ message: i, details: t.details, errType: "server error" }), Promise.reject(t);
+}
+function H(e) {
+  var o, i, n, c, s, a, u, m, d, l;
+  if (e.config.returnFullResponse)
+    return e;
+  if (e.status === 401)
+    return q.removeAllToken(), window.location.href = `${process.env.NEXT_PUBLIC_AUTH_URL}/login`, e;
+  if (e.status === 200) {
+    if ((o = e.headers["content-type"]) != null && o.includes("text/event-stream"))
+      return e;
+    const g = e.data, r = g.status;
+    if (r && typeof r.code == "number" && ![0, 200].includes(r.code)) {
+      const T = new w(
+        (r == null ? void 0 : r.msg) || "Business error",
+        String(r.code),
+        e.config,
+        e.request,
+        e
+      ), y = `BIZ ${r.code} | ${(n = (i = e.config) == null ? void 0 : i.method) == null ? void 0 : n.toUpperCase()} | ${((c = e.config) == null ? void 0 : c.baseURL) || ""}${((s = e.config) == null ? void 0 : s.url) || ""} | server: ${r == null ? void 0 : r.msg}`, L = {
+        method: (u = (a = e.config) == null ? void 0 : a.method) == null ? void 0 : u.toUpperCase(),
+        url: (m = e.config) != null && m.baseURL ? `${e.config.baseURL}${e.config.url || ""}` : e.config.url,
+        params: (d = e.config) == null ? void 0 : d.params,
+        data: (() => {
+          var f;
+          let h = (f = e.config) == null ? void 0 : f.data;
+          if (typeof h == "string")
+            try {
+              h = JSON.parse(h);
+            } catch {
+            }
+          return h;
+        })(),
+        status: e.status,
+        statusText: e.statusText,
+        requestId: ((l = e.headers) == null ? void 0 : l["x-request-id"]) || (r == null ? void 0 : r.requestId),
+        responseData: g
+      };
+      throw process.env.NODE_ENV !== "development" && R.error({ summary: y, details: L, errType: "business error" }), T;
+    }
+    return g;
+  }
+  return e;
+}
+let p = null;
+const j = $.create({
+  baseURL: process.env.NEXT_PUBLIC_AUTH_URL,
+  timeout: 1e4,
+  withCredentials: !0,
+  // Always include credentials by default
+  paramsSerializer: function(e) {
+    return N.stringify(e, { arrayFormat: "brackets" });
+  }
+});
+async function M(e) {
+  const t = e.headers;
+  return p ? (await p, e) : (O() && (p = (async () => {
+    await j.get("/api/refresh/token", {
+      params: {
+        grant_type: "refresh_token",
+        refresh_token: b("refresh_token")
+      },
+      headers: {
+        ...t
+      }
+    });
+  })().finally(() => {
+    p = null;
+  }), await p), e);
+}
+const U = $.create({
+  baseURL: process.env.ICHAINGO_INNER_API_URL || process.env.NEXT_PUBLIC_ICHAINGO_API_URL,
+  timeout: 1e4,
+  withCredentials: !0,
+  // Always include credentials by default
+  paramsSerializer: function(e) {
+    return N.stringify(e, { arrayFormat: "brackets" });
+  }
+});
+U.interceptors.request.use(M);
+U.interceptors.request.use(S, A);
+U.interceptors.response.use(H, A);
+export {
+  U as default
+};

package/dist/interceptors/commonHeader.d.ts

@@ -0,0 +1,3 @@
+import { InternalAxiosRequestConfig } from 'axios';
+export declare function commonHeader(config: InternalAxiosRequestConfig): Promise<InternalAxiosRequestConfig<any>>;
+//# sourceMappingURL=commonHeader.d.ts.map

package/dist/interceptors/commonHeader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonHeader.d.ts","sourceRoot":"","sources":["../../src/interceptors/commonHeader.ts"],"names":[],"mappings":"AAEA,OAAO,EAAoB,0BAA0B,EAAE,MAAM,OAAO,CAAC;AAErE,wBAAsB,YAAY,CAChC,MAAM,EAAE,0BAA0B,4CAmCnC"}

package/dist/interceptors/error.d.ts

@@ -0,0 +1,3 @@
+import { AxiosError } from 'axios';
+export declare function errorInterceptor(error: AxiosError): Promise<never>;
+//# sourceMappingURL=error.d.ts.map

package/dist/interceptors/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/interceptors/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAA4C,MAAM,OAAO,CAAC;AAwD7E,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,kBA2BjD"}

package/dist/interceptors/refreshToken.d.ts

@@ -0,0 +1,3 @@
+import { InternalAxiosRequestConfig } from 'axios';
+export default function refreshToken(config: InternalAxiosRequestConfig): Promise<InternalAxiosRequestConfig<any>>;
+//# sourceMappingURL=refreshToken.d.ts.map

package/dist/interceptors/refreshToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refreshToken.d.ts","sourceRoot":"","sources":["../../src/interceptors/refreshToken.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,0BAA0B,EAAE,MAAM,OAAO,CAAC;AAY1D,wBAA8B,YAAY,CACxC,MAAM,EAAE,0BAA0B,4CA0BnC"}

package/dist/interceptors/response.d.ts

@@ -0,0 +1,3 @@
+import { AxiosResponse } from 'axios';
+export default function ResponseInterceptor(response: AxiosResponse): any;
+//# sourceMappingURL=response.d.ts.map

package/dist/interceptors/response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/interceptors/response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,aAAa,EAAE,MAAM,OAAO,CAAC;AAKlD,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,QAAQ,EAAE,aAAa,GAAG,GAAG,CAsDxE"}

package/dist/lib/request.d.ts

@@ -0,0 +1,17 @@
+import { AxiosRequestConfig, AxiosError } from 'axios';
+export interface ApiRequestConfig extends AxiosRequestConfig {
+    withCredentials?: boolean;
+}
+export interface ApiResponse<T> {
+    status: {
+        code: number;
+        msg: string;
+    };
+    data: T;
+}
+export interface ApiError extends AxiosError {
+    need?: boolean;
+}
+declare const axiosInstance: import('axios').AxiosInstance;
+export default axiosInstance;
+//# sourceMappingURL=request.d.ts.map

package/dist/lib/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/lib/request.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,kBAAkB,EAAE,KAAK,UAAU,EAAE,MAAM,OAAO,CAAC;AAMxE,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,QAAS,SAAQ,UAAU;IAC1C,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAGD,QAAA,MAAM,aAAa,+BASjB,CAAC;AAYH,eAAe,aAAa,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,75 @@
+import { AxiosRequestConfig } from 'axios';
+export interface ApiRequestConfig extends AxiosRequestConfig {
+    withCredentials?: boolean;
+    returnFullResponse?: boolean;
+}
+export interface Pagination {
+    hasMore?: boolean;
+    limit: number;
+    page: number;
+    snapshotTime: number;
+    totalCount: number;
+    [property: string]: any;
+}
+/**
+* Status
+*/
+export interface Status {
+    code: number;
+    creditCount: number;
+    msg: string;
+    requestId: string;
+    [property: string]: any;
+}
+/**
+ * 后端接口返回的格式
+ */
+export interface IResponse<T> {
+    data: T;
+    pagination?: null | Pagination;
+    status: Status;
+    [property: string]: any;
+}
+/**
+* 过滤条件
+*/
+export interface IFilters {
+    /**
+     * 最大数量
+     */
+    maxAmount?: number;
+    /**
+     * 最大价值
+     */
+    maxValue?: number;
+    /**
+     * 最小数量
+     */
+    minAmount?: number;
+    /**
+     * 最小价值
+     */
+    minValue?: number;
+    /**
+     * token列表
+     */
+    tokenList?: string[];
+    [property: string]: any;
+}
+/**
+ * 分页请求
+ */
+export interface IPageRequest {
+    /**
+     * 过滤条件
+     */
+    filters?: IFilters;
+    limit: number;
+    page: number;
+    /**
+     * 秒级时间戳
+     */
+    snapshotTime?: number;
+    [property: string]: any;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CACzB;AAED;;EAEE;AACF,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,IAAI,EAAE,CAAC,CAAC;IACR,UAAU,CAAC,EAAE,IAAI,GAAG,UAAU,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CACzB;AAED;;EAEE;AACF,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CACzB"}

package/dist/util/index.d.ts

@@ -0,0 +1,3 @@
+export declare const isSimplifiedChinese: () => boolean;
+export declare const matchSystemLanguage: () => "zh-hans" | "";
+//# sourceMappingURL=index.d.ts.map

package/dist/util/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,eAE/B,CAAC;AAEF,eAAO,MAAM,mBAAmB,sBAE/B,CAAC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@ichaingo/request",
+  "version": "1.1.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "peerDependencies": {
+    "axios": "1.10.0",
+    "js-cookie": "3.0.5",
+    "next": "^15.4.5",
+    "qs": "6.14.0",
+    "@ichaingo/logger": "1.1.0",
+    "@ichaingo/token": "1.1.0"
+  },
+  "devDependencies": {
+    "@types/js-cookie": "^3.0.6",
+    "@types/qs": "^6.14.0"
+  }
+}