fix some small issues

Author: ipaunov

README.md

@@ -46,6 +46,9 @@ alert.notify({
 });
 ```
 
+* **priority** - Priority of the notification, this argument is optional, it defaults to NEUTRAL
+* **description** - Subtitle for the notification, this argument is optional
+
 ## Use Notification Types
 
 ### 1. Add notification types
@@ -102,7 +105,7 @@ In local environment, when you publish notification, it is mocked to publish the
 
 #### Notification Destination
 
-As a pre-requisite to publish the notification, you need to have a [destination](https://help.sap.com/docs/build-work-zone-standard-edition/sap-build-work-zone-standard-edition/enabling-notifications-for-custom-apps-on-sap-btp-cloud-foundry#configure-the-destination-to-the-notifications-service) configured to publish the notification. In the `package.json` by default destination name `SAP_Notification` is added, you can modify the destination name that you are configuring.
+As a pre-requisite to publish the notification, you need to have a [destination](https://help.sap.com/docs/build-work-zone-standard-edition/sap-build-work-zone-standard-edition/enabling-notifications-for-custom-apps-on-sap-btp-cloud-foundry#configure-the-destination-to-the-notifications-service) configured to publish the notification. In the `package.json` by default destination name `SAP_Notifications` is added, you can modify the destination name that you are configuring.
 
 #### Integrate with SAP Build Work Zone
 
@@ -128,12 +131,12 @@ You can use these two signature to send the custom notification with pre-defined
 
 #### With pre-defined parameters
 
-By using this approach you can post a notification by providing different parts of the notification object grouped in related units 
+By using this approach you can send notifications with the predefined parameters - recipients, data, priority, type and other parameters listed in the [API documentation](https://help.sap.com/docs/build-work-zone-standard-edition/sap-build-work-zone-standard-edition/developing-cloud-foundry-applications-with-notifications) 
 
 ```js
 alert.notify({
   recipients: [...supporters()],
-  type: "IncidentResolved"
+  type: "IncidentResolved",
   priority: 'NEUTRAL',
   data: {
     customer: customer.info,

test/lib/content-deployment.test.js

@@ -26,9 +26,6 @@ describe("contentDeployment", () => {
 
     console.log(setGlobalLogLevel.mock.calls);
     assert.expect(setGlobalLogLevel.mock.calls[0][0]).to.be.equal("error");
-    // NOTE: disabling this test, as it fails after we added default configuration in
-    // And I think it is not necessary to test this, maybe even wrong
-    // assert.expect(readFile.mock.calls[0][0]).to.be.equal('');
     assert.expect(validateNotificationTypes.mock.calls[0][0]).to.be.deep.equal([]);
     assert.expect(processNotificationTypes.mock.calls[0][0]).to.be.deep.equal([]);
   });
@@ -43,8 +40,6 @@ describe("contentDeployment", () => {
 
     console.log(setGlobalLogLevel.mock.calls);
     assert.expect(setGlobalLogLevel.mock.calls[0][0]).to.be.equal("error");
-    // As above:
-    // assert.expect(readFile.mock.calls[0][0]).to.be.equal('');
     assert.expect(validateNotificationTypes.mock.calls[0][0]).to.be.deep.equal([]);
     assert.expect(processNotificationTypes.mock.calls[0]).to.be.deep.equal(undefined);
   });

test/lib/utils.test.js

@@ -539,18 +539,6 @@ describe("Test utils", () => {
     ).toBeFalsy();
   });
 
-  // .payload not used anymore
-  // test("When invalid payload for custom notification is passed to buildNotification", () => {
-  //   expect(
-  //     buildNotification({
-  //       recipients: ["[email protected]"],
-  //       type: "TestNotificationType",
-  //       priority: "NEUTRAL",
-  //       payload: "invalid"
-  //     })
-  //   ).toBeFalsy();
-  // });
-
   test("Given invalid NTypes | When validateNotificationTypes is called | Then false is returned", () => {
     expect(validateNotificationTypes([{ NotificationTypeKey: "Test" }, { blabla: "Test2" }])).toEqual(false);
   });

test/srv/notifyToRest.test.js

@@ -1,8 +1,6 @@
 const { messages, buildNotification } = require("../../lib/utils");
 const NotifyToRest = require("../../srv/notifyToRest");
 
-// jest.mock("../../srv/notifyToRest");
-
 describe("notify to rest", () => {
   it("when no object is passed", async () => {
     const notifyToRest = new NotifyToRest();