@tomei/finance 0.1.0 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "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.3"
   }
 }

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,10 @@
-import { ObjectBase, OwnerBase } from 'src/base';
+import { IAccountSystem, RelatedObject, Owner } from 'src/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 'src/config';
 export class Account {
   accountRepository: IAccountRepository;
 
@@ -13,8 +15,8 @@ export class Account {
   private AccSystemId: string;
 
   ParentAccountNo: string;
-  Owner: OwnerBase;
-  RelatedObject: ObjectBase;
+  Owner: Owner;
+  RelatedObject: RelatedObject;
   AccountType: string;
   AccountSubType: string;
 
@@ -28,7 +30,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 +45,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 +90,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 +125,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/account-system.interface.ts

@@ -1,7 +1,7 @@
 export interface IAccountSystem {
-  createAccount(): any;
-  createInvoice(): any;
-  createDebitNote(): any;
-  createCreditNote(): any;
-  postTransaction(): any;
+  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>;
 }

package/src/base/index.ts

@@ -1,7 +1,5 @@
 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';
+import { RelatedObject } from '../base/object/base.object';
+import { Owner } from '../base/owner/base.owner';
 
-export { IAccountSystem, ObjectBase, OwnerBase, IObject, IOwner };
+export { IAccountSystem, RelatedObject, Owner };

package/src/base/object/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/owner/base.owner.ts

@@ -0,0 +1,55 @@
+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,
+    };
+  }
+}

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/index.ts

@@ -2,3 +2,4 @@ export * from './base';
 export * from './account';
 export * from './quickbook-client';
 export * from './enum';
+export { getConfig } from './config';

package/src/quickbook-client/client.ts

@@ -1,13 +1,15 @@
 import * as OAuthClient from 'intuit-oauth';
+import { IAccountSystem } from 'src/base';
 import { ClientScopes } from 'src/enum/quick-book-client-scopes.enum';
 import { IQuickBookAPICallOptions } from './interfaces/quickbook-client-call-options.interface';
-import { IQuickBookClientModuleOptions } from './interfaces/quickbook-client-options.interface';
+import { IQuickBookCreateAccountOptions } from './interfaces/quickbook-client-create-account-options.interface';
+import { IQuickBookClientOptions } from './interfaces/quickbook-client-options.interface';
 
-export class QuickBookClient {
+export class QuickBookClient implements IAccountSystem {
   client: OAuthClient;
   apiUrl: string;
 
-  constructor(options: IQuickBookClientModuleOptions) {
+  constructor(options: IQuickBookClientOptions) {
     this.client = new OAuthClient({
       clientId: options.clientId,
       clientSecret: options.clientSecret,
@@ -18,6 +20,35 @@ export class QuickBookClient {
     this.apiUrl = options.apiUrl;
   }
 
+  async createAccount(payload: IQuickBookCreateAccountOptions) {
+    try {
+      const companyId = this.getCompanyId();
+      const response = await this.callApi({
+        endpoint: `/v3/company/${companyId}/account`,
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify(payload),
+      });
+      return response.json.Account;
+    } catch (error) {
+      throw error;
+    }
+  }
+  async createInvoice() {
+    throw new Error('Method not implemented.');
+  }
+  async createDebitNote() {
+    throw new Error('Method not implemented.');
+  }
+  async createCreditNote() {
+    throw new Error('Method not implemented.');
+  }
+  async postTransaction() {
+    throw new Error('Method not implemented.');
+  }
+
   connect(scopes: ClientScopes[]): string {
     try {
       const authUrl = this.client.authorizeUri({

package/src/quickbook-client/index.ts

@@ -1,11 +1,9 @@
-import { QuickBookClientModule } from './quickbook-client.module';
-import { IQuickBookClientModuleOptions } from './interfaces/quickbook-client-options.interface';
-import { QUICKBOOK_CLIENT } from './constant';
 import { QuickBookClient } from './client';
+import { IQuickBookCreateAccountOptions } from './interfaces/quickbook-client-create-account-options.interface';
+import { IQuickBookClientOptions } from './interfaces/quickbook-client-options.interface';
 
 export {
-  QuickBookClientModule,
-  IQuickBookClientModuleOptions,
-  QUICKBOOK_CLIENT,
   QuickBookClient,
+  IQuickBookCreateAccountOptions,
+  IQuickBookClientOptions,
 };

package/src/quickbook-client/interfaces/quickbook-client-create-account-options.interface.ts

@@ -0,0 +1,9 @@
+export interface IQuickBookCreateAccountOptions {
+  Name: string;
+  AcctNum: string;
+  AccountType: string;
+  AccountSubType: string;
+  CurrencyRef?: string;
+  ParentRef?: string;
+  SubAccount?: boolean;
+}

package/src/quickbook-client/interfaces/quickbook-client-options.interface.ts

@@ -1,4 +1,4 @@
-export interface IQuickBookClientModuleOptions {
+export interface IQuickBookClientOptions {
   clientId: string;
   clientSecret: string;
   redirectUri: string;

package/src/base/base.repository.abstract.ts

@@ -1,28 +0,0 @@
-import { IBaseRepository } from './base.repository.interface';
-
-export abstract class BaseRepository<T> implements IBaseRepository<T> {
-  private model: any;
-  // private id: string;
-
-  protected constructor(model: any) {
-    this.model = model;
-  }
-
-  public async create(data: any, options?: any): Promise<T> {
-    return this.model.create(data, options);
-  }
-
-  public async findAll(options: any): Promise<T[]> {
-    return this.model.findAll(options);
-  }
-
-  public async findAllWithPagination(
-    options: any,
-  ): Promise<{ count: number; rows: T[] }> {
-    return this.model.findAndCountAll(options);
-  }
-
-  public async findOne(options: any): Promise<T> {
-    return this.model.findOne(options);
-  }
-}

package/src/base/base.repository.interface.ts

@@ -1,9 +0,0 @@
-export interface IBaseRepository<T> {
-  create(data: any | any, options?: any): Promise<T>;
-
-  findAll(options: any): Promise<T[]>;
-
-  findAllWithPagination(options: any): Promise<{ count: number; rows: T[] }>;
-
-  findOne(options: any): Promise<T>;
-}

package/src/base/object/base.object.abstract.ts

@@ -1,6 +0,0 @@
-import { IObject } from './object.interface';
-
-export abstract class ObjectBase implements IObject {
-  abstract Id: string;
-  abstract Type: string;
-}

package/src/base/object/object.interface.ts

@@ -1,4 +0,0 @@
-export interface IObject {
-  Id: string;
-  Type: string;
-}

package/src/base/owner/base.owner.abstract.ts

@@ -1,21 +0,0 @@
-import { ObjectBase } from '../object/base.object.abstract';
-import { IOwner } from './owner.interface';
-
-export abstract class OwnerBase extends ObjectBase implements IOwner {
-  abstract FullName: string;
-  abstract IDNo: string;
-  abstract IDType: string;
-  abstract Email: string;
-  abstract ContactNo: string;
-  abstract Address: string;
-  abstract getDetails(): {
-    FullName: string;
-    IDNo: string;
-    IDType: string;
-    Email: string;
-    ContactNo: string;
-    Address: string;
-    Id: string;
-    Type: string;
-  };
-}