@woltz/rich-domain 1.1.0 → 1.2.1

package/dist/value-object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"value-object.d.ts","sourceRoot":"","sources":["../src/value-object.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC;AACjC,OAAO,EACL,OAAO,EAGP,gBAAgB,EACjB,MAAM,SAAS,CAAC;AAYjB,8BAAsB,WAAW,CAAC,CAAC;IACjC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAG,CAAC,CAAC;IAC7B,OAAO,CAAC,gBAAgB,CAA6B;IACrD,OAAO,CAAC,WAAW,CAAC,CAAkB;IACtC,OAAO,CAAC,YAAY,CAAC,CAAoB;IACzC,OAAO,CAAC,YAAY,CAAsB;IAG1C,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpD,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAE/B,KAAK,EAAE,CAAC;IA2CpB,OAAO,CAAC,aAAa;IA4BrB,OAAO,CAAC,cAAc;IAmBtB;;OAEG;IACH,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,eAAe,GAAG,SAAS,CAElD;IAED,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO;IAKtC;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAInD;;OAEG;IACH,oBAAoB,IAAI,YAAY,EAAE;IAItC;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;OAEG;IACH,oBAAoB,IAAI,OAAO;IAI/B,MAAM,IAAI,CAAC;IAIX;;;OAGG;IACH,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI;CAI3C"}
+{"version":3,"file":"value-object.d.ts","sourceRoot":"","sources":["../src/value-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC;AACjC,OAAO,EACL,OAAO,EAGP,gBAAgB,EACjB,MAAM,SAAS,CAAC;AAYjB;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC;AAE7D,8BAAsB,WAAW,CAAC,CAAC;IACjC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAG,CAAC,CAAC;IAC7B,OAAO,CAAC,gBAAgB,CAA6B;IACrD,OAAO,CAAC,WAAW,CAAC,CAAkB;IACtC,OAAO,CAAC,YAAY,CAAC,CAAoB;IACzC,OAAO,CAAC,YAAY,CAAsB;IAE1C,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpD,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAE3C;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC;gBAE9C,KAAK,EAAE,CAAC;IAqCpB,OAAO,CAAC,aAAa;IA2BrB,OAAO,CAAC,cAAc;IAgBtB;;OAEG;IACH,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,eAAe,GAAG,SAAS,CAElD;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO;IAKtC;;;;;;;;;;;;;;OAcG;IACH,cAAc,IAAI,MAAM,GAAG,IAAI;IAiB/B;;OAEG;IACH,cAAc,IAAI,OAAO;IAOzB;;OAEG;IACH,MAAM,CAAC,wBAAwB,CAAC,CAAC,KAAK,qBAAqB,CAAC,CAAC,CAAC,GAAG,SAAS;IAI1E;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAInD;;OAEG;IACH,oBAAoB,IAAI,YAAY,EAAE;IAItC;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;OAEG;IACH,oBAAoB,IAAI,OAAO;IAI/B,MAAM,IAAI,CAAC;IAIX;;;OAGG;IACH,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI;CAI3C"}

package/dist/value-object.js

@@ -1,6 +1,3 @@
-// ============================================================================
-// Value Object - Immutable Domain Objects
-// ============================================================================
 import { ValidationError } from "./validation-error";
 import { DEFAULT_VALIDATION_CONFIG } from "./constants";
 import { DomainError } from "./exceptions";
@@ -11,7 +8,6 @@ function getStaticProperty(instance, propertyName) {
 export class ValueObject {
     constructor(props) {
         this.domainEvents = [];
-        // Get static configuration from subclass
         const validation = getStaticProperty(this, "validation");
         const hooks = getStaticProperty(this, "hooks");
         this.domainHooks = hooks;
@@ -23,19 +19,14 @@ export class ValueObject {
             ...validation?.config,
         };
         let finalProps = { ...props };
-        // Validate schema on creation
         if (this.domainSchema && this.validationConfig.onCreate) {
             this.validateProps(finalProps);
         }
-        // Set props (not frozen yet) so rules can access them
         this.props = finalProps;
-        // Execute rules (custom validations) - after props is set but before freezing
         if (hooks?.rules) {
             hooks.rules(this);
         }
-        // Now freeze the props for immutability
         Object.freeze(this.props);
-        // Hook onCreate
         if (hooks?.onCreate) {
             hooks.onCreate(this);
         }
@@ -55,7 +46,6 @@ export class ValueObject {
             if (this.validationConfig.throwOnError) {
                 throw validationError;
             }
-            // If not throwing, store error for later retrieval
             this._validationError = validationError;
         }
     }
@@ -63,57 +53,95 @@ export class ValueObject {
         if (pathSegment === null || pathSegment === undefined) {
             return "";
         }
-        // Handle PropertyKey (string | number | symbol)
         if (typeof pathSegment === "string" || typeof pathSegment === "number") {
             return String(pathSegment);
         }
         if (typeof pathSegment === "symbol") {
             return pathSegment.toString();
         }
-        // Handle object with 'key' property (Zod's PathSegment)
         if (typeof pathSegment === "object" && "key" in pathSegment) {
             return String(pathSegment.key);
         }
-        // Fallback
         return String(pathSegment);
     }
     /**
-     * Check if value object has validation errors (when throwOnError is false)
+     * Returns true if the value object has validation errors (when throwOnError is false).
      */
     get hasValidationErrors() {
         return !!this._validationError;
     }
     /**
-     * Get validation errors (when throwOnError is false)
+     * Returns the validation errors (when throwOnError is false).
      */
     get validationErrors() {
         return this._validationError;
     }
+    /**
+     * Compare this ValueObject with another for equality based on their properties.
+     */
     equals(other) {
         if (!other || !(other instanceof ValueObject))
             return false;
         return JSON.stringify(this.props) === JSON.stringify(other.props);
     }
     /**
-     * Add a domain event to this value object
+     * Returns the identity key for this Value Object.
+     * Used for identification in collections when identityKey is set.
+     *
+     * @returns String with the identity key or null if not defined
+     *
+     * @example
+     * ```typescript
+     * const like = new Like({ postId: 'p1', userId: 'u1' });
+     * like.getIdentityKey(); // 'p1:u1'
+     *
+     * const tag = new TagReference({ tagId: 'tag-123' });
+     * tag.getIdentityKey(); // 'tag-123'
+     * ```
+     */
+    getIdentityKey() {
+        const keyDef = getStaticProperty(this, "identityKey");
+        if (!keyDef) {
+            return null;
+        }
+        if (Array.isArray(keyDef)) {
+            return keyDef.map((k) => String(this.props[k])).join(":");
+        }
+        return String(this.props[keyDef]);
+    }
+    /**
+     * Returns true if this Value Object has an identity key defined.
+     */
+    hasIdentityKey() {
+        return (getStaticProperty(this, "identityKey") !==
+            undefined);
+    }
+    /**
+     * Returns the identity key definition (if any).
+     */
+    static getIdentityKeyDefinition() {
+        return this.identityKey;
+    }
+    /**
+     * Adds a domain event to this value object.
      */
     addDomainEvent(event) {
         this.domainEvents.push(event);
     }
     /**
-     * Get all uncommitted domain events
+     * Returns all uncommitted domain events.
      */
     getUncommittedEvents() {
         return [...this.domainEvents];
     }
     /**
-     * Clear all domain events (call after publishing)
+     * Clears all domain events (call after publishing).
      */
     clearEvents() {
         this.domainEvents = [];
     }
     /**
-     * Check if value object has uncommitted events
+     * Returns true if the value object has uncommitted events.
      */
     hasUncommittedEvents() {
         return this.domainEvents.length > 0;
@@ -122,8 +150,8 @@ export class ValueObject {
         return { ...this.props };
     }
     /**
-     * Create a new ValueObject with updated properties
-     * Since ValueObjects are immutable, this returns a new instance
+     * Creates a new ValueObject with updated properties.
+     * ValueObjects are immutable, so this returns a new instance.
      */
     clone(updates) {
         const Constructor = this.constructor;

package/dist/value-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"value-object.js","sourceRoot":"","sources":["../src/value-object.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,0CAA0C;AAC1C,+EAA+E;AAE/E,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAQrD,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,mDAAmD;AACnD,SAAS,iBAAiB,CACxB,QAAa,EACb,YAAoB;IAEpB,OAAO,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,OAAgB,WAAW;IAW/B,YAAY,KAAQ;QANZ,iBAAY,GAAmB,EAAE,CAAC;QAOxC,yCAAyC;QACzC,MAAM,UAAU,GAAG,iBAAiB,CAClC,IAAI,EACJ,YAAY,CACb,CAAC;QACF,MAAM,KAAK,GAAG,iBAAiB,CAAkB,IAAI,EAAE,OAAO,CAAC,CAAC;QAEhE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,IAAI,UAAU,EAAE,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC;QACxC,CAAC;QAED,IAAI,CAAC,gBAAgB,GAAG;YACtB,GAAG,yBAAyB;YAC5B,GAAG,UAAU,EAAE,MAAM;SACtB,CAAC;QAEF,IAAI,UAAU,GAAG,EAAE,GAAG,KAAK,EAAO,CAAC;QAEnC,8BAA8B;QAC9B,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YACxD,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACjC,CAAC;QAED,sDAAsD;QACrD,IAAY,CAAC,KAAK,GAAG,UAAU,CAAC;QAEjC,8EAA8E;QAC9E,IAAI,KAAK,EAAE,KAAK,EAAE,CAAC;YACjB,KAAK,CAAC,KAAK,CAAC,IAAW,CAAC,CAAC;QAC3B,CAAC;QAED,wCAAwC;QACxC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1B,gBAAgB;QAChB,IAAI,KAAK,EAAE,QAAQ,EAAE,CAAC;YACpB,KAAK,CAAC,QAAQ,CAAC,IAAW,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAEO,aAAa,CAAC,KAAQ;QAC5B,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,OAAO;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE9D,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;YAC9B,MAAM,IAAI,WAAW,CACnB,4EAA4E,CAC7E,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,MAAM,eAAe,GAAG,IAAI,eAAe,CACzC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC5B,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;gBAC1D,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC,CAAC,CACJ,CAAC;YAEF,IAAI,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;gBACvC,MAAM,eAAe,CAAC;YACxB,CAAC;YAED,mDAAmD;YAClD,IAAY,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACnD,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,WAAoB;QACzC,IAAI,WAAW,KAAK,IAAI,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YACtD,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,gDAAgD;QAChD,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACvE,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC;QACD,wDAAwD;QACxD,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,KAAK,IAAI,WAAW,EAAE,CAAC;YAC5D,OAAO,MAAM,CAAE,WAAgC,CAAC,GAAG,CAAC,CAAC;QACvD,CAAC;QACD,WAAW;QACX,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,mBAAmB;QACrB,OAAO,CAAC,CAAE,IAAY,CAAC,gBAAgB,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAI,gBAAgB;QAClB,OAAQ,IAAY,CAAC,gBAAgB,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,KAAqB;QAC1B,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,YAAY,WAAW,CAAC;YAAE,OAAO,KAAK,CAAC;QAC5D,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,KAAmB;QAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,OAAO,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,WAAW;QACT,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,MAAM;QACJ,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,OAAmB;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAqC,CAAC;QAC/D,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;CACF"}
+{"version":3,"file":"value-object.js","sourceRoot":"","sources":["../src/value-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAQrD,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,mDAAmD;AACnD,SAAS,iBAAiB,CACxB,QAAa,EACb,YAAoB;IAEpB,OAAO,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;AAC5C,CAAC;AAOD,MAAM,OAAgB,WAAW;IA6B/B,YAAY,KAAQ;QAxBZ,iBAAY,GAAmB,EAAE,CAAC;QAyBxC,MAAM,UAAU,GAAG,iBAAiB,CAClC,IAAI,EACJ,YAAY,CACb,CAAC;QACF,MAAM,KAAK,GAAG,iBAAiB,CAAkB,IAAI,EAAE,OAAO,CAAC,CAAC;QAEhE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,IAAI,UAAU,EAAE,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC;QACxC,CAAC;QAED,IAAI,CAAC,gBAAgB,GAAG;YACtB,GAAG,yBAAyB;YAC5B,GAAG,UAAU,EAAE,MAAM;SACtB,CAAC;QAEF,IAAI,UAAU,GAAG,EAAE,GAAG,KAAK,EAAO,CAAC;QAEnC,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YACxD,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACjC,CAAC;QAEA,IAAY,CAAC,KAAK,GAAG,UAAU,CAAC;QAEjC,IAAI,KAAK,EAAE,KAAK,EAAE,CAAC;YACjB,KAAK,CAAC,KAAK,CAAC,IAAW,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1B,IAAI,KAAK,EAAE,QAAQ,EAAE,CAAC;YACpB,KAAK,CAAC,QAAQ,CAAC,IAAW,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAEO,aAAa,CAAC,KAAQ;QAC5B,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,OAAO;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE9D,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;YAC9B,MAAM,IAAI,WAAW,CACnB,4EAA4E,CAC7E,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,MAAM,eAAe,GAAG,IAAI,eAAe,CACzC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC5B,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;gBAC1D,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC,CAAC,CACJ,CAAC;YAEF,IAAI,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;gBACvC,MAAM,eAAe,CAAC;YACxB,CAAC;YAEA,IAAY,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACnD,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,WAAoB;QACzC,IAAI,WAAW,KAAK,IAAI,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YACtD,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACvE,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,KAAK,IAAI,WAAW,EAAE,CAAC;YAC5D,OAAO,MAAM,CAAE,WAAgC,CAAC,GAAG,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,mBAAmB;QACrB,OAAO,CAAC,CAAE,IAAY,CAAC,gBAAgB,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAI,gBAAgB;QAClB,OAAQ,IAAY,CAAC,gBAAgB,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAqB;QAC1B,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,YAAY,WAAW,CAAC;YAAE,OAAO,KAAK,CAAC;QAC5D,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc;QACZ,MAAM,MAAM,GAAG,iBAAiB,CAC9B,IAAI,EACJ,aAAa,CACd,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5D,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,CACL,iBAAiB,CAA2B,IAAI,EAAE,aAAa,CAAC;YAChE,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,wBAAwB;QAC7B,OAAQ,IAAY,CAAC,WAAW,CAAC;IACnC,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,KAAmB;QAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,OAAO,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,WAAW;QACT,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,MAAM;QACJ,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,OAAmB;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAqC,CAAC;QAC/D,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;CACF"}

package/eslint.config.js

@@ -1,5 +1,10 @@
 import tsParser from "@typescript-eslint/parser";
 import tsPlugin from "@typescript-eslint/eslint-plugin";
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 
 export default [
   {
@@ -19,6 +24,7 @@ export default [
         ecmaVersion: 2020,
         sourceType: "module",
         project: "./tsconfig.json",
+        tsconfigRootDir: __dirname,
       },
       globals: {
         console: "readonly",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@woltz/rich-domain",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Rich Domain Library with Standard Schema validation support",
   "homepage": "https://github.com/tarcisioandrade/rich-domain",
   "type": "module",
@@ -41,6 +41,7 @@
     "typescript"
   ],
   "devDependencies": {
+    "@faker-js/faker": "^9.9.0",
     "zod": "^3.24.0"
   },
   "peerDependencies": {

package/src/aggregate-changes.ts

@@ -0,0 +1,335 @@
+import {
+  Operation,
+  CreateOperation,
+  UpdateOperation,
+  DeleteOperation,
+  BatchOperations,
+  BatchCreateItem,
+  BatchUpdateItem,
+} from "./types/change-tracker";
+import { EntityChanges } from "./entity-changes";
+
+/**
+ * Manages and organizes the changes of an Aggregate.
+ *
+ * Responsibilities:
+ * - Stores all operations (create, update, delete)
+ * - Orders operations respecting FK dependencies
+ * - Groups operations by entity for batch execution
+ * - Provides query and iteration methods
+ *
+ * @example
+ * ```typescript
+ * // Define an entity map for type-safe operations
+ * type UserEntities = {
+ *   User: User;
+ *   Post: Post;
+ *   Comment: Comment;
+ * };
+ *
+ * // Getting changes with types
+ * const changes = user.getChanges<UserEntities>();
+ *
+ * // Filtering by entity with autocompletion
+ * const postChanges = changes.for('Post'); // 'Post' autocompletes
+ * postChanges.creates.forEach(post => {
+ *   console.log(post.title); // 'post' is typed as Post
+ * });
+ * ```
+ */
+export class AggregateChanges<TEntityMap = Record<string, any>> {
+  private ops: Operation[] = [];
+
+  constructor(operations: Operation[] = []) {
+    this.ops = [...operations];
+  }
+
+  /**
+   * Adds a create operation.
+   */
+  addCreate<T>(
+    entity: string,
+    data: T,
+    depth: number,
+    parentId?: string,
+    parentEntity?: string
+  ): void {
+    this.ops.push({
+      type: "create",
+      entity,
+      data,
+      depth,
+      parentId,
+      parentEntity,
+    } as CreateOperation<T>);
+  }
+
+  /**
+   * Adds an update operation.
+   */
+  addUpdate<T>(
+    entity: string,
+    id: string,
+    data: T,
+    changedFields: Record<string, any>,
+    depth: number
+  ): void {
+    this.ops.push({
+      type: "update",
+      entity,
+      id,
+      data,
+      changedFields,
+      depth,
+    } as UpdateOperation<T>);
+  }
+
+  /**
+   * Adds a delete operation.
+   */
+  addDelete<T>(entity: string, id: string, data: T, depth: number): void {
+    this.ops.push({
+      type: "delete",
+      entity,
+      id,
+      data,
+      depth,
+    } as DeleteOperation<T>);
+  }
+
+  /**
+   * Returns all create operations, sorted by ascending depth (root → leaf).
+   */
+  creates(): CreateOperation[] {
+    return this.ops
+      .filter((op): op is CreateOperation => op.type === "create")
+      .sort((a, b) => a.depth - b.depth);
+  }
+
+  /**
+   * Returns all update operations.
+   */
+  updates(): UpdateOperation[] {
+    return this.ops.filter((op): op is UpdateOperation => op.type === "update");
+  }
+
+  /**
+   * Returns all delete operations, sorted by descending depth (leaf → root).
+   */
+  deletes(): DeleteOperation[] {
+    return this.ops
+      .filter((op): op is DeleteOperation => op.type === "delete")
+      .sort((a, b) => b.depth - a.depth);
+  }
+
+  /**
+   * Iterator that returns operations in the correct execution order:
+   * 1. Deletes (leaf → root)
+   * 2. Creates (root → leaf)
+   * 3. Updates
+   */
+  *operations(): Generator<Operation> {
+    yield* this.deletes();
+    yield* this.creates();
+    yield* this.updates();
+  }
+
+  /**
+   * Returns all operations as an array in execution order.
+   */
+  toArray(): Operation[] {
+    return [...this.operations()];
+  }
+
+  /**
+   * Converts the changes into BatchOperations for optimized execution.
+   *
+   * Groups operations by entity and sorts by depth:
+   * - Deletes: depth DESC (leaf → root)
+   * - Creates: depth ASC (root → leaf)
+   * - Updates: grouped by entity
+   *
+   * @example
+   * ```typescript
+   * const batch = changes.toBatchOperations();
+   *
+   * // Run deletes
+   * for (const del of batch.deletes) {
+   *   await tx[del.entity].deleteMany({ where: { id: { in: del.ids } } });
+   * }
+   *
+   * // Run creates
+   * for (const create of batch.creates) {
+   *   await tx[create.entity].createMany({ data: create.items });
+   * }
+   * ```
+   */
+  toBatchOperations(): BatchOperations {
+    return {
+      deletes: this.groupDeletes(),
+      creates: this.groupCreates(),
+      updates: this.groupUpdates(),
+    };
+  }
+
+  /**
+   * Groups deletes by entity, sorted by descending depth.
+   */
+  private groupDeletes(): BatchOperations["deletes"] {
+    const deleteOps = this.deletes();
+    const grouped = new Map<string, { depth: number; ids: string[] }>();
+
+    for (const op of deleteOps) {
+      if (!grouped.has(op.entity)) {
+        grouped.set(op.entity, { depth: op.depth, ids: [] });
+      }
+      grouped.get(op.entity)!.ids.push(op.id);
+    }
+
+    return Array.from(grouped.entries())
+      .map(([entity, { depth, ids }]) => ({ entity, depth, ids }))
+      .sort((a, b) => b.depth - a.depth);
+  }
+
+  /**
+   * Groups creates by entity, sorted by ascending depth.
+   */
+  private groupCreates(): BatchOperations["creates"] {
+    const createOps = this.creates();
+    const grouped = new Map<
+      string,
+      { depth: number; items: BatchCreateItem[] }
+    >();
+
+    for (const op of createOps) {
+      if (!grouped.has(op.entity)) {
+        grouped.set(op.entity, { depth: op.depth, items: [] });
+      }
+      grouped.get(op.entity)!.items.push({
+        data: op.data,
+        parentId: op.parentId,
+      });
+    }
+
+    return Array.from(grouped.entries())
+      .map(([entity, { depth, items }]) => ({ entity, depth, items }))
+      .sort((a, b) => a.depth - b.depth);
+  }
+
+  /**
+   * Groups updates by entity.
+   */
+  private groupUpdates(): BatchOperations["updates"] {
+    const updateOps = this.updates();
+    const grouped = new Map<string, BatchUpdateItem[]>();
+
+    for (const op of updateOps) {
+      if (!grouped.has(op.entity)) {
+        grouped.set(op.entity, []);
+      }
+      grouped.get(op.entity)!.push({
+        id: op.id,
+        changedFields: op.changedFields,
+      });
+    }
+
+    return Array.from(grouped.entries()).map(([entity, items]) => ({
+      entity,
+      items,
+    }));
+  }
+
+  /**
+   * Filters changes by entity name.
+   *
+   * @param entityName - Name of the entity (e.g., 'Post', 'Comment')
+   * @returns EntityChanges containing only the operations for this entity
+   *
+   * @example
+   * ```typescript
+   * const postChanges = changes.for('Post');
+   *
+   * if (postChanges.hasCreates()) {
+   *   postChanges.creates.forEach(post => {
+   *     console.log('New post:', post.title);
+   *   });
+   * }
+   * ```
+   */
+  for<K extends keyof TEntityMap>(entityName: K): EntityChanges<TEntityMap[K]> {
+    const filtered = this.ops.filter((op) => op.entity === entityName);
+    return new EntityChanges<TEntityMap[K]>(filtered);
+  }
+
+  /**
+   * Checks if there are create operations.
+   */
+  hasCreates(): boolean {
+    return this.ops.some((op) => op.type === "create");
+  }
+
+  /**
+   * Checks if there are update operations.
+   */
+  hasUpdates(): boolean {
+    return this.ops.some((op) => op.type === "update");
+  }
+
+  /**
+   * Checks if there are delete operations.
+   */
+  hasDeletes(): boolean {
+    return this.ops.some((op) => op.type === "delete");
+  }
+
+  /**
+   * Checks if there are any operations.
+   */
+  hasChanges(): boolean {
+    return this.ops.length > 0;
+  }
+
+  /**
+   * Checks if there are no operations.
+   */
+  isEmpty(): boolean {
+    return this.ops.length === 0;
+  }
+
+  /**
+   * Returns the total number of operations.
+   */
+  get count(): number {
+    return this.ops.length;
+  }
+
+  /**
+   * Returns the raw operations (for debug/testing).
+   */
+  get rawOperations(): Operation[] {
+    return [...this.ops];
+  }
+
+  /**
+   * Lists all entities that have changes.
+   */
+  getAffectedEntities(): string[] {
+    const entities = new Set<string>();
+    this.ops.forEach((op) => entities.add(op.entity));
+    return Array.from(entities);
+  }
+
+  /**
+   * Clears all operations.
+   */
+  clear(): void {
+    this.ops = [];
+  }
+
+  /**
+   * Creates a copy of the changes.
+   */
+  clone(): AggregateChanges<TEntityMap> {
+    return new AggregateChanges<TEntityMap>([...this.ops]);
+  }
+}