Search by

hemilrajput / laravel-typegen

hemilrajput

Generate TypeScript types from Eloquent models, Enums & FormRequests.

Package info

github.com/hemilrajput/laravel-typegen

pkg:composer/hemilrajput/laravel-typegen

Statistics

Installs: 48

Dependents: 0

Suggesters: 0

Stars: 2

Open Issues: 0

v2.3.2 2026-10-31 16:27 UTC

README

Laravel TypeGen — one artisan command turns your Eloquent models, Enums, and FormRequests into a single typed .ts file. No more hand-syncing PHP and TypeScript.

📖 Documentation

For complete documentation, guides, and setup instructions, visit laravel-typegen.github.io.

Why Laravel TypeGen?

  • Keeps types in sync: Automatically reflect changes in your PHP models in your TypeScript interfaces. Generate TypeScript types from Eloquent models, Enums, and FormRequests. Built for the Laravel 13 + Inertia + React/Vue stack.

⚡️ The Killer Feature: Synchronized Types

Laravel TypeGen doesn't just generate standalone interfaces. It understands your application's logic.

PHP Enum + Model Cast:

enum UserRole: string {
    case Admin = 'admin';
}

class User extends Model {
    protected $casts = ['role' => UserRole::class];
}

TypeScript Output:

export type UserRole = 'admin';

export interface User {
    id: number;
    role: UserRole; // Automatically linked!
}

🚀 Features

  • Eloquent Models: Generates interfaces from $fillable, $casts, and timestamps.
  • Enums: Generates union types from backed and pure PHP enums.
  • FormRequests & Zod: Generates request DTOs from your rules() method and compiles them to Zod schemas for client-side validation.
  • API Resources: Transforms Laravel JsonResources into TypeScript representations.
  • Routes & Ziggy: Generates strict types for named routes.
  • VS Code Extension: Auto-generates types on file save.
  • NPM Helpers: First-party @hemilrajput/laravel-typegen-helpers package for PaginatedResponse, InertiaForm, etc.
  • Attribute-Driven: Opt-in to generation using the #[TypeScript] attribute.
  • Zero-Config: Smart defaults for standard Laravel projects.

📊 Comparison

Feature TypeGen Spatie TS Transformer
Eloquent Support ✅ ✅
Enum Support ✅ ✅
FormRequest → DTO & Zod ✅ ❌
API Resources ✅ ❌
Relationship Auto-Discovery ✅ ❌
Linked Enum Casts ✅ ⚠️ (Manual)
Attribute Driven ✅ ✅
Inertia Native & NPM Helpers ✅ ⚠️
VS Code Extension ✅ ❌

📦 Installation

composer require hemilrajput/laravel-typegen

Requires PHP ^8.2 and Laravel ^11.0|^12.0|^13.0.

🛠 Usage

1. Tag your classes

use Hemilrajput\TypeGen\Attributes\TypeScript;

#[TypeScript]
class User extends Model { ... }

2. Generate

php artisan typescript:generate

🔗 Relationships

Opt into relationship type generation per-model:

#[TypeScript(includeRelations: ['posts', 'profile'])]
class User extends Model { /* ... */ }

Related models (Post, Profile) are auto-discovered — no need to mark them separately. Generated output:

export interface User {
  id: number;
  posts?: Post[];
  profile?: Profile | null;
}

export interface Post { /* ... */ }
export interface Profile { /* ... */ }

Relations are always emitted as optional (?) because they're only present when eager-loaded. This matches runtime reality.

Polymorphic relations

MorphTo is auto-supported when you register a morph map:

Relation::enforceMorphMap([
    'post' => Post::class,
    'video' => Video::class,
]);

Generates:

export interface Comment {
  commentable?: (Post | Video) | null;
}

Without a morph map, emits unknown | null with a comment.

🗺 Roadmap

  • v2.3.1: AST Resource extraction, DB-less CI fallback (--skip-db-check), Ziggy route typing.
  • v2.3.2: Release process hardening (gated tag CI), security policy, metadata consistency, and .gitattributes.
  • v2.4.0: CI hardening (PHP 8.5, prefer-lowest, Windows, coverage baseline), contract tests (tsc --strict compilation on generated output), deprecation warnings.
  • v3.0.0-rc.1 / v3.0.0: Minimum PHP 8.3, Laravel 12/13 baseline, opt-in/auto-detected Ziggy vs Wayfinder interop, frozen public API.

Configuration

See config/typegen.php for all available options, including:

  • Output path and style (interface vs type).
  • Custom cast mapping.
  • Prefix/suffix for generated names.
  • Including/excluding timestamps and hidden fields.

License

MIT