posthog-js 1.347.2 → 1.349.0

package/dist/module.d.ts

@@ -1901,6 +1901,8 @@ interface ProductTourSurveyQuestion {
     lowerBoundLabel?: string;
     /** Label for high end of rating scale (e.g., "Very likely") */
     upperBoundLabel?: string;
+    submitButtonText?: string;
+    backButtonText?: string;
 }
 interface ProductTourStep {
     id: string;
@@ -1928,6 +1930,18 @@ interface ProductTourStep {
     buttons?: ProductTourStepButtons;
     /** Banner configuration (only for banner steps) */
     bannerConfig?: ProductTourBannerConfig;
+    /** translation data for this tour step */
+    translations?: Record<string, ProductTourStepTranslation>;
+}
+/** all translatable content for a given tour step */
+interface ProductTourStepTranslation {
+    content?: ProductTourStep['content'];
+    contentHtml?: ProductTourStep['contentHtml'];
+    buttons?: {
+        primary?: Pick<ProductTourStepButton, 'text'>;
+        secondary?: Pick<ProductTourStepButton, 'text'>;
+    };
+    survey?: Pick<ProductTourSurveyQuestion, 'questionText' | 'lowerBoundLabel' | 'upperBoundLabel' | 'submitButtonText' | 'backButtonText'>;
 }
 interface ProductTourConditions {
     url?: string;
@@ -1990,6 +2004,46 @@ interface ShowTourOptions {
     reason?: ProductTourRenderReason;
     enableStrictValidation?: boolean;
 }
+declare enum ProductTourEventName {
+    SHOWN = "product tour shown",
+    DISMISSED = "product tour dismissed",
+    COMPLETED = "product tour completed",
+    STEP_SHOWN = "product tour step shown",
+    STEP_COMPLETED = "product tour step completed",
+    BUTTON_CLICKED = "product tour button clicked",
+    STEP_SELECTOR_FAILED = "product tour step selector failed",
+    BANNER_CONTAINER_SELECTOR_FAILED = "product tour banner container selector failed"
+}
+declare enum ProductTourEventProperties {
+    TOUR_ID = "$product_tour_id",
+    TOUR_NAME = "$product_tour_name",
+    TOUR_ITERATION = "$product_tour_iteration",
+    TOUR_RENDER_REASON = "$product_tour_render_reason",
+    TOUR_STEP_ID = "$product_tour_step_id",
+    TOUR_STEP_ORDER = "$product_tour_step_order",
+    TOUR_STEP_TYPE = "$product_tour_step_type",
+    TOUR_DISMISS_REASON = "$product_tour_dismiss_reason",
+    TOUR_BUTTON_TEXT = "$product_tour_button_text",
+    TOUR_BUTTON_ACTION = "$product_tour_button_action",
+    TOUR_BUTTON_LINK = "$product_tour_button_link",
+    TOUR_BUTTON_TOUR_ID = "$product_tour_button_tour_id",
+    TOUR_STEPS_COUNT = "$product_tour_steps_count",
+    TOUR_STEP_SELECTOR = "$product_tour_step_selector",
+    TOUR_STEP_SELECTOR_FOUND = "$product_tour_step_selector_found",
+    TOUR_STEP_ELEMENT_TAG = "$product_tour_step_element_tag",
+    TOUR_STEP_ELEMENT_ID = "$product_tour_step_element_id",
+    TOUR_STEP_ELEMENT_CLASSES = "$product_tour_step_element_classes",
+    TOUR_STEP_ELEMENT_TEXT = "$product_tour_step_element_text",
+    TOUR_ERROR = "$product_tour_error",
+    TOUR_MATCHES_COUNT = "$product_tour_matches_count",
+    TOUR_FAILURE_PHASE = "$product_tour_failure_phase",
+    TOUR_WAITED_FOR_ELEMENT = "$product_tour_waited_for_element",
+    TOUR_WAIT_DURATION_MS = "$product_tour_wait_duration_ms",
+    TOUR_BANNER_SELECTOR = "$product_tour_banner_selector",
+    TOUR_LINKED_SURVEY_ID = "$product_tour_linked_survey_id",
+    USE_MANUAL_SELECTOR = "$use_manual_selector",
+    INFERENCE_DATA_PRESENT = "$inference_data_present"
+}
 
 declare class PostHogProductTours {
     private _instance;
@@ -4264,5 +4318,5 @@ declare class PostHog implements PostHogInterface {
 
 declare const posthog: PostHog;
 
-export { Compression, DEFAULT_PRODUCT_TOUR_APPEARANCE, DisplaySurveyType, PostHog, SurveyEventName, SurveyEventProperties, SurveyEventType, SurveyPosition, SurveyQuestionBranchingType, SurveyQuestionType, SurveySchedule, SurveyTabPosition, SurveyType, SurveyWidgetType, posthog as default, posthog, severityLevels };
-export type { ActionStepStringMatching, ActionStepType, BasicSurveyQuestion, Breaker, ConversationsRemoteConfig, ConversationsTraits, ConversationsWidgetState, DisplaySurveyOptions, DisplaySurveyPopoverOptions, ErrorEventArgs, ErrorTrackingSuppressionRule, ErrorTrackingSuppressionRuleValue, EventHandler, FlagVariant, FlagsResponse, GetMessagesResponse, GetTicketsOptions, GetTicketsResponse, JSONContent, LinkSurveyQuestion, MarkAsReadResponse, Message, MessageAuthorType, MultipleSurveyQuestion, NetworkRecordOptions, OverrideConfig, PersistentStore, PostHogConfig, PostHogInterface, ProductTour, ProductTourAppearance, ProductTourBannerConfig, ProductTourButtonAction, ProductTourCallback, ProductTourConditions, ProductTourDismissReason, ProductTourDisplayFrequency, ProductTourRenderReason, ProductTourSelectorError, ProductTourStep, ProductTourStepButton, ProductTourStepButtons, ProductTourStepType, ProductTourSurveyQuestion, ProductTourSurveyQuestionType, PropertyFilters, PropertyMatchType, PropertyOperator, QueuedRequestWithOptions, RatingSurveyQuestion, RemoteConfig, RequestWithOptions, RetriableRequestWithOptions, SendMessagePayload, SendMessageResponse, SessionContext, SessionRecordingPersistedConfig, SessionRecordingRemoteConfig, SessionRecordingUrlTrigger, SessionStartReason, ShowTourOptions, SiteApp, SiteAppGlobals, SiteAppLoader, SnippetArrayItem, Survey, SurveyActionType, SurveyAppearance, SurveyCallback, SurveyConfig, SurveyElement, SurveyEventWithFilters, SurveyQuestion, SurveyQuestionDescriptionContentType, SurveyResponseValue, SurveyWithTypeAndAppearance, Ticket, TicketStatus, TipTapDoc, TipTapMark, TipTapNode, UserProvidedTraits, WidgetPosition };
+export { Compression, DEFAULT_PRODUCT_TOUR_APPEARANCE, DisplaySurveyType, PostHog, ProductTourEventName, ProductTourEventProperties, SurveyEventName, SurveyEventProperties, SurveyEventType, SurveyPosition, SurveyQuestionBranchingType, SurveyQuestionType, SurveySchedule, SurveyTabPosition, SurveyType, SurveyWidgetType, posthog as default, posthog, severityLevels };
+export type { ActionStepStringMatching, ActionStepType, BasicSurveyQuestion, Breaker, ConversationsRemoteConfig, ConversationsTraits, ConversationsWidgetState, DisplaySurveyOptions, DisplaySurveyPopoverOptions, ErrorEventArgs, ErrorTrackingSuppressionRule, ErrorTrackingSuppressionRuleValue, EventHandler, FlagVariant, FlagsResponse, GetMessagesResponse, GetTicketsOptions, GetTicketsResponse, JSONContent, LinkSurveyQuestion, MarkAsReadResponse, Message, MessageAuthorType, MultipleSurveyQuestion, NetworkRecordOptions, OverrideConfig, PersistentStore, PostHogConfig, PostHogInterface, ProductTour, ProductTourAppearance, ProductTourBannerConfig, ProductTourButtonAction, ProductTourCallback, ProductTourConditions, ProductTourDismissReason, ProductTourDisplayFrequency, ProductTourRenderReason, ProductTourSelectorError, ProductTourStep, ProductTourStepButton, ProductTourStepButtons, ProductTourStepTranslation, ProductTourStepType, ProductTourSurveyQuestion, ProductTourSurveyQuestionType, PropertyFilters, PropertyMatchType, PropertyOperator, QueuedRequestWithOptions, RatingSurveyQuestion, RemoteConfig, RequestWithOptions, RetriableRequestWithOptions, SendMessagePayload, SendMessageResponse, SessionContext, SessionRecordingPersistedConfig, SessionRecordingRemoteConfig, SessionRecordingUrlTrigger, SessionStartReason, ShowTourOptions, SiteApp, SiteAppGlobals, SiteAppLoader, SnippetArrayItem, Survey, SurveyActionType, SurveyAppearance, SurveyCallback, SurveyConfig, SurveyElement, SurveyEventWithFilters, SurveyQuestion, SurveyQuestionDescriptionContentType, SurveyResponseValue, SurveyWithTypeAndAppearance, Ticket, TicketStatus, TipTapDoc, TipTapMark, TipTapNode, UserProvidedTraits, WidgetPosition };

package/dist/module.full.d.ts

@@ -1901,6 +1901,8 @@ interface ProductTourSurveyQuestion {
     lowerBoundLabel?: string;
     /** Label for high end of rating scale (e.g., "Very likely") */
     upperBoundLabel?: string;
+    submitButtonText?: string;
+    backButtonText?: string;
 }
 interface ProductTourStep {
     id: string;
@@ -1928,6 +1930,18 @@ interface ProductTourStep {
     buttons?: ProductTourStepButtons;
     /** Banner configuration (only for banner steps) */
     bannerConfig?: ProductTourBannerConfig;
+    /** translation data for this tour step */
+    translations?: Record<string, ProductTourStepTranslation>;
+}
+/** all translatable content for a given tour step */
+interface ProductTourStepTranslation {
+    content?: ProductTourStep['content'];
+    contentHtml?: ProductTourStep['contentHtml'];
+    buttons?: {
+        primary?: Pick<ProductTourStepButton, 'text'>;
+        secondary?: Pick<ProductTourStepButton, 'text'>;
+    };
+    survey?: Pick<ProductTourSurveyQuestion, 'questionText' | 'lowerBoundLabel' | 'upperBoundLabel' | 'submitButtonText' | 'backButtonText'>;
 }
 interface ProductTourConditions {
     url?: string;
@@ -1990,6 +2004,46 @@ interface ShowTourOptions {
     reason?: ProductTourRenderReason;
     enableStrictValidation?: boolean;
 }
+declare enum ProductTourEventName {
+    SHOWN = "product tour shown",
+    DISMISSED = "product tour dismissed",
+    COMPLETED = "product tour completed",
+    STEP_SHOWN = "product tour step shown",
+    STEP_COMPLETED = "product tour step completed",
+    BUTTON_CLICKED = "product tour button clicked",
+    STEP_SELECTOR_FAILED = "product tour step selector failed",
+    BANNER_CONTAINER_SELECTOR_FAILED = "product tour banner container selector failed"
+}
+declare enum ProductTourEventProperties {
+    TOUR_ID = "$product_tour_id",
+    TOUR_NAME = "$product_tour_name",
+    TOUR_ITERATION = "$product_tour_iteration",
+    TOUR_RENDER_REASON = "$product_tour_render_reason",
+    TOUR_STEP_ID = "$product_tour_step_id",
+    TOUR_STEP_ORDER = "$product_tour_step_order",
+    TOUR_STEP_TYPE = "$product_tour_step_type",
+    TOUR_DISMISS_REASON = "$product_tour_dismiss_reason",
+    TOUR_BUTTON_TEXT = "$product_tour_button_text",
+    TOUR_BUTTON_ACTION = "$product_tour_button_action",
+    TOUR_BUTTON_LINK = "$product_tour_button_link",
+    TOUR_BUTTON_TOUR_ID = "$product_tour_button_tour_id",
+    TOUR_STEPS_COUNT = "$product_tour_steps_count",
+    TOUR_STEP_SELECTOR = "$product_tour_step_selector",
+    TOUR_STEP_SELECTOR_FOUND = "$product_tour_step_selector_found",
+    TOUR_STEP_ELEMENT_TAG = "$product_tour_step_element_tag",
+    TOUR_STEP_ELEMENT_ID = "$product_tour_step_element_id",
+    TOUR_STEP_ELEMENT_CLASSES = "$product_tour_step_element_classes",
+    TOUR_STEP_ELEMENT_TEXT = "$product_tour_step_element_text",
+    TOUR_ERROR = "$product_tour_error",
+    TOUR_MATCHES_COUNT = "$product_tour_matches_count",
+    TOUR_FAILURE_PHASE = "$product_tour_failure_phase",
+    TOUR_WAITED_FOR_ELEMENT = "$product_tour_waited_for_element",
+    TOUR_WAIT_DURATION_MS = "$product_tour_wait_duration_ms",
+    TOUR_BANNER_SELECTOR = "$product_tour_banner_selector",
+    TOUR_LINKED_SURVEY_ID = "$product_tour_linked_survey_id",
+    USE_MANUAL_SELECTOR = "$use_manual_selector",
+    INFERENCE_DATA_PRESENT = "$inference_data_present"
+}
 
 declare class PostHogProductTours {
     private _instance;
@@ -4264,5 +4318,5 @@ declare class PostHog implements PostHogInterface {
 
 declare const posthog: PostHog;
 
-export { Compression, DEFAULT_PRODUCT_TOUR_APPEARANCE, DisplaySurveyType, PostHog, SurveyEventName, SurveyEventProperties, SurveyEventType, SurveyPosition, SurveyQuestionBranchingType, SurveyQuestionType, SurveySchedule, SurveyTabPosition, SurveyType, SurveyWidgetType, posthog as default, posthog, severityLevels };
-export type { ActionStepStringMatching, ActionStepType, BasicSurveyQuestion, Breaker, ConversationsRemoteConfig, ConversationsTraits, ConversationsWidgetState, DisplaySurveyOptions, DisplaySurveyPopoverOptions, ErrorEventArgs, ErrorTrackingSuppressionRule, ErrorTrackingSuppressionRuleValue, EventHandler, FlagVariant, FlagsResponse, GetMessagesResponse, GetTicketsOptions, GetTicketsResponse, JSONContent, LinkSurveyQuestion, MarkAsReadResponse, Message, MessageAuthorType, MultipleSurveyQuestion, NetworkRecordOptions, OverrideConfig, PersistentStore, PostHogConfig, PostHogInterface, ProductTour, ProductTourAppearance, ProductTourBannerConfig, ProductTourButtonAction, ProductTourCallback, ProductTourConditions, ProductTourDismissReason, ProductTourDisplayFrequency, ProductTourRenderReason, ProductTourSelectorError, ProductTourStep, ProductTourStepButton, ProductTourStepButtons, ProductTourStepType, ProductTourSurveyQuestion, ProductTourSurveyQuestionType, PropertyFilters, PropertyMatchType, PropertyOperator, QueuedRequestWithOptions, RatingSurveyQuestion, RemoteConfig, RequestWithOptions, RetriableRequestWithOptions, SendMessagePayload, SendMessageResponse, SessionContext, SessionRecordingPersistedConfig, SessionRecordingRemoteConfig, SessionRecordingUrlTrigger, SessionStartReason, ShowTourOptions, SiteApp, SiteAppGlobals, SiteAppLoader, SnippetArrayItem, Survey, SurveyActionType, SurveyAppearance, SurveyCallback, SurveyConfig, SurveyElement, SurveyEventWithFilters, SurveyQuestion, SurveyQuestionDescriptionContentType, SurveyResponseValue, SurveyWithTypeAndAppearance, Ticket, TicketStatus, TipTapDoc, TipTapMark, TipTapNode, UserProvidedTraits, WidgetPosition };
+export { Compression, DEFAULT_PRODUCT_TOUR_APPEARANCE, DisplaySurveyType, PostHog, ProductTourEventName, ProductTourEventProperties, SurveyEventName, SurveyEventProperties, SurveyEventType, SurveyPosition, SurveyQuestionBranchingType, SurveyQuestionType, SurveySchedule, SurveyTabPosition, SurveyType, SurveyWidgetType, posthog as default, posthog, severityLevels };
+export type { ActionStepStringMatching, ActionStepType, BasicSurveyQuestion, Breaker, ConversationsRemoteConfig, ConversationsTraits, ConversationsWidgetState, DisplaySurveyOptions, DisplaySurveyPopoverOptions, ErrorEventArgs, ErrorTrackingSuppressionRule, ErrorTrackingSuppressionRuleValue, EventHandler, FlagVariant, FlagsResponse, GetMessagesResponse, GetTicketsOptions, GetTicketsResponse, JSONContent, LinkSurveyQuestion, MarkAsReadResponse, Message, MessageAuthorType, MultipleSurveyQuestion, NetworkRecordOptions, OverrideConfig, PersistentStore, PostHogConfig, PostHogInterface, ProductTour, ProductTourAppearance, ProductTourBannerConfig, ProductTourButtonAction, ProductTourCallback, ProductTourConditions, ProductTourDismissReason, ProductTourDisplayFrequency, ProductTourRenderReason, ProductTourSelectorError, ProductTourStep, ProductTourStepButton, ProductTourStepButtons, ProductTourStepTranslation, ProductTourStepType, ProductTourSurveyQuestion, ProductTourSurveyQuestionType, PropertyFilters, PropertyMatchType, PropertyOperator, QueuedRequestWithOptions, RatingSurveyQuestion, RemoteConfig, RequestWithOptions, RetriableRequestWithOptions, SendMessagePayload, SendMessageResponse, SessionContext, SessionRecordingPersistedConfig, SessionRecordingRemoteConfig, SessionRecordingUrlTrigger, SessionStartReason, ShowTourOptions, SiteApp, SiteAppGlobals, SiteAppLoader, SnippetArrayItem, Survey, SurveyActionType, SurveyAppearance, SurveyCallback, SurveyConfig, SurveyElement, SurveyEventWithFilters, SurveyQuestion, SurveyQuestionDescriptionContentType, SurveyResponseValue, SurveyWithTypeAndAppearance, Ticket, TicketStatus, TipTapDoc, TipTapMark, TipTapNode, UserProvidedTraits, WidgetPosition };