cat-documents-ng 0.0.22 → 0.0.24

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

@@ -1,8 +1,8 @@
 import { OnInit } from '@angular/core';
 import { DocumentService } from '../../state/document.service';
 import { DocumentModel } from '../../models/document.model';
+import { FolderBlockModel } from '../../models/folder.model';
 import { DocumentHttpService } from '../../services/document-http.service';
-import { ParentFolderData } from '../../models/document-type.model';
 import { DocumentQuery } from '../../state/document.query';
 import * as i0 from "@angular/core";
 /**
@@ -16,8 +16,9 @@ export declare class DocumentContainerComponent implements OnInit {
     documentHttpService: DocumentHttpService;
     /**
      * Creates an instance of DocumentContainerComponent.
-     * @class
      * @param {DocumentService} documentService - Service to manage document-related operations.
+     * @param {DocumentQuery} documentQuery - Query service to manage document-related state.
+     * @param {DocumentHttpService} documentHttpService - Service to make HTTP requests related to documents.
      */
     constructor(documentService: DocumentService, documentQuery: DocumentQuery, documentHttpService: DocumentHttpService);
     /**
@@ -34,7 +35,7 @@ export declare class DocumentContainerComponent implements OnInit {
      * The list of folders.
      * @type {Array}
      */
-    folderList: ParentFolderData[];
+    folderList: FolderBlockModel[];
     /**
      * Holds the subscription to manage observable cleanup.
      * @private
@@ -53,7 +54,7 @@ export declare class DocumentContainerComponent implements OnInit {
     private fetchFolder;
     /**
      * Fetches the document data from the API.
-     * @param folderBlockId - The folder ID to fetch the document.
+     * @param {string} folderBlockId - The folder ID to fetch the document.
      * @returns {void}
      */
     private fetchDocuments;

package/lib/document/components/folder-block/folder-block.component.d.ts

@@ -1,5 +1,5 @@
 import { DocumentStore } from '../../state/document.store';
-import { ParentFolderData } from '../../models/document-type.model';
+import { FolderBlockModel } from '../../models/folder.model';
 import * as i0 from "@angular/core";
 /**
  * The `FolderBlockComponent` is responsible for displaying a block of folders and
@@ -14,7 +14,7 @@ export declare class FolderBlockComponent {
      * Array of folder blocks data to display.
      * Each folder is represented as a `FolderBlockModel`.
      */
-    folderList: ParentFolderData[];
+    folderList: FolderBlockModel[];
     /** Number of missing files, sourced from the `SHARED` constants. */
     missingFileCount: number;
     /** Number of pending files, sourced from the `SHARED` constants. */

package/lib/document/components/folder-container/folder-container.component.d.ts

@@ -1,5 +1,5 @@
 import { DocumentModel } from '../../models/document.model';
-import { ParentFolderData } from '../../models/document-type.model';
+import { FolderBlockModel } from '../../models/folder.model';
 import * as i0 from "@angular/core";
 /**
  * The `FolderContainerComponent` is responsible for rendering a container
@@ -18,22 +18,12 @@ export declare class FolderContainerComponent {
      * A list of documents passed as input to the component.
      * Represents the document data to be displayed in the folder container.
      */
-    folderList: ParentFolderData[];
+    folderList: FolderBlockModel[];
     /**
      * The context ID for the folder container.
      * @type {string}
      */
     contextId: string;
-    /**
-     * Folder blocks data, sourced from the `SHARED` constants.
-     */
-    folderBlocks: {
-        _id: string;
-        fileCount: number;
-        text: string;
-        missingFiles: number;
-        pendingFiles: number;
-    }[];
     static ɵfac: i0.ɵɵFactoryDeclaration<FolderContainerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<FolderContainerComponent, "lib-folder-container", never, { "documentList": { "alias": "documentList"; "required": false; }; "folderList": { "alias": "folderList"; "required": false; }; "contextId": { "alias": "contextId"; "required": false; }; }, {}, never, never, false, never>;
 }

package/lib/document/models/document-type.model.d.ts

@@ -1,74 +1,37 @@
 /**
- * ParentFolderData
- * @export
- * @interface ParentFolderData - Model for parent folder data.
- * @typedef {ParentFolderData} - Model for parent folder data.
- */
-export interface ParentFolderData {
-    /**
-     * The unique identifier for the parent folder.
-     * @type {string}
-     */
-    _id: string;
-    /**
-     * The number of documents in the folder.
-     * @type {number}
-     */
-    documentCount: number;
-    /**
-     * The name of the folder.
-     * @type {string}
-     */
-    folderName: string;
-}
-/**
- * DocumentType
- * @export
- * @interface DocumentType - Model for document types.
- * @typedef {DocumentType} - Model for document types.
+ * DocumentTypeModel
+ * @interface DocumentTypeModel  Model for document types.
+ * @typedef {DocumentTypeModel}  Model for document types.
  */
-export interface DocumentType {
-    /**
-     * The unique identifier for the document type.
-     * @type {string}
-     */
-    _id: string;
-    /**
-     * The name of the document type.
-     * @type {string}
-     */
-    name: string;
+export interface DocumentTypeModel {
     /**
      * The label for the document type.
      * @type {string}
+     * @memberof DocumentTypeModel
      */
     label?: string;
     /**
-     * The description of the document type.
+     * The match rules for the document type.
      * @type {string}
+     * @memberof DocumentTypeModel
      */
     matchRules?: string;
     /**
-     * parentDocumentTypeId - The unique identifier for the parent document type.
+     * The name of the document type.
      * @type {string}
+     * @memberof DocumentTypeModel
      */
-    parentDocumentTypeId: string | null;
-}
-/**
- * DocumentTypeModel
- * @export
- * @interface DocumentTypeModel - Model for document types.
- * @typedef {DocumentTypeModel} - Model for document types.
- */
-export interface DocumentTypeModel {
+    name?: string;
     /**
-     * The list of parent folder data.
-     * @type {ParentFolderData[]}
+     * The parent document type ID.
+     * @type {string}
+     * @memberof DocumentTypeModel
      */
-    parentFolderData: ParentFolderData[];
+    parentDocumentTypeId?: string;
     /**
-     * The list of all document types.
-     * @type {DocumentType[]}
+     * The document type ID.
+     * @type {string}
+     * @memberof DocumentTypeModel
      */
-    allDocumentTypes: DocumentType[];
+    _id: string;
 }

package/lib/document/models/document.model.d.ts

@@ -30,4 +30,9 @@ export declare class DocumentModel {
      * @type {?Date}
      */
     createdAt?: Date;
+    /**
+     * Shows the type of document
+     * @type {?string}
+     */
+    documentTypeName?: string;
 }

package/lib/document/models/folder.model.d.ts

@@ -11,13 +11,13 @@ export declare class FolderBlockModel {
      */
     _id: string;
     /**
-     * Total number of files within the folder block.
+     * Total number of document within the folder block.
      */
-    fileCount?: number;
+    documentCount?: number;
     /**
      * Descriptive text associated with the folder block.
      */
-    text?: string;
+    folderName?: string;
     /**
      * Number of files marked as missing in the folder block.
      */

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

@@ -5,6 +5,7 @@ import { HttpClient } from '@angular/common/http';
 import { DocumentTypeModel } from '../models/document-type.model';
 import { DocumentAlertModel } from '../models/document-alert.model';
 import { DocumentModel } from '../models/document.model';
+import { FolderBlockModel } from '../models/folder.model';
 import * as i0 from "@angular/core";
 /**
  * Service for making HTTP requests related to documents.
@@ -31,21 +32,29 @@ 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.
+     * @param {string} contextId - The context ID to fetch the document.
      * @returns {Observable<any>} Observable that emits the transformed data for dropdown options.
      */
-    getDocumentTypes(): Observable<DocumentTypeModel>;
+    getFoldersData(contextId: string): Observable<FolderBlockModel[]>;
     /**
-      * Fetches a document by its path name and transforms the response for dropdown options.
-      * @param documentId - The document ID to fetch the document.
-      * @returns
-      */
+     * 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.
+     */
+    getDocumentTypes(): Observable<DocumentTypeModel[]>;
+    /**
+     * 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 folderId - The folder ID to fetch the document.
-     * @returns
+     * @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): Observable<DocumentModel[]>;
+    getDocumentByFolderID(folderId: string, contextId: string): Observable<DocumentModel[]>;
     static ɵfac: i0.ɵɵFactoryDeclaration<DocumentHttpService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DocumentHttpService>;
 }

package/lib/document/state/document.state.d.ts

@@ -2,6 +2,7 @@ import { EntityState } from '@datorama/akita';
 import { DocumentModel } from '../models/document.model';
 import { DocumentTypeModel } from '../models/document-type.model';
 import { DocumentAlertModel } from '../models/document-alert.model';
+import { FolderBlockModel } from '../models/folder.model';
 /**
  * Represents the state of the documents in the application.
  * This interface extends Akita's `EntityState` to include additional properties
@@ -21,6 +22,7 @@ export interface DocumentState extends EntityState<DocumentModel, string> {
     uploadedDocumentFiles: DocumentModel[];
     parentDocumentTypeId: string | null;
     documentAlert: DocumentAlertModel;
+    folders: FolderBlockModel[];
 }
 /**
  * Creates the initial state for the `DocumentState` store.

package/lib/document/state/document.store.d.ts

@@ -14,6 +14,7 @@ export declare class DocumentStore extends EntityStore<DocumentState> {
      */
     constructor();
     setUploadedDocumentFiles(files: any[]): void;
+    setFolders(folders: any): void;
     setDocumentTypes(documentType: any): void;
     setDocumentAlert(documentAlert: any): void;
     setParentDocumentTypeId(parentDocumentTypeId: string): void;

package/package.json

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