@mitre/hdf-schema 3.6.0-rc.5 → 3.7.0-rc.1

package/dist/ts/hdf.d.ts

@@ -48,6 +48,18 @@ export interface HDFResults {
      * results. May be a relative path, absolute URI, or fragment identifier.
      */
     planRef?: string;
+    /**
+     * Hash of this results document as it stood immediately before the most recent amendment
+     * application. Written by `hdf amend apply` when it applies at least one override; an apply
+     * that matches nothing leaves the document untouched. The hash covers the results file's
+     * RAW BYTES as read, not a canonical form, so reproducing it requires the byte-identical
+     * original — reformatting or re-serializing the source changes the value. Only the most
+     * recent pre-application state is recorded: applying amendments to an already-amended
+     * document REPLACES this value, so it is a single link back one step, not a growing chain.
+     * Distinct from the `previousChecksum` inside an override, which chains amendments to each
+     * other and is computed over a canonical JSON form.
+     */
+    preAmendmentChecksum?: Checksum;
     /**
      * Optional reference to automated remediation resources (Ansible playbooks, Terraform
      * scripts, etc.) for fixing failing requirements found in this assessment.
@@ -1004,7 +1016,9 @@ export interface Evidence {
     capturedBy?: Identity;
     /**
      * The evidence content. For screenshots/files: base64-encoded data or URL. For code/logs:
-     * the raw text. For URLs: the URL string.
+     * the raw text. For URLs: the URL string. Must not be empty. When encoding is 'base64',
+     * data must be bare base64 matching ^[0-9A-Za-z+/]+={0,2}$ (OSCAL's Base64Datatype): no
+     * data: URI prefix, URL, or line breaks.
      */
     data: string;
     /**
@@ -1012,7 +1026,8 @@ export interface Evidence {
      */
     description?: string;
     /**
-     * Encoding used for the data. Example: 'base64', 'utf-8'.
+     * Encoding used for the data. Example: 'base64', 'utf-8'. The value 'base64' (exactly,
+     * lowercase) requires data to be bare base64.
      */
     encoding?: string;
     /**
@@ -1147,6 +1162,13 @@ export interface Milestone {
      * Current status of this milestone.
      */
     status: MilestoneStatus;
+    /**
+     * Short single-line label for this milestone, suitable where a consumer needs a title (for
+     * example an OSCAL POA&M remediation or task). No line breaks, and no leading or trailing
+     * whitespace. The description remains the full text of the milestone; the title does not
+     * replace it.
+     */
+    title?: string;
     [property: string]: any;
 }
 /**

package/dist/ts/hdf.ts

@@ -46,6 +46,18 @@ export interface HDFResults {
      * results. May be a relative path, absolute URI, or fragment identifier.
      */
     planRef?: string;
+    /**
+     * Hash of this results document as it stood immediately before the most recent amendment
+     * application. Written by `hdf amend apply` when it applies at least one override; an apply
+     * that matches nothing leaves the document untouched. The hash covers the results file's
+     * RAW BYTES as read, not a canonical form, so reproducing it requires the byte-identical
+     * original — reformatting or re-serializing the source changes the value. Only the most
+     * recent pre-application state is recorded: applying amendments to an already-amended
+     * document REPLACES this value, so it is a single link back one step, not a growing chain.
+     * Distinct from the `previousChecksum` inside an override, which chains amendments to each
+     * other and is computed over a canonical JSON form.
+     */
+    preAmendmentChecksum?: Checksum;
     /**
      * Optional reference to automated remediation resources (Ansible playbooks, Terraform
      * scripts, etc.) for fixing failing requirements found in this assessment.
@@ -1020,7 +1032,9 @@ export interface Evidence {
     capturedBy?: Identity;
     /**
      * The evidence content. For screenshots/files: base64-encoded data or URL. For code/logs:
-     * the raw text. For URLs: the URL string.
+     * the raw text. For URLs: the URL string. Must not be empty. When encoding is 'base64',
+     * data must be bare base64 matching ^[0-9A-Za-z+/]+={0,2}$ (OSCAL's Base64Datatype): no
+     * data: URI prefix, URL, or line breaks.
      */
     data: string;
     /**
@@ -1028,7 +1042,8 @@ export interface Evidence {
      */
     description?: string;
     /**
-     * Encoding used for the data. Example: 'base64', 'utf-8'.
+     * Encoding used for the data. Example: 'base64', 'utf-8'. The value 'base64' (exactly,
+     * lowercase) requires data to be bare base64.
      */
     encoding?: string;
     /**
@@ -1167,6 +1182,13 @@ export interface Milestone {
      * Current status of this milestone.
      */
     status: MilestoneStatus;
+    /**
+     * Short single-line label for this milestone, suitable where a consumer needs a title (for
+     * example an OSCAL POA&M remediation or task). No line breaks, and no leading or trailing
+     * whitespace. The description remains the full text of the milestone; the title does not
+     * replace it.
+     */
+    title?: string;
     [property: string]: any;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitre/hdf-schema",
-  "version": "3.6.0-rc.5",
+  "version": "3.7.0-rc.1",
   "description": "JSON schemas and multi-language type definitions for Heimdall Data Format (HDF)",
   "publishConfig": {
     "access": "public"
@@ -65,7 +65,7 @@
   "dependencies": {
     "ajv": "^8.17.0",
     "ajv-formats": "^3.0.0",
-    "@mitre/hdf-utilities": "^3.6.0-rc.5"
+    "@mitre/hdf-utilities": "^3.7.0-rc.1"
   },
   "devDependencies": {
     "@hyperjump/json-schema": "^1.17.2",