@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 +22 -2
- package/contract/firestore.rules +735 -0
- package/contract/format-vectors.json +347 -0
- package/crypto/binding.d.ts +11 -0
- package/crypto/binding.js +23 -0
- package/crypto/bytes.d.ts +33 -0
- package/crypto/bytes.js +85 -0
- package/crypto/envelope.d.ts +108 -0
- package/crypto/envelope.js +189 -0
- package/crypto/kdf.d.ts +48 -0
- package/crypto/kdf.js +143 -0
- package/crypto/keyRecord.d.ts +124 -0
- package/crypto/keyRecord.js +268 -0
- package/crypto/recoveryCode.d.ts +11 -0
- package/crypto/recoveryCode.js +91 -0
- package/globals.d.ts +9 -0
- package/history/record.d.ts +54 -0
- package/history/record.js +41 -0
- package/history/retention.d.ts +60 -0
- package/history/retention.js +70 -0
- package/hushjot-core-0.4.0.tgz +0 -0
- package/notes/folders.d.ts +109 -0
- package/notes/folders.js +241 -0
- package/notes/model.d.ts +228 -0
- package/notes/model.js +273 -0
- package/notes/tags.d.ts +75 -0
- package/notes/tags.js +138 -0
- package/notes/text.d.ts +11 -0
- package/notes/text.js +27 -0
- package/package.json +30 -4
- package/public.d.ts +80 -0
- package/public.js +148 -0
- package/repo/codec.d.ts +105 -0
- package/repo/codec.js +74 -0
- package/search/index.d.ts +96 -0
- package/search/index.js +397 -0
- package/search/query.d.ts +70 -0
- package/search/query.js +157 -0
- package/sync/adapter.d.ts +354 -0
- package/sync/adapter.js +71 -0
- package/sync/pause.d.ts +84 -0
- package/sync/pause.js +146 -0
- package/sync/usage.d.ts +200 -0
- package/sync/usage.js +116 -0
package/README.md
CHANGED
|
@@ -1,3 +1,23 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @hushjot/core
|
|
2
2
|
|
|
3
|
-
|
|
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.
|