@stream-io/video-client 0.2.3 → 0.3.0

package/dist/src/Call.d.ts

@@ -5,7 +5,7 @@ import { AcceptCallResponse, BlockUserResponse, EndCallResponse, GetCallResponse
 import { CallConstructor, CallLeaveOptions, DebounceType, JoinCallData, PublishOptions, SubscriptionChanges } from './types';
 import { ViewportTracker } from './helpers/ViewportTracker';
 import { PermissionsContext } from './permissions';
-import { CallEventHandler, CallEventTypes, Logger } from './coordinator/connection/types';
+import { CallEventHandler, CallEventTypes, EventTypes, Logger } from './coordinator/connection/types';
 /**
  * An object representation of a `Call`.
  */
@@ -74,7 +74,7 @@ export declare class Call {
      * Use the [`StreamVideoClient.call`](./StreamVideoClient.md/#call)
      * method to construct a `Call` instance.
      */
-    constructor({ type, id, streamClient, metadata, members, ownCapabilities, sortParticipantsBy, clientStore, ringing, watching, }: CallConstructor);
+    constructor({ type, id, streamClient, members, ownCapabilities, sortParticipantsBy, clientStore, ringing, watching, }: CallConstructor);
     private registerEffects;
     /**
      * You can subscribe to WebSocket events provided by the API. To remove a subscription, call the `off` method.
@@ -84,7 +84,7 @@ export declare class Call {
      * @returns a function which can be called to unsubscribe from the given event(s)
      */
     on(eventName: SfuEventKinds, fn: SfuEventListener): () => void;
-    on(eventName: CallEventTypes, fn: CallEventHandler): () => void;
+    on(eventName: EventTypes, fn: CallEventHandler): () => void;
     /**
      * Remove subscription for WebSocket events that were created by the `on` method.
      * @param eventName
@@ -97,10 +97,6 @@ export declare class Call {
      * Leave the call and stop the media streams that were published by the call.
      */
     leave: ({ reject }?: CallLeaveOptions) => Promise<void>;
-    /**
-     * A getter for the call metadata.
-     */
-    get data(): import("./gen/coordinator").CallResponse | undefined;
     /**
      * A flag indicating whether the call is "ringing" type of call.
      */
@@ -448,7 +444,6 @@ export declare class Call {
     private scheduleAutoDrop;
     /**
      * Retrieves the list of recordings for the current call or call session.
-     * Updates the call state with the returned array of CallRecording objects.
      *
      * If `callSessionId` is provided, it will return the recordings for that call session.
      * Otherwise, all recordings for the current call will be returned.

package/dist/src/StreamVideoClient.d.ts

@@ -92,7 +92,9 @@ export declare class StreamVideoClient {
         next?: string | undefined;
         prev?: string | undefined;
     }>;
-    queryUsers: () => Promise<void>;
+    /**
+     * Returns a list of available data centers available for hosting calls.
+     */
     edges: () => Promise<GetEdgesResponse>;
     /**
      * addDevice - Adds a push device for a user.

package/dist/src/events/call-permissions.d.ts

@@ -1,10 +1,5 @@
-import { StreamVideoEvent } from '../coordinator/connection/types';
 import { CallState } from '../store';
 import { SfuEvent } from '../gen/video/sfu/event/events';
-/**
- * Event handler that watches for `call.permissions_updated` events
- */
-export declare const watchCallPermissionsUpdated: (state: CallState) => (event: StreamVideoEvent) => void;
 /**
  * Event handler that watches for `callGrantsUpdated` events.
  *

package/dist/src/events/call.d.ts

@@ -1,4 +1,3 @@
-import { CallState } from '../store';
 import { StreamVideoEvent } from '../coordinator/connection/types';
 import { Call } from '../Call';
 /**
@@ -15,8 +14,3 @@ export declare const watchCallRejected: (call: Call) => (event: StreamVideoEvent
  * Event handler that watches the delivery of `call.ended` Websocket event.
  */
 export declare const watchCallEnded: (call: Call) => (event: StreamVideoEvent) => Promise<void>;
-/**
- * An event handler which listens to `call.updated` events
- * and updates the given call state accordingly.
- */
-export declare const watchCallUpdated: (state: CallState) => (event: StreamVideoEvent) => void;

package/dist/src/events/index.d.ts

@@ -1,11 +1,5 @@
-export * from './backstage';
 export * from './call';
 export * from './call-permissions';
 export * from './internal';
-export * from './members';
 export * from './participant';
-export * from './reactions';
-export * from './recording';
 export * from './speaker';
-export * from './sessions';
-export * from './moderation';

package/dist/src/rtc/Dispatcher.d.ts

@@ -1,7 +1,7 @@
-import { CallEventTypes } from '../coordinator/connection/types';
+import { EventTypes } from '../coordinator/connection/types';
 import type { SfuEvent } from '../gen/video/sfu/event/events';
 export type SfuEventKinds = NonNullable<SfuEvent['eventPayload']['oneofKind']>;
-export declare const isSfuEvent: (eventName: SfuEventKinds | CallEventTypes) => eventName is SfuEventKinds;
+export declare const isSfuEvent: (eventName: SfuEventKinds | EventTypes) => eventName is SfuEventKinds;
 export type SfuEventListener = (event: SfuEvent) => void;
 export declare class Dispatcher {
     private subscribers;

package/dist/src/rtc/Publisher.d.ts

@@ -20,7 +20,6 @@ export type PublisherOpts = {
 export declare class Publisher {
     private pc;
     private readonly state;
-    private readonly dispatcher;
     private readonly transceiverRegistry;
     /**
      * An array maintaining the order how transceivers were added to the peer connection.

package/dist/src/store/CallState.d.ts

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import type { Patch } from './rxUtils';
 import { StreamVideoLocalParticipant, StreamVideoParticipant, StreamVideoParticipantPatch, StreamVideoParticipantPatches } from '../types';
 import { CallStatsReport } from '../stats/types';
-import { CallRecording, CallResponse, MemberResponse, OwnCapability } from '../gen/coordinator';
+import { CallIngressResponse, CallResponse, CallSessionResponse, CallSettingsResponse, EgressResponse, MemberResponse, OwnCapability, UserResponse, VideoEvent } from '../gen/coordinator';
 import { Pin } from '../gen/video/sfu/models/models';
 import { Comparator } from '../sorting';
 import { Logger } from '../coordinator/connection/types';
@@ -57,71 +57,29 @@ export declare enum CallingState {
  * @react You don't have to use this class directly, as we are exposing the state through Hooks.
  */
 export declare class CallState {
-    /**
-     * The raw call metadata object, as defined on the backend.
-     *
-     * @internal
-     */
-    private metadataSubject;
-    /**
-     * The list of members of the current call.
-     *
-     * @internal
-     */
+    private backstageSubject;
+    private blockedUserIdsSubject;
+    private createdAtSubject;
+    private endedAtSubject;
+    private startsAtSubject;
+    private updatedAtSubject;
+    private createdBySubject;
+    private customSubject;
+    private egressSubject;
+    private ingressSubject;
+    private recordingSubject;
+    private sessionSubject;
+    private settingsSubject;
+    private transcribingSubject;
+    private endedBySubject;
     private membersSubject;
-    /**
-     * The list of capabilities of the current user.
-     *
-     * @private
-     */
     private ownCapabilitiesSubject;
-    /**
-     * The calling state.
-     *
-     * @internal
-     */
     private callingStateSubject;
-    /**
-     * The time the call session actually started.
-     *
-     * @internal
-     */
     private startedAtSubject;
-    /**
-     * The server-side counted number of participants connected to the current call.
-     * This number includes the anonymous participants as well.
-     *
-     * @internal
-     */
     private participantCountSubject;
-    /**
-     * The server-side counted number of anonymous participants connected to the current call.
-     * This number excludes the regular participants.
-     *
-     * @internal
-     */
     private anonymousParticipantCountSubject;
-    /**
-     * All participants of the current call (including the logged-in user).
-     *
-     * @internal
-     */
     private participantsSubject;
-    /**
-     * The latest stats report of the current call.
-     * When stats gathering is enabled, this observable will emit a new value
-     * at a regular (configurable) interval.
-     *
-     * Consumers of this observable can implement their own batching logic
-     * in case they want to show historical stat data.
-     *
-     * @internal
-     */
     private callStatsReportSubject;
-    /**
-     * Emits a list of details about recordings performed for the current call.
-     */
-    private callRecordingListSubject;
     /**
      * The time the call session actually started.
      * Useful for displaying the call duration.
@@ -176,14 +134,6 @@ export declare class CallState {
      * in case they want to show historical stats data.
      */
     callStatsReport$: Observable<CallStatsReport | undefined>;
-    /**
-     * Emits a list of details about recordings performed for the current call
-     */
-    callRecordingList$: Observable<CallRecording[]>;
-    /**
-     * The raw call metadata object, as defined on the backend.
-     */
-    metadata$: Observable<CallResponse | undefined>;
     /**
      * The list of members in the current call.
      */
@@ -196,6 +146,66 @@ export declare class CallState {
      * The calling state.
      */
     callingState$: Observable<CallingState>;
+    /**
+     * The backstage state.
+     */
+    backstage$: Observable<boolean>;
+    /**
+     * Will provide the list of blocked user IDs.
+     */
+    blockedUserIds$: Observable<string[]>;
+    /**
+     * Will provide the time when this call has been created.
+     */
+    createdAt$: Observable<Date>;
+    /**
+     * Will provide the time when this call has been ended.
+     */
+    endedAt$: Observable<Date | undefined>;
+    /**
+     * Will provide the time when this call has been scheduled to start.
+     */
+    startsAt$: Observable<Date | undefined>;
+    /**
+     * Will provide the time when this call has been updated.
+     */
+    updatedAt$: Observable<Date>;
+    /**
+     * Will provide the user who created this call.
+     */
+    createdBy$: Observable<UserResponse | undefined>;
+    /**
+     * Will provide the custom data of this call.
+     */
+    custom$: Observable<Record<string, any>>;
+    /**
+     * Will provide the egress data of this call.
+     */
+    egress$: Observable<EgressResponse | undefined>;
+    /**
+     * Will provide the ingress data of this call.
+     */
+    ingress$: Observable<CallIngressResponse | undefined>;
+    /**
+     * Will provide the recording state of this call.
+     */
+    recording$: Observable<boolean>;
+    /**
+     * Will provide the session data of this call.
+     */
+    session$: Observable<CallSessionResponse | undefined>;
+    /**
+     * Will provide the settings of this call.
+     */
+    settings$: Observable<CallSettingsResponse | undefined>;
+    /**
+     * Will provide the transcribing state of this call.
+     */
+    transcribing$: Observable<boolean>;
+    /**
+     * Will provide the user who ended this call.
+     */
+    endedBy$: Observable<UserResponse | undefined>;
     readonly logger: Logger;
     /**
      * A list of comparators that are used to sort the participants.
@@ -203,6 +213,7 @@ export declare class CallState {
      * @private
      */
     private sortParticipantsBy;
+    private readonly eventHandlers;
     /**
      * Creates a new instance of the CallState class.
      *
@@ -313,17 +324,6 @@ export declare class CallState {
      * @param state the new calling state.
      */
     setCallingState: (state: Patch<CallingState>) => CallingState;
-    /**
-     * The list of call recordings.
-     */
-    get callRecordingsList(): CallRecording[];
-    /**
-     * Sets the list of call recordings.
-     *
-     * @internal
-     * @param recordings the list of call recordings.
-     */
-    setCallRecordingsList: (recordings: Patch<CallRecording[]>) => CallRecording[];
     /**
      * The call stats report.
      */
@@ -335,18 +335,6 @@ export declare class CallState {
      * @param report the report to set.
      */
     setCallStatsReport: (report: Patch<CallStatsReport | undefined>) => CallStatsReport | undefined;
-    /**
-     * The metadata of the current call.
-     */
-    get metadata(): CallResponse | undefined;
-    /**
-     * Sets the metadata of the current call.
-     *
-     * @internal
-     *
-     * @param metadata the metadata to set.
-     */
-    setMetadata: (metadata: Patch<CallResponse | undefined>) => CallResponse | undefined;
     /**
      * The members of the current call.
      */
@@ -369,6 +357,66 @@ export declare class CallState {
      * @param capabilities the capabilities to set.
      */
     setOwnCapabilities: (capabilities: Patch<OwnCapability[]>) => OwnCapability[];
+    /**
+     * The backstage state.
+     */
+    get backstage(): boolean;
+    /**
+     * Will provide the list of blocked user IDs.
+     */
+    get blockedUserIds(): string[];
+    /**
+     * Will provide the time when this call has been created.
+     */
+    get createdAt(): Date;
+    /**
+     * Will provide the time when this call has been ended.
+     */
+    get endedAt(): Date | undefined;
+    /**
+     * Will provide the time when this call has been scheduled to start.
+     */
+    get startsAt(): Date | undefined;
+    /**
+     * Will provide the time when this call has been updated.
+     */
+    get updatedAt(): Date;
+    /**
+     * Will provide the user who created this call.
+     */
+    get createdBy(): UserResponse | undefined;
+    /**
+     * Will provide the custom data of this call.
+     */
+    get custom(): Record<string, any>;
+    /**
+     * Will provide the egress data of this call.
+     */
+    get egress(): EgressResponse | undefined;
+    /**
+     * Will provide the ingress data of this call.
+     */
+    get ingress(): CallIngressResponse | undefined;
+    /**
+     * Will provide the recording state of this call.
+     */
+    get recording(): boolean;
+    /**
+     * Will provide the session data of this call.
+     */
+    get session(): CallSessionResponse | undefined;
+    /**
+     * Will provide the settings of this call.
+     */
+    get settings(): CallSettingsResponse | undefined;
+    /**
+     * Will provide the transcribing state of this call.
+     */
+    get transcribing(): boolean;
+    /**
+     * Will provide the user who ended this call.
+     */
+    get endedBy(): UserResponse | undefined;
     /**
      * Will try to find the participant with the given sessionId in the current call.
      *
@@ -412,10 +460,37 @@ export declare class CallState {
      * @returns all participants, with all patch applied.
      */
     updateParticipants: (patch: StreamVideoParticipantPatches) => StreamVideoParticipant[] | undefined;
+    /**
+     * Updates the call state with the data received from the server.
+     *
+     * @internal
+     *
+     * @param event the video event that our backend sent us.
+     */
+    updateFromEvent: (event: VideoEvent) => void;
     /**
      * Updates the participant pinned state with server side pinning data.
      *
      * @param pins the latest pins from the server.
      */
     setServerSidePins: (pins: Pin[]) => StreamVideoParticipant[];
+    /**
+     * Updates the call state with the data received from the server.
+     *
+     * @internal
+     *
+     * @param call the call response from the server.
+     */
+    updateFromCallResponse: (call: CallResponse) => void;
+    private updateFromMemberRemoved;
+    private updateFromMemberAdded;
+    private updateFromBroadcastStopped;
+    private updateFromBroadcastStarted;
+    private updateFromSessionParticipantLeft;
+    private updateFromSessionParticipantJoined;
+    private updateMembers;
+    private updateParticipantReaction;
+    private unblockUser;
+    private blockUser;
+    private updateOwnCapabilities;
 }

package/dist/src/types.d.ts

@@ -1,5 +1,5 @@
 import type { Participant, VideoDimension } from './gen/video/sfu/models/models';
-import type { CallResponse, JoinCallRequest, MemberResponse, OwnCapability, ReactionResponse } from './gen/coordinator';
+import type { JoinCallRequest, MemberResponse, OwnCapability, ReactionResponse } from './gen/coordinator';
 import type { StreamClient } from './coordinator/connection/client';
 import type { Comparator } from './sorting';
 import type { StreamVideoWriteableStateStore } from './store';
@@ -141,12 +141,6 @@ export type CallConstructor = {
      * The Call ID.
      */
     id: string;
-    /**
-     * An optional {@link CallResponse} metadata from the backend.
-     * If provided, the call will be initialized with the data from this object.
-     * This is useful when initializing a new "pending call" from an event.
-     */
-    metadata?: CallResponse;
     /**
      * An optional list of {@link MemberResponse} from the backend.
      * If provided, the call will be initialized with the data from this object.

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.2.3";
+export declare const version = "0.3.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

package/src/Call.ts

@@ -105,6 +105,7 @@ import {
   CallEventHandler,
   CallEventTypes,
   EventHandler,
+  EventTypes,
   Logger,
   StreamCallEvent,
 } from './coordinator/connection/types';
@@ -200,7 +201,6 @@ export class Call {
     type,
     id,
     streamClient,
-    metadata,
     members,
     ownCapabilities,
     sortParticipantsBy,
@@ -225,13 +225,17 @@ export class Call {
       this.state.setSortParticipantsBy(participantSorter);
     }
 
-    this.state.setMetadata(metadata);
     this.state.setMembers(members || []);
     this.state.setOwnCapabilities(ownCapabilities || []);
     this.state.setCallingState(
       ringing ? CallingState.RINGING : CallingState.IDLE,
     );
 
+    this.on('all', (event) => {
+      // update state with the latest event data
+      this.state.updateFromEvent(event);
+    });
+
     this.leaveCallHooks.push(
       registerEventHandlers(this, this.state, this.dispatcher),
     );
@@ -250,10 +254,10 @@ export class Call {
 
   private registerEffects() {
     this.leaveCallHooks.push(
-      // handles updating the permissions context when the metadata changes.
-      createSubscription(this.state.metadata$, (metadata) => {
-        if (!metadata) return;
-        this.permissionsContext.setCallSettings(metadata.settings);
+      // handles updating the permissions context when the settings change.
+      createSubscription(this.state.settings$, (settings) => {
+        if (!settings) return;
+        this.permissionsContext.setCallSettings(settings);
       }),
 
       // handle the case when the user permissions are modified.
@@ -284,13 +288,10 @@ export class Call {
       }),
 
       // handles the case when the user is blocked by the call owner.
-      createSubscription(this.state.metadata$, async (metadata) => {
-        if (!metadata) return;
+      createSubscription(this.state.blockedUserIds$, async (blockedUserIds) => {
+        if (!blockedUserIds) return;
         const currentUserId = this.currentUserId;
-        if (
-          currentUserId &&
-          metadata.blocked_user_ids.includes(currentUserId)
-        ) {
+        if (currentUserId && blockedUserIds.includes(currentUserId)) {
           this.logger('info', 'Leaving call because of being blocked');
           await this.leave();
         }
@@ -329,9 +330,9 @@ export class Call {
    * @returns a function which can be called to unsubscribe from the given event(s)
    */
   on(eventName: SfuEventKinds, fn: SfuEventListener): () => void;
-  on(eventName: CallEventTypes, fn: CallEventHandler): () => void;
+  on(eventName: EventTypes, fn: CallEventHandler): () => void;
   on(
-    eventName: SfuEventKinds | CallEventTypes,
+    eventName: SfuEventKinds | EventTypes,
     fn: SfuEventListener | CallEventHandler,
   ) {
     if (isSfuEvent(eventName)) {
@@ -420,13 +421,6 @@ export class Call {
     this.state.setCallingState(CallingState.LEFT);
   };
 
-  /**
-   * A getter for the call metadata.
-   */
-  get data() {
-    return this.state.metadata;
-  }
-
   /**
    * A flag indicating whether the call is "ringing" type of call.
    */
@@ -445,7 +439,7 @@ export class Call {
    * A flag indicating whether the call was created by the current user.
    */
   get isCreatedByMe() {
-    return this.state.metadata?.created_by.id === this.currentUserId;
+    return this.state.createdBy?.id === this.currentUserId;
   }
 
   /**
@@ -469,7 +463,7 @@ export class Call {
       this.ringingSubject.next(true);
     }
 
-    this.state.setMetadata(response.call);
+    this.state.updateFromCallResponse(response.call);
     this.state.setMembers(response.members);
     this.state.setOwnCapabilities(response.own_capabilities);
 
@@ -496,7 +490,7 @@ export class Call {
       this.ringingSubject.next(true);
     }
 
-    this.state.setMetadata(response.call);
+    this.state.updateFromCallResponse(response.call);
     this.state.setMembers(response.members);
     this.state.setOwnCapabilities(response.own_capabilities);
 
@@ -598,7 +592,7 @@ export class Call {
     let connectionConfig: RTCConfiguration | undefined;
     try {
       const call = await join(this.streamClient, this.type, this.id, data);
-      this.state.setMetadata(call.metadata);
+      this.state.updateFromCallResponse(call.metadata);
       this.state.setMembers(call.members);
       this.state.setOwnCapabilities(call.ownCapabilities);
       connectionConfig = call.connectionConfig;
@@ -815,7 +809,7 @@ export class Call {
       });
     }
 
-    const audioSettings = this.data?.settings.audio;
+    const audioSettings = this.state.settings?.audio;
     const isDtxEnabled = !!audioSettings?.opus_dtx_enabled;
     const isRedEnabled = !!audioSettings?.redundant_coding_enabled;
 
@@ -1516,7 +1510,7 @@ export class Call {
     >(`${this.streamClientBasePath}`, updates);
 
     const { call, members, own_capabilities } = response;
-    this.state.setMetadata(call);
+    this.state.updateFromCallResponse(call);
     this.state.setMembers(members);
     this.state.setOwnCapabilities(own_capabilities);
 
@@ -1617,23 +1611,23 @@ export class Call {
 
   private scheduleAutoDrop = () => {
     if (this.dropTimeout) clearTimeout(this.dropTimeout);
-    const subscription = this.state.metadata$
+    const subscription = this.state.settings$
       .pipe(
         pairwise(),
-        tap(([prevMeta, currentMeta]) => {
-          if (!(currentMeta && this.clientStore.connectedUser)) return;
+        tap(([prevSettings, currentSettings]) => {
+          if (!currentSettings || !this.clientStore.connectedUser) return;
 
           const isOutgoingCall =
-            this.currentUserId === currentMeta.created_by.id;
+            this.currentUserId === this.state.createdBy?.id;
 
           const [prevTimeoutMs, timeoutMs] = isOutgoingCall
             ? [
-                prevMeta?.settings.ring.auto_cancel_timeout_ms,
-                currentMeta.settings.ring.auto_cancel_timeout_ms,
+                prevSettings?.ring.auto_cancel_timeout_ms,
+                currentSettings.ring.auto_cancel_timeout_ms,
               ]
             : [
-                prevMeta?.settings.ring.incoming_call_timeout_ms,
-                currentMeta.settings.ring.incoming_call_timeout_ms,
+                prevSettings?.ring.incoming_call_timeout_ms,
+                currentSettings.ring.incoming_call_timeout_ms,
               ];
           if (
             typeof timeoutMs === 'undefined' ||
@@ -1658,7 +1652,6 @@ export class Call {
 
   /**
    * Retrieves the list of recordings for the current call or call session.
-   * Updates the call state with the returned array of CallRecording objects.
    *
    * If `callSessionId` is provided, it will return the recordings for that call session.
    * Otherwise, all recordings for the current call will be returned.
@@ -1672,13 +1665,9 @@ export class Call {
     if (callSessionId) {
       endpoint = `${endpoint}/${callSessionId}`;
     }
-    const response = await this.streamClient.get<ListRecordingsResponse>(
+    return this.streamClient.get<ListRecordingsResponse>(
       `${endpoint}/recordings`,
     );
-
-    this.state.setCallRecordingsList(response.recordings);
-
-    return response;
   };
 
   /**