[bot-detection] Add new method: isAIAssistant() to check whether user-agent is an AI assistant

src/bot-detection/bot-detection.d.ts

@@ -2,5 +2,6 @@
 // Project: https://github.com/faisalman/ua-parser-js
 // Definitions by: Faisal Salman <https://github.com/faisalman>
 
+export function isAIAssistant(ua: string): boolean;
 export function isAICrawler(ua: string): boolean;
 export function isBot(ua: string): boolean;

src/bot-detection/bot-detection.js

@@ -8,118 +8,178 @@
 /*jshint esversion: 6 */ 
 
 const { UAParser } = require('../main/ua-parser');
-const { Extension, BrowserType } = require('../enums/ua-parser-enums');
+const { Bots, Crawlers, Fetchers } = require('../extensions/ua-parser-extensions');
-const { Bots, Crawlers } = require('../extensions/ua-parser-extensions');
+const { BrowserType, Extension } = require('../enums/ua-parser-enums');
-const { Crawler } = Extension.BrowserName;
+const { Crawler, Fetcher } = Extension.BrowserName;
 
-const BotTypesList = [
+class BotList {
+    constructor(ext, prop, list) {
+        this.ext = ext;
+        this.prop = prop;
+        this.list = list.map(x => x.toLowerCase());
+    }
+    includes(ua) {
+        return this.list.includes(
+            (typeof ua === 'string' ? 
+                new UAParser(ua, this.ext).getBrowser() : 
+                ua.browser
+            )[this.prop]?.toLowerCase());
+    }
+}
+
+const BotTypes = new BotList(Bots, 'type', [
     BrowserType.CLI, 
     BrowserType.CRAWLER, 
     BrowserType.FETCHER, 
     BrowserType.LIBRARY
-];
+]);
+
+const AIAssistants = new BotList(Fetchers, 'name', [
+
+    // Anthropic
+    Fetcher.ANTHROPIC_CLAUDE_USER,
+
+    // Cohere
+    Fetcher.COHERE_AI,
+
+    // DuckDuckGo
+    Fetcher.DUCKDUCKGO_ASSISTBOT,
+
+    // Google
+    Fetcher.GOOGLE_GEMINI_DEEP_RESEARCH,
+
+    // Mistral AI
+    Fetcher.MISTRALAI_USER,
+
+    // OpenAI
+    Fetcher.OPENAI_CHATGPT_USER,
+
+    // Perplexity
+    Fetcher.PERPLEXITY_USER
+]);
+
+const AICrawlers = new BotList(Crawlers, 'name', [
 
-const AICrawlersList = [
     // AI2
     Crawler.AI2_BOT,
+
     // Amazon
     Crawler.AMAZON_BOT,
+
     // Anthropic
     Crawler.ANTHROPIC_AI,
     Crawler.ANTHROPIC_CLAUDE_BOT,
     Crawler.ANTHROPIC_CLAUDE_SEARCHBOT,
     Crawler.ANTHROPIC_CLAUDE_WEB,
+
     // Apple
     Crawler.APPLE_BOT,
     Crawler.APPLE_BOT_EXTENDED,
+
     // Brave
     Crawler.BRAVE_BOT,
+
     // ByteDance
     Crawler.BYTEDANCE_BYTESPIDER,
     Crawler.BYTEDANCE_TIKTOKSPIDER,
+
     // Cohere
     Crawler.COHERE_TRAINING_DATA_CRAWLER,
+
     // Common Crawl
     Crawler.COMMON_CRAWL_CCBOT,    
+
     // Coveo
     Crawler.COVEO_BOT,
+
     // DataForSeo
     Crawler.DATAFORSEO_BOT,
+
     // DeepSeek
     Crawler.DEEPSEEK_BOT,
+
     // Diffbot
     Crawler.DIFFBOT,
+
     // Google
     Crawler.GOOGLE_EXTENDED,
     Crawler.GOOGLE_OTHER,
     Crawler.GOOGLE_OTHER_IMAGE,
     Crawler.GOOGLE_OTHER_VIDEO,
     Crawler.GOOGLE_CLOUDVERTEXBOT,
+
     // Hive AI
     Crawler.HIVE_IMAGESIFTBOT,
+
     // Huawei
     Crawler.HUAWEI_PETALBOT,
     Crawler.HUAWEI_PANGUBOT,
+
     // Hugging Face
     Crawler.HUGGINGFACE_BOT,
+
     // Kangaroo
     Crawler.KANGAROO_BOT,
+
     // Mendable.ai
     Crawler.FIRECRAWL_AGENT,
+
     // Meta
     Crawler.META_FACEBOOKBOT,
     Crawler.META_EXTERNALAGENT,
+
     // OpenAI
     Crawler.OPENAI_GPTBOT,
     Crawler.OPENAI_SEARCH_BOT,
+
     // Perplexity
     Crawler.PERPLEXITY_BOT,
+
     // Replicate
     Crawler.REPLICATE_BOT,
+
     // Runpod
     Crawler.RUNPOD_BOT,
+
     // SB Intuitions
     Crawler.SB_INTUITIONS_BOT,
+
     // Semrush
     Crawler.SEMRUSH_BOT_CONTENTSHAKE,
+
     // Timpi
     Crawler.TIMPI_BOT,
+
     // Together AI
     Crawler.TOGETHER_BOT,
+
     // Velen.io
     Crawler.HUNTER_VELENPUBLICWEBCRAWLER,
+
     // Vercel
     Crawler.VERCEL_V0BOT,
+
     // Webz.io
     Crawler.WEBZIO_OMGILI,
     Crawler.WEBZIO_OMGILI_BOT,
     Crawler.WEBZIO_EXTENDED,
+
     // X
     Crawler.XAI_BOT,
+
     // You.com
     Crawler.YOU_BOT,
+
     // Zhipu AI
     Crawler.ZHIPU_CHATGLM_SPIDER
-];
+]);
 
-const isAICrawler = ua => 
+const isBot = ua => BotTypes.includes(ua);
-    AICrawlersList
+const isAIAssistant = ua => AIAssistants.includes(ua);
-        .map(s=>s.toLowerCase())
+const isAICrawler = ua => AICrawlers.includes(ua);
-        .includes(
-            (typeof ua === 'string' ? 
-                new UAParser(ua, Crawlers).getBrowser() : 
-                ua.browser
-            ).name?.toLowerCase());
 
-const isBot = ua => 
+module.exports = {
-    BotTypesList
+    isAIAssistant, 
-        .includes(
-            (typeof ua === 'string' ? 
-                new UAParser(ua, Bots).getBrowser() : 
-                ua.browser
-            ).type);
-
-module.exports = { 
     isAICrawler,
     isBot
 }

src/bot-detection/bot-detection.mjs

@@ -14,116 +14,176 @@
 import { UAParser } from '../main/ua-parser.mjs';
 import { Extension, BrowserType } from '../enums/ua-parser-enums.mjs';
 import { Bots, Crawlers, Fetchers } from '../extensions/ua-parser-extensions.mjs';
-const { Crawler } = Extension.BrowserName;
+const { Crawler, Fetcher } = Extension.BrowserName;
 
-const BotTypesList = [
+class BotList {
+    constructor(ext, prop, list) {
+        this.ext = ext;
+        this.prop = prop;
+        this.list = list.map(x => x.toLowerCase());
+    }
+    includes(ua) {
+        return this.list.includes(
+            (typeof ua === 'string' ? 
+                new UAParser(ua, this.ext).getBrowser() : 
+                ua.browser
+            )[this.prop]?.toLowerCase());
+    }
+}
+
+const BotTypes = new BotList(Bots, 'type', [
     BrowserType.CLI, 
     BrowserType.CRAWLER, 
     BrowserType.FETCHER, 
     BrowserType.LIBRARY
-];
+]);
+
+const AIAssistants = new BotList(Fetchers, 'name', [
+
+    // Anthropic
+    Fetcher.ANTHROPIC_CLAUDE_USER,
+
+    // Cohere
+    Fetcher.COHERE_AI,
+
+    // DuckDuckGo
+    Fetcher.DUCKDUCKGO_ASSISTBOT,
+
+    // Google
+    Fetcher.GOOGLE_GEMINI_DEEP_RESEARCH,
+
+    // Mistral AI
+    Fetcher.MISTRALAI_USER,
+
+    // OpenAI
+    Fetcher.OPENAI_CHATGPT_USER,
+
+    // Perplexity
+    Fetcher.PERPLEXITY_USER
+]);
+
+const AICrawlers = new BotList(Crawlers, 'name', [
 
-const AICrawlersList = [
     // AI2
     Crawler.AI2_BOT,
+
     // Amazon
     Crawler.AMAZON_BOT,
+
     // Anthropic
     Crawler.ANTHROPIC_AI,
     Crawler.ANTHROPIC_CLAUDE_BOT,
     Crawler.ANTHROPIC_CLAUDE_SEARCHBOT,
     Crawler.ANTHROPIC_CLAUDE_WEB,
+
     // Apple
     Crawler.APPLE_BOT,
     Crawler.APPLE_BOT_EXTENDED,
+
     // Brave
     Crawler.BRAVE_BOT,
+
     // ByteDance
     Crawler.BYTEDANCE_BYTESPIDER,
     Crawler.BYTEDANCE_TIKTOKSPIDER,
+
     // Cohere
     Crawler.COHERE_TRAINING_DATA_CRAWLER,
+
     // Common Crawl
     Crawler.COMMON_CRAWL_CCBOT,    
+
     // Coveo
     Crawler.COVEO_BOT,
+
     // DataForSeo
     Crawler.DATAFORSEO_BOT,
+
     // DeepSeek
     Crawler.DEEPSEEK_BOT,
+
     // Diffbot
     Crawler.DIFFBOT,
+
     // Google
     Crawler.GOOGLE_EXTENDED,
     Crawler.GOOGLE_OTHER,
     Crawler.GOOGLE_OTHER_IMAGE,
     Crawler.GOOGLE_OTHER_VIDEO,
     Crawler.GOOGLE_CLOUDVERTEXBOT,
+
     // Hive AI
     Crawler.HIVE_IMAGESIFTBOT,
+
     // Huawei
     Crawler.HUAWEI_PETALBOT,
     Crawler.HUAWEI_PANGUBOT,
+
     // Hugging Face
     Crawler.HUGGINGFACE_BOT,
+
     // Kangaroo
     Crawler.KANGAROO_BOT,
+
     // Mendable.ai
     Crawler.FIRECRAWL_AGENT,
+
     // Meta
     Crawler.META_FACEBOOKBOT,
     Crawler.META_EXTERNALAGENT,
+
     // OpenAI
     Crawler.OPENAI_GPTBOT,
     Crawler.OPENAI_SEARCH_BOT,
+
     // Perplexity
     Crawler.PERPLEXITY_BOT,
+
     // Replicate
     Crawler.REPLICATE_BOT,
+
     // Runpod
     Crawler.RUNPOD_BOT,
+
     // SB Intuitions
     Crawler.SB_INTUITIONS_BOT,
+
     // Semrush
     Crawler.SEMRUSH_BOT_CONTENTSHAKE,
+
     // Timpi
     Crawler.TIMPI_BOT,
+
     // Together AI
     Crawler.TOGETHER_BOT,
+
     // Velen.io
     Crawler.HUNTER_VELENPUBLICWEBCRAWLER,
+
     // Vercel
     Crawler.VERCEL_V0BOT,
+
     // Webz.io
     Crawler.WEBZIO_OMGILI,
     Crawler.WEBZIO_OMGILI_BOT,
     Crawler.WEBZIO_EXTENDED,
+
     // X
     Crawler.XAI_BOT,
+
     // You.com
     Crawler.YOU_BOT,
+
     // Zhipu AI
     Crawler.ZHIPU_CHATGLM_SPIDER
-];
+]);
 
-const isAICrawler = ua => 
+const isBot = ua => BotTypes.includes(ua);
-    AICrawlersList
+const isAIAssistant = ua => AIAssistants.includes(ua);
-        .map(s=>s.toLowerCase())
+const isAICrawler = ua => AICrawlers.includes(ua);
-        .includes(
-            (typeof ua === 'string' ? 
-                new UAParser(ua, Crawlers).getBrowser() : 
-                ua.browser
-            ).name?.toLowerCase());
 
-const isBot = ua => 
+export {
-    BotTypesList
+    isAIAssistant, 
-        .includes(
-            (typeof ua === 'string' ? 
-                new UAParser(ua, Bots).getBrowser() : 
-                ua.browser
-            ).type);
-
-export { 
     isAICrawler,
     isBot
 }