posthog-js 1.34.1 → 1.36.0

package/dist/module.d.ts

@@ -139,6 +139,7 @@ interface PostHogConfig {
     api_host: string;
     api_method: string;
     api_transport: string;
+    ui_host: string | null;
     token: string;
     autocapture: boolean;
     rageclick: boolean;
@@ -195,6 +196,7 @@ interface PostHogConfig {
         isIdentifiedID?: boolean;
         featureFlags?: Record<string, boolean | string>;
     };
+    segment?: any;
 }
 interface OptInOutCapturingOptions {
     capture: (event: string, properties: Properties, options: CaptureOptions) => void;
@@ -909,6 +911,7 @@ declare class PostHog {
     __autocapture_enabled: boolean | undefined;
     decideEndpointWasHit: boolean;
     SentryIntegration: typeof SentryIntegration;
+    segmentIntegration: () => any;
     constructor();
     /**
      * This function initializes a new instance of the PostHog capturing object.
@@ -993,7 +996,7 @@ declare class PostHog {
     capture(event_name: string, properties?: Properties | null, options?: CaptureOptions): CaptureResult | void;
     _addCaptureHook(callback: (eventName: string) => void): void;
     _invokeCaptureHooks(eventName: string, eventData: CaptureResult): void;
-    _calculate_event_properties(event_name: string, event_properties: Properties, start_timestamp: number): Properties;
+    _calculate_event_properties(event_name: string, event_properties: Properties): Properties;
     /**
      * Register a set of super properties, which are included with all
      * events. This will overwrite previous super property values.
@@ -1146,12 +1149,17 @@ declare class PostHog {
      * The default config is:
      *
      *     {
-     *       // Posthog host
+     *       // PostHog API host
      *       api_host: 'https://app.posthog.com',
      *
      *       // HTTP method for capturing requests
      *       api_method: 'POST'
      *
+     *       // PostHog web app host, currently only used by the Sentry integration.
+     *       // This will only be different from api_host when using a reverse-proxied API host – in that case
+     *       // the original web app host needs to be passed here so that links to the web app are still convenient.
+     *       ui_host: 'https://app.posthog.com',
+     *
      *       // Automatically capture clicks, form submissions and change events
      *       autocapture: true
      *

package/dist/module.js

@@ -921,7 +921,7 @@ var LZString = {
   }
 };
 
-var version = "1.34.1";
+var version = "1.36.0";
 
 // e.g.     Config.DEBUG = Config.DEBUG || instance.get_config('debug')
 
@@ -5986,10 +5986,11 @@ var SentryIntegration = /*#__PURE__*/_createClass(function SentryIntegration(_po
 
       if (event.level !== 'error' || !_posthog.__loaded) return event;
       if (!event.tags) event.tags = {};
-      event.tags['PostHog Person URL'] = _posthog.config.api_host + '/person/' + _posthog.get_distinct_id();
+      var host = _posthog.config.ui_host || _posthog.config.api_host;
+      event.tags['PostHog Person URL'] = host + '/person/' + _posthog.get_distinct_id();
 
       if (_posthog.sessionRecordingStarted()) {
-        event.tags['PostHog Recording URL'] = _posthog.config.api_host + '/recordings/#sessionRecordingId=' + _posthog.sessionManager.checkAndGetSessionAndWindowId(true).sessionId;
+        event.tags['PostHog Recording URL'] = host + '/recordings/#sessionRecordingId=' + _posthog.sessionManager.checkAndGetSessionAndWindowId(true).sessionId;
       }
 
       var exceptions = ((_event$exception = event.exception) === null || _event$exception === void 0 ? void 0 : _event$exception.values) || [];
@@ -6009,6 +6010,70 @@ var SentryIntegration = /*#__PURE__*/_createClass(function SentryIntegration(_po
   };
 });
 
+/**
+ * Extend Segment with extra PostHog JS functionality. Required for things like Recordings and feature flags to work correctly.
+ *
+ * ### Usage
+ *
+ *  ```js
+ *  // After your standard segment anyalytics install
+ *  analytics.load("GOEDfA21zZTtR7clsBuDvmBKAtAdZ6Np");
+ *
+ *  analytics.ready(() => {
+ *    posthog.init('<posthog-api-key>', {
+ *      capture_pageview: false,
+ *      segment: window.analytics, // NOTE: Be sure to use window.analytics here!
+ *    });
+ *    window.analytics.page();
+ *  })
+ *  ```
+ */
+// Loosely based on https://github.com/segmentio/analytics-next/blob/master/packages/core/src/plugins/index.ts
+var createSegmentIntegration = function createSegmentIntegration(posthog) {
+  var enrichEvent = function enrichEvent(ctx, eventName) {
+    if (!ctx.event.userId && ctx.event.anonymousId !== posthog.get_distinct_id()) {
+      // This is our only way of detecting that segment's analytics.reset() has been called so we also call it
+      posthog.reset();
+    }
+
+    if (ctx.event.userId && ctx.event.userId !== posthog.get_distinct_id()) {
+      posthog.register({
+        distinct_id: ctx.event.userId
+      });
+      posthog.reloadFeatureFlags();
+    }
+
+    var additionalProperties = posthog._calculate_event_properties(eventName, ctx.event.properties);
+
+    ctx.event.properties = Object.assign({}, additionalProperties, ctx.event.properties);
+    return ctx;
+  };
+
+  return {
+    name: 'PostHog JS',
+    type: 'enrichment',
+    version: '1.0.0',
+    isLoaded: function isLoaded() {
+      return true;
+    },
+    load: function load() {
+      return Promise.resolve();
+    },
+    track: function track(ctx) {
+      return enrichEvent(ctx, ctx.event.event);
+    },
+    page: function page(ctx) {
+      return enrichEvent(ctx, '$pageview');
+    },
+    identify: function identify(ctx) {
+      return enrichEvent(ctx, '$identify');
+    },
+    screen: function screen(ctx) {
+      return enrichEvent(ctx, '$screen');
+    }
+  };
+};
+
 /*
 SIMPLE STYLE GUIDE:
 
@@ -6053,6 +6118,7 @@ var defaultConfig = function defaultConfig() {
     api_host: 'https://app.posthog.com',
     api_method: 'POST',
     api_transport: 'XHR',
+    ui_host: null,
     token: '',
     autocapture: true,
     rageclick: false,
@@ -6198,12 +6264,19 @@ var create_mplib = function create_mplib(token, config, name) {
 
 var PostHog = /*#__PURE__*/function () {
   function PostHog() {
+    var _this = this;
+
     _classCallCheck(this, PostHog);
 
     this.config = defaultConfig();
     this.compression = {};
     this.decideEndpointWasHit = false;
     this.SentryIntegration = SentryIntegration;
+
+    this.segmentIntegration = function () {
+      return createSegmentIntegration(_this);
+    };
+
     this.__captureHooks = [];
     this.__request_queue = [];
     this.__loaded = false;
@@ -6297,6 +6370,22 @@ var PostHog = /*#__PURE__*/function () {
 
       this._gdpr_init();
 
+      if (config.segment) {
+        // Use segments anonymousId instead
+        this.config.get_device_id = function () {
+          return config.segment.user().anonymousId();
+        }; // If a segment user ID exists, set it as the distinct_id
+
+
+        if (config.segment.user().id()) {
+          this.register({
+            distinct_id: config.segment.user().id()
+          });
+        }
+
+        config.segment.register(this.segmentIntegration());
+      }
+
       if (((_config$bootstrap = config.bootstrap) === null || _config$bootstrap === void 0 ? void 0 : _config$bootstrap.distinctID) !== undefined) {
         var _config$bootstrap2;
 
@@ -6387,11 +6476,11 @@ var PostHog = /*#__PURE__*/function () {
   }, {
     key: "_dom_loaded",
     value: function _dom_loaded() {
-      var _this = this;
+      var _this2 = this;
 
       if (!this.has_opted_out_capturing()) {
         _eachArray(this.__request_queue, function (item) {
-          _this._send_request.apply(_this, _toConsumableArray(item));
+          _this2._send_request.apply(_this2, _toConsumableArray(item));
         });
       }
 
@@ -6568,7 +6657,7 @@ var PostHog = /*#__PURE__*/function () {
   }, {
     key: "_execute_array",
     value: function _execute_array(array) {
-      var _this2 = this;
+      var _this3 = this;
 
       var fn_name;
       var alias_calls = [];
@@ -6582,10 +6671,10 @@ var PostHog = /*#__PURE__*/function () {
           if (_isArray(fn_name)) {
             capturing_calls.push(item); // chained call e.g. posthog.get_group().set()
           } else if (typeof item === 'function') {
-            item.call(_this2);
+            item.call(_this3);
           } else if (_isArray(item) && fn_name === 'alias') {
             alias_calls.push(item);
-          } else if (_isArray(item) && fn_name.indexOf('capture') !== -1 && typeof _this2[fn_name] === 'function') {
+          } else if (_isArray(item) && fn_name.indexOf('capture') !== -1 && typeof _this3[fn_name] === 'function') {
             capturing_calls.push(item);
           } else {
             other_calls.push(item);
@@ -6694,9 +6783,8 @@ var PostHog = /*#__PURE__*/function () {
 
       if (_isBlockedUA(userAgent)) {
         return;
-      }
+      } // update persistence
 
-      var start_timestamp = this.persistence.remove_event_timer(event_name); // update persistence
 
       this.persistence.update_search_keyword(document$1.referrer);
 
@@ -6710,7 +6798,7 @@ var PostHog = /*#__PURE__*/function () {
 
       var data = {
         event: event_name,
-        properties: this._calculate_event_properties(event_name, properties || {}, start_timestamp)
+        properties: this._calculate_event_properties(event_name, properties || {})
       };
 
       if (event_name === '$identify' && options.$set) {
@@ -6754,8 +6842,10 @@ var PostHog = /*#__PURE__*/function () {
     }
   }, {
     key: "_calculate_event_properties",
-    value: function _calculate_event_properties(event_name, event_properties, start_timestamp) {
+    value: function _calculate_event_properties(event_name, event_properties) {
       // set defaults
+      var start_timestamp = this.persistence.remove_event_timer(event_name);
+
       var properties = _objectSpread2({}, event_properties);
 
       properties['token'] = this.get_config('token');
@@ -7169,12 +7259,17 @@ var PostHog = /*#__PURE__*/function () {
      * The default config is:
      *
      *     {
-     *       // Posthog host
+     *       // PostHog API host
      *       api_host: 'https://app.posthog.com',
      *
      *       // HTTP method for capturing requests
      *       api_method: 'POST'
      *
+     *       // PostHog web app host, currently only used by the Sentry integration.
+     *       // This will only be different from api_host when using a reverse-proxied API host – in that case
+     *       // the original web app host needs to be passed here so that links to the web app are still convenient.
+     *       ui_host: 'https://app.posthog.com',
+     *
      *       // Automatically capture clicks, form submissions and change events
      *       autocapture: true
      *