@guidelytech/shared 0.4.1 → 0.6.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { RuleGroup, Rule } from './runtime.js';
-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.js';
+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';
 import { z } from 'zod';
 
 declare const RuleSchema: z.ZodType<Rule>;
@@ -1732,6 +1732,364 @@ declare const EventBatchSchema: z.ZodObject<{
 }>;
 type EventBatch = z.infer<typeof EventBatchSchema>;
 
+/**
+ * How-tos: step-by-step guides with screenshots, recorded by clicking through the customer's app
+ * (SDK capture mode) and edited in the dashboard. Each step is either an action captured in the app
+ * (click, type, select, navigate) or a block the author added (text, heading, tip, alert).
+ */
+declare const HOWTO_STEP_KINDS: readonly ["action", "text", "heading", "tip", "alert"];
+type HowToStepKind = (typeof HOWTO_STEP_KINDS)[number];
+declare const HOWTO_ACTIONS: readonly ["click", "type", "select", "navigate"];
+type HowToAction = (typeof HOWTO_ACTIONS)[number];
+/** A rectangle as fractions (0–1) of its screenshot, so it survives any rendered size. */
+declare const NormalizedRectSchema: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    width: number;
+    x: number;
+    y: number;
+    height: number;
+}, {
+    width: number;
+    x: number;
+    y: number;
+    height: number;
+}>;
+type NormalizedRect = z.infer<typeof NormalizedRectSchema>;
+/** The element an action was performed on, described for people (not for selecting it). */
+declare const CapturedElementSchema: z.ZodObject<{
+    /** Visible name: aria-label, associated label, text, placeholder, alt or title. */
+    label: z.ZodDefault<z.ZodString>;
+    /** button, link, tab, menuitem, checkbox, radio, field, dropdown, option, element… */
+    role: z.ZodDefault<z.ZodString>;
+    tag: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    role: string;
+    label: string;
+    tag: string;
+}, {
+    role?: string | undefined;
+    label?: string | undefined;
+    tag?: string | undefined;
+}>;
+type CapturedElement = z.infer<typeof CapturedElementSchema>;
+/**
+ * One action the SDK recorded, sent with its screenshot as multipart form data
+ * (`step` = this JSON, `screenshot` = the image) to `POST /api/v1/sdk/capture/steps?token=`.
+ * Sensitive values never arrive here: the SDK drops typed text from password, payment, one-time-code
+ * and masked fields and redacts screenshots in the browser before uploading them.
+ */
+declare const CaptureStepSchema: z.ZodObject<{
+    /** Random id from the SDK; a retried upload with the same id is stored once. */
+    clientId: z.ZodString;
+    action: z.ZodEnum<["click", "type", "select", "navigate"]>;
+    url: z.ZodString;
+    pageTitle: z.ZodDefault<z.ZodString>;
+    element: z.ZodOptional<z.ZodObject<{
+        /** Visible name: aria-label, associated label, text, placeholder, alt or title. */
+        label: z.ZodDefault<z.ZodString>;
+        /** button, link, tab, menuitem, checkbox, radio, field, dropdown, option, element… */
+        role: z.ZodDefault<z.ZodString>;
+        tag: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        role: string;
+        label: string;
+        tag: string;
+    }, {
+        role?: string | undefined;
+        label?: string | undefined;
+        tag?: string | undefined;
+    }>>;
+    /** Typed text or chosen option; absent when it was sensitive (`valueRedacted`). */
+    value: z.ZodOptional<z.ZodString>;
+    valueRedacted: z.ZodDefault<z.ZodBoolean>;
+    /** Selectors for the element, so the step can later become an interactive tour step. */
+    selectors: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        kind: z.ZodEnum<["css", "id", "data-attr", "aria", "text", "xpath", "guidely-id"]>;
+        value: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
+        label?: string | undefined;
+    }, {
+        value: string;
+        kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
+        label?: string | undefined;
+    }>, "many">>;
+    /** Where the element sits in the screenshot. */
+    highlight: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        width: number;
+        x: number;
+        y: number;
+        height: number;
+    }, {
+        width: number;
+        x: number;
+        y: number;
+        height: number;
+    }>>;
+    /** Number of regions the SDK blurred in the screenshot before upload. */
+    redactions: z.ZodDefault<z.ZodNumber>;
+    occurredAt: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    selectors: {
+        value: string;
+        kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
+        label?: string | undefined;
+    }[];
+    url: string;
+    action: "type" | "click" | "select" | "navigate";
+    clientId: string;
+    pageTitle: string;
+    valueRedacted: boolean;
+    redactions: number;
+    value?: string | undefined;
+    occurredAt?: string | undefined;
+    element?: {
+        role: string;
+        label: string;
+        tag: string;
+    } | undefined;
+    highlight?: {
+        width: number;
+        x: number;
+        y: number;
+        height: number;
+    } | undefined;
+}, {
+    url: string;
+    action: "type" | "click" | "select" | "navigate";
+    clientId: string;
+    value?: string | undefined;
+    selectors?: {
+        value: string;
+        kind: "id" | "css" | "data-attr" | "aria" | "text" | "xpath" | "guidely-id";
+        label?: string | undefined;
+    }[] | undefined;
+    occurredAt?: string | undefined;
+    element?: {
+        role?: string | undefined;
+        label?: string | undefined;
+        tag?: string | undefined;
+    } | undefined;
+    pageTitle?: string | undefined;
+    valueRedacted?: boolean | undefined;
+    highlight?: {
+        width: number;
+        x: number;
+        y: number;
+        height: number;
+    } | undefined;
+    redactions?: number | undefined;
+}>;
+type CaptureStep = z.infer<typeof CaptureStepSchema>;
+type CaptureStepInput = z.input<typeof CaptureStepSchema>;
+/** `GET /api/v1/sdk/capture/session?token=`: what the SDK needs to start recording. */
+interface CaptureSessionInfo {
+    id: string;
+    projectId: string;
+    environment: string;
+    howToId: string;
+    howToTitle: string;
+    /** Origin of the dashboard window that opened the app (for `postMessage`). */
+    dashboardOrigin: string;
+    expiresAt: string;
+    /** Steps already recorded (a recording continues across full page loads). */
+    stepCount: number;
+    /** False when the server has no media storage: record steps without screenshots. */
+    screenshots: boolean;
+}
+
+/**
+ * A label as people would say it: icon glyphs and symbols at either end ("+ New contact", "Next →")
+ * and required-field markers ("Email *", "Name:") removed. Falls back to the raw label when nothing
+ * readable is left.
+ */
+declare function cleanLabel(label: string | undefined | null): string;
+/**
+ * Name of the page a navigate step opens. A title like "Contacts · Northwind CRM" gives "Contacts";
+ * a title that's just the app's name (no word of the path in it) gives the path instead, so
+ * "/contacts/new" reads "Contacts › New". Ids in the path are skipped.
+ */
+declare function pageName(url: string, pageTitle: string | undefined | null): string;
+/** Plain-language instruction for a captured action, e.g. `Click “Save”` or `Type “Acme” into “Company”`. */
+declare function describeCaptureStep(step: Pick<CaptureStepInput, "action" | "element" | "value" | "valueRedacted" | "pageTitle" | "url">): string;
+/** A point as fractions (0–1) of a screenshot. */
+declare const NormalizedPointSchema: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    x: number;
+    y: number;
+}, {
+    x: number;
+    y: number;
+}>;
+declare const ANNOTATION_COLORS: readonly ["brand", "red", "amber", "green", "black", "white"];
+type AnnotationColor = (typeof ANNOTATION_COLORS)[number];
+/**
+ * A mark drawn over a step's screenshot, in fractions of the full image so it survives cropping and
+ * any rendered size: an arrow, a text label or a box. `brand` uses the project's primary colour.
+ */
+declare const HowToAnnotationSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodLiteral<"arrow">;
+    from: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+    }, {
+        x: number;
+        y: number;
+    }>;
+    to: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+    }, {
+        x: number;
+        y: number;
+    }>;
+    color: z.ZodDefault<z.ZodEnum<["brand", "red", "amber", "green", "black", "white"]>>;
+}, "strip", z.ZodTypeAny, {
+    type: "arrow";
+    id: string;
+    from: {
+        x: number;
+        y: number;
+    };
+    to: {
+        x: number;
+        y: number;
+    };
+    color: "brand" | "red" | "amber" | "green" | "black" | "white";
+}, {
+    type: "arrow";
+    id: string;
+    from: {
+        x: number;
+        y: number;
+    };
+    to: {
+        x: number;
+        y: number;
+    };
+    color?: "brand" | "red" | "amber" | "green" | "black" | "white" | undefined;
+}>, z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodLiteral<"text">;
+    at: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+    }, {
+        x: number;
+        y: number;
+    }>;
+    text: z.ZodString;
+    color: z.ZodDefault<z.ZodEnum<["brand", "red", "amber", "green", "black", "white"]>>;
+}, "strip", z.ZodTypeAny, {
+    at: {
+        x: number;
+        y: number;
+    };
+    type: "text";
+    id: string;
+    text: string;
+    color: "brand" | "red" | "amber" | "green" | "black" | "white";
+}, {
+    at: {
+        x: number;
+        y: number;
+    };
+    type: "text";
+    id: string;
+    text: string;
+    color?: "brand" | "red" | "amber" | "green" | "black" | "white" | undefined;
+}>, z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodLiteral<"box">;
+    rect: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        width: number;
+        x: number;
+        y: number;
+        height: number;
+    }, {
+        width: number;
+        x: number;
+        y: number;
+        height: number;
+    }>;
+    color: z.ZodDefault<z.ZodEnum<["brand", "red", "amber", "green", "black", "white"]>>;
+}, "strip", z.ZodTypeAny, {
+    type: "box";
+    id: string;
+    color: "brand" | "red" | "amber" | "green" | "black" | "white";
+    rect: {
+        width: number;
+        x: number;
+        y: number;
+        height: number;
+    };
+}, {
+    type: "box";
+    id: string;
+    rect: {
+        width: number;
+        x: number;
+        y: number;
+        height: number;
+    };
+    color?: "brand" | "red" | "amber" | "green" | "black" | "white" | undefined;
+}>]>;
+type HowToAnnotation = z.infer<typeof HowToAnnotationSchema>;
+declare const MAX_ANNOTATIONS = 30;
+
+/** How quickly the team usually replies, shown on the messenger home screen. */
+declare const REPLY_TIMES: readonly ["minutes", "hour", "hours", "day"];
+type ReplyTime = (typeof REPLY_TIMES)[number];
+/** Levels of the status card on the messenger home screen. */
+declare const STATUS_LEVELS: readonly ["operational", "degraded", "outage", "maintenance"];
+type StatusLevel = (typeof STATUS_LEVELS)[number];
+/** A teammate shown on the messenger home screen (first name only). */
+interface MessengerTeammate {
+    name: string;
+    avatarUrl: string | null;
+}
+interface MessengerStatus {
+    level: StatusLevel;
+    message: string;
+    updatedAt: string;
+}
+/** Which personalised cards the messenger home screen shows. */
+interface MessengerHomeCards {
+    /** Guides, how-tos, articles and common questions for the page the user is on. */
+    suggestions: boolean;
+    /** A guide the user started and didn't finish, and checklist progress. */
+    progress: boolean;
+    /** Live announcements (also the News tab). */
+    news: boolean;
+}
 /** Messenger settings delivered to the SDK in `SdkConfigResponse.messenger`. */
 interface MessengerConfig {
     enabled: boolean;
@@ -1744,7 +2102,49 @@ interface MessengerConfig {
     launcher: {
         position: "bottom-right" | "bottom-left";
     };
+    /** Absent from servers before the personalised home screen; SDKs fall back to their defaults. */
+    replyTime?: ReplyTime | null;
+    team?: MessengerTeammate[];
+    status?: MessengerStatus | null;
+    home?: MessengerHomeCards;
+}
+/** Page-matched content for the messenger, from `POST /sdk/messenger/page`. */
+type MessengerPageSuggestion = {
+    type: "article";
+    articleId: string;
+    title: string;
+    summary: string;
 }
+/** A how-to recorded on this page, opened as its help article. */
+ | {
+    type: "howto";
+    articleId: string;
+    title: string;
+    steps: number;
+};
+interface MessengerPageContent {
+    /** The page as matched: its path with ids folded (`/invoices/:id`). */
+    path: string;
+    label: string | null;
+    suggestions: MessengerPageSuggestion[];
+    /** Questions people ask on this page (FAQs and learned answers); tapping one asks Scout. */
+    questions: string[];
+}
+declare const MessengerPageRequestSchema: z.ZodObject<{
+    anonymousId: z.ZodString;
+    userId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    /** Pathname only: query strings and fragments are never sent. */
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    anonymousId: string;
+    userId?: string | null | undefined;
+}, {
+    path: string;
+    anonymousId: string;
+    userId?: string | null | undefined;
+}>;
+type MessengerPageRequest = z.infer<typeof MessengerPageRequestSchema>;
 declare const MESSAGE_AUTHORS: readonly ["user", "scout", "agent", "system"];
 type MessageAuthor = (typeof MESSAGE_AUTHORS)[number];
 type ConversationStatus = "bot" | "open" | "closed";
@@ -1756,6 +2156,11 @@ interface MessengerSuggestedGuide {
     key: string;
     name: string;
 }
+/** A how-to Scout relied on; the messenger opens it in place (`GET /sdk/how-tos/:id`). */
+interface MessengerHowToCitation {
+    howToId: string;
+    title: string;
+}
 interface MessengerMessage {
     id: string;
     author: MessageAuthor;
@@ -1764,6 +2169,8 @@ interface MessengerMessage {
     body: string;
     citations: MessengerCitation[];
     suggestedGuides: MessengerSuggestedGuide[];
+    /** How-tos Scout cited (absent when none; SDKs before how-to support ignore it). */
+    howTos?: MessengerHowToCitation[];
     status: "pending" | "complete" | "failed";
     createdAt: string;
 }
@@ -1814,10 +2221,14 @@ interface ConversationLookupResponse {
 }
 declare const PostMessageSchema: z.ZodObject<{
     message: z.ZodString;
+    /** The page the user is on now (omitted when URL collection is off and by older SDKs), so Scout answers for that page. */
+    pageUrl: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     message: string;
+    pageUrl?: string | undefined;
 }, {
     message: string;
+    pageUrl?: string | undefined;
 }>;
 declare const ConversationRatingSchema: z.ZodObject<{
     rating: z.ZodNumber;
@@ -1870,17 +2281,53 @@ interface SdkArticleSummary {
     summary: string;
     collectionId: string | null;
     externalUrl: string | null;
+    /** Listed only for members of these audiences (absent = everyone). */
+    audienceIds?: string[];
     updatedAt: string;
 }
 interface SdkArticlesResponse {
-    collections: Array<{
-        id: string;
-        name: string;
-        description: string;
-        order: number;
-    }>;
+    collections: ResourceCenterCollection[];
     articles: SdkArticleSummary[];
 }
+/** A how-to the team made available in the app (`GET /sdk/how-tos`). */
+interface SdkHowToSummary {
+    id: string;
+    title: string;
+    description: string;
+    /** Numbered (recorded) steps. */
+    stepCount: number;
+    updatedAt: string;
+}
+interface SdkHowTosResponse {
+    /** Every how-to available in the app, by title (at most 200). */
+    howTos: SdkHowToSummary[];
+    /** Ids of the ones recorded on the page in `?url=`, best match first (at most 5). */
+    forPage: string[];
+}
+/** One step as the messenger renders it: text only, plus a screenshot with the element's highlight. */
+interface SdkHowToStep {
+    id: string;
+    kind: HowToStepKind;
+    title: string;
+    body: string;
+    image?: {
+        url: string;
+        /** Show only this part of the screenshot (zoomed in on the element). */
+        crop?: NormalizedRect;
+        /** The element, in the coordinates of the (cropped) image. */
+        highlight?: NormalizedRect;
+    };
+}
+/** `GET /sdk/how-tos/:id`: an available how-to with its steps. */
+interface SdkHowTo {
+    id: string;
+    title: string;
+    description: string;
+    updatedAt: string;
+    steps: SdkHowToStep[];
+    /** Key of the interactive tour made from it, when that tour is live in this environment ("Show me"). */
+    guideKey?: string;
+}
 
 /**
  * Product-analytics capture settings. Stored on `Project.settings` (keys `autocapture`,
@@ -2153,8 +2600,20 @@ interface ResourceCenterArticle {
     bodyOmitted?: boolean;
     collectionId?: string | null;
     externalUrl?: string | null;
+    /** Listed only for members of any of these audiences (absent = everyone). Not access control. */
+    audienceIds?: string[];
     updatedAt: string;
 }
+interface ResourceCenterCollection {
+    id: string;
+    name: string;
+    description: string;
+    order: number;
+    /** Parent collection for nested collections (absent/null = top level). */
+    parentId?: string | null;
+    /** Listed only for members of any of these audiences, with everything inside it (absent = everyone). */
+    audienceIds?: string[];
+}
 interface ResourceCenterConfig {
     enabled: boolean;
     title: string;
@@ -2163,12 +2622,7 @@ interface ResourceCenterConfig {
         label: string;
         showIcon: boolean;
     };
-    collections: Array<{
-        id: string;
-        name: string;
-        description: string;
-        order: number;
-    }>;
+    collections: ResourceCenterCollection[];
     articles: ResourceCenterArticle[];
     recommendedGuideIds: string[];
     checklistGuideIds: string[];
@@ -2369,14 +2823,14 @@ declare const AuthoringPickSchema: z.ZodObject<{
         height: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         width: number;
-        height: number;
         x: number;
         y: number;
+        height: number;
     }, {
         width: number;
-        height: number;
         x: number;
         y: number;
+        height: number;
     }>>;
 }, "strip", z.ZodTypeAny, {
     selectors: {
@@ -2389,9 +2843,9 @@ declare const AuthoringPickSchema: z.ZodObject<{
     stepId?: string | undefined;
     rect?: {
         width: number;
-        height: number;
         x: number;
         y: number;
+        height: number;
     } | undefined;
 }, {
     selectors: {
@@ -2404,9 +2858,9 @@ declare const AuthoringPickSchema: z.ZodObject<{
     stepId?: string | undefined;
     rect?: {
         width: number;
-        height: number;
         x: number;
         y: number;
+        height: number;
     } | undefined;
 }>;
 type AuthoringPick = z.infer<typeof AuthoringPickSchema>;
@@ -3620,6 +4074,6 @@ declare function templateConfig(id: string): {
 } | null;
 
 declare const SDK_API_VERSION = "v1";
-declare const SHARED_VERSION = "0.4.1";
+declare const SHARED_VERSION = "0.6.1";
 
-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 };
+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 };