Skip to content

A local-first personal finance app

Refactor GoCardless bank code to avoid duplication (#362)

Robert Dyer55724acafa5e
diff --git a/src/app-gocardless/banks/american-express-aesudef1.js b/src/app-gocardless/banks/american-express-aesudef1.js
index 23695fc29d..5cf17d87cf 100644
--- a/src/app-gocardless/banks/american-express-aesudef1.js
+++ b/src/app-gocardless/banks/american-express-aesudef1.js
@@ -1,7 +1,11 @@
-import { amountToInteger, sortByBookingDateOrValueDate } from '../utils.js';
+import Fallback from './integration-bank.js';
+
+import { amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['AMERICAN_EXPRESS_AESUDEF1'],
accessValidForDays: 180,
@@ -29,10 +33,6 @@ export default {
};
},
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
/**
* For AMERICAN_EXPRESS_AESUDEF1 we don't know what balance was
* after each transaction so we have to calculate it by getting
diff --git a/src/app-gocardless/banks/bankinter-bkbkesmm.js b/src/app-gocardless/banks/bankinter-bkbkesmm.js
index a14dfcdc19..f5366e4e6f 100644
--- a/src/app-gocardless/banks/bankinter-bkbkesmm.js
+++ b/src/app-gocardless/banks/bankinter-bkbkesmm.js
@@ -1,21 +1,11 @@
-import {
- printIban,
- amountToInteger,
- sortByBookingDateOrValueDate,
-} from '../utils.js';
+import Fallback from './integration-bank.js';
-const SORTED_BALANCE_TYPE_LIST = [
- 'closingBooked',
- 'expected',
- 'forwardAvailable',
- 'interimAvailable',
- 'interimBooked',
- 'nonInvoiced',
- 'openingBooked',
-];
+import { printIban } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['BANKINTER_BKBKESMM'],
accessValidForDays: 90,
@@ -44,21 +34,4 @@ export default {
date: transaction.bookingDate || transaction.valueDate,
};
},
-
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
- calculateStartingBalance(sortedTransactions = [], balances = []) {
- const currentBalance = balances
- .filter((item) => SORTED_BALANCE_TYPE_LIST.includes(item.balanceType))
- .sort(
- (a, b) =>
- SORTED_BALANCE_TYPE_LIST.indexOf(a.balanceType) -
- SORTED_BALANCE_TYPE_LIST.indexOf(b.balanceType),
- )[0];
- return sortedTransactions.reduce((total, trans) => {
- return total - amountToInteger(trans.transactionAmount.amount);
- }, amountToInteger(currentBalance?.balanceAmount?.amount || 0));
- },
};
diff --git a/src/app-gocardless/banks/belfius_gkccbebb.js b/src/app-gocardless/banks/belfius_gkccbebb.js
index 9bbc8ac108..35d9747cd4 100644
--- a/src/app-gocardless/banks/belfius_gkccbebb.js
+++ b/src/app-gocardless/banks/belfius_gkccbebb.js
@@ -2,14 +2,12 @@ import Fallback from './integration-bank.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['BELFIUS_GKCCBEBB'],
accessValidForDays: 180,
- normalizeAccount(account) {
- return Fallback.normalizeAccount(account);
- },
-
// The problem is that we have transaction with duplicated transaction ids.
// This is not expected and the nordigen api has a work-around for some backs
// They will set an internalTransactionId which is unique
@@ -20,12 +18,4 @@ export default {
date: transaction.bookingDate || transaction.valueDate,
};
},
-
- sortTransactions(transactions = []) {
- return Fallback.sortTransactions(transactions);
- },
-
- calculateStartingBalance(sortedTransactions = [], balances = []) {
- return Fallback.calculateStartingBalance(sortedTransactions, balances);
- },
};
diff --git a/src/app-gocardless/banks/bnp-be-gebabebb.js b/src/app-gocardless/banks/bnp-be-gebabebb.js
index 84e6da98b8..6cc688fec8 100644
--- a/src/app-gocardless/banks/bnp-be-gebabebb.js
+++ b/src/app-gocardless/banks/bnp-be-gebabebb.js
@@ -1,21 +1,9 @@
-import {
- sortByBookingDateOrValueDate,
- amountToInteger,
- printIban,
-} from '../utils.js';
-
-const SORTED_BALANCE_TYPE_LIST = [
- 'closingBooked',
- 'expected',
- 'forwardAvailable',
- 'interimAvailable',
- 'interimBooked',
- 'nonInvoiced',
- 'openingBooked',
-];
+import Fallback from './integration-bank.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: [
'FINTRO_BE_GEBABEBB',
'HELLO_BE_GEBABEBB',
@@ -24,20 +12,6 @@ export default {
accessValidForDays: 180,
- normalizeAccount(account) {
- return {
- account_id: account.id,
- institution: account.institution,
- mask: (account?.iban || '0000').slice(-4),
- iban: account?.iban || null,
- name: [account.name, printIban(account), account.currency]
- .filter(Boolean)
- .join(' '),
- official_name: `integration-${account.institution_id}`,
- type: 'checking',
- };
- },
-
/** BNP_BE_GEBABEBB provides a lot of useful information via the 'additionalField'
* There does not seem to be a specification of this field, but the following information is contained in its subfields:
* - for pending transactions: the 'atmPosName'
@@ -98,21 +72,4 @@ export default {
date: transaction.valueDate || transaction.bookingDate,
};
},
-
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
- calculateStartingBalance(sortedTransactions = [], balances = []) {
- const currentBalance = balances
- .filter((item) => SORTED_BALANCE_TYPE_LIST.includes(item.balanceType))
- .sort(
- (a, b) =>
- SORTED_BALANCE_TYPE_LIST.indexOf(a.balanceType) -
- SORTED_BALANCE_TYPE_LIST.indexOf(b.balanceType),
- )[0];
- return sortedTransactions.reduce((total, trans) => {
- return total - amountToInteger(trans.transactionAmount.amount);
- }, amountToInteger(currentBalance?.balanceAmount?.amount || 0));
- },
};
diff --git a/src/app-gocardless/banks/danskebank-dabno22.js b/src/app-gocardless/banks/danskebank-dabno22.js
index 98f7dc1084..c10685813a 100644
--- a/src/app-gocardless/banks/danskebank-dabno22.js
+++ b/src/app-gocardless/banks/danskebank-dabno22.js
@@ -1,11 +1,11 @@
-import {
- printIban,
- amountToInteger,
- sortByBookingDateOrValueDate,
-} from '../utils.js';
+import Fallback from './integration-bank.js';
+
+import { printIban, amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['DANSKEBANK_DABANO22'],
accessValidForDays: 180,
@@ -46,10 +46,6 @@ export default {
};
},
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
calculateStartingBalance(sortedTransactions = [], balances = []) {
const currentBalance = balances.find(
(balance) => balance.balanceType === 'interimAvailable',
diff --git a/src/app-gocardless/banks/ing-ingddeff.js b/src/app-gocardless/banks/ing-ingddeff.js
index ab7db91c81..3671f865dd 100644
--- a/src/app-gocardless/banks/ing-ingddeff.js
+++ b/src/app-gocardless/banks/ing-ingddeff.js
@@ -1,7 +1,11 @@
+import Fallback from './integration-bank.js';
+
import { printIban, amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['ING_INGDDEFF'],
accessValidForDays: 180,
diff --git a/src/app-gocardless/banks/ing-pl-ingbplpw.js b/src/app-gocardless/banks/ing-pl-ingbplpw.js
index f08d889c48..ff7f3e23a7 100644
--- a/src/app-gocardless/banks/ing-pl-ingbplpw.js
+++ b/src/app-gocardless/banks/ing-pl-ingbplpw.js
@@ -1,7 +1,11 @@
+import Fallback from './integration-bank.js';
+
import { printIban, amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['ING_PL_INGBPLPW'],
accessValidForDays: 180,
diff --git a/src/app-gocardless/banks/mbank-retail-brexplpw.js b/src/app-gocardless/banks/mbank-retail-brexplpw.js
index b531680166..90bc58409d 100644
--- a/src/app-gocardless/banks/mbank-retail-brexplpw.js
+++ b/src/app-gocardless/banks/mbank-retail-brexplpw.js
@@ -1,7 +1,11 @@
+import Fallback from './integration-bank.js';
+
import { printIban, amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['MBANK_RETAIL_BREXPLPW'],
accessValidForDays: 180,
diff --git a/src/app-gocardless/banks/norwegian-xx-norwnok1.js b/src/app-gocardless/banks/norwegian-xx-norwnok1.js
index 4d3acdcdb9..6fe7344455 100644
--- a/src/app-gocardless/banks/norwegian-xx-norwnok1.js
+++ b/src/app-gocardless/banks/norwegian-xx-norwnok1.js
@@ -1,11 +1,11 @@
-import {
- printIban,
- amountToInteger,
- sortByBookingDateOrValueDate,
-} from '../utils.js';
+import Fallback from './integration-bank.js';
+
+import { printIban, amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: [
'NORWEGIAN_NO_NORWNOK1',
'NORWEGIAN_SE_NORWNOK1',
@@ -72,10 +72,6 @@ export default {
return null;
},
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
/**
* For NORWEGIAN_XX_NORWNOK1 we don't know what balance was
* after each transaction so we have to calculate it by getting
diff --git a/src/app-gocardless/banks/sandboxfinance-sfin0000.js b/src/app-gocardless/banks/sandboxfinance-sfin0000.js
index 5106b882bc..10b455d3d3 100644
--- a/src/app-gocardless/banks/sandboxfinance-sfin0000.js
+++ b/src/app-gocardless/banks/sandboxfinance-sfin0000.js
@@ -1,11 +1,11 @@
-import {
- printIban,
- amountToInteger,
- sortByBookingDateOrValueDate,
-} from '../utils.js';
+import Fallback from './integration-bank.js';
+
+import { printIban, amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['SANDBOXFINANCE_SFIN0000'],
accessValidForDays: 90,
@@ -37,10 +37,6 @@ export default {
};
},
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
/**
* For SANDBOXFINANCE_SFIN0000 we don't know what balance was
* after each transaction so we have to calculate it by getting
diff --git a/src/app-gocardless/banks/seb-kort-bank-ab.js b/src/app-gocardless/banks/seb-kort-bank-ab.js
index d53e817728..7ff7080ba8 100644
--- a/src/app-gocardless/banks/seb-kort-bank-ab.js
+++ b/src/app-gocardless/banks/seb-kort-bank-ab.js
@@ -1,11 +1,11 @@
-import {
- printIban,
- amountToInteger,
- sortByBookingDateOrValueDate,
-} from '../utils.js';
+import Fallback from './integration-bank.js';
+
+import { printIban, amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['SEB_KORT_AB_NO_SKHSFI21', 'SEB_KORT_AB_SE_SKHSFI21'],
accessValidForDays: 180,
@@ -39,10 +39,6 @@ export default {
};
},
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
/**
* For SEB_KORT_AB_NO_SKHSFI21 and SEB_KORT_AB_SE_SKHSFI21 we don't know what balance was
* after each transaction so we have to calculate it by getting
diff --git a/src/app-gocardless/banks/seb-privat.js b/src/app-gocardless/banks/seb-privat.js
index fce6b0be3c..4accc1815c 100644
--- a/src/app-gocardless/banks/seb-privat.js
+++ b/src/app-gocardless/banks/seb-privat.js
@@ -1,30 +1,16 @@
+import Fallback from './integration-bank.js';
+
import * as d from 'date-fns';
-import {
- sortByBookingDateOrValueDate,
- amountToInteger,
- printIban,
-} from '../utils.js';
+import { amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['SEB_ESSESESS_PRIVATE'],
accessValidForDays: 180,
- normalizeAccount(account) {
- return {
- account_id: account.id,
- institution: account.institution,
- mask: (account?.iban || '0000').slice(-4),
- iban: account?.iban || null,
- name: [account.name, printIban(account), account.currency]
- .filter(Boolean)
- .join(' '),
- official_name: `integration-${account.institution_id}`,
- type: 'checking',
- };
- },
-
normalizeTransaction(transaction, _booked) {
const date =
transaction.bookingDate ||
@@ -45,10 +31,6 @@ export default {
};
},
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
calculateStartingBalance(sortedTransactions = [], balances = []) {
const currentBalance = balances.find(
(balance) => 'interimBooked' === balance.balanceType,
diff --git a/src/app-gocardless/banks/sparnord-spnodk22.js b/src/app-gocardless/banks/sparnord-spnodk22.js
index 2f1b7a0952..d518b2ec29 100644
--- a/src/app-gocardless/banks/sparnord-spnodk22.js
+++ b/src/app-gocardless/banks/sparnord-spnodk22.js
@@ -1,21 +1,9 @@
-import {
- sortByBookingDateOrValueDate,
- amountToInteger,
- printIban,
-} from '../utils.js';
-
-const SORTED_BALANCE_TYPE_LIST = [
- 'closingBooked',
- 'expected',
- 'forwardAvailable',
- 'interimAvailable',
- 'interimBooked',
- 'nonInvoiced',
- 'openingBooked',
-];
+import Fallback from './integration-bank.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: [
'SPARNORD_SPNODK22',
'LAGERNES_BANK_LAPNDKK1',
@@ -24,20 +12,6 @@ export default {
accessValidForDays: 180,
- normalizeAccount(account) {
- return {
- account_id: account.id,
- institution: account.institution,
- mask: (account?.iban || '0000').slice(-4),
- iban: account?.iban || null,
- name: [account.name, printIban(account), account.currency]
- .filter(Boolean)
- .join(' '),
- official_name: `integration-${account.institution_id}`,
- type: 'checking',
- };
- },
-
/**
* Banks on the BEC backend only give information regarding the transaction in additionalInformation
*/
@@ -48,21 +22,4 @@ export default {
remittanceInformationUnstructured: transaction.additionalInformation,
};
},
-
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
- calculateStartingBalance(sortedTransactions = [], balances = []) {
- const currentBalance = balances
- .filter((item) => SORTED_BALANCE_TYPE_LIST.includes(item.balanceType))
- .sort(
- (a, b) =>
- SORTED_BALANCE_TYPE_LIST.indexOf(a.balanceType) -
- SORTED_BALANCE_TYPE_LIST.indexOf(b.balanceType),
- )[0];
- return sortedTransactions.reduce((total, trans) => {
- return total - amountToInteger(trans.transactionAmount.amount);
- }, amountToInteger(currentBalance?.balanceAmount?.amount || 0));
- },
};
diff --git a/src/app-gocardless/banks/spk-karlsruhe-karsde66.js b/src/app-gocardless/banks/spk-karlsruhe-karsde66.js
index 94af8b6683..d4ddc45a23 100644
--- a/src/app-gocardless/banks/spk-karlsruhe-karsde66.js
+++ b/src/app-gocardless/banks/spk-karlsruhe-karsde66.js
@@ -1,11 +1,11 @@
-import {
- printIban,
- amountToInteger,
- sortByBookingDateOrValueDate,
-} from '../utils.js';
+import Fallback from './integration-bank.js';
+
+import { printIban, amountToInteger } from '../utils.js';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['SPK_KARLSRUHE_KARSDE66XXX'],
accessValidForDays: 90,
@@ -74,10 +74,6 @@ export default {
};
},
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
/**
* For SANDBOXFINANCE_SFIN0000 we don't know what balance was
* after each transaction so we have to calculate it by getting
diff --git a/src/app-gocardless/banks/spk-marburg-biedenkopf-heladef1mar.js b/src/app-gocardless/banks/spk-marburg-biedenkopf-heladef1mar.js
index 70374131d9..73d5101edd 100644
--- a/src/app-gocardless/banks/spk-marburg-biedenkopf-heladef1mar.js
+++ b/src/app-gocardless/banks/spk-marburg-biedenkopf-heladef1mar.js
@@ -1,22 +1,12 @@
-import {
- printIban,
- amountToInteger,
- sortByBookingDateOrValueDate,
-} from '../utils.js';
-import d from 'date-fns';
+import Fallback from './integration-bank.js';
-const SORTED_BALANCE_TYPE_LIST = [
- 'closingBooked',
- 'expected',
- 'forwardAvailable',
- 'interimAvailable',
- 'interimBooked',
- 'nonInvoiced',
- 'openingBooked',
-];
+import { printIban } from '../utils.js';
+import d from 'date-fns';
/** @type {import('./bank.interface.js').IBank} */
export default {
+ ...Fallback,
+
institutionIds: ['SPK_MARBURG_BIEDENKOPF_HELADEF1MAR'],
accessValidForDays: 180,
@@ -68,22 +58,4 @@ export default {
remittanceInformationUnstructured: remittanceInformationUnstructured,
};
},
-
- sortTransactions(transactions = []) {
- return sortByBookingDateOrValueDate(transactions);
- },
-
- calculateStartingBalance(sortedTransactions = [], balances = []) {
- const currentBalance = balances
- .filter((item) => SORTED_BALANCE_TYPE_LIST.includes(item.balanceType))
- .sort(
- (a, b) =>
- SORTED_BALANCE_TYPE_LIST.indexOf(a.balanceType) -
- SORTED_BALANCE_TYPE_LIST.indexOf(b.balanceType),
- )[0];
-
- return sortedTransactions.reduce((total, trans) => {
- return total - amountToInteger(trans.transactionAmount.amount);
- }, amountToInteger(currentBalance?.balanceAmount?.amount || 0));
- },
};
diff --git a/upcoming-release-notes/362.md b/upcoming-release-notes/362.md
new file mode 100644
index 0000000000..535c5914a4
--- /dev/null
+++ b/upcoming-release-notes/362.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [psybers]
+---
+
+Refactor GoCardless bank code to avoid duplication.