posthog-js-lite 3.6.0 → 4.1.0

package/lib/index.d.ts

@@ -50,8 +50,8 @@ type PostHogCoreOptions = {
     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' */
-    captureMode?: 'json' | 'form';
+    /** Whether to disable GZIP compression */
+    disableCompression?: boolean;
     disableGeoip?: boolean;
     /** Special flag to indicate ingested data is for a historical migration. */
     historicalMigration?: boolean;
@@ -77,11 +77,11 @@ declare enum PostHogPersistedProperty {
     InstalledAppBuild = "installed_app_build",
     InstalledAppVersion = "installed_app_version",
     SessionReplay = "session_replay",
-    DecideEndpointWasHit = "decide_endpoint_was_hit",
     SurveyLastSeenDate = "survey_last_seen_date",
     SurveysSeen = "surveys_seen",
     Surveys = "surveys",
-    RemoteConfig = "remote_config"
+    RemoteConfig = "remote_config",
+    FlagsEndpointWasHit = "flags_endpoint_was_hit"
 }
 type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
@@ -90,7 +90,7 @@ type PostHogFetchOptions = {
     headers: {
         [key: string]: string;
     };
-    body?: string;
+    body?: string | Blob;
     signal?: AbortSignal;
 };
 type PostHogCaptureOptions = {
@@ -119,10 +119,18 @@ type PostHogAutocaptureElement = {
     nth_of_type?: number;
     order?: number;
 } & PostHogEventProperties;
+declare enum Compression {
+    GZipJS = "gzip-js",
+    Base64 = "base64"
+}
 type PostHogRemoteConfig = {
     sessionRecording?: boolean | {
         [key: string]: JsonType;
     };
+    /**
+     * Supported compression algorithms
+     */
+    supportedCompression?: Compression[];
     /**
      * Whether surveys are enabled
      */
@@ -133,7 +141,7 @@ type PostHogRemoteConfig = {
     hasFeatureFlags?: boolean;
 };
 type FeatureFlagValue = string | boolean;
-type PostHogDecideResponse = Omit<PostHogRemoteConfig, 'surveys' | 'hasFeatureFlags'> & {
+type PostHogFlagsResponse = Omit<PostHogRemoteConfig, 'surveys' | 'hasFeatureFlags'> & {
     featureFlags: {
         [key: string]: FeatureFlagValue;
     };
@@ -179,9 +187,9 @@ type PartialWithRequired<T, K extends keyof T> = {
     [P in Exclude<keyof T, K>]?: T[P];
 };
 /**
- * These are the fields we care about from PostHogDecideResponse for feature flags.
+ * These are the fields we care about from PostHogFlagsResponse for feature flags.
  */
-type PostHogFeatureFlagDetails = PartialWithRequired<PostHogDecideResponse, 'flags' | 'featureFlags' | 'featureFlagPayloads' | 'requestId'>;
+type PostHogFeatureFlagDetails = PartialWithRequired<PostHogFlagsResponse, 'flags' | 'featureFlags' | 'featureFlagPayloads' | 'requestId'>;
 type JsonType = string | number | boolean | null | {
     [key: string]: JsonType;
 } | Array<JsonType> | JsonType[];
@@ -368,8 +376,6 @@ declare enum ActionStepStringMatching {
 type ActionStepType = {
     event?: string;
     selector?: string;
-    /** @deprecated Only `selector` should be used now. */
-    tag_name?: string;
     text?: string;
     /** @default StringMatching.Exact */
     text_matching?: ActionStepStringMatching;
@@ -410,11 +416,11 @@ declare abstract class PostHogCoreStateless {
     private requestTimeout;
     private featureFlagsRequestTimeoutMs;
     private remoteConfigRequestTimeoutMs;
-    private captureMode;
     private removeDebugCallback?;
     private disableGeoip;
     private historicalMigration;
     protected disabled: boolean;
+    protected disableCompression: boolean;
     private defaultOptIn;
     private pendingPromises;
     protected _events: SimpleEventEmitter;
@@ -459,7 +465,7 @@ declare abstract class PostHogCoreStateless {
     /***
      *** 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 getFlags(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, extraPayload?: Record<string, any>): Promise<PostHogFlagsResponse | 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;
@@ -469,16 +475,16 @@ declare abstract class PostHogCoreStateless {
         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, flagKeysToEvaluate?: string[]): Promise<PostHogDecideResponse['featureFlagPayloads'] | undefined>;
+    protected getFeatureFlagPayloadsStateless(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<PostHogFlagsResponse['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;
+        flags: PostHogFlagsResponse['featureFlags'] | undefined;
+        payloads: PostHogFlagsResponse['featureFlagPayloads'] | undefined;
+        requestId: PostHogFlagsResponse['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;
+        flags: PostHogFlagsResponse['featureFlags'] | undefined;
+        payloads: PostHogFlagsResponse['featureFlagPayloads'] | undefined;
+        requestId: PostHogFlagsResponse['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>;
     /***
@@ -544,7 +550,7 @@ declare abstract class PostHogCoreStateless {
 declare abstract class PostHogCore extends PostHogCoreStateless {
     private sendFeatureFlagEvent;
     private flagCallReported;
-    protected _decideResponsePromise?: Promise<PostHogDecideResponse | undefined>;
+    protected _flagsResponsePromise?: Promise<PostHogFlagsResponse | undefined>;
     protected _sessionExpirationTimeSeconds: number;
     private _sessionMaxLengthSeconds;
     protected sessionProps: PostHogEventProperties;
@@ -590,29 +596,21 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
         [type: string]: string;
     }): void;
     resetPersonPropertiesForFlags(): void;
-    /** @deprecated - Renamed to setPersonPropertiesForFlags */
-    personProperties(properties: {
-        [type: string]: string;
-    }): void;
     setGroupPropertiesForFlags(properties: {
         [type: string]: Record<string, string>;
     }): void;
     resetGroupPropertiesForFlags(): void;
-    /** @deprecated - Renamed to setGroupPropertiesForFlags */
-    groupProperties(properties: {
-        [type: string]: Record<string, string>;
-    }): void;
     private remoteConfigAsync;
     /***
      *** FEATURE FLAGS
      ***/
-    private decideAsync;
+    private flagsAsync;
     private cacheSessionReplay;
     private _remoteConfigAsync;
-    private _decideAsync;
+    private _flagsAsync;
     private setKnownFeatureFlagDetails;
     private getKnownFeatureFlagDetails;
-    protected getKnownFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
+    protected getKnownFeatureFlags(): PostHogFlagsResponse['featureFlags'] | undefined;
     private getKnownFeatureFlagPayloads;
     private getBootstrappedFeatureFlagDetails;
     private setBootstrappedFeatureFlagDetails;
@@ -620,20 +618,22 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     private getBootstrappedFeatureFlagPayloads;
     getFeatureFlag(key: string): FeatureFlagValue | undefined;
     getFeatureFlagPayload(key: string): JsonType | undefined;
-    getFeatureFlagPayloads(): PostHogDecideResponse['featureFlagPayloads'] | undefined;
-    getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
+    getFeatureFlagPayloads(): PostHogFlagsResponse['featureFlagPayloads'] | undefined;
+    getFeatureFlags(): PostHogFlagsResponse['featureFlags'] | undefined;
     getFeatureFlagDetails(): PostHogFeatureFlagDetails | undefined;
     getFeatureFlagsAndPayloads(): {
-        flags: PostHogDecideResponse['featureFlags'] | undefined;
-        payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
+        flags: PostHogFlagsResponse['featureFlags'] | undefined;
+        payloads: PostHogFlagsResponse['featureFlagPayloads'] | undefined;
     };
     isFeatureEnabled(key: string): boolean | undefined;
-    reloadFeatureFlags(cb?: (err?: Error, flags?: PostHogDecideResponse['featureFlags']) => void): void;
+    reloadFeatureFlags(options?: {
+        cb?: (err?: Error, flags?: PostHogFlagsResponse['featureFlags']) => void;
+    }): void;
     reloadRemoteConfigAsync(): Promise<PostHogRemoteConfig | undefined>;
-    reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
-    onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;
+    reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogFlagsResponse['featureFlags'] | undefined>;
+    onFeatureFlags(cb: (flags: PostHogFlagsResponse['featureFlags']) => void): () => void;
     onFeatureFlag(key: string, cb: (value: FeatureFlagValue) => void): () => void;
-    overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): Promise<void>;
+    overrideFeatureFlag(flags: PostHogFlagsResponse['featureFlags'] | null): Promise<void>;
     /***
      *** ERROR TRACKING
      ***/