@omnifyjp/ts 0.3.0

package/dist/php/model-generator.js

@@ -0,0 +1,396 @@
+/**
+ * Port of ModelGenerator.php — generates Eloquent model base + user classes.
+ */
+import { toPascalCase, toSnakeCase } from './naming-helper.js';
+import { toCast, toPhpDocType, isHiddenByDefault } from './type-mapper.js';
+import { buildRelation } from './relation-builder.js';
+import { baseFile, userFile } from './types.js';
+/** Generate base model and user model for all object schemas. */
+export function generateModels(reader, config) {
+    const files = [];
+    for (const [name, schema] of Object.entries(reader.getObjectSchemas())) {
+        files.push(...generateForSchema(name, schema, reader, config));
+    }
+    return files;
+}
+function generateForSchema(name, schema, reader, config) {
+    return [
+        generateBaseModel(name, schema, reader, config),
+        generateUserModel(name, config),
+    ];
+}
+function generateBaseModel(name, schema, reader, config) {
+    const modelName = toPascalCase(name);
+    const baseNamespace = config.models.baseNamespace;
+    const modelNamespace = config.models.namespace;
+    const options = schema.options ?? {};
+    const properties = (schema.properties ?? {});
+    const expandedProperties = reader.getExpandedProperties(name);
+    const propertyOrder = reader.getPropertyOrder(name);
+    const tableName = reader.getTableName(name);
+    const isAuthenticatable = options['authenticatable'] ?? false;
+    const hasSoftDelete = options.softDelete ?? false;
+    const hasTimestamps = options.timestamps ?? false;
+    const imports = buildImports(baseNamespace, modelName, hasSoftDelete, isAuthenticatable, properties);
+    const docProperties = buildDocProperties(properties, expandedProperties, propertyOrder);
+    const baseClass = isAuthenticatable ? 'Authenticatable' : 'BaseModel';
+    const traits = buildTraits(hasSoftDelete, isAuthenticatable);
+    const fillable = buildFillable(properties, expandedProperties, propertyOrder);
+    const hidden = buildHidden(properties, expandedProperties, propertyOrder);
+    const appends = buildAppends(expandedProperties);
+    const casts = buildCasts(properties, expandedProperties, propertyOrder);
+    const relations = buildRelations(properties, propertyOrder, modelNamespace);
+    const accessors = buildAccessors(expandedProperties);
+    const primaryKey = options['primaryKey'] ?? 'id';
+    const idType = options.idType ?? 'BigInt';
+    let keyTypeSection = '';
+    if (idType === 'Uuid' || idType === 'String') {
+        keyTypeSection = `
+    /**
+     * The type of the primary key.
+     */
+    protected $keyType = 'string';
+
+    /**
+     * Indicates if the IDs are auto-incrementing.
+     */
+    public $incrementing = false;`;
+    }
+    const content = `<?php
+
+namespace ${baseNamespace};
+
+/**
+ * DO NOT EDIT - This file is auto-generated by Omnify.
+ * Any changes will be overwritten on next generation.
+ *
+ * @generated by omnify
+ */
+
+${imports}
+/**
+ * ${modelName}BaseModel
+ *
+${docProperties} */
+class ${modelName}BaseModel extends ${baseClass}
+{
+${traits}    /**
+     * The table associated with the model.
+     */
+    protected $table = '${tableName}';
+
+    /**
+     * The primary key for the model.
+     */
+    protected $primaryKey = '${primaryKey}';
+${keyTypeSection}
+
+    /**
+     * Indicates if the model should be timestamped.
+     */
+    public $timestamps = ${hasTimestamps ? 'true' : 'false'};
+
+    /**
+     * Localized display names for this model.
+     *
+     * @var array<string, string>
+     */
+    protected static array $localizedDisplayNames = ${modelName}Locales::DISPLAY_NAMES;
+
+    /**
+     * Localized display names for properties.
+     *
+     * @var array<string, array<string, string>>
+     */
+    protected static array $localizedPropertyDisplayNames = ${modelName}Locales::PROPERTY_DISPLAY_NAMES;
+
+    /**
+     * The attributes that are mass assignable.
+     */
+    protected $fillable = [
+${fillable}    ];
+
+    /**
+     * The attributes that should be hidden for serialization.
+     */
+    protected $hidden = [
+${hidden}    ];
+
+    /**
+     * The accessors to append to the model's array form.
+     */
+    protected $appends = [
+${appends}    ];
+
+    /**
+     * Get the attributes that should be cast.
+     */
+    protected function casts(): array
+    {
+        return [
+${casts}        ];
+    }
+${relations}${accessors}
+}
+`;
+    return baseFile(`${config.models.basePath}/${modelName}BaseModel.php`, content);
+}
+function generateUserModel(name, config) {
+    const modelName = toPascalCase(name);
+    const modelNamespace = config.models.namespace;
+    const baseNamespace = config.models.baseNamespace;
+    const content = `<?php
+
+namespace ${modelNamespace};
+
+use ${baseNamespace}\\${modelName}BaseModel;
+use Illuminate\\Database\\Eloquent\\Factories\\HasFactory;
+
+/**
+ * ${modelName} Model
+ *
+ * This file is generated once and can be customized.
+ * Add your custom methods and logic here.
+ */
+class ${modelName} extends ${modelName}BaseModel
+{
+    use HasFactory;
+
+    /**
+     * Create a new model instance.
+     */
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+    }
+
+    // Add your custom methods here
+}
+`;
+    return userFile(`${config.models.path}/${modelName}.php`, content);
+}
+function buildImports(baseNamespace, modelName, hasSoftDelete, isAuthenticatable, properties) {
+    const lines = [];
+    if (isAuthenticatable) {
+        lines.push('use Illuminate\\Foundation\\Auth\\User as Authenticatable;');
+        lines.push('use Illuminate\\Notifications\\Notifiable;');
+    }
+    // Always include all relation types for simplicity (matching PHP)
+    const allRelationTypes = ['BelongsTo', 'HasMany', 'HasOne', 'BelongsToMany', 'MorphTo', 'MorphOne', 'MorphMany', 'MorphToMany'];
+    for (const type of allRelationTypes) {
+        lines.push(`use Illuminate\\Database\\Eloquent\\Relations\\${type};`);
+    }
+    lines.push('use Illuminate\\Database\\Eloquent\\Collection as EloquentCollection;');
+    lines.push(`use ${baseNamespace}\\Traits\\HasLocalizedDisplayName;`);
+    lines.push(`use ${baseNamespace}\\Locales\\${modelName}Locales;`);
+    if (hasSoftDelete) {
+        lines.push('use Illuminate\\Database\\Eloquent\\SoftDeletes;');
+    }
+    return lines.join('\n') + '\n';
+}
+function buildDocProperties(properties, expandedProperties, propertyOrder) {
+    const lines = [];
+    for (const propName of propertyOrder) {
+        const prop = properties[propName];
+        if (!prop)
+            continue;
+        const type = prop['type'] ?? 'String';
+        if (type === 'Association') {
+            const relation = prop['relation'] ?? '';
+            if (relation === 'ManyToOne') {
+                const snakeName = toSnakeCase(propName) + '_id';
+                const nullable = prop['nullable'] ?? false;
+                const phpType = nullable ? 'int|null' : 'int';
+                lines.push(` * @property ${phpType} $${snakeName}`);
+            }
+            continue;
+        }
+        if (expandedProperties[propName]) {
+            for (const col of expandedProperties[propName].columns ?? []) {
+                const colName = col.name ?? '';
+                const colType = col.type ?? 'String';
+                const colNullable = col.nullable ?? false;
+                const phpDocType = toPhpDocType(colType, colNullable);
+                lines.push(` * @property ${phpDocType} $${colName}`);
+            }
+            continue;
+        }
+        const nullable = prop['nullable'] ?? false;
+        const snakeName = toSnakeCase(propName);
+        const phpDocType = toPhpDocType(type, nullable);
+        lines.push(` * @property ${phpDocType} $${snakeName}`);
+    }
+    return lines.length === 0 ? '' : lines.join('\n') + '\n';
+}
+function buildTraits(hasSoftDelete, isAuthenticatable) {
+    const lines = [];
+    lines.push('    use HasLocalizedDisplayName;');
+    if (isAuthenticatable)
+        lines.push('    use Notifiable;');
+    if (hasSoftDelete)
+        lines.push('    use SoftDeletes;');
+    return lines.join('\n') + '\n';
+}
+function buildFillable(properties, expandedProperties, propertyOrder) {
+    const fields = [];
+    for (const propName of propertyOrder) {
+        const prop = properties[propName];
+        if (!prop)
+            continue;
+        const type = prop['type'] ?? 'String';
+        const fillable = prop['fillable'] ?? true;
+        if (!fillable)
+            continue;
+        if (type === 'Association') {
+            const relation = prop['relation'] ?? '';
+            if (relation === 'ManyToOne') {
+                fields.push(toSnakeCase(propName) + '_id');
+            }
+            continue;
+        }
+        if (expandedProperties[propName]) {
+            for (const col of expandedProperties[propName].columns ?? []) {
+                if (col.name)
+                    fields.push(col.name);
+            }
+            continue;
+        }
+        fields.push(toSnakeCase(propName));
+    }
+    if (fields.length === 0)
+        return '';
+    return fields.map(f => `        '${f}',`).join('\n') + '\n';
+}
+function buildHidden(properties, expandedProperties, propertyOrder) {
+    const fields = [];
+    for (const propName of propertyOrder) {
+        const prop = properties[propName];
+        if (!prop)
+            continue;
+        const type = prop['type'] ?? 'String';
+        const hidden = prop['hidden'] ?? false;
+        if (isHiddenByDefault(type) || hidden) {
+            if (expandedProperties[propName]) {
+                for (const col of expandedProperties[propName].columns ?? []) {
+                    if (col.name)
+                        fields.push(col.name);
+                }
+            }
+            else {
+                fields.push(toSnakeCase(propName));
+            }
+            continue;
+        }
+        // Check individual field hidden overrides for compound types
+        if (expandedProperties[propName]) {
+            const fieldOverrides = prop['fields'] ?? {};
+            for (const col of expandedProperties[propName].columns ?? []) {
+                const suffix = col.suffix ?? '';
+                if (fieldOverrides[suffix]?.['hidden']) {
+                    fields.push(col.name ?? '');
+                }
+            }
+        }
+    }
+    if (fields.length === 0)
+        return '';
+    return fields.map(f => `        '${f}',`).join('\n') + '\n';
+}
+function buildAppends(expandedProperties) {
+    const appends = [];
+    for (const [propName, expansion] of Object.entries(expandedProperties)) {
+        const sourceType = expansion.sourceType ?? '';
+        const snakeName = toSnakeCase(propName);
+        switch (sourceType) {
+            case 'JapaneseName':
+                appends.push(`${snakeName}_full_name`);
+                appends.push(`${snakeName}_full_name_kana`);
+                break;
+            case 'JapaneseAddress':
+                appends.push(`${snakeName}_full_address`);
+                break;
+        }
+    }
+    if (appends.length === 0)
+        return '';
+    return appends.map(a => `        '${a}',`).join('\n') + '\n';
+}
+function buildCasts(properties, expandedProperties, propertyOrder) {
+    const casts = [];
+    for (const propName of propertyOrder) {
+        const prop = properties[propName];
+        if (!prop)
+            continue;
+        const type = prop['type'] ?? 'String';
+        if (type === 'Association')
+            continue;
+        if (expandedProperties[propName]) {
+            for (const col of expandedProperties[propName].columns ?? []) {
+                const colType = col.type ?? 'String';
+                const cast = toCast(colType, col);
+                if (cast) {
+                    casts.push(`'${col.name}' => '${cast}',`);
+                }
+            }
+            continue;
+        }
+        const cast = toCast(type, prop);
+        if (cast) {
+            const snakeName = toSnakeCase(propName);
+            casts.push(`'${snakeName}' => '${cast}',`);
+        }
+    }
+    if (casts.length === 0)
+        return '';
+    return casts.map(c => `            ${c}`).join('\n') + '\n';
+}
+function buildRelations(properties, propertyOrder, modelNamespace) {
+    const methods = [];
+    for (const propName of propertyOrder) {
+        const prop = properties[propName];
+        if (!prop || prop['type'] !== 'Association')
+            continue;
+        const result = buildRelation(propName, prop, modelNamespace);
+        if (result) {
+            methods.push('\n' + result.method);
+        }
+    }
+    return methods.join('\n');
+}
+function buildAccessors(expandedProperties) {
+    const methods = [];
+    for (const [propName, expansion] of Object.entries(expandedProperties)) {
+        const sourceType = expansion.sourceType ?? '';
+        const snakeName = toSnakeCase(propName);
+        switch (sourceType) {
+            case 'JapaneseName':
+                methods.push(fullNameAccessor(snakeName, 'FullName', [
+                    `${snakeName}_lastname`, `${snakeName}_firstname`,
+                ], ' '));
+                methods.push(fullNameAccessor(snakeName, 'FullNameKana', [
+                    `${snakeName}_kana_lastname`, `${snakeName}_kana_firstname`,
+                ], ' '));
+                break;
+            case 'JapaneseAddress':
+                methods.push(fullNameAccessor(snakeName, 'FullAddress', [
+                    `${snakeName}_address1`, `${snakeName}_address2`, `${snakeName}_address3`,
+                ], ''));
+                break;
+        }
+    }
+    return methods.join('\n');
+}
+function fullNameAccessor(prefix, suffix, fields, separator) {
+    const methodName = 'get' + toPascalCase(prefix) + suffix + 'Attribute';
+    const fieldAccess = fields.map(f => `$this->${f}`).join(', ');
+    const separatorArg = separator === '' ? "''" : `'${separator}'`;
+    return `
+    /**
+     * Get the ${prefix} ${suffix} attribute.
+     */
+    public function ${methodName}(): ?string
+    {
+        $parts = array_filter([${fieldAccess}], fn($v) => $v !== null && $v !== '');
+        return count($parts) > 0 ? implode(${separatorArg}, $parts) : null;
+    }`;
+}

package/dist/php/naming-helper.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Port of NamingHelper.php — case conversion utilities.
+ */
+/** Convert camelCase/PascalCase to snake_case. */
+export declare function toSnakeCase(value: string): string;
+/** Convert any string to PascalCase. */
+export declare function toPascalCase(value: string): string;
+/** Convert any string to camelCase. */
+export declare function toCamelCase(value: string): string;
+/**
+ * Pluralize a word (simple English rules).
+ * Handles common cases: -y → -ies, -s/-sh/-ch/-x/-z → -es, default → -s
+ */
+export declare function pluralize(value: string): string;
+/** Convert a schema name to a table name (snake_case + pluralized). */
+export declare function toTableName(schemaName: string): string;
+/**
+ * Resolve a displayName from a localized map or string.
+ */
+export declare function resolveDisplayName(displayName: string | Record<string, string> | null | undefined, locale: string, fallback: string): string;
+/** Build expanded column name from property name and suffix. */
+export declare function expandedColumnName(propertyName: string, suffix: string): string;

package/dist/php/naming-helper.js

@@ -0,0 +1,61 @@
+/**
+ * Port of NamingHelper.php — case conversion utilities.
+ */
+/** Convert camelCase/PascalCase to snake_case. */
+export function toSnakeCase(value) {
+    return value
+        .replace(/([A-Z])/g, '_$1')
+        .replace(/^_/, '')
+        .toLowerCase();
+}
+/** Convert any string to PascalCase. */
+export function toPascalCase(value) {
+    return value
+        .replace(/[-_](\w)/g, (_, c) => c.toUpperCase())
+        .replace(/^(\w)/, (_, c) => c.toUpperCase());
+}
+/** Convert any string to camelCase. */
+export function toCamelCase(value) {
+    const pascal = toPascalCase(value);
+    return pascal.charAt(0).toLowerCase() + pascal.slice(1);
+}
+/**
+ * Pluralize a word (simple English rules).
+ * Handles common cases: -y → -ies, -s/-sh/-ch/-x/-z → -es, default → -s
+ */
+export function pluralize(value) {
+    if (value.endsWith('y') && !['a', 'e', 'i', 'o', 'u'].includes(value.charAt(value.length - 2))) {
+        return value.slice(0, -1) + 'ies';
+    }
+    if (value.endsWith('s') || value.endsWith('sh') || value.endsWith('ch') || value.endsWith('x') || value.endsWith('z')) {
+        return value + 'es';
+    }
+    if (value.endsWith('fe')) {
+        return value.slice(0, -2) + 'ves';
+    }
+    if (value.endsWith('f')) {
+        return value.slice(0, -1) + 'ves';
+    }
+    return value + 's';
+}
+/** Convert a schema name to a table name (snake_case + pluralized). */
+export function toTableName(schemaName) {
+    return pluralize(toSnakeCase(schemaName));
+}
+/**
+ * Resolve a displayName from a localized map or string.
+ */
+export function resolveDisplayName(displayName, locale, fallback) {
+    if (displayName == null)
+        return fallback;
+    if (typeof displayName === 'string')
+        return displayName;
+    if (typeof displayName === 'object') {
+        return displayName[locale] ?? displayName['en'] ?? Object.values(displayName)[0] ?? fallback;
+    }
+    return fallback;
+}
+/** Build expanded column name from property name and suffix. */
+export function expandedColumnName(propertyName, suffix) {
+    return `${toSnakeCase(propertyName)}_${toSnakeCase(suffix)}`;
+}

package/dist/php/relation-builder.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Port of RelationBuilder.php — generates Eloquent relation methods.
+ */
+interface RelationResult {
+    method: string;
+    imports: string[];
+}
+/** Build Eloquent relation method PHP code. */
+export declare function buildRelation(propName: string, property: Record<string, unknown>, modelNamespace: string): RelationResult | null;
+/** Get the return type hint for a relation. */
+export declare function getReturnType(relation: string): string;
+export {};

package/dist/php/relation-builder.js

@@ -0,0 +1,147 @@
+/**
+ * Port of RelationBuilder.php — generates Eloquent relation methods.
+ */
+import { toSnakeCase, toCamelCase } from './naming-helper.js';
+/** Build Eloquent relation method PHP code. */
+export function buildRelation(propName, property, modelNamespace) {
+    const relation = property['relation'] ?? '';
+    const target = property['target'] ?? '';
+    const imports = [];
+    let method = null;
+    switch (relation) {
+        case 'ManyToOne':
+            method = belongsTo(propName, target, modelNamespace);
+            break;
+        case 'OneToOne':
+            method = oneToOne(propName, property, target, modelNamespace);
+            break;
+        case 'OneToMany':
+            method = hasMany(propName, property, target, modelNamespace);
+            break;
+        case 'ManyToMany':
+            method = belongsToMany(propName, property, target, modelNamespace);
+            break;
+        case 'MorphTo':
+            method = morphTo(propName);
+            break;
+        case 'MorphOne':
+            method = morphOne(propName, property, target, modelNamespace);
+            break;
+        case 'MorphMany':
+            method = morphMany(propName, property, target, modelNamespace);
+            break;
+    }
+    if (method === null)
+        return null;
+    return { method, imports };
+}
+/** Get the return type hint for a relation. */
+export function getReturnType(relation) {
+    switch (relation) {
+        case 'ManyToOne': return 'BelongsTo';
+        case 'OneToOne': return 'HasOne';
+        case 'OneToMany': return 'HasMany';
+        case 'ManyToMany': return 'BelongsToMany';
+        case 'MorphTo': return 'MorphTo';
+        case 'MorphOne': return 'MorphOne';
+        case 'MorphMany': return 'MorphMany';
+        default: return 'BelongsTo';
+    }
+}
+function belongsTo(propName, target, ns) {
+    const snakeName = toSnakeCase(propName);
+    const foreignKey = `${snakeName}_id`;
+    const methodName = toCamelCase(propName);
+    const fqcn = `\\${ns}\\${target}`;
+    return `    /**
+     * Get the ${propName} that owns this model.
+     */
+    public function ${methodName}(): BelongsTo
+    {
+        return $this->belongsTo(${fqcn}::class, '${foreignKey}');
+    }`;
+}
+function oneToOne(propName, property, target, ns) {
+    const mappedBy = property['mappedBy'];
+    const methodName = toCamelCase(propName);
+    const fqcn = `\\${ns}\\${target}`;
+    if (mappedBy) {
+        const foreignKey = `${toSnakeCase(mappedBy)}_id`;
+        return `    /**
+     * Get the ${propName} associated with this model.
+     */
+    public function ${methodName}(): HasOne
+    {
+        return $this->hasOne(${fqcn}::class, '${foreignKey}');
+    }`;
+    }
+    return belongsTo(propName, target, ns);
+}
+function hasMany(propName, property, target, ns) {
+    const inverse = property['mappedBy'] ?? property['inversedBy'] ?? null;
+    const foreignKey = inverse ? `${toSnakeCase(inverse)}_id` : `${toSnakeCase(propName)}_id`;
+    const methodName = toCamelCase(propName);
+    const fqcn = `\\${ns}\\${target}`;
+    return `    /**
+     * Get the ${propName} for this model.
+     */
+    public function ${methodName}(): HasMany
+    {
+        return $this->hasMany(${fqcn}::class, '${foreignKey}');
+    }`;
+}
+function belongsToMany(propName, property, target, ns) {
+    const joinTable = property['joinTable'] ?? '';
+    const methodName = toCamelCase(propName);
+    const pivotFields = property['pivotFields'] ?? {};
+    const fqcn = `\\${ns}\\${target}`;
+    let chain = `$this->belongsToMany(${fqcn}::class, '${joinTable}')`;
+    const fieldKeys = Object.keys(pivotFields);
+    if (fieldKeys.length > 0) {
+        const fields = fieldKeys.map(k => `'${toSnakeCase(k)}'`).join(', ');
+        chain += `\n            ->withPivot(${fields})`;
+    }
+    chain += `\n            ->withTimestamps()`;
+    return `    /**
+     * The ${propName} that belong to this model.
+     */
+    public function ${methodName}(): BelongsToMany
+    {
+        return ${chain};
+    }`;
+}
+function morphTo(propName) {
+    const methodName = toCamelCase(propName);
+    const morphName = toSnakeCase(propName);
+    return `    /**
+     * Get the parent ${propName} model.
+     */
+    public function ${methodName}(): MorphTo
+    {
+        return $this->morphTo('${morphName}');
+    }`;
+}
+function morphOne(propName, property, target, ns) {
+    const morphName = property['morphName'] ?? toSnakeCase(propName);
+    const methodName = toCamelCase(propName);
+    const fqcn = `\\${ns}\\${target}`;
+    return `    /**
+     * Get the ${propName} for this model.
+     */
+    public function ${methodName}(): MorphOne
+    {
+        return $this->morphOne(${fqcn}::class, '${morphName}');
+    }`;
+}
+function morphMany(propName, property, target, ns) {
+    const morphName = property['morphName'] ?? toSnakeCase(propName);
+    const methodName = toCamelCase(propName);
+    const fqcn = `\\${ns}\\${target}`;
+    return `    /**
+     * Get the ${propName} for this model.
+     */
+    public function ${methodName}(): MorphMany
+    {
+        return $this->morphMany(${fqcn}::class, '${morphName}');
+    }`;
+}

package/dist/php/request-generator.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Port of RequestGenerator.php — generates Store/Update request classes.
+ */
+import { SchemaReader } from './schema-reader.js';
+import type { GeneratedFile, PhpConfig } from './types.js';
+/** Generate Store/Update request classes for all visible object schemas. */
+export declare function generateRequests(reader: SchemaReader, config: PhpConfig): GeneratedFile[];