israeli-banks-actual-budget-importer 1.2.5 → 1.3.1

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [1.3.1](https://github.com/tomerh2001/israeli-banks-actual-budget-importer/compare/v1.3.0...v1.3.1) (2025-05-23)
+
+
+### Bug Fixes
+
+* ensure graceful shutdown with timeout in scheduled run ([49bc74f](https://github.com/tomerh2001/israeli-banks-actual-budget-importer/commit/49bc74f0e631da2f4407bdd0aae9b105f165b134))
+* ensure graceful shutdown with timeout in scheduled run ([ccd946c](https://github.com/tomerh2001/israeli-banks-actual-budget-importer/commit/ccd946c52181a939abd044ce443acafc18319b82))
+
+# [1.3.0](https://github.com/tomerh2001/israeli-banks-actual-budget-importer/compare/v1.2.5...v1.3.0) (2025-05-23)
+
+
+### Bug Fixes
+
+* update schedule environment variable for periodic imports in docker compose ([82344ef](https://github.com/tomerh2001/israeli-banks-actual-budget-importer/commit/82344ef9d4a4629af884bd8adb87c7cbac87628d))
+
+
+### Features
+
+* add cron scheduling support for periodic imports and update dependencies ([03fc0c3](https://github.com/tomerh2001/israeli-banks-actual-budget-importer/commit/03fc0c3cee132ab7c513e0547337e5dcce590914))
+
 ## [1.2.5](https://github.com/tomerh2001/israeli-banks-actual-budget-importer/compare/v1.2.4...v1.2.5) (2025-05-12)
 
 

package/README.md

@@ -30,10 +30,13 @@ services:
     image: tomerh2001/israeli-banks-actual-budget-importer:latest
     cap_add:
       - SYS_ADMIN
+    environment:
+      - TZ=Asia/Jerusalem
+      - SCHEDULE=0 0 * * * # Optional (Used to run periodically - remove to run once)
     volumes:
       - ./config.json:/app/config.json
       - ./cache:/app/cache # Optional
-      - ./chrome-data:/app/chrome-data # Optional (Can be used to solve 2FA issues like with hapoalim)
+      - ./chrome-data:/app/chrome-data # Optional (Used to solve 2FA issues like with hapoalim)
 ```
 
 ### Prerequisites

package/compose.yml

@@ -5,9 +5,12 @@ services:
     cap_add:
       - SYS_ADMIN
     platform: linux/amd64
-    # build:
-    #   context: .
-    #   dockerfile: Dockerfile
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      - TZ=Asia/Jerusalem
+      - SCHEDULE=0 0 * * *
     volumes:
       - ./config.json:/app/config.json
       - ./cache:/app/cache

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.5",
+  "version": "1.3.1",
   "name": "israeli-banks-actual-budget-importer",
   "module": "index.ts",
   "type": "module",
@@ -26,9 +26,11 @@
   "packageManager": "yarn@4.9.1",
   "dependencies": {
     "@actual-app/api": "^25.5.0",
+    "cronstrue": "^2.61.0",
     "israeli-bank-scrapers": "^5.4.7",
     "lodash": "^4.17.21",
     "moment": "^2.30.1",
+    "node-cron": "^4.0.7",
     "p-queue": "^8.1.0",
     "tsx": "^4.19.4"
   }

package/src/index.ts

@@ -1,4 +1,5 @@
 /* eslint-disable unicorn/no-process-exit */
+
 /* eslint-disable no-await-in-loop */
 /* eslint-disable n/file-extension-in-import */
 
@@ -8,27 +9,63 @@ import _ from 'lodash';
 import actual from '@actual-app/api';
 import Queue from 'p-queue';
 import moment from 'moment';
+import cron, {type ScheduledTask, validate} from 'node-cron';
+import cronstrue from 'cronstrue';
 import config from '../config.json' assert {type: 'json'};
 import type {ConfigBank} from './config.d.ts';
 import {scrapeAndImportTransactions} from './utils.ts';
 
-const queue = new Queue({
-	concurrency: 10,
-	autoStart: true,
-	interval: 1000,
-	intervalCap: 10,
-});
+let scheduledTask: ScheduledTask;
+
+async function run() {
+	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);
 
-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}));
+	}
 
-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');
 }
 
-await queue.onIdle();
-await actual.shutdown();
+async function safeRun() {
+	try {
+		await run();
+	} catch (error) {
+		console.error('Error running scraper:', error);
+	} finally {
+		if (scheduledTask) {
+			printNextRunTime();
+		}
+	}
+}
 
-console.log('Done');
+function printNextRunTime() {
+	const nextRun = scheduledTask.getNextRun();
+	console.log('Next run:', moment(nextRun).fromNow(), 'at', moment(nextRun).format('YYYY-MM-DD HH:mm:ss'));
+}
+
+if (process.env?.SCHEDULE) {
+	if (!validate(process.env.SCHEDULE)) {
+		throw new Error(`Invalid cron schedule: ${process.env?.SCHEDULE}`);
+	}
 
-setTimeout(() => process.exit(0), moment.duration(5, 'seconds').asMilliseconds());
+	console.log('Started scheduled run:', process.env?.SCHEDULE, `(${cronstrue.toString(process.env?.SCHEDULE)})`);
+	scheduledTask = cron.schedule(process.env.SCHEDULE, safeRun);
+
+	printNextRunTime();
+} else {
+	await safeRun().finally(() => {
+		setTimeout(() => process.exit(0), moment.duration(5, 'seconds').asMilliseconds());
+	});
+}