@tomei/finance 0.6.3 → 0.6.4

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.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

@@ -12,6 +12,7 @@ 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';
@@ -19,6 +20,9 @@ import { DocumentRepository } from './document.repository';
 import FinanceCustomerBase from '../customer/customer';
 import DocumentModel from '../models/document.entity';
 import * as path from 'path';
+import { ClassError, LoginUserBase } from '@tomei/general';
+import { ApplicationConfig } from '@tomei/config';
+import { Op } from 'sequelize';
 
 export default class Document extends AccountSystemEntity {
   DocNo = 'New';
@@ -1007,4 +1011,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,
+};

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