🔖 (24.7.0) custom reports, splits in rules, tags and more (#2955)

This reverts commit 247e3e8d93.

.eslintrc.js

@@ -146,10 +146,9 @@ module.exports = {
           'Using default React import is discouraged, please use named exports directly instead.',
       },
       {
-        // forbid <a> in favor of <LinkButton> or <ExternalLink>
+        // forbid <a> in favor of <Link>
         selector: 'JSXOpeningElement[name.name="a"]',
-        message:
-          'Using <a> is discouraged, please use <LinkButton> or <ExternalLink> instead.',
+        message: 'Using <a> is discouraged, please use <Link> instead.',
       },
     ],
     'no-restricted-imports': [
@@ -282,12 +281,11 @@ module.exports = {
         './packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx',
         './packages/desktop-client/src/components/budget/index.tsx',
         './packages/desktop-client/src/components/budget/MobileBudget.tsx',
-        './packages/desktop-client/src/components/budget/rollover/HoldTooltip.tsx',
-        './packages/desktop-client/src/components/budget/rollover/TransferTooltip.tsx',
+        './packages/desktop-client/src/components/budget/rollover/HoldMenu.tsx',
+        './packages/desktop-client/src/components/budget/rollover/TransferMenu.tsx',
         './packages/desktop-client/src/components/common/Menu.tsx',
         './packages/desktop-client/src/components/FinancesApp.tsx',
         './packages/desktop-client/src/components/GlobalKeys.ts',
-        './packages/desktop-client/src/components/KeyHandlers.tsx',
         './packages/desktop-client/src/components/LoggedInUser.tsx',
         './packages/desktop-client/src/components/manager/ManagementApp.jsx',
         './packages/desktop-client/src/components/manager/subscribe/common.tsx',

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -8,6 +8,13 @@ body:
     attributes:
       value: |
         Thanks for taking the time to fill out this bug report! Please ensure you provide as much information as possible to better assist in confirming and identifying a fix for the bug.
+  - type: markdown
+    id: intro-md
+    attributes:
+      value: |
+        **IMPORTANT:** we use Github Issues only for BUG REPORTS and FEATURE REQUESTS. If you are looking for help/support - please reach out to the [community on Discord](https://discord.gg/pRYNYr4W5A). All non-bug and non-feature-request issues will be closed.
+
+        **Bank-sync problems (SimpleFin / GoCardless)?** Reach out via the [community Discord](https://discord.gg/pRYNYr4W5A) first and open an issue only if the community deems the issue to be a legitimate bug in Actual.
   - type: checkboxes
     id: existing-issue
     attributes:
@@ -16,20 +23,10 @@ body:
       options:
         - label: 'I have searched and found no existing issue'
           required: true
+        - label: 'I will be providing steps how to reproduce the bug (in most cases this will also mean uploading a demo budget file)'
+          required: true
     validations:
       required: true
-  - type: checkboxes
-    id: bank-sync-issue
-    attributes:
-      label: 'Is this related to GoCardless, Simplefin or another bank-sync provider?'
-      description: 'Most issues with bank-sync providers are due to a lack of a custom bank-mapper (i.e. payee or other fields not coming through). In such cases you can create a custom bank mapper in [actual-server](https://github.com/actualbudget/actual-server/blob/master/src/app-gocardless/README.md) repository. Other likely issue is misconfigured server - in which case please reach out via the [community Discord](https://discord.gg/pRYNYr4W5A) to get support.'
-      options:
-        - label: 'I have checked my server logs and could not see any errors there'
-        - label: 'I will be attaching my server logs to this issue'
-        - label: 'I will be attaching my client-side (browser) logs to this issue'
-        - label: 'I understand that this issue will be automatically closed if insufficient information is provided'
-    validations:
-      required: false
   - type: textarea
     id: what-happened
     attributes:
@@ -39,13 +36,6 @@ body:
       value: 'A bug happened!'
     validations:
       required: true
-  - type: textarea
-    id: errors-received
-    attributes:
-      label: 'What error did you receive?'
-      description: 'If you received an error or a message on the screen, please provide that here.'
-    validations:
-      required: false
   - type: markdown
     id: env-info
     attributes:
@@ -59,6 +49,7 @@ body:
         - Locally via Yarn
         - Docker
         - Fly.io
+        - Pikapods
         - NAS
         - Desktop App (Electron)
         - Other

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,8 @@
 blank_issues_enabled: false
 contact_links:
+  - name: Bank-sync issues
+    url: https://discord.gg/pRYNYr4W5A
+    about: Is bank-sync not working? Returning too much or too few information? Reach out to the community on Discord.
   - name: Support
     url: https://discord.gg/pRYNYr4W5A
-    about: Need help with something? Perhaps having issues setting up bank-sync with GoCardless or SimpleFin? Reach out to the community on Discord.
+    about: Need help with something? Having troubles setting up? Or perhaps issues using the API? Reach out to the community on Discord.

.github/workflows/electron-master.yml

@@ -1,4 +1,4 @@
-name: Electron
+name: Electron Master
 
 defaults:
   run:
@@ -9,8 +9,8 @@ env:
 
 on:
   push:
-    branches:
-      - master
+    tags:
+      - v**
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -18,6 +18,9 @@ concurrency:
 
 jobs:
   build:
+    # this is so the assets can be added to the release
+    permissions:
+      contents: write
     strategy:
       matrix:
         os:
@@ -30,14 +33,26 @@ jobs:
       - if: ${{ startsWith(matrix.os, 'windows') }}
         run: pip.exe install setuptools
       - if: ${{ ! startsWith(matrix.os, 'windows') }}
-        run: python3 -m pip install setuptools
+        run: |
+          mkdir .venv
+          python3 -m venv .venv
+          source .venv/bin/activate
+          python3 -m pip install setuptools
+      - if: ${{ startsWith(matrix.os, 'ubuntu') }}
+        run: |
+          sudo apt-get install flatpak -y
+          sudo apt-get install flatpak-builder -y
+          sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
+          sudo flatpak install org.freedesktop.Sdk/x86_64/23.08 -y
+          sudo flatpak install org.freedesktop.Platform/x86_64/23.08 -y
+          sudo flatpak install org.electronjs.Electron2.BaseApp/x86_64/23.08 -y
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Build Electron
         run: ./bin/package-electron
         env:
-          CSC_KEY_PASSWORD: ${{ secrets.CSC_KEY_PASSWORD }}
-          CSC_LINK: ${{ secrets.CSC_LINK }}
+          # CSC_KEY_PASSWORD: ${{ secrets.CSC_KEY_PASSWORD }}
+          # CSC_LINK: ${{ secrets.CSC_LINK }}
           APPLE_ID: ${{ secrets.APPLE_ID }}
           APPLE_APP_SPECIFIC_PASSWORD: ${{ secrets.APPLE_APP_SPECIFIC_PASSWORD }}
       - name: Upload Build
@@ -48,3 +63,12 @@ jobs:
             packages/desktop-electron/dist/*.dmg
             packages/desktop-electron/dist/*.exe
             packages/desktop-electron/dist/*.AppImage
+            packages/desktop-electron/dist/*.flatpak
+      - name: Add to Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            packages/desktop-electron/dist/*.dmg
+            packages/desktop-electron/dist/*.exe
+            packages/desktop-electron/dist/*.AppImage
+            packages/desktop-electron/dist/*.flatpak

.github/workflows/electron-pr.yml

@@ -28,7 +28,19 @@ jobs:
       - if: ${{ startsWith(matrix.os, 'windows') }}
         run: pip.exe install setuptools
       - if: ${{ ! startsWith(matrix.os, 'windows') }}
-        run: python3 -m pip install setuptools
+        run: |
+          mkdir .venv
+          python3 -m venv .venv
+          source .venv/bin/activate
+          python3 -m pip install setuptools
+      - if: ${{ startsWith(matrix.os, 'ubuntu') }}
+        run: |
+          sudo apt-get install flatpak -y
+          sudo apt-get install flatpak-builder -y
+          sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
+          sudo flatpak install org.freedesktop.Sdk/x86_64/23.08 -y
+          sudo flatpak install org.freedesktop.Platform/x86_64/23.08 -y
+          sudo flatpak install org.electronjs.Electron2.BaseApp/x86_64/23.08 -y
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Build Electron
@@ -41,3 +53,4 @@ jobs:
             packages/desktop-electron/dist/*.dmg
             packages/desktop-electron/dist/*.exe
             packages/desktop-electron/dist/*.AppImage
+            packages/desktop-electron/dist/*.flatpak

.github/workflows/netlify-release.yml

@@ -0,0 +1,43 @@
+name: Deploy Netlify Release
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  CI: true
+
+on:
+  push:
+    tags:
+      - v**
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Repository Checkout
+        uses: actions/checkout@v4
+    
+      - name: Set up environment
+        uses: ./.github/actions/setup
+    
+      - name: Install Netlify
+        run: npm install netlify-cli@17.10.1 -g
+    
+      - name: Build Actual
+        run: ./bin/package-browser
+
+      - name: Deploy to Netlify
+        id: netlify_deploy
+        run: |
+          netlify deploy \
+            --dir packages/desktop-client/build \
+            --site ${{ secrets.NETLIFY_SITE_ID }} \
+            --auth ${{ secrets.NETLIFY_API_TOKEN }} \
+            --filter @actual-app/web \
+            --prod

.github/workflows/trafico.yml

@@ -0,0 +1,39 @@
+##########################################################################################
+# WARNING! This workflow uses the 'pull_request_target' event. That mans that it will    #
+# always run in the context of the main actualbudget/actual repo, even if the PR is from #
+# a fork. This is necessary to get access to a GitHub token that can modify the PR.      #
+# Be VERY CAREFUL about adding things to this workflow, since forks can inject           #
+# arbitrary code into their branch, and can pollute the artifacts we download. Arbitrary #
+# code execution in this workflow could lead to a compromise of the main repo.           #
+##########################################################################################
+# See: https://securitylab.github.com/research/github-actions-preventing-pwn-requests    #
+##########################################################################################
+
+name: Trafico Reviews
+
+on:
+  pull_request_target:
+    types:
+     - opened
+     - closed
+     - reopened
+     - synchronize
+     - edited
+     - review_requested
+     - review_request_removed
+  pull_request_review:
+    types: [submitted, edited, dismissed]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  manage-review:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: actualbudget/trafico@main
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/wip.yml

@@ -0,0 +1,27 @@
+name: Add WIP
+
+on:
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  add_wip_prefix:
+    if: |
+      join(github.event.pull_request.requested_reviewers) == ''
+        && !contains(github.event.pull_request.title, 'WIP')
+        && !contains(github.event.pull_request.labels.*.name, 'WIP')
+        && github.event.pull_request.draft != true
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Add WIP
+      env:
+          TITLE: ${{ github.event.pull_request.title }}
+      shell: bash
+      run: |
+        echo ${{ secrets.GITHUB_TOKEN }} | gh auth login --with-token
+        gh pr edit ${{ github.event.pull_request.number }} -t "[WIP] ${TITLE}"

.gitignore

@@ -1,6 +1,22 @@
+# Sample Data
 /data/*
 !data/.gitkeep
 /data2
+Actual-*
+**/xcuserdata/*
+export-2020-01-10.csv
+
+# Secrets
+.secret-tokens
+
+# MacOS
+.DS_Store
+
+# Logs
+**/*.log
+
+# JavaScript
+node_modules
 packages/api/dist
 packages/api/@types
 packages/crdt/dist
@@ -8,22 +24,10 @@ packages/desktop-electron/client-build
 packages/desktop-electron/.electron-symbols
 packages/desktop-electron/dist
 packages/desktop-electron/loot-core
-node_modules
-.DS_Store
-lerna-debug.log
-Actual-*
-.#*
-**/xcuserdata/*
-.secret-tokens
 bundle.desktop.js
 bundle.desktop.js.map
 bundle.mobile.js
 bundle.mobile.js.map
-export-2020-01-10.csv
-.idea
-.vscode
-
-**/*.log
 
 # Yarn
 .pnp.*
@@ -36,3 +40,12 @@ export-2020-01-10.csv
 
 # VSCode
 .vscode
+
+# IntelliJ IDEA
+.idea
+
+# Misc
+.#*
+
+# Local Netlify folder
+.netlify

bin/package-electron

@@ -38,7 +38,7 @@ yarn rebuild-electron
 
 yarn workspace loot-core build:node
 
-yarn workspace @actual-app/web build
+yarn workspace @actual-app/web build --mode=desktop
 
 yarn workspace desktop-electron update-client
 

bin/run-vrt

@@ -0,0 +1,32 @@
+#!/bin/sh
+
+# See here for more information: https://github.com/actualbudget/actual/tree/master/packages/desktop-client#visual-regression
+
+if [ ! -d "node_modules" ] || [ "$(ls -A node_modules)" = "" ]; then
+    yarn
+fi
+
+E2E_START_URL="${E2E_START_URL:-https://localhost:3001}"
+VRT_ARGS=""
+
+# Loop through all arguments
+while [ $# -gt 0 ]; do
+    key="$1"
+    case $key in
+        --e2e-start-url)
+            E2E_START_URL="$2"
+            shift
+            ;;
+        *)
+            VRT_ARGS="$VRT_ARGS $1"
+            ;;
+    esac
+    shift
+done
+
+echo "Running VRT tests with the following parameters:"
+echo "E2E_START_URL: $E2E_START_URL"
+echo "VRT_ARGS: $VRT_ARGS"
+
+docker run --rm --network host -v "$(pwd)":/work/ -w /work/ -it mcr.microsoft.com/playwright:v1.41.1-jammy /bin/bash \
+  -c "E2E_START_URL=$E2E_START_URL yarn vrt $VRT_ARGS"

package.json

@@ -34,6 +34,7 @@
     "test:debug": "yarn workspaces foreach --all --verbose run test",
     "e2e": "yarn workspaces foreach --all --parallel --verbose run e2e",
     "vrt": "yarn workspaces foreach --all --parallel --verbose run vrt",
+    "vrt:docker": "./bin/run-vrt",
     "rebuild-electron": "./node_modules/.bin/electron-rebuild -f -m ./packages/loot-core",
     "rebuild-node": "yarn workspace loot-core rebuild",
     "lint": "eslint . --max-warnings 0 --ext .js,.jsx,.ts,.tsx",

packages/api/methods.test.ts

@@ -58,11 +58,42 @@ describe('API CRUD operations', () => {
     await api.loadBudget(budgetName);
   });
 
-  // apis: createCategoryGroup, updateCategoryGroup, deleteCategoryGroup
+  // apis: getCategoryGroups, createCategoryGroup, updateCategoryGroup, deleteCategoryGroup
   test('CategoryGroups: successfully update category groups', async () => {
     const month = '2023-10';
     global.currentMonth = month;
 
+    // get existing category groups
+    const groups = await api.getCategoryGroups();
+    expect(groups).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          hidden: 0,
+          id: 'fc3825fd-b982-4b72-b768-5b30844cf832',
+          is_income: 0,
+          name: 'Usual Expenses',
+          sort_order: 16384,
+          tombstone: 0,
+        }),
+        expect.objectContaining({
+          hidden: 0,
+          id: 'a137772f-cf2f-4089-9432-822d2ddc1466',
+          is_income: 0,
+          name: 'Investments and Savings',
+          sort_order: 32768,
+          tombstone: 0,
+        }),
+        expect.objectContaining({
+          hidden: 0,
+          id: '2E1F5BDB-209B-43F9-AF2C-3CE28E380C00',
+          is_income: 1,
+          name: 'Income',
+          sort_order: 32768,
+          tombstone: 0,
+        }),
+      ]),
+    );
+
     // create our test category group
     const mainGroupId = await api.createCategoryGroup({
       name: 'test-group',
@@ -315,13 +346,221 @@ 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, {
@@ -344,8 +583,9 @@ describe('API CRUD operations', () => {
     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);
@@ -361,9 +601,22 @@ describe('API CRUD operations', () => {
       '2023-12-31',
     );
     expect(transactions).toEqual(
-      expect.arrayContaining(
-        newTransaction.map(trans => expect.objectContaining(trans)),
-      ),
+      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);
 

packages/api/methods.ts

@@ -35,6 +35,10 @@ export async function sync() {
   return send('api/sync');
 }
 
+export async function runBankSync(args?: { accountId: string }) {
+  return send('api/bank-sync', args);
+}
+
 export async function batchBudgetUpdates(func) {
   await send('api/batch-budget-start');
   try {
@@ -121,6 +125,10 @@ export function deleteAccount(id) {
   return send('api/account-delete', { id });
 }
 
+export function getCategoryGroups() {
+  return send('api/category-groups-get');
+}
+
 export function createCategoryGroup(group) {
   return send('api/category-group-create', { group });
 }
@@ -164,3 +172,23 @@ export function updatePayee(id, fields) {
 export function deletePayee(id) {
   return send('api/payee-delete', { id });
 }
+
+export function getRules() {
+  return send('api/rules-get');
+}
+
+export function getPayeeRules(id) {
+  return send('api/payee-rules-get', { id });
+}
+
+export function createRule(rule) {
+  return send('api/rule-create', { rule });
+}
+
+export function updateRule(rule) {
+  return send('api/rule-update', { rule });
+}
+
+export function deleteRule(id) {
+  return send('api/rule-delete', { id });
+}

packages/api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@actual-app/api",
-  "version": "6.6.0",
+  "version": "6.8.2",
   "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",

packages/api/tsconfig.dist.json

@@ -10,6 +10,7 @@
     "outDir": "dist",
     "declarationDir": "@types",
     "paths": {
+      "loot-core/src/*": ["./loot-core/*"],
       "loot-core/*": ["./@types/loot-core/*"],
     }
   },

packages/crdt/package.json

@@ -20,8 +20,8 @@
     "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",

packages/desktop-client/README.md

@@ -45,7 +45,22 @@ HTTPS=true docker compose up --build
 
 Note the network IP address and port the dev instance is listening on.
 
-Next, navigate to the root of your project folder, run the standartised docker container, and launch the visual regression tests from within it.
+Next, navigate to the root of your project folder, run the standardized docker container, and launch the visual regression tests from within it.
+
+Run via yarn:
+
+```sh
+# By default, this connects to https://localhost:3001
+yarn vrt:docker
+
+    # To use a different ip and port:
+    yarn vrt:docker --e2e-start-url https://ip:port
+
+    # To update snapshots, use the following command:
+    yarn vrt:docker --e2e-start-url https://ip:port --update-snapshots
+```
+
+Run manually:
 
 ```sh
 # Run docker container
@@ -54,7 +69,8 @@ docker run --rm --network host -v $(pwd):/work/ -w /work/ -it mcr.microsoft.com/
     # If you receive an error such as "docker: invalid reference format", please instead use the following command:
     docker run --rm --network host -v ${pwd}:/work/ -w /work/ -it mcr.microsoft.com/playwright:v1.41.1-jammy /bin/bash
 
-# Run the VRT tests: important - they MUST be ran against a HTTPS server.  Use the ip and port noted earlier
+# Once inside the docker container, run the VRT tests: important - they MUST be ran against a HTTPS server.
+# Use the ip and port noted earlier
 E2E_START_URL=https://ip:port yarn vrt
 
     # To update snapshots, use the following command:
@@ -65,6 +81,15 @@ E2E_START_URL=https://ip:port yarn vrt
 
 You can also run the tests against a remote server by passing the URL:
 
+Run in standardized docker container:
+```sh
+E2E_START_URL=https://my-remote-server.com yarn vrt:docker
+
+    # Or pass in server URL as argument
+    yarn vrt:docker --e2e-start-url https://my-remote-server.com
+```
+
+Run locally:
 ```sh
 E2E_START_URL=https://my-remote-server.com yarn vrt
 ```

packages/desktop-client/e2e/accounts.test.js

@@ -7,6 +7,7 @@ test.describe('Accounts', () => {
   let page;
   let navigation;
   let configurationPage;
+  let accountPage;
 
   test.beforeAll(async ({ browser }) => {
     page = await browser.newPage();
@@ -22,7 +23,7 @@ test.describe('Accounts', () => {
   });
 
   test('creates a new account and views the initial balance transaction', async () => {
-    const accountPage = await navigation.createAccount({
+    accountPage = await navigation.createAccount({
       name: 'New Account',
       offBudget: false,
       balance: 100,
@@ -38,7 +39,7 @@ test.describe('Accounts', () => {
   });
 
   test('closes an account', async () => {
-    const accountPage = await navigation.goToAccountPage('Roth IRA');
+    accountPage = await navigation.goToAccountPage('Roth IRA');
 
     await expect(accountPage.accountName).toHaveText('Roth IRA');
 
@@ -50,4 +51,52 @@ test.describe('Accounts', () => {
     await expect(accountPage.accountName).toHaveText('Closed: Roth IRA');
     await expect(page).toMatchThemeScreenshots();
   });
+
+  test.describe('Budgeted Accounts', () => {
+    // Reset filters
+    test.afterEach(async () => {
+      await accountPage.removeFilter(0);
+    });
+
+    test('creates a transfer from two existing transactions', async () => {
+      accountPage = await navigation.goToAccountPage('For budget');
+      await expect(accountPage.accountName).toHaveText('Budgeted Accounts');
+
+      await accountPage.filterByNote('Test Acc Transfer');
+
+      await accountPage.createSingleTransaction({
+        account: 'Ally Savings',
+        payee: '',
+        notes: 'Test Acc Transfer',
+        category: 'Food',
+        debit: '34.56',
+      });
+
+      await accountPage.createSingleTransaction({
+        account: 'HSBC',
+        payee: '',
+        notes: 'Test Acc Transfer',
+        category: 'Food',
+        credit: '34.56',
+      });
+
+      await page.waitForTimeout(100); // Give time for the previous transaction to be rendered
+
+      await accountPage.selectNthTransaction(0);
+      await accountPage.selectNthTransaction(1);
+      await accountPage.clickSelectAction('Make transfer');
+
+      let transaction = accountPage.getNthTransaction(0);
+      await expect(transaction.payee).toHaveText('Ally Savings');
+      await expect(transaction.category).toHaveText('Transfer');
+      await expect(transaction.credit).toHaveText('34.56');
+      await expect(transaction.account).toHaveText('HSBC');
+
+      transaction = accountPage.getNthTransaction(1);
+      await expect(transaction.payee).toHaveText('HSBC');
+      await expect(transaction.category).toHaveText('Transfer');
+      await expect(transaction.debit).toHaveText('34.56');
+      await expect(transaction.account).toHaveText('Ally Savings');
+    });
+  });
 });

packages/desktop-client/e2e/budget.test.js

@@ -59,12 +59,9 @@ test.describe('Budget', () => {
   });
 
   test('clicking on spent amounts opens a transaction page', async () => {
-    const categoryName = await budgetPage.getCategoryNameForRow(1);
     const accountPage = await budgetPage.clickOnSpentAmountForRow(1);
     expect(page.url()).toContain('/accounts');
-    expect(await accountPage.accountName.textContent()).toMatch(
-      new RegExp(String.raw`${categoryName} \(\w+ \d+\)`),
-    );
+    expect(await accountPage.accountName.textContent()).toMatch('All Accounts');
     await page.getByRole('button', { name: 'Back' }).click();
   });
 });

packages/desktop-client/e2e/data/ynab5-demo-budget.json

@@ -102,10 +102,22 @@
         "name": "Store",
         "transfer_account_id": null,
         "deleted": false
+      },
+      {
+        "id": "620e85b1-2ae7-45b1-bb3e-b875ea5c553a",
+        "name": "Work",
+        "transfer_account_id": null,
+        "deleted": false
       }
     ],
     "payee_locations": [],
     "category_groups": [
+      {
+        "id": "a5c355c2-3b77-4a7f-b8b3-c832b10cfec8",
+        "name": "Income",
+        "hidden": false,
+        "deleted": false
+      },
       {
         "id": "d5c355c2-3b77-4a7f-b8b3-c832b10cfec9",
         "name": "Internal Master Category",
@@ -611,6 +623,30 @@
         "goal_overall_funded": null,
         "goal_overall_left": null,
         "deleted": false
+      },
+      {
+        "id": "1429f287-50aa-49d8-a89c-752cbd167d6c",
+        "category_group_id": "a5c355c2-3b77-4a7f-b8b3-c832b10cfec8",
+        "name": "Income",
+        "hidden": false,
+        "original_category_group_id": null,
+        "note": null,
+        "budgeted": 0,
+        "activity": 0,
+        "balance": 0,
+        "goal_type": "NEED",
+        "goal_day": null,
+        "goal_cadence": 1,
+        "goal_cadence_frequency": 1,
+        "goal_creation_month": null,
+        "goal_target": 0,
+        "goal_target_month": null,
+        "goal_percentage_complete": null,
+        "goal_months_to_budget": null,
+        "goal_under_funded": null,
+        "goal_overall_funded": null,
+        "goal_overall_left": null,
+        "deleted": false
       }
     ],
     "months": [
@@ -1597,7 +1633,7 @@
         "date": "2023-08-04",
         "amount": 0,
         "memo": "getting paid",
-        "cleared": "cleared",
+        "cleared": "reconciled",
         "approved": true,
         "flag_color": null,
         "account_id": "bc1d862f-bab0-41c3-bd1e-6cee8c688e32",
@@ -1657,7 +1693,7 @@
         "date": "2023-08-04",
         "amount": 1000000,
         "memo": "",
-        "cleared": "cleared",
+        "cleared": "reconciled",
         "approved": true,
         "flag_color": null,
         "account_id": "bc1d862f-bab0-41c3-bd1e-6cee8c688e32",
@@ -1704,8 +1740,28 @@
         "payee_id": "",
         "category_id": null,
         "transfer_account_id": "bc1d862f-bab0-41c3-bd1e-6cee8c688e32",
-        "transfer_transaction_id": "213526fc-ba49-4790-8a96-cc2a50182728",
-        "matched_transaction_id": "",
+        "transfer_transaction_id": null,
+        "matched_transaction_id": null,
+        "import_id": null,
+        "import_payee_name": null,
+        "import_payee_name_original": null,
+        "debt_transaction_type": null,
+        "deleted": false
+      },
+      {
+        "id": "9a22f287-f1e0-4667-9fc0-91e4a4262193",
+        "date": "2024-02-02",
+        "amount": 2000000,
+        "memo": "Paycheck",
+        "cleared": "cleared",
+        "approved": true,
+        "flag_color": null,
+        "account_id": "bc1d862f-bab0-41c3-bd1e-6cee8c688e32",
+        "payee_id": "620e85b1-2ae7-45b1-bb3e-b875ea5c553a",
+        "category_id": "1429f287-50aa-49d8-a89c-752cbd167d6c",
+        "transfer_account_id": null,
+        "transfer_transaction_id": null,
+        "matched_transaction_id": null,
         "import_id": null,
         "import_payee_name": null,
         "import_payee_name_original": null,
@@ -1729,7 +1785,7 @@
         "transaction_id": "213526fc-ba49-4790-8a96-cc2a50182728",
         "amount": -50000,
         "memo": "split part b",
-        "payee_id": "2a20470a-634f-4efa-a7f6-f1c0b0bdda41",
+        "payee_id": "8d3017e0-2aa6-4fe2-b011-c53c9f147eb6",
         "category_id": null,
         "transfer_account_id": "125f339b-2a63-481e-84c0-f04d898905d2",
         "deleted": false

packages/desktop-client/e2e/mobile.test.js

@@ -42,6 +42,9 @@ test.describe('Mobile', () => {
       'Mortgage',
       'Water',
       'Power',
+      'Starting Balances',
+      'Misc',
+      'Income',
     ]);
     await expect(page).toMatchThemeScreenshots();
   });

packages/desktop-client/e2e/onboarding.test.js

@@ -59,7 +59,7 @@ test.describe('Onboarding', () => {
     await expect(budgetPage.budgetTable).toBeVisible({ timeout: 30000 });
 
     const accountPage = await navigation.goToAccountPage('Checking');
-    await expect(accountPage.accountBalance).toHaveText('600.00');
+    await expect(accountPage.accountBalance).toHaveText('2,600.00');
 
     await navigation.goToAccountPage('Saving');
     await expect(accountPage.accountBalance).toHaveText('250.00');

packages/desktop-client/e2e/page-models/account-page.js

@@ -25,6 +25,9 @@ export class AccountPage {
 
     this.filterButton = this.page.getByRole('button', { name: 'Filter' });
     this.filterSelectTooltip = this.page.getByTestId('filters-select-tooltip');
+
+    this.selectButton = this.page.getByTestId('transactions-select-button');
+    this.selectTooltip = this.page.getByTestId('transactions-select-tooltip');
   }
 
   /**
@@ -68,14 +71,21 @@ export class AccountPage {
     await this.cancelTransactionButton.click();
   }
 
+  async selectNthTransaction(index) {
+    const row = this.transactionTableRow.nth(index);
+    await row.getByTestId('select').click();
+  }
+
   /**
    * Retrieve the data for the nth-transaction.
    * 0-based index
    */
   getNthTransaction(index) {
     const row = this.transactionTableRow.nth(index);
+    const account = row.getByTestId('account');
 
     return {
+      ...(account ? { account } : {}),
       payee: row.getByTestId('payee'),
       notes: row.getByTestId('notes'),
       category: row.getByTestId('category'),
@@ -84,6 +94,11 @@ export class AccountPage {
     };
   }
 
+  async clickSelectAction(action) {
+    await this.selectButton.click();
+    await this.selectTooltip.getByRole('button', { name: action }).click();
+  }
+
   /**
    * Open the modal for closing the account.
    */
@@ -106,6 +121,15 @@ export class AccountPage {
     return new FilterTooltip(this.page.getByTestId('filters-menu-tooltip'));
   }
 
+  /**
+   * Filter to a specific note
+   */
+  async filterByNote(note) {
+    const filterTooltip = await this.filterBy('Note');
+    await this.page.keyboard.type(note);
+    await filterTooltip.applyButton.click();
+  }
+
   /**
    * Remove the nth filter
    */
@@ -117,6 +141,24 @@ export class AccountPage {
   }
 
   async _fillTransactionFields(transactionRow, transaction) {
+    if (transaction.debit) {
+      await transactionRow.getByTestId('debit').click();
+      await this.page.keyboard.type(transaction.debit);
+      await this.page.keyboard.press('Tab');
+    }
+
+    if (transaction.credit) {
+      await transactionRow.getByTestId('credit').click();
+      await this.page.keyboard.type(transaction.credit);
+      await this.page.keyboard.press('Tab');
+    }
+
+    if (transaction.account) {
+      await transactionRow.getByTestId('account').click();
+      await this.page.keyboard.type(transaction.account);
+      await this.page.keyboard.press('Tab');
+    }
+
     if (transaction.payee) {
       await transactionRow.getByTestId('payee').click();
       await this.page.keyboard.type(transaction.payee);
@@ -139,18 +181,6 @@ export class AccountPage {
         await this.page.keyboard.press('Tab');
       }
     }
-
-    if (transaction.debit) {
-      await transactionRow.getByTestId('debit').click();
-      await this.page.keyboard.type(transaction.debit);
-      await this.page.keyboard.press('Tab');
-    }
-
-    if (transaction.credit) {
-      await transactionRow.getByTestId('credit').click();
-      await this.page.keyboard.type(transaction.credit);
-      await this.page.keyboard.press('Tab');
-    }
   }
 }
 

packages/desktop-client/e2e/page-models/mobile-account-page.js

@@ -5,7 +5,7 @@ export class MobileAccountPage {
     this.page = page;
 
     this.heading = page.getByRole('heading');
-    this.balance = page.getByTestId('account-balance');
+    this.balance = page.getByTestId('transactions-balance');
     this.noTransactionsFoundError = page.getByText('No transactions');
     this.searchBox = page.getByPlaceholder(/^Search/);
     this.transactionList = page.getByLabel('transaction list');

packages/desktop-client/e2e/page-models/rules-page.js

@@ -61,6 +61,27 @@ export class RulesPage {
         this.page.getByTestId('action-list'),
       );
     }
+
+    if (data.splits) {
+      if (data.splits.beforeSplitActions) {
+        await this._fillEditorFields(
+          data.splits.beforeSplitActions,
+          this.page.getByTestId('action-list'),
+        );
+      }
+
+      if (data.splits.splitActions) {
+        let idx = data.splits?.beforeSplitActions.length ?? 0;
+        for (const splitActions of data.splits.splitActions) {
+          await this.page.getByTestId('add-split-transactions').click();
+          await this._fillEditorFields(
+            splitActions,
+            this.page.getByTestId('action-list').nth(idx),
+          );
+          idx++;
+        }
+      }
+    }
   }
 
   async _fillEditorFields(data, rootElement) {

packages/desktop-client/e2e/page-models/settings-page.js

@@ -6,4 +6,10 @@ export class SettingsPage {
   async exportData() {
     await this.page.getByRole('button', { name: 'Export data' }).click();
   }
+
+  async enableExperimentalFeature(featureName) {
+    await this.page.getByTestId('advanced-settings').click();
+    await this.page.getByTestId('experimental-settings').click();
+    await this.page.getByLabel(featureName).check();
+  }
 }

packages/desktop-client/e2e/rules.test.js

@@ -67,4 +67,73 @@ test.describe('Rules', () => {
     await expect(transaction.debit).toHaveText('12.34');
     await expect(page).toMatchThemeScreenshots();
   });
+
+  test('creates a split transaction rule and makes sure it is applied when creating a transaction', async () => {
+    rulesPage = await navigation.goToRulesPage();
+
+    await rulesPage.createRule({
+      conditions: [
+        {
+          field: 'payee',
+          op: 'is',
+          value: 'Ikea',
+        },
+      ],
+      splits: {
+        beforeSplitActions: [
+          {
+            field: 'notes',
+            value: 'food / entertainment',
+          },
+        ],
+        splitActions: [
+          [
+            {
+              field: 'a fixed percent of the remainder',
+              value: '90',
+            },
+            {
+              field: 'category',
+              value: 'Entertainment',
+            },
+          ],
+          [
+            {
+              field: 'an equal portion of the remainder',
+            },
+            {
+              field: 'category',
+              value: 'Food',
+            },
+          ],
+        ],
+      },
+    });
+
+    const accountPage = await navigation.goToAccountPage(
+      'Capital One Checking',
+    );
+
+    await accountPage.createSingleTransaction({
+      debit: '100.00',
+      payee: 'Ikea',
+    });
+
+    const transaction = accountPage.getNthTransaction(0);
+    await expect(transaction.payee).toHaveText('Split');
+    await expect(transaction.notes).toHaveText('food / entertainment');
+    await expect(transaction.category).toHaveText('Split');
+    await expect(transaction.debit).toHaveText('100.00');
+    await expect(page).toMatchThemeScreenshots();
+
+    const firstSplitTransaction = accountPage.getNthTransaction(1);
+    await expect(firstSplitTransaction.payee).toHaveText('Ikea');
+    await expect(firstSplitTransaction.debit).toHaveText('90.00');
+    await expect(firstSplitTransaction.category).toHaveText('Entertainment');
+
+    const secondSplitTransaction = accountPage.getNthTransaction(2);
+    await expect(secondSplitTransaction.payee).toHaveText('Ikea');
+    await expect(secondSplitTransaction.debit).toHaveText('10.00');
+    await expect(secondSplitTransaction.category).toHaveText('Food');
+  });
 });