chore: magic link arg classes now properly take all required params (#92

)
passageidentity · Dec 11, 2024 · c72d387 · c72d387
1 parent 7afac85
commit c72d387
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 26 deletions.
diff --git a/custom/lib/Auth.php b/custom/lib/Auth.php
@@ -19,6 +19,7 @@
 class Auth
 {
     private CachedKeySet $jwks;
+    private readonly MagicLinksApi $magicLinksApi;
 
     /**
      * Auth class that provides methods for validating JWTs and creating Magic Links.
@@ -40,6 +41,8 @@ public function __construct(private string $appId, private Configuration $config
             60 * 60 * 24, // expires in 24 hours
             true
         );
+
+        $this->magicLinksApi = new MagicLinksApi(null, $this->config);
     }
 
     /**
@@ -84,36 +87,31 @@ public function validateJwt(string $jwt): string
      */
     public function createMagicLink(
         MagicLinkWithEmailArgs|MagicLinkWithPhoneArgs|MagicLinkWithUserArgs $args,
-        MagicLinkOptions|null $options,
+        MagicLinkOptions|null $options = null,
     ): MagicLink {
-        $identifier = null;
-        $channel = null;
+        $payloadData = [
+            'type' => $args->type,
+            'send' => $args->send,
+        ];
 
         switch ($args) {
             case $args instanceof MagicLinkWithEmailArgs:
-                $identifier = $args->email;
-                $channel = MagicLinkChannel::EMAIL;
+                $payloadData['email'] = $args->email;
+                $payloadData['channel'] = MagicLinkChannel::EMAIL;
                 break;
             case $args instanceof MagicLinkWithPhoneArgs:
-                $identifier = $args->phone;
-                $channel = MagicLinkChannel::PHONE;
+                $payloadData['phone'] = $args->phone;
+                $payloadData['channel'] = MagicLinkChannel::PHONE;
                 break;
             case $args instanceof MagicLinkWithUserArgs:
-                $identifier = $args->userId;
-                $channel = $args->channel;
+                $payloadData['user_id'] = $args->userId;
+                $payloadData['channel'] = $args->channel;
                 break;
             default:
                 throw new InvalidArgumentException("args must contain an email, phone, or userId");
         }
 
-        $payload = new CreateMagicLinkRequest(
-            [
-                'identifier' => $identifier,
-                'channel' => $channel,
-                'type' => $args->type,
-                'send' => $args->send,
-            ]
-        );
+        $payload = new CreateMagicLinkRequest($payloadData);
 
         if ($options) {
             if ($options->language) {
@@ -130,10 +128,8 @@ public function createMagicLink(
             }
         }
 
-        $magicLinksApi = new MagicLinksApi(null, $this->config);
-
         try {
-            return $magicLinksApi->createMagicLink($this->appId, $payload)->getMagicLink();
+            return $this->magicLinksApi->createMagicLink($this->appId, $payload)->getMagicLink();
         } catch (ApiException $e) {
             throw PassageError::fromApiException($e);
         }

diff --git a/custom/lib/MagicLinkArgsBase.php b/custom/lib/MagicLinkArgsBase.php
@@ -2,12 +2,10 @@
 
 namespace Passage\Client;
 
-use OpenAPI\Client\Model\MagicLinkType;
-
 readonly class MagicLinkArgsBase
 {
     public function __construct(
-        public readonly MagicLinkType $type,
+        public readonly string $type,
         public readonly bool $send,
     ) {
     }

diff --git a/custom/lib/MagicLinkWithEmailArgs.php b/custom/lib/MagicLinkWithEmailArgs.php
@@ -4,8 +4,17 @@
 
 final readonly class MagicLinkWithEmailArgs extends MagicLinkArgsBase
 {
+    /**
+     * @param string $email The email to send the magic link to
+     * @param string $type The type of magic link to send, should be OpenAPI\Client\Model\MagicLinkType
+     * @param bool $send Whether to send the magic link
+     * @see OpenAPI\Client\Model\MagicLinkType
+     */
     public function __construct(
         public readonly string $email,
+        string $type,
+        bool $send,
     ) {
+        parent::__construct($type, $send);
     }
 }
diff --git a/custom/lib/MagicLinkWithPhoneArgs.php b/custom/lib/MagicLinkWithPhoneArgs.php
@@ -4,8 +4,17 @@
 
 final readonly class MagicLinkWithPhoneArgs extends MagicLinkArgsBase
 {
+    /**
+     * @param string $phone The phone number to send the magic link to
+     * @param string $type The type of magic link to send, should be OpenAPI\Client\Model\MagicLinkType
+     * @param bool $send Whether to send the magic link
+     * @see OpenAPI\Client\Model\MagicLinkType
+     */
     public function __construct(
         public readonly string $phone,
+        string $type,
+        bool $send,
     ) {
+        parent::__construct($type, $send);
     }
 }
diff --git a/custom/lib/MagicLinkWithUserArgs.php b/custom/lib/MagicLinkWithUserArgs.php
@@ -2,13 +2,22 @@
 
 namespace Passage\Client;
 
-use OpenAPI\Client\Model\MagicLinkChannel;
-
 final readonly class MagicLinkWithUserArgs extends MagicLinkArgsBase
 {
+    /**
+     * @param string $userId The Passage user ID
+     * @param string $channel The channel to send the magic link to, should be OpenAPI\Client\Model\MagicLinkChannel
+     * @param string $type The type of magic link to send, should be OpenAPI\Client\Model\MagicLinkType
+     * @param bool $send Whether to send the magic link
+     * @see OpenAPI\Client\Model\MagicLinkChannel
+     * @see OpenAPI\Client\Model\MagicLinkType
+     */
     public function __construct(
         public readonly string $userId,
-        public readonly MagicLinkChannel $channel,
+        public readonly string $channel,
+        string $type,
+        bool $send,
     ) {
+        parent::__construct($type, $send);
     }
 }
diff --git a/custom/test/AuthTest.php b/custom/test/AuthTest.php
@@ -3,6 +3,10 @@
 namespace Passage\Test;
 
 use Dotenv\Dotenv;
+use OpenAPI\Client\Model\MagicLinkType;
+use Passage\Client\MagicLinkWithEmailArgs;
+use Passage\Client\MagicLinkWithPhoneArgs;
+use Passage\Client\MagicLinkWithUserArgs;
 use UnexpectedValueException;
 use PHPUnit\Framework\TestCase;
 use Passage\Client\Passage;