A local-first personal finance app
Add GoCardless integration for COMMERZBANK_COBADEFF (#537)
nsulzer205ccfe3d6a4
diff --git a/src/app-gocardless/bank-factory.js b/src/app-gocardless/bank-factory.jsindex 33e83a78db..a2c32ea941 100644--- a/src/app-gocardless/bank-factory.js+++ b/src/app-gocardless/bank-factory.js@@ -8,6 +8,7 @@ import BelfiusGkccbebb from './banks/belfius_gkccbebb.js';import BerlinerSparkasseBeladebexxx from './banks/berliner_sparkasse_beladebexxx.js';import BnpBeGebabebb from './banks/bnp_be_gebabebb.js';import CbcCregbebb from './banks/cbc_cregbebb.js';+import CommerzbankCobadeff from './banks/commerzbank_cobadeff.js';import DanskebankDabno22 from './banks/danskebank_dabno22.js';import EasybankBawaatww from './banks/easybank_bawaatww.js';import EntercardSwednokk from './banks/entercard_swednokk.js';@@ -47,6 +48,7 @@ export const banks = [BerlinerSparkasseBeladebexxx,BnpBeGebabebb,CbcCregbebb,+ CommerzbankCobadeff,DanskebankDabno22,EasybankBawaatww,EntercardSwednokk,diff --git a/src/app-gocardless/banks/commerzbank_cobadeff.js b/src/app-gocardless/banks/commerzbank_cobadeff.jsnew file mode 100644index 0000000000..eaf061c9b7--- /dev/null+++ b/src/app-gocardless/banks/commerzbank_cobadeff.js@@ -0,0 +1,54 @@+import Fallback from './integration-bank.js';+import { formatPayeeName } from '../../util/payee-name.js';++/** @type {import('./bank.interface.js').IBank} */+export default {+ ...Fallback,++ institutionIds: ['COMMERZBANK_COBADEFF'],++ normalizeTransaction(transaction, _booked) {+ // remittanceInformationUnstructured is limited to 140 chars thus ...+ // ... missing information form remittanceInformationUnstructuredArray ...+ // ... so we recreate it.+ transaction.remittanceInformationUnstructured =+ transaction.remittanceInformationUnstructuredArray.join(' ');++ // The limitations of remittanceInformationUnstructuredArray ...+ // ... can result in split keywords. We fix these. Other ...+ // ... splits will need to be fixed by user with rules.+ const keywords = [+ 'End-to-End-Ref.:',+ 'Mandatsref:',+ 'Gläubiger-ID:',+ 'SEPA-BASISLASTSCHRIFT',+ 'Kartenzahlung',+ 'Dauerauftrag',+ ];+ keywords.forEach((keyword) => {+ transaction.remittanceInformationUnstructured =+ transaction.remittanceInformationUnstructured.replace(+ // There can be spaces in keywords+ RegExp(keyword.split('').join('\\s*'), 'gi'),+ ', ' + keyword + ' ',+ );+ });++ // Clean up remittanceInformation, deduplicate payee (removing slashes ...+ // ... that are added to the remittanceInformation field), and ...+ // ... remove clutter like "End-to-End-Ref.: NOTPROVIDED"+ const payee = transaction.creditorName || transaction.debtorName || '';+ transaction.remittanceInformationUnstructured =+ transaction.remittanceInformationUnstructured+ .replace(/\s*(,)?\s+/g, '$1 ')+ .replace(RegExp(payee.split(' ').join('(/*| )'), 'gi'), ' ')+ .replace(', End-to-End-Ref.: NOTPROVIDED', '')+ .trim();++ return {+ ...transaction,+ payeeName: formatPayeeName(transaction),+ date: transaction.bookingDate,+ };+ },+};diff --git a/src/app-gocardless/banks/tests/commerzbank_cobadeff.spec.js b/src/app-gocardless/banks/tests/commerzbank_cobadeff.spec.jsnew file mode 100644index 0000000000..9667ce2260--- /dev/null+++ b/src/app-gocardless/banks/tests/commerzbank_cobadeff.spec.js@@ -0,0 +1,110 @@+import CommerzbankCobadeff from '../commerzbank_cobadeff.js';++describe('CommerzbankCobadeff', () => {+ describe('#normalizeTransaction', () => {+ it('correctly formats remittanceInformationUnstructured', () => {+ const transaction = {+ endToEndId: '1234567890',+ mandateId: '321654',+ bookingDate: '2024-12-20',+ valueDate: '2024-12-20',+ transactionAmount: {+ amount: '-12.34',+ currency: 'EUR',+ },+ creditorName: 'SHOP NAME CITY DE',+ remittanceInformationUnstructured:+ 'SHOP NAME//CITY/DE\n2024-12-19T15:34:31 KFN 1 AB 1234\nKartenzahlung',+ remittanceInformationUnstructuredArray: [+ 'SHOP NAME//CITY/DE',+ '2024-12-19T15:34:31 KFN 1 AB 1234',+ 'Kartenzahlung',+ ],+ remittanceInformationStructured:+ 'SHOP NAME//CITY/DE 2024-12-19T15:34:31 KFN 1 AB 1234 Kartenzahlung',+ internalTransactionId: '3815213adb654baeadfb231c853',+ };+ const normalizedTransaction = CommerzbankCobadeff.normalizeTransaction(+ transaction,+ false,+ );+ expect(normalizedTransaction.remittanceInformationUnstructured).toEqual(+ '2024-12-19T15:34:31 KFN 1 AB 1234, Kartenzahlung',+ );+ });++ it('correctly formats remittanceInformationUnstructured; repair split keyword', () => {+ const transaction = {+ endToEndId: '901234567890',+ mandateId: 'ABC123DEF456',+ bookingDate: '2024-10-11',+ valueDate: '2024-10-11',+ transactionAmount: {+ amount: '-56.78',+ currency: 'EUR',+ },+ creditorName: 'Long payee name that is eaxtly 35ch',+ remittanceInformationUnstructured:+ 'Long payee name that is eaxtly 35ch\n901234567890/. Long description tha\nt gets cut and is very long, did I\nmention it is long\nEnd-to-En',+ remittanceInformationUnstructuredArray: [+ 'Long payee name that is eaxtly 35ch',+ '901234567890/. Long description tha',+ 't gets cut and is very long, did I',+ 'mention it is long',+ 'End-to-En',+ 'd-Ref.: 901234567890',+ 'Mandatsref: ABC123DEF456',+ 'Gläubiger-ID:',+ 'AB12CDE0000000000000000012',+ 'SEPA-BASISLASTSCHRIFT wiederholend',+ ],+ remittanceInformationStructured:+ 'Long payee name that is eaxtly 35ch 901234567890/. Long description tha t gets cut and is very long, did I mention it is long End-to-En',+ internalTransactionId: '812354cfdea36465asdfe',+ };+ const normalizedTransaction = CommerzbankCobadeff.normalizeTransaction(+ transaction,+ false,+ );+ expect(normalizedTransaction.remittanceInformationUnstructured).toEqual(+ '901234567890/. Long description tha t gets cut and is very long, did I mention it is long, End-to-End-Ref.: 901234567890, Mandatsref: ABC123DEF456, Gläubiger-ID: AB12CDE0000000000000000012, SEPA-BASISLASTSCHRIFT wiederholend',+ );+ });++ it('correctly formats remittanceInformationUnstructured; removing NOTPROVIDED', () => {+ const transaction = {+ endToEndId: 'NOTPROVIDED',+ bookingDate: '2024-12-02',+ valueDate: '2024-12-02',+ transactionAmount: {+ amount: '-9',+ currency: 'EUR',+ },+ creditorName: 'CREDITOR NAME',+ creditorAccount: {+ iban: 'CREDITOR000IBAN',+ },+ remittanceInformationUnstructured:+ 'CREDITOR NAME\nCREDITOR00BIC\nCREDITOR000IBAN\nDESCRIPTION\nEnd-to-End-Ref.: NOTPROVIDED\nDauerauftrag',+ remittanceInformationUnstructuredArray: [+ 'CREDITOR NAME',+ 'CREDITOR00BIC',+ 'CREDITOR000IBAN',+ 'DESCRIPTION',+ 'End-to-End-Ref.: NOTPROVIDED',+ 'Dauerauftrag',+ ],+ remittanceInformationStructured:+ 'CREDITOR NAME CREDITOR00BIC CREDITOR000IBAN DESCRIPTION End-to-End-Ref.: NOTPROVIDED Dauerauftrag',+ internalTransactionId: 'f617dc31ab77622bf13d6c95d6dd8b4a',+ };+ const normalizedTransaction = CommerzbankCobadeff.normalizeTransaction(+ transaction,+ false,+ );+ expect(normalizedTransaction.remittanceInformationUnstructured).toEqual(+ 'CREDITOR00BIC CREDITOR000IBAN DESCRIPTION, Dauerauftrag',+ );+ });+ });+});diff --git a/src/app-gocardless/gocardless-node.types.ts b/src/app-gocardless/gocardless-node.types.tsindex 539c91e4c5..c5ed93205a 100644--- a/src/app-gocardless/gocardless-node.types.ts+++ b/src/app-gocardless/gocardless-node.types.ts@@ -356,7 +356,11 @@ export type Transaction = {/*** Account reference, conditional*/- creditorAccount?: string;+ creditorAccount?:+ | string+ | {+ iban?: string;+ };/*** BICFIdiff --git a/upcoming-release-notes/537.md b/upcoming-release-notes/537.mdnew file mode 100644index 0000000000..0d34ffdf34--- /dev/null+++ b/upcoming-release-notes/537.md@@ -0,0 +1,6 @@+---+category: Enhancements+authors: [nsulzer]+---++Add GoCardless integration for COMMERZBANK_COBADEFF\ No newline at end of file