atomaric 0.0.5 → 0.0.7

package/README.md

@@ -1,10 +1,10 @@
-## 🕹️Installation and usage
+## 🕹️Installation
 
 ```sh
 npm install atomaric
 ```
 
-### usage
+## usage
 
 ```tsx
 import { atom, useAtom, configureAtomaric } from 'atomaric';
@@ -14,7 +14,7 @@ configureAtomaric({ useSyncExternalStore }); // do this before all
 
 const nameAtom = atom(
   'World',
-  'greats:name', // optional locakStorage key
+  'greats:name', // optional localStorage key
 );
 
 function App() {

package/build/atomaric.js

@@ -1,38 +1,49 @@
-const u = {};
+const h = {};
 window.addEventListener("storage", (e) => {
-  e.key === null || u[e.key] === void 0 || u[e.key](e);
+  e.key === null || h[e.key] === void 0 || h[e.key](e);
 });
-class g {
+class m {
   constructor(s, i) {
     if (this._defaultValue = s, this.subscribers = /* @__PURE__ */ new Set(), this.save = () => {
     }, this.invokeSubscriber = (t) => t(this.value), this.get = () => this.value, this.toggle = () => this.set(!this.value), this.inkrement = (t) => this.set(this.value + t), this.subscribe = (t) => (this.subscribers.add(t), () => {
       this.subscribers.delete(t);
-    }), this.set = (t, c) => {
-      const n = typeof t == "function" ? t(this.value) : t;
-      n === this.value || n === void 0 || typeof n == "number" && isNaN(n) || (this.value = n, this.subscribers.forEach(this.invokeSubscriber, this), c !== !0 && this.save(n));
+    }), this.set = (t, l) => {
+      const r = typeof t == "function" ? t(this.value) : t;
+      r === this.value || r === void 0 || typeof r == "number" && isNaN(r) || (this.value = r, this.subscribers.forEach(this.invokeSubscriber, this), l !== !0 && this.save(r));
+    }, this.setDeferred = (t, l = 500, r, f = !0) => {
+      f && this.debounceTimeout === void 0 && this.set(t, r), clearTimeout(this.debounceTimeout), this.debounceTimeout = setTimeout(() => {
+        this.set(t, r), delete this.debounceTimeout;
+      }, l);
     }, this.value = s, typeof s != "boolean" && (this.toggle = () => {
     }), typeof s != "number" && (this.inkrement = () => {
     }), this.reset = () => {
       this.set(s, !0), this.subscribers.forEach(this.invokeSubscriber, this);
     }, i == null) return;
-    let o = null, l = !0, h = !0;
-    if (typeof i == "string" ? o = i : i.storeKey !== void 0 && (l = i.warnOnDuplicateStoreKey ?? !0, h = i.listenStorageChanges ?? !0, o = i.storeKey), o === null) return;
-    const r = `atom/${o}`;
-    this.value = r in localStorage ? JSON.parse(localStorage[r]) : s, this.save = (t) => {
+    let u = null, c = !0, g = !0, n = (t) => JSON.parse(t), a = (t) => JSON.stringify(t);
+    if (typeof i == "string" ? u = i : i.storeKey !== void 0 && (c = i.warnOnDuplicateStoreKey ?? !0, g = i.listenStorageChanges ?? !0, u = i.storeKey, n = i.parseValue ?? n, a = i.stringifyValue ?? a), u === null) return;
+    const o = `atom/${u}`;
+    this.get = () => {
+      try {
+        this.value = o in localStorage ? n(localStorage[o]) : s, this.get = () => this.value;
+      } catch {
+        console.warn("Invalid json value", localStorage[o]);
+      }
+      return this.value;
+    }, this.save = (t) => {
       if (t === s) {
         this.reset();
         return;
       }
-      localStorage[r] = JSON.stringify(t);
+      localStorage[o] = a(t);
     }, this.reset = () => {
-      delete localStorage[r], this.set(s, !0);
-    }, l && u[r] !== void 0 && console.warn("Duplicate Atom key", i), h && (u[r] = (t) => {
+      delete localStorage[o], this.set(s, !0);
+    }, c && h[o] !== void 0 && console.warn("Duplicate Atom key", i), g && (h[o] = (t) => {
       if (t.newValue === null) {
         this.reset();
         return;
       }
       try {
-        this.set(JSON.parse(t.newValue));
+        this.set(n(t.newValue));
       } catch {
         console.warn("Invalid json value", t.newValue);
       }
@@ -42,18 +53,19 @@ class g {
     return this._defaultValue;
   }
 }
-let a = () => {
+let b = () => {
   throw "call configureAtomaric() before all!";
 };
-const S = (e) => a = e.useSyncExternalStore, b = (e) => a(e.subscribe, e.get), f = (e) => e.set, m = (e) => e.get, v = (e) => e.toggle, k = (e) => e.inkrement, w = (e) => [b(e), f(e)], y = (e, s) => new g(e, s);
+const v = (e) => b = e.useSyncExternalStore, S = (e) => b(e.subscribe, e.get), d = (e) => e.set, w = (e) => e.setDeferred, y = (e) => e.get, k = (e) => e.toggle, A = (e) => e.inkrement, T = (e) => [S(e), d(e)], D = (e, s) => new m(e, s);
 export {
-  g as Atom,
-  y as atom,
-  S as configureAtomaric,
-  w as useAtom,
-  m as useAtomGet,
-  k as useAtomInkrement,
-  f as useAtomSet,
-  v as useAtomToggle,
-  b as useAtomValue
+  m as Atom,
+  D as atom,
+  v as configureAtomaric,
+  T as useAtom,
+  y as useAtomGet,
+  A as useAtomInkrement,
+  d as useAtomSet,
+  w as useAtomSetDeferred,
+  k as useAtomToggle,
+  S as useAtomValue
 };

package/build/atomaric.umd.cjs

@@ -1 +1 @@
-(function(s,n){typeof exports=="object"&&typeof module<"u"?n(exports):typeof define=="function"&&define.amd?define(["exports"],n):(s=typeof globalThis<"u"?globalThis:s||self,n(s.atomaric={}))})(this,function(s){"use strict";const n={};window.addEventListener("storage",e=>{e.key===null||n[e.key]===void 0||n[e.key](e)});class c{constructor(i,o){if(this._defaultValue=i,this.subscribers=new Set,this.save=()=>{},this.invokeSubscriber=t=>t(this.value),this.get=()=>this.value,this.toggle=()=>this.set(!this.value),this.inkrement=t=>this.set(this.value+t),this.subscribe=t=>(this.subscribers.add(t),()=>{this.subscribers.delete(t)}),this.set=(t,b)=>{const u=typeof t=="function"?t(this.value):t;u===this.value||u===void 0||typeof u=="number"&&isNaN(u)||(this.value=u,this.subscribers.forEach(this.invokeSubscriber,this),b!==!0&&this.save(u))},this.value=i,typeof i!="boolean"&&(this.toggle=()=>{}),typeof i!="number"&&(this.inkrement=()=>{}),this.reset=()=>{this.set(i,!0),this.subscribers.forEach(this.invokeSubscriber,this)},o==null)return;let l=null,g=!0,m=!0;if(typeof o=="string"?l=o:o.storeKey!==void 0&&(g=o.warnOnDuplicateStoreKey??!0,m=o.listenStorageChanges??!0,l=o.storeKey),l===null)return;const r=`atom/${l}`;this.value=r in localStorage?JSON.parse(localStorage[r]):i,this.save=t=>{if(t===i){this.reset();return}localStorage[r]=JSON.stringify(t)},this.reset=()=>{delete localStorage[r],this.set(i,!0)},g&&n[r]!==void 0&&console.warn("Duplicate Atom key",o),m&&(n[r]=t=>{if(t.newValue===null){this.reset();return}try{this.set(JSON.parse(t.newValue))}catch{console.warn("Invalid json value",t.newValue)}})}get defaultValue(){return this._defaultValue}}let a=()=>{throw"call configureAtomaric() before all!"};const S=e=>a=e.useSyncExternalStore,h=e=>a(e.subscribe,e.get),f=e=>e.set,d=e=>e.get,A=e=>e.toggle,v=e=>e.inkrement,y=e=>[h(e),f(e)],k=(e,i)=>new c(e,i);s.Atom=c,s.atom=k,s.configureAtomaric=S,s.useAtom=y,s.useAtomGet=d,s.useAtomInkrement=v,s.useAtomSet=f,s.useAtomToggle=A,s.useAtomValue=h,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})});
+(function(s,n){typeof exports=="object"&&typeof module<"u"?n(exports):typeof define=="function"&&define.amd?define(["exports"],n):(s=typeof globalThis<"u"?globalThis:s||self,n(s.atomaric={}))})(this,function(s){"use strict";const n={};window.addEventListener("storage",e=>{e.key===null||n[e.key]===void 0||n[e.key](e)});class f{constructor(i,o){if(this._defaultValue=i,this.subscribers=new Set,this.save=()=>{},this.invokeSubscriber=t=>t(this.value),this.get=()=>this.value,this.toggle=()=>this.set(!this.value),this.inkrement=t=>this.set(this.value+t),this.subscribe=t=>(this.subscribers.add(t),()=>{this.subscribers.delete(t)}),this.set=(t,c)=>{const u=typeof t=="function"?t(this.value):t;u===this.value||u===void 0||typeof u=="number"&&isNaN(u)||(this.value=u,this.subscribers.forEach(this.invokeSubscriber,this),c!==!0&&this.save(u))},this.setDeferred=(t,c=500,u,E=!0)=>{E&&this.debounceTimeout===void 0&&this.set(t,u),clearTimeout(this.debounceTimeout),this.debounceTimeout=setTimeout(()=>{this.set(t,u),delete this.debounceTimeout},c)},this.value=i,typeof i!="boolean"&&(this.toggle=()=>{}),typeof i!="number"&&(this.inkrement=()=>{}),this.reset=()=>{this.set(i,!0),this.subscribers.forEach(this.invokeSubscriber,this)},o==null)return;let l=null,b=!0,S=!0,a=t=>JSON.parse(t),h=t=>JSON.stringify(t);if(typeof o=="string"?l=o:o.storeKey!==void 0&&(b=o.warnOnDuplicateStoreKey??!0,S=o.listenStorageChanges??!0,l=o.storeKey,a=o.parseValue??a,h=o.stringifyValue??h),l===null)return;const r=`atom/${l}`;this.get=()=>{try{this.value=r in localStorage?a(localStorage[r]):i,this.get=()=>this.value}catch{console.warn("Invalid json value",localStorage[r])}return this.value},this.save=t=>{if(t===i){this.reset();return}localStorage[r]=h(t)},this.reset=()=>{delete localStorage[r],this.set(i,!0)},b&&n[r]!==void 0&&console.warn("Duplicate Atom key",o),S&&(n[r]=t=>{if(t.newValue===null){this.reset();return}try{this.set(a(t.newValue))}catch{console.warn("Invalid json value",t.newValue)}})}get defaultValue(){return this._defaultValue}}let m=()=>{throw"call configureAtomaric() before all!"};const A=e=>m=e.useSyncExternalStore,g=e=>m(e.subscribe,e.get),d=e=>e.set,v=e=>e.setDeferred,y=e=>e.get,k=e=>e.toggle,w=e=>e.inkrement,T=e=>[g(e),d(e)],D=(e,i)=>new f(e,i);s.Atom=f,s.atom=D,s.configureAtomaric=A,s.useAtom=T,s.useAtomGet=y,s.useAtomInkrement=w,s.useAtomSet=d,s.useAtomSetDeferred=v,s.useAtomToggle=k,s.useAtomValue=g,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "atomaric",
   "description": "Manage your project state",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "type": "module",
   "main": "./build/atomaric.umd.cjs",
   "module": "./build/atomaric.js",

package/types/model.d.ts

@@ -2,28 +2,42 @@ type Sunscriber<Value> = (value: Value) => void;
 
 export type AtomStoreKey = `${string}${string}:${string}${string}`;
 
-export type AtomOptions = {
+export type AtomOptions<Value> = {
   storeKey?: AtomStoreKey;
   /** **default: true** */
   warnOnDuplicateStoreKey?: boolean;
   /** **default: true** */
   listenStorageChanges?: boolean;
+  parseValue?: (stringifiedValue: string) => Value;
+  stringifyValue?: (value: Value) => string;
 };
 
+export type AtomSetMethod<Value> = (value: Value | ((prev: Value) => Value), isPreventSave?: boolean) => void;
+export type AtomSetDeferredMethod<Value> = (
+  value: Value | ((prev: Value) => Value),
+  debounceMs?: number,
+  isPreventSave?: boolean,
+  isInitInvoke?: boolean,
+) => void;
+
+export type AtomSubscribeMethod<Value> = (subscriber: Sunscriber<Value>) => () => void;
+
 export class Atom<Value> {
-  constructor(defaultValue: Value, storeKeyOrOptions: AtomStoreKey | undefined | AtomOptions);
+  constructor(defaultValue: Value, storeKeyOrOptions: AtomStoreKey | undefined | AtomOptions<Value>);
 
   readonly defaultValue: Value;
   readonly get: () => Value;
+  readonly set: AtomSetMethod<Value>;
+  readonly setDeferred: AtomSetDeferredMethod<Value>;
   readonly reset: () => void;
   readonly toggle: () => void;
   readonly inkrement: (delta: number) => void;
-  readonly subscribe: (sub: Sunscriber<Value>) => () => void;
-  readonly set: (value: Value | ((prev: Value) => Value), isPreventSave?: boolean) => void;
+  readonly subscribe: AtomSubscribeMethod<Value>;
 }
 
 export function useAtomValue<Value>(atom: Atom<Value>): Value;
 export function useAtomSet<Value>(atom: Atom<Value>): (typeof atom)['set'];
+export function useAtomSetDeferred<Value>(atom: Atom<Value>): (typeof atom)['setDeferred'];
 export function useAtomGet<Value>(atom: Atom<Value>): (typeof atom)['get'];
 export function useAtomToggle(atom: Atom<boolean>): (typeof atom)['toggle'];
 export function useAtomInkrement(atom: Atom<number>): (typeof atom)['inkrement'];
@@ -32,7 +46,7 @@ export function useAtom<Value>(atom: Atom<Value>): [Value, (typeof atom)['set']]
 
 export function atom<Value>(
   value: Value,
-  storeKeyOrOptions?: `${string}${string}:${string}${string}` | AtomOptions,
+  storeKeyOrOptions?: `${string}${string}:${string}${string}` | AtomOptions<Value>,
 ): Atom<Value>;
 
 export function configureAtomaric(hooks: { useSyncExternalStore: typeof useSyncExternalStore }): void;