@tomei/rental 0.6.4 → 0.7.0

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

@@ -0,0 +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}`);
+    }
+  }
+}

package/src/components/agreement/agreement.ts

@@ -0,0 +1,43 @@
+import { ObjectBase } from '@tomei/general';
+import { IAgreementAttr } from '../../interfaces/agreement-attr.interface';
+import { AgreementRepository } from './agreement.repository';
+
+export class Agreement extends ObjectBase {
+  ObjectId: string;
+  ObjectName: string;
+  ObjectType: string = 'Agreement';
+  TableName = 'rental_Agreement';
+  Status: 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;
+    }
+  }
+
+  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;
+    }
+  }
+}

package/src/components/rental/rental.ts

@@ -11,6 +11,7 @@ import { IRentalFindAllSearchAttr } from '../../interfaces/rental-find-all-searc
 import { RentalAccountTypeEnum } from '../../enum/account-type.enum';
 import { JointHirer } from '../joint-hirer/joint-hirer';
 import { JointHirerModel } from '../../models/joint-hirer.entity';
+import { AgreementRepository } from '../agreement/agreement.repository';
 
 export class Rental extends ObjectBase {
   ObjectId: string;
@@ -36,6 +37,7 @@ export class Rental extends ObjectBase {
   protected _UpdatedById: string;
   protected _UpdatedAt: Date;
   protected static _Repo = new RentalRepository();
+  protected static _AgreementRepo = new AgreementRepository();
 
   get RentalId(): string {
     return this.ObjectId;
@@ -167,7 +169,22 @@ export class Rental extends ObjectBase {
         );
       }
 
-      /*Part 3: Insert Rental & The Agreed Rental Price*/
+      // Part 3: Create Rental Agreement Record
+      // Call Rental._AgreementRepo create method by passing:
+      // AgreementNo: this.AgreementNo
+      // Status: "Not Generated"
+      // dbTransaction
+      await Rental._AgreementRepo.create(
+        {
+          AgreementNo: this.AgreementNo,
+          Status: 'Not Generated',
+        },
+        {
+          transaction: dbTransaction,
+        },
+      );
+
+      /*Part 4: Insert Rental & The Agreed Rental Price*/
       await rentalPrice.create(loginUser, dbTransaction);
 
       this.PriceId = rentalPrice.PriceId;
@@ -213,7 +230,7 @@ export class Rental extends ObjectBase {
         }
       }
 
-      /*Part 4: Record Create Rental Activity*/
+      /*Part 5: Record Create Rental Activity*/
       const activity = new Activity();
       activity.ActivityId = activity.createId();
       activity.Action = ActionEnum.ADD;
@@ -224,7 +241,7 @@ export class Rental extends ObjectBase {
       activity.EntityValueAfter = JSON.stringify(data);
       await activity.create(loginUser.ObjectId, dbTransaction);
 
-      /*Part 5: Return Result*/
+      /*Part 6: Return Result*/
       return this;
     } catch (error) {
       throw error;

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

@@ -26,4 +26,14 @@ export enum RentalStatusEnum {
    * Rental has been terminated by the customer.
    */
   TERMINATED = 'Terminated',
+
+  /**
+   * Customer is pending signing rental agreement
+   */
+  PENDING_SIGNING = 'Pending Signing',
+
+  /**
+   * Customer already signed and now needs to collect the rental key.
+   */
+  PENDING_KEY_COLLECTION = 'Pending Key Collection',
 }

package/src/index.ts

@@ -6,6 +6,8 @@ import { Booking } from './components/booking/booking';
 import { BookingRepository } from './components/booking/booking.repository';
 import { JointHirer } from './components/joint-hirer/joint-hirer';
 import { JointHirerRepository } from './components/joint-hirer/joint-hirer.repository';
+import { Agreement } from './components/agreement/agreement';
+import { AgreementRepository } from './components/agreement/agreement.repository';
 import * as rentalDb from './database';
 export * from './interfaces';
 export * from './models';
@@ -21,4 +23,6 @@ export {
   rentalDb,
   JointHirer,
   JointHirerRepository,
+  Agreement,
+  AgreementRepository,
 };

package/src/interfaces/agreement-attr.interface.ts

@@ -0,0 +1,4 @@
+export interface IAgreementAttr {
+  AgreementNo: string;
+  Status: string;
+}

package/src/interfaces/index.ts

@@ -2,10 +2,12 @@ import { IRentalAttr } from './rental-attr.interface';
 import { IRentalPriceAttr } from './rental-price-attr.interface';
 import { IRentalFindAllSearchAttr } from './rental-find-all-search-attr.interface';
 import { IBookingAttr } from './booking-attr.interface';
+import { IAgreementAttr } from './agreement-attr.interface';
 
 export {
   IRentalAttr,
   IRentalPriceAttr,
   IRentalFindAllSearchAttr,
   IBookingAttr,
+  IAgreementAttr,
 };

package/src/models/agreement.entity.ts

@@ -0,0 +1,26 @@
+import { Column, DataType, Table, Model, HasMany } from 'sequelize-typescript';
+import { RentalModel } from './rental.entity';
+
+@Table({
+  tableName: 'rental_Agreement',
+  createdAt: false,
+  updatedAt: false,
+  timestamps: false,
+})
+export class AgreementModel extends Model {
+  @Column({
+    primaryKey: true,
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  AgreementNo: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  Status: string;
+
+  @HasMany(() => RentalModel)
+  Rentals: RentalModel[];
+}

package/src/models/index.ts

@@ -2,5 +2,12 @@ import { RentalModel } from './rental.entity';
 import { RentalPriceModel } from './rental-price.entity';
 import { BookingModel } from './booking.entity';
 import { JointHirerModel } from './joint-hirer.entity';
+import { AgreementModel } from './agreement.entity';
 
-export { RentalModel, RentalPriceModel, BookingModel, JointHirerModel };
+export {
+  RentalModel,
+  RentalPriceModel,
+  BookingModel,
+  JointHirerModel,
+  AgreementModel,
+};

package/src/models/rental.entity.ts

@@ -13,6 +13,7 @@ import { RentalPriceModel } from './rental-price.entity';
 import { RentalStatusEnum } from '../enum/rental-status.enum';
 import { JointHirerModel } from './joint-hirer.entity';
 import { RentalAccountTypeEnum } from '../enum/account-type.enum';
+import { AgreementModel } from './agreement.entity';
 
 @Table({
   tableName: 'rental_Rental',
@@ -89,6 +90,7 @@ export class RentalModel extends Model {
   })
   EscheatmentYN: string;
 
+  @ForeignKey(() => AgreementModel)
   @Column({
     allowNull: false,
     unique: true,
@@ -123,6 +125,9 @@ export class RentalModel extends Model {
   @BelongsTo(() => RentalPriceModel)
   RentalPrice: RentalPriceModel;
 
+  @BelongsTo(() => AgreementModel)
+  Agreement: AgreementModel;
+
   @HasMany(() => JointHirerModel)
   JointHirers: JointHirerModel[];
 }

package/tsconfig.json

@@ -18,6 +18,6 @@
     "strictBindCallApply": false,
     "forceConsistentCasingInFileNames": false,
     "noFallthroughCasesInSwitch": false,
-    "strictNullChecks": true
+    "strictNullChecks": false,
   },
 }