@axonkit/client-sdk-js 0.1.1 → 0.2.0

package/dist/events.d.ts

@@ -11,11 +11,13 @@
 export declare enum RoomEvent {
     /** Successfully connected to the room. */
     Connected = "connected",
+    /** The signal channel to the server has been established (join accepted). */
+    SignalConnected = "signalConnected",
     /**
      * Disconnected from the room. This may be triggered by the server, by an
      * explicit call to {@link Room.disconnect}, or because of a network failure.
      *
-     * args: `(reason?: DisconnectReason)`
+     * args: `(reason?: {@link DisconnectReason})`
      */
     Disconnected = "disconnected",
     /** The SDK is attempting to reconnect to the room after a connection interruption. */
@@ -25,7 +27,7 @@ export declare enum RoomEvent {
     /**
      * Whenever the connection state of the room changes.
      *
-     * args: `(state: RoomState)`
+     * args: `(state: {@link ConnectionState})`
      */
     ConnectionStateChanged = "connectionStateChanged",
     /**
@@ -46,109 +48,116 @@ export declare enum RoomEvent {
      * args: `(error: Error)`
      */
     MediaDevicesError = "mediaDevicesError",
+    /**
+     * The active device for a kind has been switched via
+     * {@link Room.switchActiveDevice}.
+     *
+     * args: `(kind: MediaDeviceKind, deviceId: string)`
+     */
+    ActiveDeviceChanged = "activeDeviceChanged",
     /**
      * A remote participant has joined the room.
      *
-     * args: `(participant: RemoteParticipant)`
+     * args: `(participant: {@link RemoteParticipant})`
      */
-    ParticipantJoined = "participantJoined",
+    ParticipantConnected = "participantConnected",
     /**
      * A remote participant has left the room.
      *
-     * args: `(participant: RemoteParticipant, reason?: string)`
+     * args: `(participant: {@link RemoteParticipant}, reason?: {@link DisconnectReason})`
      */
-    ParticipantLeft = "participantLeft",
+    ParticipantDisconnected = "participantDisconnected",
     /**
      * A remote participant's metadata or attributes have been updated.
      *
-     * args: `(participant: RemoteParticipant)`
+     * args: `(participant: {@link RemoteParticipant})`
      */
     ParticipantUpdated = "participantUpdated",
     /**
      * Participant metadata has changed.
      *
-     * args: `(prevMetadata: string | undefined, participant: Participant)`
+     * args: `(prevMetadata: string | undefined, participant: {@link Participant})`
      */
     ParticipantMetadataChanged = "participantMetadataChanged",
     /**
      * Participant's display name has changed.
      *
-     * args: `(name: string, participant: Participant)`
+     * args: `(name: string, participant: {@link Participant})`
      */
     ParticipantNameChanged = "participantNameChanged",
     /**
      * Participant attributes have changed.
      *
-     * args: `(changedAttributes: Record<string, string>, participant: Participant)`
+     * args: `(changedAttributes: Record<string, string>, participant: {@link Participant})`
      */
     ParticipantAttributesChanged = "participantAttributesChanged",
     /**
      * A remote participant has published a new track.
      *
-     * args: `(publication: RemoteTrackPublication, participant: RemoteParticipant)`
+     * args: `(publication: {@link RemoteTrackPublication}, participant: {@link RemoteParticipant})`
      */
     TrackPublished = "trackPublished",
     /**
      * A remote participant has unpublished a track.
      *
-     * args: `(publication: RemoteTrackPublication, participant: RemoteParticipant)`
+     * args: `(publication: {@link RemoteTrackPublication}, participant: {@link RemoteParticipant})`
      */
     TrackUnpublished = "trackUnpublished",
     /**
      * A remote participant has published a new data track.
      *
-     * args: `(dataTrack: DataTrackInfo, participant: RemoteParticipant)`
+     * args: `(dataTrack: {@link DataTrackInfo}, participant: {@link RemoteParticipant})`
      */
     DataTrackPublished = "dataTrackPublished",
     /**
      * A remote participant has unpublished a data track.
      *
-     * args: `(dataTrackSid: string, participant: RemoteParticipant)`
+     * args: `(dataTrackSid: string, participant: {@link RemoteParticipant})`
      */
     DataTrackUnpublished = "dataTrackUnpublished",
     /**
      * Subscribed to a new track from a remote participant. This is the event
      * where you would typically attach the track to a media element.
      *
-     * args: `(track: RemoteTrack, publication: RemoteTrackPublication, participant: RemoteParticipant)`
+     * args: `(track: {@link RemoteTrack}, publication: {@link RemoteTrackPublication}, participant: {@link RemoteParticipant})`
      */
     TrackSubscribed = "trackSubscribed",
     /**
      * Could not subscribe to a track.
      *
-     * args: `(trackSid: string, participant: RemoteParticipant)`
+     * args: `(trackSid: string, participant: {@link RemoteParticipant})`
      */
     TrackSubscriptionFailed = "trackSubscriptionFailed",
     /**
      * Unsubscribed from a remote track. The track should be detached from any
      * media elements at this point.
      *
-     * args: `(track: RemoteTrack, publication: RemoteTrackPublication, participant: RemoteParticipant)`
+     * args: `(track: {@link RemoteTrack}, publication: {@link RemoteTrackPublication}, participant: {@link RemoteParticipant})`
      */
     TrackUnsubscribed = "trackUnsubscribed",
     /**
      * A track has been muted. Fires on both remote and local participants.
      *
-     * args: `(publication: TrackPublication, participant: Participant)`
+     * args: `(publication: {@link TrackPublication}, participant: {@link Participant})`
      */
     TrackMuted = "trackMuted",
     /**
      * A track has been unmuted. Fires on both remote and local participants.
      *
-     * args: `(publication: TrackPublication, participant: Participant)`
+     * args: `(publication: {@link TrackPublication}, participant: {@link Participant})`
      */
     TrackUnmuted = "trackUnmuted",
     /**
      * A local track was published successfully.
      *
-     * args: `(publication: LocalTrackPublication, participant: LocalParticipant)`
+     * args: `(publication: {@link LocalTrackPublication}, participant: {@link LocalParticipant})`
      */
     LocalTrackPublished = "localTrackPublished",
     /**
      * A local track was unpublished. When a user stops sharing their screen
      * by pressing "End" on the browser UI, this event will also fire.
      *
-     * args: `(publication: LocalTrackPublication, participant: LocalParticipant)`
+     * args: `(publication: {@link LocalTrackPublication}, participant: {@link LocalParticipant})`
      */
     LocalTrackUnpublished = "localTrackUnpublished",
     /**
@@ -161,33 +170,49 @@ export declare enum RoomEvent {
      * Active speakers changed. List of speakers ordered by audio level.
      * Includes the local participant.
      *
-     * args: `(speakers: ActiveSpeaker[])`
+     * args: `(speakers: {@link Participant}[])`
      */
     ActiveSpeakersChanged = "activeSpeakersChanged",
-    /** Room-level metadata has been updated by the server. */
-    RoomUpdated = "roomUpdated",
+    /**
+     * Room-level metadata has been updated by the server.
+     *
+     * args: `(metadata: string | undefined)`
+     */
+    RoomMetadataChanged = "roomMetadataChanged",
     /**
      * Data received from a remote participant via a DataChannel.
      *
-     * args: `(data: ArrayBuffer, participant?: RemoteParticipant)`
+     * args: `(payload: Uint8Array, participant?: {@link RemoteParticipant})`
      */
     DataReceived = "dataReceived",
     /**
      * The connection quality of a participant has changed.
      *
-     * args: `(quality: ConnectionQuality, participant: Participant)`
+     * args: `(quality: {@link ConnectionQuality}, participant: {@link Participant})`
      */
     ConnectionQualityChanged = "connectionQualityChanged",
+    /**
+     * The room's recording status has changed.
+     *
+     * args: `(recording: boolean)`
+     */
+    RecordingStatusChanged = "recordingStatusChanged",
+    /**
+     * A participant's permissions have changed.
+     *
+     * args: `(prevPermissions: ParticipantPermission | undefined, participant: {@link Participant})`
+     */
+    ParticipantPermissionsChanged = "participantPermissionsChanged",
     /**
      * Audio playback status has changed. When `canPlaybackAudio` becomes
      * `false`, the application should display UI to prompt user interaction,
      * then call {@link Room.startAudio}.
      */
-    AudioPlaybackStatusChanged = "audioPlaybackStatusChanged",
+    AudioPlaybackStatusChanged = "audioPlaybackChanged",
     /**
      * A message has been received or sent (chat, whiteboard, document, etc.).
      *
-     * args: `(message: Message, participant?: Participant)`
+     * args: `(message: {@link Message}, participant?: {@link Participant})`
      */
     ChatMessage = "chatMessage",
     /**
@@ -219,25 +244,25 @@ export declare enum RoomEvent {
      * Video playback status has changed. Similar to
      * {@link RoomEvent.AudioPlaybackStatusChanged} but for video.
      */
-    VideoPlaybackStatusChanged = "videoPlaybackStatusChanged",
+    VideoPlaybackStatusChanged = "videoPlaybackChanged",
     /**
      * The stream state of a remote track has changed (e.g. the server
      * paused or resumed forwarding media).  This is distinct from
      * {@link RoomEvent.TrackMuted} which indicates the publisher's intent.
      *
-     * args: `(publication: RemoteTrackPublication, streamState: StreamState, participant: RemoteParticipant)`
+     * args: `(publication: {@link RemoteTrackPublication}, streamState: {@link StreamState}, participant: {@link RemoteParticipant})`
      */
     TrackStreamStateChanged = "trackStreamStateChanged",
     /**
      * A new group (breakout room) has been created.
      *
-     * args: `(group: GroupInfo)`
+     * args: `(group: {@link GroupInfo})`
      */
     GroupCreated = "groupCreated",
     /**
      * A group's metadata or participant count has changed.
      *
-     * args: `(group: GroupInfo)`
+     * args: `(group: {@link GroupInfo})`
      */
     GroupUpdated = "groupUpdated",
     /**
@@ -250,13 +275,13 @@ export declare enum RoomEvent {
     /**
      * A participant has joined a group.
      *
-     * args: `(groupId: string, participant: RemoteParticipant | LocalParticipant)`
+     * args: `(groupId: string, participant: {@link RemoteParticipant} | {@link LocalParticipant})`
      */
     GroupParticipantJoined = "groupParticipantJoined",
     /**
      * A participant has left a group (returned to the main room).
      *
-     * args: `(groupId: string, participant: RemoteParticipant | LocalParticipant)`
+     * args: `(groupId: string, participant: {@link RemoteParticipant} | {@link LocalParticipant})`
      */
     GroupParticipantLeft = "groupParticipantLeft"
 }
@@ -274,13 +299,13 @@ export declare enum ParticipantEvent {
     /**
      * The participant has published a new track.
      *
-     * args: `(publication: TrackPublication)`
+     * args: `(publication: {@link TrackPublication})`
      */
     TrackPublished = "trackPublished",
     /**
      * The participant has unpublished a track.
      *
-     * args: `(publication: TrackPublication)`
+     * args: `(publication: {@link TrackPublication})`
      */
     TrackUnpublished = "trackUnpublished",
     /** One of the participant's tracks has been muted. */
@@ -290,25 +315,25 @@ export declare enum ParticipantEvent {
     /**
      * Subscribed to a new track from this participant.
      *
-     * args: `(track: RemoteTrack, publication: RemoteTrackPublication)`
+     * args: `(track: {@link RemoteTrack}, publication: {@link RemoteTrackPublication})`
      */
     TrackSubscribed = "trackSubscribed",
     /**
      * Unsubscribed from a track of this participant.
      *
-     * args: `(track: RemoteTrack, publication: RemoteTrackPublication)`
+     * args: `(track: {@link RemoteTrack}, publication: {@link RemoteTrackPublication})`
      */
     TrackUnsubscribed = "trackUnsubscribed",
     /**
      * A local track was published by this participant.
      *
-     * args: `(publication: LocalTrackPublication)`
+     * args: `(publication: {@link LocalTrackPublication})`
      */
     LocalTrackPublished = "localTrackPublished",
     /**
      * A local track was unpublished by this participant.
      *
-     * args: `(publication: LocalTrackPublication)`
+     * args: `(publication: {@link LocalTrackPublication})`
      */
     LocalTrackUnpublished = "localTrackUnpublished",
     /** The participant's metadata has changed. */
@@ -318,7 +343,7 @@ export declare enum ParticipantEvent {
     /**
      * The participant's attributes have changed.
      *
-     * args: `(changedAttributes: Record<string, string>, participant: Participant)`
+     * args: `(changedAttributes: Record<string, string>, participant: {@link Participant})`
      */
     AttributesChanged = "attributesChanged",
     /** The participant's speaking status has changed. */
@@ -330,7 +355,7 @@ export declare enum ParticipantEvent {
     /**
      * The stream state of a remote track changed (server paused/resumed forwarding).
      *
-     * args: `(publication: RemoteTrackPublication, streamState: StreamState)`
+     * args: `(publication: {@link RemoteTrackPublication}, streamState: {@link StreamState})`
      */
     TrackStreamStateChanged = "trackStreamStateChanged",
     /** Data received from this participant. */
@@ -338,7 +363,7 @@ export declare enum ParticipantEvent {
     /**
      * A chat message from this participant.
      *
-     * args: `(message: ChatMessage)`
+     * args: `(message: {@link ChatMessage})`
      */
     ChatMessage = "chatMessage"
 }
@@ -394,13 +419,13 @@ export declare enum TrackEvent {
     /**
      * The visibility of the video element changed (adaptive stream).
      *
-     * args: `(visible: boolean, track: RemoteVideoTrack)`
+     * args: `(visible: boolean, track: {@link RemoteVideoTrack})`
      */
     VisibilityChanged = "visibilityChanged",
     /**
      * The dimensions of the video element changed (adaptive stream).
      *
-     * args: `(dimensions: { width: number; height: number }, track: RemoteVideoTrack)`
+     * args: `(dimensions: { width: number; height: number }, track: {@link RemoteVideoTrack})`
      */
     VideoDimensionsChanged = "videoDimensionsChanged",
     /**
@@ -419,7 +444,7 @@ export declare enum TrackEvent {
      * The stream state of this track changed (server paused/resumed forwarding).
      * Only emitted on remote tracks.
      *
-     * args: `(track: Track, streamState: StreamState)`
+     * args: `(track: {@link Track}, streamState: {@link StreamState})`
      */
     StreamStateChanged = "streamStateChanged",
     /**

package/dist/index.d.ts

@@ -20,7 +20,7 @@ export type { TrackProcessor, ProcessorOptions } from './track/processor/types';
 export type { RoomOptions, RoomConnectOptions, InternalRoomConnectOptions, AdaptiveStreamSettings, } from './room/options';
 export type { TrackPublishDefaults, TrackPublishOptions, DataPublishOptions, VideoCaptureOptions, AudioCaptureOptions, ScreenShareCaptureOptions, VideoEncoding, VideoResolution, VideoPresetOptions, AudioPreset, AudioOutputOptions, PublishCodecOptions, CreateLocalTracksOptions, ScalabilityMode, VideoCodec, BackupVideoCodec, AudioCodec, } from './track/options';
 export { VideoPreset, BackupCodecPolicy, AudioPresets, VideoPresets, VideoPresets43, ScreenSharePresets, audioCodecs, videoCodecs, isBackupVideoCodec, defaultVideoCaptureOptions, defaultAudioCaptureOptions, defaultVideoEncoding, defaultScreenShareEncoding, videoSimulcastPresets, } from './track/options';
-export { RoomState, TrackKind, TrackSource, VideoQuality, DisconnectReason, ParticipantState, ParticipantKind, ConnectionQuality, StreamState, AudioTrackFeature, } from './protocol/types';
+export { ConnectionState, TrackKind, TrackSource, VideoQuality, DisconnectReason, ParticipantState, ParticipantKind, ConnectionQuality, StreamState, AudioTrackFeature, } from './protocol/types';
 export type { RoomInfo, ServerInfo, ParticipantInfo, ParticipantPermission, ParticipantTrackPermission, TrackInfo, DataTrackInfo, ActiveSpeaker, GroupInfo, JoinRequest, JoinResponse, SyncState, } from './protocol/types';
 export { AxonError, ConnectionError, TimeoutError, ErrorCode } from './protocol/errors';
 export { RpcError, MAX_RPC_PAYLOAD_BYTES } from './rpc';
@@ -35,7 +35,7 @@ export type { BrowserDetails, AudioAnalyserOptions } from './utils/browser';
 export { MediaDeviceFailure } from './utils/deviceFailure';
 export type { DeviceFailureKind } from './utils/deviceFailure';
 export { DefaultReconnectPolicy } from './room/DefaultReconnectPolicy';
-export type { ReconnectContext } from './room/DefaultReconnectPolicy';
+export type { ReconnectContext, ReconnectPolicy } from './room/DefaultReconnectPolicy';
 export { ConnectionCheck, CheckStatus } from './connectionHelper/ConnectionCheck';
 export type { CheckInfo } from './connectionHelper/ConnectionCheck';
 export { VERSION, PROTOCOL_VERSION } from './version';

package/dist/participant/LocalParticipant.d.ts

@@ -39,9 +39,9 @@ export declare class LocalParticipant extends Participant<LocalTrackPublication>
      * Unpublish a track from the room.
      * @param track - The track or MediaStreamTrack to unpublish.
      * @param stopOnUnpublish - Whether to stop the track after unpublishing.
-     *   Defaults to `false`.
+     *   Defaults to {@link RoomOptions.stopLocalTrackOnUnpublish} (`true`).
      */
-    unpublishTrack(track: LocalTrack | MediaStreamTrack): Promise<LocalTrackPublication | undefined>;
+    unpublishTrack(track: LocalTrack | MediaStreamTrack, stopOnUnpublish?: boolean): Promise<LocalTrackPublication | undefined>;
     publishData(data: Uint8Array, options?: DataPublishOptions): Promise<void>;
     /**
      * Sets and updates the metadata of the local participant.
@@ -101,10 +101,6 @@ export declare class LocalParticipant extends Participant<LocalTrackPublication>
      * Delete a single message by ID.
      */
     deleteMessage(id: string): Promise<void>;
-    /**
-     * Delete all messages of a given type.
-     */
-    deleteMessagesByType(type: string): Promise<void>;
     /**
      * Update a key in the room's shared state.
      */

package/dist/participant/Participant.d.ts

@@ -74,7 +74,7 @@ export type ParticipantEvents<TPublication extends TrackPublication = TrackPubli
     [ParticipantEvent.ConnectionQualityChanged]: (quality: ConnectionQuality) => void;
     [ParticipantEvent.PermissionsChanged]: (prevPermissions?: ParticipantPermission) => void;
     [ParticipantEvent.TrackStreamStateChanged]: (publication: TPublication, streamState: StreamState) => void;
-    [ParticipantEvent.DataReceived]: (data: ArrayBuffer) => void;
+    [ParticipantEvent.DataReceived]: (payload: Uint8Array) => void;
     [ParticipantEvent.ChatMessage]: (message: Message) => void;
 };
 export declare abstract class Participant<TPublication extends TrackPublication = TrackPublication> extends TypedEmitter<ParticipantEvents<TPublication>> {

package/dist/protocol/types.d.ts

@@ -1,5 +1,5 @@
 import type { types as mediasoupTypes } from 'mediasoup-client';
-export declare enum RoomState {
+export declare enum ConnectionState {
     Disconnected = "disconnected",
     Connecting = "connecting",
     Connected = "connected",
@@ -421,7 +421,7 @@ export interface ParticipantJoinedNotification {
 }
 export interface ParticipantLeftNotification {
     participantSid: string;
-    reason?: string;
+    reason?: DisconnectReason;
 }
 export interface ParticipantUpdatedNotification {
     participant: ParticipantInfo;

package/dist/room/DefaultReconnectPolicy.d.ts

@@ -5,6 +5,22 @@ export interface ReconnectContext {
     retryCount: number;
     elapsedMs: number;
 }
+/**
+ * Custom reconnection strategy. Provide an implementation via
+ * {@link RoomOptions.reconnectPolicy} to control retry behaviour after a
+ * connection interruption.
+ */
+export interface ReconnectPolicy {
+    /**
+     * Returns the number of milliseconds to wait before the next reconnect
+     * attempt, or `null` if the policy says to stop trying.
+     */
+    nextRetryDelayInMs(context: ReconnectContext): number | null;
+    /**
+     * Optional hook invoked after a successful (re)connection.
+     */
+    reset?(): void;
+}
 /**
  * Default reconnect policy with exponential back-off and jitter.
  *
@@ -14,7 +30,7 @@ export interface ReconnectContext {
  * const delay = policy.nextRetryDelayInMs({ retryCount: 1, elapsedMs: 0 });
  * ```
  */
-export declare class DefaultReconnectPolicy {
+export declare class DefaultReconnectPolicy implements ReconnectPolicy {
     private readonly maxRetries;
     private readonly baseDelay;
     private readonly maxDelay;

package/dist/room/options.d.ts

@@ -1,4 +1,5 @@
 import type { VideoCaptureOptions, AudioCaptureOptions, TrackPublishDefaults } from '../track/options';
+import type { ReconnectPolicy } from './DefaultReconnectPolicy';
 /**
  * Configuration for the adaptive stream feature. When enabled the SDK
  * automatically manages video subscription quality based on element
@@ -34,6 +35,20 @@ export interface RoomOptions {
      * subscribers on the server.
      */
     dynacast?: boolean;
+    /**
+     * Custom reconnection policy controlling retry delays after a
+     * connection interruption. See {@link DefaultReconnectPolicy}.
+     *
+     * @defaultValue `new DefaultReconnectPolicy()`
+     */
+    reconnectPolicy?: ReconnectPolicy;
+    /**
+     * Automatically disconnect from the room when the page is being
+     * unloaded or frozen (`beforeunload` / `pagehide` / `freeze`).
+     *
+     * @defaultValue `true`
+     */
+    disconnectOnPageLeave?: boolean;
     /**
      * Default capture options used when creating camera tracks.
      */
@@ -47,9 +62,20 @@ export interface RoomOptions {
      * per-track.
      */
     publishDefaults?: TrackPublishDefaults;
+    /**
+     * Automatically stop local tracks when they are unpublished, including
+     * via {@link LocalParticipant.setCameraEnabled} et al. with `false`.
+     * Pass `false` explicitly to {@link LocalParticipant.unpublishTrack} to
+     * keep a track alive across unpublish/republish cycles.
+     *
+     * @defaultValue `true`
+     */
+    stopLocalTrackOnUnpublish?: boolean;
     /**
      * Room name sent in the JoinRequest for server-side routing and room
-     * creation. Must match the `room` claim in the JWT token (if present).
+     * creation. Optional when the JWT token carries a `room` claim — the
+     * server falls back to it. Required for anonymous joins (no token).
+     * When both are present they must match.
      */
     roomName?: string;
     /**

package/dist/track/options.d.ts

@@ -371,11 +371,6 @@ export interface TrackPublishDefaults {
      * @see {@link PublishCodecOptions}
      */
     codecOptions?: PublishCodecOptions;
-    /**
-     * should local track be stopped when they are unpublished. defaults to false
-     * set this to true if you would prefer to clean up unpublished local track automatically.
-     */
-    stopTrackOnUnpublish?: boolean;
 }
 /**
  * Options when publishing tracks. Extends {@link TrackPublishDefaults} with

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axonkit/client-sdk-js",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "AxonKit JS/TS Client SDK based on mediasoup-client",
   "main": "dist/axonkit-client.umd.js",
   "module": "dist/axonkit-client.esm.js",