cat-documents-ng 1.0.0 → 1.0.1

package/projects/cat-document-lib/src/lib/document/document.module.ts

@@ -1,24 +1,187 @@
-import { NgModule } from '@angular/core';
+import { APP_INITIALIZER, NgModule } from '@angular/core';
 import { CommonModule } from '@angular/common';
 import { DocumentContainerComponent } from './components/document-container/document-container.component';
-import { DocumentListComponent } from './components/document-list/document-list.component';
-import { FolderBlockComponent } from './components/folder-block/folder-block.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 { 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';
 
 /**
- *
+ * @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,
-    DocumentListComponent,
+
+    /**
+     * A container component to manage folders.
+     * FolderContainerComponent
+     */
+    FolderContainerComponent,
+
+    /**
+     * A block component that represents an individual folder.
+     * FolderBlockComponent
+     */
     FolderBlockComponent,
-    FolderContainerComponent
+
+    /**
+     * 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,
+
   ],
   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
+  ],
+  exports: [
+    /**
+     * Exports the `DocumentContainerComponent` to be used in other modules.
+     */
+    DocumentContainerComponent
   ],
-  exports : [DocumentContainerComponent]
+  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.
+     */
+      useFactory: (configService: AppConfigService) => () =>
+        configService.loadAppConfig().catch((error) => {
+          throw new Error(error);
+        }),
+      deps: [AppConfigService],
+      multi: true,
+    }
+  ]
 })
 export class DocumentModule { }

package/projects/cat-document-lib/src/lib/document/models/document.model.ts

@@ -1,3 +1,39 @@
-export class DocumentModel{
-    
-}
+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 {number}
+   */
+  _id: number = SHARED.INITIAL_COUNT;
+
+  /**
+   * 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
+}

package/projects/cat-document-lib/src/lib/document/services/file-format.service.spec.ts

@@ -0,0 +1,16 @@
+import { TestBed } from '@angular/core/testing';
+
+import { FileFormatService } from './file-format.service';
+
+describe('FileFormatService', () => {
+  let service: FileFormatService;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({});
+    service = TestBed.inject(FileFormatService);
+  });
+
+  it('should be created', () => {
+    expect(service).toBeTruthy();
+  });
+});

package/projects/cat-document-lib/src/lib/document/services/file-format.service.ts

@@ -0,0 +1,41 @@
+import { Injectable } from '@angular/core';
+import { SHARED } from '../../../Shared/constant/SHARED';
+import { PrimeNGConfig } from 'primeng/api';
+
+/**
+ * Description placeholder
+ * @class FileFormatService
+ * @typedef {FileFormatService}
+ */
+@Injectable({
+  providedIn: 'root'
+})
+export class FileFormatService {
+
+  /**
+   * Creates an instance of FileFormatService.
+   * @constructor
+   */
+  constructor() { }
+
+    /**
+     * Description placeholder
+     * @param {number} bytes
+     * @param {PrimeNGConfig} config
+     * @returns {string}
+     */
+    formatFileSize(bytes: number, config:PrimeNGConfig): string {
+      const kilobyte = 1024;
+      const decimalPlaces = SHARED.ONE;
+      const sizes = config.translation.fileSizeTypes || SHARED.FILE_SIZE_UNITS;
+      if (bytes < kilobyte) {
+        return `${bytes} ${sizes[SHARED.INITIAL_COUNT]}`;
+      } else if (bytes < kilobyte * kilobyte) {
+        const kbSize = bytes / kilobyte;
+        return `${parseFloat(kbSize.toFixed(decimalPlaces))} ${sizes[SHARED.ONE]}`;
+      } else {
+        const mbSize = bytes / (kilobyte * kilobyte);
+        return `${parseFloat(mbSize.toFixed(decimalPlaces))} ${sizes[SHARED.TWO]}`;
+      }
+    }
+}

package/projects/cat-document-lib/src/lib/document/state/document.service.ts

@@ -1,23 +1,95 @@
 import { Injectable } from '@angular/core';
 import { HttpClient } from '@angular/common/http';
 import { DocumentStore } from './document.store';
+import { Observable, tap } from 'rxjs';
+import { AppConfigService } from '../../../Shared/services/app-config.service';
+import { URLS } from '../../../Shared/constant/URLS';
+import { DocumentModel } from '../models/document.model';
 
 /**
  * Service for managing document-related operations.
- * 
  * The `DocumentService` acts as a bridge between the application and the backend API for handling document-related data.
  * It interacts with the `DocumentStore` for state management and uses `HttpClient` for making HTTP requests.
- 
-   * Creates an instance of `DocumentService`.
-   * 
-   * @param {DocumentStore} doumentStore - The store that manages the state of documents.
-   * @param {HttpClient} http - The Angular HTTP client for making API requests.
-   */
+ * Creates an instance of `DocumentService`.
+ * @param {DocumentStore} documentStore - The store that manages the state of documents.
+ * @param {HttpClient} http - The Angular HTTP client for making API requests.
+ */
 @Injectable({ providedIn: 'root' })
 export class DocumentService {
 
-  constructor(
-    public documentStore: DocumentStore,
-    private http: HttpClient, // Changed to private for better encapsulation
-  ) { }
+    /**
+     * Creates an instance of DocumentService.
+     * @param {DocumentStore} documentStore - Store managing the state of documents.
+     * @param {HttpClient} http - Angular HTTP client for making API requests.
+     * @param {AppConfigService} appConfigService - Service for retrieving application configuration, such as API base URL.
+     */
+    constructor(
+        public documentStore: DocumentStore,
+        private http: HttpClient,
+        public appConfigService: AppConfigService
+    ) { }
+
+    /**
+     * Get api url from appConfigService.
+     * @readonly
+     * @type {string}
+     */
+    get apiUrl(): string {
+        return this.appConfigService.apiBaseUrl;
+    }
+
+    /**
+     * Sends a request to create a new document.
+     * @param {*} entity - The data of the document to be created.
+     * @returns {Observable<any>} Observable that emits the newly created document.
+     */
+    create(entity: any): Observable<any> {
+        return this.http.post<any>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}`, entity).pipe(
+            tap((newEntity: any) => this.documentStore.add(newEntity))
+        );
+    }
+
+    /**
+     * Fetches all documents from the backend.
+     * @returns {Observable<DocumentModel[]>} Observable that emits an array of documents.
+     */
+    getAll(): Observable<DocumentModel[]> {
+        return this.http.get<DocumentModel[]>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}`).pipe(
+            tap((entities: DocumentModel[]) => this.documentStore.set(entities))
+        );
+    }
+
+    /**
+     * Fetches a document by its ID.
+     * @param {string} id - The unique identifier of the document.
+     * @returns {Observable<any>} Observable that emits the retrieved document.
+     */
+    getById(id: string): Observable<any> {
+        return this.http.get<any>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`).pipe(
+            tap((entity: any) => this.documentStore.upsert(id, entity))
+        );
+    }
+
+    /**
+     * Updates an existing document by its ID.
+     * @param {string} id - The unique identifier of the document.
+     * @param {DocumentModel} entity - The updated data of the document.
+     * @returns {Observable<DocumentModel>} Observable that emits the updated document.
+     */
+    update(id: string, entity: DocumentModel): Observable<DocumentModel> {
+        return this.http.put<DocumentModel>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`, entity).pipe(
+            tap((updatedEntity: DocumentModel) => this.documentStore.update(id, updatedEntity))
+        );
+    }
+
+    /**
+     * Deletes a document by its ID.
+     * @param {string} id - The unique identifier of the document to be deleted.
+     * @returns {Observable<void>} Observable that completes when the document is deleted.
+     */
+    delete(id: string): Observable<void> {
+        return this.http.delete<void>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`).pipe(
+            tap(() => this.documentStore.remove(id))
+        );
+    }
 }

package/projects/cat-document-lib/src/shared/constant/SHARED.ts

@@ -17,6 +17,86 @@ export class SHARED {
    * Represents an empty string.
    */
   static EMPTY = "";
+
+  /**
+   * Represents an true.
+   * @static
+   * @type {boolean}
+   */
+  static TRUE: boolean = true;
+
+
+  /**
+   * Represents an false.
+   * @static
+   * @type {boolean}
+   */
+  static FALSE: boolean = false;
+
+  /**
+   * Represents an INITIAL_COUNT.
+   */
+  static INITIAL_COUNT = 0
+  /**
+   * Represents an INITIAL_VALUE.
+   */
+  static INITIAL_VALUE = 0
+
+  /**
+   * Represents the constant value for one (1).
+   * @static
+   * @type {number}
+   */
+  static ONE: number = 1
+
+  /**
+   * Represents the constant value for two (2).
+   * @static
+   * @type {number}
+   */
+  static TWO: number = 2
+
+  /**
+   * Represents the constant value for ten (10).
+   * @static
+   * @type {number}
+   */
+  static TEN: number = 10
+
+  /**
+   * Represents the constant string value 'files' used for file-related operations.
+   * @static
+   * @type {string}
+   */
+  static FILE: string = 'file';
+
+  /**
+   * Represents the array of file size units ('B', 'KB', 'MB') used for file size formatting.
+   * @static
+   * @type {string[]}
+   */
+  static FILE_SIZE_UNITS: string[] = ['B', 'KB', 'MB'];
+
+  /**
+   * Show SEVERITY value.
+   * @static
+   * @type {'error'}
+   */
+  static SEVERITY:string = 'error'
+
+  /**
+   * Show upload summery if it's failed.
+   * @static
+   * @type {'Upload Failed'}
+   */
+  static UPLOAD_SUMMERY:string = 'Upload Failed'
+
+  /**
+   * Represent empty array.
+   * @static
+   * @type {{}}
+   */
+  static EMPTY_ARRAY = []
 }
 
 /**
@@ -91,3 +171,48 @@ export const FOLDERPANEL = [
     pendingFiles: 3,
   }
 ];
+
+/**
+ * Dummy data for sumaery.
+ * @type {{}}
+ */
+export const DUMMYSUMMARY = [
+  {
+    status: 'Valuation report requested on 10th Oct 2024',
+    date: '15/10/2020 10:30',
+    icon: 'pi pi-shopping-cart',
+    color: '#9C27B0',
+    image: 'game-controller.jpg',
+  },
+  {
+    status: 'Valuation report received on 13th Oct 2024',
+    date: '15/10/2020 14:00',
+    icon: 'pi pi-cog',
+    color: '#673AB7',
+  },
+  {
+    status: 'Waiting for Valuation Report to be accepted',
+    date: '15/10/2020 16:15',
+    icon: 'pi pi-shopping-cart',
+    color: '#FF9800',
+  },
+];
+
+/**
+ * Dummy data for list box.
+ * @type {{}}
+ */
+export const COUNTRIES = [
+  { name: 'Any Word', code: 'NY', checked: false },
+  { name: 'Case Sensitive', code: 'RM', checked: false },
+  { name: 'Wildcard Search', code: 'LDN', checked: false },
+  { name: 'Whole Word Only', code: 'IST', checked: false },
+];
+
+/**
+ * Default supported image types.
+ * @type {{}}
+ */
+export const SUPPORTED_IMAGE_TYPES = [
+  'image/png'
+];

package/projects/cat-document-lib/src/shared/constant/URLS.ts

@@ -0,0 +1,31 @@
+/**
+ * Class that holds the URLs used throughout the application.
+ * These URLs are typically used for making API requests and accessing various resources.
+ * @class URLS
+ * @typedef {URLS}
+ */
+export class URLS {
+    /**
+     * The URL to fetch the application configuration file.
+     * This JSON file typically contains settings and options for the application.
+     * @static
+     * @type {string}
+     */
+    static CONFIGFILEURL = "assets/config/app.config.json";
+
+    /**
+     * The URL endpoint for document uploads.
+     * Used to send documents to the server for storage or processing.
+     * @static
+     * @type {string}
+     */
+    static DOCUMENT_UPLOAD = "documents";
+
+    /**
+     * The query parameter to pass a context ID in API requests.
+     * Used to specify the context for certain API calls, such as filtering or scoping the request.
+     * @static
+     * @type {string}
+     */
+    static CONTEXT = "?contextId=";
+}

package/projects/cat-document-lib/src/shared/services/app-config.service.spec.ts

@@ -0,0 +1,16 @@
+import { TestBed } from '@angular/core/testing';
+
+import { AppConfigService } from './app-config.service';
+
+describe('AppConfigService', () => {
+  let service: AppConfigService;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({});
+    service = TestBed.inject(AppConfigService);
+  });
+
+  it('should be created', () => {
+    expect(service).toBeTruthy();
+  });
+});

package/projects/cat-document-lib/src/shared/services/app-config.service.ts

@@ -0,0 +1,73 @@
+import { HttpClient } from '@angular/common/http';
+import { Injectable } from '@angular/core';
+import { firstValueFrom } from 'rxjs';
+import { URLS } from '../constant/URLS';
+
+/**
+ * Service that handles loading and providing configuration settings for the application.
+ * It fetches configuration data from a remote server and exposes various configuration options.
+ * @class AppConfigService
+ * @typedef {AppConfigService}
+ */
+@Injectable({
+  providedIn: 'root'
+})
+export class AppConfigService {
+
+  /**
+   * Holds the configuration data loaded from the server.
+   * @private
+   * @type {*}
+   */
+  private appConfig: any;
+
+  /**
+   * Creates an instance of AppConfigService.
+   * Initializes the HttpClient for making HTTP requests.
+   * @class
+   * @param {HttpClient} http - The HttpClient service used for making HTTP requests.
+   */
+  constructor(private http: HttpClient) {}
+
+  /**
+   * Loads the application configuration from the server by making an HTTP request to the configuration URL.
+   * This method retrieves the configuration data and assigns it to the appConfig property.
+   * @async
+   * @returns {*}
+   */
+  async loadAppConfig() {
+    try {
+      this.appConfig = await firstValueFrom(this.http.get(URLS.CONFIGFILEURL));
+    } catch (error) {
+      throw new Error("Api url is missing.")
+    }
+  }
+  
+
+  /**
+   * Returns the base URL for the API from the loaded configuration.
+   * @readonly
+   * @type {*}
+   */
+  get apiBaseUrl() {
+    return this.appConfig?.apiUrl;
+  }
+
+  /**
+   * Returns the local server API URL from the loaded configuration.
+   * @readonly
+   * @type {*}
+   */
+  get localServerApi() {
+    return this.appConfig?.localServerApi;
+  }
+
+  /**
+   * Returns the visibility options from the loaded configuration.
+   * @readonly
+   * @type {*}
+   */
+  get visibilityOptions() {
+    return this.appConfig?.visibilityOption;
+  }
+}

package/src/app/app.module.ts

@@ -1,11 +1,12 @@
-import { NgModule } from '@angular/core';
+import { APP_INITIALIZER, NgModule } from '@angular/core';
 import { CommonModule } from '@angular/common';
 import { AppRoutingModule } from './app.routing.module';
 import { AppComponent } from './app.component';
 import { BrowserModule } from '@angular/platform-browser';
 import { DocumentModule } from '../../projects/cat-document-lib/src/public-api';
 import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
-import { GlobalErrorHandler } from '../../projects/cat-document-lib/src/shared/services/global-error.handler';
+import { AppConfigService } from '../../projects/cat-document-lib/src/Shared/services/app-config.service';
+import { GlobalErrorHandler } from '../../projects/cat-document-lib/src/Shared/services/global-error.handler';
 
 /**
  * The root module of the Angular application.
@@ -52,7 +53,7 @@ import { GlobalErrorHandler } from '../../projects/cat-document-lib/src/shared/s
     /**
      * Registers the global error handler for the application.
      */
-    {provide: GlobalErrorHandler, useClass: GlobalErrorHandler}
+   
   ]
   
 })