@cripty2001/utils - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

src/react-whispr.ts

+import { Whispr, type WhisprSetter } from "@cripty2001/whispr";
+import { useEffect, useRef, useState } from "react";
+
+import { isEqual } from "lodash";
+
+/**
+ * Convert a Whispr value into a reactive react value, usable in function components with the standard react reactive system.
+ * If the value is not a Whispr, it is returned as is, thus allowing for progressive migration and adoption
+ * @param w A reactive react value or a Whispr containing it
+ * @param computer An optional function to compute the returned value. This is useful to extract a part of a larger whispr, or to compute a derived value. It is the analog of useMemo with a single dependency (the whispr itself)
+ * @returns A reactive react value
+ * 
+ * @remarks The value is NOT REACTIVE, and the same applies to the computer, if any. Only changes to its content will trigger a change, not changes to the object itself.
+ * 
+ * @example
+ * export default function MyComponent(props: { value:  Whispr<string> }) {
+ *   const value = useWhisprValue(props.value);
+ * 
+ *   return <div>{value}</div>;
+ * }
+ */
+export function useWhisprValue<I, O = I>(
+    w: Whispr<I>,
+    computer: (data: I) => O = (d) => d as unknown as O
+): O {
+    const value_w = useRef(
+        Whispr.from(
+            { w },
+            ({ w }) => computer(w)
+        )
+    ).current;
+
+    const [value, setValue] = useState(value_w.value);
+
+    value_w.subscribe((newValue) => {
+        if (isEqual(newValue, value))
+            return;
+
+        setValue(newValue);
+    }, false);  // Already got the initial value, and this will call syncronously generate a react warning as called on an not yet mounted component
+
+    return value;
+}
+
+/**
+ * Wrap a (react) value into a Whispr, if it is not one already.
+ * @param data A Whispr or a normal (react reactable) value
+ * @returns The whispr'd value, or the original whispr if it was one (allow for incremental adoption)
+ * 
+ * @remarks The returned whispr has already been ref-fed, so it can be directly used without worrying about react recreating it or similar bad things
+ */
+export function useWhispr<T>(data: T | Whispr<T>): Whispr<T> {
+    const [w, setW] = useRef(Whispr.create(
+        data instanceof Whispr ?
+            data.value :
+            data
+    )).current;
+
+    useEffect(() => {
+        setW(data instanceof Whispr ? data.value : data);
+    }, [data, setW]);
+
+    // Hooks can't be called conditionally, so we need to do this check at the end
+    if (data instanceof Whispr)
+        return data;
+
+    return w;
+}
+

package.json

 {
   "name": "@cripty2001/utils",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Internal Set of utils. If you need them use them, otherwise go to the next package ;)",
@@ -22,2 +22,4 @@ "homepage": "https://github.com/cripty2001/utils#readme",
   "devDependencies": {
+    "@types/react": "^19.2.0",
+    "react": "^18.0.0",
     "typescript": "^5.9.3"
@@ -30,2 +32,10 @@ },
   },
+  "peerDependencies": {
+    "react": "^18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
   "exports": {
@@ -39,4 +49,8 @@ ".": {
       "require": "./dist/Dispatcher.js"
+    },
+    "./react-whispr": {
+      "import": "./dist/react-whispr.js",
+      "require": "./dist/react-whispr.js"
     }
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

11957

31.89%

Number of package files

6

20%

Lines of code

272

27.1%

Worsened metrics

Dependency count

4

33.33%

Dev dependency count

3

200%

No dependency changes