@agora-sdk/secure-chat-core 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Replyke
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/cjs/context/secure-chat-context.d.ts

@@ -0,0 +1,60 @@
+import React from "react";
+import { SecureChatCrypto } from "@agora-sdk/secure-chat-crypto";
+import { SecureChatRestClient } from "../transport/rest";
+import { SecureChatSocketClient } from "../transport/socket";
+/**
+ * The value exposed by {@link useSecureChat}: the shared transport clients, the injected crypto,
+ * and the active project id. The hooks build everything else on top of these.
+ */
+export interface SecureChatContextValue {
+    /** REST client for the blind Delivery Service endpoints. */
+    rest: SecureChatRestClient;
+    /** Realtime client for the `/secure` socket.io namespace. */
+    socket: SecureChatSocketClient;
+    /** The injected MLS crypto implementation (mock, or platform ts-mls/native). */
+    crypto: SecureChatCrypto;
+    /** The Agora project id these clients are scoped to. */
+    projectId: string;
+}
+/** Props for {@link SecureChatProvider}. */
+export interface SecureChatProviderProps {
+    /** The MLS crypto implementation (mock for tests; ts-mls/OpenMLS-WASM in platform packages). */
+    crypto: SecureChatCrypto;
+    /** Agora project id (path-scoped on every endpoint). */
+    projectId: string;
+    /** Current access token. Re-pass on refresh; read lazily per request. */
+    accessToken?: string;
+    /** Override token resolution (takes precedence over `accessToken`). */
+    getAccessToken?: () => string | undefined;
+    /** Override the API base URL. Defaults to @agora-sdk/core `getApiBaseUrl()`. */
+    baseUrl?: string;
+    /** Override the socket origin. Defaults to @agora-sdk/core `getSocketUrl()`. */
+    socketUrl?: string;
+    children: React.ReactNode;
+}
+/**
+ * Provides the secure-chat transport + crypto to the `useSecure*` hooks. Render it inside a
+ * `ReplykeProvider`: by default it inherits the API base URL and socket origin from
+ * `@agora-sdk/core`'s runtime, and disconnects the socket on unmount.
+ *
+ * @param props - {@link SecureChatProviderProps} — the injected crypto, project id, token, and
+ *   optional base/socket URL overrides.
+ * @returns A context provider wrapping `children`.
+ *
+ * @example
+ * ```tsx
+ * <ReplykeProvider projectId={projectId} baseUrl={baseUrl}>
+ *   <SecureChatProvider crypto={crypto} projectId={projectId} accessToken={token}>
+ *     <Chat />
+ *   </SecureChatProvider>
+ * </ReplykeProvider>
+ * ```
+ */
+export declare function SecureChatProvider({ crypto, projectId, accessToken, getAccessToken, baseUrl, socketUrl, children, }: SecureChatProviderProps): React.JSX.Element;
+/**
+ * Access the nearest {@link SecureChatContextValue}.
+ *
+ * @returns The shared rest/socket/crypto/projectId for this provider subtree.
+ * @throws {Error} When called outside a `<SecureChatProvider>`.
+ */
+export declare function useSecureChat(): SecureChatContextValue;

package/dist/cjs/context/secure-chat-context.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecureChatProvider = SecureChatProvider;
+exports.useSecureChat = useSecureChat;
+const jsx_runtime_1 = require("react/jsx-runtime");
+// SecureChatProvider — wires the transport + crypto for the secure-chat hooks.
+//
+// Sits INSIDE a ReplykeProvider: by default it resolves the API base URL and socket origin from
+// @agora-sdk/core's runtime singletons (getApiBaseUrl / getSocketUrl), so whatever `baseUrl` the
+// app set on ReplykeProvider is honored here too. Crypto is injected (a `SecureChatCrypto`), keeping
+// core platform- and library-agnostic — the web/native packages supply the concrete MLS impl.
+const react_1 = require("react");
+const core_1 = require("@agora-sdk/core");
+const rest_1 = require("../transport/rest");
+const socket_1 = require("../transport/socket");
+const SecureChatContext = (0, react_1.createContext)(null);
+/**
+ * Provides the secure-chat transport + crypto to the `useSecure*` hooks. Render it inside a
+ * `ReplykeProvider`: by default it inherits the API base URL and socket origin from
+ * `@agora-sdk/core`'s runtime, and disconnects the socket on unmount.
+ *
+ * @param props - {@link SecureChatProviderProps} — the injected crypto, project id, token, and
+ *   optional base/socket URL overrides.
+ * @returns A context provider wrapping `children`.
+ *
+ * @example
+ * ```tsx
+ * <ReplykeProvider projectId={projectId} baseUrl={baseUrl}>
+ *   <SecureChatProvider crypto={crypto} projectId={projectId} accessToken={token}>
+ *     <Chat />
+ *   </SecureChatProvider>
+ * </ReplykeProvider>
+ * ```
+ */
+function SecureChatProvider({ crypto, projectId, accessToken, getAccessToken, baseUrl, socketUrl, children, }) {
+    // Keep the latest token in a ref so the per-request resolver always returns the current value
+    // without rebuilding the transport clients on every token change.
+    const tokenRef = (0, react_1.useRef)(accessToken);
+    tokenRef.current = accessToken;
+    const resolveToken = (0, react_1.useMemo)(() => getAccessToken ?? (() => tokenRef.current), [getAccessToken]);
+    const rest = (0, react_1.useMemo)(() => new rest_1.SecureChatRestClient({
+        projectId,
+        getAccessToken: resolveToken,
+        getBaseUrl: () => baseUrl ?? (0, core_1.getApiBaseUrl)(),
+    }), [projectId, resolveToken, baseUrl]);
+    const socket = (0, react_1.useMemo)(() => new socket_1.SecureChatSocketClient({
+        projectId,
+        getAccessToken: resolveToken,
+        getSocketUrl: () => socketUrl ?? (0, core_1.getSocketUrl)(),
+    }), [projectId, resolveToken, socketUrl]);
+    (0, react_1.useEffect)(() => {
+        return () => socket.disconnect();
+    }, [socket]);
+    const value = (0, react_1.useMemo)(() => ({ rest, socket, crypto, projectId }), [rest, socket, crypto, projectId]);
+    return (0, jsx_runtime_1.jsx)(SecureChatContext.Provider, { value: value, children: children });
+}
+/**
+ * Access the nearest {@link SecureChatContextValue}.
+ *
+ * @returns The shared rest/socket/crypto/projectId for this provider subtree.
+ * @throws {Error} When called outside a `<SecureChatProvider>`.
+ */
+function useSecureChat() {
+    const ctx = (0, react_1.useContext)(SecureChatContext);
+    if (!ctx) {
+        throw new Error("useSecureChat must be used within a <SecureChatProvider>.");
+    }
+    return ctx;
+}
+//# sourceMappingURL=secure-chat-context.js.map

package/dist/cjs/context/secure-chat-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secure-chat-context.js","sourceRoot":"","sources":["../../../src/context/secure-chat-context.tsx"],"names":[],"mappings":";;AAkEA,gDAiDC;AAQD,sCAMC;;AAjID,+EAA+E;AAC/E,EAAE;AACF,gGAAgG;AAChG,iGAAiG;AACjG,qGAAqG;AACrG,8FAA8F;AAE9F,iCAAqF;AACrF,0CAA8D;AAG9D,4CAAyD;AACzD,gDAA6D;AAiB7D,MAAM,iBAAiB,GAAG,IAAA,qBAAa,EAAgC,IAAI,CAAC,CAAC;AAmB7E;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,kBAAkB,CAAC,EACjC,MAAM,EACN,SAAS,EACT,WAAW,EACX,cAAc,EACd,OAAO,EACP,SAAS,EACT,QAAQ,GACgB;IACxB,8FAA8F;IAC9F,kEAAkE;IAClE,MAAM,QAAQ,GAAG,IAAA,cAAM,EAAqB,WAAW,CAAC,CAAC;IACzD,QAAQ,CAAC,OAAO,GAAG,WAAW,CAAC;IAE/B,MAAM,YAAY,GAAG,IAAA,eAAO,EAC1B,GAAG,EAAE,CAAC,cAAc,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAChD,CAAC,cAAc,CAAC,CACjB,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,eAAO,EAClB,GAAG,EAAE,CACH,IAAI,2BAAoB,CAAC;QACvB,SAAS;QACT,cAAc,EAAE,YAAY;QAC5B,UAAU,EAAE,GAAG,EAAE,CAAC,OAAO,IAAI,IAAA,oBAAa,GAAE;KAC7C,CAAC,EACJ,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CACnC,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,eAAO,EACpB,GAAG,EAAE,CACH,IAAI,+BAAsB,CAAC;QACzB,SAAS;QACT,cAAc,EAAE,YAAY;QAC5B,YAAY,EAAE,GAAG,EAAE,CAAC,SAAS,IAAI,IAAA,mBAAY,GAAE;KAChD,CAAC,EACJ,CAAC,SAAS,EAAE,YAAY,EAAE,SAAS,CAAC,CACrC,CAAC;IAEF,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IACnC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,MAAM,KAAK,GAAG,IAAA,eAAO,EACnB,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAC3C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAClC,CAAC;IAEF,OAAO,uBAAC,iBAAiB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAA8B,CAAC;AAC3F,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa;IAC3B,MAAM,GAAG,GAAG,IAAA,kBAAU,EAAC,iBAAiB,CAAC,CAAC;IAC1C,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/cjs/contract/index.d.ts

@@ -0,0 +1,150 @@
+export type SecureConversationType = "dm" | "group" | "channel";
+export type SecureMemberRole = "admin" | "member";
+export type SecureHandshakeKind = "welcome" | "commit" | "proposal";
+/** A Welcome targeted at the ONE device whose claimed KeyPackage was consumed. */
+export interface WelcomeEnvelope {
+    targetDeviceId: string;
+    payload: string;
+    epoch: string;
+}
+/** A Commit/Proposal broadcast to the whole group (no target device). */
+export interface HandshakeBlob {
+    payload: string;
+    epoch: string;
+}
+export interface RegisterDeviceBody {
+    deviceId: string;
+    displayName?: string | null;
+    signaturePublicKey: string;
+    credential: string;
+    ciphersuite: number;
+}
+export interface PublishKeyPackagesBody {
+    keyPackages: {
+        keyPackageRef: string;
+        keyPackage: string;
+        ciphersuite: number;
+        expiresAt?: string | null;
+    }[];
+}
+export interface CreateSecureConversationBody {
+    type: SecureConversationType;
+    mlsGroupId: string;
+    spaceId?: string | null;
+    name?: string | null;
+    memberUserIds?: string[];
+    welcomes?: WelcomeEnvelope[];
+}
+export interface AddSecureMemberBody {
+    userId: string;
+    commit: HandshakeBlob;
+    welcomes: WelcomeEnvelope[];
+}
+export interface RemoveSecureMemberBody {
+    commit: HandshakeBlob;
+}
+export interface SendSecureMessageBody {
+    ciphertext: string;
+    epoch: string;
+    senderDeviceId: string;
+    contentType?: string | null;
+}
+export interface UploadKeyBackupBody {
+    deviceId?: string | null;
+    blob: string;
+    nonce: string;
+    kdf: "argon2id" | "pbkdf2";
+    kdfParams: Record<string, unknown>;
+    cipher: "xchacha20poly1305" | "aes-256-gcm";
+    version: number;
+}
+export interface SecureDeviceModel {
+    id: string;
+    projectId: string;
+    userId: string;
+    deviceId: string;
+    displayName: string | null;
+    signaturePublicKey: string;
+    credential: string;
+    ciphersuite: number;
+    revokedAt: string | null;
+    lastSeenAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SecureKeyPackageClaim {
+    deviceId: string;
+    keyPackageRef: string;
+    keyPackage: string;
+    ciphersuite: number;
+}
+export interface SecureConversationMemberModel {
+    id: string;
+    projectId: string;
+    conversationId: string;
+    userId: string;
+    role: SecureMemberRole;
+    isActive: boolean;
+    joinedAtEpoch: string | null;
+    lastReadAt: string | null;
+    leftAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SecureConversationModel {
+    id: string;
+    projectId: string;
+    type: SecureConversationType;
+    mlsGroupId: string;
+    spaceId: string | null;
+    currentEpoch: string;
+    name: string | null;
+    createdById: string | null;
+    lastMessageAt: string | null;
+    memberCount?: number;
+    unreadCount?: number;
+    currentMember?: SecureConversationMemberModel;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SecureMessageModel {
+    id: string;
+    projectId: string;
+    conversationId: string;
+    senderUserId: string | null;
+    senderDeviceId: string | null;
+    epoch: string;
+    ciphertext: string;
+    contentType: string;
+    createdAt: string;
+}
+export interface SecureHandshakeModel {
+    id: string;
+    seq: string;
+    kind: SecureHandshakeKind;
+    conversationId: string;
+    epoch: string;
+    payload: string;
+    senderDeviceId: string | null;
+    targetDeviceId: string | null;
+}
+export interface SecureKeyBackupModel {
+    id: string;
+    projectId: string;
+    userId: string;
+    deviceId: string | null;
+    blob: string;
+    nonce: string;
+    kdf: string;
+    kdfParams: Record<string, unknown>;
+    cipher: string;
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Standard error envelope: `{ error, code, field? }` with `secure-chat/*` codes. */
+export interface SecureChatErrorBody {
+    error: string;
+    code: string;
+    field?: string;
+}

package/dist/cjs/contract/index.js

@@ -0,0 +1,16 @@
+"use strict";
+// Secure-chat wire contract — stand-in for @agora/contract (the Apache-2.0 server contract).
+//
+// Mirrors the response models + request bodies of agora-server's
+// `packages/contract/src/secure-chat.ts`. That package is the source of truth (zod + TS); the
+// client only needs the TypeScript shapes, so this copy is types-only.
+//
+// ⚠️ Keep this byte-faithful to the server contract. The arrow is SDK → contract: once
+// `@agora/contract` is published, DELETE this file and `import type { ... } from "@agora/contract"`.
+// Do NOT publish a separate `@agora-sdk/secure-chat-contract` (that would invert the dependency —
+// see STATUS.md). Do not let this copy drift in the meantime.
+//
+// Wire conventions: every binary value is **base64** (the server stores/relays opaque blobs and
+// never parses them); MLS epochs are **decimal strings** (u64 exceeds JS safe-int range).
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/cjs/contract/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/contract/index.ts"],"names":[],"mappings":";AAAA,6FAA6F;AAC7F,EAAE;AACF,iEAAiE;AACjE,8FAA8F;AAC9F,uEAAuE;AACvE,EAAE;AACF,uFAAuF;AACvF,qGAAqG;AACrG,kGAAkG;AAClG,8DAA8D;AAC9D,EAAE;AACF,gGAAgG;AAChG,0FAA0F"}

package/dist/cjs/hooks/useSecureConversations.d.ts

@@ -0,0 +1,35 @@
+import { SecureConversationModel } from "../contract";
+/** The state and actions returned by {@link useSecureConversations}. */
+export interface UseSecureConversationsValues {
+    /** The loaded conversations, newest activity first. */
+    conversations: SecureConversationModel[];
+    /** True while a page load or refresh is in flight. */
+    loading: boolean;
+    /** Whether more pages remain to {@link UseSecureConversationsValues.loadMore}. */
+    hasMore: boolean;
+    /** The last error thrown by loading or conversation creation, or `null`. */
+    error: unknown;
+    /** Append the next page of older conversations. No-op when already loading or exhausted. */
+    loadMore: () => Promise<void>;
+    /** Reload from the top, replacing the current list. */
+    refresh: () => Promise<void>;
+    /** Start (or surface) a 1:1 conversation with another user across all their devices. */
+    createDirectConversation: (peerUserId: string) => Promise<SecureConversationModel>;
+}
+/**
+ * List the caller's secure conversations and start new direct messages.
+ *
+ * Refreshes on mount and on `secure:member:joined` / `secure:member:left` signals.
+ * {@link UseSecureConversationsValues.createDirectConversation} claims one KeyPackage per peer
+ * device, builds the MLS group locally, and registers it on the blind DS with targeted Welcomes —
+ * the group secrets never leave the client.
+ *
+ * @returns {@link UseSecureConversationsValues} — the conversation list, paging state, and actions.
+ *
+ * @example
+ * ```tsx
+ * const { conversations, createDirectConversation } = useSecureConversations();
+ * await createDirectConversation(peerUserId);
+ * ```
+ */
+export declare function useSecureConversations(): UseSecureConversationsValues;

package/dist/cjs/hooks/useSecureConversations.js

@@ -0,0 +1,109 @@
+"use strict";
+// useSecureConversations — list the caller's secure conversations and start new DMs.
+//
+// Starting a DM (server spec §14.3): claim each peer device's KeyPackage → createGroup locally →
+// POST /conversations with the Welcomes targeted to each peer device. The MLS group secrets stay on
+// the client; the server only stores ciphertext metadata.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSecureConversations = useSecureConversations;
+const react_1 = require("react");
+const base64_1 = require("../util/base64");
+const secure_chat_context_1 = require("../context/secure-chat-context");
+/**
+ * List the caller's secure conversations and start new direct messages.
+ *
+ * Refreshes on mount and on `secure:member:joined` / `secure:member:left` signals.
+ * {@link UseSecureConversationsValues.createDirectConversation} claims one KeyPackage per peer
+ * device, builds the MLS group locally, and registers it on the blind DS with targeted Welcomes —
+ * the group secrets never leave the client.
+ *
+ * @returns {@link UseSecureConversationsValues} — the conversation list, paging state, and actions.
+ *
+ * @example
+ * ```tsx
+ * const { conversations, createDirectConversation } = useSecureConversations();
+ * await createDirectConversation(peerUserId);
+ * ```
+ */
+function useSecureConversations() {
+    const { rest, crypto, socket } = (0, secure_chat_context_1.useSecureChat)();
+    const [conversations, setConversations] = (0, react_1.useState)([]);
+    const [cursor, setCursor] = (0, react_1.useState)(undefined);
+    const [hasMore, setHasMore] = (0, react_1.useState)(true);
+    const [loading, setLoading] = (0, react_1.useState)(false);
+    const [error, setError] = (0, react_1.useState)(null);
+    const load = (0, react_1.useCallback)(async (reset) => {
+        setLoading(true);
+        setError(null);
+        try {
+            const page = await rest.listConversations({
+                cursor: reset ? undefined : cursor,
+                limit: 30,
+            });
+            const last = page.conversations[page.conversations.length - 1];
+            setCursor(last ? last.lastMessageAt ?? last.createdAt : cursor);
+            setHasMore(page.hasMore);
+            setConversations((prev) => (reset ? page.conversations : [...prev, ...page.conversations]));
+        }
+        catch (err) {
+            setError(err);
+        }
+        finally {
+            setLoading(false);
+        }
+    }, [rest, cursor]);
+    const refresh = (0, react_1.useCallback)(async () => {
+        setCursor(undefined);
+        await load(true);
+    }, [load]);
+    const loadMore = (0, react_1.useCallback)(async () => {
+        if (!hasMore || loading)
+            return;
+        await load(false);
+    }, [hasMore, loading, load]);
+    const createDirectConversation = (0, react_1.useCallback)(async (peerUserId) => {
+        // 1. Discover the peer's active devices and claim one KeyPackage per device.
+        const peerDevices = await rest.listDevices(peerUserId);
+        if (peerDevices.length === 0) {
+            throw new Error("Peer has no registered secure-chat devices.");
+        }
+        const initialMembers = await Promise.all(peerDevices.map(async (d) => {
+            const claim = await rest.claimKeyPackage(d.id);
+            return { deviceId: d.id, keyPackage: (0, base64_1.fromBase64)(claim.keyPackage) };
+        }));
+        // 2. Create the MLS group locally; the crypto layer holds the secrets.
+        const { group, welcomes } = await crypto.createGroup({ initialMembers });
+        // 3. Register the conversation on the blind DS, relaying the targeted Welcomes.
+        const conversation = await rest.createConversation({
+            type: "dm",
+            mlsGroupId: (0, base64_1.toBase64)(group.mlsGroupId),
+            memberUserIds: [peerUserId],
+            welcomes: welcomes.map((w) => ({
+                targetDeviceId: w.targetDeviceId,
+                payload: (0, base64_1.toBase64)(w.payload),
+                epoch: group.epoch.toString(),
+            })),
+        });
+        setConversations((prev) => [conversation, ...prev.filter((c) => c.id !== conversation.id)]);
+        return conversation;
+    }, [rest, crypto]);
+    (0, react_1.useEffect)(() => {
+        refresh();
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+    // Light realtime refresh on membership changes (metadata-only signals).
+    (0, react_1.useEffect)(() => {
+        const offJoined = socket.on("secure:member:joined", () => {
+            refresh().catch(setError);
+        });
+        const offLeft = socket.on("secure:member:left", () => {
+            refresh().catch(setError);
+        });
+        return () => {
+            offJoined();
+            offLeft();
+        };
+    }, [socket, refresh]);
+    return { conversations, loading, hasMore, error, loadMore, refresh, createDirectConversation };
+}
+//# sourceMappingURL=useSecureConversations.js.map

package/dist/cjs/hooks/useSecureConversations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSecureConversations.js","sourceRoot":"","sources":["../../../src/hooks/useSecureConversations.tsx"],"names":[],"mappings":";AAAA,qFAAqF;AACrF,EAAE;AACF,iGAAiG;AACjG,oGAAoG;AACpG,0DAA0D;;AAyC1D,wDAgGC;AAvID,iCAAyD;AAEzD,2CAAsD;AACtD,wEAA+D;AAoB/D;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,sBAAsB;IACpC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,mCAAa,GAAE,CAAC;IAEjD,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,IAAA,gBAAQ,EAA4B,EAAE,CAAC,CAAC;IAClF,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,IAAA,gBAAQ,EAAqB,SAAS,CAAC,CAAC;IACpE,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,IAAA,gBAAQ,EAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAA,gBAAQ,EAAU,IAAI,CAAC,CAAC;IAElD,MAAM,IAAI,GAAG,IAAA,mBAAW,EACtB,KAAK,EAAE,KAAc,EAAE,EAAE;QACvB,UAAU,CAAC,IAAI,CAAC,CAAC;QACjB,QAAQ,CAAC,IAAI,CAAC,CAAC;QACf,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC;gBACxC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;gBAClC,KAAK,EAAE,EAAE;aACV,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC/D,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YAChE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAC9F,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC,EACD,CAAC,IAAI,EAAE,MAAM,CAAC,CACf,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAC,KAAK,IAAI,EAAE;QACrC,SAAS,CAAC,SAAS,CAAC,CAAC;QACrB,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAEX,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,KAAK,IAAI,EAAE;QACtC,IAAI,CAAC,OAAO,IAAI,OAAO;YAAE,OAAO;QAChC,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IAE7B,MAAM,wBAAwB,GAAG,IAAA,mBAAW,EAC1C,KAAK,EAAE,UAAkB,EAAoC,EAAE;QAC7D,6EAA6E;QAC7E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACvD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CACtC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;YAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC/C,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,UAAU,EAAE,IAAA,mBAAU,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACtE,CAAC,CAAC,CACH,CAAC;QAEF,uEAAuE;QACvE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;QAEzE,gFAAgF;QAChF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC;YACjD,IAAI,EAAE,IAAI;YACV,UAAU,EAAE,IAAA,iBAAQ,EAAC,KAAK,CAAC,UAAU,CAAC;YACtC,aAAa,EAAE,CAAC,UAAU,CAAC;YAC3B,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC7B,cAAc,EAAE,CAAC,CAAC,cAAc;gBAChC,OAAO,EAAE,IAAA,iBAAQ,EAAC,CAAC,CAAC,OAAO,CAAC;gBAC5B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE;aAC9B,CAAC,CAAC;SACJ,CAAC,CAAC;QAEH,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5F,OAAO,YAAY,CAAC;IACtB,CAAC,EACD,CAAC,IAAI,EAAE,MAAM,CAAC,CACf,CAAC;IAEF,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,OAAO,EAAE,CAAC;QACV,uDAAuD;IACzD,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,wEAAwE;IACxE,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,MAAM,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;YACvD,OAAO,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YACnD,OAAO,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,EAAE;YACV,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAEtB,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;AACjG,CAAC"}