@guidelytech/shared 0.2.1 → 0.4.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/dist/{chunk-OFBIZEM5.js → chunk-QUKMOTT4.js} +159 -4
- package/dist/chunk-QUKMOTT4.js.map +1 -0
- package/dist/index.cjs +267 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +352 -83
- package/dist/index.d.ts +352 -83
- package/dist/index.js +124 -7
- package/dist/index.js.map +1 -1
- package/dist/runtime.cjs +181 -4
- package/dist/runtime.cjs.map +1 -1
- package/dist/runtime.d.cts +191 -2
- package/dist/runtime.d.ts +191 -2
- package/dist/runtime.js +47 -3
- package/package.json +1 -1
- package/dist/chunk-OFBIZEM5.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { RuleGroup, Rule } from './runtime.cjs';
|
|
2
|
-
export { MAX_PROPERTY_BYTES, RULE_FIELDS, RULE_OPERATORS, RuleField, RuleOperator, SENSITIVE_PROPERTY_PATTERN, SERVER_ASSISTED_FIELDS, TargetingContext, clamp, compare, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fnv1a, getPath, isPlainObject, isRuleGroup, matchUrlPattern, randomId, rolloutBucket, safeRegExp, sanitizeProperties, slugify, stripOrigin } from './runtime.cjs';
|
|
2
|
+
export { DEFAULT_PLATFORMS, ExceptionProperties, GUIDELY_ID_ATTRIBUTE, MAX_PROPERTY_BYTES, MAX_STACK_FRAMES, NETWORK_PLUGIN, NetworkPluginPayload, NetworkRequest, NetworkRequestType, PLATFORMS, Platform, RULE_FIELDS, RULE_OPERATORS, RuleField, RuleOperator, SENSITIVE_HEADER_PATTERN, SENSITIVE_PARAM_PATTERN, SENSITIVE_PROPERTY_PATTERN, SERVER_ASSISTED_FIELDS, SOURCEMAP_MAX_FILES_PER_UPLOAD, SOURCEMAP_MAX_FILE_BYTES, ShowWhen, StackFrame, SurveyAnswer, SurveyAnswers, TargetingContext, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, WebSocketMessage, clamp, compare, compareVersions, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, fnv1a, getPath, guidePlatforms, guidelyIdFromSelector, isChecklistComplete, isPlainObject, isQuestionVisible, isRuleGroup, matchUrlPattern, normalizeErrorMessage, normalizeFrameFile, parseStack, randomId, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, slugify, stripOrigin, supportsPlatform } from './runtime.cjs';
|
|
3
3
|
import { z } from 'zod';
|
|
4
4
|
|
|
5
5
|
declare const RuleSchema: z.ZodType<Rule>;
|
|
@@ -13,36 +13,37 @@ declare const STEP_TYPES: readonly ["modal", "tooltip", "popover", "spotlight",
|
|
|
13
13
|
type StepType = (typeof STEP_TYPES)[number];
|
|
14
14
|
declare const PLACEMENTS: readonly ["top", "top-start", "top-end", "right", "right-start", "right-end", "bottom", "bottom-start", "bottom-end", "left", "left-start", "left-end", "auto"];
|
|
15
15
|
type Placement = (typeof PLACEMENTS)[number];
|
|
16
|
-
|
|
16
|
+
/** `guidely-id` is cross-platform: `data-guidely-id` on web, `GuidelyTarget` / `guidelyTarget()` on mobile. */
|
|
17
|
+
declare const SELECTOR_KINDS: readonly ["css", "id", "data-attr", "aria", "text", "xpath", "guidely-id"];
|
|
17
18
|
declare const SelectorStrategySchema: z.ZodObject<{
|
|
18
|
-
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath"]>;
|
|
19
|
+
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath", "guidely-id"]>;
|
|
19
20
|
value: z.ZodString;
|
|
20
21
|
/** Optional human-readable label captured at pick time. */
|
|
21
22
|
label: z.ZodOptional<z.ZodString>;
|
|
22
23
|
}, "strip", z.ZodTypeAny, {
|
|
23
24
|
value: string;
|
|
24
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
25
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
25
26
|
label?: string | undefined;
|
|
26
27
|
}, {
|
|
27
28
|
value: string;
|
|
28
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
29
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
29
30
|
label?: string | undefined;
|
|
30
31
|
}>;
|
|
31
32
|
type SelectorStrategy = z.infer<typeof SelectorStrategySchema>;
|
|
32
33
|
declare const TargetSchema: z.ZodObject<{
|
|
33
34
|
/** Ordered strategies; the first one resolving to exactly one element wins. */
|
|
34
35
|
selectors: z.ZodArray<z.ZodObject<{
|
|
35
|
-
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath"]>;
|
|
36
|
+
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath", "guidely-id"]>;
|
|
36
37
|
value: z.ZodString;
|
|
37
38
|
/** Optional human-readable label captured at pick time. */
|
|
38
39
|
label: z.ZodOptional<z.ZodString>;
|
|
39
40
|
}, "strip", z.ZodTypeAny, {
|
|
40
41
|
value: string;
|
|
41
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
42
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
42
43
|
label?: string | undefined;
|
|
43
44
|
}, {
|
|
44
45
|
value: string;
|
|
45
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
46
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
46
47
|
label?: string | undefined;
|
|
47
48
|
}>, "many">;
|
|
48
49
|
/** How long to wait for the element before applying fallback. */
|
|
@@ -56,7 +57,7 @@ declare const TargetSchema: z.ZodObject<{
|
|
|
56
57
|
}, "strip", z.ZodTypeAny, {
|
|
57
58
|
selectors: {
|
|
58
59
|
value: string;
|
|
59
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
60
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
60
61
|
label?: string | undefined;
|
|
61
62
|
}[];
|
|
62
63
|
waitMs: number;
|
|
@@ -66,7 +67,7 @@ declare const TargetSchema: z.ZodObject<{
|
|
|
66
67
|
}, {
|
|
67
68
|
selectors: {
|
|
68
69
|
value: string;
|
|
69
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
70
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
70
71
|
label?: string | undefined;
|
|
71
72
|
}[];
|
|
72
73
|
waitMs?: number | undefined;
|
|
@@ -149,17 +150,17 @@ declare const StepSchema: z.ZodObject<{
|
|
|
149
150
|
target: z.ZodOptional<z.ZodObject<{
|
|
150
151
|
/** Ordered strategies; the first one resolving to exactly one element wins. */
|
|
151
152
|
selectors: z.ZodArray<z.ZodObject<{
|
|
152
|
-
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath"]>;
|
|
153
|
+
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath", "guidely-id"]>;
|
|
153
154
|
value: z.ZodString;
|
|
154
155
|
/** Optional human-readable label captured at pick time. */
|
|
155
156
|
label: z.ZodOptional<z.ZodString>;
|
|
156
157
|
}, "strip", z.ZodTypeAny, {
|
|
157
158
|
value: string;
|
|
158
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
159
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
159
160
|
label?: string | undefined;
|
|
160
161
|
}, {
|
|
161
162
|
value: string;
|
|
162
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
163
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
163
164
|
label?: string | undefined;
|
|
164
165
|
}>, "many">;
|
|
165
166
|
/** How long to wait for the element before applying fallback. */
|
|
@@ -173,7 +174,7 @@ declare const StepSchema: z.ZodObject<{
|
|
|
173
174
|
}, "strip", z.ZodTypeAny, {
|
|
174
175
|
selectors: {
|
|
175
176
|
value: string;
|
|
176
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
177
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
177
178
|
label?: string | undefined;
|
|
178
179
|
}[];
|
|
179
180
|
waitMs: number;
|
|
@@ -183,7 +184,7 @@ declare const StepSchema: z.ZodObject<{
|
|
|
183
184
|
}, {
|
|
184
185
|
selectors: {
|
|
185
186
|
value: string;
|
|
186
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
187
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
187
188
|
label?: string | undefined;
|
|
188
189
|
}[];
|
|
189
190
|
waitMs?: number | undefined;
|
|
@@ -279,7 +280,7 @@ declare const StepSchema: z.ZodObject<{
|
|
|
279
280
|
target?: {
|
|
280
281
|
selectors: {
|
|
281
282
|
value: string;
|
|
282
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
283
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
283
284
|
label?: string | undefined;
|
|
284
285
|
}[];
|
|
285
286
|
waitMs: number;
|
|
@@ -315,7 +316,7 @@ declare const StepSchema: z.ZodObject<{
|
|
|
315
316
|
target?: {
|
|
316
317
|
selectors: {
|
|
317
318
|
value: string;
|
|
318
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
319
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
319
320
|
label?: string | undefined;
|
|
320
321
|
}[];
|
|
321
322
|
waitMs?: number | undefined;
|
|
@@ -565,11 +566,11 @@ declare const SurveyQuestionSchema: z.ZodObject<{
|
|
|
565
566
|
value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString, "many">]>;
|
|
566
567
|
}, "strip", z.ZodTypeAny, {
|
|
567
568
|
value: string | number | string[];
|
|
568
|
-
op: "equals" | "
|
|
569
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
569
570
|
questionId: string;
|
|
570
571
|
}, {
|
|
571
572
|
value: string | number | string[];
|
|
572
|
-
op: "equals" | "
|
|
573
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
573
574
|
questionId: string;
|
|
574
575
|
}>>;
|
|
575
576
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -588,7 +589,7 @@ declare const SurveyQuestionSchema: z.ZodObject<{
|
|
|
588
589
|
placeholder?: string | undefined;
|
|
589
590
|
showWhen?: {
|
|
590
591
|
value: string | number | string[];
|
|
591
|
-
op: "equals" | "
|
|
592
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
592
593
|
questionId: string;
|
|
593
594
|
} | undefined;
|
|
594
595
|
}, {
|
|
@@ -607,7 +608,7 @@ declare const SurveyQuestionSchema: z.ZodObject<{
|
|
|
607
608
|
placeholder?: string | undefined;
|
|
608
609
|
showWhen?: {
|
|
609
610
|
value: string | number | string[];
|
|
610
|
-
op: "equals" | "
|
|
611
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
611
612
|
questionId: string;
|
|
612
613
|
} | undefined;
|
|
613
614
|
}>;
|
|
@@ -640,11 +641,11 @@ declare const SurveyConfigSchema: z.ZodObject<{
|
|
|
640
641
|
value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString, "many">]>;
|
|
641
642
|
}, "strip", z.ZodTypeAny, {
|
|
642
643
|
value: string | number | string[];
|
|
643
|
-
op: "equals" | "
|
|
644
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
644
645
|
questionId: string;
|
|
645
646
|
}, {
|
|
646
647
|
value: string | number | string[];
|
|
647
|
-
op: "equals" | "
|
|
648
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
648
649
|
questionId: string;
|
|
649
650
|
}>>;
|
|
650
651
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -663,7 +664,7 @@ declare const SurveyConfigSchema: z.ZodObject<{
|
|
|
663
664
|
placeholder?: string | undefined;
|
|
664
665
|
showWhen?: {
|
|
665
666
|
value: string | number | string[];
|
|
666
|
-
op: "equals" | "
|
|
667
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
667
668
|
questionId: string;
|
|
668
669
|
} | undefined;
|
|
669
670
|
}, {
|
|
@@ -682,7 +683,7 @@ declare const SurveyConfigSchema: z.ZodObject<{
|
|
|
682
683
|
placeholder?: string | undefined;
|
|
683
684
|
showWhen?: {
|
|
684
685
|
value: string | number | string[];
|
|
685
|
-
op: "equals" | "
|
|
686
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
686
687
|
questionId: string;
|
|
687
688
|
} | undefined;
|
|
688
689
|
}>, "many">;
|
|
@@ -709,7 +710,7 @@ declare const SurveyConfigSchema: z.ZodObject<{
|
|
|
709
710
|
placeholder?: string | undefined;
|
|
710
711
|
showWhen?: {
|
|
711
712
|
value: string | number | string[];
|
|
712
|
-
op: "equals" | "
|
|
713
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
713
714
|
questionId: string;
|
|
714
715
|
} | undefined;
|
|
715
716
|
}[];
|
|
@@ -734,7 +735,7 @@ declare const SurveyConfigSchema: z.ZodObject<{
|
|
|
734
735
|
placeholder?: string | undefined;
|
|
735
736
|
showWhen?: {
|
|
736
737
|
value: string | number | string[];
|
|
737
|
-
op: "equals" | "
|
|
738
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
738
739
|
questionId: string;
|
|
739
740
|
} | undefined;
|
|
740
741
|
}[];
|
|
@@ -779,17 +780,17 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
779
780
|
target: z.ZodOptional<z.ZodObject<{
|
|
780
781
|
/** Ordered strategies; the first one resolving to exactly one element wins. */
|
|
781
782
|
selectors: z.ZodArray<z.ZodObject<{
|
|
782
|
-
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath"]>;
|
|
783
|
+
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath", "guidely-id"]>;
|
|
783
784
|
value: z.ZodString;
|
|
784
785
|
/** Optional human-readable label captured at pick time. */
|
|
785
786
|
label: z.ZodOptional<z.ZodString>;
|
|
786
787
|
}, "strip", z.ZodTypeAny, {
|
|
787
788
|
value: string;
|
|
788
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
789
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
789
790
|
label?: string | undefined;
|
|
790
791
|
}, {
|
|
791
792
|
value: string;
|
|
792
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
793
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
793
794
|
label?: string | undefined;
|
|
794
795
|
}>, "many">;
|
|
795
796
|
/** How long to wait for the element before applying fallback. */
|
|
@@ -803,7 +804,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
803
804
|
}, "strip", z.ZodTypeAny, {
|
|
804
805
|
selectors: {
|
|
805
806
|
value: string;
|
|
806
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
807
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
807
808
|
label?: string | undefined;
|
|
808
809
|
}[];
|
|
809
810
|
waitMs: number;
|
|
@@ -813,7 +814,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
813
814
|
}, {
|
|
814
815
|
selectors: {
|
|
815
816
|
value: string;
|
|
816
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
817
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
817
818
|
label?: string | undefined;
|
|
818
819
|
}[];
|
|
819
820
|
waitMs?: number | undefined;
|
|
@@ -909,7 +910,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
909
910
|
target?: {
|
|
910
911
|
selectors: {
|
|
911
912
|
value: string;
|
|
912
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
913
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
913
914
|
label?: string | undefined;
|
|
914
915
|
}[];
|
|
915
916
|
waitMs: number;
|
|
@@ -945,7 +946,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
945
946
|
target?: {
|
|
946
947
|
selectors: {
|
|
947
948
|
value: string;
|
|
948
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
949
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
949
950
|
label?: string | undefined;
|
|
950
951
|
}[];
|
|
951
952
|
waitMs?: number | undefined;
|
|
@@ -1158,11 +1159,11 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1158
1159
|
value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString, "many">]>;
|
|
1159
1160
|
}, "strip", z.ZodTypeAny, {
|
|
1160
1161
|
value: string | number | string[];
|
|
1161
|
-
op: "equals" | "
|
|
1162
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
1162
1163
|
questionId: string;
|
|
1163
1164
|
}, {
|
|
1164
1165
|
value: string | number | string[];
|
|
1165
|
-
op: "equals" | "
|
|
1166
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
1166
1167
|
questionId: string;
|
|
1167
1168
|
}>>;
|
|
1168
1169
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -1181,7 +1182,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1181
1182
|
placeholder?: string | undefined;
|
|
1182
1183
|
showWhen?: {
|
|
1183
1184
|
value: string | number | string[];
|
|
1184
|
-
op: "equals" | "
|
|
1185
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
1185
1186
|
questionId: string;
|
|
1186
1187
|
} | undefined;
|
|
1187
1188
|
}, {
|
|
@@ -1200,7 +1201,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1200
1201
|
placeholder?: string | undefined;
|
|
1201
1202
|
showWhen?: {
|
|
1202
1203
|
value: string | number | string[];
|
|
1203
|
-
op: "equals" | "
|
|
1204
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
1204
1205
|
questionId: string;
|
|
1205
1206
|
} | undefined;
|
|
1206
1207
|
}>, "many">;
|
|
@@ -1227,7 +1228,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1227
1228
|
placeholder?: string | undefined;
|
|
1228
1229
|
showWhen?: {
|
|
1229
1230
|
value: string | number | string[];
|
|
1230
|
-
op: "equals" | "
|
|
1231
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
1231
1232
|
questionId: string;
|
|
1232
1233
|
} | undefined;
|
|
1233
1234
|
}[];
|
|
@@ -1252,7 +1253,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1252
1253
|
placeholder?: string | undefined;
|
|
1253
1254
|
showWhen?: {
|
|
1254
1255
|
value: string | number | string[];
|
|
1255
|
-
op: "equals" | "
|
|
1256
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
1256
1257
|
questionId: string;
|
|
1257
1258
|
} | undefined;
|
|
1258
1259
|
}[];
|
|
@@ -1262,8 +1263,10 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1262
1263
|
startAt?: string | undefined;
|
|
1263
1264
|
endAt?: string | undefined;
|
|
1264
1265
|
}>>;
|
|
1265
|
-
/** Restrict guide to url pattern(s) (applied before trigger). */
|
|
1266
|
+
/** Restrict guide to url pattern(s) (applied before trigger). On mobile these match the screen path `/<Screen>`. */
|
|
1266
1267
|
urlPatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
1268
|
+
/** Platforms that receive this guide. Guides created before mobile support are web-only. */
|
|
1269
|
+
platforms: z.ZodDefault<z.ZodArray<z.ZodEnum<["web", "ios", "android"]>, "many">>;
|
|
1267
1270
|
}, "strip", z.ZodTypeAny, {
|
|
1268
1271
|
targeting: RuleGroup;
|
|
1269
1272
|
steps: {
|
|
@@ -1303,7 +1306,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1303
1306
|
target?: {
|
|
1304
1307
|
selectors: {
|
|
1305
1308
|
value: string;
|
|
1306
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
1309
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
1307
1310
|
label?: string | undefined;
|
|
1308
1311
|
}[];
|
|
1309
1312
|
waitMs: number;
|
|
@@ -1345,6 +1348,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1345
1348
|
preset?: string | undefined;
|
|
1346
1349
|
};
|
|
1347
1350
|
urlPatterns: string[];
|
|
1351
|
+
platforms: ("web" | "ios" | "android")[];
|
|
1348
1352
|
checklist?: {
|
|
1349
1353
|
position: "bottom-left" | "bottom-right";
|
|
1350
1354
|
tasks: {
|
|
@@ -1382,7 +1386,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1382
1386
|
placeholder?: string | undefined;
|
|
1383
1387
|
showWhen?: {
|
|
1384
1388
|
value: string | number | string[];
|
|
1385
|
-
op: "equals" | "
|
|
1389
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
1386
1390
|
questionId: string;
|
|
1387
1391
|
} | undefined;
|
|
1388
1392
|
}[];
|
|
@@ -1428,7 +1432,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1428
1432
|
placeholder?: string | undefined;
|
|
1429
1433
|
showWhen?: {
|
|
1430
1434
|
value: string | number | string[];
|
|
1431
|
-
op: "equals" | "
|
|
1435
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
1432
1436
|
questionId: string;
|
|
1433
1437
|
} | undefined;
|
|
1434
1438
|
}[];
|
|
@@ -1462,7 +1466,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1462
1466
|
target?: {
|
|
1463
1467
|
selectors: {
|
|
1464
1468
|
value: string;
|
|
1465
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
1469
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
1466
1470
|
label?: string | undefined;
|
|
1467
1471
|
}[];
|
|
1468
1472
|
waitMs?: number | undefined;
|
|
@@ -1518,6 +1522,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1518
1522
|
animation?: "none" | "fade" | "slide" | undefined;
|
|
1519
1523
|
} | undefined;
|
|
1520
1524
|
urlPatterns?: string[] | undefined;
|
|
1525
|
+
platforms?: ("web" | "ios" | "android")[] | undefined;
|
|
1521
1526
|
}>;
|
|
1522
1527
|
type GuideConfig = z.infer<typeof GuideConfigSchema>;
|
|
1523
1528
|
type GuideConfigInput = z.input<typeof GuideConfigSchema>;
|
|
@@ -1567,13 +1572,15 @@ declare const ProjectThemeSchema: z.ZodObject<{
|
|
|
1567
1572
|
brandName?: string | undefined;
|
|
1568
1573
|
}>;
|
|
1569
1574
|
|
|
1570
|
-
declare const EVENT_NAMES: readonly ["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned", "checklist_task_completed", "checklist_completed", "checklist_dismissed", "survey_displayed", "survey_submitted", "survey_dismissed", "resource_center_opened", "article_viewed", "messenger_opened", "conversation_started", "conversation_handed_off", "scout_answered", "custom", "page_view", "identify"];
|
|
1575
|
+
declare const EVENT_NAMES: readonly ["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned", "checklist_task_completed", "checklist_completed", "checklist_dismissed", "survey_displayed", "survey_submitted", "survey_dismissed", "resource_center_opened", "article_viewed", "messenger_opened", "conversation_started", "conversation_handed_off", "scout_answered", "custom", "page_view", "identify", "page_leave", "click", "rage_click", "exception", "heatmap"];
|
|
1571
1576
|
type EventName = (typeof EVENT_NAMES)[number];
|
|
1577
|
+
/** Events the SDK records on its own (page analytics, click autocapture, error tracking). */
|
|
1578
|
+
declare const AUTOCAPTURE_EVENTS: readonly ["page_view", "page_leave", "click", "rage_click", "exception", "heatmap"];
|
|
1572
1579
|
declare const GUIDE_LIFECYCLE_EVENTS: readonly ["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned"];
|
|
1573
1580
|
/** Event as produced by the SDK and accepted by POST /api/v1/sdk/events */
|
|
1574
1581
|
declare const SdkEventSchema: z.ZodObject<{
|
|
1575
1582
|
eventId: z.ZodString;
|
|
1576
|
-
name: z.ZodEnum<["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned", "checklist_task_completed", "checklist_completed", "checklist_dismissed", "survey_displayed", "survey_submitted", "survey_dismissed", "resource_center_opened", "article_viewed", "messenger_opened", "conversation_started", "conversation_handed_off", "scout_answered", "custom", "page_view", "identify"]>;
|
|
1583
|
+
name: z.ZodEnum<["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned", "checklist_task_completed", "checklist_completed", "checklist_dismissed", "survey_displayed", "survey_submitted", "survey_dismissed", "resource_center_opened", "article_viewed", "messenger_opened", "conversation_started", "conversation_handed_off", "scout_answered", "custom", "page_view", "identify", "page_leave", "click", "rage_click", "exception", "heatmap"]>;
|
|
1577
1584
|
/** For `custom` events: the application-defined name. */
|
|
1578
1585
|
customName: z.ZodOptional<z.ZodString>;
|
|
1579
1586
|
occurredAt: z.ZodString;
|
|
@@ -1589,7 +1596,7 @@ declare const SdkEventSchema: z.ZodObject<{
|
|
|
1589
1596
|
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1590
1597
|
}, "strip", z.ZodTypeAny, {
|
|
1591
1598
|
eventId: string;
|
|
1592
|
-
name: "custom" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify";
|
|
1599
|
+
name: "custom" | "click" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify" | "page_leave" | "rage_click" | "exception" | "heatmap";
|
|
1593
1600
|
occurredAt: string;
|
|
1594
1601
|
anonymousId: string;
|
|
1595
1602
|
url?: string | undefined;
|
|
@@ -1604,7 +1611,7 @@ declare const SdkEventSchema: z.ZodObject<{
|
|
|
1604
1611
|
properties?: Record<string, unknown> | undefined;
|
|
1605
1612
|
}, {
|
|
1606
1613
|
eventId: string;
|
|
1607
|
-
name: "custom" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify";
|
|
1614
|
+
name: "custom" | "click" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify" | "page_leave" | "rage_click" | "exception" | "heatmap";
|
|
1608
1615
|
occurredAt: string;
|
|
1609
1616
|
anonymousId: string;
|
|
1610
1617
|
url?: string | undefined;
|
|
@@ -1622,7 +1629,7 @@ type SdkEvent = z.infer<typeof SdkEventSchema>;
|
|
|
1622
1629
|
declare const EventBatchSchema: z.ZodObject<{
|
|
1623
1630
|
events: z.ZodArray<z.ZodObject<{
|
|
1624
1631
|
eventId: z.ZodString;
|
|
1625
|
-
name: z.ZodEnum<["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned", "checklist_task_completed", "checklist_completed", "checklist_dismissed", "survey_displayed", "survey_submitted", "survey_dismissed", "resource_center_opened", "article_viewed", "messenger_opened", "conversation_started", "conversation_handed_off", "scout_answered", "custom", "page_view", "identify"]>;
|
|
1632
|
+
name: z.ZodEnum<["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned", "checklist_task_completed", "checklist_completed", "checklist_dismissed", "survey_displayed", "survey_submitted", "survey_dismissed", "resource_center_opened", "article_viewed", "messenger_opened", "conversation_started", "conversation_handed_off", "scout_answered", "custom", "page_view", "identify", "page_leave", "click", "rage_click", "exception", "heatmap"]>;
|
|
1626
1633
|
/** For `custom` events: the application-defined name. */
|
|
1627
1634
|
customName: z.ZodOptional<z.ZodString>;
|
|
1628
1635
|
occurredAt: z.ZodString;
|
|
@@ -1638,7 +1645,7 @@ declare const EventBatchSchema: z.ZodObject<{
|
|
|
1638
1645
|
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1639
1646
|
}, "strip", z.ZodTypeAny, {
|
|
1640
1647
|
eventId: string;
|
|
1641
|
-
name: "custom" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify";
|
|
1648
|
+
name: "custom" | "click" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify" | "page_leave" | "rage_click" | "exception" | "heatmap";
|
|
1642
1649
|
occurredAt: string;
|
|
1643
1650
|
anonymousId: string;
|
|
1644
1651
|
url?: string | undefined;
|
|
@@ -1653,7 +1660,7 @@ declare const EventBatchSchema: z.ZodObject<{
|
|
|
1653
1660
|
properties?: Record<string, unknown> | undefined;
|
|
1654
1661
|
}, {
|
|
1655
1662
|
eventId: string;
|
|
1656
|
-
name: "custom" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify";
|
|
1663
|
+
name: "custom" | "click" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify" | "page_leave" | "rage_click" | "exception" | "heatmap";
|
|
1657
1664
|
occurredAt: string;
|
|
1658
1665
|
anonymousId: string;
|
|
1659
1666
|
url?: string | undefined;
|
|
@@ -1681,7 +1688,7 @@ declare const EventBatchSchema: z.ZodObject<{
|
|
|
1681
1688
|
}, "strip", z.ZodTypeAny, {
|
|
1682
1689
|
events: {
|
|
1683
1690
|
eventId: string;
|
|
1684
|
-
name: "custom" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify";
|
|
1691
|
+
name: "custom" | "click" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify" | "page_leave" | "rage_click" | "exception" | "heatmap";
|
|
1685
1692
|
occurredAt: string;
|
|
1686
1693
|
anonymousId: string;
|
|
1687
1694
|
url?: string | undefined;
|
|
@@ -1703,7 +1710,7 @@ declare const EventBatchSchema: z.ZodObject<{
|
|
|
1703
1710
|
}, {
|
|
1704
1711
|
events: {
|
|
1705
1712
|
eventId: string;
|
|
1706
|
-
name: "custom" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify";
|
|
1713
|
+
name: "custom" | "click" | "guide_completed" | "guide_viewed" | "guide_started" | "step_viewed" | "step_completed" | "guide_skipped" | "guide_dismissed" | "guide_abandoned" | "checklist_task_completed" | "checklist_completed" | "checklist_dismissed" | "survey_displayed" | "survey_submitted" | "survey_dismissed" | "resource_center_opened" | "article_viewed" | "messenger_opened" | "conversation_started" | "conversation_handed_off" | "scout_answered" | "page_view" | "identify" | "page_leave" | "rage_click" | "exception" | "heatmap";
|
|
1707
1714
|
occurredAt: string;
|
|
1708
1715
|
anonymousId: string;
|
|
1709
1716
|
url?: string | undefined;
|
|
@@ -1875,6 +1882,257 @@ interface SdkArticlesResponse {
|
|
|
1875
1882
|
articles: SdkArticleSummary[];
|
|
1876
1883
|
}
|
|
1877
1884
|
|
|
1885
|
+
/**
|
|
1886
|
+
* Product-analytics capture settings. Stored on `Project.settings` (keys `autocapture`,
|
|
1887
|
+
* `errorTracking`, `replay`) and delivered to the SDK in `SdkConfigResponse.settings`. The project
|
|
1888
|
+
* setting turns a capability on; SDK options can only turn it off for one installation.
|
|
1889
|
+
*/
|
|
1890
|
+
interface AutocaptureSettings {
|
|
1891
|
+
/** `page_view` on load and on every SPA navigation. */
|
|
1892
|
+
pageviews: boolean;
|
|
1893
|
+
/** `page_leave` with visible time on page and scroll depth. */
|
|
1894
|
+
pageLeave: boolean;
|
|
1895
|
+
/** `click` on buttons, links and other interactive elements. */
|
|
1896
|
+
clicks: boolean;
|
|
1897
|
+
/** `rage_click` when the same spot is clicked 3+ times within a second. */
|
|
1898
|
+
rageClicks: boolean;
|
|
1899
|
+
/** Batched click positions on every element (`heatmap` events) for click heatmaps. */
|
|
1900
|
+
heatmaps: boolean;
|
|
1901
|
+
/** Mouse-movement heatmaps: pointer position sampled while it moves, aggregated in the browser into `heatmap` events. */
|
|
1902
|
+
mouseMovement: boolean;
|
|
1903
|
+
}
|
|
1904
|
+
interface ErrorTrackingSettings {
|
|
1905
|
+
/** Uncaught errors and unhandled promise rejections become `exception` events. */
|
|
1906
|
+
enabled: boolean;
|
|
1907
|
+
}
|
|
1908
|
+
interface ReplaySettings {
|
|
1909
|
+
enabled: boolean;
|
|
1910
|
+
/** Percentage of sessions recorded (0–100), decided once per session. */
|
|
1911
|
+
sampleRate: number;
|
|
1912
|
+
/** Record console.log/warn/error output into the recording. */
|
|
1913
|
+
recordConsole: boolean;
|
|
1914
|
+
/** Record network requests (method, URL with sensitive query values redacted, status, timing, size). */
|
|
1915
|
+
recordNetwork: boolean;
|
|
1916
|
+
/** Also record request/response headers and text/JSON bodies (redacted, ≤10KB each). Off by default. */
|
|
1917
|
+
recordNetworkPayloads: boolean;
|
|
1918
|
+
/** Mask every text node (inputs are always masked). */
|
|
1919
|
+
maskAllText: boolean;
|
|
1920
|
+
/** Elements replaced by a placeholder box in recordings (in addition to `[data-guidely-block]`). */
|
|
1921
|
+
blockSelectors: string[];
|
|
1922
|
+
/** Days recordings are kept before the worker deletes them. */
|
|
1923
|
+
retentionDays: number;
|
|
1924
|
+
}
|
|
1925
|
+
interface CaptureSettings {
|
|
1926
|
+
autocapture: AutocaptureSettings;
|
|
1927
|
+
errorTracking: ErrorTrackingSettings;
|
|
1928
|
+
replay: ReplaySettings;
|
|
1929
|
+
}
|
|
1930
|
+
declare const AutocaptureSettingsSchema: z.ZodObject<{
|
|
1931
|
+
pageviews: z.ZodOptional<z.ZodBoolean>;
|
|
1932
|
+
pageLeave: z.ZodOptional<z.ZodBoolean>;
|
|
1933
|
+
clicks: z.ZodOptional<z.ZodBoolean>;
|
|
1934
|
+
rageClicks: z.ZodOptional<z.ZodBoolean>;
|
|
1935
|
+
heatmaps: z.ZodOptional<z.ZodBoolean>;
|
|
1936
|
+
mouseMovement: z.ZodOptional<z.ZodBoolean>;
|
|
1937
|
+
}, "strip", z.ZodTypeAny, {
|
|
1938
|
+
pageviews?: boolean | undefined;
|
|
1939
|
+
pageLeave?: boolean | undefined;
|
|
1940
|
+
clicks?: boolean | undefined;
|
|
1941
|
+
rageClicks?: boolean | undefined;
|
|
1942
|
+
heatmaps?: boolean | undefined;
|
|
1943
|
+
mouseMovement?: boolean | undefined;
|
|
1944
|
+
}, {
|
|
1945
|
+
pageviews?: boolean | undefined;
|
|
1946
|
+
pageLeave?: boolean | undefined;
|
|
1947
|
+
clicks?: boolean | undefined;
|
|
1948
|
+
rageClicks?: boolean | undefined;
|
|
1949
|
+
heatmaps?: boolean | undefined;
|
|
1950
|
+
mouseMovement?: boolean | undefined;
|
|
1951
|
+
}>;
|
|
1952
|
+
declare const ErrorTrackingSettingsSchema: z.ZodObject<{
|
|
1953
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
1954
|
+
}, "strip", z.ZodTypeAny, {
|
|
1955
|
+
enabled?: boolean | undefined;
|
|
1956
|
+
}, {
|
|
1957
|
+
enabled?: boolean | undefined;
|
|
1958
|
+
}>;
|
|
1959
|
+
declare const ReplaySettingsSchema: z.ZodObject<{
|
|
1960
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
1961
|
+
sampleRate: z.ZodOptional<z.ZodNumber>;
|
|
1962
|
+
recordConsole: z.ZodOptional<z.ZodBoolean>;
|
|
1963
|
+
recordNetwork: z.ZodOptional<z.ZodBoolean>;
|
|
1964
|
+
recordNetworkPayloads: z.ZodOptional<z.ZodBoolean>;
|
|
1965
|
+
maskAllText: z.ZodOptional<z.ZodBoolean>;
|
|
1966
|
+
blockSelectors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1967
|
+
retentionDays: z.ZodOptional<z.ZodNumber>;
|
|
1968
|
+
}, "strip", z.ZodTypeAny, {
|
|
1969
|
+
enabled?: boolean | undefined;
|
|
1970
|
+
sampleRate?: number | undefined;
|
|
1971
|
+
recordConsole?: boolean | undefined;
|
|
1972
|
+
recordNetwork?: boolean | undefined;
|
|
1973
|
+
recordNetworkPayloads?: boolean | undefined;
|
|
1974
|
+
maskAllText?: boolean | undefined;
|
|
1975
|
+
blockSelectors?: string[] | undefined;
|
|
1976
|
+
retentionDays?: number | undefined;
|
|
1977
|
+
}, {
|
|
1978
|
+
enabled?: boolean | undefined;
|
|
1979
|
+
sampleRate?: number | undefined;
|
|
1980
|
+
recordConsole?: boolean | undefined;
|
|
1981
|
+
recordNetwork?: boolean | undefined;
|
|
1982
|
+
recordNetworkPayloads?: boolean | undefined;
|
|
1983
|
+
maskAllText?: boolean | undefined;
|
|
1984
|
+
blockSelectors?: string[] | undefined;
|
|
1985
|
+
retentionDays?: number | undefined;
|
|
1986
|
+
}>;
|
|
1987
|
+
declare const DEFAULT_CAPTURE_SETTINGS: CaptureSettings;
|
|
1988
|
+
/** Fills defaults for whatever a project's stored settings leave out. */
|
|
1989
|
+
declare function resolveCaptureSettings(settings: unknown): CaptureSettings;
|
|
1990
|
+
/**
|
|
1991
|
+
* One position in a `heatmap` event (`properties.points`). `x`/`y` are page coordinates in CSS
|
|
1992
|
+
* pixels; `s` is a stable selector for the element and `rx`/`ry` the position inside it (0–1), which
|
|
1993
|
+
* lets the dashboard place the point on the element even when layouts differ.
|
|
1994
|
+
*
|
|
1995
|
+
* Mouse movement (`k: "m"`) is sampled at most every 200ms while the pointer moves and binned in the
|
|
1996
|
+
* browser (per element at 0.1 of `rx`/`ry`, else on a 16px page grid); `w` is the number of samples
|
|
1997
|
+
* in the bin, so a minute of movement costs a few dozen points rather than thousands.
|
|
1998
|
+
*/
|
|
1999
|
+
interface HeatmapPoint {
|
|
2000
|
+
/** `c` click, `r` part of a rage-click burst, `m` mouse movement. */
|
|
2001
|
+
k: "c" | "r" | "m";
|
|
2002
|
+
x: number;
|
|
2003
|
+
y: number;
|
|
2004
|
+
s?: string;
|
|
2005
|
+
rx?: number;
|
|
2006
|
+
ry?: number;
|
|
2007
|
+
/** Weight: samples aggregated into this point (movement only; clicks are 1). */
|
|
2008
|
+
w?: number;
|
|
2009
|
+
}
|
|
2010
|
+
/** Properties of a `heatmap` event: a batch of clicks on one page (flushed at ~40 points and on page leave). */
|
|
2011
|
+
interface HeatmapProperties {
|
|
2012
|
+
path?: string;
|
|
2013
|
+
viewportWidth: number;
|
|
2014
|
+
viewportHeight: number;
|
|
2015
|
+
/** Document scroll height when the batch was sent. */
|
|
2016
|
+
pageHeight: number;
|
|
2017
|
+
points: HeatmapPoint[];
|
|
2018
|
+
}
|
|
2019
|
+
/** Viewport buckets heatmaps are split by (CSS px of `viewportWidth`). */
|
|
2020
|
+
declare const HEATMAP_VIEWPORTS: {
|
|
2021
|
+
readonly mobile: readonly [0, 767];
|
|
2022
|
+
readonly tablet: readonly [768, 1279];
|
|
2023
|
+
readonly desktop: readonly [1280, 100000];
|
|
2024
|
+
};
|
|
2025
|
+
type HeatmapViewport = keyof typeof HEATMAP_VIEWPORTS;
|
|
2026
|
+
/**
|
|
2027
|
+
* One upload of rrweb events for a recording, `POST /api/v1/sdk/replay`. The SDK sends it as JSON,
|
|
2028
|
+
* or gzip-compressed JSON with `?enc=gzip`. A recording is keyed by the SDK session id; every page
|
|
2029
|
+
* load starts a new `windowId` whose uploads are numbered by `seq`.
|
|
2030
|
+
*/
|
|
2031
|
+
declare const ReplayChunkSchema: z.ZodObject<{
|
|
2032
|
+
sessionId: z.ZodString;
|
|
2033
|
+
windowId: z.ZodString;
|
|
2034
|
+
seq: z.ZodNumber;
|
|
2035
|
+
anonymousId: z.ZodString;
|
|
2036
|
+
userId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2037
|
+
/** rrweb `eventWithTime` objects, in order. */
|
|
2038
|
+
events: z.ZodArray<z.ZodObject<{
|
|
2039
|
+
type: z.ZodNumber;
|
|
2040
|
+
timestamp: z.ZodNumber;
|
|
2041
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2042
|
+
type: z.ZodNumber;
|
|
2043
|
+
timestamp: z.ZodNumber;
|
|
2044
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2045
|
+
type: z.ZodNumber;
|
|
2046
|
+
timestamp: z.ZodNumber;
|
|
2047
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
2048
|
+
url: z.ZodOptional<z.ZodString>;
|
|
2049
|
+
device: z.ZodOptional<z.ZodObject<{
|
|
2050
|
+
type: z.ZodString;
|
|
2051
|
+
browser: z.ZodOptional<z.ZodString>;
|
|
2052
|
+
os: z.ZodOptional<z.ZodString>;
|
|
2053
|
+
}, "strip", z.ZodTypeAny, {
|
|
2054
|
+
type: string;
|
|
2055
|
+
browser?: string | undefined;
|
|
2056
|
+
os?: string | undefined;
|
|
2057
|
+
}, {
|
|
2058
|
+
type: string;
|
|
2059
|
+
browser?: string | undefined;
|
|
2060
|
+
os?: string | undefined;
|
|
2061
|
+
}>>;
|
|
2062
|
+
viewport: z.ZodOptional<z.ZodObject<{
|
|
2063
|
+
width: z.ZodNumber;
|
|
2064
|
+
height: z.ZodNumber;
|
|
2065
|
+
}, "strip", z.ZodTypeAny, {
|
|
2066
|
+
width: number;
|
|
2067
|
+
height: number;
|
|
2068
|
+
}, {
|
|
2069
|
+
width: number;
|
|
2070
|
+
height: number;
|
|
2071
|
+
}>>;
|
|
2072
|
+
sdk: z.ZodOptional<z.ZodObject<{
|
|
2073
|
+
name: z.ZodString;
|
|
2074
|
+
version: z.ZodString;
|
|
2075
|
+
}, "strip", z.ZodTypeAny, {
|
|
2076
|
+
name: string;
|
|
2077
|
+
version: string;
|
|
2078
|
+
}, {
|
|
2079
|
+
name: string;
|
|
2080
|
+
version: string;
|
|
2081
|
+
}>>;
|
|
2082
|
+
}, "strip", z.ZodTypeAny, {
|
|
2083
|
+
anonymousId: string;
|
|
2084
|
+
sessionId: string;
|
|
2085
|
+
events: z.objectOutputType<{
|
|
2086
|
+
type: z.ZodNumber;
|
|
2087
|
+
timestamp: z.ZodNumber;
|
|
2088
|
+
}, z.ZodTypeAny, "passthrough">[];
|
|
2089
|
+
windowId: string;
|
|
2090
|
+
seq: number;
|
|
2091
|
+
url?: string | undefined;
|
|
2092
|
+
userId?: string | null | undefined;
|
|
2093
|
+
sdk?: {
|
|
2094
|
+
name: string;
|
|
2095
|
+
version: string;
|
|
2096
|
+
} | undefined;
|
|
2097
|
+
device?: {
|
|
2098
|
+
type: string;
|
|
2099
|
+
browser?: string | undefined;
|
|
2100
|
+
os?: string | undefined;
|
|
2101
|
+
} | undefined;
|
|
2102
|
+
viewport?: {
|
|
2103
|
+
width: number;
|
|
2104
|
+
height: number;
|
|
2105
|
+
} | undefined;
|
|
2106
|
+
}, {
|
|
2107
|
+
anonymousId: string;
|
|
2108
|
+
sessionId: string;
|
|
2109
|
+
events: z.objectInputType<{
|
|
2110
|
+
type: z.ZodNumber;
|
|
2111
|
+
timestamp: z.ZodNumber;
|
|
2112
|
+
}, z.ZodTypeAny, "passthrough">[];
|
|
2113
|
+
windowId: string;
|
|
2114
|
+
seq: number;
|
|
2115
|
+
url?: string | undefined;
|
|
2116
|
+
userId?: string | null | undefined;
|
|
2117
|
+
sdk?: {
|
|
2118
|
+
name: string;
|
|
2119
|
+
version: string;
|
|
2120
|
+
} | undefined;
|
|
2121
|
+
device?: {
|
|
2122
|
+
type: string;
|
|
2123
|
+
browser?: string | undefined;
|
|
2124
|
+
os?: string | undefined;
|
|
2125
|
+
} | undefined;
|
|
2126
|
+
viewport?: {
|
|
2127
|
+
width: number;
|
|
2128
|
+
height: number;
|
|
2129
|
+
} | undefined;
|
|
2130
|
+
}>;
|
|
2131
|
+
type ReplayChunk = z.infer<typeof ReplayChunkSchema>;
|
|
2132
|
+
/** Max upload sizes for one replay chunk (bytes on the wire, and after decompression). */
|
|
2133
|
+
declare const REPLAY_MAX_COMPRESSED_BYTES: number;
|
|
2134
|
+
declare const REPLAY_MAX_RAW_BYTES: number;
|
|
2135
|
+
|
|
1878
2136
|
/** A published guide as delivered to the SDK. Draft-only data (author, notes) is never included. */
|
|
1879
2137
|
interface PublishedGuide {
|
|
1880
2138
|
id: string;
|
|
@@ -1939,6 +2197,11 @@ interface SdkConfigResponse {
|
|
|
1939
2197
|
collectUrls: boolean;
|
|
1940
2198
|
maskSelectors: string[];
|
|
1941
2199
|
sessionTimeoutMinutes: number;
|
|
2200
|
+
/** Product analytics; absent from servers that predate it (the SDK then captures nothing extra). */
|
|
2201
|
+
autocapture?: AutocaptureSettings;
|
|
2202
|
+
errorTracking?: ErrorTrackingSettings;
|
|
2203
|
+
/** `retentionDays` is server-side only and not sent. */
|
|
2204
|
+
replay?: Omit<ReplaySettings, "retentionDays">;
|
|
1942
2205
|
};
|
|
1943
2206
|
generatedAt: string;
|
|
1944
2207
|
}
|
|
@@ -2106,14 +2369,14 @@ declare const AuthoringPickSchema: z.ZodObject<{
|
|
|
2106
2369
|
height: z.ZodNumber;
|
|
2107
2370
|
}, "strip", z.ZodTypeAny, {
|
|
2108
2371
|
width: number;
|
|
2372
|
+
height: number;
|
|
2109
2373
|
x: number;
|
|
2110
2374
|
y: number;
|
|
2111
|
-
height: number;
|
|
2112
2375
|
}, {
|
|
2113
2376
|
width: number;
|
|
2377
|
+
height: number;
|
|
2114
2378
|
x: number;
|
|
2115
2379
|
y: number;
|
|
2116
|
-
height: number;
|
|
2117
2380
|
}>>;
|
|
2118
2381
|
}, "strip", z.ZodTypeAny, {
|
|
2119
2382
|
selectors: {
|
|
@@ -2126,9 +2389,9 @@ declare const AuthoringPickSchema: z.ZodObject<{
|
|
|
2126
2389
|
stepId?: string | undefined;
|
|
2127
2390
|
rect?: {
|
|
2128
2391
|
width: number;
|
|
2392
|
+
height: number;
|
|
2129
2393
|
x: number;
|
|
2130
2394
|
y: number;
|
|
2131
|
-
height: number;
|
|
2132
2395
|
} | undefined;
|
|
2133
2396
|
}, {
|
|
2134
2397
|
selectors: {
|
|
@@ -2141,9 +2404,9 @@ declare const AuthoringPickSchema: z.ZodObject<{
|
|
|
2141
2404
|
stepId?: string | undefined;
|
|
2142
2405
|
rect?: {
|
|
2143
2406
|
width: number;
|
|
2407
|
+
height: number;
|
|
2144
2408
|
x: number;
|
|
2145
2409
|
y: number;
|
|
2146
|
-
height: number;
|
|
2147
2410
|
} | undefined;
|
|
2148
2411
|
}>;
|
|
2149
2412
|
type AuthoringPick = z.infer<typeof AuthoringPickSchema>;
|
|
@@ -2214,16 +2477,16 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2214
2477
|
}>, "many">>;
|
|
2215
2478
|
target: z.ZodOptional<z.ZodObject<{
|
|
2216
2479
|
selectors: z.ZodArray<z.ZodObject<{
|
|
2217
|
-
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath"]>;
|
|
2480
|
+
kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath", "guidely-id"]>;
|
|
2218
2481
|
value: z.ZodString;
|
|
2219
2482
|
label: z.ZodOptional<z.ZodString>;
|
|
2220
2483
|
}, "strip", z.ZodTypeAny, {
|
|
2221
2484
|
value: string;
|
|
2222
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
2485
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2223
2486
|
label?: string | undefined;
|
|
2224
2487
|
}, {
|
|
2225
2488
|
value: string;
|
|
2226
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
2489
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2227
2490
|
label?: string | undefined;
|
|
2228
2491
|
}>, "many">;
|
|
2229
2492
|
waitMs: z.ZodDefault<z.ZodNumber>;
|
|
@@ -2233,7 +2496,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2233
2496
|
}, "strip", z.ZodTypeAny, {
|
|
2234
2497
|
selectors: {
|
|
2235
2498
|
value: string;
|
|
2236
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
2499
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2237
2500
|
label?: string | undefined;
|
|
2238
2501
|
}[];
|
|
2239
2502
|
waitMs: number;
|
|
@@ -2243,7 +2506,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2243
2506
|
}, {
|
|
2244
2507
|
selectors: {
|
|
2245
2508
|
value: string;
|
|
2246
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
2509
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2247
2510
|
label?: string | undefined;
|
|
2248
2511
|
}[];
|
|
2249
2512
|
waitMs?: number | undefined;
|
|
@@ -2329,7 +2592,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2329
2592
|
target?: {
|
|
2330
2593
|
selectors: {
|
|
2331
2594
|
value: string;
|
|
2332
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
2595
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2333
2596
|
label?: string | undefined;
|
|
2334
2597
|
}[];
|
|
2335
2598
|
waitMs: number;
|
|
@@ -2365,7 +2628,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2365
2628
|
target?: {
|
|
2366
2629
|
selectors: {
|
|
2367
2630
|
value: string;
|
|
2368
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
2631
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2369
2632
|
label?: string | undefined;
|
|
2370
2633
|
}[];
|
|
2371
2634
|
waitMs?: number | undefined;
|
|
@@ -2569,11 +2832,11 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2569
2832
|
value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString, "many">]>;
|
|
2570
2833
|
}, "strip", z.ZodTypeAny, {
|
|
2571
2834
|
value: string | number | string[];
|
|
2572
|
-
op: "equals" | "
|
|
2835
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
2573
2836
|
questionId: string;
|
|
2574
2837
|
}, {
|
|
2575
2838
|
value: string | number | string[];
|
|
2576
|
-
op: "equals" | "
|
|
2839
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
2577
2840
|
questionId: string;
|
|
2578
2841
|
}>>;
|
|
2579
2842
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -2592,7 +2855,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2592
2855
|
placeholder?: string | undefined;
|
|
2593
2856
|
showWhen?: {
|
|
2594
2857
|
value: string | number | string[];
|
|
2595
|
-
op: "equals" | "
|
|
2858
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
2596
2859
|
questionId: string;
|
|
2597
2860
|
} | undefined;
|
|
2598
2861
|
}, {
|
|
@@ -2611,7 +2874,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2611
2874
|
placeholder?: string | undefined;
|
|
2612
2875
|
showWhen?: {
|
|
2613
2876
|
value: string | number | string[];
|
|
2614
|
-
op: "equals" | "
|
|
2877
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
2615
2878
|
questionId: string;
|
|
2616
2879
|
} | undefined;
|
|
2617
2880
|
}>, "many">;
|
|
@@ -2638,7 +2901,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2638
2901
|
placeholder?: string | undefined;
|
|
2639
2902
|
showWhen?: {
|
|
2640
2903
|
value: string | number | string[];
|
|
2641
|
-
op: "equals" | "
|
|
2904
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
2642
2905
|
questionId: string;
|
|
2643
2906
|
} | undefined;
|
|
2644
2907
|
}[];
|
|
@@ -2663,7 +2926,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2663
2926
|
placeholder?: string | undefined;
|
|
2664
2927
|
showWhen?: {
|
|
2665
2928
|
value: string | number | string[];
|
|
2666
|
-
op: "equals" | "
|
|
2929
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
2667
2930
|
questionId: string;
|
|
2668
2931
|
} | undefined;
|
|
2669
2932
|
}[];
|
|
@@ -2674,6 +2937,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2674
2937
|
endAt?: string | undefined;
|
|
2675
2938
|
}>>;
|
|
2676
2939
|
urlPatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
2940
|
+
platforms: z.ZodDefault<z.ZodArray<z.ZodEnum<["web", "ios", "android"]>, "many">>;
|
|
2677
2941
|
}, "strip", z.ZodTypeAny, {
|
|
2678
2942
|
targeting: RuleGroup;
|
|
2679
2943
|
steps: {
|
|
@@ -2713,7 +2977,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2713
2977
|
target?: {
|
|
2714
2978
|
selectors: {
|
|
2715
2979
|
value: string;
|
|
2716
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
2980
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2717
2981
|
label?: string | undefined;
|
|
2718
2982
|
}[];
|
|
2719
2983
|
waitMs: number;
|
|
@@ -2755,6 +3019,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2755
3019
|
preset?: string | undefined;
|
|
2756
3020
|
};
|
|
2757
3021
|
urlPatterns: string[];
|
|
3022
|
+
platforms: ("web" | "ios" | "android")[];
|
|
2758
3023
|
checklist?: {
|
|
2759
3024
|
position: "bottom-left" | "bottom-right";
|
|
2760
3025
|
tasks: {
|
|
@@ -2792,7 +3057,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2792
3057
|
placeholder?: string | undefined;
|
|
2793
3058
|
showWhen?: {
|
|
2794
3059
|
value: string | number | string[];
|
|
2795
|
-
op: "equals" | "
|
|
3060
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
2796
3061
|
questionId: string;
|
|
2797
3062
|
} | undefined;
|
|
2798
3063
|
}[];
|
|
@@ -2838,7 +3103,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2838
3103
|
placeholder?: string | undefined;
|
|
2839
3104
|
showWhen?: {
|
|
2840
3105
|
value: string | number | string[];
|
|
2841
|
-
op: "equals" | "
|
|
3106
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
2842
3107
|
questionId: string;
|
|
2843
3108
|
} | undefined;
|
|
2844
3109
|
}[];
|
|
@@ -2872,7 +3137,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2872
3137
|
target?: {
|
|
2873
3138
|
selectors: {
|
|
2874
3139
|
value: string;
|
|
2875
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
3140
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2876
3141
|
label?: string | undefined;
|
|
2877
3142
|
}[];
|
|
2878
3143
|
waitMs?: number | undefined;
|
|
@@ -2928,6 +3193,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2928
3193
|
animation?: "none" | "fade" | "slide" | undefined;
|
|
2929
3194
|
} | undefined;
|
|
2930
3195
|
urlPatterns?: string[] | undefined;
|
|
3196
|
+
platforms?: ("web" | "ios" | "android")[] | undefined;
|
|
2931
3197
|
}>;
|
|
2932
3198
|
publishedAt: z.ZodString;
|
|
2933
3199
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -2975,7 +3241,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
2975
3241
|
target?: {
|
|
2976
3242
|
selectors: {
|
|
2977
3243
|
value: string;
|
|
2978
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
3244
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
2979
3245
|
label?: string | undefined;
|
|
2980
3246
|
}[];
|
|
2981
3247
|
waitMs: number;
|
|
@@ -3017,6 +3283,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3017
3283
|
preset?: string | undefined;
|
|
3018
3284
|
};
|
|
3019
3285
|
urlPatterns: string[];
|
|
3286
|
+
platforms: ("web" | "ios" | "android")[];
|
|
3020
3287
|
checklist?: {
|
|
3021
3288
|
position: "bottom-left" | "bottom-right";
|
|
3022
3289
|
tasks: {
|
|
@@ -3054,7 +3321,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3054
3321
|
placeholder?: string | undefined;
|
|
3055
3322
|
showWhen?: {
|
|
3056
3323
|
value: string | number | string[];
|
|
3057
|
-
op: "equals" | "
|
|
3324
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
3058
3325
|
questionId: string;
|
|
3059
3326
|
} | undefined;
|
|
3060
3327
|
}[];
|
|
@@ -3108,7 +3375,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3108
3375
|
placeholder?: string | undefined;
|
|
3109
3376
|
showWhen?: {
|
|
3110
3377
|
value: string | number | string[];
|
|
3111
|
-
op: "equals" | "
|
|
3378
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
3112
3379
|
questionId: string;
|
|
3113
3380
|
} | undefined;
|
|
3114
3381
|
}[];
|
|
@@ -3142,7 +3409,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3142
3409
|
target?: {
|
|
3143
3410
|
selectors: {
|
|
3144
3411
|
value: string;
|
|
3145
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
3412
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
3146
3413
|
label?: string | undefined;
|
|
3147
3414
|
}[];
|
|
3148
3415
|
waitMs?: number | undefined;
|
|
@@ -3198,6 +3465,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3198
3465
|
animation?: "none" | "fade" | "slide" | undefined;
|
|
3199
3466
|
} | undefined;
|
|
3200
3467
|
urlPatterns?: string[] | undefined;
|
|
3468
|
+
platforms?: ("web" | "ios" | "android")[] | undefined;
|
|
3201
3469
|
};
|
|
3202
3470
|
publishedAt: string;
|
|
3203
3471
|
}>;
|
|
@@ -3259,7 +3527,7 @@ declare function templateConfig(id: string): {
|
|
|
3259
3527
|
target?: {
|
|
3260
3528
|
selectors: {
|
|
3261
3529
|
value: string;
|
|
3262
|
-
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath";
|
|
3530
|
+
kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
|
|
3263
3531
|
label?: string | undefined;
|
|
3264
3532
|
}[];
|
|
3265
3533
|
waitMs: number;
|
|
@@ -3301,6 +3569,7 @@ declare function templateConfig(id: string): {
|
|
|
3301
3569
|
preset?: string | undefined;
|
|
3302
3570
|
};
|
|
3303
3571
|
urlPatterns: string[];
|
|
3572
|
+
platforms: ("web" | "ios" | "android")[];
|
|
3304
3573
|
checklist?: {
|
|
3305
3574
|
position: "bottom-left" | "bottom-right";
|
|
3306
3575
|
tasks: {
|
|
@@ -3338,7 +3607,7 @@ declare function templateConfig(id: string): {
|
|
|
3338
3607
|
placeholder?: string | undefined;
|
|
3339
3608
|
showWhen?: {
|
|
3340
3609
|
value: string | number | string[];
|
|
3341
|
-
op: "equals" | "
|
|
3610
|
+
op: "equals" | "lte" | "gte" | "in";
|
|
3342
3611
|
questionId: string;
|
|
3343
3612
|
} | undefined;
|
|
3344
3613
|
}[];
|
|
@@ -3351,6 +3620,6 @@ declare function templateConfig(id: string): {
|
|
|
3351
3620
|
} | null;
|
|
3352
3621
|
|
|
3353
3622
|
declare const SDK_API_VERSION = "v1";
|
|
3354
|
-
declare const SHARED_VERSION = "0.
|
|
3623
|
+
declare const SHARED_VERSION = "0.4.1";
|
|
3355
3624
|
|
|
3356
|
-
export { ADVANCE_ON, type ApiError, type AppSnapshot, type Appearance, AppearanceSchema, type AuthoringPick, AuthoringPickSchema, type AuthoringSessionInfo, BUTTON_ACTIONS, ButtonSchema, type ChecklistConfig, ChecklistConfigSchema, type ChecklistProgressRequest, ChecklistProgressRequestSchema, type ChecklistTask, ChecklistTaskSchema, type ConversationLookupResponse, ConversationLookupSchema, type ConversationMessagesResponse, ConversationRatingSchema, type ConversationStatus, EVENT_NAMES, type EventBatch, EventBatchSchema, type EventName, type FrequencyConfig, FrequencySchema, GUIDE_KINDS, GUIDE_LIFECYCLE_EVENTS, GUIDE_STATUSES, GUIDE_TEMPLATES, type GuideConfig, type GuideConfigInput, GuideConfigSchema, type GuideKind, GuideStateUpdateSchema, type GuideStatus, type GuideStep, type GuideStepInput, type GuideTemplate, type IdentifyRequest, IdentifyRequestSchema, type IdentifyResponse, MAX_MESSAGE_LENGTH, MESSAGE_AUTHORS, type MessageAuthor, type MessengerCitation, type MessengerConfig, type MessengerConversation, type MessengerMessage, type MessengerSuggestedGuide, PLACEMENTS, type Placement, PostMessageSchema, type ProjectTheme, ProjectThemeSchema, type PublishedGuide, PublishedGuideSchema, type ResourceCenterArticle, type ResourceCenterConfig, Rule, RuleGroup, RuleGroupSchema, RuleSchema, SDK_API_VERSION, SELECTOR_KINDS, SHARED_VERSION, STEP_TYPES, SURVEY_QUESTION_TYPES, type ScoutStreamEvent, type SdkArticleSummary, type SdkArticlesResponse, type SdkConfigResponse, type SdkEvent, SdkEventSchema, type SelectorStrategy, SelectorStrategySchema, type StartConversationRequest, type StartConversationResponse, StartConversationSchema, StepBranchSchema, type StepButton, StepSchema, type StepTarget, type StepType, type SurveyConfig, SurveyConfigSchema, type SurveyQuestion, SurveyQuestionSchema, type SurveyResponseRequest, SurveyResponseRequestSchema, TRIGGER_TYPES, TargetSchema, type TriggerConfig, TriggerSchema, type ValidationIssue, defaultGuideConfig, defaultStep, templateConfig, validateGuideConfig, visibleButtons };
|
|
3625
|
+
export { ADVANCE_ON, AUTOCAPTURE_EVENTS, type ApiError, type AppSnapshot, type Appearance, AppearanceSchema, type AuthoringPick, AuthoringPickSchema, type AuthoringSessionInfo, type AutocaptureSettings, AutocaptureSettingsSchema, BUTTON_ACTIONS, ButtonSchema, type CaptureSettings, type ChecklistConfig, ChecklistConfigSchema, type ChecklistProgressRequest, ChecklistProgressRequestSchema, type ChecklistTask, ChecklistTaskSchema, type ConversationLookupResponse, ConversationLookupSchema, type ConversationMessagesResponse, ConversationRatingSchema, type ConversationStatus, DEFAULT_CAPTURE_SETTINGS, EVENT_NAMES, type ErrorTrackingSettings, ErrorTrackingSettingsSchema, type EventBatch, EventBatchSchema, type EventName, type FrequencyConfig, FrequencySchema, GUIDE_KINDS, GUIDE_LIFECYCLE_EVENTS, GUIDE_STATUSES, GUIDE_TEMPLATES, type GuideConfig, type GuideConfigInput, GuideConfigSchema, type GuideKind, GuideStateUpdateSchema, type GuideStatus, type GuideStep, type GuideStepInput, type GuideTemplate, HEATMAP_VIEWPORTS, type HeatmapPoint, type HeatmapProperties, type HeatmapViewport, type IdentifyRequest, IdentifyRequestSchema, type IdentifyResponse, MAX_MESSAGE_LENGTH, MESSAGE_AUTHORS, type MessageAuthor, type MessengerCitation, type MessengerConfig, type MessengerConversation, type MessengerMessage, type MessengerSuggestedGuide, PLACEMENTS, type Placement, PostMessageSchema, type ProjectTheme, ProjectThemeSchema, type PublishedGuide, PublishedGuideSchema, REPLAY_MAX_COMPRESSED_BYTES, REPLAY_MAX_RAW_BYTES, type ReplayChunk, ReplayChunkSchema, type ReplaySettings, ReplaySettingsSchema, type ResourceCenterArticle, type ResourceCenterConfig, Rule, RuleGroup, RuleGroupSchema, RuleSchema, SDK_API_VERSION, SELECTOR_KINDS, SHARED_VERSION, STEP_TYPES, SURVEY_QUESTION_TYPES, type ScoutStreamEvent, type SdkArticleSummary, type SdkArticlesResponse, type SdkConfigResponse, type SdkEvent, SdkEventSchema, type SelectorStrategy, SelectorStrategySchema, type StartConversationRequest, type StartConversationResponse, StartConversationSchema, StepBranchSchema, type StepButton, StepSchema, type StepTarget, type StepType, type SurveyConfig, SurveyConfigSchema, type SurveyQuestion, SurveyQuestionSchema, type SurveyResponseRequest, SurveyResponseRequestSchema, TRIGGER_TYPES, TargetSchema, type TriggerConfig, TriggerSchema, type ValidationIssue, defaultGuideConfig, defaultStep, resolveCaptureSettings, templateConfig, validateGuideConfig, visibleButtons };
|