fiftyone.pipeline.core 4.4.99 → 4.4.101

package/aspectPropertyValue.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.
  * ********************************************************************* */
 
 /**
@@ -30,7 +30,7 @@ class AspectPropertyValue {
    * Constructor for AspectPropertyValue
    *
    * @param {string} noValueMessage The message to show when no value is set
-   * @param {Mixed} value The value inside the wrapper
+   * @param {*} value The value inside the wrapper
    */
   constructor (noValueMessage = 'No value has been set.', value) {
     if (typeof value !== 'undefined') {
@@ -46,7 +46,7 @@ class AspectPropertyValue {
   /**
    * Get the value of this instance.
    *
-   * @returns {Mixed} The value of the property
+   * @returns {*} The value of the property
    * @throws Will throw error if 'hasValue' is false.
    */
   get value () {
@@ -60,7 +60,7 @@ class AspectPropertyValue {
   /**
    * Set the value of this instance.
    *
-   * @param {Mixed} value the value to set
+   * @param {*} value the value to set
    */
   set value (value) {
     if (typeof value !== 'undefined') {

package/elementData.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 util = require('util');
@@ -25,6 +25,7 @@ const errorMessages = require('./errorMessages');
 
 /**
  * @typedef {import('./flowElement')} FlowElement
+ * @typedef {import('./flowData')} FlowData
  */
 
 /**
@@ -88,7 +89,7 @@ class ElementData {
    * (or skipping) the getInternal method
    *
    * @param {string} key the key to retrieve a property value for
-   * @returns {mixed} value
+   * @returns {FlowData} value
    */
   get (key) {
     const value = this.getInternal(key);
@@ -121,7 +122,7 @@ class ElementData {
    * Return float value of property
    *
    * @param {string} key the key to retreive a property value for
-   * @returns {number} value
+   * @returns {number} float value
    */
   getAsFloat (key) {
     const result = this.get(key);
@@ -135,7 +136,7 @@ class ElementData {
    * Return int value of property
    *
    * @param {string} key the key to retreive a property value for
-   * @returns {number} value
+   * @returns {number} int value
    */
   getAsInteger (key) {
     const result = this.get(key);

package/evidence.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 url = require('url');
@@ -44,7 +44,7 @@ class Evidence {
    * Add a piece of evidence to flowData
    *
    * @param {string} key evidence key to add
-   * @param {Mixed} value value of evidence key
+   * @param {*} value value of evidence key
    */
   add (key, value) {
     // Filter out any evidence that isn't needed in the pipeline
@@ -76,7 +76,7 @@ class Evidence {
    *
    * @param {object} evidenceObject key value map of evidence
    * @param {string} evidenceObject.key evidencekey
-   * @param {Mixed} evidenceObject.value evidence value
+   * @param {*} evidenceObject.value evidence value
    */
   addObject (evidenceObject) {
     const evidenceContainer = this;
@@ -92,7 +92,7 @@ class Evidence {
    * headers, cookies, protocol, IP and query params
    *
    * @param {object} request an HTTP request object
-   * @returns {undefined}
+   * @returns {Evidence} return updated evidence
    */
   addFromRequest (request) {
     // Process headers
@@ -173,7 +173,7 @@ class Evidence {
    * Get a piece of evidence
    *
    * @param {string} key evidence key to retreive
-   * @returns {mixed} the evidence value
+   * @returns {*} the evidence value
    */
   get (key) {
     return this.evidenceStore[key];

package/flowData.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 util = require('util');
@@ -126,7 +126,7 @@ class FlowData {
    * Set an error on the flowData (usually triggered by
    * something going wrong in a flowElement's process function)
    *
-   * @param {mixed} error the error to throw
+   * @param {*} error the error to throw
    * @param {FlowElement} flowElement the FlowElement the error is thrown on
    */
   setError (error, flowElement) {

package/flowElement.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 EvidenceKeyFilterBase = require('./evidenceKeyFilter');
@@ -25,6 +25,7 @@ const EvidenceKeyFilterBase = require('./evidenceKeyFilter');
 /**
  * @typedef {import('./flowData')} FlowData
  * @typedef {import('./pipeline')} Pipeline
+ * @typedef {import('./evidenceKeyFilter')} EvidenceKeyFilter
  */
 
 /**
@@ -66,9 +67,15 @@ class FlowElement {
       this.evidenceKeyFilter = new EvidenceKeyFilterBase();
     }
 
+    /**
+     * @type {Function[]}
+     */
     this.registrationCallbacks = [];
 
     // List of pipelines the flowElement has been added to
+    /**
+     * @type {Pipeline[]}
+     */
     this.pipelines = [];
   }
 
@@ -102,7 +109,7 @@ class FlowElement {
    * by a pipleline is processsed. Overriden by instances of this base class
    *
    * @param {FlowData} flowData FlowData being processed
-   * @returns {Mixed} result of processing
+   * @returns {*} result of processing
    */
   processInternal (flowData) {
     return true;
@@ -149,6 +156,12 @@ class FlowElement {
     return this.properties;
   }
 
+  /**
+   * Internal log
+   *
+   * @param {string} type log type
+   * @param {*} message message to log
+   */
   _log (type, message) {
     if (this.pipelines) {
       this.pipelines.forEach(pipeline => {

package/helpers.js

@@ -1,30 +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.
  * ********************************************************************* */
 
+/**
+ * @typedef {import('./flowData')} FlowData
+ */
+
 class Helpers {
   /**
    * Set response headers in the response object (e.g. Accept-CH)
    *
-   * @param {http.ServerResponse} response The response to set the headers in.
+   * @param {import('http').ServerResponse} response The response to set the headers in.
    * @param {FlowData} flowData A processed FlowData instance to get the response header values
    * from.
    */

package/javascriptbuilder.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 mustache = require('mustache');
@@ -36,6 +36,10 @@ const ElementDataDictionary = require('./elementDataDictionary.js');
 const Constants = require('./constants.js');
 const uglifyJS = require('uglify-js');
 
+/**
+ * @typedef {import('./flowData')} FlowData
+ */
+
 /**
  * An instance of EvidenceKeyFilter which removes all but header
  * and query evidence as that is all that is used by

package/jsonbundler.js

@@ -1,29 +1,33 @@
-/* *********************************************************************
- * 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 FlowElement = require('./flowElement.js');
 const ElementDataDictionary = require('./elementDataDictionary.js');
 const BasicListEvidenceKeyFilter = require('./basicListEvidenceKeyFilter.js');
 
+/**
+ * @typedef {import('./flowData')} FlowData
+ */
+
 const elementBlacklist = ['jsonbundler', 'javascriptbuilder', 'sequence', 'set-headers'];
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.pipeline.core",
-  "version": "4.4.99",
+  "version": "4.4.101",
   "description": "Core library for the 51Degrees Pipeline API",
   "keywords": [
     "51degrees",
@@ -22,10 +22,12 @@
     "uglify-js": "^3.17.4"
   },
   "devDependencies": {
-    "@types/node": "^15.14.9",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^20.14.10",
     "jest": "^27.5.1",
     "jest-each": "^27.5.1",
-    "node-mocks-http": "^1.13.0"
+    "node-mocks-http": "^1.13.0",
+    "typescript": "^5.5.3"
   },
   "license": "EUPL-1.2",
   "bugs": {

package/pipeline.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 FlowData = require('./flowData');
@@ -25,7 +25,7 @@ const EventEmitter = require('events');
 
 /**
  * @typedef {import('./flowElement')} FlowElement
- * @typedef {import('../fiftyone.pipeline.engines/dataFileUpdateService')} DataFileUpdateService
+ * @typedef {import('fiftyone.pipeline.engines').DataFileUpdateService} DataFileUpdateService
  */
 
 /**
@@ -52,10 +52,16 @@ class Pipeline {
     // If true then pipeline will suppress exceptions added to FlowData.
     this.suppressProcessExceptions = suppressProcessExceptions;
 
-    // A logger for emitting messages
+    /**
+     * A logger for emitting messages
+     * @type {EventEmitter}
+     */
     this.eventEmitter = new EventEmitter();
 
     // Flattened dictionary of flowElements the pipeline contains
+    /**
+     * @type {object}
+     */
     this.flowElements = {};
 
     if (dataFileUpdateService) {
@@ -67,8 +73,8 @@ class Pipeline {
     // in the pipeline.flowElements object.
     // Recursive function so it can handle parallel elements
     // which are passed in as arrays
-    const storeInFlowElementList = function (flowElemmentList) {
-      flowElemmentList.forEach(function (slot) {
+    const storeInFlowElementList = function (flowElementList) {
+      flowElementList.forEach(function (slot) {
         if (Array.isArray(slot)) {
           storeInFlowElementList(slot);
         } else {
@@ -87,6 +93,9 @@ class Pipeline {
 
     // Empty property database, later populated and possibly
     // updated by flowElements' property lists
+    /**
+     * @type {object}
+     */
     this.propertyDatabase = {};
 
     // Update property list - Note that some of these could be async
@@ -201,7 +210,7 @@ class Pipeline {
    * Shorthand to trigger a message on the pipeline's eventEmitter
    *
    * @param {string} type type of message
-   * @param {mixed} message message to store in the log
+   * @param {*} message message to store in the log
    */
   log (type, message) {
     this.eventEmitter.emit(type, message);