Model Typer

For Model Typer to accurately detect relationships and mutators, you must provide explicit PHP return types for them in your Laravel models:

1. Relationships: Must have a return type (e.g., HasMany, BelongsTo).
2. Mutators: Must have a return type (e.g., Attribute).

// Relationship requirement
public function providers(): HasMany
{
    return $this->hasMany(Provider::class);
}

// Mutator requirement
protected function firstName(): Attribute
{
    return Attribute::make(
        get: fn (string $value): string => ucfirst($value),
    );
}

By default, Model Typer generates TypeScript interface definitions. To generate type aliases instead, use the --use-types flag via CLI, or set 'use-types' => true in your config/modeltyper.php file.

# Via CLI
php artisan model:typer --use-types

# For a specific model
php artisan model:typer --model=User --use-types

When upgrading to version 3.0, ensure your environment meets the following minimum requirements:

• Laravel: version 11.33.0 or higher
• PHP: version 8.2 or higher
• nesbot/carbon: version 3.5 or higher (required for PHP 8.4 support)

Model Typer detects Laravel Enum casting. By default, it generates TypeScript Object Literals (which are safer and more performant). If you prefer TypeScript enum syntax, use the --use-enums flag.

Note: Using --use-enums produces const enum by default, which are inlined and not readable at runtime. To ensure values are readable at runtime (e.g., via Object.values()), use the --plain-enums flag alongside --use-enums.

# To get runtime-readable enums
php artisan model:typer --use-enums --plain-enums

Version 3.0 introduces new configuration options. To ensure your config/modeltyper.php file contains all necessary keys, delete your existing configuration file and republish the new one using the Artisan command below:

php artisan vendor:publish --provider="FumeApp\ModelTyper\ModelTyperServiceProvider" --tag=config

Install Model Typer as a development dependency using Composer.

Requirements:

• Laravel >=v11.33.0 and PHP v8.2+
• Note: For Laravel versions between 10.43.0 and 11.33.0, you must use version v2 of the package instead.

After installation, you can optionally publish the configuration file to config/modeltyper.php to customize its behavior.

composer require --dev fumeapp/modeltyper

# Optional: Publish the config file
php artisan vendor:publish --provider="FumeApp\ModelTyper\ModelTyperServiceProvider" --tag=config

You can extend or override how Laravel types are mapped to TypeScript types by modifying the custom_mappings array in config/modeltyper.php. Use the Laravel type (or Custom Cast class) as the key.

'custom_mappings' => [
    'App\Casts\YourCustomCast' => 'string | null',
    'binary' => 'Blob',
    'bool' => 'boolean',
    'point' => 'CustomPointInterface',
    'year' => 'string',
],

To customize the behavior of Model Typer, you can publish its configuration file to your application's config directory using the config tag. This allows you to control settings like whether to run automatically after migrations and where to save the output files.

php artisan vendor:publish --tag=config

To include sum aggregates (e.g., posts_sum_likes) in your TypeScript interfaces, define the $sums property in your Laravel model. The format is 'relationship_name' => 'column_to_sum'.

protected $sums = [
    // Format: 'relationship' => 'column_to_sum'
    'posts' => 'likes',
];