locality-idb 1.3.0 → 1.4.0

package/README.md

@@ -911,6 +911,58 @@ const db = new Locality({
 });
 ```
 
+#### Properties
+
+##### `version: number` (getter)
+
+Gets the current database version.
+
+**Returns:** The database version number
+
+**Example:**
+
+```typescript
+const db = new Locality({
+  dbName: 'my-database',
+  version: 2,
+  schema: mySchema,
+});
+
+await db.ready(); // (optional) for extra safety
+console.log(db.version); // 2
+```
+
+##### `tableList: string[]` (getter)
+
+Gets all table (store) names in the current database.
+
+**Returns:** Array of table names
+
+**Example:**
+
+```typescript
+const tables = db.tableList;
+console.log(tables); // ['users', 'posts', 'comments']
+```
+
+##### `dbList: Promise<IDBDatabaseInfo[]>` (getter)
+
+Gets the list of all existing IndexedDB databases in the current origin.
+
+**Returns:** Array of database information objects containing name and version
+
+**Example:**
+
+```typescript
+const databases = await db.dbList;
+console.log(databases);
+// [{ name: 'my-database', version: 1 }, { name: 'other-db', version: 2 }]
+```
+
+> This is an instance method that calls the static [`Locality.getDatabaseList()`](#localitygetdatabaselist-promiseidbdatabaseinfo) internally.
+
+---
+
 #### Methods
 
 ##### `ready(): Promise<void>`
@@ -1123,6 +1175,63 @@ await db.export({
 
 ---
 
+#### Static Methods
+
+##### `Locality.getDatabaseList(): Promise<IDBDatabaseInfo[]>`
+
+Gets the list of all existing IndexedDB databases in the current origin (static method).
+
+**Returns:** Array of database information objects containing name and version
+
+**Example:**
+
+```typescript
+import { Locality } from 'locality-idb';
+
+const databases = await Locality.getDatabaseList();
+console.log(databases);
+// [{ name: 'app-db', version: 1 }, { name: 'cache-db', version: 2 }]
+```
+
+> **Note:**
+>
+> - This method requires IndexedDB support in the browser.
+> - Returns an empty array if the browser doesn't support `indexedDB.databases()`.
+> - Can be called without instantiating the Locality class.
+
+##### `Locality.deleteDatabase(name: string): Promise<void>`
+
+Deletes an IndexedDB database by name (static method).
+
+**Parameters:**
+
+- `name`: The name of the database to delete
+
+**Returns:** Promise that resolves when the database is deleted
+
+**Example:**
+
+```typescript
+import { Locality } from 'locality-idb';
+
+// Delete a database without creating an instance
+await Locality.deleteDatabase('old-database');
+
+// Alternative: Get list of databases first
+const databases = await Locality.getDatabaseList();
+for (const db of databases) {
+  if (db.name.startsWith('temp-')) {
+    await Locality.deleteDatabase(db.name);
+  }
+}
+```
+
+> **Warning:** This will permanently remove all data from the specified database and cannot be undone.
+>
+> **Note:** This is a static method that can be called without creating a Locality instance. For deleting the current database instance, use the instance method `db.deleteDB()` instead.
+
+---
+
 ### Schema Functions
 
 #### `defineSchema<Schema extends ColumnRecord, Keys extends keyof Schema>(schema: Schema): SchemaRecord<Schema, Keys>`
@@ -1747,7 +1856,7 @@ Opens an IndexedDB database with specified stores (low-level API).
 
 - `name`: Database name
 - `stores`: Array of store configurations
-- `version`: Database version (optional, default: 1)
+- `version`: Database version (optional, default: `undefined`)
 
 **Returns:** Promise resolving to `IDBDatabase` instance
 

package/dist/index.cjs

@@ -327,6 +327,15 @@ function _formatUUID(h, v, up) {
 function _abortTransaction(error, reject) {
 	reject(error || /* @__PURE__ */ new Error("IndexedDB transaction was aborted!"));
 }
+/** Ensure `IndexedDB` is supported in the current environment */
+function _ensureIndexedDB() {
+	if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
+}
+/** Get the list of existing `IndexedDB` databases */
+async function _getDBList() {
+	if (!("databases" in window.indexedDB)) return [];
+	return await window.indexedDB.databases();
+}
 
 //#endregion
 //#region src/factory.ts
@@ -334,13 +343,13 @@ function _abortTransaction(error, reject) {
 * * Opens an `IndexedDB` database instance with the specified stores.
 * @param name Database name
 * @param stores Array of store configurations
-* @param version Database version (default is `1`)
+* @param version Database version (default is `undefined`)
 * @returns Promise that resolves to the opened {@link IDBDatabase} instance.
 */
 function openDBWithStores(name, stores, version) {
 	return new Promise((resolve, reject) => {
-		if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
-		const request = isNaN(Number(version)) ? window.indexedDB.open(name) : window.indexedDB.open(name, version);
+		_ensureIndexedDB();
+		const request = window.indexedDB.open(name, isNumber(version) ? version : void 0);
 		request.onupgradeneeded = (event) => {
 			const $request = event.target;
 			const db = $request.result;
@@ -409,15 +418,14 @@ function isTimestamp(value) {
 * @returns A promise that resolves when the database is deleted
 * @throws Error if `IndexedDB` is not supported or if the database does not exist
 */
-function deleteDB(name) {
+async function deleteDB(name) {
+	_ensureIndexedDB();
+	const dbList = await _getDBList();
 	return new Promise((resolve, reject) => {
-		if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
-		if ("databases" in window.indexedDB) window.indexedDB.databases().then((dbs) => {
-			if (!dbs.some((db) => db.name === name)) {
-				reject(/* @__PURE__ */ new Error(`Database '${name}' does not exist in this system!`));
-				return;
-			}
-		}).catch(reject);
+		if (!dbList.some((db) => db.name === name)) {
+			reject(/* @__PURE__ */ new Error(`Database '${name}' does not exist in this system!`));
+			return;
+		}
 		const request = window.indexedDB.deleteDatabase(name);
 		request.onsuccess = () => resolve();
 		request.onerror = () => reject(request.error);
@@ -1135,7 +1143,7 @@ var DeleteQuery = class {
 * // Delete a user
 * const deleted = await db.delete('users').where((user) => user.id === 1).run();
 */
-var Locality = class {
+var Locality = class Locality {
 	#name;
 	#schema;
 	#keyPaths;
@@ -1158,9 +1166,6 @@ var Locality = class {
 			this.#version = this.#db?.version;
 		});
 	}
-	get version() {
-		return this.#db?.version ?? this.#version ?? this.#configVersion;
-	}
 	/** Build store configurations from schema. */
 	#buildStoresConfig() {
 		return Object.entries(this.#schema).map(([tableName, table]) => {
@@ -1194,6 +1199,17 @@ var Locality = class {
 		const columns = this.#schema[table].columns;
 		return Object.entries(columns).find(([_, col]) => col[IsPrimaryKey])?.[0];
 	}
+	get version() {
+		return this.#db?.version ?? this.#version ?? this.#configVersion;
+	}
+	/** @instance Get all table (store) names in the current database. */
+	get tableList() {
+		return Array.from(this.#db.objectStoreNames);
+	}
+	/** @instance Get the list of existing `IndexedDB` databases. */
+	get dbList() {
+		return Locality.getDatabaseList();
+	}
 	/** @instance Waits for database initialization to complete. */
 	async ready() {
 		return this.#readyPromise;
@@ -1243,7 +1259,7 @@ var Locality = class {
 	/** @instance Closes and deletes the entire database. */
 	async deleteDB() {
 		this.#db.close();
-		return await deleteDB(this.#name);
+		await deleteDB(this.#name);
 	}
 	/** @instance Closes the current database connection. */
 	close() {
@@ -1416,6 +1432,15 @@ var Locality = class {
 		document.body.removeChild(link);
 		URL.revokeObjectURL(url);
 	}
+	/** @static Get the list of existing `IndexedDB` databases. */
+	static getDatabaseList() {
+		_ensureIndexedDB();
+		return _getDBList();
+	}
+	/** @static Delete an `IndexedDB` database by name. */
+	static async deleteDatabase(name) {
+		await deleteDB(name);
+	}
 };
 
 //#endregion

package/dist/index.d.cts

@@ -644,6 +644,10 @@ declare class Locality<DBName extends string = string, Version extends number =
   #private;
   constructor(config: LocalityConfig<DBName, Version, Schema>);
   get version(): Version;
+  /** @instance Get all table (store) names in the current database. */
+  get tableList(): LooseLiteral<TName>[];
+  /** @instance Get the list of existing `IndexedDB` databases. */
+  get dbList(): Promise<IDBDatabaseInfo[]>;
   /** @instance Waits for database initialization to complete. */
   ready(): Promise<void>;
   /**
@@ -787,6 +791,10 @@ declare class Locality<DBName extends string = string, Version extends number =
    * await db.export({ pretty: false });
    */
   export(options?: ExportOptions<TName>): Promise<void>;
+  /** @static Get the list of existing `IndexedDB` databases. */
+  static getDatabaseList(): Promise<IDBDatabaseInfo[]>;
+  /** @static Delete an `IndexedDB` database by name. */
+  static deleteDatabase(name: string): Promise<void>;
 }
 //#endregion
 //#region src/factory.d.ts
@@ -794,7 +802,7 @@ declare class Locality<DBName extends string = string, Version extends number =
  * * Opens an `IndexedDB` database instance with the specified stores.
  * @param name Database name
  * @param stores Array of store configurations
- * @param version Database version (default is `1`)
+ * @param version Database version (default is `undefined`)
  * @returns Promise that resolves to the opened {@link IDBDatabase} instance.
  */
 declare function openDBWithStores(name: string, stores: StoreConfig[], version?: number): Promise<IDBDatabase>;

package/dist/index.d.mts

@@ -644,6 +644,10 @@ declare class Locality<DBName extends string = string, Version extends number =
   #private;
   constructor(config: LocalityConfig<DBName, Version, Schema>);
   get version(): Version;
+  /** @instance Get all table (store) names in the current database. */
+  get tableList(): LooseLiteral<TName>[];
+  /** @instance Get the list of existing `IndexedDB` databases. */
+  get dbList(): Promise<IDBDatabaseInfo[]>;
   /** @instance Waits for database initialization to complete. */
   ready(): Promise<void>;
   /**
@@ -787,6 +791,10 @@ declare class Locality<DBName extends string = string, Version extends number =
    * await db.export({ pretty: false });
    */
   export(options?: ExportOptions<TName>): Promise<void>;
+  /** @static Get the list of existing `IndexedDB` databases. */
+  static getDatabaseList(): Promise<IDBDatabaseInfo[]>;
+  /** @static Delete an `IndexedDB` database by name. */
+  static deleteDatabase(name: string): Promise<void>;
 }
 //#endregion
 //#region src/factory.d.ts
@@ -794,7 +802,7 @@ declare class Locality<DBName extends string = string, Version extends number =
  * * Opens an `IndexedDB` database instance with the specified stores.
  * @param name Database name
  * @param stores Array of store configurations
- * @param version Database version (default is `1`)
+ * @param version Database version (default is `undefined`)
  * @returns Promise that resolves to the opened {@link IDBDatabase} instance.
  */
 declare function openDBWithStores(name: string, stores: StoreConfig[], version?: number): Promise<IDBDatabase>;

package/dist/index.iife.js

@@ -329,6 +329,15 @@ var LocalityIDB = (function(exports) {
 	function _abortTransaction(error, reject) {
 		reject(error || /* @__PURE__ */ new Error("IndexedDB transaction was aborted!"));
 	}
+	/** Ensure `IndexedDB` is supported in the current environment */
+	function _ensureIndexedDB() {
+		if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
+	}
+	/** Get the list of existing `IndexedDB` databases */
+	async function _getDBList() {
+		if (!("databases" in window.indexedDB)) return [];
+		return await window.indexedDB.databases();
+	}
 
 //#endregion
 //#region src/factory.ts
@@ -336,13 +345,13 @@ var LocalityIDB = (function(exports) {
 	* * Opens an `IndexedDB` database instance with the specified stores.
 	* @param name Database name
 	* @param stores Array of store configurations
-	* @param version Database version (default is `1`)
+	* @param version Database version (default is `undefined`)
 	* @returns Promise that resolves to the opened {@link IDBDatabase} instance.
 	*/
 	function openDBWithStores(name, stores, version) {
 		return new Promise((resolve, reject) => {
-			if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
-			const request = isNaN(Number(version)) ? window.indexedDB.open(name) : window.indexedDB.open(name, version);
+			_ensureIndexedDB();
+			const request = window.indexedDB.open(name, isNumber(version) ? version : void 0);
 			request.onupgradeneeded = (event) => {
 				const $request = event.target;
 				const db = $request.result;
@@ -411,15 +420,14 @@ var LocalityIDB = (function(exports) {
 	* @returns A promise that resolves when the database is deleted
 	* @throws Error if `IndexedDB` is not supported or if the database does not exist
 	*/
-	function deleteDB(name) {
+	async function deleteDB(name) {
+		_ensureIndexedDB();
+		const dbList = await _getDBList();
 		return new Promise((resolve, reject) => {
-			if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
-			if ("databases" in window.indexedDB) window.indexedDB.databases().then((dbs) => {
-				if (!dbs.some((db) => db.name === name)) {
-					reject(/* @__PURE__ */ new Error(`Database '${name}' does not exist in this system!`));
-					return;
-				}
-			}).catch(reject);
+			if (!dbList.some((db) => db.name === name)) {
+				reject(/* @__PURE__ */ new Error(`Database '${name}' does not exist in this system!`));
+				return;
+			}
 			const request = window.indexedDB.deleteDatabase(name);
 			request.onsuccess = () => resolve();
 			request.onerror = () => reject(request.error);
@@ -1137,7 +1145,7 @@ var LocalityIDB = (function(exports) {
 	* // Delete a user
 	* const deleted = await db.delete('users').where((user) => user.id === 1).run();
 	*/
-	var Locality = class {
+	var Locality = class Locality {
 		#name;
 		#schema;
 		#keyPaths;
@@ -1160,9 +1168,6 @@ var LocalityIDB = (function(exports) {
 				this.#version = this.#db?.version;
 			});
 		}
-		get version() {
-			return this.#db?.version ?? this.#version ?? this.#configVersion;
-		}
 		/** Build store configurations from schema. */
 		#buildStoresConfig() {
 			return Object.entries(this.#schema).map(([tableName, table]) => {
@@ -1196,6 +1201,17 @@ var LocalityIDB = (function(exports) {
 			const columns = this.#schema[table].columns;
 			return Object.entries(columns).find(([_, col]) => col[IsPrimaryKey])?.[0];
 		}
+		get version() {
+			return this.#db?.version ?? this.#version ?? this.#configVersion;
+		}
+		/** @instance Get all table (store) names in the current database. */
+		get tableList() {
+			return Array.from(this.#db.objectStoreNames);
+		}
+		/** @instance Get the list of existing `IndexedDB` databases. */
+		get dbList() {
+			return Locality.getDatabaseList();
+		}
 		/** @instance Waits for database initialization to complete. */
 		async ready() {
 			return this.#readyPromise;
@@ -1245,7 +1261,7 @@ var LocalityIDB = (function(exports) {
 		/** @instance Closes and deletes the entire database. */
 		async deleteDB() {
 			this.#db.close();
-			return await deleteDB(this.#name);
+			await deleteDB(this.#name);
 		}
 		/** @instance Closes the current database connection. */
 		close() {
@@ -1418,6 +1434,15 @@ var LocalityIDB = (function(exports) {
 			document.body.removeChild(link);
 			URL.revokeObjectURL(url);
 		}
+		/** @static Get the list of existing `IndexedDB` databases. */
+		static getDatabaseList() {
+			_ensureIndexedDB();
+			return _getDBList();
+		}
+		/** @static Delete an `IndexedDB` database by name. */
+		static async deleteDatabase(name) {
+			await deleteDB(name);
+		}
 	};
 
 //#endregion

package/dist/index.mjs

@@ -326,6 +326,15 @@ function _formatUUID(h, v, up) {
 function _abortTransaction(error, reject) {
 	reject(error || /* @__PURE__ */ new Error("IndexedDB transaction was aborted!"));
 }
+/** Ensure `IndexedDB` is supported in the current environment */
+function _ensureIndexedDB() {
+	if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
+}
+/** Get the list of existing `IndexedDB` databases */
+async function _getDBList() {
+	if (!("databases" in window.indexedDB)) return [];
+	return await window.indexedDB.databases();
+}
 
 //#endregion
 //#region src/factory.ts
@@ -333,13 +342,13 @@ function _abortTransaction(error, reject) {
 * * Opens an `IndexedDB` database instance with the specified stores.
 * @param name Database name
 * @param stores Array of store configurations
-* @param version Database version (default is `1`)
+* @param version Database version (default is `undefined`)
 * @returns Promise that resolves to the opened {@link IDBDatabase} instance.
 */
 function openDBWithStores(name, stores, version) {
 	return new Promise((resolve, reject) => {
-		if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
-		const request = isNaN(Number(version)) ? window.indexedDB.open(name) : window.indexedDB.open(name, version);
+		_ensureIndexedDB();
+		const request = window.indexedDB.open(name, isNumber(version) ? version : void 0);
 		request.onupgradeneeded = (event) => {
 			const $request = event.target;
 			const db = $request.result;
@@ -408,15 +417,14 @@ function isTimestamp(value) {
 * @returns A promise that resolves when the database is deleted
 * @throws Error if `IndexedDB` is not supported or if the database does not exist
 */
-function deleteDB(name) {
+async function deleteDB(name) {
+	_ensureIndexedDB();
+	const dbList = await _getDBList();
 	return new Promise((resolve, reject) => {
-		if (!window.indexedDB) throw new Error("IndexedDB is not supported in this environment or browser!");
-		if ("databases" in window.indexedDB) window.indexedDB.databases().then((dbs) => {
-			if (!dbs.some((db) => db.name === name)) {
-				reject(/* @__PURE__ */ new Error(`Database '${name}' does not exist in this system!`));
-				return;
-			}
-		}).catch(reject);
+		if (!dbList.some((db) => db.name === name)) {
+			reject(/* @__PURE__ */ new Error(`Database '${name}' does not exist in this system!`));
+			return;
+		}
 		const request = window.indexedDB.deleteDatabase(name);
 		request.onsuccess = () => resolve();
 		request.onerror = () => reject(request.error);
@@ -1134,7 +1142,7 @@ var DeleteQuery = class {
 * // Delete a user
 * const deleted = await db.delete('users').where((user) => user.id === 1).run();
 */
-var Locality = class {
+var Locality = class Locality {
 	#name;
 	#schema;
 	#keyPaths;
@@ -1157,9 +1165,6 @@ var Locality = class {
 			this.#version = this.#db?.version;
 		});
 	}
-	get version() {
-		return this.#db?.version ?? this.#version ?? this.#configVersion;
-	}
 	/** Build store configurations from schema. */
 	#buildStoresConfig() {
 		return Object.entries(this.#schema).map(([tableName, table]) => {
@@ -1193,6 +1198,17 @@ var Locality = class {
 		const columns = this.#schema[table].columns;
 		return Object.entries(columns).find(([_, col]) => col[IsPrimaryKey])?.[0];
 	}
+	get version() {
+		return this.#db?.version ?? this.#version ?? this.#configVersion;
+	}
+	/** @instance Get all table (store) names in the current database. */
+	get tableList() {
+		return Array.from(this.#db.objectStoreNames);
+	}
+	/** @instance Get the list of existing `IndexedDB` databases. */
+	get dbList() {
+		return Locality.getDatabaseList();
+	}
 	/** @instance Waits for database initialization to complete. */
 	async ready() {
 		return this.#readyPromise;
@@ -1242,7 +1258,7 @@ var Locality = class {
 	/** @instance Closes and deletes the entire database. */
 	async deleteDB() {
 		this.#db.close();
-		return await deleteDB(this.#name);
+		await deleteDB(this.#name);
 	}
 	/** @instance Closes the current database connection. */
 	close() {
@@ -1415,6 +1431,15 @@ var Locality = class {
 		document.body.removeChild(link);
 		URL.revokeObjectURL(url);
 	}
+	/** @static Get the list of existing `IndexedDB` databases. */
+	static getDatabaseList() {
+		_ensureIndexedDB();
+		return _getDBList();
+	}
+	/** @static Delete an `IndexedDB` database by name. */
+	static async deleteDatabase(name) {
+		await deleteDB(name);
+	}
 };
 
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locality-idb",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "SQL-like query builder for IndexedDB with Drizzle-style API",
   "type": "module",
   "sideEffects": false,