Merge pull request #142 from shamsss04/shams4

Shams4

Author: AlAfiz

dist/entities/invoice.entity.js.map

@@ -6,8 +6,19 @@ export interface ParsedInvoice {
   dueDate?: string;
 }
 
+/**
+ * Service for parsing PDF invoice files using optical character recognition (OCR) patterns.
+ * Extracts key financial metadata like total amounts and due dates.
+ */
 @Injectable()
 export class PdfService {
+  /**
+   * Parses a PDF buffer to extract invoice data.
+   * 
+   * @param pdfBuffer - The raw binary buffer of the PDF file.
+   * @returns A promise resolving to a ParsedInvoice object.
+   * @throws Error if the PDF parsing fails.
+   */
   async parseInvoicePdf(pdfBuffer: Buffer): Promise<ParsedInvoice> {
     try {
       const data = await pdfParse(pdfBuffer);
@@ -25,6 +36,14 @@ export class PdfService {
     }
   }
 
+  /**
+   * Searches the text content for potential currency amounts using regex patterns.
+   * Identifies the largest amount found as the likely total.
+   * 
+   * @param text - The raw text extracted from the PDF.
+   * @returns The largest positive amount found, or undefined if none found.
+   * @private
+   */
   private extractTotalAmount(text: string): number | undefined {
     // Regex patterns to find currency amounts
     const patterns = [
@@ -57,6 +76,13 @@ export class PdfService {
     return amounts.length > 0 ? Math.max(...amounts) : undefined;
   }
 
+  /**
+   * Searches the text content for potential due dates using regex patterns.
+   * 
+   * @param text - The raw text extracted from the PDF.
+   * @returns The first valid date found in ISO format, or undefined.
+   * @private
+   */
   private extractDueDate(text: string): string | undefined {
     // Regex patterns to find dates
     const patterns = [
@@ -80,6 +106,13 @@ export class PdfService {
     return undefined;
   }
 
+  /**
+   * Normalizes a date string into ISO 8601 format (YYYY-MM-DD).
+   * 
+   * @param dateString - The raw date string to normalize.
+   * @returns The normalized date string, or the original if invalid.
+   * @private
+   */
   private normalizeDate(dateString: string): string {
     // Convert various date formats to ISO format (YYYY-MM-DD)
     const date = new Date(dateString);

dist/health/health.controller.js.map

@@ -1,46 +1,86 @@
 import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, ManyToOne, JoinColumn } from 'typeorm';
 import { User } from './user.entity';
 
+/**
+ * Database entity representing a financial invoice.
+ * Tracks amount, customer details, risk assessment, and processing status.
+ */
 @Entity('invoices')
 export class Invoice {
+  /**
+   * Internal auto-incrementing identifier.
+   */
   @PrimaryGeneratedColumn()
   id: number;
 
+  /**
+   * The total monetary amount of the invoice.
+   */
   @Column({ type: 'decimal', precision: 10, scale: 2 })
   amount: number;
 
+  /**
+   * The date the invoice was issued.
+   */
   @Column({ type: 'timestamp' })
   date: Date;
 
+  /**
+   * Name of the customer or counterparty.
+   */
   @Column()
   customer: string;
 
+  /**
+   * Optional description or notes regarding the invoice.
+   */
   @Column({ type: 'text', nullable: true })
   description?: string;
 
+  /**
+   * Risk score calculated by the RiskService (0-100).
+   */
   @Column({ type: 'int', default: 0 })
   riskScore: number;
 
+  /**
+   * Current status of the invoice in the workflow.
+   */
   @Column({ 
     type: 'varchar', 
     default: 'Pending',
     enum: ['Pending', 'Approved', 'High Risk', 'Rejected']
   })
   status: string;
 
+  /**
+   * Timestamp indicating when the invoice was processed by the system.
+   */
   @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
   processedAt: Date;
 
+  /**
+   * The user who uploaded or owns this invoice.
+   */
   @ManyToOne(() => User, { nullable: true })
   @JoinColumn({ name: 'userId' })
   user?: User;
 
+  /**
+   * Foreign key reference to the user.
+   */
   @Column({ nullable: true })
   userId?: string;
 
+  /**
+   * Record creation timestamp.
+   */
   @CreateDateColumn()
   createdAt: Date;
 
+  /**
+   * Record update timestamp.
+   */
   @UpdateDateColumn()
   updatedAt: Date;
 }

dist/risk/risk.module.js.map

@@ -1,46 +1,86 @@
 import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, ManyToOne, JoinColumn } from 'typeorm';
 import { User } from './user.entity';
 
+/**
+ * Database entity for Sentry-related invoice data.
+ * Used for monitoring and tracking specific high-priority or automated invoice flows.
+ */
 @Entity('Sentry')
 export class Sentry {
+  /**
+   * Internal auto-incrementing identifier.
+   */
   @PrimaryGeneratedColumn()
   id: number;
 
+  /**
+   * The total monetary amount associated with this record.
+   */
   @Column({ type: 'decimal', precision: 10, scale: 2 })
   amount: number;
 
+  /**
+   * The date associated with this entry.
+   */
   @Column({ type: 'timestamp' })
   date: Date;
 
+  /**
+   * Name of the customer or source entity.
+   */
   @Column()
   customer: string;
 
+  /**
+   * Optional description or metadata notes.
+   */
   @Column({ type: 'text', nullable: true })
   description?: string;
 
+  /**
+   * Risk assessment score (0-100).
+   */
   @Column({ type: 'int', default: 0 })
   riskScore: number;
 
+  /**
+   * Current processing status.
+   */
   @Column({ 
     type: 'varchar', 
     default: 'Pending',
     enum: ['Pending', 'Approved', 'High Risk', 'Rejected']
   })
   status: string;
 
+  /**
+   * Timestamp of when this entry was processed.
+   */
   @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
   processedAt: Date;
 
+  /**
+   * The user associated with this entry.
+   */
   @ManyToOne(() => User, { nullable: true })
   @JoinColumn({ name: 'userId' })
   user?: User;
 
+  /**
+   * Foreign key reference to the user.
+   */
   @Column({ nullable: true })
   userId?: string;
 
+  /**
+   * Record creation timestamp.
+   */
   @CreateDateColumn()
   createdAt: Date;
 
+  /**
+   * Record update timestamp.
+   */
   @UpdateDateColumn()
   updatedAt: Date;
 }

dist/tsconfig.build.tsbuildinfo

@@ -1,10 +1,19 @@
 import { Controller, Get } from '@nestjs/common';
 import { HealthService } from './health.service';
 
+/**
+ * Controller for protocol health and monitoring endpoints.
+ * Provides public status information about system components.
+ */
 @Controller('api/v1/protocol')
 export class HealthController {
   constructor(private readonly healthService: HealthService) {}
 
+  /**
+   * Retrieves the current operational status of the protocol.
+   * 
+   * @returns A detailed health report including database and indexer status.
+   */
   @Get('health')
   async getHealth() {
     return this.healthService.getProtocolHealth();

src/dynamic/dynamic.serivice.ts

@@ -1,10 +1,19 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import { PrismaService } from '../prisma/prisma.service';
 
+/**
+ * Service responsible for monitoring the operational health of the protocol.
+ * Checks database connectivity, indexer latency, and pool availability.
+ */
 @Injectable()
 export class HealthService {
   constructor(private readonly prisma: PrismaService) {}
 
+  /**
+   * Performs a comprehensive health check across all core system components.
+   * 
+   * @returns An object containing the overall status, timestamp, and detailed component metrics.
+   */
   async getProtocolHealth() {
     const timestamp = new Date().toISOString();
 

src/entities/invoice.entity.ts

@@ -1,6 +1,10 @@
 import { Module } from '@nestjs/common';
 import { RiskService } from './risk.service';
 
+/**
+ * Module responsible for financial risk assessment.
+ * Exports the RiskService for use in other parts of the application.
+ */
 @Module({
   providers: [RiskService],
   exports: [RiskService],