ping-openmls-sdk-react-native-macos 0.2.3 → 0.6.0

package/src/NativePing.ts

@@ -54,11 +54,27 @@ export interface Spec extends TurboModule {
    * - `identityB64` — base64 of the identity export bytes
    * - `deviceLabel` — human-readable label (e.g. "MacBook")
    * - `nowMs` — wall clock; pass `Date.now()`
+   * - [CR-4] `sqlitePath` — absolute path to a host-managed SQLite file the SDK creates
+   *   and owns for persistent MLS state. `null` falls back to the in-memory provider
+   *   (fine for tests / non-cold-start flows; **not** fine for NSE-style wake-ups).
+   * - [CR-4] `sqliteEncryptionKeyB64` — 32-byte SQLCipher key, base64-encoded. Ignored
+   *   when `sqlitePath` is `null`. Pass `null` if you don't want at-rest encryption.
+   * - `deviceSigningSecretKeyB64` — optional 32-byte Ed25519 secret the SDK
+   *   adopts as its device signing key on FIRST init. Pass `null` to keep
+   *   the legacy random-key behaviour. See `ClientConfig.deviceSigningSecretKey`
+   *   in MessagingClient.ts for the security rationale.
    *
    * Resolves to `true` on success, rejects with `InitFailed` (Rust error) or
    * `InvalidIdentity` (base64 decode) on failure.
    */
-  initClient(identityB64: string, deviceLabel: string, nowMs: number): Promise<boolean>;
+  initClient(
+    identityB64: string,
+    deviceLabel: string,
+    nowMs: number,
+    sqlitePath: string | null,
+    sqliteEncryptionKeyB64: string | null,
+    deviceSigningSecretKeyB64: string | null,
+  ): Promise<boolean>;
 
   /** Returns the active client's user_id as a hex string. Rejects if not initialised. */
   getUserId(): Promise<string>;
@@ -89,10 +105,15 @@ export interface Spec extends TurboModule {
     nowMs: number,
   ): Promise<Record<string, unknown>>;
 
-  /** Add members by their KeyPackage bytes. Resolves to null on success. */
+  /**
+   * Add members by `(deviceId, keyPackage)` pairs ([CR-2]). The SDK persists a
+   * per-conversation device→leaf map so [revokeDevice] can later locate the leaves
+   * without a fresh directory lookup. Each entry is a dict so the codegen marshals
+   * it as an NSDictionary (macOS) / JSValueObject (Windows).
+   */
   addMembers(
     conversationId: number[],
-    keyPackages: number[][],
+    entries: { deviceId: number[]; keyPackage: number[] }[],
     nowMs: number,
   ): Promise<null>;
 
@@ -137,10 +158,17 @@ export interface Spec extends TurboModule {
 
   // ----- Stage 4f: linking + revocation -----
 
-  /** Build a linking ticket for a new device (caller is the existing device E). */
+  /**
+   * Build a linking ticket for a new device (caller is the existing device E).
+   *
+   * [CR-13] `lastAppEvents` is host-supplied per-conversation "what you missed"
+   * data the new device will render before sync catches up. Empty array suppresses
+   * catchup data. Each entry's bytes are opaque to the SDK.
+   */
   buildLinkingTicket(
     newDeviceId: number[],
     newDeviceKp: number[],
+    lastAppEvents: { conversationId: number[]; appEventBytes: number[] }[],
     nowMs: number,
   ): Promise<Record<string, unknown>>;
 
@@ -150,8 +178,44 @@ export interface Spec extends TurboModule {
     nowMs: number,
   ): Promise<null>;
 
-  /** Revoke a device — Remove proposals in DeviceGroup + every conversation. */
-  revokeDevice(deviceId: number[], nowMs: number): Promise<null>;
+  /**
+   * Revoke a device ([CR-2]). Returns one Commit envelope per conversation the
+   * device was a locally-known leaf in. Empty array means the device wasn't locally
+   * known anywhere (scope limit — see CR-2 doc).
+   */
+  revokeDevice(deviceId: number[], nowMs: number): Promise<Record<string, unknown>[]>;
+
+  // ----- CR-8 / CR-7 surface -----
+
+  /**
+   * Export a derived secret from a conversation's MLS exporter ([CR-8]). Returned
+   * bytes are a secret — never log; the caller is responsible for wiping the array.
+   */
+  exportConversationSecret(
+    conversationId: number[],
+    label: string,
+    context: number[],
+    length: number,
+  ): Promise<number[]>;
+
+  /**
+   * Export a portable MLS state snapshot for one conversation ([CR-7]). Returns the
+   * raw bytes — embed in a recovery blob or a linking ticket. Contains past epoch
+   * secrets; treat as a secret.
+   */
+  exportConversationStateSnapshot(
+    conversationId: number[],
+    nowMs: number,
+  ): Promise<number[]>;
+
+  /**
+   * Import a `GroupStateSnapshot` from another device of the same user identity
+   * ([CR-7]). Returns the imported conversation id.
+   */
+  importStateSnapshot(
+    snapshotBytes: number[],
+    nowMs: number,
+  ): Promise<number[]>;
 
   // ----- macOS-platform helpers -----