g-ten-security-sdk 1.0.0

package/dist/wrappers/fraud.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyzeTransaction = analyzeTransaction;
+exports.getRiskScore = getRiskScore;
+exports.detectFraud = detectFraud;
+exports.generateCommentary = generateCommentary;
+exports.trackFunds = trackFunds;
+exports.getScore = getScore;
+const interceptor_1 = require("../auth/interceptor");
+const validators_1 = require("../utils/validators");
+/**
+ * Analyze a transaction/account for fraud risk.
+ * Runs the full ML scoring pipeline and returns a comprehensive risk assessment.
+ *
+ * @param accountId The account identifier to analyze
+ * @returns Full risk score result including detections, combined score, and risk level
+ */
+async function analyzeTransaction(accountId) {
+    const validAccountId = (0, validators_1.validateRequiredString)(accountId, "accountId");
+    return await (0, interceptor_1.sdkFetch)(`/sdk/v1/analyze-transaction?account_id=${validAccountId}`, {
+        method: "POST",
+    });
+}
+/**
+ * Get the risk score for a specific account.
+ * Alias for `analyzeTransaction` — provided for semantic clarity.
+ *
+ * @param accountId The account identifier
+ * @returns Risk score result
+ */
+async function getRiskScore(accountId) {
+    return analyzeTransaction(accountId);
+}
+/**
+ * Run fraud detection on a specific account.
+ * Executes ML-based pattern detection (layering, smurfing, dormancy, KYC mismatch).
+ *
+ * @param accountId The account identifier
+ * @returns Detection results with flagged patterns and confidence scores
+ */
+async function detectFraud(accountId) {
+    const validAccountId = (0, validators_1.validateRequiredString)(accountId, "accountId");
+    return await (0, interceptor_1.sdkFetch)(`/sdk/v1/detect-fraud?account_id=${validAccountId}`, {
+        method: "POST",
+    });
+}
+/**
+ * Generate an AI-powered narrative commentary / investigation briefing for an account.
+ *
+ * @param accountId The account identifier
+ * @param request Optional narrative generation parameters (focused pattern, SHAP features, etc.)
+ * @returns Generated narrative text and supporting evidence
+ */
+async function generateCommentary(accountId, request = {}) {
+    const validAccountId = (0, validators_1.validateRequiredString)(accountId, "accountId");
+    return await (0, interceptor_1.sdkFetch)(`/sdk/v1/generate-commentary?account_id=${validAccountId}`, {
+        method: "POST",
+        body: JSON.stringify(request),
+    });
+}
+/**
+ * Trace the flow of funds from/to a specific account.
+ * Reveals layering chains, round-trip transfers, and connected entities.
+ *
+ * @param accountId The account identifier
+ * @param hint Optional hint to focus tracing (e.g. "layering", "round_trip")
+ * @returns Trace result including detected chains and amounts
+ */
+async function trackFunds(accountId, hint) {
+    const validAccountId = (0, validators_1.validateRequiredString)(accountId, "accountId");
+    let url = `/sdk/v1/track-funds?account_id=${validAccountId}`;
+    if (hint) {
+        url += `&hint=${encodeURIComponent(hint)}`;
+    }
+    return await (0, interceptor_1.sdkFetch)(url, {
+        method: "GET",
+    });
+}
+/**
+ * @deprecated Use `analyzeTransaction()` or `getRiskScore()` instead.
+ */
+async function getScore(accountId) {
+    return analyzeTransaction(accountId);
+}

package/dist/wrappers/investigation.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Assigns an alert to a specific investigator.
+ *
+ * @param alertId The alert identifier
+ * @param assigneeId The investigator's user ID, or null to unassign
+ */
+export declare function assignAlert(alertId: string, assigneeId: string | null): Promise<any>;
+/**
+ * Draft a Suspicious Transaction Report (STR) for a flagged alert.
+ *
+ * @param alertId The alert identifier
+ */
+export declare function draftStr(alertId: string): Promise<any>;
+/**
+ * Approve a drafted Suspicious Transaction Report (STR).
+ *
+ * @param alertId The alert identifier
+ */
+export declare function approveStr(alertId: string): Promise<any>;
+/**
+ * Reject a drafted Suspicious Transaction Report (STR).
+ *
+ * @param alertId The alert identifier
+ */
+export declare function rejectStr(alertId: string): Promise<any>;
+/**
+ * Retrieve the audit trail history of an alert.
+ *
+ * @param alertId The alert identifier
+ */
+export declare function getAuditTrail(alertId: string): Promise<any>;

package/dist/wrappers/investigation.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assignAlert = assignAlert;
+exports.draftStr = draftStr;
+exports.approveStr = approveStr;
+exports.rejectStr = rejectStr;
+exports.getAuditTrail = getAuditTrail;
+const WorkflowApi_1 = require("../generated/src/apis/WorkflowApi");
+const interceptor_1 = require("../auth/interceptor");
+const validators_1 = require("../utils/validators");
+/**
+ * Assigns an alert to a specific investigator.
+ *
+ * @param alertId The alert identifier
+ * @param assigneeId The investigator's user ID, or null to unassign
+ */
+async function assignAlert(alertId, assigneeId) {
+    const validAlertId = (0, validators_1.validateRequiredString)(alertId, "alertId");
+    const config = (0, interceptor_1.getAuthenticatedConfig)();
+    const api = new WorkflowApi_1.WorkflowApi(config);
+    return await api.assignAlertApiV1AlertsAlertIdAssignPost({
+        alertId: validAlertId,
+        assignRequest: { assigneeId },
+    });
+}
+/**
+ * Draft a Suspicious Transaction Report (STR) for a flagged alert.
+ *
+ * @param alertId The alert identifier
+ */
+async function draftStr(alertId) {
+    const validAlertId = (0, validators_1.validateRequiredString)(alertId, "alertId");
+    const config = (0, interceptor_1.getAuthenticatedConfig)();
+    const api = new WorkflowApi_1.WorkflowApi(config);
+    return await api.draftStrApiV1AlertsAlertIdDraftStrPost({
+        alertId: validAlertId,
+    });
+}
+/**
+ * Approve a drafted Suspicious Transaction Report (STR).
+ *
+ * @param alertId The alert identifier
+ */
+async function approveStr(alertId) {
+    const validAlertId = (0, validators_1.validateRequiredString)(alertId, "alertId");
+    const config = (0, interceptor_1.getAuthenticatedConfig)();
+    const api = new WorkflowApi_1.WorkflowApi(config);
+    return await api.approveStrApiV1AlertsAlertIdApproveStrPost({
+        alertId: validAlertId,
+    });
+}
+/**
+ * Reject a drafted Suspicious Transaction Report (STR).
+ *
+ * @param alertId The alert identifier
+ */
+async function rejectStr(alertId) {
+    const validAlertId = (0, validators_1.validateRequiredString)(alertId, "alertId");
+    const config = (0, interceptor_1.getAuthenticatedConfig)();
+    const api = new WorkflowApi_1.WorkflowApi(config);
+    return await api.rejectStrApiV1AlertsAlertIdRejectStrPost({
+        alertId: validAlertId,
+    });
+}
+/**
+ * Retrieve the audit trail history of an alert.
+ *
+ * @param alertId The alert identifier
+ */
+async function getAuditTrail(alertId) {
+    const validAlertId = (0, validators_1.validateRequiredString)(alertId, "alertId");
+    const config = (0, interceptor_1.getAuthenticatedConfig)();
+    const api = new WorkflowApi_1.WorkflowApi(config);
+    return await api.getAuditTrailApiV1AlertsAlertIdAuditGet({
+        alertId: validAlertId,
+    });
+}

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "g-ten-security-sdk",
+  "version": "1.0.0",
+  "description": "G-TEN Fraud Intelligence SDK — A clean, developer-friendly TypeScript SDK for the G-TEN platform.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rm -rf dist"
+  },
+  "keywords": ["gten", "fraud", "aml", "sdk"],
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "typescript": "^5.4.0"
+  }
+}