posthog-js 1.161.3 → 1.161.4

package/dist/module.d.ts

@@ -267,6 +267,7 @@ interface PostHogConfig {
     /** @deprecated - use `disable_persistence` instead  */
     disable_cookie?: boolean;
     disable_surveys: boolean;
+    disable_web_experiments: boolean;
     /** If set, posthog-js will never load external scripts such as those needed for Session Replay or Surveys. */
     disable_external_dependency_loading?: boolean;
     enable_recording_console_log?: boolean;
@@ -500,9 +501,10 @@ interface ToolbarParams {
     featureFlags?: Record<string, string | boolean>;
 }
 type SnippetArrayItem = [method: string, ...args: any[]];
-type JsonType = string | number | boolean | null | {
+type JsonRecord = {
     [key: string]: JsonType;
-} | Array<JsonType>;
+};
+type JsonType = string | number | boolean | null | JsonRecord | Array<JsonType>;
 /** A feature that isn't publicly available yet.*/
 interface EarlyAccessFeature {
     name: string;
@@ -1705,6 +1707,58 @@ declare class WebVitalsAutocapture {
     private _startCapturing;
 }
 
+interface WebExperimentTransform {
+    attributes?: {
+        name: string;
+        value: string;
+    }[];
+    selector?: string;
+    text?: string;
+    html?: string;
+    imgUrl?: string;
+    className?: string;
+}
+type WebExperimentUrlMatchType = 'regex' | 'not_regex' | 'exact' | 'is_not' | 'icontains' | 'not_icontains';
+interface WebExperimentVariant {
+    conditions?: {
+        url?: string;
+        urlMatchType?: WebExperimentUrlMatchType;
+        utm?: {
+            utm_source?: string;
+            utm_medium?: string;
+            utm_campaign?: string;
+            utm_term?: string;
+        };
+    };
+    variant_name: string;
+    transforms: WebExperimentTransform[];
+}
+interface WebExperiment {
+    id: number;
+    name: string;
+    feature_flag_key?: string;
+    variants: Record<string, WebExperimentVariant>;
+}
+type WebExperimentsCallback = (webExperiments: WebExperiment[]) => void;
+
+declare class WebExperiments {
+    instance: PostHog;
+    private _featureFlags?;
+    private _flagToExperiments?;
+    constructor(instance: PostHog);
+    applyFeatureFlagChanges(flags: string[]): void;
+    afterDecideResponse(response: DecideResponse): void;
+    loadIfEnabled(): void;
+    getWebExperimentsAndEvaluateDisplayLogic: (forceReload?: boolean) => void;
+    getWebExperiments(callback: WebExperimentsCallback, forceReload: boolean): void;
+    private static matchesTestVariant;
+    private static matchUrlConditions;
+    static getWindowLocation(): Location | undefined;
+    private static matchUTMConditions;
+    private static logInfo;
+    private static applyTransforms;
+}
+
 declare class PostHogExceptions {
     private readonly instance;
     private _endpointSuffix;
@@ -1735,6 +1789,7 @@ declare class PostHog {
     pageViewManager: PageViewManager;
     featureFlags: PostHogFeatureFlags;
     surveys: PostHogSurveys;
+    experiments: WebExperiments;
     toolbar: Toolbar;
     exceptions: PostHogExceptions;
     consent: ConsentManager;
@@ -2408,4 +2463,4 @@ declare class PostHog {
 
 declare const posthog: PostHog;
 
-export { type ActionStepStringMatching, type ActionStepType, type ActionType, type AutocaptureCompatibleElement, type AutocaptureConfig, type BasicSurveyQuestion, type BootstrapConfig, type Breaker, type CaptureOptions, type CaptureResult, type CapturedNetworkRequest, Compression, type DecideResponse, type DomAutocaptureEvents, type EarlyAccessFeature, type EarlyAccessFeatureCallback, type EarlyAccessFeatureResponse, type ErrorConversions, type ErrorEventArgs, type ErrorProperties, type EventHandler, type FeatureFlagsCallback, type FlagVariant, type Headers, type HeatmapConfig, type InitiatorType, type IsFeatureEnabledOptions, type JsonType, type LinkSurveyQuestion, type MultipleSurveyQuestion, type NetworkRecordOptions, type NetworkRequest, type OptInOutCapturingOptions, type PerformanceCaptureConfig, type PersistentStore, PostHog, type PostHogConfig, type Properties, type Property, type QueuedRequestOptions, type RatingSurveyQuestion, type RequestCallback, type RequestOptions, type RequestResponse, type RetriableRequestOptions, type SessionIdChangedCallback, type SessionRecordingOptions, type SeverityLevel, type SnippetArrayItem, type SupportedWebVitalsMetrics, type Survey, type SurveyAppearance, type SurveyCallback, type SurveyElement, type SurveyQuestion, SurveyQuestionBranchingType, type SurveyQuestionDescriptionContentType, SurveyQuestionType, type SurveyRenderReason, type SurveyResponse, SurveyType, type SurveyUrlMatchType, type ToolbarParams, type ToolbarSource, type ToolbarUserIntent, type ToolbarVersion, posthog as default, posthog, severityLevels };
+export { type ActionStepStringMatching, type ActionStepType, type ActionType, type AutocaptureCompatibleElement, type AutocaptureConfig, type BasicSurveyQuestion, type BootstrapConfig, type Breaker, type CaptureOptions, type CaptureResult, type CapturedNetworkRequest, Compression, type DecideResponse, type DomAutocaptureEvents, type EarlyAccessFeature, type EarlyAccessFeatureCallback, type EarlyAccessFeatureResponse, type ErrorConversions, type ErrorEventArgs, type ErrorProperties, type EventHandler, type FeatureFlagsCallback, type FlagVariant, type Headers, type HeatmapConfig, type InitiatorType, type IsFeatureEnabledOptions, type JsonRecord, type JsonType, type LinkSurveyQuestion, type MultipleSurveyQuestion, type NetworkRecordOptions, type NetworkRequest, type OptInOutCapturingOptions, type PerformanceCaptureConfig, type PersistentStore, PostHog, type PostHogConfig, type Properties, type Property, type QueuedRequestOptions, type RatingSurveyQuestion, type RequestCallback, type RequestOptions, type RequestResponse, type RetriableRequestOptions, type SessionIdChangedCallback, type SessionRecordingOptions, type SeverityLevel, type SnippetArrayItem, type SupportedWebVitalsMetrics, type Survey, type SurveyAppearance, type SurveyCallback, type SurveyElement, type SurveyQuestion, SurveyQuestionBranchingType, type SurveyQuestionDescriptionContentType, SurveyQuestionType, type SurveyRenderReason, type SurveyResponse, SurveyType, type SurveyUrlMatchType, type ToolbarParams, type ToolbarSource, type ToolbarUserIntent, type ToolbarVersion, posthog as default, posthog, severityLevels };