posthog-js 1.45.0 → 1.46.0

package/dist/module.d.ts

@@ -252,6 +252,7 @@ interface SessionRecordingOptions {
     slimDOMOptions?: SlimDOMOptions | 'all' | true;
     collectFonts?: boolean;
     inlineStylesheet?: boolean;
+    recorderVersion?: 'v1' | 'v2';
 }
 declare enum Compression {
     GZipJS = "gzip-js",
@@ -310,6 +311,7 @@ interface DecideResponse {
     sessionRecording?: {
         endpoint?: string;
         consoleLogRecordingEnabled?: boolean;
+        recorderVersion?: 'v1' | 'v2';
     };
     toolbarParams: ToolbarParams;
     editorParams?: ToolbarParams; /** @deprecated, renamed to toolbarParams, still present on older API responses */
@@ -417,7 +419,7 @@ declare class PostHogPersistence {
     expire_days: number | undefined;
     default_expiry: number | undefined;
     cross_subdomain: boolean | undefined;
-    user_state: 'anonymous' | 'identified' | undefined;
+    user_state: 'anonymous' | 'identified';
     constructor(config: PostHogConfig);
     properties(): Properties;
     load(): void;
@@ -453,7 +455,7 @@ declare class PostHogPersistence {
     set_secure(secure: boolean): void;
     set_event_timer(event_name: string, timestamp: number): void;
     remove_event_timer(event_name: string): number;
-    get_user_state(): 'anonymous' | 'identified' | undefined;
+    get_user_state(): 'anonymous' | 'identified';
     set_user_state(state: 'anonymous' | 'identified'): void;
 }
 
@@ -849,6 +851,7 @@ declare class SessionRecording {
     sessionId: string | null;
     receivedDecide: boolean;
     rrwebRecord: typeof record | undefined;
+    recorderVersion?: string;
     constructor(instance: PostHog);
     startRecordingIfEnabled(): void;
     started(): boolean;
@@ -1132,7 +1135,7 @@ declare class PostHog {
     /**
      * Identify a user with a unique ID instead of a PostHog
      * randomly generated distinct_id. If the method is never called,
-     * then unique visitors will be identified by a UUID generated
+     * then unique visitors will be identified by a UUID that is generated
      * the first time they visit the site.
      *
      * If user properties are passed, they are also sent to posthog.
@@ -1146,21 +1149,30 @@ declare class PostHog {
      * ### Notes:
      *
      * You can call this function to overwrite a previously set
-     * unique ID for the current user. PostHog cannot translate
-     * between IDs at this time, so when you change a user's ID
-     * they will appear to be a new user.
-     *
-     * When used alone, posthog.identify will change the user's
-     * distinct_id to the unique ID provided. When used in tandem
-     * with posthog.alias, it will allow you to identify based on
-     * unique ID and map that back to the original, anonymous
-     * distinct_id given to the user upon her first arrival to your
-     * site (thus connecting anonymous pre-signup activity to
-     * post-signup activity). Though the two work together, do not
-     * call identify() at the same time as alias(). Calling the two
-     * at the same time can cause a race condition, so it is best
-     * practice to call identify on the original, anonymous ID
-     * right after you've aliased it.
+     * unique ID for the current user.
+     *
+     * If the user has been identified ($user_state in persistence is set to 'identified'),
+     * then capture of $identify is skipped to avoid merging users. For example,
+     * if your system allows an admin user to impersonate another user.
+     *
+     * Then a single browser instance can have:
+     *
+     *  `identify('a') -> capture(1) -> identify('b') -> capture(2)`
+     *
+     * and capture 1 and capture 2 will have the correct distinct_id.
+     * but users a and b will NOT be merged in posthog.
+     *
+     * However, if reset is called then:
+     *
+     *  `identify('a') -> capture(1) -> reset() -> capture(2) -> identify('b') -> capture(3)`
+     *
+     * users a and b are not merged.
+     * Capture 1 is associated with user a.
+     * A new distinct id is generated for capture 2.
+     * which is merged with user b.
+     * So, capture 2 and 3 are associated with user b.
+     *
+     * If you want to merge two identified users, you can call posthog.alias
      *
      * @param {String} [new_distinct_id] A string that uniquely identifies a user. If not provided, the distinct_id currently in the persistent store (cookie or localStorage) will be used.
      * @param {Object} [userPropertiesToSet] Optional: An associative array of properties to store about the user

package/dist/module.js

@@ -921,7 +921,7 @@ var LZString = {
   }
 };
 
-var version = "1.45.0";
+var version = "1.46.0";
 
 // e.g.     Config.DEBUG = Config.DEBUG || instance.get_config('debug')
 
@@ -3585,7 +3585,7 @@ var PostHogPersistence = /*#__PURE__*/function () {
       this.storage = cookieStore;
     }
 
-    this.user_state = undefined;
+    this.user_state = 'anonymous';
     this.load();
     this.update_config(config);
     this.save();
@@ -3834,7 +3834,7 @@ var PostHogPersistence = /*#__PURE__*/function () {
   }, {
     key: "get_user_state",
     value: function get_user_state() {
-      return this.props[USER_STATE];
+      return this.props[USER_STATE] || 'anonymous';
     }
   }, {
     key: "set_user_state",
@@ -3994,7 +3994,7 @@ var SessionRecording = /*#__PURE__*/function () {
   }, {
     key: "afterDecideResponse",
     value: function afterDecideResponse(response) {
-      var _response$sessionReco2;
+      var _response$sessionReco2, _response$sessionReco4;
 
       this.receivedDecide = true;
 
@@ -4010,6 +4010,10 @@ var SessionRecording = /*#__PURE__*/function () {
         this.endpoint = (_response$sessionReco3 = response.sessionRecording) === null || _response$sessionReco3 === void 0 ? void 0 : _response$sessionReco3.endpoint;
       }
 
+      if ((_response$sessionReco4 = response.sessionRecording) !== null && _response$sessionReco4 !== void 0 && _response$sessionReco4.recorderVersion) {
+        this.recorderVersion = response.sessionRecording.recorderVersion;
+      }
+
       this.startRecordingIfEnabled();
     }
   }, {
@@ -4043,11 +4047,15 @@ var SessionRecording = /*#__PURE__*/function () {
       }
 
       if (!this.captureStarted && !this.instance.get_config('disable_session_recording')) {
+        var userSessionRecordingOptions = this.instance.get_config('session_recording'); // Always use the client side setting if given, otherwise use the server side setting
+
+        this.recorderVersion = (userSessionRecordingOptions === null || userSessionRecordingOptions === void 0 ? void 0 : userSessionRecordingOptions.recorderVersion) || this.recorderVersion;
+        var recorderJS = this.recorderVersion === 'v2' ? 'recorder-v2.js' : 'recorder.js';
         this.captureStarted = true; // If recorder.js is already loaded (if array.full.js snippet is used or posthog-js/dist/recorder is imported), don't load script.
         // Otherwise, remotely import recorder.js from cdn since it hasn't been loaded
 
         if (!this.instance.__loaded_recorder) {
-          loadScript(this.instance.get_config('api_host') + '/static/recorder.js?v=' + Config.LIB_VERSION, this._onScriptLoaded.bind(this));
+          loadScript(this.instance.get_config('api_host') + "/static/".concat(recorderJS, "?v=").concat(Config.LIB_VERSION), this._onScriptLoaded.bind(this));
         }
 
         this._onScriptLoaded();
@@ -7390,7 +7398,7 @@ var PostHog = /*#__PURE__*/function () {
     /**
      * Identify a user with a unique ID instead of a PostHog
      * randomly generated distinct_id. If the method is never called,
-     * then unique visitors will be identified by a UUID generated
+     * then unique visitors will be identified by a UUID that is generated
      * the first time they visit the site.
      *
      * If user properties are passed, they are also sent to posthog.
@@ -7404,21 +7412,30 @@ var PostHog = /*#__PURE__*/function () {
      * ### Notes:
      *
      * You can call this function to overwrite a previously set
-     * unique ID for the current user. PostHog cannot translate
-     * between IDs at this time, so when you change a user's ID
-     * they will appear to be a new user.
-     *
-     * When used alone, posthog.identify will change the user's
-     * distinct_id to the unique ID provided. When used in tandem
-     * with posthog.alias, it will allow you to identify based on
-     * unique ID and map that back to the original, anonymous
-     * distinct_id given to the user upon her first arrival to your
-     * site (thus connecting anonymous pre-signup activity to
-     * post-signup activity). Though the two work together, do not
-     * call identify() at the same time as alias(). Calling the two
-     * at the same time can cause a race condition, so it is best
-     * practice to call identify on the original, anonymous ID
-     * right after you've aliased it.
+     * unique ID for the current user.
+     *
+     * If the user has been identified ($user_state in persistence is set to 'identified'),
+     * then capture of $identify is skipped to avoid merging users. For example,
+     * if your system allows an admin user to impersonate another user.
+     *
+     * Then a single browser instance can have:
+     *
+     *  `identify('a') -> capture(1) -> identify('b') -> capture(2)`
+     *
+     * and capture 1 and capture 2 will have the correct distinct_id.
+     * but users a and b will NOT be merged in posthog.
+     *
+     * However, if reset is called then:
+     *
+     *  `identify('a') -> capture(1) -> reset() -> capture(2) -> identify('b') -> capture(3)`
+     *
+     * users a and b are not merged.
+     * Capture 1 is associated with user a.
+     * A new distinct id is generated for capture 2.
+     * which is merged with user b.
+     * So, capture 2 and 3 are associated with user b.
+     *
+     * If you want to merge two identified users, you can call posthog.alias
      *
      * @param {String} [new_distinct_id] A string that uniquely identifies a user. If not provided, the distinct_id currently in the persistent store (cookie or localStorage) will be used.
      * @param {Object} [userPropertiesToSet] Optional: An associative array of properties to store about the user
@@ -7449,8 +7466,7 @@ var PostHog = /*#__PURE__*/function () {
           $had_persisted_distinct_id: true,
           $device_id: device_id
         }, '');
-      } // identify only changes the distinct id if it doesn't match either the existing or the alias;
-      // if it's new, blow away the alias as well.
+      } // if the previous distinct id had an alias stored, then we clear it
 
 
       if (new_distinct_id !== previous_distinct_id && new_distinct_id !== this.get_property(ALIAS_ID_KEY)) {
@@ -7460,11 +7476,10 @@ var PostHog = /*#__PURE__*/function () {
         });
       }
 
-      var deviceIdMarksForIdentify = !this.get_property('$device_id');
       var isKnownAnonymous = this.persistence.get_user_state() === 'anonymous'; // send an $identify event any time the distinct_id is changing and the old ID is an anoymous ID
       // - logic on the server will determine whether or not to do anything with it.
 
-      if (new_distinct_id !== previous_distinct_id && (isKnownAnonymous || deviceIdMarksForIdentify)) {
+      if (new_distinct_id !== previous_distinct_id && isKnownAnonymous) {
         this.persistence.set_user_state('identified');
         this.capture('$identify', {
           distinct_id: new_distinct_id,