@turinhub/tale-js-sdk 1.3.0 → 2.0.0

package/dist/user/index.js

@@ -20,7 +20,7 @@ import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
  *     nickname: 'John Doe',
  *     email: 'john@example.com'
  *   });
- *   console.log('User created:', result.user.user_id);
+ *   console.log('User created:', result.user.userId);
  * } catch (error) {
  *   console.error('Failed to create user:', error.message);
  * }
@@ -39,7 +39,7 @@ export async function createUser(userData, options) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = String(base).replace(/\/+$/, "") + "/account/v1/user";
+    const url = String(base).replace(/\/+$/, "") + "/account/v2/user";
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -76,7 +76,7 @@ export async function createUser(userData, options) {
 /**
  * Retrieves user information by ID or open ID.
  *
- * @param userId - Optional user ID (open_id) to query. If not provided, returns current user info
+ * @param userId - Optional user ID (openId) to query. If not provided, returns current user info
  * @param options - Optional parameters for inclusion flags and configuration
  * @returns Promise resolving to the user information
  * @throws {ConfigurationError} When required environment variables are missing
@@ -88,7 +88,7 @@ export async function createUser(userData, options) {
  * import { getUserById } from '@tale/client';
  *
  * try {
- *   const result = await getUserById('user_open_id_here');
+ *   const result = await getUserById('userOpenId_here');
  *   console.log('User info:', result.user.username);
  * } catch (error) {
  *   console.error('Failed to get user:', error.message);
@@ -105,14 +105,14 @@ export async function getUserById(userId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     // Build URL with query parameters
-    const url = new URL(String(base).replace(/\/+$/, "") + "/account/v1/user");
+    const url = new URL(String(base).replace(/\/+$/, "") + "/account/v2/user");
     // Add query parameters
     const queryParams = {
-        user_id: userId,
-        include_rbac: true,
-        include_login_methods: true,
-        include_user_groups: true,
-        include_acl: false,
+        userId: userId,
+        includeRbac: true,
+        includeLoginMethods: true,
+        includeUserGroups: true,
+        includeAcl: false,
         ...options,
     };
     Object.entries(queryParams).forEach(([key, value]) => {
@@ -155,7 +155,7 @@ export async function getUserById(userId, options) {
 /**
  * Deletes a user by ID or open ID.
  *
- * @param userId - User ID (open_id) to delete
+ * @param userId - User ID (openId) to delete
  * @param options - Optional configuration for the request
  * @returns Promise resolving to the deletion result
  * @throws {ConfigurationError} When required environment variables are missing
@@ -167,7 +167,7 @@ export async function getUserById(userId, options) {
  * import { deleteUser } from '@tale/client';
  *
  * try {
- *   const result = await deleteUser('user_open_id_here');
+ *   const result = await deleteUser('userOpenId_here');
  *   console.log('User deleted:', result.deleted);
  * } catch (error) {
  *   console.error('Failed to delete user:', error.message);
@@ -177,7 +177,7 @@ export async function getUserById(userId, options) {
 export async function deleteUser(userId, options) {
     // Validate required fields
     if (!userId || userId.trim() === "") {
-        throw new ApiError("user_id is required for deletion", 400, "9400");
+        throw new ApiError("userId is required for deletion", 400, "9400");
     }
     // Use provided app token or get one from token service
     const token = options?.appToken ?? (await getAppToken(options));
@@ -188,7 +188,7 @@ export async function deleteUser(userId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = String(base).replace(/\/+$/, "") +
-        `/account/v1/users/${encodeURIComponent(userId)}`;
+        `/account/v2/users/${encodeURIComponent(userId)}`;
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -239,10 +239,9 @@ export async function deleteUser(userId, options) {
  *     page: 0,
  *     size: 20,
  *     keyword: 'john',
- *     sort_by: 'username',
- *     sort_direction: 'asc'
+ *     sort: 'username,asc'
  *   });
- *   console.log(`Found ${result.totalElements} users`);
+ *   console.log(`Found ${result.total} users`);
  *   console.log('First user:', result.content[0].user.username);
  * } catch (error) {
  *   console.error('Failed to list users:', error.message);
@@ -259,25 +258,24 @@ export async function listUsers(options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     // Build URL with query parameters
-    const url = new URL(String(base).replace(/\/+$/, "") + "/account/v1/users");
+    const url = new URL(String(base).replace(/\/+$/, "") + "/account/v2/users");
     // Add query parameters with defaults
     const queryParams = {
         page: 0,
         size: 20,
-        sort_by: "createdAt",
-        sort_direction: "desc",
-        include_attributes: false,
+        sort: "createdAt,desc",
+        includeAttributes: false,
         ...options,
     };
     // Handle array parameters (need to be comma-separated)
-    if (queryParams.user_groups && queryParams.user_groups.length > 0) {
-        url.searchParams.append("user_groups", queryParams.user_groups.join(","));
+    if (queryParams.userGroups && queryParams.userGroups.length > 0) {
+        url.searchParams.append("userGroups", queryParams.userGroups.join(","));
     }
-    if (queryParams.user_roles && queryParams.user_roles.length > 0) {
-        url.searchParams.append("user_roles", queryParams.user_roles.join(","));
+    if (queryParams.userRoles && queryParams.userRoles.length > 0) {
+        url.searchParams.append("userRoles", queryParams.userRoles.join(","));
     }
-    if (queryParams.user_ids && queryParams.user_ids.length > 0) {
-        url.searchParams.append("user_ids", queryParams.user_ids.join(","));
+    if (queryParams.userIds && queryParams.userIds.length > 0) {
+        url.searchParams.append("userIds", queryParams.userIds.join(","));
     }
     // Add other parameters
     if (queryParams.page !== undefined) {
@@ -286,17 +284,14 @@ export async function listUsers(options) {
     if (queryParams.size !== undefined) {
         url.searchParams.append("size", String(queryParams.size));
     }
-    if (queryParams.sort_by) {
-        url.searchParams.append("sort_by", queryParams.sort_by);
-    }
-    if (queryParams.sort_direction) {
-        url.searchParams.append("sort_direction", queryParams.sort_direction);
+    if (queryParams.sort) {
+        url.searchParams.append("sort", queryParams.sort);
     }
     if (queryParams.keyword) {
         url.searchParams.append("keyword", queryParams.keyword);
     }
-    if (queryParams.include_attributes !== undefined) {
-        url.searchParams.append("include_attributes", String(queryParams.include_attributes));
+    if (queryParams.includeAttributes !== undefined) {
+        url.searchParams.append("includeAttributes", String(queryParams.includeAttributes));
     }
     let response;
     try {
@@ -333,7 +328,7 @@ export async function listUsers(options) {
 /**
  * Updates user information by user ID or open ID.
  *
- * @param userId - User ID (open_id) to update
+ * @param userId - User ID (openId) to update
  * @param userData - User data to update
  * @param options - Optional configuration for the request
  * @returns Promise resolving to the update result
@@ -346,8 +341,8 @@ export async function listUsers(options) {
  * import { updateUser } from '@tale/client';
  *
  * try {
- *   const result = await updateUser('user_open_id_here', {
- *     nick_name: 'John Doe',
+ *   const result = await updateUser('userOpenId_here', {
+ *     nickName: 'John Doe',
  *     email: 'john@example.com'
  *   });
  *   console.log('User updated:', result.success);
@@ -370,7 +365,7 @@ export async function updateUser(userId, userData, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = String(base).replace(/\/+$/, "") +
-        `/account/v1/user/${encodeURIComponent(userId)}`;
+        `/account/v2/user/${encodeURIComponent(userId)}`;
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -400,13 +395,13 @@ export async function updateUser(userId, userData, options) {
     }
     return {
         success: true,
-        user_id: userId,
+        userId: userId,
     };
 }
 /**
  * Updates user password.
  *
- * @param passwordData - Password data including user_id and encrypted password
+ * @param passwordData - Password data including userId and encrypted password
  * @param options - Optional configuration for the request
  * @returns Promise resolving to the update result
  * @throws {ConfigurationError} When required environment variables are missing
@@ -419,8 +414,8 @@ export async function updateUser(userId, userData, options) {
  *
  * try {
  *   const result = await updateUserPassword({
- *     user_id: 'user_open_id_here',
- *     password_encrypted: 'encrypted_password_here'
+ *     userId: 'userOpenId_here',
+ *     passwordEncrypted: 'encrypted_password_here'
  *   });
  *   console.log('Password updated:', result.success);
  * } catch (error) {
@@ -430,12 +425,12 @@ export async function updateUser(userId, userData, options) {
  */
 export async function updateUserPassword(passwordData, options) {
     // Validate required fields
-    if (!passwordData.user_id || passwordData.user_id.trim() === "") {
-        throw new ApiError("user_id is required for password update", 400, "9400");
+    if (!passwordData.userId || passwordData.userId.trim() === "") {
+        throw new ApiError("userId is required for password update", 400, "9400");
     }
-    if (!passwordData.password_encrypted ||
-        passwordData.password_encrypted.trim() === "") {
-        throw new ApiError("password_encrypted is required", 400, "9400");
+    if (!passwordData.passwordEncrypted ||
+        passwordData.passwordEncrypted.trim() === "") {
+        throw new ApiError("passwordEncrypted is required", 400, "9400");
     }
     // Use provided app token or get one from token service
     const token = options?.appToken ?? (await getAppToken(options));
@@ -445,7 +440,7 @@ export async function updateUserPassword(passwordData, options) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = String(base).replace(/\/+$/, "") + "/account/v1/user/password";
+    const url = String(base).replace(/\/+$/, "") + "/account/v2/user/password";
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -475,14 +470,14 @@ export async function updateUserPassword(passwordData, options) {
     }
     return {
         success: true,
-        user_id: passwordData.user_id,
+        userId: passwordData.userId,
     };
 }
 /**
  * Uploads user avatar image.
  *
  * @param file - File object to upload as avatar
- * @param userId - User ID (open_id) of the user
+ * @param userId - User ID (openId) of the user
  * @param options - Optional configuration for the request
  * @returns Promise resolving to the upload result with avatar OSS key
  * @throws {ConfigurationError} When required environment variables are missing
@@ -496,8 +491,8 @@ export async function updateUserPassword(passwordData, options) {
  * try {
  *   const fileInput = document.querySelector('input[type="file"]');
  *   const file = fileInput.files[0];
- *   const result = await uploadAvatar(file, 'user_open_id_here');
- *   console.log('Avatar uploaded:', result.avatar_oss_key);
+ *   const result = await uploadAvatar(file, 'userOpenId_here');
+ *   console.log('Avatar uploaded:', result.avatarOssKey);
  * } catch (error) {
  *   console.error('Failed to upload avatar:', error.message);
  * }
@@ -519,11 +514,11 @@ export async function uploadAvatar(file, userId, options) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = String(base).replace(/\/+$/, "") + "/account/v1/user/avatar/upload";
+    const url = String(base).replace(/\/+$/, "") + "/account/v2/user/avatar/upload";
     // Create FormData
     const formData = new FormData();
     formData.append("file", file);
-    formData.append("user_open_id", userId);
+    formData.append("userOpenId", userId);
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -551,8 +546,8 @@ export async function uploadAvatar(file, userId, options) {
         throw new ApiError(errorMsg, response.status, json.code);
     }
     // Validate response structure
-    if (!json.data || !json.data.avatar_oss_key) {
-        throw new ApiError("Invalid avatar upload response: missing avatar_oss_key", response.status);
+    if (!json.data || !json.data.avatarOssKey) {
+        throw new ApiError("Invalid avatar upload response: missing avatarOssKey", response.status);
     }
     return json.data;
 }
@@ -629,8 +624,8 @@ export async function getAvatarPresignedUrl(ossKey, options) {
 /**
  * Updates user frozen status (freeze or unfreeze a user account).
  *
- * @param userId - User ID (open_id) to update frozen status
- * @param frozenData - Frozen status data including is_frozen flag and optional remark
+ * @param userId - User ID (openId) to update frozen status
+ * @param frozenData - Frozen status data including isFrozen flag and optional remark
  * @param options - Optional configuration for the request
  * @returns Promise resolving to the updated frozen status information
  * @throws {ConfigurationError} When required environment variables are missing
@@ -643,18 +638,18 @@ export async function getAvatarPresignedUrl(ossKey, options) {
  *
  * try {
  *   // Freeze a user account
- *   const result = await updateUserFrozenStatus('user_open_id_here', {
- *     is_frozen: true,
+ *   const result = await updateUserFrozenStatus('userOpenId_here', {
+ *     isFrozen: true,
  *     remark: 'Violated community guidelines'
  *   });
- *   console.log('User frozen:', result.is_frozen);
+ *   console.log('User frozen:', result.isFrozen);
  *
  *   // Unfreeze a user account
- *   const unfrozenResult = await updateUserFrozenStatus('user_open_id_here', {
- *     is_frozen: false,
+ *   const unfrozenResult = await updateUserFrozenStatus('userOpenId_here', {
+ *     isFrozen: false,
  *     remark: 'Account reactivated'
  *   });
- *   console.log('User unfrozen:', !unfrozenResult.is_frozen);
+ *   console.log('User unfrozen:', !unfrozenResult.isFrozen);
  * } catch (error) {
  *   console.error('Failed to update frozen status:', error.message);
  * }
@@ -665,8 +660,8 @@ export async function updateUserFrozenStatus(userId, frozenData, options) {
     if (!userId || userId.trim() === "") {
         throw new ApiError("userId is required for updating frozen status", 400, "9400");
     }
-    if (frozenData.is_frozen === undefined || frozenData.is_frozen === null) {
-        throw new ApiError("is_frozen is required", 400, "9400");
+    if (frozenData.isFrozen === undefined || frozenData.isFrozen === null) {
+        throw new ApiError("isFrozen is required", 400, "9400");
     }
     // Use provided app token or get one from token service
     const token = options?.appToken ?? (await getAppToken(options));
@@ -677,7 +672,7 @@ export async function updateUserFrozenStatus(userId, frozenData, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = String(base).replace(/\/+$/, "") +
-        `/account/v1/user/${encodeURIComponent(userId)}/frozen-status`;
+        `/account/v2/user/${encodeURIComponent(userId)}/frozen-status`;
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -708,7 +703,7 @@ export async function updateUserFrozenStatus(userId, frozenData, options) {
         throw new ApiError(errorMsg, response.status, json.code);
     }
     // Validate response structure
-    if (!json.data || json.data.user_id === undefined) {
+    if (!json.data || json.data.userId === undefined) {
         throw new ApiError("Invalid frozen status update response: missing required data", response.status);
     }
     return json.data;
@@ -716,7 +711,7 @@ export async function updateUserFrozenStatus(userId, frozenData, options) {
 /**
  * Gets user frozen status by user ID.
  *
- * @param userId - User ID (open_id) to query frozen status
+ * @param userId - User ID (openId) to query frozen status
  * @param options - Optional configuration for the request
  * @returns Promise resolving to the user frozen status information
  * @throws {ConfigurationError} When required environment variables are missing
@@ -728,10 +723,10 @@ export async function updateUserFrozenStatus(userId, frozenData, options) {
  * import { getUserFrozenStatus } from '@tale/client';
  *
  * try {
- *   const status = await getUserFrozenStatus('user_open_id_here');
- *   console.log('User is frozen:', status.is_frozen);
+ *   const status = await getUserFrozenStatus('userOpenId_here');
+ *   console.log('User is frozen:', status.isFrozen);
  *   console.log('Remark:', status.remark);
- *   console.log('Last updated:', status.updated_at);
+ *   console.log('Last updated:', status.updatedAt);
  * } catch (error) {
  *   console.error('Failed to get frozen status:', error.message);
  * }
@@ -751,7 +746,7 @@ export async function getUserFrozenStatus(userId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = String(base).replace(/\/+$/, "") +
-        `/account/v1/user/${encodeURIComponent(userId)}/frozen-status`;
+        `/account/v2/user/${encodeURIComponent(userId)}/frozen-status`;
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -779,7 +774,7 @@ export async function getUserFrozenStatus(userId, options) {
         throw new ApiError(errorMsg, response.status, json.code);
     }
     // Validate response structure
-    if (!json.data || json.data.user_id === undefined) {
+    if (!json.data || json.data.userId === undefined) {
         throw new ApiError("Invalid frozen status response: missing required data", response.status);
     }
     return json.data;

package/dist/user/types.d.ts

@@ -3,12 +3,12 @@ import type { UserAttributeItemDTO } from "../user-attribute/types.js";
 export type { AppInfo, User, UserGroup, Role, Privilege, CommonOptions, PageResponse, UserAttributeItemDTO, };
 export interface CreateUserRequest {
     username: string;
-    password_encrypted?: string;
+    passwordEncrypted?: string;
     nickname?: string;
     phone?: string;
     email?: string;
-    avatar_url?: string;
-    role_ids?: string[];
+    avatarUrl?: string;
+    roleIds?: string[];
 }
 export interface UserLoginMethod {
     method: string;
@@ -17,10 +17,10 @@ export interface UserLoginMethod {
 export interface CreateUserResponse {
     app: AppInfo;
     user: User;
-    user_roles: Role[];
-    user_privileges: Privilege[];
-    user_groups: UserGroup[];
-    user_login_methods: UserLoginMethod[];
+    userRoles: Role[];
+    userPrivileges: Privilege[];
+    userGroups: UserGroup[];
+    userLoginMethods: UserLoginMethod[];
 }
 export interface CreateUserJson {
     data: CreateUserResponse;
@@ -34,15 +34,15 @@ export interface CreateUserOptions {
     appToken?: string;
 }
 export interface GetUserRequest {
-    user_id?: string;
-    include_rbac?: boolean;
-    include_login_methods?: boolean;
-    include_user_groups?: boolean;
-    include_acl?: boolean;
+    userId?: string;
+    includeRbac?: boolean;
+    includeLoginMethods?: boolean;
+    includeUserGroups?: boolean;
+    includeAcl?: boolean;
 }
 export interface DeleteUserResponse {
     deleted: boolean;
-    user_id: string;
+    userId: string;
 }
 export interface DeleteUserJson {
     data: DeleteUserResponse;
@@ -52,21 +52,20 @@ export interface DeleteUserJson {
 export interface ListUsersRequest {
     page?: number;
     size?: number;
-    sort_by?: string;
-    sort_direction?: "asc" | "desc";
-    user_groups?: string[];
-    user_roles?: string[];
-    user_ids?: string[];
+    sort?: string;
+    userGroups?: string[];
+    userRoles?: string[];
+    userIds?: string[];
     keyword?: string;
-    include_attributes?: boolean;
+    includeAttributes?: boolean;
 }
 export interface UserListItem {
     app: AppInfo;
     user: User;
-    user_roles: Role[];
-    user_privileges: Privilege[];
-    user_groups: UserGroup[];
-    user_attributes?: UserAttributeItemDTO[];
+    userRoles: Role[];
+    userPrivileges: Privilege[];
+    userGroups: UserGroup[];
+    userAttributes?: UserAttributeItemDTO[];
 }
 export interface ListUsersResponse extends PageResponse<UserListItem> {
     content: UserListItem[];
@@ -78,14 +77,14 @@ export interface ListUsersJson {
 }
 export interface UpdateUserRequest {
     username?: string;
-    nick_name?: string;
+    nickname?: string;
     email?: string;
     phone?: string;
     remark?: string;
 }
 export interface UpdateUserResponse {
     success: boolean;
-    user_id: string;
+    userId: string;
 }
 export interface UpdateUserJson {
     data?: UpdateUserResponse;
@@ -93,12 +92,12 @@ export interface UpdateUserJson {
     msg: string;
 }
 export interface UpdateUserPasswordRequest {
-    user_id: string;
-    password_encrypted: string;
+    userId: string;
+    passwordEncrypted: string;
 }
 export interface UpdateUserPasswordResponse {
     success: boolean;
-    user_id: string;
+    userId: string;
 }
 export interface UpdateUserPasswordJson {
     data?: UpdateUserPasswordResponse;
@@ -106,7 +105,7 @@ export interface UpdateUserPasswordJson {
     msg: string;
 }
 export interface UploadAvatarResponse {
-    avatar_oss_key: string;
+    avatarOssKey: string;
 }
 export interface UploadAvatarJson {
     data: UploadAvatarResponse;
@@ -124,14 +123,14 @@ export interface AvatarPresignedUrlJson {
     msg: string;
 }
 export interface UpdateUserFrozenStatusRequest {
-    is_frozen: boolean;
+    isFrozen: boolean;
     remark?: string;
 }
 export interface UserFrozenStatusResponse {
-    user_id: string;
-    is_frozen: boolean;
+    userId: string;
+    isFrozen: boolean;
     remark: string;
-    updated_at: string;
+    updatedAt: string;
 }
 export interface UpdateUserFrozenStatusJson {
     data: UserFrozenStatusResponse;

package/dist/user-attribute/index.d.ts

@@ -14,10 +14,10 @@ export type { UserAttributeDefinition, UserAttributeDTO, UserAttributeItemDTO, U
  * @example
  * ```typescript
  * const definition = await createUserAttributeDefinition({
- *   attribute_name: "department",
+ *   attributeName: "department",
  *   description: "User's department",
- *   schema_definition: { type: "string" },
- *   is_enabled: true,
+ *   schemaDefinition: { type: "string" },
+ *   isEnabled: true,
  * });
  * ```
  */
@@ -169,10 +169,7 @@ export declare function listUserAttributes(userId: string, request?: ListUserAtt
  * @throws {ApiError} When API request fails
  * @throws {NetworkError} When network request fails
  */
-export declare function listAttributeUsers(attributeDefinitionId: string, request?: ListUserAttributesRequest & UserAttributeOptions): Promise<{
-    content: UserAttributeDTO[];
-    totalElements: number;
-}>;
+export declare function listAttributeUsers(attributeDefinitionId: string, request?: ListUserAttributesRequest & UserAttributeOptions): Promise<PageResponse<UserAttributeDTO>>;
 /**
  * Lists all user attributes grouped by user with pagination.
  *