hyperstorage-js 6.0.2 → 6.0.4

package/README.md

@@ -102,7 +102,7 @@ console.log(userStore.storage) // Storage {userSettings: '{"json":{"theme":"dar
 ### Advanced Ways to Assign a New Value
 
 ```js
-// Using setter
+// Overwrite entirely
 userStore.value = { theme: 'dark', language: 'en' }
 
 // Change single property using the setter
@@ -161,16 +161,6 @@ console.log(sessionStore.defaultValue) // 'none'
 console.log(sessionStore.value) // 'none'
 ```
 
-### Removing Values
-
-Internally uses `Storage.removeItem()` to remove the item from storage and sets the cached value to `undefined`.
-
-```js
-sessionStore.remove()
-console.log(sessionStore.value) // 'none'
-console.log(sessionStore.storage) // Storage {length: 0}
-```
-
 <br>
 
 ## TypeScript Usage
@@ -243,18 +233,6 @@ if (result && typeof result === 'object' && 'theme' in result) {
 - Updates both `Storage` and internal cache.
 - Returns the restored default value.
 
-### `remove(): void`
-
-- Removes the key and its value from `Storage`.
-- Sets the internal cache to `undefined`.
-- Returns nothing.
-
-### `clear(): void`
-
-- Clears **all keys** in `Storage`.
-- Affects all stored data, not just this key.
-- Returns nothing.
-
 ### `isDefault(): boolean`
 
 - Checks whether the cached value equals the configured default.
@@ -275,7 +253,9 @@ If the underlying `Storage` is not modified through the value setter, the intern
 - Reads the value from storage.
 - Decodes it using `decodeFn`.
 - Updates the internal cache.
-- Returns the synchronized value. The return type is `unknown` because data read from `Storage` cannot be type-checked or trusted at compile time, especially when it may have been modified externally.
+- Returns the synchronized value.
+
+The return type is `unknown` because data read from `Storage` cannot be type-checked or trusted at compile time because it may have been modified externally.
 
 ```js
 // External change to storage (to be avoided)

package/dist/index.cjs

@@ -867,16 +867,16 @@ SuperJSON.allowErrorProps;
  */
 class HyperStorage {
     /** Version of the library, injected via Rollup replace plugin. */
-    static version = "6.0.2";
+    static version = "6.0.4";
     static superjson = SuperJSON;
     /** Key name under which the data is stored. */
     itemName;
     /** Default value used when the key does not exist in storage. */
     defaultValue;
     /** Function to encode values before storing. */
-    encodeFn;
+    #encodeFn;
     /** Function to decode values when reading. */
-    decodeFn;
+    #decodeFn;
     /** The underlying storage backend (defaults to `window.localStorage`). */
     storage;
     /** Internal cached value to improve access speed. */
@@ -903,10 +903,10 @@ class HyperStorage {
         this.defaultValue = defaultValue;
         if (encodeFn && typeof encodeFn !== 'function')
             throw new TypeError('encodeFn is defined but is not a function');
-        this.encodeFn = encodeFn || ((v) => HyperStorage.superjson.stringify(v));
+        this.#encodeFn = encodeFn || ((v) => HyperStorage.superjson.stringify(v));
         if (decodeFn && typeof decodeFn !== 'function')
             throw new TypeError('decodeFn is defined but is not a function');
-        this.decodeFn = decodeFn || ((v) => HyperStorage.superjson.parse(v));
+        this.#decodeFn = decodeFn || ((v) => HyperStorage.superjson.parse(v));
         if (!(storage instanceof Storage))
             throw new TypeError('storage must be an instance of Storage');
         this.storage = storage;
@@ -917,21 +917,20 @@ class HyperStorage {
      * Automatically caches, stringifies and encodes the value.
      */
     set value(value) {
-        // Cache real value
-        this.#value = value;
-        this.storage.setItem(this.itemName, this.encodeFn(value));
+        this.#value = value; // Cache real value
+        this.storage.setItem(this.itemName, this.#encodeFn(value));
     }
     /**
      * Gets the current cached value.
      */
     get value() {
-        return this.#value ?? this.defaultValue;
+        return this.#value;
     }
     set(keyOrCallback, value) {
         if (typeof keyOrCallback === 'function')
-            return (this.value = keyOrCallback(this.value));
+            return (this.value = keyOrCallback(this.#value));
         return (this.value = {
-            ...this.value,
+            ...this.#value,
             [keyOrCallback]: value,
         });
     }
@@ -941,7 +940,7 @@ class HyperStorage {
      * This is only necessary if the stored value may have been modified externally.
      * Using this function should be avoided when possible and is not type safe.
      */
-    sync(decodeFn = this.decodeFn) {
+    sync(decodeFn = this.#decodeFn) {
         let json = this.storage.getItem(this.itemName);
         // Reset value to defaultValue if it does not exist in storage
         if (typeof json !== 'string')
@@ -951,41 +950,20 @@ class HyperStorage {
             return (this.value = decodeFn(json));
         }
         catch (err) {
-            this.reset();
             console.error(err);
+            this.reset();
             return err;
         }
     }
     /**
      * Resets the stored value to its configured default.
-     *
      * Updates both the underlying storage and the internal cache.
      */
     reset() {
         return (this.value = this.defaultValue);
     }
-    /**
-     * Removes this specific key and its value from storage.
-     *
-     * Also clears the internal cache to prevent stale data access.
-     */
-    remove() {
-        this.#value = undefined;
-        this.storage.removeItem(this.itemName);
-    }
-    /**
-     * Clears **all** data fromstorage.
-     *
-     * This affects every key in the storage.
-     * Also clears the internal cache to prevent stale data access.
-     */
-    clear() {
-        this.#value = undefined;
-        this.storage.clear();
-    }
     /**
      * Checks whether the current cached value matches the configured default value.
-     *
      * Uses reference comparison for objects and strict equality for primitives.
      */
     isDefault() {

package/dist/index.d.ts

@@ -14,11 +14,7 @@ declare class HyperStorage<T> {
     /** Key name under which the data is stored. */
     readonly itemName: string;
     /** Default value used when the key does not exist in storage. */
-    private readonly defaultValue;
-    /** Function to encode values before storing. */
-    private readonly encodeFn;
-    /** Function to decode values when reading. */
-    private readonly decodeFn;
+    readonly defaultValue: T;
     /** The underlying storage backend (defaults to `window.localStorage`). */
     readonly storage: Storage;
     /**
@@ -63,26 +59,11 @@ declare class HyperStorage<T> {
     sync(decodeFn?: (value: string) => T): unknown;
     /**
      * Resets the stored value to its configured default.
-     *
      * Updates both the underlying storage and the internal cache.
      */
     reset(): T;
-    /**
-     * Removes this specific key and its value from storage.
-     *
-     * Also clears the internal cache to prevent stale data access.
-     */
-    remove(): void;
-    /**
-     * Clears **all** data fromstorage.
-     *
-     * This affects every key in the storage.
-     * Also clears the internal cache to prevent stale data access.
-     */
-    clear(): void;
     /**
      * Checks whether the current cached value matches the configured default value.
-     *
      * Uses reference comparison for objects and strict equality for primitives.
      */
     isDefault(): boolean;

package/dist/index.mjs

@@ -865,16 +865,16 @@ SuperJSON.allowErrorProps;
  */
 class HyperStorage {
     /** Version of the library, injected via Rollup replace plugin. */
-    static version = "6.0.2";
+    static version = "6.0.4";
     static superjson = SuperJSON;
     /** Key name under which the data is stored. */
     itemName;
     /** Default value used when the key does not exist in storage. */
     defaultValue;
     /** Function to encode values before storing. */
-    encodeFn;
+    #encodeFn;
     /** Function to decode values when reading. */
-    decodeFn;
+    #decodeFn;
     /** The underlying storage backend (defaults to `window.localStorage`). */
     storage;
     /** Internal cached value to improve access speed. */
@@ -901,10 +901,10 @@ class HyperStorage {
         this.defaultValue = defaultValue;
         if (encodeFn && typeof encodeFn !== 'function')
             throw new TypeError('encodeFn is defined but is not a function');
-        this.encodeFn = encodeFn || ((v) => HyperStorage.superjson.stringify(v));
+        this.#encodeFn = encodeFn || ((v) => HyperStorage.superjson.stringify(v));
         if (decodeFn && typeof decodeFn !== 'function')
             throw new TypeError('decodeFn is defined but is not a function');
-        this.decodeFn = decodeFn || ((v) => HyperStorage.superjson.parse(v));
+        this.#decodeFn = decodeFn || ((v) => HyperStorage.superjson.parse(v));
         if (!(storage instanceof Storage))
             throw new TypeError('storage must be an instance of Storage');
         this.storage = storage;
@@ -915,21 +915,20 @@ class HyperStorage {
      * Automatically caches, stringifies and encodes the value.
      */
     set value(value) {
-        // Cache real value
-        this.#value = value;
-        this.storage.setItem(this.itemName, this.encodeFn(value));
+        this.#value = value; // Cache real value
+        this.storage.setItem(this.itemName, this.#encodeFn(value));
     }
     /**
      * Gets the current cached value.
      */
     get value() {
-        return this.#value ?? this.defaultValue;
+        return this.#value;
     }
     set(keyOrCallback, value) {
         if (typeof keyOrCallback === 'function')
-            return (this.value = keyOrCallback(this.value));
+            return (this.value = keyOrCallback(this.#value));
         return (this.value = {
-            ...this.value,
+            ...this.#value,
             [keyOrCallback]: value,
         });
     }
@@ -939,7 +938,7 @@ class HyperStorage {
      * This is only necessary if the stored value may have been modified externally.
      * Using this function should be avoided when possible and is not type safe.
      */
-    sync(decodeFn = this.decodeFn) {
+    sync(decodeFn = this.#decodeFn) {
         let json = this.storage.getItem(this.itemName);
         // Reset value to defaultValue if it does not exist in storage
         if (typeof json !== 'string')
@@ -949,41 +948,20 @@ class HyperStorage {
             return (this.value = decodeFn(json));
         }
         catch (err) {
-            this.reset();
             console.error(err);
+            this.reset();
             return err;
         }
     }
     /**
      * Resets the stored value to its configured default.
-     *
      * Updates both the underlying storage and the internal cache.
      */
     reset() {
         return (this.value = this.defaultValue);
     }
-    /**
-     * Removes this specific key and its value from storage.
-     *
-     * Also clears the internal cache to prevent stale data access.
-     */
-    remove() {
-        this.#value = undefined;
-        this.storage.removeItem(this.itemName);
-    }
-    /**
-     * Clears **all** data fromstorage.
-     *
-     * This affects every key in the storage.
-     * Also clears the internal cache to prevent stale data access.
-     */
-    clear() {
-        this.#value = undefined;
-        this.storage.clear();
-    }
     /**
      * Checks whether the current cached value matches the configured default value.
-     *
      * Uses reference comparison for objects and strict equality for primitives.
      */
     isDefault() {

package/dist/index.umd.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).HyperStorage=t()}(this,function(){"use strict";class e{constructor(){this.keyToValue=new Map,this.valueToKey=new Map}set(e,t){this.keyToValue.set(e,t),this.valueToKey.set(t,e)}getByKey(e){return this.keyToValue.get(e)}getByValue(e){return this.valueToKey.get(e)}clear(){this.keyToValue.clear(),this.valueToKey.clear()}}class t{constructor(t){this.generateIdentifier=t,this.kv=new e}register(e,t){this.kv.getByValue(e)||(t||(t=this.generateIdentifier(e)),this.kv.set(t,e))}clear(){this.kv.clear()}getIdentifier(e){return this.kv.getByValue(e)}getValue(e){return this.kv.getByKey(e)}}class r extends t{constructor(){super(e=>e.name),this.classToAllowedProps=new Map}register(e,t){"object"==typeof t?(t.allowProps&&this.classToAllowedProps.set(e,t.allowProps),super.register(e,t.identifier)):super.register(e,t)}getAllowedProps(e){return this.classToAllowedProps.get(e)}}function n(e,t){const r=function(e){if("values"in Object)return Object.values(e);const t=[];for(const r in e)e.hasOwnProperty(r)&&t.push(e[r]);return t}(e);if("find"in r)return r.find(t);const n=r;for(let e=0;e<n.length;e++){const r=n[e];if(t(r))return r}}function s(e,t){Object.entries(e).forEach(([e,r])=>t(r,e))}function o(e,t){return-1!==e.indexOf(t)}function i(e,t){for(let r=0;r<e.length;r++){const n=e[r];if(t(n))return n}}class a{constructor(){this.transfomers={}}register(e){this.transfomers[e.name]=e}findApplicable(e){return n(this.transfomers,t=>t.isApplicable(e))}findByName(e){return this.transfomers[e]}}const l=e=>void 0===e,u=e=>"object"==typeof e&&null!==e&&(e!==Object.prototype&&(null===Object.getPrototypeOf(e)||Object.getPrototypeOf(e)===Object.prototype)),c=e=>u(e)&&0===Object.keys(e).length,f=e=>Array.isArray(e),p=e=>e instanceof Map,d=e=>e instanceof Set,y=e=>"Symbol"===(e=>Object.prototype.toString.call(e).slice(8,-1))(e),g=e=>e instanceof Error,m=e=>"number"==typeof e&&isNaN(e),h=e=>(e=>"boolean"==typeof e)(e)||(e=>null===e)(e)||l(e)||(e=>"number"==typeof e&&!isNaN(e))(e)||(e=>"string"==typeof e)(e)||y(e),b=e=>e.replace(/\\/g,"\\\\").replace(/\./g,"\\."),w=e=>e.map(String).map(b).join("."),v=(e,t)=>{const r=[];let n="";for(let s=0;s<e.length;s++){let o=e.charAt(s);if(!t&&"\\"===o){const t=e.charAt(s+1);if("\\"===t){n+="\\",s++;continue}if("."!==t)throw Error("invalid path")}if("\\"===o&&"."===e.charAt(s+1)){n+=".",s++;continue}"."===o?(r.push(n),n=""):n+=o}const s=n;return r.push(s),r};function E(e,t,r,n){return{isApplicable:e,annotation:t,transform:r,untransform:n}}const I=[E(l,"undefined",()=>null,()=>{}),E(e=>"bigint"==typeof e,"bigint",e=>e.toString(),e=>"undefined"!=typeof BigInt?BigInt(e):(console.error("Please add a BigInt polyfill."),e)),E(e=>e instanceof Date&&!isNaN(e.valueOf()),"Date",e=>e.toISOString(),e=>new Date(e)),E(g,"Error",(e,t)=>{const r={name:e.name,message:e.message};return"cause"in e&&(r.cause=e.cause),t.allowedErrorProps.forEach(t=>{r[t]=e[t]}),r},(e,t)=>{const r=new Error(e.message,{cause:e.cause});return r.name=e.name,r.stack=e.stack,t.allowedErrorProps.forEach(t=>{r[t]=e[t]}),r}),E(e=>e instanceof RegExp,"regexp",e=>""+e,e=>{const t=e.slice(1,e.lastIndexOf("/")),r=e.slice(e.lastIndexOf("/")+1);return new RegExp(t,r)}),E(d,"set",e=>[...e.values()],e=>new Set(e)),E(p,"map",e=>[...e.entries()],e=>new Map(e)),E(e=>{return m(e)||((t=e)===1/0||t===-1/0);var t},"number",e=>m(e)?"NaN":e>0?"Infinity":"-Infinity",Number),E(e=>0===e&&1/e==-1/0,"number",()=>"-0",Number),E(e=>e instanceof URL,"URL",e=>e.toString(),e=>new URL(e))];function k(e,t,r,n){return{isApplicable:e,annotation:t,transform:r,untransform:n}}const O=k((e,t)=>{if(y(e)){return!!t.symbolRegistry.getIdentifier(e)}return!1},(e,t)=>["symbol",t.symbolRegistry.getIdentifier(e)],e=>e.description,(e,t,r)=>{const n=r.symbolRegistry.getValue(t[1]);if(!n)throw new Error("Trying to deserialize unknown symbol");return n}),j=[Int8Array,Uint8Array,Int16Array,Uint16Array,Int32Array,Uint32Array,Float32Array,Float64Array,Uint8ClampedArray].reduce((e,t)=>(e[t.name]=t,e),{}),A=k(e=>ArrayBuffer.isView(e)&&!(e instanceof DataView),e=>["typed-array",e.constructor.name],e=>[...e],(e,t)=>{const r=j[t[1]];if(!r)throw new Error("Trying to deserialize unknown typed array");return new r(e)});function T(e,t){if(e?.constructor){return!!t.classRegistry.getIdentifier(e.constructor)}return!1}const P=k(T,(e,t)=>["class",t.classRegistry.getIdentifier(e.constructor)],(e,t)=>{const r=t.classRegistry.getAllowedProps(e.constructor);if(!r)return{...e};const n={};return r.forEach(t=>{n[t]=e[t]}),n},(e,t,r)=>{const n=r.classRegistry.getValue(t[1]);if(!n)throw new Error(`Trying to deserialize unknown class '${t[1]}' - check https://github.com/blitz-js/superjson/issues/116#issuecomment-773996564`);return Object.assign(Object.create(n.prototype),e)}),V=k((e,t)=>!!t.customTransformerRegistry.findApplicable(e),(e,t)=>["custom",t.customTransformerRegistry.findApplicable(e).name],(e,t)=>t.customTransformerRegistry.findApplicable(e).serialize(e),(e,t,r)=>{const n=r.customTransformerRegistry.findByName(t[1]);if(!n)throw new Error("Trying to deserialize unknown custom value");return n.deserialize(e)}),R=[P,O,V,A],S=(e,t)=>{const r=i(R,r=>r.isApplicable(e,t));if(r)return{value:r.transform(e,t),type:r.annotation(e,t)};const n=i(I,r=>r.isApplicable(e,t));return n?{value:n.transform(e,t),type:n.annotation}:void 0},N={};I.forEach(e=>{N[e.annotation]=e});const z=(e,t)=>{if(t>e.size)throw new Error("index out of bounds");const r=e.keys();for(;t>0;)r.next(),t--;return r.next().value};function _(e){if(o(e,"__proto__"))throw new Error("__proto__ is not allowed as a property");if(o(e,"prototype"))throw new Error("prototype is not allowed as a property");if(o(e,"constructor"))throw new Error("constructor is not allowed as a property")}const x=(e,t,r)=>{if(_(t),0===t.length)return r(e);let n=e;for(let e=0;e<t.length-1;e++){const r=t[e];if(f(n)){n=n[+r]}else if(u(n))n=n[r];else if(d(n)){n=z(n,+r)}else if(p(n)){if(e===t.length-2)break;const s=+r,o=0===+t[++e]?"key":"value",i=z(n,s);switch(o){case"key":n=i;break;case"value":n=n.get(i)}}}const s=t[t.length-1];if(f(n)?n[+s]=r(n[+s]):u(n)&&(n[s]=r(n[s])),d(n)){const e=z(n,+s),t=r(e);e!==t&&(n.delete(e),n.add(t))}if(p(n)){const e=+t[t.length-2],o=z(n,e);switch(0===+s?"key":"value"){case"key":{const e=r(o);n.set(e,n.get(o)),e!==o&&n.delete(o);break}case"value":n.set(o,r(n.get(o)))}}return e},F=e=>e<1;function B(e,t,r,n=[]){if(!e)return;const o=F(r);if(!f(e))return void s(e,(e,s)=>B(e,t,r,[...n,...v(s,o)]));const[i,a]=e;a&&s(a,(e,s)=>{B(e,t,r,[...n,...v(s,o)])}),t(i,n)}function C(e,t,r,n){return B(t,(t,r)=>{e=x(e,r,e=>((e,t,r)=>{if(!f(t)){const n=N[t];if(!n)throw new Error("Unknown transformation: "+t);return n.untransform(e,r)}switch(t[0]){case"symbol":return O.untransform(e,t,r);case"class":return P.untransform(e,t,r);case"custom":return V.untransform(e,t,r);case"typed-array":return A.untransform(e,t,r);default:throw new Error("Unknown transformation: "+t)}})(e,t,n))},r),e}function U(e,t,r){const n=F(r);function o(t,r){const s=((e,t)=>{_(t);for(let r=0;r<t.length;r++){const n=t[r];if(d(e))e=z(e,+n);else if(p(e)){const s=+n,o=0===+t[++r]?"key":"value",i=z(e,s);switch(o){case"key":e=i;break;case"value":e=e.get(i)}}else e=e[n]}return e})(e,v(r,n));t.map(e=>v(e,n)).forEach(t=>{e=x(e,t,()=>s)})}if(f(t)){const[r,i]=t;r.forEach(t=>{e=x(e,v(t,n),()=>e)}),i&&s(i,o)}else s(t,o);return e}const M=(e,t,r,n,i=[],a=[],l=new Map)=>{const y=h(e);if(!y){!function(e,t,r){const n=r.get(e);n?n.push(t):r.set(e,[t])}(e,i,t);const r=l.get(e);if(r)return n?{transformedValue:null}:r}if(!((e,t)=>u(e)||f(e)||p(e)||d(e)||g(e)||T(e,t))(e,r)){const t=S(e,r),n=t?{transformedValue:t.value,annotations:[t.type]}:{transformedValue:e};return y||l.set(e,n),n}if(o(a,e))return{transformedValue:null};const m=S(e,r),w=m?.value??e,v=f(w)?[]:{},E={};s(w,(o,c)=>{if("__proto__"===c||"constructor"===c||"prototype"===c)throw new Error(`Detected property ${c}. This is a prototype pollution risk, please remove it from your object.`);const p=M(o,t,r,n,[...i,c],[...a,e],l);v[c]=p.transformedValue,f(p.annotations)?E[b(c)]=p.annotations:u(p.annotations)&&s(p.annotations,(e,t)=>{E[b(c)+"."+t]=e})});const I=c(E)?{transformedValue:v,annotations:m?[m.type]:void 0}:{transformedValue:v,annotations:m?[m.type,E]:E};return y||l.set(e,I),I};function D(e){return Object.prototype.toString.call(e).slice(8,-1)}function K(e){return"Array"===D(e)}function q(e,t={}){if(K(e))return e.map(e=>q(e,t));if(!function(e){if("Object"!==D(e))return!1;const t=Object.getPrototypeOf(e);return!!t&&t.constructor===Object&&t===Object.prototype}(e))return e;return[...Object.getOwnPropertyNames(e),...Object.getOwnPropertySymbols(e)].reduce((r,n)=>{if("__proto__"===n)return r;if(K(t.props)&&!t.props.includes(n))return r;return function(e,t,r,n,s){const o={}.propertyIsEnumerable.call(n,t)?"enumerable":"nonenumerable";"enumerable"===o&&(e[t]=r),s&&"nonenumerable"===o&&Object.defineProperty(e,t,{value:r,enumerable:!1,writable:!0,configurable:!0})}(r,n,q(e[n],t),e,t.nonenumerable),r},{})}class L{constructor({dedupe:e=!1}={}){this.classRegistry=new r,this.symbolRegistry=new t(e=>e.description??""),this.customTransformerRegistry=new a,this.allowedErrorProps=[],this.dedupe=e}serialize(e){const t=new Map,r=M(e,t,this,this.dedupe),n={json:r.transformedValue};r.annotations&&(n.meta={...n.meta,values:r.annotations});const s=function(e,t){const r={};let n;return e.forEach(e=>{if(e.length<=1)return;t||(e=e.map(e=>e.map(String)).sort((e,t)=>e.length-t.length));const[s,...o]=e;0===s.length?n=o.map(w):r[w(s)]=o.map(w)}),n?c(r)?[n]:[n,r]:c(r)?void 0:r}(t,this.dedupe);return s&&(n.meta={...n.meta,referentialEqualities:s}),n.meta&&(n.meta.v=1),n}deserialize(e,t){const{json:r,meta:n}=e;let s=t?.inPlace?r:q(r);return n?.values&&(s=C(s,n.values,n.v??0,this)),n?.referentialEqualities&&(s=U(s,n.referentialEqualities,n.v??0)),s}stringify(e){return JSON.stringify(this.serialize(e))}parse(e){return this.deserialize(JSON.parse(e),{inPlace:!0})}registerClass(e,t){this.classRegistry.register(e,t)}registerSymbol(e,t){this.symbolRegistry.register(e,t)}registerCustom(e,t){this.customTransformerRegistry.register({name:t,...e})}allowErrorProps(...e){this.allowedErrorProps.push(...e)}}L.defaultInstance=new L,L.serialize=L.defaultInstance.serialize.bind(L.defaultInstance),L.deserialize=L.defaultInstance.deserialize.bind(L.defaultInstance),L.stringify=L.defaultInstance.stringify.bind(L.defaultInstance),L.parse=L.defaultInstance.parse.bind(L.defaultInstance),L.registerClass=L.defaultInstance.registerClass.bind(L.defaultInstance),L.registerSymbol=L.defaultInstance.registerSymbol.bind(L.defaultInstance),L.registerCustom=L.defaultInstance.registerCustom.bind(L.defaultInstance),L.allowErrorProps=L.defaultInstance.allowErrorProps.bind(L.defaultInstance),L.serialize,L.deserialize,L.stringify,L.parse,L.registerClass,L.registerCustom,L.registerSymbol,L.allowErrorProps;class J{static version="6.0.2";static superjson=L;itemName;defaultValue;encodeFn;decodeFn;storage;#e;constructor(e,t,r={}){const{encodeFn:n,decodeFn:s,storage:o=window.localStorage}=r;if("string"!=typeof e)throw new TypeError("itemName is not a string");if(this.itemName=e,this.defaultValue=t,n&&"function"!=typeof n)throw new TypeError("encodeFn is defined but is not a function");if(this.encodeFn=n||(e=>J.superjson.stringify(e)),s&&"function"!=typeof s)throw new TypeError("decodeFn is defined but is not a function");if(this.decodeFn=s||(e=>J.superjson.parse(e)),!(o instanceof Storage))throw new TypeError("storage must be an instance of Storage");this.storage=o,this.sync()}set value(e){this.#e=e,this.storage.setItem(this.itemName,this.encodeFn(e))}get value(){return this.#e??this.defaultValue}set(e,t){return this.value="function"==typeof e?e(this.value):{...this.value,[e]:t}}sync(e=this.decodeFn){let t=this.storage.getItem(this.itemName);if("string"!=typeof t)return this.reset();try{return this.value=e(t)}catch(e){return this.reset(),console.error(e),e}}reset(){return this.value=this.defaultValue}remove(){this.#e=void 0,this.storage.removeItem(this.itemName)}clear(){this.#e=void 0,this.storage.clear()}isDefault(){return this.#e===this.defaultValue}}return J});
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).HyperStorage=t()}(this,function(){"use strict";class e{constructor(){this.keyToValue=new Map,this.valueToKey=new Map}set(e,t){this.keyToValue.set(e,t),this.valueToKey.set(t,e)}getByKey(e){return this.keyToValue.get(e)}getByValue(e){return this.valueToKey.get(e)}clear(){this.keyToValue.clear(),this.valueToKey.clear()}}class t{constructor(t){this.generateIdentifier=t,this.kv=new e}register(e,t){this.kv.getByValue(e)||(t||(t=this.generateIdentifier(e)),this.kv.set(t,e))}clear(){this.kv.clear()}getIdentifier(e){return this.kv.getByValue(e)}getValue(e){return this.kv.getByKey(e)}}class r extends t{constructor(){super(e=>e.name),this.classToAllowedProps=new Map}register(e,t){"object"==typeof t?(t.allowProps&&this.classToAllowedProps.set(e,t.allowProps),super.register(e,t.identifier)):super.register(e,t)}getAllowedProps(e){return this.classToAllowedProps.get(e)}}function n(e,t){const r=function(e){if("values"in Object)return Object.values(e);const t=[];for(const r in e)e.hasOwnProperty(r)&&t.push(e[r]);return t}(e);if("find"in r)return r.find(t);const n=r;for(let e=0;e<n.length;e++){const r=n[e];if(t(r))return r}}function s(e,t){Object.entries(e).forEach(([e,r])=>t(r,e))}function o(e,t){return-1!==e.indexOf(t)}function i(e,t){for(let r=0;r<e.length;r++){const n=e[r];if(t(n))return n}}class a{constructor(){this.transfomers={}}register(e){this.transfomers[e.name]=e}findApplicable(e){return n(this.transfomers,t=>t.isApplicable(e))}findByName(e){return this.transfomers[e]}}const l=e=>void 0===e,u=e=>"object"==typeof e&&null!==e&&(e!==Object.prototype&&(null===Object.getPrototypeOf(e)||Object.getPrototypeOf(e)===Object.prototype)),c=e=>u(e)&&0===Object.keys(e).length,f=e=>Array.isArray(e),p=e=>e instanceof Map,d=e=>e instanceof Set,y=e=>"Symbol"===(e=>Object.prototype.toString.call(e).slice(8,-1))(e),g=e=>e instanceof Error,m=e=>"number"==typeof e&&isNaN(e),h=e=>(e=>"boolean"==typeof e)(e)||(e=>null===e)(e)||l(e)||(e=>"number"==typeof e&&!isNaN(e))(e)||(e=>"string"==typeof e)(e)||y(e),b=e=>e.replace(/\\/g,"\\\\").replace(/\./g,"\\."),w=e=>e.map(String).map(b).join("."),v=(e,t)=>{const r=[];let n="";for(let s=0;s<e.length;s++){let o=e.charAt(s);if(!t&&"\\"===o){const t=e.charAt(s+1);if("\\"===t){n+="\\",s++;continue}if("."!==t)throw Error("invalid path")}if("\\"===o&&"."===e.charAt(s+1)){n+=".",s++;continue}"."===o?(r.push(n),n=""):n+=o}const s=n;return r.push(s),r};function E(e,t,r,n){return{isApplicable:e,annotation:t,transform:r,untransform:n}}const I=[E(l,"undefined",()=>null,()=>{}),E(e=>"bigint"==typeof e,"bigint",e=>e.toString(),e=>"undefined"!=typeof BigInt?BigInt(e):(console.error("Please add a BigInt polyfill."),e)),E(e=>e instanceof Date&&!isNaN(e.valueOf()),"Date",e=>e.toISOString(),e=>new Date(e)),E(g,"Error",(e,t)=>{const r={name:e.name,message:e.message};return"cause"in e&&(r.cause=e.cause),t.allowedErrorProps.forEach(t=>{r[t]=e[t]}),r},(e,t)=>{const r=new Error(e.message,{cause:e.cause});return r.name=e.name,r.stack=e.stack,t.allowedErrorProps.forEach(t=>{r[t]=e[t]}),r}),E(e=>e instanceof RegExp,"regexp",e=>""+e,e=>{const t=e.slice(1,e.lastIndexOf("/")),r=e.slice(e.lastIndexOf("/")+1);return new RegExp(t,r)}),E(d,"set",e=>[...e.values()],e=>new Set(e)),E(p,"map",e=>[...e.entries()],e=>new Map(e)),E(e=>{return m(e)||((t=e)===1/0||t===-1/0);var t},"number",e=>m(e)?"NaN":e>0?"Infinity":"-Infinity",Number),E(e=>0===e&&1/e==-1/0,"number",()=>"-0",Number),E(e=>e instanceof URL,"URL",e=>e.toString(),e=>new URL(e))];function k(e,t,r,n){return{isApplicable:e,annotation:t,transform:r,untransform:n}}const O=k((e,t)=>{if(y(e)){return!!t.symbolRegistry.getIdentifier(e)}return!1},(e,t)=>["symbol",t.symbolRegistry.getIdentifier(e)],e=>e.description,(e,t,r)=>{const n=r.symbolRegistry.getValue(t[1]);if(!n)throw new Error("Trying to deserialize unknown symbol");return n}),j=[Int8Array,Uint8Array,Int16Array,Uint16Array,Int32Array,Uint32Array,Float32Array,Float64Array,Uint8ClampedArray].reduce((e,t)=>(e[t.name]=t,e),{}),A=k(e=>ArrayBuffer.isView(e)&&!(e instanceof DataView),e=>["typed-array",e.constructor.name],e=>[...e],(e,t)=>{const r=j[t[1]];if(!r)throw new Error("Trying to deserialize unknown typed array");return new r(e)});function T(e,t){if(e?.constructor){return!!t.classRegistry.getIdentifier(e.constructor)}return!1}const P=k(T,(e,t)=>["class",t.classRegistry.getIdentifier(e.constructor)],(e,t)=>{const r=t.classRegistry.getAllowedProps(e.constructor);if(!r)return{...e};const n={};return r.forEach(t=>{n[t]=e[t]}),n},(e,t,r)=>{const n=r.classRegistry.getValue(t[1]);if(!n)throw new Error(`Trying to deserialize unknown class '${t[1]}' - check https://github.com/blitz-js/superjson/issues/116#issuecomment-773996564`);return Object.assign(Object.create(n.prototype),e)}),V=k((e,t)=>!!t.customTransformerRegistry.findApplicable(e),(e,t)=>["custom",t.customTransformerRegistry.findApplicable(e).name],(e,t)=>t.customTransformerRegistry.findApplicable(e).serialize(e),(e,t,r)=>{const n=r.customTransformerRegistry.findByName(t[1]);if(!n)throw new Error("Trying to deserialize unknown custom value");return n.deserialize(e)}),R=[P,O,V,A],S=(e,t)=>{const r=i(R,r=>r.isApplicable(e,t));if(r)return{value:r.transform(e,t),type:r.annotation(e,t)};const n=i(I,r=>r.isApplicable(e,t));return n?{value:n.transform(e,t),type:n.annotation}:void 0},N={};I.forEach(e=>{N[e.annotation]=e});const z=(e,t)=>{if(t>e.size)throw new Error("index out of bounds");const r=e.keys();for(;t>0;)r.next(),t--;return r.next().value};function _(e){if(o(e,"__proto__"))throw new Error("__proto__ is not allowed as a property");if(o(e,"prototype"))throw new Error("prototype is not allowed as a property");if(o(e,"constructor"))throw new Error("constructor is not allowed as a property")}const x=(e,t,r)=>{if(_(t),0===t.length)return r(e);let n=e;for(let e=0;e<t.length-1;e++){const r=t[e];if(f(n)){n=n[+r]}else if(u(n))n=n[r];else if(d(n)){n=z(n,+r)}else if(p(n)){if(e===t.length-2)break;const s=+r,o=0===+t[++e]?"key":"value",i=z(n,s);switch(o){case"key":n=i;break;case"value":n=n.get(i)}}}const s=t[t.length-1];if(f(n)?n[+s]=r(n[+s]):u(n)&&(n[s]=r(n[s])),d(n)){const e=z(n,+s),t=r(e);e!==t&&(n.delete(e),n.add(t))}if(p(n)){const e=+t[t.length-2],o=z(n,e);switch(0===+s?"key":"value"){case"key":{const e=r(o);n.set(e,n.get(o)),e!==o&&n.delete(o);break}case"value":n.set(o,r(n.get(o)))}}return e},F=e=>e<1;function B(e,t,r,n=[]){if(!e)return;const o=F(r);if(!f(e))return void s(e,(e,s)=>B(e,t,r,[...n,...v(s,o)]));const[i,a]=e;a&&s(a,(e,s)=>{B(e,t,r,[...n,...v(s,o)])}),t(i,n)}function C(e,t,r,n){return B(t,(t,r)=>{e=x(e,r,e=>((e,t,r)=>{if(!f(t)){const n=N[t];if(!n)throw new Error("Unknown transformation: "+t);return n.untransform(e,r)}switch(t[0]){case"symbol":return O.untransform(e,t,r);case"class":return P.untransform(e,t,r);case"custom":return V.untransform(e,t,r);case"typed-array":return A.untransform(e,t,r);default:throw new Error("Unknown transformation: "+t)}})(e,t,n))},r),e}function U(e,t,r){const n=F(r);function o(t,r){const s=((e,t)=>{_(t);for(let r=0;r<t.length;r++){const n=t[r];if(d(e))e=z(e,+n);else if(p(e)){const s=+n,o=0===+t[++r]?"key":"value",i=z(e,s);switch(o){case"key":e=i;break;case"value":e=e.get(i)}}else e=e[n]}return e})(e,v(r,n));t.map(e=>v(e,n)).forEach(t=>{e=x(e,t,()=>s)})}if(f(t)){const[r,i]=t;r.forEach(t=>{e=x(e,v(t,n),()=>e)}),i&&s(i,o)}else s(t,o);return e}const M=(e,t,r,n,i=[],a=[],l=new Map)=>{const y=h(e);if(!y){!function(e,t,r){const n=r.get(e);n?n.push(t):r.set(e,[t])}(e,i,t);const r=l.get(e);if(r)return n?{transformedValue:null}:r}if(!((e,t)=>u(e)||f(e)||p(e)||d(e)||g(e)||T(e,t))(e,r)){const t=S(e,r),n=t?{transformedValue:t.value,annotations:[t.type]}:{transformedValue:e};return y||l.set(e,n),n}if(o(a,e))return{transformedValue:null};const m=S(e,r),w=m?.value??e,v=f(w)?[]:{},E={};s(w,(o,c)=>{if("__proto__"===c||"constructor"===c||"prototype"===c)throw new Error(`Detected property ${c}. This is a prototype pollution risk, please remove it from your object.`);const p=M(o,t,r,n,[...i,c],[...a,e],l);v[c]=p.transformedValue,f(p.annotations)?E[b(c)]=p.annotations:u(p.annotations)&&s(p.annotations,(e,t)=>{E[b(c)+"."+t]=e})});const I=c(E)?{transformedValue:v,annotations:m?[m.type]:void 0}:{transformedValue:v,annotations:m?[m.type,E]:E};return y||l.set(e,I),I};function D(e){return Object.prototype.toString.call(e).slice(8,-1)}function K(e){return"Array"===D(e)}function q(e,t={}){if(K(e))return e.map(e=>q(e,t));if(!function(e){if("Object"!==D(e))return!1;const t=Object.getPrototypeOf(e);return!!t&&t.constructor===Object&&t===Object.prototype}(e))return e;return[...Object.getOwnPropertyNames(e),...Object.getOwnPropertySymbols(e)].reduce((r,n)=>{if("__proto__"===n)return r;if(K(t.props)&&!t.props.includes(n))return r;return function(e,t,r,n,s){const o={}.propertyIsEnumerable.call(n,t)?"enumerable":"nonenumerable";"enumerable"===o&&(e[t]=r),s&&"nonenumerable"===o&&Object.defineProperty(e,t,{value:r,enumerable:!1,writable:!0,configurable:!0})}(r,n,q(e[n],t),e,t.nonenumerable),r},{})}class L{constructor({dedupe:e=!1}={}){this.classRegistry=new r,this.symbolRegistry=new t(e=>e.description??""),this.customTransformerRegistry=new a,this.allowedErrorProps=[],this.dedupe=e}serialize(e){const t=new Map,r=M(e,t,this,this.dedupe),n={json:r.transformedValue};r.annotations&&(n.meta={...n.meta,values:r.annotations});const s=function(e,t){const r={};let n;return e.forEach(e=>{if(e.length<=1)return;t||(e=e.map(e=>e.map(String)).sort((e,t)=>e.length-t.length));const[s,...o]=e;0===s.length?n=o.map(w):r[w(s)]=o.map(w)}),n?c(r)?[n]:[n,r]:c(r)?void 0:r}(t,this.dedupe);return s&&(n.meta={...n.meta,referentialEqualities:s}),n.meta&&(n.meta.v=1),n}deserialize(e,t){const{json:r,meta:n}=e;let s=t?.inPlace?r:q(r);return n?.values&&(s=C(s,n.values,n.v??0,this)),n?.referentialEqualities&&(s=U(s,n.referentialEqualities,n.v??0)),s}stringify(e){return JSON.stringify(this.serialize(e))}parse(e){return this.deserialize(JSON.parse(e),{inPlace:!0})}registerClass(e,t){this.classRegistry.register(e,t)}registerSymbol(e,t){this.symbolRegistry.register(e,t)}registerCustom(e,t){this.customTransformerRegistry.register({name:t,...e})}allowErrorProps(...e){this.allowedErrorProps.push(...e)}}L.defaultInstance=new L,L.serialize=L.defaultInstance.serialize.bind(L.defaultInstance),L.deserialize=L.defaultInstance.deserialize.bind(L.defaultInstance),L.stringify=L.defaultInstance.stringify.bind(L.defaultInstance),L.parse=L.defaultInstance.parse.bind(L.defaultInstance),L.registerClass=L.defaultInstance.registerClass.bind(L.defaultInstance),L.registerSymbol=L.defaultInstance.registerSymbol.bind(L.defaultInstance),L.registerCustom=L.defaultInstance.registerCustom.bind(L.defaultInstance),L.allowErrorProps=L.defaultInstance.allowErrorProps.bind(L.defaultInstance),L.serialize,L.deserialize,L.stringify,L.parse,L.registerClass,L.registerCustom,L.registerSymbol,L.allowErrorProps;class J{static version="6.0.4";static superjson=L;itemName;defaultValue;#e;#t;storage;#r;constructor(e,t,r={}){const{encodeFn:n,decodeFn:s,storage:o=window.localStorage}=r;if("string"!=typeof e)throw new TypeError("itemName is not a string");if(this.itemName=e,this.defaultValue=t,n&&"function"!=typeof n)throw new TypeError("encodeFn is defined but is not a function");if(this.#e=n||(e=>J.superjson.stringify(e)),s&&"function"!=typeof s)throw new TypeError("decodeFn is defined but is not a function");if(this.#t=s||(e=>J.superjson.parse(e)),!(o instanceof Storage))throw new TypeError("storage must be an instance of Storage");this.storage=o,this.sync()}set value(e){this.#r=e,this.storage.setItem(this.itemName,this.#e(e))}get value(){return this.#r}set(e,t){return this.value="function"==typeof e?e(this.#r):{...this.#r,[e]:t}}sync(e=this.#t){let t=this.storage.getItem(this.itemName);if("string"!=typeof t)return this.reset();try{return this.value=e(t)}catch(e){return console.error(e),this.reset(),e}}reset(){return this.value=this.defaultValue}isDefault(){return this.#r===this.defaultValue}}return J});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperstorage-js",
-  "version": "6.0.2",
+  "version": "6.0.4",
   "description": "A lightweight wrapper for localStorage/sessionStorage with efficient caching and type-preserving serialization.",
   "license": "MIT",
   "author": "Khoeckman",

package/src/index.ts

@@ -12,27 +12,27 @@ declare const __VERSION__: string
  */
 class HyperStorage<T> {
   /** Version of the library, injected via Rollup replace plugin. */
-  static readonly version: string = __VERSION__
+  public static readonly version: string = __VERSION__
 
-  static readonly superjson = superjson
+  public static readonly superjson = superjson
 
   /** Key name under which the data is stored. */
-  readonly itemName: string
+  public readonly itemName: string
 
   /** Default value used when the key does not exist in storage. */
-  private readonly defaultValue: T
+  public readonly defaultValue: T
 
   /** Function to encode values before storing. */
-  private readonly encodeFn: (value: T) => string
+  readonly #encodeFn: (value: T) => string
 
   /** Function to decode values when reading. */
-  private readonly decodeFn: (value: string) => T
+  readonly #decodeFn: (value: string) => T
 
   /** The underlying storage backend (defaults to `window.localStorage`). */
-  readonly storage: Storage
+  public readonly storage: Storage
 
   /** Internal cached value to improve access speed. */
-  #value?: T
+  #value!: T
 
   /**
    * Creates a new HyperStorage instance.
@@ -61,13 +61,14 @@ class HyperStorage<T> {
 
     if (typeof itemName !== 'string') throw new TypeError('itemName is not a string')
     this.itemName = itemName
+
     this.defaultValue = defaultValue
 
     if (encodeFn && typeof encodeFn !== 'function') throw new TypeError('encodeFn is defined but is not a function')
-    this.encodeFn = encodeFn || ((v) => HyperStorage.superjson.stringify(v))
+    this.#encodeFn = encodeFn || ((v) => HyperStorage.superjson.stringify(v))
 
     if (decodeFn && typeof decodeFn !== 'function') throw new TypeError('decodeFn is defined but is not a function')
-    this.decodeFn = decodeFn || ((v) => HyperStorage.superjson.parse<T>(v))
+    this.#decodeFn = decodeFn || ((v) => HyperStorage.superjson.parse<T>(v))
 
     if (!(storage instanceof Storage)) throw new TypeError('storage must be an instance of Storage')
     this.storage = storage
@@ -80,17 +81,15 @@ class HyperStorage<T> {
    * Automatically caches, stringifies and encodes the value.
    */
   set value(value: T) {
-    // Cache real value
-    this.#value = value
-
-    this.storage.setItem(this.itemName, this.encodeFn(value))
+    this.#value = value // Cache real value
+    this.storage.setItem(this.itemName, this.#encodeFn(value))
   }
 
   /**
    * Gets the current cached value.
    */
   get value(): T {
-    return this.#value ?? this.defaultValue
+    return this.#value
   }
 
   /**
@@ -99,10 +98,10 @@ class HyperStorage<T> {
   set<K extends keyof T>(key: K, value: T[K]): T
   set(callback: (value: T) => T): T
   set(keyOrCallback: keyof T | ((value: T) => T), value?: T[keyof T]): T {
-    if (typeof keyOrCallback === 'function') return (this.value = keyOrCallback(this.value))
+    if (typeof keyOrCallback === 'function') return (this.value = keyOrCallback(this.#value))
 
     return (this.value = {
-      ...this.value,
+      ...this.#value,
       [keyOrCallback]: value,
     })
   }
@@ -113,7 +112,7 @@ class HyperStorage<T> {
    * This is only necessary if the stored value may have been modified externally.
    * Using this function should be avoided when possible and is not type safe.
    */
-  sync(decodeFn = this.decodeFn): unknown {
+  sync(decodeFn = this.#decodeFn): unknown {
     let json = this.storage.getItem(this.itemName)
 
     // Reset value to defaultValue if it does not exist in storage
@@ -123,45 +122,22 @@ class HyperStorage<T> {
     try {
       return (this.value = decodeFn(json))
     } catch (err) {
-      this.reset()
       console.error(err)
+      this.reset()
       return err
     }
   }
 
   /**
    * Resets the stored value to its configured default.
-   *
    * Updates both the underlying storage and the internal cache.
    */
   reset(): T {
     return (this.value = this.defaultValue)
   }
 
-  /**
-   * Removes this specific key and its value from storage.
-   *
-   * Also clears the internal cache to prevent stale data access.
-   */
-  remove(): void {
-    this.#value = undefined
-    this.storage.removeItem(this.itemName)
-  }
-
-  /**
-   * Clears **all** data fromstorage.
-   *
-   * This affects every key in the storage.
-   * Also clears the internal cache to prevent stale data access.
-   */
-  clear(): void {
-    this.#value = undefined
-    this.storage.clear()
-  }
-
   /**
    * Checks whether the current cached value matches the configured default value.
-   *
    * Uses reference comparison for objects and strict equality for primitives.
    */
   isDefault(): boolean {