@turinhub/tale-js-sdk 1.3.0 → 2.1.0

package/dist/user-group/index.js

@@ -1,566 +1,148 @@
 import { getAppToken } from "../token.js";
 import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
-// ==================== Helper Functions ====================
-/**
- * Parses standard API response format: { code, msg, data }
- */
-function parseApiResponse(json, errorMessage, statusCode) {
+function getBaseUrl(options) {
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    return String(base).replace(/\/+$/, "");
+}
+function parseApiResponse(json, errorMessage, statusCode, allowEmptyData = false) {
     if (typeof json !== "object" || json === null) {
-        throw new ApiError(`Invalid response: ${errorMessage} - not an object`, statusCode);
+        throw new ApiError(`Invalid response: ${errorMessage}`, statusCode);
     }
     const response = json;
     if (response.code !== 200) {
-        const errorMsg = typeof response.msg === "string" ? response.msg : errorMessage;
-        throw new ApiError(errorMsg, statusCode, response.code);
+        throw new ApiError(response.msg ?? errorMessage, statusCode, response.code);
     }
-    if (!response.data) {
-        throw new ApiError(`Invalid response: ${errorMessage} - missing data`, statusCode);
+    if (!allowEmptyData && response.data === undefined) {
+        throw new ApiError(`Invalid response: ${errorMessage}`, statusCode);
     }
     return response.data;
 }
-// ==================== Functions ====================
-/**
- * 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 async function getUserGroup(groupId, options) {
-    if (!groupId || groupId.trim() === "") {
-        throw new ApiError("groupId is required", 400, "9400");
-    }
+async function request(path, method, options, body, allowEmptyData = false) {
     const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = String(base).replace(/\/+$/, "") +
-        `/user-group/v1/${encodeURIComponent(groupId)}`;
     let response;
     try {
-        response = await globalThis.fetch(url, {
-            method: "GET",
+        response = await globalThis.fetch(getBaseUrl(options) + path, {
+            method,
             headers: {
                 "Content-Type": "application/json",
                 "x-t-token": token,
             },
+            body: body === undefined ? undefined : JSON.stringify(body),
         });
     }
     catch (error) {
-        throw new NetworkError(`Failed to get user group: ${error instanceof Error ? error.message : "Unknown error"}`);
-    }
-    const json = (await response.json());
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === "string" ? json.msg : "Failed to get user group";
-        throw new ApiError(errorMsg, response.status, json.code);
+        throw new NetworkError(`User group request failed: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
-    if (!json.data) {
-        throw new ApiError("Invalid user group response: missing data", response.status);
+    return parseApiResponse(await response.json(), "User group request failed", response.status, allowEmptyData);
+}
+export async function getUserGroup(groupId, options) {
+    if (!groupId || groupId.trim() === "") {
+        throw new ApiError("groupId is required", 400, "9400");
     }
-    return json.data;
+    return request(`/user-group/v2/${encodeURIComponent(groupId)}`, "GET", options);
 }
-/**
- * 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 async function listUserGroups(options) {
-    const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = new URL(String(base).replace(/\/+$/, "") + "/user-group/v2");
-    const { appToken, baseUrl, ...requestParams } = options || {};
+    const { appToken, baseUrl, ...params } = options || {};
+    const url = new URL(getBaseUrl(options) + "/user-group/v2");
     const queryParams = {
         page: 0,
-        size: 10,
+        size: 20,
         sort: "createdAt,desc",
-        ...requestParams,
+        ...params,
     };
     Object.entries(queryParams).forEach(([key, value]) => {
-        if (value !== undefined) {
+        if (value !== undefined)
             url.searchParams.append(key, String(value));
-        }
     });
+    const token = options?.appToken ?? (await getAppToken(options));
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
             method: "GET",
-            headers: {
-                "Content-Type": "application/json",
-                "x-t-token": token,
-            },
+            headers: { "Content-Type": "application/json", "x-t-token": token },
         });
     }
     catch (error) {
         throw new NetworkError(`Failed to list user groups: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
-    const json = await response.json();
-    return parseApiResponse(json, "Failed to list user groups", response.status);
+    return parseApiResponse(await response.json(), "Failed to list user groups", response.status);
 }
-/**
- * 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 async function createUserGroup(request, options) {
-    if (!request.name || request.name.trim() === "") {
+export async function createUserGroup(requestBody, options) {
+    if (!requestBody.name || requestBody.name.trim() === "") {
         throw new ApiError("name is required", 400, "9400");
     }
-    const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = String(base).replace(/\/+$/, "") + "/user-group/v1";
-    let response;
-    try {
-        response = await globalThis.fetch(url, {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "x-t-token": token,
-            },
-            body: JSON.stringify(request),
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to create user group: ${error instanceof Error ? error.message : "Unknown error"}`);
-    }
-    const json = (await response.json());
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === "string" ? json.msg : "Failed to create user group";
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
-    if (!json.data) {
-        throw new ApiError("Invalid user group creation response: missing data", response.status);
-    }
-    return json.data;
+    return request("/user-group/v2", "POST", options, requestBody);
 }
-/**
- * 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 async function updateUserGroup(groupId, request, options) {
+export async function updateUserGroup(groupId, requestBody, options) {
     if (!groupId || groupId.trim() === "") {
         throw new ApiError("groupId is required", 400, "9400");
     }
-    const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = String(base).replace(/\/+$/, "") +
-        `/user-group/v1/${encodeURIComponent(groupId)}`;
-    let response;
-    try {
-        response = await globalThis.fetch(url, {
-            method: "PUT",
-            headers: {
-                "Content-Type": "application/json",
-                "x-t-token": token,
-            },
-            body: JSON.stringify(request),
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to update user group: ${error instanceof Error ? error.message : "Unknown error"}`);
-    }
-    const json = (await response.json());
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === "string" ? json.msg : "Failed to update user group";
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
-    if (!json.data) {
-        throw new ApiError("Invalid user group update response: missing data", response.status);
-    }
-    return json.data;
+    return request(`/user-group/v2/${encodeURIComponent(groupId)}`, "PUT", options, requestBody);
 }
-/**
- * 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 async function deleteUserGroup(groupId, options) {
     if (!groupId || groupId.trim() === "") {
         throw new ApiError("groupId is required", 400, "9400");
     }
-    const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = String(base).replace(/\/+$/, "") +
-        `/user-group/v1/${encodeURIComponent(groupId)}`;
-    let response;
-    try {
-        response = await globalThis.fetch(url, {
-            method: "DELETE",
-            headers: {
-                "Content-Type": "application/json",
-                "x-t-token": token,
-            },
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to delete user group: ${error instanceof Error ? error.message : "Unknown error"}`);
-    }
-    const json = (await response.json());
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === "string" ? json.msg : "Failed to delete user group";
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
+    await request(`/user-group/v2/${encodeURIComponent(groupId)}`, "DELETE", options, undefined, true);
 }
-/**
- * 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 async function listUserGroupMembers(groupId, options) {
     if (!groupId || groupId.trim() === "") {
         throw new ApiError("groupId is required", 400, "9400");
     }
-    const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = new URL(String(base).replace(/\/+$/, "") +
-        `/user-group/v1/${encodeURIComponent(groupId)}/members`);
-    const { appToken, baseUrl, ...requestParams } = options || {};
+    const { appToken, baseUrl, ...params } = options || {};
+    const url = new URL(getBaseUrl(options) +
+        `/user-group/v2/${encodeURIComponent(groupId)}/members`);
     const queryParams = {
         page: 0,
-        size: 10,
+        size: 20,
         sort: "createdAt,desc",
-        ...requestParams,
+        ...params,
     };
     Object.entries(queryParams).forEach(([key, value]) => {
-        if (value !== undefined) {
+        if (value !== undefined)
             url.searchParams.append(key, String(value));
-        }
     });
+    const token = options?.appToken ?? (await getAppToken(options));
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
             method: "GET",
-            headers: {
-                "Content-Type": "application/json",
-                "x-t-token": token,
-            },
+            headers: { "Content-Type": "application/json", "x-t-token": token },
         });
     }
     catch (error) {
         throw new NetworkError(`Failed to list user group members: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
-    const json = await response.json();
-    return parseApiResponse(json, "Failed to list user group members", response.status);
+    return parseApiResponse(await response.json(), "Failed to list user group members", response.status);
 }
-/**
- * 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 async function addUserGroupMembers(groupId, request, options) {
+function validateMemberRequest(requestBody) {
+    if (!requestBody.userIds ||
+        !Array.isArray(requestBody.userIds) ||
+        requestBody.userIds.length === 0) {
+        throw new ApiError("userIds is required and must be a non-empty array", 400, "9400");
+    }
+}
+export async function addUserGroupMembers(groupId, requestBody, options) {
     if (!groupId || groupId.trim() === "") {
         throw new ApiError("groupId is required", 400, "9400");
     }
-    if (!request.user_ids ||
-        !Array.isArray(request.user_ids) ||
-        request.user_ids.length === 0) {
-        throw new ApiError("user_ids is required and must be a non-empty array", 400, "9400");
-    }
-    const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = String(base).replace(/\/+$/, "") +
-        `/user-group/v1/${encodeURIComponent(groupId)}/members`;
-    let response;
-    try {
-        response = await globalThis.fetch(url, {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "x-t-token": token,
-            },
-            body: JSON.stringify(request),
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to add user group members: ${error instanceof Error ? error.message : "Unknown error"}`);
-    }
-    const json = (await response.json());
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === "string"
-            ? json.msg
-            : "Failed to add user group members";
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
+    validateMemberRequest(requestBody);
+    await request(`/user-group/v2/${encodeURIComponent(groupId)}/members`, "POST", options, requestBody, true);
 }
-/**
- * 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 async function removeUserGroupMembers(groupId, request, options) {
+export async function removeUserGroupMembers(groupId, requestBody, options) {
     if (!groupId || groupId.trim() === "") {
         throw new ApiError("groupId is required", 400, "9400");
     }
-    if (!request.user_ids ||
-        !Array.isArray(request.user_ids) ||
-        request.user_ids.length === 0) {
-        throw new ApiError("user_ids is required and must be a non-empty array", 400, "9400");
-    }
-    const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = String(base).replace(/\/+$/, "") +
-        `/user-group/v1/${encodeURIComponent(groupId)}/members`;
-    let response;
-    try {
-        response = await globalThis.fetch(url, {
-            method: "DELETE",
-            headers: {
-                "Content-Type": "application/json",
-                "x-t-token": token,
-            },
-            body: JSON.stringify(request),
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to remove user group members: ${error instanceof Error ? error.message : "Unknown error"}`);
-    }
-    const json = (await response.json());
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === "string"
-            ? json.msg
-            : "Failed to remove user group members";
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
+    validateMemberRequest(requestBody);
+    await request(`/user-group/v2/${encodeURIComponent(groupId)}/members`, "DELETE", options, requestBody, true);
 }
-/**
- * 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 async function getUserGroups(userId, options) {
     if (!userId || userId.trim() === "") {
         throw new ApiError("userId is required", 400, "9400");
     }
-    const token = options?.appToken ?? (await getAppToken(options));
-    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
-    if (!base) {
-        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
-    }
-    const url = String(base).replace(/\/+$/, "") +
-        `/user-group/v1/by-user/${encodeURIComponent(userId)}`;
-    let response;
-    try {
-        response = await globalThis.fetch(url, {
-            method: "GET",
-            headers: {
-                "Content-Type": "application/json",
-                "x-t-token": token,
-            },
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to get user groups: ${error instanceof Error ? error.message : "Unknown error"}`);
-    }
-    const json = (await response.json());
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === "string" ? json.msg : "Failed to get user groups";
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
-    if (!json.data || !Array.isArray(json.data)) {
-        throw new ApiError("Invalid user groups response: missing data", response.status);
-    }
-    return json.data;
+    return request(`/user-group/v2/by-user/${encodeURIComponent(userId)}`, "GET", options);
 }

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

@@ -33,7 +33,7 @@ export interface UpdateUserGroupRequest {
     remark?: string;
 }
 export interface UserGroupMemberRequest {
-    user_ids: string[];
+    userIds: string[];
 }
 export interface UserGroupOptions extends CommonOptions {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turinhub/tale-js-sdk",
-  "version": "1.3.0",
+  "version": "2.1.0",
   "description": "Official TypeScript SDK for Tale backend services",
   "keywords": [
     "tale",