@azzas/azzas-tracker-web 1.0.84 → 1.0.85

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,130 +1,130 @@
1
- # azzas-tracker-web
2
-
3
- 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).
4
-
5
- O objetivo é fornecer uma **camada única e consistente de tracking**, garantindo que todos os eventos sejam tratados, formatados e enviados de forma confiável.
6
-
7
- E, principalmente, centralizar a complexidade e a “inteligência” de tracking **fora dos repositórios das lojas**.
8
-
9
- ---
10
-
11
- ## Fluxo do Tracking
12
-
13
- O pacote segue o seguinte fluxo de eventos:
14
-
15
- 1. **User Action**
16
- Ações do usuário na loja (ex: adicionar ao carrinho, iniciar checkout, finalizar compra).
17
-
18
- 2. **Tracks**
19
- Ponto central que recebe o contexto do evento vindo da ação do usuário e encaminha para o *Formatter*.
20
-
21
- 3. **Formatter**
22
- Acessa a constante `EVENTS` e, baseado no contexto do evento, puxa os parâmetros obrigatórios e entrega a biblioteca de parâmetros (`/params`).
23
-
24
- 4. **Params Library**
25
- Contém **getters** e **resolvers** que garantem que os dados sejam legítimos e que todos os parâmetros sejam corretamente tratados.
26
-
27
- 5. **Adapters**
28
- Módulos responsáveis por enviar os dados formatados para cada destino (Meta, Datalayer, Dito, etc).
29
-
30
- ![FLUXOGRAMA](/public/fluxograma-lib-params.png)
31
-
32
- ## Instalação
33
-
34
-
35
- ```bash
36
- npm install /path/azzas-tracker-web
37
- ```
38
-
39
-
40
- ## Exemplos
41
-
42
- Listagem dos `EVENTS` e função orquestradora `trackWebEvent`:
43
- ```javascript
44
- const EVENTS = {
45
- ADD_PERSONAL_INFO: {
46
- name: 'add_personal_info',
47
- destinations: ['DataLayer'],
48
- requiredParams: ['brand', 'pre_filled', 'currency', 'value', 'subtotal'],
49
- },
50
- VIEW_CART: {
51
- name: 'add_personal_info',
52
- destinations: ['DataLayer', 'Meta', 'Dito'],
53
- requiredParams: ['....'],
54
- }
55
- }
56
-
57
- export async function trackWebEvent(event: EventName, context: EventContext = {}) {
58
- try {
59
- const parameters = await getParameters(context, event);
60
- return await dispatchTrackEvent(event, parameters);
61
- } catch (err) {
62
- return console.error(`[DT] Error tracking event ${event}:`, err);
63
- }
64
- }
65
- ```
66
-
67
- Uso básico da função no consumidor:
68
-
69
-
70
- ```javascript
71
- import { trackWebEvent } from 'azzas-tracker-web';
72
-
73
- // DATA TRACKING | add_personal_info at submit (pre-filled always false)
74
- // @see notion document for more details:
75
- const form: Element = document.querySelector('xxxxxx');
76
- if (form) {
77
- form.addEventListener('submit', () => {
78
- trackWebEvent('ADD_PERSONAL_INFO', { preFilled: false, orderForm: vtexjs.checkout.orderForm });
79
- });
80
- }
81
- ```
82
-
83
- ***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 👍
84
-
85
- ## Teste Local para Ambientes CDN/DENO
86
-
87
- 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.
88
-
89
- Este comando realiza o build mais recente da biblioteca, empacota-o e inicia um servidor HTTP local usando o Deno para servir o arquivo
90
-
91
- 1. Aqui nesse repositório, rode o script que inicia o servidor local:
92
-
93
- ```bash
94
- npm run dev:deno
95
- ```
96
-
97
- O servidor será iniciado e começará a servir o seu arquivo de build no seguinte endereço: http://localhost:4507/.
98
-
99
- 2. No Projeto Consumidor (DENO/FRONT):
100
-
101
- Altere o link do <script> no seu projeto para apontar para o servidor local.
102
-
103
- Você deve usar: <script src="http://localhost:4507/dist/mod.global.js"></script>
104
-
105
-
106
- ## Boas Práticas
107
- - Sempre garantir que os `requiredParams` de cada evento estejam preenchidos antes de enviar.
108
-
109
- - 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.
110
-
111
- - Usar nomes de eventos semânticos e consistentes (ex: VIEW_CART, ADD_PAYMENT_INFO).
112
-
113
- - Manter os contextos enxutos, enviando apenas dados realmente necessários.
114
-
115
- - 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
116
-
117
-
118
- ## Contribuição
119
-
120
- - Adicionar novos eventos em `EVENTS`.
121
-
122
- - 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.
123
-
124
- - Garantir que todos os parâmetros obrigatórios estejam mapeados nos getters/resolvers.
125
-
126
- - Executar build (npm run build) antes de testar no checkout/loja.
127
-
128
- ## Authors
129
-
130
- - Lucas Soares
1
+ # azzas-tracker-web
2
+
3
+ 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).
4
+
5
+ O objetivo é fornecer uma **camada única e consistente de tracking**, garantindo que todos os eventos sejam tratados, formatados e enviados de forma confiável.
6
+
7
+ E, principalmente, centralizar a complexidade e a “inteligência” de tracking **fora dos repositórios das lojas**.
8
+
9
+ ---
10
+
11
+ ## Fluxo do Tracking
12
+
13
+ O pacote segue o seguinte fluxo de eventos:
14
+
15
+ 1. **User Action**
16
+ Ações do usuário na loja (ex: adicionar ao carrinho, iniciar checkout, finalizar compra).
17
+
18
+ 2. **Tracks**
19
+ Ponto central que recebe o contexto do evento vindo da ação do usuário e encaminha para o *Formatter*.
20
+
21
+ 3. **Formatter**
22
+ Acessa a constante `EVENTS` e, baseado no contexto do evento, puxa os parâmetros obrigatórios e entrega a biblioteca de parâmetros (`/params`).
23
+
24
+ 4. **Params Library**
25
+ Contém **getters** e **resolvers** que garantem que os dados sejam legítimos e que todos os parâmetros sejam corretamente tratados.
26
+
27
+ 5. **Adapters**
28
+ Módulos responsáveis por enviar os dados formatados para cada destino (Meta, Datalayer, Dito, etc).
29
+
30
+ ![FLUXOGRAMA](/public/fluxograma-lib-params.png)
31
+
32
+ ## Instalação
33
+
34
+
35
+ ```bash
36
+ npm install /path/azzas-tracker-web
37
+ ```
38
+
39
+
40
+ ## Exemplos
41
+
42
+ Listagem dos `EVENTS` e função orquestradora `trackWebEvent`:
43
+ ```javascript
44
+ const EVENTS = {
45
+ ADD_PERSONAL_INFO: {
46
+ name: 'add_personal_info',
47
+ destinations: ['DataLayer'],
48
+ requiredParams: ['brand', 'pre_filled', 'currency', 'value', 'subtotal'],
49
+ },
50
+ VIEW_CART: {
51
+ name: 'add_personal_info',
52
+ destinations: ['DataLayer', 'Meta', 'Dito'],
53
+ requiredParams: ['....'],
54
+ }
55
+ }
56
+
57
+ export async function trackWebEvent(event: EventName, context: EventContext = {}) {
58
+ try {
59
+ const parameters = await getParameters(context, event);
60
+ return await dispatchTrackEvent(event, parameters);
61
+ } catch (err) {
62
+ return console.error(`[DT] Error tracking event ${event}:`, err);
63
+ }
64
+ }
65
+ ```
66
+
67
+ Uso básico da função no consumidor:
68
+
69
+
70
+ ```javascript
71
+ import { trackWebEvent } from 'azzas-tracker-web';
72
+
73
+ // DATA TRACKING | add_personal_info at submit (pre-filled always false)
74
+ // @see notion document for more details:
75
+ const form: Element = document.querySelector('xxxxxx');
76
+ if (form) {
77
+ form.addEventListener('submit', () => {
78
+ trackWebEvent('ADD_PERSONAL_INFO', { preFilled: false, orderForm: vtexjs.checkout.orderForm });
79
+ });
80
+ }
81
+ ```
82
+
83
+ ***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 👍
84
+
85
+ ## Teste Local para Ambientes CDN/DENO
86
+
87
+ 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.
88
+
89
+ Este comando realiza o build mais recente da biblioteca, empacota-o e inicia um servidor HTTP local usando o Deno para servir o arquivo
90
+
91
+ 1. Aqui nesse repositório, rode o script que inicia o servidor local:
92
+
93
+ ```bash
94
+ npm run dev:deno
95
+ ```
96
+
97
+ O servidor será iniciado e começará a servir o seu arquivo de build no seguinte endereço: http://localhost:4507/.
98
+
99
+ 2. No Projeto Consumidor (DENO/FRONT):
100
+
101
+ Altere o link do <script> no seu projeto para apontar para o servidor local.
102
+
103
+ Você deve usar: <script src="http://localhost:4507/dist/mod.global.js"></script>
104
+
105
+
106
+ ## Boas Práticas
107
+ - Sempre garantir que os `requiredParams` de cada evento estejam preenchidos antes de enviar.
108
+
109
+ - 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.
110
+
111
+ - Usar nomes de eventos semânticos e consistentes (ex: VIEW_CART, ADD_PAYMENT_INFO).
112
+
113
+ - Manter os contextos enxutos, enviando apenas dados realmente necessários.
114
+
115
+ - 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
116
+
117
+
118
+ ## Contribuição
119
+
120
+ - Adicionar novos eventos em `EVENTS`.
121
+
122
+ - 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.
123
+
124
+ - Garantir que todos os parâmetros obrigatórios estejam mapeados nos getters/resolvers.
125
+
126
+ - Executar build (npm run build) antes de testar no checkout/loja.
127
+
128
+ ## Authors
129
+
130
+ - Lucas Soares
package/dist/mod.cjs CHANGED
@@ -600,36 +600,6 @@ function getBrand(context, eventName) {
600
600
  }
601
601
  }
602
602
 
603
- // src/params/resolvers/items/fromOrderForm.ts
604
- async function itemsFromOrderForm(context) {
605
- var _a;
606
- const items = ((_a = context.orderForm) == null ? void 0 : _a.items) || [];
607
- if (!items.length) return [];
608
- return await Promise.all(
609
- items.map(async (item) => {
610
- var _a2, _b, _c, _d, _e, _f;
611
- return {
612
- item_id: item.productId,
613
- item_category2: getItemCategory2(item),
614
- item_category4: getItemCategory4(item),
615
- item_shipping_tier: getItemShippingTier(context.orderForm, item),
616
- price: parseFloat(((item == null ? void 0 : item.price) / 100).toFixed(2)) || 0,
617
- quantity: item.quantity || 1,
618
- item_ref: item.refId || null,
619
- item_brand: normalizeBrand((_a2 = item.additionalInfo) == null ? void 0 : _a2.brandName) || ((_b = item.additionalInfo) == null ? void 0 : _b.brandName) || null,
620
- item_sku: await getItemSku(item) || null,
621
- item_name: (item == null ? void 0 : item.name.replace(item == null ? void 0 : item.skuName, "").trim()) || item.name || null,
622
- item_category: getItemCategory(item) || null,
623
- item_variant: ((_d = (_c = item == null ? void 0 : item.skuName) == null ? void 0 : _c.split(" - ")[0]) == null ? void 0 : _d.trim()) || "",
624
- item_variant2: ((_f = (_e = item == null ? void 0 : item.skuName) == null ? void 0 : _e.split(" - ")[1]) == null ? void 0 : _f.trim()) || "",
625
- item_url: `https://www.farmrio.com.br${item.detailUrl}` || null,
626
- discount: getDiscount(item),
627
- image_url: resizeVtexImage(item == null ? void 0 : item.image) || resizeVtexImage(item == null ? void 0 : item.imageUrl) || null
628
- };
629
- })
630
- );
631
- }
632
-
633
603
  // src/params/utils/itemListAttribution.ts
634
604
  var LAST_SELECTED_ITEM_KEY = "last_selected_item";
635
605
  var STORAGE_VIEWED = "last_viewed_item";
@@ -721,6 +691,16 @@ function writeCartHistory(history) {
721
691
  } catch (e) {
722
692
  }
723
693
  }
694
+ function getLatestItemListNameById(history) {
695
+ const byId = /* @__PURE__ */ new Map();
696
+ for (let index = history.length - 1; index >= 0; index -= 1) {
697
+ const entry = history[index];
698
+ if (!byId.has(entry.item_id)) {
699
+ byId.set(entry.item_id, entry.item_list_name);
700
+ }
701
+ }
702
+ return byId;
703
+ }
724
704
  function saveSelectedItem(productId, listName) {
725
705
  if (productId == null || !listName) return;
726
706
  const payload = {
@@ -771,6 +751,18 @@ function appendCartHistory(productId, listName) {
771
751
  });
772
752
  writeCartHistory(history);
773
753
  }
754
+ function getCartHistoryItemListNameMap() {
755
+ const history = readCartHistory();
756
+ if (!history.length) return null;
757
+ return getLatestItemListNameById(history);
758
+ }
759
+ function resolveItemListNameFromCartHistory(item, cartHistoryMap = null) {
760
+ const itemId = resolveIdFromUnknownItem(item);
761
+ const map = cartHistoryMap != null ? cartHistoryMap : getCartHistoryItemListNameMap();
762
+ if (!itemId) return void 0;
763
+ const resolved = map == null ? void 0 : map.get(itemId);
764
+ return resolved;
765
+ }
774
766
  function pickSelectedItemFromResolvedItems(items, source) {
775
767
  var _a;
776
768
  if (!Array.isArray(items) || items.length === 0) return null;
@@ -789,6 +781,38 @@ function persistSelectItemOriginFromResolvedItems(items, source) {
789
781
  saveSelectedItem(productId, listName);
790
782
  }
791
783
 
784
+ // src/params/resolvers/items/fromOrderForm.ts
785
+ async function itemsFromOrderForm(context) {
786
+ var _a;
787
+ const items = ((_a = context.orderForm) == null ? void 0 : _a.items) || [];
788
+ const cartHistoryMap = getCartHistoryItemListNameMap();
789
+ if (!items.length) return [];
790
+ return await Promise.all(
791
+ items.map(async (item) => {
792
+ var _a2, _b, _c, _d, _e, _f, _g;
793
+ return {
794
+ item_id: item.productId,
795
+ item_category2: getItemCategory2(item),
796
+ item_category4: getItemCategory4(item),
797
+ item_shipping_tier: getItemShippingTier(context.orderForm, item),
798
+ price: parseFloat(((item == null ? void 0 : item.price) / 100).toFixed(2)) || 0,
799
+ quantity: item.quantity || 1,
800
+ item_ref: item.refId || null,
801
+ item_brand: normalizeBrand((_a2 = item.additionalInfo) == null ? void 0 : _a2.brandName) || ((_b = item.additionalInfo) == null ? void 0 : _b.brandName) || null,
802
+ item_sku: await getItemSku(item) || null,
803
+ item_name: (item == null ? void 0 : item.name.replace(item == null ? void 0 : item.skuName, "").trim()) || item.name || null,
804
+ item_category: getItemCategory(item) || null,
805
+ item_variant: ((_d = (_c = item == null ? void 0 : item.skuName) == null ? void 0 : _c.split(" - ")[0]) == null ? void 0 : _d.trim()) || "",
806
+ item_variant2: ((_f = (_e = item == null ? void 0 : item.skuName) == null ? void 0 : _e.split(" - ")[1]) == null ? void 0 : _f.trim()) || "",
807
+ item_url: `https://www.farmrio.com.br${item.detailUrl}` || null,
808
+ discount: getDiscount(item),
809
+ image_url: resizeVtexImage(item == null ? void 0 : item.image) || resizeVtexImage(item == null ? void 0 : item.imageUrl) || null,
810
+ item_list_name: (_g = resolveItemListNameFromCartHistory(item, cartHistoryMap)) != null ? _g : null
811
+ };
812
+ })
813
+ );
814
+ }
815
+
792
816
  // src/params/resolvers/items/fromItem.ts
793
817
  async function itemsFromItem(context, event) {
794
818
  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r;