applesauce-core 0.4.0 → 0.5.0

package/dist/helpers/index.d.ts

@@ -5,3 +5,4 @@ export * from "./filter.js";
 export * from "./mailboxes.js";
 export * from "./threading.js";
 export * from "./pointers.js";
+export * from "./string.js";

package/dist/helpers/index.js

@@ -5,3 +5,4 @@ export * from "./filter.js";
 export * from "./mailboxes.js";
 export * from "./threading.js";
 export * from "./pointers.js";
+export * from "./string.js";

package/dist/helpers/string.d.ts

@@ -0,0 +1,2 @@
+export declare function isHex(str?: string): boolean;
+export declare function isHexKey(key?: string): boolean;

package/dist/helpers/string.js

@@ -0,0 +1,10 @@
+export function isHex(str) {
+    if (str?.match(/^[0-9a-f]+$/i))
+        return true;
+    return false;
+}
+export function isHexKey(key) {
+    if (key?.toLowerCase()?.match(/^[0-9a-f]{64}$/))
+        return true;
+    return false;
+}

package/dist/promise/deferred.d.ts

@@ -2,4 +2,4 @@ export type Deferred<T> = Promise<T> & {
     resolve: (value?: T | PromiseLike<T>) => void;
     reject: (reason?: any) => void;
 };
-export default function createDefer<T>(): Deferred<T>;
+export declare function createDefer<T>(): Deferred<T>;

package/dist/promise/deferred.js

@@ -1,4 +1,4 @@
-export default function createDefer() {
+export function createDefer() {
     let _resolve;
     let _reject;
     const promise = new Promise((resolve, reject) => {

package/dist/queries/index.d.ts

@@ -2,6 +2,5 @@ export * from "./simple.js";
 export * from "./profile.js";
 export * from "./mailboxes.js";
 export * from "./reactions.js";
-export * from "./channel.js";
 export * from "./mute.js";
 export * from "./thread.js";

package/dist/queries/index.js

@@ -2,6 +2,5 @@ export * from "./simple.js";
 export * from "./profile.js";
 export * from "./mailboxes.js";
 export * from "./reactions.js";
-export * from "./channel.js";
 export * from "./mute.js";
 export * from "./thread.js";

package/dist/queries/simple.d.ts

@@ -1,5 +1,10 @@
 import { Filter, NostrEvent } from "nostr-tools";
 import { Query } from "../query-store/index.js";
+/** Creates a Query that returns a single event or undefined */
 export declare function SingleEventQuery(uid: string): Query<NostrEvent | undefined>;
+/** Creates a Query returning the latest version of a replaceable event */
 export declare function ReplaceableQuery(kind: number, pubkey: string, d?: string): Query<NostrEvent | undefined>;
+/** Creates a Query that returns an array of sorted events matching the filters */
 export declare function TimelineQuery(filters: Filter | Filter[]): Query<NostrEvent[]>;
+/** Creates a Query that returns a directory of events by their UID */
+export declare function ReplaceableSetQuery(filters: Filter | Filter[]): Query<Record<string, NostrEvent>>;

package/dist/queries/simple.js

@@ -1,20 +1,32 @@
 import stringify from "json-stringify-deterministic";
-import { getReplaceableUID } from "../helpers/event.js";
+import { getEventUID, getReplaceableUID } from "../helpers/event.js";
+/** Creates a Query that returns a single event or undefined */
 export function SingleEventQuery(uid) {
     return {
         key: uid,
         run: (events) => events.event(uid),
     };
 }
+/** Creates a Query returning the latest version of a replaceable event */
 export function ReplaceableQuery(kind, pubkey, d) {
     return {
         key: getReplaceableUID(kind, pubkey, d),
         run: (events) => events.replaceable(kind, pubkey, d),
     };
 }
+/** Creates a Query that returns an array of sorted events matching the filters */
 export function TimelineQuery(filters) {
     return {
         key: stringify(filters),
         run: (events) => events.timeline(Array.isArray(filters) ? filters : [filters]),
     };
 }
+/** Creates a Query that returns a directory of events by their UID */
+export function ReplaceableSetQuery(filters) {
+    return {
+        key: stringify(filters),
+        run: (events) => events
+            .timeline(Array.isArray(filters) ? filters : [filters])
+            .map((events) => events.reduce((dir, event) => ({ ...dir, [getEventUID(event)]: event }), {})),
+    };
+}

package/dist/query-store/index.d.ts

@@ -23,6 +23,8 @@ export declare class QueryStore {
     event(id: string): Observable<import("nostr-tools").Event | undefined>;
     /** Returns the latest version of a replaceable event */
     replaceable(kind: number, pubkey: string, d?: string): Observable<import("nostr-tools").Event | undefined>;
+    /** Returns a directory of events by their UID */
+    replaceableSet(filters: Filter | Filter[]): Observable<Record<string, import("nostr-tools").Event>>;
     /** Returns an array of events that match the filter */
     timeline(filters: Filter | Filter[]): Observable<import("nostr-tools").Event[]>;
     /** Returns the parsed profile (0) for a pubkey */

package/dist/query-store/index.js

@@ -29,6 +29,10 @@ export class QueryStore {
     replaceable(kind, pubkey, d) {
         return this.runQuery(Queries.ReplaceableQuery)(kind, pubkey, d);
     }
+    /** Returns a directory of events by their UID */
+    replaceableSet(filters) {
+        return this.runQuery(Queries.ReplaceableSetQuery)(filters);
+    }
     /** Returns an array of events that match the filter */
     timeline(filters) {
         return this.runQuery(Queries.TimelineQuery)(filters);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -22,10 +22,18 @@
       "import": "./dist/helpers/index.js",
       "types": "./dist/helpers/index.d.ts"
     },
+    "./queries": {
+      "import": "./dist/queries/index.js",
+      "types": "./dist/queries/index.d.ts"
+    },
     "./observable": {
       "import": "./dist/observable/index.js",
       "types": "./dist/observable/index.d.ts"
     },
+    "./promise": {
+      "import": "./dist/promise/index.js",
+      "types": "./dist/promise/index.d.ts"
+    },
     "./query-store": {
       "import": "./dist/query-store/index.js",
       "types": "./dist/query-store/index.d.ts"
@@ -33,28 +41,24 @@
     "./event-store": {
       "import": "./dist/event-store/index.js",
       "types": "./dist/event-store/index.d.ts"
-    },
-    "./queries": {
-      "import": "./dist/queries/index.js",
-      "types": "./dist/queries/index.d.ts"
     }
   },
   "dependencies": {
-    "@types/zen-push": "^0.1.4",
     "debug": "^4.3.7",
     "json-stringify-deterministic": "^1.0.12",
     "nanoid": "^5.0.7",
     "nostr-tools": "^2.7.2",
-    "zen-push": "^0.3.1"
+    "zen-push": "^0.3.1",
+    "zen-observable": "^0.10.0"
   },
   "devDependencies": {
+    "@types/zen-push": "^0.1.4",
     "@jest/globals": "^29.7.0",
     "@types/debug": "^4.1.12",
     "@types/jest": "^29.5.13",
     "@types/zen-observable": "^0.8.7",
     "jest": "^29.7.0",
-    "jest-extended": "^4.0.2",
-    "zen-observable": "^0.10.0"
+    "jest-extended": "^4.0.2"
   },
   "jest": {
     "roots": [

package/dist/helpers/channel.d.ts

@@ -1,15 +0,0 @@
-import { nip19, NostrEvent } from "nostr-tools";
-import { ChannelMetadata } from "nostr-tools/nip28";
-export declare const ChannelMetadataSymbol: unique symbol;
-declare module "nostr-tools" {
-    interface Event {
-        [ChannelMetadataSymbol]?: ChannelMetadataContent;
-    }
-}
-export type ChannelMetadataContent = ChannelMetadata & {
-    relays?: string[];
-};
-/** Gets the parsed metadata on a channel creation or channel metadata event */
-export declare function getChannelMetadataContent(channel: NostrEvent): ChannelMetadataContent;
-/** gets the EventPointer for a channel message or metadata event */
-export declare function getChannelPointer(event: NostrEvent): nip19.EventPointer | undefined;

package/dist/helpers/channel.js

@@ -1,27 +0,0 @@
-export const ChannelMetadataSymbol = Symbol.for("channel-metadata");
-function parseChannelMetadataContent(channel) {
-    const metadata = JSON.parse(channel.content);
-    if (metadata.name === undefined)
-        throw new Error("Missing name");
-    if (metadata.about === undefined)
-        throw new Error("Missing about");
-    if (metadata.picture === undefined)
-        throw new Error("Missing picture");
-    if (metadata.relays && !Array.isArray(metadata.relays))
-        throw new Error("Invalid relays");
-    return metadata;
-}
-/** Gets the parsed metadata on a channel creation or channel metadata event */
-export function getChannelMetadataContent(channel) {
-    let metadata = channel[ChannelMetadataSymbol];
-    if (!metadata)
-        metadata = channel[ChannelMetadataSymbol] = parseChannelMetadataContent(channel);
-    return metadata;
-}
-/** gets the EventPointer for a channel message or metadata event */
-export function getChannelPointer(event) {
-    const tag = event.tags.find((t) => t[0] === "e" && t[1]);
-    if (!tag)
-        return undefined;
-    return tag[2] ? { id: tag[1], relays: [tag[2]] } : { id: tag[1] };
-}

package/dist/queries/channel.d.ts

@@ -1,11 +0,0 @@
-import { NostrEvent } from "nostr-tools";
-import { Query } from "../query-store/index.js";
-import { ChannelMetadataContent } from "../helpers/channel.js";
-/** Creates a query that returns the latest parsed metadata */
-export declare function ChannelMetadataQuery(channel: NostrEvent): Query<ChannelMetadataContent | undefined>;
-/** Creates a query that returns a map of hidden messages Map<id, reason> */
-export declare function ChannelHiddenQuery(channel: NostrEvent, authors?: string[]): Query<Map<string, string>>;
-/** Creates a query that returns a map of muted users Map<pubkey, reason> */
-export declare function ChannelMutedQuery(channel: NostrEvent, authors?: string[]): Query<Map<string, string>>;
-/** Creates a query that returns all messages in a channel */
-export declare function ChannelMessagesQuery(channel: NostrEvent): Query<NostrEvent[]>;

package/dist/queries/channel.js

@@ -1,72 +0,0 @@
-import { kinds } from "nostr-tools";
-import { getChannelMetadataContent } from "../helpers/channel.js";
-import { safeParse } from "../helpers/json.js";
-/** Creates a query that returns the latest parsed metadata */
-export function ChannelMetadataQuery(channel) {
-    return {
-        key: channel.id,
-        run: (events) => {
-            const filters = [
-                { ids: [channel.id] },
-                { kinds: [kinds.ChannelMetadata], "#e": [channel.id], authors: [channel.pubkey] },
-            ];
-            let latest = channel;
-            return events.stream(filters).map((event) => {
-                try {
-                    if (event.pubkey === latest.pubkey && event.created_at > latest.created_at) {
-                        latest = event;
-                    }
-                    return getChannelMetadataContent(latest);
-                }
-                catch (error) {
-                    return undefined;
-                }
-            });
-        },
-    };
-}
-/** Creates a query that returns a map of hidden messages Map<id, reason> */
-export function ChannelHiddenQuery(channel, authors = []) {
-    return {
-        key: channel.id,
-        run: (events) => {
-            const hidden = new Map();
-            return events
-                .stream([{ kinds: [kinds.ChannelHideMessage], "#e": [channel.id], authors: [channel.pubkey, ...authors] }])
-                .map((event) => {
-                const reason = safeParse(event.content)?.reason;
-                for (const tag of event.tags) {
-                    if (tag[0] === "e" && tag[1])
-                        hidden.set(tag[1], reason ?? "");
-                }
-                return hidden;
-            });
-        },
-    };
-}
-/** Creates a query that returns a map of muted users Map<pubkey, reason> */
-export function ChannelMutedQuery(channel, authors = []) {
-    return {
-        key: channel.id + authors.join(","),
-        run: (events) => {
-            const muted = new Map();
-            return events
-                .stream([{ kinds: [kinds.ChannelMuteUser], "#e": [channel.id], authors: [channel.pubkey, ...authors] }])
-                .map((event) => {
-                const reason = safeParse(event.content)?.reason;
-                for (const tag of event.tags) {
-                    if (tag[0] === "p" && tag[1])
-                        muted.set(tag[1], reason ?? "");
-                }
-                return muted;
-            });
-        },
-    };
-}
-/** Creates a query that returns all messages in a channel */
-export function ChannelMessagesQuery(channel) {
-    return {
-        key: channel.id,
-        run: (events) => events.timeline([{ kinds: [kinds.ChannelMessage], "#e": [channel.id] }]),
-    };
-}