applesauce-core 4.1.0 → 4.2.0

package/dist/helpers/article.d.ts

@@ -1,5 +1,9 @@
-import { NostrEvent } from "nostr-tools";
+import { kinds, NostrEvent } from "nostr-tools";
+import { KnownEvent } from "./index.js";
+/** Type for validated article events */
+export type ArticleEvent = KnownEvent<kinds.LongFormArticle>;
 /** Returns an articles title, if it exists */
+export declare function getArticleTitle(article: ArticleEvent): string;
 export declare function getArticleTitle(article: NostrEvent): string | undefined;
 /** Returns an articles image, if it exists */
 export declare function getArticleImage(article: NostrEvent): string | undefined;
@@ -7,3 +11,5 @@ export declare function getArticleImage(article: NostrEvent): string | undefined
 export declare function getArticleSummary(article: NostrEvent): string | undefined;
 /** Returns an articles published date, if it exists */
 export declare function getArticlePublished(article: NostrEvent): number;
+/** validates that an event is a valid article event */
+export declare function isValidArticle(article: NostrEvent): article is ArticleEvent;

package/dist/helpers/article.js

@@ -1,5 +1,5 @@
+import { kinds } from "nostr-tools";
 import { getTagValue } from "./event-tags.js";
-/** Returns an articles title, if it exists */
 export function getArticleTitle(article) {
     return getTagValue(article, "title");
 }
@@ -19,3 +19,7 @@ export function getArticlePublished(article) {
     else
         return article.created_at;
 }
+/** validates that an event is a valid article event */
+export function isValidArticle(article) {
+    return article.kind === kinds.LongFormArticle && getArticleTitle(article) !== undefined && article.content.length > 0;
+}

package/dist/helpers/relay-selection.d.ts

@@ -1,4 +1,5 @@
-import { ProfilePointer } from "nostr-tools/nip19";
+import { ProfilePointer } from "./pointers.js";
+import { Filter } from "./filter.js";
 export type SelectOptimalRelaysOptions = {
     /** Maximum number of connections (relays) to select */
     maxConnections: number;
@@ -13,5 +14,11 @@ export declare function setFallbackRelays(users: ProfilePointer[], fallbacks: st
 export declare function removeBlacklistedRelays(users: ProfilePointer[], blacklist: string[]): ProfilePointer[];
 /** A map of pubkeys by relay */
 export type OutboxMap = Record<string, ProfilePointer[]>;
-/** RxJS operator that aggregates contacts with outboxes into a relay -> pubkeys map */
+/** A map of filters by relay */
+export type FilterMap = Record<string, Filter | Filter[]>;
+/** Creates an {@link OutboxMap} for an array of profile points (groups users by relay) */
 export declare function groupPubkeysByRelay(pointers: ProfilePointer[]): OutboxMap;
+/** Alias for {@link groupPubkeysByRelay} */
+export declare const createOutboxMap: typeof groupPubkeysByRelay;
+/** Creates a {@link FilterMap} for an {@link OutboxMap} */
+export declare function createFilterMap(outboxMap: OutboxMap, filter: Omit<Filter, "authors">): FilterMap;

package/dist/helpers/relay-selection.js

@@ -86,7 +86,7 @@ export function removeBlacklistedRelays(users, blacklist) {
             return { ...user, relays: user.relays.filter((relay) => !blacklist.includes(relay)) };
     });
 }
-/** RxJS operator that aggregates contacts with outboxes into a relay -> pubkeys map */
+/** Creates an {@link OutboxMap} for an array of profile points (groups users by relay) */
 export function groupPubkeysByRelay(pointers) {
     const outbox = {};
     for (const pointer of pointers) {
@@ -100,3 +100,12 @@ export function groupPubkeysByRelay(pointers) {
     }
     return outbox;
 }
+/** Alias for {@link groupPubkeysByRelay} */
+export const createOutboxMap = groupPubkeysByRelay;
+/** Creates a {@link FilterMap} for an {@link OutboxMap} */
+export function createFilterMap(outboxMap, filter) {
+    return Object.fromEntries(Array.from(Object.entries(outboxMap)).map(([relay, users]) => [
+        relay,
+        { authors: users.map((user) => user.pubkey), ...filter },
+    ]));
+}

package/dist/observable/relay-selection.d.ts

@@ -7,3 +7,5 @@ export declare function includeMailboxes(store: IEventSubscriptions, type?: "inb
 export declare function ignoreBlacklistedRelays(blacklist: string[] | Observable<string[]>): MonoTypeOperatorFunction<ProfilePointer[]>;
 /** Sets fallback relays for any user that has 0 relays */
 export declare function includeFallbackRelays(fallbacks: string[] | Observable<string[]>): MonoTypeOperatorFunction<ProfilePointer[]>;
+/** A operator calls {@link selectOptimalRelays} and filters the relays for the user */
+export declare function filterOptimalRelays(maxConnections: number | Observable<number>, maxRelaysPerUser: number | Observable<number>): MonoTypeOperatorFunction<ProfilePointer[]>;

package/dist/observable/relay-selection.js

@@ -1,7 +1,7 @@
 import { combineLatest, combineLatestWith, isObservable, map, of, pipe, switchMap, } from "rxjs";
 import { getInboxes, getOutboxes } from "../helpers/mailboxes.js";
 import { addRelayHintsToPointer } from "../helpers/pointers.js";
-import { removeBlacklistedRelays, setFallbackRelays } from "../helpers/relay-selection.js";
+import { removeBlacklistedRelays, selectOptimalRelays, setFallbackRelays } from "../helpers/relay-selection.js";
 /** RxJS operator that fetches outboxes for profile pointers from the event store */
 export function includeMailboxes(store, type = "outbox") {
     // Get the outboxes for all contacts
@@ -41,3 +41,11 @@ export function includeFallbackRelays(fallbacks) {
     // Set the fallback relays for the users
     map(([users, fallbacks]) => setFallbackRelays(users, fallbacks)));
 }
+/** A operator calls {@link selectOptimalRelays} and filters the relays for the user */
+export function filterOptimalRelays(maxConnections, maxRelaysPerUser) {
+    return pipe(
+    // Combine with the observable so it re-emits when the max connections and max relays per user change
+    combineLatestWith(isObservable(maxConnections) ? maxConnections : of(maxConnections), isObservable(maxRelaysPerUser) ? maxRelaysPerUser : of(maxRelaysPerUser)), 
+    // Filter the relays for the user
+    map(([users, maxConnections, maxRelaysPerUser]) => selectOptimalRelays(users, { maxConnections, maxRelaysPerUser })));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",