posthog-js-lite 3.0.1 → 3.1.0

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-declare type PostHogCoreOptions = {
-    /** PostHog API host, usually 'https://app.posthog.com' or 'https://eu.posthog.com' */
+type PostHogCoreOptions = {
+    /** PostHog API host, usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com' */
     host?: string;
     /** The number of events to queue before sending to PostHog (flushing) */
     flushAt?: number;
@@ -36,9 +36,11 @@ declare type PostHogCoreOptions = {
     featureFlagsRequestTimeoutMs?: 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 'form' */
+    /** Whether to post events to PostHog in JSON or compressed format. Defaults to 'json' */
     captureMode?: 'json' | 'form';
     disableGeoip?: boolean;
+    /** Special flag to indicate ingested data is for a historical migration. */
+    historicalMigration?: boolean;
 };
 declare enum PostHogPersistedProperty {
     AnonymousId = "anonymous_id",
@@ -54,9 +56,10 @@ declare enum PostHogPersistedProperty {
     PersonProperties = "person_properties",
     GroupProperties = "group_properties",
     InstalledAppBuild = "installed_app_build",
-    InstalledAppVersion = "installed_app_version"
+    InstalledAppVersion = "installed_app_version",
+    SessionReplay = "session_replay"
 }
-declare type PostHogFetchOptions = {
+type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
     mode?: 'no-cors';
     credentials?: 'omit';
@@ -66,22 +69,22 @@ declare type PostHogFetchOptions = {
     body?: string;
     signal?: AbortSignal;
 };
-declare type PostHogCaptureOptions = {
+type PostHogCaptureOptions = {
     /** If provided overrides the auto-generated event ID */
     uuid?: string;
     /** If provided overrides the auto-generated timestamp */
     timestamp?: Date;
     disableGeoip?: boolean;
 };
-declare type PostHogFetchResponse = {
+type PostHogFetchResponse = {
     status: number;
     text: () => Promise<string>;
     json: () => Promise<any>;
 };
-declare type PostHogEventProperties = {
+type PostHogEventProperties = {
     [key: string]: any;
 };
-declare type PostHogAutocaptureElement = {
+type PostHogAutocaptureElement = {
     $el_text?: string;
     tag_name: string;
     href?: string;
@@ -91,7 +94,7 @@ declare type PostHogAutocaptureElement = {
 } & {
     [key: string]: any;
 };
-declare type PostHogDecideResponse = {
+type PostHogDecideResponse = {
     config: {
         enable_collect_everything: boolean;
     };
@@ -108,9 +111,11 @@ declare type PostHogDecideResponse = {
         [key: string]: JsonType;
     };
     errorsWhileComputingFlags: boolean;
-    sessionRecording: boolean;
+    sessionRecording?: boolean | {
+        [key: string]: JsonType;
+    };
 };
-declare type JsonType = string | number | boolean | null | {
+type JsonType = string | number | boolean | null | {
     [key: string]: JsonType;
 } | Array<JsonType>;
 
@@ -130,9 +135,9 @@ declare class SimpleEventEmitter {
 }
 
 declare abstract class PostHogCoreStateless {
-    private apiKey;
-    host: string;
-    private flushAt;
+    readonly apiKey: string;
+    readonly host: string;
+    readonly flushAt: number;
     private maxBatchSize;
     private maxQueueSize;
     private flushInterval;
@@ -142,7 +147,8 @@ declare abstract class PostHogCoreStateless {
     private captureMode;
     private removeDebugCallback?;
     private disableGeoip;
-    disabled: boolean;
+    private historicalMigration;
+    protected disabled: boolean;
     private defaultOptIn;
     private pendingPromises;
     protected _events: SimpleEventEmitter;
@@ -157,6 +163,7 @@ declare abstract class PostHogCoreStateless {
     abstract getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
     abstract setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void;
     constructor(apiKey: string, options?: PostHogCoreOptions);
+    protected logMsgIfDebug(fn: () => void): void;
     protected wrap(fn: () => void): void;
     protected getCommonEventProperties(): any;
     get optedOut(): boolean;
@@ -165,6 +172,7 @@ declare abstract class PostHogCoreStateless {
     on(event: string, cb: (...args: any[]) => void): () => void;
     debug(enabled?: boolean): void;
     get isDebug(): boolean;
+    get isDisabled(): boolean;
     private buildPayload;
     protected addPendingPromise<T>(promise: Promise<T>): Promise<T>;
     /***
@@ -308,7 +316,7 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): Promise<void>;
 }
 
-declare type PostHogOptions = {
+type PostHogOptions = {
     autocapture?: boolean;
     persistence?: 'localStorage' | 'sessionStorage' | 'cookie' | 'memory';
     persistence_name?: string;