Merge branch 'main' into release

Author: RoshniNaveenaS

CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 1.0.3 - 12-03-2025
+
+### Added
+
+- Added defaults for `@AsyncAPI.SchemaVersion` and `@AsyncAPI.Title`.
+
+### Changed
+
+- Replaced `console.warn` statements with `cds.debug` logs for warning messages.
+
 ## Version 1.0.2 - 15.07.2024
 
 ### Changed

lib/compile/index.js

@@ -5,6 +5,7 @@ const getChannels = require('./channels');
 const cds = require('@sap/cds/lib');
 const { join } = require('path');
 const messages = require("./message");
+const DEBUG = cds.debug('cds:asyncapi');
 const presetMapping = {
     'event_spec_version': 'x-sap-event-spec-version',
     'event_source': 'x-sap-event-source',
@@ -29,7 +30,7 @@ module.exports = function processor(csn, options = {}) {
         const ordNamespace = _getNamespace(cds.env.ord.namespace);
         const asyncapiNamespace = _getNamespace(envConf.application_namespace);
         if (ordNamespace !== asyncapiNamespace) {
-            console.warn(messages.NAMESPACE_MISMATCH)
+            DEBUG?.(messages.NAMESPACE_MISMATCH)
         }
     }
 
@@ -157,7 +158,8 @@ function getInfoObject(serviceCsn, mergedPresetObject = undefined) {
     }
 
     if (!serviceCsn['@AsyncAPI.SchemaVersion'] || !serviceCsn['@AsyncAPI.Title']) {
-        throw new Error(messages.TITLE_VERSION_ANNOTATIONS);
+        serviceCsn['@AsyncAPI.SchemaVersion'] = '1.0.0';
+        serviceCsn['@AsyncAPI.Title'] = `Use @title: '...' on your CDS service to provide a meaningful title.`;
     }
 
     isVersionValid(serviceCsn['@AsyncAPI.SchemaVersion']);

lib/compile/message.js

@@ -5,7 +5,6 @@ const errorMessages = {
     NAMESPACE_MISMATCH: 'ORD and AsyncAPI namespaces should be same.',
     TITLE_VERSION_MERGED: 'Preset for Title and Version info needs to be added when merged flag is used.',
     NO_EVENTS: 'No events found in the service.',
-    TITLE_VERSION_ANNOTATIONS: 'Title and Version info annotations needs to be added to the service(s).',
     UNSUPPORTED_VERSION: 'The version value provided is unsupported.',
     NO_SERVICES: 'There are no service definitions found in the given model(s).',
     MERGED_FLAG: 'Merged flag cannot be used with single service definition.',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/asyncapi",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "CAP tool for AsyncAPI",
   "repository": {
     "type": "git",

test/lib/compile/asyncapiMetadata.test.js

@@ -81,10 +81,12 @@ describe('asyncapi export: presets and annotations', () => {
         expect(() => toAsyncAPI(csn)).toThrowError("There are no service definitions found in the given model(s).");
     });
 
-    test('Negative test for version', async () => {
+    test('Check for default title and version if not provided in the input', async () => {
         const inputCDS = await read(join(baseInputPath, 'invalid', 'noTitle.cds'));
         const csn = cds.compile.to.csn(inputCDS);
-        expect(() => toAsyncAPI(csn)).toThrowError("Title and Version info annotations needs to be added to the service(s).");
+        const generatedAsyncAPI = toAsyncAPI(csn);
+        expect(generatedAsyncAPI).toHaveProperty('info.title', `Use @title: '...' on your CDS service to provide a meaningful title.`);
+        expect(generatedAsyncAPI).toHaveProperty('info.version', '1.0.0');
     });
 
     test('Test for application namespace', async () => {
@@ -94,4 +96,12 @@ describe('asyncapi export: presets and annotations', () => {
         const generatedAsyncAPI = toAsyncAPI(csn);
         expect(generatedAsyncAPI).toHaveProperty('x-sap-application-namespace','customer.cap-js-asyncapi')
     });
+    test('Console warnings and errors are not used', async () => {
+        const inputCDS = await read(join(baseInputPath, 'valid', 'presets.cds'));
+        const csn = cds.compile.to.csn(inputCDS);
+        const generatedAsyncAPI = toAsyncAPI(csn);
+
+        expect(generatedAsyncAPI).not.toHaveProperty('console.warn');
+        expect(generatedAsyncAPI).not.toHaveProperty('console.error');
+    });
 });