cat-documents-ng 0.1.28 → 0.1.30

package/src/lib/document/document.module.ts

@@ -0,0 +1,241 @@
+import { APP_INITIALIZER, NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { DocumentContainerComponent } from './components/document-container/document-container.component';
+import { FolderContainerComponent } from './components/folder-container/folder-container.component';
+import { FolderBlockComponent } from './components/folder-block/folder-block.component';
+import { DocumentListComponent } from './components/document-list/document-list.component';
+import { AccordionModule } from 'primeng/accordion';
+import { DocumentListItemComponent } from './components/document-list-item/document-list-item.component';
+import { ButtonModule } from 'primeng/button';
+import { SidebarModule } from 'primeng/sidebar';
+import { FileUploadModule } from 'primeng/fileupload';
+import { DocumentUploadComponent } from './components/document-upload/document-upload.component';
+import { MessageService } from 'primeng/api';
+import { HTTP_INTERCEPTORS, HttpClientModule } from '@angular/common/http';
+import { ProgressBarModule } from 'primeng/progressbar';
+import { BadgeModule } from 'primeng/badge';
+import { ListboxModule } from 'primeng/listbox';
+import { TimelineModule } from 'primeng/timeline';
+import { CheckboxModule } from 'primeng/checkbox';
+import { InputTextareaModule } from 'primeng/inputtextarea';
+import { FormsModule } from '@angular/forms';
+import { DocumentViewerComponent } from './components/document-viewer/document-viewer.component';
+import { PdfViewerModule } from 'ng2-pdf-viewer';
+import { DialogModule } from 'primeng/dialog';
+import { AppConfigService } from '../../Shared/services/app-config.service';
+import { GlobalErrorHandler } from '../../Shared/services/global-error.handler';
+import { DropdownModule } from 'primeng/dropdown';
+import { InputTextModule } from 'primeng/inputtext';
+import { DocumentDirective } from './directives/document.directive';
+import { HasPermissionDirective } from './directives/permission.directive';
+import { LinkedDocumentComponent } from './components/linked-document/linked-document.component';
+
+/**
+ * @module DocumentModule
+ * 
+ * The `DocumentModule` handles the organization and display of document and folder components 
+ * in the application. This module is designed to support features like folder containers, 
+ * document lists, and individual document items.
+ */
+@NgModule({
+  declarations: [
+    /**
+     * The main container for managing documents.
+     * DocumentContainerComponent
+     */
+    DocumentContainerComponent,
+
+    /**
+     * A container component to manage folders.
+     * FolderContainerComponent
+     */
+    FolderContainerComponent,
+
+    /**
+     * A block component that represents an individual folder.
+     * FolderBlockComponent
+     */
+    FolderBlockComponent,
+
+    /**
+     * A component to display a list of documents.
+     * DocumentListComponent
+     */
+    DocumentListComponent,
+
+    /**
+     * A component representing an individual item in the document list.
+     * DocumentListItemComponent
+     */
+    DocumentListItemComponent,
+
+    /** 
+     * A component representing to upload a file.
+     */
+    DocumentUploadComponent,
+
+    /**
+     * A component representing and allow you to view the document.
+     */
+    DocumentViewerComponent,
+
+    /**
+     * A directive to show the document.
+     */
+    DocumentDirective,
+
+    /**
+     * A directive to give permission.
+     */
+    HasPermissionDirective,
+
+    /**
+     * A component which have linked documents.
+     */
+    LinkedDocumentComponent,
+
+  ],
+  imports: [
+    /**
+     * Angular's CommonModule is imported to access common directives like `ngIf` and `ngFor`.
+     */
+    CommonModule,
+
+    /**
+     * PrimeNG AccordionModule is used for creating collapsible sections in the UI.
+     */
+    AccordionModule,
+
+    /**
+     * HttpClienModule for the http calls
+     */
+    HttpClientModule,
+
+    /**
+     * PrimeNG ButtonModule is used for creating buttons in the UI.
+     */
+    ButtonModule,
+
+    /**
+     * PrimeNG SidebarModule is used for creating sidebar in the UI.
+     */
+    SidebarModule,
+
+    /**
+     * PrimeNG FileUploadModule is used for uploading file.
+     */
+    FileUploadModule,
+
+    /**
+     * PrimeNG ProgressBarModule is used for showing progress.
+     */
+    ProgressBarModule,
+
+    /**
+     * PrimeNG BadgeModule is used for showing badge value.
+     */
+    BadgeModule,
+
+    /**
+     * PrimeNG ListboxModule is used for showing listbox value.
+     */
+    ListboxModule,
+
+    /**
+     * PrimeNG CheckboxModule is used for showing checkbox value.
+     */
+    CheckboxModule,
+
+    /**
+     * PrimeNG TimelineModule is used for showing timeline value.
+     */
+    TimelineModule,
+    /**
+     * PrimeNG InputTextareaModule is used for showing textarea value.
+     */
+    InputTextareaModule,
+    /**
+     * FormsModule to handle the forms.
+     */
+    FormsModule,
+    /**
+     *  PdfViewerModule to handle and make visible the pdf.
+     */
+    PdfViewerModule,
+    /**
+     * PrimeNG DialogModule is used for showing dialog.
+     */
+    DialogModule,
+    /**
+     * PrimeNG DropdownModule is used for creating dropdown menus, allowing users to select options from a list.
+     */
+    DropdownModule,
+    /**
+     * PrimeNG InputTextModule is used for creating InputTextFeilds, allowing users to enter name for a document.
+     */
+    InputTextModule
+
+
+  ],
+  exports: [
+  /**
+   * A directive to give permission.
+   */
+    HasPermissionDirective,
+    /**
+     * Exports the `DocumentContainerComponent` to be used in other modules.
+     */
+    DocumentContainerComponent,
+    /**
+     * Exports the `DocumentViewerComponent` to be used in other modules.
+     */
+    DocumentViewerComponent,
+    /**
+     * A component to display a list of documents.
+     * DocumentListComponent
+     */
+    DocumentListComponent,
+    /**
+     * A directive to show the document.
+     */
+    DocumentDirective,
+
+
+  ],
+  providers: [
+    /**
+     * Provide the messageservice to be used in other components.
+     */
+    MessageService,
+
+    /**
+     * Provide the messageservice to be used in other components.
+     */
+    { provide: GlobalErrorHandler, useClass: GlobalErrorHandler },
+    /**
+     * Initializes the application configuration by loading it from the AppConfigService
+     * before the application starts.
+     * This ensures that the configuration is available for the rest of the app when needed.
+     * The configuration is loaded asynchronously using the APP_INITIALIZER.
+     * @returns {Function} - A function that loads the configuration from the AppConfigService.
+     */
+    {
+      provide: APP_INITIALIZER,
+      /**
+       * This useFactory is executed when the app initializes.
+       * It calls the AppConfigService to load the configuration.
+       * If an error occurs, it throws an error.
+       * @param {AppConfigService} configService - The service responsible for loading the application configuration.
+       * @returns {Function} - A function that loads the configuration from the AppConfigService.
+       */
+      useFactory: (configService: AppConfigService) => () =>
+        configService.loadAppConfig().catch((error) => {
+          throw new Error(error);
+        }),
+      deps: [AppConfigService],
+      multi: true,
+    },
+    
+  ]
+})
+export class DocumentModule { }

package/{lib/document/models/document-alert.model.d.ts → src/lib/document/models/document-alert.model.ts}

@@ -1,38 +1,45 @@
-/**
- * The `DocumentAlertModel` is responsible for managing and displaying alert messages for documents.
- * @export
- * @class DocumentAlertModel
- * @typedef {DocumentAlertModel} - Represents the document alert model.
- */
-export declare class DocumentAlertModel {
-    /**
-     * The unique identifier for the document alert.
-     * @type {string}
-     */
-    _id: string;
-    /**
-     * The alert status for the document.
-     * @type {string}
-     */
-    alertStatus?: string;
-    /**
-     * The context ID for the document.
-     * @type {?string}
-     */
-    contextId?: string;
-    /**
-     * The document ID for the document.
-     * @type {?string}
-     */
-    documentId?: string;
-    /**
-     * The alert message for the document.
-     * @type {?string}
-     */
-    alertMessage?: string;
-    /**
-     * The alert type for the document.
-     * @type {?string}
-     */
-    status?: string;
-}
+import { SHARED } from "../../../Shared/constant/SHARED";
+
+/**
+ * The `DocumentAlertModel` is responsible for managing and displaying alert messages for documents.
+ * @export
+ * @class DocumentAlertModel
+ * @typedef {DocumentAlertModel} - Represents the document alert model.
+ */
+export class DocumentAlertModel {
+    /**
+     * The unique identifier for the document alert.
+     * @type {string}
+     */
+    _id : string = SHARED.EMPTY
+    
+    /**
+     * The alert status for the document.
+     * @type {string}
+     */
+    alertStatus?: string;
+    
+    /**
+     * The context ID for the document.
+     * @type {?string}
+     */
+    contextId?: string;
+
+    /**
+     * The document ID for the document.
+     * @type {?string}
+     */
+    documentId?: string;
+
+    /**
+     * The alert message for the document.
+     * @type {?string}
+     */
+    alertMessage?:string;
+
+    /**
+     * The alert type for the document.
+     * @type {?string}
+     */
+    status?: string;
+}

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

@@ -0,0 +1,44 @@
+
+/**
+ * DocumentTypeModel
+ * @interface DocumentTypeModel  Model for document types.
+ * @typedef {DocumentTypeModel}  Model for document types.
+ */
+export interface DocumentTypeModel {
+  
+  /**
+   * The label for the document type.
+   * @type {string}
+   * @memberof DocumentTypeModel
+   */
+  label?: string,
+
+  /**
+   * The match rules for the document type.
+   * @type {string}
+   * @memberof DocumentTypeModel
+   */
+  matchRules?: string,
+
+  /**
+   * The name of the document type.
+   * @type {string}
+   * @memberof DocumentTypeModel
+   */
+  name?: string,
+  
+  
+  /**
+   * The parent document type ID.
+   * @type {string}
+   * @memberof DocumentTypeModel
+   */
+  parentDocumentTypeId?: string,
+
+  /**
+   * The document type ID.
+   * @type {string}
+   * @memberof DocumentTypeModel
+   */
+  _id: string
+}

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

@@ -0,0 +1,53 @@
+import { SHARED } from "../../../Shared/constant/SHARED";
+
+/**
+ * Represents a document model.
+ * 
+ * This class contains the structure for document-related data, including file name, 
+ * status, and document URL.
+ */
+export class DocumentModel {
+  /**
+   * The unique identifier for the document.
+   * @type {string}
+   */
+  _id: string = SHARED.EMPTY;
+
+  /**
+   * The name of the document file.
+   * @type {?string}
+   */
+  fileName?: string;
+
+  /**
+   * The current status of the document.
+   * @type {?string}
+   */
+  status?: string;
+
+  /**
+   * The URL where the document is hosted or stored.
+   * @type {?string}
+   */
+  documentUrl?: string;
+
+  /**
+   * Date of document get uploaded
+   * @type {?Date}
+   */
+  createdAt?: Date
+
+  /**
+   * Shows the type of document
+   * @type {?string}
+   */
+  documentTypeName?:string;
+
+  /**
+   * Shows the type of content
+   * @type {?string}
+   */
+  contentType?: string;
+
+  documentName?: string;
+}

package/{lib/document/models/folder.model.d.ts → src/lib/document/models/folder.model.ts}

@@ -1,29 +1,35 @@
-/**
- * Represents the model for a folder block.
- *
- * This class provides the structure for folder block data, including properties
- * for ID, file counts, descriptive text, and counts for missing and pending files.
- */
-export declare class FolderBlockModel {
-    /**
-     * Unique identifier for the folder block.
-     * Defaults to an empty string sourced from `SHARED.EMPTY`.
-     */
-    _id: string;
-    /**
-     * Total number of document within the folder block.
-     */
-    documentCount?: number;
-    /**
-     * Descriptive text associated with the folder block.
-     */
-    folderName?: string;
-    /**
-     * Number of files marked as missing in the folder block.
-     */
-    missingFiles?: number;
-    /**
-     * Number of files marked as pending in the folder block.
-     */
-    pendingFiles?: number;
-}
+import { SHARED } from "../../../Shared/constant/SHARED";
+
+/**
+ * Represents the model for a folder block.
+ * 
+ * This class provides the structure for folder block data, including properties 
+ * for ID, file counts, descriptive text, and counts for missing and pending files.
+ */
+export class FolderBlockModel {
+    /**
+     * Unique identifier for the folder block.
+     * Defaults to an empty string sourced from `SHARED.EMPTY`.
+     */
+    _id: string = SHARED.EMPTY;
+
+    /**
+     * Total number of document within the folder block.
+     */
+    documentCount?: number;
+
+    /**
+     * Descriptive text associated with the folder block.
+     */
+    folderName?: string;
+
+    /**
+     * Number of files marked as missing in the folder block.
+     */
+    missingFiles?: number;
+
+    /**
+     * Number of files marked as pending in the folder block.
+     */
+    pendingFiles?: number;
+}

package/src/lib/document/services/document-http.service.spec.ts

@@ -0,0 +1,119 @@
+import { TestBed } from '@angular/core/testing';
+import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
+import { DocumentHttpService } from './document-http.service';
+import { DocumentStore } from '../state/document.store';
+import { AppConfigService } from '../../../Shared/services/app-config.service';
+import { URLS } from '../../../Shared/constant/URLS';
+import { DocumentTypeModel } from '../models/document-type.model';
+import { throwError } from 'rxjs';
+import { FolderBlockModel } from '../models/folder.model';
+import { DocumentModel } from '../models/document.model';
+
+describe('DocumentHttpService', () => {
+  let service: DocumentHttpService;
+  let httpMock: HttpTestingController;
+  let documentStoreSpy: jasmine.SpyObj<DocumentStore>;
+  let appConfigServiceSpy: jasmine.SpyObj<AppConfigService>;
+
+  beforeEach(() => {
+    documentStoreSpy = jasmine.createSpyObj('DocumentStore', ['setDocumentTypes', 'setFolders']);
+    appConfigServiceSpy = jasmine.createSpyObj('AppConfigService', ['apiBaseUrl'], {
+      apiBaseUrl: 'http://localhost/api'
+    });
+
+    TestBed.configureTestingModule({
+      imports: [HttpClientTestingModule],
+      providers: [
+        DocumentHttpService,
+        { provide: DocumentStore, useValue: documentStoreSpy },
+        { provide: AppConfigService, useValue: appConfigServiceSpy }
+      ]
+    });
+
+    service = TestBed.inject(DocumentHttpService);
+    httpMock = TestBed.inject(HttpTestingController);
+  });
+
+  it('should be created', () => {
+    expect(service).toBeTruthy();
+  });
+
+  it('should fetch document types and update the store', () => {
+    const mockDocumentTypes: DocumentTypeModel[] = [
+      {
+        _id: '1',
+        label: 'Parent-child1',
+        name: 'Type 1',
+        matchRules: 'Rule 1',
+        parentDocumentTypeId: '0'
+      },
+      {
+        _id: '2',
+        label: 'Parent-child2',
+        name: 'Type 2',
+        matchRules: 'Rule 2',
+        parentDocumentTypeId: '1'
+      }
+    ];
+
+    service.getDocumentTypes().subscribe((documentTypes) => {
+      expect(documentTypes).toEqual(mockDocumentTypes);
+      expect(documentStoreSpy.setDocumentTypes).toHaveBeenCalledWith(mockDocumentTypes);
+    });
+
+    const req = httpMock.expectOne(
+      `${appConfigServiceSpy.apiBaseUrl}${URLS.DOCUMENT_UPLOAD}/${URLS.DOCUMENT_TYPES}`
+    );
+    expect(req.request.method).toBe('GET');
+    req.flush(mockDocumentTypes); // Mock the response with data
+  });
+
+ 
+  
+  it('should fetch folders data and update the store', () => {
+    const contextId = 'someContextId';
+    const mockFolderData: FolderBlockModel[] = [
+      { _id: '1', folderName: 'Folder 1' },
+      { _id: '2', folderName: 'Folder 2' }
+    ];
+  
+    service.getFoldersData(contextId).subscribe((foldersData) => {
+      expect(foldersData).toEqual(mockFolderData);
+      expect(documentStoreSpy.setFolders).toHaveBeenCalledWith(mockFolderData); // ✅ Corrected method
+    });
+  
+    const req = httpMock.expectOne(
+      `${appConfigServiceSpy.apiBaseUrl}${URLS.DOCUMENT_UPLOAD}${URLS.FOLDERS}${contextId}`
+    );
+    expect(req.request.method).toBe('GET');
+    req.flush(mockFolderData);
+  });
+    
+  afterEach(() => {
+    httpMock.verify();
+  });
+
+  it('should update document name successfully', () => {
+    const documentId = '123';
+    const payload = { fileName: 'New Document Name' };
+    const mockUpdatedDocument: DocumentModel = {
+      _id: documentId,
+      fileName: 'New Document Name'
+    } as DocumentModel;
+
+    service.updateDocumentName(documentId, payload).subscribe((updatedDoc) => {
+      expect(updatedDoc).toEqual(jasmine.objectContaining(mockUpdatedDocument));
+    });
+
+    const req = httpMock.expectOne(
+      `${appConfigServiceSpy.apiBaseUrl}${URLS.DOCUMENT_UPLOAD}/${documentId}`
+    );
+    expect(req.request.method).toBe('PUT');
+    expect(req.request.body).toEqual(payload);
+    req.flush(mockUpdatedDocument);
+  });
+
+  afterEach(() => {
+    httpMock.verify();
+  });
+});