cisco-axl 1.2.5 → 1.3.0

package/README.md

@@ -34,6 +34,7 @@ NODE_TLS_REJECT_UNAUTHORIZED=0
 - Supports the Promise API. Can chain procedures together or you could use Promise.all() to run multiple "get" operations at the same time.
 - Returns all results in JSON rather than XML. Function has options to remove all blank or empty fields from JSON results via optional clean parameter.
 - Support for [json-variables](https://codsen.com/os/json-variables). The executeOperation function will recognize the dataContainerIdentifierTails from json-variables and remove them from your call. This avoids any SOAP fault issues from having extra information in call. See examples folder for use case.
+- TypeScript support with type definitions for better developer experience and code reliability
 
 ## Usage
 
@@ -184,6 +185,39 @@ service.executeOperation("updateLine", lineTags,{ dataContainerIdentifierTails:
 
 Currently there is an issue with strong-soap regarding returning nillable values for element tags. These values show if a particular tags is optional or not. Once resolved a method will be added to return tags nillable status (true or false).
 
+## TypeScript Support
+
+This library includes TypeScript declarations to provide type safety and improved developer experience.
+
+### TypeScript Usage
+
+```typescript
+import axlService from 'cisco-axl';
+
+const service = new axlService(
+  "10.10.20.1",
+  "administrator",
+  "ciscopsdt",
+  "14.0"
+);
+
+async function getPartitions() {
+  try {
+    const operation = "listRoutePartition";
+    const tags = await service.getOperationTags(operation);
+    tags.searchCriteria.name = "%%";
+    
+    const result = await service.executeOperation(operation, tags);
+    return result.routePartition;
+  } catch (error) {
+    console.error("Error fetching partitions:", error);
+    throw error;
+  }
+}
+```
+
+See the `examples/typescript` directory for more TypeScript examples.
+
 ## TODO
 
 - Add more promised based examples, particularly a Promise.All() example.

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+interface OperationOptions {
+    clean?: boolean;
+    dataContainerIdentifierTails?: string;
+    removeAttributes?: boolean;
+}
+/**
+ * Cisco axlService Service
+ * This is a service class that uses fetch and promises to pull AXL data from Cisco CUCM
+ *
+ * @class axlService
+ */
+declare class axlService {
+    private _OPTIONS;
+    /**
+     * Creates an instance of axlService.
+     * @param {string} host - CUCM hostname or IP address
+     * @param {string} username - CUCM username with AXL permissions
+     * @param {string} password - CUCM password
+     * @param {string} version - CUCM version (e.g. "14.0")
+     * @memberof axlService
+     */
+    constructor(host: string, username: string, password: string, version: string);
+    /**
+     * Returns a list of available AXL operations
+     * @param {string} [filter] - Optional filter to narrow down operations
+     * @returns {Promise<string[]>} - Array of operation names
+     * @memberof axlService
+     */
+    returnOperations(filter?: string): Promise<string[]>;
+    /**
+     * Gets the tags required for a specific AXL operation
+     * @param {string} operation - The AXL operation name
+     * @returns {Promise<any>} - Object containing the required tags
+     * @memberof axlService
+     */
+    getOperationTags(operation: string): Promise<any>;
+    /**
+     * Executes an AXL operation against the CUCM
+     * @param {string} operation - The AXL operation to execute
+     * @param {any} tags - The tags required for the operation
+     * @param {OperationOptions} [opts] - Optional parameters for customizing the operation
+     * @returns {Promise<any>} - Result of the operation
+     * @memberof axlService
+     */
+    executeOperation(operation: string, tags: any, opts?: OperationOptions): Promise<any>;
+}
+export = axlService;

package/dist/index.js

@@ -0,0 +1,265 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+const soap = __importStar(require("strong-soap"));
+const path = __importStar(require("path"));
+const WSDL = soap.soap.WSDL;
+const wsdlOptions = {
+    attributesKey: "attributes",
+    valueKey: "value",
+};
+/**
+ * Cisco axlService Service
+ * This is a service class that uses fetch and promises to pull AXL data from Cisco CUCM
+ *
+ * @class axlService
+ */
+class axlService {
+    /**
+     * Creates an instance of axlService.
+     * @param {string} host - CUCM hostname or IP address
+     * @param {string} username - CUCM username with AXL permissions
+     * @param {string} password - CUCM password
+     * @param {string} version - CUCM version (e.g. "14.0")
+     * @memberof axlService
+     */
+    constructor(host, username, password, version) {
+        if (!host || !username || !password || !version)
+            throw new TypeError("missing parameters");
+        this._OPTIONS = {
+            username: username,
+            password: password,
+            url: path.join(__dirname, `../schema/${version}/AXLAPI.wsdl`),
+            endpoint: `https://${host}:8443/axl/`,
+            version: version,
+        };
+    }
+    /**
+     * Returns a list of available AXL operations
+     * @param {string} [filter] - Optional filter to narrow down operations
+     * @returns {Promise<string[]>} - Array of operation names
+     * @memberof axlService
+     */
+    returnOperations(filter) {
+        const options = this._OPTIONS;
+        return new Promise((resolve, reject) => {
+            soap.soap.createClient(options.url, wsdlOptions, function (err, client) {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                client.setSecurity(new soap.soap.BasicAuthSecurity(options.username, options.password));
+                client.setEndpoint(options.endpoint);
+                const description = client.describe();
+                const outputArr = [];
+                for (const [, 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;
+                    }
+                    return false;
+                });
+                if (filter) {
+                    resolve(matches(filter, outputArr).sort(sortAlphaNum));
+                }
+                else {
+                    resolve(outputArr.sort(sortAlphaNum));
+                }
+                client.on("soapError", function (err) {
+                    reject(err.root.Envelope.Body.Fault);
+                });
+            });
+        });
+    }
+    /**
+     * Gets the tags required for a specific AXL operation
+     * @param {string} operation - The AXL operation name
+     * @returns {Promise<any>} - Object containing the required tags
+     * @memberof axlService
+     */
+    getOperationTags(operation) {
+        const options = this._OPTIONS;
+        return new Promise((resolve, reject) => {
+            WSDL.open(path.join(__dirname, `../schema/${options.version}/AXLAPI.wsdl`), wsdlOptions, function (err, wsdl) {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                const operationDef = wsdl.definitions.bindings.AXLAPIBinding.operations[operation];
+                const operName = operationDef.$name;
+                const operationDesc = operationDef.describe(wsdl);
+                const envelopeBody = {};
+                operationDesc.input.body.elements.map((object) => {
+                    const operMatch = new RegExp(object.qname.name, "i");
+                    envelopeBody[object.qname.name] = "";
+                    if (object.qname.name === "searchCriteria") {
+                        const output = nestedObj(object);
+                        envelopeBody.searchCriteria = output;
+                    }
+                    if (object.qname.name === "returnedTags") {
+                        const output = nestedObj(object);
+                        envelopeBody.returnedTags = output;
+                    }
+                    if (operName.match(operMatch)) {
+                        const output = nestedObj(object);
+                        envelopeBody[object.qname.name] = output;
+                    }
+                });
+                resolve(envelopeBody);
+            });
+        });
+    }
+    /**
+     * Executes an AXL operation against the CUCM
+     * @param {string} operation - The AXL operation to execute
+     * @param {any} tags - The tags required for the operation
+     * @param {OperationOptions} [opts] - Optional parameters for customizing the operation
+     * @returns {Promise<any>} - Result of the operation
+     * @memberof axlService
+     */
+    executeOperation(operation, tags, opts) {
+        var _a, _b, _c;
+        const options = this._OPTIONS;
+        const clean = (_a = opts === null || opts === void 0 ? void 0 : opts.clean) !== null && _a !== void 0 ? _a : false;
+        const dataContainerIdentifierTails = (_b = opts === null || opts === void 0 ? void 0 : opts.dataContainerIdentifierTails) !== null && _b !== void 0 ? _b : "_data";
+        const removeAttributes = (_c = opts === null || opts === void 0 ? void 0 : opts.removeAttributes) !== null && _c !== void 0 ? _c : false;
+        // Let's remove empty top level strings. Also filter out json-variables
+        Object.keys(tags).forEach((k) => (tags[k] === "" || k.includes(dataContainerIdentifierTails)) && delete tags[k]);
+        return new Promise((resolve, reject) => {
+            soap.soap.createClient(options.url, wsdlOptions, function (err, client) {
+                const customRequestHeader = { connection: "keep-alive" };
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                client.setSecurity(new soap.soap.BasicAuthSecurity(options.username, options.password));
+                client.setEndpoint(options.endpoint);
+                client.on("soapError", function (err) {
+                    reject(err.root.Envelope.Body.Fault);
+                });
+                const axlFunc = client.AXLAPIService.AXLPort[operation];
+                axlFunc(tags, function (err, result) {
+                    if (err) {
+                        reject(err);
+                        return;
+                    }
+                    if (result === null || result === void 0 ? void 0 : result.hasOwnProperty("return")) {
+                        const output = result.return;
+                        if (clean) {
+                            cleanObj(output);
+                        }
+                        if (removeAttributes) {
+                            cleanAttributes(output);
+                        }
+                        resolve(output);
+                    }
+                    else {
+                        reject("No return results");
+                    }
+                }, null, customRequestHeader);
+            });
+        });
+    }
+}
+/**
+ * Creates a nested object from WSDL elements
+ * @param {any} object - The WSDL object to process
+ * @returns {any} - Processed object
+ */
+const nestedObj = (object) => {
+    const operObj = {};
+    object.elements.map((object) => {
+        operObj[object.qname.name] = "";
+        if (Array.isArray(object.elements) && object.elements.length > 0) {
+            const nestName = object.qname.name;
+            operObj[nestName] = {};
+            const nestObj = nestedObj(object);
+            operObj[nestName] = nestObj;
+        }
+    });
+    const isEmpty = Object.keys(operObj).length === 0;
+    if (isEmpty) {
+        return "";
+    }
+    else {
+        return operObj;
+    }
+};
+/**
+ * Cleans an object by removing null, undefined, or empty values
+ * @param {any} object - The object to clean
+ * @returns {any} - Cleaned object
+ */
+const cleanObj = (object) => {
+    Object.entries(object).forEach(([k, v]) => {
+        if (v && typeof v === "object") {
+            cleanObj(v);
+        }
+        if ((v && typeof v === "object" && !Object.keys(v).length) || v === null || v === undefined) {
+            if (Array.isArray(object)) {
+                object.splice(parseInt(k), 1);
+            }
+            else {
+                delete object[k];
+            }
+        }
+    });
+    return object;
+};
+/**
+ * Removes attribute fields from an object
+ * @param {any} object - The object to clean
+ * @returns {any} - Cleaned object
+ */
+const cleanAttributes = (object) => {
+    Object.entries(object).forEach(([k, v]) => {
+        if (v && typeof v === "object") {
+            cleanAttributes(v);
+        }
+        if (v && typeof v === "object" && "attributes" in object) {
+            if (Array.isArray(object)) {
+                object.splice(parseInt(k), 1);
+            }
+            else {
+                delete object[k];
+            }
+        }
+    });
+    return object;
+};
+module.exports = axlService;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAoC;AACpC,2CAA6B;AAE7B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAE5B,MAAM,WAAW,GAAG;IAClB,aAAa,EAAE,YAAY;IAC3B,QAAQ,EAAE,OAAO;CAClB,CAAC;AAgBF;;;;;GAKG;AACH,MAAM,UAAU;IAGd;;;;;;;OAOG;IACH,YAAY,IAAY,EAAE,QAAgB,EAAE,QAAgB,EAAE,OAAe;QAC3E,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC3F,IAAI,CAAC,QAAQ,GAAG;YACd,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,QAAQ;YAClB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,OAAO,cAAc,CAAC;YAC7D,QAAQ,EAAE,WAAW,IAAI,YAAY;YACrC,OAAO,EAAE,OAAO;SACjB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,MAAe;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,EAAE,UAAU,GAAQ,EAAE,MAAW;gBAC9E,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;oBACZ,OAAO;gBACT,CAAC;gBAED,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACxF,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAErC,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACtC,MAAM,SAAS,GAAa,EAAE,CAAC;gBAE/B,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC1E,SAAS,CAAC,IAAI,CAAE,KAAa,CAAC,IAAI,CAAC,CAAC;gBACtC,CAAC;gBAED,MAAM,YAAY,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC3F,MAAM,OAAO,GAAG,CAAC,SAAiB,EAAE,KAAe,EAAE,EAAE,CACrD,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;oBACvB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;wBAC5D,OAAO,IAAI,CAAC;oBACd,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC;gBAEL,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;gBACzD,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;gBACxC,CAAC;gBAED,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,GAAQ;oBACvC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,SAAiB;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,OAAO,CAAC,OAAO,cAAc,CAAC,EAAE,WAAW,EAAE,UAAU,GAAQ,EAAE,IAAS;gBACpH,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;oBACZ,OAAO;gBACT,CAAC;gBACD,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACnF,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC;gBACpC,MAAM,aAAa,GAAG,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAClD,MAAM,YAAY,GAAQ,EAAE,CAAC;gBAE7B,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;oBACpD,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;oBACrD,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;oBAErC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;wBAC3C,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;wBACjC,YAAY,CAAC,cAAc,GAAG,MAAM,CAAC;oBACvC,CAAC;oBAED,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;wBACzC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;wBACjC,YAAY,CAAC,YAAY,GAAG,MAAM,CAAC;oBACrC,CAAC;oBAED,IAAI,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC9B,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;wBACjC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;oBAC3C,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,OAAO,CAAC,YAAY,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,SAAiB,EAAE,IAAS,EAAE,IAAuB;;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE9B,MAAM,KAAK,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,mCAAI,KAAK,CAAC;QACnC,MAAM,4BAA4B,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,4BAA4B,mCAAI,OAAO,CAAC;QACnF,MAAM,gBAAgB,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,mCAAI,KAAK,CAAC;QAEzD,uEAAuE;QACvE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,4BAA4B,CAAC,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,EAAE,UAAU,GAAQ,EAAE,MAAW;gBAC9E,MAAM,mBAAmB,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC;gBAEzD,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;oBACZ,OAAO;gBACT,CAAC;gBAED,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACxF,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAErC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,GAAQ;oBACvC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;gBAEH,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBAExD,OAAO,CACL,IAAI,EACJ,UAAU,GAAQ,EAAE,MAAW;oBAC7B,IAAI,GAAG,EAAE,CAAC;wBACR,MAAM,CAAC,GAAG,CAAC,CAAC;wBACZ,OAAO;oBACT,CAAC;oBAED,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACrC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;wBAE7B,IAAI,KAAK,EAAE,CAAC;4BACV,QAAQ,CAAC,MAAM,CAAC,CAAC;wBACnB,CAAC;wBAED,IAAI,gBAAgB,EAAE,CAAC;4BACrB,eAAe,CAAC,MAAM,CAAC,CAAC;wBAC1B,CAAC;wBAED,OAAO,CAAC,MAAM,CAAC,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,mBAAmB,CAAC,CAAC;oBAC9B,CAAC;gBACH,CAAC,EACD,IAAI,EACJ,mBAAmB,CACpB,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,SAAS,GAAG,CAAC,MAAW,EAAO,EAAE;IACrC,MAAM,OAAO,GAAQ,EAAE,CAAC;IAExB,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAEhC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjE,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YACnC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;YAClC,OAAO,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC;QAC9B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IAElD,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,QAAQ,GAAG,CAAC,MAAW,EAAO,EAAE;IACpC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QACxC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC/B,QAAQ,CAAC,CAAC,CAAC,CAAC;QACd,CAAC;QAED,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YAC5F,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,eAAe,GAAG,CAAC,MAAW,EAAO,EAAE;IAC3C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QACxC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC/B,eAAe,CAAC,CAAC,CAAC,CAAC;QACrB,CAAC;QAED,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,YAAY,IAAI,MAAM,EAAE,CAAC;YACzD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,iBAAS,UAAU,CAAC"}

package/examples/typescript/README.md

@@ -0,0 +1,44 @@
+# TypeScript Example
+
+This example demonstrates how to use the cisco-axl library with TypeScript.
+
+## Prerequisites
+
+- Node.js v16.15.0 or later
+- TypeScript installed globally: `npm install -g typescript`
+
+## Running the Example
+
+1. Build the project first:
+   ```
+   npm run build
+   ```
+
+2. Update the example.ts file with your CUCM server details:
+   ```typescript
+   const service = new axlService(
+     "your-cucm-hostname",
+     "username",
+     "password",
+     "14.0" // CUCM version
+   );
+   ```
+
+3. Run the example:
+   ```
+   npx ts-node example.ts
+   ```
+
+## Features Demonstrated
+
+- TypeScript type definitions
+- Async/await syntax with proper error handling
+- Adding a route partition
+- Listing route partitions
+
+## TypeScript Benefits
+
+- Static type checking
+- Better IDE autocompletion
+- Improved documentation with JSDoc comments
+- More maintainable codebase

package/examples/typescript/example.ts

@@ -0,0 +1,94 @@
+import axlService from '../../src/index';
+import { cleanEnv, str, host, makeValidator } from 'envalid';
+import path from 'path';
+import dotenv from 'dotenv';
+
+// Load environment variables from the appropriate .env file
+if (process.env.NODE_ENV === "development") {
+  dotenv.config({ path: path.join(__dirname, '..', '..', 'env', 'development.env') });
+} else if (process.env.NODE_ENV === "test") {
+  dotenv.config({ path: path.join(__dirname, '..', '..', 'env', 'test.env') });
+}
+
+// Validator for CUCM version format
+const versionValid = makeValidator(x => {
+  if (/.*\..*[^\\]/.test(x)) return x.toUpperCase();
+  else throw new Error('CUCM_VERSION must be in the format of ##.#');
+});
+
+// Clean and validate environment variables
+const env = cleanEnv(process.env, {
+  NODE_ENV: str({
+    choices: ["development", "test", "production", "staging"],
+    desc: "Node environment",
+    default: "development"
+  }),
+  CUCM_HOSTNAME: host({ 
+    desc: "Cisco CUCM Hostname or IP Address.",
+    default: "cucm01-pub.automate.builder" 
+  }),
+  CUCM_USERNAME: str({ 
+    desc: "Cisco CUCM AXL Username.",
+    default: "perfmon"
+  }),
+  CUCM_PASSWORD: str({ 
+    desc: "Cisco CUCM AXL Password.",
+    default: "perfmon"
+  }),
+  CUCM_VERSION: versionValid({ 
+    desc: "Cisco CUCM Version.", 
+    example: "12.5",
+    default: "15.0"
+  })
+});
+
+async function main() {
+  try {
+    // Initialize AXL service using environment variables
+    const service = new axlService(
+      env.CUCM_HOSTNAME,
+      env.CUCM_USERNAME,
+      env.CUCM_PASSWORD,
+      env.CUCM_VERSION
+    );
+    
+    // Example of adding a route partition
+    const operation = "addRoutePartition";
+    const tags = {
+      routePartition: {
+        name: "TYPESCRIPT-PT",
+        description: "Created with TypeScript",
+        timeScheduleIdName: "",
+        useOriginatingDeviceTimeZone: "",
+        timeZone: "",
+        partitionUsage: "",
+      },
+    };
+    
+    console.log("Adding route partition...");
+    const result = await service.executeOperation(operation, tags);
+    console.log("Route partition added with UUID:", result);
+    
+    // Example of listing route partitions
+    const listOperation = "listRoutePartition";
+    const listTags = await service.getOperationTags(listOperation);
+    listTags.searchCriteria.name = "%%";
+    
+    console.log("Listing route partitions...");
+    const partitions = await service.executeOperation(listOperation, listTags);
+    
+    // Display the partitions
+    console.log("Route partitions:");
+    if (Array.isArray(partitions.routePartition)) {
+      partitions.routePartition.forEach((partition: any) => {
+        console.log(`- ${partition.name}`);
+      });
+    } else if (partitions.routePartition) {
+      console.log(`- ${partitions.routePartition.name}`);
+    }
+  } catch (error) {
+    console.error("Error:", error);
+  }
+}
+
+main();

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "cisco-axl",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "description": "A library to make Cisco AXL a lot easier",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
     "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",
     "staging": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 NODE_TLS_REJECT_UNAUTHORIZED=0 NODE_ENV=staging node ./test/tests.js",
-    "wsdl": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 NODE_TLS_REJECT_UNAUTHORIZED=0 NODE_ENV=staging node ./test/wsdl.js"
+    "wsdl": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 NODE_TLS_REJECT_UNAUTHORIZED=0 NODE_ENV=staging node ./test/wsdl.js",
+    "type-check": "tsc --noEmit",
+    "ts-example": "ts-node examples/typescript/example.ts"
   },
   "repository": {
     "type": "git",
@@ -31,9 +36,12 @@
     "strong-soap": "^4.1.5"
   },
   "devDependencies": {
+    "@types/node": "^22.13.5",
     "dotenv": "*",
     "envalid": "*",
     "json-variables": "^10.1.0",
-    "node-emoji": "*"
+    "node-emoji": "*",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3"
   }
 }

package/src/index.ts

@@ -0,0 +1,286 @@
+import * as soap from 'strong-soap';
+import * as path from 'path';
+
+const WSDL = soap.soap.WSDL;
+
+const wsdlOptions = {
+  attributesKey: "attributes",
+  valueKey: "value",
+};
+
+interface AXLServiceOptions {
+  username: string;
+  password: string;
+  url: string;
+  endpoint: string;
+  version: string;
+}
+
+interface OperationOptions {
+  clean?: boolean;
+  dataContainerIdentifierTails?: string;
+  removeAttributes?: boolean;
+}
+
+/**
+ * Cisco axlService Service
+ * This is a service class that uses fetch and promises to pull AXL data from Cisco CUCM
+ *
+ * @class axlService
+ */
+class axlService {
+  private _OPTIONS: AXLServiceOptions;
+
+  /**
+   * Creates an instance of axlService.
+   * @param {string} host - CUCM hostname or IP address
+   * @param {string} username - CUCM username with AXL permissions
+   * @param {string} password - CUCM password
+   * @param {string} version - CUCM version (e.g. "14.0")
+   * @memberof axlService
+   */
+  constructor(host: string, username: string, password: string, version: string) {
+    if (!host || !username || !password || !version) throw new TypeError("missing parameters");
+    this._OPTIONS = {
+      username: username,
+      password: password,
+      url: path.join(__dirname, `../schema/${version}/AXLAPI.wsdl`),
+      endpoint: `https://${host}:8443/axl/`,
+      version: version,
+    };
+  }
+
+  /**
+   * Returns a list of available AXL operations
+   * @param {string} [filter] - Optional filter to narrow down operations
+   * @returns {Promise<string[]>} - Array of operation names
+   * @memberof axlService
+   */
+  returnOperations(filter?: string): Promise<string[]> {
+    const options = this._OPTIONS;
+    return new Promise((resolve, reject) => {
+      soap.soap.createClient(options.url, wsdlOptions, function (err: any, client: any) {
+        if (err) {
+          reject(err);
+          return;
+        }
+
+        client.setSecurity(new soap.soap.BasicAuthSecurity(options.username, options.password));
+        client.setEndpoint(options.endpoint);
+
+        const description = client.describe();
+        const outputArr: string[] = [];
+
+        for (const [, value] of Object.entries(description.AXLAPIService.AXLPort)) {
+          outputArr.push((value as any).name);
+        }
+        
+        const sortAlphaNum = (a: string, b: string) => a.localeCompare(b, "en", { numeric: true });
+        const matches = (substring: string, array: string[]) =>
+          array.filter((element) => {
+            if (element.toLowerCase().includes(substring.toLowerCase())) {
+              return true;
+            }
+            return false;
+          });
+
+        if (filter) {
+          resolve(matches(filter, outputArr).sort(sortAlphaNum));
+        } else {
+          resolve(outputArr.sort(sortAlphaNum));
+        }
+
+        client.on("soapError", function (err: any) {
+          reject(err.root.Envelope.Body.Fault);
+        });
+      });
+    });
+  }
+
+  /**
+   * Gets the tags required for a specific AXL operation
+   * @param {string} operation - The AXL operation name
+   * @returns {Promise<any>} - Object containing the required tags
+   * @memberof axlService
+   */
+  getOperationTags(operation: string): Promise<any> {
+    const options = this._OPTIONS;
+    return new Promise((resolve, reject) => {
+      WSDL.open(path.join(__dirname, `../schema/${options.version}/AXLAPI.wsdl`), wsdlOptions, function (err: any, wsdl: any) {
+        if (err) {
+          reject(err);
+          return;
+        }
+        const operationDef = wsdl.definitions.bindings.AXLAPIBinding.operations[operation];
+        const operName = operationDef.$name;
+        const operationDesc = operationDef.describe(wsdl);
+        const envelopeBody: any = {};
+        
+        operationDesc.input.body.elements.map((object: any) => {
+          const operMatch = new RegExp(object.qname.name, "i");
+          envelopeBody[object.qname.name] = "";
+          
+          if (object.qname.name === "searchCriteria") {
+            const output = nestedObj(object);
+            envelopeBody.searchCriteria = output;
+          }
+          
+          if (object.qname.name === "returnedTags") {
+            const output = nestedObj(object);
+            envelopeBody.returnedTags = output;
+          }
+          
+          if (operName.match(operMatch)) {
+            const output = nestedObj(object);
+            envelopeBody[object.qname.name] = output;
+          }
+        });
+        
+        resolve(envelopeBody);
+      });
+    });
+  }
+
+  /**
+   * Executes an AXL operation against the CUCM
+   * @param {string} operation - The AXL operation to execute
+   * @param {any} tags - The tags required for the operation
+   * @param {OperationOptions} [opts] - Optional parameters for customizing the operation
+   * @returns {Promise<any>} - Result of the operation
+   * @memberof axlService
+   */
+  executeOperation(operation: string, tags: any, opts?: OperationOptions): Promise<any> {
+    const options = this._OPTIONS;
+
+    const clean = opts?.clean ?? false;
+    const dataContainerIdentifierTails = opts?.dataContainerIdentifierTails ?? "_data";
+    const removeAttributes = opts?.removeAttributes ?? false;
+
+    // Let's remove empty top level strings. Also filter out json-variables
+    Object.keys(tags).forEach((k) => (tags[k] === "" || k.includes(dataContainerIdentifierTails)) && delete tags[k]);
+
+    return new Promise((resolve, reject) => {
+      soap.soap.createClient(options.url, wsdlOptions, function (err: any, client: any) {
+        const customRequestHeader = { connection: "keep-alive" };
+        
+        if (err) {
+          reject(err);
+          return;
+        }
+        
+        client.setSecurity(new soap.soap.BasicAuthSecurity(options.username, options.password));
+        client.setEndpoint(options.endpoint);
+
+        client.on("soapError", function (err: any) {
+          reject(err.root.Envelope.Body.Fault);
+        });
+
+        const axlFunc = client.AXLAPIService.AXLPort[operation];
+
+        axlFunc(
+          tags,
+          function (err: any, result: any) {
+            if (err) {
+              reject(err);
+              return;
+            }
+            
+            if (result?.hasOwnProperty("return")) {
+              const output = result.return;
+              
+              if (clean) {
+                cleanObj(output);
+              }
+              
+              if (removeAttributes) {
+                cleanAttributes(output);
+              }
+              
+              resolve(output);
+            } else {
+              reject("No return results");
+            }
+          },
+          null,
+          customRequestHeader
+        );
+      });
+    });
+  }
+}
+
+/**
+ * Creates a nested object from WSDL elements
+ * @param {any} object - The WSDL object to process
+ * @returns {any} - Processed object
+ */
+const nestedObj = (object: any): any => {
+  const operObj: any = {};
+  
+  object.elements.map((object: any) => {
+    operObj[object.qname.name] = "";
+    
+    if (Array.isArray(object.elements) && object.elements.length > 0) {
+      const nestName = object.qname.name;
+      operObj[nestName] = {};
+      const nestObj = nestedObj(object);
+      operObj[nestName] = nestObj;
+    }
+  });
+  
+  const isEmpty = Object.keys(operObj).length === 0;
+  
+  if (isEmpty) {
+    return "";
+  } else {
+    return operObj;
+  }
+};
+
+/**
+ * Cleans an object by removing null, undefined, or empty values
+ * @param {any} object - The object to clean
+ * @returns {any} - Cleaned object
+ */
+const cleanObj = (object: any): any => {
+  Object.entries(object).forEach(([k, v]) => {
+    if (v && typeof v === "object") {
+      cleanObj(v);
+    }
+    
+    if ((v && typeof v === "object" && !Object.keys(v).length) || v === null || v === undefined) {
+      if (Array.isArray(object)) {
+        object.splice(parseInt(k), 1);
+      } else {
+        delete object[k];
+      }
+    }
+  });
+  
+  return object;
+};
+
+/**
+ * Removes attribute fields from an object
+ * @param {any} object - The object to clean
+ * @returns {any} - Cleaned object
+ */
+const cleanAttributes = (object: any): any => {
+  Object.entries(object).forEach(([k, v]) => {
+    if (v && typeof v === "object") {
+      cleanAttributes(v);
+    }
+    
+    if (v && typeof v === "object" && "attributes" in object) {
+      if (Array.isArray(object)) {
+        object.splice(parseInt(k), 1);
+      } else {
+        delete object[k];
+      }
+    }
+  });
+  
+  return object;
+};
+
+export = axlService;

package/src/types/strong-soap.d.ts

@@ -0,0 +1,13 @@
+declare module 'strong-soap' {
+  export namespace soap {
+    export class WSDL {
+      static open(wsdlUri: string, options: any, callback: (err: any, wsdl: any) => void): void;
+    }
+    
+    export function createClient(wsdlPath: string, options: any, callback: (err: any, client: any) => void): void;
+    
+    export class BasicAuthSecurity {
+      constructor(username: string, password: string);
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2018",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "typeRoots": [
+      "./node_modules/@types",
+      "./src/types"
+    ]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.test.ts"]
+}