@thumbmarkjs/thumbmarkjs 1.0.0-rc.2 → 1.1.0-rc.1

package/src/functions/index.ts

@@ -8,7 +8,6 @@
  *   - getThumbmark
  *   - getThumbmarkDataFromPromiseMap
  *   - resolveClientComponents
- *   - getVersion
  *   - filterThumbmarkData
  *
  * Internal helpers and types are also defined here.
@@ -25,8 +24,10 @@ import {
 } from "../factory";
 import { hash } from "../utils/hash";
 import { raceAllPerformance } from "../utils/raceAll";
-import * as packageJson from '../../package.json';
+import { getVersion } from "../utils/version";
 import { filterThumbmarkData } from './filterComponents'
+import { logThumbmarkData } from '../utils/log';
+import { API_ENDPOINT } from "../options";
 
 // ===================== Types & Interfaces =====================
 
@@ -42,7 +43,7 @@ interface infoInterface {
     },
     classification?: {
         tor: boolean,
-        proxy: boolean, // i.e. vpn and 
+        proxy: boolean, 
         datacenter: boolean,
         danger_level: number, // 5 is highest and should be blocked. 0 is no danger.
     },
@@ -59,6 +60,7 @@ interface apiResponse {
     thumbmark?: string;
     info?: infoInterface;
     version?: string;
+    components?: componentInterface;
 }
 
 /**
@@ -75,14 +77,7 @@ interface thumbmarkResponse {
     elapsed?: any;
 }
 
-// ===================== Version =====================
 
-/**
- * Returns the current package version
- */
-export function getVersion(): string {
-    return packageJson.version;
-}
 
 // ===================== API Call Logic =====================
 
@@ -108,14 +103,15 @@ export const getApiPromise = (
     }
 
     // 3. Otherwise, initiate a new API call with timeout.
-    const endpoint = 'https://api.thumbmarkjs.com/thumbmark';
+    const endpoint = `${API_ENDPOINT}/thumbmark`;
     const fetchPromise = fetch(endpoint, {
         method: 'POST',
         headers: {
             'x-api-key': options.api_key!,
             'Authorization': 'custom-authorized',
+            'Content-Type': 'application/json',
         },
-        body: JSON.stringify({ components: components, clientHash: hash(JSON.stringify(components)) }),
+        body: JSON.stringify({ components, options, clientHash: hash(JSON.stringify(components)) }),
     })
         .then(response => {
             // Handle HTTP errors that aren't network errors
@@ -143,7 +139,7 @@ export const getApiPromise = (
             resolve({
                 thumbmark: hash(JSON.stringify(components)),
                 info: { timed_out: true },
-                version: packageJson.version,
+                version: getVersion(),
             });
         }, timeoutMs);
     });
@@ -171,24 +167,16 @@ export async function getThumbmark(options?: optionsInterface): Promise<thumbmar
 
     // Only add 'elapsed' if performance is true
     const maybeElapsed = _options.performance ? { elapsed } : {};
-
-    if (apiResult) {
-        const info: infoInterface = apiResult.info || {};
-        return {
-            components: clientComponentsResult,
-            info,
-            version: getVersion(),
-            thumbmark: apiResult.thumbmark || 'undefined',
-            ...maybeElapsed,
-        };
-    }
+    const components = {...clientComponentsResult, ...apiResult?.components || {}};
+    const info: infoInterface = apiResult?.info || { uniqueness: { score: 'api only' } };
+    const thumbmark = hash(JSON.stringify(components));
+    const version = getVersion();
+    logThumbmarkData(thumbmark, components, _options).catch(() => { /* do nothing */ });
     return {
-        thumbmark: hash(JSON.stringify(clientComponentsResult)),
-        components: clientComponentsResult,
-        info: {
-            uniqueness: 'api only'
-        },
-        version: getVersion(),
+        thumbmark,
+        components: components,
+        info,
+        version,
         ...maybeElapsed,
     };
 }
@@ -232,31 +220,6 @@ export async function resolveClientComponents(
   return { elapsed, resolvedComponents };
 }
 
-// ===================== Logging (Internal) =====================
 
-/**
- * Logs thumbmark data to remote logging endpoint (only once per session)
- * @internal
- */
-async function logThumbmarkData(thisHash: string, thumbmarkData: componentInterface) {
-    const url = 'https://logging.thumbmarkjs.com/v1/log';
-    const payload = {
-        thumbmark: thisHash,
-        components: thumbmarkData,
-        version: getVersion()
-    };
-    if (!sessionStorage.getItem("_tmjs_l")) {
-        sessionStorage.setItem("_tmjs_l", "1");
-        try {
-            await fetch(url, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify(payload)
-            });
-        } catch { /* do nothing */ }
-    }
-}
 
 export { globalIncludeComponent as includeComponent };

package/src/index.ts

@@ -3,7 +3,8 @@ import {
     getFingerprintData,
     getFingerprintPerformance
  } from './functions/legacy_functions'
-import { getThumbmark, getVersion } from './functions'
+import { getThumbmark } from './functions'
+import { getVersion } from './utils/version';
 import { setOption } from './options'
 import { includeComponent } from './factory'
 import { Thumbmark } from './thumbmark'

package/src/options.ts

@@ -6,16 +6,18 @@ export interface optionsInterface {
     logging?: boolean,
     api_key?: string,
     cache_api_call?: boolean,
-    performance?: boolean, // re-added
+    performance?: boolean,
 }
 
+export const API_ENDPOINT = 'https://api.thumbmarkjs.com';
+
 export const defaultOptions: optionsInterface = {
     exclude: [],
     include: [],
     logging: true,
     timeout: 5000,
     cache_api_call: true,
-    performance: false // re-added
+    performance: false
     };
 
 export let options = {...defaultOptions};

package/src/thumbmark.ts

@@ -1,5 +1,6 @@
 import { optionsInterface } from "./options";
-import { getThumbmark, getVersion, includeComponent as globalIncludeComponent } from './functions';
+import { getThumbmark, includeComponent as globalIncludeComponent } from './functions';
+import { getVersion } from "./utils/version";
 import { defaultOptions } from "./options";
 import { componentInterface } from "./factory";
 

package/src/utils/log.ts

@@ -0,0 +1,34 @@
+import { componentInterface } from '../factory';
+import { optionsInterface } from '../options';
+import { getVersion } from './version';
+import { API_ENDPOINT } from '../options';
+
+// ===================== Logging (Internal) =====================
+
+/**
+ * Logs thumbmark data to remote logging endpoint (only once per session)
+ * You can disable this by setting options.logging to false.
+ * @internal
+ */
+export async function logThumbmarkData(thisHash: string, thumbmarkData: componentInterface, options: optionsInterface): Promise<void> {
+    const url = `${API_ENDPOINT}/log`;
+    const payload = {
+        thumbmark: thisHash,
+        components: thumbmarkData,
+        version: getVersion(),
+        options,
+        path: window?.location?.pathname,
+    };
+    if (!sessionStorage.getItem("_tmjs_l") && Math.random() < 0.0001) { // Only log once per session and very rarely
+        sessionStorage.setItem("_tmjs_l", "1");
+        try {
+            await fetch(url, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(payload)
+            });
+        } catch { /* do nothing */ }
+    }
+}

package/src/utils/version.ts

@@ -0,0 +1,8 @@
+import * as packageJson from '../../package.json';
+
+/**
+ * Returns the current package version
+ */
+export function getVersion(): string {
+    return packageJson.version;
+}