Merge pull request #25 from cap-js/default-namespace

change default namespace

CHANGELOG.md

@@ -4,6 +4,12 @@ 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.2
+
+### Changed
+
+- Changed default namespace from `sap.app` to `customer.<package-name>`
+
 ## Version 1.0.1 - 14.05.2024
 
 ### Changed

lib/compile/index.js

@@ -3,8 +3,8 @@ const getMessageTraits = require('./components/messageTraits');
 const { definitionsToMessages, nestedAnnotation } = require('./components/messages');
 const getChannels = require('./channels');
 const cds = require('@sap/cds/lib');
+const { join } = require('path');
 const messages = require("./message");
-const defaultConfig = require("./config.json")
 const presetMapping = {
     'event_spec_version': 'x-sap-event-spec-version',
     'event_source': 'x-sap-event-source',
@@ -19,9 +19,20 @@ module.exports = function processor(csn, options = {}) {
         envConf = cds.env.export.asyncapi;
     } 
     if (!cds.env?.export?.asyncapi?.application_namespace) {
-        envConf["application_namespace"] = defaultConfig.application_namespace;
+        const packageJson = require(join(cds.root,'package.json'));
+        const appName = packageJson.name.replace(/\s/g, "-");
+        envConf["application_namespace"] = `customer.${appName}`
         console.info(messages.APPLICATION_NAMESPACE);
     }
+
+    if (cds.env.ord?.namespace) {
+        const ordNamespace = _getNamespace(cds.env.ord.namespace);
+        const asyncapiNamespace = _getNamespace(envConf.application_namespace);
+        if (ordNamespace !== asyncapiNamespace) {
+            console.warn(messages.NAMESPACE_MISMATCH)
+        }
+    }
+
     _serviceErrorHandling(csn, options);
 
     const applicationNamespace = envConf.application_namespace;
@@ -249,3 +260,7 @@ function* _iterate(services, csn, applicationNamespace, presets) {
         yield [generatedAsyncAPI, { file: key }];
     }
 }
+
+function _getNamespace(fullNamespace) {
+    return fullNamespace.split('.').slice(0, 2).join('.');
+}

lib/compile/message.js

@@ -2,6 +2,7 @@
 
 const errorMessages = {
     APPLICATION_NAMESPACE: 'Default application namespace is used.',
+    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).',

test/lib/compile/asyncapiMetadata.test.js

@@ -92,6 +92,6 @@ describe('asyncapi export: presets and annotations', () => {
         cds.env.export.asyncapi = {};
         const csn = cds.compile.to.csn(inputCDS);
         const generatedAsyncAPI = toAsyncAPI(csn);
-        expect(generatedAsyncAPI).toHaveProperty('x-sap-application-namespace','sap.app')
+        expect(generatedAsyncAPI).toHaveProperty('x-sap-application-namespace','customer.@cap-js/asyncapi')
     });
 });