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

package/dist/runtime/docloader.d.ts

@@ -0,0 +1,211 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";
+import { KvKey, KvStore } from "../federation/kv.js";
+
+//#region runtime/docloader.d.ts
+/**
+* A remote JSON-LD document and its context fetched by
+* a {@link DocumentLoader}.
+*/
+/**
+ * A remote JSON-LD document and its context fetched by
+ * a {@link DocumentLoader}.
+ */
+interface RemoteDocument {
+  /**
+   * The URL of the context document.
+   */
+  contextUrl: string | null;
+  /**
+   * The fetched JSON-LD document.
+   */
+  document: unknown;
+  /**
+   * The URL of the fetched document.
+   */
+  documentUrl: string;
+}
+/**
+ * A JSON-LD document loader that fetches documents from the Web.
+ * @param url The URL of the document to load.
+ * @returns The loaded remote document.
+ */
+type DocumentLoader = (url: string) => Promise<RemoteDocument>;
+/**
+ * A factory function that creates a {@link DocumentLoader} with options.
+ * @param options The options for the document loader.
+ * @returns The document loader.
+ * @since 1.4.0
+ */
+type DocumentLoaderFactory = (options?: DocumentLoaderFactoryOptions) => DocumentLoader;
+/**
+ * Options for {@link DocumentLoaderFactory}.
+ * @see {@link DocumentLoaderFactory}
+ * @see {@link AuthenticatedDocumentLoaderFactory}
+ * @since 1.4.0
+ */
+interface DocumentLoaderFactoryOptions {
+  /**
+   * Whether to allow fetching private network addresses.
+   * Turned off by default.
+   * @default `false``
+   */
+  allowPrivateAddress?: boolean;
+  /**
+   * Options for making `User-Agent` string.
+   * If a string is given, it is used as the `User-Agent` header value.
+   * If an object is given, it is passed to {@link getUserAgent} function.
+   */
+  userAgent?: GetUserAgentOptions | string;
+}
+/**
+ * A factory function that creates an authenticated {@link DocumentLoader} for
+ * a given identity.  This is used for fetching documents that require
+ * authentication.
+ * @param identity The identity to create the document loader for.
+ *                 The actor's key pair.
+ * @param options The options for the document loader.
+ * @returns The authenticated document loader.
+ * @since 0.4.0
+ */
+type AuthenticatedDocumentLoaderFactory = (identity: {
+  keyId: URL;
+  privateKey: CryptoKey;
+}, options?: DocumentLoaderFactoryOptions) => DocumentLoader;
+/**
+ * Error thrown when fetching a JSON-LD document failed.
+ */
+declare class FetchError extends Error {
+  /**
+   * The URL that failed to fetch.
+   */
+  url: URL;
+  /**
+   * Constructs a new `FetchError`.
+   *
+   * @param url The URL that failed to fetch.
+   * @param message Error message.
+   */
+  constructor(url: URL | string, message?: string);
+}
+/**
+ * Options for creating a request.
+ * @internal
+ */
+
+/**
+ * Options for {@link getDocumentLoader}.
+ * @since 1.3.0
+ */
+interface GetDocumentLoaderOptions extends DocumentLoaderFactoryOptions {
+  /**
+   * Whether to preload the frequently used contexts.
+   */
+  skipPreloadedContexts?: boolean;
+}
+/**
+ * Creates a JSON-LD document loader that utilizes the browser's `fetch` API.
+ *
+ * The created loader preloads the below frequently used contexts by default
+ * (unless `options.ignorePreloadedContexts` is set to `true`):
+ *
+ * - <https://www.w3.org/ns/activitystreams>
+ * - <https://w3id.org/security/v1>
+ * - <https://w3id.org/security/data-integrity/v1>
+ * - <https://www.w3.org/ns/did/v1>
+ * - <https://w3id.org/security/multikey/v1>
+ * - <https://purl.archive.org/socialweb/webfinger>
+ * - <http://schema.org/>
+ * @param options Options for the document loader.
+ * @returns The document loader.
+ * @since 1.3.0
+ */
+declare function getDocumentLoader({
+  allowPrivateAddress,
+  skipPreloadedContexts,
+  userAgent
+}?: GetDocumentLoaderOptions): DocumentLoader;
+/**
+ * A JSON-LD document loader that utilizes the browser's `fetch` API.
+ *
+ * This loader preloads the below frequently used contexts:
+ *
+ * - <https://www.w3.org/ns/activitystreams>
+ * - <https://w3id.org/security/v1>
+ * - <https://w3id.org/security/data-integrity/v1>
+ * - <https://www.w3.org/ns/did/v1>
+ * - <https://w3id.org/security/multikey/v1>
+ * - <https://purl.archive.org/socialweb/webfinger>
+ * - <http://schema.org/>
+ * @param url The URL of the document to load.
+ * @param allowPrivateAddress Whether to allow fetching private network
+ *                            addresses.  Turned off by default.
+ * @returns The remote document.
+ * @deprecated Use {@link getDocumentLoader} instead.
+ */
+declare function fetchDocumentLoader(url: string, allowPrivateAddress?: boolean): Promise<RemoteDocument>;
+/**
+ * The parameters for {@link kvCache} function.
+ */
+interface KvCacheParameters {
+  /**
+   * The document loader to decorate with a cache.
+   */
+  loader: DocumentLoader;
+  /**
+   * The key-value store to use for backing the cache.
+   */
+  kv: KvStore;
+  /**
+   * The key prefix to use for namespacing the cache.
+   * `["_fedify", "remoteDocument"]` by default.
+   */
+  prefix?: KvKey;
+  /**
+   * The per-URL cache rules in the array of `[urlPattern, duration]` pairs
+   * where `urlPattern` is either a string, a {@link URL}, or
+   * a {@link URLPattern} and `duration` is a {@link Temporal.Duration}.
+   * The `duration` is allowed to be at most 30 days.
+   *
+   * By default, 5 minutes for all URLs.
+   */
+  rules?: [string | URL | URLPattern, Temporal.Duration][];
+}
+/**
+ * Decorates a {@link DocumentLoader} with a cache backed by a {@link Deno.Kv}.
+ * @param parameters The parameters for the cache.
+ * @returns The decorated document loader which is cache-enabled.
+ */
+declare function kvCache({
+  loader,
+  kv,
+  prefix,
+  rules
+}: KvCacheParameters): DocumentLoader;
+/**
+ * Options for making `User-Agent` string.
+ * @see {@link getUserAgent}
+ * @since 1.3.0
+ */
+interface GetUserAgentOptions {
+  /**
+   * An optional software name and version, e.g., `"Hollo/1.0.0"`.
+   */
+  software?: string | null;
+  /**
+   * An optional URL to append to the user agent string.
+   * Usually the URL of the ActivityPub instance.
+   */
+  url?: string | URL | null;
+}
+/**
+ * Gets the user agent string for the given application and URL.
+ * @param options The options for making the user agent string.
+ * @returns The user agent string.
+ * @since 1.3.0
+ */
+declare function getUserAgent({
+  software,
+  url
+}?: GetUserAgentOptions): string; //#endregion
+export { AuthenticatedDocumentLoaderFactory, DocumentLoader, DocumentLoaderFactory, DocumentLoaderFactoryOptions, FetchError as FetchError$1, GetDocumentLoaderOptions, GetUserAgentOptions, KvCacheParameters, RemoteDocument, fetchDocumentLoader as fetchDocumentLoader$1, getDocumentLoader as getDocumentLoader$1, getUserAgent as getUserAgent$1, kvCache as kvCache$1 };

package/dist/runtime/docloader.js

@@ -0,0 +1,291 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { deno_default } from "../deno.js";
+import { contexts_default } from "./contexts.js";
+import { UrlError, validatePublicUrl } from "./url.js";
+import { getLogger } from "@logtape/logtape";
+import { HTTPHeaderLink } from "@hugoalh/http-header-link";
+import process from "node:process";
+
+//#region runtime/docloader.ts
+const logger = getLogger([
+	"fedify",
+	"runtime",
+	"docloader"
+]);
+/**
+* Error thrown when fetching a JSON-LD document failed.
+*/
+var FetchError = class extends Error {
+	/**
+	* The URL that failed to fetch.
+	*/
+	url;
+	/**
+	* Constructs a new `FetchError`.
+	*
+	* @param url The URL that failed to fetch.
+	* @param message Error message.
+	*/
+	constructor(url, message) {
+		super(message == null ? url.toString() : `${url}: ${message}`);
+		this.name = "FetchError";
+		this.url = typeof url === "string" ? new URL(url) : url;
+	}
+};
+/**
+* Creates a request for the given URL.
+* @param url The URL to create the request for.
+* @param options The options for the request.
+* @returns The created request.
+* @internal
+*/
+function createRequest(url, options = {}) {
+	return new Request(url, {
+		headers: {
+			Accept: "application/activity+json, application/ld+json",
+			"User-Agent": typeof options.userAgent === "string" ? options.userAgent : getUserAgent(options.userAgent)
+		},
+		redirect: "manual"
+	});
+}
+/**
+* Logs the request.
+* @param request The request to log.
+* @internal
+*/
+function logRequest(request) {
+	logger.debug("Fetching document: {method} {url} {headers}", {
+		method: request.method,
+		url: request.url,
+		headers: Object.fromEntries(request.headers.entries())
+	});
+}
+/**
+* Gets a {@link RemoteDocument} from the given response.
+* @param url The URL of the document to load.
+* @param response The response to get the document from.
+* @param fetch The function to fetch the document.
+* @returns The loaded remote document.
+* @throws {FetchError} If the response is not OK.
+* @internal
+*/
+async function getRemoteDocument(url, response, fetch$1) {
+	const documentUrl = response.url === "" ? url : response.url;
+	const docUrl = new URL(documentUrl);
+	if (!response.ok) {
+		logger.error("Failed to fetch document: {status} {url} {headers}", {
+			status: response.status,
+			url: documentUrl,
+			headers: Object.fromEntries(response.headers.entries())
+		});
+		throw new FetchError(documentUrl, `HTTP ${response.status}: ${documentUrl}`);
+	}
+	const contentType = response.headers.get("Content-Type");
+	const jsonLd = contentType == null || contentType === "application/activity+json" || contentType.startsWith("application/activity+json;") || contentType === "application/ld+json" || contentType.startsWith("application/ld+json;");
+	const linkHeader = response.headers.get("Link");
+	let contextUrl = null;
+	if (linkHeader != null) {
+		let link;
+		try {
+			link = new HTTPHeaderLink(linkHeader);
+		} catch (e) {
+			if (e instanceof SyntaxError) link = new HTTPHeaderLink();
+			else throw e;
+		}
+		if (jsonLd) {
+			const entries = link.getByRel("http://www.w3.org/ns/json-ld#context");
+			for (const [uri, params] of entries) if ("type" in params && params.type === "application/ld+json") {
+				contextUrl = uri;
+				break;
+			}
+		} else {
+			const entries = link.getByRel("alternate");
+			for (const [uri, params] of entries) {
+				const altUri = new URL(uri, docUrl);
+				if ("type" in params && (params.type === "application/activity+json" || params.type === "application/ld+json" || params.type.startsWith("application/ld+json;")) && altUri.href !== docUrl.href) {
+					logger.debug("Found alternate document: {alternateUrl} from {url}", {
+						alternateUrl: altUri.href,
+						url: documentUrl
+					});
+					return await fetch$1(altUri.href);
+				}
+			}
+		}
+	}
+	let document;
+	if (!jsonLd && (contentType === "text/html" || contentType?.startsWith("text/html;") || contentType === "application/xhtml+xml" || contentType?.startsWith("application/xhtml+xml;"))) {
+		const p = /<(a|link)((\s+[a-z][a-z:_-]*=("[^"]*"|'[^']*'|[^\s>]+))+)\/?>/gi;
+		const p2 = /\s+([a-z][a-z:_-]*)=("([^"]*)"|'([^']*)'|([^\s>]+))/gi;
+		const html = await response.text();
+		let m;
+		const rawAttribs = [];
+		while ((m = p.exec(html)) !== null) rawAttribs.push(m[2]);
+		for (const rawAttrs of rawAttribs) {
+			let m2;
+			const attribs = {};
+			while ((m2 = p2.exec(rawAttrs)) !== null) {
+				const key = m2[1].toLowerCase();
+				const value = m2[3] ?? m2[4] ?? m2[5] ?? "";
+				attribs[key] = value;
+			}
+			if (attribs.rel === "alternate" && "type" in attribs && (attribs.type === "application/activity+json" || attribs.type === "application/ld+json" || attribs.type.startsWith("application/ld+json;")) && "href" in attribs && new URL(attribs.href, docUrl).href !== docUrl.href) {
+				logger.debug("Found alternate document: {alternateUrl} from {url}", {
+					alternateUrl: attribs.href,
+					url: documentUrl
+				});
+				return await fetch$1(new URL(attribs.href, docUrl).href);
+			}
+		}
+		document = JSON.parse(html);
+	} else document = await response.json();
+	logger.debug("Fetched document: {status} {url} {headers}", {
+		status: response.status,
+		url: documentUrl,
+		headers: Object.fromEntries(response.headers.entries())
+	});
+	return {
+		contextUrl,
+		document,
+		documentUrl
+	};
+}
+/**
+* Creates a JSON-LD document loader that utilizes the browser's `fetch` API.
+*
+* The created loader preloads the below frequently used contexts by default
+* (unless `options.ignorePreloadedContexts` is set to `true`):
+*
+* - <https://www.w3.org/ns/activitystreams>
+* - <https://w3id.org/security/v1>
+* - <https://w3id.org/security/data-integrity/v1>
+* - <https://www.w3.org/ns/did/v1>
+* - <https://w3id.org/security/multikey/v1>
+* - <https://purl.archive.org/socialweb/webfinger>
+* - <http://schema.org/>
+* @param options Options for the document loader.
+* @returns The document loader.
+* @since 1.3.0
+*/
+function getDocumentLoader({ allowPrivateAddress, skipPreloadedContexts, userAgent } = {}) {
+	async function load(url) {
+		if (!skipPreloadedContexts && url in contexts_default) {
+			logger.debug("Using preloaded context: {url}.", { url });
+			return {
+				contextUrl: null,
+				document: contexts_default[url],
+				documentUrl: url
+			};
+		}
+		if (!allowPrivateAddress) try {
+			await validatePublicUrl(url);
+		} catch (error) {
+			if (error instanceof UrlError) logger.error("Disallowed private URL: {url}", {
+				url,
+				error
+			});
+			throw error;
+		}
+		const request = createRequest(url, { userAgent });
+		logRequest(request);
+		const response = await fetch(request, { redirect: "manual" });
+		if (response.status >= 300 && response.status < 400 && response.headers.has("Location")) return load(response.headers.get("Location"));
+		return getRemoteDocument(url, response, load);
+	}
+	return load;
+}
+const _fetchDocumentLoader = getDocumentLoader();
+const _fetchDocumentLoader_allowPrivateAddress = getDocumentLoader({ allowPrivateAddress: true });
+/**
+* A JSON-LD document loader that utilizes the browser's `fetch` API.
+*
+* This loader preloads the below frequently used contexts:
+*
+* - <https://www.w3.org/ns/activitystreams>
+* - <https://w3id.org/security/v1>
+* - <https://w3id.org/security/data-integrity/v1>
+* - <https://www.w3.org/ns/did/v1>
+* - <https://w3id.org/security/multikey/v1>
+* - <https://purl.archive.org/socialweb/webfinger>
+* - <http://schema.org/>
+* @param url The URL of the document to load.
+* @param allowPrivateAddress Whether to allow fetching private network
+*                            addresses.  Turned off by default.
+* @returns The remote document.
+* @deprecated Use {@link getDocumentLoader} instead.
+*/
+function fetchDocumentLoader(url, allowPrivateAddress = false) {
+	logger.warn("fetchDocumentLoader() function is deprecated.  Use getDocumentLoader() function instead.");
+	return (allowPrivateAddress ? _fetchDocumentLoader_allowPrivateAddress : _fetchDocumentLoader)(url);
+}
+/**
+* Decorates a {@link DocumentLoader} with a cache backed by a {@link Deno.Kv}.
+* @param parameters The parameters for the cache.
+* @returns The decorated document loader which is cache-enabled.
+*/
+function kvCache({ loader, kv, prefix, rules }) {
+	const keyPrefix = prefix ?? ["_fedify", "remoteDocument"];
+	rules ??= [[new URLPattern({}), Temporal.Duration.from({ minutes: 5 })]];
+	for (const [p, duration] of rules) if (Temporal.Duration.compare(duration, { days: 30 }) > 0) throw new TypeError("The maximum cache duration is 30 days: " + (p instanceof URLPattern ? `${p.protocol}://${p.username}:${p.password}@${p.hostname}:${p.port}/${p.pathname}?${p.search}#${p.hash}` : p.toString()));
+	function matchRule(url) {
+		for (const [pattern, duration] of rules) {
+			if (typeof pattern === "string") {
+				if (url === pattern) return duration;
+				continue;
+			}
+			if (pattern instanceof URL) {
+				if (pattern.href == url) return duration;
+				continue;
+			}
+			if (pattern.test(url)) return duration;
+		}
+		return null;
+	}
+	return async (url) => {
+		const match = matchRule(url);
+		if (match == null) return await loader(url);
+		const key = [...keyPrefix, url];
+		let cache = void 0;
+		try {
+			cache = await kv.get(key);
+		} catch (error) {
+			if (error instanceof Error) logger.warn("Failed to get the document of {url} from the KV cache: {error}", {
+				url,
+				error
+			});
+		}
+		if (cache == null) {
+			const remoteDoc = await loader(url);
+			try {
+				await kv.set(key, remoteDoc, { ttl: match });
+			} catch (error) {
+				logger.warn("Failed to save the document of {url} to the KV cache: {error}", {
+					url,
+					error
+				});
+			}
+			return remoteDoc;
+		}
+		return cache;
+	};
+}
+/**
+* Gets the user agent string for the given application and URL.
+* @param options The options for making the user agent string.
+* @returns The user agent string.
+* @since 1.3.0
+*/
+function getUserAgent({ software, url } = {}) {
+	const fedify = `Fedify/${deno_default.version}`;
+	const runtime = globalThis.Deno?.version?.deno != null ? `Deno/${Deno.version.deno}` : globalThis.process?.versions?.bun != null ? `Bun/${process.versions.bun}` : globalThis.process?.versions?.node != null ? `Node.js/${process.versions.node}` : null;
+	const userAgent = software == null ? [fedify] : [software, fedify];
+	if (runtime != null) userAgent.push(runtime);
+	if (url != null) userAgent.push(`+${url.toString()}`);
+	const first = userAgent.shift();
+	return `${first} (${userAgent.join("; ")})`;
+}
+
+//#endregion
+export { FetchError, createRequest, fetchDocumentLoader, getDocumentLoader, getRemoteDocument, getUserAgent, kvCache, logRequest };

package/dist/runtime/docloader.test.d.ts

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