fiftyone.devicedetection.onpremise 4.4.2 → 4.4.6

package/component.js

@@ -0,0 +1,39 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2022 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.
+ * ********************************************************************* */
+
+class Component {
+  constructor (metadata, engineMetadata) {
+    this.metadata = metadata;
+    this.engineMetadata = engineMetadata;
+    this.name = metadata.getName();
+    this.properties = engineMetadata.getPropertiesForComponent(metadata);
+  }
+
+  * getProperties () {
+    const Property = require('./property');
+    for (let i = 0; i < this.properties.getSize(); i++) {
+      yield new Property(this.properties.getByIndex(i), this.engineMetadata);
+    }
+  }
+}
+
+module.exports = Component;

package/constants.js

@@ -1,10 +1,10 @@
 /* *********************************************************************
  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
- * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ * Copyright 2022 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.
+ * 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.

package/dataFileMissingPropertyService.js

@@ -1,10 +1,10 @@
 /* *********************************************************************
  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
- * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ * Copyright 2022 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.
+ * 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.

package/deviceDetectionDataFile.js

@@ -1,10 +1,10 @@
 /* *********************************************************************
  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
- * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ * Copyright 2022 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.
+ * 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.

package/deviceDetectionOnPremise.js

@@ -1,10 +1,10 @@
 /* *********************************************************************
  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
- * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ * Copyright 2022 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.
+ * 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.
@@ -34,6 +34,10 @@ const EvidenceKeyFilter = core.BasicListEvidenceKeyFilter;
 const fs = require('fs');
 const util = require('util');
 const constants = require('./constants');
+const metricCategory = 'Device metrics';
+const Component = require('./component');
+const Property = require('./property');
+const Profile = require('./profile');
 
 /**
  * @typedef {import('fiftyone.pipeline.engines').DataKeyedCache} DataKeyedCache
@@ -43,6 +47,120 @@ const constants = require('./constants');
 
 const nodeVersion = Number(process.version.match(/^v(\d+\.)/)[1]);
 
+// Private method to init properties.
+// This should only be called by the call() method with an input for 'this'
+// object.
+const initProperties = function (metadata) {
+  const propertiesInternal = metadata.getProperties();
+  const properties = {};
+
+  for (var i = 0; i < propertiesInternal.getSize(); i++) {
+    var property = propertiesInternal.getByIndex(i);
+    if (property.getAvailable()) {
+      properties[property.getName().toLowerCase()] =
+        new Property(property, metadata);
+    }
+  };
+  this.properties = properties;
+};
+
+// Private method to init components
+// This should only be called by the call() method with an input for 'this'
+// object.
+const initComponents = function (metadata) {
+  // Get components list
+  const componentsInternal = metadata.getComponents();
+
+  const components = {};
+  for (let i = 0; i < componentsInternal.getSize(); i++) {
+    const component = componentsInternal.getByIndex(i);
+    components[component.getName().toLowerCase()] =
+      new Component(component, metadata);
+  }
+  this.components = components;
+};
+
+const initMatchMetrics = function () {
+  // Add a component for Device Metrics
+  const metricComponent = {
+    name: 'Metrics'
+  };
+  metricComponent.getProperties = function * (limit) {
+    for (const property of metricComponent.properties) {
+      yield property;
+    }
+  };
+
+  // Special properties
+  this.properties.deviceID = {
+    name: 'DeviceId',
+    type: 'string',
+    category: metricCategory,
+    description: constants.deviceIdDescription,
+    component: metricComponent
+  };
+
+  this.properties.userAgents = {
+    name: 'UserAgents',
+    type: 'string[]',
+    category: metricCategory,
+    description: constants.userAgentsDescription,
+    component: metricComponent
+  };
+
+  this.properties.difference = {
+    name: 'Difference',
+    type: 'int',
+    category: metricCategory,
+    description: constants.differenceDescription,
+    component: metricComponent
+  };
+
+  this.properties.method = {
+    name: 'Method',
+    type: 'string',
+    category: metricCategory,
+    description: constants.methodDescription,
+    component: metricComponent
+  };
+
+  this.properties.matchedNodes = {
+    name: 'MatchedNodes',
+    type: 'int',
+    category: metricCategory,
+    description: constants.matchedNodesDescription,
+    component: metricComponent
+  };
+
+  this.properties.drift = {
+    name: 'Drift',
+    type: 'int',
+    category: metricCategory,
+    description: constants.driftDescription,
+    component: metricComponent
+  };
+
+  this.properties.iterations = {
+    name: 'Iterations',
+    type: 'int',
+    category: metricCategory,
+    description: constants.iterationsDescription,
+    component: metricComponent
+  };
+
+  metricComponent.properties = [
+    this.properties.deviceID,
+    this.properties.userAgents,
+    this.properties.difference,
+    this.properties.method,
+    this.properties.matchedNodes,
+    this.properties.drift,
+    this.properties.iterations
+  ];
+
+  this.components.metrics = metricComponent;
+};
+
 /**
  * On premise version of the 51Degrees Device Detection Engine
  * Uses a data file to process evidence in FlowData and create results
@@ -323,77 +441,10 @@ class DeviceDetectionOnPremise extends Engine {
 
         // Get properties list
 
-        const propertiesInternal = engine.getMetaData().getProperties();
-
-        const properties = {};
-
-        for (var i = 0; i < propertiesInternal.getSize(); i++) {
-          var property = propertiesInternal.getByIndex(i);
-          if (property.getAvailable()) {
-            properties[property.getName().toLowerCase()] = {
-              name: property.getName(),
-              type: property.getType(),
-              datafiles: swigHelpers.vectorToArray(property.getDataFilesWherePresent()),
-              category: property.getCategory(),
-              description: property.getDescription()
-            };
-          }
-        };
-
-        current.properties = properties;
-
-        // Special properties
-
-        current.properties.deviceID = {
-          name: 'DeviceId',
-          type: 'string',
-          category: 'Device metrics',
-          description: constants.deviceIdDescription
-        };
-
-        current.properties.userAgents = {
-          name: 'UserAgents',
-          type: 'string[]',
-          category: 'Device metrics',
-          description: constants.userAgentsDescription
-        };
-
-        current.properties.difference = {
-          name: 'Difference',
-          type: 'int',
-          category: 'Device metrics',
-          description: constants.differenceDescription
-        };
-
-        current.properties.method = {
-          name: 'Method',
-          type: 'string',
-          category: 'Device metrics',
-          description: constants.methodDescription
-        };
-
-        if (swigWrapperType === 'Hash') {
-          current.properties.matchedNodes = {
-            name: 'MatchedNodes',
-            type: 'int',
-            category: 'Device metrics',
-            description: constants.matchedNodesDescription
-          };
-
-          current.properties.drift = {
-            name: 'Drift',
-            type: 'int',
-            category: 'Device metrics',
-            description: constants.driftDescription
-          };
-
-          current.properties.iterations = {
-            name: 'Iterations',
-            type: 'int',
-            category: 'Device metrics',
-            description: constants.iterationsDescription
-          };
-        }
+        const metadata = engine.getMetaData();
+        initProperties.call(current, metadata);
+        initComponents.call(current, metadata);
+        initMatchMetrics.call(current);
       });
     };
 
@@ -473,6 +524,14 @@ class DeviceDetectionOnPremise extends Engine {
     this.registerDataFile(ddDatafile);
   }
 
+  * profiles () {
+    const engineMetadata = this.engine.getMetaData();
+    const profilesInternal = engineMetadata.getProfiles();
+    for (let i = 0; i < profilesInternal.getSize(); i++) {
+      yield new Profile(profilesInternal.getByIndex(i), engineMetadata);
+    }
+  }
+
   /**
    * Internal process method for Device Detection On Premise engine
    * Fetches the results from the SWIG wrapper into an instance of

package/deviceDetectionOnPremisePipelineBuilder.js

@@ -1,10 +1,10 @@
 /* *********************************************************************
  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
- * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ * Copyright 2022 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.
+ * 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.

package/index.js

@@ -1,10 +1,10 @@
 /* *********************************************************************
  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
- * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ * Copyright 2022 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.
+ * 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.devicedetection.onpremise",
-  "version": "4.4.2",
+  "version": "4.4.6",
   "description": "Device detection on-premise services for the 51Degrees Pipeline API",
   "main": "index.js",
   "directories": {
@@ -22,23 +22,25 @@
     "Tung Pham <tung@51degrees.com> (https://51degrees.com)"
   ],
   "dependencies": {
-    "fiftyone.devicedetection.shared": "^4.4.2",
-    "fiftyone.pipeline.core": "^4.4.0",
-    "fiftyone.pipeline.engines": "^4.4.0",
-    "fiftyone.pipeline.engines.fiftyone": "^4.4.0",
+    "fiftyone.devicedetection.shared": "^4.4.7",
+    "fiftyone.pipeline.core": "^4.4.1",
+    "fiftyone.pipeline.engines": "^4.4.1",
+    "fiftyone.pipeline.engines.fiftyone": "^4.4.1",
+    "js-yaml": "^4.1.0",
     "n-readlines": "^1.0.1"
   },
   "devDependencies": {
-    "eslint": "^6.8.0",
-    "eslint-config-standard": "^14.1.1",
-    "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-jsdoc": "^25.4.0",
+    "@types/node": "^15.12.2",
+    "eslint": "^8.16.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsdoc": "^38.1.6",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.1",
-    "eslint-plugin-jest": "^23.13.2",
-    "jest": "^24.9.0",
-    "jest-junit": "^9.0.0"
+    "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",
   "bugs": {

package/profile.js

@@ -0,0 +1,35 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2022 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.
+ * ********************************************************************* */
+
+class Profile {
+  constructor (metadata, engineMetadata) {
+    this.metadata = metadata;
+    this.engineMetadata = engineMetadata;
+
+    const Component = require('./component');
+    this.component = new Component(
+      engineMetadata.getComponentForProfile(metadata), engineMetadata);
+    this.profileId = metadata.getProfileId();
+  }
+}
+
+module.exports = Profile;

package/property.js

@@ -0,0 +1,54 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2022 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 swigHelpers = require('./swigHelpers');
+
+class Property {
+  constructor (
+    metadata,
+    engineMetadata) {
+    this.metadata = metadata;
+    this.engineMetadata = engineMetadata;
+    this.name = metadata.getName();
+    this.type = metadata.getType();
+    this.dataFiles = swigHelpers.vectorToArray(metadata.getDataFilesWherePresent());
+    this.category = metadata.getCategory();
+    this.description = metadata.getDescription();
+
+    const Component = require('./component');
+    this.component = new Component(
+      engineMetadata.getComponentForProperty(metadata), engineMetadata);
+    this.values = engineMetadata.getValuesForProperty(metadata);
+  }
+
+  * getValues () {
+    for (let i = 0; i < this.values.getSize(); i++) {
+      yield this.values.getByIndex(i);
+    }
+  }
+
+  getNumberOfValues () {
+    return this.values.getSize();
+  }
+}
+
+module.exports = Property;

package/swigData.js

@@ -1,10 +1,10 @@
 /* *********************************************************************
  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
- * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ * Copyright 2022 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.
+ * 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.

package/swigHelpers.js

@@ -1,10 +1,10 @@
 /* *********************************************************************
  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
- * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ * Copyright 2022 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.
+ * 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.