@thg-altitude/schemaorg 1.0.38 → 1.0.42

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thg-altitude/schemaorg",
-  "version": "1.0.38",
+  "version": "1.0.42",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -11,6 +11,6 @@
   "author": "Phillip Gourley",
   "license": "ISC",
   "peerDependencies": {
-    "astro": "^4.0.8 || ^5.0.0"
+    "astro": "^4.0.8 || ^5.0.0 || ^6.0.0"
   }
 }

package/src/components/EnhancedProduct.astro

@@ -1,5 +1,5 @@
 ---
-import { mapProductSchemaDataEnhanced } from '../utils/productSchema.js';
+import { mapProductSchemaDataEnhanced, buildSubscriptionFromContracts } from '../utils/productSchema.js';
 
 const {
   image,
@@ -30,6 +30,9 @@ const {
   beauty_targetAge,
   gender,
   weight,
+  subscription,       // Optional: explicit subscription pricing data { price, priceCurrency, billingIncrement, unitCode, billingDuration }
+  subscriptionConfig, // Optional: config for auto-detecting from subscriptionContracts on variants
+                      //   { discountPercentage: 21, frequencyUnit: "MONTH", frequencyValue: 1 }
   colorVariantPages,  // Array of {url, sku, color} for sibling color pages
   currentColor,       // The color of the current page (used to filter variants)
   baseProductGroupID, // Optional: explicit base product group ID without color suffix
@@ -354,6 +357,7 @@ function generateProductSchema() {
             ...(variant?.barcode && { gtin13: variant.barcode.toString() }),
             offers: {
               "@type": "Offer",
+              sku: variant.sku.toString(),
               url: `${pageUrl}?variation=${variant?.sku}`,
               price: parseFloat(variant.price.price.amount),
               priceCurrency: currency,
@@ -385,6 +389,26 @@ function generateProductSchema() {
                       },
                     ]
                   : []),
+                ...(() => {
+                  // Subscription pricing: subscriptionContracts + config, or explicit subscription prop
+                  const variantPrice = parseFloat(variant.price.price.amount);
+                  let effectiveSub;
+                  if (variant.subscriptionContracts?.length > 0 && subscriptionConfig) {
+                    effectiveSub = buildSubscriptionFromContracts(variant, subscriptionConfig, variantPrice, currency);
+                  } else if (subscription) {
+                    effectiveSub = { ...subscription };
+                  }
+                  if (!effectiveSub) return [];
+                  return [{
+                    "@type": "UnitPriceSpecification",
+                    priceComponentType: "https://schema.org/Subscription",
+                    ...(effectiveSub.price != null && { price: effectiveSub.price }),
+                    ...(effectiveSub.priceCurrency && { priceCurrency: effectiveSub.priceCurrency }),
+                    ...(effectiveSub.billingIncrement != null && { billingIncrement: effectiveSub.billingIncrement }),
+                    ...(effectiveSub.unitCode && { unitCode: effectiveSub.unitCode }),
+                    ...(effectiveSub.billingDuration != null && { billingDuration: effectiveSub.billingDuration }),
+                  }];
+                })(),
               ],
             }
           };
@@ -488,6 +512,26 @@ function generateProductSchema() {
                     },
                   ]
                 : []),
+              ...(() => {
+                // Subscription pricing: subscriptionContracts + config, or explicit subscription prop
+                const variantPrice = parseFloat(variant.price.price.amount);
+                let effectiveSub;
+                if (variant.subscriptionContracts?.length > 0 && subscriptionConfig) {
+                  effectiveSub = buildSubscriptionFromContracts(variant, subscriptionConfig, variantPrice, currency);
+                } else if (subscription) {
+                  effectiveSub = { ...subscription };
+                }
+                if (!effectiveSub) return [];
+                return [{
+                  "@type": "UnitPriceSpecification",
+                  priceComponentType: "https://schema.org/Subscription",
+                  ...(effectiveSub.price != null && { price: effectiveSub.price }),
+                  ...(effectiveSub.priceCurrency && { priceCurrency: effectiveSub.priceCurrency }),
+                  ...(effectiveSub.billingIncrement != null && { billingIncrement: effectiveSub.billingIncrement }),
+                  ...(effectiveSub.unitCode && { unitCode: effectiveSub.unitCode }),
+                  ...(effectiveSub.billingDuration != null && { billingDuration: effectiveSub.billingDuration }),
+                }];
+              })(),
             ],
           };
         });

package/src/components/Product.astro

@@ -1,9 +1,16 @@
 ---
-import { mapProductSchemaData, stripHtml } from '../utils/productSchema.js';
+import { mapProductSchemaData, buildSubscriptionFromContracts, stripHtml } from '../utils/productSchema.js';
 
 // Use the mapping function to extract data from the full product data
 const mappedData = mapProductSchemaData(Astro.props);
 
+// Subscription data resolution:
+//   1. Explicit subscription prop: { price, priceCurrency, billingIncrement, unitCode, billingDuration }
+//   2. Auto-detect from variant.subscriptionContracts + subscriptionConfig prop
+//      subscriptionConfig: { discountPercentage, frequencyUnit, frequencyValue, billingDuration }
+const subscription = Astro.props.subscription || null;
+const subscriptionConfig = Astro.props.subscriptionConfig;
+
 // Extract suggestedGender and suggestedAge using the comprehensive mapping function
 let suggestedGender = Astro.props.suggestedGender || mappedData.suggestedGender;
 let suggestedAge = Astro.props.suggestedAge || mappedData.suggestedAge;
@@ -245,6 +252,7 @@ if (hasMultipleVariants) {
         
         const offerObj = {
           "@type": "Offer",
+          "sku": variant.sku.toString(),
           "url": `${url}${Astro.props.url || ""}?variation=${variant.sku}`,
           "itemCondition": "https://schema.org/NewCondition",
           "availability": variant.inStock ? "https://schema.org/InStock" : "https://schema.org/OutOfStock"
@@ -252,6 +260,39 @@ if (hasMultipleVariants) {
         
         if (variant?.price?.price?.amount) offerObj.price = parseFloat(variant.price.price.amount);
         if (Astro.props.currency) offerObj.priceCurrency = Astro.props.currency;
+
+        // Add subscription pricing:
+        //   1. subscriptionContracts + subscriptionConfig (subscribe & gain / auto-replenish)
+        //   2. Explicit subscription prop
+        //   3. Box subscription variant (isSubscription + subscriptionTerm/subscriptionFrequency)
+        const variantPrice = variant?.price?.price?.amount ? parseFloat(variant.price.price.amount) : null;
+        let effectiveSub;
+        if (variant.subscriptionContracts?.length > 0 && subscriptionConfig) {
+          effectiveSub = buildSubscriptionFromContracts(variant, subscriptionConfig, variantPrice, Astro.props.currency);
+        } else if (variant.isSubscription) {
+          // Box subscription variant - build from variant's own subscription fields
+          effectiveSub = {
+            price: variantPrice,
+            priceCurrency: Astro.props.currency || null,
+            billingIncrement: variant.subscriptionFrequency ?? 1,
+            unitCode: 'MON',
+            billingDuration: variant.subscriptionTerm ?? null,
+          };
+        } else if (subscription) {
+          effectiveSub = { ...subscription };
+        }
+        if (effectiveSub) {
+          const subscriptionSpec = {
+            "@type": "UnitPriceSpecification",
+            "priceComponentType": "https://schema.org/Subscription"
+          };
+          if (effectiveSub.price != null) subscriptionSpec.price = effectiveSub.price;
+          if (effectiveSub.priceCurrency) subscriptionSpec.priceCurrency = effectiveSub.priceCurrency;
+          if (effectiveSub.billingIncrement != null) subscriptionSpec.billingIncrement = effectiveSub.billingIncrement;
+          if (effectiveSub.unitCode) subscriptionSpec.unitCode = effectiveSub.unitCode;
+          if (effectiveSub.billingDuration != null) subscriptionSpec.billingDuration = effectiveSub.billingDuration;
+          offerObj.priceSpecification = subscriptionSpec;
+        }
         
         variantObj.offers = offerObj;
         variantsArray.push(variantObj);
@@ -358,6 +399,39 @@ if (hasMultipleVariants) {
         
         if (variant?.price?.price?.amount) offerObj.price = parseFloat(variant.price.price.amount);
         if (Astro.props.currency) offerObj.priceCurrency = Astro.props.currency;
+
+        // Add subscription pricing:
+        //   1. subscriptionContracts + subscriptionConfig (subscribe & gain / auto-replenish)
+        //   2. Box subscription variant (isSubscription + subscriptionTerm/subscriptionFrequency)
+        //   3. Explicit subscription prop
+        const variantPrice = variant?.price?.price?.amount ? parseFloat(variant.price.price.amount) : null;
+        let effectiveSub;
+        if (variant.subscriptionContracts?.length > 0 && subscriptionConfig) {
+          effectiveSub = buildSubscriptionFromContracts(variant, subscriptionConfig, variantPrice, Astro.props.currency);
+        } else if (variant.isSubscription) {
+          // Box subscription variant - build from variant's own subscription fields
+          effectiveSub = {
+            price: variantPrice,
+            priceCurrency: Astro.props.currency || null,
+            billingIncrement: variant.subscriptionFrequency ?? 1,
+            unitCode: 'MON',
+            billingDuration: variant.subscriptionTerm ?? null,
+          };
+        } else if (subscription) {
+          effectiveSub = { ...subscription };
+        }
+        if (effectiveSub) {
+          const subscriptionSpec = {
+            "@type": "UnitPriceSpecification",
+            "priceComponentType": "https://schema.org/Subscription"
+          };
+          if (effectiveSub.price != null) subscriptionSpec.price = effectiveSub.price;
+          if (effectiveSub.priceCurrency) subscriptionSpec.priceCurrency = effectiveSub.priceCurrency;
+          if (effectiveSub.billingIncrement != null) subscriptionSpec.billingIncrement = effectiveSub.billingIncrement;
+          if (effectiveSub.unitCode) subscriptionSpec.unitCode = effectiveSub.unitCode;
+          if (effectiveSub.billingDuration != null) subscriptionSpec.billingDuration = effectiveSub.billingDuration;
+          offerObj.priceSpecification = subscriptionSpec;
+        }
         
         offersArray.push(offerObj);
       }
@@ -462,4 +536,4 @@ if (reviewsArray.length > 0) schema.review = reviewsArray;
     return undefined;
   }
   return value;
-})}></script>
+})}></script>

package/src/utils/productSchema.js

@@ -87,6 +87,66 @@ export function mapProductSchemaDataEnhanced(productData) {
   return mapProductSchemaData(productData);
 }
 
+/**
+ * Checks if a variant has subscription contracts and builds subscription data
+ * from the variant's subscriptionContracts array combined with a subscriptionConfig.
+ *
+ * The subscriptionConfig provides the discount/frequency details that aren't
+ * available on the contract objects themselves.
+ *
+ * @param {Object} variant - The variant object with subscriptionContracts and price data
+ * @param {Object} subscriptionConfig - Config with discount/frequency defaults:
+ *   {
+ *     discountPercentage: 21,        // % discount for subscription (applied to RRP when available)
+ *     frequencyUnit: "MONTH",        // MONTH, WEEK, DAY, YEAR
+ *     frequencyValue: 1,             // billing increment (1 = every month)
+ *     billingDuration: null,         // null = ongoing
+ *   }
+ * @param {number} variantPrice - The variant's current/sale price (fallback if no RRP)
+ * @param {string} currency - Currency code (e.g. "GBP")
+ * @returns {Object|null} Mapped subscription data or null
+ */
+export function buildSubscriptionFromContracts(variant, subscriptionConfig, variantPrice, currency) {
+  if (!variant?.subscriptionContracts || variant?.subscriptionContracts?.length === 0) return null;
+  if (!subscriptionConfig) return null;
+
+  const discountPct = subscriptionConfig.discountPercentage ?? 0;
+  
+  // Use RRP as the base price for discount calculation when available
+  // The subscription discount is typically applied to the RRP (full price), not the sale price
+  const rrpPrice = variant?.price?.rrp?.amount ? parseFloat(variant.price.rrp.amount) : null;
+  const basePrice = rrpPrice ?? variantPrice;
+  
+  // Compute discounted price from the base price (RRP or sale price)
+  let subscriptionPrice = null;
+  if (basePrice != null && discountPct > 0) {
+    subscriptionPrice = parseFloat((basePrice * (1 - discountPct / 100)).toFixed(2));
+  }
+
+  // Map frequency unit
+  const frequencyUnit = (subscriptionConfig.frequencyUnit || 'MONTH').toUpperCase();
+  const unitCodeMap = {
+    'MONTH': 'MON',
+    'WEEK': 'WEE',
+    'DAY': 'DAY',
+    'YEAR': 'ANN',
+  };
+  const unitCode = unitCodeMap[frequencyUnit] || frequencyUnit;
+
+  const billingIncrement = subscriptionConfig.frequencyValue ?? 1;
+
+  return {
+    price: subscriptionPrice,
+    priceCurrency: currency || null,
+    billingIncrement,
+    unitCode,
+    billingDuration: subscriptionConfig.billingDuration ?? null,
+    initialDiscountPercentage: discountPct,
+    recurringDiscountPercentage: subscriptionConfig.recurringDiscountPercentage ?? discountPct,
+    contractIds: variant.subscriptionContracts.map(c => c.id),
+  };
+}
+
 /**
  * Simple function to strip HTML tags from text
  */