npm install fastpii-connect
# or
pnpm add fastpii-connect
# or
yarn add fastpii-connect

import { FastPIIClient } from "fastpii-connect";

const client = new FastPIIClient({
  apiKey: "fpk_your_api_key",
  baseUrl: "https://api.fastpii.com", // default
  timeout: 30,        // request timeout in seconds
  maxRetries: 2,      // retries for 408, 429, 502, 503, 504 errors
});

const result = await client.detect("My rodné číslo is 900101/1234", {
  country: "cz",            // optional: ISO country code
  language: "cs",           // optional: language hint
  privacy_preset: "balanced", // optional: "conservative", "balanced", "aggressive"
});

for (const entity of result.entities) {
  console.log(`Found ${entity.type}: ${entity.original}`);
}

const result = await client.protect("My rodné číslo is 900101/1234", {
  mode: "replace",         // "replace", "mask", "hash", "tokenize"
  country: "cz",           // optional
  language: "cs",          // optional
  privacy_preset: "aggressive", // optional
});

console.log(result.protected_text);

const result = await client.validate("900101/1234", {
  entity_type: "rodne_cislo",
  country: "cz",  // optional
});

console.log(`Valid: ${result.valid}, Confidence: ${result.confidence}`);

const detectors = await client.listDetectors({ country: "CZ" });
for (const d of detectors.detectors) {
  console.log(`${d.name} (${d.region}): ${d.description}`);
}

const result = await client.detectBatch(
  ["Text one", "Text two", "Text three"],
  { country: "cz" }
);

console.log(`Total entities: ${result.total_entities}`);

const result = await client.protectBatch(
  ["Text one", "Text two"],
  { mode: "mask", country: "cz" }
);

console.log(`Total entities: ${result.total_entities}`);

const health = await client.health();
console.log(`Status: ${health.status}, Version: ${health.version}`);

const session = new Session(client);

const result1 = await session.detect("My rodné číslo is 900101/1234");
console.log(session.countries);      // ["CZ"]

const result2 = await session.detect("My PESEL is 90010112345");
console.log(session.countries);      // ["CZ", "PL"]
console.log(session.messageCount);  // 2

const client = new FastPIIClient({ apiKey: "fpk_your_api_key" });

// Non-streaming
const response = await client.gateway.chat.completions({
  model: "gpt-4o",
  messages: [{ role: "user", content: "Hello!" }],
});

console.log(response.choices[0].message.content);

// Streaming
for await (const event of client.gateway.chat.stream({
  model: "gpt-4o",
  messages: [{ role: "user", content: "Hello!" }],
})) {
  if ("content" in event) {
    process.stdout.write(event.content);
  }
}

import {
  FastPIIError,
  AuthenticationError,
  RateLimitError,
  QuotaExceededError,
  ValidationError,
  ServerError,
  ConnectionError,
  TimeoutError,
} from "fastpii-connect";

try {
  const result = await client.detect("text");
} catch (error) {
  if (error instanceof AuthenticationError) {
    console.log("Invalid API key");
  } else if (error instanceof RateLimitError) {
    console.log(`Rate limited. Retry after ${error.retryAfter} seconds`);
  } else if (error instanceof QuotaExceededError) {
    console.log("Monthly quota exceeded");
  } else if (error instanceof ValidationError) {
    console.log(`Request error: ${error.message} (status ${error.statusCode})`);
  } else if (error instanceof ServerError) {
    console.log("Server error");
  } else if (error instanceof ConnectionError) {
    console.log(`Connection failed: ${error.message}`);
  } else if (error instanceof FastPIIError) {
    console.log(`FastPII error: ${error.message}`);
  }
}

import {
  validatePrivacyPreset,
  validateProtectMode,
  validateTextLength,
  validateBatchTexts,
} from "fastpii-connect";

validatePrivacyPreset("balanced");  // OK
validatePrivacyPreset("extreme");    // throws Error

validateProtectMode("replace");      // OK
validateProtectMode("delete");       // throws Error

validateTextLength("hello");         // OK
validateTextLength("");               // throws Error
validateTextLength("x".repeat(50001)); // throws Error

validateBatchTexts(["a", "b"]);      // OK
validateBatchTexts([]);              // throws Error
validateBatchTexts(new Array(51).fill("x")); // throws Error