cat-documents-ng 0.0.10 → 0.0.12

package/README.md

@@ -1,16 +1,6 @@
-# CatDocumentsNg
+# CatDocumentLib
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.0.5.
-
-## Development server
-
-To start a local development server, run:
-
-```bash
-ng serve
-```
-
-Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
+This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.0.0.
 
 ## Code scaffolding
 
@@ -28,13 +18,27 @@ ng generate --help
 
 ## Building
 
-To build the project run:
+To build the library, run:
 
 ```bash
-ng build
+ng build cat-document-lib
 ```
 
-This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+
+### Publishing the Library
+
+Once the project is built, you can publish your library by following these steps:
+
+1. Navigate to the `dist` directory:
+   ```bash
+   cd dist/cat-document-lib
+   ```
+
+2. Run the `npm publish` command to publish your library to the npm registry:
+   ```bash
+   npm publish
+   ```
 
 ## Running unit tests
 

package/Shared/constant/SHARED.d.ts

@@ -0,0 +1,150 @@
+/**
+ * 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 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 upload summery if it's failed.
+     * @static
+     * @type {'Upload Failed'}
+     */
+    static UPLOAD_SUMMERY: 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;
+}
+/**
+ * `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[];

package/{projects/cat-document-lib/src/Shared/constant/URLS.ts → Shared/constant/URLS.d.ts}

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

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/{projects/cat-document-lib/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>;
+}