Download the PHP package kiwilan/typescriptable-laravel without Composer
On this page you can find all versions of the php package kiwilan/typescriptable-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kiwilan/typescriptable-laravel
More information about kiwilan/typescriptable-laravel
Files in kiwilan/typescriptable-laravel
Package typescriptable-laravel
Short Description PHP package for Laravel to type Eloquent models, routes, Spatie Settings with autogenerated TypeScript. If you want to use some helpers with Inertia, you can install associated NPM package.
License MIT
Homepage https://github.com/kiwilan/typescriptable-laravel
Informations about the package typescriptable-laravel
Typescriptable for Laravel
PHP package for Laravel to type Eloquent models, routes, Spatie Settings with autogenerated TypeScript.
If you want to use some helpers with Inertia, you can install associated NPM package.
Because you need PHP and Typescript.
Features
- 💽 Supported Laravel drivers: MySQL, MariaDB, PostgreSQL, SQLite, SQL Server, MongoDB
- 💬 Generate TS types for Eloquent models
- 👭 Generate TS types for Eloquent relations
- 🪄 Generate TS types for
casts
(include nativeenum
support) - 📝 Generate TS types for
appends
and allaccessors
Illuminate\Database\Eloquent\Casts\Attribute
with PHPDocget*Attribute
methods
-
️⃣ Generate TS types for
counts
- 📖 Can generate pagination TS types for Laravel pagination
- 💾 Can generate simple PHP classes from Eloquent models
- ⚙️ Generate TS types for
spatie/laravel-settings
- 🛣 Generate TS types for Laravel routes
- Scan route parameters
- For Inertia, you can install
@kiwilan/typescriptable-laravel
NPM package to use some helpers
- ✅ Multiple commands to generate types
php artisan typescriptable
for models, settings and routes (safe even if you don't use all)php artisan typescriptable:eloquent
for Eloquent modelsphp artisan typescriptable:settings
forspatie/laravel-settings
php artisan typescriptable:routes
for Laravel routes
Roadmap
- [ ] Add parser for calebporzio/sushi
- [ ] Add parser for spatie/laravel-permission
Installation
This version requires PHP 8.2+
and supports Laravel 11.
[!WARNING]
Laravel 11 dropped Doctrine DBAL. For previous Laravel versions, you can use
1.12.03
version.
Version | L9 | L10 | L11 |
---|---|---|---|
v3+ | :x: | :x: | :white_check_mark: |
v1.12.03 | :white_check_mark: | :white_check_mark: | :x: |
You can install the package via composer:
With Laravel v11+ and PHP 8.2
With Laravel v9-10 and PHP 8.1
About TypeScript
If you want to use .d.ts
files, you need to use TypeScript in your Laravel project, you have to create a tsconfig.json
file and add .d.ts
paths in include
:
[!NOTE]
If you change paths into config or with options, adapt paths.
Complete `tsconfig.json`
Here is a complete `tsconfig.json` file example (you can adapt paths):About NPM package @kiwilan/typescriptable-laravel
NPM package is fully optional, you can use only PHP package. It's built for Vite with laravel-vite-plugin
and Inertia (only for Vue 3). It's SSR compatible.
This package add some helpers to use Laravel routes fully typed with TypeScript into Vue components and some composables to use with Vue. The best setup to install this package is to use Jetstream, a Laravel starter kit and tightenco/ziggy
is required.
Read full documentation here: @kiwilan/typescriptable-laravel
.
Configuration
You can publish the config file
A config example is available here: config/typescriptable.php.
[!IMPORTANT]
You can configure
engine.eloquent
withartisan
orparser
to change parser engine. By default, it usesartisan
command withmodel:show
command.artisan
is default engine because it's more reliable and faster thanparser
engine. With MongoDB, the engine doesn't matter because MongoDB database can't be parsed like relational databases.
Usage
With options:
- --
M
|models
: Generate Models types. - --
R
|routes
: Generate Routes types. - --
S
|settings
: Generate Settings types.
Eloquent models
Generate resources/js/types-eloquent.d.ts
file with all models types.
Options can be set into config/typescriptable.php
file.
Spatie Settings
If you use spatie/laravel-settings
, you can generate resources/js/types-settings.d.ts
file with all settings types.
Options can be set into config/typescriptable.php
file.
Routes
Generate resources/js/types-routes.d.ts
file with all routes types and resources/js/routes.ts
for routes references.
Options can be set into config/typescriptable.php
file.
Eloquent listing
Show all Eloquent models with eloquent:list
command.
Models are parsed from config/typescriptable.php
with eloquent.directory
variable.
Advanced
MongoDB
kiwilan/typescriptable-laravel
supports MongoDB with mongodb/laravel-mongodb
. Due to the MongoDB structure, Typescript conversion aren't the same as SQL databases, precision is lower. If you want to improve it, you can add an issue.
Database isn't parsed like with relational databases. The package will parse key
, fillable
and hidden
to get all fields. If some fields are missing, you can override them manually. All relations and accessors are supported.
Database prefix
You can use prefix
variable into config/database.php
file.
Override models
kiwilan/typescriptable-laravel
will cover many cases, but if you want to override some models, you can just create a type like resources/js/types/index.ts
and extends Model
type.
And you can import custom type in your code when you need to use advanced type.
Print PHP classes
If you want to print PHP classes, you can use --php-path
option with php artisan typescriptable:eloquent
command.
These classes will be generated from Eloquent models as real PHP classes.
Examples
Check examples documentation.
Testing
Create a .env
file with your database configuration
And you can run tests
[!NOTE]
You can check this gist to have a Docker database configuration.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
- Spatie: for
spatie/package-skeleton-laravel
- Ewilan Riviere: Author package
License
The MIT License (MIT). Please see License File for more information.
All versions of typescriptable-laravel with dependencies
illuminate/contracts Version ^11.0
illuminate/database Version ^11.0
illuminate/support Version ^11.0
spatie/laravel-package-tools Version ^1.16.3