tale-js-sdk 0.1.2 → 0.1.3

package/dist/user.d.ts

@@ -1,242 +0,0 @@
-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;
-}
-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;
-}
-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;
-}
-/**
- * Creates a new user in the Tale application.
- *
- * @param userData - User data to create the new user
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the created user 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 { createUser } from '@tale/client';
- *
- * try {
- *   const result = await createUser({
- *     username: 'john_doe',
- *     nickname: 'John Doe',
- *     email: 'john@example.com'
- *   });
- *   console.log('User created:', result.user.user_id);
- * } catch (error) {
- *   console.error('Failed to create user:', error.message);
- * }
- * ```
- */
-export declare function createUser(userData: CreateUserRequest, options?: CreateUserOptions): Promise<CreateUserResponse>;
-/**
- * Retrieves user information by ID or open ID.
- *
- * @param userId - Optional user ID (open_id) to query. If not provided, returns current user info
- * @param options - Optional parameters for inclusion flags and configuration
- * @returns Promise resolving to the user 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 { getUserById } from '@tale/client';
- *
- * try {
- *   const result = await getUserById('user_open_id_here');
- *   console.log('User info:', result.user.username);
- * } catch (error) {
- *   console.error('Failed to get user:', error.message);
- * }
- * ```
- */
-export declare function getUserById(userId?: string, options?: GetUserRequest & CommonOptions): Promise<CreateUserResponse>;
-/**
- * Deletes a user by ID or open ID.
- *
- * @param userId - User ID (open_id) to delete
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the deletion 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 { deleteUser } from '@tale/client';
- *
- * try {
- *   const result = await deleteUser('user_open_id_here');
- *   console.log('User deleted:', result.deleted);
- * } catch (error) {
- *   console.error('Failed to delete user:', error.message);
- * }
- * ```
- */
-export declare function deleteUser(userId: string, options?: CommonOptions): Promise<DeleteUserResponse>;
-/**
- * Lists users with pagination, filtering, and search capabilities.
- *
- * @param options - Optional parameters for pagination, filtering, and configuration
- * @returns Promise resolving to paginated user list with metadata
- * @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 { listUsers } from '@tale/client';
- *
- * try {
- *   const result = await listUsers({
- *     page: 0,
- *     size: 20,
- *     keyword: 'john',
- *     sort_by: 'username',
- *     sort_direction: 'asc'
- *   });
- *   console.log(`Found ${result.totalElements} users`);
- *   console.log('First user:', result.content[0].user.username);
- * } catch (error) {
- *   console.error('Failed to list users:', error.message);
- * }
- * ```
- */
-export declare function listUsers(options?: ListUsersRequest & CommonOptions): Promise<ListUsersResponse>;

package/dist/user.js

@@ -1,331 +0,0 @@
-import { getAppToken } from './token.js';
-import { ApiError, ConfigurationError, NetworkError } from './errors.js';
-/**
- * Creates a new user in the Tale application.
- *
- * @param userData - User data to create the new user
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the created user 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 { createUser } from '@tale/client';
- *
- * try {
- *   const result = await createUser({
- *     username: 'john_doe',
- *     nickname: 'John Doe',
- *     email: 'john@example.com'
- *   });
- *   console.log('User created:', result.user.user_id);
- * } catch (error) {
- *   console.error('Failed to create user:', error.message);
- * }
- * ```
- */
-export async function createUser(userData, options) {
-    // Validate required fields
-    if (!userData.username || userData.username.trim() === '') {
-        throw new ApiError('username is required', 400, '9400');
-    }
-    // Get app token for authentication
-    const token = await getAppToken(options);
-    // Determine base URL
-    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(/\/+$/, '') + '/account/v1/user';
-    let response;
-    try {
-        response = await globalThis.fetch(url, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                'x-t-token': token,
-            },
-            body: JSON.stringify(userData),
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to create user: ${error instanceof Error ? error.message : 'Unknown error'}`);
-    }
-    let json;
-    try {
-        const responseJson = await response.json();
-        json = responseJson;
-    }
-    catch (error) {
-        throw new ApiError(`Failed to parse user creation response: ${error instanceof Error ? error.message : 'Invalid JSON'}`, response.status);
-    }
-    // Handle API errors
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === 'string' ? json.msg : 'User creation failed';
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
-    // Validate response structure
-    if (!json.data || !json.data.user || !json.data.app) {
-        throw new ApiError('Invalid user creation response: missing required data', response.status);
-    }
-    return json.data;
-}
-/**
- * Retrieves user information by ID or open ID.
- *
- * @param userId - Optional user ID (open_id) to query. If not provided, returns current user info
- * @param options - Optional parameters for inclusion flags and configuration
- * @returns Promise resolving to the user 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 { getUserById } from '@tale/client';
- *
- * try {
- *   const result = await getUserById('user_open_id_here');
- *   console.log('User info:', result.user.username);
- * } catch (error) {
- *   console.error('Failed to get user:', error.message);
- * }
- * ```
- */
-export async function getUserById(userId, options) {
-    // Get app token for authentication
-    const token = await getAppToken(options);
-    // Determine base URL
-    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');
-    }
-    // Build URL with query parameters
-    const url = new URL(String(base).replace(/\/+$/, '') + '/account/v1/user');
-    // Add query parameters
-    const queryParams = {
-        user_id: userId,
-        include_rbac: true,
-        include_login_methods: true,
-        include_user_groups: true,
-        include_acl: false,
-        ...options
-    };
-    Object.entries(queryParams).forEach(([key, value]) => {
-        if (value !== undefined) {
-            url.searchParams.append(key, String(value));
-        }
-    });
-    let response;
-    try {
-        response = await globalThis.fetch(url.toString(), {
-            method: 'GET',
-            headers: {
-                'Content-Type': 'application/json',
-                'x-t-token': token,
-            },
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to get user: ${error instanceof Error ? error.message : 'Unknown error'}`);
-    }
-    let json;
-    try {
-        const responseJson = await response.json();
-        json = responseJson;
-    }
-    catch (error) {
-        throw new ApiError(`Failed to parse user response: ${error instanceof Error ? error.message : 'Invalid JSON'}`, response.status);
-    }
-    // Handle API errors
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === 'string' ? json.msg : 'User retrieval failed';
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
-    // Validate response structure
-    if (!json.data || !json.data.user || !json.data.app) {
-        throw new ApiError('Invalid user response: missing required data', response.status);
-    }
-    return json.data;
-}
-/**
- * Deletes a user by ID or open ID.
- *
- * @param userId - User ID (open_id) to delete
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the deletion 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 { deleteUser } from '@tale/client';
- *
- * try {
- *   const result = await deleteUser('user_open_id_here');
- *   console.log('User deleted:', result.deleted);
- * } catch (error) {
- *   console.error('Failed to delete user:', error.message);
- * }
- * ```
- */
-export async function deleteUser(userId, options) {
-    // Validate required fields
-    if (!userId || userId.trim() === '') {
-        throw new ApiError('user_id is required for deletion', 400, '9400');
-    }
-    // Get app token for authentication
-    const token = await getAppToken(options);
-    // Determine base URL
-    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(/\/+$/, '') + `/account/v1/users/${encodeURIComponent(userId)}`;
-    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: ${error instanceof Error ? error.message : 'Unknown error'}`);
-    }
-    let json;
-    try {
-        const responseJson = await response.json();
-        json = responseJson;
-    }
-    catch (error) {
-        throw new ApiError(`Failed to parse user deletion response: ${error instanceof Error ? error.message : 'Invalid JSON'}`, response.status);
-    }
-    // Handle API errors
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === 'string' ? json.msg : 'User deletion failed';
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
-    // Validate response structure
-    if (!json.data || json.data.deleted !== true) {
-        throw new ApiError('Invalid user deletion response: deletion not confirmed', response.status);
-    }
-    return json.data;
-}
-/**
- * Lists users with pagination, filtering, and search capabilities.
- *
- * @param options - Optional parameters for pagination, filtering, and configuration
- * @returns Promise resolving to paginated user list with metadata
- * @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 { listUsers } from '@tale/client';
- *
- * try {
- *   const result = await listUsers({
- *     page: 0,
- *     size: 20,
- *     keyword: 'john',
- *     sort_by: 'username',
- *     sort_direction: 'asc'
- *   });
- *   console.log(`Found ${result.totalElements} users`);
- *   console.log('First user:', result.content[0].user.username);
- * } catch (error) {
- *   console.error('Failed to list users:', error.message);
- * }
- * ```
- */
-export async function listUsers(options) {
-    // Get app token for authentication
-    const token = await getAppToken(options);
-    // Determine base URL
-    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');
-    }
-    // Build URL with query parameters
-    const url = new URL(String(base).replace(/\/+$/, '') + '/account/v1/users');
-    // Add query parameters with defaults
-    const queryParams = {
-        page: 0,
-        size: 20,
-        sort_by: 'createdAt',
-        sort_direction: 'desc',
-        include_attributes: false,
-        ...options
-    };
-    // Handle array parameters (need to be comma-separated)
-    if (queryParams.user_groups && queryParams.user_groups.length > 0) {
-        url.searchParams.append('user_groups', queryParams.user_groups.join(','));
-    }
-    if (queryParams.user_roles && queryParams.user_roles.length > 0) {
-        url.searchParams.append('user_roles', queryParams.user_roles.join(','));
-    }
-    if (queryParams.user_ids && queryParams.user_ids.length > 0) {
-        url.searchParams.append('user_ids', queryParams.user_ids.join(','));
-    }
-    // Add other parameters
-    if (queryParams.page !== undefined) {
-        url.searchParams.append('page', String(queryParams.page));
-    }
-    if (queryParams.size !== undefined) {
-        url.searchParams.append('size', String(queryParams.size));
-    }
-    if (queryParams.sort_by) {
-        url.searchParams.append('sort_by', queryParams.sort_by);
-    }
-    if (queryParams.sort_direction) {
-        url.searchParams.append('sort_direction', queryParams.sort_direction);
-    }
-    if (queryParams.keyword) {
-        url.searchParams.append('keyword', queryParams.keyword);
-    }
-    if (queryParams.include_attributes !== undefined) {
-        url.searchParams.append('include_attributes', String(queryParams.include_attributes));
-    }
-    let response;
-    try {
-        response = await globalThis.fetch(url.toString(), {
-            method: 'GET',
-            headers: {
-                'Content-Type': 'application/json',
-                'x-t-token': token,
-            },
-        });
-    }
-    catch (error) {
-        throw new NetworkError(`Failed to list users: ${error instanceof Error ? error.message : 'Unknown error'}`);
-    }
-    let json;
-    try {
-        const responseJson = await response.json();
-        json = responseJson;
-    }
-    catch (error) {
-        throw new ApiError(`Failed to parse users list response: ${error instanceof Error ? error.message : 'Invalid JSON'}`, response.status);
-    }
-    // Handle API errors
-    if (json.code !== 200) {
-        const errorMsg = typeof json.msg === 'string' ? json.msg : 'Users list retrieval failed';
-        throw new ApiError(errorMsg, response.status, json.code);
-    }
-    // Validate response structure
-    if (!json.data || !Array.isArray(json.data.content)) {
-        throw new ApiError('Invalid users list response: missing required data', response.status);
-    }
-    return json.data;
-}