feat: add password reset email templates and notification handling

Author: iamspydey

app/Enums/EmailCode.php

@@ -11,4 +11,8 @@ enum EmailCode: string
     case VERIFY_ACCOUNT = 'verify-account';
 
     case ACCOUNT_VERIFICATION_SUCCESS = 'account-verification-success';
+
+    case PASSWORD_RESET_SUCCESS = 'password-reset-success';
+
+    case PASSWORD_RESET_LINK = 'password-reset-link';
 }

app/Listeners/SendEmailVerifiedMail.php

@@ -1,14 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Listeners;
 
 use App\Enums\EmailCode;
 use App\Models\User;
 use Illuminate\Auth\Events\Verified;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\InteractsWithQueue;
 
-class SendEmailVerifiedMail
+final class SendEmailVerifiedMail
 {
     /**
      * Create the event listener.

app/Listeners/SendPasswordUpdatedMail.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Listeners;
+
+use App\Enums\EmailCode;
+use Illuminate\Auth\Events\PasswordReset;
+
+final class SendPasswordUpdatedMail
+{
+    /**
+     * Create the event listener.
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Handle the event.
+     */
+    public function handle(PasswordReset $event): void
+    {
+        /** @var \App\Models\User $user */
+        $user = $event->user;
+
+        $user->sendMail(template: EmailCode::PASSWORD_RESET_SUCCESS->value, replaceable: [
+            '{name}' => $user->name,
+            '{email}' => $user->email,
+            '{login_link}' => route('login'),
+        ]);
+    }
+}

app/Models/User.php

@@ -83,6 +83,14 @@ public function sendEmailVerificationNotification(): void
         ]);
     }
 
+    public function sendPasswordResetNotification($token): void // @pest-ignore-type
+    {
+        $this->sendMail(template: EmailCode::PASSWORD_RESET_LINK->value, replaceable: [
+            '{email}' => $this->email,
+            '{password_reset_link}' => $this->resetUrl($token),
+        ]);
+    }
+
     private function verificationUrl(): string
     {
         /** @var int|float $ttl */
@@ -98,4 +106,12 @@ private function verificationUrl(): string
             ]
         );
     }
+
+    private function resetUrl(string $token): string
+    {
+        return url(route('password.reset', [
+            'token' => $token,
+            'email' => $this->getEmailForPasswordReset(),
+        ], false));
+    }
 }

app/Support/helpers.php

@@ -1,13 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
+if (! function_exists('setting')) {
 
-if(!function_exists("setting")) {
-    
     /**
      * @param  string|int|float|array<mixed>|bool|null  $default
      * @return string|int|float|array<mixed>|bool|null
      */
-    function setting(string $option, mixed $default = null): string|int|float|array|bool|null{
-       return app(App\Support\Facades\Setting::class)::get($option, $default);
+    function setting(string $option, mixed $default = null): string|int|float|array|bool|null
+    {
+        return app(App\Support\Facades\Setting::class)::get($option, $default);
     }
-}
+}

app/Traits/MailableHelper.php

@@ -60,7 +60,7 @@ public function sendMail(EmailTemplate|string|int $template, array $replaceable)
          * @var string $mailBody
          */
         [$mailSubject, $mailBody] = $this->prepareMail($template, $replaceable);
-        
+
         $toMail = $this instanceof Authenticatable ? $this->email : $this->emails;
 
         // Send the mail to provided email

database/seeders/AppSettingSeeder.php

@@ -57,8 +57,8 @@ public function run(): void
         ]);
 
         AppSetting::query()->firstOrCreate([
-            'option' => 'mail_queue_enabled',
-            'value' => 'false',
+            'option' => 'mail_queue',
+            'value' => 'true',
         ]);
     }
 }

database/seeders/EmailTemplateSeeder.php

@@ -61,6 +61,39 @@ public function run(): void
 
 Congratulations your account verified successfully now you can login and continue.
 
+[Login Now]({login_link})',
+        ]);
+
+        /**
+         * Password reset request email
+         */
+        EmailTemplate::query()->firstOrCreate([
+            'subject' => 'Reset your pasword',
+            'purpose' => 'Sent when user request password reset from forgot password',
+            'code' => 'password-reset-link',
+            'content' => "## Password reset request received
+We have received a request for password reset for the account associated with email: **{email}**.{br}
+
+Please visit this link to reset your password: [Reset my password]({password_reset_link}){br}
+
+OR{br}
+
+[{password_reset_link}]({password_reset_link})
+
+If you didn't make the request you can ignore this email.",
+        ]);
+
+        /**
+         * Password reset success email template
+         */
+        EmailTemplate::query()->firstOrCreate([
+            'subject' => 'Your password has been reset',
+            'purpose' => 'To be sent when password resets successfully',
+            'code' => 'password-reset-success',
+            'content' => '## Password updated successfully
+
+We have updated your password as per your request. Now you can use your new password to login
+
 [Login Now]({login_link})',
         ]);
 

resources/js/pages/auth/reset-password.tsx

@@ -1,7 +1,7 @@
-import NewPasswordController from '@/actions/App/Http/Controllers/Auth/NewPasswordController';
 import { Form, Head } from '@inertiajs/react';
 import { LoaderCircle } from 'lucide-react';
 
+import UserPasswordController from '@/actions/App/Http/Controllers/Auth/UserPasswordController';
 import InputError from '@/components/input-error';
 import { Button } from '@/components/ui/button';
 import { Input } from '@/components/ui/input';
@@ -22,7 +22,7 @@ export default function ResetPassword({ token, email }: ResetPasswordProps) {
             <Head title="Reset password" />
 
             <Form
-                {...NewPasswordController.store.form()}
+                action={UserPasswordController.store()}
                 transform={(data) => ({ ...data, token, email })}
                 resetOnSuccess={['password', 'password_confirmation']}
             >