[CSL-2690] Add items to trackRecommendationView (#167)

Constructor-io · Aug 14, 2023 · 9103657 · 9103657
1 parent cfd9297
commit 9103657
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/spec/src/modules/tracker.js b/spec/src/modules/tracker.js
@@ -4829,6 +4829,29 @@ describe('ConstructorIO - Tracker', () => {
       )).to.equal(true);
     });
 
+    it('Should respond with a valid response when required parameters and items are provided', (done) => {
+      const items = [{ item_id: '123', variation_id: '234' }, { item_id: 'abc' }];
+      const { tracker } = new ConstructorIO({
+        apiKey: testApiKey,
+        fetch: fetchSpy,
+      });
+
+      tracker.on('success', (responseParams) => {
+        const requestParams = helpers.extractBodyParamsFromFetch(fetchSpy);
+        // Request
+        expect(fetchSpy).to.have.been.called;
+        expect(requestParams).to.have.property('items').to.deep.equal(items);
+
+        // Response
+        expect(responseParams).to.have.property('method').to.equal('POST');
+        expect(responseParams).to.have.property('message');
+
+        done();
+      });
+
+      expect(tracker.trackRecommendationView({ items, ...requiredParameters }, userParameters)).to.equal(true);
+    });
+
     it('Should respond with a valid response when parameters and user identifier are provided', (done) => {
       const userId = 'bd2d9d1f097614c4b4de';
       const { tracker } = new ConstructorIO({

diff --git a/src/modules/tracker.js b/src/modules/tracker.js
@@ -975,6 +975,7 @@ class Tracker {
    * @param {string} parameters.url - Current page URL
    * @param {string} parameters.podId - Pod identifier
    * @param {number} parameters.numResultsViewed - Number of results viewed
+   * @param {object[]} [parameters.items] - List of Product Item objects
    * @param {number} [parameters.resultCount] - Total number of results
    * @param {number} [parameters.resultPage] - Page number of results
    * @param {string} [parameters.resultId] - Recommendation result identifier (returned in response from Constructor)
@@ -997,6 +998,7 @@ class Tracker {
    * @example
    * constructorio.tracker.trackRecommendationView(
    *     {
+   *         items: [{ itemId: 'KMH876' }, { itemId: 'KMH140' }],
    *         resultCount: 22,
    *         resultPage: 2,
    *         resultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
@@ -1031,6 +1033,7 @@ class Tracker {
         podId = pod_id,
         num_results_viewed,
         numResultsViewed = num_results_viewed,
+        items,
       } = parameters;
 
       if (!helpers.isNil(resultCount)) {
@@ -1063,6 +1066,10 @@ class Tracker {
         bodyParams.num_results_viewed = numResultsViewed;
       }
 
+      if (items && Array.isArray(items)) {
+        bodyParams.items = items.slice(0, 100).map((item) => helpers.toSnakeCaseKeys(item, false));
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });

diff --git a/src/types/tracker.d.ts b/src/types/tracker.d.ts
@@ -125,6 +125,7 @@ declare class Tracker {
       url: string;
       podId: string;
       numResultsViewed: number;
+      items?: ItemTracked[];
       resultCount?: number;
       resultPage?: number;
       resultId?: string;