@webex/cc-store 1.28.0-ccwidgets.6 → 1.28.0-ccwidgets.60

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-import store from './store';
+import store from './storeEventsWrapper';
 export * from './store.types';
 export default store;

package/dist/types/store.d.ts

@@ -1,15 +1,43 @@
-import { IContactCenter, Team, WithWebex, IdleCode, InitParams, IStore } from './store.types';
+import { IContactCenter, Team, WithWebex, IdleCode, InitParams, IStore, ILogger, IWrapupCode, ICustomState, TaskMetaData, AgentLoginProfile } from './store.types';
+import { ITask } from '@webex/plugin-cc';
 declare class Store implements IStore {
+    private static instance;
     teams: Team[];
     loginOptions: string[];
     cc: IContactCenter;
+    logger: ILogger;
     idleCodes: IdleCode[];
     agentId: string;
-    selectedLoginOption: string;
+    currentTheme: string;
+    wrapupCodes: IWrapupCode[];
+    currentTask: ITask;
+    isAgentLoggedIn: boolean;
+    deviceType: string;
+    taskList: Record<string, ITask>;
+    dialNumber: string;
+    currentState: string;
+    customState: ICustomState;
+    consultCompleted: boolean;
+    consultInitiated: boolean;
+    consultAccepted: boolean;
+    isQueueConsultInProgress: boolean;
+    currentConsultQueueId: string;
+    consultStartTimeStamp: any;
+    lastStateChangeTimestamp?: number;
+    lastIdleCodeChangeTimestamp?: number;
+    showMultipleLoginAlert: boolean;
+    callControlAudio: MediaStream | null;
+    consultOfferReceived: boolean;
+    featureFlags: {
+        [key: string]: boolean;
+    };
+    isEndConsultEnabled: boolean;
+    allowConsultToQueue: boolean;
+    agentProfile: AgentLoginProfile;
+    taskMetaData: Record<string, TaskMetaData>;
     constructor();
-    setSelectedLoginOption(option: string): void;
-    registerCC(webex: WithWebex['webex']): Promise<void>;
-    init(options: InitParams): Promise<void>;
+    static getInstance(): Store;
+    registerCC(webex?: WithWebex['webex']): Promise<void>;
+    init(options: InitParams, setupEventListeners: any): Promise<void>;
 }
-declare const store: Store;
-export default store;
+export default Store;

package/dist/types/store.types.d.ts

@@ -1,7 +1,15 @@
-import { AgentLogin, IContactCenter, Profile, Team } from '@webex/plugin-cc';
+import { AgentLogin, IContactCenter, Profile, Team, LogContext, BuddyDetails, DestinationType, ContactServiceQueue, ITask } from '@webex/plugin-cc';
+type ILogger = {
+    log: (message: string, context?: LogContext) => void;
+    info: (message: string, context?: LogContext) => void;
+    warn: (message: string, context?: LogContext) => void;
+    trace: (message: string, context?: LogContext) => void;
+    error: (message: string, context?: LogContext) => void;
+};
 interface WithWebex {
     webex: {
         cc: IContactCenter;
+        logger: ILogger;
     };
 }
 interface WithWebexConfig {
@@ -15,13 +23,131 @@ type IdleCode = {
     isSystem: boolean;
     isDefault: boolean;
 };
+type TaskMetaData = {
+    consultCompleted: boolean;
+    consultInitiated: boolean;
+    consultAccepted: boolean;
+    isQueueConsultInProgress: boolean;
+    currentConsultQueueId: string;
+    consultStartTimeStamp: number;
+    consultOfferReceived: boolean;
+};
 interface IStore {
+    featureFlags: {
+        [key: string]: boolean;
+    };
     teams: Team[];
     loginOptions: string[];
     cc: IContactCenter;
     idleCodes: IdleCode[];
     agentId: string;
-    registerCC(webex: WithWebex['webex']): Promise<Profile>;
-    init(params: InitParams): Promise<void>;
+    logger: ILogger;
+    wrapupCodes: IWrapupCode[];
+    currentTask: ITask;
+    taskList: Record<string, ITask>;
+    taskMetaData: Record<string, TaskMetaData>;
+    isAgentLoggedIn: boolean;
+    deviceType: string;
+    dialNumber: string;
+    currentState: string;
+    lastStateChangeTimestamp?: number;
+    lastIdleCodeChangeTimestamp?: number;
+    showMultipleLoginAlert: boolean;
+    currentTheme: string;
+    customState: ICustomState;
+    consultCompleted: boolean;
+    consultInitiated: boolean;
+    consultAccepted: boolean;
+    isQueueConsultInProgress: boolean;
+    currentConsultQueueId: string;
+    consultStartTimeStamp?: number;
+    callControlAudio: MediaStream | null;
+    consultOfferReceived: boolean;
+    isEndConsultEnabled: boolean;
+    allowConsultToQueue: boolean;
+    agentProfile: AgentLoginProfile;
+    init(params: InitParams, callback: (ccSDK: IContactCenter) => void): Promise<void>;
+    registerCC(webex?: WithWebex['webex']): Promise<void>;
+}
+interface IStoreWrapper extends IStore {
+    store: IStore;
+    setCurrentTask(task: ITask): void;
+    refreshTaskList(): void;
+    setDeviceType(option: string): void;
+    setDialNumber(input: string): void;
+    setCurrentState(state: string): void;
+    setLastStateChangeTimestamp(timestamp: number): void;
+    setLastIdleCodeChangeTimestamp(timestamp: number): void;
+    setShowMultipleLoginAlert(value: boolean): void;
+    setCurrentTheme(theme: string): void;
+    setIsAgentLoggedIn(value: boolean): void;
+    setWrapupCodes(wrapupCodes: IWrapupCode[]): void;
+    setState(state: IdleCode | ICustomState): void;
+    setConsultCompleted(value: boolean): void;
+    setConsultInitiated(value: boolean): void;
+    setConsultAccepted(value: boolean): void;
+    setConsultStartTimeStamp(timestamp: number): void;
+    setAgentProfile(profile: Profile): void;
+}
+interface IWrapupCode {
+    id: string;
+    name: string;
 }
-export type { IContactCenter, Profile, Team, AgentLogin, WithWebex, IdleCode, InitParams, IStore };
+declare enum TASK_EVENTS {
+    TASK_INCOMING = "task:incoming",
+    TASK_ASSIGNED = "task:assigned",
+    TASK_MEDIA = "task:media",
+    TASK_HOLD = "task:hold",
+    TASK_UNHOLD = "task:unhold",
+    TASK_CONSULT = "task:consult",
+    TASK_CONSULT_END = "task:consultEnd",
+    TASK_CONSULT_ACCEPTED = "task:consultAccepted",
+    TASK_PAUSE = "task:pause",
+    TASK_RESUME = "task:resume",
+    TASK_END = "task:end",
+    TASK_WRAPUP = "task:wrapup",
+    TASK_REJECT = "task:rejected",
+    TASK_HYDRATE = "task:hydrate",
+    TASK_CONSULTING = "task:consulting",
+    TASK_CONSULT_QUEUE_CANCELLED = "task:consultQueueCancelled",
+    AGENT_CONTACT_ASSIGNED = "AgentContactAssigned",
+    CONTACT_RECORDING_PAUSED = "ContactRecordingPaused",
+    CONTACT_RECORDING_RESUMED = "ContactRecordingResumed",
+    AGENT_WRAPPEDUP = "AgentWrappedUp",
+    AGENT_OFFER_CONTACT = "AgentOfferContact",
+    AGENT_CONSULT_CREATED = "AgentConsultCreated"
+}
+declare enum CC_EVENTS {
+    AGENT_DN_REGISTERED = "agent:dnRegistered",
+    AGENT_LOGOUT_SUCCESS = "agent:logoutSuccess",
+    AGENT_STATION_LOGIN_SUCCESS = "agent:stationLoginSuccess",
+    AGENT_MULTI_LOGIN = "agent:multiLogin",
+    AGENT_STATE_CHANGE = "agent:stateChange",
+    AGENT_RELOGIN_SUCCESS = "agent:reloginSuccess",
+    AGENT_OFFER_CONSULT = "AgentOfferConsult"
+}
+interface ICustomStateSet {
+    name: string;
+    developerName: string;
+}
+interface ICustomStateReset {
+    reset: boolean;
+}
+type ICustomState = ICustomStateSet | ICustomStateReset;
+declare const ENGAGED_LABEL = "ENGAGED";
+declare const ENGAGED_USERNAME = "Engaged";
+type AgentLoginProfile = {
+    agentName?: string;
+    orgId?: string;
+    profileType?: string;
+    deviceType?: string;
+    roles?: Array<string>;
+    mmProfile?: {
+        chat: number;
+        email: number;
+        social: number;
+        telephony: number;
+    };
+};
+export type { IContactCenter, ITask, Profile, Team, AgentLogin, WithWebex, IdleCode, InitParams, IStore, ILogger, IWrapupCode, IStoreWrapper, ICustomState, DestinationType, BuddyDetails, ContactServiceQueue, TaskMetaData, AgentLoginProfile, };
+export { CC_EVENTS, TASK_EVENTS, ENGAGED_LABEL, ENGAGED_USERNAME };

package/dist/types/storeEventsWrapper.d.ts

@@ -0,0 +1,96 @@
+import { IStoreWrapper, IStore, InitParams, TASK_EVENTS, CC_EVENTS, IWrapupCode, WithWebex, ICustomState, IdleCode, IContactCenter, ITask, BuddyDetails, ContactServiceQueue, TaskMetaData, AgentLoginProfile } from './store.types';
+declare class StoreWrapper implements IStoreWrapper {
+    store: IStore;
+    onIncomingTask: ({ task }: {
+        task: ITask;
+    }) => void;
+    onTaskRejected?: (task: ITask, reason: string) => void;
+    onTaskAssigned?: (task: ITask) => void;
+    constructor();
+    get featureFlags(): {
+        [key: string]: boolean;
+    };
+    get teams(): Team[];
+    get loginOptions(): string[];
+    get cc(): IContactCenter;
+    get logger(): import("./store.types").ILogger;
+    get idleCodes(): IdleCode[];
+    get agentId(): string;
+    get deviceType(): string;
+    get dialNumber(): string;
+    get wrapupCodes(): IWrapupCode[];
+    get currentTask(): ITask;
+    get isAgentLoggedIn(): boolean;
+    get taskList(): Record<string, ITask>;
+    get currentState(): string;
+    get lastStateChangeTimestamp(): number;
+    get lastIdleCodeChangeTimestamp(): number;
+    get showMultipleLoginAlert(): boolean;
+    get currentTheme(): string;
+    get customState(): ICustomState;
+    get consultCompleted(): boolean;
+    get consultInitiated(): boolean;
+    get consultAccepted(): boolean;
+    get consultStartTimeStamp(): number;
+    get callControlAudio(): MediaStream;
+    get consultOfferReceived(): boolean;
+    get isQueueConsultInProgress(): boolean;
+    get currentConsultQueueId(): string;
+    get isEndConsultEnabled(): boolean;
+    get allowConsultToQueue(): boolean;
+    get taskMetaData(): Record<string, TaskMetaData>;
+    get agentProfile(): AgentLoginProfile;
+    setTaskMetaData: (taskId: string, data: TaskMetaData) => void;
+    setCurrentTheme: (theme: string) => void;
+    setShowMultipleLoginAlert: (value: boolean) => void;
+    setDeviceType: (option: string) => void;
+    setDialNumber: (input: string) => void;
+    setCurrentState: (state: string) => void;
+    setLastStateChangeTimestamp: (timestamp: number) => void;
+    setLastIdleCodeChangeTimestamp: (timestamp: number) => void;
+    setIsAgentLoggedIn: (value: boolean) => void;
+    setCurrentTask: (task: ITask) => void;
+    refreshTaskList: () => void;
+    setWrapupCodes: (wrapupCodes: IWrapupCode[]) => void;
+    setConsultCompleted: (value: boolean) => void;
+    setConsultInitiated: (value: boolean) => void;
+    setConsultAccepted: (value: boolean) => void;
+    setConsultOfferReceived: (value: boolean) => void;
+    setConsultStartTimeStamp: (timestamp: number) => void;
+    setCallControlAudio: (audio: MediaStream | null) => void;
+    setIsQueueConsultInProgress: (value: boolean) => void;
+    setCurrentConsultQueueId: (queueId: string | null) => void;
+    setState: (state: ICustomState | IdleCode) => void;
+    setIncomingTaskCb: (callback: (task: ITask) => void) => void;
+    setTaskRejected: (callback: ((task: ITask, reason: string) => void) | undefined) => void;
+    setTaskAssigned: (callback: ((task: ITask) => void) | undefined) => void;
+    setCCCallback: (event: CC_EVENTS | TASK_EVENTS, callback: any) => void;
+    setTaskCallback: (event: TASK_EVENTS, callback: any, taskId: string) => void;
+    setAgentProfile: (profile: AgentLoginProfile) => void;
+    removeCCCallback: (event: CC_EVENTS) => void;
+    removeTaskCallback: (event: TASK_EVENTS, callback: any, taskId: string) => void;
+    init(options: InitParams): Promise<void>;
+    registerCC: (webex?: WithWebex["webex"]) => Promise<void>;
+    handleTaskRemove: (taskId: any) => void;
+    handleTaskEnd: () => void;
+    handleTaskAssigned: (event: any) => void;
+    handleTaskWrapUp: (task: any) => void;
+    handleTaskMedia: (track: any) => void;
+    handleConsultCreated: () => void;
+    handleConsulting: (event: any) => void;
+    handleConsultEnd: (event: any) => void;
+    handleConsultOffer: () => void;
+    handleConsultAccepted: (event: any) => void;
+    handleConsultQueueCancelled: () => void;
+    handleIncomingTask: (event: any) => void;
+    handleStateChange: (data: any) => void;
+    handleMultiLoginCloseSession: (data: any) => void;
+    handleTaskHydrate: (event: any) => void;
+    handleTaskReject: (task: ITask, reason: string) => void;
+    getBuddyAgents: (mediaType?: string) => Promise<Array<BuddyDetails>>;
+    getQueues: (mediaType?: string) => Promise<Array<ContactServiceQueue>>;
+    cleanUpStore: () => void;
+    setupIncomingTaskHandler: (ccSDK: IContactCenter) => void;
+}
+declare const storeWrapper: StoreWrapper;
+export default storeWrapper;

package/dist/types/util.d.ts

@@ -0,0 +1,2 @@
+import { Profile } from './store.types';
+export declare function getFeatureFlags(agentProfile: Profile): {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@webex/cc-store",
   "description": "Webex Contact Center Widgets: Widgets Store",
-  "version": "1.28.0-ccwidgets.6",
+  "version": "1.28.0-ccwidgets.60",
   "main": "dist/index.js",
   "license": "MIT",
   "publishConfig": {
@@ -12,23 +12,25 @@
     "package.json"
   ],
   "scripts": {
+    "clean": "rm -rf dist && rm -rf node_modules",
+    "clean:dist": "rm -rf dist",
     "build": "yarn run -T tsc",
-    "build:src": "webpack && yarn run build",
+    "build:src": "yarn run clean:dist && webpack",
     "build:watch": "webpack --watch",
-    "test:unit": "jest"
+    "test:unit": "jest --coverage",
+    "test:styles": "eslint"
   },
   "dependencies": {
+    "@webex/plugin-cc": "3.8.0-next.48",
     "mobx": "6.13.5",
-    "react": "18.3.1",
-    "react-dom": "18.3.1",
-    "typescript": "5.6.3",
-    "webex": "3.7.0-wxcc.4"
+    "typescript": "5.6.3"
   },
   "devDependencies": {
     "@babel/core": "7.25.2",
     "@babel/preset-env": "7.25.4",
     "@babel/preset-react": "7.24.7",
     "@babel/preset-typescript": "7.25.9",
+    "@eslint/js": "^9.20.0",
     "@testing-library/dom": "10.4.0",
     "@testing-library/jest-dom": "6.6.2",
     "@testing-library/react": "16.0.1",
@@ -36,10 +38,21 @@
     "@types/react-test-renderer": "18",
     "babel-jest": "29.7.0",
     "babel-loader": "9.2.1",
+    "eslint": "^9.20.1",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^15.0.0 || ^16.0.0 ",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-react": "^7.37.4",
     "file-loader": "6.2.0",
+    "globals": "^16.0.0",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
+    "prettier": "^3.5.1",
     "ts-loader": "9.5.1",
+    "typescript-eslint": "^8.24.1",
     "webpack": "5.94.0",
     "webpack-cli": "5.1.4",
     "webpack-merge": "6.0.1"
@@ -50,6 +63,5 @@
       "**/tests/**/*.ts",
       "**/tests/**/*.tsx"
     ]
-  },
-  "stableVersion": "1.28.0-ccwidgets.5"
+  }
 }

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,oDAA4B;AAC5B,gDAA8B;AAC9B,kBAAe,eAAK,CAAC"}

package/dist/store.js

@@ -1,66 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const mobx_1 = require("mobx");
-const webex_1 = __importDefault(require("webex"));
-class Store {
-    constructor() {
-        this.teams = [];
-        this.loginOptions = [];
-        this.idleCodes = [];
-        this.agentId = '';
-        this.selectedLoginOption = '';
-        (0, mobx_1.makeAutoObservable)(this, { cc: mobx_1.observable.ref });
-    }
-    setSelectedLoginOption(option) {
-        this.selectedLoginOption = option;
-    }
-    registerCC(webex) {
-        this.cc = webex.cc;
-        return this.cc
-            .register()
-            .then((response) => {
-            this.teams = response.teams;
-            this.loginOptions = response.loginVoiceOptions;
-            this.idleCodes = response.idleCodes;
-            this.agentId = response.agentId;
-        })
-            .catch((error) => {
-            console.error('Error registering contact center', error);
-            return Promise.reject(error);
-        });
-    }
-    init(options) {
-        if ('webex' in options) {
-            // If devs decide to go with webex, they will have to listen to the ready event before calling init
-            // This has to be documented
-            return this.registerCC(options.webex);
-        }
-        return new Promise((resolve, reject) => {
-            const timer = setTimeout(() => {
-                reject(new Error('Webex SDK failed to initialize'));
-            }, 6000);
-            const webex = webex_1.default.init({
-                config: options.webexConfig,
-                credentials: {
-                    access_token: options.access_token,
-                },
-            });
-            webex.once('ready', () => {
-                clearTimeout(timer);
-                this.registerCC(webex)
-                    .then(() => {
-                    resolve();
-                })
-                    .catch((error) => {
-                    reject(error);
-                });
-            });
-        });
-    }
-}
-const store = new Store();
-exports.default = store;
-//# sourceMappingURL=store.js.map

package/dist/store.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"store.js","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":";;;;;AAAA,+BAAoD;AACpD,kDAA0B;AAG1B,MAAM,KAAK;IAQT;QAPA,UAAK,GAAW,EAAE,CAAC;QACnB,iBAAY,GAAa,EAAE,CAAC;QAE5B,cAAS,GAAe,EAAE,CAAC;QAC3B,YAAO,GAAW,EAAE,CAAC;QACrB,wBAAmB,GAAW,EAAE,CAAC;QAG/B,IAAA,yBAAkB,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,iBAAU,CAAC,GAAG,EAAC,CAAC,CAAC;IACjD,CAAC;IAED,sBAAsB,CAAC,MAAc;QACnC,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC;IACpC,CAAC;IAED,UAAU,CAAC,KAAyB;QAClC,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC,EAAE;aACX,QAAQ,EAAE;aACV,IAAI,CAAC,CAAC,QAAiB,EAAE,EAAE;YAC1B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;YAC5B,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,iBAAiB,CAAC;YAC/C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;YACpC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;QAClC,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;YACzD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI,CAAC,OAAmB;QACtB,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,mGAAmG;YACnG,4BAA4B;YAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,MAAM,CAAC,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC,CAAC;YACtD,CAAC,EAAE,IAAI,CAAC,CAAC;YAET,MAAM,KAAK,GAAG,eAAK,CAAC,IAAI,CAAC;gBACvB,MAAM,EAAE,OAAO,CAAC,WAAW;gBAC3B,WAAW,EAAE;oBACX,YAAY,EAAE,OAAO,CAAC,YAAY;iBACnC;aACF,CAAC,CAAC;YAEH,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;gBACvB,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;qBACnB,IAAI,CAAC,GAAG,EAAE;oBACT,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACf,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;AAC1B,kBAAe,KAAK,CAAC"}

package/dist/store.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=store.types.js.map

package/dist/store.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"store.types.js","sourceRoot":"","sources":["../src/store.types.ts"],"names":[],"mappings":""}