@cometchat/calls-sdk-javascript 4.2.3 → 5.0.0-beta.1

package/pack/src/Helper.d.ts

@@ -1,5 +0,0 @@
-import { CallAppSettings, ErrorModel } from "./models";
-export declare function isFalsy($false: any): any;
-export declare function mergeDeep(target: any, ...sources: any[]): any;
-export declare function validateCallAppSettings(appSettings: CallAppSettings): Promise<true>;
-export declare function throwCommonException(errorCallback: (err: ErrorModel) => void, details: any): void;

package/pack/src/api/APIHandler.d.ts

@@ -1,39 +0,0 @@
-import { CallAppSettings } from "../models";
-import { IGenerateTokenAPIResult, IVerifyTokenAPIResult } from "./helper";
-export declare class APIHandler {
-    private static appSettings;
-    /**
-     * Sets the app settings for the APIHandler class.
-     * @param appSettings - The CallAppSettings object containing the app settings.
-     */
-    static setAppSettings(appSettings: CallAppSettings): void;
-    /**
-     * Generates a call token for the given session ID and app settings.
-     * @param authToken - The authentication token.
-     * @param sessionID - The session ID for which the token is to be generated.
-     * @param appSettings - The CallAppSettings object containing the app settings.
-     * @returns A Promise that resolves to an IGenerateTokenAPIResult object.
-     */
-    static generateToken(authToken: string, sessionID: string, appSettings: CallAppSettings): Promise<IGenerateTokenAPIResult>;
-    /**
-     * Verifies the given call token for the given app settings.
-     * @param callToken - The call token to be verified.
-     * @param appSettings - The CallAppSettings object containing the app settings.
-     * @returns A Promise that resolves to an IVerifyTokenAPIResult object.
-     */
-    static verifyToken(callToken: string, appSettings: CallAppSettings): Promise<IVerifyTokenAPIResult>;
-    /**
-     * Gets the call log list for the given filter parameters and authentication token.
-     * @param params - The object containing the filter parameters.
-     * @param authToken - The authentication token.
-     * @returns A Promise that resolves to an array of call log objects.
-     */
-    static getCallLogList(params: object, authToken: string): Promise<any>;
-    /**
-     * Gets the call details for the given session ID and authentication token.
-     * @param sessionID - The session ID for which the call details are to be fetched.
-     * @param authToken - The authentication token.
-     * @returns A Promise that resolves to a call details object.
-     */
-    static getCallDetails(sessionID: string, authToken: string): Promise<any>;
-}

package/pack/src/api/endpoints.d.ts

@@ -1,7 +0,0 @@
-export declare const apiEndpoints: {
-    CALL_TOKENS: string;
-    CALL_LIST: string;
-};
-export declare const APP_ID_SPACE = "__APP_ID__";
-export declare const REGION_SPACE = "__REGION__";
-export declare const BASE_URL: string;

package/pack/src/api/helper.d.ts

@@ -1,69 +0,0 @@
-import { Region, Host } from "../types/common";
-interface StringMap {
-    [key: string]: string;
-}
-interface IGETReqObj {
-    url: string;
-    headers?: StringMap;
-}
-interface IPOSTReqObj extends IGETReqObj {
-    data?: Object;
-}
-export interface IGenerateTokenAPIResult {
-    error?: null | Object;
-    data?: {
-        data: {
-            token: string;
-        };
-        error: {
-            message: string;
-            devMessage: string;
-            source: "chat-api" | Omit<string, "chat-api">;
-            code: "AUTH_ERR_AUTH_TOKEN_NOT_FOUND" | string;
-        };
-    };
-}
-export interface IVerifyTokenAPIResult {
-    error?: null | Object;
-    data?: {
-        data?: {
-            callToken: string;
-            settings: {
-                PRESENTER_MODE_ENABLED: boolean;
-                WEBRTC_HOST: Host;
-                ANALYTICS_HOST: string;
-                ANALYTICS_VERSION: string;
-            };
-            payload: {
-                data: {
-                    appId: string;
-                    region: Region;
-                    authToken: string;
-                    user: {
-                        uid: string;
-                        name: string;
-                        avatar: string;
-                    };
-                    sessionId: string;
-                    passthrough: any;
-                };
-                room: string;
-            };
-        };
-        error?: {
-            message: string;
-            devMessage: string;
-            source: "chat-api" | Omit<string, "chat-api">;
-            code: "AUTH_ERR_AUTH_TOKEN_NOT_FOUND" | string;
-        };
-    };
-}
-export declare const postAPI: (postReqObj: IPOSTReqObj) => Promise<IGenerateTokenAPIResult>;
-export declare const getAPI: (getReqObj: IGETReqObj) => Promise<IVerifyTokenAPIResult>;
-/**
- * Encodes the given data object into a query string.
- * @param data - The data object to be encoded.
- * @returns The encoded query string.
- */
-export declare function encodeQueryData(data: any): string;
-export {};

package/pack/src/api/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./APIHandler";
-export * from "./endpoints";

package/pack/src/constants/CallConstants.d.ts

@@ -1,218 +0,0 @@
-export declare const CallConstants: {
-    readonly MODE: {
-        readonly DEFAULT: "DEFAULT";
-        readonly SPOTLIGHT: "SPOTLIGHT";
-        readonly GRID: "TILE";
-    };
-    readonly CALL_TYPE: {
-        readonly AUDIO: "audio";
-        readonly VIDEO: "video";
-    };
-    readonly RECEIVER_TYPE_GROUP: "group";
-    readonly RECEIVER_TYPE_USER: "user";
-    readonly CALL_KEYS: {
-        readonly CALL_DATA: "data";
-        readonly CALL_ID: "id";
-        readonly CALL_SESSION_ID: "sessionid";
-        readonly CALL_RECEIVER: "receiver";
-        readonly CALL_INITIATOR: "initiator";
-        readonly CALL_SENDER: "sender";
-        readonly CALL_RECEIVER_TYPE: "receiverType";
-        readonly CALL_STATUS: "status";
-        readonly CALL_TYPE: "type";
-        readonly CALL_INITIATED_AT: "initiatedAt";
-        readonly CALL_JOINED_AT: "joinedAt";
-        readonly CALL_LEFT_AT: "leftAt";
-        readonly CALL_METADATA: "metadata";
-        readonly CALL_ENTITIES: "entities";
-        readonly CALL_ENTITY_TYPE: "entityType";
-        readonly CALL_ENTITY: "entity";
-        readonly CALL_ENTITY_USER: "user";
-        readonly CALL_ENTITY_GROUP: "group";
-    };
-    readonly CALL_STATUS: {
-        readonly INITIATED: "initiated";
-        readonly ONGOING: "ongoing";
-        readonly UNANSWERED: "unanswered";
-        readonly REJECTED: "rejected";
-        readonly BUSY: "busy";
-        readonly CANCELLED: "cancelled";
-        readonly ENDED: "ended";
-    };
-    readonly AUDIO_INPUT_DEVICES: "audioInputDevices";
-    readonly AUDIO_OUTPUT_DEVICES: "audioOutputDevices";
-    readonly VIDEO_INPUT_DEVICES: "videoInputDevices";
-    readonly POST_MESSAGES: {
-        readonly TYPES: {
-            readonly ACTION_MESSAGE: "cometchat_action_message";
-            readonly HANGUP: "hangup";
-            readonly COMETCHAT_RTC_SETTINGS: "cometchat_rtc_settings";
-        };
-        readonly ACTIONS: {
-            readonly USER_JOINED: "onUserJoined";
-            readonly USER_LEFT: "onUserLeft";
-            readonly USER_LIST_CHANGED: "onUserListChanged";
-            readonly INITIAL_DEVICE_LIST: "initialDeviceList";
-            readonly DEVICE_CHANGE: "onDeviceChange";
-            readonly LOAD: "LOAD";
-            readonly CHANGE_AUDIO_INPUT: "changeAudioInput";
-            readonly CHANGE_AUDIO_OUTPUT: "changeAudioOutput";
-            readonly CHANGE_VIDEO_INPUT: "changeVideoInput";
-            readonly MUTE_AUDIO: "muteAudio";
-            readonly UNMUTE_AUDIO: "unMuteAudio";
-            readonly PAUSE_VIDEO: "pauseVideo";
-            readonly UNPAUSE_VIDEO: "unPauseVideo";
-            readonly SWITCH_MODE: "switchMode";
-            readonly START_SCREENSHARE: "startScreenShare";
-            readonly STOP_SCREENSHARE: "stopScreenShare";
-            readonly END_CALL: "endCall";
-            readonly START_RECORDING: "startRecording";
-            readonly STOP_RECORDING: "stopRecording";
-            readonly RECORDING_TOGGLED: "onRecordingToggled";
-            readonly USER_MUTED: "onUserMuted";
-            readonly ON_USER_UNMUTED: "onUserUnMuted";
-            readonly SCREEN_SHARE_STARTED: "SCREEN_SHARE_STARTED";
-            readonly SCREEN_SHARE_STOPPED: "SCREEN_SHARE_ENDED";
-            readonly SWITCH_TO_VIDEO_CALL: "switchedToVideo";
-            readonly SWITCHED_TO_VIDEO_CALL: "onCallSwitchedToVideo";
-            readonly OPEN_VIRTUAL_BACKGROUND: "openVirtualBackgroundMenu";
-            readonly SET_BACKGROUND_BLUR: "setBackgroundBlur";
-            readonly SET_BACKGROUND_IMAGE: "setBackgroundImage";
-        };
-    };
-    readonly MEDIA_DEVICE: {
-        readonly ID: "id";
-        readonly NAME: "name";
-        readonly ACTIVE: "active";
-    };
-    readonly ZOOM_BUTTON_DEFAULT_PARAMS: {
-        readonly position: "bottom-right";
-        readonly visible: true;
-    };
-    readonly NAME_LABEL_DEFAULT_PARAMS: {
-        readonly position: "bottom-left";
-        readonly visible: true;
-        readonly color: "rgba(27, 27, 27, 0.4)";
-    };
-    readonly NETWORK_LABEL_DEFAULT_PARAMS: {
-        readonly position: "bottom-right";
-        readonly visible: true;
-    };
-    readonly MAIN_VIDEO_CONTAINER_SETTINGS: {
-        readonly KEYS: {
-            readonly POSITION: "position";
-            readonly VISIBILITY: "visible";
-            readonly LEGACY_VISIBILITY: "visibility";
-            readonly COLOR: "color";
-        };
-    };
-};
-export declare const CALL_ERROR: {
-    CALL_ALREADY_INITIATED: {
-        code: string;
-        name: string;
-        message: string;
-        details: {};
-    };
-    ERROR_IN_CALLING: {
-        code: string;
-        name: string;
-        message: string;
-        details: {};
-    };
-    CANNOT_ACCEPT_CALL: {
-        code: string;
-        name: string;
-        message: string;
-        details: {};
-    };
-    NOT_INITIALIZED: {
-        code: string;
-        name: string;
-        message: string;
-        details: {};
-    };
-    NOT_LOGGED_IN: {
-        code: string;
-        name: string;
-        message: string;
-        details: {};
-    };
-    SESSION_ID_REQUIRED: {
-        code: string;
-        name: string;
-        message: string;
-        details: {};
-    };
-    CALL_SETTINGS_REQUIRED: {
-        code: string;
-        name: string;
-        message: string;
-        details: {};
-    };
-    JWT_NOT_FOUND: {
-        code: string;
-        name: string;
-        message: string;
-        details: {};
-    };
-};
-export declare const REGION: {
-    readonly us: "us";
-    readonly eu: "eu";
-    readonly in: "in";
-    readonly US: "us";
-    readonly EU: "eu";
-    readonly IN: "in";
-};
-export declare const API_ERROR_CODES: {
-    AUTH_ERR_AUTH_TOKEN_NOT_FOUND: string;
-};
-export declare const GENERAL_CONSTS: {
-    REGION: {
-        us: string;
-        eu: string;
-        in: string;
-        US: string;
-        EU: string;
-        IN: string;
-    };
-};
-export declare const GENERAL_ERROR: {
-    readonly GENERIC_EXCEPTION: {
-        readonly code: "GENERIC_EXCEPTION";
-    };
-    readonly INVALID_ARGUMENT_EXCEPTION: {
-        readonly code: "INVALID_ARGUMENT_EXCEPTION";
-    };
-    readonly API_ERROR: {
-        readonly code: "API_ERROR";
-    };
-    readonly UNKNOWN_API_ERROR: {
-        readonly code: "UNKNOWN_API_ERROR";
-        readonly message: "There is an unknown issue with the API request. Please check your internet connection and verify the api call.";
-    };
-    readonly INVALID_CALL_APP_SETTINGS: {
-        readonly code: "INVALID_CALL_APP_SETTINGS";
-        readonly message_instance: "appSettings must be an instance of CallAppSettings class";
-        readonly message_app_id: "Invalid app id, please check your appSettings";
-        readonly message_region: "Invalid region, please check your appSettings";
-        readonly message_host: "Invalid host, please check your appSettings";
-    };
-    readonly INVALID_CALL_SETTINGS: {
-        readonly code: "INVALID_CALL_SETTINGS";
-        readonly message_instance: "callSettings must be an instance of CallSettings class";
-    };
-    readonly INVALID_PRESENTER_SETTINGS: {
-        readonly code: "INVALID_PRESENTER_SETTINGS";
-        readonly message_instance: "presenterSettings must be an instance of PresenterSettings class";
-    };
-    readonly INVALID_ARGUMENT_EXCEPTION_CALL_TOKEN: {
-        readonly code: "INVALID_ARGUMENT_EXCEPTION";
-        readonly message: "callToken must be valid please verify.";
-    };
-    readonly ERROR_PRESENTER_MODE: {
-        readonly code: "ERROR_PRESENTER_MODE";
-        readonly message: "Presenter mode is disabled. To use presenter mode, please enable it from the CometChat Apps Dashboard";
-    };
-};

package/pack/src/constants/index.d.ts

@@ -1 +0,0 @@
-export * from "./CallConstants";

package/pack/src/defaultCallsettings.d.ts

@@ -1,2 +0,0 @@
-import { ICallsettings } from "./types/ICallSettings";
-export declare const defaultCallsettings: Partial<ICallsettings>;

package/pack/src/index.d.ts

@@ -1,7 +0,0 @@
-export { CometChatCalls } from "./models/CometChatCalls";
-export { CallLog } from "./models/CallLog";
-export { CallLogRequestBuilder } from "./models/CometChatCallLogs";
-export { CallUser } from "./models/CallUser";
-export { CallGroup } from "./models/CallGroup";
-export { Participant } from './models/Participant';
-export { Recording } from './models/Recording';

package/pack/src/models/CallGroup.d.ts

@@ -1,14 +0,0 @@
-export declare class CallGroup {
-    protected guid: string;
-    protected name: string;
-    protected icon: string;
-    constructor(object: any);
-    getGuid(): string;
-    setGuid(guid: string): void;
-    getName(): string;
-    setName(name: string): void;
-    getIcon(): string;
-    setIcon(icon: string): void;
-    toString(): string;
-    static getGroupFromJson(object: any): CallGroup;
-}

package/pack/src/models/CallLog.d.ts

@@ -1,276 +0,0 @@
-import { CallGroup } from "./CallGroup";
-import { CallUser } from "./CallUser";
-import { Participant } from "./Participant";
-import { Recording } from "./Recording";
-/**
- * Represents a call log.
- */
-export declare class CallLog {
-    /**
-     * The session ID of the call log.
-     */
-    private sessionId;
-    /**
-     * The total audio minutes of the call log.
-     */
-    private totalAudioMinutes;
-    /**
-     * The total video minutes of the call log.
-     */
-    private totalVideoMinutes;
-    /**
-     * The total duration of the call log.
-     */
-    private totalDuration;
-    /**
-     * Whether the call log has a recording.
-     */
-    private hasRecording;
-    /**
-     * The time the call was initiated at.
-     */
-    private initiatedAt;
-    /**
-     * The call category of the call log.
-     */
-    private callCategory;
-    /**
-     * @type {CallUser}
-     * The initiator of the call log.
-     */
-    private initiator;
-    /**
-     * @type {CallUser | CallGroup}
-     * The receiver of the call log.
-     */
-    private receiver;
-    /**
-     * The receiver type of the call log.
-     */
-    private receiverType;
-    /**
-     * The status of the call log.
-     */
-    private status;
-    /**
-     * The total duration in minutes of the call log.
-     */
-    private totalDurationInMinutes;
-    /**
-     * The total number of participants in the call log.
-     */
-    private totalParticipants;
-    /**
-     * The type of the call log.
-     */
-    private type;
-    /**
-     * The message ID of the call log.
-     */
-    private mid;
-    /**
-     * The time the call ended at.
-     */
-    private endedAt;
-    /**
-     * @type {Participant[]}
-     * The participants of the call log.
-     */
-    private participants;
-    /**
-     * @type {Recording[]}
-     * The recordings of the call log.
-     */
-    private recordings;
-    /**
-     * Creates a new instance of CallLog.
-     * @param data - The data to initialize the call log with.
-     */
-    constructor(data: any);
-    /**
-     * Gets the session ID of the call log.
-     * @returns The session ID of the call log.
-     */
-    getSessionID(): string;
-    /**
-     * Sets the session ID of the call log.
-     * @param value - The session ID to set.
-     */
-    setSessionID(value: string): void;
-    /**
-     * Gets the total audio minutes of the call log.
-     * @returns The total audio minutes of the call log.
-     */
-    getTotalAudioMinutes(): number;
-    /**
-     * Sets the total audio minutes of the call log.
-     * @param value - The total audio minutes to set.
-     */
-    setTotalAudioMinutes(value: number): void;
-    /**
-     * Gets the total video minutes of the call log.
-     * @returns The total video minutes of the call log.
-     */
-    getTotalVideoMinutes(): number;
-    /**
-     * Sets the total video minutes of the call log.
-     * @param value - The total video minutes to set.
-     */
-    setTotalVideoMinutes(value: number): void;
-    /**
-     * Gets the total duration of the call log.
-     * @returns The total duration of the call log.
-     */
-    getTotalDuration(): string;
-    /**
-     * Sets the total duration of the call log.
-     * @param value - The total duration to set.
-     */
-    setTotalDuration(value: string): void;
-    /**
-     * Gets whether the call log has a recording.
-     * @returns Whether the call log has a recording.
-     */
-    getHasRecording(): boolean;
-    /**
-     * Sets whether the call log has a recording.
-     * @param value - Whether the call log has a recording.
-     */
-    setHasRecording(value: boolean): void;
-    /**
-     * Gets the time the call was initiated at.
-     * @returns The time the call was initiated at.
-     */
-    getInitiatedAt(): number;
-    /**
-     * Sets the time the call was initiated at.
-     * @param value - The time the call was initiated at.
-     */
-    setInitiatedAt(value: number): void;
-    /**
-     * Gets the call category of the call log.
-     * @returns The call category of the call log.
-     */
-    getCallCategory(): string;
-    /**
-     * Sets the call category of the call log.
-     * @param value - The call category to set.
-     */
-    setCallCategory(value: string): void;
-    /**
-     * Gets the initiator of the call log.
-     * @returns The initiator of the call log.
-     */
-    getInitiator(): CallUser;
-    /**
-     * Sets the initiator of the call log.
-     * @param value - The initiator to set.
-     */
-    setInitiator(value: CallUser): void;
-    /**
-     * Gets the receiver of the call log.
-     * @returns The receiver of the call log.
-     */
-    getReceiver(): CallUser | CallGroup;
-    /**
-     * Sets the receiver of the call log.
-     * @param value - The receiver to set.
-     */
-    setReceiver(value: CallUser | CallGroup): void;
-    /**
-     * Gets the receiver type of the call log.
-     * @returns The receiver type of the call log.
-     */
-    getReceiverType(): string;
-    /**
-     * Sets the receiver type of the call log.
-     * @param value - The receiver type to set.
-     */
-    setReceiverType(value: string): void;
-    /**
-     * Gets the status of the call log.
-     * @returns The status of the call log.
-     */
-    getStatus(): string;
-    /**
-     * Sets the status of the call log.
-     * @param value - The status to set.
-     */
-    setStatus(value: string): void;
-    /**
-     * Gets the total duration in minutes of the call log.
-     * @returns The total duration in minutes of the call log.
-     */
-    getTotalDurationInMinutes(): number;
-    /**
-     * Sets the total duration in minutes of the call log.
-     * @param value - The total duration in minutes to set.
-     */
-    setTotalDurationInMinutes(value: number): void;
-    /**
-     * Gets the total number of participants in the call log.
-     * @returns The total number of participants in the call log.
-     */
-    getTotalParticipants(): number;
-    /**
-     * Sets the total number of participants in the call log.
-     * @param value - The total number of participants to set.
-     */
-    setTotalParticipants(value: number): void;
-    /**
-     * Gets the type of the call log.
-     * @returns The type of the call log.
-     */
-    getType(): string;
-    /**
-     * Sets the type of the call log.
-     * @param value - The type to set.
-     */
-    setType(value: string): void;
-    /**
-     * Gets the message ID of the call log.
-     * @returns The message ID of the call log.
-     */
-    getMid(): string;
-    /**
-     * Sets the message ID of the call log.
-     * @param value - The message ID to set.
-     */
-    setMid(value: string): void;
-    /**
-     * Gets the time the call ended at.
-     * @returns The time the call ended at.
-     */
-    getEndedAt(): number;
-    /**
-     * Sets the time the call ended at.
-     * @param value - The time the call ended at.
-     */
-    setEndedAt(value: number): void;
-    /**
-     * Gets the participants of the call log.
-     * @returns The participants of the call log.
-     */
-    getParticipants(): Participant[];
-    /**
-     * Sets the participants of the call log.
-     * @param value - The participants to set.
-     */
-    setParticipants(value: Participant[]): void;
-    /**
-     * Gets the recordings of the call log.
-     * @returns The recordings of the call log.
-     */
-    getRecordings(): Recording[];
-    /**
-     * Sets the recordings of the call log.
-     * @param value - The recordings to set.
-     */
-    setRecordings(value: Recording[]): void;
-    /**
-     * Creates a new instance of CallLog from JSON data.
-     * @param data - The JSON data to create the call log from.
-     * @returns A new instance of CallLog created from the JSON data.
-     */
-    static callLogFromJson(data: any): CallLog;
-}