@akinon/pz-theme 2.0.163-beta.0 → 2.0.163

package/src/utils/__tests__/section-impressions.test.ts

@@ -0,0 +1,68 @@
+import { reportsOwnImpressions } from '../section-impressions';
+import type { Block } from '../../theme-block';
+
+/**
+ * A section reports its products as one list impression unless a block in
+ * it already does (ZERO-5305): one view_item_list per list, never two.
+ */
+
+const block = (
+  type: string,
+  properties: Record<string, unknown> = {},
+  blocks: Block[] = []
+) =>
+  ({
+    id: `${type}-1`,
+    type,
+    label: type,
+    value: '',
+    properties,
+    styles: {},
+    order: 0,
+    hidden: false,
+    blocks
+  } as unknown as Block);
+
+describe('reportsOwnImpressions (ZERO-5305)', () => {
+  it('leaves the listing and favourites grids their own reports, however deep', () => {
+    expect(reportsOwnImpressions([block('product-grid')])).toBe(true);
+    expect(
+      reportsOwnImpressions([
+        block('group', {}, [block('group', {}, [block('favourites-grid')])])
+      ])
+    ).toBe(true);
+  });
+
+  it('leaves a recommendations strip drawing the section’s rows its own report', () => {
+    expect(
+      reportsOwnImpressions([
+        block('product-recommendations', { source: 'section' })
+      ])
+    ).toBe(true);
+    expect(
+      reportsOwnImpressions([
+        block('product-recommendations', {
+          source: { desktop: 'section', mobile: 'collection' }
+        })
+      ])
+    ).toBe(true);
+  });
+
+  it('still reports the section’s rows next to a strip with a source of its own', () => {
+    expect(
+      reportsOwnImpressions([
+        block('product-recommendations', { source: 'recently-viewed' })
+      ])
+    ).toBe(false);
+    expect(reportsOwnImpressions([block('product-recommendations')])).toBe(
+      false
+    );
+  });
+
+  it('reports a plain carousel’s rows itself', () => {
+    expect(reportsOwnImpressions([block('group', {}, [block('image')])])).toBe(
+      false
+    );
+    expect(reportsOwnImpressions(undefined)).toBe(false);
+  });
+});

package/src/utils/iterator-price-shapes.test.ts

@@ -359,6 +359,19 @@ describe('a collection row published in the listing row shape', () => {
       false
     );
   });
+
+  it('numbers each scoped row, for the position a card click reports (ZERO-5305)', () => {
+    const expanded = buildIteratorBlock({
+      iteratorBlock: cardIterator({}, [text('name', { dataBinding: 'item.name' })]),
+      sectionDataSource: source([
+        omnitronRow(7, '2999.00', ''),
+        omnitronRow(8, '1999.00', '')
+      ]),
+      pageContext: null
+    } as never);
+
+    expect(expanded.blocks?.map((clone) => clone.itemScopeIndex)).toEqual([0, 1]);
+  });
 });
 
 describe('a repeat inside a collection row', () => {

package/src/utils/iterator-utils.ts

@@ -1723,7 +1723,8 @@ export const buildIteratorBlock = ({
         ? {
             itemScopeProduct: resolveCollectionRowProduct(
               rawItem as Record<string, unknown>
-            )
+            ),
+            itemScopeIndex: index
           }
         : {})
     };

package/src/utils/section-impressions.ts

@@ -0,0 +1,37 @@
+import type { Block } from '../theme-block';
+
+/**
+ * Whether a block inside a section already reports the section's products
+ * as a list impression of its own (ZERO-5305), so the section must not report
+ * them a second time:
+ *
+ *   - the listing grid and the favourites grid report their own pages;
+ *   - a recommendations strip drawing the SECTION's rows (`source: section`)
+ *     reports them under its title.
+ *
+ * A strip with a source of its own (a collection by id, recently viewed,
+ * favourites) shows other products, so the section's rows still need their
+ * own report. The source is read at every breakpoint: a strip that draws the
+ * section's rows anywhere draws them.
+ */
+
+const OWN_IMPRESSION_GRIDS = new Set(['product-grid', 'favourites-grid']);
+
+const drawsSectionRows = (block: Block): boolean => {
+  const source = (block.properties as Record<string, unknown> | undefined)
+    ?.source;
+  const values =
+    source && typeof source === 'object'
+      ? Object.values(source as Record<string, unknown>)
+      : [source];
+
+  return values.some((value) => value === 'section');
+};
+
+export const reportsOwnImpressions = (blocks: Block[] | undefined): boolean =>
+  (blocks ?? []).some(
+    (block) =>
+      OWN_IMPRESSION_GRIDS.has(block.type) ||
+      (block.type === 'product-recommendations' && drawsSectionRows(block)) ||
+      reportsOwnImpressions(block.blocks)
+  );