@quintype/seo 1.50.1 → 1.50.2-aff-mkt-template.1

package/dist/index.cjs.js

@@ -1060,6 +1060,7 @@ function StructuredDataTags({ structuredData = {} }, config, pageType, response
   const structuredDataTags = get__default["default"](structuredData, ["structuredDataTags"], []);
   const enableEventsData = get__default["default"](structuredData, ["enableEventsData"], null);
   const enableStorySeoEventsData = get__default["default"](story, ["enableSeoEventsData"], null);
+  const enableAffiliateMarketing = get__default["default"](structuredData, ["enableAffiliateMarketing"], false);
   let articleData = {};
 
   if (!isStructuredDataEmpty) {
@@ -1094,6 +1095,13 @@ function StructuredDataTags({ structuredData = {} }, config, pageType, response
     newsArticleTags ? tags.push(storyTags(), newsArticleTags) : tags.push(storyTags());
   }
 
+  if (enableAffiliateMarketing && !isStructuredDataEmpty && pageType === "story-page" && story["story-template"] === "affiliate-marketing") {
+    const affiliateProductTags = generateAffiliateProductData();
+    if (affiliateProductTags) {
+      tags.push(...affiliateProductTags);
+    }
+  }
+
   if (!isStructuredDataEmpty && pageType === "story-page-amp") {
     const newsArticleTags = generateNewsArticleTags();
     newsArticleTags ? tags.push(storyTags(), newsArticleTags) : tags.push(storyTags());
@@ -1187,6 +1195,49 @@ function StructuredDataTags({ structuredData = {} }, config, pageType, response
     return ldJson("MediaGallery", schema);
   }
 
+  function generateAffiliateProductData() {
+    const storyUrl = story.url || `${publisherConfig["sketches-host"]}/${story.slug}`;
+    const authorName = get__default["default"](story, ["authors", 0, "name"]) || story["author-name"] || "";
+    const datePublished = stripMillisecondsFromTime(new Date(story["first-published-at"]), timezone);
+    const cards = get__default["default"](story, ["cards"], []);
+
+    const products = cards.reduce((acc, card) => {
+      const elements = get__default["default"](card, ["story-elements"], []);
+      let titleEl, imageEl, ctaEl, textEl;
+      for (const el of elements) {
+        if (!titleEl && el.type === "title") titleEl = el;else if (!imageEl && el.type === "image") imageEl = el;else if (!ctaEl && el.type === "text" && el.subtype === "cta") ctaEl = el;else if (!textEl && el.type === "text" && el.subtype !== "cta") textEl = el;
+      }
+
+      if (!titleEl) return acc;
+
+      const name = getPlainText(titleEl.text || titleEl.title || "");
+      if (!name) return acc;
+
+      const reviewBody = getPlainText(get__default["default"](textEl, ["text"], ""));
+      const ctaUrl = get__default["default"](ctaEl, ["metadata", "cta-url"]);
+
+      const product = {
+        name,
+        url: ctaUrl || `${storyUrl}#${card.id}`,
+        review: {
+          "@type": "Review",
+          author: getSchemaPerson(authorName),
+          reviewBody,
+          datePublished
+        }
+      };
+
+      if (imageEl && imageEl["image-s3-key"]) {
+        product.image = imageUrl(publisherConfig, imageEl["image-s3-key"]);
+      }
+
+      acc.push(ldJson("Product", product));
+      return acc;
+    }, []);
+
+    return products.length ? products : null;
+  }
+
   // All Pages have: Publisher, Site
   // Story Page have : Article/NewsArticle/LiveBlog/Review as appropriate
   return tags;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/seo",
-  "version": "1.50.1",
+  "version": "1.50.2-aff-mkt-template.1",
   "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

@@ -564,6 +564,7 @@ export function StructuredDataTags({ structuredData = {} }, config, pageType, re
   const structuredDataTags = get(structuredData, ["structuredDataTags"], []);
   const enableEventsData = get(structuredData, ["enableEventsData"], null);
   const enableStorySeoEventsData = get(story, ["enableSeoEventsData"], null);
+  const enableAffiliateMarketing = get(structuredData, ["enableAffiliateMarketing"], false);
   let articleData = {};
 
   if (!isStructuredDataEmpty) {
@@ -598,6 +599,13 @@ export function StructuredDataTags({ structuredData = {} }, config, pageType, re
     newsArticleTags ? tags.push(storyTags(), newsArticleTags) : tags.push(storyTags());
   }
 
+  if (enableAffiliateMarketing && !isStructuredDataEmpty && pageType === "story-page" && story["story-template"] === "affiliate-marketing") {
+    const affiliateProductTags = generateAffiliateProductData();
+    if (affiliateProductTags) {
+      tags.push(...affiliateProductTags);
+    }
+  }
+
   if (!isStructuredDataEmpty && pageType === "story-page-amp") {
     const newsArticleTags = generateNewsArticleTags();
     newsArticleTags ? tags.push(storyTags(), newsArticleTags) : tags.push(storyTags());
@@ -700,6 +708,52 @@ export function StructuredDataTags({ structuredData = {} }, config, pageType, re
     return ldJson("MediaGallery", schema);
   }
 
+  function generateAffiliateProductData() {
+    const storyUrl = story.url || `${publisherConfig["sketches-host"]}/${story.slug}`;
+    const authorName = get(story, ["authors", 0, "name"]) || story["author-name"] || "";
+    const datePublished = stripMillisecondsFromTime(new Date(story["first-published-at"]), timezone);
+    const cards = get(story, ["cards"], []);
+
+    const products = cards.reduce((acc, card) => {
+      const elements = get(card, ["story-elements"], []);
+      let titleEl, imageEl, ctaEl, textEl;
+      for (const el of elements) {
+        if (!titleEl && el.type === "title") titleEl = el;
+        else if (!imageEl && el.type === "image") imageEl = el;
+        else if (!ctaEl && el.type === "text" && el.subtype === "cta") ctaEl = el;
+        else if (!textEl && el.type === "text" && el.subtype !== "cta") textEl = el;
+      }
+
+      if (!titleEl) return acc;
+
+      const name = getPlainText(titleEl.text || titleEl.title || "");
+      if (!name) return acc;
+
+      const reviewBody = getPlainText(get(textEl, ["text"], ""));
+      const ctaUrl = get(ctaEl, ["metadata", "cta-url"]);
+
+      const product = {
+        name,
+        url: ctaUrl || `${storyUrl}#${card.id}`,
+        review: {
+          "@type": "Review",
+          author: getSchemaPerson(authorName),
+          reviewBody,
+          datePublished,
+        },
+      };
+
+      if (imageEl && imageEl["image-s3-key"]) {
+        product.image = imageUrl(publisherConfig, imageEl["image-s3-key"]);
+      }
+
+      acc.push(ldJson("Product", product));
+      return acc;
+    }, []);
+
+    return products.length ? products : null;
+  }
+
   // All Pages have: Publisher, Site
   // Story Page have : Article/NewsArticle/LiveBlog/Review as appropriate
   return tags;