Merge pull request #231 from 4lessandrodev/chore/deps

Chore/deps

Author: 4lessandrodev

README.md

@@ -192,40 +192,49 @@ interface Props {
 
 export default class Money extends ValueObject<Props> {
 
-    // private constructor
+    // private constructor. Avoid public new.
     private constructor(props: Props) {
         super(props);
     }
 
-    // any business rule behavior
-    sum(x: Money): Money {
+    // any business rule behavior. Check.
+    public isGt(x: Money): boolean {
+        const { number: Check } = this.validator;
+        const xValue = x.get('amount');
+        const currentValue = this.get('amount');
+        return Check(x).isGreatThan(currentValue);
+    }
+
+    // any business rule behavior. Calc.
+    public sum(x: Money): Money {
         const { number: Calc } = this.util;
         const value = fee.get('amount');
-        const current = this.props.total.get('amount');
+        const current = this.get('amount');
         const amount = Calc(current).sum(value);
         return new Money({ amount });
     }
 
-    // any business rule behavior
-    subtract(x: Money): Money {
+    // any business rule behavior. Calc.
+    public subtract(x: Money): Money {
         const { number: Calc } = this.util;
         const value = fee.get('amount');
-        const current = this.props.total.get('amount');
+        const current = this.get('amount');
         const amount = Calc(current).subtract(value);
         return new Money({ amount });
     }
 
-    // any business rule
+    // any business rule to validate state.
     public static isValidProps({ amount }: Props): boolean {
-        return this.validator.number(amount).isPositive();
+        const { number: Check } = this.validator;
+        return Check(amount).isPositive();
     }
 
     // shortcut to create a zero value
     public static zero(): Money {
         return new Money({ amount: 0 });
     }
 
-    // factory method to create a instance
+    // factory method to create an instance and validate value.
     public static create(amount: number): Result<Money> {
 
         const isValid = this.isValidProps({ amount });
@@ -254,6 +263,17 @@ const money = result.value();
 
 money.get("amount"); // 500
 
+// using methods 
+money.isGt(Money.zero());
+
+> true
+
+const other = Money.create(100).value();
+
+const result = money.sum(other);
+
+result.get('amount'); // 600
+
 ```
 
 ---
@@ -275,41 +295,41 @@ interface Props {
     fees: Money;
 }
 
+// simple example as monetary value object business behavior
 export default class Payment extends Entity<Props> {
 
     // private constructor
     private constructor(props: Props){
         super(props);
     }
 
-    // any business rule behavior
-    checkDiscount(value: Money): Money {
-        const { number: Check } = this.validator;
-        const total = this.props.total.get('amount');
-        const discount = value.get('amount');
-        const isGt = Check(discount).isGreaterThan(total);
-        if(isGt) return this.props.total;
+    // any business rule behavior. Discount must be less or equal total.
+    public checkDiscount(value: Money): Money {
+        const total = this.props.total;
+        const isGt = value.isGt(total);
+        if(isGt) return total;
         return value;
     }
 
-    // any business rule behavior
-    applyFees(value: Money): Payment {
+    // any business rule behavior. Update total.
+    public applyFees(value: Money): Payment {
         const props = this.props;
-        const fees = props.fees.sum(value);
+        const currentFee = this.props.fee;
+        const fees = currentFee.sum(value);
         const total = props.total.sum(fees);
         return new Payment({ ...props, total, fees });
     }
 
-    // any business rule behavior
-    applyDiscount(value: Money): Payment {
+    // any business rule behavior. Discount must be less or equal total.
+    public applyDiscount(value: Money): Payment {
         const props = this.props;
         const result = this.checkDiscount(value);
         const discount = props.discount.subtract(result);
         const total = props.total.subtract(discount);
         return new Payment({ ...props, total, discount });
     }
 
-    // factory method to create a instance
+    // factory method to create a instance. Value must be positive.
     public static create(props: Props): Result<Payment> {
         return Ok(new Payment(props));
     }
@@ -352,6 +372,8 @@ console.log(result.toObject());
 
 ---
 
+### See also how to use Aggregate.
+
 ## Lib Full Documentation
 
 Check lib documentation on link [Here](https://github.com/4lessandrodev/types-ddd/tree/main/docs)

package.json

@@ -77,7 +77,7 @@
 		"rimraf": "^4.1.2",
 		"ts-jest": "^27.1.4",
 		"ts-node": "^10.7.0",
-		"typescript": "^4.9.4"
+		"typescript": "^4.9.5"
 	},
 	"peerDependencies": {
 		"bcrypt": "^5.0.1",

yarn.lock

@@ -4074,11 +4074,16 @@ typescript@^3.9.10, typescript@^3.9.5, typescript@^3.9.7:
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.10.tgz#70f3910ac7a51ed6bef79da7800690b19bf778b8"
   integrity sha512-w6fIxVE/H1PkLKcCPsFqKE7Kv7QUwhU8qQY2MueZXWx5cPZdwFupLgKK3vntcK98BtNHZtAF4LA/yl2a7k8R6Q==
 
-typescript@^4.0.0, typescript@^4.5.5, typescript@^4.9.4:
+typescript@^4.0.0, typescript@^4.5.5:
   version "4.9.4"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.4.tgz#a2a3d2756c079abda241d75f149df9d561091e78"
   integrity sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg==
 
+typescript@^4.9.5:
+  version "4.9.5"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.5.tgz#095979f9bcc0d09da324d58d03ce8f8374cbe65a"
+  integrity sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==
+
 uniq@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/uniq/-/uniq-1.0.1.tgz#b31c5ae8254844a3a8281541ce2b04b865a734ff"