@0xchain/request 1.1.0-beta.81 → 1.1.0-beta.83

package/README.md

@@ -10,6 +10,7 @@ This library was generated with [Nx](https://nx.dev).
 - 自动添加通用请求头
 - 统一的错误处理
 - 支持返回完整响应对象（包含 headers 信息）
+- 业务信封可选 `toast` 时，客户端派发 `xchain-response-toast`
 
 ## 使用方法
 
@@ -68,6 +69,18 @@ if (response.status === 201) {
 }
 ```
 
+### 响应体 toast
+
+成功信封可带可选字段 `toast: { amount, title? }`。客户端会派发 `xchain-response-toast`（导出常量 `RESPONSE_TOAST_EVENT`），业务自行监听并展示；SSR 不会派发。没有 toast 时后端应省略该字段。
+
+```typescript
+import axiosInstance, { RESPONSE_TOAST_EVENT } from '@0xchain/request';
+
+window.addEventListener(RESPONSE_TOAST_EVENT, (event) => {
+  const toast = (event as CustomEvent).detail; // { amount, title? }
+});
+```
+
 ## API 配置选项
 
 ### ApiRequestConfig

package/dist/index.d.ts

@@ -1,10 +1,12 @@
 import { AxiosError } from 'axios';
+import { ResponseToast } from './responseToast';
 export interface ApiResponse<T> {
     status: {
         code: number;
         msg: string;
     };
     data: T;
+    toast?: ResponseToast;
 }
 export interface ApiError extends AxiosError {
     need?: boolean;
@@ -13,5 +15,7 @@ declare const axiosInstance: import('axios').AxiosInstance;
 export default axiosInstance;
 export { setServerHeaderProvider, setClientLocales } from './interceptors/commonHeader';
 export { refreshAccessToken, getCurrentAccessToken } from './tokenRefresh';
+export { RESPONSE_TOAST_EVENT, emitResponseToast, parseResponseToast, } from './responseToast';
+export type { ResponseToast } from './responseToast';
 export type { ApiRequestConfig, ServerHeaderProvider, Pagination, Status, IResponse, IFilters, IPageRequest, } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +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,+BAYjB,CAAC;AASH,eAAe,aAAa,CAAC;AAE7B,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAExF,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAE3E,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,UAAU,EACV,MAAM,EACN,SAAS,EACT,QAAQ,EACR,YAAY,GACb,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,UAAU,EAAE,MAAM,OAAO,CAAC;AAM/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGrD,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;IACR,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,QAAS,SAAQ,UAAU;IAC1C,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAGD,QAAA,MAAM,aAAa,+BAYjB,CAAC;AASH,eAAe,aAAa,CAAC;AAE7B,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAExF,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,UAAU,EACV,MAAM,EACN,SAAS,EACT,QAAQ,EACR,YAAY,GACb,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -258,6 +258,36 @@ function refreshAccessToken() {
 function getCurrentAccessToken() {
   return jsCookie.get(envCookieName("access_token")) || getToken("access_token") || "";
 }
+const RESPONSE_TOAST_EVENT = "xchain-response-toast";
+function readToastObject(source) {
+  if (!source || typeof source !== "object") return null;
+  const raw = source;
+  const amount = Number(raw.amount);
+  if (!Number.isFinite(amount)) return null;
+  return {
+    amount,
+    title: typeof raw.title === "string" ? raw.title : void 0
+  };
+}
+function parseResponseToast(payload) {
+  if (!payload || typeof payload !== "object") return null;
+  const rec = payload;
+  const direct = readToastObject(rec.toast);
+  if (direct) return direct;
+  if (rec.data && typeof rec.data === "object") {
+    return readToastObject(rec.data.toast);
+  }
+  return null;
+}
+function emitResponseToast(payload) {
+  if (isServerRuntime()) return;
+  if (typeof window === "undefined") return;
+  const toast = parseResponseToast(payload);
+  if (!toast) return;
+  window.dispatchEvent(
+    new CustomEvent(RESPONSE_TOAST_EVENT, { detail: toast })
+  );
+}
 function shouldSkipRefresh(config) {
   const url = typeof config?.url === "string" ? config.url : "";
   if (url.includes("/api/refresh/token")) return true;
@@ -268,6 +298,7 @@ function shouldSkipRefresh(config) {
 function handleBusinessResponse(response) {
   const config = response.config;
   if (config.returnFullResponse) {
+    emitResponseToast(response.data);
     return response;
   }
   if (response.status === 200) {
@@ -309,6 +340,7 @@ function handleBusinessResponse(response) {
       }
       throw err;
     }
+    emitResponseToast(data);
     return data;
   }
   return response;
@@ -383,8 +415,11 @@ axiosInstance.interceptors.request.use(refreshToken);
 axiosInstance.interceptors.request.use(commonHeader, errorInterceptor);
 axiosInstance.interceptors.response.use(createResponseInterceptor(axiosInstance), errorInterceptor);
 export {
+  RESPONSE_TOAST_EVENT,
   axiosInstance as default,
+  emitResponseToast,
   getCurrentAccessToken,
+  parseResponseToast,
   refreshAccessToken,
   setClientLocales,
   setServerHeaderProvider

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

@@ -1 +1 @@
-{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/interceptors/response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,aAAa,EAAE,aAAa,EAA8B,MAAM,OAAO,CAAC;AAqE7F;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,aAAa,IACrB,UAAU,aAAa,KAAG,OAAO,CAAC,GAAG,CAAC,CAoBjF;AAED,eAAe,yBAAyB,CAAC"}
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/interceptors/response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,aAAa,EAAE,aAAa,EAA8B,MAAM,OAAO,CAAC;AAwE7F;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,aAAa,IACrB,UAAU,aAAa,KAAG,OAAO,CAAC,GAAG,CAAC,CAoBjF;AAED,eAAe,yBAAyB,CAAC"}

package/dist/responseToast.d.ts

@@ -0,0 +1,14 @@
+/** 业务信封里的 toast。无发放时后端应省略该字段。 */
+export type ResponseToast = {
+    amount: number;
+    title?: string;
+};
+/** 客户端 window 事件名。产品层自行监听并展示 UI，本库不弹 toast。 */
+export declare const RESPONSE_TOAST_EVENT = "xchain-response-toast";
+/**
+ * 从业务信封 `{ data, status, toast }` 或 AxiosResponse `{ data: envelope }` 解析 toast。
+ * 只认 `toast` 字段，不把业务 `data.amount` 当成提示。
+ */
+export declare function parseResponseToast(payload: unknown): ResponseToast | null;
+export declare function emitResponseToast(payload: unknown): void;
+//# sourceMappingURL=responseToast.d.ts.map

package/dist/responseToast.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responseToast.d.ts","sourceRoot":"","sources":["../src/responseToast.ts"],"names":[],"mappings":"AAEA,iCAAiC;AACjC,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,+CAA+C;AAC/C,eAAO,MAAM,oBAAoB,0BAA0B,CAAC;AAa5D;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,aAAa,GAAG,IAAI,CASzE;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAQxD"}

package/dist/types.d.ts

@@ -1,4 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
+import { ResponseToast } from './responseToast';
+export type { ResponseToast };
 export interface ServerHeaderProvider {
     getAccessToken(): Promise<string | undefined>;
     getLanguage(): Promise<string | undefined>;
@@ -32,6 +34,7 @@ export interface IResponse<T> {
     data: T;
     pagination?: null | Pagination;
     status: Status;
+    toast?: ResponseToast;
     [property: string]: any;
 }
 /**

package/dist/types.d.ts.map

@@ -1 +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,oBAAoB;IACnC,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC9C,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC5C;AAED,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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,YAAY,EAAE,aAAa,EAAE,CAAC;AAE9B,MAAM,WAAW,oBAAoB;IACnC,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC9C,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC5C;AAED,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;AAED;;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,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xchain/request",
-  "version": "1.1.0-beta.81",
+  "version": "1.1.0-beta.83",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -32,8 +32,8 @@
     "qs": "6.14.0"
   },
   "dependencies": {
-    "@0xchain/logger": "1.1.0-beta.81",
-    "@0xchain/token": "1.1.0-beta.81"
+    "@0xchain/logger": "1.1.0-beta.83",
+    "@0xchain/token": "1.1.0-beta.83"
   },
   "nx": {
     "tags": [