@appsocom/react-native 0.0.0-stage → 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Appsotech Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# @appsocom/react-native
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+React Native client for [Appsocom Live](https://live.appsocom.com) video calls on iOS and Android: join rooms, camera and mic, video grid and controls, built on `react-native-webrtc`. It talks the same room protocol as the web and Flutter clients, so everyone can be in the same call.
+
+```bash
+npm install @appsocom/react-native react-native-webrtc
+```
+
+```tsx
+import { VideoConference, requestMediaPermissions } from "@appsocom/react-native";
+
+await requestMediaPermissions(); // Android runtime permissions
+<VideoConference url="https://api.appsocom.dev" token={token} onLeft={() => navigation.goBack()} />
+```
+
+The same components and hooks exist as in `@appsocom/react`. Long-press a tile for teacher controls.
+
+Setup:
+
+- **iOS 13+:** add `NSCameraUsageDescription` and `NSMicrophoneUsageDescription` to `Info.plist`, and the `audio` background mode to keep calls going in the background.
+- **Android:** `CAMERA`, `RECORD_AUDIO`, `MODIFY_AUDIO_SETTINGS`, `INTERNET` and `ACCESS_NETWORK_STATE`, with `minSdkVersion` 24.
+
+Guide: [UI kits](https://docs.appsocom.dev/ui-kits)
+
+Docs: [docs.appsocom.dev](https://docs.appsocom.dev) · License: MIT

package/dist/core/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./room.js";
+export * from "./session.js";

package/dist/core/index.js

@@ -0,0 +1,5 @@
+// Platform-neutral core: the room + SFU session, using whatever WebRTC
+// implementation you pass in. No react-native imports.
+export * from "./room.js";
+export * from "./session.js";
+//# sourceMappingURL=index.js.map

package/dist/core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,uDAAuD;AACvD,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC"}

package/dist/core/room.d.ts

@@ -0,0 +1,186 @@
+/**
+ * A Room for React Native (and anything else with standard WebRTC objects but
+ * no DOM). Same room protocol, events and method names as the web Room in
+ * @appsocom/client, so the @appsocom/react hooks work with both.
+ *
+ * Not available here (web only): screen sharing, background blur, noise
+ * suppression (use the OS voice processing), end-to-end encryption.
+ */
+import { Emitter } from "@appsocom/client/emitter";
+import { type ChatMessage, type ConnectionQuality, type Device, type JoinClaims, type Participant, type ParticipantState, type Permissions, type RecordingStatus, type RoomState, type TrackKind, type TranscriptSegment, type VideoQuality, type DataSaverInput, type DataSaverMode, type DataSaverSettings, type DataUsage } from "@appsocom/protocol";
+import { type WebRTCImpl } from "./session.js";
+export declare const TOKEN_HEADER = "X-SfuKit-Token";
+export interface NativeJoinOptions {
+    /** Where the kit's Worker routes live, e.g. "https://video.example.com". */
+    url: string;
+    /** Join token from your backend. */
+    token: string;
+    /** Start with the mic on. Default true. */
+    audio?: boolean;
+    /** Start with the camera on. Default true. */
+    video?: boolean;
+    /** "user" (front, default) or "environment" (back) camera. */
+    facingMode?: "user" | "environment";
+    /** Send the camera in three sizes so each viewer gets what it needs. Default true. */
+    simulcast?: boolean;
+    /** Reconnect after network drops. Default true. */
+    reconnect?: boolean;
+    /** Give up reconnecting after this long, in ms. Default 120000. */
+    reconnectTimeoutMs?: number;
+    iceServers?: RTCIceServer[];
+    /** Default 15000. Paused while you're in a waiting room. */
+    joinTimeoutMs?: number;
+    /** Receive others' tracks automatically. Default true. `{ video: false }`: only what you setSubscribed(). */
+    autoSubscribe?: boolean | {
+        audio?: boolean;
+        video?: boolean;
+    };
+    /** Called when you're put in the waiting room. */
+    onWaiting?: () => void;
+    /**
+     * Audio-first fallback: on a very bad connection stop all camera video both
+     * ways and keep audio; video comes back by itself. Default true.
+     */
+    audioFallback?: boolean;
+    /** Data saver: "low", "minimal", "audio" or custom settings. Default: the token's, else "off". */
+    dataSaver?: DataSaverInput;
+    /** WebRTC implementation. React Native: set for you by @appsocom/react-native. */
+    webrtc?: WebRTCImpl;
+    /** Override fetch / WebSocket (tests). */
+    fetch?: typeof fetch;
+    WebSocket?: typeof WebSocket;
+}
+export type ConnectionState = "connecting" | "connected" | "reconnecting" | "disconnected";
+export type NativeRoomEvents = {
+    "participant-joined": (participant: Participant) => void;
+    "participant-updated": (participant: Participant) => void;
+    "participant-left": (participant: Participant) => void;
+    track: (participant: Participant, kind: TrackKind, track: MediaStreamTrack) => void;
+    "track-removed": (participant: Participant, kind: TrackKind) => void;
+    "local-track": (kind: "video" | "screenVideo", track: MediaStreamTrack | null) => void;
+    "local-state": (state: ParticipantState) => void;
+    permissions: (permissions: Permissions, previous: Permissions) => void;
+    self: (self: Participant) => void;
+    role: (role: string, previous: string) => void;
+    muted: (devices: Device[], by: Participant | undefined) => void;
+    chat: (message: ChatMessage) => void;
+    "chat-deleted": (id: string) => void;
+    hands: (raised: Participant[]) => void;
+    waiting: () => void;
+    "group-changed": (group: string | null) => void;
+    "waiting-list": (waiting: Participant[]) => void;
+    "room-state": (state: RoomState) => void;
+    recording: (recording: RecordingStatus | null) => void;
+    message: (data: unknown, from: Participant | undefined) => void;
+    connection: (state: ConnectionState) => void;
+    "media-connection": (state: RTCPeerConnectionState) => void;
+    "connection-quality": (participantId: string, quality: ConnectionQuality) => void;
+    "active-speakers": (participantIds: string[]) => void;
+    "video-quality": (participant: Participant, quality: VideoQuality) => void;
+    "video-paused": (participant: Participant | null, paused: boolean) => void;
+    "audio-fallback": (active: boolean) => void;
+    "data-saver": (mode: DataSaverMode | "custom", settings: DataSaverSettings) => void;
+    "data-usage": (usage: DataUsage) => void;
+    transcript: (segment: TranscriptSegment) => void;
+    error: (error: Error) => void;
+    left: (reason: string) => void;
+};
+/** Join a room from React Native. Resolves once you're in. */
+export declare function joinNativeRoom(options: NativeJoinOptions): Promise<NativeRoom>;
+export declare class NativeRoom extends Emitter<NativeRoomEvents> {
+    #private;
+    readonly roomId: string;
+    readonly userId: string;
+    role: string;
+    permissions: Permissions;
+    self: Participant | null;
+    connectionState: ConnectionState;
+    roomState: RoomState;
+    waiting: Participant[];
+    chat: ChatMessage[];
+    recording: RecordingStatus | null;
+    /** @internal use joinNativeRoom() */
+    constructor(options: NativeJoinOptions);
+    get participants(): Participant[];
+    get localState(): ParticipantState;
+    get canPublish(): boolean;
+    get metadata(): Record<string, unknown> | undefined;
+    get raisedHands(): Participant[];
+    get agents(): Participant[];
+    get activeSpeakers(): string[];
+    /** Audio only by choice: setAudioOnly(true) or the "audio" data saver. See also audioFallback. */
+    get audioOnly(): boolean;
+    /** True while your connection has fallen back to audio only. */
+    get audioFallback(): boolean;
+    get dataSaver(): {
+        mode: DataSaverMode | "custom";
+        settings: DataSaverSettings;
+    };
+    /** Media data used in this call so far, current rates and MB per hour. */
+    get dataUsage(): DataUsage;
+    getConnectionQuality(participantId: string): ConnectionQuality | undefined;
+    getTrack(participantId: string, kind: TrackKind): MediaStreamTrack | undefined;
+    /** Your camera preview (null while off). Screen sharing isn't available on React Native. */
+    getLocalTrack(kind: "video" | "screenVideo"): MediaStreamTrack | null;
+    toggleMic(): void;
+    setMic(on: boolean): void;
+    toggleCamera(): void;
+    setCamera(on: boolean): void;
+    /** Flip between the front and back camera. */
+    switchCamera(): void;
+    /** Pick a specific mic/camera by device. */
+    setMicDevice(device: MediaDeviceInfo): void;
+    setCameraDevice(device: MediaDeviceInfo): void;
+    setCustomState(custom: Record<string, unknown>): void;
+    setPermissions(userId: string, permissions: Partial<Omit<Permissions, "moderate">>): void;
+    mute(userId: string, devices?: Device[], options?: {
+        lock?: boolean;
+    }): void;
+    muteAll(devices?: Device[], options?: {
+        lock?: boolean;
+    }): void;
+    stopScreenShare(userId: string): void;
+    remove(userId: string, options?: {
+        ban?: boolean;
+    }): void;
+    raiseHand(): void;
+    lowerHand(userId?: string): void;
+    lowerAllHands(): void;
+    sendChat(text: string, options?: {
+        to?: string;
+        everywhere?: boolean;
+    }): void;
+    deleteChat(id: string): void;
+    setChatEnabled(enabled: boolean): void;
+    setSpotlight(userIds: string[]): void;
+    setWaitingRoom(on: boolean): void;
+    lockRoom(locked?: boolean): void;
+    admit(userId: string): void;
+    deny(userId: string): void;
+    startRecording(options?: {
+        video?: boolean;
+    }): void;
+    stopRecording(): void;
+    sendToAgent(agentId: string, text: string): void;
+    /** App message to everyone else (room.on("message") on their side). */
+    send(data: unknown): void;
+    updateToken(token: string): void;
+    setSubscribed(participantId: string, kinds: TrackKind | TrackKind[], on: boolean): void;
+    isSubscribed(participantId: string, kind: TrackKind): boolean;
+    /** "high" | "medium" | "low" | "off" video from one participant. */
+    setVideoQuality(participantId: string, quality: VideoQuality): void;
+    /** Stop everyone's camera video (and your own camera); screen shares still come through. */
+    setAudioOnly(on: boolean): void;
+    /**
+     * Data saver for costly or weak mobile data: "off", "low", "minimal",
+     * "audio", or custom settings like `{ base: "low", activeSpeakerVideo: 2 }`.
+     */
+    setDataSaver(input: DataSaverInput): void;
+    /** Turn the audio-first fallback on or off; off while active brings video back now. */
+    setAudioFallback(enabled: boolean): void;
+    leave(reason?: string): void;
+    /** @internal */
+    _start(): Promise<void>;
+}
+/** Read (not verify) the claims in a join token. Works without atob/TextDecoder. */
+export declare function decodeClaims(token: string): JoinClaims;