@doccloak/core 0.8.0

package/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to `@doccloak/core` are documented here. The format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the
+project follows [Semantic Versioning](https://semver.org/).
+
+## [0.8.0] - 2026-07-27
+
+First public release. The engine was extracted from the DocCloak web app
+(https://github.com/WLojek/DocCloak) into this standalone Apache-2.0 package.
+
+### Added
+
+- `CoreEnv` environment abstraction (`kv`, `modelCache`, `fetch`, `wasm`,
+  `loadTokenizer`, `hardware`, `persistStorage`) so the engine runs in web,
+  extension and Node hosts without touching browser globals; in-memory
+  `memoryKV()` / `memoryBlobCache()` helpers.
+- Detection providers: GLiNER PII Edge (`gliner`, multi-language, custom
+  labels) and BardS.ai EU PII (`bardsai`, 24 EU languages, 35 PII types),
+  both on ONNX Runtime Web. Models download at runtime and are cached via
+  `CoreEnv.modelCache`; they are not bundled.
+- Regex rule set: universal rules plus 17 country-specific rule groups,
+  selectable via `REGEX_REGIONS`.
+- Detection pipeline: `detectEntities`, `detectWithRegex`,
+  `resolveOverlaps`, `filterFalsePositives`, `propagateEntities`.
+- `AnonymizationSession` placeholder mapping (labeled / blanked modes).
+- Document handling: docx read/write and legacy `.doc` text extraction;
+  OCR helpers for images (tesseract.js) behind the `./dom` entry.
+- Engine assembly: `createEngine()` with settings persistence, provider
+  registry, threshold defaults and hardware-based default-model heuristic.
+- Transport-agnostic worker protocol (`./worker-protocol`):
+  `serveEngine()` / `connectEngine()` over any `PortLike` port.
+- Build pipeline: ESM + type declarations in `dist/` for the `.`, `./dom`
+  and `./worker-protocol` entry points; tarball verified with publint and
+  arethetypeswrong.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,5 @@
+DocCloak.Core
+Copyright 2026 Witold Lojek
+
+This product includes software developed as part of the DocCloak project
+(https://github.com/WLojek).

package/README.md

@@ -0,0 +1,230 @@
+# @doccloak/core
+
+`@doccloak/core` is the UI-free document anonymization engine of the
+[DocCloak](https://github.com/WLojek/DocCloak) ecosystem: local PII detection
+(ONNX NER models, regex rules), session state and placeholder mapping,
+document parsing (docx, legacy doc, OCR for images), and a transport-agnostic
+worker protocol. Everything runs on the consumer's machine; no text ever
+leaves the host application.
+
+```sh
+npm install @doccloak/core
+```
+
+The package ships built ESM plus type declarations and exposes three entry
+points:
+
+| Entry | Contents |
+| --- | --- |
+| `@doccloak/core` | Engine, detection pipeline, providers, regex rules, session/replacement state, model loader, `CoreEnv` contract |
+| `@doccloak/core/dom` | DOM-dependent helpers: docx read/write, image-to-canvas OCR (works in DOM-less workers via `OffscreenCanvas` where available) |
+| `@doccloak/core/worker-protocol` | `serveEngine` / `connectEngine`: run the engine behind any message port |
+
+## Ecosystem split
+
+| Repository | License | Role |
+| --- | --- | --- |
+| [DocCloak.Core](https://github.com/WLojek/DocCloak.Core) (this package) | Apache-2.0 | The engine, consumed by every shell |
+| [DocCloak](https://github.com/WLojek/DocCloak) (web app) | AGPL-3.0 | Open-source web UI built on `@doccloak/core` |
+| DocCloak browser extension | proprietary | Closed-source MV3 extension, also built on `@doccloak/core` |
+
+The engine is permissively licensed (Apache-2.0) so both the AGPL web app and
+the proprietary extension can depend on it.
+
+## Models download at runtime
+
+The ONNX detection models are **not bundled** in this package. On first use
+the engine downloads them from Hugging Face and stores them in the
+`CoreEnv.modelCache` you provide (the browser Cache Storage in the reference
+hosts):
+
+| Provider | Model | Download |
+| --- | --- | --- |
+| `gliner` | GLiNER PII Edge (multi-language, custom labels) | ~65 MB |
+| `bardsai` | BardS.ai EU PII (24 EU languages, 35 PII types) | ~279 MB |
+
+`pickDefaultProvider(hardware)` chooses `gliner` on mobile or low-memory
+devices and `bardsai` otherwise. Download progress is surfaced via
+`engine.onDownloadProgress(cb)`.
+
+ONNX Runtime also needs its WASM binaries at runtime; point
+`CoreEnv.wasm.paths` at wherever your host serves the `onnxruntime-web`
+`*.wasm` assets from.
+
+## API overview
+
+- **Engine** - `createEngine(env, initialSettings?, options?)` returns a
+  `DocCloakEngine`: `detect(text, signal?, onProgress?)`, `preload()`,
+  `switchProvider(id)`, `getSettings()` / `updateSettings(patch)`,
+  `onDownloadProgress` / `onDetectionProgress`, `release()`. Settings persist
+  through `env.kv`.
+- **Detection pipeline** - `detectEntities`, `detectWithRegex`,
+  `resolveOverlaps`, `filterFalsePositives`, `propagateEntities` for hosts
+  that compose their own flow; `ALL_REGEX_RULES` and `REGEX_REGIONS` describe
+  the built-in regex rule set (universal + per-country rules).
+- **Session state** - `AnonymizationSession` maps detected entities to stable
+  placeholders (labeled or blanked) and back.
+- **Documents** (`/dom`) - `readDocx` / `writeAnonymizedDocx`, legacy `.doc`
+  text extraction (`readDocText` on the main entry), OCR helpers
+  (`loadImageToCanvas`, `recognizeCanvas`, `renderRedactedImage`) built on
+  tesseract.js.
+- **Worker protocol** (`/worker-protocol`) - `serveEngine(engine, port)` on
+  the side that owns the engine, `connectEngine(port)` on the UI side.
+  `PortLike` is satisfied by thin wrappers over `Worker`, `MessagePort` or
+  `chrome.runtime.Port`.
+- **Model loader** - `fetchModelBlob` / `evictModelFromCache` implement
+  cache-first model downloads with progress and retry (`retryAsync`).
+
+## Host integration: CoreEnv
+
+The engine never touches `localStorage`, Cache Storage, `navigator` or
+`import.meta` directly. Every host supplies a `CoreEnv` describing how the
+engine talks to the outside world:
+
+```ts
+interface CoreEnv {
+  kv: KVStore;                    // async string KV for settings persistence
+  modelCache: BlobCache;          // blob cache for downloaded model files
+  fetch: typeof fetch;            // injectable for tests/proxies
+  wasm: { paths: string; numThreads?: number };  // onnxruntime-web asset location
+  loadTokenizer(hfModelId: string): Promise<unknown>;  // e.g. @huggingface/transformers
+  hardware?: HardwareHints;       // deviceMemoryGB / isMobile, feeds provider default
+  persistStorage?: () => Promise<boolean>;  // e.g. navigator.storage.persist()
+}
+```
+
+`memoryKV()` and `memoryBlobCache()` provide in-memory implementations for
+tests and short-lived Node processes.
+
+### Web app quickstart
+
+```ts
+import { createEngine, type CoreEnv } from '@doccloak/core';
+import { AutoTokenizer } from '@huggingface/transformers';
+
+const env: CoreEnv = {
+  kv: {
+    async get(k) { return localStorage.getItem(k); },
+    async set(k, v) { localStorage.setItem(k, v); },
+    async remove(k) { localStorage.removeItem(k); },
+  },
+  modelCache: {
+    async match(url) { return (await caches.open('models')).match(url).then((r) => r?.blob()); },
+    async put(url, blob) {
+      try { await (await caches.open('models')).put(url, new Response(blob)); return true; }
+      catch { return false; }  // quota refused: engine falls back to no cache
+    },
+    async delete(url) { await (await caches.open('models')).delete(url); },
+  },
+  fetch: (...args) => fetch(...args),
+  wasm: { paths: '/', numThreads: 1 },  // serve onnxruntime-web *.wasm under /
+  loadTokenizer: (hfModelId) => AutoTokenizer.from_pretrained(hfModelId),
+  hardware: { isMobile: /Mobile/i.test(navigator.userAgent) },
+};
+
+const engine = createEngine(env);
+await engine.ready;
+const entities = await engine.detect('John Smith lives in Warsaw.');
+```
+
+In practice the web app runs the engine inside a Web Worker and talks to it
+through the worker protocol:
+
+```ts
+// detection.worker.ts (worker side)
+import { createEngine } from '@doccloak/core';
+import { serveEngine, type PortLike } from '@doccloak/core/worker-protocol';
+
+const port: PortLike = {
+  postMessage: (msg) => self.postMessage(msg),
+  onMessage: (cb) => {
+    const h = (e: MessageEvent) => void cb(e.data);
+    self.addEventListener('message', h);
+    return () => self.removeEventListener('message', h);
+  },
+};
+serveEngine(createEngine(env), port);
+
+// main thread (client side)
+import { connectEngine } from '@doccloak/core/worker-protocol';
+const worker = new Worker(new URL('./detection.worker.ts', import.meta.url), { type: 'module' });
+const engine = connectEngine({
+  postMessage: (msg) => worker.postMessage(msg),
+  onMessage: (cb) => {
+    const h = (e: MessageEvent) => void cb(e.data);
+    worker.addEventListener('message', h);
+    return () => worker.removeEventListener('message', h);
+  },
+});
+```
+
+### Browser extension (MV3) quickstart
+
+An extension host is the same wiring with extension primitives: back `kv`
+with `chrome.storage.local`, keep `modelCache` on Cache Storage (available in
+extension contexts), serve the onnxruntime-web WASM assets from the extension
+bundle (`chrome.runtime.getURL('...')` as `wasm.paths`), and run the engine in
+an offscreen document or service worker. Bridge `chrome.runtime.Port` to
+`PortLike` for `serveEngine` / `connectEngine`:
+
+```ts
+import { serveEngine } from '@doccloak/core/worker-protocol';
+
+chrome.runtime.onConnect.addListener((chromePort) => {
+  serveEngine(engine, {
+    postMessage: (msg) => chromePort.postMessage(msg),
+    onMessage: (cb) => {
+      const h = (msg: unknown) => void cb(msg);
+      chromePort.onMessage.addListener(h);
+      return () => chromePort.onMessage.removeListener(h);
+    },
+  });
+});
+```
+
+### Node quickstart
+
+The detection providers run on `onnxruntime-web`'s WASM backend, which works
+in Node 20+ (global `fetch` required). The in-memory env helpers make a
+minimal setup:
+
+```ts
+import { createEngine, memoryKV, memoryBlobCache } from '@doccloak/core';
+import { AutoTokenizer } from '@huggingface/transformers';
+
+const engine = createEngine({
+  kv: memoryKV(),
+  modelCache: memoryBlobCache(),
+  fetch: (...args) => fetch(...args),
+  wasm: { paths: 'node_modules/onnxruntime-web/dist/', numThreads: 1 },
+  loadTokenizer: (hfModelId) => AutoTokenizer.from_pretrained(hfModelId),
+});
+await engine.ready;
+console.log(await engine.detect('Contact jane.doe@example.com or +48 601 123 456.'));
+```
+
+Pure functions (regex pipeline, `AnonymizationSession`, docx/doc parsing via
+`Blob`/`ArrayBuffer`) have no environment requirements at all. The `/dom`
+entry needs DOM APIs (`DOMParser`, canvas); in Node use it under jsdom or
+stick to the DOM-free main entry.
+
+## Development
+
+In-repo consumers (the web app, the extension) link this package via
+`file:../DocCloak.Core` and compile the TypeScript source directly; the
+committed `package.json` points at `src/`. Packing (`npm pack` / `npm
+publish`) builds `dist/` and rewrites the entry points to the built output
+via the `prepack` script, then `postpack` restores the source paths.
+
+```sh
+npm install
+npm test           # vitest
+npm run typecheck
+npm run build      # emits ESM + d.ts into dist/
+npm pack           # builds + produces the publishable tarball
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). Contributions are
+accepted under Apache-2.0 (inbound = outbound); no CLA.

package/dist/doc.d.ts

@@ -0,0 +1,13 @@
+export declare function writeAnonymizedDoc(buffer: ArrayBuffer, replacements: Array<{
+    start: number;
+    end: number;
+    replacement: string;
+}>): Promise<Blob>;
+/**
+ * Extract plain text from a legacy .doc (OLE2/Compound File Binary) file.
+ * Parses the FIB and piece table to correctly extract text from both
+ * compressed (CP1252) and Unicode pieces. The result covers the whole
+ * document: main text plus footnotes, headers/footers, and comments, so PII
+ * in those regions is visible to detection.
+ */
+export declare function readDocText(buffer: ArrayBuffer): string;