@nlabs/arkhamjs-storage-browser 3.28.5 → 3.29.0

package/README.md

@@ -1,5 +1,7 @@
 # @nlabs/arkhamjs-storage-browser
 
+> **Browser Storage Integration for ArkhamJS** - Seamless localStorage and sessionStorage persistence with automatic state synchronization, compression, and encryption support.
+
 [![npm version](https://img.shields.io/npm/v/@nlabs/arkhamjs-storage-browser.svg?style=flat-square)](https://www.npmjs.com/package/@nlabs/arkhamjs-storage-browser)
 [![npm downloads](https://img.shields.io/npm/dm/@nlabs/arkhamjs-storage-browser.svg?style=flat-square)](https://www.npmjs.com/package/@nlabs/arkhamjs-storage-browser)
 [![Travis](https://img.shields.io/travis/nitrogenlabs/arkhamjs.svg?style=flat-square)](https://travis-ci.org/nitrogenlabs/arkhamjs)
@@ -8,14 +10,550 @@
 [![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](http://opensource.org/licenses/MIT)
 [![Chat](https://img.shields.io/discord/446122412715802649.svg)](https://discord.gg/Ttgev58)
 
-## Installation
+## 🚀 Features
+
+- **💾 Automatic Persistence** - State automatically persists across browser sessions
+- **🔄 Real-Time Sync** - State changes are immediately saved to storage
+- **🎯 Selective Persistence** - Choose which parts of state to persist
+- **⚡ Performance Optimized** - Debounced writes and efficient serialization
+- **🔒 Encryption Support** - Optional encryption for sensitive data
+- **🗜️ Compression** - Automatic compression for large state objects
+- **📱 Cross-Tab Sync** - Synchronize state across multiple browser tabs
+- **🔧 Configurable** - Extensive options for customization
+- **🌲 Tree-shakable** - Only include what you need
+
+## 📦 Installation
+
+```bash
+npm install @nlabs/arkhamjs-storage-browser
+```
+
+## 🎯 Quick Start
+
+### **Basic Setup**
+
+```js
+import { Flux } from '@nlabs/arkhamjs';
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+// Initialize Flux with browser storage
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore, CartStore],
+  storage: BrowserStorage, // Enable localStorage persistence
+  storageWait: 300 // Debounce storage updates by 300ms
+});
+
+// State will automatically persist across browser sessions
+Flux.dispatch({ type: 'ADD_USER', user: { name: 'John' } });
+// User data is now saved to localStorage
+```
+
+### **Storage Types**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+// Use localStorage (persists across sessions)
+const localStorage = BrowserStorage.local;
+
+// Use sessionStorage (cleared when tab closes)
+const sessionStorage = BrowserStorage.session;
+
+// Use custom storage implementation
+const customStorage = BrowserStorage.create({
+  getItem: (key) => customGet(key),
+  setItem: (key, value) => customSet(key, value),
+  removeItem: (key) => customRemove(key)
+});
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: localStorage, // or sessionStorage, or customStorage
+});
+```
+
+## 🔧 Configuration Options
+
+### **Basic Configuration**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Storage options
+  storageWait: 300,              // Debounce storage updates (ms)
+  storageDebounce: true,         // Enable debouncing
+  storageThrottle: false,        // Use throttling instead of debouncing
+
+  // Persistence options
+  storagePersist: true,          // Enable persistence
+  storageRestore: true,          // Restore state on initialization
+  storageClear: false,           // Clear storage on initialization
+
+  // Data options
+  storageSerialize: true,        // Serialize data before storage
+  storageCompress: false,        // Compress data before storage
+  storageEncrypt: false,         // Encrypt data before storage
+
+  // Key options
+  storageKey: 'arkhamjs-state',  // Storage key prefix
+  storageNamespace: 'my-app',    // Namespace for storage keys
+});
+```
+
+### **Advanced Configuration**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Selective persistence
+  storagePaths: [
+    'user.current',    // Only persist current user
+    'user.preferences', // Only persist user preferences
+    'cart.items'       // Only persist cart items
+  ],
+
+  // Exclude sensitive data
+  storageExclude: [
+    'user.password',   // Don't persist passwords
+    'auth.token',      // Don't persist auth tokens
+    'temp.*'           // Don't persist temporary data
+  ],
+
+  // Custom serialization
+  storageSerialize: (state) => {
+    // Custom serialization logic
+    return JSON.stringify(state, (key, value) => {
+      if (key === 'password') return undefined; // Remove passwords
+      if (key === 'token') return undefined;    // Remove tokens
+      return value;
+    });
+  },
+
+  // Custom deserialization
+  storageDeserialize: (data) => {
+    // Custom deserialization logic
+    const state = JSON.parse(data);
+    // Add default values or transform data
+    return state;
+  },
+
+  // Storage events
+  storageEvents: {
+    onSave: (key, value) => {
+      console.log(`Saved to storage: ${key}`);
+    },
+    onLoad: (key, value) => {
+      console.log(`Loaded from storage: ${key}`);
+    },
+    onError: (error) => {
+      console.error('Storage error:', error);
+    }
+  }
+});
+```
+
+### **Production Configuration**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+const isDevelopment = process.env.NODE_ENV === 'development';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Development: Full persistence with debugging
+  ...(isDevelopment && {
+    storageWait: 100,
+    storageDebounce: true,
+    storageEvents: {
+      onSave: (key, value) => console.log(`💾 Saved: ${key}`),
+      onLoad: (key, value) => console.log(`📂 Loaded: ${key}`)
+    }
+  }),
+
+  // Production: Optimized persistence
+  ...(!isDevelopment && {
+    storageWait: 500,
+    storageDebounce: true,
+    storageCompress: true,
+    storageEvents: {
+      onError: (error) => {
+        // Send to error tracking service
+        analytics.track('storage_error', { error: error.message });
+      }
+    }
+  })
+});
+```
+
+## 🎨 Storage Features
+
+### **Automatic State Persistence**
+
+State automatically persists across browser sessions:
+
+```js
+// User logs in
+Flux.dispatch({ type: 'USER_LOGIN', user: { id: 1, name: 'John' } });
+
+// User closes browser and reopens
+// State is automatically restored from localStorage
+const user = Flux.getState('user.current'); // { id: 1, name: 'John' }
+```
+
+### **Selective Persistence**
+
+Choose which parts of state to persist:
+
+```js
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Only persist specific paths
+  storagePaths: [
+    'user.current',      // Persist current user
+    'user.preferences',  // Persist user preferences
+    'cart.items',        // Persist cart items
+    'ui.theme'           // Persist UI theme
+  ],
+
+  // Exclude sensitive or temporary data
+  storageExclude: [
+    'user.password',     // Don't persist passwords
+    'auth.token',        // Don't persist auth tokens
+    'temp.*',            // Don't persist temporary data
+    'ui.loading'         // Don't persist loading states
+  ]
+});
+```
+
+### **Cross-Tab Synchronization**
+
+Synchronize state across multiple browser tabs:
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Enable cross-tab sync
+  storageSync: true,
+
+  // Custom sync events
+  storageEvents: {
+    onSync: (event) => {
+      if (event.key === 'arkhamjs-state') {
+        console.log('State synced from another tab');
+        // Optionally refresh UI or show notification
+      }
+    }
+  }
+});
+
+// State changes in one tab will automatically sync to other tabs
+```
+
+### **Data Compression**
 
-Using [npm](https://www.npmjs.com/):
+Compress large state objects to save storage space:
 
-```shell
-npm i --save @nlabs/arkhamjs-storage-browser
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Enable compression for large state objects
+  storageCompress: true,
+  storageCompressThreshold: 1024, // Compress if >1KB
+
+  // Custom compression
+  storageCompress: (data) => {
+    // Use custom compression library
+    return customCompress(data);
+  },
+
+  // Custom decompression
+  storageDecompress: (data) => {
+    // Use custom decompression library
+    return customDecompress(data);
+  }
+});
+```
+
+### **Data Encryption**
+
+Encrypt sensitive data before storage:
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Enable encryption
+  storageEncrypt: true,
+  storageEncryptKey: 'your-secret-key',
+
+  // Custom encryption
+  storageEncrypt: (data, key) => {
+    // Use custom encryption library
+    return customEncrypt(data, key);
+  },
+
+  // Custom decryption
+  storageDecrypt: (data, key) => {
+    // Use custom decryption library
+    return customDecrypt(data, key);
+  }
+});
+```
+
+## 🔍 Advanced Usage
+
+### **Custom Storage Implementation**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+// Create custom storage adapter
+const customStorage = BrowserStorage.create({
+  // Required methods
+  getItem: (key) => {
+    // Custom get implementation
+    return localStorage.getItem(key);
+  },
+
+  setItem: (key, value) => {
+    // Custom set implementation
+    localStorage.setItem(key, value);
+  },
+
+  removeItem: (key) => {
+    // Custom remove implementation
+    localStorage.removeItem(key);
+  },
+
+  // Optional methods
+  clear: () => {
+    // Custom clear implementation
+    localStorage.clear();
+  },
+
+  key: (index) => {
+    // Custom key implementation
+    return localStorage.key(index);
+  },
+
+  get length() {
+    // Custom length implementation
+    return localStorage.length;
+  }
+});
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: customStorage
+});
+```
+
+### **Storage Migration**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Storage migration
+  storageMigrate: (oldData, newData) => {
+    // Migrate from old format to new format
+    if (oldData.version === 1) {
+      return {
+        ...newData,
+        user: {
+          ...newData.user,
+          // Migrate old user format
+          current: oldData.user ? { ...oldData.user, id: oldData.user.id || 1 } : null
+        }
+      };
+    }
+    return newData;
+  },
+
+  // Version tracking
+  storageVersion: 2,
+
+  // Migration events
+  storageEvents: {
+    onMigrate: (oldVersion, newVersion) => {
+      console.log(`Migrated from v${oldVersion} to v${newVersion}`);
+    }
+  }
+});
+```
+
+### **Storage Analytics**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore],
+  storage: BrowserStorage,
+
+  // Storage analytics
+  storageEvents: {
+    onSave: (key, value) => {
+      // Track storage usage
+      analytics.track('storage_save', {
+        key,
+        size: JSON.stringify(value).length,
+        timestamp: Date.now()
+      });
+    },
+
+    onLoad: (key, value) => {
+      // Track storage reads
+      analytics.track('storage_load', {
+        key,
+        size: JSON.stringify(value).length,
+        timestamp: Date.now()
+      });
+    },
+
+    onError: (error) => {
+      // Track storage errors
+      analytics.track('storage_error', {
+        error: error.message,
+        timestamp: Date.now()
+      });
+    }
+  }
+});
+```
+
+## 🎯 Use Cases
+
+### **User Preferences Persistence**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [UserStore, PreferencesStore],
+  storage: BrowserStorage,
+
+  // Only persist user preferences
+  storagePaths: [
+    'user.preferences.theme',
+    'user.preferences.language',
+    'user.preferences.notifications',
+    'ui.sidebar.collapsed'
+  ]
+});
+
+// User preferences will persist across sessions
+Flux.dispatch({ type: 'SET_THEME', theme: 'dark' });
+// Theme preference is automatically saved
+```
+
+### **Shopping Cart Persistence**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [CartStore],
+  storage: BrowserStorage,
+
+  // Persist cart items
+  storagePaths: ['cart.items', 'cart.total'],
+
+  // Don't persist temporary cart state
+  storageExclude: ['cart.loading', 'cart.error']
+});
+
+// Cart items persist if user closes browser
+Flux.dispatch({ type: 'CART_ADD', item: { id: 1, name: 'Product' } });
+// Cart is automatically saved
+```
+
+### **Form Data Persistence**
+
+```js
+import { BrowserStorage } from '@nlabs/arkhamjs-storage-browser';
+
+Flux.init({
+  name: 'my-app',
+  stores: [FormStore],
+  storage: BrowserStorage,
+
+  // Persist form data with short debounce
+  storageWait: 100,
+  storagePaths: ['form.draft'],
+
+  // Clear form data on successful submission
+  storageEvents: {
+    onAction: (action) => {
+      if (action.type === 'FORM_SUBMIT_SUCCESS') {
+        // Clear draft data
+        localStorage.removeItem('arkhamjs-state-form.draft');
+      }
+    }
+  }
+});
+
+// Form data is automatically saved as user types
+// Prevents data loss if user accidentally closes browser
 ```
 
-## Documentation
+## 🔗 Related Packages
+
+- **[@nlabs/arkhamjs](./arkhamjs/README.md)** - Core Flux framework
+- **[@nlabs/arkhamjs-storage-native](./arkhamjs-storage-native/README.md)** - React Native storage
+- **[@nlabs/arkhamjs-storage-node](./arkhamjs-storage-node/README.md)** - Node.js storage
+
+## 📚 Documentation
+
+For detailed documentation and examples, visit [arkhamjs.io](https://arkhamjs.io).
+
+## 🤝 Community & Support
+
+- **💬 [Discord Community](https://discord.gg/Ttgev58)** - Chat with other developers
+- **🐛 [GitHub Issues](https://github.com/nitrogenlabs/arkhamjs/issues)** - Report bugs and request features
+- **📖 [Documentation](https://arkhamjs.io)** - Complete API reference
+
+## 📄 License
 
-For detailed [Documentation](https://arkhamjs.io) and additional options.
+MIT License - see [LICENSE](../LICENSE) file for details.

package/lib/BrowserStorage/BrowserStorage.d.ts

@@ -0,0 +1,16 @@
+import { BrowserStorageOptions } from '../types/main';
+export declare class BrowserStorage {
+    static window: any;
+    private options;
+    constructor(options?: BrowserStorageOptions);
+    static delLocalData(key: string): boolean;
+    static delSessionData(key: string): boolean;
+    static getLocalData(key: string): any;
+    static getLocalStorage(): any;
+    static getSessionData(key: string): any;
+    static getSessionStorage(): any;
+    static setLocalData(key: string, value: any): boolean;
+    static setSessionData(key: string, value: any): boolean;
+    getStorageData(key: string): Promise<any>;
+    setStorageData(key: string, value: any): Promise<boolean>;
+}

package/lib/BrowserStorage/BrowserStorage.js

@@ -0,0 +1,2 @@
+var n=Object.defineProperty;var i=Object.getOwnPropertyDescriptor;var l=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var g=(o,t)=>{for(var e in t)n(o,e,{get:t[e],enumerable:!0})},u=(o,t,e,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of l(t))!c.call(o,a)&&a!==e&&n(o,a,{get:()=>t[a],enumerable:!(s=i(t,a))||s.enumerable});return o};var S=o=>u(n({},"__esModule",{value:!0}),o);var f={};g(f,{BrowserStorage:()=>r});module.exports=S(f);class r{constructor(t={}){this.options={type:"session"};this.getStorageData=this.getStorageData.bind(this),this.setStorageData=this.setStorageData.bind(this),this.options={...this.options,...t}}static{this.window=window||{}}static delLocalData(t){const e=r.getLocalStorage();if(e)try{return e.removeItem(t),!0}catch{return!1}else return!1}static delSessionData(t){const e=r.getSessionStorage();if(e)try{return e.removeItem(t),!0}catch{return!1}else return!1}static getLocalData(t){const e=r.getLocalStorage();if(e)try{const s=e.getItem(t);return s?JSON.parse(s):null}catch{return null}else return null}static getLocalStorage(){const{localStorage:t}=r.window;return t}static getSessionData(t){const e=r.getSessionStorage();if(e)try{const s=e.getItem(t);return s&&s?JSON.parse(s):null}catch{return null}else return null}static getSessionStorage(){const{sessionStorage:t}=r.window;return t}static setLocalData(t,e){const s=r.getLocalStorage();if(s)try{return s.setItem(t,JSON.stringify(e)),!0}catch{return!1}else return!1}static setSessionData(t,e){const s=r.getSessionStorage();if(s)try{return s.setItem(t,JSON.stringify(e)),!0}catch{return!1}else return!1}getStorageData(t){const{type:e}=this.options,s=e==="local"?r.getLocalData(t):r.getSessionData(t);return Promise.resolve(s)}setStorageData(t,e){const{type:s}=this.options,a=s==="local"?r.setLocalData(t,e):r.setSessionData(t,e);return Promise.resolve(a)}}0&&(module.exports={BrowserStorage});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../src/BrowserStorage/BrowserStorage.ts"],
  "sourcesContent": ["/**\n * Copyright (c) 2018-Present, Nitrogen Labs, Inc.\n * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.\n */\nimport {BrowserStorageOptions} from '../types/main';\n\nexport class BrowserStorage {\n  static window: any = window || {};\n  private options: BrowserStorageOptions = {\n    type: 'session'\n  };\n\n  constructor(options: BrowserStorageOptions = {}) {\n    // Methods\n    this.getStorageData = this.getStorageData.bind(this);\n    this.setStorageData = this.setStorageData.bind(this);\n\n    // Configuration\n    this.options = {...this.options, ...options};\n  }\n\n  /**\n   * Removes a key from localStorage.\n   *\n   * @param {string} key Key associated with the data to remove.\n   * @returns {boolean} Whether data was successfully removed.\n   */\n  static delLocalData(key: string): boolean {\n    const localStorage = BrowserStorage.getLocalStorage();\n\n    if(localStorage) {\n      try {\n        localStorage.removeItem(key);\n        return true;\n      } catch(error) {\n        return false;\n      }\n    } else {\n      return false;\n    }\n  }\n\n  /**\n   * Removes a key from sessionStorage.\n   *\n   * @param {string} key Key associated with the data to remove.\n   * @returns {boolean} Whether data was successfully removed.\n   */\n  static delSessionData(key: string): boolean {\n    const sessionStorage = BrowserStorage.getSessionStorage();\n\n    if(sessionStorage) {\n      try {\n        sessionStorage.removeItem(key);\n        return true;\n      } catch(error) {\n        return false;\n      }\n    } else {\n      return false;\n    }\n  }\n\n  /**\n   * Get a key value from localStorage.\n   *\n   * @param {string} key The key for data.\n   * @returns {any} the data object associated with the key.\n   */\n  static getLocalData(key: string): any {\n    const localStorage = BrowserStorage.getLocalStorage();\n\n    if(localStorage) {\n      try {\n        const item = localStorage.getItem(key);\n\n        if(item) {\n          return JSON.parse(item);\n        }\n\n        return null;\n      } catch(error) {\n        return null;\n      }\n    } else {\n      return null;\n    }\n  }\n\n  /**\n   * Get localStorage from global window object.\n   *\n   * @param {string} key Key to store data.\n   * @param {any} value Data to store.\n   * @returns {any} window.localStorage.\n   */\n  static getLocalStorage(): any {\n    const {localStorage} = BrowserStorage.window;\n    return localStorage;\n  }\n\n  /**\n   * Get a key value from sessionStorage.\n   *\n   * @param {string} key The key for data.\n   * @returns {any} the data object associated with the key.\n   */\n  static getSessionData(key: string): any {\n    const sessionStorage = BrowserStorage.getSessionStorage();\n\n    if(sessionStorage) {\n      try {\n        const item = sessionStorage.getItem(key);\n\n        if(item) {\n          return item ? JSON.parse(item) : null;\n        }\n\n        return null;\n      } catch(error) {\n        return null;\n      }\n    } else {\n      return null;\n    }\n  }\n\n  /**\n   * Get sessionStorage from global window object.\n   *\n   * @param {string} key Key to store data.\n   * @param {any} value Data to store.\n   * @returns {any} window.sessionStorage.\n   */\n  static getSessionStorage(): any {\n    const {sessionStorage} = BrowserStorage.window;\n\n    return sessionStorage;\n  }\n\n  /**\n   * Saves data to localStorage.\n   *\n   * @param {string} key Key to store data.\n   * @param {any} value Data to store.\n   * @returns {boolean} Whether data was successfully saved.\n   */\n  static setLocalData(key: string, value): boolean {\n    const localStorage = BrowserStorage.getLocalStorage();\n\n    if(localStorage) {\n      try {\n        localStorage.setItem(key, JSON.stringify(value));\n        return true;\n      } catch(error) {\n        return false;\n      }\n    } else {\n      return false;\n    }\n  }\n\n  /**\n   * Saves data to sessionStorage.\n   *\n   * @param {string} key Key to store data.\n   * @param {any} value Data to store.\n   * @returns {boolean} Whether data was successfully saved.\n   */\n  static setSessionData(key: string, value): boolean {\n    const sessionStorage = BrowserStorage.getSessionStorage();\n\n    if(sessionStorage) {\n      try {\n        sessionStorage.setItem(key, JSON.stringify(value));\n        return true;\n      } catch(error) {\n        return false;\n      }\n    } else {\n      return false;\n    }\n  }\n\n  /**\n   * Get a key value from storage.\n   *\n   * @param {string} key The key for data.\n   * @returns {Promise<any>} the data object associated with the key.\n   */\n  getStorageData(key: string): Promise<any> {\n    const {type} = this.options;\n    const results = type === 'local' ? BrowserStorage.getLocalData(key) : BrowserStorage.getSessionData(key);\n    return Promise.resolve(results);\n  }\n\n  /**\n   * Saves data to storage.\n   *\n   * @param {string} key Key to store data.\n   * @param {any} value Data to store.\n   * @returns {Promise<boolean>} Whether data was successfully saved.\n   */\n  setStorageData(key: string, value): Promise<boolean> {\n    const {type} = this.options;\n    const results: boolean = type === 'local' ?\n      BrowserStorage.setLocalData(key, value) :\n      BrowserStorage.setSessionData(key, value);\n    return Promise.resolve(results);\n  }\n}\n"],
  "mappings": "4ZAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,oBAAAE,IAAA,eAAAC,EAAAH,GAMO,MAAME,CAAe,CAM1B,YAAYE,EAAiC,CAAC,EAAG,CAJjD,KAAQ,QAAiC,CACvC,KAAM,SACR,EAIE,KAAK,eAAiB,KAAK,eAAe,KAAK,IAAI,EACnD,KAAK,eAAiB,KAAK,eAAe,KAAK,IAAI,EAGnD,KAAK,QAAU,CAAC,GAAG,KAAK,QAAS,GAAGA,CAAO,CAC7C,CAZA,YAAO,OAAc,QAAU,CAAC,EAoBhC,OAAO,aAAaC,EAAsB,CACxC,MAAMC,EAAeJ,EAAe,gBAAgB,EAEpD,GAAGI,EACD,GAAI,CACF,OAAAA,EAAa,WAAWD,CAAG,EACpB,EACT,MAAe,CACb,MAAO,EACT,KAEA,OAAO,EAEX,CAQA,OAAO,eAAeA,EAAsB,CAC1C,MAAME,EAAiBL,EAAe,kBAAkB,EAExD,GAAGK,EACD,GAAI,CACF,OAAAA,EAAe,WAAWF,CAAG,EACtB,EACT,MAAe,CACb,MAAO,EACT,KAEA,OAAO,EAEX,CAQA,OAAO,aAAaA,EAAkB,CACpC,MAAMC,EAAeJ,EAAe,gBAAgB,EAEpD,GAAGI,EACD,GAAI,CACF,MAAME,EAAOF,EAAa,QAAQD,CAAG,EAErC,OAAGG,EACM,KAAK,MAAMA,CAAI,EAGjB,IACT,MAAe,CACb,OAAO,IACT,KAEA,QAAO,IAEX,CASA,OAAO,iBAAuB,CAC5B,KAAM,CAAC,aAAAF,CAAY,EAAIJ,EAAe,OACtC,OAAOI,CACT,CAQA,OAAO,eAAeD,EAAkB,CACtC,MAAME,EAAiBL,EAAe,kBAAkB,EAExD,GAAGK,EACD,GAAI,CACF,MAAMC,EAAOD,EAAe,QAAQF,CAAG,EAEvC,OAAGG,GACMA,EAAO,KAAK,MAAMA,CAAI,EAGxB,IACT,MAAe,CACb,OAAO,IACT,KAEA,QAAO,IAEX,CASA,OAAO,mBAAyB,CAC9B,KAAM,CAAC,eAAAD,CAAc,EAAIL,EAAe,OAExC,OAAOK,CACT,CASA,OAAO,aAAaF,EAAaI,EAAgB,CAC/C,MAAMH,EAAeJ,EAAe,gBAAgB,EAEpD,GAAGI,EACD,GAAI,CACF,OAAAA,EAAa,QAAQD,EAAK,KAAK,UAAUI,CAAK,CAAC,EACxC,EACT,MAAe,CACb,MAAO,EACT,KAEA,OAAO,EAEX,CASA,OAAO,eAAeJ,EAAaI,EAAgB,CACjD,MAAMF,EAAiBL,EAAe,kBAAkB,EAExD,GAAGK,EACD,GAAI,CACF,OAAAA,EAAe,QAAQF,EAAK,KAAK,UAAUI,CAAK,CAAC,EAC1C,EACT,MAAe,CACb,MAAO,EACT,KAEA,OAAO,EAEX,CAQA,eAAeJ,EAA2B,CACxC,KAAM,CAAC,KAAAK,CAAI,EAAI,KAAK,QACdC,EAAUD,IAAS,QAAUR,EAAe,aAAaG,CAAG,EAAIH,EAAe,eAAeG,CAAG,EACvG,OAAO,QAAQ,QAAQM,CAAO,CAChC,CASA,eAAeN,EAAaI,EAAyB,CACnD,KAAM,CAAC,KAAAC,CAAI,EAAI,KAAK,QACdC,EAAmBD,IAAS,QAChCR,EAAe,aAAaG,EAAKI,CAAK,EACtCP,EAAe,eAAeG,EAAKI,CAAK,EAC1C,OAAO,QAAQ,QAAQE,CAAO,CAChC,CACF",
  "names": ["BrowserStorage_exports", "__export", "BrowserStorage", "__toCommonJS", "options", "key", "localStorage", "sessionStorage", "item", "value", "type", "results"]
}


package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { BrowserStorage } from './BrowserStorage/BrowserStorage';
+export * from './types/main';
+export { BrowserStorage };

package/lib/index.js

@@ -0,0 +1,2 @@
+var x=Object.defineProperty;var i=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var w=Object.prototype.hasOwnProperty;var B=(o,r)=>{for(var e in r)x(o,e,{get:r[e],enumerable:!0})},f=(o,r,e,a)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of s(r))!w.call(o,t)&&t!==e&&x(o,t,{get:()=>r[t],enumerable:!(a=i(r,t))||a.enumerable});return o},p=(o,r,e)=>(f(o,r,"default"),e&&f(e,r,"default"));var S=o=>f(x({},"__esModule",{value:!0}),o);var m={};B(m,{BrowserStorage:()=>g.BrowserStorage});module.exports=S(m);var g=require("./BrowserStorage/BrowserStorage");p(m,require("./types/main"),module.exports);0&&(module.exports={BrowserStorage,...require("./types/main")});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIENvcHlyaWdodCAoYykgMjAxOC1QcmVzZW50LCBOaXRyb2dlbiBMYWJzLCBJbmMuXG4gKiBDb3B5cmlnaHRzIGxpY2Vuc2VkIHVuZGVyIHRoZSBNSVQgTGljZW5zZS4gU2VlIHRoZSBhY2NvbXBhbnlpbmcgTElDRU5TRSBmaWxlIGZvciB0ZXJtcy5cbiAqL1xuaW1wb3J0IHtCcm93c2VyU3RvcmFnZX0gZnJvbSAnLi9Ccm93c2VyU3RvcmFnZS9Ccm93c2VyU3RvcmFnZSc7XG5cbi8vIFN0b3JhZ2VcbmV4cG9ydCAqIGZyb20gJy4vdHlwZXMvbWFpbic7XG5leHBvcnQge0Jyb3dzZXJTdG9yYWdlfTtcbiJdLAogICJtYXBwaW5ncyI6ICI4Y0FBQSxJQUFBQSxFQUFBLEdBQUFDLEVBQUFELEVBQUEsc0RBQUFFLEVBQUFGLEdBSUEsSUFBQUcsRUFBNkIsMkNBRzdCQyxFQUFBSixFQUFjLHdCQVBkIiwKICAibmFtZXMiOiBbImluZGV4X2V4cG9ydHMiLCAiX19leHBvcnQiLCAiX190b0NvbW1vbkpTIiwgImltcG9ydF9Ccm93c2VyU3RvcmFnZSIsICJfX3JlRXhwb3J0Il0KfQo=

package/lib/types/main.d.ts

@@ -0,0 +1,3 @@
+export interface BrowserStorageOptions {
+    readonly type?: 'local' | 'session';
+}

package/lib/types/main.js

@@ -0,0 +1,2 @@
+var t=Object.defineProperty;var n=Object.getOwnPropertyDescriptor;var i=Object.getOwnPropertyNames;var l=Object.prototype.hasOwnProperty;var p=(o,e,a,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of i(e))!l.call(o,r)&&r!==a&&t(o,r,{get:()=>e[r],enumerable:!(s=n(e,r))||s.enumerable});return o};var c=o=>p(t({},"__esModule",{value:!0}),o);var y={};module.exports=c(y);
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vc3JjL3R5cGVzL21haW4udHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbImV4cG9ydCBpbnRlcmZhY2UgQnJvd3NlclN0b3JhZ2VPcHRpb25zIHtcbiAgcmVhZG9ubHkgdHlwZT86ICdsb2NhbCcgfCAnc2Vzc2lvbic7XG59XG4iXSwKICAibWFwcGluZ3MiOiAia1dBQUEsSUFBQUEsRUFBQSxrQkFBQUMsRUFBQUQiLAogICJuYW1lcyI6IFsibWFpbl9leHBvcnRzIiwgIl9fdG9Db21tb25KUyJdCn0K

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlabs/arkhamjs-storage-browser",
-  "version": "3.28.5",
+  "version": "3.29.0",
   "publishConfig": {
     "access": "public"
   },
@@ -31,9 +31,9 @@
     "url": "https://github.com/nitrogenlabs/arkhamjs/issues"
   },
   "scripts": {
-    "build": "lex compile",
+    "build": "lex compile --remove",
     "clean": "lex clean",
-    "lint": "eslint ./src --ext .ts,.tsx",
+    "lint": "lex lint --fix",
     "prepublishOnly": "npm run build",
     "publish:major": "npm version major && npm publish",
     "publish:minor": "npm version minor && npm publish",
@@ -41,18 +41,25 @@
     "pretest": "npm run lint",
     "reset": "lex clean",
     "test": "lex test",
-    "update": "npm-check-updates --interactive"
+    "update": "lex update --interactive"
   },
   "peerDependencies": {
     "@nlabs/arkhamjs": "^3.26.0"
   },
   "devDependencies": {
     "@nlabs/arkhamjs": "*",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.1",
-    "eslint": "^9.19.0",
-    "eslint-config-styleguidejs": "^3.2.1",
-    "typescript": "^5.7.3"
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.0.10",
+    "typescript": "^5.8.3"
   },
-  "gitHead": "fc371e1e28fe0ae35d40d29a217d5f0e990ec32a"
+  "files": [
+    "lib",
+    "index.js",
+    "index.d.ts",
+    "LICENSE",
+    "package.json",
+    "README.md"
+  ],
+  "gitHead": "fc371e1e28fe0ae35d40d29a217d5f0e990ec32a",
+  "type": "module"
 }