@fishjam-cloud/js-server-sdk 0.27.0-rc.0 → 0.27.0

package/dist/{chunk-Q5OZUPAC.mjs → chunk-GFB6IWU4.mjs}

@@ -1,7 +1,7 @@
 // package.json
 var package_default = {
   name: "@fishjam-cloud/js-server-sdk",
-  version: "0.27.0-rc.0",
+  version: "0.27.0",
   description: "Fishjam server SDK for JavaScript",
   homepage: "https://github.com/fishjam-cloud/js-server-sdk",
   author: "Fishjam Team",

package/dist/index.d.mts

@@ -52,6 +52,25 @@ interface MoqToken {
      */
     'token': string;
 }
+/**
+ * MoQ token configuration
+ * @export
+ * @interface MoqTokenConfig
+ */
+interface MoqTokenConfig {
+    /**
+     * Path under the root the token grants publish access to
+     * @type {string}
+     * @memberof MoqTokenConfig
+     */
+    'publishPath'?: string | null;
+    /**
+     * Path under the root the token grants subscribe access to
+     * @type {string}
+     * @memberof MoqTokenConfig
+     */
+    'subscribePath'?: string | null;
+}
 /**
  * Describes peer status
  * @export
@@ -93,13 +112,13 @@ interface Peer$1 {
      * @type {Array<Track>}
      * @memberof Peer
      */
-    'tracks': Array<Track$1>;
+    'tracks': Array<Track$2>;
     /**
      *
      * @type {PeerType}
      * @memberof Peer
      */
-    'type': PeerType;
+    'type': PeerType$1;
 }
 /**
  * @type PeerOptions
@@ -187,18 +206,24 @@ type PeerStatus = typeof PeerStatus[keyof typeof PeerStatus];
  * @export
  * @enum {string}
  */
-declare const PeerType: {
+declare const PeerType$1: {
     readonly Webrtc: "webrtc";
     readonly Agent: "agent";
     readonly Vapi: "vapi";
 };
-type PeerType = typeof PeerType[keyof typeof PeerType];
+type PeerType$1 = typeof PeerType$1[keyof typeof PeerType$1];
 /**
  * Room configuration
  * @export
  * @interface RoomConfig
  */
 interface RoomConfig {
+    /**
+     * If true, webhook notifications for this room are coalesced into a single NotificationBatch per HTTP send instead of one request per notification. VAD notifications are unaffected.
+     * @type {boolean}
+     * @memberof RoomConfig
+     */
+    'batchWebhookNotifications'?: boolean;
     /**
      * Maximum amount of peers allowed into the room
      * @type {number}
@@ -245,13 +270,13 @@ declare const RoomType: {
 };
 type RoomType = typeof RoomType[keyof typeof RoomType];
 /**
- * Token for authorizing broadcaster streamer connection
+ * Streamer authorization token
  * @export
  * @interface StreamerToken
  */
 interface StreamerToken {
     /**
-     *
+     * Token streamer should authorize with
      * @type {string}
      * @memberof StreamerToken
      */
@@ -287,11 +312,11 @@ interface Subscriptions {
     'tracks': Array<string>;
 }
 /**
- * Describes media track of a Peer
+ * Media track of a Peer
  * @export
  * @interface Track
  */
-interface Track$1 {
+interface Track$2 {
     /**
      * Assigned track id
      * @type {string}
@@ -299,7 +324,7 @@ interface Track$1 {
      */
     'id'?: string;
     /**
-     *
+     * Metadata attached to the track by the peer
      * @type {object}
      * @memberof Track
      */
@@ -312,7 +337,7 @@ interface Track$1 {
     'type'?: TrackType$2;
 }
 /**
- *
+ * Media type carried by the track
  * @export
  * @enum {string}
  */
@@ -332,13 +357,13 @@ declare const VideoCodec: {
 };
 type VideoCodec = typeof VideoCodec[keyof typeof VideoCodec];
 /**
- * Token for authorizing broadcaster viewer connection
+ * Viewer authorization token
  * @export
  * @interface ViewerToken
  */
 interface ViewerToken {
     /**
-     *
+     * Token viewer should authorize with
      * @type {string}
      * @memberof ViewerToken
      */
@@ -353,12 +378,12 @@ declare enum TrackType$1 {
     UNRECOGNIZED = -1
 }
 /** Describes a media track */
-interface Track {
+interface Track$1 {
     id: string;
     type: TrackType$1;
     metadata: string;
 }
-declare const Track: MessageFns$2<Track>;
+declare const Track$1: MessageFns$2<Track$1>;
 type Builtin$2 = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial$2<T> = T extends Builtin$2 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$2<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$2<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial$2<T[K]>;
@@ -424,6 +449,8 @@ interface ServerMessage {
     viewerDisconnected?: ServerMessage_ViewerDisconnected | undefined;
     streamerConnected?: ServerMessage_StreamerConnected | undefined;
     streamerDisconnected?: ServerMessage_StreamerDisconnected | undefined;
+    /** Batch */
+    notificationBatch?: ServerMessage_NotificationBatch | undefined;
     /** @deprecated */
     streamConnected?: ServerMessage_StreamConnected | undefined;
     /** @deprecated */
@@ -543,7 +570,7 @@ interface ServerMessage_TrackAdded {
     roomId: string;
     peerId?: string | undefined;
     componentId?: string | undefined;
-    track: Track | undefined;
+    track: Track$1 | undefined;
 }
 declare const ServerMessage_TrackAdded: MessageFns$1<ServerMessage_TrackAdded>;
 /** Notification sent when a track is removed */
@@ -551,7 +578,7 @@ interface ServerMessage_TrackRemoved {
     roomId: string;
     peerId?: string | undefined;
     componentId?: string | undefined;
-    track: Track | undefined;
+    track: Track$1 | undefined;
 }
 declare const ServerMessage_TrackRemoved: MessageFns$1<ServerMessage_TrackRemoved>;
 /** Notification sent when metadata of a multimedia track is updated */
@@ -559,7 +586,7 @@ interface ServerMessage_TrackMetadataUpdated {
     roomId: string;
     peerId?: string | undefined;
     componentId?: string | undefined;
-    track: Track | undefined;
+    track: Track$1 | undefined;
 }
 declare const ServerMessage_TrackMetadataUpdated: MessageFns$1<ServerMessage_TrackMetadataUpdated>;
 /** Notification sent when a peer creates a channel */
@@ -585,8 +612,8 @@ interface ServerMessage_TrackForwarding {
     compositionUrl: string;
     inputId: string;
     /** Track has id, type, and metadata */
-    audioTrack?: Track | undefined;
-    videoTrack?: Track | undefined;
+    audioTrack?: Track$1 | undefined;
+    videoTrack?: Track$1 | undefined;
 }
 declare const ServerMessage_TrackForwarding: MessageFns$1<ServerMessage_TrackForwarding>;
 /** Sent when track forwarding is removed */
@@ -637,6 +664,23 @@ interface ServerMessage_StreamerDisconnected {
     streamerId: string;
 }
 declare const ServerMessage_StreamerDisconnected: MessageFns$1<ServerMessage_StreamerDisconnected>;
+/**
+ * Carries multiple notifications in a single wire frame.
+ *
+ * Constraints (documented, not schema-enforced):
+ *   - Each element's `content` MUST be a notification variant — never
+ *     Authenticated, AuthRequest, SubscribeRequest, or SubscribeResponse.
+ *   - NotificationBatch MUST NOT be nested inside another NotificationBatch.
+ *     The schema technically permits this, but senders must not emit
+ *     recursive batches and receivers may treat them as a protocol violation.
+ *   - Notifications are delivered in array order; consumers must process
+ *     them in order.
+ *   - Sent only for webhooks, for peers that .
+ */
+interface ServerMessage_NotificationBatch {
+    notifications: ServerMessage[];
+}
+declare const ServerMessage_NotificationBatch: MessageFns$1<ServerMessage_NotificationBatch>;
 type Builtin$1 = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial$1<T> = T extends Builtin$1 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$1<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$1<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial$1<T[K]>;
@@ -675,7 +719,7 @@ declare const AgentResponse_Authenticated: MessageFns<AgentResponse_Authenticate
 /** Notification containing a chunk of a track's data stream */
 interface AgentResponse_TrackData {
     peerId: string;
-    track: Track | undefined;
+    track: Track$1 | undefined;
     data: Uint8Array;
 }
 declare const AgentResponse_TrackData: MessageFns<AgentResponse_TrackData>;
@@ -762,14 +806,19 @@ type RoomId = Brand<string, 'RoomId'>;
  * ID of Peer. Peer is associated with Room and can be created with {@link FishjamClient.createPeer}.
  */
 type PeerId = Brand<string, 'PeerId'>;
-/**
- * ID of a MoQ stream. Tokens for a stream can be created with
- * {@link FishjamClient.createMoqPublisherToken} and {@link FishjamClient.createMoqSubscriberToken}.
- */
-type StreamId = Brand<string, 'StreamId'>;
 type Peer = Omit<Peer$1, 'id'> & {
     id: PeerId;
 };
+/**
+ * Peer type as emitted by {@link FishjamWSNotifier}. Matches the REST API's `PeerType`,
+ * with the addition of `'unspecified'` for messages whose peer type is not set on the wire.
+ */
+type PeerType = PeerType$1 | 'unspecified';
+/**
+ * Track type as emitted by {@link FishjamWSNotifier}. Matches the REST API's `TrackType`,
+ * with the addition of `'unspecified'` for messages whose track type is not set on the wire.
+ */
+type TrackType = TrackType$2 | 'unspecified';
 type Room = {
     id: RoomId;
     peers: Peer[];
@@ -801,16 +850,57 @@ type WithPeerId<T> = {
     } : T[P];
 };
 
-type ExpectedEvents = 'roomCreated' | 'roomDeleted' | 'roomCrashed' | 'peerAdded' | 'peerDeleted' | 'peerConnected' | 'peerDisconnected' | 'peerMetadataUpdated' | 'peerCrashed' | 'streamConnected' | 'streamDisconnected' | 'viewerConnected' | 'viewerDisconnected' | 'trackAdded' | 'trackRemoved' | 'trackMetadataUpdated';
+/**
+ * Track payload embedded in {@link TrackAdded}, {@link TrackRemoved}, {@link TrackMetadataUpdated}.
+ */
+type Track = {
+    id: string;
+    type: TrackType;
+    metadata: string;
+};
+declare const expectedEventsList$1: readonly ["roomCreated", "roomDeleted", "roomCrashed", "peerAdded", "peerDeleted", "peerConnected", "peerDisconnected", "peerMetadataUpdated", "peerCrashed", "streamerConnected", "streamerDisconnected", "viewerConnected", "viewerDisconnected", "trackAdded", "trackRemoved", "trackMetadataUpdated", "channelAdded", "channelRemoved"];
+type ExpectedEvents = (typeof expectedEventsList$1)[number];
+/**
+ * `ServerMessage` oneof members that are intentionally NOT emitted to users.
+ * Grouped with a brief rationale so the classification stays reviewable.
+ * Mirrors the Python SDK's `IGNORED_NOTIFICATIONS` partition (FCE-3215).
+ */
+declare const ignoredEventsList: readonly ["authenticated", "authRequest", "subscribeRequest", "subscribeResponse", "trackForwarding", "trackForwardingRemoved", "vadNotification", "notificationBatch", "streamConnected", "streamDisconnected", "hlsPlayable", "hlsUploaded", "hlsUploadCrashed", "componentCrashed"];
+type IgnoredEvents = (typeof ignoredEventsList)[number];
 /**
  * @inline
  */
 type MessageWithIds = WithPeerId<WithRoomId<ServerMessage>>;
+/** @inline */
+type WithMappedPeerType<T> = Omit<T, 'peerType'> & {
+    peerType: PeerType;
+};
+/** @inline */
+type WithMappedTrack<T> = Omit<T, 'track'> & {
+    track: Track | undefined;
+};
 /**
  * @inline
  */
 type Notifications = {
-    [K in ExpectedEvents]: NonNullable<MessageWithIds[K]>;
+    roomCreated: NonNullable<MessageWithIds['roomCreated']>;
+    roomDeleted: NonNullable<MessageWithIds['roomDeleted']>;
+    roomCrashed: NonNullable<MessageWithIds['roomCrashed']>;
+    peerAdded: WithMappedPeerType<NonNullable<MessageWithIds['peerAdded']>>;
+    peerDeleted: WithMappedPeerType<NonNullable<MessageWithIds['peerDeleted']>>;
+    peerConnected: WithMappedPeerType<NonNullable<MessageWithIds['peerConnected']>>;
+    peerDisconnected: WithMappedPeerType<NonNullable<MessageWithIds['peerDisconnected']>>;
+    peerMetadataUpdated: WithMappedPeerType<NonNullable<MessageWithIds['peerMetadataUpdated']>>;
+    peerCrashed: WithMappedPeerType<NonNullable<MessageWithIds['peerCrashed']>>;
+    streamerConnected: NonNullable<MessageWithIds['streamerConnected']>;
+    streamerDisconnected: NonNullable<MessageWithIds['streamerDisconnected']>;
+    viewerConnected: NonNullable<MessageWithIds['viewerConnected']>;
+    viewerDisconnected: NonNullable<MessageWithIds['viewerDisconnected']>;
+    trackAdded: WithMappedTrack<NonNullable<MessageWithIds['trackAdded']>>;
+    trackRemoved: WithMappedTrack<NonNullable<MessageWithIds['trackRemoved']>>;
+    trackMetadataUpdated: WithMappedTrack<NonNullable<MessageWithIds['trackMetadataUpdated']>>;
+    channelAdded: NonNullable<MessageWithIds['channelAdded']>;
+    channelRemoved: NonNullable<MessageWithIds['channelRemoved']>;
 };
 type RoomCreated = Notifications['roomCreated'];
 type RoomDeleted = Notifications['roomDeleted'];
@@ -821,16 +911,19 @@ type PeerConnected = Notifications['peerConnected'];
 type PeerDisconnected = Notifications['peerDisconnected'];
 type PeerMetadataUpdated = Notifications['peerMetadataUpdated'];
 type PeerCrashed = Notifications['peerCrashed'];
-type StreamConnected = Notifications['streamConnected'];
-type StreamDisconnected = Notifications['streamDisconnected'];
+type StreamerConnected = Notifications['streamerConnected'];
+type StreamerDisconnected = Notifications['streamerDisconnected'];
 type ViewerConnected = Notifications['viewerConnected'];
 type ViewerDisconnected = Notifications['viewerDisconnected'];
 type TrackAdded = Notifications['trackAdded'];
 type TrackRemoved = Notifications['trackRemoved'];
 type TrackMetadataUpdated = Notifications['trackMetadataUpdated'];
+type ChannelAdded = Notifications['channelAdded'];
+type ChannelRemoved = Notifications['channelRemoved'];
 type NotificationEvents = {
-    [K in ExpectedEvents]: (message: NonNullable<MessageWithIds[K]>) => void;
+    [K in ExpectedEvents]: (message: Notifications[K]) => void;
 };
+
 declare const FishjamWSNotifier_base: new () => TypedEventEmitter<NotificationEvents>;
 /**
  * Notifier object that can be used to get notified about various events related to the Fishjam App.
@@ -856,10 +949,9 @@ type IncomingTrackImage = NonNullable<AgentResponse_TrackImage>;
 type OutgoingTrackData = Omit<NonNullable<AgentRequest_TrackData>, 'peerId'> & {
     peerId: PeerId;
 };
-type AgentTrack = Omit<Track, 'id'> & {
+type AgentTrack = Omit<Track$1, 'id'> & {
     id: TrackId;
 };
-type TrackType = 'audio' | 'video';
 type AudioCodecParameters = {
     encoding: 'opus' | 'pcm16';
     sampleRate: 16000 | 24000 | 48000;
@@ -912,7 +1004,7 @@ declare class FishjamAgent extends FishjamAgent_base {
      * @param timeoutMs - timeout in milliseconds (default: 5000)
      * @returns a promise that resolves with the captured image data
      */
-    captureImage(trackId: string, timeoutMs?: number): Promise<IncomingTrackImage>;
+    captureImage(trackId: TrackId, timeoutMs?: number): Promise<IncomingTrackImage>;
     disconnect(): void;
     private handleTrackImageMessage;
     private rejectPendingCaptures;
@@ -1013,15 +1105,10 @@ declare class FishjamClient {
      */
     createLivestreamStreamerToken(roomId: RoomId): Promise<StreamerToken>;
     /**
-     * Creates a MoQ publisher token for the given stream.
-     * @returns a MoQ publisher token
-     */
-    createMoqPublisherToken(streamId: StreamId): Promise<MoqToken>;
-    /**
-     * Creates a MoQ subscriber token for the given stream.
-     * @returns a MoQ subscriber token
+     * Creates a MoQ token.
+     * @returns a MoQ token
      */
-    createMoqSubscriberToken(streamId: StreamId): Promise<MoqToken>;
+    createMoqToken(config?: MoqTokenConfig): Promise<MoqToken>;
 }
 
 declare class MissingFishjamIdException extends Error {
@@ -1050,4 +1137,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, type IncomingTrackImage, MissingFishjamIdException, type MoqToken, 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 PeerOptionsVapi, type PeerOptionsWebRTC, PeerStatus, type Room, type RoomConfig, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, RoomType, ServerMessage, ServiceUnavailableException, type StreamConnected, type StreamDisconnected, type StreamId, type StreamerToken, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, VideoCodec, type ViewerConnected, type ViewerDisconnected, type ViewerToken };
+export { type AgentCallbacks, type AgentEvents, type AgentTrack, type AudioCodecParameters, BadRequestException, type Brand, type ChannelAdded, type ChannelRemoved, type CloseEventHandler, type ErrorEventHandler, type ExpectedAgentEvents, type ExpectedEvents, FishjamAgent, FishjamBaseException, FishjamClient, type FishjamConfig, FishjamNotFoundException, FishjamWSNotifier, ForbiddenException, type IgnoredEvents, type IncomingTrackData, type IncomingTrackImage, MissingFishjamIdException, type MoqToken, type MoqTokenConfig, 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 PeerOptionsVapi, type PeerOptionsWebRTC, PeerStatus, type PeerType, type Room, type RoomConfig, type RoomCrashed, type RoomCreated, type RoomDeleted, type RoomId, RoomNotFoundException, RoomType, ServerMessage, ServiceUnavailableException, type StreamerConnected, type StreamerDisconnected, type StreamerToken, type Track, type TrackAdded, type TrackId, type TrackMetadataUpdated, type TrackRemoved, type TrackType, UnauthorizedException, UnknownException, VideoCodec, type ViewerConnected, type ViewerDisconnected, type ViewerToken };