vesant-sdk 1.0.4

package/dist/types-Bnsnejor.d.mts

@@ -0,0 +1,150 @@
+/**
+ * Configuration types for Vesant SDK clients
+ */
+interface BaseClientConfig {
+    /** Base URL for the service */
+    baseURL: string;
+    /** Tenant ID for multi-tenancy */
+    tenantId: string;
+    /** Optional API key for authentication */
+    apiKey?: string;
+    /** Custom headers to include in all requests */
+    headers?: Record<string, string>;
+    /** Request timeout in milliseconds (default: 10000) */
+    timeout?: number;
+    /** Number of retry attempts (default: 3) */
+    retries?: number;
+    /** Enable debug logging (default: false) */
+    debug?: boolean;
+}
+interface CGSConfig {
+    /** Base URL for the Vesant API */
+    baseURL: string;
+    /** Tenant ID for multi-tenancy */
+    tenantId: string;
+    /** Optional API key for authentication */
+    apiKey?: string;
+    /** Custom headers to include in all requests */
+    headers?: Record<string, string>;
+    /** Request timeout in milliseconds (default: 10000) */
+    timeout?: number;
+    /** Number of retry attempts for failed requests (default: 3) */
+    retries?: number;
+    /** Enable debug logging (default: false) */
+    debug?: boolean;
+    /** Automatically create customer profiles on geolocation verification (default: true) */
+    autoCreateProfiles?: boolean;
+    /** Sync mode: 'async' uses events, 'sync' uses direct API calls (default: 'sync') */
+    syncMode?: 'async' | 'sync';
+}
+type RequiredCGSConfig = Required<CGSConfig>;
+type RequiredBaseClientConfig = Required<BaseClientConfig>;
+
+/**
+ * Base HTTP client for all CGS SDK clients
+ *
+ * Provides common functionality:
+ * - Request/response handling
+ * - Error handling
+ * - Retry logic with exponential backoff
+ * - Timeout management
+ * - Debug logging
+ */
+
+declare abstract class BaseClient {
+    protected config: RequiredBaseClientConfig;
+    constructor(config: BaseClientConfig);
+    /**
+     * Make an HTTP request with timeout and error handling
+     */
+    protected request<T>(endpoint: string, options?: RequestInit, serviceURL?: string): Promise<T>;
+    /**
+     * Make an HTTP request with retry logic
+     */
+    protected requestWithRetry<T>(endpoint: string, options?: RequestInit, serviceURL?: string, retries?: number): Promise<T>;
+    /**
+     * Handle error responses from API
+     */
+    protected handleErrorResponse(status: number, data: any): never;
+    /**
+     * Build query string from parameters
+     */
+    protected buildQueryString(params: Record<string, unknown>): string;
+    /**
+     * Update client configuration
+     */
+    updateConfig(config: Partial<BaseClientConfig>): void;
+    /**
+     * Get current configuration (readonly)
+     */
+    getConfig(): Readonly<BaseClientConfig>;
+    /**
+     * Health check endpoint
+     */
+    healthCheck(): Promise<{
+        status: string;
+        timestamp: string;
+    }>;
+}
+
+/**
+ * Shared types used across all CGS SDK modules
+ */
+interface APIResponse<T> {
+    data?: T;
+    error?: string;
+    message?: string;
+}
+interface PaginationParams {
+    page?: number;
+    page_size?: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}
+interface SuccessResponse<T = unknown> {
+    success: true;
+    data: T;
+    message?: string;
+}
+interface ErrorResponse {
+    success: false;
+    error: string;
+    code?: string;
+    details?: Record<string, unknown>;
+}
+type Result<T> = SuccessResponse<T> | ErrorResponse;
+/**
+ * Standard timestamp format: ISO 8601
+ */
+type Timestamp = string;
+/**
+ * UUID format
+ */
+type UUID = string;
+/**
+ * Risk levels used across the platform
+ */
+type RiskLevel = 'low' | 'medium' | 'high' | 'critical';
+/**
+ * Customer status types
+ */
+type CustomerStatus = 'active' | 'dormant' | 'deactive' | 'suspended';
+/**
+ * Entity types for customer profiles
+ */
+type EntityType = 'individual' | 'corporate' | 'joint_account' | 'minor_with_guardian';
+/**
+ * Location compliance status
+ */
+type LocationCompliance = 'compliant' | 'non-compliant' | 'unknown';
+/**
+ * Verification event types
+ */
+type VerificationEventType = 'registration' | 'login' | 'transaction' | 'withdrawal' | 'deposit' | 'api_access' | 'profile_update';
+
+export { type APIResponse as A, BaseClient as B, type CGSConfig as C, type ErrorResponse as E, type LocationCompliance as L, type PaginationParams as P, type RequiredCGSConfig as R, type SuccessResponse as S, type Timestamp as T, type UUID as U, type VerificationEventType as V, type BaseClientConfig as a, type RequiredBaseClientConfig as b, type PaginatedResponse as c, type Result as d, type RiskLevel as e, type CustomerStatus as f, type EntityType as g };

package/dist/types-Bnsnejor.d.ts

@@ -0,0 +1,150 @@
+/**
+ * Configuration types for Vesant SDK clients
+ */
+interface BaseClientConfig {
+    /** Base URL for the service */
+    baseURL: string;
+    /** Tenant ID for multi-tenancy */
+    tenantId: string;
+    /** Optional API key for authentication */
+    apiKey?: string;
+    /** Custom headers to include in all requests */
+    headers?: Record<string, string>;
+    /** Request timeout in milliseconds (default: 10000) */
+    timeout?: number;
+    /** Number of retry attempts (default: 3) */
+    retries?: number;
+    /** Enable debug logging (default: false) */
+    debug?: boolean;
+}
+interface CGSConfig {
+    /** Base URL for the Vesant API */
+    baseURL: string;
+    /** Tenant ID for multi-tenancy */
+    tenantId: string;
+    /** Optional API key for authentication */
+    apiKey?: string;
+    /** Custom headers to include in all requests */
+    headers?: Record<string, string>;
+    /** Request timeout in milliseconds (default: 10000) */
+    timeout?: number;
+    /** Number of retry attempts for failed requests (default: 3) */
+    retries?: number;
+    /** Enable debug logging (default: false) */
+    debug?: boolean;
+    /** Automatically create customer profiles on geolocation verification (default: true) */
+    autoCreateProfiles?: boolean;
+    /** Sync mode: 'async' uses events, 'sync' uses direct API calls (default: 'sync') */
+    syncMode?: 'async' | 'sync';
+}
+type RequiredCGSConfig = Required<CGSConfig>;
+type RequiredBaseClientConfig = Required<BaseClientConfig>;
+
+/**
+ * Base HTTP client for all CGS SDK clients
+ *
+ * Provides common functionality:
+ * - Request/response handling
+ * - Error handling
+ * - Retry logic with exponential backoff
+ * - Timeout management
+ * - Debug logging
+ */
+
+declare abstract class BaseClient {
+    protected config: RequiredBaseClientConfig;
+    constructor(config: BaseClientConfig);
+    /**
+     * Make an HTTP request with timeout and error handling
+     */
+    protected request<T>(endpoint: string, options?: RequestInit, serviceURL?: string): Promise<T>;
+    /**
+     * Make an HTTP request with retry logic
+     */
+    protected requestWithRetry<T>(endpoint: string, options?: RequestInit, serviceURL?: string, retries?: number): Promise<T>;
+    /**
+     * Handle error responses from API
+     */
+    protected handleErrorResponse(status: number, data: any): never;
+    /**
+     * Build query string from parameters
+     */
+    protected buildQueryString(params: Record<string, unknown>): string;
+    /**
+     * Update client configuration
+     */
+    updateConfig(config: Partial<BaseClientConfig>): void;
+    /**
+     * Get current configuration (readonly)
+     */
+    getConfig(): Readonly<BaseClientConfig>;
+    /**
+     * Health check endpoint
+     */
+    healthCheck(): Promise<{
+        status: string;
+        timestamp: string;
+    }>;
+}
+
+/**
+ * Shared types used across all CGS SDK modules
+ */
+interface APIResponse<T> {
+    data?: T;
+    error?: string;
+    message?: string;
+}
+interface PaginationParams {
+    page?: number;
+    page_size?: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}
+interface SuccessResponse<T = unknown> {
+    success: true;
+    data: T;
+    message?: string;
+}
+interface ErrorResponse {
+    success: false;
+    error: string;
+    code?: string;
+    details?: Record<string, unknown>;
+}
+type Result<T> = SuccessResponse<T> | ErrorResponse;
+/**
+ * Standard timestamp format: ISO 8601
+ */
+type Timestamp = string;
+/**
+ * UUID format
+ */
+type UUID = string;
+/**
+ * Risk levels used across the platform
+ */
+type RiskLevel = 'low' | 'medium' | 'high' | 'critical';
+/**
+ * Customer status types
+ */
+type CustomerStatus = 'active' | 'dormant' | 'deactive' | 'suspended';
+/**
+ * Entity types for customer profiles
+ */
+type EntityType = 'individual' | 'corporate' | 'joint_account' | 'minor_with_guardian';
+/**
+ * Location compliance status
+ */
+type LocationCompliance = 'compliant' | 'non-compliant' | 'unknown';
+/**
+ * Verification event types
+ */
+type VerificationEventType = 'registration' | 'login' | 'transaction' | 'withdrawal' | 'deposit' | 'api_access' | 'profile_update';
+
+export { type APIResponse as A, BaseClient as B, type CGSConfig as C, type ErrorResponse as E, type LocationCompliance as L, type PaginationParams as P, type RequiredCGSConfig as R, type SuccessResponse as S, type Timestamp as T, type UUID as U, type VerificationEventType as V, type BaseClientConfig as a, type RequiredBaseClientConfig as b, type PaginatedResponse as c, type Result as d, type RiskLevel as e, type CustomerStatus as f, type EntityType as g };

package/dist/types-CFupjwi8.d.ts

@@ -0,0 +1,213 @@
+import { g as EntityType, f as CustomerStatus, L as LocationCompliance, U as UUID, T as Timestamp, P as PaginationParams, c as PaginatedResponse } from './types-Bnsnejor.js';
+
+/**
+ * Type definitions for CGS Risk Profile Service
+ *
+ * These types match the Go structures in:
+ * services/customer-risk-profile-service/internal/domain/customer_profile.go
+ */
+
+interface CustomerProfile {
+    id: UUID;
+    tenant_id: UUID;
+    created_at: Timestamp;
+    updated_at: Timestamp;
+    customer_id: string;
+    account_number?: string;
+    entity_type: EntityType;
+    customer_status: CustomerStatus;
+    customer_tier?: string;
+    date_of_establishment?: Timestamp;
+    last_recorded_activity?: Timestamp;
+    full_name?: string;
+    date_of_birth?: Timestamp;
+    age?: number;
+    gender?: string;
+    business_name?: string;
+    registration_number?: string;
+    country_of_incorporation?: string;
+    date_of_incorporation?: Timestamp;
+    legal_form?: LegalForm;
+    nature_of_business?: string;
+    tax_id?: string;
+    annual_turnover?: number;
+    primary_phone_number?: string;
+    email_address: string;
+    residential_address?: string;
+    country_of_residence?: string;
+    registered_address?: string;
+    operating_address?: string;
+    occupation?: string;
+    employer_name?: string;
+    employment_type?: EmploymentType;
+    business_sector?: string;
+    income_range?: string;
+    source_of_funds?: string;
+    source_of_wealth?: string;
+    total_transactions: number;
+    total_volume: number;
+    flagged_transactions: number;
+    risk_score: number;
+    risk_category: RiskCategory;
+    previous_risk_score?: number;
+    previous_risk_category?: RiskCategory;
+    risk_last_calculated?: Timestamp;
+    watchlist_matches?: string[];
+    screening_status?: ScreeningStatus;
+    is_pep: boolean;
+    has_adverse_media: boolean;
+    has_sanctions: boolean;
+    requires_edd: boolean;
+    edd_notes?: string;
+    kyc_status?: string;
+    identification_type?: string;
+    identification_number?: string;
+    id_issuing_country?: string;
+    id_issue_date?: Timestamp;
+    id_expiry_date?: Timestamp;
+    location?: string;
+    location_compliance?: LocationCompliance;
+    risk_factors?: RiskFactor[];
+    risk_history?: RiskHistory[];
+}
+type RiskCategory = 'low' | 'medium' | 'high' | 'critical';
+type EmploymentType = 'salaried' | 'self_employed' | 'unemployed';
+type LegalForm = 'limited' | 'partnership' | 'ngo' | 'trust' | 'sole_trader';
+type ScreeningStatus = 'clear' | 'potential_match' | 'true_positive' | 'false_positive';
+interface RiskFactor {
+    id: UUID;
+    tenant_id: UUID;
+    profile_id: UUID;
+    factor_type: RiskFactorType;
+    factor_name: string;
+    score: number;
+    weight: number;
+    weighted_score: number;
+    description?: string;
+    evidence?: Record<string, unknown>;
+    source_event?: string;
+    source_service?: string;
+    reference_id?: string;
+    metadata?: Record<string, unknown>;
+    is_active: boolean;
+    expires_at?: Timestamp;
+    created_at: Timestamp;
+    updated_at: Timestamp;
+}
+type RiskFactorType = 'kyc' | 'aml' | 'fraud' | 'geolocation' | 'transaction' | 'watchlist' | 'pep' | 'sanctions' | 'adverse_media';
+interface RiskHistory {
+    id: UUID;
+    tenant_id: UUID;
+    profile_id: UUID;
+    previous_score: number;
+    new_score: number;
+    previous_category: RiskCategory;
+    new_category: RiskCategory;
+    change_reason: string;
+    triggered_by: string;
+    metadata?: Record<string, unknown>;
+    created_at: Timestamp;
+}
+interface CreateProfileRequest {
+    customer_id: string;
+    entity_type: EntityType;
+    customer_status?: CustomerStatus;
+    account_number?: string;
+    customer_tier?: string;
+    full_name?: string;
+    date_of_birth?: string;
+    gender?: string;
+    business_name?: string;
+    registration_number?: string;
+    country_of_incorporation?: string;
+    legal_form?: LegalForm;
+    nature_of_business?: string;
+    primary_phone_number?: string;
+    email_address: string;
+    residential_address?: string;
+    country_of_residence?: string;
+    registered_address?: string;
+    operating_address?: string;
+    occupation?: string;
+    employment_type?: EmploymentType;
+    income_range?: string;
+    source_of_funds?: string;
+    kyc_status?: string;
+    location?: string;
+    location_compliance?: LocationCompliance;
+}
+interface UpdateProfileRequest extends Partial<CreateProfileRequest> {
+    last_recorded_activity?: Timestamp;
+}
+interface ProfileDetailsResponse {
+    profile: CustomerProfile;
+    risk_factors: RiskFactor[];
+    risk_history: RiskHistory[];
+    watchlist_alert_count: number;
+    fraud_alert_count: number;
+    geolocation_alert_count: number;
+    kyc_alert_count: number;
+}
+interface ProfileFilters extends PaginationParams {
+    risk_category?: RiskCategory[];
+    min_risk_score?: number;
+    max_risk_score?: number;
+    entity_type?: EntityType[];
+    status?: CustomerStatus[];
+    location?: string[];
+    country_of_residence?: string[];
+    location_compliance?: LocationCompliance[];
+    is_pep?: boolean;
+    has_sanctions?: boolean;
+    has_adverse_media?: boolean;
+    requires_edd?: boolean;
+    kyc_status?: string[];
+    search?: string;
+    sort_by?: 'risk_score' | 'created_at' | 'updated_at' | 'customer_id' | 'full_name';
+    sort_order?: 'asc' | 'desc';
+}
+type ProfileListResponse = PaginatedResponse<CustomerProfile>;
+interface RiskDashboardMetrics {
+    total_risky_profiles: number;
+    total_critical_profiles: number;
+    total_high_profiles: number;
+    total_medium_profiles: number;
+    total_low_profiles: number;
+    total_pep_profiles: number;
+    total_sanctioned_profiles: number;
+    total_edd_required: number;
+    average_risk_score: number;
+    risk_distribution: Array<{
+        category: RiskCategory;
+        count: number;
+        percentage: number;
+    }>;
+    trend_indicators: {
+        critical_trend: 'up' | 'down' | 'stable';
+        critical_change: number;
+        high_trend: 'up' | 'down' | 'stable';
+        high_change: number;
+    };
+    recent_high_risk_profiles?: CustomerProfile[];
+}
+interface RiskConfiguration {
+    id: UUID;
+    tenant_id: UUID;
+    kyc_weight: number;
+    aml_weight: number;
+    fraud_weight: number;
+    geolocation_weight: number;
+    transaction_weight: number;
+    watchlist_weight: number;
+    critical_threshold: number;
+    high_threshold: number;
+    medium_threshold: number;
+    auto_escalate_critical: boolean;
+    create_case_on_critical: boolean;
+    auto_block_sanctioned: boolean;
+    require_review_on_pep: boolean;
+    created_at: Timestamp;
+    updated_at: Timestamp;
+}
+
+export type { CustomerProfile as C, EmploymentType as E, LegalForm as L, ProfileDetailsResponse as P, RiskCategory as R, ScreeningStatus as S, UpdateProfileRequest as U, RiskFactor as a, RiskFactorType as b, RiskHistory as c, CreateProfileRequest as d, ProfileFilters as e, ProfileListResponse as f, RiskDashboardMetrics as g, RiskConfiguration as h };