feat: add support for errors and missing literals

Refs #35

Author: char0n

apidom/packages/apidom-ast/src/ParseResult.ts

@@ -5,8 +5,6 @@ import Node from './Node';
 
 interface ParseResult extends Node {
   type: 'parseResult';
-  errors: unknown[];
-  annotations: unknown[];
   rootNode: unknown;
 }
 

apidom/packages/apidom-parser-adapter-openapi3-1/src/parser/index.ts

@@ -1,30 +1,17 @@
 import Parser from 'tree-sitter';
 // @ts-ignore
 import JSONLanguage from 'tree-sitter-json';
-import { JsonDocument, JsonObject, JsonProperty, JsonArray } from 'apidom-ast';
 import $RefParser from '@apidevtools/json-schema-ref-parser';
 import * as apiDOM from 'apidom';
+import { Error, JsonArray, JsonDocument, JsonObject, JsonProperty } from 'apidom-ast';
 import openapi3_1 from 'apidom-ns-openapi3-1';
 import { transform } from './cst';
 import specification from './specification';
 import { visit } from './visitors';
 
 const parse = async (
   source: string,
-  {
-    sourceMap = false,
-    specObj = specification,
-    keyMap = {
-      // @ts-ignore
-      [JsonDocument.type]: ['child'],
-      // @ts-ignore
-      [JsonObject.type]: ['properties'],
-      // @ts-ignore
-      [JsonProperty.type]: ['key', 'value'],
-      // @ts-ignore
-      [JsonArray.type]: ['items'],
-    },
-  } = {},
+  { sourceMap = false, specObj = specification } = {},
 ): Promise<apiDOM.ParseResultElement> => {
   const resolvedSpecObj = await $RefParser.dereference(specObj);
   const namespace = apiDOM.createNamespace(openapi3_1);
@@ -39,6 +26,19 @@ const parse = async (
   const cst = parser.parse(source);
   const ast = transform(cst);
 
+  const keyMap = {
+    // @ts-ignore
+    [JsonDocument.type]: ['children'],
+    // @ts-ignore
+    [JsonObject.type]: ['children'],
+    // @ts-ignore
+    [JsonProperty.type]: ['children'],
+    // @ts-ignore
+    [JsonArray.type]: ['children'],
+    // @ts-ignore
+    [Error.type]: ['children'],
+  };
+
   visit(ast.rootNode, documentVisitor, {
     keyMap,
     // @ts-ignore

apidom/packages/apidom-parser-adapter-openapi3-1/src/parser/specification.ts

@@ -28,6 +28,7 @@ import ServerVariableDescriptionVisitor from './visitors/open-api-3-1/server-var
 import ComponentsVisitor from './visitors/open-api-3-1/components';
 import SchemasVisitor from './visitors/open-api-3-1/components/SchemasVisitor';
 import SchemaVisitor from './visitors/open-api-3-1/SchemaVisitor';
+import ErrorVisitor from './visitors/ErrorVisitor';
 import { ValueVisitor, ObjectVisitor, ArrayVisitor } from './visitors/generics';
 
 /**
@@ -43,6 +44,7 @@ const specification = {
     value: ValueVisitor,
     object: ObjectVisitor,
     array: ArrayVisitor,
+    error: ErrorVisitor,
     document: {
       $visitor: DocumentVisitor,
       objects: {

apidom/packages/apidom-parser-adapter-openapi3-1/src/parser/visitors/DocumentVisitor.ts

@@ -1,15 +1,27 @@
 import stampit from 'stampit';
-import { visit, BREAK } from '.';
+import { visit } from '.';
 import SpecificationVisitor from './SpecificationVisitor';
 
 const DocumentVisitor = stampit(SpecificationVisitor, {
   methods: {
+    literal(literalNode) {
+      if (literalNode.isMissing) {
+        const errorVisitor = this.retrieveVisitorInstance(['error']);
+        visit(literalNode, errorVisitor);
+        this.element.content.push(errorVisitor.element);
+      }
+    },
+
     document(documentNode) {
       const openApiVisitor = this.retrieveVisitorInstance(['document', 'objects', 'OpenApi']);
       visit(documentNode.child, openApiVisitor);
       this.element.content.push(openApiVisitor.element);
+    },
 
-      return BREAK;
+    error(errorNode) {
+      const errorVisitor = this.retrieveVisitorInstance(['error']);
+      visit(errorNode, errorVisitor);
+      this.element.content.push(errorVisitor.element);
     },
   },
 });

apidom/packages/apidom-parser-adapter-openapi3-1/src/parser/visitors/ErrorVisitor.ts

@@ -0,0 +1,35 @@
+import stampit from 'stampit';
+import { BREAK } from '.';
+import SpecificationVisitor from './SpecificationVisitor';
+
+const ErrorVisitor = stampit(SpecificationVisitor, {
+  methods: {
+    literal(literalNode) {
+      if (literalNode.isMissing) {
+        const message = `(Missing ${literalNode.value})`;
+        this.element = new this.namespace.elements.Annotation(message);
+
+        this.maybeAddSourceMap(literalNode, this.element);
+
+        return BREAK;
+      }
+
+      return undefined;
+    },
+
+    error(errorNode) {
+      const message = errorNode.isUnexpected
+        ? `(Unexpected ${errorNode.value})`
+        : `(Error ${errorNode.value})`;
+
+      this.element = new this.namespace.elements.Annotation(message);
+      this.element.classes.push('error');
+
+      this.maybeAddSourceMap(errorNode, this.element);
+
+      return BREAK;
+    },
+  },
+});
+
+export default ErrorVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1/src/parser/visitors/index.ts

@@ -1,4 +1,11 @@
-import { JsonArray, JsonDocument, JsonObject, JsonProperty, visit as astVisit } from 'apidom-ast';
+import {
+  JsonArray,
+  JsonDocument,
+  JsonObject,
+  JsonProperty,
+  Error,
+  visit as astVisit,
+} from 'apidom-ast';
 
 export { BREAK } from 'apidom-ast';
 
@@ -13,6 +20,8 @@ const keyMapDefault = {
   [JsonProperty.type]: ['key', 'value'],
   // @ts-ignore
   [JsonArray.type]: ['items'],
+  // @ts-ignore
+  [Error.type]: ['children'],
 };
 
 // @ts-ignore

apidom/packages/apidom-parser-adapter-openapi3-1/test/index.ts

@@ -7,7 +7,7 @@ import * as adapter from '../src/adapter';
 const spec = fs.readFileSync(path.join(__dirname, 'fixtures', 'sample-api.json')).toString();
 // const namespace = apiDOM.createNamespace(openapi3);
 
-describe('apidom-parser', function () {
+describe('apidom-parser-adapter-openapi3-1', function () {
   it('test', async function () {
     console.log(adapter.detect(spec));
     console.log(adapter.mediaTypes);