@safekeylab/sdk 1.0.0

package/dist/types-CtDYLaOX.d.ts

@@ -0,0 +1,129 @@
+/**
+ * SafeKeyLab SDK Types
+ */
+interface SafeKeyLabConfig {
+    /** API key for authentication */
+    apiKey: string;
+    /** Base URL for the API (default: https://api.safekeylab.com) */
+    baseUrl?: string;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** Enable debug logging (default: false) */
+    debug?: boolean;
+}
+interface PIIDetection {
+    /** Type of PII detected (EMAIL, PHONE, SSN, etc.) */
+    type: string;
+    /** The detected value */
+    value: string;
+    /** Start position in text */
+    start: number;
+    /** End position in text */
+    end: number;
+    /** Confidence score (0-1) */
+    confidence: number;
+}
+interface DetectRequest {
+    /** Text to scan for PII */
+    text: string;
+    /** Types of PII to detect (default: all) */
+    types?: string[];
+    /** Minimum confidence threshold (default: 0.5) */
+    minConfidence?: number;
+}
+interface DetectResponse {
+    success: boolean;
+    detections: PIIDetection[];
+    count: number;
+    processing_time_ms: number;
+}
+interface ProtectRequest {
+    /** Text to redact PII from */
+    text: string;
+    /** Types of PII to redact (default: all) */
+    types?: string[];
+    /** Redaction style: 'placeholder' | 'mask' | 'hash' (default: placeholder) */
+    style?: 'placeholder' | 'mask' | 'hash';
+}
+interface Redaction {
+    type: string;
+    original: string;
+    start: number;
+    end: number;
+}
+interface ProtectResponse {
+    success: boolean;
+    redacted_text: string;
+    redactions: Redaction[];
+    redactions_count: number;
+    original_length: number;
+    redacted_length: number;
+    processing_time_ms: number;
+}
+interface ValidatePromptRequest {
+    /** Prompt to validate */
+    prompt: string;
+    /** Additional context for validation */
+    context?: string;
+}
+interface Threat {
+    type: string;
+    severity: 'low' | 'medium' | 'high' | 'critical';
+    description: string;
+    matched?: string;
+}
+interface ValidatePromptResponse {
+    success: boolean;
+    is_safe: boolean;
+    threats: Threat[];
+    threats_detected: number;
+    recommendation: 'allow' | 'review' | 'block';
+    processing_time_ms: number;
+}
+interface ScanOutputRequest {
+    /** LLM output to scan */
+    output: string;
+    /** Original prompt for context */
+    prompt?: string;
+}
+interface ScanOutputResponse {
+    success: boolean;
+    is_safe: boolean;
+    issues: Array<{
+        type: string;
+        severity: string;
+        description: string;
+    }>;
+    processing_time_ms: number;
+}
+interface WrapperConfig {
+    /** Block requests containing PII (default: false, will redact instead) */
+    blockOnPII?: boolean;
+    /** Block requests with detected threats (default: true) */
+    blockOnThreat?: boolean;
+    /** Types of PII to detect/redact */
+    piiTypes?: string[];
+    /** Scan LLM outputs for issues (default: true) */
+    scanOutputs?: boolean;
+    /** Custom error handler */
+    onError?: (error: Error) => void;
+    /** Callback when PII is detected */
+    onPIIDetected?: (detections: PIIDetection[]) => void;
+    /** Callback when threat is detected */
+    onThreatDetected?: (threats: Threat[]) => void;
+}
+declare class SafeKeyLabError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined);
+}
+declare class PIIBlockedError extends SafeKeyLabError {
+    detections: PIIDetection[];
+    constructor(detections: PIIDetection[]);
+}
+declare class ThreatBlockedError extends SafeKeyLabError {
+    threats: Threat[];
+    constructor(threats: Threat[]);
+}
+
+export { type DetectRequest as D, type ProtectRequest as P, type Redaction as R, type SafeKeyLabConfig as S, type Threat as T, type ValidatePromptRequest as V, type WrapperConfig as W, type DetectResponse as a, type ProtectResponse as b, type ValidatePromptResponse as c, type ScanOutputRequest as d, type ScanOutputResponse as e, type PIIDetection as f, SafeKeyLabError as g, PIIBlockedError as h, ThreatBlockedError as i };

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@safekeylab/sdk",
+  "version": "1.0.0",
+  "description": "SafeKeyLab SDK - AI Security & PII Protection for JavaScript/TypeScript",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./openai": {
+      "require": "./dist/integrations/openai.js",
+      "import": "./dist/integrations/openai.mjs",
+      "types": "./dist/integrations/openai.d.ts"
+    },
+    "./anthropic": {
+      "require": "./dist/integrations/anthropic.js",
+      "import": "./dist/integrations/anthropic.mjs",
+      "types": "./dist/integrations/anthropic.d.ts"
+    },
+    "./langchain": {
+      "require": "./dist/integrations/langchain.js",
+      "import": "./dist/integrations/langchain.mjs",
+      "types": "./dist/integrations/langchain.d.ts"
+    },
+    "./vercel-ai": {
+      "require": "./dist/integrations/vercel-ai.js",
+      "import": "./dist/integrations/vercel-ai.mjs",
+      "types": "./dist/integrations/vercel-ai.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage",
+    "lint": "eslint src --ext .ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "safekeylab",
+    "pii",
+    "privacy",
+    "security",
+    "ai",
+    "llm",
+    "openai",
+    "anthropic",
+    "langchain",
+    "vercel-ai",
+    "data-protection",
+    "gdpr",
+    "hipaa",
+    "compliance"
+  ],
+  "author": "SafeKey Lab Inc. <team@safekeylab.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/safekeylab/javascript-sdk"
+  },
+  "homepage": "https://safekeylab.com",
+  "bugs": {
+    "url": "https://github.com/safekeylab/javascript-sdk/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "peerDependencies": {
+    "openai": ">=4.0.0",
+    "@anthropic-ai/sdk": ">=0.9.0",
+    "langchain": ">=0.1.0",
+    "ai": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "openai": {
+      "optional": true
+    },
+    "@anthropic-ai/sdk": {
+      "optional": true
+    },
+    "langchain": {
+      "optional": true
+    },
+    "ai": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0",
+    "eslint": "^8.55.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.0",
+    "@typescript-eslint/parser": "^6.13.0"
+  }
+}