@ninetailed/experience.js 7.8.0-beta.1 → 7.8.0-beta.2

package/index.cjs.js

@@ -595,10 +595,6 @@ 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,
@@ -962,7 +958,10 @@ class Ninetailed {
           })));
           return;
         }
-        const baselineVariants = experience_jsShared.selectBaselineWithVariants(experience, baseline);
+        const experienceWithStickyFromExperienceApi = Object.assign(Object.assign({}, experience), {
+          sticky: selectedExperience.sticky
+        });
+        const baselineVariants = experience_jsShared.selectBaselineWithVariants(experienceWithStickyFromExperienceApi, baseline);
         if (!baselineVariants) {
           setSelectedVariant(overrideResult(Object.assign(Object.assign({}, emptyReturn), {
             loading: false,
@@ -987,7 +986,7 @@ class Ninetailed {
           status: 'success',
           loading: false,
           error: null,
-          experience,
+          experience: experienceWithStickyFromExperienceApi,
           variant,
           variantIndex: selectedExperience.variantIndex,
           audience: experience.audience ? experience.audience : null,
@@ -1018,6 +1017,18 @@ class Ninetailed {
         this.onIsInitialized(resolve);
       });
     };
+    // The following methods are used to register methods of the Ninetailed instance on the window object.
+    // GTM templates do not support executing async functions in `callInWindow`.
+    // Therefore, we provide a versions of those methods without the async keyword.
+    this.trackAsWindowHandler = (event, properties, options) => {
+      return this.track(event, properties, options);
+    };
+    this.identifyAsWindowHandler = (uid, traits, options) => {
+      return this.identify(uid, traits, options);
+    };
+    this.pageAsWindowHandler = (data, options) => {
+      return this.page(data, options);
+    };
     this.onVisibilityChange = () => {
       if (typeof document === 'undefined') {
         return;
@@ -1056,7 +1067,6 @@ 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({
@@ -1067,9 +1077,6 @@ class Ninetailed {
       if (experience_jsPluginAnalytics.hasComponentViewTrackingThreshold(plugin)) {
         plugin.setComponentViewTrackingThreshold(componentViewTrackingThreshold);
       }
-      if (requiresEventBuilder(plugin)) {
-        plugin.setEventBuilder(this.eventBuilder);
-      }
     });
     this._profileState = {
       status: 'loading',
@@ -1078,6 +1085,7 @@ class Ninetailed {
       error: null,
       from: 'api'
     };
+    this.eventBuilder = new EventBuilder(buildClientContext);
     this.ninetailedCorePlugin = new NinetailedCorePlugin({
       apiClient: this.apiClient,
       locale,
@@ -1130,9 +1138,9 @@ class Ninetailed {
   registerWindowHandlers() {
     if (typeof window !== 'undefined') {
       window.ninetailed = Object.assign({}, window.ninetailed, {
-        page: this.page.bind(this),
-        track: this.track.bind(this),
-        identify: this.identify.bind(this),
+        page: this.pageAsWindowHandler.bind(this),
+        track: this.trackAsWindowHandler.bind(this),
+        identify: this.identifyAsWindowHandler.bind(this),
         reset: this.reset.bind(this),
         debug: this.debug.bind(this),
         profile: this.profileState.profile
@@ -1272,7 +1280,6 @@ 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

@@ -560,10 +560,6 @@ 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 => {
@@ -944,7 +940,10 @@ class Ninetailed {
           })));
           return;
         }
-        const baselineVariants = selectBaselineWithVariants(experience, baseline);
+        const experienceWithStickyFromExperienceApi = Object.assign({}, experience, {
+          sticky: selectedExperience.sticky
+        });
+        const baselineVariants = selectBaselineWithVariants(experienceWithStickyFromExperienceApi, baseline);
         if (!baselineVariants) {
           setSelectedVariant(overrideResult(Object.assign({}, emptyReturn, {
             loading: false,
@@ -969,7 +968,7 @@ class Ninetailed {
           status: 'success',
           loading: false,
           error: null,
-          experience,
+          experience: experienceWithStickyFromExperienceApi,
           variant,
           variantIndex: selectedExperience.variantIndex,
           audience: experience.audience ? experience.audience : null,
@@ -1000,6 +999,18 @@ class Ninetailed {
         this.onIsInitialized(resolve);
       });
     };
+    // The following methods are used to register methods of the Ninetailed instance on the window object.
+    // GTM templates do not support executing async functions in `callInWindow`.
+    // Therefore, we provide a versions of those methods without the async keyword.
+    this.trackAsWindowHandler = (event, properties, options) => {
+      return this.track(event, properties, options);
+    };
+    this.identifyAsWindowHandler = (uid, traits, options) => {
+      return this.identify(uid, traits, options);
+    };
+    this.pageAsWindowHandler = (data, options) => {
+      return this.page(data, options);
+    };
     this.onVisibilityChange = () => {
       if (typeof document === 'undefined') {
         return;
@@ -1038,7 +1049,6 @@ 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({
@@ -1049,9 +1059,6 @@ class Ninetailed {
       if (hasComponentViewTrackingThreshold(plugin)) {
         plugin.setComponentViewTrackingThreshold(componentViewTrackingThreshold);
       }
-      if (requiresEventBuilder(plugin)) {
-        plugin.setEventBuilder(this.eventBuilder);
-      }
     });
     this._profileState = {
       status: 'loading',
@@ -1060,6 +1067,7 @@ class Ninetailed {
       error: null,
       from: 'api'
     };
+    this.eventBuilder = new EventBuilder(buildClientContext);
     this.ninetailedCorePlugin = new NinetailedCorePlugin({
       apiClient: this.apiClient,
       locale,
@@ -1113,9 +1121,9 @@ class Ninetailed {
   registerWindowHandlers() {
     if (typeof window !== 'undefined') {
       window.ninetailed = Object.assign({}, window.ninetailed, {
-        page: this.page.bind(this),
-        track: this.track.bind(this),
-        identify: this.identify.bind(this),
+        page: this.pageAsWindowHandler.bind(this),
+        track: this.trackAsWindowHandler.bind(this),
+        identify: this.identifyAsWindowHandler.bind(this),
         reset: this.reset.bind(this),
         debug: this.debug.bind(this),
         profile: this.profileState.profile
@@ -1213,4 +1221,4 @@ const selectVariant = (baseline, variants, {
   };
 };
 
-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 };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "7.8.0-beta.1",
+  "version": "7.8.0-beta.2",
   "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-beta.1",
-    "@ninetailed/experience.js-shared": "7.8.0-beta.1",
+    "@ninetailed/experience.js-plugin-analytics": "7.8.0-beta.2",
+    "@ninetailed/experience.js-shared": "7.8.0-beta.2",
     "analytics": "0.8.1",
     "uuid": "9.0.0"
   },

package/src/index.d.ts

@@ -6,12 +6,10 @@ 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/Ninetailed.d.ts

@@ -81,6 +81,9 @@ export declare class Ninetailed implements NinetailedInstance {
     private waitUntilInitialized;
     get profileState(): ProfileState;
     private buildOptions;
+    private trackAsWindowHandler;
+    private identifyAsWindowHandler;
+    private pageAsWindowHandler;
     private registerWindowHandlers;
     private onVisibilityChange;
 }

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

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

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

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