@chrisburnell/eleventy-cache-webmentions 2.2.3 → 2.2.7

package/.cache/eleventy-fetch-68a403136c61abd104ade94e69ba62

@@ -1 +1 @@
-{"cachedAt":1761690234790,"type":"json","metadata":{}}
+{"cachedAt":1764872868125,"type":"json","metadata":{}}

package/eleventy-cache-webmentions.cjs

@@ -13,12 +13,29 @@ const sanitizeHTML = require("sanitize-html");
  * @property {string} uniqueKey
  * @property {string} [cacheDirectory]
  * @property {AllowedHTML} allowedHTML
- * @property {string[]} allowlist
- * @property {string[]} blocklist
- * @property {{ string: string }} urlReplacements
+ * @property {Array<string>} allowlist
+ * @property {Array<string>} blocklist
+ * @property {{[key: string]: string}} urlReplacements
  * @property {number} maximumHtmlLength
  * @property {string} maximumHtmlText
  */
+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",
+};
 
 /**
  * @typedef {object} OptionsUserInput
@@ -61,27 +78,6 @@ const sanitizeHTML = require("sanitize-html");
  * @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
@@ -117,7 +113,7 @@ const baseURL = (url) => {
 
 /**
  * @param {string} url
- * @param {{ string: string }} [urlReplacements]
+ * @param {{[key: string], string}} [urlReplacements]
  * @returns {string}
  */
 const fixURL = (url, urlReplacements) => {
@@ -151,8 +147,8 @@ const epoch = (date) => {
 };
 
 /**
- * @param {Webmention[]} webmentions
- * @returns {Webmention[]}
+ * @param {Array<Webmention>} webmentions
+ * @returns {Array<Webmention>}
  */
 const removeDuplicates = (webmentions) => {
 	return [
@@ -259,9 +255,9 @@ const getType = (webmention) => {
 };
 
 /**
- * @param {Webmention[]} webmentions
- * @param {WebmentionType|WebmentionType[]} types
- * @returns {Webmention[]}
+ * @param {Array<Webmention>} webmentions
+ * @param {WebmentionType|Array<WebmentionType>} types
+ * @returns {Array<Webmention>}
  */
 const getByTypes = (webmentions, types) => {
 	return webmentions.filter((webmention) => {
@@ -273,9 +269,9 @@ const getByTypes = (webmentions, types) => {
 };
 
 /**
- * @param {Webmention[]} webmentions
- * @param {string[]} blocklist
- * @returns {Webmention[]}
+ * @param {Array<Webmention>} webmentions
+ * @param {Array<string>} blocklist
+ * @returns {Array<Webmention>}
  */
 const processBlocklist = (webmentions, blocklist) => {
 	return webmentions.filter((webmention) => {
@@ -294,9 +290,9 @@ const processBlocklist = (webmentions, blocklist) => {
 };
 
 /**
- * @param {Webmention[]} webmentions
- * @param {string[]} allowlist
- * @returns {Webmention[]}
+ * @param {Array<Webmention>} webmentions
+ * @param {Array<string>} allowlist
+ * @returns {Array<Webmention>}
  */
 const processAllowlist = (webmentions, allowlist) => {
 	return webmentions.filter((webmention) => {
@@ -316,9 +312,9 @@ const processAllowlist = (webmentions, allowlist) => {
 
 /**
  * @param {Options} options
- * @param {Webmention[]} webmentions
+ * @param {Array<Webmention>} webmentions
  * @param {string} url
- * @returns {Promise<{found: number, webmentions: Webmention[]}>}
+ * @returns {Promise<{found: number, webmentions: Array<Webmention>}>}
  */
 const fetchWebmentions = async (options, webmentions, url) => {
 	return await fetch(url)
@@ -384,7 +380,7 @@ const fetchWebmentions = async (options, webmentions, url) => {
 
 /**
  * @param {Options} options
- * @returns {Promise<Webmention[]>}
+ * @returns {Promise<Array<Webmention>>}
  */
 const retrieveWebmentions = async (options) => {
 	if (!options.domain) {
@@ -516,12 +512,12 @@ const retrieveWebmentions = async (options) => {
 	return webmentions;
 };
 
-/** @type {Webmention[]} */
+/** @type {Array<Webmention>} */
 const WEBMENTIONS = {};
 
 /**
  * @param {Options} options
- * @returns {Promise<{ string: Webmention[] }>}
+ * @returns {Promise<{[key: string]: Array<Webmention>}>}
  */
 const webmentionsByURL = async (options) => {
 	if (Object.keys(WEBMENTIONS).length) {
@@ -553,8 +549,8 @@ const webmentionsByURL = async (options) => {
 /**
  * @param {Options} options
  * @param {string} url
- * @param {WebmentionType[]|WebmentionType} [types=[]]
- * @returns {Promise<Webmention[]>}
+ * @param {WebmentionType|Array<WebmentionType>} [types]
+ * @returns {Promise<Array<Webmention>>}
  */
 const getWebmentions = async (options, url, types = []) => {
 	const webmentions = await webmentionsByURL(options);
@@ -603,7 +599,7 @@ const getWebmentions = async (options, url, types = []) => {
 
 /**
  * @param {object} eleventyConfig
- * @param {Options} [options={}]
+ * @param {Options} [options]
  */
 const eleventyCacheWebmentions = async (eleventyConfig, options = {}) => {
 	options = Object.assign(defaults, options);

package/eleventy-cache-webmentions.js

@@ -13,12 +13,29 @@ import sanitizeHTML from "sanitize-html";
  * @property {string} uniqueKey
  * @property {string} [cacheDirectory]
  * @property {AllowedHTML} allowedHTML
- * @property {string[]} allowlist
- * @property {string[]} blocklist
- * @property {{ string: string }} urlReplacements
+ * @property {Array<string>} allowlist
+ * @property {Array<string>} blocklist
+ * @property {{[key: string]: string}} urlReplacements
  * @property {number} maximumHtmlLength
  * @property {string} maximumHtmlText
  */
+export 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",
+};
 
 /**
  * @typedef {object} OptionsUserInput
@@ -61,27 +78,6 @@ import sanitizeHTML from "sanitize-html";
  * @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: ["a", "b", "em", "i", "strong"],
-		allowedAttributes: {
-			a: ["href"],
-		},
-	},
-	allowlist: [],
-	blocklist: [],
-	urlReplacements: {},
-	maximumHtmlLength: 1000,
-	maximumHtmlText: "mentioned this in",
-};
-
 /**
  * @param {string} url
  * @param {string} domain
@@ -117,7 +113,7 @@ const baseURL = (url) => {
 
 /**
  * @param {string} url
- * @param {{ string: string }} [urlReplacements]
+ * @param {{[key: string]: string}} [urlReplacements]
  * @returns {string}
  */
 const fixURL = (url, urlReplacements) => {
@@ -151,8 +147,8 @@ const epoch = (date) => {
 };
 
 /**
- * @param {Webmention[]} webmentions
- * @returns {Webmention[]}
+ * @param {Array<Webmention>} webmentions
+ * @returns {Array<Webmention>}
  */
 const removeDuplicates = (webmentions) => {
 	return [
@@ -266,9 +262,9 @@ export const getType = (webmention) => {
 export const getWebmentionType = getType;
 
 /**
- * @param {Webmention[]} webmentions
- * @param {WebmentionType|WebmentionType[]} types
- * @returns {Webmention[]}
+ * @param {Array<Webmention>} webmentions
+ * @param {WebmentionType|Array<WebmentionType>} types
+ * @returns {Array<Webmention>}
  */
 export const getByTypes = (webmentions, types) => {
 	return webmentions.filter((webmention) => {
@@ -283,9 +279,9 @@ export const getWebmentionsByTypes = getByTypes;
 export const getWebmentionsByType = getByTypes;
 
 /**
- * @param {Webmention[]} webmentions
- * @param {string[]} blocklist
- * @returns {Webmention[]}
+ * @param {Array<Webmention>} webmentions
+ * @param {Array<string>} blocklist
+ * @returns {Array<Webmention>}
  */
 export const processBlocklist = (webmentions, blocklist) => {
 	return webmentions.filter((webmention) => {
@@ -306,9 +302,9 @@ export const processWebmentionBlocklist = processBlocklist;
 export const processWebmentionsBlocklist = processBlocklist;
 
 /**
- * @param {Webmention[]} webmentions
- * @param {string[]} allowlist
- * @returns {Webmention[]}
+ * @param {Array<Webmention>} webmentions
+ * @param {Array<string>} allowlist
+ * @returns {Array<Webmention>}
  */
 export const processAllowlist = (webmentions, allowlist) => {
 	return webmentions.filter((webmention) => {
@@ -330,9 +326,9 @@ export const processWebmentionsAllowlist = processAllowlist;
 
 /**
  * @param {Options} options
- * @param {Webmention[]} webmentions
+ * @param {Array<Webmention>} webmentions
  * @param {string} url
- * @returns {Promise<{found: number, webmentions: Webmention[]}>}
+ * @returns {Promise<{found: number, webmentions: Array<Webmention>}>}
  */
 export const fetchWebmentions = async (options, webmentions, url) => {
 	return await fetch(url)
@@ -398,7 +394,7 @@ export const fetchWebmentions = async (options, webmentions, url) => {
 
 /**
  * @param {Options} options
- * @returns {Promise<Webmention[]>}
+ * @returns {Promise<Array<Webmention>>}
  */
 export const retrieveWebmentions = async (options) => {
 	if (!options.domain) {
@@ -530,12 +526,12 @@ export const retrieveWebmentions = async (options) => {
 	return webmentions;
 };
 
-/** @type {Webmention[]} */
+/** @type {Array<Webmention>} */
 const WEBMENTIONS = {};
 
 /**
  * @param {Options} options
- * @returns {Promise<{ string: Webmention[] }>}
+ * @returns {Promise<{[key: string]: Array<Webmention>}>}
  */
 export const webmentionsByURL = async (options) => {
 	if (Object.keys(WEBMENTIONS).length) {
@@ -569,8 +565,8 @@ export const filteredWebmentions = webmentionsByURL;
 /**
  * @param {Options} options
  * @param {string} url
- * @param {WebmentionType[]|WebmentionType} [types=[]]
- * @returns {Promise<Webmention[]>}
+ * @param {WebmentionType|Array<WebmentionType>} [types]
+ * @returns {Promise<Array<Webmention>>}
  */
 export const getWebmentions = async (options, url, types = []) => {
 	const webmentions = await webmentionsByURL(options);
@@ -619,7 +615,7 @@ export const getWebmentions = async (options, url, types = []) => {
 
 /**
  * @param {object} eleventyConfig
- * @param {Options} [options={}]
+ * @param {Options} [options]
  */
 export const eleventyCacheWebmentions = async (
 	eleventyConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chrisburnell/eleventy-cache-webmentions",
-  "version": "2.2.3",
+  "version": "2.2.7",
   "description": "Cache webmentions using eleventy-fetch and make them available to use in collections, layouts, pages, etc. in Eleventy.",
   "license": "MIT",
   "repository": {
@@ -61,14 +61,14 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@11ty/eleventy-fetch": "^5.1.0",
+    "@11ty/eleventy-fetch": "^5.1.1",
     "sanitize-html": "^2.17.0"
   },
   "devDependencies": {
-    "esbuild": "^0.25.11",
-    "eslint": "^9.38.0",
-    "eslint-plugin-jsdoc": "^61.1.10",
-    "globals": "^16.4.0",
+    "esbuild": "^0.27.1",
+    "eslint": "^9.39.1",
+    "eslint-plugin-jsdoc": "^61.4.1",
+    "globals": "^16.5.0",
     "nock": "^14.0.10"
   },
   "type": "module"