@slimlib/store 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# Store
+
+Proxy-based store for SPAs.
+
+# Installation
+
+Using npm:
+```
+npm install --save-dev @slimlib/store
+```
+
+# Usage
+
+TBD
+
+## API
+
+###  `createStoreFactory(notifyAfterCreation: boolean)`
+
+The only exported function. It returns createStore factory (see next).
+
+### `createStore<T>(initialState: T): [T, Store<T>]`
+
+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<T>`
+
+```typescript
+type StoreCallback<T> = (value: T) => void;
+type UnsubscribeCallback = () => void;
+interface Store<T> {
+    (cb: StoreCallback<T>): UnsubscribeCallback;
+    (): T;
+}
+```
+
+Publish/subscribe/read pattern implementation. Ment to be used in components / services that want to subscribe for store changes.
+
+## Limitations
+
+`Map`, `Set`, `WeakMap`, `WeakSet` cannot be used as values in current implementation.
+
+# License
+
+[MIT](./LICENSE)

package/dist/index.cjs

@@ -0,0 +1,74 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+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) {
+                if (Reflect.get(target, p, receiver) !== value) {
+                    Reflect.set(target, p, value, receiver);
+                    enqueueNotification();
+                }
+                return true;
+            },
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            get(target, p, receiver) {
+                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);
+            })
+        ];
+        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/index.d.ts

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

package/dist/index.mjs

@@ -0,0 +1,70 @@
+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) {
+                if (Reflect.get(target, p, receiver) !== value) {
+                    Reflect.set(target, p, value, receiver);
+                    enqueueNotification();
+                }
+                return true;
+            },
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            get(target, p, receiver) {
+                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);
+            })
+        ];
+        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 };

package/dist/index.umd.js

@@ -0,0 +1,2 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).slimlibStore={})}(this,(function(e){"use strict";e.createStoreFactory=e=>(t={})=>{let n=!1;const o=new WeakMap,f=new Set,r=()=>{n||(n=!0,queueMicrotask((()=>{n=!1;for(const e of f)e(t)})))},c={set:(e,t,n,o)=>(Reflect.get(e,t,o)!==n&&(Reflect.set(e,t,n,o),r()),!0),get(e,t,n){const o=Reflect.get(e,t,n);return null===o||"object"!=typeof o||o instanceof RegExp?o:s(o)},defineProperty:(...e)=>(r(),Reflect.defineProperty(...e)),deleteProperty(e,t){const n=Reflect.deleteProperty(e,t);return n&&r(),n}};return[s(t),n=>n?(f.add(n),e&&n(t),()=>f.delete(n)):t];function s(e){if(o.has(e))return o.get(e);{const t=new Proxy(e,c);return o.set(e,t),t}}},Object.defineProperty(e,"__esModule",{value:!0})}));
+//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":["../src/index.ts"],"sourcesContent":["export type StoreCallback<T> = (value: T) => void;\nexport type UnsubscribeCallback = () => void;\n\nexport interface Store<T> {\n    (cb: StoreCallback<T>): UnsubscribeCallback;\n    (): T; // return bare object without Proxy, put into documentation not to change state through it\n}\n\nexport const createStoreFactory = (notifyAfterCreation: boolean) => {\n    return <T extends object>(object: T = {} as T): [T, Store<T>] => {\n        let willNotifyNextTick = false;\n        const proxiesCache = new WeakMap<T, T>();\n        const storeListeners = new Set<StoreCallback<T>>();\n        const enqueueNotification = () => {\n            if (!willNotifyNextTick) {\n                willNotifyNextTick = true;\n                queueMicrotask(() => {\n                    willNotifyNextTick = false;\n                    for (const listener of storeListeners) {\n                        listener(object);\n                    }\n                });\n            }\n        };\n        const handler = {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            set(target: T, p: string | symbol, value: any, receiver: any) {\n                if (Reflect.get(target, p, receiver) !== value) {\n                    Reflect.set(target, p, value, receiver);\n                    enqueueNotification();\n                }\n                return true;\n            },\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            get(target: T, p: string | symbol, receiver: any) {\n                const value = Reflect.get(target, p, receiver);\n                return value !== null && typeof value === 'object' && !(value instanceof RegExp) ? createProxy(value) : value;\n            },\n            defineProperty(...args: [T, string | symbol, PropertyDescriptor]) {\n                enqueueNotification();\n                return Reflect.defineProperty(...args);\n            },\n            deleteProperty(target: T, p: string | symbol) {\n                const result = Reflect.deleteProperty(target, p);\n                if (result) {\n                    enqueueNotification();\n                }\n                return result;\n            }\n        };\n        const proxy = createProxy(object);\n        return [\n            proxy,\n            ((cb?: StoreCallback<T>): UnsubscribeCallback | T => {\n                if (!cb) {\n                    return object;\n                }\n                storeListeners.add(cb);\n                if (notifyAfterCreation) {\n                    cb(object);\n                }\n                return () => storeListeners.delete(cb);\n            }) as Store<T>\n        ];\n        function createProxy(object: T): T {\n            if (proxiesCache.has(object)) {\n                return proxiesCache.get(object) as T;\n            } else {\n                const proxy = new Proxy(object, handler);\n                proxiesCache.set(object, proxy);\n                return proxy;\n            }\n        }\n    };\n};"],"names":["notifyAfterCreation","object","willNotifyNextTick","proxiesCache","WeakMap","storeListeners","Set","enqueueNotification","queueMicrotask","listener","handler","set","target","p","value","receiver","Reflect","get","RegExp","createProxy","defineProperty","args","deleteProperty","result","cb","add","delete","has","proxy","Proxy"],"mappings":"yQAQmCA,GACxB,CAAmBC,EAAY,MAClC,IAAIC,GAAqB,EACzB,MAAMC,EAAe,IAAIC,QACnBC,EAAiB,IAAIC,IACrBC,EAAsB,KACnBL,IACDA,GAAqB,EACrBM,gBAAe,KACXN,GAAqB,EACrB,IAAK,MAAMO,KAAYJ,EACnBI,EAASR,QAKnBS,EAAU,CAEZC,IAAG,CAACC,EAAWC,EAAoBC,EAAYC,KACvCC,QAAQC,IAAIL,EAAQC,EAAGE,KAAcD,IACrCE,QAAQL,IAAIC,EAAQC,EAAGC,EAAOC,GAC9BR,MAEG,GAGXU,IAAIL,EAAWC,EAAoBE,GAC/B,MAAMD,EAAQE,QAAQC,IAAIL,EAAQC,EAAGE,GACrC,OAAiB,OAAVD,GAAmC,iBAAVA,GAAwBA,aAAiBI,OAA+BJ,EAArBK,EAAYL,IAEnGM,eAAc,IAAIC,KACdd,IACOS,QAAQI,kBAAkBC,IAErCC,eAAeV,EAAWC,GACtB,MAAMU,EAASP,QAAQM,eAAeV,EAAQC,GAI9C,OAHIU,GACAhB,IAEGgB,IAIf,MAAO,CADOJ,EAAYlB,GAGpBuB,GACOA,GAGLnB,EAAeoB,IAAID,GACfxB,GACAwB,EAAGvB,GAEA,IAAMI,EAAeqB,OAAOF,IANxBvB,GASnB,SAASkB,EAAYlB,GACjB,GAAIE,EAAawB,IAAI1B,GACjB,OAAOE,EAAac,IAAIhB,GACrB,CACH,MAAM2B,EAAQ,IAAIC,MAAM5B,EAAQS,GAEhC,OADAP,EAAaQ,IAAIV,EAAQ2B,GAClBA"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "version": "1.0.0",
+  "license": "MIT",
+  "name": "@slimlib/store",
+  "author": "Konstantin Shutkin",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
+  "unpkg": "./dist/index.umd.js",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=15"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kshutkin/slimlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kshutkin/slimlib/issues"
+  },
+  "homepage": "https://github.com/kshutkin/slimlib/store/README.md",
+  "scripts": {
+    "build": "pkgbld --umd=index",
+    "test": "jest --collectCoverage",
+    "lint": "eslint ./src",
+    "semantic-release": "npx semantic-release"
+  },
+  "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",
+    "@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",
+    "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",
+    "pkgbld": "1.1.9"
+  },
+  "dependencies": {},
+  "description": "Simple Proxy-based store for SPA"
+}