@thumbmarkjs/thumbmarkjs 1.5.1 → 1.6.1

package/src/utils/visitorId.test.ts

@@ -1,5 +1,5 @@
 import { getVisitorId, setVisitorId } from './visitorId';
-import { optionsInterface, defaultOptions } from '../options';
+import { defaultOptions, options, OptionsAfterDefaults } from '../options';
 
 describe('visitorId storage tests', () => {
     beforeEach(() => {
@@ -21,7 +21,7 @@ describe('visitorId storage tests', () => {
 
         test('should use custom storage property name', () => {
             const visitorId = 'custom-visitor-456';
-            const customOptions: optionsInterface = {
+            const customOptions: OptionsAfterDefaults = {
                 ...defaultOptions,
                 storage_property_name: 'my_custom_visitor_key'
             };
@@ -37,7 +37,7 @@ describe('visitorId storage tests', () => {
         });
 
         test('should return null when storage property does not exist', () => {
-            const options: optionsInterface = {
+            const options: OptionsAfterDefaults = {
                 ...defaultOptions,
                 storage_property_name: 'nonexistent_key'
             };
@@ -56,6 +56,15 @@ describe('visitorId storage tests', () => {
             setVisitorId(newVisitorId, options);
             expect(getVisitorId(options)).toBe(newVisitorId);
         });
+
+        test('should migrate from old value in case new prefix is set', () => {
+            const visitorId = 'test-visitor-123';
+            setVisitorId(visitorId, options);
+            expect(getVisitorId({
+                property_name_factory: (name) => `custom_prefix_${name}`,
+            } as OptionsAfterDefaults)).toBe(visitorId);
+            expect(localStorage.getItem(`custom_prefix_visitor_id`)).toBe(visitorId);
+        })
     });
 
     describe('error handling', () => {

package/src/utils/visitorId.ts

@@ -1,18 +1,42 @@
-import { optionsInterface } from "../options";
+import { DEFAULT_STORAGE_PREFIX, OptionsAfterDefaults } from "../options";
 
 /**
  * Visitor ID storage utilities - localStorage only, server generates IDs
  */
 
-const DEFAULT_STORAGE_PROPERTY_NAME = 'thumbmark_visitor_id';
+const DEFAULT_STORAGE_PROPERTY_NAME = 'visitor_id';
 
+/**
+ * Get the storage property name for visitor id
+ * @param _options
+ */
+export function getVisitorIdPropertyName(
+    _options: Pick<OptionsAfterDefaults, 'storage_property_name' | 'property_name_factory'>
+): string {
+    if(_options.storage_property_name) {
+        return _options.storage_property_name;
+    }
+
+    return _options.property_name_factory(DEFAULT_STORAGE_PROPERTY_NAME);
+}
+
+const DEFAULT_VISITOR_ID_NAME = `${DEFAULT_STORAGE_PREFIX}_${DEFAULT_STORAGE_PROPERTY_NAME}`;
 /**
  * Gets visitor ID from localStorage, returns null if unavailable
  */
-export function getVisitorId(_options: optionsInterface): string | null {
-    const storagePropertyName = _options.storage_property_name || DEFAULT_STORAGE_PROPERTY_NAME;
+export function getVisitorId(_options: OptionsAfterDefaults): string | null {
     try {
-        return localStorage.getItem(storagePropertyName);
+        const propertyName = getVisitorIdPropertyName(_options);
+        let visitorId = localStorage.getItem(propertyName);
+        if(!visitorId && propertyName !== DEFAULT_VISITOR_ID_NAME) {
+            // Migration case in case going from thumbmark prefix to a custom one
+            visitorId = localStorage.getItem(DEFAULT_VISITOR_ID_NAME);
+            if(visitorId) {
+                setVisitorId(visitorId, _options);
+            }
+        }
+
+        return visitorId;
     } catch {
         return null;
     }
@@ -21,10 +45,9 @@ export function getVisitorId(_options: optionsInterface): string | null {
 /**
  * Sets visitor ID in localStorage
  */
-export function setVisitorId(visitorId: string, _options: optionsInterface): void {
-    const storagePropertyName = _options.storage_property_name || DEFAULT_STORAGE_PROPERTY_NAME;
+export function setVisitorId(visitorId: string, _options: OptionsAfterDefaults): void {
     try {
-        localStorage.setItem(storagePropertyName, visitorId);
+        localStorage.setItem(getVisitorIdPropertyName(_options), visitorId);
     } catch {
         // Ignore storage errors
     }