adding support for JSON LD

jshemas · Mar 3, 2024 · ce77f3e · ce77f3e
1 parent fa42962
commit ce77f3e
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 0 deletions.
diff --git a/dist/lib/extract.js b/dist/lib/extract.js
@@ -56,6 +56,11 @@ function extractMetaTags(body, options) {
     // if onlyGetOpenGraphInfo isn't set, run the open graph fallbacks
     if (!options.onlyGetOpenGraphInfo) {
         ogObject = (0, fallback_1.default)(ogObject, options, $, body);
+        $('script').each((index, script) => {
+            if (script.attribs.type && script.attribs.type === 'application/ld+json') {
+                ogObject.jsonLD = JSON.parse($(script).text());
+            }
+        });
     }
     return ogObject;
 }

diff --git a/dist/lib/types.d.ts b/dist/lib/types.d.ts
@@ -161,6 +161,7 @@ export type OgObjectInteral = {
     errorDetails?: Error;
     favicon?: string;
     fbAppId?: string;
+    jsonLD?: object;
     modifiedTime?: string;
     musicAlbum?: string;
     musicAlbumDisc?: string;

diff --git a/lib/extract.ts b/lib/extract.ts
@@ -56,6 +56,12 @@ export default function extractMetaTags(body: string, options: OpenGraphScraperO
   // if onlyGetOpenGraphInfo isn't set, run the open graph fallbacks
   if (!options.onlyGetOpenGraphInfo) {
     ogObject = fallback(ogObject, options, $, body);
+
+    $('script').each((index, script) => {
+      if (script.attribs.type && script.attribs.type === 'application/ld+json') {
+        ogObject.jsonLD = JSON.parse($(script).text());
+      }
+    });
   }
 
   return ogObject;

diff --git a/lib/types.ts b/lib/types.ts
@@ -169,6 +169,7 @@ export type OgObjectInteral = {
   errorDetails?: Error;
   favicon?: string;
   fbAppId?: string;
+  jsonLD?: object;
   modifiedTime?: string;
   musicAlbum?: string;
   musicAlbumDisc?: string;

diff --git a/package.json b/package.json
@@ -64,6 +64,7 @@
   "keywords": [
     "app links",
     "dublin core",
+    "json ld",
     "meta tags",
     "metadata",
     "og",

diff --git a/tests/integration/basic.spec.ts b/tests/integration/basic.spec.ts
@@ -160,9 +160,11 @@ describe('basic', function () {
       expect(result.ogTitle).to.be.eql('Buy a domain name - Register cheap domain names from $0.99 - Namecheap');
       expect(result.ogImage).to.be.an('array').and.to.not.be.empty;
       expect(result.requestUrl).to.be.eql('https://www.namecheap.com/');
+      expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
       expect(result.charset).to.be.eql('utf-8');
       expect(result.success).to.be.eql(true);
       expect(result).to.have.all.keys(
+        'jsonLD',
         'favicon',
         'ogTitle',
         'ogDescription',
@@ -282,6 +284,7 @@ describe('basic', function () {
       expect(result).to.have.all.keys(
         'favicon',
         'fbAppId',
+        'jsonLD',
         'alAndroidAppName',
         'alAndroidPackage',
         'alAndroidUrl',
@@ -372,10 +375,12 @@ describe('basic', function () {
         expect(result.ogTitle).to.be.eql('Facebook - log in or sign up');
         expect(result.ogDescription).to.be.eql('Log into Facebook to start sharing and connecting with your friends, family, and people you know.');
         expect(result.requestUrl).to.be.eql('https://www.facebook.com/');
+        expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
         expect(result.charset).to.be.eql('utf-8');
         expect(result.success).to.be.eql(true);
         expect(result).to.have.all.keys(
           'favicon',
+          'jsonLD',
           'ogDescription',
           'ogImage',
           'ogLocale',

diff --git a/tests/integration/encoding.spec.ts b/tests/integration/encoding.spec.ts
@@ -30,11 +30,13 @@ describe('encoding', function () {
           url: 'https://r.r10s.jp/com/img/home/top/ogp.png',
         }]);
         expect(result.requestUrl).to.be.eql('https://jshemas.github.io/openGraphScraperPages/rakuten');
+        expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
         expect(result.fbAppId).to.be.eql('194149240717705');
         expect(result.charset).to.be.eql('euc-jp');
         expect(result.success).to.be.eql(true);
         expect(result).to.have.all.keys(
           'favicon',
+          'jsonLD',
           'ogDescription',
           'ogImage',
           'ogSiteName',
@@ -211,9 +213,11 @@ describe('encoding', function () {
           expect(result.ogUrl).to.be.eql('https://blog.csdn.net/qq449245884/article/details/107096460');
           expect(result.charset).to.be.eql('UTF-8');
           expect(result.requestUrl).to.be.eql('https://jshemas.github.io/openGraphScraperPages/csdn');
+          expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
           expect(result.success).to.be.eql(true);
           expect(result).to.have.all.keys(
             'favicon',
+            'jsonLD',
             'charset',
             'ogDescription',
             'ogImage',
@@ -304,9 +308,11 @@ describe('encoding', function () {
           expect(result.requestUrl).to.be.eql('https://jshemas.github.io/openGraphScraperPages/okezone');
           expect(result.success).to.be.eql(true);
           expect(result.fbAppId).to.be.eql('213195442194472');
+          expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
           expect(result).to.have.all.keys(
             'favicon',
             'fbAppId',
+            'jsonLD',
             'articleAuthor',
             'articlePublishedTime',
             'articlePublisher',

diff --git a/tests/integration/image.spec.ts b/tests/integration/image.spec.ts
@@ -33,9 +33,11 @@ describe('image', function () {
       expect(result.requestUrl).to.be.eql('https://jshemas.github.io/openGraphScraperPages/flickr');
       expect(result.charset).to.be.eql('UTF-8');
       expect(result.fbAppId).to.be.eql('137206539707334');
+      expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
       expect(result.success).to.be.eql(true);
       expect(result).to.have.all.keys(
         'favicon',
+        'jsonLD',
         'fbAppId',
         'alIosAppName',
         'alIosAppStoreId',

diff --git a/tests/integration/redirect.spec.ts b/tests/integration/redirect.spec.ts
@@ -123,8 +123,10 @@ describe('redirect', function () {
         expect(result.requestUrl).to.be.eql('https://www.forbes.com/sites/kenkam/2017/09/28/3-stocks-like-apple-was-10-years-ago-tesla-nvidia-and-alibaba/#2636f6c2f0fa');
         expect(result.charset).to.be.eql('utf-8');
         expect(result.fbAppId).to.be.eql('123694841080850');
+        expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
         expect(result.success).to.be.eql(true);
         expect(result).to.have.all.keys(
+          'jsonLD',
           'favicon',
           'fbAppId',
           'ogDate',

diff --git a/tests/integration/spotify.spec.ts b/tests/integration/spotify.spec.ts
@@ -70,10 +70,12 @@ describe('spotify', function () {
       expect(result.requestUrl).to.be.eql('https://open.spotify.com/album/5EBGCvO6upi3GNknMVe9x9');
       expect(result.charset).to.be.eql('utf-8');
       expect(result.fbAppId).to.be.eql('174829003346');
+      expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
       expect(result.success).to.be.eql(true);
       expect(result).to.have.all.keys(
         'favicon',
         'fbAppId',
+        'jsonLD',
         'alAndroidAppName',
         'alAndroidPackage',
         'alAndroidUrl',
@@ -134,10 +136,12 @@ describe('spotify', function () {
       expect(result.requestUrl).to.be.eql('https://open.spotify.com/artist/5K4W6rqBFWDnAN6FQUkS6x');
       expect(result.charset).to.be.eql('utf-8');
       expect(result.fbAppId).to.be.eql('174829003346');
+      expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
       expect(result.success).to.be.eql(true);
       expect(result).to.have.all.keys(
         'favicon',
         'fbAppId',
+        'jsonLD',
         'alAndroidAppName',
         'alAndroidPackage',
         'alAndroidUrl',
@@ -202,10 +206,12 @@ describe('spotify', function () {
       expect(result.requestUrl).to.be.eql('https://open.spotify.com/track/3p6fkbeZDIVqapfdgQe6fm');
       expect(result.charset).to.be.eql('utf-8');
       expect(result.fbAppId).to.be.eql('174829003346');
+      expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
       expect(result.success).to.be.eql(true);
       expect(result).to.have.all.keys(
         'favicon',
         'fbAppId',
+        'jsonLD',
         'alAndroidAppName',
         'alAndroidPackage',
         'alAndroidUrl',
@@ -317,10 +323,12 @@ describe('spotify', function () {
       expect(result.requestUrl).to.be.eql('https://jshemas.github.io/openGraphScraperPages/spotifyPlayList');
       expect(result.charset).to.be.eql('UTF-8');
       expect(result.fbAppId).to.be.eql('174829003346');
+      expect(result.jsonLD).to.be.an('object').and.to.not.be.empty;
       expect(result.success).to.be.eql(true);
       expect(result).to.have.all.keys(
         'favicon',
         'fbAppId',
+        'jsonLD',
         'alAndroidAppName',
         'alAndroidPackage',
         'alAndroidUrl',