create-lyrajs 1.1.3 → 2.0.1

package/README.md

@@ -31,20 +31,44 @@ When developers run `npm create lyrajs`, this tool copies the template folder to
    - JWT token generation (access + refresh tokens)
    - Password hashing with bcrypt
    - Protected routes via configuration
+   - Enhanced with dependency injection 🆕
 
 2. **User Management**
    - User entity with role support
    - UserRepository with custom queries
-   - UserController with CRUD operations
-   - Complete user routes
+   - UserController with CRUD operations and decorator support 🆕
+   - Flexible routing (traditional routes or decorators) 🆕
 
 3. **Database Setup**
    - MySQL/MariaDB configuration
-   - Migration system ready to use
+   - Migration system with backup/restore 🆕
    - Example entity (User)
-   - Fixture system for seed data
-
-4. **Configuration Files**
+   - Enhanced fixture system with dependencies 🆕
+
+4. **Server-Side Rendering (SSR)** 🆕
+   - JSX/TSX template engine configured
+   - Example template files
+   - Layout system for consistent page structure
+   - Ready to use for HTML responses
+
+5. **Job Scheduling** 🆕
+   - Pre-configured scheduler system
+   - Example job with cron schedule
+   - Timezone support
+   - Jobs auto-discovered from `src/jobs/`
+
+6. **Static Assets** 🆕
+   - Public directory for static files
+   - Configured static file serving
+   - Ready for images, CSS, fonts, etc.
+
+7. **Dependency Injection** 🆕
+   - DI container configured
+   - Third-party libraries registered (bcrypt, jwt)
+   - Auto-injection in controllers and services
+   - Singleton service management
+
+8. **Configuration Files**
    - `database.yaml` - Database connection settings
    - `security.yaml` - JWT and access control rules
    - `router.yaml` - API base path configuration
@@ -52,46 +76,55 @@ When developers run `npm create lyrajs`, this tool copies the template folder to
    - `mailer.yaml` - Email service settings
    - `.env` - Environment variables
 
-5. **Project Structure**
+9. **Project Structure**
    - TypeScript configuration
    - ESLint and Prettier setup
-   - Organized folder structure (controller, entity, repository, router, etc.)
-   - Example code demonstrating patterns
+   - Organized folder structure with new v2 directories
+   - Example code demonstrating both traditional and modern patterns
 
-6. **Development Tools**
+10. **Development Tools**
    - Hot reload with `npm run dev`
    - Build scripts
    - Type definitions
    - Path aliases configured
+   - Enhanced CLI with new commands 🆕
 
 ### Project Structure
 
 ```
 my-project/
 ├── src/
-│   ├── controller/        # HTTP request handlers
+│   ├── controller/        # HTTP controllers (decorator or traditional)
 │   │   ├── AuthController.ts    # Registration, login, logout
 │   │   └── UserController.ts    # User CRUD operations
 │   ├── entity/            # Database models
 │   │   └── User.ts              # User entity with decorators
 │   ├── repository/        # Data access layer
 │   │   └── UserRepository.ts    # User database operations
-│   ├── router/            # Route definitions
+│   ├── router/            # Route definitions (traditional routing)
 │   │   ├── index.ts             # Main router setup
 │   │   └── routes/
 │   │       ├── authRoutes.ts    # Auth endpoints
 │   │       └── userRoutes.ts    # User endpoints
-│   ├── middleware/        # Custom middleware
-│   │   └── YourMiddleware.ts    # Example middleware
 │   ├── services/          # Business logic services
 │   │   └── YourService.ts       # Example service
+│   ├── middleware/        # Custom middleware
+│   │   └── YourMiddleware.ts    # Example middleware
+│   ├── jobs/              # 🆕 Scheduled jobs
+│   │   └── ExampleJob.ts        # Example cron job
+│   ├── templates/         # 🆕 SSR templates (JSX/TSX)
+│   │   ├── ExampleRender.tsx    # Example template
+│   │   ├── layout/              # Layout templates
+│   │   └── README.md            # Template documentation
 │   ├── fixtures/          # Seed data
 │   │   └── AppFixtures.ts       # Sample user data
 │   ├── tests/             # Test files
 │   │   └── exemple.test.ts      # Example test
 │   ├── types/             # TypeScript types
 │   │   └── ExempleType.ts       # Example types
-│   └── server.ts          # Application entry point
+│   └── server.ts          # Application entry point (updated for v2)
+├── public/                # 🆕 Static assets
+│   └── assets/            # Images, CSS, fonts, etc.
 ├── config/                # YAML configuration files
 │   ├── database.yaml
 │   ├── router.yaml
@@ -99,6 +132,8 @@ my-project/
 │   ├── parameters.yaml
 │   └── mailer.yaml
 ├── migrations/            # SQL migration files
+├── backups/               # 🆕 Database backups
+├── logs/                  # 🆕 Application logs
 ├── .env                   # Environment variables
 ├── .prettierrc            # Code formatting rules
 ├── eslint.config.js       # Linting configuration
@@ -107,6 +142,8 @@ my-project/
 └── README.md              # Project documentation
 ```
 
+> **Note:** LyraJS v2 supports both traditional routing (`src/router/`) and decorator-based routing. Choose the approach that works best for your project.
+
 ## Usage
 
 ### Create a New Project
@@ -183,6 +220,8 @@ The template includes these working endpoints:
 - `PATCH /api/user/:id` - Update user
 - `DELETE /api/user/:id` - Delete user
 
+> **Note:** In v2, you can define these routes either with traditional route files or using decorators directly in controllers (`@Get`, `@Post`, etc.).
+
 ## Contributing
 
 We welcome contributions to improve the template! Here's how you can help:
@@ -335,8 +374,7 @@ LyraJS is licensed under the [GPL-3.0 License](./LICENSE).
 
 ## Authors
 
-- **Matthieu Fergola** - Core Developer
-- **Anthony Dewitte** - Core Developer
+- Matthieu Fergola
 
 ## Acknowledgments
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-lyrajs",
-  "version": "1.1.3",
+  "version": "2.0.1",
   "description": "CLI tool to create new LyraJS projects",
   "keywords": [
     "create",
@@ -12,7 +12,7 @@
     "cli",
     "scaffold"
   ],
-  "author": "Matthieu Fergola & Anthony Dewitte",
+  "author": "Matthieu Fergola",
   "license": "GPL-3.0",
   "repository": {
     "type": "git",

package/template/backups/README.md

@@ -0,0 +1,93 @@
+# Database Backups
+
+This directory stores automatic database backups created by the LyraJS migration system.
+
+## Purpose
+
+The `backups/` folder contains SQL dump files that serve as safety checkpoints for your database. These backups are automatically created before destructive migration operations to ensure data can be recovered if needed.
+
+## When Backups Are Created
+
+Backups are automatically generated in the following scenarios:
+
+- **Before destructive migrations**: When running migrations marked as `isDestructive = true`
+- **Before rollback operations**: When using `maestro migration:rollback`
+- **Before refresh operations**: When using `maestro migration:refresh`
+- **Before fresh migrations**: When using `maestro migration:fresh`
+
+## Backup File Format
+
+Backup files follow this naming convention:
+
+```
+backup_YYYY-MM-DD_HH-MM-SS_<version>.sql
+```
+
+Example: `backup_2026-01-05_14-30-45_1767607917120.sql`
+
+Where:
+- **Date/Time**: Timestamp of when the backup was created
+- **Version**: Migration version number associated with the backup
+
+## Managing Backups
+
+### List All Backups
+
+```bash
+npx maestro list:backups
+```
+
+### Restore a Backup
+
+```bash
+npx maestro restore:backup <filename>
+```
+
+Example:
+```bash
+npx maestro restore:backup backup_2026-01-05_14-30-45_1767607917120.sql
+```
+
+### Clean Up Old Backups
+
+```bash
+npx maestro cleanup:backups --days=30
+```
+
+This removes backups older than 30 days (default: 7 days).
+
+## Best Practices
+
+1. **Keep backups**: Don't delete backups immediately after migrations succeed
+2. **Regular cleanup**: Use `cleanup:backups` to manage disk space
+3. **External backups**: Consider copying important backups to external storage
+4. **Test restores**: Periodically test backup restoration in development
+
+## Storage Considerations
+
+- Backup files can be large depending on database size
+- Regular cleanup is recommended to prevent disk space issues
+- The migration system tracks backup paths in the `migrations` table
+
+## Security
+
+- Backup files contain your complete database schema and data
+- Keep this directory secure and excluded from version control
+- The `.gitignore` should include `backups/*.sql`
+
+## Related Commands
+
+```bash
+# View migration status with backup information
+npx maestro migration:status
+
+# Run migration with automatic backup
+npx maestro migration:migrate
+
+# Rollback with automatic backup
+npx maestro migration:rollback
+```
+
+---
+
+For more information, visit the [LyraJS Documentation](https://lyrajs.dev/).

package/template/config/security.yaml

@@ -14,7 +14,6 @@ security:
     max_attempts: 5
     message: 'Too many login attempts, please try again later'
   access_control:
-    - { path: /api/auth/sign-out, roles: [ROLE_USER] }
     - { path: /api/auth/user, roles: [ROLE_USER] }
     - { path: /api/admin, roles: [ROLE_ADMIN] }
   role_hierarchy:

package/template/migrations/README.md

@@ -0,0 +1,247 @@
+# Database Migrations
+
+This directory contains database migration files that track and version your database schema changes.
+
+## Purpose
+
+The `migrations/` folder stores TypeScript migration files that define how your database schema evolves over time. Each migration represents a specific change to your database structure.
+
+## What Are Migrations?
+
+Migrations are version control for your database. They allow you to:
+
+- **Track schema changes**: Every database modification is recorded
+- **Collaborate safely**: Team members can sync database changes through version control
+- **Rollback changes**: Undo migrations if something goes wrong
+- **Deploy consistently**: Apply the same schema changes across environments
+
+## Migration File Structure
+
+Migration files follow this naming convention:
+
+```
+Migration_<timestamp>.ts
+```
+
+Example: `Migration_1767607917120.ts`
+
+Each migration file implements the `MigrationInterface` with three methods:
+
+```typescript
+import { MigrationInterface } from "@lyra-js/core"
+
+export class Migration_1767607917120 implements MigrationInterface {
+  readonly version = "1767607917120"
+  readonly isDestructive = false
+  readonly canRunInParallel = false
+
+  async up(connection: any): Promise<void> {
+    // SQL to apply the migration
+  }
+
+  async down(connection: any): Promise<void> {
+    // SQL to undo the migration
+  }
+
+  async dryRun(connection: any): Promise<string[]> {
+    // Return SQL statements for preview
+  }
+}
+```
+
+## Generating Migrations
+
+### Automatic Generation (Recommended)
+
+LyraJS automatically detects schema changes by comparing your entities to the database:
+
+```bash
+npx maestro make:migration
+```
+
+This command:
+1. Introspects your current database schema
+2. Compares it with your entity definitions
+3. Generates migration code for detected differences
+4. Includes smart rename detection to prevent data loss
+
+### Manual Migration
+
+For complex operations, you can create migrations manually by copying the file structure above.
+
+## Running Migrations
+
+### Apply Pending Migrations
+
+```bash
+npx maestro migration:migrate
+```
+
+### View Migration Status
+
+```bash
+npx maestro migration:status
+```
+
+### Rollback Last Migration
+
+```bash
+npx maestro migration:rollback
+```
+
+### Rollback Multiple Migrations
+
+```bash
+npx maestro migration:rollback --steps=3
+```
+
+### Fresh Installation (⚠️ Destructive)
+
+Drops all tables and re-runs all migrations:
+
+```bash
+npx maestro migration:fresh
+```
+
+### Refresh Database (⚠️ Destructive)
+
+Rolls back all migrations and re-runs them:
+
+```bash
+npx maestro migration:refresh
+```
+
+## Migration Squashing
+
+For mature projects with many migrations, you can combine them into a single baseline migration:
+
+```bash
+# Squash all executed migrations
+npx maestro migration:squash
+
+# Squash up to a specific version
+npx maestro migration:squash --to=1767607917120
+```
+
+Squashed migrations:
+- Reduce migration count for fresh installations
+- Improve migration performance
+- Keep the migrations folder organized
+- Mark old migrations as archived
+
+## Migration Features
+
+### Smart Rename Detection
+
+The migration generator can detect when columns or tables are renamed (instead of dropped and recreated):
+
+```
+? Detected potential rename: firstname -> first_name (85% confidence)
+  Do you want to rename instead of drop+create? (Y/n)
+```
+
+### Automatic Backups
+
+Backups are automatically created before destructive operations:
+- The backup is saved to `backups/backup_YYYY-MM-DD_HH-MM-SS_<version>.sql`
+- Tracked in the migrations table for easy restoration
+
+### Migration Batching
+
+Migrations are organized in batches, making it easy to rollback related changes together.
+
+### Parallel Execution
+
+Some migrations can run in parallel for better performance (set `canRunInParallel = true`).
+
+## Best Practices
+
+1. **Never modify executed migrations**: Create new migrations for changes
+2. **Test migrations**: Always test in development before production
+3. **Write reversible migrations**: Ensure `down()` properly undoes `up()`
+4. **Use transactions**: Migrations run in transactions by default
+5. **Keep migrations small**: One logical change per migration
+6. **Review generated SQL**: Check auto-generated migrations before running
+7. **Version control**: Commit migration files to your repository
+
+## Common Operations
+
+### Adding a Column
+
+```bash
+# 1. Add column to your entity
+# 2. Generate migration
+npx maestro make:migration
+
+# 3. Review and run
+npx maestro migration:migrate
+```
+
+### Creating a Table
+
+```bash
+# 1. Create entity class
+# 2. Generate migration
+npx maestro make:migration
+
+# 3. Run migration
+npx maestro migration:migrate
+```
+
+### Renaming a Column
+
+```bash
+# 1. Rename field in entity
+# 2. Generate migration (will detect rename)
+npx maestro make:migration
+
+# 3. Confirm rename when prompted
+# 4. Run migration
+npx maestro migration:migrate
+```
+
+## Troubleshooting
+
+### Migration Failed
+
+If a migration fails:
+1. Check the error message
+2. Fix the migration file or database state
+3. Rollback if needed: `npx maestro migration:rollback`
+4. Re-run: `npx maestro migration:migrate`
+
+### Out of Sync
+
+If your database is out of sync with migrations:
+1. Use `npx maestro migration:status` to check state
+2. Manually fix the database or migrations table
+3. Or use `npx maestro migration:fresh` (⚠️ destroys data)
+
+### Restore from Backup
+
+If something goes wrong:
+
+```bash
+npx maestro list:backups
+npx maestro restore:backup <filename>
+```
+
+## Related Commands
+
+```bash
+# Show all controllers
+npx maestro show:controllers
+
+# Show all entities
+npx maestro show:entities
+
+# Show all migrations
+npx maestro show:migrations
+
+# Show database structure
+npx maestro show:routes
+```
+
+---
+
+For more information, visit the [LyraJS Documentation](https://lyrajs.dev/).

package/template/package.json

@@ -7,13 +7,11 @@
     "maestro": "maestro"
   },
   "dependencies": {
-    "@lyra-js/core": "^1.1.3",
+    "@lyra-js/core": "^2.0.1",
     "bcrypt": "^6.0.0",
-    "cookie-parser": "^1.4.7",
     "cors": "^2.8.5",
     "dotenv": "^16.5.0",
-    "express": "^5.1.0",
-    "express-rate-limit": "^8.2.1",
+    "esbuild": "^0.27.2",
     "jsonwebtoken": "^9.0.2",
     "mysql2": "^3.14.1",
     "nodemailer": "^7.0.7",
@@ -22,9 +20,7 @@
   },
   "devDependencies": {
     "@types/bcrypt": "^5.0.2",
-    "@types/cookie-parser": "^1.4.8",
     "@types/cors": "^2.8.18",
-    "@types/express": "^5.0.1",
     "@types/jsonwebtoken": "^9.0.9",
     "@types/node": "^22.15.17",
     "@types/nodemailer": "^6.4.17",

package/template/public/assets/styles/app.css

@@ -0,0 +1,158 @@
+* {
+    box-sizing: border-box;
+}
+
+html, body {
+    margin: 0;
+    padding: 0;
+}
+
+html {
+    font-size: 62.5%;
+}
+
+body {
+    background-color: #1f202a;
+    color: #dedff6;
+    font-size: 1.8rem;
+    font-family: sans-serif;
+    text-align: center;
+}
+
+h1 {
+    font-size: 5rem;
+}
+
+a {
+    color: #ffad70;
+    text-decoration: none;
+    transition: color .2s;
+}
+
+a:hover {
+    color: #ff657d;
+    transition: color .2s;
+}
+
+header {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: center;
+    height: 7rem;
+    box-shadow: 0 4px 6px -1px #0000001a,0 2px 4px -2px #0000001a;
+}
+
+header nav {
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+}
+
+header nav a {
+    margin: .5rem 1rem;
+}
+
+header nav a:not(:last-of-type)::after {
+    content: "|";
+    margin-left: 2rem;
+    color: #dedff6;
+}
+
+main {
+    height: calc(100vh - 14rem);
+    align-items: center;
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+}
+
+main > section {
+    width: 50%;
+}
+
+footer {
+    display: flex;
+    flex-flow: row wrap;
+    align-items: center;
+    justify-content: center;
+    height: 7rem;
+}
+
+footer > p {
+    margin: 0;
+    padding-top: 1.3rem;
+    border-top: 1px solid #dedff61a;
+    width: 60%;
+}
+
+footer span {
+    color: #ef4444;
+    margin: 0 .5rem;
+}
+
+footer a {
+    color: #dedff6;
+}
+
+footer a:hover {
+    color: #dedff6;
+    text-decoration: underline;
+}
+
+.logo {
+    width: fit-content;
+    margin: 0 auto;
+}
+
+.logo > img {
+    max-height: 180px;
+}
+
+.text-gradient {
+    background-color: #ffad70;
+    background-image: linear-gradient(45deg, #ffad70, #ff657d);
+    -webkit-background-clip: text;
+    -webkit-text-fill-color: transparent;
+    -moz-background-clip: text;
+    -moz-text-fill-color: transparent;
+    background-clip: text;
+    width: fit-content;
+    padding-bottom: .2em;
+    margin: 0 auto;
+}
+
+.doc-links {
+    margin-top: 6rem;
+}
+
+.btn, .btn-outline {
+    font-weight: 700;
+    font-size: 2rem;
+    border-radius: 3.4rem;
+    margin: 1rem;
+    padding: 2rem 2rem;
+    transition: all .2s;
+}
+
+.btn {
+    color: oklch(15.092% .036 346.812);
+    background-color: #ffad70;
+}
+
+.btn:hover {
+    color: oklch(15.092% .036 346.812);
+    background-color: #c68755;
+    transition: all .2s;
+}
+
+.btn-outline {
+    color: #ffad70;
+    border: 1px solid #ffad70;
+}
+
+.btn-outline:hover {
+    color: oklch(15.092% .036 346.812);
+    background-color: #ffad70;
+    transition: all .2s;
+}