@alwatr/local-storage 6.1.2 → 6.1.3

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.1.3](https://github.com/Alwatr/nanolib/compare/@alwatr/local-storage@6.1.2...@alwatr/local-storage@6.1.3) (2025-09-15)
+
+**Note:** Version bump only for package @alwatr/local-storage
+
 ## [6.1.2](https://github.com/Alwatr/nanolib/compare/@alwatr/local-storage@6.1.1...@alwatr/local-storage@6.1.2) (2025-09-14)
 
 ### 🔨 Code Refactoring

package/dist/main.cjs

@@ -1,137 +1,3 @@
-/* @alwatr/local-storage v6.1.2 */
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/main.ts
-var main_exports = {};
-__export(main_exports, {
-  LocalStorageProvider: () => LocalStorageProvider,
-  createLocalStorageProvider: () => createLocalStorageProvider
-});
-module.exports = __toCommonJS(main_exports);
-
-// src/local-storage.provider.ts
-var import_logger = require("@alwatr/logger");
-var LocalStorageProvider = class _LocalStorageProvider {
-  constructor(config_) {
-    this.config_ = config_;
-    this.logger_ = (0, import_logger.createLogger)(`local-storage-provider: ${this.config_.name}, v: ${this.config_.version}`);
-    this.logger_.logMethodArgs?.("constructor", { config: this.config_ });
-    this.key__ = _LocalStorageProvider.getKey(this.config_);
-    this.migrate__();
-  }
-  static {
-    this.version = "6.1.2";
-  }
-  /**
-   * Generates the versioned storage key.
-   * @param meta - An object containing the name and version.
-   * @returns The versioned key string.
-   */
-  static getKey(meta) {
-    return `${meta.name}.v${meta.version}`;
-  }
-  /**
-   * Statically checks if a versioned item exists in localStorage.
-   * This method provides a high-performance way to check for data existence without the overhead of creating a full provider instance.
-   *
-   * @param meta - An object containing the name and version of the item to check.
-   * @returns `true` if the item exists, otherwise `false`.
-   *
-   * @example
-   * ```typescript
-   * const formExists = LocalStorageProvider.has({ name: 'user-form', version: 1 });
-   * if (formExists) {
-   *   // Show the "Thank you" message
-   * } else {
-   *   // Show the form
-   * }
-   * ```
-   */
-  static has(meta) {
-    const key = _LocalStorageProvider.getKey(meta);
-    return localStorage.getItem(key) !== null;
-  }
-  /**
-   * Writes the default value to localStorage and returns it.
-   */
-  writeDefault__() {
-    this.logger_.logMethodArgs?.("writeDefaultــ", this.config_.defaultValue);
-    this.write(this.config_.defaultValue);
-    return this.config_.defaultValue;
-  }
-  /**
-   * Reads and parses the value from localStorage.
-   * If the item doesn't exist, is invalid JSON, or doesn't match the expected type,
-   * it writes and returns the default value.
-   */
-  read() {
-    try {
-      const value = localStorage.getItem(this.key__);
-      if (value === null) {
-        this.logger_.logMethod?.("read//no_value");
-        return this.writeDefault__();
-      }
-      const parsedValue = JSON.parse(value);
-      this.logger_.logMethodFull?.("read//value", void 0, { parsedValue });
-      return parsedValue;
-    } catch (err) {
-      this.logger_.error("read", "read_parse_error", { err });
-      return this.writeDefault__();
-    }
-  }
-  /**
-   * Serializes and writes a value to localStorage.
-   */
-  write(value) {
-    this.logger_.logMethodArgs?.("write", { value });
-    try {
-      localStorage.setItem(this.key__, JSON.stringify(value));
-    } catch (err) {
-      this.logger_.error("write", "write_stringify_error", { err });
-    }
-  }
-  /**
-   * Removes the item from localStorage.
-   */
-  remove() {
-    localStorage.removeItem(this.key__);
-  }
-  /**
-   * Manages data migration by removing all previous versions of the item.
-   */
-  migrate__() {
-    if (this.config_.version <= 1) return;
-    for (let i = 1; i < this.config_.version; i++) {
-      const oldKey = _LocalStorageProvider.getKey({ name: this.config_.name, version: i });
-      localStorage.removeItem(oldKey);
-    }
-  }
-};
-
-// src/main.ts
-function createLocalStorageProvider(config) {
-  return new LocalStorageProvider(config);
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  LocalStorageProvider,
-  createLocalStorageProvider
-});
+/* @alwatr/local-storage v6.1.3 */
+"use strict";var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:true})};var __copyProps=(to,from,except,desc)=>{if(from&&typeof from==="object"||typeof from==="function"){for(let key of __getOwnPropNames(from))if(!__hasOwnProp.call(to,key)&&key!==except)__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable})}return to};var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:true}),mod);var main_exports={};__export(main_exports,{LocalStorageProvider:()=>LocalStorageProvider,createLocalStorageProvider:()=>createLocalStorageProvider});module.exports=__toCommonJS(main_exports);var import_logger=require("@alwatr/logger");var LocalStorageProvider=class _LocalStorageProvider{constructor(config_){this.config_=config_;this.logger_=(0,import_logger.createLogger)(`local-storage-provider: ${this.config_.name}, v: ${this.config_.version}`);this.logger_.logMethodArgs?.("constructor",{config:this.config_});this.key__=_LocalStorageProvider.getKey(this.config_);this.migrate__()}static{this.version="6.1.3"}static getKey(meta){return`${meta.name}.v${meta.version}`}static has(meta){const key=_LocalStorageProvider.getKey(meta);return localStorage.getItem(key)!==null}writeDefault__(){this.logger_.logMethodArgs?.("writeDefaultــ",this.config_.defaultValue);this.write(this.config_.defaultValue);return this.config_.defaultValue}read(){try{const value=localStorage.getItem(this.key__);if(value===null){this.logger_.logMethod?.("read//no_value");return this.writeDefault__()}const parsedValue=JSON.parse(value);this.logger_.logMethodFull?.("read//value",void 0,{parsedValue});return parsedValue}catch(err){this.logger_.error("read","read_parse_error",{err});return this.writeDefault__()}}write(value){this.logger_.logMethodArgs?.("write",{value});try{localStorage.setItem(this.key__,JSON.stringify(value))}catch(err){this.logger_.error("write","write_stringify_error",{err})}}remove(){localStorage.removeItem(this.key__)}migrate__(){if(this.config_.version<=1)return;for(let i=1;i<this.config_.version;i++){const oldKey=_LocalStorageProvider.getKey({name:this.config_.name,version:i});localStorage.removeItem(oldKey)}}};function createLocalStorageProvider(config){return new LocalStorageProvider(config)}0&&(module.exports={LocalStorageProvider,createLocalStorageProvider});
 //# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../src/main.ts", "../src/local-storage.provider.ts"],
   "sourcesContent": ["import {LocalStorageProvider} from './local-storage.provider.js';\n\nimport type {LocalStorageProviderConfig} from './type.js';\n\nexport * from './local-storage.provider.js';\nexport type * from './type.js';\n\n/**\n * Factory function to create a new LocalStorageProvider.\n *\n * @param config - The configuration for the provider.\n * @returns An instance of LocalStorageProvider.\n *\n * @example\n * ```typescript\n * const userSettings = createLocalStorageProvider({\n *   name: 'user-settings',\n *   version: 1,\n *   defaultValue: { theme: 'light', notifications: true }\n * });\n *\n * // Write new settings\n * userSettings.write({ theme: 'dark', notifications: false });\n *\n * // Read the current settings\n * const currentSettings = userSettings.read();\n * console.log(currentSettings); // { theme: 'dark', notifications: false }\n * ```\n */\nexport function createLocalStorageProvider<T extends JsonValue>(config: LocalStorageProviderConfig<T>): LocalStorageProvider<T> {\n  return new LocalStorageProvider<T>(config);\n}\n", "import {createLogger} from '@alwatr/logger';\n\nimport type {LocalStorageProviderConfig, StorageMeta} from './type.js';\n\n/**\n * A provider class for managing a specific, versioned item in localStorage.\n * It encapsulates the logic for key generation, serialization, and migration.\n *\n * @example\n * ```typescript\n * const userSettings = new LocalStorageProvider({\n *   name: 'user-settings',\n *   version: 1,\n *   defaultValue: { theme: 'light', notifications: true }\n * });\n *\n * // Write new settings\n * userSettings.write({ theme: 'dark', notifications: false });\n *\n * // Read the current settings\n * const currentSettings = userSettings.read();\n * console.log(currentSettings); // { theme: 'dark', notifications: false }\n * ```\n */\nexport class LocalStorageProvider<T extends JsonValue> {\n  public static readonly version = __package_version__;\n\n  private readonly key__: string;\n  protected readonly logger_ = createLogger(`local-storage-provider: ${this.config_.name}, v: ${this.config_.version}`);\n\n  public constructor(protected readonly config_: LocalStorageProviderConfig<T>) {\n    this.logger_.logMethodArgs?.('constructor', {config: this.config_});\n    this.key__ = LocalStorageProvider.getKey(this.config_);\n    this.migrate__();\n  }\n\n  /**\n   * Generates the versioned storage key.\n   * @param meta - An object containing the name and version.\n   * @returns The versioned key string.\n   */\n  public static getKey(meta: StorageMeta): string {\n    return `${meta.name}.v${meta.version}`;\n  }\n\n  /**\n   * Statically checks if a versioned item exists in localStorage.\n   * This method provides a high-performance way to check for data existence without the overhead of creating a full provider instance.\n   *\n   * @param meta - An object containing the name and version of the item to check.\n   * @returns `true` if the item exists, otherwise `false`.\n   *\n   * @example\n   * ```typescript\n   * const formExists = LocalStorageProvider.has({ name: 'user-form', version: 1 });\n   * if (formExists) {\n   *   // Show the \"Thank you\" message\n   * } else {\n   *   // Show the form\n   * }\n   * ```\n   */\n  public static has(meta: StorageMeta): boolean {\n    const key = LocalStorageProvider.getKey(meta);\n    return localStorage.getItem(key) !== null;\n  }\n\n  /**\n   * Writes the default value to localStorage and returns it.\n   */\n  private writeDefault__(): T {\n    this.logger_.logMethodArgs?.('writeDefaultــ', this.config_.defaultValue);\n    this.write(this.config_.defaultValue);\n    return this.config_.defaultValue;\n  }\n\n  /**\n   * Reads and parses the value from localStorage.\n   * If the item doesn't exist, is invalid JSON, or doesn't match the expected type,\n   * it writes and returns the default value.\n   */\n  public read(): T {\n    try {\n      const value = localStorage.getItem(this.key__);\n\n      if (value === null) {\n        this.logger_.logMethod?.('read//no_value');\n        return this.writeDefault__();\n      }\n\n      const parsedValue = JSON.parse(value) as T;\n      this.logger_.logMethodFull?.('read//value', undefined, {parsedValue});\n      return parsedValue;\n    }\n    catch (err) {\n      this.logger_.error('read', 'read_parse_error', {err});\n      return this.writeDefault__();\n    }\n  }\n\n  /**\n   * Serializes and writes a value to localStorage.\n   */\n  public write(value: T): void {\n    this.logger_.logMethodArgs?.('write', {value});\n    try {\n      localStorage.setItem(this.key__, JSON.stringify(value));\n    }\n    catch (err) {\n      this.logger_.error('write', 'write_stringify_error', {err});\n    }\n  }\n\n  /**\n   * Removes the item from localStorage.\n   */\n  public remove(): void {\n    localStorage.removeItem(this.key__);\n  }\n\n  /**\n   * Manages data migration by removing all previous versions of the item.\n   */\n  private migrate__(): void {\n    if (this.config_.version <= 1) return;\n\n    // Iterate from v1 up to the version just before the current one and remove them.\n    for (let i = 1; i < this.config_.version; i++) {\n      const oldKey = LocalStorageProvider.getKey({name: this.config_.name, version: i});\n      localStorage.removeItem(oldKey);\n    }\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAA2B;AAwBpB,IAAM,uBAAN,MAAM,sBAA0C;AAAA,EAM9C,YAA+B,SAAwC;AAAxC;AAFtC,SAAmB,cAAU,4BAAa,2BAA2B,KAAK,QAAQ,IAAI,QAAQ,KAAK,QAAQ,OAAO,EAAE;AAGlH,SAAK,QAAQ,gBAAgB,eAAe,EAAC,QAAQ,KAAK,QAAO,CAAC;AAClE,SAAK,QAAQ,sBAAqB,OAAO,KAAK,OAAO;AACrD,SAAK,UAAU;AAAA,EACjB;AAAA,EATA;AAAA,SAAuB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBjC,OAAc,OAAO,MAA2B;AAC9C,WAAO,GAAG,KAAK,IAAI,KAAK,KAAK,OAAO;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,OAAc,IAAI,MAA4B;AAC5C,UAAM,MAAM,sBAAqB,OAAO,IAAI;AAC5C,WAAO,aAAa,QAAQ,GAAG,MAAM;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA,EAKQ,iBAAoB;AAC1B,SAAK,QAAQ,gBAAgB,kBAAkB,KAAK,QAAQ,YAAY;AACxE,SAAK,MAAM,KAAK,QAAQ,YAAY;AACpC,WAAO,KAAK,QAAQ;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,OAAU;AACf,QAAI;AACF,YAAM,QAAQ,aAAa,QAAQ,KAAK,KAAK;AAE7C,UAAI,UAAU,MAAM;AAClB,aAAK,QAAQ,YAAY,gBAAgB;AACzC,eAAO,KAAK,eAAe;AAAA,MAC7B;AAEA,YAAM,cAAc,KAAK,MAAM,KAAK;AACpC,WAAK,QAAQ,gBAAgB,eAAe,QAAW,EAAC,YAAW,CAAC;AACpE,aAAO;AAAA,IACT,SACO,KAAK;AACV,WAAK,QAAQ,MAAM,QAAQ,oBAAoB,EAAC,IAAG,CAAC;AACpD,aAAO,KAAK,eAAe;AAAA,IAC7B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,MAAM,OAAgB;AAC3B,SAAK,QAAQ,gBAAgB,SAAS,EAAC,MAAK,CAAC;AAC7C,QAAI;AACF,mBAAa,QAAQ,KAAK,OAAO,KAAK,UAAU,KAAK,CAAC;AAAA,IACxD,SACO,KAAK;AACV,WAAK,QAAQ,MAAM,SAAS,yBAAyB,EAAC,IAAG,CAAC;AAAA,IAC5D;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,SAAe;AACpB,iBAAa,WAAW,KAAK,KAAK;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA,EAKQ,YAAkB;AACxB,QAAI,KAAK,QAAQ,WAAW,EAAG;AAG/B,aAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,SAAS,KAAK;AAC7C,YAAM,SAAS,sBAAqB,OAAO,EAAC,MAAM,KAAK,QAAQ,MAAM,SAAS,EAAC,CAAC;AAChF,mBAAa,WAAW,MAAM;AAAA,IAChC;AAAA,EACF;AACF;;;ADvGO,SAAS,2BAAgD,QAAgE;AAC9H,SAAO,IAAI,qBAAwB,MAAM;AAC3C;",
+  "mappings": ";qqBAAA,+LCAA,kBAA2B,0BAwBpB,IAAM,qBAAN,MAAM,qBAA0C,CAM9C,YAA+B,QAAwC,CAAxC,qBAFtC,KAAmB,WAAU,4BAAa,2BAA2B,KAAK,QAAQ,IAAI,QAAQ,KAAK,QAAQ,OAAO,EAAE,EAGlH,KAAK,QAAQ,gBAAgB,cAAe,CAAC,OAAQ,KAAK,OAAO,CAAC,EAClE,KAAK,MAAQ,sBAAqB,OAAO,KAAK,OAAO,EACrD,KAAK,UAAU,CACjB,CATA,YAAuB,QAAU,QAgBjC,OAAc,OAAO,KAA2B,CAC9C,MAAO,GAAG,KAAK,IAAI,KAAK,KAAK,OAAO,EACtC,CAmBA,OAAc,IAAI,KAA4B,CAC5C,MAAM,IAAM,sBAAqB,OAAO,IAAI,EAC5C,OAAO,aAAa,QAAQ,GAAG,IAAM,IACvC,CAKQ,gBAAoB,CAC1B,KAAK,QAAQ,gBAAgB,iBAAkB,KAAK,QAAQ,YAAY,EACxE,KAAK,MAAM,KAAK,QAAQ,YAAY,EACpC,OAAO,KAAK,QAAQ,YACtB,CAOO,MAAU,CACf,GAAI,CACF,MAAM,MAAQ,aAAa,QAAQ,KAAK,KAAK,EAE7C,GAAI,QAAU,KAAM,CAClB,KAAK,QAAQ,YAAY,gBAAgB,EACzC,OAAO,KAAK,eAAe,CAC7B,CAEA,MAAM,YAAc,KAAK,MAAM,KAAK,EACpC,KAAK,QAAQ,gBAAgB,cAAe,OAAW,CAAC,WAAW,CAAC,EACpE,OAAO,WACT,OACO,IAAK,CACV,KAAK,QAAQ,MAAM,OAAQ,mBAAoB,CAAC,GAAG,CAAC,EACpD,OAAO,KAAK,eAAe,CAC7B,CACF,CAKO,MAAM,MAAgB,CAC3B,KAAK,QAAQ,gBAAgB,QAAS,CAAC,KAAK,CAAC,EAC7C,GAAI,CACF,aAAa,QAAQ,KAAK,MAAO,KAAK,UAAU,KAAK,CAAC,CACxD,OACO,IAAK,CACV,KAAK,QAAQ,MAAM,QAAS,wBAAyB,CAAC,GAAG,CAAC,CAC5D,CACF,CAKO,QAAe,CACpB,aAAa,WAAW,KAAK,KAAK,CACpC,CAKQ,WAAkB,CACxB,GAAI,KAAK,QAAQ,SAAW,EAAG,OAG/B,QAAS,EAAI,EAAG,EAAI,KAAK,QAAQ,QAAS,IAAK,CAC7C,MAAM,OAAS,sBAAqB,OAAO,CAAC,KAAM,KAAK,QAAQ,KAAM,QAAS,CAAC,CAAC,EAChF,aAAa,WAAW,MAAM,CAChC,CACF,CACF,EDvGO,SAAS,2BAAgD,OAAgE,CAC9H,OAAO,IAAI,qBAAwB,MAAM,CAC3C",
   "names": []
 }

package/dist/main.mjs

@@ -1,110 +1,3 @@
-/* @alwatr/local-storage v6.1.2 */
-
-// src/local-storage.provider.ts
-import { createLogger } from "@alwatr/logger";
-var LocalStorageProvider = class _LocalStorageProvider {
-  constructor(config_) {
-    this.config_ = config_;
-    this.logger_ = createLogger(`local-storage-provider: ${this.config_.name}, v: ${this.config_.version}`);
-    this.logger_.logMethodArgs?.("constructor", { config: this.config_ });
-    this.key__ = _LocalStorageProvider.getKey(this.config_);
-    this.migrate__();
-  }
-  static {
-    this.version = "6.1.2";
-  }
-  /**
-   * Generates the versioned storage key.
-   * @param meta - An object containing the name and version.
-   * @returns The versioned key string.
-   */
-  static getKey(meta) {
-    return `${meta.name}.v${meta.version}`;
-  }
-  /**
-   * Statically checks if a versioned item exists in localStorage.
-   * This method provides a high-performance way to check for data existence without the overhead of creating a full provider instance.
-   *
-   * @param meta - An object containing the name and version of the item to check.
-   * @returns `true` if the item exists, otherwise `false`.
-   *
-   * @example
-   * ```typescript
-   * const formExists = LocalStorageProvider.has({ name: 'user-form', version: 1 });
-   * if (formExists) {
-   *   // Show the "Thank you" message
-   * } else {
-   *   // Show the form
-   * }
-   * ```
-   */
-  static has(meta) {
-    const key = _LocalStorageProvider.getKey(meta);
-    return localStorage.getItem(key) !== null;
-  }
-  /**
-   * Writes the default value to localStorage and returns it.
-   */
-  writeDefault__() {
-    this.logger_.logMethodArgs?.("writeDefaultــ", this.config_.defaultValue);
-    this.write(this.config_.defaultValue);
-    return this.config_.defaultValue;
-  }
-  /**
-   * Reads and parses the value from localStorage.
-   * If the item doesn't exist, is invalid JSON, or doesn't match the expected type,
-   * it writes and returns the default value.
-   */
-  read() {
-    try {
-      const value = localStorage.getItem(this.key__);
-      if (value === null) {
-        this.logger_.logMethod?.("read//no_value");
-        return this.writeDefault__();
-      }
-      const parsedValue = JSON.parse(value);
-      this.logger_.logMethodFull?.("read//value", void 0, { parsedValue });
-      return parsedValue;
-    } catch (err) {
-      this.logger_.error("read", "read_parse_error", { err });
-      return this.writeDefault__();
-    }
-  }
-  /**
-   * Serializes and writes a value to localStorage.
-   */
-  write(value) {
-    this.logger_.logMethodArgs?.("write", { value });
-    try {
-      localStorage.setItem(this.key__, JSON.stringify(value));
-    } catch (err) {
-      this.logger_.error("write", "write_stringify_error", { err });
-    }
-  }
-  /**
-   * Removes the item from localStorage.
-   */
-  remove() {
-    localStorage.removeItem(this.key__);
-  }
-  /**
-   * Manages data migration by removing all previous versions of the item.
-   */
-  migrate__() {
-    if (this.config_.version <= 1) return;
-    for (let i = 1; i < this.config_.version; i++) {
-      const oldKey = _LocalStorageProvider.getKey({ name: this.config_.name, version: i });
-      localStorage.removeItem(oldKey);
-    }
-  }
-};
-
-// src/main.ts
-function createLocalStorageProvider(config) {
-  return new LocalStorageProvider(config);
-}
-export {
-  LocalStorageProvider,
-  createLocalStorageProvider
-};
+/* @alwatr/local-storage v6.1.3 */
+import{createLogger}from"@alwatr/logger";var LocalStorageProvider=class _LocalStorageProvider{constructor(config_){this.config_=config_;this.logger_=createLogger(`local-storage-provider: ${this.config_.name}, v: ${this.config_.version}`);this.logger_.logMethodArgs?.("constructor",{config:this.config_});this.key__=_LocalStorageProvider.getKey(this.config_);this.migrate__()}static{this.version="6.1.3"}static getKey(meta){return`${meta.name}.v${meta.version}`}static has(meta){const key=_LocalStorageProvider.getKey(meta);return localStorage.getItem(key)!==null}writeDefault__(){this.logger_.logMethodArgs?.("writeDefaultــ",this.config_.defaultValue);this.write(this.config_.defaultValue);return this.config_.defaultValue}read(){try{const value=localStorage.getItem(this.key__);if(value===null){this.logger_.logMethod?.("read//no_value");return this.writeDefault__()}const parsedValue=JSON.parse(value);this.logger_.logMethodFull?.("read//value",void 0,{parsedValue});return parsedValue}catch(err){this.logger_.error("read","read_parse_error",{err});return this.writeDefault__()}}write(value){this.logger_.logMethodArgs?.("write",{value});try{localStorage.setItem(this.key__,JSON.stringify(value))}catch(err){this.logger_.error("write","write_stringify_error",{err})}}remove(){localStorage.removeItem(this.key__)}migrate__(){if(this.config_.version<=1)return;for(let i=1;i<this.config_.version;i++){const oldKey=_LocalStorageProvider.getKey({name:this.config_.name,version:i});localStorage.removeItem(oldKey)}}};function createLocalStorageProvider(config){return new LocalStorageProvider(config)}export{LocalStorageProvider,createLocalStorageProvider};
 //# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../src/local-storage.provider.ts", "../src/main.ts"],
   "sourcesContent": ["import {createLogger} from '@alwatr/logger';\n\nimport type {LocalStorageProviderConfig, StorageMeta} from './type.js';\n\n/**\n * A provider class for managing a specific, versioned item in localStorage.\n * It encapsulates the logic for key generation, serialization, and migration.\n *\n * @example\n * ```typescript\n * const userSettings = new LocalStorageProvider({\n *   name: 'user-settings',\n *   version: 1,\n *   defaultValue: { theme: 'light', notifications: true }\n * });\n *\n * // Write new settings\n * userSettings.write({ theme: 'dark', notifications: false });\n *\n * // Read the current settings\n * const currentSettings = userSettings.read();\n * console.log(currentSettings); // { theme: 'dark', notifications: false }\n * ```\n */\nexport class LocalStorageProvider<T extends JsonValue> {\n  public static readonly version = __package_version__;\n\n  private readonly key__: string;\n  protected readonly logger_ = createLogger(`local-storage-provider: ${this.config_.name}, v: ${this.config_.version}`);\n\n  public constructor(protected readonly config_: LocalStorageProviderConfig<T>) {\n    this.logger_.logMethodArgs?.('constructor', {config: this.config_});\n    this.key__ = LocalStorageProvider.getKey(this.config_);\n    this.migrate__();\n  }\n\n  /**\n   * Generates the versioned storage key.\n   * @param meta - An object containing the name and version.\n   * @returns The versioned key string.\n   */\n  public static getKey(meta: StorageMeta): string {\n    return `${meta.name}.v${meta.version}`;\n  }\n\n  /**\n   * Statically checks if a versioned item exists in localStorage.\n   * This method provides a high-performance way to check for data existence without the overhead of creating a full provider instance.\n   *\n   * @param meta - An object containing the name and version of the item to check.\n   * @returns `true` if the item exists, otherwise `false`.\n   *\n   * @example\n   * ```typescript\n   * const formExists = LocalStorageProvider.has({ name: 'user-form', version: 1 });\n   * if (formExists) {\n   *   // Show the \"Thank you\" message\n   * } else {\n   *   // Show the form\n   * }\n   * ```\n   */\n  public static has(meta: StorageMeta): boolean {\n    const key = LocalStorageProvider.getKey(meta);\n    return localStorage.getItem(key) !== null;\n  }\n\n  /**\n   * Writes the default value to localStorage and returns it.\n   */\n  private writeDefault__(): T {\n    this.logger_.logMethodArgs?.('writeDefaultــ', this.config_.defaultValue);\n    this.write(this.config_.defaultValue);\n    return this.config_.defaultValue;\n  }\n\n  /**\n   * Reads and parses the value from localStorage.\n   * If the item doesn't exist, is invalid JSON, or doesn't match the expected type,\n   * it writes and returns the default value.\n   */\n  public read(): T {\n    try {\n      const value = localStorage.getItem(this.key__);\n\n      if (value === null) {\n        this.logger_.logMethod?.('read//no_value');\n        return this.writeDefault__();\n      }\n\n      const parsedValue = JSON.parse(value) as T;\n      this.logger_.logMethodFull?.('read//value', undefined, {parsedValue});\n      return parsedValue;\n    }\n    catch (err) {\n      this.logger_.error('read', 'read_parse_error', {err});\n      return this.writeDefault__();\n    }\n  }\n\n  /**\n   * Serializes and writes a value to localStorage.\n   */\n  public write(value: T): void {\n    this.logger_.logMethodArgs?.('write', {value});\n    try {\n      localStorage.setItem(this.key__, JSON.stringify(value));\n    }\n    catch (err) {\n      this.logger_.error('write', 'write_stringify_error', {err});\n    }\n  }\n\n  /**\n   * Removes the item from localStorage.\n   */\n  public remove(): void {\n    localStorage.removeItem(this.key__);\n  }\n\n  /**\n   * Manages data migration by removing all previous versions of the item.\n   */\n  private migrate__(): void {\n    if (this.config_.version <= 1) return;\n\n    // Iterate from v1 up to the version just before the current one and remove them.\n    for (let i = 1; i < this.config_.version; i++) {\n      const oldKey = LocalStorageProvider.getKey({name: this.config_.name, version: i});\n      localStorage.removeItem(oldKey);\n    }\n  }\n}\n", "import {LocalStorageProvider} from './local-storage.provider.js';\n\nimport type {LocalStorageProviderConfig} from './type.js';\n\nexport * from './local-storage.provider.js';\nexport type * from './type.js';\n\n/**\n * Factory function to create a new LocalStorageProvider.\n *\n * @param config - The configuration for the provider.\n * @returns An instance of LocalStorageProvider.\n *\n * @example\n * ```typescript\n * const userSettings = createLocalStorageProvider({\n *   name: 'user-settings',\n *   version: 1,\n *   defaultValue: { theme: 'light', notifications: true }\n * });\n *\n * // Write new settings\n * userSettings.write({ theme: 'dark', notifications: false });\n *\n * // Read the current settings\n * const currentSettings = userSettings.read();\n * console.log(currentSettings); // { theme: 'dark', notifications: false }\n * ```\n */\nexport function createLocalStorageProvider<T extends JsonValue>(config: LocalStorageProviderConfig<T>): LocalStorageProvider<T> {\n  return new LocalStorageProvider<T>(config);\n}\n"],
-  "mappings": ";;;AAAA,SAAQ,oBAAmB;AAwBpB,IAAM,uBAAN,MAAM,sBAA0C;AAAA,EAM9C,YAA+B,SAAwC;AAAxC;AAFtC,SAAmB,UAAU,aAAa,2BAA2B,KAAK,QAAQ,IAAI,QAAQ,KAAK,QAAQ,OAAO,EAAE;AAGlH,SAAK,QAAQ,gBAAgB,eAAe,EAAC,QAAQ,KAAK,QAAO,CAAC;AAClE,SAAK,QAAQ,sBAAqB,OAAO,KAAK,OAAO;AACrD,SAAK,UAAU;AAAA,EACjB;AAAA,EATA;AAAA,SAAuB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBjC,OAAc,OAAO,MAA2B;AAC9C,WAAO,GAAG,KAAK,IAAI,KAAK,KAAK,OAAO;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,OAAc,IAAI,MAA4B;AAC5C,UAAM,MAAM,sBAAqB,OAAO,IAAI;AAC5C,WAAO,aAAa,QAAQ,GAAG,MAAM;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA,EAKQ,iBAAoB;AAC1B,SAAK,QAAQ,gBAAgB,kBAAkB,KAAK,QAAQ,YAAY;AACxE,SAAK,MAAM,KAAK,QAAQ,YAAY;AACpC,WAAO,KAAK,QAAQ;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,OAAU;AACf,QAAI;AACF,YAAM,QAAQ,aAAa,QAAQ,KAAK,KAAK;AAE7C,UAAI,UAAU,MAAM;AAClB,aAAK,QAAQ,YAAY,gBAAgB;AACzC,eAAO,KAAK,eAAe;AAAA,MAC7B;AAEA,YAAM,cAAc,KAAK,MAAM,KAAK;AACpC,WAAK,QAAQ,gBAAgB,eAAe,QAAW,EAAC,YAAW,CAAC;AACpE,aAAO;AAAA,IACT,SACO,KAAK;AACV,WAAK,QAAQ,MAAM,QAAQ,oBAAoB,EAAC,IAAG,CAAC;AACpD,aAAO,KAAK,eAAe;AAAA,IAC7B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,MAAM,OAAgB;AAC3B,SAAK,QAAQ,gBAAgB,SAAS,EAAC,MAAK,CAAC;AAC7C,QAAI;AACF,mBAAa,QAAQ,KAAK,OAAO,KAAK,UAAU,KAAK,CAAC;AAAA,IACxD,SACO,KAAK;AACV,WAAK,QAAQ,MAAM,SAAS,yBAAyB,EAAC,IAAG,CAAC;AAAA,IAC5D;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,SAAe;AACpB,iBAAa,WAAW,KAAK,KAAK;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA,EAKQ,YAAkB;AACxB,QAAI,KAAK,QAAQ,WAAW,EAAG;AAG/B,aAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,SAAS,KAAK;AAC7C,YAAM,SAAS,sBAAqB,OAAO,EAAC,MAAM,KAAK,QAAQ,MAAM,SAAS,EAAC,CAAC;AAChF,mBAAa,WAAW,MAAM;AAAA,IAChC;AAAA,EACF;AACF;;;ACvGO,SAAS,2BAAgD,QAAgE;AAC9H,SAAO,IAAI,qBAAwB,MAAM;AAC3C;",
+  "mappings": ";AAAA,OAAQ,iBAAmB,iBAwBpB,IAAM,qBAAN,MAAM,qBAA0C,CAM9C,YAA+B,QAAwC,CAAxC,qBAFtC,KAAmB,QAAU,aAAa,2BAA2B,KAAK,QAAQ,IAAI,QAAQ,KAAK,QAAQ,OAAO,EAAE,EAGlH,KAAK,QAAQ,gBAAgB,cAAe,CAAC,OAAQ,KAAK,OAAO,CAAC,EAClE,KAAK,MAAQ,sBAAqB,OAAO,KAAK,OAAO,EACrD,KAAK,UAAU,CACjB,CATA,YAAuB,QAAU,QAgBjC,OAAc,OAAO,KAA2B,CAC9C,MAAO,GAAG,KAAK,IAAI,KAAK,KAAK,OAAO,EACtC,CAmBA,OAAc,IAAI,KAA4B,CAC5C,MAAM,IAAM,sBAAqB,OAAO,IAAI,EAC5C,OAAO,aAAa,QAAQ,GAAG,IAAM,IACvC,CAKQ,gBAAoB,CAC1B,KAAK,QAAQ,gBAAgB,iBAAkB,KAAK,QAAQ,YAAY,EACxE,KAAK,MAAM,KAAK,QAAQ,YAAY,EACpC,OAAO,KAAK,QAAQ,YACtB,CAOO,MAAU,CACf,GAAI,CACF,MAAM,MAAQ,aAAa,QAAQ,KAAK,KAAK,EAE7C,GAAI,QAAU,KAAM,CAClB,KAAK,QAAQ,YAAY,gBAAgB,EACzC,OAAO,KAAK,eAAe,CAC7B,CAEA,MAAM,YAAc,KAAK,MAAM,KAAK,EACpC,KAAK,QAAQ,gBAAgB,cAAe,OAAW,CAAC,WAAW,CAAC,EACpE,OAAO,WACT,OACO,IAAK,CACV,KAAK,QAAQ,MAAM,OAAQ,mBAAoB,CAAC,GAAG,CAAC,EACpD,OAAO,KAAK,eAAe,CAC7B,CACF,CAKO,MAAM,MAAgB,CAC3B,KAAK,QAAQ,gBAAgB,QAAS,CAAC,KAAK,CAAC,EAC7C,GAAI,CACF,aAAa,QAAQ,KAAK,MAAO,KAAK,UAAU,KAAK,CAAC,CACxD,OACO,IAAK,CACV,KAAK,QAAQ,MAAM,QAAS,wBAAyB,CAAC,GAAG,CAAC,CAC5D,CACF,CAKO,QAAe,CACpB,aAAa,WAAW,KAAK,KAAK,CACpC,CAKQ,WAAkB,CACxB,GAAI,KAAK,QAAQ,SAAW,EAAG,OAG/B,QAAS,EAAI,EAAG,EAAI,KAAK,QAAQ,QAAS,IAAK,CAC7C,MAAM,OAAS,sBAAqB,OAAO,CAAC,KAAM,KAAK,QAAQ,KAAM,QAAS,CAAC,CAAC,EAChF,aAAa,WAAW,MAAM,CAChC,CACF,CACF,ECvGO,SAAS,2BAAgD,OAAgE,CAC9H,OAAO,IAAI,qBAAwB,MAAM,CAC3C",
   "names": []
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@alwatr/local-storage",
   "description": "A modern, simple, and robust solution for managing versioned JSON objects in the browser's `localStorage`. This package provides a clean, class-based API with a factory function to ensure your application's data persistence is safe, maintainable, and future-proof.",
-  "version": "6.1.2",
+  "version": "6.1.3",
   "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
   "bugs": "https://github.com/Alwatr/nanolib/issues",
   "dependencies": {
-    "@alwatr/logger": "6.0.0"
+    "@alwatr/logger": "6.0.1"
   },
   "devDependencies": {
-    "@alwatr/nano-build": "6.1.2",
+    "@alwatr/nano-build": "6.2.0",
     "@alwatr/prettier-config": "5.0.3",
     "@alwatr/tsconfig-base": "6.0.1",
     "@alwatr/type-helper": "6.0.2",
@@ -74,5 +74,5 @@
   },
   "type": "module",
   "types": "./dist/main.d.ts",
-  "gitHead": "4249b4e06eeb5739e1d6dbacfbce5b33a3180263"
+  "gitHead": "e081773e1ba6bf1c62c07d7dc966b174fa7dd3ea"
 }