@elanlanguages/bridge-anonymization 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,173 @@
+/**
+ * Bridge Anonymization Module
+ * Main entry point for on-device PII anonymization
+ */
+export * from './types/index.js';
+export { Recognizer, RegexRecognizer, RecognizerRegistry, createDefaultRegistry, createRegistry, getGlobalRegistry, emailRecognizer, phoneRecognizer, ibanRecognizer, bicSwiftRecognizer, creditCardRecognizer, ipAddressRecognizer, urlRecognizer, createCustomIdRecognizer, createCaseIdRecognizer, createCustomerIdRecognizer, } from './recognizers/index.js';
+export { NERModel, NERModelStub, createNERModel, createNERModelStub, WordPieceTokenizer, loadVocabFromFile, parseVocab, loadRuntime, detectRuntime, getRuntimeType, type INERModel, type NERModelConfig, type NERPrediction, type NERModelMode, type DownloadProgressCallback, MODEL_REGISTRY, getModelCacheDir, isModelDownloaded, downloadModel, ensureModel, clearModelCache, listDownloadedModels, } from './ner/index.js';
+export { prenormalize, resolveEntities, tagEntities, validateOutput, generateTag, parseTag, rehydrate, } from './pipeline/index.js';
+export { encryptPIIMap, decryptPIIMap, generateKey, deriveKey, generateSalt, KeyProvider, InMemoryKeyProvider, EnvKeyProvider, } from './crypto/index.js';
+import { AnonymizationResult, AnonymizationPolicy } from './types/index.js';
+import { RecognizerRegistry } from './recognizers/index.js';
+import { type INERModel } from './ner/index.js';
+import { type NERModelMode, type DownloadProgressCallback } from './ner/model-manager.js';
+import { type KeyProvider } from './crypto/index.js';
+/**
+ * NER configuration options
+ */
+export interface NERConfig {
+    /**
+     * NER model mode:
+     * - 'standard': Full-size multilingual model (~1.1 GB)
+     * - 'quantized': Smaller quantized model (~280 MB)
+     * - 'disabled': No NER, regex-only detection
+     * - 'custom': Use custom model paths
+     */
+    mode: NERModelMode;
+    /**
+     * Custom model path (required when mode is 'custom')
+     */
+    modelPath?: string;
+    /**
+     * Custom vocab path (required when mode is 'custom')
+     */
+    vocabPath?: string;
+    /**
+     * Whether to auto-download model if not present
+     * @default true
+     */
+    autoDownload?: boolean;
+    /**
+     * Callback for download progress
+     */
+    onDownloadProgress?: DownloadProgressCallback;
+    /**
+     * Callback for status messages
+     */
+    onStatus?: (status: string) => void;
+}
+/**
+ * Anonymizer configuration
+ */
+export interface AnonymizerConfig {
+    /** Recognizer registry (uses default if not provided) */
+    registry?: RecognizerRegistry;
+    /**
+     * NER configuration
+     * @default { mode: 'disabled' }
+     */
+    ner?: NERConfig;
+    /**
+     * @deprecated Use `ner` instead. Direct NER model injection for advanced use cases.
+     */
+    nerModel?: INERModel;
+    /** Key provider for encryption (generates random key if not provided) */
+    keyProvider?: KeyProvider;
+    /** Default policy (uses default if not provided) */
+    defaultPolicy?: AnonymizationPolicy;
+    /** Model version string */
+    modelVersion?: string;
+    /** Policy version string */
+    policyVersion?: string;
+}
+/**
+ * Anonymizer instance
+ * Main class for performing PII anonymization
+ */
+export declare class Anonymizer {
+    private registry;
+    private nerModel;
+    private nerConfig;
+    private keyProvider;
+    private defaultPolicy;
+    private modelVersion;
+    private policyVersion;
+    private initialized;
+    constructor(config?: AnonymizerConfig);
+    /**
+     * Initializes the anonymizer
+     * Downloads NER model if needed and loads it
+     */
+    initialize(): Promise<void>;
+    /**
+     * Anonymizes text, replacing PII with placeholder tags
+     * @param text - Input text to anonymize
+     * @param locale - Optional locale hint (e.g., 'de-DE', 'en-US')
+     * @param policy - Optional policy override
+     * @returns Anonymization result with anonymized text and encrypted PII map
+     */
+    anonymize(text: string, locale?: string, policy?: Partial<AnonymizationPolicy>): Promise<AnonymizationResult>;
+    /**
+     * Disposes of resources
+     */
+    dispose(): Promise<void>;
+    /**
+     * Gets the recognizer registry
+     */
+    getRegistry(): RecognizerRegistry;
+    /**
+     * Gets the NER model
+     */
+    getNERModel(): INERModel | null;
+    /**
+     * Whether the anonymizer is initialized
+     */
+    get isInitialized(): boolean;
+}
+/**
+ * Creates an anonymizer with the specified configuration
+ *
+ * @example
+ * ```typescript
+ * // Regex-only (no NER)
+ * const anonymizer = createAnonymizer();
+ *
+ * // With NER (auto-downloads model on first use)
+ * const anonymizer = createAnonymizer({
+ *   ner: { mode: 'quantized' }
+ * });
+ *
+ * // With NER and progress callback
+ * const anonymizer = createAnonymizer({
+ *   ner: {
+ *     mode: 'standard',
+ *     onStatus: (status) => console.log(status),
+ *     onDownloadProgress: (p) => console.log(`${p.file}: ${p.percent}%`)
+ *   }
+ * });
+ * ```
+ */
+export declare function createAnonymizer(config?: AnonymizerConfig): Anonymizer;
+/**
+ * Creates an anonymizer with a custom NER model
+ * @deprecated Use createAnonymizer with ner: { mode: 'custom', modelPath, vocabPath } instead
+ */
+export declare function createAnonymizerWithNER(modelPath: string, vocabPath: string, config?: Omit<AnonymizerConfig, 'nerModel' | 'ner'>): Promise<Anonymizer>;
+/**
+ * Convenience function for one-off anonymization
+ * Creates a temporary anonymizer with default settings (regex-only)
+ */
+export declare function anonymize(text: string, locale?: string, policy?: Partial<AnonymizationPolicy>): Promise<AnonymizationResult>;
+/**
+ * Quick regex-only anonymization (no NER, faster)
+ */
+export declare function anonymizeRegexOnly(text: string, policy?: Partial<AnonymizationPolicy>): Promise<AnonymizationResult>;
+/**
+ * Full anonymization with NER
+ * Auto-downloads the quantized model on first use
+ *
+ * @example
+ * ```typescript
+ * const result = await anonymizeWithNER(
+ *   'Contact John Smith at john@example.com',
+ *   {
+ *     mode: 'quantized',
+ *     onStatus: console.log
+ *   }
+ * );
+ * ```
+ */
+export declare function anonymizeWithNER(text: string, nerConfig: Omit<NERConfig, 'mode'> & {
+    mode?: 'standard' | 'quantized';
+}, policy?: Partial<AnonymizationPolicy>): Promise<AnonymizationResult>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,cAAc,kBAAkB,CAAC;AAGjC,OAAO,EACL,UAAU,EACV,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,EACb,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,GAC3B,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EACL,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,aAAa,EACb,cAAc,EACd,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,eAAe,EACf,oBAAoB,GACrB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EACL,YAAY,EACZ,eAAe,EACf,WAAW,EACX,cAAc,EACd,WAAW,EACX,QAAQ,EACR,SAAS,GACV,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,aAAa,EACb,aAAa,EACb,WAAW,EACX,SAAS,EACT,YAAY,EACZ,WAAW,EACX,mBAAmB,EACnB,cAAc,GACf,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAEL,mBAAmB,EACnB,mBAAmB,EAKpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAyB,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACnF,OAAO,EAAE,KAAK,SAAS,EAAmD,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,KAAK,YAAY,EAAe,KAAK,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAMvG,OAAO,EAA8B,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIjF;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;;OAMG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,kBAAkB,CAAC,EAAE,wBAAwB,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yDAAyD;IACzD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAE9B;;;OAGG;IACH,GAAG,CAAC,EAAE,SAAS,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IAErB,yEAAyE;IACzE,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,oDAAoD;IACpD,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC,2BAA2B;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,4BAA4B;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,QAAQ,CAA0B;IAC1C,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,WAAW,CAAS;gBAEhB,MAAM,GAAE,gBAAqB;IAkBzC;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAuDjC;;;;;;OAMG;IACG,SAAS,CACb,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GACpC,OAAO,CAAC,mBAAmB,CAAC;IAoF/B;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAO9B;;OAEG;IACH,WAAW,IAAI,kBAAkB;IAIjC;;OAEG;IACH,WAAW,IAAI,SAAS,GAAG,IAAI;IAI/B;;OAEG;IACH,IAAI,aAAa,IAAI,OAAO,CAE3B;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,UAAU,CAEtE;AAED;;;GAGG;AACH,wBAAsB,uBAAuB,CAC3C,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,UAAU,GAAG,KAAK,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,CAYrB;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GACpC,OAAO,CAAC,mBAAmB,CAAC,CAS9B;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GACpC,OAAO,CAAC,mBAAmB,CAAC,CAQ9B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAA;CAAE,EACxE,MAAM,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GACpC,OAAO,CAAC,mBAAmB,CAAC,CAe9B"}

package/dist/index.js

@@ -0,0 +1,294 @@
+/**
+ * Bridge Anonymization Module
+ * Main entry point for on-device PII anonymization
+ */
+// Re-export types
+export * from './types/index.js';
+// Re-export recognizers
+export { RegexRecognizer, RecognizerRegistry, createDefaultRegistry, createRegistry, getGlobalRegistry, emailRecognizer, phoneRecognizer, ibanRecognizer, bicSwiftRecognizer, creditCardRecognizer, ipAddressRecognizer, urlRecognizer, createCustomIdRecognizer, createCaseIdRecognizer, createCustomerIdRecognizer, } from './recognizers/index.js';
+// Re-export NER components
+export { NERModel, NERModelStub, createNERModel, createNERModelStub, WordPieceTokenizer, loadVocabFromFile, parseVocab, loadRuntime, detectRuntime, getRuntimeType, MODEL_REGISTRY, getModelCacheDir, isModelDownloaded, downloadModel, ensureModel, clearModelCache, listDownloadedModels, } from './ner/index.js';
+// Re-export pipeline components
+export { prenormalize, resolveEntities, tagEntities, validateOutput, generateTag, parseTag, rehydrate, } from './pipeline/index.js';
+// Re-export crypto
+export { encryptPIIMap, decryptPIIMap, generateKey, deriveKey, generateSalt, InMemoryKeyProvider, EnvKeyProvider, } from './crypto/index.js';
+// Main anonymization imports
+import { createDefaultPolicy, mergePolicy, } from './types/index.js';
+import { createDefaultRegistry } from './recognizers/index.js';
+import { NERModelStub, createNERModel, DEFAULT_LABEL_MAP } from './ner/index.js';
+import { ensureModel } from './ner/model-manager.js';
+import { prenormalize } from './pipeline/prenormalize.js';
+import { resolveEntities } from './pipeline/resolver.js';
+import { tagEntities, countEntitiesByType } from './pipeline/tagger.js';
+import { validateOutput } from './pipeline/validator.js';
+import { encryptPIIMap, generateKey } from './crypto/index.js';
+import * as fs from 'fs/promises';
+/**
+ * Anonymizer instance
+ * Main class for performing PII anonymization
+ */
+export class Anonymizer {
+    registry;
+    nerModel = null;
+    nerConfig;
+    keyProvider;
+    defaultPolicy;
+    modelVersion;
+    policyVersion;
+    initialized = false;
+    constructor(config = {}) {
+        this.registry = config.registry ?? createDefaultRegistry();
+        this.keyProvider = config.keyProvider ?? null;
+        this.defaultPolicy = config.defaultPolicy ?? createDefaultPolicy();
+        this.policyVersion = config.policyVersion ?? '1.0.0';
+        // Handle NER configuration
+        if (config.nerModel) {
+            // Legacy: direct model injection
+            this.nerModel = config.nerModel;
+            this.nerConfig = { mode: 'custom' };
+            this.modelVersion = config.modelVersion ?? config.nerModel.version;
+        }
+        else {
+            this.nerConfig = config.ner ?? { mode: 'disabled' };
+            this.modelVersion = config.modelVersion ?? '1.0.0';
+        }
+    }
+    /**
+     * Initializes the anonymizer
+     * Downloads NER model if needed and loads it
+     */
+    async initialize() {
+        if (this.initialized)
+            return;
+        // Handle NER model setup based on mode
+        if (this.nerConfig.mode === 'disabled') {
+            this.nerModel = new NERModelStub();
+        }
+        else if (this.nerConfig.mode === 'custom') {
+            if (!this.nerConfig.modelPath || !this.nerConfig.vocabPath) {
+                throw new Error("NER mode 'custom' requires modelPath and vocabPath");
+            }
+            this.nerModel = createNERModel({
+                modelPath: this.nerConfig.modelPath,
+                vocabPath: this.nerConfig.vocabPath,
+                modelVersion: this.modelVersion,
+            });
+        }
+        else {
+            // 'standard' or 'quantized' - use model manager
+            const { modelPath, vocabPath, labelMapPath } = await ensureModel(this.nerConfig.mode, {
+                autoDownload: this.nerConfig.autoDownload ?? true,
+                onProgress: this.nerConfig.onDownloadProgress,
+                onStatus: this.nerConfig.onStatus,
+            });
+            // Load label map
+            let labelMap = DEFAULT_LABEL_MAP;
+            try {
+                const labelMapContent = await fs.readFile(labelMapPath, 'utf-8');
+                labelMap = JSON.parse(labelMapContent);
+            }
+            catch {
+                // Use default label map
+            }
+            this.nerModel = createNERModel({
+                modelPath,
+                vocabPath,
+                labelMap,
+                modelVersion: this.modelVersion,
+            });
+        }
+        // Load the model
+        if (!this.nerModel.loaded) {
+            this.nerConfig.onStatus?.('Loading NER model...');
+            await this.nerModel.load();
+            this.nerConfig.onStatus?.('NER model loaded!');
+        }
+        this.modelVersion = this.nerModel.version;
+        this.initialized = true;
+    }
+    /**
+     * Anonymizes text, replacing PII with placeholder tags
+     * @param text - Input text to anonymize
+     * @param locale - Optional locale hint (e.g., 'de-DE', 'en-US')
+     * @param policy - Optional policy override
+     * @returns Anonymization result with anonymized text and encrypted PII map
+     */
+    async anonymize(text, locale, policy) {
+        if (!this.initialized) {
+            await this.initialize();
+        }
+        const startTime = performance.now();
+        // Merge policy with defaults
+        const effectivePolicy = policy !== undefined ? mergePolicy(policy) : this.defaultPolicy;
+        // Step 1: Pre-normalize text
+        const normalizedText = prenormalize(text);
+        // Step 2: Run regex recognizers
+        const regexMatches = this.registry.findAll(normalizedText, effectivePolicy);
+        // Step 3: Run NER model
+        const nerResult = await this.nerModel.predict(normalizedText, effectivePolicy);
+        const nerMatches = nerResult.spans;
+        // Step 4: Resolve and merge entities
+        const resolvedMatches = resolveEntities(regexMatches, nerMatches, effectivePolicy, normalizedText);
+        // Step 5: Tag entities and build PII map
+        const { anonymizedText, entities, piiMap } = tagEntities(normalizedText, resolvedMatches, effectivePolicy);
+        // Step 6: Validate output
+        const validation = validateOutput(anonymizedText, entities, Array.from(piiMap.keys()), effectivePolicy);
+        if (!validation.valid) {
+            // Log validation errors (but don't expose raw PII)
+            const safeErrors = validation.errors.map((e) => ({
+                code: e.code,
+                message: e.message,
+            }));
+            // eslint-disable-next-line no-console
+            console.warn('Validation warnings:', safeErrors);
+        }
+        // Step 7: Encrypt PII map
+        const encryptionKey = this.keyProvider !== null
+            ? await this.keyProvider.getKey()
+            : generateKey();
+        const encryptedPiiMap = encryptPIIMap(piiMap, encryptionKey);
+        // Step 8: Build stats
+        const endTime = performance.now();
+        const stats = {
+            countsByType: countEntitiesByType(entities),
+            totalEntities: entities.length,
+            modelVersion: this.modelVersion,
+            policyVersion: this.policyVersion,
+            processingTimeMs: endTime - startTime,
+            leakScanPassed: validation.leakScanPassed,
+        };
+        // Step 9: Build result (without original text in entities)
+        const safeEntities = entities.map(({ original, ...rest }) => rest);
+        return {
+            anonymizedText,
+            entities: safeEntities,
+            piiMap: encryptedPiiMap,
+            stats,
+        };
+    }
+    /**
+     * Disposes of resources
+     */
+    async dispose() {
+        if (this.nerModel) {
+            await this.nerModel.dispose();
+        }
+        this.initialized = false;
+    }
+    /**
+     * Gets the recognizer registry
+     */
+    getRegistry() {
+        return this.registry;
+    }
+    /**
+     * Gets the NER model
+     */
+    getNERModel() {
+        return this.nerModel;
+    }
+    /**
+     * Whether the anonymizer is initialized
+     */
+    get isInitialized() {
+        return this.initialized;
+    }
+}
+/**
+ * Creates an anonymizer with the specified configuration
+ *
+ * @example
+ * ```typescript
+ * // Regex-only (no NER)
+ * const anonymizer = createAnonymizer();
+ *
+ * // With NER (auto-downloads model on first use)
+ * const anonymizer = createAnonymizer({
+ *   ner: { mode: 'quantized' }
+ * });
+ *
+ * // With NER and progress callback
+ * const anonymizer = createAnonymizer({
+ *   ner: {
+ *     mode: 'standard',
+ *     onStatus: (status) => console.log(status),
+ *     onDownloadProgress: (p) => console.log(`${p.file}: ${p.percent}%`)
+ *   }
+ * });
+ * ```
+ */
+export function createAnonymizer(config) {
+    return new Anonymizer(config);
+}
+/**
+ * Creates an anonymizer with a custom NER model
+ * @deprecated Use createAnonymizer with ner: { mode: 'custom', modelPath, vocabPath } instead
+ */
+export async function createAnonymizerWithNER(modelPath, vocabPath, config) {
+    const anonymizer = new Anonymizer({
+        ...config,
+        ner: {
+            mode: 'custom',
+            modelPath,
+            vocabPath,
+        },
+    });
+    await anonymizer.initialize();
+    return anonymizer;
+}
+/**
+ * Convenience function for one-off anonymization
+ * Creates a temporary anonymizer with default settings (regex-only)
+ */
+export async function anonymize(text, locale, policy) {
+    const anonymizer = createAnonymizer();
+    await anonymizer.initialize();
+    try {
+        return await anonymizer.anonymize(text, locale, policy);
+    }
+    finally {
+        await anonymizer.dispose();
+    }
+}
+/**
+ * Quick regex-only anonymization (no NER, faster)
+ */
+export async function anonymizeRegexOnly(text, policy) {
+    // Create policy with NER disabled
+    const regexOnlyPolicy = {
+        ...policy,
+        nerEnabledTypes: new Set(), // Disable all NER types
+    };
+    return anonymize(text, undefined, regexOnlyPolicy);
+}
+/**
+ * Full anonymization with NER
+ * Auto-downloads the quantized model on first use
+ *
+ * @example
+ * ```typescript
+ * const result = await anonymizeWithNER(
+ *   'Contact John Smith at john@example.com',
+ *   {
+ *     mode: 'quantized',
+ *     onStatus: console.log
+ *   }
+ * );
+ * ```
+ */
+export async function anonymizeWithNER(text, nerConfig, policy) {
+    const anonymizer = createAnonymizer({
+        ner: {
+            mode: nerConfig.mode ?? 'quantized',
+            ...nerConfig,
+        },
+    });
+    await anonymizer.initialize();
+    try {
+        return await anonymizer.anonymize(text, undefined, policy);
+    }
+    finally {
+        await anonymizer.dispose();
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,kBAAkB;AAClB,cAAc,kBAAkB,CAAC;AAEjC,wBAAwB;AACxB,OAAO,EAEL,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,EACb,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,GAC3B,MAAM,wBAAwB,CAAC;AAEhC,2BAA2B;AAC3B,OAAO,EACL,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,aAAa,EACb,cAAc,EAMd,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,eAAe,EACf,oBAAoB,GACrB,MAAM,gBAAgB,CAAC;AAExB,gCAAgC;AAChC,OAAO,EACL,YAAY,EACZ,eAAe,EACf,WAAW,EACX,cAAc,EACd,WAAW,EACX,QAAQ,EACR,SAAS,GACV,MAAM,qBAAqB,CAAC;AAE7B,mBAAmB;AACnB,OAAO,EACL,aAAa,EACb,aAAa,EACb,WAAW,EACX,SAAS,EACT,YAAY,EAEZ,mBAAmB,EACnB,cAAc,GACf,MAAM,mBAAmB,CAAC;AAE3B,6BAA6B;AAC7B,OAAO,EAML,mBAAmB,EACnB,WAAW,GACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,qBAAqB,EAAsB,MAAM,wBAAwB,CAAC;AACnF,OAAO,EAAkB,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAqB,WAAW,EAAiC,MAAM,wBAAwB,CAAC;AAEvG,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAoB,MAAM,mBAAmB,CAAC;AACjF,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AA0ElC;;;GAGG;AACH,MAAM,OAAO,UAAU;IACb,QAAQ,CAAqB;IAC7B,QAAQ,GAAqB,IAAI,CAAC;IAClC,SAAS,CAAY;IACrB,WAAW,CAAqB;IAChC,aAAa,CAAsB;IACnC,YAAY,CAAS;IACrB,aAAa,CAAS;IACtB,WAAW,GAAG,KAAK,CAAC;IAE5B,YAAY,SAA2B,EAAE;QACvC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,qBAAqB,EAAE,CAAC;QAC3D,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,mBAAmB,EAAE,CAAC;QACnE,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,OAAO,CAAC;QAErD,2BAA2B;QAC3B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,iCAAiC;YACjC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YAChC,IAAI,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;QACrE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YACpD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,OAAO,CAAC;QACrD,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO;QAE7B,uCAAuC;QACvC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;QACrC,CAAC;aAAM,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;gBAC3D,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACxE,CAAC;YAED,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC;gBAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS;gBACnC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS;gBACnC,YAAY,EAAE,IAAI,CAAC,YAAY;aAChC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,gDAAgD;YAChD,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,MAAM,WAAW,CAC9D,IAAI,CAAC,SAAS,CAAC,IAAI,EACnB;gBACE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,IAAI,IAAI;gBACjD,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB;gBAC7C,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ;aAClC,CACF,CAAC;YAEF,iBAAiB;YACjB,IAAI,QAAQ,GAAG,iBAAiB,CAAC;YACjC,IAAI,CAAC;gBACH,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;gBACjE,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAa,CAAC;YACrD,CAAC;YAAC,MAAM,CAAC;gBACP,wBAAwB;YAC1B,CAAC;YAED,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC;gBAC7B,SAAS;gBACT,SAAS;gBACT,QAAQ;gBACR,YAAY,EAAE,IAAI,CAAC,YAAY;aAChC,CAAC,CAAC;QACL,CAAC;QAED,iBAAiB;QACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,sBAAsB,CAAC,CAAC;YAClD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC,CAAC;QACjD,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACb,IAAY,EACZ,MAAe,EACf,MAAqC;QAErC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC1B,CAAC;QAED,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAEpC,6BAA6B;QAC7B,MAAM,eAAe,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAExF,6BAA6B;QAC7B,MAAM,cAAc,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAE1C,gCAAgC;QAChC,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;QAE5E,wBAAwB;QACxB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAS,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;QAChF,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC;QAEnC,qCAAqC;QACrC,MAAM,eAAe,GAAG,eAAe,CACrC,YAAY,EACZ,UAAU,EACV,eAAe,EACf,cAAc,CACf,CAAC;QAEF,yCAAyC;QACzC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,WAAW,CACtD,cAAc,EACd,eAAe,EACf,eAAe,CAChB,CAAC;QAEF,0BAA0B;QAC1B,MAAM,UAAU,GAAG,cAAc,CAC/B,cAAc,EACd,QAAQ,EACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EACzB,eAAe,CAChB,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACtB,mDAAmD;YACnD,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC/C,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,OAAO,EAAE,CAAC,CAAC,OAAO;aACnB,CAAC,CAAC,CAAC;YACJ,sCAAsC;YACtC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,UAAU,CAAC,CAAC;QACnD,CAAC;QAED,0BAA0B;QAC1B,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,KAAK,IAAI;YAC7C,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACjC,CAAC,CAAC,WAAW,EAAE,CAAC;QAElB,MAAM,eAAe,GAAG,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAE7D,sBAAsB;QACtB,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAClC,MAAM,KAAK,GAAuB;YAChC,YAAY,EAAE,mBAAmB,CAAC,QAAQ,CAAC;YAC3C,aAAa,EAAE,QAAQ,CAAC,MAAM;YAC9B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,gBAAgB,EAAE,OAAO,GAAG,SAAS;YACrC,cAAc,EAAE,UAAU,CAAC,cAAc;SAC1C,CAAC;QAEF,2DAA2D;QAC3D,MAAM,YAAY,GAAuC,QAAQ,CAAC,GAAG,CACnE,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAChC,CAAC;QAEF,OAAO;YACL,cAAc;YACd,QAAQ,EAAE,YAAY;YACtB,MAAM,EAAE,eAAe;YACvB,KAAK;SACN,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAyB;IACxD,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,SAAiB,EACjB,SAAiB,EACjB,MAAmD;IAEnD,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC;QAChC,GAAG,MAAM;QACT,GAAG,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,SAAS;YACT,SAAS;SACV;KACF,CAAC,CAAC;IAEH,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;IAC9B,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,IAAY,EACZ,MAAe,EACf,MAAqC;IAErC,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAC;IACtC,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;IAE9B,IAAI,CAAC;QACH,OAAO,MAAM,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;YAAS,CAAC;QACT,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,IAAY,EACZ,MAAqC;IAErC,kCAAkC;IAClC,MAAM,eAAe,GAAiC;QACpD,GAAG,MAAM;QACT,eAAe,EAAE,IAAI,GAAG,EAAE,EAAE,wBAAwB;KACrD,CAAC;IAEF,OAAO,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,IAAY,EACZ,SAAwE,EACxE,MAAqC;IAErC,MAAM,UAAU,GAAG,gBAAgB,CAAC;QAClC,GAAG,EAAE;YACH,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,WAAW;YACnC,GAAG,SAAS;SACb;KACF,CAAC,CAAC;IAEH,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;IAE9B,IAAI,CAAC;QACH,OAAO,MAAM,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;YAAS,CAAC;QACT,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC"}

package/dist/ner/bio-decoder.d.ts

@@ -0,0 +1,64 @@
+/**
+ * BIO Tag Decoder
+ * Converts BIO-tagged token sequences to entity spans
+ */
+import { SpanMatch } from '../types/index.js';
+import type { Token } from './tokenizer.js';
+/**
+ * BIO tag types
+ */
+export declare enum BIOTag {
+    /** Beginning of an entity */
+    B = "B",
+    /** Inside an entity (continuation) */
+    I = "I",
+    /** Outside any entity */
+    O = "O"
+}
+/**
+ * Parsed BIO label
+ */
+export interface ParsedBIOLabel {
+    /** BIO tag type */
+    tag: BIOTag;
+    /** Entity type (null for O tag) */
+    entityType: string | null;
+}
+/**
+ * Raw entity span from NER (before conversion to SpanMatch)
+ */
+export interface RawNEREntity {
+    /** Entity type string from model */
+    type: string;
+    /** Start character offset */
+    start: number;
+    /** End character offset */
+    end: number;
+    /** Combined confidence score */
+    confidence: number;
+    /** Raw text */
+    text: string;
+    /** Token indices that make up this entity */
+    tokenIndices: number[];
+}
+/**
+ * Parses a BIO label string (e.g., "B-PER", "I-ORG", "O")
+ */
+export declare function parseBIOLabel(label: string): ParsedBIOLabel;
+/**
+ * Decodes BIO-tagged tokens into entity spans
+ */
+export declare function decodeBIOTags(tokens: Token[], labels: string[], confidences: number[], originalText: string): RawNEREntity[];
+/**
+ * Converts raw NER entities to SpanMatch format
+ */
+export declare function convertToSpanMatches(rawEntities: RawNEREntity[], confidenceThreshold?: number): SpanMatch[];
+/**
+ * Post-processes NER spans to clean up boundaries
+ */
+export declare function cleanupSpanBoundaries(spans: SpanMatch[], originalText: string): SpanMatch[];
+/**
+ * Merges adjacent spans of the same type
+ */
+export declare function mergeAdjacentSpans(spans: SpanMatch[], originalText: string, maxGap?: number): SpanMatch[];
+//# sourceMappingURL=bio-decoder.d.ts.map

package/dist/ner/bio-decoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bio-decoder.d.ts","sourceRoot":"","sources":["../../src/ner/bio-decoder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAW,SAAS,EAAmB,MAAM,mBAAmB,CAAC;AAExE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C;;GAEG;AACH,oBAAY,MAAM;IAChB,6BAA6B;IAC7B,CAAC,MAAM;IACP,sCAAsC;IACtC,CAAC,MAAM;IACP,yBAAyB;IACzB,CAAC,MAAM;CACR;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,mBAAmB;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,mCAAmC;IACnC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe;IACf,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAyB3D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,KAAK,EAAE,EACf,MAAM,EAAE,MAAM,EAAE,EAChB,WAAW,EAAE,MAAM,EAAE,EACrB,YAAY,EAAE,MAAM,GACnB,YAAY,EAAE,CAkFhB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,YAAY,EAAE,EAC3B,mBAAmB,GAAE,MAAY,GAChC,SAAS,EAAE,CA0Bb;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,SAAS,EAAE,EAClB,YAAY,EAAE,MAAM,GACnB,SAAS,EAAE,CAoCb;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,SAAS,EAAE,EAClB,YAAY,EAAE,MAAM,EACpB,MAAM,GAAE,MAAU,GACjB,SAAS,EAAE,CAiCb"}