@libs-for-dev/nestjs-ddd-library 1.1.1 → 1.2.1

package/README.md

@@ -10,6 +10,9 @@ A comprehensive library providing Domain-Driven Design (DDD) building blocks for
 - **Value Objects**: Immutable objects that contain attributes but have no conceptual identity with examples:
   - **UUID**: Built-in UUID v7 generation and validation
   - **Email**: Email value object with validation
+  - **Money**: Money value object with amount and currency (ISO 4217) validation
+  - **PhoneNumber**: Phone number value object with mobile phone validation
+  - **Url**: URL value object with protocol validation
 
 ## Installation
 
@@ -74,8 +77,65 @@ if (emailResult.isOk()) {
 }
 ```
 
+#### Money
+
+```typescript
+import { Money } from '@libs-for-dev/nestjs-ddd-library';
+
+// Create a Money value object
+const moneyResult = Money.create(100.50, 'USD');
+
+if (moneyResult.isOk()) {
+  const money = moneyResult.unwrap();
+  console.log(money.amount); // 100.50
+  console.log(money.currency); // USD
+  console.log(money.value); // { amount: 100.50, currency: 'USD' }
+} else {
+  // Handle error
+  console.error(moneyResult.unwrapErr());
+}
+```
+
+#### PhoneNumber
+
+```typescript
+import { PhoneNumber } from '@libs-for-dev/nestjs-ddd-library';
+
+// Create a PhoneNumber value object
+const phoneResult = PhoneNumber.create('+1234567890');
+
+if (phoneResult.isOk()) {
+  const phone = phoneResult.unwrap();
+  console.log(phone.value); // +1234567890
+} else {
+  // Handle error
+  console.error(phoneResult.unwrapErr());
+}
+```
+
+#### Url
+
+```typescript
+import { Url } from '@libs-for-dev/nestjs-ddd-library';
+
+// Create a Url value object
+const urlResult = Url.create('https://example.com');
+
+if (urlResult.isOk()) {
+  const url = urlResult.unwrap();
+  console.log(url.value); // https://example.com
+} else {
+  // Handle error
+  console.error(urlResult.unwrapErr());
+}
+```
+
 ### Entities
 
+`AbstractEntity` provides immutable properties through `DeepReadonly`. All properties, including nested objects, are readonly and cannot be modified directly. Changes must be made through entity domain methods.
+
+#### Basic Usage
+
 ```typescript
 import { AbstractEntity, Uuid } from '@libs-for-dev/nestjs-ddd-library';
 
@@ -118,6 +178,70 @@ user.updateName('Jane Doe');
 console.log(user.props.name); // Jane Doe
 ```
 
+#### Readonly Properties with Nested Objects
+
+Properties returned by `props` getter are deeply readonly, including nested objects. This ensures immutability and prevents accidental modifications:
+
+```typescript
+import { AbstractEntity, Uuid } from '@libs-for-dev/nestjs-ddd-library';
+
+interface UserProfileProps {
+  personal: {
+    firstName: string;
+    lastName: string;
+  };
+  settings: {
+    theme: string;
+  };
+}
+
+class UserProfile extends AbstractEntity<Uuid, UserProfileProps> {
+  public static create(id: Uuid, props: UserProfileProps): UserProfile {
+    return new UserProfile(id, props);
+  }
+
+  public updateFirstName(firstName: string): void {
+    this.propsData = {
+      props: {
+        ...this.props,
+        personal: {
+          ...this.props.personal,
+          firstName
+        }
+      }
+    };
+  }
+}
+
+// Usage
+const profile = UserProfile.create(Uuid.generate(), {
+  personal: {
+    firstName: 'John',
+    lastName: 'Doe'
+  },
+  settings: {
+    theme: 'dark'
+  }
+});
+
+// All properties are readonly, including nested objects
+// This will throw an error at runtime:
+// profile.props.personal.firstName = 'Jane'; // ❌ Error: Cannot assign to read-only property
+
+// This will also throw an error:
+// profile.props.settings.theme = 'light'; // ❌ Error: Cannot assign to read-only property
+
+// Changes must be made through domain methods
+profile.updateFirstName('Jane');
+console.log(profile.props.personal.firstName); // Jane
+
+// Previous references remain unchanged (immutability)
+const oldProps = profile.props;
+profile.updateFirstName('Bob');
+console.log(oldProps.personal.firstName); // Jane (unchanged)
+console.log(profile.props.personal.firstName); // Bob (updated)
+```
+
 ## Domain Events
 
 The library integrates with NestJS CQRS to support domain events:

package/dist/index.cjs

@@ -1 +1 @@
-let e=require(`class-validator`),t=require(`oxide.ts`),n=require(`fast-equals`),r=require(`ui7`),i=require(`@nestjs/cqrs`);var a=class extends Error{static name=`NotAMoneyError`;constructor(e,t){super(`Amount ${e} with currency ${t} is not valid money`)}},o=class extends Error{static name=`NotAPhoneNumberError`;constructor(e){super(`${e} is not a valid phone number`)}},s=class extends Error{static name=`NotAnEmailError`;constructor(e){super(`${e} is not a valid email`)}},c=class extends Error{static name=`NotAnUrlError`;constructor(e){super(`${e} is not a valid URL`)}},l=class extends Error{static name=`NotAnUuidError`;constructor(e){super(`${e} is not a valid UUID`)}},u=class{constructor(e){this.props=e}equals(e){return this.constructor.name===e.constructor.name?(0,n.deepEqual)(e.props,this.props):!1}},d=class n extends u{get value(){return this.props.value}static create(e){return this.isValid(e)?(0,t.Ok)(new n({value:e})):(0,t.Err)(new s(e))}static isValid(t){return(0,e.isEmail)(t)}},f=class e extends u{get amount(){return this.props.amount}get currency(){return this.props.currency}get value(){return{amount:this.amount,currency:this.currency}}static create(n,r){return this.isValid(n,r)?(0,t.Ok)(new e({amount:n,currency:r})):(0,t.Err)(new a(n,r))}static isValid(e,t){return!(e<0||!Number.isFinite(e)||!/^[A-Z]{3}$/u.test(t))}},p=class n extends u{get value(){return this.props.value}static create(e){return this.isValid(e)?(0,t.Ok)(new n({value:e})):(0,t.Err)(new o(e))}static isValid(t){return(0,e.isMobilePhone)(t)}},m=class n extends u{get value(){return this.props.value}static create(e){return this.isValid(e)?(0,t.Ok)(new n({value:e})):(0,t.Err)(new c(e))}static isValid(t){return(0,e.isURL)(t,{require_protocol:!0})}},h=class n extends u{get value(){return this.props.value}static create(r){return(0,e.isUUID)(r)?(0,t.Ok)(new n({value:r})):(0,t.Err)(new l(r))}static generate(){return new n({value:(0,r.v7)()})}};const g=e=>{let t=Object.getOwnPropertyNames(e);for(let n of t){let t=e[n];t!==void 0&&typeof t==`object`&&g(t)}return Object.freeze(e)};var _=class extends i.AggregateRoot{id;get props(){return g(this.propsData.props)}propsData;constructor(e,t){super(),this.id=e,this.propsData={props:t}}equals(e){return this.constructor.name===e.constructor.name?this.id===e.id:!1}};exports.AbstractEntity=_,exports.AbstractValueObject=u,exports.Email=d,exports.Money=f,exports.NotAMoneyError=a,exports.NotAPhoneNumberError=o,exports.NotAnEmailError=s,exports.NotAnUrlError=c,exports.NotAnUuidError=l,exports.PhoneNumber=p,exports.Url=m,exports.Uuid=h,exports.deepReadonly=g;
+let e=require(`class-validator`),t=require(`oxide.ts`),n=require(`fast-equals`),r=require(`ui7`),i=require(`@nestjs/cqrs`);var a=class extends Error{static name=`NotAMoneyError`;constructor(e,t){super(`Amount ${e} with currency ${t} is not valid money`)}},o=class extends Error{static name=`NotAPhoneNumberError`;constructor(e){super(`${e} is not a valid phone number`)}},s=class extends Error{static name=`NotAnEmailError`;constructor(e){super(`${e} is not a valid email`)}},c=class extends Error{static name=`NotAnUrlError`;constructor(e){super(`${e} is not a valid URL`)}},l=class extends Error{static name=`NotAnUuidError`;constructor(e){super(`${e} is not a valid UUID`)}},u=class{constructor(e){this.props=e}equals(e){return this.constructor.name===e.constructor.name?(0,n.deepEqual)(e.props,this.props):!1}},d=class n extends u{get value(){return this.props.value}static create(e){return this.isValid(e)?(0,t.Ok)(new n({value:e})):(0,t.Err)(new s(e))}static isValid(t){return(0,e.isEmail)(t)}},f=class e extends u{get amount(){return this.props.amount}get currency(){return this.props.currency}get value(){return{amount:this.amount,currency:this.currency}}static create(n,r){return this.isValid(n,r)?(0,t.Ok)(new e({amount:n,currency:r})):(0,t.Err)(new a(n,r))}static isValid(e,t){return!(e<0||!Number.isFinite(e)||!/^[A-Z]{3}$/u.test(t))}},p=class n extends u{get value(){return this.props.value}static create(e){return this.isValid(e)?(0,t.Ok)(new n({value:e})):(0,t.Err)(new o(e))}static isValid(t){return(0,e.isMobilePhone)(t)}},m=class n extends u{get value(){return this.props.value}static create(e){return this.isValid(e)?(0,t.Ok)(new n({value:e})):(0,t.Err)(new c(e))}static isValid(t){return(0,e.isURL)(t,{require_protocol:!0})}},h=class n extends u{get value(){return this.props.value}static create(r){return(0,e.isUUID)(r)?(0,t.Ok)(new n({value:r})):(0,t.Err)(new l(r))}static generate(){return new n({value:(0,r.v7)()})}};const g=e=>typeof e==`object`&&!!e&&typeof e!=`function`,_=e=>{let t=Object.getOwnPropertyNames(e);for(let n of t){let t=e[n];g(t)&&_(t)}return Object.freeze(e)};var v=class extends i.AggregateRoot{id;get props(){return _(this.propsData.props)}propsData;constructor(e,t){super(),this.id=e,this.propsData={props:t}}equals(e){return this.constructor.name===e.constructor.name?this.id===e.id:!1}};exports.AbstractEntity=v,exports.AbstractValueObject=u,exports.Email=d,exports.Money=f,exports.NotAMoneyError=a,exports.NotAPhoneNumberError=o,exports.NotAnEmailError=s,exports.NotAnUrlError=c,exports.NotAnUuidError=l,exports.PhoneNumber=p,exports.Url=m,exports.Uuid=h,exports.deepReadonly=_;

package/dist/index.d.cts

@@ -85,7 +85,7 @@ declare class Uuid extends AbstractValueObject<string> {
 }
 //#endregion
 //#region src/deep-readonly.d.ts
-type DeepReadonly<T> = Readonly<{ [K in keyof T]: T[K] extends (number | string | symbol) ? Readonly<T[K]> : T[K] extends (infer A)[] ? readonly DeepReadonly<A>[] : DeepReadonly<T[K]> }>;
+type DeepReadonly<T> = Readonly<{ [K in keyof T]: T[K] extends ((...arguments_: any[]) => any) ? T[K] : T[K] extends (number | string | symbol) ? Readonly<T[K]> : T[K] extends (infer A)[] ? readonly DeepReadonly<A>[] : DeepReadonly<T[K]> }>;
 declare const deepReadonly: <T>(object: T) => DeepReadonly<T>;
 //#endregion
 //#region src/abstract-entity.d.ts

package/dist/index.d.mts

@@ -85,7 +85,7 @@ declare class Uuid extends AbstractValueObject<string> {
 }
 //#endregion
 //#region src/deep-readonly.d.ts
-type DeepReadonly<T> = Readonly<{ [K in keyof T]: T[K] extends (number | string | symbol) ? Readonly<T[K]> : T[K] extends (infer A)[] ? readonly DeepReadonly<A>[] : DeepReadonly<T[K]> }>;
+type DeepReadonly<T> = Readonly<{ [K in keyof T]: T[K] extends ((...arguments_: any[]) => any) ? T[K] : T[K] extends (number | string | symbol) ? Readonly<T[K]> : T[K] extends (infer A)[] ? readonly DeepReadonly<A>[] : DeepReadonly<T[K]> }>;
 declare const deepReadonly: <T>(object: T) => DeepReadonly<T>;
 //#endregion
 //#region src/abstract-entity.d.ts

package/dist/index.mjs

@@ -1 +1 @@
-import{isEmail as e,isMobilePhone as t,isURL as n,isUUID as r}from"class-validator";import{Err as i,Ok as a}from"oxide.ts";import{deepEqual as o}from"fast-equals";import{v7 as s}from"ui7";import{AggregateRoot as c}from"@nestjs/cqrs";var l=class extends Error{static name=`NotAMoneyError`;constructor(e,t){super(`Amount ${e} with currency ${t} is not valid money`)}},u=class extends Error{static name=`NotAPhoneNumberError`;constructor(e){super(`${e} is not a valid phone number`)}},d=class extends Error{static name=`NotAnEmailError`;constructor(e){super(`${e} is not a valid email`)}},f=class extends Error{static name=`NotAnUrlError`;constructor(e){super(`${e} is not a valid URL`)}},p=class extends Error{static name=`NotAnUuidError`;constructor(e){super(`${e} is not a valid UUID`)}},m=class{constructor(e){this.props=e}equals(e){return this.constructor.name===e.constructor.name?o(e.props,this.props):!1}},h=class t extends m{get value(){return this.props.value}static create(e){return this.isValid(e)?a(new t({value:e})):i(new d(e))}static isValid(t){return e(t)}},g=class e extends m{get amount(){return this.props.amount}get currency(){return this.props.currency}get value(){return{amount:this.amount,currency:this.currency}}static create(t,n){return this.isValid(t,n)?a(new e({amount:t,currency:n})):i(new l(t,n))}static isValid(e,t){return!(e<0||!Number.isFinite(e)||!/^[A-Z]{3}$/u.test(t))}},_=class e extends m{get value(){return this.props.value}static create(t){return this.isValid(t)?a(new e({value:t})):i(new u(t))}static isValid(e){return t(e)}},v=class e extends m{get value(){return this.props.value}static create(t){return this.isValid(t)?a(new e({value:t})):i(new f(t))}static isValid(e){return n(e,{require_protocol:!0})}},y=class e extends m{get value(){return this.props.value}static create(t){return r(t)?a(new e({value:t})):i(new p(t))}static generate(){return new e({value:s()})}};const b=e=>{let t=Object.getOwnPropertyNames(e);for(let n of t){let t=e[n];t!==void 0&&typeof t==`object`&&b(t)}return Object.freeze(e)};var x=class extends c{id;get props(){return b(this.propsData.props)}propsData;constructor(e,t){super(),this.id=e,this.propsData={props:t}}equals(e){return this.constructor.name===e.constructor.name?this.id===e.id:!1}};export{x as AbstractEntity,m as AbstractValueObject,h as Email,g as Money,l as NotAMoneyError,u as NotAPhoneNumberError,d as NotAnEmailError,f as NotAnUrlError,p as NotAnUuidError,_ as PhoneNumber,v as Url,y as Uuid,b as deepReadonly};
+import{isEmail as e,isMobilePhone as t,isURL as n,isUUID as r}from"class-validator";import{Err as i,Ok as a}from"oxide.ts";import{deepEqual as o}from"fast-equals";import{v7 as s}from"ui7";import{AggregateRoot as c}from"@nestjs/cqrs";var l=class extends Error{static name=`NotAMoneyError`;constructor(e,t){super(`Amount ${e} with currency ${t} is not valid money`)}},u=class extends Error{static name=`NotAPhoneNumberError`;constructor(e){super(`${e} is not a valid phone number`)}},d=class extends Error{static name=`NotAnEmailError`;constructor(e){super(`${e} is not a valid email`)}},f=class extends Error{static name=`NotAnUrlError`;constructor(e){super(`${e} is not a valid URL`)}},p=class extends Error{static name=`NotAnUuidError`;constructor(e){super(`${e} is not a valid UUID`)}},m=class{constructor(e){this.props=e}equals(e){return this.constructor.name===e.constructor.name?o(e.props,this.props):!1}},h=class t extends m{get value(){return this.props.value}static create(e){return this.isValid(e)?a(new t({value:e})):i(new d(e))}static isValid(t){return e(t)}},g=class e extends m{get amount(){return this.props.amount}get currency(){return this.props.currency}get value(){return{amount:this.amount,currency:this.currency}}static create(t,n){return this.isValid(t,n)?a(new e({amount:t,currency:n})):i(new l(t,n))}static isValid(e,t){return!(e<0||!Number.isFinite(e)||!/^[A-Z]{3}$/u.test(t))}},_=class e extends m{get value(){return this.props.value}static create(t){return this.isValid(t)?a(new e({value:t})):i(new u(t))}static isValid(e){return t(e)}},v=class e extends m{get value(){return this.props.value}static create(t){return this.isValid(t)?a(new e({value:t})):i(new f(t))}static isValid(e){return n(e,{require_protocol:!0})}},y=class e extends m{get value(){return this.props.value}static create(t){return r(t)?a(new e({value:t})):i(new p(t))}static generate(){return new e({value:s()})}};const b=e=>typeof e==`object`&&!!e&&typeof e!=`function`,x=e=>{let t=Object.getOwnPropertyNames(e);for(let n of t){let t=e[n];b(t)&&x(t)}return Object.freeze(e)};var S=class extends c{id;get props(){return x(this.propsData.props)}propsData;constructor(e,t){super(),this.id=e,this.propsData={props:t}}equals(e){return this.constructor.name===e.constructor.name?this.id===e.id:!1}};export{S as AbstractEntity,m as AbstractValueObject,h as Email,g as Money,l as NotAMoneyError,u as NotAPhoneNumberError,d as NotAnEmailError,f as NotAnUrlError,p as NotAnUuidError,_ as PhoneNumber,v as Url,y as Uuid,x as deepReadonly};

package/package.json

@@ -1,17 +1,22 @@
 {
   "name": "@libs-for-dev/nestjs-ddd-library",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "NestJS DDD library",
   "keywords": [
     "ddd-library",
     "nestjs"
   ],
+  "homepage": "https://gitlab.com/libs-for-dev/nestjs/nestjs-ddd-library",
   "bugs": "https://gitlab.com/libs-for-dev/nestjs/nestjs-ddd-library/-/issues",
-  "repository": "https://gitlab.com/libs-for-dev/nestjs/nestjs-ddd-library",
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/libs-for-dev/nestjs/nestjs-ddd-library.git"
+  },
   "license": "MIT",
   "author": {
     "name": "libs-for-dev"
   },
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
@@ -39,7 +44,7 @@
     "test:unit": "vitest run"
   },
   "devDependencies": {
-    "@libs-for-dev/eslint-rules": "2.4.0",
+    "@libs-for-dev/eslint-rules": "2.5.0",
     "@nestjs/common": "^11.1.11",
     "@nestjs/core": "^11.1.11",
     "@nestjs/cqrs": "^11.0.3",
@@ -53,11 +58,11 @@
     "eslint": "9.39.2",
     "fast-equals": "^6.0.0",
     "jiti": "^2.6.1",
-    "knip": "^5.78.0",
+    "knip": "^5.79.0",
     "oxide.ts": "^1.1.0",
     "reflect-metadata": "^0.2.2",
     "scriptlint": "^3.0.0",
-    "tsdown": "0.18.4",
+    "tsdown": "0.19.0-beta.2",
     "typescript": "^5.9.3",
     "ui7": "^0.2.3",
     "vitest": "^4.0.16",