@iadev93/zuno-react 0.0.6 → 0.0.7

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Ibrahim Aftab
+
+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/dist/index.d.ts

@@ -1,4 +1,70 @@
-export { createZunoReact } from "./createZunoReact";
-export { bindReact } from "./bindReact";
+import { type ZunoSubscribableStore, type CreateZunoOptions } from "@iadev93/zuno";
+/**
+ * Type definition for an equality function.
+ * It takes two values of the same type and returns true if they are considered equal, false otherwise.
+ * Used to prevent unnecessary re-renders in React hooks when the selected state hasn't "meaningfully" changed.
+ */
+export type EqualityFn<T> = (a: T, b: T) => boolean;
+/**
+ * Type definition for a selector function.
+ * It takes the full state of a store and returns a selected portion of that state.
+ * This allows components to subscribe only to the parts of the state they care about,
+ * optimizing performance by avoiding re-renders for unrelated state changes.
+ */
+export type Selector<TState, TSelected> = (state: TState) => TSelected;
+/**
+ * An extended interface for a Zuno store that includes methods for setting state
+ * and a unique key identifier. This represents a store that has been "bound" or registered.
+ */
+export type BoundStore<T> = {
+    key: string;
+    get: () => T;
+    set: (next: T | ((prev: T) => T)) => Promise<any>;
+    subscribe: (cb: (state: T) => void) => () => void;
+    raw: () => ZunoSubscribableStore<T>;
+};
+/**
+ * The core interface for the Zuno library, providing methods to create,
+ * retrieve, and update stores.
+ */
+export type ZunoCore = {
+    store<T>(storeKey: string, init: () => T): BoundStore<T>;
+    set<T>(storeKey: string, next: T | ((prev: T) => T), init?: () => T): Promise<any>;
+    get<T>(storeKey: string, init?: () => T): T;
+    stop?: () => void;
+};
+/**
+ * An extended interface for a Zuno store that includes React-specific features.
+ */
+export type ReactBoundStore<T> = BoundStore<T> & {
+    /**
+     * React hook for this store.
+     * Optional selector + equality for derived values and avoiding rerenders.
+     */
+    use: <TSelected = T>(selector?: Selector<T, TSelected>, equalityFn?: EqualityFn<TSelected>) => TSelected;
+};
+/**
+ * Binds Zuno to React.
+ * @param zuno The Zuno instance to bind.
+ * @returns A React-enhanced Zuno instance.
+ */
+export declare const bindReact: (zuno: ZunoCore) => {
+    store: <T>(storeKey: string, init: () => T) => ReactBoundStore<T>;
+    set<T>(storeKey: string, next: T | ((prev: T) => T), init?: () => T): Promise<any>;
+    get<T>(storeKey: string, init?: () => T): T;
+    stop?: () => void;
+};
+/**
+ * Creates a Zuno instance and returns a React-enhanced instance.
+ *
+ * @param opts The options for the Zuno instance.
+ * @returns An object with a `store` method that returns stores with a `use` hook.
+ */
+export declare const createZunoReact: (opts: CreateZunoOptions) => {
+    store: <T>(storeKey: string, init: () => T) => ReactBoundStore<T>;
+    set<T>(storeKey: string, next: T | ((prev: T) => T), init?: () => T): Promise<any>;
+    get<T>(storeKey: string, init?: () => T): T;
+    stop?: () => void;
+};
 export type { ZunoReadable } from "@iadev93/zuno";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,KAAK,qBAAqB,EAA0B,KAAK,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE9H;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,MAAM,EAAE,SAAS,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,CAAC;AAQvE;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC,CAAC;IACb,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAC;IAClD,GAAG,EAAE,MAAM,qBAAqB,CAAC,CAAC,CAAC,CAAC;CACrC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IACzD,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnF,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5C,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG;IAC/C;;;OAGG;IACH,GAAG,EAAE,CAAC,SAAS,GAAG,CAAC,EACjB,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,EACjC,UAAU,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,KAC/B,SAAS,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,QAAQ;YAsDvB,CAAC,YAAa,MAAM,QAAQ,MAAM,CAAC,KAAG,eAAe,CAAC,CAAC,CAAC;QA9EnE,CAAC,YAAY,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;QAC9E,CAAC,YAAY,MAAM,SAAS,MAAM,CAAC,GAAG,CAAC;WACpC,MAAM,IAAI;CAkGlB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,MAAM,iBAAiB;YA9BtC,CAAC,YAAa,MAAM,QAAQ,MAAM,CAAC,KAAG,eAAe,CAAC,CAAC,CAAC;QA9EnE,CAAC,YAAY,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;QAC9E,CAAC,YAAY,MAAM,SAAS,MAAM,CAAC,GAAG,CAAC;WACpC,MAAM,IAAI;CA6GlB,CAAC;AAGF,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -1,2 +1,75 @@
-export { createZunoReact } from "./createZunoReact";
-export { bindReact } from "./bindReact";
+import * as React from "react";
+import { toReadable, createZuno } from "@iadev93/zuno";
+/**
+ * The default equality function, using `Object.is` for strict equality comparison.
+ * This is a common and safe default for comparing primitive values and references.
+ */
+const defaultEq = Object.is;
+/**
+ * Binds Zuno to React.
+ * @param zuno The Zuno instance to bind.
+ * @returns A React-enhanced Zuno instance.
+ */
+export const bindReact = (zuno) => {
+    /**
+     * A custom hook for accessing a Zuno store in a React component.
+     */
+    const useExternalStore = (readable, selector, equalityFn = defaultEq) => {
+        const select = React.useMemo(() => {
+            return (selector ??
+                ((s) => s));
+        }, [selector]);
+        const lastRef = React.useRef(null);
+        const hasLast = React.useRef(false);
+        const getSnapshot = React.useCallback(() => {
+            const next = select(readable.getSnapshot());
+            if (!hasLast.current) {
+                hasLast.current = true;
+                lastRef.current = next;
+                return next;
+            }
+            const prev = lastRef.current;
+            if (equalityFn(prev, next))
+                return prev;
+            lastRef.current = next;
+            return next;
+        }, [readable, select, equalityFn]);
+        const subscribe = React.useCallback((onChange) => readable.subscribe(onChange), [readable]);
+        const getServerSnapshot = React.useCallback(() => {
+            const s = readable.getServerSnapshot ? readable.getServerSnapshot() : readable.getSnapshot();
+            return select(s);
+        }, [readable, select]);
+        React.useEffect(() => {
+            hasLast.current = false;
+            lastRef.current = null;
+        }, [select, equalityFn]);
+        return React.useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot);
+    };
+    /**
+     * Creates a React-enhanced store.
+     */
+    const store = (storeKey, init) => {
+        const base = zuno.store(storeKey, init);
+        return {
+            ...base,
+            use: (selector, equalityFn = defaultEq) => {
+                const readable = React.useMemo(() => toReadable(base.raw()), [storeKey]);
+                return useExternalStore(readable, selector, equalityFn);
+            },
+        };
+    };
+    return {
+        ...zuno,
+        store,
+    };
+};
+/**
+ * Creates a Zuno instance and returns a React-enhanced instance.
+ *
+ * @param opts The options for the Zuno instance.
+ * @returns An object with a `store` method that returns stores with a `use` hook.
+ */
+export const createZunoReact = (opts) => {
+    const zuno = createZuno(opts);
+    return bindReact(zuno);
+};

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@iadev93/zuno-react",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "exports": {
     ".": {
@@ -13,19 +14,18 @@
       "default": "./dist/index.js"
     }
   },
-  "scripts": {
-    "build": "tsc -p tsconfig.json"
-  },
   "peerDependencies": {
-    "@iadev93/zuno": "workspace:*",
-    "react": ">=18"
+    "react": ">=18",
+    "@iadev93/zuno": "0.0.5"
   },
   "devDependencies": {
     "@types/react": "^18.0.0",
     "typescript": "^5.9.3",
-    "@iadev93/zuno": "workspace:*"
+    "@iadev93/zuno": "0.0.5"
   },
   "keywords": [
+    "zuno",
+    "react",
     "state",
     "state-management",
     "sync",
@@ -43,5 +43,8 @@
     "url": "git+https://github.com/IADev-Channel/zuno.git"
   },
   "author": "Ibrahim Aftab",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}