@trii/types 2.10.765 → 2.10.767

package/dist/src/Conversations/Assignment.d.ts

@@ -0,0 +1,81 @@
+import { ID } from './Conversation';
+export declare const CONVERSATION_ASSIGNMENT_EVENTS_COLLECTION = "conversation_assignment_events";
+export type ConversationAssignmentEventType = 'enqueued' | 'routing_started' | 'offered' | 'assigned' | 'accepted' | 'transferred' | 'released' | 'timed_out' | 'requeued';
+export type ConversationAssignmentReason = 'conversation_created' | 'routing_selected' | 'manual_assignment' | 'manual_transfer' | 'flow_routing' | 'offer_timeout' | 'assignment_timeout' | 'agent_accepted' | 'agent_released' | 'supervisor_released' | 'capacity_rebalance' | 'sla_escalation' | 'system_recovery';
+export type AssignmentOwnerReference = {
+    type: 'none';
+    id?: never;
+} | {
+    type: 'user' | 'bot' | 'flow';
+    id: ID;
+};
+export type AssignmentStateReference = {
+    status: 'unrouted';
+    assignmentId?: never;
+    queueId?: never;
+    owner: {
+        type: 'none';
+        id?: never;
+    } | {
+        type: 'bot' | 'flow';
+        id: ID;
+    };
+} | {
+    status: 'queued' | 'routing';
+    assignmentId: ID;
+    queueId: ID;
+    owner: {
+        type: 'none';
+        id?: never;
+    };
+} | {
+    status: 'offered' | 'assigned' | 'accepted';
+    assignmentId: ID;
+    queueId: ID;
+    owner: {
+        type: 'user';
+        id: ID;
+    };
+};
+export type AssignmentActorReference = {
+    type: 'system';
+    id?: never;
+} | {
+    type: 'user' | 'bot' | 'flow';
+    id: ID;
+};
+/**
+ * Immutable domain event stored in conversation_assignment_events.
+ *
+ * Events must only be inserted. Corrections are represented by a new event.
+ */
+export interface ConversationAssignmentEvent {
+    id: ID;
+    spaceId: ID;
+    conversationId: ID;
+    /**
+     * Monotonic order within a conversation.
+     */
+    sequence: number;
+    eventType: ConversationAssignmentEventType;
+    reason: ConversationAssignmentReason;
+    /**
+     * Undefined only when no previous assignment state existed.
+     */
+    previous?: AssignmentStateReference;
+    current: AssignmentStateReference;
+    actor: AssignmentActorReference;
+    routingDecisionId?: ID;
+    /**
+     * Version of conversations after applying the transition.
+     */
+    conversationVersion: number;
+    correlationId?: ID;
+    causationId?: ID;
+    idempotencyKey: string;
+    /**
+     * Domain time and persistence time, respectively.
+     */
+    occurredAt: Date;
+    recordedAt: Date;
+}

package/dist/src/Conversations/Assignment.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONVERSATION_ASSIGNMENT_EVENTS_COLLECTION = void 0;
+exports.CONVERSATION_ASSIGNMENT_EVENTS_COLLECTION = 'conversation_assignment_events';

package/dist/src/Conversations/Conversation.d.ts

@@ -4,16 +4,16 @@ import { GroupInfo } from "./Groups/Group";
 import { Channels } from "../Common/index";
 import { IContactAddress, IContactInfo } from "../Contacts/contacts";
 import { IEnding } from "./Ending";
+import { ChatType } from "../Chats/Chat";
 export interface IConversation {
     id: string;
-    /**only for Front-End */
-    idLocal?: number;
     spaceId: string;
+    version: number;
+    /** @deprecated Use assignment.owner. */
     type: ChatType;
-    ownerId: string;
+    /**only for Front-End */
     chatName: string;
     chatImage: string;
-    chatMembers: IChatMemeber[];
     chatMembersCount: number;
     whatsappGroupInfo?: IWhatsAppGroupInfo;
     contactInfo?: IContactInfo;
@@ -21,48 +21,55 @@ export interface IConversation {
     remoteAddress: string;
     remoteAddressId: string;
     channelInfo: Channels.IChannelInfo;
+    status: ConversationStatus;
+    priority: 'low' | 'normal' | 'high' | 'urgent';
+    assignment: ConversationAssignmentSnapshot;
+    /** @deprecated Use owner and assignment.*/
+    assignedTo?: ConversationAssigned;
+    sla: {
+        status: 'none' | 'running' | 'warning' | 'breached' | 'met';
+        deadlineAt?: Date;
+        policyId?: string;
+        version: number;
+    };
     lastMessage: string;
     lastMessageId?: string;
     newMessagesCount: number;
     newMessagesUnread: boolean;
+    lastActivityAt: Date;
+    lastCustomerActivityAt?: Date;
+    lastAgentActivityAt?: Date;
     labels: ILabel[];
     pinned: boolean;
+    /** @deprecated A transfer is represented by an event and the resulting current state. */
     transferBy?: string;
+    /** @deprecated A transfer is represented by an event and the resulting current state. */
     transferTo?: ConversationAssigned;
     expired: boolean;
+    /** @deprecated Expiration does not own a separate assignment snapshot.*/
     expiredAssignedTo: ConversationAssigned;
-    status: ConversationSatus;
-    assignedTo?: ConversationAssigned;
     participants: UserInfo[];
     archived: boolean;
+    spam: boolean;
     externalMessagingWindowEndAt?: Date;
     workflowId?: string;
     botStatus: ConversationBotStatus;
     botVars: ConversationBotVar[];
     metadata: IConversationMetadata;
     /** Domain objects discussed or served by this conversation. */
-    contextReferences?: IConversationContextReference[];
-    finalizedAt: Date;
-    finalizedBy?: string;
     finalizedOnWebChat: Date;
     ending?: IEnding;
     qualityEvaluation?: IInteractionQualityEvaluation;
     reOpenAt?: Date;
+    reOpenByUserId?: string;
+    reOpenPolicyId?: string;
     createdAt: Date;
     updatedAt: Date;
-}
-export declare enum ConversationContextType {
-    TICKET = "TICKET",
-    CONVERSATION = "CONVERSATION",
-    LEAD = "LEAD",
-    DEBT = "DEBT"
-}
-export interface IConversationContextReference {
-    entityType: ConversationContextType;
-    entityId: string;
-    role?: string;
-    linkedAt: Date;
-    linkedBy?: string;
+    resolvedAt?: Date;
+    resolvedByUserId?: string;
+    resolutionReasonId?: string;
+    finalizedAt: Date;
+    finalizedBy?: string;
 }
 export interface IWhatsAppGroupInfo {
     whatsappGroupId: string;
@@ -122,29 +129,14 @@ export declare enum ConversationBotStatus {
     FINALIZED = 4,
     CANCELED = 5
 }
-export declare class ConversationBotVar {
+export interface ConversationBotVar {
     title: string;
     value: string;
 }
-export declare enum ChatType {
-    /**Conversation with a external channel/contact */
-    EXTERNAL = 0,
-    /**messages between two users */
-    DIRECT = 1,
-    /**messages between multiple users */
-    GROUP = 2,
-    /**Messages to discuss a conversation */
-    DISCUSS_CONVERSATION = 11,
-    /**Messages to discuss a ticket */
-    DISCUSS_TICKET = 12
-}
-export interface IChatMemeber {
-    joinTimeStamp: Date;
-    isAdmin: boolean;
-    userId: string;
-    user: UserInfo;
-}
-export declare class ConversationAssigned {
+/**
+ * @deprecated Legacy channel assignment configuration. Use QueueRoutingConfig.
+ */
+export interface ConversationAssigned {
     groupInfo?: GroupInfo;
     userInfo?: UserInfo;
     userIds?: string[];
@@ -153,15 +145,216 @@ export declare enum ConversationDirection {
     INBOUND = 1,
     OUTBOUND = 2
 }
-export declare enum ConversationSatus {
-    NEW = 1,
-    ACTIVE = 2,
-    FINALIZED = 3,
-    ARCHIVED = 4
-}
+/**
+ * @deprecated Use QueueDistributionMode and QueueRoutingStrategy.
+ */
 export declare enum AssignMethod {
     ALL = 0,
     ROUND_ROBIN = 1,
     RANDOM = 2,
     LEAST_BUSY = 3
 }
+export declare enum ConversationStatus {
+    NEW = 1,
+    OPEN = 2,
+    ACTIVE = 2,// Alias for OPEN
+    RESOLVED = 3,
+    FINALIZED = 3,// Alias for RESOLVED
+    WAITING = 10
+}
+export type InboxViewId = 'pending' | 'following' | 'sla_warning' | 'sla_breached' | 'team_sla_breached' | 'resolved';
+export type OwnerType = 'user' | 'bot' | 'flow' | 'none';
+export interface NoConversationOwner {
+    type: 'none';
+    id?: never;
+    displayName?: never;
+    avatarUrl?: never;
+}
+export interface UserConversationOwner {
+    type: 'user';
+    id: ID;
+    displayName?: string;
+    avatarUrl?: string;
+}
+export interface BotConversationOwner {
+    type: 'bot';
+    id: ID;
+    displayName?: string;
+    avatarUrl?: string;
+}
+export interface FlowConversationOwner {
+    type: 'flow';
+    id: ID;
+    displayName?: string;
+    avatarUrl?: string;
+}
+export type ConversationOwner = NoConversationOwner | UserConversationOwner | BotConversationOwner | FlowConversationOwner;
+export type ConversationAssignmentStatus = 'unrouted' | 'queued' | 'routing' | 'offered' | 'assigned' | 'accepted';
+export type ConversationAssignmentSource = 'routing' | 'manual' | 'transfer' | 'requeue';
+interface QueuedConversationAssignmentBase {
+    assignmentId: ID;
+    queueId: ID;
+    source: ConversationAssignmentSource;
+    queuedAt: Date;
+    lastRoutingDecisionId?: ID;
+}
+export type ConversationAssignmentSnapshot = {
+    status: 'unrouted';
+    assignmentId?: never;
+    queueId?: never;
+    owner: NoConversationOwner | BotConversationOwner | FlowConversationOwner;
+    source?: never;
+    queuedAt?: never;
+    lastRoutingDecisionId?: never;
+    offeredAt?: never;
+    offerExpiresAt?: never;
+    assignedAt?: never;
+    acceptedAt?: never;
+} | (QueuedConversationAssignmentBase & {
+    status: 'queued' | 'routing';
+    owner: NoConversationOwner;
+    offeredAt?: never;
+    offerExpiresAt?: never;
+    assignedAt?: never;
+    acceptedAt?: never;
+}) | (QueuedConversationAssignmentBase & {
+    status: 'offered';
+    owner: UserConversationOwner;
+    offeredAt: Date;
+    offerExpiresAt?: Date;
+    assignedAt?: never;
+    acceptedAt?: never;
+}) | (QueuedConversationAssignmentBase & {
+    status: 'assigned';
+    owner: UserConversationOwner;
+    offeredAt?: Date;
+    offerExpiresAt?: Date;
+    assignedAt: Date;
+    acceptedAt?: never;
+}) | (QueuedConversationAssignmentBase & {
+    status: 'accepted';
+    owner: UserConversationOwner;
+    offeredAt?: Date;
+    offerExpiresAt?: Date;
+    assignedAt: Date;
+    acceptedAt: Date;
+});
+export type ActorType = 'user' | 'contact' | 'bot' | 'flow' | 'system';
+export type ParticipantRole = 'owner' | 'collaborator' | 'follower' | 'mentioned' | 'supervisor' | 'bot' | 'flow' | 'historical';
+export type ConversationEventType = 'conversation_created' | 'queued' | 'assigned' | 'accepted' | 'transferred' | 'consult_requested' | 'collaborator_added' | 'participant_added' | 'participant_removed' | 'participation_abandoned' | 'follow_started' | 'follow_stopped' | 'message_sent' | 'message_received' | 'internal_note_added' | 'bot_started' | 'bot_finished' | 'flow_started' | 'flow_finished' | 'status_changed' | 'resolved' | 'reopened' | 'sla_warning' | 'sla_breached' | 'sla_started' | 'sla_paused' | 'sla_resumed' | 'sla_met' | 'sla_overridden';
+export type ID = string;
+export type ConversationSubscriptionSource = 'manual' | 'assigned' | 'participated' | 'mentioned' | 'supervisor' | 'rule';
+export type ConversationSubscriptionNotificationEvent = 'customer_message' | 'internal_mention' | 'assignment_change' | 'acceptance' | 'resolution' | 'reopen';
+export type ConversationSubscriptionNotifications = {
+    mode: 'all' | 'muted';
+    events?: never;
+} | {
+    mode: 'custom';
+    events: [
+        ConversationSubscriptionNotificationEvent,
+        ...ConversationSubscriptionNotificationEvent[]
+    ];
+};
+interface ConversationSubscriptionBase {
+    id: ID;
+    spaceId: string;
+    conversationId: ID;
+    userId: ID;
+    source: ConversationSubscriptionSource;
+    notifications: ConversationSubscriptionNotifications;
+    createdAt: Date;
+    updatedAt: Date;
+    version: number;
+}
+/**
+ * Current following state for one user/conversation pair.
+ *
+ * A subscription is persistent product intent. Assignment or participation
+ * visibility must not create it unless an explicit auto-follow policy applies.
+ */
+export type ConversationSubscription = (ConversationSubscriptionBase & {
+    status: 'following';
+    followedAt: Date;
+    unfollowedAt?: never;
+}) | (ConversationSubscriptionBase & {
+    status: 'unfollowed';
+    followedAt: Date;
+    unfollowedAt: Date;
+});
+export type InboxVisibilityReason = 'manual_follow' | 'assigned_to_user' | 'shared_queue_member' | 'queue_claimable' | 'active_participant' | 'sla_warning_owner' | 'sla_breached_owner' | 'supervised_queue_sla' | 'supervisor_escalation' | 'resolved_visible';
+export interface ConversationInboxSnapshot {
+    interactionKind: 'private' | 'wall_post' | 'comment' | 'mention';
+    channelType: string;
+    contact: {
+        id?: ID;
+        displayName: string;
+        initials?: string;
+    };
+    status: ConversationStatus;
+    owner: ConversationOwner;
+    queueId?: ID;
+    preview?: string;
+    unreadCount: number;
+    priority: 'low' | 'normal' | 'high' | 'urgent';
+    sla: {
+        status: 'none' | 'running' | 'warning' | 'breached' | 'met';
+        deadlineAt?: Date;
+    };
+    lastActivityAt: Date;
+}
+/**
+ * Membership of one materialized conversation in one logical inbox view.
+ *
+ * visibilityReasons has set semantics: values must be unique and non-empty.
+ * Removing one reason preserves the view while at least one reason remains.
+ */
+export interface UserInboxItemView {
+    viewId: InboxViewId;
+    visibilityReasons: [
+        InboxVisibilityReason,
+        ...InboxVisibilityReason[]
+    ];
+    requiresAction: boolean;
+}
+/**
+ * Materialized read model. There is exactly one document for each
+ * spaceId + userId + conversationId tuple.
+ *
+ * views must contain unique viewId values. Delete the document when the last
+ * view is removed.
+ */
+export interface UserInboxItemDocument {
+    id: ID;
+    spaceId: ID;
+    userId: ID;
+    conversationId: ID;
+    views: UserInboxItemView[];
+    snapshot: ConversationInboxSnapshot;
+    pinned: boolean;
+    priorityScore: number;
+    sortAt: Date;
+    conversationVersion: number;
+    subscriptionVersion?: number;
+    projectionVersion: number;
+    lastSourceEventId: ID;
+    projectedAt: Date;
+}
+/**
+ * Materialized counters for exactly one user/view pair.
+ *
+ * total and requiresAction count conversations, never visibility reasons.
+ * unread counts conversations whose snapshot.unreadCount is greater than zero,
+ * not the number of unread messages.
+ */
+export interface UserInboxCounterDocument {
+    id: ID;
+    spaceId: ID;
+    userId: ID;
+    viewId: InboxViewId;
+    total: number;
+    requiresAction: number;
+    unread: number;
+    projectionVersion: number;
+    updatedAt: Date;
+}
+export {};

package/dist/src/Conversations/Conversation.js

@@ -1,13 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssignMethod = exports.ConversationSatus = exports.ConversationDirection = exports.ConversationAssigned = exports.ChatType = exports.ConversationBotVar = exports.ConversationBotStatus = exports.ConversationContextType = void 0;
-var ConversationContextType;
-(function (ConversationContextType) {
-    ConversationContextType["TICKET"] = "TICKET";
-    ConversationContextType["CONVERSATION"] = "CONVERSATION";
-    ConversationContextType["LEAD"] = "LEAD";
-    ConversationContextType["DEBT"] = "DEBT";
-})(ConversationContextType || (exports.ConversationContextType = ConversationContextType = {}));
+exports.ConversationStatus = exports.AssignMethod = exports.ConversationDirection = exports.ConversationBotStatus = void 0;
 var ConversationBotStatus;
 (function (ConversationBotStatus) {
     ConversationBotStatus[ConversationBotStatus["NONE"] = 0] = "NONE";
@@ -16,37 +9,14 @@ var ConversationBotStatus;
     ConversationBotStatus[ConversationBotStatus["FINALIZED"] = 4] = "FINALIZED";
     ConversationBotStatus[ConversationBotStatus["CANCELED"] = 5] = "CANCELED";
 })(ConversationBotStatus || (exports.ConversationBotStatus = ConversationBotStatus = {}));
-class ConversationBotVar {
-}
-exports.ConversationBotVar = ConversationBotVar;
-var ChatType;
-(function (ChatType) {
-    /**Conversation with a external channel/contact */
-    ChatType[ChatType["EXTERNAL"] = 0] = "EXTERNAL";
-    /**messages between two users */
-    ChatType[ChatType["DIRECT"] = 1] = "DIRECT";
-    /**messages between multiple users */
-    ChatType[ChatType["GROUP"] = 2] = "GROUP";
-    /**Messages to discuss a conversation */
-    ChatType[ChatType["DISCUSS_CONVERSATION"] = 11] = "DISCUSS_CONVERSATION";
-    /**Messages to discuss a ticket */
-    ChatType[ChatType["DISCUSS_TICKET"] = 12] = "DISCUSS_TICKET";
-})(ChatType || (exports.ChatType = ChatType = {}));
-class ConversationAssigned {
-}
-exports.ConversationAssigned = ConversationAssigned;
 var ConversationDirection;
 (function (ConversationDirection) {
     ConversationDirection[ConversationDirection["INBOUND"] = 1] = "INBOUND";
     ConversationDirection[ConversationDirection["OUTBOUND"] = 2] = "OUTBOUND";
 })(ConversationDirection || (exports.ConversationDirection = ConversationDirection = {}));
-var ConversationSatus;
-(function (ConversationSatus) {
-    ConversationSatus[ConversationSatus["NEW"] = 1] = "NEW";
-    ConversationSatus[ConversationSatus["ACTIVE"] = 2] = "ACTIVE";
-    ConversationSatus[ConversationSatus["FINALIZED"] = 3] = "FINALIZED";
-    ConversationSatus[ConversationSatus["ARCHIVED"] = 4] = "ARCHIVED";
-})(ConversationSatus || (exports.ConversationSatus = ConversationSatus = {}));
+/**
+ * @deprecated Use QueueDistributionMode and QueueRoutingStrategy.
+ */
 var AssignMethod;
 (function (AssignMethod) {
     AssignMethod[AssignMethod["ALL"] = 0] = "ALL";
@@ -54,3 +24,13 @@ var AssignMethod;
     AssignMethod[AssignMethod["RANDOM"] = 2] = "RANDOM";
     AssignMethod[AssignMethod["LEAST_BUSY"] = 3] = "LEAST_BUSY";
 })(AssignMethod || (exports.AssignMethod = AssignMethod = {}));
+var ConversationStatus;
+(function (ConversationStatus) {
+    ConversationStatus[ConversationStatus["NEW"] = 1] = "NEW";
+    ConversationStatus[ConversationStatus["OPEN"] = 2] = "OPEN";
+    ConversationStatus[ConversationStatus["ACTIVE"] = 2] = "ACTIVE";
+    ConversationStatus[ConversationStatus["RESOLVED"] = 3] = "RESOLVED";
+    ConversationStatus[ConversationStatus["FINALIZED"] = 3] = "FINALIZED";
+    ConversationStatus[ConversationStatus["WAITING"] = 10] = "WAITING";
+    // ARCHIVED = 4,
+})(ConversationStatus || (exports.ConversationStatus = ConversationStatus = {}));

package/dist/src/Conversations/DashBoard/dashboard.d.ts

@@ -17,8 +17,8 @@ export interface BodyDashboard {
     memberId: string | null;
     groupId: string;
     ending?: string | null;
-    /** For filter conversations with IConversation.assignedTo.userInfo.id */
-    assignedToUserId?: string | null;
+    /** Filters conversations by IConversation.assignment.owner.id. */
+    ownerUserId?: string | null;
 }
 export declare enum GeneralDashboardType {
     UNASSIGNED = 0,