applesauce-core 0.0.0-next-20250522030625 → 0.0.0-next-20250526151506

package/dist/helpers/__tests__/exports.test.js

@@ -73,6 +73,8 @@ describe("exports", () => {
         "decryptDirectMessage",
         "encodeDecodeResult",
         "encodeGroupPointer",
+        "ensureProtocol",
+        "ensureWebSocketURL",
         "fakeVerifyEvent",
         "getAddressPointerForEvent",
         "getAddressPointerFromATag",
@@ -109,6 +111,7 @@ describe("exports", () => {
         "getGiftWrapEvent",
         "getGiftWrapSeal",
         "getGroupPointerFromGroupTag",
+        "getGroupPointerFromHTag",
         "getHandlerDescription",
         "getHandlerLinkTemplate",
         "getHandlerName",

package/dist/helpers/__tests__/groups.test.js

@@ -0,0 +1,61 @@
+import { describe, it, expect } from "vitest";
+import { decodeGroupPointer, encodeGroupPointer } from "../groups.js";
+describe("Group pointer utilities", () => {
+    describe("decodeGroupPointer", () => {
+        it("should decode a valid group pointer", () => {
+            const pointer = decodeGroupPointer("relay.example.com'group123");
+            expect(pointer).toEqual({
+                relay: "wss://relay.example.com",
+                id: "group123",
+            });
+        });
+        it("should add wss:// protocol if missing", () => {
+            const pointer = decodeGroupPointer("relay.example.com'group123");
+            expect(pointer.relay).toBe("wss://relay.example.com");
+        });
+        it("should preserve existing protocol if present", () => {
+            const pointer = decodeGroupPointer("wss://relay.example.com'group123");
+            expect(pointer.relay).toBe("wss://relay.example.com");
+            const wsPointer = decodeGroupPointer("ws://relay.example.com'group123");
+            expect(wsPointer.relay).toBe("ws://relay.example.com");
+        });
+        it("should handle default group id", () => {
+            const pointer = decodeGroupPointer("relay.example.com'");
+            expect(pointer).toEqual({
+                relay: "wss://relay.example.com",
+                id: "_",
+            });
+        });
+        it("should throw error if relay is missing", () => {
+            expect(() => decodeGroupPointer("'group123")).toThrow("Group pointer missing relay");
+        });
+    });
+    describe("encodeGroupPointer", () => {
+        it("should encode a valid group pointer", () => {
+            const pointer = {
+                relay: "wss://relay.example.com",
+                id: "group123",
+            };
+            expect(encodeGroupPointer(pointer)).toBe("relay.example.com'group123");
+        });
+        it("should strip protocol from relay", () => {
+            const pointer = {
+                relay: "wss://relay.example.com",
+                id: "group123",
+            };
+            expect(encodeGroupPointer(pointer)).toBe("relay.example.com'group123");
+            const wsPointer = {
+                relay: "ws://relay.example.com",
+                id: "group123",
+            };
+            expect(encodeGroupPointer(wsPointer)).toBe("relay.example.com'group123");
+        });
+        it("should handle invalid URLs by using the raw value", () => {
+            const pointer = {
+                relay: "invalid-url",
+                id: "group123",
+            };
+            expect(encodeGroupPointer(pointer)).toBe("invalid-url'group123");
+        });
+    });
+});

package/dist/helpers/groups.d.ts

@@ -3,8 +3,11 @@ export declare const GROUPS_LIST_KIND = 10009;
 export declare const GROUP_MESSAGE_KIND = 9;
 /** NIP-29 group pointer */
 export type GroupPointer = {
+    /** the id of the group */
     id: string;
+    /** The url to the relay with wss:// or ws:// protocol */
     relay: string;
+    /** The name of the group */
     name?: string;
 };
 /**
@@ -16,6 +19,8 @@ export declare function decodeGroupPointer(str: string): GroupPointer;
 export declare function encodeGroupPointer(pointer: GroupPointer): string;
 export declare const GroupsPublicSymbol: unique symbol;
 export declare const GroupsHiddenSymbol: unique symbol;
+/** gets a {@link GroupPointer} from a "h" tag if it has a relay hint */
+export declare function getGroupPointerFromHTag(tag: string[]): GroupPointer | undefined;
 /** gets a {@link GroupPointer} from a "group" tag */
 export declare function getGroupPointerFromGroupTag(tag: string[]): GroupPointer;
 /** Returns all the public groups from a k:10009 list */

package/dist/helpers/groups.js

@@ -8,9 +8,12 @@ export const GROUP_MESSAGE_KIND = 9;
  * @throws
  */
 export function decodeGroupPointer(str) {
-    const [relay, id] = str.split("'");
+    let [relay, id] = str.split("'");
     if (!relay)
         throw new Error("Group pointer missing relay");
+    // Prepend wss:// if missing
+    if (!relay.match(/^wss?:/))
+        relay = `wss://${relay}`;
     return { relay, id: id || "_" };
 }
 /** Converts a group pointer into a group identifier */
@@ -20,6 +23,13 @@ export function encodeGroupPointer(pointer) {
 }
 export const GroupsPublicSymbol = Symbol.for("groups-public");
 export const GroupsHiddenSymbol = Symbol.for("groups-hidden");
+/** gets a {@link GroupPointer} from a "h" tag if it has a relay hint */
+export function getGroupPointerFromHTag(tag) {
+    const [_, id, relay] = tag;
+    if (!id || !relay)
+        return undefined;
+    return { id, relay };
+}
 /** gets a {@link GroupPointer} from a "group" tag */
 export function getGroupPointerFromGroupTag(tag) {
     const [_, id, relay, name] = tag;

package/dist/helpers/url.d.ts

@@ -14,6 +14,10 @@ export declare function isStreamURL(url: string | URL): boolean;
 export declare function isAudioURL(url: string | URL): boolean;
 /** Tests if two URLs are the same */
 export declare function isSameURL(a: string | URL, b: string | URL): boolean;
+/** Adds a protocol to a URL string if its missing one */
+export declare function ensureProtocol(url: string, protocol?: string): string;
+/** Converts a URL to a WebSocket URL */
+export declare function ensureWebSocketURL<T extends string | URL>(url: T): T;
 /**
  * Normalizes a string into a relay URL
  * Does not remove the trailing slash

package/dist/helpers/url.js

@@ -39,6 +39,26 @@ export function isSameURL(a, b) {
         return false;
     }
 }
+/** Adds a protocol to a URL string if its missing one */
+export function ensureProtocol(url, protocol = "https:") {
+    // Check if the URL already has a protocol
+    if (/^[a-zA-Z][a-zA-Z0-9+.-]+:/.test(url))
+        return url;
+    return protocol + "//" + url;
+}
+/** Converts a URL to a WebSocket URL */
+export function ensureWebSocketURL(url) {
+    const p = typeof url === "string" ? new URL(ensureProtocol(url, "wss:")) : new URL(url);
+    if (p.protocol === "http:")
+        p.protocol = "ws:";
+    else if (p.protocol === "https:")
+        p.protocol = "wss:";
+    else
+        p.protocol = "wss:";
+    // return a string if a string was passed in
+    // @ts-expect-error
+    return typeof url === "string" ? p.toString() : p;
+}
 /**
  * Normalizes a string into a relay URL
  * Does not remove the trailing slash

package/package.json

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

package/dist/__tests__/index.test.js

@@ -1,17 +0,0 @@
-import { describe, expect, it } from "vitest";
-import * as core from "../index.js";
-describe("core", () => {
-    it("should export the correct functions", () => {
-        expect(Object.keys(core).sort()).toMatchInlineSnapshot(`
-      [
-        "Database",
-        "EventStore",
-        "EventStoreSymbol",
-        "Helpers",
-        "Queries",
-        "QueryStore",
-        "logger",
-      ]
-    `);
-    });
-});

package/dist/helpers/__tests__/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/helpers/__tests__/index.test.js

@@ -1,220 +0,0 @@
-import { describe, expect, it } from "vitest";
-import * as helpers from "../index.js";
-describe("helpers", () => {
-    it("should export the correct functions", () => {
-        expect(Object.keys(helpers).sort()).toMatchInlineSnapshot(`
-      [
-        "AUDIO_EXT",
-        "BLOSSOM_SERVER_LIST_KIND",
-        "BookmarkHiddenSymbol",
-        "BookmarkPublicSymbol",
-        "COMMENT_KIND",
-        "ChannelMetadataSymbol",
-        "CommentReplyPointerSymbol",
-        "CommentRootPointerSymbol",
-        "ContactsRelaysSymbol",
-        "EventContentEncryptionMethod",
-        "EventIndexableTagsSymbol",
-        "EventUIDSymbol",
-        "FAVORITE_RELAYS_KIND",
-        "FromCacheSymbol",
-        "GROUPS_LIST_KIND",
-        "GROUP_MESSAGE_KIND",
-        "GiftWrapEventSymbol",
-        "GiftWrapSealSymbol",
-        "GroupsHiddenSymbol",
-        "GroupsPublicSymbol",
-        "HiddenContactsSymbol",
-        "HiddenContentSymbol",
-        "HiddenTagsSymbol",
-        "IMAGE_EXT",
-        "LRU",
-        "MailboxesInboxesSymbol",
-        "MailboxesOutboxesSymbol",
-        "MediaAttachmentsSymbol",
-        "MuteHiddenSymbol",
-        "MutePublicSymbol",
-        "NIP05_REGEX",
-        "Nip10ThreadRefsSymbol",
-        "PICTURE_POST_KIND",
-        "ProfileContentSymbol",
-        "PublicContactsSymbol",
-        "ReplaceableIdentifierSymbol",
-        "STREAM_EXT",
-        "SeenRelaysSymbol",
-        "SharedEventSymbol",
-        "UserStatusPointerSymbol",
-        "VIDEO_EXT",
-        "ZapAddressPointerSymbol",
-        "ZapEventPointerSymbol",
-        "ZapFromSymbol",
-        "ZapInvoiceSymbol",
-        "ZapRequestSymbol",
-        "addSeenRelay",
-        "areBlossomServersEqual",
-        "canHaveHiddenContent",
-        "canHaveHiddenTags",
-        "convertToUrl",
-        "createMutedWordsRegExp",
-        "createReplaceableAddress",
-        "decodeGroupPointer",
-        "decodeLNURL",
-        "decryptDirectMessage",
-        "encodeDecodeResult",
-        "encodeGroupPointer",
-        "fakeVerifyEvent",
-        "getAddressPointerForEvent",
-        "getAddressPointerFromATag",
-        "getAddressPointersFromList",
-        "getBlossomServersFromList",
-        "getBookmarks",
-        "getCachedValue",
-        "getChannelMetadataContent",
-        "getChannelPointer",
-        "getCommentAddressPointer",
-        "getCommentEventPointer",
-        "getCommentExternalPointer",
-        "getCommentReplyPointer",
-        "getCommentRootPointer",
-        "getContacts",
-        "getContentWarning",
-        "getCoordinateFromAddressPointer",
-        "getDeleteCoordinates",
-        "getDeleteIds",
-        "getDisplayName",
-        "getEmojiTag",
-        "getEmojis",
-        "getEventPointerForEvent",
-        "getEventPointerFromETag",
-        "getEventPointerFromQTag",
-        "getEventPointerFromThreadTag",
-        "getEventPointersFromList",
-        "getEventUID",
-        "getExternalPointerFromTag",
-        "getFileMetadata",
-        "getFileMetadataFromImetaTag",
-        "getGiftWrapEvent",
-        "getGiftWrapSeal",
-        "getGroupPointerFromGroupTag",
-        "getHashtagTag",
-        "getHiddenBookmarks",
-        "getHiddenContacts",
-        "getHiddenContent",
-        "getHiddenContentEncryptionMethods",
-        "getHiddenGroups",
-        "getHiddenMutedThings",
-        "getHiddenTags",
-        "getHiddenTagsEncryptionMethods",
-        "getInboxes",
-        "getIndexableTags",
-        "getInvoice",
-        "getListTags",
-        "getMediaAttachments",
-        "getMutedThings",
-        "getNip10References",
-        "getOrComputeCachedValue",
-        "getOutboxes",
-        "getPackName",
-        "getParentEventStore",
-        "getPicturePostAttachments",
-        "getPointerForEvent",
-        "getPointerFromTag",
-        "getProfileContent",
-        "getProfilePointerFromPTag",
-        "getProfilePointersFromList",
-        "getPubkeyFromDecodeResult",
-        "getPublicBookmarks",
-        "getPublicContacts",
-        "getPublicGroups",
-        "getPublicMutedThings",
-        "getRelaysFromContactsEvent",
-        "getRelaysFromList",
-        "getReplaceableAddress",
-        "getReplaceableIdentifier",
-        "getReplaceableUID",
-        "getSeenRelays",
-        "getSha256FromURL",
-        "getTagValue",
-        "getURLFilename",
-        "getUserStatusPointer",
-        "getZapAddressPointer",
-        "getZapEventPointer",
-        "getZapPayment",
-        "getZapPreimage",
-        "getZapRecipient",
-        "getZapRequest",
-        "getZapSender",
-        "getZapSplits",
-        "hasHiddenContent",
-        "hasHiddenTags",
-        "interpretThreadTags",
-        "isATag",
-        "isAddressPointer",
-        "isAddressPointerInList",
-        "isAudioURL",
-        "isCommentAddressPointer",
-        "isCommentEventPointer",
-        "isDTag",
-        "isETag",
-        "isEvent",
-        "isEventPointer",
-        "isEventPointerInList",
-        "isFilterEqual",
-        "isFromCache",
-        "isGiftWrapLocked",
-        "isHex",
-        "isHexKey",
-        "isHiddenContentLocked",
-        "isHiddenTagsLocked",
-        "isImageURL",
-        "isNameValueTag",
-        "isNip05",
-        "isPTag",
-        "isProfilePointerInList",
-        "isRTag",
-        "isReplaceable",
-        "isSafeRelayURL",
-        "isSameURL",
-        "isSha256",
-        "isStreamURL",
-        "isTTag",
-        "isValidList",
-        "isValidProfile",
-        "isValidZap",
-        "isVideoURL",
-        "lockHiddenContent",
-        "lockHiddenTags",
-        "markFromCache",
-        "matchFilter",
-        "matchFilters",
-        "matchMutes",
-        "mergeBlossomServers",
-        "mergeBookmarks",
-        "mergeContacts",
-        "mergeFilters",
-        "mergeMutes",
-        "mergeRelaySets",
-        "normalizeURL",
-        "parseBolt11",
-        "parseBookmarkTags",
-        "parseCoordinate",
-        "parseExternalPointer",
-        "parseFileMetadataTags",
-        "parseLNURLOrAddress",
-        "parseLightningAddress",
-        "parseMutedTags",
-        "parseNIP05Address",
-        "parseSharedEvent",
-        "processTags",
-        "safeParse",
-        "setCachedValue",
-        "setEventContentEncryptionMethod",
-        "stripInvisibleChar",
-        "unixNow",
-        "unlockGiftWrap",
-        "unlockHiddenContent",
-        "unlockHiddenTags",
-      ]
-    `);
-    });
-});

package/dist/observable/__tests__/listen-latest-updates.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/observable/__tests__/listen-latest-updates.test.js

@@ -1,55 +0,0 @@
-import { beforeEach, describe, expect, it } from "vitest";
-import { subscribeSpyTo } from "@hirez_io/observer-spy";
-import { of } from "rxjs";
-import { EventStore } from "../../event-store/event-store.js";
-import { listenLatestUpdates } from "../listen-latest-updates.js";
-import { FakeUser } from "../../__tests__/fixtures.js";
-let eventStore;
-let user;
-let event;
-beforeEach(() => {
-    eventStore = new EventStore();
-    user = new FakeUser();
-    event = user.note("original content");
-});
-describe("listenLatestUpdates", () => {
-    it("should emit the initial event", () => {
-        const source = of(event);
-        const spy = subscribeSpyTo(source.pipe(listenLatestUpdates(eventStore)));
-        expect(spy.getValues()).toEqual([event]);
-    });
-    it("should emit the event again when it's updated in the event store", () => {
-        // Add the event to the store first
-        eventStore.add(event);
-        // Create a source that emits the event
-        const source = of(event);
-        const spy = subscribeSpyTo(source.pipe(listenLatestUpdates(eventStore)));
-        // Create an updated version of the event
-        Reflect.set(event, Symbol.for("new-prop"), "testing");
-        // Update the event in the store
-        eventStore.update(event);
-        // Should have received both the original and updated event
-        expect(spy.getValues()).toEqual([event, event]);
-    });
-    it("should not emit updates for other events", () => {
-        // Add the event to the store
-        eventStore.add(event);
-        // Create a source that emits the event
-        const source = of(event);
-        const spy = subscribeSpyTo(source.pipe(listenLatestUpdates(eventStore)));
-        // Create a different event
-        const otherEvent = user.note("other content");
-        // Add the other event to the store
-        eventStore.add(otherEvent);
-        // Should only have received the original event
-        expect(spy.getValues()).toEqual([event]);
-    });
-    it("should handle undefined initial event", () => {
-        const source = of(undefined);
-        const spy = subscribeSpyTo(source.pipe(listenLatestUpdates(eventStore)));
-        expect(spy.getValues()).toEqual([undefined]);
-        // Adding events to the store should not trigger emissions
-        eventStore.add(event);
-        expect(spy.getValues()).toEqual([undefined]);
-    });
-});

package/dist/observable/listen-latest-updates.d.ts

@@ -1,5 +0,0 @@
-import { NostrEvent } from "nostr-tools";
-import { MonoTypeOperatorFunction } from "rxjs";
-import { IStreamEventStore } from "../event-store/interface.js";
-/** Lists for any updates to the latest event and remits it */
-export declare function listenLatestUpdates(eventStore: IStreamEventStore): MonoTypeOperatorFunction<NostrEvent | undefined>;

package/dist/observable/listen-latest-updates.js

@@ -1,12 +0,0 @@
-import { filter, merge, tap } from "rxjs";
-/** Lists for any updates to the latest event and remits it */
-export function listenLatestUpdates(eventStore) {
-    return (source) => {
-        let latest;
-        return merge(
-        // Get the latest event
-        source.pipe(tap((value) => (latest = value))), 
-        // listen for updates
-        eventStore.updates.pipe(filter((e) => e.id === latest?.id)));
-    };
-}