@actual-app/api 6.8.2 → 6.10.0

package/dist/app/query.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.q = void 0;
+exports.q = q;
 class Query {
     constructor(state) {
         this.state = {
@@ -86,4 +86,3 @@ class Query {
 function q(table) {
     return new Query({ table });
 }
-exports.q = q;

package/dist/index.js

@@ -26,7 +26,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shutdown = exports.init = exports.utils = exports.methods = exports.internal = void 0;
+exports.utils = exports.methods = exports.internal = void 0;
+exports.init = init;
+exports.shutdown = shutdown;
 // @ts-ignore: bundle not available until we build it
 // eslint-disable-next-line import/extensions
 const bundle = __importStar(require("./app/bundle.api.js"));
@@ -53,7 +55,6 @@ async function init(config = {}) {
     injected.override(bundle.lib.send);
     return bundle.lib;
 }
-exports.init = init;
 async function shutdown() {
     if (actualApp) {
         await actualApp.send('sync');
@@ -61,4 +62,3 @@ async function shutdown() {
         actualApp = null;
     }
 }
-exports.shutdown = shutdown;

package/dist/injected.js

@@ -1,8 +1,8 @@
 "use strict";
 // TODO: comment on why it works this way
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.override = exports.send = void 0;
+exports.send = void 0;
+exports.override = override;
 function override(sendImplementation) {
     exports.send = sendImplementation;
 }
-exports.override = override;

package/dist/methods.js

@@ -23,7 +23,52 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteRule = exports.updateRule = exports.createRule = exports.getPayeeRules = exports.getRules = exports.deletePayee = exports.updatePayee = exports.createPayee = exports.getPayees = exports.deleteCategory = exports.updateCategory = exports.createCategory = exports.getCategories = exports.deleteCategoryGroup = exports.updateCategoryGroup = exports.createCategoryGroup = exports.getCategoryGroups = exports.deleteAccount = exports.reopenAccount = exports.closeAccount = exports.updateAccount = exports.createAccount = exports.getAccounts = exports.deleteTransaction = exports.updateTransaction = exports.getTransactions = exports.importTransactions = exports.addTransactions = exports.setBudgetCarryover = exports.setBudgetAmount = exports.getBudgetMonth = exports.getBudgetMonths = exports.runQuery = exports.batchBudgetUpdates = exports.runBankSync = exports.sync = exports.downloadBudget = exports.loadBudget = exports.runImport = exports.q = void 0;
+exports.q = void 0;
+exports.runImport = runImport;
+exports.loadBudget = loadBudget;
+exports.downloadBudget = downloadBudget;
+exports.getBudgets = getBudgets;
+exports.sync = sync;
+exports.runBankSync = runBankSync;
+exports.batchBudgetUpdates = batchBudgetUpdates;
+exports.runQuery = runQuery;
+exports.getBudgetMonths = getBudgetMonths;
+exports.getBudgetMonth = getBudgetMonth;
+exports.setBudgetAmount = setBudgetAmount;
+exports.setBudgetCarryover = setBudgetCarryover;
+exports.addTransactions = addTransactions;
+exports.importTransactions = importTransactions;
+exports.getTransactions = getTransactions;
+exports.updateTransaction = updateTransaction;
+exports.deleteTransaction = deleteTransaction;
+exports.getAccounts = getAccounts;
+exports.createAccount = createAccount;
+exports.updateAccount = updateAccount;
+exports.closeAccount = closeAccount;
+exports.reopenAccount = reopenAccount;
+exports.deleteAccount = deleteAccount;
+exports.getAccountBalance = getAccountBalance;
+exports.getCategoryGroups = getCategoryGroups;
+exports.createCategoryGroup = createCategoryGroup;
+exports.updateCategoryGroup = updateCategoryGroup;
+exports.deleteCategoryGroup = deleteCategoryGroup;
+exports.getCategories = getCategories;
+exports.createCategory = createCategory;
+exports.updateCategory = updateCategory;
+exports.deleteCategory = deleteCategory;
+exports.getCommonPayees = getCommonPayees;
+exports.getPayees = getPayees;
+exports.createPayee = createPayee;
+exports.updatePayee = updatePayee;
+exports.deletePayee = deletePayee;
+exports.mergePayees = mergePayees;
+exports.getRules = getRules;
+exports.getPayeeRules = getPayeeRules;
+exports.createRule = createRule;
+exports.updateRule = updateRule;
+exports.deleteRule = deleteRule;
+exports.holdBudgetForNextMonth = holdBudgetForNextMonth;
+exports.resetBudgetHold = resetBudgetHold;
 const injected = __importStar(require("./injected"));
 var query_1 = require("./app/query");
 Object.defineProperty(exports, "q", { enumerable: true, get: function () { return query_1.q; } });
@@ -41,23 +86,21 @@ async function runImport(name, func) {
     }
     await send('api/finish-import');
 }
-exports.runImport = runImport;
 async function loadBudget(budgetId) {
     return send('api/load-budget', { id: budgetId });
 }
-exports.loadBudget = loadBudget;
 async function downloadBudget(syncId, { password } = {}) {
     return send('api/download-budget', { syncId, password });
 }
-exports.downloadBudget = downloadBudget;
+async function getBudgets() {
+    return send('api/get-budgets');
+}
 async function sync() {
     return send('api/sync');
 }
-exports.sync = sync;
 async function runBankSync(args) {
     return send('api/bank-sync', args);
 }
-exports.runBankSync = runBankSync;
 async function batchBudgetUpdates(func) {
     await send('api/batch-budget-start');
     try {
@@ -67,27 +110,21 @@ async function batchBudgetUpdates(func) {
         await send('api/batch-budget-end');
     }
 }
-exports.batchBudgetUpdates = batchBudgetUpdates;
 function runQuery(query) {
     return send('api/query', { query: query.serialize() });
 }
-exports.runQuery = runQuery;
 function getBudgetMonths() {
     return send('api/budget-months');
 }
-exports.getBudgetMonths = getBudgetMonths;
 function getBudgetMonth(month) {
     return send('api/budget-month', { month });
 }
-exports.getBudgetMonth = getBudgetMonth;
 function setBudgetAmount(month, categoryId, value) {
     return send('api/budget-set-amount', { month, categoryId, amount: value });
 }
-exports.setBudgetAmount = setBudgetAmount;
 function setBudgetCarryover(month, categoryId, flag) {
     return send('api/budget-set-carryover', { month, categoryId, flag });
 }
-exports.setBudgetCarryover = setBudgetCarryover;
 function addTransactions(accountId, transactions, { learnCategories = false, runTransfers = false } = {}) {
     return send('api/transactions-add', {
         accountId,
@@ -96,35 +133,27 @@ function addTransactions(accountId, transactions, { learnCategories = false, run
         runTransfers,
     });
 }
-exports.addTransactions = addTransactions;
 function importTransactions(accountId, transactions) {
     return send('api/transactions-import', { accountId, transactions });
 }
-exports.importTransactions = importTransactions;
 function getTransactions(accountId, startDate, endDate) {
     return send('api/transactions-get', { accountId, startDate, endDate });
 }
-exports.getTransactions = getTransactions;
 function updateTransaction(id, fields) {
     return send('api/transaction-update', { id, fields });
 }
-exports.updateTransaction = updateTransaction;
 function deleteTransaction(id) {
     return send('api/transaction-delete', { id });
 }
-exports.deleteTransaction = deleteTransaction;
 function getAccounts() {
     return send('api/accounts-get');
 }
-exports.getAccounts = getAccounts;
 function createAccount(account, initialBalance) {
     return send('api/account-create', { account, initialBalance });
 }
-exports.createAccount = createAccount;
 function updateAccount(id, fields) {
     return send('api/account-update', { id, fields });
 }
-exports.updateAccount = updateAccount;
 function closeAccount(id, transferAccountId, transferCategoryId) {
     return send('api/account-close', {
         id,
@@ -132,80 +161,75 @@ function closeAccount(id, transferAccountId, transferCategoryId) {
         transferCategoryId,
     });
 }
-exports.closeAccount = closeAccount;
 function reopenAccount(id) {
     return send('api/account-reopen', { id });
 }
-exports.reopenAccount = reopenAccount;
 function deleteAccount(id) {
     return send('api/account-delete', { id });
 }
-exports.deleteAccount = deleteAccount;
+function getAccountBalance(id, cutoff) {
+    return send('api/account-balance', { id, cutoff });
+}
 function getCategoryGroups() {
     return send('api/category-groups-get');
 }
-exports.getCategoryGroups = getCategoryGroups;
 function createCategoryGroup(group) {
     return send('api/category-group-create', { group });
 }
-exports.createCategoryGroup = createCategoryGroup;
 function updateCategoryGroup(id, fields) {
     return send('api/category-group-update', { id, fields });
 }
-exports.updateCategoryGroup = updateCategoryGroup;
 function deleteCategoryGroup(id, transferCategoryId) {
     return send('api/category-group-delete', { id, transferCategoryId });
 }
-exports.deleteCategoryGroup = deleteCategoryGroup;
 function getCategories() {
     return send('api/categories-get', { grouped: false });
 }
-exports.getCategories = getCategories;
 function createCategory(category) {
     return send('api/category-create', { category });
 }
-exports.createCategory = createCategory;
 function updateCategory(id, fields) {
     return send('api/category-update', { id, fields });
 }
-exports.updateCategory = updateCategory;
 function deleteCategory(id, transferCategoryId) {
     return send('api/category-delete', { id, transferCategoryId });
 }
-exports.deleteCategory = deleteCategory;
+function getCommonPayees() {
+    return send('api/common-payees-get');
+}
 function getPayees() {
     return send('api/payees-get');
 }
-exports.getPayees = getPayees;
 function createPayee(payee) {
     return send('api/payee-create', { payee });
 }
-exports.createPayee = createPayee;
 function updatePayee(id, fields) {
     return send('api/payee-update', { id, fields });
 }
-exports.updatePayee = updatePayee;
 function deletePayee(id) {
     return send('api/payee-delete', { id });
 }
-exports.deletePayee = deletePayee;
+function mergePayees(targetId, mergeIds) {
+    return send('api/payees-merge', { targetId, mergeIds });
+}
 function getRules() {
     return send('api/rules-get');
 }
-exports.getRules = getRules;
 function getPayeeRules(id) {
     return send('api/payee-rules-get', { id });
 }
-exports.getPayeeRules = getPayeeRules;
 function createRule(rule) {
     return send('api/rule-create', { rule });
 }
-exports.createRule = createRule;
 function updateRule(rule) {
     return send('api/rule-update', { rule });
 }
-exports.updateRule = updateRule;
 function deleteRule(id) {
-    return send('api/rule-delete', { id });
+    return send('api/rule-delete', id);
+}
+function holdBudgetForNextMonth(month, amount) {
+    return send('api/budget-hold-for-next-month', { month, amount });
+}
+function resetBudgetHold(month) {
+    return send('api/budget-reset-hold', { month });
 }
-exports.deleteRule = deleteRule;

package/dist/methods.test.js

@@ -61,6 +61,16 @@ describe('API CRUD operations', () => {
         // load test budget
         await api.loadBudget(budgetName);
     });
+    // api: getBudgets
+    test('getBudgets', async () => {
+        const budgets = await api.getBudgets();
+        expect(budgets).toEqual(expect.arrayContaining([
+            expect.objectContaining({
+                id: 'test-budget',
+                name: 'Default Test Db',
+            }),
+        ]));
+    });
     // apis: getCategoryGroups, createCategoryGroup, updateCategoryGroup, deleteCategoryGroup
     test('CategoryGroups: successfully update category groups', async () => {
         const month = '2023-10';
@@ -69,28 +79,22 @@ describe('API CRUD operations', () => {
         const groups = await api.getCategoryGroups();
         expect(groups).toEqual(expect.arrayContaining([
             expect.objectContaining({
-                hidden: 0,
+                hidden: false,
                 id: 'fc3825fd-b982-4b72-b768-5b30844cf832',
-                is_income: 0,
+                is_income: false,
                 name: 'Usual Expenses',
-                sort_order: 16384,
-                tombstone: 0,
             }),
             expect.objectContaining({
-                hidden: 0,
+                hidden: false,
                 id: 'a137772f-cf2f-4089-9432-822d2ddc1466',
-                is_income: 0,
+                is_income: false,
                 name: 'Investments and Savings',
-                sort_order: 32768,
-                tombstone: 0,
             }),
             expect.objectContaining({
-                hidden: 0,
+                hidden: false,
                 id: '2E1F5BDB-209B-43F9-AF2C-3CE28E380C00',
-                is_income: 1,
+                is_income: true,
                 name: 'Income',
-                sort_order: 32768,
-                tombstone: 0,
             }),
         ]));
         // create our test category group
@@ -218,7 +222,7 @@ describe('API CRUD operations', () => {
             }),
         ]));
     });
-    //apis: createAccount, getAccounts, updateAccount, closeAccount, deleteAccount, reopenAccount
+    //apis: createAccount, getAccounts, updateAccount, closeAccount, deleteAccount, reopenAccount, getAccountBalance
     test('Accounts: successfully complete account operators', async () => {
         const accountId1 = await api.createAccount({ name: 'test-account1', offbudget: true }, 1000);
         const accountId2 = await api.createAccount({ name: 'test-account2' }, 0);
@@ -232,6 +236,8 @@ describe('API CRUD operations', () => {
             }),
             expect.objectContaining({ id: accountId2, name: 'test-account2' }),
         ]));
+        expect(await api.getAccountBalance(accountId1)).toEqual(1000);
+        expect(await api.getAccountBalance(accountId2)).toEqual(0);
         await api.updateAccount(accountId1, { offbudget: false });
         await api.closeAccount(accountId1, accountId2, null);
         await api.deleteAccount(accountId2);
@@ -476,9 +482,9 @@ describe('API CRUD operations', () => {
             }),
         ]));
         // delete rules
-        await api.deleteRule(rules[1]);
+        await api.deleteRule(rules[1].id);
         expect(await api.getRules()).toHaveLength(1);
-        await api.deleteRule(rules[0]);
+        await api.deleteRule(rules[0].id);
         expect(await api.getRules()).toHaveLength(0);
     });
     // apis: addTransactions, getTransactions, importTransactions, updateTransaction, deleteTransaction
@@ -493,6 +499,8 @@ describe('API CRUD operations', () => {
             runTransfers: true,
         });
         expect(addResult).toBe('ok');
+        expect(await api.getAccountBalance(accountId)).toEqual(200);
+        expect(await api.getAccountBalance(accountId, new Date(2023, 10, 2))).toEqual(0);
         // confirm added transactions exist
         let transactions = await api.getTransactions(accountId, '2023-11-01', '2023-11-30');
         expect(transactions).toEqual(expect.arrayContaining(newTransaction.map(trans => expect.objectContaining(trans))));

package/dist/migrations/1632571489012_remove_cache.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = runMigration;
 async function runMigration(db) {
     function getValue(node) {
         return node.expr != null ? node.expr : node.cachedValue;
@@ -100,4 +101,3 @@ CREATE TABLE kvcache_key (id INTEGER PRIMARY KEY, key REAL);
     VACUUM;
   `);
 }
-exports.default = runMigration;

package/dist/migrations/1720310586000_link_transfer_schedules.sql

@@ -0,0 +1,19 @@
+BEGIN TRANSACTION;
+
+UPDATE transactions AS t1
+SET schedule = (
+    SELECT t2.schedule FROM transactions AS t2
+    WHERE t2.id = t1.transferred_id
+      AND t2.schedule IS NOT NULL
+    LIMIT 1
+)
+WHERE t1.schedule IS NULL
+AND t1.transferred_id IS NOT NULL
+AND EXISTS (
+  SELECT 1 FROM transactions AS t2
+  WHERE t2.id = t1.transferred_id
+    AND t2.schedule IS NOT NULL
+  LIMIT 1
+);
+
+COMMIT;

package/dist/migrations/1720664867241_add_payee_favorite.sql

@@ -0,0 +1,5 @@
+BEGIN TRANSACTION;
+
+ALTER TABLE payees ADD COLUMN favorite INTEGER DEFAULT 0 DEFAULT FALSE;
+
+COMMIT;

package/dist/migrations/1720665000000_goal_context.sql

@@ -0,0 +1,6 @@
+BEGIN TRANSACTION;
+
+ALTER TABLE zero_budgets ADD COLUMN long_goal INTEGER DEFAULT null;
+ALTER TABLE reflect_budgets ADD COLUMN long_goal INTEGER DEFAULT null;
+
+COMMIT;

package/dist/migrations/1722717601000_reports_move_selected_categories.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = runMigration;
+async function runMigration(db) {
+    const categories = await db.runQuery('SELECT id FROM categories WHERE tombstone = 0', [], true);
+    const customReports = await db.runQuery('SELECT id, selected_categories, conditions FROM custom_reports WHERE tombstone = 0 AND selected_categories IS NOT NULL', [], true);
+    // Move all `selected_categories` to `conditions` if possible.. otherwise skip
+    for (const report of customReports) {
+        const conditions = report.conditions ? JSON.parse(report.conditions) : [];
+        const selectedCategories = report.selected_categories
+            ? JSON.parse(report.selected_categories)
+            : [];
+        const selectedCategoryIds = selectedCategories.map(({ id }) => id);
+        const areAllCategoriesSelected = !categories.find(({ id }) => !selectedCategoryIds.includes(id));
+        // Do nothing if all categories are selected.. we don't need to add a new condition for that
+        if (areAllCategoriesSelected) {
+            continue;
+        }
+        // If `conditions` already has a "category" filter - skip the entry
+        if (conditions.find(({ field }) => field === 'category')) {
+            continue;
+        }
+        // Append a new condition with the selected category IDs
+        await db.runQuery('UPDATE custom_reports SET conditions = ? WHERE id = ?', [
+            JSON.stringify([
+                ...conditions,
+                {
+                    field: 'category',
+                    op: 'oneOf',
+                    value: selectedCategoryIds,
+                    type: 'id',
+                },
+            ]),
+            report.id,
+        ]);
+    }
+    // Remove all the `selectedCategories` values - we don't need them anymore
+    await db.runQuery('UPDATE custom_reports SET selected_categories = NULL WHERE tombstone = 0');
+}

package/dist/migrations/1722804019000_create_dashboard_table.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = runMigration;
+const uuid_1 = require("uuid");
+/* eslint-disable rulesdir/typography */
+async function runMigration(db) {
+    db.transaction(() => {
+        db.execQuery(`
+      CREATE TABLE dashboard
+        (id TEXT PRIMARY KEY,
+         type TEXT,
+         width INTEGER,
+         height INTEGER,
+         x INTEGER,
+         y INTEGER,
+         meta TEXT,
+         tombstone INTEGER DEFAULT 0);
+
+      INSERT INTO dashboard (id, type, width, height, x, y)
+      VALUES
+        ('${(0, uuid_1.v4)()}','net-worth-card', 8, 2, 0, 0),
+        ('${(0, uuid_1.v4)()}', 'cash-flow-card', 4, 2, 8, 0);
+    `);
+        // Add custom reports to the dashboard
+        const reports = db.runQuery('SELECT id FROM custom_reports WHERE tombstone = 0 ORDER BY name COLLATE NOCASE ASC', [], true);
+        reports.forEach((report, id) => {
+            db.runQuery(`INSERT INTO dashboard (id, type, width, height, x, y, meta) VALUES (?, ?, ?, ?, ?, ?, ?)`, [
+                (0, uuid_1.v4)(),
+                'custom-report',
+                4,
+                2,
+                (id * 4) % 12,
+                2 + Math.floor(id / 3) * 2,
+                JSON.stringify({ id: report.id }),
+            ]);
+        });
+    });
+}

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@actual-app/api",
-    "version": "6.8.2",
+    "version": "6.10.0",
     "license": "MIT",
     "description": "An API for Actual",
     "engines": {
@@ -35,6 +35,6 @@
         "@types/uuid": "^9.0.2",
         "jest": "^27.5.1",
         "tsc-alias": "^1.8.8",
-        "typescript": "^5.0.2"
+        "typescript": "^5.5.4"
     }
 }

package/dist/utils.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.integerToAmount = exports.amountToInteger = void 0;
+exports.amountToInteger = amountToInteger;
+exports.integerToAmount = integerToAmount;
 function amountToInteger(n) {
     return Math.round(n * 100);
 }
-exports.amountToInteger = amountToInteger;
 function integerToAmount(n) {
     return parseFloat((n / 100).toFixed(2));
 }
-exports.integerToAmount = integerToAmount;

package/dist/validateNodeVersion.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateNodeVersion = void 0;
+exports.validateNodeVersion = validateNodeVersion;
 const compare_versions_1 = require("compare-versions");
 const packageJson = __importStar(require("./package.json"));
 function validateNodeVersion() {
@@ -35,4 +35,3 @@ function validateNodeVersion() {
         }
     }
 }
-exports.validateNodeVersion = validateNodeVersion;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@actual-app/api",
-  "version": "6.8.2",
+  "version": "6.10.0",
   "license": "MIT",
   "description": "An API for Actual",
   "engines": {
@@ -35,6 +35,6 @@
     "@types/uuid": "^9.0.2",
     "jest": "^27.5.1",
     "tsc-alias": "^1.8.8",
-    "typescript": "^5.0.2"
+    "typescript": "^5.5.4"
   }
 }