@quintype/seo 1.46.5 → 1.47.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.47.0](https://github.com/quintype/quintype-node-seo/compare/v1.46.5...v1.47.0) (2024-10-30)
+
+
+### Features
+
+* **sponsor schema:** update article and news article schema for sponsored stories ([#564](https://github.com/quintype/quintype-node-seo/issues/564)) ([ca2cf07](https://github.com/quintype/quintype-node-seo/commit/ca2cf07ed54d6b7508b4d21b1570f45f711b5dc2))
+
 ### [1.46.5](https://github.com/quintype/quintype-node-seo/compare/v1.46.4...v1.46.5) (2024-09-25)
 
 

package/dist/index.cjs.js

@@ -642,6 +642,9 @@ function generateArticleData(structuredData = {}, story = {}, publisherConfig =
   const storyAccessType = storyAccess(story["access"]);
   const authorSchema = structuredData.authorSchema && structuredData.authorSchema(story) || [];
   const isAccessibleForFree = storyAccessType ? {} : { isAccessibleForFree: storyAccessType };
+  const metadata = get__default["default"](story, ["metadata"], {});
+  const sponsor = metadata.hasOwnProperty("sponsored-by") ? { sponsor: { name: metadata["sponsored-by"] } } : {};
+
   return Object.assign({}, generateCommonData(structuredData, story, publisherConfig, timezone), {
     author: authorData(authors, authorSchema, publisherConfig),
     keywords: metaKeywords.join(","),
@@ -652,7 +655,7 @@ function generateArticleData(structuredData = {}, story = {}, publisherConfig =
     datePublished: stripMillisecondsFromTime(new Date(story["first-published-at"]), timezone),
     name: storyKeysPresence && story.headline || "",
     image: generateArticleImageData(story["hero-image-s3-key"], publisherConfig)
-  }, isAccessibleForFree, { isPartOf: generateIsPartOfDataForArticle(story, publisherConfig) }, articleSectionObj(story));
+  }, isAccessibleForFree, sponsor, { isPartOf: generateIsPartOfDataForArticle(story, publisherConfig) }, articleSectionObj(story));
 }
 
 function generateArticleImageData(image, publisherConfig = {}) {
@@ -722,10 +725,13 @@ function generateNewsArticleData(structuredData = {}, story = {}, publisherConfi
   const { alternative = {} } = story.alternative || {};
   const storyAccessType = storyAccess(story["access"]);
   const isAccessibleForFree = storyAccessType ? {} : { isAccessibleForFree: storyAccessType };
+  const metadata = get__default["default"](story, ["metadata"], {});
+  const sponsor = metadata.hasOwnProperty("sponsored-by") ? { sponsor: { name: metadata["sponsored-by"] } } : {};
+
   return Object.assign({}, {
     alternativeHeadline: alternative.home && alternative.home.default ? alternative.home.default.headline : "",
     description: story.summary
-  }, isAccessibleForFree, { isPartOf: generateIsPartOfDataForNewsArticle(story, publisherConfig, pageType, structuredData) }, generateHasPartData(storyAccessType));
+  }, sponsor, isAccessibleForFree, { isPartOf: generateIsPartOfDataForNewsArticle(story, publisherConfig, pageType, structuredData) }, generateHasPartData(storyAccessType));
 }
 
 function findStoryElementField(card, type, field, defaultValue) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/seo",
-  "version": "1.46.5",
+  "version": "1.47.0",
   "description": "SEO Modules for Quintype",
   "main": "dist/index.cjs.js",
   "repository": "https://github.com/quintype/quintype-node-seo",

package/src/structured-data/structured-data-tags.js

@@ -107,6 +107,9 @@ function generateArticleData(structuredData = {}, story = {}, publisherConfig =
   const storyAccessType = storyAccess(story["access"]);
   const authorSchema = (structuredData.authorSchema && structuredData.authorSchema(story)) || [];
   const isAccessibleForFree = storyAccessType ? {} : { isAccessibleForFree: storyAccessType };
+  const metadata = get(story, ["metadata"], {});
+  const sponsor = metadata.hasOwnProperty("sponsored-by") ? { sponsor: { name: metadata["sponsored-by"] } } : {};
+
   return Object.assign(
     {},
     generateCommonData(structuredData, story, publisherConfig, timezone),
@@ -122,6 +125,7 @@ function generateArticleData(structuredData = {}, story = {}, publisherConfig =
       image: generateArticleImageData(story["hero-image-s3-key"], publisherConfig),
     },
     isAccessibleForFree,
+    sponsor,
     { isPartOf: generateIsPartOfDataForArticle(story, publisherConfig) },
     articleSectionObj(story)
   );
@@ -210,12 +214,16 @@ function generateNewsArticleData(structuredData = {}, story = {}, publisherConfi
   const { alternative = {} } = story.alternative || {};
   const storyAccessType = storyAccess(story["access"]);
   const isAccessibleForFree = storyAccessType ? {} : { isAccessibleForFree: storyAccessType };
+  const metadata = get(story, ["metadata"], {});
+  const sponsor = metadata.hasOwnProperty("sponsored-by") ? { sponsor: { name: metadata["sponsored-by"] } } : {};
+
   return Object.assign(
     {},
     {
       alternativeHeadline: alternative.home && alternative.home.default ? alternative.home.default.headline : "",
       description: story.summary,
     },
+    sponsor,
     isAccessibleForFree,
     { isPartOf: generateIsPartOfDataForNewsArticle(story, publisherConfig, pageType, structuredData) },
     generateHasPartData(storyAccessType)