cat-documents-ng 1.0.28 → 1.0.30

package/lib/document/components/document-history/document-history.component.d.ts

@@ -5,6 +5,7 @@ import { DocumentViewerService } from '../../services/document-viewer.service';
 import { DocumentActionsService } from '../../services/document-actions.service';
 import { ConfirmationService } from 'primeng/api';
 import { DocumentHttpService } from '../../services/document-http.service';
+import { DocumentHistoryAiService } from '../../services/document-history-ai.service';
 import * as i0 from "@angular/core";
 /**
  * Component for displaying document history in a timeline format.
@@ -15,6 +16,7 @@ export declare class DocumentHistoryComponent implements OnChanges {
     private documentActionsService;
     private confirmationService;
     private documentHttpService;
+    documentHistoryAiService: DocumentHistoryAiService;
     /**
      * Input data for document history sections
      */
@@ -55,9 +57,10 @@ export declare class DocumentHistoryComponent implements OnChanges {
      * Whether the actions dropdown menu is visible
      */
     showActionsMenu: boolean;
-    constructor(documentHistoryService: DocumentHistoryService, documentViewerService: DocumentViewerService, documentActionsService: DocumentActionsService, confirmationService: ConfirmationService, documentHttpService: DocumentHttpService);
+    constructor(documentHistoryService: DocumentHistoryService, documentViewerService: DocumentViewerService, documentActionsService: DocumentActionsService, confirmationService: ConfirmationService, documentHttpService: DocumentHttpService, documentHistoryAiService: DocumentHistoryAiService);
     /**
      * Handles changes to input properties
+     * @param {SimpleChanges} changes - Changed input values.
      */
     ngOnChanges(changes: SimpleChanges): void;
     /**
@@ -74,29 +77,35 @@ export declare class DocumentHistoryComponent implements OnChanges {
     toggleAccordion(): void;
     /**
      * Process history data to add computed properties
+     * @returns {any[]} Processed history sections for rendering.
      */
     get processedHistoryData(): any[];
     /**
      * Downloads a document when clicked
-     * @param documentUrl - The URL of the document to download
-     * @param docName - The name of the document
+     * @param {string} documentUrl - The URL of the document to download.
+     * @param {string} docName - The name of the document.
      */
     downloadDocument(documentUrl: string, docName?: string): void;
     /**
      * Get alert count for the alerts section
+     * @returns {number} Alert count value.
      */
     getAlertCount(): number;
     /**
      * Get CSS class for event card based on action type
+     * @param {string} label - Event label text.
+     * @returns {string} CSS class name for event card.
      */
     getEventCardClass(label: string): string;
     /**
      * Get CSS class for event icon based on action type
+     * @param {string} label - Event label text.
+     * @returns {string} CSS class name for event icon.
      */
     getEventIconClass(label: string): string;
     /**
      * Get the appropriate icon for the event
-     * @param label - The event label
+     * @param {string} label - The event label.
      * @returns {string} The icon class
      */
     getEventIcon(label: string): string;
@@ -108,15 +117,42 @@ export declare class DocumentHistoryComponent implements OnChanges {
      * Close the actions dropdown menu
      */
     closeActionsMenu(): void;
+    /**
+     * Open AI sidebar with selected section
+     * @param {'Summary' | 'Query' | 'Insights'} section - AI section selected from menu.
+     */
+    openAiPanel(section: 'Summary' | 'Query' | 'Insights'): void;
     /**
      * Handle delete task action
      */
     onDeleteTask(): void;
     /**
      * Shows standard delete confirmation dialog
+     * @param {string} documentName - Document display name for confirmation message.
      * @private
      */
     private showStandardDeleteConfirmation;
+    /**
+     * Handles valuation report lookup success before delete confirmation.
+     * @param {string} documentId - Selected document id.
+     * @param {string} documentName - Document display name.
+     * @returns {(valuationReportData: any) => void} Callback for valuation report response.
+     */
+    private handleValuationReportCheckSuccess;
+    /**
+     * Handles valuation report lookup error before delete confirmation.
+     * @param {string} documentName - Document display name.
+     * @returns {(error: any) => void} Error callback.
+     */
+    private handleValuationReportCheckError;
+    /**
+     * Handles confirm action for delete dialog.
+     */
+    private handleConfirmDelete;
+    /**
+     * Handles cancel action for delete dialog.
+     */
+    private handleCancelDelete;
     /**
      * Performs the actual delete operation
      * @private
@@ -124,11 +160,12 @@ export declare class DocumentHistoryComponent implements OnChanges {
     private performDelete;
     /**
      * Set reference to document actions component
+     * @param {any} component - Document actions component reference.
      */
     setDocumentActionsComponent(component: any): void;
     /**
      * Handles document selection from history
-     * @param document - The selected document from history
+     * @param {HistoryDocument} document - The selected document from history.
      */
     onDocumentClick(document: HistoryDocument): void;
     /**
@@ -141,18 +178,28 @@ export declare class DocumentHistoryComponent implements OnChanges {
     private processHistoryData;
     /**
      * Gets the list of valid documents for a history item
-     * @param item - The history item
-     * @returns Array of valid documents
+     * @param {any} item - The history item.
+     * @returns {HistoryDocument[]} Array of valid documents.
      */
     private getValidDocuments;
     /**
      * Determines if a timeline item should be hidden
-     * @param item - The history item
-     * @returns True if the item should be hidden
+     * @param {any} item - The history item.
+     * @returns {boolean} True if the item should be hidden.
      */
     private shouldHideItem;
+    /**
+     * Sends a query to AI chat API and appends response in chat format.
+     */
+    sendQuery(): void;
+    /**
+     * Sends query when user presses Enter (without Shift).
+     * @param {KeyboardEvent} event - Keyboard event from textarea.
+     */
+    onQueryEnter(event: KeyboardEvent): void;
     /**
      * Listen for clicks outside the dropdown to close it
+     * @param {Event} event - Click event from document.
      */
     onDocumentClickOutside(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DocumentHistoryComponent, never>;

package/lib/document/services/document-history-ai.service.d.ts

@@ -0,0 +1,275 @@
+import { Observable } from 'rxjs';
+import { DocumentHttpService } from './document-http.service';
+import * as i0 from "@angular/core";
+export interface AiChatMessage {
+    role: 'user' | 'assistant';
+    content: string;
+    htmlContent?: string;
+}
+export interface DocumentHistoryAiState {
+    showAiMenu: boolean;
+    showAiSidebar: boolean;
+    aiSidebarHeader: 'Summary' | 'Query' | 'Insights';
+    aiContent: string;
+    aiContentHtml: string;
+    aiLoading: boolean;
+    aiError: string;
+    queryText: string;
+    queryLoading: boolean;
+    queryMessages: AiChatMessage[];
+}
+/**
+ * Handles AI-related document history workflows and formatting.
+ */
+export declare class DocumentHistoryAiService {
+    private documentHttpService;
+    /**
+     * UI state for AI panel and query chat.
+     */
+    state: DocumentHistoryAiState;
+    /**
+     * Creates an instance of DocumentHistoryAiService.
+     * @param {DocumentHttpService} documentHttpService - Service for AI API calls.
+     */
+    constructor(documentHttpService: DocumentHttpService);
+    /**
+     * Toggles AI dropdown visibility.
+     */
+    toggleAiMenu(): void;
+    /**
+     * Closes AI dropdown menu.
+     */
+    closeAiMenu(): void;
+    /**
+     * Opens AI sidebar and loads selected section data.
+     * @param {'Summary' | 'Query' | 'Insights'} section - Selected AI section.
+     * @param {any} selectedDocument - Selected document object.
+     */
+    openAiPanel(section: 'Summary' | 'Query' | 'Insights', selectedDocument: any): void;
+    /**
+     * Sends query using current query text in state.
+     * @param {any} selectedDocument - Selected document object.
+     */
+    sendQuery(selectedDocument: any): void;
+    /**
+     * Handles Enter key for query submission.
+     * @param {KeyboardEvent} event - Keyboard event from query textarea.
+     * @param {any} selectedDocument - Selected document object.
+     */
+    onQueryEnter(event: KeyboardEvent, selectedDocument: any): void;
+    /**
+     * Returns selected document id.
+     * @param {any} selectedDocument - Selected document object.
+     * @returns {string | undefined} Selected document id.
+     */
+    getCurrentDocumentId(selectedDocument: any): string | undefined;
+    /**
+     * Fetches AI content for summary or insights.
+     * @param {'Summary' | 'Insights'} section - AI section to load.
+     * @param {string} documentId - Document identifier.
+     * @returns {Observable<string>} Resolved AI content text.
+     */
+    fetchAiContent(section: 'Summary' | 'Insights', documentId: string): Observable<string>;
+    /**
+     * Fetches section content and returns text + formatted html.
+     * @param {'Summary' | 'Insights'} section - AI section to load.
+     * @param {any} selectedDocument - Selected document object.
+     * @returns {Observable<{ content: string; html: string }>} Content payload.
+     */
+    getAiContentForSection(section: 'Summary' | 'Insights', selectedDocument: any): Observable<{
+        content: string;
+        html: string;
+    }>;
+    /**
+     * Sends question against a document.
+     * @param {string} documentId - Document identifier.
+     * @param {string} question - User question.
+     * @returns {Observable<string>} Answer text.
+     */
+    askQuestion(documentId: string, question: string): Observable<string>;
+    /**
+     * Sends question and returns answer + formatted html.
+     * @param {any} selectedDocument - Selected document object.
+     * @param {string} question - User question.
+     * @returns {Observable<{ answer: string; html: string }>} Answer payload.
+     */
+    askQuestionForDocument(selectedDocument: any, question: string): Observable<{
+        answer: string;
+        html: string;
+    }>;
+    /**
+     * Returns section-specific generation error.
+     * @param {'Summary' | 'Insights'} section - Section name.
+     * @returns {string} Error message.
+     */
+    getSectionError(section: 'Summary' | 'Insights'): string;
+    /**
+     * Converts markdown-like output to presentable HTML.
+     * @param {string} content - Raw AI response content.
+     * @returns {string} Formatted HTML string.
+     */
+    formatAiContent(content: string): string;
+    /**
+     * Fetches summary text by document id.
+     * @param {string} documentId - Document identifier.
+     * @returns {Observable<string>} Summary text.
+     */
+    private fetchSummary;
+    /**
+     * Fetches insights text by document id.
+     * @param {string} documentId - Document identifier.
+     * @returns {Observable<string>} Insights text.
+     */
+    private fetchInsights;
+    /**
+     * Extracts summary text from API response.
+     * @param {any} response - Summary API response.
+     * @returns {string} Summary text.
+     */
+    private extractSummaryContent;
+    /**
+     * Extracts insights text from API response.
+     * @param {any} response - Insights API response.
+     * @returns {string} Insights text.
+     */
+    private extractInsightsContent;
+    /**
+     * Extracts answer text from question API response.
+     * @param {any} response - Question API response.
+     * @returns {string} Answer text.
+     */
+    private extractQuestionAnswer;
+    /**
+     * Maps content text to content payload.
+     * @param {string} content - Plain content text.
+     * @returns {{ content: string; html: string }} Content payload.
+     */
+    private toContentResult;
+    /**
+     * Maps answer text to answer payload.
+     * @param {string} answer - Plain answer text.
+     * @returns {{ answer: string; html: string }} Answer payload.
+     */
+    private toAnswerResult;
+    /**
+     * Initializes panel state for a selected section.
+     * @param {'Summary' | 'Query' | 'Insights'} section - Selected section.
+     */
+    private initializePanel;
+    /**
+     * Loads summary/insights content into UI state.
+     * @param {'Summary' | 'Insights'} section - Content section to load.
+     * @param {any} selectedDocument - Selected document object.
+     */
+    private loadAiContent;
+    /**
+     * Resets query-specific UI state.
+     */
+    private resetQueryState;
+    /**
+     * Adds user question into chat history and sets loading.
+     * @param {string} question - User question text.
+     */
+    private pushUserQuestion;
+    /**
+     * Handles successful summary/insights response and updates state.
+     * @param {{ content: string; html: string }} result - Formatted content result.
+     * @param {string} result.content - Raw AI content text.
+     * @param {string} result.html - Formatted AI HTML.
+     */
+    private handleAiContentResult;
+    /**
+     * Handles summary/insights request errors.
+     * @param {Error} error - Error object.
+     */
+    private handleAiContentRequestError;
+    /**
+     * Handles successful question response and updates state.
+     * @param {{ answer: string; html: string }} result - Formatted answer result.
+     * @param {string} result.answer - AI answer text.
+     * @param {string} result.html - Formatted AI answer HTML.
+     */
+    private handleQuestionResult;
+    /**
+     * Handles question request errors.
+     * @param {Error} error - Error object.
+     */
+    private handleQuestionRequestError;
+    /**
+     * Produces section-specific catchError handler.
+     * @param {'Summary' | 'Insights'} section - AI section.
+     * @returns {(error: any) => Observable<never>} Error handler.
+     */
+    private handleSectionError;
+    /**
+     * Converts summary request errors.
+     * @returns {Observable<never>} Error observable.
+     */
+    private handleSummaryError;
+    /**
+     * Converts insights request errors.
+     * @returns {Observable<never>} Error observable.
+     */
+    private handleInsightsError;
+    /**
+     * Converts ask-question request errors.
+     * @returns {Observable<never>} Error observable.
+     */
+    private handleAskQuestionError;
+    /**
+     * Converts ask-question-for-document errors.
+     * @returns {Observable<never>} Error observable.
+     */
+    private handleQuestionGenerationError;
+    /**
+     * Renders escaped lines into HTML blocks.
+     * @param {string[]} lines - Escaped content lines.
+     * @returns {string} Rendered HTML.
+     */
+    private renderMarkdownLines;
+    /**
+     * Pushes one markdown line into output.
+     * @param {string} line - Current line.
+     * @param {string[]} htmlParts - Output accumulator.
+     * @param {boolean} isInList - List tracking flag.
+     * @returns {boolean} Updated list tracking flag.
+     */
+    private pushMarkdownLine;
+    /**
+     * Closes list if it is currently open.
+     * @param {string[]} htmlParts - Output accumulator.
+     * @param {boolean} isInList - List tracking flag.
+     * @returns {boolean} Updated list flag.
+     */
+    private closeListIfNeeded;
+    /**
+     * Appends a bullet-list line.
+     * @param {string} line - Raw markdown line.
+     * @param {string[]} htmlParts - Output accumulator.
+     * @param {boolean} isInList - List tracking flag.
+     * @returns {boolean} Updated list flag.
+     */
+    private pushListLine;
+    /**
+     * Appends a paragraph line.
+     * @param {string} line - Raw markdown line.
+     * @param {string[]} htmlParts - Output accumulator.
+     * @param {boolean} isInList - List tracking flag.
+     * @returns {boolean} Updated list flag.
+     */
+    private pushParagraphLine;
+    /**
+     * Formats markdown bold markers.
+     * @param {string} text - Input text.
+     * @returns {string} Text with strong tags.
+     */
+    private formatBold;
+    /**
+     * Escapes HTML-sensitive characters.
+     * @param {string} text - Input text.
+     * @returns {string} Escaped text.
+     */
+    private escapeHtml;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentHistoryAiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DocumentHistoryAiService>;
+}

package/lib/document/services/document-http.service.d.ts

@@ -11,6 +11,24 @@ import { UserListModel } from '../models/user-list.model';
 import { StatusDataModel } from '../models/status-data.model';
 import { DocumentHistorySection } from '../models/document-history.model';
 import * as i0 from "@angular/core";
+export interface AiSummaryResponse {
+    success: boolean;
+    document_id: string;
+    documentSummary: string;
+}
+export interface AiInsightsResponse {
+    success: boolean;
+    document_id: string;
+    documentInsight: string;
+}
+export interface AiQuestionResponse {
+    success: boolean;
+    document_id: string;
+    question: string;
+    answer: string;
+    question_number: number;
+    token_optimized: boolean;
+}
 /**
  * Service for making HTTP requests related to documents.
  * Authentication is handled automatically by the HTTP interceptor in the main project.
@@ -34,6 +52,30 @@ export declare class DocumentHttpService {
      * @type {string}
      */
     get apiUrl(): string;
+    /**
+     * Returns base URL for document intelligence APIs.
+     * @returns {string} Base URL for AI endpoints.
+     */
+    get documentIntelligenceApiUrl(): string;
+    /**
+     * Calls AI summary endpoint for a document.
+     * @param {string} documentId - The document ID to summarize.
+     * @returns {Observable<AiSummaryResponse>} AI summary response.
+     */
+    getAiSummary(documentId: string): Observable<AiSummaryResponse>;
+    /**
+     * Calls AI insights endpoint for a document.
+     * @param {string} documentId - The document ID to generate insights for.
+     * @returns {Observable<AiInsightsResponse>} AI insights response.
+     */
+    getAiInsights(documentId: string): Observable<AiInsightsResponse>;
+    /**
+     * Calls AI question endpoint for chat answers.
+     * @param {string} documentId - The document ID used for context.
+     * @param {string} question - The question asked by the user.
+     * @returns {Observable<AiQuestionResponse>} AI question answer response.
+     */
+    askAiQuestion(documentId: string, question: string): Observable<AiQuestionResponse>;
     /**
      * Fetches a document by its path name and transforms the response for dropdown options.
      * Includes error handling for failed API requests.
@@ -52,19 +94,19 @@ export declare class DocumentHttpService {
      * Fetches a document by its path name and transforms the response for dropdown options.
      * Includes error handling for failed API requests.
      * @returns {Observable<any>} Observable that emits the transformed data for dropdown options.
-      */
+     */
     /**
      * Fetches a document by its path name and transforms the response for dropdown options.
      * @param {string} documentId - The document ID to fetch the document.
      * @returns {Observable<any>} Observable that emits the transformed data for dropdown options.
-    */
+     */
     getAlertsByDocumentID(documentId: string): Observable<DocumentAlertModel>;
     /**
      * Fetches a document by its folder ID and transforms the response for dropdown options.
      * @param {string} folderId - The folder ID to fetch the document.
      * @param {string} contextId - The context ID to fetch the document.
      * @returns {Observable<any>} Observable that emits the transformed data for dropdown options.
-    */
+     */
     getDocumentByFolderID(folderId: string, contextId: string): Observable<DocumentModel[]>;
     /**
      * Updates the name of a document.
@@ -76,10 +118,10 @@ export declare class DocumentHttpService {
      */
     updateDocumentName(documentId: string, payload: any): Observable<DocumentModel>;
     /**
-    * Fetches a userlist by its path name.
-    * @param {string} contextId - The document ID to fetch the document.
-    * @returns {Observable<UserListModel[]>} Observable that emits the user list data.
-    */
+     * Fetches a userlist by its path name.
+     * @param {string} contextId - The document ID to fetch the document.
+     * @returns {Observable<UserListModel[]>} Observable that emits the user list data.
+     */
     getUserListByContextId(contextId: string): Observable<UserListModel[]>;
     /**
      * Fetches document status count data by application ID with optional context ID and category parameters.
@@ -175,8 +217,8 @@ export declare class DocumentHttpService {
     downloadCsvFile(documentUrl: string): Observable<string>;
     /**
      * Downloads an email file (EML) with appropriate handling for different storage types
-     * @param documentUrl - URL of the email file
-     * @returns Observable of file content as text
+     * @param {string} documentUrl - URL of the email file
+     * @returns {Observable<string>} Observable of file content as text
      */
     downloadEmailFile(documentUrl: string): Observable<string>;
     documentRequest(payload: any): Observable<any>;

package/lib/document/services/document-scroll.service.d.ts

@@ -5,25 +5,38 @@ export interface ScrollTarget {
     element: Element;
     menuItemId: string;
 }
+/**
+ * Service to observe section visibility and scroll state; deselects menu item when section scrolls out of view.
+ */
 export declare class DocumentScrollService implements OnDestroy {
     private documentStore;
     private sectionObserver;
     private currentObservedSection;
     private isScrolling;
+    /** @type {(() => void) | null} */
     private scrollHandler;
     private scrollTimeout;
+    /** Pending deselect scheduled on ratio=0. Cancelled when ratio>0 so we don't deselect after a stale ratio=0. */
+    private deselectTimeoutId;
     constructor(documentStore: DocumentStore);
     /**
-     * Sets up scroll event listeners to track scrolling state
-     * @param containerElement - The container element to monitor for scroll events
+     * Sets up scroll event listeners to track scrolling state.
+     * @param {HTMLElement} containerElement - The container element to monitor for scroll events
      */
     setupScrollListeners(containerElement: HTMLElement): void;
     /**
-     * Sets up intersection observer to detect when the selected section scrolls out of view
-     * @param sectionElement - The section element to observe
-     * @param menuItemId - The ID of the selected menu item
+     * Sets up intersection observer to deselect when the selected section scrolls out of view.
+     * @param {Element} sectionElement - The section element to observe
+     * @param {string} menuItemId - The ID of the selected menu item
      */
     setupSectionObserver(sectionElement: Element, menuItemId: string): void;
+    /**
+     * Handles IntersectionObserver entries: cancel pending deselect when visible, schedule deselect when ratio=0.
+     * @param {IntersectionObserverEntry[]} entries - Observer entries
+     * @param {string} menuItemId - Selected menu item id
+     */
+    private handleIntersectionEntries;
+    private cancelPendingDeselect;
     /**
      * Disconnects the section observer
      */
@@ -33,12 +46,13 @@ export declare class DocumentScrollService implements OnDestroy {
      */
     setScrolling(): void;
     /**
-     * Resets the scrolling flag after a specified delay
-     * @param delay - Delay in milliseconds before resetting the flag
+     * Resets the scrolling flag after a specified delay.
+     * @param {number} [delay=1200] - Delay in milliseconds before resetting the flag
      */
     resetScrollingAfterDelay(delay?: number): void;
     /**
-     * Gets the current scrolling state
+     * Gets the current scrolling state.
+     * @returns {boolean} True when a scroll is in progress
      */
     get isCurrentlyScrolling(): boolean;
     /**
@@ -46,8 +60,8 @@ export declare class DocumentScrollService implements OnDestroy {
      */
     ngOnDestroy(): void;
     /**
-     * Removes scroll event listeners
-     * @param containerElement - The container element to remove listeners from
+     * Removes scroll event listeners.
+     * @param {HTMLElement} [containerElement] - The container element to remove listeners from
      */
     cleanupScrollListeners(containerElement?: HTMLElement): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DocumentScrollService, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cat-documents-ng",
-  "version": "1.0.28",
+  "version": "1.0.30",
   "peerDependencies": {
     "@angular/common": "^19.0.0",
     "@angular/core": "^19.0.0"