@mitre/inspec-objects 0.0.7 → 0.0.10

package/lib/objects/control.d.ts

@@ -21,14 +21,15 @@ export default class Control {
     })[];
     tags: {
         check?: string;
+        check_id?: string;
         fix?: string;
+        fix_id?: string | null;
         severity?: string;
         gtitle?: string;
         gid?: string;
         satisfies?: string[];
         rid?: string;
         stig_id?: string;
-        fix_id?: string | null;
         cci?: string[];
         cis_controls?: Record<string, string[]>[];
         nist?: string[];

package/lib/parsers/xccdf.js

@@ -60,7 +60,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
             const title = (0, xccdf_1.removeXMLSpecialCharacters)(rule['@_severity'] ? rule.title : `[[[MISSING SEVERITY FROM STIG]]] ${rule.title}`);
             control.title = title.replace(/\n/g, '{{{{newlineHERE}}}}');
             const desc = (0, xccdf_1.removeXMLSpecialCharacters)(typeof extractedDescription === 'string' ? extractedDescription : ((_a = extractedDescription.VulnDiscussion) === null || _a === void 0 ? void 0 : _a.split('Satisfies: ')[0]) || 'Missing Description');
-            control.desc = desc === null || desc === void 0 ? void 0 : desc.replace(/\n/g, '{{{{newlineHERE}}}}');
+            control.desc = desc === null || desc === void 0 ? void 0 : desc.trim().replace(/\n/g, '{{{{newlineHERE}}}}');
         }
         else {
             control.title = (0, xccdf_1.removeXMLSpecialCharacters)(rule['@_severity'] ? rule.title : `[[[MISSING SEVERITY FROM STIG]]] ${rule.title}`);
@@ -125,15 +125,9 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
         if (rule['fix'] && rule['fix'].length > 0) {
             control.tags.fix_id = rule['fix'][0]['@_id'];
         }
-        else {
-            control.tags.fix_id = null;
-        }
         if (rule['rationale']) {
             control.tags.rationale = rule['rationale'][0]['#text'];
         }
-        else {
-            control.tags.rationale = null;
-        }
         if (typeof extractedDescription === 'object') {
             control.tags.satisfies = ((_c = extractedDescription.VulnDiscussion) === null || _c === void 0 ? void 0 : _c.includes('Satisfies: ')) && extractedDescription.VulnDiscussion.split('Satisfies: ').length >= 1 ? extractedDescription.VulnDiscussion.split('Satisfies: ')[1].split(',').map(satisfaction => satisfaction.trim()) : undefined;
             control.tags.false_negatives = extractedDescription.FalseNegatives || undefined;

package/lib/utilities/diff.d.ts

@@ -1,4 +1,8 @@
 import Profile from '../objects/profile';
 import { ProfileDiff } from '../types/diff';
 export declare function removeNewlines(control?: Record<string, unknown>): Record<string, unknown>;
-export declare function diffProfile(fromProfile: Profile, toProfile: Profile): ProfileDiff;
+export declare function simplifyDiff(diffData: Record<string, unknown>): Record<string, unknown>;
+export declare function diffProfile(fromProfile: Profile, toProfile: Profile): {
+    simplified: ProfileDiff;
+    originalDiff: Record<string, unknown>;
+};

package/lib/utilities/diff.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.diffProfile = exports.removeNewlines = void 0;
+exports.diffProfile = exports.simplifyDiff = exports.removeNewlines = void 0;
 const tslib_1 = require("tslib");
 const json_diff_1 = require("json-diff");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
@@ -19,12 +19,37 @@ function removeNewlines(control) {
     });
 }
 exports.removeNewlines = removeNewlines;
+function simplifyDiff(diffData) {
+    return lodash_1.default.transform(diffData, (result, diffValue, key) => {
+        if (lodash_1.default.has(diffValue, '__new')) {
+            result[key] = lodash_1.default.get(diffValue, '__new');
+        }
+        else if (Array.isArray(diffValue)) {
+            result[key] = diffValue.map((value) => value[0] === '+' && value[1]).filter(value => value);
+        }
+        else if (typeof diffValue === 'object') {
+            result[key] = simplifyDiff(diffValue);
+        }
+        else if (key.endsWith('__deleted')) {
+            return undefined;
+        }
+        else {
+            result[key] = diffValue;
+        }
+    });
+}
+exports.simplifyDiff = simplifyDiff;
 function diffProfile(fromProfile, toProfile) {
     const profileDiff = {
         addedControlIDs: [],
         removedControlIDs: [],
         changedControls: {}
     };
+    const originalDiff = {
+        addedControlIDs: [],
+        removedControlIDs: [],
+        changedControls: {}
+    };
     const fromControlIDs = fromProfile.controls.map((control) => control.id).sort();
     const toControlIDs = toProfile.controls.map((control) => control.id).sort();
     // Find new controls
@@ -32,9 +57,11 @@ function diffProfile(fromProfile, toProfile) {
     controlIDDiff === null || controlIDDiff === void 0 ? void 0 : controlIDDiff.forEach((diffValue) => {
         if (diffValue[0] === '-') {
             profileDiff.removedControlIDs.push(diffValue[1]);
+            originalDiff.removedControlIDs.push(diffValue[1]);
         }
         else if (diffValue[0] === '+') {
             profileDiff.addedControlIDs.push(diffValue[1]);
+            originalDiff.addedControlIDs.push(diffValue[1]);
         }
     });
     // Add new controls to changedControls
@@ -42,27 +69,20 @@ function diffProfile(fromProfile, toProfile) {
         const newControl = toProfile.controls.find((control) => addedControl === control.id);
         if (newControl) {
             profileDiff.changedControls[addedControl] = newControl;
+            originalDiff.changedControls[addedControl] = newControl;
         }
     });
     // Find changed controls
     for (const fromControl of fromProfile.controls) {
         const toControl = toProfile.controls.find((control) => control.id === fromControl.id);
         if (toControl) {
-            const controlDiff = (0, json_diff_1.diff)(fromControl, toControl);
+            const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(fromControl, toControl), 'code__deleted');
             if (controlDiff) {
-                Object.entries(controlDiff).forEach(([key, value]) => {
-                    if (lodash_1.default.has(value, '__new')) {
-                        lodash_1.default.set(profileDiff, 'changedControls.' + fromControl.id + '.' + key.replace('.', '\\.'), lodash_1.default.get(controlDiff, key + '.__new'));
-                    }
-                    else if (typeof value === 'object') {
-                        Object.entries(value).forEach(([subKey]) => {
-                            lodash_1.default.set(profileDiff, 'changedControls.' + fromControl.id + '.' + key.replace('.', '\\.') + '.' + subKey.replace('.', '\\.'), lodash_1.default.get(controlDiff, key + '.' + subKey + '.__new'));
-                        });
-                    }
-                });
+                profileDiff.changedControls[toControl.id] = simplifyDiff(controlDiff);
+                originalDiff.changedControls[toControl.id] = controlDiff;
             }
         }
     }
-    return profileDiff;
+    return { simplified: profileDiff, originalDiff: originalDiff };
 }
 exports.diffProfile = diffProfile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitre/inspec-objects",
-  "version": "0.0.7",
+  "version": "0.0.10",
   "description": "Typescript objects for normalizing between InSpec profiles and XCCDF benchmarks",
   "main": "lib/index.js",
   "publishConfig": {