applesauce-react 0.9.0 → 0.11.0

package/README.md

@@ -1,15 +1,22 @@
 # applesauce-react
 
-React hooks for applesauce
+React hooks and providers for applesauce
+
+## Installation
+
+```bash
+npm install applesauce-react
+```
 
 ## Example
 
 ```jsx
 import { EventStore, QueryStore, Queries } from "applesauce-core";
-import { QueryStoreProvider, useStoreQuery } from "applesauce-react";
+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]);
@@ -19,7 +26,7 @@ function UserName({ pubkey }) {
 
 function App() {
   return (
-    <QueryStoreProvider store={store}>
+    <QueryStoreProvider queryStore={queryStore}>
       <h1>App</h1>
 
       <UserName pubkey="82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2" />

package/dist/hooks/index.d.ts

@@ -1,5 +1,10 @@
+export * from "./use-account-manager.js";
+export * from "./use-accounts.js";
+export * from "./use-active-account.js";
+export * from "./use-event-factory.js";
 export * from "./use-observable.js";
-export * from "./use-store-query.js";
-export * from "./use-render-nast.js";
 export * from "./use-query-store.js";
+export * from "./use-render-nast.js";
 export * from "./use-rendered-content.js";
+export * from "./use-store-query.js";
+export * from "./use-event-store.js";

package/dist/hooks/index.js

@@ -1,5 +1,10 @@
+export * from "./use-account-manager.js";
+export * from "./use-accounts.js";
+export * from "./use-active-account.js";
+export * from "./use-event-factory.js";
 export * from "./use-observable.js";
-export * from "./use-store-query.js";
-export * from "./use-render-nast.js";
 export * from "./use-query-store.js";
+export * from "./use-render-nast.js";
 export * from "./use-rendered-content.js";
+export * from "./use-store-query.js";
+export * from "./use-event-store.js";

package/dist/hooks/use-account-manager.d.ts

@@ -0,0 +1,4 @@
+import { AccountManager } from "applesauce-accounts";
+export declare function useAccountManager(): AccountManager;
+export declare function useAccountManager(require: false): AccountManager | undefined;
+export declare function useAccountManager(require: true): AccountManager;

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

@@ -0,0 +1,8 @@
+import { useContext } from "react";
+import { AccountsContext } from "../providers/accounts-provider.js";
+export function useAccountManager(require = true) {
+    const manager = useContext(AccountsContext);
+    if (!manager && require)
+        throw new Error("Missing AccountsProvider");
+    return manager;
+}

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

@@ -0,0 +1,2 @@
+import { IAccount } from "applesauce-accounts";
+export declare function useAccounts(): IAccount[];

package/dist/hooks/use-accounts.js

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

package/dist/hooks/use-active-account.d.ts

@@ -0,0 +1,2 @@
+import { IAccount } from "applesauce-accounts";
+export declare function useActiveAccount(): IAccount | undefined;

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

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

package/dist/hooks/use-event-factory.d.ts

@@ -0,0 +1,4 @@
+import { EventFactory } from "applesauce-factory";
+export declare function useEventFactory(require: false): EventFactory | undefined;
+export declare function useEventFactory(require: true): EventFactory;
+export declare function useEventFactory(): EventFactory;

package/dist/hooks/use-event-factory.js

@@ -0,0 +1,8 @@
+import { useContext } from "react";
+import { FactoryContext } from "../providers/factory-provider.js";
+export function useEventFactory(require = true) {
+    const factory = useContext(FactoryContext);
+    if (!require && !factory)
+        throw new Error("Missing EventFactoryProvider");
+    return factory;
+}

package/dist/hooks/use-event-store.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Gets the EventStore from a parent {@link EventStoreProvider} component
+ * If there is none it throws an error
+ */
+export declare function useEventStore(): import("applesauce-core").EventStore;

package/dist/hooks/use-event-store.js

@@ -0,0 +1,12 @@
+import { useContext } from "react";
+import { EventStoreContext } from "../providers/store-provider.js";
+/**
+ * Gets the EventStore from a parent {@link EventStoreProvider} component
+ * If there is none it throws an error
+ */
+export function useEventStore() {
+    const store = useContext(EventStoreContext);
+    if (!store)
+        throw new Error("Missing EventStoreProvider");
+    return store;
+}

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

@@ -1,6 +1,4 @@
 import { type BehaviorSubject, type Observable } from "rxjs";
-export declare function getCurrentValue<T extends unknown>(observable: BehaviorSubject<T>): T;
-export declare function getCurrentValue<T extends unknown>(observable: Observable<T>): T | undefined;
-/** 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/hooks/use-observable.js

@@ -1,17 +1,5 @@
-import { useState, useEffect } from "react";
-export function getCurrentValue(observable) {
-    if (Reflect.has(observable, "value"))
-        return Reflect.get(observable, "value");
-    return undefined;
-}
+import { useObservableState } from "observable-hooks";
+import { EMPTY } from "rxjs";
 export function useObservable(observable) {
-    const current = observable && getCurrentValue(observable);
-    const [value, setValue] = useState(current);
-    useEffect(() => {
-        // Reset the state, the method passed to subscribe will NOT always be called
-        setValue(observable && getCurrentValue(observable));
-        const sub = observable?.subscribe(setValue);
-        return () => sub?.unsubscribe();
-    }, [observable, setValue]);
-    return current || value;
+    return useObservableState(observable ?? EMPTY);
 }

package/dist/hooks/use-query-store.js

@@ -1,5 +1,5 @@
 import { useContext } from "react";
-import { QueryStoreContext } from "../provider.js";
+import { QueryStoreContext } from "../providers/store-provider.js";
 /**
  * Gets the QueryStore from a parent {@link QueryStoreProvider} component
  * If there is none it throws an error

package/dist/hooks/use-store-query.js

@@ -1,5 +1,6 @@
 import { useMemo } from "react";
-import { useObservable } from "./use-observable.js";
+import { of } from "rxjs";
+import { useObservableEagerState } from "observable-hooks";
 import { useQueryStore } from "./use-query-store.js";
 /**
  * Runs and subscribes to a query in the query store
@@ -10,9 +11,9 @@ export function useStoreQuery(queryConstructor, args) {
     const store = useQueryStore();
     const observable = useMemo(() => {
         if (args)
-            return store.runQuery(queryConstructor)(...args);
+            return store.createQuery(queryConstructor, ...args);
         else
-            return undefined;
+            return of(undefined);
     }, [args, store]);
-    return useObservable(observable);
+    return useObservableEagerState(observable);
 }

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./provider.js";
 export * as Helpers from "./helpers/index.js";
 export * as Hooks from "./hooks/index.js";
+export * from "./providers/index.js";

package/dist/index.js

@@ -1,3 +1,3 @@
-export * from "./provider.js";
 export * as Helpers from "./helpers/index.js";
 export * as Hooks from "./hooks/index.js";
+export * from "./providers/index.js";

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

@@ -0,0 +1,7 @@
+import { PropsWithChildren } from "react";
+import { AccountManager } from "applesauce-accounts";
+export declare const AccountsContext: import("react").Context<AccountManager<any> | undefined>;
+/** Provides an AccountManager to the component tree */
+export declare function AccountsProvider({ manager, children }: PropsWithChildren<{
+    manager?: AccountManager;
+}>): import("react/jsx-runtime").JSX.Element;

package/dist/providers/accounts-provider.js

@@ -0,0 +1,7 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext } from "react";
+export const AccountsContext = createContext(undefined);
+/** Provides an AccountManager to the component tree */
+export function AccountsProvider({ manager, children }) {
+    return _jsx(AccountsContext.Provider, { value: manager, children: children });
+}

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

@@ -0,0 +1,7 @@
+import { EventFactory } from "applesauce-factory";
+import { PropsWithChildren } from "react";
+export declare const FactoryContext: import("react").Context<EventFactory | undefined>;
+/** 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

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

package/dist/providers/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./factory-provider.js";
+export * from "./store-provider.js";
+export * from "./accounts-provider.js";

package/dist/providers/index.js

@@ -0,0 +1,3 @@
+export * from "./factory-provider.js";
+export * from "./store-provider.js";
+export * from "./accounts-provider.js";

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

@@ -0,0 +1,12 @@
+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 */
+export declare function EventStoreProvider({ eventStore, children }: PropsWithChildren<{
+    eventStore: EventStore;
+}>): import("react/jsx-runtime").JSX.Element;
+/** Provides a QueryStore and EventStore to the component tree */
+export declare function QueryStoreProvider({ queryStore, children }: PropsWithChildren<{
+    queryStore: QueryStore;
+}>): import("react/jsx-runtime").JSX.Element;

package/dist/providers/store-provider.js

@@ -0,0 +1,12 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext } from "react";
+export const QueryStoreContext = createContext(null);
+export const EventStoreContext = createContext(null);
+/** Provides a EventStore to the component tree */
+export function EventStoreProvider({ eventStore, children }) {
+    return _jsx(EventStoreContext.Provider, { value: eventStore, children: children });
+}
+/** Provides a QueryStore and EventStore to the component tree */
+export function QueryStoreProvider({ queryStore, children }) {
+    return (_jsx(EventStoreProvider, { eventStore: queryStore.store, children: _jsx(QueryStoreContext.Provider, { value: queryStore, children: children }) }));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-react",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "React hooks for applesauce",
   "type": "module",
   "main": "dist/index.js",
@@ -12,48 +12,55 @@
   "author": "hzrd149",
   "license": "MIT",
   "files": [
-    "dist"
+    "dist",
+    "applesauce"
   ],
   "exports": {
     ".": {
       "import": "./dist/index.js",
+      "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
     "./hooks": {
       "import": "./dist/hooks/index.js",
+      "require": "./dist/hooks/index.js",
       "types": "./dist/hooks/index.d.ts"
     },
     "./hooks/*": {
       "import": "./dist/hooks/*.js",
+      "require": "./dist/hooks/*.js",
       "types": "./dist/hooks/*.d.ts"
     },
+    "./providers": {
+      "import": "./dist/providers/index.js",
+      "require": "./dist/providers/index.js",
+      "types": "./dist/providers/index.d.ts"
+    },
+    "./providers/*": {
+      "import": "./dist/providers/*.js",
+      "require": "./dist/providers/*.js",
+      "types": "./dist/providers/*.d.ts"
+    },
     "./helpers": {
       "import": "./dist/helpers/index.js",
+      "require": "./dist/helpers/index.js",
       "types": "./dist/helpers/index.d.ts"
     }
   },
   "dependencies": {
-    "applesauce-content": "^0.9.0",
-    "applesauce-core": "^0.9.0",
-    "nostr-tools": "^2.10.1",
+    "applesauce-accounts": "^0.11.0",
+    "applesauce-content": "^0.11.0",
+    "applesauce-core": "^0.11.0",
+    "applesauce-factory": "^0.11.0",
+    "nostr-tools": "^2.10.4",
+    "observable-hooks": "^4.2.4",
     "react": "^18.3.1",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@types/jest": "^29.5.13",
-    "@types/react": "^18.3.11",
-    "jest": "^29.7.0",
-    "jest-extended": "^4.0.2",
-    "typescript": "^5.6.3"
-  },
-  "jest": {
-    "roots": [
-      "dist"
-    ],
-    "setupFilesAfterEnv": [
-      "jest-extended/all"
-    ]
+    "@types/react": "^18.3.18",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.5"
   },
   "funding": {
     "type": "lightning",
@@ -62,7 +69,7 @@
   "scripts": {
     "build": "tsc",
     "watch:build": "tsc --watch > /dev/null",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --passWithNoTests",
-    "watch:test": "(trap 'kill 0' SIGINT; pnpm run build -w > /dev/null & pnpm run test --watch)"
+    "test": "vitest run --passWithNoTests",
+    "watch:test": "vitest"
   }
 }

package/dist/provider.d.ts

@@ -1,7 +0,0 @@
-import { QueryStore } from "applesauce-core";
-import { PropsWithChildren } from "react";
-export declare const QueryStoreContext: import("react").Context<QueryStore | null>;
-/** Provides a QueryStore to the component tree */
-export declare function QueryStoreProvider({ store, children }: PropsWithChildren<{
-    store: QueryStore;
-}>): import("react/jsx-runtime").JSX.Element;

package/dist/provider.js

@@ -1,7 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import { createContext } from "react";
-export const QueryStoreContext = createContext(null);
-/** Provides a QueryStore to the component tree */
-export function QueryStoreProvider({ store, children }) {
-    return _jsx(QueryStoreContext.Provider, { value: store, children: children });
-}