applesauce-loaders 4.2.0 → 5.0.2

package/README.md

@@ -94,6 +94,51 @@ eventLoader({
 });
 ```
 
+## Unified Event Loader
+
+The Unified Event Loader is a single loader that can handle both `EventPointer` and `AddressPointer` types. It automatically routes to the appropriate loader (`createEventLoader` for events by ID, `createAddressLoader` for addressable/replaceable events) based on the pointer type.
+
+This is the recommended approach when setting up loaders for an EventStore, as it provides a single loader that works with the unified `eventLoader` property.
+
+```ts
+import { createUnifiedEventLoader, createEventLoaderForStore } from "applesauce-loaders/loaders";
+import { EventStore } from "applesauce-core";
+import { RelayPool } from "applesauce-relay";
+
+const eventStore = new EventStore();
+const pool = new RelayPool();
+
+// Option 1: Create and assign manually
+const unifiedLoader = createUnifiedEventLoader(pool, {
+  eventStore,
+  bufferTime: 1000,
+  followRelayHints: true,
+  extraRelays: ["wss://relay.example.com"],
+  lookupRelays: ["wss://purplepag.es", "wss://index.hzrd149.com"],
+});
+
+eventStore.eventLoader = unifiedLoader;
+
+// Option 2: Use the convenience function (recommended)
+createEventLoaderForStore(eventStore, pool, {
+  bufferTime: 1000,
+  followRelayHints: true,
+  extraRelays: ["wss://relay.example.com"],
+  lookupRelays: ["wss://purplepag.es", "wss://index.hzrd149.com"],
+});
+
+// Now the event store can load both events by ID and addressable events
+eventStore.event({ id: "event_id" }).subscribe((event) => {
+  console.log("Loaded event:", event);
+});
+
+eventStore.replaceable({ kind: 0, pubkey: "pubkey" }).subscribe((profile) => {
+  console.log("Loaded profile:", profile);
+});
+```
+
+The unified loader accepts all options from both `EventPointerLoaderOptions` and `AddressLoaderOptions`, making it easy to configure both types of loading in one place.
+
 ## Timeline Loader
 
 The Timeline Loader is designed for fetching paginated Nostr events in chronological order. It maintains state between calls, allowing you to efficiently load timeline events in blocks until you reach a specific timestamp or exhaust available events.
@@ -181,6 +226,12 @@ All loaders accept these common configuration options:
 - `followRelayHints`: Whether to follow relay hints (default true)
 - `extraRelays`: An array of relays to always fetch from
 
+### Unified Event Loader Options
+
+The unified event loader accepts all options from both Event Loader and Address Loader options, plus:
+
+- `lookupRelays`: Fallback lookup relays to check when event can't be found (from Address Loader)
+
 ### Timeline Loader Options
 
 - `limit`: Maximum number of events to request per filter

package/dist/helpers/address-pointer.d.ts

@@ -1,6 +1,5 @@
-import { AddressPointerWithoutD } from "applesauce-core/helpers";
-import { Filter } from "nostr-tools";
-import { AddressPointer } from "nostr-tools/nip19";
+import { Filter } from "applesauce-core/helpers/filter";
+import { AddressPointer, AddressPointerWithoutD } from "applesauce-core/helpers/pointers";
 /** Converts an array of address pointers to a filter */
 export declare function createFilterFromAddressPointers(pointers: AddressPointerWithoutD[] | AddressPointer[]): Filter;
 /** Takes a set of address pointers, groups them, then returns filters for the groups */

package/dist/helpers/address-pointer.js

@@ -1,11 +1,11 @@
-import { isAddressableKind, isReplaceableKind } from "nostr-tools/kinds";
+import { isAddressableKind, isReplaceableKind } from "applesauce-core/helpers/event";
 import { unique } from "./array.js";
 /** Converts an array of address pointers to a filter */
 export function createFilterFromAddressPointers(pointers) {
     const filter = {};
     filter.kinds = unique(pointers.map((p) => p.kind));
     filter.authors = unique(pointers.map((p) => p.pubkey));
-    const identifiers = unique(pointers.map((p) => p.identifier).filter((d) => !!d));
+    const identifiers = unique(pointers.map((p) => p.identifier).filter((d) => d !== undefined));
     if (identifiers.length > 0)
         filter["#d"] = identifiers;
     return filter;
@@ -29,7 +29,7 @@ export function createFiltersFromAddressPointers(pointers) {
 /** Checks if a relay will understand an address pointer */
 export function isLoadableAddressPointer(pointer) {
     if (isAddressableKind(pointer.kind))
-        return !!pointer.identifier;
+        return pointer.identifier !== undefined;
     else
         return isReplaceableKind(pointer.kind);
 }

package/dist/helpers/cache.d.ts

@@ -1,4 +1,5 @@
-import { Filter, NostrEvent } from "nostr-tools";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { Filter } from "applesauce-core/helpers/filter";
 import { Observable } from "rxjs";
 import { CacheRequest } from "../types.js";
 /** Calls the cache request and converts the reponse into an observable */

package/dist/helpers/cache.js

@@ -1,4 +1,4 @@
-import { markFromCache } from "applesauce-core/helpers";
+import { markFromCache } from "applesauce-core/helpers/event";
 import { from, isObservable, of, switchMap, tap } from "rxjs";
 /** Calls the cache request and converts the reponse into an observable */
 export function unwrapCacheRequest(request, filters) {

package/dist/helpers/upstream.d.ts

@@ -1,6 +1,7 @@
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { Filter } from "applesauce-core/helpers/filter";
 import { Observable } from "rxjs";
 import { NostrRequest, UpstreamPool } from "../types.js";
-import { Filter, NostrEvent } from "nostr-tools";
 /** Makes a nostr request on the upstream pool */
 export declare function makeUpstreamRequest(pool: UpstreamPool, relays: string[], filters: Filter[]): Observable<NostrEvent>;
 /** Wraps an upstream pool and returns a NostrRequest */

package/dist/loaders/address-loader.d.ts

@@ -1,5 +1,5 @@
 import { filterDuplicateEvents } from "applesauce-core";
-import { NostrEvent } from "nostr-tools";
+import { NostrEvent } from "applesauce-core/helpers/event";
 import { Observable } from "rxjs";
 import { CacheRequest, NostrRequest, UpstreamPool } from "../types.js";
 export type LoadableAddressPointer = {

package/dist/loaders/address-loader.js

@@ -115,7 +115,7 @@ export function createAddressLoader(pool, opts) {
     // Filter resutls based on requests
     (pointer, event) => event.kind === pointer.kind &&
         event.pubkey === pointer.pubkey &&
-        (pointer.identifier ? getReplaceableIdentifier(event) === pointer.identifier : true), 
+        (pointer.identifier !== undefined ? getReplaceableIdentifier(event) === pointer.identifier : true), 
     // Pass all events through the store if provided, or use EventMemory for deduplication by default
     opts?.eventStore === null ? identity : filterDuplicateEvents(opts?.eventStore || new EventMemory()));
 }

package/dist/loaders/event-loader.d.ts

@@ -1,6 +1,6 @@
-import { filterDuplicateEvents } from "applesauce-core";
-import { NostrEvent } from "nostr-tools";
-import { EventPointer } from "nostr-tools/nip19";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { EventPointer } from "applesauce-core/helpers/pointers";
+import { filterDuplicateEvents } from "applesauce-core/observable";
 import { Observable } from "rxjs";
 import { CacheRequest, NostrRequest, UpstreamPool } from "../types.js";
 export type LoadableEventPointer = EventPointer & {

package/dist/loaders/event-loader.js

@@ -1,4 +1,5 @@
-import { EventMemory, filterDuplicateEvents } from "applesauce-core";
+import { EventMemory } from "applesauce-core/event-store";
+import { filterDuplicateEvents } from "applesauce-core/observable";
 import { bufferTime, catchError, EMPTY, identity, merge, tap } from "rxjs";
 import { makeCacheRequest } from "../helpers/cache.js";
 import { consolidateEventPointers } from "../helpers/event-pointer.js";

package/dist/loaders/index.d.ts

@@ -5,5 +5,6 @@ export * from "./reactions-loader.js";
 export * from "./social-graph.js";
 export * from "./tag-value-loader.js";
 export * from "./timeline-loader.js";
+export * from "./unified-event-loader.js";
 export * from "./user-lists-loader.js";
 export * from "./zaps-loader.js";

package/dist/loaders/index.js

@@ -5,5 +5,6 @@ export * from "./reactions-loader.js";
 export * from "./social-graph.js";
 export * from "./tag-value-loader.js";
 export * from "./timeline-loader.js";
+export * from "./unified-event-loader.js";
 export * from "./user-lists-loader.js";
 export * from "./zaps-loader.js";

package/dist/loaders/reactions-loader.d.ts

@@ -1,4 +1,4 @@
-import { NostrEvent } from "nostr-tools";
+import { NostrEvent } from "applesauce-core/helpers/event";
 import { Observable } from "rxjs";
 import { UpstreamPool } from "../types.js";
 import { TagValueLoaderOptions } from "./tag-value-loader.js";

package/dist/loaders/reactions-loader.js

@@ -1,5 +1,6 @@
-import { getReplaceableAddress, getSeenRelays, isReplaceable, mergeRelaySets } from "applesauce-core/helpers";
-import { kinds } from "nostr-tools";
+import { getReplaceableAddress, isReplaceable, kinds } from "applesauce-core/helpers/event";
+import { getSeenRelays, mergeRelaySets } from "applesauce-core/helpers/relays";
+import { EMPTY } from "rxjs";
 import { wrapUpstreamPool } from "../helpers/upstream.js";
 import { createTagValueLoader } from "./tag-value-loader.js";
 /** Creates a loader that loads reaction events for a given event */
@@ -11,8 +12,14 @@ export function createReactionsLoader(pool, opts) {
     return (event, relays) => {
         if (opts?.useSeenRelays ?? true)
             relays = mergeRelaySets(relays, getSeenRelays(event));
-        return isReplaceable(event.kind)
-            ? addressableLoader({ value: getReplaceableAddress(event), relays })
-            : eventLoader({ value: event.id, relays });
+        if (isReplaceable(event.kind)) {
+            const address = getReplaceableAddress(event);
+            if (!address)
+                return EMPTY;
+            return addressableLoader({ value: address, relays });
+        }
+        else {
+            return eventLoader({ value: event.id, relays });
+        }
     };
 }

package/dist/loaders/social-graph.d.ts

@@ -1,6 +1,6 @@
-import { mapEventsToStore } from "applesauce-core";
-import { NostrEvent } from "nostr-tools";
-import { ProfilePointer } from "nostr-tools/nip19";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { ProfilePointer } from "applesauce-core/helpers/pointers";
+import { mapEventsToStore } from "applesauce-core/observable";
 import { Observable } from "rxjs";
 import { AddressPointerLoader } from "./address-loader.js";
 /** A loader that loads the social graph of a user out to a set distance */

package/dist/loaders/social-graph.js

@@ -1,6 +1,7 @@
-import { mapEventsToStore } from "applesauce-core";
-import { getProfilePointersFromList, mergeRelaySets } from "applesauce-core/helpers";
-import { kinds } from "nostr-tools";
+import { getPublicContacts } from "applesauce-core/helpers";
+import { kinds } from "applesauce-core/helpers/event";
+import { mergeRelaySets } from "applesauce-core/helpers/relays";
+import { mapEventsToStore } from "applesauce-core/observable";
 import { firstValueFrom, identity, isObservable, lastValueFrom, toArray } from "rxjs";
 import { wrapGeneratorFunction } from "../operators/generator.js";
 /** Create a social graph loader */
@@ -30,7 +31,7 @@ export function createSocialGraphLoader(addressLoader, opts) {
                 toArray()));
                 if (events.length === 0)
                     return;
-                const contacts = getProfilePointersFromList(events[events.length - 1]);
+                const contacts = getPublicContacts(events[events.length - 1]);
                 // if the distance is greater than 0, add the contacts to the queue
                 if (pointer.distance > 0) {
                     for (const contact of contacts) {

package/dist/loaders/tag-value-loader.d.ts

@@ -1,5 +1,5 @@
-import { filterDuplicateEvents } from "applesauce-core";
-import { NostrEvent } from "nostr-tools";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { filterDuplicateEvents } from "applesauce-core/observable";
 import { Observable } from "rxjs";
 import { CacheRequest, NostrRequest, UpstreamPool } from "../types.js";
 export type TagValuePointer = {

package/dist/loaders/tag-value-loader.js

@@ -1,5 +1,6 @@
-import { EventMemory, filterDuplicateEvents } from "applesauce-core";
-import { mergeRelaySets } from "applesauce-core/helpers";
+import { EventMemory } from "applesauce-core/event-store";
+import { mergeRelaySets } from "applesauce-core/helpers/relays";
+import { filterDuplicateEvents } from "applesauce-core/observable";
 import { bufferTime, EMPTY, identity, merge } from "rxjs";
 import { unique } from "../helpers/array.js";
 import { makeCacheRequest } from "../helpers/cache.js";

package/dist/loaders/timeline-loader.d.ts

@@ -1,6 +1,8 @@
-import { mapEventsToStore } from "applesauce-core";
-import { FilterMap, OutboxMap, ProfilePointer } from "applesauce-core/helpers";
-import { Filter, NostrEvent } from "nostr-tools";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { Filter } from "applesauce-core/helpers/filter";
+import { ProfilePointer } from "applesauce-core/helpers/pointers";
+import { FilterMap, OutboxMap } from "applesauce-core/helpers/relay-selection";
+import { mapEventsToStore } from "applesauce-core/observable";
 import { Observable, OperatorFunction } from "rxjs";
 import { CacheRequest, TimelessFilter, UpstreamPool } from "../types.js";
 /** A loader that optionally takes a timestamp to load till and returns a stream of events */

package/dist/loaders/timeline-loader.js

@@ -1,5 +1,8 @@
-import { logger as baseLogger, EventMemory, filterDuplicateEvents } from "applesauce-core";
-import { createFilterMap, isFilterEqual, mergeFilters, } from "applesauce-core/helpers";
+import { logger as baseLogger } from "applesauce-core";
+import { EventMemory } from "applesauce-core/event-store";
+import { isFilterEqual, mergeFilters } from "applesauce-core/helpers/filter";
+import { createFilterMap } from "applesauce-core/helpers/relay-selection";
+import { filterDuplicateEvents } from "applesauce-core/observable";
 import { nanoid } from "nanoid";
 import { BehaviorSubject, distinctUntilChanged, EMPTY, filter, finalize, identity, isObservable, map, merge, mergeMap, Observable, of, share, switchMap, tap, } from "rxjs";
 import { makeCacheRequest } from "../helpers/cache.js";

package/dist/loaders/unified-event-loader.d.ts

@@ -0,0 +1,18 @@
+import { filterDuplicateEvents, IMissingEventLoader } from "applesauce-core";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { Observable } from "rxjs";
+import { UpstreamPool } from "../types.js";
+import { AddressLoaderOptions, LoadableAddressPointer } from "./address-loader.js";
+import { EventPointerLoaderOptions, LoadableEventPointer } from "./event-loader.js";
+export type UnifiedEventLoaderOptions = Partial<EventPointerLoaderOptions & AddressLoaderOptions>;
+export type UnifiedEventLoader = (pointer: LoadableEventPointer | LoadableAddressPointer) => Observable<NostrEvent>;
+/**
+ * Create a unified event loader that can handle both EventPointer and AddressPointer types.
+ * Internally routes to createEventLoader for EventPointer and createAddressLoader for AddressPointer.
+ */
+export declare function createUnifiedEventLoader(pool: UpstreamPool, opts?: UnifiedEventLoaderOptions): UnifiedEventLoader;
+/**
+ * Creates a {@link UnifiedEventLoader} that will be used to load events that are not found in the store
+ * @returns The created loader
+ */
+export declare function createEventLoaderForStore(store: IMissingEventLoader & Parameters<typeof filterDuplicateEvents>[0], pool: UpstreamPool, opts?: Omit<UnifiedEventLoaderOptions, "eventStore">): UnifiedEventLoader;

package/dist/loaders/unified-event-loader.js

@@ -0,0 +1,46 @@
+import { isEventPointer } from "applesauce-core/helpers/pointers";
+import { createAddressLoader } from "./address-loader.js";
+import { createEventLoader } from "./event-loader.js";
+/**
+ * Create a unified event loader that can handle both EventPointer and AddressPointer types.
+ * Internally routes to createEventLoader for EventPointer and createAddressLoader for AddressPointer.
+ */
+export function createUnifiedEventLoader(pool, opts) {
+    // Create both loaders with the appropriate options
+    const eventLoader = createEventLoader(pool, {
+        bufferTime: opts?.bufferTime,
+        bufferSize: opts?.bufferSize,
+        eventStore: opts?.eventStore,
+        cacheRequest: opts?.cacheRequest,
+        followRelayHints: opts?.followRelayHints,
+        extraRelays: opts?.extraRelays,
+    });
+    const addressLoader = createAddressLoader(pool, {
+        bufferTime: opts?.bufferTime,
+        bufferSize: opts?.bufferSize,
+        eventStore: opts?.eventStore,
+        cacheRequest: opts?.cacheRequest,
+        followRelayHints: opts?.followRelayHints,
+        extraRelays: opts?.extraRelays,
+        lookupRelays: opts?.lookupRelays,
+    });
+    // Return a unified loader that routes based on pointer type
+    return (pointer) => {
+        // Check if it's an EventPointer (has 'id' property)
+        if (isEventPointer(pointer)) {
+            return eventLoader(pointer);
+        }
+        else {
+            return addressLoader(pointer);
+        }
+    };
+}
+/**
+ * Creates a {@link UnifiedEventLoader} that will be used to load events that are not found in the store
+ * @returns The created loader
+ */
+export function createEventLoaderForStore(store, pool, opts) {
+    const loader = createUnifiedEventLoader(pool, { ...opts, eventStore: store });
+    store.eventLoader = loader;
+    return loader;
+}

package/dist/loaders/user-lists-loader.d.ts

@@ -1,6 +1,6 @@
 import { mapEventsToStore } from "applesauce-core";
-import { NostrEvent } from "nostr-tools";
-import { ProfilePointer } from "nostr-tools/nip19";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { ProfilePointer } from "applesauce-core/helpers/pointers";
 import { Observable } from "rxjs";
 import { CacheRequest, UpstreamPool } from "../types.js";
 /** A list of NIP-51 list kinds that most clients will use */

package/dist/loaders/user-lists-loader.js

@@ -1,6 +1,6 @@
 import { mapEventsToStore } from "applesauce-core";
-import { mergeRelaySets } from "applesauce-core/helpers";
-import { kinds } from "nostr-tools";
+import { kinds } from "applesauce-core/helpers/event";
+import { mergeRelaySets } from "applesauce-core/helpers/relays";
 import { EMPTY, identity, merge } from "rxjs";
 import { makeCacheRequest } from "../helpers/cache.js";
 import { unwrap } from "../helpers/loaders.js";

package/dist/loaders/zaps-loader.d.ts

@@ -1,4 +1,4 @@
-import { NostrEvent } from "nostr-tools";
+import { NostrEvent } from "applesauce-core/helpers/event";
 import { Observable } from "rxjs";
 import { UpstreamPool } from "../types.js";
 import { TagValueLoaderOptions } from "./tag-value-loader.js";

package/dist/loaders/zaps-loader.js

@@ -1,5 +1,6 @@
-import { getReplaceableAddress, getSeenRelays, isReplaceable, mergeRelaySets } from "applesauce-core/helpers";
-import { kinds } from "nostr-tools";
+import { getReplaceableAddress, isReplaceable, kinds } from "applesauce-core/helpers/event";
+import { getSeenRelays, mergeRelaySets } from "applesauce-core/helpers/relays";
+import { EMPTY } from "rxjs";
 import { wrapUpstreamPool } from "../helpers/upstream.js";
 import { createTagValueLoader } from "./tag-value-loader.js";
 /** Creates a loader that loads zap events for a given event */
@@ -11,8 +12,14 @@ export function createZapsLoader(pool, opts) {
     return (event, relays) => {
         if (opts?.useSeenRelays ?? true)
             relays = mergeRelaySets(relays, getSeenRelays(event));
-        return isReplaceable(event.kind)
-            ? addressableLoader({ value: getReplaceableAddress(event), relays })
-            : eventLoader({ value: event.id, relays });
+        if (isReplaceable(event.kind)) {
+            const address = getReplaceableAddress(event);
+            if (!address)
+                return EMPTY;
+            return addressableLoader({ value: address, relays });
+        }
+        else {
+            return eventLoader({ value: event.id, relays });
+        }
     };
 }

package/dist/types.d.ts

@@ -1,14 +1,13 @@
-import { Filter, NostrEvent } from "nostr-tools";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { Filter } from "applesauce-core/helpers/filter";
 import { Observable } from "rxjs";
 /** A flexible method for requesting events from a cache */
 export type CacheRequest = (filters: Filter[]) => Observable<NostrEvent> | Promise<NostrEvent | NostrEvent[]> | NostrEvent | NostrEvent[];
+/** A method for requesting events from multiple relays */
+export type NostrRequest = (relays: string[], filters: Filter[]) => Observable<NostrEvent>;
 /** A flexible type for the upstream relay pool */
 export type UpstreamPool = NostrRequest | {
     request: NostrRequest;
 };
-/** A method for requesting events from a relay or cache` */
-export type FilterRequest = (filters: Filter[]) => Observable<NostrEvent>;
-/** A method for requesting events from multiple relays */
-export type NostrRequest = (relays: string[], filters: Filter[]) => Observable<NostrEvent>;
 /** A filter that is does not have a since or until */
 export type TimelessFilter = Omit<Filter, "since" | "until">;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-loaders",
-  "version": "4.2.0",
+  "version": "5.0.2",
   "description": "A collection of observable based loaders built on rx-nostr",
   "type": "module",
   "main": "dist/index.js",
@@ -52,17 +52,16 @@
     }
   },
   "dependencies": {
-    "applesauce-core": "^4.2.0",
+    "applesauce-core": "^5.0.0",
     "nanoid": "^5.0.9",
-    "nostr-tools": "~2.17",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
-    "applesauce-signers": "^4.2.0",
+    "applesauce-signers": "^5.0.0",
     "rimraf": "^6.0.1",
     "typescript": "^5.8.3",
-    "vitest": "^3.2.4",
+    "vitest": "^4.0.15",
     "vitest-websocket-mock": "^0.5.0"
   },
   "funding": {