feat(reference): add support for API Design Systems

packages/apidom-reference/README.md

@@ -71,7 +71,7 @@ so providing it is always a better option.
 
 ### Parser plugins
 
-Parse component comes with six (6) default parser plugins.
+Parse component comes with number of default parser plugins.
 
 #### [openapi-json-3-1](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/parse/parsers/apidom-reference-parser-openapi-json-3-1)
 
@@ -146,6 +146,35 @@ Supported media types are:
 ]
 ```
 
+#### [api-design-systems-json](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/parse/parsers/apidom-reference-parser-api-design-systems-json)
+
+Wraps [@swagger-api/apidom-parser-adapter-api-design-systsems-json](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser-adapter-api-design-systems-json) package
+and is uniquely identified by `api-design-systems-json` name.
+
+Supported media types are:
+
+```js
+[
+  'application/vnd.aai.apidesignsystems;version=2021-05-07',
+  'application/vnd.aai.apidesignsystems+json;version=2021-05-07'
+]
+```
+
+#### [api-design-systems-yaml](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/parse/parsers/apidom-reference-parser-api-design-systems-yaml)
+
+Wraps [@swagger-api/apidom-parser-adapter-api-design-systems-yaml](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser-adapter-api-design-systems-yaml) package
+and is uniquely  identified by `api-design-systems-yaml` name.
+
+
+Supported media types are:
+
+```js
+[
+  'application/vnd.aai.apidesignsystems;version=2021-05-07',
+  'application/vnd.aai.apidesignsystems+yaml;version=2021-05-07'
+]
+```
+
 #### [json](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/parse/parsers/apidom-reference-parser-json)
 
 Wraps [@swagger-api/apidom-parser-adapter-json](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser-adapter-json) package
@@ -194,6 +223,8 @@ returns `true` or until entire list of parser plugins is exhausted (throws error
   OpenApiYaml3_1Parser({ allowEmpty: true, sourceMap: false }),
   AsyncApiJson2Parser({ allowEmpty: true, sourceMap: false }),
   AsyncApiYaml2Parser({ allowEmpty: true, sourceMap: false }),
+  ApiDesignSystemsJsonParser({ allowEmpty: true, sourceMap: false }),
+  ApiDesignSystemsYamlParser({ allowEmpty: true, sourceMap: false }),
   JsonParser({ allowEmpty: true, sourceMap: false }),
   YamlParser({ allowEmpty: true, sourceMap: false }),
   BinaryParser({ allowEmpty: true }),
@@ -210,6 +241,8 @@ import {
   OpenApiYaml3_1Parser,
   AsyncApiJson2Parser,
   AsyncApiYaml2Parser,
+  ApiDesignSystemsJsonParser,
+  ApiDesignSystemsYamlParser,
   JsonParser,
   YamlParser,
   BinaryParser,
@@ -220,6 +253,8 @@ options.parse.parsers = [
   OpenApiYaml3_1Parser({ allowEmpty: true, sourceMap: false }),
   AsyncApiJson2Parser({ allowEmpty: true, sourceMap: false }),
   AsyncApiYaml2Parser({ allowEmpty: true, sourceMap: false }),
+  ApiDesignSystemsJsonParser({ allowEmpty: true, sourceMap: false }),
+  ApiDesignSystemsYamlParser({ allowEmpty: true, sourceMap: false }),
   YamlParser({ allowEmpty: true, sourceMap: false }),
   JsonParser({ allowEmpty: true, sourceMap: false }),
   BinaryParser({ allowEmpty: true }),
@@ -235,6 +270,8 @@ import {
   OpenApiYaml3_1Parser,
   AsyncApiJson2Parser,
   AsyncApiYaml2Parser,
+  ApiDesignSystemsJsonParser,
+  ApiDesignSystemsYamlParser,
   JsonParser,
   YamlParser,
   BinaryParser,
@@ -248,6 +285,8 @@ await parse('/home/user/oas.json', {
       OpenApiYaml3_1Parser({ allowEmpty: true, sourceMap: false }),
       AsyncApiJson2Parser({ allowEmpty: true, sourceMap: false }),
       AsyncApiYaml2Parser({ allowEmpty: true, sourceMap: false }),
+      ApiDesignSystemsJsonParser({ allowEmpty: true, sourceMap: false }),
+      ApiDesignSystemsYamlParser({ allowEmpty: true, sourceMap: false }),
       YamlParser({ allowEmpty: true, sourceMap: false }),
       JsonParser({ allowEmpty: true, sourceMap: false }),
       BinaryParser({ allowEmpty: true }),

packages/apidom-reference/package.json

@@ -40,6 +40,8 @@
     "@swagger-api/apidom-json-pointer": "^0.30.0",
     "@swagger-api/apidom-ns-asyncapi-2": "^0.30.0",
     "@swagger-api/apidom-ns-openapi-3-1": "^0.30.0",
+    "@swagger-api/apidom-parser-adapter-api-design-systems-json": "^0.30.1",
+    "@swagger-api/apidom-parser-adapter-api-design-systems-yaml": "^0.30.1",
     "@swagger-api/apidom-parser-adapter-asyncapi-json-2": "^0.30.1",
     "@swagger-api/apidom-parser-adapter-asyncapi-yaml-2": "^0.30.1",
     "@swagger-api/apidom-parser-adapter-json": "^0.30.1",

packages/apidom-reference/src/index.ts

@@ -11,6 +11,8 @@ import { readFile as readFileFn } from './resolve/util';
 import dereferenceFn, { dereferenceApiDOM as dereferenceApiDOMFn } from './dereference';
 
 export { default as Parser } from './parse/parsers/Parser';
+export { default as ApiDesignSystemsJsonParser } from './parse/parsers/apidom-reference-parser-api-design-systems-json';
+export { default as ApiDesignSystemsYamlParser } from './parse/parsers/apidom-reference-parser-api-design-systems-yaml';
 export { default as OpenApiJson3_1Parser } from './parse/parsers/apidom-reference-parser-openapi-json-3-1';
 export { default as OpenApiYaml3_1Parser } from './parse/parsers/apidom-reference-parser-openapi-yaml-3-1';
 export { default as AsyncApiJson2Parser } from './parse/parsers/apidom-reference-parser-asyncapi-json-2';

packages/apidom-reference/src/options/index.ts

@@ -2,6 +2,8 @@ import FileResolver from '../resolve/resolvers/FileResolver';
 import HttpResolverAxios from '../resolve/resolvers/HttpResolverAxios';
 import OpenApi3_1ResolveStrategy from '../resolve/strategies/openapi-3-1';
 import AsyncApi2ResolveStrategy from '../resolve/strategies/asyncapi-2';
+import ApiDesignSystemsJsonParser from '../parse/parsers/apidom-reference-parser-api-design-systems-json';
+import ApiDesignSystemsYamlParser from '../parse/parsers/apidom-reference-parser-api-design-systems-yaml';
 import OpenApiJson3_1Parser from '../parse/parsers/apidom-reference-parser-openapi-json-3-1';
 import OpenApiYaml3_1Parser from '../parse/parsers/apidom-reference-parser-openapi-yaml-3-1';
 import AsyncApiJson2Parser from '../parse/parsers/apidom-reference-parser-asyncapi-json-2';
@@ -21,7 +23,7 @@ const defaultOptions: IReferenceOptions = {
     mediaType: 'text/plain',
 
     /**
-     * Determines how how different types of files will be parsed.
+     * Determines how different types of files will be parsed.
      *
      * You can add additional parsers of your own, replace an existing one with
      * your own implementation, or remove any resolver by removing it from the list.
@@ -32,6 +34,8 @@ const defaultOptions: IReferenceOptions = {
       OpenApiYaml3_1Parser({ allowEmpty: true, sourceMap: false }),
       AsyncApiJson2Parser({ allowEmpty: true, sourceMap: false }),
       AsyncApiYaml2Parser({ allowEmpty: true, sourceMap: false }),
+      ApiDesignSystemsJsonParser({ allowEmpty: true, sourceMap: false }),
+      ApiDesignSystemsYamlParser({ allowEmpty: true, sourceMap: false }),
       JsonParser({ allowEmpty: true, sourceMap: false }),
       YamlParser({ allowEmpty: true, sourceMap: false }),
       BinaryParser({ allowEmpty: true }),

packages/apidom-reference/src/parse/parsers/apidom-reference-parser-api-design-systems-json/index.ts

@@ -0,0 +1,31 @@
+import stampit from 'stampit';
+import { pick } from 'ramda';
+import { ParseResultElement } from '@swagger-api/apidom-core';
+import { parse, mediaTypes } from '@swagger-api/apidom-parser-adapter-api-design-systems-json';
+
+import { ParserError } from '../../../util/errors';
+import { File as IFile, Parser as IParser } from '../../../types';
+import Parser from '../Parser';
+
+const ApiDesignSystemsJsonParser: stampit.Stamp<IParser> = stampit(Parser, {
+  props: {
+    name: 'api-design-systems-json',
+  },
+  methods: {
+    canParse(file: IFile): boolean {
+      return mediaTypes.includes(file.mediaType) && file.extension === '.json';
+    },
+    async parse(file: IFile): Promise<ParseResultElement> {
+      const source = Buffer.isBuffer(file.data) ? file.data.toString() : file.data;
+
+      try {
+        const parserOpts = pick(['sourceMap', 'syntacticAnalysis', 'refractorOpts'], this);
+        return await parse(source, parserOpts);
+      } catch (error: any) {
+        throw new ParserError(`Error parsing "${file.uri}"`, error);
+      }
+    },
+  },
+});
+
+export default ApiDesignSystemsJsonParser;

packages/apidom-reference/src/parse/parsers/apidom-reference-parser-api-design-systems-yaml/index.ts

@@ -0,0 +1,31 @@
+import stampit from 'stampit';
+import { pick } from 'ramda';
+import { ParseResultElement } from '@swagger-api/apidom-core';
+import { parse, mediaTypes } from '@swagger-api/apidom-parser-adapter-api-design-systems-yaml';
+
+import { ParserError } from '../../../util/errors';
+import { File as IFile, Parser as IParser } from '../../../types';
+import Parser from '../Parser';
+
+const ApiDesignSystemsYamlParser: stampit.Stamp<IParser> = stampit(Parser, {
+  props: {
+    name: 'api-design-systems-yaml',
+  },
+  methods: {
+    canParse(file: IFile): boolean {
+      return mediaTypes.includes(file.mediaType) && ['.yaml', '.yml'].includes(file.extension);
+    },
+    async parse(file: IFile): Promise<ParseResultElement> {
+      const source = Buffer.isBuffer(file.data) ? file.data.toString() : file.data;
+
+      try {
+        const parserOpts = pick(['sourceMap', 'refractorOpts'], this);
+        return await parse(source, parserOpts);
+      } catch (error: any) {
+        throw new ParserError(`Error parsing "${file.uri}"`, error);
+      }
+    },
+  },
+});
+
+export default ApiDesignSystemsYamlParser;