tale-js-sdk 0.1.3 → 1.0.0

package/dist/rbac/types.d.ts

@@ -1,255 +1,52 @@
-export interface Role {
-    role_id: string;
-    role_name: string;
-    role_type?: string;
-    role_property?: Record<string, any>;
-    role_config?: Record<string, any>;
-    description?: string;
-    remark?: string;
-    created_at?: string;
-    updated_at?: string;
-    privileges?: Privilege[];
-}
-export interface Privilege {
-    privilege_id: string;
-    privilege_name: string;
-    privilege_type?: string;
-    privilege_property?: Record<string, any>;
-    privilege_config?: Record<string, any>;
-    resource_ids?: string[];
-    description?: string;
-    remark?: string;
-    created_at?: string;
-    updated_at?: string;
-}
-export interface UserGroup {
-    group_id: string;
-    group_name: string;
-    description?: string;
-    type?: string;
-    remark?: string;
-    created_at?: string;
-    updated_at?: string;
-    member_count?: number;
-}
-export interface PaginatedResponse<T> {
-    content: T[];
-    pageable: {
-        sort: Sort;
-        offset: number;
-        pageNumber: number;
-        pageSize: number;
-        paged: boolean;
-        unpaged: boolean;
-    };
-    last: boolean;
-    totalPages: number;
-    totalElements: number;
-    size: number;
-    number: number;
-    sort: Sort;
-    first: boolean;
-    numberOfElements: number;
-    empty: boolean;
-}
-export interface Sort {
-    empty: boolean;
-    sorted: boolean;
-    unsorted: boolean;
-}
-export interface CommonOptions {
-    baseUrl?: string;
-    appKey?: string;
-    appSecret?: string;
-    appToken?: string;
-}
-export interface RBACOptions extends CommonOptions {
-    include_privileges?: boolean;
-    include_assignments?: boolean;
-    assignment_expires_at?: string;
-}
+import type { CommonOptions, Role, Privilege } from "../common/types.js";
+export type { Role, Privilege };
+/**
+ * Request for creating a role
+ */
 export interface CreateRoleRequest {
     role_name: string;
     role_type?: string;
-    role_property?: Record<string, any>;
-    role_config?: Record<string, any>;
+    role_property?: Record<string, unknown>;
+    role_config?: Record<string, unknown>;
     privilege_ids?: string[];
     remark?: string;
 }
+/**
+ * Request for updating a role
+ */
 export interface UpdateRoleRequest {
     role_name?: string;
     role_type?: string;
-    role_property?: Record<string, any>;
-    role_config?: Record<string, any>;
+    role_property?: Record<string, unknown>;
+    role_config?: Record<string, unknown>;
     privilege_ids?: string[];
     remark?: string;
 }
-export interface ListRolesRequest {
-    page?: number;
-    size?: number;
-    role_type?: string;
-    sort_by?: string;
-    sort_direction?: 'asc' | 'desc';
-}
-export interface CreateRoleResponse {
-    role: Role;
-    message?: string;
-}
-export interface CreateRoleJson {
-    data: CreateRoleResponse;
-    code: number;
-    msg: string;
-}
-export interface UpdateRoleResponse {
-    role: Role;
-    message?: string;
-}
-export interface UpdateRoleJson {
-    data: UpdateRoleResponse;
-    code: number;
-    msg: string;
-}
-export interface DeleteRoleResponse {
-    deleted: boolean;
-    role_id: string;
-}
-export interface DeleteRoleJson {
-    data: DeleteRoleResponse;
-    code: number;
-    msg: string;
-}
-export interface GetRoleResponse {
-    role: Role;
-}
-export interface GetRoleJson {
-    data: GetRoleResponse;
-    code: number;
-    msg: string;
-}
-export interface ListRolesJson {
-    data: PaginatedResponse<Role>;
-    code: number;
-    msg: string;
-}
+/**
+ * Request for creating a privilege
+ */
 export interface CreatePrivilegeRequest {
     privilege_name: string;
     privilege_type?: string;
-    privilege_property?: Record<string, any>;
-    privilege_config?: Record<string, any>;
+    privilege_property?: Record<string, unknown>;
+    privilege_config?: Record<string, unknown>;
     resource_ids?: string[];
     remark?: string;
 }
+/**
+ * Request for updating a privilege
+ */
 export interface UpdatePrivilegeRequest {
     privilege_name?: string;
     privilege_type?: string;
-    privilege_property?: Record<string, any>;
-    privilege_config?: Record<string, any>;
+    privilege_property?: Record<string, unknown>;
+    privilege_config?: Record<string, unknown>;
     resource_ids?: string[];
     remark?: string;
 }
-export interface ListPrivilegesRequest {
-    page?: number;
-    size?: number;
-    privilege_type?: string;
-    sort_by?: string;
-    sort_direction?: 'asc' | 'desc';
-}
-export interface CreatePrivilegeResponse {
-    privilege: Privilege;
-    message?: string;
-}
-export interface CreatePrivilegeJson {
-    data: CreatePrivilegeResponse;
-    code: number;
-    msg: string;
-}
-export interface UpdatePrivilegeResponse {
-    privilege: Privilege;
-    message?: string;
-}
-export interface UpdatePrivilegeJson {
-    data: UpdatePrivilegeResponse;
-    code: number;
-    msg: string;
-}
-export interface DeletePrivilegeResponse {
-    deleted: boolean;
-    privilege_id: string;
-}
-export interface DeletePrivilegeJson {
-    data: DeletePrivilegeResponse;
-    code: number;
-    msg: string;
-}
-export interface GetPrivilegeResponse {
-    privilege: Privilege;
-}
-export interface GetPrivilegeJson {
-    data: GetPrivilegeResponse;
-    code: number;
-    msg: string;
-}
-export interface ListPrivilegesJson {
-    data: PaginatedResponse<Privilege>;
-    code: number;
-    msg: string;
-}
-export interface PropertyResponse {
-    property: Record<string, any>;
-}
-export interface PropertyJson {
-    data: PropertyResponse;
-    code: number;
-    msg: string;
-}
-export interface ConfigResponse {
-    config: Record<string, any>;
-}
-export interface ConfigJson {
-    data: ConfigResponse;
-    code: number;
-    msg: string;
-}
-export interface UpdatePropertyRequest {
-    property: Record<string, any>;
-}
-export interface UpdatePropertyJson {
-    data: PropertyResponse;
-    code: number;
-    msg: string;
-}
-export interface UpdateConfigRequest {
-    config: Record<string, any>;
-}
-export interface UpdateConfigJson {
-    data: ConfigResponse;
-    code: number;
-    msg: string;
-}
-export interface RoleAssignment {
-    assignment_id?: string;
-    user_id: string;
-    role_id: string;
-    role: Role;
-    started_at?: string;
-    expired_at?: string;
-    assignment_type?: string;
-    assignment_ref?: string;
-    remark?: string;
-    created_at?: string;
-}
-export interface PrivilegeAssignment {
-    assignment_id?: string;
-    user_id: string;
-    privilege_id: string;
-    privilege: Privilege;
-    started_at?: string;
-    expired_at?: string;
-    assignment_type?: string;
-    assignment_ref?: string;
-    remark?: string;
-    created_at?: string;
-}
+/**
+ * Request for assigning roles to a user
+ */
 export interface UserRoleAssignmentRequest {
     role_ids: string[];
     started_at?: string;
@@ -258,6 +55,15 @@ export interface UserRoleAssignmentRequest {
     assignment_ref?: string;
     remark?: string;
 }
+/**
+ * Request for unassigning roles from a user
+ */
+export interface UserRoleUnassignmentRequest {
+    role_ids: string[];
+}
+/**
+ * Request for assigning privileges to a user
+ */
 export interface UserPrivilegeAssignmentRequest {
     privilege_ids: string[];
     started_at?: string;
@@ -266,91 +72,54 @@ export interface UserPrivilegeAssignmentRequest {
     assignment_ref?: string;
     remark?: string;
 }
-export interface RolePrivilegeAssignmentRequest {
+/**
+ * Request for unassigning privileges from a user
+ */
+export interface UserPrivilegeUnassignmentRequest {
     privilege_ids: string[];
-    remark?: string;
 }
-export interface UserRoleUnassignmentRequest {
-    role_ids: string[];
-}
-export interface UserPrivilegeUnassignmentRequest {
+/**
+ * Request for assigning privileges to a role
+ */
+export interface RolePrivilegeAssignmentRequest {
     privilege_ids: string[];
+    remark?: string;
 }
+/**
+ * Request for unassigning privileges from a role
+ */
 export interface RolePrivilegeUnassignmentRequest {
     privilege_ids: string[];
 }
-export interface AssignRolesResponse {
-    roles: Role[];
-    message?: string;
-}
-export interface AssignRolesJson {
-    data: AssignRolesResponse;
-    code: number;
-    msg: string;
-}
-export interface UnassignRolesResponse {
-    unassigned: boolean;
-    unassigned_count: number;
-}
-export interface UnassignRolesJson {
-    data: UnassignRolesResponse;
-    code: number;
-    msg: string;
-}
-export interface AssignPrivilegesResponse {
-    privileges: Privilege[];
-    message?: string;
-}
-export interface AssignPrivilegesJson {
-    data: AssignPrivilegesResponse;
-    code: number;
-    msg: string;
-}
-export interface UnassignPrivilegesResponse {
-    unassigned: boolean;
-    unassigned_count: number;
+/**
+ * Options for RBAC operations
+ */
+export interface RbacOptions extends CommonOptions {
 }
-export interface UnassignPrivilegesJson {
-    data: UnassignPrivilegesResponse;
-    code: number;
-    msg: string;
-}
-export interface GetUserRolesResponse {
-    roles: Role[];
-}
-export interface GetUserRolesJson {
-    data: GetUserRolesResponse;
-    code: number;
-    msg: string;
-}
-export interface GetUserPrivilegesResponse {
-    privileges: Privilege[];
+/**
+ * Request for listing roles
+ */
+export interface ListRolesRequest {
+    page?: number;
+    size?: number;
+    role_type?: string;
+    sort_by?: string;
+    sort_direction?: "asc" | "desc";
 }
-export interface GetUserPrivilegesJson {
-    data: GetUserPrivilegesResponse;
-    code: number;
-    msg: string;
+/**
+ * Request for listing privileges
+ */
+export interface ListPrivilegesRequest {
+    page?: number;
+    size?: number;
+    privilege_type?: string;
+    sort_by?: string;
+    sort_direction?: "asc" | "desc";
 }
+/**
+ * Privilege and role pair
+ */
 export interface PrivilegeRolePair {
-    privilege_id: string;
-    privilege_name: string;
-    role_id: string;
-    role_name: string;
-    resource_id: string;
-}
-export interface ResourcePermissionCheck {
-    user_id: string;
-    resource_id: string;
-    privilege_name: string;
-    has_permission: boolean;
-    granted_by_roles: string[];
-    granted_by_privileges: string[];
-}
-export interface GetResourcePrivilegeRolesResponse {
-    privilege_role_pairs: PrivilegeRolePair[];
-}
-export interface GetResourcePrivilegeRolesJson {
-    data: GetResourcePrivilegeRolesResponse;
-    code: number;
-    msg: string;
+    privilege: Privilege;
+    role: Role;
 }

package/dist/user/index.d.ts

@@ -1,5 +1,5 @@
-import type { CreateUserRequest, AppInfo, User, Role, Privilege, UserGroup, UserLoginMethod, CreateUserResponse, CreateUserJson, CreateUserOptions, GetUserRequest, DeleteUserResponse, DeleteUserJson, CommonOptions, ListUsersRequest, UserAttribute, UserListItem, Sort, Pageable, ListUsersResponse, ListUsersJson } from "./types.js";
-export type { CreateUserRequest, AppInfo, User, Role, Privilege, UserGroup, UserLoginMethod, CreateUserResponse, CreateUserJson, CreateUserOptions, GetUserRequest, DeleteUserResponse, DeleteUserJson, CommonOptions, ListUsersRequest, UserAttribute, UserListItem, Sort, Pageable, ListUsersResponse, ListUsersJson, };
+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.
  *
@@ -102,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>;