@fedify/fedify 1.6.0-dev.814 → 1.6.0-experiment.0

package/dist/vocab/lookup.js

@@ -0,0 +1,162 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { deno_default } from "../deno.js";
+import { getTypeId } from "./type.js";
+import { getDocumentLoader } from "../runtime/docloader.js";
+import { Object as Object$1 } from "./vocab.js";
+import { lookupWebFinger } from "../webfinger/lookup.js";
+import { getLogger } from "@logtape/logtape";
+import { SpanStatusCode, trace } from "@opentelemetry/api";
+import { delay } from "@es-toolkit/es-toolkit";
+
+//#region vocab/lookup.ts
+const logger = getLogger([
+	"fedify",
+	"vocab",
+	"lookup"
+]);
+const handleRegexp = /^@?((?:[-A-Za-z0-9._~!$&'()*+,;=]|%[A-Fa-f0-9]{2})+)@([^@]+)$/;
+/**
+* Looks up an ActivityStreams object by its URI (including `acct:` URIs)
+* or a fediverse handle (e.g., `@user@server` or `user@server`).
+*
+* @example
+* ``` typescript
+* // Look up an actor by its fediverse handle:
+* await lookupObject("@hongminhee@fosstodon.org");
+* // returning a `Person` object.
+*
+* // A fediverse handle can omit the leading '@':
+* await lookupObject("hongminhee@fosstodon.org");
+* // returning a `Person` object.
+*
+* // A `acct:` URI can be used as well:
+* await lookupObject("acct:hongminhee@fosstodon.org");
+* // returning a `Person` object.
+*
+* // Look up an object by its URI:
+* await lookupObject("https://todon.eu/@hongminhee/112060633798771581");
+* // returning a `Note` object.
+*
+* // It can be a `URL` object as well:
+* await lookupObject(new URL("https://todon.eu/@hongminhee/112060633798771581"));
+* // returning a `Note` object.
+* ```
+*
+* @param identifier The URI or fediverse handle to look up.
+* @param options Lookup options.
+* @returns The object, or `null` if not found.
+* @since 0.2.0
+*/
+async function lookupObject(identifier, options = {}) {
+	const tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
+	const tracer = tracerProvider.getTracer(deno_default.name, deno_default.version);
+	return await tracer.startActiveSpan("activitypub.lookup_object", async (span) => {
+		try {
+			const result = await lookupObjectInternal(identifier, options);
+			if (result == null) span.setStatus({ code: SpanStatusCode.ERROR });
+			else {
+				if (result.id != null) span.setAttribute("activitypub.object.id", result.id.href);
+				span.setAttribute("activitypub.object.type", getTypeId(result).href);
+				if (result.replyTargetIds.length > 0) span.setAttribute("activitypub.object.in_reply_to", result.replyTargetIds.map((id) => id.href));
+			}
+			return result;
+		} catch (error) {
+			span.setStatus({
+				code: SpanStatusCode.ERROR,
+				message: String(error)
+			});
+			throw error;
+		} finally {
+			span.end();
+		}
+	});
+}
+async function lookupObjectInternal(identifier, options = {}) {
+	const documentLoader = options.documentLoader ?? getDocumentLoader({ userAgent: options.userAgent });
+	if (typeof identifier === "string") {
+		const match = handleRegexp.exec(identifier);
+		if (match) identifier = `acct:${match[1]}@${match[2]}`;
+		identifier = new URL(identifier);
+	}
+	let document = null;
+	if (identifier.protocol === "http:" || identifier.protocol === "https:") try {
+		const remoteDoc = await documentLoader(identifier.href);
+		document = remoteDoc.document;
+	} catch (error) {
+		logger.debug("Failed to fetch remote document:\n{error}", { error });
+	}
+	if (document == null) {
+		const jrd = await lookupWebFinger(identifier, {
+			userAgent: options.userAgent,
+			tracerProvider: options.tracerProvider,
+			allowPrivateAddress: "allowPrivateAddress" in options && options.allowPrivateAddress === true
+		});
+		if (jrd?.links == null) return null;
+		for (const l of jrd.links) {
+			if (l.type !== "application/activity+json" && !l.type?.match(/application\/ld\+json;\s*profile="https:\/\/www.w3.org\/ns\/activitystreams"/) || l.rel !== "self") continue;
+			try {
+				const remoteDoc = await documentLoader(l.href);
+				document = remoteDoc.document;
+				break;
+			} catch (error) {
+				logger.debug("Failed to fetch remote document:\n{error}", { error });
+				continue;
+			}
+		}
+	}
+	if (document == null) return null;
+	try {
+		return await Object$1.fromJsonLd(document, {
+			documentLoader,
+			contextLoader: options.contextLoader,
+			tracerProvider: options.tracerProvider
+		});
+	} catch (error) {
+		if (error instanceof TypeError) {
+			logger.debug("Failed to parse JSON-LD document: {error}\n{document}", {
+				error,
+				document
+			});
+			return null;
+		}
+		throw error;
+	}
+}
+/**
+* Traverses a collection, yielding each item in the collection.
+* If the collection is paginated, it will fetch the next page
+* automatically.
+*
+* @example
+* ``` typescript
+* const collection = await lookupObject(collectionUrl);
+* if (collection instanceof Collection) {
+*   for await (const item of traverseCollection(collection)) {
+*     console.log(item.id?.href);
+*   }
+* }
+* ```
+*
+* @param collection The collection to traverse.
+* @param options Options for traversing the collection.
+* @returns An async iterable of each item in the collection.
+* @since 1.1.0
+*/
+async function* traverseCollection(collection, options = {}) {
+	if (collection.firstId == null) for await (const item of collection.getItems(options)) yield item;
+	else {
+		const interval = Temporal.Duration.from(options.interval ?? { seconds: 0 }).total("millisecond");
+		let page = await collection.getFirst(options);
+		while (page != null) {
+			for await (const item of page.getItems(options)) yield item;
+			if (interval > 0) await delay(interval);
+			page = await page.getNext(options);
+		}
+	}
+}
+
+//#endregion
+export { lookupObject, traverseCollection };

package/dist/vocab/lookup.test.d.ts

@@ -0,0 +1,2 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";

package/dist/vocab/lookup.test.js

@@ -0,0 +1,113 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { Collection, Note, Object as Object$1, Person } from "./vocab.js";
+import { lookupObject, traverseCollection } from "./lookup.js";
+import { assertEquals } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_equals.js";
+import { assertInstanceOf } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_instance_of.js";
+import { test } from "../testing/mod.js";
+import { mockDocumentLoader } from "../testing/docloader.js";
+import { install, mock, uninstall } from "../node_modules/.pnpm/@jsr_hongminhee__deno-mock-fetch@0.3.2/node_modules/@jsr/hongminhee__deno-mock-fetch/mod.js";
+
+//#region vocab/lookup.test.ts
+test("lookupObject()", async (t) => {
+	install();
+	mock("GET@/.well-known/webfinger", (req) => {
+		assertEquals(new URL(req.url).host, "example.com");
+		return new Response(JSON.stringify({
+			subject: "acct:johndoe@example.com",
+			links: [
+				{
+					rel: "alternate",
+					href: "https://example.com/object",
+					type: "application/activity+json"
+				},
+				{
+					rel: "self",
+					href: "https://example.com/html/person",
+					type: "text/html"
+				},
+				{
+					rel: "self",
+					href: "https://example.com/person",
+					type: "application/activity+json"
+				}
+			]
+		}));
+	});
+	const options = {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader
+	};
+	await t.step("actor", async () => {
+		const person = await lookupObject("@johndoe@example.com", options);
+		assertInstanceOf(person, Person);
+		assertEquals(person.id, new URL("https://example.com/person"));
+		assertEquals(person.name, "John Doe");
+		const person2 = await lookupObject("johndoe@example.com", options);
+		assertEquals(person2, person);
+		const person3 = await lookupObject("acct:johndoe@example.com", options);
+		assertEquals(person3, person);
+	});
+	await t.step("object", async () => {
+		const object = await lookupObject("https://example.com/object", options);
+		assertInstanceOf(object, Object$1);
+		assertEquals(object, new Object$1({
+			id: new URL("https://example.com/object"),
+			name: "Fetched object"
+		}));
+		const person = await lookupObject("https://example.com/hong-gildong", options);
+		assertInstanceOf(person, Person);
+		assertEquals(person, new Person({
+			id: new URL("https://example.com/hong-gildong"),
+			name: "Hong Gildong"
+		}));
+	});
+	mock("GET@/.well-known/webfinger", (req) => {
+		assertEquals(new URL(req.url).host, "example.com");
+		return new Response(JSON.stringify({
+			subject: "acct:janedoe@example.com",
+			links: [{
+				rel: "self",
+				href: "https://example.com/404",
+				type: "application/activity+json"
+			}]
+		}));
+	});
+	await t.step("not found", async () => {
+		assertEquals(await lookupObject("janedoe@example.com", options), null);
+		assertEquals(await lookupObject("https://example.com/404", options), null);
+	});
+	uninstall();
+});
+test("traverseCollection()", async () => {
+	const options = {
+		documentLoader: mockDocumentLoader,
+		contextLoader: mockDocumentLoader
+	};
+	const collection = await lookupObject("https://example.com/collection", options);
+	assertInstanceOf(collection, Collection);
+	assertEquals(await Array.fromAsync(traverseCollection(collection, options)), [
+		new Note({ content: "This is a simple note" }),
+		new Note({ content: "This is another simple note" }),
+		new Note({ content: "This is a third simple note" })
+	]);
+	const pagedCollection = await lookupObject("https://example.com/paged-collection", options);
+	assertInstanceOf(pagedCollection, Collection);
+	assertEquals(await Array.fromAsync(traverseCollection(pagedCollection, options)), [
+		new Note({ content: "This is a simple note" }),
+		new Note({ content: "This is another simple note" }),
+		new Note({ content: "This is a third simple note" })
+	]);
+	assertEquals(await Array.fromAsync(traverseCollection(pagedCollection, {
+		...options,
+		interval: { milliseconds: 250 }
+	})), [
+		new Note({ content: "This is a simple note" }),
+		new Note({ content: "This is another simple note" }),
+		new Note({ content: "This is a third simple note" })
+	]);
+});
+
+//#endregion

package/dist/vocab/mod.d.ts

@@ -0,0 +1,8 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";
+import { Accept$1 as Accept, Activity$1 as Activity, Add$1 as Add, Announce$1 as Announce, Application$1 as Application, Arrive$1 as Arrive, Article$1 as Article, Audio$1 as Audio, Block$1 as Block, ChatMessage$1 as ChatMessage, Collection$1 as Collection, CollectionPage$1 as CollectionPage, Create$1 as Create, CryptographicKey$1 as CryptographicKey, DataIntegrityProof$1 as DataIntegrityProof, Delete$1 as Delete, DidService$1 as DidService, Dislike$1 as Dislike, Document$1 as Document, Emoji$1 as Emoji, EmojiReact$1 as EmojiReact, Endpoints$1 as Endpoints, Event$1 as Event, Export$1 as Export, Flag$1 as Flag, Follow$1 as Follow, Group$1 as Group, Hashtag$1 as Hashtag, Ignore$1 as Ignore, Image$1 as Image, IntransitiveActivity$1 as IntransitiveActivity, Invite$1 as Invite, Join$1 as Join, Leave$1 as Leave, Like$1 as Like, Link$2 as Link, Listen$1 as Listen, Mention$1 as Mention, Move$1 as Move, Multikey$1 as Multikey, Note$1 as Note, Object$1, Offer$1 as Offer, OrderedCollection$1 as OrderedCollection, OrderedCollectionPage$1 as OrderedCollectionPage, Organization$1 as Organization, Page$1 as Page, Person$1 as Person, Place$1 as Place, Profile$1 as Profile, PropertyValue$1 as PropertyValue, Question$1 as Question, Read$1 as Read, Reject$1 as Reject, Relationship$1 as Relationship, Remove$1 as Remove, Service$1 as Service, Source$1 as Source, TentativeAccept$1 as TentativeAccept, TentativeReject$1 as TentativeReject, Tombstone$1 as Tombstone, Travel$1 as Travel, Undo$1 as Undo, Update$1 as Update, Video$1 as Video, View$1 as View } from "./vocab.js";
+import { Actor, ActorTypeName, GetActorHandleOptions, NormalizeActorHandleOptions, Recipient, getActorClassByTypeName$1 as getActorClassByTypeName, getActorHandle$1 as getActorHandle, getActorTypeName$1 as getActorTypeName, isActor$1 as isActor, normalizeActorHandle$1 as normalizeActorHandle } from "./actor.js";
+import { LookupObjectOptions, TraverseCollectionOptions, lookupObject$1 as lookupObject, traverseCollection$1 as traverseCollection } from "./lookup.js";
+import { PUBLIC_COLLECTION$1 as PUBLIC_COLLECTION } from "./constants.js";
+import { getTypeId$1 as getTypeId } from "./type.js";
+export { Accept, Activity, Actor, ActorTypeName, Add, Announce, Application, Arrive, Article, Audio, Block, ChatMessage, Collection, CollectionPage, Create, CryptographicKey, DataIntegrityProof, Delete, DidService, Dislike, Document, Emoji, EmojiReact, Endpoints, Event, Export, Flag, Follow, GetActorHandleOptions, Group, Hashtag, Ignore, Image, IntransitiveActivity, Invite, Join, Leave, Like, Link, Listen, LookupObjectOptions, Mention, Move, Multikey, NormalizeActorHandleOptions, Note, Object$1 as Object, Offer, OrderedCollection, OrderedCollectionPage, Organization, PUBLIC_COLLECTION, Page, Person, Place, Profile, PropertyValue, Question, Read, Recipient, Reject, Relationship, Remove, Service, Source, TentativeAccept, TentativeReject, Tombstone, Travel, TraverseCollectionOptions, Undo, Update, Video, View, getActorClassByTypeName, getActorHandle, getActorTypeName, getTypeId, isActor, lookupObject, normalizeActorHandle, traverseCollection };

package/dist/vocab/mod.js

@@ -0,0 +1,11 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { getTypeId } from "./type.js";
+import { Accept, Activity, Add, Announce, Application, Arrive, Article, Audio, Block, ChatMessage, Collection, CollectionPage, Create, CryptographicKey, DataIntegrityProof, Delete, DidService, Dislike, Document, Emoji, EmojiReact, Endpoints, Event, Export, Flag, Follow, Group, Hashtag, Ignore, Image, IntransitiveActivity, Invite, Join, Leave, Like, Link, Listen, Mention, Move, Multikey, Note, Object as Object$1, Offer, OrderedCollection, OrderedCollectionPage, Organization, Page, Person, Place, Profile, PropertyValue, Question, Read, Reject, Relationship, Remove, Service, Source, TentativeAccept, TentativeReject, Tombstone, Travel, Undo, Update, Video, View } from "./vocab.js";
+import { getActorClassByTypeName, getActorHandle, getActorTypeName, isActor, normalizeActorHandle } from "./actor.js";
+import { lookupObject, traverseCollection } from "./lookup.js";
+import { PUBLIC_COLLECTION } from "./constants.js";
+
+export { Accept, Activity, Add, Announce, Application, Arrive, Article, Audio, Block, ChatMessage, Collection, CollectionPage, Create, CryptographicKey, DataIntegrityProof, Delete, DidService, Dislike, Document, Emoji, EmojiReact, Endpoints, Event, Export, Flag, Follow, Group, Hashtag, Ignore, Image, IntransitiveActivity, Invite, Join, Leave, Like, Link, Listen, Mention, Move, Multikey, Note, Object$1 as Object, Offer, OrderedCollection, OrderedCollectionPage, Organization, PUBLIC_COLLECTION, Page, Person, Place, Profile, PropertyValue, Question, Read, Reject, Relationship, Remove, Service, Source, TentativeAccept, TentativeReject, Tombstone, Travel, Undo, Update, Video, View, getActorClassByTypeName, getActorHandle, getActorTypeName, getTypeId, isActor, lookupObject, normalizeActorHandle, traverseCollection };

package/dist/vocab/type.d.ts

@@ -0,0 +1,107 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";
+import { Link$2 as Link, Object$1 } from "./vocab.js";
+
+//#region vocab/type.d.ts
+/**
+* Returns the type URI of the given object.
+*
+* @example
+* ``` typescript
+* import { getTypeId, Person } from "@fedify/fedify";
+*
+* const obj = new Person({});
+* console.log(getTypeId(obj));
+* // => new URL("https://www.w3.org/ns/activitystreams#Person")
+* ```
+*
+* @param object The Activity Vocabulary object.
+* @returns The type URI of the object, e.g.,
+*          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+*          If the given `object` is `null` or `undefined`, returns `null` or
+*          `undefined`, respectively.
+* @since 1.3.0
+*/
+/**
+ * Returns the type URI of the given object.
+ *
+ * @example
+ * ``` typescript
+ * import { getTypeId, Person } from "@fedify/fedify";
+ *
+ * const obj = new Person({});
+ * console.log(getTypeId(obj));
+ * // => new URL("https://www.w3.org/ns/activitystreams#Person")
+ * ```
+ *
+ * @param object The Activity Vocabulary object.
+ * @returns The type URI of the object, e.g.,
+ *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+ *          If the given `object` is `null` or `undefined`, returns `null` or
+ *          `undefined`, respectively.
+ * @since 1.3.0
+ */
+declare function getTypeId(object: Object$1 | Link): URL;
+/**
+ * Returns the type URI of the given object.
+ *
+ * @example
+ * ``` typescript
+ * import { getTypeId, Person } from "@fedify/fedify";
+ *
+ * const obj = new Person({});
+ * console.log(getTypeId(obj));
+ * // => new URL("https://www.w3.org/ns/activitystreams#Person")
+ * ```
+ *
+ * @param object The Activity Vocabulary object.
+ * @returns The type URI of the object, e.g.,
+ *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+ *          If the given `object` is `null` or `undefined`, returns `null` or
+ *          `undefined`, respectively.
+ * @since 1.3.0
+ */
+declare function getTypeId(object: Object$1 | Link | undefined): URL | undefined;
+/**
+ * Returns the type URI of the given object.
+ *
+ * @example
+ * ``` typescript
+ * import { getTypeId, Person } from "@fedify/fedify";
+ *
+ * const obj = new Person({});
+ * console.log(getTypeId(obj));
+ * // => new URL("https://www.w3.org/ns/activitystreams#Person")
+ * ```
+ *
+ * @param object The Activity Vocabulary object.
+ * @returns The type URI of the object, e.g.,
+ *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+ *          If the given `object` is `null` or `undefined`, returns `null` or
+ *          `undefined`, respectively.
+ * @since 1.3.0
+ */
+declare function getTypeId(object: Object$1 | Link | null): URL | null;
+/**
+ * Returns the type URI of the given object.
+ *
+ * @example
+ * ``` typescript
+ * import { getTypeId, Person } from "@fedify/fedify";
+ *
+ * const obj = new Person({});
+ * console.log(getTypeId(obj));
+ * // => new URL("https://www.w3.org/ns/activitystreams#Person")
+ * ```
+ *
+ * @param object The Activity Vocabulary object.
+ * @returns The type URI of the object, e.g.,
+ *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+ *          If the given `object` is `null` or `undefined`, returns `null` or
+ *          `undefined`, respectively.
+ * @since 1.3.0
+ */
+declare function getTypeId(object: Object$1 | Link | null | undefined): URL | null | undefined;
+
+//#endregion
+export { getTypeId as getTypeId$1 };

package/dist/vocab/type.js

@@ -0,0 +1,13 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+//#region vocab/type.ts
+function getTypeId(object) {
+	if (object == null) return object;
+	const cls = object.constructor;
+	return cls.typeId;
+}
+
+//#endregion
+export { getTypeId };

package/dist/vocab/type.test.d.ts

@@ -0,0 +1,2 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";

package/dist/vocab/type.test.js

@@ -0,0 +1,24 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { getTypeId } from "./type.js";
+import { Person } from "./vocab.js";
+import { assertEquals } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_equals.js";
+import { test } from "../testing/mod.js";
+
+//#region vocab/type.test.ts
+test("getTypeId()", () => {
+	const obj = new Person({});
+	assertEquals(getTypeId(obj), new URL("https://www.w3.org/ns/activitystreams#Person"));
+	const obj2 = null;
+	assertEquals(getTypeId(obj2), null);
+	const obj3 = void 0;
+	assertEquals(getTypeId(obj3), void 0);
+	const obj4 = null;
+	assertEquals(getTypeId(obj4), null);
+	const obj5 = void 0;
+	assertEquals(getTypeId(obj5), void 0);
+});
+
+//#endregion