@thumbmarkjs/thumbmarkjs 1.6.0 → 1.7.0-rc.0

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

@@ -1,27 +0,0 @@
-/**
- * This file is here to support legacy implementations.
- * Eventually, these functions will be removed to keep the library small.
- */
-import { componentInterface } from '../factory';
-/**
- *
- * @deprecated
- */
-export declare function getFingerprintData(): Promise<componentInterface>;
-/**
- *
- * @param includeData boolean
- * @deprecated this function is going to be removed. use getThumbmark or Thumbmark class instead.
- */
-export declare function getFingerprint(includeData?: false): Promise<string>;
-export declare function getFingerprint(includeData: true): Promise<{
-    hash: string;
-    data: componentInterface;
-}>;
-/**
- *
- * @deprecated use Thumbmark or getThumbmark instead with options
- */
-export declare function getFingerprintPerformance(): Promise<{
-    elapsed: Record<string, number>;
-}>;

package/dist/types/index.d.ts

@@ -1,9 +0,0 @@
-import { getFingerprint, getFingerprintData, getFingerprintPerformance } from './functions/legacy_functions';
-import { getThumbmark } from './functions';
-import { getVersion } from './utils/version';
-import { setOption, optionsInterface, stabilizationExclusionRules } from './options';
-import { includeComponent } from './factory';
-import { Thumbmark } from './thumbmark';
-import { filterThumbmarkData } from './functions/filterComponents';
-import { stableStringify } from './utils/stableStringify';
-export { Thumbmark, getThumbmark, getVersion, filterThumbmarkData, optionsInterface, stabilizationExclusionRules, stableStringify, setOption, getFingerprint, getFingerprintData, getFingerprintPerformance, includeComponent };

package/dist/types/options.d.ts

@@ -1,59 +0,0 @@
-export interface OptionsAfterDefaults {
-    /**
-     * A function to customise localStorage names used by thumbmark
-     * @param name Original name of the storage property eg. visitor_id
-     * @returns The name under which the storage property should be saved eg. myprefix_visitor_id
-     */
-    property_name_factory: (name: string) => string;
-    /**
-     * @deprecated use property_name_factory
-     */
-    storage_property_name?: string;
-    exclude?: string[];
-    include?: string[];
-    permissions_to_check?: PermissionName[];
-    timeout?: number;
-    logging?: boolean;
-    api_key?: string;
-    api_endpoint?: string;
-    /**
-     * @deprecated This will be removed in Thumbmarkjs 2.0, use cache_lifetime_in_ms instead
-     */
-    cache_api_call?: boolean;
-    /**
-     * How long the cache will be valid for, maximum is 72h (259_200_000)
-     */
-    cache_lifetime_in_ms: number;
-    performance?: boolean;
-    stabilize?: string[];
-    experimental?: boolean;
-}
-export type optionsInterface = Partial<OptionsAfterDefaults>;
-export declare const DEFAULT_CACHE_LIFETIME = 0;
-export declare const MAXIMUM_CACHE_LIFETIME = 259200000;
-export declare const DEFAULT_STORAGE_PREFIX = "thumbmark";
-export declare const DEFAULT_API_ENDPOINT = "https://api.thumbmarkjs.com";
-export declare const defaultOptions: OptionsAfterDefaults;
-export declare let options: OptionsAfterDefaults;
-/**
- *
- * @param key @deprecated this function will be removed
- * @param value
- */
-export declare function setOption<K extends keyof optionsInterface>(key: K, value: OptionsAfterDefaults[K]): void;
-export declare const stabilizationExclusionRules: {
-    private: {
-        exclude: string[];
-        browsers: string[];
-    }[];
-    iframe: ({
-        exclude: string[];
-        browsers: string[];
-    } | {
-        exclude: string[];
-        browsers?: undefined;
-    })[];
-    vpn: {
-        exclude: string[];
-    }[];
-};

package/dist/types/thumbmark.d.ts

@@ -1,26 +0,0 @@
-import { optionsInterface } from "./options";
-import { componentInterface } from "./factory";
-/**
- * A client for generating thumbmarks with a persistent configuration.
- */
-export declare class Thumbmark {
-    private options;
-    /**
-     * Creates a new Thumbmarker client instance.
-     * @param options - Default configuration options for this instance.
-     */
-    constructor(options?: optionsInterface);
-    /**
-     * Generates a thumbmark using the instance's configuration.
-     * @param overrideOptions - Options to override for this specific call.
-     * @returns The thumbmark result.
-     */
-    get(overrideOptions?: optionsInterface): Promise<any>;
-    getVersion(): string;
-    /**
-     * Register a custom component to be included in the fingerprint.
-     * @param key - The component name
-     * @param fn - The component function
-     */
-    includeComponent(key: string, fn: (options?: optionsInterface) => Promise<componentInterface | null>): void;
-}

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

@@ -1,23 +0,0 @@
-import { apiResponse } from "../functions/api";
-import { OptionsAfterDefaults } from "../options";
-export declare const CACHE_KEY = "cache";
-export interface Cache {
-    apiResponse?: apiResponse;
-    apiResponseExpiry?: number;
-}
-/**
- * Get all values from cache
- * @param _options
- */
-export declare function getCache(_options: Pick<OptionsAfterDefaults, 'property_name_factory'>): Cache;
-/**
- * Write given values to cache
- * @param _options
- * @param values
- */
-export declare function setCache(_options: OptionsAfterDefaults, values: Partial<Cache>): void;
-/**
- * Returns the expiry time for cache
- * @param _options
- */
-export declare function getApiResponseExpiry(_options: Pick<OptionsAfterDefaults, 'cache_lifetime_in_ms'>): number;

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,5 +0,0 @@
-/**
- * This code is taken from https://github.com/LinusU/murmur-128/blob/master/index.js
- * But instead of dependencies to encode-utf8 and fmix, I've implemented them here.
- */
-export declare function hash(key: ArrayBuffer | 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/log.d.ts

@@ -1,8 +0,0 @@
-import { componentInterface } from '../factory';
-import { optionsInterface } from '../options';
-/**
- * Logs thumbmark data to remote logging endpoint (only once per session)
- * You can disable this by setting options.logging to false.
- * @internal
- */
-export declare function logThumbmarkData(thisHash: string, thumbmarkData: componentInterface, options: optionsInterface, experimentalData?: componentInterface): Promise<void>;

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 {};

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

@@ -1,8 +0,0 @@
-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 declare function sortComponentKeys(obj: componentInterface): componentInterface;

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

@@ -1,22 +0,0 @@
-/**
- * Stable JSON stringify implementation
- * Based on fast-json-stable-stringify by Evgeny Poberezkin
- * https://github.com/epoberezkin/fast-json-stable-stringify
- *
- * This implementation ensures consistent JSON serialization by sorting object keys,
- * which is critical for generating stable hashes from fingerprint data.
- */
-/**
- * Converts data to a stable JSON string with sorted keys
- *
- * @param data - The data to stringify
- * @returns Stable JSON string representation
- * @throws TypeError if circular reference is detected
- *
- * @example
- * ```typescript
- * const obj = { b: 2, a: 1 };
- * stableStringify(obj); // '{"a":1,"b":2}'
- * ```
- */
-export declare function stableStringify(data: any): string;

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

@@ -1,4 +0,0 @@
-/**
- * Returns the current package version
- */
-export declare function getVersion(): string;

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

@@ -1,14 +0,0 @@
-import { OptionsAfterDefaults } from "../options";
-/**
- * Get the storage property name for visitor id
- * @param _options
- */
-export declare function getVisitorIdPropertyName(_options: Pick<OptionsAfterDefaults, 'storage_property_name' | 'property_name_factory'>): string;
-/**
- * Gets visitor ID from localStorage, returns null if unavailable
- */
-export declare function getVisitorId(_options: OptionsAfterDefaults): string | null;
-/**
- * Sets visitor ID in localStorage
- */
-export declare function setVisitorId(visitorId: string, _options: OptionsAfterDefaults): void;