archstone 1.0.1 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 João Henrique Benatti Coimbra
+
+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.

package/README.md

@@ -1,10 +1,32 @@
 # archstone
 
-A TypeScript-first architecture foundation for backend services, built around Domain-Driven Design (DDD) and Clean Architecture principles.
+[![npm version](https://img.shields.io/npm/v/archstone?style=flat-square)](https://www.npmjs.com/package/archstone)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](./LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5-blue?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![Bun](https://img.shields.io/badge/Bun-runtime-black?style=flat-square&logo=bun)](https://bun.sh)
+
+> TypeScript architecture foundation for backend services based on Domain-Driven Design (DDD) and Clean Architecture.
 
 Archstone provides the core building blocks — entities, value objects, aggregates, domain events, use cases, and repository contracts — so you can focus on your domain logic instead of re-implementing the same structural patterns across every project.
 
-## Layers
+## Installation
+
+```bash
+bun add archstone
+# or
+npm install archstone
+```
+
+## Packages
+
+| Import path | Contents |
+|---|---|
+| `archstone/core` | `Either`, `ValueObject`, `UniqueEntityId`, `WatchedList`, `Optional` |
+| `archstone/domain` | All domain exports |
+| `archstone/domain/enterprise` | `Entity`, `AggregateRoot`, `DomainEvent`, `DomainEvents`, `EventHandler` |
+| `archstone/domain/application` | `UseCase`, `UseCaseError`, repository contracts |
+
+## Architecture
 
 ```
 src/
@@ -45,7 +67,7 @@ src/
 Use cases never throw. They return an `Either<Error, Value>` — left for failure, right for success.
 
 ```ts
-import { Either, left, right } from "@/core/either"
+import { Either, left, right } from "archstone/core"
 
 type Result = Either<UserNotFoundError, User>
 
@@ -65,9 +87,8 @@ else console.log(result.value)                    // User
 Entities are defined by identity. Aggregates extend that with domain event support.
 
 ```ts
-import { AggregateRoot } from "@/domain/enterprise/entities/aggregate-root"
-import { UniqueEntityId } from "@/core/unique-entity-id"
-import { Optional } from "@/core/types/optional"
+import { AggregateRoot } from "archstone/domain/enterprise"
+import { UniqueEntityId, Optional } from "archstone/core"
 
 interface OrderProps {
   customerId: UniqueEntityId
@@ -94,7 +115,7 @@ class Order extends AggregateRoot<OrderProps> {
 Value objects are equal by their properties, not by reference.
 
 ```ts
-import { ValueObject } from "@/core/value-object"
+import { ValueObject } from "archstone/core"
 
 interface EmailProps { value: string }
 
@@ -113,6 +134,8 @@ class Email extends ValueObject<EmailProps> {
 Track additions and removals in a collection without rewriting the whole thing on save.
 
 ```ts
+import { WatchedList } from "archstone/core"
+
 class TagList extends WatchedList<Tag> {
   compareItems(a: Tag, b: Tag) { return a.id.equals(b.id) }
 }
@@ -130,6 +153,8 @@ tags.getRemovedItems() // [existingTag]
 Events are raised inside aggregates and dispatched by the infrastructure layer after successful persistence.
 
 ```ts
+import { DomainEvents } from "archstone/domain/enterprise"
+
 // register a handler
 DomainEvents.register(
   (event) => sendWelcomeEmail(event as UserCreatedEvent),
@@ -146,6 +171,8 @@ DomainEvents.dispatchEventsForAggregate(user.id)
 Repositories are defined as interfaces in the application layer. Implementations live in infrastructure.
 
 ```ts
+import { Repository, Creatable } from "archstone/domain/application"
+
 // application/repositories/user-repository.ts
 export interface UserRepository extends Repository<User> {
   findByEmail(email: string): Promise<User | null>
@@ -155,19 +182,14 @@ export interface UserRepository extends Repository<User> {
 export interface AuditRepository extends Creatable<AuditLog> {}
 ```
 
-## Getting Started
+## Contributing
 
-```bash
-bun install
-bun test
-```
+Contributions are welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) first.
 
-## Tech
+## Code of Conduct
 
-- [Bun](https://bun.sh) — runtime, bundler, and test runner
-- TypeScript 5 with strict mode
-- Zero runtime dependencies
+This project follows the [Contributor Covenant](./CODE_OF_CONDUCT.md).
 
 ## License
 
-MIT
+MIT — see [LICENSE](./LICENSE).

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "archstone",
-  "version": "1.0.1",
+  "description": "TypeScript architecture foundation for backend services based on Domain-Driven Design and Clean Architecture",
+  "version": "1.0.2",
   "type": "module",
   "private": false,
   "files": [
@@ -41,6 +42,33 @@
     },
     "./package.json": "./package.json"
   },
+  "keywords": [
+    "ddd",
+    "domain-driven-design",
+    "clean-architecture",
+    "typescript",
+    "entity",
+    "aggregate",
+    "value-object",
+    "either",
+    "domain-events",
+    "repository",
+    "use-case",
+    "bun"
+  ],
+  "author": {
+    "name": "João Henrique Benatti Coimbra",
+    "url": "https://github.com/joao-coimbra"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/joao-coimbra/archstone#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/joao-coimbra/archstone.git"
+  },
+  "bugs": {
+    "url": "https://github.com/joao-coimbra/archstone/issues"
+  },
   "scripts": {
     "build": "bunup",
     "dev": "bunup --watch",