otomate 0.3.0 → 0.3.1

package/guides/html-to-docx-and-back.md

@@ -6,7 +6,9 @@ round-trip is lossless. Every step here is backed by a real test at
 `packages/otomate/src/__tests__/e2e-tracked-changes.test.ts` — if you copy the
 snippets verbatim they will run.
 
-> **Prerequisites.** Node ≥ 20, `otomate` installed. All `writeDocx` /
+> **Prerequisites.** Node ≥ 20 **or any modern browser** (Deno, Bun, workers,
+> edge runtimes also work — the library uses the Web Crypto API internally
+> and has no Node-specific imports). `otomate` installed. All `writeDocx` /
 > `readDocx` / `writeDiffDocx` calls are **async** — always `await` them.
 > `readHtml` / `writeHtml` / `renderDiffHtml` / `diff` are synchronous.
 
@@ -395,21 +397,11 @@ const buf = readFileSync("input.docx");   // Buffer (subclass of Uint8Array)
 const tree = await readDocx(buf);
 ```
 
-### 10. Tests pass via `tsx` but `tsc --noEmit` fails with `Cannot find name 'Buffer'` or `Cannot find module 'node:crypto'`
+### 10. Running the library in a browser — things that used to break but no longer do
 
-**Symptom.** Running the package's test suite works fine (because it uses `tsx`), but running `tsc --noEmit` over a file that imports from `@otomate/docx` complains about missing Node globals.
+As of `@otomate/docx@0.3.1` / `otomate@0.3.1`, the library has **zero Node-only imports**. Snapshot hashing goes through `globalThis.crypto.subtle.digest` (Web Crypto API) and the base64 fallback in the ZIP reader uses `globalThis.btoa`. Both are available in Node ≥ 20 and every modern browser. If you're on an older version and see `createHash is not a function` or `Buffer is not defined` at load time or runtime, upgrade to ≥ 0.3.1.
 
-**Cause.** The `@otomate/docx` package uses `node:crypto` and `Buffer` for the snapshot hash and base64 fallback. These types come from `@types/node`, which `tsc` only loads if your `tsconfig.json` includes `"types": ["node"]` in `compilerOptions`, or your code does a triple-slash reference. `tsx` loads Node types automatically so this doesn't bite you at runtime.
-
-**Fix.** In your consuming project's `tsconfig.json`:
-
-```json
-{
-  "compilerOptions": {
-    "types": ["node"]
-  }
-}
-```
+If you're still seeing a `tsc --noEmit` complaint about `Cannot find name 'Buffer'` or `Cannot find module 'node:crypto'` in your own downstream code (not from inside the library), that's a tsconfig issue in your project — add `@types/node` to your devDeps if you actually use Node globals, or remove stale references if you don't.
 
 And install `@types/node` as a devDep.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "otomate",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Universal document diffing library — structure-aware, string-level, multi-format",
   "type": "module",
   "main": "./dist/otomate.umd.cjs",