@thg-altitude/schemaorg 1.0.32 → 1.0.34

package/.nvmrc

@@ -1 +1 @@
-18.15.0
+22.15.0

package/index.js

@@ -6,8 +6,9 @@ import Organization from './src/components/Organization.astro'
 import ProductCollection from './src/components/ProductCollection.astro'
 import WebSite from './src/components/WebSite.astro'
 import EnhancedProductList from './src/components/EnhancedProductList.astro'
+import Recipe from './src/components/Recipe.astro'
 
-export { 
+export {
     Product,
     EnhancedProduct,
     Breadcrumb,
@@ -15,5 +16,6 @@ export {
     Organization,
     ProductCollection,
     WebSite,
-    EnhancedProductList
+    EnhancedProductList,
+    Recipe
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thg-altitude/schemaorg",
-  "version": "1.0.32",
+  "version": "1.0.34",
   "description": "",
   "main": "index.js",
   "scripts": {

package/src/components/EnhancedProduct.astro

@@ -1,4 +1,6 @@
 ---
+import { mapProductSchemaDataEnhanced } from '../utils/productSchema.js';
+
 const {
   image,
   sku,
@@ -23,8 +25,32 @@ const {
   streetAddress,
   addressLocality,
   postalCode,
+  suggestedAge,
+  suggestedGender,
+  beauty_targetAge,
+  gender,
 } = Astro.props;
 
+// Use the enhanced mapping function to extract data from the full product data
+const mappedData = mapProductSchemaDataEnhanced(Astro.props);
+
+// Extract suggestedGender and suggestedAge using the comprehensive mapping function
+let extractedSuggestedGender = suggestedGender || mappedData.suggestedGender;
+let extractedSuggestedAge = suggestedAge || mappedData.suggestedAge;
+
+// Fallback to the original simple extraction if the mapping didn't find anything
+if (!extractedSuggestedGender && Astro.props.productContent?.propertyNameToValueMap?.gender) {
+  extractedSuggestedGender = Array.isArray(Astro.props.productContent.propertyNameToValueMap.gender)
+    ? Astro.props.productContent.propertyNameToValueMap.gender[0]
+    : Astro.props.productContent.propertyNameToValueMap.gender;
+}
+
+if (!extractedSuggestedAge && Astro.props.productContent?.propertyNameToValueMap?.beauty_targetAge) {
+  extractedSuggestedAge = Array.isArray(Astro.props.productContent.propertyNameToValueMap.beauty_targetAge)
+    ? Astro.props.productContent.propertyNameToValueMap.beauty_targetAge[0]
+    : Astro.props.productContent.propertyNameToValueMap.beauty_targetAge;
+}
+
 let url;
 let schema = null;
 let schemaError = false;
@@ -63,49 +89,258 @@ try {
 }
 
 function generateProductSchema() {
+  const hasMultipleVariants = variants && variants.length > 1;
+  let variantsArray = [];
+
   if (variants && variants.length > 0 && currency) {
-    offersArray = variants
-      .filter((variant) => variant?.sku && variant?.price?.price?.amount)
-      .map((variant) => ({
-        "@type": "Offer",
-        sku: variant.sku.toString(),
-        url:
-          variants.length > 1
-            ? `${pageUrl}?variation=${variant?.sku}`
-            : pageUrl,
-        price: variant.price.price.amount,
-        priceCurrency: currency,
-        itemCondition: "http://schema.org/NewCondition",
-        availability: variant?.inStock
-          ? "https://schema.org/InStock"
-          : "https://schema.org/OutOfStock",
-        ...(variant?.barcode && { gtin13: variant.barcode.toString() }),
-        ...(brand && {
-          seller: {
-            "@type": "Organization",
-            name: brand,
-          },
-        }),
-        priceSpecification: [
-          {
-            "@type": "UnitPriceSpecification",
-            priceCurrency: currency,
-            price: variant.price.price.amount,
-            valueAddedTaxIncluded: true,
-          },
-          ...(variant?.price?.rrp?.amount
-            ? [
+    if (hasMultipleVariants) {
+      // Create individual Product objects for each variant
+      variantsArray = variants
+        .filter((variant) => variant?.sku && variant?.price?.price?.amount)
+        .map((variant) => {
+          // Build variant name with attributes from choices in logical order
+          let variantName = name;
+          const attributes = [];
+          
+          // Extract properties in preferred order: Amount + Weight + Flavor + Size + Color + Material
+          if (variant.choices && variant.choices.length > 0) {
+            // Amount (only if explicitly marked as Amount, not weight-related)
+            const amountChoice = variant.choices.find(c =>
+              c.optionKey === 'Amount' &&
+              c.title &&
+              !c.title.includes('kg') &&
+              !c.title.includes('g') &&
+              !c.title.includes('lb')
+            );
+            if (amountChoice && amountChoice.title) attributes.push(amountChoice.title);
+            
+            // Weight (from Weight optionKey OR size containing weight units)
+            const weightChoice = variant.choices.find(c =>
+              c.optionKey === 'Weight' ||
+              (c.optionKey === 'Size' && c.title && (c.title.includes('kg') || c.title.includes('g') || c.title.includes('lb'))) ||
+              (c.title && (c.title.includes('kg') || c.title.includes('lb') || /\d+\s*g\b/.test(c.title)))
+            );
+            if (weightChoice && weightChoice.title) attributes.push(weightChoice.title);
+            
+            // Flavor
+            const flavorChoice = variant.choices.find(c =>
+              c.optionKey === 'Flavour' || c.optionKey === 'Flavor' || c.optionKey === 'Taste'
+            );
+            if (flavorChoice && flavorChoice.title) attributes.push(flavorChoice.title);
+            
+            // Size (excluding weight-related sizes and already processed weight)
+            const sizeChoice = variant.choices.find(c =>
+              c.optionKey === 'Size' &&
+              c.title &&
+              !c.title.includes('kg') &&
+              !c.title.includes('g') &&
+              !c.title.includes('lb') &&
+              c !== weightChoice  // Don't duplicate if already used as weight
+            );
+            if (sizeChoice && sizeChoice.title) attributes.push(sizeChoice.title);
+            
+            // Color
+            const colorChoice = variant.choices.find(c => c.optionKey === 'Color' || c.optionKey === 'Colour' || c.colour);
+            if (colorChoice) {
+              if (colorChoice.title) attributes.push(colorChoice.title);
+              else if (colorChoice.colour) attributes.push(colorChoice.colour);
+            }
+            
+            // Material
+            const materialChoice = variant.choices.find(c => c.optionKey === 'Material');
+            if (materialChoice && materialChoice.title) attributes.push(materialChoice.title);
+          }
+          
+          if (attributes.length > 0) {
+            variantName = `${name} ${attributes.join(' ')}`;
+          }
+          
+          return {
+            "@type": "Product",
+            sku: variant.sku.toString(),
+            name: variantName,
+            ...(description && { description }),
+            ...(imageUrl && { image: imageUrl }),
+            // Extract variant-specific properties from choices using correct schema.org properties
+            ...(variant.choices && variant.choices.some(c => c.optionKey === 'Weight' || (c.title && (c.title.includes('kg') || c.title.includes('lb') || /\d+\s*g\b/.test(c.title)))) && {
+              weight: variant.choices.find(c => c.optionKey === 'Weight' || (c.title && (c.title.includes('kg') || c.title.includes('lb') || /\d+\s*g\b/.test(c.title))))?.title
+            }),
+            ...(variant.choices && variant.choices.some(c => c.optionKey === 'Size' && c.title && !c.title.includes('kg') && !c.title.includes('g') && !c.title.includes('lb')) && {
+              size: variant.choices.find(c => c.optionKey === 'Size' && c.title && !c.title.includes('kg') && !c.title.includes('g') && !c.title.includes('lb'))?.title
+            }),
+            ...(variant.choices && variant.choices.some(c => c.optionKey === 'Color' || c.optionKey === 'Colour' || c.colour) && {
+              color: variant.choices.find(c => c.optionKey === 'Color' || c.optionKey === 'Colour')?.title ||
+                     variant.choices.find(c => c.optionKey === 'Color' || c.optionKey === 'Colour' || c.colour)?.colour
+            }),
+            ...(variant.choices && variant.choices.some(c => c.optionKey === 'Material') && {
+              material: variant.choices.find(c => c.optionKey === 'Material')?.title
+            }),
+            // Handle non-standard properties (amount, flavour) as additionalProperty
+            ...(() => {
+              const additionalProperties = [];
+              
+              // Amount
+              const amountChoice = variant.choices?.find(c => c.optionKey === 'Amount');
+              if (amountChoice?.title) {
+                additionalProperties.push({
+                  "@type": "PropertyValue",
+                  "name": "amount",
+                  "value": amountChoice.title
+                });
+              }
+              
+              // Flavour (as additionalProperty since it doesn't exist in schema.org)
+              const flavourChoice = variant.choices?.find(c => c.optionKey === 'Flavour' || c.optionKey === 'Flavor' || c.optionKey === 'Taste');
+              if (flavourChoice?.title) {
+                additionalProperties.push({
+                  "@type": "PropertyValue",
+                  "name": "flavour",
+                  "value": flavourChoice.title
+                });
+              }
+              
+              return additionalProperties.length > 0 ? { additionalProperty: additionalProperties } : {};
+            })(),
+            ...(variant?.barcode && { gtin13: variant.barcode.toString() }),
+            offers: {
+              "@type": "Offer",
+              url: `${pageUrl}?variation=${variant?.sku}`,
+              price: variant.price.price.amount,
+              priceCurrency: currency,
+              itemCondition: "https://schema.org/NewCondition",
+              availability: variant?.inStock
+                ? "https://schema.org/InStock"
+                : "https://schema.org/OutOfStock",
+              ...(brand && {
+                seller: {
+                  "@type": "Organization",
+                  name: brand,
+                },
+              }),
+              priceSpecification: [
                 {
                   "@type": "UnitPriceSpecification",
                   priceCurrency: currency,
-                  price: variant.price.rrp.amount,
+                  price: variant.price.price.amount,
                   valueAddedTaxIncluded: true,
-                  priceType: "https://schema.org/ListPrice",
                 },
-              ]
-            : []),
-        ],
-      }));
+                ...(variant?.price?.rrp?.amount
+                  ? [
+                      {
+                        "@type": "UnitPriceSpecification",
+                        priceCurrency: currency,
+                        price: variant.price.rrp.amount,
+                        valueAddedTaxIncluded: true,
+                        priceType: "https://schema.org/StrikethroughPrice",
+                      },
+                    ]
+                  : []),
+              ],
+            }
+          };
+        });
+    } else {
+      // Single variant - create offers array as before
+      offersArray = variants
+        .filter((variant) => variant?.sku && variant?.price?.price?.amount)
+        .map((variant) => {
+          // Build variant name with attributes from choices in logical order
+          let variantName = name;
+          const attributes = [];
+          
+          // Extract properties in preferred order: Amount + Weight + Flavor + Size + Color + Material
+          if (variant.choices && variant.choices.length > 0) {
+            // Amount (only if explicitly marked as Amount, not weight-related)
+            const amountChoice = variant.choices.find(c =>
+              c.optionKey === 'Amount' &&
+              c.title &&
+              !c.title.includes('kg') &&
+              !c.title.includes('g') &&
+              !c.title.includes('lb')
+            );
+            if (amountChoice && amountChoice.title) attributes.push(amountChoice.title);
+            
+            // Weight (from Weight optionKey OR size containing weight units)
+            const weightChoice = variant.choices.find(c =>
+              c.optionKey === 'Weight' ||
+              (c.optionKey === 'Size' && c.title && (c.title.includes('kg') || c.title.includes('g') || c.title.includes('lb'))) ||
+              (c.title && (c.title.includes('kg') || c.title.includes('lb') || /\d+\s*g\b/.test(c.title)))
+            );
+            if (weightChoice && weightChoice.title) attributes.push(weightChoice.title);
+            
+            // Flavor
+            const flavorChoice = variant.choices.find(c =>
+              c.optionKey === 'Flavour' || c.optionKey === 'Flavor' || c.optionKey === 'Taste'
+            );
+            if (flavorChoice && flavorChoice.title) attributes.push(flavorChoice.title);
+            
+            // Size (excluding weight-related sizes and already processed weight)
+            const sizeChoice = variant.choices.find(c =>
+              c.optionKey === 'Size' &&
+              c.title &&
+              !c.title.includes('kg') &&
+              !c.title.includes('g') &&
+              !c.title.includes('lb') &&
+              c !== weightChoice  // Don't duplicate if already used as weight
+            );
+            if (sizeChoice && sizeChoice.title) attributes.push(sizeChoice.title);
+            
+            // Color
+            const colorChoice = variant.choices.find(c => c.optionKey === 'Color' || c.optionKey === 'Colour' || c.colour);
+            if (colorChoice) {
+              if (colorChoice.title) attributes.push(colorChoice.title);
+              else if (colorChoice.colour) attributes.push(colorChoice.colour);
+            }
+            
+            // Material
+            const materialChoice = variant.choices.find(c => c.optionKey === 'Material');
+            if (materialChoice && materialChoice.title) attributes.push(materialChoice.title);
+          }
+          
+          if (attributes.length > 0) {
+            variantName = `${name} ${attributes.join(' ')}`;
+          }
+          
+          return {
+            "@type": "Offer",
+            name: variantName,
+            sku: variant.sku.toString(),
+            url: pageUrl,
+            price: variant.price.price.amount,
+            priceCurrency: currency,
+            itemCondition: "https://schema.org/NewCondition",
+            availability: variant?.inStock
+              ? "https://schema.org/InStock"
+              : "https://schema.org/OutOfStock",
+            ...(variant?.barcode && { gtin13: variant.barcode.toString() }),
+            ...(brand && {
+              seller: {
+                "@type": "Organization",
+                name: brand,
+              },
+            }),
+            priceSpecification: [
+              {
+                "@type": "UnitPriceSpecification",
+                priceCurrency: currency,
+                price: variant.price.price.amount,
+                valueAddedTaxIncluded: true,
+              },
+              ...(variant?.price?.rrp?.amount
+                ? [
+                    {
+                      "@type": "UnitPriceSpecification",
+                      priceCurrency: currency,
+                      price: variant.price.rrp.amount,
+                      valueAddedTaxIncluded: true,
+                      priceType: "https://schema.org/StrikethroughPrice",
+                    },
+                  ]
+                : []),
+            ],
+          };
+        });
+    }
   }
 
   const category =
@@ -116,38 +351,199 @@ function generateProductSchema() {
   const reviewsArray = generateReviewsSchema();
 
   if (name && sku) {
-    const productSchema = {
-      "@type": "Product",
-      "@id": pageUrl,
-      url: pageUrl,
-      sku: sku.toString(),
-      name: name,
-      ...(gtin13 && { gtin13: gtin13.toString() }),
-      ...(description && { description }),
-      ...(imageUrl && { image: imageUrl }),
-      ...(brand && {
-        brand: {
-          "@type": "Brand",
-          name: brand,
-        },
-      }),
-      ...(reviewsCount > 0 &&
-        reviewsAverage && {
-          aggregateRating: {
-            "@type": "AggregateRating",
-            ratingValue: reviewsAverage,
-            reviewCount: reviewsCount,
-            bestRating: 5,
-            worstRating: 1,
+    const hasMultipleVariants = variants && variants.length > 1;
+    
+    if (hasMultipleVariants) {
+      // Determine what properties vary between variants
+      const variesBy = [];
+      
+      // Check what attributes exist across variants based on choices using correct schema.org properties
+      if (variants.some(v => v.choices && v.choices.some(c => c.optionKey === 'Weight' || (c.title && (c.title.includes('kg') || c.title.includes('lb') || /\d+\s*g\b/.test(c.title)))))) {
+        variesBy.push("https://schema.org/weight");
+      }
+      if (variants.some(v => v.choices && v.choices.some(c => c.optionKey === 'Size' && c.title && !c.title.includes('kg') && !c.title.includes('g') && !c.title.includes('lb')))) {
+        variesBy.push("https://schema.org/size");
+      }
+      if (variants.some(v => v.choices && v.choices.some(c => c.optionKey === 'Color' || c.optionKey === 'Colour' || c.colour))) {
+        variesBy.push("https://schema.org/color");
+      }
+      if (variants.some(v => v.choices && v.choices.some(c => c.optionKey === 'Material'))) {
+        variesBy.push("https://schema.org/material");
+      }
+      // For non-standard properties like amount and flavour, use additionalProperty
+      if (variants.some(v => v.choices && v.choices.some(c => c.optionKey === 'Amount'))) {
+        variesBy.push("https://schema.org/additionalProperty");
+      }
+      if (variants.some(v => v.choices && v.choices.some(c => c.optionKey === 'Flavour' || c.optionKey === 'Flavor' || c.optionKey === 'Taste'))) {
+        variesBy.push("https://schema.org/additionalProperty");
+      }
+
+      const productGroupSchema = {
+        "@type": "ProductGroup",
+        "@id": pageUrl,
+        url: pageUrl,
+        name: name,
+        productGroupID: sku.toString(),
+        ...(gtin13 && { gtin13: gtin13.toString() }),
+        ...(description && { description }),
+        ...(imageUrl && { image: imageUrl }),
+        ...(brand && {
+          brand: {
+            "@type": "Brand",
+            name: brand,
           },
         }),
-      ...(reviewsArray && reviewsArray.length > 0 && { review: reviewsArray }),
-      ...(category && { category }),
-      ...(keywords && { keywords }),
-      ...(offersArray.length > 0 && { offers: offersArray }),
-    };
+        ...(variesBy.length > 0 && { variesBy }),
+        hasVariant: variantsArray,
+        ...(reviewsCount > 0 &&
+          reviewsAverage && {
+            aggregateRating: {
+              "@type": "AggregateRating",
+              ratingValue: reviewsAverage,
+              reviewCount: reviewsCount,
+              bestRating: 5,
+              worstRating: 1,
+            },
+          }),
+        ...(reviewsArray && reviewsArray.length > 0 && { review: reviewsArray }),
+        ...(category && { category }),
+        ...(keywords && { keywords }),
+        // Handle custom properties as additionalProperty
+        ...(() => {
+          const additionalProperties = [];
+          if (extractedSuggestedGender) {
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "suggestedGender",
+              "value": extractedSuggestedGender
+            });
+          }
+          if (extractedSuggestedAge) {
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "suggestedAge",
+              "value": extractedSuggestedAge
+            });
+          }
+          if (beauty_targetAge) {
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "targetAge",
+              "value": beauty_targetAge
+            });
+          }
+          if (gender) {
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "GenderType",
+              "value": gender
+            });
+          }
+          
+          // Add flavour as additionalProperty for ProductGroup level
+          const flavourValues = variants?.map(v =>
+            v.choices?.find(c => c.optionKey === 'Flavour' || c.optionKey === 'Flavor' || c.optionKey === 'Taste')?.title
+          ).filter(Boolean);
+          
+          if (flavourValues && flavourValues.length > 0) {
+            // If multiple unique flavours, list them all; if single flavour, just that one
+            const uniqueFlavours = [...new Set(flavourValues)];
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "flavour",
+              "value": uniqueFlavours.length === 1 ? uniqueFlavours[0] : uniqueFlavours.join(', ')
+            });
+          }
+          
+          return additionalProperties.length > 0 ? { additionalProperty: additionalProperties } : {};
+        })(),
+      };
 
-    graphArray.push(productSchema);
+      graphArray.push(productGroupSchema);
+    } else {
+      // Single product schema as before
+      const productSchema = {
+        "@type": "Product",
+        "@id": pageUrl,
+        url: pageUrl,
+        sku: sku.toString(),
+        name: name,
+        ...(gtin13 && { gtin13: gtin13.toString() }),
+        ...(description && { description }),
+        ...(imageUrl && { image: imageUrl }),
+        ...(brand && {
+          brand: {
+            "@type": "Brand",
+            name: brand,
+          },
+        }),
+        ...(reviewsCount > 0 &&
+          reviewsAverage && {
+            aggregateRating: {
+              "@type": "AggregateRating",
+              ratingValue: reviewsAverage,
+              reviewCount: reviewsCount,
+              bestRating: 5,
+              worstRating: 1,
+            },
+          }),
+        ...(reviewsArray && reviewsArray.length > 0 && { review: reviewsArray }),
+        ...(category && { category }),
+        ...(keywords && { keywords }),
+        // Handle custom properties as additionalProperty
+        ...(() => {
+          const additionalProperties = [];
+          if (extractedSuggestedGender) {
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "suggestedGender",
+              "value": extractedSuggestedGender
+            });
+          }
+          if (extractedSuggestedAge) {
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "suggestedAge",
+              "value": extractedSuggestedAge
+            });
+          }
+          if (beauty_targetAge) {
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "beauty_targetAge",
+              "value": beauty_targetAge
+            });
+          }
+          if (gender) {
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "gender",
+              "value": gender
+            });
+          }
+          
+          // Add flavour as additionalProperty for single product
+          const flavourValues = variants?.map(v =>
+            v.choices?.find(c => c.optionKey === 'Flavour' || c.optionKey === 'Flavor' || c.optionKey === 'Taste')?.title
+          ).filter(Boolean);
+          
+          if (flavourValues && flavourValues.length > 0) {
+            // If multiple unique flavours, list them all; if single flavour, just that one
+            const uniqueFlavours = [...new Set(flavourValues)];
+            additionalProperties.push({
+              "@type": "PropertyValue",
+              "name": "flavour",
+              "value": uniqueFlavours.length === 1 ? uniqueFlavours[0] : uniqueFlavours.join(', ')
+            });
+          }
+          
+          return additionalProperties.length > 0 ? { additionalProperty: additionalProperties } : {};
+        })(),
+        ...(offersArray.length > 0 && { offers: offersArray }),
+      };
+
+      graphArray.push(productSchema);
+    }
   }
 }
 
@@ -281,6 +677,34 @@ function generateReviewsSchema() {
 
 {
   schema && !schemaError && (
-    <script type="application/ld+json" set:html={JSON.stringify(schema)} />
+    <script type="application/ld+json" set:html={(() => {
+      // Clean the schema object by removing undefined, null, and empty values
+      function cleanObject(obj) {
+        if (obj === null || obj === undefined || obj === '') {
+          return undefined;
+        }
+        
+        if (Array.isArray(obj)) {
+          const cleaned = obj.map(cleanObject).filter(item => item !== undefined);
+          return cleaned.length > 0 ? cleaned : undefined;
+        }
+        
+        if (typeof obj === 'object' && obj !== null) {
+          const cleaned = {};
+          for (const [key, value] of Object.entries(obj)) {
+            const cleanedValue = cleanObject(value);
+            if (cleanedValue !== undefined) {
+              cleaned[key] = cleanedValue;
+            }
+          }
+          return Object.keys(cleaned).length > 0 ? cleaned : undefined;
+        }
+        
+        return obj;
+      }
+      
+      const cleanedSchema = cleanObject(schema);
+      return cleanedSchema ? JSON.stringify(cleanedSchema, null, 2) : '{}';
+    })()} />
   )
 }