@fedify/vocab 2.3.0-dev.1274 → 2.3.0-dev.1280

package/dist-tests/vocab.test.mjs

@@ -1,6 +1,6 @@
 import { Temporal } from "@js-temporal/polyfill";
 globalThis.addEventListener = () => {};
-import { C as QuoteRequest, E as Tombstone, S as QuoteAuthorization, T as Source, _ as OrderedCollectionPage, a as Create, b as Place, c as Endpoints, d as Hashtag, f as InteractionPolicy, g as Object$1, h as Note, i as Collection, k as vocab_exports, l as Follow, m as Link, n as Announce, o as CryptographicKey, p as InteractionRule, s as Delete, t as Activity, x as Question, y as Person } from "./vocab-B0Z-tH4q.mjs";
+import { C as QuoteRequest, E as Tombstone, S as QuoteAuthorization, T as Source, _ as OrderedCollectionPage, a as Create, b as Place, c as Endpoints, d as Hashtag, f as InteractionPolicy, g as Object$1, h as Note, i as Collection, k as vocab_exports, l as Follow, m as Link, n as Announce, o as CryptographicKey, p as InteractionRule, s as Delete, t as Activity, x as Question, y as Person } from "./vocab-BBRml5cy.mjs";
 import { t as assertInstanceOf } from "./utils-CE8Dk5hm.mjs";
 import { mockDocumentLoader, test } from "@fedify/fixture";
 import { deepStrictEqual, notDeepStrictEqual, ok, rejects, throws } from "node:assert/strict";
@@ -1192,6 +1192,343 @@ test("Person.fromJsonLd() with relative URLs and baseUrl", async () => {
 		baseUrl: new URL("https://example.com")
 	})).getIcon())?.url, new URL("https://example.com/avatars/test-avatar.jpg"));
 });
+test("Object.fromJsonLd() normalizes Link icon to Image", async () => {
+	const icon = await (await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"content": "Hello",
+		"icon": {
+			"type": "Link",
+			"href": "https://example.com/icon.png",
+			"mediaType": "image/png",
+			"name": "Icon",
+			"width": 64,
+			"height": 64
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader
+	})).getIcon();
+	deepStrictEqual(icon?.url?.href, "https://example.com/icon.png");
+	deepStrictEqual(icon?.mediaType, "image/png");
+	deepStrictEqual(icon?.names, ["Icon"]);
+	deepStrictEqual(icon?.width, 64);
+	deepStrictEqual(icon?.height, 64);
+});
+test("Object.fromJsonLd() normalizes Link image to Image", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"content": "Hello",
+		"image": {
+			"type": "Link",
+			"href": "https://example.com/banner.png",
+			"mediaType": "image/png",
+			"width": 800,
+			"height": 200
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader
+	});
+	const images = [];
+	for await (const img of obj.getImages()) images.push(img);
+	deepStrictEqual(images[0]?.url?.href, "https://example.com/banner.png");
+	deepStrictEqual(images[0]?.mediaType, "image/png");
+	deepStrictEqual(images[0]?.width, 800);
+	deepStrictEqual(images[0]?.height, 200);
+});
+test("Object.fromJsonLd() normalizes Link icon with relative URL", async () => {
+	deepStrictEqual((await (await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "https://example.com/notes/1",
+		"content": "Hello",
+		"icon": {
+			"type": "Link",
+			"href": "/icons/icon.png"
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader
+	})).getIcon())?.url?.href, "https://example.com/icons/icon.png");
+});
+test("Object.fromJsonLd() normalizes Link icon with relative id and baseUrl", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "/notes/1",
+		"content": "Hello",
+		"icon": {
+			"type": "Link",
+			"href": "/icons/icon.png"
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/")
+	});
+	const icon = await obj.getIcon();
+	deepStrictEqual(obj.id?.href, "https://example.com/notes/1");
+	deepStrictEqual(icon?.url?.href, "https://example.com/icons/icon.png");
+});
+test("Object.fromJsonLd() decodes Image icon with relative id and baseUrl", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "/notes/1",
+		"content": "Hello",
+		"icon": {
+			"type": "Image",
+			"url": "/icons/icon.png"
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/")
+	});
+	const icon = await obj.getIcon();
+	deepStrictEqual(obj.id?.href, "https://example.com/notes/1");
+	deepStrictEqual(icon?.url?.href, "https://example.com/icons/icon.png");
+});
+test("Object.fromJsonLd() decodes compact icon id with relative id and baseUrl", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "/notes/1",
+		"content": "Hello",
+		"icon": "/icons/icon.png"
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/")
+	});
+	deepStrictEqual(obj.id?.href, "https://example.com/notes/1");
+	deepStrictEqual(obj.iconId?.href, "https://example.com/icons/icon.png");
+});
+test("Object.fromJsonLd() resolves compact icon id against document base", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "../notes/1",
+		"content": "Hello",
+		"icon": "icon.png"
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/outbox/page.json")
+	});
+	deepStrictEqual(obj.id?.href, "https://example.com/outbox/notes/1");
+	deepStrictEqual(obj.iconId?.href, "https://example.com/outbox/icon.png");
+});
+test("Object.fromJsonLd() skips blank node compact icon id", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "/notes/1",
+		"content": "Hello",
+		"icon": { "@id": "_:b0" }
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/")
+	});
+	deepStrictEqual(obj.id?.href, "https://example.com/notes/1");
+	deepStrictEqual(obj.iconId, null);
+});
+test("Object.fromJsonLd() resolves compact icon id against baseUrl for did id", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "did:plc:example",
+		"content": "Hello",
+		"icon": "/icons/icon.png"
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/notes/1")
+	});
+	deepStrictEqual(obj.id?.href, "did:plc:example");
+	deepStrictEqual(obj.iconId?.href, "https://example.com/icons/icon.png");
+});
+test("Object.getIcon() resolves relative Link href without id via cached re-parse", async () => {
+	const icon = await (await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"content": "Hello",
+		"icon": {
+			"@context": "https://www.w3.org/ns/activitystreams",
+			"type": "Link",
+			"href": "/icons/star.png",
+			"mediaType": "image/png"
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/")
+	})).getIcon();
+	deepStrictEqual(icon?.url?.href, "https://example.com/icons/star.png");
+	deepStrictEqual(icon?.mediaType, "image/png");
+});
+test("Object.fromJsonLd() resolves Link href against document base, not object id", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "../notes/1",
+		"content": "Hello",
+		"icon": {
+			"type": "Link",
+			"href": "icon.png"
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/outbox/page.json")
+	});
+	const icon = await obj.getIcon();
+	deepStrictEqual(obj.id?.href, "https://example.com/outbox/notes/1");
+	deepStrictEqual(icon?.url?.href, "https://example.com/outbox/icon.png");
+});
+test("Object.getIcon() resolves cached relative Link href against baseUrl for did id", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "did:plc:example",
+		"content": "Hello",
+		"icon": {
+			"@context": "https://www.w3.org/ns/activitystreams",
+			"type": "Link",
+			"href": "/icons/star.png",
+			"mediaType": "image/png"
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/notes/1")
+	});
+	const icon = await obj.getIcon();
+	deepStrictEqual(obj.id?.href, "did:plc:example");
+	deepStrictEqual(icon?.url?.href, "https://example.com/icons/star.png");
+	deepStrictEqual(icon?.mediaType, "image/png");
+});
+test("Object.getIcon() ignores mutation of caller's baseUrl after fromJsonLd()", async () => {
+	const origBaseUrl = new URL("https://example.com/");
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"content": "Hello",
+		"icon": {
+			"@context": "https://www.w3.org/ns/activitystreams",
+			"type": "Link",
+			"href": "/icons/star.png",
+			"mediaType": "image/png"
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: origBaseUrl
+	});
+	origBaseUrl.href = "https://attacker.example/";
+	const icon = await obj.getIcon();
+	deepStrictEqual(icon?.url?.href, "https://example.com/icons/star.png");
+	deepStrictEqual(icon?.mediaType, "image/png");
+});
+test("Object.fromJsonLd() does not resolve blank node @id against baseUrl", async () => {
+	deepStrictEqual((await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "_:b0"
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/")
+	})).id, null);
+});
+test("Object.fromJsonLd() handles blank node @id without baseUrl", () => {
+	return Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"id": "_:b0"
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader
+	}).then((o) => deepStrictEqual(o.id, null));
+});
+test("Object.getAttachments() resolves relative url via stored _baseUrl", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"content": "Hello",
+		"attachment": {
+			"@context": "https://www.w3.org/ns/activitystreams",
+			"type": "Document",
+			"url": "/files/report.pdf",
+			"mediaType": "application/pdf"
+		}
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader,
+		baseUrl: new URL("https://example.com/")
+	});
+	const attachments = [];
+	for await (const a of obj.getAttachments()) attachments.push(a);
+	deepStrictEqual(attachments.length, 1);
+	const doc = attachments[0];
+	deepStrictEqual(doc?.url?.href, "https://example.com/files/report.pdf");
+	deepStrictEqual(doc?.mediaType, "application/pdf");
+});
+test("Object.fromJsonLd() normalizes multiple Link icons", async () => {
+	const obj = await Object$1.fromJsonLd({
+		"@context": "https://www.w3.org/ns/activitystreams",
+		"type": "Note",
+		"content": "Hello",
+		"icon": [{
+			"type": "Link",
+			"href": "https://example.com/a.png"
+		}, {
+			"type": "Image",
+			"url": "https://example.com/b.png"
+		}]
+	}, {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader
+	});
+	const icons = [];
+	for await (const i of obj.getIcons()) icons.push(i);
+	deepStrictEqual(icons.length, 2);
+	deepStrictEqual(icons[0]?.url?.href, "https://example.com/a.png");
+	deepStrictEqual(icons[1]?.url?.href, "https://example.com/b.png");
+});
+test("Object.getIcon() normalizes fetched Link document to Image", async () => {
+	const linkDocUrl = "https://example.com/icons/avatar-link";
+	const linkDoc = {
+		"@context": "https://www.w3.org/ns/activitystreams",
+		type: "Link",
+		href: "https://example.com/avatars/user.png",
+		mediaType: "image/png",
+		width: 128,
+		height: 128
+	};
+	const docLoader = async (url) => {
+		if (url === linkDocUrl) return {
+			document: linkDoc,
+			documentUrl: url,
+			contextUrl: null
+		};
+		return await mockDocumentLoader(url);
+	};
+	const icon = await new Person({
+		id: new URL("https://example.com/ap/actors/test-user"),
+		icon: new URL(linkDocUrl)
+	}).getIcon({
+		documentLoader: docLoader,
+		contextLoader: mockDocumentLoader
+	});
+	deepStrictEqual(icon?.url?.href, "https://example.com/avatars/user.png");
+	deepStrictEqual(icon?.mediaType, "image/png");
+	deepStrictEqual(icon?.width, 128);
+	deepStrictEqual(icon?.height, 128);
+});
 test("FEP-fe34: Trust tracking in object construction", async () => {
 	const note = new Note({
 		id: new URL("https://example.com/note"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab",
-  "version": "2.3.0-dev.1274+8e82de77",
+  "version": "2.3.0-dev.1280+7bca39c7",
   "homepage": "https://fedify.dev/",
   "repository": {
     "type": "git",
@@ -46,9 +46,9 @@
     "es-toolkit": "1.46.1",
     "jsonld": "^9.0.0",
     "pkijs": "^3.3.3",
-    "@fedify/vocab-tools": "2.3.0-dev.1274+8e82de77",
-    "@fedify/webfinger": "2.3.0-dev.1274+8e82de77",
-    "@fedify/vocab-runtime": "2.3.0-dev.1274+8e82de77"
+    "@fedify/vocab-tools": "2.3.0-dev.1280+7bca39c7",
+    "@fedify/vocab-runtime": "2.3.0-dev.1280+7bca39c7",
+    "@fedify/webfinger": "2.3.0-dev.1280+7bca39c7"
   },
   "devDependencies": {
     "@types/node": "^22.17.0",

package/src/mod.ts

@@ -53,6 +53,7 @@ export * from "./actor.ts";
 export * from "./constants.ts";
 export * from "./handle.ts";
 export * from "./lookup.ts";
+export * from "./preprocessors.ts";
 export * from "./type.ts";
 export * from "./vocab.ts";
 export { LanguageString } from "@fedify/vocab-runtime";

package/src/object.yaml

@@ -137,6 +137,9 @@ properties:
     (vertical) and should be suitable for presentation at a small size.
   range:
   - "https://www.w3.org/ns/activitystreams#Image"
+  preprocessors:
+  - module: ./preprocessors.ts
+    function: normalizeLinkToImage
 
 - pluralName: images
   singularName: image
@@ -149,6 +152,9 @@ properties:
     limitations assumed.
   range:
   - "https://www.w3.org/ns/activitystreams#Image"
+  preprocessors:
+  - module: ./preprocessors.ts
+    function: normalizeLinkToImage
 
 - pluralName: replyTargets
   singularName: replyTarget

package/src/preprocessors.ts

@@ -0,0 +1,48 @@
+import type { PropertyPreprocessor } from "@fedify/vocab-runtime";
+import { Image, Link } from "./vocab.ts";
+
+/**
+ * A property preprocessor that normalizes Link values to Image objects.
+ *
+ * When an `icon` or `image` property on a vocabulary object contains an
+ * explicit ActivityStreams `Link` rather than an `Image`, this preprocessor
+ * converts it into an `Image` by mapping `href` to `url`, copying
+ * `mediaType`, `name`, `width`, and `height`, and discarding the rest.
+ *
+ * If the value is not a Link, or the Link has no `href`, it returns
+ * `undefined` so the normal range decoder continues.
+ * @since 2.3.0
+ */
+export const normalizeLinkToImage: PropertyPreprocessor<Image> = async (
+  value,
+  context,
+) => {
+  if (
+    typeof value !== "object" ||
+    value === null ||
+    Array.isArray(value) ||
+    !("@type" in value) ||
+    !Array.isArray(value["@type"]) ||
+    !value["@type"].includes("https://www.w3.org/ns/activitystreams#Link")
+  ) {
+    return undefined;
+  }
+
+  let link: Link;
+  try {
+    link = await Link.fromJsonLd(value, context);
+  } catch (error) {
+    return error instanceof Error ? error : new Error(String(error));
+  }
+
+  if (link.href == null) return undefined;
+
+  return new Image({
+    id: link.id,
+    url: link.href,
+    mediaType: link.mediaType,
+    names: link.names != null && link.names.length > 0 ? link.names : undefined,
+    width: link.width,
+    height: link.height,
+  });
+};