@tomei/finance 0.1.1 → 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.1",
+  "version": "0.1.2",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {
@@ -70,6 +70,6 @@
     ]
   },
   "dependencies": {
-    "@tomei/general": "^0.0.3"
+    "@tomei/general": "^0.0.7"
   }
 }

package/src/account/account.ts

@@ -1,10 +1,11 @@
-import { IAccountSystem, RelatedObject, Owner } from 'src/base';
+import { RelatedObject, Owner } from '../base';
 import { ICreateAccountAttr } from './interfaces/account-attr.interface';
 import { IAccountRepository } from './interfaces/account.repository.interface';
 import * as uniqid from 'uniqid';
 import { AccountModel } from './entities/account.entity';
 import axios from 'axios';
-import { getConfig } from 'src/config';
+import { getConfig } from '../config';
+import { IAccountSystem } from 'src/interfaces';
 export class Account {
   accountRepository: IAccountRepository;
 

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/{owner/base.owner.ts → base.owner.ts}

@@ -52,4 +52,8 @@ export class Owner extends PersonBase {
       Name: this.Name,
     };
   }
+
+  getDefaultAddress() {
+    return this.Address;
+  }
 }

package/src/base/index.ts

@@ -1,5 +1,4 @@
-import { IAccountSystem } from './account-system.interface';
-import { RelatedObject } from '../base/object/base.object';
-import { Owner } from '../base/owner/base.owner';
-
-export { IAccountSystem, RelatedObject, Owner };
+import { RelatedObject } from './base.object';
+import { Owner } from './base.owner';
+import { Address } from './base.address';
+export { RelatedObject, Owner, Address };

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;
+    }
+  }
+}

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

@@ -0,0 +1,23 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Column, DataType, Model, Table } from 'sequelize-typescript';
+
+@Table({ tableName: 'finance_Customer', createdAt: false, updatedAt: false })
+export class FinanceCustomerModel extends Model {
+  @ApiProperty({ type: String, description: 'CustomerId' })
+  @Column({
+    primaryKey: true,
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  CustomerId: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account System Id eg. "EZC", "CRM"',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  AccSystemId: string;
+}

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

@@ -0,0 +1,20 @@
+import { InjectModel } from '@nestjs/sequelize';
+import { FinanceCustomerModel } from './entities/customer.entity';
+import { IFinanceCustomerAttr } from './interfaces/finance-customer-attr.interface';
+import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
+
+export class FinanceCustomerRepository
+  implements IFinanceCustomerRepository<FinanceCustomerModel>
+{
+  constructor(
+    @InjectModel(FinanceCustomerModel)
+    private readonly customerModel: typeof FinanceCustomerModel,
+  ) {}
+
+  create(
+    data: IFinanceCustomerAttr | any,
+    options?: any,
+  ): Promise<FinanceCustomerModel> | any {
+    return this.customerModel.create(data, options);
+  }
+}

package/src/customer/index.ts

@@ -0,0 +1,15 @@
+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 {
+  IFinanceCustomerRepository,
+  IFinanceCustomerAttr,
+  FinanceCustomerModel,
+  ICustomerRepository,
+  FinanceCustomerRepository,
+  Customer,
+};

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

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

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

@@ -0,0 +1,4 @@
+export interface IFinanceCustomerAttr {
+  CustomerId: string;
+  AccSystemId: string;
+}

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

@@ -0,0 +1,3 @@
+export interface IFinanceCustomerRepository<T> {
+  create?(data: T | any, options?: any): Promise<T> | any;
+}

package/src/index.ts

@@ -1,5 +1,7 @@
 export * from './base';
 export * from './account';
+export * from './customer';
 export * from './quickbook-client';
 export * from './enum';
+export * from './interfaces';
 export { getConfig } from './config';

package/src/{base → interfaces}/account-system.interface.ts

@@ -4,4 +4,5 @@ export interface IAccountSystem {
   createDebitNote(payload: any): Promise<any>;
   createCreditNote(payload: any): Promise<any>;
   postTransaction(payload: any): Promise<any>;
+  createCustomer(payload: any): Promise<any>;
 }

package/src/interfaces/index.ts

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

package/src/quickbook-client/client.ts

@@ -1,8 +1,9 @@
 import * as OAuthClient from 'intuit-oauth';
-import { IAccountSystem } from 'src/base';
-import { ClientScopes } from 'src/enum/quick-book-client-scopes.enum';
+import { ClientScopes } from '../enum/quick-book-client-scopes.enum';
+import { IAccountSystem } from '../interfaces';
 import { IQuickBookAPICallOptions } from './interfaces/quickbook-client-call-options.interface';
 import { IQuickBookCreateAccountOptions } from './interfaces/quickbook-client-create-account-options.interface';
+import { IQuickBookCreateCustomerOptions } from './interfaces/quickbook-client-create-customer-options.interface';
 import { IQuickBookClientOptions } from './interfaces/quickbook-client-options.interface';
 
 export class QuickBookClient implements IAccountSystem {
@@ -36,6 +37,41 @@ export class QuickBookClient implements IAccountSystem {
       throw error;
     }
   }
+
+  async createCustomer(payload: IQuickBookCreateCustomerOptions) {
+    try {
+      const requestBody = {
+        PrimaryEmailAddr: {
+          Address: payload.Email,
+        },
+        DisplayName: payload.FullName,
+        PrimaryPhone: {
+          FreeFormNumber: payload.ContractNo,
+        },
+        BillAddr: {
+          CountrySubDivisionCode: '',
+          City: payload.Address.City,
+          PostalCode: payload.Address.PostalCode,
+          Line1: payload.Address.Line1,
+          Country: payload.Address.Country,
+        },
+      };
+
+      const companyId = this.getCompanyId();
+      const response = await this.callApi({
+        endpoint: `/v3/company/${companyId}/customer?minorversion=65`,
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify(requestBody),
+      });
+      return response.json.Customer;
+    } catch (error) {
+      throw error;
+    }
+  }
+
   async createInvoice() {
     throw new Error('Method not implemented.');
   }

package/src/quickbook-client/index.ts

@@ -1,9 +1,10 @@
 import { QuickBookClient } from './client';
 import { IQuickBookCreateAccountOptions } from './interfaces/quickbook-client-create-account-options.interface';
 import { IQuickBookClientOptions } from './interfaces/quickbook-client-options.interface';
-
+import { IQuickBookCreateCustomerOptions } from './interfaces/quickbook-client-create-customer-options.interface';
 export {
   QuickBookClient,
   IQuickBookCreateAccountOptions,
   IQuickBookClientOptions,
+  IQuickBookCreateCustomerOptions,
 };

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

@@ -0,0 +1,8 @@
+import { AddressBase } from '@tomei/general';
+
+export interface IQuickBookCreateCustomerOptions {
+  FullName: string;
+  Email: string;
+  ContractNo: string;
+  Address: AddressBase;
+}