fiftyone.devicedetection.shared 4.4.78 → 4.4.95

package/{index_dev.js → examples/dataExtension.js}

@@ -20,15 +20,24 @@
  * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
-/*
-This file is used for development package.
-*/
+class DataExtension {
+  // Helper function to read property values from flowData
+  static getValueHelper (elementData, propertyName) {
+    try {
+      const property = elementData[propertyName];
+      if (property && property.hasValue) {
+        if (Array.isArray(property.value)) {
+          return property.value.join(', ');
+        } else {
+          return property.value;
+        }
+      } else {
+        return `Unknown (${property.noValueMessage})`;
+      }
+    } catch (e) {
+      return `Unknown (${e})`;
+    }
+  };
+}
 
-module.exports = {
-  errorMessages: require('./errorMessages'),
-  testConstants: require('./tests/testConstants'),
-  keyUtils: require('./tests/keyUtils'),
-  exampleConstants: require('./examples/exampleConstants'),
-  optionsExtension: require('./examples/optionsExtension'),
-  dataExtension: require('./examples/dataExtension')
-};
+module.exports = DataExtension;

package/examples/exampleConstants.js

@@ -0,0 +1,59 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
+ * ********************************************************************* */
+
+module.exports = {
+  // This collection contains the various input values that will
+  // be used when running the examples.
+  defaultEvidenceValues: [
+    // A User-Agent from a mobile device.
+    new Map([
+      ['header.user-agent', 'Mozilla/5.0 (Linux; Android 9; SAMSUNG SM-G960U) ' +
+        'AppleWebKit/537.36 (KHTML, like Gecko) ' +
+        'SamsungBrowser/10.1 Chrome/71.0.3578.99 Mobile ' +
+        'Safari/537.36']
+    ]),
+    // A User-Agent from a desktop device.
+    new Map([
+      ['header.user-agent', 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) ' +
+        'AppleWebKit/537.36 (KHTML, like Gecko) ' +
+        'Chrome/78.0.3904.108 Safari/537.36']
+    ]),
+    // Evidence values from a windows 11 device using a browser
+    // that supports User-Agent Client Hints.
+    new Map([
+      ['header.user-agent', 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) ' +
+        'AppleWebKit/537.36 (KHTML, like Gecko) ' +
+        'Chrome/98.0.4758.102 Safari/537.36'],
+      ['header.sec-ch-ua-mobile', '?0'],
+      ['header.sec-ch-ua', '" Not A; Brand";v="99", "Chromium";v="98", ' +
+        '"Google Chrome";v="98"'],
+      ['header.sec-ch-ua-platform', '"Windows"'],
+      ['header.sec-ch-ua-platform-version', '"14.0.0"']
+    ])
+  ],
+  fileNames: {
+    enterpriseDataFileName: 'Enterprise-HashV41.hash',
+    liteDataFileName: '51Degrees-LiteV4.1.hash',
+    uaFileName: '20000 User Agents.csv',
+    evidenceFileName: '20000 Evidence Records.yml'
+  }
+};

package/examples/optionsExtension.js

@@ -0,0 +1,95 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
+ * ********************************************************************* */
+
+const CLOUD_REQUEST_ENGINE_NAME = 'cloudRequestEngine';
+
+const ONPREMISE_DEVICE_ENGINE = 'deviceDetectionOnPremise';
+
+class OptionsExtension {
+  static getElement (options, elementName) {
+    if (options.PipelineOptions) {
+      if (options.PipelineOptions.Elements) {
+        for (const e of options.PipelineOptions.Elements) {
+          if (e.elementName &&
+            e.elementName.endsWith(elementName)) {
+            return e;
+          }
+        }
+      }
+    }
+  }
+
+  static getDataFilePath (options) {
+    const cloudRequestElement = this.getElement(options, ONPREMISE_DEVICE_ENGINE);
+    if (cloudRequestElement &&
+      cloudRequestElement.elementParameters &&
+      cloudRequestElement.elementParameters.dataFilePath) {
+      return cloudRequestElement.elementParameters.dataFilePath;
+    }
+  }
+
+  static setDataFilePath (options, newDataFilePath) {
+    const cloudRequestElement = this.getElement(options, ONPREMISE_DEVICE_ENGINE);
+    if (cloudRequestElement) {
+      if (!cloudRequestElement.elementParameters) {
+        cloudRequestElement.elementParameters = { dataFilePath: newDataFilePath };
+      } else {
+        cloudRequestElement.elementParameters.dataFilePath = newDataFilePath;
+      }
+    }
+  }
+
+  static updateElementPath (options, appendDir) {
+    if (options.PipelineOptions) {
+      if (options.PipelineOptions.Elements) {
+        for (const e of options.PipelineOptions.Elements) {
+          if (e.elementName &&
+            e.elementName.startsWith('.')) {
+            e.elementName = appendDir + '/' + e.elementName;
+          }
+        }
+      }
+    }
+  }
+
+  static getResourceKey (options) {
+    const cloudRequestElement = this.getElement(options, CLOUD_REQUEST_ENGINE_NAME);
+    if (cloudRequestElement &&
+      cloudRequestElement.elementParameters &&
+      cloudRequestElement.elementParameters.resourceKey) {
+      return cloudRequestElement.elementParameters.resourceKey;
+    }
+  }
+
+  static setResourceKey (options, resourceKey) {
+    const cloudRequestElement = this.getElement(options, CLOUD_REQUEST_ENGINE_NAME);
+    if (cloudRequestElement) {
+      if (!cloudRequestElement.elementParameters) {
+        cloudRequestElement.elementParameters = { resourceKey };
+      } else {
+        cloudRequestElement.elementParameters.resourceKey = resourceKey;
+      }
+    }
+  }
+}
+
+module.exports = OptionsExtension;

package/index.js

@@ -1,29 +1,34 @@
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 /*
-This file is used for release package.
+This file is used for development package.
 */
 
 module.exports = {
-  errorMessages: require('./errorMessages')
+  errorMessages: require('./errorMessages'),
+  testConstants: require('./tests/testConstants'),
+  keyUtils: require('./tests/keyUtils'),
+  exampleConstants: require('./examples/exampleConstants'),
+  optionsExtension: require('./examples/optionsExtension'),
+  dataExtension: require('./examples/dataExtension')
 };

package/package.json

@@ -1,31 +1,42 @@
 {
   "name": "fiftyone.devicedetection.shared",
-  "version": "4.4.78",
+  "version": "4.4.95",
   "description": "Shared functionality for implementing device detection engine for the 51Degrees Pipeline API",
+  "keywords": [
+    "51degrees",
+    "device detection",
+    "user-agent",
+    "client hints",
+    "browser",
+    "os",
+    "device",
+    "cpu",
+    "mobile",
+    "phone",
+    "tablet",
+    "tv",
+    "bot",
+    "crawler",
+    "WURFL",
+    "DeviceAtlas"
+  ],
   "main": "index.js",
   "types": "types/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/51Degrees/device-detection-node"
   },
-  "author": "51Degrees",
-  "contributors": [
-    "Filip Hnízdo <filip@octophin.com> (https://octophindigital.com/)",
-    "Steve Ballantine <stephen@51degrees.com> (https://51degrees.com)",
-    "Ben Shilito <ben@51degrees.com> (https://51degrees.com)",
-    "Joseph Dix <joseph@51degrees.com> (https://51degrees.com)",
-    "Tung Pham <tung@51degrees.com> (https://51degrees.com)"
-  ],
+  "author": "51Degrees Engineering <engineering@51degrees.com>",
   "devDependencies": {
-    "eslint": "^8.48.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jest": "^26.9.0",
+    "eslint": "^8.16.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jsdoc": "^38.1.6",
-    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.1.1",
-    "jest": "^28.1.3",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-jest": "^26.2.2",
+    "eslint-plugin-n": "^15.0.0",
+    "jest": "^28.1.0",
     "jest-junit": "^13.2.0"
   },
   "license": "EUPL-1.2",
@@ -33,6 +44,8 @@
     "url": "https://github.com/51Degrees/device-detection-node/issues"
   },
   "files": [
+    "examples",
+    "tests",
     "*.js"
   ]
 }

package/tests/keyUtils.js

@@ -0,0 +1,56 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
+ * ********************************************************************* */
+
+/**
+ * Helpers to obtain keys from the environment
+ */
+module.exports = {
+  /**
+   * Obtain a key either from environment variable or from a property.
+   * Try resource key as env var, then as upper case env var, the system property
+   * @param keyName
+   */
+  getNamedKey: function (keyName) {
+    let value = process.env[keyName];
+    if (!value) {
+      value = process.env[keyName.toUpperCase()];
+    }
+    return value;
+  },
+
+  /**
+   * Evaluate whether a key might be valid
+   * @param keyValue value to test
+   * @returns boolean
+   */
+  isInvalidKey: function (keyValue) {
+    try {
+      const buff = Buffer.from(keyValue, 'base64');
+      const decoded = buff.toString('ascii');
+      return !keyValue ||
+        keyValue.trim().length < 19 ||
+        decoded.length < 14;
+    } catch (e) {
+      return true;
+    }
+  }
+};

package/tests/testConstants.js

@@ -0,0 +1,48 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
+ * ********************************************************************* */
+
+module.exports = {
+  // Environment variables name for testing
+  envVars: {
+    superResourceKeyEnvVar: 'TEST_SUPER_RESOURCE_KEY',
+    platformResourceKeyEnvVar: 'TEST_PLATFORM_RESOURCE_KEY',
+    hardwareResourceKeyEnvVar: 'TEST_HARDWARE_RESOURCE_KEY',
+    browserResourceKeyEnvVar: 'TEST_BROWSER_RESOURCE_KEY',
+    noSetHeaderResourceKeyEnvVar: 'TEST_NO_SETHEADER_RESOURCE_KEY',
+    licenseKeyEnvVar: 'TEST_LICENSE_KEY'
+  },
+  // User-Agent string for testing
+  userAgents: {
+    chromeUA: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) ' +
+      'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 ' +
+      'Safari/537.36',
+    edgeUA: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) ' +
+      'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 ' +
+      'Safari/537.36 Edg/95.0.1020.44',
+    firefoxUA: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:94.0) ' +
+      'Gecko/20100101 Firefox/94.0',
+    safariUA: 'Mozilla/5.0 (iPhone; CPU iPhone OS 15_1 like Mac OS X) ' +
+      'AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.0 ' +
+      'Mobile/15E148 Safari/604.1',
+    curlUA: 'curl/7.80.0'
+  }
+};