@famgia/omnify-laravel 0.0.18 → 0.0.20

package/README.md

@@ -90,11 +90,13 @@ const types = generateTypeScript(schemas, {
 
 - Laravel migration generation
 - TypeScript interface generation
+- Eloquent model generation with localization support
 - Support for all Laravel column types
 - Relationship handling (belongsTo, hasMany, etc.)
 - Index and constraint generation
 - Enum type support
 - Plugin system with DAG-based generator ordering
+- Multi-language displayName support (i18n)
 
 ## Generated Output
 
@@ -135,6 +137,134 @@ export interface User {
 }
 ```
 
+### Eloquent Models with Localized Display Names
+
+The generator creates a clean model structure with separated locale data:
+
+```
+app/Models/OmnifyBase/
+├── Traits/
+│   └── HasLocalizedDisplayName.php  # Reusable trait
+├── Locales/
+│   ├── UserLocales.php              # User locale data
+│   ├── PostLocales.php              # Post locale data
+│   └── ...
+├── UserBaseModel.php                # Clean base model
+├── PostBaseModel.php
+└── ...
+```
+
+#### Schema Definition with i18n
+
+Define multi-language displayNames in your YAML schema:
+
+```yaml
+# schemas/auth/User.yaml
+name: User
+displayName:
+  ja: ユーザー
+  en: User
+  vi: Người dùng
+
+properties:
+  name:
+    type: String
+    displayName:
+      ja: 氏名
+      en: Full Name
+      vi: Họ tên
+
+  email:
+    type: String
+    unique: true
+    displayName:
+      ja: メールアドレス
+      en: Email Address
+      vi: Địa chỉ email
+```
+
+#### Generated Locales Class
+
+```php
+// app/Models/OmnifyBase/Locales/UserLocales.php
+class UserLocales
+{
+    public const DISPLAY_NAMES = [
+        'ja' => 'ユーザー',
+        'en' => 'User',
+        'vi' => 'Người dùng',
+    ];
+
+    public const PROPERTY_DISPLAY_NAMES = [
+        'name' => [
+            'ja' => '氏名',
+            'en' => 'Full Name',
+            'vi' => 'Họ tên',
+        ],
+        // ...
+    ];
+}
+```
+
+#### Generated Base Model
+
+```php
+// app/Models/OmnifyBase/UserBaseModel.php
+use App\Models\OmnifyBase\Traits\HasLocalizedDisplayName;
+use App\Models\OmnifyBase\Locales\UserLocales;
+
+class UserBaseModel extends Authenticatable
+{
+    use HasLocalizedDisplayName;
+
+    protected static array $localizedDisplayNames = UserLocales::DISPLAY_NAMES;
+    protected static array $localizedPropertyDisplayNames = UserLocales::PROPERTY_DISPLAY_NAMES;
+
+    // ... rest of model
+}
+```
+
+#### Using Localized Display Names in PHP
+
+```php
+// Get model display name (uses Laravel's app()->getLocale())
+User::displayName();           // "ユーザー" (if locale is 'ja')
+User::displayName('en');       // "User"
+User::displayName('vi');       // "Người dùng"
+
+// Get property display name
+User::propertyDisplayName('name');        // "氏名" (if locale is 'ja')
+User::propertyDisplayName('name', 'en');  // "Full Name"
+
+// Get all display names
+User::allDisplayNames();  // ['ja' => 'ユーザー', 'en' => 'User', 'vi' => 'Người dùng']
+
+// Get all property names for current locale
+User::allPropertyDisplayNamesForLocale();  // ['name' => '氏名', 'email' => 'メールアドレス', ...]
+```
+
+#### Locale Configuration
+
+Configure locales in `omnify.config.ts`:
+
+```typescript
+import { defineConfig } from '@famgia/omnify';
+import laravel from '@famgia/omnify-laravel/plugin';
+
+export default defineConfig({
+  schemasDir: './schemas',
+
+  // Locale configuration
+  locale: {
+    locales: ['ja', 'en', 'vi'],
+    defaultLocale: 'ja',
+    fallbackLocale: 'en',
+  },
+
+  plugins: [laravel()],
+});
+```
+
 ## Creating Custom Plugins
 
 You can create your own generator plugins following this pattern:

package/dist/{chunk-H37M25AK.js → chunk-ILSNN7UV.js}

@@ -1122,6 +1122,9 @@ function generateMigrationsFromChanges(changes, options = {}) {
   return migrations;
 }
 
+// src/model/generator.ts
+import { isLocaleMap } from "@famgia/omnify-types";
+
 // src/utils.ts
 function toSnakeCase(str) {
   return str.replace(/([A-Z])/g, "_$1").replace(/^_/, "").toLowerCase();
@@ -1151,6 +1154,45 @@ var DEFAULT_OPTIONS = {
   baseModelPath: "app/Models/OmnifyBase",
   modelPath: "app/Models"
 };
+function generateLocalizedDisplayNames(displayName, indent = "        ") {
+  if (displayName === void 0) {
+    return "";
+  }
+  if (typeof displayName === "string") {
+    return `${indent}'en' => '${escapePhpString(displayName)}',`;
+  }
+  if (isLocaleMap(displayName)) {
+    const entries = Object.entries(displayName).map(([locale, value]) => `${indent}'${locale}' => '${escapePhpString(value)}',`).join("\n");
+    return entries;
+  }
+  return "";
+}
+function generatePropertyLocalizedDisplayNames(schema, indent = "        ") {
+  const properties = schema.properties ?? {};
+  const entries = [];
+  for (const [propName, propDef] of Object.entries(properties)) {
+    const snakeName = toSnakeCase(propName);
+    const displayName = propDef.displayName;
+    if (displayName === void 0) {
+      continue;
+    }
+    const innerIndent = indent + "    ";
+    if (typeof displayName === "string") {
+      entries.push(`${indent}'${snakeName}' => [
+${innerIndent}'en' => '${escapePhpString(displayName)}',
+${indent}],`);
+    } else if (isLocaleMap(displayName)) {
+      const localeEntries = Object.entries(displayName).map(([locale, value]) => `${innerIndent}'${locale}' => '${escapePhpString(value)}',`).join("\n");
+      entries.push(`${indent}'${snakeName}' => [
+${localeEntries}
+${indent}],`);
+    }
+  }
+  return entries.join("\n");
+}
+function escapePhpString(str) {
+  return str.replace(/\\/g, "\\\\").replace(/'/g, "\\'");
+}
 function resolveOptions(options) {
   return {
     baseModelNamespace: options?.baseModelNamespace ?? DEFAULT_OPTIONS.baseModelNamespace,
@@ -1533,11 +1575,14 @@ use Illuminate\\Database\\Eloquent\\Relations\\MorphOne;
 use Illuminate\\Database\\Eloquent\\Relations\\MorphMany;
 use Illuminate\\Database\\Eloquent\\Relations\\MorphToMany;
 use Illuminate\\Database\\Eloquent\\Collection as EloquentCollection;
+use {{BASE_MODEL_NAMESPACE}}\\Traits\\HasLocalizedDisplayName;
+use {{BASE_MODEL_NAMESPACE}}\\Locales\\{{CLASS_NAME}}Locales;
 {{IMPORTS}}
 
 {{DOC_COMMENT}}
 class {{CLASS_NAME}}BaseModel extends {{BASE_MODEL_CLASS}}
 {
+    use HasLocalizedDisplayName;
 {{TRAITS}}
     /**
      * The table associated with the model.
@@ -1556,6 +1601,20 @@ class {{CLASS_NAME}}BaseModel extends {{BASE_MODEL_CLASS}}
      */
     public $timestamps = {{TIMESTAMPS}};
 
+    /**
+     * Localized display names for this model.
+     *
+     * @var array<string, string>
+     */
+    protected static array $localizedDisplayNames = {{CLASS_NAME}}Locales::DISPLAY_NAMES;
+
+    /**
+     * Localized display names for properties.
+     *
+     * @var array<string, array<string, string>>
+     */
+    protected static array $localizedPropertyDisplayNames = {{CLASS_NAME}}Locales::PROPERTY_DISPLAY_NAMES;
+
     /**
      * The attributes that are mass assignable.
      */
@@ -1612,12 +1671,15 @@ use Illuminate\\Database\\Eloquent\\Relations\\MorphMany;
 use Illuminate\\Database\\Eloquent\\Relations\\MorphToMany;
 use Illuminate\\Database\\Eloquent\\Collection as EloquentCollection;
 use Illuminate\\Notifications\\Notifiable;
+use {{BASE_MODEL_NAMESPACE}}\\Traits\\HasLocalizedDisplayName;
+use {{BASE_MODEL_NAMESPACE}}\\Locales\\{{CLASS_NAME}}Locales;
 {{IMPORTS}}
 
 {{DOC_COMMENT}}
 class {{CLASS_NAME}}BaseModel extends Authenticatable
 {
     use Notifiable;
+    use HasLocalizedDisplayName;
 {{TRAITS}}
     /**
      * The table associated with the model.
@@ -1636,6 +1698,20 @@ class {{CLASS_NAME}}BaseModel extends Authenticatable
      */
     public $timestamps = {{TIMESTAMPS}};
 
+    /**
+     * Localized display names for this model.
+     *
+     * @var array<string, string>
+     */
+    protected static array $localizedDisplayNames = {{CLASS_NAME}}Locales::DISPLAY_NAMES;
+
+    /**
+     * Localized display names for properties.
+     *
+     * @var array<string, array<string, string>>
+     */
+    protected static array $localizedPropertyDisplayNames = {{CLASS_NAME}}Locales::PROPERTY_DISPLAY_NAMES;
+
     /**
      * The attributes that are mass assignable.
      */
@@ -1740,6 +1816,132 @@ class OmnifyServiceProvider extends ServiceProvider
         ]);
     }
 }
+`,
+    "has-localized-display-name": `<?php
+
+namespace {{BASE_MODEL_NAMESPACE}}\\Traits;
+
+/**
+ * Trait for localized display names.
+ * Uses Laravel's app()->getLocale() for locale resolution.
+ *
+ * DO NOT EDIT - This file is auto-generated by Omnify.
+ * Any changes will be overwritten on next generation.
+ *
+ * @generated by @famgia/omnify-laravel
+ */
+trait HasLocalizedDisplayName
+{
+    /**
+     * Get the localized display name for this model.
+     *
+     * @param string|null $locale Locale code (defaults to app locale)
+     * @return string
+     */
+    public static function displayName(?string $locale = null): string
+    {
+        $locale = $locale ?? app()->getLocale();
+        $displayNames = static::$localizedDisplayNames ?? [];
+
+        return $displayNames[$locale]
+            ?? $displayNames[config('app.fallback_locale', 'en')]
+            ?? $displayNames[array_key_first($displayNames) ?? 'en']
+            ?? class_basename(static::class);
+    }
+
+    /**
+     * Get all localized display names for this model.
+     *
+     * @return array<string, string>
+     */
+    public static function allDisplayNames(): array
+    {
+        return static::$localizedDisplayNames ?? [];
+    }
+
+    /**
+     * Get the localized display name for a property.
+     *
+     * @param string $property Property name
+     * @param string|null $locale Locale code (defaults to app locale)
+     * @return string
+     */
+    public static function propertyDisplayName(string $property, ?string $locale = null): string
+    {
+        $locale = $locale ?? app()->getLocale();
+        $displayNames = static::$localizedPropertyDisplayNames[$property] ?? [];
+
+        return $displayNames[$locale]
+            ?? $displayNames[config('app.fallback_locale', 'en')]
+            ?? $displayNames[array_key_first($displayNames) ?? 'en']
+            ?? $property;
+    }
+
+    /**
+     * Get all localized display names for a property.
+     *
+     * @param string $property Property name
+     * @return array<string, string>
+     */
+    public static function allPropertyDisplayNames(string $property): array
+    {
+        return static::$localizedPropertyDisplayNames[$property] ?? [];
+    }
+
+    /**
+     * Get all property display names for a given locale.
+     *
+     * @param string|null $locale Locale code (defaults to app locale)
+     * @return array<string, string>
+     */
+    public static function allPropertyDisplayNamesForLocale(?string $locale = null): array
+    {
+        $locale = $locale ?? app()->getLocale();
+        $result = [];
+
+        foreach (static::$localizedPropertyDisplayNames ?? [] as $property => $displayNames) {
+            $result[$property] = $displayNames[$locale]
+                ?? $displayNames[config('app.fallback_locale', 'en')]
+                ?? $displayNames[array_key_first($displayNames) ?? 'en']
+                ?? $property;
+        }
+
+        return $result;
+    }
+}
+`,
+    "locales": `<?php
+
+namespace {{BASE_MODEL_NAMESPACE}}\\Locales;
+
+/**
+ * Localized display names for {{CLASS_NAME}}.
+ *
+ * DO NOT EDIT - This file is auto-generated by Omnify.
+ * Any changes will be overwritten on next generation.
+ *
+ * @generated by @famgia/omnify-laravel
+ */
+class {{CLASS_NAME}}Locales
+{
+    /**
+     * Localized display names for the model.
+     *
+     * @var array<string, string>
+     */
+    public const DISPLAY_NAMES = [
+{{LOCALIZED_DISPLAY_NAMES}}
+    ];
+
+    /**
+     * Localized display names for properties.
+     *
+     * @var array<string, array<string, string>>
+     */
+    public const PROPERTY_DISPLAY_NAMES = [
+{{LOCALIZED_PROPERTY_DISPLAY_NAMES}}
+    ];
+}
 `
   };
   return stubs[stubName] ?? "";
@@ -1759,15 +1961,42 @@ function generateServiceProvider(schemas, options, stubContent) {
     schemaName: "__service_provider__"
   };
 }
+function generateLocalizedDisplayNameTrait(options, stubContent) {
+  const content = stubContent.replace(/\{\{BASE_MODEL_NAMESPACE\}\}/g, options.baseModelNamespace);
+  return {
+    path: `${options.baseModelPath}/Traits/HasLocalizedDisplayName.php`,
+    content,
+    type: "trait",
+    overwrite: true,
+    // Always overwrite trait
+    schemaName: "__trait__"
+  };
+}
+function generateLocalesClass(schema, options, stubContent) {
+  const className = toPascalCase(schema.name);
+  const localizedDisplayNames = generateLocalizedDisplayNames(schema.displayName);
+  const localizedPropertyDisplayNames = generatePropertyLocalizedDisplayNames(schema);
+  const content = stubContent.replace(/\{\{BASE_MODEL_NAMESPACE\}\}/g, options.baseModelNamespace).replace(/\{\{CLASS_NAME\}\}/g, className).replace(/\{\{LOCALIZED_DISPLAY_NAMES\}\}/g, localizedDisplayNames).replace(/\{\{LOCALIZED_PROPERTY_DISPLAY_NAMES\}\}/g, localizedPropertyDisplayNames);
+  return {
+    path: `${options.baseModelPath}/Locales/${className}Locales.php`,
+    content,
+    type: "locales",
+    overwrite: true,
+    // Always overwrite locales
+    schemaName: schema.name
+  };
+}
 function generateModels(schemas, options) {
   const resolved = resolveOptions(options);
   const models = [];
   models.push(generateBaseModel(schemas, resolved, getStubContent("base-model")));
+  models.push(generateLocalizedDisplayNameTrait(resolved, getStubContent("has-localized-display-name")));
   models.push(generateServiceProvider(schemas, resolved, getStubContent("service-provider")));
   for (const schema of Object.values(schemas)) {
     if (schema.kind === "enum") {
       continue;
     }
+    models.push(generateLocalesClass(schema, resolved, getStubContent("locales")));
     models.push(generateEntityBaseModel(
       schema,
       schemas,
@@ -2434,4 +2663,4 @@ export {
   generateMigrationsFromChanges,
   laravelPlugin
 };
-//# sourceMappingURL=chunk-H37M25AK.js.map
+//# sourceMappingURL=chunk-ILSNN7UV.js.map