@thumbmarkjs/thumbmarkjs 1.4.0 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thumbmarkjs/thumbmarkjs",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "",
   "type": "module",
   "main": "./dist/thumbmark.cjs.js",

package/src/functions/api.ts

@@ -67,7 +67,7 @@ export const getApiPromise = (
     // 3. Otherwise, initiate a new API call with timeout.
     const apiEndpoint = options.api_endpoint || DEFAULT_API_ENDPOINT;
     const endpoint = `${apiEndpoint}/thumbmark`;
-    const visitorId = getVisitorId();
+    const visitorId = getVisitorId(options);
     const requestBody: any = {
         components,
         options,
@@ -100,7 +100,7 @@ export const getApiPromise = (
         .then(data => {
             // Handle visitor ID from server response
             if (data.visitorId && data.visitorId !== visitorId) {
-                setVisitorId(data.visitorId);
+                setVisitorId(data.visitorId, options);
             }
             apiPromiseResult = data;      // Cache the successful result
             currentApiPromise = null;     // Clear the in-flight promise

package/src/options.ts

@@ -1,4 +1,5 @@
 export interface optionsInterface {
+    storage_property_name: string,
     exclude?: string[],
     include?: string[],
     permissions_to_check?: PermissionName[],
@@ -23,9 +24,10 @@ export const defaultOptions: optionsInterface = {
     cache_api_call: true,
     performance: false,
     experimental: false,
-    };
+    storage_property_name: 'thumbmark_visitor_id',
+};
 
-export let options = {...defaultOptions};
+export let options = { ...defaultOptions };
 /**
  * 
  * @param key @deprecated this function will be removed
@@ -37,12 +39,12 @@ export function setOption<K extends keyof optionsInterface>(key: K, value: optio
 
 export const stabilizationExclusionRules = {
     'private': [
-        { exclude: ['canvas'], browsers: ['firefox', 'safari>=17', 'brave' ]},
-        { exclude: ['audio'], browsers: ['samsungbrowser', 'safari' ]},
-        { exclude: ['fonts'], browsers: ['firefox']},
-        { exclude: ['audio.sampleHash', 'hardware.deviceMemory', 'header.acceptLanguage.q', 'system.hardwareConcurrency', 'plugins'], browsers: ['brave']},
-        { exclude: ['tls.extensions'], browsers: ['firefox', 'chrome', 'safari']},
-        { exclude: ['header.acceptLanguage'], browsers: ['edge', 'chrome']},
+        { exclude: ['canvas'], browsers: ['firefox', 'safari>=17', 'brave'] },
+        { exclude: ['audio'], browsers: ['samsungbrowser', 'safari'] },
+        { exclude: ['fonts'], browsers: ['firefox'] },
+        { exclude: ['audio.sampleHash', 'hardware.deviceMemory', 'header.acceptLanguage.q', 'system.hardwareConcurrency', 'plugins'], browsers: ['brave'] },
+        { exclude: ['tls.extensions'], browsers: ['firefox', 'chrome', 'safari'] },
+        { exclude: ['header.acceptLanguage'], browsers: ['edge', 'chrome'] },
     ],
     'iframe': [
         {

package/src/utils/visitorId.test.ts

@@ -0,0 +1,93 @@
+import { getVisitorId, setVisitorId } from './visitorId';
+import { optionsInterface, defaultOptions } from '../options';
+
+describe('visitorId storage tests', () => {
+    beforeEach(() => {
+        // Clear localStorage before each test to ensure isolation
+        localStorage.clear();
+    });
+
+    describe('storage_property_name option', () => {
+        test('should use default storage property name', () => {
+            const visitorId = 'test-visitor-123';
+            const options = { ...defaultOptions };
+
+            setVisitorId(visitorId, options);
+
+            // Verify it was stored with the default property name
+            expect(localStorage.getItem('thumbmark_visitor_id')).toBe(visitorId);
+            expect(getVisitorId(options)).toBe(visitorId);
+        });
+
+        test('should use custom storage property name', () => {
+            const visitorId = 'custom-visitor-456';
+            const customOptions: optionsInterface = {
+                ...defaultOptions,
+                storage_property_name: 'my_custom_visitor_key'
+            };
+
+            setVisitorId(visitorId, customOptions);
+
+            // Verify it was stored with the custom property name
+            expect(localStorage.getItem('my_custom_visitor_key')).toBe(visitorId);
+            expect(getVisitorId(customOptions)).toBe(visitorId);
+
+            // Verify it's NOT in the default location
+            expect(localStorage.getItem('thumbmark_visitor_id')).toBeNull();
+        });
+
+        test('should return null when storage property does not exist', () => {
+            const options: optionsInterface = {
+                ...defaultOptions,
+                storage_property_name: 'nonexistent_key'
+            };
+
+            expect(getVisitorId(options)).toBeNull();
+        });
+
+        test('should overwrite existing value for same storage property', () => {
+            const oldVisitorId = 'old-visitor';
+            const newVisitorId = 'new-visitor';
+            const options = { ...defaultOptions };
+
+            setVisitorId(oldVisitorId, options);
+            expect(getVisitorId(options)).toBe(oldVisitorId);
+
+            setVisitorId(newVisitorId, options);
+            expect(getVisitorId(options)).toBe(newVisitorId);
+        });
+    });
+
+    describe('error handling', () => {
+        test('should handle localStorage.getItem errors gracefully', () => {
+            const options = { ...defaultOptions };
+
+            // Mock localStorage.getItem to throw an error
+            const originalGetItem = localStorage.getItem;
+            localStorage.getItem = jest.fn(() => {
+                throw new Error('Storage quota exceeded');
+            });
+
+            expect(getVisitorId(options)).toBeNull();
+
+            // Restore original implementation
+            localStorage.getItem = originalGetItem;
+        });
+
+        test('should handle localStorage.setItem errors gracefully', () => {
+            const options = { ...defaultOptions };
+
+            // Mock localStorage.setItem to throw an error
+            const originalSetItem = localStorage.setItem;
+            localStorage.setItem = jest.fn(() => {
+                throw new Error('Storage quota exceeded');
+            });
+
+            // Should not throw error
+            expect(() => setVisitorId('test-id', options)).not.toThrow();
+
+            // Restore original implementation
+            localStorage.setItem = originalSetItem;
+        });
+    });
+});

package/src/utils/visitorId.ts

@@ -1,15 +1,15 @@
+import { optionsInterface } from "../options";
+
 /**
  * Visitor ID storage utilities - localStorage only, server generates IDs
  */
 
-const VISITOR_ID_KEY = 'thumbmark_visitor_id';
-
 /**
  * Gets visitor ID from localStorage, returns null if unavailable
  */
-export function getVisitorId(): string | null {
+export function getVisitorId(_options: optionsInterface): string | null {
     try {
-        return localStorage.getItem(VISITOR_ID_KEY);
+        return localStorage.getItem(_options.storage_property_name);
     } catch {
         return null;
     }
@@ -18,9 +18,9 @@ export function getVisitorId(): string | null {
 /**
  * Sets visitor ID in localStorage
  */
-export function setVisitorId(visitorId: string): void {
+export function setVisitorId(visitorId: string, _options: optionsInterface): void {
     try {
-        localStorage.setItem(VISITOR_ID_KEY, visitorId);
+        localStorage.setItem(_options.storage_property_name, visitorId);
     } catch {
         // Ignore storage errors
     }