create notfication types from the file and publish from plugin

Author: RamIndia

cds-plugin.js

@@ -0,0 +1,43 @@
+const cds = require("@sap/cds");
+const fs = require("fs").promises;
+const notifier = require("./srv/notify");
+
+global.alert = {
+  notify: notifier.postNotification,
+};
+
+const oErrorMessages = {
+  INVALID_NOTIFICATION_TYPES:
+    "Failed to create Notification Types as they are not valid.",
+};
+
+let fAreNotificationTypesValid = async (aNotificationtypes) => {
+  /**
+   * TODO: write a logic to check all the required fields.
+   */
+  return true;
+};
+
+cds.once("served", async () => {
+  /**
+   * For local testing initialise VCAP_SERVICES variables for the application
+   * process.env.VCAP_SERVICES = Strigified VCAP_SERVICES variable
+   */
+  /**
+   * TODO: Decide the properties to be added in the alerts section for notificationtype files.
+   */
+  if (cds.requires.alerts && cds.requires.alerts.notificationTypes) {
+    let notificationTypes = JSON.parse(
+      await fs.readFile(cds.requires.alerts.notificationTypes)
+    );
+    if (fAreNotificationTypesValid) {
+      notificationTypes.forEach((oNotificationType) => {
+        notifier.postNotificationType(oNotificationType);
+      });
+    } else {
+      console.log(oErrorMessages.INVALID_NOTIFICATION_TYPES);
+    }
+  }
+});
+
+module.exports = { alert: alert };

index.cds

@@ -0,0 +1,8 @@
+namespace sap.alert;
+
+service AlertNotificationService {
+  /**
+   * TODO : connect action to notify api.
+   */
+  action notify();
+}

package.json

@@ -8,12 +8,14 @@
     "license": "SEE LICENSE IN LICENSE",
     "main": "cds-plugin.js",
     "files": [
-      "lib",
-      "srv"
+        "lib",
+        "srv"
     ],
     "scripts": {
-      "lint": "npx eslint .",
-      "test": "npx jest --silent"
+        "lint": "npx eslint .",
+        "test": "npx jest --silent"
+    },
+    "dependencies": {
+        "@sap-cloud-sdk/core": "^1.54.2"
     }
-  }
-  
+}

srv/notify.js

@@ -0,0 +1,125 @@
+const cloudSDK = require("@sap-cloud-sdk/core");
+const { getDestination, executeHttpRequest, buildCsrfHeaders } = cloudSDK;
+
+const NOTIFICATIONS_DESTINATION_NAME = "SAP_Notifications";
+const NOTIFICATIONS_API_ENDPOINT = "v2/Notification.svc";
+const NOTIFICATION_TYPES_API_ENDPOINT = "v2/NotificationType.svc";
+
+async function _getDestination(destinationName) {
+  const notifServiceDest = await getDestination(destinationName);
+  if (!notifServiceDest) {
+    throw new Error(`failed to get destination: ${destinationName}`);
+  }
+  return notifServiceDest;
+}
+
+async function getNotificationTypes(
+  destinationName = NOTIFICATIONS_DESTINATION_NAME
+) {
+  const notifServiceDest = await _getDestination(destinationName);
+  const response = await executeHttpRequest(notifServiceDest, {
+    url: `${NOTIFICATION_TYPES_API_ENDPOINT}/NotificationTypes`,
+    method: "get",
+  });
+  return response.data.d.results;
+}
+
+async function postNotificationType(
+  notificationType,
+  destinationName = NOTIFICATIONS_DESTINATION_NAME
+) {
+  const notifServiceDest = await _getDestination(destinationName);
+  const csrfHeaders = await buildCsrfHeaders(notifServiceDest, {
+    url: NOTIFICATION_TYPES_API_ENDPOINT,
+  });
+  const aExistingNotificationTypes = await this.getNotificationTypes();
+  const bIsDuplicateNotificationType = aExistingNotificationTypes.find(
+    (nType) =>
+      nType.NotificationTypeKey === notificationType.NotificationTypeKey &&
+      nType.NotificationTypeVersion === notificationType.NotificationTypeVersion
+  );
+
+  if (!bIsDuplicateNotificationType) {
+    console.log(
+      `Notification Type of key ${notificationType.NotificationTypeKey} and version ${notificationType.NotificationTypeVersion} was not found. Creating it...`
+    );
+    const response = await executeHttpRequest(notifServiceDest, {
+      url: `${NOTIFICATION_TYPES_API_ENDPOINT}/NotificationTypes`,
+      method: "post",
+      data: notificationType,
+      headers: csrfHeaders,
+    });
+    return response.data.d;
+  } else {
+    return true;
+  }
+}
+
+async function createNotificationObject(
+  recipients,
+  notificationTypeKey,
+  notificationTypeVersion,
+  notificationData,
+  language = "en"
+) {
+  let aProperties = [];
+  if (typeof notificationData === "object") {
+    for (sProperty of Object.keys(notificationData)) {
+      //TODO: recheck if can be sent from application. Check for localization
+      aProperties.push({
+        Key: sProperty,
+        Language: language,
+        Value: notificationData[sProperty],
+        Type: "String",
+        IsSensitive: false,
+      });
+    }
+  }
+  return {
+    NotificationTypeKey: notificationTypeKey,
+    NotificationTypeVersion: notificationTypeVersion,
+    Priority: "High",
+    Properties: aProperties,
+    Recipients: recipients.map((recipient) => ({ RecipientId: recipient })),
+  };
+}
+
+async function postNotification(
+  recipients,
+  notificationTypeKey,
+  notificationTypeVersion,
+  notificationData,
+  language = "en",
+  destinationName = NOTIFICATIONS_DESTINATION_NAME
+) {
+  const notification = await createNotificationObject(
+    recipients,
+    notificationTypeKey,
+    notificationTypeVersion,
+    notificationData,
+    language
+  );
+  const notifServiceDest = await _getDestination(destinationName);
+  const csrfHeaders = await buildCsrfHeaders(notifServiceDest, {
+    url: NOTIFICATIONS_API_ENDPOINT,
+  });
+
+  let response = {};
+  try {
+    response = await executeHttpRequest(notifServiceDest, {
+      url: `${NOTIFICATIONS_API_ENDPOINT}/Notifications`,
+      method: "post",
+      data: notification,
+      headers: csrfHeaders,
+    });
+  } catch (e) {
+    console.log(e);
+  }
+  return response.data.d;
+}
+
+module.exports = {
+  getNotificationTypes,
+  postNotificationType,
+  postNotification,
+};