@tomei/finance 0.3.59 → 0.3.61

package/src/document/document.ts

@@ -18,11 +18,7 @@ import { AccountSystemEntity } from '../account-system-entity/account-system-ent
 import { DocumentRepository } from './document.repository';
 import FinanceCustomerBase from '../customer/customer';
 import DocumentModel from '../models/document.entity';
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const getConfig = require('../config');
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const config = getConfig();
+import path from 'path';
 
 export default class Document extends AccountSystemEntity {
   DocNo = 'New';
@@ -287,9 +283,14 @@ export default class Document extends AccountSystemEntity {
    */
   public static async DEFAULT_INVOICE_TEMPLATE_HTML(): Promise<Express.Multer.File> {
     /* getting invoice template in HTML format */
-    const HTMLTemplateFilePath = './invoice-template/index.html';
+    const HTMLTemplateFilePath = '\\invoice-template\\index.html';
+    let templateLocation = path.resolve(__dirname);
+    templateLocation = templateLocation.replace(
+      '\\dist\\document',
+      HTMLTemplateFilePath,
+    );
     const readFileContent = util.promisify(fs.readFile);
-    const htmlBuffer = await readFileContent(HTMLTemplateFilePath);
+    const htmlBuffer = await readFileContent(templateLocation);
 
     const htmlStream: Express.Multer.File = {
       buffer: htmlBuffer,
@@ -320,16 +321,21 @@ export default class Document extends AccountSystemEntity {
     /* prepping HTML conversion by getting its URL and String */
 
     /* todo: needs to generate HTML first before converting to PDF */
-    const HTMLTemplateFilePath = './invoice-template/index.html';
+    const HTMLTemplateFilePath = '\\invoice-template\\index.html';
+    let templateLocation = path.resolve(__dirname);
+    templateLocation = templateLocation.replace(
+      '\\dist\\document',
+      HTMLTemplateFilePath,
+    );
     const readFileContent = util.promisify(fs.readFile);
-    const htmlString = await readFileContent(HTMLTemplateFilePath, 'utf8');
+    const htmlString = await readFileContent(templateLocation, 'utf8');
 
     /* converting HTML to PDF */
     const browser = await puppeteer.launch();
     const page = await browser.newPage();
 
-    if (HTMLTemplateFilePath) {
-      await page.goto(HTMLTemplateFilePath, {
+    if (templateLocation) {
+      await page.goto(templateLocation, {
         waitUntil: 'networkidle2',
       });
     } else if (htmlString) {

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

@@ -1,28 +1,28 @@
-import { DocType, DocumentStatus } from '../../enum';
-
-export class IDocumentAttr {
-  DocNo: string;
-  DocType: DocType;
-  DocDate: Date;
-  CompanyId: string;
-  Currency: string;
-  Amount: number;
-  Description: string;
-  Status: DocumentStatus;
-  IssuedById: string;
-  IssuedToId: string;
-  IssuedToType: string;
-  RelatedObjectId?: string;
-  RelatedObjectType?: string;
-  CreatedById: string;
-  CreatedAt: Date;
-  UpdatedById?: string;
-  UpdatedAt?: Date;
-  DocPDFFileMediaId?: string;
-  DocHTMLFileMediaId?: string;
-  AccSystemRefId?: string;
-  PostedToAccSystemYN: string;
-  PostedById?: string;
-  PostedDateTime?: Date;
-  UseAccSystemDocYN: string;
-}
+import { DocType, DocumentStatus } from '../../enum';
+
+export class IDocumentAttr {
+  DocNo: string;
+  DocType: DocType;
+  DocDate: Date;
+  CompanyId: string;
+  Currency: string;
+  Amount: number;
+  Description: string;
+  Status: DocumentStatus;
+  IssuedById: string;
+  IssuedToId: string;
+  IssuedToType: string;
+  RelatedObjectId?: string;
+  RelatedObjectType?: string;
+  CreatedById: string;
+  CreatedAt: Date;
+  UpdatedById?: string;
+  UpdatedAt?: Date;
+  DocPDFFileMediaId?: string;
+  DocHTMLFileMediaId?: string;
+  AccSystemRefId?: string;
+  PostedToAccSystemYN: string;
+  PostedById?: string;
+  PostedDateTime?: Date;
+  UseAccSystemDocYN: string;
+}

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

@@ -1,22 +1,22 @@
-export class IDocumentItemAttr {
-  DocumentItemId: string;
-  DocNo: string;
-  Name: string;
-  NameBM: string;
-  Description?: string;
-  ItemId?: string;
-  ItemType?: string;
-  ItemSKU?: string;
-  ItemSerialNo?: string;
-  Currency: string;
-  UnitPrice?: number;
-  Quantity?: number;
-  QuantityUOM?: string;
-  Amount: number;
-  TaxCode?: string;
-  TaxAmount?: number;
-  TaxRate?: number;
-  TaxInclusiveYN?: string;
-  DtAccountNo?: string;
-  CtAccountNo?: string;
-}
+export class IDocumentItemAttr {
+  DocumentItemId: string;
+  DocNo: string;
+  Name: string;
+  NameBM: string;
+  Description?: string;
+  ItemId?: string;
+  ItemType?: string;
+  ItemSKU?: string;
+  ItemSerialNo?: string;
+  Currency: string;
+  UnitPrice?: number;
+  Quantity?: number;
+  QuantityUOM?: string;
+  Amount: number;
+  TaxCode?: string;
+  TaxAmount?: number;
+  TaxRate?: number;
+  TaxInclusiveYN?: string;
+  DtAccountNo?: string;
+  CtAccountNo?: string;
+}

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

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

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

@@ -1,8 +1,8 @@
-export enum DocType {
-  INVOICE = 'Invoice',
-  DEBIT_NOTE = 'Debit Note',
-  CREDIT_NOTE = 'Credit Note',
-  QUOTATION = 'Quotation',
-  PURCHASEORDER = 'Purchase Order',
-  RECEIPT = 'Receipt',
-}
+export enum DocType {
+  INVOICE = 'Invoice',
+  DEBIT_NOTE = 'Debit Note',
+  CREDIT_NOTE = 'Credit Note',
+  QUOTATION = 'Quotation',
+  PURCHASEORDER = 'Purchase Order',
+  RECEIPT = 'Receipt',
+}

package/src/enum/index.ts

@@ -1,17 +1,17 @@
-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 { DocType } from './doc-type.enum';
-import { DocumentStatus } from './document-status.enum';
-import { PaymentStatus } from './payment-status.enum';
-
-export {
-  ClientScopes,
-  PaymentType,
-  PaymentMethod,
-  TransactionTypeOptions,
-  DocType,
-  DocumentStatus,
-  PaymentStatus,
-};
+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 { DocType } from './doc-type.enum';
+import { DocumentStatus } from './document-status.enum';
+import { PaymentStatus } from './payment-status.enum';
+
+export {
+  ClientScopes,
+  PaymentType,
+  PaymentMethod,
+  TransactionTypeOptions,
+  DocType,
+  DocumentStatus,
+  PaymentStatus,
+};

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

@@ -1,3 +1,3 @@
-export enum PaymentMethod {
-  Cash = 'Cash', // example
-}
+export enum PaymentMethod {
+  Cash = 'Cash', // example
+}

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

@@ -1,4 +1,4 @@
-export enum PaymentType {
-  PAYMENT_RECEIVED = 'Payment Received',
-  PAYOUT = 'Payout',
-}
+export enum PaymentType {
+  PAYMENT_RECEIVED = 'Payment Received',
+  PAYOUT = 'Payout',
+}

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

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

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

@@ -276,7 +276,7 @@ export default class FinanceCompany extends ObjectBase {
     customer: FinanceCustomerBase,
   ) {
     try {
-      if (!customer.CustSystemCode || !customer.CustSystemRefId) {
+      if (!custSystemCode || !custSystemRefId) {
         throw new Error(
           'CustSystemCode and CustomerRefId are required fields.',
         );
@@ -300,6 +300,8 @@ export default class FinanceCompany extends ObjectBase {
         customer,
       });
 
+      customer.CompanyId = this._CompanyId;
+
       const newCustomer = await customer.save(
         customerId,
         custSystemCode,
@@ -568,7 +570,7 @@ export default class FinanceCompany extends ObjectBase {
         /*todo: check config file to see which invoice template is to be used for specific project*/
 
         /*Generating invoice based on template*/
-        // invoice.generateInvoice(invoice.IssuedById);
+        invoice.generateInvoice(invoice.IssuedById, customer);
       }
 
       const transactionDate = new Date();
@@ -621,6 +623,7 @@ export default class FinanceCompany extends ObjectBase {
         dt.DebitAmount = creditAmount ? creditAmount : 0.0;
         dt.Date = transactionDate;
         dt.Description = account.Name;
+        dt.Name = account.Name;
         dt.RelatedDocNo = invoice.DocNo;
 
         const ct = await journalEntry.newLedgerTransaction(
@@ -631,6 +634,7 @@ export default class FinanceCompany extends ObjectBase {
         ct.CreditAmount = creditAmount ? creditAmount : 0.0;
         ct.Date = transactionDate;
         ct.Description = account.Name;
+        ct.Name = account.Name;
         ct.RelatedDocNo = invoice.DocNo;
 
         await this.postJournal(dbTransaction, journalEntry);
@@ -819,6 +823,7 @@ export default class FinanceCompany extends ObjectBase {
         dt.DebitAmount = creditAmount ? creditAmount : 0.0;
         dt.Date = transactionDate;
         dt.Description = account.Name;
+        dt.Name = account.Name;
         dt.RelatedDocNo = invoice.DocNo;
 
         const ct = await journalEntry.newLedgerTransaction(
@@ -829,6 +834,7 @@ export default class FinanceCompany extends ObjectBase {
         ct.CreditAmount = creditAmount ? creditAmount : 0.0;
         ct.Date = transactionDate;
         ct.Description = account.Name;
+        ct.Name = account.Name;
         ct.RelatedDocNo = invoice.DocNo;
 
         await this.postJournal(dbTransaction, journalEntry);
@@ -984,6 +990,7 @@ export default class FinanceCompany extends ObjectBase {
       creditTransaction.CreditAmount = creditNote.Amount;
       creditTransaction.Date = transactionDate;
       creditTransaction.Description = creditNote.DocNo;
+      creditTransaction.Name = creditNote.DocNo;
 
       for (const invoiceItem of documentItems) {
         const itemLedger = await journalEntry.newLedgerTransaction(
@@ -994,6 +1001,7 @@ export default class FinanceCompany extends ObjectBase {
         itemLedger.DebitAmount = invoiceItem.Amount;
         itemLedger.Date = transactionDate;
         itemLedger.Description = invoiceItem.Description;
+        itemLedger.Name = invoiceItem.Name;
       }
 
       this.postJournal(dbTransaction, journalEntry);
@@ -1149,6 +1157,7 @@ export default class FinanceCompany extends ObjectBase {
         debitLT.DebitAmount = payment.Amount;
         debitLT.Date = transactionDate;
         debitLT.Description = customer.FullName;
+        debitLT.Name = customer.FullName;
 
         const creditLT = await journalEntry.newLedgerTransaction(
           TransactionTypeOptions.CREDIT,
@@ -1163,6 +1172,7 @@ export default class FinanceCompany extends ObjectBase {
         creditLT.CreditAmount = payment.Amount;
         creditLT.Date = transactionDate;
         creditLT.Description = paymentMethodType.Name;
+        creditLT.Name = paymentMethodType.Name;
 
         await this.postJournal(dbTransaction, journalEntry);
       }
@@ -1258,6 +1268,7 @@ export default class FinanceCompany extends ObjectBase {
       creditLT.CreditAmount = payment.Amount;
       creditLT.Date = transactionDate;
       creditLT.Description = customer.FullName;
+      creditLT.Name = customer.FullName;
 
       const debitLT = await journalEntry.newLedgerTransaction(
         TransactionTypeOptions.DEBIT,
@@ -1271,6 +1282,7 @@ export default class FinanceCompany extends ObjectBase {
       debitLT.DebitAmount = payment.Amount;
       debitLT.Date = transactionDate;
       debitLT.Description = paymentMethodType.Name;
+      debitLT.Name = paymentMethodType.Name;
 
       await this.postJournal(dbTransaction, journalEntry);
 

package/src/helpers/typeof.ts

@@ -1,29 +1,29 @@
-export default function type(value: any): string {
-  if (value === null) {
-    return 'null';
-  }
-  const baseType = typeof value;
-
-  if (!['object', 'function'].includes(baseType)) {
-    return baseType;
-  }
-
-  const tag = value[Symbol.toStringTag];
-  if (typeof tag === 'string') {
-    return tag;
-  }
-
-  if (
-    baseType === 'function' &&
-    Function.prototype.toString.call(value).startsWith('class')
-  ) {
-    return Function.prototype.toString.call(value).split(' ')[1];
-  }
-
-  const className = value.constructor.name;
-  if (typeof className === 'string' && className !== '') {
-    return className;
-  }
-
-  return baseType;
-}
+export default function type(value: any): string {
+  if (value === null) {
+    return 'null';
+  }
+  const baseType = typeof value;
+
+  if (!['object', 'function'].includes(baseType)) {
+    return baseType;
+  }
+
+  const tag = value[Symbol.toStringTag];
+  if (typeof tag === 'string') {
+    return tag;
+  }
+
+  if (
+    baseType === 'function' &&
+    Function.prototype.toString.call(value).startsWith('class')
+  ) {
+    return Function.prototype.toString.call(value).split(' ')[1];
+  }
+
+  const className = value.constructor.name;
+  if (typeof className === 'string' && className !== '') {
+    return className;
+  }
+
+  return baseType;
+}

package/src/index.ts

@@ -1,30 +1,30 @@
-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';
-import PaymentItem from './payment-item/payment-item';
-import PaymentMethod from './payment-method/payment-method';
-import PaymentMethodType from './payment-method-type/payment-method-type';
-import PaymentPaidWith from './payment-paid-with/payment-paid-with';
-
-export {
-  FinanceCompany,
-  Account,
-  FinanceCustomerBase,
-  Document,
-  DocumentItem,
-  JournalEntry,
-  LedgerTransaction,
-  Payment,
-  PaymentItem,
-  PaymentMethod,
-  PaymentMethodType,
-  PaymentPaidWith,
-};
-export * as FinanceEnum from './enum';
-export * as FinanceInterfaces from './interfaces';
-export * as FinanceDb from './database';
+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';
+import PaymentItem from './payment-item/payment-item';
+import PaymentMethod from './payment-method/payment-method';
+import PaymentMethodType from './payment-method-type/payment-method-type';
+import PaymentPaidWith from './payment-paid-with/payment-paid-with';
+
+export {
+  FinanceCompany,
+  Account,
+  FinanceCustomerBase,
+  Document,
+  DocumentItem,
+  JournalEntry,
+  LedgerTransaction,
+  Payment,
+  PaymentItem,
+  PaymentMethod,
+  PaymentMethodType,
+  PaymentPaidWith,
+};
+export * as FinanceEnum from './enum';
+export * as FinanceInterfaces from './interfaces';
+export * as FinanceDb from './database';

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

@@ -1,20 +1,20 @@
-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>;
-}
+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/ledger-transaction/interfaces/ledger-transaction-attr.interface.ts

@@ -1,17 +1,18 @@
 import { TransactionTypeOptions } from '../../enum';
 
 export interface ILedgerTransactionAttr {
-  TransactionId: string;
-  TransactionType: TransactionTypeOptions;
-  JournalEntryId: string;
-  AccountNo: string;
-  Date: Date;
-  Description: string;
-  Currency: string;
-  DebitAmount: number;
-  CreditAmount: number;
-  RelatedObjectId: string;
-  RelatedObjectType: string;
-  RelatedDocNo: string;
-  RelatedPaymentId: string;
+  TransactionId?: string;
+  TransactionType?: TransactionTypeOptions;
+  JournalEntryId?: string;
+  AccountNo?: string;
+  Date?: Date;
+  Name?: string;
+  Description?: string;
+  Currency?: string;
+  DebitAmount?: number;
+  CreditAmount?: number;
+  RelatedObjectId?: string;
+  RelatedObjectType?: string;
+  RelatedDocNo?: string;
+  RelatedPaymentId?: string;
 }

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

@@ -46,6 +46,7 @@ export default class LedgerTransaction {
     if (params.RelatedObjectId) this.RelatedObjectId = params.RelatedObjectId;
     if (params.RelatedObjectType)
       this.RelatedObjectType = params.RelatedObjectType;
+    if (params.Name) this.Name = params.Name;
   }
 
   getData() {
@@ -55,6 +56,7 @@ export default class LedgerTransaction {
       JournalEntryId: this.JournalEntryId,
       AccountNo: this.AccountNo,
       Date: this.Date,
+      Name: this.Name,
       Description: this.Description,
       Currency: this.Currency,
       DebitAmount: this.DebitAmount,
@@ -82,6 +84,7 @@ export default class LedgerTransaction {
       TransactionType: transactionType,
       JournalEntryId: journalEntryId,
       //TODO: AccountNo should be Filled In. Not sure with What
+      Name: '',
       AccountNo: '',
       Date: new Date(),
       Description: '',