posthog-node 3.5.0 → 3.6.0

package/lib/index.d.ts

@@ -45,7 +45,10 @@ declare type PostHogFetchOptions = {
     body?: string;
     signal?: AbortSignal;
 };
-declare type PosthogCaptureOptions = {
+declare type PostHogCaptureOptions = {
+    /** If provided overrides the auto-generated event ID */
+    uuid?: string;
+    /** If provided overrides the auto-generated timestamp */
     timestamp?: Date;
     disableGeoip?: boolean;
 };
@@ -132,17 +135,17 @@ declare abstract class PostHogCoreStateless {
     /***
      *** TRACKING
      ***/
-    protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
+    protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
     protected captureStateless(distinctId: string, event: string, properties?: {
         [key: string]: any;
-    }, options?: PosthogCaptureOptions): this;
+    }, options?: PostHogCaptureOptions): this;
     protected aliasStateless(alias: string, distinctId: string, properties?: {
         [key: string]: any;
-    }, options?: PosthogCaptureOptions): this;
+    }, options?: PostHogCaptureOptions): this;
     /***
      *** GROUPS
      ***/
-    protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PosthogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): this;
+    protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): this;
     /***
      *** FEATURE FLAGS
      ***/
@@ -159,7 +162,7 @@ declare abstract class PostHogCoreStateless {
     /***
      *** QUEUEING AND FLUSHING
      ***/
-    protected enqueue(type: string, _message: any, options?: PosthogCaptureOptions): void;
+    protected enqueue(type: string, _message: any, options?: PostHogCaptureOptions): void;
     flushAsync(): Promise<any>;
     flush(callback?: (err?: any, data?: any) => void): void;
     private fetchWithRetry;
@@ -167,16 +170,17 @@ declare abstract class PostHogCoreStateless {
     shutdown(): void;
 }
 
-interface IdentifyMessageV1 {
+interface IdentifyMessage {
     distinctId: string;
     properties?: Record<string | number, any>;
     disableGeoip?: boolean;
 }
-interface EventMessageV1 extends IdentifyMessageV1 {
+interface EventMessage extends IdentifyMessage {
     event: string;
     groups?: Record<string, string | number>;
     sendFeatureFlags?: boolean;
     timestamp?: Date;
+    uuid?: string;
 }
 interface GroupIdentifyMessage {
     groupType: string;
@@ -197,7 +201,7 @@ declare type PostHogNodeV1 = {
      * @param groups OPTIONAL | object of what groups are related to this event, example: { company: 'id:5' }. Can be used to analyze companies instead of users.
      * @param sendFeatureFlags OPTIONAL | Used with experiments. Determines whether to send feature flag values with the event.
      */
-    capture({ distinctId, event, properties, groups, sendFeatureFlags }: EventMessageV1): void;
+    capture({ distinctId, event, properties, groups, sendFeatureFlags }: EventMessage): void;
     /**
      * @description Identify lets you add metadata on your users so you can more easily identify who they are in PostHog,
      * and even do things like segment users by these properties.
@@ -205,7 +209,7 @@ declare type PostHogNodeV1 = {
      * @param distinctId which uniquely identifies your user
      * @param properties with a dict with any key: value pairs
      */
-    identify({ distinctId, properties }: IdentifyMessageV1): void;
+    identify({ distinctId, properties }: IdentifyMessage): void;
     /**
      * @description To marry up whatever a user does before they sign up or log in with what they do after you need to make an alias call.
      * This will allow you to answer questions like "Which marketing channels leads to users churning after a month?"
@@ -329,8 +333,8 @@ declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     enable(): void;
     disable(): void;
     debug(enabled?: boolean): void;
-    capture({ distinctId, event, properties, groups, sendFeatureFlags, timestamp, disableGeoip }: EventMessageV1): void;
-    identify({ distinctId, properties, disableGeoip }: IdentifyMessageV1): void;
+    capture({ distinctId, event, properties, groups, sendFeatureFlags, timestamp, disableGeoip, uuid, }: EventMessage): void;
+    identify({ distinctId, properties, disableGeoip }: IdentifyMessage): void;
     alias(data: {
         distinctId: string;
         alias: string;

package/lib/index.esm.js

@@ -154,7 +154,7 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
-var version = "3.5.0";
+var version = "3.6.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -1012,7 +1012,7 @@ var PostHogCoreStateless = /** @class */ (function () {
             this._events.emit(type, "Library is disabled. Not sending event. To re-enable, call posthog.optIn()");
             return;
         }
-        var message = __assign(__assign({}, _message), { type: type, library: this.getLibraryId(), library_version: this.getLibraryVersion(), timestamp: (options === null || options === void 0 ? void 0 : options.timestamp) ? options === null || options === void 0 ? void 0 : options.timestamp : currentISOTime() });
+        var message = __assign(__assign({}, _message), { type: type, library: this.getLibraryId(), library_version: this.getLibraryVersion(), timestamp: (options === null || options === void 0 ? void 0 : options.timestamp) ? options === null || options === void 0 ? void 0 : options.timestamp : currentISOTime(), uuid: (options === null || options === void 0 ? void 0 : options.uuid) ? options.uuid : generateUUID(globalThis) });
         var addGeoipDisableProperty = (_a = options === null || options === void 0 ? void 0 : options.disableGeoip) !== null && _a !== void 0 ? _a : this.disableGeoip;
         if (addGeoipDisableProperty) {
             if (!message.properties) {
@@ -2746,12 +2746,14 @@ function (_super) {
         groups = _a.groups,
         sendFeatureFlags = _a.sendFeatureFlags,
         timestamp = _a.timestamp,
-        disableGeoip = _a.disableGeoip;
+        disableGeoip = _a.disableGeoip,
+        uuid = _a.uuid;
 
     var _capture = function (props) {
       _super.prototype.captureStateless.call(_this, distinctId, event, props, {
         timestamp: timestamp,
-        disableGeoip: disableGeoip
+        disableGeoip: disableGeoip,
+        uuid: uuid
       });
     }; // :TRICKY: If we flush, or need to shut down, to not lose events we want this promise to resolve before we flush