@ai-vyumi/livecall 0.1.0

package/dist/VyumiLiveCall.d.ts

@@ -0,0 +1,122 @@
+import { CallInteractionCallback, CallSessionCallback } from './callbacks/callbacks';
+import { MediaType } from './types/types';
+declare class VyumiLiveCall {
+    /**
+     * Initializes the Vyumi Live Call SDK.
+     *
+     * This must be called once during application startup before
+     * invoking any other SDK functions. The Brand ID is provided
+     * by Vyumi and is required for SDK configuration and API access.
+     *
+     * Debug logs can optionally be enabled for development purposes.
+     * It is recommended to disable debug logs in production builds.
+     *
+     * @param brandId The unique Brand ID provided by Vyumi.
+     * @param debug Pass true to enable SDK debug logs, false to disable them.
+     */
+    initialize(brandId: string, debug?: boolean): Promise<void>;
+    /**
+     * Initiates an instant call request.
+     *
+     * This attempts to connect the customer with an available agent.
+     * Call session updates such as queue status, agent availability,
+     * room readiness, and call completion are delivered through the
+     * provided CallSessionCallback.
+     *
+     * @param payload Object containing customer information and call metadata.
+     * @param call_type Type of call to initiate (audio or video).
+     * @param sessionCallback Callback used to monitor call session events.
+     */
+    initiateCall(payload: Record<string, any>, call_type: MediaType, sessionCallback: CallSessionCallback): Promise<void>;
+    /**
+     * Joins the active call room.
+     *
+     * This must be called after receiving the room-ready event from
+     * the CallSessionCallback. The provided view handles are used
+     * to render the local and remote video streams.
+     *
+     * Microphone permission is required. Camera permission is also
+     * required when joining a video call.
+     *
+     * @param remoteViewHandle Native view handle used for rendering the remote participant's video stream.
+     * @param localViewHandle Native view handle used for rendering the local camera preview.
+     * @param interactionCallback Callback used to receive call interaction events.
+     */
+    joinCall(remoteViewHandle: number, localViewHandle: number, interactionCallback: CallInteractionCallback): Promise<void>;
+    /**
+     * Mutes or unmutes the microphone.
+  
+     * Description: This function is used to control whether to use the collected audio data. Mute (turn off the microphone) will use the muted data to replace the audio data collected by the device for streaming. At this time, the microphone device will still be occupied.
+     * Default value: The default is `false`, which means no muting.
+     *
+     * @param mute Whether to mute (disable) the microphone, `true`: mute (disable) microphone, `false`: enable microphone.
+     */
+    muteMicrophone(mute: boolean): Promise<void>;
+    /**
+     * Switches to the front or the rear camera (for the specified channel).
+     * Default value: The default is `true` which means the front camera is used.
+     *
+     * @param enable `true`: use the front camera, `false`: use the the rear camera.
+     */
+    flipCamera(flip: boolean): Promise<void>;
+    /**
+     * Turns on/off the camera (for the specified channel).
+     *
+     * @param enable Whether to turn on the camera, `true`: turn on camera, `false`: turn off camera
+     */
+    enableCamera(enable: boolean): Promise<void>;
+    /**
+     * Mutes or unmutes the audio output speaker.
+     *
+     * Description: After mute speaker, all the SDK sounds will not play, including playing stream, mediaplayer, etc.
+     * Default value: The default is `false`, which means no muting.
+     *
+     * @param mute Whether to mute (disable) speaker audio output, `true`: mute (disable) speaker audio output, `false`: enable speaker audio output.
+     */
+    muteSpeaker(mute: boolean): Promise<void>;
+    /**
+     * Sends a  Message.
+     *
+     * @param message The content of the message. Required: Yes. Value range: The length does not exceed 1024 bytes.
+  
+     */
+    sendMessage(message: string): Promise<void>;
+    /**
+     * Ends the current active call session.
+     *
+     * This should always be called when the call screen is closed
+     * or when the conversation is finished to ensure that all
+     * resources are released properly.
+     */
+    endCall(): Promise<void>;
+    /**
+     * Cancels an ongoing call request.
+     *
+     * This can be used while the customer is waiting for an
+     * available agent before the call room has been joined.
+     * Once cancelled, the call request is terminated and
+     * the customer is removed from the queue.
+     */
+    cancelCall(): Promise<void>;
+    /**
+     * Fetches available time slots for scheduling calls.
+     *
+     * The response contains available dates and time slots
+     * along with the number of agents available for each slot.
+     *
+     * @param queryParams The customer's timezone (default: "Asia/Calcutta").
+     */
+    getScheduleTimeSlots(queryParams: Record<string, any>): Promise<void>;
+    /**
+     * Schedules a call for a future time slot.
+     *
+     * The payload must contain required customer details such as
+     * name, mobile number, scheduled time (UTC), country code,
+     * WhatsApp subscription status, and timezone.
+     *
+     * @param payload JSONObject containing scheduling details.
+     */
+    scheduleCall(payload: Record<string, any>): Promise<void>;
+}
+declare const vyumiLiveCall: VyumiLiveCall;
+export default vyumiLiveCall;

package/dist/VyumiLiveCall.js

@@ -0,0 +1,185 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CallService_1 = __importDefault(require("./service/CallService"));
+const InitServices_1 = require("./service/InitServices");
+const ZegoServices_1 = __importDefault(require("./service/ZegoServices"));
+class VyumiLiveCall {
+    /**
+     * Initializes the Vyumi Live Call SDK.
+     *
+     * This must be called once during application startup before
+     * invoking any other SDK functions. The Brand ID is provided
+     * by Vyumi and is required for SDK configuration and API access.
+     *
+     * Debug logs can optionally be enabled for development purposes.
+     * It is recommended to disable debug logs in production builds.
+     *
+     * @param brandId The unique Brand ID provided by Vyumi.
+     * @param debug Pass true to enable SDK debug logs, false to disable them.
+     */
+    initialize(brandId_1) {
+        return __awaiter(this, arguments, void 0, function* (brandId, debug = false) {
+            yield (0, InitServices_1.initializeVyumiService)(brandId, debug);
+        });
+    }
+    /**
+     * Initiates an instant call request.
+     *
+     * This attempts to connect the customer with an available agent.
+     * Call session updates such as queue status, agent availability,
+     * room readiness, and call completion are delivered through the
+     * provided CallSessionCallback.
+     *
+     * @param payload Object containing customer information and call metadata.
+     * @param call_type Type of call to initiate (audio or video).
+     * @param sessionCallback Callback used to monitor call session events.
+     */
+    initiateCall(payload, call_type, sessionCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield CallService_1.default.initiateCall(payload, call_type, sessionCallback);
+        });
+    }
+    /**
+     * Joins the active call room.
+     *
+     * This must be called after receiving the room-ready event from
+     * the CallSessionCallback. The provided view handles are used
+     * to render the local and remote video streams.
+     *
+     * Microphone permission is required. Camera permission is also
+     * required when joining a video call.
+     *
+     * @param remoteViewHandle Native view handle used for rendering the remote participant's video stream.
+     * @param localViewHandle Native view handle used for rendering the local camera preview.
+     * @param interactionCallback Callback used to receive call interaction events.
+     */
+    joinCall(remoteViewHandle, localViewHandle, interactionCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield CallService_1.default.joinCall({ remoteViewHandle, localViewHandle, interactionCallback });
+        });
+    }
+    /**
+     * Mutes or unmutes the microphone.
+  
+     * Description: This function is used to control whether to use the collected audio data. Mute (turn off the microphone) will use the muted data to replace the audio data collected by the device for streaming. At this time, the microphone device will still be occupied.
+     * Default value: The default is `false`, which means no muting.
+     *
+     * @param mute Whether to mute (disable) the microphone, `true`: mute (disable) microphone, `false`: enable microphone.
+     */
+    muteMicrophone(mute) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ZegoServices_1.default.muteMicrophone(mute);
+        });
+    }
+    /**
+     * Switches to the front or the rear camera (for the specified channel).
+     * Default value: The default is `true` which means the front camera is used.
+     *
+     * @param enable `true`: use the front camera, `false`: use the the rear camera.
+     */
+    flipCamera(flip) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ZegoServices_1.default.flipCamera(flip);
+        });
+    }
+    /**
+     * Turns on/off the camera (for the specified channel).
+     *
+     * @param enable Whether to turn on the camera, `true`: turn on camera, `false`: turn off camera
+     */
+    enableCamera(enable) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ZegoServices_1.default.enableCamera(enable);
+        });
+    }
+    /**
+     * Mutes or unmutes the audio output speaker.
+     *
+     * Description: After mute speaker, all the SDK sounds will not play, including playing stream, mediaplayer, etc.
+     * Default value: The default is `false`, which means no muting.
+     *
+     * @param mute Whether to mute (disable) speaker audio output, `true`: mute (disable) speaker audio output, `false`: enable speaker audio output.
+     */
+    muteSpeaker(mute) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ZegoServices_1.default.muteSpeaker(mute);
+        });
+    }
+    /**
+     * Sends a  Message.
+     *
+     * @param message The content of the message. Required: Yes. Value range: The length does not exceed 1024 bytes.
+  
+     */
+    sendMessage(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ZegoServices_1.default.sendMessage(message);
+        });
+    }
+    /**
+     * Ends the current active call session.
+     *
+     * This should always be called when the call screen is closed
+     * or when the conversation is finished to ensure that all
+     * resources are released properly.
+     */
+    endCall() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield CallService_1.default.endCall();
+        });
+    }
+    /**
+     * Cancels an ongoing call request.
+     *
+     * This can be used while the customer is waiting for an
+     * available agent before the call room has been joined.
+     * Once cancelled, the call request is terminated and
+     * the customer is removed from the queue.
+     */
+    cancelCall() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield CallService_1.default.cancelCall();
+        });
+    }
+    /**
+     * Fetches available time slots for scheduling calls.
+     *
+     * The response contains available dates and time slots
+     * along with the number of agents available for each slot.
+     *
+     * @param queryParams The customer's timezone (default: "Asia/Calcutta").
+     */
+    getScheduleTimeSlots(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield CallService_1.default.getCallTimeSlots(queryParams);
+        });
+    }
+    /**
+     * Schedules a call for a future time slot.
+     *
+     * The payload must contain required customer details such as
+     * name, mobile number, scheduled time (UTC), country code,
+     * WhatsApp subscription status, and timezone.
+     *
+     * @param payload JSONObject containing scheduling details.
+     */
+    scheduleCall(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield CallService_1.default.scheduleCall(payload);
+        });
+    }
+}
+const vyumiLiveCall = new VyumiLiveCall();
+exports.default = vyumiLiveCall;

package/dist/callbacks/callbacks.d.ts

@@ -0,0 +1,149 @@
+import { Message } from '../types/types';
+/**
+ * Callback interface for call session lifecycle events.
+ *
+ * Implement this interface to receive updates about agent assignment,
+ * queue status, room readiness, and session-related errors.
+ */
+export interface CallSessionCallback {
+    /**
+     * Called when the call room has been successfully created and is ready to join.
+     *
+     * Use this callback to update the UI and notify the user that the call
+     * session is ready.
+     *
+     * @param message Information about the room readiness state.
+     */
+    onRoomReady: (message: string) => void;
+    /**
+     * Called when no agents are currently available to handle the call request.
+     *
+     * Implement this callback to show an appropriate message or retry option
+     * to the user.
+     *
+     * @param message Details about agent unavailability.
+     */
+    onAgentNotAvailable: (message: string) => void;
+    /**
+     * Called while the SDK is attempting to connect the user to an available agent.
+     *
+     * Use this callback to display a loading state or connection progress indicator.
+     *
+     * @param message Information about the current connection status.
+     */
+    onConnectingToAgent: (message: string) => void;
+    /**
+     * Called when an agent has been successfully assigned to the call.
+     *
+     * Implement this callback to update the UI and prepare for the call session.
+     *
+     * @param message Information about the assigned agent.
+     */
+    onAgentAssigned: (message: string) => void;
+    /**
+     * Called whenever the user's position in the queue changes.
+     *
+     * Use this callback to display the latest queue position to the user.
+     *
+     * @param message Information about the queue update.
+     * @param queuePosition Current position of the user in the queue.
+     */
+    onQueueUpdate: (message: string, queuePosition: number) => void;
+    /**
+     * Called when a session-related error occurs.
+     *
+     * Implement this callback to handle errors and display appropriate messages.
+     *
+     * @param message Error description.
+     */
+    onError: (message: string) => void;
+}
+/**
+ * Callback interface for live call interaction events.
+ *
+ * Implement this interface to receive updates during an active call,
+ * such as messages, remote participant state changes, permissions,
+ * network quality, and call termination.
+ */
+export interface CallInteractionCallback {
+    /**
+     * Called when a new chat message is received during an active call.
+     *
+     * Use this callback to display incoming messages in the chat UI.
+     *
+     * @param message Received message object.
+     */
+    onReceivingMessage: (message: Message) => void;
+    /**
+     * Called when the remote participant's microphone state changes.
+     *
+     * Use this callback to update microphone indicators in the UI.
+     *
+     * @param muted Indicates whether the remote microphone is muted.
+     */
+    onRemoteMicUpdate: (muted: boolean) => void;
+    /**
+     * Called when the remote participant's camera state changes.
+     *
+     * Use this callback to show or hide the remote video stream,
+     * or update camera status indicators.
+     *
+     * @param enabled Indicates whether the remote camera is enabled.
+     */
+    onRemoteCameraUpdate: (enabled: boolean) => void;
+    /**
+     * Called when the call has ended, either by the user,
+     * the agent, or due to a system event.
+     *
+     * Implement this callback to clean up resources and navigate
+     * the user away from the call screen.
+     */
+    onCallEnded: () => void;
+    /**
+     * Called when a required permission (such as microphone or camera)
+     * is not granted by the user.
+     *
+     * This callback is optional.
+     *
+     * @param message Details about the missing permission.
+     */
+    onPermissionError?: (message: string) => void;
+    /**
+     * Called when an error occurs during an active call session.
+     *
+     * Implement this callback to log errors and notify the user.
+     *
+     * @param message Error description.
+     */
+    onError: (message: string) => void;
+    /**
+     * Called when the network quality of the connected agent changes.
+     *
+     * Use this callback to display network quality indicators
+     * and provide feedback about connection stability.
+     *
+     * @param quality Network quality value provided by the SDK.
+     */
+    onAgentNetworkQuality: (quality: number) => void;
+}
+/**
+ * Simplified callback interface for applications that only need
+ * basic call lifecycle events.
+ */
+export interface VyumiLiveCallCallback {
+    /**
+     * Called when the call has ended.
+     *
+     * Implement this callback to perform cleanup and update the UI.
+     */
+    onCallEnded: () => void;
+    /**
+     * Called when an unrecoverable error occurs.
+     *
+     * Implement this callback to display an error message
+     * or perform custom error handling.
+     *
+     * @param message Error description.
+     */
+    onError: (message: string) => void;
+}

package/dist/callbacks/callbacks.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/config/const.d.ts

@@ -0,0 +1 @@
+export declare const API_BASE_URL = "https://api.vyumi.ai";

package/dist/config/const.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_BASE_URL = void 0;
+exports.API_BASE_URL = 'https://api.vyumi.ai';

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { default as VyumiLiveCall } from './VyumiLiveCall';
+export { default as VyumiPrebuildCall } from './kit/index';
+export type { CallInteractionCallback, CallSessionCallback, VyumiLiveCallCallback, } from './callbacks/callbacks';

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VyumiPrebuildCall = exports.VyumiLiveCall = void 0;
+var VyumiLiveCall_1 = require("./VyumiLiveCall");
+Object.defineProperty(exports, "VyumiLiveCall", { enumerable: true, get: function () { return __importDefault(VyumiLiveCall_1).default; } });
+var index_1 = require("./kit/index");
+Object.defineProperty(exports, "VyumiPrebuildCall", { enumerable: true, get: function () { return __importDefault(index_1).default; } });

package/dist/kit/index.d.ts

@@ -0,0 +1,12 @@
+import { VyumiLiveCallCallback } from '../callbacks/callbacks';
+export interface ChatMessage {
+    id: string;
+    text: string;
+    from: 'user' | 'agent';
+    time: string;
+    name: string;
+}
+declare const VyumiPrebuildCall: React.FC<{
+    vyumiLiveCallCallBacks: VyumiLiveCallCallback;
+}>;
+export default VyumiPrebuildCall;