Download the PHP package fumeapp/modeltyper without Composer

Model Typer

Model Typer is a powerful tool designed for developers working with Laravel and TypeScript. Its primary purpose is to simplify the generation of TypeScript interfaces from Laravel models, enhancing type safety and consistency in your applications.

Upgrade Guide

Please read the upgrade guide here

Installation

Starting support is for Laravel >=v11.33.0 and PHP v8.2+

[!IMPORTANT] For Laravel >=10.43.0 || <11.33.0, use v2 instead

Require this package with composer using the following command:

Optionally, you can publish the config file using the following command:

Usage

You can simply run the following command to generate TypeScript interfaces:

The output is an accurate, type-safe representation of Laravel models in TypeScript, such as:

How does it work?

This command will go through all of your models and make TypeScript Interfaces based on the database columns, mutators, and relationships.

You can then pipe the output into your preferred ???.d.ts, or set the optional argument output-file to generate it

[!TIP] To view the current mappings that are being used, use the following command:

These mappings can be extended or overridden in the config

Requirements

1. You must have a return type for your model relationships

2. You must have a return type for your model mutations

Optional Arguments

• output-file : Echo the definitions into a file

Additional Options

• --model= : Generate typescript interfaces for a specific model
• --global : Generate typescript interfaces in a global namespace named models
• --json : Output the result as json
• --use-enums : Use typescript enums instead of object literals
• --plurals : Output model plurals
• --no-relations : Do not include relations
• --optional-relations : Make relations optional fields on the model type
• --no-hidden : Do not include hidden model attributes
• --timestamps-date : Output timestamps as a Date object type
• --optional-nullables : Output nullable attributes as optional fields
• --api-resources : Output api.MetApi interfaces
• --fillables : Output model fillables
• --fillable-suffix= : Appends to fillables
• --ignore-config : Ignore options set in config

Custom Interfaces

If you have custom interfaces you are using for your models you can specify them in a reserved interfaces array

For example for a custom Point interface in a Location model you can put this in the model

And it will generate:

This will override all columns, mutators and relationships

You can also specify an interface is nullable:

You can also choose to leave off the import and just use the type:

And it should generate:

Using the custom interface is also a good place to append any additional properties you want to add to the interface.

For example, if your interface keeps some additional state in something like Vuex, you can add it to the interfaces:

This will generate:

Override default mappings / add new ones

You can override the default mappings provided by Model Typer or add new ones by publishing the config

Then inside custom_mappings add the Laravel type as the key and assign the TypeScript type as its value

You can also add mappings for your Custom Casts

Declare global

Generate your interfaces in a global namespace named model

Output plural interfaces for collections

Exports for example, when a User model exists:

Output Api.MetApi* resources

Exports:

Enable all output options

Exports both plurals & api-resources. i.e. it is equivalent to:

For Single Model

Generate your interfaces for a single model

Output as JSON

Generate your interfaces as JSON

Enum Eloquent Attribute Casting

Laravel lets you cast Enums in your models. This will get detected and bring in your enum class with your comments:

[!NOTE] ModelTyper uses Object Literals by default instead of TS Enums for opinionated reasons. But you can use --use-enums option to use TS Enums instead of Object Literals.

app/Enums/UserRoleEnum.php

Then inside our User model

app/Models/User.php

Now our ModelTyper output will look like the following:

[!NOTE] Notice how the comments are found and parsed - they must follow the specified format