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

package/dist/index.d.mts

@@ -160,6 +160,19 @@ declare const TrackTypeEnum: {
     readonly Video: "video";
 };
 type TrackTypeEnum = typeof TrackTypeEnum[keyof typeof TrackTypeEnum];
+/**
+ * Token for authorizing broadcaster viewer connection
+ * @export
+ * @interface ViewerToken
+ */
+interface ViewerToken {
+    /**
+     *
+     * @type {string}
+     * @memberof ViewerToken
+     */
+    'token'?: string;
+}
 
 type EventMap = {
   [key: string]: (...args: any[]) => void
@@ -225,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;
@@ -256,6 +301,7 @@ declare class FishjamWSNotifier extends FishjamWSNotifier_base {
  */
 declare class FishjamClient {
     private readonly roomApi;
+    private readonly viewerApi;
     /**
      * Create new instance of Fishjam Client.
      *
@@ -271,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.
      */
@@ -301,6 +347,11 @@ declare class FishjamClient {
      * @returns refreshed peer token
      */
     refreshPeerToken(roomId: RoomId, peerId: PeerId): Promise<string>;
+    /**
+     * Creates a livestream viewer token for the given room.
+     * @returns a livestream viewer token
+     */
+    createLivestreamViewerToken(roomId: RoomId): Promise<ViewerToken>;
 }
 
 declare class FishjamBaseException extends Error {
@@ -326,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 };
+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

@@ -160,6 +160,19 @@ declare const TrackTypeEnum: {
     readonly Video: "video";
 };
 type TrackTypeEnum = typeof TrackTypeEnum[keyof typeof TrackTypeEnum];
+/**
+ * Token for authorizing broadcaster viewer connection
+ * @export
+ * @interface ViewerToken
+ */
+interface ViewerToken {
+    /**
+     *
+     * @type {string}
+     * @memberof ViewerToken
+     */
+    'token'?: string;
+}
 
 type EventMap = {
   [key: string]: (...args: any[]) => void
@@ -225,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;
@@ -256,6 +301,7 @@ declare class FishjamWSNotifier extends FishjamWSNotifier_base {
  */
 declare class FishjamClient {
     private readonly roomApi;
+    private readonly viewerApi;
     /**
      * Create new instance of Fishjam Client.
      *
@@ -271,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.
      */
@@ -301,6 +347,11 @@ declare class FishjamClient {
      * @returns refreshed peer token
      */
     refreshPeerToken(roomId: RoomId, peerId: PeerId): Promise<string>;
+    /**
+     * Creates a livestream viewer token for the given room.
+     * @returns a livestream viewer token
+     */
+    createLivestreamViewerToken(roomId: RoomId): Promise<ViewerToken>;
 }
 
 declare class FishjamBaseException extends Error {
@@ -326,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 };
+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,
@@ -10817,7 +10817,7 @@ var require_dist = __commonJS({
       UserApiAxiosParamCreator: () => UserApiAxiosParamCreator,
       UserApiFactory: () => UserApiFactory,
       UserApiFp: () => UserApiFp,
-      ViewerApi: () => ViewerApi,
+      ViewerApi: () => ViewerApi2,
       ViewerApiAxiosParamCreator: () => ViewerApiAxiosParamCreator,
       ViewerApiFactory: () => ViewerApiFactory,
       ViewerApiFp: () => ViewerApiFp
@@ -14084,7 +14084,7 @@ var require_dist = __commonJS({
       Connected: "connected",
       Disconnected: "disconnected"
     };
-    var RoomConfigRoomTypeEnum2 = {
+    var RoomConfigRoomTypeEnum3 = {
       FullFeature: "full_feature",
       AudioOnly: "audio_only",
       Broadcaster: "broadcaster"
@@ -15697,8 +15697,8 @@ var require_dist = __commonJS({
       return {
         /**
          * 
-         * @summary Generate token for single viewer
-         * @param {string} roomId Room ID
+         * @summary Generate single broadcaster access token
+         * @param {string} roomId A room id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -15728,8 +15728,8 @@ var require_dist = __commonJS({
       return {
         /**
          * 
-         * @summary Generate token for single viewer
-         * @param {string} roomId Room ID
+         * @summary Generate single broadcaster access token
+         * @param {string} roomId A room id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -15746,8 +15746,8 @@ var require_dist = __commonJS({
       return {
         /**
          * 
-         * @summary Generate token for single viewer
-         * @param {string} roomId Room ID
+         * @summary Generate single broadcaster access token
+         * @param {string} roomId A room id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -15756,11 +15756,11 @@ var require_dist = __commonJS({
         }
       };
     };
-    var ViewerApi = class extends BaseAPI {
+    var ViewerApi2 = class extends BaseAPI {
       /**
        * 
-       * @summary Generate token for single viewer
-       * @param {string} roomId Room ID
+       * @summary Generate single broadcaster access token
+       * @param {string} roomId A room id.
        * @param {*} [options] Override http request option.
        * @throws {RequiredError}
        * @memberof ViewerApi
@@ -18538,7 +18538,8 @@ __export(index_exports, {
   RoomNotFoundException: () => RoomNotFoundException,
   ServiceUnavailableException: () => ServiceUnavailableException,
   UnauthorizedException: () => UnauthorizedException,
-  UnknownException: () => UnknownException
+  UnknownException: () => UnknownException,
+  ViewerToken: () => import_fishjam_openapi2.ViewerToken
 });
 module.exports = __toCommonJS(index_exports);
 var import_fishjam_openapi2 = __toESM(require_dist());
@@ -18683,6 +18684,7 @@ var mapException = (error, entity) => {
 // src/client.ts
 var FishjamClient = class {
   roomApi;
+  viewerApi;
   /**
    * Create new instance of Fishjam Client.
    *
@@ -18701,13 +18703,15 @@ var FishjamClient = class {
       }
     });
     this.roomApi = new import_fishjam_openapi.RoomApi(void 0, config.fishjamUrl, client2);
+    this.viewerApi = new import_fishjam_openapi.ViewerApi(void 0, config.fishjamUrl, client2);
   }
   /**
    * Create a new room. All peers connected to the same room will be able to send/receive streams to each other.
    */
   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: {
@@ -18793,6 +18797,18 @@ var FishjamClient = class {
       throw mapException(error, "peer");
     }
   }
+  /**
+   * Creates a livestream viewer token for the given room.
+   * @returns a livestream viewer token
+   */
+  async createLivestreamViewerToken(roomId) {
+    try {
+      const tokenResponse = await this.viewerApi.generateToken(roomId);
+      return tokenResponse.data;
+    } catch (error) {
+      throw mapException(error);
+    }
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -18811,7 +18827,8 @@ var FishjamClient = class {
   RoomNotFoundException,
   ServiceUnavailableException,
   UnauthorizedException,
-  UnknownException
+  UnknownException,
+  ViewerToken
 });
 /*! Bundled license information:
 

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,
@@ -10792,7 +10792,7 @@ var require_dist = __commonJS({
       UserApiAxiosParamCreator: () => UserApiAxiosParamCreator,
       UserApiFactory: () => UserApiFactory,
       UserApiFp: () => UserApiFp,
-      ViewerApi: () => ViewerApi,
+      ViewerApi: () => ViewerApi2,
       ViewerApiAxiosParamCreator: () => ViewerApiAxiosParamCreator,
       ViewerApiFactory: () => ViewerApiFactory,
       ViewerApiFp: () => ViewerApiFp
@@ -14059,7 +14059,7 @@ var require_dist = __commonJS({
       Connected: "connected",
       Disconnected: "disconnected"
     };
-    var RoomConfigRoomTypeEnum2 = {
+    var RoomConfigRoomTypeEnum3 = {
       FullFeature: "full_feature",
       AudioOnly: "audio_only",
       Broadcaster: "broadcaster"
@@ -15672,8 +15672,8 @@ var require_dist = __commonJS({
       return {
         /**
          * 
-         * @summary Generate token for single viewer
-         * @param {string} roomId Room ID
+         * @summary Generate single broadcaster access token
+         * @param {string} roomId A room id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -15703,8 +15703,8 @@ var require_dist = __commonJS({
       return {
         /**
          * 
-         * @summary Generate token for single viewer
-         * @param {string} roomId Room ID
+         * @summary Generate single broadcaster access token
+         * @param {string} roomId A room id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -15721,8 +15721,8 @@ var require_dist = __commonJS({
       return {
         /**
          * 
-         * @summary Generate token for single viewer
-         * @param {string} roomId Room ID
+         * @summary Generate single broadcaster access token
+         * @param {string} roomId A room id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -15731,11 +15731,11 @@ var require_dist = __commonJS({
         }
       };
     };
-    var ViewerApi = class extends BaseAPI {
+    var ViewerApi2 = class extends BaseAPI {
       /**
        * 
-       * @summary Generate token for single viewer
-       * @param {string} roomId Room ID
+       * @summary Generate single broadcaster access token
+       * @param {string} roomId A room id.
        * @param {*} [options] Override http request option.
        * @throws {RequiredError}
        * @memberof ViewerApi
@@ -15969,6 +15969,7 @@ var mapException = (error, entity) => {
 // src/client.ts
 var FishjamClient = class {
   roomApi;
+  viewerApi;
   /**
    * Create new instance of Fishjam Client.
    *
@@ -15987,13 +15988,15 @@ var FishjamClient = class {
       }
     });
     this.roomApi = new import_fishjam_openapi.RoomApi(void 0, config.fishjamUrl, client2);
+    this.viewerApi = new import_fishjam_openapi.ViewerApi(void 0, config.fishjamUrl, client2);
   }
   /**
    * Create a new room. All peers connected to the same room will be able to send/receive streams to each other.
    */
   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: {
@@ -16079,12 +16082,25 @@ var FishjamClient = class {
       throw mapException(error, "peer");
     }
   }
+  /**
+   * Creates a livestream viewer token for the given room.
+   * @returns a livestream viewer token
+   */
+  async createLivestreamViewerToken(roomId) {
+    try {
+      const tokenResponse = await this.viewerApi.generateToken(roomId);
+      return tokenResponse.data;
+    } catch (error) {
+      throw mapException(error);
+    }
+  }
 };
 var export_PeerOptions = import_fishjam_openapi2.PeerOptions;
 var export_PeerStatus = import_fishjam_openapi2.PeerStatus;
 var export_RoomConfig = import_fishjam_openapi2.RoomConfig;
 var export_RoomConfigRoomTypeEnum = import_fishjam_openapi2.RoomConfigRoomTypeEnum;
 var export_RoomConfigVideoCodecEnum = import_fishjam_openapi2.RoomConfigVideoCodecEnum;
+var export_ViewerToken = import_fishjam_openapi2.ViewerToken;
 export {
   BadRequestException,
   FishjamBaseException,
@@ -16101,7 +16117,8 @@ export {
   RoomNotFoundException,
   ServiceUnavailableException,
   UnauthorizedException,
-  UnknownException
+  UnknownException,
+  export_ViewerToken as ViewerToken
 };
 /*! Bundled license information:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishjam-cloud/js-server-sdk",
-  "version": "0.15.1",
+  "version": "0.17.1",
   "description": "Fishjam server SDK for JavaScript",
   "homepage": "https://github.com/fishjam-cloud/js-server-sdk",
   "author": "Fishjam Team",
@@ -56,12 +56,12 @@
     "websocket": "^1.0.35"
   },
   "devDependencies": {
-    "@fishjam-cloud/fishjam-openapi": "0.15.1",
-    "@fishjam-cloud/fishjam-proto": "0.15.1",
-    "@openapitools/openapi-generator-cli": "^2.16.3",
-    "@types/node": "^22.13.5",
+    "@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",
-    "tsup": "^8.3.6",
+    "tsup": "^8.4.0",
     "typed-emitter": "^2.1.0"
   }
 }