@alwatr/local-storage 5.0.0 → 5.4.0

package/CHANGELOG.md

@@ -3,6 +3,48 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.4.0](https://github.com/Alwatr/nanolib/compare/@alwatr/local-storage@1.1.8...@alwatr/local-storage@5.4.0) (2025-02-18)
+
+## 5.3.0 (2025-02-03)
+
+### Features
+
+* **local-storage:** add setItem after getItem and add hasItem ([a1b845d](https://github.com/Alwatr/nanolib/commit/a1b845d8d9d207b514f9e06c37610220337b0235)) by @
+
+### Miscellaneous Chores
+
+* edit README ([3860b3d](https://github.com/Alwatr/nanolib/commit/3860b3df48ab82dc479d5236c2e8579df614aabf)) by @
+
+### Dependencies update
+
+* bump the development-dependencies group across 1 directory with 11 updates ([cb79d07](https://github.com/Alwatr/nanolib/commit/cb79d072a57c79e1c01abff1a293d6757bb65350)) by @
+* update typescript and @types/node to version 5.7.3 and 22.13.0 respectively across multiple packages ([ddab05b](https://github.com/Alwatr/nanolib/commit/ddab05b5d767c30191f36a065e4bc88744e8e3fe)) by @
+
+## 5.0.0 (2024-11-02)
+
+### ⚠ BREAKING CHANGES
+
+* To simplify version management and ensure consistency, all nanolib packages now use the same version as @alwatr/nanolib. This may require updates to your project's dependencies.
+
+### Code Refactoring
+
+* use the same version as @alwatr/nanolib ([60eb860](https://github.com/Alwatr/nanolib/commit/60eb860a0e33dfffe2d1d95e63ce54c60876be06)) by @
+
+## [5.3.0](https://github.com/Alwatr/nanolib/compare/v5.2.1...v5.3.0) (2025-02-03)
+
+### Features
+
+* **local-storage:** add setItem after getItem and add hasItem ([a1b845d](https://github.com/Alwatr/nanolib/commit/a1b845d8d9d207b514f9e06c37610220337b0235)) by @ArmanAsadian
+
+### Miscellaneous Chores
+
+* edit README ([3860b3d](https://github.com/Alwatr/nanolib/commit/3860b3df48ab82dc479d5236c2e8579df614aabf)) by @ArmanAsadian
+
+### Dependencies update
+
+* bump the development-dependencies group across 1 directory with 11 updates ([cb79d07](https://github.com/Alwatr/nanolib/commit/cb79d072a57c79e1c01abff1a293d6757bb65350)) by @dependabot[bot]
+* update typescript and @types/node to version 5.7.3 and 22.13.0 respectively across multiple packages ([ddab05b](https://github.com/Alwatr/nanolib/commit/ddab05b5d767c30191f36a065e4bc88744e8e3fe)) by @alimd
+
 ## 5.0.0 (2024-11-02)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -64,8 +64,6 @@ We plan to add more methods to `localJsonStorage` for directly interacting with
 
 The following companies, organizations, and individuals support Nanolib ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
 
-[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
-
 ### Contributing
 
 Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request.

package/dist/main.cjs

@@ -1,4 +1,4 @@
-/* @alwatr/local-storage v5.0.0 */
+/* @alwatr/local-storage v5.4.0 */
 "use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -25,7 +25,7 @@ __export(main_exports, {
 });
 module.exports = __toCommonJS(main_exports);
 var import_package_tracer = require("@alwatr/package-tracer");
-__dev_mode__: import_package_tracer.packageTracer.add("@alwatr/local-storage", "5.0.0");
+__dev_mode__: import_package_tracer.packageTracer.add("@alwatr/local-storage", "5.4.0");
 function parseJson(content) {
   try {
     return JSON.parse(content);
@@ -65,16 +65,37 @@ var localJsonStorage = {
    * ```
    */
   getItem(name, defaultValue, version = 1) {
+    if (version > 1) {
+      this.removeItem(name, version - 1);
+    }
     if (version > 1) {
       this.removeItem(name, version - 1);
     }
     const key = this.key_(name, version);
     const value = localStorage.getItem(key);
-    if (value === null) return defaultValue;
+    if (value === null) {
+      localStorage.setItem(key, JSON.stringify(defaultValue));
+      return defaultValue;
+    }
     const json = parseJson(value);
     if (json === null || typeof json !== "object") return defaultValue;
     return json;
   },
+  /**
+   * Check if an item exists in local storage.
+   *
+   * @param name - The name of the item.
+   * @param version - The version of the item (default: 1).
+   * @returns True if the item exists, false otherwise.
+   * @example
+   * ```typescript
+   * const exists = localJsonStorage.hasItem('myItem');
+   * ```
+   */
+  hasItem(name, version = 1) {
+    const key = this.key_(name, version);
+    return localStorage.getItem(key) !== null;
+  },
   /**
    * Set local storage item as JSON.
    *
@@ -109,5 +130,4 @@ var localJsonStorage = {
 0 && (module.exports = {
   localJsonStorage
 });
-/*! For license information please see main.cjs.LEGAL.txt */
 //# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/main.ts"],
-  "sourcesContent": ["import {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Parse json string without throwing error.\n *\n * @param content - json string\n * @returns json object or null if json is invalid\n * @example\n * ```typescript\n * const json = parseJson('{\"a\":1,\"b\":2}');\n * console.log(json.a); // 1\n * ```\n */\nfunction parseJson<T extends JsonValue>(content: string): T | null {\n  try {\n    return JSON.parse(content);\n  }\n  catch (err) {\n    console.error('parseJson', 'invalid_json', err);\n    return null;\n  }\n}\n\n// @TODO: localStorage polyfill (memory fallback)\n\n/**\n * A utility object for working with local storage and JSON data.\n */\nexport const localJsonStorage = {\n  /**\n   * Generate local storage key.\n   *\n   * @param name - Name of the item.\n   * @param version - Version of the item (default: 1).\n   * @returns The generated local storage key.\n   * @example\n   * ```typescript\n   * localJsonStorage.key_('myItem', 1); // myItem.v1\n   * ```\n   */\n  key_(name: string, version = 1): string {\n    return `${name}.v${version}`;\n  },\n\n  /**\n   * Get the local storage item and parse it as JSON.\n   * If the item is not found, return the default value.\n   * If the version is greater than 1, remove the previous version.\n   * If the item is not a valid JSON object, return the default value.\n   *\n   * @param name - The name of the item.\n   * @param defaultValue - The default value of the item.\n   * @param version - The data structure version of the item (default: 1).\n   * @returns The parsed JSON value or the default value if the item is not found.\n   * @example\n   * ```typescript\n   * const value = localJsonStorage.getItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  getItem<T extends Json>(name: string, defaultValue: T, version = 1): T {\n    if (version > 1) {\n      this.removeItem(name, version - 1);\n    }\n    const key = this.key_(name, version);\n    const value = localStorage.getItem(key);\n    if (value === null) return defaultValue;\n    const json = parseJson<T>(value);\n    if (json === null || typeof json !== 'object') return defaultValue;\n    return json;\n  },\n\n  /**\n   * Set local storage item as JSON.\n   *\n   * @param name - Name of the item.\n   * @param value - Value of the item.\n   * @param version - Version of the item.\n   * @example\n   * ```typescript\n   * localJsonStorage.setItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  setItem<T extends Json>(name: string, value: T, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.setItem(key, JSON.stringify(value));\n  },\n\n  /**\n   * Removes an item from the local storage.\n   *\n   * @param name - The name of the item to remove.\n   * @param version - The version of the item to remove. Default is 1.\n   * @example\n   * ```typescript\n   * localJsonStorage.removeItem('myItem');\n   * ```\n   */\n  removeItem(name: string, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.removeItem(key);\n  },\n} as const;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,yBAAkB,OAAmB;AAarE,SAAS,UAA+B,SAA2B;AACjE,MAAI;AACF,WAAO,KAAK,MAAM,OAAO;AAAA,EAC3B,SACO,KAAK;AACV,YAAQ,MAAM,aAAa,gBAAgB,GAAG;AAC9C,WAAO;AAAA,EACT;AACF;AAOO,IAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9B,KAAK,MAAc,UAAU,GAAW;AACtC,WAAO,GAAG,IAAI,KAAK,OAAO;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,QAAwB,MAAc,cAAiB,UAAU,GAAM;AACrE,QAAI,UAAU,GAAG;AACf,WAAK,WAAW,MAAM,UAAU,CAAC;AAAA,IACnC;AACA,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,UAAM,QAAQ,aAAa,QAAQ,GAAG;AACtC,QAAI,UAAU,KAAM,QAAO;AAC3B,UAAM,OAAO,UAAa,KAAK;AAC/B,QAAI,SAAS,QAAQ,OAAO,SAAS,SAAU,QAAO;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,QAAwB,MAAc,OAAU,UAAU,GAAS;AACjE,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,iBAAa,QAAQ,KAAK,KAAK,UAAU,KAAK,CAAC;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,WAAW,MAAc,UAAU,GAAS;AAC1C,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,iBAAa,WAAW,GAAG;AAAA,EAC7B;AACF;",
+  "sourcesContent": ["import {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Parse json string without throwing error.\n *\n * @param content - json string\n * @returns json object or null if json is invalid\n * @example\n * ```typescript\n * const json = parseJson('{\"a\":1,\"b\":2}');\n * console.log(json.a); // 1\n * ```\n */\nfunction parseJson<T extends JsonValue>(content: string): T | null {\n  try {\n    return JSON.parse(content);\n  }\n  catch (err) {\n    console.error('parseJson', 'invalid_json', err);\n    return null;\n  }\n}\n\n// @TODO: localStorage polyfill (memory fallback)\n\n/**\n * A utility object for working with local storage and JSON data.\n */\nexport const localJsonStorage = {\n  /**\n   * Generate local storage key.\n   *\n   * @param name - Name of the item.\n   * @param version - Version of the item (default: 1).\n   * @returns The generated local storage key.\n   * @example\n   * ```typescript\n   * localJsonStorage.key_('myItem', 1); // myItem.v1\n   * ```\n   */\n  key_(name: string, version = 1): string {\n    return `${name}.v${version}`;\n  },\n\n  /**\n   * Get the local storage item and parse it as JSON.\n   * If the item is not found, return the default value.\n   * If the version is greater than 1, remove the previous version.\n   * If the item is not a valid JSON object, return the default value.\n   *\n   * @param name - The name of the item.\n   * @param defaultValue - The default value of the item.\n   * @param version - The data structure version of the item (default: 1).\n   * @returns The parsed JSON value or the default value if the item is not found.\n   * @example\n   * ```typescript\n   * const value = localJsonStorage.getItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  getItem<T extends Json>(name: string, defaultValue: T, version = 1): T {\n    if (version > 1) {\n      this.removeItem(name, version - 1);\n    }\n    if (version > 1) {\n      this.removeItem(name, version - 1);\n    }\n    const key = this.key_(name, version);\n    const value = localStorage.getItem(key);\n    if (value === null) {\n      localStorage.setItem(key, JSON.stringify(defaultValue));\n      return defaultValue;\n    }\n    const json = parseJson<T>(value);\n    if (json === null || typeof json !== 'object') return defaultValue;\n    return json;\n  },\n\n  /**\n   * Check if an item exists in local storage.\n   *\n   * @param name - The name of the item.\n   * @param version - The version of the item (default: 1).\n   * @returns True if the item exists, false otherwise.\n   * @example\n   * ```typescript\n   * const exists = localJsonStorage.hasItem('myItem');\n   * ```\n   */\n  hasItem(name: string, version = 1): boolean {\n    const key = this.key_(name, version);\n    return localStorage.getItem(key) !== null;\n  },\n\n  /**\n   * Set local storage item as JSON.\n   *\n   * @param name - Name of the item.\n   * @param value - Value of the item.\n   * @param version - Version of the item.\n   * @example\n   * ```typescript\n   * localJsonStorage.setItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  setItem<T extends Json>(name: string, value: T, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.setItem(key, JSON.stringify(value));\n  },\n\n  /**\n   * Removes an item from the local storage.\n   *\n   * @param name - The name of the item to remove.\n   * @param version - The version of the item to remove. Default is 1.\n   * @example\n   * ```typescript\n   * localJsonStorage.removeItem('myItem');\n   * ```\n   */\n  removeItem(name: string, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.removeItem(key);\n  },\n} as const;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,yBAAkB,OAAmB;AAarE,SAAS,UAA+B,SAA2B;AACjE,MAAI;AACF,WAAO,KAAK,MAAM,OAAO;AAAA,EAC3B,SACO,KAAK;AACV,YAAQ,MAAM,aAAa,gBAAgB,GAAG;AAC9C,WAAO;AAAA,EACT;AACF;AAOO,IAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9B,KAAK,MAAc,UAAU,GAAW;AACtC,WAAO,GAAG,IAAI,KAAK,OAAO;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,QAAwB,MAAc,cAAiB,UAAU,GAAM;AACrE,QAAI,UAAU,GAAG;AACf,WAAK,WAAW,MAAM,UAAU,CAAC;AAAA,IACnC;AACA,QAAI,UAAU,GAAG;AACf,WAAK,WAAW,MAAM,UAAU,CAAC;AAAA,IACnC;AACA,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,UAAM,QAAQ,aAAa,QAAQ,GAAG;AACtC,QAAI,UAAU,MAAM;AAClB,mBAAa,QAAQ,KAAK,KAAK,UAAU,YAAY,CAAC;AACtD,aAAO;AAAA,IACT;AACA,UAAM,OAAO,UAAa,KAAK;AAC/B,QAAI,SAAS,QAAQ,OAAO,SAAS,SAAU,QAAO;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,QAAQ,MAAc,UAAU,GAAY;AAC1C,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,WAAO,aAAa,QAAQ,GAAG,MAAM;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,QAAwB,MAAc,OAAU,UAAU,GAAS;AACjE,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,iBAAa,QAAQ,KAAK,KAAK,UAAU,KAAK,CAAC;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,WAAW,MAAc,UAAU,GAAS;AAC1C,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,iBAAa,WAAW,GAAG;AAAA,EAC7B;AACF;",
   "names": []
 }

package/dist/main.d.ts

@@ -30,6 +30,18 @@ export declare const localJsonStorage: {
      * ```
      */
     readonly getItem: <T extends Json>(name: string, defaultValue: T, version?: number) => T;
+    /**
+     * Check if an item exists in local storage.
+     *
+     * @param name - The name of the item.
+     * @param version - The version of the item (default: 1).
+     * @returns True if the item exists, false otherwise.
+     * @example
+     * ```typescript
+     * const exists = localJsonStorage.hasItem('myItem');
+     * ```
+     */
+    readonly hasItem: (name: string, version?: number) => boolean;
     /**
      * Set local storage item as JSON.
      *

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AA2BA;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;;;;;OAUG;0BACQ,MAAM,uBAAgB,MAAM;IAIvC;;;;;;;;;;;;;;OAcG;uBACK,CAAC,SAAS,IAAI,QAAQ,MAAM,gBAAgB,CAAC,uBAAgB,CAAC;IAYtE;;;;;;;;;;OAUG;uBACK,CAAC,SAAS,IAAI,QAAQ,MAAM,SAAS,CAAC,uBAAgB,IAAI;IAKlE;;;;;;;;;OASG;gCACc,MAAM,uBAAgB,IAAI;CAInC,CAAC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AA2BA;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;;;;;OAUG;0BACQ,MAAM,uBAAgB,MAAM;IAIvC;;;;;;;;;;;;;;OAcG;uBACK,CAAC,SAAS,IAAI,QAAQ,MAAM,gBAAgB,CAAC,uBAAgB,CAAC;IAkBtE;;;;;;;;;;OAUG;6BACW,MAAM,uBAAgB,OAAO;IAK3C;;;;;;;;;;OAUG;uBACK,CAAC,SAAS,IAAI,QAAQ,MAAM,SAAS,CAAC,uBAAgB,IAAI;IAKlE;;;;;;;;;OASG;gCACc,MAAM,uBAAgB,IAAI;CAInC,CAAC"}

package/dist/main.mjs

@@ -1,8 +1,8 @@
-/* @alwatr/local-storage v5.0.0 */
+/* @alwatr/local-storage v5.4.0 */
 
 // src/main.ts
 import { packageTracer } from "@alwatr/package-tracer";
-__dev_mode__: packageTracer.add("@alwatr/local-storage", "5.0.0");
+__dev_mode__: packageTracer.add("@alwatr/local-storage", "5.4.0");
 function parseJson(content) {
   try {
     return JSON.parse(content);
@@ -42,16 +42,37 @@ var localJsonStorage = {
    * ```
    */
   getItem(name, defaultValue, version = 1) {
+    if (version > 1) {
+      this.removeItem(name, version - 1);
+    }
     if (version > 1) {
       this.removeItem(name, version - 1);
     }
     const key = this.key_(name, version);
     const value = localStorage.getItem(key);
-    if (value === null) return defaultValue;
+    if (value === null) {
+      localStorage.setItem(key, JSON.stringify(defaultValue));
+      return defaultValue;
+    }
     const json = parseJson(value);
     if (json === null || typeof json !== "object") return defaultValue;
     return json;
   },
+  /**
+   * Check if an item exists in local storage.
+   *
+   * @param name - The name of the item.
+   * @param version - The version of the item (default: 1).
+   * @returns True if the item exists, false otherwise.
+   * @example
+   * ```typescript
+   * const exists = localJsonStorage.hasItem('myItem');
+   * ```
+   */
+  hasItem(name, version = 1) {
+    const key = this.key_(name, version);
+    return localStorage.getItem(key) !== null;
+  },
   /**
    * Set local storage item as JSON.
    *
@@ -85,5 +106,4 @@ var localJsonStorage = {
 export {
   localJsonStorage
 };
-/*! For license information please see main.mjs.LEGAL.txt */
 //# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/main.ts"],
-  "sourcesContent": ["import {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Parse json string without throwing error.\n *\n * @param content - json string\n * @returns json object or null if json is invalid\n * @example\n * ```typescript\n * const json = parseJson('{\"a\":1,\"b\":2}');\n * console.log(json.a); // 1\n * ```\n */\nfunction parseJson<T extends JsonValue>(content: string): T | null {\n  try {\n    return JSON.parse(content);\n  }\n  catch (err) {\n    console.error('parseJson', 'invalid_json', err);\n    return null;\n  }\n}\n\n// @TODO: localStorage polyfill (memory fallback)\n\n/**\n * A utility object for working with local storage and JSON data.\n */\nexport const localJsonStorage = {\n  /**\n   * Generate local storage key.\n   *\n   * @param name - Name of the item.\n   * @param version - Version of the item (default: 1).\n   * @returns The generated local storage key.\n   * @example\n   * ```typescript\n   * localJsonStorage.key_('myItem', 1); // myItem.v1\n   * ```\n   */\n  key_(name: string, version = 1): string {\n    return `${name}.v${version}`;\n  },\n\n  /**\n   * Get the local storage item and parse it as JSON.\n   * If the item is not found, return the default value.\n   * If the version is greater than 1, remove the previous version.\n   * If the item is not a valid JSON object, return the default value.\n   *\n   * @param name - The name of the item.\n   * @param defaultValue - The default value of the item.\n   * @param version - The data structure version of the item (default: 1).\n   * @returns The parsed JSON value or the default value if the item is not found.\n   * @example\n   * ```typescript\n   * const value = localJsonStorage.getItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  getItem<T extends Json>(name: string, defaultValue: T, version = 1): T {\n    if (version > 1) {\n      this.removeItem(name, version - 1);\n    }\n    const key = this.key_(name, version);\n    const value = localStorage.getItem(key);\n    if (value === null) return defaultValue;\n    const json = parseJson<T>(value);\n    if (json === null || typeof json !== 'object') return defaultValue;\n    return json;\n  },\n\n  /**\n   * Set local storage item as JSON.\n   *\n   * @param name - Name of the item.\n   * @param value - Value of the item.\n   * @param version - Version of the item.\n   * @example\n   * ```typescript\n   * localJsonStorage.setItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  setItem<T extends Json>(name: string, value: T, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.setItem(key, JSON.stringify(value));\n  },\n\n  /**\n   * Removes an item from the local storage.\n   *\n   * @param name - The name of the item to remove.\n   * @param version - The version of the item to remove. Default is 1.\n   * @example\n   * ```typescript\n   * localJsonStorage.removeItem('myItem');\n   * ```\n   */\n  removeItem(name: string, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.removeItem(key);\n  },\n} as const;\n"],
-  "mappings": ";;;AAAA,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,yBAAkB,OAAmB;AAarE,SAAS,UAA+B,SAA2B;AACjE,MAAI;AACF,WAAO,KAAK,MAAM,OAAO;AAAA,EAC3B,SACO,KAAK;AACV,YAAQ,MAAM,aAAa,gBAAgB,GAAG;AAC9C,WAAO;AAAA,EACT;AACF;AAOO,IAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9B,KAAK,MAAc,UAAU,GAAW;AACtC,WAAO,GAAG,IAAI,KAAK,OAAO;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,QAAwB,MAAc,cAAiB,UAAU,GAAM;AACrE,QAAI,UAAU,GAAG;AACf,WAAK,WAAW,MAAM,UAAU,CAAC;AAAA,IACnC;AACA,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,UAAM,QAAQ,aAAa,QAAQ,GAAG;AACtC,QAAI,UAAU,KAAM,QAAO;AAC3B,UAAM,OAAO,UAAa,KAAK;AAC/B,QAAI,SAAS,QAAQ,OAAO,SAAS,SAAU,QAAO;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,QAAwB,MAAc,OAAU,UAAU,GAAS;AACjE,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,iBAAa,QAAQ,KAAK,KAAK,UAAU,KAAK,CAAC;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,WAAW,MAAc,UAAU,GAAS;AAC1C,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,iBAAa,WAAW,GAAG;AAAA,EAC7B;AACF;",
+  "sourcesContent": ["import {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Parse json string without throwing error.\n *\n * @param content - json string\n * @returns json object or null if json is invalid\n * @example\n * ```typescript\n * const json = parseJson('{\"a\":1,\"b\":2}');\n * console.log(json.a); // 1\n * ```\n */\nfunction parseJson<T extends JsonValue>(content: string): T | null {\n  try {\n    return JSON.parse(content);\n  }\n  catch (err) {\n    console.error('parseJson', 'invalid_json', err);\n    return null;\n  }\n}\n\n// @TODO: localStorage polyfill (memory fallback)\n\n/**\n * A utility object for working with local storage and JSON data.\n */\nexport const localJsonStorage = {\n  /**\n   * Generate local storage key.\n   *\n   * @param name - Name of the item.\n   * @param version - Version of the item (default: 1).\n   * @returns The generated local storage key.\n   * @example\n   * ```typescript\n   * localJsonStorage.key_('myItem', 1); // myItem.v1\n   * ```\n   */\n  key_(name: string, version = 1): string {\n    return `${name}.v${version}`;\n  },\n\n  /**\n   * Get the local storage item and parse it as JSON.\n   * If the item is not found, return the default value.\n   * If the version is greater than 1, remove the previous version.\n   * If the item is not a valid JSON object, return the default value.\n   *\n   * @param name - The name of the item.\n   * @param defaultValue - The default value of the item.\n   * @param version - The data structure version of the item (default: 1).\n   * @returns The parsed JSON value or the default value if the item is not found.\n   * @example\n   * ```typescript\n   * const value = localJsonStorage.getItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  getItem<T extends Json>(name: string, defaultValue: T, version = 1): T {\n    if (version > 1) {\n      this.removeItem(name, version - 1);\n    }\n    if (version > 1) {\n      this.removeItem(name, version - 1);\n    }\n    const key = this.key_(name, version);\n    const value = localStorage.getItem(key);\n    if (value === null) {\n      localStorage.setItem(key, JSON.stringify(defaultValue));\n      return defaultValue;\n    }\n    const json = parseJson<T>(value);\n    if (json === null || typeof json !== 'object') return defaultValue;\n    return json;\n  },\n\n  /**\n   * Check if an item exists in local storage.\n   *\n   * @param name - The name of the item.\n   * @param version - The version of the item (default: 1).\n   * @returns True if the item exists, false otherwise.\n   * @example\n   * ```typescript\n   * const exists = localJsonStorage.hasItem('myItem');\n   * ```\n   */\n  hasItem(name: string, version = 1): boolean {\n    const key = this.key_(name, version);\n    return localStorage.getItem(key) !== null;\n  },\n\n  /**\n   * Set local storage item as JSON.\n   *\n   * @param name - Name of the item.\n   * @param value - Value of the item.\n   * @param version - Version of the item.\n   * @example\n   * ```typescript\n   * localJsonStorage.setItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  setItem<T extends Json>(name: string, value: T, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.setItem(key, JSON.stringify(value));\n  },\n\n  /**\n   * Removes an item from the local storage.\n   *\n   * @param name - The name of the item to remove.\n   * @param version - The version of the item to remove. Default is 1.\n   * @example\n   * ```typescript\n   * localJsonStorage.removeItem('myItem');\n   * ```\n   */\n  removeItem(name: string, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.removeItem(key);\n  },\n} as const;\n"],
+  "mappings": ";;;AAAA,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,yBAAkB,OAAmB;AAarE,SAAS,UAA+B,SAA2B;AACjE,MAAI;AACF,WAAO,KAAK,MAAM,OAAO;AAAA,EAC3B,SACO,KAAK;AACV,YAAQ,MAAM,aAAa,gBAAgB,GAAG;AAC9C,WAAO;AAAA,EACT;AACF;AAOO,IAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9B,KAAK,MAAc,UAAU,GAAW;AACtC,WAAO,GAAG,IAAI,KAAK,OAAO;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,QAAwB,MAAc,cAAiB,UAAU,GAAM;AACrE,QAAI,UAAU,GAAG;AACf,WAAK,WAAW,MAAM,UAAU,CAAC;AAAA,IACnC;AACA,QAAI,UAAU,GAAG;AACf,WAAK,WAAW,MAAM,UAAU,CAAC;AAAA,IACnC;AACA,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,UAAM,QAAQ,aAAa,QAAQ,GAAG;AACtC,QAAI,UAAU,MAAM;AAClB,mBAAa,QAAQ,KAAK,KAAK,UAAU,YAAY,CAAC;AACtD,aAAO;AAAA,IACT;AACA,UAAM,OAAO,UAAa,KAAK;AAC/B,QAAI,SAAS,QAAQ,OAAO,SAAS,SAAU,QAAO;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,QAAQ,MAAc,UAAU,GAAY;AAC1C,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,WAAO,aAAa,QAAQ,GAAG,MAAM;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,QAAwB,MAAc,OAAU,UAAU,GAAS;AACjE,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,iBAAa,QAAQ,KAAK,KAAK,UAAU,KAAK,CAAC;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,WAAW,MAAc,UAAU,GAAS;AAC1C,UAAM,MAAM,KAAK,KAAK,MAAM,OAAO;AACnC,iBAAa,WAAW,GAAG;AAAA,EAC7B;AACF;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwatr/local-storage",
-  "version": "5.0.0",
+  "version": "5.4.0",
   "description": "`localJsonStorage` is a utility object in our TypeScript package that provides methods for interacting with the local storage in a structured and versioned manner.",
   "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
   "keywords": [
@@ -68,14 +68,14 @@
     "clean": "rm -rfv dist *.tsbuildinfo"
   },
   "dependencies": {
-    "@alwatr/package-tracer": "^5.0.0"
+    "@alwatr/package-tracer": "^5.4.0"
   },
   "devDependencies": {
-    "@alwatr/nano-build": "^5.0.0",
+    "@alwatr/nano-build": "^5.4.0",
     "@alwatr/prettier-config": "^5.0.0",
     "@alwatr/tsconfig-base": "^5.0.0",
-    "@alwatr/type-helper": "^5.0.0",
-    "typescript": "^5.6.3"
+    "@alwatr/type-helper": "^5.3.0",
+    "typescript": "^5.7.3"
   },
-  "gitHead": "7d12943fafa8ef50636346e66ff56c50e2fd0c72"
+  "gitHead": "074be0d0fe780bf929e163045f8f598cd2697636"
 }