@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/README.md
CHANGED
|
@@ -21,22 +21,22 @@ modules for `/native`, `react-native-fbsdk-next` for `/native/fbsdk`, and so on)
|
|
|
21
21
|
|
|
22
22
|
## Entry points
|
|
23
23
|
|
|
24
|
-
| Import | Runs on | What it is for
|
|
25
|
-
| ----------------------------------------- | ------- |
|
|
26
|
-
| `@shware/analytics` | client | `setupAnalytics`, `track`, `
|
|
27
|
-
| `@shware/analytics/web` | browser | `storage`, `getTags`, `getDeviceId` for `setupAnalytics` on the web
|
|
28
|
-
| `@shware/analytics/native` | Expo | The same for React Native, plus `deepLink` and `useAppAnalytics`
|
|
29
|
-
| `@shware/analytics/native/firebase` | Expo | `sendFirebaseEvent`, a third-party tracker for Firebase Analytics
|
|
30
|
-
| `@shware/analytics/native/fbsdk` | Expo | `sendFBEvent`, a third-party tracker for the Facebook SDK
|
|
31
|
-
| `@shware/analytics/next` | browser | `<Analytics />` for the Next.js App Router
|
|
32
|
-
| `@shware/analytics/tanstack` | both | `<Analytics />` and `createClickIdMiddleware` for TanStack Start
|
|
33
|
-
| `@shware/analytics/react-router` | browser | `<Analytics />` for React Router
|
|
34
|
-
| `@shware/analytics/third-parties` | browser | GA4, Meta Pixel, Reddit, LinkedIn, OpenAI and UET trackers and setters
|
|
35
|
-
| `@shware/analytics/third-parties/posthog` | browser | `sendPosthogEvent` and `setPosthogUser`
|
|
36
|
-
| `@shware/analytics/server` | server | Conversions APIs: Meta, Google Ads, Microsoft, Reddit, LinkedIn, OpenAI
|
|
37
|
-
| `@shware/analytics/server/legacy` | server | The old Meta sender built on `facebook-nodejs-business-sdk`
|
|
38
|
-
| `@shware/analytics/attribution` | server | `classifyTouch` and the channel vocabulary for reading sessions
|
|
39
|
-
| `@shware/analytics/ads` | server | Pulling spend and performance from Google Ads and Meta
|
|
24
|
+
| Import | Runs on | What it is for |
|
|
25
|
+
| ----------------------------------------- | ------- | --------------------------------------------------------------------------- |
|
|
26
|
+
| `@shware/analytics` | client | `setupAnalytics`, `track`, `identify`, `reset`, `sendFeedback`, links, bots |
|
|
27
|
+
| `@shware/analytics/web` | browser | `storage`, `getTags`, `getDeviceId` for `setupAnalytics` on the web |
|
|
28
|
+
| `@shware/analytics/native` | Expo | The same for React Native, plus `deepLink` and `useAppAnalytics` |
|
|
29
|
+
| `@shware/analytics/native/firebase` | Expo | `sendFirebaseEvent`, a third-party tracker for Firebase Analytics |
|
|
30
|
+
| `@shware/analytics/native/fbsdk` | Expo | `sendFBEvent`, a third-party tracker for the Facebook SDK |
|
|
31
|
+
| `@shware/analytics/next` | browser | `<Analytics />` for the Next.js App Router |
|
|
32
|
+
| `@shware/analytics/tanstack` | both | `<Analytics />` and `createClickIdMiddleware` for TanStack Start |
|
|
33
|
+
| `@shware/analytics/react-router` | browser | `<Analytics />` for React Router |
|
|
34
|
+
| `@shware/analytics/third-parties` | browser | GA4, Meta Pixel, Reddit, LinkedIn, OpenAI and UET trackers and setters |
|
|
35
|
+
| `@shware/analytics/third-parties/posthog` | browser | `sendPosthogEvent` and `setPosthogUser` |
|
|
36
|
+
| `@shware/analytics/server` | server | Conversions APIs: Meta, Google Ads, Microsoft, Reddit, LinkedIn, OpenAI |
|
|
37
|
+
| `@shware/analytics/server/legacy` | server | The old Meta sender built on `facebook-nodejs-business-sdk` |
|
|
38
|
+
| `@shware/analytics/attribution` | server | `classifyTouch` and the channel vocabulary for reading sessions |
|
|
39
|
+
| `@shware/analytics/ads` | server | Pulling spend and performance from Google Ads and Meta |
|
|
40
40
|
|
|
41
41
|
## Client-side only
|
|
42
42
|
|
|
@@ -68,7 +68,7 @@ setupAnalytics({
|
|
|
68
68
|
release: version,
|
|
69
69
|
platform: 'web',
|
|
70
70
|
environment: process.env.NODE_ENV === 'development' ? 'development' : 'production',
|
|
71
|
-
// Optional: every tracked event is also handed to these, and
|
|
71
|
+
// Optional: every tracked event is also handed to these, and identify / reset to the setters.
|
|
72
72
|
thirdPartyTrackers: [sendGAEvent, sendPosthogEvent],
|
|
73
73
|
thirdPartyUserSetters: [setGAUser, setPosthogUser],
|
|
74
74
|
endpoint: 'https://api.example.com/v1/analytics',
|
|
@@ -141,20 +141,25 @@ export const startInstance = createStart(() => ({ requestMiddleware: [clickIdMid
|
|
|
141
141
|
## Usage
|
|
142
142
|
|
|
143
143
|
```tsx
|
|
144
|
-
import {
|
|
145
|
-
|
|
146
|
-
function
|
|
147
|
-
const
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
144
|
+
import { identify, reset, track } from '@shware/analytics';
|
|
145
|
+
|
|
146
|
+
async function login() {
|
|
147
|
+
const user = await api.login();
|
|
148
|
+
// Binds this visitor to the signed-in user (see Visitors below). Call it on every page load
|
|
149
|
+
// once someone is signed in; the second argument is handed to the pixels for matching only.
|
|
150
|
+
identify(user.id, { email: user.email });
|
|
151
|
+
track('login', { method: 'google' });
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
async function logout() {
|
|
155
|
+
await api.logout();
|
|
156
|
+
// `logout` first: it still belongs to the user leaving.
|
|
157
|
+
track('logout');
|
|
158
|
+
reset();
|
|
154
159
|
}
|
|
155
160
|
```
|
|
156
161
|
|
|
157
|
-
|
|
162
|
+
`reset()` is sign-out, as in PostHog: the current session ends (its unreported engagement goes out as a `user_engagement` with `trigger: 'reset'`), a new visitor starts on the device, and the third-party setters drop the user. What happens until the next sign-in is anonymous and belongs to whoever signs in next; the visitor left behind keeps the previous user's history. Call it when the session ends any other way too (expiry, deletion), and from every tab that notices, however late: it only replaces the visitor while the device's identity is still the one that page identified, so a second tab calling it does not cut the new anonymous visitor off, nor reset the next user who has signed in since. `identify` resets by itself when a different user signs in than the one it last identified on the device, so a sign-out the host missed does not hand one user's visitor to the next. The device id and the first visit or first open are the device's and stay.
|
|
158
163
|
|
|
159
164
|
### Typed events and strict event names
|
|
160
165
|
|
|
@@ -287,18 +292,27 @@ the events are the visitor's record. The server:
|
|
|
287
292
|
geolocation and user agent) as both `tags` and `initial_tags`, and the bot verdict from them.
|
|
288
293
|
- **refreshes `visitor.tags` from each `session_start`**: `tags` is the last-touch counterpart to
|
|
289
294
|
`initial_tags` (browser, release, landing), and a session's opening is where a visit came in, so
|
|
290
|
-
once per session is both enough and the right moment. `
|
|
295
|
+
once per session is both enough and the right moment. `identify` sends no tags (11.1): at
|
|
291
296
|
sign-in the page is the login page, and its tags would overwrite the landing's. Clients before
|
|
292
297
|
11.1 still send tags on their PATCH; merge them when present.
|
|
293
|
-
- **binds it to the user from an `identify` event** (`IDENTIFY_EVENT`): `
|
|
298
|
+
- **binds it to the user from an `identify` event** (`IDENTIFY_EVENT`): `identify` (11.2) sends no
|
|
294
299
|
request of its own — it hands the user to gtag and the pixels at once, and queues
|
|
295
300
|
`identify` with `{ user_id }` when the user differs from the one the page last identified. In
|
|
296
301
|
the batch's transaction, after creating the visitor, set its `user_id` and `distinct_id` to that
|
|
297
302
|
user (taking only a valid uuid, so a host's own event of that name binds nothing). Creation and
|
|
298
303
|
binding then travel in one request, in order: the binding can never arrive before the visitor.
|
|
299
304
|
`identify` is the SDK's: never forward it to the ad platforms or a CRM.
|
|
305
|
+
- **binds a visitor to one user only (15)**: bind only while the visitor has no user or already
|
|
306
|
+
has this one; a visitor bound to someone else keeps them, and the identify binds nothing. From
|
|
307
|
+
15 the SDK starts a new visitor at sign-out and before another user's sign-in, so its own
|
|
308
|
+
identify never meets this — but a device that upgrades from a client before 15 while signed out
|
|
309
|
+
has no user in its storage to compare, and without this the next account signing in there would
|
|
310
|
+
take the previous user's whole history. That account's events stay on the old visitor until it
|
|
311
|
+
signs out. Ship this together with the upgrade to 15, not before: a client before 15 never
|
|
312
|
+
starts a new visitor, so the first user on a shared device would keep every later user's events.
|
|
300
313
|
- **keeps `PATCH /visitors/:id`** for clients before 11.2, which bind the user there — answer 404
|
|
301
314
|
for a visitor no event has created, and merge the `tags` of clients before 11.1 when present.
|
|
315
|
+
The same one-user rule applies to its binding.
|
|
302
316
|
- **keeps `POST /visitors`** (`createVisitorSchema`) while clients before 11.0 are in use.
|
|
303
317
|
|
|
304
318
|
Deploy the server first: a server that only creates visitors on `POST /visitors` rejects the
|
|
@@ -533,9 +547,10 @@ What the SDK guarantees for this to hold:
|
|
|
533
547
|
- `session_id` is a client-generated uuidv7 persisted in `config.storage`, shared across tabs and
|
|
534
548
|
reloads. It is a grouping key, not an identity: event and visitor ids are the server's.
|
|
535
549
|
- The person a visitor belongs to is the server's too: `visitor.distinct_id`, the visitor's own id
|
|
536
|
-
until someone signs in on it and the user's id from then on. The client never sends it;
|
|
537
|
-
|
|
538
|
-
|
|
550
|
+
until someone signs in on it and the user's id from then on. The client never sends it; PostHog
|
|
551
|
+
is identified by the user's id, which is that value once a user is known. A visitor only ever
|
|
552
|
+
belongs to one user: `reset()` starts
|
|
553
|
+
a new one at sign-out, and `identify` does when another user signs in over the last one.
|
|
539
554
|
|
|
540
555
|
## Ad performance (`@shware/analytics/ads`)
|
|
541
556
|
|
|
@@ -7,7 +7,13 @@ const keys = {
|
|
|
7
7
|
first_visit_time: "first_visit_time",
|
|
8
8
|
/** Native: when a launch took the install referrer's utm as its own (see native `getTags`). */
|
|
9
9
|
install_referrer_claim_time: "install_referrer_claim_time",
|
|
10
|
-
session: "session"
|
|
10
|
+
session: "session",
|
|
11
|
+
/**
|
|
12
|
+
* The user `identify` last identified on this device, cleared by `reset()`: a different user
|
|
13
|
+
* signing in over it (an expired session, a sign-out the host never reported) resets first,
|
|
14
|
+
* rather than carrying the previous user's visitor over to the next.
|
|
15
|
+
*/
|
|
16
|
+
user_id: "user_id"
|
|
11
17
|
};
|
|
12
18
|
exports.keys = keys;
|
|
13
19
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.cjs","names":[],"sources":["../../src/constants/storage.ts"],"sourcesContent":["export const keys = {\n device_id: 'device_id',\n visitor_id: 'visitor_id',\n first_open_time: 'first_open_time',\n first_visit_time: 'first_visit_time',\n /** Native: when a launch took the install referrer's utm as its own (see native `getTags`). */\n install_referrer_claim_time: 'install_referrer_claim_time',\n session: 'session',\n} as const;\n"],"mappings":";;AAAA,MAAa,OAAO;CAClB,WAAW;CACX,YAAY;CACZ,iBAAiB;CACjB,kBAAkB;;CAElB,6BAA6B;CAC7B,SAAS;AACX"}
|
|
1
|
+
{"version":3,"file":"storage.cjs","names":[],"sources":["../../src/constants/storage.ts"],"sourcesContent":["export const keys = {\n device_id: 'device_id',\n visitor_id: 'visitor_id',\n first_open_time: 'first_open_time',\n first_visit_time: 'first_visit_time',\n /** Native: when a launch took the install referrer's utm as its own (see native `getTags`). */\n install_referrer_claim_time: 'install_referrer_claim_time',\n session: 'session',\n /**\n * The user `identify` last identified on this device, cleared by `reset()`: a different user\n * signing in over it (an expired session, a sign-out the host never reported) resets first,\n * rather than carrying the previous user's visitor over to the next.\n */\n user_id: 'user_id',\n} as const;\n"],"mappings":";;AAAA,MAAa,OAAO;CAClB,WAAW;CACX,YAAY;CACZ,iBAAiB;CACjB,kBAAkB;;CAElB,6BAA6B;CAC7B,SAAS;;;;;;CAMT,SAAS;AACX"}
|
|
@@ -6,5 +6,11 @@ export declare const keys: {
|
|
|
6
6
|
/** Native: when a launch took the install referrer's utm as its own (see native `getTags`). */
|
|
7
7
|
readonly install_referrer_claim_time: 'install_referrer_claim_time';
|
|
8
8
|
readonly session: 'session';
|
|
9
|
+
/**
|
|
10
|
+
* The user `identify` last identified on this device, cleared by `reset()`: a different user
|
|
11
|
+
* signing in over it (an expired session, a sign-out the host never reported) resets first,
|
|
12
|
+
* rather than carrying the previous user's visitor over to the next.
|
|
13
|
+
*/
|
|
14
|
+
readonly user_id: 'user_id';
|
|
9
15
|
};
|
|
10
16
|
//# sourceMappingURL=storage.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.d.cts","names":[],"sources":["../../src/constants/storage.ts"],"mappings":"A,qBAAa;WACX;WACA;WACA;WACA;;WAEA;WACA"}
|
|
1
|
+
{"version":3,"file":"storage.d.cts","names":[],"sources":["../../src/constants/storage.ts"],"mappings":"A,qBAAa;WACX;WACA;WACA;WACA;;WAEA;WACA;;;;;;WAMA"}
|
|
@@ -6,5 +6,11 @@ export declare const keys: {
|
|
|
6
6
|
/** Native: when a launch took the install referrer's utm as its own (see native `getTags`). */
|
|
7
7
|
readonly install_referrer_claim_time: 'install_referrer_claim_time';
|
|
8
8
|
readonly session: 'session';
|
|
9
|
+
/**
|
|
10
|
+
* The user `identify` last identified on this device, cleared by `reset()`: a different user
|
|
11
|
+
* signing in over it (an expired session, a sign-out the host never reported) resets first,
|
|
12
|
+
* rather than carrying the previous user's visitor over to the next.
|
|
13
|
+
*/
|
|
14
|
+
readonly user_id: 'user_id';
|
|
9
15
|
};
|
|
10
16
|
//# sourceMappingURL=storage.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.d.mts","names":[],"sources":["../../src/constants/storage.ts"],"mappings":"A,qBAAa;WACX;WACA;WACA;WACA;;WAEA;WACA"}
|
|
1
|
+
{"version":3,"file":"storage.d.mts","names":[],"sources":["../../src/constants/storage.ts"],"mappings":"A,qBAAa;WACX;WACA;WACA;WACA;;WAEA;WACA;;;;;;WAMA"}
|
|
@@ -6,7 +6,13 @@ const keys = {
|
|
|
6
6
|
first_visit_time: "first_visit_time",
|
|
7
7
|
/** Native: when a launch took the install referrer's utm as its own (see native `getTags`). */
|
|
8
8
|
install_referrer_claim_time: "install_referrer_claim_time",
|
|
9
|
-
session: "session"
|
|
9
|
+
session: "session",
|
|
10
|
+
/**
|
|
11
|
+
* The user `identify` last identified on this device, cleared by `reset()`: a different user
|
|
12
|
+
* signing in over it (an expired session, a sign-out the host never reported) resets first,
|
|
13
|
+
* rather than carrying the previous user's visitor over to the next.
|
|
14
|
+
*/
|
|
15
|
+
user_id: "user_id"
|
|
10
16
|
};
|
|
11
17
|
export { keys };
|
|
12
18
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.mjs","names":[],"sources":["../../src/constants/storage.ts"],"sourcesContent":["export const keys = {\n device_id: 'device_id',\n visitor_id: 'visitor_id',\n first_open_time: 'first_open_time',\n first_visit_time: 'first_visit_time',\n /** Native: when a launch took the install referrer's utm as its own (see native `getTags`). */\n install_referrer_claim_time: 'install_referrer_claim_time',\n session: 'session',\n} as const;\n"],"mappings":";AAAA,MAAa,OAAO;CAClB,WAAW;CACX,YAAY;CACZ,iBAAiB;CACjB,kBAAkB;;CAElB,6BAA6B;CAC7B,SAAS;AACX"}
|
|
1
|
+
{"version":3,"file":"storage.mjs","names":[],"sources":["../../src/constants/storage.ts"],"sourcesContent":["export const keys = {\n device_id: 'device_id',\n visitor_id: 'visitor_id',\n first_open_time: 'first_open_time',\n first_visit_time: 'first_visit_time',\n /** Native: when a launch took the install referrer's utm as its own (see native `getTags`). */\n install_referrer_claim_time: 'install_referrer_claim_time',\n session: 'session',\n /**\n * The user `identify` last identified on this device, cleared by `reset()`: a different user\n * signing in over it (an expired session, a sign-out the host never reported) resets first,\n * rather than carrying the previous user's visitor over to the next.\n */\n user_id: 'user_id',\n} as const;\n"],"mappings":";AAAA,MAAa,OAAO;CAClB,WAAW;CACX,YAAY;CACZ,iBAAiB;CACjB,kBAAkB;;CAElB,6BAA6B;CAC7B,SAAS;;;;;;CAMT,SAAS;AACX"}
|
package/dist/index.cjs
CHANGED
|
@@ -23,10 +23,11 @@ exports.createLinkSchema = require_schema_index.createLinkSchema;
|
|
|
23
23
|
exports.createTrackEventSchema = require_schema_index.createTrackEventSchema;
|
|
24
24
|
exports.createVisitorSchema = require_schema_index.createVisitorSchema;
|
|
25
25
|
exports.getLink = require_link_index.getLink;
|
|
26
|
+
exports.identify = require_visitor_index.identify;
|
|
27
|
+
exports.reset = require_visitor_index.reset;
|
|
26
28
|
exports.sendBeacon = require_track_index.sendBeacon;
|
|
27
29
|
exports.sendFeedback = require_feedback_index.sendFeedback;
|
|
28
30
|
exports.sendPendingEvents = require_track_index.sendPendingEvents;
|
|
29
|
-
exports.setVisitor = require_visitor_index.setVisitor;
|
|
30
31
|
exports.setupAnalytics = require_setup_index.setupAnalytics;
|
|
31
32
|
Object.defineProperty(exports, "stripeMinorUnits", {
|
|
32
33
|
enumerable: true,
|
package/dist/index.d.cts
CHANGED
|
@@ -8,7 +8,7 @@ import { setupAnalytics } from "./setup/index.cjs";
|
|
|
8
8
|
import { sendBeacon, sendPendingEvents, track } from "./track/index.cjs";
|
|
9
9
|
import { TrackOnceOptions, trackOnce } from "./track/once.cjs";
|
|
10
10
|
import { visitorId } from "./visitor/id.cjs";
|
|
11
|
-
import { IDENTIFY_EVENT,
|
|
11
|
+
import { IDENTIFY_EVENT, identify, reset } from "./visitor/index.cjs";
|
|
12
12
|
import { Link, createLink, getLink } from "./link/index.cjs";
|
|
13
13
|
import { stripeMinorUnits } from "./utils/stripe.cjs";
|
|
14
|
-
export { ALL_ENVIRONMENTS, ALL_PLATFORMS, type AllowedPropertyValues, type AnalyticsOptions, BOT_CATEGORIES, type Bot, type BotCategory, type CreateFeedbackDTO, type CreateLinkDTO, type CreateTrackEventDTO, type CreateVisitorDTO, type CustomEventProperties, type Environment, IDENTIFY_EVENT, type Link, NOT_A_BOT, type Platform, type TrackOnceOptions, type TrackProperties, type TrackTags, type UTMParams, type UpdateVisitorDTO, type UserProvidedData, type VisitorProperties, botOf, createFeedbackSchema, createLink, createLinkSchema, createTrackEventSchema, createVisitorSchema, getLink, sendBeacon, sendFeedback, sendPendingEvents,
|
|
14
|
+
export { ALL_ENVIRONMENTS, ALL_PLATFORMS, type AllowedPropertyValues, type AnalyticsOptions, BOT_CATEGORIES, type Bot, type BotCategory, type CreateFeedbackDTO, type CreateLinkDTO, type CreateTrackEventDTO, type CreateVisitorDTO, type CustomEventProperties, type Environment, IDENTIFY_EVENT, type Link, NOT_A_BOT, type Platform, type TrackOnceOptions, type TrackProperties, type TrackTags, type UTMParams, type UpdateVisitorDTO, type UserProvidedData, type VisitorProperties, botOf, createFeedbackSchema, createLink, createLinkSchema, createTrackEventSchema, createVisitorSchema, getLink, identify, reset, sendBeacon, sendFeedback, sendPendingEvents, setupAnalytics, stripeMinorUnits, track, trackOnce, updateVisitorSchema, useTrackImpression, visitorId };
|
package/dist/index.d.mts
CHANGED
|
@@ -8,7 +8,7 @@ import { setupAnalytics } from "./setup/index.mjs";
|
|
|
8
8
|
import { sendBeacon, sendPendingEvents, track } from "./track/index.mjs";
|
|
9
9
|
import { TrackOnceOptions, trackOnce } from "./track/once.mjs";
|
|
10
10
|
import { visitorId } from "./visitor/id.mjs";
|
|
11
|
-
import { IDENTIFY_EVENT,
|
|
11
|
+
import { IDENTIFY_EVENT, identify, reset } from "./visitor/index.mjs";
|
|
12
12
|
import { Link, createLink, getLink } from "./link/index.mjs";
|
|
13
13
|
import { stripeMinorUnits } from "./utils/stripe.mjs";
|
|
14
|
-
export { ALL_ENVIRONMENTS, ALL_PLATFORMS, type AllowedPropertyValues, type AnalyticsOptions, BOT_CATEGORIES, type Bot, type BotCategory, type CreateFeedbackDTO, type CreateLinkDTO, type CreateTrackEventDTO, type CreateVisitorDTO, type CustomEventProperties, type Environment, IDENTIFY_EVENT, type Link, NOT_A_BOT, type Platform, type TrackOnceOptions, type TrackProperties, type TrackTags, type UTMParams, type UpdateVisitorDTO, type UserProvidedData, type VisitorProperties, botOf, createFeedbackSchema, createLink, createLinkSchema, createTrackEventSchema, createVisitorSchema, getLink, sendBeacon, sendFeedback, sendPendingEvents,
|
|
14
|
+
export { ALL_ENVIRONMENTS, ALL_PLATFORMS, type AllowedPropertyValues, type AnalyticsOptions, BOT_CATEGORIES, type Bot, type BotCategory, type CreateFeedbackDTO, type CreateLinkDTO, type CreateTrackEventDTO, type CreateVisitorDTO, type CustomEventProperties, type Environment, IDENTIFY_EVENT, type Link, NOT_A_BOT, type Platform, type TrackOnceOptions, type TrackProperties, type TrackTags, type UTMParams, type UpdateVisitorDTO, type UserProvidedData, type VisitorProperties, botOf, createFeedbackSchema, createLink, createLinkSchema, createTrackEventSchema, createVisitorSchema, getLink, identify, reset, sendBeacon, sendFeedback, sendPendingEvents, setupAnalytics, stripeMinorUnits, track, trackOnce, updateVisitorSchema, useTrackImpression, visitorId };
|
package/dist/index.mjs
CHANGED
|
@@ -2,11 +2,11 @@ import { setupAnalytics } from "./setup/index.mjs";
|
|
|
2
2
|
import { visitorId } from "./visitor/id.mjs";
|
|
3
3
|
import { sendBeacon, sendPendingEvents, track } from "./track/index.mjs";
|
|
4
4
|
import { trackOnce } from "./track/once.mjs";
|
|
5
|
-
import { IDENTIFY_EVENT,
|
|
5
|
+
import { IDENTIFY_EVENT, identify, reset } from "./visitor/index.mjs";
|
|
6
6
|
import { sendFeedback } from "./feedback/index.mjs";
|
|
7
7
|
import { createLink, getLink } from "./link/index.mjs";
|
|
8
8
|
import { ALL_ENVIRONMENTS, ALL_PLATFORMS, createFeedbackSchema, createLinkSchema, createTrackEventSchema, createVisitorSchema, updateVisitorSchema } from "./schema/index.mjs";
|
|
9
9
|
import { BOT_CATEGORIES, NOT_A_BOT, botOf } from "./bot/index.mjs";
|
|
10
10
|
import { stripeMinorUnits } from "./utils/stripe.mjs";
|
|
11
11
|
import { useTrackImpression } from "./hooks/use-track-impression.mjs";
|
|
12
|
-
export { ALL_ENVIRONMENTS, ALL_PLATFORMS, BOT_CATEGORIES, IDENTIFY_EVENT, NOT_A_BOT, botOf, createFeedbackSchema, createLink, createLinkSchema, createTrackEventSchema, createVisitorSchema, getLink, sendBeacon, sendFeedback, sendPendingEvents,
|
|
12
|
+
export { ALL_ENVIRONMENTS, ALL_PLATFORMS, BOT_CATEGORIES, IDENTIFY_EVENT, NOT_A_BOT, botOf, createFeedbackSchema, createLink, createLinkSchema, createTrackEventSchema, createVisitorSchema, getLink, identify, reset, sendBeacon, sendFeedback, sendPendingEvents, setupAnalytics, stripeMinorUnits, track, trackOnce, updateVisitorSchema, useTrackImpression, visitorId };
|
package/dist/schema/index.cjs
CHANGED
|
@@ -254,7 +254,7 @@ const updateVisitorSchema = (0, zod_mini.object)({
|
|
|
254
254
|
/**
|
|
255
255
|
* Sent by clients before 11.1, which PATCHed their tags on every page load. From 11.1 the
|
|
256
256
|
* server refreshes `visitor.tags` from each `session_start` — the moment the visit arrives —
|
|
257
|
-
* and `
|
|
257
|
+
* and `identify` sends none: at sign-in the page is no longer where the visit came in.
|
|
258
258
|
*/
|
|
259
259
|
tags: (0, zod_mini.optional)(tagsSchema)
|
|
260
260
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","names":["pipe","string","transform","array","record","union","number","boolean","_null","object","optional","trim","minLength","maxLength","regex","uuid","_enum","iso","toLowerCase","email","e164","toUpperCase","url"],"sources":["../../src/schema/index.ts"],"sourcesContent":["import {\n enum as _enum,\n null as _null,\n array,\n boolean,\n e164,\n email,\n iso,\n maxLength,\n minLength,\n number,\n object,\n optional,\n pipe,\n record,\n regex,\n string,\n toLowerCase,\n toUpperCase,\n transform,\n trim,\n union,\n url,\n uuid,\n type z,\n} from 'zod/mini';\nimport type { Environment, Platform } from '../track/types';\n\nconst MAX_KEY_LENGTH = 128;\nconst MAX_VALUE_LENGTH = 512;\nconst MAX_PROPERTIES = 64;\n\n/**\n * Truncated rather than rejected. These schemas validate a whole batch at once, so refusing one\n * oversized value costs every event that traveled with it — and the values that overrun are the\n * ones derived from the page (a link's text, a URL carrying a long query), which no client can\n * bound in advance. A shortened value is worth more than a lost batch.\n */\nconst propertyText = pipe(\n string(),\n transform((value) => value.slice(0, MAX_VALUE_LENGTH))\n);\n\n/**\n * Tags are truncated for the same reason property values are, and they are stored more than once\n * (on the event, the session and the visitor), so an unbounded one costs several times over.\n * 1024 sits just above what GA4 itself keeps (1000 characters of page_location, 420 of\n * page_referrer, 300 of page_title). Real tags stay under ~500 characters; the rare longer ones\n * are page_referrer values from search and ad redirect URLs, where the kept prefix — host and\n * path — is the part that matters.\n */\nconst MAX_TAG_LENGTH = 1024;\n\nconst tagText = pipe(\n string(),\n transform((value) => value.slice(0, MAX_TAG_LENGTH))\n);\n\n/**\n * Keys are written by hand in instrumentation code, so an unusable one is a mistake in the host\n * rather than something the visitor typed. It is still dropped rather than rejected, for the same\n * reason: the mistake should cost that property, not the batch it happens to be in. Truncating a\n * key is not an option — two long keys would silently become one field.\n *\n * The key schema below is deliberately permissive so that this transform is reached at all; the\n * trimming it used to do happens here instead. `MAX_PROPERTIES` keeps the first N in insertion\n * order.\n */\nfunction takeProperties<T>(data: Record<string, T>): Record<string, T> {\n const result: Record<string, T> = {};\n let count = 0;\n for (const [rawKey, value] of Object.entries(data)) {\n if (count >= MAX_PROPERTIES) break;\n const key = rawKey.trim();\n if (!key || key.length > MAX_KEY_LENGTH) continue;\n result[key] = value;\n count++;\n }\n return result;\n}\n\n/**\n * Capped at GA4's own item-list limit, and truncated rather than rejected like every other\n * property limit here: an unbounded array is the one field a caller could still blow a batch\n * up with after the value and key limits.\n */\nconst MAX_ITEMS = 200;\n\nconst items = pipe(\n array(\n pipe(\n record(string(), union([propertyText, number(), boolean(), _null()])),\n transform(takeProperties)\n )\n ),\n transform((list) => list.slice(0, MAX_ITEMS))\n);\n\nexport const ALL_PLATFORMS = [\n 'ios',\n 'android',\n 'web',\n 'macos',\n 'windows',\n 'linux',\n 'unknown',\n] as const satisfies Platform[];\n\nexport const ALL_ENVIRONMENTS = ['development', 'production'] as const satisfies Environment[];\n\nexport const tagsSchema = object({\n os: optional(tagText),\n os_name: optional(tagText),\n os_version: optional(tagText),\n browser: optional(tagText),\n browser_name: optional(tagText),\n browser_version: optional(tagText),\n device: optional(tagText),\n device_id: optional(string().check(trim(), minLength(1), maxLength(36))),\n device_type: optional(tagText),\n device_vendor: optional(tagText),\n device_pixel_ratio: optional(number()),\n screen_width: optional(number()),\n screen_height: optional(number()),\n screen_resolution: optional(\n pipe(\n string().check(regex(/^\\d+x\\d+$/)),\n transform((v) => v as `${number}x${number}`)\n )\n ),\n webdriver: optional(boolean()),\n release: optional(tagText),\n language: optional(tagText),\n time_zone: optional(tagText),\n page_location: optional(tagText),\n page_referrer: optional(tagText),\n page_title: optional(tagText),\n page_load_id: optional(tagText),\n /**\n * @deprecated Renamed to `page_location` in 7.0.0. Accepted so that events from clients\n * still on an older SDK are not stripped of their page URL at this boundary — a browser\n * bundle stays cached long after a backend deploys. Remove once those clients are gone;\n * `pageLocation` in `server/page-location.ts` is the only reader.\n */\n // oxlint-disable-next-line typescript/no-deprecated -- Legacy input from pre-7.0 clients must survive validation.\n source_url: optional(tagText),\n // app info\n advertising_id: optional(tagText),\n install_referrer: optional(tagText),\n // Ad click ids (URL parameters) and ad platform cookies (underscore names); see AdvertisingInfo.\n // Meta Ads\n fbclid: optional(tagText),\n ad_id: optional(tagText),\n ad_name: optional(tagText),\n adset_id: optional(tagText),\n adset_name: optional(tagText),\n campaign_id: optional(tagText),\n campaign_name: optional(tagText),\n placement: optional(tagText),\n _fbc: optional(tagText),\n _fbp: optional(tagText),\n /**\n * @deprecated `fbc` / `fbp` / `rdt_uuid` were renamed to `_fbc` / `_fbp` / `_rdt_uuid` in 9.0.0.\n * Accepted so that conversions from clients still on an older SDK keep their match keys; the\n * senders read them only as a fallback (`server/click-ids.ts`). Remove once those clients are\n * gone.\n */\n // oxlint-disable-next-line typescript/no-deprecated -- Legacy pre-9.0 click-id fields must survive validation.\n fbc: optional(tagText),\n fbp: optional(tagText),\n rdt_uuid: optional(tagText),\n // Google Ads\n gclid: optional(tagText),\n gclsrc: optional(tagText),\n gad_source: optional(tagText),\n gad_campaignid: optional(tagText),\n network: optional(tagText),\n match_type: optional(tagText),\n wbraid: optional(tagText),\n gbraid: optional(tagText),\n dclid: optional(tagText),\n _gcl_aw: optional(tagText),\n _gcl_gb: optional(tagText),\n // Microsoft Ads\n msclkid: optional(tagText),\n _uetmsclkid: optional(tagText),\n // Reddit Ads\n rdt_cid: optional(tagText),\n _rdt_cid: optional(tagText),\n _rdt_uuid: optional(tagText),\n // LinkedIn Ads\n li_fat_id: optional(tagText),\n _li_fat_id: optional(tagText),\n // OpenAI Ads\n oppref: optional(tagText),\n __oppref: optional(tagText),\n __obref: optional(tagText),\n // other click ids\n ko_click_id: optional(tagText),\n ScCid: optional(tagText),\n ttclid: optional(tagText),\n twclid: optional(tagText),\n yclid: optional(tagText),\n epik: optional(tagText),\n // utm params\n utm_source: optional(tagText),\n utm_medium: optional(tagText),\n utm_campaign: optional(tagText),\n utm_term: optional(tagText),\n utm_content: optional(tagText),\n utm_id: optional(tagText),\n utm_source_platform: optional(tagText),\n utm_creative_format: optional(tagText),\n utm_marketing_tactic: optional(tagText),\n});\n\nexport const propertiesSchema = optional(\n pipe(\n record(string(), union([propertyText, number(), boolean(), _null(), items])),\n transform(takeProperties)\n )\n);\n\n/**\n * How far an event's time may be from the server's before the client clock it was stamped with is\n * taken as wrong. A batch legitimately arrives late — a tab frozen in the background, a\n * session_start held back after a failed batch — by hours, not days; a phone set to another year\n * writes its sessions into that year.\n */\nconst MAX_CLOCK_SKEW = 24 * 60 * 60 * 1000;\n\n/**\n * Puts the events stamped by a wrong client clock onto the server's, where they are parsed. Only\n * the events outside `MAX_CLOCK_SKEW` move, so one bad event cannot drag the rest of its batch\n * along: they move together by their own latest one — the wrong clock at sending — keeping their\n * order and spacing, and one still out after that (a batch mixing two wrong clocks) is on no clock\n * at all and takes the server's time. Corrected rather than rejected, for the same reason values\n * are truncated: a wrong clock should cost the event its time, not the batch its events.\n */\nfunction alignClock<T extends { timestamp: string }>(events: T[], now = Date.now()): T[] {\n const within = (time: number) => Math.abs(now - time) <= MAX_CLOCK_SKEW;\n const times = events.map((event) => Date.parse(event.timestamp));\n const wrong = times.filter((time) => !within(time));\n if (wrong.length === 0) return events;\n const offset = now - Math.max(...wrong);\n return events.map((event, i) => {\n if (within(times[i])) return event;\n const shifted = times[i] + offset;\n return { ...event, timestamp: new Date(within(shifted) ? shifted : now).toISOString() };\n });\n}\n\nexport const createTrackEventSchema = pipe(\n array(\n object({\n /**\n * The event's id, generated by the client when the event was tracked (12.1) and given to\n * the browser pixels as their deduplication id. Store the event under it with\n * `on conflict (id) do nothing`: a batch retried after the server committed it then\n * stores nothing twice. Optional for clients before 12.1, which send none — generate one\n * on the server for those.\n */\n id: optional(uuid({ version: 'v7' })),\n name: string().check(trim(), minLength(1), maxLength(64)),\n // Generated by the SDK, like `id` (`visitorId()`, `Session`): uuidv7 as well, so the\n // constraint is checked here once and the server need not check it again.\n visitor_id: uuid({ version: 'v7' }),\n session_id: uuid({ version: 'v7' }),\n platform: _enum(ALL_PLATFORMS),\n environment: _enum(ALL_ENVIRONMENTS),\n timestamp: iso.datetime(),\n tags: tagsSchema,\n properties: propertiesSchema,\n })\n ).check(minLength(1), maxLength(100)),\n transform((events) => alignClock(events))\n);\n\n/**\n * `POST /visitors`, what clients before 11.0 create their visitor with; 11.0 generates the id\n * itself and the server creates the visitor from its first events (README, \"Visitors\").\n * Kept for servers that still serve older clients.\n */\nexport const createVisitorSchema = object({\n device_id: string().check(trim(), minLength(1), maxLength(36)),\n platform: _enum(ALL_PLATFORMS),\n environment: _enum(ALL_ENVIRONMENTS),\n tags: tagsSchema,\n});\n\nconst emailValue = pipe(string().check(trim(), toLowerCase(), maxLength(320)), email());\n\n/** E.164: a plus sign (+) prefix, country code, then digits only, no dashes/parens/spaces. */\nconst phoneValue = pipe(string().check(trim()), e164());\n\nconst addressValue = object({\n first_name: optional(string().check(trim(), maxLength(128))),\n last_name: optional(string().check(trim(), maxLength(128))),\n street: optional(string().check(trim(), maxLength(256))),\n city: optional(string().check(trim(), maxLength(128))),\n /** User province, state, or region. Example: `Hampshire` */\n region: optional(string().check(trim(), maxLength(128))),\n postal_code: optional(string().check(trim(), maxLength(32))),\n /** 2-letter country code, per the ISO 3166-1 alpha-2 standard. Example: `UK` */\n country: optional(string().check(trim(), toUpperCase(), regex(/^[A-Z]{2}$/))),\n});\n\n/**\n * User-provided data (UPD) used for enhanced conversions, Customer Match, and demographics.\n * Values are sent unhashed; Google normalizes and hashes them before they reach its servers.\n *\n * Multiple values may be sent to increase the match rate: up to 3 emails, 3 phone numbers, and\n * 2 addresses.\n *\n * @see https://support.google.com/analytics/answer/14078702\n * @see https://support.google.com/google-ads/answer/13258081\n */\nexport const userProvidedDataSchema = object({\n email: optional(union([emailValue, array(emailValue).check(minLength(1), maxLength(3))])),\n phone_number: optional(union([phoneValue, array(phoneValue).check(minLength(1), maxLength(3))])),\n address: optional(union([addressValue, array(addressValue).check(minLength(1), maxLength(2))])),\n});\n\nexport const updateVisitorSchema = object({\n user_id: optional(uuid()),\n user_data: optional(userProvidedDataSchema),\n /**\n * Sent by clients before 11.1, which PATCHed their tags on every page load. From 11.1 the\n * server refreshes `visitor.tags` from each `session_start` — the moment the visit arrives —\n * and `setVisitor` sends none: at sign-in the page is no longer where the visit came in.\n */\n tags: optional(tagsSchema),\n});\n\nexport const createFeedbackSchema = object({\n name: string().check(minLength(1), maxLength(256)),\n // Trimmed and lower-cased like every other email the SDK accepts, so a host stores the\n // normalized form without wrapping the schema.\n email: emailValue,\n message: string().check(minLength(1), maxLength(65536)),\n /**\n * The Cloudflare Turnstile token the host verifies before storing the feedback (the same field\n * `@shware/security`'s email-code request carries). Required: without it `POST /feedback` is an\n * open free-text write that only a rate limit protects. Single-use: Turnstile spends the token\n * at verification, so the caller resets the widget after every submit, success or failure.\n */\n turnstileToken: string().check(minLength(1), maxLength(2048)),\n});\n\nconst noEmptyString = pipe(\n string().check(maxLength(256)),\n transform((v) => (v ? v : undefined))\n);\n\n/**\n * The schema for creating a link.\n * @see https://support.google.com/analytics/answer/10917952\n * */\nexport const createLinkSchema = object({\n /** The URL that the user is redirected to. */\n url: url().check(minLength(1), maxLength(1024)), // required\n\n /**\n * Campaign ID. Used to identify a specific campaign or promotion. This is a required key for GA4\n * data import. Use the same IDs that you use when uploading campaign cost data.\n */\n utm_id: optional(noEmptyString),\n\n /** Referrer, for example: google, newsletter4, billboard */\n utm_source: string().check(minLength(1), maxLength(256)), // required\n\n /** Marketing medium, for example: cpc, banner, email */\n utm_medium: string().check(minLength(1), maxLength(256)), // required\n\n /** Product, slogan, promo code, for example, spring_sale */\n utm_campaign: string().check(minLength(1), maxLength(256)), // required\n\n /** Paid keyword */\n utm_term: optional(noEmptyString),\n\n /**\n * Use to differentiate creatives. For example, if you have two call-to-action links within the\n * same email message, you can use utm_content and set different values for each so you can tell\n * which version is more effective.\n */\n utm_content: optional(noEmptyString),\n\n /**\n * The platform responsible for directing traffic to a given Analytics property (such as a buying\n * platform that sets budgets and targeting criteria or a platform that manages organic traffic\n * data). For example, Search Ads 360 or Display & Video 360.\n */\n utm_source_platform: optional(noEmptyString),\n\n /**\n * Type of creative, for example, display, native, video, search, utm_creative_format is not\n * currently reported in Google Analytics 4 properties.\n */\n utm_creative_format: optional(noEmptyString),\n\n /**\n * Targeting criteria applied to a campaign, for example, remarketing, prospecting,\n * utm_marketing_tactic is not currently reported in Google Analytics 4 properties.\n * */\n utm_marketing_tactic: optional(noEmptyString),\n});\n\nexport type CreateTrackEventDTO = z.output<typeof createTrackEventSchema>;\nexport type CreateFeedbackDTO = z.output<typeof createFeedbackSchema>;\nexport type CreateLinkDTO = z.output<typeof createLinkSchema>;\nexport type CreateVisitorDTO = z.output<typeof createVisitorSchema>;\nexport type UserProvidedDataDTO = z.output<typeof userProvidedDataSchema>;\nexport type UpdateVisitorDTO = z.output<typeof updateVisitorSchema>;\n"],"mappings":";;;AA4BA,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,iBAAiB;;;;;;;AAQvB,MAAM,gBAAA,GAAeA,SAAAA,KAAAA,EAAAA,GACnBC,SAAAA,OAAAA,CAAO,IAAA,GACPC,SAAAA,UAAAA,EAAW,UAAU,MAAM,MAAM,GAAG,gBAAgB,CAAC,CACvD;;;;;;;;;AAUA,MAAM,iBAAiB;AAEvB,MAAM,WAAA,GAAUF,SAAAA,KAAAA,EAAAA,GACdC,SAAAA,OAAAA,CAAO,IAAA,GACPC,SAAAA,UAAAA,EAAW,UAAU,MAAM,MAAM,GAAG,cAAc,CAAC,CACrD;;;;;;;;;;;AAYA,SAAS,eAAkB,MAA4C;CACrE,MAAM,SAA4B,CAAC;CACnC,IAAI,QAAQ;CACZ,KAAK,MAAM,CAAC,QAAQ,UAAU,OAAO,QAAQ,IAAI,GAAG;EAClD,IAAI,SAAS,gBAAgB;EAC7B,MAAM,MAAM,OAAO,KAAK;EACxB,IAAI,CAAC,OAAO,IAAI,SAAS,gBAAgB;EACzC,OAAO,OAAO;EACd;CACF;CACA,OAAO;AACT;;;;;;AAOA,MAAM,YAAY;AAElB,MAAM,SAAA,GAAQF,SAAAA,KAAAA,EAAAA,GACZG,SAAAA,MAAAA,EAAAA,GACEH,SAAAA,KAAAA,EAAAA,GACEI,SAAAA,OAAAA,EAAAA,GAAOH,SAAAA,OAAAA,CAAO,IAAA,GAAGI,SAAAA,MAAAA,CAAM;CAAC;EAAcC,GAAAA,SAAAA,OAAAA,CAAO;EAAGC,GAAAA,SAAAA,QAAAA,CAAQ;EAAGC,GAAAA,SAAAA,KAAAA,CAAM;AAAC,CAAC,CAAC,IAAA,GACpEN,SAAAA,UAAAA,CAAU,cAAc,CAC1B,CACF,IAAA,GACAA,SAAAA,UAAAA,EAAW,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC,CAC9C;AAEA,MAAa,gBAAgB;CAC3B;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAEA,MAAa,mBAAmB,CAAC,eAAe,YAAY;AAE5D,MAAa,cAAA,GAAaO,SAAAA,OAAAA,CAAO;CAC/B,KAAA,GAAIC,SAAAA,SAAAA,CAAS,OAAO;CACpB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,eAAA,GAAcA,SAAAA,SAAAA,CAAS,OAAO;CAC9B,kBAAA,GAAiBA,SAAAA,SAAAA,CAAS,OAAO;CACjC,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,YAAA,GAAWA,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,EAAE,CAAC,CAAC;CACvE,cAAA,GAAaH,SAAAA,SAAAA,CAAS,OAAO;CAC7B,gBAAA,GAAeA,SAAAA,SAAAA,CAAS,OAAO;CAC/B,qBAAA,GAAoBA,SAAAA,SAAAA,EAAAA,GAASJ,SAAAA,OAAAA,CAAO,CAAC;CACrC,eAAA,GAAcI,SAAAA,SAAAA,EAAAA,GAASJ,SAAAA,OAAAA,CAAO,CAAC;CAC/B,gBAAA,GAAeI,SAAAA,SAAAA,EAAAA,GAASJ,SAAAA,OAAAA,CAAO,CAAC;CAChC,oBAAA,GAAmBI,SAAAA,SAAAA,EAAAA,GACjBV,SAAAA,KAAAA,EAAAA,GACEC,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMa,SAAAA,MAAAA,CAAM,WAAW,CAAC,IAAA,GACjCZ,SAAAA,UAAAA,EAAW,MAAM,CAA0B,CAC7C,CACF;CACA,YAAA,GAAWQ,SAAAA,SAAAA,EAAAA,GAASH,SAAAA,QAAAA,CAAQ,CAAC;CAC7B,UAAA,GAASG,SAAAA,SAAAA,CAAS,OAAO;CACzB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,YAAA,GAAWA,SAAAA,SAAAA,CAAS,OAAO;CAC3B,gBAAA,GAAeA,SAAAA,SAAAA,CAAS,OAAO;CAC/B,gBAAA,GAAeA,SAAAA,SAAAA,CAAS,OAAO;CAC/B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,eAAA,GAAcA,SAAAA,SAAAA,CAAS,OAAO;;;;;;;CAQ9B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAE5B,iBAAA,GAAgBA,SAAAA,SAAAA,CAAS,OAAO;CAChC,mBAAA,GAAkBA,SAAAA,SAAAA,CAAS,OAAO;CAGlC,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,cAAA,GAAaA,SAAAA,SAAAA,CAAS,OAAO;CAC7B,gBAAA,GAAeA,SAAAA,SAAAA,CAAS,OAAO;CAC/B,YAAA,GAAWA,SAAAA,SAAAA,CAAS,OAAO;CAC3B,OAAA,GAAMA,SAAAA,SAAAA,CAAS,OAAO;CACtB,OAAA,GAAMA,SAAAA,SAAAA,CAAS,OAAO;;;;;;;CAQtB,MAAA,GAAKA,SAAAA,SAAAA,CAAS,OAAO;CACrB,MAAA,GAAKA,SAAAA,SAAAA,CAAS,OAAO;CACrB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAE1B,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,iBAAA,GAAgBA,SAAAA,SAAAA,CAAS,OAAO;CAChC,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CAEzB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,cAAA,GAAaA,SAAAA,SAAAA,CAAS,OAAO;CAE7B,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,YAAA,GAAWA,SAAAA,SAAAA,CAAS,OAAO;CAE3B,YAAA,GAAWA,SAAAA,SAAAA,CAAS,OAAO;CAC3B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAE5B,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CAEzB,cAAA,GAAaA,SAAAA,SAAAA,CAAS,OAAO;CAC7B,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,OAAA,GAAMA,SAAAA,SAAAA,CAAS,OAAO;CAEtB,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,eAAA,GAAcA,SAAAA,SAAAA,CAAS,OAAO;CAC9B,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,cAAA,GAAaA,SAAAA,SAAAA,CAAS,OAAO;CAC7B,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,sBAAA,GAAqBA,SAAAA,SAAAA,CAAS,OAAO;CACrC,sBAAA,GAAqBA,SAAAA,SAAAA,CAAS,OAAO;CACrC,uBAAA,GAAsBA,SAAAA,SAAAA,CAAS,OAAO;AACxC,CAAC;AAED,MAAa,oBAAA,GAAmBA,SAAAA,SAAAA,EAAAA,GAC9BV,SAAAA,KAAAA,EAAAA,GACEI,SAAAA,OAAAA,EAAAA,GAAOH,SAAAA,OAAAA,CAAO,IAAA,GAAGI,SAAAA,MAAAA,CAAM;CAAC;EAAcC,GAAAA,SAAAA,OAAAA,CAAO;EAAGC,GAAAA,SAAAA,QAAAA,CAAQ;EAAGC,GAAAA,SAAAA,KAAAA,CAAM;CAAG;AAAK,CAAC,CAAC,IAAA,GAC3EN,SAAAA,UAAAA,CAAU,cAAc,CAC1B,CACF;;;;;;;AAQA,MAAM,iBAAiB;;;;;;;;;AAUvB,SAAS,WAA4C,QAAa,MAAM,KAAK,IAAI,GAAQ;CACvF,MAAM,UAAU,SAAiB,KAAK,IAAI,MAAM,IAAI,KAAK;CACzD,MAAM,QAAQ,OAAO,KAAK,UAAU,KAAK,MAAM,MAAM,SAAS,CAAC;CAC/D,MAAM,QAAQ,MAAM,QAAQ,SAAS,CAAC,OAAO,IAAI,CAAC;CAClD,IAAI,MAAM,WAAW,GAAG,OAAO;CAC/B,MAAM,SAAS,MAAM,KAAK,IAAI,GAAG,KAAK;CACtC,OAAO,OAAO,KAAK,OAAO,MAAM;EAC9B,IAAI,OAAO,MAAM,EAAE,GAAG,OAAO;EAC7B,MAAM,UAAU,MAAM,KAAK;EAC3B,OAAO;GAAE,GAAG;GAAO,WAAW,IAAI,KAAK,OAAO,OAAO,IAAI,UAAU,GAAG,CAAC,CAAC,YAAY;EAAE;CACxF,CAAC;AACH;AAEA,MAAa,0BAAA,GAAyBF,SAAAA,KAAAA,EAAAA,GACpCG,SAAAA,MAAAA,EAAAA,GACEM,SAAAA,OAAAA,CAAO;;;;;;;;CAQL,KAAA,GAAIC,SAAAA,SAAAA,EAAAA,GAASK,SAAAA,KAAAA,CAAK,EAAE,SAAS,KAAK,CAAC,CAAC;CACpC,OAAA,GAAMd,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,EAAE,CAAC;CAGxD,aAAA,GAAYE,SAAAA,KAAAA,CAAK,EAAE,SAAS,KAAK,CAAC;CAClC,aAAA,GAAYA,SAAAA,KAAAA,CAAK,EAAE,SAAS,KAAK,CAAC;CAClC,WAAA,GAAUC,SAAAA,KAAAA,CAAM,aAAa;CAC7B,cAAA,GAAaA,SAAAA,KAAAA,CAAM,gBAAgB;CACnC,WAAWC,SAAAA,IAAI,SAAS;CACxB,MAAM;CACN,YAAY;AACd,CAAC,CACH,CAAC,CAAC,OAAA,GAAML,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC,IAAA,GACpCX,SAAAA,UAAAA,EAAW,WAAW,WAAW,MAAM,CAAC,CAC1C;;;;;;AAOA,MAAa,uBAAA,GAAsBO,SAAAA,OAAAA,CAAO;CACxC,YAAA,GAAWR,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,EAAE,CAAC;CAC7D,WAAA,GAAUG,SAAAA,KAAAA,CAAM,aAAa;CAC7B,cAAA,GAAaA,SAAAA,KAAAA,CAAM,gBAAgB;CACnC,MAAM;AACR,CAAC;AAED,MAAM,cAAA,GAAahB,SAAAA,KAAAA,EAAAA,GAAKC,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGO,SAAAA,YAAAA,CAAY,IAAA,GAAGL,SAAAA,UAAAA,CAAU,GAAG,CAAC,IAAA,GAAGM,SAAAA,MAAAA,CAAM,CAAC;;AAGtF,MAAM,cAAA,GAAanB,SAAAA,KAAAA,EAAAA,GAAKC,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,CAAC,IAAA,GAAGS,SAAAA,KAAAA,CAAK,CAAC;AAEtD,MAAM,gBAAA,GAAeX,SAAAA,OAAAA,CAAO;CAC1B,aAAA,GAAYC,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;CAC3D,YAAA,GAAWH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;CAC1D,SAAA,GAAQH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;CACvD,OAAA,GAAMH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;;CAErD,SAAA,GAAQH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;CACvD,cAAA,GAAaH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,EAAE,CAAC,CAAC;;CAE3D,UAAA,GAASH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGU,SAAAA,YAAAA,CAAY,IAAA,GAAGP,SAAAA,MAAAA,CAAM,YAAY,CAAC,CAAC;AAC9E,CAAC;;;;;;;;;;;AAYD,MAAa,0BAAA,GAAyBL,SAAAA,OAAAA,CAAO;CAC3C,QAAA,GAAOC,SAAAA,SAAAA,EAAAA,GAASL,SAAAA,MAAAA,CAAM,CAAC,aAAA,GAAYF,SAAAA,MAAAA,CAAM,UAAU,CAAC,CAAC,OAAA,GAAMS,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CACxF,eAAA,GAAcH,SAAAA,SAAAA,EAAAA,GAASL,SAAAA,MAAAA,CAAM,CAAC,aAAA,GAAYF,SAAAA,MAAAA,CAAM,UAAU,CAAC,CAAC,OAAA,GAAMS,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/F,UAAA,GAASH,SAAAA,SAAAA,EAAAA,GAASL,SAAAA,MAAAA,CAAM,CAAC,eAAA,GAAcF,SAAAA,MAAAA,CAAM,YAAY,CAAC,CAAC,OAAA,GAAMS,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAChG,CAAC;AAED,MAAa,uBAAA,GAAsBJ,SAAAA,OAAAA,CAAO;CACxC,UAAA,GAASC,SAAAA,SAAAA,EAAAA,GAASK,SAAAA,KAAAA,CAAK,CAAC;CACxB,YAAA,GAAWL,SAAAA,SAAAA,CAAS,sBAAsB;;;;;;CAM1C,OAAA,GAAMA,SAAAA,SAAAA,CAAS,UAAU;AAC3B,CAAC;AAED,MAAa,wBAAA,GAAuBD,SAAAA,OAAAA,CAAO;CACzC,OAAA,GAAMR,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC;CAGjD,OAAO;CACP,UAAA,GAASZ,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,KAAK,CAAC;;;;;;;CAOtD,iBAAA,GAAgBZ,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,IAAI,CAAC;AAC9D,CAAC;AAED,MAAM,iBAAA,GAAgBb,SAAAA,KAAAA,EAAAA,GACpBC,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMY,SAAAA,UAAAA,CAAU,GAAG,CAAC,IAAA,GAC7BX,SAAAA,UAAAA,EAAW,MAAO,IAAI,IAAI,KAAA,CAAU,CACtC;;;;;AAMA,MAAa,oBAAA,GAAmBO,SAAAA,OAAAA,CAAO;;CAErC,MAAA,GAAKa,SAAAA,IAAAA,CAAI,CAAC,CAAC,OAAA,GAAMV,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,IAAI,CAAC;;;;;CAM9C,SAAA,GAAQH,SAAAA,SAAAA,CAAS,aAAa;;CAG9B,aAAA,GAAYT,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC;;CAGvD,aAAA,GAAYZ,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC;;CAGvD,eAAA,GAAcZ,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC;;CAGzD,WAAA,GAAUH,SAAAA,SAAAA,CAAS,aAAa;;;;;;CAOhC,cAAA,GAAaA,SAAAA,SAAAA,CAAS,aAAa;;;;;;CAOnC,sBAAA,GAAqBA,SAAAA,SAAAA,CAAS,aAAa;;;;;CAM3C,sBAAA,GAAqBA,SAAAA,SAAAA,CAAS,aAAa;;;;;CAM3C,uBAAA,GAAsBA,SAAAA,SAAAA,CAAS,aAAa;AAC9C,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["pipe","string","transform","array","record","union","number","boolean","_null","object","optional","trim","minLength","maxLength","regex","uuid","_enum","iso","toLowerCase","email","e164","toUpperCase","url"],"sources":["../../src/schema/index.ts"],"sourcesContent":["import {\n enum as _enum,\n null as _null,\n array,\n boolean,\n e164,\n email,\n iso,\n maxLength,\n minLength,\n number,\n object,\n optional,\n pipe,\n record,\n regex,\n string,\n toLowerCase,\n toUpperCase,\n transform,\n trim,\n union,\n url,\n uuid,\n type z,\n} from 'zod/mini';\nimport type { Environment, Platform } from '../track/types';\n\nconst MAX_KEY_LENGTH = 128;\nconst MAX_VALUE_LENGTH = 512;\nconst MAX_PROPERTIES = 64;\n\n/**\n * Truncated rather than rejected. These schemas validate a whole batch at once, so refusing one\n * oversized value costs every event that traveled with it — and the values that overrun are the\n * ones derived from the page (a link's text, a URL carrying a long query), which no client can\n * bound in advance. A shortened value is worth more than a lost batch.\n */\nconst propertyText = pipe(\n string(),\n transform((value) => value.slice(0, MAX_VALUE_LENGTH))\n);\n\n/**\n * Tags are truncated for the same reason property values are, and they are stored more than once\n * (on the event, the session and the visitor), so an unbounded one costs several times over.\n * 1024 sits just above what GA4 itself keeps (1000 characters of page_location, 420 of\n * page_referrer, 300 of page_title). Real tags stay under ~500 characters; the rare longer ones\n * are page_referrer values from search and ad redirect URLs, where the kept prefix — host and\n * path — is the part that matters.\n */\nconst MAX_TAG_LENGTH = 1024;\n\nconst tagText = pipe(\n string(),\n transform((value) => value.slice(0, MAX_TAG_LENGTH))\n);\n\n/**\n * Keys are written by hand in instrumentation code, so an unusable one is a mistake in the host\n * rather than something the visitor typed. It is still dropped rather than rejected, for the same\n * reason: the mistake should cost that property, not the batch it happens to be in. Truncating a\n * key is not an option — two long keys would silently become one field.\n *\n * The key schema below is deliberately permissive so that this transform is reached at all; the\n * trimming it used to do happens here instead. `MAX_PROPERTIES` keeps the first N in insertion\n * order.\n */\nfunction takeProperties<T>(data: Record<string, T>): Record<string, T> {\n const result: Record<string, T> = {};\n let count = 0;\n for (const [rawKey, value] of Object.entries(data)) {\n if (count >= MAX_PROPERTIES) break;\n const key = rawKey.trim();\n if (!key || key.length > MAX_KEY_LENGTH) continue;\n result[key] = value;\n count++;\n }\n return result;\n}\n\n/**\n * Capped at GA4's own item-list limit, and truncated rather than rejected like every other\n * property limit here: an unbounded array is the one field a caller could still blow a batch\n * up with after the value and key limits.\n */\nconst MAX_ITEMS = 200;\n\nconst items = pipe(\n array(\n pipe(\n record(string(), union([propertyText, number(), boolean(), _null()])),\n transform(takeProperties)\n )\n ),\n transform((list) => list.slice(0, MAX_ITEMS))\n);\n\nexport const ALL_PLATFORMS = [\n 'ios',\n 'android',\n 'web',\n 'macos',\n 'windows',\n 'linux',\n 'unknown',\n] as const satisfies Platform[];\n\nexport const ALL_ENVIRONMENTS = ['development', 'production'] as const satisfies Environment[];\n\nexport const tagsSchema = object({\n os: optional(tagText),\n os_name: optional(tagText),\n os_version: optional(tagText),\n browser: optional(tagText),\n browser_name: optional(tagText),\n browser_version: optional(tagText),\n device: optional(tagText),\n device_id: optional(string().check(trim(), minLength(1), maxLength(36))),\n device_type: optional(tagText),\n device_vendor: optional(tagText),\n device_pixel_ratio: optional(number()),\n screen_width: optional(number()),\n screen_height: optional(number()),\n screen_resolution: optional(\n pipe(\n string().check(regex(/^\\d+x\\d+$/)),\n transform((v) => v as `${number}x${number}`)\n )\n ),\n webdriver: optional(boolean()),\n release: optional(tagText),\n language: optional(tagText),\n time_zone: optional(tagText),\n page_location: optional(tagText),\n page_referrer: optional(tagText),\n page_title: optional(tagText),\n page_load_id: optional(tagText),\n /**\n * @deprecated Renamed to `page_location` in 7.0.0. Accepted so that events from clients\n * still on an older SDK are not stripped of their page URL at this boundary — a browser\n * bundle stays cached long after a backend deploys. Remove once those clients are gone;\n * `pageLocation` in `server/page-location.ts` is the only reader.\n */\n // oxlint-disable-next-line typescript/no-deprecated -- Legacy input from pre-7.0 clients must survive validation.\n source_url: optional(tagText),\n // app info\n advertising_id: optional(tagText),\n install_referrer: optional(tagText),\n // Ad click ids (URL parameters) and ad platform cookies (underscore names); see AdvertisingInfo.\n // Meta Ads\n fbclid: optional(tagText),\n ad_id: optional(tagText),\n ad_name: optional(tagText),\n adset_id: optional(tagText),\n adset_name: optional(tagText),\n campaign_id: optional(tagText),\n campaign_name: optional(tagText),\n placement: optional(tagText),\n _fbc: optional(tagText),\n _fbp: optional(tagText),\n /**\n * @deprecated `fbc` / `fbp` / `rdt_uuid` were renamed to `_fbc` / `_fbp` / `_rdt_uuid` in 9.0.0.\n * Accepted so that conversions from clients still on an older SDK keep their match keys; the\n * senders read them only as a fallback (`server/click-ids.ts`). Remove once those clients are\n * gone.\n */\n // oxlint-disable-next-line typescript/no-deprecated -- Legacy pre-9.0 click-id fields must survive validation.\n fbc: optional(tagText),\n fbp: optional(tagText),\n rdt_uuid: optional(tagText),\n // Google Ads\n gclid: optional(tagText),\n gclsrc: optional(tagText),\n gad_source: optional(tagText),\n gad_campaignid: optional(tagText),\n network: optional(tagText),\n match_type: optional(tagText),\n wbraid: optional(tagText),\n gbraid: optional(tagText),\n dclid: optional(tagText),\n _gcl_aw: optional(tagText),\n _gcl_gb: optional(tagText),\n // Microsoft Ads\n msclkid: optional(tagText),\n _uetmsclkid: optional(tagText),\n // Reddit Ads\n rdt_cid: optional(tagText),\n _rdt_cid: optional(tagText),\n _rdt_uuid: optional(tagText),\n // LinkedIn Ads\n li_fat_id: optional(tagText),\n _li_fat_id: optional(tagText),\n // OpenAI Ads\n oppref: optional(tagText),\n __oppref: optional(tagText),\n __obref: optional(tagText),\n // other click ids\n ko_click_id: optional(tagText),\n ScCid: optional(tagText),\n ttclid: optional(tagText),\n twclid: optional(tagText),\n yclid: optional(tagText),\n epik: optional(tagText),\n // utm params\n utm_source: optional(tagText),\n utm_medium: optional(tagText),\n utm_campaign: optional(tagText),\n utm_term: optional(tagText),\n utm_content: optional(tagText),\n utm_id: optional(tagText),\n utm_source_platform: optional(tagText),\n utm_creative_format: optional(tagText),\n utm_marketing_tactic: optional(tagText),\n});\n\nexport const propertiesSchema = optional(\n pipe(\n record(string(), union([propertyText, number(), boolean(), _null(), items])),\n transform(takeProperties)\n )\n);\n\n/**\n * How far an event's time may be from the server's before the client clock it was stamped with is\n * taken as wrong. A batch legitimately arrives late — a tab frozen in the background, a\n * session_start held back after a failed batch — by hours, not days; a phone set to another year\n * writes its sessions into that year.\n */\nconst MAX_CLOCK_SKEW = 24 * 60 * 60 * 1000;\n\n/**\n * Puts the events stamped by a wrong client clock onto the server's, where they are parsed. Only\n * the events outside `MAX_CLOCK_SKEW` move, so one bad event cannot drag the rest of its batch\n * along: they move together by their own latest one — the wrong clock at sending — keeping their\n * order and spacing, and one still out after that (a batch mixing two wrong clocks) is on no clock\n * at all and takes the server's time. Corrected rather than rejected, for the same reason values\n * are truncated: a wrong clock should cost the event its time, not the batch its events.\n */\nfunction alignClock<T extends { timestamp: string }>(events: T[], now = Date.now()): T[] {\n const within = (time: number) => Math.abs(now - time) <= MAX_CLOCK_SKEW;\n const times = events.map((event) => Date.parse(event.timestamp));\n const wrong = times.filter((time) => !within(time));\n if (wrong.length === 0) return events;\n const offset = now - Math.max(...wrong);\n return events.map((event, i) => {\n if (within(times[i])) return event;\n const shifted = times[i] + offset;\n return { ...event, timestamp: new Date(within(shifted) ? shifted : now).toISOString() };\n });\n}\n\nexport const createTrackEventSchema = pipe(\n array(\n object({\n /**\n * The event's id, generated by the client when the event was tracked (12.1) and given to\n * the browser pixels as their deduplication id. Store the event under it with\n * `on conflict (id) do nothing`: a batch retried after the server committed it then\n * stores nothing twice. Optional for clients before 12.1, which send none — generate one\n * on the server for those.\n */\n id: optional(uuid({ version: 'v7' })),\n name: string().check(trim(), minLength(1), maxLength(64)),\n // Generated by the SDK, like `id` (`visitorId()`, `Session`): uuidv7 as well, so the\n // constraint is checked here once and the server need not check it again.\n visitor_id: uuid({ version: 'v7' }),\n session_id: uuid({ version: 'v7' }),\n platform: _enum(ALL_PLATFORMS),\n environment: _enum(ALL_ENVIRONMENTS),\n timestamp: iso.datetime(),\n tags: tagsSchema,\n properties: propertiesSchema,\n })\n ).check(minLength(1), maxLength(100)),\n transform((events) => alignClock(events))\n);\n\n/**\n * `POST /visitors`, what clients before 11.0 create their visitor with; 11.0 generates the id\n * itself and the server creates the visitor from its first events (README, \"Visitors\").\n * Kept for servers that still serve older clients.\n */\nexport const createVisitorSchema = object({\n device_id: string().check(trim(), minLength(1), maxLength(36)),\n platform: _enum(ALL_PLATFORMS),\n environment: _enum(ALL_ENVIRONMENTS),\n tags: tagsSchema,\n});\n\nconst emailValue = pipe(string().check(trim(), toLowerCase(), maxLength(320)), email());\n\n/** E.164: a plus sign (+) prefix, country code, then digits only, no dashes/parens/spaces. */\nconst phoneValue = pipe(string().check(trim()), e164());\n\nconst addressValue = object({\n first_name: optional(string().check(trim(), maxLength(128))),\n last_name: optional(string().check(trim(), maxLength(128))),\n street: optional(string().check(trim(), maxLength(256))),\n city: optional(string().check(trim(), maxLength(128))),\n /** User province, state, or region. Example: `Hampshire` */\n region: optional(string().check(trim(), maxLength(128))),\n postal_code: optional(string().check(trim(), maxLength(32))),\n /** 2-letter country code, per the ISO 3166-1 alpha-2 standard. Example: `UK` */\n country: optional(string().check(trim(), toUpperCase(), regex(/^[A-Z]{2}$/))),\n});\n\n/**\n * User-provided data (UPD) used for enhanced conversions, Customer Match, and demographics.\n * Values are sent unhashed; Google normalizes and hashes them before they reach its servers.\n *\n * Multiple values may be sent to increase the match rate: up to 3 emails, 3 phone numbers, and\n * 2 addresses.\n *\n * @see https://support.google.com/analytics/answer/14078702\n * @see https://support.google.com/google-ads/answer/13258081\n */\nexport const userProvidedDataSchema = object({\n email: optional(union([emailValue, array(emailValue).check(minLength(1), maxLength(3))])),\n phone_number: optional(union([phoneValue, array(phoneValue).check(minLength(1), maxLength(3))])),\n address: optional(union([addressValue, array(addressValue).check(minLength(1), maxLength(2))])),\n});\n\nexport const updateVisitorSchema = object({\n user_id: optional(uuid()),\n user_data: optional(userProvidedDataSchema),\n /**\n * Sent by clients before 11.1, which PATCHed their tags on every page load. From 11.1 the\n * server refreshes `visitor.tags` from each `session_start` — the moment the visit arrives —\n * and `identify` sends none: at sign-in the page is no longer where the visit came in.\n */\n tags: optional(tagsSchema),\n});\n\nexport const createFeedbackSchema = object({\n name: string().check(minLength(1), maxLength(256)),\n // Trimmed and lower-cased like every other email the SDK accepts, so a host stores the\n // normalized form without wrapping the schema.\n email: emailValue,\n message: string().check(minLength(1), maxLength(65536)),\n /**\n * The Cloudflare Turnstile token the host verifies before storing the feedback (the same field\n * `@shware/security`'s email-code request carries). Required: without it `POST /feedback` is an\n * open free-text write that only a rate limit protects. Single-use: Turnstile spends the token\n * at verification, so the caller resets the widget after every submit, success or failure.\n */\n turnstileToken: string().check(minLength(1), maxLength(2048)),\n});\n\nconst noEmptyString = pipe(\n string().check(maxLength(256)),\n transform((v) => (v ? v : undefined))\n);\n\n/**\n * The schema for creating a link.\n * @see https://support.google.com/analytics/answer/10917952\n * */\nexport const createLinkSchema = object({\n /** The URL that the user is redirected to. */\n url: url().check(minLength(1), maxLength(1024)), // required\n\n /**\n * Campaign ID. Used to identify a specific campaign or promotion. This is a required key for GA4\n * data import. Use the same IDs that you use when uploading campaign cost data.\n */\n utm_id: optional(noEmptyString),\n\n /** Referrer, for example: google, newsletter4, billboard */\n utm_source: string().check(minLength(1), maxLength(256)), // required\n\n /** Marketing medium, for example: cpc, banner, email */\n utm_medium: string().check(minLength(1), maxLength(256)), // required\n\n /** Product, slogan, promo code, for example, spring_sale */\n utm_campaign: string().check(minLength(1), maxLength(256)), // required\n\n /** Paid keyword */\n utm_term: optional(noEmptyString),\n\n /**\n * Use to differentiate creatives. For example, if you have two call-to-action links within the\n * same email message, you can use utm_content and set different values for each so you can tell\n * which version is more effective.\n */\n utm_content: optional(noEmptyString),\n\n /**\n * The platform responsible for directing traffic to a given Analytics property (such as a buying\n * platform that sets budgets and targeting criteria or a platform that manages organic traffic\n * data). For example, Search Ads 360 or Display & Video 360.\n */\n utm_source_platform: optional(noEmptyString),\n\n /**\n * Type of creative, for example, display, native, video, search, utm_creative_format is not\n * currently reported in Google Analytics 4 properties.\n */\n utm_creative_format: optional(noEmptyString),\n\n /**\n * Targeting criteria applied to a campaign, for example, remarketing, prospecting,\n * utm_marketing_tactic is not currently reported in Google Analytics 4 properties.\n * */\n utm_marketing_tactic: optional(noEmptyString),\n});\n\nexport type CreateTrackEventDTO = z.output<typeof createTrackEventSchema>;\nexport type CreateFeedbackDTO = z.output<typeof createFeedbackSchema>;\nexport type CreateLinkDTO = z.output<typeof createLinkSchema>;\nexport type CreateVisitorDTO = z.output<typeof createVisitorSchema>;\nexport type UserProvidedDataDTO = z.output<typeof userProvidedDataSchema>;\nexport type UpdateVisitorDTO = z.output<typeof updateVisitorSchema>;\n"],"mappings":";;;AA4BA,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,iBAAiB;;;;;;;AAQvB,MAAM,gBAAA,GAAeA,SAAAA,KAAAA,EAAAA,GACnBC,SAAAA,OAAAA,CAAO,IAAA,GACPC,SAAAA,UAAAA,EAAW,UAAU,MAAM,MAAM,GAAG,gBAAgB,CAAC,CACvD;;;;;;;;;AAUA,MAAM,iBAAiB;AAEvB,MAAM,WAAA,GAAUF,SAAAA,KAAAA,EAAAA,GACdC,SAAAA,OAAAA,CAAO,IAAA,GACPC,SAAAA,UAAAA,EAAW,UAAU,MAAM,MAAM,GAAG,cAAc,CAAC,CACrD;;;;;;;;;;;AAYA,SAAS,eAAkB,MAA4C;CACrE,MAAM,SAA4B,CAAC;CACnC,IAAI,QAAQ;CACZ,KAAK,MAAM,CAAC,QAAQ,UAAU,OAAO,QAAQ,IAAI,GAAG;EAClD,IAAI,SAAS,gBAAgB;EAC7B,MAAM,MAAM,OAAO,KAAK;EACxB,IAAI,CAAC,OAAO,IAAI,SAAS,gBAAgB;EACzC,OAAO,OAAO;EACd;CACF;CACA,OAAO;AACT;;;;;;AAOA,MAAM,YAAY;AAElB,MAAM,SAAA,GAAQF,SAAAA,KAAAA,EAAAA,GACZG,SAAAA,MAAAA,EAAAA,GACEH,SAAAA,KAAAA,EAAAA,GACEI,SAAAA,OAAAA,EAAAA,GAAOH,SAAAA,OAAAA,CAAO,IAAA,GAAGI,SAAAA,MAAAA,CAAM;CAAC;EAAcC,GAAAA,SAAAA,OAAAA,CAAO;EAAGC,GAAAA,SAAAA,QAAAA,CAAQ;EAAGC,GAAAA,SAAAA,KAAAA,CAAM;AAAC,CAAC,CAAC,IAAA,GACpEN,SAAAA,UAAAA,CAAU,cAAc,CAC1B,CACF,IAAA,GACAA,SAAAA,UAAAA,EAAW,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC,CAC9C;AAEA,MAAa,gBAAgB;CAC3B;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAEA,MAAa,mBAAmB,CAAC,eAAe,YAAY;AAE5D,MAAa,cAAA,GAAaO,SAAAA,OAAAA,CAAO;CAC/B,KAAA,GAAIC,SAAAA,SAAAA,CAAS,OAAO;CACpB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,eAAA,GAAcA,SAAAA,SAAAA,CAAS,OAAO;CAC9B,kBAAA,GAAiBA,SAAAA,SAAAA,CAAS,OAAO;CACjC,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,YAAA,GAAWA,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,EAAE,CAAC,CAAC;CACvE,cAAA,GAAaH,SAAAA,SAAAA,CAAS,OAAO;CAC7B,gBAAA,GAAeA,SAAAA,SAAAA,CAAS,OAAO;CAC/B,qBAAA,GAAoBA,SAAAA,SAAAA,EAAAA,GAASJ,SAAAA,OAAAA,CAAO,CAAC;CACrC,eAAA,GAAcI,SAAAA,SAAAA,EAAAA,GAASJ,SAAAA,OAAAA,CAAO,CAAC;CAC/B,gBAAA,GAAeI,SAAAA,SAAAA,EAAAA,GAASJ,SAAAA,OAAAA,CAAO,CAAC;CAChC,oBAAA,GAAmBI,SAAAA,SAAAA,EAAAA,GACjBV,SAAAA,KAAAA,EAAAA,GACEC,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMa,SAAAA,MAAAA,CAAM,WAAW,CAAC,IAAA,GACjCZ,SAAAA,UAAAA,EAAW,MAAM,CAA0B,CAC7C,CACF;CACA,YAAA,GAAWQ,SAAAA,SAAAA,EAAAA,GAASH,SAAAA,QAAAA,CAAQ,CAAC;CAC7B,UAAA,GAASG,SAAAA,SAAAA,CAAS,OAAO;CACzB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,YAAA,GAAWA,SAAAA,SAAAA,CAAS,OAAO;CAC3B,gBAAA,GAAeA,SAAAA,SAAAA,CAAS,OAAO;CAC/B,gBAAA,GAAeA,SAAAA,SAAAA,CAAS,OAAO;CAC/B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,eAAA,GAAcA,SAAAA,SAAAA,CAAS,OAAO;;;;;;;CAQ9B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAE5B,iBAAA,GAAgBA,SAAAA,SAAAA,CAAS,OAAO;CAChC,mBAAA,GAAkBA,SAAAA,SAAAA,CAAS,OAAO;CAGlC,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,cAAA,GAAaA,SAAAA,SAAAA,CAAS,OAAO;CAC7B,gBAAA,GAAeA,SAAAA,SAAAA,CAAS,OAAO;CAC/B,YAAA,GAAWA,SAAAA,SAAAA,CAAS,OAAO;CAC3B,OAAA,GAAMA,SAAAA,SAAAA,CAAS,OAAO;CACtB,OAAA,GAAMA,SAAAA,SAAAA,CAAS,OAAO;;;;;;;CAQtB,MAAA,GAAKA,SAAAA,SAAAA,CAAS,OAAO;CACrB,MAAA,GAAKA,SAAAA,SAAAA,CAAS,OAAO;CACrB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAE1B,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,iBAAA,GAAgBA,SAAAA,SAAAA,CAAS,OAAO;CAChC,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CAEzB,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,cAAA,GAAaA,SAAAA,SAAAA,CAAS,OAAO;CAE7B,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CACzB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,YAAA,GAAWA,SAAAA,SAAAA,CAAS,OAAO;CAE3B,YAAA,GAAWA,SAAAA,SAAAA,CAAS,OAAO;CAC3B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAE5B,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,UAAA,GAASA,SAAAA,SAAAA,CAAS,OAAO;CAEzB,cAAA,GAAaA,SAAAA,SAAAA,CAAS,OAAO;CAC7B,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,QAAA,GAAOA,SAAAA,SAAAA,CAAS,OAAO;CACvB,OAAA,GAAMA,SAAAA,SAAAA,CAAS,OAAO;CAEtB,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,aAAA,GAAYA,SAAAA,SAAAA,CAAS,OAAO;CAC5B,eAAA,GAAcA,SAAAA,SAAAA,CAAS,OAAO;CAC9B,WAAA,GAAUA,SAAAA,SAAAA,CAAS,OAAO;CAC1B,cAAA,GAAaA,SAAAA,SAAAA,CAAS,OAAO;CAC7B,SAAA,GAAQA,SAAAA,SAAAA,CAAS,OAAO;CACxB,sBAAA,GAAqBA,SAAAA,SAAAA,CAAS,OAAO;CACrC,sBAAA,GAAqBA,SAAAA,SAAAA,CAAS,OAAO;CACrC,uBAAA,GAAsBA,SAAAA,SAAAA,CAAS,OAAO;AACxC,CAAC;AAED,MAAa,oBAAA,GAAmBA,SAAAA,SAAAA,EAAAA,GAC9BV,SAAAA,KAAAA,EAAAA,GACEI,SAAAA,OAAAA,EAAAA,GAAOH,SAAAA,OAAAA,CAAO,IAAA,GAAGI,SAAAA,MAAAA,CAAM;CAAC;EAAcC,GAAAA,SAAAA,OAAAA,CAAO;EAAGC,GAAAA,SAAAA,QAAAA,CAAQ;EAAGC,GAAAA,SAAAA,KAAAA,CAAM;CAAG;AAAK,CAAC,CAAC,IAAA,GAC3EN,SAAAA,UAAAA,CAAU,cAAc,CAC1B,CACF;;;;;;;AAQA,MAAM,iBAAiB;;;;;;;;;AAUvB,SAAS,WAA4C,QAAa,MAAM,KAAK,IAAI,GAAQ;CACvF,MAAM,UAAU,SAAiB,KAAK,IAAI,MAAM,IAAI,KAAK;CACzD,MAAM,QAAQ,OAAO,KAAK,UAAU,KAAK,MAAM,MAAM,SAAS,CAAC;CAC/D,MAAM,QAAQ,MAAM,QAAQ,SAAS,CAAC,OAAO,IAAI,CAAC;CAClD,IAAI,MAAM,WAAW,GAAG,OAAO;CAC/B,MAAM,SAAS,MAAM,KAAK,IAAI,GAAG,KAAK;CACtC,OAAO,OAAO,KAAK,OAAO,MAAM;EAC9B,IAAI,OAAO,MAAM,EAAE,GAAG,OAAO;EAC7B,MAAM,UAAU,MAAM,KAAK;EAC3B,OAAO;GAAE,GAAG;GAAO,WAAW,IAAI,KAAK,OAAO,OAAO,IAAI,UAAU,GAAG,CAAC,CAAC,YAAY;EAAE;CACxF,CAAC;AACH;AAEA,MAAa,0BAAA,GAAyBF,SAAAA,KAAAA,EAAAA,GACpCG,SAAAA,MAAAA,EAAAA,GACEM,SAAAA,OAAAA,CAAO;;;;;;;;CAQL,KAAA,GAAIC,SAAAA,SAAAA,EAAAA,GAASK,SAAAA,KAAAA,CAAK,EAAE,SAAS,KAAK,CAAC,CAAC;CACpC,OAAA,GAAMd,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,EAAE,CAAC;CAGxD,aAAA,GAAYE,SAAAA,KAAAA,CAAK,EAAE,SAAS,KAAK,CAAC;CAClC,aAAA,GAAYA,SAAAA,KAAAA,CAAK,EAAE,SAAS,KAAK,CAAC;CAClC,WAAA,GAAUC,SAAAA,KAAAA,CAAM,aAAa;CAC7B,cAAA,GAAaA,SAAAA,KAAAA,CAAM,gBAAgB;CACnC,WAAWC,SAAAA,IAAI,SAAS;CACxB,MAAM;CACN,YAAY;AACd,CAAC,CACH,CAAC,CAAC,OAAA,GAAML,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC,IAAA,GACpCX,SAAAA,UAAAA,EAAW,WAAW,WAAW,MAAM,CAAC,CAC1C;;;;;;AAOA,MAAa,uBAAA,GAAsBO,SAAAA,OAAAA,CAAO;CACxC,YAAA,GAAWR,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,EAAE,CAAC;CAC7D,WAAA,GAAUG,SAAAA,KAAAA,CAAM,aAAa;CAC7B,cAAA,GAAaA,SAAAA,KAAAA,CAAM,gBAAgB;CACnC,MAAM;AACR,CAAC;AAED,MAAM,cAAA,GAAahB,SAAAA,KAAAA,EAAAA,GAAKC,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGO,SAAAA,YAAAA,CAAY,IAAA,GAAGL,SAAAA,UAAAA,CAAU,GAAG,CAAC,IAAA,GAAGM,SAAAA,MAAAA,CAAM,CAAC;;AAGtF,MAAM,cAAA,GAAanB,SAAAA,KAAAA,EAAAA,GAAKC,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,CAAC,IAAA,GAAGS,SAAAA,KAAAA,CAAK,CAAC;AAEtD,MAAM,gBAAA,GAAeX,SAAAA,OAAAA,CAAO;CAC1B,aAAA,GAAYC,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;CAC3D,YAAA,GAAWH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;CAC1D,SAAA,GAAQH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;CACvD,OAAA,GAAMH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;;CAErD,SAAA,GAAQH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,GAAG,CAAC,CAAC;CACvD,cAAA,GAAaH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGE,SAAAA,UAAAA,CAAU,EAAE,CAAC,CAAC;;CAE3D,UAAA,GAASH,SAAAA,SAAAA,EAAAA,GAAST,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMU,SAAAA,KAAAA,CAAK,IAAA,GAAGU,SAAAA,YAAAA,CAAY,IAAA,GAAGP,SAAAA,MAAAA,CAAM,YAAY,CAAC,CAAC;AAC9E,CAAC;;;;;;;;;;;AAYD,MAAa,0BAAA,GAAyBL,SAAAA,OAAAA,CAAO;CAC3C,QAAA,GAAOC,SAAAA,SAAAA,EAAAA,GAASL,SAAAA,MAAAA,CAAM,CAAC,aAAA,GAAYF,SAAAA,MAAAA,CAAM,UAAU,CAAC,CAAC,OAAA,GAAMS,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CACxF,eAAA,GAAcH,SAAAA,SAAAA,EAAAA,GAASL,SAAAA,MAAAA,CAAM,CAAC,aAAA,GAAYF,SAAAA,MAAAA,CAAM,UAAU,CAAC,CAAC,OAAA,GAAMS,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/F,UAAA,GAASH,SAAAA,SAAAA,EAAAA,GAASL,SAAAA,MAAAA,CAAM,CAAC,eAAA,GAAcF,SAAAA,MAAAA,CAAM,YAAY,CAAC,CAAC,OAAA,GAAMS,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAChG,CAAC;AAED,MAAa,uBAAA,GAAsBJ,SAAAA,OAAAA,CAAO;CACxC,UAAA,GAASC,SAAAA,SAAAA,EAAAA,GAASK,SAAAA,KAAAA,CAAK,CAAC;CACxB,YAAA,GAAWL,SAAAA,SAAAA,CAAS,sBAAsB;;;;;;CAM1C,OAAA,GAAMA,SAAAA,SAAAA,CAAS,UAAU;AAC3B,CAAC;AAED,MAAa,wBAAA,GAAuBD,SAAAA,OAAAA,CAAO;CACzC,OAAA,GAAMR,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC;CAGjD,OAAO;CACP,UAAA,GAASZ,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,KAAK,CAAC;;;;;;;CAOtD,iBAAA,GAAgBZ,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,IAAI,CAAC;AAC9D,CAAC;AAED,MAAM,iBAAA,GAAgBb,SAAAA,KAAAA,EAAAA,GACpBC,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMY,SAAAA,UAAAA,CAAU,GAAG,CAAC,IAAA,GAC7BX,SAAAA,UAAAA,EAAW,MAAO,IAAI,IAAI,KAAA,CAAU,CACtC;;;;;AAMA,MAAa,oBAAA,GAAmBO,SAAAA,OAAAA,CAAO;;CAErC,MAAA,GAAKa,SAAAA,IAAAA,CAAI,CAAC,CAAC,OAAA,GAAMV,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,IAAI,CAAC;;;;;CAM9C,SAAA,GAAQH,SAAAA,SAAAA,CAAS,aAAa;;CAG9B,aAAA,GAAYT,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC;;CAGvD,aAAA,GAAYZ,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC;;CAGvD,eAAA,GAAcZ,SAAAA,OAAAA,CAAO,CAAC,CAAC,OAAA,GAAMW,SAAAA,UAAAA,CAAU,CAAC,IAAA,GAAGC,SAAAA,UAAAA,CAAU,GAAG,CAAC;;CAGzD,WAAA,GAAUH,SAAAA,SAAAA,CAAS,aAAa;;;;;;CAOhC,cAAA,GAAaA,SAAAA,SAAAA,CAAS,aAAa;;;;;;CAOnC,sBAAA,GAAqBA,SAAAA,SAAAA,CAAS,aAAa;;;;;CAM3C,sBAAA,GAAqBA,SAAAA,SAAAA,CAAS,aAAa;;;;;CAM3C,uBAAA,GAAsBA,SAAAA,SAAAA,CAAS,aAAa;AAC9C,CAAC"}
|
package/dist/schema/index.mjs
CHANGED
|
@@ -253,7 +253,7 @@ const updateVisitorSchema = object({
|
|
|
253
253
|
/**
|
|
254
254
|
* Sent by clients before 11.1, which PATCHed their tags on every page load. From 11.1 the
|
|
255
255
|
* server refreshes `visitor.tags` from each `session_start` — the moment the visit arrives —
|
|
256
|
-
* and `
|
|
256
|
+
* and `identify` sends none: at sign-in the page is no longer where the visit came in.
|
|
257
257
|
*/
|
|
258
258
|
tags: optional(tagsSchema)
|
|
259
259
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["_null","_enum"],"sources":["../../src/schema/index.ts"],"sourcesContent":["import {\n enum as _enum,\n null as _null,\n array,\n boolean,\n e164,\n email,\n iso,\n maxLength,\n minLength,\n number,\n object,\n optional,\n pipe,\n record,\n regex,\n string,\n toLowerCase,\n toUpperCase,\n transform,\n trim,\n union,\n url,\n uuid,\n type z,\n} from 'zod/mini';\nimport type { Environment, Platform } from '../track/types';\n\nconst MAX_KEY_LENGTH = 128;\nconst MAX_VALUE_LENGTH = 512;\nconst MAX_PROPERTIES = 64;\n\n/**\n * Truncated rather than rejected. These schemas validate a whole batch at once, so refusing one\n * oversized value costs every event that traveled with it — and the values that overrun are the\n * ones derived from the page (a link's text, a URL carrying a long query), which no client can\n * bound in advance. A shortened value is worth more than a lost batch.\n */\nconst propertyText = pipe(\n string(),\n transform((value) => value.slice(0, MAX_VALUE_LENGTH))\n);\n\n/**\n * Tags are truncated for the same reason property values are, and they are stored more than once\n * (on the event, the session and the visitor), so an unbounded one costs several times over.\n * 1024 sits just above what GA4 itself keeps (1000 characters of page_location, 420 of\n * page_referrer, 300 of page_title). Real tags stay under ~500 characters; the rare longer ones\n * are page_referrer values from search and ad redirect URLs, where the kept prefix — host and\n * path — is the part that matters.\n */\nconst MAX_TAG_LENGTH = 1024;\n\nconst tagText = pipe(\n string(),\n transform((value) => value.slice(0, MAX_TAG_LENGTH))\n);\n\n/**\n * Keys are written by hand in instrumentation code, so an unusable one is a mistake in the host\n * rather than something the visitor typed. It is still dropped rather than rejected, for the same\n * reason: the mistake should cost that property, not the batch it happens to be in. Truncating a\n * key is not an option — two long keys would silently become one field.\n *\n * The key schema below is deliberately permissive so that this transform is reached at all; the\n * trimming it used to do happens here instead. `MAX_PROPERTIES` keeps the first N in insertion\n * order.\n */\nfunction takeProperties<T>(data: Record<string, T>): Record<string, T> {\n const result: Record<string, T> = {};\n let count = 0;\n for (const [rawKey, value] of Object.entries(data)) {\n if (count >= MAX_PROPERTIES) break;\n const key = rawKey.trim();\n if (!key || key.length > MAX_KEY_LENGTH) continue;\n result[key] = value;\n count++;\n }\n return result;\n}\n\n/**\n * Capped at GA4's own item-list limit, and truncated rather than rejected like every other\n * property limit here: an unbounded array is the one field a caller could still blow a batch\n * up with after the value and key limits.\n */\nconst MAX_ITEMS = 200;\n\nconst items = pipe(\n array(\n pipe(\n record(string(), union([propertyText, number(), boolean(), _null()])),\n transform(takeProperties)\n )\n ),\n transform((list) => list.slice(0, MAX_ITEMS))\n);\n\nexport const ALL_PLATFORMS = [\n 'ios',\n 'android',\n 'web',\n 'macos',\n 'windows',\n 'linux',\n 'unknown',\n] as const satisfies Platform[];\n\nexport const ALL_ENVIRONMENTS = ['development', 'production'] as const satisfies Environment[];\n\nexport const tagsSchema = object({\n os: optional(tagText),\n os_name: optional(tagText),\n os_version: optional(tagText),\n browser: optional(tagText),\n browser_name: optional(tagText),\n browser_version: optional(tagText),\n device: optional(tagText),\n device_id: optional(string().check(trim(), minLength(1), maxLength(36))),\n device_type: optional(tagText),\n device_vendor: optional(tagText),\n device_pixel_ratio: optional(number()),\n screen_width: optional(number()),\n screen_height: optional(number()),\n screen_resolution: optional(\n pipe(\n string().check(regex(/^\\d+x\\d+$/)),\n transform((v) => v as `${number}x${number}`)\n )\n ),\n webdriver: optional(boolean()),\n release: optional(tagText),\n language: optional(tagText),\n time_zone: optional(tagText),\n page_location: optional(tagText),\n page_referrer: optional(tagText),\n page_title: optional(tagText),\n page_load_id: optional(tagText),\n /**\n * @deprecated Renamed to `page_location` in 7.0.0. Accepted so that events from clients\n * still on an older SDK are not stripped of their page URL at this boundary — a browser\n * bundle stays cached long after a backend deploys. Remove once those clients are gone;\n * `pageLocation` in `server/page-location.ts` is the only reader.\n */\n // oxlint-disable-next-line typescript/no-deprecated -- Legacy input from pre-7.0 clients must survive validation.\n source_url: optional(tagText),\n // app info\n advertising_id: optional(tagText),\n install_referrer: optional(tagText),\n // Ad click ids (URL parameters) and ad platform cookies (underscore names); see AdvertisingInfo.\n // Meta Ads\n fbclid: optional(tagText),\n ad_id: optional(tagText),\n ad_name: optional(tagText),\n adset_id: optional(tagText),\n adset_name: optional(tagText),\n campaign_id: optional(tagText),\n campaign_name: optional(tagText),\n placement: optional(tagText),\n _fbc: optional(tagText),\n _fbp: optional(tagText),\n /**\n * @deprecated `fbc` / `fbp` / `rdt_uuid` were renamed to `_fbc` / `_fbp` / `_rdt_uuid` in 9.0.0.\n * Accepted so that conversions from clients still on an older SDK keep their match keys; the\n * senders read them only as a fallback (`server/click-ids.ts`). Remove once those clients are\n * gone.\n */\n // oxlint-disable-next-line typescript/no-deprecated -- Legacy pre-9.0 click-id fields must survive validation.\n fbc: optional(tagText),\n fbp: optional(tagText),\n rdt_uuid: optional(tagText),\n // Google Ads\n gclid: optional(tagText),\n gclsrc: optional(tagText),\n gad_source: optional(tagText),\n gad_campaignid: optional(tagText),\n network: optional(tagText),\n match_type: optional(tagText),\n wbraid: optional(tagText),\n gbraid: optional(tagText),\n dclid: optional(tagText),\n _gcl_aw: optional(tagText),\n _gcl_gb: optional(tagText),\n // Microsoft Ads\n msclkid: optional(tagText),\n _uetmsclkid: optional(tagText),\n // Reddit Ads\n rdt_cid: optional(tagText),\n _rdt_cid: optional(tagText),\n _rdt_uuid: optional(tagText),\n // LinkedIn Ads\n li_fat_id: optional(tagText),\n _li_fat_id: optional(tagText),\n // OpenAI Ads\n oppref: optional(tagText),\n __oppref: optional(tagText),\n __obref: optional(tagText),\n // other click ids\n ko_click_id: optional(tagText),\n ScCid: optional(tagText),\n ttclid: optional(tagText),\n twclid: optional(tagText),\n yclid: optional(tagText),\n epik: optional(tagText),\n // utm params\n utm_source: optional(tagText),\n utm_medium: optional(tagText),\n utm_campaign: optional(tagText),\n utm_term: optional(tagText),\n utm_content: optional(tagText),\n utm_id: optional(tagText),\n utm_source_platform: optional(tagText),\n utm_creative_format: optional(tagText),\n utm_marketing_tactic: optional(tagText),\n});\n\nexport const propertiesSchema = optional(\n pipe(\n record(string(), union([propertyText, number(), boolean(), _null(), items])),\n transform(takeProperties)\n )\n);\n\n/**\n * How far an event's time may be from the server's before the client clock it was stamped with is\n * taken as wrong. A batch legitimately arrives late — a tab frozen in the background, a\n * session_start held back after a failed batch — by hours, not days; a phone set to another year\n * writes its sessions into that year.\n */\nconst MAX_CLOCK_SKEW = 24 * 60 * 60 * 1000;\n\n/**\n * Puts the events stamped by a wrong client clock onto the server's, where they are parsed. Only\n * the events outside `MAX_CLOCK_SKEW` move, so one bad event cannot drag the rest of its batch\n * along: they move together by their own latest one — the wrong clock at sending — keeping their\n * order and spacing, and one still out after that (a batch mixing two wrong clocks) is on no clock\n * at all and takes the server's time. Corrected rather than rejected, for the same reason values\n * are truncated: a wrong clock should cost the event its time, not the batch its events.\n */\nfunction alignClock<T extends { timestamp: string }>(events: T[], now = Date.now()): T[] {\n const within = (time: number) => Math.abs(now - time) <= MAX_CLOCK_SKEW;\n const times = events.map((event) => Date.parse(event.timestamp));\n const wrong = times.filter((time) => !within(time));\n if (wrong.length === 0) return events;\n const offset = now - Math.max(...wrong);\n return events.map((event, i) => {\n if (within(times[i])) return event;\n const shifted = times[i] + offset;\n return { ...event, timestamp: new Date(within(shifted) ? shifted : now).toISOString() };\n });\n}\n\nexport const createTrackEventSchema = pipe(\n array(\n object({\n /**\n * The event's id, generated by the client when the event was tracked (12.1) and given to\n * the browser pixels as their deduplication id. Store the event under it with\n * `on conflict (id) do nothing`: a batch retried after the server committed it then\n * stores nothing twice. Optional for clients before 12.1, which send none — generate one\n * on the server for those.\n */\n id: optional(uuid({ version: 'v7' })),\n name: string().check(trim(), minLength(1), maxLength(64)),\n // Generated by the SDK, like `id` (`visitorId()`, `Session`): uuidv7 as well, so the\n // constraint is checked here once and the server need not check it again.\n visitor_id: uuid({ version: 'v7' }),\n session_id: uuid({ version: 'v7' }),\n platform: _enum(ALL_PLATFORMS),\n environment: _enum(ALL_ENVIRONMENTS),\n timestamp: iso.datetime(),\n tags: tagsSchema,\n properties: propertiesSchema,\n })\n ).check(minLength(1), maxLength(100)),\n transform((events) => alignClock(events))\n);\n\n/**\n * `POST /visitors`, what clients before 11.0 create their visitor with; 11.0 generates the id\n * itself and the server creates the visitor from its first events (README, \"Visitors\").\n * Kept for servers that still serve older clients.\n */\nexport const createVisitorSchema = object({\n device_id: string().check(trim(), minLength(1), maxLength(36)),\n platform: _enum(ALL_PLATFORMS),\n environment: _enum(ALL_ENVIRONMENTS),\n tags: tagsSchema,\n});\n\nconst emailValue = pipe(string().check(trim(), toLowerCase(), maxLength(320)), email());\n\n/** E.164: a plus sign (+) prefix, country code, then digits only, no dashes/parens/spaces. */\nconst phoneValue = pipe(string().check(trim()), e164());\n\nconst addressValue = object({\n first_name: optional(string().check(trim(), maxLength(128))),\n last_name: optional(string().check(trim(), maxLength(128))),\n street: optional(string().check(trim(), maxLength(256))),\n city: optional(string().check(trim(), maxLength(128))),\n /** User province, state, or region. Example: `Hampshire` */\n region: optional(string().check(trim(), maxLength(128))),\n postal_code: optional(string().check(trim(), maxLength(32))),\n /** 2-letter country code, per the ISO 3166-1 alpha-2 standard. Example: `UK` */\n country: optional(string().check(trim(), toUpperCase(), regex(/^[A-Z]{2}$/))),\n});\n\n/**\n * User-provided data (UPD) used for enhanced conversions, Customer Match, and demographics.\n * Values are sent unhashed; Google normalizes and hashes them before they reach its servers.\n *\n * Multiple values may be sent to increase the match rate: up to 3 emails, 3 phone numbers, and\n * 2 addresses.\n *\n * @see https://support.google.com/analytics/answer/14078702\n * @see https://support.google.com/google-ads/answer/13258081\n */\nexport const userProvidedDataSchema = object({\n email: optional(union([emailValue, array(emailValue).check(minLength(1), maxLength(3))])),\n phone_number: optional(union([phoneValue, array(phoneValue).check(minLength(1), maxLength(3))])),\n address: optional(union([addressValue, array(addressValue).check(minLength(1), maxLength(2))])),\n});\n\nexport const updateVisitorSchema = object({\n user_id: optional(uuid()),\n user_data: optional(userProvidedDataSchema),\n /**\n * Sent by clients before 11.1, which PATCHed their tags on every page load. From 11.1 the\n * server refreshes `visitor.tags` from each `session_start` — the moment the visit arrives —\n * and `setVisitor` sends none: at sign-in the page is no longer where the visit came in.\n */\n tags: optional(tagsSchema),\n});\n\nexport const createFeedbackSchema = object({\n name: string().check(minLength(1), maxLength(256)),\n // Trimmed and lower-cased like every other email the SDK accepts, so a host stores the\n // normalized form without wrapping the schema.\n email: emailValue,\n message: string().check(minLength(1), maxLength(65536)),\n /**\n * The Cloudflare Turnstile token the host verifies before storing the feedback (the same field\n * `@shware/security`'s email-code request carries). Required: without it `POST /feedback` is an\n * open free-text write that only a rate limit protects. Single-use: Turnstile spends the token\n * at verification, so the caller resets the widget after every submit, success or failure.\n */\n turnstileToken: string().check(minLength(1), maxLength(2048)),\n});\n\nconst noEmptyString = pipe(\n string().check(maxLength(256)),\n transform((v) => (v ? v : undefined))\n);\n\n/**\n * The schema for creating a link.\n * @see https://support.google.com/analytics/answer/10917952\n * */\nexport const createLinkSchema = object({\n /** The URL that the user is redirected to. */\n url: url().check(minLength(1), maxLength(1024)), // required\n\n /**\n * Campaign ID. Used to identify a specific campaign or promotion. This is a required key for GA4\n * data import. Use the same IDs that you use when uploading campaign cost data.\n */\n utm_id: optional(noEmptyString),\n\n /** Referrer, for example: google, newsletter4, billboard */\n utm_source: string().check(minLength(1), maxLength(256)), // required\n\n /** Marketing medium, for example: cpc, banner, email */\n utm_medium: string().check(minLength(1), maxLength(256)), // required\n\n /** Product, slogan, promo code, for example, spring_sale */\n utm_campaign: string().check(minLength(1), maxLength(256)), // required\n\n /** Paid keyword */\n utm_term: optional(noEmptyString),\n\n /**\n * Use to differentiate creatives. For example, if you have two call-to-action links within the\n * same email message, you can use utm_content and set different values for each so you can tell\n * which version is more effective.\n */\n utm_content: optional(noEmptyString),\n\n /**\n * The platform responsible for directing traffic to a given Analytics property (such as a buying\n * platform that sets budgets and targeting criteria or a platform that manages organic traffic\n * data). For example, Search Ads 360 or Display & Video 360.\n */\n utm_source_platform: optional(noEmptyString),\n\n /**\n * Type of creative, for example, display, native, video, search, utm_creative_format is not\n * currently reported in Google Analytics 4 properties.\n */\n utm_creative_format: optional(noEmptyString),\n\n /**\n * Targeting criteria applied to a campaign, for example, remarketing, prospecting,\n * utm_marketing_tactic is not currently reported in Google Analytics 4 properties.\n * */\n utm_marketing_tactic: optional(noEmptyString),\n});\n\nexport type CreateTrackEventDTO = z.output<typeof createTrackEventSchema>;\nexport type CreateFeedbackDTO = z.output<typeof createFeedbackSchema>;\nexport type CreateLinkDTO = z.output<typeof createLinkSchema>;\nexport type CreateVisitorDTO = z.output<typeof createVisitorSchema>;\nexport type UserProvidedDataDTO = z.output<typeof userProvidedDataSchema>;\nexport type UpdateVisitorDTO = z.output<typeof updateVisitorSchema>;\n"],"mappings":";;AA4BA,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,iBAAiB;;;;;;;AAQvB,MAAM,eAAe,KACnB,OAAO,GACP,WAAW,UAAU,MAAM,MAAM,GAAG,gBAAgB,CAAC,CACvD;;;;;;;;;AAUA,MAAM,iBAAiB;AAEvB,MAAM,UAAU,KACd,OAAO,GACP,WAAW,UAAU,MAAM,MAAM,GAAG,cAAc,CAAC,CACrD;;;;;;;;;;;AAYA,SAAS,eAAkB,MAA4C;CACrE,MAAM,SAA4B,CAAC;CACnC,IAAI,QAAQ;CACZ,KAAK,MAAM,CAAC,QAAQ,UAAU,OAAO,QAAQ,IAAI,GAAG;EAClD,IAAI,SAAS,gBAAgB;EAC7B,MAAM,MAAM,OAAO,KAAK;EACxB,IAAI,CAAC,OAAO,IAAI,SAAS,gBAAgB;EACzC,OAAO,OAAO;EACd;CACF;CACA,OAAO;AACT;;;;;;AAOA,MAAM,YAAY;AAElB,MAAM,QAAQ,KACZ,MACE,KACE,OAAO,OAAO,GAAG,MAAM;CAAC;CAAc,OAAO;CAAG,QAAQ;CAAGA,OAAM;AAAC,CAAC,CAAC,GACpE,UAAU,cAAc,CAC1B,CACF,GACA,WAAW,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC,CAC9C;AAEA,MAAa,gBAAgB;CAC3B;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAEA,MAAa,mBAAmB,CAAC,eAAe,YAAY;AAE5D,MAAa,aAAa,OAAO;CAC/B,IAAI,SAAS,OAAO;CACpB,SAAS,SAAS,OAAO;CACzB,YAAY,SAAS,OAAO;CAC5B,SAAS,SAAS,OAAO;CACzB,cAAc,SAAS,OAAO;CAC9B,iBAAiB,SAAS,OAAO;CACjC,QAAQ,SAAS,OAAO;CACxB,WAAW,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,UAAU,EAAE,CAAC,CAAC;CACvE,aAAa,SAAS,OAAO;CAC7B,eAAe,SAAS,OAAO;CAC/B,oBAAoB,SAAS,OAAO,CAAC;CACrC,cAAc,SAAS,OAAO,CAAC;CAC/B,eAAe,SAAS,OAAO,CAAC;CAChC,mBAAmB,SACjB,KACE,OAAO,CAAC,CAAC,MAAM,MAAM,WAAW,CAAC,GACjC,WAAW,MAAM,CAA0B,CAC7C,CACF;CACA,WAAW,SAAS,QAAQ,CAAC;CAC7B,SAAS,SAAS,OAAO;CACzB,UAAU,SAAS,OAAO;CAC1B,WAAW,SAAS,OAAO;CAC3B,eAAe,SAAS,OAAO;CAC/B,eAAe,SAAS,OAAO;CAC/B,YAAY,SAAS,OAAO;CAC5B,cAAc,SAAS,OAAO;;;;;;;CAQ9B,YAAY,SAAS,OAAO;CAE5B,gBAAgB,SAAS,OAAO;CAChC,kBAAkB,SAAS,OAAO;CAGlC,QAAQ,SAAS,OAAO;CACxB,OAAO,SAAS,OAAO;CACvB,SAAS,SAAS,OAAO;CACzB,UAAU,SAAS,OAAO;CAC1B,YAAY,SAAS,OAAO;CAC5B,aAAa,SAAS,OAAO;CAC7B,eAAe,SAAS,OAAO;CAC/B,WAAW,SAAS,OAAO;CAC3B,MAAM,SAAS,OAAO;CACtB,MAAM,SAAS,OAAO;;;;;;;CAQtB,KAAK,SAAS,OAAO;CACrB,KAAK,SAAS,OAAO;CACrB,UAAU,SAAS,OAAO;CAE1B,OAAO,SAAS,OAAO;CACvB,QAAQ,SAAS,OAAO;CACxB,YAAY,SAAS,OAAO;CAC5B,gBAAgB,SAAS,OAAO;CAChC,SAAS,SAAS,OAAO;CACzB,YAAY,SAAS,OAAO;CAC5B,QAAQ,SAAS,OAAO;CACxB,QAAQ,SAAS,OAAO;CACxB,OAAO,SAAS,OAAO;CACvB,SAAS,SAAS,OAAO;CACzB,SAAS,SAAS,OAAO;CAEzB,SAAS,SAAS,OAAO;CACzB,aAAa,SAAS,OAAO;CAE7B,SAAS,SAAS,OAAO;CACzB,UAAU,SAAS,OAAO;CAC1B,WAAW,SAAS,OAAO;CAE3B,WAAW,SAAS,OAAO;CAC3B,YAAY,SAAS,OAAO;CAE5B,QAAQ,SAAS,OAAO;CACxB,UAAU,SAAS,OAAO;CAC1B,SAAS,SAAS,OAAO;CAEzB,aAAa,SAAS,OAAO;CAC7B,OAAO,SAAS,OAAO;CACvB,QAAQ,SAAS,OAAO;CACxB,QAAQ,SAAS,OAAO;CACxB,OAAO,SAAS,OAAO;CACvB,MAAM,SAAS,OAAO;CAEtB,YAAY,SAAS,OAAO;CAC5B,YAAY,SAAS,OAAO;CAC5B,cAAc,SAAS,OAAO;CAC9B,UAAU,SAAS,OAAO;CAC1B,aAAa,SAAS,OAAO;CAC7B,QAAQ,SAAS,OAAO;CACxB,qBAAqB,SAAS,OAAO;CACrC,qBAAqB,SAAS,OAAO;CACrC,sBAAsB,SAAS,OAAO;AACxC,CAAC;AAED,MAAa,mBAAmB,SAC9B,KACE,OAAO,OAAO,GAAG,MAAM;CAAC;CAAc,OAAO;CAAG,QAAQ;CAAGA,OAAM;CAAG;AAAK,CAAC,CAAC,GAC3E,UAAU,cAAc,CAC1B,CACF;;;;;;;AAQA,MAAM,iBAAiB;;;;;;;;;AAUvB,SAAS,WAA4C,QAAa,MAAM,KAAK,IAAI,GAAQ;CACvF,MAAM,UAAU,SAAiB,KAAK,IAAI,MAAM,IAAI,KAAK;CACzD,MAAM,QAAQ,OAAO,KAAK,UAAU,KAAK,MAAM,MAAM,SAAS,CAAC;CAC/D,MAAM,QAAQ,MAAM,QAAQ,SAAS,CAAC,OAAO,IAAI,CAAC;CAClD,IAAI,MAAM,WAAW,GAAG,OAAO;CAC/B,MAAM,SAAS,MAAM,KAAK,IAAI,GAAG,KAAK;CACtC,OAAO,OAAO,KAAK,OAAO,MAAM;EAC9B,IAAI,OAAO,MAAM,EAAE,GAAG,OAAO;EAC7B,MAAM,UAAU,MAAM,KAAK;EAC3B,OAAO;GAAE,GAAG;GAAO,WAAW,IAAI,KAAK,OAAO,OAAO,IAAI,UAAU,GAAG,CAAC,CAAC,YAAY;EAAE;CACxF,CAAC;AACH;AAEA,MAAa,yBAAyB,KACpC,MACE,OAAO;;;;;;;;CAQL,IAAI,SAAS,KAAK,EAAE,SAAS,KAAK,CAAC,CAAC;CACpC,MAAM,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,UAAU,EAAE,CAAC;CAGxD,YAAY,KAAK,EAAE,SAAS,KAAK,CAAC;CAClC,YAAY,KAAK,EAAE,SAAS,KAAK,CAAC;CAClC,UAAUC,OAAM,aAAa;CAC7B,aAAaA,OAAM,gBAAgB;CACnC,WAAW,IAAI,SAAS;CACxB,MAAM;CACN,YAAY;AACd,CAAC,CACH,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,GACpC,WAAW,WAAW,WAAW,MAAM,CAAC,CAC1C;;;;;;AAOA,MAAa,sBAAsB,OAAO;CACxC,WAAW,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,UAAU,EAAE,CAAC;CAC7D,UAAUA,OAAM,aAAa;CAC7B,aAAaA,OAAM,gBAAgB;CACnC,MAAM;AACR,CAAC;AAED,MAAM,aAAa,KAAK,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,YAAY,GAAG,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC;;AAGtF,MAAM,aAAa,KAAK,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,CAAC;AAEtD,MAAM,eAAe,OAAO;CAC1B,YAAY,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;CAC3D,WAAW,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;CAC1D,QAAQ,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;CACvD,MAAM,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;;CAErD,QAAQ,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;CACvD,aAAa,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,EAAE,CAAC,CAAC;;CAE3D,SAAS,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,YAAY,GAAG,MAAM,YAAY,CAAC,CAAC;AAC9E,CAAC;;;;;;;;;;;AAYD,MAAa,yBAAyB,OAAO;CAC3C,OAAO,SAAS,MAAM,CAAC,YAAY,MAAM,UAAU,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CACxF,cAAc,SAAS,MAAM,CAAC,YAAY,MAAM,UAAU,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/F,SAAS,SAAS,MAAM,CAAC,cAAc,MAAM,YAAY,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAChG,CAAC;AAED,MAAa,sBAAsB,OAAO;CACxC,SAAS,SAAS,KAAK,CAAC;CACxB,WAAW,SAAS,sBAAsB;;;;;;CAM1C,MAAM,SAAS,UAAU;AAC3B,CAAC;AAED,MAAa,uBAAuB,OAAO;CACzC,MAAM,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;CAGjD,OAAO;CACP,SAAS,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,KAAK,CAAC;;;;;;;CAOtD,gBAAgB,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,IAAI,CAAC;AAC9D,CAAC;AAED,MAAM,gBAAgB,KACpB,OAAO,CAAC,CAAC,MAAM,UAAU,GAAG,CAAC,GAC7B,WAAW,MAAO,IAAI,IAAI,KAAA,CAAU,CACtC;;;;;AAMA,MAAa,mBAAmB,OAAO;;CAErC,KAAK,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,IAAI,CAAC;;;;;CAM9C,QAAQ,SAAS,aAAa;;CAG9B,YAAY,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;;CAGvD,YAAY,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;;CAGvD,cAAc,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;;CAGzD,UAAU,SAAS,aAAa;;;;;;CAOhC,aAAa,SAAS,aAAa;;;;;;CAOnC,qBAAqB,SAAS,aAAa;;;;;CAM3C,qBAAqB,SAAS,aAAa;;;;;CAM3C,sBAAsB,SAAS,aAAa;AAC9C,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["_null","_enum"],"sources":["../../src/schema/index.ts"],"sourcesContent":["import {\n enum as _enum,\n null as _null,\n array,\n boolean,\n e164,\n email,\n iso,\n maxLength,\n minLength,\n number,\n object,\n optional,\n pipe,\n record,\n regex,\n string,\n toLowerCase,\n toUpperCase,\n transform,\n trim,\n union,\n url,\n uuid,\n type z,\n} from 'zod/mini';\nimport type { Environment, Platform } from '../track/types';\n\nconst MAX_KEY_LENGTH = 128;\nconst MAX_VALUE_LENGTH = 512;\nconst MAX_PROPERTIES = 64;\n\n/**\n * Truncated rather than rejected. These schemas validate a whole batch at once, so refusing one\n * oversized value costs every event that traveled with it — and the values that overrun are the\n * ones derived from the page (a link's text, a URL carrying a long query), which no client can\n * bound in advance. A shortened value is worth more than a lost batch.\n */\nconst propertyText = pipe(\n string(),\n transform((value) => value.slice(0, MAX_VALUE_LENGTH))\n);\n\n/**\n * Tags are truncated for the same reason property values are, and they are stored more than once\n * (on the event, the session and the visitor), so an unbounded one costs several times over.\n * 1024 sits just above what GA4 itself keeps (1000 characters of page_location, 420 of\n * page_referrer, 300 of page_title). Real tags stay under ~500 characters; the rare longer ones\n * are page_referrer values from search and ad redirect URLs, where the kept prefix — host and\n * path — is the part that matters.\n */\nconst MAX_TAG_LENGTH = 1024;\n\nconst tagText = pipe(\n string(),\n transform((value) => value.slice(0, MAX_TAG_LENGTH))\n);\n\n/**\n * Keys are written by hand in instrumentation code, so an unusable one is a mistake in the host\n * rather than something the visitor typed. It is still dropped rather than rejected, for the same\n * reason: the mistake should cost that property, not the batch it happens to be in. Truncating a\n * key is not an option — two long keys would silently become one field.\n *\n * The key schema below is deliberately permissive so that this transform is reached at all; the\n * trimming it used to do happens here instead. `MAX_PROPERTIES` keeps the first N in insertion\n * order.\n */\nfunction takeProperties<T>(data: Record<string, T>): Record<string, T> {\n const result: Record<string, T> = {};\n let count = 0;\n for (const [rawKey, value] of Object.entries(data)) {\n if (count >= MAX_PROPERTIES) break;\n const key = rawKey.trim();\n if (!key || key.length > MAX_KEY_LENGTH) continue;\n result[key] = value;\n count++;\n }\n return result;\n}\n\n/**\n * Capped at GA4's own item-list limit, and truncated rather than rejected like every other\n * property limit here: an unbounded array is the one field a caller could still blow a batch\n * up with after the value and key limits.\n */\nconst MAX_ITEMS = 200;\n\nconst items = pipe(\n array(\n pipe(\n record(string(), union([propertyText, number(), boolean(), _null()])),\n transform(takeProperties)\n )\n ),\n transform((list) => list.slice(0, MAX_ITEMS))\n);\n\nexport const ALL_PLATFORMS = [\n 'ios',\n 'android',\n 'web',\n 'macos',\n 'windows',\n 'linux',\n 'unknown',\n] as const satisfies Platform[];\n\nexport const ALL_ENVIRONMENTS = ['development', 'production'] as const satisfies Environment[];\n\nexport const tagsSchema = object({\n os: optional(tagText),\n os_name: optional(tagText),\n os_version: optional(tagText),\n browser: optional(tagText),\n browser_name: optional(tagText),\n browser_version: optional(tagText),\n device: optional(tagText),\n device_id: optional(string().check(trim(), minLength(1), maxLength(36))),\n device_type: optional(tagText),\n device_vendor: optional(tagText),\n device_pixel_ratio: optional(number()),\n screen_width: optional(number()),\n screen_height: optional(number()),\n screen_resolution: optional(\n pipe(\n string().check(regex(/^\\d+x\\d+$/)),\n transform((v) => v as `${number}x${number}`)\n )\n ),\n webdriver: optional(boolean()),\n release: optional(tagText),\n language: optional(tagText),\n time_zone: optional(tagText),\n page_location: optional(tagText),\n page_referrer: optional(tagText),\n page_title: optional(tagText),\n page_load_id: optional(tagText),\n /**\n * @deprecated Renamed to `page_location` in 7.0.0. Accepted so that events from clients\n * still on an older SDK are not stripped of their page URL at this boundary — a browser\n * bundle stays cached long after a backend deploys. Remove once those clients are gone;\n * `pageLocation` in `server/page-location.ts` is the only reader.\n */\n // oxlint-disable-next-line typescript/no-deprecated -- Legacy input from pre-7.0 clients must survive validation.\n source_url: optional(tagText),\n // app info\n advertising_id: optional(tagText),\n install_referrer: optional(tagText),\n // Ad click ids (URL parameters) and ad platform cookies (underscore names); see AdvertisingInfo.\n // Meta Ads\n fbclid: optional(tagText),\n ad_id: optional(tagText),\n ad_name: optional(tagText),\n adset_id: optional(tagText),\n adset_name: optional(tagText),\n campaign_id: optional(tagText),\n campaign_name: optional(tagText),\n placement: optional(tagText),\n _fbc: optional(tagText),\n _fbp: optional(tagText),\n /**\n * @deprecated `fbc` / `fbp` / `rdt_uuid` were renamed to `_fbc` / `_fbp` / `_rdt_uuid` in 9.0.0.\n * Accepted so that conversions from clients still on an older SDK keep their match keys; the\n * senders read them only as a fallback (`server/click-ids.ts`). Remove once those clients are\n * gone.\n */\n // oxlint-disable-next-line typescript/no-deprecated -- Legacy pre-9.0 click-id fields must survive validation.\n fbc: optional(tagText),\n fbp: optional(tagText),\n rdt_uuid: optional(tagText),\n // Google Ads\n gclid: optional(tagText),\n gclsrc: optional(tagText),\n gad_source: optional(tagText),\n gad_campaignid: optional(tagText),\n network: optional(tagText),\n match_type: optional(tagText),\n wbraid: optional(tagText),\n gbraid: optional(tagText),\n dclid: optional(tagText),\n _gcl_aw: optional(tagText),\n _gcl_gb: optional(tagText),\n // Microsoft Ads\n msclkid: optional(tagText),\n _uetmsclkid: optional(tagText),\n // Reddit Ads\n rdt_cid: optional(tagText),\n _rdt_cid: optional(tagText),\n _rdt_uuid: optional(tagText),\n // LinkedIn Ads\n li_fat_id: optional(tagText),\n _li_fat_id: optional(tagText),\n // OpenAI Ads\n oppref: optional(tagText),\n __oppref: optional(tagText),\n __obref: optional(tagText),\n // other click ids\n ko_click_id: optional(tagText),\n ScCid: optional(tagText),\n ttclid: optional(tagText),\n twclid: optional(tagText),\n yclid: optional(tagText),\n epik: optional(tagText),\n // utm params\n utm_source: optional(tagText),\n utm_medium: optional(tagText),\n utm_campaign: optional(tagText),\n utm_term: optional(tagText),\n utm_content: optional(tagText),\n utm_id: optional(tagText),\n utm_source_platform: optional(tagText),\n utm_creative_format: optional(tagText),\n utm_marketing_tactic: optional(tagText),\n});\n\nexport const propertiesSchema = optional(\n pipe(\n record(string(), union([propertyText, number(), boolean(), _null(), items])),\n transform(takeProperties)\n )\n);\n\n/**\n * How far an event's time may be from the server's before the client clock it was stamped with is\n * taken as wrong. A batch legitimately arrives late — a tab frozen in the background, a\n * session_start held back after a failed batch — by hours, not days; a phone set to another year\n * writes its sessions into that year.\n */\nconst MAX_CLOCK_SKEW = 24 * 60 * 60 * 1000;\n\n/**\n * Puts the events stamped by a wrong client clock onto the server's, where they are parsed. Only\n * the events outside `MAX_CLOCK_SKEW` move, so one bad event cannot drag the rest of its batch\n * along: they move together by their own latest one — the wrong clock at sending — keeping their\n * order and spacing, and one still out after that (a batch mixing two wrong clocks) is on no clock\n * at all and takes the server's time. Corrected rather than rejected, for the same reason values\n * are truncated: a wrong clock should cost the event its time, not the batch its events.\n */\nfunction alignClock<T extends { timestamp: string }>(events: T[], now = Date.now()): T[] {\n const within = (time: number) => Math.abs(now - time) <= MAX_CLOCK_SKEW;\n const times = events.map((event) => Date.parse(event.timestamp));\n const wrong = times.filter((time) => !within(time));\n if (wrong.length === 0) return events;\n const offset = now - Math.max(...wrong);\n return events.map((event, i) => {\n if (within(times[i])) return event;\n const shifted = times[i] + offset;\n return { ...event, timestamp: new Date(within(shifted) ? shifted : now).toISOString() };\n });\n}\n\nexport const createTrackEventSchema = pipe(\n array(\n object({\n /**\n * The event's id, generated by the client when the event was tracked (12.1) and given to\n * the browser pixels as their deduplication id. Store the event under it with\n * `on conflict (id) do nothing`: a batch retried after the server committed it then\n * stores nothing twice. Optional for clients before 12.1, which send none — generate one\n * on the server for those.\n */\n id: optional(uuid({ version: 'v7' })),\n name: string().check(trim(), minLength(1), maxLength(64)),\n // Generated by the SDK, like `id` (`visitorId()`, `Session`): uuidv7 as well, so the\n // constraint is checked here once and the server need not check it again.\n visitor_id: uuid({ version: 'v7' }),\n session_id: uuid({ version: 'v7' }),\n platform: _enum(ALL_PLATFORMS),\n environment: _enum(ALL_ENVIRONMENTS),\n timestamp: iso.datetime(),\n tags: tagsSchema,\n properties: propertiesSchema,\n })\n ).check(minLength(1), maxLength(100)),\n transform((events) => alignClock(events))\n);\n\n/**\n * `POST /visitors`, what clients before 11.0 create their visitor with; 11.0 generates the id\n * itself and the server creates the visitor from its first events (README, \"Visitors\").\n * Kept for servers that still serve older clients.\n */\nexport const createVisitorSchema = object({\n device_id: string().check(trim(), minLength(1), maxLength(36)),\n platform: _enum(ALL_PLATFORMS),\n environment: _enum(ALL_ENVIRONMENTS),\n tags: tagsSchema,\n});\n\nconst emailValue = pipe(string().check(trim(), toLowerCase(), maxLength(320)), email());\n\n/** E.164: a plus sign (+) prefix, country code, then digits only, no dashes/parens/spaces. */\nconst phoneValue = pipe(string().check(trim()), e164());\n\nconst addressValue = object({\n first_name: optional(string().check(trim(), maxLength(128))),\n last_name: optional(string().check(trim(), maxLength(128))),\n street: optional(string().check(trim(), maxLength(256))),\n city: optional(string().check(trim(), maxLength(128))),\n /** User province, state, or region. Example: `Hampshire` */\n region: optional(string().check(trim(), maxLength(128))),\n postal_code: optional(string().check(trim(), maxLength(32))),\n /** 2-letter country code, per the ISO 3166-1 alpha-2 standard. Example: `UK` */\n country: optional(string().check(trim(), toUpperCase(), regex(/^[A-Z]{2}$/))),\n});\n\n/**\n * User-provided data (UPD) used for enhanced conversions, Customer Match, and demographics.\n * Values are sent unhashed; Google normalizes and hashes them before they reach its servers.\n *\n * Multiple values may be sent to increase the match rate: up to 3 emails, 3 phone numbers, and\n * 2 addresses.\n *\n * @see https://support.google.com/analytics/answer/14078702\n * @see https://support.google.com/google-ads/answer/13258081\n */\nexport const userProvidedDataSchema = object({\n email: optional(union([emailValue, array(emailValue).check(minLength(1), maxLength(3))])),\n phone_number: optional(union([phoneValue, array(phoneValue).check(minLength(1), maxLength(3))])),\n address: optional(union([addressValue, array(addressValue).check(minLength(1), maxLength(2))])),\n});\n\nexport const updateVisitorSchema = object({\n user_id: optional(uuid()),\n user_data: optional(userProvidedDataSchema),\n /**\n * Sent by clients before 11.1, which PATCHed their tags on every page load. From 11.1 the\n * server refreshes `visitor.tags` from each `session_start` — the moment the visit arrives —\n * and `identify` sends none: at sign-in the page is no longer where the visit came in.\n */\n tags: optional(tagsSchema),\n});\n\nexport const createFeedbackSchema = object({\n name: string().check(minLength(1), maxLength(256)),\n // Trimmed and lower-cased like every other email the SDK accepts, so a host stores the\n // normalized form without wrapping the schema.\n email: emailValue,\n message: string().check(minLength(1), maxLength(65536)),\n /**\n * The Cloudflare Turnstile token the host verifies before storing the feedback (the same field\n * `@shware/security`'s email-code request carries). Required: without it `POST /feedback` is an\n * open free-text write that only a rate limit protects. Single-use: Turnstile spends the token\n * at verification, so the caller resets the widget after every submit, success or failure.\n */\n turnstileToken: string().check(minLength(1), maxLength(2048)),\n});\n\nconst noEmptyString = pipe(\n string().check(maxLength(256)),\n transform((v) => (v ? v : undefined))\n);\n\n/**\n * The schema for creating a link.\n * @see https://support.google.com/analytics/answer/10917952\n * */\nexport const createLinkSchema = object({\n /** The URL that the user is redirected to. */\n url: url().check(minLength(1), maxLength(1024)), // required\n\n /**\n * Campaign ID. Used to identify a specific campaign or promotion. This is a required key for GA4\n * data import. Use the same IDs that you use when uploading campaign cost data.\n */\n utm_id: optional(noEmptyString),\n\n /** Referrer, for example: google, newsletter4, billboard */\n utm_source: string().check(minLength(1), maxLength(256)), // required\n\n /** Marketing medium, for example: cpc, banner, email */\n utm_medium: string().check(minLength(1), maxLength(256)), // required\n\n /** Product, slogan, promo code, for example, spring_sale */\n utm_campaign: string().check(minLength(1), maxLength(256)), // required\n\n /** Paid keyword */\n utm_term: optional(noEmptyString),\n\n /**\n * Use to differentiate creatives. For example, if you have two call-to-action links within the\n * same email message, you can use utm_content and set different values for each so you can tell\n * which version is more effective.\n */\n utm_content: optional(noEmptyString),\n\n /**\n * The platform responsible for directing traffic to a given Analytics property (such as a buying\n * platform that sets budgets and targeting criteria or a platform that manages organic traffic\n * data). For example, Search Ads 360 or Display & Video 360.\n */\n utm_source_platform: optional(noEmptyString),\n\n /**\n * Type of creative, for example, display, native, video, search, utm_creative_format is not\n * currently reported in Google Analytics 4 properties.\n */\n utm_creative_format: optional(noEmptyString),\n\n /**\n * Targeting criteria applied to a campaign, for example, remarketing, prospecting,\n * utm_marketing_tactic is not currently reported in Google Analytics 4 properties.\n * */\n utm_marketing_tactic: optional(noEmptyString),\n});\n\nexport type CreateTrackEventDTO = z.output<typeof createTrackEventSchema>;\nexport type CreateFeedbackDTO = z.output<typeof createFeedbackSchema>;\nexport type CreateLinkDTO = z.output<typeof createLinkSchema>;\nexport type CreateVisitorDTO = z.output<typeof createVisitorSchema>;\nexport type UserProvidedDataDTO = z.output<typeof userProvidedDataSchema>;\nexport type UpdateVisitorDTO = z.output<typeof updateVisitorSchema>;\n"],"mappings":";;AA4BA,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,iBAAiB;;;;;;;AAQvB,MAAM,eAAe,KACnB,OAAO,GACP,WAAW,UAAU,MAAM,MAAM,GAAG,gBAAgB,CAAC,CACvD;;;;;;;;;AAUA,MAAM,iBAAiB;AAEvB,MAAM,UAAU,KACd,OAAO,GACP,WAAW,UAAU,MAAM,MAAM,GAAG,cAAc,CAAC,CACrD;;;;;;;;;;;AAYA,SAAS,eAAkB,MAA4C;CACrE,MAAM,SAA4B,CAAC;CACnC,IAAI,QAAQ;CACZ,KAAK,MAAM,CAAC,QAAQ,UAAU,OAAO,QAAQ,IAAI,GAAG;EAClD,IAAI,SAAS,gBAAgB;EAC7B,MAAM,MAAM,OAAO,KAAK;EACxB,IAAI,CAAC,OAAO,IAAI,SAAS,gBAAgB;EACzC,OAAO,OAAO;EACd;CACF;CACA,OAAO;AACT;;;;;;AAOA,MAAM,YAAY;AAElB,MAAM,QAAQ,KACZ,MACE,KACE,OAAO,OAAO,GAAG,MAAM;CAAC;CAAc,OAAO;CAAG,QAAQ;CAAGA,OAAM;AAAC,CAAC,CAAC,GACpE,UAAU,cAAc,CAC1B,CACF,GACA,WAAW,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC,CAC9C;AAEA,MAAa,gBAAgB;CAC3B;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAEA,MAAa,mBAAmB,CAAC,eAAe,YAAY;AAE5D,MAAa,aAAa,OAAO;CAC/B,IAAI,SAAS,OAAO;CACpB,SAAS,SAAS,OAAO;CACzB,YAAY,SAAS,OAAO;CAC5B,SAAS,SAAS,OAAO;CACzB,cAAc,SAAS,OAAO;CAC9B,iBAAiB,SAAS,OAAO;CACjC,QAAQ,SAAS,OAAO;CACxB,WAAW,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,UAAU,EAAE,CAAC,CAAC;CACvE,aAAa,SAAS,OAAO;CAC7B,eAAe,SAAS,OAAO;CAC/B,oBAAoB,SAAS,OAAO,CAAC;CACrC,cAAc,SAAS,OAAO,CAAC;CAC/B,eAAe,SAAS,OAAO,CAAC;CAChC,mBAAmB,SACjB,KACE,OAAO,CAAC,CAAC,MAAM,MAAM,WAAW,CAAC,GACjC,WAAW,MAAM,CAA0B,CAC7C,CACF;CACA,WAAW,SAAS,QAAQ,CAAC;CAC7B,SAAS,SAAS,OAAO;CACzB,UAAU,SAAS,OAAO;CAC1B,WAAW,SAAS,OAAO;CAC3B,eAAe,SAAS,OAAO;CAC/B,eAAe,SAAS,OAAO;CAC/B,YAAY,SAAS,OAAO;CAC5B,cAAc,SAAS,OAAO;;;;;;;CAQ9B,YAAY,SAAS,OAAO;CAE5B,gBAAgB,SAAS,OAAO;CAChC,kBAAkB,SAAS,OAAO;CAGlC,QAAQ,SAAS,OAAO;CACxB,OAAO,SAAS,OAAO;CACvB,SAAS,SAAS,OAAO;CACzB,UAAU,SAAS,OAAO;CAC1B,YAAY,SAAS,OAAO;CAC5B,aAAa,SAAS,OAAO;CAC7B,eAAe,SAAS,OAAO;CAC/B,WAAW,SAAS,OAAO;CAC3B,MAAM,SAAS,OAAO;CACtB,MAAM,SAAS,OAAO;;;;;;;CAQtB,KAAK,SAAS,OAAO;CACrB,KAAK,SAAS,OAAO;CACrB,UAAU,SAAS,OAAO;CAE1B,OAAO,SAAS,OAAO;CACvB,QAAQ,SAAS,OAAO;CACxB,YAAY,SAAS,OAAO;CAC5B,gBAAgB,SAAS,OAAO;CAChC,SAAS,SAAS,OAAO;CACzB,YAAY,SAAS,OAAO;CAC5B,QAAQ,SAAS,OAAO;CACxB,QAAQ,SAAS,OAAO;CACxB,OAAO,SAAS,OAAO;CACvB,SAAS,SAAS,OAAO;CACzB,SAAS,SAAS,OAAO;CAEzB,SAAS,SAAS,OAAO;CACzB,aAAa,SAAS,OAAO;CAE7B,SAAS,SAAS,OAAO;CACzB,UAAU,SAAS,OAAO;CAC1B,WAAW,SAAS,OAAO;CAE3B,WAAW,SAAS,OAAO;CAC3B,YAAY,SAAS,OAAO;CAE5B,QAAQ,SAAS,OAAO;CACxB,UAAU,SAAS,OAAO;CAC1B,SAAS,SAAS,OAAO;CAEzB,aAAa,SAAS,OAAO;CAC7B,OAAO,SAAS,OAAO;CACvB,QAAQ,SAAS,OAAO;CACxB,QAAQ,SAAS,OAAO;CACxB,OAAO,SAAS,OAAO;CACvB,MAAM,SAAS,OAAO;CAEtB,YAAY,SAAS,OAAO;CAC5B,YAAY,SAAS,OAAO;CAC5B,cAAc,SAAS,OAAO;CAC9B,UAAU,SAAS,OAAO;CAC1B,aAAa,SAAS,OAAO;CAC7B,QAAQ,SAAS,OAAO;CACxB,qBAAqB,SAAS,OAAO;CACrC,qBAAqB,SAAS,OAAO;CACrC,sBAAsB,SAAS,OAAO;AACxC,CAAC;AAED,MAAa,mBAAmB,SAC9B,KACE,OAAO,OAAO,GAAG,MAAM;CAAC;CAAc,OAAO;CAAG,QAAQ;CAAGA,OAAM;CAAG;AAAK,CAAC,CAAC,GAC3E,UAAU,cAAc,CAC1B,CACF;;;;;;;AAQA,MAAM,iBAAiB;;;;;;;;;AAUvB,SAAS,WAA4C,QAAa,MAAM,KAAK,IAAI,GAAQ;CACvF,MAAM,UAAU,SAAiB,KAAK,IAAI,MAAM,IAAI,KAAK;CACzD,MAAM,QAAQ,OAAO,KAAK,UAAU,KAAK,MAAM,MAAM,SAAS,CAAC;CAC/D,MAAM,QAAQ,MAAM,QAAQ,SAAS,CAAC,OAAO,IAAI,CAAC;CAClD,IAAI,MAAM,WAAW,GAAG,OAAO;CAC/B,MAAM,SAAS,MAAM,KAAK,IAAI,GAAG,KAAK;CACtC,OAAO,OAAO,KAAK,OAAO,MAAM;EAC9B,IAAI,OAAO,MAAM,EAAE,GAAG,OAAO;EAC7B,MAAM,UAAU,MAAM,KAAK;EAC3B,OAAO;GAAE,GAAG;GAAO,WAAW,IAAI,KAAK,OAAO,OAAO,IAAI,UAAU,GAAG,CAAC,CAAC,YAAY;EAAE;CACxF,CAAC;AACH;AAEA,MAAa,yBAAyB,KACpC,MACE,OAAO;;;;;;;;CAQL,IAAI,SAAS,KAAK,EAAE,SAAS,KAAK,CAAC,CAAC;CACpC,MAAM,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,UAAU,EAAE,CAAC;CAGxD,YAAY,KAAK,EAAE,SAAS,KAAK,CAAC;CAClC,YAAY,KAAK,EAAE,SAAS,KAAK,CAAC;CAClC,UAAUC,OAAM,aAAa;CAC7B,aAAaA,OAAM,gBAAgB;CACnC,WAAW,IAAI,SAAS;CACxB,MAAM;CACN,YAAY;AACd,CAAC,CACH,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,GACpC,WAAW,WAAW,WAAW,MAAM,CAAC,CAC1C;;;;;;AAOA,MAAa,sBAAsB,OAAO;CACxC,WAAW,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,UAAU,EAAE,CAAC;CAC7D,UAAUA,OAAM,aAAa;CAC7B,aAAaA,OAAM,gBAAgB;CACnC,MAAM;AACR,CAAC;AAED,MAAM,aAAa,KAAK,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,YAAY,GAAG,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC;;AAGtF,MAAM,aAAa,KAAK,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,CAAC;AAEtD,MAAM,eAAe,OAAO;CAC1B,YAAY,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;CAC3D,WAAW,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;CAC1D,QAAQ,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;CACvD,MAAM,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;;CAErD,QAAQ,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;CACvD,aAAa,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,UAAU,EAAE,CAAC,CAAC;;CAE3D,SAAS,SAAS,OAAO,CAAC,CAAC,MAAM,KAAK,GAAG,YAAY,GAAG,MAAM,YAAY,CAAC,CAAC;AAC9E,CAAC;;;;;;;;;;;AAYD,MAAa,yBAAyB,OAAO;CAC3C,OAAO,SAAS,MAAM,CAAC,YAAY,MAAM,UAAU,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CACxF,cAAc,SAAS,MAAM,CAAC,YAAY,MAAM,UAAU,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/F,SAAS,SAAS,MAAM,CAAC,cAAc,MAAM,YAAY,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAChG,CAAC;AAED,MAAa,sBAAsB,OAAO;CACxC,SAAS,SAAS,KAAK,CAAC;CACxB,WAAW,SAAS,sBAAsB;;;;;;CAM1C,MAAM,SAAS,UAAU;AAC3B,CAAC;AAED,MAAa,uBAAuB,OAAO;CACzC,MAAM,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;CAGjD,OAAO;CACP,SAAS,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,KAAK,CAAC;;;;;;;CAOtD,gBAAgB,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,IAAI,CAAC;AAC9D,CAAC;AAED,MAAM,gBAAgB,KACpB,OAAO,CAAC,CAAC,MAAM,UAAU,GAAG,CAAC,GAC7B,WAAW,MAAO,IAAI,IAAI,KAAA,CAAU,CACtC;;;;;AAMA,MAAa,mBAAmB,OAAO;;CAErC,KAAK,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,IAAI,CAAC;;;;;CAM9C,QAAQ,SAAS,aAAa;;CAG9B,YAAY,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;;CAGvD,YAAY,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;;CAGvD,cAAc,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;;CAGzD,UAAU,SAAS,aAAa;;;;;;CAOhC,aAAa,SAAS,aAAa;;;;;;CAOnC,qBAAqB,SAAS,aAAa;;;;;CAM3C,qBAAqB,SAAS,aAAa;;;;;CAM3C,sBAAsB,SAAS,aAAa;AAC9C,CAAC"}
|
package/dist/setup/session.cjs
CHANGED
|
@@ -65,6 +65,15 @@ var Session = class {
|
|
|
65
65
|
});
|
|
66
66
|
return stored.id;
|
|
67
67
|
};
|
|
68
|
+
this.end = () => {
|
|
69
|
+
const engagement_time_msec = this.flush();
|
|
70
|
+
const id = readSession()?.id;
|
|
71
|
+
require_setup_index.config.storage.setItem(require_constants_storage.keys.session, "");
|
|
72
|
+
return {
|
|
73
|
+
id,
|
|
74
|
+
engagement_time_msec
|
|
75
|
+
};
|
|
76
|
+
};
|
|
68
77
|
this.isActive = () => this.active;
|
|
69
78
|
this.updateActive = (active) => {
|
|
70
79
|
this.active = active;
|