fiftyone.pipeline.engines.fiftyone 4.4.92 → 4.4.93

package/examples/usageSharing/usageSharing.js

@@ -1,59 +1,55 @@
-/* *********************************************************************
- * 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.
  * ********************************************************************* */
 
 /**
-@example usageSharing/usageSharing.js
-
-@include{doc} example-usage-sharing-intro.txt
-
-Usage sharing is enabled by default if using some 51Degrees pipeline
-builders such as the [DeviceDetectionOnPremisePipelineBuilder](https://github.com/51Degrees/device-detection-node/blob/master/fiftyone.devicedetection.onpremise/deviceDetectionOnPremisePipelineBuilder.js)
-In this example, we show how to specifically add a shareUsage element to a
-Pipeline using configuration.
-
-As with all flow elements, this can also be handled in code, using
-the constructor parameters. The commented section in the example
-demonstrates this.
-
-The 51d.json file contains all the configuration options.
-These are all optional, so each can be omitted if the default
-for that option is sufficient:
-
-@include usageSharing/51d.json
-
-For details of what each setting does, see the constructor
-parameters in the reference documentation for the
-[share usage element](https://51degrees.com/pipeline-node/class_share_usage.html)
-
-This example is available in full on [GitHub](https://github.com/51Degrees/pipeline-node/tree/master/fiftyone.pipeline.engines.fiftyone/examples/usageSharing/usageSharing.js).
-
-Expected output
-```
-Constructing pipeline from configuration file.
-
-Pipeline created with share usage element. Evidence processed
-with this pipeline will now be shared with 51Degrees using the
-specified configuration.
-```
+ * @example usageSharing/usageSharing.js
+ *
+ * Usage sharing is enabled by default if using some 51Degrees pipeline
+ * builders such as the [DeviceDetectionOnPremisePipelineBuilder](https://github.com/51Degrees/device-detection-node/blob/master/fiftyone.devicedetection.onpremise/deviceDetectionOnPremisePipelineBuilder.js)
+ * In this example, we show how to specifically add a shareUsage element to a
+ * Pipeline using configuration.
+ *
+ * As with all flow elements, this can also be handled in code, using
+ * the constructor parameters. The commented section in the example
+ * demonstrates this.
+ *
+ * The 51d.json file contains all the configuration options.
+ * These are all optional, so each can be omitted if the default
+ * for that option is sufficient:
+ *
+ * For details of what each setting does, see the constructor
+ * parameters in the reference documentation for the
+ * [share usage element](https://51degrees.com/pipeline-node/class_share_usage.html)
+ *
+ * This example is available in full on [GitHub](https://github.com/51Degrees/pipeline-node/tree/master/fiftyone.pipeline.engines.fiftyone/examples/usageSharing/usageSharing.js).
+ *
+ * Expected output
+ * ```
+ * Constructing pipeline from configuration file.
+ *
+ * Pipeline created with share usage element. Evidence processed
+ * with this pipeline will now be shared with 51Degrees using the
+ * specified configuration.
+ * ```
  */
 
 const core = require('fiftyone.pipeline.core');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.pipeline.engines.fiftyone",
-  "version": "4.4.92",
+  "version": "4.4.93",
   "description": "Shared base functions for implementing 51Degrees engines for the 51Degrees Pipeline API",
   "keywords": [
     "51degrees",

package/shareUsage.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 engines = require('fiftyone.pipeline.engines');
@@ -73,7 +73,8 @@ class ShareUsage extends Engine {
    * be excluded from sharing by adding them to this list.
    * @param {number} options.sharePercentage approximate proportion of
    * requests to be shared. 1 = 100%, 0.5 = 50%, etc..
-   * @param options.endpoint
+   * @param {string} options.endpoint The target destination for usage
+   * sharing data. The default is https://devices-v4.51degrees.com/new.ashx.
    */
   constructor (
     {
@@ -146,7 +147,7 @@ class ShareUsage extends Engine {
    * within the flow data provided.
    *
    * @param {FlowData} flowData the flow data containing the evidence to use
-   * @returns a new ShareUsageData instance, populated from the evidence
+   * @returns {ShareUsageData} New ShareUsageData instance, populated from the evidence
    * provided
    */
   getDataFromEvidence (flowData) {
@@ -312,7 +313,7 @@ class ShareUsage extends Engine {
    * If the list is null then populate from the pipeline.
    * If there are multiple or no pipelines then log an error.
    *
-   * @returns list of flow elements
+   * @returns {Array<FlowElement>} list of flow elements
    */
   getFlowElements () {
     if (!this.flowElements) {
@@ -344,11 +345,12 @@ const VALID_XML_CHARS =
     .concat(
       Array.from({ length: parseInt('0x100', 16) - parseInt('0x40', 16) }, (v, k) => k + parseInt('0x40', 16)));
 
-// an array describing whether a character value is valid
 const IS_VALID_XML_CHAR = __getIsValidCharMap();
 
 /**
+ * Get an object describing whether a character value is valid
  *
+ * @returns {object} Object of valid chars
  */
 function __getIsValidCharMap () {
   const maxChar = parseInt('0x100', 16);

package/tests/shareUsage.test.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 { PipelineBuilder } = require('fiftyone.pipeline.core');
@@ -36,8 +36,8 @@ let server = null;
 /**
  * Local server used to capture usage data sent.
  *
- * @param req the request
- * @param res the response
+ * @param {http.IncomingMessage} req the request
+ * @param {http.ServerResponse} res the response
  */
 const requestListener = function (req, res) {
   let data = '';