README

Generate TypeScript interfaces automatically from your Laravel FormRequests and API Resources. Keep your backend and frontend contracts in sync without any manual duplication.

php artisan ts:generate

// resources/types/api-request.ts — auto-generated

export interface StoreUserRequest {
  name: string;
  email: string;
  age: number | null;
  bio?: string;
}

Requirements

• PHP 8.2+
• Laravel 11 or 12

Installation

Install via Composer:

composer require jdiassdev/laravel-types-gen

The service provider is registered automatically via Laravel's package discovery. No additional setup required.

Usage

Run the artisan command from your project root:

php artisan ts:generate

Two files are generated inside resources/types/:

How it works

The package performs static analysis — it reads your PHP files directly without instantiating any class or booting the framework. This means it is safe to run at any point, including CI pipelines.

FormRequests

Both rule formats are supported.

String style

public function rules(): array
{
    return [
        'name'  => 'required|string',
        'email' => 'required|email',
        'age'   => 'required|integer|nullable',
        'bio'   => 'string',
    ];
}

Array style

public function rules(): array
{
    return [
        'name'  => ['required', 'string'],
        'tags'  => ['required', 'array'],
    ];
}

Generated output:

export interface StoreUserRequest {
  name: string;
  email: string;
  age: number | null;
  bio?: string;   // no `required` → optional
  tags: any[];
}

Fields that do not have the required rule are emitted as optional (field?: type).

Nested fields

Dot-notation fields are converted into nested TypeScript objects and arrays.

public function rules(): array
{
    return [
        'address.city'   => 'required|string',
        'address.street' => 'string',
        'items.*.name'   => 'required|string',
        'items.*.qty'    => 'required|integer',
    ];
}

export interface StoreOrderRequest {
  address: {
    city: string;
    street?: string;
  };
  items: {
    name: string;
    qty: number;
  }[];
}

API Resources

The package reads the return array of toArray() and extracts the field names. Since values depend on runtime data, all resource fields default to any.

public function toArray(Request $request): array
{
    return [
        'id'         => $this->id,
        'name'       => $this->name,
        'email'      => $this->email,
        'created_at' => $this->created_at,
    ];
}

export interface UserResource {
  id: any;
  name: any;
  email: any;
  created_at: any;
}

Type mapping

Configuration

The output path can be customized. Publish the config file:

php artisan vendor:publish --tag=laravel-types-gen-config

// config/laravel-types-gen.php

return [
    /*
    |--------------------------------------------------------------------------
    | Output Path
    |--------------------------------------------------------------------------
    |
    | The directory where the generated TypeScript files will be written.
    | Both api-request.ts and api-resource.ts are placed inside this path.
    |
    */
    'output_path' => resource_path('types'),
];

Testing

composer test

Changelog

Please see CHANGELOG for information on recent changes.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

If you discover a security vulnerability, please review our security policy and report it responsibly.

Credits

• João Dias
• All Contributors

License

The MIT License. Please see LICENSE for more information.