Merge branch 'main' into image-roles

Author: maxakuru

CHANGELOG.md

@@ -1,3 +1,18 @@
+# [1.5.0](https://github.com/adobe-rnd/helix-commerce-api/compare/v1.4.1...v1.5.0) (2024-11-05)
+
+
+### Bug Fixes
+
+* date parsing ([cebc0bc](https://github.com/adobe-rnd/helix-commerce-api/commit/cebc0bce7c9655e3b96ab328c9cd2998ac48fa68))
+* fix variants check ([d986afa](https://github.com/adobe-rnd/helix-commerce-api/commit/d986afa5f68775622af148cb3cec3ca110cdf73d))
+* support priceValidUntil in simple products ([3f79d8d](https://github.com/adobe-rnd/helix-commerce-api/commit/3f79d8d8a3cbf7c3dd39bfb19e31138d5eb36f6d))
+* test ([f484693](https://github.com/adobe-rnd/helix-commerce-api/commit/f484693165cab9e9d4ef21fbe29d3f4682ff1fa1))
+
+
+### Features
+
+* add support for ListPrice and priceValidUntil in JSON-LD ([f91bbae](https://github.com/adobe-rnd/helix-commerce-api/commit/f91bbaea681b9d687ac4e0e01b2f8e3aae201b2f))
+
 ## [1.4.1](https://github.com/adobe-rnd/helix-commerce-api/compare/v1.4.0...v1.4.1) (2024-11-05)
 
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "helix-commerce-api",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "private": true,
   "description": "API for markup content and a commerce graphql commerce proxy",
   "main": "src/index.js",

package.json

@@ -11,7 +11,7 @@
  */
 
 import { forceImagesHTTPS } from '../../utils/http.js';
-import { gql } from '../../utils/product.js';
+import { gql, parseSpecialToDate } from '../../utils/product.js';
 
 /**
  * @param {any} productData
@@ -90,6 +90,11 @@ export const adapter = (productData) => {
     } : null,
   };
 
+  const specialToDate = parseSpecialToDate(product);
+  if (specialToDate) {
+    product.specialToDate = specialToDate;
+  }
+
   return product;
 };
 

src/content/queries/cs-product.js

@@ -11,7 +11,7 @@
  */
 
 import { forceImagesHTTPS } from '../../utils/http.js';
-import { gql } from '../../utils/product.js';
+import { gql, parseSpecialToDate } from '../../utils/product.js';
 
 /**
  * @param {any} variants
@@ -49,6 +49,12 @@ export const adapter = (config, variants) => variants.map(({ selections, product
     },
     selections: selections ?? [],
   };
+
+  const specialToDate = parseSpecialToDate(product);
+  if (specialToDate) {
+    variant.specialToDate = specialToDate;
+  }
+
   if (config.attributeOverrides?.variant) {
     Object.entries(config.attributeOverrides.variant).forEach(([key, value]) => {
       variant[key] = product.attributes?.find((attr) => attr.name === value)?.value;

src/content/queries/cs-variants.js

@@ -272,6 +272,10 @@ ${HTMLTemplate.metaProperty('product:price.currency', product.prices.final.curre
    * @returns {string}
    */
   renderProductVariants() {
+    if (!this.variants) {
+      return '';
+    }
+
     return /* html */ `\
   <div class="product-variants">
     ${this.variants.map((v) => /* html */`\
@@ -292,6 +296,10 @@ ${HTMLTemplate.metaProperty('product:price.currency', product.prices.final.curre
    * @returns {string}
    */
   renderProductVariantsAttributes() {
+    if (!this.variants) {
+      return '';
+    }
+
     return /* html */ `\
   <div class="variant-attributes">
   ${this.variants?.map((v) => /* html */`\

src/templates/html/HTMLTemplate.js

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+/* eslint-disable class-methods-use-this */
+
 import { findProductImage, pruneUndefined } from '../../utils/product.js';
 
 export class JSONTemplate {
@@ -80,6 +82,58 @@ export class JSONTemplate {
     };
   }
 
+  renderOffers() {
+    const image = this.product.images?.[0]?.url
+      ?? findProductImage(this.product, this.variants)?.url;
+    const configurableProduct = this.variants?.length > 0;
+    const offers = configurableProduct ? this.variants : [this.product];
+    return {
+      offers: [
+        ...offers.map((v) => {
+          const offerUrl = this.constructProductURL(configurableProduct ? v : undefined);
+          const { prices: variantPrices } = v;
+          const finalPrice = variantPrices?.final?.amount;
+          const regularPrice = variantPrices?.regular?.amount;
+          const offer = {
+            '@type': 'Offer',
+            sku: v.sku,
+            url: offerUrl,
+            image: v.images?.[0]?.url ?? image,
+            availability: v.inStock ? 'InStock' : 'OutOfStock',
+            price: finalPrice,
+            priceCurrency: variantPrices.final?.currency,
+          };
+
+          if (finalPrice < regularPrice) {
+            offer.priceSpecification = this.renderOffersPriceSpecification(v);
+          }
+
+          if (v.gtin) {
+            offer.gtin = v.gtin;
+          }
+
+          if (v.specialToDate) {
+            offer.priceValidUntil = v.specialToDate;
+          }
+
+          return offer;
+        }).filter(Boolean),
+      ],
+    };
+  }
+
+  renderOffersPriceSpecification(variant) {
+    const { prices } = variant;
+    const { regular } = prices;
+    const { amount, currency } = regular;
+    return {
+      '@type': 'UnitPriceSpecification',
+      priceType: 'https://schema.org/ListPrice',
+      price: amount,
+      priceCurrency: currency,
+    };
+  }
+
   render() {
     const {
       sku,
@@ -88,8 +142,6 @@ export class JSONTemplate {
       images,
       reviewCount,
       ratingValue,
-      inStock,
-      prices,
     } = this.product;
 
     const productUrl = this.constructProductURL();
@@ -103,35 +155,7 @@ export class JSONTemplate {
       description: metaDescription,
       image,
       productID: sku,
-      offers: [
-        prices ? ({
-          '@type': 'Offer',
-          sku,
-          url: productUrl,
-          image,
-          availability: inStock ? 'InStock' : 'OutOfStock',
-          price: prices?.final?.amount,
-          priceCurrency: prices?.final?.currency,
-        }) : undefined,
-        ...this.variants.map((v) => {
-          const offerUrl = this.constructProductURL(v);
-          const offer = {
-            '@type': 'Offer',
-            sku: v.sku,
-            url: offerUrl,
-            image: v.images?.[0]?.url ?? image,
-            availability: v.inStock ? 'InStock' : 'OutOfStock',
-            price: v.prices?.final?.amount,
-            priceCurrency: v.prices?.final?.currency,
-          };
-
-          if (v.gtin) {
-            offer.gtin = v.gtin;
-          }
-
-          return offer;
-        }).filter(Boolean),
-      ],
+      ...this.renderOffers(),
       ...(this.renderBrand() ?? {}),
       ...(typeof reviewCount === 'number'
      && typeof ratingValue === 'number'

src/templates/json/JSONTemplate.js

@@ -89,6 +89,7 @@ declare global {
     urlKey?: string;
     externalId?: string;
     variants?: Variant[]; // variants exist on products in helix commerce but not on magento
+    specialToDate?: string;
 
     // not handled currently:
     externalParentId?: string;
@@ -109,6 +110,7 @@ declare global {
     selections: string[];
     attributes: Attribute[];
     externalId: string;
+    specialToDate?: string;
     gtin?: string;
   }
 

src/types.d.ts

@@ -95,3 +95,16 @@ export function matchConfigPath(config, path) {
   console.warn('No match found for path:', path);
   return null;
 }
+
+export function parseSpecialToDate(product) {
+  const specialToDate = product.attributes?.find((attr) => attr.name === 'special_to_date')?.value;
+  if (specialToDate) {
+    const today = new Date();
+    const specialPriceToDate = new Date(specialToDate);
+    if (specialPriceToDate.getTime() >= today.getTime()) {
+      const [date] = specialToDate.split(' ');
+      return date;
+    }
+  }
+  return undefined;
+}