@xylabs/indexed-db 5.0.83 → 5.0.84

package/README.md

@@ -104,6 +104,8 @@ new IndexedDbKeyValueStore<T, S>(dbName, storeName): IndexedDbKeyValueStore<T, S
 readonly dbName: string;
 ```
 
+The name of the IndexedDB database.
+
 ***
 
 ### storeName
@@ -112,6 +114,8 @@ readonly dbName: string;
 readonly storeName: S;
 ```
 
+The name of the object store within the database.
+
 ## Methods
 
 ### clear()?
@@ -120,6 +124,8 @@ readonly storeName: S;
 optional clear(): Promise<void>;
 ```
 
+Removes all entries from the store.
+
 ### Returns
 
 `Promise`\<`void`\>
@@ -138,12 +144,16 @@ KeyValueStore.clear
 delete(key): Promise<void>;
 ```
 
+Deletes the entry with the given key.
+
 ### Parameters
 
 #### key
 
 `StoreKey`\<`T`, `S`\>
 
+The key of the entry to delete
+
 ### Returns
 
 `Promise`\<`void`\>
@@ -162,7 +172,7 @@ KeyValueStore.delete
 get(key): Promise<StoreValue<T, S> | undefined>;
 ```
 
-Returns a promise that resolves to the value for the given key.
+Retrieves the value associated with the given key.
 
 ### Parameters
 
@@ -170,12 +180,14 @@ Returns a promise that resolves to the value for the given key.
 
 `StoreKey`\<`T`, `S`\>
 
-The key to get the value for.
+The key to look up
 
 ### Returns
 
 `Promise`\<`StoreValue`\<`T`, `S`\> \| `undefined`\>
 
+The value, or undefined if not found
+
 ### Implementation of
 
 ```ts
@@ -190,7 +202,7 @@ KeyValueStore.get
 optional keys(): Promise<StoreKey<T, S>[]>;
 ```
 
-The keys an array of keys.
+Returns all keys in the store.
 
 ### Returns
 
@@ -210,16 +222,22 @@ KeyValueStore.keys
 set(key, value): Promise<void>;
 ```
 
+Sets a value for the given key, creating or updating the entry.
+
 ### Parameters
 
 #### key
 
 `StoreKey`\<`T`, `S`\>
 
+The key to set
+
 #### value
 
 `StoreValue`\<`T`, `S`\>
 
+The value to store
+
 ### Returns
 
 `Promise`\<`void`\>
@@ -238,6 +256,8 @@ KeyValueStore.set
 withDb<R>(callback): Promise<R>;
 ```
 
+Opens the underlying IndexedDB database and passes it to the callback.
+
 ### Type Parameters
 
 #### R
@@ -250,10 +270,14 @@ withDb<R>(callback): Promise<R>;
 
 (`db`) => `R` \| `Promise`\<`R`\>
 
+Function to execute with the database
+
 ### Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
 ### functions
 
   ### <a id="buildStandardIndexName"></a>buildStandardIndexName
@@ -296,24 +320,34 @@ function checkDbNeedsUpgrade(
 logger?): Promise<number>;
 ```
 
+Checks whether any store in the database needs an upgrade and returns the appropriate version number.
+
 ## Parameters
 
 ### dbName
 
 `string`
 
+The name of the database to check
+
 ### stores
 
 `Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\>
 
+Map of store names to their expected index descriptions
+
 ### logger?
 
 `Logger`
 
+Optional logger for diagnostics
+
 ## Returns
 
 `Promise`\<`number`\>
 
+The version to open (current version + 1 if upgrade needed, otherwise current version)
+
   ### <a id="createStoreDuringUpgrade"></a>createStoreDuringUpgrade
 
 [**@xylabs/indexed-db**](#../README)
@@ -328,6 +362,8 @@ function createStoreDuringUpgrade<DBTypes>(
    logger?): void;
 ```
 
+Creates an object store with the specified indexes during a version upgrade transaction.
+
 ## Type Parameters
 
 ### DBTypes
@@ -340,18 +376,26 @@ function createStoreDuringUpgrade<DBTypes>(
 
 `IDBPDatabase`\<`DBTypes`\>
 
+The IndexedDB database instance (during upgrade)
+
 ### storeName
 
 `StoreNames`\<`DBTypes`\>
 
+The name of the store to create
+
 ### indexes
 
 [`IndexDescription`](#../type-aliases/IndexDescription)[]
 
+The index descriptions to create on the store
+
 ### logger?
 
 `Logger`
 
+Optional logger for diagnostics
+
 ## Returns
 
 `void`
@@ -369,6 +413,8 @@ function getExistingIndexes<T>(
 logger?): Promise<IndexDescription[] | null>;
 ```
 
+Retrieves the existing index descriptions for a store. Accepts either a database instance or a database name.
+
 ## Type Parameters
 
 ### T
@@ -379,20 +425,28 @@ logger?): Promise<IndexDescription[] | null>;
 
 ### db
 
+The IndexedDB database instance or database name
+
 `string` | `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
 
 ### storeName
 
 `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
 
+The name of the store to inspect
+
 ### logger?
 
 `Logger`
 
+Optional logger for diagnostics
+
 ## Returns
 
 `Promise`\<[`IndexDescription`](#../type-aliases/IndexDescription)[] \| `null`\>
 
+An array of index descriptions, or null if the store does not exist
+
   ### <a id="withDb"></a>withDb
 
 [**@xylabs/indexed-db**](#../README)
@@ -408,6 +462,9 @@ function withDb<DBTypes, R>(
 lock?): Promise<R>;
 ```
 
+Opens an IndexedDB database, automatically upgrading if needed, and passes it to the callback.
+Uses a mutex to serialize access to the same database by default.
+
 ## Type Parameters
 
 ### DBTypes
@@ -424,26 +481,38 @@ lock?): Promise<R>;
 
 `string`
 
+The name of the database to open
+
 ### callback
 
 (`db`) => `R` \| `Promise`\<`R`\>
 
+Function to execute with the opened database
+
 ### expectedIndexes?
 
 `Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\>
 
+Optional map of store names to their expected indexes (triggers upgrade check)
+
 ### logger?
 
 `Logger`
 
+Optional logger for diagnostics
+
 ### lock?
 
 `boolean` = `true`
 
+Whether to use a mutex to serialize access (defaults to true)
+
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
   ### <a id="withDbByVersion"></a>withDbByVersion
 
 [**@xylabs/indexed-db**](#../README)
@@ -460,6 +529,9 @@ function withDbByVersion<DBTypes, R>(
 lock?): Promise<R>;
 ```
 
+Opens an IndexedDB database at a specific version, handling upgrade events, and passes it to the callback.
+The database is automatically closed after the callback completes.
+
 ## Type Parameters
 
 ### DBTypes
@@ -476,30 +548,44 @@ lock?): Promise<R>;
 
 `string`
 
+The name of the database to open
+
 ### callback
 
 (`db`) => `R` \| `Promise`\<`R`\>
 
+Function to execute with the opened database
+
 ### version?
 
 `number`
 
+Optional specific version to open (undefined for latest)
+
 ### expectedIndexes?
 
 `Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\>
 
+Optional map of store names to indexes to create during upgrade
+
 ### logger?
 
 `Logger`
 
+Optional logger for diagnostics
+
 ### lock?
 
 `boolean` = `true`
 
+Whether to use a mutex to serialize access (defaults to true)
+
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
   ### <a id="withReadOnlyStore"></a>withReadOnlyStore
 
 [**@xylabs/indexed-db**](#../README)
@@ -514,6 +600,8 @@ function withReadOnlyStore<T, R>(
 logger?): Promise<R>;
 ```
 
+Opens a read-only transaction on the specified store and passes it to the callback.
+
 ## Type Parameters
 
 ### T
@@ -530,22 +618,32 @@ logger?): Promise<R>;
 
 `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
 
+The IndexedDB database instance
+
 ### storeName
 
 `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
 
+The name of the object store to open
+
 ### callback
 
 (`store`) => `R` \| `Promise`\<`R`\>
 
+Function to execute with the read-only store
+
 ### logger?
 
 `Logger`
 
+Optional logger for diagnostics
+
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
   ### <a id="withReadWriteStore"></a>withReadWriteStore
 
 [**@xylabs/indexed-db**](#../README)
@@ -560,6 +658,8 @@ function withReadWriteStore<T, R>(
 logger?): Promise<R>;
 ```
 
+Opens a read-write transaction on the specified store and passes it to the callback.
+
 ## Type Parameters
 
 ### T
@@ -576,22 +676,32 @@ logger?): Promise<R>;
 
 `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
 
+The IndexedDB database instance
+
 ### storeName
 
 `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
 
+The name of the object store to open
+
 ### callback
 
 (`store`) => `R` \| `Promise`\<`R`\>
 
+Function to execute with the read-write store
+
 ### logger?
 
 `Logger`
 
+Optional logger for diagnostics
+
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
   ### <a id="withStore"></a>withStore
 
 [**@xylabs/indexed-db**](#../README)
@@ -607,6 +717,9 @@ function withStore<T, R, M>(
 logger?): Promise<R>;
 ```
 
+Opens a transaction on the specified store with the given mode and passes the store to the callback.
+If the store does not exist, the callback receives null.
+
 ## Type Parameters
 
 ### T
@@ -627,26 +740,38 @@ logger?): Promise<R>;
 
 `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
 
+The IndexedDB database instance
+
 ### storeName
 
 `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
 
+The name of the object store to open
+
 ### callback
 
 (`store`) => `R` \| `Promise`\<`R`\>
 
+Function to execute with the store (or null if it doesn't exist)
+
 ### mode
 
 `M`
 
+The transaction mode ('readonly' or 'readwrite')
+
 ### logger?
 
 `Logger`
 
+Optional logger for diagnostics
+
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
 ### interfaces
 
   ### <a id="ObjectStore"></a>ObjectStore
@@ -655,6 +780,8 @@ logger?): Promise<R>;
 
 ***
 
+Generic IndexedDB schema type that maps store names to their value types.
+
 ## Type Parameters
 
 ### T
@@ -735,6 +862,8 @@ The index direction (1 for ascending, -1 for descending)
 const IndexSeparator: "-" = '-';
 ```
 
+Separator used between key names when building standard index names.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/dist/browser/IndexDescription.d.ts

@@ -19,6 +19,7 @@ export type IndexDescription = {
      */
     unique?: boolean;
 };
+/** Separator used between key names when building standard index names. */
 export declare const IndexSeparator = "-";
 /**
  * Given an index description, this will build the index

package/dist/browser/IndexDescription.d.ts.map

@@ -1 +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,MAAM,gBAAgB,GAAG;IAC7B;;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,CAAA;AAED,eAAO,MAAM,cAAc,MAAM,CAAA;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GAAI,OAAO,gBAAgB,WAK7D,CAAA"}
+{"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,MAAM,gBAAgB,GAAG;IAC7B;;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,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,cAAc,MAAM,CAAA;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GAAI,OAAO,gBAAgB,WAK7D,CAAA"}

package/dist/browser/IndexedDbKeyValueStore.d.ts

@@ -4,14 +4,37 @@ import type { DBSchema, IDBPDatabase, StoreKey, StoreNames, StoreValue } from 'i
  * An IndexedDB key/value store.
  */
 export declare class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>> implements KeyValueStore<StoreValue<T, S>, StoreKey<T, S>> {
+    /** The name of the IndexedDB database. */
     readonly dbName: string;
+    /** The name of the object store within the database. */
     readonly storeName: S;
     constructor(dbName: string, storeName: S);
+    /** Removes all entries from the store. */
     clear?(): Promise<void>;
+    /**
+     * Deletes the entry with the given key.
+     * @param key The key of the entry to delete
+     */
     delete(key: StoreKey<T, S>): Promise<void>;
+    /**
+     * Retrieves the value associated with the given key.
+     * @param key The key to look up
+     * @returns The value, or undefined if not found
+     */
     get(key: StoreKey<T, S>): Promise<StoreValue<T, S> | undefined>;
+    /** Returns all keys in the store. */
     keys?(): Promise<StoreKey<T, S>[]>;
+    /**
+     * Sets a value for the given key, creating or updating the entry.
+     * @param key The key to set
+     * @param value The value to store
+     */
     set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void>;
+    /**
+     * Opens the underlying IndexedDB database and passes it to the callback.
+     * @param callback Function to execute with the database
+     * @returns The result of the callback
+     */
     withDb<R = StoreValue<T, S>>(callback: (db: IDBPDatabase<T>) => Promise<R> | R): Promise<R>;
 }
 //# sourceMappingURL=IndexedDbKeyValueStore.d.ts.map

package/dist/browser/IndexedDbKeyValueStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedDbKeyValueStore.d.ts","sourceRoot":"","sources":["../../src/IndexedDbKeyValueStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,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,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAA;gBAET,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAKlC,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;IAMvB,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1C,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAQvB,IAAI,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;IAMlC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhE,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"}
+{"version":3,"file":"IndexedDbKeyValueStore.d.ts","sourceRoot":"","sources":["../../src/IndexedDbKeyValueStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,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"}

package/dist/browser/ObjectStore.d.ts

@@ -1,4 +1,5 @@
 import type { EmptyObject } from '@xylabs/object';
+/** Generic IndexedDB schema type that maps store names to their value types. */
 export interface ObjectStore<T extends EmptyObject = EmptyObject> {
     [s: string]: T;
 }

package/dist/browser/ObjectStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ObjectStore.d.ts","sourceRoot":"","sources":["../../src/ObjectStore.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAC9D,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAA;CACf"}
+{"version":3,"file":"ObjectStore.d.ts","sourceRoot":"","sources":["../../src/ObjectStore.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,gFAAgF;AAChF,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAC9D,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAA;CACf"}

package/dist/browser/checkDbNeedsUpgrade.d.ts

@@ -1,4 +1,11 @@
 import type { Logger } from '@xylabs/logger';
 import { type IndexDescription } from './IndexDescription.ts';
+/**
+ * Checks whether any store in the database needs an upgrade and returns the appropriate version number.
+ * @param dbName The name of the database to check
+ * @param stores Map of store names to their expected index descriptions
+ * @param logger Optional logger for diagnostics
+ * @returns The version to open (current version + 1 if upgrade needed, otherwise current version)
+ */
 export declare function checkDbNeedsUpgrade(dbName: string, stores: Record<string, IndexDescription[]>, logger?: Logger): Promise<number>;
 //# sourceMappingURL=checkDbNeedsUpgrade.d.ts.map

package/dist/browser/checkDbNeedsUpgrade.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkDbNeedsUpgrade.d.ts","sourceRoot":"","sources":["../../src/checkDbNeedsUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAG5C,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAI7D,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,mBAUpH"}
+{"version":3,"file":"checkDbNeedsUpgrade.d.ts","sourceRoot":"","sources":["../../src/checkDbNeedsUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAG5C,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAI7D;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,mBAUpH"}

package/dist/browser/checkStoreNeedsUpgrade.d.ts

@@ -2,5 +2,13 @@ import type { Logger } from '@xylabs/logger';
 import type { IDBPDatabase } from 'idb';
 import { type IndexDescription } from './IndexDescription.ts';
 import type { ObjectStore } from './ObjectStore.ts';
+/**
+ * Checks whether a store needs an upgrade by comparing its existing indexes against expected indexes.
+ * @param db The IndexedDB database instance
+ * @param storeName The name of the store to check
+ * @param indexes The expected index descriptions
+ * @param logger Optional logger for diagnostics
+ * @returns True if the store is missing or has missing indexes
+ */
 export declare function checkStoreNeedsUpgrade(db: IDBPDatabase<ObjectStore<object>>, storeName: string, indexes: IndexDescription[], logger?: Logger): Promise<boolean>;
 //# sourceMappingURL=checkStoreNeedsUpgrade.d.ts.map

package/dist/browser/checkStoreNeedsUpgrade.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkStoreNeedsUpgrade.d.ts","sourceRoot":"","sources":["../../src/checkStoreNeedsUpgrade.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACrF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,wBAAsB,sBAAsB,CAAC,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,oBAelJ"}
+{"version":3,"file":"checkStoreNeedsUpgrade.d.ts","sourceRoot":"","sources":["../../src/checkStoreNeedsUpgrade.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACrF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAAC,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,oBAelJ"}

package/dist/browser/createStoreDuringUpgrade.d.ts

@@ -1,5 +1,12 @@
 import type { Logger } from '@xylabs/logger';
 import type { DBSchema, IDBPDatabase, StoreNames } from 'idb';
 import { type IndexDescription } from './IndexDescription.ts';
+/**
+ * Creates an object store with the specified indexes during a version upgrade transaction.
+ * @param db The IndexedDB database instance (during upgrade)
+ * @param storeName The name of the store to create
+ * @param indexes The index descriptions to create on the store
+ * @param logger Optional logger for diagnostics
+ */
 export declare function createStoreDuringUpgrade<DBTypes extends DBSchema | unknown = unknown>(db: IDBPDatabase<DBTypes>, storeName: StoreNames<DBTypes>, indexes: IndexDescription[], logger?: Logger): void;
 //# sourceMappingURL=createStoreDuringUpgrade.d.ts.map

package/dist/browser/createStoreDuringUpgrade.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createStoreDuringUpgrade.d.ts","sourceRoot":"","sources":["../../src/createStoreDuringUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EAA+B,UAAU,EACtD,MAAM,KAAK,CAAA;AAEZ,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,uBAAuB,CAAA;AAE9B,wBAAgB,wBAAwB,CAAC,OAAO,SAAS,QAAQ,GAAG,OAAO,GAAG,OAAO,EACnF,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,EACzB,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,EAC9B,OAAO,EAAE,gBAAgB,EAAE,EAC3B,MAAM,CAAC,EAAE,MAAM,QA4BhB"}
+{"version":3,"file":"createStoreDuringUpgrade.d.ts","sourceRoot":"","sources":["../../src/createStoreDuringUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EAA+B,UAAU,EACtD,MAAM,KAAK,CAAA;AAEZ,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,uBAAuB,CAAA;AAE9B;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,SAAS,QAAQ,GAAG,OAAO,GAAG,OAAO,EACnF,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,EACzB,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,EAC9B,OAAO,EAAE,gBAAgB,EAAE,EAC3B,MAAM,CAAC,EAAE,MAAM,QA4BhB"}

package/dist/browser/getExistingIndexes.d.ts

@@ -3,5 +3,12 @@ import type { EmptyObject } from '@xylabs/object';
 import type { IDBPDatabase, StoreNames } from 'idb';
 import { type IndexDescription } from './IndexDescription.ts';
 import type { ObjectStore } from './ObjectStore.ts';
+/**
+ * Retrieves the existing index descriptions for a store. Accepts either a database instance or a database name.
+ * @param db The IndexedDB database instance or database name
+ * @param storeName The name of the store to inspect
+ * @param logger Optional logger for diagnostics
+ * @returns An array of index descriptions, or null if the store does not exist
+ */
 export declare function getExistingIndexes<T extends EmptyObject = EmptyObject>(db: IDBPDatabase<ObjectStore<T>> | string, storeName: StoreNames<ObjectStore<T>>, logger?: Logger): Promise<IndexDescription[] | null>;
 //# sourceMappingURL=getExistingIndexes.d.ts.map

package/dist/browser/getExistingIndexes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getExistingIndexes.d.ts","sourceRoot":"","sources":["../../src/getExistingIndexes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AAEnD,OAAO,EACL,KAAK,gBAAgB,EAEtB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAiCnD,wBAAsB,kBAAkB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAC1E,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EACzC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EACrC,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,gBAAgB,EAAE,GAAG,IAAI,CAAC,CAQpC"}
+{"version":3,"file":"getExistingIndexes.d.ts","sourceRoot":"","sources":["../../src/getExistingIndexes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AAEnD,OAAO,EACL,KAAK,gBAAgB,EAEtB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAiCnD;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAC1E,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EACzC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EACrC,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,gBAAgB,EAAE,GAAG,IAAI,CAAC,CAQpC"}

package/dist/browser/index.mjs

@@ -191,37 +191,60 @@ async function withDb(dbName, callback, expectedIndexes, logger, lock = true) {
 
 // src/IndexedDbKeyValueStore.ts
 var IndexedDbKeyValueStore = class {
+  /** The name of the IndexedDB database. */
   dbName;
+  /** The name of the object store within the database. */
   storeName;
   constructor(dbName, storeName) {
     this.dbName = dbName;
     this.storeName = storeName;
   }
+  /** Removes all entries from the store. */
   async clear() {
     return await this.withDb((db) => {
       return db.clear(this.storeName);
     });
   }
+  /**
+   * Deletes the entry with the given key.
+   * @param key The key of the entry to delete
+   */
   async delete(key) {
     return await this.withDb((db) => {
       return db.delete(this.storeName, key);
     });
   }
+  /**
+   * Retrieves the value associated with the given key.
+   * @param key The key to look up
+   * @returns The value, or undefined if not found
+   */
   async get(key) {
     return await this.withDb((db) => {
       return db.get(this.storeName, key) ?? void 0;
     });
   }
+  /** Returns all keys in the store. */
   async keys() {
     return await this.withDb((db) => {
       return db.getAllKeys(this.storeName);
     });
   }
+  /**
+   * Sets a value for the given key, creating or updating the entry.
+   * @param key The key to set
+   * @param value The value to store
+   */
   async set(key, value) {
     return await this.withDb(async (db) => {
       await db.put(this.storeName, value, key);
     });
   }
+  /**
+   * Opens the underlying IndexedDB database and passes it to the callback.
+   * @param callback Function to execute with the database
+   * @returns The result of the callback
+   */
   async withDb(callback) {
     return await withDb(this.dbName, (db) => {
       return callback(db);