@quintype/seo 1.46.4-recipe-schema.5 → 1.46.4

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.46.4](https://github.com/quintype/quintype-node-seo/compare/v1.46.3...v1.46.4) (2024-08-14)
+
 ### [1.46.3](https://github.com/quintype/quintype-node-seo/compare/v1.46.2...v1.46.3) (2024-07-17)
 
 ### [1.46.2](https://github.com/quintype/quintype-node-seo/compare/v1.46.1...v1.46.2) (2024-06-12)

package/dist/index.cjs.js

@@ -24,22 +24,6 @@ function objectToTags(object) {
   return lodash.entries(object).filter(([key, value]) => value).map(([key, value]) => ({ [getPropertyName(key)]: key, content: value }));
 }
 
-function extractTextFromHtmlString(html) {
-  const regex = /<p>(.*?)<\/p>/g;
-  const textContents = [];
-
-  let match;
-  while ((match = regex.exec(html)) !== null) {
-    textContents.push(match[1]);
-  }
-
-  return textContents;
-}
-
-const getCardAttributes = (card, type) => {
-  return card.metadata.attributes[type];
-};
-
 function getPropertyName(key) {
   return key.startsWith("fb:") || key.startsWith("og:") ? "property" : "name";
 }
@@ -569,28 +553,6 @@ function generateAuthorPageSchema(publisherConfig, data, url) {
   };
 }
 
-function generateRecipePageSchema(story) {
-  const { headline, url, "author-name": authorName, description } = story;
-
-  const cardsWithAttributes = story.cards.filter(card => getCardAttributes(card, "cardtype"));
-  const cardWithIngredients = cardsWithAttributes.filter(card => getCardAttributes(card, "cardtype").includes("ingredients "));
-  const ingredientsRichText = lodash.get(cardWithIngredients, ["0", "story-elements", "0", "text"], "");
-  const ingredients = extractTextFromHtmlString(ingredientsRichText);
-
-  return {
-    "@context": "https://schema.org/",
-    "@type": "Recipe",
-    name: headline,
-    url: url,
-    author: {
-      "@type": "Person",
-      name: authorName
-    },
-    description: description,
-    recipeIngredient: ingredients
-  };
-}
-
 function getMovieEntityTags(movieJson) {
     return getSchemaMovieReview(movieJson);
 }
@@ -774,12 +736,20 @@ function findStoryElementField(card, type, field, defaultValue) {
   if (elements.length > 0) return elements[0][field];else return defaultValue;
 }
 
+function getTextElementsOfOneCard(storyElements = []) {
+  return storyElements.filter(element => element.type === "text");
+}
+
+function getCompleteTextOfOneCard(storyElements, stripHtmlFromArticleBody) {
+  return getTextElementsOfOneCard(storyElements).map(item => stripHtmlFromArticleBody ? getPlainText(item.text) : item.text).join(".");
+}
+
 function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherConfig = {}, timezone) {
   const imageWidth = 1200;
   const imageHeight = 675;
   const authorSchema = structuredData.authorSchema && structuredData.authorSchema(story) || [];
   const storyKeysPresence = Object.keys(story).length > 0;
-  const articleBody = storyKeysPresence && getCompleteText(story, structuredData.stripHtmlFromArticleBody) || "";
+  storyKeysPresence && getCompleteText(story, structuredData.stripHtmlFromArticleBody) || "";
   return {
     headline: story.headline,
     description: story.summary || story.headline,
@@ -788,16 +758,21 @@ function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherC
     coverageStartTime: stripMillisecondsFromTime(new Date(story["first-published-at"]), timezone),
     dateModified: stripMillisecondsFromTime(new Date(story["last-published-at"]), timezone),
 
-    liveBlogUpdate: story.cards.map(card => getSchemaBlogPosting(card, authorData(story.authors, authorSchema, publisherConfig), findStoryElementField(card, "title", "text", story.headline), imageUrl(publisherConfig, findStoryElementField(card, "image", "image-s3-key", story["hero-image-s3-key"]), imageWidth, imageHeight), structuredData, story, timezone, articleBody))
+    liveBlogUpdate: story.cards.map(card => {
+      const storyElements = get__default["default"](card, ["story-elements"]);
+      const cardArticleBody = getCompleteTextOfOneCard(storyElements, structuredData.stripHtmlFromArticleBody) || "";
+
+      return getSchemaBlogPosting(card, authorData(story.authors, authorSchema, publisherConfig), findStoryElementField(card, "title", "text", story.headline), imageUrl(publisherConfig, findStoryElementField(card, "image", "image-s3-key", story["hero-image-s3-key"]), imageWidth, imageHeight), structuredData, story, timezone, cardArticleBody);
+    })
   };
 }
 
 function getEmbedUrl(cards) {
   const playerUrlMapping = {
     "dailymotion-embed-script": "dailymotion-url",
-    instagram: "instagram-url",
+    "instagram": "instagram-url",
     "facebook-video": "facebook-url",
-    tweet: "tweet-url",
+    "tweet": "tweet-url",
     "vimeo-video": "vimeo-url",
     "brightcove-video": "player-url"
   };
@@ -810,8 +785,7 @@ function getEmbedUrl(cards) {
         if (elem.metadata && elem.metadata[playerUrlField]) {
           return elem.metadata[playerUrlField];
         }
-      }
-      if (elem.type === "youtube-video" && elem.subtype === null) {
+      }      if (elem.type === "youtube-video" && elem.subtype === null) {
         if (elem.url) {
           return elem.url;
         }
@@ -976,6 +950,7 @@ function StructuredDataTags({ structuredData = {} }, config, pageType, response
   const isStructuredDataEmpty = Object.keys(structuredData).length === 0;
   const enableBreadcrumbList = get__default["default"](structuredData, ["enableBreadcrumbList"], true);
   const structuredDataTags = get__default["default"](structuredData, ["structuredDataTags"], []);
+
   let articleData = {};
 
   if (!isStructuredDataEmpty) {
@@ -1004,17 +979,6 @@ function StructuredDataTags({ structuredData = {} }, config, pageType, response
   if (!isStructuredDataEmpty && pageType === "story-page") {
     const newsArticleTags = generateNewsArticleTags();
     newsArticleTags ? tags.push(storyTags(), newsArticleTags) : tags.push(storyTags());
-    if (story["story-template"] === "recipe") {
-      const recipeTags = generateRecipePageSchema(story);
-      recipeTags.image = Object.assign({
-        "@type": "ImageObject"
-      }, generateArticleImageData(story["hero-image-s3-key"], publisherConfig));
-      recipeTags.video = Object.assign({
-        "@type": "VideoObject"
-      }, generateVideoArticleData(structuredData, story, publisherConfig, timezone));
-
-      tags.push(ldJson("Recipe", recipeTags));
-    }
   }
 
   if (!isStructuredDataEmpty && pageType === "story-page-amp") {

package/package.json

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

package/src/structured-data/schema.js

@@ -1,6 +1,6 @@
 import { get } from "lodash";
 import { getTitle } from "../generate-common-seo";
-import { extractTextFromHtmlString, getCardAttributes, stripMillisecondsFromTime } from "../utils";
+import { stripMillisecondsFromTime } from "../utils";
 export const getSchemaContext = { "@context": "http://schema.org" };
 
 export function getSchemaType(type) {
@@ -151,27 +151,3 @@ export function generateAuthorPageSchema(publisherConfig, data, url) {
     },
   };
 }
-
-export function generateRecipePageSchema(story) {
-  const { headline, url, "author-name": authorName, description } = story;
-
-  const cardsWithAttributes = story.cards.filter((card) => getCardAttributes(card, "cardtype"));
-  const cardWithIngredients = cardsWithAttributes.filter((card) =>
-    getCardAttributes(card, "cardtype").includes("ingredients ")
-  );
-  const ingredientsRichText = get(cardWithIngredients, ["0", "story-elements", "0", "text"], "");
-  const ingredients = extractTextFromHtmlString(ingredientsRichText);
-
-  return {
-    "@context": "https://schema.org/",
-    "@type": "Recipe",
-    name: headline,
-    url: url,
-    author: {
-      "@type": "Person",
-      name: authorName,
-    },
-    description: description,
-    recipeIngredient: ingredients,
-  };
-}

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

@@ -3,7 +3,6 @@ import { getQueryParams, stripMillisecondsFromTime } from "../utils";
 import { generateTagsForEntity } from "./entity";
 import {
   generateAuthorPageSchema,
-  generateRecipePageSchema,
   getSchemaBlogPosting,
   getSchemaBreadcrumbList,
   getSchemaContext,
@@ -229,6 +228,16 @@ function findStoryElementField(card, type, field, defaultValue) {
   else return defaultValue;
 }
 
+function getTextElementsOfOneCard(storyElements = []) {
+  return storyElements.filter((element) => element.type === "text");
+}
+
+function getCompleteTextOfOneCard(storyElements, stripHtmlFromArticleBody) {
+  return getTextElementsOfOneCard(storyElements)
+    .map((item) => (stripHtmlFromArticleBody ? getPlainText(item.text) : item.text))
+    .join(".");
+}
+
 function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherConfig = {}, timezone) {
   const imageWidth = 1200;
   const imageHeight = 675;
@@ -243,8 +252,11 @@ function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherC
     coverageStartTime: stripMillisecondsFromTime(new Date(story["first-published-at"]), timezone),
     dateModified: stripMillisecondsFromTime(new Date(story["last-published-at"]), timezone),
 
-    liveBlogUpdate: story.cards.map((card) =>
-      getSchemaBlogPosting(
+    liveBlogUpdate: story.cards.map((card) => {
+      const storyElements = get(card, ["story-elements"]);
+      const cardArticleBody = getCompleteTextOfOneCard(storyElements, structuredData.stripHtmlFromArticleBody) || "";
+
+      return getSchemaBlogPosting(
         card,
         authorData(story.authors, authorSchema, publisherConfig),
         findStoryElementField(card, "title", "text", story.headline),
@@ -257,20 +269,20 @@ function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherC
         structuredData,
         story,
         timezone,
-        articleBody
-      )
-    ),
+        cardArticleBody
+      );
+    }),
   };
 }
 
 function getEmbedUrl(cards) {
   const playerUrlMapping = {
     "dailymotion-embed-script": "dailymotion-url",
-    instagram: "instagram-url",
+    "instagram": "instagram-url",
     "facebook-video": "facebook-url",
-    tweet: "tweet-url",
+    "tweet": "tweet-url",
     "vimeo-video": "vimeo-url",
-    "brightcove-video": "player-url",
+    "brightcove-video": "player-url"
   };
 
   for (const card of cards) {
@@ -281,7 +293,7 @@ function getEmbedUrl(cards) {
         if (elem.metadata && elem.metadata[playerUrlField]) {
           return elem.metadata[playerUrlField];
         }
-      }
+      };
       if (elem.type === "youtube-video" && elem.subtype === null) {
         if (elem.url) {
           return elem.url;
@@ -447,6 +459,7 @@ export function StructuredDataTags({ structuredData = {} }, config, pageType, re
   const isStructuredDataEmpty = Object.keys(structuredData).length === 0;
   const enableBreadcrumbList = get(structuredData, ["enableBreadcrumbList"], true);
   const structuredDataTags = get(structuredData, ["structuredDataTags"], []);
+
   let articleData = {};
 
   if (!isStructuredDataEmpty) {
@@ -475,23 +488,6 @@ export function StructuredDataTags({ structuredData = {} }, config, pageType, re
   if (!isStructuredDataEmpty && pageType === "story-page") {
     const newsArticleTags = generateNewsArticleTags();
     newsArticleTags ? tags.push(storyTags(), newsArticleTags) : tags.push(storyTags());
-    if (story["story-template"] === "recipe") {
-      const recipeTags = generateRecipePageSchema(story);
-      recipeTags.image = Object.assign(
-        {
-          "@type": "ImageObject",
-        },
-        generateArticleImageData(story["hero-image-s3-key"], publisherConfig)
-      );
-      recipeTags.video = Object.assign(
-        {
-          "@type": "VideoObject",
-        },
-        generateVideoArticleData(structuredData, story, publisherConfig, timezone)
-      );
-
-      tags.push(ldJson("Recipe", recipeTags));
-    }
   }
 
   if (!isStructuredDataEmpty && pageType === "story-page-amp") {

package/src/utils.js

@@ -8,22 +8,6 @@ export function objectToTags(object) {
     .map(([key, value]) => ({ [getPropertyName(key)]: key, content: value }));
 }
 
-export function extractTextFromHtmlString(html) {
-  const regex = /<p>(.*?)<\/p>/g;
-  const textContents = [];
-
-  let match;
-  while ((match = regex.exec(html)) !== null) {
-    textContents.push(match[1]);
-  }
-
-  return textContents;
-}
-
-export const getCardAttributes = (card, type) => {
-  return card.metadata.attributes[type];
-};
-
 function getPropertyName(key) {
   return key.startsWith("fb:") || key.startsWith("og:") ? "property" : "name";
 }