@xylabs/indexed-db 7.0.7 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/README.md +1 -864
  2. package/dist/browser/index.d.ts +1 -11
  3. package/dist/browser/index.d.ts.map +1 -1
  4. package/dist/browser/index.mjs +2 -277
  5. package/dist/browser/index.mjs.map +4 -4
  6. package/dist/browser/model.d.ts +1 -2
  7. package/dist/browser/model.d.ts.map +1 -1
  8. package/dist/browser/model.mjs +2 -0
  9. package/dist/browser/model.mjs.map +3 -3
  10. package/dist/neutral/index.d.ts +1 -11
  11. package/dist/neutral/index.d.ts.map +1 -1
  12. package/dist/neutral/index.mjs +2 -277
  13. package/dist/neutral/index.mjs.map +4 -4
  14. package/dist/neutral/model.d.ts +1 -2
  15. package/dist/neutral/model.d.ts.map +1 -1
  16. package/dist/neutral/model.mjs +2 -0
  17. package/dist/neutral/model.mjs.map +3 -3
  18. package/dist/node/index.d.ts +1 -11
  19. package/dist/node/index.d.ts.map +1 -1
  20. package/dist/node/index.mjs +2 -277
  21. package/dist/node/index.mjs.map +4 -4
  22. package/dist/node/model.d.ts +1 -2
  23. package/dist/node/model.d.ts.map +1 -1
  24. package/dist/node/model.mjs +2 -0
  25. package/dist/node/model.mjs.map +3 -3
  26. package/package.json +7 -12
  27. package/dist/browser/IndexDescription.d.ts +0 -31
  28. package/dist/browser/IndexDescription.d.ts.map +0 -1
  29. package/dist/browser/IndexedDbKeyValueStore.d.ts +0 -40
  30. package/dist/browser/IndexedDbKeyValueStore.d.ts.map +0 -1
  31. package/dist/browser/ObjectStore.d.ts +0 -17
  32. package/dist/browser/ObjectStore.d.ts.map +0 -1
  33. package/dist/browser/checkDbNeedsUpgrade.d.ts +0 -11
  34. package/dist/browser/checkDbNeedsUpgrade.d.ts.map +0 -1
  35. package/dist/browser/checkStoreNeedsUpgrade.d.ts +0 -13
  36. package/dist/browser/checkStoreNeedsUpgrade.d.ts.map +0 -1
  37. package/dist/browser/createStoreDuringUpgrade.d.ts +0 -12
  38. package/dist/browser/createStoreDuringUpgrade.d.ts.map +0 -1
  39. package/dist/browser/dbMutex.d.ts +0 -14
  40. package/dist/browser/dbMutex.d.ts.map +0 -1
  41. package/dist/browser/getExistingIndexes.d.ts +0 -12
  42. package/dist/browser/getExistingIndexes.d.ts.map +0 -1
  43. package/dist/browser/withDb.d.ts +0 -16
  44. package/dist/browser/withDb.d.ts.map +0 -1
  45. package/dist/browser/withDbByVersion.d.ts +0 -17
  46. package/dist/browser/withDbByVersion.d.ts.map +0 -1
  47. package/dist/browser/withReadOnlyStore.d.ts +0 -14
  48. package/dist/browser/withReadOnlyStore.d.ts.map +0 -1
  49. package/dist/browser/withReadWriteStore.d.ts +0 -14
  50. package/dist/browser/withReadWriteStore.d.ts.map +0 -1
  51. package/dist/browser/withStore.d.ts +0 -18
  52. package/dist/browser/withStore.d.ts.map +0 -1
  53. package/dist/neutral/IndexDescription.d.ts +0 -31
  54. package/dist/neutral/IndexDescription.d.ts.map +0 -1
  55. package/dist/neutral/IndexedDbKeyValueStore.d.ts +0 -40
  56. package/dist/neutral/IndexedDbKeyValueStore.d.ts.map +0 -1
  57. package/dist/neutral/ObjectStore.d.ts +0 -17
  58. package/dist/neutral/ObjectStore.d.ts.map +0 -1
  59. package/dist/neutral/checkDbNeedsUpgrade.d.ts +0 -11
  60. package/dist/neutral/checkDbNeedsUpgrade.d.ts.map +0 -1
  61. package/dist/neutral/checkStoreNeedsUpgrade.d.ts +0 -13
  62. package/dist/neutral/checkStoreNeedsUpgrade.d.ts.map +0 -1
  63. package/dist/neutral/createStoreDuringUpgrade.d.ts +0 -12
  64. package/dist/neutral/createStoreDuringUpgrade.d.ts.map +0 -1
  65. package/dist/neutral/dbMutex.d.ts +0 -14
  66. package/dist/neutral/dbMutex.d.ts.map +0 -1
  67. package/dist/neutral/getExistingIndexes.d.ts +0 -12
  68. package/dist/neutral/getExistingIndexes.d.ts.map +0 -1
  69. package/dist/neutral/withDb.d.ts +0 -16
  70. package/dist/neutral/withDb.d.ts.map +0 -1
  71. package/dist/neutral/withDbByVersion.d.ts +0 -17
  72. package/dist/neutral/withDbByVersion.d.ts.map +0 -1
  73. package/dist/neutral/withReadOnlyStore.d.ts +0 -14
  74. package/dist/neutral/withReadOnlyStore.d.ts.map +0 -1
  75. package/dist/neutral/withReadWriteStore.d.ts +0 -14
  76. package/dist/neutral/withReadWriteStore.d.ts.map +0 -1
  77. package/dist/neutral/withStore.d.ts +0 -18
  78. package/dist/neutral/withStore.d.ts.map +0 -1
  79. package/dist/node/IndexDescription.d.ts +0 -31
  80. package/dist/node/IndexDescription.d.ts.map +0 -1
  81. package/dist/node/IndexedDbKeyValueStore.d.ts +0 -40
  82. package/dist/node/IndexedDbKeyValueStore.d.ts.map +0 -1
  83. package/dist/node/ObjectStore.d.ts +0 -17
  84. package/dist/node/ObjectStore.d.ts.map +0 -1
  85. package/dist/node/checkDbNeedsUpgrade.d.ts +0 -11
  86. package/dist/node/checkDbNeedsUpgrade.d.ts.map +0 -1
  87. package/dist/node/checkStoreNeedsUpgrade.d.ts +0 -13
  88. package/dist/node/checkStoreNeedsUpgrade.d.ts.map +0 -1
  89. package/dist/node/createStoreDuringUpgrade.d.ts +0 -12
  90. package/dist/node/createStoreDuringUpgrade.d.ts.map +0 -1
  91. package/dist/node/dbMutex.d.ts +0 -14
  92. package/dist/node/dbMutex.d.ts.map +0 -1
  93. package/dist/node/getExistingIndexes.d.ts +0 -12
  94. package/dist/node/getExistingIndexes.d.ts.map +0 -1
  95. package/dist/node/withDb.d.ts +0 -16
  96. package/dist/node/withDb.d.ts.map +0 -1
  97. package/dist/node/withDbByVersion.d.ts +0 -17
  98. package/dist/node/withDbByVersion.d.ts.map +0 -1
  99. package/dist/node/withReadOnlyStore.d.ts +0 -14
  100. package/dist/node/withReadOnlyStore.d.ts.map +0 -1
  101. package/dist/node/withReadWriteStore.d.ts +0 -14
  102. package/dist/node/withReadWriteStore.d.ts.map +0 -1
  103. package/dist/node/withStore.d.ts +0 -18
  104. package/dist/node/withStore.d.ts.map +0 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../../src/checkStoreNeedsUpgrade.ts", "../../src/withDbByVersion.ts", "../../src/IndexDescription.ts", "../../src/createStoreDuringUpgrade.ts", "../../src/dbMutex.ts", "../../src/withStore.ts", "../../src/withReadOnlyStore.ts", "../../src/getExistingIndexes.ts", "../../src/checkDbNeedsUpgrade.ts", "../../src/withDb.ts", "../../src/IndexedDbKeyValueStore.ts", "../../src/withReadWriteStore.ts"],
4
- "sourcesContent": ["import { exists } from '@xylabs/sdk/exists'\nimport type { Logger } from '@xylabs/sdk/logger'\nimport type { IDBPDatabase } from 'idb'\n\nimport { getExistingIndexes } from './getExistingIndexes.ts'\nimport { buildStandardIndexName, type IndexDescription } from './IndexDescription.ts'\n\n/**\n * Checks whether a store needs an upgrade by comparing its existing indexes against expected indexes.\n * @param db The IndexedDB database instance\n * @param storeName The name of the store to check\n * @param indexes The expected index descriptions\n * @param logger Optional logger for diagnostics\n * @returns True if the store is missing or has missing indexes\n */\nexport async function checkStoreNeedsUpgrade<DBTypes = unknown>(\n db: IDBPDatabase<DBTypes>,\n storeName: string,\n indexes: IndexDescription[],\n logger?: Logger,\n) {\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", "import type { Logger } from '@xylabs/sdk/logger'\nimport type { EmptyObject } from '@xylabs/sdk/object'\nimport type { IDBPDatabase, StoreNames } from 'idb'\nimport { openDB } from 'idb'\n\nimport { createStoreDuringUpgrade } from './createStoreDuringUpgrade.ts'\nimport { withDbLock } from './dbMutex.ts'\nimport { buildStandardIndexName, type IndexDescription } from './IndexDescription.ts'\n\n/**\n * Opens an IndexedDB database at a specific version, handling upgrade events, and passes it to the callback.\n * The database is automatically closed after the callback completes.\n * @param dbName The name of the database to open\n * @param callback Function to execute with the opened database\n * @param version Optional specific version to open (undefined for latest)\n * @param expectedIndexes Optional map of store names to indexes to create during upgrade\n * @param logger Optional logger for diagnostics\n * @param lock Whether to use a mutex to serialize access (defaults to true)\n * @returns The result of the callback\n */\nexport async function withDbByVersion<DBTypes = unknown, R = EmptyObject>(\n dbName: string,\n callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R,\n version?: number,\n expectedIndexes?: Record<string, IndexDescription[]>,\n logger?: Logger,\n lock = true,\n): Promise<R> {\n const db = await withDbLock(dbName, lock, async () => {\n return await openDB<DBTypes>(dbName, version, {\n /* v8 ignore next 2 */\n blocked(currentVersion, blockedVersion, event) {\n logger?.warn(`IndexedDb: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)\n },\n /* v8 ignore next 2 */\n blocking(currentVersion, blockedVersion, event) {\n logger?.warn(`IndexedDb: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)\n },\n /* v8 ignore next 2 */\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 })\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 interface 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\n/** Separator used between key names when building standard index names. */\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 === true ? 'UX' : 'IX'\n const indexKeys = Object.keys(key)\n return `${prefix}_${indexKeys.join(IndexSeparator)}`\n}\n", "import type { Logger } from '@xylabs/sdk/logger'\nimport type {\n IDBPDatabase, IDBPObjectStore, IndexNames, StoreNames,\n} from 'idb'\n\nimport {\n buildStandardIndexName,\n type IndexDescription,\n} from './IndexDescription.ts'\n\n/**\n * Creates an object store with the specified indexes during a version upgrade transaction.\n * @param db The IndexedDB database instance (during upgrade)\n * @param storeName The name of the store to create\n * @param indexes The index descriptions to create on the store\n * @param logger Optional logger for diagnostics\n */\nexport function createStoreDuringUpgrade<DBTypes = unknown>(\n db: IDBPDatabase<DBTypes>,\n storeName: StoreNames<DBTypes>,\n indexes: IndexDescription[],\n logger?: Logger,\n) {\n logger?.log(`Creating store ${String(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: ${String(storeName)} already exists`)\n return\n }\n logger?.log(`Creating store: created ${String(storeName)}`)\n // Name the store\n store.name = String(storeName)\n // Create an index on the hash\n for (const {\n key, multiEntry, unique,\n } of indexes) {\n logger?.log(`Creating store: index ${JSON.stringify(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 logger?.log('createIndex', indexName, keys, { multiEntry, unique })\n store.createIndex(indexName, keys, { multiEntry, unique })\n }\n}\n", "import { Mutex } from 'async-mutex'\n\nconst dbMutexes: Record<string, Mutex> = {}\n\n/**\n * Returns the shared mutex for a database name, creating one if needed.\n * @param dbName The IndexedDB database name\n */\nexport function getDbMutex(dbName: string) {\n dbMutexes[dbName] ??= new Mutex()\n return dbMutexes[dbName]\n}\n\n/**\n * Runs a handler under the shared database mutex when locking is enabled.\n * @param dbName The IndexedDB database name\n * @param lock Whether to acquire the mutex before running the handler\n * @param handler The async function to execute\n */\nexport async function withDbLock<R>(dbName: string, lock: boolean, handler: () => Promise<R>) {\n if (!lock) {\n return await handler()\n }\n return await getDbMutex(dbName).runExclusive(handler)\n}\n", "import type { Logger } from '@xylabs/sdk/logger'\nimport type { EmptyObject } from '@xylabs/sdk/object'\nimport type {\n IDBPDatabase, IDBPObjectStore, IDBPTransaction, StoreNames,\n} from 'idb'\n\nimport type { ObjectStore } from './ObjectStore.ts'\n\n/**\n * Opens a transaction on the specified store with the given mode and passes the store to the callback.\n * If the store does not exist, the callback receives null.\n * @param db The IndexedDB database instance\n * @param storeName The name of the object store to open\n * @param callback Function to execute with the store (or null if it doesn't exist)\n * @param mode The transaction mode ('readonly' or 'readwrite')\n * @param logger Optional logger for diagnostics\n * @returns The result of the callback\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\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/sdk/logger'\nimport type { EmptyObject } from '@xylabs/sdk/object'\nimport type {\n IDBPDatabase, IDBPObjectStore, StoreNames,\n} from 'idb'\n\nimport type { ObjectStore } from './ObjectStore.ts'\nimport { withStore } from './withStore.ts'\n\n/**\n * Opens a read-only transaction on the specified store and passes it to the callback.\n * @param db The IndexedDB database instance\n * @param storeName The name of the object store to open\n * @param callback Function to execute with the read-only store\n * @param logger Optional logger for diagnostics\n * @returns The result of the callback\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/sdk/logger'\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 { withDbByVersion } from './withDbByVersion.ts'\nimport { withReadOnlyStore } from './withReadOnlyStore.ts'\n\nasync function getExistingIndexesInternal<DBTypes = unknown>(\n db: IDBPDatabase<DBTypes>,\n storeName: string,\n logger?: Logger,\n): Promise<IndexDescription[] | null> {\n logger?.log('getExistingIndexesInternal', storeName)\n const typedStoreName = storeName as StoreNames<DBTypes>\n return await withReadOnlyStore(db as unknown as IDBPDatabase<ObjectStore>, typedStoreName as StoreNames<ObjectStore>, (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\n/**\n * Retrieves the existing index descriptions for a store. Accepts either a database instance or a database name.\n * @param db The IndexedDB database instance or database name\n * @param storeName The name of the store to inspect\n * @param logger Optional logger for diagnostics\n * @returns An array of index descriptions, or null if the store does not exist\n */\nexport async function getExistingIndexes<DBTypes = unknown>(\n db: IDBPDatabase<DBTypes> | string,\n storeName: string,\n logger?: Logger,\n): Promise<IndexDescription[] | null> {\n logger?.log('getExistingIndexes', storeName)\n if (typeof db === 'string') {\n return await withDbByVersion<DBTypes, 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 { Logger } from '@xylabs/sdk/logger'\n\nimport { checkStoreNeedsUpgrade } from './checkStoreNeedsUpgrade.ts'\nimport { type IndexDescription } from './IndexDescription.ts'\nimport type { ObjectStore } from './ObjectStore.ts'\nimport { withDbByVersion } from './withDbByVersion.ts'\n\n/**\n * Checks whether any store in the database needs an upgrade and returns the appropriate version number.\n * @param dbName The name of the database to check\n * @param stores Map of store names to their expected index descriptions\n * @param logger Optional logger for diagnostics\n * @returns The version to open (current version + 1 if upgrade needed, otherwise current version)\n */\nexport async function checkDbNeedsUpgrade(\n dbName: string,\n stores: Record<string, IndexDescription[]>,\n logger?: Logger,\n lock = true,\n) {\n logger?.log('checkDbNeedsUpgrade', dbName, stores)\n return await withDbByVersion<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 }, undefined, stores, logger, lock)\n}\n", "import type { Logger } from '@xylabs/sdk/logger'\nimport type { EmptyObject } from '@xylabs/sdk/object'\nimport type { IDBPDatabase } from 'idb'\n\nimport { checkDbNeedsUpgrade } from './checkDbNeedsUpgrade.ts'\nimport { withDbLock } from './dbMutex.ts'\nimport { type IndexDescription } from './IndexDescription.ts'\nimport { withDbByVersion } from './withDbByVersion.ts'\n\n/**\n * Opens an IndexedDB database, automatically upgrading if needed, and passes it to the callback.\n * Uses a mutex to serialize access to the same database by default.\n * @param dbName The name of the database to open\n * @param callback Function to execute with the opened database\n * @param expectedIndexes Optional map of store names to their expected indexes (triggers upgrade check)\n * @param logger Optional logger for diagnostics\n * @param lock Whether to use a mutex to serialize access (defaults to true)\n * @returns The result of the callback\n */\nexport async function withDb<DBTypes = unknown, R = EmptyObject>(\n dbName: string,\n callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R,\n expectedIndexes?: Record<string, IndexDescription[]>,\n logger?: Logger,\n lock = true,\n): Promise<R> {\n return await withDbLock(dbName, lock, async () => {\n const versionToOpen = expectedIndexes === undefined ? undefined : await checkDbNeedsUpgrade(dbName, expectedIndexes, logger, false)\n return await withDbByVersion<DBTypes, R>(dbName, async (db) => {\n return await callback(db)\n }, versionToOpen, expectedIndexes, logger, false)\n })\n}\n", "import type { KeyValueStore } from '@xylabs/sdk/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 /** The name of the IndexedDB database. */\n readonly dbName: string\n /** The name of the object store within the database. */\n readonly storeName: S\n\n constructor(dbName: string, storeName: S) {\n this.dbName = dbName\n this.storeName = storeName\n }\n\n /** Removes all entries from the store. */\n async clear?(): Promise<void> {\n return await this.withDb((db) => {\n return db.clear(this.storeName)\n })\n }\n\n /**\n * Deletes the entry with the given key.\n * @param key The key of the entry to delete\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 /**\n * Retrieves the value associated with the given key.\n * @param key The key to look up\n * @returns The value, or undefined if not found\n */\n async get(key: StoreKey<T, S>) {\n return await this.withDb((db) => {\n /* v8 ignore start */\n return db.get(this.storeName, key) ?? undefined\n /* v8 ignore stop */\n })\n }\n\n /** Returns all keys in the store. */\n async keys?(): Promise<StoreKey<T, S>[]> {\n return await this.withDb((db) => {\n return db.getAllKeys(this.storeName)\n })\n }\n\n /**\n * Sets a value for the given key, creating or updating the entry.\n * @param key The key to set\n * @param value The value to store\n */\n async set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void> {\n return await this.withDb(async (db) => {\n await db.put(this.storeName, value, key)\n })\n }\n\n /**\n * Opens the underlying IndexedDB database and passes it to the callback.\n * @param callback Function to execute with the database\n * @returns The result of the callback\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/sdk/logger'\nimport type { EmptyObject } from '@xylabs/sdk/object'\nimport type {\n IDBPDatabase, IDBPObjectStore, StoreNames,\n} from 'idb'\n\nimport type { ObjectStore } from './ObjectStore.ts'\nimport { withStore } from './withStore.ts'\n\n/**\n * Opens a read-write transaction on the specified store and passes it to the callback.\n * @param db The IndexedDB database instance\n * @param storeName The name of the object store to open\n * @param callback Function to execute with the read-write store\n * @param logger Optional logger for diagnostics\n * @returns The result of the callback\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"],
5
- "mappings": ";AAAA,SAAS,cAAc;;;ACGvB,SAAS,cAAc;;;ACqBhB,IAAM,iBAAiB;AAQvB,IAAM,yBAAyB,CAAC,UAA4B;AACjE,QAAM,EAAE,KAAK,OAAO,IAAI;AACxB,QAAM,SAAS,WAAW,OAAO,OAAO;AACxC,QAAM,YAAY,OAAO,KAAK,GAAG;AACjC,SAAO,GAAG,MAAM,IAAI,UAAU,KAAK,cAAc,CAAC;AACpD;;;ACpBO,SAAS,yBACd,IACA,WACA,SACA,QACA;AACA,UAAQ,IAAI,kBAAkB,OAAO,SAAS,CAAC,EAAE;AAEjD,MAAI;AACJ,MAAI;AACF,YAAQ,GAAG,kBAAkB,WAAW;AAAA;AAAA,MAEtC,eAAe;AAAA,IACjB,CAAC;AAAA,EACH,QAAQ;AACN,YAAQ,KAAK,2BAA2B,OAAO,SAAS,CAAC,iBAAiB;AAC1E;AAAA,EACF;AACA,UAAQ,IAAI,2BAA2B,OAAO,SAAS,CAAC,EAAE;AAE1D,QAAM,OAAO,OAAO,SAAS;AAE7B,aAAW;AAAA,IACT;AAAA,IAAK;AAAA,IAAY;AAAA,EACnB,KAAK,SAAS;AACZ,YAAQ,IAAI,yBAAyB,KAAK,UAAU,GAAG,CAAC,EAAE;AAC1D,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;;;ACjDA,SAAS,aAAa;AAEtB,IAAM,YAAmC,CAAC;AAMnC,SAAS,WAAW,QAAgB;AACzC,YAAU,MAAM,MAAM,IAAI,MAAM;AAChC,SAAO,UAAU,MAAM;AACzB;AAQA,eAAsB,WAAc,QAAgB,MAAe,SAA2B;AAC5F,MAAI,CAAC,MAAM;AACT,WAAO,MAAM,QAAQ;AAAA,EACvB;AACA,SAAO,MAAM,WAAW,MAAM,EAAE,aAAa,OAAO;AACtD;;;AHJA,eAAsB,gBACpB,QACA,UACA,SACA,iBACA,QACA,OAAO,MACK;AACZ,QAAM,KAAK,MAAM,WAAW,QAAQ,MAAM,YAAY;AACpD,WAAO,MAAM,OAAgB,QAAQ,SAAS;AAAA;AAAA,MAE5C,QAAQ,gBAAgB,gBAAgB,OAAO;AAC7C,gBAAQ,KAAK,0CAA0C,cAAc,OAAO,cAAc,IAAI,KAAK;AAAA,MACrG;AAAA;AAAA,MAEA,SAAS,gBAAgB,gBAAgB,OAAO;AAC9C,gBAAQ,KAAK,oCAAoC,cAAc,OAAO,cAAc,IAAI,KAAK;AAAA,MAC/F;AAAA;AAAA,MAEA,aAAa;AACX,gBAAQ,IAAI,uBAAuB;AAAA,MACrC;AAAA,MACA,QAAQA,KAAI,aAAa,aAAa,cAAc;AAYlD,YAAI,iBAAiB;AACnB,qBAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,eAAe,GAAG;AAClE,gBAAIA,IAAG,iBAAiB,SAAS,SAAgC,GAAG;AAClE;AAAA,YACF;AACA,kBAAM,kBAAkB,QAAQ,IAAI,UAAQ;AAAA,cAC1C,GAAG;AAAA,cACH,MAAM,uBAAuB,GAAG;AAAA;AAAA,YAElC,EAAE,EAAE,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAI,IAAI,MAAM,GAAG,GAAG,oBAAI,IAA8B,CAAC,EAAE,OAAO;AAC7F,qCAAyBA,KAAI,WAAkC,CAAC,GAAG,eAAe,GAAG,MAAM;AAAA,UAC7F;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACD,MAAI;AACF,WAAO,MAAM,SAAS,EAAE;AAAA,EAC1B,UAAE;AACA,OAAG,MAAM;AAAA,EACX;AACF;;;AIzDA,eAAsB,UACpB,IACA,WACA,UAEA,MACA,QACY;AACZ,UAAQ,IAAI,aAAa,WAAW,IAAI;AACxC,MAAI;AACJ,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;;;AC1BA,eAAsB,kBACpB,IACA,WACA,UACA,QACY;AACZ,SAAO,MAAM,UAAU,IAAI,WAAW,UAAU,YAAY,MAAM;AACpE;;;ACbA,eAAe,2BACb,IACA,WACA,QACoC;AACpC,UAAQ,IAAI,8BAA8B,SAAS;AACnD,QAAM,iBAAiB;AACvB,SAAO,MAAM,kBAAkB,IAA4C,gBAA2C,CAAC,UAAU;AAC/H,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;AASA,eAAsB,mBACpB,IACA,WACA,QACoC;AACpC,UAAQ,IAAI,sBAAsB,SAAS;AAC3C,MAAI,OAAO,OAAO,UAAU;AAC1B,WAAO,MAAM,gBAAoD,IAAI,OAAOC,QAAO;AACjF,aAAO,MAAM,2BAA2BA,KAAI,WAAW,MAAM;AAAA,IAC/D,CAAC;AAAA,EACH;AACA,SAAO,MAAM,2BAA2B,IAAI,WAAW,MAAM;AAC/D;;;AP7CA,eAAsB,uBACpB,IACA,WACA,SACA,QACA;AACA,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;;;AQrBA,eAAsB,oBACpB,QACA,QACA,QACA,OAAO,MACP;AACA,UAAQ,IAAI,uBAAuB,QAAQ,MAAM;AACjD,SAAO,MAAM,gBAAqC,QAAQ,OAAO,OAAO;AACtE,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,GAAG,QAAW,QAAQ,QAAQ,IAAI;AACpC;;;ACVA,eAAsB,OACpB,QACA,UACA,iBACA,QACA,OAAO,MACK;AACZ,SAAO,MAAM,WAAW,QAAQ,MAAM,YAAY;AAChD,UAAM,gBAAgB,oBAAoB,SAAY,SAAY,MAAM,oBAAoB,QAAQ,iBAAiB,QAAQ,KAAK;AAClI,WAAO,MAAM,gBAA4B,QAAQ,OAAO,OAAO;AAC7D,aAAO,MAAM,SAAS,EAAE;AAAA,IAC1B,GAAG,eAAe,iBAAiB,QAAQ,KAAK;AAAA,EAClD,CAAC;AACH;;;ACrBO,IAAM,yBAAN,MAAqI;AAAA;AAAA,EAEjI;AAAA;AAAA,EAEA;AAAA,EAET,YAAY,QAAgB,WAAc;AACxC,SAAK,SAAS;AACd,SAAK,YAAY;AAAA,EACnB;AAAA;AAAA,EAGA,MAAM,QAAwB;AAC5B,WAAO,MAAM,KAAK,OAAO,CAAC,OAAO;AAC/B,aAAO,GAAG,MAAM,KAAK,SAAS;AAAA,IAChC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,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;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAAqB;AAC7B,WAAO,MAAM,KAAK,OAAO,CAAC,OAAO;AAE/B,aAAO,GAAG,IAAI,KAAK,WAAW,GAAG,KAAK;AAAA,IAExC,CAAC;AAAA,EACH;AAAA;AAAA,EAGA,MAAM,OAAmC;AACvC,WAAO,MAAM,KAAK,OAAO,CAAC,OAAO;AAC/B,aAAO,GAAG,WAAW,KAAK,SAAS;AAAA,IACrC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAAqB,OAAwC;AACrE,WAAO,MAAM,KAAK,OAAO,OAAO,OAAO;AACrC,YAAM,GAAG,IAAI,KAAK,WAAW,OAAO,GAAG;AAAA,IACzC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,OACJ,UAEA;AACA,WAAO,MAAM,OAAa,KAAK,QAAQ,CAAC,OAAO;AAC7C,aAAO,SAAS,EAAE;AAAA,IACpB,CAAC;AAAA,EACH;AACF;;;AClEA,eAAsB,mBACpB,IACA,WACA,UACA,QACY;AACZ,SAAO,MAAM,UAAU,IAAI,WAAW,UAAU,aAAa,MAAM;AACrE;",
6
- "names": ["db", "db"]
3
+ "sources": ["../../src/index.ts"],
4
+ "sourcesContent": ["export * from '@ariestools/indexed-db'\n"],
5
+ "mappings": ";AAAA,cAAc;",
6
+ "names": []
7
7
  }
@@ -1,3 +1,2 @@
1
- export type { IndexDescription, IndexDirection, } from './IndexDescription.ts';
2
- export type * from './ObjectStore.ts';
1
+ export * from '@ariestools/indexed-db/model';
3
2
  //# sourceMappingURL=model.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/model.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gBAAgB,EAChB,cAAc,GACf,MAAM,uBAAuB,CAAA;AAC9B,mBAAmB,kBAAkB,CAAA"}
1
+ {"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/model.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAA"}
@@ -1 +1,3 @@
1
+ // src/model.ts
2
+ export * from "@ariestools/indexed-db/model";
1
3
  //# sourceMappingURL=model.mjs.map
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": [],
4
- "sourcesContent": [],
5
- "mappings": "",
3
+ "sources": ["../../src/model.ts"],
4
+ "sourcesContent": ["export * from '@ariestools/indexed-db/model'\n"],
5
+ "mappings": ";AAAA,cAAc;",
6
6
  "names": []
7
7
  }
package/package.json CHANGED
@@ -1,13 +1,11 @@
1
1
  {
2
2
  "name": "@xylabs/indexed-db",
3
- "version": "7.0.7",
4
- "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
3
+ "version": "8.0.0",
4
+ "description": "DEPRECATED use @ariestools/indexed-db. Backward-compatibility re-export shim.",
5
5
  "keywords": [
6
- "hex",
7
6
  "xylabs",
8
- "utility",
9
- "typescript",
10
- "esm"
7
+ "deprecated",
8
+ "shim"
11
9
  ],
12
10
  "homepage": "https://xylabs.com",
13
11
  "bugs": {
@@ -65,23 +63,19 @@
65
63
  "README.md"
66
64
  ],
67
65
  "dependencies": {
68
- "@xylabs/sdk": "~7.0.7"
66
+ "@ariestools/indexed-db": "~8.0.0"
69
67
  },
70
68
  "devDependencies": {
71
69
  "@opentelemetry/api": "~1.9.1",
72
70
  "@opentelemetry/sdk-trace-base": "~2.9.0",
73
71
  "@xylabs/toolchain": "~8.6.2",
74
72
  "@xylabs/tsconfig": "~8.6.2",
75
- "@xylabs/tsconfig-dom": "~8.6.2",
76
73
  "async-mutex": "~0.5.0",
77
74
  "browserslist": "~4.28.4",
78
75
  "eslint": "~10.6.0",
79
76
  "eslint-import-resolver-typescript": "~4.4.5",
80
- "fake-indexeddb": "~6.2.5",
81
77
  "idb": "~8.0.3",
82
78
  "typescript": "~6.0.3",
83
- "vite": "~8.1.3",
84
- "vitest": "~4.1.9",
85
79
  "zod": "~4.4.3"
86
80
  },
87
81
  "peerDependencies": {
@@ -96,5 +90,6 @@
96
90
  },
97
91
  "publishConfig": {
98
92
  "access": "public"
99
- }
93
+ },
94
+ "deprecated": "Use @ariestools/indexed-db instead. @xylabs/indexed-db is a compatibility shim only and will not receive further updates."
100
95
  }
@@ -1,31 +0,0 @@
1
- /**
2
- * The index direction (1 for ascending, -1 for descending)
3
- */
4
- export type IndexDirection = -1 | 1;
5
- /**
6
- * Description of index(es) to be created on a store
7
- */
8
- export interface IndexDescription {
9
- /**
10
- * The key(s) to index
11
- */
12
- key: Record<string, IndexDirection>;
13
- /**
14
- * Is the indexed value an array
15
- */
16
- multiEntry?: boolean;
17
- /**
18
- * If true, the index must enforce uniqueness on the key
19
- */
20
- unique?: boolean;
21
- }
22
- /** Separator used between key names when building standard index names. */
23
- export declare const IndexSeparator = "-";
24
- /**
25
- * Given an index description, this will build the index
26
- * name in standard form
27
- * @param index The index description
28
- * @returns The index name in standard form
29
- */
30
- export declare const buildStandardIndexName: (index: IndexDescription) => string;
31
- //# sourceMappingURL=IndexDescription.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"IndexDescription.d.ts","sourceRoot":"","sources":["../../src/IndexDescription.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAEnC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,2EAA2E;AAC3E,eAAO,MAAM,cAAc,MAAM,CAAA;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GAAI,OAAO,gBAAgB,WAK7D,CAAA"}
@@ -1,40 +0,0 @@
1
- import type { KeyValueStore } from '@xylabs/sdk/storage';
2
- import type { DBSchema, IDBPDatabase, StoreKey, StoreNames, StoreValue } from 'idb';
3
- /**
4
- * An IndexedDB key/value store.
5
- */
6
- export declare class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>> implements KeyValueStore<StoreValue<T, S>, StoreKey<T, S>> {
7
- /** The name of the IndexedDB database. */
8
- readonly dbName: string;
9
- /** The name of the object store within the database. */
10
- readonly storeName: S;
11
- constructor(dbName: string, storeName: S);
12
- /** Removes all entries from the store. */
13
- clear?(): Promise<void>;
14
- /**
15
- * Deletes the entry with the given key.
16
- * @param key The key of the entry to delete
17
- */
18
- delete(key: StoreKey<T, S>): Promise<void>;
19
- /**
20
- * Retrieves the value associated with the given key.
21
- * @param key The key to look up
22
- * @returns The value, or undefined if not found
23
- */
24
- get(key: StoreKey<T, S>): Promise<StoreValue<T, S> | undefined>;
25
- /** Returns all keys in the store. */
26
- keys?(): Promise<StoreKey<T, S>[]>;
27
- /**
28
- * Sets a value for the given key, creating or updating the entry.
29
- * @param key The key to set
30
- * @param value The value to store
31
- */
32
- set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void>;
33
- /**
34
- * Opens the underlying IndexedDB database and passes it to the callback.
35
- * @param callback Function to execute with the database
36
- * @returns The result of the callback
37
- */
38
- withDb<R = StoreValue<T, S>>(callback: (db: IDBPDatabase<T>) => Promise<R> | R): Promise<R>;
39
- }
40
- //# sourceMappingURL=IndexedDbKeyValueStore.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"IndexedDbKeyValueStore.d.ts","sourceRoot":"","sources":["../../src/IndexedDbKeyValueStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAC/C,MAAM,KAAK,CAAA;AAIZ;;GAEG;AACH,qBAAa,sBAAsB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,CAAE,YAAW,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzI,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAA;gBAET,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAKxC,0CAA0C;IACpC,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;IAM7B;;;OAGG;IACG,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhD;;;;OAIG;IACG,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAQ7B,qCAAqC;IAC/B,IAAI,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;IAMxC;;;;OAIG;IACG,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMtE;;;;OAIG;IACG,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAC/B,QAAQ,EAAE,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;CAMnB"}
@@ -1,17 +0,0 @@
1
- import type { EmptyObject } from '@xylabs/sdk/object';
2
- /** IDB schema value shape for a single store (key/value/indexes), exported for callers that want it. */
3
- export interface ObjectStoreValue<T extends object = EmptyObject> {
4
- indexes?: Record<string, IDBValidKey>;
5
- key: IDBValidKey;
6
- value: T;
7
- }
8
- /**
9
- * Generic IndexedDB schema type that maps store names to their value types.
10
- *
11
- * Intentionally does NOT extend `idb`'s `DBSchema` and does not embed `ObjectStoreValue` —
12
- * `idb`'s `StoreNames<T>` filters out string index signatures via `KeyToKeyNoIndex`, so any type
13
- * structurally matching `DBSchema` (i.e. whose values satisfy `DBSchemaValue`'s key/value/indexes
14
- * shape) resolves `StoreNames<T>` to `never`. That makes runtime store-name strings unassignable.
15
- */
16
- export type ObjectStore<T extends EmptyObject = EmptyObject> = Record<string, T>;
17
- //# sourceMappingURL=ObjectStore.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ObjectStore.d.ts","sourceRoot":"","sources":["../../src/ObjectStore.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,wGAAwG;AACxG,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,WAAW;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACrC,GAAG,EAAE,WAAW,CAAA;IAChB,KAAK,EAAE,CAAC,CAAA;CACT;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA"}
@@ -1,11 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import { type IndexDescription } from './IndexDescription.ts';
3
- /**
4
- * Checks whether any store in the database needs an upgrade and returns the appropriate version number.
5
- * @param dbName The name of the database to check
6
- * @param stores Map of store names to their expected index descriptions
7
- * @param logger Optional logger for diagnostics
8
- * @returns The version to open (current version + 1 if upgrade needed, otherwise current version)
9
- */
10
- export declare function checkDbNeedsUpgrade(dbName: string, stores: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<number>;
11
- //# sourceMappingURL=checkDbNeedsUpgrade.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"checkDbNeedsUpgrade.d.ts","sourceRoot":"","sources":["../../src/checkDbNeedsUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAGhD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAI7D;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,EAC1C,MAAM,CAAC,EAAE,MAAM,EACf,IAAI,UAAO,mBAWZ"}
@@ -1,13 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { IDBPDatabase } from 'idb';
3
- import { type IndexDescription } from './IndexDescription.ts';
4
- /**
5
- * Checks whether a store needs an upgrade by comparing its existing indexes against expected indexes.
6
- * @param db The IndexedDB database instance
7
- * @param storeName The name of the store to check
8
- * @param indexes The expected index descriptions
9
- * @param logger Optional logger for diagnostics
10
- * @returns True if the store is missing or has missing indexes
11
- */
12
- export declare function checkStoreNeedsUpgrade<DBTypes = unknown>(db: IDBPDatabase<DBTypes>, storeName: string, indexes: IndexDescription[], logger?: Logger): Promise<boolean>;
13
- //# sourceMappingURL=checkStoreNeedsUpgrade.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"checkStoreNeedsUpgrade.d.ts","sourceRoot":"","sources":["../../src/checkStoreNeedsUpgrade.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAErF;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAAC,OAAO,GAAG,OAAO,EAC5D,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,EACzB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gBAAgB,EAAE,EAC3B,MAAM,CAAC,EAAE,MAAM,oBAgBhB"}
@@ -1,12 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { IDBPDatabase, StoreNames } from 'idb';
3
- import { type IndexDescription } from './IndexDescription.ts';
4
- /**
5
- * Creates an object store with the specified indexes during a version upgrade transaction.
6
- * @param db The IndexedDB database instance (during upgrade)
7
- * @param storeName The name of the store to create
8
- * @param indexes The index descriptions to create on the store
9
- * @param logger Optional logger for diagnostics
10
- */
11
- export declare function createStoreDuringUpgrade<DBTypes = unknown>(db: IDBPDatabase<DBTypes>, storeName: StoreNames<DBTypes>, indexes: IndexDescription[], logger?: Logger): void;
12
- //# sourceMappingURL=createStoreDuringUpgrade.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createStoreDuringUpgrade.d.ts","sourceRoot":"","sources":["../../src/createStoreDuringUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EACV,YAAY,EAA+B,UAAU,EACtD,MAAM,KAAK,CAAA;AAEZ,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,uBAAuB,CAAA;AAE9B;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,GAAG,OAAO,EACxD,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,EACzB,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,EAC9B,OAAO,EAAE,gBAAgB,EAAE,EAC3B,MAAM,CAAC,EAAE,MAAM,QA4BhB"}
@@ -1,14 +0,0 @@
1
- import { Mutex } from 'async-mutex';
2
- /**
3
- * Returns the shared mutex for a database name, creating one if needed.
4
- * @param dbName The IndexedDB database name
5
- */
6
- export declare function getDbMutex(dbName: string): Mutex;
7
- /**
8
- * Runs a handler under the shared database mutex when locking is enabled.
9
- * @param dbName The IndexedDB database name
10
- * @param lock Whether to acquire the mutex before running the handler
11
- * @param handler The async function to execute
12
- */
13
- export declare function withDbLock<R>(dbName: string, lock: boolean, handler: () => Promise<R>): Promise<R>;
14
- //# sourceMappingURL=dbMutex.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"dbMutex.d.ts","sourceRoot":"","sources":["../../src/dbMutex.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAInC;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,SAGxC;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,cAK3F"}
@@ -1,12 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { IDBPDatabase } from 'idb';
3
- import { type IndexDescription } from './IndexDescription.ts';
4
- /**
5
- * Retrieves the existing index descriptions for a store. Accepts either a database instance or a database name.
6
- * @param db The IndexedDB database instance or database name
7
- * @param storeName The name of the store to inspect
8
- * @param logger Optional logger for diagnostics
9
- * @returns An array of index descriptions, or null if the store does not exist
10
- */
11
- export declare function getExistingIndexes<DBTypes = unknown>(db: IDBPDatabase<DBTypes> | string, storeName: string, logger?: Logger): Promise<IndexDescription[] | null>;
12
- //# sourceMappingURL=getExistingIndexes.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getExistingIndexes.d.ts","sourceRoot":"","sources":["../../src/getExistingIndexes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAc,MAAM,KAAK,CAAA;AAEnD,OAAO,EACL,KAAK,gBAAgB,EAEtB,MAAM,uBAAuB,CAAA;AAmC9B;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,GAAG,OAAO,EACxD,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,MAAM,EAClC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,gBAAgB,EAAE,GAAG,IAAI,CAAC,CAQpC"}
@@ -1,16 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { EmptyObject } from '@xylabs/sdk/object';
3
- import type { IDBPDatabase } from 'idb';
4
- import { type IndexDescription } from './IndexDescription.ts';
5
- /**
6
- * Opens an IndexedDB database, automatically upgrading if needed, and passes it to the callback.
7
- * Uses a mutex to serialize access to the same database by default.
8
- * @param dbName The name of the database to open
9
- * @param callback Function to execute with the opened database
10
- * @param expectedIndexes Optional map of store names to their expected indexes (triggers upgrade check)
11
- * @param logger Optional logger for diagnostics
12
- * @param lock Whether to use a mutex to serialize access (defaults to true)
13
- * @returns The result of the callback
14
- */
15
- export declare function withDb<DBTypes = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<R>;
16
- //# sourceMappingURL=withDb.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"withDb.d.ts","sourceRoot":"","sources":["../../src/withDb.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,KAAK,CAAA;AAIvC,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAG7D;;;;;;;;;GASG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAG,OAAO,EAAE,CAAC,GAAG,WAAW,EAC7D,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,EACf,IAAI,UAAO,GACV,OAAO,CAAC,CAAC,CAAC,CAOZ"}
@@ -1,17 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { EmptyObject } from '@xylabs/sdk/object';
3
- import type { IDBPDatabase } from 'idb';
4
- import { type IndexDescription } from './IndexDescription.ts';
5
- /**
6
- * Opens an IndexedDB database at a specific version, handling upgrade events, and passes it to the callback.
7
- * The database is automatically closed after the callback completes.
8
- * @param dbName The name of the database to open
9
- * @param callback Function to execute with the opened database
10
- * @param version Optional specific version to open (undefined for latest)
11
- * @param expectedIndexes Optional map of store names to indexes to create during upgrade
12
- * @param logger Optional logger for diagnostics
13
- * @param lock Whether to use a mutex to serialize access (defaults to true)
14
- * @returns The result of the callback
15
- */
16
- export declare function withDbByVersion<DBTypes = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, version?: number, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<R>;
17
- //# sourceMappingURL=withDbByVersion.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"withDbByVersion.d.ts","sourceRoot":"","sources":["../../src/withDbByVersion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAc,MAAM,KAAK,CAAA;AAKnD,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAErF;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,CAAC,OAAO,GAAG,OAAO,EAAE,CAAC,GAAG,WAAW,EACtE,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,CAAC,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EACvD,OAAO,CAAC,EAAE,MAAM,EAChB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,EACpD,MAAM,CAAC,EAAE,MAAM,EACf,IAAI,UAAO,GACV,OAAO,CAAC,CAAC,CAAC,CAgDZ"}
@@ -1,14 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { EmptyObject } from '@xylabs/sdk/object';
3
- import type { IDBPDatabase, IDBPObjectStore, StoreNames } from 'idb';
4
- import type { ObjectStore } from './ObjectStore.ts';
5
- /**
6
- * Opens a read-only transaction on the specified store and passes it to the callback.
7
- * @param db The IndexedDB database instance
8
- * @param storeName The name of the object store to open
9
- * @param callback Function to execute with the read-only store
10
- * @param logger Optional logger for diagnostics
11
- * @returns The result of the callback
12
- */
13
- 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>;
14
- //# sourceMappingURL=withReadOnlyStore.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"withReadOnlyStore.d.ts","sourceRoot":"","sources":["../../src/withReadOnlyStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EACV,YAAY,EAAE,eAAe,EAAE,UAAU,EAC1C,MAAM,KAAK,CAAA;AAEZ,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAGnD;;;;;;;GAOG;AACH,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"}
@@ -1,14 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { EmptyObject } from '@xylabs/sdk/object';
3
- import type { IDBPDatabase, IDBPObjectStore, StoreNames } from 'idb';
4
- import type { ObjectStore } from './ObjectStore.ts';
5
- /**
6
- * Opens a read-write transaction on the specified store and passes it to the callback.
7
- * @param db The IndexedDB database instance
8
- * @param storeName The name of the object store to open
9
- * @param callback Function to execute with the read-write store
10
- * @param logger Optional logger for diagnostics
11
- * @returns The result of the callback
12
- */
13
- 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>;
14
- //# sourceMappingURL=withReadWriteStore.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"withReadWriteStore.d.ts","sourceRoot":"","sources":["../../src/withReadWriteStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EACV,YAAY,EAAE,eAAe,EAAE,UAAU,EAC1C,MAAM,KAAK,CAAA;AAEZ,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAGnD;;;;;;;GAOG;AACH,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"}
@@ -1,18 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { EmptyObject } from '@xylabs/sdk/object';
3
- import type { IDBPDatabase, IDBPObjectStore, StoreNames } from 'idb';
4
- import type { ObjectStore } from './ObjectStore.ts';
5
- /**
6
- * Opens a transaction on the specified store with the given mode and passes the store to the callback.
7
- * If the store does not exist, the callback receives null.
8
- * @param db The IndexedDB database instance
9
- * @param storeName The name of the object store to open
10
- * @param callback Function to execute with the store (or null if it doesn't exist)
11
- * @param mode The transaction mode ('readonly' or 'readwrite')
12
- * @param logger Optional logger for diagnostics
13
- * @returns The result of the callback
14
- */
15
- 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>, [
16
- StoreNames<ObjectStore<T>>
17
- ], StoreNames<ObjectStore<T>>, M> | null) => Promise<R> | R, mode: M, logger?: Logger): Promise<R>;
18
- //# sourceMappingURL=withStore.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"withStore.d.ts","sourceRoot":"","sources":["../../src/withStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EACV,YAAY,EAAE,eAAe,EAAmB,UAAU,EAC3D,MAAM,KAAK,CAAA;AAEZ,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;;;;;GASG;AACH,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"}
@@ -1,31 +0,0 @@
1
- /**
2
- * The index direction (1 for ascending, -1 for descending)
3
- */
4
- export type IndexDirection = -1 | 1;
5
- /**
6
- * Description of index(es) to be created on a store
7
- */
8
- export interface IndexDescription {
9
- /**
10
- * The key(s) to index
11
- */
12
- key: Record<string, IndexDirection>;
13
- /**
14
- * Is the indexed value an array
15
- */
16
- multiEntry?: boolean;
17
- /**
18
- * If true, the index must enforce uniqueness on the key
19
- */
20
- unique?: boolean;
21
- }
22
- /** Separator used between key names when building standard index names. */
23
- export declare const IndexSeparator = "-";
24
- /**
25
- * Given an index description, this will build the index
26
- * name in standard form
27
- * @param index The index description
28
- * @returns The index name in standard form
29
- */
30
- export declare const buildStandardIndexName: (index: IndexDescription) => string;
31
- //# sourceMappingURL=IndexDescription.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"IndexDescription.d.ts","sourceRoot":"","sources":["../../src/IndexDescription.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAEnC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,2EAA2E;AAC3E,eAAO,MAAM,cAAc,MAAM,CAAA;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GAAI,OAAO,gBAAgB,WAK7D,CAAA"}
@@ -1,40 +0,0 @@
1
- import type { KeyValueStore } from '@xylabs/sdk/storage';
2
- import type { DBSchema, IDBPDatabase, StoreKey, StoreNames, StoreValue } from 'idb';
3
- /**
4
- * An IndexedDB key/value store.
5
- */
6
- export declare class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>> implements KeyValueStore<StoreValue<T, S>, StoreKey<T, S>> {
7
- /** The name of the IndexedDB database. */
8
- readonly dbName: string;
9
- /** The name of the object store within the database. */
10
- readonly storeName: S;
11
- constructor(dbName: string, storeName: S);
12
- /** Removes all entries from the store. */
13
- clear?(): Promise<void>;
14
- /**
15
- * Deletes the entry with the given key.
16
- * @param key The key of the entry to delete
17
- */
18
- delete(key: StoreKey<T, S>): Promise<void>;
19
- /**
20
- * Retrieves the value associated with the given key.
21
- * @param key The key to look up
22
- * @returns The value, or undefined if not found
23
- */
24
- get(key: StoreKey<T, S>): Promise<StoreValue<T, S> | undefined>;
25
- /** Returns all keys in the store. */
26
- keys?(): Promise<StoreKey<T, S>[]>;
27
- /**
28
- * Sets a value for the given key, creating or updating the entry.
29
- * @param key The key to set
30
- * @param value The value to store
31
- */
32
- set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void>;
33
- /**
34
- * Opens the underlying IndexedDB database and passes it to the callback.
35
- * @param callback Function to execute with the database
36
- * @returns The result of the callback
37
- */
38
- withDb<R = StoreValue<T, S>>(callback: (db: IDBPDatabase<T>) => Promise<R> | R): Promise<R>;
39
- }
40
- //# sourceMappingURL=IndexedDbKeyValueStore.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"IndexedDbKeyValueStore.d.ts","sourceRoot":"","sources":["../../src/IndexedDbKeyValueStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAC/C,MAAM,KAAK,CAAA;AAIZ;;GAEG;AACH,qBAAa,sBAAsB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,CAAE,YAAW,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzI,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAA;gBAET,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAKxC,0CAA0C;IACpC,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;IAM7B;;;OAGG;IACG,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhD;;;;OAIG;IACG,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAQ7B,qCAAqC;IAC/B,IAAI,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;IAMxC;;;;OAIG;IACG,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMtE;;;;OAIG;IACG,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAC/B,QAAQ,EAAE,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;CAMnB"}
@@ -1,17 +0,0 @@
1
- import type { EmptyObject } from '@xylabs/sdk/object';
2
- /** IDB schema value shape for a single store (key/value/indexes), exported for callers that want it. */
3
- export interface ObjectStoreValue<T extends object = EmptyObject> {
4
- indexes?: Record<string, IDBValidKey>;
5
- key: IDBValidKey;
6
- value: T;
7
- }
8
- /**
9
- * Generic IndexedDB schema type that maps store names to their value types.
10
- *
11
- * Intentionally does NOT extend `idb`'s `DBSchema` and does not embed `ObjectStoreValue` —
12
- * `idb`'s `StoreNames<T>` filters out string index signatures via `KeyToKeyNoIndex`, so any type
13
- * structurally matching `DBSchema` (i.e. whose values satisfy `DBSchemaValue`'s key/value/indexes
14
- * shape) resolves `StoreNames<T>` to `never`. That makes runtime store-name strings unassignable.
15
- */
16
- export type ObjectStore<T extends EmptyObject = EmptyObject> = Record<string, T>;
17
- //# sourceMappingURL=ObjectStore.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ObjectStore.d.ts","sourceRoot":"","sources":["../../src/ObjectStore.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,wGAAwG;AACxG,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,WAAW;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACrC,GAAG,EAAE,WAAW,CAAA;IAChB,KAAK,EAAE,CAAC,CAAA;CACT;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA"}
@@ -1,11 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import { type IndexDescription } from './IndexDescription.ts';
3
- /**
4
- * Checks whether any store in the database needs an upgrade and returns the appropriate version number.
5
- * @param dbName The name of the database to check
6
- * @param stores Map of store names to their expected index descriptions
7
- * @param logger Optional logger for diagnostics
8
- * @returns The version to open (current version + 1 if upgrade needed, otherwise current version)
9
- */
10
- export declare function checkDbNeedsUpgrade(dbName: string, stores: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<number>;
11
- //# sourceMappingURL=checkDbNeedsUpgrade.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"checkDbNeedsUpgrade.d.ts","sourceRoot":"","sources":["../../src/checkDbNeedsUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAGhD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAI7D;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,EAC1C,MAAM,CAAC,EAAE,MAAM,EACf,IAAI,UAAO,mBAWZ"}
@@ -1,13 +0,0 @@
1
- import type { Logger } from '@xylabs/sdk/logger';
2
- import type { IDBPDatabase } from 'idb';
3
- import { type IndexDescription } from './IndexDescription.ts';
4
- /**
5
- * Checks whether a store needs an upgrade by comparing its existing indexes against expected indexes.
6
- * @param db The IndexedDB database instance
7
- * @param storeName The name of the store to check
8
- * @param indexes The expected index descriptions
9
- * @param logger Optional logger for diagnostics
10
- * @returns True if the store is missing or has missing indexes
11
- */
12
- export declare function checkStoreNeedsUpgrade<DBTypes = unknown>(db: IDBPDatabase<DBTypes>, storeName: string, indexes: IndexDescription[], logger?: Logger): Promise<boolean>;
13
- //# sourceMappingURL=checkStoreNeedsUpgrade.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"checkStoreNeedsUpgrade.d.ts","sourceRoot":"","sources":["../../src/checkStoreNeedsUpgrade.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAErF;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAAC,OAAO,GAAG,OAAO,EAC5D,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,EACzB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gBAAgB,EAAE,EAC3B,MAAM,CAAC,EAAE,MAAM,oBAgBhB"}