Merge pull request #21 from cap-js/build-plugin

copy types file during build

Author: AnmolBinani

cds-plugin.js

@@ -1,8 +1,12 @@
 const cds = require("@sap/cds");
+const build = require('@sap/cds-dk/lib/build')
 const { validateNotificationTypes, readFile } = require("./lib/utils");
 const { createNotificationTypesMap } = require("./lib/notificationTypes");
 const { setGlobalLogLevel } = require("@sap-cloud-sdk/util");
 
+// register build plugin
+build.register('notifications', { impl: '@cap-js/notifications/lib/build', description: 'Notifications build plugin', taskDefaults: { src: cds.env.folders.srv } });
+
 cds.once("served", async () => {
   setGlobalLogLevel("error");
   const profiles = cds.env.profiles ?? [];
@@ -17,4 +21,4 @@ cds.once("served", async () => {
       cds.notifications = { local: { types: notificationTypesMap } };
     }
   }
-});
+});

lib/build.js

@@ -0,0 +1,19 @@
+const cds = require('@sap/cds')
+const { BuildPlugin } = require('@sap/cds-dk/lib/build')
+
+const { copy, exists, path } = cds.utils
+
+module.exports = class NotificationsBuildPlugin extends BuildPlugin {
+
+  static hasTask() {
+    const notificationTypesFile = cds.env.requires?.notifications?.types;
+    return notificationTypesFile === undefined ? false : exists(notificationTypesFile);
+  }
+
+  async build() {
+    if(exists(cds.env.requires.notifications.types)) {
+      const fileName = path.basename(cds.env.requires.notifications.types);
+      await copy(cds.env.requires.notifications.types).to(path.join(this.task.dest, fileName));
+    }
+  }
+}

lib/content-deployment.js

@@ -2,12 +2,15 @@ const cds = require("@sap/cds");
 const { validateNotificationTypes, readFile } = require("./utils");
 const { processNotificationTypes } = require("./notificationTypes");
 const { setGlobalLogLevel } = require("@sap-cloud-sdk/util");
+const { basename } = require('path');
 
 async function deployNotificationTypes() {
   setGlobalLogLevel("error");
 
   // read notification types
-  const notificationTypes = readFile(cds.env?.requires?.notifications?.types);
+  const filePath = cds.env.requires?.notifications?.types ?? '';
+  const fileName = basename(filePath);
+  const notificationTypes = readFile(fileName);
 
   if (validateNotificationTypes(notificationTypes)) {
     await processNotificationTypes(notificationTypes);
@@ -18,4 +21,4 @@ deployNotificationTypes();
 
 module.exports = {
   deployNotificationTypes
-}
+}

package.json

@@ -15,7 +15,8 @@
     "@sap-cloud-sdk/connectivity": "3.5.0",
     "@sap-cloud-sdk/http-client": "3.5.0",
     "@sap-cloud-sdk/util": "3.5.0",
-    "@sap/cds": ">=7",
+    "@sap/cds": "7.3.0",
+    "@sap/cds-dk": "7.3.1",
     "lodash": "4.17.21"
   },
   "devDependencies": {