Merge pull request #228 from Jgmdevelopers/feature/android-notification-helper

feat: add android notification helper

Author: dwightwatson

src/FcmMessage.php

@@ -12,6 +12,7 @@ class FcmMessage implements Message
 {
     use Macroable;
 
+
     /**
      * Create a new message instance.
      */
@@ -28,6 +29,7 @@ public function __construct(
         //
     }
 
+
     /**
      * Create a new message instance.
      */
@@ -36,6 +38,7 @@ public static function create(...$args): static
         return new static(...$args);
     }
 
+
     /**
      * Set the message name.
      */
@@ -46,9 +49,7 @@ public function name(?string $name): self
         return $this;
     }
 
-    /**
-     * Set the message token.
-     */
+    
     public function token(?string $token): self
     {
         $this->token = $token;
@@ -66,22 +67,17 @@ public function topic(?string $topic): self
         return $this;
     }
 
-    /**
-     * Set the message condition.
-     */
+    
     public function condition(?string $condition): self
     {
         $this->condition = $condition;
 
         return $this;
     }
 
-    /**
-     * Set the message data, or throw exception if data is not an array of strings.
-     */
     public function data(?array $data): self
     {
-        if (! empty(array_filter($data, fn ($value) => ! is_string($value)))) {
+        if (! empty(array_filter($data, fn($value) => ! is_string($value)))) {
             throw new InvalidArgumentException('Data values must be strings.');
         }
 
@@ -90,36 +86,62 @@ public function data(?array $data): self
         return $this;
     }
 
+ 
+    public function custom(?array $custom = []): self
+    {
+        $this->custom = $custom;
+
+        return $this;
+    }
+
+
     /**
-     * Set additional custom message data.
+     * Set "android" specific custom options.
      */
-    public function custom(?array $custom): self
+    public function android(array $options = []): self
     {
-        $this->custom = $custom;
+
+        $this->custom([
+            ...$this->custom,
+            'android' => $options,
+        ]);
 
         return $this;
     }
 
+
+
     /**
-     * Set the message notification.
+     * Set APNs-specific custom options for iOS.
+     * Set APNs-specific custom options for iOS.
      */
+    public function ios(array $options = []): self
+    {
+        $this->custom([
+            ...$this->custom,
+            'apns' => $options,
+            'apns' => $options,
+        ]);
+
+        return $this;
+    }
+
+   
     public function notification(Notification $notification): self
     {
         $this->notification = $notification;
 
         return $this;
     }
 
-    /**
-     * Set the message Firebase Messaging client instance.
-     */
     public function usingClient(Messaging $client): self
     {
         $this->client = $client;
 
         return $this;
     }
 
+
     public function toArray()
     {
         return array_filter([
@@ -133,6 +155,7 @@ public function toArray()
         ]);
     }
 
+
     /**
      * @return mixed
      */

tests/FcmMessageTest.php

@@ -109,4 +109,43 @@ public function test_it_can_set_client()
 
         $this->assertSame($client, $message->client);
     }
+
+    public function test_appends_android_options_into_custom()
+    {
+        $msg = FcmMessage::create()
+            ->notification(new Notification(title: 'T', body: 'B'))
+            ->android(['notification' => ['channel_id' => 'ops', 'sound' => 'default']]);
+
+        $payload = $msg->toArray();
+
+        $this->assertArrayHasKey('android', $payload);
+        $this->assertArrayHasKey('notification', $payload['android']);
+        $this->assertEquals('ops', $payload['android']['notification']['channel_id']);
+        $this->assertEquals('default', $payload['android']['notification']['sound']);
+    }
+
+    public function test_appends_ios_options_into_custom()
+    {
+        $msg = FcmMessage::create()
+            ->ios(['payload' => ['aps' => ['sound' => 'default']]]);
+
+        $payload = $msg->toArray();
+
+        $this->assertArrayHasKey('apns', $payload);
+        $this->assertArrayHasKey('payload', $payload['apns']);
+        $this->assertEquals('default', $payload['apns']['payload']['aps']['sound']);
+    }
+
+    public function test_preserves_existing_custom_keys_when_using_helpers()
+    {
+        $msg = FcmMessage::create()
+            ->custom(['meta' => ['a' => 1]])
+            ->android(['notification' => ['color' => '#000']]);
+
+        $payload = $msg->toArray();
+
+        $this->assertArrayHasKey('meta', $payload);
+        $this->assertEquals(1, $payload['meta']['a']);
+        $this->assertEquals('#000', $payload['android']['notification']['color']);
+    }
 }