posthog-js-lite 2.0.0-alpha5 → 2.0.1

package/lib/index.d.ts

@@ -5,21 +5,31 @@ declare type PosthogCoreOptions = {
     enable?: boolean;
     sendFeatureFlagEvent?: boolean;
     preloadFeatureFlags?: boolean;
-    decidePollInterval?: number;
+    bootstrap?: {
+        distinctId?: string;
+        isIdentifiedId?: boolean;
+        featureFlags?: Record<string, boolean | string>;
+        featureFlagPayloads?: Record<string, JsonType>;
+    };
     fetchRetryCount?: number;
     fetchRetryDelay?: number;
+    requestTimeout?: number;
     sessionExpirationTimeSeconds?: number;
     captureMode?: 'json' | 'form';
 };
 declare enum PostHogPersistedProperty {
+    AnonymousId = "anonymous_id",
     DistinctId = "distinct_id",
     Props = "props",
     FeatureFlags = "feature_flags",
+    FeatureFlagPayloads = "feature_flag_payloads",
     OverrideFeatureFlags = "override_feature_flags",
     Queue = "queue",
     OptedOut = "opted_out",
     SessionId = "session_id",
-    SessionLastTimestamp = "session_timestamp"
+    SessionLastTimestamp = "session_timestamp",
+    PersonProperties = "person_properties",
+    GroupProperties = "group_properties"
 }
 declare type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
@@ -28,11 +38,13 @@ declare type PostHogFetchOptions = {
     headers: {
         [key: string]: string;
     };
-    body: string;
+    body?: string;
+    signal?: AbortSignal;
 };
 declare type PostHogFetchResponse = {
     status: number;
     text: () => Promise<string>;
+    json: () => Promise<any>;
 };
 declare type PostHogEventProperties = {
     [key: string]: any;
@@ -60,8 +72,15 @@ declare type PostHogDecideResponse = {
     featureFlags: {
         [key: string]: string | boolean;
     };
+    featureFlagPayloads: {
+        [key: string]: JsonType;
+    };
+    errorsWhileComputingFlags: boolean;
     sessionRecording: boolean;
-};
+};
+declare type JsonType = string | number | boolean | null | {
+    [key: string]: JsonType;
+} | Array<JsonType>;
 
 interface RetriableOptions {
     retryCount?: number;
@@ -80,9 +99,10 @@ declare class SimpleEventEmitter {
 
 declare abstract class PostHogCore {
     private apiKey;
-    private host;
+    host: string;
     private flushAt;
     private flushInterval;
+    private requestTimeout;
     private captureMode;
     private sendFeatureFlagEvent;
     private flagCallReported;
@@ -90,8 +110,6 @@ declare abstract class PostHogCore {
     protected _events: SimpleEventEmitter;
     protected _flushTimer?: any;
     protected _decideResponsePromise?: Promise<PostHogDecideResponse>;
-    protected _decideTimer?: any;
-    protected _decidePollInterval: number;
     protected _retryOptions: RetriableOptions;
     protected _sessionExpirationTimeSeconds: number;
     abstract fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
@@ -103,18 +121,21 @@ declare abstract class PostHogCore {
     private _optoutOverride;
     constructor(apiKey: string, options?: PosthogCoreOptions);
     protected getCommonEventProperties(): any;
+    protected setupBootstrap(options?: Partial<PosthogCoreOptions>): void;
     private get props();
     private set props(value);
+    private clearProps;
     private _props;
     get optedOut(): boolean;
     optIn(): void;
     optOut(): void;
     on(event: string, cb: (...args: any[]) => void): () => void;
-    reset(): void;
+    reset(propertiesToKeep?: PostHogPersistedProperty[]): void;
     debug(enabled?: boolean): void;
     private buildPayload;
     getSessionId(): string | undefined;
     resetSessionId(): void;
+    getAnonymousId(): string;
     getDistinctId(): string;
     register(properties: {
         [key: string]: any;
@@ -126,7 +147,7 @@ declare abstract class PostHogCore {
     identify(distinctId?: string, properties?: PostHogEventProperties): this;
     capture(event: string, properties?: {
         [key: string]: any;
-    }): this;
+    }, forceSendFeatureFlags?: boolean): this;
     alias(alias: string): this;
     autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties): this;
     /***
@@ -137,17 +158,39 @@ declare abstract class PostHogCore {
     }): this;
     group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties): this;
     groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties): this;
+    /***
+     * PROPERTIES
+     ***/
+    personProperties(properties: {
+        [type: string]: string;
+    }): this;
+    groupProperties(properties: {
+        [type: string]: Record<string, string>;
+    }): this;
     /***
      *** FEATURE FLAGS
      ***/
     private decideAsync;
     private _decideAsync;
-    getFeatureFlag(key: string, defaultResult?: string | boolean): boolean | string | undefined;
+    private setKnownFeatureFlags;
+    private setKnownFeatureFlagPayloads;
+    getFeatureFlag(key: string): boolean | string | undefined;
+    getFeatureFlagPayload(key: string): JsonType | undefined;
+    getFeatureFlagPayloads(): PostHogDecideResponse['featureFlagPayloads'] | undefined;
+    _parsePayload(response: any): any;
     getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
-    isFeatureEnabled(key: string, defaultResult?: boolean): boolean;
-    reloadFeatureFlagsAsync(): Promise<PostHogDecideResponse['featureFlags']>;
+    getFeatureFlagsAndPayloads(): {
+        flags: PostHogDecideResponse['featureFlags'] | undefined;
+        payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
+    };
+    isFeatureEnabled(key: string): boolean | undefined;
+    reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags']>;
     onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;
+    onFeatureFlag(key: string, cb: (value: string | boolean) => void): () => void;
     overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): void;
+    _sendFeatureFlags(event: string, properties?: {
+        [key: string]: any;
+    }): void;
     /***
      *** QUEUEING AND FLUSHING
      ***/