@chrisburnell/eleventy-cache-webmentions 2.0.0 → 2.0.2

package/README.md

@@ -2,6 +2,22 @@
 
 > Cache webmentions using eleventy-fetch and make them available to use in collections, layouts, pages, etc. in Eleventy.
 
+## Breaking change for v2.0.0
+
+Version 2.0.0 introduces a breaking change for those migrating from earlier versions of the plugin. This affects usage of the plugin from JavaScript files; specifically, you will need to make a small change to the way that you `require()` the plugin by removing an extra set of parentheses:
+
+**v1.2.5 and below**
+
+```javascript
+require("@chrisburnell/eleventy-cache-webmentions")()
+```
+
+**v2.0.0 and above**
+
+```javascript
+require("@chrisburnell/eleventy-cache-webmentions")
+```
+
 ## Quick Guide
 
 I wrote a quicker and simpler guide to getting this Eleventy plugin working that cuts out all the fluff and extra details.
@@ -281,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

@@ -42,7 +42,7 @@ const getPublished = (webmention) => {
 }
 
 const getContent = (webmention) => {
-	return webmention?.["content"]?.["html"] || webmention?.["content"] || webmention?.["data"]?.["content"] || ""
+	return webmention?.["contentSanitized"] || webmention?.["content"]?.["html"] || webmention?.["content"]?.["value"] || webmention?.["content"] || webmention?.["data"]?.["content"] || ""
 }
 
 const getSource = (webmention) => {
@@ -109,52 +109,53 @@ const fetchWebmentions = async (options) => {
 		const since = webmentions.length ? getPublished(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 false
-						})
-					}
-					if (webmentions.length) {
-						console.log(`[${hostname(options.domain)}] ${webmentions.length} new Webmentions fetched into cache.`)
+								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
+							})
+						}
+						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,12 +239,12 @@ const eleventyCacheWebmentions = (eleventyConfig, options = {}) => {
 
 	// Liquid Filters
 	eleventyConfig.addLiquidFilter("getWebmentions", getWebmentionsFilter)
+	eleventyConfig.addLiquidFilter("getWebmentionsByTypes", getByTypes)
 	eleventyConfig.addLiquidFilter("getWebmentionPublished", getPublished)
 	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)
@@ -262,8 +263,14 @@ 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.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.0",
+  "version": "2.0.2",
   "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",