@guidelytech/shared 0.6.2 → 0.8.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.
Files changed (8) hide show
  1. package/LICENSE +21 -0
  2. package/dist/index.cjs +4 -2
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +10 -10
  5. package/dist/index.d.ts +10 -10
  6. package/dist/index.js +4 -2
  7. package/dist/index.js.map +1 -1
  8. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -1572,7 +1572,7 @@ declare const ProjectThemeSchema: z.ZodObject<{
1572
1572
  brandName?: string | undefined;
1573
1573
  }>;
1574
1574
 
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"];
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", "experiment_viewed"];
1576
1576
  type EventName = (typeof EVENT_NAMES)[number];
1577
1577
  /** Events the SDK records on its own (page analytics, click autocapture, error tracking). */
1578
1578
  declare const AUTOCAPTURE_EVENTS: readonly ["page_view", "page_leave", "click", "rage_click", "exception", "heatmap"];
@@ -1580,7 +1580,7 @@ declare const GUIDE_LIFECYCLE_EVENTS: readonly ["guide_viewed", "guide_started",
1580
1580
  /** Event as produced by the SDK and accepted by POST /api/v1/sdk/events */
1581
1581
  declare const SdkEventSchema: z.ZodObject<{
1582
1582
  eventId: z.ZodString;
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"]>;
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", "experiment_viewed"]>;
1584
1584
  /** For `custom` events: the application-defined name. */
1585
1585
  customName: z.ZodOptional<z.ZodString>;
1586
1586
  occurredAt: z.ZodString;
@@ -1596,7 +1596,7 @@ declare const SdkEventSchema: z.ZodObject<{
1596
1596
  properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1597
1597
  }, "strip", z.ZodTypeAny, {
1598
1598
  eventId: string;
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";
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" | "experiment_viewed";
1600
1600
  occurredAt: string;
1601
1601
  anonymousId: string;
1602
1602
  url?: string | undefined;
@@ -1611,7 +1611,7 @@ declare const SdkEventSchema: z.ZodObject<{
1611
1611
  properties?: Record<string, unknown> | undefined;
1612
1612
  }, {
1613
1613
  eventId: string;
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";
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" | "experiment_viewed";
1615
1615
  occurredAt: string;
1616
1616
  anonymousId: string;
1617
1617
  url?: string | undefined;
@@ -1629,7 +1629,7 @@ type SdkEvent = z.infer<typeof SdkEventSchema>;
1629
1629
  declare const EventBatchSchema: z.ZodObject<{
1630
1630
  events: z.ZodArray<z.ZodObject<{
1631
1631
  eventId: z.ZodString;
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"]>;
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", "experiment_viewed"]>;
1633
1633
  /** For `custom` events: the application-defined name. */
1634
1634
  customName: z.ZodOptional<z.ZodString>;
1635
1635
  occurredAt: z.ZodString;
@@ -1645,7 +1645,7 @@ declare const EventBatchSchema: z.ZodObject<{
1645
1645
  properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1646
1646
  }, "strip", z.ZodTypeAny, {
1647
1647
  eventId: string;
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";
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" | "experiment_viewed";
1649
1649
  occurredAt: string;
1650
1650
  anonymousId: string;
1651
1651
  url?: string | undefined;
@@ -1660,7 +1660,7 @@ declare const EventBatchSchema: z.ZodObject<{
1660
1660
  properties?: Record<string, unknown> | undefined;
1661
1661
  }, {
1662
1662
  eventId: string;
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";
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" | "experiment_viewed";
1664
1664
  occurredAt: string;
1665
1665
  anonymousId: string;
1666
1666
  url?: string | undefined;
@@ -1688,7 +1688,7 @@ declare const EventBatchSchema: z.ZodObject<{
1688
1688
  }, "strip", z.ZodTypeAny, {
1689
1689
  events: {
1690
1690
  eventId: string;
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";
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" | "experiment_viewed";
1692
1692
  occurredAt: string;
1693
1693
  anonymousId: string;
1694
1694
  url?: string | undefined;
@@ -1710,7 +1710,7 @@ declare const EventBatchSchema: z.ZodObject<{
1710
1710
  }, {
1711
1711
  events: {
1712
1712
  eventId: string;
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";
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" | "experiment_viewed";
1714
1714
  occurredAt: string;
1715
1715
  anonymousId: string;
1716
1716
  url?: string | undefined;
@@ -4074,6 +4074,6 @@ declare function templateConfig(id: string): {
4074
4074
  } | null;
4075
4075
 
4076
4076
  declare const SDK_API_VERSION = "v1";
4077
- declare const SHARED_VERSION = "0.6.2";
4077
+ declare const SHARED_VERSION = "0.8.0";
4078
4078
 
4079
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 };
package/dist/index.d.ts CHANGED
@@ -1572,7 +1572,7 @@ declare const ProjectThemeSchema: z.ZodObject<{
1572
1572
  brandName?: string | undefined;
1573
1573
  }>;
1574
1574
 
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"];
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", "experiment_viewed"];
1576
1576
  type EventName = (typeof EVENT_NAMES)[number];
1577
1577
  /** Events the SDK records on its own (page analytics, click autocapture, error tracking). */
1578
1578
  declare const AUTOCAPTURE_EVENTS: readonly ["page_view", "page_leave", "click", "rage_click", "exception", "heatmap"];
@@ -1580,7 +1580,7 @@ declare const GUIDE_LIFECYCLE_EVENTS: readonly ["guide_viewed", "guide_started",
1580
1580
  /** Event as produced by the SDK and accepted by POST /api/v1/sdk/events */
1581
1581
  declare const SdkEventSchema: z.ZodObject<{
1582
1582
  eventId: z.ZodString;
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"]>;
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", "experiment_viewed"]>;
1584
1584
  /** For `custom` events: the application-defined name. */
1585
1585
  customName: z.ZodOptional<z.ZodString>;
1586
1586
  occurredAt: z.ZodString;
@@ -1596,7 +1596,7 @@ declare const SdkEventSchema: z.ZodObject<{
1596
1596
  properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1597
1597
  }, "strip", z.ZodTypeAny, {
1598
1598
  eventId: string;
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";
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" | "experiment_viewed";
1600
1600
  occurredAt: string;
1601
1601
  anonymousId: string;
1602
1602
  url?: string | undefined;
@@ -1611,7 +1611,7 @@ declare const SdkEventSchema: z.ZodObject<{
1611
1611
  properties?: Record<string, unknown> | undefined;
1612
1612
  }, {
1613
1613
  eventId: string;
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";
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" | "experiment_viewed";
1615
1615
  occurredAt: string;
1616
1616
  anonymousId: string;
1617
1617
  url?: string | undefined;
@@ -1629,7 +1629,7 @@ type SdkEvent = z.infer<typeof SdkEventSchema>;
1629
1629
  declare const EventBatchSchema: z.ZodObject<{
1630
1630
  events: z.ZodArray<z.ZodObject<{
1631
1631
  eventId: z.ZodString;
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"]>;
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", "experiment_viewed"]>;
1633
1633
  /** For `custom` events: the application-defined name. */
1634
1634
  customName: z.ZodOptional<z.ZodString>;
1635
1635
  occurredAt: z.ZodString;
@@ -1645,7 +1645,7 @@ declare const EventBatchSchema: z.ZodObject<{
1645
1645
  properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1646
1646
  }, "strip", z.ZodTypeAny, {
1647
1647
  eventId: string;
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";
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" | "experiment_viewed";
1649
1649
  occurredAt: string;
1650
1650
  anonymousId: string;
1651
1651
  url?: string | undefined;
@@ -1660,7 +1660,7 @@ declare const EventBatchSchema: z.ZodObject<{
1660
1660
  properties?: Record<string, unknown> | undefined;
1661
1661
  }, {
1662
1662
  eventId: string;
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";
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" | "experiment_viewed";
1664
1664
  occurredAt: string;
1665
1665
  anonymousId: string;
1666
1666
  url?: string | undefined;
@@ -1688,7 +1688,7 @@ declare const EventBatchSchema: z.ZodObject<{
1688
1688
  }, "strip", z.ZodTypeAny, {
1689
1689
  events: {
1690
1690
  eventId: string;
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";
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" | "experiment_viewed";
1692
1692
  occurredAt: string;
1693
1693
  anonymousId: string;
1694
1694
  url?: string | undefined;
@@ -1710,7 +1710,7 @@ declare const EventBatchSchema: z.ZodObject<{
1710
1710
  }, {
1711
1711
  events: {
1712
1712
  eventId: string;
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";
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" | "experiment_viewed";
1714
1714
  occurredAt: string;
1715
1715
  anonymousId: string;
1716
1716
  url?: string | undefined;
@@ -4074,6 +4074,6 @@ declare function templateConfig(id: string): {
4074
4074
  } | null;
4075
4075
 
4076
4076
  declare const SDK_API_VERSION = "v1";
4077
- declare const SHARED_VERSION = "0.6.2";
4077
+ declare const SHARED_VERSION = "0.8.0";
4078
4078
 
4079
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 };
package/dist/index.js CHANGED
@@ -379,7 +379,9 @@ var EVENT_NAMES = [
379
379
  "click",
380
380
  "rage_click",
381
381
  "exception",
382
- "heatmap"
382
+ "heatmap",
383
+ // Feature flags: a user was bucketed into an experiment variation (properties: experimentKey, variationId, flagKey).
384
+ "experiment_viewed"
383
385
  ];
384
386
  var AUTOCAPTURE_EVENTS = ["page_view", "page_leave", "click", "rage_click", "exception", "heatmap"];
385
387
  var GUIDE_LIFECYCLE_EVENTS = ["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned"];
@@ -835,7 +837,7 @@ var MAX_ANNOTATIONS = 30;
835
837
 
836
838
  // src/index.ts
837
839
  var SDK_API_VERSION = "v1";
838
- var SHARED_VERSION = "0.6.2";
840
+ var SHARED_VERSION = "0.8.0";
839
841
  export {
840
842
  ADVANCE_ON,
841
843
  ANNOTATION_COLORS,