@neoimpulse/cap-js-notifications 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,62 @@
+# CAP JS Notifications
+
+## Overview
+
+CAP JS Notifications is a CDS plugin designed to provide an easy action for the notification service. It supports sending notifications to different destinations based on the environment configuration.
+
+## Features
+
+- Send notifications to REST endpoints or console based on the environment.
+- Validate and process notification types.
+- Deploy notification types to the notification service.
+- Customizable notification templates.
+
+## Installation
+
+To install the dependencies, run:
+
+```bash
+npm install
+```
+
+## Usage
+
+### Configuration
+
+The plugin configuration is defined in the `package.json` file under the `cds.requires.notifications` section. It includes settings for different environments, notification types, and destinations.
+
+### Notification Types
+
+Notification types are defined in the `srv/notification-types.json` file. Each notification type includes templates for different languages and versions.
+
+### Running the Plugin
+
+To run the plugin, use the following command:
+
+```bash
+cds run
+```
+
+### Building the Project
+
+To build the project, use the following command:
+
+```bash
+cds build
+```
+
+### Releasing the Project
+
+The release process is automated using GitHub Actions. The configuration is defined in the `.github/workflows/release.yml` file.
+
+## License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](./LICENSE) file for more details.
+
+## Contributing
+
+Contributions are welcome! Please read the [CONTRIBUTING](./CONTRIBUTING.md) guidelines before submitting a pull request.
+
+## Contact
+
+For any questions or issues, please contact the author at Neoimpulse GmbH.

package/cds-plugin.js

@@ -1,4 +1,4 @@
-const cds = require("@sap/cds/lib");
+const cds = require("@sap/cds");
 
 if (cds.cli.command === "build") {
   // register build plugin

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@neoimpulse/cap-js-notifications",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "A CDS plugin to provide an easy action for the notification service",
     "main": "cds-plugin.js",
     "scripts": {
@@ -13,7 +13,7 @@
     "keywords": [
         "cds",
         "cap",
-        "trim",
+        "notifications",
         "plugin"
     ],
     "author": "Neoimpulse GmbH",
@@ -30,10 +30,13 @@
         "README.md"
     ],
     "dependencies": {
-        "@sap/cds": "^7",
-        "express": "^4.17.1"
+        "@sap-cloud-sdk/connectivity": "^3.13.0",
+        "@sap-cloud-sdk/http-client": "^3.13.0",
+        "@sap-cloud-sdk/util": "^3.13.0"
     },
     "devDependencies": {
+        "@sap/cds": ">=7.3",
+        "@sap/cds-dk": ">=7.3",
         "prettier": "^3.3.3",
         "semantic-release": "^24.2.1"
     },
@@ -49,8 +52,7 @@
                     "kind": "notify-to-rest"
                 },
                 "prefix": "$app-name",
-                "types": "srv/notification-types.json",
-                "outbox": true
+                "types": "srv/notification-types.json"
             },
             "kinds": {
                 "notify-to-console": {

package/srv/notifyToConsole.js

@@ -1,6 +1,6 @@
 const cds = require("@sap/cds");
 const LOG = cds.log('notifications');
-const { readFile } = require("../lib/utils");
+const { readFile, buildNotification } = require("../lib/utils");
 
 module.exports = class NotifyToConsole extends cds.Service {
   async init() {
@@ -15,7 +15,7 @@ module.exports = class NotifyToConsole extends cds.Service {
       console.log (
         '\n---------------------------------------------------------------\n' +
         'Notification:', req.event,
-         notification,
+        buildNotification(notification),
         '\n---------------------------------------------------------------\n',
       )
 

package/srv/notifyToRest.js

@@ -1,6 +1,6 @@
 const { buildHeadersForDestination } = require("@sap-cloud-sdk/connectivity");
 const { executeHttpRequest } = require("@sap-cloud-sdk/http-client");
-const { getNotificationDestination, readFile } = require("../lib/utils");
+const { getNotificationDestination, readFile, buildNotification } = require("../lib/utils");
 const cds = require("@sap/cds");
 const LOG = cds.log('notifications');
 const NOTIFICATIONS_API_ENDPOINT = "v2/Notification.svc";
@@ -28,7 +28,7 @@ module.exports = exports = class NotifyToRest extends cds.Service  {
       await executeHttpRequest(notificationDestination, {
         url: `${NOTIFICATIONS_API_ENDPOINT}/Notifications`,
         method: "post",
-        data: notificationData,
+        data: buildNotification(notificationData),
         headers: csrfHeaders,
       });
     } catch (err) {