openred 0.2.0

package/dist/vault-CDr54-Ev.d.ts

@@ -0,0 +1,80 @@
+type PIIType = 'EMAIL' | 'PHONE' | 'SSN' | 'CREDIT_CARD' | 'IP_ADDRESS' | 'DATE_OF_BIRTH' | 'ADDRESS' | 'URL' | (string & {});
+type ConfidenceLevel = 'high' | 'medium' | 'low';
+interface PIIMatch {
+    type: PIIType;
+    value: string;
+    start: number;
+    end: number;
+    confidence: number;
+    detector: string;
+}
+interface PIIDetector {
+    name: string;
+    type: PIIType;
+    confidence: ConfidenceLevel;
+    detect(text: string, context?: DetectionContext): PIIMatch[];
+}
+interface DetectionContext {
+    locale?: string;
+}
+type RedactorFn = (match: PIIMatch) => string;
+type RedactionStrategy = 'placeholder' | 'hash' | 'mask' | 'category' | RedactorFn;
+interface TokenMapping {
+    original: string;
+    replacement: string;
+    type: PIIType;
+    confidence: number;
+}
+interface RedactionResult {
+    text: string;
+    matches: PIIMatch[];
+    tokens: TokenMapping[];
+    stats: {
+        totalDetected: number;
+        byType: Record<string, number>;
+        processingTimeMs: number;
+    };
+}
+interface VaultEntry {
+    original: string;
+    replacement: string;
+    type: PIIType;
+}
+interface AggregatorConfig {
+    overlapResolution: 'longest' | 'highest-confidence' | 'first';
+    minConfidence: number;
+    mergeAdjacent: boolean;
+}
+interface PipelineConfig {
+    detectors: PIIDetector[];
+    locale?: string;
+    minConfidence?: number;
+    strategy?: RedactionStrategy;
+    vault?: boolean;
+    vaultTTL?: number;
+    allowList?: string[];
+    denyList?: string[];
+    overlapResolution?: 'longest' | 'highest-confidence' | 'first';
+    onDetection?: (match: PIIMatch) => void;
+    onRedaction?: (result: RedactionResult) => void;
+}
+
+declare class Vault {
+    private replacementToOriginal;
+    private originalToReplacement;
+    private ttl?;
+    private timers;
+    constructor(options?: {
+        ttl?: number;
+    });
+    store(original: string, replacement: string, type: PIIType): void;
+    getReplacementFor(original: string): string | undefined;
+    restore(text: string): string;
+    getMapping(): Map<string, VaultEntry>;
+    getEntries(): VaultEntry[];
+    clear(): void;
+    export(): string;
+    import(data: string): void;
+}
+
+export { type AggregatorConfig as A, type ConfidenceLevel as C, type DetectionContext as D, type PIIMatch as P, type RedactorFn as R, type TokenMapping as T, Vault as V, type PIIDetector as a, type RedactionStrategy as b, type PIIType as c, type PipelineConfig as d, type RedactionResult as e, type VaultEntry as f };

package/package.json

@@ -0,0 +1,112 @@
+{
+  "name": "openred",
+  "version": "0.2.0",
+  "description": "Fast, zero-dependency PII redaction for AI pipelines",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./middleware/express": {
+      "import": {
+        "types": "./dist/middleware/express.d.ts",
+        "default": "./dist/middleware/express.js"
+      },
+      "require": {
+        "types": "./dist/middleware/express.d.cts",
+        "default": "./dist/middleware/express.cjs"
+      }
+    },
+    "./middleware/fastify": {
+      "import": {
+        "types": "./dist/middleware/fastify.d.ts",
+        "default": "./dist/middleware/fastify.js"
+      },
+      "require": {
+        "types": "./dist/middleware/fastify.d.cts",
+        "default": "./dist/middleware/fastify.cjs"
+      }
+    },
+    "./integrations/openai": {
+      "import": {
+        "types": "./dist/integrations/openai.d.ts",
+        "default": "./dist/integrations/openai.js"
+      },
+      "require": {
+        "types": "./dist/integrations/openai.d.cts",
+        "default": "./dist/integrations/openai.cjs"
+      }
+    },
+    "./integrations/anthropic": {
+      "import": {
+        "types": "./dist/integrations/anthropic.d.ts",
+        "default": "./dist/integrations/anthropic.js"
+      },
+      "require": {
+        "types": "./dist/integrations/anthropic.d.cts",
+        "default": "./dist/integrations/anthropic.cjs"
+      }
+    },
+    "./integrations/langchain": {
+      "import": {
+        "types": "./dist/integrations/langchain.d.ts",
+        "default": "./dist/integrations/langchain.js"
+      },
+      "require": {
+        "types": "./dist/integrations/langchain.d.cts",
+        "default": "./dist/integrations/langchain.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "bench": "tsx benchmarks/performance.ts",
+    "bench:accuracy": "tsx benchmarks/accuracy.ts"
+  },
+  "keywords": [
+    "pii",
+    "redaction",
+    "privacy",
+    "ai",
+    "llm",
+    "data-protection",
+    "gdpr",
+    "ccpa",
+    "openai",
+    "anthropic",
+    "langchain",
+    "middleware"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ErnestCodes/openred.git"
+  },
+  "homepage": "https://github.com/ErnestCodes/openred#readme",
+  "bugs": {
+    "url": "https://github.com/ErnestCodes/openred/issues"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^25.2.1",
+    "tsup": "^8.0.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.4.0",
+    "vitest": "^2.0.0"
+  }
+}