tshex-cli 1.0.19 → 1.0.21

package/README.md

@@ -140,1100 +140,29 @@ users/
 └── languages/
 ```
 
-## Library structure
+## Documentation index
 
-The library is divided into a root, a shared directory, and one or more contexts. Each level has a role in the implementation.
+From this point on, the guide is split into dedicated documents under `docs/`.
 
-### Root
+### General
 
-The root contains `index.d.ts` and `main.ts`.
+- [Library structure](https://github.com/virtualitems/tshex-cli/blob/main/docs/library-structure.md)
+- [Library types](https://github.com/virtualitems/tshex-cli/blob/main/docs/library-types.md)
+- [Context ports](https://github.com/virtualitems/tshex-cli/blob/main/docs/context-ports.md)
+- [Generated file reference](https://github.com/virtualitems/tshex-cli/blob/main/docs/generated-file-reference.md)
 
-`index.d.ts` declares the types available to the library. `main.ts` starts as a placeholder for the main implementation and the public components that belong directly to that entry point.
+### Shared application
 
-### Shared code
+- [shared/application/data](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/application/data.md)
+- [shared/application/events.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/application/events.md)
+- [shared/application/http.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/application/http.md)
+- [shared/application/loggers.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/application/loggers.md)
+- [shared/application/services.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/application/services.md)
+- [shared/application/validations.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/application/validations.md)
 
-The `shared` directory contains code used by multiple contexts. It holds abstractions, interfaces, contracts, base types, and specific implementations with a common meaning across the library.
+### Shared domain
 
-```text
-shared/
-├── domain/
-└── application/
-```
-
-`shared/domain` contains foundations for modeling business concepts. `shared/application` contains contracts for coordinating use cases, data sources, events, validations, HTTP responses, and logs.
-
-### Contexts
-
-A context represents an application capability and groups its vocabulary, rules, and operations.
-
-```text
-users/
-billing/
-sales/
-inventory/
-```
-
-Separating by context organizes an application around its capabilities. Multiple contexts can be part of the same project, process, and data source. Each context preserves its own rules while sharing the general abstractions in `shared`.
-
-Each generated context contains three directories:
-
-```text
-domain/
-application/
-adapters/
-```
-
-#### `domain`
-
-Contains the context's capabilities. A capability groups business knowledge that can be used in different processes: validating an email address, identifying an entity, calculating a price, changing an order's status, or grouping the parts of a sale.
-
-Value objects, entities, and aggregates materialize these capabilities through data, rules, and behavior.
-
-#### `application`
-
-Contains the application of domain capabilities in processes that fulfill system purposes.
-
-An application service combines capabilities to complete an operation. For example, the process of registering a user can validate the email address, construct the entity, save its data, publish an event, and log the result.
-
-#### Context root
-
-The generated context root contains `example-ports.ts` as a starting point for the context's ports. You can keep that file, replace it, or add `index.ts` and other `.ts` files at the context root as the communication surface grows.
-
-A port describes a form of communication between the context and another system. It defines the received data, the returned data, and the operation available at that boundary.
-
-#### `adapters`
-
-Contains the integrations that connect the context with other systems. An adapter imports a port, implements the communication defined by that port, and connects an external input or output to an application process.
-
-An adapter can integrate an HTTP controller, a message consumer, an SDK, a driver, a remote client, an event bus, or a logging provider.
-
-### Layered architecture
-
-The structure is organized into three levels: capabilities, processes, and communication.
-
-```text
-External system
-      ↕
-Port + adapter
-      ↓
-  Application
-      ↓
-    Domain
-```
-
-The domain occupies the inner layer and contains the context's capabilities.
-
-The application occupies the middle layer and uses those capabilities to build processes that fulfill system purposes.
-
-Ports and adapters occupy the outer layer and handle communication between systems.
-
-A port declares the communication available at the context boundary: what data enters, what data leaves, and which operation is exposed. Ports are declared in `.ts` modules located at the context root. Many projects centralize them in `index.ts`, but the generated template starts with `example-ports.ts`.
-
-An adapter implements that communication. It imports the corresponding port, translates external input or output into the application process format, and delegates the work to the application service.
-
-The import direction follows this path:
-
-```text
-adapter → port
-adapter → application
-application → domain
-```
-
-One possible arrangement is to keep `users/example-ports.ts` at the context root and replace the starter export with your own contracts as the context grows. In this guide, the examples stay close to the generated files: value objects extend `ValueObject`, entities extend `Entity`, services extend `Service`, repositories extend `Repository`, and ports live at the context root.
-
-> **Tip:** start the implementation inside the context and move a component to `shared` when its meaning and use belong to multiple contexts.
-
-## Library types
-
-### `index.d.ts`
-
-The file declares the generic type:
-
-```ts
-type Generic<T = unknown> = Record<string, T>
-```
-
-`Generic<T>` represents an object with `string` keys and values of a common type.
-
-```ts
-const filters: Generic<string> = {
-    status: 'active'
-}
-```
-
-When the type is omitted, the values use `unknown`:
-
-```ts
-const metadata: Generic = {
-    retries: 2
-}
-```
-
-Data source contracts use this form to represent plain objects whose specific structure will be defined by each implementation.
-
-## Shared domain
-
-The domain starts with small concepts and progresses toward structures that combine multiple identities. We will begin with value objects, continue with entities, and finish with aggregates.
-
-### Value objects
-
-A value object represents a concept with its own rules, semantics, or behavior. Its identity is determined by its value.
-
-The `shared/domain/value-objects.ts` file generates the `ValueObject<T>` base class and the `Email` and `NullableBoolean` implementations.
-
-#### Create an email address
-
-`Email` turns text into a domain concept with validation and its own operations:
-
-```ts
-import { Email } from './core/shared/domain/value-objects.js'
-
-const email = Email.from('ana@example.com')
-
-email.value
-email.username
-email.domain
-```
-
-Creation is performed with `Email.from()`. This method runs `Email.isValid()` before constructing the instance.
-
-```ts
-Email.isValid('ana@example.com')
-```
-
-Every creation follows the same validity rule:
-
-```text
-received value
-    ↓
-isValid(value)
-    ↓
-from(value)
-    ↓
-valid instance
-```
-
-When validation fails, `from()` throws `ValueError`.
-
-> **Tip:** use a native type when it fully expresses the data. Create a value object when the concept provides its own rules or operations. A text identifier can be represented with `string`; an email address benefits from `Email` because it includes validation and behavior.
-
-#### Represent a nullable Boolean state
-
-`NullableBoolean` models the values `true`, `false`, and `null`:
-
-```ts
-import { NullableBoolean } from './core/shared/domain/value-objects.js'
-
-const active = NullableBoolean.from(null)
-
-active.value
-active.isIndeterminate()
-```
-
-The `isIndeterminate()` method expresses an operation specific to the concept and allows the `null` state to be checked with explicit intent.
-
-#### Implement a value object
-
-We will create a user name. The example has one rule and one small operation so the focus stays on the value object itself.
-
-```ts
-import { ValueError } from '../../shared/domain/errors.js'
-import { ValueObject } from '../../shared/domain/value-objects.js'
-
-export class UserName extends ValueObject<string> {
-    public override readonly value: string
-
-    protected constructor(value: string) {
-        super()
-        this.value = value
-    }
-
-    public override equals(
-        other: UserName | null | undefined
-    ): boolean {
-        return other instanceof UserName &&
-            this.value === other.value
-    }
-
-    public normalized(): string {
-        return this.value.trim().toLowerCase()
-    }
-
-    public static override isValid(value: unknown): boolean {
-        if (super.isValid(value) === false) {
-            return false
-        }
-
-        return typeof value === 'string' &&
-            value.trim().length > 0
-    }
-
-    public static from(value: string): UserName {
-        if (this.isValid(value) === false) {
-            throw new ValueError(value, this.name)
-        }
-
-        return new this(value)
-    }
-}
-```
-
-Now we can create and use the concept:
-
-```ts
-const name = UserName.from('Ana')
-const normalized = name.normalized()
-```
-
-`isValid()` centralizes the rule. `from()` creates the valid instance. `normalized()` adds behavior specific to the concept.
-
-### Entities
-
-An entity represents a concept with its own identity. Two instances represent the same element when they share that identity.
-
-The `shared/domain/entities.ts` file generates the `Entity` base class. Each entity implements `equals()`. The inherited `toJSON()` method can be overridden when you want to return a plain object.
-
-This example creates an entity for the `users` context.
-
-```ts
-import { Entity } from '../../shared/domain/entities.js'
-import {
-    Email,
-    NullableBoolean
-} from '../../shared/domain/value-objects.js'
-
-type UserName = {
-    value: string
-}
-
-export class User extends Entity {
-    public constructor(
-        public readonly id: string,
-        public readonly name: UserName,
-        public readonly email: Email,
-        public readonly active: NullableBoolean
-    ) {
-        super()
-    }
-
-    public override equals(other: Entity): boolean {
-        return other instanceof User && other.id === this.id
-    }
-
-    public override toJSON(): Record<string, unknown> {
-        return {
-            id: this.id,
-            name: this.name.value,
-            email: this.email.value,
-            active: this.active.value
-        }
-    }
-}
-```
-
-The `id` property defines the identity. The `equals()` method compares entities using that property.
-
-`toJSON()` produces a plain representation of the entity:
-
-```ts
-const user = new User(
-    'user-1',
-    UserName.from('Ana'),
-    Email.from('ana@example.com'),
-    NullableBoolean.from(true)
-)
-
-const json = user.toJSON()
-```
-
-The result uses the internal values of `UserName`, `Email`, and `NullableBoolean`.
-
-### Aggregates
-
-An aggregate groups multiple entities into a logical unit. The aggregate's operations depend on all the identities that compose it.
-
-A user list can group several users:
-
-```text
-UserList
-└── items
-```
-
-Each element preserves its own identity within the unit.
-
-```ts
-import { Aggregate } from '../../shared/domain/aggregates.js'
-
-type User = {
-    id: string
-}
-
-export class UserList extends Aggregate {
-    public constructor(public readonly items: User[]) {
-        super()
-    }
-
-    public count(): number {
-        return this.items.length
-    }
-}
-```
-
-`UserList` groups multiple `User` entities into a single logical unit. The `count()` method operates on that group.
-
-### Domain errors
-
-The `shared/domain/errors.ts` file generates `ValueError`. This error represents a received value that does not satisfy the expected rule.
-
-```ts
-import { ValueError } from '../../shared/domain/errors.js'
-
-if (userId.trim().length === 0) {
-    throw new ValueError(userId, 'UserId')
-}
-```
-
-Because it is in `shared`, `ValueError` can be used from any context and by any domain concept that validates values.
-
-## Shared application
-
-The application layer coordinates use cases. Its contracts connect the domain with validations, data sources, HTTP responses, logs, and events.
-
-### Validations
-
-The `shared/application/validations.ts` file declares the `Validatable` contract:
-
-```ts
-isValid(): boolean
-```
-
-`isValid()` checks whether the data is valid according to the rule defined by the implementation.
-
-We will create a validation for the use case that registers users.
-
-```ts
-import type { Validatable } from '../../shared/application/validations.js'
-import { Email } from '../../shared/domain/value-objects.js'
-
-export type CreateUserValidationData = {
-    name: string
-    email: string
-}
-
-export class CreateUserValidation implements Validatable {
-    public constructor(
-        private readonly data: CreateUserValidationData
-    ) {}
-
-    public isValid(): boolean {
-        return this.data.name.trim().length > 0 &&
-            Email.isValid(this.data.email)
-    }
-}
-```
-
-In this example, the application service runs this validation before constructing the `User` entity.
-
-### Services
-
-Services represent application use cases. Each service applies domain capabilities in a process that fulfills a purpose, such as creating a user, confirming an order, or recording a payment.
-
-The `shared/application/services.ts` file generates the `Service` base class. A concrete implementation defines its inputs, dependencies, and the method that executes the process.
-
-We will begin with a service that creates a user.
-
-```ts
-import type { Validatable } from '../../shared/application/validations.js'
-import { Service } from '../../shared/application/services.js'
-import {
-    Email,
-    NullableBoolean
-} from '../../shared/domain/value-objects.js'
-
-export type CreateUserData = {
-    id: string
-    name: string
-    email: string
-}
-
-export class UserName {
-    public constructor(public readonly value: string) {}
-
-    public static from(value: string): UserName {
-        return new UserName(value.trim())
-    }
-}
-
-export class User {
-    public constructor(
-        public readonly id: string,
-        public readonly name: UserName,
-        public readonly email: Email,
-        public readonly active: NullableBoolean
-    ) {}
-}
-
-export class CreateUserValidation implements Validatable {
-    public constructor(
-        private readonly data: CreateUserData
-    ) {}
-
-    public isValid(): boolean {
-        return this.data.name.trim().length > 0 &&
-            Email.isValid(this.data.email)
-    }
-}
-
-export interface UserWriter {
-    save(data: { user: User }): Promise<void>
-}
-
-export type CreateUserResult = {
-    user: {
-        id: string
-        name: string
-        email: string
-        active: boolean | null
-    }
-}
-
-export class CreateUserService extends Service {
-    public constructor(private readonly users: UserWriter) {
-        super()
-    }
-
-    public async execute(data: CreateUserData): Promise<CreateUserResult> {
-        const validation = new CreateUserValidation(data)
-
-        if (validation.isValid() === false) {
-            throw new Error('The name or email is invalid.')
-        }
-
-        const user = new User(
-            data.id,
-            UserName.from(data.name),
-            Email.from(data.email),
-            NullableBoolean.from(true)
-        )
-
-        await this.users.save({ user })
-
-        return {
-            user: {
-                id: user.id,
-                name: user.name.value,
-                email: user.email.value,
-                active: user.active.value
-            }
-        }
-    }
-}
-```
-
-In this example, the service receives one object, validates it, constructs the entity, delegates persistence, and returns another object with the result.
-
-### HTTP responses
-
-The `shared/application/http.ts` file generates lightweight HTTP contracts: `HttpRequest`, `HttpResponse`, `HttpResponseBody`, `HttpRequestHandler`, and `HttpMiddleware`.
-
-`HttpResponseBody` is an interface organized into three properties:
-
-```ts
-import type { HttpResponseBody } from '../../shared/application/http.js'
-
-const body: HttpResponseBody = {
-    data,
-    errors,
-    links
-}
-```
-
-`data` contains the operation data and accepts `null` when the response has no data:
-
-```ts
-const body: HttpResponseBody = {
-    data: {
-        id: 'user-1',
-        name: 'Ana'
-    },
-    errors: null,
-    links: null
-}
-```
-
-`errors` contains a list of messages:
-
-```ts
-const body: HttpResponseBody = {
-    data: null,
-    errors: ['The email is invalid.'],
-    links: null
-}
-```
-
-`links` contains HATEOAS links related to the resource and its available operations:
-
-```ts
-const body: HttpResponseBody = {
-    data: {
-        id: 'user-1',
-        name: 'Ana'
-    },
-    errors: null,
-    links: {
-        self: new URL('https://api.example.com/users/user-1')
-    }
-}
-```
-
-An entity's plain output can be used as `data`:
-
-```ts
-const body: HttpResponseBody = {
-    data: user.toJSON(),
-    errors: null,
-    links: null
-}
-```
-
-`HttpRequestHandler` and `HttpMiddleware` define the contracts for adapters that receive a request, delegate to a handler, and produce a response.
-
-### Logs
-
-The `shared/application/loggers.ts` file declares the `Logger` contract. The application uses this abstraction to produce logs that an adapter sends to external services.
-
-The contract includes the `debug`, `info`, `warning`, `error`, and `critical` levels, together with the numeric constants `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`.
-
-We will create a simple adapter that connects the contract to the console.
-
-```ts
-import { Logger } from '../../shared/application/loggers.js'
-
-export class ConsoleLoggerAdapter extends Logger {
-    public debug(data: unknown): void {
-        console.debug(data)
-    }
-
-    public info(data: unknown): void {
-        console.info(data)
-    }
-
-    public warning(data: unknown): void {
-        console.warn(data)
-    }
-
-    public error(data: unknown): void {
-        console.error(data)
-    }
-
-    public critical(data: unknown): void {
-        console.error(data)
-    }
-}
-```
-
-In this example, the service receives `Logger` as a dependency. The adapter decides where to send each level.
-
-### Events
-
-The `shared/application/events.ts` file contains the contracts that connect the application to an event bus.
-
-The flow starts with an event, continues through the dispatcher, and ends in one or more handlers:
-
-```text
-Service
-    ↓ creates
-Event
-    ↓ passes to
-EventDispatcher
-    ↓ publishes to
-Event bus
-    ↓ executes
-EventHandler
-```
-
-#### Event
-
-`Event` represents something that occurred in the application. It contains the event time and its plain details.
-
-```ts
-import { Event } from '../../shared/application/events.js'
-
-export class UserCreated extends Event {
-    public constructor(details: { userId: string }) {
-        super(Date.now(), details)
-    }
-}
-```
-
-#### Handler
-
-`EventHandler` represents a reaction to the event.
-
-```ts
-import {
-    Event,
-    EventHandler
-} from '../../shared/application/events.js'
-import { Logger } from '../../shared/application/loggers.js'
-
-export class LogUserCreated extends EventHandler {
-    public constructor(private readonly logger: Logger) {
-        super()
-    }
-
-    public async handle(event: Event): Promise<void> {
-        this.logger.info(event.details)
-    }
-}
-```
-
-#### Dispatcher
-
-`EventDispatcher` represents the interaction contract with the event bus. Its concrete implementation subscribes handlers, removes subscriptions, and dispatches events.
-
-```ts
-subscribe(key, handler)
-unsubscribe(key, handler)
-dispatch(event)
-```
-
-In one possible implementation, the service can receive `EventDispatcher` and publish `UserCreated` after completing the use case.
-
-## Data sources
-
-The `shared/application/data/` directory organizes access to a data source into three modules: `drivers.ts`, `managers.ts`, and `repositories.ts`. Together, they define `DriverAdapter`, `DataManager`, `DatasetManager`, and `Repository`.
-
-The complete flow looks like this:
-
-```text
-DriverAdapter
-    ↓ connects and enables
-DataManager or DatasetManager
-    ↓ provides plain data to
-Repository
-    ↓ transforms
-Domain objects
-    ↓ used by
-Service
-```
-
-We will begin with the connection and proceed to the use case.
-
-### Driver adapter
-
-`DriverAdapter` connects and disconnects the source through a driver. When the connection is available, `connect()` returns an enabled data manager.
-
-```ts
-connect(...args): Promise<DataManager>
-disconnect(): Promise<unknown>
-```
-
-We will create an adapter for an in-memory collection of users. This example avoids a database so the focus stays on the adapter's responsibility, not on infrastructure details.
-
-```ts
-import { DriverAdapter } from '../../shared/application/data/drivers.js'
-import { DataManager } from '../../shared/application/data/managers.js'
-
-type UserRecord = {
-    id: string
-    name: string
-    email: string
-    active: boolean | null
-}
-
-class UserDataManager extends DataManager<UserRecord> {
-    public constructor(private readonly records: UserRecord[]) {
-        super()
-    }
-
-    public async all(): Promise<UserRecord[]> {
-        return this.records
-    }
-}
-
-export class UserDriverAdapter
-    extends DriverAdapter<UserDataManager> {
-
-    public constructor(private readonly records: UserRecord[]) {
-        super()
-    }
-
-    public async connect(): Promise<UserDataManager> {
-        return new UserDataManager(this.records)
-    }
-
-    public async disconnect(): Promise<void> {
-    }
-}
-```
-
-The concrete implementation can encapsulate a database driver, an HTTP client, a file system, or another source.
-
-### Data manager
-
-`DataManager` operates on the source and works with plain objects and arrays. Its base form exposes one abstract operation and one default operation:
-
-```ts
-all(): Promise<Array<T>>
-none(): Array<T>
-```
-
-`all()` retrieves the available records. `none()` already creates an empty typed collection.
-
-First, we will define the shape used by the source:
-
-```ts
-type UserRecord = {
-    id: string
-    name: string
-    email: string
-    active: boolean | null
-}
-```
-
-Now we will implement the data manager.
-
-```ts
-import { DataManager } from '../../shared/application/data/managers.js'
-
-export type UserRecord = {
-    id: string
-    name: string
-    email: string
-    active: boolean | null
-}
-
-export class UserDataManager
-    extends DataManager<UserRecord> {
-
-    public constructor(private readonly records: UserRecord[]) {
-        super()
-    }
-
-    public async all(): Promise<UserRecord[]> {
-        return this.records
-    }
-}
-```
-
-The data manager reflects the structure of the source. In this example, it only exposes plain records.
-
-#### Source operations
-
-The file also declares interfaces that extend a data manager's capabilities:
-
-| Interface | Operation |
-| --- | --- |
-| `Filterable` | Filters records. |
-| `Sortable` | Sorts records. |
-| `Creatable` | Creates records. |
-| `Updatable` | Updates records. |
-| `Deletable` | Deletes records. |
-| `Aggregatable` | Performs aggregations. |
-| `Relatable` | Selects or preloads relationships. |
-
-A data manager can implement the interfaces required by its source:
-
-```ts
-import {
-    Creatable,
-    DataManager,
-    Filterable
-} from '../../shared/application/data/managers.js'
-
-export class UserDataManager
-    extends DataManager<UserRecord>
-    implements
-        Filterable<Partial<UserRecord>>,
-        Creatable<UserRecord> {
-
-    public constructor(private readonly records: UserRecord[]) {
-        super()
-    }
-
-    public async all(): Promise<UserRecord[]> {
-        return this.records
-    }
-
-    public async filter(
-        selector: Partial<UserRecord>
-    ): Promise<UserRecord[]> {
-        return this.records.filter((record) =>
-            (selector.id === undefined || record.id === selector.id) &&
-            (selector.email === undefined || record.email === selector.email)
-        )
-    }
-
-    public async create(data: UserRecord): Promise<void> {
-        this.records.push(data)
-    }
-}
-```
-
-It can also declare operations specific to source queries:
-
-```ts
-public async findByEmail(query: { email: string }): Promise<UserRecord[]> {
-    return this.filter({ email: query.email })
-}
-```
-
-The application layer decides when to execute these operations, combines their results, and catches errors produced by the source.
-
-### Dataset manager
-
-`DatasetManager` extends `DataManager` with set operations:
-
-```ts
-union()
-intersection()
-difference()
-symmetricDifference()
-complement()
-```
-
-This implementation is useful when an operation works with unions, intersections, differences, and complements between data collections.
-
-### Repository
-
-`Repository` acts as an intermediary between plain data and domain objects.
-
-```text
-UserRecord
-    ↓ transform
-User
-```
-
-The generated base class focuses on reading plain data and transforming it into domain objects. Using the `UserDriverAdapter` from the previous example, a repository can stay very small.
-
-Now we will implement the repository.
-
-```ts
-import { DriverAdapter } from '../../shared/application/data/drivers.js'
-import { DataManager } from '../../shared/application/data/managers.js'
-import { Repository } from '../../shared/application/data/repositories.js'
-import {
-    Email,
-    NullableBoolean
-} from '../../shared/domain/value-objects.js'
-
-type UserRecord = {
-    id: string
-    name: string
-    email: string
-    active: boolean | null
-}
-
-class UserName {
-    public constructor(public readonly value: string) {}
-
-    public static from(value: string): UserName {
-        return new UserName(value)
-    }
-}
-
-class User {
-    public constructor(
-        public readonly id: string,
-        public readonly name: UserName,
-        public readonly email: Email,
-        public readonly active: NullableBoolean
-    ) {}
-}
-
-export class UserRepository
-    extends Repository<UserRecord, User> {
-
-    public constructor(
-        driver: DriverAdapter<DataManager<UserRecord>>
-    ) {
-        super(driver)
-    }
-
-    protected override transform(data: UserRecord): User {
-        return new User(
-            data.id,
-            UserName.from(data.name),
-            Email.from(data.email),
-            NullableBoolean.from(data.active)
-        )
-    }
-}
-```
-
-Here, `transform()` converts each record into an entity. The constructor receives any driver compatible with `DataManager<UserRecord>`, and the inherited `all()` method already handles the connect, read, transform, and disconnect flow.
-
-### Queries and errors in the application
-
-Application services coordinate queries and catch errors from data sources. The process expresses the collaboration capabilities it needs through application-specific contracts. Adapters materialize those contracts.
-
-```ts
-import { Service } from '../../shared/application/services.js'
-
-type User = {
-    id: string
-}
-
-export interface UsersReader {
-    all(): Promise<User[]>
-}
-
-export class ListUsersService extends Service {
-    public constructor(private readonly users: UsersReader) {
-        super()
-    }
-
-    public async execute(): Promise<{ users: User[] }> {
-        try {
-            return {
-                users: await this.users.all()
-            }
-        } catch {
-            throw new Error('Could not list users.')
-        }
-    }
-}
-```
-
-`UsersReader` expresses the collaboration required by the process. `UserRepository`, located in `adapters`, already satisfies that collaboration through the inherited `all()` method.
-
-## Context ports
-
-Ports describe communication between the context and other systems. Each port defines the shape of an interaction at the boundary: input data, output data, and the available operation.
-
-The context generates `example-ports.ts` as a root-level starting point. As the context grows, you can add `index.ts` as the main port file or split ports across multiple `.ts` files. Adapters import the ports that define the communication they materialize.
-
-### Main port
-
-The generated `example-ports.ts` file is only a placeholder:
-
-```ts
-export function example(): void {
-    // ...
-}
-```
-
-You can replace it with your own root-level contract. A minimal option for creating a user is:
-
-```ts
-export type CreateUserRequest = {
-    user: {
-        id: string
-        name: string
-        email: string
-    }
-}
-
-export type CreateUserResponse = {
-    user: {
-        id: string
-        name: string
-        email: string
-        active: boolean | null
-    }
-}
-
-export interface CreateUserPort {
-    create(
-        request: CreateUserRequest
-    ): Promise<CreateUserResponse>
-}
-```
-
-`CreateUserRequest` represents the information received from another system. `CreateUserResponse` represents the returned response. `CreateUserPort` defines the operation available at the context boundary.
-
-### Adapt the port to the application process
-
-In this example, the adapter imports the port and the service. Its job here is to translate the root-level contract into the application input object and return the service result.
-
-```ts
-import type {
-    CreateUserPort,
-    CreateUserRequest,
-    CreateUserResponse
-} from '../example-ports.js'
-
-type CreateUserService = {
-    execute(data: {
-        id: string
-        name: string
-        email: string
-    }): Promise<CreateUserResponse>
-}
-
-export class CreateUserAdapter implements CreateUserPort {
-    public constructor(
-        private readonly service: CreateUserService
-    ) {}
-
-    public async create(
-        request: CreateUserRequest
-    ): Promise<CreateUserResponse> {
-        return this.service.execute({
-            id: request.user.id,
-            name: request.user.name,
-            email: request.user.email
-        })
-    }
-}
-```
-
-In this example, the port expresses the communication, the adapter implements it, the service executes the process, and the domain provides the capabilities used by that process.
-
-### Additional ports
-
-A context can organize its communications across several files at the root. Each file declares the ports for a group of interactions.
-
-```ts
-export type ListUsersRequest = {
-    active: boolean | null
-}
-
-export type ListUsersResponse = {
-    users: Array<{
-        id: string
-        name: string
-        email: string
-        active: boolean | null
-    }>
-}
-
-export interface ListUsersPort {
-    list(request: ListUsersRequest): Promise<ListUsersResponse>
-}
-```
-
-An adapter can import the contract from the file where it is declared:
-
-```ts
-import type {
-    ListUsersPort,
-    ListUsersResponse
-} from '../example-ports.js'
-```
-
-> **Tip:** group ports that form a coherent communication in the same file. Use additional files when the context grows and groups of interactions with their own responsibilities emerge.
-
-## Generated file reference
-
-| File | Purpose |
-| --- | --- |
-| `core/index.d.ts` | Declares `Generic<T>` for plain objects. |
-| `core/main.ts` | Starts as a placeholder for the library's main implementation and exports. |
-| `shared/domain/value-objects.ts` | Declares `ValueObject<T>` and implements `Email` and `NullableBoolean`. |
-| `shared/domain/entities.ts` | Declares the `Entity` base class. |
-| `shared/domain/aggregates.ts` | Declares the `Aggregate` base class. |
-| `shared/domain/errors.ts` | Implements `ValueError`. |
-| `shared/application/validations.ts` | Declares `Validatable`. |
-| `shared/application/services.ts` | Declares `Service` as the base class for use cases. |
-| `shared/application/http.ts` | Declares HTTP request, response, body, handler, and middleware contracts. |
-| `shared/application/loggers.ts` | Declares log levels and the `Logger` contract. |
-| `shared/application/events.ts` | Declares `Event`, `EventHandler`, and `EventDispatcher`. |
-| `shared/application/data/drivers.ts` | Declares the `DriverAdapter` contract used to connect to a data source. |
-| `shared/application/data/managers.ts` | Declares source operations together with `DataManager` and `DatasetManager`. |
-| `shared/application/data/repositories.ts` | Declares the `Repository` base class for transforming records into domain objects. |
-| `users/example-ports.ts` | Provides a root-level starter file with a placeholder export for your context ports. |
-| `users/domain/` | Contains the context's capabilities. |
-| `users/application/` | Contains processes that apply domain capabilities to fulfill purposes. |
-| `users/adapters/` | Contains integrations that import ports and connect the context with other systems. |
+- [shared/domain/aggregates.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/domain/aggregates.md)
+- [shared/domain/entities.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/domain/entities.md)
+- [shared/domain/errors.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/domain/errors.md)
+- [shared/domain/value-objects.ts](https://github.com/virtualitems/tshex-cli/blob/main/docs/shared/domain/value-objects.md)