g-ten-security-sdk 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,51 @@
+# G-TEN Security SDK
+
+A clean, developer-friendly TypeScript SDK for the **G-TEN Fraud Intelligence Platform**.
+
+## What is this SDK?
+The G-TEN Security SDK provides a seamless way for frontend applications, backend services, and third-party integrations to communicate with the G-TEN Core API. 
+
+Instead of manually writing HTTP requests and handling complex authentication flows, this SDK gives developers a fully typed, object-oriented interface to interact with G-TEN's advanced anti-money laundering (AML) and fraud detection systems.
+
+## What is it used for?
+This SDK is primarily used by developers building tools for Financial Intelligence Units (FIUs) or banking compliance teams. You can use it to:
+
+1. **Perform Graph-Based Fraud Analytics:** Detect complex money laundering patterns like *Layering* (rapid multi-hop transfers), *Smurfing* (structuring deposits), and *Round-Tripping* directly from Neo4j data.
+2. **Access AI-Powered Investigation Narratives:** Query the G-TEN Intelligence Chatbot or generate automated, plain-English investigator briefings for suspicious accounts using Gemini and Gemma 4 AI models.
+3. **Manage Alert Workflows:** Retrieve high-risk alerts, update their statuses, and assign them to investigators.
+4. **Interact with Core Banking Data:** Fetch branch information, account details, and live transaction streams securely.
+
+## Features
+
+- **Type-Safe:** Fully typed with TypeScript interfaces automatically generated from the FastAPI backend.
+- **Easy Authentication:** Built-in interceptors to automatically attach JWT tokens and handle session states.
+- **Modular APIs:** Divided into logical clients (`FraudApi`, `ChatApi`, `AuthApi`, `DataApi`) so you only import what you need.
+
+## Installation
+
+```bash
+npm install g-ten-security-sdk
+```
+
+## Quick Start Example
+
+```typescript
+import { FraudApi, ChatApi } from 'g-ten-security-sdk';
+
+const fraudClient = new FraudApi();
+const chatClient = new ChatApi();
+
+// 1. Fetch recent critical alerts
+const alerts = await fraudClient.getAlerts({ limit: 10 });
+
+// 2. Ask the AI Copilot to analyze a specific account's graph structure
+const analysis = await chatClient.sendChatMessage({
+  message: "Find all the accounts linked to smurfing that interacted with ACC_00025",
+  history: []
+});
+
+console.log(analysis.response);
+```
+
+## License
+UNLICENSED

package/package.json

@@ -1,16 +1,23 @@
 {
   "name": "g-ten-security-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "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"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc",
     "build:watch": "tsc --watch",
     "clean": "rm -rf dist"
   },
-  "keywords": ["gten", "fraud", "aml", "sdk"],
+  "keywords": [
+    "gten",
+    "fraud",
+    "aml",
+    "sdk"
+  ],
   "license": "UNLICENSED",
   "devDependencies": {
     "typescript": "^5.4.0"