@turinhub/tale-js-sdk 1.3.0 → 2.0.0

package/dist/user-attribute/index.js

@@ -32,10 +32,10 @@ function parseApiResponse(json, errorMessage, statusCode) {
  * @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,
  * });
  * ```
  */
@@ -46,7 +46,7 @@ export async function createUserAttributeDefinition(request, options) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v1/definition");
+    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v2/definition");
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -83,7 +83,7 @@ export async function updateUserAttributeDefinition(openId, request, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/definition/${encodeURIComponent(openId)}`);
+        `/user-attribute/v2/definition/${encodeURIComponent(openId)}`);
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -118,7 +118,7 @@ export async function deleteUserAttributeDefinition(openId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/definition/${encodeURIComponent(openId)}`);
+        `/user-attribute/v2/definition/${encodeURIComponent(openId)}`);
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -162,7 +162,7 @@ export async function getUserAttributeDefinition(openId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/definition/${encodeURIComponent(openId)}`);
+        `/user-attribute/v2/definition/${encodeURIComponent(openId)}`);
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -207,7 +207,7 @@ export async function listUserAttributeDefinitions(request) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v1/definition");
+    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v2/definition");
     const { appToken, baseUrl, ...requestParams } = request || {};
     const queryParams = {
         page: 0,
@@ -252,7 +252,7 @@ export async function listEnabledUserAttributeDefinitions(options) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v1/definition/enabled");
+    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v2/definition/enabled");
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -292,7 +292,7 @@ export async function toggleUserAttributeDefinitionStatus(openId, isEnabled, opt
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/definition/${encodeURIComponent(openId)}/status`);
+        `/user-attribute/v2/definition/${encodeURIComponent(openId)}/status`);
     url.searchParams.append("enabled", String(isEnabled));
     let response;
     try {
@@ -331,7 +331,7 @@ export async function setUserAttribute(userId, attributeDefinitionId, request, o
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
+        `/user-attribute/v2/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -368,7 +368,7 @@ export async function getUserAttribute(userId, attributeDefinitionId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
+        `/user-attribute/v2/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -403,7 +403,7 @@ export async function deleteUserAttribute(userId, attributeDefinitionId, options
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
+        `/user-attribute/v2/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -447,7 +447,7 @@ export async function getUserAttributes(userId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute`);
+        `/user-attribute/v2/user/${encodeURIComponent(userId)}/attribute`);
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -487,7 +487,7 @@ export async function listUserAttributes(userId, request) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute/page`);
+        `/user-attribute/v2/user/${encodeURIComponent(userId)}/attribute/page`);
     const { appToken, baseUrl, ...requestParams } = request || {};
     const queryParams = {
         page: 0,
@@ -535,11 +535,12 @@ export async function listAttributeUsers(attributeDefinitionId, request) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-attribute/v1/definition/${encodeURIComponent(attributeDefinitionId)}/users`);
+        `/user-attribute/v2/definition/${encodeURIComponent(attributeDefinitionId)}/users`);
     const { appToken, baseUrl, ...requestParams } = request || {};
     const queryParams = {
         page: 0,
         size: 20,
+        sort: "createdAt,desc",
         ...requestParams,
     };
     Object.entries(queryParams).forEach(([key, value]) => {
@@ -561,11 +562,7 @@ export async function listAttributeUsers(attributeDefinitionId, request) {
         throw new NetworkError(`Failed to list attribute users: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
     const json = await response.json();
-    const data = parseApiResponse(json, "Failed to list attribute users", response.status);
-    if (!Array.isArray(data.content)) {
-        throw new ApiError("Invalid attribute users response: content is not an array", response.status);
-    }
-    return data;
+    return parseApiResponse(json, "Failed to list attribute users", response.status);
 }
 /**
  * Lists all user attributes grouped by user with pagination.
@@ -584,7 +581,7 @@ export async function listAllUserAttributes(request) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v1/user/attribute/page");
+    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v2/user/attribute/page");
     const { appToken, baseUrl, ...requestParams } = request || {};
     const queryParams = {
         page: 0,

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

@@ -3,78 +3,78 @@ import type { CommonOptions } from "../common/types.js";
  * User attribute definition
  */
 export interface UserAttributeDefinition {
-    open_id: string;
-    attribute_name: string;
+    openId: string;
+    attributeName: string;
     description?: string;
-    schema_definition: Record<string, unknown>;
-    is_enabled: boolean;
-    created_at: string;
-    updated_at: string;
+    schemaDefinition: Record<string, unknown>;
+    isEnabled: boolean;
+    createdAt: string;
+    updatedAt: string;
     remark?: string;
 }
 /**
  * User attribute value (matches backend UserAttributeDTO)
  */
 export interface UserAttributeDTO {
-    user_id: string;
-    attribute_definition_id: string;
-    attribute_name: string;
-    attribute_value: Record<string, unknown>;
-    created_at: string;
-    updated_at: string;
+    userId: string;
+    attributeDefinitionId: string;
+    attributeName: string;
+    attributeValue: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
     remark?: string;
 }
 /**
- * User attribute item (without user_id, matches backend UserAttributeItemDTO)
+ * User attribute item (without userId, matches backend UserAttributeItemDTO)
  */
 export interface UserAttributeItemDTO {
-    attribute_definition_id: string;
-    attribute_name: string;
-    attribute_value: Record<string, unknown>;
-    created_at: string;
-    updated_at: string;
+    attributeDefinitionId: string;
+    attributeName: string;
+    attributeValue: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
     remark?: string;
 }
 /**
  * User attribute grouped by user (matches backend UserAttributeGroupedDTO)
  */
 export interface UserAttributeGroupedDTO {
-    user_id: string;
+    userId: string;
     username: string;
     nickname: string;
     email: string;
     phone: string;
-    avatar_url?: string;
+    avatarUrl?: string;
     remark?: string;
-    is_frozen: boolean;
-    registered_at: string;
+    isFrozen: boolean;
+    registeredAt: string;
     attributes: UserAttributeItemDTO[];
 }
 /**
  * Request for creating a user attribute definition
  */
 export interface CreateUserAttributeDefinitionRequest {
-    attribute_name: string;
+    attributeName: string;
     description?: string;
-    schema_definition: Record<string, unknown>;
-    is_enabled?: boolean;
+    schemaDefinition: Record<string, unknown>;
+    isEnabled?: boolean;
     remark?: string;
 }
 /**
  * Request for updating a user attribute definition
  */
 export interface UpdateUserAttributeDefinitionRequest {
-    attribute_name?: string;
+    attributeName?: string;
     description?: string;
-    schema_definition?: Record<string, unknown>;
-    is_enabled?: boolean;
+    schemaDefinition?: Record<string, unknown>;
+    isEnabled?: boolean;
     remark?: string;
 }
 /**
  * Request for setting a user attribute value
  */
 export interface SetUserAttributeRequest {
-    attribute_value: Record<string, unknown>;
+    attributeValue: Record<string, unknown>;
     remark?: string;
 }
 /**

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

@@ -1,231 +1,12 @@
 import type { PageResponse } from "../common/types.js";
 import type { UserGroupInfo, UserGroupMember, CreateUserGroupRequest, UpdateUserGroupRequest, UserGroupMemberRequest, UserGroupOptions, ListUserGroupsRequest, ListUserGroupMembersRequest } from "./types.js";
 export type { UserGroupInfo, UserGroupMember, CreateUserGroupRequest, UpdateUserGroupRequest, UserGroupMemberRequest, UserGroupOptions, ListUserGroupsRequest, ListUserGroupMembersRequest, } from "./types.js";
-/**
- * Gets a user group by ID.
- *
- * @param groupId - User group ID
- * @param options - Optional configuration
- * @returns Promise resolving to user group information
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { getUserGroup } from '@tale/client';
- *
- * try {
- *   const group = await getUserGroup('group_id_here');
- *   console.log('Group name:', group.name);
- * } catch (error) {
- *   console.error('Failed to get user group:', error.message);
- * }
- * ```
- */
 export declare function getUserGroup(groupId: string, options?: UserGroupOptions): Promise<UserGroupInfo>;
-/**
- * Lists user groups with pagination and optional keyword filtering.
- *
- * @param options - Optional parameters for pagination and filtering
- * @returns Promise resolving to paginated user group list
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { listUserGroups } from '@tale/client';
- *
- * try {
- *   const result = await listUserGroups({
- *     page: 0,
- *     size: 20,
- *     keyword: 'admin'
- *   });
- *   console.log(`Found ${result.totalElements} user groups`);
- * } catch (error) {
- *   console.error('Failed to list user groups:', error.message);
- * }
- * ```
- */
 export declare function listUserGroups(options?: ListUserGroupsRequest & UserGroupOptions): Promise<PageResponse<UserGroupInfo>>;
-/**
- * Creates a new user group.
- *
- * @param request - User group creation request
- * @param options - Optional configuration
- * @returns Promise resolving to created user group
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { createUserGroup } from '@tale/client';
- *
- * try {
- *   const group = await createUserGroup({
- *     name: 'Administrators',
- *     description: 'Admin users',
- *     type: 'system'
- *   });
- *   console.log('Group created:', group.group_id);
- * } catch (error) {
- *   console.error('Failed to create user group:', error.message);
- * }
- * ```
- */
-export declare function createUserGroup(request: CreateUserGroupRequest, options?: UserGroupOptions): Promise<UserGroupInfo>;
-/**
- * Updates an existing user group.
- *
- * @param groupId - User group ID to update
- * @param request - Update request with fields to modify
- * @param options - Optional configuration
- * @returns Promise resolving to updated user group
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { updateUserGroup } from '@tale/client';
- *
- * try {
- *   const group = await updateUserGroup('group_id_here', {
- *     name: 'Updated Name',
- *     description: 'Updated description'
- *   });
- *   console.log('Group updated:', group.name);
- * } catch (error) {
- *   console.error('Failed to update user group:', error.message);
- * }
- * ```
- */
-export declare function updateUserGroup(groupId: string, request: UpdateUserGroupRequest, options?: UserGroupOptions): Promise<UserGroupInfo>;
-/**
- * Deletes a user group.
- *
- * @param groupId - User group ID to delete
- * @param options - Optional configuration
- * @returns Promise that resolves when deletion is successful
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { deleteUserGroup } from '@tale/client';
- *
- * try {
- *   await deleteUserGroup('group_id_here');
- *   console.log('Group deleted successfully');
- * } catch (error) {
- *   console.error('Failed to delete user group:', error.message);
- * }
- * ```
- */
+export declare function createUserGroup(requestBody: CreateUserGroupRequest, options?: UserGroupOptions): Promise<UserGroupInfo>;
+export declare function updateUserGroup(groupId: string, requestBody: UpdateUserGroupRequest, options?: UserGroupOptions): Promise<UserGroupInfo>;
 export declare function deleteUserGroup(groupId: string, options?: UserGroupOptions): Promise<void>;
-/**
- * Gets members of a user group with pagination.
- *
- * @param groupId - User group ID
- * @param options - Optional parameters for pagination
- * @returns Promise resolving to paginated member list
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { listUserGroupMembers } from '@tale/client';
- *
- * try {
- *   const result = await listUserGroupMembers('group_id_here', {
- *     page: 0,
- *     size: 20
- *   });
- *   console.log(`Found ${result.totalElements} members`);
- * } catch (error) {
- *   console.error('Failed to list user group members:', error.message);
- * }
- * ```
- */
 export declare function listUserGroupMembers(groupId: string, options?: ListUserGroupMembersRequest & UserGroupOptions): Promise<PageResponse<UserGroupMember>>;
-/**
- * Adds members to a user group.
- *
- * @param groupId - User group ID
- * @param request - Request containing user IDs to add
- * @param options - Optional configuration
- * @returns Promise that resolves when members are added
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { addUserGroupMembers } from '@tale/client';
- *
- * try {
- *   await addUserGroupMembers('group_id_here', {
- *     user_ids: ['user1', 'user2', 'user3']
- *   });
- *   console.log('Members added successfully');
- * } catch (error) {
- *   console.error('Failed to add members:', error.message);
- * }
- * ```
- */
-export declare function addUserGroupMembers(groupId: string, request: UserGroupMemberRequest, options?: UserGroupOptions): Promise<void>;
-/**
- * Removes members from a user group.
- *
- * @param groupId - User group ID
- * @param request - Request containing user IDs to remove
- * @param options - Optional configuration
- * @returns Promise that resolves when members are removed
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { removeUserGroupMembers } from '@tale/client';
- *
- * try {
- *   await removeUserGroupMembers('group_id_here', {
- *     user_ids: ['user1', 'user2']
- *   });
- *   console.log('Members removed successfully');
- * } catch (error) {
- *   console.error('Failed to remove members:', error.message);
- * }
- * ```
- */
-export declare function removeUserGroupMembers(groupId: string, request: UserGroupMemberRequest, options?: UserGroupOptions): Promise<void>;
-/**
- * Gets all user groups that a user belongs to.
- *
- * @param userId - User ID
- * @param options - Optional configuration
- * @returns Promise resolving to list of user groups
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When API request fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { getUserGroups } from '@tale/client';
- *
- * try {
- *   const groups = await getUserGroups('user_id_here');
- *   console.log(`User belongs to ${groups.length} groups`);
- *   groups.forEach(group => console.log('-', group.name));
- * } catch (error) {
- *   console.error('Failed to get user groups:', error.message);
- * }
- * ```
- */
+export declare function addUserGroupMembers(groupId: string, requestBody: UserGroupMemberRequest, options?: UserGroupOptions): Promise<void>;
+export declare function removeUserGroupMembers(groupId: string, requestBody: UserGroupMemberRequest, options?: UserGroupOptions): Promise<void>;
 export declare function getUserGroups(userId: string, options?: UserGroupOptions): Promise<UserGroupInfo[]>;