applesauce-core 0.0.0-next-20250103191026 → 0.0.0-next-20250109205419

package/dist/helpers/file-metadata.d.ts

@@ -0,0 +1,53 @@
+import { NostrEvent } from "nostr-tools";
+export type FileMetadata = {
+    /** URL of the file */
+    url: string;
+    /** MIME type */
+    type?: string;
+    /** sha256 hash of the file */
+    sha256?: string;
+    /**
+     * The original sha256 hash before the file was transformed
+     * @deprecated
+     */
+    originalSha256?: string;
+    /** size of the file in bytes */
+    size?: number;
+    /** size of file in pixels in the form <width>x<height> */
+    dimensions?: string;
+    /** magnet */
+    magnet?: string;
+    /** torrent infohash */
+    infohash?: string;
+    /** URL to a thumbnail */
+    thumbnail?: string;
+    /** URL to a preview image with the same dimensions */
+    image?: string;
+    /** summary */
+    summary?: string;
+    /** description for accessability */
+    alt?: string;
+    /** blurhash */
+    blurhash?: string;
+    /** fallback URLs */
+    fallback?: string[];
+};
+export type MediaAttachment = FileMetadata;
+/**
+ * Parses file metadata tags into {@link FileMetadata}
+ * @throws
+ */
+export declare function parseFileMetadataTags(tags: string[][]): FileMetadata;
+/**
+ * Parses a imeta tag into a {@link FileMetadata}
+ * @throws
+ */
+export declare function getFileMetadataFromImetaTag(tag: string[]): FileMetadata;
+export declare const MediaAttachmentsSymbol: unique symbol;
+/** Gets all the media attachments on an event */
+export declare function getMediaAttachments(event: NostrEvent): FileMetadata[];
+/**
+ * Gets {@link FileMetadata} for a NIP-94 kind 1063 event
+ * @throws
+ */
+export declare function getFileMetadata(file: NostrEvent): FileMetadata;

package/dist/helpers/file-metadata.js

@@ -0,0 +1,90 @@
+import { getOrComputeCachedValue } from "./cache.js";
+/**
+ * Parses file metadata tags into {@link FileMetadata}
+ * @throws
+ */
+export function parseFileMetadataTags(tags) {
+    const fields = {};
+    let fallback = undefined;
+    for (const [name, value] of tags) {
+        switch (name) {
+            case "fallback":
+                fallback = fallback ? [...fallback, value] : [value];
+                break;
+            default:
+                fields[name] = value;
+                break;
+        }
+    }
+    if (!fields.url)
+        throw new Error("Missing required url in file metadata");
+    const metadata = { url: fields.url, fallback };
+    // parse size
+    if (fields.size)
+        metadata.size = parseInt(fields.size);
+    // copy optional fields
+    if (fields.m)
+        metadata.type = fields.m;
+    if (fields.x)
+        metadata.sha256 = fields.x;
+    if (fields.ox)
+        metadata.originalSha256 = fields.ox;
+    if (fields.dim)
+        metadata.dimensions = fields.dim;
+    if (fields.magnet)
+        metadata.magnet = fields.magnet;
+    if (fields.i)
+        metadata.infohash = fields.i;
+    if (fields.thumb)
+        metadata.thumbnail = fields.thumb;
+    if (fields.image)
+        metadata.image = fields.image;
+    if (fields.summary)
+        metadata.summary = fields.summary;
+    if (fields.alt)
+        metadata.alt = fields.alt;
+    if (fields.blurhash)
+        metadata.blurhash = fields.blurhash;
+    return metadata;
+}
+/**
+ * Parses a imeta tag into a {@link FileMetadata}
+ * @throws
+ */
+export function getFileMetadataFromImetaTag(tag) {
+    const parts = tag.slice(1);
+    const tags = [];
+    for (const part of parts) {
+        const match = part.match(/^(.+?)\s(.+)$/);
+        if (match) {
+            const [_, name, value] = match;
+            tags.push([name, value]);
+        }
+    }
+    return parseFileMetadataTags(tags);
+}
+export const MediaAttachmentsSymbol = Symbol.for("media-attachments");
+/** Gets all the media attachments on an event */
+export function getMediaAttachments(event) {
+    return getOrComputeCachedValue(event, MediaAttachmentsSymbol, () => {
+        return event.tags
+            .filter((t) => t[0] === "imeta")
+            .map((tag) => {
+            try {
+                return getFileMetadataFromImetaTag(tag);
+            }
+            catch (error) {
+                // ignore invalid attachments
+                return undefined;
+            }
+        })
+            .filter((a) => !!a);
+    });
+}
+/**
+ * Gets {@link FileMetadata} for a NIP-94 kind 1063 event
+ * @throws
+ */
+export function getFileMetadata(file) {
+    return parseFileMetadataTags(file.tags);
+}

package/dist/helpers/file-metadata.test.d.ts

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

package/dist/helpers/file-metadata.test.js

@@ -0,0 +1,103 @@
+import { describe, expect, it } from "vitest";
+import { getFileMetadataFromImetaTag, parseFileMetadataTags } from "./file-metadata.js";
+describe("file metadata helpers", () => {
+    describe("parseFileMetadataTags", () => {
+        it("should parse a simple 1060 event", () => {
+            const tags = [
+                ["url", "https://image.nostr.build/30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae.gif"],
+                ["ox", "30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae"],
+                ["fallback", "https://media.tenor.com/wpvrkjn192gAAAAC/daenerys-targaryen.gif"],
+                ["x", "77fcf42b2b720babcdbe686eff67273d8a68862d74a2672db672bc48439a3ea5"],
+                ["m", "image/gif"],
+                ["dim", "360x306"],
+                ["bh", "L38zleNL00~W^kRj0L-p0KM_^kx]"],
+                ["blurhash", "L38zleNL00~W^kRj0L-p0KM_^kx]"],
+                [
+                    "thumb",
+                    "https://image.nostr.build/thumb/30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae.gif",
+                ],
+                ["t", "gifbuddy"],
+                ["summary", "Khaleesi call dragons Daenerys Targaryen"],
+                ["alt", "a woman with blonde hair and a brooch on her shoulder"],
+                [
+                    "thumb",
+                    "https://media.tenor.com/wpvrkjn192gAAAAx/daenerys-targaryen.webp",
+                    "5d92423664fc15874b1d26c70a05a541ec09b5c438bf157977a87c8e64b31463",
+                ],
+                [
+                    "image",
+                    "https://media.tenor.com/wpvrkjn192gAAAAe/daenerys-targaryen.png",
+                    "5d92423664fc15874b1d26c70a05a541ec09b5c438bf157977a87c8e64b31463",
+                ],
+            ];
+            expect(parseFileMetadataTags(tags)).toEqual({
+                url: "https://image.nostr.build/30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae.gif",
+                type: "image/gif",
+                dimensions: "360x306",
+                blurhash: "L38zleNL00~W^kRj0L-p0KM_^kx]",
+                sha256: "77fcf42b2b720babcdbe686eff67273d8a68862d74a2672db672bc48439a3ea5",
+                originalSha256: "30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae",
+                thumbnail: "https://media.tenor.com/wpvrkjn192gAAAAx/daenerys-targaryen.webp",
+                image: "https://media.tenor.com/wpvrkjn192gAAAAe/daenerys-targaryen.png",
+                summary: "Khaleesi call dragons Daenerys Targaryen",
+                fallback: ["https://media.tenor.com/wpvrkjn192gAAAAC/daenerys-targaryen.gif"],
+                alt: "a woman with blonde hair and a brooch on her shoulder",
+            });
+        });
+    });
+    describe("getFileMetadataFromImetaTag", () => {
+        it("should parse simple imeta tag", () => {
+            expect(getFileMetadataFromImetaTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+            });
+        });
+        it("should parse thumbnail url", () => {
+            expect(getFileMetadataFromImetaTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                "thumb https://exmaple.com/thumb.jpg",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                thumbnail: "https://exmaple.com/thumb.jpg",
+            });
+        });
+        it("should parse multiple fallback urls", () => {
+            expect(getFileMetadataFromImetaTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                "fallback https://exmaple.com/image2.jpg",
+                "fallback https://exmaple.com/image3.jpg",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                fallback: ["https://exmaple.com/image2.jpg", "https://exmaple.com/image3.jpg"],
+            });
+        });
+    });
+});

package/dist/helpers/index.d.ts

@@ -13,7 +13,8 @@ export * from "./json.js";
 export * from "./lnurl.js";
 export * from "./lru.js";
 export * from "./mailboxes.js";
-export * from "./media-attachment.js";
+export * from "./file-metadata.js";
+export * from "./picture-post.js";
 export * from "./pointers.js";
 export * from "./profile.js";
 export * from "./relays.js";

package/dist/helpers/index.js

@@ -13,7 +13,8 @@ export * from "./json.js";
 export * from "./lnurl.js";
 export * from "./lru.js";
 export * from "./mailboxes.js";
-export * from "./media-attachment.js";
+export * from "./file-metadata.js";
+export * from "./picture-post.js";
 export * from "./pointers.js";
 export * from "./profile.js";
 export * from "./relays.js";

package/dist/helpers/media-attachment.d.ts

@@ -2,10 +2,15 @@ import { NostrEvent } from "nostr-tools";
 export type MediaAttachment = {
     /** URL of the file */
     url: string;
-    /** mime type */
+    /** MIME type */
     type?: string;
     /** sha256 hash of the file */
     sha256?: string;
+    /**
+     * The original sha256 hash before the file was transformed
+     * @deprecated
+     */
+    originalSha256?: string;
     /** size of the file in bytes */
     size?: number;
     /** size of file in pixels in the form <width>x<height> */
@@ -15,13 +20,17 @@ export type MediaAttachment = {
     /** torrent infohash */
     infohash?: string;
     /** URL to a thumbnail */
-    thumb?: string;
+    thumbnail?: string;
     /** URL to a preview image with the same dimensions */
     image?: string;
     /** summary */
     summary?: string;
     /** description for accessability */
     alt?: string;
+    /** blurhash */
+    blurhash?: string;
+    /** fallback URLs */
+    fallback?: string[];
 };
 /**
  * Parses a imeta tag into a {@link MediaAttachment}

package/dist/helpers/media-attachment.js

@@ -6,16 +6,24 @@ import { getOrComputeCachedValue } from "./cache.js";
 export function parseMediaAttachmentTag(tag) {
     const parts = tag.slice(1);
     const fields = {};
+    let fallback = undefined;
     for (const part of parts) {
         const match = part.match(/^(.+?)\s(.+)$/);
         if (match) {
             const [_, name, value] = match;
-            fields[name] = value;
+            switch (name) {
+                case "fallback":
+                    fallback = fallback ? [...fallback, value] : [value];
+                    break;
+                default:
+                    fields[name] = value;
+                    break;
+            }
         }
     }
     if (!fields.url)
         throw new Error("Missing required url in attachment");
-    const attachment = { url: fields.url };
+    const attachment = { url: fields.url, fallback };
     // parse size
     if (fields.size)
         attachment.size = parseInt(fields.size);
@@ -24,6 +32,8 @@ export function parseMediaAttachmentTag(tag) {
         attachment.type = fields.m;
     if (fields.x)
         attachment.sha256 = fields.x;
+    if (fields.ox)
+        attachment.originalSha256 = fields.ox;
     if (fields.dim)
         attachment.dimensions = fields.dim;
     if (fields.magnet)
@@ -31,13 +41,15 @@ export function parseMediaAttachmentTag(tag) {
     if (fields.i)
         attachment.infohash = fields.i;
     if (fields.thumb)
-        attachment.thumb = fields.thumb;
+        attachment.thumbnail = fields.thumb;
     if (fields.image)
         attachment.image = fields.image;
     if (fields.summary)
         attachment.summary = fields.summary;
     if (fields.alt)
         attachment.alt = fields.alt;
+    if (fields.blurhash)
+        attachment.blurhash = fields.blurhash;
     return attachment;
 }
 export const MediaAttachmentsSymbol = Symbol.for("media-attachments");

package/dist/helpers/media-attachment.test.d.ts

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

package/dist/helpers/media-attachment.test.js

@@ -0,0 +1,59 @@
+import { describe, expect, it } from "vitest";
+import { parseMediaAttachmentTag } from "./media-attachment.js";
+describe("media attachment helpers", () => {
+    describe("parseMediaAttachmentTag", () => {
+        it("should parse simple imeta tag", () => {
+            expect(parseMediaAttachmentTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+            });
+        });
+        it("should parse thumbnail url", () => {
+            expect(parseMediaAttachmentTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                "thumb https://exmaple.com/thumb.jpg",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                thumbnail: "https://exmaple.com/thumb.jpg",
+            });
+        });
+        it("should parse multiple fallback urls", () => {
+            expect(parseMediaAttachmentTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                "fallback https://exmaple.com/image2.jpg",
+                "fallback https://exmaple.com/image3.jpg",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                fallback: ["https://exmaple.com/image2.jpg", "https://exmaple.com/image3.jpg"],
+            });
+        });
+    });
+});

package/dist/helpers/media-post.d.ts

@@ -0,0 +1,4 @@
+import { NostrEvent } from "nostr-tools";
+export declare const MEDIA_POST_KIND = 20;
+/** Return the media attachments from a kind 20 media post */
+export declare function getMediaPostAttachments(post: NostrEvent): import("./file-metadata.js").FileMetadata[];

package/dist/helpers/media-post.js

@@ -0,0 +1,6 @@
+import { getMediaAttachments } from "./file-metadata.js";
+export const MEDIA_POST_KIND = 20;
+/** Return the media attachments from a kind 20 media post */
+export function getMediaPostAttachments(post) {
+    return getMediaAttachments(post);
+}

package/dist/helpers/picture-post.d.ts

@@ -0,0 +1,4 @@
+import { NostrEvent } from "nostr-tools";
+export declare const PICTURE_POST_KIND = 20;
+/** Return the media attachments from a kind 20 media post */
+export declare function getPicturePostAttachments(post: NostrEvent): import("./file-metadata.js").FileMetadata[];

package/dist/helpers/picture-post.js

@@ -0,0 +1,6 @@
+import { getMediaAttachments } from "./file-metadata.js";
+export const PICTURE_POST_KIND = 20;
+/** Return the media attachments from a kind 20 media post */
+export function getPicturePostAttachments(post) {
+    return getMediaAttachments(post);
+}

package/package.json

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