@tomei/rental 0.12.4 → 0.13.0

package/migrations/rental-table-migrations.js

@@ -1,96 +1,96 @@
-'use strict';
-
-/** @type {import('sequelize-cli').Migration} */
-module.exports = {
-    async up(queryInterface, Sequelize) {
-        await queryInterface.createTable('rental_Rental', {
-            RentalId: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-                primaryKey: true,
-            },
-            CustomerId: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-            },
-            CustomerType: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-            },
-            ItemId: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-            },
-            ItemType: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-            },
-            PriceId: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-                references: {
-                    model: 'rental_Price',
-                    key: 'PriceId',
-                },
-                onUpdate: 'CASCADE',
-                onDelete: 'CASCADE',
-            },
-            StartDateTime: {
-                type: Sequelize.DATE,
-                allowNull: false,
-            },
-            EndDateTime: {
-                type: Sequelize.DATE,
-                allowNull: false,
-            },
-            Status: {
-                type: Sequelize.STRING(50),
-                allowNull: false,
-            },
-            CancelRemarks: {
-                type: Sequelize.STRING(3000),
-            },
-            TerminateRemarks: {
-                type: Sequelize.STRING(3000),
-            },
-            EscheatmentYN: {
-                type: Sequelize.CHAR(1),
-            },
-            AgreementNo: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-                unique: true,
-                references: {
-                    model: 'rental_Agreement',
-                    key: 'AgreementNo',
-                },
-                onUpdate: 'CASCADE',
-                onDelete: 'CASCADE',
-            },
-            AccountType: {
-                type: Sequelize.STRING(10),
-                allowNull: false,
-            },
-            CreatedById: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-            },
-            CreatedAt: {
-                type: Sequelize.DATE,
-                allowNull: false,
-            },
-            UpdatedById: {
-                type: Sequelize.STRING(30),
-                allowNull: false,
-            },
-            UpdatedAt: {
-                type: Sequelize.DATE,
-                allowNull: false,
-            },
-        });
-    },
-
-    async down(queryInterface) {
-        await queryInterface.dropTable('rental_Rental');
-    },
-};
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+    async up(queryInterface, Sequelize) {
+        await queryInterface.createTable('rental_Rental', {
+            RentalId: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+                primaryKey: true,
+            },
+            CustomerId: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+            },
+            CustomerType: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+            },
+            ItemId: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+            },
+            ItemType: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+            },
+            PriceId: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+                references: {
+                    model: 'rental_Price',
+                    key: 'PriceId',
+                },
+                onUpdate: 'CASCADE',
+                onDelete: 'CASCADE',
+            },
+            StartDateTime: {
+                type: Sequelize.DATE,
+                allowNull: false,
+            },
+            EndDateTime: {
+                type: Sequelize.DATE,
+                allowNull: false,
+            },
+            Status: {
+                type: Sequelize.STRING(50),
+                allowNull: false,
+            },
+            CancelRemarks: {
+                type: Sequelize.STRING(3000),
+            },
+            TerminateRemarks: {
+                type: Sequelize.STRING(3000),
+            },
+            EscheatmentYN: {
+                type: Sequelize.CHAR(1),
+            },
+            AgreementNo: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+                unique: true,
+                references: {
+                    model: 'rental_Agreement',
+                    key: 'AgreementNo',
+                },
+                onUpdate: 'CASCADE',
+                onDelete: 'CASCADE',
+            },
+            AccountType: {
+                type: Sequelize.STRING(10),
+                allowNull: false,
+            },
+            CreatedById: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+            },
+            CreatedAt: {
+                type: Sequelize.DATE,
+                allowNull: false,
+            },
+            UpdatedById: {
+                type: Sequelize.STRING(30),
+                allowNull: false,
+            },
+            UpdatedAt: {
+                type: Sequelize.DATE,
+                allowNull: false,
+            },
+        });
+    },
+
+    async down(queryInterface) {
+        await queryInterface.dropTable('rental_Rental');
+    },
+};

package/package.json

@@ -1,75 +1,75 @@
-{
-  "name": "@tomei/rental",
-  "version": "0.12.4",
-  "description": "Tomei Rental Package",
-  "main": "dist/index.js",
-  "scripts": {
-    "start:dev": "tsc -w",
-    "build": "tsc",
-    "prepare": "husky install",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "npx eslint . --fix",
-    "test": "jest --forceExit --detectOpenHandles"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@gitlab.com/tomei-package/rental.git"
-  },
-  "keywords": [
-    "tomei",
-    "rental"
-  ],
-  "author": "Tomei",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://gitlab.com/tomei-package/rental/issues"
-  },
-  "homepage": "https://gitlab.com/tomei-package/rental#readme",
-  "devDependencies": {
-    "@commitlint/cli": "^19.6.0",
-    "@commitlint/config-conventional": "^19.6.0",
-    "@eslint/js": "^9.15.0",
-    "@tsconfig/node18": "^18.2.4",
-    "@types/jest": "^29.5.14",
-    "@types/luxon": "^3.4.2",
-    "@types/node": "^22.10.0",
-    "@types/validator": "^13.12.2",
-    "@typescript-eslint/eslint-plugin": "^8.16.0",
-    "dotenv": "^16.4.5",
-    "eslint": "^9.15.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "globals": "^15.12.0",
-    "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "jest-mock-extended": "^3.0.7",
-    "lint-staged": "^15.2.10",
-    "prettier": "^3.4.1",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "tsc-watch": "^6.2.1",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.7.2",
-    "typescript-eslint": "^8.16.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "@tomei/activity-history": "^0.2.23",
-    "@tomei/config": "^0.3.21",
-    "@tomei/general": "^0.21.3",
-    "@tomei/sso": "^0.51.6",
-    "luxon": "^3.5.0",
-    "reflect-metadata": "^0.2.2",
-    "sequelize": "^6.37.5",
-    "sequelize-typescript": "^2.1.6"
-  },
-  "lint-staged": {
-    "*/**/*.{js,ts,tsx}": [
-      "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-      "eslint \"{src,apps,libs,test}/**/*.ts\" --fix"
-    ]
-  }
-}
+{
+  "name": "@tomei/rental",
+  "version": "0.13.0",
+  "description": "Tomei Rental Package",
+  "main": "dist/index.js",
+  "scripts": {
+    "start:dev": "tsc -w",
+    "build": "tsc",
+    "prepare": "husky install",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "npx eslint . --fix",
+    "test": "jest --forceExit --detectOpenHandles"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.com/tomei-package/rental.git"
+  },
+  "keywords": [
+    "tomei",
+    "rental"
+  ],
+  "author": "Tomei",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://gitlab.com/tomei-package/rental/issues"
+  },
+  "homepage": "https://gitlab.com/tomei-package/rental#readme",
+  "devDependencies": {
+    "@commitlint/cli": "^19.6.0",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@eslint/js": "^9.15.0",
+    "@tsconfig/node18": "^18.2.4",
+    "@types/jest": "^29.5.14",
+    "@types/luxon": "^3.4.2",
+    "@types/node": "^22.10.0",
+    "@types/validator": "^13.12.2",
+    "@typescript-eslint/eslint-plugin": "^8.16.0",
+    "dotenv": "^16.4.5",
+    "eslint": "^9.15.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^15.12.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.7",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.4.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^6.2.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.16.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@tomei/activity-history": "^0.2.23",
+    "@tomei/config": "^0.3.21",
+    "@tomei/general": "^0.21.3",
+    "@tomei/sso": "^0.51.6",
+    "luxon": "^3.5.0",
+    "reflect-metadata": "^0.2.2",
+    "sequelize": "^6.37.5",
+    "sequelize-typescript": "^2.1.6"
+  },
+  "lint-staged": {
+    "*/**/*.{js,ts,tsx}": [
+      "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+      "eslint \"{src,apps,libs,test}/**/*.ts\" --fix"
+    ]
+  }
+}

package/sonar-project.properties

@@ -1,13 +1,13 @@
-sonar.projectKey=all-tomei-projects_rental
-sonar.organization=all-tomei-projects
-
-# This is the name and version displayed in the SonarCloud UI.
-#sonar.projectName=Rental
-#sonar.projectVersion=1.0
-
-
-# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
-#sonar.sources=.
-
-# Encoding of the source code. Default is default system encoding
+sonar.projectKey=all-tomei-projects_rental
+sonar.organization=all-tomei-projects
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=Rental
+#sonar.projectVersion=1.0
+
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+#sonar.sources=.
+
+# Encoding of the source code. Default is default system encoding
 #sonar.sourceEncoding=UTF-8

package/src/components/agreement/agreement.repository.ts

@@ -1,54 +1,54 @@
-import { RepositoryBase, IRepositoryBase } from '@tomei/general';
-import { AgreementModel } from '../../models/agreement.entity';
-
-export class AgreementRepository
-  extends RepositoryBase<AgreementModel>
-  implements IRepositoryBase<AgreementModel>
-{
-  constructor() {
-    super(AgreementModel);
-  }
-
-  async findByPk(
-    id: string,
-    transaction?: any,
-  ): Promise<AgreementModel | null> {
-    try {
-      const result = await AgreementModel.findByPk(id, {
-        transaction: transaction,
-      });
-
-      return result;
-    } catch (error) {
-      throw new Error(`An Error occured when fetching : ${error.message}`);
-    }
-  }
-
-  async delete(AgreementNo: string, dbTransaction?: any) {
-    try {
-      const options = {
-        where: {
-          AgreementNo,
-        },
-        transaction: dbTransaction,
-      };
-      await AgreementModel.destroy(options);
-    } catch (error) {
-      throw new Error(`An Error occured when delete : ${error.message}`);
-    }
-  }
-
-  async findAndCountAll(options?: any) {
-    try {
-      let Agreements: any;
-      if (options) {
-        Agreements = await AgreementModel.findAndCountAll(options);
-      } else {
-        Agreements = await AgreementModel.findAndCountAll();
-      }
-      return Agreements;
-    } catch (error) {
-      throw new Error(`An Error occured when retriving : ${error.message}`);
-    }
-  }
-}
+import { RepositoryBase, IRepositoryBase } from '@tomei/general';
+import { AgreementModel } from '../../models/agreement.entity';
+
+export class AgreementRepository
+  extends RepositoryBase<AgreementModel>
+  implements IRepositoryBase<AgreementModel>
+{
+  constructor() {
+    super(AgreementModel);
+  }
+
+  async findByPk(
+    id: string,
+    transaction?: any,
+  ): Promise<AgreementModel | null> {
+    try {
+      const result = await AgreementModel.findByPk(id, {
+        transaction: transaction,
+      });
+
+      return result;
+    } catch (error) {
+      throw new Error(`An Error occured when fetching : ${error.message}`);
+    }
+  }
+
+  async delete(AgreementNo: string, dbTransaction?: any) {
+    try {
+      const options = {
+        where: {
+          AgreementNo,
+        },
+        transaction: dbTransaction,
+      };
+      await AgreementModel.destroy(options);
+    } catch (error) {
+      throw new Error(`An Error occured when delete : ${error.message}`);
+    }
+  }
+
+  async findAndCountAll(options?: any) {
+    try {
+      let Agreements: any;
+      if (options) {
+        Agreements = await AgreementModel.findAndCountAll(options);
+      } else {
+        Agreements = await AgreementModel.findAndCountAll();
+      }
+      return Agreements;
+    } catch (error) {
+      throw new Error(`An Error occured when retriving : ${error.message}`);
+    }
+  }
+}

package/src/components/agreement/agreement.ts

@@ -1,49 +1,117 @@
-import { ObjectBase } from '@tomei/general';
-import { IAgreementAttr } from '../../interfaces/agreement-attr.interface';
-import { AgreementRepository } from './agreement.repository';
-import { AggrementStatusEnum } from '../../enum/aggrement-status.enum';
-
-export class Agreement extends ObjectBase {
-  ObjectId: string;
-  ObjectName: string;
-  ObjectType: string = 'Agreement';
-  TableName = 'rental_Agreement';
-  Status: AggrementStatusEnum;
-  DateSigned: Date;
-  MediaId: string;
-
-  private static _Repo = new AgreementRepository();
-
-  get AgreementNo(): string {
-    return this.ObjectId;
-  }
-
-  set AgreementNo(value: string) {
-    this.ObjectId = value;
-  }
-
-  protected constructor(agreementAttr?: IAgreementAttr) {
-    super();
-    if (agreementAttr) {
-      this.ObjectId = agreementAttr.AgreementNo;
-      this.Status = agreementAttr.Status;
-      this.DateSigned = agreementAttr.DateSigned;
-      this.MediaId = agreementAttr.MediaId;
-    }
-  }
-
-  public static async init(
-    agreementNo?: string,
-    dbTransaction?: any,
-  ): Promise<Agreement> {
-    try {
-      if (agreementNo) {
-        const agreement = await this._Repo.findByPk(agreementNo, dbTransaction);
-        return new Agreement(agreement?.get({ plain: true }));
-      }
-      return new Agreement();
-    } catch (error) {
-      throw error;
-    }
-  }
-}
+import { ClassError, ObjectBase } from '@tomei/general';
+import { AggrementStatusEnum } from '../../enum/aggrement-status.enum';
+import { IAgreementAttr } from '../../interfaces/agreement-attr.interface';
+import { AgreementRepository } from './agreement.repository';
+import { ApplicationConfig } from '@tomei/config';
+import { LoginUser } from '@tomei/sso';
+import { HirerSignatureRepository } from '../hirer-signature/hirer-signature.repository';
+import * as rentalDb from '../../database';
+import { QueryTypes } from 'sequelize';
+import { IResponseHirerSignature } from '../../interfaces/response-hirer-signature-attr.interface';
+
+export class Agreement extends ObjectBase {
+  ObjectId: string;
+  ObjectName: string;
+  ObjectType: string = 'Agreement';
+  TableName = 'rental_Agreement';
+  Status: AggrementStatusEnum;
+  DateSigned: Date;
+  MediaId: string;
+
+  private static _Repo = new AgreementRepository();
+  protected static _HirerSignatureRepo = new HirerSignatureRepository();
+
+  get AgreementNo(): string {
+    return this.ObjectId;
+  }
+
+  set AgreementNo(value: string) {
+    this.ObjectId = value;
+  }
+
+  protected constructor(agreementAttr?: IAgreementAttr) {
+    super();
+    if (agreementAttr) {
+      this.ObjectId = agreementAttr.AgreementNo;
+      this.Status = agreementAttr.Status;
+      this.DateSigned = agreementAttr.DateSigned;
+      this.MediaId = agreementAttr.MediaId;
+    }
+  }
+
+  public static async init(
+    agreementNo?: string,
+    dbTransaction?: any,
+  ): Promise<Agreement> {
+    try {
+      if (agreementNo) {
+        const agreement = await this._Repo.findByPk(agreementNo, dbTransaction);
+        return new Agreement(agreement?.get({ plain: true }));
+      }
+      return new Agreement();
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  public static async getSignatureList(
+    loginUser: LoginUser,
+    agreementNo: string,
+    dbTransaction: any,
+  ) {
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() by passing:
+      // SystemCode: "<get_from_app_config>"
+      // PrivilegeCode: "AGREEMENT_SIGNATURE_LIST"
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = loginUser.checkPrivileges(
+        systemCode,
+        'AGREEMENT_SIGNATURE_LIST',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Agreement',
+          'AgreementErrMsg01',
+          "You do not have 'AGREEMENT_SIGNATURE_LIST' privilege.",
+        );
+      }
+
+      // Part 2: Validation
+      // Make sure agreementNo exists, if not throw new ClassError by passing:
+      if (!agreementNo) {
+        throw new ClassError(
+          'AgreementNo',
+          'AgreementNoErrMsg01',
+          'AgreementNo is missing',
+        );
+      }
+
+      // Part 3: Retrieve Listing
+      const query = `
+      SELECT 
+          hs.*, 
+          c.FullName
+      FROM 
+         rental_HirerSignature hs
+      LEFT JOIN 
+          sdb_Customer c ON hs.CustomerId = c.CustomerId
+      WHERE 
+          hs.AgreementNo = '${agreementNo}'
+      `;
+
+      const db = rentalDb.getConnection();
+      const signatures: IResponseHirerSignature[] = await db.query(query, {
+        type: QueryTypes.SELECT,
+        transaction: dbTransaction,
+      });
+
+      // Part 4: Return the returned records.
+      return signatures;
+    } catch (error) {
+      throw error;
+    }
+  }
+}