node-device-detector - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

index.js

 module.exports = DeviceDetector;
-module.exports.DeviceDetector = DeviceDetector;
 
-const YAML = require('yamljs');
+const helper = require('./parser/helper');
+// device parsers
+const MobileParser = require('./parser/device/mobile');
+const HbbTvParser = require('./parser/device/hbb-tv');
+const Console = require('./parser/device/console');
+const CarBrowser = require('./parser/device/car-browser');
+const Camera = require('./parser/device/camera');
+const PortableMediaPlayer = require('./parser/device/portable-media-player');
+// client parsers
+const MobileApp = require('./parser/client/mobile-app');
+const MediaPlayer = require('./parser/client/media-player');
+const Browser = require('./parser/client/browser');
+const Library = require('./parser/client/library');
+const FeedReader = require('./parser/client/feed-reader');
+const PIM = require('./parser/client/pim');
+// os parsers
+const OsParser = require('./parser/os-abstract-parser');
 
-const BASE_REGEXES_DIR = __dirname + '/regexes';
-const BASE_DATA_DIR = __dirname + '/data';
+const DEVICE_TYPE = require('./parser/const/device-type');
+const DEVICE_PARSER = {
+  MOBILE: 'Mobile',
+  HBBTV: 'hbbtv',
+  CONSOLE: 'console',
+  CAR_BROWSER: 'CarBrowser',
+  CAMERA: 'Camera',
+  PORTABLE_MEDIA_PLAYER: 'PortableMediaPlayer'
+};
+const CLIENT_PARSER = {
+  FEED_READER: 'FeedReader',
+  MEDIA_PLAYER: 'MediaPlayer',
+  PIM: 'PIM',
+  MOBILE_APP: 'MobileApp',
+  LIBRARY: 'Library',
+  BROWSER: 'Browser',
+};
 
-function getBaseRegExp(str) {
-  str = str.replace(new RegExp('/', 'g'), '\\/');
-  str = str.replace(new RegExp('\\+\\+', 'g'), '+');
-  str = '(?:^|[^A-Z0-9\-_]|[^A-Z0-9\-]_|sprd-)(?:' + str + ')';
-  return new RegExp(str, 'i');
-}
+const TV_CLIENT_LIST = ['Kylo', 'Espial TV Browser'];
+const DESKTOP_OS_LIST = ['AmigaOS', 'IBM', 'GNU/Linux', 'Mac', 'Unix', 'Windows', 'BeOS', 'Chrome OS'];
+const CHROME_CLIENT_LIST = ['Chrome', 'Chrome Mobile'];
 
 function DeviceDetector(options) {
+  this.osData = null;
+  this.deviceData = null;
+  this.clientData = null;
 
-  this.browser_collection = [];
-  this.app_collection = [];
-  this.os_collection = [];
-  this.os_systems = [];
-  this.os_families = [];
-  this.os_collection = [];
-  this.device_collection = [];
+  this.osParserList = {};
+  this.deviceParserList = {};
+  this.clientParserList = {};
 
@@ -30,221 +56,252 @@ this.init();
 DeviceDetector.prototype.init = function () {
-  this.loadAppCollection();
-  this.loadBrowserCollection();
-  this.loadOsCollection();
-  this.loadBrandCollection();
-};
 
-DeviceDetector.prototype.loadAppCollection = function () {
-  console.log('DeviceDetector load client/mobile_apps.yml');
-  let path = BASE_REGEXES_DIR + '/client/mobile_apps.yml';
-  this.app_collection = YAML.load(path);
+  this.addParseOs("Os", new OsParser);
 
+  this.addParseClient(CLIENT_PARSER.FEED_READER, new FeedReader);
+  this.addParseClient(CLIENT_PARSER.MOBILE_APP, new MobileApp);
+  this.addParseClient(CLIENT_PARSER.MEDIA_PLAYER, new MediaPlayer);
+  this.addParseClient(CLIENT_PARSER.PIM, new PIM);
+  this.addParseClient(CLIENT_PARSER.BROWSER, new Browser);
+  this.addParseClient(CLIENT_PARSER.LIBRARY, new Library);
 
-};
+  this.addParseDevice(DEVICE_PARSER.HBBTV, new HbbTvParser);
+  this.addParseDevice(DEVICE_PARSER.CONSOLE, new Console);
+  this.addParseDevice(DEVICE_PARSER.CAR_BROWSER, new CarBrowser());
+  this.addParseDevice(DEVICE_PARSER.CAMERA, new Camera());
+  this.addParseDevice(DEVICE_PARSER.PORTABLE_MEDIA_PLAYER, new PortableMediaPlayer());
+  this.addParseDevice(DEVICE_PARSER.MOBILE, new MobileParser);
 
-DeviceDetector.prototype.loadBrowserCollection = function () {
-  console.log('DeviceDetector load client/browser.yml');
-  let path = BASE_REGEXES_DIR + '/client/browsers.yml';
-  this.browser_collection = YAML.load(path);
 };
 
-DeviceDetector.prototype.loadOsCollection = function () {
-  console.log('DeviceDetector load oss.yml');
-  let path = BASE_REGEXES_DIR + '/oss.yml';
-  this.os_collection = YAML.load(path);
-
-  this.os_families = require(BASE_DATA_DIR + '/os_families.json');
-  this.os_systems = require(BASE_DATA_DIR + '/os_systems.json');
+DeviceDetector.prototype.getParseDevice = function (name) {
+  return this.deviceParserList[name] ? this.deviceParserList[name] : null;
 };
 
-DeviceDetector.prototype.loadBrandCollection = function () {
-  console.log('DeviceDetector load device/mobiles.yml');
-  let path = BASE_REGEXES_DIR + '/device/mobiles.yml';
-  this.device_collection = YAML.load(path);
+DeviceDetector.prototype.getParseClient = function (name) {
+  return this.clientParserList[name] ? this.clientParserList[name] : null;
 };
 
-DeviceDetector.prototype.fixStringName = function (result) {
-  return result.replace(new RegExp('_', 'g'), ' ').replace(/ TD$/i, '');
+DeviceDetector.prototype.getParseOs = function (name) {
+  return this.osParserList[name] ? this.osParserList[name] : null;
 };
 
-DeviceDetector.prototype.fixStringVersion = function (result) {
-  return result.replace(new RegExp('_', 'g'), '.').trim();
+DeviceDetector.prototype.addParseDevice = function (name, parser) {
+  this.deviceParserList[name] = parser;
 };
 
-DeviceDetector.prototype.buildVersion = function (version, matches) {
-  return this.fixStringVersion(this.buildByMatch(version, matches));
+DeviceDetector.prototype.addParseOs = function (name, parser) {
+  this.osParserList[name] = parser;
 };
 
-DeviceDetector.prototype.buildModel = function (model, matches) {
-  model = this.fixStringName(this.buildByMatch(model, matches));
-  return (model === 'Build') ? null : model;
+DeviceDetector.prototype.addParseClient = function (name, parser) {
+  this.clientParserList[name] = parser;
 };
 
-DeviceDetector.prototype.buildByMatch = function (item, matches) {
-  item = item || '';
-  item = item.toString();
-  if (item.indexOf('$') !== -1) {
-    for (let nb = 1; nb <= 3; nb++) {
-      if (item.indexOf('$' + nb) === -1) {
-        continue;
-      }
-      let replace = (matches[nb] !== undefined) ? matches[nb] : '';
-      item = item.replace('$' + nb, replace);
+/**
+ * parse os
+ */
+DeviceDetector.prototype.parseOs = function () {
+  for (let name in this.osParserList) {
+    let parser = this.osParserList[name];
+    let result = parser.parse(this.userAgent);
+    if (result) {
+      this.osData = parser.getParseData();
+      break;
     }
   }
-  return item;
 };
 
-DeviceDetector.prototype.findDevice = function (userAgent) {
+DeviceDetector.prototype.getDeviceAttr = function (attr, defaultValue) {
+  return this.deviceData && this.deviceData[attr] ? this.deviceData[attr] : defaultValue;
+};
 
+DeviceDetector.prototype.getOsAttr = function (attr, defaultValue) {
+  return this.osData && this.osData[attr] ? this.osData[attr] : defaultValue;
+};
 
-  for (let brand in this.device_collection) {
+DeviceDetector.prototype.getClientAttr = function (attr, defaultValue) {
+  return this.clientData && this.clientData[attr] ? this.clientData[attr] : defaultValue;
+};
 
-    let match = getBaseRegExp(this.device_collection[brand]['regex']).exec(userAgent);
-    let deviceType = this.device_collection[brand]['device'];
-    let model = '';
+/**
+ * parse device
+ */
+DeviceDetector.prototype.parseDeviceType = function () {
+  let osName = this.getOsAttr('name', '');
+  let osFamily = this.getOsAttr('family', '');
+  let osShortName = this.getOsAttr('short_name', '');
+  let osVersion = this.getOsAttr('version', '');
+  let clientName = this.getClientAttr('name', '');
+  let deviceType = this.getDeviceAttr('type', '');
 
-    if (match) {
-      if (this.device_collection[brand]['models'] !== undefined) {
-        let models = this.device_collection[brand]['models'];
-        for (let i = 0, l = models.length; i < l; i++) {
-          let data = models[i];
-          let modelMatch = getBaseRegExp(data.regex).exec(userAgent);
-          if (modelMatch) {
-            model = this.buildModel(data.model, modelMatch);
-            if (data.device !== undefined) {
-              deviceType = data.device;
-            }
-            break;
-          }
-        }
-      } else if (this.device_collection[brand]['model'] !== undefined) {
-        model = this.buildModel(this.device_collection[brand]['model'], match);
-      }
-      return {
-        brand: String(brand).trim(),
-        model: String(model).trim(),
-        type: deviceType
-      };
+  if (deviceType === '' && this.isAndroid() && CHROME_CLIENT_LIST.indexOf(clientName) !== -1) {
+    if (helper.matchUserAgent('Chrome/[\\.0-9]* Mobile', this.userAgent) !== null) {
+      deviceType = DEVICE_TYPE.SMARTPHONE
+    } else if (helper.matchUserAgent('Chrome/[\.0-9]* (?!Mobile)', this.userAgent) !== null) {
+      deviceType = DEVICE_TYPE.TABLET
     }
   }
-  return null;
-};
 
-DeviceDetector.prototype.findApp = function (userAgent) {
-  for (let i = 0, l = this.app_collection.length; i < l; i++) {
-    let item = this.app_collection[i];
-    let regex = getBaseRegExp(item.regex);
-    let match;
-    if ((match = regex.exec(userAgent))) {
-      return {
-        name: this.buildByMatch(item.name, match),
-        version: this.buildVersion(item.version, match),
-        type: 'mobile app'
-      };
+  if (deviceType === '' && (helper.hasAndroidTableFragment(this.userAgent) || helper.hasOperaTableFragment(this.userAgent)  )) {
+    deviceType = DEVICE_TYPE.TABLET;
+  }
+
+  if (deviceType === '' && helper.hasAndroidMobileFragment(this.userAgent)) {
+    deviceType = DEVICE_TYPE.SMARTPHONE;
+  }
+
+  if (deviceType === '' && osShortName === 'AND' && osVersion !== '') {
+    if (helper.versionCompare(osVersion, '2.0') === -1) {
+      deviceType = DEVICE_TYPE.SMARTPHONE;
+    } else if (helper.versionCompare(osVersion, '3.0') >= 0 && helper.versionCompare(osVersion, '4.0') === -1) {
+      deviceType = DEVICE_TYPE.TABLET;
     }
   }
-  return {};
+
+  if (deviceType === DEVICE_TYPE.FEATURE_PHONE && this.isAndroid()) {
+    deviceType = DEVICE_TYPE.SMARTPHONE;
+  }
+
+  if (deviceType === '' && (osShortName === 'WRT' || (osShortName === 'WIN' && helper.versionCompare(osVersion, '8.0'))) && helper.hasTouchFragment(this.userAgent)) {
+    deviceType = DEVICE_TYPE.TABLET;
+  }
+
+  if (helper.hasOperaTVStoreFragment(this.userAgent)) {
+    deviceType = DEVICE_TYPE.TABLET;
+  }
+
+  if (helper.hasOperaTVStoreFragment(this.userAgent)) {
+    deviceType = DEVICE_TYPE.TV;
+  }
+
+  if (deviceType === '' && TV_CLIENT_LIST.indexOf(clientName) !== -1) {
+    deviceType = DEVICE_TYPE.TV;
+  }
+
+  if (deviceType === '' && DESKTOP_OS_LIST.indexOf(osFamily) !== -1) {
+    deviceType = DEVICE_TYPE.DESKTOP;
+  }
+
+  this.deviceData.type = deviceType;
 };
 
-
-DeviceDetector.prototype.findBrowser = function (user_agent) {
-  for (let i = 0, l = this.browser_collection.length; i < l; i++) {
-    let item = this.browser_collection[i];
-    let regex = getBaseRegExp(item.regex);
-    let match;
-    if ((match = regex.exec(user_agent))) {
-      return {
-        name: this.buildByMatch(item.name, match),
-        version: this.buildVersion(item.version, match),
-        type: 'browser'
-      };
+DeviceDetector.prototype.parseDevice = function () {
+  for (let name in this.deviceParserList) {
+    let parser = this.deviceParserList[name];
+    let result = parser.parse(this.userAgent);
+    if (result) {
+      this.deviceData = parser.getParseData();
+      break;
     }
   }
-  return null;
+
 };
 
-
 /**
- * @param userAgent
- * @return {{name: string, version: string, platform: string, short_name: string}}|null
+ * @todo need realisation
  */
-DeviceDetector.prototype.findOs = function (userAgent) {
-  for (let i = 0, l = this.os_collection.length; i < l; i++) {
-    let item = this.os_collection[i];
-    let regex = getBaseRegExp(item.regex);
-    let match;
-    if ((match = regex.exec(userAgent))) {
+DeviceDetector.prototype.parseBot = function () {
 
-      let name = this.buildByMatch(item.name, match);
-      let short = 'UNK';
+};
 
-      for(let key in this.os_systems){
-        if (String(name).toLowerCase() === String(this.os_systems[key]).toLowerCase()) {
-          name = this.os_systems[key];
-          short = key;
-          break;
-        }
-      }
-
-      return {
-        name: name,
-        version: this.buildVersion(item.version, match),
-        platform: this.findPlatform(userAgent),
-        short_name: short
-      };
+/**
+ * parse client
+ */
+DeviceDetector.prototype.parseClient = function () {
+  for (let name in this.clientParserList) {
+    let parser = this.clientParserList[name];
+    let result = parser.parse(this.userAgent);
+    if (result) {
+      this.clientData = parser.getParseData();
+      break;
     }
   }
-  return null;
 };
 
+
 /**
  * @param userAgent
- * @return {*}
+ * @return {{os: (null|*), device: (null|*), client: (null|*)}}
  */
-DeviceDetector.prototype.findPlatform = function (userAgent) {
-  if (/arm/i.test(userAgent)) {
-    return 'ARM';
-  } else if (/WOW64|x64|win64|amd64|x86_64/i.test(userAgent)) {
-    return 'x64';
-  } else if (/i[0-9]86|i86pc/i.test(userAgent)) {
-    return 'x86';
-  }
-  return '';
-};
+DeviceDetector.prototype.detect = function (userAgent) {
+  this.reset();
+  this.userAgent = userAgent;
 
-DeviceDetector.prototype.detect = function (user_agent) {
-  let osData = this.findOs(user_agent);
-  let clientData = this.findApp(user_agent);
-  let deviceData = this.findDevice(user_agent);
-  let ret = {};
+  this.parseBot();
+  this.parseOs();
+  this.parseClient();
+  this.parseDevice();
+  this.parseDeviceType();
 
-  if (osData) {
-    ret.os = osData;
-  }
+  return {
+    os: this.osData,
+    device: this.deviceData,
+    client: this.clientData
+  };
+};
 
-  if (clientData.name === undefined) {
-    clientData = this.findBrowser(user_agent);
-    if (clientData) {
-      ret.client = {
-        name: clientData.name,
-        version: clientData.version,
-        type: clientData.type
-      };
-    }
-  }
-  if (deviceData) {
-    ret.device = {
-      brand: deviceData.brand,
-      model: deviceData.model,
-      type: deviceData.type,
-    };
-  }
+/**
+ * is device type desktop
+ * @return {boolean}
+ */
+DeviceDetector.prototype.isDesktop = function () {
+  return !this.isMobile() && !this.isTabled() && !this.isPhablet();
+};
 
-  return ret;
+/**
+ * is device type mobile
+ * @return {boolean}
+ */
+DeviceDetector.prototype.isMobile = function () {
+  let type = this.getDeviceAttr('type', '');
+  return [DEVICE_TYPE.SMARTPHONE, DEVICE_TYPE.FEATURE_PHONE].indexOf(type) !== -1;
 };
 
+/**
+ * is device type table
+ * @return {boolean}
+ */
+DeviceDetector.prototype.isTabled = function () {
+  let type = this.getDeviceAttr('type', '');
+  return [DEVICE_TYPE.TABLET].indexOf(type) !== -1;
+};
 
+/**
+ * is device type phablet
+ * @return {boolean}
+ */
+DeviceDetector.prototype.isPhablet = function () {
+  return [DEVICE_TYPE.PHABLET].indexOf(type) !== -1;
+};
+/**
+ * is device type android table
+ * @return {boolean}
+ */
+DeviceDetector.prototype.isAndroid = function () {
+  let osFamily = this.getOsAttr('family', '');
+  return osFamily === 'Android';
+};
 
+/**
+ * is device type apple table
+ * @return {boolean}
+ */
+DeviceDetector.prototype.isIOS = function () {
+  let osFamily = this.getOsAttr('family', '');
+  return osFamily === 'iOS';
+};
 
-
+/**
+ * reset detect result
+ */
+DeviceDetector.prototype.reset = function () {
+  this.userAgent = null;
+  this.osData = null;
+  this.clientData = null;
+  this.deviceData = {
+    id: '',
+    type: '',
+    brand: '',
+    model: ''
+  };
+};

package.json

 {
   "name": "node-device-detector",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Nodejs device detector (port Piwik)",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "coverage": "istanbul cover --report html ./node_modules/mocha/bin/_mocha -- -R spec tests/*.spec.js",
+    "test": "mocha -- -R spec tests/*.spec.js"
   },
@@ -15,7 +16,7 @@ "repository": {
     "device-detector",
-	"detect mobile", 
-	"detect tablet",
-	"detect os",
-	"detect device brand", 
-	"detect device model"
+    "detect mobile",
+    "detect tablet",
+    "detect os",
+    "detect device brand",
+    "detect device model"
   ],
@@ -29,3 +30,3 @@ "author": "sanchezzzhak",
   "dependencies": {
-    "yamljs": "^0.2.8"
+    "yamljs": ">=0.3.0"
   },
@@ -37,6 +38,6 @@ "devDependencies": {
     "mocha": "^3.4.2",
-    "nock": "^9.2.6",
-    "nyc": "^11.8.0",
+    "nock": "^9.6.1",
+    "nyc": "^11.9.0",
     "sinon": "^4.5.0"
   }
 }

README.md

@@ -1,10 +0,12 @@
-# node-device-detector
+# [node-device-detector](https://www.npmjs.com/package/node-device-detector)
 
+Port php lib [matomo-org/device-detector](https://github.com/matomo-org/device-detector) to NodeJs
 
-port phplib piwik/device-detector from nodejs
+### !!! library works only under nodejs v10+
 
-### library works only under nodejs v10+
 
 ### Install
+
 local install production
+
 ```
@@ -22,15 +24,56 @@ npm install node-device-detector --production
 const DeviceDetector = require('node-device-detector');
+const userAgent = 'Mozilla/5.0 (Linux; Android 5.0; NX505J Build/KVT49L) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.78 Mobile Safari/537.36';
+const detector = new DeviceDetector;
 
-let userAgent = 'Mozilla/5.0 (Linux; Android 5.0; NX505J Build/KVT49L) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.78 Mobile Safari/537.36';
-let detector = new DeviceDetector;
+console.log(detector.detect(userAgent));
+console.log('helper methods check type device');
+console.log('isDesktop', detector.isDesktop()); // false
+console.log('isTabled', detector.isTabled()); // false
+console.log('isPhablet', detector.isPhablet()); // false
+console.log('isIOS', detector.isIOS()); // false
+console.log('isAndroid', detector.isAndroid()); // true
+console.log('isMobile', detector.isMobile()); // true
 
-console.log(detector.detect(userAgent));
 ```
+
 ### Result parse
+
 ```json
+{
+	"os" : {
+		"short_name" : "AND",
+		"name" : "Android",
+		"version" : "5.0",
+		"platform" : "",
+		"family" : "Android"
+	},
+	"device" : {
+		"id" : "",
+		"type" : "smartphone",
+		"brand" : "ZTE",
+		"model" : "Nubia Z7 max"
+	},
+	"client" : {
+		"engine" : "Blink",
+		"engine_version" : "",
+		"short_name" : "CM",
+		"name" : "Chrome Mobile",
+		"version" : "43.0.2357.78",
+		"type" : "browser"
+	}
+}
+```
+
+Result is not detect
+```json
 { 
-    device: { brand: 'ZTE', model: 'Nubia Z7 max', type: 'smartphone' },
-    os: { name: 'Android', version: '5.0' },
-    browser: { name: 'Chrome Mobile', version: '43.0.2357.78' } 
+  "os": null,
+  "device": {
+    "id": "",
+    "type" : "is type detect not empty attr",
+    "brand": "",
+    "model": ""
+  },
+  "client": null
 }
 ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Number of package files

68

increased by74.36%

Lines of code

1428

increased by106.06%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

78

increased by122.86%

Number of low supply chain risk alerts

1

decreased by-80%

Worsened metrics

Total package byte prevSize

3190323

decreased by-15.12%

Dependency changes

• + Addedyamljs@0.3.0(transitive)

• - Removedyamljs@0.2.10(transitive)

• Updatedyamljs@>=0.3.0