@signalwire/js - npm Package Compare versions

Comparing version 3.24.0 to 3.25.0

dist/core/src/rooms/methods.d.ts

@@ -82,2 +82,3 @@ import { type BaseRoomInterface, type RoomSessionRecording, type RoomSessionPlayback, type RoomSessionStream } from '.';
 export declare const startStream: RoomMethodDescriptor<any, StartStreamParams>;
+export declare const setPrioritizeHandraise: RoomMethodDescriptor<any, boolean>;
 export declare type GetLayouts = ReturnType<typeof getLayouts.value>;
@@ -100,2 +101,3 @@ export declare type GetMembers = ReturnType<typeof getMembers.value>;
 export declare type Unlock = ReturnType<typeof unlock.value>;
+export declare type SetPrioritizeHandraise = ReturnType<typeof setPrioritizeHandraise.value>;
 /**
@@ -149,2 +151,10 @@ * Room Member Methods
 export declare const deleteMemberMeta: RoomMethodDescriptor<void, RoomMemberMethodParams>;
+export interface SetRaisedHandRoomParams {
+    memberId: string;
+    raised?: boolean;
+}
+export interface SetRaisedHandMemberParams {
+    raised?: boolean;
+}
+export declare const setRaisedHand: RoomMethodDescriptor<void, SetRaisedHandRoomParams | SetRaisedHandMemberParams>;
 export declare type AudioMuteMember = ReturnType<typeof audioMuteMember.value>;
@@ -171,3 +181,4 @@ export declare type AudioUnmuteMember = ReturnType<typeof audioUnmuteMember.value>;
 export declare type DemoteMember = ReturnType<typeof demote.value>;
+export declare type SetRaisedHand = ReturnType<typeof setRaisedHand.value>;
 export {};
 //# sourceMappingURL=methods.d.ts.map

dist/core/src/types/index.d.ts

@@ -108,2 +108,12 @@ import type { EventEmitter } from '../utils/EventEmitter';
     setLocalStream(stream: MediaStream): Promise<MediaStream>;
+    /**
+     * Send DTMF
+     * @param {string} dtmf
+     *
+     * @example
+     * ```typescript
+     * room.sendDigits('1')
+     * ```
+     */
+    sendDigits(dtmf: string): Promise<void>;
     /** @internal */
@@ -110,0 +120,0 @@ stopOutboundAudio(): void;

dist/core/src/types/videoMember.d.ts

@@ -47,3 +47,3 @@ import type { SwEvent, VideoPosition } from '.';
  */
-export declare type MemberUpdatedEventNames = typeof MEMBER_UPDATED_EVENTS[number];
+export declare type MemberUpdatedEventNames = (typeof MEMBER_UPDATED_EVENTS)[number];
 export declare type MemberTalkingStarted = 'member.talking.started';
@@ -66,3 +66,3 @@ export declare type MemberTalkingEnded = 'member.talking.ended';
 export declare type VideoMemberEventNames = MemberJoined | MemberLeft | MemberUpdated | MemberUpdatedEventNames | MemberTalkingEventNames | MemberListUpdated;
-export declare type InternalMemberUpdatedEventNames = typeof INTERNAL_MEMBER_UPDATED_EVENTS[number];
+export declare type InternalMemberUpdatedEventNames = (typeof INTERNAL_MEMBER_UPDATED_EVENTS)[number];
 /**
@@ -99,2 +99,4 @@ * List of internal events
     meta?: Record<string, unknown>;
+    /** Indicate if the member hand is raised or not */
+    handraised: Boolean;
     /**
@@ -226,2 +228,11 @@ * Mutes the outbound audio for this member (e.g., the one coming from a
     remove(): Rooms.RemoveMember;
+    /**
+     * Raise or lower this member's hand.
+     *
+     * @example
+     * ```typescript
+     * await member.setRaisedHand()
+     * ```
+     */
+    setRaisedHand(params?: Rooms.SetRaisedHandMemberParams): Rooms.SetRaisedHand;
 }
@@ -228,0 +239,0 @@ /**

dist/core/src/types/videoRoomSession.d.ts

@@ -75,2 +75,4 @@ import type { BaseConnectionContract, SwEvent } from '.';
     streams?: Rooms.RoomSessionStream[];
+    /** Prioritize the hand raise for the layout */
+    prioritizeHandraise: Boolean;
     /**
@@ -697,2 +699,40 @@ * Puts the microphone on mute. The other participants will not hear audio
     unlock(): Rooms.Unlock;
+    /**
+     * Set the priority of members hand raise
+     * @param param a boolean flag to enable/disable the hand raise prioritization
+     *
+     * @permissions
+     *  - `video.prioritize_handraise`: to set the hand raise priority
+     *
+     * You need to specify the permissions when [creating the Video Room
+     * Token](https://developer.signalwire.com/apis/reference/create_room_token)
+     * on the server side.
+     *
+     * @example
+     * ```typescript
+     * await room.setPrioritizeHandraise(true)
+     * ```
+     */
+    setPrioritizeHandraise(params: boolean): Rooms.SetPrioritizeHandraise;
+    /**
+     * Raise or lower the hand of a specific participant in the room.
+     * @param params
+     * @param params.memberId id of the member to remove
+     * @param params.raised boolean flag to raise or lower the hand
+     *
+     * @permissions
+     *  - `video.member.raisehand`: to raise a hand
+     *  - `video.member.lowerhand`: to lower a hand
+     *
+     * You need to specify the permissions when [creating the Video Room
+     * Token](https://developer.signalwire.com/apis/reference/create_room_token)
+     * on the server side.
+     *
+     * @example
+     * ```typescript
+     * const id = 'de550c0c-3fac-4efd-b06f-b5b8614b8966'  // you can get this from getMembers()
+     * await room.setHandRaised({ memberId: id, raised: false })
+     * ```
+     */
+    setRaisedHand(params: Rooms.SetRaisedHandRoomParams): Rooms.SetRaisedHand;
 }
@@ -734,2 +774,3 @@ /**
     streams?: any[];
+    prioritize_handraise: boolean;
 };
@@ -736,0 +777,0 @@ /**

dist/core/src/types/voiceCall.d.ts

@@ -721,2 +721,3 @@ import type { SwEvent } from '.';
 export declare type CallingCallCollectEndState = Exclude<CallingCallCollectResult['type'], 'start_of_input'>;
+export declare type CallingCallCollectState = 'error' | 'collecting' | 'finished';
 export interface CallingCallCollectEventParams {
@@ -728,2 +729,3 @@ node_id: string;
     final?: boolean;
+    state?: CallingCallCollectState;
 }
@@ -730,0 +732,0 @@ export interface CallingCallCollectEvent extends SwEvent {

dist/core/src/utils/interfaces.d.ts

@@ -180,3 +180,3 @@ /// <reference types="node" />
  */
-export declare type RoomMethod = 'video.room.get' | 'video.rooms.get' | 'video.list_available_layouts' | 'video.hide_video_muted' | 'video.show_video_muted' | 'video.members.get' | 'video.member.audio_mute' | 'video.member.audio_unmute' | 'video.member.video_mute' | 'video.member.video_unmute' | 'video.member.deaf' | 'video.member.undeaf' | 'video.member.set_input_volume' | 'video.member.set_output_volume' | 'video.member.set_input_sensitivity' | 'video.member.set_position' | 'video.member.remove' | 'video.member.get_meta' | 'video.member.set_meta' | 'video.member.update_meta' | 'video.member.delete_meta' | 'video.get_meta' | 'video.set_meta' | 'video.update_meta' | 'video.delete_meta' | 'video.set_layout' | 'video.set_position' | 'video.recording.list' | 'video.recording.start' | 'video.recording.stop' | 'video.recording.pause' | 'video.recording.resume' | 'video.playback.list' | 'video.playback.start' | 'video.playback.pause' | 'video.playback.resume' | 'video.playback.stop' | 'video.playback.set_volume' | 'video.playback.seek_absolute' | 'video.playback.seek_relative' | 'video.member.demote' | 'video.member.promote' | 'video.stream.list' | 'video.stream.start' | 'video.stream.stop' | 'video.lock' | 'video.unlock';
+export declare type RoomMethod = 'video.room.get' | 'video.rooms.get' | 'video.list_available_layouts' | 'video.hide_video_muted' | 'video.show_video_muted' | 'video.members.get' | 'video.member.audio_mute' | 'video.member.audio_unmute' | 'video.member.video_mute' | 'video.member.video_unmute' | 'video.member.deaf' | 'video.member.undeaf' | 'video.member.set_input_volume' | 'video.member.set_output_volume' | 'video.member.set_input_sensitivity' | 'video.member.set_position' | 'video.member.remove' | 'video.member.get_meta' | 'video.member.set_meta' | 'video.member.update_meta' | 'video.member.delete_meta' | 'video.get_meta' | 'video.set_meta' | 'video.update_meta' | 'video.delete_meta' | 'video.set_layout' | 'video.set_position' | 'video.recording.list' | 'video.recording.start' | 'video.recording.stop' | 'video.recording.pause' | 'video.recording.resume' | 'video.playback.list' | 'video.playback.start' | 'video.playback.pause' | 'video.playback.resume' | 'video.playback.stop' | 'video.playback.set_volume' | 'video.playback.seek_absolute' | 'video.playback.seek_relative' | 'video.member.demote' | 'video.member.promote' | 'video.stream.list' | 'video.stream.start' | 'video.stream.stop' | 'video.lock' | 'video.unlock' | 'video.member.raisehand' | 'video.member.lowerhand' | 'video.prioritize_handraise';
 export interface WebSocketClient {
@@ -183,0 +183,0 @@ addEventListener: WebSocket['addEventListener'];

dist/js/src/utils/interfaces.d.ts

@@ -33,2 +33,4 @@ import type { Rooms, BaseConnectionState, InternalVideoLayout, VideoLayoutEventNames, VideoRoomSessionEventNames, VideoRoomEventParams, InternalVideoMemberEntity, InternalVideoMemberEntityUpdated, VideoMemberEventNames, MemberUpdated, MemberUpdatedEventNames, MemberTalkingEventNames, VideoMemberTalkingEventParams, RTCTrackEventName, VideoRecordingEventNames, VideoPlaybackEventNames, RoomSessionRecording, RoomSessionPlayback, VideoRoomSessionContract, OnlyFunctionProperties, MemberListUpdated, VideoPositions, RoomAudienceCount, VideoRoomAudienceCountEventParams, RoomLeft, RoomLeftEventParams, VideoStreamEventNames, RoomSessionStream, RoomJoined, RoomSubscribed, VideoRoomSubscribedEventParams, VideoAuthorization, VideoRoomDeviceUpdatedEventNames, DeviceUpdatedEventParams, VideoRoomDeviceDisconnectedEventNames, DeviceDisconnectedEventParams, VideoRoomDeviceEventNames } from '@signalwire/core';
     member: VideoMemberEntityUpdated;
+    room_id?: string;
+    room_session_id?: string;
 };
@@ -35,0 +37,0 @@ export declare type VideoMemberListUpdatedParams = {

dist/webrtc/src/BaseConnection.d.ts

@@ -136,5 +136,4 @@ import { BaseComponent, BaseComponentOptions, BaseConnectionState, Rooms, EventEmitter, BaseConnectionContract, WebRTCMethod } from '@signalwire/core';
     hangupAll(): Promise<void>;
+    sendDigits(dtmf: string): Promise<void>;
     /** @internal */
-    dtmf(dtmf: string): void;
-    /** @internal */
     doReinviteWithRelayOnly(): void;
@@ -141,0 +140,0 @@ /** @internal */

package.json

@@ -6,3 +6,3 @@ {
   "license": "MIT",
-  "version": "3.24.0",
+  "version": "3.25.0",
   "main": "dist/index.js",
@@ -43,4 +43,4 @@ "module": "dist/index.esm.js",
   "dependencies": {
-    "@signalwire/core": "3.20.0",
-    "@signalwire/webrtc": "3.10.4",
+    "@signalwire/core": "3.21.0",
+    "@signalwire/webrtc": "3.11.0",
     "jwt-decode": "^3.1.2"
@@ -47,0 +47,0 @@ },

src/BaseRoomSession.ts

@@ -495,2 +495,4 @@ import {
   unlock: Rooms.unlock,
+  setRaisedHand: Rooms.setRaisedHand,
+  setPrioritizeHandraise: Rooms.setPrioritizeHandraise,
 })
@@ -497,0 +499,0 @@

src/utils/interfaces.ts

@@ -80,2 +80,4 @@ import type {
   member: VideoMemberEntityUpdated
+  room_id?: string
+  room_session_id?: string
 }
@@ -82,0 +84,0 @@ export type VideoMemberListUpdatedParams = { members: VideoMemberEntity[] }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2545424

increased by0.27%

Number of downloads

737

increased by7.91%

Lines of code

24152

increased by0.36%

Published versions last months

5

increased by25%

Dependency changes

• + Added@signalwire/core@3.21.0(transitive)

• + Added@signalwire/webrtc@3.11.0(transitive)

• - Removed@signalwire/core@3.20.0(transitive)

• - Removed@signalwire/webrtc@3.10.4(transitive)

• Updated@signalwire/core@3.21.0

• Updated@signalwire/webrtc@3.11.0