Anonymize Functions

anonymize(
  text: string,
  locale?: string,
  policy?: Partial<AnonymizationPolicy>
): Promise<AnonymizationResult>

interface AnonymizationResult {
  anonymizedText: string;
  entities: Array<{
    type: PIIType;
    id: number;
    start: number;
    end: number;
    confidence: number;
    source: 'REGEX' | 'NER' | 'HYBRID';
    semantic?: {
      gender?: 'male' | 'female' | 'neutral' | 'unknown';
      scope?: 'city' | 'country' | 'region' | 'unknown';
      title?: string;
    };
  }>;
  piiMap?: {   // undefined when mode is 'anonymize'
    ciphertext: string;
    iv: string;
    authTag: string;
  };
  stats: {
    countsByType: Record<PIIType, number>;
    totalEntities: number;
    processingTimeMs: number;
    modelVersion: string;
    leakScanPassed?: boolean;
  };
}

const anonymizer = createAnonymizer({
  ner: { mode: 'quantized' }
});
await anonymizer.initialize();

const result = await anonymizer.anonymize(
  'Contact John at john@example.com',
  'en-US'
);

console.log(result.anonymizedText);
// "Contact <PII type="PERSON" id="1"/> at <PII type="EMAIL" id="1"/>"

console.log(result.entities);
// [
//   { type: 'PERSON', id: 1, start: 8, end: 12, confidence: 0.95, source: 'NER' },
//   { type: 'EMAIL', id: 1, start: 16, end: 32, confidence: 1.0, source: 'REGEX' }
// ]

console.log(result.stats);
// { totalEntities: 2, processingTimeMs: 150, ... }

function anonymize(
  text: string,
  locale?: string,
  policy?: Partial<AnonymizationPolicy>
): Promise<AnonymizationResult>

import { anonymize } from 'rehydra';

const result = await anonymize('Email: test@example.com');
console.log(result.anonymizedText);
// "Email: <PII type="EMAIL" id="1"/>"

function anonymizeRegexOnly(
  text: string,
  policy?: Partial<AnonymizationPolicy>
): Promise<AnonymizationResult>

import { anonymizeRegexOnly } from 'rehydra';

const result = await anonymizeRegexOnly(
  'Card: 4111111111111111, IBAN: DE89370400440532013000'
);

console.log(result.anonymizedText);
// "Card: <PII type="CREDIT_CARD" id="1"/>, IBAN: <PII type="IBAN" id="2"/>"

function anonymizeWithNER(
  text: string,
  nerConfig: Omit<NERConfig, 'mode'> & { mode?: 'standard' | 'quantized' },
  policy?: Partial<AnonymizationPolicy>
): Promise<AnonymizationResult>

import { anonymizeWithNER } from 'rehydra';

const result = await anonymizeWithNER(
  'Hello John Smith from Acme Corp!',
  { 
    mode: 'quantized',
    onStatus: console.log 
  }
);

console.log(result.anonymizedText);
// "Hello <PII type="PERSON" id="1"/> from <PII type="ORG" id="1"/>!"

import { createAnonymizer, PIIType } from 'rehydra';

const anonymizer = createAnonymizer({
  ner: { mode: 'quantized' }
});
await anonymizer.initialize();

// Default behavior
await anonymizer.anonymize('Email: test@example.com');

// Override for this call only
await anonymizer.anonymize('Email: test@example.com', undefined, {
  enabledTypes: new Set([PIIType.PHONE]),  // Only detect phones
  allowlistTerms: new Set(['test@example.com']),  // Ignore this email
});

// Keep countries visible (requires semantic: { enabled: true })
await anonymizer.anonymize('Meeting in Berlin, Germany.', undefined, {
  excludeLocationScopes: new Set(['country', 'region']),
});

const result = await anonymizer.anonymize(text);
console.log(result.anonymizedText);

if (result.stats.totalEntities === 0) {
  console.log('No PII detected');
}

console.log(`Found ${result.stats.countsByType['EMAIL'] || 0} emails`);

if (!result.stats.leakScanPassed) {
  console.warn('Potential PII leak detected in output');
}