posthog-node 2.3.1 → 2.5.0

package/lib/index.d.ts

@@ -18,6 +18,20 @@ declare type PosthogCoreOptions = {
     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",
+    PersonProperties = "person_properties",
+    GroupProperties = "group_properties"
+}
 declare type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
     mode?: 'no-cors';
@@ -28,11 +42,17 @@ declare type PostHogFetchOptions = {
     body?: string;
     signal?: AbortSignal;
 };
+declare type PosthogCaptureOptions = {
+    timestamp?: Date;
+};
 declare type PostHogFetchResponse = {
     status: number;
     text: () => Promise<string>;
     json: () => Promise<any>;
 };
+declare type PostHogEventProperties = {
+    [key: string]: any;
+};
 declare type PostHogDecideResponse = {
     config: {
         enable_collect_everything: boolean;
@@ -60,6 +80,85 @@ declare type JsonType = string | number | boolean | null | {
     [key: string]: JsonType;
 } | Array<JsonType>;
 
+interface RetriableOptions {
+    retryCount?: number;
+    retryDelay?: number;
+    retryCheck?: (err: any) => true;
+}
+
+declare class SimpleEventEmitter {
+    events: {
+        [key: string]: ((...args: any[]) => void)[];
+    };
+    constructor();
+    on(event: string, listener: (...args: any[]) => void): () => void;
+    emit(event: string, payload: any): void;
+}
+
+declare abstract class PostHogCoreStateless {
+    private apiKey;
+    host: string;
+    private flushAt;
+    private flushInterval;
+    private requestTimeout;
+    private captureMode;
+    private removeDebugCallback?;
+    private _optoutOverride;
+    protected _events: SimpleEventEmitter;
+    protected _flushTimer?: any;
+    protected _retryOptions: RetriableOptions;
+    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);
+    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;
+    }): 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>>): Promise<boolean | string | undefined>;
+    protected getFeatureFlagPayloadStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<JsonType | undefined>;
+    protected getFeatureFlagPayloadsStateless(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): 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>>): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
+    protected getFeatureFlagsAndPayloadsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): 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;
+}
+
 interface IdentifyMessageV1 {
     distinctId: string;
     properties?: Record<string | number, any>;
@@ -68,6 +167,7 @@ interface EventMessageV1 extends IdentifyMessageV1 {
     event: string;
     groups?: Record<string, string | number>;
     sendFeatureFlags?: boolean;
+    timestamp?: Date;
 }
 interface GroupIdentifyMessage {
     groupType: string;
@@ -202,16 +302,22 @@ declare type PostHogOptions = PosthogCoreOptions & {
     maxCacheSize?: number;
     fetch?: (url: string, options: PostHogFetchOptions) => Promise<PostHogFetchResponse>;
 };
-declare class PostHog implements PostHogNodeV1 {
-    private _sharedClient;
+declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
+    private _memoryStorage;
     private featureFlagsPoller?;
     private maxCacheSize;
+    private options;
     distinctIdHasSentFlagCalls: Record<string, string[]>;
     constructor(apiKey: string, options?: PostHogOptions);
-    private reInit;
+    getPersistedProperty(key: PostHogPersistedProperty): any | undefined;
+    setPersistedProperty(key: PostHogPersistedProperty, value: any | null): void;
+    fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
+    getLibraryId(): string;
+    getLibraryVersion(): string;
+    getCustomUserAgent(): string;
     enable(): void;
     disable(): void;
-    capture({ distinctId, event, properties, groups, sendFeatureFlags }: EventMessageV1): void;
+    capture({ distinctId, event, properties, groups, sendFeatureFlags, timestamp }: EventMessageV1): void;
     identify({ distinctId, properties }: IdentifyMessageV1): void;
     alias(data: {
         distinctId: string;
@@ -252,10 +358,8 @@ declare class PostHog implements PostHogNodeV1 {
     }): Promise<PosthogFlagsAndPayloadsResponse>;
     groupIdentify({ groupType, groupKey, properties }: GroupIdentifyMessage): void;
     reloadFeatureFlags(): Promise<void>;
-    flush(): void;
     shutdown(): void;
     shutdownAsync(): Promise<void>;
-    debug(enabled?: boolean): void;
 }
 
 export { PostHog, PostHogOptions };