@stream-io/video-client 0.0.36 → 0.0.38

package/dist/src/StreamVideoClient.d.ts

@@ -70,9 +70,8 @@ export declare class StreamVideoClient {
      *
      * @param type the type of the call.
      * @param id the id of the call, if not provided a unique random value is used
-     * @param {boolean} [ringing] whether the call should be created in the ringing state.
      */
-    call: (type: string, id: string, ringing?: boolean) => Call;
+    call: (type: string, id: string) => Call;
     /**
      * Creates a new guest user with the given data.
      *
@@ -141,6 +140,12 @@ export declare class StreamVideoClient {
      * @return {string} Returns a token
      */
     createToken(userID: string, exp?: number, iat?: number, call_cids?: string[]): string;
+    /**
+     * A callback that can be used to create ringing calls from push notifications. If the call already exists, it will do nothing.
+     * @param call_cid
+     * @returns
+     */
+    onRingingCall: (call_cid: string) => Promise<Call>;
     /**
      * Connects the given anonymous user to the client.
      *

package/dist/src/gen/coordinator/index.d.ts

@@ -12,10 +12,10 @@ export interface APIError {
     StatusCode: number;
     /**
      * API error code
-     * @type {string}
+     * @type {number}
      * @memberof APIError
      */
-    code: APIErrorCodeEnum;
+    code: number;
     /**
      * Additional error-specific information
      * @type {Array<number>}
@@ -49,44 +49,6 @@ export interface APIError {
      */
     more_info: string;
 }
-/**
- * @export
- */
-export declare const APIErrorCodeEnum: {
-    readonly INTERNAL_ERROR: "internal-error";
-    readonly ACCESS_KEY_ERROR: "access-key-error";
-    readonly INPUT_ERROR: "input-error";
-    readonly AUTH_FAILED: "auth-failed";
-    readonly DUPLICATE_USERNAME: "duplicate-username";
-    readonly RATE_LIMITED: "rate-limited";
-    readonly NOT_FOUND: "not-found";
-    readonly NOT_ALLOWED: "not-allowed";
-    readonly EVENT_NOT_SUPPORTED: "event-not-supported";
-    readonly CHANNEL_FEATURE_NOT_SUPPORTED: "channel-feature-not-supported";
-    readonly MESSAGE_TOO_LONG: "message-too-long";
-    readonly MULTIPLE_NESTING_LEVEL: "multiple-nesting-level";
-    readonly PAYLOAD_TOO_BIG: "payload-too-big";
-    readonly EXPIRED_TOKEN: "expired-token";
-    readonly TOKEN_NOT_VALID_YET: "token-not-valid-yet";
-    readonly TOKEN_USED_BEFORE_IAT: "token-used-before-iat";
-    readonly INVALID_TOKEN_SIGNATURE: "invalid-token-signature";
-    readonly CUSTOM_COMMAND_ENDPOINT_MISSING: "custom-command-endpoint-missing";
-    readonly CUSTOM_COMMAND_ENDPOINTCALL_ERROR: "custom-command-endpoint=call-error";
-    readonly CONNECTION_ID_NOT_FOUND: "connection-id-not-found";
-    readonly COOL_DOWN: "cool-down";
-    readonly QUERY_CHANNEL_PERMISSIONS_MISMATCH: "query-channel-permissions-mismatch";
-    readonly TOO_MANY_CONNECTIONS: "too-many-connections";
-    readonly NOT_SUPPORTED_IN_PUSH_V1: "not-supported-in-push-v1";
-    readonly MODERATION_FAILED: "moderation-failed";
-    readonly VIDEO_PROVIDER_NOT_CONFIGURED: "video-provider-not-configured";
-    readonly VIDEO_INVALID_CALL_ID: "video-invalid-call-id";
-    readonly VIDEO_CREATE_CALL_FAILED: "video-create-call-failed";
-    readonly APP_SUSPENDED: "app-suspended";
-    readonly VIDEO_NO_DATACENTERS_AVAILABLE: "video-no-datacenters-available";
-    readonly VIDEO_JOIN_CALL_FAILURE: "video-join-call-failure";
-    readonly QUERY_CALLS_PERMISSIONS_MISMATCH: "query-calls-permissions-mismatch";
-};
-export type APIErrorCodeEnum = (typeof APIErrorCodeEnum)[keyof typeof APIErrorCodeEnum];
 /**
  *
  * @export
@@ -150,6 +112,12 @@ export interface AudioSettings {
      * @memberof AudioSettings
      */
     access_request_enabled: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AudioSettings
+     */
+    default_device: AudioSettingsDefaultDeviceEnum;
     /**
      *
      * @type {boolean}
@@ -175,6 +143,14 @@ export interface AudioSettings {
      */
     speaker_default_on: boolean;
 }
+/**
+ * @export
+ */
+export declare const AudioSettingsDefaultDeviceEnum: {
+    readonly SPEAKER: "speaker";
+    readonly EARPIECE: "earpiece";
+};
+export type AudioSettingsDefaultDeviceEnum = (typeof AudioSettingsDefaultDeviceEnum)[keyof typeof AudioSettingsDefaultDeviceEnum];
 /**
  *
  * @export
@@ -187,6 +163,12 @@ export interface AudioSettingsRequest {
      * @memberof AudioSettingsRequest
      */
     access_request_enabled?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AudioSettingsRequest
+     */
+    default_device: AudioSettingsRequestDefaultDeviceEnum;
     /**
      *
      * @type {boolean}
@@ -212,6 +194,14 @@ export interface AudioSettingsRequest {
      */
     speaker_default_on?: boolean;
 }
+/**
+ * @export
+ */
+export declare const AudioSettingsRequestDefaultDeviceEnum: {
+    readonly SPEAKER: "speaker";
+    readonly EARPIECE: "earpiece";
+};
+export type AudioSettingsRequestDefaultDeviceEnum = (typeof AudioSettingsRequestDefaultDeviceEnum)[keyof typeof AudioSettingsRequestDefaultDeviceEnum];
 /**
  *
  * @export
@@ -744,12 +734,24 @@ export interface CallParticipantResponse {
      * @memberof CallParticipantResponse
      */
     joined_at: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallParticipantResponse
+     */
+    role: string;
     /**
      *
      * @type {UserResponse}
      * @memberof CallParticipantResponse
      */
     user: UserResponse;
+    /**
+     *
+     * @type {string}
+     * @memberof CallParticipantResponse
+     */
+    user_session_id: string;
 }
 /**
  * This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen
@@ -1196,6 +1198,12 @@ export interface CallSessionParticipantJoinedEvent {
      * @memberof CallSessionParticipantJoinedEvent
      */
     user: UserResponse;
+    /**
+     * The user session ID of the user that joined the call session
+     * @type {string}
+     * @memberof CallSessionParticipantJoinedEvent
+     */
+    user_session_id: string;
 }
 /**
  * This event is sent when a participant leaves a call session
@@ -1233,6 +1241,12 @@ export interface CallSessionParticipantLeftEvent {
      * @memberof CallSessionParticipantLeftEvent
      */
     user: UserResponse;
+    /**
+     * The user session ID of the user that left the call session
+     * @type {string}
+     * @memberof CallSessionParticipantLeftEvent
+     */
+    user_session_id: string;
 }
 /**
  *
@@ -1665,6 +1679,37 @@ export interface ConnectedEvent {
      */
     type: string;
 }
+/**
+ * This event is sent when the WS connection fails
+ * @export
+ * @interface ConnectionErrorEvent
+ */
+export interface ConnectionErrorEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionErrorEvent
+     */
+    connection_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionErrorEvent
+     */
+    created_at: string;
+    /**
+     *
+     * @type {APIError}
+     * @memberof ConnectionErrorEvent
+     */
+    error: APIError | null;
+    /**
+     * The type of event: "connection.ok" in this case
+     * @type {string}
+     * @memberof ConnectionErrorEvent
+     */
+    type: string;
+}
 /**
  *
  * @export
@@ -2986,7 +3031,7 @@ export interface QueryCallsRequest {
      * @type {Array<SortParamRequest>}
      * @memberof QueryCallsRequest
      */
-    sort: Array<SortParamRequest>;
+    sort?: Array<SortParamRequest>;
     /**
      *
      * @type {boolean}
@@ -3044,7 +3089,7 @@ export interface QueryMembersRequest {
      * @type {string}
      * @memberof QueryMembersRequest
      */
-    id?: string;
+    id: string;
     /**
      *
      * @type {number}
@@ -3479,13 +3524,13 @@ export interface SendReactionResponse {
  */
 export interface SortParamRequest {
     /**
-     *
+     * Direction of sorting, -1 for descending, 1 for ascending
      * @type {number}
      * @memberof SortParamRequest
      */
     direction?: number;
     /**
-     *
+     * Name of field to sort by
      * @type {string}
      * @memberof SortParamRequest
      */
@@ -4185,6 +4230,8 @@ export type VideoEvent = ({
 } & CallUpdatedEvent) | ({
     type: 'call.user_muted';
 } & CallUserMuted) | ({
+    type: 'connection.error';
+} & ConnectionErrorEvent) | ({
     type: 'connection.ok';
 } & ConnectedEvent) | ({
     type: 'custom';

package/package.json

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

package/src/StreamVideoClient.ts

@@ -303,15 +303,13 @@ export class StreamVideoClient {
    *
    * @param type the type of the call.
    * @param id the id of the call, if not provided a unique random value is used
-   * @param {boolean} [ringing] whether the call should be created in the ringing state.
    */
-  call = (type: string, id: string, ringing?: boolean) => {
+  call = (type: string, id: string) => {
     return new Call({
       streamClient: this.streamClient,
       id: id,
       type: type,
       clientStore: this.writeableStateStore,
-      ringing,
     });
   };
 
@@ -484,6 +482,33 @@ export class StreamVideoClient {
     return this.streamClient.createToken(userID, exp, iat, call_cids);
   }
 
+  /**
+   * A callback that can be used to create ringing calls from push notifications. If the call already exists, it will do nothing.
+   * @param call_cid
+   * @returns
+   */
+  onRingingCall = async (call_cid: string) => {
+    // if we find the call and is already ringing, we don't need to create a new call
+    // as client would have received the call.ring state because the app had WS alive when receiving push notifications
+    let call = this.readOnlyStateStore.calls.find(
+      (c) => c.cid === call_cid && c.ringing,
+    );
+    if (!call) {
+      // if not it means that WS is not alive when receiving the push notifications and we need to fetch the call
+      const [callType, callId] = call_cid.split(':');
+      call = new Call({
+        streamClient: this.streamClient,
+        type: callType,
+        id: callId,
+        clientStore: this.writeableStateStore,
+        ringing: true,
+      });
+      await call.get();
+    }
+
+    return call;
+  };
+
   /**
    * Connects the given anonymous user to the client.
    *

package/src/events/__tests__/sessions.test.ts

@@ -68,6 +68,7 @@ describe('call.session events', () => {
         id: 'user-id',
         role: 'user',
       },
+      user_session_id: '123',
     });
     expect(state.metadata).toEqual({
       session: {
@@ -78,6 +79,8 @@ describe('call.session events', () => {
               id: 'user-id',
               role: 'user',
             },
+            user_session_id: '123',
+            role: 'user',
           },
         ],
         participants_count_by_role: {
@@ -100,6 +103,7 @@ describe('call.session events', () => {
               id: 'user-id',
               role: 'user',
             },
+            user_session_id: '123',
           },
         ],
         participants_count_by_role: {
@@ -115,6 +119,7 @@ describe('call.session events', () => {
         id: 'user-id',
         role: 'user',
       },
+      user_session_id: '123',
     });
     expect(state.metadata).toEqual({
       session: {

package/src/events/sessions.ts

@@ -33,7 +33,7 @@ export const watchCallSessionEnded = (state: CallState) => {
 export const watchCallSessionParticipantJoined = (state: CallState) => {
   return function onCallParticipantJoined(event: StreamVideoEvent) {
     if (event.type !== 'call.session_participant_joined') return;
-    const { user } = event;
+    const { user, user_session_id } = event;
     state.setMetadata((metadata) => {
       if (!metadata || !metadata.session) {
         state.logger(
@@ -55,6 +55,8 @@ export const watchCallSessionParticipantJoined = (state: CallState) => {
               // FIXME OL: ideally, this comes from the backend
               joined_at: new Date().toISOString(),
               user,
+              role: user.role,
+              user_session_id,
             },
           ],
           participants_count_by_role: {
@@ -75,7 +77,7 @@ export const watchCallSessionParticipantJoined = (state: CallState) => {
 export const watchCallSessionParticipantLeft = (state: CallState) => {
   return function onCallParticipantLeft(event: StreamVideoEvent) {
     if (event.type !== 'call.session_participant_left') return;
-    const { user } = event;
+    const { user, user_session_id } = event;
     state.setMetadata((metadata) => {
       if (!metadata || !metadata.session) {
         state.logger(
@@ -91,7 +93,9 @@ export const watchCallSessionParticipantLeft = (state: CallState) => {
         ...metadata,
         session: {
           ...session,
-          participants: participants.filter((p) => p.user.id !== user.id),
+          participants: participants.filter(
+            (p) => p.user_session_id !== user_session_id,
+          ),
           participants_count_by_role: {
             ...participants_count_by_role,
             [user.role]: Math.max(

package/src/gen/coordinator/index.ts

@@ -14,10 +14,10 @@ export interface APIError {
   StatusCode: number;
   /**
    * API error code
-   * @type {string}
+   * @type {number}
    * @memberof APIError
    */
-  code: APIErrorCodeEnum;
+  code: number;
   /**
    * Additional error-specific information
    * @type {Array<number>}
@@ -49,47 +49,6 @@ export interface APIError {
    */
   more_info: string;
 }
-
-/**
- * @export
- */
-export const APIErrorCodeEnum = {
-  INTERNAL_ERROR: 'internal-error',
-  ACCESS_KEY_ERROR: 'access-key-error',
-  INPUT_ERROR: 'input-error',
-  AUTH_FAILED: 'auth-failed',
-  DUPLICATE_USERNAME: 'duplicate-username',
-  RATE_LIMITED: 'rate-limited',
-  NOT_FOUND: 'not-found',
-  NOT_ALLOWED: 'not-allowed',
-  EVENT_NOT_SUPPORTED: 'event-not-supported',
-  CHANNEL_FEATURE_NOT_SUPPORTED: 'channel-feature-not-supported',
-  MESSAGE_TOO_LONG: 'message-too-long',
-  MULTIPLE_NESTING_LEVEL: 'multiple-nesting-level',
-  PAYLOAD_TOO_BIG: 'payload-too-big',
-  EXPIRED_TOKEN: 'expired-token',
-  TOKEN_NOT_VALID_YET: 'token-not-valid-yet',
-  TOKEN_USED_BEFORE_IAT: 'token-used-before-iat',
-  INVALID_TOKEN_SIGNATURE: 'invalid-token-signature',
-  CUSTOM_COMMAND_ENDPOINT_MISSING: 'custom-command-endpoint-missing',
-  CUSTOM_COMMAND_ENDPOINTCALL_ERROR: 'custom-command-endpoint=call-error',
-  CONNECTION_ID_NOT_FOUND: 'connection-id-not-found',
-  COOL_DOWN: 'cool-down',
-  QUERY_CHANNEL_PERMISSIONS_MISMATCH: 'query-channel-permissions-mismatch',
-  TOO_MANY_CONNECTIONS: 'too-many-connections',
-  NOT_SUPPORTED_IN_PUSH_V1: 'not-supported-in-push-v1',
-  MODERATION_FAILED: 'moderation-failed',
-  VIDEO_PROVIDER_NOT_CONFIGURED: 'video-provider-not-configured',
-  VIDEO_INVALID_CALL_ID: 'video-invalid-call-id',
-  VIDEO_CREATE_CALL_FAILED: 'video-create-call-failed',
-  APP_SUSPENDED: 'app-suspended',
-  VIDEO_NO_DATACENTERS_AVAILABLE: 'video-no-datacenters-available',
-  VIDEO_JOIN_CALL_FAILURE: 'video-join-call-failure',
-  QUERY_CALLS_PERMISSIONS_MISMATCH: 'query-calls-permissions-mismatch',
-} as const;
-export type APIErrorCodeEnum =
-  (typeof APIErrorCodeEnum)[keyof typeof APIErrorCodeEnum];
-
 /**
  *
  * @export
@@ -153,6 +112,12 @@ export interface AudioSettings {
    * @memberof AudioSettings
    */
   access_request_enabled: boolean;
+  /**
+   *
+   * @type {string}
+   * @memberof AudioSettings
+   */
+  default_device: AudioSettingsDefaultDeviceEnum;
   /**
    *
    * @type {boolean}
@@ -178,6 +143,17 @@ export interface AudioSettings {
    */
   speaker_default_on: boolean;
 }
+
+/**
+ * @export
+ */
+export const AudioSettingsDefaultDeviceEnum = {
+  SPEAKER: 'speaker',
+  EARPIECE: 'earpiece',
+} as const;
+export type AudioSettingsDefaultDeviceEnum =
+  (typeof AudioSettingsDefaultDeviceEnum)[keyof typeof AudioSettingsDefaultDeviceEnum];
+
 /**
  *
  * @export
@@ -190,6 +166,12 @@ export interface AudioSettingsRequest {
    * @memberof AudioSettingsRequest
    */
   access_request_enabled?: boolean;
+  /**
+   *
+   * @type {string}
+   * @memberof AudioSettingsRequest
+   */
+  default_device: AudioSettingsRequestDefaultDeviceEnum;
   /**
    *
    * @type {boolean}
@@ -215,6 +197,17 @@ export interface AudioSettingsRequest {
    */
   speaker_default_on?: boolean;
 }
+
+/**
+ * @export
+ */
+export const AudioSettingsRequestDefaultDeviceEnum = {
+  SPEAKER: 'speaker',
+  EARPIECE: 'earpiece',
+} as const;
+export type AudioSettingsRequestDefaultDeviceEnum =
+  (typeof AudioSettingsRequestDefaultDeviceEnum)[keyof typeof AudioSettingsRequestDefaultDeviceEnum];
+
 /**
  *
  * @export
@@ -745,12 +738,24 @@ export interface CallParticipantResponse {
    * @memberof CallParticipantResponse
    */
   joined_at: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallParticipantResponse
+   */
+  role: string;
   /**
    *
    * @type {UserResponse}
    * @memberof CallParticipantResponse
    */
   user: UserResponse;
+  /**
+   *
+   * @type {string}
+   * @memberof CallParticipantResponse
+   */
+  user_session_id: string;
 }
 /**
  * This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen
@@ -1193,6 +1198,12 @@ export interface CallSessionParticipantJoinedEvent {
    * @memberof CallSessionParticipantJoinedEvent
    */
   user: UserResponse;
+  /**
+   * The user session ID of the user that joined the call session
+   * @type {string}
+   * @memberof CallSessionParticipantJoinedEvent
+   */
+  user_session_id: string;
 }
 /**
  * This event is sent when a participant leaves a call session
@@ -1230,6 +1241,12 @@ export interface CallSessionParticipantLeftEvent {
    * @memberof CallSessionParticipantLeftEvent
    */
   user: UserResponse;
+  /**
+   * The user session ID of the user that left the call session
+   * @type {string}
+   * @memberof CallSessionParticipantLeftEvent
+   */
+  user_session_id: string;
 }
 /**
  *
@@ -1650,6 +1667,37 @@ export interface ConnectedEvent {
    */
   type: string;
 }
+/**
+ * This event is sent when the WS connection fails
+ * @export
+ * @interface ConnectionErrorEvent
+ */
+export interface ConnectionErrorEvent {
+  /**
+   *
+   * @type {string}
+   * @memberof ConnectionErrorEvent
+   */
+  connection_id: string;
+  /**
+   *
+   * @type {string}
+   * @memberof ConnectionErrorEvent
+   */
+  created_at: string;
+  /**
+   *
+   * @type {APIError}
+   * @memberof ConnectionErrorEvent
+   */
+  error: APIError | null;
+  /**
+   * The type of event: "connection.ok" in this case
+   * @type {string}
+   * @memberof ConnectionErrorEvent
+   */
+  type: string;
+}
 /**
  *
  * @export
@@ -2958,7 +3006,7 @@ export interface QueryCallsRequest {
    * @type {Array<SortParamRequest>}
    * @memberof QueryCallsRequest
    */
-  sort: Array<SortParamRequest>;
+  sort?: Array<SortParamRequest>;
   /**
    *
    * @type {boolean}
@@ -3014,7 +3062,7 @@ export interface QueryMembersRequest {
    * @type {string}
    * @memberof QueryMembersRequest
    */
-  id?: string;
+  id: string;
   /**
    *
    * @type {number}
@@ -3453,13 +3501,13 @@ export interface SendReactionResponse {
  */
 export interface SortParamRequest {
   /**
-   *
+   * Direction of sorting, -1 for descending, 1 for ascending
    * @type {number}
    * @memberof SortParamRequest
    */
   direction?: number;
   /**
-   *
+   * Name of field to sort by
    * @type {string}
    * @memberof SortParamRequest
    */
@@ -4135,6 +4183,7 @@ export type VideoEvent =
   | ({ type: 'call.unblocked_user' } & UnblockedUserEvent)
   | ({ type: 'call.updated' } & CallUpdatedEvent)
   | ({ type: 'call.user_muted' } & CallUserMuted)
+  | ({ type: 'connection.error' } & ConnectionErrorEvent)
   | ({ type: 'connection.ok' } & ConnectedEvent)
   | ({ type: 'custom' } & CustomVideoEvent)
   | ({ type: 'health.check' } & HealthCheckEvent);