Implement modified event

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Added
 
 - Augmenting the `ModelEvents` interface it is now possible to extend model events with custom events.
+- The following model events: `modified`, `relation-loaded`.
 
 ### Changed
 

src/models/Model.test.ts

@@ -1,5 +1,5 @@
 import { faker } from '@noeldemartin/faker';
-import { after, seconds, tt } from '@noeldemartin/utils';
+import { after, afterAnimationFrame, seconds, tt } from '@noeldemartin/utils';
 import type { Assert, Equals, Expect, Extends, HasKey , Not } from '@noeldemartin/utils';
 
 import InvalidModelDefinition from '@/errors/InvalidModelDefinition';
@@ -50,25 +50,42 @@ describe('Model', () => {
 
     it('emits events', async () => {
         // Arrange
+        const modifiedHistory: string[] = [];
         let createCount = 0;
         let updateCount = 0;
         let deleteCount = 0;
 
+        Post.on('modified', (_, field) => modifiedHistory.push(field));
         Post.on('created', () => createCount++);
         Post.on('updated', () => updateCount++);
         Post.on('deleted', () => deleteCount++);
 
         // Act
         const post = await Post.create({ title: faker.random.words() });
 
+        post.title = faker.random.words();
+        post.title = faker.random.words();
+        post.body = faker.lorem.paragraphs();
+
+        await after({ ms: 10 });
         post.update({ title: faker.random.words() });
+
+        await after({ ms: 10 });
         post.update({ title: faker.random.words() });
+
+        await after({ ms: 10 });
         post.update({ title: faker.random.words() });
 
+        await after({ ms: 10 });
         await Post.create({ title: faker.random.words() });
         await post.delete();
 
         // Assert
+        expect(modifiedHistory).toHaveLength(13);
+        expect(modifiedHistory.filter(field => field === 'title')).toHaveLength(5);
+        expect(modifiedHistory.filter(field => field === 'body')).toHaveLength(1);
+        expect(modifiedHistory.filter(field => field === 'createdAt')).toHaveLength(2);
+        expect(modifiedHistory.filter(field => field === 'updatedAt')).toHaveLength(5);
         expect(createCount).toBe(2);
         expect(updateCount).toBe(3);
         expect(deleteCount).toBe(1);

src/models/Model.ts

@@ -57,8 +57,9 @@ export type ModelCastAttributeOptions = {
 export interface ModelEvents {
     created: void;
     deleted: void;
-    'relation-loaded': Relation;
     updated: void;
+    modified: string;
+    'relation-loaded': Relation;
 }
 
 export type ModelEmitArgs<T extends keyof ModelEvents> =
@@ -593,9 +594,10 @@ export class Model {
     }
 
     public setAttribute(field: string, value: unknown): void {
-        return this.hasAttributeSetter(field)
-            ? this.callAttributeSetter(field, value)
-            : this.setAttributeValue(field, value);
+        const previousValue = this.getAttribute(field);
+
+        this.hasAttributeSetter(field) ? this.callAttributeSetter(field, value) : this.setAttributeValue(field, value);
+        this.attributeValueChanged(previousValue, value) && this.emit('modified', field);
     }
 
     public setAttributeValue(field: string, value: unknown): void {