@hyperwatch/useragent 3.9.3 → 4.0.0

package/regexes/uap-core-device.json

@@ -1,6 +1,6 @@
 [
   {
-    "regex": "^.{0,100}?(?:(?:iPhone|Windows CE|Windows Phone|Android).{0,300}(?:(?:Bot|Yeti)-Mobile|YRSpider|BingPreview|bots?/\\d|(?:bot|spider)\\.html)|AdsBot-Google-Mobile.{0,200}iPhone)",
+    "regex": "^.{0,100}?(?:(?:iPhone|Windows CE|Windows Phone|Android).{0,300}(?:(?:Bot|Yeti)-Mobile|YRSpider|BingPreview|bots?/\\d|(?:bot|spider)\\.html|Google-InspectionTool)|AdsBot-Google-Mobile.{0,200}iPhone)",
     "regex_flag": "i",
     "device_replacement": "Spider",
     "brand_replacement": "Spider",
@@ -24,13 +24,13 @@
     "brand_replacement": "Spider"
   },
   {
-    "regex": "Mozilla.{1,100}Mobile.{1,100}AspiegelBot",
+    "regex": "Mozilla.{1,100}Mobile.{1,100}(AspiegelBot|PetalBot)",
     "device_replacement": "Spider",
     "brand_replacement": "Spider",
     "model_replacement": "Smartphone"
   },
   {
-    "regex": "Mozilla.{0,200}AspiegelBot",
+    "regex": "Mozilla.{0,200}(AspiegelBot|PetalBot)",
     "device_replacement": "Spider",
     "brand_replacement": "Spider",
     "model_replacement": "Desktop"
@@ -504,6 +504,30 @@
     "brand_replacement": "ChangJia",
     "model_replacement": "$1"
   },
+  {
+    "regex": "CrKey.*DeviceType/([^/]*)",
+    "brand_replacement": "Google",
+    "device_replacement": "Chromecast",
+    "model_replacement": "$1"
+  },
+  {
+    "regex": "Fuchsia.*CrKey",
+    "brand_replacement": "Google",
+    "device_replacement": "Chromecast",
+    "model_replacement": "Nest Hub"
+  },
+  {
+    "regex": "Linux.*CrKey/1.36",
+    "brand_replacement": "Google",
+    "device_replacement": "Chromecast",
+    "model_replacement": "First Generation"
+  },
+  {
+    "regex": "CrKey/",
+    "brand_replacement": "Google",
+    "device_replacement": "Chromecast",
+    "model_replacement": "Chromecast"
+  },
   {
     "regex": "; {0,2}(Cloudfone)[ _](Excite)([^ ][^;/]{1,100}?)(?: Build|\\) AppleWebKit)",
     "device_replacement": "$1 $2 $3",
@@ -1072,7 +1096,7 @@
     "model_replacement": "$1"
   },
   {
-    "regex": "; {0,2}(ADR6200|ADR6400L|ADR6425LVW|Amaze|DesireS?|EndeavorU|Eris|EVO|Evo\\d[A-Z]+|HD2|IncredibleS?|Inspire[A-Z0-9]*|Inspire[A-Z0-9]*|Sensation[A-Z0-9]*|Wildfire)[ _-](.{1,200}?)(?:[/;\\)]|Build|MIUI|1\\.0)",
+    "regex": "; {0,2}(ADR6200|ADR6400L|ADR6425LVW|Amaze|DesireS?|EndeavorU|Eris|EVO|Evo\\d[A-Z]+|HD2|IncredibleS?|Inspire[A-Z0-9]*|Sensation[A-Z0-9]*|Wildfire)[ _-](.{1,200}?)(?:[/;\\)]|Build|MIUI|1\\.0)",
     "regex_flag": "i",
     "device_replacement": "HTC $1 $2",
     "brand_replacement": "HTC",
@@ -1612,6 +1636,30 @@
     "brand_replacement": "Meizu",
     "model_replacement": "$1"
   },
+  {
+    "regex": "Quest 3",
+    "device_replacement": "Quest",
+    "brand_replacement": "Meta",
+    "model_replacement": "Quest 3"
+  },
+  {
+    "regex": "Quest 2",
+    "device_replacement": "Quest",
+    "brand_replacement": "Meta",
+    "model_replacement": "Quest 2"
+  },
+  {
+    "regex": "Quest Pro",
+    "device_replacement": "Quest",
+    "brand_replacement": "Meta",
+    "model_replacement": "Quest Pro"
+  },
+  {
+    "regex": "Quest",
+    "device_replacement": "Quest",
+    "brand_replacement": "Meta",
+    "model_replacement": "Quest"
+  },
   {
     "regex": "; {0,2}(?:Micromax[ _](A111|A240)|(A111|A240)) Build",
     "regex_flag": "i",
@@ -1895,13 +1943,13 @@
     "model_replacement": "$1"
   },
   {
-    "regex": "; (ONE [a-zA-Z]\\d+)(?: Build|\\) AppleWebKit)",
+    "regex": "; (ONE [a-zA-Z]\\d+)(?: Build|;? {0,2}\\) AppleWebKit)",
     "device_replacement": "OnePlus $1",
     "brand_replacement": "OnePlus",
     "model_replacement": "$1"
   },
   {
-    "regex": "; (ONEPLUS [a-zA-Z]\\d+)(?: Build|\\) AppleWebKit)",
+    "regex": "; (ONEPLUS [a-zA-Z]\\d+)(?: Build|;? {0,2}\\) AppleWebKit)",
     "device_replacement": "OnePlus $1",
     "brand_replacement": "OnePlus",
     "model_replacement": "$1"
@@ -3546,7 +3594,7 @@
     "model_replacement": "Wii U"
   },
   {
-    "regex": "Nintendo (DS|3DS|DSi|Wii);",
+    "regex": "Nintendo (Switch|DS|3DS|DSi|Wii);",
     "device_replacement": "Nintendo $1",
     "brand_replacement": "Nintendo",
     "model_replacement": "$1"
@@ -3742,7 +3790,7 @@
     "model_replacement": "Smartphone"
   },
   {
-    "regex": "^.{0,100}(bot|BUbiNG|zao|borg|DBot|oegp|silk|Xenu|zeal|^NING|CCBot|crawl|htdig|lycos|slurp|teoma|voila|yahoo|Sogou|CiBra|Nutch|^Java/|^JNLP/|Daumoa|Daum|Genieo|ichiro|larbin|pompos|Scrapy|snappy|speedy|spider|msnbot|msrbot|vortex|^vortex|crawler|favicon|indexer|Riddler|scooter|scraper|scrubby|WhatWeb|WinHTTP|bingbot|BingPreview|openbot|gigabot|furlbot|polybot|seekbot|^voyager|archiver|Icarus6j|mogimogi|Netvibes|blitzbot|altavista|charlotte|findlinks|Retreiver|TLSProber|WordPress|SeznamBot|ProoXiBot|wsr\\-agent|Squrl Java|EtaoSpider|PaperLiBot|SputnikBot|A6\\-Indexer|netresearch|searchsight|baiduspider|YisouSpider|ICC\\-Crawler|http%20client|Python-urllib|dataparksearch|converacrawler|Screaming Frog|AppEngine-Google|YahooCacheSystem|fast\\-webcrawler|Sogou Pic Spider|semanticdiscovery|Innovazion Crawler|facebookexternalhit|Google.{0,200}/\\+/web/snippet|Google-HTTP-Java-Client|BlogBridge|IlTrovatore-Setaccio|InternetArchive|GomezAgent|WebThumbnail|heritrix|NewsGator|PagePeeker|Reaper|ZooShot|holmes|NL-Crawler|Pingdom|StatusCake|WhatsApp|masscan|Google Web Preview|Qwantify|Yeti|OgScrper)",
+    "regex": "^.{0,100}(bot|BUbiNG|zao|borg|DBot|oegp|silk|Xenu|zeal|^NING|CCBot|crawl|htdig|lycos|slurp|teoma|voila|yahoo|Sogou|CiBra|Nutch|^Java/|^JNLP/|Daumoa|Daum|Genieo|ichiro|larbin|pompos|Scrapy|snappy|speedy|spider|msnbot|msrbot|vortex|^vortex|crawler|favicon|indexer|Riddler|scooter|scraper|scrubby|WhatWeb|WinHTTP|bingbot|BingPreview|openbot|gigabot|furlbot|polybot|seekbot|^voyager|archiver|Icarus6j|mogimogi|Netvibes|blitzbot|altavista|charlotte|findlinks|Retreiver|TLSProber|WordPress|SeznamBot|ProoXiBot|wsr\\-agent|Squrl Java|EtaoSpider|PaperLiBot|SputnikBot|A6\\-Indexer|netresearch|searchsight|baiduspider|YisouSpider|ICC\\-Crawler|http%20client|Python-urllib|dataparksearch|converacrawler|Screaming Frog|AppEngine-Google|YahooCacheSystem|fast\\-webcrawler|Sogou Pic Spider|semanticdiscovery|Innovazion Crawler|facebookexternalhit|Google.{0,200}/\\+/web/snippet|Google-HTTP-Java-Client|BlogBridge|IlTrovatore-Setaccio|InternetArchive|GomezAgent|WebThumbnail|heritrix|NewsGator|PagePeeker|Reaper|ZooShot|holmes|NL-Crawler|Pingdom|StatusCake|WhatsApp|masscan|Google Web Preview|Qwantify|Yeti|OgScrper|RecipeRadar|GPTBot|Google-InspectionTool)",
     "regex_flag": "i",
     "device_replacement": "Spider",
     "brand_replacement": "Spider",

package/regexes/uap-core-os.json

@@ -40,7 +40,7 @@
     "regex": "HbbTV/\\d+\\.\\d+\\.\\d+ \\(.{0,30}; ?([a-zA-Z]+) ?;.{0,30}(201[1-9]).{0,30}\\)"
   },
   {
-    "regex": "AspiegelBot",
+    "regex": "AspiegelBot|PetalBot",
     "os_replacement": "Other"
   },
   {
@@ -56,6 +56,22 @@
   {
     "regex": "ArcGISRuntime-(?:Android|iOS)\\/\\d+\\.\\d+(?:\\.\\d+|) \\((Android|iOS) (\\d+)(?:\\.(\\d+)(?:\\.(\\d+)|)|);"
   },
+  {
+    "regex": "(Android) (\\d+)(?:\\.(\\d+)).*CrKey",
+    "os_replacement": "Chromecast Android"
+  },
+  {
+    "regex": "Fuchsia.*(CrKey)(?:[/](\\d+)\\.(\\d+)(?:\\.(\\d+)|)|)",
+    "os_replacement": "Chromecast Fuchsia"
+  },
+  {
+    "regex": "Linux.*(CrKey)(?:[/](\\d+)\\.(\\d+)(?:\\.(\\d+)|)|).*DeviceType/SmartSpeaker",
+    "os_replacement": "Chromecast SmartSpeaker"
+  },
+  {
+    "regex": "Linux.*(CrKey)(?:[/](\\d+)\\.(\\d+)(?:\\.(\\d+)|)|)",
+    "os_replacement": "Chromecast Linux"
+  },
   {
     "regex": "(Android)[ \\-/](\\d+)(?:\\.(\\d+)|)(?:[.\\-]([a-z0-9]+)|)"
   },
@@ -109,6 +125,10 @@
     "regex": "(android)\\s(?:mobile\\/)(\\d+)(?:\\.(\\d+)(?:\\.(\\d+)|)|)",
     "os_replacement": "Android"
   },
+  {
+    "regex": "Quest",
+    "os_replacement": "Android"
+  },
   {
     "regex": "(Silk-Accelerated=[a-z]{4,5})",
     "os_replacement": "Android"
@@ -220,6 +240,10 @@
   {
     "regex": "(Tizen)[/ ](\\d+)\\.(\\d+)"
   },
+  {
+    "regex": "Intel Mac OS X.+(CriOS|EdgiOS)/\\d+",
+    "os_replacement": "iOS"
+  },
   {
     "regex": "((?:Mac[ +]?|; )OS[ +]X)[\\s+/](?:(\\d+)[_.](\\d+)(?:[_.](\\d+)|)|Mach-O)",
     "os_replacement": "Mac OS X"
@@ -272,6 +296,10 @@
     "regex": "^Box.{0,200};(Darwin)/(10)\\.(1\\d)(?:\\.(\\d+)|)",
     "os_replacement": "Mac OS X"
   },
+  {
+    "regex": "darwin; arm64",
+    "os_replacement": "Mac OS X"
+  },
   {
     "regex": "(Apple\\s?TV)(?:/(\\d+)\\.(\\d+)|)",
     "os_replacement": "ATV OS X"
@@ -679,6 +707,39 @@
     "os_replacement": "iOS",
     "os_v1_replacement": "15"
   },
+  {
+    "regex": "CFNetwork/.{0,100} Darwin/22\\.([0-5])\\.\\d+",
+    "os_replacement": "iOS",
+    "os_v1_replacement": "16",
+    "os_v2_replacement": "$1"
+  },
+  {
+    "regex": "CFNetwork/.{0,100} Darwin/(22)\\.\\d+",
+    "os_replacement": "iOS",
+    "os_v1_replacement": "16"
+  },
+  {
+    "regex": "CFNetwork/.{0,100} Darwin/23\\.([0-5])\\.\\d+",
+    "os_replacement": "iOS",
+    "os_v1_replacement": "17",
+    "os_v2_replacement": "$1"
+  },
+  {
+    "regex": "CFNetwork/.{0,100} Darwin/(23)\\.\\d+",
+    "os_replacement": "iOS",
+    "os_v1_replacement": "17"
+  },
+  {
+    "regex": "CFNetwork/.{0,100} Darwin/24\\.([0-5])\\.\\d+",
+    "os_replacement": "iOS",
+    "os_v1_replacement": "18",
+    "os_v2_replacement": "$1"
+  },
+  {
+    "regex": "CFNetwork/.{0,100} Darwin/(24)\\.\\d+",
+    "os_replacement": "iOS",
+    "os_v1_replacement": "18"
+  },
   {
     "regex": "CFNetwork/.{0,100} Darwin/",
     "os_replacement": "iOS"
@@ -849,10 +910,6 @@
   {
     "regex": "(WebTV)/(\\d+).(\\d+)"
   },
-  {
-    "regex": "(CrKey)(?:[/](\\d+)\\.(\\d+)(?:\\.(\\d+)|)|)",
-    "os_replacement": "Chromecast"
-  },
   {
     "regex": "(hpw|web)OS/(\\d+)\\.(\\d+)(?:\\.(\\d+)|)",
     "os_replacement": "webOS"
@@ -901,5 +958,15 @@
   },
   {
     "regex": "^(Roku)/DVP-(\\d+)\\.(\\d+)"
+  },
+  {
+    "regex": "os\\/macos[#]?(\\d*)[.]?(\\d*)[.]?(\\d*)",
+    "os_replacement": "Mac OS X",
+    "os_v1_replacement": "$1",
+    "os_v2_replacement": "$2",
+    "os_v3_replacement": "$3"
+  },
+  {
+    "regex": "(HarmonyOS)[\\s;]+(\\d+|)\\.?(\\d+|)\\.?(\\d+|)"
   }
 ]

package/src/useragent.js

@@ -418,15 +418,14 @@ exports.Agent = Agent;
  * @returns {Boolean}
  */
 function isSafe(userAgent) {
-  let consecutive = 0,
-    code = 0;
+  let consecutive = 0;
 
   if (userAgent.length > 1000) {
     return false;
   }
 
   for (let i = 0; i < userAgent.length; i++) {
-    code = userAgent.charCodeAt(i);
+    const code = userAgent.charCodeAt(i);
     if (
       (code >= 48 && code <= 57) || // numbers
       (code >= 65 && code <= 90) || // letters A-Z

package/.eslintrc.json

@@ -1,75 +0,0 @@
-{
-  "env": {
-    "node": true,
-    "es6": true
-  },
-  "plugins": ["node", "import"],
-  "extends": [
-    "eslint:recommended",
-    "plugin:node/recommended",
-    "plugin:import/recommended"
-  ],
-  "rules": {
-    // -------------------
-    // Relaxing some rules
-    // -------------------
-
-    "no-console": "off",
-    "no-process-exit": "off",
-
-    // ----------------------------------
-    // Adding more eslint rules as errors
-    // ----------------------------------
-
-    // Disallow Unused Variables
-    // https://eslint.org/docs/rules/no-unused-vars
-    "no-unused-vars": ["error", { "vars": "all" }],
-    // require using arrow functions as callbacks
-    // https://eslint.org/docs/rules/prefer-arrow-callback
-    "prefer-arrow-callback": "error",
-    // require using template literals instead of string concatenation
-    // http://eslint.org/docs/rules/prefer-template
-    "prefer-template": "error",
-    // require using of const declaration for variables that are never modified after declared
-    // https://eslint.org/docs/rules/prefer-const
-    "prefer-const": "error",
-    // disallow modifying variables that are declared using const
-    // https://eslint.org/docs/rules/no-const-assign
-    "no-const-assign": "error",
-    // require let or const instead of var
-    // https://eslint.org/docs/rules/no-var
-    "no-var": "error",
-
-    // ------------------------------------
-    // Adding more eslint rules as warnings
-    // ------------------------------------
-
-    // require at least one whitespace after comments( // and /*)
-    // https://eslint.org/docs/rules/spaced-comment
-    "spaced-comment": ["warn", "always"],
-    // Require Following Curly Brace Conventions
-    // https://eslint.org/docs/rules/curly
-    "curly": ["warn", "all"],
-    // Require empty lines after class members
-    // https://eslint.org/docs/rules/lines-between-class-members
-    "lines-between-class-members": [
-      "warn",
-      "always",
-      { "exceptAfterSingleLine": true }
-    ],
-
-    "import/order": [
-      "warn",
-      {
-        "alphabetize": {
-          "order": "asc",
-          "caseInsensitive": true
-        },
-        "newlines-between": "always"
-      }
-    ]
-  },
-  "parserOptions": {
-    "ecmaVersion": 2018
-  }
-}

package/.prettierrc

@@ -1,4 +0,0 @@
-{
-  singleQuote: true,
-  trailingComma: "es5"
-}

package/data/benchmark-results.json

@@ -1,38 +0,0 @@
-{
-  "opencollective-2020-11": {
-    "total": 1525,
-    "hyperwatch": {
-      "average": 0.0123,
-      "miss": 14,
-      "missPercentage": 0.92
-    },
-    "uap": {
-      "average": 0.0745,
-      "miss": 40,
-      "missPercentage": 2.6
-    },
-    "combined": {
-      "average": 0.0196,
-      "miss": 0,
-      "missPercentage": 0
-    }
-  },
-  "opencollective-2022-10-14": {
-    "total": 2558,
-    "hyperwatch": {
-      "average": 0.0142,
-      "miss": 71,
-      "missPercentage": 2.8
-    },
-    "uap": {
-      "average": 0.0692,
-      "miss": 111,
-      "missPercentage": 4.3
-    },
-    "combined": {
-      "average": 0.0206,
-      "miss": 10,
-      "missPercentage": 0.39
-    }
-  }
-}

package/docs/API.md

@@ -1,178 +0,0 @@
-# API
-
-Include the `@hyperwatch/useragent` parser in you node.js application:
-
-```js
-const useragent = require('@hyperwatch/useragent');
-```
-
-### useragent.parse(useragent string);
-
-This is the actual user agent parser, this is where all the magic is happening.
-The function accepts 1 argument, the user agent string that is known on the server
-from the `req.headers.useragent` header.
-
-The parser returns an `Agent` instance, this allows you to output user agent
-information in different predefined formats. See the Agent section for more
-information.
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-```
-
-The parse method returns an `Agent` instance that contains all details about the
-user agent. See the Agent section of the API documentation for the available
-methods.
-
-### useragent.fromJSON(obj);
-
-Transforms the JSON representation of an `Agent` instance back in to a working
-`Agent` instance
-
-```js
-const agent = useragent.parse(req.headers['user-agent']),
-  another = useragent.fromJSON(JSON.stringify(agent));
-
-console.log(agent == another);
-```
-
----
-
-## Agent, Os, and Device instances
-
-Most of the methods mentioned above return an `Agent` instance. The Agent exposes
-the parsed out information from the user agent strings. This allows us to
-extend the agent with more methods that do not necessarily need to be in the
-core agent instance, allowing us to expose a plugin interface for third-party
-developers and at the same time create a uniform interface for all versioning.
-
-The Agent has the following property
-
-- `family` The browser family, or browser name, defaults to `null`.
-- `major` The major version number of the family, defaults to `null`.
-- `minor` The minor version number of the family, defaults to `null`.
-- `patch` The patch version number of the family, defaults to `null`.
-- `patch_minor` The patch version number of the family, defaults to `null`.
-
-In addition to the properties mentioned above, it also has 2 special properties,
-which are:
-
-- `os` Os instance
-- `device` Device instance
-
-When you access those 2 properties the agent will do on-demand parsing of the
-Operating System or/and Device information.
-
-The Os has the same properties as the Agent, for the Device we
-don't have any versioning information available, so only the `family` property is
-set there. If we cannot find the family, they will default to `null`.
-
-The following methods are available:
-
-### Agent.toAgent();
-
-Returns the family and version number concatenated in a nice human-readable
-string.
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.toAgent(); // 'Firefox 82.0'
-```
-
-### Agent.toString();
-
-Returns the results of the `Agent.toAgent()` but also adds the parsed operating
-system to the string in a human-readable format.
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.toString(); // 'Firefox 82.0 / Mac OS X 10.15'
-
-// as it's a to string method you can also concatenate it with another string
-'your useragent is ' + agent;
-// 'your useragent is Firefox 82.0 / Mac OS X 10.15'
-```
-
-### Agent.toVersion();
-
-Returns the version of the browser in a human-readable string.
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.toVersion(); // '82.0'
-```
-
-### Agent.toJSON();
-
-Generates a JSON representation of the Agent. By using the `toJSON` method we
-automatically allow it to be stringified when supplying as to the
-`JSON.stringify` method.
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.toJSON(); // returns an object
-
-JSON.stringify(agent);
-```
-
-### Os.toString();
-
-Generates a stringified version of `os`;
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.os.toString(); // 'Mac OS X 10.15'
-```
-
-### Os.toVersion();
-
-Generates a stringified version of `os`'s version;
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.os.toVersion(); // '10.15'
-```
-
-### Os.toJSON();
-
-Generates a JSON representation of the Os (Operating System). By using the `toJSON`
-method we automatically allow it to be stringified when supplying as to the
-`JSON.stringify` method.
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.os.toJSON(); // returns an object
-
-JSON.stringify(agent.os);
-```
-
-### Device.toString();
-
-Generates a stringified version of `device`;
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.device.toString(); // 'Asus A100'
-```
-
-### Device.toVersion();
-
-Generates a stringified version of the `device`'s version;
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.device.toVersion(); // '' , no version found but could also be '0.0.0'
-```
-
-### Device.toJSON();
-
-Generates a JSON representation of the Device. By using the `toJSON` method we
-automatically allow it to be stringified when supplying as to the
-`JSON.stringify` method.
-
-```js
-const agent = useragent.parse(req.headers['user-agent']);
-agent.device.toJSON(); // returns an object
-
-JSON.stringify(agent.device);
-```