applesauce-core 0.0.0-next-20250425210455 → 0.0.0-next-20250428164231

package/dist/helpers/lists.d.ts

@@ -1,28 +1,56 @@
 import { AddressPointer, EventPointer, ProfilePointer } from "nostr-tools/nip19";
 import { NostrEvent } from "nostr-tools";
+export declare const FAVORITE_RELAYS_KIND = 10012;
+export type ReadListTags = "public" | "hidden" | "all";
+/** Returns all the tags of a list or set */
+export declare function getListTags(list: NostrEvent, type?: ReadListTags): string[][];
 /**
  * Checks if an event pointer is anywhere in a list or set
  * NOTE: Ignores the `relay` field in EventPointer
- * NOTE: This will check the hidden tags if the list has hidden tags and they are unlocked
+ * @param list - The list or set to check
+ * @param pointer - The event pointer to check
+ * @param type - Which types of tags to check
  */
-export declare function isEventPointerInList(list: NostrEvent, pointer: string | EventPointer): boolean;
+export declare function isEventPointerInList(list: NostrEvent, pointer: string | EventPointer, type?: ReadListTags): boolean;
 /**
  * Checks if an address pointer is anywhere in a list or set
  * NOTE: Ignores the `relay` field in AddressPointer
- * NOTE: This will check the hidden tags if the list has hidden tags and they are unlocked
+ * @param list - The list or set to check
+ * @param pointer - The address pointer to check
+ * @param type - Which types of tags to check
  */
-export declare function isAddressPointerInList(list: NostrEvent, pointer: string | AddressPointer): boolean;
+export declare function isAddressPointerInList(list: NostrEvent, pointer: string | AddressPointer, type?: ReadListTags): boolean;
 /**
  * Checks if an profile pointer is anywhere in a list or set
  * NOTE: Ignores the `relay` field in ProfilePointer
- * NOTE: This will check the hidden tags if the list has hidden tags and they are unlocked
+ * @param list - The list or set to check
+ * @param pointer - The profile pointer to check
+ * @param type - Which types of tags to check
  */
-export declare function isProfilePointerInList(list: NostrEvent, pointer: string | ProfilePointer): boolean;
-/** Returns all the EventPointer in a list or set */
-export declare function getEventPointersFromList(list: NostrEvent): EventPointer[];
-/** Returns all the AddressPointer in a list or set */
-export declare function getAddressPointersFromList(list: NostrEvent): AddressPointer[];
-/** Returns all the ProfilePointer in a list or set */
-export declare function getProfilePointersFromList(list: NostrEvent): ProfilePointer[];
+export declare function isProfilePointerInList(list: NostrEvent, pointer: string | ProfilePointer, type?: ReadListTags): boolean;
+/**
+ * Returns all the EventPointer in a list or set
+ * @param list - The list or set to get the event pointers from
+ * @param type - Which types of tags to read
+ */
+export declare function getEventPointersFromList(list: NostrEvent, type?: ReadListTags): EventPointer[];
+/**
+ * Returns all the AddressPointer in a list or set
+ * @param list - The list or set to get the address pointers from
+ * @param type - Which types of tags to read
+ */
+export declare function getAddressPointersFromList(list: NostrEvent, type?: ReadListTags): AddressPointer[];
+/**
+ * Returns all the ProfilePointer in a list or set
+ * @param list - The list or set to get the profile pointers from
+ * @param type - Which types of tags to read
+ */
+export declare function getProfilePointersFromList(list: NostrEvent, type?: ReadListTags): ProfilePointer[];
+/**
+ * Returns a deduplicated array of all 'relay' tags in a list or set
+ * @param list - The list or set to get the relays from
+ * @param type - Which types of tags to read
+ */
+export declare function getRelaysFromList(list: NostrEvent, type?: ReadListTags): string[];
 /** Returns if an event is a valid list or set */
 export declare function isValidList(event: NostrEvent): boolean;

package/dist/helpers/lists.js

@@ -3,48 +3,87 @@ import { getHiddenTags } from "./hidden-tags.js";
 import { getAddressPointerFromATag, getCoordinateFromAddressPointer, getEventPointerFromETag, getProfilePointerFromPTag, } from "./pointers.js";
 import { isATag, isETag, isPTag, processTags } from "./tags.js";
 import { getReplaceableIdentifier } from "./event.js";
-function listGetAllTags(list) {
-    const hidden = getHiddenTags(list);
-    return hidden ? [...hidden, ...list.tags] : list.tags;
+import { mergeRelaySets } from "./relays.js";
+export const FAVORITE_RELAYS_KIND = 10012;
+/** Returns all the tags of a list or set */
+export function getListTags(list, type) {
+    switch (type) {
+        case "public":
+            return list.tags;
+        case "hidden":
+            return getHiddenTags(list) ?? [];
+        default:
+        case "all":
+            return [...(getHiddenTags(list) ?? []), ...list.tags];
+    }
 }
 /**
  * Checks if an event pointer is anywhere in a list or set
  * NOTE: Ignores the `relay` field in EventPointer
- * NOTE: This will check the hidden tags if the list has hidden tags and they are unlocked
+ * @param list - The list or set to check
+ * @param pointer - The event pointer to check
+ * @param type - Which types of tags to check
  */
-export function isEventPointerInList(list, pointer) {
+export function isEventPointerInList(list, pointer, type) {
     const id = typeof pointer === "string" ? pointer : pointer.id;
-    return listGetAllTags(list).some((t) => t[0] === "e" && t[1] === id);
+    const tags = getListTags(list, type);
+    return tags.some((t) => t[0] === "e" && t[1] === id);
 }
 /**
  * Checks if an address pointer is anywhere in a list or set
  * NOTE: Ignores the `relay` field in AddressPointer
- * NOTE: This will check the hidden tags if the list has hidden tags and they are unlocked
+ * @param list - The list or set to check
+ * @param pointer - The address pointer to check
+ * @param type - Which types of tags to check
  */
-export function isAddressPointerInList(list, pointer) {
+export function isAddressPointerInList(list, pointer, type) {
     const cord = typeof pointer === "string" ? pointer : getCoordinateFromAddressPointer(pointer);
-    return listGetAllTags(list).some((t) => t[0] === "a" && t[1] === cord);
+    const tags = getListTags(list, type);
+    return tags.some((t) => t[0] === "a" && t[1] === cord);
 }
 /**
  * Checks if an profile pointer is anywhere in a list or set
  * NOTE: Ignores the `relay` field in ProfilePointer
- * NOTE: This will check the hidden tags if the list has hidden tags and they are unlocked
+ * @param list - The list or set to check
+ * @param pointer - The profile pointer to check
+ * @param type - Which types of tags to check
  */
-export function isProfilePointerInList(list, pointer) {
+export function isProfilePointerInList(list, pointer, type) {
     const pubkey = typeof pointer === "string" ? pointer : pointer.pubkey;
-    return listGetAllTags(list).some((t) => t[0] === "p" && t[1] === pubkey);
+    const tags = getListTags(list, type);
+    return tags.some((t) => t[0] === "p" && t[1] === pubkey);
 }
-/** Returns all the EventPointer in a list or set */
-export function getEventPointersFromList(list) {
-    return processTags(listGetAllTags(list), (tag) => (isETag(tag) ? tag : undefined), getEventPointerFromETag);
+/**
+ * Returns all the EventPointer in a list or set
+ * @param list - The list or set to get the event pointers from
+ * @param type - Which types of tags to read
+ */
+export function getEventPointersFromList(list, type) {
+    return processTags(getListTags(list, type), (tag) => (isETag(tag) ? tag : undefined), getEventPointerFromETag);
+}
+/**
+ * Returns all the AddressPointer in a list or set
+ * @param list - The list or set to get the address pointers from
+ * @param type - Which types of tags to read
+ */
+export function getAddressPointersFromList(list, type) {
+    return processTags(getListTags(list, type), (t) => (isATag(t) ? t : undefined), getAddressPointerFromATag);
 }
-/** Returns all the AddressPointer in a list or set */
-export function getAddressPointersFromList(list) {
-    return processTags(listGetAllTags(list), (t) => (isATag(t) ? t : undefined), getAddressPointerFromATag);
+/**
+ * Returns all the ProfilePointer in a list or set
+ * @param list - The list or set to get the profile pointers from
+ * @param type - Which types of tags to read
+ */
+export function getProfilePointersFromList(list, type) {
+    return processTags(getListTags(list, type), (t) => (isPTag(t) ? t : undefined), getProfilePointerFromPTag);
 }
-/** Returns all the ProfilePointer in a list or set */
-export function getProfilePointersFromList(list) {
-    return processTags(listGetAllTags(list), (t) => (isPTag(t) ? t : undefined), getProfilePointerFromPTag);
+/**
+ * Returns a deduplicated array of all 'relay' tags in a list or set
+ * @param list - The list or set to get the relays from
+ * @param type - Which types of tags to read
+ */
+export function getRelaysFromList(list, type) {
+    return mergeRelaySets(processTags(getListTags(list, type), (t) => (t[0] === "relay" ? t[1] : undefined)));
 }
 /** Returns if an event is a valid list or set */
 export function isValidList(event) {

package/dist/queries/index.d.ts

@@ -3,6 +3,7 @@ export * from "./bookmarks.js";
 export * from "./channels.js";
 export * from "./comments.js";
 export * from "./contacts.js";
+export * from "./relays.js";
 export * from "./mailboxes.js";
 export * from "./mutes.js";
 export * from "./pins.js";

package/dist/queries/index.js

@@ -3,6 +3,7 @@ export * from "./bookmarks.js";
 export * from "./channels.js";
 export * from "./comments.js";
 export * from "./contacts.js";
+export * from "./relays.js";
 export * from "./mailboxes.js";
 export * from "./mutes.js";
 export * from "./pins.js";

package/dist/queries/lists.d.ts

@@ -0,0 +1,14 @@
+import { AddressPointer } from "nostr-tools/nip19";
+import { Query } from "../query-store/query-store.js";
+/**
+ * A query that returns all favorite relays for a pubkey
+ * @param pubkey - The pubkey to get the favorite relays for
+ * @param hidden - Whether to read hidden tags instead of public tags
+ */
+export declare function FavoriteRelays(pubkey: string, hidden?: boolean): Query<string[] | undefined>;
+/**
+ * A query that returns all favorite relay sets for a pubkey
+ * @param pubkey - The pubkey to get the favorite relay sets for
+ * @param hidden - Whether to read hidden tags instead of public tags
+ */
+export declare function FavoriteRelaySets(pubkey: string, hidden?: boolean): Query<AddressPointer[] | undefined>;

package/dist/queries/lists.js

@@ -0,0 +1,24 @@
+import { map } from "rxjs";
+import { FAVORITE_RELAYS_KIND, getAddressPointersFromList, getRelaysFromList } from "../helpers/lists.js";
+/**
+ * A query that returns all favorite relays for a pubkey
+ * @param pubkey - The pubkey to get the favorite relays for
+ * @param hidden - Whether to read hidden tags instead of public tags
+ */
+export function FavoriteRelays(pubkey, hidden = false) {
+    return (events) => {
+        return events.replaceable(FAVORITE_RELAYS_KIND, pubkey).pipe(map((e) => e && getRelaysFromList(e, hidden)));
+    };
+}
+/**
+ * A query that returns all favorite relay sets for a pubkey
+ * @param pubkey - The pubkey to get the favorite relay sets for
+ * @param hidden - Whether to read hidden tags instead of public tags
+ */
+export function FavoriteRelaySets(pubkey, hidden = false) {
+    return (events) => {
+        return events
+            .replaceable(FAVORITE_RELAYS_KIND, pubkey)
+            .pipe(map((e) => e && getAddressPointersFromList(e, hidden)));
+    };
+}

package/dist/queries/relays.d.ts

@@ -0,0 +1,27 @@
+import { AddressPointer } from "nostr-tools/nip19";
+import { ReadListTags } from "../helpers/lists.js";
+import { Query } from "../query-store/query-store.js";
+/**
+ * A query that returns all favorite relays for a pubkey
+ * @param pubkey - The pubkey to get the favorite relays for
+ * @param type - Which types of tags to read
+ */
+export declare function FavoriteRelays(pubkey: string, type?: ReadListTags): Query<string[] | undefined>;
+/**
+ * A query that returns all favorite relay sets for a pubkey
+ * @param pubkey - The pubkey to get the favorite relay sets for
+ * @param type - Which types of tags to read
+ */
+export declare function FavoriteRelaySets(pubkey: string, type?: ReadListTags): Query<AddressPointer[] | undefined>;
+/**
+ * A query that returns all search relays for a pubkey
+ * @param pubkey - The pubkey to get the search relays for
+ * @param type - Which types of tags to read
+ */
+export declare function SearchRelays(pubkey: string, type?: ReadListTags): Query<string[] | undefined>;
+/**
+ * A query that returns all blocked relays for a pubkey
+ * @param pubkey - The pubkey to get the blocked relays for
+ * @param type - Which types of tags to read
+ */
+export declare function BlockedRelays(pubkey: string, type?: ReadListTags): Query<string[] | undefined>;

package/dist/queries/relays.js

@@ -0,0 +1,44 @@
+import { kinds } from "nostr-tools";
+import { identity, map } from "rxjs";
+import { FAVORITE_RELAYS_KIND, getAddressPointersFromList, getRelaysFromList } from "../helpers/lists.js";
+import { listenLatestUpdates } from "../observable/listen-latest-updates.js";
+/**
+ * A query that returns all favorite relays for a pubkey
+ * @param pubkey - The pubkey to get the favorite relays for
+ * @param type - Which types of tags to read
+ */
+export function FavoriteRelays(pubkey, type) {
+    return (events) => {
+        return events.replaceable(FAVORITE_RELAYS_KIND, pubkey).pipe(type !== "public" ? listenLatestUpdates(events) : map(identity), map((e) => e && getRelaysFromList(e, type)));
+    };
+}
+/**
+ * A query that returns all favorite relay sets for a pubkey
+ * @param pubkey - The pubkey to get the favorite relay sets for
+ * @param type - Which types of tags to read
+ */
+export function FavoriteRelaySets(pubkey, type) {
+    return (events) => {
+        return events.replaceable(FAVORITE_RELAYS_KIND, pubkey).pipe(type !== "public" ? listenLatestUpdates(events) : map(identity), map((e) => e && getAddressPointersFromList(e, type)));
+    };
+}
+/**
+ * A query that returns all search relays for a pubkey
+ * @param pubkey - The pubkey to get the search relays for
+ * @param type - Which types of tags to read
+ */
+export function SearchRelays(pubkey, type) {
+    return (events) => {
+        return events.replaceable(kinds.SearchRelaysList, pubkey).pipe(type !== "public" ? listenLatestUpdates(events) : map(identity), map((e) => e && getRelaysFromList(e, type)));
+    };
+}
+/**
+ * A query that returns all blocked relays for a pubkey
+ * @param pubkey - The pubkey to get the blocked relays for
+ * @param type - Which types of tags to read
+ */
+export function BlockedRelays(pubkey, type) {
+    return (events) => {
+        return events.replaceable(kinds.BlockedRelaysList, pubkey).pipe(type !== "public" ? listenLatestUpdates(events) : map(identity), map((e) => e && getRelaysFromList(e, type)));
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "0.0.0-next-20250425210455",
+  "version": "0.0.0-next-20250428164231",
   "description": "",
   "type": "module",
   "main": "dist/index.js",