@omnifyjp/omnify 5.0.1 → 5.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omnifyjp/omnify",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "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": "5.0.1",
-    "@omnifyjp/omnify-darwin-x64": "5.0.1",
-    "@omnifyjp/omnify-linux-x64": "5.0.1",
-    "@omnifyjp/omnify-linux-arm64": "5.0.1",
-    "@omnifyjp/omnify-win32-x64": "5.0.1"
+    "@omnifyjp/omnify-darwin-arm64": "5.0.2",
+    "@omnifyjp/omnify-darwin-x64": "5.0.2",
+    "@omnifyjp/omnify-linux-x64": "5.0.2",
+    "@omnifyjp/omnify-linux-arm64": "5.0.2",
+    "@omnifyjp/omnify-win32-x64": "5.0.2"
   }
 }

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

@@ -504,7 +504,21 @@ function buildRelations(schemaName, properties, propertyOrder, modelNamespace, r
         const target = prop['target'] ?? '';
         const ns = target ? reader.resolveModelNamespace(target, modelNamespace) : modelNamespace;
         const targetTableName = target ? reader.getTableName(target) : '';
-        const result = buildRelation(propName, prop, ns, { sourceTableName, targetTableName });
+        // For ManyToMany, look up the explicit `kind: pivot` schema (the
+        // sorted PascalCase concat of source + target — auto-created on
+        // first generate) and pass its property names so belongsToMany
+        // emits `->withPivot('col1', 'col2')`. Without this, custom pivot
+        // columns the user added are unreachable through the relation.
+        const relation = prop['relation'] ?? '';
+        let pivotProperties;
+        if (relation === 'ManyToMany' && target) {
+            const pivotName = [schemaName, target].sort().join('');
+            const pivotSchema = reader.getSchema(pivotName);
+            if (pivotSchema?.properties) {
+                pivotProperties = Object.keys(pivotSchema.properties).map(toSnakeCase);
+            }
+        }
+        const result = buildRelation(propName, prop, ns, { sourceTableName, targetTableName, pivotProperties });
         if (result) {
             methods.push('\n' + result.method);
             declaredMethods.add(toCamelCase(propName));

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

@@ -8,6 +8,12 @@ interface RelationResult {
 interface RelationContext {
     sourceTableName: string;
     targetTableName: string;
+    /** Property names declared on the explicit `kind: pivot` schema for
+     * this M2M (e.g. `["position", "notes"]`). Surfaced in the generated
+     * `belongsToMany()` chain via `->withPivot(...)` so consumers can
+     * read those columns through the relation. Empty / undefined when
+     * the user has not added custom columns to the pivot schema. */
+    pivotProperties?: string[];
 }
 /** Build Eloquent relation method PHP code. */
 export declare function buildRelation(propName: string, property: Record<string, unknown>, modelNamespace: string, context?: RelationContext): RelationResult | null;

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

@@ -128,12 +128,15 @@ function belongsToMany(propName, property, target, ns, context) {
         joinTable = generatePivotTableName(context.sourceTableName, context.targetTableName);
     }
     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(', ');
+    // withPivot for every column declared on the explicit `kind: pivot`
+    // schema (resolved upstream and passed via context.pivotProperties).
+    // The legacy `pivotFields:` block on the M2M property was removed in
+    // v5.0.0; pivot columns now live on the pivot schema itself.
+    const pivotCols = context?.pivotProperties ?? [];
+    if (pivotCols.length > 0) {
+        const fields = pivotCols.map(k => `'${toSnakeCase(k)}'`).join(', ');
         chain += `\n            ->withPivot(${fields})`;
     }
     chain += `\n            ->withTimestamps()`;

package/types/schema.d.ts

@@ -85,7 +85,16 @@ export interface CompoundFieldOverride {
   placeholder?: LocalizedString;
 }
 
-/** Field definition on a pivot table. */
+/**
+ * Field definition on a pivot table.
+ *
+ * @deprecated Removed in v5.0.0 — `pivotFields:` on a M2M association
+ * is rejected by validation. Use an explicit `kind: pivot` schema
+ * (auto-created by `omnify generate`) and put extra columns under its
+ * `properties:` block. The interface is retained for IDE auto-complete
+ * compatibility on legacy YAML so users see the deprecation in their
+ * editor, then get the actionable hard error from the CLI.
+ */
 export interface PivotFieldDefinition {
   type: BuiltInPropertyType;
   nullable?: boolean;
@@ -239,7 +248,14 @@ export interface PropertyDefinition {
   onUpdate?: ReferentialAction;
   owning?: boolean;
   joinTable?: string;
+  /** @deprecated Removed in v5.0.0 — declare extra pivot columns on the
+   * explicit `kind: pivot` schema (auto-created by `omnify generate`)
+   * instead. Validation rejects YAML that still uses this field. */
   pivotFields?: Record<string, PivotFieldDefinition>;
+  /** @deprecated Removed in v5.0.0 — set `options.id` on the explicit
+   * `kind: pivot` schema instead. Validation rejects YAML that still
+   * uses this field. */
+  pivotId?: IdType;
   targetNamespace?: string;
   idType?: IdType;
 }