A local-first personal finance app
:recycle: (typescript) converted indexeddb to strict TS (#4672)
Matiss Janis Aboltinsaf03477d3a59
diff --git a/packages/loot-core/package.json b/packages/loot-core/package.jsonindex dc7006695d..051fe97689 100644--- a/packages/loot-core/package.json+++ b/packages/loot-core/package.json@@ -120,7 +120,6 @@"./platform/server/connection": "./src/platform/server/connection/index.ts","./platform/server/fetch": "./src/platform/server/fetch/index.web.ts","./platform/server/fs": "./src/platform/server/fs/index.web.ts",- "./platform/server/indexeddb": "./src/platform/server/indexeddb/index.web.ts","./platform/server/log": "./src/platform/server/log/index.web.ts","./platform/server/sqlite": "./src/platform/server/sqlite/index.web.ts","./server/budget/types/*": "./src/server/budget/types/*.d.ts",diff --git a/packages/loot-core/src/platform/server/asyncStorage/index.ts b/packages/loot-core/src/platform/server/asyncStorage/index.tsindex 792f3282aa..94ce316a46 100644--- a/packages/loot-core/src/platform/server/asyncStorage/index.ts+++ b/packages/loot-core/src/platform/server/asyncStorage/index.ts@@ -21,6 +21,7 @@ export const getItem: T.GetItem = async function (key) {return new Promise((resolve, reject) => {const req = objectStore.get(key);req.onerror = e => reject(e);+ // @ts-expect-error fix mereq.onsuccess = e => resolve(e.target.result);commit(transaction);});@@ -67,6 +68,7 @@ export async function multiGet<K extends readonly (keyof GlobalPrefsJson)[]>(return new Promise<[string, string]>((resolve, reject) => {const req = objectStore.get(key);req.onerror = e => reject(e);+ // @ts-expect-error fix mereq.onsuccess = e => resolve([key, e.target.result]);});}),diff --git a/packages/loot-core/src/platform/server/fs/index.web.ts b/packages/loot-core/src/platform/server/fs/index.web.tsindex 0d29988852..e42ab0f9fa 100644--- a/packages/loot-core/src/platform/server/fs/index.web.ts+++ b/packages/loot-core/src/platform/server/fs/index.web.ts@@ -246,6 +246,7 @@ export const populateFileHeirarchy = async function () {const { store } = idb.getStore(await idb.getDatabase(), 'files');const req = store.getAllKeys();const paths: string[] = await new Promise((resolve, reject) => {+ // @ts-expect-error fix mereq.onsuccess = e => resolve(e.target.result);req.onerror = e => reject(e);});diff --git a/packages/loot-core/src/platform/server/indexeddb/index.d.ts b/packages/loot-core/src/platform/server/indexeddb/index.d.tsdeleted file mode 100644index 46421c1a1f..0000000000--- a/packages/loot-core/src/platform/server/indexeddb/index.d.ts+++ /dev/null@@ -1,24 +0,0 @@-export function getDatabase();-export type GetDatabase = typeof getDatabase;--export function openDatabase();-export type OpenDatabase = typeof openDatabase;--export function closeDatabase();-export type CloseDatabase = typeof closeDatabase;--export function getStore(db: IDBDatabase, name: string);-export type GetStore = typeof getStore;--export function get(- store: IDBObjectStore,- key: IDBValidKey | IDBKeyRange,- mapper?: (v: unknown) => unknown,-);-export type Get = typeof get;--export function set(store: IDBObjectStore, value: unknown);-export type Set = typeof set;--export function del(store: IDBObjectStore, key: IDBValidKey);-export type Del = typeof del;diff --git a/packages/loot-core/src/platform/server/indexeddb/index.js b/packages/loot-core/src/platform/server/indexeddb/index.jsdeleted file mode 100644index e69de29bb2..0000000000diff --git a/packages/loot-core/src/platform/server/indexeddb/index.ts b/packages/loot-core/src/platform/server/indexeddb/index.tsnew file mode 100644index 0000000000..1d5062ed04--- /dev/null+++ b/packages/loot-core/src/platform/server/indexeddb/index.ts@@ -0,0 +1,113 @@+let openedDb: null | ReturnType<typeof _openDatabase> = _openDatabase();++// The web version uses IndexedDB to store data+function _openDatabase() {+ return new Promise<IDBDatabase>((resolve, reject) => {+ const dbVersion = 9;+ const openRequest = indexedDB.open('actual', dbVersion);++ openRequest.onupgradeneeded = function (e) {+ const db = (e.target as IDBOpenDBRequest).result;++ // Remove old stores+ if (db.objectStoreNames.contains('filesystem')) {+ db.deleteObjectStore('filesystem');+ }+ if (db.objectStoreNames.contains('messages')) {+ db.deleteObjectStore('messages');+ }++ // Create new stores+ if (!db.objectStoreNames.contains('asyncStorage')) {+ db.createObjectStore('asyncStorage');+ }+ if (!db.objectStoreNames.contains('files')) {+ db.createObjectStore('files', { keyPath: 'filepath' });+ }+ };++ openRequest.onblocked = e => console.log('blocked', e);++ openRequest.onerror = () => {+ console.log('openRequest error');+ reject(new Error('indexeddb-failure: Could not open IndexedDB'));+ };++ openRequest.onsuccess = function (e) {+ const db = (e.target as IDBOpenDBRequest).result;++ db.onversionchange = () => {+ // TODO: Notify the user somehow+ db.close();+ };++ db.onerror = function (event) {+ const error = (event.target as IDBOpenDBRequest)?.error;+ console.log('Database error: ' + error);++ if (event.target && error) {+ if (error.name === 'QuotaExceededError') {+ throw new Error('indexeddb-quota-error');+ }+ }+ };+ resolve(db);+ };+ });+}++type Data = { filepath: string; contents: string };++export const getStore = function (db: IDBDatabase, name: string) {+ const trans = db.transaction([name], 'readwrite');+ return { trans, store: trans.objectStore(name) };+};++export const get = async function (+ store: IDBObjectStore,+ key: IDBValidKey | IDBKeyRange,+) {+ return new Promise<Data>((resolve, reject) => {+ const req = store.get(key);+ req.onsuccess = () => {+ resolve(req.result);+ };+ req.onerror = e => reject(e);+ });+};++export const set = async function (store: IDBObjectStore, item: Data) {+ return new Promise((resolve, reject) => {+ const req = store.put(item);+ req.onsuccess = () => resolve(undefined);+ req.onerror = e => reject(e);+ });+};++export const del = async function (store: IDBObjectStore, key: string) {+ return new Promise((resolve, reject) => {+ const req = store.delete(key);+ req.onsuccess = () => resolve(undefined);+ req.onerror = e => reject(e);+ });+};++export const getDatabase = function () {+ return openedDb;+};++export const openDatabase = function () {+ if (openedDb == null) {+ openedDb = _openDatabase();+ }+ return openedDb;+};++export const closeDatabase = function () {+ if (openedDb) {+ openedDb.then(db => {+ db.close();+ });+ openedDb = null;+ }+};diff --git a/packages/loot-core/src/platform/server/indexeddb/index.web.ts b/packages/loot-core/src/platform/server/indexeddb/index.web.tsdeleted file mode 100644index f739654549..0000000000--- a/packages/loot-core/src/platform/server/indexeddb/index.web.ts+++ /dev/null@@ -1,147 +0,0 @@-// @ts-strict-ignore-import type * as T from '.';--let openedDb = _openDatabase();--// The web version uses IndexedDB to store data-function _openDatabase() {- return new Promise((resolve, reject) => {- const dbVersion = 9;- const openRequest = indexedDB.open('actual', dbVersion);-- openRequest.onupgradeneeded = function (e) {- // @ts-expect-error EventTarget needs refinement- const 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' });- }-- // Create new stores- if (!db.objectStoreNames.contains('asyncStorage')) {- db.createObjectStore('asyncStorage');- }- if (!db.objectStoreNames.contains('files')) {- db.createObjectStore('files', { keyPath: 'filepath' });- }- };-- openRequest.onblocked = e => console.log('blocked', e);-- openRequest.onerror = () => {- console.log('openRequest error');- reject(new Error('indexeddb-failure: Could not open IndexedDB'));- };-- openRequest.onsuccess = function (e) {- // @ts-expect-error EventTarget needs refinement- const db = e.target.result;-- db.onversionchange = () => {- // TODO: Notify the user somehow- db.close();- };-- db.onerror = function (event) {- console.log('Database error: ' + (event.target && event.target.error));-- if (event.target && event.target.error) {- const e = event.target.error;- if (e.name === 'QuotaExceededError') {- // Don't try to get the sized used -- too brittle. Is there- // a better way to do it?- //- // async function run() {- // let transaction = db.transaction(['asyncStorage'], 'readonly');- // let objectStore = transaction.objectStore('filesystem');-- // let files = await new Promise((resolve, reject) => {- // let req = objectStore.getAll();- // req.onerror = e => reject(e);- // req.onsuccess = e => resolve(e.target.result);- // });-- // console.log('files', files.length);- // for (let file of files) {- // console.log(file.filepath, file.contents.length);- // }-- // transaction = db.transaction(['files'], 'readonly');- // objectStore = transaction.objectStore('messages');-- // let messages = await new Promise((resolve, reject) => {- // let req = objectStore.getAll();- // req.onerror = e => reject(e);- // req.onsuccess = e => resolve(e.target.result);- // });-- // console.log('messages', messages.length);- // console.log('message bytes', JSON.stringify(messages).length);- // }-- throw new Error('indexeddb-quota-error');- }- }- };- resolve(db);- };- });-}--export const getStore: T.GetStore = function (db, name) {- const trans = db.transaction([name], 'readwrite');- return { trans, store: trans.objectStore(name) };-};--export const get: T.Get = async function (store, key, mapper = x => x) {- return new Promise((resolve, reject) => {- const req = store.get(key);- req.onsuccess = () => {- resolve(mapper(req.result));- };- req.onerror = e => reject(e);- });-};--export const set: T.Set = async function (store, item) {- return new Promise((resolve, reject) => {- const req = store.put(item);- req.onsuccess = () => resolve(undefined);- req.onerror = e => reject(e);- });-};--export const del: T.Del = async function (store, key) {- return new Promise((resolve, reject) => {- const req = store.delete(key);- req.onsuccess = () => resolve(undefined);- req.onerror = e => reject(e);- });-};--export const getDatabase: T.GetDatabase = function () {- return openedDb;-};--export const openDatabase: T.OpenDatabase = function () {- if (openedDb == null) {- openedDb = _openDatabase();- }- return openedDb;-};--export const closeDatabase: T.CloseDatabase = function () {- if (openedDb) {- openedDb.then(db => {- // @ts-expect-error db type needs refinement- db.close();- });- openedDb = null;- }-};diff --git a/upcoming-release-notes/4672.md b/upcoming-release-notes/4672.mdnew file mode 100644index 0000000000..afdc52ff43--- /dev/null+++ b/upcoming-release-notes/4672.md@@ -0,0 +1,6 @@+---+category: Maintenance+authors: [MatissJanis]+---++Converted indexeddb files to strict TypeScript.