israeli-banks-actual-budget-importer 1.0.0-beta.1 → 1.0.0

package/package.json

@@ -1,7 +1,12 @@
 {
+  "version": "1.0.0",
   "name": "israeli-banks-actual-budget-importer",
   "module": "index.ts",
   "type": "module",
+  "scripts": {
+    "start": "NODE_TLS_REJECT_UNAUTHORIZED=0 tsx src/index.ts",
+    "test": "xo"
+  },
   "devDependencies": {
     "@codedependant/semantic-release-docker": "^5.1.0",
     "@semantic-release/changelog": "^6.0.3",
@@ -10,15 +15,20 @@
     "@semantic-release/github": "^11.0.1",
     "@semantic-release/npm": "^12.0.1",
     "@semantic-release/release-notes-generator": "^14.0.3",
+    "@types/lodash": "^4.17.16",
+    "@types/papaparse": "^5.3.15",
     "bun-types": "latest",
+    "papaparse": "^5.5.2",
+    "typescript": "^5.8.2",
     "xo": "^0.60.0"
   },
-  "peerDependencies": {
-    "typescript": "^5.8.2"
-  },
-  "version": "1.0.0-beta.1",
-  "scripts": {
-    "test": "xo"
-  },
-  "packageManager": "yarn@4.7.0"
+  "packageManager": "yarn@4.7.0",
+  "dependencies": {
+    "@actual-app/api": "^25.3.1",
+    "israeli-bank-scrapers": "^5.4.5",
+    "lodash": "^4.17.21",
+    "moment": "^2.30.1",
+    "p-queue": "^8.1.0",
+    "tsx": "^4.19.3"
+  }
 }

package/src/config.d.ts

@@ -0,0 +1,26 @@
+import type {InitConfig} from '@actual-app/api/@types/loot-core/server/main';
+import type {ScraperCredentials, CompanyTypes} from 'israeli-bank-scrapers';
+
+export type Config = {
+	banks: ConfigBanks;
+	actual: ConfigActual;
+};
+
+export type ConfigActual = {
+	init: InitConfig;
+	budget: ConfigActualBudget;
+};
+
+export type ConfigActualBudget = {
+	syncId: string;
+	password: string;
+};
+
+export type ConfigBanks = Partial<{
+	[key in CompanyTypes]: ConfigBank;
+}>;
+
+export type ConfigBank = ScraperCredentials & {
+	actualAccountId: string;
+	reconcile?: boolean;
+};

package/src/index.ts

@@ -0,0 +1,27 @@
+/* eslint-disable no-await-in-loop */
+/* eslint-disable n/file-extension-in-import */
+
+import {type CompanyTypes} from 'israeli-bank-scrapers';
+import _ from 'lodash';
+import actual from '@actual-app/api';
+import Queue from 'p-queue';
+import {config, type ConfigBank} from '../config.ts';
+import {scrapeAndImportTransactions} from './utils.ts';
+
+const queue = new Queue({
+	concurrency: 10,
+	autoStart: true,
+	interval: 1000,
+	intervalCap: 10,
+});
+
+await actual.init(config.actual.init);
+await actual.downloadBudget(config.actual.budget.syncId, config.actual.budget);
+
+for (const [companyId, bank] of _.entries(config.banks) as Array<[CompanyTypes, ConfigBank]>) {
+	await queue.add(async () => scrapeAndImportTransactions({companyId, bank}));
+}
+
+await queue.onIdle();
+await actual.shutdown();
+console.log('Done');

package/src/utils.d.ts

@@ -0,0 +1,8 @@
+import type {ScraperCredentials, CompanyTypes} from 'israeli-bank-scrapers';
+import type actual from '@actual-app/api';
+import {type ConfigBank} from '../config.js';
+
+export type ScrapeTransactionsContext = {
+	companyId: CompanyTypes;
+	bank: ConfigBank;
+};

package/src/utils.ts

@@ -0,0 +1,92 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+
+/* eslint-disable import/extensions */
+/* eslint-disable n/file-extension-in-import */
+import {createScraper, type ScraperCredentials} from 'israeli-bank-scrapers';
+import _ from 'lodash';
+import moment from 'moment';
+import actual from '@actual-app/api';
+import {type PayeeEntity, type TransactionEntity} from '@actual-app/api/@types/loot-core/types/models';
+import {type ScrapeTransactionsContext} from './utils.d';
+
+export async function scrapeAndImportTransactions({companyId, bank}: ScrapeTransactionsContext) {
+	try {
+		const scraper = createScraper({
+			companyId,
+			startDate: moment().subtract(6, 'month').toDate(),
+			executablePath: '/opt/homebrew/bin/chromium',
+			additionalTransactionInformation: true,
+			verbose: false,
+			showBrowser: false,
+		});
+		scraper.onProgress((companyId, payload) => {
+			console.debug('Progress', companyId, payload);
+		});
+
+		const result = await scraper.scrape(bank as ScraperCredentials);
+		if (!result.success) {
+			throw new Error(`Failed to scrape (${result.errorType}): ${result.errorMessage}`);
+		}
+
+		const transactions = _(result.accounts)
+			.filter(account => account.txns.length > 0)
+			.flatMap(account => account.txns)
+			.value();
+
+		for (const account of result.accounts!) {
+			if (account.txns.length <= 0) {
+				continue;
+			}
+		}
+
+		const accounts = await actual.getAccounts() as TransactionEntity[];
+		const account = _.find(accounts, {id: bank.actualAccountId})!;
+		const accountBalance = result.accounts![0].balance!;
+		console.log('Account', account, 'Balance', accountBalance);
+
+		const payees: PayeeEntity[] = await actual.getPayees();
+		const mappedTransactions = transactions.map(async x => ({
+			date: moment(x.date).format('YYYY-MM-DD'),
+			amount: actual.utils.amountToInteger(x.chargedAmount),
+			payee: _.find(payees, {name: x.description})?.id ?? (await actual.createPayee({name: x.description})),
+			imported_payee: x.description,
+			notes: x.status,
+		}));
+
+		const importResult = await actual.importTransactions(bank.actualAccountId, await Promise.all(mappedTransactions), {defaultCleared: true});
+		if (_.isEmpty(importResult)) {
+			console.error('Errors', importResult.errors);
+			throw new Error('Failed to import transactions');
+		} else {
+			console.log('Imported', importResult.added, 'transactions');
+		}
+
+		if (!bank.reconcile) {
+			return;
+		}
+
+		const currentBalance = actual.utils.integerToAmount(await actual.getAccountBalance(bank.actualAccountId));
+		const balanceDiff = accountBalance - currentBalance;
+		if (balanceDiff === 0) {
+			return;
+		}
+
+		console.log('Balance diff', balanceDiff);
+		const reconciliationResult = await actual.importTransactions(bank.actualAccountId, [{
+			date: moment().format('YYYY-MM-DD'),
+			amount: actual.utils.amountToInteger(balanceDiff),
+			payee: null,
+			imported_payee: 'Reconciliation',
+			notes: `Reconciliation from ${currentBalance.toLocaleString()} to ${accountBalance.toLocaleString()}`,
+		}]);
+		if (_.isEmpty(reconciliationResult)) {
+			console.error('Reconciliation errors', reconciliationResult.errors);
+		} else {
+			console.info('Added a reconciliation transaction from', currentBalance, 'to', accountBalance);
+		}
+	} catch (error) {
+		console.error('Error', companyId, error);
+	}
+}
+