@decocms/apps-vtex 7.66.1 → 7.66.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decocms/apps-vtex",
-  "version": "7.66.1",
+  "version": "7.66.3",
   "type": "module",
   "description": "Deco commerce app: VTEX integration",
   "repository": {
@@ -51,10 +51,10 @@
     "lint:unused": "knip"
   },
   "dependencies": {
-    "@decocms/blocks": "7.66.1",
-    "@decocms/apps-commerce": "7.66.1",
-    "@decocms/apps-website": "7.66.1",
-    "@decocms/tanstack": "7.66.1"
+    "@decocms/blocks": "7.66.3",
+    "@decocms/apps-commerce": "7.66.3",
+    "@decocms/apps-website": "7.66.3",
+    "@decocms/tanstack": "7.66.3"
   },
   "peerDependencies": {
     "@tanstack/react-query": ">=5.0.0",

package/src/utils/__tests__/transform.test.ts

@@ -649,17 +649,19 @@ describe("toProductVariant", () => {
 		expect(offer.inventoryLevel?.value).toBe(0);
 	});
 
-	it("filters additionalProperty to variant-differentiating names only", () => {
+	it("filters spec additionalProperty to variant-differentiating names only", () => {
 		const product = makeISProduct({ items: [makeISSku()] });
 		const sku = makeISSku();
 		const result = toProductVariant(product, sku, baseOptions);
 
-		const propNames = result.additionalProperty?.map((p) => p.name) ?? [];
+		const specNames = (result.additionalProperty ?? [])
+			.filter((p) => p.valueReference !== "ReferenceID")
+			.map((p) => p.name);
 		// Should only contain Cor, Voltagem, Tamanho (from VARIANT_PROPERTY_NAMES)
-		for (const name of propNames) {
+		for (const name of specNames) {
 			expect(["Cor", "Voltagem", "Tamanho"]).toContain(name);
 		}
-		expect(propNames.length).toBeGreaterThan(0);
+		expect(specNames.length).toBeGreaterThan(0);
 	});
 
 	it("respects custom variantPropertyNames", () => {
@@ -670,8 +672,32 @@ describe("toProductVariant", () => {
 			variantPropertyNames: new Set(["Cor"]),
 		});
 
-		const propNames = result.additionalProperty?.map((p) => p.name) ?? [];
-		expect(propNames).toEqual(["Cor"]);
+		const specNames = (result.additionalProperty ?? [])
+			.filter((p) => p.valueReference !== "ReferenceID")
+			.map((p) => p.name);
+		expect(specNames).toEqual(["Cor"]);
+	});
+
+	// Analytics reads the SKU RefId off additionalProperty for GA4 dimension2
+	// (view_item_list / select_item) and its productImpression / productClick
+	// equivalents. It lives in `referenceId`, not `variations`, so the
+	// variantProps filter used to drop it and blank the dimension.
+	it("keeps the SKU reference ids (RefId) alongside the variant specs", () => {
+		const product = makeISProduct({ items: [makeISSku()] });
+		const sku = { ...makeISSku(), referenceId: [{ Key: "RefId", Value: "010276949803" }] };
+		const result = toProductVariant(product, sku, baseOptions);
+
+		const refId = result.additionalProperty?.find((p) => p.name === "RefId");
+		expect(refId?.value).toBe("010276949803");
+		expect(refId?.valueReference).toBe("ReferenceID");
+	});
+
+	it("omits RefId when the SKU carries no referenceId", () => {
+		const product = makeISProduct({ items: [makeISSku()] });
+		const sku = { ...makeISSku(), referenceId: undefined };
+		const result = toProductVariant(product, sku, baseOptions);
+
+		expect(result.additionalProperty?.some((p) => p.name === "RefId")).toBe(false);
 	});
 
 	it("produces lean offers with availability but no priceSpecification details", () => {
@@ -767,6 +793,31 @@ describe("toProductShelf", () => {
 		);
 		expect(result.isVariantOf?.additionalProperty).toEqual([]);
 	});
+
+	// Analytics reads the product reference off isVariantOf.model for GA4
+	// dimension1 (view_item_list / select_item) and its productImpression /
+	// productClick equivalents. toProductShelf used to drop it, blanking the
+	// dimension on every shelf, PLP and search result.
+	it("carries productReference on isVariantOf.model (analytics dimension1)", () => {
+		const result = toProductShelf(
+			makeProduct({ productReference: "0102769498" }),
+			makeSku(),
+			0,
+			options,
+		);
+		expect(result.isVariantOf?.model).toBe("0102769498");
+	});
+
+	it("keeps the SKU RefId reachable on the complete-variants shelf (dimension2)", () => {
+		const result = toProductShelf(makeProduct(), makeSku(), 0, {
+			...options,
+			shelfCompleteVariants: true,
+		});
+		const variantProps = result.isVariantOf?.hasVariant?.[0]?.additionalProperty ?? [];
+		expect(variantProps).toEqual(
+			expect.arrayContaining([expect.objectContaining({ name: "RefId", value: "REF-SKU1" })]),
+		);
+	});
 });
 
 // ---------------------------------------------------------------------------

package/src/utils/transform.ts

@@ -678,7 +678,7 @@ const SHELF_PROPERTY_NAMES = new Set([
  * - Offers: best seller only (in-stock first, then cheapest), stripped installments (keeps ListPrice, SalePrice, SRP, PIX, best no-interest)
  * - isVariantOf: single in-stock variant at level 0
  * - additionalProperty: filtered to known-used property names
- * - Drops: description, video, isAccessoryOrSparePartFor, alternateName, gtin, releaseDate, model
+ * - Drops: description, video, isAccessoryOrSparePartFor, alternateName, gtin, releaseDate
  */
 export const toProductShelf = <P extends LegacyProductVTEX | ProductVTEX>(
 	product: P,
@@ -687,7 +687,7 @@ export const toProductShelf = <P extends LegacyProductVTEX | ProductVTEX>(
 	options: ProductOptions,
 ): Product => {
 	const { baseUrl, priceCurrency } = options;
-	const { productId, items } = product;
+	const { productId, items, productReference } = product;
 	const { name, itemId: skuId } = sku;
 
 	// Images: cap at 2
@@ -762,6 +762,12 @@ export const toProductShelf = <P extends LegacyProductVTEX | ProductVTEX>(
 						// flags that read isVariantOf.additionalProperty (e.g. ReleaseFlag ->
 						// "Lançamento") still fire on shelf/carousel cards.
 						additionalProperty: groupAdditionalProperty,
+						// The product reference (VTEX `productReference`). Analytics reads it
+						// off `isVariantOf.model` — GA4 `dimension1` on view_item_list /
+						// select_item, and the equivalent on productImpression /
+						// productClick. Dropping it silently blanked that dimension on every
+						// shelf, PLP and search result. One short string per product.
+						model: productReference,
 					} satisfies ProductGroup;
 				})()
 			: undefined;
@@ -828,13 +834,19 @@ export const toProductVariant = <P extends LegacyProductVTEX | ProductVTEX>(
 	const includeImage = options.variantIncludeImage !== false;
 	const includeInventory = options.variantIncludeInventory !== false;
 
-	// additionalProperty: only variant-differentiating specs
+	// additionalProperty: variant-differentiating specs, plus the SKU reference
+	// ids. Analytics reads the SKU's `RefId` off this list — GA4 `dimension2` on
+	// view_item_list / select_item, and the equivalent on productImpression /
+	// productClick. It lives in `referenceId`, not in `variations`, so the
+	// `variantProps` filter dropped it and blanked that dimension on every shelf
+	// card rendered with `shelfCompleteVariants`. One short string per SKU.
 	const specificationsAdditionalProperty = isLegacySku(sku)
 		? toAdditionalPropertiesLegacy(sku)
 		: toAdditionalProperties(sku);
-	const additionalProperty = specificationsAdditionalProperty.filter((prop) =>
-		variantProps.has(prop.name ?? ""),
-	);
+	const additionalProperty = [
+		...specificationsAdditionalProperty.filter((prop) => variantProps.has(prop.name ?? "")),
+		...(toAdditionalPropertyReferenceIds(sku.referenceId ?? []) ?? []),
+	];
 
 	// Offers: best seller, lean (availability + seller; optional inventoryLevel)
 	const offerConverter = isLegacyProduct(product) ? toOfferLegacy : toOffer;