@alwatr/local-storage 6.3.3 → 6.3.4

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.3.4](https://github.com/Alwatr/nanolib/compare/@alwatr/local-storage@6.3.3...@alwatr/local-storage@6.3.4) (2025-09-27)
+
+### 🧹 Miscellaneous Chores
+
+* exclude test files from package distribution ([86f4f2f](https://github.com/Alwatr/nanolib/commit/86f4f2f5985845c5cf3a3a9398de7b2f98ce53e7))
+
 ## [6.3.3](https://github.com/Alwatr/nanolib/compare/@alwatr/local-storage@6.3.2...@alwatr/local-storage@6.3.3) (2025-09-22)
 
 ### 🐛 Bug Fixes

package/dist/main.cjs

@@ -1,4 +1,4 @@
-/** 📦 @alwatr/local-storage v6.3.3 */
-__dev_mode__: console.debug("📦 @alwatr/local-storage v6.3.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{static{this.version="6.3.3"}constructor(config){this.logger_=(0,import_logger.createLogger)(`local-storage-provider: ${config.name}, v: ${config.schemaVersion}`);this.logger_.logMethodArgs?.("constructor",{config});this.meta__={name:config.name,schemaVersion:config.schemaVersion};this.key__=_LocalStorageProvider.getKey(this.meta__);this.defaultValue__=this.convertDataType__(config.defaultValue);this.migrate__()}static getKey(meta){return`${meta.name}.v${meta.schemaVersion}`}static has(meta){const key=_LocalStorageProvider.getKey(meta);return localStorage.getItem(key)!==null}handleDefault__(){this.logger_.logMethodArgs?.("handleDefault__",this.defaultValue__);try{this.write(this.defaultValue__)}catch(err){this.logger_.error("write","write_default_error",{err})}return this.defaultValue__}convertDataType__(data){this.logger_.logMethod?.("convertDataType");try{return JSON.parse(JSON.stringify(data))}catch(err){this.logger_.error("convertDataType__","convert_data_type_error",{err});throw new Error("convert_data_type_error")}}read(){let value=null;try{value=localStorage.getItem(this.key__)}catch(err){this.logger_.error("read","read_local_storage_error",{err})}if(value===null){this.logger_.logMethod?.("read//no_value");return this.handleDefault__()}try{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.handleDefault__()}}write(value){this.logger_.logMethodArgs?.("write",{value});let valueStr;try{valueStr=JSON.stringify(value)}catch(err){this.logger_.error("write","write_stringify_error",{err});throw new Error("write_stringify_error")}try{localStorage.setItem(this.key__,valueStr)}catch(err){this.logger_.error("write","write_local_storage_error",{err})}}remove(){localStorage.removeItem(this.key__)}migrate__(){if(this.meta__.schemaVersion<=1)return;for(let i=1;i<this.meta__.schemaVersion;i++){const oldKey=_LocalStorageProvider.getKey({name:this.meta__.name,schemaVersion:i});localStorage.removeItem(oldKey)}}};function createLocalStorageProvider(config){return new LocalStorageProvider(config)}0&&(module.exports={LocalStorageProvider,createLocalStorageProvider});
+/** 📦 @alwatr/local-storage v6.3.4 */
+__dev_mode__: console.debug("📦 @alwatr/local-storage v6.3.4");
+"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{static{this.version="6.3.4"}constructor(config){this.logger_=(0,import_logger.createLogger)(`local-storage-provider: ${config.name}, v: ${config.schemaVersion}`);this.logger_.logMethodArgs?.("constructor",{config});this.meta__={name:config.name,schemaVersion:config.schemaVersion};this.key__=_LocalStorageProvider.getKey(this.meta__);this.defaultValue__=this.convertDataType__(config.defaultValue);this.migrate__()}static getKey(meta){return`${meta.name}.v${meta.schemaVersion}`}static has(meta){const key=_LocalStorageProvider.getKey(meta);return localStorage.getItem(key)!==null}handleDefault__(){this.logger_.logMethodArgs?.("handleDefault__",this.defaultValue__);try{this.write(this.defaultValue__)}catch(err){this.logger_.error("write","write_default_error",{err})}return this.defaultValue__}convertDataType__(data){this.logger_.logMethod?.("convertDataType");try{return JSON.parse(JSON.stringify(data))}catch(err){this.logger_.error("convertDataType__","convert_data_type_error",{err});throw new Error("convert_data_type_error")}}read(){let value=null;try{value=localStorage.getItem(this.key__)}catch(err){this.logger_.error("read","read_local_storage_error",{err})}if(value===null){this.logger_.logMethod?.("read//no_value");return this.handleDefault__()}try{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.handleDefault__()}}write(value){this.logger_.logMethodArgs?.("write",{value});let valueStr;try{valueStr=JSON.stringify(value)}catch(err){this.logger_.error("write","write_stringify_error",{err});throw new Error("write_stringify_error")}try{localStorage.setItem(this.key__,valueStr)}catch(err){this.logger_.error("write","write_local_storage_error",{err})}}remove(){localStorage.removeItem(this.key__)}migrate__(){if(this.meta__.schemaVersion<=1)return;for(let i=1;i<this.meta__.schemaVersion;i++){const oldKey=_LocalStorageProvider.getKey({name:this.meta__.name,schemaVersion:i});localStorage.removeItem(oldKey)}}};function createLocalStorageProvider(config){return new LocalStorageProvider(config)}0&&(module.exports={LocalStorageProvider,createLocalStorageProvider});
 //# sourceMappingURL=main.cjs.map

package/dist/main.mjs

@@ -1,4 +1,4 @@
-/** 📦 @alwatr/local-storage v6.3.3 */
-__dev_mode__: console.debug("📦 @alwatr/local-storage v6.3.3");
-import{createLogger}from"@alwatr/logger";var LocalStorageProvider=class _LocalStorageProvider{static{this.version="6.3.3"}constructor(config){this.logger_=createLogger(`local-storage-provider: ${config.name}, v: ${config.schemaVersion}`);this.logger_.logMethodArgs?.("constructor",{config});this.meta__={name:config.name,schemaVersion:config.schemaVersion};this.key__=_LocalStorageProvider.getKey(this.meta__);this.defaultValue__=this.convertDataType__(config.defaultValue);this.migrate__()}static getKey(meta){return`${meta.name}.v${meta.schemaVersion}`}static has(meta){const key=_LocalStorageProvider.getKey(meta);return localStorage.getItem(key)!==null}handleDefault__(){this.logger_.logMethodArgs?.("handleDefault__",this.defaultValue__);try{this.write(this.defaultValue__)}catch(err){this.logger_.error("write","write_default_error",{err})}return this.defaultValue__}convertDataType__(data){this.logger_.logMethod?.("convertDataType");try{return JSON.parse(JSON.stringify(data))}catch(err){this.logger_.error("convertDataType__","convert_data_type_error",{err});throw new Error("convert_data_type_error")}}read(){let value=null;try{value=localStorage.getItem(this.key__)}catch(err){this.logger_.error("read","read_local_storage_error",{err})}if(value===null){this.logger_.logMethod?.("read//no_value");return this.handleDefault__()}try{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.handleDefault__()}}write(value){this.logger_.logMethodArgs?.("write",{value});let valueStr;try{valueStr=JSON.stringify(value)}catch(err){this.logger_.error("write","write_stringify_error",{err});throw new Error("write_stringify_error")}try{localStorage.setItem(this.key__,valueStr)}catch(err){this.logger_.error("write","write_local_storage_error",{err})}}remove(){localStorage.removeItem(this.key__)}migrate__(){if(this.meta__.schemaVersion<=1)return;for(let i=1;i<this.meta__.schemaVersion;i++){const oldKey=_LocalStorageProvider.getKey({name:this.meta__.name,schemaVersion:i});localStorage.removeItem(oldKey)}}};function createLocalStorageProvider(config){return new LocalStorageProvider(config)}export{LocalStorageProvider,createLocalStorageProvider};
+/** 📦 @alwatr/local-storage v6.3.4 */
+__dev_mode__: console.debug("📦 @alwatr/local-storage v6.3.4");
+import{createLogger}from"@alwatr/logger";var LocalStorageProvider=class _LocalStorageProvider{static{this.version="6.3.4"}constructor(config){this.logger_=createLogger(`local-storage-provider: ${config.name}, v: ${config.schemaVersion}`);this.logger_.logMethodArgs?.("constructor",{config});this.meta__={name:config.name,schemaVersion:config.schemaVersion};this.key__=_LocalStorageProvider.getKey(this.meta__);this.defaultValue__=this.convertDataType__(config.defaultValue);this.migrate__()}static getKey(meta){return`${meta.name}.v${meta.schemaVersion}`}static has(meta){const key=_LocalStorageProvider.getKey(meta);return localStorage.getItem(key)!==null}handleDefault__(){this.logger_.logMethodArgs?.("handleDefault__",this.defaultValue__);try{this.write(this.defaultValue__)}catch(err){this.logger_.error("write","write_default_error",{err})}return this.defaultValue__}convertDataType__(data){this.logger_.logMethod?.("convertDataType");try{return JSON.parse(JSON.stringify(data))}catch(err){this.logger_.error("convertDataType__","convert_data_type_error",{err});throw new Error("convert_data_type_error")}}read(){let value=null;try{value=localStorage.getItem(this.key__)}catch(err){this.logger_.error("read","read_local_storage_error",{err})}if(value===null){this.logger_.logMethod?.("read//no_value");return this.handleDefault__()}try{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.handleDefault__()}}write(value){this.logger_.logMethodArgs?.("write",{value});let valueStr;try{valueStr=JSON.stringify(value)}catch(err){this.logger_.error("write","write_stringify_error",{err});throw new Error("write_stringify_error")}try{localStorage.setItem(this.key__,valueStr)}catch(err){this.logger_.error("write","write_local_storage_error",{err})}}remove(){localStorage.removeItem(this.key__)}migrate__(){if(this.meta__.schemaVersion<=1)return;for(let i=1;i<this.meta__.schemaVersion;i++){const oldKey=_LocalStorageProvider.getKey({name:this.meta__.name,schemaVersion:i});localStorage.removeItem(oldKey)}}};function createLocalStorageProvider(config){return new LocalStorageProvider(config)}export{LocalStorageProvider,createLocalStorageProvider};
 //# sourceMappingURL=main.mjs.map

package/package.json

@@ -1,17 +1,17 @@
 {
   "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.3.3",
+  "version": "6.3.4",
   "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
   "bugs": "https://github.com/Alwatr/nanolib/issues",
   "dependencies": {
-    "@alwatr/logger": "6.0.7"
+    "@alwatr/logger": "6.0.8"
   },
   "devDependencies": {
-    "@alwatr/nano-build": "6.3.3",
-    "@alwatr/prettier-config": "5.0.4",
-    "@alwatr/tsconfig-base": "6.0.2",
-    "@alwatr/type-helper": "6.1.3",
+    "@alwatr/nano-build": "6.3.4",
+    "@alwatr/prettier-config": "5.0.5",
+    "@alwatr/tsconfig-base": "6.0.3",
+    "@alwatr/type-helper": "6.1.4",
     "@jest/globals": "^30.1.2",
     "typescript": "^5.9.2"
   },
@@ -25,7 +25,8 @@
   "files": [
     "**/*.{js,mjs,cjs,map,d.ts,html,md,LEGAL.txt}",
     "LICENSE",
-    "!demo/**/*"
+    "!demo/**/*",
+    "!**/*.test.js"
   ],
   "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/local-storage#readme",
   "keywords": [
@@ -75,5 +76,5 @@
   "sideEffects": false,
   "type": "module",
   "types": "./dist/main.d.ts",
-  "gitHead": "a0c8605949969959c8226e54b8c8c0fc7276819a"
+  "gitHead": "c013ded43aff3937cf347de4e99125ab807d99e1"
 }

package/src/main.test.js

@@ -1,234 +0,0 @@
-import {describe, beforeEach, afterEach, it, expect, jest} from '@jest/globals';
-import {createLocalStorageProvider, LocalStorageProvider} from '@alwatr/local-storage';
-
-/**
- * @jest-environment jsdom
- */
-describe('LocalStorageProvider', () => {
-  /**
-   * @type {jest.Mocked<Pick<Storage, "getItem" | "setItem" | "removeItem">>}
-   */
-  let mockLocalStorage;
-
-  beforeEach(() => {
-    mockLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-    Object.defineProperty(globalThis, 'localStorage', {
-      value: mockLocalStorage,
-      writable: true,
-    });
-  });
-
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  describe('static getKey', () => {
-    it('should generate the correct versioned key', () => {
-      const key = LocalStorageProvider.getKey({name: 'test', schemaVersion: 1});
-      expect(key).toBe('test.v1');
-    });
-
-    it('should handle different names and versions', () => {
-      const key1 = LocalStorageProvider.getKey({name: 'user-settings', schemaVersion: 2});
-      expect(key1).toBe('user-settings.v2');
-      const key2 = LocalStorageProvider.getKey({name: 'form-data', schemaVersion: 5});
-      expect(key2).toBe('form-data.v5');
-    });
-  });
-
-  describe('static has', () => {
-    it('should return true if item exists', () => {
-      mockLocalStorage.getItem.mockReturnValue('{"value": "test"}');
-      const exists = LocalStorageProvider.has({name: 'test', schemaVersion: 1});
-      expect(exists).toBe(true);
-      expect(mockLocalStorage.getItem).toHaveBeenCalledWith('test.v1');
-    });
-
-    it('should return false if item does not exist', () => {
-      mockLocalStorage.getItem.mockReturnValue(null);
-      const exists = LocalStorageProvider.has({name: 'test', schemaVersion: 1});
-      expect(exists).toBe(false);
-    });
-
-    it('should return false for null value', () => {
-      mockLocalStorage.getItem.mockReturnValue(null);
-      const exists = LocalStorageProvider.has({name: 'test', schemaVersion: 1});
-      expect(exists).toBe(false);
-    });
-  });
-
-  describe('constructor and migration', () => {
-    it('should initialize with config and migrate old versions', () => {
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 3,
-        defaultValue: {key: 'value'},
-      });
-      expect(mockLocalStorage.removeItem).toHaveBeenCalledWith('test.v1');
-      expect(mockLocalStorage.removeItem).toHaveBeenCalledWith('test.v2');
-    });
-
-    it('should not migrate if schemaVersion is 1', () => {
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {key: 'value'},
-      });
-      expect(mockLocalStorage.removeItem).not.toHaveBeenCalled();
-    });
-
-    it('should migrate multiple old versions for higher schemaVersion', () => {
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 5,
-        defaultValue: {key: 'value'},
-      });
-      expect(mockLocalStorage.removeItem).toHaveBeenCalledWith('test.v1');
-      expect(mockLocalStorage.removeItem).toHaveBeenCalledWith('test.v2');
-      expect(mockLocalStorage.removeItem).toHaveBeenCalledWith('test.v3');
-      expect(mockLocalStorage.removeItem).toHaveBeenCalledWith('test.v4');
-    });
-  });
-
-  describe('read', () => {
-    it('should return default value if no item exists', () => {
-      mockLocalStorage.getItem.mockReturnValue(null);
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {key: 'default'},
-      });
-      const result = provider.read();
-      expect(result).toEqual({key: 'default'});
-      expect(mockLocalStorage.setItem).toHaveBeenCalledWith('test.v1', '{"key":"default"}');
-    });
-
-    it('should return parsed value if item exists', () => {
-      mockLocalStorage.getItem.mockReturnValue('{"key":"stored"}');
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {key: 'default'},
-      });
-      const result = provider.read();
-      expect(result).toEqual({key: 'stored'});
-    });
-
-    it('should return default value on invalid JSON', () => {
-      mockLocalStorage.getItem.mockReturnValue('invalid json');
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {key: 'default'},
-      });
-      const result = provider.read();
-      expect(result).toEqual({key: 'default'});
-    });
-
-    it('should handle complex default values', () => {
-      mockLocalStorage.getItem.mockReturnValue(null);
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {theme: 'dark', lastLogin: Date.now(), settings: [1, 2, 3]},
-      });
-      const result = provider.read();
-      expect(result.theme).toBe('dark');
-      expect(Array.isArray(result.settings)).toBe(true);
-    });
-  });
-
-  describe('write', () => {
-    it('should serialize and store the value', () => {
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {key: 'default'},
-      });
-      provider.write({key: 'newValue'});
-      expect(mockLocalStorage.setItem).toHaveBeenCalledWith('test.v1', '{"key":"newValue"}');
-    });
-
-    it('should handle write errors gracefully', () => {
-      mockLocalStorage.setItem.mockImplementation(() => {
-        throw new Error('Storage full');
-      });
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {key: 'default'},
-      });
-      expect(() => provider.write({key: 'value'})).not.toThrow();
-    });
-
-    it('should write different data types', () => {
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        /**
-         * @type {string|number|Array<number>}
-         */
-        defaultValue: '',
-      });
-      provider.write('string value');
-      expect(mockLocalStorage.setItem).toHaveBeenCalledWith('test.v1', '"string value"');
-      provider.write(42);
-      expect(mockLocalStorage.setItem).toHaveBeenCalledWith('test.v1', '42');
-      provider.write([1, 2, 3]);
-      expect(mockLocalStorage.setItem).toHaveBeenCalledWith('test.v1', '[1,2,3]');
-    });
-  });
-
-  describe('remove', () => {
-    it('should remove the item from storage', () => {
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {key: 'default'},
-      });
-      provider.remove();
-      expect(mockLocalStorage.removeItem).toHaveBeenCalledWith('test.v1');
-    });
-
-    it('should not throw if item does not exist', () => {
-      const provider = createLocalStorageProvider({
-        name: 'test',
-        schemaVersion: 1,
-        defaultValue: {key: 'default'},
-      });
-      expect(() => provider.remove()).not.toThrow();
-    });
-  });
-
-  describe('createLocalStorageProvider factory', () => {
-    it('should create a provider instance', () => {
-      const provider = createLocalStorageProvider({
-        name: 'factory-test',
-        schemaVersion: 1,
-        defaultValue: {created: true},
-      });
-      expect(provider).toBeInstanceOf(LocalStorageProvider);
-      const result = provider.read();
-      expect(result.created).toBe(true);
-    });
-
-    it('should handle different configurations', () => {
-      const provider1 = createLocalStorageProvider({
-        name: 'config1',
-        schemaVersion: 2,
-        defaultValue: 'default1',
-      });
-      const provider2 = createLocalStorageProvider({
-        name: 'config2',
-        schemaVersion: 1,
-        defaultValue: {key: 'default2'},
-      });
-      expect(provider1.read()).toBe('default1');
-      expect(provider2.read().key).toBe('default2');
-    });
-  });
-});