ustor 0.0.8 → 0.1.0

package/README.md

@@ -23,6 +23,8 @@ This library provides a powerful reactivity system for creating stateful objects
   - [Deeply Nested Structures](#deeply-nested-structures)
   - [Arrays and Objects](#arrays-and-objects)
   - [Reactivity and Effects](#reactivity-and-effects)
+	- [`state.$prop`](#stateprop)
+
 - [Integration with Solid.js, Preact Signals or any](#integration-with-solidjs-preact-signals-or-any)
 
 ## Installation
@@ -188,9 +190,20 @@ s.a = 4;
 console.log(effectValue); // 8
 ```
 
+### `state.$prop`
+
+The `$` properties are automatically generated for each property in the store. These `$`-prefixed properties contain the underlying signal, providing direct access to the signal itself, separate from the reactive value it holds. The `$` properties are non-enumerable and are useful when you need to access or manipulate the signal directly, rather than the reactive value.
+
+For example, if you have a store with a count property:
+
+```js
+const s = store({ count: 0 });
+console.log(s.count); // 0
+console.log(s.$count); // The underlying signal object
+```
 ## Integration with Solid.js, Preact Signals or any
 
-This library can be used with Solid.js, Preact Signals, React, or any other UI framework to provide reactive signals.
+This library can be used with Solid.js, Preact Signals, or any other UI framework to provide reactive signals.
 
 To use Solid.js:
 
@@ -233,7 +246,7 @@ const state = store({
 });
 ```
 
-The library provides a unified API to work with different reactive systems, allowing you to switch between Solid.js, Preact Signals, React, or any other UI framework easily.
+The library provides a unified API to work with different reactive systems, allowing you to switch between Solid.js, Preact Signals, or any other UI framework easily.
 
 ### License
 

package/dist/index.es.js

@@ -1,28 +1,34 @@
-let api = {},
-    _s = Symbol("s"),
-    is = (v) => v[_s],
-    isObject = (v) => v && v.constructor === Object,
-    resolve = (v) => Array.isArray(v) ? store(v) : isObject(v) ? Object.seal(store(v)) : v,
-    store = (values, proto) => {
-        if ((is(values) && !proto) || !(api.signal && api.get && api.set && api.is)) return values;
-        if (Array.isArray(values)) values.forEach((item, i) => values[i] = is(item) ? item : store(item));
-        if (isObject(values)) {
-            let state = Object.create(proto || Object.getPrototypeOf(values));
-            Object.entries(Object.getOwnPropertyDescriptors(values)).forEach(
-                ([key, desc]) => {
-                    let signal = api.is(desc.value) ? desc.value : api.signal(resolve(desc.value)),
-                        memo = desc.get ? (api.memo ? api.memo(desc.get.bind(state)) : desc.get.bind(state)()) : signal;
-                    Object.defineProperty(state, key, {
-                        get: () => desc.get ? memo : api.get(memo),
-                        set: desc.get ? desc.set?.bind(state) : v => api.set(signal, resolve(v)),
-                        enumerable: true,
+const api = {};
+const _s = Symbol();
+const is = (v) => v[_s];
+const isObject = (v) => v && v.constructor === Object;
+const resolve = (v) => Array.isArray(v) ? store(v) : isObject(v) ? Object.seal(store(v)) : v;
+const store = (values, proto) => {
+    if ((is(values) && !proto) || !(api.signal && api.get && api.set && api.is)) return values;
+    if (Array.isArray(values)) values.forEach((item, i) => values[i] = is(item) ? item : store(item));
+    if (isObject(values)) {
+        let state = Object.create(proto || Object.getPrototypeOf(values));
+        Object.entries(Object.getOwnPropertyDescriptors(values)).forEach(
+            ([key, desc]) => {
+                let signal = api.is(desc.value) ? desc.value : api.signal(resolve(desc.value)),
+                    memo = desc.get ? (api.memo ? api.memo(desc.get.bind(state)) : desc.get.bind(state)()) : signal;
+                Object.defineProperty(state, key, {
+                    get: () => (desc.get ? memo : api.get(signal)),
+                    set: desc.get ? desc.set?.bind(state) : v => api.set(signal, resolve(v)),
+                    enumerable: true,
+                });
+                if (!key.startsWith("$")) {
+                    Object.defineProperty(state, "$" + key, {
+                        get: () => signal,
+                        enumerable: false,
                     });
                 }
-            );
-            Object.defineProperty(state, _s, { value: true });
-            return state;
-        }
-        return values;
-    };
+            }
+        );
+        Object.defineProperty(state, _s, { value: true });
+        return state;
+    }
+    return values;
+};
 
 export { api, is, store };

package/dist/index.js

@@ -1,31 +1,37 @@
 'use strict';
 
-let api = {},
-    _s = Symbol("s"),
-    is = (v) => v[_s],
-    isObject = (v) => v && v.constructor === Object,
-    resolve = (v) => Array.isArray(v) ? store(v) : isObject(v) ? Object.seal(store(v)) : v,
-    store = (values, proto) => {
-        if ((is(values) && !proto) || !(api.signal && api.get && api.set && api.is)) return values;
-        if (Array.isArray(values)) values.forEach((item, i) => values[i] = is(item) ? item : store(item));
-        if (isObject(values)) {
-            let state = Object.create(proto || Object.getPrototypeOf(values));
-            Object.entries(Object.getOwnPropertyDescriptors(values)).forEach(
-                ([key, desc]) => {
-                    let signal = api.is(desc.value) ? desc.value : api.signal(resolve(desc.value)),
-                        memo = desc.get ? (api.memo ? api.memo(desc.get.bind(state)) : desc.get.bind(state)()) : signal;
-                    Object.defineProperty(state, key, {
-                        get: () => desc.get ? memo : api.get(memo),
-                        set: desc.get ? desc.set?.bind(state) : v => api.set(signal, resolve(v)),
-                        enumerable: true,
+const api = {};
+const _s = Symbol();
+const is = (v) => v[_s];
+const isObject = (v) => v && v.constructor === Object;
+const resolve = (v) => Array.isArray(v) ? store(v) : isObject(v) ? Object.seal(store(v)) : v;
+const store = (values, proto) => {
+    if ((is(values) && !proto) || !(api.signal && api.get && api.set && api.is)) return values;
+    if (Array.isArray(values)) values.forEach((item, i) => values[i] = is(item) ? item : store(item));
+    if (isObject(values)) {
+        let state = Object.create(proto || Object.getPrototypeOf(values));
+        Object.entries(Object.getOwnPropertyDescriptors(values)).forEach(
+            ([key, desc]) => {
+                let signal = api.is(desc.value) ? desc.value : api.signal(resolve(desc.value)),
+                    memo = desc.get ? (api.memo ? api.memo(desc.get.bind(state)) : desc.get.bind(state)()) : signal;
+                Object.defineProperty(state, key, {
+                    get: () => (desc.get ? memo : api.get(signal)),
+                    set: desc.get ? desc.set?.bind(state) : v => api.set(signal, resolve(v)),
+                    enumerable: true,
+                });
+                if (!key.startsWith("$")) {
+                    Object.defineProperty(state, "$" + key, {
+                        get: () => signal,
+                        enumerable: false,
                     });
                 }
-            );
-            Object.defineProperty(state, _s, { value: true });
-            return state;
-        }
-        return values;
-    };
+            }
+        );
+        Object.defineProperty(state, _s, { value: true });
+        return state;
+    }
+    return values;
+};
 
 exports.api = api;
 exports.is = is;

package/dist/index.min.js

@@ -1 +1 @@
-var ustor=function(e){let t={},r=Symbol("s"),s=e=>e[r],i=e=>e&&e.constructor===Object,a=e=>Array.isArray(e)?n(e):i(e)?Object.seal(n(e)):e,n=(e,o)=>{if(s(e)&&!o||!(t.signal&&t.get&&t.set&&t.is))return e;if(Array.isArray(e)&&e.forEach(((t,r)=>e[r]=s(t)?t:n(t))),i(e)){let s=Object.create(o||Object.getPrototypeOf(e));return Object.entries(Object.getOwnPropertyDescriptors(e)).forEach((([e,r])=>{let i=t.is(r.value)?r.value:t.signal(a(r.value)),n=r.get?t.memo?t.memo(r.get.bind(s)):r.get.bind(s)():i;Object.defineProperty(s,e,{get:()=>r.get?n:t.get(n),set:r.get?r.set?.bind(s):e=>t.set(i,a(e)),enumerable:!0})})),Object.defineProperty(s,r,{value:!0}),s}return e};return e.api=t,e.is=s,e.store=n,e}({});
+var ustor=function(e){const t={},r=Symbol(),s=e=>e[r],i=e=>e&&e.constructor===Object,n=e=>Array.isArray(e)?a(e):i(e)?Object.seal(a(e)):e,a=(e,o)=>{if(s(e)&&!o||!(t.signal&&t.get&&t.set&&t.is))return e;if(Array.isArray(e)&&e.forEach(((t,r)=>e[r]=s(t)?t:a(t))),i(e)){let s=Object.create(o||Object.getPrototypeOf(e));return Object.entries(Object.getOwnPropertyDescriptors(e)).forEach((([e,r])=>{let i=t.is(r.value)?r.value:t.signal(n(r.value)),a=r.get?t.memo?t.memo(r.get.bind(s)):r.get.bind(s)():i;Object.defineProperty(s,e,{get:()=>r.get?a:t.get(i),set:r.get?r.set?.bind(s):e=>t.set(i,n(e)),enumerable:!0}),e.startsWith("$")||Object.defineProperty(s,"$"+e,{get:()=>i,enumerable:!1})})),Object.defineProperty(s,r,{value:!0}),s}return e};return e.api=t,e.is=s,e.store=a,e}({});

package/dist/index.umd.js

@@ -1 +1 @@
-!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).ustor={})}(this,(function(e){let t={},r=Symbol("s"),o=e=>e[r],i=e=>e&&e.constructor===Object,n=e=>Array.isArray(e)?s(e):i(e)?Object.seal(s(e)):e,s=(e,f)=>{if(o(e)&&!f||!(t.signal&&t.get&&t.set&&t.is))return e;if(Array.isArray(e)&&e.forEach(((t,r)=>e[r]=o(t)?t:s(t))),i(e)){let o=Object.create(f||Object.getPrototypeOf(e));return Object.entries(Object.getOwnPropertyDescriptors(e)).forEach((([e,r])=>{let i=t.is(r.value)?r.value:t.signal(n(r.value)),s=r.get?t.memo?t.memo(r.get.bind(o)):r.get.bind(o)():i;Object.defineProperty(o,e,{get:()=>r.get?s:t.get(s),set:r.get?r.set?.bind(o):e=>t.set(i,n(e)),enumerable:!0})})),Object.defineProperty(o,r,{value:!0}),o}return e};e.api=t,e.is=o,e.store=s}));
+!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).ustor={})}(this,(function(e){const t={},r=Symbol(),o=e=>e[r],i=e=>e&&e.constructor===Object,n=e=>Array.isArray(e)?s(e):i(e)?Object.seal(s(e)):e,s=(e,a)=>{if(o(e)&&!a||!(t.signal&&t.get&&t.set&&t.is))return e;if(Array.isArray(e)&&e.forEach(((t,r)=>e[r]=o(t)?t:s(t))),i(e)){let o=Object.create(a||Object.getPrototypeOf(e));return Object.entries(Object.getOwnPropertyDescriptors(e)).forEach((([e,r])=>{let i=t.is(r.value)?r.value:t.signal(n(r.value)),s=r.get?t.memo?t.memo(r.get.bind(o)):r.get.bind(o)():i;Object.defineProperty(o,e,{get:()=>r.get?s:t.get(i),set:r.get?r.set?.bind(o):e=>t.set(i,n(e)),enumerable:!0}),e.startsWith("$")||Object.defineProperty(o,"$"+e,{get:()=>i,enumerable:!1})})),Object.defineProperty(o,r,{value:!0}),o}return e};e.api=t,e.is=o,e.store=s}));

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "ustor",
 	"description": "A lightweight reactive store library that provides a powerful reactivity system for managing state, compatible with any UI framework, including Solid.js, and Preact Signals.",
-	"version": "0.0.8",
+	"version": "0.1.0",
 	"type": "module",
 	"source": "./src/index.js",
 	"main": "./dist/index.js",