@stream-io/video-client 1.14.0 → 1.15.1

package/src/gen/video/sfu/event/events.ts

@@ -8,10 +8,10 @@ import { GoAwayReason } from '../models/models';
 import { CallGrants } from '../models/models';
 import { Codec } from '../models/models';
 import { ConnectionQuality } from '../models/models';
-import { PublishOptions } from '../models/models';
 import { CallState } from '../models/models';
 import { TrackSubscriptionDetails } from '../signal_rpc/signal';
 import { TrackInfo } from '../models/models';
+import { SubscribeOption } from '../models/models';
 import { ClientDetails } from '../models/models';
 import { TrackUnpublishReason } from '../models/models';
 import { Participant } from '../models/models';
@@ -244,16 +244,6 @@ export interface SfuEvent {
          */
         participantMigrationComplete: ParticipantMigrationComplete;
       }
-    | {
-        oneofKind: 'codecNegotiationComplete';
-        /**
-         * CodecNegotiationComplete is sent to signal the completion of a codec negotiation.
-         * SDKs can safely stop previous transceivers
-         *
-         * @generated from protobuf field: stream.video.sfu.event.CodecNegotiationComplete codec_negotiation_complete = 26;
-         */
-        codecNegotiationComplete: CodecNegotiationComplete;
-      }
     | {
         oneofKind: 'changePublishOptions';
         /**
@@ -272,14 +262,18 @@ export interface SfuEvent {
  */
 export interface ChangePublishOptions {
   /**
-   * @generated from protobuf field: stream.video.sfu.models.PublishOption publish_option = 1;
+   * @generated from protobuf field: repeated stream.video.sfu.models.PublishOption publish_options = 1;
    */
-  publishOption?: PublishOption;
+  publishOptions: PublishOption[];
+  /**
+   * @generated from protobuf field: string reason = 2;
+   */
+  reason: string;
 }
 /**
- * @generated from protobuf message stream.video.sfu.event.CodecNegotiationComplete
+ * @generated from protobuf message stream.video.sfu.event.ChangePublishOptionsComplete
  */
-export interface CodecNegotiationComplete {}
+export interface ChangePublishOptionsComplete {}
 /**
  * @generated from protobuf message stream.video.sfu.event.ParticipantMigrationComplete
  */
@@ -504,6 +498,14 @@ export interface JoinRequest {
    * @generated from protobuf field: stream.video.sfu.event.ReconnectDetails reconnect_details = 7;
    */
   reconnectDetails?: ReconnectDetails;
+  /**
+   * @generated from protobuf field: repeated stream.video.sfu.models.PublishOption preferred_publish_options = 9;
+   */
+  preferredPublishOptions: PublishOption[];
+  /**
+   * @generated from protobuf field: repeated stream.video.sfu.models.SubscribeOption preferred_subscribe_options = 10;
+   */
+  preferredSubscribeOptions: SubscribeOption[];
 }
 /**
  * @generated from protobuf message stream.video.sfu.event.ReconnectDetails
@@ -570,9 +572,9 @@ export interface JoinResponse {
    */
   fastReconnectDeadlineSeconds: number;
   /**
-   * @generated from protobuf field: stream.video.sfu.models.PublishOptions publish_options = 4;
+   * @generated from protobuf field: repeated stream.video.sfu.models.PublishOption publish_options = 4;
    */
-  publishOptions?: PublishOptions;
+  publishOptions: PublishOption[];
 }
 /**
  * ParticipantJoined is fired when a user joins a call
@@ -729,6 +731,14 @@ export interface AudioSender {
    * @generated from protobuf field: stream.video.sfu.models.Codec codec = 2;
    */
   codec?: Codec;
+  /**
+   * @generated from protobuf field: stream.video.sfu.models.TrackType track_type = 3;
+   */
+  trackType: TrackType;
+  /**
+   * @generated from protobuf field: int32 publish_option_id = 4;
+   */
+  publishOptionId: number;
 }
 /**
  * VideoLayerSetting is used to specify various parameters of a particular encoding in simulcast.
@@ -779,6 +789,14 @@ export interface VideoSender {
    * @generated from protobuf field: repeated stream.video.sfu.event.VideoLayerSetting layers = 3;
    */
   layers: VideoLayerSetting[];
+  /**
+   * @generated from protobuf field: stream.video.sfu.models.TrackType track_type = 4;
+   */
+  trackType: TrackType;
+  /**
+   * @generated from protobuf field: int32 publish_option_id = 5;
+   */
+  publishOptionId: number;
 }
 /**
  * sent to users when they need to change the quality of their video
@@ -1000,13 +1018,6 @@ class SfuEvent$Type extends MessageType<SfuEvent> {
         oneof: 'eventPayload',
         T: () => ParticipantMigrationComplete,
       },
-      {
-        no: 26,
-        name: 'codec_negotiation_complete',
-        kind: 'message',
-        oneof: 'eventPayload',
-        T: () => CodecNegotiationComplete,
-      },
       {
         no: 27,
         name: 'change_publish_options',
@@ -1027,10 +1038,12 @@ class ChangePublishOptions$Type extends MessageType<ChangePublishOptions> {
     super('stream.video.sfu.event.ChangePublishOptions', [
       {
         no: 1,
-        name: 'publish_option',
+        name: 'publish_options',
         kind: 'message',
+        repeat: 1 /*RepeatType.PACKED*/,
         T: () => PublishOption,
       },
+      { no: 2, name: 'reason', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
     ]);
   }
 }
@@ -1039,15 +1052,16 @@ class ChangePublishOptions$Type extends MessageType<ChangePublishOptions> {
  */
 export const ChangePublishOptions = new ChangePublishOptions$Type();
 // @generated message type with reflection information, may provide speed optimized methods
-class CodecNegotiationComplete$Type extends MessageType<CodecNegotiationComplete> {
+class ChangePublishOptionsComplete$Type extends MessageType<ChangePublishOptionsComplete> {
   constructor() {
-    super('stream.video.sfu.event.CodecNegotiationComplete', []);
+    super('stream.video.sfu.event.ChangePublishOptionsComplete', []);
   }
 }
 /**
- * @generated MessageType for protobuf message stream.video.sfu.event.CodecNegotiationComplete
+ * @generated MessageType for protobuf message stream.video.sfu.event.ChangePublishOptionsComplete
  */
-export const CodecNegotiationComplete = new CodecNegotiationComplete$Type();
+export const ChangePublishOptionsComplete =
+  new ChangePublishOptionsComplete$Type();
 // @generated message type with reflection information, may provide speed optimized methods
 class ParticipantMigrationComplete$Type extends MessageType<ParticipantMigrationComplete> {
   constructor() {
@@ -1306,6 +1320,20 @@ class JoinRequest$Type extends MessageType<JoinRequest> {
         kind: 'message',
         T: () => ReconnectDetails,
       },
+      {
+        no: 9,
+        name: 'preferred_publish_options',
+        kind: 'message',
+        repeat: 1 /*RepeatType.PACKED*/,
+        T: () => PublishOption,
+      },
+      {
+        no: 10,
+        name: 'preferred_subscribe_options',
+        kind: 'message',
+        repeat: 1 /*RepeatType.PACKED*/,
+        T: () => SubscribeOption,
+      },
     ]);
   }
 }
@@ -1413,7 +1441,8 @@ class JoinResponse$Type extends MessageType<JoinResponse> {
         no: 4,
         name: 'publish_options',
         kind: 'message',
-        T: () => PublishOptions,
+        repeat: 1 /*RepeatType.PACKED*/,
+        T: () => PublishOption,
       },
     ]);
   }
@@ -1578,6 +1607,22 @@ class AudioSender$Type extends MessageType<AudioSender> {
   constructor() {
     super('stream.video.sfu.event.AudioSender', [
       { no: 2, name: 'codec', kind: 'message', T: () => Codec },
+      {
+        no: 3,
+        name: 'track_type',
+        kind: 'enum',
+        T: () => [
+          'stream.video.sfu.models.TrackType',
+          TrackType,
+          'TRACK_TYPE_',
+        ],
+      },
+      {
+        no: 4,
+        name: 'publish_option_id',
+        kind: 'scalar',
+        T: 5 /*ScalarType.INT32*/,
+      },
     ]);
   }
 }
@@ -1630,6 +1675,22 @@ class VideoSender$Type extends MessageType<VideoSender> {
         repeat: 1 /*RepeatType.PACKED*/,
         T: () => VideoLayerSetting,
       },
+      {
+        no: 4,
+        name: 'track_type',
+        kind: 'enum',
+        T: () => [
+          'stream.video.sfu.models.TrackType',
+          TrackType,
+          'TRACK_TYPE_',
+        ],
+      },
+      {
+        no: 5,
+        name: 'publish_option_id',
+        kind: 'scalar',
+        T: 5 /*ScalarType.INT32*/,
+      },
     ]);
   }
 }

package/src/gen/video/sfu/models/models.ts

@@ -5,6 +5,7 @@
 import { MessageType } from '@protobuf-ts/runtime';
 import { Struct } from '../../../google/protobuf/struct';
 import { Timestamp } from '../../../google/protobuf/timestamp';
+
 /**
  * CallState is the current state of the call
  * as seen by an SFU.
@@ -194,49 +195,108 @@ export interface VideoLayer {
   quality: VideoQuality;
 }
 /**
- * @generated from protobuf message stream.video.sfu.models.PublishOptions
+ * SubscribeOption represents the configuration options for subscribing to a track.
+ *
+ * @generated from protobuf message stream.video.sfu.models.SubscribeOption
  */
-export interface PublishOptions {
+export interface SubscribeOption {
+  /**
+   * The type of the track being subscribed (e.g., video, screenshare).
+   *
+   * @generated from protobuf field: stream.video.sfu.models.TrackType track_type = 1;
+   */
+  trackType: TrackType;
   /**
-   * @generated from protobuf field: repeated stream.video.sfu.models.PublishOption codecs = 1;
+   * The codecs supported by the subscriber for decoding tracks.
+   *
+   * @generated from protobuf field: repeated stream.video.sfu.models.Codec codecs = 2;
    */
-  codecs: PublishOption[];
+  codecs: Codec[];
 }
 /**
+ * PublishOption represents the configuration options for publishing a track.
+ *
  * @generated from protobuf message stream.video.sfu.models.PublishOption
  */
 export interface PublishOption {
   /**
+   * The type of the track being published (e.g., video, screenshare).
+   *
    * @generated from protobuf field: stream.video.sfu.models.TrackType track_type = 1;
    */
   trackType: TrackType;
   /**
+   * The codec to be used for encoding the track (e.g., VP8, VP9, H264).
+   *
    * @generated from protobuf field: stream.video.sfu.models.Codec codec = 2;
    */
   codec?: Codec;
   /**
+   * The target bitrate for the published track, in bits per second.
+   *
    * @generated from protobuf field: int32 bitrate = 3;
    */
   bitrate: number;
   /**
+   * The target frames per second (FPS) for video encoding.
+   *
    * @generated from protobuf field: int32 fps = 4;
    */
   fps: number;
   /**
+   * The maximum number of spatial layers to send.
+   * - For SVC (e.g., VP9), spatial layers downscale by a factor of 2:
+   *   - 1 layer: full resolution
+   *   - 2 layers: full resolution + half resolution
+   *   - 3 layers: full resolution + half resolution + quarter resolution
+   * - For non-SVC codecs (e.g., VP8/H264), this determines the number of
+   *   encoded resolutions (e.g., quarter, half, full) sent for simulcast.
+   *
    * @generated from protobuf field: int32 max_spatial_layers = 5;
    */
   maxSpatialLayers: number;
   /**
+   * The maximum number of temporal layers for scalable video coding (SVC).
+   * Temporal layers allow varying frame rates for different bandwidths.
+   *
    * @generated from protobuf field: int32 max_temporal_layers = 6;
    */
   maxTemporalLayers: number;
+  /**
+   * The dimensions of the video (e.g., width and height in pixels).
+   * Spatial layers are based on this base resolution. For example, if the base
+   * resolution is 1280x720:
+   * - Full resolution (1 layer) = 1280x720
+   * - Half resolution (2 layers) = 640x360
+   * - Quarter resolution (3 layers) = 320x180
+   *
+   * @generated from protobuf field: stream.video.sfu.models.VideoDimension video_dimension = 7;
+   */
+  videoDimension?: VideoDimension;
+  /**
+   * The unique identifier for the publish request.
+   * - This `id` is assigned exclusively by the SFU. Any `id` set by the client
+   *   in the `PublishOption` will be ignored and overwritten by the SFU.
+   * - The primary purpose of this `id` is to uniquely identify each publish
+   *   request, even in scenarios where multiple publish requests for the same
+   *   `track_type` and `codec` are active simultaneously.
+   *   For example:
+   *     - A user may publish two tracks of the same type (e.g., video) and codec
+   *       (e.g., VP9) concurrently.
+   * - This uniqueness ensures that individual requests can be managed
+   *   independently. For instance, an `id` is critical when stopping a specific
+   *   publish request without affecting others.
+   *
+   * @generated from protobuf field: int32 id = 8;
+   */
+  id: number;
 }
 /**
  * @generated from protobuf message stream.video.sfu.models.Codec
  */
 export interface Codec {
   /**
-   * @generated from protobuf field: uint32 payload_type = 11;
+   * @generated from protobuf field: uint32 payload_type = 16;
    */
   payloadType: number;
   /**
@@ -248,7 +308,7 @@ export interface Codec {
    */
   clockRate: number;
   /**
-   * @generated from protobuf field: string encoding_parameters = 13;
+   * @generated from protobuf field: string encoding_parameters = 15;
    */
   encodingParameters: string;
   /**
@@ -311,6 +371,14 @@ export interface TrackInfo {
    * @generated from protobuf field: bool muted = 10;
    */
   muted: boolean;
+  /**
+   * @generated from protobuf field: stream.video.sfu.models.Codec codec = 11;
+   */
+  codec?: Codec;
+  /**
+   * @generated from protobuf field: int32 publish_option_id = 12;
+   */
+  publishOptionId: number;
 }
 /**
  * @generated from protobuf message stream.video.sfu.models.Error
@@ -1102,23 +1170,33 @@ class VideoLayer$Type extends MessageType<VideoLayer> {
  */
 export const VideoLayer = new VideoLayer$Type();
 // @generated message type with reflection information, may provide speed optimized methods
-class PublishOptions$Type extends MessageType<PublishOptions> {
+class SubscribeOption$Type extends MessageType<SubscribeOption> {
   constructor() {
-    super('stream.video.sfu.models.PublishOptions', [
+    super('stream.video.sfu.models.SubscribeOption', [
       {
         no: 1,
+        name: 'track_type',
+        kind: 'enum',
+        T: () => [
+          'stream.video.sfu.models.TrackType',
+          TrackType,
+          'TRACK_TYPE_',
+        ],
+      },
+      {
+        no: 2,
         name: 'codecs',
         kind: 'message',
         repeat: 1 /*RepeatType.PACKED*/,
-        T: () => PublishOption,
+        T: () => Codec,
       },
     ]);
   }
 }
 /**
- * @generated MessageType for protobuf message stream.video.sfu.models.PublishOptions
+ * @generated MessageType for protobuf message stream.video.sfu.models.SubscribeOption
  */
-export const PublishOptions = new PublishOptions$Type();
+export const SubscribeOption = new SubscribeOption$Type();
 // @generated message type with reflection information, may provide speed optimized methods
 class PublishOption$Type extends MessageType<PublishOption> {
   constructor() {
@@ -1148,6 +1226,13 @@ class PublishOption$Type extends MessageType<PublishOption> {
         kind: 'scalar',
         T: 5 /*ScalarType.INT32*/,
       },
+      {
+        no: 7,
+        name: 'video_dimension',
+        kind: 'message',
+        T: () => VideoDimension,
+      },
+      { no: 8, name: 'id', kind: 'scalar', T: 5 /*ScalarType.INT32*/ },
     ]);
   }
 }
@@ -1160,7 +1245,7 @@ class Codec$Type extends MessageType<Codec> {
   constructor() {
     super('stream.video.sfu.models.Codec', [
       {
-        no: 11,
+        no: 16,
         name: 'payload_type',
         kind: 'scalar',
         T: 13 /*ScalarType.UINT32*/,
@@ -1173,7 +1258,7 @@ class Codec$Type extends MessageType<Codec> {
         T: 13 /*ScalarType.UINT32*/,
       },
       {
-        no: 13,
+        no: 15,
         name: 'encoding_parameters',
         kind: 'scalar',
         T: 9 /*ScalarType.STRING*/,
@@ -1237,6 +1322,13 @@ class TrackInfo$Type extends MessageType<TrackInfo> {
       { no: 8, name: 'stereo', kind: 'scalar', T: 8 /*ScalarType.BOOL*/ },
       { no: 9, name: 'red', kind: 'scalar', T: 8 /*ScalarType.BOOL*/ },
       { no: 10, name: 'muted', kind: 'scalar', T: 8 /*ScalarType.BOOL*/ },
+      { no: 11, name: 'codec', kind: 'message', T: () => Codec },
+      {
+        no: 12,
+        name: 'publish_option_id',
+        kind: 'scalar',
+        T: 5 /*ScalarType.INT32*/,
+      },
     ]);
   }
 }

package/src/helpers/array.ts

@@ -0,0 +1,14 @@
+/**
+ * Adds unique values to an array.
+ *
+ * @param arr the array to add to.
+ * @param values the values to add.
+ */
+export const pushToIfMissing = <T>(arr: T[], ...values: T[]): T[] => {
+  for (const v of values) {
+    if (!arr.includes(v)) {
+      arr.push(v);
+    }
+  }
+  return arr;
+};

package/src/permissions/PermissionsContext.ts

@@ -1,4 +1,6 @@
 import { CallSettingsResponse, OwnCapability } from '../gen/coordinator';
+import { TrackType } from '../gen/video/sfu/models/models';
+import { ensureExhausted } from '../helpers/ensureExhausted';
 
 /**
  * Stores the permissions for the current user and exposes
@@ -39,6 +41,26 @@ export class PermissionsContext {
     return this.permissions.includes(permission);
   };
 
+  /**
+   * Helper method that checks whether the current user has the permission
+   * to publish the given track type.
+   */
+  canPublish = (trackType: TrackType) => {
+    switch (trackType) {
+      case TrackType.AUDIO:
+        return this.hasPermission(OwnCapability.SEND_AUDIO);
+      case TrackType.VIDEO:
+        return this.hasPermission(OwnCapability.SEND_VIDEO);
+      case TrackType.SCREEN_SHARE:
+      case TrackType.SCREEN_SHARE_AUDIO:
+        return this.hasPermission(OwnCapability.SCREENSHARE);
+      case TrackType.UNSPECIFIED:
+        return false;
+      default:
+        ensureExhausted(trackType, 'Unknown track type');
+    }
+  };
+
   /**
    * Checks if the current user can request a specific permission
    * within the call.

package/src/permissions/__tests__/PermissionsContext.test.ts

@@ -0,0 +1,40 @@
+import { describe, expect, it } from 'vitest';
+import { TrackType } from '../../gen/video/sfu/models/models';
+import { CallSettingsResponse, OwnCapability } from '../../gen/coordinator';
+import { PermissionsContext } from '../PermissionsContext';
+
+describe('PermissionsContext', () => {
+  it('should set permissions', () => {
+    const ctx = new PermissionsContext();
+    ctx.setPermissions([OwnCapability.SEND_AUDIO]);
+    expect(ctx.hasPermission(OwnCapability.SEND_AUDIO)).toBe(true);
+    expect(ctx.hasPermission(OwnCapability.SEND_VIDEO)).toBe(false);
+  });
+
+  it('should set call settings', () => {
+    const ctx = new PermissionsContext();
+    const settings: CallSettingsResponse = {
+      // @ts-expect-error incomplete settings
+      audio: { access_request_enabled: true },
+      // @ts-expect-error incomplete settings
+      video: { access_request_enabled: false },
+      // @ts-expect-error incomplete settings
+      screensharing: { access_request_enabled: false },
+    };
+    ctx.setCallSettings(settings);
+    expect(ctx.canRequest(OwnCapability.SEND_AUDIO)).toBe(true);
+    expect(ctx.canRequest(OwnCapability.SEND_VIDEO)).toBe(false);
+    expect(ctx.canRequest(OwnCapability.SCREENSHARE)).toBe(false);
+    expect(ctx.canRequest(OwnCapability.BLOCK_USERS)).toBe(false);
+  });
+
+  it('should check if user can publish', () => {
+    const ctx = new PermissionsContext();
+    ctx.setPermissions([OwnCapability.SEND_AUDIO]);
+    expect(ctx.canPublish(TrackType.AUDIO)).toBe(true);
+    expect(ctx.canPublish(TrackType.VIDEO)).toBe(false);
+    expect(ctx.canPublish(TrackType.SCREEN_SHARE)).toBe(false);
+    expect(ctx.canPublish(TrackType.SCREEN_SHARE_AUDIO)).toBe(false);
+    expect(ctx.canPublish(TrackType.UNSPECIFIED)).toBe(false);
+  });
+});

package/src/rpc/__tests__/createClient.test.ts

@@ -0,0 +1,38 @@
+import { describe, expect, it, vi } from 'vitest';
+import {
+  createSignalClient,
+  withHeaders,
+  withRequestLogger,
+} from '../createClient';
+import { TwirpFetchTransport } from '@protobuf-ts/twirp-transport';
+
+describe('createClient', () => {
+  it('should create a client with TwirpFetchTransport', () => {
+    const client = createSignalClient();
+    expect(client).toBeDefined();
+    // @ts-expect-error - private field
+    expect(client._transport).toBeDefined();
+    // @ts-expect-error - private field
+    expect(client._transport).toBeInstanceOf(TwirpFetchTransport);
+  });
+
+  it('withHeaders should add headers to the request', () => {
+    const headers = { Authorization: 'Bearer token' };
+    const interceptor = withHeaders(headers);
+    const next = vi.fn();
+    interceptor.interceptUnary(next, null, null, { meta: {} });
+    expect(next).toHaveBeenCalled();
+    expect(next.mock.lastCall.at(-1).meta).toEqual(headers);
+  });
+
+  it('withRequestLogger should log the request', () => {
+    const logger = vi.fn();
+    const level = 'debug';
+    const interceptor = withRequestLogger(logger, level);
+    const next = vi.fn();
+    // @ts-expect-error - private field
+    interceptor.interceptUnary(next, { name: 'test' }, null, null);
+    expect(next).toHaveBeenCalled();
+    expect(logger).toHaveBeenCalled();
+  });
+});

package/src/rpc/createClient.ts

@@ -48,11 +48,17 @@ export const withRequestLogger = (
       input: object,
       options: RpcOptions,
     ): UnaryCall => {
-      logger(level, `Calling SFU RPC method ${method.name}`, {
-        input,
-        options,
-      });
-      return next(method, input, options);
+      let invocation: UnaryCall | undefined;
+      try {
+        invocation = next(method, input, options);
+      } finally {
+        logger(level, `Invoked SFU RPC method ${method.name}`, {
+          request: invocation?.request,
+          headers: invocation?.requestHeaders,
+          response: invocation?.response,
+        });
+      }
+      return invocation;
     },
   };
 };