cat-documents-ng 0.1.30 → 0.1.32

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

@@ -1,38 +1,43 @@
-/**
- * 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:";
-}
+/**
+ * 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;
+    /**
+     * Error message when the file name contains invalid characters.
+     * Disallowed characters: <, >, :, ", /, \, |, ?, *
+     * @static
+     * @type {string}
+     */
+    static ERROR_INVALID_FILENAME_CHARACTERS: string;
+}

package/Shared/constant/PERMISSIONS.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Storing all permission properties.
+ * @export
+ * @class PERMISSIONS
+ * @typedef {PERMISSIONS}
+ */
+export declare class PERMISSIONS {
+    /**
+     * Access permission.
+     * @static
+     * @type {string}
+     */
+    static DOCUMENT_POST: string;
+    /**
+     * Access permission for updating existing documents.
+     * @static
+     * @type {string}
+     */
+    static DOCUMENT_PUT: string;
+}

package/Shared/constant/SHARED.d.ts

@@ -0,0 +1,215 @@
+/**
+ * The `SHARED` class contains shared constants used across the application.
+ * These constants are related to document statuses and other shared data.
+ */
+export declare class SHARED {
+    /**
+     * Represents the stores userData.
+     */
+    static SESSIONKEY: string;
+    /**
+     * Represents the count of missing files.
+     */
+    static MISSINGCOUNT: number;
+    /**
+     * Represents the count of pending files.
+     */
+    static PENDINGCOUNT: number;
+    /**
+     * Represents an empty string.
+     */
+    static EMPTY: string;
+    /**
+     * Represents an true.
+     * @static
+     * @type {boolean}
+     */
+    static TRUE: boolean;
+    /**
+     * Represents an false.
+     * @static
+     * @type {boolean}
+     */
+    static FALSE: boolean;
+    /**
+     * Represents an INITIAL_COUNT.
+     */
+    static INITIAL_COUNT: number;
+    /**
+     * Represents an INITIAL_VALUE.
+     */
+    static INITIAL_VALUE: number;
+    /**
+     * Represents the constant value for one (1).
+     * @static
+     * @type {number}
+     */
+    static ONE: number;
+    /**
+     * Represents the constant value for two (2).
+     * @static
+     * @type {number}
+     */
+    static TWO: number;
+    /**
+     * Represents the constant value for ten (10).
+     * @static
+     * @type {number}
+     */
+    static TEN: number;
+    /**
+     * Represents the constant string value 'files' used for file-related operations.
+     * @static
+     * @type {string}
+     */
+    static FILE: string;
+    /**
+     * Represents the array of file size units ('B', 'KB', 'MB') used for file size formatting.
+     * @static
+     * @type {string[]}
+     */
+    static FILE_SIZE_UNITS: string[];
+    /**
+     * Show SEVERITY value.
+     * @static
+     * @type {'error'}
+     */
+    static SEVERITY: string;
+    /**
+     * Show SEVERITY value.
+     * @static
+     * @type {'error'}
+     */
+    static SUCCESS_SEVERITY: string;
+    /**
+     * Show upload summery if it's failed.
+     * @static
+     * @type {'Upload Failed'}
+     */
+    static UPLOAD_SUMMERY: string;
+    /**
+     * Show upload summery if it's success.
+     * @static
+     * @type {'Document uploaded successfully.'}
+     */
+    static UPLOAD_SUCCESS: string;
+    /**
+     * Represent empty array.
+     * @static
+     * @type {{}}
+     */
+    static EMPTY_ARRAY: never[];
+    /**
+     * Represent contextId.
+     * @static
+     * @type {string}
+     */
+    static CONTEXT_ID: string;
+    /**
+     * Represent fileSize.
+     * @static
+     * @type {string}
+     */
+    static FILE_SIZE: string;
+    /**
+     * Represent documentName.
+     * @static
+     * @type {string}
+     */
+    static DOCUMENT_NAME: string;
+    /**
+     * Represent documentTypeId.
+     * @static
+     * @type {string}
+     */
+    static DOCUMENT_TYPE_ID: string;
+    /**
+     * Represent upload summery.
+     * @static
+     * @type {string}
+     */
+    static UPLOAD_ERROR_SUMMERY: string;
+    /**
+     * Represent upload error details.
+     * @static
+     * @type {string}
+     */
+    static UPLOAD_ERROR_DETAILS: string;
+    /**
+     * Represents the message prefix for a successful document name update.
+     * @static
+     * @type {string}
+     */
+    static UPDATE_DOCUMENT_NAME: string;
+    /**
+     * Identifier used to reference the file input element (e.g., for ViewChild or DOM access).
+     * @static
+     * @type {string}
+     */
+    static FILE_INPUT: string;
+}
+/**
+ * `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 declare const DUMMYDOCUMENTLIST: {
+    _id: number;
+    fileName: string;
+    status: string;
+    documentUrl: string;
+}[];
+/**
+ * `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 declare const FOLDERPANEL: {
+    _id: string;
+    fileCount: number;
+    text: string;
+    missingFiles: number;
+    pendingFiles: number;
+}[];
+/**
+ * Dummy data for sumaery.
+ * @type {{}}
+ */
+export declare const DUMMYSUMMARY: ({
+    status: string;
+    date: string;
+    icon: string;
+    color: string;
+    image: string;
+} | {
+    status: string;
+    date: string;
+    icon: string;
+    color: string;
+    image?: undefined;
+})[];
+/**
+ * Dummy data for list box.
+ * @type {{}}
+ */
+export declare const COUNTRIES: {
+    name: string;
+    code: string;
+    checked: boolean;
+}[];
+/**
+ * Default supported image types.
+ * @type {{}}
+ */
+export declare const SUPPORTED_IMAGE_TYPES: string[];
+/**
+ * @constant {Array<{label: string, value: string, files: string[]}>} DOCUMENTTYPES
+ * An array of document type objects containing labels, values, and associated files.
+ */
+export declare const DOCUMENTTYPES: {
+    label: string;
+    value: string;
+}[];
+export declare const DocumentAlertList: {
+    status: string;
+    isAlert: boolean;
+    alertMessage: string;
+}[];

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

@@ -1,65 +1,60 @@
-/**
- * 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=";
-}
+/**
+ * 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;
+}

package/Shared/services/app-config.service.d.ts

@@ -0,0 +1,51 @@
+import { HttpClient } from '@angular/common/http';
+import * as i0 from "@angular/core";
+/**
+ * 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}
+ */
+export declare class AppConfigService {
+    private http;
+    /**
+     * Holds the configuration data loaded from the server.
+     * @private
+     * @type {*}
+     */
+    private appConfig;
+    /**
+     * 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(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 {*}
+     */
+    loadAppConfig(): Promise<void>;
+    /**
+     * Returns the base URL for the API from the loaded configuration.
+     * @readonly
+     * @type {*}
+     */
+    get apiBaseUrl(): any;
+    /**
+     * Returns the local server API URL from the loaded configuration.
+     * @readonly
+     * @type {*}
+     */
+    get localServerApi(): any;
+    /**
+     * Returns the visibility options from the loaded configuration.
+     * @readonly
+     * @type {*}
+     */
+    get visibilityOptions(): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AppConfigService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AppConfigService>;
+}

package/{src/Shared/services/global-error.handler.ts → Shared/services/global-error.handler.d.ts}

@@ -1,29 +1,27 @@
-import { ErrorHandler, Injectable, Injector } from '@angular/core';
-import { HttpErrorResponse } from '@angular/common/http';
-
-/**
- * GlobalErrorHandler is a custom error handler that implements the ErrorHandler interface.
- * It is used to handle both HTTP errors and other types of errors globally in the application.
- * @class
- * @implements {ErrorHandler}
- * @decorator {Injectable}
- */
-@Injectable()
-export class GlobalErrorHandler implements ErrorHandler {
-    /**
-     * Creates an instance of GlobalErrorHandler.
-     * @constructor
-     * @param {Injector} injector - The Angular injector used to get instances of services.
-     */
-    constructor(private injector: Injector) { }
-
-    /**
-     * Handles errors globally in the application.
-     * 
-     * @param {any} error - The error object that needs to be handled.
-     * @returns {void}
-     */
-    handleError(error: any): void {
-        console.error('GlobalErrorHandler:', error);
-    }
-}
+import { ErrorHandler, Injector } from '@angular/core';
+import * as i0 from "@angular/core";
+/**
+ * GlobalErrorHandler is a custom error handler that implements the ErrorHandler interface.
+ * It is used to handle both HTTP errors and other types of errors globally in the application.
+ * @class
+ * @implements {ErrorHandler}
+ * @decorator {Injectable}
+ */
+export declare class GlobalErrorHandler implements ErrorHandler {
+    private injector;
+    /**
+     * Creates an instance of GlobalErrorHandler.
+     * @constructor
+     * @param {Injector} injector - The Angular injector used to get instances of services.
+     */
+    constructor(injector: Injector);
+    /**
+     * Handles errors globally in the application.
+     *
+     * @param {any} error - The error object that needs to be handled.
+     * @returns {void}
+     */
+    handleError(error: any): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GlobalErrorHandler, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GlobalErrorHandler>;
+}

package/Shared/services/session.service.d.ts

@@ -0,0 +1,46 @@
+import { Router } from '@angular/router';
+import * as i0 from "@angular/core";
+/**
+ * Service for managing user session details.
+ * @class SessionService
+ * @typedef {SessionService}
+ */
+export declare class SessionService {
+    router: Router;
+    /**
+     * Creates an instance of SessionService.
+     * @param {Router} router - Angular Router for navigation.
+     */
+    constructor(router: Router);
+    /**
+     * Retrieves the current user's role from local storage.
+     * @returns {string | null} The user's role, or null if not found.
+     */
+    getUserRole(): string | null;
+    /**
+     * Stores the user session data in local storage.
+     * @param {any} data - The session data to store.
+     */
+    setUserSession(data: any): void;
+    /**
+     * Retrieves the stored user session data.
+     * @returns {any | null} The parsed session data, or null if not found.
+     */
+    getUserSession(): any | null;
+    /**
+     * Retrieves the user's permissions from the stored session data.
+     * @returns {any | null} The user's permissions, or null if not found.
+     */
+    getUserPermissions(): any | null;
+    /**
+     * Retrieves the session ID from the stored session data.
+     * @returns {any | null} The session ID, or null if not found.
+     */
+    getSessionID(): any | null;
+    /**
+     * Clears all stored session data from local storage.
+     */
+    clearSession(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SessionService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SessionService>;
+}