@speclynx/apidom-datamodel 2.2.3 → 2.4.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.4.0](https://github.com/speclynx/apidom/compare/v2.3.0...v2.4.0) (2026-01-29)
+
+**Note:** Version bump only for package @speclynx/apidom-datamodel
+
+# [2.3.0](https://github.com/speclynx/apidom/compare/v2.2.3...v2.3.0) (2026-01-27)
+
+**Note:** Version bump only for package @speclynx/apidom-datamodel
+
 ## [2.2.3](https://github.com/speclynx/apidom/compare/v2.2.2...v2.2.3) (2026-01-26)
 
 **Note:** Version bump only for package @speclynx/apidom-datamodel

package/README.md

@@ -180,6 +180,55 @@ link.relation = 'self';
 link.href = 'https://example.com';
 ```
 
+### ParseResultElement
+
+Represents the result of parsing a document. It contains the parsed API element and any annotations (errors, warnings) produced during parsing.
+
+```js
+import { ParseResultElement, ObjectElement, AnnotationElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+
+const parseResult = new ParseResultElement();
+
+// Add the parsed result
+const api = new ObjectElement({ openapi: '3.1.0' });
+api.classes.push('result');
+parseResult.push(api);
+
+// Add annotations
+const warning = new AnnotationElement('Deprecated feature used');
+warning.classes.push('warning');
+parseResult.push(warning);
+
+// Access the result
+parseResult.result; // => ObjectElement
+parseResult.isEmpty; // => false
+
+// Iterate over annotations
+for (const annotation of parseResult.annotations) {
+  console.log(toValue(annotation));
+}
+```
+
+### AnnotationElement
+
+Represents metadata about the parsing process, such as errors, warnings, or informational messages.
+
+```js
+import { AnnotationElement } from '@speclynx/apidom-datamodel';
+
+// Create a warning annotation
+const warning = new AnnotationElement('Multiple documents found, using first');
+warning.classes.push('warning');
+
+// Create an error annotation
+const error = new AnnotationElement('Invalid syntax at line 10');
+error.classes.push('error');
+
+// Annotations can have a code for programmatic identification
+error.code = 'INVALID_SYNTAX';
+```
+
 ---
 
 ## Source Maps

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-datamodel",
-  "version": "2.2.3",
+  "version": "2.4.0",
   "description": "Data model primitives for ApiDOM.",
   "publishConfig": {
     "access": "public",
@@ -39,7 +39,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-error": "^2.2.3",
+    "@speclynx/apidom-error": "^2.4.0",
     "ramda": "~0.32.0"
   },
   "files": [
@@ -52,5 +52,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "e08f97d01904015b1cf621e093145fe55de0d02d"
+  "gitHead": "f127ee0b98cc108b83a690bf317895e17a32b4d4"
 }