@quintype/seo 1.48.2-support-event-schema.5 → 1.49.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.49.0](https://github.com/quintype/quintype-node-seo/compare/v1.48.1...v1.49.0) (2025-04-24)
+
+
+### Features
+
+* add event schema support when eventDetails exist in story data ([#567](https://github.com/quintype/quintype-node-seo/issues/567)) ([941b86e](https://github.com/quintype/quintype-node-seo/commit/941b86eedd93845fd7a295341a75bd667c35fc85))
+
 ### [1.48.1](https://github.com/quintype/quintype-node-seo/compare/v1.48.0...v1.48.1) (2024-12-17)
 
 

package/dist/index.cjs.js

@@ -913,15 +913,47 @@ function generateBreadcrumbListData(pageType = "", publisherConfig = {}, data =
   return getSchemaBreadcrumbList(breadcrumbsDataList);
 }
 
-function generateEventsSchema(story = {}) {
-  const { location = "", startdate = "", enddate = "", mode = "offline", paidevent = false, organizertype = "Organization", organizername = "", organizeremail = "", organizerurl = "", organizertelephone = "" } = story.eventDetails || {};
+function generateEventsSchema(story = {}, publisherConfig = {}) {
+  const {
+    location = '',
+    startdate = '',
+    enddate = '',
+    mode = 'offline',
+    paidevent = false,
+    organizertype = 'Organization',
+    organizername = '',
+    organizeremail = '',
+    organizerurl = '',
+    organizertelephone = ''
+  } = story.eventDetails || {};
   const eventMode = {
-    online: "https://schema.org/OnlineEventAttendanceMode",
-    offline: "https://schema.org/OfflineEventAttendanceMode",
-    mix: "https://schema.org/MixedEventAttendanceMode"
+    online: 'https://schema.org/OnlineEventAttendanceMode',
+    offline: 'https://schema.org/OfflineEventAttendanceMode',
+    mix: 'https://schema.org/MixedEventAttendanceMode'
   };
-  const organizerData = organizername ? { Organizer: Object.assign({}, getSchemaType(organizertype), { name: organizername, url: organizerurl, email: organizeremail, telephone: organizertelephone }) } : {};
-  const eventsData = Object.assign({}, getSchemaContext, getSchemaType("Event"), { name: story.headline, description: story.subheadline || "", url: story.url, image: story["hero-image-s3-key"] || "", startDate: startdate, endDate: enddate, eventAttendanceMode: eventMode[mode], isAccessibleForFree: paidevent, eventStatus: "https://schema.org/EventScheduled", location: location }, organizerData);
+  const imageWidth = 1200;
+  const imageHeight = 675;
+  const image = imageUrl(publisherConfig, story['hero-image-s3-key'], imageWidth, imageHeight);
+  const organizerData = organizername ? {
+    Organizer: Object.assign({}, getSchemaType(organizertype), {
+      name: organizername,
+      url: organizerurl,
+      email: organizeremail,
+      telephone: organizertelephone
+    })
+  } : {};
+  const eventsData = Object.assign({}, getSchemaContext, getSchemaType('Event'), {
+    name: story.headline,
+    description: story.subheadline || '',
+    url: story.url,
+    image: image,
+    startDate: startdate,
+    endDate: enddate,
+    eventAttendanceMode: eventMode[mode],
+    isAccessibleForFree: paidevent,
+    eventStatus: 'https://schema.org/EventScheduled',
+    location: location
+  }, organizerData);
   return eventsData;
 }
 
@@ -998,7 +1030,8 @@ 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"], []);
-
+  const enableEventsData = get__default["default"](structuredData, ["enableEventsData"], null);
+  const enableStorySeoEventsData = get__default["default"](story, ["enableSeoEventsData"], null);
   let articleData = {};
 
   if (!isStructuredDataEmpty) {
@@ -1024,8 +1057,8 @@ function StructuredDataTags({ structuredData = {} }, config, pageType, response
     tags.push(ldJson("BreadcrumbList", generateBreadcrumbListData(pageType, publisherConfig, response.data)));
   }
 
-  if (structuredData.enableEventsData && pageType === "story-page" && story.enableSeoEventsData) {
-    tags.push(ldJson("Event", generateEventsSchema(story)));
+  if (enableEventsData && pageType === "story-page" && enableStorySeoEventsData) {
+    tags.push(ldJson("Event", generateEventsSchema(story, publisherConfig)));
   }
 
   if (!isStructuredDataEmpty && pageType === "story-page") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/seo",
-  "version": "1.48.2-support-event-schema.5",
+  "version": "1.49.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

@@ -399,16 +399,56 @@ function generateBreadcrumbListData(pageType = "", publisherConfig = {}, data =
   return getSchemaBreadcrumbList(breadcrumbsDataList);
 }
 
-function generateEventsSchema(story = {}) {
-  const {location = "", startdate = "", enddate = "", mode = "offline", paidevent = false, organizertype = "Organization", organizername = "", organizeremail="", organizerurl="", organizertelephone=""} = story.eventDetails || {};
+function generateEventsSchema (story = {}, publisherConfig = {}) {
+  const {
+    location = '',
+    startdate = '',
+    enddate = '',
+    mode = 'offline',
+    paidevent = false,
+    organizertype = 'Organization',
+    organizername = '',
+    organizeremail = '',
+    organizerurl = '',
+    organizertelephone = ''
+  } = story.eventDetails || {}
   const eventMode = {
-    online: "https://schema.org/OnlineEventAttendanceMode",
-    offline: "https://schema.org/OfflineEventAttendanceMode",
-    mix: "https://schema.org/MixedEventAttendanceMode"
+    online: 'https://schema.org/OnlineEventAttendanceMode',
+    offline: 'https://schema.org/OfflineEventAttendanceMode',
+    mix: 'https://schema.org/MixedEventAttendanceMode'
   }
-  const organizerData = organizername ? {Organizer : Object.assign({}, getSchemaType(organizertype), {name: organizername,url: organizerurl, email: organizeremail,telephone: organizertelephone})} : {}
-  const eventsData = Object.assign({}, getSchemaContext, getSchemaType("Event"), { name: story.headline, description: story.subheadline || "", url: story.url, image: story["hero-image-s3-key"] || "", startDate: startdate, endDate: enddate, eventAttendanceMode: eventMode[mode], isAccessibleForFree: paidevent, eventStatus: "https://schema.org/EventScheduled", location: location}, organizerData);
-  return eventsData;
+  const imageWidth = 1200
+  const imageHeight = 675
+  const image = imageUrl(publisherConfig, story['hero-image-s3-key'], imageWidth, imageHeight)
+  const organizerData = organizername
+    ? {
+        Organizer: Object.assign({}, getSchemaType(organizertype), {
+          name: organizername,
+          url: organizerurl,
+          email: organizeremail,
+          telephone: organizertelephone
+        })
+      }
+    : {}
+  const eventsData = Object.assign(
+    {},
+    getSchemaContext,
+    getSchemaType('Event'),
+    {
+      name: story.headline,
+      description: story.subheadline || '',
+      url: story.url,
+      image: image,
+      startDate: startdate,
+      endDate: enddate,
+      eventAttendanceMode: eventMode[mode],
+      isAccessibleForFree: paidevent,
+      eventStatus: 'https://schema.org/EventScheduled',
+      location: location
+    },
+    organizerData
+  )
+  return eventsData
 }
 
 /**
@@ -484,7 +524,8 @@ 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"], []);
-
+  const enableEventsData = get(structuredData, ["enableEventsData"], null);
+  const enableStorySeoEventsData = get(story, ["enableSeoEventsData"], null);
   let articleData = {};
 
   if (!isStructuredDataEmpty) {
@@ -510,8 +551,8 @@ export function StructuredDataTags({ structuredData = {} }, config, pageType, re
     tags.push(ldJson("BreadcrumbList", generateBreadcrumbListData(pageType, publisherConfig, response.data)));
   }
 
-  if(structuredData.enableEventsData && pageType === "story-page" && story.enableSeoEventsData){
-    tags.push(ldJson("Event", generateEventsSchema(story)));
+  if(enableEventsData && pageType === "story-page" && enableStorySeoEventsData){
+    tags.push(ldJson("Event", generateEventsSchema(story, publisherConfig)));
   }
 
   if (!isStructuredDataEmpty && pageType === "story-page") {