@turinhub/tale-js-sdk 1.3.0

package/dist/user/types.d.ts

@@ -0,0 +1,145 @@
+import type { AppInfo, User, UserGroup, Role, Privilege, CommonOptions, PageResponse } from "../common/types.js";
+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;
+    nickname?: string;
+    phone?: string;
+    email?: string;
+    avatar_url?: string;
+    role_ids?: 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 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 UserListItem {
+    app: AppInfo;
+    user: User;
+    user_roles: Role[];
+    user_privileges: Privilege[];
+    user_groups: UserGroup[];
+    user_attributes?: UserAttributeItemDTO[];
+}
+export interface ListUsersResponse extends PageResponse<UserListItem> {
+    content: UserListItem[];
+}
+export interface ListUsersJson {
+    data: ListUsersResponse;
+    code: number;
+    msg: string;
+}
+export interface UpdateUserRequest {
+    username?: string;
+    nick_name?: string;
+    email?: string;
+    phone?: string;
+    remark?: string;
+}
+export interface UpdateUserResponse {
+    success: boolean;
+    user_id: string;
+}
+export interface UpdateUserJson {
+    data?: UpdateUserResponse;
+    code: number;
+    msg: string;
+}
+export interface UpdateUserPasswordRequest {
+    user_id: string;
+    password_encrypted: string;
+}
+export interface UpdateUserPasswordResponse {
+    success: boolean;
+    user_id: string;
+}
+export interface UpdateUserPasswordJson {
+    data?: UpdateUserPasswordResponse;
+    code: number;
+    msg: string;
+}
+export interface UploadAvatarResponse {
+    avatar_oss_key: string;
+}
+export interface UploadAvatarJson {
+    data: UploadAvatarResponse;
+    code: number;
+    msg: string;
+}
+export interface AvatarPresignedUrlResponse {
+    ossKey: string;
+    presignedUrl: string;
+    expireTimeInSeconds: number;
+}
+export interface AvatarPresignedUrlJson {
+    data: AvatarPresignedUrlResponse;
+    code: number;
+    msg: string;
+}
+export interface UpdateUserFrozenStatusRequest {
+    is_frozen: boolean;
+    remark?: string;
+}
+export interface UserFrozenStatusResponse {
+    user_id: string;
+    is_frozen: boolean;
+    remark: string;
+    updated_at: string;
+}
+export interface UpdateUserFrozenStatusJson {
+    data: UserFrozenStatusResponse;
+    code: number;
+    msg: string;
+}
+export interface GetUserFrozenStatusJson {
+    data: UserFrozenStatusResponse;
+    code: number;
+    msg: string;
+}

package/dist/user/types.js

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

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

@@ -0,0 +1,186 @@
+import type { PageResponse } from "../common/types.js";
+import type { UserAttributeDefinition, UserAttributeDTO, UserAttributeItemDTO, UserAttributeGroupedDTO, CreateUserAttributeDefinitionRequest, UpdateUserAttributeDefinitionRequest, SetUserAttributeRequest, ListUserAttributeDefinitionsRequest, ListUserAttributesRequest, ListAllUserAttributesRequest, UserAttributeOptions } from "./types.js";
+export type { UserAttributeDefinition, UserAttributeDTO, UserAttributeItemDTO, UserAttributeGroupedDTO, CreateUserAttributeDefinitionRequest, UpdateUserAttributeDefinitionRequest, SetUserAttributeRequest, ListUserAttributeDefinitionsRequest, ListUserAttributesRequest, ListAllUserAttributesRequest, UserAttributeOptions, };
+/**
+ * Creates a new user attribute definition.
+ *
+ * @param request - Attribute definition creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created attribute definition
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * const definition = await createUserAttributeDefinition({
+ *   attribute_name: "department",
+ *   description: "User's department",
+ *   schema_definition: { type: "string" },
+ *   is_enabled: true,
+ * });
+ * ```
+ */
+export declare function createUserAttributeDefinition(request: CreateUserAttributeDefinitionRequest, options?: UserAttributeOptions): Promise<UserAttributeDefinition>;
+/**
+ * Updates an existing user attribute definition.
+ *
+ * @param openId - Attribute definition open ID
+ * @param request - Attribute definition update request
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated attribute definition
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateUserAttributeDefinition(openId: string, request: UpdateUserAttributeDefinitionRequest, options?: UserAttributeOptions): Promise<UserAttributeDefinition>;
+/**
+ * Deletes a user attribute definition.
+ *
+ * @param openId - Attribute definition open ID
+ * @param options - Optional configuration
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function deleteUserAttributeDefinition(openId: string, options?: UserAttributeOptions): Promise<void>;
+/**
+ * Gets a user attribute definition by open ID.
+ *
+ * @param openId - Attribute definition open ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to attribute definition
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getUserAttributeDefinition(openId: string, options?: UserAttributeOptions): Promise<UserAttributeDefinition>;
+/**
+ * Lists user attribute definitions with pagination and optional filtering.
+ *
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of attribute definitions
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * const result = await listUserAttributeDefinitions({
+ *   page: 0,
+ *   size: 20,
+ *   keyword: "department",
+ * });
+ * console.log(result.content); // Array of definitions
+ * console.log(result.total); // Total count
+ * ```
+ */
+export declare function listUserAttributeDefinitions(request?: ListUserAttributeDefinitionsRequest & UserAttributeOptions): Promise<PageResponse<UserAttributeDefinition>>;
+/**
+ * Lists all enabled user attribute definitions.
+ *
+ * @param options - Optional configuration
+ * @returns Promise resolving to array of enabled attribute definitions
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function listEnabledUserAttributeDefinitions(options?: UserAttributeOptions): Promise<UserAttributeDefinition[]>;
+/**
+ * Toggles the enabled status of a user attribute definition.
+ *
+ * @param openId - Attribute definition open ID
+ * @param isEnabled - Whether the definition should be enabled
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated attribute definition
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function toggleUserAttributeDefinitionStatus(openId: string, isEnabled: boolean, options?: UserAttributeOptions): Promise<UserAttributeDefinition>;
+/**
+ * Sets a user attribute value.
+ *
+ * @param userId - User ID
+ * @param attributeDefinitionId - Attribute definition ID
+ * @param request - Attribute value to set
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated user attribute
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function setUserAttribute(userId: string, attributeDefinitionId: string, request: SetUserAttributeRequest, options?: UserAttributeOptions): Promise<UserAttributeDTO>;
+/**
+ * Gets a user attribute value.
+ *
+ * @param userId - User ID
+ * @param attributeDefinitionId - Attribute definition ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to user attribute
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getUserAttribute(userId: string, attributeDefinitionId: string, options?: UserAttributeOptions): Promise<UserAttributeDTO>;
+/**
+ * Deletes a user attribute value.
+ *
+ * @param userId - User ID
+ * @param attributeDefinitionId - Attribute definition ID
+ * @param options - Optional configuration
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function deleteUserAttribute(userId: string, attributeDefinitionId: string, options?: UserAttributeOptions): Promise<void>;
+/**
+ * Gets all attributes for a specific user.
+ *
+ * @param userId - User ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to array of user attributes
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getUserAttributes(userId: string, options?: UserAttributeOptions): Promise<UserAttributeDTO[]>;
+/**
+ * Lists user attributes with pagination.
+ *
+ * @param userId - User ID
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of user attributes
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function listUserAttributes(userId: string, request?: ListUserAttributesRequest & UserAttributeOptions): Promise<PageResponse<UserAttributeDTO>>;
+/**
+ * Lists all users who have a specific attribute.
+ *
+ * @param attributeDefinitionId - Attribute definition ID
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of user attributes
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @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;
+}>;
+/**
+ * Lists all user attributes grouped by user with pagination.
+ *
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of grouped user attributes
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function listAllUserAttributes(request?: ListAllUserAttributesRequest & UserAttributeOptions): Promise<PageResponse<UserAttributeGroupedDTO>>;