fiftyone.devicedetection.cloud 4.4.128 → 4.4.129

package/deviceDetectionCloud.js

@@ -18,21 +18,24 @@
  * 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 CloudEngine = require('fiftyone.pipeline.cloudrequestengine').CloudEngine;
-
-/**
- * The deviceDetction cloud engine requires the 51Degrees
- * cloudRequestEngine to be placed in a pipeline before it.
- * It takes that raw JSON response and parses it to extract the
- * device part. It also uses this data to generate a list of properties
- **/
-class DeviceDetectionCloud extends CloudEngine {
-  constructor () {
-    super(...arguments);
-    this.dataKey = 'device';
-  }
-}
-
-module.exports = DeviceDetectionCloud;
+ * ********************************************************************* */
+
+const CloudEngine = require('fiftyone.pipeline.cloudrequestengine').CloudEngine;
+
+/**
+ * The deviceDetction cloud engine requires the 51Degrees
+ * cloudRequestEngine to be placed in a pipeline before it.
+ * It takes that raw JSON response and parses it to extract the
+ * device part. It also uses this data to generate a list of properties
+ **/
+class DeviceDetectionCloud extends CloudEngine {
+  /**
+   * Constructor for DeviceDetectionCloud
+   */
+  constructor () {
+    super(...arguments);
+    this.dataKey = 'device';
+  }
+}
+
+module.exports = DeviceDetectionCloud;

package/deviceDetectionCloudPipelineBuilder.js

@@ -1,23 +1,23 @@
-/* *********************************************************************
- * 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.
  * ********************************************************************* */
 
 const core = require('fiftyone.pipeline.core');
@@ -26,11 +26,14 @@ const CloudRequestEngine = require('fiftyone.pipeline.cloudrequestengine').Cloud
 const PipelineBuilder = core.PipelineBuilder;
 const LruCache = require('fiftyone.pipeline.engines').LruCache;
 
+/**
+ * Extension of pipelineBuilder class that allows for the quick
+ * generation of a device detection cloud pipeline. Adds share usage,
+ * caching.
+ */
 class DeviceDetectionCloudPipelineBuilder extends PipelineBuilder {
   /**
-   * Extension of pipelineBuilder class that allows for the quick
-   * generation of a device detection cloud pipeline. Adds share usage,
-   * caching.
+   * Constructor for DeviceDetectionCloudPipelineBuilder
    *
    * @param {object} options the options for the pipeline builder
    * @param {string} options.licenceKeys license key(s) used by the

package/hardwareProfileCloudEngine.js

@@ -1,36 +1,53 @@
-/* *********************************************************************
- * 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.
  * ********************************************************************* */
 
+/**
+ * @typedef {import('fiftyone.pipeline.core').FlowData} FlowData
+ */
+
 const CloudEngine = require('fiftyone.pipeline.cloudrequestengine').CloudEngine;
 
 const AspectPropertyValue = require('fiftyone.pipeline.core').AspectPropertyValue;
 const AspectDataDictionary = require('fiftyone.pipeline.engines').AspectDataDictionary;
 
+/**
+ * This Cloud Aspect Engine enables the parsing of 'hardware profile'
+ * responses from the 51Degrees cloud service.
+ */
 class HardwareProfileCloudEngine extends CloudEngine {
+  /**
+   * Constructor for HardwareProfileCloudEngine
+   */
   constructor () {
     super(...arguments);
     this.dataKey = 'hardware';
   }
 
+  /**
+   * Process internal FlowData cloud data for devices,
+   * set them as FlowData elements
+   *
+   * @param {FlowData} flowData The FlowData object
+   */
   processInternal (flowData) {
     const engine = this;
 

package/index.js

@@ -18,12 +18,11 @@
  * 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 = {
-
-  DeviceDetectionCloud: require('./deviceDetectionCloud'),
-  DeviceDetectionCloudPipelineBuilder: require('./deviceDetectionCloudPipelineBuilder'),
-  HardwareProfileCloudEngine: require('../fiftyone.devicedetection.cloud/hardwareProfileCloudEngine')
-
-};
+ * ********************************************************************* */
+
+module.exports = {
+  DeviceDetectionCloud: require('./deviceDetectionCloud'),
+  DeviceDetectionCloudPipelineBuilder: require('./deviceDetectionCloudPipelineBuilder'),
+  HardwareProfileCloudEngine: require('../fiftyone.devicedetection.cloud/hardwareProfileCloudEngine')
+
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.devicedetection.cloud",
-  "version": "4.4.128",
+  "version": "4.4.129",
   "description": "Device detection cloud services for the 51Degrees Pipeline API",
   "keywords": [
     "51degrees",