Add page for Enums

Author: faisalman

docs/.vitepress/config.js

@@ -31,7 +31,7 @@ export default defineConfig({
                 items: [
                     {
                         text: 'Changelog',
-                        link: '/intro/whats-new'
+                        link: '/intro/changelog'
                     },
                     {
                         text: 'Contributing',
@@ -59,7 +59,8 @@ export default defineConfig({
                         ]
                     },
                     { text: 'Extending Regex', link: '/intro/extending-regex' },
-                    { text: 'Migrating from v1 to v2', link: '/intro/whats-new' }
+                    { text: 'Migrating from v1 to v2', link: '/intro/whats-new' },
+                    { text: 'Changelog', link: '/intro/changelog' }
                 ]
             },
             {
@@ -139,7 +140,8 @@ export default defineConfig({
                 text: 'Submodules',
                 items: [
                     { 
-                        text: 'Enums'
+                        text: 'Enums',
+                        link: '/api/submodules/enums',
                     },
                     {
                         text: 'Extensions', 

docs/api/main/get-device.md

@@ -17,8 +17,6 @@ Get details of device information (type, vendor, model) from user-agent string.
 
 ::: info
 See list of possible device type [here](/info/device/type).
-
-If you wish to detect **desktop** devices, you must handle the logic yourself, since UAParser only reports info that is directly available from user-agent string (read more about this issue [here🡭](https://github.com/faisalman/ua-parser-js/issues/182)).
 :::
 
 ---

docs/api/submodules/enums.md

@@ -0,0 +1,127 @@
+# Enums Submodule
+
+### `'ua-parser-js/enums'`
+
+## `Browser`
+```csv:no-line-numbers
+"115", "2345", "360", ALIPAY, AMAYA, ANDROID, ARORA, AVANT, AVAST, AVG, 
+BAIDU, BASILISK, BLAZER, BOLT, BOWSER, BRAVE, CAMINO, CHIMERA, CHROME, 
+CHROME_HEADLESS, CHROME_MOBILE, CHROME_WEBVIEW, CHROMIUM, COBALT, 
+COC_COC, CONKEROR, DAUM, DILLO, DOLPHIN, DORIS, DRAGON, DUCKDUCKGO, 
+EDGE, EPIPHANY, FACEBOOK, FALKON, FIREBIRD, FIREFOX, FIREFOX_FOCUS, 
+FIREFOX_MOBILE, FIREFOX_REALITY, FENNEC, FLOCK, FLOW, GO, 
+GOOGLE_SEARCH, HELIO, HEYTAP, HONOR, HUAWEI, ICAB, ICE, ICEAPE, 
+ICECAT, ICEDRAGON, ICEWEASEL, IE, INSTAGRAM, IRIDIUM, IRON, JASMINE, 
+KONQUEROR, KAKAO, KHTML, K_MELEON, KLAR, KLARNA, KINDLE, LENOVO, 
+LADYBIRD, LIBREWOLF, LIEBAO, LINE, LINKEDIN, LINKS, LUNASCAPE, LYNX, 
+MAEMO, MAXTHON, MIDORI, MINIMO, MIUI, MOZILLA, MOSAIC, NAVER, 
+NETFRONT, NETSCAPE, NETSURF, NOKIA, OBIGO, OCULUS, OMNIWEB, OPERA, 
+OPERA_COAST, OPERA_MINI, OPERA_MOBI, OPERA_TABLET, OPERA_TOUCH, OVI, 
+PALEMOON, PHANTOMJS, PHOENIX, PICOBROWSER, POLARIS, PUFFIN, QQ, 
+QQ_LITE, QUARK, QUPZILLA, REKONQ, ROCKMELT, SAFARI, SAFARI_MOBILE, 
+SAILFISH, SAMSUNG, SEAMONKEY, SILK, SKYFIRE, SLEIPNIR, SLIMBOAT, 
+SLIMBROWSER, SLIMJET, SNAPCHAT, SOGOU_EXPLORER, SOGOU_MOBILE, 
+SWIFTFOX, TESLA, TIKTOK, TIZEN, TWITTER, UC, UP, VIVALDI, VIVO, 
+W3M, WATERFOX, WEBKIT, WECHAT, WEIBO, WHALE, WOLVIC, YANDEX
+```
+::: info
+See list of possible browser name [here](/info/browser/name).
+:::
+
+## `BrowserType`
+```csv:no-line-numbers
+CRAWLER, CLI, EMAIL, FETCHER, INAPP, MEDIAPLAYER, LIBRARY
+```
+::: info
+Find the example of various browser types in [**ua-parser-js/extensions**](/api/submodules/extensions/overview) submodule.
+:::
+
+## `CPU`
+```csv:no-line-numbers
+"68K", ARM, ARM_64, ARM_HF, AVR, AVR_32, IA64, IRIX, IRIX_64, MIPS, 
+MIPS_64, PA_RISC, PPC, SPARC, SPARC_64, X86, X86_64
+```
+::: info
+See list of possible cpu architecture [here](/info/cpu/arch).
+:::
+
+## `Device`
+```csv:no-line-numbers
+CONSOLE, DESKTOP, EMBEDDED, MOBILE, SMARTTV, TABLET, WEARABLE, XR
+```
+::: info
+See list of possible device type [here](/info/device/type).
+:::
+
+## `Vendor`
+```csv:no-line-numbers
+ACER, ADVAN, ALCATEL, APPLE, AMAZON, ARCHOS, ASUS, ATT, BENQ, 
+BLACKBERRY, CAT, DELL, ENERGIZER, ESSENTIAL, FACEBOOK, FAIRPHONE, 
+GEEKSPHONE, GENERIC, GOOGLE, HMD, HP, HTC, HUAWEI, IMO, INFINIX, 
+ITEL, JOLLA, KOBO, LENOVO, LG, MEIZU, MICROMAX, MICROSOFT, MOTOROLA, 
+NEXIAN, NINTENDO, NOKIA, NOTHING, NVIDIA, ONEPLUS, OPPO, OUYA, PALM, 
+PANASONIC, PEBBLE, PICO, POLYTRON, REALME, RIM, ROKU, SAMSUNG, SHARP, 
+SIEMENS, SMARTFREN, SONY, SPRINT, TCL, TECHNISAT, TECNO, TESLA, 
+ULEFONE, VIVO, VODAFONE, XBOX, XIAOMI, ZEBRA, ZTE
+```
+::: info
+See list of possible device vendor [here](/info/device/vendor).
+:::
+
+## `Engine`
+```csv:no-line-numbers
+AMAYA, ARKWEB, BLINK, EDGEHTML, FLOW, GECKO, GOANNA, ICAB, KHTML, 
+LIBWEB, LINKS, LYNX, NETFRONT, NETSURF, PRESTO, SERVO, TASMAN, 
+TRIDENT, W3M, WEBKIT
+```
+::: info
+See list of possible engine name [here](/info/engine/name).
+:::
+
+## `OS`
+```csv:no-line-numbers
+AIX, AMIGA_OS, ANDROID, ANDROID_X86, ARCH, BADA, BEOS, BLACKBERRY, 
+CENTOS, CHROME_OS, CHROMECAST, CHROMECAST_ANDROID, CHROMECAST_FUCHSIA, 
+CHROMECAST_LINUX, CHROMECAST_SMARTSPEAKER, CONTIKI, DEBIAN, DEEPIN, 
+DRAGONFLY, ELEMENTARY_OS, FEDORA, FIREFOX_OS, FREEBSD, FUCHSIA, 
+GENTOO, GHOSTBSD, GNU, HAIKU, HARMONYOS, HP_UX, HURD, IOS, JOLI, 
+KAIOS, KUBUNTU, LINPUS, LINSPIRE, LINUX, MACOS, MAEMO, MAGEIA, 
+MANDRIVA, MANJARO, MEEGO, MINIX, MINT, MORPH_OS, NETBSD, NETRANGE, 
+NETTV, NINTENDO, OPENHARMONY, OPENBSD, OPENVMS, OS2, PALM, PC_BSD, 
+PCLINUXOS, PICO, PLAN9, PLAYSTATION, QNX, RASPBIAN, REDHAT, 
+RIM_TABLET_OS, RISC_OS, SABAYON, SAILFISH, SERENITYOS, SERIES40, 
+SLACKWARE, SOLARIS, SUSE, SYMBIAN, TIZEN, UBUNTU, UBUNTU_TOUCH, 
+UNIX, VECTORLINUX, WATCHOS, WEBOS, WINDOWS, WINDOWS_IOT, 
+WINDOWS_MOBILE, WINDOWS_PHONE, XBOX, ZENWALK
+```
+::: info
+See list of possible os name [here](/info/os/name).
+:::
+
+
+## Code Example
+
+- Match for a specific `os.name`:
+
+```js
+import { UAParser } from 'ua-parser-js';
+import { OS } from 'ua-parser-js/enums';
+
+if (UAParser().os.name == OS.RIM_TABLET_OS) {
+    console.log('Are you for real?');
+}
+```
+
+- Match for a specific `browser.type`:
+
+```js
+import { UAParser } from 'ua-parser-js';
+import { Bots } from 'ua-parser-js/extensions';
+import { BrowserType } from 'ua-parser-js/enums';
+
+const botParser = new UAParser(Bots);
+const typeofBrowser = botParser.setUA(req.headers['user-agent']).getBrowser().type;
+if (typeofBrowser == BrowserType.CRAWLER) {
+    console.log('Hi, hello there Spidey!');
+}
+```

docs/info/device/type.md

@@ -10,4 +10,9 @@ Type of the device.
 | `smarttv` | Smart TVs or similar devices. | `LG Smart TV`, `Samsung Smart TV` |
 | `tablet` | Portable touchscreen devices larger than smartphones but smaller than laptops. | `Apple iPad`, `Samsung Galaxy Tab` |
 | `wearable` | Devices worn on the body, such as smartwatches or fitness trackers. | `Pebble`, `Apple Watch` |
-| `xr` | Extended reality (XR) devices, encompassing virtual reality (VR) and augmented reality (AR) headsets. | `Google Glass`, `Oculus Quest` |
+| `xr` | Extended reality (XR) devices, encompassing virtual reality (VR) and augmented reality (AR) headsets. | `Google Glass`, `Oculus Quest` |
+
+
+::: tip
+If you wish to detect **desktop** devices, you must handle the logic yourself, since UAParser only reports info that is directly available from user-agent string (read more about this issue [here🡭](https://github.com/faisalman/ua-parser-js/issues/182)).
+:::

docs/intro/changelog.md

@@ -0,0 +1,189 @@
+# UAParser.js Changelog
+
+## Version 2.0.0
+
+- `ua-parser-js/extensions` submodule:
+    - Add new CLI: ELinks, HTTPie
+    - Add new crawler: AI2Bot, aiHitBot, anthropic-ai, Diffbot, ImagesiftBot, magpie-crawler, Omgilibot, Screaming Frog SEO Spider, Seznambot, Teoma, Timpibot, VelenPublicWebCrawler, Webzio-Extended, YouBot
+    - Add new email: Airmail, BlueMail, eMClient, NaverMailApp, Sparrow, Yahoo
+    - Add new fetcher: cohere-ai, Vercelbot
+    - Add new library: java, python-urllib, python-requests
+- `ua-parser-js/helpers` submodule:
+    - Add new method `isAIBot()`: Checks if the user-agent is an AI bot
+
+## Version 2.0.0-rc.3
+
+- Add support for Headers object
+- Add new device: Advan, Cat, Energizer, Honor, IMO, Micromax, Smartfren
+- Add new engine: Servo
+- `ua-parser-js/extensions` submodule:
+    - Breaking change: rename `module` to `library`
+    - Add new email clients: Evolution, KMail, Kontact
+    - Add new bots: 360Spider, Archive.org Bots, CCBot, DataForSeoBot, DuckAssistBot, Exabot, Google Bots, Meta Bots, MojeekBot, PerplexityBot, PetalBot, TurnitinBot, Yeti, YisouSpider
+
+## Version 2.0.0-rc.2
+
+- Fix incorrect import path in ESM files
+- Add new browser: 115, SlimBoat, Slimjet, LibreWolf
+- Improve browser detection: 2345, 360, Dragon, Iron, Maxthon
+- `ua-parser-js/enums` submodule:
+    - Add Chromecast OS variants: Android/Fuchsia/Linux/SmartSpeaker
+- `ua-parser-js/helpers` submodule:
+    - Add new method: `isBot()` to check if the browser is identified as a bot
+
+## Version 2.0.0-rc.1
+
+- Fix Python Request mistakenly identified as Meta Quest
+- Add new browser: Helio
+- Add new device: itel, Nothing, Pico, TCL
+- Add new engine: ArkWeb
+- Add new OS: OpenHarmony, Pico
+- Improve browser detection: Quark
+- Improve device detection: Xiaomi, Amazon Echo Show, Google Chromecast, Samsung Galaxy Watch
+- `ua-parser-js/helpers` submodule:
+    - Add new method: 
+        - `getDeviceVendor()` to guess for a device vendor based on its model name
+        - `isElectron()` to check if current window is running inside Electron
+        - `isFromEU()` to check if current window is from an EU (European Union) country
+        - `isStandalonePWA()` to check if current window is a standalone PWA
+    - Rename `isChromiumBased()` to `isChromeFamily()`
+    - Update `isAppleSilicon()` to also checks for WebGL renderer info
+- `ua-parser-js/extensions` submodule:
+    - Restore `Bots` as a compilation of all these browser types: `cli`, `crawler`, `fetcher`, and `library`
+
+## Version 2.0.0-beta.3
+
+- Breaking:
+  - AR/VR devices moved to new device type: `xr`
+  - New property in `browser`: `type`
+- New features:
+  - Parse directly from command line using `npx ua-parser-js`
+  - Extensions can be passed as a list to `UAParser()`
+- Add new browser: Pico Browser, Twitter, Wolvic
+- Improve browser detection: DuckDuckGo, ICEBrowser, Klar, QQ, Sleipnir
+- Improve device detection: Oculus Quest & Oppo Pad
+- Update latest client hints spec: `formFactor` -> `formFactors`
+- In `ua-parser-js/extensions` submodule, `bots` divided into `crawler` / `fetcher` 
+
+## Version 2.0.0-beta.2
+
+- Increase UA_MAX_LENGTH to 500
+- Add TypeScript declaration file in `ua-parser-js/extensions` submodule
+- Improve TypeScript module resolution
+- Add new methods in `ua-parser-js/helpers` submodule: `isAppleSilicon()` & `isChromiumBased()`
+- Fix misidentified WebView token as device model
+- Add new browser: Alipay, Klarna, Opera GX, Smart Lenovo Browser, Vivo Browser
+- Rename browser: Avant, Baidu, Samsung Internet, Sogou Explorer, Sogou Mobile, WeChat
+- Improve client-hints detection: Edge, Xbox
+
+## Version 2.0.0-beta.1
+
+- Update Client Hints Form-Factor
+- Provide in-package type definitions
+- Add new device: Ulefone
+- Improve device detection: Realme, Xiaomi Redmi
+
+## Version 2.0.0-alpha.3
+
+- Add `withFeatureCheck()` method
+- Add `isFrozenUA()` method in `ua-parser-js/helpers` submodule
+- Add `MediaPlayers` & `Modules` in `ua-parser-js/extensions` submodule
+- Fix issue with ESM import
+
+## Version 2.0.0-alpha.2
+
+- Fix browser result always returning Chromium when using withClientHints()
+- Fix infinite-loop when await-ing withClientHints() in non-client-hints browser
+
+## Version 2.0.0-alpha.1
+
+- Initial work on new major version
+
+---
+
+## Version 0.7.38 / 1.0.38
+- Fix error on getOS() when userAgentData.platform is undefined
+- Add new browser: Opera GX, Twitter
+- Improve browser detection: DuckDuckGo
+- Improve device detection: OPPO Pad, Oculus Quest
+
+## Version 0.7.37 / 1.0.37
+- Fix misidentified WebView token as device model
+- Increase UA_MAX_LENGTH to 500
+- Add new browser: Alipay, Klarna, Smart Lenovo Browser, Vivo Browser
+- Add new device: Ulefone
+- Improve device detection: Realme, Xiaomi Redmi
+- Rename browser: Avant, Baidu, Samsung Internet, Sogou Explorer, Sogou Mobile, WeChat
+
+## Version 0.7.36 / 1.0.36
+- Add new browser: Snapchat
+- Add new devices: Infinix, Tecno
+- Improve device detection: Amazon Fire TV, Xiaomi POCO 
+- Improve OS detection: iOS
+
+## Version 0.7.35 / 1.0.35
+- Fix result from user-supplied user-agent being altered
+- Add new browser: Heytap, TikTok
+- Add new engine: LibWeb
+- Add new OS: SerenityOS
+- Improve browser detection: Yandex
+- Improve device detection: iPhone, Amazon Echo
+- Improve OS detection: iOS
+
+## Version 0.7.34 / 1.0.34
+- Fix Sharp Mobile detected as Huawei Tablet
+- Fix IE8 bug
+- Add new devices : Kobo e-Reader, Apple Watch, and some new SmartTV devices
+- Add new OS : watchOS
+- Improve browser detection : Kakao, Naver, Brave
+- Improve device detection : Oculus, iPad
+- Improve OS detection : Chrome OS
+- Using navigator.userAgentData as fallback for device.type & os.name
+
+## Version 0.7.33 / 1.0.33
+
+- Add new browser : Cobalt
+- Identify Macintosh as an Apple device
+- Fix ReDoS vulnerability
+
+## Version 0.7.32 / 1.0.32
+
+- Add new browser : DuckDuckGo, Huawei Browser, LinkedIn
+- Add new OS : HarmonyOS
+- Add some Huawei models
+- Add Sharp Aquos TV
+- Improve detection Xiaomi Mi CC9 
+- Fix Sony Xperia 1 III misidentified as Acer tablet
+- Fix Detect Sony BRAVIA as SmartTV 
+- Fix Detect Xiaomi Mi TV as SmartTV 
+- Fix Detect Galaxy Tab S8 as tablet 
+- Fix WeGame mistakenly identified as WeChat
+- Fix included commas in Safari / Mobile Safari version
+- Increase UA_MAX_LENGTH to 350
+
+## Version 0.7.31 / 1.0.2
+
+- Fix OPPO Reno A5 incorrect detection
+- Fix TypeError Bug
+- Use AST to extract regexes and verify them with safe-regex
+
+## Version 0.7.30 / 1.0.1
+
+- Add new browser : Obigo, UP.Browser, Klar
+- Add new device : Oculus, Roku
+- Add new OS: Maemo, HP-UX, Android-x86, Deepin, elementary OS, GhostBSD, Linspire, Manjaro, Sabayon
+- Improve detection for Sony Xperia 1ii, LG Android TV, and some more devices
+- Improve detection for ARM64 CPU
+- Improve detection for Windows Mobile, Netscape, Mac on PowerPC
+- Categorize PDA as mobile
+- Fix Sharp devices misjudged as Huawei
+- Fix trailing comma for ES3 compatibility
+- Some code refactor
+
+## Version 0.7 / 1.0
+
+Version 1.0.x is basically the equivalent of version 0.7.x (mirror/duplicate). See [#536](https://github.com/faisalman/ua-parser-js/issues/536) for the reason behind this confusion.
+
+## Version 0.8
+
+Version 0.8 was created by accident. This version is now deprecated and no longer maintained, please update to version 0.7 / 1.0.