@ninetailed/experience.js 6.4.0-beta.1 → 6.4.0-beta.5

package/index.cjs

@@ -2621,7 +2621,7 @@ const ninetailedPlugin = ({
       };
     }
     try {
-      const anonymousId = _instance.storage.getItem(ANONYMOUS_ID);
+      const anonymousId = yield _instance.storage.getItem(ANONYMOUS_ID);
       const profile = yield apiClient.upsertProfile({
         profileId: anonymousId,
         events
@@ -2629,8 +2629,8 @@ const ninetailedPlugin = ({
         locale,
         enabledFeatures
       });
-      _instance.storage.setItem(ANONYMOUS_ID, profile.id);
-      _instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
+      yield _instance.storage.setItem(ANONYMOUS_ID, profile.id);
+      yield _instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
       experience_jsShared.logger.debug('Profile from api: ', profile);
       _instance.dispatch({
         type: PROFILE_CHANGE,
@@ -2642,7 +2642,7 @@ 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 fallbackProfile = yield _instance.storage.getItem(PROFILE_FALLBACK_CACHE);
       if (fallbackProfile) {
         experience_jsShared.logger.debug('Found a fallback profile - will use this.');
         _instance.dispatch({
@@ -2683,21 +2683,21 @@ const ninetailedPlugin = ({
     config: {},
     initialize: ({
       instance
-    }) => {
+    }) => __awaiter(void 0, void 0, void 0, function* () {
       _instance = instance;
-      if (instance.storage.getItem(DEBUG_FLAG)) {
+      if (yield instance.storage.getItem(DEBUG_FLAG)) {
         experience_jsShared.logger.addSink(new experience_jsShared.ConsoleLogSink());
         experience_jsShared.logger.info('Ninetailed Debug Mode is enabled.');
       }
       // legacy support for the old anonymousId
-      const legacyAnonymousId = instance.storage.getItem(LEGACY_ANONYMOUS_ID);
+      const legacyAnonymousId = yield instance.storage.getItem(LEGACY_ANONYMOUS_ID);
       if (legacyAnonymousId) {
         experience_jsShared.logger.debug('Found legacy anonymousId, migrating to new one.', legacyAnonymousId);
-        instance.storage.setItem(ANONYMOUS_ID, legacyAnonymousId);
-        instance.storage.removeItem(LEGACY_ANONYMOUS_ID);
+        yield instance.storage.setItem(ANONYMOUS_ID, legacyAnonymousId);
+        yield instance.storage.removeItem(LEGACY_ANONYMOUS_ID);
       }
       if (profile) {
-        instance.storage.setItem(ANONYMOUS_ID, profile.id);
+        yield instance.storage.setItem(ANONYMOUS_ID, profile.id);
       }
       instance.on(SET_ENABLED_FEATURES, ({
         payload
@@ -2705,7 +2705,7 @@ const ninetailedPlugin = ({
         enabledFeatures = payload.features || [];
       });
       experience_jsShared.logger.debug('Ninetailed Core plugin initialized.');
-    },
+    }),
     flush: asyncThrottle(flush),
     pageStart: params => {
       return abortNonClientEvents(params);
@@ -2775,9 +2775,10 @@ const ninetailedPlugin = ({
         instance.dispatch({
           type: PROFILE_RESET
         });
-        instance.storage.removeItem(ANONYMOUS_ID);
-        instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
+        yield instance.storage.removeItem(ANONYMOUS_ID);
+        yield instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
         experience_jsShared.logger.debug('Removed old profile data from localstorage.');
+        // TODO replace with a proper event instead of abusing the track event ssystem.
         yield ninetailed.track('nt_reset');
         experience_jsShared.logger.info('Profile reset successful.');
         yield delay(10);
@@ -2787,11 +2788,11 @@ const ninetailedPlugin = ({
         const instance = args[args.length - 1];
         const consoleLogSink = new experience_jsShared.ConsoleLogSink();
         if (enabled) {
-          instance.storage.setItem(DEBUG_FLAG, true);
+          yield instance.storage.setItem(DEBUG_FLAG, true);
           experience_jsShared.logger.addSink(consoleLogSink);
           experience_jsShared.logger.info('Debug mode enabled.');
         } else {
-          instance.storage.removeItem(DEBUG_FLAG);
+          yield instance.storage.removeItem(DEBUG_FLAG);
           experience_jsShared.logger.info('Debug mode disabled.');
           experience_jsShared.logger.removeSink(consoleLogSink.name);
         }
@@ -3364,7 +3365,8 @@ class Ninetailed {
     onLog,
     onError,
     buildClientContext,
-    componentViewTrackingThreshold = 2000
+    componentViewTrackingThreshold = 2000,
+    storage
   } = {}) {
     this.isInitialized = false;
     this.page = (data, options) => __awaiter(this, void 0, void 0, function* () {
@@ -3572,10 +3574,10 @@ class Ninetailed {
       buildClientContext,
       ninetailed: this
     });
-    this.instance = Analytics__default["default"]({
+    this.instance = Analytics__default["default"](Object.assign({
       app: 'ninetailed',
       plugins: [...this.plugins, this.eventQueue]
-    });
+    }, storage ? storage : {}));
     const detachOnReadyListener = this.instance.on('ready', () => {
       this.isInitialized = true;
       experience_jsShared.logger.info('Ninetailed Experience.js SDK is completely initialized.');

package/index.js

@@ -2614,7 +2614,7 @@ const ninetailedPlugin = ({
       };
     }
     try {
-      const anonymousId = _instance.storage.getItem(ANONYMOUS_ID);
+      const anonymousId = yield _instance.storage.getItem(ANONYMOUS_ID);
       const profile = yield apiClient.upsertProfile({
         profileId: anonymousId,
         events
@@ -2622,8 +2622,8 @@ const ninetailedPlugin = ({
         locale,
         enabledFeatures
       });
-      _instance.storage.setItem(ANONYMOUS_ID, profile.id);
-      _instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
+      yield _instance.storage.setItem(ANONYMOUS_ID, profile.id);
+      yield _instance.storage.setItem(PROFILE_FALLBACK_CACHE, profile);
       logger.debug('Profile from api: ', profile);
       _instance.dispatch({
         type: PROFILE_CHANGE,
@@ -2635,7 +2635,7 @@ const ninetailedPlugin = ({
       };
     } catch (error) {
       logger.debug('An error occurred during flushing the events: ', error);
-      const fallbackProfile = _instance.storage.getItem(PROFILE_FALLBACK_CACHE);
+      const fallbackProfile = yield _instance.storage.getItem(PROFILE_FALLBACK_CACHE);
       if (fallbackProfile) {
         logger.debug('Found a fallback profile - will use this.');
         _instance.dispatch({
@@ -2676,21 +2676,21 @@ const ninetailedPlugin = ({
     config: {},
     initialize: ({
       instance
-    }) => {
+    }) => __awaiter(void 0, void 0, void 0, function* () {
       _instance = instance;
-      if (instance.storage.getItem(DEBUG_FLAG)) {
+      if (yield instance.storage.getItem(DEBUG_FLAG)) {
         logger.addSink(new ConsoleLogSink());
         logger.info('Ninetailed Debug Mode is enabled.');
       }
       // legacy support for the old anonymousId
-      const legacyAnonymousId = instance.storage.getItem(LEGACY_ANONYMOUS_ID);
+      const legacyAnonymousId = yield instance.storage.getItem(LEGACY_ANONYMOUS_ID);
       if (legacyAnonymousId) {
         logger.debug('Found legacy anonymousId, migrating to new one.', legacyAnonymousId);
-        instance.storage.setItem(ANONYMOUS_ID, legacyAnonymousId);
-        instance.storage.removeItem(LEGACY_ANONYMOUS_ID);
+        yield instance.storage.setItem(ANONYMOUS_ID, legacyAnonymousId);
+        yield instance.storage.removeItem(LEGACY_ANONYMOUS_ID);
       }
       if (profile) {
-        instance.storage.setItem(ANONYMOUS_ID, profile.id);
+        yield instance.storage.setItem(ANONYMOUS_ID, profile.id);
       }
       instance.on(SET_ENABLED_FEATURES, ({
         payload
@@ -2698,7 +2698,7 @@ const ninetailedPlugin = ({
         enabledFeatures = payload.features || [];
       });
       logger.debug('Ninetailed Core plugin initialized.');
-    },
+    }),
     flush: asyncThrottle(flush),
     pageStart: params => {
       return abortNonClientEvents(params);
@@ -2768,9 +2768,10 @@ const ninetailedPlugin = ({
         instance.dispatch({
           type: PROFILE_RESET
         });
-        instance.storage.removeItem(ANONYMOUS_ID);
-        instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
+        yield instance.storage.removeItem(ANONYMOUS_ID);
+        yield instance.storage.removeItem(PROFILE_FALLBACK_CACHE);
         logger.debug('Removed old profile data from localstorage.');
+        // TODO replace with a proper event instead of abusing the track event ssystem.
         yield ninetailed.track('nt_reset');
         logger.info('Profile reset successful.');
         yield delay(10);
@@ -2780,11 +2781,11 @@ const ninetailedPlugin = ({
         const instance = args[args.length - 1];
         const consoleLogSink = new ConsoleLogSink();
         if (enabled) {
-          instance.storage.setItem(DEBUG_FLAG, true);
+          yield instance.storage.setItem(DEBUG_FLAG, true);
           logger.addSink(consoleLogSink);
           logger.info('Debug mode enabled.');
         } else {
-          instance.storage.removeItem(DEBUG_FLAG);
+          yield instance.storage.removeItem(DEBUG_FLAG);
           logger.info('Debug mode disabled.');
           logger.removeSink(consoleLogSink.name);
         }
@@ -3357,7 +3358,8 @@ class Ninetailed {
     onLog,
     onError,
     buildClientContext,
-    componentViewTrackingThreshold = 2000
+    componentViewTrackingThreshold = 2000,
+    storage
   } = {}) {
     this.isInitialized = false;
     this.page = (data, options) => __awaiter(this, void 0, void 0, function* () {
@@ -3565,10 +3567,10 @@ class Ninetailed {
       buildClientContext,
       ninetailed: this
     });
-    this.instance = Analytics({
+    this.instance = Analytics(Object.assign({
       app: 'ninetailed',
       plugins: [...this.plugins, this.eventQueue]
-    });
+    }, storage ? storage : {}));
     const detachOnReadyListener = this.instance.on('ready', () => {
       this.isInitialized = true;
       logger.info('Ninetailed Experience.js SDK is completely initialized.');

package/lib/Ninetailed.d.ts

@@ -12,6 +12,14 @@ declare global {
         } & unknown;
     }
 }
+type GetItem<T = any> = (key: string) => Promise<T>;
+type SetItem = (key: string, value: string) => Promise<void>;
+type RemoveItem = (key: string) => Promise<void>;
+export type Storage = {
+    getItem: GetItem;
+    setItem: SetItem;
+    removeItem: RemoveItem;
+};
 type Options = {
     url?: string;
     locale?: Locale;
@@ -22,6 +30,7 @@ type Options = {
     onError?: OnErrorHandler;
     componentViewTrackingThreshold?: number;
     buildClientContext?: () => NinetailedRequestContext;
+    storage?: Storage;
 };
 type NinetailedApiClientInstanceOrOptions = NinetailedApiClient | NinetailedApiClientOptions;
 export declare class Ninetailed implements NinetailedInstance {
@@ -37,7 +46,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, }?: Options);
+    constructor(ninetailedApiClientInstanceOrOptions: NinetailedApiClientInstanceOrOptions, { plugins, url, profile, locale, requestTimeout, onLog, onError, buildClientContext, componentViewTrackingThreshold, storage, }?: Options);
     page: (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     track: (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     /**

package/package.json

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