@eeacms/volto-eea-chatbot 1.0.9

package/src/ChatBlock/types/interfaces.ts

@@ -0,0 +1,154 @@
+import type { Packet, OnyxDocument } from './streamingModels';
+import { PacketType } from './streamingModels';
+
+export type FeedbackType = 'like' | 'dislike';
+
+export enum RetrievalType {
+  None = 'none',
+  Search = 'search',
+  SelectedDocs = 'selectedDocs',
+}
+
+export enum ResearchType {
+  LegacyAgentic = 'LEGACY_AGENTIC',
+  Thoughtful = 'THOUGHTFUL',
+  Deep = 'DEEP',
+  Fast = 'FAST',
+}
+
+export enum ChatFileType {
+  IMAGE = 'image',
+  DOCUMENT = 'document',
+  PLAIN_TEXT = 'plain_text',
+  CSV = 'csv',
+  USER_KNOWLEDGE = 'user_knowledge',
+}
+
+export interface Message {
+  messageId: number | null;
+  nodeId: number;
+  message: string; // Unique identifier for tree structure (can be negative for temp messages)
+  error?: string;
+  type: 'user' | 'assistant' | 'system' | 'error';
+  retrievalType?: RetrievalType;
+  researchType?: ResearchType;
+  query?: string | null;
+  files: FileDescriptor[];
+  toolCall: ToolCallMetadata | null;
+
+  // for rebuilding the message tree
+  parentNodeId: number | null;
+  childrenNodeIds?: number[];
+  latestChildNodeId?: number | null;
+  overridden_model?: string;
+
+  // Packet-based data
+  packets: Packet[];
+  groupedPackets?: { ind: number; packets: Packet[] }[];
+
+  // Packet indices for tracking
+  toolPackets?: number[];
+  displayPackets?: number[];
+
+  // Message status
+  isComplete?: boolean;
+  isFinalMessageComing?: boolean;
+
+  // Cached values for easy access
+  documents?: OnyxDocument[] | null;
+  citations?: Record<string, string>; // citation_num -> document_id
+  relatedQuestions?: { question: string }[] | null;
+
+  // Feedback state
+  currentFeedback?: FeedbackType | null;
+
+  // Timestamps
+  time_sent?: string;
+}
+
+export interface RendererResult {
+  icon: React.ComponentType<{ size: number }> | null;
+  status: string | null;
+  content: JSX.Element;
+  expandedText?: JSX.Element;
+}
+
+export interface MessageRendererProps<T extends Packet = Packet> {
+  packets: T[];
+  message: Message;
+  libs: {
+    [key: string]: any;
+  };
+  markers?: any;
+  stableContextSources?: any;
+  addQualityMarkersPlugin?: any;
+  onComplete: () => void;
+  animate: boolean;
+  stopPacketSeen: boolean;
+  children: (result: RendererResult) => JSX.Element;
+}
+
+export type MessageRenderer<T extends Packet = Packet> = React.FC<
+  MessageRendererProps<T>
+>;
+
+export interface GroupedPackets {
+  ind: number;
+  packets: Packet[];
+}
+
+export interface FileDescriptor {
+  id: string;
+  type: ChatFileType;
+  name?: string | null;
+
+  user_file_id?: string | null;
+  // FE only
+  isUploading?: boolean;
+}
+
+export interface Filters {
+  source_type: string[] | null;
+  document_set: string[] | null;
+  time_cutoff: Date | null;
+}
+
+export interface ToolCallMetadata {
+  tool_name: string;
+  tool_args: Record<string, any>;
+  tool_result?: Record<string, any>;
+}
+
+export interface ChatMessageProps {
+  message: Message;
+  isLoading: boolean;
+  isDeepResearchEnabled?: boolean;
+  libs?: any;
+  onChoice?: (message: string) => void;
+  onFetchRelatedQuestions?: () => void;
+  enableFeedback?: boolean;
+  scrollToInput?: boolean;
+  feedbackReasons?: string[];
+  qualityCheck?: string;
+  qualityCheckStages?: any[];
+  qualityCheckContext?: string;
+  qualityCheckEnabled?: boolean;
+  noSupportDocumentsMessage?: any;
+  totalFailMessage?: any;
+  isFetchingRelatedQuestions?: boolean;
+  enableShowTotalFailMessage?: boolean;
+  enableMatomoTracking?: boolean;
+  persona?: number;
+  maxContextSegments?: number;
+  isLastMessage?: boolean;
+  className?: string;
+  chatWindowRef?: React.RefObject<HTMLDivElement>;
+  chatWindowEndRef?: React.RefObject<HTMLDivElement>;
+  showTools?: PacketType[];
+}
+
+export interface Persona {
+  id: number;
+  name: string;
+  description?: string;
+}

package/src/ChatBlock/types/slate.d.ts

@@ -0,0 +1,3 @@
+declare module '@plone/volto-slate/editor/render' {
+  export const serializeNodes: any;
+}

package/src/ChatBlock/types/streamingModels.ts

@@ -0,0 +1,267 @@
+/**
+ * Streaming Models for Onyx v2
+ * Based on the new packet-based architecture
+ */
+
+export interface OnyxDocument {
+  document_id: string;
+  semantic_identifier: string;
+  link: string | null;
+  blurb: string;
+  content?: string;
+  source_type: string;
+  updated_at: string | null;
+  match_highlights: string[];
+  db_doc_id?: number;
+  score?: number;
+}
+
+interface BaseObj {
+  type: string;
+}
+
+export enum PacketType {
+  MESSAGE_START = 'message_start',
+  MESSAGE_DELTA = 'message_delta',
+  MESSAGE_END = 'message_end',
+
+  STOP = 'stop',
+  SECTION_END = 'section_end',
+
+  // Specific tool packets
+  SEARCH_TOOL_START = 'internal_search_tool_start',
+  SEARCH_TOOL_DELTA = 'internal_search_tool_delta',
+  IMAGE_GENERATION_TOOL_START = 'image_generation_tool_start',
+  IMAGE_GENERATION_TOOL_DELTA = 'image_generation_tool_delta',
+  FETCH_TOOL_START = 'fetch_tool_start',
+
+  // Custom tool packets
+  CUSTOM_TOOL_START = 'custom_tool_start',
+  CUSTOM_TOOL_DELTA = 'custom_tool_delta',
+
+  // Reasoning packets
+  REASONING_START = 'reasoning_start',
+  REASONING_DELTA = 'reasoning_delta',
+  REASONING_END = 'reasoning_end',
+
+  CITATION_START = 'citation_start',
+  CITATION_DELTA = 'citation_delta',
+  CITATION_END = 'citation_end',
+
+  MESSAGE_END_ID_INFO = 'message_end_id_info',
+
+  ERROR = 'error',
+}
+
+// Basic Message Packets
+export interface MessageStart extends BaseObj {
+  id: string;
+  type: PacketType.MESSAGE_START;
+  content: string;
+  final_documents: OnyxDocument[] | null;
+}
+
+export interface MessageDelta extends BaseObj {
+  content: string;
+  type: PacketType.MESSAGE_DELTA;
+}
+
+export interface MessageEnd extends BaseObj {
+  type: PacketType.MESSAGE_END;
+}
+
+// Control Packets
+export interface Stop extends BaseObj {
+  type: PacketType.STOP;
+}
+
+export interface SectionEnd extends BaseObj {
+  type: PacketType.SECTION_END;
+}
+
+// Specific tool packets
+export interface SearchToolStart extends BaseObj {
+  type: PacketType.SEARCH_TOOL_START;
+  is_internet_search?: boolean;
+}
+
+export interface SearchToolDelta extends BaseObj {
+  type: PacketType.SEARCH_TOOL_DELTA;
+  queries: string[] | null;
+  documents: OnyxDocument[] | null;
+}
+
+export type ImageShape = 'square' | 'landscape' | 'portrait';
+
+export interface GeneratedImage {
+  file_id: string;
+  url: string;
+  revised_prompt: string;
+  shape?: ImageShape;
+}
+
+export interface ImageGenerationToolStart extends BaseObj {
+  type: PacketType.IMAGE_GENERATION_TOOL_START;
+}
+
+export interface ImageGenerationToolDelta extends BaseObj {
+  type: PacketType.IMAGE_GENERATION_TOOL_DELTA;
+  images: GeneratedImage[];
+}
+
+export interface FetchToolStart extends BaseObj {
+  type: PacketType.FETCH_TOOL_START;
+  queries: string[] | null;
+  documents: OnyxDocument[] | null;
+}
+
+// Custom Tool Packets
+export interface CustomToolStart extends BaseObj {
+  type: PacketType.CUSTOM_TOOL_START;
+  tool_name: string;
+}
+
+export interface CustomToolDelta extends BaseObj {
+  type: PacketType.CUSTOM_TOOL_DELTA;
+  tool_name: string;
+  response_type: string;
+  data?: any;
+  file_ids?: string[] | null;
+}
+
+// Reasoning Packets
+export interface ReasoningStart extends BaseObj {
+  type: PacketType.REASONING_START;
+}
+
+export interface ReasoningDelta extends BaseObj {
+  type: PacketType.REASONING_DELTA;
+  reasoning: string;
+}
+
+export interface ReasoningEnd extends BaseObj {
+  type: PacketType.REASONING_END;
+}
+
+// Citation Packets
+export interface StreamingCitation {
+  citation_num: number;
+  document_id: string;
+}
+
+export interface CitationStart extends BaseObj {
+  type: PacketType.CITATION_START;
+}
+
+export interface CitationDelta extends BaseObj {
+  type: PacketType.CITATION_DELTA;
+  citations: StreamingCitation[];
+}
+
+export interface CitationEnd extends BaseObj {
+  type: PacketType.CITATION_END;
+}
+
+export interface MessageEndIdInfo extends BaseObj {
+  type: PacketType.MESSAGE_END_ID_INFO;
+  user_message_id: number;
+  reserved_assistant_message_id: number;
+}
+
+// Error packet
+export interface ErrorObj extends BaseObj {
+  type: PacketType.ERROR;
+  error: string;
+}
+
+export type ChatObj = MessageStart | MessageDelta | MessageEnd;
+export type StopObj = Stop;
+export type SectionEndObj = SectionEnd;
+
+// Specific tool objects
+export type SearchToolObj = SearchToolStart | SearchToolDelta | SectionEnd;
+export type ImageGenerationToolObj =
+  | ImageGenerationToolStart
+  | ImageGenerationToolDelta
+  | SectionEnd;
+export type FetchToolObj = FetchToolStart | SectionEnd;
+export type CustomToolObj = CustomToolStart | CustomToolDelta | SectionEnd;
+export type NewToolObj =
+  | SearchToolObj
+  | ImageGenerationToolObj
+  | FetchToolObj
+  | CustomToolObj;
+
+export type ReasoningObj =
+  | ReasoningStart
+  | ReasoningDelta
+  | ReasoningEnd
+  | SectionEnd;
+export type CitationObj =
+  | CitationStart
+  | CitationDelta
+  | CitationEnd
+  | SectionEnd;
+
+// Union type for all possible streaming objects
+export type ObjTypes =
+  | ChatObj
+  | NewToolObj
+  | ReasoningObj
+  | StopObj
+  | SectionEndObj
+  | CitationObj
+  | ErrorObj
+  | MessageEndIdInfo;
+
+// Packet wrapper for streaming objects
+export interface Packet {
+  ind: number;
+  obj: ObjTypes;
+}
+
+export interface ChatPacket {
+  ind: number;
+  obj: ChatObj;
+}
+
+export interface StopPacket {
+  ind: number;
+  obj: StopObj;
+}
+
+export interface CitationPacket {
+  ind: number;
+  obj: CitationObj;
+}
+
+// New specific tool packet types
+export interface SearchToolPacket {
+  ind: number;
+  obj: SearchToolObj;
+}
+
+export interface ImageGenerationToolPacket {
+  ind: number;
+  obj: ImageGenerationToolObj;
+}
+
+export interface FetchToolPacket {
+  ind: number;
+  obj: FetchToolObj;
+}
+
+export interface CustomToolPacket {
+  ind: number;
+  obj: CustomToolObj;
+}
+
+export interface ReasoningPacket {
+  ind: number;
+  obj: ReasoningObj;
+}
+
+export interface SectionEndPacket {
+  ind: number;
+  obj: SectionEndObj;
+}

package/src/ChatBlock/types/volto.d.ts

@@ -0,0 +1,3 @@
+declare module '@plone/volto/helpers/Loadable' {
+  export const injectLazyLibs: any;
+}

package/src/ChatBlock/utils/citations.ts

@@ -0,0 +1,25 @@
+import type { Message } from '../types/interfaces';
+
+/**
+ * Regex to match citation markers like [1], [2], etc.
+ * The negative lookahead (?![[(\])])  ensures we don't match citations
+ * that are already formatted as links like [1](1) or [1][ or [1]]
+ */
+const CITATION_MATCH = /\[\d+\](?![[(\])])/gm;
+
+/**
+ * Transforms citation markers [1] into markdown links [1](1)
+ * so they can be rendered as clickable citations by the Citation component.
+ *
+ * @param text - The text containing citation markers
+ * @returns The text with citations transformed into markdown links
+ */
+export function addCitations(text: string, message: Message): string {
+  return text.replaceAll(CITATION_MATCH, (match) => {
+    const number = match.match(/\d+/)?.[0];
+    if (!number || !message.citations) {
+      return text;
+    }
+    return `[${match}](${message.citations[number]})`;
+  });
+}

package/src/ChatBlock/utils/index.tsx

@@ -0,0 +1,114 @@
+import type { ReactNode, MutableRefObject } from 'react';
+import { useState, useCallback, useEffect } from 'react';
+
+export const EMAIL_REGEX = /([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})/g;
+
+interface CreateChatMessageFeedbackArgs {
+  chat_message_id: string;
+  feedback_text?: string;
+  is_positive: boolean;
+  predefined_feedback?: string;
+}
+
+// Convert text with email addresses to mailto links
+export function transformEmailsToLinks(text: string): (string | ReactNode)[] {
+  return text.split(EMAIL_REGEX).map((part, index) => {
+    if (EMAIL_REGEX.test(part)) {
+      return (
+        <a key={index} href={`mailto:${part}`} className="text-email">
+          {part}
+        </a>
+      );
+    }
+    return part;
+  });
+}
+
+export function debounce(
+  callable: () => void,
+  click_signal: MutableRefObject<boolean | null>,
+): void {
+  if (!click_signal.current) {
+    click_signal.current = true;
+    setTimeout(() => {
+      click_signal.current = null;
+    }, 1000);
+    callable();
+  }
+}
+
+export const useCopyToClipboard = (text: string): [boolean, () => void] => {
+  const [copied, setCopied] = useState(false);
+
+  const copy = useCallback(() => {
+    navigator.clipboard.writeText(text).then(
+      () => setCopied(true),
+      () => setCopied(false),
+    );
+  }, [text]);
+
+  useEffect(() => {
+    if (!copied) return;
+
+    const timeout = setTimeout(() => setCopied(false), 2000);
+
+    return () => clearTimeout(timeout);
+  }, [copied]);
+
+  return [copied, copy];
+};
+
+export function convertToPercentage(
+  floatValue: number,
+  digits: number = 2,
+): string {
+  if (floatValue < 0 || floatValue > 1) {
+    return '0%';
+  }
+  return (floatValue * 100).toFixed(digits) + '%';
+}
+
+export async function createChatMessageFeedback({
+  chat_message_id,
+  feedback_text = '',
+  is_positive,
+  predefined_feedback = '',
+}: CreateChatMessageFeedbackArgs): Promise<any> {
+  const payload: {
+    chat_message_id: string;
+    feedback_text: string;
+    is_positive: boolean;
+    predefined_feedback?: string;
+  } = {
+    chat_message_id,
+    feedback_text,
+    is_positive,
+  };
+
+  if (!is_positive) {
+    payload.predefined_feedback = predefined_feedback;
+  }
+
+  const createChatMessageFeedbackResponse = await fetch(
+    '/_da/chat/create-chat-message-feedback',
+    {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(payload),
+    },
+  );
+
+  if (!createChatMessageFeedbackResponse.ok) {
+    //eslint-disable-next-line no-console
+    console.log(
+      `Failed to submit feedback - ${createChatMessageFeedbackResponse.status}`,
+    );
+    throw Error(`Failed to submit feedback.`);
+  }
+
+  const createChatMessageFeedbackResponseJson =
+    await createChatMessageFeedbackResponse.json();
+  return await createChatMessageFeedbackResponseJson;
+}

package/src/halloumi/README.md

@@ -0,0 +1 @@
+code based on Apache2 licensed https://github.com/oumi-ai/halloumi-demo/tree/d088e1f25e7785326a53bc120113e226ee2f54b7