@lark-apaas/dataloom 0.1.3-alpha.3 → 0.1.3-alpha.4

package/lib/service/index.js

@@ -1,4 +1,4 @@
-const MIGRATION_HINT = "[dataloom] service.user / service.session has moved to @lark-apaas/auth-sdk\nUse `authClient` from @lark-apaas/client-toolkit/auth (or @lark-apaas/auth-sdk), e.g.:\n  import { authClient } from '@lark-apaas/client-toolkit/auth';\n  await authClient.user.search({ name: '张三' });\nIf you really need to keep using dataloom.service.*, ensure client-toolkit injects accountServices when constructing DataloomClient.";
+const MIGRATION_HINT = "[dataloom] service.user / service.session has moved to @lark-apaas/auth-sdk\nUse `authClient` from @lark-apaas/client-toolkit/auth (or @lark-apaas/auth-sdk), e.g.:\n  import { authClient } from '@lark-apaas/client-toolkit/auth';\n  await authClient.user.search({ name: 'zhangsan' });\nIf you really need to keep using dataloom.service.*, ensure client-toolkit injects accountServices when constructing DataloomClient.";
 const ALLOWED_REFLECTION_KEYS = new Set([
     'constructor',
     'then',

package/lib/service/types.d.ts

@@ -1,33 +1,105 @@
 /**
- * 用户服务形状契约（结构性 interface，不 import auth-sdk 的具体实现）。
+ * Account services 形状契约。
  *
- * 与 @lark-apaas/auth-sdk 中 `UserService` 的 public 方法对齐；
- * 返回值故意用 `unknown` 以避免把 auth-sdk 的领域类型（如 AccountServiceResponse / UserResponse）
- * 反向引入 dataloom——dataloom 不关心具体返回结构，只关心"形状"。
+ * dataloom 自身不持有 user/session 实现（已迁出至 @lark-apaas/auth-sdk），
+ * 但仍需要类型上的"形状契约"以保证：
+ *   1. DataloomService.user/session 字段对老调用方有完整类型提示；
+ *   2. client-toolkit 注入 authClient.user/session 时编译期可结构性校验。
+ *
+ * 此处类型镜像自 auth-sdk 的 public 类型（保持结构一致），
+ * 但**不 import auth-sdk**，避免 dataloom → auth-sdk 的反向依赖。
+ *
+ * @see packages/client/auth-sdk/src/account/services/user-service/types.ts
+ * @see packages/client/auth-sdk/src/account/services/session-service/types.ts
+ */
+export interface AccountServiceError {
+    code: number;
+    details: string;
+    hint: string | null;
+    message: string;
+}
+interface AccountServiceBase {
+    status: number;
+    statusText: string;
+}
+export interface AccountServiceSuccess<T> extends AccountServiceBase {
+    error: null;
+    data: T;
+}
+export interface AccountServiceFailure extends AccountServiceBase {
+    error: AccountServiceError;
+    data: null;
+}
+export type AccountServiceResponse<T> = AccountServiceSuccess<T> | AccountServiceFailure;
+/** 与 auth-sdk UserStatus 对齐：1 = active / 2 = inactive */
+export type UserStatus = 1 | 2;
+export interface User {
+    user_id: string;
+    email: string;
+    name: string;
+    avatar: string;
+    status: UserStatus;
+}
+export interface SearchParams {
+    name: string;
+    pageSize?: number;
+}
+export interface UserResponse {
+    user_list: User[];
+}
+/**
+ * 用户服务形状契约（与 auth-sdk `UserService` public 方法对齐）。
  */
 export interface UserServiceShape {
-    search(params: {
-        name: string;
-        pageSize?: number;
-    }): Promise<unknown>;
-    getByIds(ids: string[] | number[]): Promise<unknown>;
+    search(params: SearchParams): Promise<AccountServiceResponse<UserResponse>>;
+    getByIds(ids: string[] | number[]): Promise<AccountServiceResponse<UserResponse>>;
+}
+export interface I18n {
+    language_code: number;
+    text: string;
+}
+export type I18ns = I18n[];
+export interface Avatar {
+    source?: string;
+    image?: {
+        large?: string;
+    };
+    color?: string;
+}
+export interface UserBaseInfo {
+    user_id?: number;
+    name?: I18ns;
+    avatar?: Avatar;
+    email?: string;
+    phone_number?: string;
+    tenant_name?: string;
+}
+export interface UserInfoResponse {
+    user_info?: UserBaseInfo;
+}
+export interface SignInRedirectionOptions {
+    /** The URL to redirect to after a successful login. Defaults to the current URL. */
+    returnUrl?: string;
+    /** Whether to open the login page in a new tab. Defaults to `false`. */
+    newTab?: boolean;
+}
+export interface NavigateToUserProfileOptions {
+    newTab?: boolean;
 }
 /**
- * 会话服务形状契约（结构性 interface，不 import auth-sdk 的具体实现）。
+ * 会话服务形状契约（与 auth-sdk `SessionService` public 方法对齐）。
  *
- * 与 @lark-apaas/auth-sdk 中 `SessionService` 的 public 方法对齐。
+ * 注意：`redirectToLogin` / `navigateToUserProfile` 的成功分支在 auth-sdk
+ * 实现中返回 `data: 'success'`；但其中 `navigateToUserProfile` 未显式标注
+ * 返回类型，TS 会把字面量推断为 `string`。为了让 auth-sdk 的实例可结构性
+ * 赋值到本契约，这里成功分支用 `string` 而非 `'success'` 字面量。
  */
 export interface SessionServiceShape {
-    redirectToLogin(options?: {
-        returnUrl?: string;
-        newTab?: boolean;
-    }): unknown;
-    signOut(): Promise<unknown>;
+    redirectToLogin(options?: SignInRedirectionOptions): AccountServiceResponse<string>;
+    signOut(): Promise<AccountServiceResponse<null>>;
     getUrlWithBizSource(): string;
-    getUserInfo(): Promise<unknown>;
-    navigateToUserProfile(options?: {
-        newTab?: boolean;
-    }): unknown;
+    getUserInfo(): Promise<AccountServiceResponse<UserInfoResponse>>;
+    navigateToUserProfile(options?: NavigateToUserProfileOptions): AccountServiceResponse<string>;
 }
 /**
  * 注入到 DataloomService 的 account services 引用。
@@ -37,4 +109,5 @@ export interface AccountServicesInjection {
     user: UserServiceShape;
     session: SessionServiceShape;
 }
+export {};
 //# sourceMappingURL=types.d.ts.map

package/lib/service/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/service/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACtE,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC;IAC7E,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5B,mBAAmB,IAAI,MAAM,CAAC;IAC9B,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,qBAAqB,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC;CAChE;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,EAAE,mBAAmB,CAAC;CAC9B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/service/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAIH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,kBAAkB;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC,CAAE,SAAQ,kBAAkB;IAClE,KAAK,EAAE,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D,KAAK,EAAE,mBAAmB,CAAC;IAC3B,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAChC,qBAAqB,CAAC,CAAC,CAAC,GACxB,qBAAqB,CAAC;AAI1B,yDAAyD;AACzD,MAAM,MAAM,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC;AAE/B,MAAM,WAAW,IAAI;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,IAAI,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC;IAC5E,QAAQ,CACN,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GACvB,OAAO,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC;CAClD;AAID,MAAM,WAAW,IAAI;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,KAAK,GAAG,IAAI,EAAE,CAAC;AAE3B,MAAM,WAAW,MAAM;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,oFAAoF;IACpF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wEAAwE;IACxE,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,CACb,OAAO,CAAC,EAAE,wBAAwB,GACjC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAClC,OAAO,IAAI,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,mBAAmB,IAAI,MAAM,CAAC;IAC9B,WAAW,IAAI,OAAO,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACjE,qBAAqB,CACnB,OAAO,CAAC,EAAE,4BAA4B,GACrC,sBAAsB,CAAC,MAAM,CAAC,CAAC;CACnC;AAID;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,EAAE,mBAAmB,CAAC;CAC9B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/dataloom",
-  "version": "0.1.3-alpha.3",
+  "version": "0.1.3-alpha.4",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
   "files": [