README

Transforms Laravel Models to Typescript Interfaces/Types

Precautions

This packages instantiates Models to retrieve it's casts, attributes, relations in some cases. So, if your models have some sensitive actions inside __constructor method, please be aware of using this package.

Installation

Via Composer

composer require --dev wovosoft/laravel-typescript

Publish Configuration

Run the command given below. This will publish laravel-typescript.php config file.

php artisan vendor:publish --provider="Wovosoft\LaravelTypescript\LaravelTypescriptServiceProvider"

Configure the configurations

return [
    'output_path'       => resource_path('js/types/models.d.ts'),
    'source_dir'        => app_path('Models'),
    /**
     * Custom attributes should have return types defined.
     * But if it is not, then the return type should be this type.
     * And this value should be php supported return types.
     * like primitive types or any other classes
     */
    "custom_attributes" => [
        "fallback_return_type" => "string"
    ]
];

Usage

Run the command given below to generate typescript types.

php artisan laravel-typescript:transform

Generated contents will be written in configured location.

Advanced Usage

Sometimes Models can be stored in different locations, like in some packages, some directories etc., in that case, please check the source of ./src/LaravelTypescript.php

You can just instantiate this class, and generate types for models in some other directories.

use Wovosoft\LaravelTypescript\Facades\LaravelTypescript;


$dirs = [
    "models"               => app_path("Models"),
    "hrmPerson"            => base_path("packages/wovosoft/hrms-person/src/Models"),
];

foreach ($dirs as $name => $dir) {
    LaravelTypescript::generate(
        sourceDir : $dir,
        outputPath: resource_path("js/types/$name.d.ts")
    );
    
    echo "Generated $name.d.ts";
}

Note on New Model Attributes

For new Model Attributes, return type of the Closure function should be defined, otherwise, it will generate value of config('laravel-typescript.custom_attributes.fallback_return_type') type for the related property.

use \Illuminate\Database\Eloquent\Model;
use \Illuminate\Database\Eloquent\Casts\Attribute;

class User extends Model{
    public function isActive() : Attribute 
    {
        return Attribute::get(fn(): bool =>$this->status==='active');
    }
    
    public function getIsInactiveAttribute():bool
    {
        return $this->status==="inactive";
    }
}

Change log

Please see the changelog for more information on what has changed recently.

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please create issues in Issues Tracker

Credits

License

MIT. Please see the license file for more information.

wovosoft / laravel-typescript

Maintainers

Details