@ninetailed/experience.js 7.8.0 → 7.9.0

package/index.cjs.js

@@ -214,7 +214,7 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
     });
   }
   pageStart(params) {
-    return this.abortNonClientEvents(params);
+    return NinetailedCorePlugin.abortNonClientEvents(params);
   }
   page({
     payload
@@ -231,7 +231,7 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
     });
   }
   trackStart(params) {
-    return this.abortNonClientEvents(params);
+    return NinetailedCorePlugin.abortNonClientEvents(params);
   }
   track({
     payload
@@ -249,7 +249,7 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
     });
   }
   identifyStart(params) {
-    return this.abortNonClientEvents(params);
+    return NinetailedCorePlugin.abortNonClientEvents(params);
   }
   identify({
     payload
@@ -301,7 +301,7 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
       this.queue = experience_jsShared.unionBy([event], this.queue, 'messageId');
     });
   }
-  abortNonClientEvents({
+  static abortNonClientEvents({
     abort,
     payload
   }) {
@@ -527,7 +527,7 @@ const makeExperienceSelectMiddleware = ({
     const middlewareFunctions = pluginsWithMiddleware.map(plugin => plugin.getExperienceSelectionMiddleware({
       experiences,
       baseline
-    }));
+    })).filter(result => typeof result !== 'undefined');
     return experience_jsShared.pipe(...middlewareFunctions);
   };
   const middleware = prepareMiddleware();
@@ -595,6 +595,10 @@ class EventBuilder {
   }
 }
 
+const requiresEventBuilder = plugin => {
+  return typeof plugin === 'object' && plugin !== null && 'setEventBuilder' in plugin && typeof plugin.setEventBuilder === 'function';
+};
+
 const buildOverrideMiddleware = experienceSelectionMiddleware => _a => {
   var {
       experience: originalExperience,
@@ -1067,6 +1071,7 @@ class Ninetailed {
       });
     }
     this.plugins = (plugins !== null && plugins !== void 0 ? plugins : []).flat();
+    this.eventBuilder = new EventBuilder(buildClientContext);
     this.plugins.forEach(plugin => {
       if (acceptsCredentials(plugin) && this.clientId && this.environment) {
         plugin.setCredentials({
@@ -1077,6 +1082,9 @@ class Ninetailed {
       if (experience_jsPluginAnalytics.hasComponentViewTrackingThreshold(plugin)) {
         plugin.setComponentViewTrackingThreshold(componentViewTrackingThreshold);
       }
+      if (requiresEventBuilder(plugin)) {
+        plugin.setEventBuilder(this.eventBuilder);
+      }
     });
     this._profileState = {
       status: 'loading',
@@ -1085,7 +1093,6 @@ class Ninetailed {
       error: null,
       from: 'api'
     };
-    this.eventBuilder = new EventBuilder(buildClientContext);
     this.ninetailedCorePlugin = new NinetailedCorePlugin({
       apiClient: this.apiClient,
       locale,
@@ -1280,6 +1287,7 @@ exports.CONSENT = CONSENT;
 exports.DEBUG_FLAG = DEBUG_FLAG;
 exports.EMPTY_MERGE_ID = EMPTY_MERGE_ID;
 exports.EXPERIENCES_FALLBACK_CACHE = EXPERIENCES_FALLBACK_CACHE;
+exports.EventBuilder = EventBuilder;
 exports.HAS_SEEN_STICKY_COMPONENT = HAS_SEEN_STICKY_COMPONENT;
 exports.LEGACY_ANONYMOUS_ID = LEGACY_ANONYMOUS_ID;
 exports.Ninetailed = Ninetailed;

package/index.esm.js

@@ -175,7 +175,7 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
     logger.debug('Ninetailed Core plugin initialized.');
   }
   pageStart(params) {
-    return this.abortNonClientEvents(params);
+    return NinetailedCorePlugin.abortNonClientEvents(params);
   }
   async page({
     payload
@@ -190,7 +190,7 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
     }));
   }
   trackStart(params) {
-    return this.abortNonClientEvents(params);
+    return NinetailedCorePlugin.abortNonClientEvents(params);
   }
   async track({
     payload
@@ -206,7 +206,7 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
     }));
   }
   identifyStart(params) {
-    return this.abortNonClientEvents(params);
+    return NinetailedCorePlugin.abortNonClientEvents(params);
   }
   async identify({
     payload
@@ -252,7 +252,7 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
   async enqueueEvent(event) {
     this.queue = unionBy([event], this.queue, 'messageId');
   }
-  abortNonClientEvents({
+  static abortNonClientEvents({
     abort,
     payload
   }) {
@@ -491,7 +491,7 @@ const makeExperienceSelectMiddleware = ({
     const middlewareFunctions = pluginsWithMiddleware.map(plugin => plugin.getExperienceSelectionMiddleware({
       experiences,
       baseline
-    }));
+    })).filter(result => typeof result !== 'undefined');
     return pipe(...middlewareFunctions);
   };
   const middleware = prepareMiddleware();
@@ -560,6 +560,10 @@ class EventBuilder {
   }
 }
 
+const requiresEventBuilder = plugin => {
+  return typeof plugin === 'object' && plugin !== null && 'setEventBuilder' in plugin && typeof plugin.setEventBuilder === 'function';
+};
+
 const _excluded = ["experience", "variant", "variantIndex"],
   _excluded2 = ["element"];
 const buildOverrideMiddleware = experienceSelectionMiddleware => _ref => {
@@ -1049,6 +1053,7 @@ class Ninetailed {
       });
     }
     this.plugins = (plugins != null ? plugins : []).flat();
+    this.eventBuilder = new EventBuilder(buildClientContext);
     this.plugins.forEach(plugin => {
       if (acceptsCredentials(plugin) && this.clientId && this.environment) {
         plugin.setCredentials({
@@ -1059,6 +1064,9 @@ class Ninetailed {
       if (hasComponentViewTrackingThreshold(plugin)) {
         plugin.setComponentViewTrackingThreshold(componentViewTrackingThreshold);
       }
+      if (requiresEventBuilder(plugin)) {
+        plugin.setEventBuilder(this.eventBuilder);
+      }
     });
     this._profileState = {
       status: 'loading',
@@ -1067,7 +1075,6 @@ class Ninetailed {
       error: null,
       from: 'api'
     };
-    this.eventBuilder = new EventBuilder(buildClientContext);
     this.ninetailedCorePlugin = new NinetailedCorePlugin({
       apiClient: this.apiClient,
       locale,
@@ -1221,4 +1228,4 @@ const selectVariant = (baseline, variants, {
   };
 };
 
-export { ANONYMOUS_ID, COMPONENT, COMPONENT_START, CONSENT, DEBUG_FLAG, EMPTY_MERGE_ID, EXPERIENCES_FALLBACK_CACHE, HAS_SEEN_STICKY_COMPONENT, LEGACY_ANONYMOUS_ID, Ninetailed, NinetailedCorePlugin, OnChangeEmitter, PAGE_HIDDEN, PLUGIN_NAME, PROFILE_CHANGE, PROFILE_FALLBACK_CACHE, PROFILE_RESET, SET_ENABLED_FEATURES, buildClientNinetailedRequestContext, decodeExperienceVariantsMap, makeExperienceSelectMiddleware, selectPluginsHavingExperienceSelectionMiddleware, selectPluginsHavingOnChangeEmitter, selectVariant };
+export { ANONYMOUS_ID, COMPONENT, COMPONENT_START, CONSENT, DEBUG_FLAG, EMPTY_MERGE_ID, EXPERIENCES_FALLBACK_CACHE, EventBuilder, HAS_SEEN_STICKY_COMPONENT, LEGACY_ANONYMOUS_ID, Ninetailed, NinetailedCorePlugin, OnChangeEmitter, PAGE_HIDDEN, PLUGIN_NAME, PROFILE_CHANGE, PROFILE_FALLBACK_CACHE, PROFILE_RESET, SET_ENABLED_FEATURES, buildClientNinetailedRequestContext, decodeExperienceVariantsMap, makeExperienceSelectMiddleware, selectPluginsHavingExperienceSelectionMiddleware, selectPluginsHavingOnChangeEmitter, selectVariant };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "7.8.0",
+  "version": "7.9.0",
   "description": "Ninetailed SDK for javascript",
   "license": "MIT",
   "repository": {
@@ -9,8 +9,8 @@
     "directory": "packages/sdks/javascript"
   },
   "dependencies": {
-    "@ninetailed/experience.js-plugin-analytics": "7.8.0",
-    "@ninetailed/experience.js-shared": "7.8.0",
+    "@ninetailed/experience.js-plugin-analytics": "7.9.0",
+    "@ninetailed/experience.js-shared": "7.9.0",
     "analytics": "0.8.1",
     "uuid": "9.0.0"
   },

package/src/index.d.ts

@@ -6,10 +6,12 @@ export * from './lib/types';
 export * from './lib/experience';
 export * from './lib/plugins/selectPluginsHavingExperienceSelectionMiddleware';
 export * from './lib/plugins/selectPluginsHavingOnChangeEmitter';
+export * from './lib/types/interfaces/RequiresEventBuilder';
 export * from './lib/types/interfaces/HasExperienceSelectionMiddleware';
 export * from './lib/types/interfaces/InterestedInSeenElements';
 export * from './lib/types/interfaces/InterestedInProfileChange';
 export * from './lib/types/interfaces/InterestedInHiddenPage';
 export * from './lib/types/interfaces/AcceptsCredentials';
 export * from './lib/utils/OnChangeEmitter';
+export * from './lib/utils/EventBuilder';
 export type { Profile } from '@ninetailed/experience.js-shared';

package/src/lib/NinetailedCorePlugin/NinetailedCorePlugin.d.ts

@@ -62,7 +62,7 @@ export declare class NinetailedCorePlugin extends NinetailedAnalyticsPlugin impl
         debug: (...args: any[]) => Promise<void>;
     };
     private enqueueEvent;
-    private abortNonClientEvents;
+    private static abortNonClientEvents;
     private get instance();
     flush: (args: void) => Promise<FlushResult>;
     private _flush;

package/src/lib/guards/requiresEventBuilder.d.ts

@@ -0,0 +1,2 @@
+import { RequiresEventBuilder } from '../types/interfaces/RequiresEventBuilder';
+export declare const requiresEventBuilder: (plugin: unknown) => plugin is RequiresEventBuilder;

package/src/lib/types/interfaces/HasExperienceSelectionMiddleware.d.ts

@@ -9,7 +9,7 @@ type BuildExperienceSelectionMiddlewareArg<TVariant extends Reference> = {
     experiences: ExperienceConfiguration<TVariant>[];
     baseline: Reference;
 };
-export type BuildExperienceSelectionMiddleware<TBaseline extends Reference, TVariant extends Reference> = (arg: BuildExperienceSelectionMiddlewareArg<TVariant>) => ExperienceSelectionMiddleware<TBaseline, TVariant>;
+export type BuildExperienceSelectionMiddleware<TBaseline extends Reference, TVariant extends Reference> = (arg: BuildExperienceSelectionMiddlewareArg<TVariant>) => ExperienceSelectionMiddleware<TBaseline, TVariant> | undefined;
 export interface HasExperienceSelectionMiddleware<TBaseline extends Reference, TVariant extends Reference> {
     getExperienceSelectionMiddleware: BuildExperienceSelectionMiddleware<TBaseline, TVariant>;
 }

package/src/lib/types/interfaces/RequiresEventBuilder.d.ts

@@ -0,0 +1,4 @@
+import { EventBuilder } from '../../utils/EventBuilder';
+export interface RequiresEventBuilder {
+    setEventBuilder(eventBuilder: EventBuilder): void;
+}