feat: implement JSON-LD retrieval of image

Author: plaa

packages/metascraper-helpers/index.js

@@ -6,6 +6,7 @@ const {
   replace,
   includes,
   isString,
+  isArray,
   trim,
   flow,
   chain,
@@ -210,6 +211,8 @@ module.exports = {
   normalizeUrl,
   isMime,
   isUrl,
+  isString,
+  isArray,
   isVideoUrl,
   isAudioUrl,
   isImageUrl,

packages/metascraper-image/index.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { $filter, url: urlFn } = require('@metascraper/helpers')
+const { $filter, url: urlFn, isString, isArray } = require('@metascraper/helpers')
 
 /**
  * Wrap a rule with validation and formatting logic.
@@ -14,13 +14,25 @@ const wrap = rule => ({ htmlDom, url }) => {
   return urlFn(value, { url })
 }
 
+const findImageFromLd = ({ jsonLd, url }) => {
+  const value = jsonLd.image
+  if (isString(value)) {
+    return urlFn(value, { url })
+  }
+  if (isArray(value) && value.length > 0 && value[0].url) {
+    return urlFn(value[0].url, { url })
+  }
+  return null
+}
+
 const getSrc = el => el.attr('src')
 
 /**
  * Rules.
  */
 module.exports = () => ({
   image: [
+    findImageFromLd,
     wrap($ => $('meta[property="og:image:secure_url"]').attr('content')),
     wrap($ => $('meta[property="og:image:url"]').attr('content')),
     wrap($ => $('meta[property="og:image"]').attr('content')),

packages/metascraper/__snapshots__/index.js.snap-shot

@@ -972,7 +972,7 @@ exports['engadget 1'] = {
   "author": null,
   "date": "2019-01-07T15:37:00.000Z",
   "description": "Previously, only paid subscribers had access to private repositories.",
-  "image": "https://o.aolcdn.com/images/dims?thumbnail=1200%2C630&quality=80&image_uri=https%3A%2F%2Fo.aolcdn.com%2Fimages%2Fdims%3Fcrop%3D4834%252C3230%252C0%252C0%26quality%3D85%26format%3Djpg%26resize%3D1600%252C1069%26image_uri%3Dhttps%253A%252F%252Fs.yimg.com%252Fos%252Fcreatr-images%252F2019-01%252F2d1e22f0-12ae-11e9-bae7-60d640081814%26client%3Da1acac3e1b3290917d92%26signature%3D269ae0af3a1a1772ffea6759d126791b9ad25184&client=amp-blogside-v2&signature=ea8c3bcfcab1cb450830a18333e5a76988365326",
+  "image": "https://o.aolcdn.com/images/dims?thumbnail=640%2C480&quality=80&image_uri=https%3A%2F%2Fo.aolcdn.com%2Fimages%2Fdims%3Fcrop%3D4834%252C3230%252C0%252C0%26quality%3D85%26format%3Djpg%26resize%3D1600%252C1069%26image_uri%3Dhttps%253A%252F%252Fs.yimg.com%252Fos%252Fcreatr-images%252F2019-01%252F2d1e22f0-12ae-11e9-bae7-60d640081814%26client%3Da1acac3e1b3290917d92%26signature%3D269ae0af3a1a1772ffea6759d126791b9ad25184&client=amp-blogside-v2&signature=4539df4b9d0dc62559e62894701669f8e9e58612",
   "video": null,
   "lang": "en",
   "logo": "https://s.blogsmithmedia.com/www.engadget.com/assets-h79a2a298ee2333258b2b96d407e66b8d/images/favicon-160x160.png?h=1638b0a8bbe7effa8f85c3ecabb63620",