Laravel Jetstream

https://github.com/laravel/jetstream
Admin
Laravel Jetstream is a scaffolding package that provides Tailwind-based authentication starter kits...
Tokens:55,946
Snippets:432
Trust Score:9.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Jetstream install command handle() method

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/InstallCommand.md

Signature of the main entry point for the Jetstream install command. It returns int|null and orchestrates the installation steps.

```php
public function handle()
```

--------------------------------

### jetstream:install

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/InstallCommand.md

Documentation for the jetstream:install artisan command, including its arguments, options, and behavior.

```APIDOC
## jetstream:install

### Description
Scaffolds the chosen stack (Inertia or Livewire) into a Laravel application: publishes config/migrations, installs npm/composer packages, copies models/actions/views/pages/tests, configures sessions and optional features.

### Method
artisan command

### Command
jetstream:install {stack} [options]

### Arguments
- **stack** (string) - Required - The development stack that should be installed (inertia,livewire). Invalid values return exit code 1 with the error "Invalid stack. Supported stacks are [inertia] and [livewire]."

### Options
- **--dark** (flag) - Optional - Install dark-mode classes.
- **--teams** (flag) - Optional - Install team support (publishes team migrations, team stubs, Features::teams(['invitations' => true])).
- **--api** (flag) - Optional - Enable Features::api() in config/jetstream.php (and runs install:api).
- **--verification** (flag) - Optional - Enable Fortify email verification (Features::emailVerification()).
- **--pest** (flag) - Optional - Install Pest + feature test stubs.
- **--ssr** (flag) - Optional - (Inertia only) Install Inertia SSR (@vue/server-renderer, ssr.js, SSR vite build).
- **--composer** (option) - Optional - Path to Composer binary used for require/remove sub-processes. Default: global.

### Exit Codes
- **1** - Invalid stack value.
```

--------------------------------

### Jetstream Install Commands

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/InstallCommand.md

Basic installation commands for Jetstream with different options: Inertia with teams, Livewire with Pest and API, and Inertia with SSR and custom composer binary.

```bash
php artisan jetstream:install inertia --teams
```

```bash
php artisan jetstream:install livewire --pest --api
```

```bash
php artisan jetstream:install inertia --ssr --composer=/usr/local/bin/composer
```

--------------------------------

### Basic sending of TeamInvitation

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Mail-TeamInvitation.md

Basic usage example showing how to create an invitation and send the mailable synchronously using Mail::send().

```php
use Illuminate\Support\Facades\Mail;
use Laravel\Jetstream\Mail\TeamInvitation;
use Laravel\Jetstream\TeamInvitation as TeamInvitationModel;

$invitation = TeamInvitationModel::create([
    'team_id' => $team->id,
    'email' => 'newmember@example.com',
    'role' => 'editor',
]);

Mail::to($invitation->email)->send(new TeamInvitation($invitation));
```

--------------------------------

### UpdateTeamMemberRole usage example

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Actions.md

Example of how to instantiate and call the update method, including exception handling for validation and authorization.

```php
use Laravel\\\Jetstream\\\Actions\\\UpdateTeamMemberRole;

$updater = new UpdateTeamMemberRole;

try {
    $updater->update($user, $team, $userId, 'editor');
} catch (\\\Illuminate\\\Validation\\\ValidationException $e) {
    // "The role must be a valid role."
} catch (\\\Illuminate\\\Auth\\\Access\\\AuthorizationException $e) {
    // Not authorized to update team members.
}
```

--------------------------------

### Basic Agent usage

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Agent.md

Basic usage example showing how to instantiate Agent, set a user agent, and call platform(), browser(), and isDesktop(). The comments indicate expected return values.

```php
use Laravel\Jetstream\Agent;

$agent = new Agent();
$agent->setUserAgent($userAgentString);   // inherited from MobileDetect

$agent->platform();   // "Mac OS X", "Windows", "Linux", ...
$agent->browser();    // "Chrome", "Firefox", "Safari", ...
$agent->isDesktop();  // true / false
```

--------------------------------

### Declaring permissions and roles

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Jetstream.md

Example of declaring permissions and roles in JetstreamServiceProvider::boot(). Shows how to set permissions, default API token permissions, define a role with a description, find a role, and validate permissions.

```php
use Laravel\Jetstream\Jetstream;

// In App\Providers\JetstreamServiceProvider::boot()
Jetstream::permissions(['create', 'read', 'update', 'delete']);
Jetstream::defaultApiTokenPermissions(['read']);

Jetstream::role('admin', 'Administrator', [
    'create', 'read', 'update', 'delete',
])->description('Administrator users can perform any action.');

$role = Jetstream::findRole('admin');       // \Laravel\Jetstream\Role|null
$valid = Jetstream::validPermissions(['read', 'bogus']); // ['read']
```

--------------------------------

### Configuration with options in config/jetstream.php

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Features.md

Example configuration file for Jetstream, enabling features like terms and privacy policy, profile photos, API, teams with invitations option, and account deletion.

```php
// config/jetstream.php
use Laravel\Jetstream\Features;

return [
    'stack' => 'inertia',
    'middleware' => ['web'],
    'features' => [
        Features::termsAndPrivacyPolicy(),
        Features::profilePhotos(),
        Features::api(),
        Features::teams(['invitations' => true]),
        Features::accountDeletion(),
    ],
    'profile_photo_disk' => 'public',
];
```

--------------------------------

### Override current-team.update redirect with config/fortify.php

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Http-Controllers-Livewire.md

Customization example for overriding the redirect target of the current-team.update route by setting the 'home' configuration value in config/fortify.php.

```php
// config/fortify.php
'home' => '/dashboard',
```

--------------------------------

### Queue TeamInvitation on emails queue

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Mail-TeamInvitation.md

Advanced usage example that queues the mailable on the 'emails' queue using the Queueable trait's onQueue method.

```php
Mail::to($invitation->email)
    ->queue(new TeamInvitation($invitation)->onQueue('emails'));
```

--------------------------------

### jetstream:install command signature

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/InstallCommand.md

Shows the full command signature with the required stack argument and all available options. The stack argument accepts 'inertia' or 'livewire'; invalid values return exit code 1 with the error "Invalid stack. Supported stacks are [inertia] and [livewire]."

```text
jetstream:install {stack : The development stack that should be installed (inertia,livewire)}
                  {--dark : Indicate that dark mode support should be installed}
                  {--teams : Indicates if team support should be installed}
                  {--api : Indicates if API support should be installed}
                  {--verification : Indicates if email verification support should be installed}
                  {--pest : Indicates if Pest should be installed}
                  {--ssr : Indicates if Inertia SSR support should be installed}
                  {--composer=global : Absolute path to the Composer binary which should be used to install packages}
```

--------------------------------

### Invalid Stack Error Handling

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/InstallCommand.md

Shows the error message and exit code when an invalid stack is provided to the install command.

```bash
php artisan jetstream:install typo
# ✗ Invalid stack. Supported stacks are [inertia] and [livewire].
# exit code 1
```

--------------------------------

### Register custom models with Jetstream

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Jetstream.md

Shows how to register custom model classes with Jetstream and then use the newTeamModel() method to retrieve a team instance. This example is from the 'Example — custom models' section.

```php
use Laravel\Jetstream\Jetstream;

Jetstream::useUserModel(\App\Models\User::class);
Jetstream::useTeamModel(\App\Models\Team::class);
Jetstream::useMembershipModel(\App\Models\Membership::class);
Jetstream::useTeamInvitationModel(\App\Models\TeamInvitation::class);

$team = Jetstream::newTeamModel()->findOrFail(1);
```

--------------------------------

### Role rule usage

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Actions.md

Usage example for the Role rule: validates a 'role' field with the Role rule and checks for failures.

```php
use Illuminate\Support\Facades\Validator;
use Laravel\Jetstream\Rules\Role;

$validator = Validator::make(['role' => 'admin'], [
    'role' => ['required', 'string', new Role],
]);

if ($validator->fails()) {
    // role → "The role must be a valid role." for unregistered keys.
}
```

--------------------------------

### Blade method invocation examples

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Livewire-Components.md

Blade examples of method calls invoked from the component using `wire:click` and `wire:submit.prevent` directives. These trigger the corresponding component methods (`confirmUserDeletion`, `deleteUser`, `createApiToken`).

```blade
<button wire:click="confirmUserDeletion">Delete account</button>
<form wire:submit.prevent="deleteUser"> ... </form>
<button wire:click="createApiToken">Create</button>
```

--------------------------------

### Error handling for TeamInvitation sending

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Mail-TeamInvitation.md

Error handling example showing that the mailable itself never throws; transport failures are caught and reported, while the invitation row persists.

```php
try {
    Mail::to($invitation->email)->send(new TeamInvitation($invitation));
} catch (\Throwable $e) {
    report($e);   // transport failures surface here; the invitation row persists
}
```

--------------------------------

### Blade views consumed by Livewire controllers

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Http-Controllers-Livewire.md

Shows how the returned Blade views from the Livewire controllers are consumed by the frontend, with examples for profile.show and api.index.

```php
// Blade layouts consume the returned views, e.g.:
//   view('profile.show')  → <livewire:profile.update-profile-information-form />
//   view('api.index')     → <livewire:api.api-token-manager />
```

--------------------------------

### Bind custom Jetstream action implementations

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Jetstream.md

Example of binding custom action classes to Jetstream contracts. Place this in a service provider to override default team and user management behavior.

```php
use App\Actions\Jetstream\AddTeamMember;
use App\Actions\Jetstream\CreateTeam;
use App\Actions\Jetstream\DeleteTeam;
use App\Actions\Jetstream\DeleteUser;
use App\Actions\Jetstream\InviteTeamMember;
use App\Actions\Jetstream\RemoveTeamMember;
use App\Actions\Jetstream\UpdateTeamName;
use Laravel\Jetstream\Jetstream;

Jetstream::createTeamsUsing(CreateTeam::class);
Jetstream::updateTeamNamesUsing(UpdateTeamName::class);
Jetstream::addTeamMembersUsing(AddTeamMember::class);
Jetstream::inviteTeamMembersUsing(InviteTeamMember::class);
Jetstream::removeTeamMembersUsing(RemoveTeamMember::class);
Jetstream::deleteTeamsUsing(DeleteTeam::class);
Jetstream::deleteUsersUsing(DeleteUser::class);
```

--------------------------------

### Customize Inertia rendering with Jetstream::inertia()->whenRendering

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Http-Controllers-Inertia.md

Use this example to customize the data passed to an Inertia page render in Jetstream. The callback receives the request and existing data, and should return the merged data array. This is useful for adding custom data to team pages or other Inertia-rendered views.

```php
use Laravel\Jetstream\Jetstream;

Jetstream::inertia()->whenRendering('Teams/Show', function ($request, $data) {
    return array_merge($data, ['custom' => true]);
});
```

--------------------------------

### Basic event listening for before/after pair

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Events.md

Shows how to listen for the AddingTeamMember and TeamMemberAdded events. The first listener runs before the member is attached, the second after, logging the activity.

```php
use Illuminate\Support\Facades\Event;
use Laravel\Jetstream\Events\AddingTeamMember;
use Laravel\Jetstream\Events\TeamMemberAdded;

Event::listen(function (AddingTeamMember $event) {
    // Validate or annotate before the member is attached.
});

Event::listen(function (TeamMemberAdded $event) {
    activity()->log("{$event->user->email} joined team {$event->team->name}");
});
```

--------------------------------

### Create Team Invitations Migration

Source: https://github.com/laravel/jetstream/blob/5.x/UPGRADE.md

Create the team_invitations database migration. The generated migration should have the content shown in the next snippet.

```bash
php artisan make:migration create_team_invitations_table
```

--------------------------------

### ValidateTeamDeletion usage

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Actions.md

Usage example: validates team deletion before invoking the DeletesTeams contract. Catches ValidationException for personal teams.

```php
use Laravel\Jetstream\Actions\ValidateTeamDeletion;

try {
    (new ValidateTeamDeletion)->validate($user, $team);
    app(\Laravel\Jetstream\Contracts\DeletesTeams::class)->delete($team);
} catch (\Illuminate\Validation\ValidationException) {
    // Personal teams cannot be deleted.
}
```

--------------------------------

### Advanced: implementing your own contract

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Contracts.md

Shows how to implement your own contract. Create a class implementing CreatesTeams and replace the default binding with Jetstream::createTeamsUsing().

```php
namespace App\Actions\Jetstream;

use Laravel\Jetstream\Contracts\CreatesTeams;

class CreateProjectTeam implements CreatesTeams
{
    public function create($user, array $input)
    {
        // your own validation + persistence
        return $user->ownedTeams()->create([
            'name' => $input['name'],
            'personal_team' => false,
        ]);
    }
}

// Replace the default binding:
Jetstream::createTeamsUsing(CreateProjectTeam::class);
```

--------------------------------

### Trait Laravel\Jetstream\HasProfilePhoto

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/HasProfilePhoto.md

Documentation for the HasProfilePhoto trait, including its public methods, accessor, protected helpers, usage examples, and notes.

```APIDOC
## Trait `Laravel\Jetstream\HasProfilePhoto`

### Description
Eloquent trait for the application `User` model providing profile-photo storage, deletion, and URL accessor. Requires the `users` table to have a `profile_photo_path` column (published users migration) and a `name` column (used to build the default avatar URL).

### Usage
Apply with `use HasProfilePhoto;`. The stub `User` model also appends `profile_photo_url` to its array form (`$appends = ['profile_photo_url']`), backed by the protected `profilePhotoUrl(): Attribute` accessor.

### Methods

#### `public function updateProfilePhoto(UploadedFile $photo, $storagePath = 'profile-photos')`

- **Parameters**:
  - `$photo` (`\Illuminate\Http\UploadedFile`) - Required - The uploaded file to store.
  - `$storagePath` (string) - Optional - Storage directory, default `'profile-photos'`.
- **Returns**: `void`
- **Behavior**: Stores the upload via `$photo->storePublicly($storagePath, ['disk' => $this->profilePhotoDisk()])`, saves `profile_photo_path`, then deletes the previous photo file from the same disk if one existed.

#### `public function deleteProfilePhoto()`

- **Parameters**: None
- **Returns**: `void`
- **Behavior**: No-op unless `Features::managesProfilePhotos()` is true and `profile_photo_path` is non-null. Otherwise deletes the stored file and clears `profile_photo_path`.

### Accessor

#### `protected function profilePhotoUrl(): Attribute`

Returns an `Attribute` accessor that returns the stored-file URL or the default gravatar-like URL.

```php
protected function profilePhotoUrl(): Attribute
{
    return Attribute::get(function (): string {
        return $this->profile_photo_path
                ? Storage::disk($this->profilePhotoDisk())->url($this->profile_photo_path)
                : $this->defaultProfilePhotoUrl();
    });
}
```

### Protected Helpers

#### `protected function defaultProfilePhotoUrl()`

- **Returns**: `string`
- **Behavior**: Builds initials from `$this->name` (first character of each whitespace-separated word, uppercase-joined) and returns `https://ui-avatars.com/api/?name={...}&color=7F9CF5&background=EBF4FF`.

#### `protected function profilePhotoDisk()`

- **Returns**: `string`
- **Behavior**: Returns `'s3'` when `$_ENV['VAPOR_ARTIFACT_NAME']` is set (Laravel Vapor environment); otherwise `config('jetstream.profile_photo_disk', 'public')`.

### Examples

#### Basic — upload and delete

```php
use Laravel\Jetstream\HasProfilePhoto;

class User extends Authenticatable
{
    use HasProfilePhoto;
}

// Controller / Livewire action:
$request->user()->updateProfilePhoto($request->file('photo'));
// stored under profile-photos/ on the configured disk; previous photo removed

$user->profile_photo_url;   // "https://cdn.example.com/profile-photos/abc.jpg"
$request->user()->deleteProfilePhoto();
```

#### Advanced — custom storage path and disk selection

```php
$user->updateProfilePhoto($uploadedFile, 'avatars/2024');

// Disk is config-driven ("public" by default, "s3" under Vapor):
// config/jetstream.php
'profile_photo_disk' => 's3',
```

#### Error handling — guarding when the feature is off

```php
use Laravel\Jetstream\Features;

// deleteProfilePhoto() silently no-ops unless the feature is enabled,
// so callers must gate their UI on the feature flag:
if (Features::managesProfilePhotos()) {
    $user->deleteProfilePhoto();
}
```

### Notes

- The profile photo file is stored with `storePublicly()` so it is publicly reachable; `Storage::disk(...)->delete()` removes previous files after a successful replacement.
- Environment variable `VAPOR_ARTIFACT_NAME` switches the disk to `s3` automatically (see [configuration.md](configuration.md)).
- Consumed by `Inertia\ProfilePhotoController::destroy()` (`DELETE /user/profile-photo`, [Http-Controllers-Inertia.md](Http-Controllers-Inertia.md)) and `Livewire\UpdateProfileInformationForm` ([Livewire-Components.md](Livewire-Components.md)).
```

--------------------------------

### Role::__construct

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Role.md

Creates a new Role instance with a key, display name, and permissions list.

```APIDOC
## Role::__construct

### Description
Creates a new Role instance with a key, display name, and permissions list.

### Method
Constructor

### Signature
```php
public function __construct(string $key, string $name, array $permissions)
```

### Parameters
- **$key** (string) - Required - Role key.
- **$name** (string) - Required - Display name.
- **$permissions** (array) - Required - Permissions granted.

### Returns
No return value (constructor).
```

--------------------------------

### GET /privacy-policy

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/endpoints.md

Displays the privacy policy page. This endpoint is publicly accessible and only registered when the terms and privacy policy feature is enabled.

```APIDOC
## GET /privacy-policy

### Description
Displays the privacy policy page. This endpoint is publicly accessible and only registered when the terms and privacy policy feature is enabled.

### Method
GET

### Endpoint
/privacy-policy

### Parameters
None

### Response
#### Success Response (200)
- **policy** (string) - The privacy policy content, converted from markdown.

#### Response Example
{
  "policy": "<h1>Privacy Policy</h1>..."
}
```

--------------------------------

### Basic role definition and serialization

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Role.md

Creates a Role instance, sets a description, and serializes it to JSON.

```php
use Laravel\Jetstream\Jetstream;
use Laravel\Jetstream\Role;

$role = new Role('editor', 'Editor', ['read', 'create', 'update']);
$role->description('Editors can read, create, and update.');

json_encode($role);
// {"key":"editor","name":"Editor","description":"...","permissions":["read","create","update"]}
```

--------------------------------

### InstallCommand class declaration

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/InstallCommand.md

Declares the artisan command class with the AsCommand attribute, implementing PromptsForMissingInput for interactive input.

```php
#[AsCommand(name: 'jetstream:install')]
class InstallCommand extends Command implements PromptsForMissingInput
```

--------------------------------

### GET /terms-of-service

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/endpoints.md

Displays the terms of service page. This endpoint is publicly accessible and only registered when the terms and privacy policy feature is enabled.

```APIDOC
## GET /terms-of-service

### Description
Displays the terms of service page. This endpoint is publicly accessible and only registered when the terms and privacy policy feature is enabled.

### Method
GET

### Endpoint
/terms-of-service

### Parameters
None

### Response
#### Success Response (200)
- **terms** (string) - The terms of service content, converted from markdown.

#### Response Example
{
  "terms": "<h1>Terms of Service</h1>..."
}
```

--------------------------------

### TeamInvitation build() method

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Mail-TeamInvitation.md

Build method that returns a markdown email with a signed accept URL and the subject 'Team Invitation'. The signed route prevents URL forgery.

```php
public function build()
{
    return $this->markdown('emails.team-invitation', ['acceptUrl' => URL::signedRoute('team-invitations.accept', [
        'invitation' => $this->invitation,
    ])])->subject(__('Team Invitation'));
}
```

--------------------------------

### Role and permission registration methods

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Jetstream.md

Method signatures for role and permission registration. These methods manage roles, permissions, and default API token permissions.

```php
public static function hasRoles()
public static function findRole(string $key)
public static function role(string $key, string $name, array $permissions)
public static function hasPermissions()
public static function permissions(array $permissions)
public static function defaultApiTokenPermissions(array $permissions)
public static function validPermissions(array $permissions)
```

--------------------------------

### Role constructor

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Role.md

Constructor for Role with key, name, and permissions parameters.

```php
public function __construct(string $key, string $name, array $permissions)
```

--------------------------------

### Publish Jetstream Views

Source: https://github.com/laravel/jetstream/blob/5.x/UPGRADE.md

Publish all Jetstream views before upgrading. Run this command before upgrading to Jetstream 3.x.

```bash
php artisan vendor:publish --tag=jetstream-views
```

--------------------------------

### Advanced member removal and deletion preconditions

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Team.md

Demonstrates how to remove a user from a team and the preconditions for purging a team, including validation before calling purge().

```php
$team->removeUser($user);                 // detaches and clears current_team_id if needed

// purge() is what the DeleteTeam action (stub) calls:
if ($user->ownsTeam($team)) {
    // validate first, e.g. Laravel\Jetstream\Actions\ValidateTeamDeletion
    $team->purge();                       // clears owner/member context, detaches, deletes
}
```

--------------------------------

### OwnerRole::__construct

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Role.md

Creates a new OwnerRole instance with fixed key 'owner', name 'Owner', and permissions ['*'].

```APIDOC
## OwnerRole::__construct

### Description
Creates a new OwnerRole instance with fixed key 'owner', name 'Owner', and permissions ['*'] (wildcard for all permissions).

### Method
Constructor

### Signature
```php
public function __construct()
```

### Parameters
None.

### Returns
No return value (constructor).
```

--------------------------------

### TeamInvitation::build

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Mail-TeamInvitation.md

Builds the mailable content. Returns the mailable instance with a markdown view and subject.

```APIDOC
## TeamInvitation::build

### Description
Builds the mailable content. Returns the mailable instance with a markdown view and subject.

### Method
build

### Signature
```php
public function build()
```

### Return Value
Returns `$this` (the mailable instance).

### Behavior
- Uses the markdown view `emails.team-invitation` with data `['acceptUrl' => ...]`.
- Sets the subject to `__('Team Invitation')`.
- The `acceptUrl` is a signed route targeting `team-invitations.accept` with the invitation ID.

### View Data
- `$acceptUrl` (string) - Signed URL for accepting the invitation.
- `$invitation` (\Laravel\Jetstream\TeamInvitation) - Invitation model (public property).

### Usage Example
```php
Mail::to($invitation->email)->send(new TeamInvitation($invitation));
```
```

--------------------------------

### register() merges jetstream config

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/JetstreamServiceProvider.md

Merges the package's config/jetstream.php into the 'jetstream' config key during registration.

```php
public function register()
{
    $this->mergeConfigFrom(__DIR__.'/../config/jetstream.php', 'jetstream');
}
```

--------------------------------

### Basic usage: upload, access URL, and delete profile photo

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/HasProfilePhoto.md

Shows how to use the trait in a User model, upload a profile photo, access the URL, and delete the photo. The upload stores under the configured disk; the previous photo is removed.

```php
use Laravel\Jetstream\HasProfilePhoto;

class User extends Authenticatable
{
    use HasProfilePhoto;
}

// Controller / Livewire action:
$request->user()->updateProfilePhoto($request->file('photo'));
// stored under profile-photos/ on the configured disk; previous photo removed

$user->profile_photo_url;   // "https://cdn.example.com/profile-photos/abc.jpg"
$request->user()->deleteProfilePhoto();

```

--------------------------------

### Chain multiple whenRendering() callbacks

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/InertiaManager.md

Registers multiple callbacks for the same page; render() applies them in registration order, merging props sequentially.

```php
Jetstream::inertia()
    ->whenRendering('Teams/Show', fn ($request, $data) => array_merge($data, ['a' => 1]))
    ->whenRendering('Teams/Show', fn ($request, $data) => array_merge($data, ['b' => 2]));

// render() applies both callbacks in registration order:
// $data = ['team' => ..., 'a' => 1, 'b' => 2]

```

--------------------------------

### ShareInertiaData handle() signature

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Http-Middleware.md

Inertia-stack middleware appended to the web group by JetstreamServiceProvider::bootInertia(). Calls Inertia::share() with three top-level props.

```php
class ShareInertiaData
{
    public function handle($request, $next)
}
```

--------------------------------

### Agent edge cases

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Agent.md

Edge case handling: empty user agent results in null platform and true isDesktop; CloudFront header makes isDesktop return true.

```php
$agent->setUserAgent('');     // empty user agent
$agent->platform();           // null (no rule matched)
$agent->isDesktop();          // true (not mobile, not tablet)

// CloudFront edge case:
$agent->setUserAgent('Amazon CloudFront');
$agent->setHttpHeader('HTTP_CLOUDFRONT_IS_DESKTOP_VIEWER', 'true');
$agent->isDesktop();          // true
```

--------------------------------

### Advanced role lookup and owner role

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Role.md

Registers a role, finds it, and demonstrates the OwnerRole usage.

```php
use Laravel\Jetstream\Jetstream;
use Laravel\Jetstream\OwnerRole;

Jetstream::role('admin', 'Administrator', ['*'])->description('Full access.');

$role = Jetstream::findRole('admin');   // Role|null
$role->jsonSerialize();

$owner = new OwnerRole;                 // key "owner", permissions ['*']
if ($user->ownsTeam($team)) {
    $teamRole = $user->teamRole($team);   // returns a new OwnerRole
}
```

--------------------------------

### Basic usage of HasTeams on User model

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/HasTeams.md

Basic usage of the HasTeams trait on a User model. Shows how to apply the trait and demonstrates common team-related methods: currentTeam (lazy switch to personal team), allTeams, personalTeam, ownsTeam, belongsToTeam, and switchTeam.

```php
use Laravel\Jetstream\HasTeams;

class User extends Authenticatable
{
    use HasApiTokens;
    use HasTeams;

    // ...
}

$user = User::find(1);

$user->currentTeam;            // lazy switch to personal team, then BelongsTo resolution
$user->allTeams();             // collection sorted by name
$user->personalTeam();
$user->ownsTeam($team);        // bool
$user->belongsToTeam($team);   // bool
$user->switchTeam($team);      // bool
```

--------------------------------

### Jetstream user and team model management methods

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Jetstream.md

Lists the static methods for managing user, team, membership, and team invitation models. These methods allow retrieving, creating, and setting the model classes used by Jetstream. The find methods throw ModelNotFoundException when the model is absent.

```php
public static function findUserByIdOrFail($id)
public static function findUserByEmailOrFail(string $email)
public static function userModel()
public static function newUserModel()
public static function useUserModel(string $model)
public static function teamModel()
public static function newTeamModel()
public static function useTeamModel(string $model)
public static function membershipModel()
public static function useMembershipModel(string $model)
public static function teamInvitationModel()
public static function useTeamInvitationModel(string $model)
```

--------------------------------

### Basic team relation and membership checks

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Team.md

Shows how to extend the Jetstream Team model and use its relations and membership methods.

```php
use Laravel\Jetstream\Team as JetstreamTeam;

class Team extends JetstreamTeam
{
    protected $fillable = ['name', 'personal_team'];
}

/** @var \App\Models\Team $team */
$team->owner;                 // \App\Models\User
$team->users;                 // collection, each with ->membership->role
$team->allUsers();            // users + owner
$team->hasUser($user);        // bool
$team->hasUserWithEmail('a@b.c'); // bool
$team->teamInvitations;       // pending invitation models
```

--------------------------------

### Jetstream utility method signatures

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Jetstream.md

Lists the three public static methods available on the Jetstream class: inertia(), localizedMarkdownPath(), and ignoreRoutes(). These are the primary utilities for interacting with Jetstream's Inertia manager, localized markdown paths, and route registration control.

```php
public static function inertia()
public static function localizedMarkdownPath($name)
public static function ignoreRoutes()
```

--------------------------------

### Add Livewire Styles and Scripts to Guest Layout

Source: https://github.com/laravel/jetstream/blob/5.x/UPGRADE.md

Add @livewireStyles and @livewireScripts to the guest layout for Livewire 3, which ships with Alpine by default. The diff shows the required additions.

```diff
        <!-- Scripts -->
        @vite(['resources/css/app.css', 'resources/js/app.js'])
+
+       <!-- Styles -->
+       @livewireStyles
    </head>
    <body>
        <div class="font-sans text-gray-900 dark:text-gray-100 antialiased">
            {{ $slot }}
        </div>
+
+       @livewireScripts
    </body>
```

--------------------------------

### Role::description

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Role.md

Sets the description property and returns the current instance for fluent chaining.

```APIDOC
## Role::description

### Description
Sets the description property and returns the current instance for fluent chaining.

### Method
Method

### Signature
```php
public function description(string $description)
```

### Parameters
- **$description** (string) - Required - Human-readable description.

### Returns
- **$this** - The current Role instance for chaining.
```

--------------------------------

### platform()

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Agent.md

Detects the operating-system name by merging MobileDetect's operating systems with additional rules and matching the user agent. Results are cached per request.

```APIDOC
## platform()

### Description
Detects the operating-system name by merging MobileDetect's operating systems with additional rules and matching the user agent. Results are cached per request.

### Method
platform()

### Returns
string|null - The operating system name (e.g., "Mac OS X", "Windows", "Linux") or null if no match.

### Example
```php
$agent = new Agent();
$agent->setUserAgent($userAgentString);
$platform = $agent->platform(); // "Mac OS X", "Windows", etc.
```
```

--------------------------------

### Basic feature flag checks in application code

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Features.md

Use Features::hasTeamFeatures() and Features::managesProfilePhotos() to conditionally enable team routes and profile photo uploader in your application.

```php
use Laravel\Jetstream\Features;

if (Features::hasTeamFeatures()) {
    // Team routes and Livewire components are active.
}

if (Features::managesProfilePhotos()) {
    // Render the profile photo uploader.
}
```

--------------------------------

### Generate signed accept URL

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Membership.md

Generates a signed URL for accepting a team invitation. The route 'team-invitations.accept' is used and the resulting URL includes a signature query parameter.

```php
use Illuminate\Support\Facades\URL;

URL::signedRoute('team-invitations.accept', ['invitation' => $invitation]);
// GET /team-invitations/{invitation}?signature=...  (route is 'team-invitations.accept')
```

--------------------------------

### Basic usage: resolving contract implementations

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Contracts.md

Shows how to resolve contract implementations from the container. Bind implementations in the service provider using Jetstream::addTeamMembersUsing(), then resolve via app() in a controller.

```php
use Laravel\Jetstream\Contracts\AddsTeamMembers;
use Laravel\Jetstream\Contracts\CreatesTeams;
use Laravel\Jetstream\Jetstream;

// Bound in the service provider:
Jetstream::addTeamMembersUsing(\App\Actions\Jetstream\AddTeamMember::class);

// Used in a controller:
app(CreatesTeams::class)->create($request->user(), $request->all());
app(AddsTeamMembers::class)->add($user, $team, $email, $role);
```

--------------------------------

### Error handling: guard deleteProfilePhoto() with Features::managesProfilePhotos()

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/HasProfilePhoto.md

Shows how to gate the deleteProfilePhoto() call behind the feature flag to avoid a silent no-op.

```php
use Laravel\Jetstream\Features;

// deleteProfilePhoto() silently no-ops unless the feature is enabled,
// so callers must gate their UI on the feature flag:
if (Features::managesProfilePhotos()) {
    $user->deleteProfilePhoto();
}

```

--------------------------------

### Using TeamInvitation model

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Membership.md

Demonstrates retrieving a TeamInvitation by primary key, accessing its email, role, and team relation, and deleting it. The team relation returns the configured team model.

```php
use Laravel\Jetstream\TeamInvitation;

$invitation = TeamInvitation::whereKey($id)->firstOrFail();
$invitation->email;   // "newmember@example.com"
$invitation->role;    // "editor"
$invitation->team;    // \App\Models\Team

$invitation->delete();
```

--------------------------------

### OwnerRole constructor

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Role.md

Constructor for OwnerRole with fixed values.

```php
public function __construct()
{
    parent::__construct('owner', 'Owner', ['*']);
}
```

--------------------------------

### Advanced event listening with resolved models

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Events.md

Shows how to listen for InvitingTeamMember and TeamMemberUpdated events. The InvitingTeamMember listener sends an email using the event's email, team, and role. The TeamMemberUpdated listener notes that team is a fresh model and user is resolved via Jetstream::findUserByIdOrFail.

```php
use Laravel\Jetstream\Events\InvitingTeamMember;
use Laravel\Jetstream\Events\TeamMemberUpdated;

Event::listen(function (InvitingTeamMember $event) {
    $mail = to($event->email);
    $mail->send(new \App\Mail\TeamWelcome($event->team, $event->role));
});

Event::listen(function (TeamMemberUpdated $event) {
    // $event->team is a fresh model (the package action passes $team->fresh())
    // $event->user is resolved via Jetstream::findUserByIdOrFail($teamMemberId)
    audit()->record('role_changed', $event->team, $event->user);
});
```

--------------------------------

### Error handling for unknown roles

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Role.md

Checks if a role exists before using it.

```php
$role = Jetstream::findRole('nonexistent');   // null — check before use
if ($role === null) {
    // Role is not registered; validation rule would have rejected it earlier.
}
```

--------------------------------

### Custom Inertia page data and localized markdown path

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Jetstream.md

Shows how to add custom data to an Inertia page render and how to resolve a localized markdown path. The whenRendering callback merges a custom flag into the page data, and localizedMarkdownPath returns the localized file path when available, falling back to the plain name.

```php
use Laravel\Jetstream\Jetstream;

Jetstream::inertia()->whenRendering('Profile/Show', function ($request, $data) {
    return array_merge($data, ['customFlag' => true]);
});

Jetstream::localizedMarkdownPath('policy.md');
// e.g. "/app/resources/markdown/policy.fr.md" when the app locale is "fr",
// falling back to "/app/resources/markdown/policy.md"
```

--------------------------------

### Published Jetstream config stub with auth_session and guard

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/configuration.md

Published stub adds 'auth_session' and 'guard' keys, with commented-out feature options and account deletion enabled.

```php
'auth_session' => AuthenticateSession::class,
'guard' => 'sanctum',
'features' => [
    // Features::termsAndPrivacyPolicy(),
    // Features::profilePhotos(),
    // Features::api(),
    // Features::teams(['invitations' => true]),
    Features::accountDeletion(),
],
```

--------------------------------

### Publish Inertia Authentication Pages

Source: https://github.com/laravel/jetstream/blob/5.x/UPGRADE.md

Publishes the Vue-based authentication pages for the Inertia stack in Jetstream 2.0.

```bash
php artisan vendor:publish --tag=jetstream-inertia-auth-pages
```

--------------------------------

### Livewire Team Routes

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/endpoints.md

All team-related routes for the Livewire stack, including create, show, current team switching, and invitation acceptance.

```APIDOC
## GET /teams/create

### Description
Displays the form to create a new team. Returns a Blade view.

### Method
GET

### Endpoint
/teams/create

### Parameters
None

### Response
#### Success Response (200)
- Blade `teams.create` view

#### Error Response (403)
- When the `create` gate is denied

```

```APIDOC
## GET /teams/{team}

### Description
Displays the details of a specific team. Returns a Blade view.

### Method
GET

### Endpoint
/teams/{team}

### Parameters
#### Path Parameters
- `team` (string) - Required - The team identifier

### Response
#### Success Response (200)
- Blade `teams.show` view

#### Error Response (404)
- When the team is not found

#### Error Response (403)
- When the `view` gate is denied

```

```APIDOC
## PUT /current-team

### Description
Switches the current team to the specified team.

### Method
PUT

### Endpoint
/current-team

### Parameters
#### Request Body
- `team_id` (integer) - Required - The ID of the team to switch to

### Response
#### Success Response (303)
- Redirect to `fortify.home`

#### Error Response (404)
- When the team is not found

#### Error Response (403)
- When the `switchTeam` operation fails

```

```APIDOC
## GET /team-invitations/{invitation}

### Description
Accepts a team invitation. Requires a signed URL.

### Method
GET

### Endpoint
/team-invitations/{invitation}

### Parameters
#### Path Parameters
- `invitation` (string) - Required - The invitation identifier

### Response
#### Success Response (302)
- Redirect to `fortify.home` with a success banner

#### Error Response (403)
- When the signature is invalid

#### Error Response (404)
- When the invitation is not found

```

--------------------------------

### isDesktop()

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Agent.md

Determines if the user agent represents a desktop device. Returns true for Amazon CloudFront with the HTTP_CLOUDFRONT_IS_DESKTOP_VIEWER header set to 'true', otherwise returns true if not mobile and not tablet. Results are cached per request.

```APIDOC
## isDesktop()

### Description
Determines if the user agent represents a desktop device. Returns true for Amazon CloudFront with the HTTP_CLOUDFRONT_IS_DESKTOP_VIEWER header set to 'true', otherwise returns true if not mobile and not tablet. Results are cached per request.

### Method
isDesktop()

### Returns
bool - True if the device is considered a desktop, false otherwise.

### Example
```php
$agent = new Agent();
$agent->setUserAgent('Amazon CloudFront');
$agent->setHttpHeader('HTTP_CLOUDFRONT_IS_DESKTOP_VIEWER', 'true');
$isDesktop = $agent->isDesktop(); // true
```
```

--------------------------------

### CreatesTeams interface

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Contracts.md

Marker interface for creating teams. The method contract is documented in a @method docblock. Bound by Jetstream::createTeamsUsing().

```php
/**
 * @method \Illuminate\Database\Eloquent\Model create(\Illuminate\Foundation\Auth\User $user, array $input)
 */
interface CreatesTeams
```

--------------------------------

### Error handling: bind a closure

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Contracts.md

Shows error handling by swapping the binding to behave differently per request. Bind a closure instead of a class, valid because the singleton accepts a callback.

```php
// Bind a closure instead of a class (valid because singleton accepts a callback):
Jetstream::createTeamsUsing(function ($app) {
    return new CustomCreateTeam;
});
```

--------------------------------

### Configure Blade Authentication Views in JetstreamServiceProvider

Source: https://github.com/laravel/jetstream/blob/5.x/UPGRADE.md

Add this code to the boot method of your application's JetstreamServiceProvider to continue using Blade-based authentication views in Jetstream 2.x.

```php
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use Laravel\Fortify\Fortify;

Fortify::loginView(function () {
    return view('auth/login', [
        'canResetPassword' => Route::has('password.request'),
        'status' => session('status'),
    ]);
});

Fortify::requestPasswordResetLinkView(function () {
    return view('auth/forgot-password', [
        'status' => session('status'),
    ]);
});

Fortify::resetPasswordView(function (Request $request) {
    return view('auth/reset-password', [
        'email' => $request->input('email'),
        'token' => $request->route('token'),
    ]);
});

Fortify::registerView(function () {
    return view('auth/register');
});

Fortify::verifyEmailView(function () {
    return view('auth/verify-email', [
        'status' => session('status'),
    ]);
});

Fortify::twoFactorChallengeView(function () {
    return view('auth/two-factor-challenge');
});

Fortify::confirmPasswordView(function () {
    return view('auth/confirm-password');
});
```

--------------------------------

### Add page props via whenRendering()

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/InertiaManager.md

Registers a callback to inject custom page props for a specific Inertia page, e.g., adding a user's Gravatar URL to Profile/Show.

```php
use Laravel\Jetstream\Jetstream;

// In App\Providers\JetstreamServiceProvider::boot() (or any service provider):
Jetstream::inertia()->whenRendering('Profile/Show', function ($request, $data) {
    return array_merge($data, [
        'customGravatar' => $request->user()->gravatar,
    ]);
});
```

--------------------------------

### TeamInvitation::__construct

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/Mail-TeamInvitation.md

Constructor for the TeamInvitation mailable. Accepts a TeamInvitation model instance representing the pending invitation.

```APIDOC
## TeamInvitation::__construct

### Description
Constructor for the TeamInvitation mailable. Accepts a TeamInvitation model instance representing the pending invitation.

### Method
Constructor

### Signature
```php
public function __construct(TeamInvitationModel $invitation)
```

### Parameters
- `$invitation` (Laravel\Jetstream\TeamInvitation) - Required - Team invitation row containing `email`, `role`, and the related `team`.

### Usage Example
```php
$invitation = TeamInvitationModel::create([
    'team_id' => $team->id,
    'email' => 'newmember@example.com',
    'role' => 'editor',
]);

Mail::to($invitation->email)->send(new TeamInvitation($invitation));
```
```

--------------------------------

### Update Jetstream to 5.x

Source: https://github.com/laravel/jetstream/blob/5.x/UPGRADE.md

Run this command after upgrading the laravel/jetstream dependency to ^5.0 in composer.json to update the package.

```bash
composer update
```

--------------------------------

### switchTeam($team)

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/HasTeams.md

Switches the user's current team to the given team if the user belongs to it.

```APIDOC
## switchTeam($team)

### Description
Switches the user's current team to the given team if the user belongs to it.

### Parameters
- **$team** (team model) - Required - The team to switch to.

### Returns
`bool`

### Behavior
- If the user does not `belongsToTeam($team)`, returns `false` without changes.
- Otherwise, `forceFill(['current_team_id' => $team->id])->save()`, sets the `currentTeam` relation, and returns `true`.
```

--------------------------------

### Default Jetstream config file

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/configuration.md

Default package config file (config/jetstream.php) with the 'inertia' stack, 'web' middleware, account deletion feature, and 'public' profile photo disk.

```php
return [
    'stack' => 'inertia',
    'middleware' => ['web'],
    'features' => [Features::accountDeletion()],
    'profile_photo_disk' => 'public',
];
```

--------------------------------

### profilePhotoUrl() accessor implementation

Source: https://github.com/laravel/jetstream/blob/5.x/_autodocs/api-reference/HasProfilePhoto.md

Defines the profilePhotoUrl accessor that returns the stored file URL or the default profile photo URL.

```php
protected function profilePhotoUrl(): Attribute
{
    return Attribute::get(function (): string {
        return $this->profile_photo_path
                ? Storage::disk($this->profilePhotoDisk())->url($this->profile_photo_path)
                : $this->defaultProfilePhotoUrl();
    });
}

```

--------------------------------

### Clear View Cache

Source: https://github.com/laravel/jetstream/blob/5.x/UPGRADE.md

Clear the view cache after moving and updating views. Required for both Livewire and Inertia stacks.

```bash
php artisan view:clear
```
Tokens:
Raw