@fishjam-cloud/js-server-sdk 0.17.1 → 0.20.0

package/dist/index.d.ts

@@ -89,19 +89,13 @@ interface RoomConfig {
      */
     'maxPeers'?: number | null;
     /**
-     * Duration (in seconds) after which the peer will be removed if it is disconnected. If not provided, this feature is disabled.
-     * @type {number}
-     * @memberof RoomConfig
-     */
-    'peerDisconnectedTimeout'?: number | null;
-    /**
-     * Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.
-     * @type {number}
+     * True if livestream viewers can omit specifying a token.
+     * @type {boolean}
      * @memberof RoomConfig
      */
-    'peerlessPurgeTimeout'?: number | null;
+    'public'?: boolean;
     /**
-     * The use-case of the room. If not provided, this defaults to full_feature.
+     * The use-case of the room. If not provided, this defaults to conference.
      * @type {string}
      * @memberof RoomConfig
      */
@@ -123,6 +117,8 @@ declare const RoomConfigRoomTypeEnum: {
     readonly FullFeature: "full_feature";
     readonly AudioOnly: "audio_only";
     readonly Broadcaster: "broadcaster";
+    readonly Livestream: "livestream";
+    readonly Conference: "conference";
 };
 type RoomConfigRoomTypeEnum = typeof RoomConfigRoomTypeEnum[keyof typeof RoomConfigRoomTypeEnum];
 declare const RoomConfigVideoCodecEnum: {
@@ -130,6 +126,19 @@ declare const RoomConfigVideoCodecEnum: {
     readonly Vp8: "vp8";
 };
 type RoomConfigVideoCodecEnum = typeof RoomConfigVideoCodecEnum[keyof typeof RoomConfigVideoCodecEnum];
+/**
+ * Token for authorizing broadcaster streamer connection
+ * @export
+ * @interface StreamerToken
+ */
+interface StreamerToken {
+    /**
+     *
+     * @type {string}
+     * @memberof StreamerToken
+     */
+    'token': string;
+}
 /**
  * Describes media track of a Peer or Component
  * @export
@@ -171,7 +180,7 @@ interface ViewerToken {
      * @type {string}
      * @memberof ViewerToken
      */
-    'token'?: string;
+    'token': string;
 }
 
 type EventMap = {
@@ -238,44 +247,13 @@ type Peer = Omit<Peer$1, 'id'> & {
 type Room = {
     id: RoomId;
     peers: Peer[];
-    config: RoomOptions;
+    config: RoomConfig;
 };
 type FishjamConfig = {
-    fishjamUrl: string;
+    fishjamId?: string;
+    fishjamUrl?: string;
     managementToken: string;
 };
-type RoomOptions = {
-    /**
-     * Maximum amount of peers allowed into the room
-     * @type {number}
-     */
-    maxPeers?: number | null;
-    /**
-     * Duration (in seconds) after which the peer will be removed if it is disconnected. If not provided, this feature is disabled.
-     * @type {number}
-     */
-    peerDisconnectedTimeout?: number | null;
-    /**
-     * Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.
-     * @type {number}
-     */
-    peerlessPurgeTimeout?: number | null;
-    /**
-     * The use-case of the room. If not provided, this defaults to full_feature.
-     * @type {string}
-     */
-    roomType?: RoomConfigRoomTypeEnum | 'livestream';
-    /**
-     * Enforces video codec for each peer in the room
-     * @type {string}
-     */
-    videoCodec?: RoomConfigVideoCodecEnum | null;
-    /**
-     * URL where Fishjam notifications will be sent
-     * @type {string}
-     */
-    webhookUrl?: string | null;
-};
 
 type ExpectedEvents = 'roomCreated' | 'roomDeleted' | 'roomCrashed' | 'peerAdded' | 'peerDeleted' | 'peerConnected' | 'peerDisconnected' | 'peerMetadataUpdated' | 'peerCrashed' | 'trackAdded' | 'trackRemoved' | 'trackMetadataUpdated';
 type ErrorEventHandler = (msg: Error) => void;
@@ -302,6 +280,7 @@ declare class FishjamWSNotifier extends FishjamWSNotifier_base {
 declare class FishjamClient {
     private readonly roomApi;
     private readonly viewerApi;
+    private readonly streamerApi;
     /**
      * Create new instance of Fishjam Client.
      *
@@ -317,7 +296,7 @@ declare class FishjamClient {
     /**
      * Create a new room. All peers connected to the same room will be able to send/receive streams to each other.
      */
-    createRoom(config?: RoomOptions): Promise<Room>;
+    createRoom(config?: RoomConfig): Promise<Room>;
     /**
      * Delete an existing room. All peers connected to this room will be disconnected and removed.
      */
@@ -352,8 +331,16 @@ declare class FishjamClient {
      * @returns a livestream viewer token
      */
     createLivestreamViewerToken(roomId: RoomId): Promise<ViewerToken>;
+    /**
+     * Creates a livestream streamer token for the given room.
+     * @returns a livestream streamer token
+     */
+    createLivestreamStreamerToken(roomId: RoomId): Promise<StreamerToken>;
 }
 
+declare class MissingFishjamIdException extends Error {
+    constructor();
+}
 declare class FishjamBaseException extends Error {
     statusCode: number;
     axiosCode?: string;
@@ -377,4 +364,4 @@ declare class ServiceUnavailableException extends FishjamBaseException {
 declare class UnknownException extends FishjamBaseException {
 }
 
-export { BadRequestException, type Brand, type CloseEventHandler, type ErrorEventHandler, type ExpectedEvents, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, type NotificationEvents, type Peer, type PeerId, PeerNotFoundException, type PeerOptions, PeerStatus, type Room, type RoomConfig, RoomConfigRoomTypeEnum, RoomConfigVideoCodecEnum, type RoomId, RoomNotFoundException, type RoomOptions, ServiceUnavailableException, UnauthorizedException, UnknownException, type ViewerToken };
+export { BadRequestException, type Brand, type CloseEventHandler, type ErrorEventHandler, type ExpectedEvents, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, MissingFishjamIdException, type NotificationEvents, type Peer, type PeerId, PeerNotFoundException, type PeerOptions, PeerStatus, type Room, type RoomConfig, RoomConfigRoomTypeEnum, RoomConfigVideoCodecEnum, type RoomId, RoomNotFoundException, ServiceUnavailableException, type StreamerToken, UnauthorizedException, UnknownException, type ViewerToken };