fix: pass dialyzer checks

codedge-llc · Jul 5, 2021 · c26d19b · c26d19b
1 parent 5638e19
commit c26d19b
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 10 deletions.
diff --git a/lib/pigeon.ex b/lib/pigeon.ex
@@ -89,9 +89,9 @@ defmodule Pigeon do
     Application.get_env(:pigeon, :json_library, Jason)
   end
 
-  @spec push(pid | atom, notification :: struct, push_opts) ::
+  @spec push(pid | atom, notification :: notification, push_opts) ::
           notification :: struct | no_return
-  @spec push(pid | atom, notifications :: [struct, ...], push_opts) ::
+  @spec push(pid | atom, notifications :: [notification, ...], push_opts) ::
           notifications :: [struct, ...] | no_return
   def push(pid, notifications, opts \\ [])
 

diff --git a/lib/pigeon/adm/notification.ex b/lib/pigeon/adm/notification.ex
@@ -30,6 +30,7 @@ defmodule Pigeon.ADM.Notification do
       }
   """
   @type t :: %__MODULE__{
+          __meta__: Pigeon.Metadata.t(),
           consolidation_key: String.t(),
           expires_after: integer,
           md5: binary,

diff --git a/lib/pigeon/apns/notification.ex b/lib/pigeon/apns/notification.ex
@@ -7,10 +7,10 @@ defmodule Pigeon.APNS.Notification do
             collapse_id: nil,
             device_token: nil,
             expiration: nil,
-            priority: nil,
-            push_type: "alert",
             id: nil,
             payload: %{"aps" => %{}},
+            priority: nil,
+            push_type: "alert",
             topic: nil,
             response: nil
 
@@ -20,25 +20,27 @@ defmodule Pigeon.APNS.Notification do
   ## Examples
 
       %Pigeon.APNS.Notification{
+          __meta__: %Pigeon.Metadata{on_response: nil},
           collapse_id: nil,
           device_token: "device token",
           expiration: nil,
-          priority: nil,
-          push_type: "alert",
           id: nil, # Set on push response if nil
           payload: %{"aps" => %{"alert" => "push message"}},
+          priority: nil,
+          push_type: "alert",
           response: nil, # Set on push response
           topic: "com.example.YourApp"
       }
   """
   @type t :: %__MODULE__{
+          __meta__: Pigeon.Metadata.t(),
           collapse_id: String.t() | nil,
           device_token: String.t() | nil,
           expiration: non_neg_integer | nil,
-          priority: non_neg_integer | nil,
-          push_type: String.t() | nil,
           id: String.t() | nil,
           payload: %{String.t() => term},
+          priority: non_neg_integer | nil,
+          push_type: String.t() | nil,
           response: response,
           topic: String.t() | nil
         }
@@ -96,6 +98,7 @@ defmodule Pigeon.APNS.Notification do
 
       iex> Pigeon.APNS.Notification.new("push message", "device token")
       %Pigeon.APNS.Notification{
+        __meta__: %Pigeon.Metadata{},
         device_token: "device token",
         expiration: nil,
         priority: nil,

diff --git a/lib/pigeon/fcm/notification.ex b/lib/pigeon/fcm/notification.ex
@@ -17,6 +17,7 @@ defmodule Pigeon.FCM.Notification do
             webpush: nil
 
   @type t :: %__MODULE__{
+          __meta__: Pigeon.Metadata.t(),
           android: map | nil,
           apns: map | nil,
           data: map | nil,

diff --git a/lib/pigeon/legacy_fcm/notification.ex b/lib/pigeon/legacy_fcm/notification.ex
@@ -21,6 +21,7 @@ defmodule Pigeon.LegacyFCM.Notification do
   alias Pigeon.LegacyFCM.Notification
 
   @type t :: %__MODULE__{
+          __meta__: Pigeon.Metadata.t(),
           collapse_key: nil | String.t(),
           condition: nil | String.t(),
           content_available: boolean,

diff --git a/lib/pigeon/metadata.ex b/lib/pigeon/metadata.ex
@@ -1,8 +1,10 @@
 defmodule Pigeon.Metadata do
-  @moduledoc false
+  @moduledoc """
+  Internal push notification metadata.
+  """
 
   @type t :: %__MODULE__{
-          on_response: Pigeon.on_response()
+          on_response: Pigeon.on_response() | nil
         }
 
   defstruct on_response: nil