posthog-js-lite 2.2.0 → 2.3.0

package/lib/index.d.ts

@@ -16,6 +16,7 @@ declare type PosthogCoreOptions = {
     requestTimeout?: number;
     sessionExpirationTimeSeconds?: number;
     captureMode?: 'json' | 'form';
+    disableGeoip?: boolean;
 };
 declare enum PostHogPersistedProperty {
     AnonymousId = "anonymous_id",
@@ -43,6 +44,7 @@ declare type PostHogFetchOptions = {
 };
 declare type PosthogCaptureOptions = {
     timestamp?: Date;
+    disableGeoip?: boolean;
 };
 declare type PostHogFetchResponse = {
     status: number;
@@ -88,7 +90,7 @@ declare type JsonType = string | number | boolean | null | {
 interface RetriableOptions {
     retryCount?: number;
     retryDelay?: number;
-    retryCheck?: (err: any) => true;
+    retryCheck?: (err: any) => boolean;
 }
 
 declare class SimpleEventEmitter {
@@ -100,42 +102,87 @@ declare class SimpleEventEmitter {
     emit(event: string, payload: any): void;
 }
 
-declare abstract class PostHogCore {
+declare abstract class PostHogCoreStateless {
     private apiKey;
     host: string;
     private flushAt;
     private flushInterval;
     private requestTimeout;
     private captureMode;
-    private sendFeatureFlagEvent;
-    private flagCallReported;
     private removeDebugCallback?;
+    private debugMode;
+    private pendingPromises;
+    private disableGeoip;
+    private _optoutOverride;
     protected _events: SimpleEventEmitter;
     protected _flushTimer?: any;
-    protected _decideResponsePromise?: Promise<PostHogDecideResponse>;
     protected _retryOptions: RetriableOptions;
-    protected _sessionExpirationTimeSeconds: number;
     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;
-    private _optoutOverride;
     constructor(apiKey: string, options?: PosthogCoreOptions);
     protected getCommonEventProperties(): any;
+    get optedOut(): boolean;
+    optIn(): void;
+    optOut(): void;
+    on(event: string, cb: (...args: any[]) => void): () => void;
+    debug(enabled?: boolean): void;
+    private buildPayload;
+    /***
+     *** TRACKING
+     ***/
+    protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
+    protected captureStateless(distinctId: string, event: string, properties?: {
+        [key: string]: any;
+    }, options?: PosthogCaptureOptions): this;
+    protected aliasStateless(alias: string, distinctId: string, properties?: {
+        [key: string]: any;
+    }, options?: PosthogCaptureOptions): this;
+    /***
+     *** GROUPS
+     ***/
+    protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PosthogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): this;
+    /***
+     *** 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 getFeatureFlagStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<boolean | string | 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): Promise<PostHogDecideResponse['featureFlagPayloads'] | undefined>;
+    protected _parsePayload(response: any): any;
+    protected getFeatureFlagsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
+    protected getFeatureFlagsAndPayloadsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
+        flags: PostHogDecideResponse['featureFlags'] | undefined;
+        payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
+    }>;
+    /***
+     *** QUEUEING AND FLUSHING
+     ***/
+    protected enqueue(type: string, _message: any, options?: PosthogCaptureOptions): void;
+    flushAsync(): Promise<any>;
+    flush(callback?: (err?: any, data?: any) => void): void;
+    private fetchWithRetry;
+    shutdownAsync(): Promise<void>;
+    shutdown(): void;
+}
+declare abstract class PostHogCore extends PostHogCoreStateless {
+    private sendFeatureFlagEvent;
+    private flagCallReported;
+    protected _decideResponsePromise?: Promise<PostHogDecideResponse | undefined>;
+    protected _sessionExpirationTimeSeconds: number;
+    constructor(apiKey: string, options?: PosthogCoreOptions);
     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(propertiesToKeep?: PostHogPersistedProperty[]): void;
-    debug(enabled?: boolean): void;
-    private buildPayload;
+    protected getCommonEventProperties(): any;
+    private enrichProperties;
     getSessionId(): string | undefined;
     resetSessionId(): void;
     getAnonymousId(): string;
@@ -180,26 +227,17 @@ declare abstract class PostHogCore {
     getFeatureFlag(key: string): boolean | string | undefined;
     getFeatureFlagPayload(key: string): JsonType | undefined;
     getFeatureFlagPayloads(): PostHogDecideResponse['featureFlagPayloads'] | undefined;
-    _parsePayload(response: any): any;
     getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
     getFeatureFlagsAndPayloads(): {
         flags: PostHogDecideResponse['featureFlags'] | undefined;
         payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
     };
     isFeatureEnabled(key: string): boolean | undefined;
-    reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags']>;
+    reloadFeatureFlags(cb?: (err?: Error, flags?: PostHogDecideResponse['featureFlags']) => void): void;
+    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;
-    /***
-     *** QUEUEING AND FLUSHING
-     ***/
-    private enqueue;
-    flushAsync(): Promise<any>;
-    flush(callback?: (err?: any, data?: any) => void): void;
-    private fetchWithRetry;
-    shutdownAsync(): Promise<void>;
-    shutdown(): void;
 }
 
 declare type PostHogOptions = {