@mitre/hdf-generators 3.6.0 → 3.7.0

package/README.md

@@ -11,6 +11,12 @@ Takes an HDF Baseline JSON document (requirement definitions with metadata, desc
 
 This bridges from HDF's tool-agnostic baseline format to InSpec's executable compliance-as-code format.
 
+It also carries the **upgrade engine**: given a current baseline or InSpec profile and a newer
+upstream one, it matches requirements between them and smart-merges the fields, so local
+customizations survive a guidance version bump instead of being overwritten. Requirements the
+upstream adds arrive as new controls; the delta between the two is reportable. The CLI reaches
+it as `hdf generate upgrade <current> <upstream>`.
+
 ## Relationship to other packages
 
 | Package | Relationship |

package/dist/index.d.ts

@@ -46,7 +46,7 @@ type PreferSide = 'current' | 'upstream' | undefined;
  * prefer "current": scalars from current, current wins tag/desc conflicts
  * prefer "upstream": everything from upstream (full replacement)
  */
-declare function mergeRequirement(current: BaselineRequirement, upstream: BaselineRequirement, prefer?: PreferSide): BaselineRequirement;
+export declare function mergeRequirement(current: BaselineRequirement, upstream: BaselineRequirement, prefer?: PreferSide): BaselineRequirement;
 /**
  * Merge two tag maps.
  *
@@ -54,7 +54,7 @@ declare function mergeRequirement(current: BaselineRequirement, upstream: Baseli
  * prefer "current": union; current wins on key conflicts.
  * prefer "upstream": upstream replaces all.
  */
-declare function mergeTags(current: Record<string, any> // eslint-disable-line @typescript-eslint/no-explicit-any
+export declare function mergeTags(current: Record<string, any> // eslint-disable-line @typescript-eslint/no-explicit-any
 , upstream: Record<string, any> // eslint-disable-line @typescript-eslint/no-explicit-any
 , prefer?: PreferSide): Record<string, any>;
 /**
@@ -64,7 +64,7 @@ declare function mergeTags(current: Record<string, any> // eslint-disable-line @
  * prefer "current": union; current wins on label conflicts.
  * prefer "upstream": upstream replaces all.
  */
-declare function mergeDescriptions(current: Description[], upstream: Description[], prefer?: PreferSide): Description[];
+export declare function mergeDescriptions(current: Description[], upstream: Description[], prefer?: PreferSide): Description[];
 /**
  * Merge two reference arrays.
  *
@@ -72,7 +72,7 @@ declare function mergeDescriptions(current: Description[], upstream: Description
  * prefer "current": current only.
  * prefer "upstream": upstream only.
  */
-declare function mergeRefs(current?: Reference[], upstream?: Reference[], prefer?: PreferSide): Reference[] | undefined;
+export declare function mergeRefs(current?: Reference[], upstream?: Reference[], prefer?: PreferSide): Reference[] | undefined;
 //#endregion
 //#region src/delta-types.d.ts
 /**
@@ -160,7 +160,7 @@ type DeltaOptions = UpgradeOptions;
  * Ported from ts-inspec-objects escapeQuotes(), cross-referenced with
  * inspec-parser's RubyRebuilder.
  */
-declare function escapeQuotes(s: string): string;
+export declare function escapeQuotes(s: string): string;
 //#endregion
 //#region src/control-stub.d.ts
 /**
@@ -176,7 +176,7 @@ declare function escapeQuotes(s: string): string;
  *     <code or stub comment>
  *   end
  */
-declare function generateControlStub(req: BaselineRequirement): string;
+export declare function generateControlStub(req: BaselineRequirement): string;
 //#endregion
 //#region src/inspec-yml.d.ts
 /**
@@ -185,7 +185,7 @@ declare function generateControlStub(req: BaselineRequirement): string;
  * Uses string interpolation — no YAML library needed since the structure
  * is fixed and shallow.
  */
-declare function generateInSpecYml(baseline: HDFBaseline, options?: GeneratorOptions): string;
+export declare function generateInSpecYml(baseline: HDFBaseline, options?: GeneratorOptions): string;
 //#endregion
 //#region src/profile-generator.d.ts
 /**
@@ -195,7 +195,7 @@ declare function generateInSpecYml(baseline: HDFBaseline, options?: GeneratorOpt
  * control filenames to Ruby source code. No file I/O — the CLI
  * is responsible for writing files to disk.
  */
-declare function generateInSpecProfile(baseline: HDFBaseline, options?: GeneratorOptions): InSpecProfile;
+export declare function generateInSpecProfile(baseline: HDFBaseline, options?: GeneratorOptions): InSpecProfile;
 //#endregion
 //#region src/delta.d.ts
 /**
@@ -209,13 +209,13 @@ declare function generateInSpecProfile(baseline: HDFBaseline, options?: Generato
  * (a control removed from upstream should not survive the upgrade).
  * Set opts.keepUnmatched to retain them instead.
  */
-declare function generateUpgrade(currentBaseline: HDFBaseline, upstreamBaseline: HDFBaseline, linkRecords: LinkRecord[], opts?: UpgradeOptions): UpgradeResult;
+export declare function generateUpgrade(currentBaseline: HDFBaseline, upstreamBaseline: HDFBaseline, linkRecords: LinkRecord[], opts?: UpgradeOptions): UpgradeResult;
 /**
  * Legacy entry point. Wraps generateUpgrade for backward compatibility.
  *
  * @deprecated Use generateUpgrade instead.
  */
-declare function generateDelta(newBaseline: HDFBaseline, linkRecords: LinkRecord[], oldCodeMap: Map<string, string>, opts?: DeltaOptions, oldControlCount?: number): DeltaResult;
+export declare function generateDelta(newBaseline: HDFBaseline, linkRecords: LinkRecord[], oldCodeMap: Map<string, string>, opts?: DeltaOptions, oldControlCount?: number): DeltaResult;
 //#endregion
 //#region src/delta-report.d.ts
 /**
@@ -229,13 +229,13 @@ interface DeltaJsonReport {
  * Generate a structured JSON report from a delta result.
  * Matches SAF CLI's delta.json format: { ...diff, links }.
  */
-declare function generateDeltaJson(result: DeltaResult): DeltaJsonReport;
+export declare function generateDeltaJson(result: DeltaResult): DeltaJsonReport;
 /**
  * Generate a Markdown report from a delta result.
  * Matches SAF CLI's delta.md format: mapping table, control counts,
  * match statistics, and statistics validation.
  */
-declare function generateDeltaMarkdown(result: DeltaResult): string;
+export declare function generateDeltaMarkdown(result: DeltaResult): string;
 //#endregion
-export { type DeltaJsonReport, type DeltaOptions, type DeltaResult, type DeltaStatistics, type GeneratorOptions, type InSpecProfile, type LinkRecord, type PreferSide, type ProfileMetadata, type UpgradeOptions, type UpgradeResult, escapeQuotes, generateControlStub, generateDelta, generateDeltaJson, generateDeltaMarkdown, generateInSpecProfile, generateInSpecYml, generateUpgrade, mergeDescriptions, mergeRefs, mergeRequirement, mergeTags };
+export type { DeltaJsonReport, DeltaOptions, DeltaResult, DeltaStatistics, GeneratorOptions, InSpecProfile, LinkRecord, PreferSide, ProfileMetadata, UpgradeOptions, UpgradeResult };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/merge.ts","../src/delta-types.ts","../src/ruby-escape.ts","../src/control-stub.ts","../src/inspec-yml.ts","../src/profile-generator.ts","../src/delta.ts","../src/delta-report.ts"],"mappings":";;;;;UAGiB;;EAEf;;EAEA,WAAW;;EAEX;;;;;UAMe;EACf;EACA;EACA;EACA;;;;;UAMe;;EAEf;;EAEA,UAAU;;;;KC3BA;;;;;;;;;;;;;;;iBAgBI,iBACd,SAAS,qBACT,UAAU,qBACV,SAAS,aACR;;;;;;;;iBAwCa,UACd,SAAS;EACT,UAAU;EACV,SAAS,aACR;;;;;;;;iBA4Ba,kBACd,SAAS,eACT,UAAU,eACV,SAAS,aACR;;;;;;;;iBAqCa,UACd,UAAU,aACV,WAAW,aACX,SAAS,aACR;;;;;;UCpIc;EACf;EACA;EACA;EACA;EACA;EACA;EACA;;;;;;;;;;;;;;;UAgBe;EACf;EACA;EACA;EACA;EACA;EACA;EACA;;;;;UAMe;EACf,UAAU;EACV,UAAU;EACV,aAAa;EACb,YAAY;;;KAIF,cAAc;;;;UAKT;;EAEf,SAAS;;EAET;;EAEA;;EAEA;;EAEA,WAAW;;EAEX;;;;;;;;EAQA;;;KAIU,eAAe;;;;;;;;;;;;;;iBCrEX,aAAa;;;;;;;;;;;;;;;;iBCWb,oBAAoB,KAAK;;;;;;;;;iBCbzB,kBACd,UAAU,aACV,UAAU;;;;;;;;;;iBCCI,sBACd,UAAU,aACV,UAAU,mBACT;;;;;;;;;;;;;;iBCGa,gBACd,iBAAiB,aACjB,kBAAkB,aAClB,aAAa,cACb,OAAO,iBACN;;;;;;iBAmFa,cACd,aAAa,aACb,aAAa,cACb,YAAY,qBACZ,OAAO,cACP,2BACC;;;;;;;UC1Gc;EACf,OAAO;;;;;;iBAOO,kBAAkB,QAAQ,cAAc;;;;;;iBAoCxC,sBAAsB,QAAQ"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/merge.ts","../src/delta-types.ts","../src/ruby-escape.ts","../src/control-stub.ts","../src/inspec-yml.ts","../src/profile-generator.ts","../src/delta.ts","../src/delta-report.ts"],"mappings":";;;;;UAGiB;;EAEf;;EAEA,WAAW;;EAEX;;;;;UAMe;EACf;EACA;EACA;EACA;;;;;UAMe;;EAEf;;EAEA,UAAU;;;;KC3BA;;;;;;;;;;;;;;;wBAgBI,iBACd,SAAS,qBACT,UAAU,qBACV,SAAS,aACR;;;;;;;;wBAwCa,UACd,SAAS;EACT,UAAU;EACV,SAAS,aACR;;;;;;;;wBA4Ba,kBACd,SAAS,eACT,UAAU,eACV,SAAS,aACR;;;;;;;;wBAqCa,UACd,UAAU,aACV,WAAW,aACX,SAAS,aACR;;;;;;UCpIc;EACf;EACA;EACA;EACA;EACA;EACA;EACA;;;;;;;;;;;;;;;UAgBe;EACf;EACA;EACA;EACA;EACA;EACA;EACA;;;;;UAMe;EACf,UAAU;EACV,UAAU;EACV,aAAa;EACb,YAAY;;;KAIF,cAAc;;;;UAKT;;EAEf,SAAS;;EAET;;EAEA;;EAEA;;EAEA,WAAW;;EAEX;;;;;;;;EAQA;;;KAIU,eAAe;;;;;;;;;;;;;;wBCrEX,aAAa;;;;;;;;;;;;;;;;wBCWb,oBAAoB,KAAK;;;;;;;;;wBCbzB,kBACd,UAAU,aACV,UAAU;;;;;;;;;;wBCCI,sBACd,UAAU,aACV,UAAU,mBACT;;;;;;;;;;;;;;wBCGa,gBACd,iBAAiB,aACjB,kBAAkB,aAClB,aAAa,cACb,OAAO,iBACN;;;;;;wBAmFa,cACd,aAAa,aACb,aAAa,cACb,YAAY,qBACZ,OAAO,cACP,2BACC;;;;;;;UC1Gc;EACf,OAAO;;;;;;wBAOO,kBAAkB,QAAQ,cAAc;;;;;;wBAoCxC,sBAAsB,QAAQ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitre/hdf-generators",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Generate InSpec profile stubs from HDF Baseline definitions",
   "publishConfig": {
     "access": "public"
@@ -25,10 +25,10 @@
   "author": "MITRE Corporation",
   "license": "Apache-2.0",
   "dependencies": {
-    "@mitre/hdf-schema": "^3.6.0"
+    "@mitre/hdf-schema": "^3.7.0"
   },
   "devDependencies": {
-    "@mitre/hdf-fixtures": "^3.6.0"
+    "@mitre/hdf-fixtures": "^3.7.0"
   },
   "engines": {
     "node": ">=22.0.0"