Alpha release of v2.0

faisalman · Mar 29, 2023 · 30de983 · 30de983
1 parent 894512c
commit 30de983
Show file tree

Hide file tree

Showing 16 changed files with 279 additions and 194 deletions.
diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "ua-parser-js",
-  "version": "0.7.33",
+  "version": "2.0.0-alpha.1",
   "authors": [
     "Faisal Salman <f@faisalman.com>"
   ],

diff --git a/changelog.md b/changelog.md
@@ -1,27 +1,42 @@
 # UAParser.js Changelog
 
+# Version 2.0.0-alpha.1
+- Breaking changes:
+  - Browser detection on mobile device: `Chrome => Mobile Chrome`, `Firefox => Mobile Firefox`
+  - OS detection: `Mac OS => macOS`, `Chromium OS => Chrome OS`
+- Add some new methods in result object: 
+  - Add support for client hints: `withClientHints()`
+  - Utility for easy comparison: `is()`
+  - Utility to print full-name: `toString()`
+- Add support for ES module `import { UAParser } from 'ua-parser-js'`
+- Provide Enums `'ua-parser-js/enums'`
+- Provide Extensions `'ua-parser-js/extensions'`
+- 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 / 1.0
 
 Version 1.0.x is basically the equivalent of version 0.7.x. See [#536](https://github.com/faisalman/ua-parser-js/issues/536) for the reason behind this confusion.
 
-## Version 0.7.30 / 1.0.1
+## 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
 
-- 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.31 / 1.0.2
+## Version 0.7.33 / 1.0.33
 
-- Fix OPPO Reno A5 incorrect detection
-- Fix TypeError Bug
-- Use AST to extract regexes and verify them with safe-regex
+- Add new browser : Cobalt
+- Identify Macintosh as an Apple device
+- Fix ReDoS vulnerability
 
 ## Version 0.7.32 / 1.0.32
 
@@ -38,11 +53,24 @@ Version 1.0.x is basically the equivalent of version 0.7.x. See [#536](https://g
 - Fix included commas in Safari / Mobile Safari version
 - Increase UA_MAX_LENGTH to 350
 
-## Version 0.7.33 / 1.0.33
+## Version 0.7.31 / 1.0.2
 
-- Add new browser : Cobalt
-- Identify Macintosh as an Apple device
-- Fix ReDoS vulnerability
+- 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.8
 

diff --git a/dist/ua-parser.min.js b/dist/ua-parser.min.js
diff --git a/dist/ua-parser.pack.js b/dist/ua-parser.pack.js
diff --git a/package.js b/package.js
@@ -1,6 +1,6 @@
 Package.describe({
   name: 'faisalman:ua-parser-js',
-  version: '0.7.33',
+  version: '2.0.0-alpha.1',
   summary: 'Lightweight JavaScript-based user-agent string parser',
   git: 'https://github.com/faisalman/ua-parser-js.git',
   documentation: 'readme.md'

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "title": "UAParser.js",
   "name": "ua-parser-js",
-  "version": "0.7.33",
+  "version": "2.0.0-alpha.1",
   "author": "Faisal Salman <f@faisalman.com> (http://faisalman.com)",
   "description": "Detect Browser, Engine, OS, CPU, and Device type/model from User-Agent data. Supports browser & node.js environment",
   "keywords": [
@@ -139,30 +139,30 @@
     "yuanyang <work_yuanyang@163.com>",
     "Yun Young-jin <yupmin@yupmin-office-macmini.local>",
     "Zach Bjornson <zbbjornson@gmail.com>"
-  ],  
+  ],
   "type": "commonjs",
   "main": "src/ua-parser.js",
   "module": "src/ua-parser.mjs",
   "exports": {
-    "." : {
+    ".": {
       "require": "./src/ua-parser.js",
       "import": "./src/ua-parser.mjs"
     },
-    "./enums" : {
-      "require": "./src/ua-parser-enum.js",
-      "import": "./src/ua-parser-enum.mjs"
+    "./enums": {
+      "require": "./src/enum/ua-parser-enum.js",
+      "import": "./src/enum/ua-parser-enum.mjs"
     },
-    "./extensions" : {
-      "require": "./src/ua-parser-extension.js",
-      "import": "./src/ua-parser-extension.mjs"
+    "./extensions": {
+      "require": "./src/extension/ua-parser-extension.js",
+      "import": "./src/extension/ua-parser-extension.mjs"
     }
   },
   "files": [
     "dist",
     "src"
   ],
   "scripts": {
-    "build": "uglifyjs src/ua-parser.js -o dist/ua-parser.min.js --comments '/^ UA/' && uglifyjs src/ua-parser.js -o dist/ua-parser.pack.js --comments '/^ UA/' --compress --mangle && uglifyjs src/ua-parser-enum.js -o dist/ua-parser-enum.min.js --comments '/^  Enum/' && node -e \"const fs=require('fs');fs.writeFileSync('src/ua-parser.mjs','// Generated ESM version of UAParser.js\\n// DO NOT EDIT THIS FILE!\\n// Source: /src/ua-parser.js\\n\\nconst window = undefined;\\n\\n'+fs.readFileSync('src/ua-parser.js','utf-8').replace(/\\(func[\\s\\S]+strict\\';/ig,'').replace(/\\/[\\/\\s]+export[\\s\\S]+/ig,'export {UAParser};'),'utf-8');fs.writeFileSync('src/ua-parser-enum.mjs','// Generated ESM version of UAParser.js enums\\n// DO NOT EDIT THIS FILE!\\n// Source: /src/ua-parser-enum.js\\n\\n'+fs.readFileSync('src/ua-parser-enum.js','utf-8').replace(/module\\.exports =/ig,'export'),'utf-8');fs.writeFileSync('src/ua-parser-extension.mjs','// Generated ESM version of UAParser.js extensions\\n// DO NOT EDIT THIS FILE!\\n// Source: /src/ua-parser-extension.js\\n\\n'+fs.readFileSync('src/ua-parser-extension.js','utf-8').replace(/module\\.exports =/ig,'export'),'utf-8')\"",
+    "build": "uglifyjs src/ua-parser.js -o dist/ua-parser.min.js --comments '/^ UA/' && uglifyjs src/ua-parser.js -o dist/ua-parser.pack.js --comments '/^ UA/' --compress --mangle && node -e \"const fs=require('fs');fs.writeFileSync('src/ua-parser.mjs','// Generated ESM version of UAParser.js\\n// DO NOT EDIT THIS FILE!\\n// Source: /src/ua-parser.js\\n\\nconst window = undefined;\\n\\n'+fs.readFileSync('src/ua-parser.js','utf-8').replace(/\\(func[\\s\\S]+strict\\';/ig,'').replace(/\\/[\\/\\s]+export[\\s\\S]+/ig,'export {UAParser};'),'utf-8');fs.writeFileSync('src/enum/ua-parser-enum.mjs','// Generated ESM version of UAParser.js enums\\n// DO NOT EDIT THIS FILE!\\n// Source: /src/enum/ua-parser-enum.js\\n\\n'+fs.readFileSync('src/enum/ua-parser-enum.js','utf-8').replace(/module\\.exports =/ig,'export'),'utf-8');fs.writeFileSync('src/extension/ua-parser-extension.mjs','// Generated ESM version of UAParser.js extensions\\n// DO NOT EDIT THIS FILE!\\n// Source: /src/extension/ua-parser-extension.js\\n\\n'+fs.readFileSync('src/extension/ua-parser-extension.js','utf-8').replace(/const UA.+\\)/ig,'import UAParser from \\'ua-parser-js\\'').replace(/module\\.exports =/ig,'export'),'utf-8')\"",
     "test": "jshint src/ua-parser.js && mocha -R nyan test",
     "test-ci": "jshint src/ua-parser.js && mocha -R spec test",
     "verup": "node ./node_modules/verup",

diff --git a/readme.md b/readme.md
@@ -43,16 +43,19 @@ JavaScript library to detect Browser, Engine, OS, CPU, and Device type/model fro
 
 ---
 
+# Version 2.0
+What's new & breaking, please read [CHANGELOG](changelog.md) before upgrading.
+
 # Documentation
-### UAParser([user-agent:string][,extensions:object][,headers:object(since@1.1)])
+### UAParser([user-agent:string][,extensions:object][,headers:object(since@2.0)])
 
 In the browser environment you dont need to pass the user-agent string to the function, you can just call the funtion and it should automatically get the string from the `window.navigator.userAgent`, but that is not the case in nodejs. The user-agent string must be passed in' nodejs for the function to work. Usually you can find the user agent in: `request.headers["user-agent"]`.
 
 
 ## Constructor
 When you call `UAParser` with the `new` keyword, `UAParser` will return a new instance with an empty result object, you have to call one of the available methods to get the information from the user-agent string.
 Like so:
-* `new UAParser([user-agent:string][,extensions:object][,headers:object(since@1.1)])`
+* `new UAParser([user-agent:string][,extensions:object][,headers:object(since@2.0)])`
 ```js
 let parser = new UAParser("your user-agent here"); // you need to pass the user-agent for nodejs
 console.log(parser); // {}
@@ -65,22 +68,19 @@ console.log(parserResults);
   "os"      : {},
   "device"  : {},
   "cpu"     : {}
-  
-  // since@1.1 
-  ,"ua_ch"  : {}
 } */
 ```
 
 When you call UAParser without the `new` keyword, it will automatically call `getResult()` function and return the parsed results.
-* `UAParser([user-agent:string][,extensions:object][,headers:object(since@1.1)])`
-    * returns result object `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} /* added since@1.1: ua_ch: {} */ }`
+* `UAParser([user-agent:string][,extensions:object][,headers:object(since@2.0)])`
+    * returns result object `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`
 
 ## Methods
 
 #### Methods table
 The methods are self explanatory, here's a small overview on all the available methods:
 *  `getResult()` - returns all function object calls, user-agent string, browser info, cpu, device, engine, os:
-`{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} /* added since@1.1: ua_ch: {} */ }`.
+`{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`.
 
  *  `getBrowser()`      - returns the browser name and version.
  *  `getDevice()`       - returns the device model, type, vendor.
@@ -93,7 +93,7 @@ The methods are self explanatory, here's a small overview on all the available m
 ---
 
 * `getResult()`
-    * returns `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} /* added since@1.1: ua_ch: {} */ }`
+    * returns `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`
 
 * `getBrowser()`
     * returns `{ name: '', version: '' }`
@@ -113,7 +113,7 @@ NetSurf, Netfront, Netscape, NokiaBrowser, Obigo, Oculus Browser, OmniWeb,
 Opera Coast, Opera [Mini/Mobi/Tablet], PaleMoon, PhantomJS, Phoenix, Polaris, 
 Puffin, QQ, QQBrowser, QQBrowserLite, Quark, QupZilla, RockMelt, [Mobile] Safari, 
 Sailfish Browser, Samsung Browser, SeaMonkey, Silk, Skyfire, Sleipnir, Slim, 
-SlimBrowser, Swiftfox, Tesla, Tizen Browser, UCBrowser, UP.Browser, Viera, 
+SlimBrowser, Swiftfox, Tesla, TikTok, Tizen Browser, UCBrowser, UP.Browser, Viera, 
 Vivaldi, Waterfox, WeChat, Weibo, Yandex, baidu, iCab, w3m, Whale Browser, ...
 
 # 'browser.version' determined dynamically
@@ -148,8 +148,8 @@ Siemens, Sony[Ericsson], Sprint, Tesla, Vivo, Vodafone, Xbox, Xiaomi, Zebra, ZTE
 
 ```sh
 # Possible 'engine.name'
-Amaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, Links, Lynx, NetFront,
-NetSurf, Presto, Tasman, Trident, w3m, WebKit
+Amaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, LibWeb, Links, Lynx, 
+NetFront, NetSurf, Presto, Tasman, Trident, w3m, WebKit
 
 # 'engine.version' determined dynamically
 ```
@@ -165,8 +165,9 @@ Fuchsia, Gentoo, GhostBSD, GNU, Haiku, HarmonyOS, HP-UX, Hurd, iOS, Joli, KaiOS,
 Linpus, Linspire,Linux, Mac OS, Maemo, Mageia, Mandriva, Manjaro, MeeGo, Minix, 
 Mint, Morph OS, NetBSD, NetRange, NetTV, Nintendo, OpenBSD, OpenVMS, OS/2, Palm, 
 PC-BSD, PCLinuxOS, Plan9, PlayStation, QNX, Raspbian, RedHat, RIM Tablet OS, 
-RISC OS, Sabayon, Sailfish, Series40, Slackware, Solaris, SUSE, Symbian, Tizen, 
-Ubuntu, Unix, VectorLinux, Viera, watchOS, WebOS, Windows [Phone/Mobile], Zenwalk, ...
+RISC OS, Sabayon, Sailfish, SerenityOS, Series40, Slackware, Solaris, SUSE, Symbian, 
+Tizen, Ubuntu, Unix, VectorLinux, Viera, watchOS, WebOS, Windows [Phone/Mobile], 
+Zenwalk, ...
 
 # 'os.version' determined dynamically
 ```
@@ -186,10 +187,10 @@ Ubuntu, Unix, VectorLinux, Viera, watchOS, WebOS, Windows [Phone/Mobile], Zenwal
     * set UA string to be parsed
     * returns current instance
 
-#### * `is():boolean` utility `since@1.1`
+#### * `is():boolean` utility `since@2.0`
 
 ```js
-// Is just a shorthand to check whether specified item has a property with equals value (case-insensitive)
+// Is just a shorthand comparison to check whether the value of specified item equals one of its properties (in a case-insensitive way)
 // so that instead of write it using `==` operator like this:
 
 let ua = UAParser();
@@ -202,15 +203,10 @@ if (device.type == "smarttv" || device.vendor == "Samsung") {}
 // we can also write the comparison above into as follow:
 
 if (device.is("mobile") && !os.is("iOS")) {}
-if (device.is("smarttv") || device.is("Samsung")) {}
+if (device.is("SmartTV") || device.is("SaMsUnG")) {}
 
 /*
-    Each properties will be checked in this particular order:
-    * browser : name
-    * cpu : architecture 
-    * device : type, model, vendor
-    * engine : name 
-    * os : name
+    For device, properties will be checked in this particular order: type, model, vendor
 */
 
 // Another examples:
@@ -250,7 +246,7 @@ let engine = uap.getEngine();
 engine.is("Blink");                 // true
 ```
 
-#### * `toString():string` utility `since@1.1`
+#### * `toString():string` utility `since@2.0`
 
 ```js
 // Retrieve full-name values as a string
@@ -291,11 +287,12 @@ engine.version;                     // "28.0.1500.95"
 engine.toString();                  // "Blink 28.0.1500.95"
 ```
 
-#### * `withClientHints():Promise<object>|Thenable<object>` `since@1.1`
+#### * `withClientHints():Promise<object>|Thenable<object>` `since@2.0`
 
-Unlike reading user-agent data, accessing client-hints data in browser-environment must be done in an asynchronous way. Worry not, you can chain the UAParser's `get*` method with `withClientHints()` to read the client-hints data as well that will return the updated data as a `Promise`. In nodejs-environment / browser-environment with non-secure context or without client-hints support (basically anything that's not chromium-based) this will return the updated data as a `Thenable` (can be chained with `then()`).
+Recently Chrome limits the information exposed through user-agent and introduces a new experimental set of data called "client-hints". In browser-environment, obtaining the client-hints data via JavaScript must be done in an asynchronous way. In `UAParser` you can chain the result object from `get*` method with `withClientHints()` to also read the client-hints data from the browser and return the updated data as a `Promise`.
 
 ```js
+// client-side example
 (async function () {  
     let ua = new UAParser();
 
@@ -314,12 +311,43 @@ Unlike reading user-agent data, accessing client-hints data in browser-environme
 })();
 ```
 
+Along with `User-Agent` HTTP header, Chrome also sends this client-hints data by default under `Sec-CH-UA-*` HTTP headers in each request. In server-side development, you can capture this extra information by passing the `req.headers` to `UAParser()` (see examples below). When using `withClientHints()` in nodejs environment and browser without client-hints support (basically anything that's not Chromium-based) the updated data will be returned as a `Thenable` (has `then()` method).
+
+```js
+// server-side example
+
+// Suppose we got a request having these HTTP headers: 
+const request = {
+    headers : {
+        'user-agent' : 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36',
+
+        'sec-ch-ua-mobile' : '?1',
+        'sec-ch-ua-model' : 'Galaxy S3 Marketing',
+        'sec-ch-ua-platform' : 'Android'
+    }
+};
+
+const result1 = UAParser(request.headers);                      // parse only "user-agent" header
+const result2 = UAParser(request.headers).withClientHints();    // update with "sec-ch-ua" headers
+
+console.log(result1.os.name);       // "Linux"
+console.log(result1.device.type);   // undefined
+console.log(result1.device.model);  // undefined
+
+console.log(result2.os.name);       // "Android"
+console.log(result2.device.type);   // "mobile"
+console.log(result2.device.model);  // "Galaxy S3 Marketing"
+
+new UAParser(request.headers).getBrowser().withClientHints().then((browser) => {
+    console.log(browser.toString());    // Chrome 110.0.0.0 
+});
+```
 
 ## Extending Regex
 
 If you want to detect something that's not currently provided by UAParser.js (eg: `bots`, specific apps, etc), you can pass a list of regexes to extend internal UAParser.js regexes with your own.
 
-* `UAParser([uastring,] extensions [,headers:object(since@1.1)])`
+* `UAParser([uastring,] extensions [,headers:object(since@2.0)])`
 
 ```js
 // Example:
@@ -389,18 +417,6 @@ console.log(myParser2.setUA(myUA2).getDevice());  // {vendor: "MyTab", model: "1
             cpu: {
                 architecture: ""
             }
-
-            // added since@1.1:
-            ,ua_ch: {
-                architecture: "",
-                brands: "",
-                bitness: "",
-                fullVersionList: "",
-                mobile: "",
-                model: "",
-                platform: "",
-                platformVersion: ""
-            }
         }
     */
     // Default result depends on current window.navigator.userAgent value
@@ -453,7 +469,7 @@ http.createServer(function (req, res) {
     // get user-agent header
     var ua = uap(req.headers['user-agent']);
 
-    /* // BEGIN since@1.1 - you can also pass client-hints data to UAParser
+    /* // BEGIN since@2.0 - you can also pass client-hints data to UAParser
 
     // note: only works in secure context (https:// or localhost or file://)
 
@@ -463,7 +479,7 @@ http.createServer(function (req, res) {
     
     var ua = uap(req.headers);
 
-    // END since@1.1 */
+    // END since@2.0 */
 
     // write the result as response
     res.end(JSON.stringify(ua, null, '  '));
@@ -477,14 +493,13 @@ console.log('Server running at http://127.0.0.1:1337/');
 
 ```js
 import { UAParser } from 'ua-parser-js';
-import { CPUArch, DeviceType } from 'ua-parser-js/enums';
 
-const { cpu, device } = UAParser('Mozilla/5.0 (X11; U; Linux armv7l; en-GB; rv:1.9.2a1pre) Gecko/20090928 Firefox/3.5 Maemo Browser 1.4.1.22 RX-51 N900');
+const { browser, cpu, device } = UAParser('Mozilla/5.0 (X11; U; Linux armv7l; en-GB; rv:1.9.2a1pre) Gecko/20090928 Firefox/3.5 Maemo Browser 1.4.1.22 RX-51 N900');
 
-console.log(browser.name)                   // Maemo Browser
-console.log(cpu.is(CPUArch.ARM))            // true
-console.log(device.is(DeviceType.MOBILE))   // true
-console.log(device.model)                   // N900
+console.log(browser.name);          // Maemo Browser
+console.log(cpu.is('arm'));         // true
+console.log(device.is('mobile'));   // true
+console.log(device.model);          // N900
 ```
 
 ## Using TypeScript