opencode-rehydra-core 0.14.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 ELAN Languages
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.en.md

@@ -0,0 +1,191 @@
+<p align="center">
+  <img src="https://framerusercontent.com/images/NT4xWP34VHd2Wlrk197je5BUi4.png?scale-down-to=512" width="400" alt="Rehydra" />
+</p>
+
+<p align="center">
+  PII security for AI workflows, coding agents and browser workloads.<br/>
+  Detects, replaces, encrypts, and <strong>rehydrates</strong> back when needed.
+</p>
+
+<p align="center">
+  <a href="https://github.com/EightDoor/opencode-rehydra-sdk/issues">Issues</a> ·
+  <a href="./README.md">中文</a>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/opencode-rehydra-core"><img src="https://img.shields.io/npm/v/opencode-rehydra-core?color=blue" alt="npm" /></a>
+  <a href="https://github.com/EightDoor/opencode-rehydra-sdk/blob/main/LICENSE"><img src="https://img.shields.io/github/license/EightDoor/opencode-rehydra-sdk" alt="license" /></a>
+</p>
+
+<p align="center">
+  <code>npm i opencode-rehydra-core</code> · <code>npm i <a href="packages/opencode-plugin/">opencode-rehydar</a></code>
+</p>
+
+## The Problem
+
+When you send code, messages, or documents through an LLM, real names, emails, and API keys go with them. Existing anonymizers either strip PII permanently — which breaks the conversation — or merely mask it, which leaves the model unable to reason.
+
+You need **pseudonyms** the LLM can work with and your tools can reverse.
+
+## How Rehydra Solves It
+
+1. **Detect** — Regex patterns catch structured PII (emails, phones, UK postcodes, IBANs, credit cards). An on-device NER model (ONNX, no cloud calls) catches soft PII (names, organizations, locations).
+2. **Replace** — Each PII value gets a stable placeholder: `<PII type="PERSON" id="1"/>`. The LLM works with these instead of real data.
+3. **Persist** — The same entity always gets the same ID, across every message in the session. The LLM maintains relational coherence without ever seeing real PII.
+4. **Rehydrate** — When a response needs to become real again (a file write, a bash command, a final answer), Rehydra restores the original values from its encrypted map.
+
+## Quick Start
+
+### OpenCode plugin
+
+```bash
+npm install opencode-rehydar
+```
+
+Enable it in `opencode.json` (V2 uses a `plugins` list):
+
+```json
+{
+  "plugins": [
+    {
+      "package": "opencode-rehydar",
+      "options": { "envFiles": [".env", ".env.local"] }
+    }
+  ]
+}
+```
+
+It intercepts the conversation between [OpenCode](https://github.com/sst/opencode) and the LLM. Secrets from `.env` files are replaced with placeholders before they leave your machine and restored before tools execute. Requires OpenCode's **V2** plugin API; the V1 `plugin` configuration and hook set are not supported.
+
+The plugin scrubs the session-title request (`session.hook("title")`), but rehydrates responses only for the primary answer (`http.response` with `kind === "primary"`). Session titles can therefore display `<PII .../>` placeholders, so disable the title agent to avoid placeholder titles; see [the limitation and configuration](packages/opencode-plugin/README.en.md#session-title-limitation).
+
+### Library — embed PII anonymization in your app
+
+The highly customizable backbone behind the implementations above. Supports custom NER models, encryption key providers, session storage providers, tag formats and many more tweaks.
+
+```typescript
+import { anonymize } from 'opencode-rehydra-core';
+
+const { anonymizedText } = await anonymize(
+  'Email john.smith@acme-corp.com or call John at +41 79 123 45 67'
+);
+```
+
+Works in **Node.js**, **Bun**, and **browsers**. No data leaves your machine.
+
+### Proxy module
+
+The SDK ships a `rehydra/proxy` module you can embed in your own services. It anonymizes outbound messages and rehydrates tool-call arguments before they execute, so the LLM works with placeholders while your tools always get real values.
+
+```typescript
+import { createRehydraProxy } from "rehydra/proxy";
+// Mount createRehydraProxy({ ... }) on the host you control.
+```
+
+Tool results (file reads, bash output) are anonymized on the way out. Tool call arguments (file writes, bash commands) are rehydrated on the way back.
+
+## Why Rehydra?
+
+### Reversible, not destructive
+
+Most PII libraries mask or redact permanently. Rehydra encrypts the original values with AES-256-GCM and restores them on demand. Anonymize for the LLM, rehydrate for your tools — a full round-trip, not a one-way street.
+
+### Session-persistent identity
+
+`PERSON_1` stays `PERSON_1` across every message in the conversation. When John Smith comes up in message 1, message 5, and message 20, the LLM sees the same placeholder every time. It can track relationships, reference earlier context, and produce coherent multi-turn output — without ever seeing real PII. Sessions persist to SQLite (server), IndexedDB (browser), or in-memory, so identity mappings survive restarts.
+
+### Zero-trust, on-device
+
+NER inference runs locally via ONNX Runtime (~280 MB quantized model). No API calls to external services. Works offline. PII never leaves your machine.
+
+### Core capabilities
+
+- **Secrets, not just PII**: beyond names, emails, and phone numbers, Rehydra detects API keys (OpenAI, Anthropic, Stripe, AWS, GitHub...), JWTs, private keys, database connection strings, and `.env` secrets.
+- **Streaming-aware**: purpose-built for LLM token streams. A sentence-buffered chunking system with NER overlap preservation ensures accurate detection even when PII spans chunk boundaries, with a low-latency mode for real-time streaming.
+- **Server-side tool loops**: `createRehydraFetch` supports `onToolCall` for OpenAI Chat Completions and Anthropic Messages requests with `stream: true`. The first response is buffered and its complete tool calls are validated before callbacks run. Interleaved calls retain their IDs and arguments. Tool arguments are rehydrated locally, and tool results are anonymized before the next request. Continuation requests use `stream: false`; the final response is returned as provider-compatible SSE including completion events and usage. This buffers the initial response and final JSON response, so it does not preserve token-by-token generation latency. Streams without tool calls retain their original events. Set `maxToolRounds` to bound callback rounds (default 10) and `maxToolResponseBytes` to bound each buffered response (default 8 MiB); on reaching the round limit, pending calls are returned to the caller without execution. Pass an `AbortSignal` through fetch to cancel buffering or prevent later callbacks; a callback already running must manage its own cancellation. Truncated calls, malformed arguments, and oversized streams fail before tool execution. Upstream HTTP errors retain their status. OpenAI tool loops require a single completion choice. Custom providers can opt in through `streamingToolLoop` on `LLMContentProvider`.
+- **Semantic enrichment for machine translation**: optional gender and scope attributes on PII tags (`<PII type="PERSON" gender="male" id="1"/>`, `<PII type="LOCATION" scope="city" id="2"/>`) preserve grammatical context for downstream systems.
+- **Stable external tag IDs**: callers that manage PII maps across independent anonymization calls can seed lowercase alphanumeric IDs through `existingPiiMap`. This allows an ID to be derived from the value it masks, for example with a keyed HMAC, instead of depending on a per-call counter.
+
+```typescript
+const existingPiiMap = new Map([
+  ['EMAIL_a4f2c9d8e7b6q', 'alice@acme.com'],
+]);
+
+const result = await anonymizer.anonymize(
+  'Email alice@acme.com',
+  undefined,
+  policy,
+  existingPiiMap,
+);
+// → 'Email <PII type="EMAIL" id="a4f2c9d8e7b6q"/>'
+```
+
+External IDs must match `[0-9a-z]+`. Decimal-only IDs retain their existing numeric behavior. Avoid IDs beginning with recognizer prefixes such as `case`, `file`, `ref`, or `ticket`, and avoid runs of seven or more digits; those shapes may themselves be detected as case IDs or phone numbers inside an inbound tag.
+
+## Example: Full Round-Trip with Sessions
+
+```typescript
+import {
+  createAnonymizer,
+  InMemoryKeyProvider,
+  SQLitePIIStorageProvider,
+} from 'opencode-rehydra-core';
+
+const keyProvider = new InMemoryKeyProvider();
+const anonymizer = createAnonymizer({
+  ner: {
+    mode: 'quantized',              // ~280 MB model, auto-downloads on first use
+    caseFallback: true,             // detect lowercase names like "tom"
+    thresholds: { PERSON: 0.8 },   // require higher confidence for names
+    onStatus: console.log,          // log model download progress
+  },
+  semantic: { enabled: true },      // adds gender/scope attributes for MT
+  secrets: { enabled: true },       // detect API keys, JWTs, connection strings
+  keyProvider,
+  piiStorageProvider: new SQLitePIIStorageProvider('./pii.db'),
+});
+
+const session = anonymizer.session('chat-123');
+
+// Message 1 — NER detects names and orgs, regex catches emails
+const r1 = await session.anonymize(
+  'Tell John Smith at Acme Corp (john.smith@acme-corp.com) we accept the offer'
+);
+// → "Tell <PII type="PERSON" gender="male" id="1"/> at <PII type="ORG" id="2"/>
+//    (<PII type="EMAIL" id="3"/>) we accept the offer"
+
+// Message 2 — same entities keep their IDs across messages
+const r2 = await session.anonymize(
+  'CC john.smith@acme-corp.com and loop in admin@acme-corp.com'
+);
+// → "CC <PII type="EMAIL" id="3"/> and loop in <PII type="EMAIL" id="4"/>"
+
+// Rehydrate any message — PII map is loaded from SQLite automatically
+const original = await session.rehydrate(r2.anonymizedText);
+// → "CC john.smith@acme-corp.com and loop in admin@acme-corp.com"
+
+await anonymizer.dispose();
+```
+
+## Address detection
+
+The default regex registry detects UK postcode syntax and numbered English-language street addresses such as `34a Friskin Road`. Apartment identifiers are included when adjacent to a street address, as in `Flat 1\n34a Friskin Road`. A contiguous UK address block ending in a postcode is masked as one `ADDRESS`; a standalone postcode uses `POSTAL_CODE`. Bare apartment numbers, unnumbered buildings, and other countries' postal formats need custom recognizers or NER. Postcode matching checks syntax, not whether a postcode is currently assigned.
+
+Disable `ADDRESS` or `POSTAL_CODE` through the detection policy to opt out of either recognizer.
+
+## Packages
+
+| Package | Description |
+|---------|-------------|
+| [`opencode-rehydra-core`](https://www.npmjs.com/package/opencode-rehydra-core) | Core SDK — detect, anonymize, rehydrate |
+| [`opencode-rehydar`](packages/opencode-plugin/) | OpenCode plugin — scrubs secrets before they reach LLM providers |
+
+## Documentation
+
+- [Core SDK usage](#library--embed-pii-anonymization-in-your-app)
+- [OpenCode plugin](packages/opencode-plugin/README.en.md)
+- [中文](README.md)
+
+## License
+
+[MIT](LICENSE)

package/README.md

@@ -0,0 +1,191 @@
+<p align="center">
+  <img src="https://framerusercontent.com/images/NT4xWP34VHd2Wlrk197je5BUi4.png?scale-down-to=512" width="400" alt="Rehydra" />
+</p>
+
+<p align="center">
+  为 AI 工作流、编程助手和浏览器场景提供 PII 安全防护。<br/>
+  检测、替换、加密，并在需要时<strong>还原</strong>真实值。
+</p>
+
+<p align="center">
+  <a href="https://github.com/EightDoor/opencode-rehydra-sdk/issues">Issues</a> ·
+  <a href="./README.en.md">English</a>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/opencode-rehydra-core"><img src="https://img.shields.io/npm/v/opencode-rehydra-core?color=blue" alt="npm" /></a>
+  <a href="https://github.com/EightDoor/opencode-rehydra-sdk/blob/main/LICENSE"><img src="https://img.shields.io/github/license/EightDoor/opencode-rehydra-sdk" alt="license" /></a>
+</p>
+
+<p align="center">
+  <code>npm i opencode-rehydra-core</code> · <code>npm i <a href="packages/opencode-plugin/">opencode-rehydar</a></code>
+</p>
+
+## 问题所在
+
+当你把代码、消息或文档发给 LLM 时，真实姓名、邮箱和 API Key 会一并离开你的机器。已有的匿名化工具要么永久删除 PII（那样对话就断了），要么只是临时遮盖（那样模型无法推理）。
+
+你需要的是**化名**：模型能拿来推理，你的工具又能还原回去。
+
+## Rehydra 的做法
+
+1. **检测** — 正则捕获结构化 PII（邮箱、电话、英国邮编、IBAN、信用卡卡号）。本地 NER 模型（ONNX，不联网）捕获非结构化 PII（人名、机构、地点）。
+2. **替换** — 每个 PII 值获得一个稳定占位符：`<PII type="PERSON" id="1"/>`。模型用占位符而不是真实数据来工作。
+3. **持久化** — 同一实体在整个会话的每条消息里都是同一个 ID。模型能维持关系一致性，却从未看到真实 PII。
+4. **还原** — 当响应需要变回真实值时（写文件、执行 bash 命令、给出最终答案），Rehydra 从加密映射中还原原始值。
+
+## 快速开始
+
+### OpenCode 插件
+
+```bash
+npm install opencode-rehydar
+```
+
+在 `opencode.json` 中启用（V2 使用 `plugins` 列表）：
+
+```json
+{
+  "plugins": [
+    {
+      "package": "opencode-rehydar",
+      "options": { "envFiles": [".env", ".env.local"] }
+    }
+  ]
+}
+```
+
+它拦截 [OpenCode](https://github.com/sst/opencode) 与 LLM 之间的对话。`.env` 文件中的密钥在离开本机前被替换为占位符，在工具执行前被还原。需要 OpenCode 的 **V2** 插件 API；不支持 V1 的 `plugin` 配置和 hook 集合。
+
+插件会脱敏会话标题请求（`session.hook("title")`），但只对主回答还原响应（`http.response` 且 `kind === "primary"`）。因此会话标题可能显示 `<PII .../>` 占位符，建议禁用标题 agent 以避免占位符标题，详见[限制与配置](packages/opencode-plugin/README.md#session-title-limitation)。
+
+### 作为库嵌入你的应用
+
+上面实现背后的可高度定制内核。支持自定义 NER 模型、加密密钥提供器、会话存储提供器、标签格式等多种调整。
+
+```typescript
+import { anonymize } from 'opencode-rehydra-core';
+
+const { anonymizedText } = await anonymize(
+  'Email john.smith@acme-corp.com or call John at +41 79 123 45 67'
+);
+```
+
+在 **Node.js**、**Bun** 和**浏览器**中都能运行。数据不离开你的机器。
+
+### 代理模块
+
+SDK 内置 `rehydra/proxy` 模块，可嵌入你自己的服务。它在出站消息上做脱敏，并在工具调用执行前还原参数，因此模型用占位符工作，而你的工具始终拿到真实值。
+
+```typescript
+import { createRehydraProxy } from "rehydra/proxy";
+// 将 createRehydraProxy({ ... }) 挂载到你自己的宿主上。
+```
+
+工具结果（文件读取、bash 输出）在返回时脱敏。工具调用参数（文件写入、bash 命令）在执行前还原。
+
+## 为什么选 Rehydra
+
+### 可逆，而非破坏性
+
+多数 PII 库做的是永久遮盖或删除。Rehydra 用 AES-256-GCM 加密原始值，按需还原。给模型用匿名值，给工具用还原值——完整往返，而不是单行道。
+
+### 跨会话稳定的身份
+
+`PERSON_1` 在整段对话的每条消息里都是 `PERSON_1`。当 John Smith 分别出现在第 1、5、20 条消息里，模型每次看到的都是同一个占位符。它能追踪关系、引用前文、产出连贯的多轮输出——而从未看到真实 PII。会话可持久化到 SQLite（服务端）、IndexedDB（浏览器）或内存，身份映射在重启后依然有效。
+
+### 零信任，端侧运行
+
+NER 推理通过 ONNX Runtime 在本地执行（量化模型约 280 MB）。不调用任何外部 API。可离线工作。PII 永不离开你的机器。
+
+### 关键能力
+
+- **密钥而不只是 PII**：除姓名、邮箱、电话外，还能检测 API Key（OpenAI、Anthropic、Stripe、AWS、GitHub 等）、JWT、私钥、数据库连接串和 `.env` 密钥。
+- **面向流式**：专为 LLM token 流设计。带句子缓冲的分块系统配合 NER 重叠保留，确保 PII 跨分块边界时仍能准确检测，并提供低延迟实时流式模式。
+- **服务端工具循环**：`createRehydraFetch` 支持在 `stream: true` 的 OpenAI Chat Completions 与 Anthropic Messages 请求上使用 `onToolCall`。首次响应被缓冲，其完整工具调用在回调执行前完成校验。交错调用保留各自的 ID 和参数。工具参数在本地还原，工具结果在下一次请求前脱敏。续请求使用 `stream: false`，最终响应以兼容 provider 的 SSE 返回，包含完成事件和用量信息；代价是缓冲了首包和最终 JSON，因此不保留逐 token 的生成延迟。不含工具调用的流保持原始事件。`maxToolRounds` 限制回调轮数（默认 10 轮），`maxToolResponseBytes` 限制每个缓冲响应大小（默认 8 MiB）；达到轮数上限时未执行的调用原样返回给调用方。通过 fetch 传入 `AbortSignal` 可取消缓冲或阻止后续回调，已在运行的回调需自行处理取消。被截断的调用、畸形参数和超限流会在工具执行前失败。上游 HTTP 错误保留其状态码。OpenAI 工具循环要求只有一个 completion choice。自定义 provider 可通过 `LLMContentProvider` 上的 `streamingToolLoop` 接入。
+- **机器翻译的语义增强**：PII 标签上的可选性别和范围属性（`<PII type="PERSON" gender="male" id="1"/>`、`<PII type="LOCATION" scope="city" id="2"/>`）为下游系统保留语法上下文。
+- **稳定的外部标签 ID**：跨独立匿名化调用管理 PII 映射的调用方，可以通过 `existingPiiMap` 预置小写字母数字 ID。这允许 ID 由被遮盖的值派生（例如用带密钥的 HMAC），而不依赖每次调用的计数器。
+
+```typescript
+const existingPiiMap = new Map([
+  ['EMAIL_a4f2c9d8e7b6q', 'alice@acme.com'],
+]);
+
+const result = await anonymizer.anonymize(
+  'Email alice@acme.com',
+  undefined,
+  policy,
+  existingPiiMap,
+);
+// → 'Email <PII type="EMAIL" id="a4f2c9d8e7b6q"/>'
+```
+
+外部 ID 必须匹配 `[0-9a-z]+`。纯数字 ID 保留现有的数字行为。避免以识别器前缀开头（`case`、`file`、`ref`、`ticket`）的 ID，也避免连续七位或更多数字——这些形态本身可能在传入的标签里被识别成 case ID 或电话号码。
+
+## 示例：带会话的完整往返
+
+```typescript
+import {
+  createAnonymizer,
+  InMemoryKeyProvider,
+  SQLitePIIStorageProvider,
+} from 'opencode-rehydra-core';
+
+const keyProvider = new InMemoryKeyProvider();
+const anonymizer = createAnonymizer({
+  ner: {
+    mode: 'quantized',              // ~280 MB 模型，首次使用时自动下载
+    caseFallback: true,             // 检测 "tom" 这类小写名字
+    thresholds: { PERSON: 0.8 },   // 对人名要求更高置信度
+    onStatus: console.log,          // 打印模型下载进度
+  },
+  semantic: { enabled: true },      // 为机器翻译添加性别/范围属性
+  secrets: { enabled: true },       // 检测 API Key、JWT、连接串
+  keyProvider,
+  piiStorageProvider: new SQLitePIIStorageProvider('./pii.db'),
+});
+
+const session = anonymizer.session('chat-123');
+
+// 消息 1 — NER 检测人名和机构，正则捕获邮箱
+const r1 = await session.anonymize(
+  'Tell John Smith at Acme Corp (john.smith@acme-corp.com) we accept the offer'
+);
+// → "Tell <PII type="PERSON" gender="male" id="1"/> at <PII type="ORG" id="2"/>
+//    (<PII type="EMAIL" id="3"/>) we accept the offer"
+
+// 消息 2 — 同一实体跨消息保持 ID
+const r2 = await session.anonymize(
+  'CC john.smith@acme-corp.com and loop in admin@acme-corp.com'
+);
+// → "CC <PII type="EMAIL" id="3"/> and loop in <PII type="EMAIL" id="4"/>"
+
+// 还原任意消息 — PII 映射会自动从 SQLite 加载
+const original = await session.rehydrate(r2.anonymizedText);
+// → "CC john.smith@acme-corp.com and loop in admin@acme-corp.com"
+
+await anonymizer.dispose();
+```
+
+## 地址识别说明
+
+默认正则注册表检测英国邮编语法和带门牌号的英文街道地址，例如 `34a Friskin Road`。当公寓标识与街道地址相邻时会被包含，例如 `Flat 1\n34a Friskin Road`。以邮编结尾的连续英国地址块会被整体遮盖为一个 `ADDRESS`；独立的邮编使用 `POSTAL_CODE`。裸公寓号、无门牌号的建筑以及其他国家的邮编格式需要自定义识别器或 NER。邮编匹配只检查语法，不验证该邮编当前是否仍在使用。
+
+通过检测策略禁用 `ADDRESS` 或 `POSTAL_CODE` 即可关闭对应识别器。
+
+## 包
+
+| 包 | 说明 |
+|---|---|
+| [`opencode-rehydra-core`](https://www.npmjs.com/package/opencode-rehydra-core) | 核心 SDK —— 检测、匿名化、还原 |
+| [`opencode-rehydar`](packages/opencode-plugin/) | OpenCode 插件 —— 在密钥到达 LLM provider 前脱敏 |
+
+## 文档
+
+- [核心 SDK 用法](#作为库嵌入你的应用)
+- [OpenCode 插件](packages/opencode-plugin/README.md)
+- [English](README.en.md)
+
+## License
+
+[MIT](LICENSE)

package/dist/browser.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Rehydra Module - Browser Entry Point
+ * Browser-safe entry point for on-device PII anonymization
+ *
+ * This module excludes Node.js-specific exports like SQLitePIIStorageProvider.
+ * For full functionality including SQLite, use the main entry point or import from 'rehydra/node'.
+ */
+export * from "./types/index.js";
+export type { Recognizer } from "./recognizers/index.js";
+export { RegexRecognizer, RecognizerRegistry, createDefaultRegistry, createRegistry, getGlobalRegistry, emailRecognizer, phoneRecognizer, ukPostalCodeRecognizer, streetAddressRecognizer, UK_POSTAL_CODE_PATTERN, isValidUKPostalCode, normalizeUKPostalCode, 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, type OrtSessionOptions, MODEL_REGISTRY, getModelCacheDir, isModelDownloaded, downloadModel, ensureModel, clearModelCache, listDownloadedModels, } from "./ner/index.js";
+export { prenormalize, resolveEntities, tagEntities, validateOutput, generateTag, parseTag, rehydrate, enrichSemantics, inferGender, classifyLocation, getDatabaseStats, hasName, hasLocation, isSemanticDataAvailable, isSemanticDataDownloaded, getSemanticDataCacheDir, getDataDirectory, downloadSemanticData, ensureSemanticData, initializeSemanticData, loadSemanticData, clearSemanticData, clearSemanticDataCache, getSemanticDataInfo, SEMANTIC_DATA_FILES, extractTitle, extractTitlesFromSpans, mergeAdjacentTitleSpans, getTitlesForLanguage, getAllTitles, startsWithTitle, isOnlyTitle, type SemanticDataFileInfo, type EnricherConfig, type GenderResult, type LocationResult, type TitleExtractionResult, } from "./pipeline/index.js";
+export type { KeyProvider } from "./crypto/index.js";
+export { encryptPIIMap, decryptPIIMap, generateKey, deriveKey, generateSalt, InMemoryKeyProvider, ConfigKeyProvider, validateKey, secureCompare, uint8ArrayToBase64, base64ToUint8Array, } from "./crypto/index.js";
+export { getStorageProvider, isNode, isBrowser, resetStorageProvider, setStorageProvider, type StorageProvider, } from "#storage";
+export { type PIIStorageProvider, type PIIMapMetadata, type StoredPIIMap, type ListOptions, type AnonymizerSession, InMemoryPIIStorageProvider, IndexedDBPIIStorageProvider, } from "./storage/browser.js";
+export { join as pathJoin, dirname as pathDirname, basename as pathBasename, normalize as pathNormalize, extname as pathExtname, isAbsolute as pathIsAbsolute, } from "./utils/path.js";
+import { Anonymizer as AnonymizerCore, anonymize as anonymizeCore, anonymizeRegexOnly as anonymizeRegexOnlyCore, anonymizeWithNER as anonymizeWithNERCore, type AnonymizerConfig, type NERConfig } from "./core/index.js";
+export type { AnonymizerConfig, NERConfig };
+/**
+ * Anonymizer instance
+ * Main class for performing PII anonymization
+ */
+export declare class Anonymizer extends AnonymizerCore {
+    constructor(config?: AnonymizerConfig);
+}
+/**
+ * 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;
+export declare const anonymize: typeof anonymizeCore;
+export declare const anonymizeRegexOnly: typeof anonymizeRegexOnlyCore;
+export declare const anonymizeWithNER: typeof anonymizeWithNERCore;
+//# sourceMappingURL=browser.d.ts.map

package/dist/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,cAAc,kBAAkB,CAAC;AAGjC,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,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,KAAK,iBAAiB,EACtB,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,EACT,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,EACP,WAAW,EAEX,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,gBAAgB,EAChB,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EAEnB,YAAY,EACZ,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,YAAY,EACZ,eAAe,EACf,WAAW,EACX,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,qBAAqB,GAC3B,MAAM,qBAAqB,CAAC;AAG7B,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EACL,aAAa,EACb,aAAa,EACb,WAAW,EACX,SAAS,EACT,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,kBAAkB,EAClB,MAAM,EACN,SAAS,EACT,oBAAoB,EACpB,kBAAkB,EAClB,KAAK,eAAe,GACrB,MAAM,UAAU,CAAC;AAGlB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,0BAA0B,EAC1B,2BAA2B,GAG5B,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EACL,IAAI,IAAI,QAAQ,EAChB,OAAO,IAAI,WAAW,EACtB,QAAQ,IAAI,YAAY,EACxB,SAAS,IAAI,aAAa,EAC1B,OAAO,IAAI,WAAW,EACtB,UAAU,IAAI,cAAc,GAC7B,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EACL,UAAU,IAAI,cAAc,EAC5B,SAAS,IAAI,aAAa,EAC1B,kBAAkB,IAAI,sBAAsB,EAC5C,gBAAgB,IAAI,oBAAoB,EACxC,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACf,MAAM,iBAAiB,CAAC;AAMzB,YAAY,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC;AAE5C;;;GAGG;AACH,qBAAa,UAAW,SAAQ,cAAc;gBAChC,MAAM,GAAE,gBAAqB;CAU1C;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,UAAU,CAEtE;AAGD,eAAO,MAAM,SAAS,sBAAgB,CAAC;AACvC,eAAO,MAAM,kBAAkB,+BAAyB,CAAC;AACzD,eAAO,MAAM,gBAAgB,6BAAuB,CAAC"}

package/dist/browser.js

@@ -0,0 +1,74 @@
+/**
+ * Rehydra Module - Browser Entry Point
+ * Browser-safe entry point for on-device PII anonymization
+ *
+ * This module excludes Node.js-specific exports like SQLitePIIStorageProvider.
+ * For full functionality including SQLite, use the main entry point or import from 'rehydra/node'.
+ */
+// Re-export types
+export * from "./types/index.js";
+export { RegexRecognizer, RecognizerRegistry, createDefaultRegistry, createRegistry, getGlobalRegistry, emailRecognizer, phoneRecognizer, ukPostalCodeRecognizer, streetAddressRecognizer, UK_POSTAL_CODE_PATTERN, isValidUKPostalCode, normalizeUKPostalCode, 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, enrichSemantics, inferGender, classifyLocation, getDatabaseStats, hasName, hasLocation, 
+// Semantic data loader exports
+isSemanticDataAvailable, isSemanticDataDownloaded, getSemanticDataCacheDir, getDataDirectory, downloadSemanticData, ensureSemanticData, initializeSemanticData, loadSemanticData, clearSemanticData, clearSemanticDataCache, getSemanticDataInfo, SEMANTIC_DATA_FILES, 
+// Title extractor exports
+extractTitle, extractTitlesFromSpans, mergeAdjacentTitleSpans, getTitlesForLanguage, getAllTitles, startsWithTitle, isOnlyTitle, } from "./pipeline/index.js";
+export { encryptPIIMap, decryptPIIMap, generateKey, deriveKey, generateSalt, InMemoryKeyProvider, ConfigKeyProvider, validateKey, secureCompare, uint8ArrayToBase64, base64ToUint8Array, } from "./crypto/index.js";
+// Re-export storage utilities (file system abstraction)
+export { getStorageProvider, isNode, isBrowser, resetStorageProvider, setStorageProvider, } from "#storage";
+// Re-export PII storage providers (browser-safe only - no SQLite)
+export { InMemoryPIIStorageProvider, IndexedDBPIIStorageProvider,
+// Note: SQLitePIIStorageProvider is NOT exported in browser build
+// Import from 'rehydra/storage/sqlite' if needed in Node.js
+ } from "./storage/browser.js";
+// Re-export path utilities
+export { join as pathJoin, dirname as pathDirname, basename as pathBasename, normalize as pathNormalize, extname as pathExtname, isAbsolute as pathIsAbsolute, } from "./utils/path.js";
+// Import core anonymizer components
+import { Anonymizer as AnonymizerCore, anonymize as anonymizeCore, anonymizeRegexOnly as anonymizeRegexOnlyCore, anonymizeWithNER as anonymizeWithNERCore, } from "./core/index.js";
+// Import session implementation
+import { AnonymizerSessionImpl } from "./storage/session-base.js";
+/**
+ * Anonymizer instance
+ * Main class for performing PII anonymization
+ */
+export class Anonymizer extends AnonymizerCore {
+    constructor(config = {}) {
+        super(config, (anonymizer, sessionId, storage, keyProvider) => {
+            return new AnonymizerSessionImpl(anonymizer, sessionId, storage, keyProvider);
+        });
+    }
+}
+/**
+ * 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);
+}
+// Re-export standalone functions from core
+export const anonymize = anonymizeCore;
+export const anonymizeRegexOnly = anonymizeRegexOnlyCore;
+export const anonymizeWithNER = anonymizeWithNERCore;
+//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,kBAAkB;AAClB,cAAc,kBAAkB,CAAC;AAIjC,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,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,EAOd,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,EACT,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,EACP,WAAW;AACX,+BAA+B;AAC/B,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,gBAAgB,EAChB,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB;AACnB,0BAA0B;AAC1B,YAAY,EACZ,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,YAAY,EACZ,eAAe,EACf,WAAW,GAMZ,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EACL,aAAa,EACb,aAAa,EACb,WAAW,EACX,SAAS,EACT,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAE3B,wDAAwD;AACxD,OAAO,EACL,kBAAkB,EAClB,MAAM,EACN,SAAS,EACT,oBAAoB,EACpB,kBAAkB,GAEnB,MAAM,UAAU,CAAC;AAElB,kEAAkE;AAClE,OAAO,EAML,0BAA0B,EAC1B,2BAA2B;AAC3B,kEAAkE;AAClE,4DAA4D;EAC7D,MAAM,sBAAsB,CAAC;AAE9B,2BAA2B;AAC3B,OAAO,EACL,IAAI,IAAI,QAAQ,EAChB,OAAO,IAAI,WAAW,EACtB,QAAQ,IAAI,YAAY,EACxB,SAAS,IAAI,aAAa,EAC1B,OAAO,IAAI,WAAW,EACtB,UAAU,IAAI,cAAc,GAC7B,MAAM,iBAAiB,CAAC;AAEzB,oCAAoC;AACpC,OAAO,EACL,UAAU,IAAI,cAAc,EAC5B,SAAS,IAAI,aAAa,EAC1B,kBAAkB,IAAI,sBAAsB,EAC5C,gBAAgB,IAAI,oBAAoB,GAGzC,MAAM,iBAAiB,CAAC;AAEzB,gCAAgC;AAChC,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAKlE;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,cAAc;IAC5C,YAAY,SAA2B,EAAE;QACvC,KAAK,CAAC,MAAM,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE;YAC5D,OAAO,IAAI,qBAAqB,CAC9B,UAAU,EACV,SAAS,EACT,OAAO,EACP,WAAW,CACZ,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAyB;IACxD,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAED,2CAA2C;AAC3C,MAAM,CAAC,MAAM,SAAS,GAAG,aAAa,CAAC;AACvC,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AACzD,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC"}