@slimlib/store 1.1.2 → 1.3.0

package/README.md

@@ -73,7 +73,7 @@ export function doSomething() {
     state.field = value;
 }
 
-export const storeName = { subscribe };
+export default { subscribe };
 ```
 
 In component
@@ -95,9 +95,13 @@ $storeName
 
 The only exported function. It returns createStore factory (see next) which notifies innidiately after creating store if `notifyAfterCreation` is truethy.
 
-#### `createStore<T>(initialState: T): [T, Store<T>]`
+#### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
 
-Store factory function that takes initial state and returns proxy object and store tuple. Proxy object ment to be left for actions implementations and store is for subscription for changes.
+Store factory function that takes initial state and returns proxy object, store and function to notify subscribers. Proxy object ment to be left for actions implementations, store is for subscription for changes and notification only for some edge cases when original object have been changed and listeners have to be notified.
+
+#### `unwrapValue(value: T): T`
+
+Unwraps potential proxy object and returns plain object if possible or value itself.
 
 #### `Store<T>`
 
@@ -114,7 +118,7 @@ Publish/subscribe/read pattern implementation. Ment to be used in components / s
 
 ### `react` and `preact` exports
 
-#### `createStore<T>(initialState: T): [T, Store<T>]`
+#### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
 
 Store factory created with `notifyAfterCreation` === `false`.
 
@@ -124,7 +128,7 @@ Function to subscribe to store inside component. Returns current state.
 
 ### `svelte` export
 
-#### `createStore<T>(initialState: T): [T, Store<T>]`
+#### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
 
 Store factory created with `notifyAfterCreation` === `true`.
 
@@ -135,6 +139,11 @@ Store factory created with `notifyAfterCreation` === `true`.
 Mixing proxied values and values from underlying object can fail for cases where code needs checking for equality.
 
 For example searching array element from underlying object in proxified array will fail.
+
+## Similar projects
+
+[Valtio](https://github.com/pmndrs/valtio) - more sofisticated but similar approach, less limitations
+
 # License
 
 [MIT](./LICENSE)

package/dist/core.cjs

@@ -61,7 +61,8 @@ const createStoreFactory = (notifyAfterCreation) => {
                     cb(object);
                 }
                 return () => storeListeners.delete(cb);
-            })
+            }),
+            enqueueNotification
         ];
         function createProxy(object) {
             if (proxiesCache.has(object)) {
@@ -77,3 +78,4 @@ const createStoreFactory = (notifyAfterCreation) => {
 };
 
 exports.createStoreFactory = createStoreFactory;
+exports.unwrapValue = unwrapValue;

package/dist/core.d.ts

@@ -4,4 +4,5 @@ export interface Store<T> {
     (cb: StoreCallback<T>): UnsubscribeCallback;
     (): Readonly<T>;
 }
-export declare const createStoreFactory: (notifyAfterCreation: boolean) => <T extends object>(object?: T) => [T, Store<T>];
+export declare const unwrapValue: <T>(value: T) => T;
+export declare const createStoreFactory: (notifyAfterCreation: boolean) => <T extends object>(object?: T) => [T, Store<T>, () => void];

package/dist/core.mjs

@@ -57,7 +57,8 @@ const createStoreFactory = (notifyAfterCreation) => {
                     cb(object);
                 }
                 return () => storeListeners.delete(cb);
-            })
+            }),
+            enqueueNotification
         ];
         function createProxy(object) {
             if (proxiesCache.has(object)) {
@@ -72,4 +73,4 @@ const createStoreFactory = (notifyAfterCreation) => {
     };
 };
 
-export { createStoreFactory };
+export { createStoreFactory, unwrapValue };

package/dist/index.cjs

@@ -7,3 +7,4 @@ var core = require('./core.cjs');
 
 
 exports.createStoreFactory = core.createStoreFactory;
+exports.unwrapValue = core.unwrapValue;

package/dist/index.mjs

@@ -1 +1 @@
-export { createStoreFactory } from './core.mjs';
+export { createStoreFactory, unwrapValue } from './core.mjs';

package/dist/preact.cjs

@@ -10,7 +10,7 @@ const useStore = (store) => {
     const [, setState] = hooks.useState();
     hooks.useEffect(() => {
         return store(() => setState({}));
-    }, []);
+    }, [store]);
     return store();
 };
 

package/dist/preact.d.ts

@@ -1,3 +1,3 @@
 import { Store } from './core';
-export declare const createStore: <T extends object>(object?: T) => [T, Store<T>];
+export declare const createStore: <T extends object>(object?: T) => [T, Store<T>, () => void];
 export declare const useStore: <T>(store: Store<T>) => Readonly<T>;

package/dist/preact.mjs

@@ -6,7 +6,7 @@ const useStore = (store) => {
     const [, setState] = useState();
     useEffect(() => {
         return store(() => setState({}));
-    }, []);
+    }, [store]);
     return store();
 };
 

package/dist/preact.umd.js

@@ -1,2 +1,2 @@
-!function(e,o){"object"==typeof exports&&"undefined"!=typeof module?o(exports,require("preact/hooks"),require("./core")):"function"==typeof define&&define.amd?define(["exports","preact/hooks","./core"],o):o((e="undefined"!=typeof globalThis?globalThis:e||self).slimlibStorePreact={},e.preactHooks,e.slimlibStoreCore)}(this,(function(e,o,t){"use strict";const n=t.createStoreFactory(!1);e.createStore=n,e.useStore=e=>{const[,t]=o.useState();return o.useEffect((()=>e((()=>t({})))),[]),e()},Object.defineProperty(e,"__esModule",{value:!0})}));
+!function(e,o){"object"==typeof exports&&"undefined"!=typeof module?o(exports,require("preact/hooks"),require("./core")):"function"==typeof define&&define.amd?define(["exports","preact/hooks","./core"],o):o((e="undefined"!=typeof globalThis?globalThis:e||self).slimlibStorePreact={},e.preactHooks,e.slimlibStoreCore)}(this,(function(e,o,t){"use strict";const n=t.createStoreFactory(!1);e.createStore=n,e.useStore=e=>{const[,t]=o.useState();return o.useEffect((()=>e((()=>t({})))),[e]),e()},Object.defineProperty(e,"__esModule",{value:!0})}));
 //# sourceMappingURL=preact.umd.js.map

package/dist/preact.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"preact.umd.js","sources":["../src/preact.ts"],"sourcesContent":["import { useState, useEffect } from 'preact/hooks';\nimport { createStoreFactory, Store } from './core';\n\nexport const createStore = createStoreFactory(false);\n\nexport const useStore = <T>(store: Store<T>) => {\n    const [, setState] = useState<object>();\n    \n    useEffect(() => {\n        return store(() => setState({}));\n    }, []);\n    \n    return store();\n};\n"],"names":["createStore","createStoreFactory","store","setState","useState","useEffect"],"mappings":"uWAGaA,EAAcC,sBAAmB,8BAElBC,IACxB,OAASC,GAAYC,aAMrB,OAJAC,aAAU,IACCH,GAAM,IAAMC,EAAS,OAC7B,IAEID"}
+{"version":3,"file":"preact.umd.js","sources":["../src/preact.ts"],"sourcesContent":["import { useState, useEffect } from 'preact/hooks';\nimport { createStoreFactory, Store } from './core';\n\nexport const createStore = createStoreFactory(false);\n\nexport const useStore = <T>(store: Store<T>) => {\n    const [, setState] = useState<object>();\n    \n    useEffect(() => {\n        return store(() => setState({}));\n    }, [store]);\n    \n    return store();\n};\n"],"names":["createStore","createStoreFactory","store","setState","useState","useEffect"],"mappings":"uWAGaA,EAAcC,sBAAmB,8BAElBC,IACxB,OAASC,GAAYC,aAMrB,OAJAC,aAAU,IACCH,GAAM,IAAMC,EAAS,OAC7B,CAACD,IAEGA"}

package/dist/react.cjs

@@ -10,7 +10,7 @@ const useStore = (store) => {
     const [, setState] = react.useState();
     react.useEffect(() => {
         return store(() => setState({}));
-    }, []);
+    }, [store]);
     return store();
 };
 

package/dist/react.d.ts

@@ -1,3 +1,3 @@
 import { Store } from './core';
-export declare const createStore: <T extends object>(object?: T) => [T, Store<T>];
+export declare const createStore: <T extends object>(object?: T) => [T, Store<T>, () => void];
 export declare const useStore: <T>(store: Store<T>) => Readonly<T>;

package/dist/react.mjs

@@ -6,7 +6,7 @@ const useStore = (store) => {
     const [, setState] = useState();
     useEffect(() => {
         return store(() => setState({}));
-    }, []);
+    }, [store]);
     return store();
 };
 

package/dist/react.umd.js

@@ -1,2 +1,2 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("react"),require("./core")):"function"==typeof define&&define.amd?define(["exports","react","./core"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).slimlibStoreReact={},e.react,e.slimlibStoreCore)}(this,(function(e,t,o){"use strict";const n=o.createStoreFactory(!1);e.createStore=n,e.useStore=e=>{const[,o]=t.useState();return t.useEffect((()=>e((()=>o({})))),[]),e()},Object.defineProperty(e,"__esModule",{value:!0})}));
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("react"),require("./core")):"function"==typeof define&&define.amd?define(["exports","react","./core"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).slimlibStoreReact={},e.react,e.slimlibStoreCore)}(this,(function(e,t,o){"use strict";const n=o.createStoreFactory(!1);e.createStore=n,e.useStore=e=>{const[,o]=t.useState();return t.useEffect((()=>e((()=>o({})))),[e]),e()},Object.defineProperty(e,"__esModule",{value:!0})}));
 //# sourceMappingURL=react.umd.js.map

package/dist/react.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"react.umd.js","sources":["../src/react.ts"],"sourcesContent":["import { useState, useEffect } from 'react';\nimport { createStoreFactory, Store } from './core';\n\nexport const createStore = createStoreFactory(false);\n\nexport const useStore = <T>(store: Store<T>) => {\n    const [, setState] = useState<object>();\n    \n    useEffect(() => {\n        return store(() => setState({}));\n    }, []);\n    \n    return store();\n};\n"],"names":["createStore","createStoreFactory","store","setState","useState","useEffect"],"mappings":"kVAGaA,EAAcC,sBAAmB,8BAElBC,IACxB,OAASC,GAAYC,aAMrB,OAJAC,aAAU,IACCH,GAAM,IAAMC,EAAS,OAC7B,IAEID"}
+{"version":3,"file":"react.umd.js","sources":["../src/react.ts"],"sourcesContent":["import { useState, useEffect } from 'react';\nimport { createStoreFactory, Store } from './core';\n\nexport const createStore = createStoreFactory(false);\n\nexport const useStore = <T>(store: Store<T>) => {\n    const [, setState] = useState<object>();\n    \n    useEffect(() => {\n        return store(() => setState({}));\n    }, [store]);\n    \n    return store();\n};\n"],"names":["createStore","createStoreFactory","store","setState","useState","useEffect"],"mappings":"kVAGaA,EAAcC,sBAAmB,8BAElBC,IACxB,OAASC,GAAYC,aAMrB,OAJAC,aAAU,IACCH,GAAM,IAAMC,EAAS,OAC7B,CAACD,IAEGA"}

package/dist/svelte.d.ts

@@ -1 +1 @@
-export declare const createStore: <T extends object>(object?: T) => [T, import("./core").Store<T>];
+export declare const createStore: <T extends object>(object?: T) => [T, import("./core").Store<T>, () => void];

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.2",
+  "version": "1.3.0",
   "license": "MIT",
   "name": "@slimlib/store",
   "author": "Konstantin Shutkin",