@azzas/azzas-tracker-web 1.0.71 → 1.0.73

package/README.md

@@ -1,130 +1,130 @@
-# azzas-tracker-web
-
-Pacote interno para **Data Tracking** das lojas WEB, centralizando a captura e envio de eventos para diferentes plataformas de mídia (Meta, Dito, DataLayer, etc).  
-
-O objetivo é fornecer uma **camada única e consistente de tracking**, garantindo que todos os eventos sejam tratados, formatados e enviados de forma confiável.  
-
-E, principalmente, centralizar a complexidade e a “inteligência” de tracking **fora dos repositórios das lojas**.
-
----
-
-## Fluxo do Tracking
-
-O pacote segue o seguinte fluxo de eventos:
-
-1. **User Action**  
-   Ações do usuário na loja (ex: adicionar ao carrinho, iniciar checkout, finalizar compra).  
-
-2. **Tracks**  
-   Ponto central que recebe o contexto do evento vindo da ação do usuário e encaminha para o *Formatter*.  
-
-3. **Formatter**  
-   Acessa a constante `EVENTS` e, baseado no contexto do evento, puxa os parâmetros obrigatórios e entrega a biblioteca de parâmetros (`/params`).  
-
-4. **Params Library**  
-   Contém **getters** e **resolvers** que garantem que os dados sejam legítimos e que todos os parâmetros sejam corretamente tratados.  
-
-5. **Adapters**  
-   Módulos responsáveis por enviar os dados formatados para cada destino (Meta, Datalayer, Dito, etc).  
-
-![FLUXOGRAMA](/public/fluxograma-lib-params.png)
-
-## Instalação
-
-
-```bash
-npm install /path/azzas-tracker-web
-```
-
-
-## Exemplos
-
-Listagem dos `EVENTS` e função orquestradora `trackWebEvent`:
-```javascript
-  const EVENTS = {
-    ADD_PERSONAL_INFO: {
-      name: 'add_personal_info',
-      destinations: ['DataLayer'],
-      requiredParams: ['brand', 'pre_filled', 'currency', 'value', 'subtotal'],
-    }, 
-    VIEW_CART: {
-      name: 'add_personal_info',
-      destinations: ['DataLayer', 'Meta', 'Dito'],
-      requiredParams: ['....'],
-    }
-  }
-
-  export async function trackWebEvent(event: EventName, context: EventContext = {}) {
-    try {
-      const parameters = await getParameters(context, event);
-      return await dispatchTrackEvent(event, parameters);
-    } catch (err) {
-      return console.error(`[DT] Error tracking event ${event}:`, err);
-    }
-  }
-```
-
-Uso básico da função no consumidor:
-
-
-```javascript
-  import { trackWebEvent } from 'azzas-tracker-web';
-
-  // DATA TRACKING | add_personal_info at submit (pre-filled always false)
-  // @see notion document for more details:
-  const form: Element = document.querySelector('xxxxxx');
-  if (form) {
-    form.addEventListener('submit', () => {
-      trackWebEvent('ADD_PERSONAL_INFO', { preFilled: false, orderForm: vtexjs.checkout.orderForm });
-    });
-  }
-```
-
-***OBS***: atente-se ao adicionar eventos novos e contribua na documentação do NOTION ou apenas DOCUMENTE em algum lugar! Seu futuro EU será grato 👍
-
-## Teste Local para Ambientes CDN/DENO
-
-Para testar alterações na biblioteca localmente, simulando a forma como ela é carregada por uma CDN (<script src="...">), use o script npm run dev:deno.
-
-Este comando realiza o build mais recente da biblioteca, empacota-o e inicia um servidor HTTP local usando o Deno para servir o arquivo
-
-1. Aqui nesse repositório, rode o script que inicia o servidor local:
-
-```bash
-  npm run dev:deno
-```
-
-O servidor será iniciado e começará a servir o seu arquivo de build no seguinte endereço: http://localhost:4507/.
-
-2. No Projeto Consumidor (DENO/FRONT):
-
-Altere o link do <script> no seu projeto para apontar para o servidor local.
-
-Você deve usar: <script src="http://localhost:4507/dist/mod.global.js"></script>
-
-
-## Boas Práticas
-- Sempre garantir que os `requiredParams` de cada evento estejam preenchidos antes de enviar.
-
-- Procure sempre manter o envio das ações de usuário o mais ***genérico*** possível. Toda a inteligência e complexidade do tratamento dos dados deve ficar centralizada na lib, e não nos repositórios das lojas.
-
-- Usar nomes de eventos semânticos e consistentes (ex: VIEW_CART, ADD_PAYMENT_INFO).
-
-- Manter os contextos enxutos, enviando apenas dados realmente necessários.
-
-- Cada novo evento deve ser registrado em `EVENTS` com seus destinos e parâmetros obrigatórios. Essa constante talvez venha a ser dinâmica dependendo da MARCA utilizada
-
-
-## Contribuição
-
-- Adicionar novos eventos em `EVENTS`.
-
-- Criar adapter correspondente caso seja necessário integrar com nova plataforma. Nesse caso deve-se avaliar qual será o serviço feito, o que será consumido, para onde será enviado.
-
-- Garantir que todos os parâmetros obrigatórios estejam mapeados nos getters/resolvers.
-
-- Executar build (npm run build) antes de testar no checkout/loja.
-
-## Authors
-
-- Lucas Soares
+# azzas-tracker-web
+
+Pacote interno para **Data Tracking** das lojas WEB, centralizando a captura e envio de eventos para diferentes plataformas de mídia (Meta, Dito, DataLayer, etc).  
+
+O objetivo é fornecer uma **camada única e consistente de tracking**, garantindo que todos os eventos sejam tratados, formatados e enviados de forma confiável.  
+
+E, principalmente, centralizar a complexidade e a “inteligência” de tracking **fora dos repositórios das lojas**.
+
+---
+
+## Fluxo do Tracking
+
+O pacote segue o seguinte fluxo de eventos:
+
+1. **User Action**  
+   Ações do usuário na loja (ex: adicionar ao carrinho, iniciar checkout, finalizar compra).  
+
+2. **Tracks**  
+   Ponto central que recebe o contexto do evento vindo da ação do usuário e encaminha para o *Formatter*.  
+
+3. **Formatter**  
+   Acessa a constante `EVENTS` e, baseado no contexto do evento, puxa os parâmetros obrigatórios e entrega a biblioteca de parâmetros (`/params`).  
+
+4. **Params Library**  
+   Contém **getters** e **resolvers** que garantem que os dados sejam legítimos e que todos os parâmetros sejam corretamente tratados.  
+
+5. **Adapters**  
+   Módulos responsáveis por enviar os dados formatados para cada destino (Meta, Datalayer, Dito, etc).  
+
+![FLUXOGRAMA](/public/fluxograma-lib-params.png)
+
+## Instalação
+
+
+```bash
+npm install /path/azzas-tracker-web
+```
+
+
+## Exemplos
+
+Listagem dos `EVENTS` e função orquestradora `trackWebEvent`:
+```javascript
+  const EVENTS = {
+    ADD_PERSONAL_INFO: {
+      name: 'add_personal_info',
+      destinations: ['DataLayer'],
+      requiredParams: ['brand', 'pre_filled', 'currency', 'value', 'subtotal'],
+    }, 
+    VIEW_CART: {
+      name: 'add_personal_info',
+      destinations: ['DataLayer', 'Meta', 'Dito'],
+      requiredParams: ['....'],
+    }
+  }
+
+  export async function trackWebEvent(event: EventName, context: EventContext = {}) {
+    try {
+      const parameters = await getParameters(context, event);
+      return await dispatchTrackEvent(event, parameters);
+    } catch (err) {
+      return console.error(`[DT] Error tracking event ${event}:`, err);
+    }
+  }
+```
+
+Uso básico da função no consumidor:
+
+
+```javascript
+  import { trackWebEvent } from 'azzas-tracker-web';
+
+  // DATA TRACKING | add_personal_info at submit (pre-filled always false)
+  // @see notion document for more details:
+  const form: Element = document.querySelector('xxxxxx');
+  if (form) {
+    form.addEventListener('submit', () => {
+      trackWebEvent('ADD_PERSONAL_INFO', { preFilled: false, orderForm: vtexjs.checkout.orderForm });
+    });
+  }
+```
+
+***OBS***: atente-se ao adicionar eventos novos e contribua na documentação do NOTION ou apenas DOCUMENTE em algum lugar! Seu futuro EU será grato 👍
+
+## Teste Local para Ambientes CDN/DENO
+
+Para testar alterações na biblioteca localmente, simulando a forma como ela é carregada por uma CDN (<script src="...">), use o script npm run dev:deno.
+
+Este comando realiza o build mais recente da biblioteca, empacota-o e inicia um servidor HTTP local usando o Deno para servir o arquivo
+
+1. Aqui nesse repositório, rode o script que inicia o servidor local:
+
+```bash
+  npm run dev:deno
+```
+
+O servidor será iniciado e começará a servir o seu arquivo de build no seguinte endereço: http://localhost:4507/.
+
+2. No Projeto Consumidor (DENO/FRONT):
+
+Altere o link do <script> no seu projeto para apontar para o servidor local.
+
+Você deve usar: <script src="http://localhost:4507/dist/mod.global.js"></script>
+
+
+## Boas Práticas
+- Sempre garantir que os `requiredParams` de cada evento estejam preenchidos antes de enviar.
+
+- Procure sempre manter o envio das ações de usuário o mais ***genérico*** possível. Toda a inteligência e complexidade do tratamento dos dados deve ficar centralizada na lib, e não nos repositórios das lojas.
+
+- Usar nomes de eventos semânticos e consistentes (ex: VIEW_CART, ADD_PAYMENT_INFO).
+
+- Manter os contextos enxutos, enviando apenas dados realmente necessários.
+
+- Cada novo evento deve ser registrado em `EVENTS` com seus destinos e parâmetros obrigatórios. Essa constante talvez venha a ser dinâmica dependendo da MARCA utilizada
+
+
+## Contribuição
+
+- Adicionar novos eventos em `EVENTS`.
+
+- Criar adapter correspondente caso seja necessário integrar com nova plataforma. Nesse caso deve-se avaliar qual será o serviço feito, o que será consumido, para onde será enviado.
+
+- Garantir que todos os parâmetros obrigatórios estejam mapeados nos getters/resolvers.
+
+- Executar build (npm run build) antes de testar no checkout/loja.
+
+## Authors
+
+- Lucas Soares

package/dist/mod.cjs

@@ -424,17 +424,55 @@ async function getItemSku(item) {
   return (_b = (_a = product[0].items.find((i) => i.name === item.skuName)) == null ? void 0 : _a.itemId) != null ? _b : null;
 }
 function getDiscount(item) {
-  return item.discount || item.discount === 0 ? item.discount : parseFloat(Math.max(item.listPrice - item.sellingPrice, 0).toFixed(2)) / 100 || 0;
+  const strategies = [
+    // 1. listPrice - sellingPrice
+    () => {
+      if ((item == null ? void 0 : item.listPrice) != null && (item == null ? void 0 : item.sellingPrice) != null) {
+        const diff = Math.max(item.listPrice - item.sellingPrice, 0);
+        return diff ? parseFloat((diff / 100).toFixed(2)) : 0;
+      }
+      return null;
+    },
+    // 2. listPrice - price
+    () => {
+      if ((item == null ? void 0 : item.listPrice) != null && (item == null ? void 0 : item.price) != null) {
+        return Math.max(item.listPrice - item.price, 0);
+      }
+      return null;
+    },
+    // 3. desconto calculado.
+    () => (item == null ? void 0 : item.discount) || (item == null ? void 0 : item.discount) === 0 ? item.discount : null
+  ];
+  for (const getValue of strategies) {
+    const value = getValue();
+    if (value !== null && value !== void 0) {
+      return value;
+    }
+  }
+  return 0;
 }
 function getItemCategory(item) {
   const strategies = [
     () => {
-      var _a;
-      return ((_a = item == null ? void 0 : item.productCategories) == null ? void 0 : _a["39"]) === "BAZAR" ? "Sale" : "Cole\xE7\xE3o";
+      const stringCategories = ((item == null ? void 0 : item.categories) || (item == null ? void 0 : item.productCategories)).toString().toLowerCase();
+      const hasOutletSaleOrBazar = stringCategories.includes("outlet") || stringCategories.includes("sale") || stringCategories.includes("bazar");
+      return hasOutletSaleOrBazar ? (item == null ? void 0 : item.brand) === "By NV" ? "Outlet" : "Sale" : "Cole\xE7\xE3o";
     },
     () => item == null ? void 0 : item.item_category,
     () => item == null ? void 0 : item.category,
-    () => item == null ? void 0 : item.categories[0]
+    () => item == null ? void 0 : item.categories[0],
+    () => {
+      var _a, _b;
+      const breadcrumb = (_b = (_a = item == null ? void 0 : item.itemOffered) == null ? void 0 : _a.breadcrumbList) == null ? void 0 : _b.itemListElement;
+      if (!Array.isArray(breadcrumb)) return null;
+      const level1 = breadcrumb.find((el) => {
+        const path = el == null ? void 0 : el.item;
+        if (!path) return false;
+        const parts = path.replace(/^\/|\/$/g, "").split("/");
+        return parts.length === 1;
+      });
+      return (level1 == null ? void 0 : level1.name) || null;
+    }
   ];
   for (const getValue of strategies) {
     const value = getValue();
@@ -448,18 +486,15 @@ function getItemCategory2(item) {
   const strategies = [
     () => Object.values((item == null ? void 0 : item.productCategories) || {}).pop(),
     // checkout select_item context
-    () => {
-      var _a;
-      return (_a = Object.values((item == null ? void 0 : item.categories) || {}).pop()) == null ? void 0 : _a.slice(1, -1).replace(/\//g, ",");
-    },
-    // 
+    () => Object.values((item == null ? void 0 : item.categories) || {}).pop(),
     () => {
       var _a, _b, _c, _d, _e;
       return (_e = (_d = (_c = (_b = (_a = item == null ? void 0 : item.category) == null ? void 0 : _a.split) == null ? void 0 : _b.call(_a, ">")) == null ? void 0 : _c[1]) == null ? void 0 : _d.trim) == null ? void 0 : _e.call(_d);
     },
     // deco select_item context
-    () => item.item_category2
+    () => item.item_category2,
     // deco add_to_cart context PDP
+    () => item == null ? void 0 : item.subGrup
   ];
   for (const getValue of strategies) {
     const value = getValue();
@@ -575,24 +610,24 @@ async function itemsFromOrderForm(context) {
 
 // src/params/resolvers/items/fromItem.ts
 async function itemsFromItem(context, event) {
-  var _a, _b, _c, _d, _e, _f;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m;
   const { item, orderForm, itemListName } = context;
   return [
     {
       index: typeof (item == null ? void 0 : item.index) === "number" ? item.index : null,
       quantity: 1,
-      item_id: (item == null ? void 0 : item.productId) || (item == null ? void 0 : item.item_group_id) || (item == null ? void 0 : item.sku) || null,
+      item_id: (item == null ? void 0 : item.productId) || (item == null ? void 0 : item.item_group_id) || (item == null ? void 0 : item.sku) || (item == null ? void 0 : item.id) || null,
       item_category2: getItemCategory2(item),
       item_category4: getItemCategory4(item),
       item_shipping_tier: event === "REMOVE_FROM_CART" ? getItemShippingTier(orderForm, item) : null,
       price: (item == null ? void 0 : item.listPrice) || (item == null ? void 0 : item.price) || 0,
-      item_ref: (item == null ? void 0 : item.ref) || (item == null ? void 0 : item.refId) || (item == null ? void 0 : item.item_ref) || ((_a = item == null ? void 0 : item.additionalProperty) == null ? void 0 : _a.find((i) => i.name === "RefId").value) || null,
-      item_brand: ((_b = item == null ? void 0 : item.additionalInfo) == null ? void 0 : _b.brandName) || (item == null ? void 0 : item.item_brand) || ((_c = item == null ? void 0 : item.brand) == null ? void 0 : _c.name) || null,
-      item_sku: (item == null ? void 0 : item.sku) || (item == null ? void 0 : item.id) || (item == null ? void 0 : item.item_id) || await getItemSku(item) || null,
-      item_name: (item == null ? void 0 : item.name) || (item == null ? void 0 : item.item_name) || null,
+      item_ref: (item == null ? void 0 : item.ref) || (item == null ? void 0 : item.refId) || (item == null ? void 0 : item.item_ref) || ((_a = item == null ? void 0 : item.additionalProperty) == null ? void 0 : _a.find((i) => i.name === "RefId").value) || ((_c = item == null ? void 0 : item.itemOffered) == null ? void 0 : _c.gtin.substring(0, (_b = item == null ? void 0 : item.itemOffered) == null ? void 0 : _b.gtin.lastIndexOf("_"))) || null,
+      item_brand: ((_d = item == null ? void 0 : item.additionalInfo) == null ? void 0 : _d.brandName) || (item == null ? void 0 : item.item_brand) || ((_e = item == null ? void 0 : item.brand) == null ? void 0 : _e.name) || ((_g = (_f = item == null ? void 0 : item.itemOffered) == null ? void 0 : _f.brand) == null ? void 0 : _g.name) || null,
+      item_sku: (item == null ? void 0 : item.sku) || ((_h = item == null ? void 0 : item.itemOffered) == null ? void 0 : _h.sku) || (item == null ? void 0 : item.item_id) || (item == null ? void 0 : item.id) || await getItemSku(item) || null,
+      item_name: (item == null ? void 0 : item.name) || (item == null ? void 0 : item.item_name) || ((_j = (_i = item == null ? void 0 : item.itemOffered) == null ? void 0 : _i.isVariantOf) == null ? void 0 : _j.name) || null,
       item_category: getItemCategory(item) || null,
-      item_variant: ((item == null ? void 0 : item.skuName) || (item == null ? void 0 : item.item_variant) || (item == null ? void 0 : item.name)).split(/[-/]/)[0].trim() || null,
-      item_variant2: (item == null ? void 0 : item.size) || ((_d = item == null ? void 0 : item.itemAttributes) == null ? void 0 : _d.size) || ((_f = (_e = (item == null ? void 0 : item.skuName) || (item == null ? void 0 : item.name)) == null ? void 0 : _e.split(/[-/]/).pop()) == null ? void 0 : _f.trim()) || null,
+      item_variant: ((item == null ? void 0 : item.skuName) || (item == null ? void 0 : item.item_variant) || (item == null ? void 0 : item.name) || (item == null ? void 0 : item.itemOffered.name)).split(/[-/]/)[0].trim() || null,
+      item_variant2: (item == null ? void 0 : item.size) || ((_k = item == null ? void 0 : item.itemAttributes) == null ? void 0 : _k.size) || ((_m = (_l = (item == null ? void 0 : item.skuName) || (item == null ? void 0 : item.name) || (item == null ? void 0 : item.itemOffered.name)) == null ? void 0 : _l.split(/[-/]/).pop()) == null ? void 0 : _m.trim()) || null,
       discount: getDiscount(item),
       item_list_name: itemListName || null,
       item_url: (item == null ? void 0 : item.item_url) || null
@@ -610,7 +645,7 @@ async function itemsFromList(context) {
       quantity: 1,
       item_ref: (item == null ? void 0 : item.ref) || (item == null ? void 0 : item.item_ref) || ((_e = item == null ? void 0 : item.referenceId) == null ? void 0 : _e[0].Value) || (item == null ? void 0 : item.productReference) || (item == null ? void 0 : item.additionalProperty.find((i) => i.name === "RefId").value) || null,
       index: typeof (context == null ? void 0 : context.index) === "number" ? context.index : Number(item == null ? void 0 : item.index),
-      item_brand: item.isNotFarm ? item == null ? void 0 : item.item_brand : normalizeBrand((_f = item == null ? void 0 : item.brand) == null ? void 0 : _f.name) || normalizeBrand(context.brand) || normalizeBrand(item == null ? void 0 : item.item_brand) || null,
+      item_brand: (item == null ? void 0 : item.item_brand) ? item.item_brand : item.isNotFarm ? item == null ? void 0 : item.item_brand : normalizeBrand((_f = item == null ? void 0 : item.brand) == null ? void 0 : _f.name) || normalizeBrand(context.brand) || normalizeBrand(item == null ? void 0 : item.item_brand) || null,
       item_name: ((_g = item == null ? void 0 : item.productName) == null ? void 0 : _g.split(" - ").shift()) || ((_h = item == null ? void 0 : item.alternateName) == null ? void 0 : _h.split(" - ").shift()) || ((_i = item == null ? void 0 : item.item_name) == null ? void 0 : _i.split(" - ").shift()) || ((_k = (_j = item == null ? void 0 : item.seo) == null ? void 0 : _j.title) == null ? void 0 : _k.split(" - ").shift()) || null,
       item_category: getItemCategory(item) || null,
       item_variant: ((_m = (_l = item == null ? void 0 : item.name) == null ? void 0 : _l.split("-")) == null ? void 0 : _m[0].trim()) || (item == null ? void 0 : item.item_variant) || ((_o = (_n = item == null ? void 0 : item.productName) == null ? void 0 : _n.split("-")) == null ? void 0 : _o[1].trim()) || null,