@volorio/chat-e2ee 0.2.0 → 0.2.1

package/LICENSE

@@ -0,0 +1,16 @@
+Volorio SDK Commercial License
+
+Copyright (c) 2026 Volorio. All rights reserved.
+
+Permission to install and use this SDK is granted only to an authorized Volorio
+customer or evaluator, solely to integrate an application with Volorio services,
+and subject to the Volorio Terms at https://volor.io/terms.
+
+Except where the Volorio Terms expressly allow it, you may not redistribute,
+sublicense, sell, publish, reverse engineer, or create a competing service from
+this SDK or its source code. No ownership rights are transferred.
+
+Third-party dependencies remain subject to their respective licenses.
+
+THE SDK IS PROVIDED WITHOUT WARRANTIES EXCEPT TO THE EXTENT EXPRESSLY STATED IN
+THE VOLORIO TERMS.

package/README.md

@@ -1,18 +1,43 @@
 # @volorio/chat-e2ee
 
-Volorio Chat end-to-end encryption add-on contracts.
+Volorio Signal Protocol compatible end-to-end encryption add-on contracts for chat.
 
-This package exposes Volorio-branded Signal Protocol compatible envelope helpers for customer clients. It does not send plaintext to Volorio services. A real Signal Protocol engine must be provided by the application; otherwise `createEnvelope` fails with `volorio_signal_protocol_engine_required`.
+## Install
+
+```bash
+npm install @volorio/chat-e2ee@0.2.1
+```
+
+## Runtime and security
+
+- Runtime: Browser application
+- Source version: `0.2.1`
+- Registry status: published as 0.2.1
+- API base URL for server calls: `https://api.volor.io`
+- License: proprietary commercial SDK; see the included `LICENSE` and [Volorio Terms](https://volor.io/terms).
+- Never expose a Volorio API key in browser, React Native, or Flutter code. Create short-lived sessions in your backend.
+- Capability note: Requested products must be granted to the API key and accepted by the session endpoint.
+
+## Public API
+
+- `VolorioSignalProtocolEncryptInput`
+- `VolorioSignalProtocolEngine`
+- `MissingSignalProtocolEngineError`
+- `VolorioChatE2eeClient`
+- `createVolorioChatE2eeClient`
 
 ```ts
-import { createVolorioChatE2eeClient } from "@volorio/chat-e2ee";
-
-const e2ee = createVolorioChatE2eeClient(signalEngine);
-const encryption = await e2ee.createEnvelope({
-  plaintext: new TextEncoder().encode("secret"),
-  senderDeviceId: "device_a",
-  recipientDeviceIds: ["device_b"],
-});
+import { VolorioChatE2eeClient } from "@volorio/chat-e2ee";
 ```
 
-Send the returned `encryption` object through `@volorio/chat`. The chat service stores only encrypted payload metadata and marks moderation status as `encrypted_unscanned`.
+
+## Dependencies
+
+- `@privacyresearch/libsignal-protocol-typescript` `^0.0.16`
+- `@volorio/chat` `^0.2.0`
+
+## Documentation
+
+- [Volorio npm integration guide](https://volor.io/docs/packages/npm-overview)
+- [REST and SDK documentation](https://volor.io/docs)
+- [Volorio Console](https://app.volor.io)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@volorio/chat-e2ee",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "private": false,
   "description": "Volorio Signal Protocol compatible end-to-end encryption add-on contracts for chat.",
   "main": "dist/src/index.js",
@@ -11,7 +11,11 @@
       "default": "./dist/src/index.js"
     }
   },
-  "files": ["dist/src", "README.md"],
+  "files": [
+    "dist/src",
+    "README.md",
+    "LICENSE"
+  ],
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -24,5 +28,21 @@
   "dependencies": {
     "@privacyresearch/libsignal-protocol-typescript": "^0.0.16",
     "@volorio/chat": "^0.2.0"
-  }
+  },
+  "homepage": "https://volor.io/docs/packages/npm-overview",
+  "license": "SEE LICENSE IN LICENSE",
+  "keywords": [
+    "volorio",
+    "realtime",
+    "rtc",
+    "sdk",
+    "chat-e2ee",
+    "signal",
+    "protocol",
+    "compatible",
+    "end-to-end",
+    "encryption",
+    "add-on",
+    "contracts"
+  ]
 }