cat-documents-ng 1.0.2 → 1.0.4

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

@@ -1,187 +0,0 @@
-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
-  ],
-  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,39 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -1,41 +0,0 @@
-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.query.ts

@@ -1,23 +0,0 @@
-import { Injectable } from '@angular/core';
-import { QueryEntity } from '@datorama/akita';
-import { DocumentStore } from './document.store';
-import { DocumentState } from './document.state';
-
-/**
- * Service that provides querying capabilities for the `DocumentStore`.
- * 
- * The `DocumentQuery` class extends Akita's `QueryEntity`, allowing consumers
- * to retrieve, observe, and filter data from the `DocumentStore` in a reactive manner.
- * 
- * @extends QueryEntity<DocumentState>
- * * Creates an instance of `DocumentQuery`.
-   * 
-   * @param {DocumentStore} store - The underlying store that holds the document state.
-*/
-
-@Injectable({ providedIn: 'root' })
-export class DocumentQuery extends QueryEntity<DocumentState> {
-  constructor(protected override store: DocumentStore) {
-    super(store);
-  }
-}

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

@@ -1,39 +0,0 @@
-import { EntityState } from '@datorama/akita';
-import { DocumentModel } from '../models/document.model';
-
-/**
- * Represents the state of the documents in the application.
- * 
- * This interface extends Akita's `EntityState` to include additional properties
- * for managing document-specific data, such as `records`, `filteredRecords` and `folderId`.
- * 
- * @extends EntityState<DocumentModel, string>
- * 
- * @property {any[]} records - A collection of records related to documents.
- * @property {any[]} filteredRecords - A collection of filteredRecords related to documents.
- * @property {string | null} folderId - The ID of the currently selected folder, or `null` if no folder is selected.
- * @property {boolean} isDialogOpen - A flag indicating whether a dialog is open.
- */
-export interface DocumentState extends EntityState<DocumentModel, string> {
-  records: DocumentModel[];
-  folderId: string | null;
-  isDialogOpen: boolean;
-  filteredRecords:DocumentModel[]
-}
-
-/**
- * Creates the initial state for the `DocumentState` store.
- * 
- * This function provides default values for all properties in the `DocumentState` interface,
- * ensuring the store starts with a consistent initial structure.
- * 
- * @returns {DocumentState} The initial state of the document store.
- */
-export function createInitialState(): DocumentState {
-  return {
-    records: [],
-    filteredRecords: [],
-    folderId: null,
-    isDialogOpen: false,
-  };
-}

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

@@ -1,23 +0,0 @@
-import { Injectable } from '@angular/core';
-import { EntityStore, StoreConfig } from '@datorama/akita';
-import { createInitialState, DocumentState } from './document.state';
-
-/**
- * Store that manages the state of documents in the application.
- * 
- * The `DocumentStore` class extends Akita's `EntityStore` to manage the entity state for documents.
- * It uses the `createInitialState` function to initialize the store with default values and 
- * is configured with the name `'documents'`.
- * 
- * @extends EntityStore<DocumentState>
- */
-@Injectable({ providedIn: 'root' })
-@StoreConfig({ name: 'documents' })
-export class DocumentStore extends EntityStore<DocumentState> {
-  /**
-   * Creates an instance of `DocumentStore` with the initial state of the documents.
-   */
-  constructor() {
-    super(createInitialState());
-  }
-}

package/projects/cat-document-lib/src/public-api.ts

@@ -1,8 +0,0 @@
-/*
- * Public API Surface of cat-document-lib
- */
-
-export * from './lib/document/document.module';
-export * from './lib/document/components/document-container/document-container.component';
-export * from './lib/document/components/document-viewer/document-viewer.component'
-

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

@@ -1,232 +0,0 @@
-/**
- * The `SHARED` class contains shared constants used across the application.
- * These constants are related to document statuses and other shared data.
- */
-export class SHARED {
-  /**
-   * Represents the count of missing files.
-   */
-  static MISSINGCOUNT = 2;
-
-  /**
-   * Represents the count of pending files.
-   */
-  static PENDINGCOUNT = 3;
-
-  /**
-   * 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 = []
-
-  /**
-   * Represent contextId.
-   * @static
-   * @type {string}
-   */
-  static CONTEXT_ID : string = 'contextId'
-  
-  /**
-   * Represent fileSize.
-   * @static
-   * @type {string}
-   */
-  static FILE_SIZE : string = 'fileSize'
-}
-
-/**
- * `DUMMYDOCUMENTLIST` is a mock list of document objects used for testing and development purposes.
- * Each document includes an ID, file name, status, and document URL.
- */
-export const DUMMYDOCUMENTLIST = [
-  {
-    _id: 1,
-    fileName: 'Document 1',
-    status: 'pending',
-    documentUrl: 'https://vadimdez.github.io/ng2-pdf-viewer/assets/pdf-test.pdf',
-  },
-  {
-    _id: 2,
-    fileName: 'Document 2',
-    status: 'verified',
-    documentUrl: 'https://vadimdez.github.io/ng2-pdf-viewer/assets/pdf-test.pdf',
-  },
-  {
-    _id: 3,
-    fileName: 'Document 3',
-    status: 'sentReminder',
-    documentUrl: 'https://vadimdez.github.io/ng2-pdf-viewer/assets/pdf-test.pdf',
-  },
-  {
-    _id: 4,
-    fileName: 'Document 4',
-    status: 'pending',
-    documentUrl: 'https://vadimdez.github.io/ng2-pdf-viewer/assets/pdf-test.pdf',
-  },
-];
-
-/**
- * `FOLDERPANEL` is a mock list of folder data representing various folders in the application.
- * Each folder contains an ID, file count, text description, missing files count, and pending files count.
- */
-export const FOLDERPANEL = [
-  {
-    _id: 'folder1',
-    fileCount: 10,
-    text: 'Documents',
-    missingFiles: 3,
-    pendingFiles: 2,
-  },
-  {
-    _id: 'folder2',
-    fileCount: 5,
-    text: 'Images',
-    missingFiles: 0,
-    pendingFiles: 1,
-  },
-  {
-    _id: 'folder3',
-    fileCount: 20,
-    text: 'Reports',
-    missingFiles: 5,
-    pendingFiles: 0,
-  },
-  {
-    _id: 'folder4',
-    fileCount: 8,
-    text: 'Videos',
-    missingFiles: 0,
-    pendingFiles: 0,
-  },
-  {
-    _id: 'folder5',
-    fileCount: 15,
-    text: 'Archives',
-    missingFiles: 1,
-    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

@@ -1,31 +0,0 @@
-/**
- * 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

@@ -1,16 +0,0 @@
-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();
-  });
-});