@fishjam-cloud/js-server-sdk 0.23.0 → 0.25.0

package/dist/chunk-QK3SKSR4.mjs

@@ -0,0 +1,123 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// package.json
+var package_default = {
+  name: "@fishjam-cloud/js-server-sdk",
+  version: "0.25.0",
+  description: "Fishjam server SDK for JavaScript",
+  homepage: "https://github.com/fishjam-cloud/js-server-sdk",
+  author: "Fishjam Team",
+  repository: {
+    type: "git",
+    url: "https://github.com/fishjam-cloud/js-server-sdk.git"
+  },
+  bugs: {
+    url: "https://github.com/fishjam-cloud/js-server-sdk/issues"
+  },
+  license: "Apache-2.0",
+  keywords: [
+    "webrtc",
+    "fishjam",
+    "server",
+    "membrane"
+  ],
+  main: "./dist/index.js",
+  types: "./dist/index.d.ts",
+  files: [
+    "dist"
+  ],
+  exports: {
+    ".": "./dist/index.js",
+    "./gemini": "./dist/integrations/gemini.js"
+  },
+  scripts: {
+    build: "tsup --dts-resolve",
+    format: "prettier --write .",
+    "format:check": "prettier --check .",
+    typecheck: "tsc --noEmit",
+    lint: "eslint . --fix",
+    "lint:check": "eslint . "
+  },
+  tsup: {
+    entry: [
+      "src/index.ts",
+      "src/integrations/gemini.ts",
+      "src/proto.ts"
+    ],
+    noExternal: [
+      "fishjam-openapi",
+      "fishjam-proto"
+    ],
+    minify: false,
+    format: [
+      "cjs",
+      "esm"
+    ],
+    outDir: "dist"
+  },
+  dependencies: {
+    axios: "^1.7.9",
+    uuid: "^11.1.0"
+  },
+  peerDependencies: {
+    "@google/genai": "^1.0.0"
+  },
+  peerDependenciesMeta: {
+    "@google/genai": {
+      optional: true
+    }
+  },
+  devDependencies: {
+    "@fishjam-cloud/fishjam-openapi": "workspace:*",
+    "@fishjam-cloud/fishjam-proto": "workspace:*",
+    "@openapitools/openapi-generator-cli": "^2.18.4",
+    "@types/node": "^22.13.16",
+    "@types/websocket": "^1.0.10",
+    eslint: "^9.33.0",
+    prettier: "^3.6.2",
+    tsup: "^8.4.0",
+    "typed-emitter": "^2.1.0"
+  },
+  "lint-staged": {
+    "*.{js,ts,tsx,mjs,cjs}": [
+      "eslint --fix --config packages/js-server-sdk/eslint.config.mjs"
+    ]
+  }
+};
+
+export {
+  __require,
+  __commonJS,
+  __toESM,
+  package_default
+};

package/dist/index.d.mts

@@ -1,6 +1,44 @@
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 import axios from 'axios';
 
+/**
+ * Output audio options
+ * @export
+ * @interface AgentOutput
+ */
+interface AgentOutput {
+    /**
+     *
+     * @type {AudioFormat}
+     * @memberof AgentOutput
+     */
+    'audioFormat'?: AudioFormat;
+    /**
+     *
+     * @type {AudioSampleRate}
+     * @memberof AgentOutput
+     */
+    'audioSampleRate'?: AudioSampleRate;
+}
+/**
+ * The format of the output audio
+ * @export
+ * @enum {string}
+ */
+declare const AudioFormat: {
+    readonly Pcm16: "pcm16";
+};
+type AudioFormat = typeof AudioFormat[keyof typeof AudioFormat];
+/**
+ * The sample rate of the output audio
+ * @export
+ * @enum {string}
+ */
+declare const AudioSampleRate: {
+    readonly NUMBER_16000: 16000;
+    readonly NUMBER_24000: 24000;
+};
+type AudioSampleRate = typeof AudioSampleRate[keyof typeof AudioSampleRate];
 /**
  * Describes peer status
  * @export
@@ -32,11 +70,11 @@ interface Peer$1 {
      */
     'subscribeMode': SubscribeMode;
     /**
-     * Describes peer\'s subscriptions in manual mode
-     * @type {Array<string>}
+     *
+     * @type {Subscriptions}
      * @memberof Peer
      */
-    'subscriptions': Array<string>;
+    'subscriptions': Subscriptions;
     /**
      * List of all peer\'s tracks
      * @type {Array<Track>}
@@ -64,62 +102,23 @@ type PeerOptions = PeerOptionsAgent | PeerOptionsWebRTC;
 interface PeerOptionsAgent {
     /**
      *
-     * @type {PeerOptionsAgentOutput}
+     * @type {AgentOutput}
      * @memberof PeerOptionsAgent
      */
-    'output'?: PeerOptionsAgentOutput;
+    'output'?: AgentOutput;
     /**
-     * Configuration of peer\'s subscribing policy
-     * @type {string}
+     *
+     * @type {SubscribeMode}
      * @memberof PeerOptionsAgent
      */
-    'subscribeMode'?: PeerOptionsAgentSubscribeModeEnum;
-}
-declare const PeerOptionsAgentSubscribeModeEnum: {
-    readonly Auto: "auto";
-    readonly Manual: "manual";
-};
-type PeerOptionsAgentSubscribeModeEnum = typeof PeerOptionsAgentSubscribeModeEnum[keyof typeof PeerOptionsAgentSubscribeModeEnum];
-/**
- * Output audio options
- * @export
- * @interface PeerOptionsAgentOutput
- */
-interface PeerOptionsAgentOutput {
-    /**
-     * The format of the output audio
-     * @type {string}
-     * @memberof PeerOptionsAgentOutput
-     */
-    'audioFormat'?: PeerOptionsAgentOutputAudioFormatEnum;
-    /**
-     * The sample rate of the output audio
-     * @type {number}
-     * @memberof PeerOptionsAgentOutput
-     */
-    'audioSampleRate'?: PeerOptionsAgentOutputAudioSampleRateEnum;
+    'subscribeMode'?: SubscribeMode;
 }
-declare const PeerOptionsAgentOutputAudioFormatEnum: {
-    readonly Pcm16: "pcm16";
-};
-type PeerOptionsAgentOutputAudioFormatEnum = typeof PeerOptionsAgentOutputAudioFormatEnum[keyof typeof PeerOptionsAgentOutputAudioFormatEnum];
-declare const PeerOptionsAgentOutputAudioSampleRateEnum: {
-    readonly NUMBER_16000: 16000;
-    readonly NUMBER_24000: 24000;
-};
-type PeerOptionsAgentOutputAudioSampleRateEnum = typeof PeerOptionsAgentOutputAudioSampleRateEnum[keyof typeof PeerOptionsAgentOutputAudioSampleRateEnum];
 /**
  * Options specific to the WebRTC peer
  * @export
  * @interface PeerOptionsWebRTC
  */
 interface PeerOptionsWebRTC {
-    /**
-     * Enables the peer to use simulcast
-     * @type {boolean}
-     * @memberof PeerOptionsWebRTC
-     */
-    'enableSimulcast'?: boolean;
     /**
      * Custom peer metadata
      * @type {{ [key: string]: any; }}
@@ -129,17 +128,12 @@ interface PeerOptionsWebRTC {
         [key: string]: any;
     };
     /**
-     * Configuration of peer\'s subscribing policy
-     * @type {string}
+     *
+     * @type {SubscribeMode}
      * @memberof PeerOptionsWebRTC
      */
-    'subscribeMode'?: PeerOptionsWebRTCSubscribeModeEnum;
+    'subscribeMode'?: SubscribeMode;
 }
-declare const PeerOptionsWebRTCSubscribeModeEnum: {
-    readonly Auto: "auto";
-    readonly Manual: "manual";
-};
-type PeerOptionsWebRTCSubscribeModeEnum = typeof PeerOptionsWebRTCSubscribeModeEnum[keyof typeof PeerOptionsWebRTCSubscribeModeEnum];
 /**
  * Informs about the peer status
  * @export
@@ -179,17 +173,17 @@ interface RoomConfig {
      */
     'public'?: boolean;
     /**
-     * The use-case of the room. If not provided, this defaults to conference.
-     * @type {string}
+     *
+     * @type {RoomType}
      * @memberof RoomConfig
      */
-    'roomType'?: RoomConfigRoomTypeEnum;
+    'roomType'?: RoomType;
     /**
-     * Enforces video codec for each peer in the room
-     * @type {string}
+     *
+     * @type {VideoCodec}
      * @memberof RoomConfig
      */
-    'videoCodec'?: RoomConfigVideoCodecEnum;
+    'videoCodec'?: VideoCodec;
     /**
      * URL where Fishjam notifications will be sent
      * @type {string}
@@ -197,7 +191,12 @@ interface RoomConfig {
      */
     'webhookUrl'?: string | null;
 }
-declare const RoomConfigRoomTypeEnum: {
+/**
+ * The use-case of the room. If not provided, this defaults to conference.
+ * @export
+ * @enum {string}
+ */
+declare const RoomType: {
     readonly FullFeature: "full_feature";
     readonly AudioOnly: "audio_only";
     readonly Broadcaster: "broadcaster";
@@ -205,12 +204,7 @@ declare const RoomConfigRoomTypeEnum: {
     readonly Conference: "conference";
     readonly AudioOnlyLivestream: "audio_only_livestream";
 };
-type RoomConfigRoomTypeEnum = typeof RoomConfigRoomTypeEnum[keyof typeof RoomConfigRoomTypeEnum];
-declare const RoomConfigVideoCodecEnum: {
-    readonly H264: "h264";
-    readonly Vp8: "vp8";
-};
-type RoomConfigVideoCodecEnum = typeof RoomConfigVideoCodecEnum[keyof typeof RoomConfigVideoCodecEnum];
+type RoomType = typeof RoomType[keyof typeof RoomType];
 /**
  * Token for authorizing broadcaster streamer connection
  * @export
@@ -234,6 +228,25 @@ declare const SubscribeMode: {
     readonly Manual: "manual";
 };
 type SubscribeMode = typeof SubscribeMode[keyof typeof SubscribeMode];
+/**
+ * Describes peer\'s subscriptions in manual mode
+ * @export
+ * @interface Subscriptions
+ */
+interface Subscriptions {
+    /**
+     * List of peer IDs this peer subscribes to
+     * @type {Array<string>}
+     * @memberof Subscriptions
+     */
+    'peers': Array<string>;
+    /**
+     * List of track IDs this peer subscribes to
+     * @type {Array<string>}
+     * @memberof Subscriptions
+     */
+    'tracks': Array<string>;
+}
 /**
  * Describes media track of a Peer
  * @export
@@ -254,16 +267,31 @@ interface Track$1 {
     'metadata'?: object | null;
     /**
      *
-     * @type {string}
+     * @type {TrackType}
      * @memberof Track
      */
-    'type'?: TrackTypeEnum;
+    'type'?: TrackType$2;
 }
-declare const TrackTypeEnum: {
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+declare const TrackType$2: {
     readonly Audio: "audio";
     readonly Video: "video";
 };
-type TrackTypeEnum = typeof TrackTypeEnum[keyof typeof TrackTypeEnum];
+type TrackType$2 = typeof TrackType$2[keyof typeof TrackType$2];
+/**
+ * Enforces video codec for each peer in the room
+ * @export
+ * @enum {string}
+ */
+declare const VideoCodec: {
+    readonly H264: "h264";
+    readonly Vp8: "vp8";
+};
+type VideoCodec = typeof VideoCodec[keyof typeof VideoCodec];
 /**
  * Token for authorizing broadcaster viewer connection
  * @export
@@ -353,6 +381,8 @@ interface ServerMessage {
     viewerDisconnected?: ServerMessage_ViewerDisconnected | undefined;
     streamerConnected?: ServerMessage_StreamerConnected | undefined;
     streamerDisconnected?: ServerMessage_StreamerDisconnected | undefined;
+    channelAdded?: ServerMessage_ChannelAdded | undefined;
+    channelRemoved?: ServerMessage_ChannelRemoved | undefined;
 }
 declare const ServerMessage: MessageFns$1<ServerMessage>;
 /** Notification sent when a room crashes */
@@ -411,7 +441,7 @@ interface ServerMessage_AuthRequest {
     token: string;
 }
 declare const ServerMessage_AuthRequest: MessageFns$1<ServerMessage_AuthRequest>;
-/** Request sent by peer to subsribe for certain message type */
+/** Request sent by peer to subscribe for certain message type */
 interface ServerMessage_SubscribeRequest {
     eventType: ServerMessage_EventType;
 }
@@ -437,7 +467,7 @@ interface ServerMessage_HlsPlayable {
     componentId: string;
 }
 declare const ServerMessage_HlsPlayable: MessageFns$1<ServerMessage_HlsPlayable>;
-/** Notification sent when the HLS recording is successfully uploded to AWS S3 */
+/** Notification sent when the HLS recording is successfully uploaded to AWS S3 */
 interface ServerMessage_HlsUploaded {
     roomId: string;
 }
@@ -479,6 +509,22 @@ interface ServerMessage_TrackMetadataUpdated {
     track: Track | undefined;
 }
 declare const ServerMessage_TrackMetadataUpdated: MessageFns$1<ServerMessage_TrackMetadataUpdated>;
+/** Notification sent when a peer creates a channel */
+interface ServerMessage_ChannelAdded {
+    roomId: string;
+    peerId?: string | undefined;
+    componentId?: string | undefined;
+    channelId: string;
+}
+declare const ServerMessage_ChannelAdded: MessageFns$1<ServerMessage_ChannelAdded>;
+/** Notification sent when a peer deletes a channel */
+interface ServerMessage_ChannelRemoved {
+    roomId: string;
+    peerId?: string | undefined;
+    componentId?: string | undefined;
+    channelId: string;
+}
+declare const ServerMessage_ChannelRemoved: MessageFns$1<ServerMessage_ChannelRemoved>;
 /** Notification sent when streamer successfully connects */
 interface ServerMessage_StreamConnected {
     streamId: string;
@@ -539,6 +585,7 @@ declare const AgentRequest_TrackData: MessageFns<AgentRequest_TrackData>;
 interface AgentResponse {
     authenticated?: AgentResponse_Authenticated | undefined;
     trackData?: AgentResponse_TrackData | undefined;
+    trackImage?: AgentResponse_TrackImage | undefined;
 }
 declare const AgentResponse: MessageFns<AgentResponse>;
 /** Response confirming successful authentication */
@@ -552,6 +599,12 @@ interface AgentResponse_TrackData {
     data: Uint8Array;
 }
 declare const AgentResponse_TrackData: MessageFns<AgentResponse_TrackData>;
+interface AgentResponse_TrackImage {
+    trackId: string;
+    contentType: string;
+    data: Uint8Array;
+}
+declare const AgentResponse_TrackImage: MessageFns<AgentResponse_TrackImage>;
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
@@ -750,7 +803,7 @@ declare class FishjamAgent extends FishjamAgent_base {
      */
     createTrack(codecParameters: AudioCodecParameters, metadata?: object): AgentTrack;
     /**
-     * Interrupt track indentified by `trackId`.
+     * Interrupt track identified by `trackId`.
      *
      * Any audio that has been sent by the agent, but not played
      * by Fishjam will be cleared and be prevented from playing.
@@ -782,6 +835,7 @@ declare class FishjamClient {
     private readonly viewerApi;
     private readonly streamerApi;
     private readonly fishjamConfig;
+    private deprecationWarningShown;
     /**
      * Create new instance of Fishjam Client.
      *
@@ -794,6 +848,7 @@ declare class FishjamClient {
      * ```
      */
     constructor(config: FishjamConfig);
+    private handleDeprecationHeader;
     /**
      * Create a new room. All peers connected to the same room will be able to send/receive streams to each other.
      */
@@ -882,4 +937,4 @@ declare class ServiceUnavailableException extends FishjamBaseException {
 declare class UnknownException extends FishjamBaseException {
 }
 
-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, type PeerOptionsAgent, type PeerOptionsWebRTC, 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, type PeerOptionsAgent, type PeerOptionsWebRTC, PeerStatus, type Room, type RoomConfig, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, RoomType, ServerMessage, ServiceUnavailableException, type StreamConnected, type StreamDisconnected, type StreamerToken, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, VideoCodec, type ViewerConnected, type ViewerDisconnected, type ViewerToken };