@chrisburnell/eleventy-cache-webmentions 2.0.1 → 2.0.3

package/README.md

@@ -297,11 +297,11 @@ If you would rather get Webmentions for a given page directly from a Layout/Incl
 Instead of getting all the Webmentions for a given page, you may want to grab only certain types of Webmentions. This is useful if you want to display different types of Webmentions separately, e.g.:
 
 ```twig
-{% set bookmarks = webmentions | getTypes(['bookmark-of']) %}
-{% set likes = webmentions | getTypes(['like-of']) %}
-{% set reposts = webmentions | getTypes(['repost-of']) %}
+{% set bookmarks = webmentions | getWebmentionsByTypes(['bookmark-of']) %}
+{% set likes = webmentions | getWebmentionsByTypes(['like-of']) %}
+{% set reposts = webmentions | getWebmentionsByTypes(['repost-of']) %}
 
-{% set replies = webmentions | getTypes(['mention-of', 'in-reply-to']) %}
+{% set replies = webmentions | getWebmentionsByTypes(['mention-of', 'in-reply-to']) %}
 ```
 
 ## Get all Webmentions at once

package/eleventy-cache-webmentions.js

@@ -41,6 +41,10 @@ const getPublished = (webmention) => {
 	return webmention?.["data"]?.["published"] || webmention["published"] || webmention["wm-received"] || webmention["verified_date"]
 }
 
+const getReceived = (webmention) => {
+	return webmention["wm-received"] || webmention["verified_date"] || webmention?.["data"]?.["published"] || webmention["published"]
+}
+
 const getContent = (webmention) => {
 	return webmention?.["contentSanitized"] || webmention?.["content"]?.["html"] || webmention?.["content"]?.["value"] || webmention?.["content"] || webmention?.["data"]?.["content"] || ""
 }
@@ -81,15 +85,15 @@ const defaults = {
 
 const fetchWebmentions = 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.")
+		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.")
+		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.")
+		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, options.directory)
@@ -102,59 +106,70 @@ const fetchWebmentions = async (options) => {
 		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.duration)) {
-		// Get the published date of the most recent Webmention, if it exists
-		const since = webmentions.length ? getPublished(webmentions[0]) : false
+		// 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}` : ""}`
-		await fetch(url).then(async (response) => {
-			if (response.ok) {
-				const feed = await response.json()
-				if (feed[options.key].length) {
-					// Combine newly-fetched Webmentions with cached Webmentions
-					webmentions = feed[options.key].concat(webmentions)
-					// Remove duplicates by source URL
-					webmentions = uniqBy([...feed[options.key], ...webmentions], (webmention) => {
-						return getSource(webmention)
-					})
-					// Process the blocklist, if it has any entries
-					if (options.blocklist.length) {
-						webmentions = webmentions.filter((webmention) => {
-							let sourceUrl = getSource(webmention)
-							for (let url of options.blocklist) {
-								if (sourceUrl.includes(url.replace(/\/?$/, "/"))) {
-									return false
-								}
-							}
-							return true
+		await fetch(url)
+			.then(async (response) => {
+				if (response.ok) {
+					const feed = await response.json()
+
+					if (feed[options.key].length) {
+						// Combine newly-fetched Webmentions with cached Webmentions
+						webmentions = feed[options.key].concat(webmentions)
+						// Remove duplicates by source URL
+						webmentions = uniqBy([...feed[options.key], ...webmentions], (webmention) => {
+							return getSource(webmention)
 						})
-					}
-					// Process the allowlist, if it has any entries
-					if (options.allowlist.length) {
-						webmentions = webmentions.filter((webmention) => {
-							let sourceUrl = getSource(webmention)
-							for (let url of options.allowlist) {
-								if (sourceUrl.includes(url.replace(/\/?$/, "/"))) {
-									return true
+						// Process the blocklist, if it has any entries
+						if (options.blocklist.length) {
+							webmentions = webmentions.filter((webmention) => {
+								let sourceUrl = getSource(webmention)
+								for (let url of options.blocklist) {
+									if (sourceUrl.includes(url.replace(/\/?$/, "/"))) {
+										return false
+									}
+								}
+								return true
+							})
+						}
+						// Process the allowlist, if it has any entries
+						if (options.allowlist.length) {
+							webmentions = webmentions.filter((webmention) => {
+								let sourceUrl = getSource(webmention)
+								for (let url of options.allowlist) {
+									if (sourceUrl.includes(url.replace(/\/?$/, "/"))) {
+										return true
+									}
 								}
-							}
-							return false
+								return false
+							})
+						}
+						// 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))
 						})
+						// Add a console message with the number of fetched and processed Webmentions, if any
+						if (webmentionsCachedLength < webmentions.length) {
+							console.log(`[${hostname(options.domain)}] ${webmentions.length - webmentionsCachedLength} new Webmentions fetched into cache.`)
+						}
 					}
-					if (webmentions.length) {
-						console.log(`[${hostname(options.domain)}] ${webmentions.length} new Webmentions fetched into cache.`)
-					}
+					await asset.save(webmentions, "json")
+					return webmentions
 				}
-				await asset.save(webmentions, "json")
-				return webmentions
-			}
-			return Promise.reject(response)
-		})
-		.catch((error) => {
-			console.log(`[${hostname(options.domain)}] Something went wrong with your request to ${hostname(options.feed)}!`, error)
-		})
+				return Promise.reject(response)
+			})
+			.catch((error) => {
+				console.log(`[${hostname(options.domain)}] Something went wrong with your request to ${hostname(options.feed)}!`, error)
+			})
 	}
 
 	return webmentions
@@ -238,17 +253,19 @@ const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
 
 	// Liquid Filters
 	eleventyConfig.addLiquidFilter("getWebmentions", getWebmentionsFilter)
+	eleventyConfig.addLiquidFilter("getWebmentionsByTypes", getByTypes)
 	eleventyConfig.addLiquidFilter("getWebmentionPublished", getPublished)
+	eleventyConfig.addLiquidFilter("getWebmentionReceived", getReceived)
 	eleventyConfig.addLiquidFilter("getWebmentionContent", getContent)
 	eleventyConfig.addLiquidFilter("getWebmentionSource", getSource)
 	eleventyConfig.addLiquidFilter("getWebmentionTarget", getTarget)
 	eleventyConfig.addLiquidFilter("getWebmentionType", getType)
-	eleventyConfig.addLiquidFilter("getWebmentionsByTypes", getByTypes)
 
 	// Nunjucks Filters
 	eleventyConfig.addNunjucksAsyncFilter("getWebmentions", getWebmentionsFilter)
 	eleventyConfig.addNunjucksFilter("getWebmentionsByTypes", getByTypes)
 	eleventyConfig.addNunjucksFilter("getWebmentionPublished", getPublished)
+	eleventyConfig.addNunjucksFilter("getWebmentionReceived", getReceived)
 	eleventyConfig.addNunjucksFilter("getWebmentionContent", getContent)
 	eleventyConfig.addNunjucksFilter("getWebmentionSource", getSource)
 	eleventyConfig.addNunjucksFilter("getWebmentionTarget", getTarget)
@@ -262,8 +279,16 @@ module.exports.webmentionsByUrl = filteredWebmentions
 module.exports.fetchWebmentions = fetchWebmentions
 module.exports.getWebmentions = getWebmentions
 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.getTarget = getTarget
+module.exports.getWebmentionTarget = getTarget
 module.exports.getType = getType
+module.exports.getWebmentionType = getType

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chrisburnell/eleventy-cache-webmentions",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "Cache webmentions using eleventy-fetch and make them available to use in collections, layouts, pages, etc. in Eleventy.",
   "author": "Chris Burnell <me@chrisburnell.com>",
   "license": "MIT",
@@ -20,13 +20,13 @@
     "webmention"
   ],
   "devDependencies": {
-    "eslint": "^8.56.0"
+    "eslint": "^9.2.0"
   },
   "dependencies": {
-    "@11ty/eleventy-fetch": "^4.0.0",
+    "@11ty/eleventy-fetch": "^4.0.1",
     "lodash": "^4.17.21",
-    "node-fetch": "^2.6.7",
-    "sanitize-html": "^2.11.0"
+    "node-fetch": "^3.3.2",
+    "sanitize-html": "^2.13.0"
   },
   "main": "eleventy-cache-webmentions.js",
   "scripts": {