core-outline 1.1.31 → 1.1.33
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 +9 -22
- package/dist/index.es.js +11 -3934
- package/dist/index.js +12 -3935
- package/index.d.ts +15 -0
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ Wrap your app's root component with `<CoreOutline>`. All tracking is automatic f
|
|
|
18
18
|
|
|
19
19
|
```jsx
|
|
20
20
|
import React from 'react';
|
|
21
|
-
import { CoreOutline } from '
|
|
21
|
+
import { CoreOutline } from '@/components/CoreOutlineClient';
|
|
22
22
|
|
|
23
23
|
function App() {
|
|
24
24
|
return (
|
|
@@ -41,7 +41,9 @@ export default App;
|
|
|
41
41
|
|------|------|----------|-------------|
|
|
42
42
|
| `warehouse_id` | `string` | Yes | Your tenant warehouse UUID (returned from the SDK source creation call) |
|
|
43
43
|
| `data_source_id` | `string` | Yes | The UUID of your SDK data source |
|
|
44
|
-
| `data_source_secret` | `string` | Yes | The secret generated at data source creation |
|
|
44
|
+
| `data_source_secret` | `string` | Yes | The secret generated at data source creation. |
|
|
45
|
+
|
|
46
|
+
---
|
|
45
47
|
|
|
46
48
|
## What Gets Tracked Automatically
|
|
47
49
|
|
|
@@ -60,12 +62,12 @@ All events include: `anonymous_id` (persistent across sessions), `session_id` (p
|
|
|
60
62
|
For commerce events, call the exported helpers from anywhere in your app — no props required.
|
|
61
63
|
|
|
62
64
|
```js
|
|
63
|
-
import { flag_item_clicked, flag_item_purchased } from '
|
|
65
|
+
import { flag_item_clicked, flag_item_purchased } from '@/components/CoreOutlineClient';
|
|
64
66
|
|
|
65
67
|
// Track a product click
|
|
66
68
|
flag_item_clicked('sku-123');
|
|
67
69
|
|
|
68
|
-
// Track a purchase (price is optional, maps to value_num in
|
|
70
|
+
// Track a purchase (price is optional, maps to value_num in The Warehouse)
|
|
69
71
|
flag_item_purchased('sku-123', 49.99);
|
|
70
72
|
```
|
|
71
73
|
|
|
@@ -74,11 +76,11 @@ flag_item_purchased('sku-123', 49.99);
|
|
|
74
76
|
Events flow through the following pipeline:
|
|
75
77
|
|
|
76
78
|
```
|
|
77
|
-
Browser → POST /api/ingest/events →
|
|
78
|
-
→ Consumer worker →
|
|
79
|
+
Browser → POST /api/ingest/events → ({warehouse_id}.analytics.events)
|
|
80
|
+
→ Consumer worker → The Warehouse atlas_analytics
|
|
79
81
|
```
|
|
80
82
|
|
|
81
|
-
The
|
|
83
|
+
The The Warehouse tables populated are:
|
|
82
84
|
|
|
83
85
|
| Table | Populated by |
|
|
84
86
|
|-------|-------------|
|
|
@@ -87,18 +89,3 @@ The ClickHouse tables populated are:
|
|
|
87
89
|
| `fact_pageview` | `pageview` events |
|
|
88
90
|
| `stg_events_sdk_event` | All events (raw staging) |
|
|
89
91
|
| `stg_rrweb_event` | Session recording chunks |
|
|
90
|
-
|
|
91
|
-
These tables are queried by the [atlas-analytics](https://analytics.atlas.coreoutline.com) API under `/metrics/saas/traffic`, `/metrics/saas/engagement`, and related endpoints.
|
|
92
|
-
|
|
93
|
-
## Anonymous vs Session Identity
|
|
94
|
-
|
|
95
|
-
- **`anonymous_id`** — a UUID stored in `localStorage`; persists across browser sessions, used to stitch cross-session user journeys.
|
|
96
|
-
- **`session_id`** — a UUID stored in `sessionStorage`; reset on each new tab or browser close, matching the standard session definition.
|
|
97
|
-
|
|
98
|
-
## Service URLs
|
|
99
|
-
|
|
100
|
-
| Service | URL |
|
|
101
|
-
|---------|-----|
|
|
102
|
-
| Hermes API (credential management) | `https://atlas-orchestrator.atlas.coreoutline.com` |
|
|
103
|
-
| Maia (data engineering / pipelines) | `https://data-engineering.atlas.coreoutline.com` |
|
|
104
|
-
| Atlas Analytics API | `https://analytics.atlas.coreoutline.com` |
|