tshex-cli 1.0.17 → 1.0.19

package/templates/lib/shared/domain/value-objects.ts

@@ -1,15 +1,5 @@
-// Libraries
-
-// Same Layer
-
 import { ValueError } from './errors.js'
 
-// Lower Layers
-
-// Types
-
-// Constants
-
 /**
  * @see https://emailregex.com/
  */
@@ -17,40 +7,23 @@ const VALID_EMAIL_REGEX =
     /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
 
 /**
- * @description
+ * @description Represents a domain concept whose identity is determined by its value.
+ * It centralizes the rules, semantics, and behavior that belong to that value.
  */
 export abstract class ValueObject<T = unknown> {
     [property: string]: unknown
 
-    // public ATTRIBUTES
-
     public abstract readonly value: T
 
-    // protected ATTRIBUTES
-
-    // private ATTRIBUTES
-
-    // public static ATTRIBUTES
-
-    // protected static ATTRIBUTES
-
-    // private static ATTRIBUTES
-
-    // Constructor, Getters, Setters
-
-    // public METHODS
-
     public toString(): string {
         return String(this.value)
     }
 
-    public abstract equals(other: ValueObject<T> | null | undefined): boolean
-
-    // protected METHODS
-
-    // private METHODS
+    public toJSON(): T {
+        return this.value
+    }
 
-    // public static METHODS
+    public abstract equals(other: ValueObject<T> | null | undefined): boolean
 
     public static isValid(value: unknown): boolean {
         return (
@@ -59,41 +32,22 @@ export abstract class ValueObject<T = unknown> {
             Object.is(value, NaN) === false
         )
     }
-
-    // protected static METHODS
-
-    // private static METHODS
 } //:: class
 
 /**
- * @description
+ * @description Models a Boolean state that can be true, false, or null.
+ * It adds explicit behavior for the indeterminate state.
  */
 export class NullableBoolean extends ValueObject<boolean | null> {
     [property: string]: unknown
 
-    // public ATTRIBUTES
-
     public override readonly value: boolean | null
 
-    // protected ATTRIBUTES
-
-    // private ATTRIBUTES
-
-    // public static ATTRIBUTES
-
-    // protected static ATTRIBUTES
-
-    // private static ATTRIBUTES
-
-    // Constructor, Getters, Setters
-
     protected constructor(value: boolean | null) {
         super()
         this.value = value
     }
 
-    // public METHODS
-
     public override equals(other: NullableBoolean | null | undefined): boolean {
         if (other === null || other === undefined) return false
         return this.value === other.value
@@ -103,43 +57,19 @@ export class NullableBoolean extends ValueObject<boolean | null> {
         return this.value === null
     }
 
-    // protected METHODS
-
-    // private METHODS
-
-    // public static METHODS
-
     public static from(value: boolean | null): NullableBoolean {
         return new this(value)
     }
-
-    // protected static METHODS
-
-    // private static METHODS
 } //:: class
 
 /**
- * @description
+ * @description Represents an email address as a value object with validation and email-specific operations.
  */
 export class Email extends ValueObject<string> {
     [property: string]: unknown
 
-    // public ATTRIBUTES
-
     public override readonly value: string
 
-    // protected ATTRIBUTES
-
-    // private ATTRIBUTES
-
-    // public static ATTRIBUTES
-
-    // protected static ATTRIBUTES
-
-    // private static ATTRIBUTES
-
-    // Constructor, Getters, Setters
-
     protected constructor(value: string) {
         super()
         this.value = value
@@ -157,8 +87,6 @@ export class Email extends ValueObject<string> {
         return this.domain?.split('.').pop()
     }
 
-    // public METHODS
-
     public override equals(other: Email | null | undefined): boolean {
         if (other === null || other === undefined) {
             return false
@@ -167,12 +95,6 @@ export class Email extends ValueObject<string> {
         return this.value === other.value
     }
 
-    // protected METHODS
-
-    // private METHODS
-
-    // public static METHODS
-
     public static override isValid(value: unknown): boolean {
         if (super.isValid(value) === false) return false
 
@@ -187,8 +109,4 @@ export class Email extends ValueObject<string> {
 
         return new this(value)
     }
-
-    // protected static METHODS
-
-    // private static METHODS
 } //:: class

package/readme.md

@@ -1,217 +0,0 @@
-# Hexagonal Architecture CLI
-
-This CLI will help you to generate a hexagonal architecture structure.
-
-# Why?
-
-Hexagonal architecture is a software design pattern that separates the internal domain of the application from the external dependencies. This separation is achieved by dividing the application into layers. Each layer has a specific responsibility and interacts with the other layers in a specific way.
-
-The goal is to separate the domain code from installed dependencies. A Hexagonal Architecture _framework_ would work against that goal, since it couples the domain code to the framework itself. That is why this CLI exists: it scaffolds the structure for you, using your own codebase instead of a framework.
-
-# Note
-
-This tool and its templates are in constant development, so be aware that some changes may occur and be careful when updating the tool.
-
-If you have any suggestions or improvements, please let me know.
-
-https://github.com/virtualitems/tshex-cli/issues
-
-# Getting started
-
-`tshex` scaffolds folders and files for a hexagonal architecture project. It does not write business logic for you; it only generates the structure, so you can fill it in with your own code.
-
-There are four things you can generate:
-
-- A **library** (`--lib`): the shared foundation of a project. It contains the domain and application contracts (entities, value objects, services, etc.) that the rest of the code depends on.
-- A **context** (`--ctx`): a specific business area (e.g. `users`, `billing`, `orders`). It contains the `domain/`, `application/`, and `adapters/` folders where you implement that area's logic.
-- A **React context** (`--react-context`): a React-ready context scaffold.
-
-A typical project has one library and one or more contexts inside it.
-
-## Install
-
-Install the CLI globally:
-
-```bash
-npm install -g tshex-cli
-```
-
-Check the installation:
-
-```bash
-tshex --version
-```
-
-Show the command options:
-
-```bash
-tshex --help
-```
-
-## Usage
-
-```bash
-tshex [--lib <name>] [--ctx <name>] [--react-context <name>] [--dir <path>]
-```
-
-| Option         | Purpose                                                            |
-| -------------- | ------------------------------------------------------------------- |
-| `--lib <name>` | Generate a library called `<name>`, based on `templates/lib`.       |
-| `--ctx <name>` | Generate a context called `<name>`, based on `templates/ctx`.       |
-| `--react-context <name>` | Generate a React context called `<name>`, based on `templates/react-context`. |
-| `--dir <path>` | Parent directory where the library/context will be created. Defaults to the current directory. |
-| `--help`       | Show the command options.                                           |
-| `--version`    | Show the installed version.                                         |
-
-`--lib`, `--ctx`, and `--react-context` can be used together in a single command. Running `tshex` without any options just prints the help text — it does not generate anything.
-
-## Create a library
-
-Use this when you are starting a new project and need the shared contracts that the rest of your code will build on:
-
-```bash
-tshex --lib core
-```
-
-This generates a `core/` folder in the current directory:
-
-```text
-core/
-├── index.d.ts
-├── main.ts
-└── shared/
-    ├── application/
-    │   ├── databases.ts
-    │   ├── events.ts
-    │   ├── http.ts
-    │   ├── loggers.ts
-    │   └── services.ts
-    └── domain/
-        ├── aggregates.ts
-        ├── entities.ts
-        ├── errors.ts
-        └── value-objects.ts
-```
-
-What each file is for:
-
-| File               | Purpose                                       |
-| ------------------ | --------------------------------------------- |
-| `index.d.ts`       | Declare library types.                        |
-| `main.ts`          | Export the library API.                       |
-| `entities.ts`      | Define entity contracts.                      |
-| `value-objects.ts` | Define value objects and validation.          |
-| `aggregates.ts`    | Define aggregate contracts.                   |
-| `errors.ts`        | Define domain errors.                         |
-| `services.ts`      | Define application service contracts.         |
-| `databases.ts`     | Define data manager and repository contracts. |
-| `events.ts`        | Define event contracts.                       |
-| `http.ts`          | Define HTTP response contracts.               |
-| `loggers.ts`       | Define logger contracts.                      |
-
-`main.ts` is generated with a placeholder `throw new Error('Not implemented yet')`, so the library fails loudly if you try to use it before filling it in. To start using it, open `main.ts`, remove that line, and export your own code, built on top of the shared contracts. For example:
-
-```ts
-export { Entity } from './shared/domain/entities.js'
-export { ValueObject, Email } from './shared/domain/value-objects.js'
-
-class User extends Entity {
-    constructor(public readonly email: Email) {
-        super()
-    }
-}
-```
-
-## Create a context
-
-Use this to scaffold a specific business area, such as `users`, inside an existing library (or on its own):
-
-```bash
-tshex --ctx users
-```
-
-This generates a `users/` folder in the current directory:
-
-```text
-users/
-├── adapters/
-├── application/
-├── domain/
-└── index.ts
-```
-
-What each part is for:
-
-| Path           | Purpose                                                         |
-| -------------- | ---------------------------------------------------------------- |
-| `domain/`      | Entities, value objects, aggregates, and domain errors.          |
-| `application/` | Use cases, services, DTOs, and contracts.                        |
-| `adapters/`    | Database, HTTP, event, file, and service implementations.        |
-| `index.ts`     | Export or compose the context's public API.                      |
-
-## Choose the destination folder
-
-By default, `tshex` creates files in your current directory. Use `--dir` to choose a different parent directory instead.
-
-Create a library inside `./src`:
-
-```bash
-tshex --lib core --dir ./src
-```
-
-This generates the library at:
-
-```text
-./src/core
-```
-
-Create a context inside that library:
-
-```bash
-tshex --ctx users --dir ./src/core
-```
-
-This generates the context at:
-
-```text
-./src/core/users
-```
-
-You can also use an absolute path:
-
-```bash
-tshex --ctx users --dir /workspace/project/src
-```
-
-## Create a library and a context together
-
-You can generate both in a single command. `tshex` creates the library first, then creates the context inside it:
-
-```bash
-tshex --dir ./src --lib core --ctx users
-```
-
-Result:
-
-```text
-src/
-└── core/
-    ├── index.d.ts
-    ├── main.ts
-    ├── shared/
-    └── users/
-        ├── adapters/
-        ├── application/
-        ├── domain/
-        └── index.ts
-```
-
-    ## Create a React context
-
-    Use this when you want only the React context scaffold:
-
-    ```bash
-    tshex --react-context users
-    ```
-
-    This generates a `users/` folder in the current directory.

package/templates/lib/shared/application/databases.ts

@@ -1,102 +0,0 @@
-type Generic<T = unknown> = Record<string, T>
-
-/**
- * @description
- */
-export interface Filterable<S = Generic> {
-    filter(selector: S): Promise<Array<S>>
-}
-
-/**
- * @description
- */
-export interface Sortable<S = Generic> {
-    sort(selector: S): Promise<Array<S>>
-}
-
-/**
- * @description
- */
-export interface Creatable<D = Generic> {
-    create(data: D): Promise<unknown>
-}
-
-/**
- * @description
- */
-export interface Updatable<S = Generic, D = Generic> {
-    update(selector: S, data: D): Promise<unknown>
-}
-
-/**
- * @description
- */
-export interface Deletable<S = Generic> {
-    delete(selector: S): Promise<unknown>
-}
-
-/**
- * @description
- */
-export interface Aggregatable<S = Generic> {
-    aggregate(selector: S): Promise<S>
-}
-
-/**
- * @description
- */
-export interface Relatable {
-    selectRelated(...args: unknown[]): unknown
-
-    prefetchRelated(...args: unknown[]): unknown
-}
-
-/**
- * @description
- */
-export abstract class DataManager<T = Generic> {
-    [property: string]: unknown
-
-    public abstract all(): Promise<Array<T>>
-
-    public abstract none(): Array<T>
-} //:: class
-
-/**
- * @description
- */
-export abstract class DatasetManager<T = Generic> extends DataManager<T> {
-    [property: string]: unknown
-
-    public abstract union(other: Array<T>): Promise<Array<T>>
-
-    public abstract intersection(other: Array<T>): Promise<Array<T>>
-
-    public abstract difference(other: Array<T>): Promise<Array<T>>
-
-    public abstract symmetric_difference(other: Array<T>): Promise<Array<T>>
-
-    public abstract complement(other: Array<T>): Promise<Array<T>>
-} //:: class
-
-/**
- * @description
- */
-export abstract class DriverManager<M extends DataManager = DataManager> {
-    [property: string]: unknown
-
-    public abstract connect(...args: unknown[]): Promise<M>
-
-    public abstract disconnect(): Promise<unknown>
-} //:: class
-
-/**
- * @description Represents a data source.
- */
-export abstract class Repository<M extends DriverManager = DriverManager> {
-    [property: string]: unknown
-
-    public constructor(public readonly manager: M) {}
-
-    protected abstract transform<T = Generic>(data: Generic): T
-} //:: class