node-red-contrib-mobius-flow-base 2.5.86-beta.68 → 2.5.86-beta.69

package/dist/nodes/common/mobsearch.js

@@ -1,33 +1,63 @@
+/**
+ *
+ * @param mobiusSrvc - Connection to Mobius
+ * @param {object} opts - Options object, field explained below
+
+   OPTS OBJECT (opts.)
+    ALL CASES
+      htmlElementId - The id of the HTML element that mobsearch will inject into
+    NON-LISTED ONLY
+      uriFieldName - The id of the URI HTML field, mobsearch will set the value of this field to be the result
+    LISTED ONLY (Uses editable list)
+      containerRowName - The id of the row containing the HTML container
+      containerName - The id of the HTML container
+      containerSecondFieldName - The id of the secondary field (Not URI field) within HTML container
+ 
+  EXAMPLE  OPTS OBJECT - context of getMultiResource
+  opts = {
+    htmlElementId: 'mobsearch',
+    list: node.resources,
+    containerRowName: 'node-input-resources-container-row',
+    containerName: 'node-input-resources-container',
+    containerSecondFieldName: 'node-input-resources-comment',
+  }
+ * 
+ * 
+ * 
+ */
 initMobsearch = {
+  // Standard mobsearch to rid level
   toRid: (mobiusSrvc, opts) => {
     getMobsearch(mobiusSrvc, true, false, opts);
   },
+  // Standard mobsearch to ins level
   toIns: (mobiusSrvc, opts) => {
     getMobsearch(mobiusSrvc, false, false, opts);
   },
+  // Mobsearch to rid level, for nodes using editable list
   toRid_listed: (mobiusSrvc, opts) => {
     getMobsearch(mobiusSrvc, true, true, opts);
   },
+  // Mobsearch to ins level, for nodes using editable list
   toIns_listed: (mobiusSrvc, opts) => {
     getMobsearch(mobiusSrvc, false, true, opts);
   },
 };
 
-// RID ONLY
-// opts.htmlElementId
-// opts.uriFieldName
-// opts.selectionIndex
-// opts.containerRowName
-// opts.containerName
-// opts.containerSecondFieldName
-
+// Make / Reset global selectionIndex vairable (variable to allow setting of correct list field)
 if (typeof selectionIndex === undefined) {
   let selectionIndex = 0;
 }
 
-function addMobsearchListButton(field, i, opts) {
+/**
+ * function to add search button functionality to list rows
+ * @param {*} field - The search field within a given list row
+ * @param {*} rowIndex - The list row index
+ * @param {*} opts - Mobsearch options object
+ */
+function addMobsearchListButton(field, rowIndex, opts) {
   field.click(function () {
-    selectionIndex = i;
+    selectionIndex = rowIndex;
     $(`#${opts.containerRowName}`).hide();
     $('#instance-search-sid').val('');
     $('#instance-search-pid').val('');
@@ -39,8 +69,22 @@ function addMobsearchListButton(field, i, opts) {
   });
 }
 
+/**
+ *
+ * @param mobiusSrvc - Connection to Mobius
+ * @param {boolean} useRid - Flag for Mobsearch to include rid field
+ * @param {boolean} listed - Flag for Mobsearch work with nodes using editableLists
+ * @param {object} opts - Mobsearhc options object
+ */
 function getMobsearch(mobiusSrvc, useRid, listed, opts) {
   selectionIndex = 0;
+  // Get current state of input field
+  let uriFieldValue = '';
+  if (!listed) {
+    uriFieldValue = $(`#${opts.uriFieldName}`).val();
+  }
+
+  // * HTML INJECTION * //
 
   const resourceHtml = `
   <input type="text" id="instance-search-hid" style="width:13%;" placeholder="HID">
@@ -57,12 +101,6 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
   <input type="text" id="instance-search-ins" style="width:10%;" placeholder="INS">
   `;
 
-  // Get current state of input field
-  let uriFieldValue = '';
-  if (!listed) {
-    uriFieldValue = $(`#${opts.uriFieldName}`).val();
-  }
-
   //set level dependent html
   let rows = useRid === true ? resourceHtml : instanceHtml;
   let alertMsg = useRid === true ? `and/or RID ` : ``;
@@ -92,7 +130,10 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     `;
   }
 
-  //Inital setup
+  // * END HTML INJECTION * //
+
+  // * INIT SETUP * //
+
   $('#instance-search-row').hide();
   $('#wildcard-alert-row').hide();
   $('#node-search-return').addClass('disabled');
@@ -122,9 +163,13 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     };
   }
 
-  //End init setup
+  // * END INIT SETUP * //
 
-  //Function to search for RIDs
+  /**
+   * Search for INSs present on selected PID
+   * @param {object} objects - Response from call to Mobiu, list of mobius objects
+   * @param {string} pid - The chosen PID
+   */
   function ridSearch(objects, ins) {
     $.getJSON(
       `mdiscover?mobius=${mobiusSrvc}&uri=${searchObject.hid}/${searchObject.sid}/${searchObject.pid}/${searchObject.ins}`,
@@ -150,7 +195,11 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     );
   }
 
-  //Function to search for INSs
+  /**
+   * Search for INSs present on selected PID
+   * @param {object} objects - Response from call to Mobius, list of mobius objects
+   * @param {string} pid - The chosen PID
+   */
   function insSearch(objects, pid) {
     let inss = ['#', '+'];
     for (let i = 0; i < objects.length; i++) {
@@ -179,7 +228,10 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
       .autocomplete('search', '');
   }
 
-  //Function to search for PIDs
+  /**
+   * Search for PIDs present on selected service
+   * @param {object} objects - Response from call to Mobius, list of mobius objects
+   */
   function pidsSearch(objects) {
     searchObject.objects = objects;
     let pids = ['#', '+'];
@@ -203,7 +255,10 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
       .autocomplete('search', '');
   }
 
-  //Function to search for SIDs, and then fetch child objects based on selection
+  /**
+   * Search for SIDs, and then fetch child objects based on selection
+   * @param {object} response - Response from call to Mobius
+   */
   function serviceSearch(response) {
     let services = ['#', '+'];
     for (let i = 0; i < response.length; i++) {
@@ -246,7 +301,9 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
       .autocomplete('search', '');
   }
 
-  //Start a new search
+  /**
+   * Start mobsearch
+   */
   function startSearch() {
     $('#wildcard-alert-row').hide();
     $('#instance-search-sid').val('');
@@ -265,7 +322,9 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     }
   }
 
-  //Finish a search
+  /**
+   * Finish mobsearch, compile full URI and set value in host node
+   */
   function finishSearch() {
     $('#wildcard-alert-row').hide();
     let uri = `${searchObject.hid}/${searchObject.sid}/${searchObject.pid}/${searchObject.ins}`;
@@ -290,7 +349,9 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     $('#instance-row').show();
   }
 
-  //Function to update if accept button is grade out and functions based on conditions of fields
+  /**
+   * Update if accept button is grade out and functional, based on conditions of fields
+   */
   function acceptCheck() {
     if (useRid) {
       checkFieldsToRid();
@@ -300,6 +361,9 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     checkWildcards();
   }
 
+  /**
+   * Check state of all field to rid level, change state of accept button accordingly
+   */
   function checkFieldsToRid() {
     if (
       ($('#instance-search-hid').val() !== '' &&
@@ -320,6 +384,9 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     }
   }
 
+  /**
+   * Check state of all field to ins level, change state of accept button accordingly
+   */
   function checkFieldsToIns() {
     if (
       ($('#instance-search-hid').val() !== '' &&
@@ -338,6 +405,9 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     }
   }
 
+  /**
+   * Checks if + wildcard values are present, shows / hides alert message accordingly
+   */
   function checkWildcards() {
     if (
       $('#instance-search-sid').val() !== '+' &&
@@ -350,6 +420,9 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     }
   }
 
+  /**
+   * Update editable list with results from mobsearch
+   */
   function updateList() {
     $(`#${opts.containerName}`)
       .editableList('items')
@@ -366,7 +439,8 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     $(`#${opts.containerRowName}`).show();
   }
 
-  // Respond to clicks
+  // * CLICK RESPONSE * //
+
   $('#node-lookup-instance').click(function () {
     //When search button is clicked
     $('#instance-search-sid').val('');
@@ -381,6 +455,7 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     $('#instance-row').hide();
     $('#instance-search-row').show();
   });
+
   $('#instance-search-sid').click(function () {
     //SID field clicked
     $('#instance-search-pid').val('');
@@ -431,6 +506,7 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
       }
     });
   }
+
   $('#node-search-return').click(function () {
     //Return/Back button clicked
     $('#node-search-return').addClass('disabled');
@@ -446,7 +522,10 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     }
   });
 
-  // Respond to search field changes
+  // * END CLICK RESPONSE * //
+
+  // * CHANGE RESPONSE * //
+
   $('#instance-search-hid').change(function () {
     acceptCheck();
     $('#instance-search-sid').val('');
@@ -456,18 +535,22 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
       $('#instance-search-rid').val('');
     }
   });
+
   $('#instance-search-sid').change(function () {
     searchObject.sid = $('#instance-search-sid').val();
     acceptCheck();
   });
+
   $('#instance-search-pid').change(function () {
     searchObject.pid = $('#instance-search-pid').val();
     acceptCheck();
   });
+
   $('#instance-search-ins').change(function () {
     searchObject.ins = $('#instance-search-ins').val();
     acceptCheck();
   });
+
   if (useRid) {
     $('#instance-search-rid').change(function () {
       searchObject.rid = $('#instance-search-rid').val();
@@ -475,6 +558,8 @@ function getMobsearch(mobiusSrvc, useRid, listed, opts) {
     });
   }
 
+  // * END CHANGE RESPONSE * //
+
   // reset input filed after init
   if (!listed) {
     $(`#${opts.uriFieldName}`).val(uriFieldValue);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-mobius-flow-base",
-  "version": "2.5.86-beta.68",
+  "version": "2.5.86-beta.69",
   "description": "Node-RED base nodes for Mobius Flow",
   "main": "index.js",
   "types": "dist/index.d.ts",