@yext/chat-headless/src/models/slices/ConversationState.ts

A state manager library powered by Redux for Yext Chat integrations

import { Message, MessageNotes } from "@yext/chat-core";

/**
 * Maintains the data for the current conversation.
 *
 * @public
 */
export interface ConversationState {
  /** The id of the current conversation. */
  conversationId?: string;
  /** The messages in a conversation. */
  messages: Message[];
  /** Information relevant to the current state of the conversation, generated and provided by Chat API. */
  notes?: MessageNotes;
  /** Whether the next message is currently processing or has started responding. */
  isLoading: boolean;
  /**
   * Whether a new message can be sent to Chat API.
   * This is set to false when a previous message is being processed.
   */
  canSendMessage: boolean;
}