@lark-apaas/client-toolkit 1.2.9 → 1.2.34

package/lib/integrations/services/UserService.js

@@ -1,8 +1,10 @@
 import { getAppId } from "../../utils/getAppId.js";
+import { isNewPathEnabled } from "../../utils/apiPath.js";
 const DEFAULT_CONFIG = {
-    getAppId: ()=>getAppId(window.location.pathname),
-    searchUserUrl: (appId)=>`/af/app/${appId}/runtime/api/v1/account/search_user`,
-    listUsersUrl: (appId)=>`/af/app/${appId}/runtime/api/v1/account/list_users`
+    getAppId: ()=>getAppId(),
+    searchUserUrl: (appId)=>isNewPathEnabled() ? `/app/${appId}/__runtime__/api/v1/account/search_user` : `/af/app/${appId}/runtime/api/v1/account/search_user`,
+    listUsersUrl: (appId)=>isNewPathEnabled() ? `/app/${appId}/__runtime__/api/v1/account/list_users` : `/af/app/${appId}/runtime/api/v1/account/list_users`,
+    convertExternalContactUrl: (appId)=>isNewPathEnabled() ? `/app/${appId}/__runtime__/api/v1/account/convert_lark_user` : `/af/app/${appId}/runtime/api/v1/account/convert_lark_user`
 };
 class UserService {
     config;
@@ -42,5 +44,23 @@ class UserService {
         if (!response.ok) throw new Error('Failed to fetch users by ids');
         return response.json();
     }
+    async convertExternalContact(larkUserID) {
+        const appId = this.config.getAppId();
+        if (!appId) throw new Error('Failed to get appId');
+        const response = await fetch(this.config.convertExternalContactUrl(appId), {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({
+                larkUserID
+            }),
+            credentials: 'include'
+        });
+        if (!response.ok) throw new Error('Failed to convert external contact');
+        const data = await response.json();
+        if (!data?.data?.userInfo?.userID) throw new Error('Invalid response from convert external contact');
+        return data;
+    }
 }
 export { UserService };

package/lib/integrations/services/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types';
 export * from './UserService';
 export * from './DepartmentService';
+export * from './ChatService';
 export * from './UserProfileService';

package/lib/integrations/services/index.js

@@ -1,4 +1,5 @@
 export * from "./types.js";
 export * from "./UserService.js";
 export * from "./DepartmentService.js";
+export * from "./ChatService.js";
 export * from "./UserProfileService.js";

package/lib/integrations/services/types.d.ts

@@ -14,6 +14,8 @@ export type UserInfo = {
     avatar: string;
     userType: '_employee' | '_externalUser' | '_anonymousUser';
     department: DepartmentBasic;
+    email?: string;
+    tenantName?: string;
 };
 export type DepartmentInfo = {
     departmentID: string;
@@ -32,6 +34,7 @@ export type SearchUsersParams = {
     query?: string;
     offset?: number;
     pageSize?: number;
+    searchExternalContact?: boolean;
 };
 export type SearchUsersResponse = {
     data: {
@@ -40,6 +43,14 @@ export type SearchUsersResponse = {
     };
     status_code: string;
 };
+export type ConvertExternalContactResponse = {
+    data: {
+        userInfo: {
+            tenantID: number;
+            userID: number;
+        };
+    };
+};
 export type BatchGetUsersResponse = {
     data: {
         userInfoMap: Record<string, UserInfo & SearchAvatar>;
@@ -61,6 +72,40 @@ export type SearchDepartmentsResponse = {
     };
     status_code: string;
 };
+export type ChatInfo = {
+    /** 群组 ID */
+    chatID: string;
+    /** 群组名称（国际化文本） */
+    name: I18nText;
+    /** 头像：URL 或 16 进制 RGB 颜色 */
+    avatar: string;
+    /** 是否是外部群 */
+    isExternal?: boolean;
+    /** 群成员数量（不包括机器人），搜索接口返回，批量查询接口不返回 */
+    userCount?: number;
+};
+export type SearchChatsParams = {
+    query?: string;
+    offset?: number;
+    pageSize?: number;
+};
+export type SearchChatsResponse = {
+    data: {
+        result: {
+            chatResult?: {
+                total: number;
+                items: ChatInfo[];
+            };
+        };
+    };
+    status_code: string;
+};
+export type BatchGetChatsResponse = {
+    data: {
+        chatInfoMap: Record<string, ChatInfo>;
+    };
+    status_code: string;
+};
 export type UserProfileAccountStatus = 0 | 1 | 2 | 3 | 4;
 export type SimpleUserProfileInfo = {
     name?: string;

package/lib/logger/intercept-global-error.js

@@ -1,5 +1,6 @@
-import { createApplyHandle, getModuleHot } from "../utils/module-hot.js";
-import { submitPostMessage, submitSlardarEvent } from "../utils/postMessage.js";
+import { slardar } from "@lark-apaas/internal-slardar";
+import { getHmrApi } from "../utils/hmr-api.js";
+import { submitPostMessage } from "../utils/postMessage.js";
 import { levelSchema } from "./log-types.js";
 import { logger } from "./logger.js";
 let devServerDisconnectInfo = null;
@@ -19,22 +20,26 @@ function processDevServerLog(log) {
                 status: 'disconnected'
             }
         });
-        submitSlardarEvent({
+        slardar.sendEvent({
             name: 'sandbox-devServer',
-            categories: {
-                type: 'disconnected',
+            metrics: {
                 time
+            },
+            categories: {
+                type: 'disconnected'
             }
         });
         return;
     }
     if (!devServerDisconnectInfo) return;
     if (devFlag && log.includes('Trying to reconnect')) {
-        if (retryCount) submitSlardarEvent({
+        if (retryCount) slardar.sendEvent({
             name: 'sandbox-devServer',
-            categories: {
-                type: 'reconnect-failed',
+            metrics: {
                 retryCount: retryCount + 1
+            },
+            categories: {
+                type: 'reconnect-failed'
             }
         });
         retryCount++;
@@ -52,37 +57,41 @@ function processDevServerLog(log) {
         const startTime = devServerDisconnectInfo.time;
         const duration = Date.now() - startTime;
         devServerDisconnectInfo = null;
-        submitSlardarEvent({
+        slardar.sendEvent({
             name: 'sandbox-devServer',
-            categories: {
-                type: 'devServer-reconnected',
+            metrics: {
                 startTime,
                 duration
+            },
+            categories: {
+                type: 'devServer-reconnected'
             }
         });
     }
 }
 function listenModuleHmr() {
-    const hot = getModuleHot();
-    if (hot) hot.addStatusHandler(createApplyHandle((success, status)=>{
-        if (success) submitPostMessage({
-            type: 'DevServerMessage',
-            data: {
-                type: 'devServer-status',
-                status: 'hmr-apply-success'
-            }
+    const hmr = getHmrApi();
+    if (hmr) {
+        hmr.onSuccess(()=>{
+            submitPostMessage({
+                type: 'DevServerMessage',
+                data: {
+                    type: 'devServer-status',
+                    status: 'hmr-apply-success'
+                }
+            });
         });
-        else {
-            console.warn('hmr apply failed', status);
-            submitSlardarEvent({
+        hmr.onError((error)=>{
+            console.warn('hmr apply failed', error);
+            slardar.sendEvent({
                 name: 'sandbox-devServer',
                 categories: {
                     type: 'hmr-apply-failed',
-                    status
+                    error: String(error)
                 }
             });
-        }
-    }));
+        });
+    }
 }
 function interceptErrors() {
     window.addEventListener('error', (event)=>{

package/lib/logger/log-types.d.ts

@@ -1,7 +1,7 @@
 import z from 'zod';
 export declare const networkRequestLogSchema: z.ZodObject<{
     method: z.ZodString;
-    status: z.ZodInt;
+    status: z.ZodNumber;
     statusText: z.ZodString;
     path: z.ZodString;
     requestData: z.ZodOptional<z.ZodUnknown>;
@@ -27,11 +27,11 @@ export declare const logStackFrameSchema: z.ZodObject<{
     columnNumber: z.ZodNumber;
 }, z.core.$strip>;
 export declare const levelSchema: z.ZodEnum<{
+    error: "error";
     success: "success";
     debug: "debug";
     info: "info";
     warn: "warn";
-    error: "error";
 }>;
 export declare const logMeta: z.ZodObject<{
     stacktrace: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -52,11 +52,11 @@ export declare const logMeta: z.ZodObject<{
 export declare const selectedLogSchema: z.ZodObject<{
     type: z.ZodLiteral<"typedLogV2">;
     level: z.ZodEnum<{
+        error: "error";
         success: "success";
         debug: "debug";
         info: "info";
         warn: "warn";
-        error: "error";
     }>;
     id: z.ZodString;
     args: z.ZodArray<z.ZodUnknown>;
@@ -80,11 +80,11 @@ export declare const selectedLogSchema: z.ZodObject<{
 export type LogLevel = z.infer<typeof levelSchema>;
 export declare const logWithMetaSchema: z.ZodObject<{
     level: z.ZodEnum<{
+        error: "error";
         success: "success";
         debug: "debug";
         info: "info";
         warn: "warn";
-        error: "error";
     }>;
     args: z.ZodArray<z.ZodUnknown>;
     meta: z.ZodOptional<z.ZodObject<{

package/lib/logger/log-types.js

@@ -1,7 +1,7 @@
 import zod from "zod";
 const networkRequestLogSchema = zod.object({
     method: zod.string(),
-    status: zod.int(),
+    status: zod.number().int(),
     statusText: zod.string(),
     path: zod.string(),
     requestData: zod.optional(zod.unknown()),

package/lib/runtime/index.d.ts

@@ -15,6 +15,7 @@
  * - 使用 __FULLSTACK_RUNTIME_INITIALIZED__ 标志位防止重复初始化
  * - 旧版 AppContainer 和新版 runtime 可以共存
  */
+import './react-devtools-hook';
 import './styles';
 declare global {
     interface Window {

package/lib/runtime/index.js

@@ -1,3 +1,4 @@
+import "./react-devtools-hook.js";
 import "./styles.js";
 import { registerDayjsPlugins } from "./dayjs.js";
 import { initAxiosConfig } from "./axios.js";

package/lib/runtime/react-devtools-hook.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Inject minimal __REACT_DEVTOOLS_GLOBAL_HOOK__ before React loads.
+ * React checks for this hook during module initialization and registers its
+ * renderer via hook.inject(). This gives us access to renderer.overrideProps()
+ * for live component prop modification in the inspector.
+ *
+ * Must execute before React's module-level code runs.
+ *
+ * When react-refresh-runtime runs first (as an rspack runtime module),
+ * it may create __REACT_DEVTOOLS_GLOBAL_HOOK__ with an inject() that
+ * doesn't populate the renderers Map. We patch the existing hook to
+ * ensure renderers are always tracked.
+ */
+export {};
+declare global {
+    interface Window {
+        __REACT_DEVTOOLS_GLOBAL_HOOK__?: any;
+    }
+}

package/lib/runtime/react-devtools-hook.js

@@ -0,0 +1,20 @@
+if ('undefined' != typeof window && 'production' !== process.env.NODE_ENV) if (window.__REACT_DEVTOOLS_GLOBAL_HOOK__) {
+    const hook = window.__REACT_DEVTOOLS_GLOBAL_HOOK__;
+    if (!(hook.renderers instanceof Map)) hook.renderers = new Map();
+    const originalInject = 'function' == typeof hook.inject ? hook.inject.bind(hook) : null;
+    hook.inject = function(renderer) {
+        const id = originalInject ? originalInject(renderer) : hook.renderers.size + 1;
+        if (null != id && !hook.renderers.has(id)) hook.renderers.set(id, renderer);
+        return id;
+    };
+} else window.__REACT_DEVTOOLS_GLOBAL_HOOK__ = {
+    renderers: new Map(),
+    supportsFiber: true,
+    inject (renderer) {
+        const id = this.renderers.size + 1;
+        this.renderers.set(id, renderer);
+        return id;
+    },
+    onCommitFiberRoot () {},
+    onCommitFiberUnmount () {}
+};

package/lib/theme-layer.css

@@ -1,3 +1,4 @@
 @layer theme, base, antd, components, utilities;
-@import "tailwindcss";
+@import 'tailwindcss' source(none);
+@source "../**/*.{js,jsx,ts,tsx}";
 

package/lib/utils/apiPath.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 判断当前是否启用新的路径规范
+ * 新路径规范：CLIENT_BASE_PATH 以 /app/:appId 格式开头
+ */
+export declare function isNewPathEnabled(): boolean;

package/lib/utils/apiPath.js

@@ -0,0 +1,5 @@
+function isNewPathEnabled() {
+    const basePath = process.env.CLIENT_BASE_PATH || '/';
+    return /^\/app\/[^/]/.test(basePath);
+}
+export { isNewPathEnabled };

package/lib/utils/axiosConfig.js

@@ -3,6 +3,93 @@ import { observable } from "@lark-apaas/observable-web";
 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)) {
@@ -54,7 +141,7 @@ async function logResponse(ok, responseOrError) {
             logTraceID
         };
         if (stacktrace) logMeta.stacktrace = stacktrace;
-        logger.debug({
+        logger.log({
             level: ok,
             args: [
                 parts.join(''),
@@ -110,7 +197,7 @@ async function logResponse(ok, responseOrError) {
         const stacktrace = await requestStacktraceMap.get(requestUUID);
         const logMeta = {};
         if (stacktrace) logMeta.stacktrace = stacktrace;
-        logger.debug({
+        logger.log({
             level: 'error',
             args: [
                 parts.join(''),
@@ -120,7 +207,7 @@ async function logResponse(ok, responseOrError) {
         });
         return;
     }
-    logger.debug({
+    logger.log({
         level: 'error',
         args: [
             '请求失败：无响应对象或配置信息'
@@ -138,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;
@@ -157,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);
@@ -193,6 +299,10 @@ AxiosProto.request = function(configOrUrl, config) {
         return response;
     }, (error)=>{
         handleSpanEnd(error.config || finalConfig, null, error);
+        slardar.captureException(error, {
+            source: 'toolkit',
+            module: 'axios-request'
+        });
         throw error;
     });
 };
@@ -234,6 +344,12 @@ function initAxiosConfig(axiosInstance) {
         config._startTime = config._startTime || Date.now();
         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)=>{
@@ -241,8 +357,8 @@ function initAxiosConfig(axiosInstance) {
             if (error.response?.status === 403) {
                 const method = (error.config?.method || 'GET').toUpperCase();
                 const url = (error.config?.url || '').split('?')[0];
-                logger.debug({
-                    level: 'warning',
+                logger.log({
+                    level: 'warn',
                     args: [
                         `请求被拒绝(403)：${method} ${url}`,
                         {
@@ -252,9 +368,47 @@ function initAxiosConfig(axiosInstance) {
                     ],
                     meta: {}
                 });
+                slardar.sendEvent({
+                    name: 'toolkit_axios_403_downgrade',
+                    categories: {
+                        url: String(error.config?.url || ''),
+                        method: String(error.config?.method || ''),
+                        ...'production' !== process.env.NODE_ENV && {
+                            responseData: (()=>{
+                                try {
+                                    const data = error.response?.data;
+                                    if (!data) return '';
+                                    return 'string' == typeof data ? data.slice(0, 512) : JSON.stringify(data).slice(0, 512);
+                                } catch  {
+                                    return '';
+                                }
+                            })()
+                        }
+                    }
+                });
                 return error.response;
             }
         } catch (e) {}
+        slardar.sendEvent({
+            name: 'toolkit_axios_response_error',
+            categories: {
+                url: String(error.config?.url || ''),
+                method: String(error.config?.method || ''),
+                status: String(error.response?.status || ''),
+                ...'production' !== process.env.NODE_ENV && {
+                    errorMessage: String(error.message || ''),
+                    responseData: (()=>{
+                        try {
+                            const data = error.response?.data;
+                            if (!data) return '';
+                            return 'string' == typeof data ? data.slice(0, 512) : JSON.stringify(data).slice(0, 512);
+                        } catch  {
+                            return '';
+                        }
+                    })()
+                }
+            }
+        });
         return Promise.reject(error);
     });
     'production' !== process.env.NODE_ENV && instance.interceptors.response.use((response)=>{

package/lib/utils/getAppId.d.ts

@@ -1,6 +1,4 @@
 /**
- * 提取固定前缀后的第一个目录名
- * @param {string} path - 输入路径字符串
- * @returns {string|null} - 提取的目录名或null
+ * 获取应用 ID
  */
-export declare function getAppId(path: string): string | null;
+export declare function getAppId(): string | null;

package/lib/utils/getAppId.js

@@ -1,12 +1,5 @@
-function getAppId(path) {
-    if (window.MIAODA_APP_ID) return window.MIAODA_APP_ID;
-    let prefix;
-    prefix = path.includes('/ai/feida/runtime/') ? '/ai/feida/runtime/' : path.includes('/spark/r/') ? '/spark/r/' : '/ai/miaoda/';
+function getAppId() {
     const windowAppId = window.appId || null;
-    if (!path.startsWith(prefix)) return windowAppId;
-    const remainder = path.substring(prefix.length);
-    const nextSlashIndex = remainder.indexOf('/');
-    if (-1 === nextSlashIndex) return remainder || windowAppId;
-    return remainder.substring(0, nextSlashIndex) || windowAppId;
+    return windowAppId;
 }
 export { getAppId };

package/lib/utils/getInitialInfo.d.ts

@@ -13,9 +13,10 @@ interface AppRuntimePublished {
 interface BucketConfig {
     default_bucket_id?: string;
 }
-/** 获取应用初始化信息（仅全栈沙箱模式下使用） */
-export declare function getInitialInfo(refresh?: boolean): Promise<{
+declare let initialInfo: {
     app_info?: AppRuntimePublished;
     app_runtime_extra?: AppRuntimeExtra;
-}>;
+} | undefined;
+/** 获取应用初始化信息（仅全栈沙箱模式下使用） */
+export declare function getInitialInfo(refresh?: boolean): Promise<typeof initialInfo>;
 export {};