@xdevplatform/chat-xdk 0.1.0

package/pkg/chat_xdk_wasm.d.ts

@@ -0,0 +1,315 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The X Chat encryption SDK for JavaScript (crypto-only WASM layer).
+ *
+ * Provides all cryptographic operations: key generation, encrypt/decrypt,
+ * sign/verify. Juicebox key-storage lifecycle (setup/unlock/delete/changePin)
+ * is handled by the JS wrapper in `index.js`, which calls `exportKeys()` /
+ * `importKeys()` to shuttle raw key bytes across the boundary.
+ */
+export class Chat {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Decrypt a base64-encoded ciphertext and return the UTF-8 plaintext.
+     *
+     * Use for metadata fields like group names returned by the API.
+     */
+    decrypt(ciphertext_b64: string, conversation_key: Uint8Array): string;
+    /**
+     * Decrypt an encrypted conversation key (ECIES).
+     */
+    decryptConversationKey(encrypted_key_b64: string): Uint8Array;
+    /**
+     * Decrypt a raw webhook event payload.
+     *
+     * `conversationKeys` is the object returned by `extractConversationKeys`.
+     * `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.
+     */
+    decryptEvent(event_b64: string, conversation_keys: any, signing_keys: any): any;
+    /**
+     * Decrypt multiple events in batch.
+     *
+     * This is the recommended API for decrypting messages. It:
+     * 1. Extracts conversation keys from any KeyChange events
+     * 2. For each message, finds the correct signing key by matching userId + version
+     * 3. Decrypts the message using the appropriate conversation key
+     *
+     * `signingKeys` is an array of `{ userId, publicKeyVersion, publicKey,
+     * identityPublicKey, identityPublicKeySignature }` objects for ALL
+     * participants in the conversation (pass the X API response through).
+     *
+     * Returns `{ messages, conversationKeys, errors }`.
+     */
+    decryptEvents(events: string[], signing_keys: any): any;
+    /**
+     * Decrypt a streaming-encrypted payload (e.g. media).
+     */
+    decryptStream(encrypted: Uint8Array, conversation_key: Uint8Array): Uint8Array;
+    /**
+     * Encrypt a UTF-8 string and return base64 ciphertext.
+     *
+     * Use for metadata fields like group names before sending to the API.
+     */
+    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 }`.
+     */
+    encryptConversationKeyForRecipients(conversation_key: Uint8Array, recipients: 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, ... }]`.
+     */
+    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;
+    /**
+     * Encrypt a reaction-remove.
+     */
+    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;
+    /**
+     * Encrypt a reply message for the X API.
+     */
+    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;
+    /**
+     * Encrypt a stream (e.g. media).
+     */
+    encryptStream(plaintext: Uint8Array, conversation_key: Uint8Array): Uint8Array;
+    /**
+     * Export private keys as raw bytes (`Uint8Array`).
+     */
+    exportKeys(): Uint8Array;
+    /**
+     * Extract and decrypt conversation keys from raw KeyChange event strings.
+     *
+     * Returns a `ConversationKeyResult` with:
+     * - `keys`: Object mapping key version strings to `Uint8Array` conversation keys
+     * - `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.
+     *
+     * The key version is read from the JS clock (`Date.now()`) because the
+     * `wasm32-unknown-unknown` target has no system clock.
+     */
+    generateKeypairs(): any;
+    /**
+     * Get the fingerprint of the loaded identity public key.
+     *
+     * Returns a URL-safe base64 string that users can compare
+     * out-of-band (e.g. in person or over a trusted channel) to
+     * verify key authenticity.
+     */
+    getPublicKeyFingerprint(): string;
+    /**
+     * Get current public keys.
+     */
+    getPublicKeys(): any;
+    /**
+     * Returns `true` when the identity key is loaded (sufficient for decryption).
+     */
+    hasIdentityKey(): boolean;
+    /**
+     * Import private keys from raw bytes (`Uint8Array`).
+     *
+     * The input bytes are zeroized after import.
+     */
+    importKeys(keys: Uint8Array): void;
+    /**
+     * Returns `true` when both identity and signing keys are loaded.
+     */
+    isUnlocked(): boolean;
+    /**
+     * Clear keys from memory.
+     */
+    lock(): void;
+    /**
+     * Create a new Chat instance.
+     */
+    constructor();
+    /**
+     * Prepare conversation keys for all participants in one call.
+     *
+     * 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.
+     *
+     * Returns `{ conversationKey, conversationKeyVersion, participantKeys }`.
+     */
+    prepareConversationKeys(public_keys: any): any;
+    /**
+     * Set the public key version for the loaded identity key.
+     *
+     * Call after `importKeys` (or unlock) with the version string the
+     * X API reports for your registered public key, so KeyChange
+     * participant entries for other key versions are skipped.
+     */
+    setKeyVersion(version: string): void;
+    /**
+     * When enabled, `decryptEvent` throws if signature verification fails
+     * instead of returning events with `verified: false`.
+     */
+    setRejectUnverified(reject: boolean): void;
+    /**
+     * Sign data. Returns raw signature bytes (`Uint8Array`).
+     */
+    sign(data: Uint8Array): Uint8Array;
+    /**
+     * Build and sign a GroupMemberAdd action signature.
+     */
+    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;
+    /**
+     * Build and sign a ConversationKeyChange action signature.
+     */
+    signKeyChange(public_key_version: string, message_id: string, sender_id: string, conversation_id: string, conversation_key_version: string, conversation_key: Uint8Array): any;
+    /**
+     * Verify a signature.
+     */
+    verify(public_key_b64: string, signature: Uint8Array, data: Uint8Array): boolean;
+    /**
+     * Verify that a signing key is authentically bound to an identity key.
+     *
+     * Call this when you receive another user's public keys from the X API
+     * to detect server-side key substitution. All inputs are base64.
+     */
+    verifyKeyBinding(identity_public_key_b64: string, signing_public_key_b64: string, identity_public_key_signature_b64: string): boolean;
+}
+
+/**
+ * Decode base64 string to bytes.
+ *
+ * Returns null if the input is not valid base64.
+ */
+export function base64ToBytes(b64: string): Uint8Array | undefined;
+
+/**
+ * Encode bytes to base64 string.
+ */
+export function bytesToBase64(bytes: Uint8Array): string;
+
+/**
+ * Encode bytes to lowercase hex string.
+ */
+export function bytesToHex(bytes: Uint8Array): string;
+
+/**
+ * Detect image dimensions from file bytes.
+ *
+ * Supports PNG, JPEG, GIF, WebP, and BMP.
+ * Returns `{ width, height }` or null.
+ */
+export function detectImageDimensions(bytes: Uint8Array): any;
+
+/**
+ * Detect MIME type from file bytes using magic numbers.
+ *
+ * Returns the MIME type string (e.g., "image/png", "video/mp4") or null.
+ */
+export function detectMimeType(bytes: Uint8Array): string | undefined;
+
+/**
+ * Decode hex string to bytes.
+ *
+ * Returns null if the input is not valid hex.
+ */
+export function hexToBytes(hex: string): Uint8Array | undefined;
+
+/**
+ * Initialize panic hook for better error messages in console.
+ */
+export function init(): void;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_chat_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];
+    readonly chat_decrypt: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly chat_decryptConversationKey: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly chat_decryptEvent: (a: number, b: number, c: number, d: any, e: any) => [number, number, number];
+    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_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];
+    readonly chat_hasIdentityKey: (a: number) => number;
+    readonly chat_importKeys: (a: number, b: number, c: number) => [number, number];
+    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_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_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 init: () => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;