@lark-apaas/client-toolkit 1.2.56-alpha.0 → 1.2.56-beta.0

package/lib/hooks/useCurrentUserProfile.d.ts

@@ -1,10 +1,11 @@
 import { IUserProfile } from '../apis/udt-types';
 /**
  * useCurrentUserProfile 的返回类型。
- * 与 client-toolkit-lite 完全一致：所有字段保证非 undefined（未加载时为空字符串），
- * 使用 `if (!userInfo.user_id)` 判断是否已加载完成。
+ * 初始状态为空对象 `{}`（所有字段均为 undefined），异步获取用户信息后字段才会被填充。
+ * 使用时必须通过可选链或空值合并进行安全访问，如 `userInfo?.user_id`。
+ * 判断是否已加载完成应使用 `if (!userInfo?.user_id)` 而非 `if (!userInfo)`（因为空对象是 truthy）。
  */
-export interface ICompatibilityUserProfile extends IUserProfile {
+export type ICompatibilityUserProfile = Partial<IUserProfile & {
     /**
      * @deprecated please use `name`
      */
@@ -13,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/hooks/useCurrentUserProfile.js

@@ -25,14 +25,9 @@ function fetchLarkUserId() {
 function getCompatibilityUserProfile() {
     const userInfo = getCurrentUserProfile();
     return {
-        user_id: userInfo.user_id ?? '',
-        email: userInfo.email ?? '',
-        name: userInfo.name ?? '',
-        avatar: userInfo.avatar ?? '',
-        status: userInfo.status,
-        lark_user_id: userInfo.lark_user_id,
-        userName: userInfo.name ?? '',
-        userAvatar: userInfo.avatar ?? ''
+        ...userInfo,
+        userName: userInfo.name,
+        userAvatar: userInfo.avatar
     };
 }
 const useCurrentUserProfile = ()=>{
@@ -43,15 +38,14 @@ const useCurrentUserProfile = ()=>{
             const result = await authClient.session.getUserInfo();
             if (cancelled) return;
             const info = result?.data?.user_info;
-            const userName = getNameFromArray(info?.name) ?? '';
-            const avatar = info?.avatar?.image?.large ?? '';
+            const userName = getNameFromArray(info?.name);
             const newUserInfo = {
-                user_id: info?.user_id?.toString() ?? '',
-                email: info?.email ?? '',
+                user_id: info?.user_id?.toString(),
+                email: info?.email,
                 name: userName,
-                avatar,
+                avatar: info?.avatar?.image?.large,
                 userName,
-                userAvatar: avatar
+                userAvatar: info?.avatar?.image?.large
             };
             const larkUserId = await fetchLarkUserId();
             if (larkUserId) newUserInfo.lark_user_id = larkUserId;

package/lib/integrations/dataloom.d.ts

@@ -1,4 +1,4 @@
-declare const createDataLoomClient: () => import("@lark-apaas/dataloom").DataloomClient;
+declare const createDataLoomClient: (url?: string, pat?: string) => import("@lark-apaas/dataloom").DataloomClient;
 /** 获取dataloom实例 */
 export declare function getDataloom(): Promise<ReturnType<typeof createDataLoomClient>>;
 export {};

package/lib/integrations/dataloom.js

@@ -1,10 +1,14 @@
+import { splitWorkspaceUrl } from "../utils/url.js";
 import { createClient } from "@lark-apaas/dataloom";
 import { authClient } from "@lark-apaas/auth-sdk";
 import { getAppId } from "../utils/getAppId.js";
-import { getInitialInfo } from "../utils/getInitialInfo.js";
-const createDataLoomClient = ()=>{
+import { getAppPublished } from "../utils/getInitialInfo.js";
+const createDataLoomClient = (url, pat)=>{
+    const { baseUrl } = url ? splitWorkspaceUrl(url) : {
+        baseUrl: ''
+    };
     const appId = getAppId();
-    return createClient({
+    return createClient(baseUrl, pat, {
         global: {
             enableDataloomLog: 'production' !== process.env.NODE_ENV,
             requestRateLimit: 'production' !== process.env.NODE_ENV ? 100 : void 0,
@@ -22,8 +26,10 @@ let pendingPromise = null;
 function getDataloom() {
     if (dataloom) return Promise.resolve(dataloom);
     if (pendingPromise) return pendingPromise;
-    pendingPromise = getInitialInfo().then(()=>{
-        dataloom = createDataLoomClient();
+    pendingPromise = getAppPublished().then((info)=>{
+        const DATALOOM_CLIENT_URL = info?.app_runtime_extra?.url;
+        const DATALOOM_PAT = info?.app_runtime_extra?.token;
+        dataloom = createDataLoomClient(DATALOOM_CLIENT_URL, DATALOOM_PAT);
         return dataloom;
     }).finally(()=>{
         pendingPromise = null;

package/lib/integrations/getCurrentUserProfile.d.ts

@@ -1,10 +1,11 @@
 import { IUserProfile } from '../apis/udt-types';
 /**
  * 获取当前用户信息。
- * 与 client-toolkit-lite 一致返回 IUserProfile（非 Partial）；
- * 调用方需自行处理 window._userInfo 未就绪时空对象的情况。
+ * 返回 Partial<IUserProfile>，因为初始值来自 window._userInfo，
+ * 该值在运行时始终为空对象 {}，所有字段均为 undefined。
+ * 异步获取用户信息后才会被填充为完整的 IUserProfile。
  */
-export declare function getCurrentUserProfile(): IUserProfile;
+export declare function getCurrentUserProfile(): Partial<IUserProfile>;
 /**
  * @deprecated 请使用 getCurrentUserProfile 代替
  */

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

@@ -6,6 +6,15 @@ export type I18nText = {
 export type DepartmentBasic = {
     departmentID: string;
     name: I18nText;
+    /** 飞书部门 open id（od- 开头），调飞书部门能力时使用 */
+    openDepartmentID?: string;
+};
+/** 直属上级 / 虚线上级，仅在 needFullFields 时返回 */
+export type LeaderUser = {
+    /** 飞书企业内 user_id */
+    employeeID?: string;
+    /** 妙搭用户全局唯一 ID */
+    miaodaUserID?: string;
 };
 export type UserInfo = {
     userID: string;
@@ -16,11 +25,32 @@ export type UserInfo = {
     department: DepartmentBasic;
     email?: string;
     tenantName?: string;
+    /** 妙搭用户全局唯一 ID（来源同 userID，向前兼容别名） */
+    miaodaUserID?: string;
+    /** 飞书企业内 user_id，仅内部飞书用户；调飞书开放平台能力时使用 */
+    employeeID?: string;
+    /** 飞书用户全局唯一 ID（来源同 larkUserID 别名） */
+    larkID?: string;
+    nickname?: string;
+    mobile?: string;
+    gender?: number;
+    country?: string;
+    workStation?: string;
+    employeeNo?: string;
+    city?: string;
+    jobTitle?: string;
+    employeeType?: number;
+    /** 直属上级 */
+    leader?: LeaderUser;
+    /** 虚线上级 */
+    dottedLineLeaders?: LeaderUser[];
 };
 export type DepartmentInfo = {
     departmentID: string;
     larkDepartmentID: string;
     name: I18nText;
+    /** 飞书部门 open id（od- 开头） */
+    openDepartmentID?: string;
 };
 export type AccountType = 'apaas' | 'lark';
 export type SearchAvatar = {
@@ -35,6 +65,8 @@ export type SearchUsersParams = {
     offset?: number;
     pageSize?: number;
     searchExternalContact?: boolean;
+    /** 是否返回 full 字段（手机号/职位/上级等），默认 false */
+    needFullFields?: boolean;
 };
 export type SearchUsersResponse = {
     data: {
@@ -75,6 +107,8 @@ export type SearchDepartmentsResponse = {
 export type ChatInfo = {
     /** 群组 ID */
     chatID: string;
+    /** 飞书群组 open id（oc_ 开头），调飞书群组能力时使用 */
+    openChatID?: string;
     /** 群组名称（国际化文本） */
     name: I18nText;
     /** 头像：URL 或 16 进制 RGB 颜色 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/client-toolkit",
-  "version": "1.2.56-alpha.0",
+  "version": "1.2.56-beta.0",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
   "files": [
@@ -102,7 +102,7 @@
     "@lark-apaas/aily-web-sdk": "^0.0.11",
     "@lark-apaas/auth-sdk": "^0.1.5",
     "@lark-apaas/client-capability": "^0.1.7",
-    "@lark-apaas/dataloom": "0.1.4-alpha.10",
+    "@lark-apaas/dataloom": "^0.1.3",
     "@lark-apaas/internal-slardar": "^0.0.3",
     "@lark-apaas/miaoda-inspector": "^1.0.23",
     "@lark-apaas/observable-web": "^1.0.6",

package/lib/integrations/__test__/dataloom.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/integrations/__test__/dataloom.test.js

@@ -1,83 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { getDataloom } from "../dataloom.js";
-const { getInitialInfoMock, getAppPublishedMock, getAppIdMock, createClientMock, authUserMock, authSessionMock } = vi.hoisted(()=>({
-        getInitialInfoMock: vi.fn(),
-        getAppPublishedMock: vi.fn(),
-        getAppIdMock: vi.fn(),
-        createClientMock: vi.fn(),
-        authUserMock: {},
-        authSessionMock: {}
-    }));
-vi.mock('../../utils/getInitialInfo', ()=>({
-        getInitialInfo: getInitialInfoMock,
-        getAppPublished: getAppPublishedMock
-    }));
-vi.mock('../../utils/getAppId', ()=>({
-        getAppId: getAppIdMock
-    }));
-vi.mock('@lark-apaas/dataloom', ()=>({
-        createClient: createClientMock
-    }));
-vi.mock('@lark-apaas/auth-sdk', ()=>({
-        authClient: {
-            user: authUserMock,
-            session: authSessionMock
-        }
-    }));
-beforeEach(()=>{
-    getInitialInfoMock.mockReset();
-    getAppPublishedMock.mockReset();
-    getAppIdMock.mockReset();
-    createClientMock.mockReset();
-});
-afterEach(()=>{
-    vi.restoreAllMocks();
-});
-describe('getDataloom', ()=>{
-    it('返回-createClient实例-改用getInitialInfo-新签名不取token/url-appId注入-并发去重-缓存复用', async ()=>{
-        getAppIdMock.mockReturnValue('app-1');
-        getInitialInfoMock.mockResolvedValue({
-            app_runtime_extra: {
-                token: 'pat',
-                url: 'https://x'
-            }
-        });
-        const client = {
-            __id: 'client-1'
-        };
-        createClientMock.mockReturnValue(client);
-        const p1 = getDataloom();
-        const p2 = getDataloom();
-        expect(p1).toBe(p2);
-        const [c1, c2] = await Promise.all([
-            p1,
-            p2
-        ]);
-        expect(c1).toBe(client);
-        expect(c2).toBe(client);
-        expect(getInitialInfoMock).toHaveBeenCalledTimes(1);
-        expect(getAppPublishedMock).not.toHaveBeenCalled();
-        expect(createClientMock).toHaveBeenCalledTimes(1);
-        const args = createClientMock.mock.calls[0];
-        expect(args).toHaveLength(1);
-        const options = args[0];
-        expect(typeof options).toBe('object');
-        expect(options).not.toBe('https://x');
-        expect(options).not.toBe('pat');
-        expect(options.global).toBeDefined();
-        expect(options.global).not.toHaveProperty('url');
-        expect(options.global).not.toHaveProperty('key');
-        expect(options.global?.appId).toBe('app-1');
-        expect(options.global?.accountServices).toEqual({
-            user: authUserMock,
-            session: authSessionMock
-        });
-        const cached1 = await getDataloom();
-        const cached2 = await getDataloom();
-        expect(cached1).toBe(client);
-        expect(cached2).toBe(client);
-        expect(cached1).toBe(cached2);
-        expect(getInitialInfoMock).toHaveBeenCalledTimes(1);
-        expect(createClientMock).toHaveBeenCalledTimes(1);
-    });
-});