@chrisburnell/eleventy-cache-webmentions 2.1.12 → 2.2.2

package/.cache/eleventy-fetch-68a403136c61abd104ade94e69ba62

@@ -1 +1 @@
-{"cachedAt":1761155512715,"type":"json","metadata":{}}
+{"cachedAt":1761203061369,"type":"json","metadata":{}}

package/eleventy-cache-webmentions.cjs

@@ -0,0 +1,677 @@
+const { AssetCache } = require("@11ty/eleventy-fetch");
+const { styleText } = require("node:util");
+const sanitizeHTML = require("sanitize-html");
+
+/**
+ * @typedef {sanitizeHTML.IOptions} AllowedHTML
+ */
+
+/**
+ * @typedef {Object} OptionsDefaults
+ * @prop {boolean} refresh
+ * @prop {string} duration
+ * @prop {string} uniqueKey
+ * @prop {string} [cacheDirectory]
+ * @prop {AllowedHTML} allowedHTML
+ * @prop {string[]} allowlist
+ * @prop {string[]} blocklist
+ * @prop {Object<string, string>} urlReplacements
+ * @prop {number} maximumHtmlLength
+ * @prop {string} maximumHtmlText
+ */
+
+/**
+ * @typedef {Object} OptionsUserInput
+ * @prop {string} domain
+ * @prop {string} feed
+ * @prop {string} key
+ */
+
+/**
+ * @typedef {OptionsDefaults & OptionsUserInput} Options
+ */
+
+/**
+ * @typedef {Object} Webmention
+ * @prop {string} [source]
+ * @prop {string} [url]
+ * @prop {string} [target]
+ * @prop {string} [published]
+ * @prop {string} [contentSanitized]
+ * @prop {Object} [content]
+ * @prop {string} [content.html]
+ * @prop {string} [content.value]
+ * @prop {Object} [data]
+ * @prop {string} [data.title]
+ * @prop {string} [data.url]
+ * @prop {string} [data.published]
+ * @prop {string} [data.content]
+ * @prop {string} [type]
+ * @prop {Object} [activity]
+ * @prop {string} [activity.type]
+ * @prop {boolean} [verified]
+ * @prop {string} ["wm-property"]
+ * @prop {string} ["wm-received"]
+ * @prop {string} ["wm-source"]
+ * @prop {string} ["wm-target"]
+ * @prop {string} ["verified_date"]
+ */
+
+/**
+ * @typedef {"bookmark-of"|"like-of"|"repost-of"|"mention-of"|"in-reply-to"} WebmentionType
+ */
+
+/**
+ * @type {OptionsDefaults}
+ */
+const defaults = {
+	refresh: false,
+	duration: "1d",
+	uniqueKey: "webmentions",
+	cacheDirectory: undefined,
+	allowedHTML: {
+		allowedTags: ["a", "b", "em", "i", "strong"],
+		allowedAttributes: {
+			a: ["href"],
+		},
+	},
+	allowlist: [],
+	blocklist: [],
+	urlReplacements: {},
+	maximumHtmlLength: 1000,
+	maximumHtmlText: "mentioned this in",
+};
+
+/**
+ * @param {string} url
+ * @param {string} domain
+ * @returns {string}
+ */
+const absoluteURL = (url, domain) => {
+	try {
+		return new URL(url, domain).toString();
+	} catch (e) {
+		console.error(
+			`Trying to convert ${styleText(
+				"bold",
+				url,
+			)} to be an absolute url with base ${styleText(
+				"bold",
+				domain,
+			)} and failed.`,
+		);
+		return url;
+	}
+};
+
+/**
+ * @param {string} url
+ * @returns {string}
+ */
+const baseURL = (url) => {
+	let hashSplit = url.split("#");
+	let queryparamSplit = hashSplit[0].split("?");
+	return queryparamSplit[0];
+};
+
+/**
+ * @param {string} url
+ * @param {Object<string, string>} [urlReplacements]
+ * @returns {string}
+ */
+const fixURL = (url, urlReplacements) => {
+	return Object.entries(urlReplacements).reduce(
+		(accumulator, [key, value]) => {
+			const regex = new RegExp(key, "g");
+			return accumulator.replace(regex, value);
+		},
+		url,
+	);
+};
+
+/**
+ * @param {string} url
+ * @returns {string}
+ */
+const hostname = (url) => {
+	if (typeof url === "string" && url.includes("//")) {
+		const urlObject = new URL(url);
+		return urlObject.hostname;
+	}
+	return url;
+};
+
+/**
+ * @param {string|number|Date} date
+ * @returns {number}
+ */
+const epoch = (date) => {
+	return new Date(date).getTime();
+};
+
+/**
+ * @param {Webmention[]} webmentions
+ * @returns {Webmention[]}
+ */
+const removeDuplicates = (webmentions) => {
+	return [
+		...webmentions
+			.reduce((map, webmention) => {
+				const key =
+					webmention === null || webmention === undefined
+						? webmention
+						: getSource(webmention);
+				if (!map.has(key)) {
+					map.set(key, webmention);
+				}
+				return map;
+			}, new Map())
+			.values(),
+	];
+};
+
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+const getPublished = (webmention) => {
+	return (
+		webmention?.["data"]?.["published"] ||
+		webmention["published"] ||
+		webmention["wm-received"] ||
+		webmention["verified_date"]
+	);
+};
+
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+const getReceived = (webmention) => {
+	return (
+		webmention["wm-received"] ||
+		webmention["verified_date"] ||
+		webmention["published"] ||
+		webmention?.["data"]?.["published"]
+	);
+};
+
+/**
+ * @param {Webmention} webmention
+ * @returns {string}
+ */
+const getContent = (webmention) => {
+	return (
+		webmention?.["contentSanitized"] ||
+		webmention?.["content"]?.["html"] ||
+		webmention?.["content"]?.["value"] ||
+		webmention?.["content"] ||
+		webmention?.["data"]?.["content"] ||
+		""
+	);
+};
+
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+const getSource = (webmention) => {
+	return (
+		webmention["wm-source"] ||
+		webmention["source"] ||
+		webmention?.["data"]?.["url"] ||
+		webmention["url"]
+	);
+};
+
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+const getURL = (webmention) => {
+	return (
+		webmention?.["data"]?.["url"] ||
+		webmention["url"] ||
+		webmention["wm-source"] ||
+		webmention["source"]
+	);
+};
+
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+const getTarget = (webmention) => {
+	return webmention["wm-target"] || webmention["target"];
+};
+
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+const getType = (webmention) => {
+	return (
+		webmention["wm-property"] ||
+		webmention?.["activity"]?.["type"] ||
+		webmention["type"]
+	);
+};
+
+/**
+ * @param {Webmention[]} webmentions
+ * @param {WebmentionType|WebmentionType[]} types
+ * @returns {Webmention[]}
+ */
+const getByTypes = (webmentions, types) => {
+	return webmentions.filter((webmention) => {
+		if (typeof types === "string") {
+			return types === getType(webmention);
+		}
+		return types.includes(getType(webmention));
+	});
+};
+
+/**
+ * @param {Webmention[]} webmentions
+ * @param {string[]} blocklist
+ * @returns {Webmention[]}
+ */
+const processBlocklist = (webmentions, blocklist) => {
+	return webmentions.filter((webmention) => {
+		let url = getSource(webmention);
+		let source = getSource(webmention);
+		for (let blocklistURL of blocklist) {
+			if (
+				url.includes(blocklistURL.replace(/\/?$/, "/")) ||
+				source.includes(blocklistURL.replace(/\/?$/, "/"))
+			) {
+				return false;
+			}
+		}
+		return true;
+	});
+};
+
+/**
+ * @param {Webmention[]} webmentions
+ * @param {string[]} allowlist
+ * @returns {Webmention[]}
+ */
+const processAllowlist = (webmentions, allowlist) => {
+	return webmentions.filter((webmention) => {
+		let url = getSource(webmention);
+		let source = getSource(webmention);
+		for (let allowlistURL of allowlist) {
+			if (
+				url.includes(allowlistURL.replace(/\/?$/, "/")) ||
+				source.includes(allowlistURL.replace(/\/?$/, "/"))
+			) {
+				return true;
+			}
+		}
+		return false;
+	});
+};
+
+/**
+ * @param {Options} options
+ * @param {Webmention[]} webmentions
+ * @param {string} url
+ * @returns {Promise<{found: number, webmentions: Webmention[]}>}
+ */
+const fetchWebmentions = async (options, webmentions, url) => {
+	return await fetch(url)
+		.then(async (response) => {
+			if (!response.ok) {
+				return Promise.reject(response);
+			}
+
+			const feed = await response.json();
+
+			if (!(options.key in feed)) {
+				console.log(
+					`${styleText("grey", `[${hostname(options.domain)}]`)} ${
+						options.key
+					} was not found as a key in the response from ${styleText(
+						"bold",
+						hostname(options.feed),
+					)}!`,
+				);
+				return Promise.reject(response);
+			}
+
+			// Combine newly-fetched Webmentions with cached Webmentions
+			webmentions = feed[options.key].concat(webmentions);
+			// Remove duplicates by source URL
+			webmentions = removeDuplicates(webmentions);
+			// Process the blocklist, if it has any entries
+			if (options.blocklist.length) {
+				webmentions = processBlocklist(webmentions, options.blocklist);
+			}
+			// Process the allowlist, if it has any entries
+			if (options.allowlist.length) {
+				webmentions = processAllowlist(webmentions, options.allowlist);
+			}
+			// Sort webmentions by received date for getting most recent Webmention on subsequent requests
+			webmentions = webmentions.sort((a, b) => {
+				return epoch(getReceived(b)) - epoch(getReceived(a));
+			});
+
+			return {
+				found: feed[options.key].length,
+				webmentions: webmentions,
+			};
+		})
+		.catch((error) => {
+			console.warn(
+				`${styleText(
+					"grey",
+					`[${hostname(options.domain)}]`,
+				)} Something went wrong with your Webmention request to ${styleText(
+					"bold",
+					hostname(options.feed),
+				)}!`,
+			);
+			console.warn(error instanceof Error ? error.message : error);
+
+			return {
+				found: 0,
+				webmentions: webmentions,
+			};
+		});
+};
+
+/**
+ * @param {Options} options
+ * @returns {Promise<Webmention[]>}
+ */
+const retrieveWebmentions = async (options) => {
+	if (!options.domain) {
+		throw new Error(
+			"`domain` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.",
+		);
+	}
+
+	if (!options.feed) {
+		throw new Error(
+			"`feed` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.",
+		);
+	}
+
+	if (!options.key) {
+		throw new Error(
+			"`key` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.",
+		);
+	}
+
+	let asset = new AssetCache(
+		options.uniqueKey || `webmentions-${hostname(options.domain)}`,
+		options.cacheDirectory,
+	);
+
+	let webmentions = [];
+
+	// Unless specifically getting fresh Webmentions, if there is a cached file
+	// at all, grab its contents now
+	if (asset.isCacheValid("9001y") && !options.refresh) {
+		webmentions = await asset.getCachedValue();
+	}
+
+	// Get the number of cached Webmentions for diffing against fetched
+	// Webmentions later
+	const webmentionsCachedLength = webmentions.length;
+
+	// If there is a cached file but it is outside of expiry, fetch fresh
+	// results since the most recent Webmention
+	if (!asset.isCacheValid(options.refresh ? "0s" : options.duration)) {
+		const performanceStart = process.hrtime();
+		// Get the received date of the most recent Webmention, if it exists
+		const since = webmentions.length ? getReceived(webmentions[0]) : false;
+		// Build the URL for the fetch request
+		const url = `${options.feed}${
+			since
+				? `${options.feed.includes("?") ? "&" : "?"}since=${since}`
+				: ""
+		}`;
+
+		// If using webmention.io, loop through pages until no results found
+		if (url.includes("https://webmention.io")) {
+			const urlObject = new URL(url);
+			const perPage =
+				Number(urlObject.searchParams.get("per-page")) || 1000;
+			urlObject.searchParams.delete("per-page");
+			// Start on page 0, to increment per subsequent request
+			let page = 0;
+			// Loop until a break condition is hit
+			while (true) {
+				const urlPaginated =
+					urlObject.href + `&per-page=${perPage}&page=${page}`;
+				const fetched = await fetchWebmentions(
+					options,
+					webmentions,
+					urlPaginated,
+				);
+
+				// An error occurred during fetching paged results → break
+				if (!fetched && !fetched.found && !fetched.webmentions) {
+					break;
+				}
+
+				// Page has no Webmentions → break
+				if (fetched.found === 0) {
+					break;
+				}
+
+				webmentions = fetched.webmentions;
+
+				// If there are less Webmentions found than should be in each
+				// page → break
+				if (fetched.found < perPage) {
+					break;
+				}
+
+				// Increment page
+				page += 1;
+				// Throttle next request
+				await new Promise((resolve) => setTimeout(resolve, 1000));
+			}
+		} else {
+			const fetched = await fetchWebmentions(options, webmentions, url);
+			webmentions = fetched.webmentions;
+		}
+
+		// Process the blocklist, if it has any entries
+		if (options.blocklist.length) {
+			webmentions = processBlocklist(webmentions, options.blocklist);
+		}
+
+		// Process the allowlist, if it has any entries
+		if (options.allowlist.length) {
+			webmentions = processAllowlist(webmentions, options.allowlist);
+		}
+
+		await asset.save(webmentions, "json");
+
+		const performance = process.hrtime(performanceStart);
+
+		// Add a console message with the number of fetched and processed Webmentions, if any
+		if (webmentionsCachedLength < webmentions.length) {
+			console.log(
+				`${styleText(
+					"grey",
+					`[${hostname(options.domain)}]`,
+				)} ${styleText(
+					"bold",
+					String(webmentions.length - webmentionsCachedLength),
+				)} new Webmentions fetched into cache in ${styleText(
+					"bold",
+					(performance[0] + performance[1] / 1e9).toFixed(3) +
+						" seconds",
+				)}.`,
+			);
+		}
+	}
+
+	return webmentions;
+};
+
+/** @type {Webmention[]} */
+const WEBMENTIONS = {};
+
+/**
+ * @param {Options} options
+ * @returns {Promise<Object<string, Webmention[]>>}
+ */
+const webmentionsByURL = async (options) => {
+	if (Object.keys(WEBMENTIONS).length) {
+		return WEBMENTIONS;
+	}
+
+	let rawWebmentions = await retrieveWebmentions(options);
+
+	// Fix local URLs based on urlReplacements and sort Webmentions into groups
+	// by target base URL
+	rawWebmentions.forEach((webmention) => {
+		let url = baseURL(
+			fixURL(
+				getTarget(webmention).replace(/\/?$/, "/"),
+				options.urlReplacements,
+			),
+		);
+
+		if (!WEBMENTIONS[url]) {
+			WEBMENTIONS[url] = [];
+		}
+
+		WEBMENTIONS[url].push(webmention);
+	});
+
+	return WEBMENTIONS;
+};
+
+/**
+ * @param {Options} options
+ * @param {string} url
+ * @param {WebmentionType[]|WebmentionType} [types=[]]
+ * @returns {Promise<Webmention[]>}
+ */
+const getWebmentions = async (options, url, types = []) => {
+	const webmentions = await webmentionsByURL(options);
+	url = absoluteURL(url, options.domain);
+
+	if (!url || !webmentions || !webmentions[url]) {
+		return [];
+	}
+
+	return (
+		webmentions[url]
+			// Filter webmentions by allowed response post types
+			.filter((entry) => {
+				return typeof types === "object" && Object.keys(types).length
+					? types.includes(getType(entry))
+					: typeof types === "string"
+					? types === getType(entry)
+					: true;
+			})
+			// Sanitize content of webmentions against HTML limit
+			.map((entry) => {
+				const html = getContent(entry);
+
+				if (html.length) {
+					entry.contentSanitized = sanitizeHTML(
+						html,
+						options.allowedHTML,
+					);
+					if (html.length > options.maximumHtmlLength) {
+						entry.contentSanitized = `${
+							options.maximumHtmlText
+						} <a href="${getSource(entry)}">${getSource(
+							entry,
+						)}</a>`;
+					}
+				}
+
+				return entry;
+			})
+			// Sort by published
+			.sort((a, b) => {
+				return epoch(getPublished(a)) - epoch(getPublished(b));
+			})
+	);
+};
+
+/**
+ * @param {Object} eleventyConfig
+ * @param {Options} [options={}]
+ */
+const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
+	options = Object.assign(defaults, options);
+
+	const byURL = webmentionsByURL(options);
+	const all = Object.values(byURL).reduce(
+		(array, webmentions) => [...array, ...webmentions],
+		[],
+	);
+
+	// Global Data
+	eleventyConfig.addGlobalData("webmentionsDefaults", defaults);
+	eleventyConfig.addGlobalData("webmentionsOptions", options);
+	eleventyConfig.addGlobalData("webmentionsByURL", byURL);
+	eleventyConfig.addGlobalData("webmentionsByUrl", byURL);
+	eleventyConfig.addGlobalData("webmentionsAll", all);
+
+	// Liquid Filters
+	eleventyConfig.addLiquidFilter("getWebmentionsByType", getByTypes);
+	eleventyConfig.addLiquidFilter("getWebmentionsByTypes", getByTypes);
+	eleventyConfig.addLiquidFilter("getWebmentionPublished", getPublished);
+	eleventyConfig.addLiquidFilter("getWebmentionReceived", getReceived);
+	eleventyConfig.addLiquidFilter("getWebmentionContent", getContent);
+	eleventyConfig.addLiquidFilter("getWebmentionSource", getSource);
+	eleventyConfig.addLiquidFilter("getWebmentionURL", getURL);
+	eleventyConfig.addLiquidFilter("getWebmentionTarget", getTarget);
+	eleventyConfig.addLiquidFilter("getWebmentionType", getType);
+
+	// Nunjucks Filters
+	eleventyConfig.addNunjucksFilter("getWebmentionsByType", getByTypes);
+	eleventyConfig.addNunjucksFilter("getWebmentionsByTypes", getByTypes);
+	eleventyConfig.addNunjucksFilter("getWebmentionPublished", getPublished);
+	eleventyConfig.addNunjucksFilter("getWebmentionReceived", getReceived);
+	eleventyConfig.addNunjucksFilter("getWebmentionContent", getContent);
+	eleventyConfig.addNunjucksFilter("getWebmentionSource", getSource);
+	eleventyConfig.addNunjucksFilter("getWebmentionURL", getURL);
+	eleventyConfig.addNunjucksFilter("getWebmentionTarget", getTarget);
+	eleventyConfig.addNunjucksFilter("getWebmentionType", getType);
+};
+
+module.exports = eleventyCacheWebmentions;
+module.exports.defaults = defaults;
+module.exports.getPublished = getPublished;
+module.exports.getWebmentionPublished = getPublished;
+module.exports.getReceived = getReceived;
+module.exports.getWebmentionReceived = getReceived;
+module.exports.getContent = getContent;
+module.exports.getWebmentionContent = getContent;
+module.exports.getSource = getSource;
+module.exports.getWebmentionSource = getSource;
+module.exports.getURL = getURL;
+module.exports.getWebmentionURL = getURL;
+module.exports.getTarget = getTarget;
+module.exports.getWebmentionTarget = getTarget;
+module.exports.getType = getType;
+module.exports.getWebmentionType = getType;
+module.exports.getByTypes = getByTypes;
+module.exports.getByType = getByTypes;
+module.exports.getWebmentionsByTypes = getByTypes;
+module.exports.getWebmentionsByType = getByTypes;
+module.exports.processBlocklist = processBlocklist;
+module.exports.processWebmentionBlocklist = processBlocklist;
+module.exports.processWebmentionsBlocklist = processBlocklist;
+module.exports.processAllowlist = processAllowlist;
+module.exports.processWebmentionAllowlist = processAllowlist;
+module.exports.processWebmentionsAllowlist = processAllowlist;
+module.exports.fetchWebmentions = fetchWebmentions;
+module.exports.retrieveWebmentions = retrieveWebmentions;
+module.exports.webmentionsByURL = webmentionsByURL;
+module.exports.webmentionsByUrl = webmentionsByURL;
+module.exports.filteredWebmentions = webmentionsByURL;
+module.exports.getWebmentions = getWebmentions;

package/eleventy-cache-webmentions.js

@@ -1,16 +1,76 @@
-const sanitizeHTML = require("sanitize-html");
-const { AssetCache } = require("@11ty/eleventy-fetch");
-const { styleText } = require("node:util");
+import { AssetCache } from "@11ty/eleventy-fetch";
+import { styleText } from "node:util";
+import sanitizeHTML from "sanitize-html";
 
 /**
- * @type {Object}
+ * @typedef {sanitizeHTML.IOptions} AllowedHTML
  */
-const defaults = {
+
+/**
+ * @typedef {Object} OptionsDefaults
+ * @prop {boolean} refresh
+ * @prop {string} duration
+ * @prop {string} uniqueKey
+ * @prop {string} [cacheDirectory]
+ * @prop {AllowedHTML} allowedHTML
+ * @prop {string[]} allowlist
+ * @prop {string[]} blocklist
+ * @prop {Object<string, string>} urlReplacements
+ * @prop {number} maximumHtmlLength
+ * @prop {string} maximumHtmlText
+ */
+
+/**
+ * @typedef {Object} OptionsUserInput
+ * @prop {string} domain
+ * @prop {string} feed
+ * @prop {string} key
+ */
+
+/**
+ * @typedef {OptionsDefaults & OptionsUserInput} Options
+ */
+
+/**
+ * @typedef {Object} Webmention
+ * @prop {string} [source]
+ * @prop {string} [url]
+ * @prop {string} [target]
+ * @prop {string} [published]
+ * @prop {string} [contentSanitized]
+ * @prop {Object} [content]
+ * @prop {string} [content.html]
+ * @prop {string} [content.value]
+ * @prop {Object} [data]
+ * @prop {string} [data.title]
+ * @prop {string} [data.url]
+ * @prop {string} [data.published]
+ * @prop {string} [data.content]
+ * @prop {string} [type]
+ * @prop {Object} [activity]
+ * @prop {string} [activity.type]
+ * @prop {boolean} [verified]
+ * @prop {string} ["wm-property"]
+ * @prop {string} ["wm-received"]
+ * @prop {string} ["wm-source"]
+ * @prop {string} ["wm-target"]
+ * @prop {string} ["verified_date"]
+ */
+
+/**
+ * @typedef {"bookmark-of"|"like-of"|"repost-of"|"mention-of"|"in-reply-to"} WebmentionType
+ */
+
+/**
+ * @type {OptionsDefaults}
+ */
+export const defaults = {
 	refresh: false,
 	duration: "1d",
 	uniqueKey: "webmentions",
+	cacheDirectory: undefined,
 	allowedHTML: {
-		allowedTags: ["b", "i", "em", "strong", "a"],
+		allowedTags: ["a", "b", "em", "i", "strong"],
 		allowedAttributes: {
 			a: ["href"],
 		},
@@ -48,7 +108,7 @@ const absoluteURL = (url, domain) => {
  * @param {string} url
  * @returns {string}
  */
-const baseUrl = (url) => {
+const baseURL = (url) => {
 	let hashSplit = url.split("#");
 	let queryparamSplit = hashSplit[0].split("?");
 	return queryparamSplit[0];
@@ -56,10 +116,10 @@ const baseUrl = (url) => {
 
 /**
  * @param {string} url
- * @param {Object} urlReplacements
+ * @param {Object<string, string>} [urlReplacements]
  * @returns {string}
  */
-const fixUrl = (url, urlReplacements) => {
+const fixURL = (url, urlReplacements) => {
 	return Object.entries(urlReplacements).reduce(
 		(accumulator, [key, value]) => {
 			const regex = new RegExp(key, "g");
@@ -90,10 +150,31 @@ const epoch = (date) => {
 };
 
 /**
- * @param {Object} date
+ * @param {Webmention[]} webmentions
+ * @returns {Webmention[]}
+ */
+const removeDuplicates = (webmentions) => {
+	return [
+		...webmentions
+			.reduce((map, webmention) => {
+				const key =
+					webmention === null || webmention === undefined
+						? webmention
+						: getSource(webmention);
+				if (!map.has(key)) {
+					map.set(key, webmention);
+				}
+				return map;
+			}, new Map())
+			.values(),
+	];
+};
+
+/**
+ * @param {Webmention} webmention
  * @returns {string|undefined}
  */
-const getPublished = (webmention) => {
+export const getPublished = (webmention) => {
 	return (
 		webmention?.["data"]?.["published"] ||
 		webmention["published"] ||
@@ -101,12 +182,13 @@ const getPublished = (webmention) => {
 		webmention["verified_date"]
 	);
 };
+export const getWebmentionPublished = getPublished;
 
 /**
- * @param {Object} webmention
+ * @param {Webmention} webmention
  * @returns {string|undefined}
  */
-const getReceived = (webmention) => {
+export const getReceived = (webmention) => {
 	return (
 		webmention["wm-received"] ||
 		webmention["verified_date"] ||
@@ -114,12 +196,13 @@ const getReceived = (webmention) => {
 		webmention?.["data"]?.["published"]
 	);
 };
+export const getWebmentionReceived = getReceived;
 
 /**
- * @param {Object} webmention
+ * @param {Webmention} webmention
  * @returns {string}
  */
-const getContent = (webmention) => {
+export const getContent = (webmention) => {
 	return (
 		webmention?.["contentSanitized"] ||
 		webmention?.["content"]?.["html"] ||
@@ -129,12 +212,13 @@ const getContent = (webmention) => {
 		""
 	);
 };
+export const getWebmentionContent = getContent;
 
 /**
- * @param {Object} webmention
- * @returns {string}
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
  */
-const getSource = (webmention) => {
+export const getSource = (webmention) => {
 	return (
 		webmention["wm-source"] ||
 		webmention["source"] ||
@@ -142,12 +226,13 @@ const getSource = (webmention) => {
 		webmention["url"]
 	);
 };
+export const getWebmentionSource = getSource;
 
 /**
- * @param {Object} webmention
- * @returns {string}
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
  */
-const getURL = (webmention) => {
+export const getURL = (webmention) => {
 	return (
 		webmention?.["data"]?.["url"] ||
 		webmention["url"] ||
@@ -155,76 +240,53 @@ const getURL = (webmention) => {
 		webmention["source"]
 	);
 };
+export const getWebmentionURL = getURL;
 
 /**
- * @param {Object} webmention
- * @returns {string}
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
  */
-const getTarget = (webmention) => {
+export const getTarget = (webmention) => {
 	return webmention["wm-target"] || webmention["target"];
 };
+export const getWebmentionTarget = getTarget;
 
 /**
- * @param {Object} webmention
+ * @param {Webmention} webmention
  * @returns {string|undefined}
  */
-const getType = (webmention) => {
+export const getType = (webmention) => {
 	return (
 		webmention["wm-property"] ||
 		webmention?.["activity"]?.["type"] ||
 		webmention["type"]
 	);
 };
+export const getWebmentionType = getType;
 
 /**
- * @param {Object[]} webmentions
- * @param {string} type
- * @returns {Object[]}
- */
-const getByType = (webmentions, type) => {
-	return webmentions.filter((webmention) => {
-		return type === getType(webmention);
-	});
-};
-
-/**
- * @param {Object[]} webmentions
- * @param {string[]} types
- * @returns {Object[]}
+ * @param {Webmention[]} webmentions
+ * @param {WebmentionType|WebmentionType[]} types
+ * @returns {Webmention[]}
  */
-const getByTypes = (webmentions, types) => {
+export const getByTypes = (webmentions, types) => {
 	return webmentions.filter((webmention) => {
+		if (typeof types === "string") {
+			return types === getType(webmention);
+		}
 		return types.includes(getType(webmention));
 	});
 };
+export const getByType = getByTypes;
+export const getWebmentionsByTypes = getByTypes;
+export const getWebmentionsByType = getByTypes;
 
 /**
- * @param {Object[]} webmentions
- * @returns {Object[]}
- */
-const removeDuplicates = (webmentions) => {
-	return [
-		...webmentions
-			.reduce((map, webmention) => {
-				const key =
-					webmention === null || webmention === undefined
-						? webmention
-						: getSource(webmention);
-				if (!map.has(key)) {
-					map.set(key, webmention);
-				}
-				return map;
-			}, new Map())
-			.values(),
-	];
-};
-
-/**
- * @param {Object[]} webmentions
+ * @param {Webmention[]} webmentions
  * @param {string[]} blocklist
- * @returns {Object[]}
+ * @returns {Webmention[]}
  */
-const processBlocklist = (webmentions, blocklist) => {
+export const processBlocklist = (webmentions, blocklist) => {
 	return webmentions.filter((webmention) => {
 		let url = getSource(webmention);
 		let source = getSource(webmention);
@@ -239,13 +301,15 @@ const processBlocklist = (webmentions, blocklist) => {
 		return true;
 	});
 };
+export const processWebmentionBlocklist = processBlocklist;
+export const processWebmentionsBlocklist = processBlocklist;
 
 /**
- * @param {Object[]} webmentions
+ * @param {Webmention[]} webmentions
  * @param {string[]} allowlist
- * @returns {Object[]}
+ * @returns {Webmention[]}
  */
-const processAllowlist = (webmentions, allowlist) => {
+export const processAllowlist = (webmentions, allowlist) => {
 	return webmentions.filter((webmention) => {
 		let url = getSource(webmention);
 		let source = getSource(webmention);
@@ -260,14 +324,16 @@ const processAllowlist = (webmentions, allowlist) => {
 		return false;
 	});
 };
+export const processWebmentionAllowlist = processAllowlist;
+export const processWebmentionsAllowlist = processAllowlist;
 
 /**
- * @param {Object} options
- * @param {Object[]} webmentions
+ * @param {Options} options
+ * @param {Webmention[]} webmentions
  * @param {string} url
- * @returns {Promise<{found:number,filtered:Object[]}>}
+ * @returns {Promise<{found: number, webmentions: Webmention[]}>}
  */
-const performFetch = async (options, webmentions, url) => {
+export const fetchWebmentions = async (options, webmentions, url) => {
 	return await fetch(url)
 		.then(async (response) => {
 			if (!response.ok) {
@@ -276,7 +342,7 @@ const performFetch = async (options, webmentions, url) => {
 
 			const feed = await response.json();
 
-			if (!options.key in feed) {
+			if (!(options.key in feed)) {
 				console.log(
 					`${styleText("grey", `[${hostname(options.domain)}]`)} ${
 						options.key
@@ -307,7 +373,7 @@ const performFetch = async (options, webmentions, url) => {
 
 			return {
 				found: feed[options.key].length,
-				filtered: webmentions,
+				webmentions: webmentions,
 			};
 		})
 		.catch((error) => {
@@ -324,16 +390,16 @@ const performFetch = async (options, webmentions, url) => {
 
 			return {
 				found: 0,
-				filtered: webmentions,
+				webmentions: webmentions,
 			};
 		});
 };
 
 /**
- * @param {Object} options
- * @returns {Promise<Object[]>}
+ * @param {Options} options
+ * @returns {Promise<Webmention[]>}
  */
-const fetchWebmentions = async (options) => {
+export const retrieveWebmentions = async (options) => {
 	if (!options.domain) {
 		throw new Error(
 			"`domain` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.",
@@ -354,7 +420,7 @@ const fetchWebmentions = async (options) => {
 
 	let asset = new AssetCache(
 		options.uniqueKey || `webmentions-${hostname(options.domain)}`,
-		options.directory,
+		options.cacheDirectory,
 	);
 
 	let webmentions = [];
@@ -394,14 +460,14 @@ const fetchWebmentions = async (options) => {
 			while (true) {
 				const urlPaginated =
 					urlObject.href + `&per-page=${perPage}&page=${page}`;
-				const fetched = await performFetch(
+				const fetched = await fetchWebmentions(
 					options,
 					webmentions,
 					urlPaginated,
 				);
 
 				// An error occurred during fetching paged results → break
-				if (!fetched && !fetched.found && !fetched.filtered) {
+				if (!fetched && !fetched.found && !fetched.webmentions) {
 					break;
 				}
 
@@ -410,7 +476,7 @@ const fetchWebmentions = async (options) => {
 					break;
 				}
 
-				webmentions = fetched.filtered;
+				webmentions = fetched.webmentions;
 
 				// If there are less Webmentions found than should be in each
 				// page → break
@@ -424,8 +490,8 @@ const fetchWebmentions = async (options) => {
 				await new Promise((resolve) => setTimeout(resolve, 1000));
 			}
 		} else {
-			const fetched = await performFetch(options, webmentions, url);
-			webmentions = fetched.filtered;
+			const fetched = await fetchWebmentions(options, webmentions, url);
+			webmentions = fetched.webmentions;
 		}
 
 		// Process the blocklist, if it has any entries
@@ -463,47 +529,50 @@ const fetchWebmentions = async (options) => {
 	return webmentions;
 };
 
-let filtered = {};
+/** @type {Webmention[]} */
+const WEBMENTIONS = {};
 
 /**
- * @param {Object} options
- * @returns {Promise<Object<string, Object[]>>}
+ * @param {Options} options
+ * @returns {Promise<Object<string, Webmention[]>>}
  */
-const filteredWebmentions = async (options) => {
-	if (Object.entries(filtered).length) {
-		return filtered;
+export const webmentionsByURL = async (options) => {
+	if (Object.keys(WEBMENTIONS).length) {
+		return WEBMENTIONS;
 	}
 
-	let rawWebmentions = await fetchWebmentions(options);
+	let rawWebmentions = await retrieveWebmentions(options);
 
 	// Fix local URLs based on urlReplacements and sort Webmentions into groups
 	// by target base URL
 	rawWebmentions.forEach((webmention) => {
-		let url = baseUrl(
-			fixUrl(
+		let url = baseURL(
+			fixURL(
 				getTarget(webmention).replace(/\/?$/, "/"),
 				options.urlReplacements,
 			),
 		);
 
-		if (!filtered[url]) {
-			filtered[url] = [];
+		if (!WEBMENTIONS[url]) {
+			WEBMENTIONS[url] = [];
 		}
 
-		filtered[url].push(webmention);
+		WEBMENTIONS[url].push(webmention);
 	});
 
-	return filtered;
+	return WEBMENTIONS;
 };
+export const webmentionsByUrl = webmentionsByURL;
+export const filteredWebmentions = webmentionsByURL;
 
 /**
- * @param {Object} options
+ * @param {Options} options
  * @param {string} url
- * @param {string[]|Object} [types={}]
- * @returns {Promise<Object[]>}
+ * @param {WebmentionType[]|WebmentionType} [types=[]]
+ * @returns {Promise<Webmention[]>}
  */
-const getWebmentions = async (options, url, types = {}) => {
-	const webmentions = await filteredWebmentions(options);
+export const getWebmentions = async (options, url, types = []) => {
+	const webmentions = await webmentionsByURL(options);
 	url = absoluteURL(url, options.domain);
 
 	if (!url || !webmentions || !webmentions[url]) {
@@ -516,6 +585,8 @@ const getWebmentions = async (options, url, types = {}) => {
 			.filter((entry) => {
 				return typeof types === "object" && Object.keys(types).length
 					? types.includes(getType(entry))
+					: typeof types === "string"
+					? types === getType(entry)
 					: true;
 			})
 			// Sanitize content of webmentions against HTML limit
@@ -547,27 +618,26 @@ const getWebmentions = async (options, url, types = {}) => {
 
 /**
  * @param {Object} eleventyConfig
- * @param {Object} [options={}]
+ * @param {Options} [options={}]
  */
-const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
+export const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
 	options = Object.assign(defaults, options);
 
+	const byURL = webmentionsByURL(options);
+	const all = Object.values(byURL).reduce(
+		(array, webmentions) => [...array, ...webmentions],
+		[],
+	);
+
 	// Global Data
 	eleventyConfig.addGlobalData("webmentionsDefaults", defaults);
 	eleventyConfig.addGlobalData("webmentionsOptions", options);
-	const filtered = async () => await filteredWebmentions(options);
-	eleventyConfig.addGlobalData("webmentionsByUrl", filtered);
-	const unfiltered = async () =>
-		await filteredWebmentions(options).then((filtered) =>
-			Object.values(filtered).reduce(
-				(array, webmentions) => [...array, ...webmentions],
-				[],
-			),
-		);
-	eleventyConfig.addGlobalData("webmentionsAll", unfiltered);
+	eleventyConfig.addGlobalData("webmentionsByURL", byURL);
+	eleventyConfig.addGlobalData("webmentionsByUrl", byURL);
+	eleventyConfig.addGlobalData("webmentionsAll", all);
 
 	// Liquid Filters
-	eleventyConfig.addLiquidFilter("getWebmentionsByType", getByType);
+	eleventyConfig.addLiquidFilter("getWebmentionsByType", getByTypes);
 	eleventyConfig.addLiquidFilter("getWebmentionsByTypes", getByTypes);
 	eleventyConfig.addLiquidFilter("getWebmentionPublished", getPublished);
 	eleventyConfig.addLiquidFilter("getWebmentionReceived", getReceived);
@@ -578,7 +648,7 @@ const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
 	eleventyConfig.addLiquidFilter("getWebmentionType", getType);
 
 	// Nunjucks Filters
-	eleventyConfig.addNunjucksFilter("getWebmentionsByType", getByType);
+	eleventyConfig.addNunjucksFilter("getWebmentionsByType", getByTypes);
 	eleventyConfig.addNunjucksFilter("getWebmentionsByTypes", getByTypes);
 	eleventyConfig.addNunjucksFilter("getWebmentionPublished", getPublished);
 	eleventyConfig.addNunjucksFilter("getWebmentionReceived", getReceived);
@@ -589,28 +659,4 @@ const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
 	eleventyConfig.addNunjucksFilter("getWebmentionType", getType);
 };
 
-module.exports = eleventyCacheWebmentions;
-module.exports.defaults = defaults;
-module.exports.filteredWebmentions = filteredWebmentions;
-module.exports.webmentionsByUrl = filteredWebmentions;
-module.exports.fetchWebmentions = fetchWebmentions;
-module.exports.performFetch = performFetch;
-module.exports.getWebmentions = getWebmentions;
-module.exports.getByType = getByType;
-module.exports.getWebmentionsByType = getByType;
-module.exports.getByTypes = getByTypes;
-module.exports.getWebmentionsByTypes = getByTypes;
-module.exports.getPublished = getPublished;
-module.exports.getWebmentionPublished = getPublished;
-module.exports.getReceived = getReceived;
-module.exports.getWebmentionReceived = getReceived;
-module.exports.getContent = getContent;
-module.exports.getWebmentionContent = getContent;
-module.exports.getSource = getSource;
-module.exports.getWebmentionSource = getSource;
-module.exports.getURL = getURL;
-module.exports.getWebmentionURL = getURL;
-module.exports.getTarget = getTarget;
-module.exports.getWebmentionTarget = getTarget;
-module.exports.getType = getType;
-module.exports.getWebmentionType = getType;
+export default eleventyCacheWebmentions;

package/eleventy-cache-webmentions.min.cjs

@@ -0,0 +1 @@
+const{AssetCache}=require("@11ty/eleventy-fetch"),{styleText}=require("node:util"),sanitizeHTML=require("sanitize-html"),defaults={refresh:!1,duration:"1d",uniqueKey:"webmentions",cacheDirectory:void 0,allowedHTML:{allowedTags:["a","b","em","i","strong"],allowedAttributes:{a:["href"]}},allowlist:[],blocklist:[],urlReplacements:{},maximumHtmlLength:1e3,maximumHtmlText:"mentioned this in"},absoluteURL=(url,domain)=>{try{return new URL(url,domain).toString()}catch{return console.error(`Trying to convert ${styleText("bold",url)} to be an absolute url with base ${styleText("bold",domain)} and failed.`),url}},baseURL=url=>url.split("#")[0].split("?")[0],fixURL=(url,urlReplacements)=>Object.entries(urlReplacements).reduce((accumulator,[key,value])=>{const regex=new RegExp(key,"g");return accumulator.replace(regex,value)},url),hostname=url=>typeof url=="string"&&url.includes("//")?new URL(url).hostname:url,epoch=date=>new Date(date).getTime(),removeDuplicates=webmentions=>[...webmentions.reduce((map,webmention)=>{const key=webmention==null?webmention:getSource(webmention);return map.has(key)||map.set(key,webmention),map},new Map).values()],getPublished=webmention=>webmention?.data?.published||webmention.published||webmention["wm-received"]||webmention.verified_date,getReceived=webmention=>webmention["wm-received"]||webmention.verified_date||webmention.published||webmention?.data?.published,getContent=webmention=>webmention?.contentSanitized||webmention?.content?.html||webmention?.content?.value||webmention?.content||webmention?.data?.content||"",getSource=webmention=>webmention["wm-source"]||webmention.source||webmention?.data?.url||webmention.url,getURL=webmention=>webmention?.data?.url||webmention.url||webmention["wm-source"]||webmention.source,getTarget=webmention=>webmention["wm-target"]||webmention.target,getType=webmention=>webmention["wm-property"]||webmention?.activity?.type||webmention.type,getByTypes=(webmentions,types)=>webmentions.filter(webmention=>typeof types=="string"?types===getType(webmention):types.includes(getType(webmention))),processBlocklist=(webmentions,blocklist)=>webmentions.filter(webmention=>{let url=getSource(webmention),source=getSource(webmention);for(let blocklistURL of blocklist)if(url.includes(blocklistURL.replace(/\/?$/,"/"))||source.includes(blocklistURL.replace(/\/?$/,"/")))return!1;return!0}),processAllowlist=(webmentions,allowlist)=>webmentions.filter(webmention=>{let url=getSource(webmention),source=getSource(webmention);for(let allowlistURL of allowlist)if(url.includes(allowlistURL.replace(/\/?$/,"/"))||source.includes(allowlistURL.replace(/\/?$/,"/")))return!0;return!1}),fetchWebmentions=async(options,webmentions,url)=>await fetch(url).then(async response=>{if(!response.ok)return Promise.reject(response);const feed=await response.json();return options.key in feed?(webmentions=feed[options.key].concat(webmentions),webmentions=removeDuplicates(webmentions),options.blocklist.length&&(webmentions=processBlocklist(webmentions,options.blocklist)),options.allowlist.length&&(webmentions=processAllowlist(webmentions,options.allowlist)),webmentions=webmentions.sort((a,b)=>epoch(getReceived(b))-epoch(getReceived(a))),{found:feed[options.key].length,webmentions}):(console.log(`${styleText("grey",`[${hostname(options.domain)}]`)} ${options.key} was not found as a key in the response from ${styleText("bold",hostname(options.feed))}!`),Promise.reject(response))}).catch(error=>(console.warn(`${styleText("grey",`[${hostname(options.domain)}]`)} Something went wrong with your Webmention request to ${styleText("bold",hostname(options.feed))}!`),console.warn(error instanceof Error?error.message:error),{found:0,webmentions})),retrieveWebmentions=async options=>{if(!options.domain)throw new Error("`domain` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.");if(!options.feed)throw new Error("`feed` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.");if(!options.key)throw new Error("`key` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.");let asset=new AssetCache(options.uniqueKey||`webmentions-${hostname(options.domain)}`,options.cacheDirectory),webmentions=[];asset.isCacheValid("9001y")&&!options.refresh&&(webmentions=await asset.getCachedValue());const webmentionsCachedLength=webmentions.length;if(!asset.isCacheValid(options.refresh?"0s":options.duration)){const performanceStart=process.hrtime(),since=webmentions.length?getReceived(webmentions[0]):!1,url=`${options.feed}${since?`${options.feed.includes("?")?"&":"?"}since=${since}`:""}`;if(url.includes("https://webmention.io")){const urlObject=new URL(url),perPage=Number(urlObject.searchParams.get("per-page"))||1e3;urlObject.searchParams.delete("per-page");let page=0;for(;;){const urlPaginated=urlObject.href+`&per-page=${perPage}&page=${page}`,fetched=await fetchWebmentions(options,webmentions,urlPaginated);if(!fetched&&!fetched.found&&!fetched.webmentions||fetched.found===0||(webmentions=fetched.webmentions,fetched.found<perPage))break;page+=1,await new Promise(resolve=>setTimeout(resolve,1e3))}}else webmentions=(await fetchWebmentions(options,webmentions,url)).webmentions;options.blocklist.length&&(webmentions=processBlocklist(webmentions,options.blocklist)),options.allowlist.length&&(webmentions=processAllowlist(webmentions,options.allowlist)),await asset.save(webmentions,"json");const performance=process.hrtime(performanceStart);webmentionsCachedLength<webmentions.length&&console.log(`${styleText("grey",`[${hostname(options.domain)}]`)} ${styleText("bold",String(webmentions.length-webmentionsCachedLength))} new Webmentions fetched into cache in ${styleText("bold",(performance[0]+performance[1]/1e9).toFixed(3)+" seconds")}.`)}return webmentions},WEBMENTIONS={},webmentionsByURL=async options=>(Object.keys(WEBMENTIONS).length||(await retrieveWebmentions(options)).forEach(webmention=>{let url=baseURL(fixURL(getTarget(webmention).replace(/\/?$/,"/"),options.urlReplacements));WEBMENTIONS[url]||(WEBMENTIONS[url]=[]),WEBMENTIONS[url].push(webmention)}),WEBMENTIONS),getWebmentions=async(options,url,types=[])=>{const webmentions=await webmentionsByURL(options);return url=absoluteURL(url,options.domain),!url||!webmentions||!webmentions[url]?[]:webmentions[url].filter(entry=>typeof types=="object"&&Object.keys(types).length?types.includes(getType(entry)):typeof types=="string"?types===getType(entry):!0).map(entry=>{const html=getContent(entry);return html.length&&(entry.contentSanitized=sanitizeHTML(html,options.allowedHTML),html.length>options.maximumHtmlLength&&(entry.contentSanitized=`${options.maximumHtmlText} <a href="${getSource(entry)}">${getSource(entry)}</a>`)),entry}).sort((a,b)=>epoch(getPublished(a))-epoch(getPublished(b)))},eleventyCacheWebmentions=(eleventyConfig,options={})=>{options=Object.assign(defaults,options);const byURL=webmentionsByURL(options),all=Object.values(byURL).reduce((array,webmentions)=>[...array,...webmentions],[]);eleventyConfig.addGlobalData("webmentionsDefaults",defaults),eleventyConfig.addGlobalData("webmentionsOptions",options),eleventyConfig.addGlobalData("webmentionsByURL",byURL),eleventyConfig.addGlobalData("webmentionsByUrl",byURL),eleventyConfig.addGlobalData("webmentionsAll",all),eleventyConfig.addLiquidFilter("getWebmentionsByType",getByTypes),eleventyConfig.addLiquidFilter("getWebmentionsByTypes",getByTypes),eleventyConfig.addLiquidFilter("getWebmentionPublished",getPublished),eleventyConfig.addLiquidFilter("getWebmentionReceived",getReceived),eleventyConfig.addLiquidFilter("getWebmentionContent",getContent),eleventyConfig.addLiquidFilter("getWebmentionSource",getSource),eleventyConfig.addLiquidFilter("getWebmentionURL",getURL),eleventyConfig.addLiquidFilter("getWebmentionTarget",getTarget),eleventyConfig.addLiquidFilter("getWebmentionType",getType),eleventyConfig.addNunjucksFilter("getWebmentionsByType",getByTypes),eleventyConfig.addNunjucksFilter("getWebmentionsByTypes",getByTypes),eleventyConfig.addNunjucksFilter("getWebmentionPublished",getPublished),eleventyConfig.addNunjucksFilter("getWebmentionReceived",getReceived),eleventyConfig.addNunjucksFilter("getWebmentionContent",getContent),eleventyConfig.addNunjucksFilter("getWebmentionSource",getSource),eleventyConfig.addNunjucksFilter("getWebmentionURL",getURL),eleventyConfig.addNunjucksFilter("getWebmentionTarget",getTarget),eleventyConfig.addNunjucksFilter("getWebmentionType",getType)};module.exports=eleventyCacheWebmentions,module.exports.defaults=defaults,module.exports.getPublished=getPublished,module.exports.getWebmentionPublished=getPublished,module.exports.getReceived=getReceived,module.exports.getWebmentionReceived=getReceived,module.exports.getContent=getContent,module.exports.getWebmentionContent=getContent,module.exports.getSource=getSource,module.exports.getWebmentionSource=getSource,module.exports.getURL=getURL,module.exports.getWebmentionURL=getURL,module.exports.getTarget=getTarget,module.exports.getWebmentionTarget=getTarget,module.exports.getType=getType,module.exports.getWebmentionType=getType,module.exports.getByTypes=getByTypes,module.exports.getByType=getByTypes,module.exports.getWebmentionsByTypes=getByTypes,module.exports.getWebmentionsByType=getByTypes,module.exports.processBlocklist=processBlocklist,module.exports.processWebmentionBlocklist=processBlocklist,module.exports.processWebmentionsBlocklist=processBlocklist,module.exports.processAllowlist=processAllowlist,module.exports.processWebmentionAllowlist=processAllowlist,module.exports.processWebmentionsAllowlist=processAllowlist,module.exports.fetchWebmentions=fetchWebmentions,module.exports.retrieveWebmentions=retrieveWebmentions,module.exports.webmentionsByURL=webmentionsByURL,module.exports.webmentionsByUrl=webmentionsByURL,module.exports.filteredWebmentions=webmentionsByURL,module.exports.getWebmentions=getWebmentions;

package/eleventy-cache-webmentions.min.js

@@ -0,0 +1 @@
+import{AssetCache}from"@11ty/eleventy-fetch";import{styleText}from"node:util";import sanitizeHTML from"sanitize-html";export const defaults={refresh:!1,duration:"1d",uniqueKey:"webmentions",cacheDirectory:void 0,allowedHTML:{allowedTags:["a","b","em","i","strong"],allowedAttributes:{a:["href"]}},allowlist:[],blocklist:[],urlReplacements:{},maximumHtmlLength:1e3,maximumHtmlText:"mentioned this in"};const absoluteURL=(url,domain)=>{try{return new URL(url,domain).toString()}catch{return console.error(`Trying to convert ${styleText("bold",url)} to be an absolute url with base ${styleText("bold",domain)} and failed.`),url}},baseURL=url=>url.split("#")[0].split("?")[0],fixURL=(url,urlReplacements)=>Object.entries(urlReplacements).reduce((accumulator,[key,value])=>{const regex=new RegExp(key,"g");return accumulator.replace(regex,value)},url),hostname=url=>typeof url=="string"&&url.includes("//")?new URL(url).hostname:url,epoch=date=>new Date(date).getTime(),removeDuplicates=webmentions=>[...webmentions.reduce((map,webmention)=>{const key=webmention==null?webmention:getSource(webmention);return map.has(key)||map.set(key,webmention),map},new Map).values()];export const getPublished=webmention=>webmention?.data?.published||webmention.published||webmention["wm-received"]||webmention.verified_date,getWebmentionPublished=getPublished,getReceived=webmention=>webmention["wm-received"]||webmention.verified_date||webmention.published||webmention?.data?.published,getWebmentionReceived=getReceived,getContent=webmention=>webmention?.contentSanitized||webmention?.content?.html||webmention?.content?.value||webmention?.content||webmention?.data?.content||"",getWebmentionContent=getContent,getSource=webmention=>webmention["wm-source"]||webmention.source||webmention?.data?.url||webmention.url,getWebmentionSource=getSource,getURL=webmention=>webmention?.data?.url||webmention.url||webmention["wm-source"]||webmention.source,getWebmentionURL=getURL,getTarget=webmention=>webmention["wm-target"]||webmention.target,getWebmentionTarget=getTarget,getType=webmention=>webmention["wm-property"]||webmention?.activity?.type||webmention.type,getWebmentionType=getType,getByTypes=(webmentions,types)=>webmentions.filter(webmention=>typeof types=="string"?types===getType(webmention):types.includes(getType(webmention))),getByType=getByTypes,getWebmentionsByTypes=getByTypes,getWebmentionsByType=getByTypes,processBlocklist=(webmentions,blocklist)=>webmentions.filter(webmention=>{let url=getSource(webmention),source=getSource(webmention);for(let blocklistURL of blocklist)if(url.includes(blocklistURL.replace(/\/?$/,"/"))||source.includes(blocklistURL.replace(/\/?$/,"/")))return!1;return!0}),processWebmentionBlocklist=processBlocklist,processWebmentionsBlocklist=processBlocklist,processAllowlist=(webmentions,allowlist)=>webmentions.filter(webmention=>{let url=getSource(webmention),source=getSource(webmention);for(let allowlistURL of allowlist)if(url.includes(allowlistURL.replace(/\/?$/,"/"))||source.includes(allowlistURL.replace(/\/?$/,"/")))return!0;return!1}),processWebmentionAllowlist=processAllowlist,processWebmentionsAllowlist=processAllowlist,fetchWebmentions=async(options,webmentions,url)=>await fetch(url).then(async response=>{if(!response.ok)return Promise.reject(response);const feed=await response.json();return options.key in feed?(webmentions=feed[options.key].concat(webmentions),webmentions=removeDuplicates(webmentions),options.blocklist.length&&(webmentions=processBlocklist(webmentions,options.blocklist)),options.allowlist.length&&(webmentions=processAllowlist(webmentions,options.allowlist)),webmentions=webmentions.sort((a,b)=>epoch(getReceived(b))-epoch(getReceived(a))),{found:feed[options.key].length,webmentions}):(console.log(`${styleText("grey",`[${hostname(options.domain)}]`)} ${options.key} was not found as a key in the response from ${styleText("bold",hostname(options.feed))}!`),Promise.reject(response))}).catch(error=>(console.warn(`${styleText("grey",`[${hostname(options.domain)}]`)} Something went wrong with your Webmention request to ${styleText("bold",hostname(options.feed))}!`),console.warn(error instanceof Error?error.message:error),{found:0,webmentions})),retrieveWebmentions=async options=>{if(!options.domain)throw new Error("`domain` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.");if(!options.feed)throw new Error("`feed` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.");if(!options.key)throw new Error("`key` is a required field when attempting to retrieve Webmentions. See https://www.npmjs.com/package/@chrisburnell/eleventy-cache-webmentions#installation for more information.");let asset=new AssetCache(options.uniqueKey||`webmentions-${hostname(options.domain)}`,options.cacheDirectory),webmentions=[];asset.isCacheValid("9001y")&&!options.refresh&&(webmentions=await asset.getCachedValue());const webmentionsCachedLength=webmentions.length;if(!asset.isCacheValid(options.refresh?"0s":options.duration)){const performanceStart=process.hrtime(),since=webmentions.length?getReceived(webmentions[0]):!1,url=`${options.feed}${since?`${options.feed.includes("?")?"&":"?"}since=${since}`:""}`;if(url.includes("https://webmention.io")){const urlObject=new URL(url),perPage=Number(urlObject.searchParams.get("per-page"))||1e3;urlObject.searchParams.delete("per-page");let page=0;for(;;){const urlPaginated=urlObject.href+`&per-page=${perPage}&page=${page}`,fetched=await fetchWebmentions(options,webmentions,urlPaginated);if(!fetched&&!fetched.found&&!fetched.webmentions||fetched.found===0||(webmentions=fetched.webmentions,fetched.found<perPage))break;page+=1,await new Promise(resolve=>setTimeout(resolve,1e3))}}else webmentions=(await fetchWebmentions(options,webmentions,url)).webmentions;options.blocklist.length&&(webmentions=processBlocklist(webmentions,options.blocklist)),options.allowlist.length&&(webmentions=processAllowlist(webmentions,options.allowlist)),await asset.save(webmentions,"json");const performance=process.hrtime(performanceStart);webmentionsCachedLength<webmentions.length&&console.log(`${styleText("grey",`[${hostname(options.domain)}]`)} ${styleText("bold",String(webmentions.length-webmentionsCachedLength))} new Webmentions fetched into cache in ${styleText("bold",(performance[0]+performance[1]/1e9).toFixed(3)+" seconds")}.`)}return webmentions};const WEBMENTIONS={};export const webmentionsByURL=async options=>(Object.keys(WEBMENTIONS).length||(await retrieveWebmentions(options)).forEach(webmention=>{let url=baseURL(fixURL(getTarget(webmention).replace(/\/?$/,"/"),options.urlReplacements));WEBMENTIONS[url]||(WEBMENTIONS[url]=[]),WEBMENTIONS[url].push(webmention)}),WEBMENTIONS),webmentionsByUrl=webmentionsByURL,filteredWebmentions=webmentionsByURL,getWebmentions=async(options,url,types=[])=>{const webmentions=await webmentionsByURL(options);return url=absoluteURL(url,options.domain),!url||!webmentions||!webmentions[url]?[]:webmentions[url].filter(entry=>typeof types=="object"&&Object.keys(types).length?types.includes(getType(entry)):typeof types=="string"?types===getType(entry):!0).map(entry=>{const html=getContent(entry);return html.length&&(entry.contentSanitized=sanitizeHTML(html,options.allowedHTML),html.length>options.maximumHtmlLength&&(entry.contentSanitized=`${options.maximumHtmlText} <a href="${getSource(entry)}">${getSource(entry)}</a>`)),entry}).sort((a,b)=>epoch(getPublished(a))-epoch(getPublished(b)))},eleventyCacheWebmentions=(eleventyConfig,options={})=>{options=Object.assign(defaults,options);const byURL=webmentionsByURL(options),all=Object.values(byURL).reduce((array,webmentions)=>[...array,...webmentions],[]);eleventyConfig.addGlobalData("webmentionsDefaults",defaults),eleventyConfig.addGlobalData("webmentionsOptions",options),eleventyConfig.addGlobalData("webmentionsByURL",byURL),eleventyConfig.addGlobalData("webmentionsByUrl",byURL),eleventyConfig.addGlobalData("webmentionsAll",all),eleventyConfig.addLiquidFilter("getWebmentionsByType",getByTypes),eleventyConfig.addLiquidFilter("getWebmentionsByTypes",getByTypes),eleventyConfig.addLiquidFilter("getWebmentionPublished",getPublished),eleventyConfig.addLiquidFilter("getWebmentionReceived",getReceived),eleventyConfig.addLiquidFilter("getWebmentionContent",getContent),eleventyConfig.addLiquidFilter("getWebmentionSource",getSource),eleventyConfig.addLiquidFilter("getWebmentionURL",getURL),eleventyConfig.addLiquidFilter("getWebmentionTarget",getTarget),eleventyConfig.addLiquidFilter("getWebmentionType",getType),eleventyConfig.addNunjucksFilter("getWebmentionsByType",getByTypes),eleventyConfig.addNunjucksFilter("getWebmentionsByTypes",getByTypes),eleventyConfig.addNunjucksFilter("getWebmentionPublished",getPublished),eleventyConfig.addNunjucksFilter("getWebmentionReceived",getReceived),eleventyConfig.addNunjucksFilter("getWebmentionContent",getContent),eleventyConfig.addNunjucksFilter("getWebmentionSource",getSource),eleventyConfig.addNunjucksFilter("getWebmentionURL",getURL),eleventyConfig.addNunjucksFilter("getWebmentionTarget",getTarget),eleventyConfig.addNunjucksFilter("getWebmentionType",getType)};export default eleventyCacheWebmentions;

package/eslint.config.js

@@ -1,16 +1,36 @@
-module.exports = [
+import js from "@eslint/js";
+
+export default [
+	js.configs.recommended,
 	{
-		files: ["**/*.js"],
+		files: ["src/**/*.js"],
 		languageOptions: {
-			ecmaVersion: 12,
-			sourceType: "module",
+			ecmaVersion: "latest",
 		},
-		languageOptions: {
-			globals: {
-				browser: true,
-				commonjs: true,
-				es2021: true,
-			},
+		rules: {
+			"no-process-env": 0,
+			"jsdoc/check-access": "warn",
+			"jsdoc/check-alignment": "warn",
+			"jsdoc/check-indentation": "warn",
+			"jsdoc/check-param-names": "warn",
+			"jsdoc/check-tag-names": "warn",
+			"jsdoc/check-types": "warn",
+			"jsdoc/implements-on-classes": "warn",
+			"jsdoc/no-undefined-types": "warn",
+			"jsdoc/require-jsdoc": [
+				"warn",
+				{
+					require: {
+						FunctionDeclaration: true,
+						MethodDefinition: true,
+						ClassDeclaration: true,
+					},
+				},
+			],
+			"jsdoc/require-param": "warn",
+			"jsdoc/require-param-type": "warn",
+			"jsdoc/require-returns": "warn",
+			"jsdoc/require-returns-type": "warn",
 		},
 	},
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chrisburnell/eleventy-cache-webmentions",
-  "version": "2.1.12",
+  "version": "2.2.2",
   "description": "Cache webmentions using eleventy-fetch and make them available to use in collections, layouts, pages, etc. in Eleventy.",
   "license": "MIT",
   "repository": {
@@ -37,8 +37,15 @@
     "access": "public",
     "provenance": true
   },
-  "main": "eleventy-cache-webmentions.js",
+  "main": "eleventy-cache-webmentions.cjs",
+  "exports": {
+    ".": {
+      "require": "./eleventy-cache-webmentions.cjs",
+      "import": "./eleventy-cache-webmentions.js"
+    }
+  },
   "scripts": {
+    "build": "esbuild eleventy-cache-webmentions.js --minify-whitespace --minify-syntax --outfile=eleventy-cache-webmentions.min.js && esbuild eleventy-cache-webmentions.cjs --minify-whitespace --minify-syntax --outfile=eleventy-cache-webmentions.min.cjs",
     "lint": "eslint eleventy-cache-webmentions.js",
     "test": "node --test"
   },
@@ -58,7 +65,9 @@
     "sanitize-html": "^2.17.0"
   },
   "devDependencies": {
+    "esbuild": "^0.25.11",
     "eslint": "^9.38.0",
     "nock": "^14.0.10"
-  }
+  },
+  "type": "module"
 }