feat: expose detectors and separate detect and collect functions

src/api.ts

@@ -10,11 +10,11 @@ import {
   State,
 } from './types'
 
-export function detect<T extends AbstractDetectorDict>(
-  components: ComponentDict<any>,
-  detectors: T,
-): [DetectionDict<T>, BotDetectionResult] {
-  const detections = {} as DetectionDict<T>
+export function detect<T extends ComponentDict, K extends AbstractDetectorDict<T>>(
+  components: T,
+  detectors: K,
+): [DetectionDict<K>, BotDetectionResult] {
+  const detections = {} as DetectionDict<K>
   let finalDetection: BotDetectionResult = {
     bot: false,
   }

src/detector.ts

@@ -1,6 +1,7 @@
 import { BotDetectionResult, BotDetectorInterface, ComponentDict, DetectionDict } from './types'
 import { collect, detect } from './api'
-import { detectors, sources } from '.'
+import { detectors } from './detectors'
+import { sources } from './sources'
 
 /**
  * Class representing a bot detector.

src/detectors/eval_length.ts

@@ -3,13 +3,20 @@ import { BrowserEngineKind, BrowserKind, ComponentDict, DetectorResponse, State
 
 export function detectEvalLengthInconsistency({
   evalLength,
-  browser: { browserKind: browser, BrowserEngineKind: browserEngine },
+  browserKind,
+  browserEngineKind,
 }: ComponentDict): DetectorResponse {
-  if (evalLength.state !== State.Success) return
+  if (
+    evalLength.state !== State.Success ||
+    browserKind.state !== State.Success ||
+    browserEngineKind.state !== State.Success
+  )
+    return
+
   const length = evalLength.value
   return (
-    (length === 37 && !arrayIncludes([BrowserEngineKind.Webkit, BrowserEngineKind.Gecko], browserEngine)) ||
-    (length === 39 && !arrayIncludes([BrowserKind.IE], browser)) ||
-    (length === 33 && !arrayIncludes([BrowserEngineKind.Chromium], browserEngine))
+    (length === 37 && !arrayIncludes([BrowserEngineKind.Webkit, BrowserEngineKind.Gecko], browserEngineKind.value)) ||
+    (length === 39 && !arrayIncludes([BrowserKind.IE], browserKind.value)) ||
+    (length === 33 && !arrayIncludes([BrowserEngineKind.Chromium], browserEngineKind.value))
   )
 }

src/detectors/notification_permissions.ts

@@ -2,9 +2,9 @@ import { BotKind, BrowserKind, ComponentDict, DetectorResponse, State } from '..
 
 export function detectNotificationPermissions({
   notificationPermissions,
-  browser: { browserKind },
+  browserKind,
 }: ComponentDict): DetectorResponse {
-  if (browserKind !== BrowserKind.Chrome) return false
+  if (browserKind.state !== State.Success || browserKind.value !== BrowserKind.Chrome) return false
 
   if (notificationPermissions.state === State.Success && notificationPermissions.value) {
     return BotKind.HeadlessChrome

src/detectors/plugins_inconsistency.ts

@@ -1,10 +1,23 @@
-import { BotKind, BrowserKind, ComponentDict, DetectorResponse, State } from '../types'
+import { BotKind, BrowserEngineKind, BrowserKind, ComponentDict, DetectorResponse, State } from '../types'
 
 export function detectPluginsLengthInconsistency({
   pluginsLength,
-  browser: { browserKind, isAndroid },
+  android,
+  browserKind,
+  browserEngineKind,
 }: ComponentDict): DetectorResponse {
-  if (pluginsLength.state !== State.Success) return
-  if (browserKind !== BrowserKind.Chrome || isAndroid) return
+  if (
+    pluginsLength.state !== State.Success ||
+    android.state !== State.Success ||
+    browserKind.state !== State.Success ||
+    browserEngineKind.state !== State.Success
+  )
+    return
+  if (
+    browserKind.value !== BrowserKind.Chrome ||
+    android.value ||
+    browserEngineKind.value !== BrowserEngineKind.Chromium
+  )
+    return
   if (pluginsLength.value === 0) return BotKind.HeadlessChrome
 }

src/detectors/product_sub.ts

@@ -1,12 +1,12 @@
 import { BotKind, BrowserKind, ComponentDict, DetectorResponse, State } from '../types'
 
-export function detectProductSub({ productSub, browser: { browserKind } }: ComponentDict): DetectorResponse {
-  if (productSub.state !== State.Success) return false
+export function detectProductSub({ productSub, browserKind }: ComponentDict): DetectorResponse {
+  if (productSub.state !== State.Success || browserKind.state !== State.Success) return false
   if (
-    (browserKind === BrowserKind.Chrome ||
-      browserKind === BrowserKind.Safari ||
-      browserKind === BrowserKind.Opera ||
-      browserKind === BrowserKind.WeChat) &&
+    (browserKind.value === BrowserKind.Chrome ||
+      browserKind.value === BrowserKind.Safari ||
+      browserKind.value === BrowserKind.Opera ||
+      browserKind.value === BrowserKind.WeChat) &&
     productSub.value !== '20030107'
   )
     return BotKind.Unknown

src/detectors/rtt.ts

@@ -1,8 +1,8 @@
 import { BotKind, ComponentDict, DetectorResponse, State } from '../types'
 
-export function detectRTT({ rtt, browser: { isAndroid } }: ComponentDict): DetectorResponse {
-  if (rtt.state !== State.Success) return
+export function detectRTT({ rtt, android }: ComponentDict): DetectorResponse {
+  if (rtt.state !== State.Success || android.state !== State.Success) return
   // Rtt is 0 on android webview
-  if (isAndroid) return
+  if (android.value) return
   if (rtt.value === 0) return BotKind.HeadlessChrome
 }

src/detectors/window_size.ts

@@ -1,9 +1,9 @@
 import { BotKind, ComponentDict, DetectorResponse, State } from '../types'
 
-export function detectWindowSize({ windowSize, browser: { documentFocus } }: ComponentDict): DetectorResponse {
-  if (windowSize.state !== State.Success) return false
+export function detectWindowSize({ windowSize, documentFocus }: ComponentDict): DetectorResponse {
+  if (windowSize.state !== State.Success || documentFocus.state !== State.Success) return false
   const { outerWidth, outerHeight } = windowSize.value
   // When a page is opened in a new tab without focusing it right away, the window outer size is 0x0
-  if (!documentFocus) return
+  if (!documentFocus.value) return
   if (outerWidth === 0 && outerHeight === 0) return BotKind.HeadlessChrome
 }

src/sources/android.ts

@@ -0,0 +1,5 @@
+import { isAndroid } from '../utils/browser'
+
+export default function collectIsAndroid(): boolean {
+  return isAndroid()
+}

src/sources/browser_engine_kind.ts

@@ -0,0 +1,6 @@
+import { BrowserEngineKind } from '../types'
+import { getBrowserEngineKind } from '../utils/browser'
+
+export default function collectBrowserEngineKind(): BrowserEngineKind {
+  return getBrowserEngineKind()
+}

src/sources/browser_kind.ts

@@ -0,0 +1,6 @@
+import { BrowserKind } from '../types'
+import { getBrowserKind } from '../utils/browser'
+
+export default function collectBrowserKind(): BrowserKind {
+  return getBrowserKind()
+}

src/sources/document_focus.ts

@@ -0,0 +1,5 @@
+import { getDocumentFocus } from '../utils/browser'
+
+export default function hasDocumentFocus(): boolean {
+  return getDocumentFocus()
+}

src/sources/index.ts

@@ -1,6 +1,9 @@
+import collectIsAndroid from './android'
 import getAppVersion from './app_version'
-import getBrowserInformation from './browser'
+import collectBrowserKind from './browser_kind'
+import collectBrowserEngineKind from './browser_engine_kind'
 import getDocumentElementKeys from './document_element_keys'
+import hasDocumentFocus from './document_focus'
 import getErrorTrace from './error_trace'
 import getEvalLength from './eval_length'
 import getFunctionBind from './function_bind'
@@ -20,9 +23,12 @@ import getWindowSize, { WindowSizePayload } from './window_size'
 import checkDistinctiveProperties, { DistinctivePropertiesPayload } from './distinctive_properties'
 
 export const sources = {
+  android: collectIsAndroid,
+  browserKind: collectBrowserKind,
+  browserEngineKind: collectBrowserEngineKind,
+  documentFocus: hasDocumentFocus,
   userAgent: getUserAgent,
   appVersion: getAppVersion,
-  browser: getBrowserInformation,
   rtt: getRTT,
   windowSize: getWindowSize,
   pluginsLength: getPluginsLength,

src/types.ts

@@ -87,11 +87,11 @@ export type DefaultDetectorDict = typeof detectors
  */
 export type SourceResponse<T> = T extends (...args: any[]) => any ? Awaited<ReturnType<T>> : T
 
-export type AbstractDetector = (...args: any[]) => DetectorResponse
+export type AbstractDetector<T> = (components: T) => DetectorResponse
 
 export type AbstractSourceDict = Record<string, SourceResponse<any>>
 
-export type AbstractDetectorDict = Record<string, AbstractDetector>
+export type AbstractDetectorDict<T> = Record<string, AbstractDetector<T>>
 
 export type AbstractComponentDict = Record<string, Component<any>>
 
@@ -100,7 +100,10 @@ export type AbstractDetectionsDict = Record<string, BotDetectionResult>
 /**
  * Represents a dictionary of detectors detection.
  */
-export type DetectionDict<T extends AbstractDetectorDict = DefaultDetectorDict> = Record<keyof T, BotDetectionResult>
+export type DetectionDict<T extends AbstractDetectorDict<any> = DefaultDetectorDict> = Record<
+  keyof T,
+  BotDetectionResult
+>
 
 /**
  * Dictionary of components.