@ninetailed/experience.js 7.11.1 → 7.12.0

package/index.cjs.js

@@ -98,6 +98,7 @@ const ANONYMOUS_ID = '__nt_anonymous_id__';
 const DEBUG_FLAG = '__nt_debug__';
 const PROFILE_FALLBACK_CACHE = '__nt_profile__';
 const EXPERIENCES_FALLBACK_CACHE = '__nt_experiences__';
+const CHANGES_FALLBACK_CACHE = '__nt_changes__';
 const PROFILE_CHANGE = 'profile-change';
 const PROFILE_RESET = 'profile-reset';
 const CONSENT = '__nt-consent__';
@@ -343,19 +344,31 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
   clearFallbackExperiences() {
     this.instance.storage.removeItem(EXPERIENCES_FALLBACK_CACHE);
   }
+  setFallbackChanges(changes) {
+    this.instance.storage.setItem(CHANGES_FALLBACK_CACHE, changes);
+  }
+  getFallbackChanges() {
+    return this.instance.storage.getItem(CHANGES_FALLBACK_CACHE) || [];
+  }
+  clearFallbackChanges() {
+    this.instance.storage.removeItem(CHANGES_FALLBACK_CACHE);
+  }
   clearCaches() {
     this.clearAnonymousId();
     this.clearFallbackProfile();
     this.clearFallbackExperiences();
+    this.clearFallbackChanges();
   }
   populateCaches({
     experiences,
     profile,
-    anonymousId
+    anonymousId,
+    changes
   }) {
     this.setAnonymousId(anonymousId);
     this.setFallbackProfile(profile);
     this.setFallbackExperiences(experiences);
+    this.setFallbackChanges(changes);
   }
   _flush() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -371,7 +384,8 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
         const anonymousId = this.getAnonymousId();
         const {
           profile,
-          experiences
+          experiences,
+          changes
         } = yield this.apiClient.upsertProfile({
           profileId: anonymousId,
           events
@@ -382,7 +396,8 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
         this.populateCaches({
           anonymousId: profile.id,
           profile,
-          experiences
+          experiences,
+          changes
         });
         experience_jsShared.logger.debug('Profile from api: ', profile);
         experience_jsShared.logger.debug('Experiences from api: ', experiences);
@@ -390,6 +405,7 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
           type: PROFILE_CHANGE,
           profile,
           experiences,
+          changes,
           error: undefined
         });
         yield delay(20);
@@ -400,12 +416,14 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
         experience_jsShared.logger.debug('An error occurred during flushing the events: ', error);
         const fallbackProfile = this.getFallbackProfile();
         const fallbackExperiences = this.getFallbackExperiences();
+        const fallbackChanges = this.getFallbackChanges();
         if (fallbackProfile) {
           experience_jsShared.logger.debug('Found a fallback profile - will use this.');
           this.instance.dispatch({
             type: PROFILE_CHANGE,
             profile: fallbackProfile,
             experiences: fallbackExperiences,
+            changes: fallbackChanges,
             error: undefined
           });
         } else {
@@ -413,6 +431,7 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
           this.instance.dispatch({
             type: PROFILE_CHANGE,
             profile: null,
+            changes: fallbackChanges,
             experiences: fallbackExperiences,
             error: error
           });
@@ -850,6 +869,7 @@ class Ninetailed {
           cb(Object.assign(Object.assign({}, this._profileState), {
             status: 'success',
             profile: payload.profile,
+            changes: payload.changes,
             experiences: payload.experiences,
             error: null
           }));
@@ -1018,6 +1038,18 @@ class Ninetailed {
         removeMiddlewareChangeListeners();
       };
     };
+    /**
+     * Registers a callback to be notified when changes occur in the profile state.
+     *
+     * @param cb - Callback function that receives the changes state
+     * @returns Function to unsubscribe from changes updates
+     */
+    this.onChangesChange = cb => {
+      this.notifyChangesCallback(cb, this._profileState);
+      return this.onProfileChange(profileState => {
+        this.notifyChangesCallback(cb, profileState);
+      });
+    };
     this.onIsInitialized = onIsInitializedCallback => {
       if (typeof onIsInitializedCallback === 'function') {
         if (this.isInitialized) {
@@ -1105,6 +1137,7 @@ class Ninetailed {
       status: 'loading',
       profile: null,
       experiences: null,
+      changes: null,
       error: null,
       from: 'api'
     };
@@ -1179,6 +1212,31 @@ class Ninetailed {
       });
     });
   }
+  /**
+   * Helper method to extract changes state from profile state and notify callback
+   * @private
+   */
+  notifyChangesCallback(cb, profileState) {
+    if (profileState.status === 'loading') {
+      cb({
+        status: 'loading',
+        changes: null,
+        error: null
+      });
+    } else if (profileState.status === 'error') {
+      cb({
+        status: 'error',
+        changes: null,
+        error: profileState.error
+      });
+    } else {
+      cb({
+        status: 'success',
+        changes: profileState.changes,
+        error: null
+      });
+    }
+  }
   // Always throws, never returns
   handleMethodError(error, method) {
     experience_jsShared.logger.error(error);
@@ -1332,6 +1390,7 @@ Object.defineProperty(exports, 'selectHasExperienceVariants', {
     get: function () { return experience_jsShared.selectHasVariants; }
 });
 exports.ANONYMOUS_ID = ANONYMOUS_ID;
+exports.CHANGES_FALLBACK_CACHE = CHANGES_FALLBACK_CACHE;
 exports.COMPONENT = COMPONENT;
 exports.COMPONENT_START = COMPONENT_START;
 exports.CONSENT = CONSENT;

package/index.esm.js

@@ -54,6 +54,7 @@ const ANONYMOUS_ID = '__nt_anonymous_id__';
 const DEBUG_FLAG = '__nt_debug__';
 const PROFILE_FALLBACK_CACHE = '__nt_profile__';
 const EXPERIENCES_FALLBACK_CACHE = '__nt_experiences__';
+const CHANGES_FALLBACK_CACHE = '__nt_changes__';
 const PROFILE_CHANGE = 'profile-change';
 const PROFILE_RESET = 'profile-reset';
 const CONSENT = '__nt-consent__';
@@ -294,19 +295,31 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
   clearFallbackExperiences() {
     this.instance.storage.removeItem(EXPERIENCES_FALLBACK_CACHE);
   }
+  setFallbackChanges(changes) {
+    this.instance.storage.setItem(CHANGES_FALLBACK_CACHE, changes);
+  }
+  getFallbackChanges() {
+    return this.instance.storage.getItem(CHANGES_FALLBACK_CACHE) || [];
+  }
+  clearFallbackChanges() {
+    this.instance.storage.removeItem(CHANGES_FALLBACK_CACHE);
+  }
   clearCaches() {
     this.clearAnonymousId();
     this.clearFallbackProfile();
     this.clearFallbackExperiences();
+    this.clearFallbackChanges();
   }
   populateCaches({
     experiences,
     profile,
-    anonymousId
+    anonymousId,
+    changes
   }) {
     this.setAnonymousId(anonymousId);
     this.setFallbackProfile(profile);
     this.setFallbackExperiences(experiences);
+    this.setFallbackChanges(changes);
   }
   async _flush() {
     const events = Object.assign([], this.queue);
@@ -321,7 +334,8 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
       const anonymousId = this.getAnonymousId();
       const {
         profile,
-        experiences
+        experiences,
+        changes
       } = await this.apiClient.upsertProfile({
         profileId: anonymousId,
         events
@@ -332,7 +346,8 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
       this.populateCaches({
         anonymousId: profile.id,
         profile,
-        experiences
+        experiences,
+        changes
       });
       logger.debug('Profile from api: ', profile);
       logger.debug('Experiences from api: ', experiences);
@@ -340,6 +355,7 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
         type: PROFILE_CHANGE,
         profile,
         experiences,
+        changes,
         error: undefined
       });
       await delay(20);
@@ -350,12 +366,14 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
       logger.debug('An error occurred during flushing the events: ', error);
       const fallbackProfile = this.getFallbackProfile();
       const fallbackExperiences = this.getFallbackExperiences();
+      const fallbackChanges = this.getFallbackChanges();
       if (fallbackProfile) {
         logger.debug('Found a fallback profile - will use this.');
         this.instance.dispatch({
           type: PROFILE_CHANGE,
           profile: fallbackProfile,
           experiences: fallbackExperiences,
+          changes: fallbackChanges,
           error: undefined
         });
       } else {
@@ -363,6 +381,7 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
         this.instance.dispatch({
           type: PROFILE_CHANGE,
           profile: null,
+          changes: fallbackChanges,
           experiences: fallbackExperiences,
           error: error
         });
@@ -833,6 +852,7 @@ class Ninetailed {
           cb(Object.assign({}, this._profileState, {
             status: 'success',
             profile: payload.profile,
+            changes: payload.changes,
             experiences: payload.experiences,
             error: null
           }));
@@ -1001,6 +1021,18 @@ class Ninetailed {
         removeMiddlewareChangeListeners();
       };
     };
+    /**
+     * Registers a callback to be notified when changes occur in the profile state.
+     *
+     * @param cb - Callback function that receives the changes state
+     * @returns Function to unsubscribe from changes updates
+     */
+    this.onChangesChange = cb => {
+      this.notifyChangesCallback(cb, this._profileState);
+      return this.onProfileChange(profileState => {
+        this.notifyChangesCallback(cb, profileState);
+      });
+    };
     this.onIsInitialized = onIsInitializedCallback => {
       if (typeof onIsInitializedCallback === 'function') {
         if (this.isInitialized) {
@@ -1088,6 +1120,7 @@ class Ninetailed {
       status: 'loading',
       profile: null,
       experiences: null,
+      changes: null,
       error: null,
       from: 'api'
     };
@@ -1167,6 +1200,32 @@ class Ninetailed {
       });
     });
   }
+  /**
+   * Helper method to extract changes state from profile state and notify callback
+   * @private
+   */
+  notifyChangesCallback(cb, profileState) {
+    if (profileState.status === 'loading') {
+      cb({
+        status: 'loading',
+        changes: null,
+        error: null
+      });
+    } else if (profileState.status === 'error') {
+      cb({
+        status: 'error',
+        changes: null,
+        error: profileState.error
+      });
+    } else {
+      cb({
+        status: 'success',
+        changes: profileState.changes,
+        error: null
+      });
+    }
+  }
+
   // Always throws, never returns
   handleMethodError(error, method) {
     logger.error(error);
@@ -1284,4 +1343,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, CHANGES_FALLBACK_CACHE, 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.11.1",
+  "version": "7.12.0",
   "description": "Ninetailed SDK for javascript",
   "license": "MIT",
   "repository": {
@@ -9,8 +9,8 @@
     "directory": "packages/sdks/javascript"
   },
   "dependencies": {
-    "@ninetailed/experience.js-plugin-analytics": "7.11.1",
-    "@ninetailed/experience.js-shared": "7.11.1",
+    "@ninetailed/experience.js-plugin-analytics": "7.12.0",
+    "@ninetailed/experience.js-shared": "7.12.0",
     "analytics": "0.8.1",
     "uuid": "9.0.0"
   },

package/src/lib/Ninetailed.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="analytics" />
 import { Locale, Traits, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions, NinetailedRequestContext, Reference, Event } from '@ninetailed/experience.js-shared';
 import { OnInitProfileId } from './NinetailedCorePlugin';
-import { EventFunctionOptions, NinetailedInstance, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, TrackComponentView } from './types';
+import { EventFunctionOptions, NinetailedInstance, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, TrackComponentView, OnChangesChangeCallback } from './types';
 import { ObserveOptions } from './ElementSeenObserver';
 import { OnSelectVariantArgs, OnSelectVariantCallback } from './types/OnSelectVariant';
 import { ElementSeenPayload, NinetailedPlugin } from '@ninetailed/experience.js-plugin-analytics';
@@ -80,6 +80,18 @@ export declare class Ninetailed implements NinetailedInstance {
     debug: (enabled: boolean) => Promise<void>;
     onProfileChange: (cb: OnProfileChangeCallback) => import("analytics").DetachListeners;
     onSelectVariant: <Baseline extends Reference, Variant extends Reference>({ baseline, experiences }: OnSelectVariantArgs<Baseline, Variant>, cb: OnSelectVariantCallback<Baseline, Variant>) => () => void;
+    /**
+     * Registers a callback to be notified when changes occur in the profile state.
+     *
+     * @param cb - Callback function that receives the changes state
+     * @returns Function to unsubscribe from changes updates
+     */
+    onChangesChange: (cb: OnChangesChangeCallback) => import("analytics").DetachListeners;
+    /**
+     * Helper method to extract changes state from profile state and notify callback
+     * @private
+     */
+    private notifyChangesCallback;
     private handleMethodError;
     onIsInitialized: (onIsInitializedCallback: OnIsInitializedCallback) => void;
     private waitUntilInitialized;

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

@@ -76,6 +76,9 @@ export declare class NinetailedCorePlugin extends NinetailedAnalyticsPlugin impl
     private setFallbackExperiences;
     private getFallbackExperiences;
     private clearFallbackExperiences;
+    private setFallbackChanges;
+    private getFallbackChanges;
+    private clearFallbackChanges;
     private clearCaches;
     private populateCaches;
     private _flush;

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

@@ -1,5 +1,5 @@
 import { HAS_SEEN_COMPONENT, HAS_SEEN_ELEMENT } from '@ninetailed/experience.js-plugin-analytics';
-import { PROFILE_CHANGE, Profile, SelectedVariantInfo, PROFILE_RESET } from '@ninetailed/experience.js-shared';
+import { PROFILE_CHANGE, Profile, SelectedVariantInfo, PROFILE_RESET, Change } from '@ninetailed/experience.js-shared';
 import { HAS_SEEN_STICKY_COMPONENT, PAGE_HIDDEN } from '../constants';
 type ReadyAction = {
     type: 'ready';
@@ -16,11 +16,13 @@ type ProfileChangeAction = {
     type: typeof PROFILE_CHANGE;
     profile: Profile;
     experiences: SelectedVariantInfo[];
+    changes: Change[];
     error: undefined | null;
 } | {
     type: typeof PROFILE_CHANGE;
     profile: Profile | null;
     experiences: SelectedVariantInfo[];
+    changes: Change[];
     error: Error;
 };
 type ProfileResetAction = {

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

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

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

@@ -1,5 +1,5 @@
 import { DetachListeners } from 'analytics';
-import { Logger, PageviewProperties, Profile, Properties, Traits, SelectedVariantInfo, Reference, Event } from '@ninetailed/experience.js-shared';
+import { Logger, PageviewProperties, Profile, Properties, Traits, SelectedVariantInfo, Reference, Event, Change } from '@ninetailed/experience.js-shared';
 import { ElementSeenPayload, NinetailedPlugin, TrackComponentProperties } from '@ninetailed/experience.js-plugin-analytics';
 import { type Ninetailed } from '../Ninetailed';
 import { OnSelectVariant } from './OnSelectVariant';
@@ -8,21 +8,37 @@ export type ProfileState = {
     status: 'loading';
     profile: null;
     experiences: null;
+    changes: null;
     error: null;
     from: 'api' | 'hydrated';
 } | {
     status: 'success';
     profile: Profile;
     experiences: SelectedVariantInfo[];
+    changes: Change[];
     error: null;
     from: 'api' | 'hydrated';
 } | {
     status: 'error';
     profile: Profile | null;
     experiences: SelectedVariantInfo[] | null;
+    changes: Change[] | null;
     error: Error;
     from: 'api' | 'hydrated';
 };
+export type ChangesState = {
+    status: 'loading';
+    changes: null;
+    error: null;
+} | {
+    status: 'success';
+    changes: Change[];
+    error: null;
+} | {
+    status: 'error';
+    changes: null;
+    error: Error;
+};
 export type OnIsInitializedCallback = () => void;
 export type OnIsInitialized = (cb: OnIsInitializedCallback) => void;
 export type EventFunctionOptions = {
@@ -42,6 +58,7 @@ export type Result<T> = {
     error: Error;
 };
 export type OnProfileChangeCallback = (profile: ProfileState) => void;
+export type OnChangesChangeCallback = (changesState: ChangesState) => void;
 export type Page = (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<FlushResult>;
 export type Track = (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<FlushResult>;
 export type TrackHasSeenComponent = (properties: TrackComponentProperties) => Promise<void>;
@@ -51,6 +68,7 @@ export type Batch = (events: Event[]) => Promise<FlushResult>;
 export type Reset = () => void;
 export type Debug = (enable: boolean) => void;
 export type OnProfileChange = (cb: OnProfileChangeCallback) => DetachListeners;
+export type OnChangesChange = (cb: OnChangesChangeCallback) => DetachListeners;
 type ObserveElement = Ninetailed['observeElement'];
 type UnObserveElement = Ninetailed['unobserveElement'];
 export interface NinetailedInstance<TBaseline extends Reference = Reference, TVariant extends Reference = Reference> {
@@ -67,6 +85,7 @@ export interface NinetailedInstance<TBaseline extends Reference = Reference, TVa
     debug: Debug;
     profileState: ProfileState;
     onProfileChange: OnProfileChange;
+    onChangesChange: OnChangesChange;
     plugins: NinetailedPlugin[];
     logger: Logger;
     eventBuilder: EventBuilder;