@xdevplatform/chat-xdk 0.1.0 → 0.2.0

package/pkg/chat_xdk_wasm.d.ts

@@ -25,11 +25,17 @@ export class Chat {
     /**
      * Decrypt a raw webhook event payload.
      *
-     * `conversationKeys` is the object returned by `extractConversationKeys`.
+     * `conversationKeys` is a plain `version → key bytes` map — the `.keys`
+     * property of the object returned by `extractConversationKeys` (passing
+     * the whole result object yields an empty map and every decrypt fails
+     * with "no matching key found").
      * `signingKeys` is an array of `{ userId, publicKeyVersion, publicKey,
-     * identityPublicKey, identityPublicKeySignature }` objects for the sender;
-     * the SDK picks the matching version automatically.
-     * Pass an empty array to skip signature verification.
+     * identityPublicKey, identityPublicKeySignature }` objects; entries are
+     * filtered to the event's sender and the SDK picks the matching version
+     * automatically. Under the default reject-unverified policy an empty
+     * array makes every signed event throw; only after
+     * `setRejectUnverified(false)` are such events returned with
+     * `verified: false`.
      */
     decryptEvent(event_b64: string, conversation_keys: any, signing_keys: any): any;
     /**
@@ -59,32 +65,37 @@ export class Chat {
     encrypt(plaintext: string, conversation_key: Uint8Array): string;
     /**
      * Encrypt a reaction-add.
-     */
-    encryptAddReaction(message_id: string, sender_id: string, conversation_id: string, conversation_key: Uint8Array, target_message_sequence_id: string, emoji: string, conversation_key_version: string, signing_key_version: string): any;
-    /**
-     * Encrypt a conversation key for one or more recipients.
      *
-     * Each entry is `{ userId, publicKey, keyVersion }`.
+     * Takes a single params object with camelCase keys: `messageId`,
+     * `senderId`, `conversationId`, `conversationKey` (Uint8Array),
+     * `targetMessageSequenceId`, `emoji`, `conversationKeyVersion`,
+     * `signingKeyVersion`. The same shape works for `encryptRemoveReaction`.
      */
-    encryptConversationKeyForRecipients(conversation_key: Uint8Array, recipients: any): any;
+    encryptAddReaction(params: any): any;
     /**
      * Encrypt a text message for the X API.
      *
-     * `entities` accepts a JS array of `[start, end, "type"]` tuples, e.g.
-     * `[[0, 23, "url"], [25, 30, "mention"]]`.
-     *
-     * `attachments` accepts a JS array of attachment objects, e.g.
-     * `[{ attachment_type: "media", media_hash_key: "...", width: 1024, ... }]`.
+     * Takes a single params object with camelCase keys: `messageId`,
+     * `senderId`, `conversationId`, `conversationKey` (Uint8Array), `text`,
+     * `conversationKeyVersion`, `signingKeyVersion`, plus optional
+     * `entities` (array of `[start, end, "type"]` tuples), `attachments`
+     * (array of attachment objects), `shouldNotify`, and `ttlMsec`.
      */
-    encryptMessage(message_id: string, sender_id: string, conversation_id: string, conversation_key: Uint8Array, text: string, conversation_key_version: string, signing_key_version: string, entities?: any | null, attachments?: any | null, should_notify?: boolean | null, ttl_msec?: number | null): any;
+    encryptMessage(params: any): any;
     /**
      * Encrypt a reaction-remove.
+     *
+     * Takes the same params object shape as `encryptAddReaction`.
      */
-    encryptRemoveReaction(message_id: string, sender_id: string, conversation_id: string, conversation_key: Uint8Array, target_message_sequence_id: string, emoji: string, conversation_key_version: string, signing_key_version: string): any;
+    encryptRemoveReaction(params: any): any;
     /**
      * Encrypt a reply message for the X API.
+     *
+     * Takes a single params object: the same fields as `encryptMessage` plus
+     * required `replyToSequenceId` and optional `replyToSenderId`,
+     * `replyToText`, `replyToEntities`, and `replyToAttachments`.
      */
-    encryptReply(message_id: string, sender_id: string, conversation_id: string, conversation_key: Uint8Array, text: string, conversation_key_version: string, signing_key_version: string, reply_to_sequence_id: string, reply_to_sender_id?: number | null, reply_to_text?: string | null, entities?: any | null, attachments?: any | null, reply_to_entities?: any | null, reply_to_attachments?: any | null, should_notify?: boolean | null, ttl_msec?: number | null): any;
+    encryptReply(params: any): any;
     /**
      * Encrypt a stream (e.g. media).
      */
@@ -101,10 +112,6 @@ export class Chat {
      * - `latestVersion`: The highest key version (use for encrypting new messages)
      */
     extractConversationKeys(events: string[]): any;
-    /**
-     * Generate a new conversation key.
-     */
-    generateConversationKey(): Uint8Array;
     /**
      * Generate new keypairs and return the registration payload.
      *
@@ -147,16 +154,42 @@ export class Chat {
      */
     constructor();
     /**
-     * Prepare conversation keys for all participants in one call.
+     * Prepare a signed conversation-key change, ready to send to the X API.
+     *
+     * Takes a single params object with camelCase keys: `senderId`,
+     * `signingKeyVersion`, `publicKeys` (the flat array of public keys —
+     * self plus recipients — from the X API), plus optional
+     * `conversationId`. Omit `conversationId` for a one-to-one and it is
+     * derived from the two participants; pass the existing id for a group
+     * key rotation.
+     *
+     * Returns `{ conversationId, conversationKey, conversationKeyVersion,
+     * participantKeys, actionSignatures }`.
+     */
+    prepareConversationKeyChange(params: any): any;
+    /**
+     * Prepare a signed group create, ready to send to the X API.
      *
-     * This is the recommended method for both group creation and key
-     * initialization. Pass the flat array of public keys from the X API;
-     * the SDK groups by userId, picks the latest version per user,
-     * generates a fresh conversation key, and encrypts it for everyone.
+     * Takes a single params object with camelCase keys: `senderId`,
+     * `signingKeyVersion`, `publicKeys` (for the new roster),
+     * `conversationId`, `memberIds`, `adminIds`, plus optional `title`,
+     * `avatarUrl`, and `ttlMsec`. Emits two action signatures (a
+     * conversation-key change and the group create). Returns the same shape
+     * as [`Chat::prepare_conversation_key_change`].
+     */
+    prepareGroupCreate(params: any): any;
+    /**
+     * Prepare a signed group member-add change, ready to send to the X API.
      *
-     * Returns `{ conversationKey, conversationKeyVersion, participantKeys }`.
+     * Takes a single params object with camelCase keys: `senderId`,
+     * `signingKeyVersion`, `publicKeys` (for the updated roster),
+     * `conversationId`, `newMemberIds`, `currentMemberIds`,
+     * `currentAdminIds`, `currentPendingMemberIds`, plus optional
+     * `currentTitle`, `currentAvatarUrl`, `currentTtlMsec`, and
+     * `currentScreenCaptureBlockingEnabled`. Returns the same shape as
+     * [`Chat::prepare_conversation_key_change`].
      */
-    prepareConversationKeys(public_keys: any): any;
+    prepareGroupMembersChange(params: any): any;
     /**
      * Set the public key version for the loaded identity key.
      *
@@ -166,8 +199,9 @@ export class Chat {
      */
     setKeyVersion(version: string): void;
     /**
-     * When enabled, `decryptEvent` throws if signature verification fails
-     * instead of returning events with `verified: false`.
+     * When enabled — the default — `decryptEvent` throws for any signed
+     * event whose signature cannot be verified (invalid, missing, or no
+     * matching signing key) instead of returning it with `verified: false`.
      */
     setRejectUnverified(reject: boolean): void;
     /**
@@ -175,13 +209,13 @@ export class Chat {
      */
     sign(data: Uint8Array): Uint8Array;
     /**
-     * Build and sign a GroupMemberAdd action signature.
+     * Create an incremental stream decryptor for large payloads.
      */
-    signAddMembers(public_key_version: string, message_id: string, sender_id: string, conversation_id: string, new_member_ids: string[], current_member_ids: string[], current_admin_ids: string[], current_pending_member_ids: string[], conversation_key_version: string, current_title?: string | null, current_avatar_url?: string | null, current_ttl_msec?: number | null): any;
+    streamDecryptor(conversation_key: Uint8Array): StreamDecryptor;
     /**
-     * Build and sign a ConversationKeyChange action signature.
+     * Create an incremental stream encryptor for large payloads.
      */
-    signKeyChange(public_key_version: string, message_id: string, sender_id: string, conversation_id: string, conversation_key_version: string, conversation_key: Uint8Array): any;
+    streamEncryptor(conversation_key: Uint8Array): StreamEncryptor;
     /**
      * Verify a signature.
      */
@@ -195,6 +229,46 @@ export class Chat {
     verifyKeyBinding(identity_public_key_b64: string, signing_public_key_b64: string, identity_public_key_signature_b64: string): boolean;
 }
 
+/**
+ * Incremental stream decryptor for large payloads.
+ *
+ * Feed ciphertext with `push`; call `finish` once at end of input. `finish`
+ * throws if the stream ended before its final frame (truncation), so callers
+ * must not treat plaintext as complete until `finish` succeeds.
+ */
+export class StreamDecryptor {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Decrypt the final frame and consume the decryptor.
+     */
+    finish(): Uint8Array;
+    /**
+     * Decrypt a ciphertext chunk, returning plaintext available so far.
+     */
+    push(ciphertext: Uint8Array): Uint8Array;
+}
+
+/**
+ * Incremental stream encryptor for large payloads.
+ *
+ * Feed plaintext with `push`; call `finish` once to emit the final frame.
+ */
+export class StreamEncryptor {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Emit the final frame and consume the encryptor.
+     */
+    finish(): Uint8Array;
+    /**
+     * Encrypt a plaintext chunk, returning ciphertext available so far.
+     */
+    push(plaintext: Uint8Array): Uint8Array;
+}
+
 /**
  * Decode base64 string to bytes.
  *
@@ -244,6 +318,8 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 export interface InitOutput {
     readonly memory: WebAssembly.Memory;
     readonly __wbg_chat_free: (a: number, b: number) => void;
+    readonly __wbg_streamdecryptor_free: (a: number, b: number) => void;
+    readonly __wbg_streamencryptor_free: (a: number, b: number) => void;
     readonly base64ToBytes: (a: number, b: number) => [number, number];
     readonly bytesToBase64: (a: number, b: number) => [number, number];
     readonly bytesToHex: (a: number, b: number) => [number, number];
@@ -253,15 +329,13 @@ export interface InitOutput {
     readonly chat_decryptEvents: (a: number, b: number, c: number, d: any) => [number, number, number];
     readonly chat_decryptStream: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
     readonly chat_encrypt: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
-    readonly chat_encryptAddReaction: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number) => [number, number, number];
-    readonly chat_encryptConversationKeyForRecipients: (a: number, b: number, c: number, d: any) => [number, number, number];
-    readonly chat_encryptMessage: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number) => [number, number, number];
-    readonly chat_encryptRemoveReaction: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number) => [number, number, number];
-    readonly chat_encryptReply: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number, u: number, v: number, w: number, x: number, y: number, z: number, a1: number, b1: number) => [number, number, number];
+    readonly chat_encryptAddReaction: (a: number, b: any) => [number, number, number];
+    readonly chat_encryptMessage: (a: number, b: any) => [number, number, number];
+    readonly chat_encryptRemoveReaction: (a: number, b: any) => [number, number, number];
+    readonly chat_encryptReply: (a: number, b: any) => [number, number, number];
     readonly chat_encryptStream: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
     readonly chat_exportKeys: (a: number) => [number, number, number, number];
     readonly chat_extractConversationKeys: (a: number, b: number, c: number) => [number, number, number];
-    readonly chat_generateConversationKey: (a: number) => [number, number, number, number];
     readonly chat_generateKeypairs: (a: number) => [number, number, number];
     readonly chat_getPublicKeyFingerprint: (a: number) => [number, number, number, number];
     readonly chat_getPublicKeys: (a: number) => [number, number, number];
@@ -270,17 +344,23 @@ export interface InitOutput {
     readonly chat_isUnlocked: (a: number) => number;
     readonly chat_lock: (a: number) => void;
     readonly chat_new: () => number;
-    readonly chat_prepareConversationKeys: (a: number, b: any) => [number, number, number];
+    readonly chat_prepareConversationKeyChange: (a: number, b: any) => [number, number, number];
+    readonly chat_prepareGroupCreate: (a: number, b: any) => [number, number, number];
+    readonly chat_prepareGroupMembersChange: (a: number, b: any) => [number, number, number];
     readonly chat_setKeyVersion: (a: number, b: number, c: number) => void;
     readonly chat_setRejectUnverified: (a: number, b: number) => void;
     readonly chat_sign: (a: number, b: number, c: number) => [number, number, number, number];
-    readonly chat_signAddMembers: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number, u: number, v: number, w: number, x: number, y: number) => [number, number, number];
-    readonly chat_signKeyChange: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number) => [number, number, number];
+    readonly chat_streamDecryptor: (a: number, b: number, c: number) => [number, number, number];
+    readonly chat_streamEncryptor: (a: number, b: number, c: number) => [number, number, number];
     readonly chat_verify: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number];
     readonly chat_verifyKeyBinding: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number];
     readonly detectImageDimensions: (a: number, b: number) => any;
     readonly detectMimeType: (a: number, b: number) => [number, number];
     readonly hexToBytes: (a: number, b: number) => [number, number];
+    readonly streamdecryptor_finish: (a: number) => [number, number, number, number];
+    readonly streamdecryptor_push: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly streamencryptor_finish: (a: number) => [number, number, number, number];
+    readonly streamencryptor_push: (a: number, b: number, c: number) => [number, number, number, number];
     readonly init: () => void;
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;