tale-js-sdk 0.1.2 → 0.1.3

package/dist/auth.d.ts

@@ -1,271 +0,0 @@
-export interface LoginRequest {
-    username: string;
-    password: string;
-    app_key?: string;
-}
-export interface LoginOptions {
-    baseUrl?: string;
-    appKey?: string;
-    device_name?: string;
-    device_fingerprint?: string;
-    scope?: string;
-}
-export interface SendSmsOptions {
-    baseUrl?: string;
-    appKey?: string;
-}
-export interface VerifySmsOptions {
-    baseUrl?: string;
-    appKey?: string;
-    device_name?: string;
-    device_fingerprint?: string;
-    scope?: string;
-}
-export interface AuthAppInfo {
-    app_id: string;
-    org_id: string;
-    app_key: string;
-    app_name: string;
-}
-export interface AuthUser {
-    user_id: string;
-    nick_name: string;
-    avatar_url: string;
-    username: string;
-    email: string;
-    phone: string;
-    registered_at: string;
-    remark: string;
-    is_frozen: boolean;
-    latest_login_time?: string;
-}
-export interface UserToken {
-    token: string;
-    scope: string;
-    device_name?: string;
-    device_fingerprint?: string;
-    granted_at: string;
-    expired_at: string;
-}
-export interface AuthRole {
-    role_id: string;
-    role_name: string;
-    description?: string;
-    assigned_at: string;
-    expires_at?: string;
-    is_active: boolean;
-}
-export interface AuthPrivilege {
-    privilege_id: string;
-    privilege_name: string;
-    description?: string;
-    granted_directly: boolean;
-    role_id?: string;
-    assigned_at: string;
-    expires_at?: string;
-    is_active: boolean;
-}
-export interface AuthUserGroup {
-    group_id: string;
-    group_name: string;
-    description?: string;
-}
-export interface AuthUserLoginMethod {
-    method_type: string;
-    identifier: string;
-    is_active: boolean;
-    created_at: string;
-    last_used_at?: string;
-}
-export interface LoginResponse {
-    app: AuthAppInfo;
-    user: AuthUser;
-    token: UserToken;
-    user_roles: AuthRole[];
-    user_privileges: AuthPrivilege[];
-    user_groups: AuthUserGroup[];
-    user_login_methods: AuthUserLoginMethod[];
-}
-export interface LoginJson {
-    app: AuthAppInfo;
-    user: AuthUser;
-    token: UserToken;
-    user_roles: AuthRole[];
-    user_privileges: AuthPrivilege[];
-    user_groups: AuthUserGroup[];
-    user_login_methods: AuthUserLoginMethod[];
-}
-export interface SendSmsResponse {
-    app_key: string;
-    phone: string;
-    type: 'login' | 'register';
-    sms_id: string;
-    expired_at: string;
-}
-export interface SendSmsJson {
-    app_key: string;
-    phone: string;
-    type: 'login' | 'register';
-    sms_id: string;
-    expired_at: string;
-}
-export interface VerifySmsRequest {
-    sms_id: string;
-    sms_type: 'login' | 'register';
-    verification_code: string;
-    username?: string;
-    password_encrypted?: string;
-}
-export interface SmsLoginResponse {
-    app: AuthAppInfo;
-    user: AuthUser;
-    token: UserToken;
-    user_roles: AuthRole[];
-    user_privileges: AuthPrivilege[];
-    user_groups: AuthUserGroup[];
-    user_login_methods: AuthUserLoginMethod[];
-}
-export interface SmsLoginJson {
-    app: AuthAppInfo;
-    user: AuthUser;
-    token: UserToken;
-    user_roles: AuthRole[];
-    user_privileges: AuthPrivilege[];
-    user_groups: AuthUserGroup[];
-    user_login_methods: AuthUserLoginMethod[];
-}
-/**
- * Authenticates a user with username and password.
- *
- * @param credentials - User login credentials
- * @param options - Optional configuration for the login request
- * @returns Promise resolving to login response with user info and token
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When authentication fails or returns invalid response
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { login } from '@tale/client';
- *
- * try {
- *   const result = await login({
- *     username: 'johndoe',
- *     password: 'secure_password_123'
- *   });
- *   console.log('Login successful:', result.user.username);
- *   console.log('User token:', result.token.token);
- * } catch (error) {
- *   console.error('Login failed:', error.message);
- * }
- * ```
- */
-export declare function login(credentials: LoginRequest, options?: LoginOptions): Promise<LoginResponse>;
-/**
- * Validates a user token.
- *
- * @param token - User token to validate
- * @param options - Optional configuration for validation
- * @returns Promise resolving to validation result
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When validation fails
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { validateToken } from '@tale/client';
- *
- * try {
- *   const result = await validateToken('tu_user_token_here');
- *   console.log('Token is valid');
- * } catch (error) {
- *   console.error('Token validation failed:', error.message);
- * }
- * ```
- */
-export declare function validateToken(token: string, options?: {
-    scope?: string;
-    baseUrl?: string;
-}): Promise<boolean>;
-/**
- * Sends SMS verification code for login or registration.
- *
- * @param phone - Phone number for sending SMS
- * @param options - Optional configuration for the request
- * @returns Promise resolving to SMS sending response
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When SMS sending fails or returns invalid response
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { sendSmsVerification } from '@tale/client';
- *
- * try {
- *   const result = await sendSmsVerification('+8613800138000');
- *   console.log('SMS sent:', result.sms_id);
- *   console.log('Type:', result.type); // 'login' or 'register'
- * } catch (error) {
- *   console.error('SMS sending failed:', error.message);
- * }
- * ```
- */
-export declare function sendSmsVerification(phone: string, options?: SendSmsOptions): Promise<SendSmsResponse>;
-/**
- * Verifies SMS code and authenticates user (login or register).
- *
- * @param request - SMS verification request with sms_id, code, and optional user data
- * @param options - Optional configuration for the request
- * @returns Promise resolving to login response with user info and token
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When verification fails or returns invalid response
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { verifySmsCode } from '@tale/client';
- *
- * try {
- *   const result = await verifySmsCode({
- *     sms_id: 'uuid-here',
- *     sms_type: 'login',
- *     verification_code: '123456'
- *   });
- *   console.log('Login successful:', result.user.user_id);
- *   console.log('User token:', result.token.token);
- * } catch (error) {
- *   console.error('SMS verification failed:', error.message);
- * }
- * ```
- */
-export declare function verifySmsCode(request: VerifySmsRequest, options?: VerifySmsOptions): Promise<SmsLoginResponse>;
-/**
- * Registers a new user with SMS verification and optional additional information.
- *
- * @param request - Registration request with SMS verification and optional user data
- * @param options - Optional configuration for the request
- * @returns Promise resolving to registration response with user info and token
- * @throws {ConfigurationError} When required environment variables are missing
- * @throws {ApiError} When registration fails or returns invalid response
- * @throws {NetworkError} When network request fails
- *
- * @example
- * ```typescript
- * import { registerWithSms } from '@tale/client';
- *
- * try {
- *   const result = await registerWithSms({
- *     sms_id: 'uuid-here',
- *     sms_type: 'register',
- *     verification_code: '123456',
- *     username: 'newuser',
- *     password_encrypted: 'encrypted_password'
- *   });
- *   console.log('Registration successful:', result.user.user_id);
- *   console.log('User token:', result.token.token);
- * } catch (error) {
- *   console.error('Registration failed:', error.message);
- * }
- * ```
- */
-export declare function registerWithSms(request: VerifySmsRequest, options?: VerifySmsOptions): Promise<SmsLoginResponse>;