applesauce-react 0.0.0-next-20250217154504 → 0.0.0-next-20250217174538

package/README.md

@@ -1,6 +1,12 @@
 # applesauce-react
 
-React hooks for applesauce
+React hooks and providers for applesauce
+
+## Installation
+
+```bash
+npm install applesauce-react
+```
 
 ## Example
 
@@ -9,8 +15,8 @@ import { EventStore, QueryStore, Queries } from "applesauce-core";
 import { QueryStoreProvider } from "applesauce-react/providers";
 import { useStoreQuery } from "applesauce-react/hooks";
 
-const events = new EventStore();
-const store = new QueryStore(events);
+const eventStore = new EventStore();
+const queryStore = new QueryStore(eventStore);
 
 function UserName({ pubkey }) {
   const profile = useStoreQuery(Queries.ProfileQuery, [pubkey]);
@@ -20,7 +26,7 @@ function UserName({ pubkey }) {
 
 function App() {
   return (
-    <QueryStoreProvider store={store}>
+    <QueryStoreProvider queryStore={queryStore}>
       <h1>App</h1>
 
       <UserName pubkey="82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2" />

package/dist/hooks/use-accounts.js

@@ -1,6 +1,6 @@
-import { useObservable } from "./use-observable.js";
+import { useObservableEagerState } from "observable-hooks";
 import { useAccountManager } from "./use-account-manager.js";
 export function useAccounts() {
     const manager = useAccountManager();
-    return useObservable(manager.accounts$);
+    return useObservableEagerState(manager.accounts$);
 }

package/dist/hooks/use-active-account.js

@@ -1,6 +1,6 @@
-import { useObservable } from "./use-observable.js";
+import { useObservableEagerState } from "observable-hooks";
 import { useAccountManager } from "./use-account-manager.js";
 export function useActiveAccount() {
     const manager = useAccountManager();
-    return useObservable(manager.active$);
+    return useObservableEagerState(manager.active$);
 }

package/dist/hooks/use-observable.d.ts

@@ -1,4 +1,4 @@
 import { type BehaviorSubject, type Observable } from "rxjs";
-/** Subscribe to the value of an observable */
+/** A thing wrapper around useObservableState that allows undefined */
 export declare function useObservable<T extends unknown>(observable?: BehaviorSubject<T>): T;
 export declare function useObservable<T extends unknown>(observable?: Observable<T>): T | undefined;

package/dist/providers/factory-provider.d.ts

@@ -1,7 +1,7 @@
 import { EventFactory } from "applesauce-factory";
 import { PropsWithChildren } from "react";
 export declare const FactoryContext: import("react").Context<EventFactory | undefined>;
-/** Provides an EventFactory to the component tree */
+/** Provides an {@link EventFactory} to the component tree */
 export declare function FactoryProvider({ factory, children }: PropsWithChildren<{
     factory?: EventFactory;
 }>): import("react/jsx-runtime").JSX.Element;

package/dist/providers/factory-provider.js

@@ -1,7 +1,7 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { createContext } from "react";
 export const FactoryContext = createContext(undefined);
-/** Provides an EventFactory to the component tree */
+/** Provides an {@link EventFactory} to the component tree */
 export function FactoryProvider({ factory, children }) {
     return _jsx(FactoryContext.Provider, { value: factory, children: children });
 }

package/dist/providers/store-provider.d.ts

@@ -1,5 +1,5 @@
-import { EventStore, QueryStore } from "applesauce-core";
 import { PropsWithChildren } from "react";
+import { EventStore, QueryStore } from "applesauce-core";
 export declare const QueryStoreContext: import("react").Context<QueryStore | null>;
 export declare const EventStoreContext: import("react").Context<EventStore | null>;
 /** Provides a EventStore to the component tree */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-react",
-  "version": "0.0.0-next-20250217154504",
+  "version": "0.0.0-next-20250217174538",
   "description": "React hooks for applesauce",
   "type": "module",
   "main": "dist/index.js",
@@ -48,10 +48,10 @@
     }
   },
   "dependencies": {
-    "applesauce-accounts": "0.0.0-next-20250217154504",
-    "applesauce-content": "0.0.0-next-20250217154504",
-    "applesauce-core": "0.0.0-next-20250217154504",
-    "applesauce-factory": "0.0.0-next-20250217154504",
+    "applesauce-accounts": "0.0.0-next-20250217174538",
+    "applesauce-content": "0.0.0-next-20250217174538",
+    "applesauce-core": "0.0.0-next-20250217174538",
+    "applesauce-factory": "0.0.0-next-20250217174538",
     "nostr-tools": "^2.10.4",
     "observable-hooks": "^4.2.4",
     "react": "^18.3.1",