@warlock.js/cascade 5.7.0 → 5.9.0

package/llms-full.txt

@@ -2771,6 +2771,35 @@ export default class BackfillStatuses extends Migration {
 
 Class-form builders include `createTable()` / `createTableIfNotExists()`, `dropTable()` / `dropTableIfExists()`, `dropColumn(name)`, `renameTableTo(name)`, `timestamps()`, `index(...)`, `primaryUuid()`, and `raw(sql)` for a raw statement.
 
+### Foreign-key columns that match the app's PK type — `this.foreignId`
+
+`this.foreignId(name)` (5.8+) derives the column's type from `migrationDefaults.primaryKey` so a foreign-key column always matches the type of the `id` it points at, instead of hardcoding one:
+
+| `migrationDefaults.primaryKey` | `foreignId` produces |
+| --- | --- |
+| `uuid` | `uuid` column |
+| `bigInt` | `bigInteger` column |
+| anything else (default) | `integer` column |
+
+```ts
+import { Migration } from "@warlock.js/cascade";
+
+export default class AddUserToPosts extends Migration {
+  public readonly table = "posts";
+
+  public async up(): Promise<void> {
+    // uuid / bigInteger / integer, matching the app's chosen PK type
+    this.foreignId("user_id").index();
+  }
+
+  public down(): void {
+    this.dropColumn("user_id");
+  }
+}
+```
+
+Reach for it on plain (non-`.references()`) FK id columns — e.g. a polymorphic `user_id` paired with a `user_type` — so a reference to a default-PK model is always type-compatible with that model's `id`.
+
 ## Raw SQL migrations
 
 For SQL-only changes (Postgres), `Migration.rawSql` builds a migration class for you:

package/package.json

@@ -13,9 +13,9 @@
     "@mongez/events": "^2.2.7",
     "@mongez/reinforcements": "^4.0.1",
     "@mongez/supportive-is": "^2.1.4",
-    "@warlock.js/context": "5.7.0",
-    "@warlock.js/logger": "5.7.0",
-    "@warlock.js/seal": "5.7.0",
+    "@warlock.js/context": "5.9.0",
+    "@warlock.js/logger": "5.9.0",
+    "@warlock.js/seal": "5.9.0",
     "citty": "^0.2.2",
     "fast-glob": "^3.3.3"
   },
@@ -43,7 +43,7 @@
   ],
   "author": "hassanzohdy",
   "license": "MIT",
-  "version": "5.7.0",
+  "version": "5.9.0",
   "main": "./cjs/index.cjs",
   "module": "./esm/index.mjs",
   "types": "./esm/index.d.mts",

package/skills/write-migration/SKILL.md

@@ -124,6 +124,35 @@ export default class BackfillStatuses extends Migration {
 
 Class-form builders include `createTable()` / `createTableIfNotExists()`, `dropTable()` / `dropTableIfExists()`, `dropColumn(name)`, `renameTableTo(name)`, `timestamps()`, `index(...)`, `primaryUuid()`, and `raw(sql)` for a raw statement.
 
+### Foreign-key columns that match the app's PK type — `this.foreignId`
+
+`this.foreignId(name)` (5.8+) derives the column's type from `migrationDefaults.primaryKey` so a foreign-key column always matches the type of the `id` it points at, instead of hardcoding one:
+
+| `migrationDefaults.primaryKey` | `foreignId` produces |
+| --- | --- |
+| `uuid` | `uuid` column |
+| `bigInt` | `bigInteger` column |
+| anything else (default) | `integer` column |
+
+```ts
+import { Migration } from "@warlock.js/cascade";
+
+export default class AddUserToPosts extends Migration {
+  public readonly table = "posts";
+
+  public async up(): Promise<void> {
+    // uuid / bigInteger / integer, matching the app's chosen PK type
+    this.foreignId("user_id").index();
+  }
+
+  public down(): void {
+    this.dropColumn("user_id");
+  }
+}
+```
+
+Reach for it on plain (non-`.references()`) FK id columns — e.g. a polymorphic `user_id` paired with a `user_type` — so a reference to a default-PK model is always type-compatible with that model's `id`.
+
 ## Raw SQL migrations
 
 For SQL-only changes (Postgres), `Migration.rawSql` builds a migration class for you: