@thumbmarkjs/thumbmarkjs 1.1.0-rc.2 → 1.1.0-rc.4

package/src/options.ts

@@ -7,6 +7,7 @@ export interface optionsInterface {
     api_key?: string,
     cache_api_call?: boolean,
     performance?: boolean,
+    stabilize?: string[],
 }
 
 export const API_ENDPOINT = 'https://api.thumbmarkjs.com';
@@ -14,6 +15,7 @@ export const API_ENDPOINT = 'https://api.thumbmarkjs.com';
 export const defaultOptions: optionsInterface = {
     exclude: [],
     include: [],
+    stabilize: ['private', 'iframe'],
     logging: true,
     timeout: 5000,
     cache_api_call: true,
@@ -27,11 +29,30 @@ export let options = {...defaultOptions};
  * @param value 
  */
 export function setOption<K extends keyof optionsInterface>(key: K, value: optionsInterface[K]) {
-    if (!['include', 'exclude', 'permissions_to_check', 'retries', 'timeout', 'logging', 'api_key', 'cache_api_call'].includes(key))
-        throw new Error('Unknown option ' + key)
-    if (['include', 'exclude', 'permissions_to_check'].includes(key) && !(Array.isArray(value) && value.every(item => typeof item === 'string')) )
-        throw new Error('The value of the include, exclude and permissions_to_check must be an array of strings');
-    if ([ 'retries', 'timeout'].includes(key) && typeof value !== 'number')
-        throw new Error('The value of retries must be a number');
     options[key] = value;
 }
+
+export const stabilizationExclusionRules = {
+    'private': [
+        { exclude: ['canvas'], browsers: ['firefox', 'safari>=17', 'brave' ]},
+        { exclude: ['audio'], browsers: ['samsungbrowser', 'safari' ]},
+        { exclude: ['fonts'], browsers: ['firefox']},
+        { exclude: ['plugins'], browsers: ['brave']},
+    ],
+    'iframe': [
+        {
+            exclude: [
+                'permissions.camera',
+                'permission.geolocation',
+                'permissions.microphone',
+                'system.applePayVersion',
+                'system.cookieEnabled'
+            ],
+            browsers: ['safari']
+        },
+
+    ],
+    'vpn': [
+        { exclude: ['ip'] },
+    ],
+}

package/src/utils/sort.ts

@@ -0,0 +1,23 @@
+import { componentInterface } from '../factory';
+
+/**
+ * Recursively sorts the keys of a component object alphabetically.
+ * This ensures a consistent order for hashing.
+ * @param obj The component object to sort.
+ * @returns A new object with sorted keys.
+ */
+export function sortComponentKeys(obj: componentInterface): componentInterface {
+    // Arrays, primitives, and null values are returned as is.
+    if (typeof obj !== 'object' || obj === null || Array.isArray(obj)) {
+        return obj;
+    }
+
+    return Object.keys(obj)
+        .sort()
+        .reduce((acc: componentInterface, key: string) => {
+            const value = obj[key];
+            // Recurse for nested objects
+            acc[key] = sortComponentKeys(value as componentInterface);
+            return acc;
+        }, {});
+}