@reopt-ai/data-contract 0.6.3 → 0.7.0
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/dist/client.cjs +228 -321
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +57 -71
- package/dist/client.d.cts.map +1 -0
- package/dist/client.d.ts +57 -71
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +228 -322
- package/dist/client.js.map +1 -1
- package/dist/control.cjs +158 -54
- package/dist/control.cjs.map +1 -1
- package/dist/control.d.cts +121 -137
- package/dist/control.d.cts.map +1 -0
- package/dist/control.d.ts +121 -137
- package/dist/control.d.ts.map +1 -0
- package/dist/control.js +134 -54
- package/dist/control.js.map +1 -1
- package/dist/events-BUIeU60t.d.cts +142 -0
- package/dist/events-BUIeU60t.d.cts.map +1 -0
- package/dist/events-BUIeU60t.d.ts +142 -0
- package/dist/events-BUIeU60t.d.ts.map +1 -0
- package/dist/events.cjs +110 -15
- package/dist/events.cjs.map +1 -1
- package/dist/events.d.cts +2 -59
- package/dist/events.d.ts +2 -59
- package/dist/events.js +101 -15
- package/dist/events.js.map +1 -1
- package/dist/identity.cjs +150 -55
- package/dist/identity.cjs.map +1 -1
- package/dist/identity.d.cts +21 -20
- package/dist/identity.d.cts.map +1 -0
- package/dist/identity.d.ts +21 -20
- package/dist/identity.d.ts.map +1 -0
- package/dist/identity.js +126 -56
- package/dist/identity.js.map +1 -1
- package/dist/index.cjs +46 -25
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +37 -54
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.ts +37 -54
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +36 -25
- package/dist/index.js.map +1 -1
- package/dist/ingest.cjs +152 -57
- package/dist/ingest.cjs.map +1 -1
- package/dist/ingest.d.cts +182 -193
- package/dist/ingest.d.cts.map +1 -0
- package/dist/ingest.d.ts +182 -193
- package/dist/ingest.d.ts.map +1 -0
- package/dist/ingest.js +126 -57
- package/dist/ingest.js.map +1 -1
- package/dist/query.cjs +284 -84
- package/dist/query.cjs.map +1 -1
- package/dist/query.d.cts +456 -469
- package/dist/query.d.cts.map +1 -0
- package/dist/query.d.ts +456 -469
- package/dist/query.d.ts.map +1 -0
- package/dist/query.js +245 -84
- package/dist/query.js.map +1 -1
- package/dist/report.cjs +104 -74
- package/dist/report.cjs.map +1 -1
- package/dist/report.d.cts +182 -136
- package/dist/report.d.cts.map +1 -0
- package/dist/report.d.ts +182 -136
- package/dist/report.d.ts.map +1 -0
- package/dist/report.js +93 -74
- package/dist/report.js.map +1 -1
- package/dist/version-B_0qb1_K.cjs +53 -0
- package/dist/version-B_0qb1_K.cjs.map +1 -0
- package/dist/version-C09Cyf4R.js +12 -0
- package/dist/version-C09Cyf4R.js.map +1 -0
- package/dist/{version-DJ2Grb_N.d.ts → version-CGujUGWd.d.cts} +5 -3
- package/dist/version-CGujUGWd.d.cts.map +1 -0
- package/dist/{version-DJ2Grb_N.d.cts → version-CGujUGWd.d.ts} +5 -3
- package/dist/version-CGujUGWd.d.ts.map +1 -0
- package/package.json +69 -28
- package/dist/chunk-3EEANNYN.cjs +0 -62
- package/dist/chunk-3EEANNYN.cjs.map +0 -1
- package/dist/chunk-7W33YGRO.js +0 -160
- package/dist/chunk-7W33YGRO.js.map +0 -1
- package/dist/chunk-F2RNXJGO.cjs +0 -19
- package/dist/chunk-F2RNXJGO.cjs.map +0 -1
- package/dist/chunk-FP2X3PRK.js +0 -62
- package/dist/chunk-FP2X3PRK.js.map +0 -1
- package/dist/chunk-JCEWUSUM.js +0 -53
- package/dist/chunk-JCEWUSUM.js.map +0 -1
- package/dist/chunk-L3JPDRVG.cjs +0 -160
- package/dist/chunk-L3JPDRVG.cjs.map +0 -1
- package/dist/chunk-L4KBQAOO.js +0 -204
- package/dist/chunk-L4KBQAOO.js.map +0 -1
- package/dist/chunk-NJ4JKNBX.js +0 -361
- package/dist/chunk-NJ4JKNBX.js.map +0 -1
- package/dist/chunk-ORNTN6AK.cjs +0 -53
- package/dist/chunk-ORNTN6AK.cjs.map +0 -1
- package/dist/chunk-PSUINLW7.js +0 -19
- package/dist/chunk-PSUINLW7.js.map +0 -1
- package/dist/chunk-RU26QFM2.js +0 -179
- package/dist/chunk-RU26QFM2.js.map +0 -1
- package/dist/chunk-XDH5QQYF.cjs +0 -361
- package/dist/chunk-XDH5QQYF.cjs.map +0 -1
- package/dist/chunk-YCTGHWTP.cjs +0 -204
- package/dist/chunk-YCTGHWTP.cjs.map +0 -1
- package/dist/chunk-ZI6A3WQP.cjs +0 -179
- package/dist/chunk-ZI6A3WQP.cjs.map +0 -1
package/dist/chunk-RU26QFM2.js
DELETED
|
@@ -1,179 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
IDENTITY_ID_PATTERN
|
|
3
|
-
} from "./chunk-7W33YGRO.js";
|
|
4
|
-
import {
|
|
5
|
-
RESERVED_EVENT_NAMES
|
|
6
|
-
} from "./chunk-FP2X3PRK.js";
|
|
7
|
-
|
|
8
|
-
// src/ingest.ts
|
|
9
|
-
import { z } from "zod";
|
|
10
|
-
var MAX_TRACK_PAYLOAD_BYTES = 512e3;
|
|
11
|
-
var zClientEventMetadata = {
|
|
12
|
-
/**
|
|
13
|
-
* Client-generated UUID. This is the project-scoped idempotency key stored as
|
|
14
|
-
* `RawEvent.clientEventId`; the server uses a separate globally unique raw
|
|
15
|
-
* event id internally. Re-sending the same eventId to the same project is
|
|
16
|
-
* always safe and always reported as a duplicate.
|
|
17
|
-
*/
|
|
18
|
-
eventId: z.uuid(),
|
|
19
|
-
/** Event time, epoch milliseconds. */
|
|
20
|
-
timestamp: z.number().int().nonnegative(),
|
|
21
|
-
/**
|
|
22
|
-
* The browser device this event belongs to, for events a server records
|
|
23
|
-
* on a visitor's behalf (a form submission, an order). Lets one server
|
|
24
|
-
* batch carry events from many visitors — a forwarder cannot split its
|
|
25
|
-
* batches per device without breaking its failure model and its
|
|
26
|
-
* `accepted + duplicates + rejected === sent` invariant.
|
|
27
|
-
*
|
|
28
|
-
* Honoured in `server` mode only, where it takes precedence over the
|
|
29
|
-
* `reopt-device-id` request header. Ignored in `browser` mode: there the
|
|
30
|
-
* header is authoritative and a body field would be trivially forged.
|
|
31
|
-
* Same character set as every identity id.
|
|
32
|
-
*/
|
|
33
|
-
deviceId: z.string().regex(IDENTITY_ID_PATTERN, "expected an identity id").optional()
|
|
34
|
-
};
|
|
35
|
-
var zTrackPayload = z.object({
|
|
36
|
-
name: z.string().min(1).max(200),
|
|
37
|
-
properties: z.record(z.string(), z.unknown()).optional(),
|
|
38
|
-
profileId: z.string().max(500).or(z.number()).optional()
|
|
39
|
-
}).refine((data) => !RESERVED_EVENT_NAMES.includes(data.name), {
|
|
40
|
-
message: `Event name cannot be one of the reserved names: ${RESERVED_EVENT_NAMES.join(", ")}`,
|
|
41
|
-
path: ["name"]
|
|
42
|
-
});
|
|
43
|
-
var zIdentifyPayload = z.object({
|
|
44
|
-
profileId: z.string().min(1).max(500).or(z.number()),
|
|
45
|
-
firstName: z.string().max(200).optional(),
|
|
46
|
-
lastName: z.string().max(200).optional(),
|
|
47
|
-
email: z.email().max(320).optional(),
|
|
48
|
-
avatar: z.url().max(2e3).optional(),
|
|
49
|
-
properties: z.record(z.string(), z.unknown()).optional()
|
|
50
|
-
});
|
|
51
|
-
var zIncrementPayload = z.object({
|
|
52
|
-
profileId: z.string().min(1).max(500).or(z.number()),
|
|
53
|
-
property: z.string().min(1).max(200),
|
|
54
|
-
value: z.number().positive().optional()
|
|
55
|
-
});
|
|
56
|
-
var zDecrementPayload = z.object({
|
|
57
|
-
profileId: z.string().min(1).max(500).or(z.number()),
|
|
58
|
-
property: z.string().min(1).max(200),
|
|
59
|
-
value: z.number().positive().optional()
|
|
60
|
-
});
|
|
61
|
-
var zTrackHandlerPayload = z.discriminatedUnion("type", [
|
|
62
|
-
z.object({ type: z.literal("track"), payload: zTrackPayload, ...zClientEventMetadata }),
|
|
63
|
-
z.object({ type: z.literal("identify"), payload: zIdentifyPayload, ...zClientEventMetadata }),
|
|
64
|
-
z.object({ type: z.literal("increment"), payload: zIncrementPayload, ...zClientEventMetadata }),
|
|
65
|
-
z.object({ type: z.literal("decrement"), payload: zDecrementPayload, ...zClientEventMetadata })
|
|
66
|
-
]);
|
|
67
|
-
var INGEST_MODES = ["browser", "server"];
|
|
68
|
-
var zIngestMode = z.enum(INGEST_MODES);
|
|
69
|
-
var INGEST_REJECTION_REASONS = [
|
|
70
|
-
/** Failed the zod schema (bad eventId, missing name, wrong types…). */
|
|
71
|
-
"validation_failed",
|
|
72
|
-
/** Used one of RESERVED_EVENT_NAMES. */
|
|
73
|
-
"reserved_name",
|
|
74
|
-
/** Another row earlier in the same batch already claimed this eventId. */
|
|
75
|
-
"duplicate_in_batch"
|
|
76
|
-
];
|
|
77
|
-
var zIngestRejectionReason = z.enum(INGEST_REJECTION_REASONS);
|
|
78
|
-
var zIngestRejection = z.object({
|
|
79
|
-
/** May be absent or malformed on `validation_failed` — hence `string`, not `uuid`. */
|
|
80
|
-
eventId: z.string(),
|
|
81
|
-
/** Position in the submitted batch. The only reliable identifier when eventId itself is bad. */
|
|
82
|
-
index: z.number().int().nonnegative(),
|
|
83
|
-
reason: zIngestRejectionReason,
|
|
84
|
-
message: z.string().optional()
|
|
85
|
-
});
|
|
86
|
-
var ingestCounts = {
|
|
87
|
-
/** Raw events newly persisted by this request. */
|
|
88
|
-
accepted: z.number().int().nonnegative(),
|
|
89
|
-
/**
|
|
90
|
-
* Events the server already had. In `server` mode this is exactly the
|
|
91
|
-
* eventId-idempotency count; in `browser` mode it also includes the
|
|
92
|
-
* 5-second click dedup.
|
|
93
|
-
*/
|
|
94
|
-
duplicates: z.number().int().nonnegative(),
|
|
95
|
-
/** Always `[]` in `browser` mode, where a bad row fails the whole batch. */
|
|
96
|
-
rejected: z.array(zIngestRejection)
|
|
97
|
-
};
|
|
98
|
-
var zSessionCredential = z.object({
|
|
99
|
-
id: z.string().regex(IDENTITY_ID_PATTERN),
|
|
100
|
-
token: z.string().regex(/^[A-Za-z0-9_-]{43}$/)
|
|
101
|
-
});
|
|
102
|
-
var zIngestOkResponse = z.object({
|
|
103
|
-
status: z.literal("ok"),
|
|
104
|
-
requestId: z.string(),
|
|
105
|
-
mode: zIngestMode,
|
|
106
|
-
...ingestCounts,
|
|
107
|
-
queued: z.boolean(),
|
|
108
|
-
session: zSessionCredential.optional()
|
|
109
|
-
});
|
|
110
|
-
var zIngestAcceptedResponse = z.object({
|
|
111
|
-
status: z.literal("accepted"),
|
|
112
|
-
requestId: z.string(),
|
|
113
|
-
mode: zIngestMode,
|
|
114
|
-
...ingestCounts,
|
|
115
|
-
backgroundQueued: z.literal(false),
|
|
116
|
-
replay: z.literal("unmaterialized-raw-events"),
|
|
117
|
-
session: zSessionCredential.optional()
|
|
118
|
-
});
|
|
119
|
-
var zIngestResponse = z.discriminatedUnion("status", [zIngestOkResponse, zIngestAcceptedResponse]);
|
|
120
|
-
function reconcileIngestResponse(response, sentCount) {
|
|
121
|
-
return response.accepted + response.duplicates + response.rejected.length === sentCount;
|
|
122
|
-
}
|
|
123
|
-
var INGEST_ERROR_CODES = [
|
|
124
|
-
/** 401 — unknown or mismatched credentials. Stop and alert; do not retry. */
|
|
125
|
-
"unauthorized",
|
|
126
|
-
/** 400 — body was not valid JSON. */
|
|
127
|
-
"invalid_json",
|
|
128
|
-
/** 400 — request exceeded MAX_TRACK_PAYLOAD_BYTES. Split the batch. */
|
|
129
|
-
"payload_too_large",
|
|
130
|
-
/** 400 — zero events submitted. */
|
|
131
|
-
"empty_batch",
|
|
132
|
-
/** 400 — batch contained a `type: "alias"` event, which is not supported. */
|
|
133
|
-
"alias_unsupported",
|
|
134
|
-
/** 400 — the project has no organization; it cannot be billed or quota-checked. */
|
|
135
|
-
"project_without_organization",
|
|
136
|
-
/** 400 — `browser` mode only: a row failed validation. `server` mode reports these in `rejected[]`. */
|
|
137
|
-
"validation_failed",
|
|
138
|
-
/** 429 — per-project request rate limit. `Retry-After` set. Pause this tick, keep the cursor. */
|
|
139
|
-
"rate_limited",
|
|
140
|
-
/** 429 — the organization's monthly event quota is exhausted. `Retry-After` set (capped at 1h). Alert: a human must raise the limit. */
|
|
141
|
-
"quota_exceeded",
|
|
142
|
-
/** 410 — the project is being deleted. Permanent; stop sending. */
|
|
143
|
-
"project_purging",
|
|
144
|
-
/** 500 — unexpected server failure. Back off and retry. */
|
|
145
|
-
"internal_error"
|
|
146
|
-
];
|
|
147
|
-
var zIngestErrorCode = z.enum(INGEST_ERROR_CODES);
|
|
148
|
-
var zIngestError = z.object({
|
|
149
|
-
status: z.number().int(),
|
|
150
|
-
code: zIngestErrorCode,
|
|
151
|
-
error: z.string(),
|
|
152
|
-
message: z.string().optional(),
|
|
153
|
-
/** zod issues, when `code === "validation_failed"`. */
|
|
154
|
-
errors: z.unknown().optional(),
|
|
155
|
-
requestId: z.string().optional()
|
|
156
|
-
});
|
|
157
|
-
|
|
158
|
-
export {
|
|
159
|
-
MAX_TRACK_PAYLOAD_BYTES,
|
|
160
|
-
zTrackPayload,
|
|
161
|
-
zIdentifyPayload,
|
|
162
|
-
zIncrementPayload,
|
|
163
|
-
zDecrementPayload,
|
|
164
|
-
zTrackHandlerPayload,
|
|
165
|
-
INGEST_MODES,
|
|
166
|
-
zIngestMode,
|
|
167
|
-
INGEST_REJECTION_REASONS,
|
|
168
|
-
zIngestRejectionReason,
|
|
169
|
-
zIngestRejection,
|
|
170
|
-
zSessionCredential,
|
|
171
|
-
zIngestOkResponse,
|
|
172
|
-
zIngestAcceptedResponse,
|
|
173
|
-
zIngestResponse,
|
|
174
|
-
reconcileIngestResponse,
|
|
175
|
-
INGEST_ERROR_CODES,
|
|
176
|
-
zIngestErrorCode,
|
|
177
|
-
zIngestError
|
|
178
|
-
};
|
|
179
|
-
//# sourceMappingURL=chunk-RU26QFM2.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/ingest.ts"],"sourcesContent":["/**\n * `POST /api/track` — the ingest contract.\n *\n * The request shape is shared by both credential modes. The *response* shape\n * is where server-ingest differs: it reports per-event rejections instead of\n * failing a whole batch, because a forwarder that stalls on one malformed row\n * stops forwarding forever.\n *\n * Absorbed from the former internal `@reopt/ingest-contract`; that package is\n * now a deprecated re-export of this module.\n */\nimport { z } from \"zod\";\nimport { IDENTITY_ID_PATTERN } from \"./identity.js\";\n\nexport {\n AUTO_EVENT_NAMES,\n AUTO_EVENT_PROPERTIES,\n AUTO_EVENT_ROLLUP_KEYS,\n RESERVED_EVENT_NAMES,\n SCROLL_DEPTH_BUCKETS,\n scrollDepthBucket,\n type AutoEventName,\n type ScrollDepthBucket,\n} from \"./events.js\";\nimport { RESERVED_EVENT_NAMES } from \"./events.js\";\n\n/** Hard cap enforced by the route before the body is even parsed. */\nexport const MAX_TRACK_PAYLOAD_BYTES = 512_000;\n\nconst zClientEventMetadata = {\n /**\n * Client-generated UUID. This is the project-scoped idempotency key stored as\n * `RawEvent.clientEventId`; the server uses a separate globally unique raw\n * event id internally. Re-sending the same eventId to the same project is\n * always safe and always reported as a duplicate.\n */\n eventId: z.uuid(),\n /** Event time, epoch milliseconds. */\n timestamp: z.number().int().nonnegative(),\n /**\n * The browser device this event belongs to, for events a server records\n * on a visitor's behalf (a form submission, an order). Lets one server\n * batch carry events from many visitors — a forwarder cannot split its\n * batches per device without breaking its failure model and its\n * `accepted + duplicates + rejected === sent` invariant.\n *\n * Honoured in `server` mode only, where it takes precedence over the\n * `reopt-device-id` request header. Ignored in `browser` mode: there the\n * header is authoritative and a body field would be trivially forged.\n * Same character set as every identity id.\n */\n deviceId: z.string().regex(IDENTITY_ID_PATTERN, \"expected an identity id\").optional(),\n};\n\nexport const zTrackPayload = z\n .object({\n name: z.string().min(1).max(200),\n properties: z.record(z.string(), z.unknown()).optional(),\n profileId: z.string().max(500).or(z.number()).optional(),\n })\n .refine((data) => !RESERVED_EVENT_NAMES.includes(data.name as never), {\n message: `Event name cannot be one of the reserved names: ${RESERVED_EVENT_NAMES.join(\", \")}`,\n path: [\"name\"],\n });\n\nexport const zIdentifyPayload = z.object({\n profileId: z.string().min(1).max(500).or(z.number()),\n firstName: z.string().max(200).optional(),\n lastName: z.string().max(200).optional(),\n email: z.email().max(320).optional(),\n avatar: z.url().max(2000).optional(),\n properties: z.record(z.string(), z.unknown()).optional(),\n});\n\nexport const zIncrementPayload = z.object({\n profileId: z.string().min(1).max(500).or(z.number()),\n property: z.string().min(1).max(200),\n value: z.number().positive().optional(),\n});\n\nexport const zDecrementPayload = z.object({\n profileId: z.string().min(1).max(500).or(z.number()),\n property: z.string().min(1).max(200),\n value: z.number().positive().optional(),\n});\n\nexport const zTrackHandlerPayload = z.discriminatedUnion(\"type\", [\n z.object({ type: z.literal(\"track\"), payload: zTrackPayload, ...zClientEventMetadata }),\n z.object({ type: z.literal(\"identify\"), payload: zIdentifyPayload, ...zClientEventMetadata }),\n z.object({ type: z.literal(\"increment\"), payload: zIncrementPayload, ...zClientEventMetadata }),\n z.object({ type: z.literal(\"decrement\"), payload: zDecrementPayload, ...zClientEventMetadata }),\n]);\n\nexport type ITrackPayload = z.infer<typeof zTrackPayload>;\nexport type IIdentifyPayload = z.infer<typeof zIdentifyPayload>;\nexport type IIncrementPayload = z.infer<typeof zIncrementPayload>;\nexport type IDecrementPayload = z.infer<typeof zDecrementPayload>;\nexport type ITrackHandlerPayload = z.infer<typeof zTrackHandlerPayload>;\n\n// ─── Ingest mode ────────────────────────────────────────────────────────────\n\n/**\n * Decided by the credential presented, never by a header the caller sets:\n * `reopt-write-key` alone → `browser`, `reopt-client-id` + `reopt-client-secret`\n * → `server`. A separate mode header could disagree with the credential; this\n * cannot.\n *\n * `browser` keeps the 5-second click dedup and device-scoped sessions.\n * `server` drops both and relies solely on `eventId` idempotency — a server\n * batch legitimately contains the same event name many times within one second,\n * and its \"device\" is a process, not a person.\n */\nexport const INGEST_MODES = [\"browser\", \"server\"] as const;\nexport const zIngestMode = z.enum(INGEST_MODES);\nexport type IngestMode = z.infer<typeof zIngestMode>;\n\n// ─── Response ───────────────────────────────────────────────────────────────\n\n/**\n * Why a single event in a batch was dropped. These are permanent: re-sending\n * the same row produces the same rejection, so a forwarder should count it as\n * skipped and advance its cursor rather than retry.\n */\nexport const INGEST_REJECTION_REASONS = [\n /** Failed the zod schema (bad eventId, missing name, wrong types…). */\n \"validation_failed\",\n /** Used one of RESERVED_EVENT_NAMES. */\n \"reserved_name\",\n /** Another row earlier in the same batch already claimed this eventId. */\n \"duplicate_in_batch\",\n] as const;\nexport const zIngestRejectionReason = z.enum(INGEST_REJECTION_REASONS);\nexport type IngestRejectionReason = z.infer<typeof zIngestRejectionReason>;\n\nexport const zIngestRejection = z.object({\n /** May be absent or malformed on `validation_failed` — hence `string`, not `uuid`. */\n eventId: z.string(),\n /** Position in the submitted batch. The only reliable identifier when eventId itself is bad. */\n index: z.number().int().nonnegative(),\n reason: zIngestRejectionReason,\n message: z.string().optional(),\n});\nexport type IngestRejection = z.infer<typeof zIngestRejection>;\n\nconst ingestCounts = {\n /** Raw events newly persisted by this request. */\n accepted: z.number().int().nonnegative(),\n /**\n * Events the server already had. In `server` mode this is exactly the\n * eventId-idempotency count; in `browser` mode it also includes the\n * 5-second click dedup.\n */\n duplicates: z.number().int().nonnegative(),\n /** Always `[]` in `browser` mode, where a bad row fails the whole batch. */\n rejected: z.array(zIngestRejection),\n};\n\n/**\n * The session ingest filed this batch under, with the token that lets the\n * browser (or a server acting for it) join the same session later with\n * authority — see `signSessionToken` in `./identity`. Browser mode only;\n * absent when the batch carried no sessionable event.\n */\nexport const zSessionCredential = z.object({\n id: z.string().regex(IDENTITY_ID_PATTERN),\n token: z.string().regex(/^[A-Za-z0-9_-]{43}$/),\n});\nexport type SessionCredential = z.infer<typeof zSessionCredential>;\n\n/** 200 — accepted and handed to the materialize queue. */\nexport const zIngestOkResponse = z.object({\n status: z.literal(\"ok\"),\n requestId: z.string(),\n mode: zIngestMode,\n ...ingestCounts,\n queued: z.boolean(),\n session: zSessionCredential.optional(),\n});\n\n/**\n * 202 — raw events landed, but enqueueing the materialize task failed. No data\n * is lost: the `replay-unmaterialized` cron picks these up. A forwarder should\n * treat this as success and advance its cursor. Carries the same counts as 200\n * so the reconciliation below works here too.\n */\nexport const zIngestAcceptedResponse = z.object({\n status: z.literal(\"accepted\"),\n requestId: z.string(),\n mode: zIngestMode,\n ...ingestCounts,\n backgroundQueued: z.literal(false),\n replay: z.literal(\"unmaterialized-raw-events\"),\n session: zSessionCredential.optional(),\n});\n\nexport const zIngestResponse = z.discriminatedUnion(\"status\", [zIngestOkResponse, zIngestAcceptedResponse]);\n\nexport type IngestOkResponse = z.infer<typeof zIngestOkResponse>;\nexport type IngestAcceptedResponse = z.infer<typeof zIngestAcceptedResponse>;\nexport type IngestResponse = z.infer<typeof zIngestResponse>;\n\n/**\n * The reconciliation a forwarder runs on every 2xx:\n *\n * accepted + duplicates + rejected.length === events sent\n *\n * A mismatch means the server silently dropped something, which is exactly the\n * failure mode this contract exists to make impossible to miss.\n */\nexport function reconcileIngestResponse(response: IngestResponse, sentCount: number): boolean {\n return response.accepted + response.duplicates + response.rejected.length === sentCount;\n}\n\n// ─── Errors ─────────────────────────────────────────────────────────────────\n\n/**\n * Stable machine-readable codes. Branch on these, never on `error`/`message`,\n * which are prose and may be reworded.\n */\nexport const INGEST_ERROR_CODES = [\n /** 401 — unknown or mismatched credentials. Stop and alert; do not retry. */\n \"unauthorized\",\n /** 400 — body was not valid JSON. */\n \"invalid_json\",\n /** 400 — request exceeded MAX_TRACK_PAYLOAD_BYTES. Split the batch. */\n \"payload_too_large\",\n /** 400 — zero events submitted. */\n \"empty_batch\",\n /** 400 — batch contained a `type: \"alias\"` event, which is not supported. */\n \"alias_unsupported\",\n /** 400 — the project has no organization; it cannot be billed or quota-checked. */\n \"project_without_organization\",\n /** 400 — `browser` mode only: a row failed validation. `server` mode reports these in `rejected[]`. */\n \"validation_failed\",\n /** 429 — per-project request rate limit. `Retry-After` set. Pause this tick, keep the cursor. */\n \"rate_limited\",\n /** 429 — the organization's monthly event quota is exhausted. `Retry-After` set (capped at 1h). Alert: a human must raise the limit. */\n \"quota_exceeded\",\n /** 410 — the project is being deleted. Permanent; stop sending. */\n \"project_purging\",\n /** 500 — unexpected server failure. Back off and retry. */\n \"internal_error\",\n] as const;\nexport const zIngestErrorCode = z.enum(INGEST_ERROR_CODES);\nexport type IngestErrorCode = z.infer<typeof zIngestErrorCode>;\n\nexport const zIngestError = z.object({\n status: z.number().int(),\n code: zIngestErrorCode,\n error: z.string(),\n message: z.string().optional(),\n /** zod issues, when `code === \"validation_failed\"`. */\n errors: z.unknown().optional(),\n requestId: z.string().optional(),\n});\nexport type IngestError = z.infer<typeof zIngestError>;\n"],"mappings":";;;;;;;;AAWA,SAAS,SAAS;AAgBX,IAAM,0BAA0B;AAEvC,IAAM,uBAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO3B,SAAS,EAAE,KAAK;AAAA;AAAA,EAEhB,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaxC,UAAU,EAAE,OAAO,EAAE,MAAM,qBAAqB,yBAAyB,EAAE,SAAS;AACtF;AAEO,IAAM,gBAAgB,EAC1B,OAAO;AAAA,EACN,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AAAA,EAC/B,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,EAAE,SAAS;AAAA,EACvD,WAAW,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,SAAS;AACzD,CAAC,EACA,OAAO,CAAC,SAAS,CAAC,qBAAqB,SAAS,KAAK,IAAa,GAAG;AAAA,EACpE,SAAS,mDAAmD,qBAAqB,KAAK,IAAI,CAAC;AAAA,EAC3F,MAAM,CAAC,MAAM;AACf,CAAC;AAEI,IAAM,mBAAmB,EAAE,OAAO;AAAA,EACvC,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC;AAAA,EACnD,WAAW,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,SAAS;AAAA,EACxC,UAAU,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,SAAS;AAAA,EACvC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,SAAS;AAAA,EACnC,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAI,EAAE,SAAS;AAAA,EACnC,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,EAAE,SAAS;AACzD,CAAC;AAEM,IAAM,oBAAoB,EAAE,OAAO;AAAA,EACxC,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC;AAAA,EACnD,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AAAA,EACnC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS;AACxC,CAAC;AAEM,IAAM,oBAAoB,EAAE,OAAO;AAAA,EACxC,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC;AAAA,EACnD,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AAAA,EACnC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS;AACxC,CAAC;AAEM,IAAM,uBAAuB,EAAE,mBAAmB,QAAQ;AAAA,EAC/D,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,OAAO,GAAG,SAAS,eAAe,GAAG,qBAAqB,CAAC;AAAA,EACtF,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,UAAU,GAAG,SAAS,kBAAkB,GAAG,qBAAqB,CAAC;AAAA,EAC5F,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,WAAW,GAAG,SAAS,mBAAmB,GAAG,qBAAqB,CAAC;AAAA,EAC9F,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,WAAW,GAAG,SAAS,mBAAmB,GAAG,qBAAqB,CAAC;AAChG,CAAC;AAqBM,IAAM,eAAe,CAAC,WAAW,QAAQ;AACzC,IAAM,cAAc,EAAE,KAAK,YAAY;AAUvC,IAAM,2BAA2B;AAAA;AAAA,EAEtC;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AACF;AACO,IAAM,yBAAyB,EAAE,KAAK,wBAAwB;AAG9D,IAAM,mBAAmB,EAAE,OAAO;AAAA;AAAA,EAEvC,SAAS,EAAE,OAAO;AAAA;AAAA,EAElB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA,EACpC,QAAQ;AAAA,EACR,SAAS,EAAE,OAAO,EAAE,SAAS;AAC/B,CAAC;AAGD,IAAM,eAAe;AAAA;AAAA,EAEnB,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvC,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA;AAAA,EAEzC,UAAU,EAAE,MAAM,gBAAgB;AACpC;AAQO,IAAM,qBAAqB,EAAE,OAAO;AAAA,EACzC,IAAI,EAAE,OAAO,EAAE,MAAM,mBAAmB;AAAA,EACxC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB;AAC/C,CAAC;AAIM,IAAM,oBAAoB,EAAE,OAAO;AAAA,EACxC,QAAQ,EAAE,QAAQ,IAAI;AAAA,EACtB,WAAW,EAAE,OAAO;AAAA,EACpB,MAAM;AAAA,EACN,GAAG;AAAA,EACH,QAAQ,EAAE,QAAQ;AAAA,EAClB,SAAS,mBAAmB,SAAS;AACvC,CAAC;AAQM,IAAM,0BAA0B,EAAE,OAAO;AAAA,EAC9C,QAAQ,EAAE,QAAQ,UAAU;AAAA,EAC5B,WAAW,EAAE,OAAO;AAAA,EACpB,MAAM;AAAA,EACN,GAAG;AAAA,EACH,kBAAkB,EAAE,QAAQ,KAAK;AAAA,EACjC,QAAQ,EAAE,QAAQ,2BAA2B;AAAA,EAC7C,SAAS,mBAAmB,SAAS;AACvC,CAAC;AAEM,IAAM,kBAAkB,EAAE,mBAAmB,UAAU,CAAC,mBAAmB,uBAAuB,CAAC;AAcnG,SAAS,wBAAwB,UAA0B,WAA4B;AAC5F,SAAO,SAAS,WAAW,SAAS,aAAa,SAAS,SAAS,WAAW;AAChF;AAQO,IAAM,qBAAqB;AAAA;AAAA,EAEhC;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AACF;AACO,IAAM,mBAAmB,EAAE,KAAK,kBAAkB;AAGlD,IAAM,eAAe,EAAE,OAAO;AAAA,EACnC,QAAQ,EAAE,OAAO,EAAE,IAAI;AAAA,EACvB,MAAM;AAAA,EACN,OAAO,EAAE,OAAO;AAAA,EAChB,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE7B,QAAQ,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC7B,WAAW,EAAE,OAAO,EAAE,SAAS;AACjC,CAAC;","names":[]}
|
package/dist/chunk-XDH5QQYF.cjs
DELETED
|
@@ -1,361 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
var _chunkORNTN6AKcjs = require('./chunk-ORNTN6AK.cjs');
|
|
5
|
-
|
|
6
|
-
// src/query.ts
|
|
7
|
-
var _zod = require('zod');
|
|
8
|
-
var zGranularity = _zod.z.enum(["hour", "day", "week", "month"]);
|
|
9
|
-
var zTimezone = _zod.z.string().min(1).max(64).refine(isValidTimeZone, { message: "unknown IANA time zone" });
|
|
10
|
-
function isValidTimeZone(value) {
|
|
11
|
-
try {
|
|
12
|
-
new Intl.DateTimeFormat("en-US", { timeZone: value });
|
|
13
|
-
return true;
|
|
14
|
-
} catch (e) {
|
|
15
|
-
return false;
|
|
16
|
-
}
|
|
17
|
-
}
|
|
18
|
-
var zChannelFilter = _zod.z.object({
|
|
19
|
-
referrerTypes: _zod.z.array(_zod.z.string()).optional(),
|
|
20
|
-
channelTypes: _zod.z.array(_zod.z.string()).optional(),
|
|
21
|
-
utmSources: _zod.z.array(_zod.z.string()).optional(),
|
|
22
|
-
utmMediums: _zod.z.array(_zod.z.string()).optional(),
|
|
23
|
-
utmCampaigns: _zod.z.array(_zod.z.string()).optional()
|
|
24
|
-
}).optional();
|
|
25
|
-
var zQuerySource = _zod.z.enum(["rollup", "raw", "mixed"]);
|
|
26
|
-
var zQueryMeta = _zod.z.object({
|
|
27
|
-
projectId: _zod.z.string(),
|
|
28
|
-
/** When the underlying computation actually ran. On a cache hit, when the cached value was computed. */
|
|
29
|
-
computedAt: _chunkORNTN6AKcjs.zInstant,
|
|
30
|
-
/** Age of the returned computation, in seconds. `0` on a cache miss. */
|
|
31
|
-
cacheAgeSeconds: _zod.z.number().int().nonnegative(),
|
|
32
|
-
/**
|
|
33
|
-
* How far behind live materialization was when the computation ran, in
|
|
34
|
-
* seconds. `0` means no live event is pending; `null` means measurement
|
|
35
|
-
* failed and must never be interpreted as fresh.
|
|
36
|
-
*
|
|
37
|
-
* Deliberately not `now - max(events.created_at)` — that conflates "the
|
|
38
|
-
* pipeline is behind" with "this project is quiet", and grows without bound
|
|
39
|
-
* on an idle project.
|
|
40
|
-
*/
|
|
41
|
-
ingestLagSeconds: _zod.z.number().int().nonnegative().nullable(),
|
|
42
|
-
/** Whether the freshness measurement itself succeeded. */
|
|
43
|
-
ingestLagStatus: _zod.z.enum(["known", "unknown"]),
|
|
44
|
-
/**
|
|
45
|
-
* Pending events older than the live replay window. Kept separate so an old
|
|
46
|
-
* permanently failing event neither pegs live lag nor disappears behind 0.
|
|
47
|
-
* `null` means the measurement failed.
|
|
48
|
-
*/
|
|
49
|
-
ingestDeadLetterCount: _zod.z.number().int().nonnegative().nullable(),
|
|
50
|
-
cached: _zod.z.boolean(),
|
|
51
|
-
/**
|
|
52
|
-
* The time zone actually used to place bucket and window boundaries — the
|
|
53
|
-
* resolved value, not the requested one. Read it rather than assuming the
|
|
54
|
-
* request was honoured: when no zone is given anywhere it is `"UTC"`, and
|
|
55
|
-
* that is exactly the case a consumer needs to notice.
|
|
56
|
-
*/
|
|
57
|
-
timezone: _zod.z.string(),
|
|
58
|
-
/**
|
|
59
|
-
* Where the numbers came from. `rollup`: pre-aggregated hourly tables;
|
|
60
|
-
* `raw`: a scan of the event/session tables; `mixed`: finished hours from
|
|
61
|
-
* the rollup, the hour still in progress from raw. Diagnostic — the values
|
|
62
|
-
* agree either way — but a consumer that expected `rollup` and sees `raw`
|
|
63
|
-
* has asked for a combination the rollups cannot serve.
|
|
64
|
-
*/
|
|
65
|
-
source: zQuerySource,
|
|
66
|
-
requestId: _zod.z.string()
|
|
67
|
-
});
|
|
68
|
-
function zQueryEnvelope(data) {
|
|
69
|
-
return _zod.z.object({ data, meta: zQueryMeta });
|
|
70
|
-
}
|
|
71
|
-
var zTimeseriesBreakdown = _zod.z.object({
|
|
72
|
-
kind: _zod.z.literal("property"),
|
|
73
|
-
key: _zod.z.string().min(1).max(200),
|
|
74
|
-
topN: _zod.z.number().int().min(1).max(100).default(5)
|
|
75
|
-
});
|
|
76
|
-
var zEventPropertyFilter = _zod.z.object({
|
|
77
|
-
key: _zod.z.string().min(1).max(200),
|
|
78
|
-
operator: _zod.z.literal("eq").default("eq"),
|
|
79
|
-
value: _zod.z.string().min(1).max(500)
|
|
80
|
-
});
|
|
81
|
-
var zEventsTimeseriesInput = _zod.z.object({
|
|
82
|
-
projectId: _zod.z.string().min(1),
|
|
83
|
-
startDate: _chunkORNTN6AKcjs.zDate,
|
|
84
|
-
endDate: _chunkORNTN6AKcjs.zDate,
|
|
85
|
-
granularity: zGranularity.default("day"),
|
|
86
|
-
/** Omit to count every event in the window. */
|
|
87
|
-
eventName: _zod.z.string().min(1).max(200).optional(),
|
|
88
|
-
/** Exact matches against top-level `properties` keys. Every item must match. */
|
|
89
|
-
propertyFilters: _zod.z.array(zEventPropertyFilter).max(10).optional(),
|
|
90
|
-
breakdown: zTimeseriesBreakdown.optional(),
|
|
91
|
-
/**
|
|
92
|
-
* Cannot be combined with `breakdown` — the backend's breakdown time series
|
|
93
|
-
* takes no segment. Sending both is refused with `unsupported_combination`
|
|
94
|
-
* rather than silently ignoring one of them.
|
|
95
|
-
*/
|
|
96
|
-
segmentId: _zod.z.string().min(1).optional(),
|
|
97
|
-
/** Omit to fall back to the project's configured zone, then to UTC. */
|
|
98
|
-
timezone: zTimezone.optional(),
|
|
99
|
-
/**
|
|
100
|
-
* Events whose catalogue status is `internal` (operational probes) are
|
|
101
|
-
* left out by default. A probe that needs to find its own event sets this.
|
|
102
|
-
*/
|
|
103
|
-
includeInternal: _zod.z.boolean().default(false)
|
|
104
|
-
}).refine((input) => input.startDate <= input.endDate, {
|
|
105
|
-
message: "endDate must be on or after startDate",
|
|
106
|
-
path: ["endDate"]
|
|
107
|
-
});
|
|
108
|
-
var zBucketStart = _zod.z.string().regex(/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/, "expected 'YYYY-MM-DD HH:MM:SS'");
|
|
109
|
-
var zTimeseriesPoint = _zod.z.object({
|
|
110
|
-
date: zBucketStart,
|
|
111
|
-
count: _zod.z.number().int().nonnegative()
|
|
112
|
-
});
|
|
113
|
-
var zEventsTimeseriesData = _zod.z.object({
|
|
114
|
-
granularity: zGranularity,
|
|
115
|
-
/** Zone the buckets were cut in. Mirrors `meta.timezone`. */
|
|
116
|
-
timezone: _zod.z.string(),
|
|
117
|
-
/** Total per bucket. Always present, with or without a breakdown. */
|
|
118
|
-
series: _zod.z.array(zTimeseriesPoint),
|
|
119
|
-
/** Present only when `breakdown` was requested: the top-N values, each with its own series. */
|
|
120
|
-
breakdown: _zod.z.array(
|
|
121
|
-
_zod.z.object({
|
|
122
|
-
value: _zod.z.string(),
|
|
123
|
-
points: _zod.z.array(zTimeseriesPoint)
|
|
124
|
-
})
|
|
125
|
-
).optional()
|
|
126
|
-
});
|
|
127
|
-
var zEventsTimeseriesResponse = zQueryEnvelope(zEventsTimeseriesData);
|
|
128
|
-
var zFunnelInput = _zod.z.object({
|
|
129
|
-
projectId: _zod.z.string().min(1),
|
|
130
|
-
/** Ordered event names. A user counts at step k if they reached at least step k. */
|
|
131
|
-
steps: _zod.z.array(_zod.z.string().min(1).max(200)).min(2).max(10),
|
|
132
|
-
startDate: _chunkORNTN6AKcjs.zDate,
|
|
133
|
-
endDate: _chunkORNTN6AKcjs.zDate,
|
|
134
|
-
/** Max seconds between the first and last step for a conversion to count. Default 24h. */
|
|
135
|
-
windowSeconds: _zod.z.number().int().min(60).max(2592e3).default(86400),
|
|
136
|
-
segmentId: _zod.z.string().min(1).optional(),
|
|
137
|
-
channelFilter: zChannelFilter,
|
|
138
|
-
/**
|
|
139
|
-
* Decides where `startDate` / `endDate` fall. A funnel has no buckets, so
|
|
140
|
-
* this only moves the window — but a nine-hour window shift changes who is
|
|
141
|
-
* in the funnel.
|
|
142
|
-
*/
|
|
143
|
-
timezone: zTimezone.optional(),
|
|
144
|
-
/** Accepted for symmetry with events.timeseries; funnel steps are named explicitly, so nothing is filtered. */
|
|
145
|
-
includeInternal: _zod.z.boolean().default(false)
|
|
146
|
-
}).refine((input) => input.startDate <= input.endDate, {
|
|
147
|
-
message: "endDate must be on or after startDate",
|
|
148
|
-
path: ["endDate"]
|
|
149
|
-
});
|
|
150
|
-
var zFunnelStep = _zod.z.object({
|
|
151
|
-
step: _zod.z.number().int().min(1),
|
|
152
|
-
name: _zod.z.string(),
|
|
153
|
-
users: _zod.z.number().int().nonnegative(),
|
|
154
|
-
/** Percent of the previous step that reached this one. `100` for step 1. */
|
|
155
|
-
conversionRate: _zod.z.number(),
|
|
156
|
-
/** Percent of the previous step that did not. `0` for step 1. */
|
|
157
|
-
dropoffRate: _zod.z.number(),
|
|
158
|
-
dropoffUsers: _zod.z.number().int().nonnegative()
|
|
159
|
-
});
|
|
160
|
-
var zFunnelData = _zod.z.object({
|
|
161
|
-
steps: _zod.z.array(zFunnelStep),
|
|
162
|
-
totalUsers: _zod.z.number().int().nonnegative(),
|
|
163
|
-
/** Percent of step-1 users that reached the last step. */
|
|
164
|
-
overallConversionRate: _zod.z.number()
|
|
165
|
-
});
|
|
166
|
-
var zFunnelResponse = zQueryEnvelope(zFunnelData);
|
|
167
|
-
var zRetentionInterval = _zod.z.enum(["day", "week", "month"]);
|
|
168
|
-
var zRetentionInput = _zod.z.object({
|
|
169
|
-
projectId: _zod.z.string().min(1),
|
|
170
|
-
startDate: _chunkORNTN6AKcjs.zDate,
|
|
171
|
-
endDate: _chunkORNTN6AKcjs.zDate,
|
|
172
|
-
interval: zRetentionInterval.default("day"),
|
|
173
|
-
periods: _zod.z.number().int().min(1).max(30).default(7),
|
|
174
|
-
startEvent: _zod.z.string().min(1).max(200).optional(),
|
|
175
|
-
returnEvent: _zod.z.string().min(1).max(200).optional(),
|
|
176
|
-
/** `bounded`: returned in exactly period N. `unbounded`: returned in period N or later. */
|
|
177
|
-
retentionType: _zod.z.enum(["bounded", "unbounded"]).default("bounded"),
|
|
178
|
-
/**
|
|
179
|
-
* `first-ever` (default): the cohort is everyone whose true first activity
|
|
180
|
-
* landed in the window, read from the first-seen aggregate. `startEvent`,
|
|
181
|
-
* `segmentId` and `channelFilter` then constrain only the *returning* side.
|
|
182
|
-
* `first-in-window`: the cohort is selected by scanning events in the window
|
|
183
|
-
* with all filters applied. Slower, but filters apply to cohort selection.
|
|
184
|
-
*/
|
|
185
|
-
cohortMode: _zod.z.enum(["first-ever", "first-in-window"]).default("first-ever"),
|
|
186
|
-
segmentId: _zod.z.string().min(1).optional(),
|
|
187
|
-
channelFilter: zChannelFilter,
|
|
188
|
-
/**
|
|
189
|
-
* Decides where a cohort day starts, and so which period a return falls in.
|
|
190
|
-
*
|
|
191
|
-
* Honoured under both cohort modes. Note that a non-UTC zone makes
|
|
192
|
-
* `first-ever` read raw events instead of its daily rollup — the rollup is
|
|
193
|
-
* cut on UTC days and cannot be re-cut after the fact — so expect a slower
|
|
194
|
-
* query in exchange for cohorts that match the reader's calendar.
|
|
195
|
-
*/
|
|
196
|
-
timezone: zTimezone.optional(),
|
|
197
|
-
/** Accepted for symmetry with events.timeseries; retention reads named or all-event activity and does not yet apply the internal filter. */
|
|
198
|
-
includeInternal: _zod.z.boolean().default(false)
|
|
199
|
-
}).refine((input) => input.startDate <= input.endDate, {
|
|
200
|
-
message: "endDate must be on or after startDate",
|
|
201
|
-
path: ["endDate"]
|
|
202
|
-
});
|
|
203
|
-
var zRetentionCell = _zod.z.object({
|
|
204
|
-
/** `0` is the cohort's own period. */
|
|
205
|
-
period: _zod.z.number().int().nonnegative(),
|
|
206
|
-
users: _zod.z.number().int().nonnegative(),
|
|
207
|
-
/** Percent of `cohortSize`. */
|
|
208
|
-
rate: _zod.z.number()
|
|
209
|
-
});
|
|
210
|
-
var zRetentionData = _zod.z.object({
|
|
211
|
-
matrix: _zod.z.array(
|
|
212
|
-
_zod.z.object({
|
|
213
|
-
/** Cohort bucket start, same shape and zone as {@link zBucketStart}. */
|
|
214
|
-
cohortDate: zBucketStart,
|
|
215
|
-
cohortSize: _zod.z.number().int().nonnegative(),
|
|
216
|
-
/** Length is `periods + 1`, index-aligned to `period`. */
|
|
217
|
-
retention: _zod.z.array(zRetentionCell)
|
|
218
|
-
})
|
|
219
|
-
),
|
|
220
|
-
/** Unweighted mean rate per period across cohorts. */
|
|
221
|
-
averageRetention: _zod.z.array(_zod.z.object({ period: _zod.z.number().int().nonnegative(), rate: _zod.z.number() })),
|
|
222
|
-
interval: zRetentionInterval,
|
|
223
|
-
periods: _zod.z.number().int(),
|
|
224
|
-
retentionType: _zod.z.enum(["bounded", "unbounded"]),
|
|
225
|
-
/** Zone the cohort days were cut in. Mirrors `meta.timezone`. */
|
|
226
|
-
timezone: _zod.z.string()
|
|
227
|
-
});
|
|
228
|
-
var zRetentionResponse = zQueryEnvelope(zRetentionData);
|
|
229
|
-
var zTrafficOverviewInput = _zod.z.object({
|
|
230
|
-
projectId: _zod.z.string().min(1),
|
|
231
|
-
startDate: _chunkORNTN6AKcjs.zDate,
|
|
232
|
-
endDate: _chunkORNTN6AKcjs.zDate,
|
|
233
|
-
granularity: zGranularity.default("day"),
|
|
234
|
-
timezone: zTimezone.optional()
|
|
235
|
-
}).refine((input) => input.startDate <= input.endDate, {
|
|
236
|
-
message: "endDate must be on or after startDate",
|
|
237
|
-
path: ["endDate"]
|
|
238
|
-
});
|
|
239
|
-
var zTrafficTotals = _zod.z.object({
|
|
240
|
-
sessions: _zod.z.number().int().nonnegative(),
|
|
241
|
-
pageviews: _zod.z.number().int().nonnegative(),
|
|
242
|
-
newVisitors: _zod.z.number().int().nonnegative(),
|
|
243
|
-
returningVisitors: _zod.z.number().int().nonnegative(),
|
|
244
|
-
/** Percent of sessions that bounced, two decimals. */
|
|
245
|
-
bounceRate: _zod.z.number()
|
|
246
|
-
});
|
|
247
|
-
var zTrafficSeriesPoint = zTrafficTotals.extend({ date: zBucketStart });
|
|
248
|
-
var zTrafficOverviewData = _zod.z.object({
|
|
249
|
-
granularity: zGranularity,
|
|
250
|
-
timezone: _zod.z.string(),
|
|
251
|
-
totals: zTrafficTotals,
|
|
252
|
-
series: _zod.z.array(zTrafficSeriesPoint)
|
|
253
|
-
});
|
|
254
|
-
var zTrafficOverviewResponse = zQueryEnvelope(zTrafficOverviewData);
|
|
255
|
-
var zTrafficDimension = _zod.z.enum(["channel", "referrer", "utm"]);
|
|
256
|
-
var zTrafficSourcesInput = _zod.z.object({
|
|
257
|
-
projectId: _zod.z.string().min(1),
|
|
258
|
-
startDate: _chunkORNTN6AKcjs.zDate,
|
|
259
|
-
endDate: _chunkORNTN6AKcjs.zDate,
|
|
260
|
-
/** `channel`: channel_type · `referrer`: referrer name+type · `utm`: source/medium/campaign. */
|
|
261
|
-
dimension: zTrafficDimension,
|
|
262
|
-
limit: _zod.z.number().int().min(1).max(100).default(10),
|
|
263
|
-
timezone: zTimezone.optional()
|
|
264
|
-
}).refine((input) => input.startDate <= input.endDate, {
|
|
265
|
-
message: "endDate must be on or after startDate",
|
|
266
|
-
path: ["endDate"]
|
|
267
|
-
});
|
|
268
|
-
var zTrafficSourceRow = zTrafficTotals.extend({
|
|
269
|
-
/** Display key for the row: the channel, the referrer name, or `source / medium / campaign`. */
|
|
270
|
-
key: _zod.z.string(),
|
|
271
|
-
channelType: _zod.z.string().optional(),
|
|
272
|
-
referrerName: _zod.z.string().optional(),
|
|
273
|
-
referrerType: _zod.z.string().optional(),
|
|
274
|
-
utmSource: _zod.z.string().optional(),
|
|
275
|
-
utmMedium: _zod.z.string().optional(),
|
|
276
|
-
utmCampaign: _zod.z.string().optional()
|
|
277
|
-
});
|
|
278
|
-
var zTrafficSourcesData = _zod.z.object({
|
|
279
|
-
dimension: zTrafficDimension,
|
|
280
|
-
timezone: _zod.z.string(),
|
|
281
|
-
/** Ordered by sessions, descending. */
|
|
282
|
-
rows: _zod.z.array(zTrafficSourceRow)
|
|
283
|
-
});
|
|
284
|
-
var zTrafficSourcesResponse = zQueryEnvelope(zTrafficSourcesData);
|
|
285
|
-
var QUERY_ERROR_CODES = [
|
|
286
|
-
/** 401 — unknown or mismatched credentials. */
|
|
287
|
-
"unauthorized",
|
|
288
|
-
/** 403 — the credential's project is not the project asked about. */
|
|
289
|
-
"project_scope_mismatch",
|
|
290
|
-
/** 403 — the credential lacks the `query` scope. Provision a query-scoped client. */
|
|
291
|
-
"query_scope_missing",
|
|
292
|
-
/** 400 — input failed the schema. `errors` carries the zod issues. */
|
|
293
|
-
"validation_failed",
|
|
294
|
-
/** 400 — inputs are individually valid but cannot be served together (e.g. breakdown + segmentId). */
|
|
295
|
-
"unsupported_combination",
|
|
296
|
-
/** 410 — the project is being deleted. Permanent; stop asking. */
|
|
297
|
-
"project_purging",
|
|
298
|
-
/** 429 — per-credential query rate limit. `Retry-After` set. */
|
|
299
|
-
"rate_limited",
|
|
300
|
-
/** 504 — the analytics backend exceeded its statement timeout. Narrow the window. */
|
|
301
|
-
"query_timeout",
|
|
302
|
-
/** 500 — unexpected server failure. */
|
|
303
|
-
"internal_error"
|
|
304
|
-
];
|
|
305
|
-
var zQueryErrorCode = _zod.z.enum(QUERY_ERROR_CODES);
|
|
306
|
-
var zQueryError = _zod.z.object({
|
|
307
|
-
status: _zod.z.number().int(),
|
|
308
|
-
code: zQueryErrorCode,
|
|
309
|
-
error: _zod.z.string(),
|
|
310
|
-
message: _zod.z.string().optional(),
|
|
311
|
-
errors: _zod.z.unknown().optional(),
|
|
312
|
-
requestId: _zod.z.string().optional()
|
|
313
|
-
});
|
|
314
|
-
var QUERY_API_PATHS = {
|
|
315
|
-
eventsTimeseries: "/api/v1/query/events/timeseries",
|
|
316
|
-
funnel: "/api/v1/query/funnel",
|
|
317
|
-
retention: "/api/v1/query/retention",
|
|
318
|
-
trafficOverview: "/api/v1/query/traffic/overview",
|
|
319
|
-
trafficSources: "/api/v1/query/traffic/sources"
|
|
320
|
-
};
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
exports.zGranularity = zGranularity; exports.zTimezone = zTimezone; exports.isValidTimeZone = isValidTimeZone; exports.zChannelFilter = zChannelFilter; exports.zQuerySource = zQuerySource; exports.zQueryMeta = zQueryMeta; exports.zQueryEnvelope = zQueryEnvelope; exports.zTimeseriesBreakdown = zTimeseriesBreakdown; exports.zEventPropertyFilter = zEventPropertyFilter; exports.zEventsTimeseriesInput = zEventsTimeseriesInput; exports.zBucketStart = zBucketStart; exports.zTimeseriesPoint = zTimeseriesPoint; exports.zEventsTimeseriesData = zEventsTimeseriesData; exports.zEventsTimeseriesResponse = zEventsTimeseriesResponse; exports.zFunnelInput = zFunnelInput; exports.zFunnelStep = zFunnelStep; exports.zFunnelData = zFunnelData; exports.zFunnelResponse = zFunnelResponse; exports.zRetentionInterval = zRetentionInterval; exports.zRetentionInput = zRetentionInput; exports.zRetentionCell = zRetentionCell; exports.zRetentionData = zRetentionData; exports.zRetentionResponse = zRetentionResponse; exports.zTrafficOverviewInput = zTrafficOverviewInput; exports.zTrafficTotals = zTrafficTotals; exports.zTrafficSeriesPoint = zTrafficSeriesPoint; exports.zTrafficOverviewData = zTrafficOverviewData; exports.zTrafficOverviewResponse = zTrafficOverviewResponse; exports.zTrafficDimension = zTrafficDimension; exports.zTrafficSourcesInput = zTrafficSourcesInput; exports.zTrafficSourceRow = zTrafficSourceRow; exports.zTrafficSourcesData = zTrafficSourcesData; exports.zTrafficSourcesResponse = zTrafficSourcesResponse; exports.QUERY_ERROR_CODES = QUERY_ERROR_CODES; exports.zQueryErrorCode = zQueryErrorCode; exports.zQueryError = zQueryError; exports.QUERY_API_PATHS = QUERY_API_PATHS;
|
|
361
|
-
//# sourceMappingURL=chunk-XDH5QQYF.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["/Users/eric/reopt-ai/reopt-data/packages/data-contract/dist/chunk-XDH5QQYF.cjs","../src/query.ts"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,wDAA6B;AAC7B;AACA;ACOA,0BAAkB;AAMX,IAAM,aAAA,EAAe,MAAA,CAAE,IAAA,CAAK,CAAC,MAAA,EAAQ,KAAA,EAAO,MAAA,EAAQ,OAAO,CAAC,CAAA;AAc5D,IAAM,UAAA,EAAY,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,EAAE,CAAA,CAAE,MAAA,CAAO,eAAA,EAAiB,EAAE,OAAA,EAAS,yBAAyB,CAAC,CAAA;AAEzG,SAAS,eAAA,CAAgB,KAAA,EAAwB;AACtD,EAAA,IAAI;AACF,IAAA,IAAI,IAAA,CAAK,cAAA,CAAe,OAAA,EAAS,EAAE,QAAA,EAAU,MAAM,CAAC,CAAA;AACpD,IAAA,OAAO,IAAA;AAAA,EACT,EAAA,UAAQ;AACN,IAAA,OAAO,KAAA;AAAA,EACT;AACF;AAOO,IAAM,eAAA,EAAiB,MAAA,CAC3B,MAAA,CAAO;AAAA,EACN,aAAA,EAAe,MAAA,CAAE,KAAA,CAAM,MAAA,CAAE,MAAA,CAAO,CAAC,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAC5C,YAAA,EAAc,MAAA,CAAE,KAAA,CAAM,MAAA,CAAE,MAAA,CAAO,CAAC,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAC3C,UAAA,EAAY,MAAA,CAAE,KAAA,CAAM,MAAA,CAAE,MAAA,CAAO,CAAC,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EACzC,UAAA,EAAY,MAAA,CAAE,KAAA,CAAM,MAAA,CAAE,MAAA,CAAO,CAAC,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EACzC,YAAA,EAAc,MAAA,CAAE,KAAA,CAAM,MAAA,CAAE,MAAA,CAAO,CAAC,CAAA,CAAE,QAAA,CAAS;AAC7C,CAAC,CAAA,CACA,QAAA,CAAS,CAAA;AAWL,IAAM,aAAA,EAAe,MAAA,CAAE,IAAA,CAAK,CAAC,QAAA,EAAU,KAAA,EAAO,OAAO,CAAC,CAAA;AAGtD,IAAM,WAAA,EAAa,MAAA,CAAE,MAAA,CAAO;AAAA,EACjC,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA;AAAA,EAEpB,UAAA,EAAY,0BAAA;AAAA;AAAA,EAEZ,eAAA,EAAiB,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAU9C,gBAAA,EAAkB,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA;AAAA,EAE1D,eAAA,EAAiB,MAAA,CAAE,IAAA,CAAK,CAAC,OAAA,EAAS,SAAS,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM5C,qBAAA,EAAuB,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAC/D,MAAA,EAAQ,MAAA,CAAE,OAAA,CAAQ,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOlB,QAAA,EAAU,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,MAAA,EAAQ,YAAA;AAAA,EACR,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO;AACtB,CAAC,CAAA;AAIM,SAAS,cAAA,CAAuC,IAAA,EAAS;AAC9D,EAAA,OAAO,MAAA,CAAE,MAAA,CAAO,EAAE,IAAA,EAAM,IAAA,EAAM,WAAW,CAAC,CAAA;AAC5C;AASO,IAAM,qBAAA,EAAuB,MAAA,CAAE,MAAA,CAAO;AAAA,EAC3C,IAAA,EAAM,MAAA,CAAE,OAAA,CAAQ,UAAU,CAAA;AAAA,EAC1B,GAAA,EAAK,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA;AAAA,EAC9B,IAAA,EAAM,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,OAAA,CAAQ,CAAC;AAClD,CAAC,CAAA;AAIM,IAAM,qBAAA,EAAuB,MAAA,CAAE,MAAA,CAAO;AAAA,EAC3C,GAAA,EAAK,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA;AAAA,EAC9B,QAAA,EAAU,MAAA,CAAE,OAAA,CAAQ,IAAI,CAAA,CAAE,OAAA,CAAQ,IAAI,CAAA;AAAA,EACtC,KAAA,EAAO,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG;AAClC,CAAC,CAAA;AAGM,IAAM,uBAAA,EAAyB,MAAA,CACnC,MAAA,CAAO;AAAA,EACN,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA;AAAA,EAC3B,SAAA,EAAW,uBAAA;AAAA,EACX,OAAA,EAAS,uBAAA;AAAA,EACT,WAAA,EAAa,YAAA,CAAa,OAAA,CAAQ,KAAK,CAAA;AAAA;AAAA,EAEvC,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA;AAAA,EAE/C,eAAA,EAAiB,MAAA,CAAE,KAAA,CAAM,oBAAoB,CAAA,CAAE,GAAA,CAAI,EAAE,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAChE,SAAA,EAAW,oBAAA,CAAqB,QAAA,CAAS,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzC,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA;AAAA,EAEtC,QAAA,EAAU,SAAA,CAAU,QAAA,CAAS,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAK7B,eAAA,EAAiB,MAAA,CAAE,OAAA,CAAQ,CAAA,CAAE,OAAA,CAAQ,KAAK;AAC5C,CAAC,CAAA,CACA,MAAA,CAAO,CAAC,KAAA,EAAA,GAAU,KAAA,CAAM,UAAA,GAAa,KAAA,CAAM,OAAA,EAAS;AAAA,EACnD,OAAA,EAAS,uCAAA;AAAA,EACT,IAAA,EAAM,CAAC,SAAS;AAClB,CAAC,CAAA;AAgBI,IAAM,aAAA,EAAe,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,KAAA,CAAM,uCAAA,EAAyC,gCAAgC,CAAA;AAE/G,IAAM,iBAAA,EAAmB,MAAA,CAAE,MAAA,CAAO;AAAA,EACvC,IAAA,EAAM,YAAA;AAAA,EACN,KAAA,EAAO,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY;AACtC,CAAC,CAAA;AAGM,IAAM,sBAAA,EAAwB,MAAA,CAAE,MAAA,CAAO;AAAA,EAC5C,WAAA,EAAa,YAAA;AAAA;AAAA,EAEb,QAAA,EAAU,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA;AAAA,EAEnB,MAAA,EAAQ,MAAA,CAAE,KAAA,CAAM,gBAAgB,CAAA;AAAA;AAAA,EAEhC,SAAA,EAAW,MAAA,CACR,KAAA;AAAA,IACC,MAAA,CAAE,MAAA,CAAO;AAAA,MACP,KAAA,EAAO,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA,MAChB,MAAA,EAAQ,MAAA,CAAE,KAAA,CAAM,gBAAgB;AAAA,IAClC,CAAC;AAAA,EACH,CAAA,CACC,QAAA,CAAS;AACd,CAAC,CAAA;AAGM,IAAM,0BAAA,EAA4B,cAAA,CAAe,qBAAqB,CAAA;AAKtE,IAAM,aAAA,EAAe,MAAA,CACzB,MAAA,CAAO;AAAA,EACN,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA;AAAA;AAAA,EAE3B,KAAA,EAAO,MAAA,CAAE,KAAA,CAAM,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAC,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,EAAE,CAAA;AAAA,EACxD,SAAA,EAAW,uBAAA;AAAA,EACX,OAAA,EAAS,uBAAA;AAAA;AAAA,EAET,aAAA,EAAe,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,GAAA,CAAI,EAAE,CAAA,CAAE,GAAA,CAAI,MAAS,CAAA,CAAE,OAAA,CAAQ,KAAM,CAAA;AAAA,EACrE,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EACtC,aAAA,EAAe,cAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMf,QAAA,EAAU,SAAA,CAAU,QAAA,CAAS,CAAA;AAAA;AAAA,EAE7B,eAAA,EAAiB,MAAA,CAAE,OAAA,CAAQ,CAAA,CAAE,OAAA,CAAQ,KAAK;AAC5C,CAAC,CAAA,CACA,MAAA,CAAO,CAAC,KAAA,EAAA,GAAU,KAAA,CAAM,UAAA,GAAa,KAAA,CAAM,OAAA,EAAS;AAAA,EACnD,OAAA,EAAS,uCAAA;AAAA,EACT,IAAA,EAAM,CAAC,SAAS;AAClB,CAAC,CAAA;AAGI,IAAM,YAAA,EAAc,MAAA,CAAE,MAAA,CAAO;AAAA,EAClC,IAAA,EAAM,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA;AAAA,EAC5B,IAAA,EAAM,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA,EACf,KAAA,EAAO,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA;AAAA,EAEpC,cAAA,EAAgB,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA;AAAA,EAEzB,WAAA,EAAa,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA,EACtB,YAAA,EAAc,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY;AAC7C,CAAC,CAAA;AAEM,IAAM,YAAA,EAAc,MAAA,CAAE,MAAA,CAAO;AAAA,EAClC,KAAA,EAAO,MAAA,CAAE,KAAA,CAAM,WAAW,CAAA;AAAA,EAC1B,UAAA,EAAY,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA;AAAA,EAEzC,qBAAA,EAAuB,MAAA,CAAE,MAAA,CAAO;AAClC,CAAC,CAAA;AAGM,IAAM,gBAAA,EAAkB,cAAA,CAAe,WAAW,CAAA;AAKlD,IAAM,mBAAA,EAAqB,MAAA,CAAE,IAAA,CAAK,CAAC,KAAA,EAAO,MAAA,EAAQ,OAAO,CAAC,CAAA;AAE1D,IAAM,gBAAA,EAAkB,MAAA,CAC5B,MAAA,CAAO;AAAA,EACN,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA;AAAA,EAC3B,SAAA,EAAW,uBAAA;AAAA,EACX,OAAA,EAAS,uBAAA;AAAA,EACT,QAAA,EAAU,kBAAA,CAAmB,OAAA,CAAQ,KAAK,CAAA;AAAA,EAC1C,OAAA,EAAS,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,EAAE,CAAA,CAAE,OAAA,CAAQ,CAAC,CAAA;AAAA,EAClD,UAAA,EAAY,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAChD,WAAA,EAAa,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA;AAAA,EAEjD,aAAA,EAAe,MAAA,CAAE,IAAA,CAAK,CAAC,SAAA,EAAW,WAAW,CAAC,CAAA,CAAE,OAAA,CAAQ,SAAS,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjE,UAAA,EAAY,MAAA,CAAE,IAAA,CAAK,CAAC,YAAA,EAAc,iBAAiB,CAAC,CAAA,CAAE,OAAA,CAAQ,YAAY,CAAA;AAAA,EAC1E,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EACtC,aAAA,EAAe,cAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASf,QAAA,EAAU,SAAA,CAAU,QAAA,CAAS,CAAA;AAAA;AAAA,EAE7B,eAAA,EAAiB,MAAA,CAAE,OAAA,CAAQ,CAAA,CAAE,OAAA,CAAQ,KAAK;AAC5C,CAAC,CAAA,CACA,MAAA,CAAO,CAAC,KAAA,EAAA,GAAU,KAAA,CAAM,UAAA,GAAa,KAAA,CAAM,OAAA,EAAS;AAAA,EACnD,OAAA,EAAS,uCAAA;AAAA,EACT,IAAA,EAAM,CAAC,SAAS;AAClB,CAAC,CAAA;AAGI,IAAM,eAAA,EAAiB,MAAA,CAAE,MAAA,CAAO;AAAA;AAAA,EAErC,MAAA,EAAQ,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA,EACrC,KAAA,EAAO,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA;AAAA,EAEpC,IAAA,EAAM,MAAA,CAAE,MAAA,CAAO;AACjB,CAAC,CAAA;AAEM,IAAM,eAAA,EAAiB,MAAA,CAAE,MAAA,CAAO;AAAA,EACrC,MAAA,EAAQ,MAAA,CAAE,KAAA;AAAA,IACR,MAAA,CAAE,MAAA,CAAO;AAAA;AAAA,MAEP,UAAA,EAAY,YAAA;AAAA,MACZ,UAAA,EAAY,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA;AAAA,MAEzC,SAAA,EAAW,MAAA,CAAE,KAAA,CAAM,cAAc;AAAA,IACnC,CAAC;AAAA,EACH,CAAA;AAAA;AAAA,EAEA,gBAAA,EAAkB,MAAA,CAAE,KAAA,CAAM,MAAA,CAAE,MAAA,CAAO,EAAE,MAAA,EAAQ,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA,EAAG,IAAA,EAAM,MAAA,CAAE,MAAA,CAAO,EAAE,CAAC,CAAC,CAAA;AAAA,EAChG,QAAA,EAAU,kBAAA;AAAA,EACV,OAAA,EAAS,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA;AAAA,EACxB,aAAA,EAAe,MAAA,CAAE,IAAA,CAAK,CAAC,SAAA,EAAW,WAAW,CAAC,CAAA;AAAA;AAAA,EAE9C,QAAA,EAAU,MAAA,CAAE,MAAA,CAAO;AACrB,CAAC,CAAA;AAGM,IAAM,mBAAA,EAAqB,cAAA,CAAe,cAAc,CAAA;AAWxD,IAAM,sBAAA,EAAwB,MAAA,CAClC,MAAA,CAAO;AAAA,EACN,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA;AAAA,EAC3B,SAAA,EAAW,uBAAA;AAAA,EACX,OAAA,EAAS,uBAAA;AAAA,EACT,WAAA,EAAa,YAAA,CAAa,OAAA,CAAQ,KAAK,CAAA;AAAA,EACvC,QAAA,EAAU,SAAA,CAAU,QAAA,CAAS;AAC/B,CAAC,CAAA,CACA,MAAA,CAAO,CAAC,KAAA,EAAA,GAAU,KAAA,CAAM,UAAA,GAAa,KAAA,CAAM,OAAA,EAAS;AAAA,EACnD,OAAA,EAAS,uCAAA;AAAA,EACT,IAAA,EAAM,CAAC,SAAS;AAClB,CAAC,CAAA;AAGI,IAAM,eAAA,EAAiB,MAAA,CAAE,MAAA,CAAO;AAAA,EACrC,QAAA,EAAU,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA,EACvC,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA,EACxC,WAAA,EAAa,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA,EAC1C,iBAAA,EAAmB,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA;AAAA,EAEhD,UAAA,EAAY,MAAA,CAAE,MAAA,CAAO;AACvB,CAAC,CAAA;AAGM,IAAM,oBAAA,EAAsB,cAAA,CAAe,MAAA,CAAO,EAAE,IAAA,EAAM,aAAa,CAAC,CAAA;AAExE,IAAM,qBAAA,EAAuB,MAAA,CAAE,MAAA,CAAO;AAAA,EAC3C,WAAA,EAAa,YAAA;AAAA,EACb,QAAA,EAAU,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA,EACnB,MAAA,EAAQ,cAAA;AAAA,EACR,MAAA,EAAQ,MAAA,CAAE,KAAA,CAAM,mBAAmB;AACrC,CAAC,CAAA;AAEM,IAAM,yBAAA,EAA2B,cAAA,CAAe,oBAAoB,CAAA;AAGpE,IAAM,kBAAA,EAAoB,MAAA,CAAE,IAAA,CAAK,CAAC,SAAA,EAAW,UAAA,EAAY,KAAK,CAAC,CAAA;AAG/D,IAAM,qBAAA,EAAuB,MAAA,CACjC,MAAA,CAAO;AAAA,EACN,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA;AAAA,EAC3B,SAAA,EAAW,uBAAA;AAAA,EACX,OAAA,EAAS,uBAAA;AAAA;AAAA,EAET,SAAA,EAAW,iBAAA;AAAA,EACX,KAAA,EAAO,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,OAAA,CAAQ,EAAE,CAAA;AAAA,EAClD,QAAA,EAAU,SAAA,CAAU,QAAA,CAAS;AAC/B,CAAC,CAAA,CACA,MAAA,CAAO,CAAC,KAAA,EAAA,GAAU,KAAA,CAAM,UAAA,GAAa,KAAA,CAAM,OAAA,EAAS;AAAA,EACnD,OAAA,EAAS,uCAAA;AAAA,EACT,IAAA,EAAM,CAAC,SAAS;AAClB,CAAC,CAAA;AAGI,IAAM,kBAAA,EAAoB,cAAA,CAAe,MAAA,CAAO;AAAA;AAAA,EAErD,GAAA,EAAK,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA,EACd,WAAA,EAAa,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EACjC,YAAA,EAAc,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAClC,YAAA,EAAc,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAClC,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAC/B,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAC/B,WAAA,EAAa,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,QAAA,CAAS;AACnC,CAAC,CAAA;AAGM,IAAM,oBAAA,EAAsB,MAAA,CAAE,MAAA,CAAO;AAAA,EAC1C,SAAA,EAAW,iBAAA;AAAA,EACX,QAAA,EAAU,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA;AAAA,EAEnB,IAAA,EAAM,MAAA,CAAE,KAAA,CAAM,iBAAiB;AACjC,CAAC,CAAA;AAEM,IAAM,wBAAA,EAA0B,cAAA,CAAe,mBAAmB,CAAA;AAKlE,IAAM,kBAAA,EAAoB;AAAA;AAAA,EAE/B,cAAA;AAAA;AAAA,EAEA,wBAAA;AAAA;AAAA,EAEA,qBAAA;AAAA;AAAA,EAEA,mBAAA;AAAA;AAAA,EAEA,yBAAA;AAAA;AAAA,EAEA,iBAAA;AAAA;AAAA,EAEA,cAAA;AAAA;AAAA,EAEA,eAAA;AAAA;AAAA,EAEA;AACF,CAAA;AACO,IAAM,gBAAA,EAAkB,MAAA,CAAE,IAAA,CAAK,iBAAiB,CAAA;AAGhD,IAAM,YAAA,EAAc,MAAA,CAAE,MAAA,CAAO;AAAA,EAClC,MAAA,EAAQ,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,GAAA,CAAI,CAAA;AAAA,EACvB,IAAA,EAAM,eAAA;AAAA,EACN,KAAA,EAAO,MAAA,CAAE,MAAA,CAAO,CAAA;AAAA,EAChB,OAAA,EAAS,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAC7B,MAAA,EAAQ,MAAA,CAAE,OAAA,CAAQ,CAAA,CAAE,QAAA,CAAS,CAAA;AAAA,EAC7B,SAAA,EAAW,MAAA,CAAE,MAAA,CAAO,CAAA,CAAE,QAAA,CAAS;AACjC,CAAC,CAAA;AAIM,IAAM,gBAAA,EAAkB;AAAA,EAC7B,gBAAA,EAAkB,iCAAA;AAAA,EAClB,MAAA,EAAQ,sBAAA;AAAA,EACR,SAAA,EAAW,yBAAA;AAAA,EACX,eAAA,EAAiB,gCAAA;AAAA,EACjB,cAAA,EAAgB;AAClB,CAAA;ADjJA;AACA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,opDAAC","file":"/Users/eric/reopt-ai/reopt-data/packages/data-contract/dist/chunk-XDH5QQYF.cjs","sourcesContent":[null,"/**\n * `POST /api/v1/query/*` — the read contract.\n *\n * Server credentials, project-scoped: the authenticated client's projectId must\n * equal the `projectId` in the body, or the request is refused. Reads are POSTs\n * because the inputs nest (funnel steps, channel filters) and would not survive\n * a query string; consumers cache on their own side, so HTTP cache semantics\n * buy nothing here.\n *\n * Response shapes mirror the existing dashboard computations exactly — this\n * plane re-exposes them, it does not add new math.\n */\nimport { z } from \"zod\";\nimport { zDate, zInstant } from \"./index.js\";\n\nexport { zDate, zInstant };\n\n/** Bucket width for a time series. */\nexport const zGranularity = z.enum([\"hour\", \"day\", \"week\", \"month\"]);\nexport type Granularity = z.infer<typeof zGranularity>;\n\n/**\n * IANA time zone name, e.g. `Asia/Seoul`. Decides two things at once: where a\n * calendar day starts, and therefore which bucket an event falls in.\n *\n * A Korean brand reading \"23 Aug: 120 visits\" means 23 Aug in Seoul. Computed\n * in UTC, that headline silently covers 23 Aug 09:00 through 24 Aug 09:00 —\n * wrong by nine hours in a way nothing on the page reveals.\n *\n * Validated against the runtime's own zone database rather than a regex, so an\n * unknown name fails here with a clear message instead of deep inside a query.\n */\nexport const zTimezone = z.string().min(1).max(64).refine(isValidTimeZone, { message: \"unknown IANA time zone\" });\n\nexport function isValidTimeZone(value: string): boolean {\n try {\n new Intl.DateTimeFormat(\"en-US\", { timeZone: value });\n return true;\n } catch {\n return false;\n }\n}\n\n/**\n * Acquisition-channel filter. Every field is a set — an event matches when its\n * value is in the set; omitted fields do not constrain. Mirrors the dashboard's\n * `channelFilterSchema` field-for-field.\n */\nexport const zChannelFilter = z\n .object({\n referrerTypes: z.array(z.string()).optional(),\n channelTypes: z.array(z.string()).optional(),\n utmSources: z.array(z.string()).optional(),\n utmMediums: z.array(z.string()).optional(),\n utmCampaigns: z.array(z.string()).optional(),\n })\n .optional();\nexport type ChannelFilter = z.infer<typeof zChannelFilter>;\n\n// ─── Envelope ───────────────────────────────────────────────────────────────\n\n/**\n * Staleness is reported as two independent numbers, never as one sum, because\n * the two have different remedies: a stale cache resolves itself at the next\n * TTL, while ingest lag means the read model is genuinely behind and the right\n * response is an \"aggregating\" badge, not a refresh.\n */\nexport const zQuerySource = z.enum([\"rollup\", \"raw\", \"mixed\"]);\nexport type QuerySource = z.infer<typeof zQuerySource>;\n\nexport const zQueryMeta = z.object({\n projectId: z.string(),\n /** When the underlying computation actually ran. On a cache hit, when the cached value was computed. */\n computedAt: zInstant,\n /** Age of the returned computation, in seconds. `0` on a cache miss. */\n cacheAgeSeconds: z.number().int().nonnegative(),\n /**\n * How far behind live materialization was when the computation ran, in\n * seconds. `0` means no live event is pending; `null` means measurement\n * failed and must never be interpreted as fresh.\n *\n * Deliberately not `now - max(events.created_at)` — that conflates \"the\n * pipeline is behind\" with \"this project is quiet\", and grows without bound\n * on an idle project.\n */\n ingestLagSeconds: z.number().int().nonnegative().nullable(),\n /** Whether the freshness measurement itself succeeded. */\n ingestLagStatus: z.enum([\"known\", \"unknown\"]),\n /**\n * Pending events older than the live replay window. Kept separate so an old\n * permanently failing event neither pegs live lag nor disappears behind 0.\n * `null` means the measurement failed.\n */\n ingestDeadLetterCount: z.number().int().nonnegative().nullable(),\n cached: z.boolean(),\n /**\n * The time zone actually used to place bucket and window boundaries — the\n * resolved value, not the requested one. Read it rather than assuming the\n * request was honoured: when no zone is given anywhere it is `\"UTC\"`, and\n * that is exactly the case a consumer needs to notice.\n */\n timezone: z.string(),\n /**\n * Where the numbers came from. `rollup`: pre-aggregated hourly tables;\n * `raw`: a scan of the event/session tables; `mixed`: finished hours from\n * the rollup, the hour still in progress from raw. Diagnostic — the values\n * agree either way — but a consumer that expected `rollup` and sees `raw`\n * has asked for a combination the rollups cannot serve.\n */\n source: zQuerySource,\n requestId: z.string(),\n});\nexport type QueryMeta = z.infer<typeof zQueryMeta>;\n\n/** Every query response is `{ data, meta }`. */\nexport function zQueryEnvelope<T extends z.ZodTypeAny>(data: T) {\n return z.object({ data, meta: zQueryMeta });\n}\n\n// ─── events.timeseries ──────────────────────────────────────────────────────\n\n/**\n * v1 breaks down by `properties` JSON keys only. Built-in columns\n * (country / os / browser / utm_*) have a totals breakdown in the backend but\n * no *time series* variant, and this plane does not add new computations.\n */\nexport const zTimeseriesBreakdown = z.object({\n kind: z.literal(\"property\"),\n key: z.string().min(1).max(200),\n topN: z.number().int().min(1).max(100).default(5),\n});\nexport type TimeseriesBreakdown = z.infer<typeof zTimeseriesBreakdown>;\n\n/** Exact-match filter for a top-level event `properties` key. Multiple filters are ANDed. */\nexport const zEventPropertyFilter = z.object({\n key: z.string().min(1).max(200),\n operator: z.literal(\"eq\").default(\"eq\"),\n value: z.string().min(1).max(500),\n});\nexport type EventPropertyFilter = z.infer<typeof zEventPropertyFilter>;\n\nexport const zEventsTimeseriesInput = z\n .object({\n projectId: z.string().min(1),\n startDate: zDate,\n endDate: zDate,\n granularity: zGranularity.default(\"day\"),\n /** Omit to count every event in the window. */\n eventName: z.string().min(1).max(200).optional(),\n /** Exact matches against top-level `properties` keys. Every item must match. */\n propertyFilters: z.array(zEventPropertyFilter).max(10).optional(),\n breakdown: zTimeseriesBreakdown.optional(),\n /**\n * Cannot be combined with `breakdown` — the backend's breakdown time series\n * takes no segment. Sending both is refused with `unsupported_combination`\n * rather than silently ignoring one of them.\n */\n segmentId: z.string().min(1).optional(),\n /** Omit to fall back to the project's configured zone, then to UTC. */\n timezone: zTimezone.optional(),\n /**\n * Events whose catalogue status is `internal` (operational probes) are\n * left out by default. A probe that needs to find its own event sets this.\n */\n includeInternal: z.boolean().default(false),\n })\n .refine((input) => input.startDate <= input.endDate, {\n message: \"endDate must be on or after startDate\",\n path: [\"endDate\"],\n });\nexport type EventsTimeseriesInput = z.input<typeof zEventsTimeseriesInput>;\n\n/**\n * Bucket start as wall-clock time in `meta.timezone`, `YYYY-MM-DD HH:MM:SS`.\n *\n * Pinned rather than left to the backend, because a consumer keys its chart on\n * this string: an unspecified format is one where two backends, or two\n * granularities, can quietly disagree and produce two different keys for the\n * same bucket.\n *\n * It is wall time, not an instant — for `Asia/Seoul` a day bucket reads\n * `2026-08-24 00:00:00`, which is `2026-08-23T15:00:00Z`. Day, week and month\n * buckets always carry `00:00:00`, so slicing the first ten characters is a\n * safe way to get a date key.\n */\nexport const zBucketStart = z.string().regex(/^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$/, \"expected 'YYYY-MM-DD HH:MM:SS'\");\n\nexport const zTimeseriesPoint = z.object({\n date: zBucketStart,\n count: z.number().int().nonnegative(),\n});\nexport type TimeseriesPoint = z.infer<typeof zTimeseriesPoint>;\n\nexport const zEventsTimeseriesData = z.object({\n granularity: zGranularity,\n /** Zone the buckets were cut in. Mirrors `meta.timezone`. */\n timezone: z.string(),\n /** Total per bucket. Always present, with or without a breakdown. */\n series: z.array(zTimeseriesPoint),\n /** Present only when `breakdown` was requested: the top-N values, each with its own series. */\n breakdown: z\n .array(\n z.object({\n value: z.string(),\n points: z.array(zTimeseriesPoint),\n })\n )\n .optional(),\n});\nexport type EventsTimeseriesData = z.infer<typeof zEventsTimeseriesData>;\n\nexport const zEventsTimeseriesResponse = zQueryEnvelope(zEventsTimeseriesData);\nexport type EventsTimeseriesResponse = z.infer<typeof zEventsTimeseriesResponse>;\n\n// ─── funnel ─────────────────────────────────────────────────────────────────\n\nexport const zFunnelInput = z\n .object({\n projectId: z.string().min(1),\n /** Ordered event names. A user counts at step k if they reached at least step k. */\n steps: z.array(z.string().min(1).max(200)).min(2).max(10),\n startDate: zDate,\n endDate: zDate,\n /** Max seconds between the first and last step for a conversion to count. Default 24h. */\n windowSeconds: z.number().int().min(60).max(2_592_000).default(86_400),\n segmentId: z.string().min(1).optional(),\n channelFilter: zChannelFilter,\n /**\n * Decides where `startDate` / `endDate` fall. A funnel has no buckets, so\n * this only moves the window — but a nine-hour window shift changes who is\n * in the funnel.\n */\n timezone: zTimezone.optional(),\n /** Accepted for symmetry with events.timeseries; funnel steps are named explicitly, so nothing is filtered. */\n includeInternal: z.boolean().default(false),\n })\n .refine((input) => input.startDate <= input.endDate, {\n message: \"endDate must be on or after startDate\",\n path: [\"endDate\"],\n });\nexport type FunnelInput = z.input<typeof zFunnelInput>;\n\nexport const zFunnelStep = z.object({\n step: z.number().int().min(1),\n name: z.string(),\n users: z.number().int().nonnegative(),\n /** Percent of the previous step that reached this one. `100` for step 1. */\n conversionRate: z.number(),\n /** Percent of the previous step that did not. `0` for step 1. */\n dropoffRate: z.number(),\n dropoffUsers: z.number().int().nonnegative(),\n});\n\nexport const zFunnelData = z.object({\n steps: z.array(zFunnelStep),\n totalUsers: z.number().int().nonnegative(),\n /** Percent of step-1 users that reached the last step. */\n overallConversionRate: z.number(),\n});\nexport type FunnelData = z.infer<typeof zFunnelData>;\n\nexport const zFunnelResponse = zQueryEnvelope(zFunnelData);\nexport type FunnelResponse = z.infer<typeof zFunnelResponse>;\n\n// ─── retention ──────────────────────────────────────────────────────────────\n\nexport const zRetentionInterval = z.enum([\"day\", \"week\", \"month\"]);\n\nexport const zRetentionInput = z\n .object({\n projectId: z.string().min(1),\n startDate: zDate,\n endDate: zDate,\n interval: zRetentionInterval.default(\"day\"),\n periods: z.number().int().min(1).max(30).default(7),\n startEvent: z.string().min(1).max(200).optional(),\n returnEvent: z.string().min(1).max(200).optional(),\n /** `bounded`: returned in exactly period N. `unbounded`: returned in period N or later. */\n retentionType: z.enum([\"bounded\", \"unbounded\"]).default(\"bounded\"),\n /**\n * `first-ever` (default): the cohort is everyone whose true first activity\n * landed in the window, read from the first-seen aggregate. `startEvent`,\n * `segmentId` and `channelFilter` then constrain only the *returning* side.\n * `first-in-window`: the cohort is selected by scanning events in the window\n * with all filters applied. Slower, but filters apply to cohort selection.\n */\n cohortMode: z.enum([\"first-ever\", \"first-in-window\"]).default(\"first-ever\"),\n segmentId: z.string().min(1).optional(),\n channelFilter: zChannelFilter,\n /**\n * Decides where a cohort day starts, and so which period a return falls in.\n *\n * Honoured under both cohort modes. Note that a non-UTC zone makes\n * `first-ever` read raw events instead of its daily rollup — the rollup is\n * cut on UTC days and cannot be re-cut after the fact — so expect a slower\n * query in exchange for cohorts that match the reader's calendar.\n */\n timezone: zTimezone.optional(),\n /** Accepted for symmetry with events.timeseries; retention reads named or all-event activity and does not yet apply the internal filter. */\n includeInternal: z.boolean().default(false),\n })\n .refine((input) => input.startDate <= input.endDate, {\n message: \"endDate must be on or after startDate\",\n path: [\"endDate\"],\n });\nexport type RetentionInput = z.input<typeof zRetentionInput>;\n\nexport const zRetentionCell = z.object({\n /** `0` is the cohort's own period. */\n period: z.number().int().nonnegative(),\n users: z.number().int().nonnegative(),\n /** Percent of `cohortSize`. */\n rate: z.number(),\n});\n\nexport const zRetentionData = z.object({\n matrix: z.array(\n z.object({\n /** Cohort bucket start, same shape and zone as {@link zBucketStart}. */\n cohortDate: zBucketStart,\n cohortSize: z.number().int().nonnegative(),\n /** Length is `periods + 1`, index-aligned to `period`. */\n retention: z.array(zRetentionCell),\n })\n ),\n /** Unweighted mean rate per period across cohorts. */\n averageRetention: z.array(z.object({ period: z.number().int().nonnegative(), rate: z.number() })),\n interval: zRetentionInterval,\n periods: z.number().int(),\n retentionType: z.enum([\"bounded\", \"unbounded\"]),\n /** Zone the cohort days were cut in. Mirrors `meta.timezone`. */\n timezone: z.string(),\n});\nexport type RetentionData = z.infer<typeof zRetentionData>;\n\nexport const zRetentionResponse = zQueryEnvelope(zRetentionData);\nexport type RetentionResponse = z.infer<typeof zRetentionResponse>;\n\n// ─── traffic ────────────────────────────────────────────────────────────────\n\n/**\n * Session-level traffic for a brand site, served from the hourly rollups.\n * `newVisitors` counts sessions whose device was first seen inside them;\n * `returningVisitors` is the rest. Both are session counts, not people —\n * \"visitor\" is the vocabulary the dashboards already use.\n */\nexport const zTrafficOverviewInput = z\n .object({\n projectId: z.string().min(1),\n startDate: zDate,\n endDate: zDate,\n granularity: zGranularity.default(\"day\"),\n timezone: zTimezone.optional(),\n })\n .refine((input) => input.startDate <= input.endDate, {\n message: \"endDate must be on or after startDate\",\n path: [\"endDate\"],\n });\nexport type TrafficOverviewInput = z.input<typeof zTrafficOverviewInput>;\n\nexport const zTrafficTotals = z.object({\n sessions: z.number().int().nonnegative(),\n pageviews: z.number().int().nonnegative(),\n newVisitors: z.number().int().nonnegative(),\n returningVisitors: z.number().int().nonnegative(),\n /** Percent of sessions that bounced, two decimals. */\n bounceRate: z.number(),\n});\nexport type TrafficTotals = z.infer<typeof zTrafficTotals>;\n\nexport const zTrafficSeriesPoint = zTrafficTotals.extend({ date: zBucketStart });\n\nexport const zTrafficOverviewData = z.object({\n granularity: zGranularity,\n timezone: z.string(),\n totals: zTrafficTotals,\n series: z.array(zTrafficSeriesPoint),\n});\nexport type TrafficOverviewData = z.infer<typeof zTrafficOverviewData>;\nexport const zTrafficOverviewResponse = zQueryEnvelope(zTrafficOverviewData);\nexport type TrafficOverviewResponse = z.infer<typeof zTrafficOverviewResponse>;\n\nexport const zTrafficDimension = z.enum([\"channel\", \"referrer\", \"utm\"]);\nexport type TrafficDimension = z.infer<typeof zTrafficDimension>;\n\nexport const zTrafficSourcesInput = z\n .object({\n projectId: z.string().min(1),\n startDate: zDate,\n endDate: zDate,\n /** `channel`: channel_type · `referrer`: referrer name+type · `utm`: source/medium/campaign. */\n dimension: zTrafficDimension,\n limit: z.number().int().min(1).max(100).default(10),\n timezone: zTimezone.optional(),\n })\n .refine((input) => input.startDate <= input.endDate, {\n message: \"endDate must be on or after startDate\",\n path: [\"endDate\"],\n });\nexport type TrafficSourcesInput = z.input<typeof zTrafficSourcesInput>;\n\nexport const zTrafficSourceRow = zTrafficTotals.extend({\n /** Display key for the row: the channel, the referrer name, or `source / medium / campaign`. */\n key: z.string(),\n channelType: z.string().optional(),\n referrerName: z.string().optional(),\n referrerType: z.string().optional(),\n utmSource: z.string().optional(),\n utmMedium: z.string().optional(),\n utmCampaign: z.string().optional(),\n});\nexport type TrafficSourceRow = z.infer<typeof zTrafficSourceRow>;\n\nexport const zTrafficSourcesData = z.object({\n dimension: zTrafficDimension,\n timezone: z.string(),\n /** Ordered by sessions, descending. */\n rows: z.array(zTrafficSourceRow),\n});\nexport type TrafficSourcesData = z.infer<typeof zTrafficSourcesData>;\nexport const zTrafficSourcesResponse = zQueryEnvelope(zTrafficSourcesData);\nexport type TrafficSourcesResponse = z.infer<typeof zTrafficSourcesResponse>;\n\n// ─── Errors ─────────────────────────────────────────────────────────────────\n\nexport const QUERY_ERROR_CODES = [\n /** 401 — unknown or mismatched credentials. */\n \"unauthorized\",\n /** 403 — the credential's project is not the project asked about. */\n \"project_scope_mismatch\",\n /** 403 — the credential lacks the `query` scope. Provision a query-scoped client. */\n \"query_scope_missing\",\n /** 400 — input failed the schema. `errors` carries the zod issues. */\n \"validation_failed\",\n /** 400 — inputs are individually valid but cannot be served together (e.g. breakdown + segmentId). */\n \"unsupported_combination\",\n /** 410 — the project is being deleted. Permanent; stop asking. */\n \"project_purging\",\n /** 429 — per-credential query rate limit. `Retry-After` set. */\n \"rate_limited\",\n /** 504 — the analytics backend exceeded its statement timeout. Narrow the window. */\n \"query_timeout\",\n /** 500 — unexpected server failure. */\n \"internal_error\",\n] as const;\nexport const zQueryErrorCode = z.enum(QUERY_ERROR_CODES);\nexport type QueryErrorCode = z.infer<typeof zQueryErrorCode>;\n\nexport const zQueryError = z.object({\n status: z.number().int(),\n code: zQueryErrorCode,\n error: z.string(),\n message: z.string().optional(),\n errors: z.unknown().optional(),\n requestId: z.string().optional(),\n});\nexport type QueryError = z.infer<typeof zQueryError>;\n\n/** Paths, so the client and the route handlers cannot drift apart. */\nexport const QUERY_API_PATHS = {\n eventsTimeseries: \"/api/v1/query/events/timeseries\",\n funnel: \"/api/v1/query/funnel\",\n retention: \"/api/v1/query/retention\",\n trafficOverview: \"/api/v1/query/traffic/overview\",\n trafficSources: \"/api/v1/query/traffic/sources\",\n} as const;\n"]}
|