@inovys/domain-driven-design 0.1.0-RC.1

package/README.md

@@ -0,0 +1,20 @@
+<div align="center">
+  <h1>Inovys - Domain Driven Design</h1>
+
+  <p>
+    <a href="./README.md" target="_blank">
+      <img alt="Version" src="https://img.shields.io/badge/version-0.1.0-blue.svg">
+    </a>
+    <a href="./LICENSE" target="_blank">
+      <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-green.svg" />
+    </a>
+  </p>
+</div>
+
+## 📝 Table of content
+
+- 👋 [Introduction](#👋-introduction)
+
+## 👋 Introduction
+
+Welcome to the NestJS Boilerplate. This project provides a solid foundation for building scalable and maintainable backend applications with NestJS, following the [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html). It also integrates concepts from [Domain-Driven Design (DDD)](https://martinfowler.com/bliki/DomainDrivenDesign.html) to help organize your code around the core business logic.

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":""}

package/dist/main.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":""}

package/dist/primitives/aggregate-root.d.ts

@@ -0,0 +1,8 @@
+import type { DomainEvent } from "./domain-event.js";
+import { Entity } from "./entity.js";
+export declare abstract class AggregateRoot<Properties extends Record<keyof Properties, unknown>> extends Entity<Properties> {
+    private readonly _events;
+    protected commit(event: DomainEvent): void;
+    pullDomainEvents(): DomainEvent<Record<string, unknown>>[];
+}
+//# sourceMappingURL=aggregate-root.d.ts.map

package/dist/primitives/aggregate-root.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregate-root.d.ts","sourceRoot":"","sources":["../../src/primitives/aggregate-root.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,8BAAsB,aAAa,CACjC,UAAU,SAAS,MAAM,CAAC,MAAM,UAAU,EAAE,OAAO,CAAC,CACpD,SAAQ,MAAM,CAAC,UAAU,CAAC;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAE7C,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW;IAInC,gBAAgB;CAMjB"}

package/dist/primitives/aggregate-root.js

@@ -0,0 +1,13 @@
+import { Entity } from "./entity.js";
+export class AggregateRoot extends Entity {
+    _events = [];
+    commit(event) {
+        this._events.push(event);
+    }
+    pullDomainEvents() {
+        const events = [...this._events];
+        this._events.length = 0;
+        return events;
+    }
+}
+//# sourceMappingURL=aggregate-root.js.map

package/dist/primitives/aggregate-root.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregate-root.js","sourceRoot":"","sources":["../../src/primitives/aggregate-root.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,OAAgB,aAEpB,SAAQ,MAAkB;IACT,OAAO,GAAkB,EAAE,CAAC;IAEnC,MAAM,CAAC,KAAkB;QACjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,gBAAgB;QACd,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QAExB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/primitives/domain-event.d.ts

@@ -0,0 +1,11 @@
+interface CreateDomainEventProps<Payload = Record<string, unknown>> {
+    payload: Payload;
+}
+export declare abstract class DomainEvent<Payload = Record<string, unknown>> {
+    readonly id: string;
+    readonly payload: Payload;
+    readonly type: string;
+    constructor(properties: CreateDomainEventProps<Payload>);
+}
+export {};
+//# sourceMappingURL=domain-event.d.ts.map

package/dist/primitives/domain-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"domain-event.d.ts","sourceRoot":"","sources":["../../src/primitives/domain-event.ts"],"names":[],"mappings":"AAEA,UAAU,sBAAsB,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAChE,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,8BAAsB,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACjE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,UAAU,EAAE,sBAAsB,CAAC,OAAO,CAAC;CAKxD"}

package/dist/primitives/domain-event.js

@@ -0,0 +1,12 @@
+import { randomUUID } from "node:crypto";
+export class DomainEvent {
+    id;
+    payload;
+    type;
+    constructor(properties) {
+        this.id = randomUUID();
+        this.payload = properties.payload;
+        this.type = this.constructor.name;
+    }
+}
+//# sourceMappingURL=domain-event.js.map

package/dist/primitives/domain-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domain-event.js","sourceRoot":"","sources":["../../src/primitives/domain-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,MAAM,OAAgB,WAAW;IACtB,EAAE,CAAS;IACX,OAAO,CAAU;IACjB,IAAI,CAAS;IAEtB,YAAY,UAA2C;QACrD,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF"}

package/dist/primitives/entity.d.ts

@@ -0,0 +1,21 @@
+interface EntityProperties {
+    id: string;
+}
+interface CreateEntityProperties<Properties extends Record<keyof Properties, unknown>> {
+    id?: EntityProperties["id"];
+    properties: Properties;
+}
+export declare abstract class Entity<Properties extends Record<keyof Properties, unknown>> {
+    readonly id: EntityProperties["id"];
+    protected readonly _properties: Properties;
+    constructor({ id, properties }: CreateEntityProperties<Properties>);
+    static fromSnapshot<Constructor extends new (...args: any) => any>(this: Constructor, snapshot: InstanceType<Constructor>["_properties"] & EntityProperties): InstanceType<Constructor>;
+    get properties(): Readonly<{
+        id: string;
+    } & Properties>;
+    snapshot(): Properties & {
+        id: string;
+    };
+}
+export {};
+//# sourceMappingURL=entity.d.ts.map

package/dist/primitives/entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../src/primitives/entity.ts"],"names":[],"mappings":"AAEA,UAAU,gBAAgB;IACxB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,UAAU,sBAAsB,CAAC,UAAU,SAAS,MAAM,CAAC,MAAM,UAAU,EAAE,OAAO,CAAC;IACnF,EAAE,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC5B,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,8BAAsB,MAAM,CAAC,UAAU,SAAS,MAAM,CAAC,MAAM,UAAU,EAAE,OAAO,CAAC;IAC/E,SAAgB,EAAE,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC3C,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC;gBAE/B,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAKlE,MAAM,CAAC,YAAY,CAAC,WAAW,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,EAC/D,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,GAAG,gBAAgB,GACpE,YAAY,CAAC,WAAW,CAAC;IAQ5B,IAAI,UAAU;;oBAKb;IAED,QAAQ;;;CAIT"}

package/dist/primitives/entity.js

@@ -0,0 +1,26 @@
+import { randomUUID } from "node:crypto";
+export class Entity {
+    id;
+    _properties;
+    constructor({ id, properties }) {
+        this.id = id ?? randomUUID();
+        this._properties = properties;
+    }
+    static fromSnapshot(snapshot) {
+        const { id, ...properties } = snapshot;
+        // 'this' inside a static method correctly refers to the class (constructor function) that invoked it.
+        // biome-ignore lint:complexity/noThisInStatic
+        return new this({ id, properties });
+    }
+    get properties() {
+        return Object.freeze({
+            id: this.id,
+            ...this._properties,
+        });
+    }
+    snapshot() {
+        const snapshot = { ...this._properties, id: this.id };
+        return snapshot;
+    }
+}
+//# sourceMappingURL=entity.js.map

package/dist/primitives/entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.js","sourceRoot":"","sources":["../../src/primitives/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAWzC,MAAM,OAAgB,MAAM;IACV,EAAE,CAAyB;IACxB,WAAW,CAAa;IAE3C,YAAY,EAAE,EAAE,EAAE,UAAU,EAAsC;QAChE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,UAAU,EAAE,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,YAAY,CAEjB,QAAqE;QAErE,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,QAAQ,CAAC;QAEvC,sGAAsG;QACtG,8CAA8C;QAC9C,OAAO,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,GAAG,IAAI,CAAC,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED,QAAQ;QACN,MAAM,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;QACtD,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@inovys/domain-driven-design",
+  "version": "0.1.0-RC.1",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/main.js",
+      "types": "./dist/main.d.ts"
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.2",
+    "oxfmt": "^0.43.0",
+    "oxlint": "^1.58.0",
+    "typescript": "^6.0.2"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}