posthog-node 4.2.0 → 4.2.2

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-declare type PostHogCoreOptions = {
+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) */
@@ -37,7 +37,7 @@ 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. */
@@ -57,9 +57,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';
@@ -69,22 +70,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 PostHogDecideResponse = {
+type PostHogDecideResponse = {
     config: {
         enable_collect_everything: boolean;
     };
@@ -101,13 +102,15 @@ declare type PostHogDecideResponse = {
         [key: string]: JsonType;
     };
     errorsWhileComputingFlags: boolean;
-    sessionRecording: boolean;
+    sessionRecording?: boolean | {
+        [key: string]: JsonType;
+    };
 };
-declare type PostHogFlagsAndPayloadsResponse = {
+type PostHogFlagsAndPayloadsResponse = {
     featureFlags: PostHogDecideResponse['featureFlags'];
     featureFlagPayloads: PostHogDecideResponse['featureFlagPayloads'];
 };
-declare type JsonType = string | number | boolean | null | {
+type JsonType = string | number | boolean | null | {
     [key: string]: JsonType;
 } | Array<JsonType>;
 
@@ -127,8 +130,8 @@ declare class SimpleEventEmitter {
 }
 
 declare abstract class PostHogCoreStateless {
-    private apiKey;
-    host: string;
+    readonly apiKey: string;
+    readonly host: string;
     private flushAt;
     private maxBatchSize;
     private maxQueueSize;
@@ -140,7 +143,7 @@ declare abstract class PostHogCoreStateless {
     private removeDebugCallback?;
     private disableGeoip;
     private historicalMigration;
-    disabled: boolean;
+    protected disabled: boolean;
     private defaultOptIn;
     private pendingPromises;
     protected _events: SimpleEventEmitter;
@@ -155,6 +158,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;
@@ -163,6 +167,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>;
     /***
@@ -230,7 +235,7 @@ interface GroupIdentifyMessage {
     distinctId?: string;
     disableGeoip?: boolean;
 }
-declare type PostHogNodeV1 = {
+type PostHogNodeV1 = {
     /**
      * @description Capture allows you to capture anything a user does within your system,
      * which you can later use in PostHog to find patterns in usage,
@@ -352,7 +357,7 @@ declare type PostHogNodeV1 = {
     shutdown(shutdownTimeoutMs?: number): void;
 };
 
-declare type PostHogOptions = PostHogCoreOptions & {
+type PostHogOptions = PostHogCoreOptions & {
     persistence?: 'memory';
     personalApiKey?: string;
     featureFlagsPollingInterval?: number;
@@ -430,8 +435,8 @@ declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
  * @file Adapted from [posthog-js](https://github.com/PostHog/posthog-js/blob/8157df935a4d0e71d2fefef7127aa85ee51c82d1/src/extensions/sentry-integration.ts) with modifications for the Node SDK.
  */
 
-declare type _SentryEventProcessor = any;
-declare type _SentryHub = any;
+type _SentryEventProcessor = any;
+type _SentryHub = any;
 interface _SentryIntegration {
     name: string;
     setupOnce(addGlobalEventProcessor: (callback: _SentryEventProcessor) => void, getCurrentHub: () => _SentryHub): void;