Skip to content

A local-first personal finance app

Convert loot-core to TS p1 (#841)

Alberto Gasparin79ad04dd8809
diff --git a/.eslintrc.js b/.eslintrc.js
index 0f2fd4ab34..4a5d5aa27f 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -10,8 +10,8 @@ rulesDirPlugin.RULES_DIR = path.join(
);
module.exports = {
- plugins: ['prettier', 'import', 'rulesdir'],
- extends: ['react-app'],
+ plugins: ['prettier', 'import', 'rulesdir', '@typescript-eslint'],
+ extends: ['react-app', 'plugin:@typescript-eslint/recommended'],
reportUnusedDisableDirectives: true,
rules: {
'prettier/prettier': 'error',
@@ -66,5 +66,11 @@ module.exports = {
pathGroupsExcludedImportTypes: ['react'],
},
],
+
+ // Rules disable during TS migration
+ '@typescript-eslint/no-var-requires': 'off',
+ 'prefer-const': 'off',
+ '@typescript-eslint/no-empty-function': 'off',
+ '@typescript-eslint/no-unused-vars': 'off',
},
};
diff --git a/packages/desktop-client/src/components/budget/MobileBudget.js b/packages/desktop-client/src/components/budget/MobileBudget.js
index 8351cae45e..e53638b28a 100644
--- a/packages/desktop-client/src/components/budget/MobileBudget.js
+++ b/packages/desktop-client/src/components/budget/MobileBudget.js
@@ -8,7 +8,7 @@ import {
addCategory,
moveCategory,
moveCategoryGroup,
-} from 'loot-core/src/shared/categories.js';
+} from 'loot-core/src/shared/categories';
import * as monthUtils from 'loot-core/src/shared/months';
import AnimatedLoading from '../../icons/AnimatedLoading';
diff --git a/packages/desktop-client/src/components/budget/index.js b/packages/desktop-client/src/components/budget/index.js
index 3bbc203196..6f7d896b5a 100644
--- a/packages/desktop-client/src/components/budget/index.js
+++ b/packages/desktop-client/src/components/budget/index.js
@@ -13,7 +13,7 @@ import {
addGroup,
updateGroup,
deleteGroup,
-} from 'loot-core/src/shared/categories.js';
+} from 'loot-core/src/shared/categories';
import * as monthUtils from 'loot-core/src/shared/months';
import useFeatureFlag from '../../hooks/useFeatureFlag';
diff --git a/packages/desktop-client/src/components/schedules/StatusBadge.js b/packages/desktop-client/src/components/schedules/StatusBadge.js
index 636286c67d..ca8fbea125 100644
--- a/packages/desktop-client/src/components/schedules/StatusBadge.js
+++ b/packages/desktop-client/src/components/schedules/StatusBadge.js
@@ -67,7 +67,7 @@ export function getStatusProps(status) {
}
export function StatusIcon({ status }) {
- let { color } = getStatusProps(status);
+ let { color, Icon } = getStatusProps(status);
return <Icon style={{ width: 13, height: 13, color }} />;
}
diff --git a/packages/loot-core/jest.config.js b/packages/loot-core/jest.config.js
index d312daafb7..f28baba230 100644
--- a/packages/loot-core/jest.config.js
+++ b/packages/loot-core/jest.config.js
@@ -1,15 +1,23 @@
module.exports = {
preset: 'ts-jest/presets/js-with-ts-esm',
- moduleFileExtensions: ['testing.js', 'electron.js'].concat([
+ moduleFileExtensions: [
+ 'testing.js',
+ 'testing.ts',
+ 'electron.js',
+ 'electron.ts',
'mjs',
'js',
'ts',
'tsx',
'json',
- ]),
+ ],
setupFilesAfterEnv: ['<rootDir>/src/mocks/setup.js'],
testEnvironment: 'node',
- testPathIgnorePatterns: ['/node_modules/', '/lib/', '.+/index.web.test.js'],
+ testPathIgnorePatterns: [
+ '/node_modules/',
+ '/lib/',
+ '.+/index\\.web\\.test\\.(js|ts|tsx)',
+ ],
transformIgnorePatterns: ['/node_modules/', '__mocks__'],
transform: {
'\\.pegjs$': 'pegjs-jest-transformer',
diff --git a/packages/loot-core/jest.web.config.js b/packages/loot-core/jest.web.config.js
index caaa70d8d7..658a61021e 100644
--- a/packages/loot-core/jest.web.config.js
+++ b/packages/loot-core/jest.web.config.js
@@ -2,7 +2,10 @@ module.exports = {
preset: 'ts-jest/presets/js-with-ts-esm',
moduleFileExtensions: [
'testing.js',
+ 'testing.ts',
'web.js',
+ 'web.ts',
+ 'web.tsx',
'mjs',
'js',
'ts',
@@ -11,7 +14,7 @@ module.exports = {
],
testEnvironment: 'jsdom',
testPathIgnorePatterns: ['/node_modules/', '/lib/'].filter(Boolean),
- testMatch: ['**/*.web.test.js'],
+ testMatch: ['**/*.web.test.(js|ts|tsx)'],
transformIgnorePatterns: ['__mocks__', '/node_modules/(?!absurd-sql)'],
transform: {
'\\.pegjs$': 'pegjs-jest-transformer',
diff --git a/packages/loot-core/package.json b/packages/loot-core/package.json
index 04e20eb73d..4e0a411857 100644
--- a/packages/loot-core/package.json
+++ b/packages/loot-core/package.json
@@ -42,6 +42,7 @@
"@babel/preset-env": "^7.20.2",
"@babel/preset-typescript": "^7.20.2",
"@types/jest": "^27.5.0",
+ "@types/jlongster__sql.js": "npm:@types/sql.js@latest",
"@types/webpack": "^5.28.0",
"adm-zip": "^0.5.9",
"babel-loader": "^8.0.6",
diff --git a/packages/loot-core/src/platform/exceptions/index.browser.js b/packages/loot-core/src/platform/exceptions/index.browser.ts
similarity index 100%
rename from packages/loot-core/src/platform/exceptions/index.browser.js
rename to packages/loot-core/src/platform/exceptions/index.browser.ts
diff --git a/packages/loot-core/src/platform/exceptions/index.d.ts b/packages/loot-core/src/platform/exceptions/index.d.ts
new file mode 100644
index 0000000000..56aad41fa9
--- /dev/null
+++ b/packages/loot-core/src/platform/exceptions/index.d.ts
@@ -0,0 +1,2 @@
+export function captureException(exc: Error): void;
+export function captureBreadcrumb(breadcrumb: unknown): void;
diff --git a/packages/loot-core/src/platform/exceptions/index.electron.js b/packages/loot-core/src/platform/exceptions/index.electron.ts
similarity index 100%
rename from packages/loot-core/src/platform/exceptions/index.electron.js
rename to packages/loot-core/src/platform/exceptions/index.electron.ts
diff --git a/packages/loot-core/src/platform/exceptions/index.testing.js b/packages/loot-core/src/platform/exceptions/index.testing.ts
similarity index 100%
rename from packages/loot-core/src/platform/exceptions/index.testing.js
rename to packages/loot-core/src/platform/exceptions/index.testing.ts
diff --git a/packages/loot-core/src/platform/exceptions/index.web.js b/packages/loot-core/src/platform/exceptions/index.web.ts
similarity index 100%
rename from packages/loot-core/src/platform/exceptions/index.web.js
rename to packages/loot-core/src/platform/exceptions/index.web.ts
diff --git a/packages/loot-core/src/platform/server/fetch/index.d.ts b/packages/loot-core/src/platform/server/fetch/index.d.ts
new file mode 100644
index 0000000000..5d610e61bd
--- /dev/null
+++ b/packages/loot-core/src/platform/server/fetch/index.d.ts
@@ -0,0 +1,5 @@
+export function fetch(input: RequestInfo | URL): Promise<unknown>;
+export function fetchBinary(
+ input: RequestInfo | URL,
+ filepath: string,
+): Promise<unknown>;
diff --git a/packages/loot-core/src/platform/server/fetch/index.electron.js b/packages/loot-core/src/platform/server/fetch/index.electron.ts
similarity index 57%
rename from packages/loot-core/src/platform/server/fetch/index.electron.js
rename to packages/loot-core/src/platform/server/fetch/index.electron.ts
index bc79d0f7d5..4374bab0af 100644
--- a/packages/loot-core/src/platform/server/fetch/index.electron.js
+++ b/packages/loot-core/src/platform/server/fetch/index.electron.ts
@@ -1,9 +1,9 @@
let fs = require('fs');
-let fetch = require('node-fetch');
+const _fetch = require('node-fetch');
-async function fetchBinary(url, filepath) {
- const res = await fetch(url);
+async function _fetchBinary(url, filepath) {
+ const res = await _fetch(url);
return new Promise((resolve, reject) => {
const fileStream = fs.createWriteStream(filepath);
res.body.pipe(fileStream);
@@ -11,9 +11,9 @@ async function fetchBinary(url, filepath) {
reject(err);
});
fileStream.on('finish', function () {
- resolve();
+ resolve(undefined);
});
});
}
-module.exports = { fetch, fetchBinary };
+module.exports = { fetch: _fetch, fetchBinary: _fetchBinary };
diff --git a/packages/loot-core/src/platform/server/fetch/index.testing.js b/packages/loot-core/src/platform/server/fetch/index.testing.ts
similarity index 100%
rename from packages/loot-core/src/platform/server/fetch/index.testing.js
rename to packages/loot-core/src/platform/server/fetch/index.testing.ts
diff --git a/packages/loot-core/src/platform/server/fetch/index.web.js b/packages/loot-core/src/platform/server/fetch/index.web.ts
similarity index 100%
rename from packages/loot-core/src/platform/server/fetch/index.web.js
rename to packages/loot-core/src/platform/server/fetch/index.web.ts
diff --git a/packages/loot-core/src/platform/server/fs/index.web.js b/packages/loot-core/src/platform/server/fs/index.web.js
index 2596e9569d..3b0bbc3590 100644
--- a/packages/loot-core/src/platform/server/fs/index.web.js
+++ b/packages/loot-core/src/platform/server/fs/index.web.js
@@ -5,7 +5,7 @@ let connection = require('../connection');
let idb = require('../indexeddb');
let { _getModule } = require('../sqlite');
-let baseAPI = require('./index.electron.js');
+let baseAPI = require('./index.electron');
let join = require('./path-join');
let FS = null;
diff --git a/packages/loot-core/src/platform/server/indexeddb/index.d.ts b/packages/loot-core/src/platform/server/indexeddb/index.d.ts
new file mode 100644
index 0000000000..97b1d26b13
--- /dev/null
+++ b/packages/loot-core/src/platform/server/indexeddb/index.d.ts
@@ -0,0 +1,7 @@
+export function getDatabase();
+export function openDatabase();
+export function closeDatabase();
+export function getStore(db: IDBDatabase, name: string);
+export function get(store: IDBObjectStore, key: IDBValidKey | IDBKeyRange);
+export function set(store: IDBObjectStore, value: unknown);
+export function del(store: IDBObjectStore, key: IDBValidKey);
diff --git a/packages/loot-core/src/platform/server/indexeddb/index.web.js b/packages/loot-core/src/platform/server/indexeddb/index.web.ts
similarity index 86%
rename from packages/loot-core/src/platform/server/indexeddb/index.web.js
rename to packages/loot-core/src/platform/server/indexeddb/index.web.ts
index 633f49d907..a88bf609c9 100644
--- a/packages/loot-core/src/platform/server/indexeddb/index.web.js
+++ b/packages/loot-core/src/platform/server/indexeddb/index.web.ts
@@ -7,13 +7,16 @@ function _openDatabase() {
let openRequest = indexedDB.open('actual', dbVersion);
openRequest.onupgradeneeded = function (e) {
- let db = e.target.result;
+ // @ts-expect-error EventTarget needs refinement
+ let db: IDBDatabase = e.target.result;
// Remove old stores
if (db.objectStoreNames.contains('filesystem')) {
+ // @ts-expect-error deleteObjectStore does not seem to accept options
db.deleteObjectStore('filesystem', { keyPath: 'filepath' });
}
if (db.objectStoreNames.contains('messages')) {
+ // @ts-expect-error deleteObjectStore does not seem to accept options
db.deleteObjectStore('messages', { keyPath: 'filepath' });
}
@@ -34,6 +37,7 @@ function _openDatabase() {
};
openRequest.onsuccess = function (e) {
+ // @ts-expect-error EventTarget needs refinement
let db = e.target.result;
db.onversionchange = () => {
@@ -87,12 +91,12 @@ function _openDatabase() {
});
}
-function getStore(db, name) {
+function getStore(db: IDBDatabase, name: string) {
let trans = db.transaction([name], 'readwrite');
return { trans, store: trans.objectStore(name) };
}
-async function get(store, key, mapper = x => x) {
+async function get(store: IDBObjectStore, key, mapper = x => x) {
return new Promise((resolve, reject) => {
let req = store.get(key);
req.onsuccess = e => {
@@ -102,10 +106,10 @@ async function get(store, key, mapper = x => x) {
});
}
-async function set(store, item) {
+async function set(store: IDBObjectStore, item) {
return new Promise((resolve, reject) => {
let req = store.put(item);
- req.onsuccess = e => resolve();
+ req.onsuccess = e => resolve(undefined);
req.onerror = e => reject(e);
});
}
@@ -113,7 +117,7 @@ async function set(store, item) {
async function del(store, key) {
return new Promise((resolve, reject) => {
let req = store.delete(key);
- req.onsuccess = e => resolve();
+ req.onsuccess = e => resolve(undefined);
req.onerror = e => reject(e);
});
}
@@ -132,6 +136,7 @@ function openDatabase() {
function closeDatabase() {
if (openedDb) {
openedDb.then(db => {
+ // @ts-expect-error db type needs refinement
db.close();
});
openedDb = null;
diff --git a/packages/loot-core/src/platform/server/log/index.web.js b/packages/loot-core/src/platform/server/log/index.api.ts
similarity index 71%
rename from packages/loot-core/src/platform/server/log/index.web.js
rename to packages/loot-core/src/platform/server/log/index.api.ts
index 53750a6f75..15f9a99164 100644
--- a/packages/loot-core/src/platform/server/log/index.web.js
+++ b/packages/loot-core/src/platform/server/log/index.api.ts
@@ -1,4 +1,6 @@
-const logger = {
+import type Logger from '.';
+
+const logger: Logger = {
info: (...args) => {
console.log(...args);
},
diff --git a/packages/loot-core/src/platform/server/log/index.d.ts b/packages/loot-core/src/platform/server/log/index.d.ts
new file mode 100644
index 0000000000..6a08454159
--- /dev/null
+++ b/packages/loot-core/src/platform/server/log/index.d.ts
@@ -0,0 +1,9 @@
+import { type Transports } from 'electron-log';
+
+interface Logger {
+ info(...args: unknown[]): void;
+ warn(...args: unknown[]): void;
+ transports?: Transports;
+}
+
+export default Logger;
diff --git a/packages/loot-core/src/platform/server/log/index.electron.js b/packages/loot-core/src/platform/server/log/index.electron.ts
similarity index 68%
rename from packages/loot-core/src/platform/server/log/index.electron.js
rename to packages/loot-core/src/platform/server/log/index.electron.ts
index 4fa7132197..7232b970bd 100644
--- a/packages/loot-core/src/platform/server/log/index.electron.js
+++ b/packages/loot-core/src/platform/server/log/index.electron.ts
@@ -1,4 +1,6 @@
-const logger = require('electron-log');
+import logger from 'electron-log';
+
+import type Logger from '.';
if (logger.transports) {
logger.transports.file.appName = 'Actual';
@@ -7,4 +9,4 @@ if (logger.transports) {
logger.transports.console.level = false;
}
-export default logger;
+export default logger as Logger;
diff --git a/packages/loot-core/src/platform/server/log/index.api.js b/packages/loot-core/src/platform/server/log/index.web.ts
similarity index 71%
rename from packages/loot-core/src/platform/server/log/index.api.js
rename to packages/loot-core/src/platform/server/log/index.web.ts
index 53750a6f75..15f9a99164 100644
--- a/packages/loot-core/src/platform/server/log/index.api.js
+++ b/packages/loot-core/src/platform/server/log/index.web.ts
@@ -1,4 +1,6 @@
-const logger = {
+import type Logger from '.';
+
+const logger: Logger = {
info: (...args) => {
console.log(...args);
},
diff --git a/packages/loot-core/src/platform/server/sqlite/index.d.ts b/packages/loot-core/src/platform/server/sqlite/index.d.ts
new file mode 100644
index 0000000000..0460c0113d
--- /dev/null
+++ b/packages/loot-core/src/platform/server/sqlite/index.d.ts
@@ -0,0 +1,30 @@
+export async function init(): unknown;
+
+export function _getModule(): SqlJsStatic;
+
+export function prepare(db, sql): unknown;
+
+export function runQuery(
+ db: unknown,
+ sql: string,
+ params?: string[],
+ fetchAll?: false,
+): { changes: unknown };
+export function runQuery(
+ db: unknown,
+ sql: string,
+ params: string[],
+ fetchAll: true,
+): unknown[];
+
+export function execQuery(db, sql): void;
+
+export function transaction(db, fn): unknown;
+
+export async function asyncTransaction(db, fn): unknown;
+
+export async function openDatabase(pathOrBuffer?: string | Buffer): unknown;
+
+export function closeDatabase(db): void;
+
+export function exportDatabase(db): void;
diff --git a/packages/loot-core/src/platform/server/sqlite/index.electron.js b/packages/loot-core/src/platform/server/sqlite/index.electron.ts
similarity index 98%
rename from packages/loot-core/src/platform/server/sqlite/index.electron.js
rename to packages/loot-core/src/platform/server/sqlite/index.electron.ts
index 241bf10d10..67bcacaa50 100644
--- a/packages/loot-core/src/platform/server/sqlite/index.electron.js
+++ b/packages/loot-core/src/platform/server/sqlite/index.electron.ts
@@ -1,4 +1,4 @@
-const Database = require('better-sqlite3');
+import Database from 'better-sqlite3';
function verifyParamTypes(sql, arr) {
arr.forEach(val => {
diff --git a/packages/loot-core/src/platform/server/sqlite/index.web.test.js b/packages/loot-core/src/platform/server/sqlite/index.web.test.ts
similarity index 85%
rename from packages/loot-core/src/platform/server/sqlite/index.web.test.js
rename to packages/loot-core/src/platform/server/sqlite/index.web.test.ts
index 9b6918823f..c48a88f9fc 100644
--- a/packages/loot-core/src/platform/server/sqlite/index.web.test.js
+++ b/packages/loot-core/src/platform/server/sqlite/index.web.test.ts
@@ -25,6 +25,7 @@ describe('Web sqlite', () => {
let rows = runQuery(db, 'SELECT * FROM numbers', null, true);
expect(rows.length).toBe(1);
+ // @ts-expect-error Property 'number' does not exist on type 'unknown'
expect(rows[0].number).toBe(4);
let consoleSpy = jest.spyOn(console, 'log').mockImplementation();
@@ -41,6 +42,7 @@ describe('Web sqlite', () => {
// Nothing should have changed in the db
rows = runQuery(db, 'SELECT * FROM numbers', null, true);
expect(rows.length).toBe(1);
+ // @ts-expect-error Property 'number' does not exist on type 'unknown'
expect(rows[0].number).toBe(4);
});
@@ -52,6 +54,7 @@ describe('Web sqlite', () => {
let rows = runQuery(db, 'SELECT * FROM numbers', null, true);
expect(rows.length).toBe(1);
+ // @ts-expect-error Property 'number' does not exist on type 'unknown'
expect(rows[0].number).toBe(4);
transaction(db, () => {
@@ -73,8 +76,11 @@ describe('Web sqlite', () => {
// Nothing should have changed in the db
rows = runQuery(db, 'SELECT * FROM numbers', null, true);
expect(rows.length).toBe(3);
+ // @ts-expect-error Property 'number' does not exist on type 'unknown'
expect(rows[0].number).toBe(4);
+ // @ts-expect-error Property 'number' does not exist on type 'unknown'
expect(rows[1].number).toBe(5);
+ // @ts-expect-error Property 'number' does not exist on type 'unknown'
expect(rows[2].number).toBe(6);
});
});
diff --git a/packages/loot-core/src/platform/server/sqlite/index.web.js b/packages/loot-core/src/platform/server/sqlite/index.web.ts
similarity index 83%
rename from packages/loot-core/src/platform/server/sqlite/index.web.js
rename to packages/loot-core/src/platform/server/sqlite/index.web.ts
index d8439a3a0e..0ad16c16db 100644
--- a/packages/loot-core/src/platform/server/sqlite/index.web.js
+++ b/packages/loot-core/src/platform/server/sqlite/index.web.ts
@@ -1,6 +1,6 @@
-import initSqlJS from '@jlongster/sql.js';
+import initSqlJS, { type SqlJsStatic } from '@jlongster/sql.js';
-let SQL = null;
+let SQL: SqlJsStatic | null = null;
export async function init() {
// `initSqlJS` doesn't actually return a real promise, so make sure
@@ -11,7 +11,7 @@ export async function init() {
}).then(
sql => {
SQL = sql;
- resolve();
+ resolve(undefined);
},
err => {
reject(err);
@@ -39,7 +39,19 @@ export function prepare(db, sql) {
return db.prepare(sql);
}
-export function runQuery(db, sql, params = [], fetchAll) {
+export function runQuery(
+ db: unknown,
+ sql: string,
+ params?: string[],
+ fetchAll?: false,
+): { changes: unknown };
+export function runQuery(
+ db: unknown,
+ sql: string,
+ params: string[],
+ fetchAll: true,
+): unknown[];
+export function runQuery(db, sql, params = [], fetchAll = false) {
if (params) {
verifyParamTypes(sql, params);
}
@@ -138,7 +150,7 @@ export async function asyncTransaction(db, fn) {
}
}
-export async function openDatabase(pathOrBuffer) {
+export async function openDatabase(pathOrBuffer?: string | Buffer) {
if (pathOrBuffer) {
if (typeof pathOrBuffer !== 'string') {
return new SQL.Database(pathOrBuffer);
@@ -147,13 +159,17 @@ export async function openDatabase(pathOrBuffer) {
let path = pathOrBuffer;
if (path !== ':memory:') {
if (typeof SharedArrayBuffer === 'undefined') {
+ // @ts-expect-error FS missing in sql.js types
let stream = SQL.FS.open(SQL.FS.readlink(path), 'a+');
await stream.node.contents.readIfFallback();
+ // @ts-expect-error FS missing in sql.js types
SQL.FS.close(stream);
}
let db = new SQL.Database(
+ // @ts-expect-error FS missing in sql.js types
path.includes('/blocked') ? path : SQL.FS.readlink(path),
+ // @ts-expect-error 2nd argument missed in sql.js types
{ filename: true },
);
db.exec(`
diff --git a/packages/loot-core/src/platform/uuid/index.d.ts b/packages/loot-core/src/platform/uuid/index.d.ts
new file mode 100644
index 0000000000..f990539567
--- /dev/null
+++ b/packages/loot-core/src/platform/uuid/index.d.ts
@@ -0,0 +1,2 @@
+export function v4(): Promise<string>;
+export function v4Sync(): string;
diff --git a/packages/loot-core/src/platform/uuid/index.electron.ts b/packages/loot-core/src/platform/uuid/index.electron.ts
new file mode 100644
index 0000000000..beb846a813
--- /dev/null
+++ b/packages/loot-core/src/platform/uuid/index.electron.ts
@@ -0,0 +1,11 @@
+const _uuid = require('uuid');
+
+module.exports = {
+ v4: function () {
+ return Promise.resolve(_uuid.v4());
+ },
+
+ v4Sync: function () {
+ return _uuid.v4();
+ },
+};
diff --git a/packages/loot-core/src/platform/uuid/index.testing.js b/packages/loot-core/src/platform/uuid/index.testing.ts
similarity index 100%
rename from packages/loot-core/src/platform/uuid/index.testing.js
rename to packages/loot-core/src/platform/uuid/index.testing.ts
diff --git a/packages/loot-core/src/platform/uuid/index.web.js b/packages/loot-core/src/platform/uuid/index.web.js
deleted file mode 100644
index 633da75631..0000000000
--- a/packages/loot-core/src/platform/uuid/index.web.js
+++ /dev/null
@@ -1,11 +0,0 @@
-const uuid = require('uuid');
-
-module.exports = {
- v4: function () {
- return Promise.resolve(uuid.v4());
- },
-
- v4Sync: function () {
- return uuid.v4();
- },
-};
diff --git a/packages/loot-core/src/platform/uuid/index.electron.js b/packages/loot-core/src/platform/uuid/index.web.ts
similarity index 100%
rename from packages/loot-core/src/platform/uuid/index.electron.js
rename to packages/loot-core/src/platform/uuid/index.web.ts
diff --git a/packages/loot-core/src/server/encryption.js b/packages/loot-core/src/server/encryption.js
index 85502e8a16..1e1926d517 100644
--- a/packages/loot-core/src/server/encryption.js
+++ b/packages/loot-core/src/server/encryption.js
@@ -1,6 +1,6 @@
import * as internals from './encryption-internals';
-let uuid = require('../platform/uuid/index.electron.js');
+let uuid = require('../platform/uuid');
// A map of all possible master encryption keys to use, keyed by
// unique id
diff --git a/packages/loot-core/src/shared/__snapshots__/months.test.js.snap b/packages/loot-core/src/shared/__snapshots__/months.test.ts.snap
similarity index 100%
rename from packages/loot-core/src/shared/__snapshots__/months.test.js.snap
rename to packages/loot-core/src/shared/__snapshots__/months.test.ts.snap
diff --git a/packages/loot-core/src/shared/accounts.js b/packages/loot-core/src/shared/accounts.ts
similarity index 100%
rename from packages/loot-core/src/shared/accounts.js
rename to packages/loot-core/src/shared/accounts.ts
diff --git a/packages/loot-core/src/shared/arithmetic.test.js b/packages/loot-core/src/shared/arithmetic.test.ts
similarity index 100%
rename from packages/loot-core/src/shared/arithmetic.test.js
rename to packages/loot-core/src/shared/arithmetic.test.ts
diff --git a/packages/loot-core/src/shared/arithmetic.js b/packages/loot-core/src/shared/arithmetic.ts
similarity index 100%
rename from packages/loot-core/src/shared/arithmetic.js
rename to packages/loot-core/src/shared/arithmetic.ts
diff --git a/packages/loot-core/src/shared/async.test.js b/packages/loot-core/src/shared/async.test.ts
similarity index 98%
rename from packages/loot-core/src/shared/async.test.js
rename to packages/loot-core/src/shared/async.test.ts
index 1bafca0c45..3f545b5da7 100644
--- a/packages/loot-core/src/shared/async.test.js
+++ b/packages/loot-core/src/shared/async.test.ts
@@ -5,7 +5,7 @@ function timeout(n) {
}
function makeFunction(data) {
- return async function fn(n, { throwError } = {}) {
+ return async function fn(n, { throwError = false } = {}) {
data.push(n);
await timeout(10);
diff --git a/packages/loot-core/src/shared/async.js b/packages/loot-core/src/shared/async.ts
similarity index 100%
rename from packages/loot-core/src/shared/async.js
rename to packages/loot-core/src/shared/async.ts
diff --git a/packages/loot-core/src/shared/categories.js b/packages/loot-core/src/shared/categories.ts
similarity index 100%
rename from packages/loot-core/src/shared/categories.js
rename to packages/loot-core/src/shared/categories.ts
diff --git a/packages/loot-core/src/shared/environment.js b/packages/loot-core/src/shared/environment.ts
similarity index 100%
rename from packages/loot-core/src/shared/environment.js
rename to packages/loot-core/src/shared/environment.ts
diff --git a/packages/loot-core/src/shared/errors.js b/packages/loot-core/src/shared/errors.ts
similarity index 100%
rename from packages/loot-core/src/shared/errors.js
rename to packages/loot-core/src/shared/errors.ts
diff --git a/packages/loot-core/src/shared/months.test.js b/packages/loot-core/src/shared/months.test.ts
similarity index 100%
rename from packages/loot-core/src/shared/months.test.js
rename to packages/loot-core/src/shared/months.test.ts
diff --git a/packages/loot-core/src/shared/months.js b/packages/loot-core/src/shared/months.ts
similarity index 98%
rename from packages/loot-core/src/shared/months.js
rename to packages/loot-core/src/shared/months.ts
index 4f2cdd6805..5132c0dccf 100644
--- a/packages/loot-core/src/shared/months.js
+++ b/packages/loot-core/src/shared/months.ts
@@ -1,7 +1,7 @@
import * as d from 'date-fns';
import memoizeOne from 'memoize-one';
-function _parse(value) {
+function _parse(value: string | Date) {
if (typeof value === 'string') {
// Dates are hard. We just want to deal with months in the format
// 2020-01 and days in the format 2020-01-01, but life is never
@@ -140,7 +140,7 @@ export function bounds(month) {
};
}
-export function _range(start, end, inclusive) {
+export function _range(start, end, inclusive = false) {
const months = [];
let month = monthFromDate(start);
while (d.isBefore(_parse(month), _parse(end))) {
@@ -163,7 +163,7 @@ export function rangeInclusive(start, end) {
return _range(start, end, true);
}
-export function _dayRange(start, end, inclusive) {
+export function _dayRange(start, end, inclusive = false) {
const days = [];
let day = start;
while (d.isBefore(_parse(day), _parse(end))) {
diff --git a/packages/loot-core/src/shared/query.js b/packages/loot-core/src/shared/query.ts
similarity index 87%
rename from packages/loot-core/src/shared/query.js
rename to packages/loot-core/src/shared/query.ts
index ad564dc725..e7a54db285 100644
--- a/packages/loot-core/src/shared/query.js
+++ b/packages/loot-core/src/shared/query.ts
@@ -1,4 +1,19 @@
+type QueryState = {
+ filterExpressions: Array<unknown>;
+ selectExpressions: Array<unknown>;
+ groupExpressions: Array<unknown>;
+ orderExpressions: Array<unknown>;
+ calculation: boolean;
+ rawMode: boolean;
+ withDead: boolean;
+ validateRefs: boolean;
+ limit: number | null;
+ offset: number | null;
+};
+
export class Query {
+ state: QueryState;
+
constructor(state) {
this.state = {
filterExpressions: state.filterExpressions || [],
@@ -32,7 +47,7 @@ export class Query {
});
}
- select(exprs = []) {
+ select(exprs: Array<unknown> | unknown = []) {
if (!Array.isArray(exprs)) {
exprs = [exprs];
}
diff --git a/packages/loot-core/src/shared/rules.js b/packages/loot-core/src/shared/rules.ts
similarity index 100%
rename from packages/loot-core/src/shared/rules.js
rename to packages/loot-core/src/shared/rules.ts
diff --git a/packages/loot-core/src/shared/schedules.test.js b/packages/loot-core/src/shared/schedules.test.ts
similarity index 100%
rename from packages/loot-core/src/shared/schedules.test.js
rename to packages/loot-core/src/shared/schedules.test.ts
diff --git a/packages/loot-core/src/shared/schedules.js b/packages/loot-core/src/shared/schedules.ts
similarity index 96%
rename from packages/loot-core/src/shared/schedules.js
rename to packages/loot-core/src/shared/schedules.ts
index 182236b481..62f5c6736b 100644
--- a/packages/loot-core/src/shared/schedules.js
+++ b/packages/loot-core/src/shared/schedules.ts
@@ -100,7 +100,7 @@ export function getRecurringDescription(config) {
let strs = [];
let uniqueDays = new Set(patterns.map(p => p.type));
- let isSameDay = uniqueDays.length === 1 && !uniqueDays.has('day');
+ let isSameDay = uniqueDays.size === 1 && !uniqueDays.has('day');
for (let pattern of patterns) {
if (pattern.type === 'day') {
@@ -151,8 +151,15 @@ export function getRecurringDescription(config) {
}
}
+type RecurringSchedule = {
+ start: Date;
+ frequency: string;
+ byHourOfDay: number[];
+ interval?: unknown;
+};
+
export function recurConfigToRSchedule(config) {
- let base = {
+ let base: RecurringSchedule = {
start: monthUtils.parseDate(config.start),
frequency: config.frequency.toUpperCase(),
byHourOfDay: [12],
diff --git a/packages/loot-core/src/shared/test-helpers.js b/packages/loot-core/src/shared/test-helpers.ts
similarity index 100%
rename from packages/loot-core/src/shared/test-helpers.js
rename to packages/loot-core/src/shared/test-helpers.ts
diff --git a/packages/loot-core/src/shared/transactions.js b/packages/loot-core/src/shared/transactions.ts
similarity index 100%
rename from packages/loot-core/src/shared/transactions.js
rename to packages/loot-core/src/shared/transactions.ts
diff --git a/packages/loot-core/src/shared/util.test.js b/packages/loot-core/src/shared/util.test.ts
similarity index 85%
rename from packages/loot-core/src/shared/util.test.js
rename to packages/loot-core/src/shared/util.test.ts
index afe3b3d7c5..c8160f102d 100644
--- a/packages/loot-core/src/shared/util.test.js
+++ b/packages/loot-core/src/shared/util.test.ts
@@ -37,31 +37,31 @@ describe('utility functions', () => {
test('number formatting works with comma-dot format', () => {
setNumberFormat({ format: 'comma-dot', hideFraction: false });
let formatter = getNumberFormat().formatter;
- expect(formatter.format('1234.56')).toBe('1,234.56');
+ expect(formatter.format(Number('1234.56'))).toBe('1,234.56');
setNumberFormat({ format: 'comma-dot', hideFraction: true });
formatter = getNumberFormat().formatter;
- expect(formatter.format('1234.56')).toBe('1,235');
+ expect(formatter.format(Number('1234.56'))).toBe('1,235');
});
test('number formatting works with dot-comma format', () => {
setNumberFormat({ format: 'dot-comma', hideFraction: false });
let formatter = getNumberFormat().formatter;
- expect(formatter.format('1234.56')).toBe('1.234,56');
+ expect(formatter.format(Number('1234.56'))).toBe('1.234,56');
setNumberFormat({ format: 'dot-comma', hideFraction: true });
formatter = getNumberFormat().formatter;
- expect(formatter.format('1234.56')).toBe('1.235');
+ expect(formatter.format(Number('1234.56'))).toBe('1.235');
});
test('number formatting works with space-comma format', () => {
setNumberFormat({ format: 'space-comma', hideFraction: false });
let formatter = getNumberFormat().formatter;
// grouping separator space char is a non-breaking space, or UTF-16 \xa0
- expect(formatter.format('1234.56')).toBe('1\xa0234,56');
+ expect(formatter.format(Number('1234.56'))).toBe('1\xa0234,56');
setNumberFormat({ format: 'space-comma', hideFraction: true });
formatter = getNumberFormat().formatter;
- expect(formatter.format('1234.56')).toBe('1\xa0235');
+ expect(formatter.format(Number('1234.56'))).toBe('1\xa0235');
});
});
diff --git a/packages/loot-core/src/shared/util.ts b/packages/loot-core/src/shared/util.ts
index 053bde20d7..9506ee207c 100644
--- a/packages/loot-core/src/shared/util.ts
+++ b/packages/loot-core/src/shared/util.ts
@@ -30,7 +30,7 @@ export function shallowEqual(a, b) {
return true;
}
- var numKeysA = 0,
+ let numKeysA = 0,
numKeysB = 0,
key;
for (key in b) {
@@ -66,7 +66,7 @@ export function getChangedValues(obj1, obj2) {
export function hasFieldsChanged(obj1, obj2, fields) {
let changed = false;
- for (var i = 0; i < fields.length; i++) {
+ for (let i = 0; i < fields.length; i++) {
let field = fields[i];
if (obj1[field] !== obj2[field]) {
changed = true;
diff --git a/upcoming-release-notes/841.md b/upcoming-release-notes/841.md
new file mode 100644
index 0000000000..5351d07222
--- /dev/null
+++ b/upcoming-release-notes/841.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [albertogasparin]
+---
+
+Initial migration of loot-core to Typescript
diff --git a/yarn.lock b/yarn.lock
index 801647326e..ea5c258286 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3871,6 +3871,13 @@ __metadata:
languageName: node
linkType: hard
+"@types/emscripten@npm:*":
+ version: 1.39.6
+ resolution: "@types/emscripten@npm:1.39.6"
+ checksum: 437f2f9cdfd9057255662508fa9a415fe704ba484c6198f3549c5b05feebcdcd612b1ec7b10026d2566935d05d3c36f9366087cb42bc90bd25772a88fcfc9343
+ languageName: node
+ linkType: hard
+
"@types/eslint-scope@npm:^3.7.3":
version: 3.7.4
resolution: "@types/eslint-scope@npm:3.7.4"
@@ -4031,6 +4038,16 @@ __metadata:
languageName: node
linkType: hard
+"@types/jlongster__sql.js@npm:@types/sql.js@latest":
+ version: 1.4.4
+ resolution: "@types/sql.js@npm:1.4.4"
+ dependencies:
+ "@types/emscripten": "*"
+ "@types/node": "*"
+ checksum: c71928d76b59e4899da4b137a4f1bbf8cc0cf198928efa183bba90880ae69331da23a99175b88a7f5eaa34ce9ebef8f94dd1dcca8e4abdac2abb560d860e6636
+ languageName: node
+ linkType: hard
+
"@types/json-schema@npm:*, @types/json-schema@npm:^7.0.4, @types/json-schema@npm:^7.0.5, @types/json-schema@npm:^7.0.8, @types/json-schema@npm:^7.0.9":
version: 7.0.11
resolution: "@types/json-schema@npm:7.0.11"
@@ -13654,6 +13671,7 @@ __metadata:
"@rschedule/json-tools": ^1.2.0
"@rschedule/standard-date-adapter": ^1.2.0
"@types/jest": ^27.5.0
+ "@types/jlongster__sql.js": "npm:@types/sql.js@latest"
"@types/webpack": ^5.28.0
absurd-sql: 0.0.53
adm-zip: ^0.5.9