@famgia/omnify-laravel 0.0.68 → 0.0.70

package/ai-guides/laravel-guide.md

@@ -2,9 +2,23 @@
 
 This guide covers Laravel-specific features and generated code patterns for Omnify.
 
+## Quick Start
+
+```bash
+# Create new Laravel project (recommended)
+npx @famgia/omnify create-laravel-project my-app
+cd my-app
+
+# Or initialize in existing project
+npx @famgia/omnify init
+
+# Generate Laravel migrations and models
+npx @famgia/omnify generate
+```
+
 ## Generated Files
 
-When you run `npx omnify generate`, the following Laravel files are generated:
+When you run `npx @famgia/omnify generate`, the following Laravel files are generated:
 
 ### Migrations
 - `database/migrations/omnify/*.php` - Laravel migrations for each schema
@@ -19,6 +33,9 @@ When you run `npx omnify generate`, the following Laravel files are generated:
 ### Locales
 - `app/Models/OmnifyBase/Locales/{ModelName}Locales.php` - i18n display names
 
+### Service Provider
+- `app/Providers/OmnifyServiceProvider.php` - Morph map registration (configurable path)
+
 ## Model Structure
 
 ```php
@@ -56,6 +73,122 @@ class UserBaseModel extends Model
 }
 ```
 
+## Schema Options
+
+### Hidden Schemas (System Tables)
+
+For system tables that only need migrations (no models), use `hidden: true`:
+
+```yaml
+# schemas/system/Cache.yaml
+name: AppCache
+options:
+  id: false
+  timestamps: false
+  hidden: true           # Skip model generation
+  tableName: cache       # Use Laravel's default cache table name
+properties:
+  key:
+    type: String
+    primary: true
+  value:
+    type: MediumText
+  expiration:
+    type: Int
+```
+
+Use cases for `hidden: true`:
+- Laravel cache tables (`cache`, `cache_locks`)
+- Job queues (`jobs`, `failed_jobs`)
+- Session tables
+- System tables that don't need application models
+
+### Custom Table Name
+
+Override the auto-generated table name:
+
+```yaml
+name: AppCache
+options:
+  tableName: cache       # Use 'cache' instead of 'app_caches'
+```
+
+### Soft Delete
+
+```yaml
+options:
+  softDelete: true  # Adds deleted_at column and SoftDeletes trait
+```
+
+### Timestamps
+
+```yaml
+options:
+  timestamps: true  # Adds created_at, updated_at columns (default: true)
+```
+
+### Custom ID Type
+
+```yaml
+options:
+  idType: Uuid     # BigInt (default), Int, Uuid, String
+```
+
+### No Auto ID
+
+```yaml
+options:
+  id: false        # For tables with custom primary key
+```
+
+## Property Types
+
+### String Types
+
+| Type | Description | MySQL Column |
+|------|-------------|--------------|
+| `String` | Short text (default 255) | `VARCHAR(length)` |
+| `Text` | Text (~65KB) | `TEXT` |
+| `MediumText` | Medium text (~16MB) | `MEDIUMTEXT` |
+| `LongText` | Long text (~4GB) | `LONGTEXT` |
+
+### Numeric Types
+
+| Type | Description | MySQL Column |
+|------|-------------|--------------|
+| `TinyInt` | 8-bit (-128~127) | `TINYINT` |
+| `Int` | 32-bit integer | `INT` |
+| `BigInt` | 64-bit integer | `BIGINT` |
+| `Float` | Floating point | `FLOAT` |
+| `Decimal` | Precise decimal | `DECIMAL(p,s)` |
+
+### Date/Time Types
+
+| Type | Description | MySQL Column |
+|------|-------------|--------------|
+| `Date` | Date only | `DATE` |
+| `DateTime` | Date and time | `DATETIME` |
+| `Timestamp` | Timestamp | `TIMESTAMP` |
+
+### Timestamp with useCurrent
+
+```yaml
+properties:
+  created_at:
+    type: Timestamp
+    useCurrent: true           # Default to CURRENT_TIMESTAMP
+  updated_at:
+    type: Timestamp
+    useCurrent: true
+    useCurrentOnUpdate: true   # Auto-update on row change
+```
+
+Generated migration:
+```php
+$table->timestamp('created_at')->useCurrent();
+$table->timestamp('updated_at')->useCurrent()->useCurrentOnUpdate();
+```
+
 ## Localization (i18n)
 
 ### Display Names
@@ -69,7 +202,6 @@ User::getLocalizedPropertyDisplayName('email');
 
 ### Schema Definition
 ```yaml
-# yaml-language-server: $schema=./node_modules/.omnify/combined-schema.json
 name: User
 displayName:
   ja: ユーザー
@@ -84,7 +216,7 @@ properties:
 
 ## Relationships
 
-### ManyToOne
+### ManyToOne (BelongsTo)
 ```yaml
 # In Post schema
 author:
@@ -96,14 +228,13 @@ author:
 
 Generated:
 ```php
-// PostBaseModel.php
 public function author(): BelongsTo
 {
     return $this->belongsTo(User::class);
 }
 ```
 
-### OneToMany
+### OneToMany (HasMany)
 ```yaml
 # In User schema
 posts:
@@ -115,16 +246,14 @@ posts:
 
 Generated:
 ```php
-// UserBaseModel.php
 public function posts(): HasMany
 {
     return $this->hasMany(Post::class, 'author_id');
 }
 ```
 
-### ManyToMany
+### ManyToMany (BelongsToMany)
 ```yaml
-# In Post schema
 tags:
   type: Association
   relation: ManyToMany
@@ -138,7 +267,6 @@ tags:
 
 Generated:
 ```php
-// PostBaseModel.php
 public function tags(): BelongsToMany
 {
     return $this->belongsToMany(Tag::class, 'post_tags')
@@ -146,25 +274,19 @@ public function tags(): BelongsToMany
 }
 ```
 
-## Migration Options
-
-### Soft Delete
+### MorphTo (Polymorphic)
 ```yaml
-options:
-  softDelete: true  # Adds deleted_at column and SoftDeletes trait
+# Comment can belong to Post or Video
+commentable:
+  type: Association
+  relation: MorphTo
+  targets: [Post, Video]
+  nullable: true           # Default: true
 ```
 
-### Timestamps
-```yaml
-options:
-  timestamps: true  # Adds created_at, updated_at columns
-```
-
-### Custom Table Name
-```yaml
-options:
-  table: custom_table_name
-```
+Generated columns:
+- `commentable_type` (enum: 'Post', 'Video')
+- `commentable_id` (bigint, nullable)
 
 ## Enum Support
 
@@ -191,32 +313,149 @@ Generated migration:
 $table->enum('status', ['draft', 'published', 'archived'])->default('draft');
 ```
 
+## Configuration
+
+```typescript
+// omnify.config.ts
+import { defineConfig } from '@famgia/omnify';
+import laravel from '@famgia/omnify-laravel/plugin';
+
+export default defineConfig({
+  schemasDir: './schemas',
+  lockFilePath: './.omnify.lock',
+
+  database: {
+    driver: 'mysql',
+    devUrl: 'mysql://root:password@localhost:3306/dev_db',
+  },
+
+  plugins: [
+    laravel({
+      // Migration output path
+      migrationsPath: 'database/migrations/omnify',
+
+      // Model output paths
+      modelsPath: 'app/Models',
+      baseModelsPath: 'app/Models/OmnifyBase',
+
+      // Service provider path (for morph map)
+      providersPath: 'app/Providers',
+
+      // Locales path
+      localesPath: 'app/Models/OmnifyBase/Locales',
+    }),
+  ],
+});
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `migrationsPath` | `string` | `database/migrations/omnify` | Laravel migrations output |
+| `modelsPath` | `string` | `app/Models` | Model classes output |
+| `baseModelsPath` | `string` | `app/Models/OmnifyBase` | Base model classes output |
+| `providersPath` | `string` | `app/Providers` | Service provider output |
+| `localesPath` | `string` | `app/Models/OmnifyBase/Locales` | Locale files output |
+
 ## Commands
 
 ```bash
+# Create new Laravel project
+npx @famgia/omnify create-laravel-project my-app
+
 # Generate Laravel migrations and models
-npx omnify generate
+npx @famgia/omnify generate
 
 # Force regenerate all files
-npx omnify generate --force
+npx @famgia/omnify generate --force
+
+# Only generate migrations
+npx @famgia/omnify generate --migrations-only
 
 # Validate schemas
-npx omnify validate
+npx @famgia/omnify validate
+
+# Show pending changes
+npx @famgia/omnify diff
+
+# Reset all generated files
+npx @famgia/omnify reset
 ```
 
-## Configuration
+## Examples
 
-```typescript
-// omnify.config.ts
-import { defineConfig } from '@famgia/omnify';
+### System Table (Cache)
 
-export default defineConfig({
-  schemasDir: './schemas',
-  output: {
-    laravel: {
-      migrationsPath: './database/migrations/omnify',
-      modelsPath: './app/Models',
-    },
-  },
-});
+```yaml
+# schemas/system/AppCache.yaml
+name: AppCache
+options:
+  id: false
+  timestamps: false
+  hidden: true
+  tableName: cache
+properties:
+  key:
+    type: String
+    length: 255
+    primary: true
+  value:
+    type: MediumText
+  expiration:
+    type: Int
+```
+
+### User with Authenticatable
+
+```yaml
+# schemas/User.yaml
+name: User
+displayName:
+  ja: ユーザー
+  en: User
+options:
+  softDelete: true
+  authenticatable: true
+properties:
+  name:
+    type: String
+    displayName:
+      ja: 氏名
+      en: Full Name
+  email:
+    type: Email
+    unique: true
+  password:
+    type: Password
+```
+
+### Post with Relations
+
+```yaml
+# schemas/Post.yaml
+name: Post
+displayName:
+  ja: 投稿
+  en: Post
+options:
+  softDelete: true
+properties:
+  title:
+    type: String
+  content:
+    type: LongText
+  status:
+    type: EnumRef
+    enum: PostStatus
+    default: draft
+  author:
+    type: Association
+    relation: ManyToOne
+    target: User
+    onDelete: CASCADE
+  tags:
+    type: Association
+    relation: ManyToMany
+    target: Tag
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@famgia/omnify-laravel",
-  "version": "0.0.68",
+  "version": "0.0.70",
   "description": "Laravel migration and TypeScript type generator for omnify-schema",
   "type": "module",
   "main": "./dist/index.js",
@@ -25,9 +25,9 @@
     "README.md"
   ],
   "dependencies": {
-    "@famgia/omnify-types": "0.0.57",
-    "@famgia/omnify-core": "0.0.59",
-    "@famgia/omnify-atlas": "0.0.53"
+    "@famgia/omnify-types": "0.0.59",
+    "@famgia/omnify-core": "0.0.61",
+    "@famgia/omnify-atlas": "0.0.55"
   },
   "scripts": {
     "build": "tsup",