Add mappings to image in notification (#653)

* Add mappings to image in notification

- Add missing mappings for imageUrl to image in FCM notifications

* Update unit tests

Author: lahirumaramba

src/messaging/messaging-types.ts

@@ -392,6 +392,18 @@ function validateApnsFcmOptions(fcmOptions: ApnsFcmOptions) {
     throw new FirebaseMessagingError(
       MessagingClientErrorCode.INVALID_PAYLOAD, 'analyticsLabel must be a string value');
   }
+
+  const propertyMappings: {[key: string]: string} = {
+    imageUrl: 'image',
+  };
+  Object.keys(propertyMappings).forEach((key) => {
+    if (key in fcmOptions && propertyMappings[key] in fcmOptions) {
+      throw new FirebaseMessagingError(
+          MessagingClientErrorCode.INVALID_PAYLOAD,
+          `Multiple specifications for ${key} in ApnsFcmOptions`);
+    }
+  });
+  renameProperties(fcmOptions, propertyMappings);
 }
 
 /**
@@ -430,6 +442,18 @@ function validateNotification(notification: Notification) {
     throw new FirebaseMessagingError(
         MessagingClientErrorCode.INVALID_PAYLOAD, 'notification.imageUrl must be a valid URL string');
   }
+
+  const propertyMappings: {[key: string]: string} = {
+    imageUrl: 'image',
+  };
+  Object.keys(propertyMappings).forEach((key) => {
+    if (key in notification && propertyMappings[key] in notification) {
+      throw new FirebaseMessagingError(
+          MessagingClientErrorCode.INVALID_PAYLOAD,
+          `Multiple specifications for ${key} in Notification`);
+    }
+  });
+  renameProperties(notification, propertyMappings);
 }
 
 /**
@@ -674,6 +698,7 @@ function validateAndroidNotification(notification: AndroidNotification) {
     titleLocKey: 'title_loc_key',
     titleLocArgs: 'title_loc_args',
     channelId: 'channel_id',
+    imageUrl: 'image',
   };
   renameProperties(notification, propertyMappings);
 }

test/unit/messaging/messaging.spec.ts

@@ -2801,6 +2801,13 @@ describe('Messaging', () => {
       {
         label: 'Generic notification message',
         req: {
+          notification: {
+            title: 'test.title',
+            body: 'test.body',
+            imageUrl: 'https://example.com/image.png',
+          },
+        },
+        expectedReq: {
           notification: {
             title: 'test.title',
             body: 'test.body',
@@ -2830,6 +2837,19 @@ describe('Messaging', () => {
       {
         label: 'Android notification message',
         req: {
+          android: {
+            notification: {
+              title: 'test.title',
+              body: 'test.body',
+              icon: 'test.icon',
+              color: '#112233',
+              sound: 'test.sound',
+              tag: 'test.tag',
+              imageUrl: 'https://example.com/image.png',
+            },
+          },
+        },
+        expectedReq: {
           android: {
             notification: {
               title: 'test.title',
@@ -2912,7 +2932,7 @@ describe('Messaging', () => {
               color: '#112233',
               sound: 'test.sound',
               tag: 'test.tag',
-              image: 'https://example.com/image.png',
+              imageUrl: 'https://example.com/image.png',
               clickAction: 'test.click.action',
               titleLocKey: 'title.loc.key',
               titleLocArgs: ['arg1', 'arg2'],
@@ -3076,7 +3096,7 @@ describe('Messaging', () => {
             },
             fcmOptions: {
               analyticsLabel: 'test.analytics',
-              image: 'https://example.com/image.png',
+              imageUrl: 'https://example.com/image.png',
             },
           },
         },