cat-documents-ng 0.1.27 → 0.1.30

package/ng-package.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../dist/cat-document-lib",
+  "lib": {
+    "entryFile": "src/public-api.ts"
+  },
+ "assets": [
+ "src/assets"
+  ]
+
+}

package/package.json

@@ -1,25 +1,20 @@
-{
-  "name": "cat-documents-ng",
-  "version": "0.1.27",
-  "peerDependencies": {
-    "@angular/common": "^19.0.0",
-    "@angular/core": "^19.0.0"
-  },
-  "dependencies": {
-    "tslib": "^2.3.0"
-  },
-  "typings": "index.d.ts",
-  "sideEffects": false,
-  "main": "bundles/cat-document-lib.umd.js",
-  "module": "fesm2022/cat-documents-ng.mjs",
-  "es2015": "fesm2015/cat-document-lib.js",
-  "exports": {
-    "./package.json": {
-      "default": "./package.json"
-    },
-    ".": {
-      "types": "./index.d.ts",
-      "default": "./fesm2022/cat-documents-ng.mjs"
-    }
-  }
-}
+{
+  "name": "cat-documents-ng",
+
+  "version": "0.1.30",
+  "peerDependencies": {
+    "@angular/common": "^19.0.0",
+    "@angular/core": "^19.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "typings": "index.d.ts",
+  "sideEffects": false,
+  "main": "bundles/cat-document-lib.umd.js",
+  "module": "fesm2015/cat-document-lib.js",
+  "es2015": "fesm2015/cat-document-lib.js",
+  "devDependencies": {
+    "@types/jest": "^29.5.14"
+  }
+}

package/{Shared/constant/ERROR.d.ts → src/Shared/constant/ERROR.ts}

@@ -1,36 +1,38 @@
-/**
- * A utility class containing common error messages.
- * @class ERRORS
- */
-export declare class ERRORS {
-    /**
-     * Error message for invalid recipient.
-     * @static
-     * @type {string}
-     */
-    static INVALID_RECIPIENT: string;
-    /**
-     * Error message for invalid document.
-     * @static
-     * @type {string}
-     */
-    static ERROR_FETCHING_DOCUMENTS: string;
-    /**
-     * Error message for invalid document.
-     * @static
-     * @type {string}
-     */
-    static ERROR_FETCHING_FOLDERS: string;
-    /**
-     * Error message for invalid document.
-     * @static
-     * @type {string}
-     */
-    static ERROR_ALLDOCUMENT_MISSING: string;
-    /**
-     * Error message for invalid document.
-     * @static
-     * @type {string}
-     */
-    static ERROR_DOCUMENT_TYPES: string;
-}
+/**
+ * A utility class containing common error messages.
+ * @class ERRORS
+ */
+export class ERRORS {
+    /**
+     * Error message for invalid recipient.
+     * @static
+     * @type {string}
+     */
+    static INVALID_RECIPIENT = "Invalid recipient: The recipient cannot be empty.";
+    
+    /**
+     * Error message for invalid document.
+     * @static
+     * @type {string}
+     */
+    static ERROR_FETCHING_DOCUMENTS = "Error fetching documents:";
+    /**
+     * Error message for invalid document.
+     * @static
+     * @type {string}
+     */
+    static ERROR_FETCHING_FOLDERS = "Error fetching folders:";
+   
+    /**
+     * Error message for invalid document.
+     * @static
+     * @type {string}
+     */
+    static ERROR_ALLDOCUMENT_MISSING = "allDocumentTypes is missing in the response:";
+    /**
+     * Error message for invalid document.
+     * @static
+     * @type {string}
+     */
+    static ERROR_DOCUMENT_TYPES = "Error fetching document types:";
+}

package/src/Shared/constant/PERMISSIONS.ts

@@ -0,0 +1,16 @@
+
+/**
+ * Storing all permission properties.
+ * @export
+ * @class PERMISSIONS
+ * @typedef {PERMISSIONS}
+ */
+export class PERMISSIONS{
+    
+/**
+ * Access permission.
+ * @static
+ * @type {string}
+ */
+static DOCUMENT_POST = 'Documents-POST'
+}

package/src/Shared/constant/SHARED.ts

@@ -0,0 +1,312 @@
+/**
+ * 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 stores userData.
+   */
+  static SESSIONKEY = 'userData';
+  /**
+   * 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 SEVERITY value.
+   * @static
+   * @type {'error'}
+   */
+  static SUCCESS_SEVERITY:string = 'success'
+
+  /**
+   * Show upload summery if it's failed.
+   * @static
+   * @type {'Upload Failed'}
+   */
+  static UPLOAD_SUMMERY:string = 'Upload Failed'
+  
+  /**
+   * Show upload summery if it's success.
+   * @static
+   * @type {'Document uploaded successfully.'}
+   */
+  static UPLOAD_SUCCESS:string = 'Document uploaded successfully.'
+
+  /**
+   * 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'
+  /**
+   * Represent documentName.
+   * @static
+   * @type {string}
+   */
+  static DOCUMENT_NAME : string = 'documentName'
+  /**
+   * Represent documentTypeId.
+   * @static
+   * @type {string}
+   */
+  static DOCUMENT_TYPE_ID : string = 'documentTypeId'
+  
+  /**
+   * Represent upload summery.
+   * @static
+   * @type {string}
+   */
+  static UPLOAD_ERROR_SUMMERY : string = 'Form Data Missing'
+  
+  /**
+   * Represent upload error details.
+   * @static
+   * @type {string}
+   */
+  static UPLOAD_ERROR_DETAILS : string = 'Required form data is missing. Please ensure the document and all required fields are provided.'
+
+  /**
+   * Represents the message prefix for a successful document name update.
+   * @static
+   * @type {string}
+   */
+  static UPDATE_DOCUMENT_NAME :string = 'Document name updated for ID:'
+}
+
+/**
+ * `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'
+];
+
+/**
+ * @constant {Array<{label: string, value: string, files: string[]}>} DOCUMENTTYPES
+ * An array of document type objects containing labels, values, and associated files.
+ */
+
+export const DOCUMENTTYPES= [
+  {
+    label: "BankStatement",
+    value: "bank_statement",
+  },
+  {
+    label: "Payslip",
+    value: "payslip",
+  },
+  {
+    label: "Selfie",
+    value: "selfie",
+  },
+  {
+    label: "Other",
+    value: "other",
+  }
+];
+
+export const DocumentAlertList = [
+  { status: 'Pending', isAlert: true, alertMessage: 'The name on the payslip does not match either the driver name or the policyholder name.' },
+  { status: 'Verified', isAlert: false, alertMessage: 'Document is verified successfully.' },
+];

package/{Shared/constant/URLS.d.ts → src/Shared/constant/URLS.ts}

@@ -1,60 +1,65 @@
-/**
- * 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 declare 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: string;
-    /**
-     * The URL endpoint for document uploads.
-     * Used to send documents to the server for storage or processing.
-     * @static
-     * @type {string}
-     */
-    static DOCUMENT_UPLOAD: string;
-    /**
-     * 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: string;
-    /**
-     * The query parameter to pass a document ID in API requests.
-     * @static
-     * @type {string}
-     */
-    static DOCUMENT_TYPES: string;
-    /**
-     * The query parameter to pass a context ID in API requests.
-     * @static
-     * @type {string}
-     */
-    static FOLDERS: string;
-    /**
-     * The query parameter to pass a document ID in API requests.
-     * @static
-     * @type {string}
-     */
-    static ALERT_BY_DOCUMENT_ID: string;
-    /**
-     * The query parameter to pass a document ID in API requests.
-     * @static
-     * @type {string}
-     */
-    static PARENT_DOCUMENT_TYPE_ID: string;
-    /**
-     * 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_ID: string;
-}
+/**
+ * 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/api.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=";
+
+    /**
+     * The query parameter to pass a document ID in API requests.
+     * @static
+     * @type {string}
+     */
+    static DOCUMENT_TYPES = "documentTypes";
+    /**
+     * The query parameter to pass a context ID in API requests.
+     * @static
+     * @type {string}
+     */
+    static FOLDERS = "/folders?contextId=";
+    /**
+     * The query parameter to pass a document ID in API requests.
+     * @static
+     * @type {string}
+     */
+    static ALERT_BY_DOCUMENT_ID = "alerts?documentId=";
+    /**
+     * The query parameter to pass a document ID in API requests.
+     * @static
+     * @type {string}
+     */
+    static PARENT_DOCUMENT_TYPE_ID = "parentDocumentType?parentDocumentTypeId=";
+
+    /**
+     * 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_ID = "&contextId=";
+}

package/src/Shared/services/app-config.service.spec.ts

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

package/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?.documentApiUrl;
+  }
+
+  /**
+   * 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;
+  }
+}