@globalart/ddd 1.0.1 → 1.0.2

package/README.md

@@ -2,195 +2,19 @@
 
 A comprehensive Domain-Driven Design (DDD) toolkit for NestJS applications, providing essential building blocks for building robust, maintainable domain models.
 
-## Features
-
-- **Aggregate Root**: Base class for domain aggregates with domain event management
-- **Command & Query**: CQRS pattern implementation with command and query buses
-- **Value Objects**: Type-safe value objects with equality comparison
-- **Specifications**: Composite specification pattern for business rules
-- **Filtering**: Advanced filtering system with type-safe field operations
-- **Pagination**: Built-in pagination support with validation
-- **Repository Pattern**: Abstract repository interface
-- **Unit of Work**: Transaction management abstraction
-- **Domain Events**: Event-driven architecture support
-- **Exception Handling**: Domain-specific exception base classes
-
 ## Installation
 
 ```bash
 npm install @globalart/ddd
 ```
 
-## Quick Start
-
-### Aggregate Root
-
-```typescript
-import { AggregateRoot } from '@globalart/ddd';
-
-class UserCreatedEvent {
-  constructor(public readonly userId: string, public readonly email: string) {}
-}
-
-class User extends AggregateRoot<UserCreatedEvent> {
-  constructor(
-    public readonly id: string,
-    public readonly email: string,
-    public readonly name: string
-  ) {
-    super();
-    this.addDomainEvent(new UserCreatedEvent(id, email));
-  }
-}
-```
-
-### Value Objects
-
-```typescript
-import { ValueObject } from '@globalart/ddd';
-
-class Email extends ValueObject<string> {
-  constructor(value: string) {
-    if (!this.isValidEmail(value)) {
-      throw new Error('Invalid email format');
-    }
-    super({ value });
-  }
-
-  private isValidEmail(email: string): boolean {
-    return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email);
-  }
-}
-
-// Usage
-const email = new Email('user@example.com');
-const emailValue = email.unpack(); // 'user@example.com'
-```
-
-### Commands and Queries
-
-```typescript
-import { Command, Query } from '@globalart/ddd';
-
-class CreateUserCommand extends Command {
-  constructor(
-    public readonly email: string,
-    public readonly name: string,
-    correlationId?: string
-  ) {
-    super({ correlationId });
-  }
-}
-
-class GetUserQuery extends Query {
-  constructor(public readonly userId: string) {
-    super();
-  }
-}
-```
-
-### Specifications
-
-```typescript
-import { CompositeSpecification } from '@globalart/ddd';
-
-class UserEmailSpecification extends CompositeSpecification<User> {
-  isSatisfiedBy(user: User): boolean {
-    return user.email.includes('@');
-  }
-
-  mutate(user: User): Result<User, string> {
-    return this.isSatisfiedBy(user) 
-      ? Ok(user) 
-      : Err('Invalid email format');
-  }
-
-  accept(visitor: ISpecVisitor): Result<void, string> {
-    return Ok(undefined);
-  }
-}
-
-// Usage
-const emailSpec = new UserEmailSpecification();
-const isValid = emailSpec.isSatisfiedBy(user);
-```
-
-### Filtering
-
-```typescript
-import { StringFilter, NumberFilter, DateFilter } from '@globalart/ddd';
-
-// String filtering
-const nameFilter = new StringFilter('name', 'contains', 'john');
-
-// Number filtering
-const ageFilter = new NumberFilter('age', 'gte', 18);
-
-// Date filtering
-const createdFilter = new DateFilter('createdAt', 'after', new Date('2023-01-01'));
-```
-
-### Pagination
-
-```typescript
-import { IPagination, paginationSchema } from '@globalart/ddd';
-
-const pagination: IPagination = {
-  limit: 10,
-  offset: 0
-};
-
-// Validation
-const result = paginationSchema.parse(pagination);
-```
-
-### Repository Pattern
-
-```typescript
-import { Repository } from '@globalart/ddd';
-
-interface UserRepository extends Repository<User> {
-  findByEmail(email: string): Promise<User | null>;
-  findActiveUsers(): Promise<User[]>;
-}
-```
-
-## API Reference
-
-### Core Classes
-
-- `AggregateRoot<E>` - Base class for domain aggregates
-- `Command` - Base class for commands with correlation tracking
-- `Query` - Base class for queries
-- `ValueObject<T>` - Base class for value objects
-- `CompositeSpecification<T>` - Base class for business rules
-
-### Value Objects
-
-- `Id` - UUID-based identifier
-- `NanoId` - NanoID-based identifier
-- `StringVO` - String value object
-- `BooleanVO` - Boolean value object
-- `DateVO` - Date value object
-
-### Filtering
-
-- `StringFilter` - String field filtering
-- `NumberFilter` - Numeric field filtering
-- `DateFilter` - Date field filtering
-- `RootFilter` - Filter composition
-
-### Utilities
-
-- `IPagination` - Pagination interface
-- `ISort` - Sorting interface
-- `Repository<T>` - Repository interface
-- `UnitOfWork` - Transaction management
-
-## License
+## Documentation
 
-MIT
+📖 **[Complete documentation and usage examples](https://nestjs-toolkit.js.org/packages/ddd)**
 
-## Contributing
+The documentation includes:
+- Detailed guides for all components
+- Real-world usage scenarios
+- API reference
+- DDD best practices in NestJS
 
-Contributions are welcome! Please feel free to submit a Pull Request.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@globalart/ddd",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A advanced DDD for NestJS",
   "author": {
     "name": "GlobalArt, Inc"
@@ -27,7 +27,19 @@
   "keywords": [
     "ddd"
   ],
+  "scripts": {
+    "format": "prettier --write \"**/*.ts\"",
+    "test": "jest --runInBand --passWithNoTests",
+    "test:cov": "jest --coverage --passWithNoTests",
+    "coveralls": "yarn run test:cov --coverageReporters=text-lcov | coveralls",
+    "build": "tsdown",
+    "build:watch": "tsdown --watch",
+    "prepublishOnly": "npm run build",
+    "publish:dev": "npm publish --access public --tag dev",
+    "publish:npm": "release-it"
+  },
   "devDependencies": {
+    "release-it": "19.0.4",
     "tsdown": "0.14.2"
   },
   "publishConfig": {
@@ -42,15 +54,5 @@
     "ts-pattern": "5.8.0",
     "uuid": "12.0.0",
     "zod": "4.1.5"
-  },
-  "scripts": {
-    "format": "prettier --write \"**/*.ts\"",
-    "test": "jest --runInBand --passWithNoTests",
-    "test:cov": "jest --coverage --passWithNoTests",
-    "coveralls": "yarn run test:cov --coverageReporters=text-lcov | coveralls",
-    "build": "tsdown",
-    "build:watch": "tsdown --watch",
-    "publish:dev": "npm publish --access public --tag dev",
-    "publish:npm": "release-it"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2003 GlobalArt Inc
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.