tiny-essentials 1.19.2 → 1.19.3

package/dist/v1/libs/TinyLocalStorage.cjs

@@ -421,6 +421,12 @@ class TinyLocalStorage {
   /** @type {Storage} */
   #localStorage = window.localStorage;
 
+  /** @type {string|null} */
+  #dbKey = null;
+
+  /** @type {number} */
+  #version = 0;
+
   /** @type {(ev: StorageEvent) => any} */
   #storageEvent = (ev) => this.emit('storage', ev);
 
@@ -428,11 +434,84 @@ class TinyLocalStorage {
    * Initializes the TinyLocalStorage instance and sets up cross-tab sync.
    *
    * Adds listener for the native `storage` event to support tab synchronization.
+   * @param {string} [dbName] - Unique database name.
    */
-  constructor() {
+  constructor(dbName) {
+    if (typeof dbName !== 'undefined' && typeof dbName !== 'string')
+      throw new TypeError('TinyLocalStorage: dbName must be a string if provided.');
+    if (typeof dbName === 'string') this.#dbKey = `LSDB::${dbName}`;
     window.addEventListener('storage', this.#storageEvent);
   }
 
+  /**
+   * Validates that a given key does not conflict with internal database keys.
+   *
+   * This method is used to prevent accidental overwriting of reserved `LSDB::` keys
+   * in `localStorage`, which are used internally by TinyLocalStorage for versioning
+   * and data management.
+   *
+   * @param {string} name - The key to validate before writing to localStorage.
+   * @throws {Error} If the key starts with `LSDB::`.
+   */
+  #isProtectedDbKey(name) {
+    if (typeof name === 'string' && name.startsWith('LSDB::'))
+      throw new Error(`TinyLocalStorage: Key "${name}" may conflict with reserved dbKeys.`);
+  }
+
+  /**
+   * Updates the version of the storage and triggers migration if needed.
+   *
+   * @param {number} version - Desired version of the database.
+   * @param {(oldVersion: number, newVersion: number) => void} onUpgrade - Callback to perform migration logic.
+   * @throws {Error} If the database key has not been initialized.
+   * @throws {TypeError} If `version` is not a valid positive number.
+   * @throws {TypeError} If `onUpgrade` is not a function.
+   */
+  updateStorageVersion(version, onUpgrade) {
+    if (typeof this.#dbKey !== 'string')
+      throw new Error(
+        'TinyLocalStorage: Database key is not initialized. Set a valid dbName in the constructor.',
+      );
+    if (typeof version !== 'number' || Number.isNaN(version) || version < 1)
+      throw new TypeError('TinyLocalStorage: version must be a positive number.');
+    if (typeof onUpgrade !== 'function')
+      throw new TypeError('TinyLocalStorage: onUpgrade must be a function.');
+
+    // @ts-ignore
+    const savedVersion = parseInt(localStorage.getItem(this.#dbKey), 10) || 0;
+    if (typeof savedVersion !== 'number' || Number.isNaN(savedVersion) || savedVersion < 0)
+      throw new TypeError('TinyLocalStorage: saved version in localStorage is not a valid number.');
+
+    if (version < savedVersion)
+      throw new Error(
+        `TinyLocalStorage: Cannot downgrade database version from ${savedVersion} to ${version}.`,
+      );
+
+    if (version > savedVersion) {
+      onUpgrade(savedVersion, version);
+      localStorage.setItem(this.#dbKey, String(version));
+      this.#version = version;
+    }
+  }
+
+  /**
+   * Gets the current database key used in localStorage.
+   *
+   * @returns {string|null} The database key, or null if not set.
+   */
+  getDbKey() {
+    return this.#dbKey;
+  }
+
+  /**
+   * Gets the current version of the database.
+   *
+   * @returns {number} The current version number.
+   */
+  getVersion() {
+    return this.#version;
+  }
+
   /**
    * Defines a custom storage interface (e.g. `sessionStorage`).
    *
@@ -440,7 +519,7 @@ class TinyLocalStorage {
    */
   setLocalStorage(localstorage) {
     if (!(localstorage instanceof Storage))
-      throw new Error('Argument must be a valid instance of Storage.');
+      throw new TypeError('Argument must be a valid instance of Storage.');
     this.#localStorage = localstorage;
   }
 
@@ -462,7 +541,7 @@ class TinyLocalStorage {
    */
   #setJson(name, data) {
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
+      throw new TypeError('Key must be a non-empty string.');
     return TinyLocalStorage.encodeSpecialJson(data);
   }
 
@@ -475,13 +554,14 @@ class TinyLocalStorage {
    * @param {LocalStorageJsonValue} data - The data to be serialized and stored.
    */
   setJson(name, data) {
+    this.#isProtectedDbKey(name);
     if (
       !objChecker.isJsonObject(data) &&
       !Array.isArray(data) &&
       !(data instanceof Map) &&
       !(data instanceof Set)
     ) {
-      throw new Error('The storage value is not a valid JSON-compatible structure.');
+      throw new TypeError('The storage value is not a valid JSON-compatible structure.');
     }
     const encoded = this.#setJson(name, data);
     this.emit('setJson', name, data);
@@ -499,7 +579,7 @@ class TinyLocalStorage {
    */
   #getJson(name, defaultData) {
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
+      throw new TypeError('Key must be a non-empty string.');
 
     const raw = this.#localStorage.getItem(name);
     const fallbackTypes = {
@@ -553,7 +633,8 @@ class TinyLocalStorage {
    * @param {Date} data
    */
   setDate(name, data) {
-    if (!(data instanceof Date)) throw new Error('Value must be a Date.');
+    this.#isProtectedDbKey(name);
+    if (!(data instanceof Date)) throw new TypeError('Value must be a Date.');
     const encoded = this.#setJson(name, data);
     this.emit('setDate', name, data);
     return this.#localStorage.setItem(name, JSON.stringify(encoded));
@@ -575,7 +656,8 @@ class TinyLocalStorage {
    * @param {RegExp} data
    */
   setRegExp(name, data) {
-    if (!(data instanceof RegExp)) throw new Error('Value must be a RegExp.');
+    this.#isProtectedDbKey(name);
+    if (!(data instanceof RegExp)) throw new TypeError('Value must be a RegExp.');
     const encoded = this.#setJson(name, data);
     this.emit('setRegExp', name, data);
     return this.#localStorage.setItem(name, JSON.stringify(encoded));
@@ -597,7 +679,8 @@ class TinyLocalStorage {
    * @param {bigint} data
    */
   setBigInt(name, data) {
-    if (typeof data !== 'bigint') throw new Error('Value must be a BigInt.');
+    this.#isProtectedDbKey(name);
+    if (typeof data !== 'bigint') throw new TypeError('Value must be a BigInt.');
     const encoded = this.#setJson(name, data);
     this.emit('setBigInt', name, data);
     return this.#localStorage.setItem(name, JSON.stringify(encoded));
@@ -620,7 +703,8 @@ class TinyLocalStorage {
    * @param {symbol} data
    */
   setSymbol(name, data) {
-    if (typeof data !== 'symbol') throw new Error('Value must be a Symbol.');
+    this.#isProtectedDbKey(name);
+    if (typeof data !== 'symbol') throw new TypeError('Value must be a Symbol.');
     const encoded = this.#setJson(name, data);
     this.emit('setSymbol', name, data);
     return this.#localStorage.setItem(name, JSON.stringify(encoded));
@@ -653,8 +737,9 @@ class TinyLocalStorage {
    * @param {any} data - The data to store.
    */
   setItem(name, data) {
+    this.#isProtectedDbKey(name);
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
+      throw new TypeError('Key must be a non-empty string.');
     this.emit('setItem', name, data);
     return this.#localStorage.setItem(name, data);
   }
@@ -667,7 +752,7 @@ class TinyLocalStorage {
    */
   getItem(name) {
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
+      throw new TypeError('Key must be a non-empty string.');
     return this.#localStorage.getItem(name);
   }
 
@@ -678,9 +763,10 @@ class TinyLocalStorage {
    * @param {string} data - The string to store.
    */
   setString(name, data) {
+    this.#isProtectedDbKey(name);
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
-    if (typeof data !== 'string') throw new Error('Value must be a string.');
+      throw new TypeError('Key must be a non-empty string.');
+    if (typeof data !== 'string') throw new TypeError('Value must be a string.');
 
     this.emit('setString', name, data);
     return this.#localStorage.setItem(
@@ -700,7 +786,7 @@ class TinyLocalStorage {
    */
   getString(name) {
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
+      throw new TypeError('Key must be a non-empty string.');
     let value = this.#localStorage.getItem(name);
     try {
       /** @type {{ value: string; __string__: boolean }} */
@@ -722,9 +808,10 @@ class TinyLocalStorage {
    * @param {number} data - The number to store.
    */
   setNumber(name, data) {
+    this.#isProtectedDbKey(name);
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
-    if (typeof data !== 'number') throw new Error('Value must be a number.');
+      throw new TypeError('Key must be a non-empty string.');
+    if (typeof data !== 'number') throw new TypeError('Value must be a number.');
     this.emit('setNumber', name, data);
     return this.#localStorage.setItem(name, String(data));
   }
@@ -737,7 +824,7 @@ class TinyLocalStorage {
    */
   getNumber(name) {
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
+      throw new TypeError('Key must be a non-empty string.');
 
     /** @type {number|string|null} */
     let number = this.#localStorage.getItem(name);
@@ -756,9 +843,10 @@ class TinyLocalStorage {
    * @param {boolean} data - The boolean value to store.
    */
   setBool(name, data) {
+    this.#isProtectedDbKey(name);
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
-    if (typeof data !== 'boolean') throw new Error('Value must be a boolean.');
+      throw new TypeError('Key must be a non-empty string.');
+    if (typeof data !== 'boolean') throw new TypeError('Value must be a boolean.');
     this.emit('setBool', name, data);
     return this.#localStorage.setItem(name, String(data));
   }
@@ -771,7 +859,7 @@ class TinyLocalStorage {
    */
   getBool(name) {
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
+      throw new TypeError('Key must be a non-empty string.');
 
     const value = this.#localStorage.getItem(name);
     if (typeof value === 'boolean') return value;
@@ -790,7 +878,7 @@ class TinyLocalStorage {
    */
   removeItem(name) {
     if (typeof name !== 'string' || !name.length)
-      throw new Error('Key must be a non-empty string.');
+      throw new TypeError('Key must be a non-empty string.');
 
     this.emit('removeItem', name);
     return this.#localStorage.removeItem(name);

package/dist/v1/libs/TinyLocalStorage.d.mts

@@ -130,6 +130,13 @@ declare class TinyLocalStorage {
     static deleteJsonType(type: any): boolean;
     static encodeSpecialJson(value: any): any;
     static decodeSpecialJson(value: any): any;
+    /**
+     * Initializes the TinyLocalStorage instance and sets up cross-tab sync.
+     *
+     * Adds listener for the native `storage` event to support tab synchronization.
+     * @param {string} [dbName] - Unique database name.
+     */
+    constructor(dbName?: string);
     /**
      * Enables or disables throwing an error when the maximum number of listeners is exceeded.
      *
@@ -258,6 +265,28 @@ declare class TinyLocalStorage {
      * @returns {number} The maximum number of listeners.
      */
     getMaxListeners(): number;
+    /**
+     * Updates the version of the storage and triggers migration if needed.
+     *
+     * @param {number} version - Desired version of the database.
+     * @param {(oldVersion: number, newVersion: number) => void} onUpgrade - Callback to perform migration logic.
+     * @throws {Error} If the database key has not been initialized.
+     * @throws {TypeError} If `version` is not a valid positive number.
+     * @throws {TypeError} If `onUpgrade` is not a function.
+     */
+    updateStorageVersion(version: number, onUpgrade: (oldVersion: number, newVersion: number) => void): void;
+    /**
+     * Gets the current database key used in localStorage.
+     *
+     * @returns {string|null} The database key, or null if not set.
+     */
+    getDbKey(): string | null;
+    /**
+     * Gets the current version of the database.
+     *
+     * @returns {number} The current version number.
+     */
+    getVersion(): number;
     /**
      * Defines a custom storage interface (e.g. `sessionStorage`).
      *

package/dist/v1/libs/TinyLocalStorage.mjs

@@ -375,16 +375,83 @@ class TinyLocalStorage {
     //////////////////////////////////////////////////////
     /** @type {Storage} */
     #localStorage = window.localStorage;
+    /** @type {string|null} */
+    #dbKey = null;
+    /** @type {number} */
+    #version = 0;
     /** @type {(ev: StorageEvent) => any} */
     #storageEvent = (ev) => this.emit('storage', ev);
     /**
      * Initializes the TinyLocalStorage instance and sets up cross-tab sync.
      *
      * Adds listener for the native `storage` event to support tab synchronization.
+     * @param {string} [dbName] - Unique database name.
      */
-    constructor() {
+    constructor(dbName) {
+        if (typeof dbName !== 'undefined' && typeof dbName !== 'string')
+            throw new TypeError('TinyLocalStorage: dbName must be a string if provided.');
+        if (typeof dbName === 'string')
+            this.#dbKey = `LSDB::${dbName}`;
         window.addEventListener('storage', this.#storageEvent);
     }
+    /**
+     * Validates that a given key does not conflict with internal database keys.
+     *
+     * This method is used to prevent accidental overwriting of reserved `LSDB::` keys
+     * in `localStorage`, which are used internally by TinyLocalStorage for versioning
+     * and data management.
+     *
+     * @param {string} name - The key to validate before writing to localStorage.
+     * @throws {Error} If the key starts with `LSDB::`.
+     */
+    #isProtectedDbKey(name) {
+        if (typeof name === 'string' && name.startsWith('LSDB::'))
+            throw new Error(`TinyLocalStorage: Key "${name}" may conflict with reserved dbKeys.`);
+    }
+    /**
+     * Updates the version of the storage and triggers migration if needed.
+     *
+     * @param {number} version - Desired version of the database.
+     * @param {(oldVersion: number, newVersion: number) => void} onUpgrade - Callback to perform migration logic.
+     * @throws {Error} If the database key has not been initialized.
+     * @throws {TypeError} If `version` is not a valid positive number.
+     * @throws {TypeError} If `onUpgrade` is not a function.
+     */
+    updateStorageVersion(version, onUpgrade) {
+        if (typeof this.#dbKey !== 'string')
+            throw new Error('TinyLocalStorage: Database key is not initialized. Set a valid dbName in the constructor.');
+        if (typeof version !== 'number' || Number.isNaN(version) || version < 1)
+            throw new TypeError('TinyLocalStorage: version must be a positive number.');
+        if (typeof onUpgrade !== 'function')
+            throw new TypeError('TinyLocalStorage: onUpgrade must be a function.');
+        // @ts-ignore
+        const savedVersion = parseInt(localStorage.getItem(this.#dbKey), 10) || 0;
+        if (typeof savedVersion !== 'number' || Number.isNaN(savedVersion) || savedVersion < 0)
+            throw new TypeError('TinyLocalStorage: saved version in localStorage is not a valid number.');
+        if (version < savedVersion)
+            throw new Error(`TinyLocalStorage: Cannot downgrade database version from ${savedVersion} to ${version}.`);
+        if (version > savedVersion) {
+            onUpgrade(savedVersion, version);
+            localStorage.setItem(this.#dbKey, String(version));
+            this.#version = version;
+        }
+    }
+    /**
+     * Gets the current database key used in localStorage.
+     *
+     * @returns {string|null} The database key, or null if not set.
+     */
+    getDbKey() {
+        return this.#dbKey;
+    }
+    /**
+     * Gets the current version of the database.
+     *
+     * @returns {number} The current version number.
+     */
+    getVersion() {
+        return this.#version;
+    }
     /**
      * Defines a custom storage interface (e.g. `sessionStorage`).
      *
@@ -392,7 +459,7 @@ class TinyLocalStorage {
      */
     setLocalStorage(localstorage) {
         if (!(localstorage instanceof Storage))
-            throw new Error('Argument must be a valid instance of Storage.');
+            throw new TypeError('Argument must be a valid instance of Storage.');
         this.#localStorage = localstorage;
     }
     /**
@@ -412,7 +479,7 @@ class TinyLocalStorage {
      */
     #setJson(name, data) {
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         return TinyLocalStorage.encodeSpecialJson(data);
     }
     /**
@@ -424,11 +491,12 @@ class TinyLocalStorage {
      * @param {LocalStorageJsonValue} data - The data to be serialized and stored.
      */
     setJson(name, data) {
+        this.#isProtectedDbKey(name);
         if (!isJsonObject(data) &&
             !Array.isArray(data) &&
             !(data instanceof Map) &&
             !(data instanceof Set)) {
-            throw new Error('The storage value is not a valid JSON-compatible structure.');
+            throw new TypeError('The storage value is not a valid JSON-compatible structure.');
         }
         const encoded = this.#setJson(name, data);
         this.emit('setJson', name, data);
@@ -445,7 +513,7 @@ class TinyLocalStorage {
      */
     #getJson(name, defaultData) {
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         const raw = this.#localStorage.getItem(name);
         const fallbackTypes = {
             obj: () => ({}),
@@ -491,8 +559,9 @@ class TinyLocalStorage {
      * @param {Date} data
      */
     setDate(name, data) {
+        this.#isProtectedDbKey(name);
         if (!(data instanceof Date))
-            throw new Error('Value must be a Date.');
+            throw new TypeError('Value must be a Date.');
         const encoded = this.#setJson(name, data);
         this.emit('setDate', name, data);
         return this.#localStorage.setItem(name, JSON.stringify(encoded));
@@ -512,8 +581,9 @@ class TinyLocalStorage {
      * @param {RegExp} data
      */
     setRegExp(name, data) {
+        this.#isProtectedDbKey(name);
         if (!(data instanceof RegExp))
-            throw new Error('Value must be a RegExp.');
+            throw new TypeError('Value must be a RegExp.');
         const encoded = this.#setJson(name, data);
         this.emit('setRegExp', name, data);
         return this.#localStorage.setItem(name, JSON.stringify(encoded));
@@ -533,8 +603,9 @@ class TinyLocalStorage {
      * @param {bigint} data
      */
     setBigInt(name, data) {
+        this.#isProtectedDbKey(name);
         if (typeof data !== 'bigint')
-            throw new Error('Value must be a BigInt.');
+            throw new TypeError('Value must be a BigInt.');
         const encoded = this.#setJson(name, data);
         this.emit('setBigInt', name, data);
         return this.#localStorage.setItem(name, JSON.stringify(encoded));
@@ -555,8 +626,9 @@ class TinyLocalStorage {
      * @param {symbol} data
      */
     setSymbol(name, data) {
+        this.#isProtectedDbKey(name);
         if (typeof data !== 'symbol')
-            throw new Error('Value must be a Symbol.');
+            throw new TypeError('Value must be a Symbol.');
         const encoded = this.#setJson(name, data);
         this.emit('setSymbol', name, data);
         return this.#localStorage.setItem(name, JSON.stringify(encoded));
@@ -586,8 +658,9 @@ class TinyLocalStorage {
      * @param {any} data - The data to store.
      */
     setItem(name, data) {
+        this.#isProtectedDbKey(name);
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         this.emit('setItem', name, data);
         return this.#localStorage.setItem(name, data);
     }
@@ -599,7 +672,7 @@ class TinyLocalStorage {
      */
     getItem(name) {
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         return this.#localStorage.getItem(name);
     }
     /**
@@ -609,10 +682,11 @@ class TinyLocalStorage {
      * @param {string} data - The string to store.
      */
     setString(name, data) {
+        this.#isProtectedDbKey(name);
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         if (typeof data !== 'string')
-            throw new Error('Value must be a string.');
+            throw new TypeError('Value must be a string.');
         this.emit('setString', name, data);
         return this.#localStorage.setItem(name, JSON.stringify({
             __string__: true,
@@ -627,7 +701,7 @@ class TinyLocalStorage {
      */
     getString(name) {
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         let value = this.#localStorage.getItem(name);
         try {
             /** @type {{ value: string; __string__: boolean }} */
@@ -651,10 +725,11 @@ class TinyLocalStorage {
      * @param {number} data - The number to store.
      */
     setNumber(name, data) {
+        this.#isProtectedDbKey(name);
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         if (typeof data !== 'number')
-            throw new Error('Value must be a number.');
+            throw new TypeError('Value must be a number.');
         this.emit('setNumber', name, data);
         return this.#localStorage.setItem(name, String(data));
     }
@@ -666,7 +741,7 @@ class TinyLocalStorage {
      */
     getNumber(name) {
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         /** @type {number|string|null} */
         let number = this.#localStorage.getItem(name);
         if (typeof number === 'number')
@@ -685,10 +760,11 @@ class TinyLocalStorage {
      * @param {boolean} data - The boolean value to store.
      */
     setBool(name, data) {
+        this.#isProtectedDbKey(name);
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         if (typeof data !== 'boolean')
-            throw new Error('Value must be a boolean.');
+            throw new TypeError('Value must be a boolean.');
         this.emit('setBool', name, data);
         return this.#localStorage.setItem(name, String(data));
     }
@@ -700,7 +776,7 @@ class TinyLocalStorage {
      */
     getBool(name) {
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         const value = this.#localStorage.getItem(name);
         if (typeof value === 'boolean')
             return value;
@@ -719,7 +795,7 @@ class TinyLocalStorage {
      */
     removeItem(name) {
         if (typeof name !== 'string' || !name.length)
-            throw new Error('Key must be a non-empty string.');
+            throw new TypeError('Key must be a non-empty string.');
         this.emit('removeItem', name);
         return this.#localStorage.removeItem(name);
     }

package/docs/v1/libs/TinyLocalStorage.md

@@ -32,6 +32,59 @@ console.log(storage.getDate('today') instanceof Date); // true
 
 ---
 
+## 🏁 `constructor(dbName?: string)`
+
+Initializes the `TinyLocalStorage` instance and sets up cross-tab synchronization.
+
+### 🔧 Parameters
+
+* `dbName` (optional, `string`) – A unique name for the database. It becomes the base key used internally in `localStorage`.
+
+### 📡 Behavior
+
+* Automatically adds a `storage` event listener to support syncing across browser tabs.
+
+---
+
+## 🔁 `updateStorageVersion(version: number, onUpgrade: (oldVersion: number, newVersion: number) => void)`
+
+Updates the version of the database. If the new version is higher than the current one, it triggers the provided migration callback.
+
+### 🔧 Parameters
+
+* `version` (`number`) – The desired new version of the database. Must be a positive integer.
+* `onUpgrade` (`function`) – A callback function executed during upgrade. Receives `oldVersion` and `newVersion` as arguments.
+
+### ⚠️ Throws
+
+* `Error` – If the database key hasn't been initialized via the constructor.
+* `TypeError` – If `version` is invalid (not a number, NaN, or < 1).
+* `TypeError` – If `onUpgrade` is not a function.
+* `TypeError` – If the saved version in `localStorage` is invalid.
+* `Error` – If the provided `version` is lower than the stored version (downgrade is not supported).
+
+---
+
+## 🔑 `getDbKey(): string | null`
+
+Returns the current internal database key used in `localStorage`.
+
+### 🔙 Returns
+
+* `string | null` – The full storage key prefix (e.g. `LSDB::yourDbName`), or `null` if uninitialized.
+
+---
+
+## 🧮 `getVersion(): number`
+
+Returns the current active version of the storage system.
+
+### 🔙 Returns
+
+* `number` – The version number currently in use.
+
+---
+
 ## 📦 Storage Methods
 
 ### `setJson(key, data)`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-essentials",
-  "version": "1.19.2",
+  "version": "1.19.3",
   "description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
   "scripts": {
     "test": "npm run test:mjs && npm run test:cjs && npm run test:js",