tale-js-sdk 0.1.2 → 0.1.4

package/dist/user/index.d.ts

@@ -1,145 +1,5 @@
-export interface CreateUserRequest {
-    username: string;
-    password_encrypted?: string;
-    nickname?: string;
-    phone?: string;
-    email?: string;
-    avatar_url?: string;
-    role_ids?: string[];
-}
-export interface AppInfo {
-    app_id: string;
-    org_id: string;
-    app_key: string;
-    app_name: string;
-}
-export interface User {
-    user_id: string;
-    nick_name: string;
-    avatar_url: string;
-    username: string;
-    email: string;
-    phone: string;
-    registered_at: string;
-    remark: string | null;
-    is_frozen: boolean;
-    latest_login_time?: string;
-}
-export interface Role {
-    role_id: string;
-    role_name: string;
-    description?: string;
-}
-export interface Privilege {
-    privilege_id: string;
-    privilege_name: string;
-    description?: string;
-}
-export interface UserGroup {
-    group_id: string;
-    group_name: string;
-    description?: string;
-}
-export interface UserLoginMethod {
-    method: string;
-    enabled: boolean;
-}
-export interface CreateUserResponse {
-    app: AppInfo;
-    user: User;
-    user_roles: Role[];
-    user_privileges: Privilege[];
-    user_groups: UserGroup[];
-    user_login_methods: UserLoginMethod[];
-}
-export interface CreateUserJson {
-    data: CreateUserResponse;
-    code: number;
-    msg: string;
-}
-export interface CreateUserOptions {
-    baseUrl?: string;
-    appKey?: string;
-    appSecret?: string;
-    appToken?: string;
-}
-export interface GetUserRequest {
-    user_id?: string;
-    include_rbac?: boolean;
-    include_login_methods?: boolean;
-    include_user_groups?: boolean;
-    include_acl?: boolean;
-}
-export interface DeleteUserResponse {
-    deleted: boolean;
-    user_id: string;
-}
-export interface DeleteUserJson {
-    data: DeleteUserResponse;
-    code: number;
-    msg: string;
-}
-export interface CommonOptions {
-    baseUrl?: string;
-    appKey?: string;
-    appSecret?: string;
-    appToken?: string;
-}
-export interface ListUsersRequest {
-    page?: number;
-    size?: number;
-    sort_by?: string;
-    sort_direction?: 'asc' | 'desc';
-    user_groups?: string[];
-    user_roles?: string[];
-    user_ids?: string[];
-    keyword?: string;
-    include_attributes?: boolean;
-}
-export interface UserAttribute {
-    attribute_id: string;
-    attribute_name: string;
-    attribute_value: string;
-}
-export interface UserListItem {
-    app: AppInfo;
-    user: User;
-    user_roles: Role[];
-    user_privileges: Privilege[];
-    user_groups: UserGroup[];
-    user_attributes?: UserAttribute[];
-}
-export interface Sort {
-    empty: boolean;
-    sorted: boolean;
-    unsorted: boolean;
-}
-export interface Pageable {
-    sort: Sort;
-    offset: number;
-    pageNumber: number;
-    pageSize: number;
-    paged: boolean;
-    unpaged: boolean;
-}
-export interface ListUsersResponse {
-    content: UserListItem[];
-    pageable: Pageable;
-    last: boolean;
-    totalPages: number;
-    totalElements: number;
-    size: number;
-    number: number;
-    sort: Sort;
-    first: boolean;
-    numberOfElements: number;
-    empty: boolean;
-}
-export interface ListUsersJson {
-    data: ListUsersResponse;
-    code: number;
-    msg: string;
-}
+import type { CreateUserRequest, AppInfo, User, Role, Privilege, UserGroup, UserLoginMethod, CreateUserResponse, CreateUserJson, CreateUserOptions, GetUserRequest, DeleteUserResponse, DeleteUserJson, CommonOptions, ListUsersRequest, UserAttribute, UserListItem, ListUsersResponse, ListUsersJson, UpdateUserRequest, UpdateUserResponse, UpdateUserJson, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateUserPasswordJson, UploadAvatarResponse, UploadAvatarJson, AvatarPresignedUrlResponse, AvatarPresignedUrlJson, UpdateUserFrozenStatusRequest, UserFrozenStatusResponse, UpdateUserFrozenStatusJson, GetUserFrozenStatusJson } from "./types.js";
+export type { CreateUserRequest, AppInfo, User, Role, Privilege, UserGroup, UserLoginMethod, CreateUserResponse, CreateUserJson, CreateUserOptions, GetUserRequest, DeleteUserResponse, DeleteUserJson, CommonOptions, ListUsersRequest, UserAttribute, UserListItem, ListUsersResponse, ListUsersJson, UpdateUserRequest, UpdateUserResponse, UpdateUserJson, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateUserPasswordJson, UploadAvatarResponse, UploadAvatarJson, AvatarPresignedUrlResponse, AvatarPresignedUrlJson, UpdateUserFrozenStatusRequest, UserFrozenStatusResponse, UpdateUserFrozenStatusJson, GetUserFrozenStatusJson, };
 /**
  * Creates a new user in the Tale application.
  *
@@ -242,3 +102,166 @@ export declare function deleteUser(userId: string, options?: CommonOptions): Pro
  * ```
  */
 export declare function listUsers(options?: ListUsersRequest & CommonOptions): Promise<ListUsersResponse>;
+/**
+ * Updates user information by user ID or open ID.
+ *
+ * @param userId - User ID (open_id) to update
+ * @param userData - User data to update
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the update result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateUser } from '@tale/client';
+ *
+ * try {
+ *   const result = await updateUser('user_open_id_here', {
+ *     nick_name: 'John Doe',
+ *     email: 'john@example.com'
+ *   });
+ *   console.log('User updated:', result.success);
+ * } catch (error) {
+ *   console.error('Failed to update user:', error.message);
+ * }
+ * ```
+ */
+export declare function updateUser(userId: string, userData: UpdateUserRequest, options?: CommonOptions): Promise<UpdateUserResponse>;
+/**
+ * Updates user password.
+ *
+ * @param passwordData - Password data including user_id 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
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateUserPassword } from '@tale/client';
+ *
+ * try {
+ *   const result = await updateUserPassword({
+ *     user_id: 'user_open_id_here',
+ *     password_encrypted: 'encrypted_password_here'
+ *   });
+ *   console.log('Password updated:', result.success);
+ * } catch (error) {
+ *   console.error('Failed to update password:', error.message);
+ * }
+ * ```
+ */
+export declare function updateUserPassword(passwordData: UpdateUserPasswordRequest, options?: CommonOptions): Promise<UpdateUserPasswordResponse>;
+/**
+ * Uploads user avatar image.
+ *
+ * @param file - File object to upload as avatar
+ * @param userId - User ID (open_id) 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
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { uploadAvatar } from '@tale/client';
+ *
+ * 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);
+ * } catch (error) {
+ *   console.error('Failed to upload avatar:', error.message);
+ * }
+ * ```
+ */
+export declare function uploadAvatar(file: File, userId: string, options?: CommonOptions): Promise<UploadAvatarResponse>;
+/**
+ * Gets presigned URL for avatar access.
+ *
+ * @param ossKey - OSS key of the avatar
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to presigned URL information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getAvatarPresignedUrl } from '@tale/client';
+ *
+ * try {
+ *   const result = await getAvatarPresignedUrl('avatars/user123.jpg');
+ *   console.log('Presigned URL:', result.presignedUrl);
+ *   console.log('Expires in:', result.expireTimeInSeconds, 'seconds');
+ * } catch (error) {
+ *   console.error('Failed to get presigned URL:', error.message);
+ * }
+ * ```
+ */
+export declare function getAvatarPresignedUrl(ossKey: string, options?: CommonOptions): Promise<AvatarPresignedUrlResponse>;
+/**
+ * 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 options - Optional configuration for the request
+ * @returns Promise resolving to the updated frozen status information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateUserFrozenStatus } from '@tale/client';
+ *
+ * try {
+ *   // Freeze a user account
+ *   const result = await updateUserFrozenStatus('user_open_id_here', {
+ *     is_frozen: true,
+ *     remark: 'Violated community guidelines'
+ *   });
+ *   console.log('User frozen:', result.is_frozen);
+ *
+ *   // Unfreeze a user account
+ *   const unfrozenResult = await updateUserFrozenStatus('user_open_id_here', {
+ *     is_frozen: false,
+ *     remark: 'Account reactivated'
+ *   });
+ *   console.log('User unfrozen:', !unfrozenResult.is_frozen);
+ * } catch (error) {
+ *   console.error('Failed to update frozen status:', error.message);
+ * }
+ * ```
+ */
+export declare function updateUserFrozenStatus(userId: string, frozenData: UpdateUserFrozenStatusRequest, options?: CommonOptions): Promise<UserFrozenStatusResponse>;
+/**
+ * Gets user frozen status by user ID.
+ *
+ * @param userId - User ID (open_id) 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
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getUserFrozenStatus } from '@tale/client';
+ *
+ * try {
+ *   const status = await getUserFrozenStatus('user_open_id_here');
+ *   console.log('User is frozen:', status.is_frozen);
+ *   console.log('Remark:', status.remark);
+ *   console.log('Last updated:', status.updated_at);
+ * } catch (error) {
+ *   console.error('Failed to get frozen status:', error.message);
+ * }
+ * ```
+ */
+export declare function getUserFrozenStatus(userId: string, options?: CommonOptions): Promise<UserFrozenStatusResponse>;