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

package/dist/index.d.mts

@@ -238,12 +238,44 @@ type Peer = Omit<Peer$1, 'id'> & {
 type Room = {
     id: RoomId;
     peers: Peer[];
-    config: RoomConfig;
+    config: RoomOptions;
 };
 type FishjamConfig = {
     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;
@@ -285,7 +317,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?: RoomConfig): Promise<Room>;
+    createRoom(config?: RoomOptions): Promise<Room>;
     /**
      * Delete an existing room. All peers connected to this room will be disconnected and removed.
      */
@@ -316,10 +348,10 @@ declare class FishjamClient {
      */
     refreshPeerToken(roomId: RoomId, peerId: PeerId): Promise<string>;
     /**
-     * Creates a broadcast viewer token for the given room.
-     * @returns a broadcast viewer token
+     * Creates a livestream viewer token for the given room.
+     * @returns a livestream viewer token
      */
-    createBroadcastViewerToken(roomId: RoomId): Promise<ViewerToken>;
+    createLivestreamViewerToken(roomId: RoomId): Promise<ViewerToken>;
 }
 
 declare class FishjamBaseException extends Error {
@@ -345,4 +377,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, ServiceUnavailableException, UnauthorizedException, UnknownException, type ViewerToken };
+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 };

package/dist/index.d.ts

@@ -238,12 +238,44 @@ type Peer = Omit<Peer$1, 'id'> & {
 type Room = {
     id: RoomId;
     peers: Peer[];
-    config: RoomConfig;
+    config: RoomOptions;
 };
 type FishjamConfig = {
     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;
@@ -285,7 +317,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?: RoomConfig): Promise<Room>;
+    createRoom(config?: RoomOptions): Promise<Room>;
     /**
      * Delete an existing room. All peers connected to this room will be disconnected and removed.
      */
@@ -316,10 +348,10 @@ declare class FishjamClient {
      */
     refreshPeerToken(roomId: RoomId, peerId: PeerId): Promise<string>;
     /**
-     * Creates a broadcast viewer token for the given room.
-     * @returns a broadcast viewer token
+     * Creates a livestream viewer token for the given room.
+     * @returns a livestream viewer token
      */
-    createBroadcastViewerToken(roomId: RoomId): Promise<ViewerToken>;
+    createLivestreamViewerToken(roomId: RoomId): Promise<ViewerToken>;
 }
 
 declare class FishjamBaseException extends Error {
@@ -345,4 +377,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, ServiceUnavailableException, UnauthorizedException, UnknownException, type ViewerToken };
+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 };

package/dist/index.js

@@ -10806,7 +10806,7 @@ var require_dist = __commonJS({
       RoomApiAxiosParamCreator: () => RoomApiAxiosParamCreator,
       RoomApiFactory: () => RoomApiFactory,
       RoomApiFp: () => RoomApiFp,
-      RoomConfigRoomTypeEnum: () => RoomConfigRoomTypeEnum2,
+      RoomConfigRoomTypeEnum: () => RoomConfigRoomTypeEnum3,
       RoomConfigVideoCodecEnum: () => RoomConfigVideoCodecEnum2,
       SipApi: () => SipApi,
       SipApiAxiosParamCreator: () => SipApiAxiosParamCreator,
@@ -14084,7 +14084,7 @@ var require_dist = __commonJS({
       Connected: "connected",
       Disconnected: "disconnected"
     };
-    var RoomConfigRoomTypeEnum2 = {
+    var RoomConfigRoomTypeEnum3 = {
       FullFeature: "full_feature",
       AudioOnly: "audio_only",
       Broadcaster: "broadcaster"
@@ -18710,7 +18710,8 @@ var FishjamClient = class {
    */
   async createRoom(config = {}) {
     try {
-      const response = await this.roomApi.createRoom(config);
+      const parsedRoomType = config.roomType == "livestream" ? import_fishjam_openapi.RoomConfigRoomTypeEnum.Broadcaster : config.roomType;
+      const response = await this.roomApi.createRoom({ ...config, roomType: parsedRoomType });
       const {
         data: {
           data: {
@@ -18797,10 +18798,10 @@ var FishjamClient = class {
     }
   }
   /**
-   * Creates a broadcast viewer token for the given room.
-   * @returns a broadcast viewer token
+   * Creates a livestream viewer token for the given room.
+   * @returns a livestream viewer token
    */
-  async createBroadcastViewerToken(roomId) {
+  async createLivestreamViewerToken(roomId) {
     try {
       const tokenResponse = await this.viewerApi.generateToken(roomId);
       return tokenResponse.data;

package/dist/index.mjs

@@ -10781,7 +10781,7 @@ var require_dist = __commonJS({
       RoomApiAxiosParamCreator: () => RoomApiAxiosParamCreator,
       RoomApiFactory: () => RoomApiFactory,
       RoomApiFp: () => RoomApiFp,
-      RoomConfigRoomTypeEnum: () => RoomConfigRoomTypeEnum2,
+      RoomConfigRoomTypeEnum: () => RoomConfigRoomTypeEnum3,
       RoomConfigVideoCodecEnum: () => RoomConfigVideoCodecEnum2,
       SipApi: () => SipApi,
       SipApiAxiosParamCreator: () => SipApiAxiosParamCreator,
@@ -14059,7 +14059,7 @@ var require_dist = __commonJS({
       Connected: "connected",
       Disconnected: "disconnected"
     };
-    var RoomConfigRoomTypeEnum2 = {
+    var RoomConfigRoomTypeEnum3 = {
       FullFeature: "full_feature",
       AudioOnly: "audio_only",
       Broadcaster: "broadcaster"
@@ -15995,7 +15995,8 @@ var FishjamClient = class {
    */
   async createRoom(config = {}) {
     try {
-      const response = await this.roomApi.createRoom(config);
+      const parsedRoomType = config.roomType == "livestream" ? import_fishjam_openapi.RoomConfigRoomTypeEnum.Broadcaster : config.roomType;
+      const response = await this.roomApi.createRoom({ ...config, roomType: parsedRoomType });
       const {
         data: {
           data: {
@@ -16082,10 +16083,10 @@ var FishjamClient = class {
     }
   }
   /**
-   * Creates a broadcast viewer token for the given room.
-   * @returns a broadcast viewer token
+   * Creates a livestream viewer token for the given room.
+   * @returns a livestream viewer token
    */
-  async createBroadcastViewerToken(roomId) {
+  async createLivestreamViewerToken(roomId) {
     try {
       const tokenResponse = await this.viewerApi.generateToken(roomId);
       return tokenResponse.data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishjam-cloud/js-server-sdk",
-  "version": "0.17.0",
+  "version": "0.17.1",
   "description": "Fishjam server SDK for JavaScript",
   "homepage": "https://github.com/fishjam-cloud/js-server-sdk",
   "author": "Fishjam Team",
@@ -56,8 +56,8 @@
     "websocket": "^1.0.35"
   },
   "devDependencies": {
-    "@fishjam-cloud/fishjam-openapi": "0.17.0",
-    "@fishjam-cloud/fishjam-proto": "0.17.0",
+    "@fishjam-cloud/fishjam-openapi": "0.17.1",
+    "@fishjam-cloud/fishjam-proto": "0.17.1",
     "@openapitools/openapi-generator-cli": "^2.18.4",
     "@types/node": "^22.13.16",
     "@types/websocket": "^1.0.10",