@vkontakte/calls-sdk 2.8.4-dev.c1b325f.0 → 2.8.4-dev.c289e55.0

package/classes/Conversation.d.ts

@@ -112,7 +112,6 @@ export default class Conversation extends EventEmitter {
     private _createMediaSource;
     private _connectSignaling;
     private _processConnection;
-    private _prepareParticipants;
     private _onConversationParticipantListChunk;
     private _createParticipantListChunk;
     private _participantListChunkToExternalChunk;
@@ -365,6 +364,7 @@ export default class Conversation extends EventEmitter {
     private _refreshRooms;
     /** получили из сингналинга сообщение о реакции пользователей */
     private _onFeedback;
+    private _onDecorativeParticipantIdChanged;
     private _isMe;
     private _getMuteStatesForRoomId;
     private _getMuteStatesForCurrentRoom;

package/default/Api.d.ts

@@ -8,10 +8,11 @@ export default class Api extends BaseApi {
     private _userId;
     private _uuid;
     private _externalUidsCache;
+    private _decorativeIdToInitialId;
+    private _initialIdToDecorativeId;
     private _callUnsafe;
     protected _call(method: string, data?: any, noSession?: boolean): Promise<any>;
-    userId(compositeUserId: ParticipantId): Promise<ExternalParticipantId>;
-    prepareUserIds(ids: OkUserId[]): Promise<void>;
+    userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
     authorize(): Promise<void>;
     log(items: LogItem[]): void;
     init(): void;
@@ -48,7 +49,10 @@ export default class Api extends BaseApi {
      */
     getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
     getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
-    cacheExternalId(participantId: CompositeUserId, externalId: ExternalParticipantId): void;
+    cacheExternalId(participantId: OkUserId | CompositeUserId | ParticipantId, externalId: ExternalParticipantId): void;
+    mapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId, initialId: OkUserId | CompositeUserId | ParticipantId): void;
+    getDecorativeIdByInitialId(initialId: OkUserId | CompositeUserId | ParticipantId): OkUserId | undefined;
+    replaceByInitialIdIdIfExists(id: OkUserId | CompositeUserId | ParticipantId): OkUserId;
     getConversationParams(conversationId?: string): Promise<ConversationParams>;
     getUserId(): OkUserId | null;
     setUserId(userId: OkUserId): void;

package/default/Signaling.d.ts

@@ -20,9 +20,8 @@ import ParticipantLayout, { RequestKeyFrame, StopStream } from '../types/Partici
 import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
 import { StreamDescriptionString } from '../types/ParticipantStreamDescription';
 import { PerfStatReport } from '../types/PerfStatReporter';
-import SignalingMessage, { GetRoomsSignalingResponse, SignalingSuccessResponse } from '../types/SignalingMessage';
+import SignalingMessage, { GetParticipantsSignalingResponse, GetRoomsSignalingResponse, SignalingSuccessResponse } from '../types/SignalingMessage';
 import { IPublishStreamData, IRecordConfData, IStartStreamData, IStopStreamData } from '../types/Streams';
-import { WaitingParticipantId } from '../types/WaitingHall';
 export default class Signaling extends BaseSignaling {
     private socket;
     protected sequence: number;
@@ -73,7 +72,7 @@ export default class Signaling extends BaseSignaling {
     /**
      * Send a command to a signaling server
      */
-    protected _send(command: SignalingCommandType, params?: any, needResponse?: boolean, retryCount?: number): Promise<SignalingMessage>;
+    protected _send<T extends SignalingSuccessResponse>(command: SignalingCommandType, params?: any, needResponse?: boolean, retryCount?: number): Promise<T>;
     /**
      * Send a raw command to a signaling server
      */
@@ -135,7 +134,7 @@ export default class Signaling extends BaseSignaling {
     changeOptions(changes: {
         [key in ConversationOption]?: boolean;
     }): Promise<SignalingMessage>;
-    getWaitingHall(fromId?: WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
+    getWaitingHall(fromId?: SignalingMessage.WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
     promoteParticipant(participantId: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
     requestPromotion(unrequest?: boolean): Promise<SignalingMessage>;
     acceptPromotion(reject?: boolean): Promise<SignalingMessage>;
@@ -153,7 +152,7 @@ export default class Signaling extends BaseSignaling {
      */
     readyToSend(isReady?: boolean): void;
     getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
-    getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
+    getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<GetParticipantsSignalingResponse>;
     startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
     stopAsr(params?: IAsrStopParams): Promise<SignalingMessage>;
     requestAsr(request: boolean): Promise<SignalingMessage>;

package/enums/SignalingNotification.d.ts

@@ -47,6 +47,7 @@ declare enum SignalingNotification {
     FEATURES_PER_ROLE_CHANGED = "features-per-role-changed",
     PARTICIPANT_ANIMOJI_CHANGED = "participant-animoji-changed",
     ASR_STARTED = "asr-started",
-    ASR_STOPPED = "asr-stopped"
+    ASR_STOPPED = "asr-stopped",
+    DECORATIVE_PARTICIPANT_ID_CHANGED = "decorative-participant-id-changed"
 }
 export default SignalingNotification;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/calls-sdk",
-  "version": "2.8.4-dev.c1b325f.0",
+  "version": "2.8.4-dev.c289e55.0",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

package/static/External.d.ts

@@ -531,6 +531,12 @@ declare namespace External {
      */
     function onAsrStopped(roomId: number | null): void;
     function onAsrTranscription(id: ExternalParticipantId, text: string, timestamp: number, duration: number): void;
+    /**
+     * Изменился id участника (деанонимизация)
+     * @param prevId
+     * @param newId
+     */
+    function onDecorativeParticipantIdChanged(prevId: ExternalParticipantId, newId: ExternalParticipantId): void;
     /**
      * Одобрено повышение пользователя в зеле ожидания/зале в режиме Audience
      *

package/static/Params.d.ts

@@ -324,6 +324,12 @@ export type ParamsObject = {
     movieShare: boolean;
     /** @hidden */
     breakVideoPayloadTypes: boolean;
+    /**
+     * Включить звонки контактам
+     *
+     * _По умолчанию: `false`_
+     */
+    useCallsToContacts: boolean;
     /**
      * Включить постраничный вывод участников. Работает только если включено videoTracksCount (слоты)
      *
@@ -777,7 +783,13 @@ export type ParamsObject = {
      */
     onRemoteSharedUrl?: (userId: ExternalParticipantId, sharedUrl: string | undefined, roomId: IRoomId) => void;
     /**
-     * Одобрено повышение пользователя в зеле ожидания/зале в режиме Audience
+     * Изменился id участника (деанонимизация)
+     * @param prevId
+     * @param newId
+     */
+    onDecorativeParticipantIdChanged?: (prevId: ExternalParticipantId, newId: ExternalParticipantId) => void;
+    /**
+     * Одобрено повышение пользователя в зале ожидания/зале в режиме Audience
      *
      * @param adminParticipantId админ, одобривший повышение
      */
@@ -898,6 +910,7 @@ export default abstract class Params {
     static get movieShare(): boolean;
     static get videoTracksCount(): number;
     static get breakVideoPayloadTypes(): boolean;
+    static get useCallsToContacts(): boolean;
     static get useParticipantListChunk(): boolean;
     static get useRooms(): boolean;
     static get participantListChunkInitIndex(): number;

package/static/Utils.d.ts

@@ -15,11 +15,13 @@ declare namespace Utils {
         local: any;
         remote: any;
     }>;
-    function composeUserId(id: CompositeUserId | OkUserId, type: UserType): CompositeUserId;
+    function composeUserId(id: CompositeUserId | OkUserId, type?: UserType): CompositeUserId;
     function composeParticipantId(id: CompositeUserId | OkUserId, type: UserType, deviceIdx?: number): ParticipantId;
     function compose(compositeId: CompositeUserId, deviceIdx?: number): ParticipantId;
     function composeId(participant: SignalingMessage.Participant): ParticipantId;
+    function composeDecorativeId(participant: SignalingMessage.Participant): ParticipantId | undefined;
     function composeMessageId(message: SignalingMessage): ParticipantId;
+    function extractOkId(id: OkUserId | CompositeUserId | ParticipantId): OkUserId;
     function decomposeId(compositeId: CompositeUserId | OkUserId): {
         id: OkUserId;
         type: UserType;

package/types/ExternalId.d.ts

@@ -17,6 +17,7 @@ export type ExternalUserId = string;
 export declare namespace ExternalIdUtils {
     function fromIds(ids: ExternalUserId[] | ExternalId[]): ExternalId[];
     function fromId(id: ExternalUserId, type?: ExternalIdType, deviceIdx?: number): ExternalParticipantId;
+    function fromSignalingParticipant(participant: SignalingMessage.Participant, useDecorative?: boolean): ExternalParticipantId | undefined;
     function fromSignaling(signalingId: SignalingMessage.ExternalId, deviceIdx?: number): ExternalParticipantId;
     function toString(externalId: ExternalId): ExternalIdString;
     function fromIdToString(id: ExternalUserId, type?: ExternalIdType, deviceIdx?: number): ExternalIdString;

package/types/Participant.d.ts

@@ -15,6 +15,7 @@ export type CompositeUserId = string;
 /**
  * Уникально идентифицирует участника звонка
  * (одному пользователю могут соответствовать несколько участников, в случае если пользователь зашёл в звонок с нескольких устройств)
+ * Включает композитный id и постфикс с номером устройства, если он не равен 0
  */
 export type ParticipantId = string;
 export type OkUserId = number;
@@ -44,7 +45,13 @@ export interface ParticipantStateMapped {
     };
 }
 export interface Participant {
+    /**
+     * string representation
+     */
     id: ParticipantId;
+    /**
+     * If user has 'decorative external id' it will be set as externalId
+     */
     externalId: ExternalParticipantId;
     mediaSettings: MediaSettings;
     state: ParticipantState;

package/types/SignalingMessage.d.ts

@@ -48,6 +48,9 @@ export interface GetRoomsSignalingResponse extends SignalingSuccessResponse {
         roomId?: number;
     };
 }
+export interface GetParticipantsSignalingResponse extends SignalingSuccessResponse {
+    participants: SignalingMessage.Participant[];
+}
 declare namespace SignalingMessage {
     export interface ExternalId {
         type: 'UNKNOWN' | 'VK' | 'ANONYM';
@@ -70,6 +73,8 @@ declare namespace SignalingMessage {
     export interface Participant {
         id: OkUserId;
         idType?: UserType;
+        decorativeUserId?: CompositeUserId;
+        decorativeExternalUserId?: ExternalId;
         deviceIdx?: number;
         externalId?: ExternalId;
         state: ParticipantState;
@@ -97,6 +102,14 @@ declare namespace SignalingMessage {
         countAfter: number;
         markerFound: boolean;
     }
+    export interface WaitingParticipantId {
+        addedTs: number;
+        id: CompositeUserId;
+    }
+    export interface WaitingParticipant {
+        id: WaitingParticipantId;
+        externalId?: ExternalId;
+    }
     export interface RoomUrlSharingInfo {
         sharedUrl: string;
         initiatorId: CompositeUserId;
@@ -407,6 +420,11 @@ declare namespace SignalingMessage {
     export interface ParticipantSourcesUpdateNotification extends Notification {
         participantUpdateInfos: ParticipantUpdateInfo[];
     }
+    export interface DecorativeParticipantIdChanged extends Notification {
+        participantId: CompositeUserId;
+        decorativeParticipantId?: CompositeUserId;
+        decorativeExternalParticipantId?: ExternalId;
+    }
     export {};
 }
 export default SignalingMessage;

package/types/WaitingHall.d.ts

@@ -1,18 +1,9 @@
 import { ExternalId } from './ExternalId';
-import { CompositeUserId } from './Participant';
 import SignalingMessage from './SignalingMessage';
 import { IFeedback } from './Feedback';
-export type WaitingParticipantId = {
-    addedTs: number;
-    id: CompositeUserId;
-};
-export type WaitingParticipant = {
-    id: WaitingParticipantId;
-    externalId?: SignalingMessage.ExternalId;
-};
 export type ChatRoom = {
     totalCount: number;
-    firstParticipants?: WaitingParticipant[];
+    firstParticipants?: SignalingMessage.WaitingParticipant[];
     handCount?: number;
     feedback?: IFeedback[];
 };
@@ -24,5 +15,5 @@ export type WaitingHallResponse = {
     pageMarker: string | null;
     totalCount: number;
 };
-export declare function waitingParticipantIdToString(id: WaitingParticipantId): string | null;
-export declare function waitingParticipantIdFromString(id: string): WaitingParticipantId | null;
+export declare function waitingParticipantIdToString(id: SignalingMessage.WaitingParticipantId): string | null;
+export declare function waitingParticipantIdFromString(id: string): SignalingMessage.WaitingParticipantId | null;