@shware/analytics 14.1.0 → 15.0.1
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 +48 -33
- package/dist/constants/storage.cjs +7 -1
- package/dist/constants/storage.cjs.map +1 -1
- package/dist/constants/storage.d.cts +6 -0
- package/dist/constants/storage.d.cts.map +1 -1
- package/dist/constants/storage.d.mts +6 -0
- package/dist/constants/storage.d.mts.map +1 -1
- package/dist/constants/storage.mjs +7 -1
- package/dist/constants/storage.mjs.map +1 -1
- package/dist/index.cjs +2 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +2 -2
- package/dist/schema/index.cjs +1 -1
- package/dist/schema/index.cjs.map +1 -1
- package/dist/schema/index.mjs +1 -1
- package/dist/schema/index.mjs.map +1 -1
- package/dist/setup/session.cjs +9 -0
- package/dist/setup/session.cjs.map +1 -1
- package/dist/setup/session.d.cts +10 -0
- package/dist/setup/session.d.cts.map +1 -1
- package/dist/setup/session.d.mts +10 -0
- package/dist/setup/session.d.mts.map +1 -1
- package/dist/setup/session.mjs +9 -0
- package/dist/setup/session.mjs.map +1 -1
- package/dist/third-parties/google-analytics.cjs.map +1 -1
- package/dist/third-parties/google-analytics.mjs.map +1 -1
- package/dist/third-parties/posthog.cjs +9 -8
- package/dist/third-parties/posthog.cjs.map +1 -1
- package/dist/third-parties/posthog.d.cts +9 -8
- package/dist/third-parties/posthog.d.cts.map +1 -1
- package/dist/third-parties/posthog.d.mts +9 -8
- package/dist/third-parties/posthog.d.mts.map +1 -1
- package/dist/third-parties/posthog.mjs +9 -8
- package/dist/third-parties/posthog.mjs.map +1 -1
- package/dist/track/gtag.cjs.map +1 -1
- package/dist/track/gtag.d.cts +2 -1
- package/dist/track/gtag.d.cts.map +1 -1
- package/dist/track/gtag.d.mts +2 -1
- package/dist/track/gtag.d.mts.map +1 -1
- package/dist/track/gtag.mjs.map +1 -1
- package/dist/track/index.cjs +117 -67
- package/dist/track/index.cjs.map +1 -1
- package/dist/track/index.d.cts +9 -2
- package/dist/track/index.d.cts.map +1 -1
- package/dist/track/index.d.mts +9 -2
- package/dist/track/index.d.mts.map +1 -1
- package/dist/track/index.mjs +117 -68
- package/dist/track/index.mjs.map +1 -1
- package/dist/visitor/id.cjs +5 -0
- package/dist/visitor/id.cjs.map +1 -1
- package/dist/visitor/id.d.cts +2 -0
- package/dist/visitor/id.d.cts.map +1 -1
- package/dist/visitor/id.d.mts +2 -0
- package/dist/visitor/id.d.mts.map +1 -1
- package/dist/visitor/id.mjs +5 -1
- package/dist/visitor/id.mjs.map +1 -1
- package/dist/visitor/index.cjs +94 -24
- package/dist/visitor/index.cjs.map +1 -1
- package/dist/visitor/index.d.cts +35 -8
- package/dist/visitor/index.d.cts.map +1 -1
- package/dist/visitor/index.d.mts +35 -8
- package/dist/visitor/index.d.mts.map +1 -1
- package/dist/visitor/index.mjs +95 -26
- package/dist/visitor/index.mjs.map +1 -1
- package/dist/visitor/types.d.cts +3 -19
- package/dist/visitor/types.d.cts.map +1 -1
- package/dist/visitor/types.d.mts +3 -19
- package/dist/visitor/types.d.mts.map +1 -1
- package/package.json +1 -1
package/dist/track/index.mjs
CHANGED
|
@@ -61,8 +61,8 @@ let timer = null;
|
|
|
61
61
|
* up on, as it was when it ran after the server's answer. Never more than once: a pixel's global
|
|
62
62
|
* either exists by then or the script is blocked.
|
|
63
63
|
*/
|
|
64
|
-
function firePixels(event) {
|
|
65
|
-
if (
|
|
64
|
+
function firePixels({ event, options }) {
|
|
65
|
+
if (options.enableThirdPartyTracking === false || IGNORED_EVENTS.includes(event.name)) return;
|
|
66
66
|
const notReady = callTrackers(config.thirdPartyTrackers, event);
|
|
67
67
|
if (notReady.length === 0) return;
|
|
68
68
|
setTimeout(() => callTrackers(notReady, event), 0);
|
|
@@ -79,6 +79,33 @@ function callTrackers(trackers, event) {
|
|
|
79
79
|
});
|
|
80
80
|
}
|
|
81
81
|
/**
|
|
82
|
+
* What an event shares with every other event of the moment it happens: the visitor, the session,
|
|
83
|
+
* the time and the client, with the last built tags until the event's own are captured.
|
|
84
|
+
*/
|
|
85
|
+
function context(session_id, timestamp = (/* @__PURE__ */ new Date()).toISOString()) {
|
|
86
|
+
return {
|
|
87
|
+
visitor_id: visitorId(),
|
|
88
|
+
session_id,
|
|
89
|
+
timestamp,
|
|
90
|
+
platform: config.platform,
|
|
91
|
+
environment: config.environment,
|
|
92
|
+
tags: cache.tags ?? {}
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
/** Queues the event, its tags to be filled in once `tags` settles. */
|
|
96
|
+
function push(event, tags, options) {
|
|
97
|
+
const item = {
|
|
98
|
+
event,
|
|
99
|
+
tagged: tags.then((settled) => {
|
|
100
|
+
event.tags = settled;
|
|
101
|
+
}),
|
|
102
|
+
options
|
|
103
|
+
};
|
|
104
|
+
list.push(item);
|
|
105
|
+
return item;
|
|
106
|
+
}
|
|
107
|
+
const silent = { enableThirdPartyTracking: false };
|
|
108
|
+
/**
|
|
82
109
|
* Queues an event, preceded by a `session_start` when it is the one that opens a session, and
|
|
83
110
|
* fires its third-party trackers.
|
|
84
111
|
*
|
|
@@ -91,46 +118,44 @@ function callTrackers(trackers, event) {
|
|
|
91
118
|
*/
|
|
92
119
|
function enqueue(name, properties, options, init = {}) {
|
|
93
120
|
const timestamp = (/* @__PURE__ */ new Date()).toISOString();
|
|
94
|
-
const tags = captureTags();
|
|
95
121
|
const { id: session_id, started } = getSession().touch(Date.parse(timestamp));
|
|
96
|
-
const
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
timestamp,
|
|
101
|
-
session_id
|
|
102
|
-
};
|
|
103
|
-
tags.then((settled) => result.settled = settled);
|
|
104
|
-
return result;
|
|
105
|
-
};
|
|
106
|
-
if (started) list.push(item({
|
|
122
|
+
const at = context(session_id, timestamp);
|
|
123
|
+
const tags = captureTags();
|
|
124
|
+
if (started) push({
|
|
125
|
+
...at,
|
|
107
126
|
id: v7(),
|
|
108
127
|
name: "session_start",
|
|
109
|
-
properties: {}
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
128
|
+
properties: {}
|
|
129
|
+
}, tags, silent);
|
|
130
|
+
const item = push({
|
|
131
|
+
...at,
|
|
113
132
|
id: init.id ?? v7(),
|
|
114
133
|
name,
|
|
115
|
-
properties
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
if (init.pixels !== false) firePixels(event);
|
|
120
|
-
return event;
|
|
134
|
+
properties
|
|
135
|
+
}, tags, options);
|
|
136
|
+
if (init.pixels !== false) firePixels(item);
|
|
137
|
+
return item;
|
|
121
138
|
}
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
139
|
+
/**
|
|
140
|
+
* Ends the current session for `reset()`. What it accrued and has not reported goes out as a
|
|
141
|
+
* `user_engagement`, as when the page is closed, and the queue is sent. Synchronous: every queued
|
|
142
|
+
* event already carries its visitor and session, so the caller can replace the visitor right after.
|
|
143
|
+
*/
|
|
144
|
+
function endSession() {
|
|
145
|
+
const { id, engagement_time_msec } = getSession().end();
|
|
146
|
+
if (id && engagement_time_msec > 0) {
|
|
147
|
+
const properties = {
|
|
148
|
+
engagement_time_msec,
|
|
149
|
+
trigger: "reset"
|
|
150
|
+
};
|
|
151
|
+
push({
|
|
152
|
+
...context(id),
|
|
153
|
+
id: v7(),
|
|
154
|
+
name: "user_engagement",
|
|
155
|
+
properties
|
|
156
|
+
}, captureTags(), silent);
|
|
157
|
+
}
|
|
158
|
+
if (list.length > 0) flush();
|
|
134
159
|
}
|
|
135
160
|
/**
|
|
136
161
|
* Sends the queue. Everything that has to be awaited is awaited first, and only then are the
|
|
@@ -143,16 +168,33 @@ async function flush() {
|
|
|
143
168
|
timer = null;
|
|
144
169
|
}
|
|
145
170
|
if (list.length === 0) return;
|
|
146
|
-
let
|
|
171
|
+
let headers;
|
|
147
172
|
try {
|
|
148
173
|
await getTokenBucket().removeTokens();
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
174
|
+
headers = await config.getHeaders();
|
|
175
|
+
await Promise.all(list.map((item) => item.tagged));
|
|
176
|
+
} catch (e) {
|
|
177
|
+
if (e instanceof Error) console.log(e.message);
|
|
178
|
+
return;
|
|
179
|
+
}
|
|
180
|
+
await Promise.all(byVisitor(list.splice(0)).map((batch) => send(batch, headers)));
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* The items grouped by the visitor they were tracked under, each group in queue order. Not
|
|
184
|
+
* `Map.groupBy`: it is ES2024, missing from Safari before 17.4 and from Hermes before V1.
|
|
185
|
+
*/
|
|
186
|
+
function byVisitor(items) {
|
|
187
|
+
const groups = /* @__PURE__ */ new Map();
|
|
188
|
+
for (const item of items) {
|
|
189
|
+
const { visitor_id } = item.event;
|
|
190
|
+
groups.set(visitor_id, [...groups.get(visitor_id) ?? [], item]);
|
|
191
|
+
}
|
|
192
|
+
return [...groups.values()];
|
|
193
|
+
}
|
|
194
|
+
/** One visitor's batch, as one request. */
|
|
195
|
+
async function send(items, headers) {
|
|
196
|
+
try {
|
|
197
|
+
const body = JSON.stringify(items.map((item) => item.event));
|
|
156
198
|
const response = await fetch(`${config.endpoint}/events`, {
|
|
157
199
|
method: "POST",
|
|
158
200
|
credentials: "include",
|
|
@@ -162,14 +204,24 @@ async function flush() {
|
|
|
162
204
|
body
|
|
163
205
|
});
|
|
164
206
|
if (!response.ok) throw new Error(`Failed to send track event: ${response.status} ${await response.text()}`);
|
|
165
|
-
|
|
207
|
+
items.forEach(({ event, options }) => options.onSucceed?.({ id: event.id }));
|
|
166
208
|
} catch (e) {
|
|
167
209
|
if (e instanceof Error) console.log(e.message);
|
|
168
|
-
|
|
169
|
-
list.unshift(...starts);
|
|
170
|
-
events.filter((event) => event.name !== "session_start").forEach((event) => event.options.onError?.(e));
|
|
210
|
+
fail(items, e);
|
|
171
211
|
}
|
|
172
212
|
}
|
|
213
|
+
/**
|
|
214
|
+
* `fetch` has already retried the transient failures by the time a batch fails; what remains is a
|
|
215
|
+
* batch the server rejected outright — one invalid event fails the whole batch — or a network that
|
|
216
|
+
* stayed down past the retries. The other events are reported lost; `session_start` alone goes
|
|
217
|
+
* back on the queue for the next send, because it is the session's only attribution record: a
|
|
218
|
+
* session without one has no channel, and its every later event drops out of an attribution join.
|
|
219
|
+
*/
|
|
220
|
+
function fail(items, e) {
|
|
221
|
+
const isStart = (item) => item.event.name === "session_start";
|
|
222
|
+
list.unshift(...items.filter(isStart));
|
|
223
|
+
items.filter((item) => !isStart(item)).forEach((item) => item.options.onError?.(e));
|
|
224
|
+
}
|
|
173
225
|
/** `track`, with the `EventInit` only the SDK itself passes. */
|
|
174
226
|
function queueEvent(name, properties, options, init) {
|
|
175
227
|
enqueue(name, properties, options, init);
|
|
@@ -200,42 +252,39 @@ function beacon(dto) {
|
|
|
200
252
|
* Nothing can be awaited here, so the events go with the tags they have settled on (the last
|
|
201
253
|
* built ones otherwise). Each goes with the id it was tracked with, and its third-party trackers
|
|
202
254
|
* were fired then, under that id: none is fired again here. The visitor id is local
|
|
203
|
-
* (`visitorId`), so a first visit left within a second is sent like any other
|
|
204
|
-
*
|
|
255
|
+
* (`visitorId`), so a first visit left within a second is sent like any other. One beacon per
|
|
256
|
+
* visitor, as one request per visitor in `flush`; a visitor's events no beacon can take — no
|
|
257
|
+
* `sendBeacon`, a refused body — stay queued for the usual send.
|
|
205
258
|
*/
|
|
206
259
|
function sendPendingEvents() {
|
|
207
260
|
if (list.length === 0) return;
|
|
208
|
-
const visitor_id = visitorId();
|
|
209
|
-
if (!beacon(list.map((event) => toDTO(event, visitor_id, event.settled ?? cache.tags ?? {})))) {
|
|
210
|
-
flush();
|
|
211
|
-
return;
|
|
212
|
-
}
|
|
213
261
|
if (timer) {
|
|
214
262
|
clearTimeout(timer);
|
|
215
263
|
timer = null;
|
|
216
264
|
}
|
|
217
|
-
list.splice(0).forEach((
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
265
|
+
byVisitor(list.splice(0)).forEach((batch) => {
|
|
266
|
+
if (!beacon(batch.map((item) => item.event))) {
|
|
267
|
+
list.push(...batch);
|
|
268
|
+
return;
|
|
269
|
+
}
|
|
270
|
+
batch.forEach(({ event, options }) => options.onSucceed?.({
|
|
271
|
+
id: event.id,
|
|
272
|
+
beacon: true
|
|
273
|
+
}));
|
|
274
|
+
});
|
|
275
|
+
if (list.length > 0) flush();
|
|
221
276
|
}
|
|
222
277
|
function sendBeacon(name, properties) {
|
|
223
|
-
const visitor_id = visitorId();
|
|
224
278
|
const session_id = getSession().extend();
|
|
225
279
|
if (!session_id) return;
|
|
226
280
|
if (beacon([{
|
|
281
|
+
...context(session_id),
|
|
227
282
|
id: v7(),
|
|
228
283
|
name,
|
|
229
|
-
properties
|
|
230
|
-
tags: cache.tags ?? {},
|
|
231
|
-
visitor_id,
|
|
232
|
-
session_id,
|
|
233
|
-
platform: config.platform,
|
|
234
|
-
environment: config.environment,
|
|
235
|
-
timestamp: (/* @__PURE__ */ new Date()).toISOString()
|
|
284
|
+
properties
|
|
236
285
|
}])) return;
|
|
237
286
|
console.warn("Failed to send beacon", name, properties);
|
|
238
287
|
}
|
|
239
|
-
export { queueEvent, sendBeacon, sendPendingEvents, track };
|
|
288
|
+
export { endSession, queueEvent, sendBeacon, sendPendingEvents, track };
|
|
240
289
|
|
|
241
290
|
//# sourceMappingURL=index.mjs.map
|
package/dist/track/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["uuidv7"],"sources":["../../src/track/index.ts"],"sourcesContent":["import { TokenBucket, fetch } from '@shware/utils';\nimport { v7 as uuidv7 } from 'uuid';\nimport type { CreateTrackEventDTO } from '../schema/index';\nimport { cache, config } from '../setup/index';\nimport { getSession } from '../setup/session';\nimport { IGNORED_EVENTS } from '../third-parties/ignored-events';\nimport { visitorId } from '../visitor/id';\nimport type {\n EventName,\n ThirdPartyTracker,\n TrackEventResponse,\n TrackName,\n TrackProperties,\n TrackTags,\n} from './types';\n\nexport interface TrackOptions {\n enableThirdPartyTracking?: boolean;\n /**\n * Called once the server (or a beacon) has taken the event, with the event's id: the one\n * generated when it was tracked, which the third-party trackers were given too. `beacon` is\n * set when the event went by `sendPendingEvents`: the browser queued it, but a beacon cannot\n * tell delivered from dropped, so it is taken, not confirmed.\n */\n onSucceed?: (response?: TrackEventResponse[number] & { beacon?: true }) => void;\n onError?: (error: unknown) => void;\n}\n\nconst defaultOptions: TrackOptions = {};\n\nlet tokenBucket: TokenBucket | undefined;\n\n/**\n * The rate limiter, built on the first send rather than at module scope: its\n * constructor starts a refill `setInterval`, and Cloudflare Workers refuse to\n * set a timer outside a request handler for the same reason they refuse to\n * generate random values there — see `setup/session.ts`.\n */\nfunction getTokenBucket() {\n return (tokenBucket ??= new TokenBucket({ rate: 1, capacity: 20, requested: 2 }));\n}\n\ntype Item = {\n /**\n * The event's id, a uuidv7 generated when it is tracked. The server stores the event under it\n * (`on conflict (id) do nothing`, so a batch `fetch` retries is not stored twice), and the\n * third-party trackers are given it at once as their deduplication id — the id the server's\n * conversions API sends again for the same event.\n */\n id: string;\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n name: TrackName<any>;\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n properties: TrackProperties<any>;\n tags: Promise<TrackTags>;\n /** `tags` once settled: a page being hidden can await nothing, and sends what it has. */\n settled?: TrackTags;\n /** Decided when the event happens, as GA4 and PostHog decide it, never when it is sent. */\n session_id: string;\n timestamp: string;\n options: TrackOptions;\n};\n\n/**\n * How an event is created, for the SDK's own callers (`trackOnce`); not exported from the\n * package. `id` carries over the id of an earlier attempt at the same occurrence, and\n * `pixels: false` skips the third-party trackers that attempt has already fired.\n */\nexport interface EventInit {\n id?: string;\n pixels?: boolean;\n}\n\n/**\n * Tags belong to the moment the event happened, not to the moment its batch goes out: a queued\n * event waits up to `delay` ms, and a single page app can navigate in that window, which would\n * stamp every pending event with the URL of the page the user has already left.\n *\n * The promise then sits in the queue with nothing awaiting it, so a failure has to be absorbed\n * here — an unhandled rejection would surface as a global error long before `sendEvents` could\n * catch it. Falling back to the last built tags keeps the event, minus whatever changed since.\n */\nasync function captureTags(): Promise<TrackTags> {\n try {\n return await config.getTags();\n } catch (e: unknown) {\n if (e instanceof Error) console.log(e.message);\n return cache.tags ?? {};\n }\n}\n\n/**\n * The events not yet sent, and the only place they are: a batch leaves it at the moment it is\n * handed to `fetch` or to a beacon, never earlier. So when the page is hidden or left,\n * everything still unsent is right here for `sendPendingEvents`.\n */\nconst list: Item[] = [];\nconst batchSize = 10;\nconst delay = 2000;\nlet timer: ReturnType<typeof setTimeout> | null = null;\n\n/**\n * Hands the event to the third-party trackers now, as it is tracked, under its own id — not once\n * the server has answered. An event followed by a full-page navigation (an outbound link,\n * `begin_checkout` before the redirect to the payment page, a landing page left at once) reaches\n * the pixels before the page goes, and the server's conversions API, sending the same id, still\n * deduplicates against the browser event. A server that is down no longer takes the pixels down\n * with it either.\n *\n * A tracker that returns `false` is not ready — its pixel's global is not on the page yet, the\n * snippet still loading (the first `page_view` of a visit is tracked right as the page mounts).\n * Those trackers, and only those, are called once more on the next macrotask, with the same event\n * and id, after the inline snippets have had their turn; a tracker still not ready then is given\n * up on, as it was when it ran after the server's answer. Never more than once: a pixel's global\n * either exists by then or the script is blocked.\n */\nfunction firePixels(event: Item) {\n // An explicit false, not falsiness: a caller passing `{ onSucceed }` replaces the options\n // object wholesale, and leaving the flag out must not silently switch forwarding off.\n if (event.options.enableThirdPartyTracking === false || IGNORED_EVENTS.includes(event.name)) {\n return;\n }\n const notReady = callTrackers(config.thirdPartyTrackers, event);\n if (notReady.length === 0) return;\n setTimeout(() => callTrackers(notReady, event), 0);\n}\n\n/** Calls each tracker with the event; returns the ones that said they were not ready. */\nfunction callTrackers(trackers: ThirdPartyTracker[], event: Item): ThirdPartyTracker[] {\n return trackers.filter((tracker) => {\n try {\n return tracker(event.name, event.properties, event.id) === false;\n } catch (e: unknown) {\n // A third-party script does not get to take the tracking call, or the other trackers, with it.\n if (e instanceof Error) console.log(e.message);\n return false;\n }\n });\n}\n\n/**\n * Queues an event, preceded by a `session_start` when it is the one that opens a session, and\n * fires its third-party trackers.\n *\n * The session is decided here, when the event happens, as GA4 and PostHog decide it: the\n * `session_start` then sits in the queue right before the event that opened the session, so\n * wherever that event goes — a batch, a beacon, a retry — its announcement has gone ahead of it.\n * It carries that event's tags and time, as GA4 derives it from the hit that started the\n * session: the landing page is where the session began, whatever the page has navigated to by\n * the time the batch goes out.\n */\nfunction enqueue(\n name: Item['name'],\n properties: Item['properties'],\n options: TrackOptions,\n init: EventInit = {}\n): Item {\n const timestamp = new Date().toISOString();\n const tags = captureTags();\n const { id: session_id, started } = getSession().touch(Date.parse(timestamp));\n const item = (fields: Pick<Item, 'id' | 'name' | 'properties' | 'options'>): Item => {\n const result: Item = { ...fields, tags, timestamp, session_id };\n void tags.then((settled) => (result.settled = settled));\n return result;\n };\n if (started) {\n const options = { enableThirdPartyTracking: false };\n list.push(item({ id: uuidv7(), name: 'session_start', properties: {}, options }));\n }\n const event = item({ id: init.id ?? uuidv7(), name, properties, options });\n list.push(event);\n if (init.pixels !== false) firePixels(event);\n return event;\n}\n\nfunction toDTO(event: Item, visitor_id: string, tags: TrackTags): CreateTrackEventDTO[number] {\n return {\n id: event.id,\n name: event.name,\n properties: event.properties,\n tags,\n visitor_id,\n session_id: event.session_id,\n platform: config.platform,\n environment: config.environment,\n timestamp: event.timestamp,\n };\n}\n\n/**\n * Sends the queue. Everything that has to be awaited is awaited first, and only then are the\n * events taken off the queue and handed to `fetch` in the same synchronous step — so there is\n * no moment at which an event is neither queued nor sent.\n */\nasync function flush() {\n if (timer) {\n clearTimeout(timer);\n timer = null;\n }\n if (list.length === 0) return;\n\n let events: Item[] = [];\n try {\n await getTokenBucket().removeTokens();\n const visitor_id = visitorId();\n const headers = await config.getHeaders();\n // Settled before the events leave the queue; those queued meanwhile are a microtask away.\n await Promise.all(list.map((event) => event.tags));\n\n events = list.splice(0);\n if (events.length === 0) return;\n const dto: CreateTrackEventDTO = await Promise.all(\n events.map(async (event) => toDTO(event, visitor_id, await event.tags))\n );\n\n const body = JSON.stringify(dto);\n const response = await fetch(`${config.endpoint}/events`, {\n method: 'POST',\n credentials: 'include',\n // Retried although a POST: every event carries its client-generated id, and the server stores\n // a batch it already has `on conflict (id) do nothing`.\n retries: 3,\n // keepalive lets the request survive the page being unloaded mid-flight, within a 64KB\n // budget shared by every such request of the page; a body that could not fit goes as a\n // plain POST rather than failing outright.\n keepalive: body.length < 60_000,\n headers,\n body,\n });\n\n if (!response.ok) {\n throw new Error(`Failed to send track event: ${response.status} ${await response.text()}`);\n }\n\n // The body is not read. Every event has had its id since it was tracked, and its trackers\n // were fired with it then. Servers still answer one `{ id }` per event (`TrackEventResponse`),\n // which a server predating client ids fills with ids of its own; neither is needed here, and\n // an answer that is not even JSON does not turn a stored batch into a failure.\n events.forEach((event) => event.options.onSucceed?.({ id: event.id }));\n } catch (e: unknown) {\n if (e instanceof Error) console.log(e.message);\n // `fetch` has already retried the transient failures by the time a batch fails here; what\n // remains is a batch the server rejected outright — one invalid event fails the whole batch\n // — or a network that stayed down past the retries. The other events are reported lost;\n // `session_start` alone goes back on the queue for the next send, because it is the\n // session's only attribution record: a session without one has no channel, and its every\n // later event drops out of an attribution join.\n const starts = events.filter((event) => event.name === 'session_start');\n list.unshift(...starts);\n events\n .filter((event) => event.name !== 'session_start')\n .forEach((event) => event.options.onError?.(e));\n }\n}\n\n/** `track`, with the `EventInit` only the SDK itself passes. */\nexport function queueEvent<T extends EventName = EventName>(\n name: TrackName<T>,\n properties: TrackProperties<T> | undefined,\n options: TrackOptions,\n init?: EventInit\n) {\n enqueue(name, properties, options, init);\n if (list.length >= batchSize) {\n void flush();\n return;\n }\n if (timer) clearTimeout(timer);\n timer = setTimeout(() => void flush(), delay);\n}\n\n/**\n * Queues the event for the next batch — up to 2 s away, at once when the batch is full — and\n * hands it to the third-party trackers now, under the id it is sent with.\n */\nexport function track<T extends EventName = EventName>(\n name: TrackName<T>,\n properties?: TrackProperties<T>,\n options: TrackOptions = defaultOptions\n) {\n queueEvent(name, properties, options);\n}\n\nfunction beacon(dto: CreateTrackEventDTO): boolean {\n // Not every runtime with a `navigator` has it: React Native has neither beacons nor pages.\n if (typeof navigator === 'undefined' || !('sendBeacon' in navigator)) return false;\n // text/plain keeps a cross-origin beacon a CORS simple request: as application/json it needs a\n // preflight, which a page being closed often cannot complete, and the beacon is then dropped.\n // The server reads it as JSON (`zBeaconJson` in @shware/http).\n const blob = new Blob([JSON.stringify(dto)], { type: 'text/plain;charset=UTF-8' });\n return navigator.sendBeacon(`${config.endpoint}/events`, blob);\n}\n\n/**\n * Sends the queue by beacon, now: for when the page is hidden or left, the last moment its\n * script is sure to run — what PostHog's `requestQueue.unload()` and GA4 do on the same events.\n * Call it before the engagement beacon: a new session's `session_start` is in this queue.\n *\n * Nothing can be awaited here, so the events go with the tags they have settled on (the last\n * built ones otherwise). Each goes with the id it was tracked with, and its third-party trackers\n * were fired then, under that id: none is fired again here. The visitor id is local\n * (`visitorId`), so a first visit left within a second is sent like any other; when no beacon\n * can take them — no `sendBeacon`, a refused body — they stay queued for the usual send.\n */\nexport function sendPendingEvents() {\n if (list.length === 0) return;\n const visitor_id = visitorId();\n const dto: CreateTrackEventDTO = list.map((event) =>\n toDTO(event, visitor_id, event.settled ?? cache.tags ?? {})\n );\n if (!beacon(dto)) {\n void flush();\n return;\n }\n if (timer) {\n clearTimeout(timer);\n timer = null;\n }\n list.splice(0).forEach((event) => event.options.onSucceed?.({ id: event.id, beacon: true }));\n}\n\nexport function sendBeacon<T extends EventName = EventName>(\n name: TrackName<T>,\n properties?: TrackProperties<T>\n) {\n const visitor_id = visitorId();\n // No stored session means no event was ever queued from this storage, so there is no session\n // to report for — and one started here could never be announced. See `Session.extend`.\n const session_id = getSession().extend();\n if (!session_id) return;\n\n const dto: CreateTrackEventDTO = [\n {\n id: uuidv7(),\n name,\n properties,\n // Tags are worth less than the event carrying them: an empty set still reports the\n // engagement, and every field in `tagsSchema` is optional.\n tags: cache.tags ?? {},\n visitor_id,\n session_id,\n platform: config.platform,\n environment: config.environment,\n timestamp: new Date().toISOString(),\n },\n ];\n if (beacon(dto)) return;\n console.warn('Failed to send beacon', name, properties);\n}\n"],"mappings":";;;;;;;AA4BA,MAAM,iBAA+B,CAAC;AAEtC,IAAI;;;;;;;AAQJ,SAAS,iBAAiB;CACxB,OAAQ,gBAAgB,IAAI,YAAY;EAAE,MAAM;EAAG,UAAU;EAAI,WAAW;CAAE,CAAC;AACjF;;;;;;;;;;AA0CA,eAAe,cAAkC;CAC/C,IAAI;EACF,OAAO,MAAM,OAAO,QAAQ;CAC9B,SAAS,GAAY;EACnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC7C,OAAO,MAAM,QAAQ,CAAC;CACxB;AACF;;;;;;AAOA,MAAM,OAAe,CAAC;AACtB,MAAM,YAAY;AAClB,MAAM,QAAQ;AACd,IAAI,QAA8C;;;;;;;;;;;;;;;;AAiBlD,SAAS,WAAW,OAAa;CAG/B,IAAI,MAAM,QAAQ,6BAA6B,SAAS,eAAe,SAAS,MAAM,IAAI,GACxF;CAEF,MAAM,WAAW,aAAa,OAAO,oBAAoB,KAAK;CAC9D,IAAI,SAAS,WAAW,GAAG;CAC3B,iBAAiB,aAAa,UAAU,KAAK,GAAG,CAAC;AACnD;;AAGA,SAAS,aAAa,UAA+B,OAAkC;CACrF,OAAO,SAAS,QAAQ,YAAY;EAClC,IAAI;GACF,OAAO,QAAQ,MAAM,MAAM,MAAM,YAAY,MAAM,EAAE,MAAM;EAC7D,SAAS,GAAY;GAEnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;GAC7C,OAAO;EACT;CACF,CAAC;AACH;;;;;;;;;;;;AAaA,SAAS,QACP,MACA,YACA,SACA,OAAkB,CAAC,GACb;CACN,MAAM,6BAAY,IAAI,KAAK,EAAA,CAAE,YAAY;CACzC,MAAM,OAAO,YAAY;CACzB,MAAM,EAAE,IAAI,YAAY,YAAY,WAAW,CAAC,CAAC,MAAM,KAAK,MAAM,SAAS,CAAC;CAC5E,MAAM,QAAQ,WAAuE;EACnF,MAAM,SAAe;GAAE,GAAG;GAAQ;GAAM;GAAW;EAAW;EAC9D,KAAU,MAAM,YAAa,OAAO,UAAU,OAAQ;EACtD,OAAO;CACT;CACA,IAAI,SAEF,KAAK,KAAK,KAAK;EAAE,IAAIA,GAAO;EAAG,MAAM;EAAiB,YAAY,CAAC;EAAG,SAAA,EADpD,0BAA0B,MACgC;CAAE,CAAC,CAAC;CAElF,MAAM,QAAQ,KAAK;EAAE,IAAI,KAAK,MAAMA,GAAO;EAAG;EAAM;EAAY;CAAQ,CAAC;CACzE,KAAK,KAAK,KAAK;CACf,IAAI,KAAK,WAAW,OAAO,WAAW,KAAK;CAC3C,OAAO;AACT;AAEA,SAAS,MAAM,OAAa,YAAoB,MAA8C;CAC5F,OAAO;EACL,IAAI,MAAM;EACV,MAAM,MAAM;EACZ,YAAY,MAAM;EAClB;EACA;EACA,YAAY,MAAM;EAClB,UAAU,OAAO;EACjB,aAAa,OAAO;EACpB,WAAW,MAAM;CACnB;AACF;;;;;;AAOA,eAAe,QAAQ;CACrB,IAAI,OAAO;EACT,aAAa,KAAK;EAClB,QAAQ;CACV;CACA,IAAI,KAAK,WAAW,GAAG;CAEvB,IAAI,SAAiB,CAAC;CACtB,IAAI;EACF,MAAM,eAAe,CAAC,CAAC,aAAa;EACpC,MAAM,aAAa,UAAU;EAC7B,MAAM,UAAU,MAAM,OAAO,WAAW;EAExC,MAAM,QAAQ,IAAI,KAAK,KAAK,UAAU,MAAM,IAAI,CAAC;EAEjD,SAAS,KAAK,OAAO,CAAC;EACtB,IAAI,OAAO,WAAW,GAAG;EACzB,MAAM,MAA2B,MAAM,QAAQ,IAC7C,OAAO,IAAI,OAAO,UAAU,MAAM,OAAO,YAAY,MAAM,MAAM,IAAI,CAAC,CACxE;EAEA,MAAM,OAAO,KAAK,UAAU,GAAG;EAC/B,MAAM,WAAW,MAAM,MAAM,GAAG,OAAO,SAAS,UAAU;GACxD,QAAQ;GACR,aAAa;GAGb,SAAS;GAIT,WAAW,KAAK,SAAS;GACzB;GACA;EACF,CAAC;EAED,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,+BAA+B,SAAS,OAAO,GAAG,MAAM,SAAS,KAAK,GAAG;EAO3F,OAAO,SAAS,UAAU,MAAM,QAAQ,YAAY,EAAE,IAAI,MAAM,GAAG,CAAC,CAAC;CACvE,SAAS,GAAY;EACnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAO7C,MAAM,SAAS,OAAO,QAAQ,UAAU,MAAM,SAAS,eAAe;EACtE,KAAK,QAAQ,GAAG,MAAM;EACtB,OACG,QAAQ,UAAU,MAAM,SAAS,eAAe,CAAC,CACjD,SAAS,UAAU,MAAM,QAAQ,UAAU,CAAC,CAAC;CAClD;AACF;;AAGA,SAAgB,WACd,MACA,YACA,SACA,MACA;CACA,QAAQ,MAAM,YAAY,SAAS,IAAI;CACvC,IAAI,KAAK,UAAU,WAAW;EAC5B,MAAW;EACX;CACF;CACA,IAAI,OAAO,aAAa,KAAK;CAC7B,QAAQ,iBAAiB,KAAK,MAAM,GAAG,KAAK;AAC9C;;;;;AAMA,SAAgB,MACd,MACA,YACA,UAAwB,gBACxB;CACA,WAAW,MAAM,YAAY,OAAO;AACtC;AAEA,SAAS,OAAO,KAAmC;CAEjD,IAAI,OAAO,cAAc,eAAe,EAAE,gBAAgB,YAAY,OAAO;CAI7E,MAAM,OAAO,IAAI,KAAK,CAAC,KAAK,UAAU,GAAG,CAAC,GAAG,EAAE,MAAM,2BAA2B,CAAC;CACjF,OAAO,UAAU,WAAW,GAAG,OAAO,SAAS,UAAU,IAAI;AAC/D;;;;;;;;;;;;AAaA,SAAgB,oBAAoB;CAClC,IAAI,KAAK,WAAW,GAAG;CACvB,MAAM,aAAa,UAAU;CAI7B,IAAI,CAAC,OAH4B,KAAK,KAAK,UACzC,MAAM,OAAO,YAAY,MAAM,WAAW,MAAM,QAAQ,CAAC,CAAC,CAE9C,CAAC,GAAG;EAChB,MAAW;EACX;CACF;CACA,IAAI,OAAO;EACT,aAAa,KAAK;EAClB,QAAQ;CACV;CACA,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,UAAU,MAAM,QAAQ,YAAY;EAAE,IAAI,MAAM;EAAI,QAAQ;CAAK,CAAC,CAAC;AAC7F;AAEA,SAAgB,WACd,MACA,YACA;CACA,MAAM,aAAa,UAAU;CAG7B,MAAM,aAAa,WAAW,CAAC,CAAC,OAAO;CACvC,IAAI,CAAC,YAAY;CAiBjB,IAAI,OAAO,CAdT;EACE,IAAIA,GAAO;EACX;EACA;EAGA,MAAM,MAAM,QAAQ,CAAC;EACrB;EACA;EACA,UAAU,OAAO;EACjB,aAAa,OAAO;EACpB,4BAAW,IAAI,KAAK,EAAA,CAAE,YAAY;CACpC,CAEW,CAAC,GAAG;CACjB,QAAQ,KAAK,yBAAyB,MAAM,UAAU;AACxD"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["uuidv7"],"sources":["../../src/track/index.ts"],"sourcesContent":["import { TokenBucket, fetch } from '@shware/utils';\nimport { v7 as uuidv7 } from 'uuid';\nimport type { CreateTrackEventDTO } from '../schema/index';\nimport { cache, config } from '../setup/index';\nimport { getSession } from '../setup/session';\nimport { IGNORED_EVENTS } from '../third-parties/ignored-events';\nimport { visitorId } from '../visitor/id';\nimport type {\n EventName,\n ThirdPartyTracker,\n TrackEventResponse,\n TrackName,\n TrackProperties,\n TrackTags,\n} from './types';\n\nexport interface TrackOptions {\n enableThirdPartyTracking?: boolean;\n /**\n * Called once the server (or a beacon) has taken the event, with the event's id: the one\n * generated when it was tracked, which the third-party trackers were given too. `beacon` is\n * set when the event went by `sendPendingEvents`: the browser queued it, but a beacon cannot\n * tell delivered from dropped, so it is taken, not confirmed.\n */\n onSucceed?: (response?: TrackEventResponse[number] & { beacon?: true }) => void;\n onError?: (error: unknown) => void;\n}\n\nconst defaultOptions: TrackOptions = {};\n\nlet tokenBucket: TokenBucket | undefined;\n\n/**\n * The rate limiter, built on the first send rather than at module scope: its\n * constructor starts a refill `setInterval`, and Cloudflare Workers refuse to\n * set a timer outside a request handler for the same reason they refuse to\n * generate random values there — see `setup/session.ts`.\n */\nfunction getTokenBucket() {\n return (tokenBucket ??= new TokenBucket({ rate: 1, capacity: 20, requested: 2 }));\n}\n\n/**\n * An event as the server takes it, one element of a `POST /events` batch — with the id the SDK\n * always generates, and the name and properties as `track` types them.\n */\ntype TrackEvent = Omit<CreateTrackEventDTO[number], 'id' | 'name' | 'properties'> & {\n id: string;\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n name: TrackName<any>;\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n properties: TrackProperties<any>;\n};\n\ntype Item = {\n /**\n * The event as it is sent, complete from the moment it is tracked: its id (a uuidv7 the server\n * stores it under, `on conflict (id) do nothing`, and the deduplication id the third-party\n * trackers are given at once), and the visitor, session and time it happened in — decided then,\n * as GA4 and PostHog decide them, never when the batch goes out. `reset()` replaces the visitor\n * and session, and an event tracked before it still belongs to the ones it happened in.\n *\n * `tags` starts as the last built tags and is replaced by the event's own once they are\n * captured (`tagged`): a page being hidden can await nothing, and sends what it has.\n */\n event: TrackEvent;\n tagged: Promise<void>;\n options: TrackOptions;\n};\n\n/**\n * How an event is created, for the SDK's own callers (`trackOnce`); not exported from the\n * package. `id` carries over the id of an earlier attempt at the same occurrence, and\n * `pixels: false` skips the third-party trackers that attempt has already fired.\n */\nexport interface EventInit {\n id?: string;\n pixels?: boolean;\n}\n\n/**\n * Tags belong to the moment the event happened, not to the moment its batch goes out: a queued\n * event waits up to `delay` ms, and a single page app can navigate in that window, which would\n * stamp every pending event with the URL of the page the user has already left.\n *\n * The promise then sits in the queue with nothing awaiting it, so a failure has to be absorbed\n * here — an unhandled rejection would surface as a global error long before `sendEvents` could\n * catch it. Falling back to the last built tags keeps the event, minus whatever changed since.\n */\nasync function captureTags(): Promise<TrackTags> {\n try {\n return await config.getTags();\n } catch (e: unknown) {\n if (e instanceof Error) console.log(e.message);\n return cache.tags ?? {};\n }\n}\n\n/**\n * The events not yet sent, and the only place they are: a batch leaves it at the moment it is\n * handed to `fetch` or to a beacon, never earlier. So when the page is hidden or left,\n * everything still unsent is right here for `sendPendingEvents`.\n */\nconst list: Item[] = [];\nconst batchSize = 10;\nconst delay = 2000;\nlet timer: ReturnType<typeof setTimeout> | null = null;\n\n/**\n * Hands the event to the third-party trackers now, as it is tracked, under its own id — not once\n * the server has answered. An event followed by a full-page navigation (an outbound link,\n * `begin_checkout` before the redirect to the payment page, a landing page left at once) reaches\n * the pixels before the page goes, and the server's conversions API, sending the same id, still\n * deduplicates against the browser event. A server that is down no longer takes the pixels down\n * with it either.\n *\n * A tracker that returns `false` is not ready — its pixel's global is not on the page yet, the\n * snippet still loading (the first `page_view` of a visit is tracked right as the page mounts).\n * Those trackers, and only those, are called once more on the next macrotask, with the same event\n * and id, after the inline snippets have had their turn; a tracker still not ready then is given\n * up on, as it was when it ran after the server's answer. Never more than once: a pixel's global\n * either exists by then or the script is blocked.\n */\nfunction firePixels({ event, options }: Item) {\n // An explicit false, not falsiness: a caller passing `{ onSucceed }` replaces the options\n // object wholesale, and leaving the flag out must not silently switch forwarding off.\n if (options.enableThirdPartyTracking === false || IGNORED_EVENTS.includes(event.name)) {\n return;\n }\n const notReady = callTrackers(config.thirdPartyTrackers, event);\n if (notReady.length === 0) return;\n setTimeout(() => callTrackers(notReady, event), 0);\n}\n\n/** Calls each tracker with the event; returns the ones that said they were not ready. */\nfunction callTrackers(trackers: ThirdPartyTracker[], event: TrackEvent): ThirdPartyTracker[] {\n return trackers.filter((tracker) => {\n try {\n return tracker(event.name, event.properties, event.id) === false;\n } catch (e: unknown) {\n // A third-party script does not get to take the tracking call, or the other trackers, with it.\n if (e instanceof Error) console.log(e.message);\n return false;\n }\n });\n}\n\n/**\n * What an event shares with every other event of the moment it happens: the visitor, the session,\n * the time and the client, with the last built tags until the event's own are captured.\n */\nfunction context(session_id: string, timestamp = new Date().toISOString()) {\n return {\n visitor_id: visitorId(),\n session_id,\n timestamp,\n platform: config.platform,\n environment: config.environment,\n tags: cache.tags ?? {},\n };\n}\n\n/** Queues the event, its tags to be filled in once `tags` settles. */\nfunction push(event: TrackEvent, tags: Promise<TrackTags>, options: TrackOptions): Item {\n const tagged = tags.then((settled) => {\n event.tags = settled;\n });\n const item = { event, tagged, options };\n list.push(item);\n return item;\n}\n\nconst silent: TrackOptions = { enableThirdPartyTracking: false };\n\n/**\n * Queues an event, preceded by a `session_start` when it is the one that opens a session, and\n * fires its third-party trackers.\n *\n * The session is decided here, when the event happens, as GA4 and PostHog decide it: the\n * `session_start` then sits in the queue right before the event that opened the session, so\n * wherever that event goes — a batch, a beacon, a retry — its announcement has gone ahead of it.\n * It carries that event's tags and time, as GA4 derives it from the hit that started the\n * session: the landing page is where the session began, whatever the page has navigated to by\n * the time the batch goes out.\n */\nfunction enqueue(\n name: TrackEvent['name'],\n properties: TrackEvent['properties'],\n options: TrackOptions,\n init: EventInit = {}\n): Item {\n const timestamp = new Date().toISOString();\n const { id: session_id, started } = getSession().touch(Date.parse(timestamp));\n const at = context(session_id, timestamp);\n const tags = captureTags();\n if (started) push({ ...at, id: uuidv7(), name: 'session_start', properties: {} }, tags, silent);\n const item = push({ ...at, id: init.id ?? uuidv7(), name, properties }, tags, options);\n if (init.pixels !== false) firePixels(item);\n return item;\n}\n\n/**\n * Ends the current session for `reset()`. What it accrued and has not reported goes out as a\n * `user_engagement`, as when the page is closed, and the queue is sent. Synchronous: every queued\n * event already carries its visitor and session, so the caller can replace the visitor right after.\n */\nexport function endSession() {\n const { id, engagement_time_msec } = getSession().end();\n if (id && engagement_time_msec > 0) {\n const properties = { engagement_time_msec, trigger: 'reset' };\n push(\n { ...context(id), id: uuidv7(), name: 'user_engagement', properties },\n captureTags(),\n silent\n );\n }\n if (list.length > 0) void flush();\n}\n\n/**\n * Sends the queue. Everything that has to be awaited is awaited first, and only then are the\n * events taken off the queue and handed to `fetch` in the same synchronous step — so there is\n * no moment at which an event is neither queued nor sent.\n */\nasync function flush() {\n if (timer) {\n clearTimeout(timer);\n timer = null;\n }\n if (list.length === 0) return;\n\n let headers: Record<string, string>;\n try {\n await getTokenBucket().removeTokens();\n headers = await config.getHeaders();\n // Tagged before the events leave the queue; those queued meanwhile are a microtask away.\n await Promise.all(list.map((item) => item.tagged));\n } catch (e: unknown) {\n // Nothing has left the queue yet: the events wait for the next send.\n if (e instanceof Error) console.log(e.message);\n return;\n }\n\n // The server takes one visitor per request, and a queue spans two after `reset()`. `send`\n // settles its own failures, so neither batch can take the other down.\n await Promise.all(byVisitor(list.splice(0)).map((batch) => send(batch, headers)));\n}\n\n/**\n * The items grouped by the visitor they were tracked under, each group in queue order. Not\n * `Map.groupBy`: it is ES2024, missing from Safari before 17.4 and from Hermes before V1.\n */\nfunction byVisitor(items: Item[]): Item[][] {\n const groups = new Map<string, Item[]>();\n for (const item of items) {\n const { visitor_id } = item.event;\n groups.set(visitor_id, [...(groups.get(visitor_id) ?? []), item]);\n }\n return [...groups.values()];\n}\n\n/** One visitor's batch, as one request. */\nasync function send(items: Item[], headers: Record<string, string>) {\n try {\n const body = JSON.stringify(items.map((item) => item.event));\n const response = await fetch(`${config.endpoint}/events`, {\n method: 'POST',\n credentials: 'include',\n // Retried although a POST: every event carries its client-generated id, and the server stores\n // a batch it already has `on conflict (id) do nothing`.\n retries: 3,\n // keepalive lets the request survive the page being unloaded mid-flight, within a 64KB\n // budget shared by every such request of the page; a body that could not fit goes as a\n // plain POST rather than failing outright.\n keepalive: body.length < 60_000,\n headers,\n body,\n });\n\n if (!response.ok) {\n throw new Error(`Failed to send track event: ${response.status} ${await response.text()}`);\n }\n\n // The body is not read. Every event has had its id since it was tracked, and its trackers\n // were fired with it then. Servers still answer one `{ id }` per event (`TrackEventResponse`),\n // which a server predating client ids fills with ids of its own; neither is needed here, and\n // an answer that is not even JSON does not turn a stored batch into a failure.\n items.forEach(({ event, options }) => options.onSucceed?.({ id: event.id }));\n } catch (e: unknown) {\n if (e instanceof Error) console.log(e.message);\n fail(items, e);\n }\n}\n\n/**\n * `fetch` has already retried the transient failures by the time a batch fails; what remains is a\n * batch the server rejected outright — one invalid event fails the whole batch — or a network that\n * stayed down past the retries. The other events are reported lost; `session_start` alone goes\n * back on the queue for the next send, because it is the session's only attribution record: a\n * session without one has no channel, and its every later event drops out of an attribution join.\n */\nfunction fail(items: Item[], e: unknown) {\n const isStart = (item: Item) => item.event.name === 'session_start';\n list.unshift(...items.filter(isStart));\n items.filter((item) => !isStart(item)).forEach((item) => item.options.onError?.(e));\n}\n\n/** `track`, with the `EventInit` only the SDK itself passes. */\nexport function queueEvent<T extends EventName = EventName>(\n name: TrackName<T>,\n properties: TrackProperties<T> | undefined,\n options: TrackOptions,\n init?: EventInit\n) {\n enqueue(name, properties, options, init);\n if (list.length >= batchSize) {\n void flush();\n return;\n }\n if (timer) clearTimeout(timer);\n timer = setTimeout(() => void flush(), delay);\n}\n\n/**\n * Queues the event for the next batch — up to 2 s away, at once when the batch is full — and\n * hands it to the third-party trackers now, under the id it is sent with.\n */\nexport function track<T extends EventName = EventName>(\n name: TrackName<T>,\n properties?: TrackProperties<T>,\n options: TrackOptions = defaultOptions\n) {\n queueEvent(name, properties, options);\n}\n\nfunction beacon(dto: CreateTrackEventDTO): boolean {\n // Not every runtime with a `navigator` has it: React Native has neither beacons nor pages.\n if (typeof navigator === 'undefined' || !('sendBeacon' in navigator)) return false;\n // text/plain keeps a cross-origin beacon a CORS simple request: as application/json it needs a\n // preflight, which a page being closed often cannot complete, and the beacon is then dropped.\n // The server reads it as JSON (`zBeaconJson` in @shware/http).\n const blob = new Blob([JSON.stringify(dto)], { type: 'text/plain;charset=UTF-8' });\n return navigator.sendBeacon(`${config.endpoint}/events`, blob);\n}\n\n/**\n * Sends the queue by beacon, now: for when the page is hidden or left, the last moment its\n * script is sure to run — what PostHog's `requestQueue.unload()` and GA4 do on the same events.\n * Call it before the engagement beacon: a new session's `session_start` is in this queue.\n *\n * Nothing can be awaited here, so the events go with the tags they have settled on (the last\n * built ones otherwise). Each goes with the id it was tracked with, and its third-party trackers\n * were fired then, under that id: none is fired again here. The visitor id is local\n * (`visitorId`), so a first visit left within a second is sent like any other. One beacon per\n * visitor, as one request per visitor in `flush`; a visitor's events no beacon can take — no\n * `sendBeacon`, a refused body — stay queued for the usual send.\n */\nexport function sendPendingEvents() {\n if (list.length === 0) return;\n if (timer) {\n clearTimeout(timer);\n timer = null;\n }\n byVisitor(list.splice(0)).forEach((batch) => {\n if (!beacon(batch.map((item) => item.event))) {\n list.push(...batch);\n return;\n }\n batch.forEach(({ event, options }) => options.onSucceed?.({ id: event.id, beacon: true }));\n });\n if (list.length > 0) void flush();\n}\n\nexport function sendBeacon<T extends EventName = EventName>(\n name: TrackName<T>,\n properties?: TrackProperties<T>\n) {\n // No stored session means no event was ever queued from this storage, so there is no session\n // to report for — and one started here could never be announced. See `Session.extend`.\n const session_id = getSession().extend();\n if (!session_id) return;\n\n // With the last built tags: they are worth less than the event carrying them, and an empty set\n // still reports the engagement (every field in `tagsSchema` is optional).\n if (beacon([{ ...context(session_id), id: uuidv7(), name, properties }])) return;\n console.warn('Failed to send beacon', name, properties);\n}\n"],"mappings":";;;;;;;AA4BA,MAAM,iBAA+B,CAAC;AAEtC,IAAI;;;;;;;AAQJ,SAAS,iBAAiB;CACxB,OAAQ,gBAAgB,IAAI,YAAY;EAAE,MAAM;EAAG,UAAU;EAAI,WAAW;CAAE,CAAC;AACjF;;;;;;;;;;AAiDA,eAAe,cAAkC;CAC/C,IAAI;EACF,OAAO,MAAM,OAAO,QAAQ;CAC9B,SAAS,GAAY;EACnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC7C,OAAO,MAAM,QAAQ,CAAC;CACxB;AACF;;;;;;AAOA,MAAM,OAAe,CAAC;AACtB,MAAM,YAAY;AAClB,MAAM,QAAQ;AACd,IAAI,QAA8C;;;;;;;;;;;;;;;;AAiBlD,SAAS,WAAW,EAAE,OAAO,WAAiB;CAG5C,IAAI,QAAQ,6BAA6B,SAAS,eAAe,SAAS,MAAM,IAAI,GAClF;CAEF,MAAM,WAAW,aAAa,OAAO,oBAAoB,KAAK;CAC9D,IAAI,SAAS,WAAW,GAAG;CAC3B,iBAAiB,aAAa,UAAU,KAAK,GAAG,CAAC;AACnD;;AAGA,SAAS,aAAa,UAA+B,OAAwC;CAC3F,OAAO,SAAS,QAAQ,YAAY;EAClC,IAAI;GACF,OAAO,QAAQ,MAAM,MAAM,MAAM,YAAY,MAAM,EAAE,MAAM;EAC7D,SAAS,GAAY;GAEnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;GAC7C,OAAO;EACT;CACF,CAAC;AACH;;;;;AAMA,SAAS,QAAQ,YAAoB,6BAAY,IAAI,KAAK,EAAA,CAAE,YAAY,GAAG;CACzE,OAAO;EACL,YAAY,UAAU;EACtB;EACA;EACA,UAAU,OAAO;EACjB,aAAa,OAAO;EACpB,MAAM,MAAM,QAAQ,CAAC;CACvB;AACF;;AAGA,SAAS,KAAK,OAAmB,MAA0B,SAA6B;CAItF,MAAM,OAAO;EAAE;EAAO,QAHP,KAAK,MAAM,YAAY;GACpC,MAAM,OAAO;EACf,CAC2B;EAAG;CAAQ;CACtC,KAAK,KAAK,IAAI;CACd,OAAO;AACT;AAEA,MAAM,SAAuB,EAAE,0BAA0B,MAAM;;;;;;;;;;;;AAa/D,SAAS,QACP,MACA,YACA,SACA,OAAkB,CAAC,GACb;CACN,MAAM,6BAAY,IAAI,KAAK,EAAA,CAAE,YAAY;CACzC,MAAM,EAAE,IAAI,YAAY,YAAY,WAAW,CAAC,CAAC,MAAM,KAAK,MAAM,SAAS,CAAC;CAC5E,MAAM,KAAK,QAAQ,YAAY,SAAS;CACxC,MAAM,OAAO,YAAY;CACzB,IAAI,SAAS,KAAK;EAAE,GAAG;EAAI,IAAIA,GAAO;EAAG,MAAM;EAAiB,YAAY,CAAC;CAAE,GAAG,MAAM,MAAM;CAC9F,MAAM,OAAO,KAAK;EAAE,GAAG;EAAI,IAAI,KAAK,MAAMA,GAAO;EAAG;EAAM;CAAW,GAAG,MAAM,OAAO;CACrF,IAAI,KAAK,WAAW,OAAO,WAAW,IAAI;CAC1C,OAAO;AACT;;;;;;AAOA,SAAgB,aAAa;CAC3B,MAAM,EAAE,IAAI,yBAAyB,WAAW,CAAC,CAAC,IAAI;CACtD,IAAI,MAAM,uBAAuB,GAAG;EAClC,MAAM,aAAa;GAAE;GAAsB,SAAS;EAAQ;EAC5D,KACE;GAAE,GAAG,QAAQ,EAAE;GAAG,IAAIA,GAAO;GAAG,MAAM;GAAmB;EAAW,GACpE,YAAY,GACZ,MACF;CACF;CACA,IAAI,KAAK,SAAS,GAAG,MAAW;AAClC;;;;;;AAOA,eAAe,QAAQ;CACrB,IAAI,OAAO;EACT,aAAa,KAAK;EAClB,QAAQ;CACV;CACA,IAAI,KAAK,WAAW,GAAG;CAEvB,IAAI;CACJ,IAAI;EACF,MAAM,eAAe,CAAC,CAAC,aAAa;EACpC,UAAU,MAAM,OAAO,WAAW;EAElC,MAAM,QAAQ,IAAI,KAAK,KAAK,SAAS,KAAK,MAAM,CAAC;CACnD,SAAS,GAAY;EAEnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC7C;CACF;CAIA,MAAM,QAAQ,IAAI,UAAU,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,KAAK,OAAO,OAAO,CAAC,CAAC;AAClF;;;;;AAMA,SAAS,UAAU,OAAyB;CAC1C,MAAM,yBAAS,IAAI,IAAoB;CACvC,KAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,EAAE,eAAe,KAAK;EAC5B,OAAO,IAAI,YAAY,CAAC,GAAI,OAAO,IAAI,UAAU,KAAK,CAAC,GAAI,IAAI,CAAC;CAClE;CACA,OAAO,CAAC,GAAG,OAAO,OAAO,CAAC;AAC5B;;AAGA,eAAe,KAAK,OAAe,SAAiC;CAClE,IAAI;EACF,MAAM,OAAO,KAAK,UAAU,MAAM,KAAK,SAAS,KAAK,KAAK,CAAC;EAC3D,MAAM,WAAW,MAAM,MAAM,GAAG,OAAO,SAAS,UAAU;GACxD,QAAQ;GACR,aAAa;GAGb,SAAS;GAIT,WAAW,KAAK,SAAS;GACzB;GACA;EACF,CAAC;EAED,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,+BAA+B,SAAS,OAAO,GAAG,MAAM,SAAS,KAAK,GAAG;EAO3F,MAAM,SAAS,EAAE,OAAO,cAAc,QAAQ,YAAY,EAAE,IAAI,MAAM,GAAG,CAAC,CAAC;CAC7E,SAAS,GAAY;EACnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC7C,KAAK,OAAO,CAAC;CACf;AACF;;;;;;;;AASA,SAAS,KAAK,OAAe,GAAY;CACvC,MAAM,WAAW,SAAe,KAAK,MAAM,SAAS;CACpD,KAAK,QAAQ,GAAG,MAAM,OAAO,OAAO,CAAC;CACrC,MAAM,QAAQ,SAAS,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,SAAS,SAAS,KAAK,QAAQ,UAAU,CAAC,CAAC;AACpF;;AAGA,SAAgB,WACd,MACA,YACA,SACA,MACA;CACA,QAAQ,MAAM,YAAY,SAAS,IAAI;CACvC,IAAI,KAAK,UAAU,WAAW;EAC5B,MAAW;EACX;CACF;CACA,IAAI,OAAO,aAAa,KAAK;CAC7B,QAAQ,iBAAiB,KAAK,MAAM,GAAG,KAAK;AAC9C;;;;;AAMA,SAAgB,MACd,MACA,YACA,UAAwB,gBACxB;CACA,WAAW,MAAM,YAAY,OAAO;AACtC;AAEA,SAAS,OAAO,KAAmC;CAEjD,IAAI,OAAO,cAAc,eAAe,EAAE,gBAAgB,YAAY,OAAO;CAI7E,MAAM,OAAO,IAAI,KAAK,CAAC,KAAK,UAAU,GAAG,CAAC,GAAG,EAAE,MAAM,2BAA2B,CAAC;CACjF,OAAO,UAAU,WAAW,GAAG,OAAO,SAAS,UAAU,IAAI;AAC/D;;;;;;;;;;;;;AAcA,SAAgB,oBAAoB;CAClC,IAAI,KAAK,WAAW,GAAG;CACvB,IAAI,OAAO;EACT,aAAa,KAAK;EAClB,QAAQ;CACV;CACA,UAAU,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU;EAC3C,IAAI,CAAC,OAAO,MAAM,KAAK,SAAS,KAAK,KAAK,CAAC,GAAG;GAC5C,KAAK,KAAK,GAAG,KAAK;GAClB;EACF;EACA,MAAM,SAAS,EAAE,OAAO,cAAc,QAAQ,YAAY;GAAE,IAAI,MAAM;GAAI,QAAQ;EAAK,CAAC,CAAC;CAC3F,CAAC;CACD,IAAI,KAAK,SAAS,GAAG,MAAW;AAClC;AAEA,SAAgB,WACd,MACA,YACA;CAGA,MAAM,aAAa,WAAW,CAAC,CAAC,OAAO;CACvC,IAAI,CAAC,YAAY;CAIjB,IAAI,OAAO,CAAC;EAAE,GAAG,QAAQ,UAAU;EAAG,IAAIA,GAAO;EAAG;EAAM;CAAW,CAAC,CAAC,GAAG;CAC1E,QAAQ,KAAK,yBAAyB,MAAM,UAAU;AACxD"}
|
package/dist/visitor/id.cjs
CHANGED
|
@@ -15,10 +15,15 @@ let uuid = require("uuid");
|
|
|
15
15
|
function visitorId() {
|
|
16
16
|
const stored = require_setup_index.config.storage.getItem(require_constants_storage.keys.visitor_id);
|
|
17
17
|
if (stored && stored !== "undefined") return stored;
|
|
18
|
+
return newVisitorId();
|
|
19
|
+
}
|
|
20
|
+
/** Starts a new visitor on this device — `reset()` — and returns its id. */
|
|
21
|
+
function newVisitorId() {
|
|
18
22
|
const id = (0, uuid.v7)();
|
|
19
23
|
require_setup_index.config.storage.setItem(require_constants_storage.keys.visitor_id, id);
|
|
20
24
|
return id;
|
|
21
25
|
}
|
|
26
|
+
exports.newVisitorId = newVisitorId;
|
|
22
27
|
exports.visitorId = visitorId;
|
|
23
28
|
|
|
24
29
|
//# sourceMappingURL=id.cjs.map
|
package/dist/visitor/id.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"id.cjs","names":["config","keys","uuidv7"],"sources":["../../src/visitor/id.ts"],"sourcesContent":["import { v7 as uuidv7 } from 'uuid';\nimport { keys } from '../constants/storage';\nimport { config } from '../setup/index';\n\n/**\n * This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so\n * it exists the moment the page loads. The first events, and the beacon of a visit left within a\n * second, go out without waiting for a round trip; the server creates the visitor from its first\n * events. An id a server issued to an older client is kept as it is: the visitor continues.\n *\n * Needs a server that creates visitors from events (see the README, \"Visitors\"); one that still\n * only creates them on `POST /visitors` rejects the events of a new visitor.\n */\nexport function visitorId(): string {\n const stored = config.storage.getItem(keys.visitor_id);\n // An old client stored the string 'undefined' as the id (it wrote an unset id): not an id, so it\n // is replaced below with a new one, which also clears the bad value from storage for good.\n if (stored && stored !== 'undefined') return stored;\n const id = uuidv7();\n config.storage.setItem(keys.visitor_id, id);\n return id;\n}\n"],"mappings":";;;;;;;;;;;;;;AAaA,SAAgB,YAAoB;CAClC,MAAM,SAASA,oBAAAA,OAAO,QAAQ,QAAQC,0BAAAA,KAAK,UAAU;CAGrD,IAAI,UAAU,WAAW,aAAa,OAAO;CAC7C,MAAM,MAAA,GAAKC,KAAAA,GAAAA,CAAO;CAClB,oBAAA,OAAO,QAAQ,QAAQD,0BAAAA,KAAK,YAAY,EAAE;CAC1C,OAAO;AACT"}
|
|
1
|
+
{"version":3,"file":"id.cjs","names":["config","keys","uuidv7"],"sources":["../../src/visitor/id.ts"],"sourcesContent":["import { v7 as uuidv7 } from 'uuid';\nimport { keys } from '../constants/storage';\nimport { config } from '../setup/index';\n\n/**\n * This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so\n * it exists the moment the page loads. The first events, and the beacon of a visit left within a\n * second, go out without waiting for a round trip; the server creates the visitor from its first\n * events. An id a server issued to an older client is kept as it is: the visitor continues.\n *\n * Needs a server that creates visitors from events (see the README, \"Visitors\"); one that still\n * only creates them on `POST /visitors` rejects the events of a new visitor.\n */\nexport function visitorId(): string {\n const stored = config.storage.getItem(keys.visitor_id);\n // An old client stored the string 'undefined' as the id (it wrote an unset id): not an id, so it\n // is replaced below with a new one, which also clears the bad value from storage for good.\n if (stored && stored !== 'undefined') return stored;\n return newVisitorId();\n}\n\n/** Starts a new visitor on this device — `reset()` — and returns its id. */\nexport function newVisitorId(): string {\n const id = uuidv7();\n config.storage.setItem(keys.visitor_id, id);\n return id;\n}\n"],"mappings":";;;;;;;;;;;;;;AAaA,SAAgB,YAAoB;CAClC,MAAM,SAASA,oBAAAA,OAAO,QAAQ,QAAQC,0BAAAA,KAAK,UAAU;CAGrD,IAAI,UAAU,WAAW,aAAa,OAAO;CAC7C,OAAO,aAAa;AACtB;;AAGA,SAAgB,eAAuB;CACrC,MAAM,MAAA,GAAKC,KAAAA,GAAAA,CAAO;CAClB,oBAAA,OAAO,QAAQ,QAAQD,0BAAAA,KAAK,YAAY,EAAE;CAC1C,OAAO;AACT"}
|
package/dist/visitor/id.d.cts
CHANGED
|
@@ -8,4 +8,6 @@
|
|
|
8
8
|
* only creates them on `POST /visitors` rejects the events of a new visitor.
|
|
9
9
|
*/
|
|
10
10
|
export declare function visitorId(): string;
|
|
11
|
+
/** Starts a new visitor on this device — `reset()` — and returns its id. */
|
|
12
|
+
export declare function newVisitorId(): string;
|
|
11
13
|
//# sourceMappingURL=id.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"id.d.cts","names":[],"sources":["../../src/visitor/id.ts"],"mappings":";;;;;;;;;wBAagB"}
|
|
1
|
+
{"version":3,"file":"id.d.cts","names":[],"sources":["../../src/visitor/id.ts"],"mappings":";;;;;;;;;wBAagB;;wBASA"}
|
package/dist/visitor/id.d.mts
CHANGED
|
@@ -8,4 +8,6 @@
|
|
|
8
8
|
* only creates them on `POST /visitors` rejects the events of a new visitor.
|
|
9
9
|
*/
|
|
10
10
|
export declare function visitorId(): string;
|
|
11
|
+
/** Starts a new visitor on this device — `reset()` — and returns its id. */
|
|
12
|
+
export declare function newVisitorId(): string;
|
|
11
13
|
//# sourceMappingURL=id.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"id.d.mts","names":[],"sources":["../../src/visitor/id.ts"],"mappings":";;;;;;;;;wBAagB"}
|
|
1
|
+
{"version":3,"file":"id.d.mts","names":[],"sources":["../../src/visitor/id.ts"],"mappings":";;;;;;;;;wBAagB;;wBASA"}
|
package/dist/visitor/id.mjs
CHANGED
|
@@ -14,10 +14,14 @@ import { v7 } from "uuid";
|
|
|
14
14
|
function visitorId() {
|
|
15
15
|
const stored = config.storage.getItem(keys.visitor_id);
|
|
16
16
|
if (stored && stored !== "undefined") return stored;
|
|
17
|
+
return newVisitorId();
|
|
18
|
+
}
|
|
19
|
+
/** Starts a new visitor on this device — `reset()` — and returns its id. */
|
|
20
|
+
function newVisitorId() {
|
|
17
21
|
const id = v7();
|
|
18
22
|
config.storage.setItem(keys.visitor_id, id);
|
|
19
23
|
return id;
|
|
20
24
|
}
|
|
21
|
-
export { visitorId };
|
|
25
|
+
export { newVisitorId, visitorId };
|
|
22
26
|
|
|
23
27
|
//# sourceMappingURL=id.mjs.map
|
package/dist/visitor/id.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"id.mjs","names":["uuidv7"],"sources":["../../src/visitor/id.ts"],"sourcesContent":["import { v7 as uuidv7 } from 'uuid';\nimport { keys } from '../constants/storage';\nimport { config } from '../setup/index';\n\n/**\n * This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so\n * it exists the moment the page loads. The first events, and the beacon of a visit left within a\n * second, go out without waiting for a round trip; the server creates the visitor from its first\n * events. An id a server issued to an older client is kept as it is: the visitor continues.\n *\n * Needs a server that creates visitors from events (see the README, \"Visitors\"); one that still\n * only creates them on `POST /visitors` rejects the events of a new visitor.\n */\nexport function visitorId(): string {\n const stored = config.storage.getItem(keys.visitor_id);\n // An old client stored the string 'undefined' as the id (it wrote an unset id): not an id, so it\n // is replaced below with a new one, which also clears the bad value from storage for good.\n if (stored && stored !== 'undefined') return stored;\n const id = uuidv7();\n config.storage.setItem(keys.visitor_id, id);\n return id;\n}\n"],"mappings":";;;;;;;;;;;;;AAaA,SAAgB,YAAoB;CAClC,MAAM,SAAS,OAAO,QAAQ,QAAQ,KAAK,UAAU;CAGrD,IAAI,UAAU,WAAW,aAAa,OAAO;CAC7C,MAAM,KAAKA,GAAO;CAClB,OAAO,QAAQ,QAAQ,KAAK,YAAY,EAAE;CAC1C,OAAO;AACT"}
|
|
1
|
+
{"version":3,"file":"id.mjs","names":["uuidv7"],"sources":["../../src/visitor/id.ts"],"sourcesContent":["import { v7 as uuidv7 } from 'uuid';\nimport { keys } from '../constants/storage';\nimport { config } from '../setup/index';\n\n/**\n * This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so\n * it exists the moment the page loads. The first events, and the beacon of a visit left within a\n * second, go out without waiting for a round trip; the server creates the visitor from its first\n * events. An id a server issued to an older client is kept as it is: the visitor continues.\n *\n * Needs a server that creates visitors from events (see the README, \"Visitors\"); one that still\n * only creates them on `POST /visitors` rejects the events of a new visitor.\n */\nexport function visitorId(): string {\n const stored = config.storage.getItem(keys.visitor_id);\n // An old client stored the string 'undefined' as the id (it wrote an unset id): not an id, so it\n // is replaced below with a new one, which also clears the bad value from storage for good.\n if (stored && stored !== 'undefined') return stored;\n return newVisitorId();\n}\n\n/** Starts a new visitor on this device — `reset()` — and returns its id. */\nexport function newVisitorId(): string {\n const id = uuidv7();\n config.storage.setItem(keys.visitor_id, id);\n return id;\n}\n"],"mappings":";;;;;;;;;;;;;AAaA,SAAgB,YAAoB;CAClC,MAAM,SAAS,OAAO,QAAQ,QAAQ,KAAK,UAAU;CAGrD,IAAI,UAAU,WAAW,aAAa,OAAO;CAC7C,OAAO,aAAa;AACtB;;AAGA,SAAgB,eAAuB;CACrC,MAAM,KAAKA,GAAO;CAClB,OAAO,QAAQ,QAAQ,KAAK,YAAY,EAAE;CAC1C,OAAO;AACT"}
|
package/dist/visitor/index.cjs
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
2
|
const require_setup_index = require("../setup/index.cjs");
|
|
3
|
+
const require_constants_storage = require("../constants/storage.cjs");
|
|
3
4
|
const require_visitor_id = require("./id.cjs");
|
|
4
5
|
const require_track_index = require("../track/index.cjs");
|
|
5
6
|
// src/visitor/index.ts
|
|
@@ -10,44 +11,113 @@ const require_track_index = require("../track/index.cjs");
|
|
|
10
11
|
*/
|
|
11
12
|
const IDENTIFY_EVENT = "identify";
|
|
12
13
|
/**
|
|
13
|
-
* The user this page
|
|
14
|
-
*
|
|
14
|
+
* The visitor and user this page last identified, as `<visitor>:<user>`: identify once per binding
|
|
15
|
+
* per page, not per call. The visitor is part of it because the storage is shared: another tab's
|
|
16
|
+
* `reset()` replaces the visitor under this page, and the same user here must then bind the new
|
|
17
|
+
* one too.
|
|
18
|
+
*
|
|
19
|
+
* `undefined` until this page identifies anyone; `null` once it has signed out (`reset()`), so the
|
|
20
|
+
* same user signing back in is identified again, and a later `reset()` here knows it has nothing
|
|
21
|
+
* left to sign out — the device's identity, if any, is someone this page has not identified.
|
|
15
22
|
*/
|
|
16
23
|
let identified;
|
|
24
|
+
/** Hands the user to every third-party user setter; one that throws does not stop the others. */
|
|
25
|
+
function setUsers(user) {
|
|
26
|
+
require_setup_index.config.thirdPartyUserSetters.forEach((setter) => {
|
|
27
|
+
try {
|
|
28
|
+
setter(user);
|
|
29
|
+
} catch (e) {
|
|
30
|
+
if (e instanceof Error) console.log(e.message);
|
|
31
|
+
}
|
|
32
|
+
});
|
|
33
|
+
}
|
|
17
34
|
/**
|
|
18
35
|
* Hands the signed-in user to the analytics: the third-party user setters (gtag, the pixels) now,
|
|
19
36
|
* and the server through an `identify` event, sent when the user differs from the one this page
|
|
20
37
|
* last identified — a host calls this on every page load once someone is signed in. Like any
|
|
21
|
-
* event it goes with the next batch or the page-hide beacon; `
|
|
38
|
+
* event it goes with the next batch or the page-hide beacon; `userData` is handed to the setters
|
|
22
39
|
* only, never stored with the event.
|
|
23
40
|
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
41
|
+
* The visitor's sessions so far — those before the sign-in included — become this user's. So a
|
|
42
|
+
* different user than the one last identified on this device (an expired session, a sign-out the
|
|
43
|
+
* host never reported) is `reset()` first: the previous user's visitor stays theirs, and this one
|
|
44
|
+
* starts on a new visitor.
|
|
28
45
|
*
|
|
29
|
-
* Synchronous and never throws: sign-in
|
|
46
|
+
* Synchronous and never throws: sign-in must not fail on analytics.
|
|
30
47
|
*/
|
|
31
|
-
function
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
...dto,
|
|
39
|
-
distinct_id: dto.user_id || null
|
|
40
|
-
};
|
|
41
|
-
require_setup_index.config.thirdPartyUserSetters.forEach((setter) => {
|
|
42
|
-
try {
|
|
43
|
-
setter(identity);
|
|
44
|
-
} catch (e) {
|
|
45
|
-
if (e instanceof Error) console.log(e.message);
|
|
48
|
+
function identify(userId, userData) {
|
|
49
|
+
let visitor = "";
|
|
50
|
+
try {
|
|
51
|
+
const previous = require_setup_index.config.storage.getItem(require_constants_storage.keys.user_id);
|
|
52
|
+
if (previous && previous !== userId) {
|
|
53
|
+
startOver();
|
|
54
|
+
setUsers({});
|
|
46
55
|
}
|
|
56
|
+
require_setup_index.config.storage.setItem(require_constants_storage.keys.user_id, userId);
|
|
57
|
+
visitor = require_visitor_id.visitorId();
|
|
58
|
+
} catch (e) {
|
|
59
|
+
if (e instanceof Error) console.log(e.message);
|
|
60
|
+
}
|
|
61
|
+
const binding = `${visitor}:${userId}`;
|
|
62
|
+
if (binding !== identified) {
|
|
63
|
+
identified = binding;
|
|
64
|
+
require_track_index.track(IDENTIFY_EVENT, { user_id: userId }, { enableThirdPartyTracking: false });
|
|
65
|
+
}
|
|
66
|
+
setUsers({
|
|
67
|
+
user_id: userId,
|
|
68
|
+
user_data: userData
|
|
47
69
|
});
|
|
48
70
|
}
|
|
71
|
+
/**
|
|
72
|
+
* Signs the visitor out, as PostHog's `reset()` does: call it on sign-out, after
|
|
73
|
+
* `track('logout')`, so that event still belongs to the user leaving.
|
|
74
|
+
*
|
|
75
|
+
* - The current session ends: what it accrued goes out as a `user_engagement`
|
|
76
|
+
* (`trigger: 'reset'`), as when the page is closed, and the queue is sent under the visitor
|
|
77
|
+
* and session its events happened in.
|
|
78
|
+
* - A new visitor starts, and the next event opens a new session on it. Everything until the next
|
|
79
|
+
* sign-in is anonymous, and becomes whoever's signs in next; the visitor that is left stays the
|
|
80
|
+
* previous user's, with its history.
|
|
81
|
+
* - The third-party setters drop the user (PostHog resets its identity, GA clears its user_id).
|
|
82
|
+
*
|
|
83
|
+
* The device id and the first visit or first open stay: they describe the device, not the person.
|
|
84
|
+
*
|
|
85
|
+
* Only the sign-out this page knows of: the session and visitor are replaced while the device's
|
|
86
|
+
* identity (`keys.user_id` and the visitor, shared by every tab) is still the one this page last
|
|
87
|
+
* identified, or the page has neither identified nor signed out anyone (a host that identifies at
|
|
88
|
+
* sign-in only, on a page loaded since). Every tab of a site sees a sign-out and calls this,
|
|
89
|
+
* some of them late — a tab frozen in the background handles it on resuming, after another tab
|
|
90
|
+
* may have signed out and in again. A call that finds no user, or someone else's binding, is
|
|
91
|
+
* stale: replacing that would cut the new anonymous visitor off from the next sign-in, or end the
|
|
92
|
+
* next user's session and leave their pages on a visitor nobody identified. It only clears this
|
|
93
|
+
* page: its setters are still told, since GA holds the user per page.
|
|
94
|
+
*
|
|
95
|
+
* Synchronous and never throws: sign-out must not fail on analytics.
|
|
96
|
+
*/
|
|
97
|
+
function reset() {
|
|
98
|
+
let current = false;
|
|
99
|
+
try {
|
|
100
|
+
const user = require_setup_index.config.storage.getItem(require_constants_storage.keys.user_id);
|
|
101
|
+
current = !!user && (identified === void 0 || identified === `${require_visitor_id.visitorId()}:${user}`);
|
|
102
|
+
if (current) startOver();
|
|
103
|
+
} catch (e) {
|
|
104
|
+
if (e instanceof Error) console.log(e.message);
|
|
105
|
+
}
|
|
106
|
+
if (current || identified) setUsers({});
|
|
107
|
+
identified = null;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Ends the device's session and starts a new visitor with no user: `reset()` for the sign-out it
|
|
111
|
+
* knows of, `identify` for a user signing in over another.
|
|
112
|
+
*/
|
|
113
|
+
function startOver() {
|
|
114
|
+
require_track_index.endSession();
|
|
115
|
+
require_visitor_id.newVisitorId();
|
|
116
|
+
require_setup_index.config.storage.setItem(require_constants_storage.keys.user_id, "");
|
|
117
|
+
}
|
|
49
118
|
exports.IDENTIFY_EVENT = IDENTIFY_EVENT;
|
|
50
|
-
exports.
|
|
119
|
+
exports.identify = identify;
|
|
120
|
+
exports.reset = reset;
|
|
51
121
|
exports.visitorId = require_visitor_id.visitorId;
|
|
52
122
|
|
|
53
123
|
//# sourceMappingURL=index.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","names":[],"sources":["../../src/visitor/index.ts"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["config","keys","visitorId"],"sources":["../../src/visitor/index.ts"],"sourcesContent":["import { keys } from '../constants/storage';\nimport { config } from '../setup/index';\nimport { endSession, track } from '../track/index';\nimport type { UserProvidedData } from '../track/types';\nimport { newVisitorId, visitorId } from './id';\nimport type { ThirdPartyUserSetter } from './types';\n\nexport { visitorId } from './id';\n\n/**\n * The event that binds the visitor to the user who signed in on it: the server sets the visitor's\n * `user_id` and `distinct_id` from its `user_id` property, in the transaction that stores the\n * batch — which also creates the visitor when it is new, so the binding can never arrive before it.\n */\nexport const IDENTIFY_EVENT = 'identify';\n\n/**\n * The visitor and user this page last identified, as `<visitor>:<user>`: identify once per binding\n * per page, not per call. The visitor is part of it because the storage is shared: another tab's\n * `reset()` replaces the visitor under this page, and the same user here must then bind the new\n * one too.\n *\n * `undefined` until this page identifies anyone; `null` once it has signed out (`reset()`), so the\n * same user signing back in is identified again, and a later `reset()` here knows it has nothing\n * left to sign out — the device's identity, if any, is someone this page has not identified.\n */\nlet identified: string | null | undefined;\n\n/** Hands the user to every third-party user setter; one that throws does not stop the others. */\nfunction setUsers(user: Parameters<ThirdPartyUserSetter>[0]) {\n config.thirdPartyUserSetters.forEach((setter) => {\n try {\n setter(user);\n } catch (e: unknown) {\n if (e instanceof Error) console.log(e.message);\n }\n });\n}\n\n/**\n * Hands the signed-in user to the analytics: the third-party user setters (gtag, the pixels) now,\n * and the server through an `identify` event, sent when the user differs from the one this page\n * last identified — a host calls this on every page load once someone is signed in. Like any\n * event it goes with the next batch or the page-hide beacon; `userData` is handed to the setters\n * only, never stored with the event.\n *\n * The visitor's sessions so far — those before the sign-in included — become this user's. So a\n * different user than the one last identified on this device (an expired session, a sign-out the\n * host never reported) is `reset()` first: the previous user's visitor stays theirs, and this one\n * starts on a new visitor.\n *\n * Synchronous and never throws: sign-in must not fail on analytics.\n */\nexport function identify(userId: string, userData?: UserProvidedData) {\n let visitor = '';\n try {\n const previous = config.storage.getItem(keys.user_id);\n if (previous && previous !== userId) {\n // Another user is on the device: start over whatever this page last identified.\n startOver();\n setUsers({});\n }\n config.storage.setItem(keys.user_id, userId);\n visitor = visitorId();\n } catch (e: unknown) {\n if (e instanceof Error) console.log(e.message);\n }\n\n const binding = `${visitor}:${userId}`;\n if (binding !== identified) {\n identified = binding;\n track(IDENTIFY_EVENT, { user_id: userId }, { enableThirdPartyTracking: false });\n }\n\n setUsers({ user_id: userId, user_data: userData });\n}\n\n/**\n * Signs the visitor out, as PostHog's `reset()` does: call it on sign-out, after\n * `track('logout')`, so that event still belongs to the user leaving.\n *\n * - The current session ends: what it accrued goes out as a `user_engagement`\n * (`trigger: 'reset'`), as when the page is closed, and the queue is sent under the visitor\n * and session its events happened in.\n * - A new visitor starts, and the next event opens a new session on it. Everything until the next\n * sign-in is anonymous, and becomes whoever's signs in next; the visitor that is left stays the\n * previous user's, with its history.\n * - The third-party setters drop the user (PostHog resets its identity, GA clears its user_id).\n *\n * The device id and the first visit or first open stay: they describe the device, not the person.\n *\n * Only the sign-out this page knows of: the session and visitor are replaced while the device's\n * identity (`keys.user_id` and the visitor, shared by every tab) is still the one this page last\n * identified, or the page has neither identified nor signed out anyone (a host that identifies at\n * sign-in only, on a page loaded since). Every tab of a site sees a sign-out and calls this,\n * some of them late — a tab frozen in the background handles it on resuming, after another tab\n * may have signed out and in again. A call that finds no user, or someone else's binding, is\n * stale: replacing that would cut the new anonymous visitor off from the next sign-in, or end the\n * next user's session and leave their pages on a visitor nobody identified. It only clears this\n * page: its setters are still told, since GA holds the user per page.\n *\n * Synchronous and never throws: sign-out must not fail on analytics.\n */\nexport function reset() {\n let current = false;\n try {\n const user = config.storage.getItem(keys.user_id);\n current = !!user && (identified === undefined || identified === `${visitorId()}:${user}`);\n if (current) startOver();\n } catch (e: unknown) {\n if (e instanceof Error) console.log(e.message);\n }\n if (current || identified) setUsers({});\n identified = null;\n}\n\n/**\n * Ends the device's session and starts a new visitor with no user: `reset()` for the sign-out it\n * knows of, `identify` for a user signing in over another.\n */\nfunction startOver() {\n endSession();\n newVisitorId();\n config.storage.setItem(keys.user_id, '');\n}\n"],"mappings":";;;;;;;;;;;AAcA,MAAa,iBAAiB;;;;;;;;;;;AAY9B,IAAI;;AAGJ,SAAS,SAAS,MAA2C;CAC3D,oBAAA,OAAO,sBAAsB,SAAS,WAAW;EAC/C,IAAI;GACF,OAAO,IAAI;EACb,SAAS,GAAY;GACnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC/C;CACF,CAAC;AACH;;;;;;;;;;;;;;;AAgBA,SAAgB,SAAS,QAAgB,UAA6B;CACpE,IAAI,UAAU;CACd,IAAI;EACF,MAAM,WAAWA,oBAAAA,OAAO,QAAQ,QAAQC,0BAAAA,KAAK,OAAO;EACpD,IAAI,YAAY,aAAa,QAAQ;GAEnC,UAAU;GACV,SAAS,CAAC,CAAC;EACb;EACA,oBAAA,OAAO,QAAQ,QAAQA,0BAAAA,KAAK,SAAS,MAAM;EAC3C,UAAUC,mBAAAA,UAAU;CACtB,SAAS,GAAY;EACnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;CAC/C;CAEA,MAAM,UAAU,GAAG,QAAQ,GAAG;CAC9B,IAAI,YAAY,YAAY;EAC1B,aAAa;EACb,oBAAA,MAAM,gBAAgB,EAAE,SAAS,OAAO,GAAG,EAAE,0BAA0B,MAAM,CAAC;CAChF;CAEA,SAAS;EAAE,SAAS;EAAQ,WAAW;CAAS,CAAC;AACnD;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,SAAgB,QAAQ;CACtB,IAAI,UAAU;CACd,IAAI;EACF,MAAM,OAAOF,oBAAAA,OAAO,QAAQ,QAAQC,0BAAAA,KAAK,OAAO;EAChD,UAAU,CAAC,CAAC,SAAS,eAAe,KAAA,KAAa,eAAe,GAAGC,mBAAAA,UAAU,EAAE,GAAG;EAClF,IAAI,SAAS,UAAU;CACzB,SAAS,GAAY;EACnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;CAC/C;CACA,IAAI,WAAW,YAAY,SAAS,CAAC,CAAC;CACtC,aAAa;AACf;;;;;AAMA,SAAS,YAAY;CACnB,oBAAA,WAAW;CACX,mBAAA,aAAa;CACb,oBAAA,OAAO,QAAQ,QAAQD,0BAAAA,KAAK,SAAS,EAAE;AACzC"}
|