@turinhub/tale-js-sdk 1.3.0

package/dist/acl/types.d.ts

@@ -0,0 +1,142 @@
+import type { CommonOptions } from "../common/types.js";
+/**
+ * ACL Record (Access Control List Record)
+ * Represents a single access control rule
+ */
+export interface AclRecord {
+    record_id: string;
+    app_id: string;
+    template_id?: string;
+    subject_type: string;
+    subject_id?: string;
+    subject_identifier?: string;
+    resource_type: string;
+    resource_id?: string;
+    resource_identifier?: string;
+    effect_type: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
+    description?: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Request for creating an ACL record
+ */
+export interface CreateAclRecordRequest {
+    template_id?: string;
+    subject_type: string;
+    subject_id?: string;
+    subject_identifier?: string;
+    resource_type: string;
+    resource_id?: string;
+    resource_identifier?: string;
+    effect_type: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
+    description?: string;
+}
+/**
+ * Request for updating an ACL record
+ */
+export interface UpdateAclRecordRequest {
+    template_id?: string;
+    effect_type?: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
+    description?: string;
+}
+/**
+ * Request for listing ACL records
+ */
+export interface ListAclRecordsRequest {
+    page?: number;
+    size?: number;
+    sort?: string;
+    template_id?: string;
+    subject_type?: string;
+    subject_id?: string;
+    subject_identifier?: string;
+    resource_type?: string;
+    resource_id?: string;
+    resource_identifier?: string;
+}
+/**
+ * Batch creation response for ACL records
+ */
+export interface AclBatchCreateResponse {
+    success_count: number;
+    failure_count: number;
+    success_records: AclRecord[];
+    failures: AclBatchFailure[];
+}
+/**
+ * Failure details for batch creation
+ */
+export interface AclBatchFailure {
+    index: number;
+    request: CreateAclRecordRequest;
+    error_message: string;
+}
+/**
+ * ACL Template
+ * Represents a reusable ACL configuration template
+ */
+export interface AclTemplate {
+    template_id: string;
+    app_id: string;
+    template_name: string;
+    template_code: string;
+    subject_type?: string;
+    subject_filter?: Record<string, unknown>;
+    resource_type?: string;
+    resource_filter?: Record<string, unknown>;
+    effect_type?: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
+    description?: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Request for creating an ACL template
+ */
+export interface CreateAclTemplateRequest {
+    template_name: string;
+    template_code: string;
+    subject_type?: string;
+    subject_filter?: Record<string, unknown>;
+    resource_type?: string;
+    resource_filter?: Record<string, unknown>;
+    effect_type?: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
+    description?: string;
+}
+/**
+ * Request for updating an ACL template
+ */
+export interface UpdateAclTemplateRequest {
+    template_name?: string;
+    subject_filter?: Record<string, unknown>;
+    resource_filter?: Record<string, unknown>;
+    effect_type?: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
+    description?: string;
+}
+/**
+ * Request for listing ACL templates
+ */
+export interface ListAclTemplatesRequest {
+    page?: number;
+    size?: number;
+    sort?: string;
+    resource_type?: string;
+    subject_type?: string;
+}
+/**
+ * Options for ACL operations
+ */
+export interface AclOptions extends CommonOptions {
+}

package/dist/acl/types.js

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

package/dist/auth/index.d.ts

@@ -0,0 +1,166 @@
+import type { LoginRequest, LoginOptions, LoginWithSmsOptions, VerifySmsOptions, AppInfo, AuthUser, UserToken, AuthRole, AuthPrivilege, UserGroup, AuthUserLoginMethod, LoginResponse, LoginJson, SendSmsResponse, SendSmsJson, VerifySmsRequest, SmsLoginResponse, SmsLoginJson } from "./types.js";
+export type { LoginRequest, LoginOptions, LoginWithSmsOptions, VerifySmsOptions, AppInfo, AuthUser, UserToken, AuthRole, AuthPrivilege, UserGroup, AuthUserLoginMethod, LoginResponse, LoginJson, SendSmsResponse, SendSmsJson, VerifySmsRequest, SmsLoginResponse, SmsLoginJson, };
+/**
+ * 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 (TALE_BASE_URL, TALE_APP_KEY) 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);
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * import { login } from '@tale/client';
+ *
+ * // Login with include parameters to control what data is returned
+ * const result = await login({
+ *   username: 'johndoe',
+ *   password: 'secure_password_123'
+ * }, {
+ *   include_rbac: true,           // Include roles and privileges (SDK default: false)
+ *   include_user_groups: true,    // Include user groups (SDK default: false)
+ *   include_login_methods: true,  // Include login methods (SDK default: false)
+ *   include_attributes: true,     // Include user attributes (SDK default: false)
+ *   include_acl: true             // Include ACL records (SDK default: false)
+ * });
+ * ```
+ *
+ * @note The function requires the following environment variables:
+ * - TALE_BASE_URL: Base URL for Tale backend services
+ * - TALE_APP_KEY: Application key for authentication
+ * @note By default, all include parameters are set to false for better performance.
+ *       Explicitly set them to true if you need the additional data.
+ *
+ * @param options.include_rbac Include roles and privileges; default false
+ * @param options.include_login_methods Include user login methods; default false
+ * @param options.include_user_groups Include user groups; default false
+ * @param options.include_attributes Include user attributes; default false
+ * @param options.include_acl Include ACL records; default false
+ */
+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>;
+/**
+ * Initiates SMS login by sending 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 { loginWithSms } from '@tale/client';
+ *
+ * try {
+ *   const result = await loginWithSms('+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 loginWithSms(phone: string, options?: LoginWithSmsOptions): 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>;