@mitre/inspec-objects 0.0.30 → 0.0.32

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+lib

package/.eslintrc

@@ -0,0 +1,41 @@
+{
+    "rules": {
+      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/no-explicit-any": "off",
+      "unicorn/filename-case": "off",
+      "unicorn/prefer-node-protocol": "off",
+      "unicorn/numeric-separators-style": "off",
+      "unicorn/no-hex-escape": "off",
+      "unicorn/better-regex": "off",
+      "unicorn/no-zero-fractions": "off",
+      "unicorn/no-array-for-each": "off",
+      "unicorn/explicit-length-check": "off",
+      "unicorn/no-process-exit": "off",
+      "no-process-exit": "off",
+      "no-await-in-loop": "off",
+      "no-control-regex": "off",
+      "max-nested-callbacks": "off",
+      "unicorn/prefer-json-parse-buffer": "off",
+      "camelcase": "off", // Camel case fields are used in CKL
+      "no-console": "off",
+      "node/no-missing-import": "off",
+      "complexity": "off",
+      "no-constant-condition": "off",
+      "keyword-spacing": 2,
+      "space-before-blocks":"warn",
+      "space-in-parens": 2,
+      "indent": ["error", 2, { "SwitchCase": 1 }],
+      "quotes": [2, "single", { "avoidEscape": true }],
+      "object-curly-spacing": [2, "never"]
+    },
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended"
+    ]    
+  }

package/.github/workflows/e2e-test.yml

@@ -4,35 +4,22 @@ on:
   push:
     branches: [ main ]
   pull_request:
-    branches: [ main ]
 
 jobs:
   build:
     runs-on: ubuntu-20.04
 
     steps:
-     - uses: actions/checkout@v2
-
-     - name: Cache node modules
-       uses: actions/cache@v2
-       env:
-         cache-name: cache-node-modules
-       with:
-         # npm cache files are stored in `~/.npm` on Linux/macOS
-         path: ~/.npm
-         key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
-         restore-keys: |
-           ${{ runner.os }}-build-${{ env.cache-name }}-
-           ${{ runner.os }}-build-
-           ${{ runner.os }}-
+     - uses: actions/checkout@v3
 
      - name: Setup Node.js
-       uses: actions/setup-node@v1
+       uses: actions/setup-node@v3
        with:
-        node-version: '16.x'
+        node-version: 18
+        cache: 'npm'
 
      - name: Install dependencies
-       run: npm install
+       run: npm ci
 
      - name: Run e2e tests
-       run: yarn test
+       run: npm test

package/.github/workflows/linter.yml

@@ -0,0 +1,27 @@
+
+name: Lint TS-InSpec-Objects
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    steps:
+     - name: Checkout code
+       uses: actions/checkout@v3
+
+     - name: Setup Node.js
+       uses: actions/setup-node@v3
+       with:
+        node-version: 18
+        cache: 'npm'
+
+     - name: Install project dependencies
+       run: npm ci
+
+     - name: Run lint
+       run: npm run lint:ci

package/.github/workflows/push-to-gpr.yml

@@ -0,0 +1,36 @@
+name: Build and Release NPM to GPR (GitHub Package Registry)
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          registry-url: https://npm.pkg.github.com/
+          scope: '@mitre'
+
+      - name: Build the NPM Package
+        run: |
+          npm install
+          npm run build
+      - name: Pack all items that are published
+        run: npm pack
+      # Setup .npmrc file to publish to GitHub Package Registry
+      - uses: actions/setup-node@v1
+        with:
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@mitre'
+
+      # Publish inspec-objects to GitHub Package Registry
+      - name: Publish inspec-objects to GPR
+        run: npm publish mitre-inspec-objects-*.tgz
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/push-to-npm.yml

@@ -0,0 +1,34 @@
+name: Push @mitre/inspec-objects to NPM
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install project dependencies
+        run: npm ci
+
+      - name: Remove testing resources
+        run: rm -rf test
+
+      - name: Build
+        run: npm run build
+
+      - name: Pack all items that are published as packages
+        run: npm pack
+
+      - name: Publish inspec-objects to NPM
+        run: npm publish --access public mitre-inspec-objects-*.tgz
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -1,6 +1,54 @@
 # ts-inspec-objects
 Typescript objects for InSpec profiles
 
+This repository contains the source code that facilitates the writing of InSpec profiles (for use in things like stub generation and delta comparisons) more consistent with `Chef Cookstyle` formatting for ease of use when comparing with new changes from delta and when generating InSpec stubs that match a standard format. 
+
+For more information about Chef Cookstyle see: 
+ - [chef/cookstyle on GitHub](https://github.com/chef/cookstyle)
+ - [Chef Cookstyle on Chef documents page](https://docs.chef.io/workstation/cookstyle/)
+
+## How to Use
+The process code maintained in this repository generates a `npm` executable that is published to the `npm registry` as [mitre-inspec-objects](https://www.npmjs.com/package/@mitre/inspec-objects).
+
+To use the `mitre-inspec-objects` npm package, simply add the package as a dependency to your project application using the npm install command:
+```
+npm install mitre-inspec-objects
+```
+The package is a CommonJS-based npm written in TypeScript 
+
+## Parsing Process
+
+When using this library to parse `InSpec profiles` or `xccdf files` for the purposes of generating InSpec profiles, the general workflow is as follows:
+```
+  - The input is processed, read into a typescript object
+  - Operated on with any required action / logic
+  - Then written into an InSpec profile as output. 
+```
+This means that we can not simply write out in the same format we got in. Instead, we have to make choices about formatting for how to write out content.
+
+Here are some formatting choices that are being made.
+
+1. String quotation
+
+      | The string contains | Use	|
+      |--------	|--------------------	|
+      | single (') and double (") quotes| percent string syntax - %q() |
+      | single (') quotes | double (") quotes |
+      | other | single (') quotes	|
+
+2. Tag keywords are not quoted (ex: tag severity: 'medium')
+3. Each control file ends with a newline
+
+### Workflow graphical representation
+<div align="center">
+  <img src="images/ts-inspec-objects.jpg" alt="Typescript Objects Generation Process" title="Typescript Objects Generation Process">
+</div>
+
+### Delta and Stub Process
+<div align="center">
+  <img src="images/Delta_Process.jpg" alt="Delta and Stub Generation Process" title="Delta and Stub Generation Process">
+</div>
+
 ### NOTICE
 
 © 2018-2022 The MITRE Corporation.

package/lib/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./objects/control";
-export * from "./objects/profile";
-export * from "./parsers/json";
-export * from "./parsers/oval";
-export * from "./parsers/xccdf";
-export * from "./utilities/diff";
-export * from "./utilities/update";
+export * from './objects/control';
+export * from './objects/profile';
+export * from './parsers/json';
+export * from './parsers/oval';
+export * from './parsers/xccdf';
+export * from './utilities/diff';
+export * from './utilities/update';

package/lib/objects/control.d.ts

@@ -1,4 +1,4 @@
-import { ExecJSON } from "inspecjs";
+import { ExecJSON } from 'inspecjs';
 export declare function objectifyDescriptions(descs: ExecJSON.ControlDescription[] | {
     [key: string]: string | undefined;
 } | null | undefined): {
@@ -49,5 +49,5 @@ export default class Control {
     };
     constructor(data?: Partial<Control>);
     toUnformattedObject(): Control;
-    toRuby(lineLength?: number): string;
+    toRuby(): string;
 }

package/lib/objects/control.js

@@ -36,25 +36,36 @@ class Control {
         });
         return new Control((0, flat_1.unflatten)(flattened));
     }
-    toRuby(lineLength = 80) {
-        let result = "# encoding: UTF-8\n\n";
-        result += `control "${this.id}" do\n`;
+    toRuby() {
+        let result = '';
+        result += `control '${this.id}' do\n`;
         if (this.title) {
-            result += `  title "${(0, global_1.escapeDoubleQuotes)((0, global_1.removeNewlinePlaceholders)(this.title))}"\n`;
+            result += `  title ${(0, global_1.escapeQuotes)(this.title)}\n`;
         }
         else {
             console.error(`${this.id} does not have a title`);
         }
+        // This is the known 'default' description - on previous version this content was repeated on descriptions processed by "descs"
         if (this.desc) {
-            result += `  desc "${(0, global_1.escapeDoubleQuotes)((0, global_1.removeNewlinePlaceholders)(this.desc))}"\n`;
+            result += `  desc ${(0, global_1.escapeQuotes)(this.desc)}\n`;
         }
         else {
             console.error(`${this.id} does not have a desc`);
         }
         if (this.descs) {
-            Object.entries(this.descs).forEach(([key, desc]) => {
-                if (desc) {
-                    result += `  desc "${key}", "${(0, global_1.escapeDoubleQuotes)((0, global_1.removeNewlinePlaceholders)(desc))}"\n`;
+            Object.entries(this.descs).forEach(([key, subDesc]) => {
+                if (subDesc) {
+                    if (key.match('default') && this.desc) {
+                        if (subDesc != this.desc) {
+                            // The "default" keyword may have the same content as the desc content for backward compatibility with different historical InSpec versions.
+                            // In that case, we can ignore writing the "default" subdescription field.
+                            // If they are different, however, someone may be trying to use the keyword "default" for a unique subdescription, which should not be done.
+                            console.error(`${this.id} has a subdescription called "default" with contents that do not match the main description. "Default" should not be used as a keyword for unique sub-descriptions.`);
+                        }
+                    }
+                    else {
+                        result += `  desc '${key}', ${(0, global_1.escapeQuotes)(subDesc)}\n`;
+                    }
                 }
                 else {
                     console.error(`${this.id} does not have a desc for the value ${key}`);
@@ -69,34 +80,39 @@ class Control {
         }
         if (this.refs) {
             this.refs.forEach((ref) => {
+                var _a;
                 if (typeof ref === 'string') {
-                    result += `  ref '${(0, global_1.escapeQuotes)((0, global_1.removeNewlinePlaceholders)(ref))}'\n`;
+                    result += `  ref ${(0, global_1.escapeQuotes)(ref)}\n`;
                 }
                 else {
-                    result += `  ref '${(0, global_1.escapeQuotes)((0, global_1.removeNewlinePlaceholders)(ref.ref || ''))}', url: '${(0, global_1.escapeQuotes)((0, global_1.removeNewlinePlaceholders)(ref.url || ''))}'`;
+                    result += `  ref ${(0, global_1.escapeQuotes)(((_a = ref.ref) === null || _a === void 0 ? void 0 : _a.toString()) || '')}, url: ${(0, global_1.escapeQuotes)(ref.url || '')}`;
                 }
             });
         }
         Object.entries(this.tags).forEach(([tag, value]) => {
             if (value) {
-                if (typeof value === "object") {
-                    if (Array.isArray(value) && typeof value[0] === "string") {
-                        result += `  tag ${tag}: ${JSON.stringify(value).split('","').join('", "')}\n`;
+                if (typeof value === 'object') {
+                    if (Array.isArray(value) && typeof value[0] === 'string') {
+                        // The goal is to keep the style similar to cookstyle formatting
+                        result += `  tag ${tag}: ${JSON.stringify(value)
+                            .replace(/"/g, "'") // replace the double quotes with single quotes, ex: ["V-72029","SV-86653"] -> ['V-72029','SV-86653']
+                            .split("','") // split the items in the string
+                            .join("', '")}\n`; // join them together using single quote and a space, ex: ['V-72029','SV-86653'] -> ['V-72029', 'SV-86653']
                     }
                     else {
                         // Convert JSON Object to Ruby Hash
                         const stringifiedObject = JSON.stringify(value, null, 2)
-                            .replace(/\n/g, "\n  ")
-                            .replace(/\{\n {6}/g, "{")
-                            .replace(/\[\n {8}/g, "[")
-                            .replace(/\n {6}\]/g, "]")
-                            .replace(/\n {4}\}/g, "}")
+                            .replace(/\n/g, '\n  ')
+                            .replace(/\{\n {6}/g, '{')
+                            .replace(/\[\n {8}/g, '[')
+                            .replace(/\n {6}\]/g, ']')
+                            .replace(/\n {4}\}/g, '}')
                             .replace(/": \[/g, '" => [');
                         result += `  tag ${tag}: ${stringifiedObject}\n`;
                     }
                 }
-                else if (typeof value === "string") {
-                    result += `  tag ${tag}: "${(0, global_1.escapeDoubleQuotes)((0, global_1.removeNewlinePlaceholders)(value))}"\n`;
+                else if (typeof value === 'string') {
+                    result += `  tag ${tag}: ${(0, global_1.escapeQuotes)(value)}\n`;
                 }
             }
         });
@@ -104,7 +120,10 @@ class Control {
             result += '\n';
             result += this.describe;
         }
-        result += "end";
+        if (!result.slice(-1).match('\n')) {
+            result += '\n';
+        }
+        result += 'end\n';
         return result;
     }
 }

package/lib/objects/profile.d.ts

@@ -1,4 +1,4 @@
-import Control from "./control";
+import Control from './control';
 export default class Profile {
     name?: string | null;
     title?: string | null;
@@ -11,10 +11,10 @@ export default class Profile {
     version?: string | null;
     inspec_version?: string | null;
     supports: {
-        "platform-family"?: string;
-        "platform-name"?: string;
-        "os-name"?: string;
-        "os-family"?: string;
+        'platform-family'?: string;
+        'platform-name'?: string;
+        'os-name'?: string;
+        'os-family'?: string;
         release?: string;
         platform?: string;
     }[];
@@ -44,7 +44,7 @@ export default class Profile {
     readme?: string | null;
     files: string[];
     controls: Control[];
-    constructor(data?: Omit<Partial<Profile>, "controls">);
+    constructor(data?: Omit<Partial<Profile>, 'controls'>);
     createInspecYaml(): string;
     toUnformattedObject(): Profile;
 }

package/lib/objects/profile.js

@@ -37,7 +37,7 @@ class Profile {
     toUnformattedObject() {
         const unformattedProfile = new Profile(this);
         Object.entries(this).forEach(([key, value]) => {
-            if (typeof value === "string") {
+            if (typeof value === 'string') {
                 lodash_1.default.set(unformattedProfile, key, (0, global_1.unformatText)(value));
             }
         });

package/lib/parsers/json.d.ts

@@ -1,6 +1,6 @@
-import { ContextualizedEvaluation, ContextualizedProfile, ExecJSON } from "inspecjs";
-import Profile from "../objects/profile";
+import { ContextualizedEvaluation, ContextualizedProfile, ExecJSON } from 'inspecjs';
+import Profile from '../objects/profile';
 export declare function processEvaluation(evaluationInput: ContextualizedEvaluation): Profile;
 export declare function processProfileJSON(profileInput: ContextualizedProfile): Profile;
 export declare function processExecJSON(execJSON: ExecJSON.Execution): Profile;
-export declare function processJSON(json: string): Profile;
+export declare function processInSpecProfile(json: string): Profile;

package/lib/parsers/json.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processJSON = exports.processExecJSON = exports.processProfileJSON = exports.processEvaluation = void 0;
+exports.processInSpecProfile = exports.processExecJSON = exports.processProfileJSON = exports.processEvaluation = void 0;
 const tslib_1 = require("tslib");
 const inspecjs_1 = require("inspecjs");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const control_1 = tslib_1.__importStar(require("../objects/control"));
 const profile_1 = tslib_1.__importDefault(require("../objects/profile"));
+const update_1 = require("../utilities/update");
 function processEvaluation(evaluationInput) {
     const topLevelProfile = evaluationInput.contains[0];
     const profile = new profile_1.default({
@@ -14,9 +15,9 @@ function processEvaluation(evaluationInput) {
         maintainer: topLevelProfile.data.maintainer,
         copyright: topLevelProfile.data.copyright,
         copyright_email: topLevelProfile.data.copyright_email,
-        license: lodash_1.default.get(topLevelProfile.data, "license"),
-        summary: lodash_1.default.get(topLevelProfile.data, "summary"),
-        description: lodash_1.default.get(topLevelProfile.data, "description"),
+        license: lodash_1.default.get(topLevelProfile.data, 'license'),
+        summary: lodash_1.default.get(topLevelProfile.data, 'summary'),
+        description: lodash_1.default.get(topLevelProfile.data, 'description'),
         version: topLevelProfile.data.version,
     });
     topLevelProfile.contains.forEach((control) => {
@@ -39,9 +40,9 @@ function processProfileJSON(profileInput) {
         maintainer: profileInput.data.maintainer,
         copyright: profileInput.data.copyright,
         copyright_email: profileInput.data.copyright_email,
-        license: lodash_1.default.get(profileInput.data, "license"),
-        summary: lodash_1.default.get(profileInput.data, "summary"),
-        description: lodash_1.default.get(profileInput.data, "description"),
+        license: lodash_1.default.get(profileInput.data, 'license'),
+        summary: lodash_1.default.get(profileInput.data, 'summary'),
+        description: lodash_1.default.get(profileInput.data, 'description'),
         version: profileInput.data.version,
     });
     profileInput.data.controls.forEach((control) => {
@@ -54,12 +55,15 @@ function processProfileJSON(profileInput) {
             tags: control.tags,
             descs: (0, control_1.objectifyDescriptions)(control.descriptions),
         });
+        newControl.describe = (0, update_1.getExistingDescribeFromControl)(newControl);
         // Migrate check and fix text from tags to descriptions
         if (newControl.tags.check && !newControl.descs.check) {
+            // eslint-disable-next-line  @typescript-eslint/no-non-null-assertion
             lodash_1.default.set(newControl.descs, 'check', control.tags.check);
             lodash_1.default.set(newControl.tags, 'check', undefined);
         }
         if (newControl.tags.fix && !newControl.descs.fix) {
+            // eslint-disable-next-line  @typescript-eslint/no-non-null-assertion
             lodash_1.default.set(newControl.descs, 'fix', control.tags.fix);
             lodash_1.default.set(newControl.tags, 'fix', undefined);
         }
@@ -72,19 +76,19 @@ function processExecJSON(execJSON) {
     return processEvaluation((0, inspecjs_1.contextualizeEvaluation)(execJSON));
 }
 exports.processExecJSON = processExecJSON;
-function processJSON(json) {
+function processInSpecProfile(json) {
     const convertedFile = (0, inspecjs_1.convertFile)(json, true);
     let profile = new profile_1.default();
-    if (convertedFile["1_0_ExecJson"]) {
-        profile = processEvaluation((0, inspecjs_1.contextualizeEvaluation)(convertedFile["1_0_ExecJson"])).toUnformattedObject();
+    if (convertedFile['1_0_ExecJson']) {
+        profile = processEvaluation((0, inspecjs_1.contextualizeEvaluation)(convertedFile['1_0_ExecJson'])).toUnformattedObject();
     }
-    else if (convertedFile["1_0_ProfileJson"]) {
+    else if (convertedFile['1_0_ProfileJson']) {
         profile = processProfileJSON((0, inspecjs_1.contextualizeProfile)(JSON.parse(json))).toUnformattedObject();
     }
     else {
-        throw new Error("Unknown file type passed");
+        throw new Error('Unknown file type passed');
     }
-    profile.controls = lodash_1.default.sortBy(profile.controls, "id");
+    profile.controls = lodash_1.default.sortBy(profile.controls, 'id');
     return profile;
 }
-exports.processJSON = processJSON;
+exports.processInSpecProfile = processInSpecProfile;

package/lib/parsers/oval.js

@@ -4,10 +4,10 @@ exports.processOVAL = exports.extractAllCriteriaRefs = void 0;
 const xccdf_1 = require("../utilities/xccdf");
 // https://stackoverflow.com/questions/9133500/how-to-find-a-node-in-a-tree-with-javascript
 function searchTree(aTree, fCompair, bGreedy) {
-    var aInnerTree = []; // will contain the inner children
-    var oNode; // always the current node
-    var aReturnNodes = []; // the nodes array which will returned
-    // 1. loop through all root nodes so we don't touch the tree structure
+    let oNode; // always the current node  
+    const aInnerTree = []; // will contain the inner children
+    const aReturnNodes = []; // the nodes array which will returned
+    // 1. loop through all root nodes, store tree content locally so we don't touch the tree structure
     for (const keysTree in aTree) {
         aInnerTree.push(aTree[keysTree]);
     }
@@ -26,7 +26,7 @@ function searchTree(aTree, fCompair, bGreedy) {
                 // true if the property is an array
                 if (oNode[keysNode] instanceof Array) {
                     // 2. push all array object to aInnerTree to search in those later
-                    for (var i = 0; i < oNode[keysNode].length; i++) {
+                    for (let i = 0; i < oNode[keysNode].length; i++) {
                         aInnerTree.push(oNode[keysNode][i]);
                     }
                 }
@@ -40,8 +40,8 @@ function extractAllCriteriaRefs(initialCriteria) {
     initialCriteria.forEach(criteria => {
         var _a;
         (_a = criteria.criterion) === null || _a === void 0 ? void 0 : _a.forEach((criterion) => {
-            if (criterion["@_test_ref"]) {
-                criteriaRefs.push(criterion["@_test_ref"]);
+            if (criterion['@_test_ref']) {
+                criteriaRefs.push(criterion['@_test_ref']);
             }
         });
         if (criteria.criteria) {
@@ -61,22 +61,23 @@ function processOVAL(oval) {
     for (const ovalDefinitions of parsed.oval_definitions) {
         for (const definitionList of ovalDefinitions.definitions) {
             for (const definition of definitionList.definition) {
-                extractedDefinitions[definition["@_id"]] = definition;
-                extractedDefinitions[definition["@_id"]].criteriaRefs = extractAllCriteriaRefs(definition.criteria);
-                extractedDefinitions[definition["@_id"]].resolvedValues = (_a = extractedDefinitions[definition["@_id"]].criteriaRefs) === null || _a === void 0 ? void 0 : _a.map((criteriaRef) => {
+                extractedDefinitions[definition['@_id']] = definition;
+                extractedDefinitions[definition['@_id']].criteriaRefs = extractAllCriteriaRefs(definition.criteria);
+                extractedDefinitions[definition['@_id']].resolvedValues = (_a = extractedDefinitions[definition['@_id']].criteriaRefs) === null || _a === void 0 ? void 0 : _a.map((criteriaRef) => {
                     // Extract the original criteria from the oval file
-                    const foundCriteriaRefererence = searchTree(parsed.oval_definitions[0].tests, (oNode) => oNode["@_id"] === criteriaRef, false)[0];
-                    let foundObjects = [];
-                    let foundStates = [];
+                    const foundCriteriaRefererence = searchTree(parsed.oval_definitions[0].tests, (oNode) => oNode['@_id'] === criteriaRef, false)[0];
+                    // eslint-disable-next-line @typescript-eslint/ban-types
+                    const foundObjects = [];
+                    const foundStates = [];
                     if (foundCriteriaRefererence) {
                         if (foundCriteriaRefererence.object) {
                             foundCriteriaRefererence.object.forEach((object) => {
-                                if (!object["@_object_ref"]) {
+                                if (!object['@_object_ref']) {
                                     console.warn(`Found object without object_ref in test ${criteriaRef}`);
                                 }
                                 else {
-                                    const objectRef = object["@_object_ref"];
-                                    const foundObjectReference = searchTree(parsed.oval_definitions[0].objects, (oNode) => oNode["@_id"] === objectRef, false)[0];
+                                    const objectRef = object['@_object_ref'];
+                                    const foundObjectReference = searchTree(parsed.oval_definitions[0].objects, (oNode) => oNode['@_id'] === objectRef, false)[0];
                                     if (foundObjectReference) {
                                         foundObjects.push(foundObjectReference);
                                     }
@@ -88,12 +89,12 @@ function processOVAL(oval) {
                         }
                         if (foundCriteriaRefererence.state) {
                             foundCriteriaRefererence.state.forEach((state) => {
-                                if (!state["@_state_ref"]) {
+                                if (!state['@_state_ref']) {
                                     console.warn(`Found state without state_ref in test ${criteriaRef}`);
                                 }
                                 else {
-                                    const stateRef = state["@_state_ref"];
-                                    const foundStateReference = searchTree(parsed.oval_definitions[0].states, (oNode) => oNode["@_id"] === stateRef, false)[0];
+                                    const stateRef = state['@_state_ref'];
+                                    const foundStateReference = searchTree(parsed.oval_definitions[0].states, (oNode) => oNode['@_id'] === stateRef, false)[0];
                                     if (foundStateReference) {
                                         foundStates.push(foundStateReference);
                                     }

package/lib/parsers/xccdf.d.ts

@@ -6,7 +6,7 @@ export declare type GroupContextualizedRule = BenchmarkRule & {
 };
 export declare function extractAllRules(groups: BenchmarkGroup[]): GroupContextualizedRule[];
 export declare function extractAllComplexChecks(complexCheck: RuleComplexCheck): Omit<RuleComplexCheck, 'complex-check'>[];
-export declare function processXCCDF(xml: string, removeNewlines: boolean | undefined, useRuleId: 'group' | 'rule' | 'version' | 'cis', ovalDefinitions?: Record<string, OvalDefinitionValue & {
+export declare function processXCCDF(xml: string, removeNewlines: false, useRuleId: 'group' | 'rule' | 'version' | 'cis', ovalDefinitions?: Record<string, OvalDefinitionValue & {
     criteriaRefs?: string[];
     resolvedValues?: any;
 }>): Profile;