@lark-apaas/client-toolkit 1.2.28-alpha.9 → 1.2.29

package/lib/hooks/useCurrentUserProfile.d.ts

@@ -1,5 +1,11 @@
 import { IUserProfile } from '../apis/udt-types';
-export interface ICompatibilityUserProfile extends IUserProfile {
+/**
+ * useCurrentUserProfile 的返回类型。
+ * 初始状态为空对象 `{}`（所有字段均为 undefined），异步获取用户信息后字段才会被填充。
+ * 使用时必须通过可选链或空值合并进行安全访问，如 `userInfo?.user_id`。
+ * 判断是否已加载完成应使用 `if (!userInfo?.user_id)` 而非 `if (!userInfo)`（因为空对象是 truthy）。
+ */
+export type ICompatibilityUserProfile = Partial<IUserProfile & {
     /**
      * @deprecated please use `name`
      */
@@ -8,5 +14,14 @@ export interface ICompatibilityUserProfile extends IUserProfile {
      * @deprecated please use `avatar`
      */
     userAvatar: string;
-}
-export declare const useCurrentUserProfile: () => ICompatibilityUserProfile;
+}>;
+export declare const useCurrentUserProfile: () => Partial<IUserProfile & {
+    /**
+     * @deprecated please use `name`
+     */
+    userName: string;
+    /**
+     * @deprecated please use `avatar`
+     */
+    userAvatar: string;
+}>;

package/lib/integrations/getCurrentUserProfile.d.ts

@@ -1,5 +1,11 @@
 import { IUserProfile } from '../apis/udt-types';
-export declare function getCurrentUserProfile(): IUserProfile;
+/**
+ * 获取当前用户信息。
+ * 返回 Partial<IUserProfile>，因为初始值来自 window._userInfo，
+ * 该值在运行时始终为空对象 {}，所有字段均为 undefined。
+ * 异步获取用户信息后才会被填充为完整的 IUserProfile。
+ */
+export declare function getCurrentUserProfile(): Partial<IUserProfile>;
 /**
  * @deprecated 请使用 getCurrentUserProfile 代替
  */

package/lib/utils/axiosConfig.js

@@ -4,6 +4,92 @@ import { logger } from "../apis/logger.js";
 import { getStacktrace } from "../logger/selected-logs.js";
 import { safeStringify } from "./safeStringify.js";
 import { slardar } from "@lark-apaas/internal-slardar";
+import { normalizeBasePath } from "./utils.js";
+const APP_CLIENT_API_LOG_TYPE = 'app_client_api_log';
+function stripBasePath(urlPath) {
+    const base = normalizeBasePath(process.env.CLIENT_BASE_PATH);
+    if (base && urlPath.startsWith(base)) return urlPath.slice(base.length) || '/';
+    return urlPath;
+}
+let _pageRoutes = null;
+function getPageRouteDefinitions() {
+    if (_pageRoutes) return _pageRoutes;
+    try {
+        const raw = process.env.__PAGE_ROUTE_DEFINITIONS__;
+        if (raw) {
+            const parsed = JSON.parse(raw);
+            if (Array.isArray(parsed)) {
+                _pageRoutes = parsed;
+                return _pageRoutes;
+            }
+        }
+    } catch  {}
+    _pageRoutes = [];
+    return _pageRoutes;
+}
+let _apiRoutes = null;
+function getApiRouteDefinitions() {
+    if (_apiRoutes) return _apiRoutes;
+    try {
+        const raw = process.env.__API_ROUTE_DEFINITIONS__;
+        if (raw) {
+            const parsed = JSON.parse(raw);
+            if (Array.isArray(parsed)) {
+                _apiRoutes = parsed;
+                return _apiRoutes;
+            }
+        }
+    } catch  {}
+    _apiRoutes = [];
+    return _apiRoutes;
+}
+function matchRoute(concretePath, routes) {
+    const segments = concretePath.split('/').filter(Boolean);
+    for (const route of routes){
+        const routeSegments = route.path.split('/').filter(Boolean);
+        if (routeSegments.length !== segments.length) continue;
+        let match = true;
+        for(let i = 0; i < routeSegments.length; i++)if (!routeSegments[i].startsWith(':')) {
+            if (routeSegments[i] !== segments[i]) {
+                match = false;
+                break;
+            }
+        }
+        if (match) return route.path;
+    }
+    return null;
+}
+function matchApiRoute(method, concretePath) {
+    const routes = getApiRouteDefinitions();
+    const segments = concretePath.split('/').filter(Boolean);
+    for (const route of routes){
+        if ('*' !== route.method && route.method !== method) continue;
+        const routeSegments = route.path.split('/').filter(Boolean);
+        if (routeSegments.length !== segments.length) continue;
+        let match = true;
+        for(let i = 0; i < routeSegments.length; i++)if (!routeSegments[i].startsWith(':')) {
+            if (routeSegments[i] !== segments[i]) {
+                match = false;
+                break;
+            }
+        }
+        if (match) return route.path;
+    }
+    return null;
+}
+function getRefererPath() {
+    try {
+        if ('undefined' == typeof window || !window.location?.pathname) return '/';
+        const rawPath = stripBasePath(window.location.pathname);
+        return matchRoute(rawPath, getPageRouteDefinitions()) || rawPath;
+    } catch  {
+        return '/';
+    }
+}
+function getApiField(method, path) {
+    const matched = matchApiRoute(method, path);
+    return `${method} ${matched || path}`;
+}
 const isValidResponse = (resp)=>null != resp && 'object' == typeof resp && 'config' in resp && null !== resp.config && void 0 !== resp.config && 'object' == typeof resp.config && 'status' in resp && 'number' == typeof resp.status && 'data' in resp;
 async function logResponse(ok, responseOrError) {
     if (isValidResponse(responseOrError)) {
@@ -139,13 +225,20 @@ function handleSpanEnd(cfg, response, error) {
         const errorMessage = error?.message || '未知错误';
         const url = response?.request?.responseURL || errorResponse?.request?.responseURL || cfg.url || "";
         const method = (cfg.method || 'GET').toUpperCase();
-        const path = url.split('?')[0].replace(/^https?:\/\/[^/]+/, '') || '/';
+        const rawPath = url.split('?')[0].replace(/^https?:\/\/[^/]+/, '') || '/';
+        const path = stripBasePath(rawPath);
+        const durationMs = startTime ? Date.now() - startTime : void 0;
+        const referer_path = getRefererPath();
+        const api = getApiField(method, path);
+        const type = APP_CLIENT_API_LOG_TYPE;
         const logData = {
             method,
             path,
             url,
-            duration_ms: startTime ? Date.now() - startTime : void 0,
-            status: response ? response.status : errorResponse.status || 0
+            duration_ms: durationMs,
+            status: response ? response.status : errorResponse.status || 0,
+            referer_path,
+            type
         };
         if (error) logData.error_message = errorMessage;
         if ('undefined' != typeof navigator) logData.user_agent = navigator.userAgent;
@@ -158,7 +251,19 @@ function handleSpanEnd(cfg, response, error) {
         const responseData = response?.data || errorResponse?.data;
         if (responseData) logData.response = responseData;
         const level = error ? 'ERROR' : 'INFO';
-        observable.log(level, safeStringify(logData), {}, currentSpan);
+        observable.log(level, safeStringify(logData), {
+            referer_path,
+            api,
+            type,
+            duration_ms: durationMs
+        }, currentSpan);
+        if ('function' == typeof currentSpan.setAttributes) currentSpan.setAttributes({
+            referer_path,
+            api,
+            duration_ms: durationMs,
+            module: 'app_web',
+            source_type: 'platform'
+        });
         'function' == typeof currentSpan.end && currentSpan.end();
     } catch (e) {
         console.error('[AxiosTrace] Log span failed:', e);
@@ -240,6 +345,11 @@ function initAxiosConfig(axiosInstance) {
         const csrfToken = window.csrfToken;
         if (csrfToken) config.headers['X-Suda-Csrf-Token'] = csrfToken;
         if ('undefined' != typeof window && window.location?.pathname) config.headers['X-Page-Route'] = window.location.pathname;
+        const refererPath = getRefererPath();
+        config.headers['Rpc-Persist-Apaas-Observability-Referer-Path'] = refererPath;
+        const reqMethod = (config.method || 'GET').toUpperCase();
+        const requestPath = stripBasePath((config.url || '').split('?')[0]);
+        config.headers['Rpc-Persist-Apaas-Observability-Api'] = getApiField(reqMethod, requestPath);
         return config;
     }, (error)=>Promise.reject(error));
     instance.interceptors.response.use((response)=>response, (error)=>{

package/lib/utils/hmr-api.d.ts

@@ -9,6 +9,12 @@
  * @see docs/RFC_HMR_API.md
  */
 export interface HmrApi {
+    /**
+     * 注册 HMR 更新前回调（模块替换之前触发）
+     * @param callback 回调函数
+     * @returns cleanup 函数，用于取消注册
+     */
+    onBeforeApply?(callback: () => void): () => void;
     /**
      * 注册 HMR 成功回调
      * @param callback 成功回调函数
@@ -24,7 +30,7 @@ export interface HmrApi {
 }
 declare global {
     interface Window {
-        __VITE_HMR__?: HmrApi;
+        __VITE_HMR__?: Required<HmrApi>;
     }
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/client-toolkit",
-  "version": "1.2.28-alpha.9",
+  "version": "1.2.29",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
   "files": [
@@ -103,7 +103,7 @@
     "@lark-apaas/auth-sdk": "^0.1.2",
     "@lark-apaas/client-capability": "^0.1.6",
     "@lark-apaas/internal-slardar": "^0.0.3",
-    "@lark-apaas/miaoda-inspector": "^1.0.20",
+    "@lark-apaas/miaoda-inspector": "^1.0.21",
     "@lark-apaas/observable-web": "^1.0.5",
     "@radix-ui/react-avatar": "^1.1.10",
     "@radix-ui/react-popover": "^1.1.15",