@actual-app/api 6.7.1 → 6.8.0

package/dist/methods.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.sync = exports.downloadBudget = exports.loadBudget = exports.runImport = exports.q = void 0;
+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;
 const injected = __importStar(require("./injected"));
 var query_1 = require("./app/query");
 Object.defineProperty(exports, "q", { enumerable: true, get: function () { return query_1.q; } });
@@ -54,6 +54,10 @@ 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 {
@@ -185,3 +189,23 @@ function deletePayee(id) {
     return send('api/payee-delete', { id });
 }
 exports.deletePayee = deletePayee;
+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 });
+}
+exports.deleteRule = deleteRule;

package/dist/methods.test.js

@@ -290,12 +290,203 @@ describe('API CRUD operations', () => {
             }),
         ]));
     });
+    // apis: getRules, getPayeeRules, createRule, updateRule, deleteRule
+    test('Rules: successfully update rules', async () => {
+        await api.createPayee({ name: 'test-payee' });
+        await api.createPayee({ name: 'test-payee2' });
+        // create our test rules
+        const rule = await api.createRule({
+            stage: 'pre',
+            conditionsOp: 'and',
+            conditions: [
+                {
+                    field: 'payee',
+                    op: 'is',
+                    value: 'test-payee',
+                },
+            ],
+            actions: [
+                {
+                    op: 'set',
+                    field: 'category',
+                    value: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+                },
+            ],
+        });
+        const rule2 = await api.createRule({
+            stage: 'pre',
+            conditionsOp: 'and',
+            conditions: [
+                {
+                    field: 'payee',
+                    op: 'is',
+                    value: 'test-payee2',
+                },
+            ],
+            actions: [
+                {
+                    op: 'set',
+                    field: 'category',
+                    value: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+                },
+            ],
+        });
+        // get existing rules
+        const rules = await api.getRules();
+        expect(rules).toEqual(expect.arrayContaining([
+            expect.objectContaining({
+                actions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'category',
+                        op: 'set',
+                        type: 'id',
+                        value: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+                    }),
+                ]),
+                conditions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'payee',
+                        op: 'is',
+                        type: 'id',
+                        value: 'test-payee2',
+                    }),
+                ]),
+                conditionsOp: 'and',
+                id: rule2.id,
+                stage: 'pre',
+            }),
+            expect.objectContaining({
+                actions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'category',
+                        op: 'set',
+                        type: 'id',
+                        value: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+                    }),
+                ]),
+                conditions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'payee',
+                        op: 'is',
+                        type: 'id',
+                        value: 'test-payee',
+                    }),
+                ]),
+                conditionsOp: 'and',
+                id: rule.id,
+                stage: 'pre',
+            }),
+        ]));
+        // get by payee
+        expect(await api.getPayeeRules('test-payee')).toEqual(expect.arrayContaining([
+            expect.objectContaining({
+                actions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'category',
+                        op: 'set',
+                        type: 'id',
+                        value: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+                    }),
+                ]),
+                conditions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'payee',
+                        op: 'is',
+                        type: 'id',
+                        value: 'test-payee',
+                    }),
+                ]),
+                conditionsOp: 'and',
+                id: rule.id,
+                stage: 'pre',
+            }),
+        ]));
+        expect(await api.getPayeeRules('test-payee2')).toEqual(expect.arrayContaining([
+            expect.objectContaining({
+                actions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'category',
+                        op: 'set',
+                        type: 'id',
+                        value: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+                    }),
+                ]),
+                conditions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'payee',
+                        op: 'is',
+                        type: 'id',
+                        value: 'test-payee2',
+                    }),
+                ]),
+                conditionsOp: 'and',
+                id: rule2.id,
+                stage: 'pre',
+            }),
+        ]));
+        // update one rule
+        const updatedRule = {
+            ...rule,
+            stage: 'post',
+            conditionsOp: 'or',
+        };
+        expect(await api.updateRule(updatedRule)).toEqual(updatedRule);
+        expect(await api.getRules()).toEqual(expect.arrayContaining([
+            expect.objectContaining({
+                actions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'category',
+                        op: 'set',
+                        type: 'id',
+                        value: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+                    }),
+                ]),
+                conditions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'payee',
+                        op: 'is',
+                        type: 'id',
+                        value: 'test-payee',
+                    }),
+                ]),
+                conditionsOp: 'or',
+                id: rule.id,
+                stage: 'post',
+            }),
+            expect.objectContaining({
+                actions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'category',
+                        op: 'set',
+                        type: 'id',
+                        value: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+                    }),
+                ]),
+                conditions: expect.arrayContaining([
+                    expect.objectContaining({
+                        field: 'payee',
+                        op: 'is',
+                        type: 'id',
+                        value: 'test-payee2',
+                    }),
+                ]),
+                conditionsOp: 'and',
+                id: rule2.id,
+                stage: 'pre',
+            }),
+        ]));
+        // delete rules
+        await api.deleteRule(rules[1]);
+        expect(await api.getRules()).toHaveLength(1);
+        await api.deleteRule(rules[0]);
+        expect(await api.getRules()).toHaveLength(0);
+    });
     // apis: addTransactions, getTransactions, importTransactions, updateTransaction, deleteTransaction
     test('Transactions: successfully update transactions', async () => {
         const accountId = await api.createAccount({ name: 'test-account' }, 0);
         let newTransaction = [
-            { date: '2023-11-03', imported_id: '11', amount: 100 },
-            { date: '2023-11-03', imported_id: '11', amount: 100 },
+            { date: '2023-11-03', imported_id: '11', amount: 100, notes: 'notes' },
+            { date: '2023-11-03', imported_id: '12', amount: 100, notes: '' },
         ];
         const addResult = await api.addTransactions(accountId, newTransaction, {
             learnCategories: true,
@@ -307,8 +498,9 @@ describe('API CRUD operations', () => {
         expect(transactions).toEqual(expect.arrayContaining(newTransaction.map(trans => expect.objectContaining(trans))));
         expect(transactions).toHaveLength(2);
         newTransaction = [
-            { date: '2023-12-03', imported_id: '11', amount: 100 },
-            { date: '2023-12-03', imported_id: '22', amount: 200 },
+            { date: '2023-12-03', imported_id: '11', amount: 100, notes: 'notes' },
+            { date: '2023-12-03', imported_id: '12', amount: 100, notes: 'notes' },
+            { date: '2023-12-03', imported_id: '22', amount: 200, notes: '' },
         ];
         const reconciled = await api.importTransactions(accountId, newTransaction);
         // Expect it to reconcile and to have updated one of the previous transactions
@@ -316,7 +508,15 @@ describe('API CRUD operations', () => {
         expect(reconciled.updated).toHaveLength(1);
         // confirm imported transactions exist
         transactions = await api.getTransactions(accountId, '2023-12-01', '2023-12-31');
-        expect(transactions).toEqual(expect.arrayContaining(newTransaction.map(trans => expect.objectContaining(trans))));
+        expect(transactions).toEqual(expect.arrayContaining([
+            expect.objectContaining({ imported_id: '22', amount: 200 }),
+        ]));
+        expect(transactions).toHaveLength(1);
+        // confirm imported transactions update perfomed
+        transactions = await api.getTransactions(accountId, '2023-11-01', '2023-11-30');
+        expect(transactions).toEqual(expect.arrayContaining([
+            expect.objectContaining({ notes: 'notes', amount: 100 }),
+        ]));
         expect(transactions).toHaveLength(2);
         const idToUpdate = reconciled.added[0];
         const idToDelete = reconciled.updated[0];

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@actual-app/api",
-    "version": "6.7.1",
+    "version": "6.8.0",
     "license": "MIT",
     "description": "An API for Actual",
     "engines": {
@@ -9,7 +9,8 @@
     "main": "dist/index.js",
     "types": "@types/index.d.ts",
     "files": [
-        "dist"
+        "dist",
+        "@types"
     ],
     "scripts": {
         "build:app": "yarn workspace loot-core build:api",
@@ -21,14 +22,15 @@
         "clean": "rm -rf dist @types"
     },
     "dependencies": {
-        "better-sqlite3": "^9.3.0",
+        "@actual-app/crdt": "workspace:^",
+        "better-sqlite3": "^9.6.0",
         "compare-versions": "^6.1.0",
         "node-fetch": "^3.3.2",
         "uuid": "^9.0.1"
     },
     "devDependencies": {
-        "@swc/core": "^1.3.105",
-        "@swc/jest": "^0.2.31",
+        "@swc/core": "^1.5.3",
+        "@swc/jest": "^0.2.36",
         "@types/jest": "^27.5.2",
         "@types/uuid": "^9.0.2",
         "jest": "^27.5.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@actual-app/api",
-  "version": "6.7.1",
+  "version": "6.8.0",
   "license": "MIT",
   "description": "An API for Actual",
   "engines": {
@@ -9,7 +9,8 @@
   "main": "dist/index.js",
   "types": "@types/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "@types"
   ],
   "scripts": {
     "build:app": "yarn workspace loot-core build:api",
@@ -21,14 +22,15 @@
     "clean": "rm -rf dist @types"
   },
   "dependencies": {
-    "better-sqlite3": "^9.3.0",
+    "@actual-app/crdt": "workspace:^",
+    "better-sqlite3": "^9.6.0",
     "compare-versions": "^6.1.0",
     "node-fetch": "^3.3.2",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@swc/core": "^1.3.105",
-    "@swc/jest": "^0.2.31",
+    "@swc/core": "^1.5.3",
+    "@swc/jest": "^0.2.36",
     "@types/jest": "^27.5.2",
     "@types/uuid": "^9.0.2",
     "jest": "^27.5.1",