add: parse the issue's name from the xml file

Author: Fubinator

README.md

@@ -1,6 +1,6 @@
 <h1 align="center">burp.js by <a href="https://turingsecure.com" target="_blank">turingsecure.</a></h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-0.1.1-blue.svg?cacheSeconds=2592000" />
+  <img alt="Version" src="https://img.shields.io/badge/version-0.1.2-blue.svg?cacheSeconds=2592000" />
   <a href="#" target="_blank">
     <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
   </a>
@@ -50,6 +50,7 @@ An issue object has the following properties:
 | Property                     | Type               |
 | ---------------------------- | ------------------ |
 | serialNumber                 | string             |
+| name                         | string             |
 | type                         | string             |
 | host                         | string             |
 | path                         | string             |
@@ -78,5 +79,5 @@ Feel free to check out the [issues page](https://github.com/turingsecure/burp.js
 
 ## License
 
-Copyright © 2021 [turingsecure](https://turingsecure.com).
+Copyright © 2025 [turingsecure](https://turingsecure.com).
 This project is [MIT](LICENSE) licensed.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turingsecure/burp.js",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Client side parser for Burp Suite XML output files.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,22 +25,12 @@
     "type": "git",
     "url": "https://github.com/turingsecure/burp.js.git"
   },
-  "keywords": [
-    "burp",
-    "xml",
-    "parser",
-    "security",
-    "javascript",
-    "itsec"
-  ],
+  "keywords": ["burp", "xml", "parser", "security", "javascript", "itsec"],
   "jest": {
     "transform": {
       "^.+\\.tsx?$": "ts-jest"
     },
-    "moduleFileExtensions": [
-      "ts",
-      "js"
-    ],
+    "moduleFileExtensions": ["ts", "js"],
     "testRegex": "^.+\\.spec\\.ts$"
   },
   "author": "turingsecure",

src/index.ts

@@ -6,6 +6,7 @@ interface RequestResponse {
 
 interface Issue {
   serialNumber?: string;
+  name?: string;
   type?: string;
   host?: string;
   path?: string;
@@ -28,7 +29,10 @@ function getTextContent(nodes: Node[], property: string): string | undefined {
   return findChildNode(nodes, property)?.textContent;
 }
 
-function parseRequestResponse(nodes: Node[], isBase64Encoded: boolean): RequestResponse[] {
+function parseRequestResponse(
+  nodes: Node[],
+  isBase64Encoded: boolean
+): RequestResponse[] {
   const requestResponseNodes = nodes.filter(
     (childNode: Node) => childNode.nodeName === "requestresponse"
   );
@@ -41,7 +45,8 @@ function parseRequestResponse(nodes: Node[], isBase64Encoded: boolean): RequestR
     const responseRequestObject: RequestResponse = {
       request: getTextContent(childNodes, "request"),
       response: getTextContent(childNodes, "response"),
-      responseRedirected: getTextContent(childNodes, "responseRedirected") === "true"
+      responseRedirected:
+        getTextContent(childNodes, "responseRedirected") === "true",
     };
 
     if (isBase64Encoded) {
@@ -63,6 +68,7 @@ function createIssueObject(node: ChildNode, isBase64Encoded: boolean): Issue {
 
   const issueObject: Issue = {
     serialNumber: getTextContent(childNodes, "serialNumber"),
+    name: getTextContent(childNodes, "name"),
     type: getTextContent(childNodes, "type"),
     host: getTextContent(childNodes, "host"),
     path: getTextContent(childNodes, "path"),
@@ -71,10 +77,13 @@ function createIssueObject(node: ChildNode, isBase64Encoded: boolean): Issue {
     confidence: getTextContent(childNodes, "confidence"),
     issueBackground: getTextContent(childNodes, "issueBackground"),
     remediationBackground: getTextContent(childNodes, "remediationBackground"),
-    vulnerabilityClassifications: getTextContent(childNodes, "vulnerabilityClassifications"),
+    vulnerabilityClassifications: getTextContent(
+      childNodes,
+      "vulnerabilityClassifications"
+    ),
     issueDetail: getTextContent(childNodes, "issueDetail"),
     references: getTextContent(childNodes, "references"),
-    requestresponse: parseRequestResponse(childNodes, isBase64Encoded)
+    requestresponse: parseRequestResponse(childNodes, isBase64Encoded),
   };
 
   return issueObject;

test/index.spec.ts

@@ -3,11 +3,15 @@ const path = require("path");
 const { BurpParser } = require("../src/index");
 
 const xml = fs.readFileSync(path.join(__dirname, "__testdata__", "scan.xml"));
-const shortXml = fs.readFileSync(path.join(__dirname, "__testdata__", "short-scan.xml"));
+const shortXml = fs.readFileSync(
+  path.join(__dirname, "__testdata__", "short-scan.xml")
+);
 const shortXmlBase64 = fs.readFileSync(
   path.join(__dirname, "__testdata__", "short-scan-base64.xml")
 );
-const xmlBase64 = fs.readFileSync(path.join(__dirname, "__testdata__", "scan-base64.xml"));
+const xmlBase64 = fs.readFileSync(
+  path.join(__dirname, "__testdata__", "scan-base64.xml")
+);
 
 describe("BurpParser", () => {
   it("Should return a list of issues", () => {
@@ -22,6 +26,7 @@ describe("BurpParser", () => {
     const [firstIssue] = issues;
 
     expect(firstIssue).toHaveProperty("serialNumber");
+    expect(firstIssue).toHaveProperty("name");
     expect(firstIssue).toHaveProperty("type");
     expect(firstIssue).toHaveProperty("host");
     expect(firstIssue).toHaveProperty("path");