@rplx/react 0.2.0

package/README.md

@@ -0,0 +1,74 @@
+# @rplx/react
+
+React bindings for Ripple state management library.
+
+## Installation
+
+```bash
+npm install @rplx/core @rplx/react
+```
+
+## Usage
+
+```tsx
+import { createStore } from '@rplx/core'
+import { StoreProvider, useStoreState, useDispatch } from '@rplx/react'
+
+// Create your store
+const store = createStore({
+  initialState: { count: 0 }
+})
+
+// Wrap your app with StoreProvider
+function App() {
+  return (
+    <StoreProvider store={store}>
+      <Counter />
+    </StoreProvider>
+  )
+}
+
+// Use hooks in components
+function Counter() {
+  const state = useStoreState()
+  const dispatch = useDispatch()
+  
+  return (
+    <div>
+      <p>Count: {state.count}</p>
+      <button onClick={() => dispatch('increment')}>
+        Increment
+      </button>
+    </div>
+  )
+}
+```
+
+## API
+
+### `StoreProvider`
+
+Provider component that makes the store available to all child components.
+
+**Props:**
+- `store: StoreAPI<State>` - The store instance (created with `createStore()`)
+- `children: ReactNode` - Child components
+
+### `useStoreState<State>()`
+
+Hook that subscribes to store state changes and returns the current state. Component will re-render when state changes.
+
+**Returns:** `State` - The current store state
+
+### `useDispatch<Payload>()`
+
+Hook that returns a memoized dispatch function for dispatching events.
+
+**Returns:** `(eventKey: string, payload?: Payload) => Promise<void>`
+
+### `useStore<State>()`
+
+Hook that returns the store instance directly.
+
+**Returns:** `StoreAPI<State>` - The store instance (created with `createStore()`)
+

package/dist/index.d.mts

@@ -0,0 +1,71 @@
+import React, { ReactNode } from 'react';
+import { StoreAPI } from '@rplx/core';
+
+interface StoreProviderProps<State> {
+    store: StoreAPI<State>;
+    children: ReactNode;
+}
+declare function StoreProvider<State>({ store, children }: StoreProviderProps<State>): React.JSX.Element;
+declare function useStore<State>(): StoreAPI<State>;
+
+/**
+ * Hook to subscribe to store state changes and trigger re-renders
+ * Returns the current state and re-renders when state changes
+ */
+declare function useStoreState<State>(): State;
+
+/**
+ * Hook to get a dispatch function for the store
+ * Returns a memoized dispatch function
+ */
+declare function useDispatch<Payload = any>(): <P = Payload>(eventKey: string, payload?: P | undefined) => Promise<void>;
+
+/**
+ * Hook that leverages shared Subscription objects for optimal React memoization.
+ *
+ * The key insight: Subscription objects are shared (same instance for same key+params),
+ * so we can use the Subscription object itself as a stable reference in dependency arrays.
+ * This eliminates the need to memoize params arrays or use JSON.stringify.
+ *
+ * @example
+ * ```tsx
+ * function TodoItem({ id }: { id: string }) {
+ *   const todo = useSubscription('todoById', id)
+ *   return <div>{todo.title}</div>
+ * }
+ *
+ * function TodoList() {
+ *   const todos = useSubscription('todos')
+ *   return <div>{todos.map(...)}</div>
+ * }
+ * ```
+ */
+declare function useSubscription<Result, Params extends any[] = []>(subscriptionKey: string, ...params: Params): Result;
+/**
+ * Factory function that creates a reusable hook for a specific subscription key.
+ *
+ * This is useful when you want to create a typed hook for a specific subscription,
+ * making it easier to use in components without passing the key each time.
+ * The store is automatically obtained from context, so no store parameter is needed.
+ *
+ * @example
+ * ```tsx
+ * // Create the hook once (outside component) - no store needed!
+ * const useTodos = createSubscriptionHook('todos')
+ * const useTodoById = createSubscriptionHook('todoById')
+ *
+ * // Use in components
+ * function TodoList() {
+ *   const todos = useTodos() // No params needed
+ *   return <div>{todos.map(...)}</div>
+ * }
+ *
+ * function TodoItem({ id }: { id: string }) {
+ *   const todo = useTodoById(id) // Just params
+ *   return <div>{todo.title}</div>
+ * }
+ * ```
+ */
+declare function createSubscriptionHook<Result, Params extends any[] = []>(subscriptionKey: string): (...params: Params) => Result;
+
+export { StoreProvider, createSubscriptionHook, useDispatch, useStore, useStoreState, useSubscription };

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+import React, { ReactNode } from 'react';
+import { StoreAPI } from '@rplx/core';
+
+interface StoreProviderProps<State> {
+    store: StoreAPI<State>;
+    children: ReactNode;
+}
+declare function StoreProvider<State>({ store, children }: StoreProviderProps<State>): React.JSX.Element;
+declare function useStore<State>(): StoreAPI<State>;
+
+/**
+ * Hook to subscribe to store state changes and trigger re-renders
+ * Returns the current state and re-renders when state changes
+ */
+declare function useStoreState<State>(): State;
+
+/**
+ * Hook to get a dispatch function for the store
+ * Returns a memoized dispatch function
+ */
+declare function useDispatch<Payload = any>(): <P = Payload>(eventKey: string, payload?: P | undefined) => Promise<void>;
+
+/**
+ * Hook that leverages shared Subscription objects for optimal React memoization.
+ *
+ * The key insight: Subscription objects are shared (same instance for same key+params),
+ * so we can use the Subscription object itself as a stable reference in dependency arrays.
+ * This eliminates the need to memoize params arrays or use JSON.stringify.
+ *
+ * @example
+ * ```tsx
+ * function TodoItem({ id }: { id: string }) {
+ *   const todo = useSubscription('todoById', id)
+ *   return <div>{todo.title}</div>
+ * }
+ *
+ * function TodoList() {
+ *   const todos = useSubscription('todos')
+ *   return <div>{todos.map(...)}</div>
+ * }
+ * ```
+ */
+declare function useSubscription<Result, Params extends any[] = []>(subscriptionKey: string, ...params: Params): Result;
+/**
+ * Factory function that creates a reusable hook for a specific subscription key.
+ *
+ * This is useful when you want to create a typed hook for a specific subscription,
+ * making it easier to use in components without passing the key each time.
+ * The store is automatically obtained from context, so no store parameter is needed.
+ *
+ * @example
+ * ```tsx
+ * // Create the hook once (outside component) - no store needed!
+ * const useTodos = createSubscriptionHook('todos')
+ * const useTodoById = createSubscriptionHook('todoById')
+ *
+ * // Use in components
+ * function TodoList() {
+ *   const todos = useTodos() // No params needed
+ *   return <div>{todos.map(...)}</div>
+ * }
+ *
+ * function TodoItem({ id }: { id: string }) {
+ *   const todo = useTodoById(id) // Just params
+ *   return <div>{todo.title}</div>
+ * }
+ * ```
+ */
+declare function createSubscriptionHook<Result, Params extends any[] = []>(subscriptionKey: string): (...params: Params) => Result;
+
+export { StoreProvider, createSubscriptionHook, useDispatch, useStore, useStoreState, useSubscription };

package/dist/index.js

@@ -0,0 +1,196 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  StoreProvider: () => StoreProvider,
+  createSubscriptionHook: () => createSubscriptionHook,
+  useDispatch: () => useDispatch,
+  useStore: () => useStore,
+  useStoreState: () => useStoreState,
+  useSubscription: () => useSubscription
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/StoreContext.tsx
+var import_react = __toESM(require("react"));
+var StoreContext = (0, import_react.createContext)(null);
+function StoreProvider({ store, children }) {
+  const subscribersRef = (0, import_react.useRef)(/* @__PURE__ */ new Set());
+  const storeRef = (0, import_react.useRef)(store);
+  (0, import_react.useEffect)(() => {
+    storeRef.current = store;
+    const subscriptionKey = "__ripple_react_state_tracker__";
+    try {
+      store.registerSubscription(subscriptionKey, {
+        compute: (state) => state
+      });
+    } catch (error) {
+    }
+    const unsubscribe = store.subscribe(
+      subscriptionKey,
+      [],
+      (newState) => {
+        subscribersRef.current.forEach((callback) => {
+          try {
+            callback(newState);
+          } catch (error) {
+            console.error("Error in store subscriber:", error);
+          }
+        });
+      }
+    );
+    return () => {
+      unsubscribe();
+    };
+  }, [store]);
+  const subscribe = import_react.default.useCallback((callback) => {
+    subscribersRef.current.add(callback);
+    return () => {
+      subscribersRef.current.delete(callback);
+    };
+  }, []);
+  return /* @__PURE__ */ import_react.default.createElement(StoreContext.Provider, { value: { store, subscribe } }, children);
+}
+function useStore() {
+  const context = (0, import_react.useContext)(StoreContext);
+  if (!context) {
+    throw new Error("useStore must be used within a StoreProvider");
+  }
+  return context.store;
+}
+
+// src/useStoreState.ts
+var import_react2 = require("react");
+function useStoreState() {
+  const context = (0, import_react2.useContext)(StoreContext);
+  if (!context) {
+    throw new Error("useStoreState must be used within a StoreProvider");
+  }
+  const { store, subscribe } = context;
+  const [state, setState] = (0, import_react2.useState)(() => store.getState());
+  (0, import_react2.useEffect)(() => {
+    const unsubscribe = subscribe((newState) => {
+      setState((prevState) => {
+        if (prevState !== newState) {
+          return newState;
+        }
+        return prevState;
+      });
+    });
+    const currentState = store.getState();
+    setState(currentState);
+    return unsubscribe;
+  }, [store, subscribe]);
+  return state;
+}
+
+// src/useDispatch.ts
+var import_react3 = require("react");
+function useDispatch() {
+  const store = useStore();
+  const dispatch = (0, import_react3.useCallback)(
+    (eventKey, payload) => {
+      return store.dispatch(eventKey, payload);
+    },
+    [store]
+  );
+  return dispatch;
+}
+
+// src/useSubscription.ts
+var import_react4 = require("react");
+function useSubscription(subscriptionKey, ...params) {
+  const store = useStore();
+  const subscription = (0, import_react4.useMemo)(
+    () => store.getSubscription(subscriptionKey, params),
+    [store, subscriptionKey, ...params]
+    // Spread params - React will handle equality
+  );
+  const getSnapshot = (0, import_react4.useCallback)(
+    () => store.query(subscription.key, subscription.params),
+    [store, subscription]
+    // Subscription object is stable, so this is stable too
+  );
+  const subscribe = (0, import_react4.useCallback)(
+    (onStoreChange) => {
+      return store.subscribe(
+        subscription.key,
+        subscription.params,
+        () => {
+          onStoreChange();
+        }
+      );
+    },
+    [store, subscription]
+    // Subscription object is stable, so this is stable too
+  );
+  return (0, import_react4.useSyncExternalStore)(
+    subscribe,
+    getSnapshot,
+    getSnapshot
+    // Server snapshot (same as client for now)
+  );
+}
+function createSubscriptionHook(subscriptionKey) {
+  return function useSubscriptionHook(...params) {
+    const store = useStore();
+    const subscription = (0, import_react4.useMemo)(
+      () => store.getSubscription(subscriptionKey, params),
+      [store, subscriptionKey, ...params]
+    );
+    const getSnapshot = (0, import_react4.useCallback)(
+      () => store.query(subscription.key, subscription.params),
+      [store, subscription]
+    );
+    const subscribe = (0, import_react4.useCallback)(
+      (onStoreChange) => {
+        return store.subscribe(
+          subscription.key,
+          subscription.params,
+          () => {
+            onStoreChange();
+          }
+        );
+      },
+      [store, subscription]
+    );
+    return (0, import_react4.useSyncExternalStore)(subscribe, getSnapshot, getSnapshot);
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  StoreProvider,
+  createSubscriptionHook,
+  useDispatch,
+  useStore,
+  useStoreState,
+  useSubscription
+});

package/dist/index.mjs

@@ -0,0 +1,154 @@
+// src/StoreContext.tsx
+import React, { createContext, useContext, useRef, useEffect } from "react";
+var StoreContext = createContext(null);
+function StoreProvider({ store, children }) {
+  const subscribersRef = useRef(/* @__PURE__ */ new Set());
+  const storeRef = useRef(store);
+  useEffect(() => {
+    storeRef.current = store;
+    const subscriptionKey = "__ripple_react_state_tracker__";
+    try {
+      store.registerSubscription(subscriptionKey, {
+        compute: (state) => state
+      });
+    } catch (error) {
+    }
+    const unsubscribe = store.subscribe(
+      subscriptionKey,
+      [],
+      (newState) => {
+        subscribersRef.current.forEach((callback) => {
+          try {
+            callback(newState);
+          } catch (error) {
+            console.error("Error in store subscriber:", error);
+          }
+        });
+      }
+    );
+    return () => {
+      unsubscribe();
+    };
+  }, [store]);
+  const subscribe = React.useCallback((callback) => {
+    subscribersRef.current.add(callback);
+    return () => {
+      subscribersRef.current.delete(callback);
+    };
+  }, []);
+  return /* @__PURE__ */ React.createElement(StoreContext.Provider, { value: { store, subscribe } }, children);
+}
+function useStore() {
+  const context = useContext(StoreContext);
+  if (!context) {
+    throw new Error("useStore must be used within a StoreProvider");
+  }
+  return context.store;
+}
+
+// src/useStoreState.ts
+import { useState, useEffect as useEffect2, useContext as useContext2 } from "react";
+function useStoreState() {
+  const context = useContext2(StoreContext);
+  if (!context) {
+    throw new Error("useStoreState must be used within a StoreProvider");
+  }
+  const { store, subscribe } = context;
+  const [state, setState] = useState(() => store.getState());
+  useEffect2(() => {
+    const unsubscribe = subscribe((newState) => {
+      setState((prevState) => {
+        if (prevState !== newState) {
+          return newState;
+        }
+        return prevState;
+      });
+    });
+    const currentState = store.getState();
+    setState(currentState);
+    return unsubscribe;
+  }, [store, subscribe]);
+  return state;
+}
+
+// src/useDispatch.ts
+import { useCallback } from "react";
+function useDispatch() {
+  const store = useStore();
+  const dispatch = useCallback(
+    (eventKey, payload) => {
+      return store.dispatch(eventKey, payload);
+    },
+    [store]
+  );
+  return dispatch;
+}
+
+// src/useSubscription.ts
+import { useSyncExternalStore, useMemo, useCallback as useCallback2 } from "react";
+function useSubscription(subscriptionKey, ...params) {
+  const store = useStore();
+  const subscription = useMemo(
+    () => store.getSubscription(subscriptionKey, params),
+    [store, subscriptionKey, ...params]
+    // Spread params - React will handle equality
+  );
+  const getSnapshot = useCallback2(
+    () => store.query(subscription.key, subscription.params),
+    [store, subscription]
+    // Subscription object is stable, so this is stable too
+  );
+  const subscribe = useCallback2(
+    (onStoreChange) => {
+      return store.subscribe(
+        subscription.key,
+        subscription.params,
+        () => {
+          onStoreChange();
+        }
+      );
+    },
+    [store, subscription]
+    // Subscription object is stable, so this is stable too
+  );
+  return useSyncExternalStore(
+    subscribe,
+    getSnapshot,
+    getSnapshot
+    // Server snapshot (same as client for now)
+  );
+}
+function createSubscriptionHook(subscriptionKey) {
+  return function useSubscriptionHook(...params) {
+    const store = useStore();
+    const subscription = useMemo(
+      () => store.getSubscription(subscriptionKey, params),
+      [store, subscriptionKey, ...params]
+    );
+    const getSnapshot = useCallback2(
+      () => store.query(subscription.key, subscription.params),
+      [store, subscription]
+    );
+    const subscribe = useCallback2(
+      (onStoreChange) => {
+        return store.subscribe(
+          subscription.key,
+          subscription.params,
+          () => {
+            onStoreChange();
+          }
+        );
+      },
+      [store, subscription]
+    );
+    return useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
+  };
+}
+export {
+  StoreProvider,
+  createSubscriptionHook,
+  useDispatch,
+  useStore,
+  useStoreState,
+  useSubscription
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@rplx/react",
+  "version": "0.2.0",
+  "description": "React bindings for Ripple state management",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "clean": "rm -rf dist"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0"
+  },
+  "dependencies": {
+    "@rplx/core": "^0.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.43",
+    "react": "^18.2.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.2.2"
+  },
+  "keywords": [
+    "state-management",
+    "react",
+    "re-frame",
+    "ripple"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anonymeye/ripple.git",
+    "directory": "packages/ripple-react"
+  },
+  "bugs": {
+    "url": "https://github.com/anonymeye/ripple/issues"
+  },
+  "homepage": "https://github.com/anonymeye/ripple#readme",
+  "publishConfig": {
+    "access": "public"
+  }
+}