@omnifyjp/omnify 3.21.2 → 3.22.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omnifyjp/omnify",
-  "version": "3.21.2",
+  "version": "3.22.1",
   "description": "Schema-driven code generation for Laravel, TypeScript, and SQL",
   "license": "MIT",
   "repository": {
@@ -36,10 +36,10 @@
     "zod": "^3.24.0"
   },
   "optionalDependencies": {
-    "@omnifyjp/omnify-darwin-arm64": "3.21.2",
-    "@omnifyjp/omnify-darwin-x64": "3.21.2",
-    "@omnifyjp/omnify-linux-x64": "3.21.2",
-    "@omnifyjp/omnify-linux-arm64": "3.21.2",
-    "@omnifyjp/omnify-win32-x64": "3.21.2"
+    "@omnifyjp/omnify-darwin-arm64": "3.22.1",
+    "@omnifyjp/omnify-darwin-x64": "3.22.1",
+    "@omnifyjp/omnify-linux-x64": "3.22.1",
+    "@omnifyjp/omnify-linux-arm64": "3.22.1",
+    "@omnifyjp/omnify-win32-x64": "3.22.1"
   }
 }

package/ts-dist/php/index.js

@@ -26,6 +26,7 @@ import { generateFileModels } from './file-model-generator.js';
 import { generateFileTrait } from './file-trait-generator.js';
 import { generateFileCleanup } from './file-cleanup-generator.js';
 import { generateSchemaConfig } from './schema-config-generator.js';
+import { generateTranslatableConfig } from './translatable-config-generator.js';
 import { baseFile } from './types.js';
 import { generateControllers } from './controller-generator.js';
 import { generateServices } from './service-generator.js';
@@ -73,6 +74,12 @@ export function generatePhp(data, overrides) {
     }
     // Issue #34: every `kind: enum` schema becomes a global PHP enum class.
     files.push(...generateEnums(reader, config));
+    // Astrotomic translatable config (only when at least one schema has
+    // translatable fields). Closes the silent footgun where the vendor
+    // default config shipped with Astrotomic only supports ['en', 'fr', 'es']
+    // and the generator's flat `attr:locale` form would be dropped for any
+    // locale outside that list.
+    files.push(...generateTranslatableConfig(reader, config));
     // Per-schema files
     files.push(...generateLocales(reader, config));
     files.push(...generateModels(reader, config));

package/ts-dist/php/model-generator.js

@@ -524,11 +524,42 @@ function buildRelations(schemaName, properties, propertyOrder, modelNamespace, r
     }
     return methods.join('\n');
 }
+/**
+ * Method names that belong to Laravel trait authors and will break PHP's
+ * method-declaration rules if a generated relation shadows them. Caught in
+ * practice when `NotificationExtend.yaml` added a reverse relation called
+ * `notifications()` on User, which collides with `Notifiable::notifications()`
+ * — the class fails to load with a "Declaration must be compatible" fatal.
+ *
+ * Keep this tight — only names we've actually seen collide in shipped
+ * Laravel traits. False positives here would silently drop valid relations,
+ * so err on the side of under-reserving.
+ */
+const LARAVEL_RESERVED_RELATION_NAMES = new Set([
+    // Illuminate\Notifications\Notifiable
+    'notifications',
+    'readNotifications',
+    'unreadNotifications',
+    // Laravel Sanctum / Passport
+    'tokens',
+    // Laravel Scout (rare but would conflict on searchable models)
+    'searchableAs',
+    // Spatie Permission (common enough to pre-reserve)
+    'roles',
+    'permissions',
+]);
 /**
  * Discover child schemas that point at `parentName` via ManyToOne/OneToOne and
  * generate the corresponding HasMany/HasOne accessor on the parent. Skips any
  * inverse relation whose derived method name collides with a user-declared
  * relation. Issue #39.
+ *
+ * Also skips + warns when the derived method name collides with a well-known
+ * Laravel trait method (e.g. Notifiable::notifications), since silently
+ * shadowing those produces a PHP fatal at class load time. Users who need
+ * the relation should declare it explicitly in the editable {Name}.php with
+ * a unique method name, or add `mappedBy: <customName>` to the child schema
+ * so the derived method name changes.
  */
 function buildInverseRelations(parentName, modelNamespace, reader, declaredMethods, explicitInverses) {
     const methods = [];
@@ -561,6 +592,17 @@ function buildInverseRelations(parentName, modelNamespace, reader, declaredMetho
                 : toCamelCase(pluralize(childName));
             if (declaredMethods.has(methodName))
                 continue;
+            // Reserved-name collision guard: Laravel trait methods like
+            // Notifiable::notifications() cannot be safely shadowed. Skip + warn.
+            if (LARAVEL_RESERVED_RELATION_NAMES.has(methodName)) {
+                console.warn(`[omnify-ts] ${parentName}: skipping auto-generated inverse relation ` +
+                    `'${methodName}()' from ${childName}.${childPropName} — name collides ` +
+                    `with a Laravel trait method (e.g. Notifiable::${methodName}). ` +
+                    `Fix: add 'mappedBy: <customName>' to ${childName}.${childPropName} ` +
+                    `in your schema so the derived method name changes, or declare the ` +
+                    `relation manually in the editable ${parentName}.php with a unique name.`);
+                continue;
+            }
             declaredMethods.add(methodName);
             // OneToOne with mappedBy is the reverse side already — skip; it would
             // generate a child-side accessor, not a parent-side one.

package/ts-dist/php/translatable-config-generator.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generates `config/translatable.php` from the project's omnify locale config.
+ *
+ * Addresses a gap caught while writing the #75–#79 service base E2E tests
+ * in l12: Astrotomic's vendor default config only ships `['en', 'fr', 'es']`
+ * as supported locales. Consumers using `ja` / `vi` / `ko` / etc. hit a
+ * silent footgun — `Translatable::fill(['title:ja' => '...'])` drops the key
+ * because `getLocalesHelper()->has('ja')` returns false, producing NULL
+ * translations at runtime with no error.
+ *
+ * This generator emits a ready-to-commit `config/translatable.php` wired to
+ * the locales declared in `omnify.yaml` under `locale.locales`. It's only
+ * written when the project actually has a schema with translatable fields
+ * (no point in rewriting the config if nothing would consume it).
+ *
+ * The file is marked `overwrite: true` — it's a base file in Omnify's sense:
+ * when locales change in omnify.yaml, the config should follow automatically.
+ * Consumers that need per-project overrides can copy it to a different name
+ * or extend it via Laravel's config merging.
+ */
+import type { SchemaReader } from './schema-reader.js';
+import type { GeneratedFile, PhpConfig } from './types.js';
+export declare function generateTranslatableConfig(reader: SchemaReader, _config: PhpConfig): GeneratedFile[];

package/ts-dist/php/translatable-config-generator.js

@@ -0,0 +1,168 @@
+/**
+ * Generates `config/translatable.php` from the project's omnify locale config.
+ *
+ * Addresses a gap caught while writing the #75–#79 service base E2E tests
+ * in l12: Astrotomic's vendor default config only ships `['en', 'fr', 'es']`
+ * as supported locales. Consumers using `ja` / `vi` / `ko` / etc. hit a
+ * silent footgun — `Translatable::fill(['title:ja' => '...'])` drops the key
+ * because `getLocalesHelper()->has('ja')` returns false, producing NULL
+ * translations at runtime with no error.
+ *
+ * This generator emits a ready-to-commit `config/translatable.php` wired to
+ * the locales declared in `omnify.yaml` under `locale.locales`. It's only
+ * written when the project actually has a schema with translatable fields
+ * (no point in rewriting the config if nothing would consume it).
+ *
+ * The file is marked `overwrite: true` — it's a base file in Omnify's sense:
+ * when locales change in omnify.yaml, the config should follow automatically.
+ * Consumers that need per-project overrides can copy it to a different name
+ * or extend it via Laravel's config merging.
+ */
+import { baseFile } from './types.js';
+export function generateTranslatableConfig(reader, _config) {
+    // Only emit when at least one schema has translatable fields — otherwise
+    // the file would just be dead weight in projects that don't use i18n.
+    const objectSchemas = reader.getProjectObjectSchemas();
+    let hasAnyTranslatable = false;
+    for (const name of Object.keys(objectSchemas)) {
+        if (reader.getTranslatableFields(name).length > 0) {
+            hasAnyTranslatable = true;
+            break;
+        }
+    }
+    if (!hasAnyTranslatable) {
+        return [];
+    }
+    const locales = reader.getLocales();
+    if (locales.length === 0) {
+        // Nothing we can honestly write — fall back to Astrotomic's own default.
+        return [];
+    }
+    const defaultLocale = reader.getDefaultLocale();
+    // Astrotomic has a separate fallback_locale config — prefer the omnify
+    // `fallbackLocale` if set, otherwise fall back to the same defaultLocale.
+    const fallbackLocale = reader.getLocale()?.fallbackLocale ?? defaultLocale;
+    const localesPhp = locales.map(l => `        '${l}',`).join('\n');
+    const content = `<?php
+
+/**
+ * DO NOT EDIT - This file is auto-generated by Omnify from omnify.yaml's
+ * \`locale.locales\` config. Any manual changes will be overwritten on the
+ * next \`omnify generate\`.
+ *
+ * Consumers that need per-project overrides should use Laravel's config
+ * merging or a separate config file.
+ *
+ * @generated by omnify
+ */
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Application Locales
+    |--------------------------------------------------------------------------
+    |
+    | Emitted from \`locale.locales\` in omnify.yaml. Adding or removing
+    | locales here without editing omnify.yaml first will be overwritten
+    | on the next generation.
+    |
+    */
+    'locales' => [
+${localesPhp}
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Locale separator
+    |--------------------------------------------------------------------------
+    */
+    'locale_separator' => '-',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Default locale
+    |--------------------------------------------------------------------------
+    */
+    'default_locale' => '${defaultLocale}',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Translator
+    |--------------------------------------------------------------------------
+    */
+    'translator' => null,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Use fallback
+    |--------------------------------------------------------------------------
+    |
+    | Enabled so that missing translations transparently fall back to the
+    | configured fallback_locale. Without this, attributesToArray() returns
+    | NULL for untranslated attributes instead of using the fallback row —
+    | which would surface as blank dropdown labels in multi-locale projects.
+    |
+    */
+    'use_fallback' => true,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Use property fallback
+    |--------------------------------------------------------------------------
+    */
+    'use_property_fallback' => true,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Fallback locale
+    |--------------------------------------------------------------------------
+    */
+    'fallback_locale' => '${fallbackLocale}',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Translation model namespace
+    |--------------------------------------------------------------------------
+    */
+    'translation_model_namespace' => null,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Translation suffix
+    |--------------------------------------------------------------------------
+    */
+    'translation_suffix' => 'Translation',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Locale key
+    |--------------------------------------------------------------------------
+    */
+    'locale_key' => 'locale',
+
+    /*
+    |--------------------------------------------------------------------------
+    | To array always loads translations
+    |--------------------------------------------------------------------------
+    |
+    | When true, calling toArray() on a model auto-loads its translations.
+    | Keeps paginator results self-contained for JSON API responses.
+    |
+    */
+    'to_array_always_loads_translations' => true,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Rule factory
+    |--------------------------------------------------------------------------
+    */
+    'rule_factory' => [
+        'format' => 0, // Astrotomic\Translatable\Validation\RuleFactory::FORMAT_ARRAY
+        'prefix' => '%',
+        'suffix' => '%',
+    ],
+];
+`;
+    return [baseFile('config/translatable.php', content)];
+}