@mitre/hdf-extension-graph 3.6.0-rc.3 → 3.6.0-rc.5

package/README.md

@@ -24,6 +24,10 @@ pnpm add @mitre/hdf-extension-graph
 
 Requires `@mitre/hdf-schema` as a peer dependency.
 
+```bash
+go get github.com/mitre/hdf-libs/hdf-extension-graph/go/v3
+```
+
 ## Usage
 
 ### Build the graph
@@ -144,16 +148,56 @@ Builds a bidirectional extension graph from an HDF Results file. Links baselines
 
 ```typescript
 interface Modification {
-  field: string;        // 'impact', 'title', or 'severity'
+  field: string;        // 'impact', 'title', 'severity', 'effectiveImpact', or 'disposition'
   originalValue: unknown;
   newValue: unknown;
   inBaseline: string;   // Name of the baseline making the change
 }
 ```
 
+## Go
+
+The Go module (package `hdfextension`) mirrors the TypeScript package: the same graph, the same derived properties, and `Modification` output that serializes identically. The `test/cross-language-equivalence.test.ts` suite builds the `go/cmd/equivalence-dump` command and compares its canonical graph dump with the TypeScript dumper's (`test/equivalence-dump.ts`) on the same fixtures, so the two implementations cannot drift.
+
+```go
+import hdfextension "github.com/mitre/hdf-libs/hdf-extension-graph/go/v3"
+
+graph := hdfextension.BuildExtensionGraph(results) // results is a *hdf.HDFResults
+
+stig := graph.FindBaseline("rhel9-stig-baseline")
+for _, overlay := range stig.ExtendedBy {
+    fmt.Printf("%s extends %s\n", overlay.Data.Name, stig.Data.Name)
+}
+
+for _, req := range graph.FindRequirements("SV-238196") {
+    if !req.IsRedundant() {
+        for _, mod := range req.Modifications() {
+            fmt.Printf("%s: %v → %v\n", mod.Field, mod.OriginalValue, mod.NewValue)
+        }
+    }
+}
+```
+
+### `BuildExtensionGraph(results *hdf.HDFResults) *ExtensionGraph`
+
+Builds the bidirectional graph from an HDF Results document, linking baselines via `parentBaseline` and requirements by matching `id` across linked baselines.
+
+| TypeScript | Go |
+|---|---|
+| `graph.baselines` | `graph.Baselines` (`[]*ContextualizedBaseline`) |
+| `graph.requirements` | `graph.Requirements` (`[]*ContextualizedRequirement`) |
+| `graph.rootBaselines` | `graph.RootBaselines()` |
+| `graph.findBaseline(name)` | `graph.FindBaseline(name)` (nil when absent) |
+| `graph.findRequirements(id)` | `graph.FindRequirements(id)` |
+| `baseline.data` / `sourcedFrom` / `extendsFrom` / `extendedBy` / `requirements` | `Data` / `SourcedFrom` / `ExtendsFrom` / `ExtendedBy` / `Requirements` fields on `ContextualizedBaseline` |
+| `req.data` / `sourcedFrom` / `extendsFrom` / `extendedBy` | `Data` / `SourcedFrom` / `ExtendsFrom` / `ExtendedBy` fields on `ContextualizedRequirement` |
+| `req.root` / `isRedundant` / `fullCode` / `extensionChain` / `modifications` | `Root()` / `IsRedundant()` / `FullCode()` / `ExtensionChain()` / `Modifications()` methods |
+| `Modification` | `Modification{Field, OriginalValue, NewValue, InBaseline}` |
+
+`hdfextension.TrackedFields` lists the requirement fields `Modifications()` compares, in emission order.
+
 ## Notes
 
-- **TypeScript only** — there is no Go implementation of hdf-extension-graph.
 - The HDF schemas consumed by this package are documented at <https://mitre.github.io/hdf-libs/schemas/>.
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitre/hdf-extension-graph",
-  "version": "3.6.0-rc.3",
+  "version": "3.6.0-rc.5",
   "description": "Bidirectional extension graph processing for HDF profile/baseline hierarchies",
   "publishConfig": {
     "access": "public"
@@ -25,11 +25,11 @@
   "author": "MITRE Corporation",
   "license": "Apache-2.0",
   "dependencies": {
-    "@mitre/hdf-schema": "^3.6.0-rc.3"
+    "@mitre/hdf-schema": "^3.6.0-rc.5"
   },
   "devDependencies": {
-    "@mitre/hdf-parsers": "^3.6.0-rc.3",
-    "@mitre/hdf-fixtures": "^3.6.0-rc.3"
+    "@mitre/hdf-fixtures": "^3.6.0-rc.5",
+    "@mitre/hdf-parsers": "^3.6.0-rc.5"
   },
   "engines": {
     "node": ">=22.0.0"