@webex/contact-center 0.0.0-next.1

package/src/config.ts

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

package/src/constants.ts

@@ -0,0 +1,51 @@
+export const EVENT = 'event';
+export const READY = 'ready';
+export const TIMEOUT_DURATION = 20000; // 20 seconds timeout duration for webrtc registration
+export const EMPTY_STRING = '';
+export const PRODUCT_NAME = 'wxcc_sdk';
+// FILE NAMES
+export const LOG_PREFIX = 'PLUGIN_CC';
+export const WEB_CALLING_SERVICE_FILE = 'WebCallingService';
+export const CONFIG_FILE_NAME = 'config-index';
+export const CC_FILE = 'cc';
+export const CONNECTION_SERVICE_FILE = 'connection-service';
+export const WEB_SOCKET_MANAGER_FILE = 'WebSocketManager';
+export const AQM_REQS_FILE = 'aqm-reqs';
+export const WEBEX_REQUEST_FILE = 'WebexRequest';
+export const TASK_MANAGER_FILE = 'TaskManager';
+export const TASK_FILE = 'Task';
+// AGENT OUTDIAL CONSTANTS
+export const OUTDIAL_DIRECTION = 'OUTBOUND';
+export const ATTRIBUTES = {};
+export const OUTDIAL_MEDIA_TYPE = 'telephony';
+export const OUTBOUND_TYPE = 'OUTDIAL';
+
+// Log related constants
+export const UNKNOWN_ERROR = 'Unknown error';
+export const MERCURY_DISCONNECTED_SUCCESS = 'Mercury disconnected successfully';
+
+// METHOD NAMES
+export const METHODS = {
+  REGISTER: 'register',
+  DEREGISTER: 'deregister',
+  GET_BUDDY_AGENTS: 'getBuddyAgents',
+  CONNECT_WEBSOCKET: 'connectWebsocket',
+  STATION_LOGIN: 'stationLogin',
+  STATION_LOGOUT: 'stationLogout',
+  STATION_RELOGIN: 'stationReLogin',
+  SET_AGENT_STATE: 'setAgentState',
+  HANDLE_WEBSOCKET_MESSAGE: 'handleWebsocketMessage',
+  SETUP_EVENT_LISTENERS: 'setupEventListeners',
+  GET_CONNECTION_CONFIG: 'getConnectionConfig',
+  HANDLE_CONNECTION_LOST: 'handleConnectionLost',
+  SILENT_RELOGIN: 'silentRelogin',
+  HANDLE_DEVICE_TYPE: 'handleDeviceType',
+  START_OUTDIAL: 'startOutdial',
+  GET_QUEUES: 'getQueues',
+  UPLOAD_LOGS: 'uploadLogs',
+  UPDATE_AGENT_PROFILE: 'updateAgentProfile',
+  GET_DEVICE_ID: 'getDeviceId',
+  HANDLE_INCOMING_TASK: 'handleIncomingTask',
+  HANDLE_TASK_HYDRATE: 'handleTaskHydrate',
+  INCOMING_TASK_LISTENER: 'incomingTaskListener',
+};

package/src/index.ts

@@ -0,0 +1,220 @@
+import {registerPlugin} from '@webex/webex-core';
+import config from './config';
+import ContactCenter from './cc';
+
+/** @module ContactCenterModule */
+
+// Core exports
+/**
+ * ContactCenter is the main plugin class for Webex Contact Center integration
+ * @category Core
+ */
+export {default as ContactCenter} from './cc';
+
+// Service exports
+/**
+ * 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';
+
+// Enums
+/**
+ * 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';
+
+// Interfaces
+/** 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';
+
+// 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';
+
+// Constants
+/**
+ * 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';
+
+registerPlugin('cc', ContactCenter, {
+  config,
+});
+
+/** The Contact Center plugin default export */
+export default ContactCenter;

package/src/logger-proxy.ts

@@ -0,0 +1,110 @@
+import {Logger, LogContext, LOGGING_LEVEL} from './types';
+import {LOG_PREFIX} from './constants';
+
+/**
+ * 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
+   */
+  public static logger: Logger;
+
+  /**
+   * Initializes the logger proxy with a provided logger implementation.
+   *
+   * @param {Logger} logger - A logger object implementing standard logging methods.
+   * @ignore
+   */
+  public static initialize(logger: Logger): void {
+    LoggerProxy.logger = logger;
+  }
+
+  /**
+   * 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
+   */
+  public static log(message: string, context: LogContext = {}): void {
+    if (LoggerProxy.logger) {
+      LoggerProxy.logger.log(LoggerProxy.format(LOGGING_LEVEL.log, message, context));
+    }
+  }
+
+  /**
+   * Logs an informational message.
+   *
+   * @param {string} message - The log message.
+   * @param {LogContext} [context={}] - Optional context providing module and method names.
+   * @ignore
+   */
+  public static info(message: string, context: LogContext = {}): void {
+    if (LoggerProxy.logger) {
+      LoggerProxy.logger.info(LoggerProxy.format(LOGGING_LEVEL.info, message, context));
+    }
+  }
+
+  /**
+   * Logs a warning message.
+   *
+   * @param {string} message - The warning message.
+   * @param {LogContext} [context={}] - Optional context providing module and method names.
+   * @ignore
+   */
+  public static warn(message: string, context: LogContext = {}): void {
+    if (LoggerProxy.logger) {
+      LoggerProxy.logger.warn(LoggerProxy.format(LOGGING_LEVEL.warn, message, context));
+    }
+  }
+
+  /**
+   * 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
+   */
+  public static trace(message: string, context: LogContext = {}): void {
+    if (LoggerProxy.logger) {
+      LoggerProxy.logger.trace(LoggerProxy.format(LOGGING_LEVEL.trace, message, context));
+    }
+  }
+
+  /**
+   * Logs an error message.
+   *
+   * @param {string} message - The error message.
+   * @param {LogContext} [context={}] - Optional context providing module and method names.
+   * @ignore
+   */
+  public static error(message: string, context: LogContext = {}): void {
+    if (LoggerProxy.logger) {
+      LoggerProxy.logger.error(LoggerProxy.format(LOGGING_LEVEL.error, message, context));
+    }
+  }
+
+  /**
+   * 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(level: LOGGING_LEVEL, message: string, context: LogContext): string {
+    const timestamp = new Date().toISOString();
+    const moduleName = context.module || 'unknown';
+    const methodName = context.method || 'unknown';
+    const interactionId = context.interactionId ? ` - interactionId:${context.interactionId}` : '';
+    const trackingId = context.trackingId ? ` - trackingId:${context.trackingId}` : '';
+
+    return `${timestamp} ${LOG_PREFIX} - [${level}]: module:${moduleName} - method:${methodName}${interactionId}${trackingId} - ${message}`;
+  }
+}