@debugbundle/shared-types 2.1.0 → 2.2.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/analytics-flows.d.ts +691 -0
- package/dist/analytics-flows.d.ts.map +1 -0
- package/dist/analytics-flows.js +99 -0
- package/dist/analytics-flows.js.map +1 -0
- package/dist/analytics-journey-samples.d.ts +58 -58
- package/dist/analytics-product.d.ts +10 -10
- package/dist/analytics-saved-funnels.d.ts +97 -97
- package/dist/analytics.d.ts +99 -99
- package/dist/browser-resource-context.d.ts +10 -10
- package/dist/browser-resource-routes.d.ts +2 -2
- package/dist/capture-rule-evaluation.d.ts +2 -2
- package/dist/capture-rule-schemas.d.ts +44 -44
- package/dist/event-envelope.d.ts +120 -120
- package/dist/index.d.ts +195 -194
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
export const AnalyticsFlowKeySchema = z
|
|
3
|
+
.string()
|
|
4
|
+
.trim()
|
|
5
|
+
.regex(/^[a-z][a-z0-9_.-]{0,63}$/);
|
|
6
|
+
export const AnalyticsFlowOriginSchema = z
|
|
7
|
+
.string()
|
|
8
|
+
.max(255)
|
|
9
|
+
.refine((value) => {
|
|
10
|
+
try {
|
|
11
|
+
const url = new URL(value);
|
|
12
|
+
return (url.origin === value &&
|
|
13
|
+
!url.username &&
|
|
14
|
+
!url.password &&
|
|
15
|
+
(url.protocol === "https:" ||
|
|
16
|
+
(url.protocol === "http:" && ["localhost", "127.0.0.1", "[::1]"].includes(url.hostname))));
|
|
17
|
+
}
|
|
18
|
+
catch {
|
|
19
|
+
return false;
|
|
20
|
+
}
|
|
21
|
+
}, "Use an exact HTTPS origin (HTTP is allowed for localhost).");
|
|
22
|
+
export const AnalyticsFlowDefinitionInputSchema = z
|
|
23
|
+
.object({
|
|
24
|
+
flow_key: AnalyticsFlowKeySchema,
|
|
25
|
+
display_name: z.string().trim().min(1).max(120),
|
|
26
|
+
kind: z.enum(["acquisition", "activation"]),
|
|
27
|
+
timeout_minutes: z.number().int().min(10).max(1440).default(60),
|
|
28
|
+
steps: z
|
|
29
|
+
.array(z
|
|
30
|
+
.object({
|
|
31
|
+
step_key: AnalyticsFlowKeySchema,
|
|
32
|
+
display_name: z.string().trim().min(1).max(120),
|
|
33
|
+
origin: AnalyticsFlowOriginSchema
|
|
34
|
+
})
|
|
35
|
+
.strict())
|
|
36
|
+
.min(2)
|
|
37
|
+
.max(8)
|
|
38
|
+
})
|
|
39
|
+
.strict()
|
|
40
|
+
.refine((value) => new Set(value.steps.map((step) => step.step_key)).size === value.steps.length, "Step keys must be unique.");
|
|
41
|
+
export const AnalyticsFlowDefinitionSchema = AnalyticsFlowDefinitionInputSchema.innerType()
|
|
42
|
+
.extend({
|
|
43
|
+
id: z.string().uuid(),
|
|
44
|
+
project_id: z.string().uuid(),
|
|
45
|
+
version: z.number().int().positive(),
|
|
46
|
+
archived_at: z.string().datetime().nullable()
|
|
47
|
+
})
|
|
48
|
+
.refine((value) => new Set(value.steps.map((step) => step.step_key)).size === value.steps.length, "Step keys must be unique.");
|
|
49
|
+
const Count = z.number().int().nonnegative();
|
|
50
|
+
export const AnalyticsFlowReportSchema = z.object({
|
|
51
|
+
flow: AnalyticsFlowDefinitionSchema,
|
|
52
|
+
window: z.object({
|
|
53
|
+
from: z.string().datetime(),
|
|
54
|
+
to: z.string().datetime(),
|
|
55
|
+
previous_from: z.string().datetime()
|
|
56
|
+
}),
|
|
57
|
+
starts: Count,
|
|
58
|
+
previous_starts: Count,
|
|
59
|
+
completions: Count,
|
|
60
|
+
steps: z
|
|
61
|
+
.array(z.object({
|
|
62
|
+
step_key: AnalyticsFlowKeySchema,
|
|
63
|
+
display_name: z.string(),
|
|
64
|
+
reached: Count,
|
|
65
|
+
previous_reached: Count,
|
|
66
|
+
unlinked: Count,
|
|
67
|
+
dropoff: Count,
|
|
68
|
+
average_seconds: z.number().nonnegative().nullable()
|
|
69
|
+
}))
|
|
70
|
+
.min(2)
|
|
71
|
+
.max(8),
|
|
72
|
+
sources: z
|
|
73
|
+
.array(z.object({ source: z.string(), campaign: z.string(), starts: Count, completions: Count }))
|
|
74
|
+
.max(50),
|
|
75
|
+
coverage: z.object({
|
|
76
|
+
observation: z.literal("explicit_integration_signals"),
|
|
77
|
+
incomplete: z.literal(true),
|
|
78
|
+
sources_truncated: z.boolean()
|
|
79
|
+
})
|
|
80
|
+
});
|
|
81
|
+
export const AnalyticsFlowsResponseSchema = z.object({
|
|
82
|
+
flows: z.array(AnalyticsFlowDefinitionSchema).max(100)
|
|
83
|
+
});
|
|
84
|
+
export const AnalyticsFlowResponseSchema = z.object({ flow: AnalyticsFlowDefinitionSchema });
|
|
85
|
+
const Secret = z.string().regex(/^[A-Za-z0-9_-]{43}$/);
|
|
86
|
+
const Label = z.string().regex(/^[a-zA-Z0-9][a-zA-Z0-9._~+-]{0,99}$/);
|
|
87
|
+
const Context = z.object({ context: Secret, consent: z.boolean().optional() });
|
|
88
|
+
export const AnalyticsFlowCaptureSchemas = {
|
|
89
|
+
start: Context.extend({
|
|
90
|
+
step_key: AnalyticsFlowKeySchema,
|
|
91
|
+
source: Label.optional(),
|
|
92
|
+
campaign: Label.optional()
|
|
93
|
+
}).strict(),
|
|
94
|
+
step: Context.extend({ step_key: AnalyticsFlowKeySchema }).strict(),
|
|
95
|
+
handoff: Context.extend({ step_key: AnalyticsFlowKeySchema, token: Secret }).strict(),
|
|
96
|
+
arrive: Context.extend({ token: Secret }).strict(),
|
|
97
|
+
withdraw: Context.strict()
|
|
98
|
+
};
|
|
99
|
+
//# sourceMappingURL=analytics-flows.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analytics-flows.js","sourceRoot":"","sources":["../src/analytics-flows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACpC,MAAM,EAAE;KACR,IAAI,EAAE;KACN,KAAK,CAAC,0BAA0B,CAAC,CAAC;AACrC,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,EAAE;KACR,GAAG,CAAC,GAAG,CAAC;KACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;IAChB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,OAAO,CACL,GAAG,CAAC,MAAM,KAAK,KAAK;YACpB,CAAC,GAAG,CAAC,QAAQ;YACb,CAAC,GAAG,CAAC,QAAQ;YACb,CAAC,GAAG,CAAC,QAAQ,KAAK,QAAQ;gBACxB,CAAC,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAC5F,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,EAAE,4DAA4D,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC;KAChD,MAAM,CAAC;IACN,QAAQ,EAAE,sBAAsB;IAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;IAC3C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAC/D,KAAK,EAAE,CAAC;SACL,KAAK,CACJ,CAAC;SACE,MAAM,CAAC;QACN,QAAQ,EAAE,sBAAsB;QAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;QAC/C,MAAM,EAAE,yBAAyB;KAClC,CAAC;SACD,MAAM,EAAE,CACZ;SACA,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,CAAC,CAAC;CACV,CAAC;KACD,MAAM,EAAE;KACR,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM,EACxF,2BAA2B,CAC5B,CAAC;AAEJ,MAAM,CAAC,MAAM,6BAA6B,GAAG,kCAAkC,CAAC,SAAS,EAAE;KACxF,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IACrB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC7B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACpC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC9C,CAAC;KACD,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM,EACxF,2BAA2B,CAC5B,CAAC;AAEJ,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;AAC7C,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,IAAI,EAAE,6BAA6B;IACnC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACrC,CAAC;IACF,MAAM,EAAE,KAAK;IACb,eAAe,EAAE,KAAK;IACtB,WAAW,EAAE,KAAK;IAClB,KAAK,EAAE,CAAC;SACL,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,QAAQ,EAAE,sBAAsB;QAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QACxB,OAAO,EAAE,KAAK;QACd,gBAAgB,EAAE,KAAK;QACvB,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,KAAK;QACd,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;KACrD,CAAC,CACH;SACA,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,CAAC,CAAC;IACT,OAAO,EAAE,CAAC;SACP,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAC1F;SACA,GAAG,CAAC,EAAE,CAAC;IACV,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC;QACtD,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;QAC3B,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE;KAC/B,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;CACvD,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,6BAA6B,EAAE,CAAC,CAAC;AAE7F,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;AACvD,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;AACtE,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC/E,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC;QACpB,QAAQ,EAAE,sBAAsB;QAChC,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE;QACxB,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE;KAC3B,CAAC,CAAC,MAAM,EAAE;IACX,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE;IACnE,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IACrF,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClD,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE;CAC3B,CAAC"}
|