feat(fcm): Rename apns.live_activity_token to lowerCamelCase

Author: janodetzel

etc/firebase-admin.messaging.api.md

@@ -61,7 +61,7 @@ export interface ApnsConfig {
     headers?: {
         [key: string]: string;
     };
-    live_activity_token?: string;
+    liveActivityToken?: string;
     payload?: ApnsPayload;
 }
 

src/messaging/messaging-api.ts

@@ -242,9 +242,9 @@ export interface WebpushNotification {
  */
 export interface ApnsConfig {
   /**
-   * APN `live_activity_push_to_start_token` or `live_activity_push_token` to start or update live activities.
+   * APN `pushToStartToken` or `pushToken` to start or update live activities.
    */
-  live_activity_token?: string;
+  liveActivityToken?: string;
   /**
    * A collection of APNs headers. Header values must be strings.
    */

src/messaging/messaging-internal.ts

@@ -123,24 +123,30 @@ function validateApnsConfig(config: ApnsConfig | undefined): void {
     throw new FirebaseMessagingError(
       MessagingClientErrorCode.INVALID_PAYLOAD, 'apns must be a non-null object');
   }
-  validateApnsLiveActivityToken(config.live_activity_token);
+  validateApnsLiveActivityToken(config.liveActivityToken);
   validateStringMap(config.headers, 'apns.headers');
   validateApnsPayload(config.payload);
   validateApnsFcmOptions(config.fcmOptions);
+
+  const propertyMappings = {
+    liveActivityToken: 'live_activity_token'
+  }
+
+  renameProperties(config, propertyMappings)
 }
 
-function validateApnsLiveActivityToken(liveActivityToken: ApnsConfig['live_activity_token']): void {
+function validateApnsLiveActivityToken(liveActivityToken: ApnsConfig['liveActivityToken']): void {
   if (typeof liveActivityToken === 'undefined') {
     return;
   } else if (!validator.isString(liveActivityToken)) {
     throw new FirebaseMessagingError(
       MessagingClientErrorCode.INVALID_PAYLOAD,
-      'apns.live_activity_token must be a string value',
+      'apns.liveActivityToken must be a string value',
     );
   } else if (!validator.isNonEmptyString(liveActivityToken)) {
     throw new FirebaseMessagingError(
       MessagingClientErrorCode.INVALID_PAYLOAD,
-      'apns.live_activity_token must be a non-empty string',
+      'apns.liveActivityToken must be a non-empty string',
     );
   }
 }

test/unit/messaging/messaging.spec.ts

@@ -1729,15 +1729,15 @@ describe('Messaging', () => {
     invalidApnsLiveActivityTokens.forEach((arg) => {
       it(`should throw given invalid apns live activity token: ${JSON.stringify(arg)}`, () => {
         expect(() => {
-          messaging.send({ apns: { live_activity_token: arg }, topic: 'test' });
-        }).to.throw('apns.live_activity_token must be a string value');
+          messaging.send({ apns: { liveActivityToken: arg }, topic: 'test' });
+        }).to.throw('apns.liveActivityToken must be a string value');
       });
     })
 
     it('should throw given empty apns live activity token', () => {
       expect(() => {
-        messaging.send({ apns: { live_activity_token: '' }, topic: 'test' });
-      }).to.throw('apns.live_activity_token must be a non-empty string');
+        messaging.send({ apns: { liveActivityToken: '' }, topic: 'test' });
+      }).to.throw('apns.liveActivityToken must be a non-empty string');
     });
 
     const invalidApnsPayloads: any[] = [null, '', 'payload', true, 1.23];
@@ -2407,7 +2407,7 @@ describe('Messaging', () => {
         label: 'APNS Start LiveActivity',
         req: {
           apns: {
-            live_activity_token: 'live-activity-token',
+            liveActivityToken: 'live-activity-token',
             headers:{
               'apns-priority': '10'
             },
@@ -2432,7 +2432,7 @@ describe('Messaging', () => {
         },
         expectedReq: {
           apns: {
-            live_activity_token: 'live-activity-token',
+            liveActivityToken: 'live-activity-token',
             headers:{
               'apns-priority': '10'
             },
@@ -2460,7 +2460,7 @@ describe('Messaging', () => {
         label: 'APNS Update LiveActivity',
         req: {
           apns: {
-            live_activity_token: 'live-activity-token',
+            liveActivityToken: 'live-activity-token',
             headers:{
               'apns-priority': '10'
             },
@@ -2482,7 +2482,7 @@ describe('Messaging', () => {
         },
         expectedReq: {
           apns: {
-            live_activity_token: 'live-activity-token',
+            liveActivityToken: 'live-activity-token',
             headers:{
               'apns-priority': '10'
             },
@@ -2507,7 +2507,7 @@ describe('Messaging', () => {
         label: 'APNS End LiveActivity',
         req: {
           apns: {
-            live_activity_token: 'live-activity-token',
+            liveActivityToken: 'live-activity-token',
             'headers':{
               'apns-priority': '10'
             },
@@ -2530,7 +2530,7 @@ describe('Messaging', () => {
         },
         expectedReq: {
           apns: {
-            live_activity_token: 'live-activity-token',
+            liveActivityToken: 'live-activity-token',
             'headers':{
               'apns-priority': '10'
             },