Enable setting a live activity token in an Apns config

Author: jeromegamez

CHANGELOG.md

@@ -12,6 +12,8 @@ Please read about the future of the Firebase Admin PHP SDK on the
 * You can now save on method call by passing a custom Firestore database name to
   `Kreait\Firebase\Factory::createFirestore($databaseName)` instead of having to chain
   ``::withFirestoreDatabase($databaseName)->createFirestore()``
+* It is now possible to set [live activity tokens](https://firebase.google.com/docs/cloud-messaging/ios/live-activity)
+  in Apns configs.
 
 ### Deprecated
 

src/Firebase/Messaging/ApnsConfig.php

@@ -21,7 +21,8 @@
  *     fcm_options?: array{
  *         analytics_label?: string,
  *         image?: string
- *     }
+ *     },
+ *     live_activity_token?: non-empty-string
  * }
  */
 final class ApnsConfig implements JsonSerializable
@@ -34,17 +35,19 @@ final class ApnsConfig implements JsonSerializable
      * @param array<non-empty-string, non-empty-string> $headers
      * @param array<non-empty-string, mixed> $payload
      * @param array<non-empty-string, string> $fcmOptions
+     * @param non-empty-string|null $liveActivityToken
      */
     private function __construct(
         private readonly array $headers,
         private readonly array $payload,
         private readonly array $fcmOptions,
+        private readonly ?string $liveActivityToken,
     ) {
     }
 
     public static function new(): self
     {
-        return new self([], [], []);
+        return new self([], [], [], null);
     }
 
     /**
@@ -55,8 +58,9 @@ public static function fromArray(array $data): self
         $headers = $data['headers'] ?? [];
         $payload = $data['payload'] ?? [];
         $fcmOptions = $data['fcm_options'] ?? [];
+        $liveActivityToken = $data['live_activity_token'] ?? null;
 
-        return new self($headers, $payload, $fcmOptions);
+        return new self($headers, $payload, $fcmOptions, $liveActivityToken);
     }
 
     /**
@@ -72,6 +76,7 @@ public function withHeader(string $name, string $value): self
             headers: $headers,
             payload: $this->payload,
             fcmOptions: $this->fcmOptions,
+            liveActivityToken: $this->liveActivityToken,
         );
     }
 
@@ -93,6 +98,7 @@ public function withApsField(string $key, mixed $value): self
             headers: $this->headers,
             payload: $payload,
             fcmOptions: $this->fcmOptions,
+            liveActivityToken: $this->liveActivityToken,
         );
     }
 
@@ -112,6 +118,7 @@ public function withDataField(string $name, mixed $value): self
             headers: $this->headers,
             payload: $payload,
             fcmOptions: $this->fcmOptions,
+            liveActivityToken: $this->liveActivityToken,
         );
     }
 
@@ -155,6 +162,20 @@ public function withPriority(string $priority): self
         return $this->withHeader('apns-priority', $priority);
     }
 
+    /**
+     * @see https://firebase.google.com/docs/cloud-messaging/ios/live-activity
+     * @param non-empty-string $liveActivityToken
+    */
+    public function withLiveActivityToken(string $liveActivityToken): self
+    {
+        return new self(
+            headers: $this->headers,
+            payload: $this->payload,
+            fcmOptions: $this->fcmOptions,
+            liveActivityToken: $liveActivityToken,
+        );
+    }
+
     /**
      * A subtitle of the notification, supported by iOS 9+, silently ignored for others.
      */
@@ -194,6 +215,7 @@ public function toArray(): array
             'headers' => array_filter($this->headers, $filter),
             'payload' => array_filter($this->payload, $filter),
             'fcm_options' => array_filter($this->fcmOptions, $filter),
+            'live_activity_token' => $this->liveActivityToken,
         ], $filter);
     }
 

tests/Unit/Messaging/ApnsConfigTest.php

@@ -89,6 +89,17 @@ public function itCanHaveAPowerConservingPriority(): void
         $this->assertSame('5', $payload['headers']['apns-priority']);
     }
 
+    #[Test]
+    public function itCanBeGivenALiveActivityToken(): void
+    {
+        $config = ApnsConfig::fromArray(['live_activity_token' => 'token']);
+
+        $payload = Json::decode(Json::encode($config), true);
+
+        $this->assertArrayHasKey('live_activity_token', $payload);
+        $this->assertSame('token', $payload['live_activity_token']);
+    }
+
     #[Test]
     public function itHasASubtitle(): void
     {
@@ -123,6 +134,7 @@ public static function validDataProvider(): Iterator
                     'sound' => 'default',
                 ],
             ],
+            'live_activity_token' => 'token',
         ]];
     }
 }