@fedify/vocab 2.4.0-dev.1962 → 2.4.0-dev.1964

package/dist-tests/lookup-DaLkzo2s.mjs

@@ -0,0 +1,264 @@
+import { Temporal } from "temporal-polyfill";
+globalThis.addEventListener = () => {};
+import { k as Object$1 } from "./vocab-D3s0_CFf.mjs";
+import { i as isActor, o as name, s as version } from "./actor-Bms47rRP.mjs";
+import { t as getTypeId } from "./type-BMdjm4Eg.mjs";
+import { lookupWebFinger } from "@fedify/webfinger";
+import { SpanStatusCode, trace } from "@opentelemetry/api";
+import { getLogger } from "@logtape/logtape";
+import { getDocumentLoader, haveSameFe34Origin, haveSameIriOrigin, parseIri } from "@fedify/vocab-runtime";
+import { delay } from "es-toolkit";
+//#region src/handle.ts
+/**
+* Regular expression to match a fediverse handle in the format `@user@server`
+* or `user@server`.  The `user` part can contain alphanumeric characters and
+* some special characters except `@`.  The `server` part is all characters
+* after the `@` symbol in the middle.
+*/
+const handleRegexp = /^@?((?:[-A-Za-z0-9._~!$&'()*+,;=]|%[A-Fa-f0-9]{2})+)@([^@]+)$/;
+/**
+* Parses a fediverse handle in the format `@user@server` or `user@server`.
+* The `user` part can contain alphanumeric characters and some special
+* characters except `@`.  The `server` part is all characters after the `@`
+* symbol in the middle.
+*
+* @example
+* ```typescript
+* const handle = parseFediverseHandle("@username@example.com");
+* console.log(handle?.username); // "username"
+* console.log(handle?.host);     // "example.com"
+* ```
+*
+* @param handle - The fediverse handle string to parse.
+* @returns A {@link FediverseHandle} object with `username` and `host`
+*          if the input is valid; otherwise `null`.
+* @since 1.8.0
+*/
+function parseFediverseHandle(handle) {
+	const match = handleRegexp.exec(handle);
+	if (match) return {
+		username: match[1],
+		host: match[2]
+	};
+	return null;
+}
+/**
+* Converts a fediverse handle in the format `@user@server` or `user@server`
+* to an `acct:` URI, which is a URL-like identifier for ActivityPub actors.
+*
+* @example
+* ```typescript
+* const identifier = toAcctUrl("@username@example.com");
+* console.log(identifier?.href); // "acct:username@example.com"
+* ```
+*
+* @param handle - The fediverse handle string to convert.
+* @returns A `URL` object representing the `acct:` URI if conversion succeeds;
+*          otherwise `null`.
+* @since 1.8.0
+*/
+function toAcctUrl(handle) {
+	const parsed = parseFediverseHandle(handle);
+	if (!parsed) return null;
+	return new URL(`acct:${parsed.username}@${parsed.host}`);
+}
+//#endregion
+//#region src/lookup.ts
+const objectLookupCounters = /* @__PURE__ */ new WeakMap();
+function getObjectLookupCounter(meterProvider) {
+	let counter = objectLookupCounters.get(meterProvider);
+	if (counter == null) {
+		counter = meterProvider.getMeter(name, version).createCounter("activitypub.object.lookup", {
+			description: "ActivityStreams object lookups via lookupObject(), classified by whether the resolved value is an Actor.",
+			unit: "{lookup}"
+		});
+		objectLookupCounters.set(meterProvider, counter);
+	}
+	return counter;
+}
+function getLookupRemoteHost(identifier) {
+	let url;
+	if (identifier instanceof URL) url = identifier;
+	else try {
+		url = new URL(identifier);
+	} catch {
+		return extractHandleHost(identifier.startsWith("@") ? identifier.slice(1) : identifier);
+	}
+	if (url.host !== "") return url.host;
+	if (url.protocol === "acct:") return extractHandleHost(url.pathname);
+}
+function extractHandleHost(handle) {
+	const at = handle.lastIndexOf("@");
+	if (at < 0 || at >= handle.length - 1) return void 0;
+	const candidate = handle.slice(at + 1);
+	if (/[/?#\s]/.test(candidate)) return void 0;
+	try {
+		return new URL(`https://${candidate}`).host || void 0;
+	} catch {
+		return;
+	}
+}
+const logger = getLogger([
+	"fedify",
+	"vocab",
+	"lookup"
+]);
+/**
+* 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 = {}) {
+	return await (options.tracerProvider ?? trace.getTracerProvider()).getTracer(name, version).startActiveSpan("activitypub.lookup_object", async (span) => {
+		let kind = "other";
+		try {
+			const result = await lookupObjectInternal(identifier, options);
+			if (result != null) kind = isActor(result) ? "actor" : "object";
+			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));
+				span.addEvent("activitypub.object.fetched", {
+					"activitypub.object.type": getTypeId(result).href,
+					"activitypub.object.json": JSON.stringify(await result.toJsonLd(options))
+				});
+			}
+			return result;
+		} catch (error) {
+			span.recordException(error);
+			span.setStatus({
+				code: SpanStatusCode.ERROR,
+				message: String(error)
+			});
+			throw error;
+		} finally {
+			if (options.meterProvider != null) {
+				const attributes = { "activitypub.lookup.kind": kind };
+				const host = getLookupRemoteHost(identifier);
+				if (host != null) attributes["activitypub.remote.host"] = host;
+				getObjectLookupCounter(options.meterProvider).add(1, attributes);
+			}
+			span.end();
+		}
+	});
+}
+async function lookupObjectInternal(identifier, options = {}) {
+	const documentLoader = options.documentLoader ?? getDocumentLoader({ userAgent: options.userAgent });
+	if (typeof identifier === "string") identifier = toAcctUrl(identifier) ?? new URL(identifier);
+	let remoteDoc = null;
+	if (identifier.protocol === "http:" || identifier.protocol === "https:") try {
+		remoteDoc = await documentLoader(identifier.href, { signal: options.signal });
+	} catch (error) {
+		logger.debug("Failed to fetch remote document:\n{error}", { error });
+	}
+	if (remoteDoc == null) {
+		const jrd = await lookupWebFinger(identifier, {
+			userAgent: options.userAgent,
+			tracerProvider: options.tracerProvider,
+			meterProvider: options.meterProvider,
+			allowPrivateAddress: "allowPrivateAddress" in options && options.allowPrivateAddress === true,
+			signal: options.signal
+		});
+		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" || l.href == null) continue;
+			try {
+				remoteDoc = await documentLoader(l.href, { signal: options.signal });
+				break;
+			} catch (error) {
+				logger.debug("Failed to fetch remote document:\n{error}", { error });
+				continue;
+			}
+		}
+	}
+	if (remoteDoc == null) return null;
+	let object;
+	let documentUrl;
+	try {
+		documentUrl = parseIri(remoteDoc.documentUrl);
+		object = await Object$1.fromJsonLd(remoteDoc.document, {
+			documentLoader,
+			contextLoader: options.contextLoader,
+			tracerProvider: options.tracerProvider,
+			baseUrl: documentUrl
+		});
+	} catch (error) {
+		if (error instanceof TypeError) {
+			logger.debug("Failed to parse JSON-LD document: {error}\n{document}", {
+				...remoteDoc,
+				error
+			});
+			return null;
+		}
+		throw error;
+	}
+	if (options.crossOrigin !== "trust" && object.id != null && !haveSameIriOrigin(object.id, documentUrl) && !haveSameFe34Origin(object.id, documentUrl)) {
+		if (options.crossOrigin === "throw") throw new Error(`The object's @id (${object.id.href}) has a different origin than the document URL (${remoteDoc.documentUrl}); refusing to return the object.  If you want to bypass this check and are aware of the security implications, set the crossOrigin option to "trust".`);
+		logger.warn("The object's @id ({objectId}) has a different origin than the document URL ({documentUrl}); refusing to return the object.  If you want to bypass this check and are aware of the security implications, set the crossOrigin option to \"trust\".", {
+			...remoteDoc,
+			objectId: object.id.href
+		});
+		return null;
+	}
+	return object;
+}
+/**
+* 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 = {}) {
+	const interval = Temporal.Duration.from(options.interval ?? { seconds: 0 }).total("millisecond");
+	let page = await collection.getFirst(options);
+	if (page == null) for await (const item of collection.getItems(options)) yield item;
+	else 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 { traverseCollection as n, lookupObject as t };

package/dist-tests/lookup.test.mjs

@@ -1,269 +1,11 @@
-import { Temporal } from "temporal-polyfill";
+import "temporal-polyfill";
 globalThis.addEventListener = () => {};
-import { D as Note, M as Person, O as Object$1, o as Collection } from "./vocab-CNiWKo57.mjs";
-import { c as esm_default, i as isActor, o as name, s as version } from "./actor-DH8a9EGs.mjs";
-import { t as getTypeId } from "./type-BMdjm4Eg.mjs";
+import { N as Person, O as Note, k as Object$1, s as Collection } from "./vocab-D3s0_CFf.mjs";
+import { t as esm_default } from "./esm-BcWVaclW.mjs";
+import { n as traverseCollection, t as lookupObject } from "./lookup-DaLkzo2s.mjs";
 import { t as assertInstanceOf } from "./utils-Df2odC27.mjs";
 import { createTestMeterProvider, createTestTracerProvider, mockDocumentLoader, test } from "@fedify/fixture";
 import { deepStrictEqual, equal, ok, rejects } from "node:assert/strict";
-import { lookupWebFinger } from "@fedify/webfinger";
-import { SpanStatusCode, trace } from "@opentelemetry/api";
-import { getLogger } from "@logtape/logtape";
-import { getDocumentLoader, haveSameFe34Origin, haveSameIriOrigin, parseIri } from "@fedify/vocab-runtime";
-import { delay } from "es-toolkit";
-//#region src/handle.ts
-/**
-* Regular expression to match a fediverse handle in the format `@user@server`
-* or `user@server`.  The `user` part can contain alphanumeric characters and
-* some special characters except `@`.  The `server` part is all characters
-* after the `@` symbol in the middle.
-*/
-const handleRegexp = /^@?((?:[-A-Za-z0-9._~!$&'()*+,;=]|%[A-Fa-f0-9]{2})+)@([^@]+)$/;
-/**
-* Parses a fediverse handle in the format `@user@server` or `user@server`.
-* The `user` part can contain alphanumeric characters and some special
-* characters except `@`.  The `server` part is all characters after the `@`
-* symbol in the middle.
-*
-* @example
-* ```typescript
-* const handle = parseFediverseHandle("@username@example.com");
-* console.log(handle?.username); // "username"
-* console.log(handle?.host);     // "example.com"
-* ```
-*
-* @param handle - The fediverse handle string to parse.
-* @returns A {@link FediverseHandle} object with `username` and `host`
-*          if the input is valid; otherwise `null`.
-* @since 1.8.0
-*/
-function parseFediverseHandle(handle) {
-	const match = handleRegexp.exec(handle);
-	if (match) return {
-		username: match[1],
-		host: match[2]
-	};
-	return null;
-}
-/**
-* Converts a fediverse handle in the format `@user@server` or `user@server`
-* to an `acct:` URI, which is a URL-like identifier for ActivityPub actors.
-*
-* @example
-* ```typescript
-* const identifier = toAcctUrl("@username@example.com");
-* console.log(identifier?.href); // "acct:username@example.com"
-* ```
-*
-* @param handle - The fediverse handle string to convert.
-* @returns A `URL` object representing the `acct:` URI if conversion succeeds;
-*          otherwise `null`.
-* @since 1.8.0
-*/
-function toAcctUrl(handle) {
-	const parsed = parseFediverseHandle(handle);
-	if (!parsed) return null;
-	return new URL(`acct:${parsed.username}@${parsed.host}`);
-}
-//#endregion
-//#region src/lookup.ts
-const objectLookupCounters = /* @__PURE__ */ new WeakMap();
-function getObjectLookupCounter(meterProvider) {
-	let counter = objectLookupCounters.get(meterProvider);
-	if (counter == null) {
-		counter = meterProvider.getMeter(name, version).createCounter("activitypub.object.lookup", {
-			description: "ActivityStreams object lookups via lookupObject(), classified by whether the resolved value is an Actor.",
-			unit: "{lookup}"
-		});
-		objectLookupCounters.set(meterProvider, counter);
-	}
-	return counter;
-}
-function getLookupRemoteHost(identifier) {
-	let url;
-	if (identifier instanceof URL) url = identifier;
-	else try {
-		url = new URL(identifier);
-	} catch {
-		return extractHandleHost(identifier.startsWith("@") ? identifier.slice(1) : identifier);
-	}
-	if (url.host !== "") return url.host;
-	if (url.protocol === "acct:") return extractHandleHost(url.pathname);
-}
-function extractHandleHost(handle) {
-	const at = handle.lastIndexOf("@");
-	if (at < 0 || at >= handle.length - 1) return void 0;
-	const candidate = handle.slice(at + 1);
-	if (/[/?#\s]/.test(candidate)) return void 0;
-	try {
-		return new URL(`https://${candidate}`).host || void 0;
-	} catch {
-		return;
-	}
-}
-const logger = getLogger([
-	"fedify",
-	"vocab",
-	"lookup"
-]);
-/**
-* 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 = {}) {
-	return await (options.tracerProvider ?? trace.getTracerProvider()).getTracer(name, version).startActiveSpan("activitypub.lookup_object", async (span) => {
-		let kind = "other";
-		try {
-			const result = await lookupObjectInternal(identifier, options);
-			if (result != null) kind = isActor(result) ? "actor" : "object";
-			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));
-				span.addEvent("activitypub.object.fetched", {
-					"activitypub.object.type": getTypeId(result).href,
-					"activitypub.object.json": JSON.stringify(await result.toJsonLd(options))
-				});
-			}
-			return result;
-		} catch (error) {
-			span.recordException(error);
-			span.setStatus({
-				code: SpanStatusCode.ERROR,
-				message: String(error)
-			});
-			throw error;
-		} finally {
-			if (options.meterProvider != null) {
-				const attributes = { "activitypub.lookup.kind": kind };
-				const host = getLookupRemoteHost(identifier);
-				if (host != null) attributes["activitypub.remote.host"] = host;
-				getObjectLookupCounter(options.meterProvider).add(1, attributes);
-			}
-			span.end();
-		}
-	});
-}
-async function lookupObjectInternal(identifier, options = {}) {
-	const documentLoader = options.documentLoader ?? getDocumentLoader({ userAgent: options.userAgent });
-	if (typeof identifier === "string") identifier = toAcctUrl(identifier) ?? new URL(identifier);
-	let remoteDoc = null;
-	if (identifier.protocol === "http:" || identifier.protocol === "https:") try {
-		remoteDoc = await documentLoader(identifier.href, { signal: options.signal });
-	} catch (error) {
-		logger.debug("Failed to fetch remote document:\n{error}", { error });
-	}
-	if (remoteDoc == null) {
-		const jrd = await lookupWebFinger(identifier, {
-			userAgent: options.userAgent,
-			tracerProvider: options.tracerProvider,
-			meterProvider: options.meterProvider,
-			allowPrivateAddress: "allowPrivateAddress" in options && options.allowPrivateAddress === true,
-			signal: options.signal
-		});
-		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" || l.href == null) continue;
-			try {
-				remoteDoc = await documentLoader(l.href, { signal: options.signal });
-				break;
-			} catch (error) {
-				logger.debug("Failed to fetch remote document:\n{error}", { error });
-				continue;
-			}
-		}
-	}
-	if (remoteDoc == null) return null;
-	let object;
-	let documentUrl;
-	try {
-		documentUrl = parseIri(remoteDoc.documentUrl);
-		object = await Object$1.fromJsonLd(remoteDoc.document, {
-			documentLoader,
-			contextLoader: options.contextLoader,
-			tracerProvider: options.tracerProvider,
-			baseUrl: documentUrl
-		});
-	} catch (error) {
-		if (error instanceof TypeError) {
-			logger.debug("Failed to parse JSON-LD document: {error}\n{document}", {
-				...remoteDoc,
-				error
-			});
-			return null;
-		}
-		throw error;
-	}
-	if (options.crossOrigin !== "trust" && object.id != null && !haveSameIriOrigin(object.id, documentUrl) && !haveSameFe34Origin(object.id, documentUrl)) {
-		if (options.crossOrigin === "throw") throw new Error(`The object's @id (${object.id.href}) has a different origin than the document URL (${remoteDoc.documentUrl}); refusing to return the object.  If you want to bypass this check and are aware of the security implications, set the crossOrigin option to "trust".`);
-		logger.warn("The object's @id ({objectId}) has a different origin than the document URL ({documentUrl}); refusing to return the object.  If you want to bypass this check and are aware of the security implications, set the crossOrigin option to \"trust\".", {
-			...remoteDoc,
-			objectId: object.id.href
-		});
-		return null;
-	}
-	return object;
-}
-/**
-* 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 = {}) {
-	const interval = Temporal.Duration.from(options.interval ?? { seconds: 0 }).total("millisecond");
-	let page = await collection.getFirst(options);
-	if (page == null) for await (const item of collection.getItems(options)) yield item;
-	else 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
 //#region src/lookup.test.ts
 test("lookupObject()", {
 	sanitizeResources: false,

package/dist-tests/object.yaml

@@ -469,3 +469,18 @@ properties:
     (boost) was approved by the target post's author.
   range:
   - "https://gotosocial.org/ns#AnnounceAuthorization"
+
+- pluralName: translations
+  singularName: translation
+  compactName: translations
+  uri: "https://w3id.org/fep/22cd#translations"
+  extraContext: "https://w3id.org/fep/22cd"
+  description: |
+    Translation metadata for the language versions in this object's content,
+    name, or summary maps, as defined by the draft
+    [FEP-22cd](https://w3id.org/fep/22cd).  Each entry describes one translated
+    language; directly authored languages have no entry.  The entries share
+    this object's identity, replies, and reactions.  Translator credit grants
+    no authority to update the object.
+  range:
+  - "https://w3id.org/fep/22cd#Translation"