@signalwire/realtime-api - npm Package Compare versions

Comparing version 4.0.0 to 4.0.1-dev.202404301530.94a97d7.0

dist/core/src/BaseComponent.d.ts

@@ -48,4 +48,8 @@ import type { Task } from '@redux-saga/types';
             remove: (key: string) => Map<string, unknown>;
+            getAll: () => [string, unknown][];
+            deleteAll: () => Map<string, unknown>;
         };
+        callSegments: import("./types").CallSegmentContract[];
         sessionEmitter: EventEmitter<import("./utils/interfaces").ClientEvents, any>;
+        unifiedEventing: boolean | undefined;
         dispatch: import("redux").Dispatch<import("redux").AnyAction>;
@@ -62,4 +66,10 @@ getState(): any;
         remove: (key: string) => Map<string, unknown>;
+        getAll: () => [string, unknown][];
+        deleteAll: () => Map<string, unknown>;
     };
     /** @internal */
+    get callSegments(): import("./types").CallSegmentContract[];
+    /** @internal */
+    get unifiedEventing(): boolean | undefined;
+    /** @internal */
     get emitter(): EventEmitter<EventTypes, any>;
@@ -66,0 +76,0 @@ /** @internal */

dist/core/src/BaseSession.d.ts

 import { SWCloseEvent } from './utils';
+import { RPCConnectParams } from './RPCMessages';
 import { SessionOptions, RPCConnectResult, JSONRPCRequest, JSONRPCResponse, WebSocketAdapter, NodeSocketAdapter, WebSocketClient, SessionStatus, SessionAuthError } from './utils/interfaces';
@@ -20,2 +21,3 @@ import { SwAuthorizationState } from '.';
     reauthenticate?(): Promise<void>;
+    unifiedEventing: boolean;
     protected _rpcConnectResult: RPCConnectResult;
@@ -77,2 +79,3 @@ private _requests;
     execute(msg: JSONRPCRequest | JSONRPCResponse): Promise<any>;
+    protected get _connectParams(): RPCConnectParams;
     /**
@@ -79,0 +82,0 @@ * Authenticate with the SignalWire Network

dist/core/src/index.d.ts

@@ -1,2 +0,2 @@
-import { uuid, setLogger, getLogger, isGlobalEvent, toExternalJSON, fromSnakeToCamelCase, toSnakeCaseKeys, toLocalEvent, toSyntheticEvent, extendComponent, validateEventsToSubscribe, toInternalEventName, toInternalAction, timeoutPromise, debounce, SWCloseEvent, isSATAuth, LOCAL_EVENT_PREFIX, stripNamespacePrefix } from './utils';
+import { uuid, setLogger, getLogger, isGlobalEvent, toExternalJSON, fromSnakeToCamelCase, toSnakeCaseKeys, toLocalEvent, toSyntheticEvent, extendComponent, validateEventsToSubscribe, toInternalEventName, toInternalAction, timeoutPromise, debounce, SWCloseEvent, isSATAuth, LOCAL_EVENT_PREFIX, stripNamespacePrefix, isJSONRPCRequest, isJSONRPCResponse } from './utils';
 import { WEBRTC_EVENT_TYPES, isWebrtcEventType } from './utils/common';
@@ -13,3 +13,3 @@ import { BaseSession } from './BaseSession';
 import { MEMBER_UPDATED_EVENTS, INTERNAL_MEMBER_UPDATED_EVENTS } from './types/videoMember';
-export { uuid, setLogger, getLogger, BaseSession, BaseJWTSession, BaseComponent, BaseConsumer, BaseClient, connect, configureStore, EventEmitter, extendComponent, validateEventsToSubscribe, getEventEmitter, isGlobalEvent, toExternalJSON, fromSnakeToCamelCase, toSnakeCaseKeys, toLocalEvent, toInternalEventName, toInternalAction, toSyntheticEvent, GLOBAL_VIDEO_EVENTS, MEMBER_UPDATED_EVENTS, INTERNAL_MEMBER_UPDATED_EVENTS, findNamespaceInPayload, timeoutPromise, debounce, SWCloseEvent, WEBRTC_EVENT_TYPES, isWebrtcEventType, isSATAuth, LOCAL_EVENT_PREFIX, stripNamespacePrefix, };
+export { uuid, setLogger, getLogger, BaseSession, BaseJWTSession, BaseComponent, BaseConsumer, BaseClient, connect, configureStore, EventEmitter, extendComponent, validateEventsToSubscribe, getEventEmitter, isGlobalEvent, toExternalJSON, fromSnakeToCamelCase, toSnakeCaseKeys, toLocalEvent, toInternalEventName, toInternalAction, toSyntheticEvent, GLOBAL_VIDEO_EVENTS, MEMBER_UPDATED_EVENTS, INTERNAL_MEMBER_UPDATED_EVENTS, findNamespaceInPayload, timeoutPromise, debounce, SWCloseEvent, WEBRTC_EVENT_TYPES, isWebrtcEventType, isSATAuth, isJSONRPCRequest, isJSONRPCResponse, LOCAL_EVENT_PREFIX, stripNamespacePrefix, };
 export * from './redux/features/component/componentSlice';
@@ -33,3 +33,3 @@ export * from './redux/features/session/sessionSlice';
 export * as MemberPosition from './memberPosition';
-export type { RoomSessionRecording, RoomSessionPlayback, RoomSessionStream, } from './rooms';
+export type { RoomSessionRecording, RoomSessionPlayback, RoomSessionStream, RoomSessionMember, } from './rooms';
 export declare const selectors: {
@@ -45,2 +45,3 @@ getIceServers: ({ session }: import("./redux/interfaces").SDKState) => RTCIceServer[];
 export * as testUtils from './testUtils';
+export * from './utils/mapObject';
 //# sourceMappingURL=index.d.ts.map

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

@@ -5,2 +5,3 @@ import { Saga, Task } from '@redux-saga/core';
 import { InternalUserOptions, SessionConstructor, InternalChannels } from '../utils/interfaces';
+import { CallSegmentContract } from '../types/callSegment';
 export interface ConfigureStoreOptions {
@@ -24,4 +25,8 @@ userOptions: InternalUserOptions;
         remove: (key: string) => Map<string, unknown>;
+        getAll: () => [string, unknown][];
+        deleteAll: () => Map<string, unknown>;
     };
+    callSegments: CallSegmentContract[];
     sessionEmitter: import("eventemitter3").EventEmitter<import("../utils/interfaces").ClientEvents, any>;
+    unifiedEventing: boolean | undefined;
     dispatch: import("redux").Dispatch<import("redux").AnyAction>;
@@ -28,0 +33,0 @@ getState(): any;

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

@@ -76,2 +76,4 @@ import type { Channel, SagaIterator } from '@redux-saga/types';
     error: SessionAuthError;
+}> | PayloadAction<{
+    token: string;
 }> | PayloadAction<SessionAuthStatus>;
@@ -78,0 +80,0 @@ export declare type SwEventChannel = MulticastChannel<MapToPubSubShape<SwEventParams>>;

dist/core/src/redux/utils/useInstanceMap.d.ts

@@ -5,3 +5,5 @@ export declare const useInstanceMap: () => {
     remove: (key: string) => Map<string, unknown>;
+    getAll: () => [string, unknown][];
+    deleteAll: () => Map<string, unknown>;
 };
 //# sourceMappingURL=useInstanceMap.d.ts.map

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

@@ -11,2 +11,3 @@ import { BaseComponent, EventEmitter } from '..';
 export * from './RoomSessionStream';
+export * from './RoomSessionMember';
 //# sourceMappingURL=index.d.ts.map

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

 import { type BaseRoomInterface, type RoomSessionRecording, type RoomSessionPlayback, type RoomSessionStream } from '.';
 import type { VideoMemberEntity, MemberCommandParams, VideoPosition } from '../types';
 import type { MediaAllowed, VideoMeta } from '../utils/interfaces';
-declare type RoomMethodParams = Record<string, unknown>;
+export declare type RoomMethodParams = Record<string, unknown>;
 interface RoomMethodPropertyDescriptor<OutputType, ParamsType> extends PropertyDescriptor {
@@ -14,3 +14,3 @@ value: (params: ParamsType) => Promise<OutputType>;
  */
-interface RoomMemberMethodParams extends Record<string, unknown> {
+export interface RoomMemberMethodParams extends Record<string, unknown> {
     memberId?: string;
@@ -17,0 +17,0 @@ }

dist/core/src/RPCMessages/RPCConnect.d.ts

@@ -20,2 +20,3 @@ declare type WithToken = {
     topics?: string[];
+    eventing?: string[];
     event_acks?: boolean;
@@ -28,2 +29,7 @@ };
 };
+export declare const UNIFIED_CONNECT_VERSION: {
+    major: number;
+    minor: number;
+    revision: number;
+};
 export declare const RPCConnect: (params: RPCConnectParams) => {
@@ -37,3 +43,11 @@ id: string;
 };
+export declare const RPCConnectUnified: (params: RPCConnectParams) => {
+    id: string;
+    method: import("..").JSONRPCMethod;
+    params: {
+        [key: string]: any;
+    };
+    jsonrpc: "2.0";
+};
 export {};
 //# sourceMappingURL=RPCConnect.d.ts.map

dist/core/src/testUtils.d.ts

@@ -23,4 +23,8 @@ /// <reference types="jest" />
         remove: (key: string) => Map<string, unknown>;
+        getAll: () => [string, unknown][];
+        deleteAll: () => Map<string, unknown>;
     };
+    callSegments: import(".").CallSegmentContract[];
     sessionEmitter: EventEmitter<import(".").ClientEvents, any>;
+    unifiedEventing: boolean | undefined;
     dispatch: import("redux").Dispatch<import("redux").AnyAction>;
@@ -50,4 +54,8 @@ getState(): any;
             remove: (key: string) => Map<string, unknown>;
+            getAll: () => [string, unknown][];
+            deleteAll: () => Map<string, unknown>;
         };
+        callSegments: import(".").CallSegmentContract[];
         sessionEmitter: EventEmitter<import(".").ClientEvents, any>;
+        unifiedEventing: boolean | undefined;
         dispatch: import("redux").Dispatch<import("redux").AnyAction>;
@@ -54,0 +62,0 @@ getState(): any;

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

@@ -1,18 +0,7 @@
-export interface FetchAddressResponse {
-    data: Array<{
-        display_name: string;
-        name: string;
-        preview_url?: string;
-        cover_url?: string;
-        resource_id: string;
-        type: string;
-        channels: {
-            audio?: string;
-            messaging?: string;
-            video?: string;
-        };
-    }> | [];
+import { CallState, CallConnect, CallPlay, InternalVideoRoomSessionEntity, MapToPubSubShape, SwEvent, CallEnded, CallRecord, ToInternalVideoEvent, VideoMemberEvent, VideoLayoutEvent } from '..';
+export interface PaginatedResponse<T> {
+    data: Array<T> | [];
     links: {
-        first: string;
-        self: string;
+        first?: string;
+        self?: string;
         next?: string;
@@ -22,6 +11,338 @@ prev?: string;
 }
+export interface PaginatedResult<T> {
+    data: Array<T> | [];
+    self(): Promise<PaginatedResult<T> | undefined>;
+    nextPage(): Promise<PaginatedResult<T> | undefined>;
+    prevPage(): Promise<PaginatedResult<T> | undefined>;
+    firstPage(): Promise<PaginatedResult<T> | undefined>;
+    hasNext: boolean;
+    hasPrev: boolean;
+}
+/**
+ * Addresses
+ */
+export interface Address {
+    id: string;
+    display_name: string;
+    name: string;
+    preview_url?: string;
+    cover_url?: string;
+    resource_id: string;
+    type: string;
+    channels: {
+        audio?: string;
+        messaging?: string;
+        video?: string;
+    };
+}
 export interface GetAddressesOptions {
     type?: string;
     displayName?: string;
+    pageSize?: number;
 }
+export interface GetAddressOptions {
+    id: string;
+}
+export interface GetAddressResponse extends Address {
+}
+export interface FetchAddressResponse extends PaginatedResponse<Address> {
+}
+/**
+ * Conversations
+ */
+export interface SendConversationMessageOptions {
+    text: string;
+    addressId: string;
+    metadata?: Record<string, any>;
+    details?: Record<string, any>;
+}
+export interface GetConversationsOptions {
+    pageSize?: number;
+}
+export interface Conversation {
+    created_at: number;
+    id: string;
+    last_message_at: number;
+    metadata: Record<string, any>;
+    name: string;
+    sendMessage(options: {
+        text: string;
+    }): Promise<SendConversationMessageResponse>;
+    getMessages(options: {
+        pageSize?: number;
+    }): Promise<PaginatedResult<ConversationMessage>>;
+}
+export interface SendConversationMessageResponse {
+    table: {
+        conversation_id: string;
+        text: string;
+    };
+}
+export interface FetchConversationsResponse extends PaginatedResponse<Conversation> {
+}
+/**
+ * Conversation Messages
+ */
+export interface GetMessagesOptions {
+    pageSize?: number;
+}
+export interface ConversationMessage {
+    id: string;
+    conversation_id: string;
+    user_id: string;
+    ts: number;
+    details: Record<string, any>;
+    type: string;
+    subtype: string;
+    kind: string;
+}
+export interface FetchConversationMessagesResponse extends PaginatedResponse<ConversationMessage> {
+}
+export interface GetConversationMessagesOptions {
+    addressId: string;
+    pageSize?: number;
+}
+/**
+ * Subsriber info
+ */
+export interface SubscriberInfoResponse {
+    id: string;
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    display_name?: string;
+    job_title?: string;
+    time_zone?: number;
+    country?: string;
+    region?: string;
+    company_name?: string;
+    push_notification_key: string;
+    app_settings?: {
+        display_name: string;
+        scopes: string[];
+    };
+}
+/**
+ * Device registration
+ */
+export declare type RegisterDeviceType = 'iOS' | 'Android' | 'Desktop';
+export interface RegisterDeviceParams {
+    deviceType: RegisterDeviceType;
+    deviceToken: string;
+}
+export interface UnregisterDeviceParams {
+    id: string;
+}
+export interface RegisterDeviceResponse {
+    date_registered: Date;
+    device_name?: string;
+    device_token: string;
+    device_type: RegisterDeviceType;
+    id: string;
+    push_notification_key: string;
+}
+export declare type CallJoined = 'call.joined';
+export declare type CallStarted = 'call.started';
+export declare type CallUpdated = 'call.updated';
+export declare type CallLeft = 'call.left';
+export declare type CallStream = 'call.stream';
+export declare type CallStates = 'created' | 'ringing' | 'answered' | 'ending' | 'ended';
+export declare type CallConnectStates = 'connecting' | 'connected';
+export declare type CallDirections = 'inbound' | 'outbound';
+export declare type CallDeviceTypes = 'webrtc' | 'sip' | 'phone';
+export declare type CallPlayState = 'playing' | 'paused' | 'finished';
+export declare type CallRecordState = 'recording' | 'paused' | 'finished';
+export declare type CallStreamState = 'streaming' | 'completed';
+interface CallDeviceCommonParams {
+    headers?: any[];
+}
+export interface CallDeviceWebRTCOrSIPParams extends CallDeviceCommonParams {
+    from: string;
+    to: string;
+}
+export interface CallDevicePhoneParams extends CallDeviceCommonParams {
+    from_number: string;
+    to_number: string;
+}
+export interface CallDeviceWebRTCOrSIP {
+    type: 'webrtc' | 'sip';
+    params: CallDeviceWebRTCOrSIPParams;
+}
+export interface CallDevicePhone {
+    type: 'phone';
+    params: CallDevicePhoneParams;
+}
+export declare type CallDevice = CallDeviceWebRTCOrSIP | CallDevicePhone;
+/**
+ * Call Joined - call.joined
+ */
+export interface CallJoinedEventParams {
+    room_id: string;
+    room_session_id: string;
+    call_id: string;
+    member_id: string;
+    node_id: string;
+    room_session: InternalVideoRoomSessionEntity;
+}
+export interface CallJoinedEvent extends SwEvent {
+    event_type: CallJoined;
+    params: CallJoinedEventParams;
+}
+/**
+ * Call State - call.state
+ */
+export interface CallStateEventParams {
+    call_id: string;
+    node_id: string;
+    segment_id: string;
+    call_state: CallStates;
+    direction: CallDirections;
+    device: CallDevice;
+    start_time: number;
+    answer_time: number;
+    end_time: number;
+}
+export interface CallStateEvent extends SwEvent {
+    event_type: CallState;
+    params: CallStateEventParams;
+}
+/**
+ * Call Started - call.started
+ */
+export interface CallStartedEventParams {
+    call_id: string;
+    node_id: string;
+    segment_id: string;
+    call_state: CallStates;
+    direction: CallDirections;
+    device: CallDevice;
+    start_time: number;
+    answer_time: number;
+    end_time: number;
+}
+export interface CallStartedEvent extends SwEvent {
+    event_type: CallStarted;
+    params: CallStartedEventParams;
+}
+/**
+ * Call Updated - call.updated
+ */
+export interface CallUpdatedEventParams {
+    call_id: string;
+    node_id: string;
+    segment_id: string;
+    call_state: CallStates;
+    direction: CallDirections;
+    device: CallDevice;
+    start_time: number;
+    answer_time: number;
+    end_time: number;
+}
+export interface CallUpdatedEvent extends SwEvent {
+    event_type: CallUpdated;
+    params: CallUpdatedEventParams;
+}
+/**
+ * Call Ended - call.ended
+ */
+export interface CallEndedEventParams {
+    call_id: string;
+    node_id: string;
+    segment_id: string;
+    call_state: CallStates;
+    direction: CallDirections;
+    device: CallDevice;
+    start_time: number;
+    answer_time: number;
+    end_time: number;
+}
+export interface CallEndedEvent extends SwEvent {
+    event_type: CallEnded;
+    params: CallEndedEventParams;
+}
+/**
+ * Call Left - call.left
+ */
+export interface CallLeftEventParams {
+    room_id: string;
+    room_session_id: string;
+    call_id: string;
+    member_id: string;
+    node_id: string;
+    room_session: InternalVideoRoomSessionEntity;
+}
+export interface CallLeftEvent extends SwEvent {
+    event_type: CallLeft;
+    params: CallLeftEventParams;
+}
+/**
+ * Call Play - call.play
+ */
+export interface CallPlayEventParams {
+    control_id: string;
+    call_id: string;
+    node_id: string;
+    state: CallPlayState;
+}
+export interface CallPlayEvent extends SwEvent {
+    event_type: CallPlay;
+    params: CallPlayEventParams;
+}
+/**
+ * Call Record - call.record
+ */
+export interface CallRecordEventParams {
+    control_id: string;
+    call_id: string;
+    node_id: string;
+    state: CallRecordState;
+}
+export interface CallRecordEvent extends SwEvent {
+    event_type: CallRecord;
+    params: CallRecordEventParams;
+}
+/**
+ * Call Stream - call.stream
+ */
+export interface CallStreamEventParams {
+    control_id: string;
+    call_id: string;
+    node_id: string;
+    state: CallStreamState;
+}
+export interface CallStreamEvent extends SwEvent {
+    event_type: CallStream;
+    params: CallStreamEventParams;
+}
+/**
+ * Call Connect - call.connect
+ */
+export interface CallConnectEventParams {
+    connect_state: CallConnectStates;
+    peer?: {
+        call_id: string;
+        node_id: string;
+        device: CallDevice;
+    };
+    call_id: string;
+    node_id: string;
+    segment_id: string;
+}
+export interface CallConnectEvent extends SwEvent {
+    event_type: CallConnect;
+    params: CallConnectEventParams;
+}
+declare type UndoToInternalVideoEvent<T> = T extends ToInternalVideoEvent<infer U> ? U : T;
+declare type AdjustEventType<T> = T extends {
+    event_type: infer ET;
+    params: infer P;
+} ? {
+    event_type: UndoToInternalVideoEvent<ET>;
+    params: P;
+} : T;
+export declare type CFMemberEvent = AdjustEventType<VideoMemberEvent>;
+export declare type CFLayoutEvent = AdjustEventType<VideoLayoutEvent>;
+export declare type CallFabricEvent = CallJoinedEvent | CallStartedEvent | CallUpdatedEvent | CallEndedEvent | CallLeftEvent | CallStateEvent | CallPlayEvent | CallRecordEvent | CallStreamEvent | CallConnectEvent | CFMemberEvent | CFLayoutEvent;
+export declare type CallFabricAction = MapToPubSubShape<CallFabricEvent>;
+export {};
 //# sourceMappingURL=callfabric.d.ts.map

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

@@ -9,2 +9,3 @@ import type { EventEmitter } from '../utils/EventEmitter';
 import type { VoiceCallEvent } from './voice';
+import { CallFabricEvent, ConversationEvent } from '..';
 export interface SwEvent {
@@ -143,2 +144,13 @@ event_channel: string;
 export interface ClientContract<ClientInstance, EventTypes extends EventEmitter.ValidEventTypes> extends EmitterContract<EventTypes> {
+    /**
+     * Connect the underlay WebSocket connection to the SignalWire network.
+     *
+     * @returns Promise that will resolve with the Client object.
+     *
+     * @example
+     *
+     * ```js
+     * client.connect()
+     * ```
+     */
     connect(): Promise<ClientInstance>;
@@ -173,3 +185,3 @@ /**
 }
-export declare type SwEventParams = VideoAPIEventParams | WebRTCMessageParams | VideoManagerEvent | ChatEvent | TaskEvent | MessagingEvent | VoiceCallEvent | SwAuthorizationStateParams;
+export declare type SwEventParams = VideoAPIEventParams | WebRTCMessageParams | VideoManagerEvent | ChatEvent | TaskEvent | MessagingEvent | VoiceCallEvent | SwAuthorizationStateParams | ConversationEvent | CallFabricEvent;
 export declare type PubSubChannelEvents = InternalVideoEventNames | SessionEvents;
@@ -186,2 +198,4 @@ export * from './video';
 export * from './callfabric';
+export * from './callSegment';
+export * from './conversation';
 //# sourceMappingURL=index.d.ts.map

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

@@ -68,3 +68,6 @@ export declare type CamelToSnakeCase<S extends string> = S extends `${infer T}${infer U}` ? `${T extends Capitalize<T> ? '_' : ''}${Lowercase<T>}${CamelToSnakeCase<U>}` : S;
 };
+export declare type Prettify<T> = {
+    [K in keyof T]: Prettify<T[K]>;
+} & {};
 export {};
 //# sourceMappingURL=utils.d.ts.map

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

@@ -119,3 +119,6 @@ import type { SwEvent, VideoPosition } from '.';
     /** Indicate if the member hand is raised or not */
-    handraised: Boolean;
+    handraised: boolean;
+    callId?: string;
+    nodeId?: string;
+    memberId?: string;
     /**
@@ -276,2 +279,8 @@ * Mutes the outbound audio for this member (e.g., the one coming from a
 };
+export interface InternalUnifiedVideoMemberEntity extends InternalVideoMemberEntity {
+    memberId: string;
+    callId: string;
+    nodeId: string;
+}
+export declare type InternalUnifiedMethodTarget = Pick<InternalUnifiedVideoMemberEntity, 'memberId' | 'callId' | 'nodeId'>;
 /**
@@ -343,2 +352,3 @@ * VideoMember entity plus `updated` field
         id: string;
+        member_id?: string;
         talking: boolean;
@@ -345,0 +355,0 @@ };

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

@@ -54,2 +54,4 @@ import type { BaseConnectionContract, SwEvent } from '.';
     roomId: string;
+    /** Id of the room associated to this room session */
+    roomSessionId?: string;
     /** @internal */
@@ -837,2 +839,3 @@ eventChannel: string;
     member_id: string;
+    node_id?: string;
 }
@@ -839,0 +842,0 @@ export interface VideoRoomSubscribedEvent extends SwEvent {

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

@@ -15,2 +15,3 @@ import { Authorization, JSONRPCRequest, JSONRPCResponse, SATAuthorization } from '..';
 export * from './eventUtils';
+export * from './mapObject';
 export { LOCAL_EVENT_PREFIX };
@@ -17,0 +18,0 @@ export declare const mutateStorageKey: (key: string) => string;

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

@@ -9,3 +9,3 @@ /// <reference types="node" />
 import type { URL as NodeURL } from 'node:url';
-import { AllOrNone, ChatJSONRPCMethod, MessagingJSONRPCMethod, VoiceJSONRPCMethod, ClientContextMethod } from '..';
+import { AllOrNone, ChatJSONRPCMethod, MessagingJSONRPCMethod, VoiceJSONRPCMethod, ClientContextMethod, CallSegmentContract } from '..';
 declare type JSONRPCParams = Record<string, any>;
@@ -16,3 +16,4 @@ declare type JSONRPCResult = Record<string, any>;
 export declare type WebRTCMethod = 'video.message' | 'webrtc.verto';
-export declare type JSONRPCMethod = 'signalwire.connect' | 'signalwire.ping' | 'signalwire.disconnect' | 'signalwire.event' | 'signalwire.reauthenticate' | 'signalwire.subscribe' | 'signalwire.unsubscribe' | WebRTCMethod | RoomMethod | VertoMethod | ChatJSONRPCMethod | MessagingJSONRPCMethod | VoiceJSONRPCMethod | ClientContextMethod;
+export declare type SubscriberMethod = 'subscriber.online' | 'subscriber.offline';
+export declare type JSONRPCMethod = 'signalwire.connect' | 'signalwire.ping' | 'signalwire.disconnect' | 'signalwire.event' | 'signalwire.reauthenticate' | 'signalwire.subscribe' | 'signalwire.unsubscribe' | SubscriberMethod | WebRTCMethod | RoomMethod | UnifiedRoomMethod | VertoMethod | ChatJSONRPCMethod | MessagingJSONRPCMethod | VoiceJSONRPCMethod | ClientContextMethod;
 export declare type JSONRPCSubscribeMethod = Extract<JSONRPCMethod, 'signalwire.subscribe' | 'chat.subscribe'>;
@@ -49,12 +50,11 @@ export declare type JSONRPCUnSubscribeMethod = Extract<JSONRPCMethod, 'signalwire.unsubscribe'>;
     logLevel?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent';
-    /** To refresh the auth token */
-    onRefreshToken?(): Promise<void>;
+    /** The SDK invokes this method and uses the new token to re-auth. */
+    onRefreshToken?(): Promise<string>;
+    sessionChannel?: SessionChannel;
     /**
-     * The SDK invokes this method and uses the new token to re-auth.
-     * TODO: rename it: getNewToken, getRefreshedToken, fetchToken (?)
-     *
      * @internal
+     * Unified eventing is required only with Call Fabric SDK
      * */
-    _onRefreshToken?(): Promise<void>;
-    sessionChannel?: SessionChannel;
+    unifiedEventing?: boolean;
+    instanceMap?: InstanceMap;
 }
@@ -185,2 +185,6 @@ export interface UserOptions extends SessionOptions {
 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';
+/**
+ * List of all Unified Room methods
+ */
+export declare type UnifiedRoomMethod = 'call.mute' | 'call.unmute' | 'call.deaf' | 'call.undeaf' | 'call.layout.list' | 'call.member.list' | 'call.member.remove' | 'call.layout.set' | 'call.microphone.volume.set' | 'call.microphone.sensitivity.set';
 export interface WebSocketClient {
@@ -246,2 +250,4 @@ addEventListener: WebSocket['addEventListener'];
     remove: <T extends unknown>(key: string) => Map<string, T>;
+    getAll: <T extends unknown>() => [string, T][];
+    deleteAll: <T extends unknown>() => Map<string, T>;
 };
@@ -261,2 +267,3 @@ declare type SDKWorkerBaseParams<T> = {
     instanceMap: InstanceMap;
+    callSegments: CallSegmentContract[];
     dispatcher?: (type: any, payload: any, channel?: SwEventChannel | SessionChannel) => SagaIterator;
@@ -263,0 +270,0 @@ };

dist/realtime-api/src/testUtils.d.ts

@@ -19,4 +19,8 @@ /// <reference types="jest" />
         remove: (key: string) => Map<string, unknown>;
+        getAll: () => [string, unknown][];
+        deleteAll: () => Map<string, unknown>;
     };
+    callSegments: import("@signalwire/core").CallSegmentContract[];
     sessionEmitter: EventEmitter<import("@signalwire/core").ClientEvents, any>;
+    unifiedEventing: boolean | undefined;
     dispatch: import("redux").Dispatch<import("redux").AnyAction>;
@@ -46,4 +50,8 @@ getState(): any;
             remove: (key: string) => Map<string, unknown>;
+            getAll: () => [string, unknown][];
+            deleteAll: () => Map<string, unknown>;
         };
+        callSegments: import("@signalwire/core").CallSegmentContract[];
         sessionEmitter: EventEmitter<import("@signalwire/core").ClientEvents, any>;
+        unifiedEventing: boolean | undefined;
         dispatch: import("redux").Dispatch<import("redux").AnyAction>;
@@ -50,0 +58,0 @@ getState(): any;

dist/realtime-api/src/utils/internals.d.ts

@@ -17,4 +17,8 @@ import { UserOptions } from '@signalwire/core';
             remove: (key: string) => Map<string, unknown>;
+            getAll: () => [string, unknown][];
+            deleteAll: () => Map<string, unknown>;
         };
+        callSegments: import("@signalwire/core").CallSegmentContract[];
         sessionEmitter: import("eventemitter3").EventEmitter<import("@signalwire/core").ClientEvents, any>;
+        unifiedEventing: boolean | undefined;
         dispatch: import("redux").Dispatch<import("redux").AnyAction>;
@@ -21,0 +25,0 @@ getState(): any;

dist/realtime-api/src/video/RoomSession.d.ts

@@ -50,3 +50,3 @@ import { VideoRoomEventParams, Optional } from '@signalwire/core';
     /** @internal */
-    protected getSubscriptions(): ("room.started" | "room.ended" | "room.subscribed" | "room.updated" | "member.joined" | "member.left" | "member.updated" | "layout.changed" | "recording.started" | "recording.updated" | "recording.ended" | "playback.started" | "playback.updated" | "playback.ended" | "stream.started" | "stream.ended" | "member.updated.deaf" | "member.updated.visible" | "member.updated.audioMuted" | "member.updated.videoMuted" | "member.updated.inputVolume" | "member.updated.outputVolume" | "member.updated.inputSensitivity" | import("@signalwire/core").MemberTalkingEventNames | "memberList.updated" | "room.audienceCount")[];
+    protected getSubscriptions(): ("room.started" | "room.ended" | "member.joined" | "member.left" | "member.updated" | "layout.changed" | "room.subscribed" | "room.updated" | "recording.started" | "recording.updated" | "recording.ended" | "playback.started" | "playback.updated" | "playback.ended" | "stream.started" | "stream.ended" | "member.updated.deaf" | "member.updated.visible" | "member.updated.audioMuted" | "member.updated.videoMuted" | "member.updated.inputVolume" | "member.updated.outputVolume" | "member.updated.inputSensitivity" | import("@signalwire/core").MemberTalkingEventNames | "memberList.updated" | "room.audienceCount")[];
 }
@@ -53,0 +53,0 @@ export declare const RoomSessionAPI: import("@signalwire/core").ConstructableType<RoomSession>;

dist/realtime-api/src/video/RoomSessionMember/RoomSessionMember.d.ts

@@ -45,3 +45,3 @@ import { VideoMemberContract, EntityUpdated, VideoMemberJoinedEventParams, VideoMemberLeftEventParams, VideoMemberUpdatedEventParams, VideoMemberTalkingEventParams } from '@signalwire/core';
     get talking(): boolean;
-    get handraised(): Boolean;
+    get handraised(): boolean;
     remove(): Promise<void>;
@@ -48,0 +48,0 @@ }

package.json

@@ -6,5 +6,6 @@ {
   "license": "MIT",
-  "version": "4.0.0",
+  "version": "4.0.1-dev.202404301530.94a97d7.0",
   "main": "dist/index.node.js",
   "exports": {
+    "types": "./dist/realtime-api/src/index.d.ts",
     "require": "./dist/index.node.js",
@@ -41,3 +42,3 @@ "default": "./dist/index.node.mjs"
   "dependencies": {
-    "@signalwire/core": "4.0.0",
+    "@signalwire/core": "4.1.0-dev.202404301530.94a97d7.0",
     "ws": "^8.13.0"
@@ -44,0 +45,0 @@ },

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2333635

increased by1.57%

Number of package files

628

increased by1.95%

Lines of code

36738

increased by1.5%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

3

increased by50%

Dependency changes

• + Added@signalwire/core@4.1.0-dev.202404301530.94a97d7.0(transitive)

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

• Updated@signalwire/core@4.1.0-dev.202404301530.94a97d7.0