@webex/contact-center 0.0.0-next.1

package/dist/types/config.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Default configuration for the Webex Contact Center SDK.
+ *
+ * @public
+ * @example
+ * import config from './config';
+ * const allowMultiLogin = config.cc.allowMultiLogin;
+ * @ignore
+ */
+declare const _default: {
+    /**
+     * Contact Center configuration options.
+     * @public
+     */
+    cc: {
+        /**
+         * Whether to allow multiple logins from different devices.
+         * @type {boolean}
+         * @default false
+         */
+        allowMultiLogin: boolean;
+        /**
+         * Whether to automatically attempt relogin on connection loss.
+         * @type {boolean}
+         * @default true
+         */
+        allowAutomatedRelogin: boolean;
+        /**
+         * The type of client making the connection.
+         * @type {string}
+         * @default 'WebexCCSDK'
+         */
+        clientType: string;
+        /**
+         * Whether to enable keep-alive messages.
+         * @type {boolean}
+         * @default false
+         */
+        isKeepAliveEnabled: boolean;
+        /**
+         * Whether to force registration.
+         * @type {boolean}
+         * @default true
+         */
+        force: boolean;
+        /**
+         * Metrics configuration for the client.
+         * @public
+         */
+        metrics: {
+            /**
+             * Name of the client for metrics.
+             * @type {string}
+             * @default 'WEBEX_JS_SDK'
+             */
+            clientName: string;
+            /**
+             * Type of client for metrics.
+             * @type {string}
+             * @default 'WebexCCSDK'
+             */
+            clientType: string;
+        };
+    };
+};
+export default _default;

package/dist/types/constants.d.ts

@@ -0,0 +1,45 @@
+export declare const EVENT = "event";
+export declare const READY = "ready";
+export declare const TIMEOUT_DURATION = 20000;
+export declare const EMPTY_STRING = "";
+export declare const PRODUCT_NAME = "wxcc_sdk";
+export declare const LOG_PREFIX = "PLUGIN_CC";
+export declare const WEB_CALLING_SERVICE_FILE = "WebCallingService";
+export declare const CONFIG_FILE_NAME = "config-index";
+export declare const CC_FILE = "cc";
+export declare const CONNECTION_SERVICE_FILE = "connection-service";
+export declare const WEB_SOCKET_MANAGER_FILE = "WebSocketManager";
+export declare const AQM_REQS_FILE = "aqm-reqs";
+export declare const WEBEX_REQUEST_FILE = "WebexRequest";
+export declare const TASK_MANAGER_FILE = "TaskManager";
+export declare const TASK_FILE = "Task";
+export declare const OUTDIAL_DIRECTION = "OUTBOUND";
+export declare const ATTRIBUTES: {};
+export declare const OUTDIAL_MEDIA_TYPE = "telephony";
+export declare const OUTBOUND_TYPE = "OUTDIAL";
+export declare const UNKNOWN_ERROR = "Unknown error";
+export declare const MERCURY_DISCONNECTED_SUCCESS = "Mercury disconnected successfully";
+export declare const METHODS: {
+    REGISTER: string;
+    DEREGISTER: string;
+    GET_BUDDY_AGENTS: string;
+    CONNECT_WEBSOCKET: string;
+    STATION_LOGIN: string;
+    STATION_LOGOUT: string;
+    STATION_RELOGIN: string;
+    SET_AGENT_STATE: string;
+    HANDLE_WEBSOCKET_MESSAGE: string;
+    SETUP_EVENT_LISTENERS: string;
+    GET_CONNECTION_CONFIG: string;
+    HANDLE_CONNECTION_LOST: string;
+    SILENT_RELOGIN: string;
+    HANDLE_DEVICE_TYPE: string;
+    START_OUTDIAL: string;
+    GET_QUEUES: string;
+    UPLOAD_LOGS: string;
+    UPDATE_AGENT_PROFILE: string;
+    GET_DEVICE_ID: string;
+    HANDLE_INCOMING_TASK: string;
+    HANDLE_TASK_HYDRATE: string;
+    INCOMING_TASK_LISTENER: string;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,178 @@
+import ContactCenter from './cc';
+/** @module ContactCenterModule */
+/**
+ * ContactCenter is the main plugin class for Webex Contact Center integration
+ * @category Core
+ */
+export { default as ContactCenter } from './cc';
+/**
+ * Task class represents a contact center task that can be managed by an agent
+ * @category Services
+ */
+export { default as Task } from './services/task';
+/**
+ * Agent routing service for Contact Center operations
+ * @category Services
+ */
+export { default as routingAgent } from './services/agent';
+/**
+ * Task Events for Contact Center operations
+ * @enum {string}
+ * @category Enums
+ */
+export { TASK_EVENTS } from './services/task/types';
+export type { TASK_EVENTS as TaskEvents } from './services/task/types';
+/**
+ * Agent Events for Contact Center operations
+ * @enum {string}
+ * @category Enums
+ */
+export { AGENT_EVENTS } from './services/agent/types';
+export type { AGENT_EVENTS as AgentEvents } from './services/agent/types';
+/**
+ * Contact Center Task Events
+ * @enum {string}
+ * @category Enums
+ */
+export { CC_TASK_EVENTS } from './services/config/types';
+/**
+ * Contact Center Agent Events
+ * @enum {string}
+ * @category Enums
+ */
+export { CC_AGENT_EVENTS } from './services/config/types';
+/**
+ * Combined Contact Center Events
+ * @enum {string}
+ * @category Enums
+ */
+export { CC_EVENTS } from './services/config/types';
+export type { CC_EVENTS as ContactCenterEvents } from './services/config/types';
+/** Main types and interfaces for Contact Center functionality */
+export type { 
+/** Interface for Contact Center plugin */
+IContactCenter, 
+/** Configuration options for Contact Center plugin */
+CCPluginConfig, 
+/** WebexSDK interface */
+WebexSDK, } from './types';
+/** Agent related types */
+export type { 
+/** Login options for agents */
+LoginOption, 
+/** Agent login information */
+AgentLogin, 
+/** Agent device update information */
+AgentProfileUpdate, 
+/** Station login response */
+StationLoginResponse, 
+/** Station logout response */
+StationLogoutResponse, 
+/** Buddy agents response */
+BuddyAgentsResponse, 
+/** Buddy agents information */
+BuddyAgents, 
+/** Subscribe request parameters */
+SubscribeRequest, 
+/** Upload logs response */
+UploadLogsResponse, 
+/** Update device type response */
+UpdateDeviceTypeResponse, 
+/** Generic error interface */
+GenericError, 
+/** Set state response */
+SetStateResponse, } from './types';
+/** Task related types */
+export type { AgentContact, 
+/** Task interface */
+ITask, TaskData, 
+/** Task response */
+TaskResponse, ConsultPayload, ConsultEndPayload, ConsultTransferPayLoad, 
+/** Dialer payload */
+DialerPayload, TransferPayLoad, ResumeRecordingPayload, WrapupPayLoad, } from './services/task/types';
+/** Agent related types */
+export type { 
+/** State change interface */
+StateChange, 
+/** Logout interface */
+Logout, 
+/** State change success response */
+StateChangeSuccess, 
+/** Station login success response */
+StationLoginSuccess, 
+/** Extended station login success response with notification tracking */
+StationLoginSuccessResponse, 
+/** Device type update success response */
+DeviceTypeUpdateSuccess, 
+/** Agent login success response */
+LogoutSuccess, 
+/** Agent relogin success response */
+ReloginSuccess, 
+/** Agent state type */
+AgentState, 
+/** User station login parameters */
+UserStationLogin, 
+/** Device type for agent login */
+DeviceType, 
+/** Buddy agent details */
+BuddyDetails, 
+/** Buddy agents success response */
+BuddyAgentsSuccess, } from './services/agent/types';
+/** Config related types */
+export type { 
+/** Profile interface */
+Profile, 
+/** Contact service queue interface */
+ContactServiceQueue, 
+/** Response type from getUserUsingCI method */
+AgentResponse, 
+/** Response from getDesktopProfileById */
+DesktopProfileResponse, 
+/** Response from getMultimediaProfileById */
+MultimediaProfileResponse, 
+/** Response from getListOfTeams */
+ListTeamsResponse, 
+/** Response from getListOfAuxCodes */
+ListAuxCodesResponse, 
+/** Response from getSiteInfo */
+SiteInfo, 
+/** Response from getOrgInfo */
+OrgInfo, 
+/** Response from getOrganizationSetting */
+OrgSettings, 
+/** Response from getTenantData */
+TenantData, 
+/** Response from getURLMapping */
+URLMapping, 
+/** Response from getDialPlanData */
+DialPlanEntity, 
+/** Auxiliary code information */
+AuxCode, 
+/** Team information */
+TeamList, 
+/** Wrap-up reason information */
+WrapUpReason, 
+/** WebSocket event data */
+WebSocketEvent, 
+/** Wrap-up configuration data */
+WrapupData, 
+/** Base entity type */
+Entity, 
+/** Dial plan configuration */
+DialPlan, 
+/** Auxiliary code type (IDLE_CODE or WRAP_UP_CODE) */
+AuxCodeType, } from './services/config/types';
+/**
+ * Idle code constant
+ * @constant {string}
+ * @category Enums
+ */
+export { IDLE_CODE } from './services/config/types';
+/**
+ * Wrap up code constant
+ * @constant {string}
+ * @category Enums
+ */
+export { WRAP_UP_CODE } from './services/config/types';
+/** The Contact Center plugin default export */
+export default ContactCenter;

package/dist/types/logger-proxy.d.ts

@@ -0,0 +1,71 @@
+import { Logger, LogContext } from './types';
+/**
+ * LoggerProxy acts as a static proxy to route logging calls to an injected logger implementation.
+ * Ensures a consistent log format and centralizes logging behavior for the SDK.
+ * @ignore
+ */
+export default class LoggerProxy {
+    /**
+     * The static logger instance to be used by the proxy.
+     * @ignore
+     */
+    static logger: Logger;
+    /**
+     * Initializes the logger proxy with a provided logger implementation.
+     *
+     * @param {Logger} logger - A logger object implementing standard logging methods.
+     * @ignore
+     */
+    static initialize(logger: Logger): void;
+    /**
+     * Logs a generic message using the default log level.
+     *
+     * @param {string} message - The log message.
+     * @param {LogContext} [context={}] - Optional context providing module and method names.
+     * @ignore
+     */
+    static log(message: string, context?: LogContext): void;
+    /**
+     * Logs an informational message.
+     *
+     * @param {string} message - The log message.
+     * @param {LogContext} [context={}] - Optional context providing module and method names.
+     * @ignore
+     */
+    static info(message: string, context?: LogContext): void;
+    /**
+     * Logs a warning message.
+     *
+     * @param {string} message - The warning message.
+     * @param {LogContext} [context={}] - Optional context providing module and method names.
+     * @ignore
+     */
+    static warn(message: string, context?: LogContext): void;
+    /**
+     * Logs a trace-level message, useful for debugging.
+     *
+     * @param {string} message - The trace message.
+     * @param {LogContext} [context={}] - Optional context providing module and method names.
+     * @ignore
+     */
+    static trace(message: string, context?: LogContext): void;
+    /**
+     * Logs an error message.
+     *
+     * @param {string} message - The error message.
+     * @param {LogContext} [context={}] - Optional context providing module and method names.
+     * @ignore
+     */
+    static error(message: string, context?: LogContext): void;
+    /**
+     * Formats a log message with timestamp, log level, and context details.
+     *
+     * @private
+     * @param {LOGGING_LEVEL} level - Logging level (e.g., info, error).
+     * @param {string} message - The message to be logged.
+     * @param {LogContext} context - Context containing module and method metadata.
+     * @returns {string} The formatted log string.
+     * @ignore
+     */
+    private static format;
+}

package/dist/types/metrics/MetricsManager.d.ts

@@ -0,0 +1,223 @@
+import { EventPayload } from '@webex/internal-plugin-metrics/src/metrics.types';
+import { WebexSDK } from '../types';
+import { METRIC_EVENT_NAMES } from './constants';
+import { Failure } from '../services/core/GlobalTypes';
+export type MetricsType = 'behavioral' | 'operational' | 'business';
+/**
+ * @class MetricsManager
+ * @classdesc Manages the collection, batching, and submission of behavioral, operational, and business metrics for the Webex SDK.
+ * Implements a singleton pattern to ensure a single instance throughout the application lifecycle.
+ *
+ * @remarks
+ * This class is responsible for tracking, batching, and submitting various types of metric events.
+ * It also provides utility methods for extracting common tracking fields from AQM responses.
+ * @ignore
+ */
+export default class MetricsManager {
+    /**
+     * The Webex SDK instance used for submitting metrics.
+     * @private
+     */
+    private webex;
+    /**
+     * Stores currently running timed events.
+     * @private
+     */
+    private readonly runningEvents;
+    /**
+     * Queue for pending behavioral events.
+     * @private
+     */
+    private pendingBehavioralEvents;
+    /**
+     * Queue for pending operational events.
+     * @private
+     */
+    private pendingOperationalEvents;
+    /**
+     * Queue for pending business events.
+     * @private
+     */
+    private pendingBusinessEvents;
+    /**
+     * Indicates if the manager is ready to submit events.
+     * @private
+     */
+    private readyToSubmitEvents;
+    /**
+     * Lock to prevent concurrent submissions.
+     * @private
+     */
+    private submittingEvents;
+    /**
+     * Singleton instance of MetricsManager.
+     * @private
+     */
+    private static instance;
+    /**
+     * Flag to disable metrics collection.
+     * @private
+     */
+    private metricsDisabled;
+    /**
+     * Private constructor to enforce singleton pattern.
+     * @private
+     */
+    private constructor();
+    /**
+     * Marks the manager as ready to submit events and triggers submission.
+     * @private
+     */
+    private setReadyToSubmitEvents;
+    /**
+     * Submits all pending events if not already submitting.
+     * @private
+     */
+    private submitPendingEvents;
+    /**
+     * Submits all pending behavioral events if ready.
+     * @private
+     */
+    private submitPendingBehavioralEvents;
+    /**
+     * Submits all pending operational events if ready.
+     * @private
+     */
+    private submitPendingOperationalEvents;
+    /**
+     * Submits all pending business events if ready.
+     * @private
+     */
+    private submitPendingBusinessEvents;
+    /**
+     * Adds a duration property to the event payload if the event was timed.
+     * @param eventName - The name of the event.
+     * @param options - Optional event payload.
+     * @returns The event payload with duration if applicable.
+     * @private
+     */
+    private addDurationIfTimed;
+    /**
+     * Converts spaces in a string to underscores.
+     * @param str - The input string.
+     * @returns The string with spaces replaced by underscores.
+     * @public
+     * @example
+     * MetricsManager.spacesToUnderscore('my event name'); // 'my_event_name'
+     */
+    static spacesToUnderscore(str: string): string;
+    /**
+     * Prepares the event payload by removing empty or undefined fields and adding common metadata.
+     * @param obj - The original event payload.
+     * @returns The cleaned and enriched event payload.
+     * @private
+     */
+    private static preparePayload;
+    /**
+     * Checks if metrics collection is currently disabled.
+     * @returns True if metrics are disabled, false otherwise.
+     * @private
+     */
+    private isMetricsDisabled;
+    /**
+     * Enables or disables metrics collection. Clears pending events if disabled.
+     * @param disabled - Whether to disable metrics.
+     * @public
+     * @example
+     * MetricsManager.getInstance().setMetricsDisabled(true);
+     */
+    setMetricsDisabled(disabled: boolean): void;
+    /**
+     * Clears all pending events from the queues.
+     * @private
+     */
+    private clearPendingEvents;
+    /**
+     * Tracks a behavioral event and submits it if possible.
+     * @param name - The metric event name.
+     * @param options - Optional event payload.
+     * @public
+     * @example
+     * MetricsManager.getInstance().trackBehavioralEvent('AGENT_LOGIN', {agentId: '123'});
+     */
+    trackBehavioralEvent(name: METRIC_EVENT_NAMES, options?: EventPayload): void;
+    /**
+     * Tracks an operational event and submits it if possible.
+     * @param name - The metric event name.
+     * @param options - Optional event payload.
+     * @public
+     * @example
+     * MetricsManager.getInstance().trackOperationalEvent('AGENT_LOGOUT', {agentId: '123'});
+     */
+    trackOperationalEvent(name: METRIC_EVENT_NAMES, options?: EventPayload): void;
+    /**
+     * Tracks a business event and submits it if possible.
+     * @param name - The metric event name.
+     * @param options - Optional event payload.
+     * @public
+     * @example
+     * MetricsManager.getInstance().trackBusinessEvent('AGENT_TRANSFER', {agentId: '123'});
+     */
+    trackBusinessEvent(name: METRIC_EVENT_NAMES, options?: EventPayload): void;
+    /**
+     * Tracks an event across one or more metric services.
+     * @param name - The metric event name.
+     * @param payload - Optional event payload.
+     * @param metricServices - Array of metric types to track (default: ['behavioral']).
+     * @public
+     * @example
+     * MetricsManager.getInstance().trackEvent('AGENT_LOGIN', {agentId: '123'}, ['behavioral', 'operational']);
+     */
+    trackEvent(name: METRIC_EVENT_NAMES, payload?: EventPayload, metricServices?: MetricsType[]): void;
+    /**
+     * Starts timing for one or more event keys.
+     * @param keys - A string or array of strings representing event keys.
+     * @public
+     * @example
+     * MetricsManager.getInstance().timeEvent('AGENT_LOGIN');
+     * MetricsManager.getInstance().timeEvent(['AGENT_LOGIN', 'AGENT_LOGOUT']);
+     */
+    timeEvent(keys: string | string[]): void;
+    /**
+     * Sets the Webex SDK instance and marks the manager as ready when the SDK is ready.
+     * @param webex - The Webex SDK instance.
+     * @private
+     */
+    private setWebex;
+    /**
+     * Returns the singleton instance of MetricsManager, initializing it if necessary.
+     * @param options - Optional object containing the Webex SDK instance.
+     * @returns The singleton MetricsManager instance.
+     * @public
+     * @example
+     * const metrics = MetricsManager.getInstance({webex});
+     */
+    static getInstance(options?: {
+        webex: WebexSDK;
+    }): MetricsManager;
+    /**
+     * Resets the singleton instance of MetricsManager. Useful for testing.
+     * @public
+     * @example
+     * MetricsManager.resetInstance();
+     */
+    static resetInstance(): void;
+    /**
+     * Extracts common tracking fields from an AQM response object.
+     * @param response - The AQM response object.
+     * @returns An object containing common tracking fields.
+     * @public
+     * @example
+     * const fields = MetricsManager.getCommonTrackingFieldForAQMResponse(response);
+     */
+    static getCommonTrackingFieldForAQMResponse(response: any): Record<string, any>;
+    /**
+     * Extracts common tracking fields from an AQM failure response object.
+     * @param failureResponse - The AQM failure response object.
+     * @returns An object containing common tracking fields for failures.
+     * @public
+     * @example
+     * const fields = MetricsManager.getCommonTrackingFieldForAQMResponseFailed(failureResponse);
+     */
+    static getCommonTrackingFieldForAQMResponseFailed(failureResponse: Failure): Record<string, any>;
+}

package/dist/types/metrics/behavioral-events.d.ts

@@ -0,0 +1,29 @@
+import { MetricEventAgent, MetricEventProduct, MetricEventVerb } from '@webex/internal-plugin-metrics/src/metrics.types';
+import { METRIC_EVENT_NAMES } from './constants';
+/**
+ * Represents the taxonomy for a behavioral event in the metrics system.
+ * @ignore
+ * @typedef BehavioralEventTaxonomy
+ * @property {MetricEventProduct} product - The product associated with the behavioral event.
+ * @property {MetricEventAgent} agent - The agent responsible for the behavioral event.
+ * @property {string} target - The target entity of the behavioral event.
+ * @property {MetricEventVerb} verb - The action or verb describing the behavioral event.
+ *
+ * @category Metrics
+ * @type BehavioralEvents
+ */
+export type BehavioralEventTaxonomy = {
+    product: MetricEventProduct;
+    agent: MetricEventAgent;
+    target: string;
+    verb: MetricEventVerb;
+};
+/**
+ * Get the taxonomy information for a given behavioral event name.
+ * @ignore
+ * @param name - The name of the metric event to look up.
+ * @returns The corresponding {@link BehavioralEventTaxonomy} if found, otherwise `undefined`.
+ *
+ * @typedoc
+ */
+export declare function getEventTaxonomy(name: METRIC_EVENT_NAMES): BehavioralEventTaxonomy | undefined;