g-ten-security-sdk 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +33 -0
  2. package/package.json +10 -3
package/README.md ADDED
@@ -0,0 +1,33 @@
1
+ # G-TEN Security SDK
2
+
3
+ A clean, developer-friendly TypeScript SDK for the **G-TEN Fraud Intelligence Platform**.
4
+
5
+ This SDK provides type-safe wrappers around the G-TEN backend API, allowing you to easily integrate advanced fraud detection, graph analytics, and AI narrative explainability into any frontend or backend application.
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install g-ten-security-sdk
11
+ ```
12
+
13
+ ## Features
14
+
15
+ - **Fraud Analytics:** Access Neo4j graph algorithms to detect Layering, Smurfing, and Round-Trip patterns.
16
+ - **Narrative Explainability:** Use AI to generate human-readable investigation briefings (powered by Gemini & Gemma 4 31B).
17
+ - **Type-Safe:** Fully typed with TypeScript interfaces automatically generated from the FastAPI backend.
18
+ - **Easy Authentication:** Built-in interceptors to handle JWT tokens automatically.
19
+
20
+ ## Usage Example
21
+
22
+ ```typescript
23
+ import { FraudApi } from 'g-ten-security-sdk';
24
+
25
+ const fraudClient = new FraudApi();
26
+
27
+ // Get recent high-risk alerts
28
+ const alerts = await fraudClient.getAlerts();
29
+ console.log(alerts);
30
+ ```
31
+
32
+ ## License
33
+ UNLICENSED
package/package.json CHANGED
@@ -1,16 +1,23 @@
1
1
  {
2
2
  "name": "g-ten-security-sdk",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "G-TEN Fraud Intelligence SDK — A clean, developer-friendly TypeScript SDK for the G-TEN platform.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
- "files": ["dist"],
7
+ "files": [
8
+ "dist"
9
+ ],
8
10
  "scripts": {
9
11
  "build": "tsc",
10
12
  "build:watch": "tsc --watch",
11
13
  "clean": "rm -rf dist"
12
14
  },
13
- "keywords": ["gten", "fraud", "aml", "sdk"],
15
+ "keywords": [
16
+ "gten",
17
+ "fraud",
18
+ "aml",
19
+ "sdk"
20
+ ],
14
21
  "license": "UNLICENSED",
15
22
  "devDependencies": {
16
23
  "typescript": "^5.4.0"