libsodium-sumo 0.8.2 → 0.8.3

package/README.md

@@ -73,8 +73,8 @@ await sodium.ready;
 
 let key = sodium.crypto_secretstream_xchacha20poly1305_keygen();
 
-let res = sodium.crypto_secretstream_xchacha20poly1305_init_push(key);
-let [state_out, header] = [res.state, res.header];
+let { state: state_out, header } =
+  sodium.crypto_secretstream_xchacha20poly1305_init_push(key);
 let c1 = sodium.crypto_secretstream_xchacha20poly1305_push(state_out,
   sodium.from_string('message 1'), null,
   sodium.crypto_secretstream_xchacha20poly1305_TAG_MESSAGE);
@@ -84,9 +84,11 @@ let c2 = sodium.crypto_secretstream_xchacha20poly1305_push(state_out,
 
 let state_in = sodium.crypto_secretstream_xchacha20poly1305_init_pull(header, key);
 let r1 = sodium.crypto_secretstream_xchacha20poly1305_pull(state_in, c1);
-let [m1, tag1] = [sodium.to_string(r1.message), r1.tag];
+let { message: m1_bytes, tag: tag1 } = r1;
+let m1 = sodium.to_string(m1_bytes);
 let r2 = sodium.crypto_secretstream_xchacha20poly1305_pull(state_in, c2);
-let [m2, tag2] = [sodium.to_string(r2.message), r2.tag];
+let { message: m2_bytes, tag: tag2 } = r2;
+let m2 = sodium.to_string(m2_bytes);
 
 console.log(m1);
 console.log(m2);
@@ -219,6 +221,13 @@ returns the following object:
 { publicKey: (Uint8Array), privateKey: (Uint8Array), keyType: 'x25519' }
 ```
 
+This also applies to newer APIs such as:
+```javascript
+{ state: (StateAddress), header: (Uint8Array) }
+{ ciphertext: (Uint8Array), sharedSecret: (Uint8Array) }
+```
+for `crypto_secretstream_xchacha20poly1305_init_push()` and `crypto_kem_enc()`.
+
 ### Standard vs Sumo version
 
 The standard version (in the `dist/browsers`, `dist/modules`, and
@@ -247,9 +256,10 @@ need to be installed on your system:
 * bun
 * make
 
-Running `make` will install the dev dependencies, clone libsodium,
-build it, test it, build the wrapper, and create the modules and
-minified distribution files.
+Running `make` will install the dev dependencies if needed, build the
+standard and sumo distributions, regenerate API docs and TypeScript
+bindings, pack the generated outputs, and rebuild the browser test
+artifacts.
 
 ### Benchmarks