@ianmenethil/zp-devicefp 0.1.0-alpha.0

package/dist/npm/index.d.ts

@@ -0,0 +1,101 @@
+export type SignalName =
+	| 'ua'
+	| 'uaHints'
+	| 'locale'
+	| 'screen'
+	| 'hardware'
+	| 'storage'
+	| 'fonts'
+	| 'canvas'
+	| 'webgl'
+	| 'audio'
+	| 'mediaDevices'
+	| 'permissions'
+	| 'webrtc'
+	| 'frameInfo'
+	| 'networkInfo'
+	| 'paymentSupport'
+	| 'referrerInfo'
+	| 'navigationInfo'
+	| 'riskSignals';
+
+export type SignalStatus = 'ok' | 'unsupported' | 'blocked' | 'timeout' | 'error';
+
+export interface SignalResult<T = unknown> {
+	status: SignalStatus;
+	value?: T;
+	durationMs: number;
+	error?: string;
+}
+
+export interface AntiSpoofReport {
+	score: number;
+	anomalies: string[];
+	automationHints: string[];
+}
+
+export interface FingerprintResult {
+	schemaVersion: number;
+	libraryVersion: string;
+	thumbprint: string;
+	confidence: number;
+	componentHashes: Partial<Record<SignalName, string>>;
+	signals: Partial<Record<SignalName, SignalResult>>;
+	antiSpoof: AntiSpoofReport;
+	warnings: string[];
+	diagnostics: CollectorDiagnostics;
+}
+
+export interface CollectOptions {
+	include?: SignalName[];
+	exclude?: SignalName[];
+	timeoutMs?: number;
+	abortSignal?: AbortSignal;
+	extended?: boolean;
+	debug?: boolean;
+}
+
+export interface CollectorDiagnostics {
+	requestedSignals: SignalName[];
+	completedSignals: SignalName[];
+	elapsedMs: number;
+}
+
+export interface UploadOptions {
+	endpoint: string;
+	headers?: Record<string, string>;
+	bodyExtras?: Record<string, unknown>;
+}
+
+export interface ProgressEvent {
+	completed: number;
+	total: number;
+	signal: SignalName;
+	result: SignalResult;
+}
+
+export interface WarningEvent {
+	signal?: SignalName;
+	message: string;
+}
+
+export interface CompleteEvent {
+	result: FingerprintResult;
+}
+
+export interface EventPayloadMap {
+	progress: ProgressEvent;
+	warning: WarningEvent;
+	complete: CompleteEvent;
+}
+
+export interface FingerprintClient {
+	collect(options?: CollectOptions): Promise<FingerprintResult>;
+	collectSync(options?: Omit<CollectOptions, 'timeoutMs' | 'abortSignal'>): FingerprintResult;
+	upload(result: FingerprintResult, options: UploadOptions): Promise<Response>;
+	on<K extends keyof EventPayloadMap>(event: K, cb: (payload: EventPayloadMap[K]) => void): () => void;
+}
+
+export declare const LIBRARY_VERSION: string;
+export declare const SCHEMA_VERSION: number;
+export declare function createFingerprintClient(options?: CollectOptions): Promise<FingerprintClient>;