@vesant-sdk/fraud 0.1.0-dev.40d1c39

package/dist/index.d.mts

@@ -0,0 +1,63 @@
+import { Timestamp, RiskLevel, BaseClient, RequestOptions } from '@vesant-sdk/core';
+
+/**
+ * Fraud scoring types.
+ */
+
+type FraudEventType = '$create_account' | '$verification' | '$login' | '$logout' | '$update_account' | '$update_password' | '$link_session_to_user' | '$security_notification' | '$transaction' | '$wager' | '$chargeback' | '$create_order' | '$update_order' | '$order_status' | '$add_promotion';
+interface FraudScoreRequest {
+    customer_id: string;
+    sift_user_id: string;
+    event_type: FraudEventType;
+    transaction_id?: string;
+    amount?: number;
+    currency?: string;
+    ip_address?: string;
+    device_id?: string;
+    user_agent?: string;
+    metadata?: Record<string, unknown>;
+}
+type FraudReactionType = 'approve' | 'reject' | 'hold' | 'restrict' | 'block' | 'refund' | 'void_transaction' | 'reverse_transaction' | 'freeze_account' | 'block_withdrawal' | 'limit_withdrawal' | 'disable_payment_method' | 'revoke_session' | 'require_reauth' | 'trigger_alert' | 'no_alert' | 'escalate' | 'increase_priority' | 'create_case' | 'auto_lock_account' | 'notify_team' | (string & Record<string, never>);
+interface TenantAction {
+    type: FraudReactionType;
+    params?: Record<string, unknown>;
+}
+type FraudDecision = 'approve' | 'review' | 'block' | 'reject' | (string & Record<string, never>);
+interface FraudScoreResponseData {
+    reference: string;
+    score: number;
+    risk_level: RiskLevel;
+    decision: FraudDecision;
+    signals: string[];
+    matched_rule_ids: string[];
+    matched_rule_names: string[];
+    applied_reactions: string[];
+    alert_created: boolean;
+    alert_reference?: string;
+    tenant_actions: TenantAction[];
+}
+interface FraudScoreResponseMetadata {
+    request_id?: string;
+    processing_ms?: number;
+    tenant_id?: string;
+    version?: string;
+}
+interface FraudScoreResponseEnvelope<T> {
+    success: boolean;
+    message: string;
+    data: T;
+    metadata?: FraudScoreResponseMetadata;
+    timestamp: Timestamp;
+}
+
+/**
+ * Fraud scoring API client.
+ */
+
+declare class FraudClient extends BaseClient {
+    scoreEvent(request: FraudScoreRequest, requestOptions?: RequestOptions): Promise<FraudScoreResponseEnvelope<FraudScoreResponseData>>;
+    scoreEventsBulk(requests: FraudScoreRequest[], requestOptions?: RequestOptions): Promise<FraudScoreResponseEnvelope<FraudScoreResponseData[]>>;
+    private validateScoreRequest;
+}
+
+export { FraudClient, type FraudDecision, type FraudEventType, type FraudReactionType, type FraudScoreRequest, type FraudScoreResponseData, type FraudScoreResponseEnvelope, type FraudScoreResponseMetadata, type TenantAction };

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import { Timestamp, RiskLevel, BaseClient, RequestOptions } from '@vesant-sdk/core';
+
+/**
+ * Fraud scoring types.
+ */
+
+type FraudEventType = '$create_account' | '$verification' | '$login' | '$logout' | '$update_account' | '$update_password' | '$link_session_to_user' | '$security_notification' | '$transaction' | '$wager' | '$chargeback' | '$create_order' | '$update_order' | '$order_status' | '$add_promotion';
+interface FraudScoreRequest {
+    customer_id: string;
+    sift_user_id: string;
+    event_type: FraudEventType;
+    transaction_id?: string;
+    amount?: number;
+    currency?: string;
+    ip_address?: string;
+    device_id?: string;
+    user_agent?: string;
+    metadata?: Record<string, unknown>;
+}
+type FraudReactionType = 'approve' | 'reject' | 'hold' | 'restrict' | 'block' | 'refund' | 'void_transaction' | 'reverse_transaction' | 'freeze_account' | 'block_withdrawal' | 'limit_withdrawal' | 'disable_payment_method' | 'revoke_session' | 'require_reauth' | 'trigger_alert' | 'no_alert' | 'escalate' | 'increase_priority' | 'create_case' | 'auto_lock_account' | 'notify_team' | (string & Record<string, never>);
+interface TenantAction {
+    type: FraudReactionType;
+    params?: Record<string, unknown>;
+}
+type FraudDecision = 'approve' | 'review' | 'block' | 'reject' | (string & Record<string, never>);
+interface FraudScoreResponseData {
+    reference: string;
+    score: number;
+    risk_level: RiskLevel;
+    decision: FraudDecision;
+    signals: string[];
+    matched_rule_ids: string[];
+    matched_rule_names: string[];
+    applied_reactions: string[];
+    alert_created: boolean;
+    alert_reference?: string;
+    tenant_actions: TenantAction[];
+}
+interface FraudScoreResponseMetadata {
+    request_id?: string;
+    processing_ms?: number;
+    tenant_id?: string;
+    version?: string;
+}
+interface FraudScoreResponseEnvelope<T> {
+    success: boolean;
+    message: string;
+    data: T;
+    metadata?: FraudScoreResponseMetadata;
+    timestamp: Timestamp;
+}
+
+/**
+ * Fraud scoring API client.
+ */
+
+declare class FraudClient extends BaseClient {
+    scoreEvent(request: FraudScoreRequest, requestOptions?: RequestOptions): Promise<FraudScoreResponseEnvelope<FraudScoreResponseData>>;
+    scoreEventsBulk(requests: FraudScoreRequest[], requestOptions?: RequestOptions): Promise<FraudScoreResponseEnvelope<FraudScoreResponseData[]>>;
+    private validateScoreRequest;
+}
+
+export { FraudClient, type FraudDecision, type FraudEventType, type FraudReactionType, type FraudScoreRequest, type FraudScoreResponseData, type FraudScoreResponseEnvelope, type FraudScoreResponseMetadata, type TenantAction };

package/dist/index.js

@@ -0,0 +1,59 @@
+'use strict';
+
+var core = require('@vesant-sdk/core');
+
+// src/client.ts
+var FraudClient = class extends core.BaseClient {
+  async scoreEvent(request, requestOptions) {
+    this.validateScoreRequest(request);
+    return this.requestWithRetry(
+      "/api/v1/fraud/score",
+      {
+        method: "POST",
+        body: JSON.stringify(request)
+      },
+      void 0,
+      void 0,
+      requestOptions
+    );
+  }
+  async scoreEventsBulk(requests, requestOptions) {
+    if (!Array.isArray(requests) || requests.length === 0) {
+      throw new core.ValidationError(
+        "Invalid bulk score request: at least one score request is required",
+        ["requests"]
+      );
+    }
+    requests.forEach((request, index) => this.validateScoreRequest(request, index));
+    return this.requestWithRetry(
+      "/api/v1/fraud/score/bulk",
+      {
+        method: "POST",
+        body: JSON.stringify(requests)
+      },
+      void 0,
+      void 0,
+      requestOptions
+    );
+  }
+  validateScoreRequest(request, index) {
+    const errors = [];
+    const prefix = index === void 0 ? "" : `requests[${index}].`;
+    if (!request.customer_id?.trim()) {
+      errors.push(`${prefix}customer_id is required`);
+    }
+    if (!request.sift_user_id?.trim()) {
+      errors.push(`${prefix}sift_user_id is required`);
+    }
+    if (!request.event_type?.trim()) {
+      errors.push(`${prefix}event_type is required`);
+    }
+    if (errors.length > 0) {
+      throw new core.ValidationError(`Invalid fraud score request: ${errors.join(", ")}`, errors);
+    }
+  }
+};
+
+exports.FraudClient = FraudClient;
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts"],"names":["BaseClient","ValidationError"],"mappings":";;;;;AAaO,IAAM,WAAA,GAAN,cAA0BA,eAAA,CAAW;AAAA,EAC1C,MAAM,UAAA,CACJ,OAAA,EACA,cAAA,EAC6D;AAC7D,IAAA,IAAA,CAAK,qBAAqB,OAAO,CAAA;AAEjC,IAAA,OAAO,IAAA,CAAK,gBAAA;AAAA,MACV,qBAAA;AAAA,MACA;AAAA,QACE,MAAA,EAAQ,MAAA;AAAA,QACR,IAAA,EAAM,IAAA,CAAK,SAAA,CAAU,OAAO;AAAA,OAC9B;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,QAAA,EACA,cAAA,EAC+D;AAC/D,IAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,QAAQ,CAAA,IAAK,QAAA,CAAS,WAAW,CAAA,EAAG;AACrD,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,oEAAA;AAAA,QACA,CAAC,UAAU;AAAA,OACb;AAAA,IACF;AAEA,IAAA,QAAA,CAAS,OAAA,CAAQ,CAAC,OAAA,EAAS,KAAA,KAAU,KAAK,oBAAA,CAAqB,OAAA,EAAS,KAAK,CAAC,CAAA;AAE9E,IAAA,OAAO,IAAA,CAAK,gBAAA;AAAA,MACV,0BAAA;AAAA,MACA;AAAA,QACE,MAAA,EAAQ,MAAA;AAAA,QACR,IAAA,EAAM,IAAA,CAAK,SAAA,CAAU,QAAQ;AAAA,OAC/B;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEQ,oBAAA,CAAqB,SAA4B,KAAA,EAAsB;AAC7E,IAAA,MAAM,SAAmB,EAAC;AAC1B,IAAA,MAAM,MAAA,GAAS,KAAA,KAAU,MAAA,GAAY,EAAA,GAAK,YAAY,KAAK,CAAA,EAAA,CAAA;AAE3D,IAAA,IAAI,CAAC,OAAA,CAAQ,WAAA,EAAa,IAAA,EAAK,EAAG;AAChC,MAAA,MAAA,CAAO,IAAA,CAAK,CAAA,EAAG,MAAM,CAAA,uBAAA,CAAyB,CAAA;AAAA,IAChD;AACA,IAAA,IAAI,CAAC,OAAA,CAAQ,YAAA,EAAc,IAAA,EAAK,EAAG;AACjC,MAAA,MAAA,CAAO,IAAA,CAAK,CAAA,EAAG,MAAM,CAAA,wBAAA,CAA0B,CAAA;AAAA,IACjD;AACA,IAAA,IAAI,CAAC,OAAA,CAAQ,UAAA,EAAY,IAAA,EAAK,EAAG;AAC/B,MAAA,MAAA,CAAO,IAAA,CAAK,CAAA,EAAG,MAAM,CAAA,sBAAA,CAAwB,CAAA;AAAA,IAC/C;AAEA,IAAA,IAAI,MAAA,CAAO,SAAS,CAAA,EAAG;AACrB,MAAA,MAAM,IAAIA,qBAAgB,CAAA,6BAAA,EAAgC,MAAA,CAAO,KAAK,IAAI,CAAC,IAAI,MAAM,CAAA;AAAA,IACvF;AAAA,EACF;AACF","file":"index.js","sourcesContent":["/**\n * Fraud scoring API client.\n */\n\nimport { BaseClient } from '@vesant-sdk/core';\nimport type { RequestOptions } from '@vesant-sdk/core';\nimport { ValidationError } from '@vesant-sdk/core';\nimport type {\n  FraudScoreRequest,\n  FraudScoreResponseData,\n  FraudScoreResponseEnvelope,\n} from './types';\n\nexport class FraudClient extends BaseClient {\n  async scoreEvent(\n    request: FraudScoreRequest,\n    requestOptions?: RequestOptions\n  ): Promise<FraudScoreResponseEnvelope<FraudScoreResponseData>> {\n    this.validateScoreRequest(request);\n\n    return this.requestWithRetry<FraudScoreResponseEnvelope<FraudScoreResponseData>>(\n      '/api/v1/fraud/score',\n      {\n        method: 'POST',\n        body: JSON.stringify(request),\n      },\n      undefined,\n      undefined,\n      requestOptions\n    );\n  }\n\n  async scoreEventsBulk(\n    requests: FraudScoreRequest[],\n    requestOptions?: RequestOptions\n  ): Promise<FraudScoreResponseEnvelope<FraudScoreResponseData[]>> {\n    if (!Array.isArray(requests) || requests.length === 0) {\n      throw new ValidationError(\n        'Invalid bulk score request: at least one score request is required',\n        ['requests']\n      );\n    }\n\n    requests.forEach((request, index) => this.validateScoreRequest(request, index));\n\n    return this.requestWithRetry<FraudScoreResponseEnvelope<FraudScoreResponseData[]>>(\n      '/api/v1/fraud/score/bulk',\n      {\n        method: 'POST',\n        body: JSON.stringify(requests),\n      },\n      undefined,\n      undefined,\n      requestOptions\n    );\n  }\n\n  private validateScoreRequest(request: FraudScoreRequest, index?: number): void {\n    const errors: string[] = [];\n    const prefix = index === undefined ? '' : `requests[${index}].`;\n\n    if (!request.customer_id?.trim()) {\n      errors.push(`${prefix}customer_id is required`);\n    }\n    if (!request.sift_user_id?.trim()) {\n      errors.push(`${prefix}sift_user_id is required`);\n    }\n    if (!request.event_type?.trim()) {\n      errors.push(`${prefix}event_type is required`);\n    }\n\n    if (errors.length > 0) {\n      throw new ValidationError(`Invalid fraud score request: ${errors.join(', ')}`, errors);\n    }\n  }\n}\n"]}

package/dist/index.mjs

@@ -0,0 +1,57 @@
+import { BaseClient, ValidationError } from '@vesant-sdk/core';
+
+// src/client.ts
+var FraudClient = class extends BaseClient {
+  async scoreEvent(request, requestOptions) {
+    this.validateScoreRequest(request);
+    return this.requestWithRetry(
+      "/api/v1/fraud/score",
+      {
+        method: "POST",
+        body: JSON.stringify(request)
+      },
+      void 0,
+      void 0,
+      requestOptions
+    );
+  }
+  async scoreEventsBulk(requests, requestOptions) {
+    if (!Array.isArray(requests) || requests.length === 0) {
+      throw new ValidationError(
+        "Invalid bulk score request: at least one score request is required",
+        ["requests"]
+      );
+    }
+    requests.forEach((request, index) => this.validateScoreRequest(request, index));
+    return this.requestWithRetry(
+      "/api/v1/fraud/score/bulk",
+      {
+        method: "POST",
+        body: JSON.stringify(requests)
+      },
+      void 0,
+      void 0,
+      requestOptions
+    );
+  }
+  validateScoreRequest(request, index) {
+    const errors = [];
+    const prefix = index === void 0 ? "" : `requests[${index}].`;
+    if (!request.customer_id?.trim()) {
+      errors.push(`${prefix}customer_id is required`);
+    }
+    if (!request.sift_user_id?.trim()) {
+      errors.push(`${prefix}sift_user_id is required`);
+    }
+    if (!request.event_type?.trim()) {
+      errors.push(`${prefix}event_type is required`);
+    }
+    if (errors.length > 0) {
+      throw new ValidationError(`Invalid fraud score request: ${errors.join(", ")}`, errors);
+    }
+  }
+};
+
+export { FraudClient };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts"],"names":[],"mappings":";;;AAaO,IAAM,WAAA,GAAN,cAA0B,UAAA,CAAW;AAAA,EAC1C,MAAM,UAAA,CACJ,OAAA,EACA,cAAA,EAC6D;AAC7D,IAAA,IAAA,CAAK,qBAAqB,OAAO,CAAA;AAEjC,IAAA,OAAO,IAAA,CAAK,gBAAA;AAAA,MACV,qBAAA;AAAA,MACA;AAAA,QACE,MAAA,EAAQ,MAAA;AAAA,QACR,IAAA,EAAM,IAAA,CAAK,SAAA,CAAU,OAAO;AAAA,OAC9B;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,QAAA,EACA,cAAA,EAC+D;AAC/D,IAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,QAAQ,CAAA,IAAK,QAAA,CAAS,WAAW,CAAA,EAAG;AACrD,MAAA,MAAM,IAAI,eAAA;AAAA,QACR,oEAAA;AAAA,QACA,CAAC,UAAU;AAAA,OACb;AAAA,IACF;AAEA,IAAA,QAAA,CAAS,OAAA,CAAQ,CAAC,OAAA,EAAS,KAAA,KAAU,KAAK,oBAAA,CAAqB,OAAA,EAAS,KAAK,CAAC,CAAA;AAE9E,IAAA,OAAO,IAAA,CAAK,gBAAA;AAAA,MACV,0BAAA;AAAA,MACA;AAAA,QACE,MAAA,EAAQ,MAAA;AAAA,QACR,IAAA,EAAM,IAAA,CAAK,SAAA,CAAU,QAAQ;AAAA,OAC/B;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEQ,oBAAA,CAAqB,SAA4B,KAAA,EAAsB;AAC7E,IAAA,MAAM,SAAmB,EAAC;AAC1B,IAAA,MAAM,MAAA,GAAS,KAAA,KAAU,MAAA,GAAY,EAAA,GAAK,YAAY,KAAK,CAAA,EAAA,CAAA;AAE3D,IAAA,IAAI,CAAC,OAAA,CAAQ,WAAA,EAAa,IAAA,EAAK,EAAG;AAChC,MAAA,MAAA,CAAO,IAAA,CAAK,CAAA,EAAG,MAAM,CAAA,uBAAA,CAAyB,CAAA;AAAA,IAChD;AACA,IAAA,IAAI,CAAC,OAAA,CAAQ,YAAA,EAAc,IAAA,EAAK,EAAG;AACjC,MAAA,MAAA,CAAO,IAAA,CAAK,CAAA,EAAG,MAAM,CAAA,wBAAA,CAA0B,CAAA;AAAA,IACjD;AACA,IAAA,IAAI,CAAC,OAAA,CAAQ,UAAA,EAAY,IAAA,EAAK,EAAG;AAC/B,MAAA,MAAA,CAAO,IAAA,CAAK,CAAA,EAAG,MAAM,CAAA,sBAAA,CAAwB,CAAA;AAAA,IAC/C;AAEA,IAAA,IAAI,MAAA,CAAO,SAAS,CAAA,EAAG;AACrB,MAAA,MAAM,IAAI,gBAAgB,CAAA,6BAAA,EAAgC,MAAA,CAAO,KAAK,IAAI,CAAC,IAAI,MAAM,CAAA;AAAA,IACvF;AAAA,EACF;AACF","file":"index.mjs","sourcesContent":["/**\n * Fraud scoring API client.\n */\n\nimport { BaseClient } from '@vesant-sdk/core';\nimport type { RequestOptions } from '@vesant-sdk/core';\nimport { ValidationError } from '@vesant-sdk/core';\nimport type {\n  FraudScoreRequest,\n  FraudScoreResponseData,\n  FraudScoreResponseEnvelope,\n} from './types';\n\nexport class FraudClient extends BaseClient {\n  async scoreEvent(\n    request: FraudScoreRequest,\n    requestOptions?: RequestOptions\n  ): Promise<FraudScoreResponseEnvelope<FraudScoreResponseData>> {\n    this.validateScoreRequest(request);\n\n    return this.requestWithRetry<FraudScoreResponseEnvelope<FraudScoreResponseData>>(\n      '/api/v1/fraud/score',\n      {\n        method: 'POST',\n        body: JSON.stringify(request),\n      },\n      undefined,\n      undefined,\n      requestOptions\n    );\n  }\n\n  async scoreEventsBulk(\n    requests: FraudScoreRequest[],\n    requestOptions?: RequestOptions\n  ): Promise<FraudScoreResponseEnvelope<FraudScoreResponseData[]>> {\n    if (!Array.isArray(requests) || requests.length === 0) {\n      throw new ValidationError(\n        'Invalid bulk score request: at least one score request is required',\n        ['requests']\n      );\n    }\n\n    requests.forEach((request, index) => this.validateScoreRequest(request, index));\n\n    return this.requestWithRetry<FraudScoreResponseEnvelope<FraudScoreResponseData[]>>(\n      '/api/v1/fraud/score/bulk',\n      {\n        method: 'POST',\n        body: JSON.stringify(requests),\n      },\n      undefined,\n      undefined,\n      requestOptions\n    );\n  }\n\n  private validateScoreRequest(request: FraudScoreRequest, index?: number): void {\n    const errors: string[] = [];\n    const prefix = index === undefined ? '' : `requests[${index}].`;\n\n    if (!request.customer_id?.trim()) {\n      errors.push(`${prefix}customer_id is required`);\n    }\n    if (!request.sift_user_id?.trim()) {\n      errors.push(`${prefix}sift_user_id is required`);\n    }\n    if (!request.event_type?.trim()) {\n      errors.push(`${prefix}event_type is required`);\n    }\n\n    if (errors.length > 0) {\n      throw new ValidationError(`Invalid fraud score request: ${errors.join(', ')}`, errors);\n    }\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@vesant-sdk/fraud",
+  "version": "0.1.0-dev.40d1c39",
+  "description": "Fraud detection and scoring client for the Vesant Compliance Platform",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint src --ext .ts"
+  },
+  "keywords": [
+    "vesant",
+    "compliance",
+    "fraud",
+    "fraud-detection",
+    "risk-scoring"
+  ],
+  "author": "Vesant Compliance",
+  "license": "MIT",
+  "dependencies": {
+    "@vesant-sdk/core": "0.1.0"
+  },
+  "devDependencies": {
+    "msw": "^2.4.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^2.0.0"
+  },
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/botcalm-compliance/vesant-sdk.git",
+    "directory": "typescript/packages/fraud"
+  }
+}