Plugins

Author: oklemenz2

.cdsrc.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const config = require("./config.json");
+const { merge } = require("./src/util/helper");
+
+module.exports = {
+  cds: merge(
+    ...[...config.plugins, config.paths.base].map((module) => {
+      return require(`${module}/package.json`).cds;
+    }),
+  ),
+};

bin/commands/init.js

@@ -189,12 +189,6 @@ Examples:
         json.websockets = { enabled: true };
       });
 
-      // Install @cap-js-community packages
-      shelljs.exec(
-        `npm install --save @cap-js-community/event-queue @cap-js-community/websocket @cap-js-community/feature-toggle-library`,
-        { silent: true },
-      );
-
       return true;
     } catch (err) {
       console.error("Project initialization failed: ", err.message);

bin/features/app.js

@@ -4,7 +4,7 @@
 const fs = require("fs");
 const path = require("path");
 
-const config = require("../config");
+const config = require("../config.json");
 
 module.exports = () => {
   try {

cds-plugin.js

@@ -12,9 +12,14 @@ const { StatusCodes, getReasonPhrase } = require("http-status-codes");
 const toggles = require("@cap-js-community/feature-toggle-library");
 const { config: eventQueueConfig } = require("@cap-js-community/event-queue");
 
-const { mergeDeep, toObject } = require("./src/util/helper");
+const { merge, toObject } = require("./src/util/helper");
 
-const config = mergeDeep(require("./config"), cds.env.requires?.["sap-afc-sdk"]?.config ?? {});
+const config = merge(require("./config.json"), cds.env.requires?.["sap-afc-sdk"]?.config ?? {});
+
+// Plugins
+for (const plugin of config.plugins) {
+  require(`${plugin}/cds-plugin`);
+}
 
 const SERVER_SUFFIX = "srv";
 const APPROUTER_SUFFIX = "approuter";
@@ -139,7 +144,7 @@ function serveBroker() {
   let brokerConfig = toObject(cds.env.requires?.["sap-afc-sdk"]?.broker);
   const brokerPath = path.join(cds.root, config.paths.broker);
   try {
-    brokerConfig = mergeDeep(require(brokerPath), brokerConfig);
+    brokerConfig = merge(require(brokerPath), brokerConfig);
   } catch (err) {
     if (Object.keys(brokerConfig).length === 0) {
       cds.log("/broker").info(`broker.json not found at '${brokerPath}'. Call 'afc add broker'`);
@@ -260,7 +265,7 @@ function serveMergedAppConfig(packageRoot, uiPath) {
         inbound.resolutionResult.url = `${uiPath}/${inbound.resolutionResult.url}`;
       }
     }
-    const mergedFioriSandboxConfig = mergeDeep(packageFioriSandboxConfig, projectFioriSandboxConfig);
+    const mergedFioriSandboxConfig = merge(packageFioriSandboxConfig, projectFioriSandboxConfig);
     res.send(mergedFioriSandboxConfig);
   });
 }
@@ -414,7 +419,7 @@ function outboxServices() {
 }
 
 function handleFeatureToggles() {
-  // event-queue
+  // Event-Queue
   for (const name in config.toggles.eventQueue) {
     const toggle = config.toggles.eventQueue[name];
     eventQueueConfig[name] = toggles.getFeatureValue(toggle);

config.json

@@ -1,5 +1,6 @@
 {
   "paths": {
+    "base": "./",
     "broker": "./srv/broker.json",
     "catalog": "./srv/catalog.json",
     "launchpad": "launchpad.html",
@@ -27,5 +28,10 @@
   },
   "endpoints": {
     "authentication": "https://authentication.sap.hana.ondemand.com"
-  }
+  },
+  "plugins": [
+    "@cap-js-community/event-queue",
+    "@cap-js-community/feature-toggle-library",
+    "@cap-js-community/websocket"
+  ]
 }