jsonld.js

'use strict'

const cheerio = require('cheerio')
const test = require('ava').default

const { $jsonld, jsonld } = require('..')

test('empty object if JSON-LD is not preset into the html', t => {
  const $ = cheerio.load('')
  const data = jsonld($)
  t.deepEqual(data, [])
})

test('normalize @graph', t => {
  const content = {
    '@context': 'https://schema.org',
    '@graph': [
      {
        '@type': 'Article'
      },
      {
        '@type': 'WebPage'
      }
    ]
  }

  const html = `
      <script type="application/ld+json"> { "@context": "http://schema.org", "@type": "Organization", "url": "https://bykvu.com/ru", "logo": "https://bykvu.com/wp-content/themes/bykvu/img/logo.svg" } </script>
      <script type="application/ld+json">${JSON.stringify(content)}</script>
      `

  const $ = cheerio.load(html)
  const data = jsonld($)
  t.snapshot(data)
})

test('parse JSON-LD from markup if it is present', t => {
  const $ = cheerio.load(
    '<script type="application/ld+json">{"@context":"http://schema.org","@type":"NewsArticle","mainEntityOfPage":"https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving","headline":"This is the Tesla Semi truck","description":"500 miles of range and more aerodynamic than a supercar","speakable":{"@type":"SpeakableSpecification","xpath":["/html/head/title","/html/head/meta[@name=\'description\']/@content"]},"datePublished":"2017-11-16T23:47:07-05:00","dateModified":"2017-11-16T23:47:07-05:00","author":{"@type":"Person","name":"Zac Estrada"},"publisher":{"@type":"Organization","name":"The Verge","logo":{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/uploads/chorus_asset/file/13668586/google_amp.0.png","width":600,"height":60}},"about":{"@type":"Event","name":"Tesla Semi Truck Event 2017","startDate":"2017-11-17T04:00:00+00:00","location":{"@type":"Place","name":"Tesla Motors factory","address":"Hawthorne, California, USA"}},"image":[{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/k8ssXKPAuRwxa1pKew982ZMgv0o=/1400x1400/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":1400},{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/l6nkV8CkJIdUrJIzHFWUFc1zLRM=/1400x1050/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":1050},{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/5Sqo6J73lBi1hwzEiKCQy6FLx3I=/1400x788/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":788}]}</script>'
  )
  const data = jsonld($)
  t.snapshot(data)
})

test('ensure to return first value', t => {
  const $ = cheerio.load(
    '<script type="application/ld+json">[{"@context":"http://schema.org","@type":"NewsArticle","mainEntityOfPage":"https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving","headline":"This is the Tesla Semi truck","description":"500 miles of range and more aerodynamic than a supercar","speakable":{"@type":"SpeakableSpecification","xpath":["/html/head/title","/html/head/meta[@name=\'description\']/@content"]},"datePublished":"2017-11-16T23:47:07-05:00","dateModified":"2017-11-16T23:47:07-05:00","author":{"@type":"Person","name":"Zac Estrada"},"publisher":{"@type":"Organization","name":"The Verge","logo":{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/uploads/chorus_asset/file/13668586/google_amp.0.png","width":600,"height":60}},"about":{"@type":"Event","name":"Tesla Semi Truck Event 2017","startDate":"2017-11-17T04:00:00+00:00","location":{"@type":"Place","name":"Tesla Motors factory","address":"Hawthorne, California, USA"}},"image":[{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/k8ssXKPAuRwxa1pKew982ZMgv0o=/1400x1400/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":1400},{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/l6nkV8CkJIdUrJIzHFWUFc1zLRM=/1400x1050/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":1050},{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/5Sqo6J73lBi1hwzEiKCQy6FLx3I=/1400x788/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":788}]}]</script>'
  )
  const data = jsonld($)
  t.true(Object.keys(data).length > 0)
})

test('reads multiple JSON-LD blocks', t => {
  const $ =
    cheerio.load(`<script type="application/ld+json"> { "@context": "http://schema.org", "@type": "Organization", "url": "https://bykvu.com/ru", "logo": "https://bykvu.com/wp-content/themes/bykvu/img/logo.svg" } </script>
        <script type="application/ld+json"> { "@context": "http://schema.org", "@type": "NewsArticle", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://bykvu.com/ru/bukvy/uchenye-nazvali-depressiju-prichinoj-22-opasnyh-zabolevanij/" }, "headline": "Ученые назвали депрессию причиной 22 опасных заболеваний", "image": [ "https://bykvu.com/wp-content/themes/bykvu/includes/images/noimage_large.jpg" ], "datePublished": "2019-09-09T00:29:09+02:00", "dateModified": "2019-09-09T00:29:09+02:00", "author": { "@type": "Person", "name": "Буквы" }, "publisher": { "@type": "Organization", "name": "Буквы", "logo": { "@type": "ImageObject", "url": "https://bykvu.com/wp-content/themes/bykvu/img/apple-icon-180x180.png" } }, "description": "Ученые австралийского центра точного здравоохранения при Университете Южной Австралии выяснили, что депрессия является причиной 22 различных заболеваний." } </script>
        <script type="application/ld+json"> { "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [ { "@type": "ListItem", "position": 1, "item": { "@id": "https://bykvu.com/ru", "name": "Буквы" } }, { "@type": "ListItem", "position": 2, "item": { "@id": "https://bykvu.com/ru/category/bukvy/", "name": "Новости" } }, { "@type": "ListItem", "position": 3, "item": { "@id": "https://bykvu.com/ru/bukvy/uchenye-nazvali-depressiju-prichinoj-22-opasnyh-zabolevanij/", "name": "Ученые назвали депрессию причиной 22 опасных заболеваний" } } ] } </script>`)

  const data = jsonld($)
  t.is(Object.keys(data).length, 3)
})

test('only caches the last invocation', t => {
  const html =
    '<script type="application/ld+json">[{"@context":"http://schema.org","@type":"NewsArticle","mainEntityOfPage":"https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving","headline":"This is the Tesla Semi truck","description":"500 miles of range and more aerodynamic than a supercar","speakable":{"@type":"SpeakableSpecification","xpath":["/html/head/title","/html/head/meta[@name=\'description\']/@content"]},"datePublished":"2017-11-16T23:47:07-05:00","dateModified":"2017-11-16T23:47:07-05:00","author":{"@type":"Person","name":"Zac Estrada"},"publisher":{"@type":"Organization","name":"The Verge","logo":{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/uploads/chorus_asset/file/13668586/google_amp.0.png","width":600,"height":60}},"about":{"@type":"Event","name":"Tesla Semi Truck Event 2017","startDate":"2017-11-17T04:00:00+00:00","location":{"@type":"Place","name":"Tesla Motors factory","address":"Hawthorne, California, USA"}},"image":[{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/k8ssXKPAuRwxa1pKew982ZMgv0o=/1400x1400/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":1400},{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/l6nkV8CkJIdUrJIzHFWUFc1zLRM=/1400x1050/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":1050},{"@type":"ImageObject","url":"https://cdn.vox-cdn.com/thumbor/5Sqo6J73lBi1hwzEiKCQy6FLx3I=/1400x788/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg","width":1400,"height":788}]}]</script>'

  const $ = cheerio.load(html)
  const $mutate = cheerio.load($.html())
  const json = jsonld($)

  // Remove the script from the document. This never happens in the
  // codebase, but it's done to show that the last invocation is cached
  // because the value of $ does not change when we do this.
  $mutate('script[type="application/ld+json"]').remove()

  // Load the HTML again and use it to process with jsonld. We will expect
  // that the mutate created does not equal to original, even though it has the
  // same arguments.
  t.notDeepEqual(json, jsonld($mutate))

  // Load it and process it with the same instance of cheerio. Because this
  // is the same arguments used in json1, json2 should be equal to one
  // another.
  t.deepEqual(json, jsonld(cheerio.load($.html())))
})

test('parse json with break lines', t => {
  const $ =
    cheerio.load(`<script type="application/ld+json">{"@context":"https://schema.org","mainEntity":{"description":"This is an example
🌐 of a multiline description
📬 to see how it is parsed
📧 and how it is decoded"}}</script>`)
  t.snapshot(jsonld($))
})

test('returns empty array if JSON-LD is invalid', t => {
  const $ = cheerio.load('<script type="application/ld+json">{{</script>')
  t.deepEqual(jsonld($), [])
})

test('ignore @graph if it is not an array', t => {
  const $ = cheerio.load(
    '<script type="application/ld+json">{"@context":"http://schema.org","@graph":{"1":{"@id":"https://www.mobeforlife.com/#identity","@type":"MedicalOrganization","sameAs":["https://www.facebook.com/mobeforlife/","https://www.linkedin.com/company/mob%C4%93-llc","https://www.instagram.com/mobeforlife/"]},"2":{"@id":"#creator","@type":"Organization"},"3":{"@type":"BreadcrumbList","description":"Breadcrumbs list","itemListElement":[{"@type":"ListItem","item":"https://www.mobeforlife.com/","name":"Home","position":1},{"@type":"ListItem","item":"https://www.mobeforlife.com/blog/smart-goals-put-your-goals-within-reach","name":"SMART Goals: Put your goals within reach.","position":2}],"name":"Breadcrumbs"}}}</script>'
  )

  t.deepEqual(jsonld($), [{ '@context': 'http://schema.org' }])
})

test('respect root nodes under no @graph', t => {
  const $ = cheerio.load(
    '<script type="application/ld+json">[{"@type":"NewsArticle"},{"@type":"BreadcrumbList"}]</script>'
  )
  t.deepEqual(jsonld($), [
    { '@type': 'NewsArticle' },
    { '@type': 'BreadcrumbList' }
  ])
})

test('group all properties of the same node together', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Organization",
  "name": "Acme Inc"
}
</script>

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@graph": [
    {
      "@type": "BreadcrumbList",
      "name": "Breadcrumbs"
    },
    {
      "@type": "Article",
      "headline": "Hello World"
    }
  ]
}
</script>`)

  t.deepEqual(jsonld($), [
    {
      '@context': 'https://schema.org',
      '@type': 'Organization',
      name: 'Acme Inc'
    },
    {
      '@context': 'https://schema.org',
      '@type': 'BreadcrumbList',
      name: 'Breadcrumbs'
    },
    {
      '@context': 'https://schema.org',
      '@type': 'Article',
      headline: 'Hello World'
    }
  ])
})

test('$jsonld finds nested contentUrl under mainEntity', t => {
  const expected = 'https://audio-ssl.itunes.apple.com/example/preview.m4a'
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "WebPage",
      "mainEntity": {
        "@type": "MusicRecording",
        "name": "Example Track",
        "contentUrl": "${expected}"
      }
    }
    </script>`)
  t.is($jsonld('contentUrl')($), expected)
})

test('$jsonld finds nested property inside @graph item', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@graph": [
        {
          "@type": "WebPage",
          "name": "Home"
        },
        {
          "@type": "MusicAlbum",
          "track": {
            "@type": "MusicRecording",
            "contentUrl": "https://example.com/track.m4a"
          }
        }
      ]
    }
    </script>`)
  t.is($jsonld('contentUrl')($), 'https://example.com/track.m4a')
})

test('$jsonld traverses arrays to find property', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "MusicAlbum",
      "track": [
        { "@type": "MusicRecording", "name": "Track 1" },
        { "@type": "MusicRecording", "name": "Track 2", "contentUrl": "https://example.com/t2.m4a" }
      ]
    }
    </script>`)
  t.is($jsonld('contentUrl')($), 'https://example.com/t2.m4a')
})

test('$jsonld resolves object with .name to its name string', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "Article",
      "nested": {
        "author": { "@type": "Person", "name": "Jane Doe" }
      }
    }
    </script>`)
  t.is($jsonld('author')($), 'Jane Doe')
})

test('$jsonld returns first match when multiple nested values exist', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "MusicAlbum",
      "track": [
        { "@type": "MusicRecording", "contentUrl": "https://example.com/first.m4a" },
        { "@type": "MusicRecording", "contentUrl": "https://example.com/second.m4a" }
      ]
    }
    </script>`)
  t.is($jsonld('contentUrl')($), 'https://example.com/first.m4a')
})

test('$jsonld prefers direct path over recursive search', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "MusicRecording",
      "contentUrl": "https://example.com/top-level.m4a",
      "associatedMedia": {
        "contentUrl": "https://example.com/nested.m4a"
      }
    }
    </script>`)
  t.is($jsonld('contentUrl')($), 'https://example.com/top-level.m4a')
})

test('$jsonld returns undefined for truly missing properties', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "Article",
      "headline": "Hello"
    }
    </script>`)
  t.is($jsonld('contentUrl')($), undefined)
})

test('$jsonld decodes HTML entities from recursive results', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "WebPage",
      "mainEntity": {
        "@type": "Article",
        "headline": "Rock &amp; Roll"
      }
    }
    </script>`)
  t.is($jsonld('headline')($), 'Rock & Roll')
})

test('$jsonld handles deeply nested properties (3+ levels)', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "WebPage",
      "mainEntity": {
        "@type": "MusicAlbum",
        "byArtist": {
          "@type": "MusicGroup",
          "track": {
            "@type": "MusicRecording",
            "contentUrl": "https://example.com/deep.m4a"
          }
        }
      }
    }
    </script>`)
  t.is($jsonld('contentUrl')($), 'https://example.com/deep.m4a')
})

test('$jsonld finds property across multiple JSON-LD blocks', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    { "@context": "https://schema.org", "@type": "Organization", "name": "Acme" }
    </script>
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "WebPage",
      "mainEntity": {
        "@type": "MusicRecording",
        "contentUrl": "https://example.com/audio.m4a"
      }
    }
    </script>`)
  t.is($jsonld('contentUrl')($), 'https://example.com/audio.m4a')
})

test('$jsonld preserves falsy primitives (0, false) from recursive search', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "WebPage",
      "mainEntity": {
        "@type": "Product",
        "offers": { "@type": "Offer", "price": 0 }
      }
    }
    </script>`)
  t.is($jsonld('price')($), 0)
})

test('$jsonld prefers direct get() in later block over recursive match in earlier block', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "WebPage",
      "mainEntity": {
        "@type": "MusicRecording",
        "contentUrl": "https://example.com/nested.m4a"
      }
    }
    </script>
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "MusicRecording",
      "contentUrl": "https://example.com/direct.m4a"
    }
    </script>`)
  t.is($jsonld('contentUrl')($), 'https://example.com/direct.m4a')
})

test('$jsonld ignores @context when it is an object with property definitions', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": {
        "@vocab": "http://schema.org/",
        "name": "http://schema.org/name",
        "description": "http://schema.org/description"
      },
      "@type": "Article",
      "name": "Actual Article Title"
    }
    </script>`)
  t.is($jsonld('name')($), 'Actual Article Title')
  t.is($jsonld('description')($), undefined)
})

test('$jsonld does not convert ImageObject with .name to its name string', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "SocialMediaPosting",
      "image": {
        "@type": "ImageObject",
        "name": "photo.jpg",
        "url": "https://example.com/photo.jpg",
        "contentUrl": "https://example.com/photo.jpg"
      }
    }
    </script>`)
  const result = $jsonld('image')($)
  t.is(typeof result, 'object')
  t.is(result.url, 'https://example.com/photo.jpg')
})

test('$jsonld joins multiple author names from array of Person objects', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "NewsArticle",
      "author": [
        { "@type": "Person", "name": "David K. Li" },
        { "@type": "Person", "name": "Doha Madani" }
      ]
    }
    </script>`)
  t.is($jsonld('author.name')($), 'David K. Li and Doha Madani')
})

test('$jsonld returns full object for direct get() when object has .name and non-name properties', t => {
  const $ = cheerio.load(`
    <script type="application/ld+json">
    {
      "@context": "https://schema.org",
      "@type": "WebSite",
      "publisher": {
        "@type": "Organization",
        "name": "Acme Corp",
        "logo": { "url": "https://example.com/logo.png", "width": 100, "height": 100 }
      }
    }
    </script>`)
  const result = $jsonld('publisher')($)
  t.is(typeof result, 'object')
  t.is(result.name, 'Acme Corp')
})