@orbitconnect/react 0.1.0 → 0.1.3

package/README.md

@@ -2,7 +2,7 @@
 
 React SDK for OrbitConnect — drop in real-time chat, voice/video calls, and meetings into any React app.
 
-> The SDK connects exclusively to `https://orbitxyz.muvle.org/api/v1`. This base URL is fixed and cannot be overridden.
+> Get your API keys at [orbitconnect.cloud](https://orbitconnect.cloud). All requests go to `https://api.orbitconnect.cloud/api/v1` — this base URL is fixed and cannot be overridden.
 
 ## Install
 
@@ -16,9 +16,17 @@ Also import the stylesheet once in your entry file:
 import '@orbitconnect/react/index.css'
 ```
 
-## Quick start
+---
+
+## Get started
+
+### 1. Create an account
+
+Sign up at [orbitconnect.cloud](https://orbitconnect.cloud) to get your:
+- `ORBIT_SECRET_KEY` — server-side secret key (`sk_live_…`)
+- `ORBIT_CLIENT_ID` — publishable client ID (`pk_live_…`)
 
-### 1. Backend — issue a user token
+### 2. Backend — issue a user token
 
 ```ts
 // Express / Next.js API route
@@ -36,7 +44,7 @@ app.post('/auth/token', async (req, res) => {
 })
 ```
 
-### 2. Frontend — wrap with OrbitProvider
+### 3. Frontend — wrap with OrbitProvider
 
 ```tsx
 import { OrbitProvider, Chat } from '@orbitconnect/react'
@@ -215,6 +223,23 @@ const {
 } = useCall()
 ```
 
+### useMeeting()
+
+```ts
+const {
+  meeting,          // ActiveMeeting | null
+  joinMeeting,      // (meetingId, title) => Promise<void>
+  leaveMeeting,
+  muteSelf,
+  unmuteSelf,
+  startScreenShare,
+  stopScreenShare,
+  raiseHand,
+  lowerHand,
+  sendReaction,     // (emoji: string) => void
+} = useMeeting()
+```
+
 ### useNotifications()
 
 ```ts
@@ -254,6 +279,12 @@ const {
 } = useRealtime()
 ```
 
+### useCallHistory()
+
+```ts
+const { records } = useCallHistory()  // CallRecord[]
+```
+
 ### useOrbitEvent(eventType, handler)
 
 Subscribe to any raw WebSocket event.
@@ -270,12 +301,6 @@ useOrbitEvent('notification:received', ({ payload }) => {
 })
 ```
 
-### useCallHistory()
-
-```ts
-const { records } = useCallHistory()  // CallRecord[]
-```
-
 ### useOrbit()
 
 Access the raw context from any child component.
@@ -361,14 +386,6 @@ When the server closes the WebSocket with code `4001` (token expired), the SDK c
 
 ---
 
-## Build
-
-```bash
-npm run build    # tsc + vite build + tailwind CSS
-npm run dev      # vite dev server (for SDK development)
-npm run lint     # eslint
-```
-
 ## License
 
-MIT
+MIT — [orbitconnect.cloud](https://orbitconnect.cloud)

package/dist/OrbitContext.d.ts

@@ -33,6 +33,8 @@ export interface AppConfig {
     sounds?: SoundConfig;
     /** Show the chat header bar (default: true) */
     showChatHeader?: boolean;
+    /** Show the conversation list header — brand/title + new-chat button (default: true) */
+    showConversationHeader?: boolean;
     /** Show the quick-message button in the composer (default: true) */
     showQuickMessageButton?: boolean;
     /** Use the rich-text (contentEditable) editor; false = plain textarea (default: true) */
@@ -49,6 +51,13 @@ export interface AppConfig {
     enableMeetingUi?: boolean;
     /** Show "Powered by OrbitConnect" footer in Chat and Meeting widgets (default: true) */
     showPoweredBy?: boolean;
+    /**
+     * Enable end-to-end encryption for messages.
+     * When true, message content is encrypted client-side before sending
+     * and decrypted on receipt using the PSALMS + RSA dual-layer cipher.
+     * The conversation must also have is_e2e_enabled=true on the backend.
+     */
+    enableE2E?: boolean;
     /** Custom attachment button icon */
     attachmentIcon?: ReactNode;
     /** Custom voice-record button icon */
@@ -80,8 +89,12 @@ export interface OrbitContextValue {
     baseUrl: string;
     /** Optional branding config */
     appConfig?: AppConfig;
+    /** E2E key pair — present only when appConfig.enableE2E is true */
+    e2eKeys?: import('./e2e').E2EKeys;
+    /** Per-session key used by the PSALMS cipher layer */
+    e2eSessionKey?: string;
 }
 export declare const OrbitContext: import("react").Context<OrbitContextValue | null>;
 export declare function useOrbit(): OrbitContextValue;
 /** Convenience hook — returns appConfig with safe defaults applied */
-export declare function useAppConfig(): Required<Pick<AppConfig, 'showChatHeader' | 'showQuickMessageButton' | 'useRichTextEditor' | 'showAttachMentButton' | 'showSearchIcon' | 'showAudioIcon' | 'showVideoIcon' | 'enableMeetingUi' | 'showPoweredBy'>> & Pick<AppConfig, 'attachmentIcon' | 'recordIcon' | 'QuickmessageIcon' | 'emojIcon' | 'stickerIcon' | 'sendIcon' | 'deliveredIcon' | 'sentIcon' | 'readIcon' | 'callIcon' | 'VideoCallIcon'>;
+export declare function useAppConfig(): Required<Pick<AppConfig, 'showChatHeader' | 'showConversationHeader' | 'showQuickMessageButton' | 'useRichTextEditor' | 'showAttachMentButton' | 'showSearchIcon' | 'showAudioIcon' | 'showVideoIcon' | 'enableMeetingUi' | 'showPoweredBy' | 'enableE2E'>> & Pick<AppConfig, 'attachmentIcon' | 'recordIcon' | 'QuickmessageIcon' | 'emojIcon' | 'stickerIcon' | 'sendIcon' | 'deliveredIcon' | 'sentIcon' | 'readIcon' | 'callIcon' | 'VideoCallIcon'>;

package/dist/e2e/index.d.ts

@@ -0,0 +1,28 @@
+/**
+ * E2E encryption for the React SDK.
+ * Layer 1: PSALMS arithmetic cipher
+ * Layer 2: RSA-OAEP via Web Crypto API
+ *
+ * Key pair is generated once per session and stored in memory.
+ * The public key is shared with the backend/other participants via the
+ * X-E2E-Public-Key header on the first message send.
+ */
+export interface E2EKeys {
+    publicKey: CryptoKey;
+    privateKey: CryptoKey;
+    /** Exported SPKI public key as base64 — safe to share */
+    publicKeyB64: string;
+}
+/** Generate a fresh RSA-OAEP 2048-bit key pair */
+export declare function generateE2EKeyPair(): Promise<E2EKeys>;
+/** Import a base64 SPKI public key for encrypting to a recipient */
+export declare function importPublicKey(b64: string): Promise<CryptoKey>;
+/**
+ * Encrypt plaintext: PSALMS → RSA-OAEP
+ * Returns a compact JSON string safe to send as message content.
+ */
+export declare function e2eEncrypt(plaintext: string, sessionKey: string, recipientPublicKey: CryptoKey): Promise<string>;
+/**
+ * Decrypt: RSA-OAEP → PSALMS
+ */
+export declare function e2eDecrypt(encryptedB64: string, sessionKey: string, privateKey: CryptoKey): Promise<string>;

package/dist/e2e/psalms.d.ts

@@ -0,0 +1,10 @@
+/**
+ * PSALMS CIPHER — browser-compatible port
+ * Arithmetic cipher: add → subtract → divide (encrypt), reversed on decrypt.
+ * Uses Web Crypto API for IV generation.
+ */
+export declare function psalmsEncrypt(plaintext: string, key: string): {
+    cipher: string;
+    iv: string;
+};
+export declare function psalmsDecrypt(cipher: string, iv: string, key: string): string;