chore: update appearance initialization

Author: JoeyMckenzie

.gitignore

@@ -23,3 +23,5 @@ yarn-error.log
 /.vscode
 /.zed
 resources/js/ziggy.js
+.phpstorm.meta.php
+_ide_helper.php

app/Data/UserData.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Data;
+
+use Spatie\LaravelData\Data;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
+
+#[TypeScript]
+final class UserData extends Data
+{
+    public int $id;
+
+    public string $firstName;
+
+    public string $lastName;
+
+    public string $fullName;
+
+    public string $initials;
+
+    public string $email;
+
+    public ?string $profileImage = null;
+
+    public ?string $emailVerifiedAt = null;
+
+    public string $createdAt;
+
+    public string $updatedAt;
+}

app/Http/Middleware/HandleInertiaRequests.php

@@ -4,6 +4,7 @@
 
 namespace App\Http\Middleware;
 
+use App\Data\UserData;
 use Illuminate\Foundation\Inspiring;
 use Illuminate\Http\Request;
 use Inertia\Middleware;
@@ -55,7 +56,7 @@ public function share(Request $request): array
             'name' => config('app.name'),
             'quote' => ['message' => trim($message), 'author' => trim($author)],
             'auth' => [
-                'user' => $request->user(),
+                'user' => UserData::from($request->user()),
             ],
             'ziggy' => [
                 ...(new Ziggy)->toArray(),

app/Models/User.php

@@ -4,26 +4,62 @@
 
 namespace App\Models;
 
+use Carbon\CarbonImmutable;
 use Database\Factories\UserFactory;
+use Eloquent;
 use Illuminate\Contracts\Auth\MustVerifyEmail;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Foundation\Auth\User as Authenticatable;
+use Illuminate\Notifications\DatabaseNotification;
+use Illuminate\Notifications\DatabaseNotificationCollection;
 use Illuminate\Notifications\Notifiable;
+use Illuminate\Support\Facades\Storage;
 
+/**
+ * @property int $id
+ * @property string $first_name
+ * @property string $last_name
+ * @property string|null $avatar
+ * @property string $email
+ * @property CarbonImmutable|null $email_verified_at
+ * @property string $password
+ * @property string|null $remember_token
+ * @property CarbonImmutable|null $created_at
+ * @property CarbonImmutable|null $updated_at
+ * @property-read DatabaseNotificationCollection<int, DatabaseNotification> $notifications
+ * @property-read int|null $notifications_count
+ *
+ * @method static UserFactory factory($count = null, $state = [])
+ * @method static Builder<static>|User newModelQuery()
+ * @method static Builder<static>|User newQuery()
+ * @method static Builder<static>|User query()
+ * @method static Builder<static>|User whereAvatar($value)
+ * @method static Builder<static>|User whereCreatedAt($value)
+ * @method static Builder<static>|User whereEmail($value)
+ * @method static Builder<static>|User whereEmailVerifiedAt($value)
+ * @method static Builder<static>|User whereFirstName($value)
+ * @method static Builder<static>|User whereId($value)
+ * @method static Builder<static>|User whereLastName($value)
+ * @method static Builder<static>|User wherePassword($value)
+ * @method static Builder<static>|User whereRememberToken($value)
+ * @method static Builder<static>|User whereUpdatedAt($value)
+ *
+ * @mixin Eloquent
+ */
 final class User extends Authenticatable implements MustVerifyEmail
 {
     /** @use HasFactory<UserFactory> */
     use HasFactory, Notifiable;
 
     /**
-     * The attributes that are mass assignable.
-     *
      * @var list<string>
      */
-    protected $fillable = [
-        'name',
-        'email',
-        'password',
+    protected $appends = [
+        'full_name',
+        'initials',
+        'profile_image',
     ];
 
     /**
@@ -48,4 +84,35 @@ protected function casts(): array
             'password' => 'hashed',
         ];
     }
+
+    /**
+     * @return Attribute<string, string>
+     */
+    protected function fullName(): Attribute
+    {
+        return Attribute::make(fn (): string => "$this->first_name $this->last_name");
+    }
+
+    /**
+     * @return Attribute<string, string>
+     */
+    protected function initials(): Attribute
+    {
+        $firstNameInitial = substr($this->first_name ?? '', 0, 1);
+        $lastNameInitial = substr($this->last_name ?? '', 0, 1);
+
+        return Attribute::make(fn (): string => $firstNameInitial.$lastNameInitial);
+    }
+
+    /**
+     * @return Attribute<string, string>
+     */
+    protected function profileImage(): Attribute
+    {
+        $avatar = $this->avatar !== null
+            ? Storage::url($this->avatar)
+            : null;
+
+        return Attribute::make(fn (): ?string => $avatar);
+    }
 }

app/Support/StylisticEslintFormatter.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Support;
+
+use RuntimeException;
+use Spatie\TypeScriptTransformer\Formatters\Formatter;
+
+final class StylisticEslintFormatter implements Formatter
+{
+    public function format(string $file): void
+    {
+        exec('npm run lint:fix', $output, $resultCode);
+
+        if ($resultCode !== 0) {
+            throw new RuntimeException(
+                sprintf(
+                    'Failed to format file %s. Output: %s',
+                    $file,
+                    implode("\n", $output)
+                )
+            );
+        }
+    }
+}

composer.json

@@ -13,6 +13,8 @@
         "inertiajs/inertia-laravel": "^2.0",
         "laravel/framework": "^12.0",
         "laravel/tinker": "^2.10.1",
+        "spatie/laravel-data": "^4.15",
+        "spatie/laravel-typescript-transformer": "^2.5",
         "tightenco/ziggy": "^2.4"
     },
     "require-dev": {
@@ -71,6 +73,12 @@
             "Composer\\Config::disableProcessTimeout",
             "npx concurrently -c \"#c4b5fd,#fb7185,#fdba74\" \"php artisan queue:listen --tries=1\" \"php artisan pail --timeout=0\" \"php artisan inertia:start-ssr\" --names=queue,logs,ssr"
         ],
+        "generate:ide-helpers": [
+            "php artisan ide-helper:generate",
+            "php artisan ide-helper:models -RW",
+            "php artisan ide-helper:meta",
+            "@fmt"
+        ],
         "test:unit": "vendor/bin/pest --parallel",
         "test:watch": "vendor/bin/pest --parallel --watch",
         "test:coverage": "vendor/bin/pest --coverage --parallel",
@@ -108,6 +116,11 @@
             "@refactor:test",
             "@test",
             "@typos"
+        ],
+        "transform": "php artisan typescript:transform --format",
+        "reschema": [
+            "php artisan migrate:fresh --seed",
+            "@generate:ide-helpers"
         ]
     },
     "extra": {