tshex-cli 1.0.2

package/templates/lib/shared/application/data/Repository.ts

@@ -0,0 +1,55 @@
+// Libraries
+
+// Same Layer
+
+import type DataManager from './DataManager.js';
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+* @description Represents a data source.
+*/
+export default abstract class Repository<M extends DataManager>
+{
+
+    [property: string]: unknown;
+
+    // Public Attributes
+
+    public manager: M;
+
+    // Protected Attributes
+
+    // Private Attributes
+
+    // Public Static Attributes
+
+    // Protected Static Attributes
+
+    // Private Static Attributes
+
+    // Constructor, Getters, Setters
+
+    public constructor(manager: M)
+    {
+        this.manager = manager;
+    }
+
+    // Public Methods
+
+    // Protected Methods
+
+    // Private Methods
+
+    // Public Static Methods
+
+    // Protected Static Methods
+
+    // Private Static Methods
+
+} //:: class

package/templates/lib/shared/application/events/Event.ts

@@ -0,0 +1,56 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+ * @description 
+ */
+export default abstract class Event
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    public readonly timestamp: number;
+
+    public readonly details?: Record<string, unknown>;
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    public constructor(timestamp: number, details?: Record<string, unknown>)
+    {
+        this.timestamp = timestamp;
+        this.details = details;
+    }
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/application/events/EventDispatcher.ts

@@ -0,0 +1,55 @@
+// Libraries
+
+// Same Layer
+
+import type Event from './Event.js';
+import type EventHandler from './EventHandler.js';
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+ * @description 
+ */
+export default abstract class EventDispatcher
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    // public METHODS
+
+    public abstract subscribe(key: unknown, handler: EventHandler): void;
+
+    public abstract unsubscribe(key: unknown, handler: EventHandler): void;
+
+    public abstract dispatch(event: Event): void;
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/application/events/EventHandler.ts

@@ -0,0 +1,50 @@
+// Libraries
+
+// Same Layer
+
+import type Event from './Event.js';
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+ * @description 
+ */
+export default abstract class EventHandler
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    // public METHODS
+
+    public abstract handle(event: Event): Promise<void>;
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/domain/Entity.ts

@@ -0,0 +1,50 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+ * @description An Entity is a class that represents a domain concept or element.
+ */
+export default abstract class Entity
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    // public METHODS
+
+    public abstract equals(other: Entity): boolean;
+
+    public abstract flatten(): Record<string, unknown>;
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/domain/Service.ts

@@ -0,0 +1,48 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+ * @description A service is a class that contains business logic that doesn't belong to any entity.
+ * It is used to perform operations that don't fit into an entity or involve multiple entities.
+ * Normally, method arguments are entities.
+ */
+export default abstract class Service
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

package/templates/lib/shared/domain/errors/ValueError.ts

@@ -0,0 +1,69 @@
+// Libraries
+
+// Same Layer
+
+// Lower Layers
+
+// Types
+
+// Constants
+
+
+/**
+* @description 
+*/
+export default class ValueError extends Error
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    public constructor(value: unknown, expected: string)
+    {
+        let valueRepr: string;
+
+        if (value === undefined) {
+            valueRepr = 'undefined';
+        }
+
+        else if (value === null) {
+            valueRepr = 'null';
+        }
+
+        else if (Object.is(value, NaN)) {
+            valueRepr = 'NaN';
+        }
+
+        else {
+            valueRepr = `${value.constructor.name}(${value.toString()})`;
+        }
+
+        super(`Invalid value ${valueRepr} for ${expected}.`);
+    }
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

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

@@ -0,0 +1,87 @@
+// Libraries
+
+// Same Layer
+
+import ValueObject from './ValueObject.js';
+
+import ValueError from '../errors/ValueError.js';
+
+// Lower Layers
+
+// Types
+
+type T = boolean;
+
+// Constants
+
+
+/**
+ * @description 
+ */
+export default class BooleanValueObject extends ValueObject
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    public override readonly value: T;
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    protected constructor(value: T)
+    {
+        super();
+        this.value = value;
+    }
+
+    // public METHODS
+
+    public override equals(other: BooleanValueObject | null | undefined): boolean
+    {
+        if (other === null || other === undefined) {
+            return false;
+        }
+
+        return this.value === other.value;
+    }
+
+    public toggle(): BooleanValueObject
+    {
+        return new BooleanValueObject(!this.value);
+    }
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    public static override isValid(value: unknown): boolean
+    {
+        return ('boolean' === typeof value);
+    }
+
+    public static from(value: T): BooleanValueObject
+    {
+        if (!this.isValid(value)) {
+            throw new ValueError(value, this.name);
+        }
+        return new this(value);
+    }
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

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

@@ -0,0 +1,100 @@
+// Libraries
+
+// Same Layer
+
+import ValueObject from './ValueObject.js';
+
+import ValueError from '../errors/ValueError.js';
+
+// Lower Layers
+
+// Types
+
+type T = Date;
+
+// Constants
+
+
+/**
+* @description 
+*/
+export default class DateValueObject extends ValueObject
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    public override readonly value: T;
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    protected constructor(value: T)
+    {
+        super();
+        this.value = value;
+    }
+
+    // public METHODS
+
+    public override equals(other: DateValueObject | null | undefined): boolean
+    {
+        if (other === null || other === undefined) {
+            return false;
+        }
+
+        return this.value.getTime() === other.value.getTime();
+    }
+
+    public isAfter(other: DateValueObject): boolean
+    {
+        return this.value > other.value;
+    }
+
+    public isBefore(other: DateValueObject): boolean
+    {
+        return this.value < other.value;
+    }
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    public static override isValid(value: unknown): boolean
+    {
+        if (value === null || value === undefined) {
+            return false;
+        }
+
+        if (!(value instanceof Date)) {
+            return false;
+        }
+
+        return !isNaN(value.getTime());
+    }
+
+    public static from(value: T): DateValueObject
+    {
+        if (!this.isValid(value)) {
+            throw new ValueError(value, this.name);
+        }
+        return new this(value);
+    }
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class

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

@@ -0,0 +1,89 @@
+// Libraries
+
+// Same Layer
+
+import StringValueObject from './StringValueObject.js';
+
+import ValueError from '../errors/ValueError.js';
+
+// Lower Layers
+
+// Types
+
+type T = string;
+
+// Constants
+
+
+/**
+* @description 
+*/
+export default class EmailValueObject extends StringValueObject
+{
+
+    [property: string]: unknown;
+
+    // public ATTRIBUTES
+
+    // protected ATTRIBUTES
+
+    // private ATTRIBUTES
+
+    // public static ATTRIBUTES
+
+    // protected static ATTRIBUTES
+
+    // private static ATTRIBUTES
+
+    // Constructor, Getters, Setters
+
+    get username(): string | undefined
+    {
+        return this.value.split('@').shift();
+    }
+
+    get domain(): string | undefined
+    {
+        return this.value.split('@').pop();
+    }
+
+    get tld(): string | undefined
+    {
+        return this.domain?.split('.').pop();
+    }
+
+    // public METHODS
+
+    // protected METHODS
+
+    // private METHODS
+
+    // public static METHODS
+
+    /**
+    * @see https://emailregex.com/
+    */
+    public static override isValid(value: unknown): boolean
+    {
+        const 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,}))$/;
+
+        if (!super.isValid(value)) {
+            return false;
+        }
+
+        return regex.test(value as string);
+    }
+
+    public static override from(value: T): EmailValueObject
+    {
+        if (!this.isValid(value)) {
+            throw new ValueError(value, this.name);
+        }
+        return new this(value);
+    }
+
+    // protected static METHODS
+
+    // private static METHODS
+
+} //:: class