PII Guard

import { PIIGuard, redactPII } from '@orka-js/core';
 
// Une seule ligne
const safeText = redactPII("Contact john@example.com or call 06 12 34 56 78");
// → "Contact [EMAIL] or call [PHONE]"
 
// Contrôle total avec une instance PIIGuard
const guard = new PIIGuard({
  detectTypes: ['email', 'phone', 'credit_card', 'iban'],
  redactBeforeLLM: true,
});
 
const result = guard.detect("My card is 4111 1111 1111 1111");
console.log(result.redactedText);  // "My card is [CREDIT_CARD]"
console.log(result.matches);       // [{ type: 'credit_card', value: '4111...', ... }]

const guard = new PIIGuard({
  // Activer/désactiver la détection (défaut: true)
  enabled: true,
 
  // Types à détecter (défaut: tous les types courants)
  detectTypes: ['email', 'phone', 'credit_card', 'ssn', 'iban', 'ip_address'],
 
  // Masquer automatiquement avant les appels LLM (défaut: true)
  redactBeforeLLM: true,
 
  // Utiliser des placeholders typés comme [EMAIL] (défaut: true)
  useTypedPlaceholders: true,
 
  // Placeholder personnalisé quand useTypedPlaceholders est false
  redactionPlaceholder: '[REDACTED]',
 
  // Seuil de confiance minimum 0-1 (défaut: 0.8)
  minConfidence: 0.8,
 
  // Lever une erreur au lieu de masquer (mode strict)
  throwOnPII: false,
 
  // Callback quand des données personnelles sont détectées
  onPIIDetected: (matches) => {
    console.warn('PII detected:', matches.map(m => m.type));
  },
});

import { PIIGuard } from '@orka-js/core';
import { OpenAIAdapter } from '@orka-js/openai';
 
const guard = new PIIGuard({
  detectTypes: ['email', 'phone', 'credit_card', 'iban'],
  onPIIDetected: (matches) => {
    // Logger pour la piste d'audit
    console.log(`[AUDIT] Redacted ${matches.length} PII items`);
  },
});
 
const llm = new OpenAIAdapter({ apiKey: process.env.OPENAI_API_KEY! });
 
// Protéger l'entrée utilisateur avant l'appel LLM
async function safeAsk(userQuestion: string) {
  const safeQuestion = guard.processForLLM(userQuestion);
 
  const result = await llm.generate(safeQuestion, {
    systemPrompt: "You are a helpful assistant.",
  });
 
  return result.content;
}
 
// Exemple d'utilisation
const answer = await safeAsk(
  "My email is john@company.com and my card is 4111111111111111"
);
// Le LLM reçoit : "My email is [EMAIL] and my card is [CREDIT_CARD]"

const guard = new PIIGuard({
  customPatterns: [
    {
      name: 'employee_id',
      pattern: /EMP-\d{6}/g,
      redactWith: '[EMPLOYEE_ID]',
      confidence: 0.95,
    },
    {
      name: 'internal_project',
      pattern: /PRJ-[A-Z]{2}-\d{4}/g,
      redactWith: '[PROJECT_CODE]',
    },
    {
      name: 'french_secu',
      pattern: /[12]\s?\d{2}\s?\d{2}\s?\d{2}\s?\d{3}\s?\d{3}\s?\d{2}/g,
      redactWith: '[SECU_NUMBER]',
      confidence: 0.9,
    },
  ],
});
 
const result = guard.detect("Employee EMP-123456 on project PRJ-FR-2024");
// → "Employee [EMPLOYEE_ID] on project [PROJECT_CODE]"

const guard = new PIIGuard({
  allowList: [
    /support@company\.com/,      // Email support entreprise
    /noreply@company\.com/,      // Email no-reply
    /192\.168\.\d+\.\d+/,    // IPs réseau interne
  ],
});
 
const result = guard.detect("Contact support@company.com or personal@gmail.com");
// → "Contact support@company.com or [EMAIL]"
// Email entreprise préservé, email personnel masqué

import { PIIGuard, OrkaError, OrkaErrorCode } from '@orka-js/core';
 
const strictGuard = new PIIGuard({
  throwOnPII: true,
});
 
try {
  strictGuard.detect("My email is john@example.com");
} catch (error) {
  if (OrkaError.isOrkaError(error)) {
    console.error(`PII detected: ${error.message}`);
    // Gérer: demander à l'utilisateur de retirer les données sensibles
  }
}

import { redactPII, detectPII, createPIIGuard } from '@orka-js/core';
 
// Masquage rapide
const safe = redactPII("Email: test@example.com");
 
// Détection rapide
const result = detectPII("Phone: 06 12 34 56 78");
 
// Créer une instance configurée
const guard = createPIIGuard({ detectTypes: ['email'] });