@fin.cx/csvparser

@fin.cx/csvparser turns CSV exports from financial providers into normalized monetary transactions. It currently includes parsers for Commerzbank, Fidor, PayPal, and Spendesk and exposes TypeScript classes that fit the @fin.cx/portablefinance CSV parser interface.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Installation

pnpm add @fin.cx/csvparser

Supported Providers

| Provider | Class | Input Style | | --- | --- | --- | | Commerzbank | CsvCommerzbank | CSV descriptor with name and contentString | | Fidor Bank | CsvFidor | CSV descriptor with name and contentString | | PayPal | CsvPayPal | CSV descriptor with name and contentString | | Spendesk | CsvSpendesk | CSV string, file, directory, or descriptor |

Every parser returns IMonetaryTransaction[] from getTransactions(). Provider-specific parsing details are kept internally while the public transaction shape stays portable across payment sources.

Quick Start

import { CsvCommerzbank, CsvFidor, CsvPayPal, CsvSpendesk } from '@fin.cx/csvparser';

const parser = new CsvCommerzbank();

parser.addCsvDecriptor({
  name: 'commerzbank.csv',
  contentString: csvFileContent,
});

const transactions = await parser.getTransactions();

The descriptor method name is addCsvDecriptor because it follows the upstream @fin.cx/portablefinance interface.

Parsing Descriptor-Based Providers

Commerzbank, Fidor, and PayPal use the same descriptor workflow:

import { CsvPayPal } from '@fin.cx/csvparser';

const paypalParser = new CsvPayPal();

paypalParser.addCsvDecriptor({
  name: 'paypal.csv',
  contentString: paypalCsv,
});

const paypalTransactions = await paypalParser.getTransactions();

Each resulting transaction contains:

{
  id: string,
  data: {
    paymentAccountId: string,
    originTransactionId: string,
    originAccountId: string,
    additionalIds: string[],
    date: number,
    amount: number,
    description: string,
    name: string,
  }
}

Parsing Spendesk CSV

Spendesk supports descriptor parsing plus convenience constructors for strings, files, and directories.

import { CsvSpendesk } from '@fin.cx/csvparser';

const spendeskParser = await CsvSpendesk.fromCsvString(spendeskCsv);
const spendeskTransactions = await spendeskParser.getTransactions();

From a single CSV file:

const spendeskParser = await CsvSpendesk.fromFile('./exports/Spendesk.csv');
const transactions = await spendeskParser.getTransactions();

From a directory containing files whose names start with Spendesk:

const spendeskParser = await CsvSpendesk.fromDir('./exports');
const transactions = await spendeskParser.getTransactions();

Spendesk also exposes getLoads() and getDebits() for provider-specific filtering before converting to portable transactions.

Merging Spendesk Exports

import { CsvSpendesk } from '@fin.cx/csvparser';

const january = await CsvSpendesk.fromFile('./exports/Spendesk-January.csv');
const february = await CsvSpendesk.fromFile('./exports/Spendesk-February.csv');

await january.concat(february);

const mergedTransactions = await january.getTransactions();

Development

pnpm install
pnpm test
pnpm run build

Tests are powered by @git.zone/tstest, and production builds use @git.zone/tsbuild.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the license file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

Company Information

Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany

For any legal inquiries or further information, please contact us via email at [email protected].

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.