feat: enable validation of AsyncAPI Spec v3 documents in validate command

package.json

@@ -16,13 +16,14 @@
     "@asyncapi/modelina": "^1.9.0",
     "@asyncapi/openapi-schema-parser": "^3.0.3",
     "@asyncapi/optimizer": "^0.2.1",
-    "@asyncapi/parser": "^2.1.0",
-    "@asyncapi/raml-dt-schema-parser": "^4.0.3",
+    "@asyncapi/parser": "^3.0.0-next-major-spec.2",
     "@asyncapi/protobuf-schema-parser": "3.0.0",
+    "@asyncapi/raml-dt-schema-parser": "^4.0.3",
     "@asyncapi/studio": "^0.17.3",
     "@oclif/core": "^1.26.2",
     "@oclif/errors": "^1.3.6",
     "@oclif/plugin-not-found": "^2.3.22",
+    "@smoya/multi-parser": "^3.0.0",
     "@stoplight/spectral-cli": "6.9.0",
     "ajv": "^8.12.0",
     "chalk": "^4.1.0",

src/commands/convert.ts

@@ -12,7 +12,7 @@ import type { ConvertVersion } from '@asyncapi/converter';
 // @ts-ignore
 import specs from '@asyncapi/specs';
 
-const latestVersion = Object.keys(specs).pop() as string;
+const latestVersion = Object.keys(specs.schemas).pop() as string;
 
 export default class Convert extends Command {
   static description = 'Convert asyncapi documents older to newer versions';

src/commands/generate/models.ts

@@ -1,5 +1,6 @@
 import { CSharpFileGenerator, JavaFileGenerator, JavaScriptFileGenerator, TypeScriptFileGenerator, GoFileGenerator, Logger, DartFileGenerator, PythonFileGenerator, RustFileGenerator, TS_COMMON_PRESET, TS_JSONBINPACK_PRESET, CSHARP_DEFAULT_PRESET, CSHARP_NEWTONSOFT_SERIALIZER_PRESET, CSHARP_COMMON_PRESET, CSHARP_JSON_SERIALIZER_PRESET, KotlinFileGenerator, TS_DESCRIPTION_PRESET, PhpFileGenerator, CplusplusFileGenerator } from '@asyncapi/modelina';
 import { Flags } from '@oclif/core';
+import { ConvertDocumentParserAPIVersion } from '@smoya/multi-parser';
 import Command from '../../base';
 import { load } from '../../models/SpecificationFile';
 import { formatOutput, parse, validationFlags } from '../../parser';
@@ -161,6 +162,11 @@ export default class Models extends Command {
       this.log(`Input is not a correct AsyncAPI document so it cannot be processed.${formatOutput(severityErrors,'stylish','error')}`);
       return;
     }
+
+    // Modelina, atm, is not using @asyncapi/[email protected] but @asyncapi/[email protected], so it still uses Parser-API v1.0.0. 
+    // This call converts the parsed document object using @asyncapi/[email protected] (Parser-API v2.0.0) to a document compatible with the Parser-API version in use in @asyncapi/[email protected]  (v1.0.0)
+    // This is needed until https://github.com/asyncapi/modelina/issues/1493 gets fixed.
+    const convertedDoc = ConvertDocumentParserAPIVersion(document.json(), '1.0.0');
 
     Logger.setLogger({
       info: (message) => {
@@ -314,7 +320,7 @@ export default class Models extends Command {
 
     if (output) {
       const models = await fileGenerator.generateToFiles(
-        document as any,
+        convertedDoc as any,
         output,
         { ...fileOptions, } as any);
       const generatedModels = models.map((model) => { return model.modelName; });
@@ -323,7 +329,7 @@ export default class Models extends Command {
     }
 
     const models = await fileGenerator.generateCompleteModels(
-      document as any,
+      convertedDoc as any,
       { ...fileOptions } as any);
     const generatedModels = models.map((model) => {
       return `

test.asyncapi-cli

@@ -0,0 +1 @@
+{"store":{}}

test/fixtures/valid-specification-latest.yml

@@ -0,0 +1,48 @@
+asyncapi: 3.0.0
+id: urn:some:company
+info:
+  title: Account Service
+  version: 1.0.0
+  description: This service is in charge of processing user signups
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+  contact:
+    name: API Support
+    url: https://www.example.com/support
+    email: [email protected]
+  tags:
+  - name: some-tag
+defaultContentType: 'application/json'
+servers:
+  production:
+    host: development.gigantic-server.com
+    description: Development server
+    protocol: kafka
+    protocolVersion: '1.0.0'
+channels:
+  UserSignedUp:
+    address: 'user/signedup'
+    messages: 
+      UserSignedUp:
+        $ref: '#/components/messages/UserSignedUp'
+operations:
+  UserSignedUp:
+    description: User signedup
+    action: 'send'
+    channel:
+      $ref: '#/channels/UserSignedUp'        
+components:
+  messages:
+    UserSignedUp:
+      messageId: UserSignedUp
+      payload:
+        type: object
+        properties:
+          displayName:
+            type: string
+            description: Name of the user
+          email:
+            type: string
+            format: email
+            description: Email of the user

test/integration/validate.test.ts

@@ -70,9 +70,9 @@ describe('validate', () => {
     test
       .stderr()
       .stdout()
-      .command(['validate', './test/fixtures/valid-specification.yml'])
+      .command(['validate', './test/fixtures/valid-specification-latest.yml'])
       .it('works when file path is passed', (ctx, done) => {
-        expect(ctx.stdout).toMatch('File ./test/fixtures/valid-specification.yml is valid! File ./test/fixtures/valid-specification.yml and referenced documents don\'t have governance issues.');
+        expect(ctx.stdout).toMatch('File ./test/fixtures/valid-specification-latest.yml is valid! File ./test/fixtures/valid-specification-latest.yml and referenced documents don\'t have governance issues.');
         expect(ctx.stderr).toEqual('');
         done();
       });
@@ -221,9 +221,9 @@ describe('validate', () => {
     test
       .stderr()
       .stdout()
-      .command(['validate', './test/fixtures/valid-specification.yml', '--diagnostics-format=text'])
+      .command(['validate', './test/fixtures/valid-specification-latest.yml', '--diagnostics-format=text'])
       .it('works with --diagnostics-format flag (without governance issues)', (ctx, done) => {
-        expect(ctx.stdout).toMatch('File ./test/fixtures/valid-specification.yml is valid! File ./test/fixtures/valid-specification.yml and referenced documents don\'t have governance issues.');
+        expect(ctx.stdout).toMatch('File ./test/fixtures/valid-specification-latest.yml is valid! File ./test/fixtures/valid-specification-latest.yml and referenced documents don\'t have governance issues.');
         expect(ctx.stderr).toEqual('');
         done();
       });