@tomei/finance 0.2.15 → 0.3.0

package/src/finance-company/finance-company.ts

@@ -1,19 +1,27 @@
 import axios from 'axios';
-import { HashTable, IBaseRepository, LoginUserBase } from '@tomei/general';
+import {
+  HashTable,
+  IBaseRepository,
+  LoginUserBase,
+  ObjectBase,
+} from '@tomei/general';
 import { BadRequestException } from '@nestjs/common';
 import { IAccountSystem } from '../interfaces';
-import { JournalEntry, JournalEntryRepository } from '../journal-entry';
-import { LedgerTransactionRepository } from '../ledger-transaction';
-import { Account } from '../account';
-import { Customer, FinanceCustomerRepository } from '../customer';
-import { AccountSystemEntity } from '../account-system-entity';
-import cuid from 'cuid';
+import * as cuid from 'cuid';
 import { FinanceCompanyRepository } from './finance-company.repository';
-
-export class FinanceCompany extends AccountSystemEntity {
+import { FinanceCustomerRepository } from '../customer/finance-customer.repository';
+import { JournalEntryRepository } from '../journal-entry/journal-entry.repository';
+import { Account } from '../account/account';
+import { LedgerTransactionRepository } from '../ledger-transaction/ledger-transaction.repository';
+import { FinanceCustomerBase } from '../customer/customer';
+import { JournalEntry } from '../journal-entry/journal-entry';
+
+export default class FinanceCompany extends ObjectBase {
+  private _CompanyId = 'New';
   private _CompSystemCode = '';
   private _CompSystemRefId = '';
   private _AccSystemCode = '';
+  private _AccSystemRefId = '';
   protected BaseRepository: IBaseRepository;
   private static _htFinanceCompanyIds = new HashTable();
   private static _htFinanceCompanies = new HashTable();
@@ -47,8 +55,20 @@ export class FinanceCompany extends AccountSystemEntity {
     this._AccSystemCode = code;
   }
 
+  get AccSystemRefId() {
+    return this._AccSystemRefId;
+  }
+
+  get CompanyId() {
+    return this._CompanyId;
+  }
+
   get ObjectId() {
-    return this.CompanyId;
+    return this._CompanyId;
+  }
+
+  private set ObjectId(id: string) {
+    this._CompanyId = id;
   }
 
   get ObjectName() {
@@ -90,17 +110,19 @@ export class FinanceCompany extends AccountSystemEntity {
       /*Retrieve the finance company from finance_Company table using compSystemCode,
        * CompSystemRefId and accSystemCode */
       const company = await FinanceCompany.financeCompanyRepository.findOne({
-        CompSystemCode: compSystemCode,
-        CompSystemRefId: compSystemRefId,
-        AccSystemCode: accSystemCode,
+        where: {
+          CompSystemCode: compSystemCode,
+          CompSystemRefId: compSystemRefId,
+          AccSystemCode: accSystemCode,
+        },
       });
 
       /*Retrieve and store the companyId from the result*/
-      financeCompany.CompanyId = company.CompanyId;
-      sCompanyId = financeCompany.CompanyId;
+      financeCompany.ObjectId = company.CompanyId;
+      sCompanyId = financeCompany.ObjectId;
 
       /*Add the details into the hashtable*/
-      FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.CompanyId);
+      FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.ObjectId);
       FinanceCompany._htFinanceCompanies.add(sCompanyId, financeCompany);
     }
 
@@ -117,9 +139,13 @@ export class FinanceCompany extends AccountSystemEntity {
       /*Retrieve the finance company from finance_Company table using compSystemCode,
        * CompSystemRefId and accSystemCode */
       const company = await FinanceCompany.financeCompanyRepository.findOne({
-        CompanyId: companyId,
+        where: { CompanyId: companyId },
       });
 
+      if (!company) {
+        throw Error('No finance company found. Please create first.');
+      }
+
       /*Using the result returned, instantiate a new FinanceCompany*/
       const compSystemCode = company.CompSystemCode;
       const compSystemRefId = company.CompSystemRefId;
@@ -132,17 +158,18 @@ export class FinanceCompany extends AccountSystemEntity {
       );
 
       /*Retrieve and store the CompanyId from the result*/
-      financeCompany.CompanyId = company.CompanyId;
+      financeCompany.ObjectId = company.CompanyId;
 
       /*Add the details into the hashtable*/
       const sKey = `${compSystemCode}-${compSystemRefId}-${accSystemCode}`;
-      FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.CompanyId);
+      FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.ObjectId);
       FinanceCompany._htFinanceCompanies.add(
-        financeCompany.CompanyId,
+        financeCompany.ObjectId,
         financeCompany,
       );
     }
-
+    // tslint:disable-next-line:no-console
+    console.log('return from hash table');
     return FinanceCompany._htFinanceCompanies.get(companyId);
   }
 
@@ -162,9 +189,11 @@ export class FinanceCompany extends AccountSystemEntity {
 
     /*Validating if the finance company already exists in finance_Company*/
     const company = await FinanceCompany.financeCompanyRepository.findOne({
-      CompSystemCode: compSystemCode,
-      CompSystemRefId: compSystemRefId,
-      AccSystemCode: accSystemCode,
+      where: {
+        CompSystemCode: compSystemCode,
+        CompSystemRefId: compSystemRefId,
+        AccSystemCode: accSystemCode,
+      },
     });
 
     if (company) {
@@ -174,18 +203,27 @@ export class FinanceCompany extends AccountSystemEntity {
     }
 
     /*Generating the companyId*/
-    financeCompany.CompanyId = cuid();
+    financeCompany.ObjectId = cuid();
 
     /*Save the FinanceCompany to the finance_Company table*/
-    await FinanceCompany.financeCompanyRepository.create(financeCompany, {
-      transaction: dbTransaction,
-    });
+    await FinanceCompany.financeCompanyRepository.create(
+      {
+        CompanyId: financeCompany.CompanyId,
+        CompSystemCode: financeCompany.CompSystemCode,
+        CompSystemRefId: financeCompany.CompSystemRefId,
+        AccSystemCode: financeCompany.AccSystemCode,
+        AccSystemRefId: financeCompany.AccSystemRefId,
+      },
+      {
+        transaction: dbTransaction,
+      },
+    );
 
     /*Add the details to hashtable*/
     const sKey = `${compSystemCode}-${compSystemRefId}-${accSystemCode}`;
-    FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.CompanyId);
+    FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.ObjectId);
     FinanceCompany._htFinanceCompanies.add(
-      financeCompany.CompanyId,
+      financeCompany.ObjectId,
       financeCompany,
     );
   }
@@ -194,7 +232,7 @@ export class FinanceCompany extends AccountSystemEntity {
     dbTransaction: any,
     custSystemCode: string,
     custSystemRefId: string,
-    customer: Customer,
+    customer: FinanceCustomerBase,
   ) {
     try {
       if (customer.CustSystemCode || customer.CustSystemRefId) {

package/src/index.ts

@@ -1,9 +1,22 @@
-export * from './account';
-export * from './customer';
-export * from './enum';
-export * from './interfaces';
-export * from './payment';
-export * from './ledger-transaction';
-export * from './journal-entry';
-export * from './finance-company';
-export { getConfig } from './config';
+import { Account } from './account/account';
+import FinanceCompany from './finance-company/finance-company';
+import { FinanceCustomerBase } from './customer/customer';
+import { Document } from './document/document';
+import { DocumentItem } from './document/document-item';
+import { JournalEntry } from './journal-entry/journal-entry';
+import { LedgerTransaction } from './ledger-transaction/ledger-transaction';
+import { Payment } from './payment/payment';
+
+export {
+  FinanceCompany,
+  Account,
+  FinanceCustomerBase,
+  Document,
+  DocumentItem,
+  JournalEntry,
+  LedgerTransaction,
+  Payment,
+};
+export * as FinanceEnum from './enum';
+export * as FinanceInterfaces from './interfaces';
+export * as FinanceDb from './database';

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

@@ -1,14 +1,20 @@
-import { Customer } from '../customer';
-import { Payment } from '../payment';
-
-export interface IAccountSystem {
-  createAccount(payload: any): Promise<any>;
-  createInvoice(payload: any): Promise<any>;
-  createDebitNote(payload: any): Promise<any>;
-  createCreditNote(payload: any): Promise<any>;
-  postTransaction(payload: any): Promise<any>;
-  createCustomer(payload: any): Promise<any>;
-  makePayment(customer: Customer, paymentInfo: Payment): Promise<any>;
-  collectPayments(customer: Customer, paymentInfo: Payment): Promise<any>;
-  postJournalEntry(payload: any): Promise<any>;
-}
+import { Payment } from '../payment/payment';
+import { FinanceCustomerBase } from '../customer/customer';
+
+export interface IAccountSystem {
+  createAccount(payload: any): Promise<any>;
+  createInvoice(payload: any): Promise<any>;
+  createDebitNote(payload: any): Promise<any>;
+  createCreditNote(payload: any): Promise<any>;
+  postTransaction(payload: any): Promise<any>;
+  createCustomer(payload: any): Promise<any>;
+  makePayment(
+    customer: FinanceCustomerBase,
+    paymentInfo: Payment,
+  ): Promise<any>;
+  collectPayments(
+    customer: FinanceCustomerBase,
+    paymentInfo: Payment,
+  ): Promise<any>;
+  postJournalEntry(payload: any): Promise<any>;
+}

package/src/interfaces/index.ts

@@ -1,3 +1,3 @@
-import { IAccountSystem } from '../interfaces/account-system.interface';
-
-export { IAccountSystem };
+import { IAccountSystem } from '../interfaces/account-system.interface';
+
+export { IAccountSystem };

package/src/journal-entry/journal-entry.repository.ts

@@ -1,5 +1,5 @@
 import { InjectModel } from '@nestjs/sequelize';
-import { JournalEntryModel } from './entities/journal-entry.entity';
+import JournalEntryModel from '../models/journal-entry.entity';
 import { IJournalEntryRepository } from './interfaces/journal-entry.repository.interface';
 import { IJournalEntryAttr } from './interfaces/journal-entry-attr.interface';
 import { Injectable } from '@nestjs/common/decorators';

package/src/journal-entry/journal-entry.ts

@@ -1,14 +1,14 @@
 import * as cuid from 'cuid';
 import { Op } from 'sequelize';
-import { LedgerTransactionRepository } from '../ledger-transaction/ledger-transaction.repository';
-import { LedgerTransaction } from '../ledger-transaction';
 import { ILedgerTransactionTypeOptionsAttr } from '../ledger-transaction/interfaces/ledger-transaction-attr.interface';
 import { JournalEntryRepository } from './journal-entry.repository';
 import { IJournalEntryAttr } from './interfaces/journal-entry-attr.interface';
 import { TransactionTypeOptions } from '../enum';
-import { JournalEntryModel } from './entities/journal-entry.entity';
-import { AccountSystemEntity } from '../account-system-entity';
+import JournalEntryModel from '../models/journal-entry.entity';
 import { IBaseRepository } from '@tomei/general';
+import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
+import { LedgerTransactionRepository } from '../ledger-transaction/ledger-transaction.repository';
+import { LedgerTransaction } from '../ledger-transaction/ledger-transaction';
 
 export class JournalEntry extends AccountSystemEntity {
   private _JournalEntryId: string;

package/src/ledger-transaction/ledger-transaction.repository.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import { InjectModel } from '@nestjs/sequelize';
-import { LedgerTransactionModel } from './entities/ledger-transaction.entity';
+import LedgerTransactionModel from '../models/ledger-transaction.entity';
 import { ILedgerTransactionAttr } from './interfaces/ledger-transaction-attr.interface';
 import { ILedgerTransactionRepository } from './interfaces/ledger-transaction.repository.interface';
 

package/src/{account/entities → models}/account.entity.ts

@@ -1,171 +1,171 @@
-import { ApiProperty } from '@nestjs/swagger';
-import {
-  Column,
-  CreatedAt,
-  Model,
-  Table,
-  DataType,
-  UpdatedAt,
-  HasMany,
-} from 'sequelize-typescript';
-import { LedgerTransactionModel } from '../../ledger-transaction/entities/ledger-transaction.entity';
-import { PaymentModel } from '../../payment/entities/payment.entity';
-import { DocumentItemModel } from '../../document/entities/document-item.entity';
-@Table({ tableName: 'finance_Account', createdAt: false, updatedAt: false })
-export class AccountModel extends Model {
-  @ApiProperty({ type: String, description: 'AccountNo' })
-  @Column({
-    primaryKey: true,
-    allowNull: false,
-    type: DataType.STRING(30),
-  })
-  AccountNo: string;
-
-  //copy from finance account migration table
-  @ApiProperty({ type: String, description: 'Parent account of this object' })
-  @Column({
-    type: DataType.STRING(30),
-  })
-  ParentAccountNo: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'System Code eg. "EZC", "CRM"',
-  })
-  @Column({
-    allowNull: false,
-    type: DataType.STRING(10),
-  })
-  SystemCode: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Finance account system code eg. "quickbook"',
-  })
-  @Column({
-    allowNull: false,
-    type: DataType.STRING(10),
-  })
-  AccSystemCode: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Account id in finance system',
-  })
-  @Column({
-    allowNull: false,
-    type: DataType.STRING(10),
-  })
-  AccSystemRefId: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Name of the account',
-  })
-  @Column({
-    allowNull: true,
-    type: DataType.STRING(200),
-  })
-  Name: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Account description',
-  })
-  @Column({
-    allowNull: true,
-    type: DataType.TEXT,
-  })
-  Description: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Account Type',
-  })
-  @Column({
-    allowNull: true,
-    type: DataType.STRING(100),
-  })
-  AccountType: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Account Sub Type',
-  })
-  @Column({
-    allowNull: true,
-    type: DataType.STRING(100),
-  })
-  AccountSubType: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Owner id of the account',
-  })
-  @Column({
-    allowNull: true,
-    type: DataType.STRING(30),
-  })
-  OwnerId: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Owner type',
-  })
-  @Column({
-    allowNull: true,
-    type: DataType.STRING(200),
-  })
-  OwnerType: string;
-
-  @ApiProperty({ type: String, description: 'Associated Object id' })
-  @Column({
-    allowNull: true,
-    type: DataType.STRING(30),
-  })
-  RelatedObjectId: string;
-
-  @ApiProperty({ type: String, description: 'Associated Object type' })
-  @Column({
-    allowNull: true,
-    type: DataType.STRING(200),
-  })
-  RelatedObjectType: string;
-
-  @ApiProperty({
-    example: new Date(),
-    description: 'Timestamp for data creation.',
-  })
-  @CreatedAt
-  CreatedAt: Date;
-
-  @ApiProperty({
-    example: '138140891dd211b288d34bc7b4312a49',
-    description: 'The CreatedById for Media.',
-  })
-  @Column({ allowNull: false, type: DataType.STRING(30) })
-  CreatedById: string;
-
-  @ApiProperty({
-    example: new Date(),
-    description: 'Timestamp for latest data modification',
-  })
-  @UpdatedAt
-  UpdatedAt: Date;
-
-  @ApiProperty({
-    example: '138140891dd211b288d34bc7b4312a49',
-    description: 'The UpdatedById for Media.',
-  })
-  @Column({ allowNull: false, type: DataType.STRING(30) })
-  UpdatedById: string;
-
-  @HasMany(() => PaymentModel)
-  Payments: PaymentModel[];
-
-  @HasMany(() => DocumentItemModel)
-  DocumentItems: DocumentItemModel[];
-
-  @HasMany(() => LedgerTransactionModel)
-  LedgerTransactions: LedgerTransactionModel[];
-}
+import { ApiProperty } from '@nestjs/swagger';
+import {
+  Column,
+  CreatedAt,
+  Model,
+  Table,
+  DataType,
+  UpdatedAt,
+  HasMany,
+} from 'sequelize-typescript';
+import LedgerTransactionModel from './ledger-transaction.entity';
+import PaymentModel from './payment.entity';
+import DocumentItemModel from './document-item.entity';
+
+@Table({ tableName: 'finance_Account', createdAt: false, updatedAt: false })
+export default class AccountModel extends Model {
+  @ApiProperty({ type: String, description: 'AccountNo' })
+  @Column({
+    primaryKey: true,
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  AccountNo: string;
+
+  @ApiProperty({ type: String, description: 'Parent account of this object' })
+  @Column({
+    type: DataType.STRING(30),
+  })
+  ParentAccountNo: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'System Code eg. "EZC", "CRM"',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  SystemCode: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Finance account system code eg. "quickbook"',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  AccSystemCode: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account id in finance system',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  AccSystemRefId: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Name of the account',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(200),
+  })
+  Name: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account description',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.TEXT,
+  })
+  Description: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account Type',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(100),
+  })
+  AccountType: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account Sub Type',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(100),
+  })
+  AccountSubType: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Owner id of the account',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(30),
+  })
+  OwnerId: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Owner type',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(200),
+  })
+  OwnerType: string;
+
+  @ApiProperty({ type: String, description: 'Associated Object id' })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(30),
+  })
+  RelatedObjectId: string;
+
+  @ApiProperty({ type: String, description: 'Associated Object type' })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(200),
+  })
+  RelatedObjectType: string;
+
+  @ApiProperty({
+    example: new Date(),
+    description: 'Timestamp for data creation.',
+  })
+  @CreatedAt
+  CreatedAt: Date;
+
+  @ApiProperty({
+    example: '138140891dd211b288d34bc7b4312a49',
+    description: 'The CreatedById for Media.',
+  })
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  CreatedById: string;
+
+  @ApiProperty({
+    example: new Date(),
+    description: 'Timestamp for latest data modification',
+  })
+  @UpdatedAt
+  UpdatedAt: Date;
+
+  @ApiProperty({
+    example: '138140891dd211b288d34bc7b4312a49',
+    description: 'The UpdatedById for Media.',
+  })
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  UpdatedById: string;
+
+  @HasMany(() => PaymentModel)
+  Payments: PaymentModel[];
+
+  @HasMany(() => DocumentItemModel)
+  DocumentItems: DocumentItemModel[];
+
+  @HasMany(() => LedgerTransactionModel)
+  LedgerTransactions: LedgerTransactionModel[];
+}