@slimlib/store 1.3.3 → 1.3.5

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Konstantin Shutkin
+Copyright (c) 2023 Konstantin Shutkin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,6 +7,8 @@ Proxy-based store for SPAs.
 3. Small size (less than 1Kb minified not gzipped)
 4. Typescript support
 
+[Changelog](./CHANGELOG.md)
+
 # Installation
 
 Using npm:
@@ -93,15 +95,15 @@ $storeName
 
 ####  `createStoreFactory(notifyAfterCreation: boolean)`
 
-The only exported function. It returns createStore factory (see next) which notifies innidiately after creating store if `notifyAfterCreation` is truethy.
+The only exported function. It returns createStore factory (see next) which notifies immediately after creating store if `notifyAfterCreation` is truthy.
 
 #### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
 
-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.
+Store factory function that takes initial state and returns proxy object, store and function to notify subscribers. Proxy object meant to be left for actions implementations, store is for subscription for changes and notification only for some edge cases when an original object has 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.
+Unwraps a potential proxy object and returns a plain object if possible or value itself.
 
 #### `Store<T>`
 
@@ -114,7 +116,7 @@ interface Store<T> {
 }
 ```
 
-Publish/subscribe/read pattern implementation. Ment to be used in components / services that want to subscribe for store changes.
+Publish/subscribe/read pattern implementation. Meant to be used in components / services that want to subscribe for store changes.
 
 ### `react` and `preact` exports
 
@@ -136,14 +138,14 @@ Store factory created with `notifyAfterCreation` === `true`.
 
 `Map`, `Set`, `WeakMap`, `WeakSet` cannot be used as values in current implementation.
 
-Mixing proxied values and values from underlying object can fail for cases where code needs checking for equality.
+Mixing proxied values and values from an 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.
+For example searching for an array element from the underlying object in a proxied array will fail.
 
 ## Similar projects
 
-[Valtio](https://github.com/pmndrs/valtio) - more sofisticated but similar approach, less limitations
+[Valtio](https://github.com/pmndrs/valtio) - more sophisticated but similar approach, less limitations
 
 # License
 
-[MIT](./LICENSE)
+[MIT](https://github.com/kshutkin/slimlib/blob/main/LICENSE)

package/dist/core.cjs

@@ -1,78 +1,78 @@
 'use strict';
 
-const unwrap = Symbol();
-const unwrapValue = (value) => (value != null && value[unwrap]) || value;
-const createStoreFactory = (notifyAfterCreation) => {
-    return (object = {}) => {
-        let willNotifyNextTick = false;
-        const proxiesCache = new WeakMap();
-        const storeListeners = new Set();
-        const enqueueNotification = () => {
-            if (!willNotifyNextTick) {
-                willNotifyNextTick = true;
-                queueMicrotask(() => {
-                    willNotifyNextTick = false;
-                    for (const listener of storeListeners) {
-                        listener(object);
-                    }
-                });
-            }
-        };
-        const handler = {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            set(target, p, value, receiver) {
-                const realValue = unwrapValue(value);
-                if (Reflect.get(target, p, receiver) !== realValue) {
-                    Reflect.set(target, p, realValue, receiver);
-                    enqueueNotification();
-                }
-                return true;
-            },
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            get(target, p, receiver) {
-                if (p === unwrap)
-                    return target;
-                const value = Reflect.get(target, p, receiver);
-                return value !== null && typeof value === 'object' && !(value instanceof RegExp) ? createProxy(value) : value;
-            },
-            defineProperty(...args) {
-                enqueueNotification();
-                return Reflect.defineProperty(...args);
-            },
-            deleteProperty(target, p) {
-                const result = Reflect.deleteProperty(target, p);
-                if (result) {
-                    enqueueNotification();
-                }
-                return result;
-            }
-        };
-        const proxy = createProxy(object);
-        return [
-            proxy,
-            ((cb) => {
-                if (!cb) {
-                    return object;
-                }
-                storeListeners.add(cb);
-                if (notifyAfterCreation) {
-                    cb(object);
-                }
-                return () => storeListeners.delete(cb);
-            }),
-            enqueueNotification
-        ];
-        function createProxy(object) {
-            if (proxiesCache.has(object)) {
-                return proxiesCache.get(object);
-            }
-            else {
-                const proxy = new Proxy(object, handler);
-                proxiesCache.set(object, proxy);
-                return proxy;
-            }
-        }
-    };
+const unwrap = Symbol();
+const unwrapValue = (value) => (value != null && value[unwrap]) || value;
+const createStoreFactory = (notifyAfterCreation) => {
+    return (object = {}) => {
+        let willNotifyNextTick = false;
+        const proxiesCache = new WeakMap();
+        const storeListeners = new Set();
+        const enqueueNotification = () => {
+            if (!willNotifyNextTick) {
+                willNotifyNextTick = true;
+                queueMicrotask(() => {
+                    willNotifyNextTick = false;
+                    for (const listener of storeListeners) {
+                        listener(object);
+                    }
+                });
+            }
+        };
+        const handler = {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            set(target, p, value, receiver) {
+                const realValue = unwrapValue(value);
+                if (Reflect.get(target, p, receiver) !== realValue) {
+                    Reflect.set(target, p, realValue, receiver);
+                    enqueueNotification();
+                }
+                return true;
+            },
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            get(target, p, receiver) {
+                if (p === unwrap)
+                    return target;
+                const value = Reflect.get(target, p, receiver);
+                return value !== null && typeof value === 'object' && !(value instanceof RegExp) ? createProxy(value) : value;
+            },
+            defineProperty(...args) {
+                enqueueNotification();
+                return Reflect.defineProperty(...args);
+            },
+            deleteProperty(target, p) {
+                const result = Reflect.deleteProperty(target, p);
+                if (result) {
+                    enqueueNotification();
+                }
+                return result;
+            }
+        };
+        const proxy = createProxy(object);
+        return [
+            proxy,
+            ((cb) => {
+                if (!cb) {
+                    return object;
+                }
+                storeListeners.add(cb);
+                if (notifyAfterCreation) {
+                    cb(object);
+                }
+                return () => storeListeners.delete(cb);
+            }),
+            enqueueNotification
+        ];
+        function createProxy(object) {
+            if (proxiesCache.has(object)) {
+                return proxiesCache.get(object);
+            }
+            else {
+                const proxy = new Proxy(object, handler);
+                proxiesCache.set(object, proxy);
+                return proxy;
+            }
+        }
+    };
 };
 
 exports.createStoreFactory = createStoreFactory;

package/dist/core.d.ts

@@ -1,8 +1,8 @@
-export declare type StoreCallback<T> = (value: T) => void;
-export declare type UnsubscribeCallback = () => void;
-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>, () => void];
+export type StoreCallback<T> = (value: T) => void;
+export type UnsubscribeCallback = () => void;
+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>, () => void];

package/dist/core.mjs

@@ -1,76 +1,76 @@
-const unwrap = Symbol();
-const unwrapValue = (value) => (value != null && value[unwrap]) || value;
-const createStoreFactory = (notifyAfterCreation) => {
-    return (object = {}) => {
-        let willNotifyNextTick = false;
-        const proxiesCache = new WeakMap();
-        const storeListeners = new Set();
-        const enqueueNotification = () => {
-            if (!willNotifyNextTick) {
-                willNotifyNextTick = true;
-                queueMicrotask(() => {
-                    willNotifyNextTick = false;
-                    for (const listener of storeListeners) {
-                        listener(object);
-                    }
-                });
-            }
-        };
-        const handler = {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            set(target, p, value, receiver) {
-                const realValue = unwrapValue(value);
-                if (Reflect.get(target, p, receiver) !== realValue) {
-                    Reflect.set(target, p, realValue, receiver);
-                    enqueueNotification();
-                }
-                return true;
-            },
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            get(target, p, receiver) {
-                if (p === unwrap)
-                    return target;
-                const value = Reflect.get(target, p, receiver);
-                return value !== null && typeof value === 'object' && !(value instanceof RegExp) ? createProxy(value) : value;
-            },
-            defineProperty(...args) {
-                enqueueNotification();
-                return Reflect.defineProperty(...args);
-            },
-            deleteProperty(target, p) {
-                const result = Reflect.deleteProperty(target, p);
-                if (result) {
-                    enqueueNotification();
-                }
-                return result;
-            }
-        };
-        const proxy = createProxy(object);
-        return [
-            proxy,
-            ((cb) => {
-                if (!cb) {
-                    return object;
-                }
-                storeListeners.add(cb);
-                if (notifyAfterCreation) {
-                    cb(object);
-                }
-                return () => storeListeners.delete(cb);
-            }),
-            enqueueNotification
-        ];
-        function createProxy(object) {
-            if (proxiesCache.has(object)) {
-                return proxiesCache.get(object);
-            }
-            else {
-                const proxy = new Proxy(object, handler);
-                proxiesCache.set(object, proxy);
-                return proxy;
-            }
-        }
-    };
+const unwrap = Symbol();
+const unwrapValue = (value) => (value != null && value[unwrap]) || value;
+const createStoreFactory = (notifyAfterCreation) => {
+    return (object = {}) => {
+        let willNotifyNextTick = false;
+        const proxiesCache = new WeakMap();
+        const storeListeners = new Set();
+        const enqueueNotification = () => {
+            if (!willNotifyNextTick) {
+                willNotifyNextTick = true;
+                queueMicrotask(() => {
+                    willNotifyNextTick = false;
+                    for (const listener of storeListeners) {
+                        listener(object);
+                    }
+                });
+            }
+        };
+        const handler = {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            set(target, p, value, receiver) {
+                const realValue = unwrapValue(value);
+                if (Reflect.get(target, p, receiver) !== realValue) {
+                    Reflect.set(target, p, realValue, receiver);
+                    enqueueNotification();
+                }
+                return true;
+            },
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            get(target, p, receiver) {
+                if (p === unwrap)
+                    return target;
+                const value = Reflect.get(target, p, receiver);
+                return value !== null && typeof value === 'object' && !(value instanceof RegExp) ? createProxy(value) : value;
+            },
+            defineProperty(...args) {
+                enqueueNotification();
+                return Reflect.defineProperty(...args);
+            },
+            deleteProperty(target, p) {
+                const result = Reflect.deleteProperty(target, p);
+                if (result) {
+                    enqueueNotification();
+                }
+                return result;
+            }
+        };
+        const proxy = createProxy(object);
+        return [
+            proxy,
+            ((cb) => {
+                if (!cb) {
+                    return object;
+                }
+                storeListeners.add(cb);
+                if (notifyAfterCreation) {
+                    cb(object);
+                }
+                return () => storeListeners.delete(cb);
+            }),
+            enqueueNotification
+        ];
+        function createProxy(object) {
+            if (proxiesCache.has(object)) {
+                return proxiesCache.get(object);
+            }
+            else {
+                const proxy = new Proxy(object, handler);
+                proxiesCache.set(object, proxy);
+                return proxy;
+            }
+        }
+    };
 };
 
 export { createStoreFactory, unwrapValue };

package/dist/index.d.ts

@@ -1 +1 @@
-export * from './core';
+export * from './core';

package/dist/preact.cjs

@@ -3,13 +3,13 @@
 var hooks = require('preact/hooks');
 var core = require('./core.cjs');
 
-const createStore = core.createStoreFactory(false);
-const useStore = (store) => {
-    const [, setState] = hooks.useState();
-    hooks.useEffect(() => {
-        return store(() => setState({}));
-    }, [store]);
-    return store();
+const createStore = core.createStoreFactory(false);
+const useStore = (store) => {
+    const [, setState] = hooks.useState();
+    hooks.useEffect(() => {
+        return store(() => setState({}));
+    }, [store]);
+    return store();
 };
 
 exports.createStore = createStore;

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>, () => void];
-export declare const useStore: <T>(store: Store<T>) => Readonly<T>;
+import { Store } from './core';
+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

@@ -1,13 +1,13 @@
 import { useState, useEffect } from 'preact/hooks';
 import { createStoreFactory } from './core.mjs';
 
-const createStore = createStoreFactory(false);
-const useStore = (store) => {
-    const [, setState] = useState();
-    useEffect(() => {
-        return store(() => setState({}));
-    }, [store]);
-    return store();
+const createStore = createStoreFactory(false);
+const useStore = (store) => {
+    const [, setState] = useState();
+    useEffect(() => {
+        return store(() => setState({}));
+    }, [store]);
+    return store();
 };
 
 export { createStore, useStore };

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    }, [store]);\n    \n    return store();\n};\n"],"names":["createStore","createStoreFactory","store","setState","useState","useEffect"],"mappings":"uWAGaA,EAAcC,EAAkBA,oBAAC,8BAElBC,IACxB,MAAS,CAAAC,GAAYC,EAAAA,WAMrB,OAJAC,EAAAA,WAAU,IACCH,GAAM,IAAMC,EAAS,OAC7B,CAACD,IAEGA"}
+{"version":3,"file":"preact.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/react.cjs

@@ -3,13 +3,13 @@
 var react = require('react');
 var core = require('./core.cjs');
 
-const createStore = core.createStoreFactory(false);
-const useStore = (store) => {
-    const [, setState] = react.useState();
-    react.useEffect(() => {
-        return store(() => setState({}));
-    }, [store]);
-    return store();
+const createStore = core.createStoreFactory(false);
+const useStore = (store) => {
+    const [, setState] = react.useState();
+    react.useEffect(() => {
+        return store(() => setState({}));
+    }, [store]);
+    return store();
 };
 
 exports.createStore = createStore;

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>, () => void];
-export declare const useStore: <T>(store: Store<T>) => Readonly<T>;
+import { Store } from './core';
+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

@@ -1,13 +1,13 @@
 import { useState, useEffect } from 'react';
 import { createStoreFactory } from './core.mjs';
 
-const createStore = createStoreFactory(false);
-const useStore = (store) => {
-    const [, setState] = useState();
-    useEffect(() => {
-        return store(() => setState({}));
-    }, [store]);
-    return store();
+const createStore = createStoreFactory(false);
+const useStore = (store) => {
+    const [, setState] = useState();
+    useEffect(() => {
+        return store(() => setState({}));
+    }, [store]);
+    return store();
 };
 
 export { createStore, useStore };

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    }, [store]);\n    \n    return store();\n};\n"],"names":["createStore","createStoreFactory","store","setState","useState","useEffect"],"mappings":"kVAGaA,EAAcC,EAAkBA,oBAAC,8BAElBC,IACxB,MAAS,CAAAC,GAAYC,EAAAA,WAMrB,OAJAC,EAAAA,WAAU,IACCH,GAAM,IAAMC,EAAS,OAC7B,CAACD,IAEGA"}
+{"version":3,"file":"react.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/svelte.d.ts

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

package/dist/svelte.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"svelte.umd.js","sources":["../src/svelte.ts"],"sourcesContent":["import { createStoreFactory } from './core';\n\nexport const createStore = createStoreFactory(true);\n"],"names":["createStore","createStoreFactory"],"mappings":"gTAEaA,EAAcC,EAAkBA,oBAAC"}
+{"version":3,"file":"svelte.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.3",
+  "version": "1.3.5",
   "license": "MIT",
   "name": "@slimlib/store",
   "author": "Konstantin Shutkin",
@@ -47,12 +47,6 @@
     "url": "https://github.com/kshutkin/slimlib/issues"
   },
   "homepage": "https://github.com/kshutkin/slimlib/blob/main/store/README.md",
-  "scripts": {
-    "build": "pkgbld-internal --umd=index,preact,react,svelte",
-    "test": "jest --collectCoverage",
-    "lint": "eslint ./src",
-    "semantic-release": "npx semantic-release"
-  },
   "peerDependencies": {
     "preact": ">=10.0.0",
     "react": ">=17.0.0"
@@ -66,37 +60,27 @@
     }
   },
   "devDependencies": {
-    "@semantic-release/changelog": "6.0.1",
-    "@semantic-release/commit-analyzer": "9.0.2",
-    "@semantic-release/git": "10.0.1",
-    "@semantic-release/npm": "9.0.0",
-    "@semantic-release/release-notes-generator": "10.0.3",
-    "@types/jest": "27.4.0",
-    "@types/react": "^17.0.39",
-    "@typescript-eslint/eslint-plugin": "5.11.0",
-    "@typescript-eslint/parser": "5.11.0",
-    "conventional-changelog-angular": "5.0.13",
-    "eslint": "8.8.0",
-    "jest": "27.5.1",
-    "pkgbld-internal": "1.0.8",
+    "@types/react": "^18.0.0",
     "preact": ">=10.0.0",
     "react": ">=17.0.0",
     "react-dom": ">=17.0.0",
-    "@testing-library/react": "12.1.3",
+    "@testing-library/react": "^14.0.0",
     "@types/react-dom": ">=17.0.0",
-    "semantic-release": "19.0.2",
-    "semantic-release-monorepo": "7.0.5",
-    "ts-jest": "27.1.3",
-    "typescript": "4.5.x",
-    "update-monorepo-package-json": "0.2.0",
-    "@testing-library/svelte": "3.0.3",
-    "svelte": "3.46.4",
-    "svelte-jester": "2.3.2"
+    "jest-environment-jsdom": "^29.4.3",
+    "@testing-library/svelte": "^3.2.2",
+    "svelte": "^3.55.1",
+    "svelte-jester": "^2.3.2",
+    "tslib": "^2.5.0"
   },
   "description": "Simple Proxy-based store for SPA",
   "keywords": [
     "@slimlib",
     "store",
     "proxy"
-  ]
-}
+  ],
+  "scripts": {
+    "build": "pkgbld-internal --umd=index,preact,react,svelte",
+    "test": "jest --collectCoverage",
+    "lint": "eslint ./src"
+  }
+}