@quintype/seo 1.38.42-subscription-markup.0 → 1.40.0

package/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 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.40.0](https://github.com/quintype/quintype-node-seo/compare/v1.38.37-fix-canonical-url.0...v1.40.0) (2021-12-16)
+
+
+### Features
+
+* generate subscription based schema for news article ([#515](https://github.com/quintype/quintype-node-seo/issues/515)) ([39b2bad](https://github.com/quintype/quintype-node-seo/commit/39b2badaaa156ed6f01e8552e0d1f120b15361c0))
+* **ImageTags:** Added support for og:image:alt and twitter:image:alt ([#501](https://github.com/quintype/quintype-node-seo/issues/501)) ([3d271ab](https://github.com/quintype/quintype-node-seo/commit/3d271ab21e009e0520ce1e6949bb1c8d32eeefa1))
+* **Structure data tool testing:** Add support for testing structure data with all necessary schemas ⚡  ([#507](https://github.com/quintype/quintype-node-seo/issues/507)) ([aeea32a](https://github.com/quintype/quintype-node-seo/commit/aeea32a994bf4cf64cdf538d2ec3d785203b3817))
+
+
+### Bug Fixes
+
+* **pickImage:** image is undefined of pickImage ([#508](https://github.com/quintype/quintype-node-seo/issues/508)) ([fecc8be](https://github.com/quintype/quintype-node-seo/commit/fecc8be44c86220456a511a89d197b52d60875c6))
+
+## [1.39.0](https://github.com/quintype/quintype-node-seo/compare/v1.38.36...v1.39.0) (2021-08-23)
+
+
+### Features
+
+* generate subscription based schema for news article ([#515](https://github.com/quintype/quintype-node-seo/issues/515)) ([39b2bad](https://github.com/quintype/quintype-node-seo/commit/39b2badaaa156ed6f01e8552e0d1f120b15361c0))
+* **ImageTags:** Added support for og:image:alt and twitter:image:alt ([#501](https://github.com/quintype/quintype-node-seo/issues/501)) ([3d271ab](https://github.com/quintype/quintype-node-seo/commit/3d271ab21e009e0520ce1e6949bb1c8d32eeefa1))
+* **Structure data tool testing:** Add support for testing structure data with all necessary schemas ⚡  ([#507](https://github.com/quintype/quintype-node-seo/issues/507)) ([aeea32a](https://github.com/quintype/quintype-node-seo/commit/aeea32a994bf4cf64cdf538d2ec3d785203b3817))
+
+
+### Bug Fixes
+
+* **canonical:** remove canonical url for shell pages ([66cdebf](https://github.com/quintype/quintype-node-seo/commit/66cdebfb8f910adefa16d31d53f7e7473a06be4e))
+* **pickImage:** image is undefined of pickImage ([#508](https://github.com/quintype/quintype-node-seo/issues/508)) ([fecc8be](https://github.com/quintype/quintype-node-seo/commit/fecc8be44c86220456a511a89d197b52d60875c6))
+
 ### [1.38.41](https://github.com/quintype/quintype-node-seo/compare/v1.38.41-news-article-schema.1...v1.38.41) (2021-08-17)
 
 ### [1.38.40](https://github.com/quintype/quintype-node-seo/compare/v1.38.39...v1.38.40) (2021-07-28)

package/dist/index.cjs.js

@@ -471,11 +471,11 @@ function getSchemaType(type) {
   return { "@type": type };
 }
 
-function getSchemaPerson(name) {
+function getSchemaPerson(name, url = "") {
   return Object.assign({}, getSchemaType("Person"), {
     givenName: name,
     name: name
-  });
+  }, url && { url: url });
 }
 
 function getSchemaFooter({ cssSelector }) {
@@ -610,8 +610,14 @@ function generateCommonData(structuredData = {}, story = {}, publisherConfig = {
   }, getSchemaMainEntityOfPage(mainEntityUrl), getSchemaPublisher(structuredData.organization, orgUrl));
 }
 
-function authorData(authors) {
-  return (authors || []).map(author => getSchemaPerson(author.name));
+function authorData(authors = [], authorSchema = [], publisherConfig = {}) {
+  if (authorSchema.length > 0) {
+    return authorSchema.map(author => getSchemaPerson(author.name, author.url));
+  }
+  return authors.map(author => {
+    const authorUrl = author.slug ? `${publisherConfig["sketches-host"]}/author/${author.slug}` : null;
+    return getSchemaPerson(author.name, authorUrl);
+  });
 }
 
 function getTextElementsOfCards(story) {
@@ -649,8 +655,10 @@ function generateArticleData(structuredData = {}, story = {}, publisherConfig =
   const imageWidth = pageType === "story-page-amp" ? "1200" : "480";
   const imageHeight = pageType === "story-page-amp" ? "750" : "270";
   const storyAccessType = storyAccess(story["access"]);
+  const authorSchema = structuredData.authorSchema && structuredData.authorSchema(story) || [];
+
   return Object.assign({}, generateCommonData(structuredData, story, publisherConfig, pageType, timezone), {
-    author: authorData(authors),
+    author: authorData(authors, authorSchema, publisherConfig),
     keywords: metaKeywords.join(","),
     thumbnailUrl: imageUrl(publisherConfig, story["hero-image-s3-key"], imageWidth, imageHeight),
     articleBody: storyKeysPresence && getCompleteText(story, structuredData.stripHtmlFromArticleBody) || "",
@@ -744,6 +752,7 @@ function findStoryElementField(card, type, field, defaultValue) {
 function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherConfig = {}, pageType, timezone) {
   const imageWidth = pageType === "story-page-amp" ? "1200" : "480";
   const imageHeight = pageType === "story-page-amp" ? "750" : "270";
+  const authorSchema = structuredData.authorSchema && structuredData.authorSchema(story) || [];
   return {
     headline: story.headline,
     description: story.summary || story.headline,
@@ -751,7 +760,7 @@ function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherC
     coverageEndTime: stripMillisecondsFromTime(new Date(story["last-published-at"]), timezone),
     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), findStoryElementField(card, "title", "text", story.headline), imageUrl(publisherConfig, findStoryElementField(card, "image", "image-s3-key", story["hero-image-s3-key"]), imageWidth, imageHeight), structuredData, story, 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))
   };
 }
 
@@ -765,8 +774,9 @@ function generateVideoArticleData(structuredData = {}, story = {}, publisherConf
   const headline = get__default['default'](story, ["headline"], "");
   const imageWidth = pageType === "story-page-amp" ? "1200" : "480";
   const imageHeight = pageType === "story-page-amp" ? "750" : "270";
+  const authorSchema = structuredData.authorSchema && structuredData.authorSchema(story) || [];
   return Object.assign({}, generateCommonData(structuredData, story, publisherConfig, pageType, timezone), {
-    author: authorData(story.authors),
+    author: authorData(story.authors, authorSchema, publisherConfig),
     keywords: metaKeywords.join(","),
     dateCreated: stripMillisecondsFromTime(new Date(story["first-published-at"]), timezone),
     dateModified: stripMillisecondsFromTime(new Date(story["last-published-at"]), timezone),
@@ -880,6 +890,14 @@ function generateBreadcrumbListData(pageType = "", publisherConfig = {}, data =
  * @property {Array} structuredDataTags An array of tags describing the publisher. eg: `{structuredDataTags: ["section-page", "tag-page"]}`
  * @property {boolean} isSubscriptionsEnabled Enable subscription based schema (default false)
  * @property {boolean} isShowcaseProduct Should product type be showcase (default false, fallback: basic)
+ * @property {function} authorSchema Should override author-url in Person schema. We have to pass an array of authors with name and URL Eg: "authorSchema" : (story)=> getAuthorWithUrl(story, config); const getAuthorWithUrl = (story, config) => {
+  return story.authors.map((author)=>{
+    return {
+      name: author.name,
+      url: `${config['sketches-host']}/author/${author.id}`
+    }
+  })
+}
  *
  */
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/seo",
-  "version": "1.38.42-subscription-markup.0",
+  "version": "1.40.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

@@ -6,11 +6,16 @@ export function getSchemaType(type) {
   return { "@type": type };
 }
 
-export function getSchemaPerson(name) {
-  return Object.assign({}, getSchemaType("Person"), {
-    givenName: name,
-    name: name,
-  });
+export function getSchemaPerson(name, url = "") {
+  return Object.assign(
+    {},
+    getSchemaType("Person"),
+    {
+      givenName: name,
+      name: name,
+    },
+    url && { url: url }
+  );
 }
 
 export function getSchemaFooter({ cssSelector }) {

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

@@ -59,8 +59,14 @@ function generateCommonData(structuredData = {}, story = {}, publisherConfig = {
   );
 }
 
-function authorData(authors) {
-  return (authors || []).map((author) => getSchemaPerson(author.name));
+function authorData(authors = [], authorSchema = [], publisherConfig = {}) {
+  if (authorSchema.length > 0) {
+    return authorSchema.map((author) => getSchemaPerson(author.name, author.url));
+  }
+  return authors.map((author) => {
+    const authorUrl = author.slug ? `${publisherConfig["sketches-host"]}/author/${author.slug}` : null;
+    return getSchemaPerson(author.name, authorUrl);
+  });
 }
 
 function getTextElementsOfCards(story) {
@@ -98,11 +104,13 @@ function generateArticleData(structuredData = {}, story = {}, publisherConfig =
   const imageWidth = pageType === "story-page-amp" ? "1200" : "480";
   const imageHeight = pageType === "story-page-amp" ? "750" : "270";
   const storyAccessType = storyAccess(story["access"]);
+  const authorSchema = (structuredData.authorSchema && structuredData.authorSchema(story)) || [];
+
   return Object.assign(
     {},
     generateCommonData(structuredData, story, publisherConfig, pageType, timezone),
     {
-      author: authorData(authors),
+      author: authorData(authors, authorSchema, publisherConfig),
       keywords: metaKeywords.join(","),
       thumbnailUrl: imageUrl(publisherConfig, story["hero-image-s3-key"], imageWidth, imageHeight),
       articleBody: (storyKeysPresence && getCompleteText(story, structuredData.stripHtmlFromArticleBody)) || "",
@@ -219,6 +227,7 @@ function findStoryElementField(card, type, field, defaultValue) {
 function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherConfig = {}, pageType, timezone) {
   const imageWidth = pageType === "story-page-amp" ? "1200" : "480";
   const imageHeight = pageType === "story-page-amp" ? "750" : "270";
+  const authorSchema = (structuredData.authorSchema && structuredData.authorSchema(story)) || [];
   return {
     headline: story.headline,
     description: story.summary || story.headline,
@@ -229,7 +238,7 @@ function generateLiveBlogPostingData(structuredData = {}, story = {}, publisherC
     liveBlogUpdate: story.cards.map((card) =>
       getSchemaBlogPosting(
         card,
-        authorData(story.authors),
+        authorData(story.authors, authorSchema, publisherConfig),
         findStoryElementField(card, "title", "text", story.headline),
         imageUrl(
           publisherConfig,
@@ -255,8 +264,9 @@ function generateVideoArticleData(structuredData = {}, story = {}, publisherConf
   const headline = get(story, ["headline"], "");
   const imageWidth = pageType === "story-page-amp" ? "1200" : "480";
   const imageHeight = pageType === "story-page-amp" ? "750" : "270";
+  const authorSchema = (structuredData.authorSchema && structuredData.authorSchema(story)) || [];
   return Object.assign({}, generateCommonData(structuredData, story, publisherConfig, pageType, timezone), {
-    author: authorData(story.authors),
+    author: authorData(story.authors, authorSchema, publisherConfig),
     keywords: metaKeywords.join(","),
     dateCreated: stripMillisecondsFromTime(new Date(story["first-published-at"]), timezone),
     dateModified: stripMillisecondsFromTime(new Date(story["last-published-at"]), timezone),
@@ -370,6 +380,14 @@ function generateBreadcrumbListData(pageType = "", publisherConfig = {}, data =
  * @property {Array} structuredDataTags An array of tags describing the publisher. eg: `{structuredDataTags: ["section-page", "tag-page"]}`
  * @property {boolean} isSubscriptionsEnabled Enable subscription based schema (default false)
  * @property {boolean} isShowcaseProduct Should product type be showcase (default false, fallback: basic)
+ * @property {function} authorSchema Should override author-url in Person schema. We have to pass an array of authors with name and URL Eg: "authorSchema" : (story)=> getAuthorWithUrl(story, config); const getAuthorWithUrl = (story, config) => {
+  return story.authors.map((author)=>{
+    return {
+      name: author.name,
+      url: `${config['sketches-host']}/author/${author.id}`
+    }
+  })
+}
  *
  */