@guidelytech/shared 0.8.0 → 0.9.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/chunk-UW6NRYRY.js +809 -0
- package/dist/chunk-UW6NRYRY.js.map +1 -0
- package/dist/index.cjs +189 -60
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +97 -6
- package/dist/index.d.ts +97 -6
- package/dist/index.js +121 -53
- package/dist/index.js.map +1 -1
- package/dist/runtime.cjs +110 -8
- package/dist/runtime.cjs.map +1 -1
- package/dist/runtime.d.cts +106 -5
- package/dist/runtime.d.ts +106 -5
- package/dist/runtime.js +47 -3
- package/package.json +4 -4
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { RuleGroup, Rule } from './runtime.cjs';
|
|
2
|
-
export { CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, EmbedProvider, ExceptionProperties, FILE_LINK_CLASS, GUIDELY_ID_ATTRIBUTE, MAX_COLLECTION_DEPTH, MAX_PROPERTY_BYTES, MAX_STACK_FRAMES, MEDIA_FILE_MAX_BYTES, MEDIA_FILE_TYPES, MEDIA_IMAGE_MAX_BYTES, MEDIA_IMAGE_TYPES, MEDIA_MAX_BYTES, MEDIA_VIDEO_MAX_BYTES, MEDIA_VIDEO_TYPES, MediaContentType, MediaKind, NETWORK_PLUGIN, NetworkPluginPayload, NetworkRequest, NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, Platform, RULE_FIELDS, RULE_OPERATORS, RcArticleLike, RcCollectionLike, RcSection, 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, VIDEO_ATTRS, VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, WebSocketMessage, clamp, compare, compareVersions, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds } from './runtime.cjs';
|
|
1
|
+
import { RuleGroup, Rule, MessengerComplaint, MessengerComplaintOffer, MessengerComplaintsConfig } from './runtime.cjs';
|
|
2
|
+
export { ARTICLE_VISIBILITIES, ArticleVisibility, CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, COMPLAINT_EVENTS, COMPLAINT_FIELD_TYPES, COMPLAINT_STATUSES, ComplaintEvent, ComplaintField, ComplaintFieldType, ComplaintStatus, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, EmbedProvider, ExceptionProperties, FILE_LINK_CLASS, GUIDELY_ID_ATTRIBUTE, GUIDE_VISIBILITIES, GuideVisibility, LOGGED_IN_AUDIENCE, MAX_COLLECTION_DEPTH, MAX_COMPLAINT_ANSWER_LENGTH, MAX_COMPLAINT_ATTACHMENT_BYTES, MAX_COMPLAINT_CHOICES, MAX_COMPLAINT_FIELDS, MAX_COMPLAINT_LENGTH, MAX_PROPERTY_BYTES, MAX_STACK_FRAMES, MEDIA_FILE_MAX_BYTES, MEDIA_FILE_TYPES, MEDIA_IMAGE_MAX_BYTES, MEDIA_IMAGE_TYPES, MEDIA_MAX_BYTES, MEDIA_VIDEO_MAX_BYTES, MEDIA_VIDEO_TYPES, MediaContentType, MediaKind, MessengerComplaintCategory, NETWORK_PLUGIN, NetworkPluginPayload, NetworkRequest, NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, Platform, RULE_FIELDS, RULE_OPERATORS, RcArticleLike, RcCollectionLike, RcSection, RuleField, RuleOperator, SENSITIVE_HEADER_PATTERN, SENSITIVE_PARAM_PATTERN, SENSITIVE_PROPERTY_PATTERN, SERVER_ASSISTED_FIELDS, SHOW_ME_CLASS, SHOW_ME_HREF_PREFIX, SOURCEMAP_MAX_FILES_PER_UPLOAD, SOURCEMAP_MAX_FILE_BYTES, ShowWhen, StackFrame, SurveyAnswer, SurveyAnswers, TargetingContext, VIDEO_ATTRS, VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, WebSocketMessage, clamp, compare, compareVersions, complaintReference, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, hasVideoMedia, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, matchesHelpQuery, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, servedArticleAudiences, showMeHref, showMeKeyFromHref, showMeKeys, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds, visitorAudiences, withVisibility } from './runtime.cjs';
|
|
3
3
|
import { z } from 'zod';
|
|
4
4
|
|
|
5
5
|
declare const RuleSchema: z.ZodType<Rule>;
|
|
@@ -974,6 +974,8 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
974
974
|
targeting?: RuleGroup | undefined;
|
|
975
975
|
customHtml?: string | undefined;
|
|
976
976
|
}>, "many">>;
|
|
977
|
+
/** Everyone, only identified (logged-in) users, or only anonymous visitors; applied on top of `targeting`. */
|
|
978
|
+
visibility: z.ZodDefault<z.ZodEnum<["everyone", "identified", "anonymous"]>>;
|
|
977
979
|
targeting: z.ZodDefault<z.ZodType<RuleGroup, z.ZodTypeDef, RuleGroup>>;
|
|
978
980
|
trigger: z.ZodDefault<z.ZodObject<{
|
|
979
981
|
type: z.ZodDefault<z.ZodEnum<["page_load", "url_match", "event", "element_click", "element_visible", "manual", "delay", "after_guide", "segment_enter"]>>;
|
|
@@ -1268,6 +1270,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1268
1270
|
/** Platforms that receive this guide. Guides created before mobile support are web-only. */
|
|
1269
1271
|
platforms: z.ZodDefault<z.ZodArray<z.ZodEnum<["web", "ios", "android"]>, "many">>;
|
|
1270
1272
|
}, "strip", z.ZodTypeAny, {
|
|
1273
|
+
visibility: "everyone" | "identified" | "anonymous";
|
|
1271
1274
|
targeting: RuleGroup;
|
|
1272
1275
|
steps: {
|
|
1273
1276
|
type: "custom" | "modal" | "tooltip" | "banner" | "checklist" | "survey" | "popover" | "spotlight" | "hotspot" | "slideout";
|
|
@@ -1396,6 +1399,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1396
1399
|
endAt?: string | undefined;
|
|
1397
1400
|
} | undefined;
|
|
1398
1401
|
}, {
|
|
1402
|
+
visibility?: "everyone" | "identified" | "anonymous" | undefined;
|
|
1399
1403
|
checklist?: {
|
|
1400
1404
|
tasks: {
|
|
1401
1405
|
id: string;
|
|
@@ -2107,6 +2111,8 @@ interface MessengerConfig {
|
|
|
2107
2111
|
team?: MessengerTeammate[];
|
|
2108
2112
|
status?: MessengerStatus | null;
|
|
2109
2113
|
home?: MessengerHomeCards;
|
|
2114
|
+
/** Complaint categories when the project takes complaints in the messenger (absent from older servers). */
|
|
2115
|
+
complaints?: MessengerComplaintsConfig | null;
|
|
2110
2116
|
}
|
|
2111
2117
|
/** Page-matched content for the messenger, from `POST /sdk/messenger/page`. */
|
|
2112
2118
|
type MessengerPageSuggestion = {
|
|
@@ -2171,6 +2177,8 @@ interface MessengerMessage {
|
|
|
2171
2177
|
suggestedGuides: MessengerSuggestedGuide[];
|
|
2172
2178
|
/** How-tos Scout cited (absent when none; SDKs before how-to support ignore it). */
|
|
2173
2179
|
howTos?: MessengerHowToCitation[];
|
|
2180
|
+
/** Scout offered the complaint form (absent otherwise). */
|
|
2181
|
+
complaintOffer?: MessengerComplaintOffer;
|
|
2174
2182
|
status: "pending" | "complete" | "failed";
|
|
2175
2183
|
createdAt: string;
|
|
2176
2184
|
}
|
|
@@ -2182,6 +2190,8 @@ interface MessengerConversation {
|
|
|
2182
2190
|
lastMessagePreview: string;
|
|
2183
2191
|
unread: number;
|
|
2184
2192
|
rating: number | null;
|
|
2193
|
+
/** The complaint filed in this conversation, latest first (absent when none). */
|
|
2194
|
+
complaint?: MessengerComplaint;
|
|
2185
2195
|
}
|
|
2186
2196
|
declare const MAX_MESSAGE_LENGTH = 4000;
|
|
2187
2197
|
declare const StartConversationSchema: z.ZodObject<{
|
|
@@ -2240,6 +2250,12 @@ declare const ConversationRatingSchema: z.ZodObject<{
|
|
|
2240
2250
|
rating: number;
|
|
2241
2251
|
comment?: string | undefined;
|
|
2242
2252
|
}>;
|
|
2253
|
+
interface FileComplaintResponse {
|
|
2254
|
+
complaint: MessengerComplaint;
|
|
2255
|
+
conversation: MessengerConversation;
|
|
2256
|
+
/** Token of the conversation started for it (absent when it was filed in an existing one). */
|
|
2257
|
+
token?: string;
|
|
2258
|
+
}
|
|
2243
2259
|
interface ConversationMessagesResponse {
|
|
2244
2260
|
conversation: MessengerConversation;
|
|
2245
2261
|
messages: MessengerMessage[];
|
|
@@ -2283,6 +2299,9 @@ interface SdkArticleSummary {
|
|
|
2283
2299
|
externalUrl: string | null;
|
|
2284
2300
|
/** Listed only for members of these audiences (absent = everyone). */
|
|
2285
2301
|
audienceIds?: string[];
|
|
2302
|
+
/** Guide keys of the article's "Show me" prompts (absent = none). */
|
|
2303
|
+
walkthroughs?: string[];
|
|
2304
|
+
hasVideo?: boolean;
|
|
2286
2305
|
updatedAt: string;
|
|
2287
2306
|
}
|
|
2288
2307
|
interface SdkArticlesResponse {
|
|
@@ -2296,6 +2315,10 @@ interface SdkHowToSummary {
|
|
|
2296
2315
|
description: string;
|
|
2297
2316
|
/** Numbered (recorded) steps. */
|
|
2298
2317
|
stepCount: number;
|
|
2318
|
+
/** Key of the interactive tour made from it, when that tour is live in this environment ("Show me"). */
|
|
2319
|
+
guideKey?: string;
|
|
2320
|
+
/** The how-to has a video. */
|
|
2321
|
+
hasVideo?: boolean;
|
|
2299
2322
|
updatedAt: string;
|
|
2300
2323
|
}
|
|
2301
2324
|
interface SdkHowTosResponse {
|
|
@@ -2327,6 +2350,10 @@ interface SdkHowTo {
|
|
|
2327
2350
|
steps: SdkHowToStep[];
|
|
2328
2351
|
/** Key of the interactive tour made from it, when that tour is live in this environment ("Show me"). */
|
|
2329
2352
|
guideKey?: string;
|
|
2353
|
+
/** Video made from the how-to (WebM), played above the steps. */
|
|
2354
|
+
video?: {
|
|
2355
|
+
url: string;
|
|
2356
|
+
};
|
|
2330
2357
|
}
|
|
2331
2358
|
|
|
2332
2359
|
/**
|
|
@@ -2602,6 +2629,10 @@ interface ResourceCenterArticle {
|
|
|
2602
2629
|
externalUrl?: string | null;
|
|
2603
2630
|
/** Listed only for members of any of these audiences (absent = everyone). Not access control. */
|
|
2604
2631
|
audienceIds?: string[];
|
|
2632
|
+
/** Guide keys of the article's "Show me" prompts (absent = none); the first one is offered in Help results. */
|
|
2633
|
+
walkthroughs?: string[];
|
|
2634
|
+
/** The article plays a video. */
|
|
2635
|
+
hasVideo?: boolean;
|
|
2605
2636
|
updatedAt: string;
|
|
2606
2637
|
}
|
|
2607
2638
|
interface ResourceCenterCollection {
|
|
@@ -2707,10 +2738,12 @@ interface IdentifyResponse {
|
|
|
2707
2738
|
dismissedAt?: string | null;
|
|
2708
2739
|
lastShownAt?: string | null;
|
|
2709
2740
|
}>;
|
|
2741
|
+
/** `dismissResetAt` changes when a teammate resets the user's dismissal; SDKs then drop their cached `dismissedAt`. */
|
|
2710
2742
|
checklistProgress: Record<string, {
|
|
2711
2743
|
completedTaskIds: string[];
|
|
2712
2744
|
completedAt?: string | null;
|
|
2713
2745
|
dismissedAt?: string | null;
|
|
2746
|
+
dismissResetAt?: string | null;
|
|
2714
2747
|
}>;
|
|
2715
2748
|
surveysSubmitted: string[];
|
|
2716
2749
|
firstSeenAt: string;
|
|
@@ -3110,6 +3143,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3110
3143
|
targeting?: RuleGroup | undefined;
|
|
3111
3144
|
customHtml?: string | undefined;
|
|
3112
3145
|
}>, "many">>;
|
|
3146
|
+
visibility: z.ZodDefault<z.ZodEnum<["everyone", "identified", "anonymous"]>>;
|
|
3113
3147
|
targeting: z.ZodDefault<z.ZodType<RuleGroup, z.ZodTypeDef, RuleGroup>>;
|
|
3114
3148
|
trigger: z.ZodDefault<z.ZodObject<{
|
|
3115
3149
|
type: z.ZodDefault<z.ZodEnum<["page_load", "url_match", "event", "element_click", "element_visible", "manual", "delay", "after_guide", "segment_enter"]>>;
|
|
@@ -3393,6 +3427,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3393
3427
|
urlPatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
3394
3428
|
platforms: z.ZodDefault<z.ZodArray<z.ZodEnum<["web", "ios", "android"]>, "many">>;
|
|
3395
3429
|
}, "strip", z.ZodTypeAny, {
|
|
3430
|
+
visibility: "everyone" | "identified" | "anonymous";
|
|
3396
3431
|
targeting: RuleGroup;
|
|
3397
3432
|
steps: {
|
|
3398
3433
|
type: "custom" | "modal" | "tooltip" | "banner" | "checklist" | "survey" | "popover" | "spotlight" | "hotspot" | "slideout";
|
|
@@ -3521,6 +3556,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3521
3556
|
endAt?: string | undefined;
|
|
3522
3557
|
} | undefined;
|
|
3523
3558
|
}, {
|
|
3559
|
+
visibility?: "everyone" | "identified" | "anonymous" | undefined;
|
|
3524
3560
|
checklist?: {
|
|
3525
3561
|
tasks: {
|
|
3526
3562
|
id: string;
|
|
@@ -3651,12 +3687,13 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3651
3687
|
}>;
|
|
3652
3688
|
publishedAt: z.ZodString;
|
|
3653
3689
|
}, "strip", z.ZodTypeAny, {
|
|
3654
|
-
id: string;
|
|
3655
3690
|
key: string;
|
|
3691
|
+
id: string;
|
|
3656
3692
|
kind: string;
|
|
3657
3693
|
name: string;
|
|
3658
3694
|
version: number;
|
|
3659
3695
|
config: {
|
|
3696
|
+
visibility: "everyone" | "identified" | "anonymous";
|
|
3660
3697
|
targeting: RuleGroup;
|
|
3661
3698
|
steps: {
|
|
3662
3699
|
type: "custom" | "modal" | "tooltip" | "banner" | "checklist" | "survey" | "popover" | "spotlight" | "hotspot" | "slideout";
|
|
@@ -3787,12 +3824,13 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3787
3824
|
};
|
|
3788
3825
|
publishedAt: string;
|
|
3789
3826
|
}, {
|
|
3790
|
-
id: string;
|
|
3791
3827
|
key: string;
|
|
3828
|
+
id: string;
|
|
3792
3829
|
kind: string;
|
|
3793
3830
|
name: string;
|
|
3794
3831
|
version: number;
|
|
3795
3832
|
config: {
|
|
3833
|
+
visibility?: "everyone" | "identified" | "anonymous" | undefined;
|
|
3796
3834
|
checklist?: {
|
|
3797
3835
|
tasks: {
|
|
3798
3836
|
id: string;
|
|
@@ -3931,6 +3969,58 @@ interface ApiError {
|
|
|
3931
3969
|
};
|
|
3932
3970
|
}
|
|
3933
3971
|
|
|
3972
|
+
declare const FileComplaintSchema: z.ZodObject<{
|
|
3973
|
+
anonymousId: z.ZodString;
|
|
3974
|
+
userId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
3975
|
+
categoryId: z.ZodString;
|
|
3976
|
+
description: z.ZodString;
|
|
3977
|
+
/** Answers to the category's extra questions, by field id. */
|
|
3978
|
+
answers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
3979
|
+
/** Required from visitors the app hasn't identified. */
|
|
3980
|
+
email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
3981
|
+
pageUrl: z.ZodOptional<z.ZodString>;
|
|
3982
|
+
/** File it in this conversation (send its token in `X-Guidely-Conversation`); otherwise a new one is started. */
|
|
3983
|
+
conversationId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
3984
|
+
/** One screenshot, base64-encoded (png, jpeg, webp or gif). */
|
|
3985
|
+
attachment: z.ZodNullable<z.ZodOptional<z.ZodObject<{
|
|
3986
|
+
fileName: z.ZodString;
|
|
3987
|
+
data: z.ZodString;
|
|
3988
|
+
}, "strip", z.ZodTypeAny, {
|
|
3989
|
+
fileName: string;
|
|
3990
|
+
data: string;
|
|
3991
|
+
}, {
|
|
3992
|
+
fileName: string;
|
|
3993
|
+
data: string;
|
|
3994
|
+
}>>>;
|
|
3995
|
+
}, "strip", z.ZodTypeAny, {
|
|
3996
|
+
description: string;
|
|
3997
|
+
anonymousId: string;
|
|
3998
|
+
answers: Record<string, string>;
|
|
3999
|
+
categoryId: string;
|
|
4000
|
+
userId?: string | null | undefined;
|
|
4001
|
+
pageUrl?: string | undefined;
|
|
4002
|
+
email?: string | null | undefined;
|
|
4003
|
+
conversationId?: string | null | undefined;
|
|
4004
|
+
attachment?: {
|
|
4005
|
+
fileName: string;
|
|
4006
|
+
data: string;
|
|
4007
|
+
} | null | undefined;
|
|
4008
|
+
}, {
|
|
4009
|
+
description: string;
|
|
4010
|
+
anonymousId: string;
|
|
4011
|
+
categoryId: string;
|
|
4012
|
+
userId?: string | null | undefined;
|
|
4013
|
+
pageUrl?: string | undefined;
|
|
4014
|
+
answers?: Record<string, string> | undefined;
|
|
4015
|
+
email?: string | null | undefined;
|
|
4016
|
+
conversationId?: string | null | undefined;
|
|
4017
|
+
attachment?: {
|
|
4018
|
+
fileName: string;
|
|
4019
|
+
data: string;
|
|
4020
|
+
} | null | undefined;
|
|
4021
|
+
}>;
|
|
4022
|
+
type FileComplaintRequest = z.infer<typeof FileComplaintSchema>;
|
|
4023
|
+
|
|
3934
4024
|
interface GuideTemplate {
|
|
3935
4025
|
id: string;
|
|
3936
4026
|
name: string;
|
|
@@ -3943,6 +4033,7 @@ declare const GUIDE_TEMPLATES: GuideTemplate[];
|
|
|
3943
4033
|
declare function templateConfig(id: string): {
|
|
3944
4034
|
template: GuideTemplate;
|
|
3945
4035
|
config: {
|
|
4036
|
+
visibility: "everyone" | "identified" | "anonymous";
|
|
3946
4037
|
targeting: RuleGroup;
|
|
3947
4038
|
steps: {
|
|
3948
4039
|
type: "custom" | "modal" | "tooltip" | "banner" | "checklist" | "survey" | "popover" | "spotlight" | "hotspot" | "slideout";
|
|
@@ -4074,6 +4165,6 @@ declare function templateConfig(id: string): {
|
|
|
4074
4165
|
} | null;
|
|
4075
4166
|
|
|
4076
4167
|
declare const SDK_API_VERSION = "v1";
|
|
4077
|
-
declare const SHARED_VERSION = "0.
|
|
4168
|
+
declare const SHARED_VERSION = "0.9.0";
|
|
4078
4169
|
|
|
4079
|
-
export { ADVANCE_ON, ANNOTATION_COLORS, AUTOCAPTURE_EVENTS, type AnnotationColor, type ApiError, type AppSnapshot, type Appearance, AppearanceSchema, type AuthoringPick, AuthoringPickSchema, type AuthoringSessionInfo, type AutocaptureSettings, AutocaptureSettingsSchema, BUTTON_ACTIONS, ButtonSchema, type CaptureSessionInfo, type CaptureSettings, type CaptureStep, type CaptureStepInput, CaptureStepSchema, type CapturedElement, CapturedElementSchema, 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, HOWTO_ACTIONS, HOWTO_STEP_KINDS, type HeatmapPoint, type HeatmapProperties, type HeatmapViewport, type HowToAction, type HowToAnnotation, HowToAnnotationSchema, type HowToStepKind, type IdentifyRequest, IdentifyRequestSchema, type IdentifyResponse, MAX_ANNOTATIONS, MAX_MESSAGE_LENGTH, MESSAGE_AUTHORS, type MessageAuthor, type MessengerCitation, type MessengerConfig, type MessengerConversation, type MessengerHomeCards, type MessengerHowToCitation, type MessengerMessage, type MessengerPageContent, type MessengerPageRequest, MessengerPageRequestSchema, type MessengerPageSuggestion, type MessengerStatus, type MessengerSuggestedGuide, type MessengerTeammate, NormalizedPointSchema, type NormalizedRect, NormalizedRectSchema, PLACEMENTS, type Placement, PostMessageSchema, type ProjectTheme, ProjectThemeSchema, type PublishedGuide, PublishedGuideSchema, REPLAY_MAX_COMPRESSED_BYTES, REPLAY_MAX_RAW_BYTES, REPLY_TIMES, type ReplayChunk, ReplayChunkSchema, type ReplaySettings, ReplaySettingsSchema, type ReplyTime, type ResourceCenterArticle, type ResourceCenterCollection, type ResourceCenterConfig, Rule, RuleGroup, RuleGroupSchema, RuleSchema, SDK_API_VERSION, SELECTOR_KINDS, SHARED_VERSION, STATUS_LEVELS, STEP_TYPES, SURVEY_QUESTION_TYPES, type ScoutStreamEvent, type SdkArticleSummary, type SdkArticlesResponse, type SdkConfigResponse, type SdkEvent, SdkEventSchema, type SdkHowTo, type SdkHowToStep, type SdkHowToSummary, type SdkHowTosResponse, type SelectorStrategy, SelectorStrategySchema, type StartConversationRequest, type StartConversationResponse, StartConversationSchema, type StatusLevel, 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, cleanLabel, defaultGuideConfig, defaultStep, describeCaptureStep, pageName, resolveCaptureSettings, templateConfig, validateGuideConfig, visibleButtons };
|
|
4170
|
+
export { ADVANCE_ON, ANNOTATION_COLORS, AUTOCAPTURE_EVENTS, type AnnotationColor, type ApiError, type AppSnapshot, type Appearance, AppearanceSchema, type AuthoringPick, AuthoringPickSchema, type AuthoringSessionInfo, type AutocaptureSettings, AutocaptureSettingsSchema, BUTTON_ACTIONS, ButtonSchema, type CaptureSessionInfo, type CaptureSettings, type CaptureStep, type CaptureStepInput, CaptureStepSchema, type CapturedElement, CapturedElementSchema, 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 FileComplaintRequest, type FileComplaintResponse, FileComplaintSchema, 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, HOWTO_ACTIONS, HOWTO_STEP_KINDS, type HeatmapPoint, type HeatmapProperties, type HeatmapViewport, type HowToAction, type HowToAnnotation, HowToAnnotationSchema, type HowToStepKind, type IdentifyRequest, IdentifyRequestSchema, type IdentifyResponse, MAX_ANNOTATIONS, MAX_MESSAGE_LENGTH, MESSAGE_AUTHORS, type MessageAuthor, type MessengerCitation, MessengerComplaint, MessengerComplaintOffer, MessengerComplaintsConfig, type MessengerConfig, type MessengerConversation, type MessengerHomeCards, type MessengerHowToCitation, type MessengerMessage, type MessengerPageContent, type MessengerPageRequest, MessengerPageRequestSchema, type MessengerPageSuggestion, type MessengerStatus, type MessengerSuggestedGuide, type MessengerTeammate, NormalizedPointSchema, type NormalizedRect, NormalizedRectSchema, PLACEMENTS, type Placement, PostMessageSchema, type ProjectTheme, ProjectThemeSchema, type PublishedGuide, PublishedGuideSchema, REPLAY_MAX_COMPRESSED_BYTES, REPLAY_MAX_RAW_BYTES, REPLY_TIMES, type ReplayChunk, ReplayChunkSchema, type ReplaySettings, ReplaySettingsSchema, type ReplyTime, type ResourceCenterArticle, type ResourceCenterCollection, type ResourceCenterConfig, Rule, RuleGroup, RuleGroupSchema, RuleSchema, SDK_API_VERSION, SELECTOR_KINDS, SHARED_VERSION, STATUS_LEVELS, STEP_TYPES, SURVEY_QUESTION_TYPES, type ScoutStreamEvent, type SdkArticleSummary, type SdkArticlesResponse, type SdkConfigResponse, type SdkEvent, SdkEventSchema, type SdkHowTo, type SdkHowToStep, type SdkHowToSummary, type SdkHowTosResponse, type SelectorStrategy, SelectorStrategySchema, type StartConversationRequest, type StartConversationResponse, StartConversationSchema, type StatusLevel, 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, cleanLabel, defaultGuideConfig, defaultStep, describeCaptureStep, pageName, resolveCaptureSettings, templateConfig, validateGuideConfig, visibleButtons };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { RuleGroup, Rule } from './runtime.js';
|
|
2
|
-
export { CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, EmbedProvider, ExceptionProperties, FILE_LINK_CLASS, GUIDELY_ID_ATTRIBUTE, MAX_COLLECTION_DEPTH, MAX_PROPERTY_BYTES, MAX_STACK_FRAMES, MEDIA_FILE_MAX_BYTES, MEDIA_FILE_TYPES, MEDIA_IMAGE_MAX_BYTES, MEDIA_IMAGE_TYPES, MEDIA_MAX_BYTES, MEDIA_VIDEO_MAX_BYTES, MEDIA_VIDEO_TYPES, MediaContentType, MediaKind, NETWORK_PLUGIN, NetworkPluginPayload, NetworkRequest, NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, Platform, RULE_FIELDS, RULE_OPERATORS, RcArticleLike, RcCollectionLike, RcSection, 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, VIDEO_ATTRS, VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, WebSocketMessage, clamp, compare, compareVersions, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds } from './runtime.js';
|
|
1
|
+
import { RuleGroup, Rule, MessengerComplaint, MessengerComplaintOffer, MessengerComplaintsConfig } from './runtime.js';
|
|
2
|
+
export { ARTICLE_VISIBILITIES, ArticleVisibility, CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, COMPLAINT_EVENTS, COMPLAINT_FIELD_TYPES, COMPLAINT_STATUSES, ComplaintEvent, ComplaintField, ComplaintFieldType, ComplaintStatus, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, EmbedProvider, ExceptionProperties, FILE_LINK_CLASS, GUIDELY_ID_ATTRIBUTE, GUIDE_VISIBILITIES, GuideVisibility, LOGGED_IN_AUDIENCE, MAX_COLLECTION_DEPTH, MAX_COMPLAINT_ANSWER_LENGTH, MAX_COMPLAINT_ATTACHMENT_BYTES, MAX_COMPLAINT_CHOICES, MAX_COMPLAINT_FIELDS, MAX_COMPLAINT_LENGTH, MAX_PROPERTY_BYTES, MAX_STACK_FRAMES, MEDIA_FILE_MAX_BYTES, MEDIA_FILE_TYPES, MEDIA_IMAGE_MAX_BYTES, MEDIA_IMAGE_TYPES, MEDIA_MAX_BYTES, MEDIA_VIDEO_MAX_BYTES, MEDIA_VIDEO_TYPES, MediaContentType, MediaKind, MessengerComplaintCategory, NETWORK_PLUGIN, NetworkPluginPayload, NetworkRequest, NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, Platform, RULE_FIELDS, RULE_OPERATORS, RcArticleLike, RcCollectionLike, RcSection, RuleField, RuleOperator, SENSITIVE_HEADER_PATTERN, SENSITIVE_PARAM_PATTERN, SENSITIVE_PROPERTY_PATTERN, SERVER_ASSISTED_FIELDS, SHOW_ME_CLASS, SHOW_ME_HREF_PREFIX, SOURCEMAP_MAX_FILES_PER_UPLOAD, SOURCEMAP_MAX_FILE_BYTES, ShowWhen, StackFrame, SurveyAnswer, SurveyAnswers, TargetingContext, VIDEO_ATTRS, VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, WebSocketMessage, clamp, compare, compareVersions, complaintReference, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, hasVideoMedia, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, matchesHelpQuery, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, servedArticleAudiences, showMeHref, showMeKeyFromHref, showMeKeys, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds, visitorAudiences, withVisibility } from './runtime.js';
|
|
3
3
|
import { z } from 'zod';
|
|
4
4
|
|
|
5
5
|
declare const RuleSchema: z.ZodType<Rule>;
|
|
@@ -974,6 +974,8 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
974
974
|
targeting?: RuleGroup | undefined;
|
|
975
975
|
customHtml?: string | undefined;
|
|
976
976
|
}>, "many">>;
|
|
977
|
+
/** Everyone, only identified (logged-in) users, or only anonymous visitors; applied on top of `targeting`. */
|
|
978
|
+
visibility: z.ZodDefault<z.ZodEnum<["everyone", "identified", "anonymous"]>>;
|
|
977
979
|
targeting: z.ZodDefault<z.ZodType<RuleGroup, z.ZodTypeDef, RuleGroup>>;
|
|
978
980
|
trigger: z.ZodDefault<z.ZodObject<{
|
|
979
981
|
type: z.ZodDefault<z.ZodEnum<["page_load", "url_match", "event", "element_click", "element_visible", "manual", "delay", "after_guide", "segment_enter"]>>;
|
|
@@ -1268,6 +1270,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1268
1270
|
/** Platforms that receive this guide. Guides created before mobile support are web-only. */
|
|
1269
1271
|
platforms: z.ZodDefault<z.ZodArray<z.ZodEnum<["web", "ios", "android"]>, "many">>;
|
|
1270
1272
|
}, "strip", z.ZodTypeAny, {
|
|
1273
|
+
visibility: "everyone" | "identified" | "anonymous";
|
|
1271
1274
|
targeting: RuleGroup;
|
|
1272
1275
|
steps: {
|
|
1273
1276
|
type: "custom" | "modal" | "tooltip" | "banner" | "checklist" | "survey" | "popover" | "spotlight" | "hotspot" | "slideout";
|
|
@@ -1396,6 +1399,7 @@ declare const GuideConfigSchema: z.ZodObject<{
|
|
|
1396
1399
|
endAt?: string | undefined;
|
|
1397
1400
|
} | undefined;
|
|
1398
1401
|
}, {
|
|
1402
|
+
visibility?: "everyone" | "identified" | "anonymous" | undefined;
|
|
1399
1403
|
checklist?: {
|
|
1400
1404
|
tasks: {
|
|
1401
1405
|
id: string;
|
|
@@ -2107,6 +2111,8 @@ interface MessengerConfig {
|
|
|
2107
2111
|
team?: MessengerTeammate[];
|
|
2108
2112
|
status?: MessengerStatus | null;
|
|
2109
2113
|
home?: MessengerHomeCards;
|
|
2114
|
+
/** Complaint categories when the project takes complaints in the messenger (absent from older servers). */
|
|
2115
|
+
complaints?: MessengerComplaintsConfig | null;
|
|
2110
2116
|
}
|
|
2111
2117
|
/** Page-matched content for the messenger, from `POST /sdk/messenger/page`. */
|
|
2112
2118
|
type MessengerPageSuggestion = {
|
|
@@ -2171,6 +2177,8 @@ interface MessengerMessage {
|
|
|
2171
2177
|
suggestedGuides: MessengerSuggestedGuide[];
|
|
2172
2178
|
/** How-tos Scout cited (absent when none; SDKs before how-to support ignore it). */
|
|
2173
2179
|
howTos?: MessengerHowToCitation[];
|
|
2180
|
+
/** Scout offered the complaint form (absent otherwise). */
|
|
2181
|
+
complaintOffer?: MessengerComplaintOffer;
|
|
2174
2182
|
status: "pending" | "complete" | "failed";
|
|
2175
2183
|
createdAt: string;
|
|
2176
2184
|
}
|
|
@@ -2182,6 +2190,8 @@ interface MessengerConversation {
|
|
|
2182
2190
|
lastMessagePreview: string;
|
|
2183
2191
|
unread: number;
|
|
2184
2192
|
rating: number | null;
|
|
2193
|
+
/** The complaint filed in this conversation, latest first (absent when none). */
|
|
2194
|
+
complaint?: MessengerComplaint;
|
|
2185
2195
|
}
|
|
2186
2196
|
declare const MAX_MESSAGE_LENGTH = 4000;
|
|
2187
2197
|
declare const StartConversationSchema: z.ZodObject<{
|
|
@@ -2240,6 +2250,12 @@ declare const ConversationRatingSchema: z.ZodObject<{
|
|
|
2240
2250
|
rating: number;
|
|
2241
2251
|
comment?: string | undefined;
|
|
2242
2252
|
}>;
|
|
2253
|
+
interface FileComplaintResponse {
|
|
2254
|
+
complaint: MessengerComplaint;
|
|
2255
|
+
conversation: MessengerConversation;
|
|
2256
|
+
/** Token of the conversation started for it (absent when it was filed in an existing one). */
|
|
2257
|
+
token?: string;
|
|
2258
|
+
}
|
|
2243
2259
|
interface ConversationMessagesResponse {
|
|
2244
2260
|
conversation: MessengerConversation;
|
|
2245
2261
|
messages: MessengerMessage[];
|
|
@@ -2283,6 +2299,9 @@ interface SdkArticleSummary {
|
|
|
2283
2299
|
externalUrl: string | null;
|
|
2284
2300
|
/** Listed only for members of these audiences (absent = everyone). */
|
|
2285
2301
|
audienceIds?: string[];
|
|
2302
|
+
/** Guide keys of the article's "Show me" prompts (absent = none). */
|
|
2303
|
+
walkthroughs?: string[];
|
|
2304
|
+
hasVideo?: boolean;
|
|
2286
2305
|
updatedAt: string;
|
|
2287
2306
|
}
|
|
2288
2307
|
interface SdkArticlesResponse {
|
|
@@ -2296,6 +2315,10 @@ interface SdkHowToSummary {
|
|
|
2296
2315
|
description: string;
|
|
2297
2316
|
/** Numbered (recorded) steps. */
|
|
2298
2317
|
stepCount: number;
|
|
2318
|
+
/** Key of the interactive tour made from it, when that tour is live in this environment ("Show me"). */
|
|
2319
|
+
guideKey?: string;
|
|
2320
|
+
/** The how-to has a video. */
|
|
2321
|
+
hasVideo?: boolean;
|
|
2299
2322
|
updatedAt: string;
|
|
2300
2323
|
}
|
|
2301
2324
|
interface SdkHowTosResponse {
|
|
@@ -2327,6 +2350,10 @@ interface SdkHowTo {
|
|
|
2327
2350
|
steps: SdkHowToStep[];
|
|
2328
2351
|
/** Key of the interactive tour made from it, when that tour is live in this environment ("Show me"). */
|
|
2329
2352
|
guideKey?: string;
|
|
2353
|
+
/** Video made from the how-to (WebM), played above the steps. */
|
|
2354
|
+
video?: {
|
|
2355
|
+
url: string;
|
|
2356
|
+
};
|
|
2330
2357
|
}
|
|
2331
2358
|
|
|
2332
2359
|
/**
|
|
@@ -2602,6 +2629,10 @@ interface ResourceCenterArticle {
|
|
|
2602
2629
|
externalUrl?: string | null;
|
|
2603
2630
|
/** Listed only for members of any of these audiences (absent = everyone). Not access control. */
|
|
2604
2631
|
audienceIds?: string[];
|
|
2632
|
+
/** Guide keys of the article's "Show me" prompts (absent = none); the first one is offered in Help results. */
|
|
2633
|
+
walkthroughs?: string[];
|
|
2634
|
+
/** The article plays a video. */
|
|
2635
|
+
hasVideo?: boolean;
|
|
2605
2636
|
updatedAt: string;
|
|
2606
2637
|
}
|
|
2607
2638
|
interface ResourceCenterCollection {
|
|
@@ -2707,10 +2738,12 @@ interface IdentifyResponse {
|
|
|
2707
2738
|
dismissedAt?: string | null;
|
|
2708
2739
|
lastShownAt?: string | null;
|
|
2709
2740
|
}>;
|
|
2741
|
+
/** `dismissResetAt` changes when a teammate resets the user's dismissal; SDKs then drop their cached `dismissedAt`. */
|
|
2710
2742
|
checklistProgress: Record<string, {
|
|
2711
2743
|
completedTaskIds: string[];
|
|
2712
2744
|
completedAt?: string | null;
|
|
2713
2745
|
dismissedAt?: string | null;
|
|
2746
|
+
dismissResetAt?: string | null;
|
|
2714
2747
|
}>;
|
|
2715
2748
|
surveysSubmitted: string[];
|
|
2716
2749
|
firstSeenAt: string;
|
|
@@ -3110,6 +3143,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3110
3143
|
targeting?: RuleGroup | undefined;
|
|
3111
3144
|
customHtml?: string | undefined;
|
|
3112
3145
|
}>, "many">>;
|
|
3146
|
+
visibility: z.ZodDefault<z.ZodEnum<["everyone", "identified", "anonymous"]>>;
|
|
3113
3147
|
targeting: z.ZodDefault<z.ZodType<RuleGroup, z.ZodTypeDef, RuleGroup>>;
|
|
3114
3148
|
trigger: z.ZodDefault<z.ZodObject<{
|
|
3115
3149
|
type: z.ZodDefault<z.ZodEnum<["page_load", "url_match", "event", "element_click", "element_visible", "manual", "delay", "after_guide", "segment_enter"]>>;
|
|
@@ -3393,6 +3427,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3393
3427
|
urlPatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
3394
3428
|
platforms: z.ZodDefault<z.ZodArray<z.ZodEnum<["web", "ios", "android"]>, "many">>;
|
|
3395
3429
|
}, "strip", z.ZodTypeAny, {
|
|
3430
|
+
visibility: "everyone" | "identified" | "anonymous";
|
|
3396
3431
|
targeting: RuleGroup;
|
|
3397
3432
|
steps: {
|
|
3398
3433
|
type: "custom" | "modal" | "tooltip" | "banner" | "checklist" | "survey" | "popover" | "spotlight" | "hotspot" | "slideout";
|
|
@@ -3521,6 +3556,7 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3521
3556
|
endAt?: string | undefined;
|
|
3522
3557
|
} | undefined;
|
|
3523
3558
|
}, {
|
|
3559
|
+
visibility?: "everyone" | "identified" | "anonymous" | undefined;
|
|
3524
3560
|
checklist?: {
|
|
3525
3561
|
tasks: {
|
|
3526
3562
|
id: string;
|
|
@@ -3651,12 +3687,13 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3651
3687
|
}>;
|
|
3652
3688
|
publishedAt: z.ZodString;
|
|
3653
3689
|
}, "strip", z.ZodTypeAny, {
|
|
3654
|
-
id: string;
|
|
3655
3690
|
key: string;
|
|
3691
|
+
id: string;
|
|
3656
3692
|
kind: string;
|
|
3657
3693
|
name: string;
|
|
3658
3694
|
version: number;
|
|
3659
3695
|
config: {
|
|
3696
|
+
visibility: "everyone" | "identified" | "anonymous";
|
|
3660
3697
|
targeting: RuleGroup;
|
|
3661
3698
|
steps: {
|
|
3662
3699
|
type: "custom" | "modal" | "tooltip" | "banner" | "checklist" | "survey" | "popover" | "spotlight" | "hotspot" | "slideout";
|
|
@@ -3787,12 +3824,13 @@ declare const PublishedGuideSchema: z.ZodObject<{
|
|
|
3787
3824
|
};
|
|
3788
3825
|
publishedAt: string;
|
|
3789
3826
|
}, {
|
|
3790
|
-
id: string;
|
|
3791
3827
|
key: string;
|
|
3828
|
+
id: string;
|
|
3792
3829
|
kind: string;
|
|
3793
3830
|
name: string;
|
|
3794
3831
|
version: number;
|
|
3795
3832
|
config: {
|
|
3833
|
+
visibility?: "everyone" | "identified" | "anonymous" | undefined;
|
|
3796
3834
|
checklist?: {
|
|
3797
3835
|
tasks: {
|
|
3798
3836
|
id: string;
|
|
@@ -3931,6 +3969,58 @@ interface ApiError {
|
|
|
3931
3969
|
};
|
|
3932
3970
|
}
|
|
3933
3971
|
|
|
3972
|
+
declare const FileComplaintSchema: z.ZodObject<{
|
|
3973
|
+
anonymousId: z.ZodString;
|
|
3974
|
+
userId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
3975
|
+
categoryId: z.ZodString;
|
|
3976
|
+
description: z.ZodString;
|
|
3977
|
+
/** Answers to the category's extra questions, by field id. */
|
|
3978
|
+
answers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
3979
|
+
/** Required from visitors the app hasn't identified. */
|
|
3980
|
+
email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
3981
|
+
pageUrl: z.ZodOptional<z.ZodString>;
|
|
3982
|
+
/** File it in this conversation (send its token in `X-Guidely-Conversation`); otherwise a new one is started. */
|
|
3983
|
+
conversationId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
3984
|
+
/** One screenshot, base64-encoded (png, jpeg, webp or gif). */
|
|
3985
|
+
attachment: z.ZodNullable<z.ZodOptional<z.ZodObject<{
|
|
3986
|
+
fileName: z.ZodString;
|
|
3987
|
+
data: z.ZodString;
|
|
3988
|
+
}, "strip", z.ZodTypeAny, {
|
|
3989
|
+
fileName: string;
|
|
3990
|
+
data: string;
|
|
3991
|
+
}, {
|
|
3992
|
+
fileName: string;
|
|
3993
|
+
data: string;
|
|
3994
|
+
}>>>;
|
|
3995
|
+
}, "strip", z.ZodTypeAny, {
|
|
3996
|
+
description: string;
|
|
3997
|
+
anonymousId: string;
|
|
3998
|
+
answers: Record<string, string>;
|
|
3999
|
+
categoryId: string;
|
|
4000
|
+
userId?: string | null | undefined;
|
|
4001
|
+
pageUrl?: string | undefined;
|
|
4002
|
+
email?: string | null | undefined;
|
|
4003
|
+
conversationId?: string | null | undefined;
|
|
4004
|
+
attachment?: {
|
|
4005
|
+
fileName: string;
|
|
4006
|
+
data: string;
|
|
4007
|
+
} | null | undefined;
|
|
4008
|
+
}, {
|
|
4009
|
+
description: string;
|
|
4010
|
+
anonymousId: string;
|
|
4011
|
+
categoryId: string;
|
|
4012
|
+
userId?: string | null | undefined;
|
|
4013
|
+
pageUrl?: string | undefined;
|
|
4014
|
+
answers?: Record<string, string> | undefined;
|
|
4015
|
+
email?: string | null | undefined;
|
|
4016
|
+
conversationId?: string | null | undefined;
|
|
4017
|
+
attachment?: {
|
|
4018
|
+
fileName: string;
|
|
4019
|
+
data: string;
|
|
4020
|
+
} | null | undefined;
|
|
4021
|
+
}>;
|
|
4022
|
+
type FileComplaintRequest = z.infer<typeof FileComplaintSchema>;
|
|
4023
|
+
|
|
3934
4024
|
interface GuideTemplate {
|
|
3935
4025
|
id: string;
|
|
3936
4026
|
name: string;
|
|
@@ -3943,6 +4033,7 @@ declare const GUIDE_TEMPLATES: GuideTemplate[];
|
|
|
3943
4033
|
declare function templateConfig(id: string): {
|
|
3944
4034
|
template: GuideTemplate;
|
|
3945
4035
|
config: {
|
|
4036
|
+
visibility: "everyone" | "identified" | "anonymous";
|
|
3946
4037
|
targeting: RuleGroup;
|
|
3947
4038
|
steps: {
|
|
3948
4039
|
type: "custom" | "modal" | "tooltip" | "banner" | "checklist" | "survey" | "popover" | "spotlight" | "hotspot" | "slideout";
|
|
@@ -4074,6 +4165,6 @@ declare function templateConfig(id: string): {
|
|
|
4074
4165
|
} | null;
|
|
4075
4166
|
|
|
4076
4167
|
declare const SDK_API_VERSION = "v1";
|
|
4077
|
-
declare const SHARED_VERSION = "0.
|
|
4168
|
+
declare const SHARED_VERSION = "0.9.0";
|
|
4078
4169
|
|
|
4079
|
-
export { ADVANCE_ON, ANNOTATION_COLORS, AUTOCAPTURE_EVENTS, type AnnotationColor, type ApiError, type AppSnapshot, type Appearance, AppearanceSchema, type AuthoringPick, AuthoringPickSchema, type AuthoringSessionInfo, type AutocaptureSettings, AutocaptureSettingsSchema, BUTTON_ACTIONS, ButtonSchema, type CaptureSessionInfo, type CaptureSettings, type CaptureStep, type CaptureStepInput, CaptureStepSchema, type CapturedElement, CapturedElementSchema, 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, HOWTO_ACTIONS, HOWTO_STEP_KINDS, type HeatmapPoint, type HeatmapProperties, type HeatmapViewport, type HowToAction, type HowToAnnotation, HowToAnnotationSchema, type HowToStepKind, type IdentifyRequest, IdentifyRequestSchema, type IdentifyResponse, MAX_ANNOTATIONS, MAX_MESSAGE_LENGTH, MESSAGE_AUTHORS, type MessageAuthor, type MessengerCitation, type MessengerConfig, type MessengerConversation, type MessengerHomeCards, type MessengerHowToCitation, type MessengerMessage, type MessengerPageContent, type MessengerPageRequest, MessengerPageRequestSchema, type MessengerPageSuggestion, type MessengerStatus, type MessengerSuggestedGuide, type MessengerTeammate, NormalizedPointSchema, type NormalizedRect, NormalizedRectSchema, PLACEMENTS, type Placement, PostMessageSchema, type ProjectTheme, ProjectThemeSchema, type PublishedGuide, PublishedGuideSchema, REPLAY_MAX_COMPRESSED_BYTES, REPLAY_MAX_RAW_BYTES, REPLY_TIMES, type ReplayChunk, ReplayChunkSchema, type ReplaySettings, ReplaySettingsSchema, type ReplyTime, type ResourceCenterArticle, type ResourceCenterCollection, type ResourceCenterConfig, Rule, RuleGroup, RuleGroupSchema, RuleSchema, SDK_API_VERSION, SELECTOR_KINDS, SHARED_VERSION, STATUS_LEVELS, STEP_TYPES, SURVEY_QUESTION_TYPES, type ScoutStreamEvent, type SdkArticleSummary, type SdkArticlesResponse, type SdkConfigResponse, type SdkEvent, SdkEventSchema, type SdkHowTo, type SdkHowToStep, type SdkHowToSummary, type SdkHowTosResponse, type SelectorStrategy, SelectorStrategySchema, type StartConversationRequest, type StartConversationResponse, StartConversationSchema, type StatusLevel, 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, cleanLabel, defaultGuideConfig, defaultStep, describeCaptureStep, pageName, resolveCaptureSettings, templateConfig, validateGuideConfig, visibleButtons };
|
|
4170
|
+
export { ADVANCE_ON, ANNOTATION_COLORS, AUTOCAPTURE_EVENTS, type AnnotationColor, type ApiError, type AppSnapshot, type Appearance, AppearanceSchema, type AuthoringPick, AuthoringPickSchema, type AuthoringSessionInfo, type AutocaptureSettings, AutocaptureSettingsSchema, BUTTON_ACTIONS, ButtonSchema, type CaptureSessionInfo, type CaptureSettings, type CaptureStep, type CaptureStepInput, CaptureStepSchema, type CapturedElement, CapturedElementSchema, 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 FileComplaintRequest, type FileComplaintResponse, FileComplaintSchema, 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, HOWTO_ACTIONS, HOWTO_STEP_KINDS, type HeatmapPoint, type HeatmapProperties, type HeatmapViewport, type HowToAction, type HowToAnnotation, HowToAnnotationSchema, type HowToStepKind, type IdentifyRequest, IdentifyRequestSchema, type IdentifyResponse, MAX_ANNOTATIONS, MAX_MESSAGE_LENGTH, MESSAGE_AUTHORS, type MessageAuthor, type MessengerCitation, MessengerComplaint, MessengerComplaintOffer, MessengerComplaintsConfig, type MessengerConfig, type MessengerConversation, type MessengerHomeCards, type MessengerHowToCitation, type MessengerMessage, type MessengerPageContent, type MessengerPageRequest, MessengerPageRequestSchema, type MessengerPageSuggestion, type MessengerStatus, type MessengerSuggestedGuide, type MessengerTeammate, NormalizedPointSchema, type NormalizedRect, NormalizedRectSchema, PLACEMENTS, type Placement, PostMessageSchema, type ProjectTheme, ProjectThemeSchema, type PublishedGuide, PublishedGuideSchema, REPLAY_MAX_COMPRESSED_BYTES, REPLAY_MAX_RAW_BYTES, REPLY_TIMES, type ReplayChunk, ReplayChunkSchema, type ReplaySettings, ReplaySettingsSchema, type ReplyTime, type ResourceCenterArticle, type ResourceCenterCollection, type ResourceCenterConfig, Rule, RuleGroup, RuleGroupSchema, RuleSchema, SDK_API_VERSION, SELECTOR_KINDS, SHARED_VERSION, STATUS_LEVELS, STEP_TYPES, SURVEY_QUESTION_TYPES, type ScoutStreamEvent, type SdkArticleSummary, type SdkArticlesResponse, type SdkConfigResponse, type SdkEvent, SdkEventSchema, type SdkHowTo, type SdkHowToStep, type SdkHowToSummary, type SdkHowTosResponse, type SelectorStrategy, SelectorStrategySchema, type StartConversationRequest, type StartConversationResponse, StartConversationSchema, type StatusLevel, 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, cleanLabel, defaultGuideConfig, defaultStep, describeCaptureStep, pageName, resolveCaptureSettings, templateConfig, validateGuideConfig, visibleButtons };
|