cisco-axl 1.0.1

package/README.md

@@ -0,0 +1,78 @@
+# Cisco AXL SOAP Library
+
+Simple library to pull AXL data Cisco CUCM via SOAP. The goal of this project is to make it easier for people to use AXL and to include all functionality of AXL!
+
+Administrative XML (AXL) information can be found at:
+[Administrative XML (AXL) Reference](https://developer.cisco.com/docs/axl/#!axl-developer-guide).
+
+## Installation
+
+Using npm:
+
+```javascript
+npm i -g npm
+npm i --save cisco-axl
+```
+
+## Requirements
+
+This package uses the built in Fetch API of Node. This feature was first introduced in Node v16.15.0. You may need to enable expermential vm module. Also you can disable warnings with an optional enviromental variable.
+
+Also if you are using self signed certificates on Cisco VOS products you may need to disable TLS verification. This makes TLS, and HTTPS by extension, insecure. The use of this environment variable is strongly discouraged. Please only do this in a lab enviroment.
+
+Suggested enviromental variables:
+
+```env
+NODE_OPTIONS=--experimental-vm-modules
+NODE_NO_WARNINGS=1
+NODE_TLS_REJECT_UNAUTHORIZED=0
+```
+
+## Features
+
+* This library uses strong-soap to parse the AXL WSDL file. As a result any AXL function for your specified version is avaliable to use!
+* Supports the Promise API
+* Returns all results in JSON rather than XML
+* Automatically cleans up SQL queries to avoid injection
+
+## Usage
+
+```javascript
+const axlService = require("cisco-axl");
+
+let service = new axlService("10.10.20.1", "administrator", "ciscopsdt");
+
+var method = "addRoutePartition";
+var params = {
+  routePartition: {
+    name: 'INTERNAL-PT',
+    description: 'Internal directory numbers',
+    timeScheduleIdName: '',
+    useOriginatingDeviceTimeZone: '',
+    timeZone: '',
+    partitionUsage: ''
+  }
+};
+
+service
+.executeMethod(method, params)
+.then((results) => {
+    console.log(`Here are a list of all the partitions on our cluster:`);
+    results.routePartition.map((str) => {
+        console.log(str.name);
+    });
+})
+.catch((error) => {
+    console.log(error);
+});
+```
+
+## Examples
+
+Check /test/tests.js for more examples.
+
+```javascript
+npm run test
+```
+
+Note: Test are using Cisco's DevNet sandbox information. Find more information here: [Cisco DevNet](https://devnetsandbox.cisco.com/)

package/index.js

@@ -0,0 +1,157 @@
+var soap = require("strong-soap").soap;
+var XMLHandler = soap.XMLHandler;
+var xmlHandler = new XMLHandler();
+var WSDL = soap.WSDL;
+
+/**
+ * Cisco axlService Service
+ * This is a service class that uses fetch and promises to pull AXL data from Cisco CUCM
+ *
+ *
+ * @class axlService
+ */
+class axlService {
+  constructor(host, username, password, version) {
+    this._OPTIONS = {
+      username: username,
+      password: password,
+      url: `./schema/${version}/AXLAPI.wsdl`,
+      endpoint: `https://${host}:8443/axl/`,
+      version: version,
+    };
+  }
+  returnMethods(filter) {
+    var options = this._OPTIONS;
+    return new Promise((resolve, reject) => {
+      soap.createClient(options.url, {}, function (err, client) {
+        client.setSecurity(
+          new soap.BasicAuthSecurity(options.username, options.password)
+        );
+        client.setEndpoint(options.endpoint);
+
+        var description = client.describe();
+
+        var outputArr = [];
+
+        for (const [key, value] of Object.entries(
+          description.AXLAPIService.AXLPort
+        )) {
+          outputArr.push(value.name);
+        }
+        const sortAlphaNum = (a, b) =>
+          a.localeCompare(b, "en", { numeric: true });
+        const matches = (substring, array) =>
+          array.filter((element) => {
+            if (element.toLowerCase().includes(substring.toLowerCase())) {
+              return true;
+            }
+          });
+
+        if (filter) {
+          resolve(matches(filter, outputArr).sort(sortAlphaNum));
+        } else {
+          resolve(outputArr.sort(sortAlphaNum));
+        }
+
+        client.on("soapError", function (err) {
+          reject(err.root.Envelope.Body.Fault);
+        });
+      });
+    });
+  }
+  getMethodParams(method) {
+    var options = this._OPTIONS;
+    return new Promise((resolve, reject) => {
+      WSDL.open(
+        `./schema/${options.version}/AXLAPI.wsdl`,
+        {},
+        function (err, wsdl) {
+          if (err) {
+            reject(err);
+          }
+          var operation =
+            wsdl.definitions.bindings.AXLAPIBinding.operations[method];
+          var operName = operation.$name;
+          var operationDesc = operation.describe(wsdl);
+          var envelopeBody = {};
+          operationDesc.input.body.elements.map((object) => {
+            var operMatch = new RegExp(object.qname.name, "i");
+            envelopeBody[object.qname.name] = "";
+            if (object.qname.name === "searchCriteria") {
+              let output = nestedObj(object);
+              envelopeBody.searchCriteria = output;
+            }
+            if (object.qname.name === "returnedTags") {
+              let output = nestedObj(object);
+              envelopeBody.returnedTags = output;
+            }
+            if (operName.match(operMatch)) {
+              let output = nestedObj(object);
+              envelopeBody[object.qname.name] = output;
+            }
+          });
+          resolve(envelopeBody);
+        }
+      );
+    });
+  }
+  executeMethod(method, params) {
+    var options = this._OPTIONS;
+    var cleanParams = Object.fromEntries(
+      Object.entries(params).filter(([_, v]) => v != "")
+    );
+    return new Promise((resolve, reject) => {
+      soap.createClient(options.url, {}, function (err, client) {
+        client.setSecurity(
+          new soap.BasicAuthSecurity(options.username, options.password)
+        );
+        client.setEndpoint(options.endpoint);
+
+        client.on("soapError", function (err) {
+          reject(err.root.Envelope.Body.Fault);
+        });
+
+        var axlFunc = client.AXLAPIService.AXLPort[method];
+
+        axlFunc(
+          cleanParams,
+          function (
+            err,
+            result,
+            envelope,
+            rawResponse,
+            soapHeader,
+            rawRequest
+          ) {
+            if (err) {
+              reject(err);
+            }
+            resolve(result.return);
+          }
+        );
+      });
+    });
+  }
+}
+
+const nestedObj = (object) => {
+  var operObj = {};
+  object.elements.map((object) => {
+    operObj[object.qname.name] = "";
+    if (Array.isArray(object.elements) && object.elements.length > 0) {
+      var nestName = object.qname.name;
+      operObj[nestName] = {};
+      var nestObj = nestedObj(object);
+      operObj[nestName] = nestObj;
+    }
+  });
+  const isEmpty = Object.keys(operObj).length === 0;
+  if (isEmpty) {
+    operObj = "";
+    return operObj;
+  } else {
+    return operObj;
+  }
+};
+
+module.exports = axlService;

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "cisco-axl",
+  "version": "1.0.1",
+  "description": "Package to make Cisco AXL easier",
+  "main": "index.js",
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 NODE_TLS_REJECT_UNAUTHORIZED=0 node ./test/tests.js"
+  },
+  "keywords": [
+    "cisco",
+    "node",
+    "axl",
+    "soap",
+    "xml",
+    "callmanager"
+  ],
+  "author": "Jeremy Worden",
+  "license": "MIT",
+  "dependencies": {
+    "soap": "^0.45.0",
+    "strong-soap": "^3.4.0"
+  },
+  "devDependencies": {
+    "node-emoji": "^1.11.0"
+  }
+}