ua-parser-js 2.0.0-alpha.3 → 2.0.0-beta.1

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

@@ -0,0 +1,104 @@
+// Type definitions for UAParser.js v2.0.0-beta.1
+// Project: https://github.com/faisalman/ua-parser-js
+// Definitions by: Faisal Salman <https://github.com/faisalman>
+
+declare namespace UAParser {
+    
+    interface IData<T> {
+        is(val: string): boolean;
+        toString(): string;
+        withClientHints(): PromiseLike<T> | T;
+        withFeatureCheck(): T;
+    }
+
+    interface IBrowser extends IData<IBrowser> {
+        name?: string;
+        version?: string;
+        major?: string;
+    }
+
+    interface ICPU extends IData<ICPU> {
+        architecture?: 'ia32' | 'ia64' | 'amd64' | 'arm' | 'arm64' | 'armhf' | 'avr' | 'irix' | 'irix64' | 'mips' | 'mips64' | '68k' | 'ppc' | 'sparc' | 'sparc64';
+    }
+
+    interface IDevice extends IData<IDevice> {
+        type?: 'mobile' | 'tablet' | 'console' | 'smarttv' | 'wearable';
+        vendor?: string;
+        model?: string;
+    }
+
+    interface IEngine extends IData<IEngine> {
+        name?: 'Amaya' | 'Blink' | 'EdgeHTML' | 'Flow' | 'Gecko' | 'Goanna' | 'iCab' | 'KHTML' | 'LibWeb' | 'Links' | 'Lynx' | 'NetFront' | 'NetSurf' | 'Presto' | 'Tasman' | 'Trident' | 'w3m' | 'WebKit';
+        version?: string;
+    }
+
+    interface IOS extends IData<IOS> {
+        name?: string;
+        version?: string;
+    }
+
+    interface IResult extends IData<IResult> {
+        ua: string;
+        browser: IBrowser;
+        cpu: ICPU; 
+        device: IDevice;
+        engine: IEngine; 
+        os: IOS;
+    }
+
+    type RegexMap = ((RegExp | string | (string | RegExp | Function)[])[])[];
+
+    export function UAParser(uastring?: string, extensions?: Record<string, RegexMap>, headers?: Record<string, string>): IResult;
+    export function UAParser(uastring?: string, headers?: Record<string, string>): IResult;
+    export function UAParser(extensions?: Record<string, RegexMap>, headers?: Record<string, string>): IResult;
+    export function UAParser(headers?: Record<string, string>): IResult;
+
+    export class UAParser {
+        
+        static readonly BROWSER: {
+            NAME: 'name'; 
+            VERSION: 'version'; 
+            MAJOR: 'major';
+        };
+        static readonly CPU: { 
+            ARCHITECTURE: 'architecture'; 
+        };
+        static readonly DEVICE: { 
+            TYPE: 'type';
+            VENDOR: 'vendor'; 
+            MODEL: 'model';
+            CONSOLE: 'console';
+            MOBILE: 'mobile';
+            SMARTTV: 'smarttv';
+            TABLET: 'tablet';
+            WEARABLE: 'wearable';
+            EMBEDDED: 'embedded';
+        };
+        static readonly ENGINE: { 
+            NAME: 'name'; 
+            VERSION: 'version'; 
+        };
+        static readonly OS: { 
+            NAME: 'name';
+            VERSION: 'version'; 
+        };
+        static readonly VERSION: string;
+
+        constructor(uastring?: string, extensions?: Record<string, RegexMap>, headers?: Record<string, string>);
+        constructor(uastring?: string, headers?: Record<string, string>);
+        constructor(extensions?: Record<string, RegexMap>, headers?: Record<string, string>);
+        constructor(headers?: Record<string, string>);
+    
+        getUA(): string;
+        getBrowser(): IBrowser;
+        getCPU(): ICPU;
+        getDevice(): IDevice;
+        getEngine(): IEngine;
+        getOS(): IOS;
+        getResult(): IResult;
+        setUA(uastring: string): UAParser;
+    }
+}
+
+export as namespace UAParser;
+export = UAParser;

package/src/main/ua-parser.js

@@ -1,7 +1,7 @@
 /////////////////////////////////////////////////////////////////////////////////
-/* UAParser.js v2.0.0-alpha.3
+/* UAParser.js v2.0.0-beta.1
    Copyright © 2012-2023 Faisal Salman <f@faisalman.com>
-   MIT License *//*
+   AGPLv3 License *//*
    Detect Browser, Engine, OS, CPU, and Device type/model from User-Agent data.
    Supports browser & node.js environment. 
    Demo   : https://faisalman.github.io/ua-parser-js
@@ -20,7 +20,7 @@
     /////////////
 
 
-    var LIBVERSION  = '2.0.0-alpha.3',
+    var LIBVERSION  = '2.0.0-beta.1',
         EMPTY       = '',
         UNKNOWN     = '?',
         FUNC_TYPE   = 'function',
@@ -43,6 +43,7 @@
         USER_AGENT  = 'user-agent',
         UA_MAX_LENGTH = 350,
         BRANDS      = 'brands',
+        FORMFACTOR  = 'formFactor',
         FULLVERLIST = 'fullVersionList',
         PLATFORM    = 'platform',
         PLATFORMVER = 'platformVersion',
@@ -51,11 +52,12 @@
         CH_HEADER_FULL_VER_LIST = CH_HEADER + '-full-version-list',
         CH_HEADER_ARCH      = CH_HEADER + '-arch',
         CH_HEADER_BITNESS   = CH_HEADER + '-' + BITNESS,
+        CH_HEADER_FORM_FACTOR = CH_HEADER + '-form-factor',
         CH_HEADER_MOBILE    = CH_HEADER + '-' + MOBILE,
         CH_HEADER_MODEL     = CH_HEADER + '-' + MODEL,
         CH_HEADER_PLATFORM  = CH_HEADER + '-' + PLATFORM,
         CH_HEADER_PLATFORM_VER = CH_HEADER_PLATFORM + '-version',
-        CH_ALL_VALUES       = [BRANDS, FULLVERLIST, MOBILE, MODEL, PLATFORM, PLATFORMVER, ARCHITECTURE, BITNESS],
+        CH_ALL_VALUES       = [BRANDS, FULLVERLIST, MOBILE, MODEL, PLATFORM, PLATFORMVER, ARCHITECTURE, FORMFACTOR, BITNESS],
         UA_BROWSER  = 'browser',
         UA_CPU      = 'cpu',
         UA_DEVICE   = 'device',
@@ -127,10 +129,14 @@
         itemListToArray = function (header) {
             if (!header) return undefined;
             var arr = [];
-            var tokens = strip(/\\?\"/g, header).split(', ');
+            var tokens = strip(/\\?\"/g, header).split(',');
             for (var i = 0; i < tokens.length; i++) {
-                var token = tokens[i].split(';v=');
-                arr[i] = { brand : token[0], version : token[1] };
+                if (tokens[i].indexOf(';') > -1) {
+                    var token = trim(tokens[i]).split(';v=');
+                    arr[i] = { brand : token[0], version : token[1] };
+                } else {
+                    arr[i] = tokens[i];
+                }
             }
             return arr;
         },
@@ -155,7 +161,7 @@
             return str.replace(pattern, EMPTY);
         },
         stripQuotes = function (val) {
-            return typeof val === STR_TYPE ? strip(/\"/g, val) : val; 
+            return typeof val === STR_TYPE ? strip(/\\?\"/g, val) : val; 
         },
         trim = function (str, len) {
             if (typeof(str) === STR_TYPE) {
@@ -237,7 +243,7 @@
                     return (i === UNKNOWN) ? undefined : i;
                 }
             }
-            return str;
+            return map.hasOwnProperty('*') ? map['*'] : str;
     };
 
     ///////////////
@@ -256,6 +262,16 @@
             '8.1'       : 'NT 6.3',
             '10'        : ['NT 6.4', 'NT 10.0'],
             'RT'        : 'ARM'
+        },
+        
+        formFactorMap = {
+            'embedded'  : 'Automotive',
+            'mobile'    : 'Mobile',
+            'tablet'    : ['Tablet', 'EInk'],
+            'smarttv'   : 'TV',
+            'wearable'  : ['VR', 'XR', 'Watch'],
+            '?'         : ['Desktop', 'Unknown'],
+            '*'         : undefined
     };
 
     //////////////
@@ -478,8 +494,10 @@
             /\b; (\w+) build\/hm\1/i,                                           // Xiaomi Hongmi 'numeric' models
             /\b(hm[-_ ]?note?[_ ]?(?:\d\w)?) bui/i,                             // Xiaomi Hongmi
             /\b(redmi[\-_ ]?(?:note|k)?[\w_ ]+)(?: bui|\))/i,                   // Xiaomi Redmi
+            /oid[^\)]+; (m?[12][0-389][01]\w{3,6}[c-y])( bui|\))/i,             // Xiaomi Redmi 'numeric' models
             /\b(mi[-_ ]?(?:a\d|one|one[_ ]plus|note lte|max|cc)?[_ ]?(?:\d?\w?)[_ ]?(?:plus|se|lite)?)(?: bui|\))/i // Xiaomi Mi
             ], [[MODEL, /_/g, ' '], [VENDOR, XIAOMI], [TYPE, MOBILE]], [
+            /oid[^\)]+; (2\d{4}(283|rpbf)[cgl])( bui|\))/i,                     // Redmi Pad
             /\b(mi[-_ ]?(?:pad)(?:[\w_ ]+))(?: bui|\))/i                        // Mi Pad tablets
             ],[[MODEL, /_/g, ' '], [VENDOR, XIAOMI], [TYPE, TABLET]], [
 
@@ -494,7 +512,7 @@
             ], [MODEL, [VENDOR, 'Vivo'], [TYPE, MOBILE]], [
 
             // Realme
-            /\b(rmx[12]\d{3})(?: bui|;|\))/i
+            /\b(rmx[1-3]\d{3})(?: bui|;|\))/i
             ], [MODEL, [VENDOR, 'Realme'], [TYPE, MOBILE]], [
 
             // Motorola
@@ -580,6 +598,10 @@
             /droid.+; (m[1-5] note) bui/i,
             /\bmz-([-\w]{2,})/i
             ], [MODEL, [VENDOR, 'Meizu'], [TYPE, MOBILE]], [
+                
+            // Ulefone
+            /; ((?:power )?armor(?:[\w ]{0,8}))(?: bui|\))/i
+            ], [MODEL, [VENDOR, 'Ulefone'], [TYPE, MOBILE]], [
 
             // MIXED
             /(blackberry|benq|palm(?=\-)|sonyericsson|acer|asus|dell|meizu|motorola|polytron|infinix|tecno)[-_ ]?([-\w]*)/i,
@@ -930,6 +952,7 @@
                 [PLATFORM, stripQuotes(uach[CH_HEADER_PLATFORM])],
                 [PLATFORMVER, stripQuotes(uach[CH_HEADER_PLATFORM_VER])],
                 [ARCHITECTURE, stripQuotes(uach[CH_HEADER_ARCH])],
+                [FORMFACTOR, itemListToArray(uach[CH_HEADER_FORM_FACTOR])],
                 [BITNESS, stripQuotes(uach[CH_HEADER_BITNESS])]
             ]);
         } else {
@@ -1011,8 +1034,7 @@
         };
 
         this.parseCH = function () {
-            var ua = this.ua,
-                uaCH = this.uaCH,
+            var uaCH = this.uaCH,
                 rgxMap = this.rgxMap;
     
             switch (this.itemType) {
@@ -1044,6 +1066,18 @@
                     if (uaCH[MODEL]) {
                         this.set(MODEL, uaCH[MODEL]);
                     }
+                    if (uaCH[FORMFACTOR]) {
+                        var ff;
+                        if (typeof uaCH[FORMFACTOR] !== 'string') {
+                            var idx = 0;
+                            while (!ff && idx < uaCH[FORMFACTOR].length) {
+                                ff = strMapper(uaCH[FORMFACTOR][idx++], formFactorMap);
+                            }
+                        } else {
+                            ff = strMapper(uaCH[FORMFACTOR], formFactorMap);
+                        }
+                        this.set(TYPE, ff);
+                    }
                     break;
                 case UA_OS:
                     var osName = uaCH[PLATFORM];

package/src/main/ua-parser.mjs

@@ -1,11 +1,11 @@
-// Generated ESM version of UAParser.js 
+// Generated ESM version of ua-parser-js
 // DO NOT EDIT THIS FILE!
 // Source: /src/main/ua-parser.js
 
 /////////////////////////////////////////////////////////////////////////////////
-/* UAParser.js v2.0.0-alpha.3
+/* UAParser.js v2.0.0-beta.1
    Copyright © 2012-2023 Faisal Salman <f@faisalman.com>
-   MIT License *//*
+   AGPLv3 License *//*
    Detect Browser, Engine, OS, CPU, and Device type/model from User-Agent data.
    Supports browser & node.js environment. 
    Demo   : https://faisalman.github.io/ua-parser-js
@@ -22,7 +22,7 @@
     /////////////
 
 
-    var LIBVERSION  = '2.0.0-alpha.3',
+    var LIBVERSION  = '2.0.0-beta.1',
         EMPTY       = '',
         UNKNOWN     = '?',
         FUNC_TYPE   = 'function',
@@ -45,6 +45,7 @@
         USER_AGENT  = 'user-agent',
         UA_MAX_LENGTH = 350,
         BRANDS      = 'brands',
+        FORMFACTOR  = 'formFactor',
         FULLVERLIST = 'fullVersionList',
         PLATFORM    = 'platform',
         PLATFORMVER = 'platformVersion',
@@ -53,11 +54,12 @@
         CH_HEADER_FULL_VER_LIST = CH_HEADER + '-full-version-list',
         CH_HEADER_ARCH      = CH_HEADER + '-arch',
         CH_HEADER_BITNESS   = CH_HEADER + '-' + BITNESS,
+        CH_HEADER_FORM_FACTOR = CH_HEADER + '-form-factor',
         CH_HEADER_MOBILE    = CH_HEADER + '-' + MOBILE,
         CH_HEADER_MODEL     = CH_HEADER + '-' + MODEL,
         CH_HEADER_PLATFORM  = CH_HEADER + '-' + PLATFORM,
         CH_HEADER_PLATFORM_VER = CH_HEADER_PLATFORM + '-version',
-        CH_ALL_VALUES       = [BRANDS, FULLVERLIST, MOBILE, MODEL, PLATFORM, PLATFORMVER, ARCHITECTURE, BITNESS],
+        CH_ALL_VALUES       = [BRANDS, FULLVERLIST, MOBILE, MODEL, PLATFORM, PLATFORMVER, ARCHITECTURE, FORMFACTOR, BITNESS],
         UA_BROWSER  = 'browser',
         UA_CPU      = 'cpu',
         UA_DEVICE   = 'device',
@@ -129,10 +131,14 @@
         itemListToArray = function (header) {
             if (!header) return undefined;
             var arr = [];
-            var tokens = strip(/\\?\"/g, header).split(', ');
+            var tokens = strip(/\\?\"/g, header).split(',');
             for (var i = 0; i < tokens.length; i++) {
-                var token = tokens[i].split(';v=');
-                arr[i] = { brand : token[0], version : token[1] };
+                if (tokens[i].indexOf(';') > -1) {
+                    var token = trim(tokens[i]).split(';v=');
+                    arr[i] = { brand : token[0], version : token[1] };
+                } else {
+                    arr[i] = tokens[i];
+                }
             }
             return arr;
         },
@@ -157,7 +163,7 @@
             return str.replace(pattern, EMPTY);
         },
         stripQuotes = function (val) {
-            return typeof val === STR_TYPE ? strip(/\"/g, val) : val; 
+            return typeof val === STR_TYPE ? strip(/\\?\"/g, val) : val; 
         },
         trim = function (str, len) {
             if (typeof(str) === STR_TYPE) {
@@ -239,7 +245,7 @@
                     return (i === UNKNOWN) ? undefined : i;
                 }
             }
-            return str;
+            return map.hasOwnProperty('*') ? map['*'] : str;
     };
 
     ///////////////
@@ -258,6 +264,16 @@
             '8.1'       : 'NT 6.3',
             '10'        : ['NT 6.4', 'NT 10.0'],
             'RT'        : 'ARM'
+        },
+        
+        formFactorMap = {
+            'embedded'  : 'Automotive',
+            'mobile'    : 'Mobile',
+            'tablet'    : ['Tablet', 'EInk'],
+            'smarttv'   : 'TV',
+            'wearable'  : ['VR', 'XR', 'Watch'],
+            '?'         : ['Desktop', 'Unknown'],
+            '*'         : undefined
     };
 
     //////////////
@@ -480,8 +496,10 @@
             /\b; (\w+) build\/hm\1/i,                                           // Xiaomi Hongmi 'numeric' models
             /\b(hm[-_ ]?note?[_ ]?(?:\d\w)?) bui/i,                             // Xiaomi Hongmi
             /\b(redmi[\-_ ]?(?:note|k)?[\w_ ]+)(?: bui|\))/i,                   // Xiaomi Redmi
+            /oid[^\)]+; (m?[12][0-389][01]\w{3,6}[c-y])( bui|\))/i,             // Xiaomi Redmi 'numeric' models
             /\b(mi[-_ ]?(?:a\d|one|one[_ ]plus|note lte|max|cc)?[_ ]?(?:\d?\w?)[_ ]?(?:plus|se|lite)?)(?: bui|\))/i // Xiaomi Mi
             ], [[MODEL, /_/g, ' '], [VENDOR, XIAOMI], [TYPE, MOBILE]], [
+            /oid[^\)]+; (2\d{4}(283|rpbf)[cgl])( bui|\))/i,                     // Redmi Pad
             /\b(mi[-_ ]?(?:pad)(?:[\w_ ]+))(?: bui|\))/i                        // Mi Pad tablets
             ],[[MODEL, /_/g, ' '], [VENDOR, XIAOMI], [TYPE, TABLET]], [
 
@@ -496,7 +514,7 @@
             ], [MODEL, [VENDOR, 'Vivo'], [TYPE, MOBILE]], [
 
             // Realme
-            /\b(rmx[12]\d{3})(?: bui|;|\))/i
+            /\b(rmx[1-3]\d{3})(?: bui|;|\))/i
             ], [MODEL, [VENDOR, 'Realme'], [TYPE, MOBILE]], [
 
             // Motorola
@@ -582,6 +600,10 @@
             /droid.+; (m[1-5] note) bui/i,
             /\bmz-([-\w]{2,})/i
             ], [MODEL, [VENDOR, 'Meizu'], [TYPE, MOBILE]], [
+                
+            // Ulefone
+            /; ((?:power )?armor(?:[\w ]{0,8}))(?: bui|\))/i
+            ], [MODEL, [VENDOR, 'Ulefone'], [TYPE, MOBILE]], [
 
             // MIXED
             /(blackberry|benq|palm(?=\-)|sonyericsson|acer|asus|dell|meizu|motorola|polytron|infinix|tecno)[-_ ]?([-\w]*)/i,
@@ -932,6 +954,7 @@
                 [PLATFORM, stripQuotes(uach[CH_HEADER_PLATFORM])],
                 [PLATFORMVER, stripQuotes(uach[CH_HEADER_PLATFORM_VER])],
                 [ARCHITECTURE, stripQuotes(uach[CH_HEADER_ARCH])],
+                [FORMFACTOR, itemListToArray(uach[CH_HEADER_FORM_FACTOR])],
                 [BITNESS, stripQuotes(uach[CH_HEADER_BITNESS])]
             ]);
         } else {
@@ -1013,8 +1036,7 @@
         };
 
         this.parseCH = function () {
-            var ua = this.ua,
-                uaCH = this.uaCH,
+            var uaCH = this.uaCH,
                 rgxMap = this.rgxMap;
     
             switch (this.itemType) {
@@ -1046,6 +1068,18 @@
                     if (uaCH[MODEL]) {
                         this.set(MODEL, uaCH[MODEL]);
                     }
+                    if (uaCH[FORMFACTOR]) {
+                        var ff;
+                        if (typeof uaCH[FORMFACTOR] !== 'string') {
+                            var idx = 0;
+                            while (!ff && idx < uaCH[FORMFACTOR].length) {
+                                ff = strMapper(uaCH[FORMFACTOR][idx++], formFactorMap);
+                            }
+                        } else {
+                            ff = strMapper(uaCH[FORMFACTOR], formFactorMap);
+                        }
+                        this.set(TYPE, ff);
+                    }
                     break;
                 case UA_OS:
                     var osName = uaCH[PLATFORM];

package/license.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2012-2023 Faisal Salman <<f@faisalman.com>>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.