@chrisburnell/eleventy-cache-webmentions 2.1.11 → 2.2.1

package/eleventy-cache-webmentions.js

@@ -1,13 +1,76 @@
-const sanitizeHTML = require("sanitize-html");
-const { AssetCache } = require("@11ty/eleventy-fetch");
-const { styleText } = require("node:util");
-
-const defaults = {
+import { AssetCache } from "@11ty/eleventy-fetch";
+import { styleText } from "node:util";
+import sanitizeHTML from "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}
+ */
+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"],
 		},
@@ -19,6 +82,11 @@ const defaults = {
 	maximumHtmlText: "mentioned this in",
 };
 
+/**
+ * @param {string} url
+ * @param {string} domain
+ * @returns {string}
+ */
 const absoluteURL = (url, domain) => {
 	try {
 		return new URL(url, domain).toString();
@@ -36,13 +104,22 @@ const absoluteURL = (url, domain) => {
 	}
 };
 
-const baseUrl = (url) => {
+/**
+ * @param {string} url
+ * @returns {string}
+ */
+const baseURL = (url) => {
 	let hashSplit = url.split("#");
 	let queryparamSplit = hashSplit[0].split("?");
 	return queryparamSplit[0];
 };
 
-const fixUrl = (url, urlReplacements) => {
+/**
+ * @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");
@@ -52,19 +129,52 @@ const fixUrl = (url, urlReplacements) => {
 	);
 };
 
-const hostname = (value) => {
-	if (typeof value === "string" && value.includes("//")) {
-		const urlObject = new URL(value);
+/**
+ * @param {string} url
+ * @returns {string}
+ */
+const hostname = (url) => {
+	if (typeof url === "string" && url.includes("//")) {
+		const urlObject = new URL(url);
 		return urlObject.hostname;
 	}
-	return value;
+	return url;
 };
 
-const epoch = (value) => {
-	return new Date(value).getTime();
+/**
+ * @param {string|number|Date} date
+ * @returns {number}
+ */
+const epoch = (date) => {
+	return new Date(date).getTime();
 };
 
-const getPublished = (webmention) => {
+/**
+ * @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}
+ */
+export const getPublished = (webmention) => {
 	return (
 		webmention?.["data"]?.["published"] ||
 		webmention["published"] ||
@@ -72,8 +182,13 @@ const getPublished = (webmention) => {
 		webmention["verified_date"]
 	);
 };
+export const getWebmentionPublished = getPublished;
 
-const getReceived = (webmention) => {
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+export const getReceived = (webmention) => {
 	return (
 		webmention["wm-received"] ||
 		webmention["verified_date"] ||
@@ -81,8 +196,13 @@ const getReceived = (webmention) => {
 		webmention?.["data"]?.["published"]
 	);
 };
+export const getWebmentionReceived = getReceived;
 
-const getContent = (webmention) => {
+/**
+ * @param {Webmention} webmention
+ * @returns {string}
+ */
+export const getContent = (webmention) => {
 	return (
 		webmention?.["contentSanitized"] ||
 		webmention?.["content"]?.["html"] ||
@@ -92,8 +212,13 @@ const getContent = (webmention) => {
 		""
 	);
 };
+export const getWebmentionContent = getContent;
 
-const getSource = (webmention) => {
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+export const getSource = (webmention) => {
 	return (
 		webmention["wm-source"] ||
 		webmention["source"] ||
@@ -101,8 +226,13 @@ const getSource = (webmention) => {
 		webmention["url"]
 	);
 };
+export const getWebmentionSource = getSource;
 
-const getURL = (webmention) => {
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+export const getURL = (webmention) => {
 	return (
 		webmention?.["data"]?.["url"] ||
 		webmention["url"] ||
@@ -110,49 +240,53 @@ const getURL = (webmention) => {
 		webmention["source"]
 	);
 };
+export const getWebmentionURL = getURL;
 
-const getTarget = (webmention) => {
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+export const getTarget = (webmention) => {
 	return webmention["wm-target"] || webmention["target"];
 };
+export const getWebmentionTarget = getTarget;
 
-const getType = (webmention) => {
+/**
+ * @param {Webmention} webmention
+ * @returns {string|undefined}
+ */
+export const getType = (webmention) => {
 	return (
 		webmention["wm-property"] ||
 		webmention?.["activity"]?.["type"] ||
 		webmention["type"]
 	);
 };
-
-const getByType = (webmentions, allowedType) => {
-	return webmentions.filter((webmention) => {
-		return allowedType === getType(webmention);
-	});
-};
-
-const getByTypes = (webmentions, allowedTypes) => {
+export const getWebmentionType = getType;
+
+/**
+ * @param {Webmention[]} webmentions
+ * @param {WebmentionType|WebmentionType[]} types
+ * @returns {Webmention[]}
+ */
+export const getByTypes = (webmentions, types) => {
 	return webmentions.filter((webmention) => {
-		return allowedTypes.includes(getType(webmention));
+		if (typeof types === "string") {
+			return types === getType(webmention);
+		}
+		return types.includes(getType(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(),
-	];
-};
-
-const processBlocklist = (webmentions, blocklist) => {
+export const getByType = getByTypes;
+export const getWebmentionsByTypes = getByTypes;
+export const getWebmentionsByType = getByTypes;
+
+/**
+ * @param {Webmention[]} webmentions
+ * @param {string[]} blocklist
+ * @returns {Webmention[]}
+ */
+export const processBlocklist = (webmentions, blocklist) => {
 	return webmentions.filter((webmention) => {
 		let url = getSource(webmention);
 		let source = getSource(webmention);
@@ -167,8 +301,15 @@ const processBlocklist = (webmentions, blocklist) => {
 		return true;
 	});
 };
-
-const processAllowlist = (webmentions, allowlist) => {
+export const processWebmentionBlocklist = processBlocklist;
+export const processWebmentionsBlocklist = processBlocklist;
+
+/**
+ * @param {Webmention[]} webmentions
+ * @param {string[]} allowlist
+ * @returns {Webmention[]}
+ */
+export const processAllowlist = (webmentions, allowlist) => {
 	return webmentions.filter((webmention) => {
 		let url = getSource(webmention);
 		let source = getSource(webmention);
@@ -183,8 +324,16 @@ const processAllowlist = (webmentions, allowlist) => {
 		return false;
 	});
 };
-
-const performFetch = async (options, webmentions, url) => {
+export const processWebmentionAllowlist = processAllowlist;
+export const processWebmentionsAllowlist = processAllowlist;
+
+/**
+ * @param {Options} options
+ * @param {Webmention[]} webmentions
+ * @param {string} url
+ * @returns {Promise<{found: number, webmentions: Webmention[]}>}
+ */
+export const fetchWebmentions = async (options, webmentions, url) => {
 	return await fetch(url)
 		.then(async (response) => {
 			if (!response.ok) {
@@ -193,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
@@ -224,7 +373,7 @@ const performFetch = async (options, webmentions, url) => {
 
 			return {
 				found: feed[options.key].length,
-				filtered: webmentions,
+				webmentions: webmentions,
 			};
 		})
 		.catch((error) => {
@@ -241,12 +390,16 @@ const performFetch = async (options, webmentions, url) => {
 
 			return {
 				found: 0,
-				filtered: webmentions,
+				webmentions: webmentions,
 			};
 		});
 };
 
-const fetchWebmentions = async (options) => {
+/**
+ * @param {Options} options
+ * @returns {Promise<Webmention[]>}
+ */
+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.",
@@ -267,7 +420,7 @@ const fetchWebmentions = async (options) => {
 
 	let asset = new AssetCache(
 		options.uniqueKey || `webmentions-${hostname(options.domain)}`,
-		options.directory,
+		options.cacheDirectory,
 	);
 
 	let webmentions = [];
@@ -307,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;
 				}
 
@@ -323,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
@@ -337,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
@@ -376,36 +529,50 @@ const fetchWebmentions = async (options) => {
 	return webmentions;
 };
 
-let filtered = {};
-const filteredWebmentions = async (options) => {
-	if (Object.entries(filtered).length) {
-		return filtered;
+/** @type {Webmention[]} */
+const WEBMENTIONS = {};
+
+/**
+ * @param {Options} options
+ * @returns {Promise<Object<string, Webmention[]>>}
+ */
+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;
 };
-
-const getWebmentions = async (options, url, allowedTypes = {}) => {
-	const webmentions = await filteredWebmentions(options);
+export const webmentionsByUrl = webmentionsByURL;
+export const filteredWebmentions = webmentionsByURL;
+
+/**
+ * @param {Options} options
+ * @param {string} url
+ * @param {WebmentionType[]|WebmentionType} [types=[]]
+ * @returns {Promise<Webmention[]>}
+ */
+export const getWebmentions = async (options, url, types = []) => {
+	const webmentions = await webmentionsByURL(options);
 	url = absoluteURL(url, options.domain);
 
 	if (!url || !webmentions || !webmentions[url]) {
@@ -416,9 +583,10 @@ const getWebmentions = async (options, url, allowedTypes = {}) => {
 		webmentions[url]
 			// Filter webmentions by allowed response post types
 			.filter((entry) => {
-				return typeof allowedTypes === "object" &&
-					Object.keys(allowedTypes).length
-					? allowedTypes.includes(getType(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
@@ -448,25 +616,28 @@ const getWebmentions = async (options, url, allowedTypes = {}) => {
 	);
 };
 
-const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
+/**
+ * @param {Object} eleventyConfig
+ * @param {Options} [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);
@@ -477,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);
@@ -488,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

@@ -0,0 +1,36 @@
+import js from "@eslint/js";
+
+export default [
+	js.configs.recommended,
+	{
+		files: ["src/**/*.js"],
+		languageOptions: {
+			ecmaVersion: "latest",
+		},
+		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",
+		},
+	},
+];