cat-documents-ng 0.0.5 → 0.0.7

package/{src → projects/cat-document-lib/src}/lib/document/document.module.ts

@@ -1,191 +1,191 @@
-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 { 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,
-
-    /**
-     * 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,
-
-  ],
-  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 the `DocumentViewerComponent` to be used in other modules.
-     */
-    DocumentViewerComponent
-  ],
-  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 { }
+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 { 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,
+
+    /**
+     * 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,
+
+  ],
+  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 the `DocumentViewerComponent` to be used in other modules.
+     */
+    DocumentViewerComponent
+  ],
+  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/{src → projects/cat-document-lib/src}/lib/document/models/document.model.ts

@@ -1,39 +1,39 @@
-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
-}
+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/{src → projects/cat-document-lib/src}/lib/document/models/folder.model.ts

@@ -1,35 +1,35 @@
-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 files within the folder block.
-     */
-    fileCount?: number;
-
-    /**
-     * Descriptive text associated with the folder block.
-     */
-    text?: 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 files within the folder block.
+     */
+    fileCount?: number;
+
+    /**
+     * Descriptive text associated with the folder block.
+     */
+    text?: 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 → projects/cat-document-lib/src}/lib/document/services/file-format.service.spec.ts

@@ -1,16 +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();
-  });
-});
+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/{src → projects/cat-document-lib/src}/lib/document/services/file-format.service.ts

@@ -1,41 +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]}`;
-      }
-    }
-}
+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]}`;
+      }
+    }
+}