posthog-js 1.66.1 → 1.67.0

package/dist/module.d.ts

@@ -1,3 +1,5 @@
+import { SurveyCallback as SurveyCallback$1 } from 'types';
+
 declare enum NodeType {
     Document = 0,
     DocumentType = 1,
@@ -432,6 +434,51 @@ interface EarlyAccessFeatureResponse {
 declare type NetworkRequest = {
     url: string;
 };
+interface Survey {
+    name: string;
+    description: string;
+    type: SurveyType;
+    linked_flag_key?: string | null;
+    targeting_flag_key?: string | null;
+    questions: SurveyQuestion[];
+    appearance?: SurveyAppearance | null;
+    conditions?: {
+        url?: string;
+        selector?: string;
+    } | null;
+    start_date?: string | null;
+    end_date?: string | null;
+}
+interface SurveyAppearance {
+    background_color?: string;
+    button_color?: string;
+    text_color?: string;
+}
+declare enum SurveyType {
+    Popover = "Popover",
+    Button = "Button",
+    Email = "Email",
+    FullScreen = "Fullscreen"
+}
+interface SurveyQuestion {
+    type: SurveyQuestionType;
+    question: string;
+    required?: boolean;
+    link?: boolean;
+    choices?: string[];
+}
+declare enum SurveyQuestionType {
+    Open = "open",
+    MultipleChoiceSingle = "multiple_single",
+    MultipleChoiceMulti = "multiple_multi",
+    NPS = "nps",
+    Rating = "rating",
+    Link = "link"
+}
+declare type SurveyCallback = (surveys: Survey[]) => void;
+interface SurveyResponse {
+    surveys: Survey[];
+}
 
 /**
  * PostHog People Object
@@ -1119,6 +1166,13 @@ declare class ExceptionObserver {
     }): void;
 }
 
+declare class PostHogSurveys {
+    instance: PostHog;
+    constructor(instance: PostHog);
+    getSurveys(callback: SurveyCallback$1, forceReload?: boolean): void;
+    getActiveMatchingSurveys(callback: SurveyCallback$1, forceReload?: boolean): void;
+}
+
 /**
  * PostHog Library Object
  * @constructor
@@ -1134,6 +1188,7 @@ declare class PostHog {
     people: PostHogPeople;
     featureFlags: PostHogFeatureFlags;
     feature_flags: PostHogFeatureFlags;
+    surveys: PostHogSurveys;
     toolbar: Toolbar;
     sessionRecording: SessionRecording | undefined;
     webPerformance: WebPerformanceObserver | undefined;
@@ -1331,6 +1386,10 @@ declare class PostHog {
     /** Get the list of early access features. To check enrollment status, use `isFeatureEnabled`. */
     getEarlyAccessFeatures(callback: EarlyAccessFeatureCallback, force_reload?: boolean): void;
     onFeatureFlags(callback: (flags: string[], variants: Record<string, string | boolean>) => void): () => void;
+    /** Get list of all surveys. */
+    getSurveys(callback: SurveyCallback, forceReload?: boolean): void;
+    /** Get surveys that should be enabled for the current user. */
+    getActiveMatchingSurveys(callback: SurveyCallback, forceReload?: boolean): void;
     /**
      * Identify a user with a unique ID instead of a PostHog
      * randomly generated distinct_id. If the method is never called,
@@ -1790,4 +1849,4 @@ declare class PostHog {
 
 declare const posthog: PostHog;
 
-export { AutoCaptureCustomProperty, AutocaptureCompatibleElement, AutocaptureConfig, Breaker, CaptureCallback, CaptureOptions, CaptureResult, Compression, CompressionData, DecideResponse, DomAutocaptureEvents, EarlyAccessFeature, EarlyAccessFeatureCallback, EarlyAccessFeatureResponse, EventHandler, FeatureFlagsCallback, GDPROptions, JSC, JsonType, NetworkRequest, OptInOutCapturingOptions, PersistentStore, PostData, PostHog, PostHogConfig, Properties, Property, QueuedRequestData, RequestCallback, RetryQueueElement, SessionRecordingOptions, SnippetArrayItem, ToolbarParams, ToolbarSource, ToolbarUserIntent, ToolbarVersion, XHROptions, XHRParams, posthog as default, isFeatureEnabledOptions, posthog };
+export { AutoCaptureCustomProperty, AutocaptureCompatibleElement, AutocaptureConfig, Breaker, CaptureCallback, CaptureOptions, CaptureResult, Compression, CompressionData, DecideResponse, DomAutocaptureEvents, EarlyAccessFeature, EarlyAccessFeatureCallback, EarlyAccessFeatureResponse, EventHandler, FeatureFlagsCallback, GDPROptions, JSC, JsonType, NetworkRequest, OptInOutCapturingOptions, PersistentStore, PostData, PostHog, PostHogConfig, Properties, Property, QueuedRequestData, RequestCallback, RetryQueueElement, SessionRecordingOptions, SnippetArrayItem, Survey, SurveyAppearance, SurveyCallback, SurveyQuestion, SurveyQuestionType, SurveyResponse, SurveyType, ToolbarParams, ToolbarSource, ToolbarUserIntent, ToolbarVersion, XHROptions, XHRParams, posthog as default, isFeatureEnabledOptions, posthog };