cisco-perfmon 1.5.2 → 1.6.0

package/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Update npm
+        run: npm install -g npm@latest
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish to npm
+        run: npm publish --access public
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true

package/main.js

@@ -1,86 +1,104 @@
 const fetch = require("fetch-retry")(global.fetch);
-const util = require("util");
 const parseString = require("xml2js").parseString;
 const stripPrefix = require("xml2js").processors.stripPrefix;
 const http = require("http");
 
-var XML_ADD_COUNTER_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const escapeXml = (str) => {
+  if (typeof str !== "string") return str;
+  return str
+    .replace(/&/g, "&amp;")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+    .replace(/'/g, "&apos;");
+};
+
+const buildCounterStr = (c) => {
+  const host = escapeXml(c.host);
+  const object = escapeXml(c.object);
+  const instance = c.instance ? escapeXml(c.instance) : "";
+  const counter = c.counter ? escapeXml(c.counter) : "";
+  const objectPart = instance ? `${object}(${instance})` : object;
+  return `<soap:Counter><soap:Name>\\\\${host}\\${objectPart}\\${counter}</soap:Name></soap:Counter>`;
+};
+
+const XML_ADD_COUNTER_ENVELOPE = (sessionHandle, counters) => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
  <soapenv:Header/>
  <soapenv:Body>
     <soap:perfmonAddCounter>
-       <soap:SessionHandle>%s</soap:SessionHandle>
-       <soap:ArrayOfCounter>%s</soap:ArrayOfCounter>
+       <soap:SessionHandle>${sessionHandle}</soap:SessionHandle>
+       <soap:ArrayOfCounter>${counters}</soap:ArrayOfCounter>
     </soap:perfmonAddCounter>
  </soapenv:Body>
 </soapenv:Envelope>`;
 
-var XML_CLOSE_SESSION_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const XML_CLOSE_SESSION_ENVELOPE = (sessionHandle) => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
 <soapenv:Header/>
 <soapenv:Body>
    <soap:perfmonCloseSession>
-      <soap:SessionHandle>%s</soap:SessionHandle>
+      <soap:SessionHandle>${sessionHandle}</soap:SessionHandle>
    </soap:perfmonCloseSession>
 </soapenv:Body>
 </soapenv:Envelope>`;
 
-var XML_COLLECT_COUNTER_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const XML_COLLECT_COUNTER_ENVELOPE = (host, object) => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
 <soapenv:Header/>
 <soapenv:Body>
    <soap:perfmonCollectCounterData>
-      <soap:Host>%s</soap:Host>
-      <soap:Object>%s</soap:Object>
+      <soap:Host>${host}</soap:Host>
+      <soap:Object>${object}</soap:Object>
    </soap:perfmonCollectCounterData>
 </soapenv:Body>
 </soapenv:Envelope>`;
 
-var XML_COLLECT_SESSION_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const XML_COLLECT_SESSION_ENVELOPE = (sessionHandle) => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
 <soapenv:Header/>
 <soapenv:Body>
    <soap:perfmonCollectSessionData>
-      <soap:SessionHandle>%s</soap:SessionHandle>
+      <soap:SessionHandle>${sessionHandle}</soap:SessionHandle>
    </soap:perfmonCollectSessionData>
 </soapenv:Body>
 </soapenv:Envelope>`;
 
-var XML_LIST_COUNTER_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const XML_LIST_COUNTER_ENVELOPE = (host) => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
 <soapenv:Header/>
 <soapenv:Body>
    <soap:perfmonListCounter>
-      <soap:Host>%s</soap:Host>
+      <soap:Host>${host}</soap:Host>
    </soap:perfmonListCounter>
 </soapenv:Body>
 </soapenv:Envelope>`;
 
-var XML_LIST_INSTANCE_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const XML_LIST_INSTANCE_ENVELOPE = (host, object) => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
 <soapenv:Header/>
 <soapenv:Body>
    <soap:perfmonListInstance>
-      <soap:Host>%s</soap:Host>
-      <soap:Object>%s</soap:Object>
+      <soap:Host>${host}</soap:Host>
+      <soap:Object>${object}</soap:Object>
    </soap:perfmonListInstance>
 </soapenv:Body>
 </soapenv:Envelope>`;
 
-var XML_OPEN_SESSION_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const XML_OPEN_SESSION_ENVELOPE = () => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
 <soapenv:Header/>
 <soapenv:Body>
    <soap:perfmonOpenSession/>
 </soapenv:Body>
 </soapenv:Envelope>`;
 
-var XML_QUERY_COUNTER_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const XML_QUERY_COUNTER_ENVELOPE = (counter) => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
 <soapenv:Header/>
 <soapenv:Body>
-   <soap:perfmonQueryCounterDescription>%s</soap:perfmonQueryCounterDescription>
+   <soap:perfmonQueryCounterDescription>${counter}</soap:perfmonQueryCounterDescription>
 </soapenv:Body>
 </soapenv:Envelope>`;
 
-var XML_REMOVE_COUNTER_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
+const XML_REMOVE_COUNTER_ENVELOPE = (sessionHandle, counters) => `<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
 <soapenv:Header/>
 <soapenv:Body>
    <soap:perfmonRemoveCounter>
-      <soap:SessionHandle>%s</soap:SessionHandle>
-      <soap:ArrayOfCounter>%s</soap:ArrayOfCounter>
+      <soap:SessionHandle>${sessionHandle}</soap:SessionHandle>
+      <soap:ArrayOfCounter>${counters}</soap:ArrayOfCounter>
    </soap:perfmonRemoveCounter>
 </soapenv:Body>
 </soapenv:Envelope>`;
@@ -99,6 +117,8 @@ var XML_REMOVE_COUNTER_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schem
  */
 class perfMonService {
   constructor(host, username, password, options = {}, retry = true) {
+    const RATE_LIMIT_DELAYS = [30000, 60000, 120000]; // 30s, 60s, 120s exponential backoff
+
     this._OPTIONS = {
       retryOn: async function (attempt, error, response) {
         if (!retry) {
@@ -107,6 +127,23 @@ class perfMonService {
         if (attempt > (process.env.PM_RETRY ? parseInt(process.env.PM_RETRY) : 3)) {
           return false;
         }
+
+        // Check for SOAP-level rate limiting (CUCM 80 req/min limit)
+        if (response && response.status === 500) {
+          try {
+            const clonedResponse = response.clone();
+            const body = await clonedResponse.text();
+            if (body.includes("Exceeded allowed rate for Perfmon")) {
+              const backoff = RATE_LIMIT_DELAYS[Math.min(attempt, RATE_LIMIT_DELAYS.length - 1)];
+              const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+              await delay(backoff);
+              return true;
+            }
+          } catch (e) {
+            // If we can't read the body, fall through to normal retry
+          }
+        }
+
         // retry on any network error, or 4xx or 5xx status codes
         if (error !== null || response.status >= 400) {
           const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
@@ -128,6 +165,28 @@ class perfMonService {
     }
 
     this._HOST = host;
+    this._COOKIE = "";
+  }
+  /**
+   * Get the current stored cookie
+   *
+   * @getCookie
+   * @memberof perfMonService
+   * @returns {string} returns the stored cookie string.
+   */
+  getCookie() {
+    return this._COOKIE;
+  }
+  /**
+   * Set a cookie to be used for subsequent requests
+   *
+   * @setCookie
+   * @memberof perfMonService
+   * @param {string} cookie - The cookie string to set.
+   */
+  setCookie(cookie) {
+    this._COOKIE = cookie;
+    this._OPTIONS.headers.Cookie = cookie;
   }
   /**
    * Post Fetch using Cisco PerfMon API
@@ -147,7 +206,7 @@ class perfMonService {
     try {
       let options = this._OPTIONS;
       let server = this._HOST;
-      let XML = util.format(XML_COLLECT_COUNTER_ENVELOPE, host, object);
+      let XML = XML_COLLECT_COUNTER_ENVELOPE(escapeXml(host), escapeXml(object));
       let soapBody = Buffer.from(XML);
       options.body = soapBody;
       options.SOAPAction = `perfmonCollectCounterData`;
@@ -161,6 +220,12 @@ class perfMonService {
       };
 
       promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
+      if (promiseResults.cookie) {
+        this.setCookie(promiseResults.cookie);
+      }
 
       let output = await parseXml(await response.text());
       // Remove unnecessary keys
@@ -198,9 +263,9 @@ class perfMonService {
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   async collectSessionData(SessionHandle) {
-    let options = this._OPTIONS;
+    let options = { ...this._OPTIONS, headers: { ...this._OPTIONS.headers } };
     let server = this._HOST;
-    let XML = util.format(XML_COLLECT_SESSION_ENVELOPE, SessionHandle);
+    let XML = XML_COLLECT_SESSION_ENVELOPE(SessionHandle);
     let soapBody = Buffer.from(XML);
     options.body = soapBody;
     options.SOAPAction = `perfmonCollectSessionData`;
@@ -213,6 +278,9 @@ class perfMonService {
     };
 
     promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
 
     let output = await parseXml(await response.text());
     // Remove unnecessary keys
@@ -246,9 +314,9 @@ class perfMonService {
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   async listCounter(host, filtered = []) {
-    let options = this._OPTIONS;
+    let options = { ...this._OPTIONS, headers: { ...this._OPTIONS.headers } };
     let server = this._HOST;
-    let XML = util.format(XML_LIST_COUNTER_ENVELOPE, host);
+    let XML = XML_LIST_COUNTER_ENVELOPE(escapeXml(host));
     let soapBody = Buffer.from(XML);
     options.body = soapBody;
     options.SOAPAction = `perfmonListCounter`;
@@ -261,6 +329,9 @@ class perfMonService {
     };
 
     promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
 
     let output = await parseXml(await response.text());
     // Remove unnecessary keys
@@ -299,9 +370,9 @@ class perfMonService {
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   async listInstance(host, object) {
-    let options = this._OPTIONS;
+    let options = { ...this._OPTIONS, headers: { ...this._OPTIONS.headers } };
     let server = this._HOST;
-    let XML = util.format(XML_LIST_INSTANCE_ENVELOPE, host, object);
+    let XML = XML_LIST_INSTANCE_ENVELOPE(escapeXml(host), escapeXml(object));
     let soapBody = Buffer.from(XML);
     options.body = soapBody;
     options.SOAPAction = `perfmonListInstance`;
@@ -315,6 +386,9 @@ class perfMonService {
     };
 
     promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
 
     let output = await parseXml(await response.text());
     // Remove unnecessary keys
@@ -331,11 +405,7 @@ class perfMonService {
 
       // If the results are not an array, we make it an array.
       if (!Array.isArray(promiseResults.results)) {
-        var temp = promiseResults.results;
-        promiseResults = {
-          results: [],
-        };
-        promiseResults.results.push(temp);
+        promiseResults.results = [promiseResults.results];
       }
       return promiseResults;
     } else {
@@ -356,9 +426,9 @@ class perfMonService {
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   async openSession() {
-    let options = this._OPTIONS;
+    let options = { ...this._OPTIONS, headers: { ...this._OPTIONS.headers } };
     let server = this._HOST;
-    let XML = util.format(XML_OPEN_SESSION_ENVELOPE);
+    let XML = XML_OPEN_SESSION_ENVELOPE();
     let soapBody = Buffer.from(XML);
     options.body = soapBody;
     options.SOAPAction = `perfmonOpenSession`;
@@ -371,6 +441,9 @@ class perfMonService {
     };
 
     promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
 
     let output = await parseXml(await response.text());
     // Remove unnecessary keys
@@ -404,9 +477,9 @@ class perfMonService {
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   async closeSession(sessionHandle) {
-    let options = this._OPTIONS;
+    let options = { ...this._OPTIONS, headers: { ...this._OPTIONS.headers } };
     let server = this._HOST;
-    let XML = util.format(XML_CLOSE_SESSION_ENVELOPE, sessionHandle);
+    let XML = XML_CLOSE_SESSION_ENVELOPE(sessionHandle);
     let soapBody = Buffer.from(XML);
     options.body = soapBody;
     options.SOAPAction = `perfmonCloseSession`;
@@ -419,6 +492,9 @@ class perfMonService {
     };
 
     promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
 
     let output = await parseXml(await response.text());
     // Remove unnecessary keys
@@ -451,16 +527,10 @@ class perfMonService {
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   async addCounter(sessionHandle, counter) {
-    let options = this._OPTIONS;
+    let options = { ...this._OPTIONS, headers: { ...this._OPTIONS.headers } };
     let server = this._HOST;
-    let counterStr;
-    // Build the counter string
-    if (Array.isArray(counter)) {
-      counter.forEach((counter) => (counterStr += "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>"));
-    } else {
-      counterStr = "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>";
-    }
-    let XML = util.format(XML_ADD_COUNTER_ENVELOPE, sessionHandle, counterStr);
+    let counterStr = Array.isArray(counter) ? counter.map(buildCounterStr).join("") : buildCounterStr(counter);
+    let XML = XML_ADD_COUNTER_ENVELOPE(sessionHandle, counterStr);
     let soapBody = Buffer.from(XML);
     options.body = soapBody;
     options.SOAPAction = `perfmonAddCounter`;
@@ -473,6 +543,9 @@ class perfMonService {
     };
 
     promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
 
     let output = await parseXml(await response.text());
     // Remove unnecessary keys
@@ -505,17 +578,10 @@ class perfMonService {
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   async removeCounter(sessionHandle, counter) {
-    let options = this._OPTIONS;
+    let options = { ...this._OPTIONS, headers: { ...this._OPTIONS.headers } };
     let server = this._HOST;
-
-    let counterStr;
-    if (Array.isArray(counter)) {
-      counter.forEach((counter) => (counterStr += "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>"));
-    } else {
-      counterStr = "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>";
-    }
-
-    let XML = util.format(XML_REMOVE_COUNTER_ENVELOPE, sessionHandle, counterStr);
+    let counterStr = Array.isArray(counter) ? counter.map(buildCounterStr).join("") : buildCounterStr(counter);
+    let XML = XML_REMOVE_COUNTER_ENVELOPE(sessionHandle, counterStr);
     let soapBody = Buffer.from(XML);
     options.body = soapBody;
     options.SOAPAction = `perfmonRemoveCounter`;
@@ -528,6 +594,9 @@ class perfMonService {
     };
 
     promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
 
     let output = await parseXml(await response.text());
     // Remove unnecessary keys
@@ -559,10 +628,10 @@ class perfMonService {
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
   async queryCounterDescription(object) {
-    let options = this._OPTIONS;
+    let options = { ...this._OPTIONS, headers: { ...this._OPTIONS.headers } };
     let server = this._HOST;
-    let counterStr = "<soap:Counter>" + "\\\\" + object.host + "\\" + (object.instance ? `${object.object}(${object.instance})` : object.object) + "\\" + object.counter + "</soap:Counter>";
-    let XML = util.format(XML_QUERY_COUNTER_ENVELOPE, counterStr);
+    let counterStr = buildCounterStr(object);
+    let XML = XML_QUERY_COUNTER_ENVELOPE(counterStr);
     let soapBody = Buffer.from(XML);
     options.body = soapBody;
     options.SOAPAction = `perfmonQueryCounterDescription`;
@@ -576,6 +645,9 @@ class perfMonService {
     };
 
     promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
+    if (promiseResults.cookie) {
+      this.setCookie(promiseResults.cookie);
+    }
 
     let output = await parseXml(await response.text());
     // Remove unnecessary keys
@@ -627,18 +699,26 @@ const removeKeys = (obj, keys) => {
 };
 
 const clean = (object) => {
-  Object.entries(object).forEach(([k, v]) => {
-    if (v && typeof v === "object") {
-      clean(v);
+  if (Array.isArray(object)) {
+    for (let i = object.length - 1; i >= 0; i--) {
+      const v = object[i];
+      if (v && typeof v === "object") {
+        clean(v);
+      }
+      if ((v && typeof v === "object" && !Object.keys(v).length) || v === null || v === undefined) {
+        object.splice(i, 1);
+      }
     }
-    if ((v && typeof v === "object" && !Object.keys(v).length) || v === null || v === undefined) {
-      if (Array.isArray(object)) {
-        object.splice(k, 1);
-      } else {
+  } else {
+    Object.entries(object).forEach(([k, v]) => {
+      if (v && typeof v === "object") {
+        clean(v);
+      }
+      if ((v && typeof v === "object" && !Object.keys(v).length) || v === null || v === undefined) {
         delete object[k];
       }
-    }
-  });
+    });
+  }
   return object;
 };
 

package/main.mjs

@@ -0,0 +1,5 @@
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const perfMonService = require("./main.js");
+
+export default perfMonService;

package/package.json

@@ -1,8 +1,17 @@
 {
   "name": "cisco-perfmon",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "A library to pull Perfmon data from Cisco VOS applications via SOAP",
   "main": "main.js",
+  "module": "main.mjs",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./main.mjs",
+      "require": "./main.js",
+      "types": "./types/index.d.ts"
+    }
+  },
   "scripts": {
     "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 NODE_TLS_REJECT_UNAUTHORIZED=0 NODE_ENV=test node ./test/tests.js",
     "development": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 NODE_TLS_REJECT_UNAUTHORIZED=0 NODE_ENV=development node ./test/tests.js",
@@ -20,7 +29,7 @@
     "cucm",
     "vos"
   ],
-  "author": "Jeremy Worden <jeremy@automate.builders> (https://automate.builders/)",
+  "author": "sieteunoseis <jeremy.worden@gmail.com>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/sieteunoseis/cisco-perfmon/issues"
@@ -28,13 +37,12 @@
   "homepage": "https://github.com/sieteunoseis/cisco-perfmon#readme",
   "dependencies": {
     "fetch-retry": "^6.0.0",
-    "util": "*",
-    "xml2js": "*"
+    "xml2js": "^0.6.0"
   },
   "devDependencies": {
-    "dotenv": "*",
-    "envalid": "^8.0.0",
-    "jsdoc-to-markdown": "^9.0.4",
+    "dotenv": "^17.0.0",
+    "envalid": "^8.1.0",
+    "jsdoc-to-markdown": "^9.1.0",
     "p-limit": "^3.1.0"
   }
 }

package/types/index.d.ts

@@ -0,0 +1,162 @@
+export interface PerfmonOptions {
+  Cookie?: string;
+  [key: string]: string | undefined;
+}
+
+export interface PerfmonResult {
+  cookie: string;
+  results: any;
+}
+
+export interface PerfmonCounterResult extends PerfmonResult {
+  object: string;
+}
+
+export interface CounterData {
+  host: string;
+  object: string;
+  instance: string;
+  counter: string;
+  value: string;
+  cstatus: string;
+}
+
+export interface CounterInfo {
+  Name: string;
+  MultiInstance: string;
+  ArrayOfCounter?: {
+    Counter: Array<{
+      Name: string;
+    }>;
+  };
+}
+
+export interface CounterDescription {
+  Description: string;
+  Name: string;
+}
+
+export interface Counter {
+  host: string;
+  object: string;
+  instance?: string;
+  counter: string;
+}
+
+declare class perfMonService {
+  constructor(
+    host: string,
+    username: string,
+    password: string,
+    options?: PerfmonOptions,
+    retry?: boolean
+  );
+
+  /**
+   * Get the current stored cookie
+   */
+  getCookie(): string;
+
+  /**
+   * Set a cookie to be used for subsequent requests
+   */
+  setCookie(cookie: string): void;
+
+  /**
+   * Collect counter data without a session
+   */
+  collectCounterData(
+    host: string,
+    object: string
+  ): Promise<{
+    cookie: string;
+    object: string;
+    results: CounterData[] | CounterData | string;
+  }>;
+
+  /**
+   * Collect data for an open session
+   */
+  collectSessionData(
+    SessionHandle: string
+  ): Promise<{
+    cookie: string;
+    results: CounterData[] | CounterData | string;
+  }>;
+
+  /**
+   * List available counters on a host
+   */
+  listCounter(
+    host: string,
+    filtered?: string[]
+  ): Promise<{
+    cookie: string;
+    results: CounterInfo[] | string;
+  }>;
+
+  /**
+   * List instances of a perfmon object on a host
+   */
+  listInstance(
+    host: string,
+    object: string
+  ): Promise<{
+    cookie: string;
+    object: string;
+    results: any[] | string;
+  }>;
+
+  /**
+   * Open a perfmon session
+   */
+  openSession(): Promise<{
+    cookie: string;
+    results: string;
+  }>;
+
+  /**
+   * Close a perfmon session
+   */
+  closeSession(
+    sessionHandle: string
+  ): Promise<{
+    cookie: string;
+    results: "success";
+  }>;
+
+  /**
+   * Add counter(s) to a session
+   */
+  addCounter(
+    sessionHandle: string,
+    counter: Counter | Counter[]
+  ): Promise<{
+    cookie: string;
+    results: "success";
+  }>;
+
+  /**
+   * Remove counter(s) from a session
+   */
+  removeCounter(
+    sessionHandle: string,
+    counter: Counter | Counter[]
+  ): Promise<{
+    cookie: string;
+    results: "success";
+  }>;
+
+  /**
+   * Get counter description
+   */
+  queryCounterDescription(
+    object: Counter
+  ): Promise<{
+    cookie: string;
+    object: string;
+    results: CounterDescription | string;
+  }>;
+}
+
+export = perfMonService;