@yoch/frozenminisearch 1.1.0 → 1.2.1

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## Unreleased
 
+## v1.2.1 — `@yoch/frozenminisearch`
+
+Patch release: lower search overhead when stored fields are disabled and fewer query-normalization allocations. No API or MSv5 wire-format changes.
+
+### Improved
+
+- **Search without `storeFields`** — skip stored-field reads during scoring and result finalization when the index has no stored fields (`storeFields: []`).
+- **String query normalization** — pre-allocated term/spec buffers, hoisted per-query field boosts and match weights, and shared `termToQuerySpec` building (fewer intermediate arrays and closures).
+
+## v1.2.0 — `@yoch/frozenminisearch`
+
+Minor release: configurable MSv5 snapshot compression and Node 20 support.
+
+### Added
+
+- **`SaveBinaryOptions`** — `saveBinarySync()` / `saveBinaryAsync()` accept `{ compression: 'auto' | 'raw' | 'zstd' | 'zlib' }`.
+- **`CODEC_ZLIB`** — portable deflate snapshots readable on Node 20+; explicit `compression: 'zlib'` always writes zlib on disk.
+- **Exported types** — `BinaryCompression`, `SaveBinaryOptions`.
+
+### Improved
+
+- **`compression: 'auto'`** — one compression pass: zstd when available (Node 22.15+), otherwise zlib on Node 20–22.14, otherwise raw when compression does not strictly shrink the payload (including payloads under 64 B).
+- **Node engine** — `>=20` (was `>=22.15`); zstd remains available on Node 22.15+ and is required to read zstd snapshots.
+
 ## v1.1.0 — `@yoch/frozenminisearch`
 
 Minor release: MiniSearch JSON wire export and clearer JSON import API. MSv5 binary format unchanged.

package/README.md

@@ -5,6 +5,8 @@
 [![CI](https://github.com/yoch/frozenminisearch/actions/workflows/main.yml/badge.svg)](https://github.com/yoch/frozenminisearch/actions/workflows/main.yml)
 [![Socket Badge](https://socket.dev/api/badge/npm/package/@yoch/frozenminisearch)](https://socket.dev/npm/package/%40yoch%2Ffrozenminisearch)
 
+[API documentation](https://yoch.github.io/frozenminisearch/)
+
 **Memory-optimized, read-only full-text search for Node.js** — the same BM25, prefix/fuzzy, and `autoSuggest` API as [MiniSearch](https://github.com/lucaong/minisearch), with **up to ~98% less index RAM** on real corpora and compact binary snapshots you ship instead of JSON.
 
 **Why it exists:** [MiniSearch](https://github.com/lucaong/minisearch) optimizes for a mutable in-memory index. FrozenMiniSearch optimizes for **retained heap, disk footprint, and cold load** once the corpus is fixed — packed radix postings, columnar `storeFields`, typed-array layouts, and MSv5 binary wire format instead of per-document JS objects.
@@ -186,7 +188,23 @@ const buf = index.saveBinarySync()
 const loaded = FrozenMiniSearch.loadBinarySync(buf, {}) // field names embedded in snapshot
 ```
 
-- **Node ≥ 22.15.0** (zstd via `node:zlib`)
+- **Node ≥ 20**
+- Default snapshot compression (`compression: 'auto'`, one pass):
+  - payloads under 64 B stay raw
+  - `zstd` on Node 22.15+ when it strictly shrinks the payload
+  - otherwise `zlib` on Node 20–22.14 when it strictly shrinks the payload
+  - otherwise `raw` (uncompressed)
+- Explicit snapshot compression always writes the chosen codec, even when compression would not shrink the payload (useful for portability):
+
+```javascript
+const portable = index.saveBinarySync({ compression: 'zlib' })
+const uncompressed = index.saveBinarySync({ compression: 'raw' })
+const bestRatio = index.saveBinarySync({ compression: 'zstd' }) // Node 22.15+
+```
+
+- Snapshot readability depends on the embedded codec:
+  - `raw` and `zlib` snapshots load on Node 20+
+  - `zstd` snapshots require Node 22.15+
 - Snapshots produced by this package version are forward-compatible; re-build from MiniSearch JSON if an older binary fails to load
 - `tokenize` / `processTerm` are not stored — pass the same functions at load when customized