@chrisburnell/eleventy-cache-webmentions 2.1.10 → 2.1.12

package/.cache/eleventy-fetch-68a403136c61abd104ade94e69ba62

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

package/README.md

@@ -31,6 +31,8 @@ Check it out: [Webmention Setup for Eleventy](https://chrisburnell.com/article/w
 -   **With npm:** `npm install @chrisburnell/eleventy-cache-webmentions`
 -   **Direct download:** [https://github.com/chrisburnell/eleventy-cache-webmentions/archive/master.zip](https://github.com/chrisburnell/eleventy-cache-webmentions/archive/master.zip)
 
+*Important Note: This plugin uses Node.js features only present in versions 18+. If you’re deploying your website somewhere, check to make sure that your Node.js version is set to 18 or greater. ([Cloudflare Pages](https://community.cloudflare.com/t/pages-node-js-version/295548/3), [GitHub Actions](https://github.com/actions/setup-node), [Netlify](https://answers.netlify.com/t/specifying-a-node-version/9701))*
+
 Inside your Eleventy config file, use `addPlugin()` to add it to your project:
 
 ```javascript

package/eleventy-cache-webmentions.js

@@ -1,7 +1,10 @@
 const sanitizeHTML = require("sanitize-html");
 const { AssetCache } = require("@11ty/eleventy-fetch");
-const chalk = require("chalk");
+const { styleText } = require("node:util");
 
+/**
+ * @type {Object}
+ */
 const defaults = {
 	refresh: false,
 	duration: "1d",
@@ -19,14 +22,21 @@ 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();
 	} catch (e) {
 		console.error(
-			`Trying to convert ${chalk.bold(
+			`Trying to convert ${styleText(
+				"bold",
 				url,
-			)} to be an absolute url with base ${chalk.bold(
+			)} to be an absolute url with base ${styleText(
+				"bold",
 				domain,
 			)} and failed.`,
 		);
@@ -34,12 +44,21 @@ const absoluteURL = (url, domain) => {
 	}
 };
 
+/**
+ * @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} urlReplacements
+ * @returns {string}
+ */
 const fixUrl = (url, urlReplacements) => {
 	return Object.entries(urlReplacements).reduce(
 		(accumulator, [key, value]) => {
@@ -50,18 +69,30 @@ 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();
 };
 
+/**
+ * @param {Object} date
+ * @returns {string|undefined}
+ */
 const getPublished = (webmention) => {
 	return (
 		webmention?.["data"]?.["published"] ||
@@ -71,6 +102,10 @@ const getPublished = (webmention) => {
 	);
 };
 
+/**
+ * @param {Object} webmention
+ * @returns {string|undefined}
+ */
 const getReceived = (webmention) => {
 	return (
 		webmention["wm-received"] ||
@@ -80,6 +115,10 @@ const getReceived = (webmention) => {
 	);
 };
 
+/**
+ * @param {Object} webmention
+ * @returns {string}
+ */
 const getContent = (webmention) => {
 	return (
 		webmention?.["contentSanitized"] ||
@@ -91,6 +130,10 @@ const getContent = (webmention) => {
 	);
 };
 
+/**
+ * @param {Object} webmention
+ * @returns {string}
+ */
 const getSource = (webmention) => {
 	return (
 		webmention["wm-source"] ||
@@ -100,6 +143,10 @@ const getSource = (webmention) => {
 	);
 };
 
+/**
+ * @param {Object} webmention
+ * @returns {string}
+ */
 const getURL = (webmention) => {
 	return (
 		webmention?.["data"]?.["url"] ||
@@ -109,10 +156,18 @@ const getURL = (webmention) => {
 	);
 };
 
+/**
+ * @param {Object} webmention
+ * @returns {string}
+ */
 const getTarget = (webmention) => {
 	return webmention["wm-target"] || webmention["target"];
 };
 
+/**
+ * @param {Object} webmention
+ * @returns {string|undefined}
+ */
 const getType = (webmention) => {
 	return (
 		webmention["wm-property"] ||
@@ -121,18 +176,32 @@ const getType = (webmention) => {
 	);
 };
 
-const getByType = (webmentions, allowedType) => {
+/**
+ * @param {Object[]} webmentions
+ * @param {string} type
+ * @returns {Object[]}
+ */
+const getByType = (webmentions, type) => {
 	return webmentions.filter((webmention) => {
-		return allowedType === getType(webmention);
+		return type === getType(webmention);
 	});
 };
 
-const getByTypes = (webmentions, allowedTypes) => {
+/**
+ * @param {Object[]} webmentions
+ * @param {string[]} types
+ * @returns {Object[]}
+ */
+const getByTypes = (webmentions, types) => {
 	return webmentions.filter((webmention) => {
-		return allowedTypes.includes(getType(webmention));
+		return types.includes(getType(webmention));
 	});
 };
 
+/**
+ * @param {Object[]} webmentions
+ * @returns {Object[]}
+ */
 const removeDuplicates = (webmentions) => {
 	return [
 		...webmentions
@@ -150,6 +219,11 @@ const removeDuplicates = (webmentions) => {
 	];
 };
 
+/**
+ * @param {Object[]} webmentions
+ * @param {string[]} blocklist
+ * @returns {Object[]}
+ */
 const processBlocklist = (webmentions, blocklist) => {
 	return webmentions.filter((webmention) => {
 		let url = getSource(webmention);
@@ -166,6 +240,11 @@ const processBlocklist = (webmentions, blocklist) => {
 	});
 };
 
+/**
+ * @param {Object[]} webmentions
+ * @param {string[]} allowlist
+ * @returns {Object[]}
+ */
 const processAllowlist = (webmentions, allowlist) => {
 	return webmentions.filter((webmention) => {
 		let url = getSource(webmention);
@@ -182,6 +261,12 @@ const processAllowlist = (webmentions, allowlist) => {
 	});
 };
 
+/**
+ * @param {Object} options
+ * @param {Object[]} webmentions
+ * @param {string} url
+ * @returns {Promise<{found:number,filtered:Object[]}>}
+ */
 const performFetch = async (options, webmentions, url) => {
 	return await fetch(url)
 		.then(async (response) => {
@@ -193,9 +278,10 @@ const performFetch = async (options, webmentions, url) => {
 
 			if (!options.key in feed) {
 				console.log(
-					`${chalk.grey(`[${hostname(options.domain)}]`)} ${
+					`${styleText("grey", `[${hostname(options.domain)}]`)} ${
 						options.key
-					} was not found as a key in the response from ${chalkf.bold(
+					} was not found as a key in the response from ${styleText(
+						"bold",
 						hostname(options.feed),
 					)}!`,
 				);
@@ -226,9 +312,11 @@ const performFetch = async (options, webmentions, url) => {
 		})
 		.catch((error) => {
 			console.warn(
-				`${chalk.grey(
+				`${styleText(
+					"grey",
 					`[${hostname(options.domain)}]`,
-				)} Something went wrong with your Webmention request to ${chalk.bold(
+				)} Something went wrong with your Webmention request to ${styleText(
+					"bold",
 					hostname(options.feed),
 				)}!`,
 			);
@@ -241,6 +329,10 @@ const performFetch = async (options, webmentions, url) => {
 		});
 };
 
+/**
+ * @param {Object} options
+ * @returns {Promise<Object[]>}
+ */
 const fetchWebmentions = async (options) => {
 	if (!options.domain) {
 		throw new Error(
@@ -353,9 +445,14 @@ const fetchWebmentions = async (options) => {
 		// Add a console message with the number of fetched and processed Webmentions, if any
 		if (webmentionsCachedLength < webmentions.length) {
 			console.log(
-				`${chalk.grey(`[${hostname(options.domain)}]`)} ${chalk.bold(
-					webmentions.length - webmentionsCachedLength,
-				)} new Webmentions fetched into cache in ${chalk.bold(
+				`${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",
 				)}.`,
@@ -367,6 +464,11 @@ const fetchWebmentions = async (options) => {
 };
 
 let filtered = {};
+
+/**
+ * @param {Object} options
+ * @returns {Promise<Object<string, Object[]>>}
+ */
 const filteredWebmentions = async (options) => {
 	if (Object.entries(filtered).length) {
 		return filtered;
@@ -394,7 +496,13 @@ const filteredWebmentions = async (options) => {
 	return filtered;
 };
 
-const getWebmentions = async (options, url, allowedTypes = {}) => {
+/**
+ * @param {Object} options
+ * @param {string} url
+ * @param {string[]|Object} [types={}]
+ * @returns {Promise<Object[]>}
+ */
+const getWebmentions = async (options, url, types = {}) => {
 	const webmentions = await filteredWebmentions(options);
 	url = absoluteURL(url, options.domain);
 
@@ -406,9 +514,8 @@ 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))
 					: true;
 			})
 			// Sanitize content of webmentions against HTML limit
@@ -438,6 +545,10 @@ const getWebmentions = async (options, url, allowedTypes = {}) => {
 	);
 };
 
+/**
+ * @param {Object} eleventyConfig
+ * @param {Object} [options={}]
+ */
 const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
 	options = Object.assign(defaults, options);
 

package/eslint.config.js

@@ -0,0 +1,16 @@
+module.exports = [
+	{
+		files: ["**/*.js"],
+		languageOptions: {
+			ecmaVersion: 12,
+			sourceType: "module",
+		},
+		languageOptions: {
+			globals: {
+				browser: true,
+				commonjs: true,
+				es2021: true,
+			},
+		},
+	},
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chrisburnell/eleventy-cache-webmentions",
-  "version": "2.1.10",
+  "version": "2.1.12",
   "description": "Cache webmentions using eleventy-fetch and make them available to use in collections, layouts, pages, etc. in Eleventy.",
   "license": "MIT",
   "repository": {
@@ -55,11 +55,10 @@
   },
   "dependencies": {
     "@11ty/eleventy-fetch": "^5.1.0",
-    "chalk": "4.1.2",
     "sanitize-html": "^2.17.0"
   },
   "devDependencies": {
-    "eslint": "^9.28.0",
-    "nock": "^14.0.5"
+    "eslint": "^9.38.0",
+    "nock": "^14.0.10"
   }
 }