@ninetailed/experience.js 3.0.0-beta.11 → 3.0.0-beta.14

package/index.esm.js

@@ -2303,19 +2303,17 @@ const NINETAILED_TRACKER_EVENTS = {
   /**
    * `profile` - Fires when the profile is returned by the cdp API.
    */
-  profile: 'profile'
+  profile: 'profile',
+
+  /**
+   * `reset` - gets fired when the profile gets reset, so other plugins can react.
+   */
+  reset: 'reset-profile'
 };
 const PLUGIN_NAME = 'ninetailed';
 
 const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
 
-const emptyProfile = {
-  id: '',
-  random: 0,
-  audiences: [],
-  traits: {},
-  location: {}
-};
 const ninetailedPlugin = ({
   clientId,
   environment,
@@ -2342,7 +2340,12 @@ const ninetailedPlugin = ({
 
     try {
       const anonymousId = instance.storage.getItem(ANONYMOUS_ID);
-      const profile = yield apiClient.upsertProfile(events, anonymousId);
+      const profile = yield apiClient.upsertProfile({
+        profileId: anonymousId,
+        events
+      }, {
+        locale
+      });
       instance.storage.setItem(ANONYMOUS_ID, profile.id);
       instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
       logger.debug('Profile from api: ', profile);
@@ -2352,11 +2355,22 @@ const ninetailedPlugin = ({
       });
     } catch (error) {
       logger.debug('An error occurred during flushing the events: ', error);
-      const fallbackProfile = instance.storage.getItem(PROFILE_FALLBACK_CACHE) || emptyProfile;
-      instance.dispatch({
-        type: NINETAILED_TRACKER_EVENTS.profile,
-        profile: fallbackProfile
-      });
+      const fallbackProfile = instance.storage.getItem(PROFILE_FALLBACK_CACHE);
+
+      if (fallbackProfile) {
+        logger.debug('Found a fallback profile - will use this.');
+        instance.dispatch({
+          type: NINETAILED_TRACKER_EVENTS.profile,
+          profile: fallbackProfile
+        });
+      } else {
+        logger.debug('No fallback profile found - setting profile to null.');
+        instance.dispatch({
+          type: NINETAILED_TRACKER_EVENTS.profile,
+          profile: null,
+          error
+        });
+      }
     } // This is necessary to make sure that the cache is updated before the next flush is performed
 
 
@@ -2370,6 +2384,17 @@ const ninetailedPlugin = ({
     throttledFlush(instance);
   });
 
+  const abortNonClientEvents = ({
+    abort,
+    payload
+  }) => {
+    if (typeof window !== 'object') {
+      return abort();
+    }
+
+    return payload;
+  };
+
   return {
     name: 'ninetailed',
     config: {},
@@ -2396,6 +2421,9 @@ const ninetailedPlugin = ({
 
       logger.debug('Ninetailed Core plugin initialized.');
     },
+    pageStart: params => {
+      return abortNonClientEvents(params);
+    },
     page: ({
       payload,
       instance
@@ -2409,6 +2437,9 @@ const ninetailedPlugin = ({
         ctx
       }), instance);
     }),
+    trackStart: params => {
+      return abortNonClientEvents(params);
+    },
     track: ({
       payload,
       instance
@@ -2423,6 +2454,9 @@ const ninetailedPlugin = ({
         ctx
       }), instance);
     }),
+    identifyStart: params => {
+      return abortNonClientEvents(params);
+    },
     identify: ({
       payload,
       instance
@@ -2450,12 +2484,18 @@ const ninetailedPlugin = ({
     },
     methods: {
       reset: (...args) => __awaiter(void 0, void 0, void 0, function* () {
+        // TODO it seems reset gets called during Next.js SSR builds. Need to verify that.
+        logger.debug('Resetting profile.');
         const instance = args[args.length - 1];
-        yield instance.storage.removeItem(ANONYMOUS_ID);
         instance.dispatch({
-          type: NINETAILED_TRACKER_EVENTS.profile,
-          profile: emptyProfile
+          type: NINETAILED_TRACKER_EVENTS.reset
         });
+        yield instance.storage.removeItem(ANONYMOUS_ID);
+        yield instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
+        logger.debug('Removed old profile data from localstorage.'); // sending a new page event, when no anonymousId is set will create a new profile.
+
+        yield instance.page();
+        logger.info('Profile reset successful.');
         yield delay(10);
       }),
       debug: (...args) => __awaiter(void 0, void 0, void 0, function* () {
@@ -3009,11 +3049,19 @@ class Ninetailed {
       return this.instance.on(NINETAILED_TRACKER_EVENTS.profile, ({
         payload
       }) => {
-        cb(Object.assign(Object.assign({}, this._profileState), {
-          status: 'success',
-          profile: payload.profile,
-          error: null
-        }));
+        if (payload.error) {
+          cb(Object.assign(Object.assign({}, this._profileState), {
+            status: 'error',
+            profile: payload.profile,
+            error: payload.error
+          }));
+        } else {
+          cb(Object.assign(Object.assign({}, this._profileState), {
+            status: 'success',
+            profile: payload.profile,
+            error: null
+          }));
+        }
       });
     };
 

package/index.umd.js

@@ -2374,7 +2374,12 @@
 	  /**
 	   * `profile` - Fires when the profile is returned by the cdp API.
 	   */
-	  profile: 'profile'
+	  profile: 'profile',
+
+	  /**
+	   * `reset` - gets fired when the profile gets reset, so other plugins can react.
+	   */
+	  reset: 'reset-profile'
 	};
 	var PLUGIN_NAME = 'ninetailed';
 
@@ -2384,20 +2389,13 @@
 	  });
 	};
 
-	var emptyProfile = {
-	  id: '',
-	  random: 0,
-	  audiences: [],
-	  traits: {},
-	  location: {}
-	};
 	var ninetailedPlugin = function ninetailedPlugin(_a) {
 	  var clientId = _a.clientId,
 	      environment = _a.environment;
 	      _a.preview;
 	      var url = _a.url,
-	      profile = _a.profile;
-	      _a.locale;
+	      profile = _a.profile,
+	      locale = _a.locale;
 	  var apiClient = new experience_jsShared.NinetailedApiClient({
 	    clientId: clientId,
 	    environment: environment,
@@ -2429,7 +2427,12 @@
 	            anonymousId = instance.storage.getItem(ANONYMOUS_ID);
 	            return [4
 	            /*yield*/
-	            , apiClient.upsertProfile(events, anonymousId)];
+	            , apiClient.upsertProfile({
+	              profileId: anonymousId,
+	              events: events
+	            }, {
+	              locale: locale
+	            })];
 
 	          case 2:
 	            profile_1 = _a.sent();
@@ -2447,11 +2450,23 @@
 	          case 3:
 	            error_1 = _a.sent();
 	            experience_jsShared.logger.debug('An error occurred during flushing the events: ', error_1);
-	            fallbackProfile = instance.storage.getItem(PROFILE_FALLBACK_CACHE) || emptyProfile;
-	            instance.dispatch({
-	              type: NINETAILED_TRACKER_EVENTS.profile,
-	              profile: fallbackProfile
-	            });
+	            fallbackProfile = instance.storage.getItem(PROFILE_FALLBACK_CACHE);
+
+	            if (fallbackProfile) {
+	              experience_jsShared.logger.debug('Found a fallback profile - will use this.');
+	              instance.dispatch({
+	                type: NINETAILED_TRACKER_EVENTS.profile,
+	                profile: fallbackProfile
+	              });
+	            } else {
+	              experience_jsShared.logger.debug('No fallback profile found - setting profile to null.');
+	              instance.dispatch({
+	                type: NINETAILED_TRACKER_EVENTS.profile,
+	                profile: null,
+	                error: error_1
+	              });
+	            }
+
 	            return [3
 	            /*break*/
 	            , 4];
@@ -2488,6 +2503,17 @@
 	    });
 	  };
 
+	  var abortNonClientEvents = function abortNonClientEvents(_a) {
+	    var abort = _a.abort,
+	        payload = _a.payload;
+
+	    if (typeof window !== 'object') {
+	      return abort();
+	    }
+
+	    return payload;
+	  };
+
 	  return {
 	    name: 'ninetailed',
 	    config: {},
@@ -2514,6 +2540,9 @@
 
 	      experience_jsShared.logger.debug('Ninetailed Core plugin initialized.');
 	    },
+	    pageStart: function (params) {
+	      return abortNonClientEvents(params);
+	    },
 	    page: function (_a) {
 	      var payload = _a.payload,
 	          instance = _a.instance;
@@ -2543,6 +2572,9 @@
 	        });
 	      });
 	    },
+	    trackStart: function (params) {
+	      return abortNonClientEvents(params);
+	    },
 	    track: function (_a) {
 	      var payload = _a.payload,
 	          instance = _a.instance;
@@ -2573,6 +2605,9 @@
 	        });
 	      });
 	    },
+	    identifyStart: function (params) {
+	      return abortNonClientEvents(params);
+	    },
 	    identify: function (_a) {
 	      var payload = _a.payload,
 	          instance = _a.instance;
@@ -2627,7 +2662,12 @@
 	          return __generator(this, function (_a) {
 	            switch (_a.label) {
 	              case 0:
+	                // TODO it seems reset gets called during Next.js SSR builds. Need to verify that.
+	                experience_jsShared.logger.debug('Resetting profile.');
 	                instance = args[args.length - 1];
+	                instance.dispatch({
+	                  type: NINETAILED_TRACKER_EVENTS.reset
+	                });
 	                return [4
 	                /*yield*/
 	                , instance.storage.removeItem(ANONYMOUS_ID)];
@@ -2635,17 +2675,31 @@
 	              case 1:
 	                _a.sent();
 
-	                instance.dispatch({
-	                  type: NINETAILED_TRACKER_EVENTS.profile,
-	                  profile: emptyProfile
-	                });
 	                return [4
 	                /*yield*/
-	                , delay(10)];
+	                , instance.storage.removeItem(PROFILE_FALLBACK_CACHE)];
 
 	              case 2:
 	                _a.sent();
 
+	                experience_jsShared.logger.debug('Removed old profile data from localstorage.'); // sending a new page event, when no anonymousId is set will create a new profile.
+
+	                return [4
+	                /*yield*/
+	                , instance.page()];
+
+	              case 3:
+	                // sending a new page event, when no anonymousId is set will create a new profile.
+	                _a.sent();
+
+	                experience_jsShared.logger.info('Profile reset successful.');
+	                return [4
+	                /*yield*/
+	                , delay(10)];
+
+	              case 4:
+	                _a.sent();
+
 	                return [2
 	                /*return*/
 	                ];
@@ -2835,11 +2889,20 @@
 	      cb(_this.profileState);
 	      return _this.instance.on(NINETAILED_TRACKER_EVENTS.profile, function (_a) {
 	        var payload = _a.payload;
-	        cb(__assign(__assign({}, _this._profileState), {
-	          status: 'success',
-	          profile: payload.profile,
-	          error: null
-	        }));
+
+	        if (payload.error) {
+	          cb(__assign(__assign({}, _this._profileState), {
+	            status: 'error',
+	            profile: payload.profile,
+	            error: payload.error
+	          }));
+	        } else {
+	          cb(__assign(__assign({}, _this._profileState), {
+	            status: 'success',
+	            profile: payload.profile,
+	            error: null
+	          }));
+	        }
 	      });
 	    };
 

package/lib/analytics/get-analytics-plugin.d.ts

@@ -14,6 +14,10 @@ export declare const NINETAILED_TRACKER_EVENTS: {
      * `profile` - Fires when the profile is returned by the cdp API.
      */
     profile: string;
+    /**
+     * `reset` - gets fired when the profile gets reset, so other plugins can react.
+     */
+    reset: string;
 };
 export declare const PLUGIN_NAME = "ninetailed";
 export declare const ninetailedPlugin: ({ clientId, environment, preview, url, profile, locale, }: AnalyticsPluginNinetailedConfig) => AnalyticsPlugin;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "3.0.0-beta.11",
+  "version": "3.0.0-beta.14",
   "main": "./index.umd.js",
   "module": "./index.esm.js",
   "typings": "./index.d.ts",
   "dependencies": {
-    "@ninetailed/experience.js-shared": "3.0.0-beta.11",
+    "@ninetailed/experience.js-shared": "3.0.0-beta.14",
     "ts-toolbelt": "^9.6.0",
     "diary": "^0.3.1",
     "zod": "^3.18.0",