@hushjot/core 0.0.0-stage → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,23 @@
1
- # Temporary Holding Version
1
+ # @hushjot/core
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ HushJot's stored-byte format, extracted so a second client can read and write
4
+ a vault without reimplementing it: the AES-256-GCM envelope, Argon2id key
5
+ records, the sealed note-meta JSON, title and excerpt derivation, and the
6
+ search index.
7
+
8
+ Built from the app repository. Do not edit these files — change
9
+ `src/core/public.ts` there and republish.
10
+
11
+ ## Node only
12
+
13
+ Key derivation uses `hash-wasm` on the calling thread. The browser build of
14
+ HushJot runs the same code in a Web Worker; that worker is not shipped here,
15
+ so this package should not be bundled for a browser.
16
+
17
+ ## The contract
18
+
19
+ - `@hushjot/core/contract/format-vectors.json` — frozen ciphertext, key
20
+ records and derivations. Assert against these; a divergence means the two
21
+ clients no longer agree about what a note looks like on disk.
22
+ - `@hushjot/core/contract/firestore.rules` — the live security rules, for
23
+ running an emulator against the real thing rather than a stale copy.