@xylabs/indexed-db 4.4.32 → 4.4.34

package/src/withDb.ts

@@ -1,12 +1,58 @@
+import type { Logger } from '@xylabs/logger'
 import type { EmptyObject } from '@xylabs/object'
-import type { DBSchema, IDBPDatabase } from 'idb'
+import type {
+  DBSchema, IDBPDatabase, StoreNames,
+} from 'idb'
 import { openDB } from 'idb'
 
-export async function withDb<T extends DBSchema = DBSchema, R = EmptyObject>(
+import { checkDbNeedsUpgrade } from './checkDbNeedsUpgrade.ts'
+import { createStoreDuringUpgrade } from './createStoreDuringUpgrade.ts'
+import { buildStandardIndexName, type IndexDescription } from './IndexDescription.ts'
+
+export async function withDb<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(
   dbName: string,
-  callback: (db: IDBPDatabase<T>) => Promise<R> | R,
+  callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R,
+  expectedIndexes?: Record<string, IndexDescription[]>,
+  logger?: Logger,
 ): Promise<R> {
-  const db = await openDB<T>(dbName)
+  const versionToOpen = expectedIndexes === undefined ? undefined : await checkDbNeedsUpgrade(dbName, expectedIndexes, logger)
+  const db = await openDB<DBTypes>(dbName, versionToOpen, {
+    blocked(currentVersion, blockedVersion, event) {
+      logger?.warn(`IndexedDb: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)
+    },
+    blocking(currentVersion, blockedVersion, event) {
+      logger?.warn(`IndexedDb: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)
+    },
+    terminated() {
+      logger?.log('IndexedDb: Terminated')
+    },
+    upgrade(db, oldVersion, newVersion, transaction) {
+      if (oldVersion !== newVersion) {
+        logger?.log(`IndexedDb: Upgrading from ${oldVersion} to ${newVersion}`)
+        const objectStores = transaction.objectStoreNames
+        for (const name of objectStores) {
+          try {
+            db.deleteObjectStore(name)
+          } catch {
+            console.log(`IndexedDb: Failed to delete existing object store ${name}`)
+          }
+        }
+      }
+      if (expectedIndexes) {
+        for (const [storeName, indexes] of Object.entries(expectedIndexes)) {
+          if (db.objectStoreNames.contains(storeName as StoreNames<DBTypes>)) {
+            continue
+          }
+          const indexesToCreate = indexes.map(idx => ({
+            ...idx,
+            name: buildStandardIndexName(idx),
+            // eslint-disable-next-line unicorn/no-array-reduce
+          })).reduce((acc, idx) => acc.set(idx.name, idx), new Map<string, IndexDescription>()).values()
+          createStoreDuringUpgrade(db, storeName as StoreNames<DBTypes>, [...indexesToCreate], logger)
+        }
+      }
+    },
+  })
   try {
     return await callback(db)
   } finally {

package/src/withReadOnlyStore.ts

@@ -1,20 +1,17 @@
+import type { Logger } from '@xylabs/logger'
 import type { EmptyObject } from '@xylabs/object'
 import type {
   IDBPDatabase, IDBPObjectStore, StoreNames,
 } from 'idb'
 
 import type { ObjectStore } from './ObjectStore.ts'
+import { withStore } from './withStore.ts'
 
 export async function withReadOnlyStore<T extends EmptyObject = EmptyObject, R = T>(
   db: IDBPDatabase<ObjectStore<T>>,
   storeName: StoreNames<ObjectStore<T>>,
-  callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, string>) => Promise<R> | R,
+  callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readonly'> | null) => Promise<R> | R,
+  logger?: Logger,
 ): Promise<R> {
-  const transaction = db.transaction(storeName, 'readonly')
-  const store = transaction.objectStore(storeName)
-  try {
-    return await callback(store)
-  } finally {
-    await transaction.done
-  }
+  return await withStore(db, storeName, callback, 'readonly', logger)
 }

package/src/withReadWriteStore.ts

@@ -1,20 +1,17 @@
+import type { Logger } from '@xylabs/logger'
 import type { EmptyObject } from '@xylabs/object'
 import type {
   IDBPDatabase, IDBPObjectStore, StoreNames,
 } from 'idb'
 
 import type { ObjectStore } from './ObjectStore.ts'
+import { withStore } from './withStore.ts'
 
 export async function withReadWriteStore<T extends EmptyObject = EmptyObject, R = T>(
   db: IDBPDatabase<ObjectStore<T>>,
   storeName: StoreNames<ObjectStore<T>>,
-  callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, string>) => Promise<R> | R,
+  callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readwrite'> | null) => Promise<R> | R,
+  logger?: Logger,
 ): Promise<R> {
-  const transaction = db.transaction(storeName, 'readwrite')
-  const store = transaction.objectStore(storeName)
-  try {
-    return await callback(store)
-  } finally {
-    await transaction.done
-  }
+  return await withStore(db, storeName, callback, 'readwrite', logger)
 }

package/src/withStore.ts

@@ -0,0 +1,34 @@
+import type { Logger } from '@xylabs/logger'
+import type { EmptyObject } from '@xylabs/object'
+import type {
+  IDBPDatabase, IDBPObjectStore, IDBPTransaction, StoreNames,
+} from 'idb'
+
+import type { ObjectStore } from './ObjectStore.ts'
+
+export async function withStore<T extends EmptyObject = EmptyObject, R = T, M extends 'readonly' | 'readwrite' = 'readonly'>(
+  db: IDBPDatabase<ObjectStore<T>>,
+  storeName: StoreNames<ObjectStore<T>>,
+  callback: (store: IDBPObjectStore<ObjectStore<T>,
+    [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, M> | null) => Promise<R> | R,
+  mode: M,
+  logger?: Logger,
+): Promise<R> {
+  logger?.log('withStore', storeName, mode)
+  let transaction: IDBPTransaction<ObjectStore<T>, [StoreNames<ObjectStore<T>>], M> | undefined = undefined
+  logger?.log('withStore:transaction')
+  let store = null
+  try {
+    transaction = db.transaction(storeName, mode)
+    // we do this in a try/catch because the store might not exist
+    store = transaction.objectStore(storeName)
+  } catch (ex) {
+    logger?.log('withStore:catch', ex)
+  }
+  try {
+    return await callback(store)
+  } finally {
+    logger?.log('withStore:finally')
+    await transaction?.done
+  }
+}

package/xy.config.ts

@@ -1,9 +1,9 @@
 import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
 const config: XyTsupConfig = {
   compile: {
-    browser: {},
+    browser: { src: true },
     neutral: { src: true },
-    node: {},
+    node: { src: true },
   },
 }
 

package/dist/neutral/createStore.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createStore.d.ts","sourceRoot":"","sources":["../../src/createStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EACV,YAAY,EAAc,UAAU,EACrC,MAAM,KAAK,CAAA;AAEZ,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,wBAAgB,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAC7D,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAChC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EACrC,OAAO,EAAE,gBAAgB,EAAE,EAC3B,MAAM,CAAC,EAAE,MAAM,QAoBhB"}