@fishjam-cloud/js-server-sdk 0.22.0 → 0.22.1

package/dist/index.d.mts

@@ -643,6 +643,10 @@ type FishjamConfig = {
 };
 type ErrorEventHandler = (msg: Event) => void;
 type CloseEventHandler = (code: number, reason: string) => void;
+type AgentCallbacks = {
+    onError?: ErrorEventHandler;
+    onClose?: CloseEventHandler;
+};
 
 type WithRoomId<T> = {
     [P in keyof T]: NonNullable<T[P]> extends {
@@ -713,7 +717,9 @@ type IncomingTrackData = Omit<NonNullable<AgentResponse_TrackData>, 'peerId'> &
 type OutgoingTrackData = Omit<NonNullable<AgentRequest_TrackData>, 'peerId'> & {
     peerId: PeerId;
 };
-type AgentTrack = Track;
+type AgentTrack = Omit<Track, 'id'> & {
+    id: TrackId;
+};
 type TrackType = 'audio' | 'video';
 type AudioCodecParameters = {
     encoding: 'opus' | 'pcm16';
@@ -731,12 +737,21 @@ type AgentEvents = {
 declare const FishjamAgent_base: new () => TypedEventEmitter<AgentEvents>;
 declare class FishjamAgent extends FishjamAgent_base {
     private readonly client;
-    constructor(config: FishjamConfig, agentToken: string, onError: ErrorEventHandler, onClose: CloseEventHandler);
+    constructor(config: FishjamConfig, agentToken: string, callbacks?: AgentCallbacks);
     /**
      * Creates an outgoing audio track for the agent
      * @returns a new audio track
      */
     createTrack(codecParameters: AudioCodecParameters, metadata?: object): AgentTrack;
+    /**
+     * Interrupt track indentified by `trackId`.
+     *
+     * Any audio that has been sent by the agent, but not played
+     * by Fishjam will be cleared and be prevented from playing.
+     *
+     * Audio sent after the interrupt will be played normally.
+     */
+    interruptTrack(trackId: TrackId): void;
     /**
      * Deletes an outgoing audio track for the agent
      */
@@ -745,6 +760,7 @@ declare class FishjamAgent extends FishjamAgent_base {
      * Send audio data for the given track
      */
     sendData(trackId: TrackId, data: Uint8Array): void;
+    disconnect(): void;
     private dispatchNotification;
     private setupConnection;
     private isExpectedEvent;
@@ -787,14 +803,14 @@ declare class FishjamClient {
     /**
      * Create a new peer assigned to a room.
      */
-    createPeer(roomId: RoomId, options?: PeerOptions): Promise<{
+    createPeer(roomId: RoomId, options?: PeerOptionsWebRTC): Promise<{
         peer: Peer;
         peerToken: string;
     }>;
     /**
      * Create a new agent assigned to a room.
      */
-    createAgent(roomId: RoomId, options: PeerOptions | undefined, onError: ErrorEventHandler, onClose: CloseEventHandler): Promise<{
+    createAgent(roomId: RoomId, options?: PeerOptionsAgent, callbacks?: AgentCallbacks): Promise<{
         agent: FishjamAgent;
         peer: Peer;
     }>;
@@ -860,4 +876,4 @@ declare class ServiceUnavailableException extends FishjamBaseException {
 declare class UnknownException extends FishjamBaseException {
 }
 
-export { type AgentEvents, type AgentTrack, type AudioCodecParameters, BadRequestException, type Brand, type CloseEventHandler, type ErrorEventHandler, type ExpectedAgentEvents, type ExpectedEvents, FishjamAgent, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, type IncomingTrackData, MissingFishjamIdException, type NotificationEvents, type OutgoingTrackData, type Peer, type PeerAdded, type PeerConnected, type PeerCrashed, type PeerDeleted, type PeerDisconnected, type PeerId, type PeerMetadataUpdated, PeerNotFoundException, type PeerOptions, PeerStatus, type Room, type RoomConfig, RoomConfigRoomTypeEnum, RoomConfigVideoCodecEnum, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, ServerMessage, ServiceUnavailableException, type StreamConnected, type StreamDisconnected, type StreamerToken, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, type ViewerConnected, type ViewerDisconnected, type ViewerToken };
+export { type AgentCallbacks, type AgentEvents, type AgentTrack, type AudioCodecParameters, BadRequestException, type Brand, type CloseEventHandler, type ErrorEventHandler, type ExpectedAgentEvents, type ExpectedEvents, FishjamAgent, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, type IncomingTrackData, MissingFishjamIdException, type NotificationEvents, type OutgoingTrackData, type Peer, type PeerAdded, type PeerConnected, type PeerCrashed, type PeerDeleted, type PeerDisconnected, type PeerId, type PeerMetadataUpdated, PeerNotFoundException, type PeerOptions, PeerStatus, type Room, type RoomConfig, RoomConfigRoomTypeEnum, RoomConfigVideoCodecEnum, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, ServerMessage, ServiceUnavailableException, type StreamConnected, type StreamDisconnected, type StreamerToken, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, type ViewerConnected, type ViewerDisconnected, type ViewerToken };

package/dist/index.d.ts

@@ -643,6 +643,10 @@ type FishjamConfig = {
 };
 type ErrorEventHandler = (msg: Event) => void;
 type CloseEventHandler = (code: number, reason: string) => void;
+type AgentCallbacks = {
+    onError?: ErrorEventHandler;
+    onClose?: CloseEventHandler;
+};
 
 type WithRoomId<T> = {
     [P in keyof T]: NonNullable<T[P]> extends {
@@ -713,7 +717,9 @@ type IncomingTrackData = Omit<NonNullable<AgentResponse_TrackData>, 'peerId'> &
 type OutgoingTrackData = Omit<NonNullable<AgentRequest_TrackData>, 'peerId'> & {
     peerId: PeerId;
 };
-type AgentTrack = Track;
+type AgentTrack = Omit<Track, 'id'> & {
+    id: TrackId;
+};
 type TrackType = 'audio' | 'video';
 type AudioCodecParameters = {
     encoding: 'opus' | 'pcm16';
@@ -731,12 +737,21 @@ type AgentEvents = {
 declare const FishjamAgent_base: new () => TypedEventEmitter<AgentEvents>;
 declare class FishjamAgent extends FishjamAgent_base {
     private readonly client;
-    constructor(config: FishjamConfig, agentToken: string, onError: ErrorEventHandler, onClose: CloseEventHandler);
+    constructor(config: FishjamConfig, agentToken: string, callbacks?: AgentCallbacks);
     /**
      * Creates an outgoing audio track for the agent
      * @returns a new audio track
      */
     createTrack(codecParameters: AudioCodecParameters, metadata?: object): AgentTrack;
+    /**
+     * Interrupt track indentified by `trackId`.
+     *
+     * Any audio that has been sent by the agent, but not played
+     * by Fishjam will be cleared and be prevented from playing.
+     *
+     * Audio sent after the interrupt will be played normally.
+     */
+    interruptTrack(trackId: TrackId): void;
     /**
      * Deletes an outgoing audio track for the agent
      */
@@ -745,6 +760,7 @@ declare class FishjamAgent extends FishjamAgent_base {
      * Send audio data for the given track
      */
     sendData(trackId: TrackId, data: Uint8Array): void;
+    disconnect(): void;
     private dispatchNotification;
     private setupConnection;
     private isExpectedEvent;
@@ -787,14 +803,14 @@ declare class FishjamClient {
     /**
      * Create a new peer assigned to a room.
      */
-    createPeer(roomId: RoomId, options?: PeerOptions): Promise<{
+    createPeer(roomId: RoomId, options?: PeerOptionsWebRTC): Promise<{
         peer: Peer;
         peerToken: string;
     }>;
     /**
      * Create a new agent assigned to a room.
      */
-    createAgent(roomId: RoomId, options: PeerOptions | undefined, onError: ErrorEventHandler, onClose: CloseEventHandler): Promise<{
+    createAgent(roomId: RoomId, options?: PeerOptionsAgent, callbacks?: AgentCallbacks): Promise<{
         agent: FishjamAgent;
         peer: Peer;
     }>;
@@ -860,4 +876,4 @@ declare class ServiceUnavailableException extends FishjamBaseException {
 declare class UnknownException extends FishjamBaseException {
 }
 
-export { type AgentEvents, type AgentTrack, type AudioCodecParameters, BadRequestException, type Brand, type CloseEventHandler, type ErrorEventHandler, type ExpectedAgentEvents, type ExpectedEvents, FishjamAgent, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, type IncomingTrackData, MissingFishjamIdException, type NotificationEvents, type OutgoingTrackData, type Peer, type PeerAdded, type PeerConnected, type PeerCrashed, type PeerDeleted, type PeerDisconnected, type PeerId, type PeerMetadataUpdated, PeerNotFoundException, type PeerOptions, PeerStatus, type Room, type RoomConfig, RoomConfigRoomTypeEnum, RoomConfigVideoCodecEnum, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, ServerMessage, ServiceUnavailableException, type StreamConnected, type StreamDisconnected, type StreamerToken, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, type ViewerConnected, type ViewerDisconnected, type ViewerToken };
+export { type AgentCallbacks, type AgentEvents, type AgentTrack, type AudioCodecParameters, BadRequestException, type Brand, type CloseEventHandler, type ErrorEventHandler, type ExpectedAgentEvents, type ExpectedEvents, FishjamAgent, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, type IncomingTrackData, MissingFishjamIdException, type NotificationEvents, type OutgoingTrackData, type Peer, type PeerAdded, type PeerConnected, type PeerCrashed, type PeerDeleted, type PeerDisconnected, type PeerId, type PeerMetadataUpdated, PeerNotFoundException, type PeerOptions, PeerStatus, type Room, type RoomConfig, RoomConfigRoomTypeEnum, RoomConfigVideoCodecEnum, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, ServerMessage, ServiceUnavailableException, type StreamConnected, type StreamDisconnected, type StreamerToken, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, type ViewerConnected, type ViewerDisconnected, type ViewerToken };

package/dist/index.js

@@ -19519,6 +19519,7 @@ var FishjamWSNotifier = class extends import_events.EventEmitter {
     const fishjamUrl = getFishjamUrl(config);
     const websocketUrl = `${httpToWebsocket(fishjamUrl)}/socket/server/websocket`;
     this.client = new WebSocket(websocketUrl);
+    this.client.binaryType = "arraybuffer";
     this.client.onerror = (message) => onError(message);
     this.client.onclose = (message) => onClose(message.code, message.reason);
     this.client.onmessage = (message) => this.dispatchNotification(message);
@@ -19526,7 +19527,8 @@ var FishjamWSNotifier = class extends import_events.EventEmitter {
   }
   dispatchNotification(message) {
     try {
-      const decodedMessage = import_fishjam_proto.ServerMessage.decode(message.data);
+      const data = new Uint8Array(message.data);
+      const decodedMessage = import_fishjam_proto.ServerMessage.decode(data);
       const [notification, msg] = Object.entries(decodedMessage).find(([_k, v]) => v);
       if (!this.isExpectedEvent(notification)) return;
       this.emit(notification, msg);
@@ -19554,14 +19556,14 @@ var import_fishjam_proto2 = __toESM(require_dist2());
 var expectedEventsList2 = ["trackData"];
 var FishjamAgent = class extends import_events2.EventEmitter {
   client;
-  constructor(config, agentToken, onError, onClose) {
+  constructor(config, agentToken, callbacks) {
     super();
     const fishjamUrl = getFishjamUrl(config);
     const websocketUrl = `${httpToWebsocket(fishjamUrl)}/socket/agent/websocket`;
     this.client = new WebSocket(websocketUrl);
     this.client.binaryType = "arraybuffer";
-    this.client.onerror = (message) => onError(message);
-    this.client.onclose = (message) => onClose(message.code, message.reason);
+    this.client.onclose = (message) => callbacks?.onClose?.(message.code, message.reason);
+    this.client.onerror = (message) => callbacks?.onError?.(message);
     this.client.onmessage = (message) => this.dispatchNotification(message);
     this.client.onopen = () => this.setupConnection(agentToken);
   }
@@ -19580,6 +19582,18 @@ var FishjamAgent = class extends import_events2.EventEmitter {
     this.client.send(addTrack);
     return track;
   }
+  /**
+   * Interrupt track indentified by `trackId`.
+   *
+   * Any audio that has been sent by the agent, but not played
+   * by Fishjam will be cleared and be prevented from playing.
+   *
+   * Audio sent after the interrupt will be played normally.
+   */
+  interruptTrack(trackId) {
+    const msg = import_fishjam_proto2.AgentRequest.encode({ interruptTrack: { trackId } }).finish();
+    this.client.send(msg);
+  }
   /**
    * Deletes an outgoing audio track for the agent
    */
@@ -19594,6 +19608,9 @@ var FishjamAgent = class extends import_events2.EventEmitter {
     const trackData = import_fishjam_proto2.AgentRequest.encode({ trackData: { trackId, data } }).finish();
     this.client.send(trackData);
   }
+  disconnect() {
+    this.client.close();
+  }
   dispatchNotification(message) {
     try {
       const data = new Uint8Array(message.data);
@@ -19738,7 +19755,7 @@ var FishjamClient = class {
   /**
    * Create a new agent assigned to a room.
    */
-  async createAgent(roomId, options = {}, onError, onClose) {
+  async createAgent(roomId, options = {}, callbacks) {
     try {
       const response = await this.roomApi.addPeer(roomId, {
         type: "agent",
@@ -19747,7 +19764,7 @@ var FishjamClient = class {
       const {
         data: { data }
       } = response;
-      const agent = new FishjamAgent(this.fishjamConfig, data.token, onError, onClose);
+      const agent = new FishjamAgent(this.fishjamConfig, data.token, callbacks);
       return { agent, peer: data.peer };
     } catch (error) {
       throw mapException(error);

package/dist/index.mjs

@@ -19494,6 +19494,7 @@ var FishjamWSNotifier = class extends EventEmitter {
     const fishjamUrl = getFishjamUrl(config);
     const websocketUrl = `${httpToWebsocket(fishjamUrl)}/socket/server/websocket`;
     this.client = new WebSocket(websocketUrl);
+    this.client.binaryType = "arraybuffer";
     this.client.onerror = (message) => onError(message);
     this.client.onclose = (message) => onClose(message.code, message.reason);
     this.client.onmessage = (message) => this.dispatchNotification(message);
@@ -19501,7 +19502,8 @@ var FishjamWSNotifier = class extends EventEmitter {
   }
   dispatchNotification(message) {
     try {
-      const decodedMessage = import_fishjam_proto.ServerMessage.decode(message.data);
+      const data = new Uint8Array(message.data);
+      const decodedMessage = import_fishjam_proto.ServerMessage.decode(data);
       const [notification, msg] = Object.entries(decodedMessage).find(([_k, v]) => v);
       if (!this.isExpectedEvent(notification)) return;
       this.emit(notification, msg);
@@ -19529,14 +19531,14 @@ import { v4 as uuid4 } from "uuid";
 var expectedEventsList2 = ["trackData"];
 var FishjamAgent = class extends EventEmitter2 {
   client;
-  constructor(config, agentToken, onError, onClose) {
+  constructor(config, agentToken, callbacks) {
     super();
     const fishjamUrl = getFishjamUrl(config);
     const websocketUrl = `${httpToWebsocket(fishjamUrl)}/socket/agent/websocket`;
     this.client = new WebSocket(websocketUrl);
     this.client.binaryType = "arraybuffer";
-    this.client.onerror = (message) => onError(message);
-    this.client.onclose = (message) => onClose(message.code, message.reason);
+    this.client.onclose = (message) => callbacks?.onClose?.(message.code, message.reason);
+    this.client.onerror = (message) => callbacks?.onError?.(message);
     this.client.onmessage = (message) => this.dispatchNotification(message);
     this.client.onopen = () => this.setupConnection(agentToken);
   }
@@ -19555,6 +19557,18 @@ var FishjamAgent = class extends EventEmitter2 {
     this.client.send(addTrack);
     return track;
   }
+  /**
+   * Interrupt track indentified by `trackId`.
+   *
+   * Any audio that has been sent by the agent, but not played
+   * by Fishjam will be cleared and be prevented from playing.
+   *
+   * Audio sent after the interrupt will be played normally.
+   */
+  interruptTrack(trackId) {
+    const msg = import_fishjam_proto2.AgentRequest.encode({ interruptTrack: { trackId } }).finish();
+    this.client.send(msg);
+  }
   /**
    * Deletes an outgoing audio track for the agent
    */
@@ -19569,6 +19583,9 @@ var FishjamAgent = class extends EventEmitter2 {
     const trackData = import_fishjam_proto2.AgentRequest.encode({ trackData: { trackId, data } }).finish();
     this.client.send(trackData);
   }
+  disconnect() {
+    this.client.close();
+  }
   dispatchNotification(message) {
     try {
       const data = new Uint8Array(message.data);
@@ -19713,7 +19730,7 @@ var FishjamClient = class {
   /**
    * Create a new agent assigned to a room.
    */
-  async createAgent(roomId, options = {}, onError, onClose) {
+  async createAgent(roomId, options = {}, callbacks) {
     try {
       const response = await this.roomApi.addPeer(roomId, {
         type: "agent",
@@ -19722,7 +19739,7 @@ var FishjamClient = class {
       const {
         data: { data }
       } = response;
-      const agent = new FishjamAgent(this.fishjamConfig, data.token, onError, onClose);
+      const agent = new FishjamAgent(this.fishjamConfig, data.token, callbacks);
       return { agent, peer: data.peer };
     } catch (error) {
       throw mapException(error);

package/package.json

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