fiftyone.devicedetection.onpremise 4.4.127 → 4.4.129

package/component.js

@@ -18,22 +18,41 @@
  * 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;
+ * ********************************************************************* */
+
+class Component {
+  /**
+   *  Constructor for Component
+   *
+   * @param {object} metadata Metadata
+   * @param {object} engineMetadata Engine metadata
+   */
+  constructor (metadata, engineMetadata) {
+    this.metadata = metadata;
+    this.engineMetadata = engineMetadata;
+    /**
+     * @type {string}
+     */
+    this.name = metadata.getName();
+    /**
+     * @type {object}
+     */
+    this.properties = engineMetadata.getPropertiesForComponent(metadata);
+  }
+
+  /**
+   * Yield component properties
+   *
+   * @generator
+   * @yields {Property}
+   * @returns {void}
+   */
+  * 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/deviceDetectionDataFile.js

@@ -31,14 +31,19 @@ const DataFile = engines.DataFile;
  * update url which contains the product, type and licensekeys.
  * These paramaters are passed in to the datafile constructor's
  * updateURLParams parameter
- *
- * @param {string} options.useUrlFormatter whether to append default URL params for Data File download
  **/
 class DeviceDetectionDataFile extends DataFile {
+  /**
+   * Constructor for Device Detection DataFile
+   *
+   * @param {object} options options for the datafile
+   * @param {string} options.useUrlFormatter whether to append default URL params for Data File download
+   **/
   constructor ({ useUrlFormatter = true, ...rest }) {
     super({ ...rest });
     this.useUrlFormatter = useUrlFormatter;
   }
+
   /**
    * Uses the product, type and licensekey parameters the datafile
    * was constructed with to generate a querystring used in the datafile
@@ -46,7 +51,6 @@ class DeviceDetectionDataFile extends DataFile {
    *
    * @returns {string} url
    */
-
   urlFormatter () {
     const queryParams = {
       Product: this.updateURLParams.product,

package/deviceDetectionOnPremise.js

@@ -43,6 +43,14 @@ const Profile = require('./profile');
  * @typedef {import('fiftyone.pipeline.engines').DataKeyedCache} DataKeyedCache
  */
 
+/**
+ * @typedef {import('fiftyone.pipeline.engines').Engine} Engine
+ */
+
+/**
+ * @typedef {import('fiftyone.pipeline.core').FlowData} FlowData
+ */
+
 // Determine if Windows or linux and which node version
 
 const nodeVersion = Number(process.version.match(/^v(\d+\.)/)[1]);
@@ -185,7 +193,7 @@ class DeviceDetectionOnPremise extends Engine {
    * update service
    * @param {boolean} options.dataUpdateVerifyMd5 whether to check MD5 of datafile
    * @param {boolean} options.dataUpdateUseUrlFormatter whether to append default URL params for Data File download
-   * @param {Array} options.restrictedProperties list of properties the engine
+   * @param {Array<string>} options.restrictedProperties list of properties the engine
    * will be restricted to
    * @param {string} options.licenceKeys license key(s) used by the
    * data file update service. A key can be obtained from the
@@ -206,7 +214,7 @@ class DeviceDetectionOnPremise extends Engine {
    * use the same file to prevent high disk usage.
    * @param {boolean} options.updateMatchedUserAgent True if the detection
    * should record the matched characters from the target User-Agent
-   * @param {object} options.maxMatchedUserAgentLength Number of characters to
+   * @param {number} options.maxMatchedUserAgentLength Number of characters to
    * consider in the matched User-Agent. Ignored if updateMatchedUserAgent
    * is false
    * @param {number} options.drift Set maximum drift in hash position to
@@ -417,10 +425,13 @@ class DeviceDetectionOnPremise extends Engine {
 
     const current = this;
 
-    // Function for initialising the engine, wrapped like this so
-    // that an engine can be initialised once the datafile is
-    // retrieved if updateOnStart is set to true
-
+    /**
+     * Function for initialising the engine, wrapped like this so
+     * that an engine can be initialised once the datafile is
+     * retrieved if updateOnStart is set to true
+     *
+     * @returns {Promise<void>} init Engine Promise
+     */
     this.initEngine = function () {
       return new Promise(function (resolve, reject) {
         const engine = new swigWrapper['Engine' + swigWrapperType + 'Swig'](dataFilePath, config, requiredProperties);
@@ -545,7 +556,7 @@ class DeviceDetectionOnPremise extends Engine {
    * the FlowData.
    *
    * @param {FlowData} flowData FlowData to process
-   * @returns {Promise} the result of processing
+   * @returns {Promise<void>} the result of processing
    **/
   processInternal (flowData) {
     const dd = this;

package/deviceDetectionOnPremisePipelineBuilder.js

@@ -65,7 +65,7 @@ class DeviceDetectionOnPremisePipelineBuilder extends PipelineBuilder {
    * @param {number} options.cacheSize size of the default cache
    * (includes cache if set). NOTE: This is not supported for on-premise
    * engine.
-   * @param {Array} options.restrictedProperties list of properties the engine
+   * @param {Array<string>} options.restrictedProperties list of properties the engine
    * will be restricted to
    * @param {string} options.performanceProfile used to control the tradeoff
    * between performance and system memory usage (Only applies to on-premise,

package/index.js

@@ -18,13 +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 = {
-
-  DeviceDetectionOnPremise: require('./deviceDetectionOnPremise'),
-  DeviceDetectionOnPremisePipelineBuilder: require('./deviceDetectionOnPremisePipelineBuilder'),
-  SwigData: require('./swigData'),
-  swigHelpers: require('../fiftyone.devicedetection.onpremise/swigHelpers')
-
-};
+ * ********************************************************************* */
+
+module.exports = {
+  DeviceDetectionOnPremise: require('./deviceDetectionOnPremise'),
+  DeviceDetectionOnPremisePipelineBuilder: require('./deviceDetectionOnPremisePipelineBuilder'),
+  SwigData: require('./swigData'),
+  swigHelpers: require('../fiftyone.devicedetection.onpremise/swigHelpers')
+};

package/package.json

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

package/profile.js

@@ -18,18 +18,30 @@
  * 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;
+ * ********************************************************************* */
+
+class Profile {
+  /**
+   *  Constructor for Profile
+   *
+   * @param {object} metadata Metadata
+   * @param {object} engineMetadata Engine metadata
+   */
+  constructor (metadata, engineMetadata) {
+    this.metadata = metadata;
+    this.engineMetadata = engineMetadata;
+
+    const Component = require('./component');
+    /**
+     * @type {Component}
+     */
+    this.component = new Component(
+      engineMetadata.getComponentForProfile(metadata), engineMetadata);
+    /**
+     * @type {number} uint32
+     */
+    this.profileId = metadata.getProfileId();
+  }
+}
+
+module.exports = Profile;

package/property.js

@@ -1,51 +1,90 @@
-/* *********************************************************************
- * 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 swigHelpers = require('./swigHelpers');
 
 class Property {
+  /**
+   *  Constructor for Property
+   *
+   * @param {object} metadata Metadata
+   * @param {object} engineMetadata Engine metadata
+   */
   constructor (
     metadata,
     engineMetadata) {
     this.metadata = metadata;
     this.engineMetadata = engineMetadata;
+    /**
+     * @type {string}
+     */
     this.name = metadata.getName();
+    /**
+     * @type {string}
+     */
     this.type = metadata.getType();
+    /**
+     * @type {Array<string>}
+     */
     this.dataFiles = swigHelpers.vectorToArray(metadata.getDataFilesWherePresent());
+    /**
+     * @type {string}
+     */
     this.category = metadata.getCategory();
+    /**
+     * @type {string}
+     */
     this.description = metadata.getDescription();
 
     const Component = require('./component');
+    /**
+     * @type {Component}
+     */
     this.component = new Component(
       engineMetadata.getComponentForProperty(metadata), engineMetadata);
+    /**
+     * @type {object}
+     */
     this.values = engineMetadata.getValuesForProperty(metadata);
   }
 
+  /**
+   * Yield property values
+   *
+   * @generator
+   * @yields {object}
+   * @returns {void}
+   */
   * getValues () {
     for (let i = 0; i < this.values.getSize(); i++) {
       yield this.values.getByIndex(i);
     }
   }
 
+  /**
+   * Get number of values in the property
+   *
+   * @returns {number} uint32
+   */
   getNumberOfValues () {
     return this.values.getSize();
   }

package/swigData.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 AspectData = require('fiftyone.pipeline.engines').AspectData;
@@ -43,7 +43,7 @@ class SwigData extends AspectData {
    * @param {object} options options object
    * @param {FlowElement} options.flowElement the FlowElement the
    * data is part of
-   * @param {ResultsHashSwig} options.swigResults the results from the
+   * @param {object} options.swigResults the results from the
    * swig engine
    */
   constructor ({
@@ -59,7 +59,7 @@ class SwigData extends AspectData {
    * correct type via a check of the engine's property list metadata
    *
    * @param {string} key the property key to retrieve
-   * @returns {mixed} value property value
+   * @returns {AspectPropertyValue} value property value
    */
   getInternal (key) {
     // Start with special properties