ua-parser-js 2.0.0-rc.3 → 2.0.1

package/src/helpers/ua-parser-helpers.d.ts

@@ -1,13 +1,14 @@
-// Type definitions for Helpers submodule of UAParser.js v2.0.0-rc.3
+// Type definitions for Helpers submodule of UAParser.js v2.0.1
 // Project: https://github.com/faisalman/ua-parser-js
 // Definitions by: Faisal Salman <https://github.com/faisalman>
 
-import { IResult } from "../main/ua-parser";
+import type { IResult } from "../main/ua-parser";
 
 declare function getDeviceVendor(model: string): string | undefined;
-declare function isAppleSilicon(res: IResult, useFeatureDetection?: boolean): boolean;
-declare function isBot(res: IResult): boolean;
-declare function isChromeFamily(res: IResult): boolean;
+declare function isAppleSilicon(resultOrUA: IResult | string): boolean;
+declare function isAIBot(resultOrUA: IResult | string): boolean;
+declare function isBot(resultOrUA: IResult | string): boolean;
+declare function isChromeFamily(resultOrUA: IResult | string): boolean;
 declare function isElectron(): boolean;
 declare function isFromEU(): boolean;
 declare function isFrozenUA(ua: string): boolean;
@@ -16,6 +17,7 @@ declare function isStandalonePWA(): boolean;
 export {
     getDeviceVendor,
     isAppleSilicon,
+    isAIBot,
     isBot,
     isChromeFamily,
     isElectron,

package/src/helpers/ua-parser-helpers.js

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////
-/*  Helpers for UAParser.js v2.0.0-rc.3
+/*  Helpers for UAParser.js v2.0.1
     https://github.com/faisalman/ua-parser-js
     Author: Faisal Salman <f@faisalman.com>
     AGPLv3 License */
@@ -9,18 +9,22 @@
 
 const { UAParser } = require('../main/ua-parser');
 const { CPU, OS, Engine } = require('../enums/ua-parser-enums');
+const { Bots } = require('../extensions/ua-parser-extensions');
 const { isFromEU } = require('detect-europe-js');
 const { isFrozenUA } = require('ua-is-frozen');
 const { isStandalonePWA } = require('is-standalone-pwa');
 
+const toResult = (value, head, ext) => typeof value === 'string' ? UAParser(value, head, ext) : value;
+
 const getDeviceVendor = (model) => UAParser(`Mozilla/5.0 (Linux; Android 10; ${model}) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.0.0 Safari/537.36`).device.vendor;
 
-const isAppleSilicon = (res, useFeatureDetection) => {
+const isAppleSilicon = (resultOrUA) => {
+    const res = toResult(resultOrUA);
     if (res.os.is(OS.MACOS)) {
         if (res.cpu.is(CPU.ARM)) {
             return true;
         }
-        if (useFeatureDetection) {
+        if (typeof resultOrUA !== 'string' && typeof window !== 'undefined') {
             try {
                 const canvas = document.createElement('canvas');
                 const webgl = canvas.getContext('webgl2') || canvas.getContext('webgl') || canvas.getContext('experimental-webgl');
@@ -37,9 +41,85 @@ const isAppleSilicon = (res, useFeatureDetection) => {
     return false;
 }
 
-const isBot = (res) => ['cli', 'crawler', 'fetcher', 'library'].includes(res.browser.type);
+const isAIBot = (resultOrUA) => [
+
+    // AI2
+    'ai2bot',
+
+    // Amazon
+    'amazonbot',
+
+    // Anthropic
+    'anthropic-ai',
+    'claude-web',
+    'claudebot',
+
+    // Apple
+    'applebot',
+    'applebot-extended',
+
+    // ByteDance
+    'bytespider',
+
+    // Common Crawl
+    'ccbot',
+
+    // DataForSeo
+    'dataforseobot',
+
+    // Diffbot
+    'diffbot',
+
+    // Google
+    'googleother',
+    'googleother-image',
+    'googleother-video',
+    'google-extended',
+
+    // Hive AI
+    'imagesiftbot',
+
+    // Huawei
+    'petalbot',
+
+    // Meta
+    'facebookbot',
+    'meta-externalagent',
+
+    // OpenAI
+    'gptbot',
+    'oai-searchbot',
+
+    // Perplexity
+    'perplexitybot',
+
+    // Timpi
+    'timpibot',
+
+    // Velen.io
+    'velenpublicwebcrawler',
+
+    // Webz.io
+    'omgili',
+    'omgilibot',
+    'webzio-extended',
+
+    // You.com
+    'youbot',
+
+    // Zyte
+    'scrapy'
+
+    ].includes(String(toResult(resultOrUA, Bots).browser.name).toLowerCase());
+
+const isBot = (resultOrUA) => [
+    'cli', 
+    'crawler', 
+    'fetcher', 
+    'library'
+    ].includes(toResult(resultOrUA, Bots).browser.type);
 
-const isChromeFamily = (res) => res.engine.is(Engine.BLINK);
+const isChromeFamily = (resultOrUA) => toResult(resultOrUA).engine.is(Engine.BLINK);
 
 const isElectron = () => !!(process?.versions?.hasOwnProperty('electron') ||    // node.js
                             / electron\//i.test(navigator?.userAgent));         // browser
@@ -47,6 +127,7 @@ const isElectron = () => !!(process?.versions?.hasOwnProperty('electron') ||
 module.exports = { 
     getDeviceVendor,
     isAppleSilicon,
+    isAIBot,
     isBot,
     isChromeFamily,
     isElectron,

package/src/helpers/ua-parser-helpers.mjs

@@ -3,7 +3,7 @@
 // Source: /src/helpers/ua-parser-helpers.js
 
 ///////////////////////////////////////////////
-/*  Helpers for UAParser.js v2.0.0-rc.3
+/*  Helpers for UAParser.js v2.0.1
     https://github.com/faisalman/ua-parser-js
     Author: Faisal Salman <f@faisalman.com>
     AGPLv3 License */
@@ -13,18 +13,22 @@
 
 import { UAParser } from '../main/ua-parser.mjs';
 import { CPU, OS, Engine } from '../enums/ua-parser-enums.mjs';
+import { Bots } from '../extensions/ua-parser-extensions.mjs';
 import { isFromEU } from 'detect-europe-js';
 import { isFrozenUA } from 'ua-is-frozen';
 import { isStandalonePWA } from 'is-standalone-pwa';
 
+const toResult = (value, head, ext) => typeof value === 'string' ? UAParser(value, head, ext) : value;
+
 const getDeviceVendor = (model) => UAParser(`Mozilla/5.0 (Linux; Android 10; ${model}) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.0.0 Safari/537.36`).device.vendor;
 
-const isAppleSilicon = (res, useFeatureDetection) => {
+const isAppleSilicon = (resultOrUA) => {
+    const res = toResult(resultOrUA);
     if (res.os.is(OS.MACOS)) {
         if (res.cpu.is(CPU.ARM)) {
             return true;
         }
-        if (useFeatureDetection) {
+        if (typeof resultOrUA !== 'string' && typeof window !== 'undefined') {
             try {
                 const canvas = document.createElement('canvas');
                 const webgl = canvas.getContext('webgl2') || canvas.getContext('webgl') || canvas.getContext('experimental-webgl');
@@ -41,9 +45,85 @@ const isAppleSilicon = (res, useFeatureDetection) => {
     return false;
 }
 
-const isBot = (res) => ['cli', 'crawler', 'fetcher', 'library'].includes(res.browser.type);
+const isAIBot = (resultOrUA) => [
+
+    // AI2
+    'ai2bot',
+
+    // Amazon
+    'amazonbot',
+
+    // Anthropic
+    'anthropic-ai',
+    'claude-web',
+    'claudebot',
+
+    // Apple
+    'applebot',
+    'applebot-extended',
+
+    // ByteDance
+    'bytespider',
+
+    // Common Crawl
+    'ccbot',
+
+    // DataForSeo
+    'dataforseobot',
+
+    // Diffbot
+    'diffbot',
+
+    // Google
+    'googleother',
+    'googleother-image',
+    'googleother-video',
+    'google-extended',
+
+    // Hive AI
+    'imagesiftbot',
+
+    // Huawei
+    'petalbot',
+
+    // Meta
+    'facebookbot',
+    'meta-externalagent',
+
+    // OpenAI
+    'gptbot',
+    'oai-searchbot',
+
+    // Perplexity
+    'perplexitybot',
+
+    // Timpi
+    'timpibot',
+
+    // Velen.io
+    'velenpublicwebcrawler',
+
+    // Webz.io
+    'omgili',
+    'omgilibot',
+    'webzio-extended',
+
+    // You.com
+    'youbot',
+
+    // Zyte
+    'scrapy'
+
+    ].includes(String(toResult(resultOrUA, Bots).browser.name).toLowerCase());
+
+const isBot = (resultOrUA) => [
+    'cli', 
+    'crawler', 
+    'fetcher', 
+    'library'
+    ].includes(toResult(resultOrUA, Bots).browser.type);
 
-const isChromeFamily = (res) => res.engine.is(Engine.BLINK);
+const isChromeFamily = (resultOrUA) => toResult(resultOrUA).engine.is(Engine.BLINK);
 
 const isElectron = () => !!(process?.versions?.hasOwnProperty('electron') ||    // node.js
                             / electron\//i.test(navigator?.userAgent));         // browser
@@ -51,6 +131,7 @@ const isElectron = () => !!(process?.versions?.hasOwnProperty('electron') ||
 export { 
     getDeviceVendor,
     isAppleSilicon,
+    isAIBot,
     isBot,
     isChromeFamily,
     isElectron,

package/src/main/ua-parser.d.ts

@@ -1,7 +1,10 @@
-// Type definitions for UAParser.js v2.0.0-rc.3
+// Type definitions for UAParser.js v2.0.1
 // Project: https://github.com/faisalman/ua-parser-js
 // Definitions by: Faisal Salman <https://github.com/faisalman>
 
+import type { IncomingHttpHeaders } from 'http';
+import type { Headers as FetchAPIHeaders } from 'node-fetch';
+
 declare namespace UAParser {
     
     interface IData<T> {
@@ -50,11 +53,12 @@ declare namespace UAParser {
     type RegexMap = ((RegExp | string | (string | RegExp | Function)[])[])[];
     type UAParserProps = 'browser' | 'cpu' | 'device' | 'engine' | 'os';
     type UAParserExt = Partial<Record<UAParserProps, RegexMap>> | Partial<Record<UAParserProps, RegexMap>>[];
+    type UAParserHeaders = Record<string, string> | IncomingHttpHeaders | FetchAPIHeaders;
 
-    export function UAParser(uastring?: string, extensions?: UAParserExt, headers?: Record<string, string>): IResult;
-    export function UAParser(uastring?: string, headers?: Record<string, string>): IResult;
-    export function UAParser(extensions?: UAParserExt, headers?: Record<string, string>): IResult;
-    export function UAParser(headers?: Record<string, string>): IResult;
+    export function UAParser(uastring?: string, extensions?: UAParserExt, headers?: UAParserHeaders): IResult;
+    export function UAParser(uastring?: string, headers?: UAParserHeaders): IResult;
+    export function UAParser(extensions?: UAParserExt, headers?: UAParserHeaders): IResult;
+    export function UAParser(headers?: UAParserHeaders): IResult;
 
     export class UAParser {