@actual-app/api 5.1.2 → 6.0.1

package/dist/app/query.d.ts

@@ -0,0 +1,19 @@
+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/app/query.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Query {
+    constructor(state) {
+        this.state = {
+            filterExpressions: state.filterExpressions || [],
+            selectExpressions: state.selectExpressions || [],
+            groupExpressions: state.groupExpressions || [],
+            orderExpressions: state.orderExpressions || [],
+            calculation: false,
+            rawMode: false,
+            withDead: false,
+            validateRefs: true,
+            limit: null,
+            offset: null,
+            ...state,
+        };
+    }
+    filter(expr) {
+        return new Query({
+            ...this.state,
+            filterExpressions: [...this.state.filterExpressions, expr],
+        });
+    }
+    unfilter(exprs) {
+        let exprSet = new Set(exprs);
+        return new Query({
+            ...this.state,
+            filterExpressions: this.state.filterExpressions.filter(expr => !exprSet.has(Object.keys(expr)[0])),
+        });
+    }
+    select(exprs = []) {
+        if (!Array.isArray(exprs)) {
+            exprs = [exprs];
+        }
+        let query = new Query({ ...this.state, selectExpressions: exprs });
+        query.state.calculation = false;
+        return query;
+    }
+    calculate(expr) {
+        let query = this.select({ result: expr });
+        query.state.calculation = true;
+        return query;
+    }
+    groupBy(exprs) {
+        if (!Array.isArray(exprs)) {
+            exprs = [exprs];
+        }
+        return new Query({
+            ...this.state,
+            groupExpressions: [...this.state.groupExpressions, ...exprs],
+        });
+    }
+    orderBy(exprs) {
+        if (!Array.isArray(exprs)) {
+            exprs = [exprs];
+        }
+        return new Query({
+            ...this.state,
+            orderExpressions: [...this.state.orderExpressions, ...exprs],
+        });
+    }
+    limit(num) {
+        return new Query({ ...this.state, limit: num });
+    }
+    offset(num) {
+        return new Query({ ...this.state, offset: num });
+    }
+    raw() {
+        return new Query({ ...this.state, rawMode: true });
+    }
+    withDead() {
+        return new Query({ ...this.state, withDead: true });
+    }
+    withoutValidatedRefs() {
+        return new Query({ ...this.state, validateRefs: false });
+    }
+    options(opts) {
+        return new Query({ ...this.state, tableOptions: opts });
+    }
+    serialize() {
+        return this.state;
+    }
+}
+function q(table) {
+    return new Query({ table });
+}
+exports.default = q;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+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/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shutdown = exports.init = exports.utils = exports.methods = exports.internal = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const bundle = __importStar(require("./app/bundle.api"));
+const injected = __importStar(require("./injected"));
+let actualApp;
+exports.internal = bundle.lib;
+// DEPRECATED: remove the next line in @actual-app/api v7
+exports.methods = __importStar(require("./methods"));
+__exportStar(require("./methods"), exports);
+exports.utils = __importStar(require("./utils"));
+async function init(config = {}) {
+    if (actualApp) {
+        return;
+    }
+    global.fetch = node_fetch_1.default;
+    await bundle.init(config);
+    actualApp = bundle.lib;
+    injected.override(bundle.lib.send);
+    return bundle.lib;
+}
+exports.init = init;
+async function shutdown() {
+    if (actualApp) {
+        await actualApp.send('close-budget');
+        actualApp = null;
+    }
+}
+exports.shutdown = shutdown;

package/dist/injected.d.ts

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

package/dist/injected.js

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

package/dist/methods.d.ts

@@ -0,0 +1,35 @@
+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 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): 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.js

@@ -0,0 +1,181 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __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.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; } });
+function send(name, args) {
+    return injected.send(name, args);
+}
+async function runImport(name, func) {
+    await send('api/start-import', { budgetName: name });
+    try {
+        await func();
+    }
+    catch (e) {
+        await send('api/abort-import');
+        throw e;
+    }
+    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 batchBudgetUpdates(func) {
+    await send('api/batch-budget-start');
+    try {
+        await func();
+    }
+    finally {
+        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) {
+    return send('api/transactions-add', { accountId, transactions });
+}
+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 filterTransactions(accountId, text) {
+    return send('api/transactions-filter', { accountId, text });
+}
+exports.filterTransactions = filterTransactions;
+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,
+        transferAccountId,
+        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 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 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;

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

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

package/dist/migrations/1632571489012_remove_cache.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+async function runMigration(db, uuid) {
+    function getValue(node) {
+        return node.expr != null ? node.expr : node.cachedValue;
+    }
+    db.execQuery(`
+CREATE TABLE zero_budget_months
+  (id TEXT PRIMARY KEY,
+   buffered INTEGER DEFAULT 0);
+
+CREATE TABLE zero_budgets
+  (id TEXT PRIMARY KEY,
+   month INTEGER,
+   category TEXT,
+   amount INTEGER DEFAULT 0,
+   carryover INTEGER DEFAULT 0);
+
+CREATE TABLE reflect_budgets
+  (id TEXT PRIMARY KEY,
+   month INTEGER,
+   category TEXT,
+   amount INTEGER DEFAULT 0,
+   carryover INTEGER DEFAULT 0);
+
+CREATE TABLE notes
+  (id TEXT PRIMARY KEY,
+   note TEXT);
+
+CREATE TABLE kvcache (key TEXT PRIMARY KEY, value TEXT);
+CREATE TABLE kvcache_key (id INTEGER PRIMARY KEY, key REAL);
+`);
+    // Migrate budget amounts and carryover
+    let budget = db.runQuery(`SELECT * FROM spreadsheet_cells WHERE name LIKE 'budget%!budget-%'`, [], true);
+    db.transaction(() => {
+        budget.forEach(monthBudget => {
+            let match = monthBudget.name.match(/^(budget-report|budget)(\d+)!budget-(.+)$/);
+            if (match == null) {
+                console.log('Warning: invalid budget month name', monthBudget.name);
+                return;
+            }
+            let type = match[1];
+            let month = match[2].slice(0, 4) + '-' + match[2].slice(4);
+            let dbmonth = parseInt(match[2]);
+            let cat = match[3];
+            let amount = parseInt(getValue(monthBudget));
+            if (isNaN(amount)) {
+                amount = 0;
+            }
+            let sheetName = monthBudget.name.split('!')[0];
+            let carryover = db.runQuery('SELECT * FROM spreadsheet_cells WHERE name = ?', [`${sheetName}!carryover-${cat}`], true);
+            let table = type === 'budget-report' ? 'reflect_budgets' : 'zero_budgets';
+            db.runQuery(`INSERT INTO ${table} (id, month, category, amount, carryover) VALUES (?, ?, ?, ?, ?)`, [
+                `${month}-${cat}`,
+                dbmonth,
+                cat,
+                amount,
+                carryover.length > 0 && getValue(carryover[0]) === 'true' ? 1 : 0,
+            ]);
+        });
+    });
+    // Migrate buffers
+    let buffers = db.runQuery(`SELECT * FROM spreadsheet_cells WHERE name LIKE 'budget%!buffered'`, [], true);
+    db.transaction(() => {
+        buffers.forEach(buffer => {
+            let match = buffer.name.match(/^budget(\d+)!buffered$/);
+            if (match) {
+                let month = match[1].slice(0, 4) + '-' + match[1].slice(4);
+                let amount = parseInt(getValue(buffer));
+                if (isNaN(amount)) {
+                    amount = 0;
+                }
+                db.runQuery(`INSERT INTO zero_budget_months (id, buffered) VALUES (?, ?)`, [month, amount]);
+            }
+        });
+    });
+    // Migrate notes
+    let notes = db.runQuery(`SELECT * FROM spreadsheet_cells WHERE name LIKE 'notes!%'`, [], true);
+    let parseNote = str => {
+        try {
+            let value = JSON.parse(str);
+            return value && value !== '' ? value : null;
+        }
+        catch (e) {
+            return null;
+        }
+    };
+    db.transaction(() => {
+        notes.forEach(note => {
+            let parsed = parseNote(getValue(note));
+            if (parsed) {
+                let [, id] = note.name.split('!');
+                db.runQuery(`INSERT INTO notes (id, note) VALUES (?, ?)`, [id, parsed]);
+            }
+        });
+    });
+    db.execQuery(`
+    DROP TABLE spreadsheet_cells;
+    ANALYZE;
+    VACUUM;
+  `);
+}
+exports.default = runMigration;

package/dist/migrations/1681115033845_add_schedule_name.sql

@@ -0,0 +1,5 @@
+BEGIN TRANSACTION;
+
+ALTER TABLE schedules ADD COLUMN name TEXT DEFAULT NULL;
+
+COMMIT;

package/dist/migrations/1682974838138_remove_payee_rules.sql

@@ -0,0 +1,5 @@
+BEGIN TRANSACTION;
+
+DROP TABLE payee_rules;
+
+COMMIT;

package/dist/test.d.ts

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

package/dist/test.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const api = __importStar(require("./index"));
+async function run() {
+    let app = await api.init({ config: { dataDir: '/tmp' } });
+    await app.send('create-budget', { testMode: true });
+}
+run();

package/dist/utils.d.ts

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

package/dist/utils.js

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

package/package.json

@@ -1,25 +1,27 @@
 {
   "name": "@actual-app/api",
-  "version": "5.1.2",
+  "version": "6.0.1",
   "license": "MIT",
   "description": "An API for Actual",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "app",
-    "default-db.sqlite",
-    "index.js",
-    "injected.js",
-    "methods.js",
-    "migrations",
-    "utils.js"
+    "dist"
   ],
   "scripts": {
     "lint": "eslint .",
-    "build": "yarn workspace loot-core build:api"
+    "build:app": "yarn workspace loot-core build:api",
+    "build:node": "tsc --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"
   },
   "dependencies": {
     "better-sqlite3": "^8.2.0",
     "node-fetch": "^2.6.9",
     "uuid": "3.3.2"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.2"
   }
 }