@slimlib/store 1.1.1 → 1.2.0

package/README.md

@@ -73,7 +73,7 @@ export function doSomething() {
     state.field = value;
 }
 
-export const storeName = { subscribe };
+export default { subscribe };
 ```
 
 In component
@@ -99,6 +99,10 @@ The only exported function. It returns createStore factory (see next) which noti
 
 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.
 
+#### `unwrapValue(value: T): T`
+
+Unwraps potential proxy object and returns plain object if possible or value itself.
+
 #### `Store<T>`
 
 ```typescript
@@ -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

@@ -77,3 +77,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 unwrapValue: <T>(value: T) => T;
 export declare const createStoreFactory: (notifyAfterCreation: boolean) => <T extends object>(object?: T) => [T, Store<T>];

package/dist/core.mjs

@@ -72,4 +72,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.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.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/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.1",
+  "version": "1.2.0",
   "license": "MIT",
   "name": "@slimlib/store",
   "author": "Konstantin Shutkin",
@@ -48,7 +48,7 @@
   "bugs": {
     "url": "https://github.com/kshutkin/slimlib/issues"
   },
-  "homepage": "https://github.com/kshutkin/slimlib/store/README.md",
+  "homepage": "https://github.com/kshutkin/slimlib/blob/main/store/README.md",
   "scripts": {
     "build": "pkgbld --umd=index,preact,react,svelte",
     "test": "jest --collectCoverage",