TehRiehlBudget/tehriehlbudget-backend/src/statements/parsers/parser.interface.ts

import type { AccountType } from '@prisma/client';

export type ParsedRowType = 'INCOME' | 'EXPENSE';

export interface ParsedRow {
  sourceIndex: number;
  date: string;
  amount: number;
  type: ParsedRowType;
  description: string;
  externalId?: string;
  rawMemo?: string;
  confidence: number;
}

export interface ColumnMapping {
  date?: string;
  description?: string;
  amount?: string;
  debit?: string;
  credit?: string;
  type?: string;
}

export interface NeedsMapping {
  headers: string[];
  sample: string[][];
  guess: ColumnMapping;
}

export interface ParseResult {
  rows: ParsedRow[];
  warnings: string[];
  needsMapping?: NeedsMapping;
}

export interface ParserFileInput {
  buffer: Buffer;
  mimetype?: string;
  originalname?: string;
}

export interface ParseOptions {
  mapping?: ColumnMapping;
  account: { type: AccountType };
}

export interface StatementParser {
  format: 'csv' | 'ofx' | 'pdf';
  canParse(file: ParserFileInput): boolean;
  parse(file: ParserFileInput, options: ParseOptions): Promise<ParseResult>;
}