[codex] Capture VTEX newsletter opt-in

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hellotext/vtex-checkout",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Hellotext SDK for VTEX Checkout",
   "unpkg": "dist/funnel.js",
   "author": "Hellotext",

src/__tests__/confirmation.test.js

@@ -106,8 +106,7 @@ describe("confirmation.initialize", () => {
       },
       object_parameters: {
         reference: "order-group-123",
-        amount: 109995000,
-        currency: "COP",
+        source: "vtex",
         delivery: "deliver",
         items: [
           expect.objectContaining({
@@ -122,6 +121,44 @@ describe("confirmation.initialize", () => {
     });
   });
 
+  it("identifies newsletter opt-in from the current order form", () => {
+    const orderForm = createOrderForm();
+
+    orderForm.clientPreferencesData = {
+      optinNewsLetter: true,
+    };
+
+    getOrderFormMock = jest.fn(() => ({
+      done: (callback) => callback(orderForm),
+    }));
+    global.window.vtexjs.checkout.getOrderForm = getOrderFormMock;
+
+    confirmation.initialize("business-123");
+
+    const expectedUser = {
+      id: "test.user@example.com",
+      email: "test.user@example.com",
+      first_name: "Test",
+      last_name: "User",
+      phone: "+15555550123",
+      document: "TEST-DOC-12345",
+      source: "vtex",
+      subscription_state: true,
+    };
+
+    expect(Hellotext.identify).toHaveBeenCalledWith(
+      "test.user@example.com",
+      expectedUser,
+    );
+    expect(Hellotext.track).toHaveBeenCalledWith("order.placed", {
+      user_parameters: expectedUser,
+      object_parameters: expect.objectContaining({
+        reference: "order-group-123",
+        source: "vtex",
+      }),
+    });
+  });
+
   it("only initializes Hellotext when VTEX checkout is unavailable", () => {
     delete global.window.vtexjs;
     delete global.vtexjs;

src/__tests__/funnel.test.js

@@ -132,8 +132,7 @@ describe("funnel.initialize", () => {
       },
       object_parameters: {
         reference: "order-group-123",
-        amount: 109995000,
-        currency: "COP",
+        source: "vtex",
         delivery: "deliver",
         items: [
           expect.objectContaining({
@@ -174,8 +173,7 @@ describe("funnel.initialize", () => {
       },
       object_parameters: {
         reference: "order-group-123",
-        amount: 109995000,
-        currency: "COP",
+        source: "vtex",
         delivery: "deliver",
         items: [
           expect.objectContaining({
@@ -218,6 +216,33 @@ describe("funnel.initialize", () => {
     expect(Hellotext.track).not.toHaveBeenCalled();
   });
 
+  it("identifies newsletter opt-in changes when VTEX emits an order update event", async () => {
+    const updatedOrderForm = createOrderForm();
+
+    updatedOrderForm.clientPreferencesData = {
+      optinNewsLetter: true,
+    };
+
+    funnel.initialize("business-123");
+    await flushAsyncWork();
+
+    Hellotext.identify.mockClear();
+    Hellotext.track.mockClear();
+    orderFormUpdatedHandler({}, updatedOrderForm);
+
+    expect(Hellotext.identify).toHaveBeenCalledWith("test.user@example.com", {
+      id: "test.user@example.com",
+      email: "test.user@example.com",
+      first_name: "Test",
+      last_name: "User",
+      phone: "+15555550123",
+      document: "TEST-DOC-12345",
+      source: "vtex",
+      subscription_state: true,
+    });
+    expect(Hellotext.track).not.toHaveBeenCalled();
+  });
+
   it("tracks checkout started once per order form id", async () => {
     const updatedOrderForm = createOrderForm();
 
@@ -255,8 +280,7 @@ describe("funnel.initialize", () => {
       },
       object_parameters: {
         reference: "order-group-456",
-        amount: 109995000,
-        currency: "COP",
+        source: "vtex",
         delivery: "deliver",
         items: [
           expect.objectContaining({

src/__tests__/utils.test.js

@@ -61,6 +61,32 @@ describe("extractUserData", () => {
       source: "vtex",
     });
   });
+
+  it("maps VTEX newsletter opt-in into a Hellotext subscribe signal", () => {
+    const orderForm = createOrderForm();
+
+    orderForm.clientPreferencesData = {
+      optinNewsLetter: true,
+    };
+
+    expect(extractUserData(orderForm)).toEqual(
+      expect.objectContaining({
+        subscription_state: true,
+      }),
+    );
+  });
+
+  it("does not send a subscription state when VTEX newsletter opt-in is false", () => {
+    const orderForm = createOrderForm();
+
+    orderForm.clientPreferencesData = {
+      optinNewsLetter: false,
+    };
+
+    expect(extractUserData(orderForm)).not.toHaveProperty(
+      "subscription_state",
+    );
+  });
 });
 
 describe("extractOrderData", () => {
@@ -69,8 +95,7 @@ describe("extractOrderData", () => {
 
     expect(extractOrderData(orderForm)).toEqual({
       reference: "order-group-123",
-      amount: 109995000,
-      currency: "COP",
+      source: "vtex",
       delivery: "deliver",
       items: [
         {

src/utils.js

@@ -1,7 +1,8 @@
 const extractUserData = (orderForm) => {
   const profile = orderForm?.clientProfileData || {};
+  const preferences = orderForm?.clientPreferencesData || {};
 
-  return {
+  const user = {
     id: profile.email,
     email: profile.email,
     first_name: profile.firstName,
@@ -10,6 +11,12 @@ const extractUserData = (orderForm) => {
     document: profile.document,
     source: "vtex",
   };
+
+  if (preferences.optinNewsLetter === true) {
+    user.subscription_state = true;
+  }
+
+  return user;
 };
 
 const extractOrderData = (orderForm) => {
@@ -75,8 +82,7 @@ const extractOrderData = (orderForm) => {
 
   return {
     reference: orderForm.orderGroup || orderForm.orderFormId,
-    amount: orderForm.value || 0,
-    currency: storeData.currencyCode,
+    source: "vtex",
     delivery,
     items,
   };