@tomei/finance 0.2.4 → 0.2.6

package/migrations/finance-journal-entry-migration.js

@@ -28,7 +28,7 @@ module.exports = {
         type: Sequelize.CHAR(1),
         allowNull: false,
       },
-      DatePostedToAccSystem: {
+      PostedDateTime: {
         type: Sequelize.DATE,
         allowNull: true,
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {
@@ -35,6 +35,7 @@
     "@nestjs/platform-express": "^9.0.8",
     "@nestjs/sequelize": "^9.0.0",
     "@tomei/general": "^0.0.14",
+    "@tomei/media": "^0.4.0",
     "axios": "^1.1.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",
@@ -46,6 +47,7 @@
   },
   "devDependencies": {
     "@nestjs/swagger": "^6.0.4",
+    "@types/multer": "^1.4.7",
     "@types/node": "^18.0.6",
     "@types/sequelize": "^4.28.14",
     "@types/uniqid": "^5.3.2",

package/src/account/account.ts

@@ -2,7 +2,8 @@ import { IAccountRepository } from './interfaces/account.repository.interface';
 import { AccountModel } from './entities/account.entity';
 import { ObjectBase, PersonBase, RecordNotFoundError } from '@tomei/general';
 import { IBaseRepository } from '@tomei/general/dist/interfaces/repository.base.interface';
-export class Account {
+import { IAccountSystemEntity } from 'src/interfaces/account-system-entity.interface';
+export class Account implements IAccountSystemEntity {
   accountRepository: IAccountRepository;
   AccountNo: string;
   Owner: PersonBase;
@@ -14,15 +15,21 @@ export class Account {
   private RelatedObjectId: string;
   private RelatedObjectType: string;
   private ParentAccountNo: string;
-  private SystemCode: string;
-  private AccSystemAccountId: string;
-  private AccSystemCode: string;
-  private Name: string;
-  private Description: string;
-  private AccountType: string;
-  private AccountSubtype: string;
+  AccSystemRefId: string;
+
+  SystemCode: string;
+  AccSystemCode: string;
+  Name: string;
+  Description: string;
+  AccountType: string;
+  AccountSubtype: string;
+  PostedToAccSystemYN: 'N';
+  PostedById: string;
+  PostedDateTime: Date;
+
+  CreatedAt: Date;
+  CreatedById: string;
 
-  constructor();
   constructor(
     accountRepository?: IBaseRepository<AccountModel>,
     accountNo?: string,
@@ -38,7 +45,7 @@ export class Account {
         this.ParentAccountNo = accountData.ParentAccountNo;
         this.SystemCode = accountData.SystemCode;
         this.AccSystemCode = accountData.AccSystemCode;
-        this.AccSystemAccountId = accountData.AccSystemAccountId;
+        this.AccSystemRefId = accountData.AccSystemRefId;
         this.Name = accountData.Name;
         this.Description = accountData.Description;
         this.AccountType = accountData.AccountType;
@@ -80,7 +87,7 @@ export class Account {
     if (!this.AccSystemCode) {
       throw new Error('AccSystemCode is required.');
     }
-    if (!this.AccSystemAccountId) {
+    if (!this.AccSystemRefId) {
       throw new Error('AccSystemAccountId is required.');
     }
     if (!this.AccountType) {
@@ -94,17 +101,17 @@ export class Account {
   }
 
   async save(
-    accSystemAccountId: string,
+    AccSystemRefId: string,
     userId: string,
     dbTransaction?: any,
   ): Promise<AccountModel> {
-    this.AccSystemAccountId = accSystemAccountId;
+    this.AccSystemRefId = AccSystemRefId;
     const data = await this.accountRepository.create(
       {
         AccountNo: this.AccountNo,
         SystemCode: this.SystemCode,
         AccSystemCode: this.AccSystemCode,
-        AccSystemAccountId: this.AccSystemAccountId,
+        AccSystemRefId: this.AccSystemRefId,
         Name: this.Name,
         Description: this.Description,
         AccountType: this.AccountType,
@@ -132,7 +139,7 @@ export class Account {
       try {
         const account = await this.accountRepository.findOne({
           OwnerId: this.OwnerId,
-          AccSystemAccountId: this.AccSystemAccountId,
+          AccSystemRefId: this.AccSystemRefId,
         });
 
         if (account) {

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

@@ -56,7 +56,7 @@ export class AccountModel extends Model {
     allowNull: false,
     type: DataType.STRING(10),
   })
-  AccSystemAccountId: string;
+  AccSystemRefId: string;
 
   @ApiProperty({
     type: String,

package/src/customer/customer.ts

@@ -1,36 +1,50 @@
-import { AddressBase, PersonBase } from '@tomei/general';
-import { IAccountSystem } from '../interfaces';
-import { getConfig } from '../config';
-import * as cuid from 'cuid';
+import { AddressBase, PersonBase, RecordNotFoundError } from '@tomei/general';
+import { FinanceCustomerModel } from './entities/customer.entity';
+import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
 
 export abstract class Customer extends PersonBase {
-  ObjectId: string; // Finance_Customer.CustomerId
-  ObjectName: string;
-
-  AccSystemCustomerId: string; //customer id return from accounting system
-  CustomerRefId: string | undefined; //CRM customer CustomerId
-  SystemCode: string;
-  AccSystemCode: string;
-
   FullName: string;
   IDNo: string;
   IDType: string;
-  public Email: string;
   ContactNo: string;
+  Email: string;
   DefaultAddress: AddressBase;
 
-  accountingSystem: IAccountSystem;
+  financeCustomerRepository: IFinanceCustomerRepository;
+
+  CustomerId: string;
+
+  SystemCode: string;
+  AccSystemCode: string;
+  AccSystemCustomerId: string; //customer id return from accounting system
+  CustSystemCode: string;
+  CustSystemRefId: string;
 
   constructor(
-    accountingSystem: IAccountSystem,
     systemCode: string,
-    email: string,
+    accSystemCode: string,
+    custSystemCode: string,
+    custSystemRefId: string,
   ) {
     super();
-    this.accountingSystem = accountingSystem;
-    this.SystemCode = systemCode;
-    this.AccSystemCode = getConfig().systemConfig[systemCode].accountingSystem;
-    this.Email = email;
+    const financeCustomerData = this.financeCustomerRepository.findOne({
+      where: {
+        SystemCode: systemCode,
+        AccSystemCode: accSystemCode,
+        AccSystemCustomerId: custSystemCode,
+        CustomerRefId: custSystemRefId,
+      },
+    });
+    if (financeCustomerData) {
+      this.CustomerId = financeCustomerData.CustomerId;
+      this.AccSystemCode = accSystemCode;
+      this.AccSystemCustomerId = financeCustomerData.AccSystemCustomerId;
+      this.CustSystemCode = custSystemCode;
+      this.CustSystemRefId = custSystemRefId;
+    } else {
+      const notFoundError = new RecordNotFoundError('No Record Found');
+      throw notFoundError;
+    }
   }
 
   /*
@@ -63,33 +77,20 @@ export abstract class Customer extends PersonBase {
     this.DefaultAddress = person.DefaultAddress;
   }
 
-  /**
-   *
-   * @returns {string} - Return Finance CustomerId
-   */
-  getCustomerId(): string {
-    if (!this.ObjectId) {
-      throw new Error('Finance Customer must be created first.');
-    }
-    return this.ObjectId;
-  }
-
-  /**
-   * Create customer in accounting system
-   *
-   */
-  async create() {
-    try {
-      this.AccSystemCustomerId = await this.accountingSystem.createCustomer({
-        FullName: this.FullName,
-        Email: this.Email,
-        ContractNo: this.ContactNo,
-        DefaultAddress: this.DefaultAddress,
-      });
-
-      this.ObjectId = cuid();
-    } catch (error) {
-      throw error;
-    }
+  async save(
+    customerId: string,
+    dbTransaction?: any,
+  ): Promise<FinanceCustomerModel> {
+    const data = await this.financeCustomerRepository.create(
+      {
+        CustomerId: customerId,
+        SystemCode: this.SystemCode,
+        AccSystemCode: this.SystemCode,
+        AccSystemCustomerId: this.AccSystemCustomerId,
+        CustomerRefId: this.CustSystemRefId,
+      },
+      dbTransaction,
+    );
+    return data;
   }
 }

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

@@ -1,20 +1,28 @@
 import { InjectModel } from '@nestjs/sequelize';
+import { BaseRepository } from '@tomei/general';
 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>
+  extends BaseRepository<FinanceCustomerModel>
+  implements IFinanceCustomerRepository
 {
   constructor(
     @InjectModel(FinanceCustomerModel)
-    private readonly customerModel: typeof FinanceCustomerModel,
-  ) {}
+    private readonly financeCustomerModel: typeof FinanceCustomerModel,
+  ) {
+    super(financeCustomerModel);
+  }
 
   create(
     data: IFinanceCustomerAttr | any,
     options?: any,
   ): Promise<FinanceCustomerModel> | any {
-    return this.customerModel.create(data, options);
+    return this.financeCustomerModel.create(data, options);
+  }
+
+  findOne(options: any): Promise<FinanceCustomerModel> {
+    return this.financeCustomerModel.findOne(options);
   }
 }

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

@@ -1,3 +1,4 @@
-export interface IFinanceCustomerRepository<T> {
-  create?(data: T | any, options?: any): Promise<T> | any;
-}
+import { IBaseRepository } from '@tomei/general';
+import { FinanceCustomerModel } from '../entities/customer.entity';
+
+export type IFinanceCustomerRepository = IBaseRepository<FinanceCustomerModel>;

package/src/document/document.ts

@@ -0,0 +1,171 @@
+import * as util from 'util';
+import * as fs from 'fs';
+import { ObjectBase } from '@tomei/general';
+import {
+  Medias,
+  InternalMediaDto,
+  IMediasRepository,
+  CommonService as MediaCommonService,
+  MediaType,
+} from '@tomei/media';
+import { DocumentStatus, DocType } from 'src/enum';
+import { DocumentRepository } from './document.repository';
+import { IDocumentAttr } from './interfaces/document-attr.interface';
+import { IAccountSystemEntity } from 'src/interfaces/account-system-entity.interface';
+
+export class Document extends ObjectBase implements IAccountSystemEntity {
+  ObjectId: string;
+  ObjectName: string;
+
+  DocNo: string;
+  DocType: DocType;
+  DocDate: Date;
+  SystemCode: string;
+  Currency: string;
+  Amount: number;
+  Description: string;
+  IssuedById: string;
+  IssuedToId: string;
+  IssuedToType: string;
+  AccSystemCode: string;
+  PostedToAccSystemYN = 'N';
+  PostedById: string;
+  PostedDateTime: Date;
+  AccSystemRefId: string;
+  UseAccSystemDocYN: string;
+  private DocHTMLFilePath: string;
+  private DocPDFFilePath: string;
+  private Status: DocumentStatus;
+
+  documentRepository: DocumentRepository;
+  mediaRepository: IMediasRepository;
+  mediaCommonService: MediaCommonService;
+
+  public get InvoiceInHTML() {
+    return (async () => {
+      this.DocHTMLFilePath = './invoice-template/index.html';
+      const readFileContent = util.promisify(fs.readFile);
+      const htmlBuffer = await readFileContent(this.DocHTMLFilePath);
+
+      const htmlStream: Express.Multer.File = {
+        buffer: htmlBuffer,
+        fieldname: 'FileStream',
+        originalname: 'index.html',
+        mimetype: 'text/html',
+        size: htmlBuffer.length,
+        encoding: '8bit',
+        filename: 'sample-invoice.html',
+        destination: '',
+        path: '',
+        stream: null,
+      };
+
+      return htmlStream;
+    })();
+  }
+
+  public get InvoiceInPDF() {
+    return (async () => {
+      this.DocPDFFilePath = './invoice-template/sample-invoice.pdf';
+      const readFileContent = util.promisify(fs.readFile);
+      const pdfBuffer = await readFileContent(this.DocPDFFilePath);
+
+      const pdfStream: Express.Multer.File = {
+        buffer: pdfBuffer,
+        fieldname: 'FileStream',
+        originalname: 'sample-invoice.[df]',
+        mimetype: 'application/pdf',
+        size: pdfBuffer.length,
+        encoding: '8bit',
+        filename: 'sample-invoice.pdf',
+        destination: '',
+        path: '',
+        stream: null,
+      };
+
+      return pdfStream;
+    })();
+  }
+
+  get objectId(): string {
+    return this.ObjectId;
+  }
+  get objectName(): string {
+    return this.ObjectName;
+  }
+
+  init(params: IDocumentAttr) {
+    this.DocNo = params.DocNo;
+    this.DocType = params.DocType;
+    this.DocDate = params.DocDate;
+    this.SystemCode = params.SystemCode;
+    this.Currency = params.Currency;
+    this.Amount = params.Amount;
+    this.Description = params.Description;
+    this.Status = params.Status;
+    this.IssuedById = params.IssuedById;
+    this.IssuedToId = params.IssuedToId;
+    this.IssuedToType = params.IssuedToType;
+    this.AccSystemCode = params.AccSystemCode;
+    this.PostedToAccSystemYN = params.PostedToAccSystemYN;
+    this.UseAccSystemDocYN = params.UseAccSystemDocYN;
+    this.DocPDFFilePath = params.DocPDFFilePath;
+    this.DocHTMLFilePath = params.DocHTMLFilePath;
+  }
+
+  async generateInvoice(userId?: string): Promise<void> {
+    const media: Medias = new Medias(
+      this.mediaRepository,
+      this.mediaCommonService,
+    );
+
+    const htmlPayload: InternalMediaDto = {
+      ObjectId: this.DocNo,
+      ObjectType: this.DocType,
+      Type: MediaType.Document,
+      FileName: `${this.DocType}-${this.DocNo}`,
+      FileStream: '',
+      FileExtension: 'HTML',
+      Title: `${this.DocType}-${this.DocNo}.html`,
+      Description: `HTML ${this.DocType}`,
+      IsEncryptedYN: 'N',
+    };
+    await media.postInternal(
+      await this.InvoiceInHTML,
+      htmlPayload,
+      userId ?? 'System',
+    );
+
+    const pdfPayload: InternalMediaDto = {
+      ObjectId: this.DocNo,
+      ObjectType: this.DocType,
+      Type: MediaType.Document,
+      FileName: `${this.DocType}-${this.DocNo}`,
+      FileStream: '',
+      FileExtension: 'PDF',
+      Title: `${this.DocType}-${this.DocNo}.pdf`,
+      Description: `PDF ${this.DocType}`,
+      IsEncryptedYN: 'N',
+    };
+
+    await media.postInternal(
+      await this.InvoiceInPDF,
+      pdfPayload,
+      userId ?? 'System',
+    );
+
+    try {
+      const document = await this.documentRepository.findOne({
+        where: {
+          DocNo: this.DocNo,
+        },
+      });
+
+      document.DocHTMLFilePath = this.DocHTMLFilePath;
+      document.DocPDFFilePath = this.DocPDFFilePath;
+      await document.save();
+    } catch (err) {
+      console.log(err);
+    }
+  }
+}

package/src/document/entities/document.entity.ts

@@ -1,5 +1,5 @@
 import { Column, DataType, HasMany, Model, Table } from 'sequelize-typescript';
-import { DocumentType, DocumentStatus } from '../../enum';
+import { DocType, DocumentStatus } from '../../enum';
 import { DocumentItemModel } from './document-item.entity';
 
 @Table({ tableName: 'finance_Document', timestamps: false })
@@ -15,7 +15,7 @@ export class DocumentModel extends Model {
     allowNull: false,
     type: DataType.STRING(30),
   })
-  DocType: DocumentType;
+  DocType: DocType;
 
   @Column({
     allowNull: false,

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

@@ -1,8 +1,8 @@
-import { DocumentType, DocumentStatus } from '../../enum';
+import { DocType, DocumentStatus } from '../../enum';
 
 export class IDocumentAttr {
   DocNo: string;
-  DocType: DocumentType;
+  DocType: DocType;
   DocDate: Date;
   SystemCode: string;
   Currency: string;
@@ -13,7 +13,7 @@ export class IDocumentAttr {
   IssuedToId: string;
   IssuedToType: string;
   AccSystemCode: string;
-  PostedToAccYN: string;
+  PostedToAccSystemYN: string;
   UseAccSystemDocYN: string;
   DocPDFFilePath: string;
   DocHTMLFilePath: string;

package/src/enum/{document-type.enum.ts → doc-type.enum.ts}

@@ -1,7 +1,7 @@
-export enum DocumentType {
+export enum DocType {
   INVOICE = 'Invoice',
   DEBIT_NOTE = 'Debit Note',
   CREDIT_NOTE = 'Credit Note',
   QUOTATION = 'Quotation',
   RECEIPT = 'Receipt',
-}
+}

package/src/enum/index.ts

@@ -2,7 +2,7 @@ import { ClientScopes } from './quick-book-client-scopes.enum';
 import { PaymentType } from './payment-type.enum';
 import { PaymentMethod } from './payment-method.enum';
 import { TransactionTypeOptions } from './transaction-type.enum';
-import { DocumentType } from './document-type.enum';
+import { DocType } from './doc-type.enum';
 import { DocumentStatus } from './document-status.enum';
 
 export {
@@ -10,6 +10,6 @@ export {
   PaymentType,
   PaymentMethod,
   TransactionTypeOptions,
-  DocumentType,
+  DocType,
   DocumentStatus,
 };