ecom-documents 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+### Added
+### Fixed
+### Removed

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Your Organization
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# ecom-documents

package/dist/index.d.mts

@@ -0,0 +1,324 @@
+import axios from 'axios';
+import { ValidationError } from 'class-validator';
+
+declare class DateRangeExportDto {
+    from: string | Date;
+    to: string | Date;
+}
+
+interface PageOptionsDto {
+    page?: number;
+    limit?: number;
+    skip: number;
+    take?: number;
+    order?: 'ASC' | 'DESC';
+}
+interface ChunkedFetchConfig<T> {
+    queryFn: (pageOptions: PageOptionsDto) => Promise<[T[], number]>;
+    pageOptions: PageOptionsDto;
+    chunkSize?: number;
+}
+declare function fetchDBQueryInChunks<T>(config: ChunkedFetchConfig<T>): Promise<T[]>;
+
+declare function maskAccountNumber(str: string): string;
+
+type ValueOf<T> = T[keyof T];
+
+declare const DocumentType: {
+    readonly STATEMENTS: "STATEMENTS";
+    readonly PAYOUTS: "PAYOUTS";
+    readonly SETTLEMENTS: "SETTLEMENTS";
+    readonly TRANSACTIONS: "TRANSACTIONS";
+    readonly TRANSACTIONS_INTERNAL: "TRANSACTIONS_INTERNAL";
+    readonly REFUNDS: "REFUNDS";
+    readonly REFUNDS_INTERNAL_GATEWAY: "REFUNDS_INTERNAL_GATEWAY";
+    readonly PROFIT_FEES: "PROFIT_FEES";
+    readonly PAYMENT_METHODS: "PAYMENT_METHODS";
+    readonly VENDOR_LIST: "VENDOR_LIST";
+    readonly VENDOR_SALES: "VENDOR_SALES";
+    readonly EXCEPTIONS: "EXCEPTIONS";
+    readonly REFUNDS_POS: "REFUNDS_POS";
+    readonly REFUNDS_INTERNAL_POS: "REFUNDS_INTERNAL_POS";
+};
+type DocumentType = ValueOf<typeof DocumentType>;
+
+declare const FileFormat: {
+    readonly PDF: "pdf";
+    readonly CSV: "csv";
+    readonly XLSX: "xlsx";
+};
+type FileFormat = ValueOf<typeof FileFormat>;
+
+declare class MerchantDetailsHeaderExportDto {
+    name: string;
+    profile?: string;
+    accountNumber: string;
+    totalBalance: number;
+    availableBalance: number;
+    pendingBalance: number;
+    currency: string;
+}
+
+declare class DocumentGenerationRequestDto<T = any> {
+    documentFormat: FileFormat;
+    documentType: DocumentType;
+    merchantInfo: MerchantDetailsHeaderExportDto;
+    dateRange: DateRangeExportDto;
+    data: T[];
+    presignedURL?: boolean;
+}
+
+declare class DocumentPathResponseDto {
+    name: string;
+    path: string;
+    s3Result: object;
+    constructor(name: string, path: string, commandResult: object);
+}
+
+declare class DocumentExportClient {
+    client: ReturnType<typeof axios.create>;
+    constructor(documentMsBaseUrl: string, documentMSCommunicationKey: string);
+    generateDocument(documentFormat: FileFormat, documentType: DocumentType, dateRange: DateRangeExportDto, payload: {
+        data: object[];
+    }, merchantInfo: MerchantDetailsHeaderExportDto, presignedURL?: boolean): Promise<DocumentPathResponseDto>;
+}
+
+declare class DocumentError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    details?: any | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined, details?: any | undefined);
+}
+declare class DocumentGenerationError extends DocumentError {
+    constructor(message: string, details?: any);
+}
+declare class DocumentNetworkError extends DocumentError {
+    constructor(message: string, statusCode?: number, details?: any);
+}
+
+declare class DocumentValidationError extends DocumentError {
+    validationErrors: ValidationError[];
+    constructor(message: string, validationErrors: ValidationError[]);
+    getMessages(): string[];
+}
+
+declare class ExceptionDocument {
+    createdAt: string | Date;
+    merchantName: string;
+    merchantRisk: string;
+    cardNumber: string;
+    cardIssuer: string;
+    cardHolderName: string;
+    payerIpAddress: string;
+    product: string;
+    paymentMethod: string;
+    amount: number | string;
+    action: string;
+}
+declare class ExceptionExportDto {
+    data: ExceptionDocument[];
+}
+
+declare class PaymentMethodDocument {
+    paymentMethod: string;
+    totalAmount: number;
+    percentageOfTotal: string;
+    txnCount: number;
+}
+declare class PaymentMethodsExportDto {
+    data: PaymentMethodDocument[];
+}
+
+declare class PayoutDocument {
+    id: string;
+    mid: string;
+    iban: string;
+    amount: number;
+    currency: string;
+    numOfTxn: number;
+    notes: string;
+    createdAt: string | Date;
+}
+declare class PayoutsExportDto {
+    data: PayoutDocument[];
+}
+
+declare class ProfitFeesDocument {
+    mid: string;
+    merchantName: string;
+    numOfTxn: number;
+    totalTxnAmount: number;
+    totalProfitAmount: number;
+    type: 'PROFIT' | 'FEES';
+}
+declare class ProfitFeesExportDto {
+    data: ProfitFeesDocument[];
+}
+
+declare class RefundBaseDto {
+    createdAt: string | Date;
+    refundedAt?: string | Date;
+    rejectedAt?: string | Date;
+    ecomReference?: string;
+    merchantReference?: string;
+    originalTxnId: string;
+    originalTxnDate: string | Date;
+    originalTxnAmount: number;
+    amount: number;
+    paymentMethod: string;
+    status: string;
+    mid: string;
+    merchantName: string;
+}
+declare class RefundDocument extends RefundBaseDto {
+    customerName: string;
+    customerPhone: string;
+    invoiceNumber?: string;
+    product: string;
+    type: string;
+    requestedBy?: string;
+}
+declare class RefundPOSDocument extends RefundBaseDto {
+    authId: string | null;
+    terminalId: string;
+    terminalName?: string;
+    cardNumber: string;
+}
+declare class RefundsExportDto {
+    data: RefundDocument[];
+}
+declare class RefundsPOSExportDto {
+    data: RefundPOSDocument[];
+}
+
+declare class SettlementDocument {
+    mid: string;
+    merchantName: string;
+    bank?: string;
+    holderName?: string;
+    iban?: string;
+    accountNumber?: string;
+    totalAmount: number;
+    totalTxnCount: number;
+    settlementDate?: string | null;
+}
+declare class SettlementsExportDto {
+    data: SettlementDocument[];
+}
+
+declare class StatementDocument {
+    createdAt: Date | string;
+    transactionId?: string;
+    merchantReference?: string;
+    invoiceId?: string;
+    description?: string;
+    paymentMethod: string;
+    amount: number;
+    type: string;
+    balanceAfter: number;
+}
+declare class StatementsExportDto {
+    data: StatementDocument[];
+}
+
+declare class TransactionDocument {
+    createdAt: string | Date;
+    id: string;
+    ecomReference: string;
+    merchantReference?: string;
+    merchantName?: string;
+    invoiceNumber?: string;
+    customerName: string;
+    customerPhone: string;
+    amount: number;
+    product: string;
+    paymentMethod: string;
+    status: string;
+    authCode?: string;
+    terminalId?: string;
+    terminalName?: string;
+    cardNumber?: string;
+}
+declare class TransactionsExportDto {
+    data: TransactionDocument[];
+}
+
+declare class VendorSalesDocument {
+    mid: string;
+    vendorNumber: string;
+    vendorName: string;
+    totalTxnAmount: number;
+}
+declare class VendorListDocument {
+    mid: string;
+    vendorNumber: string;
+    vendorName: string;
+    email: string;
+    bank: string;
+    iban: string;
+    commission: number | string;
+}
+declare class VendorSalesExportDto {
+    data: VendorSalesDocument[];
+}
+declare class VendorListExportDto {
+    data: VendorListDocument[];
+}
+
+declare const DocumentPayloadMap: {
+    readonly STATEMENTS: typeof StatementsExportDto;
+    readonly PAYOUTS: typeof PayoutsExportDto;
+    readonly SETTLEMENTS: typeof SettlementsExportDto;
+    readonly TRANSACTIONS: typeof TransactionsExportDto;
+    readonly TRANSACTIONS_INTERNAL: typeof TransactionsExportDto;
+    readonly REFUNDS: typeof RefundsExportDto;
+    readonly REFUNDS_INTERNAL_GATEWAY: typeof RefundsExportDto;
+    readonly PROFIT_FEES: typeof ProfitFeesExportDto;
+    readonly PAYMENT_METHODS: typeof PaymentMethodsExportDto;
+    readonly VENDOR_LIST: typeof VendorListExportDto;
+    readonly VENDOR_SALES: typeof VendorSalesExportDto;
+    readonly EXCEPTIONS: typeof ExceptionExportDto;
+    readonly REFUNDS_POS: typeof RefundsPOSExportDto;
+    readonly REFUNDS_INTERNAL_POS: typeof RefundsPOSExportDto;
+};
+
+declare class InvoiceDocument {
+    createdAt: string | Date;
+    paidAt: string | Date;
+    customerName: string;
+    customerPhone: string;
+    id: string;
+    merchantReference: string;
+    createdBy: string;
+    transactionId: string;
+    status: string;
+    amount: number;
+    paymentMethod: string;
+}
+declare class InvoiceHistoryDocument {
+    createdAt: string | Date;
+    action: string;
+    createdBy: string;
+    invoiceId: string;
+    paymentMethod: string;
+    paymentMethodBrand: string;
+}
+declare class InvoiceExportDto {
+    data: InvoiceDocument[];
+}
+declare class InvoiceHistoryExportDto {
+    data: InvoiceHistoryDocument[];
+}
+
+interface ValidationResult<T = any> {
+    isValid: boolean;
+    errors?: ValidationError[];
+    validatedPayload?: T;
+    errorMessage?: string;
+}
+declare class DocumentValidator {
+    static validatePayload(type: DocumentType, payload: any): Promise<ValidationResult>;
+    static formatErrors(errors: ValidationError[]): string[];
+}
+
+export { type ChunkedFetchConfig, DateRangeExportDto, DocumentError, DocumentExportClient, DocumentGenerationError, DocumentGenerationRequestDto, DocumentNetworkError, DocumentPathResponseDto, DocumentPayloadMap, DocumentType, DocumentValidationError, DocumentValidator, ExceptionExportDto, FileFormat, InvoiceExportDto, InvoiceHistoryExportDto, MerchantDetailsHeaderExportDto, type PageOptionsDto, PaymentMethodsExportDto, PayoutsExportDto, ProfitFeesExportDto, RefundsExportDto, RefundsPOSExportDto, SettlementsExportDto, StatementsExportDto, TransactionsExportDto, type ValidationResult, type ValueOf, VendorListExportDto, VendorSalesExportDto, fetchDBQueryInChunks, maskAccountNumber };

package/dist/index.d.ts

@@ -0,0 +1,324 @@
+import axios from 'axios';
+import { ValidationError } from 'class-validator';
+
+declare class DateRangeExportDto {
+    from: string | Date;
+    to: string | Date;
+}
+
+interface PageOptionsDto {
+    page?: number;
+    limit?: number;
+    skip: number;
+    take?: number;
+    order?: 'ASC' | 'DESC';
+}
+interface ChunkedFetchConfig<T> {
+    queryFn: (pageOptions: PageOptionsDto) => Promise<[T[], number]>;
+    pageOptions: PageOptionsDto;
+    chunkSize?: number;
+}
+declare function fetchDBQueryInChunks<T>(config: ChunkedFetchConfig<T>): Promise<T[]>;
+
+declare function maskAccountNumber(str: string): string;
+
+type ValueOf<T> = T[keyof T];
+
+declare const DocumentType: {
+    readonly STATEMENTS: "STATEMENTS";
+    readonly PAYOUTS: "PAYOUTS";
+    readonly SETTLEMENTS: "SETTLEMENTS";
+    readonly TRANSACTIONS: "TRANSACTIONS";
+    readonly TRANSACTIONS_INTERNAL: "TRANSACTIONS_INTERNAL";
+    readonly REFUNDS: "REFUNDS";
+    readonly REFUNDS_INTERNAL_GATEWAY: "REFUNDS_INTERNAL_GATEWAY";
+    readonly PROFIT_FEES: "PROFIT_FEES";
+    readonly PAYMENT_METHODS: "PAYMENT_METHODS";
+    readonly VENDOR_LIST: "VENDOR_LIST";
+    readonly VENDOR_SALES: "VENDOR_SALES";
+    readonly EXCEPTIONS: "EXCEPTIONS";
+    readonly REFUNDS_POS: "REFUNDS_POS";
+    readonly REFUNDS_INTERNAL_POS: "REFUNDS_INTERNAL_POS";
+};
+type DocumentType = ValueOf<typeof DocumentType>;
+
+declare const FileFormat: {
+    readonly PDF: "pdf";
+    readonly CSV: "csv";
+    readonly XLSX: "xlsx";
+};
+type FileFormat = ValueOf<typeof FileFormat>;
+
+declare class MerchantDetailsHeaderExportDto {
+    name: string;
+    profile?: string;
+    accountNumber: string;
+    totalBalance: number;
+    availableBalance: number;
+    pendingBalance: number;
+    currency: string;
+}
+
+declare class DocumentGenerationRequestDto<T = any> {
+    documentFormat: FileFormat;
+    documentType: DocumentType;
+    merchantInfo: MerchantDetailsHeaderExportDto;
+    dateRange: DateRangeExportDto;
+    data: T[];
+    presignedURL?: boolean;
+}
+
+declare class DocumentPathResponseDto {
+    name: string;
+    path: string;
+    s3Result: object;
+    constructor(name: string, path: string, commandResult: object);
+}
+
+declare class DocumentExportClient {
+    client: ReturnType<typeof axios.create>;
+    constructor(documentMsBaseUrl: string, documentMSCommunicationKey: string);
+    generateDocument(documentFormat: FileFormat, documentType: DocumentType, dateRange: DateRangeExportDto, payload: {
+        data: object[];
+    }, merchantInfo: MerchantDetailsHeaderExportDto, presignedURL?: boolean): Promise<DocumentPathResponseDto>;
+}
+
+declare class DocumentError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    details?: any | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined, details?: any | undefined);
+}
+declare class DocumentGenerationError extends DocumentError {
+    constructor(message: string, details?: any);
+}
+declare class DocumentNetworkError extends DocumentError {
+    constructor(message: string, statusCode?: number, details?: any);
+}
+
+declare class DocumentValidationError extends DocumentError {
+    validationErrors: ValidationError[];
+    constructor(message: string, validationErrors: ValidationError[]);
+    getMessages(): string[];
+}
+
+declare class ExceptionDocument {
+    createdAt: string | Date;
+    merchantName: string;
+    merchantRisk: string;
+    cardNumber: string;
+    cardIssuer: string;
+    cardHolderName: string;
+    payerIpAddress: string;
+    product: string;
+    paymentMethod: string;
+    amount: number | string;
+    action: string;
+}
+declare class ExceptionExportDto {
+    data: ExceptionDocument[];
+}
+
+declare class PaymentMethodDocument {
+    paymentMethod: string;
+    totalAmount: number;
+    percentageOfTotal: string;
+    txnCount: number;
+}
+declare class PaymentMethodsExportDto {
+    data: PaymentMethodDocument[];
+}
+
+declare class PayoutDocument {
+    id: string;
+    mid: string;
+    iban: string;
+    amount: number;
+    currency: string;
+    numOfTxn: number;
+    notes: string;
+    createdAt: string | Date;
+}
+declare class PayoutsExportDto {
+    data: PayoutDocument[];
+}
+
+declare class ProfitFeesDocument {
+    mid: string;
+    merchantName: string;
+    numOfTxn: number;
+    totalTxnAmount: number;
+    totalProfitAmount: number;
+    type: 'PROFIT' | 'FEES';
+}
+declare class ProfitFeesExportDto {
+    data: ProfitFeesDocument[];
+}
+
+declare class RefundBaseDto {
+    createdAt: string | Date;
+    refundedAt?: string | Date;
+    rejectedAt?: string | Date;
+    ecomReference?: string;
+    merchantReference?: string;
+    originalTxnId: string;
+    originalTxnDate: string | Date;
+    originalTxnAmount: number;
+    amount: number;
+    paymentMethod: string;
+    status: string;
+    mid: string;
+    merchantName: string;
+}
+declare class RefundDocument extends RefundBaseDto {
+    customerName: string;
+    customerPhone: string;
+    invoiceNumber?: string;
+    product: string;
+    type: string;
+    requestedBy?: string;
+}
+declare class RefundPOSDocument extends RefundBaseDto {
+    authId: string | null;
+    terminalId: string;
+    terminalName?: string;
+    cardNumber: string;
+}
+declare class RefundsExportDto {
+    data: RefundDocument[];
+}
+declare class RefundsPOSExportDto {
+    data: RefundPOSDocument[];
+}
+
+declare class SettlementDocument {
+    mid: string;
+    merchantName: string;
+    bank?: string;
+    holderName?: string;
+    iban?: string;
+    accountNumber?: string;
+    totalAmount: number;
+    totalTxnCount: number;
+    settlementDate?: string | null;
+}
+declare class SettlementsExportDto {
+    data: SettlementDocument[];
+}
+
+declare class StatementDocument {
+    createdAt: Date | string;
+    transactionId?: string;
+    merchantReference?: string;
+    invoiceId?: string;
+    description?: string;
+    paymentMethod: string;
+    amount: number;
+    type: string;
+    balanceAfter: number;
+}
+declare class StatementsExportDto {
+    data: StatementDocument[];
+}
+
+declare class TransactionDocument {
+    createdAt: string | Date;
+    id: string;
+    ecomReference: string;
+    merchantReference?: string;
+    merchantName?: string;
+    invoiceNumber?: string;
+    customerName: string;
+    customerPhone: string;
+    amount: number;
+    product: string;
+    paymentMethod: string;
+    status: string;
+    authCode?: string;
+    terminalId?: string;
+    terminalName?: string;
+    cardNumber?: string;
+}
+declare class TransactionsExportDto {
+    data: TransactionDocument[];
+}
+
+declare class VendorSalesDocument {
+    mid: string;
+    vendorNumber: string;
+    vendorName: string;
+    totalTxnAmount: number;
+}
+declare class VendorListDocument {
+    mid: string;
+    vendorNumber: string;
+    vendorName: string;
+    email: string;
+    bank: string;
+    iban: string;
+    commission: number | string;
+}
+declare class VendorSalesExportDto {
+    data: VendorSalesDocument[];
+}
+declare class VendorListExportDto {
+    data: VendorListDocument[];
+}
+
+declare const DocumentPayloadMap: {
+    readonly STATEMENTS: typeof StatementsExportDto;
+    readonly PAYOUTS: typeof PayoutsExportDto;
+    readonly SETTLEMENTS: typeof SettlementsExportDto;
+    readonly TRANSACTIONS: typeof TransactionsExportDto;
+    readonly TRANSACTIONS_INTERNAL: typeof TransactionsExportDto;
+    readonly REFUNDS: typeof RefundsExportDto;
+    readonly REFUNDS_INTERNAL_GATEWAY: typeof RefundsExportDto;
+    readonly PROFIT_FEES: typeof ProfitFeesExportDto;
+    readonly PAYMENT_METHODS: typeof PaymentMethodsExportDto;
+    readonly VENDOR_LIST: typeof VendorListExportDto;
+    readonly VENDOR_SALES: typeof VendorSalesExportDto;
+    readonly EXCEPTIONS: typeof ExceptionExportDto;
+    readonly REFUNDS_POS: typeof RefundsPOSExportDto;
+    readonly REFUNDS_INTERNAL_POS: typeof RefundsPOSExportDto;
+};
+
+declare class InvoiceDocument {
+    createdAt: string | Date;
+    paidAt: string | Date;
+    customerName: string;
+    customerPhone: string;
+    id: string;
+    merchantReference: string;
+    createdBy: string;
+    transactionId: string;
+    status: string;
+    amount: number;
+    paymentMethod: string;
+}
+declare class InvoiceHistoryDocument {
+    createdAt: string | Date;
+    action: string;
+    createdBy: string;
+    invoiceId: string;
+    paymentMethod: string;
+    paymentMethodBrand: string;
+}
+declare class InvoiceExportDto {
+    data: InvoiceDocument[];
+}
+declare class InvoiceHistoryExportDto {
+    data: InvoiceHistoryDocument[];
+}
+
+interface ValidationResult<T = any> {
+    isValid: boolean;
+    errors?: ValidationError[];
+    validatedPayload?: T;
+    errorMessage?: string;
+}
+declare class DocumentValidator {
+    static validatePayload(type: DocumentType, payload: any): Promise<ValidationResult>;
+    static formatErrors(errors: ValidationError[]): string[];
+}
+
+export { type ChunkedFetchConfig, DateRangeExportDto, DocumentError, DocumentExportClient, DocumentGenerationError, DocumentGenerationRequestDto, DocumentNetworkError, DocumentPathResponseDto, DocumentPayloadMap, DocumentType, DocumentValidationError, DocumentValidator, ExceptionExportDto, FileFormat, InvoiceExportDto, InvoiceHistoryExportDto, MerchantDetailsHeaderExportDto, type PageOptionsDto, PaymentMethodsExportDto, PayoutsExportDto, ProfitFeesExportDto, RefundsExportDto, RefundsPOSExportDto, SettlementsExportDto, StatementsExportDto, TransactionsExportDto, type ValidationResult, type ValueOf, VendorListExportDto, VendorSalesExportDto, fetchDBQueryInChunks, maskAccountNumber };