@xdevplatform/chat-xdk 0.1.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 X Corp.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -13,44 +13,34 @@ The Rust WASM layer is a pure crypto engine; Juicebox key-storage lifecycle is o
 ## Prerequisites
 
 - **Node.js 18+**
-- [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
 
-## Setup
-
-### 1. Build chat-xdk WASM
+## Install
 
 ```bash
-cd crates/wasm
-wasm-pack build --target nodejs --out-dir pkg    # or --target web for browser bundlers
+npm install @xdevplatform/chat-xdk
 ```
 
-### 2. Build juicebox-sdk WASM
+The compiled WASM engine ships inside the package (`pkg/`) — no build step.
 
-`juicebox-sdk` is not on npm — it must be built from source.
-Clone [juicebox-sdk](https://github.com/juicebox-systems/juicebox-sdk) as a sibling of `chat-xdk`:
+Juicebox PIN-based key storage is an optional peer dependency:
 
 ```bash
-git clone https://github.com/juicebox-systems/juicebox-sdk.git ../juicebox-sdk
-cd ../juicebox-sdk/rust/sdk/bridge/wasm
-wasm-pack build --target nodejs --out-dir pkg --out-name juicebox-sdk
+npm install juicebox-sdk   # only needed for setup()/unlock()/changePin()
 ```
 
-The `--out-name juicebox-sdk` flag is required so the output files match the names
-that `index.js` imports (`juicebox-sdk.js`, `juicebox-sdk_bg.js`, `juicebox-sdk_bg.wasm`).
-Use the same `--target` for both builds (`nodejs` for Node, `web` or `bundler` for browsers).
+## Developing in this repo
 
-### 3. Install dependencies
+Working from a chat-xdk checkout (instead of the npm package) requires staging
+the WASM build that `index.js` resolves at `./pkg/`:
 
 ```bash
-cd crates/wasm/js
-npm install
-npm install ../../juicebox-sdk/rust/sdk/bridge/wasm/pkg   # links juicebox-sdk
+make wasm   # from the repo root; builds --target web and stages js/pkg/
 ```
 
 ## Quick Start
 
 ```typescript
-import { createChat } from "chat-xdk";
+import { createChat } from "@xdevplatform/chat-xdk";
 
 const chat = await createChat({
   juiceboxConfig: configJson,
@@ -58,10 +48,24 @@ const chat = await createChat({
 });
 await chat.unlock("2580");
 
-// Initial load — batch decrypt with automatic key extraction
+// Initial load — batch decrypt with automatic key extraction.
+// Each signing-key entry carries all five fields from the X API
+// public keys response.
 const result = chat.decryptEvents(rawEvents, [
-  { userId: "111", publicKeyVersion: "v1", publicKey: "BASE64..." },
-  { userId: "222", publicKeyVersion: "v1", publicKey: "BASE64..." },
+  {
+    userId: "111",
+    publicKeyVersion: "v1",
+    publicKey: "BASE64...",
+    identityPublicKey: "BASE64...",
+    identityPublicKeySignature: "BASE64...",
+  },
+  {
+    userId: "222",
+    publicKeyVersion: "v1",
+    publicKey: "BASE64...",
+    identityPublicKey: "BASE64...",
+    identityPublicKeySignature: "BASE64...",
+  },
 ]);
 
 for (const dm of result.messages) {