@xylabs/indexed-db 4.4.32 → 4.4.34

package/dist/node/index.mjs

@@ -0,0 +1,233 @@
+// src/checkDbNeedsUpgrade.ts
+import { exists } from "@xylabs/exists";
+
+// src/withDb.ts
+import { openDB } from "idb";
+
+// src/IndexDescription.ts
+var IndexSeparator = "-";
+var buildStandardIndexName = (index) => {
+  const { key, unique } = index;
+  const prefix = unique ? "UX" : "IX";
+  const indexKeys = Object.keys(key);
+  return `${prefix}_${indexKeys.join(IndexSeparator)}`;
+};
+
+// src/createStoreDuringUpgrade.ts
+function createStoreDuringUpgrade(db, storeName, indexes, logger) {
+  logger?.log(`Creating store ${storeName}`);
+  let store;
+  try {
+    store = db.createObjectStore(storeName, {
+      // If it isn't explicitly set, create a value by auto incrementing.
+      autoIncrement: true
+    });
+  } catch {
+    logger?.warn(`Failed to create store: ${storeName} already exists`);
+    return;
+  }
+  logger?.log(`Creating store: created ${storeName}`);
+  store.name = storeName;
+  for (const {
+    key,
+    multiEntry,
+    unique
+  } of indexes) {
+    logger?.log(`Creating store: index ${key}`);
+    const indexKeys = Object.keys(key);
+    const keys = indexKeys.length === 1 ? indexKeys[0] : indexKeys;
+    const indexName = buildStandardIndexName({ key, unique });
+    console.log("createIndex", indexName, keys, { multiEntry, unique });
+    store.createIndex(indexName, keys, { multiEntry, unique });
+  }
+}
+
+// src/withDb.ts
+async function withDb(dbName, callback, expectedIndexes, logger) {
+  const versionToOpen = expectedIndexes === void 0 ? void 0 : await checkDbNeedsUpgrade(dbName, expectedIndexes, logger);
+  const db = await openDB(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(db2, oldVersion, newVersion, transaction) {
+      if (oldVersion !== newVersion) {
+        logger?.log(`IndexedDb: Upgrading from ${oldVersion} to ${newVersion}`);
+        const objectStores = transaction.objectStoreNames;
+        for (const name of objectStores) {
+          try {
+            db2.deleteObjectStore(name);
+          } catch {
+            console.log(`IndexedDb: Failed to delete existing object store ${name}`);
+          }
+        }
+      }
+      if (expectedIndexes) {
+        for (const [storeName, indexes] of Object.entries(expectedIndexes)) {
+          if (db2.objectStoreNames.contains(storeName)) {
+            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), /* @__PURE__ */ new Map()).values();
+          createStoreDuringUpgrade(db2, storeName, [...indexesToCreate], logger);
+        }
+      }
+    }
+  });
+  try {
+    return await callback(db);
+  } finally {
+    db.close();
+  }
+}
+
+// src/withStore.ts
+async function withStore(db, storeName, callback, mode, logger) {
+  logger?.log("withStore", storeName, mode);
+  let transaction = void 0;
+  logger?.log("withStore:transaction");
+  let store = null;
+  try {
+    transaction = db.transaction(storeName, mode);
+    store = transaction.objectStore(storeName);
+  } catch (ex) {
+    logger?.log("withStore:catch", ex);
+  }
+  try {
+    return await callback(store);
+  } finally {
+    logger?.log("withStore:finally");
+    await transaction?.done;
+  }
+}
+
+// src/withReadOnlyStore.ts
+async function withReadOnlyStore(db, storeName, callback, logger) {
+  return await withStore(db, storeName, callback, "readonly", logger);
+}
+
+// src/getExistingIndexes.ts
+async function getExistingIndexesInternal(db, storeName, logger) {
+  logger?.log("getExistingIndexesInternal", storeName);
+  return await withReadOnlyStore(db, storeName, (store) => {
+    return store ? [...store.indexNames].map((indexName) => {
+      const index = store.index(indexName);
+      const key = {};
+      if (Array.isArray(index.keyPath)) {
+        for (const keyPath of index.keyPath) {
+          key[keyPath] = 1;
+        }
+      } else {
+        key[index.keyPath] = 1;
+      }
+      const desc = {
+        key,
+        unique: index.unique,
+        multiEntry: index.multiEntry
+      };
+      return desc;
+    }) : null;
+  }, logger);
+}
+async function getExistingIndexes(db, storeName, logger) {
+  logger?.log("getExistingIndexes", storeName);
+  if (typeof db === "string") {
+    return await withDb(db, async (db2) => {
+      return await getExistingIndexesInternal(db2, storeName, logger);
+    });
+  }
+  return await getExistingIndexesInternal(db, storeName, logger);
+}
+
+// src/checkDbNeedsUpgrade.ts
+async function checkStoreNeedsUpgrade(db, storeName, indexes, logger) {
+  logger?.log("checkStoreNeedsUpgrade", storeName, indexes);
+  const existingIndexes = await getExistingIndexes(db, storeName, logger);
+  if (existingIndexes === null) {
+    return true;
+  }
+  const existingIndexNames = new Set(existingIndexes.map(({ key, unique }) => buildStandardIndexName({ key, unique })).filter(exists));
+  for (const { key, unique } of indexes) {
+    const indexName = buildStandardIndexName({ key, unique });
+    if (!existingIndexNames.has(indexName)) {
+      return true;
+    }
+  }
+  return false;
+}
+async function checkDbNeedsUpgrade(dbName, stores, logger) {
+  logger?.log("checkDbNeedsUpgrade", dbName, stores);
+  return await withDb(dbName, async (db) => {
+    for (const [storeName, indexes] of Object.entries(stores)) {
+      if (await checkStoreNeedsUpgrade(db, storeName, indexes, logger)) {
+        return db.version + 1;
+      }
+    }
+    return db.version;
+  });
+}
+
+// src/IndexedDbKeyValueStore.ts
+var IndexedDbKeyValueStore = class {
+  constructor(dbName, storeName) {
+    this.dbName = dbName;
+    this.storeName = storeName;
+  }
+  async clear() {
+    return await this.withDb((db) => {
+      return db.clear(this.storeName);
+    });
+  }
+  async delete(key) {
+    return await this.withDb((db) => {
+      return db.delete(this.storeName, key);
+    });
+  }
+  async get(key) {
+    return await this.withDb((db) => {
+      return db.get(this.storeName, key) ?? void 0;
+    });
+  }
+  async keys() {
+    return await this.withDb((db) => {
+      return db.getAllKeys(this.storeName);
+    });
+  }
+  async set(key, value) {
+    return await this.withDb((db) => {
+      return db.put(this.storeName, value, key);
+    });
+  }
+  async withDb(callback) {
+    return await withDb(this.dbName, (db) => {
+      return callback(db);
+    });
+  }
+};
+
+// src/withReadWriteStore.ts
+async function withReadWriteStore(db, storeName, callback, logger) {
+  return await withStore(db, storeName, callback, "readwrite", logger);
+}
+export {
+  IndexSeparator,
+  IndexedDbKeyValueStore,
+  buildStandardIndexName,
+  checkDbNeedsUpgrade,
+  checkStoreNeedsUpgrade,
+  createStoreDuringUpgrade,
+  getExistingIndexes,
+  withDb,
+  withReadOnlyStore,
+  withReadWriteStore,
+  withStore
+};
+//# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/checkDbNeedsUpgrade.ts","../../src/withDb.ts","../../src/IndexDescription.ts","../../src/createStoreDuringUpgrade.ts","../../src/withStore.ts","../../src/withReadOnlyStore.ts","../../src/getExistingIndexes.ts","../../src/IndexedDbKeyValueStore.ts","../../src/withReadWriteStore.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport type { Logger } from '@xylabs/logger'\nimport type { IDBPDatabase } from 'idb'\n\nimport { getExistingIndexes } from './getExistingIndexes.ts'\nimport { buildStandardIndexName, type IndexDescription } from './IndexDescription.ts'\nimport type { ObjectStore } from './ObjectStore.ts'\nimport { withDb } from './withDb.ts'\n\nexport async function checkStoreNeedsUpgrade(db: IDBPDatabase<ObjectStore<object>>, storeName: string, indexes: IndexDescription[], logger?: Logger) {\n  logger?.log('checkStoreNeedsUpgrade', storeName, indexes)\n  const existingIndexes = await getExistingIndexes(db, storeName, logger)\n  if (existingIndexes === null) {\n    // the store does not exist, so we need to trigger upgrade (no existing indexes)\n    return true\n  }\n  const existingIndexNames = new Set(existingIndexes.map(({ key, unique }) => buildStandardIndexName({ key, unique })).filter(exists))\n  for (const { key, unique } of indexes) {\n    const indexName = buildStandardIndexName({ key, unique })\n    if (!existingIndexNames.has(indexName)) {\n      return true\n    }\n  }\n  return false\n}\n\nexport async function checkDbNeedsUpgrade(dbName: string, stores: Record<string, IndexDescription[]>, logger?: Logger) {\n  logger?.log('checkDbNeedsUpgrade', dbName, stores)\n  return await withDb<ObjectStore, number>(dbName, async (db) => {\n    for (const [storeName, indexes] of Object.entries(stores)) {\n      if (await checkStoreNeedsUpgrade(db, storeName, indexes, logger)) {\n        return db.version + 1\n      }\n    }\n    return db.version\n  })\n}\n","import type { Logger } from '@xylabs/logger'\nimport type { EmptyObject } from '@xylabs/object'\nimport type {\n  DBSchema, IDBPDatabase, StoreNames,\n} from 'idb'\nimport { openDB } from 'idb'\n\nimport { checkDbNeedsUpgrade } from './checkDbNeedsUpgrade.ts'\nimport { createStoreDuringUpgrade } from './createStoreDuringUpgrade.ts'\nimport { buildStandardIndexName, type IndexDescription } from './IndexDescription.ts'\n\nexport async function withDb<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(\n  dbName: string,\n  callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R,\n  expectedIndexes?: Record<string, IndexDescription[]>,\n  logger?: Logger,\n): Promise<R> {\n  const versionToOpen = expectedIndexes === undefined ? undefined : await checkDbNeedsUpgrade(dbName, expectedIndexes, logger)\n  const db = await openDB<DBTypes>(dbName, versionToOpen, {\n    blocked(currentVersion, blockedVersion, event) {\n      logger?.warn(`IndexedDb: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)\n    },\n    blocking(currentVersion, blockedVersion, event) {\n      logger?.warn(`IndexedDb: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)\n    },\n    terminated() {\n      logger?.log('IndexedDb: Terminated')\n    },\n    upgrade(db, oldVersion, newVersion, transaction) {\n      if (oldVersion !== newVersion) {\n        logger?.log(`IndexedDb: Upgrading from ${oldVersion} to ${newVersion}`)\n        const objectStores = transaction.objectStoreNames\n        for (const name of objectStores) {\n          try {\n            db.deleteObjectStore(name)\n          } catch {\n            console.log(`IndexedDb: Failed to delete existing object store ${name}`)\n          }\n        }\n      }\n      if (expectedIndexes) {\n        for (const [storeName, indexes] of Object.entries(expectedIndexes)) {\n          if (db.objectStoreNames.contains(storeName as StoreNames<DBTypes>)) {\n            continue\n          }\n          const indexesToCreate = indexes.map(idx => ({\n            ...idx,\n            name: buildStandardIndexName(idx),\n            // eslint-disable-next-line unicorn/no-array-reduce\n          })).reduce((acc, idx) => acc.set(idx.name, idx), new Map<string, IndexDescription>()).values()\n          createStoreDuringUpgrade(db, storeName as StoreNames<DBTypes>, [...indexesToCreate], logger)\n        }\n      }\n    },\n  })\n  try {\n    return await callback(db)\n  } finally {\n    db.close()\n  }\n}\n","/**\n * The index direction (1 for ascending, -1 for descending)\n */\nexport type IndexDirection = -1 | 1\n\n/**\n * Description of index(es) to be created on a store\n */\nexport type IndexDescription = {\n  /**\n   * The key(s) to index\n   */\n  key: Record<string, IndexDirection>\n  /**\n   * Is the indexed value an array\n   */\n  multiEntry?: boolean\n  /**\n   * If true, the index must enforce uniqueness on the key\n   */\n  unique?: boolean\n}\n\nexport const IndexSeparator = '-'\n\n/**\n * Given an index description, this will build the index\n * name in standard form\n * @param index The index description\n * @returns The index name in standard form\n */\nexport const buildStandardIndexName = (index: IndexDescription) => {\n  const { key, unique } = index\n  const prefix = unique ? 'UX' : 'IX'\n  const indexKeys = Object.keys(key)\n  return `${prefix}_${indexKeys.join(IndexSeparator)}`\n}\n","import type { Logger } from '@xylabs/logger'\nimport type {\n  DBSchema,\n  IDBPDatabase, IDBPObjectStore, IndexNames, StoreNames,\n} from 'idb'\n\nimport {\n  buildStandardIndexName,\n  type IndexDescription,\n} from './IndexDescription.ts'\n\nexport function createStoreDuringUpgrade<DBTypes extends DBSchema | unknown = unknown>(\n  db: IDBPDatabase<DBTypes>,\n  storeName: StoreNames<DBTypes>,\n  indexes: IndexDescription[],\n  logger?: Logger,\n) {\n  logger?.log(`Creating store ${storeName}`)\n  // Create the store\n  let store: IDBPObjectStore<DBTypes, ArrayLike<StoreNames<DBTypes>>, StoreNames<DBTypes>, 'versionchange'> | undefined\n  try {\n    store = db.createObjectStore(storeName, {\n    // If it isn't explicitly set, create a value by auto incrementing.\n      autoIncrement: true,\n    })\n  } catch {\n    logger?.warn(`Failed to create store: ${storeName} already exists`)\n    return\n  }\n  logger?.log(`Creating store: created ${storeName}`)\n  // Name the store\n  store.name = storeName\n  // Create an index on the hash\n  for (const {\n    key, multiEntry, unique,\n  } of indexes) {\n    logger?.log(`Creating store: index ${key}`)\n    const indexKeys = Object.keys(key)\n    const keys = indexKeys.length === 1 ? indexKeys[0] : indexKeys\n    const indexName = buildStandardIndexName({ key, unique }) as IndexNames<DBTypes, StoreNames<DBTypes>>\n    console.log('createIndex', indexName, keys, { multiEntry, unique })\n    store.createIndex(indexName, keys, { multiEntry, unique })\n  }\n}\n","import type { Logger } from '@xylabs/logger'\nimport type { EmptyObject } from '@xylabs/object'\nimport type {\n  IDBPDatabase, IDBPObjectStore, IDBPTransaction, StoreNames,\n} from 'idb'\n\nimport type { ObjectStore } from './ObjectStore.ts'\n\nexport async function withStore<T extends EmptyObject = EmptyObject, R = T, M extends 'readonly' | 'readwrite' = 'readonly'>(\n  db: IDBPDatabase<ObjectStore<T>>,\n  storeName: StoreNames<ObjectStore<T>>,\n  callback: (store: IDBPObjectStore<ObjectStore<T>,\n    [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, M> | null) => Promise<R> | R,\n  mode: M,\n  logger?: Logger,\n): Promise<R> {\n  logger?.log('withStore', storeName, mode)\n  let transaction: IDBPTransaction<ObjectStore<T>, [StoreNames<ObjectStore<T>>], M> | undefined = undefined\n  logger?.log('withStore:transaction')\n  let store = null\n  try {\n    transaction = db.transaction(storeName, mode)\n    // we do this in a try/catch because the store might not exist\n    store = transaction.objectStore(storeName)\n  } catch (ex) {\n    logger?.log('withStore:catch', ex)\n  }\n  try {\n    return await callback(store)\n  } finally {\n    logger?.log('withStore:finally')\n    await transaction?.done\n  }\n}\n","import type { Logger } from '@xylabs/logger'\nimport type { EmptyObject } from '@xylabs/object'\nimport type {\n  IDBPDatabase, IDBPObjectStore, StoreNames,\n} from 'idb'\n\nimport type { ObjectStore } from './ObjectStore.ts'\nimport { withStore } from './withStore.ts'\n\nexport async function withReadOnlyStore<T extends EmptyObject = EmptyObject, R = T>(\n  db: IDBPDatabase<ObjectStore<T>>,\n  storeName: StoreNames<ObjectStore<T>>,\n  callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readonly'> | null) => Promise<R> | R,\n  logger?: Logger,\n): Promise<R> {\n  return await withStore(db, storeName, callback, 'readonly', logger)\n}\n","import type { Logger } from '@xylabs/logger'\nimport type { EmptyObject } from '@xylabs/object'\nimport type { IDBPDatabase, StoreNames } from 'idb'\n\nimport {\n  type IndexDescription,\n  type IndexDirection,\n} from './IndexDescription.ts'\nimport type { ObjectStore } from './ObjectStore.ts'\nimport { withDb } from './withDb.ts'\nimport { withReadOnlyStore } from './withReadOnlyStore.ts'\n\nasync function getExistingIndexesInternal<T extends EmptyObject = EmptyObject>(\n  db: IDBPDatabase<ObjectStore<T>>,\n  storeName: StoreNames<ObjectStore<T>>,\n  logger?: Logger,\n): Promise<IndexDescription[] | null> {\n  logger?.log('getExistingIndexesInternal', storeName)\n  return await withReadOnlyStore(db, storeName, (store) => {\n    return store\n      ? [...store.indexNames].map((indexName) => {\n          const index = store.index(indexName)\n          const key: Record<string, IndexDirection> = {}\n          if (Array.isArray(index.keyPath)) {\n            for (const keyPath of index.keyPath) {\n              key[keyPath] = 1\n            }\n          } else {\n            key[index.keyPath] = 1\n          }\n          const desc: IndexDescription = {\n            key,\n            unique: index.unique,\n            multiEntry: index.multiEntry,\n          }\n          return desc\n        })\n      : null\n  }, logger)\n}\n\nexport async function getExistingIndexes<T extends EmptyObject = EmptyObject>(\n  db: IDBPDatabase<ObjectStore<T>> | string,\n  storeName: StoreNames<ObjectStore<T>>,\n  logger?: Logger,\n): Promise<IndexDescription[] | null> {\n  logger?.log('getExistingIndexes', storeName)\n  if (typeof db === 'string') {\n    return await withDb<ObjectStore<T>, IndexDescription[] | null>(db, async (db) => {\n      return await getExistingIndexesInternal(db, storeName, logger)\n    })\n  }\n  return await getExistingIndexesInternal(db, storeName, logger)\n}\n","import type { KeyValueStore } from '@xylabs/storage'\nimport type {\n  DBSchema,\n  IDBPDatabase, StoreKey, StoreNames, StoreValue,\n} from 'idb'\n\nimport { withDb } from './withDb.ts'\n\n/**\n * An IndexedDB key/value store.\n */\nexport class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>> implements KeyValueStore<StoreValue<T, S>, StoreKey<T, S>> {\n  constructor(readonly dbName: string, readonly storeName: S) {}\n\n  async clear?(): Promise<void> {\n    return await this.withDb((db) => {\n      return db.clear(this.storeName)\n    })\n  }\n\n  async delete(key: StoreKey<T, S>): Promise<void> {\n    return await this.withDb((db) => {\n      return db.delete(this.storeName, key)\n    })\n  }\n\n  async get(key: StoreKey<T, S>) {\n    return await this.withDb((db) => {\n      return db.get(this.storeName, key) ?? undefined\n    })\n  }\n\n  async keys?(): Promise<StoreKey<T, S>[]> {\n    return await this.withDb((db) => {\n      return db.getAllKeys(this.storeName)\n    })\n  }\n\n  async set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<StoreKey<T, S>> {\n    return await this.withDb((db) => {\n      return db.put(this.storeName, value, key)\n    })\n  }\n\n  async withDb<R = StoreValue<T, S>>(\n    callback: (db: IDBPDatabase<T>) =>\n      Promise<R> | R,\n  ) {\n    return await withDb<T, R>(this.dbName, (db) => {\n      return callback(db)\n    })\n  }\n}\n","import type { Logger } from '@xylabs/logger'\nimport type { EmptyObject } from '@xylabs/object'\nimport type {\n  IDBPDatabase, IDBPObjectStore, StoreNames,\n} from 'idb'\n\nimport type { ObjectStore } from './ObjectStore.ts'\nimport { withStore } from './withStore.ts'\n\nexport async function withReadWriteStore<T extends EmptyObject = EmptyObject, R = T>(\n  db: IDBPDatabase<ObjectStore<T>>,\n  storeName: StoreNames<ObjectStore<T>>,\n  callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readwrite'> | null) => Promise<R> | R,\n  logger?: Logger,\n): Promise<R> {\n  return await withStore(db, storeName, callback, 'readwrite', logger)\n}\n"],"mappings":";AAAA,SAAS,cAAc;;;ACKvB,SAAS,cAAc;;;ACkBhB,IAAM,iBAAiB;AAQvB,IAAM,yBAAyB,CAAC,UAA4B;AACjE,QAAM,EAAE,KAAK,OAAO,IAAI;AACxB,QAAM,SAAS,SAAS,OAAO;AAC/B,QAAM,YAAY,OAAO,KAAK,GAAG;AACjC,SAAO,GAAG,MAAM,IAAI,UAAU,KAAK,cAAc,CAAC;AACpD;;;ACzBO,SAAS,yBACd,IACA,WACA,SACA,QACA;AACA,UAAQ,IAAI,kBAAkB,SAAS,EAAE;AAEzC,MAAI;AACJ,MAAI;AACF,YAAQ,GAAG,kBAAkB,WAAW;AAAA;AAAA,MAEtC,eAAe;AAAA,IACjB,CAAC;AAAA,EACH,QAAQ;AACN,YAAQ,KAAK,2BAA2B,SAAS,iBAAiB;AAClE;AAAA,EACF;AACA,UAAQ,IAAI,2BAA2B,SAAS,EAAE;AAElD,QAAM,OAAO;AAEb,aAAW;AAAA,IACT;AAAA,IAAK;AAAA,IAAY;AAAA,EACnB,KAAK,SAAS;AACZ,YAAQ,IAAI,yBAAyB,GAAG,EAAE;AAC1C,UAAM,YAAY,OAAO,KAAK,GAAG;AACjC,UAAM,OAAO,UAAU,WAAW,IAAI,UAAU,CAAC,IAAI;AACrD,UAAM,YAAY,uBAAuB,EAAE,KAAK,OAAO,CAAC;AACxD,YAAQ,IAAI,eAAe,WAAW,MAAM,EAAE,YAAY,OAAO,CAAC;AAClE,UAAM,YAAY,WAAW,MAAM,EAAE,YAAY,OAAO,CAAC;AAAA,EAC3D;AACF;;;AFhCA,eAAsB,OACpB,QACA,UACA,iBACA,QACY;AACZ,QAAM,gBAAgB,oBAAoB,SAAY,SAAY,MAAM,oBAAoB,QAAQ,iBAAiB,MAAM;AAC3H,QAAM,KAAK,MAAM,OAAgB,QAAQ,eAAe;AAAA,IACtD,QAAQ,gBAAgB,gBAAgB,OAAO;AAC7C,cAAQ,KAAK,0CAA0C,cAAc,OAAO,cAAc,IAAI,KAAK;AAAA,IACrG;AAAA,IACA,SAAS,gBAAgB,gBAAgB,OAAO;AAC9C,cAAQ,KAAK,oCAAoC,cAAc,OAAO,cAAc,IAAI,KAAK;AAAA,IAC/F;AAAA,IACA,aAAa;AACX,cAAQ,IAAI,uBAAuB;AAAA,IACrC;AAAA,IACA,QAAQA,KAAI,YAAY,YAAY,aAAa;AAC/C,UAAI,eAAe,YAAY;AAC7B,gBAAQ,IAAI,6BAA6B,UAAU,OAAO,UAAU,EAAE;AACtE,cAAM,eAAe,YAAY;AACjC,mBAAW,QAAQ,cAAc;AAC/B,cAAI;AACF,YAAAA,IAAG,kBAAkB,IAAI;AAAA,UAC3B,QAAQ;AACN,oBAAQ,IAAI,qDAAqD,IAAI,EAAE;AAAA,UACzE;AAAA,QACF;AAAA,MACF;AACA,UAAI,iBAAiB;AACnB,mBAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,eAAe,GAAG;AAClE,cAAIA,IAAG,iBAAiB,SAAS,SAAgC,GAAG;AAClE;AAAA,UACF;AACA,gBAAM,kBAAkB,QAAQ,IAAI,UAAQ;AAAA,YAC1C,GAAG;AAAA,YACH,MAAM,uBAAuB,GAAG;AAAA;AAAA,UAElC,EAAE,EAAE,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAI,IAAI,MAAM,GAAG,GAAG,oBAAI,IAA8B,CAAC,EAAE,OAAO;AAC7F,mCAAyBA,KAAI,WAAkC,CAAC,GAAG,eAAe,GAAG,MAAM;AAAA,QAC7F;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AACD,MAAI;AACF,WAAO,MAAM,SAAS,EAAE;AAAA,EAC1B,UAAE;AACA,OAAG,MAAM;AAAA,EACX;AACF;;;AGpDA,eAAsB,UACpB,IACA,WACA,UAEA,MACA,QACY;AACZ,UAAQ,IAAI,aAAa,WAAW,IAAI;AACxC,MAAI,cAA4F;AAChG,UAAQ,IAAI,uBAAuB;AACnC,MAAI,QAAQ;AACZ,MAAI;AACF,kBAAc,GAAG,YAAY,WAAW,IAAI;AAE5C,YAAQ,YAAY,YAAY,SAAS;AAAA,EAC3C,SAAS,IAAI;AACX,YAAQ,IAAI,mBAAmB,EAAE;AAAA,EACnC;AACA,MAAI;AACF,WAAO,MAAM,SAAS,KAAK;AAAA,EAC7B,UAAE;AACA,YAAQ,IAAI,mBAAmB;AAC/B,UAAM,aAAa;AAAA,EACrB;AACF;;;ACxBA,eAAsB,kBACpB,IACA,WACA,UACA,QACY;AACZ,SAAO,MAAM,UAAU,IAAI,WAAW,UAAU,YAAY,MAAM;AACpE;;;ACJA,eAAe,2BACb,IACA,WACA,QACoC;AACpC,UAAQ,IAAI,8BAA8B,SAAS;AACnD,SAAO,MAAM,kBAAkB,IAAI,WAAW,CAAC,UAAU;AACvD,WAAO,QACH,CAAC,GAAG,MAAM,UAAU,EAAE,IAAI,CAAC,cAAc;AACvC,YAAM,QAAQ,MAAM,MAAM,SAAS;AACnC,YAAM,MAAsC,CAAC;AAC7C,UAAI,MAAM,QAAQ,MAAM,OAAO,GAAG;AAChC,mBAAW,WAAW,MAAM,SAAS;AACnC,cAAI,OAAO,IAAI;AAAA,QACjB;AAAA,MACF,OAAO;AACL,YAAI,MAAM,OAAO,IAAI;AAAA,MACvB;AACA,YAAM,OAAyB;AAAA,QAC7B;AAAA,QACA,QAAQ,MAAM;AAAA,QACd,YAAY,MAAM;AAAA,MACpB;AACA,aAAO;AAAA,IACT,CAAC,IACD;AAAA,EACN,GAAG,MAAM;AACX;AAEA,eAAsB,mBACpB,IACA,WACA,QACoC;AACpC,UAAQ,IAAI,sBAAsB,SAAS;AAC3C,MAAI,OAAO,OAAO,UAAU;AAC1B,WAAO,MAAM,OAAkD,IAAI,OAAOC,QAAO;AAC/E,aAAO,MAAM,2BAA2BA,KAAI,WAAW,MAAM;AAAA,IAC/D,CAAC;AAAA,EACH;AACA,SAAO,MAAM,2BAA2B,IAAI,WAAW,MAAM;AAC/D;;;AN5CA,eAAsB,uBAAuB,IAAuC,WAAmB,SAA6B,QAAiB;AACnJ,UAAQ,IAAI,0BAA0B,WAAW,OAAO;AACxD,QAAM,kBAAkB,MAAM,mBAAmB,IAAI,WAAW,MAAM;AACtE,MAAI,oBAAoB,MAAM;AAE5B,WAAO;AAAA,EACT;AACA,QAAM,qBAAqB,IAAI,IAAI,gBAAgB,IAAI,CAAC,EAAE,KAAK,OAAO,MAAM,uBAAuB,EAAE,KAAK,OAAO,CAAC,CAAC,EAAE,OAAO,MAAM,CAAC;AACnI,aAAW,EAAE,KAAK,OAAO,KAAK,SAAS;AACrC,UAAM,YAAY,uBAAuB,EAAE,KAAK,OAAO,CAAC;AACxD,QAAI,CAAC,mBAAmB,IAAI,SAAS,GAAG;AACtC,aAAO;AAAA,IACT;AAAA,EACF;AACA,SAAO;AACT;AAEA,eAAsB,oBAAoB,QAAgB,QAA4C,QAAiB;AACrH,UAAQ,IAAI,uBAAuB,QAAQ,MAAM;AACjD,SAAO,MAAM,OAA4B,QAAQ,OAAO,OAAO;AAC7D,eAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,MAAM,GAAG;AACzD,UAAI,MAAM,uBAAuB,IAAI,WAAW,SAAS,MAAM,GAAG;AAChE,eAAO,GAAG,UAAU;AAAA,MACtB;AAAA,IACF;AACA,WAAO,GAAG;AAAA,EACZ,CAAC;AACH;;;AOzBO,IAAM,yBAAN,MAAqI;AAAA,EAC1I,YAAqB,QAAyB,WAAc;AAAvC;AAAyB;AAAA,EAAe;AAAA,EAE7D,MAAM,QAAwB;AAC5B,WAAO,MAAM,KAAK,OAAO,CAAC,OAAO;AAC/B,aAAO,GAAG,MAAM,KAAK,SAAS;AAAA,IAChC,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,OAAO,KAAoC;AAC/C,WAAO,MAAM,KAAK,OAAO,CAAC,OAAO;AAC/B,aAAO,GAAG,OAAO,KAAK,WAAW,GAAG;AAAA,IACtC,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,KAAqB;AAC7B,WAAO,MAAM,KAAK,OAAO,CAAC,OAAO;AAC/B,aAAO,GAAG,IAAI,KAAK,WAAW,GAAG,KAAK;AAAA,IACxC,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,OAAmC;AACvC,WAAO,MAAM,KAAK,OAAO,CAAC,OAAO;AAC/B,aAAO,GAAG,WAAW,KAAK,SAAS;AAAA,IACrC,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,KAAqB,OAAkD;AAC/E,WAAO,MAAM,KAAK,OAAO,CAAC,OAAO;AAC/B,aAAO,GAAG,IAAI,KAAK,WAAW,OAAO,GAAG;AAAA,IAC1C,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,OACJ,UAEA;AACA,WAAO,MAAM,OAAa,KAAK,QAAQ,CAAC,OAAO;AAC7C,aAAO,SAAS,EAAE;AAAA,IACpB,CAAC;AAAA,EACH;AACF;;;AC3CA,eAAsB,mBACpB,IACA,WACA,UACA,QACY;AACZ,SAAO,MAAM,UAAU,IAAI,WAAW,UAAU,aAAa,MAAM;AACrE;","names":["db","db"]}

package/dist/node/withDb.d.ts

@@ -0,0 +1,6 @@
+import type { Logger } from '@xylabs/logger';
+import type { EmptyObject } from '@xylabs/object';
+import type { DBSchema, IDBPDatabase } from 'idb';
+import { type IndexDescription } from './IndexDescription.ts';
+export declare function withDb<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger): Promise<R>;
+//# sourceMappingURL=withDb.d.ts.map

package/dist/node/withDb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withDb.d.ts","sourceRoot":"","sources":["../../src/withDb.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,QAAQ,EAAE,YAAY,EACvB,MAAM,KAAK,CAAA;AAKZ,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAErF,wBAAsB,MAAM,CAAC,OAAO,SAAS,QAAQ,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC,GAAG,WAAW,EACxF,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,CAAC,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EACvD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,EACpD,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,CAAC,CAAC,CA4CZ"}

package/dist/node/withReadOnlyStore.d.ts

@@ -0,0 +1,6 @@
+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';
+export declare 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>>, 'readonly'> | null) => Promise<R> | R, logger?: Logger): Promise<R>;
+//# sourceMappingURL=withReadOnlyStore.d.ts.map

package/dist/node/withReadOnlyStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withReadOnlyStore.d.ts","sourceRoot":"","sources":["../../src/withReadOnlyStore.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,EAAE,eAAe,EAAE,UAAU,EAC1C,MAAM,KAAK,CAAA;AAEZ,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAGnD,wBAAsB,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,CAAC,GAAG,CAAC,EAChF,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAChC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EACrC,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EACjJ,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,CAAC,CAAC,CAEZ"}

package/dist/node/withReadWriteStore.d.ts

@@ -0,0 +1,6 @@
+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';
+export declare 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>>, 'readwrite'> | null) => Promise<R> | R, logger?: Logger): Promise<R>;
+//# sourceMappingURL=withReadWriteStore.d.ts.map

package/dist/node/withReadWriteStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withReadWriteStore.d.ts","sourceRoot":"","sources":["../../src/withReadWriteStore.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,EAAE,eAAe,EAAE,UAAU,EAC1C,MAAM,KAAK,CAAA;AAEZ,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAGnD,wBAAsB,kBAAkB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,CAAC,GAAG,CAAC,EACjF,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAChC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EACrC,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAClJ,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,CAAC,CAAC,CAEZ"}

package/dist/node/withStore.d.ts

@@ -0,0 +1,8 @@
+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';
+export declare 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>;
+//# sourceMappingURL=withStore.d.ts.map

package/dist/node/withStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withStore.d.ts","sourceRoot":"","sources":["../../src/withStore.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,EAAE,eAAe,EAAmB,UAAU,EAC3D,MAAM,KAAK,CAAA;AAEZ,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,wBAAsB,SAAS,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,UAAU,GAAG,WAAW,GAAG,UAAU,EACzH,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAChC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EACrC,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,EAC9C;IAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EACxF,IAAI,EAAE,CAAC,EACP,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,CAAC,CAAC,CAkBZ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/indexed-db",
-  "version": "4.4.32",
+  "version": "4.4.34",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "hex",
@@ -28,26 +28,40 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/neutral/index.d.ts",
-      "default": "./dist/neutral/index.mjs"
+      "node": {
+        "types": "./dist/node/index.d.ts",
+        "default": "./dist/node/index.mjs"
+      },
+      "browser": {
+        "types": "./dist/browser/index.d.ts",
+        "default": "./dist/browser/index.mjs"
+      },
+      "neutral": {
+        "types": "./dist/neutral/index.d.ts",
+        "default": "./dist/neutral/index.mjs"
+      }
     },
     "./package.json": "./package.json"
   },
-  "module": "./dist/neutral/index.mjs",
-  "types": "./dist/neutral/index.d.ts",
+  "module": "./dist/browser/index.mjs",
+  "types": "./dist/browser/index.d.ts",
   "workspaces": [
     "packages/**/*"
   ],
   "dependencies": {
-    "@xylabs/logger": "^4.4.32",
-    "@xylabs/object": "^4.4.32",
-    "@xylabs/storage": "^4.4.32",
+    "@xylabs/exists": "^4.4.34",
+    "@xylabs/logger": "^4.4.34",
+    "@xylabs/object": "^4.4.34",
+    "@xylabs/storage": "^4.4.34",
     "idb": "^8.0.1"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^4.2.6",
     "@xylabs/tsconfig": "^4.2.6",
-    "@xylabs/vitest-extended": "^4.4.32",
+    "@xylabs/tsconfig-dom": "^4.2.6",
+    "@xylabs/vitest-extended": "^4.4.34",
+    "fake-indexeddb": "^6.0.0",
+    "jsdom": "^25.0.1",
     "typescript": "^5.7.2",
     "vitest": "^2.1.8"
   },

package/src/IndexDescription.ts

@@ -15,10 +15,6 @@ export type IndexDescription = {
    * Is the indexed value an array
    */
   multiEntry?: boolean
-  /**
-   * The name of the index
-   */
-  name?: string
   /**
    * If true, the index must enforce uniqueness on the key
    */

package/src/IndexedDbKeyValueStore.ts

@@ -18,13 +18,13 @@ export class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>>
     })
   }
 
-  async delete(key: string): Promise<void> {
+  async delete(key: StoreKey<T, S>): Promise<void> {
     return await this.withDb((db) => {
       return db.delete(this.storeName, key)
     })
   }
 
-  async get(key: string) {
+  async get(key: StoreKey<T, S>) {
     return await this.withDb((db) => {
       return db.get(this.storeName, key) ?? undefined
     })
@@ -36,7 +36,7 @@ export class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>>
     })
   }
 
-  async set(key: string, value: StoreValue<T, S>): Promise<void> {
+  async set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<StoreKey<T, S>> {
     return await this.withDb((db) => {
       return db.put(this.storeName, value, key)
     })

package/src/checkDbNeedsUpgrade.ts

@@ -0,0 +1,37 @@
+import { exists } from '@xylabs/exists'
+import type { Logger } from '@xylabs/logger'
+import type { IDBPDatabase } from 'idb'
+
+import { getExistingIndexes } from './getExistingIndexes.ts'
+import { buildStandardIndexName, type IndexDescription } from './IndexDescription.ts'
+import type { ObjectStore } from './ObjectStore.ts'
+import { withDb } from './withDb.ts'
+
+export async function checkStoreNeedsUpgrade(db: IDBPDatabase<ObjectStore<object>>, storeName: string, indexes: IndexDescription[], logger?: Logger) {
+  logger?.log('checkStoreNeedsUpgrade', storeName, indexes)
+  const existingIndexes = await getExistingIndexes(db, storeName, logger)
+  if (existingIndexes === null) {
+    // the store does not exist, so we need to trigger upgrade (no existing indexes)
+    return true
+  }
+  const existingIndexNames = new Set(existingIndexes.map(({ key, unique }) => buildStandardIndexName({ key, unique })).filter(exists))
+  for (const { key, unique } of indexes) {
+    const indexName = buildStandardIndexName({ key, unique })
+    if (!existingIndexNames.has(indexName)) {
+      return true
+    }
+  }
+  return false
+}
+
+export async function checkDbNeedsUpgrade(dbName: string, stores: Record<string, IndexDescription[]>, logger?: Logger) {
+  logger?.log('checkDbNeedsUpgrade', dbName, stores)
+  return await withDb<ObjectStore, number>(dbName, async (db) => {
+    for (const [storeName, indexes] of Object.entries(stores)) {
+      if (await checkStoreNeedsUpgrade(db, storeName, indexes, logger)) {
+        return db.version + 1
+      }
+    }
+    return db.version
+  })
+}

package/src/{createStore.ts → createStoreDuringUpgrade.ts}

@@ -1,36 +1,43 @@
 import type { Logger } from '@xylabs/logger'
-import type { EmptyObject } from '@xylabs/object'
 import type {
-  IDBPDatabase, IndexNames, StoreNames,
+  DBSchema,
+  IDBPDatabase, IDBPObjectStore, IndexNames, StoreNames,
 } from 'idb'
 
 import {
   buildStandardIndexName,
   type IndexDescription,
 } from './IndexDescription.ts'
-import type { ObjectStore } from './ObjectStore.ts'
 
-export function createStore<T extends EmptyObject = EmptyObject>(
-  db: IDBPDatabase<ObjectStore<T>>,
-  storeName: StoreNames<ObjectStore<T>>,
+export function createStoreDuringUpgrade<DBTypes extends DBSchema | unknown = unknown>(
+  db: IDBPDatabase<DBTypes>,
+  storeName: StoreNames<DBTypes>,
   indexes: IndexDescription[],
   logger?: Logger,
 ) {
   logger?.log(`Creating store ${storeName}`)
   // Create the store
-  const store = db.createObjectStore(storeName, {
+  let store: IDBPObjectStore<DBTypes, ArrayLike<StoreNames<DBTypes>>, StoreNames<DBTypes>, 'versionchange'> | undefined
+  try {
+    store = db.createObjectStore(storeName, {
     // If it isn't explicitly set, create a value by auto incrementing.
-    autoIncrement: true,
-  })
+      autoIncrement: true,
+    })
+  } catch {
+    logger?.warn(`Failed to create store: ${storeName} already exists`)
+    return
+  }
+  logger?.log(`Creating store: created ${storeName}`)
   // Name the store
   store.name = storeName
   // Create an index on the hash
   for (const {
     key, multiEntry, unique,
   } of indexes) {
+    logger?.log(`Creating store: index ${key}`)
     const indexKeys = Object.keys(key)
     const keys = indexKeys.length === 1 ? indexKeys[0] : indexKeys
-    const indexName = buildStandardIndexName({ key, unique }) as IndexNames<ObjectStore<T>, StoreNames<ObjectStore<T>>>
+    const indexName = buildStandardIndexName({ key, unique }) as IndexNames<DBTypes, StoreNames<DBTypes>>
     console.log('createIndex', indexName, keys, { multiEntry, unique })
     store.createIndex(indexName, keys, { multiEntry, unique })
   }

package/src/getExistingIndexes.ts

@@ -1,3 +1,4 @@
+import type { Logger } from '@xylabs/logger'
 import type { EmptyObject } from '@xylabs/object'
 import type { IDBPDatabase, StoreNames } from 'idb'
 
@@ -6,30 +7,48 @@ import {
   type IndexDirection,
 } from './IndexDescription.ts'
 import type { ObjectStore } from './ObjectStore.ts'
+import { withDb } from './withDb.ts'
 import { withReadOnlyStore } from './withReadOnlyStore.ts'
 
-export async function getExistingIndexes<T extends EmptyObject = EmptyObject>(
+async function getExistingIndexesInternal<T extends EmptyObject = EmptyObject>(
   db: IDBPDatabase<ObjectStore<T>>,
   storeName: StoreNames<ObjectStore<T>>,
-): Promise<IndexDescription[]> {
+  logger?: Logger,
+): Promise<IndexDescription[] | null> {
+  logger?.log('getExistingIndexesInternal', storeName)
   return await withReadOnlyStore(db, storeName, (store) => {
-    return [...store.indexNames].map((indexName) => {
-      const index = store.index(indexName)
-      const key: Record<string, IndexDirection> = {}
-      if (Array.isArray(index.keyPath)) {
-        for (const keyPath of index.keyPath) {
-          key[keyPath] = 1
-        }
-      } else {
-        key[index.keyPath] = 1
-      }
-      const desc: IndexDescription = {
-        name: indexName as string,
-        key,
-        unique: index.unique,
-        multiEntry: index.multiEntry,
-      }
-      return desc
+    return store
+      ? [...store.indexNames].map((indexName) => {
+          const index = store.index(indexName)
+          const key: Record<string, IndexDirection> = {}
+          if (Array.isArray(index.keyPath)) {
+            for (const keyPath of index.keyPath) {
+              key[keyPath] = 1
+            }
+          } else {
+            key[index.keyPath] = 1
+          }
+          const desc: IndexDescription = {
+            key,
+            unique: index.unique,
+            multiEntry: index.multiEntry,
+          }
+          return desc
+        })
+      : null
+  }, logger)
+}
+
+export async function getExistingIndexes<T extends EmptyObject = EmptyObject>(
+  db: IDBPDatabase<ObjectStore<T>> | string,
+  storeName: StoreNames<ObjectStore<T>>,
+  logger?: Logger,
+): Promise<IndexDescription[] | null> {
+  logger?.log('getExistingIndexes', storeName)
+  if (typeof db === 'string') {
+    return await withDb<ObjectStore<T>, IndexDescription[] | null>(db, async (db) => {
+      return await getExistingIndexesInternal(db, storeName, logger)
     })
-  })
+  }
+  return await getExistingIndexesInternal(db, storeName, logger)
 }

package/src/index.ts

@@ -1,4 +1,5 @@
-export * from './createStore.ts'
+export * from './checkDbNeedsUpgrade.ts'
+export * from './createStoreDuringUpgrade.ts'
 export * from './getExistingIndexes.ts'
 export * from './IndexDescription.ts'
 export * from './IndexedDbKeyValueStore.ts'
@@ -6,3 +7,4 @@ export * from './ObjectStore.ts'
 export * from './withDb.ts'
 export * from './withReadOnlyStore.ts'
 export * from './withReadWriteStore.ts'
+export * from './withStore.ts'