posthog-node 2.3.0 → 2.4.0

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

@@ -1,4 +1,4 @@
-import { PostHogFetchOptions, PostHogFetchResponse, PostHogAutocaptureElement, PostHogDecideResponse, PosthogCoreOptions, PostHogEventProperties, PostHogPersistedProperty, JsonType } from './types';
+import { PostHogFetchOptions, PostHogFetchResponse, PostHogAutocaptureElement, PostHogDecideResponse, PosthogCoreOptions, PostHogEventProperties, PostHogPersistedProperty, PosthogCaptureOptions, JsonType } from './types';
 import { RetriableOptions } from './utils';
 export * as utils from './utils';
 import { LZString } from './lz-string';
@@ -50,20 +50,20 @@ export declare abstract class PostHogCore {
     /***
      *** TRACKING
      ***/
-    identify(distinctId?: string, properties?: PostHogEventProperties): this;
+    identify(distinctId?: string, properties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
     capture(event: string, properties?: {
         [key: string]: any;
-    }, forceSendFeatureFlags?: boolean): this;
+    }, options?: PosthogCaptureOptions): this;
     alias(alias: string): this;
-    autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties): this;
+    autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
     /***
      *** GROUPS
      ***/
     groups(groups: {
         [type: string]: string | number;
     }): this;
-    group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties): this;
-    groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties): this;
+    group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
+    groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
     /***
      * PROPERTIES
      ***/
@@ -94,9 +94,6 @@ export declare abstract class PostHogCore {
     onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;
     onFeatureFlag(key: string, cb: (value: string | boolean) => void): () => void;
     overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): void;
-    _sendFeatureFlags(event: string, properties?: {
-        [key: string]: any;
-    }): void;
     /***
      *** QUEUEING AND FLUSHING
      ***/

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

@@ -42,6 +42,9 @@ export declare type PostHogFetchOptions = {
     body?: string;
     signal?: AbortSignal;
 };
+export declare type PosthogCaptureOptions = {
+    timestamp?: Date;
+};
 export declare type PostHogFetchResponse = {
     status: number;
     text: () => Promise<string>;

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

@@ -17,7 +17,7 @@ export declare class PostHog implements PostHogNodeV1 {
     private reInit;
     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;

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

@@ -1,4 +1,4 @@
-import { JsonType } from 'posthog-core/src';
+import { JsonType } from '../../posthog-core/src';
 export interface IdentifyMessageV1 {
     distinctId: string;
     properties?: Record<string | number, any>;
@@ -7,6 +7,7 @@ export interface EventMessageV1 extends IdentifyMessageV1 {
     event: string;
     groups?: Record<string, string | number>;
     sendFeatureFlags?: boolean;
+    timestamp?: Date;
 }
 export interface GroupIdentifyMessage {
     groupType: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "posthog-node",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "PostHog Node.js integration",
   "repository": "PostHog/posthog-node",
   "scripts": {

package/src/posthog-node.ts

@@ -109,12 +109,23 @@ export class PostHog implements PostHogNodeV1 {
     return this._sharedClient.optOut()
   }
 
-  capture({ distinctId, event, properties, groups, sendFeatureFlags }: EventMessageV1): void {
+  capture({ distinctId, event, properties, groups, sendFeatureFlags, timestamp }: EventMessageV1): void {
     this.reInit(distinctId)
     if (groups) {
       this._sharedClient.groups(groups)
     }
-    this._sharedClient.capture(event, properties, sendFeatureFlags || false)
+
+    const _capture = (): void => {
+      this._sharedClient.capture(event, properties, { timestamp })
+    }
+
+    if (sendFeatureFlags) {
+      this._sharedClient.reloadFeatureFlagsAsync(false).finally(() => {
+        _capture()
+      })
+    } else {
+      _capture()
+    }
   }
 
   identify({ distinctId, properties }: IdentifyMessageV1): void {

package/src/types.ts

@@ -1,4 +1,4 @@
-import { JsonType } from 'posthog-core/src'
+import { JsonType } from '../../posthog-core/src'
 
 export interface IdentifyMessageV1 {
   distinctId: string
@@ -9,6 +9,7 @@ export interface EventMessageV1 extends IdentifyMessageV1 {
   event: string
   groups?: Record<string, string | number> // Mapping of group type to group id
   sendFeatureFlags?: boolean
+  timestamp?: Date
 }
 
 export interface GroupIdentifyMessage {

package/test/posthog-node.spec.ts

@@ -136,6 +136,20 @@ describe('PostHog Node.js', () => {
         },
       ])
     })
+
+    it('should allow overriding timestamp', async () => {
+      expect(mockedFetch).toHaveBeenCalledTimes(0)
+      posthog.capture({ event: 'custom-time', distinctId: '123', timestamp: new Date('2021-02-03') })
+      jest.runOnlyPendingTimers()
+      const batchEvents = getLastBatchEvents()
+      expect(batchEvents).toMatchObject([
+        {
+          distinct_id: '123',
+          timestamp: '2021-02-03T00:00:00.000Z',
+          event: 'custom-time',
+        },
+      ])
+    })
   })
 
   describe('groupIdentify', () => {