@quintype/seo 1.47.0 → 1.48.0-recipe-schema.0

package/dist/index.cjs.js

@@ -550,6 +550,33 @@ function generateAuthorPageSchema(publisherConfig, data, url) {
   };
 }
 
+function generateRecipePageSchema(story) {
+  const { headline, url, "author-name": authorName, description, metadata } = story;
+  const servings = lodash.get(metadata, ["servings"], "");
+  const ingredients = lodash.get(metadata, ["ingredients"], "");
+  const recipeAttributes = lodash.get(metadata, ["story-attributes"], "");
+  const cuisine = lodash.get(recipeAttributes, ["cuisine", "0"], "");
+  const preperationtime = lodash.get(recipeAttributes, ["preparationtime", "0"], "");
+  const cookingtime = lodash.get(recipeAttributes, ["cookingtime", "0"], "");
+
+  return {
+    "@context": "https://schema.org/",
+    "@type": "Recipe",
+    name: headline,
+    url: url,
+    author: {
+      "@type": "Person",
+      name: authorName
+    },
+    description: description,
+    recipeIngredient: ingredients,
+    prepTime: preperationtime,
+    cookTime: cookingtime,
+    recipeCuisine: cuisine,
+    recipeYield: servings
+  };
+}
+
 function getMovieEntityTags(movieJson) {
     return getSchemaMovieReview(movieJson);
 }
@@ -960,7 +987,6 @@ 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) {
@@ -989,11 +1015,33 @@ 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") {
     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 && structuredData.header) {

package/package.json

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

package/src/structured-data/schema.js

@@ -141,3 +141,30 @@ export function generateAuthorPageSchema(publisherConfig, data, url) {
     },
   };
 }
+
+export function generateRecipePageSchema(story) {
+  const { headline, url, "author-name": authorName, description, metadata } = story;
+  const servings = get(metadata, ["servings"], "");
+  const ingredients = get(metadata, ["ingredients"], "");
+  const recipeAttributes = get(metadata, ["story-attributes"], "");
+  const cuisine = get(recipeAttributes, ["cuisine", "0"], "");
+  const preperationtime = get(recipeAttributes, ["preparationtime", "0"], "");
+  const cookingtime = get(recipeAttributes, ["cookingtime", "0"], "");
+
+  return {
+    "@context": "https://schema.org/",
+    "@type": "Recipe",
+    name: headline,
+    url: url,
+    author: {
+      "@type": "Person",
+      name: authorName,
+    },
+    description: description,
+    recipeIngredient: ingredients,
+    prepTime: preperationtime,
+    cookTime: cookingtime,
+    recipeCuisine: cuisine,
+    recipeYield: servings,
+  };
+}

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

@@ -3,6 +3,7 @@ import { getQueryParams, stripMillisecondsFromTime } from "../utils";
 import { generateTagsForEntity } from "./entity";
 import {
   generateAuthorPageSchema,
+  generateRecipePageSchema,
   getSchemaBlogPosting,
   getSchemaBreadcrumbList,
   getSchemaContext,
@@ -472,7 +473,6 @@ 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) {
@@ -501,11 +501,45 @@ 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") {
     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 && structuredData.header) {