@fishjam-cloud/js-server-sdk 0.28.0 → 0.28.1

package/dist/index.d.ts

@@ -12,13 +12,13 @@ interface AgentOutput {
      * @type {AudioFormat}
      * @memberof AgentOutput
      */
-    audioFormat?: AudioFormat;
+    'audioFormat'?: AudioFormat;
     /**
      *
      * @type {AudioSampleRate}
      * @memberof AgentOutput
      */
-    audioSampleRate?: AudioSampleRate;
+    'audioSampleRate'?: AudioSampleRate;
 }
 /**
  * The format of the output audio
@@ -28,7 +28,7 @@ interface AgentOutput {
 declare const AudioFormat: {
     readonly Pcm16: "pcm16";
 };
-type AudioFormat = (typeof AudioFormat)[keyof typeof AudioFormat];
+type AudioFormat = typeof AudioFormat[keyof typeof AudioFormat];
 /**
  * The sample rate of the output audio
  * @export
@@ -38,38 +38,44 @@ declare const AudioSampleRate: {
     readonly NUMBER_16000: 16000;
     readonly NUMBER_24000: 24000;
 };
-type AudioSampleRate = (typeof AudioSampleRate)[keyof typeof AudioSampleRate];
+type AudioSampleRate = typeof AudioSampleRate[keyof typeof AudioSampleRate];
 /**
- * Token for authorizing a MoQ relay connection
+ * Connection details for a MoQ relay client
  * @export
- * @interface MoqToken
+ * @interface MoqAccess
  */
-interface MoqToken {
+interface MoqAccess {
     /**
-     * JWT token for MoQ relay
+     * Relay connection URL with the JWT embedded as a `?jwt=` query parameter. Pass directly to a MoQ client SDK.
      * @type {string}
-     * @memberof MoqToken
+     * @memberof MoqAccess
      */
-    token: string;
+    'connection_url': string;
+    /**
+     * JWT authorizing the MoQ relay connection, also embedded in `connection_url`
+     * @type {string}
+     * @memberof MoqAccess
+     */
+    'token': string;
 }
 /**
- * MoQ token configuration
+ * MoQ access configuration
  * @export
- * @interface MoqTokenConfig
+ * @interface MoqAccessConfig
  */
-interface MoqTokenConfig {
+interface MoqAccessConfig {
     /**
      * Path under the root the token grants publish access to
      * @type {string}
-     * @memberof MoqTokenConfig
+     * @memberof MoqAccessConfig
      */
-    publishPath?: string | null;
+    'publishPath'?: string | null;
     /**
      * Path under the root the token grants subscribe access to
      * @type {string}
-     * @memberof MoqTokenConfig
+     * @memberof MoqAccessConfig
      */
-    subscribePath?: string | null;
+    'subscribePath'?: string | null;
 }
 /**
  * Describes peer status
@@ -82,43 +88,43 @@ interface Peer$1 {
      * @type {string}
      * @memberof Peer
      */
-    id: string;
+    'id': string;
     /**
      * Custom metadata set by the peer
      * @type {object}
      * @memberof Peer
      */
-    metadata: object | null;
+    'metadata': object | null;
     /**
      *
      * @type {PeerStatus}
      * @memberof Peer
      */
-    status: PeerStatus;
+    'status': PeerStatus;
     /**
      *
      * @type {SubscribeMode}
      * @memberof Peer
      */
-    subscribeMode: SubscribeMode;
+    'subscribeMode': SubscribeMode;
     /**
      *
      * @type {Subscriptions}
      * @memberof Peer
      */
-    subscriptions: Subscriptions;
+    'subscriptions': Subscriptions;
     /**
      * List of all peer\'s tracks
      * @type {Array<Track>}
      * @memberof Peer
      */
-    tracks: Array<Track$2>;
+    'tracks': Array<Track$2>;
     /**
      *
      * @type {PeerType}
      * @memberof Peer
      */
-    type: PeerType$1;
+    'type': PeerType$1;
 }
 /**
  * @type PeerOptions
@@ -137,13 +143,13 @@ interface PeerOptionsAgent {
      * @type {AgentOutput}
      * @memberof PeerOptionsAgent
      */
-    output?: AgentOutput;
+    'output'?: AgentOutput;
     /**
      *
      * @type {SubscribeMode}
      * @memberof PeerOptionsAgent
      */
-    subscribeMode?: SubscribeMode;
+    'subscribeMode'?: SubscribeMode;
 }
 /**
  * Options specific to the VAPI peer
@@ -156,19 +162,19 @@ interface PeerOptionsVapi {
      * @type {string}
      * @memberof PeerOptionsVapi
      */
-    apiKey: string;
+    'apiKey': string;
     /**
      * VAPI call ID
      * @type {string}
      * @memberof PeerOptionsVapi
      */
-    callId: string;
+    'callId': string;
     /**
      *
      * @type {SubscribeMode}
      * @memberof PeerOptionsVapi
      */
-    subscribeMode?: SubscribeMode;
+    'subscribeMode'?: SubscribeMode;
 }
 /**
  * Options specific to the WebRTC peer
@@ -181,7 +187,7 @@ interface PeerOptionsWebRTC {
      * @type {{ [key: string]: any; }}
      * @memberof PeerOptionsWebRTC
      */
-    metadata?: {
+    'metadata'?: {
         [key: string]: any;
     };
     /**
@@ -189,7 +195,7 @@ interface PeerOptionsWebRTC {
      * @type {SubscribeMode}
      * @memberof PeerOptionsWebRTC
      */
-    subscribeMode?: SubscribeMode;
+    'subscribeMode'?: SubscribeMode;
 }
 /**
  * Informs about the peer status
@@ -200,7 +206,7 @@ declare const PeerStatus: {
     readonly Connected: "connected";
     readonly Disconnected: "disconnected";
 };
-type PeerStatus = (typeof PeerStatus)[keyof typeof PeerStatus];
+type PeerStatus = typeof PeerStatus[keyof typeof PeerStatus];
 /**
  * Peer type
  * @export
@@ -211,7 +217,7 @@ declare const PeerType$1: {
     readonly Agent: "agent";
     readonly Vapi: "vapi";
 };
-type PeerType$1 = (typeof PeerType$1)[keyof typeof PeerType$1];
+type PeerType$1 = typeof PeerType$1[keyof typeof PeerType$1];
 /**
  * Room configuration
  * @export
@@ -223,37 +229,37 @@ interface RoomConfig {
      * @type {boolean}
      * @memberof RoomConfig
      */
-    batchWebhookNotifications?: boolean;
+    'batchWebhookNotifications'?: boolean;
     /**
      * Maximum amount of peers allowed into the room
      * @type {number}
      * @memberof RoomConfig
      */
-    maxPeers?: number | null;
+    'maxPeers'?: number | null;
     /**
      * True if livestream viewers can omit specifying a token.
      * @type {boolean}
      * @memberof RoomConfig
      */
-    public?: boolean;
+    'public'?: boolean;
     /**
      *
      * @type {RoomType}
      * @memberof RoomConfig
      */
-    roomType?: RoomType;
+    'roomType'?: RoomType;
     /**
      *
      * @type {VideoCodec}
      * @memberof RoomConfig
      */
-    videoCodec?: VideoCodec;
+    'videoCodec'?: VideoCodec;
     /**
      * URL where Fishjam notifications will be sent
      * @type {string}
      * @memberof RoomConfig
      */
-    webhookUrl?: string | null;
+    'webhookUrl'?: string | null;
 }
 /**
  * The use-case of the room. If not provided, this defaults to conference.
@@ -268,7 +274,7 @@ declare const RoomType: {
     readonly Conference: "conference";
     readonly AudioOnlyLivestream: "audio_only_livestream";
 };
-type RoomType = (typeof RoomType)[keyof typeof RoomType];
+type RoomType = typeof RoomType[keyof typeof RoomType];
 /**
  * Streamer authorization token
  * @export
@@ -280,7 +286,7 @@ interface StreamerToken {
      * @type {string}
      * @memberof StreamerToken
      */
-    token: string;
+    'token': string;
 }
 /**
  * Configuration of peer\'s subscribing policy
@@ -291,7 +297,7 @@ declare const SubscribeMode: {
     readonly Auto: "auto";
     readonly Manual: "manual";
 };
-type SubscribeMode = (typeof SubscribeMode)[keyof typeof SubscribeMode];
+type SubscribeMode = typeof SubscribeMode[keyof typeof SubscribeMode];
 /**
  * Describes peer\'s subscriptions in manual mode
  * @export
@@ -303,13 +309,13 @@ interface Subscriptions {
      * @type {Array<string>}
      * @memberof Subscriptions
      */
-    peers: Array<string>;
+    'peers': Array<string>;
     /**
      * List of track IDs this peer subscribes to
      * @type {Array<string>}
      * @memberof Subscriptions
      */
-    tracks: Array<string>;
+    'tracks': Array<string>;
 }
 /**
  * Media track of a Peer
@@ -322,19 +328,19 @@ interface Track$2 {
      * @type {string}
      * @memberof Track
      */
-    id?: string;
+    'id'?: string;
     /**
      * Metadata attached to the track by the peer
      * @type {object}
      * @memberof Track
      */
-    metadata?: object | null;
+    'metadata'?: object | null;
     /**
      *
      * @type {TrackType}
      * @memberof Track
      */
-    type?: TrackType$2;
+    'type'?: TrackType$2;
 }
 /**
  * Media type carried by the track
@@ -345,7 +351,7 @@ declare const TrackType$2: {
     readonly Audio: "audio";
     readonly Video: "video";
 };
-type TrackType$2 = (typeof TrackType$2)[keyof typeof TrackType$2];
+type TrackType$2 = typeof TrackType$2[keyof typeof TrackType$2];
 /**
  * Enforces video codec for each peer in the room
  * @export
@@ -355,7 +361,7 @@ declare const VideoCodec: {
     readonly H264: "h264";
     readonly Vp8: "vp8";
 };
-type VideoCodec = (typeof VideoCodec)[keyof typeof VideoCodec];
+type VideoCodec = typeof VideoCodec[keyof typeof VideoCodec];
 /**
  * Viewer authorization token
  * @export
@@ -367,7 +373,7 @@ interface ViewerToken {
      * @type {string}
      * @memberof ViewerToken
      */
-    token: string;
+    'token': string;
 }
 
 /** Defines types of tracks being published by peers and component */
@@ -1173,10 +1179,10 @@ declare class FishjamClient {
      */
     createLivestreamStreamerToken(roomId: RoomId): Promise<StreamerToken>;
     /**
-     * Creates a MoQ token.
-     * @returns a MoQ token
+     * Creates MoQ access.
+     * @returns connection details containing the relay URL with the JWT embedded as a `?jwt=` query parameter, and the token itself
      */
-    createMoqToken(config?: MoqTokenConfig): Promise<MoqToken>;
+    createMoqAccess(config?: MoqAccessConfig): Promise<MoqAccess>;
 }
 
 declare class MissingFishjamIdException extends Error {
@@ -1209,4 +1215,4 @@ declare class QuotaExceededException extends FishjamBaseException {
 declare class UnknownException extends FishjamBaseException {
 }
 
-export { type AgentCallbacks, type AgentEvents, type AgentTrack, type AudioCodecParameters, BadRequestException, type Brand, type ChannelAdded, type ChannelRemoved, type CloseEventHandler, type ErrorEventHandler, type ExpectedAgentEvents, type ExpectedEvents, FishjamAgent, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, type IgnoredEvents, type IncomingTrackData, type IncomingTrackImage, InvalidFishjamCredentialsException, MissingFishjamIdException, type MoqToken, type MoqTokenConfig, type NotificationEvents, type OutgoingTrackData, type Override, type Peer, type PeerAdded, type PeerConnected, type PeerCrashed, type PeerDeleted, type PeerDisconnected, type PeerId, type PeerMetadataUpdated, PeerNotFoundException, type PeerOptions, type PeerOptionsAgent, type PeerOptionsVapi, type PeerOptionsWebRTC, PeerStatus, type PeerType, QuotaExceededException, type Room, type RoomConfig, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, RoomType, ServerMessage, type ServerNotification, ServiceUnavailableException, type StreamerConnected, type StreamerDisconnected, type StreamerToken, type Track, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, VideoCodec, type ViewerConnected, type ViewerDisconnected, type ViewerToken, decodeServerNotifications };
+export { type AgentCallbacks, type AgentEvents, type AgentTrack, type AudioCodecParameters, BadRequestException, type Brand, type ChannelAdded, type ChannelRemoved, type CloseEventHandler, type ErrorEventHandler, type ExpectedAgentEvents, type ExpectedEvents, FishjamAgent, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, type IgnoredEvents, type IncomingTrackData, type IncomingTrackImage, InvalidFishjamCredentialsException, MissingFishjamIdException, type MoqAccess, type MoqAccessConfig, type NotificationEvents, type OutgoingTrackData, type Override, type Peer, type PeerAdded, type PeerConnected, type PeerCrashed, type PeerDeleted, type PeerDisconnected, type PeerId, type PeerMetadataUpdated, PeerNotFoundException, type PeerOptions, type PeerOptionsAgent, type PeerOptionsVapi, type PeerOptionsWebRTC, PeerStatus, type PeerType, QuotaExceededException, type Room, type RoomConfig, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, RoomType, ServerMessage, type ServerNotification, ServiceUnavailableException, type StreamerConnected, type StreamerDisconnected, type StreamerToken, type Track, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, VideoCodec, type ViewerConnected, type ViewerDisconnected, type ViewerToken, decodeServerNotifications };