@actual-app/api 6.4.0 → 6.6.0

package/dist/app/query.js

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

package/dist/index.js

@@ -27,6 +27,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.shutdown = exports.init = exports.utils = exports.methods = exports.internal = void 0;
+// @ts-ignore: bundle not available until we build it
 // eslint-disable-next-line import/extensions
 const bundle = __importStar(require("./app/bundle.api.js"));
 const injected = __importStar(require("./injected"));
@@ -42,7 +43,11 @@ async function init(config = {}) {
         return;
     }
     (0, validateNodeVersion_1.validateNodeVersion)();
-    global.fetch = (...args) => import('node-fetch').then(({ default: fetch }) => fetch(...args));
+    if (!globalThis.fetch) {
+        globalThis.fetch = (url, init) => {
+            return Promise.resolve().then(() => __importStar(require('node-fetch'))).then(({ default: fetch }) => fetch(url, init));
+        };
+    }
     await bundle.init(config);
     actualApp = bundle.lib;
     injected.override(bundle.lib.send);

package/dist/methods.js

@@ -22,14 +22,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 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.deleteAccount = exports.reopenAccount = exports.closeAccount = exports.updateAccount = exports.createAccount = exports.getAccounts = exports.deleteTransaction = exports.updateTransaction = exports.filterTransactions = 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.deletePayee = exports.updatePayee = exports.createPayee = exports.getPayees = exports.deleteCategory = exports.updateCategory = exports.createCategory = exports.getCategories = exports.deleteCategoryGroup = exports.updateCategoryGroup = exports.createCategoryGroup = 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;
 const injected = __importStar(require("./injected"));
 var query_1 = require("./app/query");
-Object.defineProperty(exports, "q", { enumerable: true, get: function () { return __importDefault(query_1).default; } });
+Object.defineProperty(exports, "q", { enumerable: true, get: function () { return query_1.q; } });
 function send(name, args) {
     return injected.send(name, args);
 }
@@ -104,10 +101,6 @@ function getTransactions(accountId, startDate, endDate) {
     return send('api/transactions-get', { accountId, startDate, endDate });
 }
 exports.getTransactions = getTransactions;
-function filterTransactions(accountId, text) {
-    return send('api/transactions-filter', { accountId, text });
-}
-exports.filterTransactions = filterTransactions;
 function updateTransaction(id, fields) {
     return send('api/transaction-update', { id, fields });
 }

package/dist/methods.test.js

@@ -23,6 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-strict-ignore
 const fs = __importStar(require("fs/promises"));
 const path = __importStar(require("path"));
 const api = __importStar(require("./index"));
@@ -228,4 +229,77 @@ describe('API CRUD operations', () => {
             }),
         ]));
     });
+    // apis: createPayee, getPayees, updatePayee, deletePayee
+    test('Payees: successfully update payees', async () => {
+        const payeeId1 = await api.createPayee({ name: 'test-payee1' });
+        const payeeId2 = await api.createPayee({ name: 'test-payee2' });
+        let payees = await api.getPayees();
+        // payees successfully created
+        expect(payees).toEqual(expect.arrayContaining([
+            expect.objectContaining({
+                id: payeeId1,
+                name: 'test-payee1',
+            }),
+            expect.objectContaining({
+                id: payeeId2,
+                name: 'test-payee2',
+            }),
+        ]));
+        await api.updatePayee(payeeId1, { name: 'test-updated-payee' });
+        await api.deletePayee(payeeId2);
+        // confirm update and delete were successful
+        payees = await api.getPayees();
+        expect(payees).toEqual(expect.arrayContaining([
+            expect.objectContaining({
+                id: payeeId1,
+                name: 'test-updated-payee',
+            }),
+            expect.not.objectContaining({
+                name: 'test-payee1',
+            }),
+            expect.not.objectContaining({
+                id: payeeId2,
+            }),
+        ]));
+    });
+    // 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 },
+        ];
+        const addResult = await api.addTransactions(accountId, newTransaction, {
+            learnCategories: true,
+            runTransfers: true,
+        });
+        expect(addResult).toBe('ok');
+        // 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))));
+        expect(transactions).toHaveLength(2);
+        newTransaction = [
+            { date: '2023-12-03', imported_id: '11', amount: 100 },
+            { date: '2023-12-03', imported_id: '22', amount: 200 },
+        ];
+        const reconciled = await api.importTransactions(accountId, newTransaction);
+        // Expect it to reconcile and to have updated one of the previous transactions
+        expect(reconciled.added).toHaveLength(1);
+        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).toHaveLength(2);
+        const idToUpdate = reconciled.added[0];
+        const idToDelete = reconciled.updated[0];
+        await api.updateTransaction(idToUpdate, { amount: 500 });
+        await api.deleteTransaction(idToDelete);
+        // confirm updates and deletions work
+        transactions = await api.getTransactions(accountId, '2023-12-01', '2023-12-31');
+        expect(transactions).toEqual(expect.arrayContaining([
+            expect.objectContaining({ id: idToUpdate, amount: 500 }),
+            expect.not.objectContaining({ id: idToDelete }),
+        ]));
+        expect(transactions).toHaveLength(1);
+    });
 });

package/dist/migrations/1632571489012_remove_cache.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-async function runMigration(db, uuid) {
+async function runMigration(db) {
     function getValue(node) {
         return node.expr != null ? node.expr : node.cachedValue;
     }

package/dist/migrations/1704572023730_add_account_sync_source.sql

@@ -0,0 +1,5 @@
+BEGIN TRANSACTION;
+
+ALTER TABLE accounts ADD COLUMN account_sync_source TEXT;
+
+COMMIT;

package/dist/migrations/1704572023731_add_missing_goCardless_sync_source.sql

@@ -0,0 +1,9 @@
+BEGIN TRANSACTION;
+
+UPDATE accounts
+SET
+  account_sync_source = 'goCardless'
+WHERE account_id IS NOT NULL
+  AND account_sync_source IS NULL;
+
+COMMIT;

package/dist/migrations/1707267033000_reports.sql

@@ -0,0 +1,28 @@
+BEGIN TRANSACTION;
+
+CREATE TABLE custom_reports
+  (
+    id TEXT PRIMARY KEY,
+    name TEXT,
+    start_date TEXT,
+    end_date TEXT,
+    date_static INTEGER DEFAULT 0,
+    date_range TEXT,
+    mode TEXT DEFAULT 'total',
+    group_by TEXT DEFAULT 'Category',
+    balance_type TEXT DEFAULT 'Expense',
+    show_empty INTEGER DEFAULT 0,
+    show_offbudget INTEGER DEFAULT 0,
+    show_hidden INTEGER DEFAULT 0,
+    show_uncategorized INTEGER DEFAULT 0,
+    selected_categories TEXT,
+    graph_type TEXT DEFAULT 'BarGraph',
+    conditions TEXT,
+    conditions_op TEXT DEFAULT 'and',
+    metadata TEXT,
+    interval TEXT DEFAULT 'Monthly',
+    color_scheme TEXT,
+    tombstone INTEGER DEFAULT 0
+  );
+
+COMMIT;

package/dist/package.json

@@ -1,36 +1,38 @@
 {
     "name": "@actual-app/api",
-    "version": "6.4.0",
+    "version": "6.6.0",
     "license": "MIT",
     "description": "An API for Actual",
     "engines": {
         "node": ">=18.12.0"
     },
     "main": "dist/index.js",
-    "types": "dist/index.d.ts",
+    "types": "@types/index.d.ts",
     "files": [
         "dist"
     ],
     "scripts": {
         "build:app": "yarn workspace loot-core build:api",
-        "build:node": "tsc --p tsconfig.dist.json",
+        "build:node": "tsc --p tsconfig.dist.json && tsc-alias -p tsconfig.dist.json",
         "build:migrations": "cp migrations/*.sql dist/migrations",
         "build:default-db": "cp default-db.sqlite dist/",
-        "build": "rm -rf dist && yarn run build:app && yarn run build:node && yarn run build:migrations && yarn run build:default-db",
-        "test": "yarn run build:app && jest -c jest.config.js"
+        "build": "yarn run clean && yarn run build:app && yarn run build:node && yarn run build:migrations && yarn run build:default-db",
+        "test": "yarn run build:app && jest -c jest.config.js",
+        "clean": "rm -rf dist @types"
     },
     "dependencies": {
-        "better-sqlite3": "^9.1.1",
+        "better-sqlite3": "^9.3.0",
         "compare-versions": "^6.1.0",
         "node-fetch": "^3.3.2",
-        "uuid": "^9.0.0"
+        "uuid": "^9.0.1"
     },
     "devDependencies": {
-        "@swc/core": "^1.3.82",
-        "@swc/jest": "^0.2.29",
-        "@types/jest": "^27.5.0",
+        "@swc/core": "^1.3.105",
+        "@swc/jest": "^0.2.31",
+        "@types/jest": "^27.5.2",
         "@types/uuid": "^9.0.2",
-        "jest": "^27.0.0",
+        "jest": "^27.5.1",
+        "tsc-alias": "^1.8.8",
         "typescript": "^5.0.2"
     }
 }

package/package.json

@@ -1,36 +1,38 @@
 {
   "name": "@actual-app/api",
-  "version": "6.4.0",
+  "version": "6.6.0",
   "license": "MIT",
   "description": "An API for Actual",
   "engines": {
     "node": ">=18.12.0"
   },
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "@types/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
     "build:app": "yarn workspace loot-core build:api",
-    "build:node": "tsc --p tsconfig.dist.json",
+    "build:node": "tsc --p tsconfig.dist.json && tsc-alias -p tsconfig.dist.json",
     "build:migrations": "cp migrations/*.sql dist/migrations",
     "build:default-db": "cp default-db.sqlite dist/",
-    "build": "rm -rf dist && yarn run build:app && yarn run build:node && yarn run build:migrations && yarn run build:default-db",
-    "test": "yarn run build:app && jest -c jest.config.js"
+    "build": "yarn run clean && yarn run build:app && yarn run build:node && yarn run build:migrations && yarn run build:default-db",
+    "test": "yarn run build:app && jest -c jest.config.js",
+    "clean": "rm -rf dist @types"
   },
   "dependencies": {
-    "better-sqlite3": "^9.1.1",
+    "better-sqlite3": "^9.3.0",
     "compare-versions": "^6.1.0",
     "node-fetch": "^3.3.2",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@swc/core": "^1.3.82",
-    "@swc/jest": "^0.2.29",
-    "@types/jest": "^27.5.0",
+    "@swc/core": "^1.3.105",
+    "@swc/jest": "^0.2.31",
+    "@types/jest": "^27.5.2",
     "@types/uuid": "^9.0.2",
-    "jest": "^27.0.0",
+    "jest": "^27.5.1",
+    "tsc-alias": "^1.8.8",
     "typescript": "^5.0.2"
   }
 }

package/dist/app/bundle.api.d.ts

@@ -1,6 +0,0 @@
-export = __webpack_exports__;
-export = __webpack_exports__;
-/******/
-/************************************************************************/
-/******/
-/******/ /******/ /******/ /******/ declare var __webpack_exports__: any;

package/dist/app/query.d.ts

@@ -1,19 +0,0 @@
-export default function q(table: any): Query;
-declare class Query {
-    constructor(state: any);
-    state: any;
-    filter(expr: any): Query;
-    unfilter(exprs: any): Query;
-    select(exprs?: any[]): Query;
-    calculate(expr: any): Query;
-    groupBy(exprs: any): Query;
-    orderBy(exprs: any): Query;
-    limit(num: any): Query;
-    offset(num: any): Query;
-    raw(): Query;
-    withDead(): Query;
-    withoutValidatedRefs(): Query;
-    options(opts: any): Query;
-    serialize(): any;
-}
-export {};

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-export function init(config?: {}): Promise<any>;
-export function shutdown(): Promise<void>;
-export const internal: any;
-export * as methods from "./methods";
-export * from "./methods";
-export * as utils from "./utils";

package/dist/injected.d.ts

@@ -1,2 +0,0 @@
-export function override(sendImplementation: any): void;
-export let send: any;

package/dist/jest.config.d.ts

@@ -1,9 +0,0 @@
-export const moduleFileExtensions: string[];
-export const testEnvironment: string;
-export const testPathIgnorePatterns: string[];
-export const watchPathIgnorePatterns: string[];
-export const setupFilesAfterEnv: string[];
-export const transformIgnorePatterns: string[];
-export const transform: {
-    '^.+\\.(t|j)sx?$': string;
-};

package/dist/methods.d.ts

@@ -1,39 +0,0 @@
-export function runImport(name: any, func: any): Promise<void>;
-export function loadBudget(budgetId: any): Promise<any>;
-export function downloadBudget(syncId: any, { password }?: {
-    password: any;
-}): Promise<any>;
-export function sync(): Promise<any>;
-export function batchBudgetUpdates(func: any): Promise<void>;
-export function runQuery(query: any): any;
-export function getBudgetMonths(): any;
-export function getBudgetMonth(month: any): any;
-export function setBudgetAmount(month: any, categoryId: any, value: any): any;
-export function setBudgetCarryover(month: any, categoryId: any, flag: any): any;
-export function addTransactions(accountId: any, transactions: any, { learnCategories, runTransfers }?: {
-    learnCategories?: boolean;
-    runTransfers?: boolean;
-}): any;
-export function importTransactions(accountId: any, transactions: any): any;
-export function getTransactions(accountId: any, startDate: any, endDate: any): any;
-export function filterTransactions(accountId: any, text: any): any;
-export function updateTransaction(id: any, fields: any): any;
-export function deleteTransaction(id: any): any;
-export function getAccounts(): any;
-export function createAccount(account: any, initialBalance: any): any;
-export function updateAccount(id: any, fields: any): any;
-export function closeAccount(id: any, transferAccountId: any, transferCategoryId: any): any;
-export function reopenAccount(id: any): any;
-export function deleteAccount(id: any): any;
-export function createCategoryGroup(group: any): any;
-export function updateCategoryGroup(id: any, fields: any): any;
-export function deleteCategoryGroup(id: any, transferCategoryId: any): any;
-export function getCategories(): any;
-export function createCategory(category: any): any;
-export function updateCategory(id: any, fields: any): any;
-export function deleteCategory(id: any, transferCategoryId: any): any;
-export function getPayees(): any;
-export function createPayee(payee: any): any;
-export function updatePayee(id: any, fields: any): any;
-export function deletePayee(id: any): any;
-export { default as q } from "./app/query";

package/dist/methods.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/migrations/1632571489012_remove_cache.d.ts

@@ -1 +0,0 @@
-export default function runMigration(db: any, uuid: any): Promise<void>;

package/dist/utils.d.ts

@@ -1,2 +0,0 @@
-export function amountToInteger(n: any): number;
-export function integerToAmount(n: any): number;

package/dist/validateNodeVersion.d.ts

@@ -1 +0,0 @@
-export function validateNodeVersion(): void;