edinburgh 0.5.0 → 0.6.1

package/skill/Lifecycle Hooks.md

@@ -0,0 +1,24 @@
+### Lifecycle Hooks
+
+- **`static migrate(record)`**: Called when deserializing rows written with an older schema
+  version. Receives a plain record object; mutate it in-place to match the current schema.
+
+- **`preCommit()`**: Called on each modified instance right before the transaction commits.
+  Useful for computing derived fields, enforcing cross-field invariants, or creating related
+  instances.
+
+**Examples:**
+
+```typescript
+const User = E.defineModel("User", class {
+  id = E.field(E.identifier);
+  name = E.field(E.string);
+  email = E.field(E.string);
+}, {
+  pk: "id",
+  unique: { email: "email" },
+});
+// Optional: declare a companion type so `let u: User` works.
+// Not needed if you only use `new User()`, `User.find()`, etc.
+type User = InstanceType<typeof User>;
+```

package/skill/{Model_delete.md → Lifecycle Hooks_delete.md }

@@ -1,4 +1,4 @@
-#### model.delete · method
+#### modelBase.delete · method
 
 Delete this model instance from the database.
 

package/skill/{Model_getPrimaryKeyHash.md → Lifecycle Hooks_getPrimaryKeyHash.md }

@@ -1,4 +1,4 @@
-#### model.getPrimaryKeyHash · method
+#### modelBase.getPrimaryKeyHash · method
 
 **Signature:** `() => number`
 

package/skill/{Model_isValid.md → Lifecycle Hooks_isValid.md }

@@ -1,4 +1,4 @@
-#### model.isValid · method
+#### modelBase.isValid · method
 
 Check if this model instance is valid.
 

package/skill/Lifecycle Hooks_migrate.md

@@ -0,0 +1,26 @@
+#### ModelBase.migrate · static method
+
+Optional migration function called when deserializing rows written with an older schema version.
+Receives a plain record with all fields and should mutate it in-place to match the current schema.
+It runs during lazy loading and during `runMigration()`. Changing this method creates a new schema version.
+If it updates values used by secondary or unique indexes, those index entries are refreshed only by `runMigration()`.
+
+**Signature:** `(record: Record<string, any>) => void`
+
+**Parameters:**
+
+- `record: Record<string, any>` - A plain object containing the row's field values from the older schema version.
+
+**Examples:**
+
+```typescript
+const User = E.defineModel("User", class {
+  id = E.field(E.identifier);
+  name = E.field(E.string);
+  role = E.field(E.string);
+
+  static migrate(record: Record<string, any>) {
+    record.role ??= "user";
+  }
+}, { pk: "id" });
+```

package/skill/{Model_preCommit.md → Lifecycle Hooks_preCommit.md }

@@ -1,4 +1,4 @@
-#### model.preCommit · method
+#### modelBase.preCommit · method
 
 Optional hook called on each modified instance right before the transaction commits.
 Runs before data is written to disk, so changes made here are included in the commit.
@@ -14,7 +14,7 @@ Common use cases:
 **Examples:**
 
 ```typescript
-const Post = E.defineModel(class {
+const Post = E.defineModel("Post", class {
   id = E.field(E.identifier);
   title = E.field(E.string);
   slug = E.field(E.string);

package/skill/{Model_preventPersist.md → Lifecycle Hooks_preventPersist.md }

@@ -1,4 +1,4 @@
-#### model.preventPersist · method
+#### modelBase.preventPersist · method
 
 Prevent this instance from being persisted to the database.
 

package/skill/{Model_validate.md → Lifecycle Hooks_validate.md }

@@ -1,4 +1,4 @@
-#### model.validate · method
+#### modelBase.validate · method
 
 Validate all fields in this model instance.
 
@@ -6,7 +6,7 @@ Validate all fields in this model instance.
 
 **Parameters:**
 
-- `raise: boolean` (optional) - - If true, throw on first validation error.
+- `raise: boolean` (optional) - If true, throw on first validation error.
 
 **Returns:** Array of validation errors (empty if valid).
 

package/skill/ModelBase.md

@@ -0,0 +1,7 @@
+### ModelBase · abstract class
+
+Base class for all database models in the Edinburgh ORM.
+
+Models represent database entities with typed fields, automatic serialization,
+change tracking, and relationship management. Model classes are created using
+`E.defineModel()`.

package/skill/ModelClass.md

@@ -0,0 +1,8 @@
+### ModelClass · class
+
+Runtime base constructor for model classes returned by `defineModel()`.
+
+Prefer the `ModelClass` type alias for annotations and the result of
+`defineModel()` for concrete model classes.
+
+**Type:** `typeof ModelClassRuntime`