@ninetailed/experience.js 3.0.0-beta.33 → 3.0.0-beta.37

package/index.cjs

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var unionBy = require('lodash/unionBy');
 var experience_jsShared = require('@ninetailed/experience.js-shared');
 var Analytics = require('analytics');
+var experience_jsPluginAnalytics = require('@ninetailed/experience.js-plugin-analytics');
 var flatten = require('lodash/flatten');
 var find = require('lodash/find');
 var includes = require('lodash/includes');
@@ -2586,80 +2587,74 @@ const LEGACY_ANONYMOUS_ID = '__anon_id';
 const ANONYMOUS_ID = '__nt_anonymous_id__';
 const DEBUG_FLAG = '__nt_debug__';
 const PROFILE_FALLBACK_CACHE = '__nt_profile__';
+const PROFILE_CHANGE = 'profile-change';
+const PROFILE_RESET = 'profile-reset';
 
-const NINETAILED_TRACKER_EVENTS = {
-  /**
-   * `profile` - Fires when the profile is returned by the cdp API.
-   */
-  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 ninetailedPlugin = ({
-  clientId,
-  environment,
-  preview: _preview = false,
-  url,
+  apiClient,
   profile,
   locale
 }) => {
-  const apiClient = new experience_jsShared.NinetailedApiClient({
-    clientId,
-    environment,
-    url
-  });
+  let _instance;
   let queue = [];
-  const flush = instance => __awaiter(void 0, void 0, void 0, function* () {
+  const flush = () => __awaiter(void 0, void 0, void 0, function* () {
     const events = Object.assign([], queue);
     experience_jsShared.logger.info('Start flushing events.');
     queue = [];
     if (!events.length) {
-      return;
+      return {
+        success: true
+      };
     }
     try {
-      const anonymousId = instance.storage.getItem(ANONYMOUS_ID);
+      const anonymousId = _instance.storage.getItem(ANONYMOUS_ID);
       const profile = yield apiClient.upsertProfile({
         profileId: anonymousId,
         events
       }, {
         locale
       });
-      instance.storage.setItem(ANONYMOUS_ID, profile.id);
-      instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
+      _instance.storage.setItem(ANONYMOUS_ID, profile.id);
+      _instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
       experience_jsShared.logger.debug('Profile from api: ', profile);
-      instance.dispatch({
-        type: NINETAILED_TRACKER_EVENTS.profile,
+      _instance.dispatch({
+        type: PROFILE_CHANGE,
         profile
       });
+      yield delay(20);
+      return {
+        success: true
+      };
     } catch (error) {
       experience_jsShared.logger.debug('An error occurred during flushing the events: ', error);
-      const fallbackProfile = instance.storage.getItem(PROFILE_FALLBACK_CACHE);
+      const 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,
+        _instance.dispatch({
+          type: PROFILE_CHANGE,
           profile: fallbackProfile
         });
+        return {
+          success: false
+        };
       } else {
         experience_jsShared.logger.debug('No fallback profile found - setting profile to null.');
-        instance.dispatch({
-          type: NINETAILED_TRACKER_EVENTS.profile,
+        _instance.dispatch({
+          type: PROFILE_CHANGE,
+          // TODO is it a good idea to set the profile to null?
           profile: null,
           error
         });
+        return {
+          success: false
+        };
       }
     }
-    // This is necessary to make sure that the cache is updated before the next flush is performed
-    yield delay(20);
   });
-  const throttledFlush = asyncThrottle(flush);
-  const enqueueEvent = (event, instance) => __awaiter(void 0, void 0, void 0, function* () {
+  const enqueueEvent = event => __awaiter(void 0, void 0, void 0, function* () {
     queue = unionBy__default["default"]([event], queue, 'messageId');
-    throttledFlush(instance);
   });
   const abortNonClientEvents = ({
     abort,
@@ -2676,6 +2671,7 @@ const ninetailedPlugin = ({
     initialize: ({
       instance
     }) => {
+      _instance = instance;
       if (instance.storage.getItem(DEBUG_FLAG)) {
         experience_jsShared.logger.addSink(new experience_jsShared.ConsoleLogSink());
         experience_jsShared.logger.info('Ninetailed Debug Mode is enabled.');
@@ -2692,12 +2688,12 @@ const ninetailedPlugin = ({
       }
       experience_jsShared.logger.debug('Ninetailed Core plugin initialized.');
     },
+    flush: asyncThrottle(flush),
     pageStart: params => {
       return abortNonClientEvents(params);
     },
     page: ({
-      payload,
-      instance
+      payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       experience_jsShared.logger.info('Sending Page event.');
       const ctx = buildClientNinetailedRequestContext();
@@ -2706,14 +2702,13 @@ const ninetailedPlugin = ({
         timestamp: payload.meta.ts,
         properties: payload.properties,
         ctx
-      }), instance);
+      }));
     }),
     trackStart: params => {
       return abortNonClientEvents(params);
     },
     track: ({
-      payload,
-      instance
+      payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       experience_jsShared.logger.info('Sending Track event.');
       const ctx = buildClientNinetailedRequestContext();
@@ -2723,14 +2718,13 @@ const ninetailedPlugin = ({
         event: payload.event,
         properties: payload.properties,
         ctx
-      }), instance);
+      }));
     }),
     identifyStart: params => {
       return abortNonClientEvents(params);
     },
     identify: ({
-      payload,
-      instance
+      payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       experience_jsShared.logger.info('Sending Identify event.');
       const ctx = buildClientNinetailedRequestContext();
@@ -2745,7 +2739,7 @@ const ninetailedPlugin = ({
         traits: payload.traits,
         userId: payload.userId,
         ctx
-      }), instance);
+      }));
     }),
     setItemStart: ({
       abort,
@@ -2762,10 +2756,10 @@ const ninetailedPlugin = ({
         experience_jsShared.logger.debug('Resetting profile.');
         const instance = args[args.length - 1];
         instance.dispatch({
-          type: NINETAILED_TRACKER_EVENTS.reset
+          type: PROFILE_RESET
         });
-        yield instance.storage.removeItem(ANONYMOUS_ID);
-        yield instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
+        instance.storage.removeItem(ANONYMOUS_ID);
+        instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
         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.
         yield instance.page();
@@ -2777,11 +2771,11 @@ const ninetailedPlugin = ({
         const instance = args[args.length - 1];
         const consoleLogSink = new experience_jsShared.ConsoleLogSink();
         if (enabled) {
-          yield instance.storage.setItem(DEBUG_FLAG, true);
+          instance.storage.setItem(DEBUG_FLAG, true);
           experience_jsShared.logger.addSink(consoleLogSink);
           experience_jsShared.logger.info('Debug mode enabled.');
         } else {
-          yield instance.storage.removeItem(DEBUG_FLAG);
+          instance.storage.removeItem(DEBUG_FLAG);
           experience_jsShared.logger.info('Debug mode disabled.');
           experience_jsShared.logger.removeSink(consoleLogSink.name);
         }
@@ -3188,11 +3182,7 @@ for (var COLLECTION_NAME in DOMIterables) {
 handlePrototype(DOMTokenListPrototype, 'DOMTokenList');
 
 class Ninetailed {
-  constructor({
-    clientId,
-    environment,
-    preview
-  }, {
+  constructor(ninetailedApiClientInstanceOrOptions, {
     plugins,
     url,
     profile,
@@ -3209,7 +3199,8 @@ class Ninetailed {
           throw new Error(`[Validation Error] "page" was called with invalid params. Page data is not valid: ${result.error.format()}`);
         }
         yield this.waitUntilInitialized();
-        return this.instance.page(data, this.buildOptions(options));
+        yield this.instance.page(data, this.buildOptions(options));
+        return this.eventQueue.flush();
       } catch (error) {
         experience_jsShared.logger.error(error);
         if (error instanceof RangeError) {
@@ -3225,7 +3216,8 @@ class Ninetailed {
           throw new Error(`[Validation Error] "track" was called with invalid params. Properties are no valid json object: ${result.error.format()}`);
         }
         yield this.waitUntilInitialized();
-        return this.instance.track(event.toString(), result.data, this.buildOptions(options));
+        yield this.instance.track(event.toString(), result.data, this.buildOptions(options));
+        return this.eventQueue.flush();
       } catch (error) {
         experience_jsShared.logger.error(error);
         if (error instanceof RangeError) {
@@ -3234,21 +3226,15 @@ class Ninetailed {
         throw error;
       }
     });
-    this.trackHasSeenComponent = payload => __awaiter(this, void 0, void 0, function* () {
-      return this.instance.track('hasSeenComponent', payload, {
-        plugins: {
-          all: true,
-          ninetailed: false
-        }
-      });
+    this.trackHasSeenComponent = properties => __awaiter(this, void 0, void 0, function* () {
+      return this.instance.dispatch(Object.assign(Object.assign({}, properties), {
+        type: experience_jsPluginAnalytics.HAS_SEEN_COMPONENT
+      }));
     });
-    this.trackExperience = properties => {
-      return this.instance.track('nt_experience', properties, {
-        plugins: {
-          all: true,
-          ninetailed: false
-        }
-      });
+    this.trackHasSeenExperience = properties => {
+      return this.instance.dispatch(Object.assign(Object.assign({}, properties), {
+        type: experience_jsPluginAnalytics.HAS_SEEN_EXPERIENCE
+      }));
     };
     this.identify = (uid, traits, options) => __awaiter(this, void 0, void 0, function* () {
       try {
@@ -3257,7 +3243,8 @@ class Ninetailed {
           throw new Error(`[Validation Error] "identify" was called with invalid params. Traits are no valid json: ${result.error.format()}`);
         }
         yield this.waitUntilInitialized();
-        return this.instance.identify(uid.toString(), result.data, this.buildOptions(options));
+        yield this.instance.identify(uid.toString(), result.data, this.buildOptions(options));
+        return this.eventQueue.flush();
       } catch (error) {
         experience_jsShared.logger.error(error);
         if (error instanceof RangeError) {
@@ -3282,7 +3269,7 @@ class Ninetailed {
     };
     this.onProfileChange = cb => {
       cb(this.profileState);
-      return this.instance.on(NINETAILED_TRACKER_EVENTS.profile, ({
+      return this.instance.on(PROFILE_CHANGE, ({
         payload
       }) => {
         if (payload.error) {
@@ -3317,6 +3304,21 @@ class Ninetailed {
         this.onIsInitialized(resolve);
       });
     };
+    if (ninetailedApiClientInstanceOrOptions instanceof experience_jsShared.NinetailedApiClient) {
+      this.apiClient = ninetailedApiClientInstanceOrOptions;
+    } else {
+      const {
+        clientId,
+        environment,
+        preview
+      } = ninetailedApiClientInstanceOrOptions;
+      this.apiClient = new experience_jsShared.NinetailedApiClient({
+        clientId,
+        environment,
+        url,
+        preview
+      });
+    }
     this.plugins = flatten__default["default"](plugins || []);
     if (profile) {
       this._profileState = {
@@ -3340,17 +3342,15 @@ class Ninetailed {
       experience_jsShared.logger.addSink(new experience_jsShared.OnErrorLogSink(onError));
     }
     this.logger = experience_jsShared.logger;
+    this.eventQueue = ninetailedPlugin({
+      apiClient: this.apiClient,
+      profile,
+      locale,
+      requestTimeout
+    });
     this.instance = Analytics__default["default"]({
       app: 'ninetailed',
-      plugins: [...this.plugins, ninetailedPlugin({
-        clientId,
-        environment,
-        url,
-        profile,
-        locale,
-        requestTimeout,
-        preview
-      })]
+      plugins: [...this.plugins, this.eventQueue]
     });
     const detachOnReadyListener = this.instance.on('ready', () => {
       this.isInitialized = true;
@@ -4322,10 +4322,11 @@ exports.ANONYMOUS_ID = ANONYMOUS_ID;
 exports.DEBUG_FLAG = DEBUG_FLAG;
 exports.EXPERIENCE_TRAIT_PREFIX = EXPERIENCE_TRAIT_PREFIX;
 exports.LEGACY_ANONYMOUS_ID = LEGACY_ANONYMOUS_ID;
-exports.NINETAILED_TRACKER_EVENTS = NINETAILED_TRACKER_EVENTS;
 exports.Ninetailed = Ninetailed;
 exports.PLUGIN_NAME = PLUGIN_NAME;
+exports.PROFILE_CHANGE = PROFILE_CHANGE;
 exports.PROFILE_FALLBACK_CACHE = PROFILE_FALLBACK_CACHE;
+exports.PROFILE_RESET = PROFILE_RESET;
 exports.decodeExperienceVariantsMap = decodeExperienceVariantsMap;
 exports.isExperienceMatch = isExperienceMatch;
 exports.ninetailedPlugin = ninetailedPlugin;

package/index.js

@@ -1,6 +1,7 @@
 import unionBy from 'lodash/unionBy';
-import { NinetailedApiClient, logger, ConsoleLogSink, buildPageEvent, buildTrackEvent, buildIdentifyEvent, OnLogLogSink, OnErrorLogSink, PageviewProperties, Properties, Traits } from '@ninetailed/experience.js-shared';
+import { logger, ConsoleLogSink, buildPageEvent, buildTrackEvent, buildIdentifyEvent, NinetailedApiClient, OnLogLogSink, OnErrorLogSink, PageviewProperties, Properties, Traits } from '@ninetailed/experience.js-shared';
 import Analytics from 'analytics';
+import { HAS_SEEN_EXPERIENCE, HAS_SEEN_COMPONENT } from '@ninetailed/experience.js-plugin-analytics';
 import flatten from 'lodash/flatten';
 import find from 'lodash/find';
 import includes from 'lodash/includes';
@@ -2573,80 +2574,74 @@ const LEGACY_ANONYMOUS_ID = '__anon_id';
 const ANONYMOUS_ID = '__nt_anonymous_id__';
 const DEBUG_FLAG = '__nt_debug__';
 const PROFILE_FALLBACK_CACHE = '__nt_profile__';
+const PROFILE_CHANGE = 'profile-change';
+const PROFILE_RESET = 'profile-reset';
 
-const NINETAILED_TRACKER_EVENTS = {
-  /**
-   * `profile` - Fires when the profile is returned by the cdp API.
-   */
-  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 ninetailedPlugin = ({
-  clientId,
-  environment,
-  preview: _preview = false,
-  url,
+  apiClient,
   profile,
   locale
 }) => {
-  const apiClient = new NinetailedApiClient({
-    clientId,
-    environment,
-    url
-  });
+  let _instance;
   let queue = [];
-  const flush = instance => __awaiter(void 0, void 0, void 0, function* () {
+  const flush = () => __awaiter(void 0, void 0, void 0, function* () {
     const events = Object.assign([], queue);
     logger.info('Start flushing events.');
     queue = [];
     if (!events.length) {
-      return;
+      return {
+        success: true
+      };
     }
     try {
-      const anonymousId = instance.storage.getItem(ANONYMOUS_ID);
+      const anonymousId = _instance.storage.getItem(ANONYMOUS_ID);
       const profile = yield apiClient.upsertProfile({
         profileId: anonymousId,
         events
       }, {
         locale
       });
-      instance.storage.setItem(ANONYMOUS_ID, profile.id);
-      instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
+      _instance.storage.setItem(ANONYMOUS_ID, profile.id);
+      _instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
       logger.debug('Profile from api: ', profile);
-      instance.dispatch({
-        type: NINETAILED_TRACKER_EVENTS.profile,
+      _instance.dispatch({
+        type: PROFILE_CHANGE,
         profile
       });
+      yield delay(20);
+      return {
+        success: true
+      };
     } catch (error) {
       logger.debug('An error occurred during flushing the events: ', error);
-      const fallbackProfile = instance.storage.getItem(PROFILE_FALLBACK_CACHE);
+      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,
+        _instance.dispatch({
+          type: PROFILE_CHANGE,
           profile: fallbackProfile
         });
+        return {
+          success: false
+        };
       } else {
         logger.debug('No fallback profile found - setting profile to null.');
-        instance.dispatch({
-          type: NINETAILED_TRACKER_EVENTS.profile,
+        _instance.dispatch({
+          type: PROFILE_CHANGE,
+          // TODO is it a good idea to set the profile to null?
           profile: null,
           error
         });
+        return {
+          success: false
+        };
       }
     }
-    // This is necessary to make sure that the cache is updated before the next flush is performed
-    yield delay(20);
   });
-  const throttledFlush = asyncThrottle(flush);
-  const enqueueEvent = (event, instance) => __awaiter(void 0, void 0, void 0, function* () {
+  const enqueueEvent = event => __awaiter(void 0, void 0, void 0, function* () {
     queue = unionBy([event], queue, 'messageId');
-    throttledFlush(instance);
   });
   const abortNonClientEvents = ({
     abort,
@@ -2663,6 +2658,7 @@ const ninetailedPlugin = ({
     initialize: ({
       instance
     }) => {
+      _instance = instance;
       if (instance.storage.getItem(DEBUG_FLAG)) {
         logger.addSink(new ConsoleLogSink());
         logger.info('Ninetailed Debug Mode is enabled.');
@@ -2679,12 +2675,12 @@ const ninetailedPlugin = ({
       }
       logger.debug('Ninetailed Core plugin initialized.');
     },
+    flush: asyncThrottle(flush),
     pageStart: params => {
       return abortNonClientEvents(params);
     },
     page: ({
-      payload,
-      instance
+      payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       logger.info('Sending Page event.');
       const ctx = buildClientNinetailedRequestContext();
@@ -2693,14 +2689,13 @@ const ninetailedPlugin = ({
         timestamp: payload.meta.ts,
         properties: payload.properties,
         ctx
-      }), instance);
+      }));
     }),
     trackStart: params => {
       return abortNonClientEvents(params);
     },
     track: ({
-      payload,
-      instance
+      payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       logger.info('Sending Track event.');
       const ctx = buildClientNinetailedRequestContext();
@@ -2710,14 +2705,13 @@ const ninetailedPlugin = ({
         event: payload.event,
         properties: payload.properties,
         ctx
-      }), instance);
+      }));
     }),
     identifyStart: params => {
       return abortNonClientEvents(params);
     },
     identify: ({
-      payload,
-      instance
+      payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       logger.info('Sending Identify event.');
       const ctx = buildClientNinetailedRequestContext();
@@ -2732,7 +2726,7 @@ const ninetailedPlugin = ({
         traits: payload.traits,
         userId: payload.userId,
         ctx
-      }), instance);
+      }));
     }),
     setItemStart: ({
       abort,
@@ -2749,10 +2743,10 @@ const ninetailedPlugin = ({
         logger.debug('Resetting profile.');
         const instance = args[args.length - 1];
         instance.dispatch({
-          type: NINETAILED_TRACKER_EVENTS.reset
+          type: PROFILE_RESET
         });
-        yield instance.storage.removeItem(ANONYMOUS_ID);
-        yield instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
+        instance.storage.removeItem(ANONYMOUS_ID);
+        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();
@@ -2764,11 +2758,11 @@ const ninetailedPlugin = ({
         const instance = args[args.length - 1];
         const consoleLogSink = new ConsoleLogSink();
         if (enabled) {
-          yield instance.storage.setItem(DEBUG_FLAG, true);
+          instance.storage.setItem(DEBUG_FLAG, true);
           logger.addSink(consoleLogSink);
           logger.info('Debug mode enabled.');
         } else {
-          yield instance.storage.removeItem(DEBUG_FLAG);
+          instance.storage.removeItem(DEBUG_FLAG);
           logger.info('Debug mode disabled.');
           logger.removeSink(consoleLogSink.name);
         }
@@ -3175,11 +3169,7 @@ for (var COLLECTION_NAME in DOMIterables) {
 handlePrototype(DOMTokenListPrototype, 'DOMTokenList');
 
 class Ninetailed {
-  constructor({
-    clientId,
-    environment,
-    preview
-  }, {
+  constructor(ninetailedApiClientInstanceOrOptions, {
     plugins,
     url,
     profile,
@@ -3196,7 +3186,8 @@ class Ninetailed {
           throw new Error(`[Validation Error] "page" was called with invalid params. Page data is not valid: ${result.error.format()}`);
         }
         yield this.waitUntilInitialized();
-        return this.instance.page(data, this.buildOptions(options));
+        yield this.instance.page(data, this.buildOptions(options));
+        return this.eventQueue.flush();
       } catch (error) {
         logger.error(error);
         if (error instanceof RangeError) {
@@ -3212,7 +3203,8 @@ class Ninetailed {
           throw new Error(`[Validation Error] "track" was called with invalid params. Properties are no valid json object: ${result.error.format()}`);
         }
         yield this.waitUntilInitialized();
-        return this.instance.track(event.toString(), result.data, this.buildOptions(options));
+        yield this.instance.track(event.toString(), result.data, this.buildOptions(options));
+        return this.eventQueue.flush();
       } catch (error) {
         logger.error(error);
         if (error instanceof RangeError) {
@@ -3221,21 +3213,15 @@ class Ninetailed {
         throw error;
       }
     });
-    this.trackHasSeenComponent = payload => __awaiter(this, void 0, void 0, function* () {
-      return this.instance.track('hasSeenComponent', payload, {
-        plugins: {
-          all: true,
-          ninetailed: false
-        }
-      });
+    this.trackHasSeenComponent = properties => __awaiter(this, void 0, void 0, function* () {
+      return this.instance.dispatch(Object.assign(Object.assign({}, properties), {
+        type: HAS_SEEN_COMPONENT
+      }));
     });
-    this.trackExperience = properties => {
-      return this.instance.track('nt_experience', properties, {
-        plugins: {
-          all: true,
-          ninetailed: false
-        }
-      });
+    this.trackHasSeenExperience = properties => {
+      return this.instance.dispatch(Object.assign(Object.assign({}, properties), {
+        type: HAS_SEEN_EXPERIENCE
+      }));
     };
     this.identify = (uid, traits, options) => __awaiter(this, void 0, void 0, function* () {
       try {
@@ -3244,7 +3230,8 @@ class Ninetailed {
           throw new Error(`[Validation Error] "identify" was called with invalid params. Traits are no valid json: ${result.error.format()}`);
         }
         yield this.waitUntilInitialized();
-        return this.instance.identify(uid.toString(), result.data, this.buildOptions(options));
+        yield this.instance.identify(uid.toString(), result.data, this.buildOptions(options));
+        return this.eventQueue.flush();
       } catch (error) {
         logger.error(error);
         if (error instanceof RangeError) {
@@ -3269,7 +3256,7 @@ class Ninetailed {
     };
     this.onProfileChange = cb => {
       cb(this.profileState);
-      return this.instance.on(NINETAILED_TRACKER_EVENTS.profile, ({
+      return this.instance.on(PROFILE_CHANGE, ({
         payload
       }) => {
         if (payload.error) {
@@ -3304,6 +3291,21 @@ class Ninetailed {
         this.onIsInitialized(resolve);
       });
     };
+    if (ninetailedApiClientInstanceOrOptions instanceof NinetailedApiClient) {
+      this.apiClient = ninetailedApiClientInstanceOrOptions;
+    } else {
+      const {
+        clientId,
+        environment,
+        preview
+      } = ninetailedApiClientInstanceOrOptions;
+      this.apiClient = new NinetailedApiClient({
+        clientId,
+        environment,
+        url,
+        preview
+      });
+    }
     this.plugins = flatten(plugins || []);
     if (profile) {
       this._profileState = {
@@ -3327,17 +3329,15 @@ class Ninetailed {
       logger.addSink(new OnErrorLogSink(onError));
     }
     this.logger = logger;
+    this.eventQueue = ninetailedPlugin({
+      apiClient: this.apiClient,
+      profile,
+      locale,
+      requestTimeout
+    });
     this.instance = Analytics({
       app: 'ninetailed',
-      plugins: [...this.plugins, ninetailedPlugin({
-        clientId,
-        environment,
-        url,
-        profile,
-        locale,
-        requestTimeout,
-        preview
-      })]
+      plugins: [...this.plugins, this.eventQueue]
     });
     const detachOnReadyListener = this.instance.on('ready', () => {
       this.isInitialized = true;
@@ -4305,4 +4305,4 @@ const decodeExperienceVariantsMap = encodedExperienceVariantsMap => {
   }), {});
 };
 
-export { ANONYMOUS_ID, DEBUG_FLAG, EXPERIENCE_TRAIT_PREFIX, LEGACY_ANONYMOUS_ID, NINETAILED_TRACKER_EVENTS, Ninetailed, PLUGIN_NAME, PROFILE_FALLBACK_CACHE, decodeExperienceVariantsMap, isExperienceMatch, ninetailedPlugin, selectActiveExperiments, selectDistribution, selectEligibleExperiences, selectExperience, selectBaselineWithVariants as selectExperienceBaselineWithVariants, selectVariant as selectExperienceVariant, selectVariants as selectExperienceVariants, selectHasVariants as selectHasExperienceVariants, selectVariant$1 as selectVariant };
+export { ANONYMOUS_ID, DEBUG_FLAG, EXPERIENCE_TRAIT_PREFIX, LEGACY_ANONYMOUS_ID, Ninetailed, PLUGIN_NAME, PROFILE_CHANGE, PROFILE_FALLBACK_CACHE, PROFILE_RESET, decodeExperienceVariantsMap, isExperienceMatch, ninetailedPlugin, selectActiveExperiments, selectDistribution, selectEligibleExperiences, selectExperience, selectBaselineWithVariants as selectExperienceBaselineWithVariants, selectVariant as selectExperienceVariant, selectVariants as selectExperienceVariants, selectHasVariants as selectHasExperienceVariants, selectVariant$1 as selectVariant };

package/lib/Ninetailed.d.ts

@@ -1,7 +1,8 @@
 import { AnalyticsPlugin, DetachListeners } from 'analytics';
-import { Locale, Traits, Profile, Variant, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties } from '@ninetailed/experience.js-shared';
+import { Locale, Traits, Profile, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions } from '@ninetailed/experience.js-shared';
+import { TrackComponentProperties, TrackExperienceProperties } from '@ninetailed/experience.js-plugin-analytics';
+import { FlushResult } from './analytics';
 import { ProfileState } from './types';
-import { ExperienceConfiguration } from './experience';
 declare global {
     interface Window {
         ninetailed?: {
@@ -29,24 +30,11 @@ declare type EventFunctionOptions = {
     };
 };
 declare type OnProfileChangeCallback = (profile: ProfileState) => void;
-export declare type Page = (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<void>;
-export declare type Track = (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<void>;
-export declare type TrackHasSeenComponent = (payload: {
-    variant: Variant<unknown>;
-    audience: {
-        id: string;
-    };
-    isPersonalized: boolean;
-}) => Promise<void>;
-export declare type TrackExperienceProperties = {
-    experience: ExperienceConfiguration;
-    variant: number;
-    component: {
-        id: string;
-    };
-};
-export declare type TrackExperience = (properties: TrackExperienceProperties) => Promise<void>;
-export declare type Identify = (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<void>;
+export declare type Page = (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<FlushResult>;
+export declare type Track = (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<FlushResult>;
+export declare type TrackHasSeenComponent = (properties: TrackComponentProperties) => Promise<void>;
+export declare type TrackHasSeenExperience = (properties: TrackExperienceProperties) => Promise<void>;
+export declare type Identify = (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<FlushResult>;
 export declare type Reset = () => void;
 export declare type Debug = (enable: boolean) => void;
 export declare type OnProfileChange = (cb: OnProfileChangeCallback) => DetachListeners;
@@ -54,7 +42,7 @@ export interface NinetailedInstance {
     page: Page;
     track: Track;
     trackHasSeenComponent: TrackHasSeenComponent;
-    trackExperience: TrackExperience;
+    trackHasSeenExperience: TrackHasSeenExperience;
     identify: Identify;
     reset: Reset;
     debug: Debug;
@@ -64,22 +52,21 @@ export interface NinetailedInstance {
     logger: Logger;
     onIsInitialized: OnIsInitialized;
 }
+declare type NinetailedApiClientInstanceOrOptions = NinetailedApiClient | NinetailedApiClientOptions;
 export declare class Ninetailed implements NinetailedInstance {
     private readonly instance;
     private _profileState;
     private isInitialized;
+    private readonly apiClient;
+    private readonly eventQueue;
     readonly plugins: AnalyticsPlugin[];
     readonly logger: Logger;
-    constructor({ clientId, environment, preview, }: {
-        clientId: string;
-        environment?: string;
-        preview?: boolean;
-    }, { plugins, url, profile, locale, requestTimeout, onLog, onError, }?: Options);
-    page: (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<any>;
-    track: (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<any>;
+    constructor(ninetailedApiClientInstanceOrOptions: NinetailedApiClientInstanceOrOptions, { plugins, url, profile, locale, requestTimeout, onLog, onError, }?: Options);
+    page: (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<FlushResult>;
+    track: (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<FlushResult>;
     trackHasSeenComponent: TrackHasSeenComponent;
-    trackExperience: TrackExperience;
-    identify: (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<any>;
+    trackHasSeenExperience: TrackHasSeenExperience;
+    identify: (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<FlushResult>;
     reset: () => void;
     debug: (enabled: boolean) => void;
     onProfileChange: (cb: OnProfileChangeCallback) => DetachListeners;

package/lib/analytics/constants.d.ts

@@ -2,3 +2,5 @@ export declare const LEGACY_ANONYMOUS_ID = "__anon_id";
 export declare const ANONYMOUS_ID = "__nt_anonymous_id__";
 export declare const DEBUG_FLAG = "__nt_debug__";
 export declare const PROFILE_FALLBACK_CACHE = "__nt_profile__";
+export declare const PROFILE_CHANGE = "profile-change";
+export declare const PROFILE_RESET = "profile-reset";

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

@@ -1,24 +1,17 @@
 import { AnalyticsPlugin } from 'analytics';
-import { Profile, Locale } from '@ninetailed/experience.js-shared';
+import { Profile, Locale, NinetailedApiClient } from '@ninetailed/experience.js-shared';
 declare type AnalyticsPluginNinetailedConfig = {
-    clientId: string;
-    environment?: string;
-    preview?: boolean;
-    url?: string;
+    apiClient: NinetailedApiClient;
     profile?: Profile;
     locale?: Locale;
     requestTimeout?: number;
 };
-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;
+export declare type FlushResult = {
+    success: boolean;
+};
+export interface NinetailedEventQueue extends AnalyticsPlugin {
+    flush: () => Promise<FlushResult>;
+}
+export declare const ninetailedPlugin: ({ apiClient, profile, locale, }: AnalyticsPluginNinetailedConfig) => NinetailedEventQueue;
 export {};

package/lib/experience/isExperienceMatch.d.ts

@@ -1,8 +1,8 @@
 import { Profile } from '@ninetailed/experience.js-shared';
 import { ExperienceConfiguration } from './types';
 declare type IsExperienceMatchArgs = {
-    experience: ExperienceConfiguration;
-    activeExperiments: ExperienceConfiguration[];
+    experience: ExperienceConfiguration<any>;
+    activeExperiments: ExperienceConfiguration<any>[];
     profile: Profile;
 };
 export declare const isExperienceMatch: ({ experience, activeExperiments, profile, }: IsExperienceMatchArgs) => boolean;

package/lib/experience/selectActiveExperiments.d.ts

@@ -1,3 +1,3 @@
 import { Profile } from '@ninetailed/experience.js-shared';
-import { ExperienceConfiguration } from './types';
-export declare const selectActiveExperiments: (experiments: ExperienceConfiguration[], profile: Profile) => ExperienceConfiguration[];
+import { ExperienceConfiguration, Reference } from './types';
+export declare const selectActiveExperiments: <Variant extends Reference>(experiments: ExperienceConfiguration<Variant>[], profile: Profile) => ExperienceConfiguration<Variant>[];

package/lib/experience/selectBaselineWithVariants.d.ts

@@ -1,2 +1,2 @@
-import { Baseline, BaselineWithVariants, ExperienceConfiguration } from './types';
-export declare const selectBaselineWithVariants: (experience: ExperienceConfiguration, baseline: Baseline) => BaselineWithVariants | null;
+import { Baseline, BaselineWithVariants, ExperienceConfiguration, Reference } from './types';
+export declare const selectBaselineWithVariants: <Variant extends Reference>(experience: ExperienceConfiguration<Variant>, baseline: Baseline) => BaselineWithVariants<Variant> | null;

package/lib/experience/selectDistribution.d.ts

@@ -1,8 +1,8 @@
 import { Profile } from '@ninetailed/experience.js-shared';
-import { Distribution, ExperienceConfiguration } from './types';
-declare type SelectDistributionArgs = {
-    experience: ExperienceConfiguration;
+import { Distribution, ExperienceConfiguration, Reference } from './types';
+declare type SelectDistributionArgs<Variant extends Reference> = {
+    experience: ExperienceConfiguration<Variant>;
     profile: Profile;
 };
-export declare const selectDistribution: ({ experience, profile, }: SelectDistributionArgs) => Distribution;
+export declare const selectDistribution: <Variant extends Reference>({ experience, profile, }: SelectDistributionArgs<Variant>) => Distribution;
 export {};

package/lib/experience/selectEligibleExperiences.d.ts

@@ -1,12 +1,12 @@
-import { ExperienceConfiguration } from './types';
-declare type SelectEligibleExperiencesArgs = {
-    experiences: ExperienceConfiguration[];
-    activeExperiments: ExperienceConfiguration[];
+import { ExperienceConfiguration, Reference } from './types';
+declare type SelectEligibleExperiencesArgs<Variant extends Reference> = {
+    experiences: ExperienceConfiguration<Variant>[];
+    activeExperiments: ExperienceConfiguration<Variant>[];
 };
 /**
  * We can use any personalization as eligible experience
  * When going for an experiment we can only select a active experiment when 1 or more experiments are active
  * If the profile is not in any active experiments, we can select any expermiment
  */
-export declare const selectEligibleExperiences: ({ experiences, activeExperiments, }: SelectEligibleExperiencesArgs) => ExperienceConfiguration[];
+export declare const selectEligibleExperiences: <Variant extends Reference>({ experiences, activeExperiments, }: SelectEligibleExperiencesArgs<Variant>) => ExperienceConfiguration<Variant>[];
 export {};

package/lib/experience/selectExperience.d.ts

@@ -1,9 +1,9 @@
 import { Profile } from '@ninetailed/experience.js-shared';
-import { ExperienceConfiguration } from './types';
-declare type SelectExprienceArgs = {
-    experiences: ExperienceConfiguration[];
-    activeExperiments: ExperienceConfiguration[];
+import { ExperienceConfiguration, Reference } from './types';
+declare type SelectExprienceArgs<Variant extends Reference> = {
+    experiences: ExperienceConfiguration<Variant>[];
+    activeExperiments: ExperienceConfiguration<Variant>[];
     profile: Profile;
 };
-export declare const selectExperience: ({ experiences, activeExperiments, profile, }: SelectExprienceArgs) => ExperienceConfiguration | null;
+export declare const selectExperience: <Variant extends Reference>({ experiences, activeExperiments, profile, }: SelectExprienceArgs<Variant>) => ExperienceConfiguration<Variant> | null;
 export {};

package/lib/experience/selectHasVariants.d.ts

@@ -1,2 +1,2 @@
-import { Baseline, ExperienceConfiguration } from './types';
-export declare const selectHasVariants: (experience: ExperienceConfiguration, baseline: Baseline) => boolean;
+import { Baseline, ExperienceConfiguration, Reference } from './types';
+export declare const selectHasVariants: <Variant extends Reference>(experience: ExperienceConfiguration<Variant>, baseline: Baseline) => boolean;

package/lib/experience/selectVariant.d.ts

@@ -1,9 +1,9 @@
 import { Profile } from '@ninetailed/experience.js-shared';
-import { Baseline, ExperienceConfiguration, Variant } from './types';
-declare type SelectVariantArgs = {
+import { Baseline, ExperienceConfiguration, Reference, VariantRef } from './types';
+declare type SelectVariantArgs<Variant extends Reference> = {
     baseline: Baseline;
-    experience: ExperienceConfiguration;
+    experience: ExperienceConfiguration<Variant>;
     profile: Profile;
 };
-export declare const selectVariant: ({ baseline, experience, profile, }: SelectVariantArgs) => Variant | null;
+export declare const selectVariant: <Variant extends Reference>({ baseline, experience, profile, }: SelectVariantArgs<Variant>) => Variant | VariantRef | null;
 export {};

package/lib/experience/selectVariants.d.ts

@@ -1,2 +1,2 @@
-import { Baseline, Variant, ExperienceConfiguration } from './types';
-export declare const selectVariants: (experience: ExperienceConfiguration, baseline: Baseline) => Variant[];
+import { Baseline, ExperienceConfiguration, Reference, VariantRef } from './types';
+export declare const selectVariants: <Variant extends Reference>(experience: ExperienceConfiguration<Variant>, baseline: Baseline) => (Variant | VariantRef)[];

package/lib/experience/types/Baseline.d.ts

@@ -1,3 +1,2 @@
-export declare type Baseline<P = Record<string, unknown>> = P & {
-    id: string;
-};
+import { Reference } from './Reference';
+export declare type Baseline<P = unknown> = P & Reference;

package/lib/experience/types/BaselineWithVariants.d.ts

@@ -1,6 +1,7 @@
 import { Baseline } from './Baseline';
-import { Variant } from './Variant';
-export declare type BaselineWithVariants = {
+import { Reference } from './Reference';
+import { VariantRef } from './VariantRef';
+export declare type BaselineWithVariants<Variant extends Reference> = {
     baseline: Baseline;
-    variants: Variant<Record<string, unknown>>[];
+    variants: (Variant | VariantRef)[];
 };

package/lib/experience/types/ExperienceConfiguration.d.ts

@@ -1,7 +1,8 @@
 import { BaselineWithVariants } from './BaselineWithVariants';
 import { Distribution } from './Distribution';
+import { Reference } from './Reference';
 export declare type ExperienceType = 'nt_personalization' | 'nt_experiment';
-export declare type ExperienceConfiguration = {
+export declare type ExperienceConfiguration<Variant extends Reference> = {
     id: string;
     type: ExperienceType;
     audience?: {
@@ -9,5 +10,5 @@ export declare type ExperienceConfiguration = {
     };
     trafficAllocation: number;
     distribution: Distribution[];
-    components: BaselineWithVariants[];
+    components: BaselineWithVariants<Variant>[];
 };

package/lib/experience/types/Reference.d.ts

@@ -0,0 +1,3 @@
+export declare type Reference = {
+    id: string;
+};

package/lib/experience/types/VariantRef.d.ts

@@ -0,0 +1,4 @@
+export declare type VariantRef = {
+    id: string;
+    hidden: boolean;
+};

package/lib/experience/types/index.d.ts

@@ -1,5 +1,6 @@
+export type { Reference } from './Reference';
 export type { Baseline } from './Baseline';
-export type { Variant } from './Variant';
+export type { VariantRef } from './VariantRef';
 export type { BaselineWithVariants } from './BaselineWithVariants';
 export type { Distribution } from './Distribution';
 export type { ExperienceConfiguration, ExperienceType, } from './ExperienceConfiguration';

package/lib/experience/utils.d.ts

@@ -1,4 +1,4 @@
 import { Profile } from '@ninetailed/experience.js-shared';
 import { ExperienceConfiguration } from './types';
-export declare const getTrafficRandom: (profile: Profile, experience: ExperienceConfiguration) => number;
-export declare const getDistributionRandom: (profile: Profile, experience: ExperienceConfiguration) => number;
+export declare const getTrafficRandom: (profile: Profile, experience: ExperienceConfiguration<any>) => number;
+export declare const getDistributionRandom: (profile: Profile, experience: ExperienceConfiguration<any>) => number;

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "3.0.0-beta.33",
+  "version": "3.0.0-beta.37",
   "module": "./index.js",
   "main": "./index.cjs",
   "type": "module",
   "types": "./index.d.ts",
   "dependencies": {
-    "@ninetailed/experience.js-shared": "3.0.0-beta.33",
+    "@ninetailed/experience.js-shared": "3.0.0-beta.37",
     "analytics": "0.8.1",
     "lodash": "4.17.21",
-    "murmurhash-js": "1.0.0"
+    "murmurhash-js": "1.0.0",
+    "@ninetailed/experience.js-plugin-analytics": "3.0.0-beta.37"
   },
   "peerDependencies": {}
 }

package/lib/experience/types/Variant.d.ts

@@ -1,4 +0,0 @@
-export declare type Variant<P = unknown> = P & {
-    id: string;
-    hidden: boolean;
-};