posthog-js-lite 2.6.2 → 3.0.0-beta.2

package/lib/index.d.ts

@@ -1,20 +1,38 @@
-declare type PosthogCoreOptions = {
+declare type PostHogCoreOptions = {
+    /** PostHog API host, usually 'https://app.posthog.com' or 'https://eu.posthog.com' */
     host?: string;
+    /** The number of events to queue before sending to PostHog (flushing) */
     flushAt?: number;
+    /** The interval in milliseconds between periodic flushes */
     flushInterval?: number;
-    enable?: boolean;
+    /** The maximum number of queued messages to be flushed as part of a single batch (must be higher than `flushAt`) */
+    maxBatchSize?: number;
+    /** If set to true the SDK is essentially disabled (useful for local environments where you don't want to track anything) */
+    disabled?: boolean;
+    /** If set to false the SDK will not track until the `optIn` function is called. */
+    defaultOptIn?: boolean;
+    /** Whether to track that `getFeatureFlag` was called (used by Experiments) */
     sendFeatureFlagEvent?: boolean;
+    /** Whether to load feature flags when initialized or not */
     preloadFeatureFlags?: boolean;
+    /** Option to bootstrap the library with given distinctId and feature flags */
     bootstrap?: {
         distinctId?: string;
         isIdentifiedId?: boolean;
         featureFlags?: Record<string, boolean | string>;
         featureFlagPayloads?: Record<string, JsonType>;
     };
+    /** How many times we will retry HTTP requests. Defaults to 3. */
     fetchRetryCount?: number;
+    /** The delay between HTTP request retries, Defaults to 3 seconds. */
     fetchRetryDelay?: number;
+    /** Timeout in milliseconds for any calls. Defaults to 10 seconds. */
     requestTimeout?: number;
+    /** Timeout in milliseconds for feature flag calls. Defaults to 10 seconds for stateful clients, and 3 seconds for stateless. */
+    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 */
     captureMode?: 'json' | 'form';
     disableGeoip?: boolean;
 };
@@ -93,9 +111,9 @@ declare type JsonType = string | number | boolean | null | {
 } | Array<JsonType>;
 
 interface RetriableOptions {
-    retryCount?: number;
-    retryDelay?: number;
-    retryCheck?: (err: any) => boolean;
+    retryCount: number;
+    retryDelay: number;
+    retryCheck: (err: any) => boolean;
 }
 
 declare class SimpleEventEmitter {
@@ -111,46 +129,53 @@ declare abstract class PostHogCoreStateless {
     private apiKey;
     host: string;
     private flushAt;
+    private maxBatchSize;
     private flushInterval;
+    private flushPromise;
     private requestTimeout;
+    private featureFlagsRequestTimeoutMs;
     private captureMode;
     private removeDebugCallback?;
-    private debugMode;
     private disableGeoip;
-    private _optoutOverride;
+    disabled: boolean;
+    private defaultOptIn;
     private pendingPromises;
     protected _events: SimpleEventEmitter;
     protected _flushTimer?: any;
     protected _retryOptions: RetriableOptions;
+    protected _initPromise: Promise<void>;
+    protected _isInitialized: boolean;
     abstract fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
     abstract getLibraryId(): string;
     abstract getLibraryVersion(): string;
     abstract getCustomUserAgent(): string | void;
     abstract getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
     abstract setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void;
-    constructor(apiKey: string, options?: PosthogCoreOptions);
+    constructor(apiKey: string, options?: PostHogCoreOptions);
+    protected wrap(fn: () => void): void;
     protected getCommonEventProperties(): any;
     get optedOut(): boolean;
-    optIn(): void;
-    optOut(): void;
+    optIn(): Promise<void>;
+    optOut(): Promise<void>;
     on(event: string, cb: (...args: any[]) => void): () => void;
     debug(enabled?: boolean): void;
+    get isDebug(): boolean;
     private buildPayload;
-    protected addPendingPromise(promise: Promise<any>): void;
+    protected addPendingPromise<T>(promise: Promise<T>): Promise<T>;
     /***
      *** TRACKING
      ***/
-    protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
+    protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
     protected captureStateless(distinctId: string, event: string, properties?: {
         [key: string]: any;
-    }, options?: PostHogCaptureOptions): this;
+    }, options?: PostHogCaptureOptions): void;
     protected aliasStateless(alias: string, distinctId: string, properties?: {
         [key: string]: any;
-    }, options?: PostHogCaptureOptions): this;
+    }, options?: PostHogCaptureOptions): void;
     /***
      *** GROUPS
      ***/
-    protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): this;
+    protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): void;
     /***
      *** FEATURE FLAGS
      ***/
@@ -168,11 +193,16 @@ declare abstract class PostHogCoreStateless {
      *** QUEUEING AND FLUSHING
      ***/
     protected enqueue(type: string, _message: any, options?: PostHogCaptureOptions): void;
-    flushAsync(): Promise<any>;
-    flush(callback?: (err?: any, data?: any) => void): void;
+    private clearFlushTimer;
+    /**
+     * Helper for flushing the queue in the background
+     * Avoids unnecessary promise errors
+     */
+    private flushBackground;
+    flush(): Promise<any[]>;
+    private _flush;
     private fetchWithRetry;
-    shutdownAsync(): Promise<void>;
-    shutdown(): void;
+    shutdown(shutdownTimeoutMs?: number): Promise<void>;
 }
 declare abstract class PostHogCore extends PostHogCoreStateless {
     private sendFeatureFlagEvent;
@@ -180,8 +210,8 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     protected _decideResponsePromise?: Promise<PostHogDecideResponse | undefined>;
     protected _sessionExpirationTimeSeconds: number;
     protected sessionProps: PostHogEventProperties;
-    constructor(apiKey: string, options?: PosthogCoreOptions);
-    protected setupBootstrap(options?: Partial<PosthogCoreOptions>): void;
+    constructor(apiKey: string, options?: PostHogCoreOptions);
+    protected setupBootstrap(options?: Partial<PostHogCoreOptions>): void;
     private get props();
     private set props(value);
     private clearProps;
@@ -189,15 +219,24 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     on(event: string, cb: (...args: any[]) => void): () => void;
     reset(propertiesToKeep?: PostHogPersistedProperty[]): void;
     protected getCommonEventProperties(): any;
-    enrichProperties(properties?: PostHogEventProperties): any;
-    getSessionId(): string | undefined;
+    private enrichProperties;
+    /**
+     * * @returns {string} The stored session ID for the current session. This may be an empty string if the client is not yet fully initialized.
+     */
+    getSessionId(): string;
     resetSessionId(): void;
+    /**
+     * * @returns {string} The stored anonymous ID. This may be an empty string if the client is not yet fully initialized.
+     */
     getAnonymousId(): string;
+    /**
+     * * @returns {string} The stored distinct ID. This may be an empty string if the client is not yet fully initialized.
+     */
     getDistinctId(): string;
-    unregister(property: string): void;
+    unregister(property: string): Promise<void>;
     register(properties: {
         [key: string]: any;
-    }): void;
+    }): Promise<void>;
     registerForSession(properties: {
         [key: string]: any;
     }): void;
@@ -205,39 +244,39 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     /***
      *** TRACKING
      ***/
-    identify(distinctId?: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
+    identify(distinctId?: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
     capture(event: string, properties?: {
         [key: string]: any;
-    }, options?: PostHogCaptureOptions): this;
-    alias(alias: string): this;
-    autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
+    }, options?: PostHogCaptureOptions): void;
+    alias(alias: string): void;
+    autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
     /***
      *** GROUPS
      ***/
     groups(groups: {
         [type: string]: string | number;
-    }): this;
-    group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
-    groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
+    }): void;
+    group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
+    groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
     /***
      * PROPERTIES
      ***/
     setPersonPropertiesForFlags(properties: {
         [type: string]: string;
-    }): this;
+    }): void;
     resetPersonPropertiesForFlags(): void;
     /** @deprecated - Renamed to setPersonPropertiesForFlags */
     personProperties(properties: {
         [type: string]: string;
-    }): this;
+    }): void;
     setGroupPropertiesForFlags(properties: {
         [type: string]: Record<string, string>;
-    }): this;
+    }): void;
     resetGroupPropertiesForFlags(): void;
     /** @deprecated - Renamed to setGroupPropertiesForFlags */
     groupProperties(properties: {
         [type: string]: Record<string, string>;
-    }): this;
+    }): void;
     /***
      *** FEATURE FLAGS
      ***/
@@ -258,14 +297,14 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
     onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;
     onFeatureFlag(key: string, cb: (value: string | boolean) => void): () => void;
-    overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): void;
+    overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): Promise<void>;
 }
 
 declare type PostHogOptions = {
     autocapture?: boolean;
     persistence?: 'localStorage' | 'sessionStorage' | 'cookie' | 'memory';
     persistence_name?: string;
-} & PosthogCoreOptions;
+} & PostHogCoreOptions;
 
 declare class PostHog extends PostHogCore {
     private _storage;