@tomei/finance 0.2.11 → 0.2.13

package/migrations/finance-company-migration.js

@@ -0,0 +1,45 @@
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_Company', {
+      CompanyId: {
+        type: Sequelize.STRING(30),
+        primaryKey: true,
+        allowNull: false,
+      },
+      CompSystemCode: {
+        type: Sequelize.STRING(10),
+        allowNull: false,
+      },
+      CompSystemRefId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      AccSystemCode: {
+        type: Sequelize.STRING(10),
+        allowNull: false,
+      },
+      AccSystemRefId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      PostedToAccSystemYN: {
+        type: Sequelize.CHAR(1),
+        allowNull: false,
+      },
+      PostedById: {
+        type: Sequelize.STRING(30),
+        allowNull: true,
+      },
+      PostedDateTime: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_Company');
+  },
+};

package/migrations/finance-customer-migration.js

@@ -8,22 +8,40 @@ module.exports = {
         primaryKey: true,
         allowNull: false,
       },
-      SystemCode: {
+      CompanyId: {
         type: Sequelize.STRING(30),
         allowNull: false,
+        references: {
+          model: 'finance_Company',
+          key: 'CompanyId',
+        },
+        onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
       },
-      AccSystemCode: {
-        type: Sequelize.STRING(30),
+      CustSystemCode: {
+        type: Sequelize.STRING(10),
         allowNull: false,
       },
-      AccSystemCustomerId: {
+      CustSystemRefId: {
         type: Sequelize.STRING(30),
         allowNull: false,
       },
-      CustomerRefId: {
+      AccSystemRefId: {
         type: Sequelize.STRING(30),
         allowNull: false,
       },
+      PostedToAccSystemYN: {
+        type: Sequelize.CHAR(1),
+        allowNull: false,
+      },
+      PostedById: {
+        type: Sequelize.STRING(30),
+        allowNull: true,
+      },
+      PostedDateTime: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
     });
   },
 

package/migrations/finance-post-history-migration.js

@@ -0,0 +1,45 @@
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_PostHistory', {
+      PostId: {
+        type: Sequelize.STRING(30),
+        primaryKey: true,
+        allowNull: false,
+      },
+      DateTime: {
+        type: Sequelize.Date,
+        allowNull: false,
+      },
+      ItemId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      ItemType: {
+        type: Sequelize.STRING(200),
+        allowNull: false,
+      },
+      ItemValue: {
+        type: Sequelize.JSON(),
+        allowNull: false,
+      },
+      PostedById: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      AccSystemCode: {
+        type: Sequelize.STRING(10),
+        allowNull: false,
+      },
+      AccSystemRefId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_PostHistory');
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.2.11",
+  "version": "0.2.13",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {
@@ -34,7 +34,7 @@
     "@nestjs/core": "^9.0.8",
     "@nestjs/platform-express": "^9.0.8",
     "@nestjs/sequelize": "^9.0.0",
-    "@tomei/general": "^0.0.14",
+    "@tomei/general": "^0.0.24",
     "@tomei/media": "^0.4.0",
     "axios": "^1.1.3",
     "class-transformer": "^0.5.1",

package/src/account/account.ts

@@ -2,34 +2,24 @@ import { IAccountRepository } from './interfaces/account.repository.interface';
 import { AccountModel } from './entities/account.entity';
 import { ObjectBase, LoginUserBase, RecordNotFoundError } from '@tomei/general';
 import { IBaseRepository } from '@tomei/general/dist/interfaces/repository.base.interface';
-import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
+import { AccountSystemEntity } from '../account-system-entity';
 export class Account extends AccountSystemEntity {
   protected BaseRepository;
   ObjectId: string;
   ObjectName: string;
 
-  /*todo:remove when ObjectBase updated.*/
-  get objectId(): string {
-    return '';
-  }
-
-  /*todo:remove when ObjectBase updated.*/
-  get objectName(): string {
-    return '';
-  }
   accountRepository: IAccountRepository;
   AccountNo: string;
   Owner: LoginUserBase;
   RelatedObject: ObjectBase;
   TableName: string;
-
   private isNewRecord = true;
   private OwnerId: string;
   private OwnerType: string;
   private RelatedObjectId: string;
   private RelatedObjectType: string;
   private ParentAccountNo: string;
-  AccSystemRefId: string;
+
 
   SystemCode: string;
   AccSystemCode: string;
@@ -37,9 +27,8 @@ export class Account extends AccountSystemEntity {
   Description: string;
   AccountType: string;
   AccountSubtype: string;
-  PostedToAccSystemYN: 'N';
-  PostedById: string;
-  PostedDateTime: Date;
+
+
 
   CreatedAt: Date;
   CreatedById: string;

package/src/account-system-entity/account-system-entity.ts

@@ -1,30 +1,100 @@
 import { IBaseRepository, LoginUserBase, ObjectBase } from '@tomei/general';
-// import { FinanceCompany } from '../finance-company';
+import { FinanceCompany } from '../finance-company';
+import { PostHistoryRepository } from './post-history.repository';
+import cuid from 'cuid';
 
 export abstract class AccountSystemEntity extends ObjectBase {
-  CompanyId = '';
-  PostedToAccSystemYN = 'N';
-  AccSystemRefId = '';
-  PostedById = '';
-  PostedDateTime: Date;
+  private _CompanyId = 'New';
+  private _PostedToAccSystemYN = 'N';
+  private _AccSystemRefId = '';
+  private _PostedById = '';
+  private _PostedDateTime: Date;
+  protected abstract BaseRepository: IBaseRepository<any>;
+  private static PostHistoryRepository = new PostHistoryRepository();
 
-  protected abstract BaseRepository: IBaseRepository;
+  get CompanyId(): string {
+    return this._CompanyId;
+  }
+
+  /*todo:verify if protected is correct instead of private*/
+  protected set CompanyId(value: string) {
+    this._CompanyId = value;
+  }
+
+  get PostedToAccSystemYN(): string {
+    return this._PostedToAccSystemYN;
+  }
+
+  set PostedToAccSystemYN(value: string) {
+    this._PostedToAccSystemYN = value;
+  }
+
+  get AccSystemRefId(): string {
+    return this._AccSystemRefId;
+  }
+
+  set AccSystemRefId(value: string) {
+    this._AccSystemRefId = value;
+  }
+
+  get PostedById(): string {
+    return this._PostedById;
+  }
+
+  set PostedById(value: string) {
+    this._PostedById = value;
+  }
 
-  postToAccSystem(dbTransaction: any, loginUser: LoginUserBase) {
+  get PostedDateTime(): Date {
+    return this._PostedDateTime;
+  }
+
+  set PostedDateTime(value: Date) {
+    this._PostedDateTime = value;
+  }
+
+  async postToAccSystem(dbTransaction: any, loginUser: LoginUserBase) {
     try {
       /*retrieve the finance company details from finance_Company to
        * get details of the accounting system*/
+      const company = FinanceCompany.getFinanceCompany(this.CompanyId);
 
-      /*instantiating the appropriate accounting system to perform the post*/
+      /*todo:instantiating the appropriate accounting system to perform the post*/
+      // if (this.TableName === 'finance_Customer') {
+      //   await this.AccountingSystem.createCustomer();
+      // }
 
       /*setting the posted fields*/
-      this.PostedToAccSystemYN = 'Y';
-      this.PostedById = loginUser.ObjectId;
-      this.PostedDateTime = new Date();
+      this._PostedToAccSystemYN = 'Y';
+      this._PostedById = loginUser.ObjectId;
+      this._PostedDateTime = new Date();
+
       /*updating the posted fields to the table either using direct
        * SQL or BaseRepository*/
+      const entity = await this.BaseRepository.findByPk(this.ObjectId);
+      const updated = await entity.update(
+        {
+          PostedToAccSystemYN: this._PostedToAccSystemYN,
+          PostedById: this._PostedById,
+          PostedDateTime: this._PostedDateTime,
+        },
+        { transaction: dbTransaction },
+      );
 
       /*writing to accounting transaction log table finance_PostHistory*/
+      await AccountSystemEntity.PostHistoryRepository.create(
+        {
+          PostId: cuid(),
+          DateTime: this._PostedDateTime,
+          ItemId: this.ObjectId,
+          ItemType: this.TableName,
+          ItemValue: JSON.stringify(updated),
+          PostedById: this._PostedById,
+          AccSystemCode: company.AccSystemCode,
+          AccSystemRefId: this._AccSystemRefId,
+        },
+        { transaction: dbTransaction },
+      );
     } catch (err) {
       throw err;
     }

package/src/account-system-entity/index.ts

@@ -0,0 +1,3 @@
+import { AccountSystemEntity } from './account-system-entity';
+
+export { AccountSystemEntity };

package/src/account-system-entity/post-history.entity.ts

@@ -0,0 +1,41 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Column, DataType, Model, Table } from 'sequelize-typescript';
+
+@Table({ tableName: 'finance_PostHistory', createdAt: false, updatedAt: false })
+export class FinancePostHistoryModel extends Model {
+  @ApiProperty({ type: String, description: 'PostId' })
+  @Column({
+    primaryKey: true,
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  PostId: string;
+
+  @ApiProperty({ type: Date })
+  @Column({ allowNull: false, type: DataType.DATE })
+  DateTime: Date;
+
+  @ApiProperty({ type: String, description: 'ItemId' })
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  ItemId: string;
+
+  @ApiProperty({ type: String, description: 'ItemType' })
+  @Column({ allowNull: false, type: DataType.STRING(200) })
+  ItemType: string;
+
+  @ApiProperty({ type: String, description: 'ItemValue' })
+  @Column({ allowNull: false, type: DataType.JSON })
+  ItemValue: string;
+
+  @ApiProperty()
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  PostedById: string;
+
+  @ApiProperty()
+  @Column({ allowNull: false, type: DataType.STRING(10) })
+  AccSystemCode: string;
+
+  @ApiProperty()
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  AccSystemRefId: string;
+}

package/src/account-system-entity/post-history.repository.ts

@@ -0,0 +1,12 @@
+import { BaseRepository, IBaseRepository } from '@tomei/general';
+import { FinancePostHistoryModel } from './post-history.entity';
+
+export class PostHistoryRepository
+  extends BaseRepository<FinancePostHistoryModel>
+  implements IBaseRepository<FinancePostHistoryModel>
+{
+  constructor() {
+    const postHistoryModel = new FinancePostHistoryModel();
+    super(postHistoryModel);
+  }
+}

package/src/customer/customer.ts

@@ -1,44 +1,58 @@
-import { IAddress, LoginUserBase, RecordNotFoundError } from '@tomei/general';
+import {
+  IAddress,
+  IPerson,
+  LoginUserBase,
+  RecordNotFoundError,
+} from '@tomei/general';
+import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
 import { FinanceCustomerModel } from './entities/customer.entity';
 import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
+export abstract class Customer extends AccountSystemEntity implements IPerson {
+  abstract FullName: string;
+  abstract IDNo: string;
+  abstract IDType: string;
+  abstract ContactNo: string;
+  abstract Email: string;
+  abstract DefaultAddress: IAddress;
 
-export abstract class Customer extends LoginUserBase {
-  FullName: string;
-  IDNo: string;
-  IDType: string;
-  ContactNo: string;
-  Email: string;
-  DefaultAddress: IAddress;
+  // note: getDetails from spec is void type. Meaning that this probably needed a fix soon
+  async getDetails(): Promise<{
+    FullName: string;
+    IDNo: string;
+    IDType: string;
+    Email: string;
+    ContactNo: string;
+  }> {
+    return {
+      FullName: this.FullName,
+      IDNo: this.IDNo,
+      IDType: this.IDType,
+      Email: this.Email,
+      ContactNo: this.ContactNo,
+    };
+  }
 
   financeCustomerRepository: IFinanceCustomerRepository;
 
   CustomerId: string;
-
-  SystemCode: string;
-  AccSystemCode: string;
-  AccSystemCustomerId: string; // customer id return from accounting system
   CustSystemCode: string;
   CustSystemRefId: string;
 
   constructor(
-    systemCode: string,
-    accSystemCode: string,
+    sFinanceCompanyId: string,
     custSystemCode: string,
     custSystemRefId: string,
   ) {
     super();
     const financeCustomerData = this.financeCustomerRepository.findOne({
       where: {
-        SystemCode: systemCode,
-        AccSystemCode: accSystemCode,
-        AccSystemCustomerId: custSystemCode,
-        CustomerRefId: custSystemRefId,
+        CompanyId: sFinanceCompanyId,
+        CustSystemCode: custSystemCode,
+        CustSystemRefId: custSystemRefId,
       },
     });
     if (financeCustomerData) {
-      this.CustomerId = financeCustomerData.CustomerId;
-      this.AccSystemCode = accSystemCode;
-      this.AccSystemCustomerId = financeCustomerData.AccSystemCustomerId;
+      this.CompanyId = sFinanceCompanyId;
       this.CustSystemCode = custSystemCode;
       this.CustSystemRefId = custSystemRefId;
     } else {
@@ -50,7 +64,7 @@ export abstract class Customer extends LoginUserBase {
   /*
    * Get the billing address for a person.
    **/
-  abstract getBilligAddress(): Promise<IAddress>;
+  abstract getBillingAddress(): Promise<IAddress>;
 
   init(person: LoginUserBase) {
     this.FullName = person.FullName;
@@ -68,10 +82,8 @@ export abstract class Customer extends LoginUserBase {
     const data = await this.financeCustomerRepository.create(
       {
         CustomerId: customerId,
-        SystemCode: this.SystemCode,
-        AccSystemCode: this.SystemCode,
-        AccSystemCustomerId: this.AccSystemCustomerId,
-        CustomerRefId: this.CustSystemRefId,
+        CustSystemCode: this.CustSystemCode,
+        CustSystemRefId: this.CustSystemRefId,
       },
       dbTransaction,
     );

package/src/customer/entities/customer.entity.ts

@@ -1,5 +1,13 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { Column, DataType, Model, Table } from 'sequelize-typescript';
+import {
+  ForeignKey,
+  BelongsTo,
+  Column,
+  DataType,
+  Model,
+  Table,
+} from 'sequelize-typescript';
+import { FinanceCompanyModel } from '../../finance-company/entities/finance-company.entity';
 
 @Table({ tableName: 'finance_Customer', createdAt: false, updatedAt: false })
 export class FinanceCustomerModel extends Model {
@@ -11,43 +19,75 @@ export class FinanceCustomerModel extends Model {
   })
   CustomerId: string;
 
+  @ApiProperty({ type: String, description: 'CompanyId' })
+  @ForeignKey(() => FinanceCompanyModel)
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  CompanyId: string;
+
   @ApiProperty({
     type: String,
-    description: 'System Code eg. "EZC", "CRM"',
+    description: 'Cust System Code eg. "EZC", "CRM"',
   })
   @Column({
     allowNull: false,
-    type: DataType.STRING(30),
+    type: DataType.STRING(10),
   })
-  SystemCode: string;
+  CustSystemCode: string;
 
   @ApiProperty({
     type: String,
-    description: 'Account System Code eg. "EZC", "CRM"',
+    description: 'CustSystemRefId',
   })
   @Column({
     allowNull: false,
     type: DataType.STRING(30),
   })
-  AccSystemCode: string;
+  CustSystemRefId: string;
 
   @ApiProperty({
     type: String,
-    description: 'Account Customer Id in Api',
+    description: 'Account Customer Id in API',
   })
   @Column({
     allowNull: false,
     type: DataType.STRING(30),
   })
-  AccSystemCustomerId: string;
+  AccSystemRefId: string;
 
   @ApiProperty({
     type: String,
-    description: 'Custoemr Ref Id',
+    description: 'PostedToAccSystemYN',
+    example: 'Y',
   })
   @Column({
     allowNull: false,
+    type: DataType.CHAR(1),
+  })
+  PostedToAccSystemYN: string;
+
+  @ApiProperty({
+    example: '138140891dd211b288d34bc7b4312a49',
+    description: 'PostedById',
+  })
+  @Column({
+    allowNull: true,
     type: DataType.STRING(30),
   })
-  CustomerRefId: string;
+  PostedById: string;
+
+  @ApiProperty({
+    example: new Date(),
+    description: 'PostedToAccSystem Date',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.DATE,
+  })
+  PostedDateTime: Date;
+
+  @BelongsTo(() => FinanceCompanyModel)
+  FinanceCompany: FinanceCompanyModel;
 }

package/src/customer/index.ts

@@ -1,15 +1,15 @@
+import { Customer } from './customer';
 import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
 import { IFinanceCustomerAttr } from './interfaces/finance-customer-attr.interface';
 import { FinanceCustomerModel } from './entities/customer.entity';
 import { ICustomerRepository } from './interfaces/customer.repository.interface';
 import { FinanceCustomerRepository } from './finance-customer.repository';
-import { Customer } from './customer';
 
 export {
+  Customer,
   IFinanceCustomerRepository,
   IFinanceCustomerAttr,
   FinanceCustomerModel,
   ICustomerRepository,
   FinanceCustomerRepository,
-  Customer,
 };

package/src/customer/interfaces/finance-customer-attr.interface.ts

@@ -1,4 +1,10 @@
 export interface IFinanceCustomerAttr {
   CustomerId: string;
-  AccSystemId: string;
+  CompanyId: string;
+  CustSystemCode: string;
+  CustSystemRefId: string;
+  AccSystemRefId: string;
+  PostedToAccSystemYN: string;
+  PostedById: string;
+  PostedDateTime?: Date;
 }

package/src/document/document.ts

@@ -8,12 +8,12 @@ import {
   CommonService as MediaCommonService,
   MediaType,
 } from '@tomei/media';
-import { DocumentStatus, DocType } from 'src/enum';
+import { DocumentStatus, DocType } from '../enum';
 import { DocumentRepository } from './document.repository';
 import { IDocumentAttr } from './interfaces/document-attr.interface';
 import { DocumentItemRepository } from './document-item.repository';
 import { DocumentItem } from './document-item';
-import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
+import { AccountSystemEntity } from '../account-system-entity';
 
 export class Document extends AccountSystemEntity {
   protected BaseRepository: IBaseRepository;
@@ -31,10 +31,6 @@ export class Document extends AccountSystemEntity {
   IssuedToId: string;
   IssuedToType: string;
   AccSystemCode: string;
-  PostedToAccSystemYN = 'N';
-  PostedById: string;
-  PostedDateTime: Date;
-  AccSystemRefId: string;
   UseAccSystemDocYN: string;
   private DocHTMLFilePath: string;
   private DocPDFFilePath: string;