cisco-perfmon 1.2.3 → 1.3.1

package/main.js

@@ -89,29 +89,43 @@ var XML_REMOVE_COUNTER_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schem
  *
  *
  * @class perfMonService
+ * @param {string} host - The host to collect data from. This is usually the IP address/FQDN of the CUCM publisher.
+ * @param {string} username - The username to authenticate with. This is usually an AXL user. Can leave this blank if using JESSIONSSO cookie.
+ * @param {string} password - The password to authenticate with. This is usually an AXL user. Can leave this blank if using JESSIONSSO cookie.
+ * @param {object} options - Additional headers to add to the request. Useful for adding cookies for SSO sessions.
+ * @returns {object} returns constructor object.
  */
 class perfMonService {
-  constructor(host, username, password) {
+  constructor(host, username, password, options) {
     this._OPTIONS = {
       method: "POST",
       headers: {
-        Authorization:
-          "Basic " + Buffer.from(username + ":" + password).toString("base64"),
+        Authorization: "Basic " + Buffer.from(username + ":" + password).toString("base64"),
         "Content-Type": "text/xml;charset=UTF-8",
+        Connection: "keep-alive",
       },
     };
+
+    // Adds additional headers if they are provided. Useful for adding cookies for SSO sessions
+    if (options) {
+      this._OPTIONS.headers = Object.assign(this._OPTIONS.headers, options);
+    }
+
     this._HOST = host;
   }
   /**
    * Post Fetch using Cisco PerfMon API
    *
    * @collectCounterData
-   var service = new perfMonService();
-   service.collectCounterData().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.collectCounterData().then((results => {
+   *    console.log(results.Results);
+   *   }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @param {string} host - The host to collect data from
+   * @param {string} object - The object to collect data about. Example: Cisco CallManager
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   collectCounterData(host, object) {
     var XML;
@@ -125,14 +139,17 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
+            promiseResults.Cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
             const reader = response.body.getReader();
             for await (const chunk of readChunks(reader)) {
@@ -145,22 +162,16 @@ class perfMonService {
             removeKeys(output, "$");
 
             if (keyExists(output, "perfmonCollectCounterDataReturn")) {
-              var returnResults =
-                output.Body.perfmonCollectCounterDataResponse
-                  .perfmonCollectCounterDataReturn;
+              var returnResults = output.Body.perfmonCollectCounterDataResponse.perfmonCollectCounterDataReturn;
               if (returnResults) {
                 var newOutput;
                 if (Array.isArray(returnResults)) {
                   newOutput = returnResults.map((item) => {
-                    let arr = item.Name.split("\\").filter(
-                      (element) => element
-                    );
+                    let arr = item.Name.split("\\").filter((element) => element);
 
-                    let instanceArr = arr[1]
-                      .split(/[()]+/)
-                      .filter(function (e) {
-                        return e;
-                      });
+                    let instanceArr = arr[1].split(/[()]+/).filter(function (e) {
+                      return e;
+                    });
 
                     return {
                       host: arr[0],
@@ -172,9 +183,7 @@ class perfMonService {
                     };
                   });
                 } else {
-                  let arr = returnResults.Name.split("\\").filter(
-                    (element) => element
-                  );
+                  let arr = returnResults.Name.split("\\").filter((element) => element);
 
                   let instanceArr = arr[1].split(/[()]+/).filter(function (e) {
                     return e;
@@ -189,19 +198,36 @@ class perfMonService {
                     cstatus: returnResults.CStatus,
                   };
                 }
-                resolve(clean(newOutput));
+                promiseResults.Results = clean(newOutput);
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              // Error checking. If the response contains a fault, we return the fault.
+              if (keyExists(output, "Fault")) {
+                if (output.Body.Fault.faultcode.includes("RateControl")) {
+                  promiseResults.Results = { faultcode: "RateControl", faultstring: output.Body.Fault.faultstring };
+                } else if (output.Body.Fault.faultcode.includes("generalException")) {
+                  promiseResults.Results = { faultcode: "generalException", faultstring: output.Body.Fault.faultstring };
+                } else {
+                  promiseResults.Results = { faultcode: output.Body.Fault.faultcode, faultstring: output.Body.Fault.faultstring };
+                }
+                resolve(promiseResults);
+              } else {
+                // Error unknown. Return the response status instead.
+                reject(response.status);
+              }
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -209,12 +235,14 @@ class perfMonService {
    * Post Fetch using Cisco PerfMon API
    *
    * @collectSessionData
-   var service = new perfMonService();
-   service.collectSessionData().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.collectSessionData().then((results => {
+   *    console.log(results.Results);
+   * }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @param {string} SessionHandle - A unique session ID from the client, of type SessionHandleType. The session handle that the perfmonOpenSession request previously opened.
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   collectSessionData(SessionHandle) {
     var XML;
@@ -228,14 +256,17 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
+            promiseResults.Cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
             const reader = response.body.getReader();
             for await (const chunk of readChunks(reader)) {
@@ -248,23 +279,17 @@ class perfMonService {
             removeKeys(output, "$");
 
             if (keyExists(output, "perfmonCollectSessionDataReturn")) {
-              var returnResults =
-                output.Body.perfmonCollectSessionDataResponse
-                  .perfmonCollectSessionDataReturn;
+              var returnResults = output.Body.perfmonCollectSessionDataResponse.perfmonCollectSessionDataReturn;
 
               if (returnResults) {
                 var newOutput;
                 if (Array.isArray(returnResults)) {
                   newOutput = returnResults.map((item) => {
-                    let arr = item.Name.split("\\").filter(
-                      (element) => element
-                    );
+                    let arr = item.Name.split("\\").filter((element) => element);
 
-                    let instanceArr = arr[1]
-                      .split(/[()]+/)
-                      .filter(function (e) {
-                        return e;
-                      });
+                    let instanceArr = arr[1].split(/[()]+/).filter(function (e) {
+                      return e;
+                    });
 
                     return {
                       host: arr[0],
@@ -276,9 +301,7 @@ class perfMonService {
                     };
                   });
                 } else {
-                  let arr = returnResults.Name.split("\\").filter(
-                    (element) => element
-                  );
+                  let arr = returnResults.Name.split("\\").filter((element) => element);
 
                   let instanceArr = arr[1].split(/[()]+/).filter(function (e) {
                     return e;
@@ -293,19 +316,24 @@ class perfMonService {
                     cstatus: returnResults.CStatus,
                   };
                 }
-                resolve(clean(newOutput));
+                promiseResults.Results = clean(newOutput);
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              promiseResults.Results = { response: "empty" };
+              resolve(promiseResults);
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -313,12 +341,14 @@ class perfMonService {
    * Post Fetch using Cisco PerfMon API
    *
    * @listCounter
-   var service = new perfMonService();
-   service.listCounter().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.listCounter().then((results => {
+   *    console.log(results.Results);
+   * }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @param {string} host - The host to collect data from.
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   listCounter(host) {
     var XML;
@@ -332,14 +362,17 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
+            promiseResults.Cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
             const reader = response.body.getReader();
             for await (const chunk of readChunks(reader)) {
@@ -352,23 +385,27 @@ class perfMonService {
             removeKeys(output, "$");
 
             if (keyExists(output, "perfmonListCounterReturn")) {
-              var returnResults =
-                output.Body.perfmonListCounterResponse.perfmonListCounterReturn;
+              var returnResults = output.Body.perfmonListCounterResponse.perfmonListCounterReturn;
 
               if (returnResults) {
-                resolve(clean(returnResults));
+                promiseResults.Results = clean(returnResults);
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              promiseResults.Results = { response: "empty" };
+              resolve(promiseResults);
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -376,12 +413,15 @@ class perfMonService {
    * Post Fetch using Cisco PerfMon API
    *
    * @listInstance
-   var service = new perfMonService();
-   service.listInstance().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.listInstance().then((results => {
+   *    console.log(results.Results);
+   * }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @param {string} host - The host to collect data from.
+   * @param {string} object - The object to collect data about. Example: Cisco CallManager
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   listInstance(host, object) {
     var XML;
@@ -395,14 +435,17 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
+            promiseResults.Cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
             const reader = response.body.getReader();
             for await (const chunk of readChunks(reader)) {
@@ -415,24 +458,27 @@ class perfMonService {
             removeKeys(output, "$");
 
             if (keyExists(output, "perfmonListInstanceReturn")) {
-              var returnResults =
-                output.Body.perfmonListInstanceResponse
-                  .perfmonListInstanceReturn;
+              var returnResults = output.Body.perfmonListInstanceResponse.perfmonListInstanceReturn;
 
               if (returnResults) {
-                resolve(clean(returnResults));
+                promiseResults.Results = clean(returnResults);
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              promiseResults.Results = { response: "empty" };
+              resolve(promiseResults);
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -440,12 +486,13 @@ class perfMonService {
    * Post Fetch using Cisco PerfMon API
    *
    * @openSession
-   var service = new perfMonService();
-   service.openSession().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.openSession().then((results => {
+   *    console.log(results.Results);
+   * }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   openSession() {
     var XML;
@@ -458,14 +505,17 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
+            promiseResults.Cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
             const reader = response.body.getReader();
             for await (const chunk of readChunks(reader)) {
@@ -478,23 +528,27 @@ class perfMonService {
             removeKeys(output, "$");
 
             if (keyExists(output, "perfmonOpenSessionReturn")) {
-              var returnResults =
-                output.Body.perfmonOpenSessionResponse.perfmonOpenSessionReturn;
+              var returnResults = output.Body.perfmonOpenSessionResponse.perfmonOpenSessionReturn;
 
               if (returnResults) {
-                resolve(clean(returnResults));
+                promiseResults.Results = clean(returnResults);
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              promiseResults.Results = { response: "empty" };
+              resolve(promiseResults);
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -502,12 +556,14 @@ class perfMonService {
    * Post Fetch using Cisco PerfMon API
    *
    * @closeSession
-   var service = new perfMonService();
-   service.closeSession().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.closeSession().then((results => {
+   *    console.log(results.Results);
+   * }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @param {string} sessionHandle - A unique session ID from the client, of type SessionHandleType. The session handle that the perfmonOpenSession request previously opened.
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   closeSession(sessionHandle) {
     var XML;
@@ -520,14 +576,17 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
+            promiseResults.Cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
             const reader = response.body.getReader();
             for await (const chunk of readChunks(reader)) {
@@ -542,19 +601,24 @@ class perfMonService {
             if (keyExists(output, "perfmonCloseSessionResponse")) {
               var returnResults = output.Body.perfmonCloseSessionResponse;
               if (returnResults) {
-                resolve({ response: "success" });
+                promiseResults.Results = { response: "success" };
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              promiseResults.Results = { response: "empty" };
+              resolve(promiseResults);
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -562,12 +626,15 @@ class perfMonService {
    * Post Fetch using Cisco PerfMon API
    *
    * @addCounter
-   var service = new perfMonService();
-   service.addCounter().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.addCounter().then((results => {
+   *    console.log(results.Results);
+   * }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @param {string} sessionHandle - A unique session ID from the client, of type SessionHandleType. The session handle that the perfmonOpenSession request previously opened.
+   * @param {object} counter - The counter to add. Example: Memory
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   addCounter(sessionHandle, counter) {
     var XML;
@@ -577,32 +644,9 @@ class perfMonService {
     var server = this._HOST;
 
     if (Array.isArray(counter)) {
-      counter.forEach(
-        (item) =>
-          (counterStr +=
-            "<soap:Counter>" +
-            "<soap:Name>" +
-            "\\\\" +
-            item.host +
-            "\\" +
-            item.object +
-            "\\" +
-            item.counter +
-            "</soap:Name>" +
-            "</soap:Counter>")
-      );
+      counter.forEach((item) => (counterStr += "<soap:Counter>" + "<soap:Name>" + "\\\\" + item.host + "\\" + item.object + "\\" + item.counter + "</soap:Name>" + "</soap:Counter>"));
     } else {
-      counterStr =
-        "<soap:Counter>" +
-        "<soap:Name>" +
-        "\\\\" +
-        counter.host +
-        "\\" +
-        counter.object +
-        "\\" +
-        counter.counter +
-        "</soap:Name>" +
-        "</soap:Counter>";
+      counterStr = "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + counter.object + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>";
     }
 
     XML = util.format(XML_ADD_COUNTER_ENVELOPE, sessionHandle, counterStr);
@@ -611,11 +655,13 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
@@ -633,19 +679,24 @@ class perfMonService {
             if (keyExists(output, "perfmonAddCounterResponse")) {
               var returnResults = output.Body.perfmonAddCounterResponse;
               if (returnResults) {
-                resolve({ response: "success" });
+                promiseResults.Results = { response: "success" };
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              promiseResults.Results = { response: "empty" };
+              resolve(promiseResults);
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -653,12 +704,15 @@ class perfMonService {
    * Post Fetch using Cisco PerfMon API
    *
    * @removeCounter
-   var service = new perfMonService();
-   service.removeCounter().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.removeCounter().then((results => {
+   *    console.log(results.Results);
+   * }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @param {string} sessionHandle - A unique session ID from the client, of type SessionHandleType. The session handle that the perfmonOpenSession request previously opened.
+   * @param {object} counter - The counter to remove. Example: Memory
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   removeCounter(sessionHandle, counter) {
     var XML;
@@ -668,32 +722,9 @@ class perfMonService {
     var server = this._HOST;
 
     if (Array.isArray(counter)) {
-      counter.forEach(
-        (item) =>
-          (counterStr +=
-            "<soap:Counter>" +
-            "<soap:Name>" +
-            "\\\\" +
-            item.host +
-            "\\" +
-            item.object +
-            "\\" +
-            item.counter +
-            "</soap:Name>" +
-            "</soap:Counter>")
-      );
+      counter.forEach((item) => (counterStr += "<soap:Counter>" + "<soap:Name>" + "\\\\" + item.host + "\\" + item.object + "\\" + item.counter + "</soap:Name>" + "</soap:Counter>"));
     } else {
-      counterStr =
-        "<soap:Counter>" +
-        "<soap:Name>" +
-        "\\\\" +
-        counter.host +
-        "\\" +
-        counter.object +
-        "\\" +
-        counter.counter +
-        "</soap:Name>" +
-        "</soap:Counter>";
+      counterStr = "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + counter.object + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>";
     }
 
     XML = util.format(XML_REMOVE_COUNTER_ENVELOPE, sessionHandle, counterStr);
@@ -702,11 +733,13 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
@@ -724,19 +757,24 @@ class perfMonService {
             if (keyExists(output, "perfmonRemoveCounterResponse")) {
               var returnResults = output.Body.perfmonRemoveCounterResponse;
               if (returnResults) {
-                resolve({ response: "success" });
+                promiseResults.Results = { response: "success" };
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              promiseResults.Results = { response: "empty" };
+              resolve(promiseResults);
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -744,12 +782,14 @@ class perfMonService {
    * Post Fetch using Cisco PerfMon API
    *
    * @queryCounterDescription
-   var service = new perfMonService();
-   service.queryCounterDescription().then((success => {
-        console.log(success);
-      }))
+   * @example
+   * var service = new perfMonService();
+   * service.queryCounterDescription().then((results => {
+   *    console.log(results.Results);
+   * }))
    * @memberof perfMonService
-   * @returns {promise} returns a Promise
+   * @param {object} counter - The counter to query. Example: Memory
+   * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   queryCounterDescription(counter) {
     var XML;
@@ -757,15 +797,7 @@ class perfMonService {
     options.SOAPAction = `perfmonQueryCounterDescription`;
     var server = this._HOST;
 
-    var counterStr =
-      "<soap:Counter>" +
-      "\\\\" +
-      counter.host +
-      "\\" +
-      counter.object +
-      "\\" +
-      counter.counter +
-      "</soap:Counter>";
+    var counterStr = "<soap:Counter>" + "\\\\" + counter.host + "\\" + counter.object + "\\" + counter.counter + "</soap:Counter>";
 
     XML = util.format(XML_QUERY_COUNTER_ENVELOPE, counterStr);
 
@@ -773,14 +805,17 @@ class perfMonService {
     options.body = soapBody;
 
     return new Promise((resolve, reject) => {
+      // Set up our promise results
+      var promiseResults = {
+        Cookie: "",
+        Results: "",
+      };
       // We fetch the API endpoint
-      fetch(
-        `https://${server}:8443/perfmonservice2/services/PerfmonService/`,
-        options
-      )
+      fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
             var data = []; // create an array to save chunked data from server
+            promiseResults.Cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
             const reader = response.body.getReader();
             for await (const chunk of readChunks(reader)) {
@@ -794,23 +829,26 @@ class perfMonService {
             removeKeys(output, "$");
 
             if (keyExists(output, "perfmonQueryCounterDescriptionReturn")) {
-              var returnResults =
-                output.Body.perfmonQueryCounterDescriptionResponse
-                  .perfmonQueryCounterDescriptionReturn;
+              var returnResults = output.Body.perfmonQueryCounterDescriptionResponse.perfmonQueryCounterDescriptionReturn;
               if (returnResults) {
-                resolve(clean(returnResults));
+                promiseResults.Results = clean(returnResults);
+                resolve(promiseResults);
               } else {
-                reject(output.Body.Fault);
+                promiseResults.Results = output.Body.Fault;
+                reject(promiseResults);
               }
             } else {
-              resolve({ response: "empty" });
+              promiseResults.Results = { response: "empty" };
+              resolve(promiseResults);
             }
           } catch (e) {
-            reject(e);
+            promiseResults.Results = e;
+            reject(promiseResults);
           }
         })
         .catch((error) => {
-          reject(error);
+          promiseResults.Results = error;
+          reject(promiseResults);
         }); // catches the error and logs it
     });
   }
@@ -887,11 +925,7 @@ const clean = (object) => {
     if (v && typeof v === "object") {
       clean(v);
     }
-    if (
-      (v && typeof v === "object" && !Object.keys(v).length) ||
-      v === null ||
-      v === undefined
-    ) {
+    if ((v && typeof v === "object" && !Object.keys(v).length) || v === null || v === undefined) {
       if (Array.isArray(object)) {
         object.splice(k, 1);
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cisco-perfmon",
-  "version": "1.2.3",
+  "version": "1.3.1",
   "description": "A library to pull Perfmon data from Cisco VOS applications via SOAP",
   "main": "main.js",
   "scripts": {
@@ -30,6 +30,7 @@
   },
   "devDependencies": {
     "dotenv": "*",
-    "envalid": "^8.0.0"
+    "envalid": "^8.0.0",
+    "jsdoc-to-markdown": "^9.0.4"
   }
 }

package/test/tests.js

@@ -1,14 +1,14 @@
 const perfMonService = require("../main");
-const path = require('path');
+const path = require("path");
 const { cleanEnv, str, host } = require("envalid");
 
 // If not production load the local env file
-if(process.env.NODE_ENV === "development"){
-  require('dotenv').config({ path: path.join(__dirname, '..', 'env', 'development.env') })
-}else if(process.env.NODE_ENV === "test"){
-  require('dotenv').config({ path: path.join(__dirname, '..', 'env', 'test.env') })
-}else if(process.env.NODE_ENV === "staging"){
-  require('dotenv').config({ path: path.join(__dirname, '..', 'env', 'staging.env') })
+if (process.env.NODE_ENV === "development") {
+  require("dotenv").config({ path: path.join(__dirname, "..", "env", "development.env") });
+} else if (process.env.NODE_ENV === "test") {
+  require("dotenv").config({ path: path.join(__dirname, "..", "env", "test.env") });
+} else if (process.env.NODE_ENV === "staging") {
+  require("dotenv").config({ path: path.join(__dirname, "..", "env", "staging.env") });
 }
 
 const env = cleanEnv(process.env, {
@@ -19,7 +19,7 @@ const env = cleanEnv(process.env, {
   CUCM_HOSTNAME: host({ desc: "Cisco CUCM Hostname or IP Address to send the perfmon request to. Typically the publisher." }),
   CUCM_USERNAME: str({ desc: "Cisco CUCM AXL Username." }),
   CUCM_PASSWORD: str({ desc: "Cisco CUCM AXL Password." }),
-  CUCM_SERVER_NAME: str({ desc: "The CUCM name or IP address of the target server from which the client wants to retrieve the counter information from. Note this could be any node in the cluster." , example: "hq-cucm-pub or hq-cucm-sub" }),
+  CUCM_SERVER_NAME: str({ desc: "The CUCM name or IP address of the target server from which the client wants to retrieve the counter information from. Note this could be any node in the cluster.", example: "hq-cucm-pub or hq-cucm-sub" }),
 });
 
 let service = new perfMonService(env.CUCM_HOSTNAME, env.CUCM_USERNAME, env.CUCM_PASSWORD);
@@ -34,45 +34,47 @@ var counterObj = {
   counter: "% CPU Time",
 };
 
+var serviceSSO = "";
+
 (async () => {
   console.log("Let's get a description of our counter.");
   await service
     .queryCounterDescription(counterObj)
     .then((results) => {
-      console.log("queryCounterDescription: ", results);
+      console.log("queryCounterDescription: ", results.Results);
+      if (results.Cookie) {
+        serviceSSO = new perfMonService(env.CUCM_HOSTNAME, "", "", { Cookie: results.Cookie });
+      }
     })
     .catch((error) => {
       console.log(error);
     });
 
-  console.log(
-    "Let's open a session, add a counter, wait 30 seconds, collect the session data, remove the counter and finally close the session"
-  );
-  await service
+  console.log("Let's open a session, add a counter, wait 30 seconds, collect the session data, remove the counter and finally close the session");
+  await serviceSSO
     .openSession()
     .then(async (results) => {
-      console.log("SessionID", results);
+      console.log("SessionID", results.Results);
       SessionID = results;
-      await service
+      await serviceSSO
         .addCounter(SessionID, counterObj)
         .then(async (results) => {
-          console.log("addCounter", results);
-          const delay = (ms) =>
-            new Promise((resolve) => setTimeout(resolve, ms));
+          console.log("addCounter", results.Results);
+          const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
           console.log("Wait 30 seconds");
           await delay(30000); /// waiting 30 second.
-          await service
+          await serviceSSO
             .collectSessionData(SessionID)
             .then(async (results) => {
-              console.log("collectSessionData", results);
-              await service
-                .removeCounter(SessionID, counterObj)
+              console.log("collectSessionData", results.Results);
+              await serviceSSO
+                .removeCounter(SessionID, results.Results)
                 .then(async (results) => {
-                  console.log("removeCounter", results);
-                  await service
+                  console.log("removeCounter", results.Results);
+                  await serviceSSO
                     .closeSession(SessionID)
                     .then((results) => {
-                      console.log("closeSession", results);
+                      console.log("closeSession", results.Results);
                     })
                     .catch((error) => {
                       console.log(error);
@@ -95,34 +97,30 @@ var counterObj = {
     });
 
   console.log("Let's collect some non session counter data.");
-  await service
+  await serviceSSO
     .collectCounterData(cucmServerName, "Cisco CallManager")
     .then((results) => {
-      console.log("collectCounterData", results);
+      console.log("collectCounterData", results.Results);
     })
     .catch((error) => {
       console.log(error);
     });
 
-  console.log(
-    "Let's returns the list of available PerfMon objects and counters on a particular host"
-  );
-  await service
+  console.log("Let's returns the list of available PerfMon objects and counters on a particular host");
+  await serviceSSO
     .listCounter(cucmServerName)
     .then((results) => {
-      console.log("listCounter", results);
+      console.log("listCounter", results.Results);
     })
     .catch((error) => {
       console.log(error);
     });
 
-  console.log(
-    "Let's return a list of instances of a PerfMon object on a particular host. Instances of an object can dynamically change. This operation returns the most recent list."
-  );
-  await service
+  console.log("Let's return a list of instances of a PerfMon object on a particular host. Instances of an object can dynamically change. This operation returns the most recent list.");
+  await serviceSSO
     .listInstance(cucmServerName, "Processor")
     .then((results) => {
-      console.log("listInstance", results);
+      console.log("listInstance", results.Results);
     })
     .catch((error) => {
       console.log(error);