@neoimpulse/cap-js-notifications 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/cds-plugin.js

@@ -0,0 +1,25 @@
+const cds = require("@sap/cds/lib");
+
+if (cds.cli.command === "build") {
+  // register build plugin
+  cds.build?.register?.('notifications', require("./lib/build"));
+}
+
+else cds.once("served", async () => {
+  const { validateNotificationTypes, readFile } = require("./lib/utils");
+  const { createNotificationTypesMap } = require("./lib/notificationTypes");
+  const { deployNotificationTypes } = require("./lib/content-deployment");
+  const production = cds.env.profiles?.includes("production");
+
+  // read notification types
+  const notificationTypes = readFile(cds.env.requires?.notifications?.types);
+  if (validateNotificationTypes(notificationTypes)) {
+    if (!production) {
+      const notificationTypesMap = createNotificationTypesMap(notificationTypes, true);
+      cds.notifications = { local: { types: notificationTypesMap } };
+    }
+    deployNotificationTypes();
+  }
+
+  require("@sap-cloud-sdk/util").setGlobalLogLevel("error")
+})

package/lib/build.js

@@ -0,0 +1,19 @@
+const cds = require('@sap/cds')
+
+const { copy, exists, path } = cds.utils
+
+module.exports = class NotificationsBuildPlugin extends cds.build.Plugin {
+  static taskDefaults = { src: cds.env.folders.srv }
+  
+  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));
+    }
+  }
+}

package/lib/content-deployment.js

@@ -0,0 +1,22 @@
+const cds = require("@sap/cds");
+const { validateNotificationTypes, readFile } = require("./utils");
+const { processNotificationTypes } = require("./notificationTypes");
+const { setGlobalLogLevel } = require("@sap-cloud-sdk/util");
+
+async function deployNotificationTypes() {
+  setGlobalLogLevel("error");
+
+  // read notification types
+  const filePath = cds.env.requires?.notifications?.types ?? '';
+  const notificationTypes = readFile(filePath);
+
+  if (validateNotificationTypes(notificationTypes)) {
+    await processNotificationTypes(notificationTypes);
+  }
+}
+
+deployNotificationTypes();
+
+module.exports = {
+  deployNotificationTypes
+}

package/lib/notificationTypes.js

@@ -0,0 +1,307 @@
+const { executeHttpRequest } = require("@sap-cloud-sdk/http-client");
+const { buildHeadersForDestination } = require("@sap-cloud-sdk/connectivity");
+const { getNotificationDestination, getPrefix, getNotificationTypesKeyWithPrefix } = require("./utils");
+const NOTIFICATION_TYPES_API_ENDPOINT = "v2/NotificationType.svc";
+const cds = require("@sap/cds");
+const LOG = cds.log('notifications');
+
+const defaultTemplate = {
+  NotificationTypeKey: "Default",
+  NotificationTypeVersion: "1",
+  Templates: [
+    {
+      Language: "en",
+      Description: "Other Notifications",
+      TemplatePublic: "{{title}}",
+      TemplateSensitive: "{{title}}",
+      TemplateGrouped: "Other Notifications",
+      TemplateLanguage: "mustache",
+      Subtitle: "{{description}}"
+    }
+  ]
+};
+
+function fromOdataArrayFormat(objectInArray) {
+  if (objectInArray === undefined || objectInArray === null || Array.isArray(objectInArray)) {
+    return (objectInArray === undefined || objectInArray === null) ? [] : objectInArray;
+  } else {
+    return (objectInArray.results === undefined || objectInArray.results === null) ? [] : objectInArray.results;
+  }
+}
+
+function createNotificationTypesMap(notificationTypesJSON, isLocal = false) {
+  const types = {};
+
+  if (isLocal) {
+    types["Default"] = { "1": defaultTemplate };
+  }
+
+  // add user provided templates
+  notificationTypesJSON.forEach((notificationType) => {
+    // set default NotificationTypeVersion if required
+    if (notificationType.NotificationTypeVersion === undefined) {
+      notificationType.NotificationTypeVersion = "1";
+    }
+
+    const notificationTypeKeyWithPrefix = getNotificationTypesKeyWithPrefix(notificationType.NotificationTypeKey);
+
+    // update the notification type key with prefix
+    notificationType.NotificationTypeKey = notificationTypeKeyWithPrefix;
+
+    if (!(notificationTypeKeyWithPrefix in types)) {
+      types[notificationTypeKeyWithPrefix] = {};
+    }
+
+    types[notificationTypeKeyWithPrefix][notificationType.NotificationTypeVersion] = notificationType;
+  });
+
+  return types;
+}
+
+async function getNotificationTypes() {
+  const notificationDestination = await getNotificationDestination();
+  const response = await executeHttpRequest(notificationDestination, {
+    url: `${NOTIFICATION_TYPES_API_ENDPOINT}/NotificationTypes?$format=json&$expand=Templates,Actions,DeliveryChannels`,
+    method: "get"
+  });
+  return response.data.d.results;
+}
+
+async function createNotificationType(notificationType) {
+  const notificationDestination = await getNotificationDestination();
+  const csrfHeaders = await buildHeadersForDestination(notificationDestination, {
+    url: NOTIFICATION_TYPES_API_ENDPOINT
+  });
+
+  LOG._warn && LOG.warn(
+    `Notification Type of key ${notificationType.NotificationTypeKey} and version ${notificationType.NotificationTypeVersion} was not found. Creating it...`
+  );
+
+  const response = await executeHttpRequest(notificationDestination, {
+    url: `${NOTIFICATION_TYPES_API_ENDPOINT}/NotificationTypes`,
+    method: "post",
+    data: notificationType,
+    headers: csrfHeaders
+  });
+  return response.data?.d ?? response;
+}
+
+async function updateNotificationType(id, notificationType) {
+  const notificationDestination = await getNotificationDestination();
+  const csrfHeaders = await buildHeadersForDestination(notificationDestination, {
+    url: NOTIFICATION_TYPES_API_ENDPOINT
+  });
+
+  LOG._info && LOG.info(
+    `Detected change in notification type of key ${notificationType.NotificationTypeKey} and version ${notificationType.NotificationTypeVersion}. Updating it...`
+  );
+
+  const response = await executeHttpRequest(notificationDestination, {
+    url: `${NOTIFICATION_TYPES_API_ENDPOINT}/NotificationTypes(guid'${id}')`,
+    method: "patch",
+    data: notificationType,
+    headers: csrfHeaders
+  });
+  return response.status;
+}
+
+async function deleteNotificationType(notificationType) {
+  const notificationDestination = await getNotificationDestination();
+  const csrfHeaders = await buildHeadersForDestination(notificationDestination, {
+    url: NOTIFICATION_TYPES_API_ENDPOINT
+  });
+
+  LOG._info && LOG.info(
+    `Notification Type of key ${notificationType.NotificationTypeKey} and version ${notificationType.NotificationTypeVersion} not present in the types file. Deleting it...`
+  );
+
+  const response = await executeHttpRequest(notificationDestination, {
+    url: `${NOTIFICATION_TYPES_API_ENDPOINT}/NotificationTypes(guid'${notificationType.NotificationTypeId}')`,
+    method: "delete",
+    headers: csrfHeaders
+  });
+  return response.status;
+}
+
+function _createChannelsMap(channels) {
+  const channelMap = {};
+
+  channels.forEach((channel) => {
+    channelMap[channel.Type] = channel;
+  });
+
+  return channelMap;
+}
+
+function areDeliveryChannelsEqual(oldChannels, newChannels) {
+  if (oldChannels.length !== newChannels.length) {
+    return false;
+  }
+
+  const oldChannelsMap = _createChannelsMap(oldChannels);
+  const newChannelsMap = _createChannelsMap(newChannels);
+
+  for (let type of Object.keys(oldChannelsMap)) {
+    if (!(type in newChannelsMap)) return false;
+
+    const oldChannel = oldChannelsMap[type];
+    const newChannel = newChannelsMap[type];
+
+    // TODO: Check if language is not there
+    const equal =
+      oldChannel.Type == newChannel.Type.toUpperCase() &&
+      oldChannel.Enabled == newChannel.Enabled &&
+      oldChannel.DefaultPreference == newChannel.DefaultPreference &&
+      oldChannel.EditablePreference == newChannel.EditablePreference;
+
+    if (!equal) return false;
+    delete newChannelsMap[type];
+  }
+
+  return Object.keys(newChannelsMap).length == 0;
+}
+
+function isActionEqual(oldAction, newAction) {
+  return (
+    oldAction.Language == newAction.Language.toUpperCase() &&
+    oldAction.ActionId == newAction.ActionId &&
+    oldAction.ActionText == newAction.ActionText &&
+    oldAction.GroupActionText == newAction.GroupActionText &&
+    oldAction.Nature == newAction.Nature
+  );
+}
+
+function areActionsEqual(oldActions, newActions) {
+  if (oldActions.length !== newActions.length) {
+    return false;
+  }
+
+  let matchFound = false;
+  for (const oldAction of oldActions) {
+    for (const newAction of newActions) {
+      if (isActionEqual(oldAction, newAction)) {
+        matchFound = true;
+        break;
+      }
+    }
+    if (!matchFound) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+function isTemplateEqual(oldTemplate, newTemplate) {
+  return (
+    oldTemplate.Language == newTemplate.Language.toUpperCase() &&
+    oldTemplate.TemplatePublic == newTemplate.TemplatePublic &&
+    oldTemplate.TemplateSensitive == newTemplate.TemplateSensitive &&
+    oldTemplate.TemplateGrouped == newTemplate.TemplateGrouped &&
+    oldTemplate.Description == newTemplate.Description &&
+    oldTemplate.TemplateLanguage == newTemplate.TemplateLanguage.toUpperCase() &&
+    oldTemplate.Subtitle == newTemplate.Subtitle &&
+    oldTemplate.EmailSubject == newTemplate.EmailSubject &&
+    oldTemplate.EmailText == newTemplate.EmailText &&
+    oldTemplate.EmailHtml == newTemplate.EmailHtml
+  );
+}
+
+function areTemplatesEqual(oldTemplates, newTemplates) {
+  if (oldTemplates.length !== newTemplates.length) {
+    return false;
+  }
+
+  let matchFound = false;
+  for (const oldTemplate of oldTemplates) {
+    for (const newTemplate of newTemplates) {
+      if (isTemplateEqual(oldTemplate, newTemplate)) {
+        matchFound = true;
+        break;
+      }
+    }
+    if (!matchFound) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+function isNotificationTypeEqual(oldNotificationType, newNotificationType) {
+  if (newNotificationType.IsGroupable === undefined) {
+    newNotificationType.IsGroupable = true;
+  }
+
+  return (
+    oldNotificationType.IsGroupable == newNotificationType.IsGroupable &&
+    areTemplatesEqual(fromOdataArrayFormat(oldNotificationType.Templates), fromOdataArrayFormat(newNotificationType.Templates)) &&
+    areActionsEqual(fromOdataArrayFormat(oldNotificationType.Actions), fromOdataArrayFormat(newNotificationType.Actions)) &&
+    areDeliveryChannelsEqual(fromOdataArrayFormat(oldNotificationType.DeliveryChannels), fromOdataArrayFormat(newNotificationType.DeliveryChannels))
+  );
+}
+
+async function processNotificationTypes(notificationTypesJSON) {
+  const notificationTypes = createNotificationTypesMap(notificationTypesJSON);
+  const prefix = getPrefix();
+  let defaultTemplateExists = false;
+
+  // get notficationTypes
+  const existingTypes = await getNotificationTypes();
+
+  // iterate through notification types
+  for (const existingType of existingTypes) {
+    if (existingType.NotificationTypeKey == "Default") {
+      defaultTemplateExists = true;
+      continue;
+    }
+
+    if (!existingType.NotificationTypeKey.startsWith(`${prefix}/`)) {
+      LOG._info && LOG.info(`Skipping Notification Type of other application: ${existingType.NotificationTypeKey}.`);
+      continue;
+    }
+
+    // if the type isn't present in the JSON file, delete it
+    if (
+      notificationTypes[existingType.NotificationTypeKey] === undefined ||
+      notificationTypes[existingType.NotificationTypeKey][existingType.NotificationTypeVersion] === undefined
+    ) {
+      await deleteNotificationType(existingType);
+      continue;
+    }
+
+    const newType = JSON.parse(JSON.stringify(notificationTypes[existingType.NotificationTypeKey][existingType.NotificationTypeVersion]));
+
+    // if the type is there then verify if everything is same or not
+    if (!isNotificationTypeEqual(existingType, newType)) {
+      await updateNotificationType(existingType.NotificationTypeId, notificationTypes[existingType.NotificationTypeKey][existingType.NotificationTypeVersion]);
+    } else {
+      LOG._info && LOG.info(
+        `Notification Type of key ${existingType.NotificationTypeKey} and version ${existingType.NotificationTypeVersion} unchanged.`
+      );
+    }
+
+    delete notificationTypes[existingType.NotificationTypeKey][existingType.NotificationTypeVersion];
+
+    if (Object.keys(notificationTypes[existingType.NotificationTypeKey]).length == 0) {
+      delete notificationTypes[existingType.NotificationTypeKey];
+    }
+  }
+
+  // create default template if required
+  if (!defaultTemplateExists) {
+    await createNotificationType(defaultTemplate);
+  }
+
+  // create notification types that aren't there
+  for (const notificationTypeKey in notificationTypes) {
+    for (const notificationTypeVersion in notificationTypes[notificationTypeKey]) {
+      await createNotificationType(notificationTypes[notificationTypeKey][notificationTypeVersion]);
+    }
+  }
+}
+
+module.exports = {
+  createNotificationTypesMap,
+  processNotificationTypes
+}

package/lib/utils.js

@@ -0,0 +1,247 @@
+const { existsSync, readFileSync } = require('fs');
+const { basename } = require('path');
+const cds = require("@sap/cds");
+const LOG = cds.log('notifications');
+const { getDestination } = require("@sap-cloud-sdk/connectivity");
+const PRIORITIES = ["LOW", "NEUTRAL", "MEDIUM", "HIGH"];
+
+const messages = {
+  TYPES_FILE_NOT_EXISTS: "Notification Types file path is incorrect.",
+  INVALID_NOTIFICATION_TYPES: "Notification Types must contain the following key: 'NotificationTypeKey'.",
+  DESTINATION_NOT_FOUND: "Failed to get destination: ",
+  MANDATORY_PARAMETER_NOT_PASSED_FOR_DEFAULT_NOTIFICATION: "Recipients and title are mandatory parameters.",
+  MANDATORY_PARAMETER_NOT_PASSED_FOR_CUSTOM_NOTIFICATION: "Recipients are mandatory parameters.",
+  RECIPIENTS_IS_NOT_ARRAY: "Recipients is not an array or it is empty.",
+  TITLE_IS_NOT_STRING: "Title is not a string.",
+  DESCRIPTION_IS_NOT_STRING: "Description is not a string.",
+  PROPERTIES_IS_NOT_OBJECT: "Properties is not an object.",
+  NAVIGATION_IS_NOT_OBJECT: "Navigation is not an object.",
+  PAYLOAD_IS_NOT_OBJECT: "Payload is not an object.",
+  EMPTY_OBJECT_FOR_NOTIFY: "Empty object is passed a single parameter to notify function.",
+  NO_OBJECT_FOR_NOTIFY: "An object must be passed to notify function."
+};
+
+function validateNotificationTypes(notificationTypes) {
+  for(let notificationType of notificationTypes){
+    if (!("NotificationTypeKey" in notificationType)) {
+      LOG._warn && LOG.warn(messages.INVALID_NOTIFICATION_TYPES);
+      return false;
+    }
+  }
+
+  return true;
+}
+
+function validateDefaultNotifyParameters(recipients, priority, title, description) {
+  if (!recipients || !title) {
+    LOG._warn && LOG.warn(messages.MANDATORY_PARAMETER_NOT_PASSED_FOR_DEFAULT_NOTIFICATION);
+    return false;
+  }
+
+  if (!Array.isArray(recipients) || recipients.length == 0) {
+    LOG._warn && LOG.warn(messages.RECIPIENTS_IS_NOT_ARRAY);
+    return false;
+  }
+
+  if (typeof title !== "string") {
+    LOG._warn && LOG.warn(messages.TITLE_IS_NOT_STRING);
+    return false;
+  }
+
+  if (priority && !PRIORITIES.includes(priority.toUpperCase())) {
+    LOG._warn && LOG.warn(`Invalid priority ${priority}. Allowed priorities are LOW, NEUTRAL, MEDIUM, HIGH`);
+    return false;
+  }
+
+  if (description && typeof description !== "string") {
+    LOG._warn && LOG.warn(messages.DESCRIPTION_IS_NOT_STRING);
+    return false;
+  }
+
+  return true;
+}
+
+function validateCustomNotifyParameters(type, recipients, properties, navigation, priority, payload) {
+  if (!recipients) {
+    LOG._warn && LOG.warn(messages.MANDATORY_PARAMETER_NOT_PASSED_FOR_CUSTOM_NOTIFICATION);
+    return false;
+  }
+
+  if (!Array.isArray(recipients) || recipients.length == 0) {
+    LOG._warn && LOG.warn(messages.RECIPIENTS_IS_NOT_ARRAY);
+    return false;
+  }
+
+  if (priority && !PRIORITIES.includes(priority.toUpperCase())) {
+    LOG._warn && LOG.warn(`Invalid priority ${priority}. Allowed priorities are LOW, NEUTRAL, MEDIUM, HIGH`);
+    return false;
+  }
+
+  if (properties && !Array.isArray(properties)) {
+    LOG._warn && LOG.warn(messages.PROPERTIES_IS_NOT_OBJECT);
+    return false;
+  }
+
+  if (navigation && typeof navigation !== "object") {
+    LOG._warn && LOG.warn(messages.NAVIGATION_IS_NOT_OBJECT);
+    return false;
+  }
+
+  if (payload && typeof payload !== "object") {
+    LOG._warn && LOG.warn(messages.PAYLOAD_IS_NOT_OBJECT);
+    return false;
+  }
+
+  return true;
+}
+
+
+function readFile(filePath) {
+  if (!existsSync(filePath)) {
+    LOG._warn && LOG.warn(messages.TYPES_FILE_NOT_EXISTS);
+    return [];
+  }
+
+  return JSON.parse(readFileSync(filePath));
+}
+
+async function getNotificationDestination() {
+  const destinationName = cds.env.requires.notifications?.destination ?? "SAP_Notifications";
+  const notificationDestination = await getDestination({ destinationName, useCache: true });
+  if (!notificationDestination) {
+    // TODO: What to do if destination isn't found??
+    throw new Error(messages.DESTINATION_NOT_FOUND + destinationName);
+  }
+  return notificationDestination;
+}
+
+let prefix // be filled in below...
+function getPrefix() {
+  if (!prefix) {
+    prefix = cds.env.requires.notifications?.prefix
+    if (prefix === "$app-name") try {
+      prefix = require(cds.root + '/package.json').name
+    } catch { prefix = null }
+    if (!prefix) prefix = basename(cds.root)
+  }
+  return prefix
+}
+
+function getNotificationTypesKeyWithPrefix(notificationTypeKey) {
+  const prefix = getPrefix();
+  return `${prefix}/${notificationTypeKey}`;
+}
+
+function buildDefaultNotification(
+  recipients,
+  priority = "NEUTRAL",
+  title,
+  description = ""
+) {
+  const properties = [
+    {
+      Key: "title",
+      Language: "en",
+      Value: title,
+      Type: "String",
+      IsSensitive: false,
+    },
+    {
+      Key: "description",
+      Language: "en",
+      Value: description,
+      Type: "String",
+      IsSensitive: false,
+    },
+  ];
+
+  return {
+    NotificationTypeKey: "Default",
+    NotificationTypeVersion: "1",
+    Priority: priority,
+    Properties: properties,
+    Recipients: recipients.map((recipient) => ({ RecipientId: recipient }))
+  };
+}
+
+function buildCustomNotification(_) {
+  let notification = {
+
+    // Properties with simple API variants
+    NotificationTypeKey: getNotificationTypesKeyWithPrefix(_.NotificationTypeKey || _.type),
+    Recipients: _.Recipients || _.recipients?.map(id => ({ RecipientId: id })),
+    Priority: _.Priority || _.priority || "NEUTRAL",
+    Properties: _.Properties || Object.entries(_.data).map(([k,v]) => ({
+      Key:k, Value:v, Language: "en", Type: typeof v, // IsSensitive: false
+    })),
+
+    // Low-level API properties
+    OriginId: _.OriginId,
+    NotificationTypeId: _.NotificationTypeId,
+    NotificationTypeVersion: _.NotificationTypeVersion || "1",
+    NavigationTargetAction: _.NavigationTargetAction,
+    NavigationTargetObject: _.NavigationTargetObject,
+    ProviderId: _.ProviderId,
+    ActorId: _.ActorId,
+    ActorDisplayText: _.ActorDisplayText,
+    ActorImageURL: _.ActorImageURL,
+    TargetParameters: _.TargetParameters,
+    NotificationTypeTimestamp: _.NotificationTypeTimestamp,
+  }
+  return notification
+}
+
+function buildNotification(notificationData) {
+  let notification;
+
+  if (Object.keys(notificationData).length === 0) {
+    LOG._warn && LOG.warn(messages.EMPTY_OBJECT_FOR_NOTIFY);
+    return;
+  }
+
+  if (notificationData.type) {
+    if (!validateCustomNotifyParameters(
+      notificationData.type,
+      notificationData.recipients,
+      notificationData.properties,
+      notificationData.navigation,
+      notificationData.priority,
+      notificationData.payload)
+    ) {
+      return;
+    }
+
+    notification = buildCustomNotification(notificationData);
+  } else if (notificationData.NotificationTypeKey) {
+    notificationData.NotificationTypeKey = getNotificationTypesKeyWithPrefix(notificationData.NotificationTypeKey);
+    notification = notificationData;
+  } else {
+    if (!validateDefaultNotifyParameters(
+      notificationData.recipients,
+      notificationData.priority,
+      notificationData.title,
+      notificationData.description)
+    ) {
+      return;
+    }
+
+    notification = buildDefaultNotification(
+      notificationData.recipients,
+      notificationData.priority,
+      notificationData.title,
+      notificationData.description
+    );
+  }
+
+  return JSON.parse(JSON.stringify(notification));
+}
+
+module.exports = {
+  messages,
+  validateNotificationTypes,
+  readFile,
+  getNotificationDestination,
+  getPrefix,
+  getNotificationTypesKeyWithPrefix,
+  buildNotification
+};

package/package.json

@@ -0,0 +1,65 @@
+{
+    "name": "@neoimpulse/cap-js-notifications",
+    "version": "1.0.0",
+    "description": "A CDS plugin to provide an easy action for the notification service",
+    "main": "cds-plugin.js",
+    "scripts": {
+        "pretty": "npx prettier --write ."
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/neoimpulseGmbH/cap-js-notifications"
+    },
+    "keywords": [
+        "cds",
+        "cap",
+        "trim",
+        "plugin"
+    ],
+    "author": "Neoimpulse GmbH",
+    "license": "Apache-2.0",
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "lib",
+        "srv",
+        "cds-plugin.js",
+        "package.json",
+        "LICENSE",
+        "README.md"
+    ],
+    "dependencies": {
+        "@sap/cds": "^7",
+        "express": "^4.17.1"
+    },
+    "devDependencies": {
+        "prettier": "^3.3.3",
+        "semantic-release": "^24.2.1"
+    },
+    "cds": {
+        "requires": {
+            "destinations": true,
+            "notifications": {
+                "[development]": {
+                    "kind": "notify-to-console"
+                },
+                "[production]": {
+                    "destination": "SAP_Notifications",
+                    "kind": "notify-to-rest"
+                },
+                "prefix": "$app-name",
+                "types": "srv/notification-types.json",
+                "outbox": true
+            },
+            "kinds": {
+                "notify-to-console": {
+                    "impl": "@neoimpulse/cap-js-notifications/srv/notifyToConsole"
+                },
+                "notify-to-rest": {
+                    "impl": "@neoimpulse/cap-js-notifications/srv/notifyToRest"
+                }
+            }
+        }
+    }
+}

package/srv/notification-types.json

@@ -0,0 +1,16 @@
+[
+	{
+		"NotificationTypeKey": "ExampleMessage",
+		"NotificationTypeVersion": "1",
+		"Templates": [
+			{
+				"Language": "en",
+				"TemplateSensitive": "Example {{Example_ID}} completed.",
+				"TemplatePublic": "Rejected Example detected.",
+				"TemplateGrouped": "Example for which you are responsible have been rejected.",
+				"TemplateLanguage": "Mustache",
+				"Subtitle": "The user {{Username}} has completed the unloading process for Example {{Example_ID}}. Please review and proceed with posting."
+			}
+		]
+	}
+]

package/srv/notifyToConsole.js

@@ -0,0 +1,41 @@
+const cds = require("@sap/cds");
+const LOG = cds.log('notifications');
+const { readFile } = require("../lib/utils");
+
+module.exports = class NotifyToConsole extends cds.Service {
+  async init() {
+
+    const notificationTypes = readFile(cds.env.requires?.notifications?.types);
+    const eventsToListen = notificationTypes.map(notificationType => notificationType.NotificationTypeKey);
+    LOG._info && LOG.info(`Listening to events: ${eventsToListen.join(", ")}`);
+
+    this.on(eventsToListen, req => {
+      LOG._debug && LOG.debug('Handling notification event:', req.event)
+      const notification = req.data; if (!notification) return
+      console.log (
+        '\n---------------------------------------------------------------\n' +
+        'Notification:', req.event,
+         notification,
+        '\n---------------------------------------------------------------\n',
+      )
+
+      const { NotificationTypeKey, NotificationTypeVersion } = notification
+      const types = cds.notifications.local.types // REVISIT: what is this?
+
+      if (!(NotificationTypeKey in types)) {
+        LOG._warn && LOG.warn(
+          `Notification Type ${NotificationTypeKey} is not in the notification types file`
+        );
+        return;
+      }
+
+      if (!(NotificationTypeVersion in types[NotificationTypeKey])) {
+        LOG._warn && LOG.warn(
+          `Notification Type Version ${NotificationTypeVersion} for type ${NotificationTypeKey} is not in the notification types file`
+        );
+      }
+    })
+
+    return super.init()
+  }
+}

package/srv/notifyToRest.js

@@ -0,0 +1,45 @@
+const { buildHeadersForDestination } = require("@sap-cloud-sdk/connectivity");
+const { executeHttpRequest } = require("@sap-cloud-sdk/http-client");
+const { getNotificationDestination, readFile } = require("../lib/utils");
+const cds = require("@sap/cds");
+const LOG = cds.log('notifications');
+const NOTIFICATIONS_API_ENDPOINT = "v2/Notification.svc";
+
+
+module.exports = exports = class NotifyToRest extends cds.Service  {
+  async init() {
+    const notificationTypes = readFile(cds.env.requires?.notifications?.types);
+    const eventsToListen = notificationTypes.map(notificationType => notificationType.NotificationTypeKey);
+    LOG._info && LOG.info(`Listening to events: ${eventsToListen.join(", ")}`);
+    this.on(eventsToListen, req => this.postNotification(req.data))
+    return super.init()
+  }
+
+  async postNotification(notificationData) {
+    const notificationDestination = await getNotificationDestination();
+    const csrfHeaders = await buildHeadersForDestination(notificationDestination, {
+      url: NOTIFICATIONS_API_ENDPOINT,
+    });
+
+    try {
+      LOG._info && LOG.info(
+        `Sending notification of key: ${notificationData.NotificationTypeKey} and version: ${notificationData.NotificationTypeVersion}`
+      );
+      await executeHttpRequest(notificationDestination, {
+        url: `${NOTIFICATIONS_API_ENDPOINT}/Notifications`,
+        method: "post",
+        data: notificationData,
+        headers: csrfHeaders,
+      });
+    } catch (err) {
+      const message = err.response.data?.error?.message?.value ?? err.response.message;
+      const error = new cds.error(message);
+
+      if (/^4\d\d$/.test(err.response?.status) && err.response?.status != 429) {
+        error.unrecoverable = true;
+      }
+
+      throw error;
+    }
+  }
+}