posthog-js-lite 3.4.2 → 3.5.0

package/lib/index.d.ts

@@ -19,11 +19,23 @@ type PostHogCoreOptions = {
     sendFeatureFlagEvent?: boolean;
     /** Whether to load feature flags when initialized or not */
     preloadFeatureFlags?: boolean;
+    /**
+     * Whether to load remote config when initialized or not
+     * Experimental support
+     * Default: false - Remote config is loaded by default
+     */
+    disableRemoteConfig?: boolean;
+    /**
+     * Whether to load surveys when initialized or not
+     * Experimental support
+     * Default: false - Surveys are loaded by default, but requires the `PostHogSurveyProvider` to be used
+     */
+    disableSurveys?: boolean;
     /** Option to bootstrap the library with given distinctId and feature flags */
     bootstrap?: {
         distinctId?: string;
         isIdentifiedId?: boolean;
-        featureFlags?: Record<string, boolean | string>;
+        featureFlags?: Record<string, FeatureFlagValue>;
         featureFlagPayloads?: Record<string, JsonType>;
     };
     /** How many times we will retry HTTP requests. Defaults to 3. */
@@ -34,6 +46,8 @@ type PostHogCoreOptions = {
     requestTimeout?: number;
     /** Timeout in milliseconds for feature flag calls. Defaults to 10 seconds for stateful clients, and 3 seconds for stateless. */
     featureFlagsRequestTimeoutMs?: number;
+    /** Timeout in milliseconds for remote config calls. Defaults to 3 seconds. */
+    remoteConfigRequestTimeoutMs?: number;
     /** For Session Analysis how long before we expire a session (defaults to 30 mins) */
     sessionExpirationTimeSeconds?: number;
     /** Whether to post events to PostHog in JSON or compressed format. Defaults to 'json' */
@@ -46,8 +60,10 @@ declare enum PostHogPersistedProperty {
     AnonymousId = "anonymous_id",
     DistinctId = "distinct_id",
     Props = "props",
+    FeatureFlagDetails = "feature_flag_details",
     FeatureFlags = "feature_flags",
     FeatureFlagPayloads = "feature_flag_payloads",
+    BootstrapFeatureFlagDetails = "bootstrap_feature_flag_details",
     BootstrapFeatureFlags = "bootstrap_feature_flags",
     BootstrapFeatureFlagPayloads = "bootstrap_feature_flag_payloads",
     OverrideFeatureFlags = "override_feature_flags",
@@ -60,7 +76,11 @@ declare enum PostHogPersistedProperty {
     InstalledAppBuild = "installed_app_build",
     InstalledAppVersion = "installed_app_version",
     SessionReplay = "session_replay",
-    DecideEndpointWasHit = "decide_endpoint_was_hit"
+    DecideEndpointWasHit = "decide_endpoint_was_hit",
+    SurveyLastSeenDate = "survey_last_seen_date",
+    SurveysSeen = "surveys_seen",
+    Surveys = "surveys",
+    RemoteConfig = "remote_config"
 }
 type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
@@ -97,31 +117,267 @@ type PostHogAutocaptureElement = {
 } & {
     [key: string]: any;
 };
-type PostHogDecideResponse = {
-    config: {
-        enable_collect_everything: boolean;
-    };
-    editorParams: {
-        toolbarVersion: string;
-        jsURL: string;
+type PostHogRemoteConfig = {
+    sessionRecording?: boolean | {
+        [key: string]: JsonType;
     };
-    isAuthenticated: true;
-    supportedCompression: string[];
+    /**
+     * Whether surveys are enabled
+     */
+    surveys?: boolean | Survey[];
+    /**
+     * Indicates if the team has any flags enabled (if not we don't need to load them)
+     */
+    hasFeatureFlags?: boolean;
+};
+type FeatureFlagValue = string | boolean;
+type PostHogDecideResponse = Omit<PostHogRemoteConfig, 'surveys' | 'hasFeatureFlags'> & {
     featureFlags: {
-        [key: string]: string | boolean;
+        [key: string]: FeatureFlagValue;
     };
     featureFlagPayloads: {
         [key: string]: JsonType;
     };
+    flags: {
+        [key: string]: FeatureFlagDetail;
+    };
     errorsWhileComputingFlags: boolean;
-    quotaLimited?: string[];
     sessionRecording?: boolean | {
         [key: string]: JsonType;
     };
+    quotaLimited?: string[];
+    requestId?: string;
+};
+/**
+ * Creates a type with all properties of T, but makes only K properties required while the rest remain optional.
+ *
+ * @template T - The base type containing all properties
+ * @template K - Union type of keys from T that should be required
+ *
+ * @example
+ * interface User {
+ *   id: number;
+ *   name: string;
+ *   email?: string;
+ *   age?: number;
+ * }
+ *
+ * // Makes 'id' and 'name' required, but 'email' and 'age' optional
+ * type RequiredUser = PartialWithRequired<User, 'id' | 'name'>;
+ *
+ * const user: RequiredUser = {
+ *   id: 1,      // Must be provided
+ *   name: "John" // Must be provided
+ *   // email and age are optional
+ * };
+ */
+type PartialWithRequired<T, K extends keyof T> = {
+    [P in K]: T[P];
+} & {
+    [P in Exclude<keyof T, K>]?: T[P];
 };
+/**
+ * These are the fields we care about from PostHogDecideResponse for feature flags.
+ */
+type PostHogFeatureFlagDetails = PartialWithRequired<PostHogDecideResponse, 'flags' | 'featureFlags' | 'featureFlagPayloads' | 'requestId'>;
 type JsonType = string | number | boolean | null | {
     [key: string]: JsonType;
-} | Array<JsonType>;
+} | Array<JsonType>;
+type FeatureFlagDetail = {
+    key: string;
+    enabled: boolean;
+    variant: string | undefined;
+    reason: EvaluationReason | undefined;
+    metadata: FeatureFlagMetadata | undefined;
+};
+type FeatureFlagMetadata = {
+    id: number | undefined;
+    version: number | undefined;
+    description: string | undefined;
+    payload: string | undefined;
+};
+type EvaluationReason = {
+    code: string | undefined;
+    condition_index: number | undefined;
+    description: string | undefined;
+};
+type SurveyAppearance = {
+    backgroundColor?: string;
+    submitButtonColor?: string;
+    submitButtonText?: string;
+    submitButtonTextColor?: string;
+    ratingButtonColor?: string;
+    ratingButtonActiveColor?: string;
+    autoDisappear?: boolean;
+    displayThankYouMessage?: boolean;
+    thankYouMessageHeader?: string;
+    thankYouMessageDescription?: string;
+    thankYouMessageDescriptionContentType?: SurveyQuestionDescriptionContentType;
+    thankYouMessageCloseButtonText?: string;
+    borderColor?: string;
+    position?: SurveyPosition;
+    placeholder?: string;
+    shuffleQuestions?: boolean;
+    surveyPopupDelaySeconds?: number;
+    widgetType?: SurveyWidgetType;
+    widgetSelector?: string;
+    widgetLabel?: string;
+    widgetColor?: string;
+};
+declare enum SurveyPosition {
+    Left = "left",
+    Right = "right",
+    Center = "center"
+}
+declare enum SurveyWidgetType {
+    Button = "button",
+    Tab = "tab",
+    Selector = "selector"
+}
+declare enum SurveyType {
+    Popover = "popover",
+    API = "api",
+    Widget = "widget"
+}
+type SurveyQuestion = BasicSurveyQuestion | LinkSurveyQuestion | RatingSurveyQuestion | MultipleSurveyQuestion;
+declare enum SurveyQuestionDescriptionContentType {
+    Html = "html",
+    Text = "text"
+}
+type SurveyQuestionBase = {
+    question: string;
+    id?: string;
+    description?: string;
+    descriptionContentType?: SurveyQuestionDescriptionContentType;
+    optional?: boolean;
+    buttonText?: string;
+    originalQuestionIndex: number;
+    branching?: NextQuestionBranching | EndBranching | ResponseBasedBranching | SpecificQuestionBranching;
+};
+type BasicSurveyQuestion = SurveyQuestionBase & {
+    type: SurveyQuestionType.Open;
+};
+type LinkSurveyQuestion = SurveyQuestionBase & {
+    type: SurveyQuestionType.Link;
+    link?: string;
+};
+type RatingSurveyQuestion = SurveyQuestionBase & {
+    type: SurveyQuestionType.Rating;
+    display: SurveyRatingDisplay;
+    scale: 3 | 5 | 7 | 10;
+    lowerBoundLabel: string;
+    upperBoundLabel: string;
+};
+declare enum SurveyRatingDisplay {
+    Number = "number",
+    Emoji = "emoji"
+}
+type MultipleSurveyQuestion = SurveyQuestionBase & {
+    type: SurveyQuestionType.SingleChoice | SurveyQuestionType.MultipleChoice;
+    choices: string[];
+    hasOpenChoice?: boolean;
+    shuffleOptions?: boolean;
+};
+declare enum SurveyQuestionType {
+    Open = "open",
+    MultipleChoice = "multiple_choice",
+    SingleChoice = "single_choice",
+    Rating = "rating",
+    Link = "link"
+}
+declare enum SurveyQuestionBranchingType {
+    NextQuestion = "next_question",
+    End = "end",
+    ResponseBased = "response_based",
+    SpecificQuestion = "specific_question"
+}
+type NextQuestionBranching = {
+    type: SurveyQuestionBranchingType.NextQuestion;
+};
+type EndBranching = {
+    type: SurveyQuestionBranchingType.End;
+};
+type ResponseBasedBranching = {
+    type: SurveyQuestionBranchingType.ResponseBased;
+    responseValues: Record<string, any>;
+};
+type SpecificQuestionBranching = {
+    type: SurveyQuestionBranchingType.SpecificQuestion;
+    index: number;
+};
+type SurveyResponse = {
+    surveys: Survey[];
+};
+declare enum SurveyMatchType {
+    Regex = "regex",
+    NotRegex = "not_regex",
+    Exact = "exact",
+    IsNot = "is_not",
+    Icontains = "icontains",
+    NotIcontains = "not_icontains"
+}
+type Survey = {
+    id: string;
+    name: string;
+    description?: string;
+    type: SurveyType;
+    feature_flag_keys?: {
+        key: string;
+        value?: string;
+    }[];
+    linked_flag_key?: string;
+    targeting_flag_key?: string;
+    internal_targeting_flag_key?: string;
+    questions: SurveyQuestion[];
+    appearance?: SurveyAppearance;
+    conditions?: {
+        url?: string;
+        selector?: string;
+        seenSurveyWaitPeriodInDays?: number;
+        urlMatchType?: SurveyMatchType;
+        events?: {
+            repeatedActivation?: boolean;
+            values?: {
+                name: string;
+            }[];
+        };
+        actions?: {
+            values: SurveyActionType[];
+        };
+        deviceTypes?: string[];
+        deviceTypesMatchType?: SurveyMatchType;
+    };
+    start_date?: string;
+    end_date?: string;
+    current_iteration?: number;
+    current_iteration_start_date?: string;
+};
+type SurveyActionType = {
+    id: number;
+    name?: string;
+    steps?: ActionStepType[];
+};
+/** Sync with plugin-server/src/types.ts */
+declare enum ActionStepStringMatching {
+    Contains = "contains",
+    Exact = "exact",
+    Regex = "regex"
+}
+type ActionStepType = {
+    event?: string;
+    selector?: string;
+    /** @deprecated Only `selector` should be used now. */
+    tag_name?: string;
+    text?: string;
+    /** @default StringMatching.Exact */
+    text_matching?: ActionStepStringMatching;
+    href?: string;
+    /** @default ActionStepStringMatching.Exact */
+    href_matching?: ActionStepStringMatching;
+    url?: string;
+    /** @default StringMatching.Contains */
+    url_matching?: ActionStepStringMatching;
+};
 
 interface RetriableOptions {
     retryCount: number;
@@ -142,12 +398,15 @@ declare abstract class PostHogCoreStateless {
     readonly apiKey: string;
     readonly host: string;
     readonly flushAt: number;
+    readonly preloadFeatureFlags: boolean;
+    readonly disableSurveys: boolean;
     private maxBatchSize;
     private maxQueueSize;
     private flushInterval;
     private flushPromise;
     private requestTimeout;
     private featureFlagsRequestTimeoutMs;
+    private remoteConfigRequestTimeoutMs;
     private captureMode;
     private removeDebugCallback?;
     private disableGeoip;
@@ -160,6 +419,7 @@ declare abstract class PostHogCoreStateless {
     protected _retryOptions: RetriableOptions;
     protected _initPromise: Promise<void>;
     protected _isInitialized: boolean;
+    protected _remoteConfigResponsePromise?: Promise<PostHogRemoteConfig | undefined>;
     abstract fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
     abstract getLibraryId(): string;
     abstract getLibraryVersion(): string;
@@ -193,19 +453,36 @@ declare abstract class PostHogCoreStateless {
      *** GROUPS
      ***/
     protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): void;
+    protected getRemoteConfig(): Promise<PostHogRemoteConfig | undefined>;
     /***
      *** FEATURE FLAGS
      ***/
     protected getDecide(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, extraPayload?: Record<string, any>): Promise<PostHogDecideResponse | undefined>;
-    protected getFeatureFlagStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<boolean | string | undefined>;
+    protected getFeatureFlagStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
+        response: FeatureFlagValue | undefined;
+        requestId: string | undefined;
+    }>;
+    protected getFeatureFlagDetailStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
+        response: FeatureFlagDetail | undefined;
+        requestId: string | undefined;
+    } | undefined>;
     protected getFeatureFlagPayloadStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<JsonType | undefined>;
-    protected getFeatureFlagPayloadsStateless(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<PostHogDecideResponse['featureFlagPayloads'] | undefined>;
-    protected _parsePayload(response: any): any;
-    protected getFeatureFlagsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
-    protected getFeatureFlagsAndPayloadsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
+    protected getFeatureFlagPayloadsStateless(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<PostHogDecideResponse['featureFlagPayloads'] | undefined>;
+    protected getFeatureFlagsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<{
+        flags: PostHogDecideResponse['featureFlags'] | undefined;
+        payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
+        requestId: PostHogDecideResponse['requestId'] | undefined;
+    }>;
+    protected getFeatureFlagsAndPayloadsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<{
         flags: PostHogDecideResponse['featureFlags'] | undefined;
         payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
+        requestId: PostHogDecideResponse['requestId'] | undefined;
     }>;
+    protected getFeatureFlagDetailsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<PostHogFeatureFlagDetails | undefined>;
+    /***
+     *** SURVEYS
+     ***/
+    getSurveysStateless(): Promise<SurveyResponse['surveys']>;
     /***
      *** QUEUEING AND FLUSHING
      ***/
@@ -297,26 +574,37 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     groupProperties(properties: {
         [type: string]: Record<string, string>;
     }): void;
+    private remoteConfigAsync;
     /***
      *** FEATURE FLAGS
      ***/
     private decideAsync;
+    private cacheSessionReplay;
+    private _remoteConfigAsync;
     private _decideAsync;
-    private setKnownFeatureFlags;
-    private setKnownFeatureFlagPayloads;
-    getFeatureFlag(key: string): boolean | string | undefined;
+    private setKnownFeatureFlagDetails;
+    private getKnownFeatureFlagDetails;
+    private getKnownFeatureFlags;
+    private getKnownFeatureFlagPayloads;
+    private getBootstrappedFeatureFlagDetails;
+    private setBootstrappedFeatureFlagDetails;
+    private getBootstrappedFeatureFlags;
+    private getBootstrappedFeatureFlagPayloads;
+    getFeatureFlag(key: string): FeatureFlagValue | undefined;
     getFeatureFlagPayload(key: string): JsonType | undefined;
     getFeatureFlagPayloads(): PostHogDecideResponse['featureFlagPayloads'] | undefined;
     getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
+    getFeatureFlagDetails(): PostHogFeatureFlagDetails | undefined;
     getFeatureFlagsAndPayloads(): {
         flags: PostHogDecideResponse['featureFlags'] | undefined;
         payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
     };
     isFeatureEnabled(key: string): boolean | undefined;
     reloadFeatureFlags(cb?: (err?: Error, flags?: PostHogDecideResponse['featureFlags']) => void): void;
+    reloadRemoteConfigAsync(): Promise<PostHogRemoteConfig | undefined>;
     reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
     onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;
-    onFeatureFlag(key: string, cb: (value: string | boolean) => void): () => void;
+    onFeatureFlag(key: string, cb: (value: FeatureFlagValue) => void): () => void;
     overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): Promise<void>;
     /***
      *** ERROR TRACKING
@@ -343,12 +631,14 @@ type PostHogOptions = {
     autocapture?: boolean;
     persistence?: 'localStorage' | 'sessionStorage' | 'cookie' | 'memory';
     persistence_name?: string;
+    captureHistoryEvents?: boolean;
 } & PostHogCoreOptions;
 
 declare class PostHog extends PostHogCore {
     private _storage;
     private _storageCache;
     private _storageKey;
+    private _lastPathname;
     constructor(apiKey: string, options?: PostHogOptions);
     private getWindow;
     getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
@@ -358,6 +648,8 @@ declare class PostHog extends PostHogCore {
     getLibraryVersion(): string;
     getCustomUserAgent(): void;
     getCommonEventProperties(): any;
+    private setupHistoryEventTracking;
+    private captureNavigationEvent;
 }
 
 export { PostHog, PostHog as default };