cat-documents-ng 1.0.2 → 1.0.4

package/lib/document/state/document.store.d.ts

@@ -0,0 +1,56 @@
+import { EntityStore } from '@datorama/akita';
+import { DocumentState } from './document.state';
+import { DocumentCategory } from '../models/document-category.model';
+import { Message } from 'primeng/api';
+import { DocumentModel } from '../models/document.model';
+import { UserListModel } from '../models/user-list.model';
+import { StatusDataModel } from '../models/status-data.model';
+import { DocumentListResponse } from '../models/document-list-response.model';
+import { DocumentListItem } from '../models/document-list-response.model';
+import { DocumentHistorySection } from '../models/document-history.model';
+import * as i0 from "@angular/core";
+/**
+ * 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'`.
+ * @augments EntityStore<DocumentState>
+ */
+export declare class DocumentStore extends EntityStore<DocumentState> {
+    /**
+     * Creates an instance of `DocumentStore` with the initial state of the documents.
+     */
+    constructor();
+    setUploadedDocumentFiles(files: any[]): void;
+    setFolders(folders: any): void;
+    setDocumentTypes(documentType: any): void;
+    setDocumentAlert(documentAlert: any): void;
+    setParentDocumentTypeId(parentDocumentTypeId: string): void;
+    setMessage(message: Message[]): void;
+    setDocumentList(documents: DocumentModel[]): void;
+    setDocumentCategories(categories: DocumentCategory[]): void;
+    setSelectedMenuItem(menuItem: string | null): void;
+    setSelectedUserId(userId: string | null): void;
+    setSelectedStatus(status: string | null): void;
+    setSearchKey(searchKey: string | null): void;
+    setSelectionState(menuItem: string | null, userId: string | null, status: string | null, searchKey?: string | null): void;
+    clearSelectionState(): void;
+    setShowUserList(show: boolean): void;
+    setCurrentDocument(document: DocumentModel | null): void;
+    setUserList(userList: UserListModel[]): void;
+    setStatusData(statusData: StatusDataModel[]): void;
+    setDocumentListResponse(response: DocumentListResponse[] | null): void;
+    setSelectedDocument(document: DocumentListItem | undefined): void;
+    setDocumentHistory(history: DocumentHistorySection[]): void;
+    setShowDocumentHistory(show: boolean): void;
+    setIsActionLoading(loading: boolean): void;
+    setDocumentStatus(status: 'pending' | 'accepted' | 'rejected'): void;
+    setDocumentIsUploaded(uploaded: boolean): void;
+    setAlertData(alertData: any): void;
+    setDeleteError(error: any): void;
+    setDeleteSuccess(success: boolean): void;
+    updateDocumentViewerState(document?: DocumentListItem, history?: DocumentHistorySection[], showHistory?: boolean, loading?: boolean, status?: 'pending' | 'accepted' | 'rejected', uploaded?: boolean, alertData?: any): void;
+    clearDocumentViewerState(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentStore, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DocumentStore>;
+}

package/package.json

@@ -1,63 +1,25 @@
 {
   "name": "cat-documents-ng",
-  "version": "1.0.2",
-  "scripts": {
-    "ng": "ng",
-    "start": "ng serve",
-    "build": "ng build",
-    "watch": "ng build --watch --configuration development",
-    "test": "jest --config projects/cat-document-lib/jest.config.mjs",
-    "lint": "ng lint",
-    "prepare": "husky install"
-  },
-  "type": "module",
-  "dependencies": {
-    "@angular/animations": "^19.0.4",
-    "@angular/cdk": "^18.2.14",
+  "version": "1.0.4",
+  "peerDependencies": {
     "@angular/common": "^19.0.0",
-    "@angular/compiler": "^19.0.0",
-    "@angular/core": "^19.0.0",
-    "@angular/forms": "^19.0.0",
-    "@angular/platform-browser": "^19.0.0",
-    "@angular/platform-browser-dynamic": "^19.0.0",
-    "@angular/router": "^19.0.0",
-    "@datorama/akita": "^8.0.1",
-    "jsdocs": "^1.0.0",
-    "moment": "^2.30.1",
-    "ng2-pdf-viewer": "^9.1.5",
-    "primeflex": "^3.3.1",
-    "primeicons": "^7.0.0",
-    "primeng": "^17.18.10",
-    "rxjs": "~7.8.0",
-    "tslib": "^2.3.0",
-    "zone.js": "~0.15.0"
+    "@angular/core": "^19.0.0"
   },
-  "devDependencies": {
-    "@angular-devkit/build-angular": "^19.0.5",
-    "@angular-eslint/eslint-plugin": "^19.0.2",
-    "@angular-eslint/eslint-plugin-template": "^19.0.2",
-    "@angular-eslint/template-parser": "^19.0.2",
-    "@angular/cli": "^19.0.5",
-    "@angular/compiler-cli": "^19.0.0",
-    "@eslint/js": "^9.17.0",
-    "@types/jest": "^29.5.14",
-    "@typescript-eslint/eslint-plugin": "^8.18.0",
-    "@typescript-eslint/parser": "^8.18.0",
-    "angular-eslint": "19.0.2",
-    "eslint": "^9.17.0",
-    "eslint-plugin-jsdoc": "^50.6.1",
-    "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "jest-preset-angular": "^14.4.2",
-    "lint-staged": "^15.2.11",
-    "ng-packagr": "^19.0.0",
-    "typescript": "~5.6.2",
-    "typescript-eslint": "8.18.0"
+  "dependencies": {
+    "tslib": "^2.3.0"
   },
-  "lint-staged": {
-    "**/*.ts": "eslint",
-    "**/*.js": "eslint --fix",
-    "**/*.html": "eslint --fix",
-    "*.js": "eslint --cache --fix"
+  "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"
+    }
   }
-}
+}

package/public-api.d.ts

@@ -0,0 +1,27 @@
+export * from './lib/document/document.module';
+export * from './lib/document/components/document-container/document-container.component';
+export * from './lib/document/components/document-upload/document-upload.component';
+export * from './lib/document/components/document-viewer/document-viewer.component';
+export * from './lib/document/components/document-content-viewer/document-content-viewer.component';
+export * from './lib/document/components/document-zoom-controls/document-zoom-controls.component';
+export * from './lib/document/components/document-actions/document-actions.component';
+export * from './lib/document/components/document-history/document-history.component';
+export * from './lib/document/components/document-list/document-list.component';
+export * from './lib/document/components/document-search/document-search.component';
+export * from './lib/document/components/sidebar/sidebar.component';
+export * from './lib/document/components/request-document/request-document.component';
+export * from './lib/document/models/document-history.model';
+export * from './lib/document/models/uploaded-file-response.model';
+export * from './lib/document/services/document-table-builder.service';
+export * from './lib/document/services/document-content-type.service';
+export * from './lib/document/services/document-zoom.service';
+export * from './lib/document/services/eml-parser.service';
+export * from './lib/document/services/excel-parser.service';
+export * from './lib/document/services/csv-parser.service';
+export * from './lib/document/directives/document.directive';
+export * from './lib/document/directives/permission.directive';
+export * from './Shared/components/confirmation-dialog/confirmation-dialog.component';
+export * from './Shared/components/table-primary/table-primary.component';
+export * from './Shared/components/table-primary/table-primary.model';
+export * from './Shared/constant/SHARED';
+export * from './Shared/shared.module';

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,32 +0,0 @@
-## Hello Developer,
-Thank you for raising the Pull Request!
-We greatly appreciate your efforts and contributions to the team. To ensure the quality and standards our team is committed to, we kindly request you to complete the checklist below before submitting the PR.
-
-## Pull Request Checklist
-
-### Code Quality
-- [Y/N] Code adheres to coding standards and style guides.
-- [Y/N] Code is properly commented and documented.
-- [Y/N] No Hard-coded values are added.
-- [Y/N] PR doesn't include more than 10 files.
-
-### Clean Coding
-- [Y/N] Classes and methods adheres to Single Responsibility Principle
-- [Y/N] Classes are not exceeding 200 lines of code
-- [Y/N] Methods are not exceeding 20 lines of code
-
-### Testing
-- [Y/N] Unit tests are written and executed.
-- [Y/N] All tests pass successfully.
-- [Y/N] Manual testing is completed and verified.
-
-### Functionality
-- [Y/N] Feature behaves as expected.
-- [Y/N] Edge cases are handled.
-
-### Documentation
-- [Y/N] Relevant documentation is updated (e.g., README, user guides, API docs).
-
-### Dependencies
-- [Y/N] No unused dependencies or imports.
-- [Y/N] Dependencies are updated and compatible.

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx lint-staged

package/angular.json

@@ -1,119 +0,0 @@
-{
-  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
-  "version": 1,
-  "newProjectRoot": "projects",
-  "projects": {
-    "cat-documents-ng": {
-      "projectType": "application",
-      "schematics": {
-        "@schematics/angular:component": {
-          "style": "scss"
-        }
-      },
-      "root": "",
-      "sourceRoot": "src",
-      "prefix": "app",
-      "architect": {
-        "build": {
-          "builder": "@angular-devkit/build-angular:application",
-          "options": {
-            "outputPath": "dist/cat-documents-ng",
-            "index": "src/index.html",
-            "browser": "src/main.ts",
-            "polyfills": ["zone.js"],
-            "tsConfig": "tsconfig.app.json",
-            "inlineStyleLanguage": "scss",
-            "assets": [
-              "src/favicon.ico",
-              "src/assets",
-              {
-                "glob": "**/*",
-                "input": "dist/cat-document-lib/src/assets",
-                "output": "assets"
-              }
-            ],
-            "styles": [
-              "./node_modules/primeng/resources/themes/saga-blue/theme.css",
-              "./node_modules/primeng/resources/primeng.min.css",
-              "./node_modules/primeicons/primeicons.css",
-              "./node_modules/primeflex/primeflex.css",
-              "src/styles.scss"
-            ],
-            "scripts": []
-          },
-          "configurations": {
-            "production": {
-              "budgets": [
-                {
-                  "type": "initial",
-                  "maximumWarning": "500kB",
-                  "maximumError": "1MB"
-                },
-                {
-                  "type": "anyComponentStyle",
-                  "maximumWarning": "4kB",
-                  "maximumError": "8kB"
-                }
-              ],
-              "outputHashing": "all"
-            },
-            "development": {
-              "optimization": false,
-              "extractLicenses": false,
-              "sourceMap": true
-            }
-          },
-          "defaultConfiguration": "production"
-        },
-        "serve": {
-          "builder": "@angular-devkit/build-angular:dev-server",
-          "configurations": {
-            "production": {
-              "buildTarget": "cat-documents-ng:build:production"
-            },
-            "development": {
-              "buildTarget": "cat-documents-ng:build:development"
-            }
-          },
-          "defaultConfiguration": "development"
-        },
-        "extract-i18n": {
-          "builder": "@angular-devkit/build-angular:extract-i18n"
-        },
-        "lint": {
-          "builder": "@angular-eslint/builder:lint",
-          "options": {
-            "eslintConfig": "eslint.config.js",
-            "lintFilePatterns": ["src/**/*.ts", "src/**/*.html"]
-          }
-        }
-      }
-    },
-    "cat-document-lib": {
-      "projectType": "library",
-      "root": "projects/cat-document-lib",
-      "sourceRoot": "projects/cat-document-lib/src",
-      "prefix": "lib",
-      "architect": {
-        "build": {
-          "builder": "@angular-devkit/build-angular:ng-packagr",
-          "options": {
-            "project": "projects/cat-document-lib/ng-package.json"
-          },
-          "configurations": {
-            "production": {
-              "tsConfig": "projects/cat-document-lib/tsconfig.lib.prod.json"
-            },
-            "development": {
-              "tsConfig": "projects/cat-document-lib/tsconfig.lib.json"
-            }
-          },
-          "defaultConfiguration": "production"
-        }
-      }
-    }
-  },
-  "cli": {
-    "analytics": "77456047-823c-4f1a-b41d-1ddee393b72d"
-  }
-}

package/eslint.config.cjs

@@ -1,148 +0,0 @@
-// @ts-check
-const eslint = require("@eslint/js");
-const tseslint = require("@typescript-eslint/eslint-plugin");
-const tseslintParser = require("@typescript-eslint/parser");
-const angular = require("@angular-eslint/eslint-plugin");
-const jsdoc = require("eslint-plugin-jsdoc");
-const angularParser = require("@angular-eslint/template-parser");
-
-module.exports = [
-  {
-    files: ["**/*.ts"],
-    languageOptions: {
-      parser: tseslintParser, // Use TypeScript parser for .ts files
-      parserOptions: {
-        ecmaVersion: 2020,
-        sourceType: "module",
-        project: "./tsconfig.json", // Ensure this points to your tsconfig.json
-      },
-    },
-    plugins: {
-      "@typescript-eslint": tseslint,
-      "@angular-eslint": angular,
-      jsdoc,
-    },
-    rules: {
-      "@angular-eslint/directive-selector": [
-        "error",
-        {
-          type: "attribute",
-          style: "camelCase",
-        },
-      ],
-      "@angular-eslint/component-selector": [
-        "error",
-        {
-          type: "element",
-          style: "kebab-case",
-        },
-      ],
-      "jsdoc/check-access": 1, // Recommended
-      "jsdoc/check-alignment": 1, // Recommended
-      "jsdoc/check-param-names": 1, // Recommended
-      "jsdoc/check-property-names": 1, // Recommended
-      "jsdoc/check-tag-names": 1, // Recommended
-      "jsdoc/check-types": 1, // Recommended
-      "jsdoc/check-values": 1, // Recommended
-      "jsdoc/empty-tags": 1, // Recommended
-      "jsdoc/implements-on-classes": 1, // Recommended
-      "jsdoc/multiline-blocks": 1, // Recommended
-      "jsdoc/no-multi-asterisks": 1, // Recommended
-      "jsdoc/no-undefined-types": 1, // Recommended
-      "jsdoc/require-jsdoc": [
-        "error",
-        {
-          "contexts": [
-            "ClassDeclaration",
-            "ClassExpression",
-            "ArrowFunctionExpression",
-            "FunctionDeclaration",
-            "FunctionExpression",
-          ],
-        },
-      ],
-      'jsdoc/require-description': 'error',
-      "jsdoc/require-param": 1, // Recommended
-      "jsdoc/require-param-description": 1, // Recommended
-      "jsdoc/require-param-name": 1, // Recommended
-      "jsdoc/require-param-type": 1, // Recommended
-      "jsdoc/require-property": 1, // Recommended
-      "jsdoc/require-property-description": 1, // Recommended
-      "jsdoc/require-property-name": 1, // Recommended
-      "jsdoc/require-property-type": 1, // Recommended
-      "jsdoc/require-returns": 1, // Recommended
-      "jsdoc/require-returns-check": 1, // Recommended
-      "jsdoc/require-returns-description": 1, // Recommended
-      "jsdoc/require-returns-type": 1, // Recommended
-      "jsdoc/require-yields": 1, // Recommended
-      "jsdoc/require-yields-check": 1, // Recommended
-      "jsdoc/tag-lines": 1, // Recommended
-      "jsdoc/valid-types": 1, // Recommended
-      "max-lines": [
-        "error",
-        {
-          max: 200,
-          skipBlankLines: true,
-          skipComments: true,
-        },
-      ],
-      "max-lines-per-function": [
-        "error",
-        {
-          max: 20,
-          skipBlankLines: true,
-          skipComments: true,
-          IIFEs: true,
-        },
-      ],
-    },
-  },
-  {
-    files: ["**/*.html"],
-    languageOptions: {
-      parser: angularParser, // Use Angular template parser
-    },
-    plugins: {
-      "@angular-eslint": angular,
-    },
-    rules: {
-      // Add custom template rules here if needed
-    },
-  },
-  {
-    files: ["**/*.spec.ts"],
-    languageOptions: {
-      parser: tseslintParser, // Use TypeScript parser for .spec.ts files
-      parserOptions: {
-        ecmaVersion: 2020,
-        sourceType: "module",
-        project: "./tsconfig.json", // Ensure this points to your tsconfig.json
-      },
-    },
-    plugins: {
-      "@typescript-eslint": tseslint,
-      "@angular-eslint": angular,
-    },
-    rules: {
-      // Custom rules for spec files, e.g., allow certain things that are specific to testing
-      "max-lines": [
-        "error", // You might want to warn rather than error in test files
-        {
-          max: 500, // Allow more lines in spec files
-          skipBlankLines: true,
-          skipComments: true,
-        },
-      ],
-      "max-lines-per-function": [
-        "error", // You might want to relax this for test files as well
-        {
-          max: 50, // Allow more lines in functions in spec files
-          skipBlankLines: true,
-          skipComments: true,
-          IIFEs: true,
-        },
-      ],
-      // Add other rules specific to testing or Jest (if applicable)
-    },
-  }
-];

package/projects/cat-document-lib/README.md

@@ -1,63 +0,0 @@
-# CatDocumentLib
-
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.0.0.
-
-## Code scaffolding
-
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
-
-```bash
-ng generate component component-name
-```
-
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
-
-```bash
-ng generate --help
-```
-
-## Building
-
-To build the library, run:
-
-```bash
-ng build cat-document-lib
-```
-
-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
-
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
-
-```bash
-ng test
-```
-
-## Running end-to-end tests
-
-For end-to-end (e2e) testing, run:
-
-```bash
-ng e2e
-```
-
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
-
-## Additional Resources
-
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.

package/projects/cat-document-lib/ng-package.json

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

package/projects/cat-document-lib/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "cat-document-lib",
-  "version": "0.0.1",
-  "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"
-}

package/projects/cat-document-lib/setup-jest.ts

@@ -1 +0,0 @@
-import 'jest-preset-angular/setup-jest';

package/projects/cat-document-lib/src/lib/document/components/document-container/document-container.component.html

@@ -1,6 +0,0 @@
-<div class="grid m-0">
-    <div class="col-12 md:col-12 lg:col-12 overflow-y-scroll py-0 pl-0" >
-      <lib-folder-container [documentList]="documentList"></lib-folder-container>
-      <lib-document-list [documentList]="documentList"></lib-document-list>
-    </div>
-</div>

package/projects/cat-document-lib/src/lib/document/components/document-container/document-container.component.ts

@@ -1,82 +0,0 @@
-import { Component, Input, OnInit } from '@angular/core';
-import { SHARED } from '../../../../Shared/constant/SHARED';
-import { DocumentService } from '../../state/document.service';
-import { DocumentModel } from '../../models/document.model';
-import { URLS } from '../../../../Shared/constant/URLS';
-import { Subscription } from 'rxjs';
-
-
-/**
- *This component is responsible for managing and displaying a list of documents.
- * @class DocumentContainerComponent
- * @typedef {DocumentContainerComponent}
- */
-@Component({
-  selector: 'lib-document-container',
-  standalone: false,
-  templateUrl: './document-container.component.html',
-  styleUrl: './document-container.component.scss'
-})
-export class DocumentContainerComponent implements OnInit{
-
-  /**
-   * Creates an instance of DocumentContainerComponent.
-   * @class
-   * @param {DocumentService} documentService - Service to manage document-related operations.
-   */
-  constructor(public documentService : DocumentService){
-
-  }
-  /**
-   * Get contextId in input.
-   * @type {string}
-   */
-  @Input() contextId : string = SHARED.EMPTY;
-  /**
-   * The list of dummy documents.
-   * @type {Array}
-   */
-  documentList : DocumentModel[] = []
-
-  /**
-   * Holds the subscription to manage observable cleanup.
-   * @private
-   * @type {Subscription}
-   */
-  private subscription: Subscription = new Subscription();
-
-  /** 
-   * Call document service method to get the document by contextId.
-   */
-  ngOnInit(): void {
-    const documentSubscription = this.documentService
-      .getById(`${URLS.CONTEXT}${this.contextId}`)
-      .subscribe({
-        /**
-         * Handles the successful API response.
-         * @param {DocumentModel[]} res - The list of documents returned by the API.
-         */
-        next: (res: DocumentModel[]) => {
-          if (res) {
-            this.documentList = res;
-          }
-        },
-        /**
-         * Handles errors that occur during the API call.
-         * Logs the error to the console.
-         * @param {any} err - The error object returned from the API.
-         */
-        error: (err) => {
-          throw new Error(err)
-        }
-      });
-    this.subscription.add(documentSubscription);
-  }
-
-  /** 
-   * Unsubscribe subscription on destroy of component .
-   */
-  ngOnDestroy(): void {
-    this.subscription.unsubscribe();
-  }
-}