@tomei/finance 0.1.0 → 0.1.2

package/migrations/finance-customer-migration.js

@@ -0,0 +1,21 @@
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_Customer', {
+      CustomerId: {
+        type: Sequelize.STRING(30),
+        primaryKey: true,
+        allowNull: false,
+      },
+      AccSystemId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_Customer');
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {
@@ -34,13 +34,13 @@
     "@nestjs/core": "^9.0.8",
     "@nestjs/platform-express": "^9.0.8",
     "@nestjs/sequelize": "^9.0.0",
+    "axios": "^1.1.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",
     "dotenv": "^16.0.3",
     "intuit-oauth": "^4.0.0",
     "sequelize-typescript": "^2.1.3",
-    "uniqid": "^5.4.0",
-    "axios": "^1.1.3"
+    "uniqid": "^5.4.0"
   },
   "devDependencies": {
     "@nestjs/swagger": "^6.0.4",
@@ -68,5 +68,8 @@
       "npm run build",
       "git add ."
     ]
+  },
+  "dependencies": {
+    "@tomei/general": "^0.0.7"
   }
 }

package/src/account/account.repository.ts

@@ -1,7 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { InjectModel } from '@nestjs/sequelize';
-import { BaseRepository } from '../base/base.repository.abstract';
 import { AccountModel } from './entities/account.entity';
+import { BaseRepository } from '@tomei/general';
 import {
   IAccountAttr,
   ICreateAccountAttr,

package/src/account/account.ts

@@ -1,8 +1,11 @@
-import { ObjectBase, OwnerBase } from 'src/base';
+import { RelatedObject, Owner } from '../base';
 import { ICreateAccountAttr } from './interfaces/account-attr.interface';
 import { IAccountRepository } from './interfaces/account.repository.interface';
-import { QuickBookClient } from '../quickbook-client';
 import * as uniqid from 'uniqid';
+import { AccountModel } from './entities/account.entity';
+import axios from 'axios';
+import { getConfig } from '../config';
+import { IAccountSystem } from 'src/interfaces';
 export class Account {
   accountRepository: IAccountRepository;
 
@@ -13,8 +16,8 @@ export class Account {
   private AccSystemId: string;
 
   ParentAccountNo: string;
-  Owner: OwnerBase;
-  RelatedObject: ObjectBase;
+  Owner: Owner;
+  RelatedObject: RelatedObject;
   AccountType: string;
   AccountSubType: string;
 
@@ -28,7 +31,7 @@ export class Account {
     params?: ICreateAccountAttr,
   ) {
     this.accountRepository = accountRepository;
-    this.AccSystemId = SysCode;
+    this.AccSystemId = getConfig().systemConfig[SysCode].accountingSystem;
     if (params) {
       this.init(params);
     }
@@ -43,10 +46,15 @@ export class Account {
     if (params.ParentAccountNo) {
       this.ParentAccountNo = params.ParentAccountNo;
     }
+
+    this.OwnerId = params.Owner.Id;
+    this.OwnerType = typeof params.Owner;
+    this.RelatedObjectId = params.RelatedObject.Id;
+    this.RelatedObjectType = typeof params.RelatedObject;
     this.isParamsInitialized = true;
   }
 
-  async create(userId: string, client: QuickBookClient, dbOptions: any) {
+  async create(userId: string, client: IAccountSystem, dbOptions: any) {
     try {
       if (!this.Owner || !this.RelatedObject) {
         throw new Error(
@@ -83,51 +91,33 @@ export class Account {
         );
       }
 
-      const companyId = client.getCompanyId();
-      const createAccountPayload = {
+      let createAccountPayload: any = {
         Name: this.Owner.FullName,
         AcctNum: uniqid(),
         AccountType: this.AccountType,
         AccountSubType: this.AccountSubType,
       };
-      const response = await client.callApi({
-        endpoint: `/v3/company/${companyId}/account`,
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/json',
-        },
-        body: JSON.stringify(createAccountPayload),
-      });
-
-      const data = response.json.Account;
 
       if (this.ParentAccountNo) {
-        const createChildAccountPayload = {
-          Id: data.Id,
+        createAccountPayload = {
+          ...createAccountPayload,
           CurrencyRef: 'MYR',
           ParentRef: this.ParentAccountNo,
           SubAccount: true,
         };
-
-        await client.callApi({
-          endpoint: `/v3/company/${companyId}/account`,
-          method: 'PUT',
-          headers: {
-            'Content-Type': 'application/json',
-          },
-          body: JSON.stringify(createChildAccountPayload),
-        });
       }
 
+      const data = await client.createAccount(createAccountPayload);
+
       const account = await this.accountRepository.create(
         {
           AccountNo: data.Id,
           SystemCode: this.AccSystemId,
           Name: data.AcctNum,
-          OwnerId: this.Owner.Id,
-          OwnerType: this.Owner.Type,
-          RelatedObjectId: this.RelatedObject.Id,
-          RelatedObjectType: this.RelatedObject.Type,
+          OwnerId: this.OwnerId,
+          OwnerType: this.OwnerType,
+          RelatedObjectId: this.RelatedObjectId,
+          RelatedObjectType: this.RelatedObjectType,
           CreatedAt: new Date(),
           CreatedById: userId,
           UpdatedAt: new Date(),
@@ -136,6 +126,23 @@ export class Account {
         dbOptions,
       );
 
+      const payload = {
+        Action: 'Create',
+        Activity: 'Account Created',
+        Description: `Account (ID: ${account.AccountNo}) has been created`,
+        EntityType: typeof AccountModel,
+        EntityValueBefore: JSON.stringify({}),
+        EntityValueAfter: JSON.stringify(account),
+        PerformedById: account.CreatedById,
+        PerformedAt: new Date(),
+        EntityId: account.AccountNo,
+      };
+
+      await axios.post(
+        `${process.env.COMMON_API_URL}/activity-histories`,
+        payload,
+      );
+
       return account;
     } catch (error) {
       throw error;

package/src/account/entities/account.entity.ts

@@ -6,11 +6,7 @@ import {
   Table,
   DataType,
   UpdatedAt,
-  AfterCreate,
 } from 'sequelize-typescript';
-import { ObjectBase, OwnerBase } from '../../base';
-import { QuickBookClient } from '../../quickbook-client';
-import axios from 'axios';
 
 @Table({ tableName: 'finance_Account', createdAt: false, updatedAt: false })
 export class AccountModel extends Model {
@@ -103,32 +99,4 @@ export class AccountModel extends Model {
   })
   @Column({ allowNull: false, type: DataType.STRING(30) })
   UpdatedById: string;
-
-  Owner: OwnerBase;
-  RelatedObject: ObjectBase;
-  QuickbookClient: QuickBookClient;
-
-  @AfterCreate
-  static async createActivityHistory(instance) {
-    const payload = {
-      Action: 'Create',
-      Activity: 'Account Created',
-      Description: `Account (ID: ${instance.AccountNo}) has been created`,
-      EntityType: typeof instance,
-      EntityValueBefore: JSON.stringify({}),
-      EntityValueAfter: JSON.stringify(instance),
-      PerformedById: instance.CreatedById,
-      PerformedAt: new Date(),
-      EntityId: instance.AccountNo,
-    };
-
-    try {
-      await axios.post(
-        `${process.env.COMMON_API_URL}/activity-histories`,
-        payload,
-      );
-    } catch (error) {
-      throw error;
-    }
-  }
 }

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

@@ -1,4 +1,4 @@
-import { ObjectBase, OwnerBase } from '../../base';
+import { Owner, RelatedObject } from 'src/base';
 
 export interface IAccountAttr {
   AccountNo: string;
@@ -15,8 +15,8 @@ export interface IAccountAttr {
 }
 
 export interface ICreateAccountAttr {
-  Owner: OwnerBase;
-  RelatedObject: ObjectBase;
+  Owner: Owner;
+  RelatedObject: RelatedObject;
   AccountType: string;
   AccountSubType: string;
   ParentAccountNo?: string;

package/src/account/interfaces/account.repository.interface.ts

@@ -1,4 +1,4 @@
-import { IBaseRepository } from '../../base/base.repository.interface';
+import { IBaseRepository } from '@tomei/general';
 import { AccountModel } from '../entities/account.entity';
 
 export type IAccountRepository = IBaseRepository<AccountModel>;

package/src/base/base.address.ts

@@ -0,0 +1,21 @@
+import { AddressBase } from '@tomei/general';
+
+export class Address extends AddressBase {
+  Line1: string;
+  City: string;
+  PostalCode: string;
+  Country: string;
+
+  constructor(
+    line1: string,
+    city: string,
+    postalCode: string,
+    country: string,
+  ) {
+    super();
+    this.Line1 = line1;
+    this.City = city;
+    this.PostalCode = postalCode;
+    this.Country = country;
+  }
+}

package/src/base/base.object.ts

@@ -0,0 +1,14 @@
+import { ObjectBase } from '@tomei/general';
+
+export class RelatedObject extends ObjectBase {
+  Id: string;
+  Name: string;
+  Type: string;
+
+  constructor(id: string, name: string) {
+    super();
+    this.Id = id;
+    this.Name = name;
+    this.Type = 'RelatedObject';
+  }
+}

package/src/base/base.owner.ts

@@ -0,0 +1,59 @@
+import { PersonBase, AddressBase } from '@tomei/general';
+
+export class Owner extends PersonBase {
+  FullName: string;
+  IDNo: string;
+  IDType: string;
+  Email: string;
+  ContactNo: string;
+  Address: AddressBase;
+  Id: string;
+  Name: string;
+
+  constructor(
+    fullName: string,
+    idNo: string,
+    idType: string,
+    email: string,
+    contactNo: string,
+    address: AddressBase,
+    id: string,
+    name: string,
+  ) {
+    super();
+    this.FullName = fullName;
+    this.IDNo = idNo;
+    this.IDType = idType;
+    this.Email = email;
+    this.ContactNo = contactNo;
+    this.Address = address;
+    this.Id = id;
+    this.Name = name;
+  }
+
+  getDetails(): {
+    FullName: string;
+    IDNo: string;
+    IDType: string;
+    Email: string;
+    ContactNo: string;
+    Address: AddressBase;
+    Id: string;
+    Name: string;
+  } {
+    return {
+      FullName: this.FullName,
+      IDNo: this.IDNo,
+      IDType: this.IDType,
+      Email: this.Email,
+      ContactNo: this.ContactNo,
+      Address: this.Address,
+      Id: this.Id,
+      Name: this.Name,
+    };
+  }
+
+  getDefaultAddress() {
+    return this.Address;
+  }
+}

package/src/base/index.ts

@@ -1,7 +1,4 @@
-import { IAccountSystem } from './account-system.interface';
-import { IOwner } from './owner/owner.interface';
-import { OwnerBase } from './owner/base.owner.abstract';
-import { IObject } from './object/object.interface';
-import { ObjectBase } from './object/base.object.abstract';
-
-export { IAccountSystem, ObjectBase, OwnerBase, IObject, IOwner };
+import { RelatedObject } from './base.object';
+import { Owner } from './base.owner';
+import { Address } from './base.address';
+export { RelatedObject, Owner, Address };

package/src/config.ts

@@ -0,0 +1,173 @@
+const config = {
+  development: {
+    commonApiUrl: process.env.COMMON_API_URL,
+    accountingSystem: {
+      quickbooks: {
+        packageName: process.env.PACKAGE_NAME,
+        accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS,
+        API_Url: process.env.API_URL,
+      },
+      xero: {
+        packageName: process.env.PACKAGE_NAME,
+        accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS,
+        API_Url: process.env.API_URL,
+      },
+    },
+    systemConfig: {
+      EZC: {
+        accountingSystem: 'quickbooks',
+        companyName: process.env.COMPANY_NAME,
+        API_Key: process.env.QUICKBOOK_API_KEY,
+        API_Secret: process.env.QUICKBOOK_API_SECRET,
+        redirectUrl: process.env.EZCASH_REDIRECT_URL,
+      },
+      EZG: {
+        accountingSystem: 'xero',
+        companyName: process.env.COMPANY_NAME,
+        API_Key: process.env.QUICKBOOK_API_KEY,
+        API_Secret: process.env.QUICKBOOK_API_SECRET,
+        redirectUrl: process.env.EZGOLD_REDIRECT_URL,
+      },
+    },
+  },
+  test: {
+    commonApiUrl: process.env.COMMON_API_URL,
+    accountingSystem: {
+      quickbooks: {
+        packageName: process.env.PACKAGE_NAME,
+        accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS,
+        API_Url: process.env.API_URL,
+      },
+      xero: {
+        packageName: process.env.PACKAGE_NAME,
+        accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS,
+        API_Url: process.env.API_URL,
+      },
+    },
+    systemConfig: {
+      EZC: {
+        accountingSystem: 'quickbooks',
+        companyName: process.env.COMPANY_NAME,
+        API_Key: process.env.QUICKBOOK_API_KEY,
+        API_Secret: process.env.QUICKBOOK_API_SECRET,
+        redirectUrl: process.env.EZCASH_REDIRECT_URL,
+      },
+      EZG: {
+        accountingSystem: 'xero',
+        companyName: process.env.COMPANY_NAME,
+        API_Key: process.env.QUICKBOOK_API_KEY,
+        API_Secret: process.env.QUICKBOOK_API_SECRET,
+        redirectUrl: process.env.EZGOLD_REDIRECT_URL,
+      },
+    },
+  },
+  staging: {
+    commonApiUrl: process.env.COMMON_API_URL,
+    accountingSystem: {
+      quickbooks: {
+        packageName: process.env.PACKAGE_NAME,
+        accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS,
+        API_Url: process.env.API_URL,
+      },
+      xero: {
+        packageName: process.env.PACKAGE_NAME,
+        accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS,
+        API_Url: process.env.API_URL,
+      },
+    },
+    systemConfig: {
+      EZC: {
+        accountingSystem: 'quickbooks',
+        companyName: process.env.COMPANY_NAME,
+        API_Key: process.env.QUICKBOOK_API_KEY,
+        API_Secret: process.env.QUICKBOOK_API_SECRET,
+        redirectUrl: process.env.EZCASH_REDIRECT_URL,
+      },
+      EZG: {
+        accountingSystem: 'xero',
+        companyName: process.env.COMPANY_NAME,
+        API_Key: process.env.QUICKBOOK_API_KEY,
+        API_Secret: process.env.QUICKBOOK_API_SECRET,
+        redirectUrl: process.env.EZGOLD_REDIRECT_URL,
+      },
+    },
+  },
+  production: {
+    commonApiUrl: process.env.COMMON_API_URL,
+    accountingSystem: {
+      quickbooks: {
+        packageName: process.env.PACKAGE_NAME,
+        accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS,
+        API_Url: process.env.API_URL,
+      },
+      xero: {
+        packageName: process.env.PACKAGE_NAME,
+        accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS,
+        API_Url: process.env.API_URL,
+      },
+    },
+    systemConfig: {
+      EZC: {
+        accountingSystem: 'quickbooks',
+        companyName: process.env.COMPANY_NAME,
+        API_Key: process.env.QUICKBOOK_API_KEY,
+        API_Secret: process.env.QUICKBOOK_API_SECRET,
+        redirectUrl: process.env.EZCASH_REDIRECT_URL,
+      },
+      EZG: {
+        accountingSystem: 'xero',
+        companyName: process.env.COMPANY_NAME,
+        API_Key: process.env.QUICKBOOK_API_KEY,
+        API_Secret: process.env.QUICKBOOK_API_SECRET,
+        redirectUrl: process.env.EZGOLD_REDIRECT_URL,
+      },
+    },
+  },
+};
+
+type Config = {
+  commonApiUrl: string;
+  accountingSystem: {
+    quickbooks: {
+      packageName: string;
+      accountSystemClass: string;
+      API_Url: string;
+    };
+    xero: {
+      packageName: string;
+      accountSystemClass: string;
+      API_Url: string;
+    };
+  };
+  systemConfig: {
+    EZC: {
+      accountingSystem: string;
+      companyName: string;
+      API_Key: string;
+      API_Secret: string;
+      redirectUrl: string;
+    };
+    EZG: {
+      accountingSystem: string;
+      companyName: string;
+      API_Key: string;
+      API_Secret: string;
+      redirectUrl: string;
+    };
+  };
+};
+
+export const getConfig = (): Config => {
+  switch (process.env.NODE_ENV) {
+    case 'development':
+      return config['development'];
+    case 'test':
+      return config['test'];
+    case 'staging':
+      return config['staging'];
+    case 'production':
+      return config['production'];
+    default:
+      break;
+  }
+};

package/src/customer/customer.ts

@@ -0,0 +1,146 @@
+import { AddressBase, PersonBase } from '@tomei/general';
+import { IAccountSystem } from '../interfaces';
+import { Address } from '../base/base.address';
+import { FinanceCustomerRepository } from './finance-customer.repository';
+import { ICustomerRepository } from './interfaces/customer.repository.interface';
+import { getConfig } from '../config';
+
+export class Customer extends PersonBase {
+  private CustomerId: string;
+  private AccSystemId: string;
+
+  FullName: string;
+  IDNo: string;
+  IDType: string;
+  Email: string;
+  ContactNo: string;
+  Address: AddressBase;
+  Id: string;
+  Name: string;
+
+  financeCustomerRepository: FinanceCustomerRepository;
+  customerRepository: ICustomerRepository<any>;
+  customerAddressRepository: any;
+  client: IAccountSystem;
+  person: PersonBase;
+  systemCode: string;
+  constructor(
+    financeCustomerRepository: FinanceCustomerRepository,
+    customerRepository: ICustomerRepository<any>,
+    customerAddressRepository: any,
+    client: IAccountSystem,
+    systemCode: string,
+    person?: PersonBase,
+  ) {
+    super();
+    this.financeCustomerRepository = financeCustomerRepository;
+    this.customerRepository = customerRepository;
+    this.customerAddressRepository = customerAddressRepository;
+    this.client = client;
+    this.systemCode = systemCode;
+    if (person) {
+      this.person = person;
+      this.init(person);
+    }
+  }
+
+  init(person: PersonBase) {
+    this.FullName = person.FullName;
+    this.IDNo = person.IDNo;
+    this.IDType = person.IDType;
+    this.Email = person.Email;
+    this.ContactNo = person.ContactNo;
+    this.Address = person.Address;
+  }
+
+  async getDetails(): Promise<any> {
+    if (
+      !this.FullName ||
+      !this.IDNo ||
+      !this.IDType ||
+      !this.Email ||
+      !this.ContactNo ||
+      !this.Address
+    ) {
+      const customerData = await this.customerRepository.findOne({
+        where: { IdNo: this.IDNo },
+      });
+      if (!customerData) {
+        throw new Error('Customer must be created first.');
+      }
+
+      this.FullName = customerData.FullName;
+      this.IDNo = customerData.IDNo;
+      this.IDType = customerData.IDType;
+      this.Email = customerData.Email;
+      this.ContactNo = customerData.ContactNo;
+      this.Id = customerData.CustomerId;
+      this.Name = customerData.PreferredName;
+    }
+
+    return {
+      FullName: this.FullName,
+      IDNo: this.IDNo,
+      IDType: this.IDType,
+      Email: this.Email,
+      ContactNo: this.ContactNo,
+      Address: this.Address,
+      Id: this.Id,
+      Name: this.Name,
+    };
+  }
+
+  async getDefaultAddress(): Promise<any> {
+    if (
+      !this.Address.Line1 ||
+      !this.Address.City ||
+      !this.Address.PostalCode ||
+      !this.Address.Country
+    ) {
+      const addressData = await this.customerAddressRepository.findOne({
+        where: { CustomerId: this.Id, isDefaultYN: 'Y' },
+      });
+
+      if (!addressData) {
+        throw new Error('Address must be created first.');
+      }
+
+      this.Address = new Address(
+        addressData.Address,
+        addressData.City,
+        addressData.PostCode,
+        addressData.Country,
+      );
+    }
+    return {
+      Line1: this.Address.Line1,
+      City: this.Address.City,
+      PostalCode: this.Address.PostalCode,
+      Country: this.Address.Country,
+    };
+  }
+
+  async create() {
+    try {
+      await this.getDetails();
+      await this.getDefaultAddress();
+
+      const customerData = await this.client.createCustomer({
+        FullName: this.FullName,
+        Email: this.Email,
+        ContractNo: this.ContactNo,
+        Address: this.Address,
+      });
+
+      this.AccSystemId =
+        getConfig().systemConfig[this.systemCode].accountingSystem;
+      this.CustomerId = customerData.Id;
+      return await this.financeCustomerRepository.create({
+        CustomerId: customerData.Id,
+        AccSystemId: this.AccSystemId,
+      });
+    } catch (error) {
+      throw error;
+    }
+  }
+}