@keverdjs/fraud-sdk-angular 2.0.0 → 3.0.0

package/README.md

@@ -1,42 +1,39 @@
 # @keverdjs/fraud-sdk-angular
 
-Angular SDK for Keverd fraud detection and device fingerprinting.
+Angular SDK for Keverd persistent device intelligence.
 
-## Installation
+## Install
 
 ```bash
 npm install @keverdjs/fraud-sdk-angular
 ```
 
-## Quick Start
+## Quickstart
 
-```typescript
+```ts
+import { Component } from '@angular/core';
 import { KeverdService } from '@keverdjs/fraud-sdk-angular';
 
 @Component({
   selector: 'app-root',
   template: `
     <div *ngIf="loading">Loading...</div>
-    <div *ngIf="error">Error: {{ error.message }}</div>
-    <div *ngIf="data">Risk Score: {{ data.riskScore }}</div>
-  `
+    <div *ngIf="riskScore !== null">Risk: {{ riskScore }}</div>
+  `,
 })
 export class AppComponent {
-  data: any;
   loading = false;
-  error: any;
+  riskScore: number | null = null;
 
-  constructor(private keverd: KeverdService) {
-    this.keverd.init({ apiKey: 'your-api-key' });
-    this.loadData();
+  constructor(private readonly keverd: KeverdService) {
+    this.keverd.init({ apiKey: 'YOUR_PUBLIC_API_KEY' });
   }
 
-  async loadData() {
+  async ngOnInit(): Promise<void> {
     this.loading = true;
     try {
-      this.data = await this.keverd.getVisitorData();
-    } catch (err) {
-      this.error = err;
+      const result = await this.keverd.getVisitorData();
+      this.riskScore = result.riskScore;
     } finally {
       this.loading = false;
     }
@@ -44,9 +41,3 @@ export class AppComponent {
 }
 ```
 
-## Usage
-
-See the main [Keverd Fraud SDK Web README](../../README.md) for detailed documentation.
-
-> **Note**: This package is currently under development.
-

package/dist/index.d.mts

@@ -61,12 +61,30 @@ interface KeverdSimSwapEngine {
     updatedProfile?: Record<string, unknown>;
 }
 interface KeverdFingerprintResponse {
-    risk_score: number;
-    score: number;
-    action: 'allow' | 'soft_challenge' | 'hard_challenge' | 'block';
-    reason: string[];
-    session_id: string;
-    requestId: string;
+    risk_score?: number;
+    score?: number;
+    action?: 'allow' | 'soft_challenge' | 'hard_challenge' | 'block';
+    reason?: string[];
+    session_id?: string;
+    requestId?: string;
+    confidence?: number;
+    fingerprintjs_visitor_id?: string;
+    privacy_signals?: {
+        is_incognito?: boolean;
+        is_vpn?: boolean;
+        is_automated?: boolean;
+        has_ad_blocker?: boolean;
+    };
+    device_match?: boolean;
+    fraud_probability?: number;
+    recommended_action?: string;
+    adaptive_response?: {
+        recommended_action?: string;
+        challenges?: string[];
+        reason?: string;
+        confidence?: number;
+        [key: string]: unknown;
+    };
     sim_swap_engine?: KeverdSimSwapEngine;
 }
 interface KeverdPrivacySignals {
@@ -90,6 +108,13 @@ interface KeverdVisitorData {
     deviceMatch?: boolean;
     fraudProbability?: number;
     recommendedAction?: string;
+    adaptiveResponse?: {
+        recommendedAction?: string;
+        challenges?: string[];
+        reason?: string;
+        confidence?: number;
+        [key: string]: unknown;
+    };
 }
 interface KeverdConfig {
     apiKey: string;
@@ -102,6 +127,21 @@ interface KeverdLoadOptions {
     apiKey: string;
     debug?: boolean;
 }
+type LoginResult$1 = 'success' | 'failure';
+type AuthMethod$1 = 'password' | 'password_otp' | 'password_totp' | 'sso' | 'magic_link' | 'passkey' | 'unknown';
+interface LoginContext$1 {
+    identifierHash?: string;
+    result?: LoginResult$1;
+    failureReason?: string;
+    authMethod?: AuthMethod$1;
+    mfaUsed?: boolean;
+    attemptId?: string;
+}
+interface VerifyLoginOptions {
+    userId?: string;
+    login?: LoginContext$1;
+    metadata?: Record<string, unknown>;
+}
 interface KeverdVisitorDataOptions {
     extendedResult?: boolean;
     ignoreCache?: boolean;
@@ -133,6 +173,11 @@ declare class KeverdService {
      * Returns an RxJS Observable
      */
     getVisitorData(options?: KeverdVisitorDataOptions): Observable<KeverdVisitorData>;
+    /**
+     * Verify user identity during login attempts.
+     * Wraps the web SDK `verifyLogin` and exposes an Observable.
+     */
+    verifyLogin(options?: VerifyLoginOptions): Observable<KeverdFingerprintResponse>;
     /**
      * Collect data and send fingerprint request
      * Uses the web SDK which includes all enhanced signals including FingerprintJS
@@ -214,4 +259,40 @@ declare class KeverdModule {
     static forRoot(config: KeverdConfig): ModuleWithProviders<KeverdModule>;
 }
 
-export { type KeverdBehavioralData, type KeverdConfig, type KeverdDeviceInfo, type KeverdError, type KeverdFingerprintRequest, type KeverdFingerprintResponse, type KeverdLoadOptions, KeverdModule, KeverdService, type KeverdSessionInfo, type KeverdVisitorData, type KeverdVisitorDataOptions };
+type LoginResult = 'success' | 'failure';
+type AuthMethod = 'password' | 'password_otp' | 'password_totp' | 'sso' | 'magic_link' | 'passkey' | 'unknown';
+interface LoginContext {
+    identifierHash?: string;
+    result?: LoginResult;
+    failureReason?: string;
+    authMethod?: AuthMethod;
+    mfaUsed?: boolean;
+    attemptId?: string;
+}
+interface HashLoginIdentifierOptions {
+    salt?: string;
+    prefix?: string;
+}
+interface BuildLoginContextOptions {
+    identifier: string;
+    result?: LoginResult;
+    failureReason?: string;
+    authMethod?: AuthMethod;
+    mfaUsed?: boolean;
+    attemptId?: string;
+    salt?: string;
+}
+declare function hashLoginIdentifier(identifier: string, options?: HashLoginIdentifierOptions): Promise<string>;
+declare function buildLoginContextFromIdentifier(options: BuildLoginContextOptions): Promise<LoginContext>;
+
+interface AdaptiveActionHandlers {
+    onAllow?: (response: KeverdFingerprintResponse) => void;
+    onSoftChallenge?: (response: KeverdFingerprintResponse) => void;
+    onHardChallenge?: (response: KeverdFingerprintResponse) => void;
+    onBlock?: (response: KeverdFingerprintResponse) => void;
+    onChallenges?: (response: KeverdFingerprintResponse, challenges: string[]) => void;
+    onUnknown?: (response: KeverdFingerprintResponse) => void;
+}
+declare function handleAdaptiveResponse(response: KeverdFingerprintResponse, handlers: AdaptiveActionHandlers): void;
+
+export { type KeverdBehavioralData, type KeverdConfig, type KeverdDeviceInfo, type KeverdError, type KeverdFingerprintRequest, type KeverdFingerprintResponse, type KeverdLoadOptions, KeverdModule, KeverdService, type KeverdSessionInfo, type KeverdVisitorData, type KeverdVisitorDataOptions, buildLoginContextFromIdentifier, handleAdaptiveResponse, hashLoginIdentifier };

package/dist/index.d.ts

@@ -61,12 +61,30 @@ interface KeverdSimSwapEngine {
     updatedProfile?: Record<string, unknown>;
 }
 interface KeverdFingerprintResponse {
-    risk_score: number;
-    score: number;
-    action: 'allow' | 'soft_challenge' | 'hard_challenge' | 'block';
-    reason: string[];
-    session_id: string;
-    requestId: string;
+    risk_score?: number;
+    score?: number;
+    action?: 'allow' | 'soft_challenge' | 'hard_challenge' | 'block';
+    reason?: string[];
+    session_id?: string;
+    requestId?: string;
+    confidence?: number;
+    fingerprintjs_visitor_id?: string;
+    privacy_signals?: {
+        is_incognito?: boolean;
+        is_vpn?: boolean;
+        is_automated?: boolean;
+        has_ad_blocker?: boolean;
+    };
+    device_match?: boolean;
+    fraud_probability?: number;
+    recommended_action?: string;
+    adaptive_response?: {
+        recommended_action?: string;
+        challenges?: string[];
+        reason?: string;
+        confidence?: number;
+        [key: string]: unknown;
+    };
     sim_swap_engine?: KeverdSimSwapEngine;
 }
 interface KeverdPrivacySignals {
@@ -90,6 +108,13 @@ interface KeverdVisitorData {
     deviceMatch?: boolean;
     fraudProbability?: number;
     recommendedAction?: string;
+    adaptiveResponse?: {
+        recommendedAction?: string;
+        challenges?: string[];
+        reason?: string;
+        confidence?: number;
+        [key: string]: unknown;
+    };
 }
 interface KeverdConfig {
     apiKey: string;
@@ -102,6 +127,21 @@ interface KeverdLoadOptions {
     apiKey: string;
     debug?: boolean;
 }
+type LoginResult$1 = 'success' | 'failure';
+type AuthMethod$1 = 'password' | 'password_otp' | 'password_totp' | 'sso' | 'magic_link' | 'passkey' | 'unknown';
+interface LoginContext$1 {
+    identifierHash?: string;
+    result?: LoginResult$1;
+    failureReason?: string;
+    authMethod?: AuthMethod$1;
+    mfaUsed?: boolean;
+    attemptId?: string;
+}
+interface VerifyLoginOptions {
+    userId?: string;
+    login?: LoginContext$1;
+    metadata?: Record<string, unknown>;
+}
 interface KeverdVisitorDataOptions {
     extendedResult?: boolean;
     ignoreCache?: boolean;
@@ -133,6 +173,11 @@ declare class KeverdService {
      * Returns an RxJS Observable
      */
     getVisitorData(options?: KeverdVisitorDataOptions): Observable<KeverdVisitorData>;
+    /**
+     * Verify user identity during login attempts.
+     * Wraps the web SDK `verifyLogin` and exposes an Observable.
+     */
+    verifyLogin(options?: VerifyLoginOptions): Observable<KeverdFingerprintResponse>;
     /**
      * Collect data and send fingerprint request
      * Uses the web SDK which includes all enhanced signals including FingerprintJS
@@ -214,4 +259,40 @@ declare class KeverdModule {
     static forRoot(config: KeverdConfig): ModuleWithProviders<KeverdModule>;
 }
 
-export { type KeverdBehavioralData, type KeverdConfig, type KeverdDeviceInfo, type KeverdError, type KeverdFingerprintRequest, type KeverdFingerprintResponse, type KeverdLoadOptions, KeverdModule, KeverdService, type KeverdSessionInfo, type KeverdVisitorData, type KeverdVisitorDataOptions };
+type LoginResult = 'success' | 'failure';
+type AuthMethod = 'password' | 'password_otp' | 'password_totp' | 'sso' | 'magic_link' | 'passkey' | 'unknown';
+interface LoginContext {
+    identifierHash?: string;
+    result?: LoginResult;
+    failureReason?: string;
+    authMethod?: AuthMethod;
+    mfaUsed?: boolean;
+    attemptId?: string;
+}
+interface HashLoginIdentifierOptions {
+    salt?: string;
+    prefix?: string;
+}
+interface BuildLoginContextOptions {
+    identifier: string;
+    result?: LoginResult;
+    failureReason?: string;
+    authMethod?: AuthMethod;
+    mfaUsed?: boolean;
+    attemptId?: string;
+    salt?: string;
+}
+declare function hashLoginIdentifier(identifier: string, options?: HashLoginIdentifierOptions): Promise<string>;
+declare function buildLoginContextFromIdentifier(options: BuildLoginContextOptions): Promise<LoginContext>;
+
+interface AdaptiveActionHandlers {
+    onAllow?: (response: KeverdFingerprintResponse) => void;
+    onSoftChallenge?: (response: KeverdFingerprintResponse) => void;
+    onHardChallenge?: (response: KeverdFingerprintResponse) => void;
+    onBlock?: (response: KeverdFingerprintResponse) => void;
+    onChallenges?: (response: KeverdFingerprintResponse, challenges: string[]) => void;
+    onUnknown?: (response: KeverdFingerprintResponse) => void;
+}
+declare function handleAdaptiveResponse(response: KeverdFingerprintResponse, handlers: AdaptiveActionHandlers): void;
+
+export { type KeverdBehavioralData, type KeverdConfig, type KeverdDeviceInfo, type KeverdError, type KeverdFingerprintRequest, type KeverdFingerprintResponse, type KeverdLoadOptions, KeverdModule, KeverdService, type KeverdSessionInfo, type KeverdVisitorData, type KeverdVisitorDataOptions, buildLoginContextFromIdentifier, handleAdaptiveResponse, hashLoginIdentifier };