Merge pull request #2135 from rittaschool/add-fcm-data-messages

Add fcm data messages (#2007)

Author: scopsy

docs/docs/channels/push/fcm.md

@@ -23,7 +23,17 @@ novu.trigger('event-name', {
     subscriberId: '...',
   },
   payload: {
-    abc: 'def',
+    abc: 'def', // If the notification is a data notification, the payload will be sent as the data
+  },
+  overrides: {
+    fcm: {
+      type: 'notification',
+      // type: 'data' => will turn this into a FCM data notification, where the payload is sent as a data notification
+      data: {
+        key: 'value',
+        // If type is "notification", you can use the "data" override to send notification messages with optional data payload
+      },
+    },
   },
 });
 ```
@@ -38,7 +48,6 @@ import { Novu, PushProviderIdEnum } from '@novu/node';
 
 const novu = new Novu(process.env.NOVU_API_KEY);
 
-const body = req.body; // From your HTTPS listener
 await novu.subscribers.setCredentials('subscriberId', PushProviderIdEnum.FCM, {
   deviceTokens: ['token1', 'token2'],
 });

package.json

@@ -68,6 +68,7 @@
     "@commitlint/cli": "17.0.1",
     "@commitlint/config-angular": "^13.2.0",
     "@commitlint/config-conventional": "17.0.0",
+    "@cspell/eslint-plugin": "^6.14.3",
     "@nrwl/cli": "13.8.5",
     "@nrwl/eslint-plugin-nx": "13.8.5",
     "@nrwl/jest": "13.8.5",
@@ -92,9 +93,9 @@
     "cspell": "^4.2.8",
     "cypress-intellij-reporter": "^0.0.6",
     "cz-conventional-changelog": "3.3.0",
+    "deep-extend": "^0.6.0",
     "detect-port": "^1.3.0",
     "eslint": "7.32.0",
-    "@cspell/eslint-plugin": "^6.14.3",
     "eslint-config-airbnb-typescript": "16.1.4",
     "eslint-config-prettier": "^7.2.0",
     "eslint-import-resolver-webpack": "^0.13.2",

packages/node/src/lib/events/events.interface.ts

@@ -62,6 +62,7 @@ export type ITriggerOverrideDelayAction = {
 };
 
 export type ITriggerOverrideFCM = {
+  type?: 'notification' | 'data';
   tag?: string;
   body?: string;
   icon?: string;

packages/stateless/src/lib/provider/provider.interface.ts

@@ -32,6 +32,8 @@ export interface IPushOptions {
   content: string;
   payload: object;
   overrides?: {
+    type?: 'notification' | 'data';
+    data?: { [key: string]: string };
     tag?: string;
     body?: string;
     icon?: string;