@thumbmarkjs/thumbmarkjs 0.14.1 → 0.14.2

package/README.md

@@ -6,7 +6,7 @@ ThumbmarkJS is the world's second best browser fingerprinting JavaScript library
 
 ThumbmarkJS is open source (MIT).
 
-🙏 Please don't do evil. ThumbmarkJS is meant to be used for good. We use this at work to prevent scammers and spammers.
+🙏 Please don't do evil. ThumbmarkJS is meant to be used for good. Use this to prevent scammers and spammers for example. If you see this library being used for evil, contact me.
 
 ## Demo page
 
@@ -26,7 +26,7 @@ Supported module formats:
 ### And on the web page:
 
 ```javascript
-<script src="https://cdn.jsdelivr.net/npm/@thumbmarkjs/thumbmarkjs/dist/thumbmark.iife.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@thumbmarkjs/thumbmarkjs/dist/thumbmark.umd.js"></script>
 <script>
 ThumbmarkJS.getFingerprint().then(
     function(fp) {
@@ -38,7 +38,7 @@ ThumbmarkJS.getFingerprint().then(
 <!-- or -->
 
 <script>
-import('https://cdn.jsdelivr.net/npm/@thumbmarkjs/thumbmarkjs/dist/thumbmark.iife.js')
+import('https://cdn.jsdelivr.net/npm/@thumbmarkjs/thumbmarkjs/dist/thumbmark.umd.js')
 .then(() => {
     ThumbmarkJS.getFingerprint().then((fp) => { console.log(fp)})
 })
@@ -50,6 +50,19 @@ You can also call `ThumbmarkJS.getFingerprintData()` to get a full JSON object w
 You can also get any previous version from the CDN by replacing `latest` with the version number. Currently the URL would be
 `https://cdn.thumbmarkjs.com/0.13.0/Thumbmark.js`
 
+## Options
+
+You can use the `setOption` method to change the behavior of the library. Currently it takes only one option.
+
+|  option |     type |                             example | what it does |
+| - | - | - | - |
+| exclude | string[] | ['webgl', 'system.browser.version'] | removes components from the fingerprint hash. An excluded top-level component improves performance. |
+
+example usage:
+
+```
+ThumbmarkJS.setOption('exclude', ['webgl', 'system.browser.version])
+```
 
 ## Install with NPM
 

package/dist/thumbmark.esm.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file is used to create the includeComponent function as well as the interfaces each of the
+ * fingerprint components must implement.
+ *
+ */
+interface componentInterface {
+    [key: string]: string | string[] | number | boolean | componentInterface;
+}
+
+declare function getFingerprintData(): Promise<componentInterface>;
+declare function getFingerprint(): Promise<string>;
+declare function getFingerprintPerformance(): Promise<{
+    [key: string]: any;
+}>;
+
+interface optionsInterface {
+    exclude?: string[];
+    include?: string[];
+    webgl_runs?: number;
+    canvas_runs?: number;
+}
+declare function setOption<K extends keyof optionsInterface>(key: K, value: optionsInterface[K]): void;
+
+declare function getVersion(): string;
+
+export { getFingerprint, getFingerprintData, getFingerprintPerformance, getVersion, setOption };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@thumbmarkjs/thumbmarkjs",
-  "version": "0.14.1",
+  "version": "0.14.2",
   "description": "",
-  "main": "dist/thumbmark.cjs.js",
-  "module": "dist/thumbmark.esm.js",
-  "types": "dist/types/index.d.ts",
+  "main": "./dist/thumbmark.cjs.js",
+  "module": "./dist/thumbmark.esm.js",
+  "types": "./dist/types/thumbmark.esm.d.ts",
   "exports": {
     ".": {
       "import": "./dist/thumbmark.esm.js",
@@ -17,7 +17,7 @@
   ],
   "scripts": {
     "test": "jest",
-    "build": "rm -rf dist/* && rollup -c"
+    "build": "rm -rf dist/* && rm -rf types/* && rollup -c"
   },
   "keywords": [
     "fingerprint",
@@ -33,12 +33,12 @@
   "license": "MIT",
   "unpkg": "dist/thumbmark.umd.js",
   "devDependencies": {
-    "@testing-library/jest-dom": "^6.1.6",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
+    "@testing-library/jest-dom": "^6.1.6",
     "@types/jest": "^29.5.11",
     "@types/jsdom": "^21.1.6",
     "@types/node": "^20.10.6",

package/dist/types/components/audio/audio.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/canvas/canvas.d.ts

@@ -1,2 +0,0 @@
-import { componentInterface } from '../../factory';
-export default function generateCanvasFingerprint(): Promise<componentInterface>;

package/dist/types/components/fonts/fonts.d.ts

@@ -1,2 +0,0 @@
-import { componentInterface } from '../../factory';
-export default function getFontMetrics(): Promise<componentInterface>;

package/dist/types/components/hardware/hardware.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/index.d.ts

@@ -1,16 +0,0 @@
-/**
- * Does anyone have a cleaner way of doing this?
- * I want to import all the components in this folder
- * Feels a little dumb I'm doing this manually.
- */
-import './audio/audio';
-import './canvas/canvas';
-import './fonts/fonts';
-import './hardware/hardware';
-import './locales/locales';
-import './permissions/permissions';
-import './plugins/plugins';
-import './screen/screen';
-import './system/system';
-import './webgl/webgl';
-import './math/math';

package/dist/types/components/locales/locales.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/math/math.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/permissions/permissions.d.ts

@@ -1,2 +0,0 @@
-import { componentInterface } from '../../factory';
-export default function getBrowserPermissions(): Promise<componentInterface>;

package/dist/types/components/plugins/plugins.d.ts

@@ -1,2 +0,0 @@
-import { componentInterface } from '../../factory';
-export default function getInstalledPlugins(): Promise<componentInterface>;

package/dist/types/components/screen/screen.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/system/browser.d.ts

@@ -1,6 +0,0 @@
-interface BrowserResult {
-    name: string;
-    version: string;
-}
-export declare function getBrowser(): BrowserResult;
-export {};

package/dist/types/components/system/system.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/webgl/webgl.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/factory.d.ts

@@ -1,30 +0,0 @@
-/**
- * This file is used to create the includeComponent function as well as the interfaces each of the
- * fingerprint components must implement.
- *
- */
-export interface componentInterface {
-    [key: string]: string | string[] | number | boolean | componentInterface;
-}
-export interface componentFunctionInterface {
-    (): Promise<componentInterface>;
-}
-export declare const components: {
-    [name: string]: componentFunctionInterface;
-};
-export declare const timeoutInstance: componentInterface;
-/**
- * includeComponent is the function each component function needs to call in order for the component to be included
- * in the fingerprint.
- * @param {string} name - the name identifier of the component
- * @param {componentFunctionInterface} creationFunction - the function that implements the component
- * @returns
- */
-export declare const includeComponent: (name: string, creationFunction: componentFunctionInterface) => void;
-/**
- * The function turns the map of component functions to a map of Promises when called
- * @returns {[name: string]: <Promise>componentInterface}
- */
-export declare const getComponentPromises: () => {
-    [k: string]: Promise<componentInterface>;
-};

package/dist/types/fingerprint/functions.d.ts

@@ -1,6 +0,0 @@
-import { componentInterface } from '../factory';
-export declare function getFingerprintData(): Promise<componentInterface>;
-export declare function getFingerprint(): Promise<string>;
-export declare function getFingerprintPerformance(): Promise<{
-    [key: string]: any;
-}>;

package/dist/types/fingerprint/options.d.ts

@@ -1,8 +0,0 @@
-export interface optionsInterface {
-    exclude?: string[];
-    include?: string[];
-    webgl_runs?: number;
-    canvas_runs?: number;
-}
-export declare let options: optionsInterface;
-export declare function setOption<K extends keyof optionsInterface>(key: K, value: optionsInterface[K]): void;

package/dist/types/index.d.ts

@@ -1,5 +0,0 @@
-import { getFingerprint, getFingerprintData, getFingerprintPerformance } from './fingerprint/functions';
-import { setOption } from './fingerprint/options';
-import './components';
-declare function getVersion(): string;
-export { setOption, getVersion, getFingerprint, getFingerprintData, getFingerprintPerformance };

package/dist/types/utils/commonPixels.d.ts

@@ -1 +0,0 @@
-export declare function getCommonPixels(images: ImageData[], width: number, height: number): ImageData;

package/dist/types/utils/ephemeralIFrame.d.ts

@@ -1,4 +0,0 @@
-export declare function ephemeralIFrame(callback: ({ iframe }: {
-    iframe: Document;
-}) => void): Promise<any>;
-export declare function wait<T = void>(durationMs: number, resolveWith?: T): Promise<T>;

package/dist/types/utils/getMostFrequent.d.ts

@@ -1,5 +0,0 @@
-export declare function mostFrequentValuesInArrayOfDictionaries(arr: {
-    [key: string]: any;
-}[], keys: string[]): {
-    [key: string]: any;
-};

package/dist/types/utils/hash.d.ts

@@ -1 +0,0 @@
-export declare function hash(key: string, seed?: number): string;

package/dist/types/utils/imageDataToDataURL.d.ts

@@ -1 +0,0 @@
-export declare function imageDataToDataURL(imageData: ImageData): string;

package/dist/types/utils/raceAll.d.ts

@@ -1,9 +0,0 @@
-type DelayedPromise<T> = Promise<T>;
-export declare function delay<T>(t: number, val: T): DelayedPromise<T>;
-export interface RaceResult<T> {
-    value: T;
-    elapsed?: number;
-}
-export declare function raceAllPerformance<T>(promises: Promise<T>[], timeoutTime: number, timeoutVal: T): Promise<RaceResult<T>[]>;
-export declare function raceAll<T>(promises: Promise<T>[], timeoutTime: number, timeoutVal: T): Promise<(T | undefined)[]>;
-export {};