@tomei/finance 0.6.112 → 0.8.0

package/src/config.ts

@@ -1,382 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const dotenv = require('dotenv');
-
-dotenv.config();
-
-const defaultConfig = {
-  commonApiUrl: process.env.COMMON_API_URL,
-  accountingSystem: {
-    quickbooks: {
-      packageName: process.env.PACKAGE_NAME || '',
-      accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS || '',
-      apiUrl: process.env.API_URL || '',
-    },
-    xero: {
-      packageName: process.env.PACKAGE_NAME || '',
-      accountSystemClass: process.env.ACCOUNT_SYSTEM_CLASS || '',
-      apiUrl: process.env.API_URL || '',
-    },
-  },
-  financeCompanies: {
-    'TXG-FS': {
-      companyId: process.env.COMPANYID || 'TXG-FS',
-      companyName: process.env.COMPANYNAME || 'TXG Financial Solutions Sdn Bhd',
-      companySystemCode: process.env.COMPSYSTEMCODE || 'Tomei-SSO',
-      companySystemRefId: process.env.COMPSYSTEMREFID || '',
-      accountSystemCode: process.env.ACCSYSTEMCODE || '',
-      accountingSystem: 'quickbooks',
-      apiKey: process.env.QUICKBOOK_API_KEY,
-      redirectUrl: process.env.EZGOLD_REDIRECT_URL,
-      apiSecret: process.env.QUICKBOOK_API_SECRET,
-      paymentMethods: {
-        cash: {
-          id: 'CS',
-          name: 'Cash',
-          types: {
-            cash: {
-              id: 'CS-CASH',
-              name: 'Cash',
-              accountNo: 'CASH',
-              processingFeeRate: 0.0,
-              processingFeeAccountNo: 'CASH-FEE',
-            },
-          },
-        },
-        cheque: {
-          id: 'CQ',
-          name: 'Cheque',
-          types: {
-            cash: {
-              id: 'CQ-Cheque',
-              name: 'Cheque',
-              accountNo: 'CHEQUE',
-              processingFeeRate: 0.0,
-              processingFeeAccountNo: 'CASH-FEE',
-            },
-          },
-        },
-        bankTransfer: {
-          id: 'BT',
-          name: 'Bank Transfer',
-          types: {
-            bankTransfer: {
-              id: 'BT-RHB',
-              name: 'RHB',
-              accountNo: '19GKBA20900-01',
-              processingFeeRate: 1.0,
-              processingFeeAccountNo: 'RHB-FEE',
-            },
-          },
-        },
-        debitCard: {
-          id: 'DC',
-          name: 'Debit Card',
-          types: {
-            mastercard: {
-              id: 'DC-MSC',
-              name: 'Mastercard',
-              accountNo: 'CURLEC',
-              processingFeeRate: 1.5,
-              processingFeeAccountNo: 'CURLEC-FEE',
-            },
-            visa: {
-              id: 'DC-VISA',
-              name: 'Visa',
-              accountNo: 'CURLEC',
-              processingFeeRate: 1.5,
-              processingFeeAccountNo: 'CURLEC-FEE',
-            },
-          },
-        },
-        creditCard: {
-          id: 'CC',
-          name: 'Credit Card',
-          types: {
-            mastercard: {
-              id: 'CC-MSC',
-              name: 'Mastercard',
-              accountNo: 'CURLEC',
-              processingFeeRate: 2.5,
-              processingFeeAccountNo: 'CURLEC-FEE',
-            },
-            visa: {
-              id: 'CC-VISA',
-              name: 'Visa',
-              accountNo: 'CURLEC',
-              processingFeeRate: 2.5,
-              processingFeeAccountNo: 'CURLEC-FEE',
-            },
-            amex: {
-              id: 'CC-AMEX',
-              name: 'American Express',
-              accountNo: 'CURLEC',
-              processingFeeRate: 3.5,
-              processingFeeAccountNo: 'CURLEC-FEE',
-            },
-          },
-        },
-        mandate: {
-          id: 'MD',
-          name: 'Mandate',
-          types: {
-            RHB: {
-              id: 'MD-RHB',
-              name: 'RHB Mandate',
-              accountNo: '19GKBA20900-01',
-              processingFeeRate: 1.0,
-              processingFeeAccountNo: 'RHB-FEE',
-            },
-          },
-        },
-      },
-    },
-    'TXG-B': {
-      companyId: 'TXG-B',
-      companyName: 'TXG Bullion Sdn Bhd',
-      companySystemCode: 'Tomei-SSO',
-      companySystemRefId: '',
-      accountingSystem: 'quickbooks',
-      accountSystemCode: '',
-      apiKey: '',
-      apiSecret: '',
-      redirectUrl: process.env.EZGOLD_REDIRECT_URL,
-      paymentMethods: {
-        cash: {
-          id: 'CS',
-          name: 'Cash',
-          types: {
-            cash: {
-              id: 'CS-CASH',
-              name: 'Cash',
-              accountno: '',
-              processingFeeRate: 0.0,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-        bankTransfer: {
-          id: 'BT',
-          name: 'Bank Transfer',
-          types: {
-            banktransfer: {
-              id: 'BT-RHB',
-              name: 'RHB',
-              accountno: '',
-              processingFeeRate: 1.0,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-        debitCard: {
-          id: 'DC',
-          name: 'Debit Card',
-          types: {
-            mastercard: {
-              id: 'DC-MSC',
-              name: 'Mastercard',
-              accountno: '',
-              processingFeeRate: 1.5,
-              processingFeeAccountNo: '',
-            },
-            visa: {
-              id: 'DC-VISA',
-              name: 'Visa',
-              accountno: '',
-              processingFeeRate: 1.5,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-        creditCard: {
-          id: 'CC',
-          name: 'Credit Card',
-          types: {
-            mastercard: {
-              id: 'CC-MSC',
-              name: 'Mastercard',
-              accountno: '',
-              processingFeeRate: 2.5,
-              processingFeeAccountNo: '',
-            },
-            visa: {
-              id: 'CC-VISA',
-              name: 'Visa',
-              accountno: '',
-              processingFeeRate: 2.5,
-              processingFeeAccountNo: '',
-            },
-            amex: {
-              id: 'CC-AMEX',
-              name: 'American Express',
-              accountno: '',
-              processingFeeRate: 3.5,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-        eWallet: {
-          id: 'EW',
-          name: 'E-Wallet',
-          types: {
-            touchngo: {
-              id: 'EW-T&G',
-              name: 'Touch & Go',
-              accountno: '',
-              processingFeeRate: 1.5,
-              processingFeeAccountNo: '',
-            },
-            Boost: {
-              id: 'EW-BOOST',
-              name: 'Boost',
-              accountno: '',
-              processingFeeRate: 2.5,
-              processingFeeAccountNo: '',
-            },
-            GrabPay: {
-              id: 'EW-GRAB',
-              name: 'GrabPay',
-              accountno: '',
-              processingFeeRate: 2.5,
-              processingFeeAccountNo: '',
-            },
-            ShopeePay: {
-              id: 'EW-SHOPEE',
-              name: 'ShopeePay',
-              accountno: '',
-              processingFeeRate: 2.5,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-        mandate: {
-          id: 'MD',
-          name: 'Mandate',
-          types: {
-            RHB: {
-              id: 'MD-RHB',
-              name: 'RHB Mandate',
-              accountno: '',
-              processingFeeRate: 1.0,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-        storeCredit: {
-          id: 'SC',
-          name: 'Store Credit',
-          types: {
-            scTomei: {
-              id: 'SC-TOMEI',
-              name: 'Tomei Store Credit',
-              accountno: '',
-              processingFeeRate: 0.0,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-        pointsRedemption: {
-          id: 'PR',
-          name: 'Points Redemption',
-          types: {
-            prTomei: {
-              id: 'PR-TOMEI',
-              name: 'Tomei Points Redemption',
-              accountno: '',
-              processingFeeRate: 0.0,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-        voucher: {
-          id: 'VC',
-          name: 'Voucher',
-          types: {
-            gift: {
-              id: 'VC-GF',
-              name: 'Gift Voucher',
-              accountno: '',
-              processingFeeRate: 0.0,
-              processingFeeAccountNo: '',
-            },
-            cash: {
-              id: 'VC-CS',
-              name: 'Cash Voucher',
-              accountno: '',
-              processingFeeRate: 0.0,
-              processingFeeAccountNo: '',
-            },
-          },
-        },
-      },
-    },
-  },
-};
-
-const config = {
-  development: {
-    environment: 'development',
-    ...defaultConfig,
-  },
-  test: {
-    environment: 'test',
-    ...defaultConfig,
-  },
-  staging: {
-    environment: 'staging',
-    ...defaultConfig,
-  },
-  production: {
-    environment: 'production',
-    ...defaultConfig,
-  },
-};
-
-type Config = {
-  commonApiUrl: string;
-  environment: 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;
-    };
-  };
-};
-
-const getConfig = () => {
-  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;
-  }
-};
-
-module.exports = () => getConfig();

package/src/customer/customer.ts

@@ -1,311 +0,0 @@
-import {
-  IAddress,
-  IRepositoryBase,
-  IPerson,
-  LoginUserBase,
-} from '@tomei/general';
-import { RecordNotFoundError } from '@tomei/general/dist/class/exceptions/record-not-found.error';
-import FinanceCustomerModel from '../models/customer.entity';
-import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
-import { FinanceCustomerRepository } from './finance-customer.repository';
-import Account from '../account/account';
-import { AccountRepository } from '../account/account.repository';
-import { type } from '../helpers/typeof';
-import * as FinanceDb from '../database';
-import { LedgerTransactionRepository } from '../ledger-transaction/ledger-transaction.repository';
-
-// const AccountSystemEntity = import('../account-system-entity').then(({AccountSystemEntity}) => AccountSystemEntity);
-export default abstract class FinanceCustomerBase
-  extends AccountSystemEntity
-  implements IPerson
-{
-  CustomerId = 'New';
-  CustSystemCode = '';
-  CustSystemRefId = '';
-
-  protected abstract ParentARAccountNo: string;
-  protected abstract ParentAPAccountNo: string;
-  protected abstract ARAccountNo: string;
-  protected abstract APAccountNo: string;
-  protected abstract _ObjectType: string;
-
-  abstract FullName: string;
-  abstract IDNo: string;
-  abstract IDType: string;
-  abstract ContactNo: string;
-  abstract Email: string;
-  abstract DefaultAddress: IAddress;
-
-  private _AccountReceivable: Account;
-  private _AccountPayable: Account;
-
-  protected _DbTransaction: any;
-
-  private static _AccountRepository = new AccountRepository();
-  private static _LedgerTransactionRepository =
-    new LedgerTransactionRepository();
-
-  // 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,
-    };
-  }
-
-  protected static _FinanceCustomerRepository = new FinanceCustomerRepository();
-  RepositoryBase: IRepositoryBase<any>;
-
-  constructor(
-    custSystemRefId?: string,
-    custSystemCode?: string,
-    sFinanceCompanyId?: string,
-  ) {
-    super();
-    if (custSystemRefId && custSystemCode && sFinanceCompanyId) {
-      this.CustSystemRefId = custSystemRefId;
-      this.CustSystemCode = custSystemCode;
-      this.CompanyId = sFinanceCompanyId;
-    }
-  }
-
-  public static async initCustomer<C extends FinanceCustomerBase>(
-    this: new () => C,
-    custSystemRefId: string,
-    custSystemCode: string,
-    sFinanceCompanyId: string,
-    dbTransaction?: any,
-  ): Promise<C> {
-    const financeCustomerData =
-      await FinanceCustomerBase._FinanceCustomerRepository.findOne({
-        where: {
-          CompanyId: sFinanceCompanyId,
-          CustSystemCode: custSystemCode,
-          CustSystemRefId: custSystemRefId,
-        },
-        transaction: dbTransaction,
-      });
-    if (financeCustomerData) {
-      const self = new this();
-      self._DbTransaction = dbTransaction;
-      self.CustomerId = financeCustomerData.CustomerId;
-      self.CompanyId = sFinanceCompanyId;
-      self.CustSystemCode = custSystemCode;
-      self.CustSystemRefId = custSystemRefId;
-      self.AccSystemRefId = financeCustomerData.AccSystemRefId;
-      self.PostedToAccSystemYN = financeCustomerData.PostedToAccSystemYN;
-      self.PostedById = financeCustomerData.PostedById;
-      self.PostedDateTime = financeCustomerData.PostedDateTime;
-      return self;
-    } else {
-      const notFoundError = new RecordNotFoundError(
-        'FinanceCustomerErrMsg',
-        'No Record Found',
-      );
-      throw notFoundError;
-    }
-  }
-
-  async getAccountReceivable(): Promise<Account> {
-    try {
-      const transaction = this._DbTransaction;
-      if (this._AccountReceivable) {
-        return this._AccountReceivable;
-      } else {
-        const accountData =
-          await FinanceCustomerBase._AccountRepository.findOne({
-            where: {
-              AccountNo: this.ARAccountNo,
-              AccountType: 'Account Receivable',
-              OwnerId: this.CustomerId,
-              OwnerType: type(this),
-            },
-            transaction,
-          });
-        this._AccountReceivable = new Account(transaction);
-        if (accountData) {
-          this._AccountReceivable.AccountNo = accountData.AccountNo;
-          this._AccountReceivable.AccSystemRefId = accountData.AccSystemRefId;
-          this._AccountReceivable.Name = accountData.Name;
-          this._AccountReceivable.Description = accountData.Description;
-          this._AccountReceivable.ParentAccountNo = accountData.ParentAccountNo;
-          this._AccountReceivable.AccountType = accountData.AccountType;
-          this._AccountReceivable.OwnerId = accountData.OwnerId;
-          this._AccountReceivable.OwnerType = accountData.OwnerType;
-          this._AccountReceivable.RelatedObjectId = accountData.RelatedObjectId;
-          this._AccountReceivable.RelatedObjectType =
-            accountData.RelatedObjectType;
-          this._AccountReceivable.CreatedById = accountData.CreatedById;
-          this._AccountReceivable.CreatedAt = accountData.CreatedAt;
-          this._AccountReceivable.UpdatedById = accountData.UpdatedById;
-          this._AccountReceivable.UpdatedAt = accountData.UpdatedAt;
-        } else {
-          // this._AccountReceivable.AccountNo = `${this.CustSystemCode}-AR-123456789`;
-          // this._AccountReceivable.ParentAccountNo = `${this.CustSystemCode}-AR`;
-          this._AccountReceivable.AccountNo = this.ARAccountNo; //SystemInfo.SYSTEM_CODE + '-AR-' + '8 digit running no'
-          this._AccountReceivable.ParentAccountNo = this.ParentARAccountNo; //SystemInfo.SYSTEM_CODE + '-AR'
-          this._AccountReceivable.AccountType = 'Account Receivable';
-          this._AccountReceivable.OwnerId = this.CustomerId;
-          this._AccountReceivable.OwnerType = type(this);
-        }
-        return this._AccountReceivable;
-      }
-    } catch (error) {
-      throw error;
-    }
-  }
-
-  async getAccountPayable(): Promise<Account> {
-    try {
-      const transaction = this._DbTransaction;
-      if (this._AccountPayable) {
-        return this._AccountPayable;
-      } else {
-        const accountData =
-          await FinanceCustomerBase._AccountRepository.findOne({
-            where: {
-              AccountNo: this.APAccountNo,
-              AccountType: 'Account Payable',
-              OwnerId: this.CustomerId,
-              OwnerType: type(this),
-            },
-            transaction,
-          });
-
-        this._AccountPayable = new Account(transaction);
-        if (accountData) {
-          this._AccountPayable.AccountNo = accountData.AccountNo;
-          this._AccountPayable.ParentAccountNo = accountData.ParentAccountNo;
-          this._AccountPayable.AccountType = accountData.AccountType;
-          this._AccountPayable.OwnerId = accountData.OwnerId;
-          this._AccountPayable.OwnerType = accountData.OwnerType;
-        } else {
-          // this._AccountPayable.AccountNo = `${this.CustSystemCode}-AP-123456789`;
-          // this._AccountPayable.ParentAccountNo = `${this.CustSystemCode}-AP`;
-          this._AccountPayable.AccountNo = this.APAccountNo; //SystemInfo.SYSTEM_CODE + '-AP-' + '8 digit running no'
-          this._AccountPayable.ParentAccountNo = this.ParentAPAccountNo; //SystemInfo.SYSTEM_CODE + '-AP'
-          this._AccountPayable.AccountType = 'Account Payable';
-          this._AccountPayable.OwnerId = this.CustomerId;
-          this._AccountPayable.OwnerType = type(this);
-        }
-
-        return this._AccountPayable;
-      }
-    } catch (error) {
-      throw error;
-    }
-  }
-
-  /*
-   * Get the billing address for a person.
-   **/
-  abstract getBillingAddress(params: any): Promise<IAddress>;
-
-  init(person: LoginUserBase) {
-    this.FullName = person.FullName;
-    this.IDNo = person.IDNo;
-    this.IDType = person.IDType;
-    this.Email = person.Email;
-    this.ContactNo = person.ContactNo;
-    this.DefaultAddress = person.DefaultAddress;
-  }
-
-  async save(
-    accSystemRefId: string,
-    custSystemCode: string,
-    custSystemRefId: string,
-    dbTransaction?: any,
-  ): Promise<FinanceCustomerModel> {
-    this.CustSystemCode = custSystemCode;
-    this.CustSystemRefId = custSystemRefId;
-    this.AccSystemRefId = accSystemRefId;
-    if (accSystemRefId !== 'REF') {
-      this.PostedToAccSystemYN = 'Y';
-      this.PostedDateTime = new Date();
-    } else {
-      this.PostedToAccSystemYN = 'N';
-    }
-    this.CustomerId = this.createId();
-    const data = await FinanceCustomerBase._FinanceCustomerRepository.create(
-      {
-        CompanyId: this.CompanyId,
-        CustomerId: this.CustomerId,
-        CustSystemCode: this.CustSystemCode,
-        CustSystemRefId: this.CustSystemRefId,
-        AccSystemRefId: this.AccSystemRefId,
-        PostedToAccSystemYN: this.PostedToAccSystemYN,
-      },
-      { transaction: dbTransaction },
-    );
-    return data;
-  }
-
-  static async isFinanceCustomerExist(
-    custSystemRefId: string,
-    custSystemCode: string,
-    sFinanceCompanyId: string,
-    dbTransaction?: any,
-  ): Promise<boolean> {
-    const data = await FinanceCustomerBase._FinanceCustomerRepository.findAll({
-      where: {
-        CustSystemRefId: custSystemRefId,
-        CustSystemCode: custSystemCode,
-        CompanyId: sFinanceCompanyId,
-      },
-      transaction: dbTransaction,
-    });
-
-    if (data.length > 0) {
-      return true;
-    }
-    return false;
-  }
-
-  /**
-   * Method to calculate and return the outstanding balance for customer receivable account
-   *
-   * @param dbTransaction
-   * @returns {number}
-   */
-  async getOutstandingBalance(dbTransaction: any): Promise<number> {
-    if (!dbTransaction) {
-      dbTransaction = await FinanceDb.getConnection().transaction();
-    }
-
-    const AR = await this.getAccountReceivable();
-
-    const ledgerTransactions =
-      await FinanceCustomerBase._LedgerTransactionRepository.findAll({
-        where: {
-          AccountNo: AR.AccountNo,
-        },
-        transaction: dbTransaction,
-      });
-
-    const totalDebitAmount = ledgerTransactions.reduce(
-      (accumulator, currentValue) => accumulator + +currentValue.DebitAmount,
-      0,
-    );
-
-    const totalCreditAmount = ledgerTransactions.reduce(
-      (accumulator, currentValue) => accumulator + +currentValue.CreditAmount,
-      0,
-    );
-
-    if (totalCreditAmount > totalDebitAmount) {
-      return 0;
-    }
-
-    const balance = totalDebitAmount - totalCreditAmount;
-    return balance;
-  }
-}

package/src/customer/finance-customer.repository.ts

@@ -1,13 +0,0 @@
-import { Injectable } from '@nestjs/common/decorators';
-import { RepositoryBase, IRepositoryBase } from '@tomei/general';
-import FinanceCustomerModel from '../models/customer.entity';
-
-@Injectable()
-export class FinanceCustomerRepository
-  extends RepositoryBase<FinanceCustomerModel>
-  implements IRepositoryBase<FinanceCustomerModel>
-{
-  constructor() {
-    super(FinanceCustomerModel);
-  }
-}

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

@@ -1,3 +0,0 @@
-export interface ICustomerRepository<T> {
-  findOne?(options: any): Promise<T>;
-}