@tomei/rental 0.1.2 → 0.2.1

package/package.json

@@ -1,67 +1,71 @@
-{
-  "name": "@tomei/rental",
-  "version": "0.1.2",
-  "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": "^17.6.3",
-    "@commitlint/config-conventional": "^17.6.3",
-    "@tsconfig/node18": "^2.0.1",
-    "@types/jest": "^29.5.2",
-    "@types/node": "^18.17.12",
-    "@types/validator": "^13.11.1",
-    "@typescript-eslint/eslint-plugin": "^5.33.0",
-    "dotenv": "^16.1.4",
-    "eslint": "^8.40.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.3",
-    "jest": "^29.5.0",
-    "jest-mock-extended": "^3.0.4",
-    "lint-staged": "^13.2.2",
-    "prettier": "^2.7.1",
-    "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
-    "tsc-watch": "^5.0.3",
-    "tsconfig-paths": "^4.0.0",
-    "tslint": "^6.1.3",
-    "typescript": "^4.7.4"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "reflect-metadata": "^0.1.13",
-    "sequelize": "^6.32.1",
-    "sequelize-typescript": "^2.1.5",
-    "cuid": "^3.0.0"
-  },
-  "lint-staged": {
-    "*/**/*.{js,ts,tsx}": [
-      "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-      "eslint \"{src,apps,libs,test}/**/*.ts\" --fix"
-    ]
-  }
-}
+{
+  "name": "@tomei/rental",
+  "version": "0.2.1",
+  "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": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
+    "@tsconfig/node18": "^2.0.1",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^18.17.12",
+    "@types/validator": "^13.11.1",
+    "@typescript-eslint/eslint-plugin": "^5.33.0",
+    "dotenv": "^16.1.4",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "jest": "^29.5.0",
+    "jest-mock-extended": "^3.0.4",
+    "lint-staged": "^13.2.2",
+    "prettier": "^2.7.1",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "tsc-watch": "^5.0.3",
+    "tsconfig-paths": "^4.0.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.7.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "cuid": "^3.0.0",
+    "reflect-metadata": "^0.1.13",
+    "sequelize": "^6.32.1",
+    "sequelize-typescript": "^2.1.5",
+    "@tomei/activity-history": "^0.2.1",
+    "@tomei/config": "^0.2.2",
+    "@tomei/general": "^0.5.1",
+    "@tomei/sso": "^0.11.6"
+  },
+  "lint-staged": {
+    "*/**/*.{js,ts,tsx}": [
+      "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+      "eslint \"{src,apps,libs,test}/**/*.ts\" --fix"
+    ]
+  }
+}

package/src/components/rental/rental.repository.ts

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

package/src/components/rental/rental.ts

@@ -0,0 +1,289 @@
+import { IRentalAttr } from '../../interfaces/rental-attr.interface';
+import { RentalStatusEnum } from '../../enum/rental-status.enum';
+import { RentalRepository } from './rental.repository';
+import { ClassError } from '@tomei/general';
+import { ApplicationConfig } from '@tomei/config';
+import { LoginUser } from '@tomei/sso';
+import { RentalPrice } from '../rental-price/rental-price';
+import * as cuid from 'cuid';
+import { Op } from 'sequelize';
+import { ActionEnum, Activity } from '@tomei/activity-history';
+import { IRentalFindAllSearchAttr } from '../../interfaces/rental-find-all-search-attr.interface';
+
+export class Rental {
+  RentalId: string;
+  CustomerId: string;
+  CustomerType: string;
+  ItemId: string;
+  ItemType: string;
+  PriceId: string;
+  StartDateTime: Date;
+  EndDateTime: Date;
+  CancelRemarks: string;
+  TerminateRemarks: string;
+  AgreementNo: string;
+  private _Status: RentalStatusEnum;
+  private _EscheatmentYN: string = 'N';
+  private _CreatedById: string;
+  private _CreatedAt: Date;
+  private _UpdatedById: string;
+  private _UpdatedAt: Date;
+  private static _Repo = new RentalRepository();
+
+  get Status(): RentalStatusEnum {
+    return this._Status;
+  }
+
+  get EscheatmentYN(): string {
+    return this._EscheatmentYN;
+  }
+
+  get CreatedById(): string {
+    return this._CreatedById;
+  }
+
+  get CreatedAt(): Date {
+    return this._CreatedAt;
+  }
+
+  get UpdatedById(): string {
+    return this._UpdatedById;
+  }
+
+  get UpdatedAt(): Date {
+    return this._UpdatedAt;
+  }
+
+  private constructor(rentalAttr?: IRentalAttr) {
+    if (rentalAttr) {
+      this.RentalId = rentalAttr.RentalId;
+      this.CustomerId = rentalAttr.CustomerId;
+      this.CustomerType = rentalAttr.CustomerType;
+      this.ItemId = rentalAttr.ItemId;
+      this.ItemType = rentalAttr.ItemType;
+      this.PriceId = rentalAttr.PriceId;
+      this.StartDateTime = rentalAttr.StartDateTime;
+      this.EndDateTime = rentalAttr.EndDateTime;
+      this.CancelRemarks = rentalAttr.CancelRemarks;
+      this.TerminateRemarks = rentalAttr.TerminateRemarks;
+      this.AgreementNo = rentalAttr.AgreementNo;
+      this._Status = rentalAttr.Status;
+      this._EscheatmentYN = rentalAttr.EscheatmentYN;
+      this._CreatedById = rentalAttr.CreatedById;
+      this._CreatedAt = rentalAttr.CreatedAt;
+      this._UpdatedById = rentalAttr.UpdatedById;
+      this._UpdatedAt = rentalAttr.UpdatedAt;
+    }
+  }
+
+  public static async init(dbTransaction?: any, rentalId?: string) {
+    try {
+      if (rentalId) {
+        const rental = await Rental._Repo.findByPk(rentalId, dbTransaction);
+        if (rental) {
+          return new Rental(rental);
+        } else {
+          throw new ClassError('Rental', 'RentalErrMsg', 'Rental Not Found');
+        }
+      }
+      return new Rental();
+    } catch (error) {
+      throw new ClassError(
+        'Rental',
+        'RentalErrMsg',
+        'Failed To Initialize Price',
+      );
+    }
+  }
+
+  public async create(
+    rentalPrice: RentalPrice,
+    loginUser: LoginUser,
+    dbTransaction?: any,
+  ) {
+    try {
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'Rental - Create',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'RentalPrice',
+          'RentalPriceErrMsg',
+          'You do not have the privilege.',
+        );
+      }
+
+      const isItemAvailable = await this.isItemAvailable(
+        this.ItemId,
+        this.ItemType,
+        this.StartDateTime,
+        this.EndDateTime,
+        dbTransaction,
+      );
+
+      if (!isItemAvailable) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg02',
+          'Rental Item is not available at current date.',
+        );
+      }
+
+      await rentalPrice.create(loginUser, dbTransaction);
+
+      this.PriceId = rentalPrice.PriceId;
+
+      this.RentalId = cuid();
+      this._Status = RentalStatusEnum.ACTIVE;
+      this._CreatedById = loginUser.ObjectId;
+      this._UpdatedById = loginUser.ObjectId;
+      this._CreatedAt = new Date();
+      this._UpdatedAt = new Date();
+
+      const data = {
+        RentalId: this.RentalId,
+        CustomerId: this.CustomerId,
+        CustomerType: this.CustomerType,
+        ItemId: this.ItemId,
+        ItemType: this.ItemType,
+        PriceId: this.PriceId,
+        StartDateTime: this.StartDateTime,
+        EndDateTime: this.EndDateTime,
+        CancelRemarks: this.CancelRemarks,
+        TerminateRemarks: this.TerminateRemarks,
+        AgreementNo: this.AgreementNo,
+        Status: this.Status,
+        EscheatmentYN: this.EscheatmentYN,
+        CreatedById: this.CreatedById,
+        CreatedAt: this.CreatedAt,
+        UpdatedById: this.UpdatedById,
+        UpdatedAt: this.UpdatedAt,
+      };
+
+      await Rental._Repo.create(data, dbTransaction);
+
+      const activity = new Activity();
+      activity.ActivityId = cuid();
+      activity.Action = ActionEnum.ADD;
+      activity.Description = 'Add Rental';
+      activity.EntityType = 'Rental';
+      activity.EntityId = this.RentalId;
+      activity.EntityValueBefore = JSON.stringify({});
+      activity.EntityValueAfter = JSON.stringify(data);
+      await activity.create(loginUser, dbTransaction);
+
+      return this;
+    } catch (error) {
+      throw new ClassError(
+        'RentalPrice',
+        'RentalPriceErrMsg',
+        'Failed To Create RentalPrice',
+      );
+    }
+  }
+
+  async isItemAvailable(
+    itemId: string,
+    itemType: string,
+    startDateTime: Date,
+    endDateTime: Date,
+    dbTransaction?: any,
+  ) {
+    try {
+      const item = await Rental._Repo.findOne({
+        where: {
+          ItemId: itemId,
+          ItemType: itemType,
+          StartDateTime: {
+            [Op.lte]: endDateTime,
+          },
+          EndDateTime: {
+            [Op.gte]: startDateTime,
+          },
+        },
+        transaction: dbTransaction,
+      });
+
+      if (item) {
+        return false;
+      } else {
+        return true;
+      }
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  public static async findAll(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    page?: number,
+    row?: number,
+    search?: IRentalFindAllSearchAttr,
+  ) {
+    try {
+      const systemCode = await ApplicationConfig.getComponentConfigValue(
+        'system-code',
+      );
+
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'Rental - View',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg',
+          'You do not have the privilege.',
+        );
+      }
+
+      const queryObj: any = {};
+
+      let options: any = {
+        transaction: dbTransaction,
+      };
+
+      if (page && row) {
+        options = {
+          ...options,
+          limit: row,
+          offset: row * (page - 1),
+          order: [['CreatedAt', 'DESC']],
+        };
+      }
+
+      if (search) {
+        Object.entries(search).forEach(([key, value]) => {
+          if (key === 'StartDateTime') {
+            queryObj[key] = {
+              [Op.eq]: value,
+            };
+          } else if (key === 'EndDateTime') {
+            queryObj[key] = {
+              [Op.eq]: value,
+            };
+          } else {
+            queryObj[key] = {
+              [Op.substring]: value,
+            };
+          }
+        });
+
+        options = {
+          ...options,
+          where: queryObj,
+        };
+      }
+
+      return await Rental._Repo.findAndCountAll(options);
+    } catch (err) {
+      throw err;
+    }
+  }
+}

package/src/components/rental-price/rental-price.repository.ts

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

package/src/components/rental-price/rental-price.ts

@@ -0,0 +1,89 @@
+import { ClassError } from '@tomei/general';
+import { RentalPriceRepository } from './rental-price.repository';
+import { IRentalPriceAttr } from '../../interfaces/rental-price-attr.interface';
+import { LoginUser } from '@tomei/sso';
+import { ApplicationConfig } from '@tomei/config';
+import * as cuid from 'cuid';
+
+export class RentalPrice {
+  PriceId: string;
+  RetailPrice: number;
+  Currency: string;
+  PromoCode: string;
+  Remarks: string;
+
+  private static _Repo = new RentalPriceRepository();
+
+  private constructor(rentalPriceAttr?: IRentalPriceAttr) {
+    if (rentalPriceAttr) {
+      this.PriceId = rentalPriceAttr.PriceId;
+      this.RetailPrice = rentalPriceAttr.RetailPrice;
+      this.Currency = rentalPriceAttr.Currency;
+      this.PromoCode = rentalPriceAttr.PromoCode;
+      this.Remarks = rentalPriceAttr.Remarks;
+    }
+  }
+
+  public static async init(dbTransaction?: any, priceId?: string) {
+    try {
+      if (priceId) {
+        const rentalPrice = await RentalPrice._Repo.findByPk(
+          priceId,
+          dbTransaction,
+        );
+        if (rentalPrice) {
+          return new RentalPrice(rentalPrice);
+        } else {
+          throw new ClassError(
+            'RentalPrice',
+            'RentalPriceErrMsg',
+            'RentalPrice Not Found',
+          );
+        }
+      }
+      return new RentalPrice();
+    } catch (error) {
+      throw new ClassError(
+        'RentalPrice',
+        'RentalPriceErrMsg',
+        'Failed To Initialize RentalPrice',
+      );
+    }
+  }
+
+  public async create(loginUser: LoginUser, dbTransaction?: any) {
+    try {
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'Rental - Create',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'RentalPrice',
+          'RentalPriceErrMsg',
+          'You do not have the privilege.',
+        );
+      }
+
+      this.PriceId = cuid();
+
+      await RentalPrice._Repo.create(
+        {
+          PriceId: this.PriceId,
+          RetailPrice: this.RetailPrice,
+          Currency: this.Currency,
+          PromoCode: this.PromoCode,
+          Remarks: this.Remarks,
+        },
+        dbTransaction,
+      );
+
+      return this;
+    } catch (error) {
+      throw error;
+    }
+  }
+}

package/src/database.ts

@@ -1,15 +1,15 @@
-import { Sequelize, SequelizeOptions } from 'sequelize-typescript';
-
-let sequelize: Sequelize;
-
-function init(sequelizeOptions: SequelizeOptions) {
-  sequelize = new Sequelize(sequelizeOptions);
-
-  sequelize.addModels([__dirname + '/models']);
-}
-
-function getConnection() {
-  return sequelize;
-}
-
-export { init, getConnection };
+import { Sequelize, SequelizeOptions } from 'sequelize-typescript';
+
+let sequelize: Sequelize;
+
+function init(sequelizeOptions: SequelizeOptions) {
+  sequelize = new Sequelize(sequelizeOptions);
+
+  sequelize.addModels([__dirname + '/models']);
+}
+
+function getConnection() {
+  return sequelize;
+}
+
+export { init, getConnection };

package/src/enum/index.ts

@@ -0,0 +1,3 @@
+import { RentalStatusEnum } from './rental-status.enum';
+
+export { RentalStatusEnum };

package/src/enum/rental-status.enum.ts

@@ -0,0 +1,6 @@
+export enum RentalStatusEnum {
+  ACTIVE = 'Active',
+  SUSPENDED = 'Suspended',
+  CANCELLED = 'Cancelled',
+  TERMINATED = 'Terminated',
+}

package/src/index.ts

@@ -1 +1,16 @@
-export * as rentalDb from './database';
+import { RentalPriceRepository } from './components/rental-price/rental-price.repository';
+import { RentalRepository } from './components/rental/rental.repository';
+import { Rental } from './components/rental/rental';
+import { RentalPrice } from './components/rental-price/rental-price';
+import * as rentalDb from './database';
+export * from './interfaces';
+export * from './models';
+export * from './enum';
+
+export {
+  Rental,
+  RentalPrice,
+  RentalRepository,
+  RentalPriceRepository,
+  rentalDb,
+};

package/src/interfaces/index.ts

@@ -0,0 +1,5 @@
+import { IRentalAttr } from './rental-attr.interface';
+import { IRentalPriceAttr } from './rental-price-attr.interface';
+import { IRentalFindAllSearchAttr } from './rental-find-all-search-attr.interface';
+
+export { IRentalAttr, IRentalPriceAttr, IRentalFindAllSearchAttr };