posthog-node 4.2.0 → 4.2.2

package/lib/posthog-core/src/index.d.ts

@@ -4,8 +4,8 @@ export * as utils from './utils';
 import { LZString } from './lz-string';
 import { SimpleEventEmitter } from './eventemitter';
 export declare abstract class PostHogCoreStateless {
-    private apiKey;
-    host: string;
+    readonly apiKey: string;
+    readonly host: string;
     private flushAt;
     private maxBatchSize;
     private maxQueueSize;
@@ -17,7 +17,7 @@ export declare abstract class PostHogCoreStateless {
     private removeDebugCallback?;
     private disableGeoip;
     private historicalMigration;
-    disabled: boolean;
+    protected disabled: boolean;
     private defaultOptIn;
     private pendingPromises;
     protected _events: SimpleEventEmitter;
@@ -32,6 +32,7 @@ export 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;
@@ -40,6 +41,7 @@ export 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>;
     /***

package/lib/posthog-core/src/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-export declare type PostHogCoreOptions = {
+export 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 @@ export 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 @@ export declare enum PostHogPersistedProperty {
     PersonProperties = "person_properties",
     GroupProperties = "group_properties",
     InstalledAppBuild = "installed_app_build",
-    InstalledAppVersion = "installed_app_version"
+    InstalledAppVersion = "installed_app_version",
+    SessionReplay = "session_replay"
 }
-export declare type PostHogFetchOptions = {
+export type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
     mode?: 'no-cors';
     credentials?: 'omit';
@@ -69,26 +70,26 @@ export declare type PostHogFetchOptions = {
     body?: string;
     signal?: AbortSignal;
 };
-export declare type PostHogCaptureOptions = {
+export type PostHogCaptureOptions = {
     /** If provided overrides the auto-generated event ID */
     uuid?: string;
     /** If provided overrides the auto-generated timestamp */
     timestamp?: Date;
     disableGeoip?: boolean;
 };
-export declare type PostHogFetchResponse = {
+export type PostHogFetchResponse = {
     status: number;
     text: () => Promise<string>;
     json: () => Promise<any>;
 };
-export declare type PostHogQueueItem = {
+export type PostHogQueueItem = {
     message: any;
     callback?: (err: any) => void;
 };
-export declare type PostHogEventProperties = {
+export type PostHogEventProperties = {
     [key: string]: any;
 };
-export declare type PostHogAutocaptureElement = {
+export type PostHogAutocaptureElement = {
     $el_text?: string;
     tag_name: string;
     href?: string;
@@ -98,7 +99,7 @@ export declare type PostHogAutocaptureElement = {
 } & {
     [key: string]: any;
 };
-export declare type PostHogDecideResponse = {
+export type PostHogDecideResponse = {
     config: {
         enable_collect_everything: boolean;
     };
@@ -115,12 +116,14 @@ export declare type PostHogDecideResponse = {
         [key: string]: JsonType;
     };
     errorsWhileComputingFlags: boolean;
-    sessionRecording: boolean;
+    sessionRecording?: boolean | {
+        [key: string]: JsonType;
+    };
 };
-export declare type PostHogFlagsAndPayloadsResponse = {
+export type PostHogFlagsAndPayloadsResponse = {
     featureFlags: PostHogDecideResponse['featureFlags'];
     featureFlagPayloads: PostHogDecideResponse['featureFlagPayloads'];
 };
-export declare type JsonType = string | number | boolean | null | {
+export type JsonType = string | number | boolean | null | {
     [key: string]: JsonType;
 } | Array<JsonType>;

package/lib/posthog-node/src/extensions/sentry-integration.d.ts

@@ -2,8 +2,8 @@
  * @file Adapted from [posthog-js](https://github.com/PostHog/posthog-js/blob/8157df935a4d0e71d2fefef7127aa85ee51c82d1/src/extensions/sentry-integration.ts) with modifications for the Node SDK.
  */
 import { type PostHog } from '../posthog-node';
-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;

package/lib/posthog-node/src/feature-flags.d.ts

@@ -7,7 +7,7 @@ declare class ClientError extends Error {
 declare class InconclusiveMatchError extends Error {
     constructor(message: string);
 }
-declare type FeatureFlagsPollerOptions = {
+type FeatureFlagsPollerOptions = {
     personalApiKey: string;
     projectApiKey: string;
     host: string;
@@ -39,6 +39,7 @@ declare class FeatureFlagsPoller {
     };
     constructor({ pollingInterval, personalApiKey, projectApiKey, timeout, host, customHeaders, ...options }: FeatureFlagsPollerOptions);
     debug(enabled?: boolean): void;
+    private logMsgIfDebug;
     getFeatureFlag(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<string | boolean | undefined>;
     computeFeatureFlagPayloadLocally(key: string, matchValue: string | boolean): Promise<JsonType | undefined>;
     getAllFlagsAndPayloads(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<{

package/lib/posthog-node/src/fetch.d.ts

@@ -7,6 +7,6 @@
  * See https://github.com/PostHog/posthog-js-lite/issues/127 for more info
  */
 import { PostHogFetchOptions, PostHogFetchResponse } from 'posthog-core/src';
-declare type FetchLike = (url: string, options: PostHogFetchOptions) => Promise<PostHogFetchResponse>;
+type FetchLike = (url: string, options: PostHogFetchOptions) => Promise<PostHogFetchResponse>;
 declare const _default: FetchLike;
 export default _default;

package/lib/posthog-node/src/posthog-node.d.ts

@@ -1,6 +1,6 @@
 import { JsonType, PostHogCoreOptions, PostHogCoreStateless, PostHogFetchOptions, PostHogFetchResponse, PostHogFlagsAndPayloadsResponse, PostHogPersistedProperty } from '../../posthog-core/src';
 import { EventMessage, GroupIdentifyMessage, IdentifyMessage, PostHogNodeV1 } from './types';
-export declare type PostHogOptions = PostHogCoreOptions & {
+export type PostHogOptions = PostHogCoreOptions & {
     persistence?: 'memory';
     personalApiKey?: string;
     featureFlagsPollingInterval?: number;

package/lib/posthog-node/src/types.d.ts

@@ -18,23 +18,23 @@ export interface GroupIdentifyMessage {
     distinctId?: string;
     disableGeoip?: boolean;
 }
-export declare type PropertyGroup = {
+export type PropertyGroup = {
     type: 'AND' | 'OR';
     values: PropertyGroup[] | FlagProperty[];
 };
-export declare type FlagProperty = {
+export type FlagProperty = {
     key: string;
     type?: string;
     value: string | number | (string | number)[];
     operator?: string;
     negation?: boolean;
 };
-export declare type FeatureFlagCondition = {
+export type FeatureFlagCondition = {
     properties: FlagProperty[];
     rollout_percentage?: number;
     variant?: string;
 };
-export declare type PostHogFeatureFlag = {
+export type PostHogFeatureFlag = {
     id: number;
     name: string;
     key: string;
@@ -56,7 +56,7 @@ export declare type PostHogFeatureFlag = {
     ensure_experience_continuity: boolean;
     experiment_set: number[];
 };
-export declare type PostHogNodeV1 = {
+export 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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "posthog-node",
-  "version": "4.2.0",
+  "version": "4.2.2",
   "description": "PostHog Node.js integration",
   "repository": {
     "type": "git",

package/src/feature-flags.ts

@@ -90,6 +90,12 @@ class FeatureFlagsPoller {
     this.debugMode = enabled
   }
 
+  private logMsgIfDebug(fn: () => void): void {
+    if (this.debugMode) {
+      fn()
+    }
+  }
+
   async getFeatureFlag(
     key: string,
     distinctId: string,
@@ -99,7 +105,7 @@ class FeatureFlagsPoller {
   ): Promise<string | boolean | undefined> {
     await this.loadFeatureFlags()
 
-    let response = undefined
+    let response: string | boolean | undefined = undefined
     let featureFlag = undefined
 
     if (!this.loadedSuccessfullyOnce) {
@@ -116,14 +122,10 @@ class FeatureFlagsPoller {
     if (featureFlag !== undefined) {
       try {
         response = this.computeFlagLocally(featureFlag, distinctId, groups, personProperties, groupProperties)
-        if (this.debugMode) {
-          console.debug(`Successfully computed flag locally: ${key} -> ${response}`)
-        }
+        this.logMsgIfDebug(() => console.debug(`Successfully computed flag locally: ${key} -> ${response}`))
       } catch (e) {
         if (e instanceof InconclusiveMatchError) {
-          if (this.debugMode) {
-            console.debug(`InconclusiveMatchError when computing flag locally: ${key}: ${e}`)
-          }
+          this.logMsgIfDebug(() => console.debug(`InconclusiveMatchError when computing flag locally: ${key}: ${e}`))
         } else if (e instanceof Error) {
           this.onError?.(new Error(`Error computing flag locally: ${key}: ${e}`))
         }
@@ -219,18 +221,18 @@ class FeatureFlagsPoller {
       const groupName = this.groupTypeMapping[String(aggregation_group_type_index)]
 
       if (!groupName) {
-        if (this.debugMode) {
+        this.logMsgIfDebug(() =>
           console.warn(
             `[FEATURE FLAGS] Unknown group type index ${aggregation_group_type_index} for feature flag ${flag.key}`
           )
-        }
+        )
         throw new InconclusiveMatchError('Flag has unknown group type index')
       }
 
       if (!(groupName in groups)) {
-        if (this.debugMode) {
+        this.logMsgIfDebug(() =>
           console.warn(`[FEATURE FLAGS] Can't compute group feature flag: ${flag.key} without group names passed in`)
-        }
+        )
         return false
       }
 
@@ -307,9 +309,7 @@ class FeatureFlagsPoller {
   ): boolean {
     const rolloutPercentage = condition.rollout_percentage
     const warnFunction = (msg: string): void => {
-      if (this.debugMode) {
-        console.warn(msg)
-      }
+      this.logMsgIfDebug(() => console.warn(msg))
     }
     if ((condition.properties || []).length > 0) {
       for (const prop of condition.properties) {

package/src/posthog-node.ts

@@ -39,7 +39,6 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
   distinctIdHasSentFlagCalls: Record<string, string[]>
 
   constructor(apiKey: string, options: PostHogOptions = {}) {
-    options.captureMode = options?.captureMode || 'json'
     super(apiKey, options)
 
     this.options = options