@beworke/pixel 0.1.0-rc.5 → 0.1.0-rc.6

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.
Files changed (34) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/README.md +38 -69
  3. package/dist/index.cjs.js +1 -1
  4. package/dist/index.cjs.js.map +1 -1
  5. package/dist/index.esm.js +1 -1
  6. package/dist/index.esm.js.map +1 -1
  7. package/dist/v2/global.global.js +1 -1
  8. package/dist/v2/global.global.js.map +1 -1
  9. package/dist/v2/index.cjs.js +1 -1
  10. package/dist/v2/index.cjs.js.map +1 -1
  11. package/dist/v2/index.esm.js +1 -1
  12. package/dist/v2/index.esm.js.map +1 -1
  13. package/docs/public/README.md +75 -0
  14. package/docs/public/api/exports.md +47 -0
  15. package/docs/public/api/pixel.md +65 -0
  16. package/docs/public/configuration/commerce.md +44 -0
  17. package/docs/public/configuration/modules.md +66 -0
  18. package/docs/public/configuration/overview.md +66 -0
  19. package/docs/public/events/catalog.md +65 -0
  20. package/docs/public/getting-started/installation.md +75 -0
  21. package/docs/public/getting-started/quick-start.md +77 -0
  22. package/docs/public/getting-started/react-nextjs.md +55 -0
  23. package/docs/public/getting-started/script-tag.md +57 -0
  24. package/docs/public/guides/funnel-checkout.md +52 -0
  25. package/docs/public/guides/funnel-downsell.md +53 -0
  26. package/docs/public/guides/funnel-full.md +64 -0
  27. package/docs/public/guides/funnel-landing.md +68 -0
  28. package/docs/public/guides/funnel-thank-you.md +48 -0
  29. package/docs/public/guides/funnel-upsell.md +72 -0
  30. package/docs/public/limitations.md +32 -0
  31. package/docs/public/privacy/limitations.md +33 -0
  32. package/docs/public/release-candidate/validation.md +37 -0
  33. package/docs/public/troubleshooting.md +55 -0
  34. package/package.json +3 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # @beworke/pixel
2
2
 
3
+ ## 0.1.0-rc.6 — Public RC docs on npm + install fix
4
+
5
+ ### Fixed
6
+
7
+ - README npm com links **GitHub** (npm não hospeda páginas `.md` individuais)
8
+ - `docs/public/` incluído no tarball npm → `node_modules/@beworke/pixel/docs/public/`
9
+ - Instalação documentada: `npm install @beworke/pixel@rc` (público, sem token)
10
+ - `publish:rc` publica tags `rc` e `latest` juntas
11
+
3
12
  ## Unreleased — Etapa 20 Runtime Intelligence
4
13
 
5
14
  ### Added
package/README.md CHANGED
@@ -2,31 +2,41 @@
2
2
 
3
3
  SDK de analytics e conversão para web — implemente funis (landing, checkout, upsell, thank-you) em React, Next.js, SPA ou HTML puro **sem conhecer a arquitetura interna**.
4
4
 
5
- **Versão RC:** `0.1.0-rc.5` · **Etapas concluídas:** 1–20 · **Próxima etapa funcional:** 21 — Commerce Lifecycle
5
+ **Versão RC:** `0.1.0-rc.6` · **Etapas concluídas:** 1–20 · **Próxima etapa funcional:** 21 — Commerce Lifecycle
6
6
 
7
- ## Documentação pública
7
+ ## Instalação (npm — sem token)
8
8
 
9
- **Comece aqui:** [`docs/public/README.md`](./docs/public/README.md)
9
+ Pacote **público**. Qualquer dev instala **sem login** no npm:
10
10
 
11
- | Guia | Link |
12
- |------|------|
13
- | Instalação | [docs/public/getting-started/installation.md](./docs/public/getting-started/installation.md) |
14
- | Quick start | [docs/public/getting-started/quick-start.md](./docs/public/getting-started/quick-start.md) |
15
- | API Pixel | [docs/public/api/pixel.md](./docs/public/api/pixel.md) |
16
- | Eventos | [docs/public/events/catalog.md](./docs/public/events/catalog.md) |
17
- | Configuração | [docs/public/configuration/overview.md](./docs/public/configuration/overview.md) |
18
- | Funis | [docs/public/guides/funnel-full.md](./docs/public/guides/funnel-full.md) |
19
- | Privacidade (RC) | [docs/public/privacy/limitations.md](./docs/public/privacy/limitations.md) |
20
- | Limitações | [docs/public/limitations.md](./docs/public/limitations.md) |
11
+ ```bash
12
+ npm install @beworke/pixel@rc
13
+ # ou versão fixa:
14
+ npm install @beworke/pixel@0.1.0-rc.6
15
+ ```
21
16
 
22
- Exemplos públicos: [`examples/public/`](./examples/public/) · Next.js: [`examples/nextjs/`](./examples/nextjs/)
17
+ > **Importante:** `npm install @beworke/pixel` sem tag usa `latest`. Use `@rc` ou `@0.1.0-rc.6` até alinhar tags.
23
18
 
24
- ## Instalação
19
+ ## Documentação pública
25
20
 
26
- ```bash
27
- npm install ./beworke-pixel-0.1.0-rc.5.tgz
28
- npm run validate:rc-package # no repo do SDK
29
- ```
21
+ O **npm não hospeda** arquivos `.md` como site (URLs tipo `npmjs.com/.../installation.md` **não existem**).
22
+
23
+ | Onde ler | Link |
24
+ |----------|------|
25
+ | **GitHub (recomendado no browser)** | [docs/public/README.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/README.md) |
26
+ | **Após `npm install`** | `node_modules/@beworke/pixel/docs/public/` |
27
+
28
+ | Guia | GitHub |
29
+ |------|--------|
30
+ | Instalação | [getting-started/installation.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/getting-started/installation.md) |
31
+ | Quick start | [getting-started/quick-start.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/getting-started/quick-start.md) |
32
+ | API Pixel | [api/pixel.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/api/pixel.md) |
33
+ | Eventos | [events/catalog.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/events/catalog.md) |
34
+ | Configuração | [configuration/overview.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/configuration/overview.md) |
35
+ | Funis | [guides/funnel-full.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/guides/funnel-full.md) |
36
+ | Privacidade (RC) | [privacy/limitations.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/privacy/limitations.md) |
37
+ | Limitações | [limitations.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/limitations.md) |
38
+
39
+ Repositório: https://github.com/techionext/Pixel-Global
30
40
 
31
41
  ## Quick start
32
42
 
@@ -60,11 +70,8 @@ const pixel = new Pixel({
60
70
  });
61
71
 
62
72
  await pixel.init();
63
- // PAGE_VIEW automático
64
-
65
73
  pixel.lead({ email: 'user@example.com' });
66
74
  pixel.purchase({ transactionId: 'ord_1', value: 197, currency: 'BRL' });
67
-
68
75
  await pixel.destroy();
69
76
  ```
70
77
 
@@ -77,65 +84,27 @@ await pixel.destroy();
77
84
  | `purchase`, `lead`, `addToCart`, `removeFromCart` | Conversão |
78
85
  | `initiateCheckout`, `addPaymentInfo`, `viewContent`, `search` | Conversão |
79
86
 
80
- Exports: `DEFAULT_PIXEL_CONFIG`, `PixelConfig`, `PixelDebugSnapshot`, `resolveStorageAdapterName`.
81
-
82
- Detalhes: [docs/public/api/pixel.md](./docs/public/api/pixel.md)
83
-
84
- ## Eventos (resumo)
87
+ Detalhes: [api/pixel.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/api/pixel.md)
85
88
 
86
- Core · Session · Behavior · Conversion — 24 tipos em `PixelEvent`. Catálogo completo: [docs/public/events/catalog.md](./docs/public/events/catalog.md).
87
-
88
- ## Script tag (CDN / IIFE)
89
+ ## Script tag (CDN)
89
90
 
90
91
  ```html
91
- <script src="https://unpkg.com/@beworke/pixel@0.1.0-rc.5/dist/v2/global.global.js"></script>
92
+ <script src="https://unpkg.com/@beworke/pixel@rc/dist/v2/global.global.js"></script>
92
93
  <script>
93
94
  const { Pixel, DEFAULT_PIXEL_CONFIG } = window.PixelV2;
94
95
  </script>
95
96
  ```
96
97
 
97
- Global oficial: **`window.PixelV2`**. Prefira tarball fixo `0.1.0-rc.5` em testes reprodutíveis.
98
-
99
- ## Package exports
100
-
101
- | Export | Uso |
102
- |--------|-----|
103
- | `@beworke/pixel` | Entry principal |
104
- | `@beworke/pixel/global` | IIFE |
105
- | `@beworke/pixel/v2` | Alias |
106
- | `@beworke/pixel/config`, `/events`, `/services`, `/runtime`, `/logger` | Avançado |
107
-
108
- Não existe `@beworke/pixel/diagnostics` no RC.
98
+ Global oficial: **`window.PixelV2`**.
109
99
 
110
100
  ## Limitações do RC
111
101
 
112
- - **Sem Consent Gate / CMP completo** — a aplicação controla quando chamar `init()` ([privacidade](./docs/public/privacy/limitations.md))
113
- - **Não declarar GDPR/LGPD/CCPA compliant** com este RC
102
+ - Sem Consent Gate / CMP completo — a aplicação controla quando chamar `init()`
103
+ - Não declarar GDPR/LGPD/CCPA compliant com este RC
114
104
  - Sem eventos dedicados upsell/downsell — use `VIEW_CONTENT` + `PURCHASE`
115
- - Etapa 21 (Commerce Lifecycle) e Etapa 25 (Privacy) ainda no roadmap
116
-
117
- Lista completa: [docs/public/limitations.md](./docs/public/limitations.md) · [RELEASE_CANDIDATE.md](./RELEASE_CANDIDATE.md)
118
-
119
- ## Validação
120
-
121
- 670 testes passando (2 skipped). Comandos:
122
-
123
- ```bash
124
- npm run type-check && npm test && npm run build
125
- npm run validate:public-docs && npm run validate:public-examples
126
- npm run validate:rc-package
127
- ```
128
-
129
- Matriz: [`PIXEL_V2_VALIDATION_MATRIX.md`](./PIXEL_V2_VALIDATION_MATRIX.md)
130
-
131
- ---
132
-
133
- ## Contribuidores e arquitetura interna
134
105
 
135
- Documentação de engenharia (não necessária para implementar funis):
106
+ Lista: [limitations.md](https://github.com/techionext/Pixel-Global/blob/main/docs/public/limitations.md)
136
107
 
137
- - [`ARCHITECTURE.md`](./ARCHITECTURE.md)
138
- - [`README_LEGACY_AUDIT.md`](./README_LEGACY_AUDIT.md)
139
- - Playgrounds internos: [`examples/html-script/`](./examples/html-script/)
108
+ ## Contribuidores
140
109
 
141
- Migração v1 → v2: `GomarkePixel` → `Pixel`, `window.gomarkePixel` → `window.PixelV2`.
110
+ Arquitetura interna: [ARCHITECTURE.md](https://github.com/techionext/Pixel-Global/blob/main/ARCHITECTURE.md) · Playgrounds: `examples/html-script/` no repositório.