@webex/contact-center 3.12.0-next.8 → 3.12.0-task-refactor.1

package/dist/types/services/task/state-machine/TaskStateMachine.d.ts

@@ -0,0 +1,906 @@
+/**
+ * Task State Machine Configuration
+ *
+ * This file defines the XState state machine configuration for contact center tasks.
+ * It orchestrates state transitions, guards, and actions for task lifecycle management.
+ *
+ * GUARD FUNCTIONS: All guard logic is centralized in guards.ts for reusability and testing.
+ * This file imports and uses those guards via the `guards` object.
+ */
+import { TaskContext, TaskEventPayload, UIControlConfig, TaskActionsMap } from './types';
+import { TaskState } from './constants';
+/**
+ * Get task state machine configuration with UI control config
+ * Defines all states, transitions, guards, and actions for task management
+ *
+ * @param uiControlConfig - UI control configuration
+ * @returns State machine configuration object
+ */
+export declare function getTaskStateMachineConfig(uiControlConfig: UIControlConfig): {
+    id: string;
+    initial: TaskState;
+    context: TaskContext;
+    on: {
+        RECORDING_STARTED: {
+            actions: string[];
+        };
+        CONTACT_UPDATED: {
+            actions: string[];
+        };
+        CONTACT_OWNER_CHANGED: {
+            actions: string[];
+        };
+        HYDRATE: {
+            actions: string[];
+        };
+    };
+    states: {
+        IDLE: {
+            on: {
+                HYDRATE: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    actions: string[];
+                    guard?: undefined;
+                    target?: undefined;
+                })[];
+                TASK_INCOMING: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULTING_ACTIVE: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        OFFERED: {
+            on: {
+                TASK_OFFERED: {
+                    actions: string[];
+                };
+                ASSIGN: ({
+                    guard: ({ event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                RONA: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                TASK_WRAPUP: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONTACT_ENDED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                ASSIGN_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                INVITE_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                OUTBOUND_FAILED: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                CONSULTING_ACTIVE: {
+                    target: TaskState;
+                    actions: string[];
+                }[];
+                OFFER_CONSULT: {
+                    actions: string[];
+                };
+                CONSULT_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT_END: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        CONNECTED: {
+            on: {
+                CONSULTING_ACTIVE: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                ASSIGN: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                HOLD_INITIATED: {
+                    target: TaskState;
+                };
+                HOLD_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                TRANSFER_SUCCESS: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    actions: string[];
+                    guard?: undefined;
+                    target?: undefined;
+                })[];
+                TRANSFER_FAILED: {
+                    actions: string[];
+                };
+                CONTACT_ENDED: ({
+                    guard: ({ event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TASK_WRAPUP: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                PAUSE_RECORDING: {
+                    actions: string[];
+                };
+                RESUME_RECORDING: {
+                    actions: string[];
+                };
+            };
+        };
+        HOLD_INITIATING: {
+            on: {
+                HOLD_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                HOLD_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        HELD: {
+            on: {
+                UNHOLD_INITIATED: {
+                    target: TaskState;
+                };
+                UNHOLD_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                TRANSFER_SUCCESS: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TRANSFER_FAILED: {
+                    actions: string[];
+                };
+                CONTACT_ENDED: ({
+                    guard: ({ event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TASK_WRAPUP: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        RESUME_INITIATING: {
+            on: {
+                UNHOLD_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                UNHOLD_FAILED: {
+                    target: TaskState;
+                };
+            };
+        };
+        CONSULT_INITIATING: {
+            on: {
+                HOLD_SUCCESS: {
+                    actions: string[];
+                };
+                HOLD_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT_FAILED: ({
+                    guard: ({ context }: {
+                        context: any;
+                    }) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                CTQ_CANCEL: ({
+                    guard: ({ event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+            };
+        };
+        CONSULTING: {
+            on: {
+                CONSULTING_ACTIVE: {
+                    actions: string[];
+                };
+                CONSULT_END: ({
+                    guard: ({ context, event }: {
+                        context: any;
+                        event: any;
+                    }) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                SWITCH_TO_MAIN_CALL: {
+                    actions: string[];
+                };
+                SWITCH_TO_CONSULT: {
+                    actions: string[];
+                };
+                HOLD_SUCCESS: {
+                    actions: string[];
+                };
+                UNHOLD_SUCCESS: {
+                    actions: string[];
+                };
+                TRANSFER_SUCCESS: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TRANSFER_FAILED: {
+                    actions: string[];
+                };
+                TRANSFER_CONFERENCE: {
+                    actions: string[];
+                };
+                TRANSFER_CONFERENCE_SUCCESS: ({
+                    guard: ({ context }: {
+                        context: any;
+                    }) => boolean;
+                    actions: string[];
+                    target?: undefined;
+                } | {
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TRANSFER_CONFERENCE_FAILED: {
+                    actions: string[];
+                };
+                ASSIGN: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONTACT_ENDED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                TASK_WRAPUP: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                MERGE_TO_CONFERENCE: {
+                    target: TaskState;
+                };
+                CONFERENCE_START: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        CONF_INITIATING: {
+            on: {
+                CONFERENCE_START: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONFERENCE_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        CONFERENCING: {
+            on: {
+                CONFERENCE_START: {
+                    actions: string[];
+                };
+                EXIT_CONFERENCE_SUCCESS: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                CONSULT_END: {
+                    actions: string[];
+                };
+                HOLD_SUCCESS: {
+                    actions: string[];
+                };
+                UNHOLD_SUCCESS: {
+                    actions: string[];
+                };
+                CONSULT: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                PARTICIPANT_LEAVE: ({
+                    guard: (params: any) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    actions: string[];
+                    guard?: undefined;
+                    target?: undefined;
+                })[];
+                TRANSFER_CONFERENCE: {
+                    actions: string[];
+                };
+                TRANSFER_CONFERENCE_SUCCESS: {
+                    guard: ({ context }: {
+                        context: any;
+                    }) => boolean;
+                    actions: string[];
+                }[];
+                TRANSFER_CONFERENCE_FAILED: {
+                    actions: string[];
+                };
+                CONFERENCE_END: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    guard: ({ context, event }: {
+                        context: any;
+                        event: any;
+                    }) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                CONTACT_ENDED: {
+                    actions: string[];
+                }[];
+            };
+        };
+        WRAPPING_UP: {
+            entry: string[];
+            on: {
+                WRAPUP_COMPLETE: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        COMPLETED: {
+            type: "final";
+            entry: string[];
+        };
+        TERMINATED: {
+            type: "final";
+            entry: string[];
+        };
+    };
+};
+/**
+ * Create a task state machine instance using only the built-in actions.
+ * The resulting machine is ready for most consumers that rely on the default
+ * context mutators declared in actions.ts.
+ *
+ * @param uiControlConfig - UI control configuration
+ * @returns StateMachine instance for task management
+ */
+export declare function createTaskStateMachine(uiControlConfig: UIControlConfig, options?: {
+    actions?: Partial<TaskActionsMap>;
+}): import("xstate").StateMachine<TaskContext, TaskEventPayload, Record<string, import("xstate").AnyActorRef>, {
+    src: string;
+    logic: never;
+    id: string;
+}, {
+    type: string;
+    params: undefined;
+}, never, never, TaskState.IDLE | TaskState.OFFERED | TaskState.CONNECTED | TaskState.HOLD_INITIATING | TaskState.HELD | TaskState.RESUME_INITIATING | TaskState.CONSULT_INITIATING | TaskState.CONSULTING | TaskState.CONF_INITIATING | TaskState.CONFERENCING | TaskState.WRAPPING_UP | TaskState.COMPLETED | TaskState.TERMINATED, string, {}, {}, import("xstate").EventObject, import("xstate").MetaObject, {
+    id: string;
+    initial: TaskState;
+    context: TaskContext;
+    on: {
+        RECORDING_STARTED: {
+            actions: string[];
+        };
+        CONTACT_UPDATED: {
+            actions: string[];
+        };
+        CONTACT_OWNER_CHANGED: {
+            actions: string[];
+        };
+        HYDRATE: {
+            actions: string[];
+        };
+    };
+    states: {
+        IDLE: {
+            on: {
+                HYDRATE: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    actions: string[];
+                    guard?: undefined;
+                    target?: undefined;
+                })[];
+                TASK_INCOMING: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULTING_ACTIVE: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        OFFERED: {
+            on: {
+                TASK_OFFERED: {
+                    actions: string[];
+                };
+                ASSIGN: ({
+                    guard: ({ event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                RONA: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                TASK_WRAPUP: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONTACT_ENDED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                ASSIGN_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                INVITE_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                OUTBOUND_FAILED: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                CONSULTING_ACTIVE: {
+                    target: TaskState;
+                    actions: string[];
+                }[];
+                OFFER_CONSULT: {
+                    actions: string[];
+                };
+                CONSULT_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT_END: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        CONNECTED: {
+            on: {
+                CONSULTING_ACTIVE: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                ASSIGN: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                HOLD_INITIATED: {
+                    target: TaskState;
+                };
+                HOLD_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                TRANSFER_SUCCESS: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    actions: string[];
+                    guard?: undefined;
+                    target?: undefined;
+                })[];
+                TRANSFER_FAILED: {
+                    actions: string[];
+                };
+                CONTACT_ENDED: ({
+                    guard: ({ event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TASK_WRAPUP: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                PAUSE_RECORDING: {
+                    actions: string[];
+                };
+                RESUME_RECORDING: {
+                    actions: string[];
+                };
+            };
+        };
+        HOLD_INITIATING: {
+            on: {
+                HOLD_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                HOLD_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        HELD: {
+            on: {
+                UNHOLD_INITIATED: {
+                    target: TaskState;
+                };
+                UNHOLD_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                TRANSFER_SUCCESS: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TRANSFER_FAILED: {
+                    actions: string[];
+                };
+                CONTACT_ENDED: ({
+                    guard: ({ event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TASK_WRAPUP: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        RESUME_INITIATING: {
+            on: {
+                UNHOLD_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                UNHOLD_FAILED: {
+                    target: TaskState;
+                };
+            };
+        };
+        CONSULT_INITIATING: {
+            on: {
+                HOLD_SUCCESS: {
+                    actions: string[];
+                };
+                HOLD_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT_SUCCESS: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONSULT_FAILED: ({
+                    guard: ({ context }: {
+                        context: any;
+                    }) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                CTQ_CANCEL: ({
+                    guard: ({ event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+            };
+        };
+        CONSULTING: {
+            on: {
+                CONSULTING_ACTIVE: {
+                    actions: string[];
+                };
+                CONSULT_END: ({
+                    guard: ({ context, event }: {
+                        context: any;
+                        event: any;
+                    }) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                SWITCH_TO_MAIN_CALL: {
+                    actions: string[];
+                };
+                SWITCH_TO_CONSULT: {
+                    actions: string[];
+                };
+                HOLD_SUCCESS: {
+                    actions: string[];
+                };
+                UNHOLD_SUCCESS: {
+                    actions: string[];
+                };
+                TRANSFER_SUCCESS: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TRANSFER_FAILED: {
+                    actions: string[];
+                };
+                TRANSFER_CONFERENCE: {
+                    actions: string[];
+                };
+                TRANSFER_CONFERENCE_SUCCESS: ({
+                    guard: ({ context }: {
+                        context: any;
+                    }) => boolean;
+                    actions: string[];
+                    target?: undefined;
+                } | {
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                TRANSFER_CONFERENCE_FAILED: {
+                    actions: string[];
+                };
+                ASSIGN: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONTACT_ENDED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                TASK_WRAPUP: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                MERGE_TO_CONFERENCE: {
+                    target: TaskState;
+                };
+                CONFERENCE_START: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        CONF_INITIATING: {
+            on: {
+                CONFERENCE_START: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                CONFERENCE_FAILED: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        CONFERENCING: {
+            on: {
+                CONFERENCE_START: {
+                    actions: string[];
+                };
+                EXIT_CONFERENCE_SUCCESS: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                CONSULT_END: {
+                    actions: string[];
+                };
+                HOLD_SUCCESS: {
+                    actions: string[];
+                };
+                UNHOLD_SUCCESS: {
+                    actions: string[];
+                };
+                CONSULT: {
+                    target: TaskState;
+                    actions: string[];
+                };
+                PARTICIPANT_LEAVE: ({
+                    guard: (params: any) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    actions: string[];
+                    guard?: undefined;
+                    target?: undefined;
+                })[];
+                TRANSFER_CONFERENCE: {
+                    actions: string[];
+                };
+                TRANSFER_CONFERENCE_SUCCESS: {
+                    guard: ({ context }: {
+                        context: any;
+                    }) => boolean;
+                    actions: string[];
+                }[];
+                TRANSFER_CONFERENCE_FAILED: {
+                    actions: string[];
+                };
+                CONFERENCE_END: ({
+                    guard: ({ context, event }: import("./guards").GuardParams) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    guard: ({ context, event }: {
+                        context: any;
+                        event: any;
+                    }) => boolean;
+                    target: TaskState;
+                    actions: string[];
+                } | {
+                    target: TaskState;
+                    actions: string[];
+                    guard?: undefined;
+                })[];
+                CONTACT_ENDED: {
+                    actions: string[];
+                }[];
+            };
+        };
+        WRAPPING_UP: {
+            entry: string[];
+            on: {
+                WRAPUP_COMPLETE: {
+                    target: TaskState;
+                    actions: string[];
+                };
+            };
+        };
+        COMPLETED: {
+            type: "final";
+            entry: string[];
+        };
+        TERMINATED: {
+            type: "final";
+            entry: string[];
+        };
+    };
+}>;
+export type TaskStateMachine = ReturnType<typeof createTaskStateMachine>;