@ninetailed/experience.js 7.0.1-beta.0 → 7.1.0-beta.0

package/index.cjs

@@ -96,6 +96,7 @@ const LEGACY_ANONYMOUS_ID = '__anon_id';
 const ANONYMOUS_ID = '__nt_anonymous_id__';
 const DEBUG_FLAG = '__nt_debug__';
 const PROFILE_FALLBACK_CACHE = '__nt_profile__';
+const EXPERIENCES_FALLBACK_CACHE = '__nt_experiences__';
 const PROFILE_CHANGE = 'profile-change';
 const PROFILE_RESET = 'profile-reset';
 const CONSENT = '__nt-consent__';
@@ -126,7 +127,10 @@ const ninetailedPlugin = ({
     }
     try {
       const anonymousId = _instance.storage.getItem(ANONYMOUS_ID);
-      const profile = yield apiClient.upsertProfile({
+      const {
+        profile,
+        experiences
+      } = yield apiClient.upsertProfile({
         profileId: anonymousId,
         events
       }, {
@@ -135,10 +139,13 @@ const ninetailedPlugin = ({
       });
       _instance.storage.setItem(ANONYMOUS_ID, profile.id);
       _instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
+      _instance.storage.setItem(EXPERIENCES_FALLBACK_CACHE, experiences);
       experience_jsShared.logger.debug('Profile from api: ', profile);
+      experience_jsShared.logger.debug('Experiences from api: ', experiences);
       _instance.dispatch({
         type: PROFILE_CHANGE,
-        profile
+        profile,
+        experiences
       });
       yield delay(20);
       return {
@@ -147,27 +154,27 @@ const ninetailedPlugin = ({
     } catch (error) {
       experience_jsShared.logger.debug('An error occurred during flushing the events: ', error);
       const fallbackProfile = _instance.storage.getItem(PROFILE_FALLBACK_CACHE);
+      const fallbackExperiences = _instance.storage.getItem(EXPERIENCES_FALLBACK_CACHE) || [];
       if (fallbackProfile) {
         experience_jsShared.logger.debug('Found a fallback profile - will use this.');
         _instance.dispatch({
           type: PROFILE_CHANGE,
-          profile: fallbackProfile
+          profile: fallbackProfile,
+          experiences: fallbackExperiences
         });
-        return {
-          success: false
-        };
       } else {
         experience_jsShared.logger.debug('No fallback profile found - setting profile to null.');
         _instance.dispatch({
           type: PROFILE_CHANGE,
           // TODO is it a good idea to set the profile to null?
           profile: null,
+          experiences: fallbackExperiences,
           error
         });
-        return {
-          success: false
-        };
       }
+      return {
+        success: false
+      };
     }
   });
   const enqueueEvent = event => __awaiter(void 0, void 0, void 0, function* () {
@@ -266,7 +273,7 @@ const ninetailedPlugin = ({
       abort,
       payload
     }) => {
-      if (![ANONYMOUS_ID, DEBUG_FLAG, PROFILE_FALLBACK_CACHE, CONSENT].includes(payload.key)) {
+      if (![ANONYMOUS_ID, DEBUG_FLAG, PROFILE_FALLBACK_CACHE, EXPERIENCES_FALLBACK_CACHE, CONSENT].includes(payload.key)) {
         return abort();
       }
       return payload;
@@ -281,6 +288,7 @@ const ninetailedPlugin = ({
         });
         instance.storage.removeItem(ANONYMOUS_ID);
         instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
+        instance.storage.removeItem(EXPERIENCES_FALLBACK_CACHE);
         experience_jsShared.logger.debug('Removed old profile data from localstorage.');
         yield ninetailed.track('nt_reset');
         experience_jsShared.logger.info('Profile reset successful.');
@@ -356,7 +364,6 @@ class Ninetailed {
   constructor(ninetailedApiClientInstanceOrOptions, {
     plugins,
     url,
-    profile,
     locale,
     requestTimeout,
     onLog,
@@ -474,12 +481,14 @@ class Ninetailed {
           cb(Object.assign(Object.assign({}, this._profileState), {
             status: 'error',
             profile: payload.profile,
+            experiences: payload.experiences,
             error: payload.error
           }));
         } else {
           cb(Object.assign(Object.assign({}, this._profileState), {
             status: 'success',
             profile: payload.profile,
+            experiences: payload.experiences,
             error: null
           }));
         }
@@ -541,21 +550,13 @@ class Ninetailed {
         });
       }
     });
-    if (profile) {
-      this._profileState = {
-        status: 'success',
-        profile,
-        error: null,
-        from: 'hydrated'
-      };
-    } else {
-      this._profileState = {
-        status: 'loading',
-        profile: null,
-        error: null,
-        from: 'api'
-      };
-    }
+    this._profileState = {
+      status: 'loading',
+      profile: null,
+      experiences: null,
+      error: null,
+      from: 'api'
+    };
     if (typeof onLog === 'function') {
       experience_jsShared.logger.addSink(new experience_jsShared.OnLogLogSink(onLog));
     }
@@ -565,7 +566,6 @@ class Ninetailed {
     this.logger = experience_jsShared.logger;
     this.eventQueue = ninetailedPlugin({
       apiClient: this.apiClient,
-      profile,
       locale,
       requestTimeout,
       buildClientContext,
@@ -587,7 +587,8 @@ class Ninetailed {
       this._profileState = profileState;
       if (typeof window !== 'undefined') {
         window.ninetailed = Object.assign({}, window.ninetailed, {
-          profile: this.profileState.profile
+          profile: this.profileState.profile,
+          experiences: this.profileState.experiences
         });
       }
     });
@@ -666,7 +667,7 @@ const selectVariant = (baseline, variants, {
     return (_a = profile === null || profile === void 0 ? void 0 : profile.audiences) === null || _a === void 0 ? void 0 : _a.includes((_b = variant.audience) === null || _b === void 0 ? void 0 : _b.id);
   });
   if (variant) {
-    if ((options === null || options === void 0 ? void 0 : options.holdout) || -1 > (profile === null || profile === void 0 ? void 0 : profile.random)) {
+    if ((options === null || options === void 0 ? void 0 : options.holdout) || -1 > ((profile === null || profile === void 0 ? void 0 : profile.random) || 0)) {
       return {
         loading: false,
         variant: Object.assign(Object.assign({}, baseline), {
@@ -902,6 +903,7 @@ exports.ANONYMOUS_ID = ANONYMOUS_ID;
 exports.CONSENT = CONSENT;
 exports.DEBUG_FLAG = DEBUG_FLAG;
 exports.EMPTY_MERGE_ID = EMPTY_MERGE_ID;
+exports.EXPERIENCES_FALLBACK_CACHE = EXPERIENCES_FALLBACK_CACHE;
 exports.ElementSeenPayloadSchema = ElementSeenPayloadSchema;
 exports.HAS_SEEN_COMPONENT = HAS_SEEN_COMPONENT;
 exports.HAS_SEEN_ELEMENT = HAS_SEEN_ELEMENT;

package/index.js

@@ -89,6 +89,7 @@ const LEGACY_ANONYMOUS_ID = '__anon_id';
 const ANONYMOUS_ID = '__nt_anonymous_id__';
 const DEBUG_FLAG = '__nt_debug__';
 const PROFILE_FALLBACK_CACHE = '__nt_profile__';
+const EXPERIENCES_FALLBACK_CACHE = '__nt_experiences__';
 const PROFILE_CHANGE = 'profile-change';
 const PROFILE_RESET = 'profile-reset';
 const CONSENT = '__nt-consent__';
@@ -119,7 +120,10 @@ const ninetailedPlugin = ({
     }
     try {
       const anonymousId = _instance.storage.getItem(ANONYMOUS_ID);
-      const profile = yield apiClient.upsertProfile({
+      const {
+        profile,
+        experiences
+      } = yield apiClient.upsertProfile({
         profileId: anonymousId,
         events
       }, {
@@ -128,10 +132,13 @@ const ninetailedPlugin = ({
       });
       _instance.storage.setItem(ANONYMOUS_ID, profile.id);
       _instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
+      _instance.storage.setItem(EXPERIENCES_FALLBACK_CACHE, experiences);
       logger.debug('Profile from api: ', profile);
+      logger.debug('Experiences from api: ', experiences);
       _instance.dispatch({
         type: PROFILE_CHANGE,
-        profile
+        profile,
+        experiences
       });
       yield delay(20);
       return {
@@ -140,27 +147,27 @@ const ninetailedPlugin = ({
     } catch (error) {
       logger.debug('An error occurred during flushing the events: ', error);
       const fallbackProfile = _instance.storage.getItem(PROFILE_FALLBACK_CACHE);
+      const fallbackExperiences = _instance.storage.getItem(EXPERIENCES_FALLBACK_CACHE) || [];
       if (fallbackProfile) {
         logger.debug('Found a fallback profile - will use this.');
         _instance.dispatch({
           type: PROFILE_CHANGE,
-          profile: fallbackProfile
+          profile: fallbackProfile,
+          experiences: fallbackExperiences
         });
-        return {
-          success: false
-        };
       } else {
         logger.debug('No fallback profile found - setting profile to null.');
         _instance.dispatch({
           type: PROFILE_CHANGE,
           // TODO is it a good idea to set the profile to null?
           profile: null,
+          experiences: fallbackExperiences,
           error
         });
-        return {
-          success: false
-        };
       }
+      return {
+        success: false
+      };
     }
   });
   const enqueueEvent = event => __awaiter(void 0, void 0, void 0, function* () {
@@ -259,7 +266,7 @@ const ninetailedPlugin = ({
       abort,
       payload
     }) => {
-      if (![ANONYMOUS_ID, DEBUG_FLAG, PROFILE_FALLBACK_CACHE, CONSENT].includes(payload.key)) {
+      if (![ANONYMOUS_ID, DEBUG_FLAG, PROFILE_FALLBACK_CACHE, EXPERIENCES_FALLBACK_CACHE, CONSENT].includes(payload.key)) {
         return abort();
       }
       return payload;
@@ -274,6 +281,7 @@ const ninetailedPlugin = ({
         });
         instance.storage.removeItem(ANONYMOUS_ID);
         instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
+        instance.storage.removeItem(EXPERIENCES_FALLBACK_CACHE);
         logger.debug('Removed old profile data from localstorage.');
         yield ninetailed.track('nt_reset');
         logger.info('Profile reset successful.');
@@ -349,7 +357,6 @@ class Ninetailed {
   constructor(ninetailedApiClientInstanceOrOptions, {
     plugins,
     url,
-    profile,
     locale,
     requestTimeout,
     onLog,
@@ -467,12 +474,14 @@ class Ninetailed {
           cb(Object.assign(Object.assign({}, this._profileState), {
             status: 'error',
             profile: payload.profile,
+            experiences: payload.experiences,
             error: payload.error
           }));
         } else {
           cb(Object.assign(Object.assign({}, this._profileState), {
             status: 'success',
             profile: payload.profile,
+            experiences: payload.experiences,
             error: null
           }));
         }
@@ -534,21 +543,13 @@ class Ninetailed {
         });
       }
     });
-    if (profile) {
-      this._profileState = {
-        status: 'success',
-        profile,
-        error: null,
-        from: 'hydrated'
-      };
-    } else {
-      this._profileState = {
-        status: 'loading',
-        profile: null,
-        error: null,
-        from: 'api'
-      };
-    }
+    this._profileState = {
+      status: 'loading',
+      profile: null,
+      experiences: null,
+      error: null,
+      from: 'api'
+    };
     if (typeof onLog === 'function') {
       logger.addSink(new OnLogLogSink(onLog));
     }
@@ -558,7 +559,6 @@ class Ninetailed {
     this.logger = logger;
     this.eventQueue = ninetailedPlugin({
       apiClient: this.apiClient,
-      profile,
       locale,
       requestTimeout,
       buildClientContext,
@@ -580,7 +580,8 @@ class Ninetailed {
       this._profileState = profileState;
       if (typeof window !== 'undefined') {
         window.ninetailed = Object.assign({}, window.ninetailed, {
-          profile: this.profileState.profile
+          profile: this.profileState.profile,
+          experiences: this.profileState.experiences
         });
       }
     });
@@ -659,7 +660,7 @@ const selectVariant = (baseline, variants, {
     return (_a = profile === null || profile === void 0 ? void 0 : profile.audiences) === null || _a === void 0 ? void 0 : _a.includes((_b = variant.audience) === null || _b === void 0 ? void 0 : _b.id);
   });
   if (variant) {
-    if ((options === null || options === void 0 ? void 0 : options.holdout) || -1 > (profile === null || profile === void 0 ? void 0 : profile.random)) {
+    if ((options === null || options === void 0 ? void 0 : options.holdout) || -1 > ((profile === null || profile === void 0 ? void 0 : profile.random) || 0)) {
       return {
         loading: false,
         variant: Object.assign(Object.assign({}, baseline), {
@@ -855,4 +856,4 @@ const makeExperienceSelectMiddleware = ({
   };
 };
 
-export { ANONYMOUS_ID, CONSENT, DEBUG_FLAG, EMPTY_MERGE_ID, ElementSeenPayloadSchema, HAS_SEEN_COMPONENT, HAS_SEEN_ELEMENT, LEGACY_ANONYMOUS_ID, Ninetailed, NinetailedPlugin, OnChangeEmitter, PAGE_HIDDEN, PLUGIN_NAME, PROFILE_CHANGE, PROFILE_FALLBACK_CACHE, PROFILE_RESET, SET_ENABLED_FEATURES, TrackComponentProperties, buildClientNinetailedRequestContext, decodeExperienceVariantsMap, makeExperienceSelectMiddleware, ninetailedPlugin, selectPluginsHavingExperienceSelectionMiddleware, selectPluginsHavingOnChangeEmitter, selectVariant };
+export { ANONYMOUS_ID, CONSENT, DEBUG_FLAG, EMPTY_MERGE_ID, EXPERIENCES_FALLBACK_CACHE, ElementSeenPayloadSchema, HAS_SEEN_COMPONENT, HAS_SEEN_ELEMENT, LEGACY_ANONYMOUS_ID, Ninetailed, NinetailedPlugin, OnChangeEmitter, PAGE_HIDDEN, PLUGIN_NAME, PROFILE_CHANGE, PROFILE_FALLBACK_CACHE, PROFILE_RESET, SET_ENABLED_FEATURES, TrackComponentProperties, buildClientNinetailedRequestContext, decodeExperienceVariantsMap, makeExperienceSelectMiddleware, ninetailedPlugin, selectPluginsHavingExperienceSelectionMiddleware, selectPluginsHavingOnChangeEmitter, selectVariant };

package/lib/Ninetailed.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="analytics" />
-import { Locale, Traits, Profile, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions, NinetailedRequestContext } from '@ninetailed/experience.js-shared';
+import { Locale, Traits, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions, NinetailedRequestContext } from '@ninetailed/experience.js-shared';
 import { EventFunctionOptions, NinetailedInstance, NinetailedPlugin, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, ElementSeenPayload, TrackComponentView } from './types';
 import { ObserveOptions } from './ElementSeenObserver';
 declare global {
@@ -24,7 +24,6 @@ type Options = {
     url?: string;
     locale?: Locale;
     plugins?: (NinetailedPlugin | NinetailedPlugin[])[];
-    profile?: Profile;
     requestTimeout?: number;
     onLog?: OnLogHandler;
     onError?: OnErrorHandler;
@@ -46,7 +45,7 @@ export declare class Ninetailed implements NinetailedInstance {
     readonly plugins: NinetailedPlugin[];
     readonly logger: Logger;
     private readonly componentViewTrackingThreshold;
-    constructor(ninetailedApiClientInstanceOrOptions: NinetailedApiClientInstanceOrOptions, { plugins, url, profile, locale, requestTimeout, onLog, onError, buildClientContext, componentViewTrackingThreshold, storageImpl, }?: Options);
+    constructor(ninetailedApiClientInstanceOrOptions: NinetailedApiClientInstanceOrOptions, { plugins, url, locale, requestTimeout, onLog, onError, buildClientContext, componentViewTrackingThreshold, storageImpl, }?: Options);
     page: (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     track: (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     /**

package/lib/analytics/constants.d.ts

@@ -2,6 +2,7 @@ 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 EXPERIENCES_FALLBACK_CACHE = "__nt_experiences__";
 export declare const PROFILE_CHANGE = "profile-change";
 export declare const PROFILE_RESET = "profile-reset";
 export declare const CONSENT = "__nt-consent__";

package/lib/selectVariant.d.ts

@@ -33,5 +33,5 @@ type Fail<T> = {
 type Result<T> = Loading<T> | Success<T> | Fail<T>;
 export declare const selectVariant: <T extends {
     id: string;
-}>(baseline: T, variants: Variant<T>[], { status, profile, error }: ProfileState, options?: Options) => Result<T>;
+}>(baseline: T, variants: Variant<T>[], { status, profile, error }: Omit<ProfileState, 'experiences'>, options?: Options) => Result<T>;
 export {};

package/lib/types/index.d.ts

@@ -1,4 +1,4 @@
-import { Logger, PageviewProperties, Profile, Properties, Traits } from '@ninetailed/experience.js-shared';
+import { Logger, PageviewProperties, Profile, Properties, Traits, SelectedVariantInfo } from '@ninetailed/experience.js-shared';
 import { DetachListeners } from 'analytics';
 import { TrackComponentProperties } from './TrackingProperties';
 import { NinetailedPlugin } from './NinetailedPlugin';
@@ -7,16 +7,19 @@ import { ElementSeenPayload } from './ElementSeenPayload';
 type Loading = {
     status: 'loading';
     profile: null;
+    experiences: null;
     error: null;
 };
 type Success = {
     status: 'success';
     profile: Profile;
+    experiences: SelectedVariantInfo[];
     error: null;
 };
 type Fail = {
     status: 'error';
     profile: null;
+    experiences: null;
     error: Error;
 };
 export type ProfileState = {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "7.0.1-beta.0",
+  "version": "7.1.0-beta.0",
   "module": "./index.js",
   "main": "./index.cjs",
   "type": "module",
   "types": "./index.d.ts",
   "dependencies": {
-    "@ninetailed/experience.js-shared": "7.0.1-beta.0",
+    "@ninetailed/experience.js-shared": "7.1.0-beta.0",
     "analytics": "0.8.1",
     "zod": "3.21.4"
   },