cat-documents-ng 1.0.3 → 1.0.5

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

@@ -0,0 +1,299 @@
+import { EventEmitter, OnInit, OnDestroy, OnChanges, SimpleChanges, ElementRef, AfterViewInit } from '@angular/core';
+import { DocumentListItem, DocumentListResponse } from '../../models/document-list-response.model';
+import { TableData } from '../../../../Shared/components/table-primary/table-primary.model';
+import { DocumentListService } from '../../services/document-list.service';
+import { Message } from 'primeng/api';
+import { DocumentHttpService } from '../../services/document-http.service';
+import { DocumentMenuService } from '../../services/document-menu.service';
+import { DocumentStore } from '../../state/document.store';
+import { DocumentScrollService } from '../../services/document-scroll.service';
+import * as i0 from "@angular/core";
+/**
+ * This component is responsible for displaying and managing a list of documents.
+ * Provides functionality for file upload, document selection, and dialog management.
+ * @class DocumentListComponent
+ */
+export declare class DocumentListComponent implements OnInit, OnDestroy, OnChanges, AfterViewInit {
+    private documentListService;
+    private documentHttpService;
+    private documentMenuService;
+    private documentStore;
+    private documentScrollService;
+    /**
+     * Represents the context ID for the document list.
+     * This value is passed from the parent component.
+     * @type {string}
+     * @memberof DocumentListComponent
+     */
+    contextId: string;
+    /**
+     * The document list response data passed from the parent component.
+     * @type {DocumentListResponse[] | null}
+     * @memberof DocumentListComponent
+     */
+    documentListResponse: DocumentListResponse[] | null;
+    /**
+     * The selected menu item ID for scrolling to specific sections
+     * @type {string | null}
+     * @memberof DocumentListComponent
+     */
+    selectedMenuItemId: string | null;
+    /**
+     * Additional navigation information for precise scrolling
+     * @type {object | null}
+     * @memberof DocumentListComponent
+     */
+    navigationInfo: {
+        menuItemId: string;
+        menuItemLabel: string;
+        categoryLabel: string;
+        categoryIndex: number;
+    } | null;
+    /**
+     * Reference to the document categories container for scrolling
+     */
+    documentCategoriesContainer: ElementRef;
+    /**
+     * Subscription to document list response from store
+     */
+    private documentListSubscription;
+    handleSelectedDocumentInNewTab: EventEmitter<{
+        selectedDocument: DocumentListItem;
+        contextId: string;
+        documentList: DocumentListItem[];
+    }>;
+    /**
+     * The currently selected document.
+     * @type {DocumentModel}
+     * @memberof DocumentListComponent
+     */
+    selectedDocument: DocumentListItem;
+    /**
+     * Default visibility of the sidebar.
+     * @type {boolean}
+     * @memberof DocumentListComponent
+     */
+    isSidebarVisible: boolean;
+    /**
+     * Default visibility of the messages.
+     * @type {Message[]}
+     * @memberof DocumentListComponent
+     */
+    messages: Message[];
+    /**
+     * Default visibility of the dialog.
+     * @type {boolean}
+     * @memberof DocumentListComponent
+     */
+    isdialogVisible: boolean;
+    /**
+     * The list of documents to display.
+     * This value is passed from the parent component.
+     * @type {DocumentModel[]}
+     * @memberof DocumentListComponent
+     */
+    documentList: DocumentListItem[];
+    /**
+     * Available document types for selection.
+     * @type {string[]}
+     * @memberof DocumentListComponent
+     */
+    options: any[];
+    /**
+     * The selected option for the document type.
+     * @type {(string | null)}
+     * @memberof DocumentListComponent
+     */
+    selectedOption: string | null;
+    /**
+     * The file name associated with the document.
+     * It may be undefined until a file is selected or loaded.
+     * @type {string | undefined}
+     */
+    fileName: string | undefined;
+    /**
+     * Table data for each category
+     */
+    categoryTables: TableData[];
+    /**
+     * Document categories from the response
+     */
+    documentCategories: DocumentListResponse[];
+    /**
+     * Completion counts for each category
+     */
+    categoryCompletionCounts: string[];
+    /**
+     * Severity levels for each category completion badge
+     */
+    categorySeverities: ('success' | 'info' | 'warning' | 'danger')[];
+    /**
+     * Message to display for document deletion
+     */
+    deleteMessage: Message[];
+    handleSelectedDocument: EventEmitter<DocumentListItem>;
+    /**
+     * Getter to return category labels as they come from the API
+     */
+    get formattedCategoryLabels(): string[];
+    /**
+     * Getter to generate safe category IDs for HTML elements
+     */
+    get categoryIds(): string[];
+    /**
+     * Creates an instance of DocumentListComponent.
+     * @class
+     * @param {DocumentListService} documentListService - The service responsible for document list operations.
+     */
+    constructor(documentListService: DocumentListService, documentHttpService: DocumentHttpService, documentMenuService: DocumentMenuService, documentStore: DocumentStore, documentScrollService: DocumentScrollService);
+    /**
+     * Handles changes to input properties
+     */
+    ngOnChanges(changes: SimpleChanges): void;
+    /**
+     * Initializes the component by setting up document list subscription.
+     */
+    ngOnInit(): void;
+    /**
+     * Called after the view is initialized
+     */
+    ngAfterViewInit(): void;
+    /**
+     * Handles the visibility of the sidebar.
+     * @param {boolean} isVisible - Indicates whether the sidebar should be visible or not.
+     * @memberof DocumentListComponent
+     */
+    handleOpenSideBar(isVisible: boolean): void;
+    /**
+     * Builds document categories from the API response
+     */
+    buildDocumentCategories(): void;
+    /**
+     * Sets up subscription to document list response from store
+     */
+    setupDocumentListSubscription(): void;
+    /**
+     * Handles table row click event
+     */
+    handleTableRowClick(rowData: any): void;
+    /**
+     * Handles the delete action from the table component
+     * @param {any} rowData - The row data containing the document to delete
+     */
+    handleDeleteAction(rowData: any): void;
+    /**
+     * Closes the document viewer dialog and resets the selected document
+     */
+    handleCloseModal(): void;
+    /**
+     * Refreshes the document list after a status update
+     * @param {boolean} isDeleteAction - Optional flag indicating if this refresh is due to a delete action
+     */
+    refreshDocumentList(isDeleteAction?: boolean): void;
+    handleTableRowCtrlClick(rowData: any): void;
+    /**
+     * Handles document status update events from viewer
+     * @param event - The status update event
+     */
+    handleDocumentStatusUpdate(event: {
+        actionType?: string;
+    }): void;
+    /**
+     * Shows delete error message for 2 seconds without closing dialog
+     * @param error - The error object from the delete operation
+     */
+    private showDeleteErrorMessage;
+    /**
+     * Handles delete error events from the document viewer
+     * @param error - The error object from the delete operation
+     */
+    handleDeleteError(error: any): void;
+    /**
+     * Handles delete success events from the document viewer
+     */
+    handleDeleteSuccess(): void;
+    /**
+     * Handles document name update event from viewer
+     */
+    handleDocumentNameUpdate(): void;
+    /**
+     * Handles the event when the document viewer is destroyed
+     * Triggers a refresh of the document data
+     */
+    handleViewerDestroyed(): void;
+    /**
+     * Scrolls to the category section that matches the selected menu item
+     * @param menuItemId - The ID of the selected menu item
+     */
+    scrollToCategorySection(menuItemId: string): void;
+    /**
+     * Finds category by converting menuItemId to readable format and matching exactly
+     * @param menuItemId - The menu item ID to match
+     * @returns The matching category or null
+     */
+    private findCategoryByMenuItemId;
+    /**
+     * Converts menuItemId to readable label format
+     * @param menuItemId - The menu item ID
+     * @returns Readable label
+     */
+    private convertMenuItemIdToReadableLabel;
+    /**
+     * Checks if a menu label is a substring of a longer category name
+     * @param menuLabel - The menu label to check
+     * @param categoryLabel - The category label to check against
+     * @returns True if menuLabel is a substring of a longer category
+     */
+    private isSubstringOfLongerCategory;
+    /**
+     * Legacy matching for backward compatibility with existing hardcoded keywords
+     * @param menuItemId - The menu item ID
+     * @returns The matching category or null
+     */
+    private findCategoryByLegacyMatching;
+    /**
+     * Scrolls to the category section using navigationInfo
+     * @param navigationInfo - The navigation info object containing menuItemId
+     */
+    scrollToCategorySectionWithNavigationInfo(navigationInfo: {
+        menuItemId: string;
+        menuItemLabel: string;
+        categoryLabel: string;
+        categoryIndex: number;
+    }): void;
+    /**
+     * Adds a temporary highlight effect to the scrolled category
+     * @param categoryElement - The DOM element of the category to highlight
+     */
+    highlightCategory(categoryElement: HTMLElement): void;
+    /**
+     * Alternative scrolling method using IntersectionObserver for better performance
+     * This method can be used as a fallback or alternative to the current approach
+     * @param navigationInfo - The navigation info object
+     */
+    scrollToCategorySectionWithIntersectionObserver(navigationInfo: {
+        menuItemId: string;
+        menuItemLabel: string;
+        categoryLabel: string;
+        categoryIndex: number;
+    }): void;
+    /**
+     * Resets the document list to the top when menu item is deselected
+     */
+    private resetToTop;
+    /**
+     * Handles changes in document list due to filtering
+     * Checks if the selected menu item's section is still visible and deselects if not
+     */
+    private handleDocumentListFilteringChange;
+    /**
+     * Deselects the current menu item and resets the view
+     */
+    private deselectMenuItemAndReset;
+    /**
+     * Cleanup subscriptions on component destroy
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentListComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DocumentListComponent, "lib-document-list", never, { "contextId": { "alias": "contextId"; "required": false; }; "documentListResponse": { "alias": "documentListResponse"; "required": false; }; "selectedMenuItemId": { "alias": "selectedMenuItemId"; "required": false; }; "navigationInfo": { "alias": "navigationInfo"; "required": false; }; "documentList": { "alias": "documentList"; "required": false; }; }, { "handleSelectedDocumentInNewTab": "handleSelectedDocumentInNewTab"; "handleSelectedDocument": "handleSelectedDocument"; }, never, ["*"], false, never>;
+}

package/lib/document/components/document-list-item/document-list-item.component.d.ts

@@ -0,0 +1,28 @@
+import { EventEmitter } from '@angular/core';
+import { DocumentModel } from '../../models/document.model';
+import * as i0 from "@angular/core";
+/**
+ * DocumentListItemComponent
+ *
+ * This component displays individual document items within a list.
+ * It accepts a list of documents as input and handles interactions with documents.
+ */
+export declare class DocumentListItemComponent {
+    /**
+     * Emit the selected document.
+     * @type {EventEmitter<DocumentModel>}
+     */
+    documentClick: EventEmitter<DocumentModel>;
+    /**
+     * The document to display.
+     * @type {DocumentModel[]}
+     */
+    document: DocumentModel;
+    /**
+     * Handles interactions with a document.
+     * @param {DocumentModel} document - The document to be opened or interacted with.
+     */
+    handleOpenDocument(document: DocumentModel): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentListItemComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DocumentListItemComponent, "lib-document-list-item", never, { "document": { "alias": "document"; "required": false; }; }, { "documentClick": "documentClick"; }, never, never, false, never>;
+}

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

@@ -0,0 +1,77 @@
+import { OnInit, OnDestroy, EventEmitter } from '@angular/core';
+import { SHARED } from '../../../../Shared/constant/SHARED';
+import { DocumentHelperService } from '../../services/document.service';
+import { DocumentQuery } from '../../state/document.query';
+import * as i0 from "@angular/core";
+export declare class DocumentSearchComponent implements OnInit, OnDestroy {
+    private documentHelperService;
+    private documentQuery;
+    readonly SHARED: typeof SHARED;
+    contextId: string;
+    onActionClick: EventEmitter<void>;
+    onRequestClick: EventEmitter<void>;
+    searchTerm: string;
+    showActionsMenu: boolean;
+    private destroy$;
+    private searchSubject;
+    private hasActiveFilters;
+    constructor(documentHelperService: DocumentHelperService, documentQuery: DocumentQuery);
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    /**
+     * Sets up the search input subscription with debouncing
+     */
+    private setupSearchSubscription;
+    /**
+     * Sets up subscription to monitor all filter states
+     */
+    private setupFilterSubscription;
+    /**
+     * Handles search term changes from ngModel
+     * @param searchTerm - The search term entered by the user
+     */
+    onSearchInputChange(searchTerm: string): void;
+    /**
+     * Handles search term changes
+     * @param searchTerm - The search term entered by the user
+     */
+    private onSearchChange;
+    /**
+     * Clears the search input
+     */
+    onClearSearch(): void;
+    /**
+     * Clears all filters including search, menu item, user, and status selections
+     */
+    onClearAllFilters(): void;
+    /**
+     * Determines if the Clear All button should be visible
+     */
+    get shouldShowClearAll(): boolean;
+    /**
+     * Toggles the actions dropdown menu
+     */
+    toggleActionsMenu(): void;
+    /**
+     * Handles upload document action
+     */
+    handleUploadDocument(): void;
+    /**
+     * Handles request document action
+     */
+    handleRequestDocument(): void;
+    /**
+     * Sets up click outside listener to close dropdown
+     */
+    private setupClickOutsideListener;
+    /**
+     * Removes click outside listener
+     */
+    private removeClickOutsideListener;
+    /**
+     * Handles clicks outside the dropdown to close it
+     */
+    private handleClickOutside;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentSearchComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DocumentSearchComponent, "document-search", never, { "contextId": { "alias": "contextId"; "required": false; }; }, { "onActionClick": "onActionClick"; "onRequestClick": "onRequestClick"; }, never, never, false, never>;
+}

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

@@ -0,0 +1,24 @@
+import { OnInit, OnDestroy, OnChanges, SimpleChanges } from '@angular/core';
+import { DocumentQuery } from '../../state/document.query';
+import { StatusCalculatorService, CalculatedStatusData } from '../../services/status-calculator.service';
+import { DocumentHelperService } from '../../services/document.service';
+import * as i0 from "@angular/core";
+export declare class DocumentStatusComponent implements OnInit, OnDestroy, OnChanges {
+    private documentQuery;
+    private documentService;
+    private statusCalculatorService;
+    contextId: string;
+    statusData: any;
+    selectedStatus: string | null;
+    statusDataWithPercentages: CalculatedStatusData[];
+    private subscription;
+    constructor(documentQuery: DocumentQuery, documentService: DocumentHelperService, statusCalculatorService: StatusCalculatorService);
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnInit(): void;
+    private refetchStatusData;
+    selectStatus(status: string): void;
+    private updateCalculatedStatusData;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentStatusComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DocumentStatusComponent, "lib-document-status", never, { "contextId": { "alias": "contextId"; "required": false; }; "statusData": { "alias": "statusData"; "required": false; }; }, {}, never, never, false, never>;
+}