feat: add support for openapi schemas

package.json

@@ -41,6 +41,7 @@
   "author": "Elhebert",
   "license": "MIT",
   "dependencies": {
+    "@asyncapi/openapi-schema-parser": "^3.0.10",
     "@asyncapi/parser": "^3.0.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1"

src/index.ts

@@ -1,8 +1,12 @@
 import { type Input, fromFile, fromURL, Parser } from '@asyncapi/parser';
 import AsyncAPIParsingError from './AsyncAPIParsingError';
 import validate, { type ValidationFunction } from './validate';
+import openAPISchemaParser from '@asyncapi/openapi-schema-parser';
 
-const parser = new Parser({ ruleset: { core: true, recommended: false } });
+const parser = new Parser({
+  ruleset: { core: true, recommended: false },
+  schemaParsers: [openAPISchemaParser()],
+});
 
 export default {
   /**

tests/fixtures/valid-schema-openapi-2.4.0.yaml

@@ -0,0 +1,44 @@
+asyncapi: 2.4.0
+info:
+  title: My API
+  version: '1.0.0'
+
+channels:
+  myChannel:
+    publish:
+      message:
+        $ref: '#/components/messages/testMessage'
+
+components:
+  messages:
+    testMessage:
+      schemaFormat: application/vnd.oai.openapi;version=3.0.0
+      payload:
+        type: object
+        nullable: true
+        example:
+          name: Fran
+        properties:
+          name:
+            type: string
+          discriminatorTest:
+            discriminator:
+              propertyName: objectType
+            oneOf:
+              - type: object
+                properties:
+                  objectType:
+                    type: string
+                  prop1:
+                    type: string
+              - type: object
+                properties:
+                  objectType:
+                    type: string
+                  prop2:
+                    type: string
+          test:
+            type: object
+            properties:
+              testing:
+                type: string

tests/fixtures/valid-schema-openapi-3.0.0.yaml

@@ -0,0 +1,51 @@
+asyncapi: 3.0.0
+info:
+  title: My API
+  version: 1.0.0
+channels:
+  myChannel:
+    address: myChannel
+    messages:
+      publish.message:
+        $ref: '#/components/messages/testMessage'
+operations:
+  myChannel.publish:
+    action: receive
+    channel:
+      $ref: '#/channels/myChannel'
+    messages:
+      - $ref: '#/channels/myChannel/messages/publish.message'
+components:
+  messages:
+    testMessage:
+      payload:
+        schemaFormat: application/vnd.oai.openapi;version=3.0.0
+        schema:
+          type: object
+          nullable: true
+          example:
+            name: Fran
+          properties:
+            name:
+              type: string
+            discriminatorTest:
+              discriminator:
+                propertyName: objectType
+              oneOf:
+                - type: object
+                  properties:
+                    objectType:
+                      type: string
+                    prop1:
+                      type: string
+                - type: object
+                  properties:
+                    objectType:
+                      type: string
+                    prop2:
+                      type: string
+            test:
+              type: object
+              properties:
+                testing:
+                  type: string

tests/from-file.test.ts

@@ -204,4 +204,28 @@ describe('parsing `fromFile`', () => {
       );
     }
   });
+
+  it('validate an openapi schema inside a valid Async API 3.0.0 schema', async () => {
+    const validator = await asyncApiValidation.fromFile(
+      path.join(__dirname, 'fixtures', 'valid-schema-openapi-3.0.0.yaml')
+    );
+
+    const payload = {
+      name: 'Fran',
+    };
+
+    expect(validator('testMessage', payload)).toBe(true);
+  });
+
+  it('validate an openapi schema inside a valid Async API 2.4.0 schema', async () => {
+    const validator = await asyncApiValidation.fromFile(
+      path.join(__dirname, 'fixtures', 'valid-schema-openapi-2.4.0.yaml')
+    );
+
+    const payload = {
+      name: 'Fran',
+    };
+
+    expect(validator('testMessage', payload)).toBe(true);
+  });
 });

tests/from-schema.test.ts

@@ -218,4 +218,32 @@ describe('parsing `fromSchema`', () => {
       );
     }
   });
+
+  it('validate an openapi schema inside a valid Async API 3.0.0 schema', async () => {
+    const schema = await readFile(
+      path.join(__dirname, 'fixtures', 'valid-schema-openapi-3.0.0.yaml'),
+      'utf-8'
+    );
+    const validator = await asyncApiValidation.fromSchema(schema);
+
+    const payload = {
+      name: 'Fran',
+    };
+
+    expect(validator('testMessage', payload)).toBe(true);
+  });
+
+  it('validate an openapi schema inside a valid Async API 2.4.0 schema', async () => {
+    const schema = await readFile(
+      path.join(__dirname, 'fixtures', 'valid-schema-openapi-2.4.0.yaml'),
+      'utf-8'
+    );
+    const validator = await asyncApiValidation.fromSchema(schema);
+
+    const payload = {
+      name: 'Fran',
+    };
+
+    expect(validator('testMessage', payload)).toBe(true);
+  });
 });