@tomei/finance 0.3.0 → 0.3.2

package/src/account-system-entity/post-history.repository.ts

@@ -1,9 +1,9 @@
-import { BaseRepository, IBaseRepository } from '@tomei/general';
+import { RepositoryBase, IRepositoryBase } from '@tomei/general';
 import FinancePostHistoryModel from '../models/post-history.entity';
 
 export class PostHistoryRepository
-  extends BaseRepository<FinancePostHistoryModel>
-  implements IBaseRepository<FinancePostHistoryModel>
+  extends RepositoryBase<FinancePostHistoryModel>
+  implements IRepositoryBase<FinancePostHistoryModel>
 {
   constructor() {
     super(FinancePostHistoryModel);

package/src/customer/customer.ts

@@ -1,6 +1,6 @@
 import {
   IAddress,
-  IBaseRepository,
+  IRepositoryBase,
   IPerson,
   LoginUserBase,
   RecordNotFoundError,
@@ -10,7 +10,7 @@ import { IFinanceCustomerRepository } from './interfaces/finance-customer.reposi
 import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
 
 // const AccountSystemEntity = import('../account-system-entity').then(({AccountSystemEntity}) => AccountSystemEntity);
-export abstract class FinanceCustomerBase
+export default abstract class FinanceCustomerBase
   extends AccountSystemEntity
   implements IPerson
 {
@@ -43,7 +43,7 @@ export abstract class FinanceCustomerBase
   CustomerId: string;
   CustSystemCode: string;
   CustSystemRefId: string;
-  BaseRepository: IBaseRepository<any>;
+  RepositoryBase: IRepositoryBase<any>;
 
   constructor(
     custSystemRefId: string,

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

@@ -1,13 +1,13 @@
 import { Injectable } from '@nestjs/common/decorators';
 import { InjectModel } from '@nestjs/sequelize';
-import { BaseRepository } from '@tomei/general';
+import { RepositoryBase } from '@tomei/general';
 import FinanceCustomerModel from '../models/customer.entity';
 import { IFinanceCustomerAttr } from './interfaces/finance-customer-attr.interface';
 import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
 
 @Injectable()
 export class FinanceCustomerRepository
-  extends BaseRepository<FinanceCustomerModel>
+  extends RepositoryBase<FinanceCustomerModel>
   implements IFinanceCustomerRepository
 {
   constructor(

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

@@ -1,4 +1,4 @@
-import { IBaseRepository } from '@tomei/general';
+import { IRepositoryBase } from '@tomei/general';
 import FinanceCustomerModel from '../../models/customer.entity';
 
-export type IFinanceCustomerRepository = IBaseRepository<FinanceCustomerModel>;
+export type IFinanceCustomerRepository = IRepositoryBase<FinanceCustomerModel>;

package/src/document/document-item.repository.ts

@@ -1,49 +1,11 @@
-import { Injectable } from '@nestjs/common';
-import { InjectModel } from '@nestjs/sequelize';
-import { BaseRepository } from '@tomei/general';
+import { RepositoryBase, IRepositoryBase } from '@tomei/general';
 import DocumentItemModel from '../models/document-item.entity';
-import { IDocumentItemAttr } from './interfaces/document-item-attr.interface';
-import { IDocumentItemRepository } from './interfaces/document-item.repository.interface';
 
-@Injectable()
 export class DocumentItemRepository
-  extends BaseRepository<DocumentItemModel>
-  implements IDocumentItemRepository
+  extends RepositoryBase<DocumentItemModel>
+  implements IRepositoryBase<DocumentItemModel>
 {
-  constructor(
-    @InjectModel(DocumentItemModel)
-    private readonly documentItemModel: typeof DocumentItemModel,
-  ) {
-    super(documentItemModel);
-  }
-
-  create(
-    data: IDocumentItemAttr,
-    options?: any,
-  ): Promise<DocumentItemModel> | any {
-    return this.documentItemModel.create({ ...data }, options);
-  }
-
-  bulkCreate(data: IDocumentItemAttr[], options?: any): any {
-    const payload: any = [...data];
-    return this.documentItemModel.bulkCreate(payload, options);
-  }
-
-  findAll(options: any): Promise<DocumentItemModel[]> {
-    return this.documentItemModel.findAll(options);
-  }
-
-  findAllWithPagination(
-    options: any,
-  ): Promise<{ count: number; rows: DocumentItemModel[] }> {
-    return this.documentItemModel.findAndCountAll(options);
-  }
-
-  findOne(options: any): Promise<DocumentItemModel> {
-    return this.documentItemModel.findOne(options);
-  }
-
-  update(data: IDocumentItemAttr, options?: any): any {
-    return this.documentItemModel.update({ ...data }, options);
+  constructor() {
+    super(DocumentItemModel);
   }
 }

package/src/document/document-item.ts

@@ -1,4 +1,6 @@
-export class DocumentItem {
+import { DocumentItemRepository } from './document-item.repository';
+
+export default class DocumentItem {
   DocumentItemId: string;
   DocNo: string;
   Name: string;
@@ -19,4 +21,6 @@ export class DocumentItem {
   TaxInclusiveYN?: string;
   DtAccountNo?: string;
   CtAccountNo?: string;
+
+  constructor(dbTransaction?: any, documentItemId?: string) {}
 }

package/src/document/document.repository.ts

@@ -1,41 +1,11 @@
-import { Injectable } from '@nestjs/common';
-import { InjectModel } from '@nestjs/sequelize';
-import { BaseRepository } from '@tomei/general';
+import { RepositoryBase, IRepositoryBase } from '@tomei/general';
 import DocumentModel from '../models/document.entity';
-import { IDocumentAttr } from './interfaces/document-attr.interface';
-import { IDocumentRepository } from './interfaces/document.repository.interface';
 
-@Injectable()
 export class DocumentRepository
-  extends BaseRepository<DocumentModel>
-  implements IDocumentRepository
+  extends RepositoryBase<DocumentModel>
+  implements IRepositoryBase<DocumentModel>
 {
-  constructor(
-    @InjectModel(DocumentModel)
-    private readonly documentModel: typeof DocumentModel,
-  ) {
-    super(documentModel);
-  }
-
-  create(data: IDocumentAttr, options?: any): Promise<DocumentModel> | any {
-    return this.documentModel.create({ ...data }, options);
-  }
-
-  findAll(options: any): Promise<DocumentModel[]> {
-    return this.documentModel.findAll(options);
-  }
-
-  findAllWithPagination(
-    options: any,
-  ): Promise<{ count: number; rows: DocumentModel[] }> {
-    return this.documentModel.findAndCountAll(options);
-  }
-
-  findOne(options: any): Promise<DocumentModel> {
-    return this.documentModel.findOne(options);
-  }
-
-  update(data: IDocumentAttr, options?: any): any {
-    return this.documentModel.update({ ...data }, options);
+  constructor() {
+    super(DocumentModel);
   }
 }

package/src/document/document.ts

@@ -1,7 +1,7 @@
 import * as util from 'util';
 import * as fs from 'fs';
 import puppeteer from 'puppeteer';
-import { IBaseRepository, RecordNotFoundError } from '@tomei/general';
+import { RecordNotFoundError } from '@tomei/general';
 import {
   Medias,
   InternalMediaDto,
@@ -13,52 +13,55 @@ import {
 import { DocumentStatus, DocType } from '../enum';
 import { IDocumentAttr } from './interfaces/document-attr.interface';
 import { DocumentItemRepository } from './document-item.repository';
-import { DocumentItem } from './document-item';
-import { IDocumentRepository } from './interfaces/document.repository.interface';
+import DocumentItem from './document-item';
 import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
-import DocumentModel from '../models/document.entity';
+import { DocumentRepository } from './document.repository';
+import FinanceCompany from '../finance-company/finance-company';
+import FinanceCustomerBase from '../customer/customer';
 
-export class Document extends AccountSystemEntity {
+export default class Document extends AccountSystemEntity {
   DocNo: string;
   private _DocType: DocType;
-  private _DocDate: Date = new Date();
+  private _DocDate = new Date();
   Currency: string;
   Amount: number;
   Description: string;
+  private _Status = DocumentStatus.UNPAID;
   IssuedById: string;
   IssuedToId: string;
   IssuedToType: string;
   CreatedById: string;
   CreatedAt: Date;
-  UpdatedById?: string;
-  UpdatedAt?: Date;
+  UpdatedById: string;
+  UpdatedAt: Date;
   UseAccSystemDocYN: string;
 
-  private _documentRepository: IBaseRepository<DocumentModel> =
-    new DocumentModel();
-  protected _BaseRepository: IBaseRepository;
-
-  _ObjectId: string;
-  _ObjectName: string;
-  _TableName: string;
-
   private _DocHTMLFileMediaId: string;
   private _DocPDFFileMediaId: string;
-  private _Status: DocumentStatus = DocumentStatus.UNPAID;
 
-  private IsNewRecord = true;
-  private _DocumentItems: any;
+  private static _RepositoryBase = new DocumentRepository();
+  private static _DocumentItemRepository = new DocumentItemRepository();
+
+  private _DbTransaction: any;
+  private _IsNewRecord = true;
+  private _DocumentItems = null;
 
-  documentRepository: IDocumentRepository;
-  documentItemRepository: DocumentItemRepository;
   mediaRepository: IMediasRepository;
   mediaCommonService: MediaCommonService;
 
+  private get IsNewRecord() {
+    return this._IsNewRecord;
+  }
+
+  private set IsNewRecord(record: boolean) {
+    this._IsNewRecord = record;
+  }
+
   public get DocType() {
     return this._DocType;
   }
 
-  private set DocType(docType: DocType) {
+  public set DocType(docType: DocType) {
     this._DocType = docType;
   }
 
@@ -95,80 +98,121 @@ export class Document extends AccountSystemEntity {
   }
 
   /* AccountSystemEntity Implementation */
-  override get BaseRepository() {
-    return this._documentRepository;
+  get RepositoryBase() {
+    return Document._RepositoryBase;
   }
 
   /* ObjectBase Implementation */
-  override get ObjectId() {
+  get ObjectId() {
     return this.DocNo;
   }
 
-  override get ObjectName() {
+  get ObjectName() {
     return this.DocNo;
   }
 
-  override get TableName() {
+  get TableName() {
     return 'finance_Document';
   }
 
-  constructor(dbTransaction: any);
-  constructor(dbTransaction: any, docNo?: string) {
+  constructor(dbTransaction?: any, docNo?: string) {
     super();
-    const documentData = this.BaseRepository.findOne({
-      where: {
-        DocNo: docNo,
-      },
-      transaction: dbTransaction,
-    });
-    if (documentData) {
-      this.IsNewRecord = false;
-      this.DocType = documentData.DocType;
-      this.DocDate = documentData.DocDate;
-      this.CompanyId = documentData.CompanyId;
-      this.Currency = documentData.Currency;
-      this.Amount = documentData.Amount;
-      this.Description = documentData.Description;
-      this.Status = documentData.Status;
-      this.IssuedById = documentData.IssuedById;
-      this.IssuedToId = documentData.IssuedToId;
-      this.IssuedToType = documentData.IssuedToType;
-      this.CreatedById = documentData.CreatedById;
-      this.CreatedAt = documentData.CreatedAt;
-      this.UpdatedById = documentData.UpdatedById;
-      this.UpdatedAt = documentData.UpdatedAt;
-      this.DocPDFFileMediaId = documentData.DocPDFFileMediaId;
-      this.DocHTMLFileMediaId = documentData.DocHTMLFileMediaId;
-      this.AccSystemRefId = documentData.AccSystemRefId;
-      this.PostedToAccSystemYN = documentData.PostedToAccSystemYN;
-      this.PostedById = documentData.PostedById;
-      this.PostedDateTime = documentData.PostedDateTime;
-      this.UseAccSystemDocYN = documentData.UseAccSystemDocYN;
-    } else {
-      const notFoundError = new RecordNotFoundError('No Record Found.');
-      throw notFoundError;
+    if (dbTransaction) {
+      this._DbTransaction = dbTransaction;
+    }
+    if (docNo) {
+      this.RepositoryBase.findOne({
+        where: {
+          DocNo: docNo,
+        },
+        transaction: dbTransaction,
+      })
+        .then((documentData) => {
+          if (documentData) {
+            this.IsNewRecord = false;
+            this.DocType = documentData.DocType;
+            this.DocDate = documentData.DocDate;
+            this.CompanyId = documentData.CompanyId;
+            this.Currency = documentData.Currency;
+            this.Amount = documentData.Amount;
+            this.Description = documentData.Description;
+            this.Status = documentData.Status;
+            this.IssuedById = documentData.IssuedById;
+            this.IssuedToId = documentData.IssuedToId;
+            this.IssuedToType = documentData.IssuedToType;
+            this.CreatedById = documentData.CreatedById;
+            this.CreatedAt = documentData.CreatedAt;
+            this.UpdatedById = documentData.UpdatedById;
+            this.UpdatedAt = documentData.UpdatedAt;
+            this.DocPDFFileMediaId = documentData.DocPDFFileMediaId;
+            this.DocHTMLFileMediaId = documentData.DocHTMLFileMediaId;
+            this.AccSystemRefId = documentData.AccSystemRefId;
+            this.PostedToAccSystemYN = documentData.PostedToAccSystemYN;
+            this.PostedById = documentData.PostedById;
+            this.PostedDateTime = documentData.PostedDateTime;
+            this.UseAccSystemDocYN = documentData.UseAccSystemDocYN;
+          } else {
+            const notFoundError = new RecordNotFoundError('No Record Found.');
+            throw notFoundError;
+          }
+        })
+        .catch((err) => {
+          // tslint:disable-next-line:no-console
+          console.log('Document Class constructor err: ', err);
+        });
     }
   }
 
-  public get DocumentItems() {
-    // this._DocumentItems = new DocumentItem();
-    if (this._DocumentItems === null) {
+  get DocumentItems(): Promise<DocumentItem[]> {
+    return new Promise((resolve, reject) => {
       if (!this.IsNewRecord) {
-        this.documentItemRepository
+        Document._DocumentItemRepository
           .findAll({
             where: {
               DocNo: this.DocNo,
             },
+            transaction: this._DbTransaction,
+          })
+          .then((documentItems) => {
+            const documentItemObjects = documentItems.map((documentItem) => {
+              new DocumentItem(
+                this._DbTransaction,
+                documentItem.DocumentItemId,
+              );
+            });
+            return Promise.all(documentItemObjects);
           })
-          .then((allDocumentItems) => {
-            this._DocumentItems = allDocumentItems;
+          .then((documentItemObjects) => {
+            this._DocumentItems = documentItemObjects;
+            resolve(this._DocumentItems);
+          })
+          .catch((err) => {
+            reject(err);
           });
       }
-    }
-
-    return this._DocumentItems;
+      resolve(this._DocumentItems);
+    });
   }
 
+  // public get DocumentItems() {
+  //   // this._DocumentItems = new DocumentItem();
+  //   if (this._DocumentItems === null) {
+  //     if (!this.IsNewRecord) {
+  //       Document._DocumentItemRepository
+  //         .findAll({
+  //           where: {
+  //             DocNo: this.DocNo,
+  //           },
+  //         })
+  //         .then((allDocumentItems) => {
+  //           this._DocumentItems = allDocumentItems;
+  //         });
+  //     }
+  //   }
+
+  //   return this._DocumentItems;
+  // }
+
   /**
    * Returns HTML template file for invoice generation
    *
@@ -315,10 +359,16 @@ export class Document extends AccountSystemEntity {
    * @see DocumentFileInHTML - for implementation
    * @see DocumentFileInPDF - for implementation
    *
+   * @see {@link FinanceCompany.issueInvoice} - for implementation
+   *
    * @param userId - userId that trigger this function
+   *
    * @returns {MediasModel} - HTML & PDF Media
    */
-  async generateInvoice(userId?: string): Promise<{
+  async generateInvoice(
+    userId?: string,
+    customer?: FinanceCustomerBase,
+  ): Promise<{
     HTMLMedia: MediasModel;
     PDFMedia: MediasModel;
   }> {
@@ -328,6 +378,7 @@ export class Document extends AccountSystemEntity {
     );
 
     /* todo: needs to manipulate HTML DOM before uploading to media*/
+    console.log(customer || 'no customer provided', '<< customer');
 
     /* insert FileStream on htmlPayload  */
     const htmlPayload: InternalMediaDto = {
@@ -370,7 +421,7 @@ export class Document extends AccountSystemEntity {
     );
 
     try {
-      const document = await this.documentRepository.findOne({
+      const document = await this.RepositoryBase.findOne({
         where: {
           DocNo: this.DocNo,
         },
@@ -391,15 +442,17 @@ export class Document extends AccountSystemEntity {
     };
   }
 
+  async generateCreditNote(userId?: string, customer?: FinanceCustomerBase) {}
+
   /**
    * Create a new Document Item which is automatically added to the DocumentItems list
    *
    * @returns {DocumentItem}
    */
-  async newDocumentItem(): Promise<DocumentItem> {
+  get NewDocumentItem(): DocumentItem {
     const documentItem = new DocumentItem();
     documentItem.DocNo = this.DocNo;
-    this.DocumentItems.push(documentItem);
+    this._DocumentItems.push(documentItem);
     return documentItem;
   }
 }

package/src/document/interfaces/document-item.repository.interface.ts

@@ -1,4 +1,4 @@
-import { IBaseRepository } from '@tomei/general';
+import { IRepositoryBase } from '@tomei/general';
 import DocumentItemModel from '../../models/document-item.entity';
 
-export type IDocumentItemRepository = IBaseRepository<DocumentItemModel>;
+export type IDocumentItemRepository = IRepositoryBase<DocumentItemModel>;

package/src/enum/index.ts

@@ -4,6 +4,7 @@ import { PaymentMethod } from './payment-method.enum';
 import { TransactionTypeOptions } from './transaction-type.enum';
 import { DocType } from './doc-type.enum';
 import { DocumentStatus } from './document-status.enum';
+import { PaymentStatus } from './payment-status.enum';
 
 export {
   ClientScopes,
@@ -12,4 +13,5 @@ export {
   TransactionTypeOptions,
   DocType,
   DocumentStatus,
+  PaymentStatus,
 };

package/src/enum/payment-status.enum.ts

@@ -0,0 +1,4 @@
+export enum PaymentStatus {
+  SUCCESSFUL = 'Successful',
+  FAILED = 'Failed',
+}

package/src/enum/transaction-type.enum.ts

@@ -1,4 +1,4 @@
 export enum TransactionTypeOptions {
-  Debit = 1,
-  Credit = 2,
+  DEBIT = 'Debit',
+  CREDIT = 'Credit',
 }

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

@@ -1,9 +1,9 @@
-import { BaseRepository, IBaseRepository } from '@tomei/general';
+import { RepositoryBase, IRepositoryBase } from '@tomei/general';
 import FinanceCompanyModel from '../models/finance-company.entity';
 
 export class FinanceCompanyRepository
-  extends BaseRepository<FinanceCompanyModel>
-  implements IBaseRepository<FinanceCompanyModel>
+  extends RepositoryBase<FinanceCompanyModel>
+  implements IRepositoryBase<FinanceCompanyModel>
 {
   constructor() {
     super(FinanceCompanyModel);