@tomei/finance 0.6.3 → 0.6.5

package/src/database.ts

@@ -1,15 +1,15 @@
-import { Sequelize, SequelizeOptions } from 'sequelize-typescript';
-
-let sequelize: Sequelize;
-
-function init(sequelizeOptions: SequelizeOptions) {
-  sequelize = new Sequelize(sequelizeOptions);
-
-  sequelize.addModels([__dirname + '/models']);
-}
-
-function getConnection() {
-  return sequelize;
-}
-
-export { init, getConnection };
+import { Sequelize, SequelizeOptions } from 'sequelize-typescript';
+
+let sequelize: Sequelize;
+
+function init(sequelizeOptions: SequelizeOptions) {
+  sequelize = new Sequelize(sequelizeOptions);
+
+  sequelize.addModels([__dirname + '/models']);
+}
+
+function getConnection() {
+  return sequelize;
+}
+
+export { init, getConnection };

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

@@ -1,11 +1,11 @@
-import { RepositoryBase, IRepositoryBase } from '@tomei/general';
-import DocumentItemModel from '../models/document-item.entity';
-
-export class DocumentItemRepository
-  extends RepositoryBase<DocumentItemModel>
-  implements IRepositoryBase<DocumentItemModel>
-{
-  constructor() {
-    super(DocumentItemModel);
-  }
-}
+import { RepositoryBase, IRepositoryBase } from '@tomei/general';
+import DocumentItemModel from '../models/document-item.entity';
+
+export class DocumentItemRepository
+  extends RepositoryBase<DocumentItemModel>
+  implements IRepositoryBase<DocumentItemModel>
+{
+  constructor() {
+    super(DocumentItemModel);
+  }
+}

package/src/document/document-item.ts

@@ -1,6 +1,8 @@
 import Document from './document';
 import { ObjectBase } from '@tomei/general';
 import { DocumentItemRepository } from './document-item.repository';
+import { ClassError } from '@tomei/general';
+import { IDocumentItemAttr } from './interfaces/document-item-attr.interface';
 
 export default class DocumentItem extends ObjectBase {
   DocumentItemId = 'New';
@@ -72,26 +74,60 @@ export default class DocumentItem extends ObjectBase {
     this._Document = document;
   }
 
-  init(data: any) {
-    this.DocumentItemId = data.DocumentItemId || this.DocumentItemId;
-    this.DocNo = data.DocNo || this.DocNo;
-    this.Name = data.Name || this.Name;
-    this.NameBM = data.NameBM || this.NameBM;
-    this.Description = data.Description || this.Description;
-    this.ItemId = data.ItemId || this.ItemId;
-    this.ItemType = data.ItemType || this.ItemType;
-    this.ItemSKU = data.ItemSKU || this.ItemSKU;
-    this.ItemSerialNo = data.ItemSerialNo || this.ItemSerialNo;
-    this.Currency = data.Currency || this.Currency;
-    this.UnitPrice = data.UnitPrice || this.UnitPrice;
-    this.Quantity = data.Quantity || this.Quantity;
-    this.QuantityUOM = data.QuantityUOM || this.QuantityUOM;
-    this._Amount = data.Amount || this._Amount;
-    this.TaxCode = data.TaxCode || this.TaxCode;
-    this.TaxAmount = data.TaxAmount || this.TaxAmount;
-    this.TaxRate = data.TaxRate || this.TaxRate;
-    this.TaxInclusiveYN = data.TaxInclusiveYN || this.TaxInclusiveYN;
-    this.DtAccountNo = data.DtAccountNo || this.DtAccountNo;
-    this.CtAccountNo = data.CtAccountNo || this.CtAccountNo;
+  init(params: IDocumentItemAttr) {
+    this.DocumentItemId = params.DocumentItemId || this.DocumentItemId;
+    this.DocNo = params.DocNo || this.DocNo;
+    this.Name = params.Name || this.Name;
+    this.NameBM = params.NameBM || this.NameBM;
+    this.Description = params.Description || this.Description;
+    this.ItemId = params.ItemId || this.ItemId;
+    this.ItemType = params.ItemType || this.ItemType;
+    this.ItemSKU = params.ItemSKU || this.ItemSKU;
+    this.ItemSerialNo = params.ItemSerialNo || this.ItemSerialNo;
+    this.Currency = params.Currency || this.Currency;
+    this.UnitPrice = params.UnitPrice || this.UnitPrice;
+    this.Quantity = params.Quantity || this.Quantity;
+    this.QuantityUOM = params.QuantityUOM || this.QuantityUOM;
+    this._Amount = params.Amount || this._Amount;
+    this.TaxCode = params.TaxCode || this.TaxCode;
+    this.TaxAmount = params.TaxAmount || this.TaxAmount;
+    this.TaxRate = params.TaxRate || this.TaxRate;
+    this.TaxInclusiveYN = params.TaxInclusiveYN || this.TaxInclusiveYN;
+    this.DtAccountNo = params.DtAccountNo || this.DtAccountNo;
+    this.CtAccountNo = params.CtAccountNo || this.CtAccountNo;
+  }
+
+  public static async initDocumentItems(
+    dbTransaction: any,
+    document: Document,
+  ) {
+    try {
+      const documentItems = await this._RepositoryBase.findAll({
+        where: {
+          DocNo: document.DocNo,
+        },
+        transaction: dbTransaction,
+      });
+
+      if (documentItems) {
+        const documentItemObjects = documentItems.map((documentItem) => {
+          const di = new DocumentItem(dbTransaction, document);
+          di.init({ ...documentItem.get({ plain: true }) });
+          return di;
+        });
+
+        return documentItemObjects;
+      } else {
+        const notFoundError = new ClassError(
+          'Document',
+          'InitDocumentItemErrMsg00',
+          `No Document Item record found.`,
+        );
+
+        throw notFoundError;
+      }
+    } catch (error) {
+      throw error;
+    }
   }
 }

package/src/document/document.repository.ts

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

package/src/document/document.ts

@@ -1,4 +1,5 @@
 import * as util from 'util';
+import * as path from 'path';
 import * as fs from 'fs';
 import * as puppeteer from 'puppeteer';
 import { RecordNotFoundError } from '@tomei/general/dist/class/exceptions/record-not-found.error';
@@ -12,13 +13,17 @@ import {
 } from '@tomei/media';
 import { DocumentStatus, DocType } from '../enum';
 import { IDocumentAttr } from './interfaces/document-attr.interface';
+import { IDocumentFindAll } from './interfaces/document-find-all.interface';
 import { DocumentItemRepository } from './document-item.repository';
 import DocumentItem from './document-item';
 import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
 import { DocumentRepository } from './document.repository';
 import FinanceCustomerBase from '../customer/customer';
 import DocumentModel from '../models/document.entity';
-import * as path from 'path';
+import DocumentItemModel from '../models/document-item.entity';
+import { ClassError, LoginUserBase } from '@tomei/general';
+import { ApplicationConfig } from '@tomei/config';
+import { Op } from 'sequelize';
 
 export default class Document extends AccountSystemEntity {
   DocNo = 'New';
@@ -141,7 +146,6 @@ export default class Document extends AccountSystemEntity {
       })
         .then((documentData) => {
           if (documentData) {
-            this.IsNewRecord = false;
             this.DocType = documentData.DocType;
             this.DocDate = documentData.DocDate;
             this.CompanyId = documentData.CompanyId;
@@ -181,47 +185,85 @@ export default class Document extends AccountSystemEntity {
     }
   }
 
+  init(params: IDocumentAttr) {
+    this.DocNo = params.DocNo;
+    this.DocType = params.DocType;
+    this.DocDate = params.DocDate;
+    this.CompanyId = params.CompanyId;
+    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.RelatedObjectId = params.RelatedObjectId;
+    this.RelatedObjectType = params.RelatedObjectType;
+    this.CreatedById = params.CreatedById;
+    this.CreatedAt = params.CreatedAt;
+    this.UpdatedById = params.UpdatedById;
+    this.UpdatedAt = params.UpdatedAt;
+    this.DocPDFFileMediaId = params.DocPDFFileMediaId;
+    this.DocHTMLFileMediaId = params.DocHTMLFileMediaId;
+    this.AccSystemRefId = params.AccSystemRefId;
+    this.PostedToAccSystemYN = params.PostedToAccSystemYN;
+    this.PostedById = params.PostedById;
+    this.PostedDateTime = params.PostedDateTime;
+    this.UseAccSystemDocYN = params.UseAccSystemDocYN;
+  }
+
   public static async initDocument(dbTransaction: any, docNo: string) {
-    const document = new Document(dbTransaction);
-    const documentData = await this._RepositoryBase.findOne({
-      where: {
-        DocNo: docNo,
-      },
-    });
-    if (documentData) {
-      document.IsNewRecord = false;
-      document.DocType = documentData.DocType;
-      document.DocDate = documentData.DocDate;
-      document.CompanyId = documentData.CompanyId;
-      document.Currency = documentData.Currency;
-      document.Amount = documentData.Amount;
-      document.Description = documentData.Description;
-      document.Status = documentData.Status;
-      document.IssuedById = documentData.IssuedById;
-      document.IssuedToId = documentData.IssuedToId;
-      document.IssuedToType = documentData.IssuedToType;
-      document.RelatedObjectId = documentData.RelatedObjectId;
-      document.RelatedObjectType = documentData.RelatedObjectType;
-      document.CreatedById = documentData.CreatedById;
-      document.CreatedAt = documentData.CreatedAt;
-      document.UpdatedById = documentData.UpdatedById;
-      document.UpdatedAt = documentData.UpdatedAt;
-      document.DocPDFFileMediaId = documentData.DocPDFFileMediaId;
-      document.DocHTMLFileMediaId = documentData.DocHTMLFileMediaId;
-      document.AccSystemRefId = documentData.AccSystemRefId;
-      document.PostedToAccSystemYN = documentData.PostedToAccSystemYN;
-      document.PostedById = documentData.PostedById;
-      document.PostedDateTime = documentData.PostedDateTime;
-      document.UseAccSystemDocYN = documentData.UseAccSystemDocYN;
-      document.IsNewRecord = false;
-    } else {
-      const notFoundError = new RecordNotFoundError(
-        'FinanceDocumentErrMsg',
-        'No Record Found.',
-      );
-      throw notFoundError;
+    try {
+      const document = new Document(dbTransaction);
+      const documentData = await this._RepositoryBase.findOne({
+        where: {
+          DocNo: docNo,
+        },
+        include: [
+          {
+            model: DocumentItemModel,
+          },
+        ],
+      });
+      if (documentData) {
+        document.DocNo = documentData.DocNo;
+        document.DocType = documentData.DocType;
+        document.DocDate = documentData.DocDate;
+        document.CompanyId = documentData.CompanyId;
+        document.Currency = documentData.Currency;
+        document.Amount = documentData.Amount;
+        document.Description = documentData.Description;
+        document.Status = documentData.Status;
+        document.IssuedById = documentData.IssuedById;
+        document.IssuedToId = documentData.IssuedToId;
+        document.IssuedToType = documentData.IssuedToType;
+        document.RelatedObjectId = documentData.RelatedObjectId;
+        document.RelatedObjectType = documentData.RelatedObjectType;
+        document.CreatedById = documentData.CreatedById;
+        document.CreatedAt = documentData.CreatedAt;
+        document.UpdatedById = documentData.UpdatedById;
+        document.UpdatedAt = documentData.UpdatedAt;
+        document.DocPDFFileMediaId = documentData.DocPDFFileMediaId;
+        document.DocHTMLFileMediaId = documentData.DocHTMLFileMediaId;
+        document.AccSystemRefId = documentData.AccSystemRefId;
+        document.PostedToAccSystemYN = documentData.PostedToAccSystemYN;
+        document.PostedById = documentData.PostedById;
+        document.PostedDateTime = documentData.PostedDateTime;
+        document.UseAccSystemDocYN = documentData.UseAccSystemDocYN;
+        document.IsNewRecord = false;
+      } else {
+        const notFoundError = new ClassError(
+          'Document',
+          'InitDocumentErrMsg00',
+          `No Document record found.`,
+        );
+
+        throw notFoundError;
+      }
+      return documentData;
+    } catch (error) {
+      throw error;
     }
-    return document;
   }
 
   /**
@@ -239,23 +281,9 @@ export default class Document extends AccountSystemEntity {
   get DocumentItems(): Promise<DocumentItem[]> {
     return new Promise((resolve, reject) => {
       if (!this.IsNewRecord) {
-        Document._DocumentItemRepository
-          .findAll({
-            where: {
-              DocNo: this.DocNo,
-            },
-            transaction: this._DbTransaction,
-          })
+        DocumentItem.initDocumentItems(this._DbTransaction, this)
           .then((documentItems) => {
-            const documentItemObjects = documentItems.map((documentItem) => {
-              const di = new DocumentItem(this._DbTransaction, this);
-              di.init({ ...documentItem.get({ plain: true }) });
-            });
-            return Promise.all(documentItemObjects);
-          })
-          .then((documentItemObjects) => {
-            this._DocumentItems = documentItemObjects;
-            resolve(this._DocumentItems);
+            return Promise.all(documentItems);
           })
           .catch((err) => {
             reject(err);
@@ -783,33 +811,6 @@ export default class Document extends AccountSystemEntity {
     })();
   }
 
-  init(params: IDocumentAttr) {
-    this.DocNo = params.DocNo;
-    this.DocType = params.DocType;
-    this.DocDate = params.DocDate;
-    this.CompanyId = params.CompanyId;
-    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.RelatedObjectId = params.RelatedObjectId;
-    this.RelatedObjectType = params.RelatedObjectType;
-    this.CreatedById = params.CreatedById;
-    this.CreatedAt = params.CreatedAt;
-    this.UpdatedById = params.UpdatedById;
-    this.UpdatedAt = params.UpdatedAt;
-    this.DocPDFFileMediaId = params.DocPDFFileMediaId;
-    this.DocHTMLFileMediaId = params.DocHTMLFileMediaId;
-    this.AccSystemRefId = params.AccSystemRefId;
-    this.PostedToAccSystemYN = params.PostedToAccSystemYN;
-    this.PostedById = params.PostedById;
-    this.PostedDateTime = params.PostedDateTime;
-    this.UseAccSystemDocYN = params.UseAccSystemDocYN;
-  }
-
   /**
    * Returns generated HTML & PDF Invoice Media
    *
@@ -1007,4 +1008,109 @@ export default class Document extends AccountSystemEntity {
       order: [['CreatedAt', 'DESC']],
     });
   }
+
+  /**
+   * Retrieve a list of documents from the database.
+   *
+   * @param loginUser - The user who is issuing the request.
+   * @param dbTransaction - The database transaction to be used, if any.
+   * @param page - Optional. The page number for paginated results.
+   * @param row - Optional. The number of rows to retrieve per page.
+   * @param search - Optional. An object containing search criteria.
+   *
+   * @returns {count: number, rows: DocumentModel[]} - An object containing the count of matching documents and an array of DocumentModel objects.
+   * @throws {Error} - If the user does not have the required privilege or if an error occurs during the operation.
+   */
+  async findAll(
+    loginUser: LoginUserBase,
+    dbTransaction: any,
+    page?: number,
+    row?: number,
+    search?: IDocumentFindAll,
+  ): Promise<{ count: number; rows: DocumentModel[] }> {
+    try {
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'Invoice - View',
+      );
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Document',
+          'DocumentFindAllErrMsg00',
+          `You do not have 'Invoice - View' privilege.`,
+        );
+      }
+
+      let options: any = {
+        transaction: dbTransaction,
+      };
+
+      /*Create an object to store search criteria*/
+      const searchObj: IDocumentFindAll | any = {};
+
+      /*Apply search filters if they are provided*/
+      if (search.DocNo) {
+        searchObj.DocNo = search.DocNo;
+      }
+
+      if (search.DocType) {
+        searchObj.DocType = search.DocType;
+      }
+
+      if (search.StartDate) {
+        searchObj.DocDate = {
+          ...searchObj.DocDate,
+          [Op.gte]: new Date(search.StartDate).toISOString(),
+        };
+      }
+
+      if (search.EndDate) {
+        searchObj.DocDate = {
+          ...searchObj.DocDate,
+          [Op.lte]: new Date(search.EndDate).toISOString(),
+        };
+      }
+
+      if (search.IssuedToId) {
+        searchObj.IssuedToId = search.IssuedToId;
+      }
+
+      if (search.IssuedToType) {
+        searchObj.IssuedToType = search.IssuedToType;
+      }
+
+      if (search.Status) {
+        searchObj.Status = search.Status;
+      }
+
+      /*If pagination is requested, update query options*/
+      if (page && row) {
+        options = {
+          ...options,
+          limit: row,
+          offset: row * (page - 1),
+          order: [['CreatedAt', 'DESC']],
+        };
+      }
+
+      /*If search criteria exist, add them to the query options*/
+      if (Object.keys(searchObj).length) {
+        options = {
+          ...options,
+          where: searchObj,
+        };
+      }
+
+      /*Retrieve documents from the database with pagination and search filters applied*/
+      const documents = await this.RepositoryBase.findAllWithPagination(
+        options,
+      );
+      return documents;
+    } catch (error) {
+      throw error;
+    }
+  }
 }

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-find-all.interface.ts

@@ -0,0 +1,11 @@
+import { DocType, DocumentStatus } from '../../enum';
+
+export interface IDocumentFindAll {
+  DocNo?: string;
+  DocType?: DocType;
+  StartDate?: Date;
+  EndDate?: Date;
+  IssuedToId?: string;
+  IssuedToType?: string;
+  Status?: DocumentStatus;
+}

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