posthog-node 2.4.0 → 2.5.0

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

@@ -3,42 +3,84 @@ import { RetriableOptions } from './utils';
 export * as utils from './utils';
 import { LZString } from './lz-string';
 import { SimpleEventEmitter } from './eventemitter';
-export declare abstract class PostHogCore {
+export declare abstract class PostHogCoreStateless {
     private apiKey;
     host: string;
     private flushAt;
     private flushInterval;
     private requestTimeout;
     private captureMode;
-    private sendFeatureFlagEvent;
-    private flagCallReported;
     private removeDebugCallback?;
+    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;
+    }): 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;
+}
+export 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;
@@ -83,26 +125,17 @@ export 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;
 }
 export * from './types';
 export { LZString };

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

@@ -1,4 +1,4 @@
-import { JsonType, PosthogCoreOptions, PostHogFetchOptions, PostHogFetchResponse, PosthogFlagsAndPayloadsResponse } from '../../posthog-core/src';
+import { JsonType, PosthogCoreOptions, PostHogCoreStateless, PostHogFetchOptions, PostHogFetchResponse, PosthogFlagsAndPayloadsResponse, PostHogPersistedProperty } from '../../posthog-core/src';
 import { EventMessageV1, GroupIdentifyMessage, IdentifyMessageV1, PostHogNodeV1 } from './types';
 export declare type PostHogOptions = PosthogCoreOptions & {
     persistence?: 'memory';
@@ -8,13 +8,19 @@ export declare type PostHogOptions = PosthogCoreOptions & {
     maxCacheSize?: number;
     fetch?: (url: string, options: PostHogFetchOptions) => Promise<PostHogFetchResponse>;
 };
-export declare class PostHog implements PostHogNodeV1 {
-    private _sharedClient;
+export 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, timestamp }: EventMessageV1): void;
@@ -58,8 +64,6 @@ export 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;
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "posthog-node",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "PostHog Node.js integration",
   "repository": "PostHog/posthog-node",
   "scripts": {
     "prepublishOnly": "cd .. && yarn build"
   },
   "engines": {
-    "node": ">=14.17.0"
+    "node": ">=15.0.0"
   },
   "license": "MIT",
   "author": {

package/src/posthog-node.ts

@@ -2,8 +2,8 @@ import { version } from '../package.json'
 
 import {
   JsonType,
-  PostHogCore,
   PosthogCoreOptions,
+  PostHogCoreStateless,
   PostHogFetchOptions,
   PostHogFetchResponse,
   PosthogFlagsAndPayloadsResponse,
@@ -29,15 +29,37 @@ export type PostHogOptions = PosthogCoreOptions & {
 const THIRTY_SECONDS = 30 * 1000
 const MAX_CACHE_SIZE = 50 * 1000
 
-class PostHogClient extends PostHogCore {
+// The actual exported Nodejs API.
+export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
   private _memoryStorage = new PostHogMemoryStorage()
 
-  constructor(apiKey: string, private options: PostHogOptions = {}) {
-    options.captureMode = options?.captureMode || 'json'
-    options.preloadFeatureFlags = false // Don't preload as this makes no sense without a distinctId
-    options.sendFeatureFlagEvent = false // Let `posthog-node` handle this on its own, since we're dealing with multiple distinctIDs
+  private featureFlagsPoller?: FeatureFlagsPoller
+  private maxCacheSize: number
+  private options: PostHogOptions
+
+  distinctIdHasSentFlagCalls: Record<string, string[]>
 
+  constructor(apiKey: string, options: PostHogOptions = {}) {
+    options.captureMode = options?.captureMode || 'json'
     super(apiKey, options)
+
+    this.options = options
+
+    if (options.personalApiKey) {
+      this.featureFlagsPoller = new FeatureFlagsPoller({
+        pollingInterval:
+          typeof options.featureFlagsPollingInterval === 'number'
+            ? options.featureFlagsPollingInterval
+            : THIRTY_SECONDS,
+        personalApiKey: options.personalApiKey,
+        projectApiKey: apiKey,
+        timeout: options.requestTimeout ?? 10000, // 10 seconds
+        host: this.host,
+        fetch: options.fetch,
+      })
+    }
+    this.distinctIdHasSentFlagCalls = {}
+    this.maxCacheSize = options.maxCacheSize || MAX_CACHE_SIZE
   }
 
   getPersistedProperty(key: PostHogPersistedProperty): any | undefined {
@@ -48,11 +70,6 @@ class PostHogClient extends PostHogCore {
     return this._memoryStorage.setProperty(key, value)
   }
 
-  getSessionId(): string | undefined {
-    // Sessions don't make sense for Node
-    return undefined
-  }
-
   fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse> {
     return this.options.fetch ? this.options.fetch(url, options) : fetch(url, options)
   }
@@ -66,76 +83,45 @@ class PostHogClient extends PostHogCore {
   getCustomUserAgent(): string {
     return `posthog-node/${version}`
   }
-}
-
-// The actual exported Nodejs API.
-export class PostHog implements PostHogNodeV1 {
-  private _sharedClient: PostHogClient
-  private featureFlagsPoller?: FeatureFlagsPoller
-  private maxCacheSize: number
-
-  distinctIdHasSentFlagCalls: Record<string, string[]>
-
-  constructor(apiKey: string, options: PostHogOptions = {}) {
-    this._sharedClient = new PostHogClient(apiKey, options)
-    if (options.personalApiKey) {
-      this.featureFlagsPoller = new FeatureFlagsPoller({
-        pollingInterval:
-          typeof options.featureFlagsPollingInterval === 'number'
-            ? options.featureFlagsPollingInterval
-            : THIRTY_SECONDS,
-        personalApiKey: options.personalApiKey,
-        projectApiKey: apiKey,
-        timeout: options.requestTimeout ?? 10000, // 10 seconds
-        host: this._sharedClient.host,
-        fetch: options.fetch,
-      })
-    }
-    this.distinctIdHasSentFlagCalls = {}
-    this.maxCacheSize = options.maxCacheSize || MAX_CACHE_SIZE
-  }
-
-  private reInit(distinctId: string): void {
-    // Certain properties we want to persist. Queue is persisted always by default.
-    this._sharedClient.reset([PostHogPersistedProperty.OptedOut])
-    this._sharedClient.setPersistedProperty(PostHogPersistedProperty.DistinctId, distinctId)
-  }
 
   enable(): void {
-    return this._sharedClient.optIn()
+    return super.optIn()
   }
 
   disable(): void {
-    return this._sharedClient.optOut()
+    return super.optOut()
   }
 
   capture({ distinctId, event, properties, groups, sendFeatureFlags, timestamp }: EventMessageV1): void {
-    this.reInit(distinctId)
-    if (groups) {
-      this._sharedClient.groups(groups)
-    }
-
-    const _capture = (): void => {
-      this._sharedClient.capture(event, properties, { timestamp })
+    const _capture = (props: EventMessageV1['properties']): void => {
+      super.captureStateless(distinctId, event, props, { timestamp })
     }
 
     if (sendFeatureFlags) {
-      this._sharedClient.reloadFeatureFlagsAsync(false).finally(() => {
-        _capture()
+      super.getFeatureFlagsStateless(distinctId, groups).then((flags) => {
+        const featureVariantProperties: Record<string, string | boolean> = {}
+        if (flags) {
+          for (const [feature, variant] of Object.entries(flags)) {
+            featureVariantProperties[`$feature/${feature}`] = variant
+          }
+        }
+        const flagProperties = {
+          $active_feature_flags: flags ? Object.keys(flags) : undefined,
+          ...featureVariantProperties,
+        }
+        _capture({ ...properties, $groups: groups, ...flagProperties })
       })
     } else {
-      _capture()
+      _capture({ ...properties, $groups: groups })
     }
   }
 
   identify({ distinctId, properties }: IdentifyMessageV1): void {
-    this.reInit(distinctId)
-    this._sharedClient.identify(distinctId, properties)
+    super.identifyStateless(distinctId, properties)
   }
 
   alias(data: { distinctId: string; alias: string }): void {
-    this.reInit(data.distinctId)
-    this._sharedClient.alias(data.alias)
+    super.aliasStateless(data.alias, data.distinctId)
   }
 
   async getFeatureFlag(
@@ -171,20 +157,7 @@ export class PostHog implements PostHogNodeV1 {
     const flagWasLocallyEvaluated = response !== undefined
 
     if (!flagWasLocallyEvaluated && !onlyEvaluateLocally) {
-      this.reInit(distinctId)
-      if (groups != undefined) {
-        this._sharedClient.groups(groups)
-      }
-
-      if (personProperties) {
-        this._sharedClient.personProperties(personProperties)
-      }
-
-      if (groupProperties) {
-        this._sharedClient.groupProperties(groupProperties)
-      }
-      await this._sharedClient.reloadFeatureFlagsAsync(false)
-      response = this._sharedClient.getFeatureFlag(key)
+      response = await super.getFeatureFlagStateless(key, distinctId, groups, personProperties, groupProperties)
     }
 
     const featureFlagReportedKey = `${key}_${response}`
@@ -260,20 +233,7 @@ export class PostHog implements PostHogNodeV1 {
     const payloadWasLocallyEvaluated = response !== undefined
 
     if (!payloadWasLocallyEvaluated && !onlyEvaluateLocally) {
-      this.reInit(distinctId)
-      if (groups != undefined) {
-        this._sharedClient.groups(groups)
-      }
-
-      if (personProperties) {
-        this._sharedClient.personProperties(personProperties)
-      }
-
-      if (groupProperties) {
-        this._sharedClient.groupProperties(groupProperties)
-      }
-      await this._sharedClient.reloadFeatureFlagsAsync(false)
-      response = this._sharedClient.getFeatureFlagPayload(key)
+      response = await super.getFeatureFlagPayloadStateless(key, distinctId, groups, personProperties, groupProperties)
     }
 
     try {
@@ -348,20 +308,12 @@ export class PostHog implements PostHogNodeV1 {
     }
 
     if (fallbackToDecide && !onlyEvaluateLocally) {
-      this.reInit(distinctId)
-      if (groups) {
-        this._sharedClient.groups(groups)
-      }
-
-      if (personProperties) {
-        this._sharedClient.personProperties(personProperties)
-      }
-
-      if (groupProperties) {
-        this._sharedClient.groupProperties(groupProperties)
-      }
-      await this._sharedClient.reloadFeatureFlagsAsync(false)
-      const remoteEvaluationResult = this._sharedClient.getFeatureFlagsAndPayloads()
+      const remoteEvaluationResult = await super.getFeatureFlagsAndPayloadsStateless(
+        distinctId,
+        groups,
+        personProperties,
+        groupProperties
+      )
       featureFlags = {
         ...featureFlags,
         ...(remoteEvaluationResult.flags || {}),
@@ -376,28 +328,19 @@ export class PostHog implements PostHogNodeV1 {
   }
 
   groupIdentify({ groupType, groupKey, properties }: GroupIdentifyMessage): void {
-    this.reInit(`$${groupType}_${groupKey}`)
-    this._sharedClient.groupIdentify(groupType, groupKey, properties)
+    super.groupIdentifyStateless(groupType, groupKey, properties)
   }
 
   async reloadFeatureFlags(): Promise<void> {
     await this.featureFlagsPoller?.loadFeatureFlags(true)
   }
 
-  flush(): void {
-    this._sharedClient.flush()
-  }
-
   shutdown(): void {
     void this.shutdownAsync()
   }
 
   async shutdownAsync(): Promise<void> {
     this.featureFlagsPoller?.stopPoller()
-    return this._sharedClient.shutdownAsync()
-  }
-
-  debug(enabled?: boolean): void {
-    return this._sharedClient.debug(enabled)
+    return super.shutdownAsync()
   }
 }

package/lib/node_modules/tslib/tslib.es6.d.ts

@@ -1,35 +0,0 @@
-export function __extends(d: any, b: any): void;
-export function __rest(s: any, e: any): {};
-export function __decorate(decorators: any, target: any, key: any, desc: any, ...args: any[]): any;
-export function __param(paramIndex: any, decorator: any): (target: any, key: any) => void;
-export function __metadata(metadataKey: any, metadataValue: any): any;
-export function __awaiter(thisArg: any, _arguments: any, P: any, generator: any): any;
-export function __generator(thisArg: any, body: any): {
-    next: (v: any) => any;
-    throw: (v: any) => any;
-    return: (v: any) => any;
-};
-export function __exportStar(m: any, o: any): void;
-export function __values(o: any): any;
-export function __read(o: any, n: any): any;
-/** @deprecated */
-export function __spread(...args: any[]): any[];
-/** @deprecated */
-export function __spreadArrays(...args: any[]): any[];
-export function __spreadArray(to: any, from: any, pack: any, ...args: any[]): any;
-export function __await(v: any): __await;
-export class __await {
-    constructor(v: any);
-    v: any;
-}
-export function __asyncGenerator(thisArg: any, _arguments: any, generator: any): {};
-export function __asyncDelegator(o: any): {};
-export function __asyncValues(o: any): any;
-export function __makeTemplateObject(cooked: any, raw: any): any;
-export function __importStar(mod: any): any;
-export function __importDefault(mod: any): any;
-export function __classPrivateFieldGet(receiver: any, state: any, kind: any, f: any): any;
-export function __classPrivateFieldSet(receiver: any, state: any, value: any, kind: any, f: any): any;
-export function __classPrivateFieldIn(state: any, receiver: any): any;
-export function __assign(...args: any[]): any;
-export function __createBinding(o: any, m: any, k: any, k2: any): void;