@rineex/ddd 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,351 @@
+/**
+ * Port interface for application services that execute commands or queries.
+ *
+ * @template I - The input type for the service execution
+ * @template O - The output type returned by the service execution
+ *
+ * @example
+ * ```typescript
+ * interface CreateUserInput {
+ *   name: string;
+ *   email: string;
+ * }
+ *
+ * interface CreateUserOutput {
+ *   id: string;
+ *   name: string;
+ * }
+ *
+ * class CreateUserService implements ApplicationServicePort<CreateUserInput, CreateUserOutput> {
+ *   async execute(args: CreateUserInput): Promise<CreateUserOutput> {
+ *     // implementation
+ *   }
+ * }
+ * ```
+ */
+interface ApplicationServicePort<I, O> {
+    execute: (args: I) => Promise<O>;
+}
+
+interface DomainErrorMetadata {
+    cause?: {
+        name: string;
+        message: string;
+        stack?: string;
+    };
+    [key: string]: unknown;
+}
+/**
+ * Base class for all Domain Errors in the application.
+ *
+ * This class ensures:
+ * 1. Serializable and structured for logs or API responses.
+ * 2. Identifiable via stable error codes (not just class names).
+ * 3. Contextual with optional structured metadata.
+ * 4. Supports error chaining (cause) and stack trace preservation.
+ *
+ * @example
+ * export class InsufficientFundsError extends DomainError {
+ *   constructor(accountId: string, currentBalance: number) {
+ *     super(
+ *       `Account ${accountId} has insufficient funds.`,
+ *       'INSUFFICIENT_FUNDS',
+ *       { accountId, currentBalance }
+ *     );
+ *   }
+ * }
+ */
+declare abstract class DomainError extends Error {
+    /** Stable, machine-readable error code */
+    readonly code: string;
+    /** Structured, immutable domain metadata */
+    readonly metadata: Readonly<DomainErrorMetadata>;
+    /**
+     * @param message - Human-readable error message
+     * @param code - Stable error code
+     * @param metadata - Domain-specific structured data; optional `cause` can be included
+     */
+    protected constructor(message: string, code: string, metadata?: DomainErrorMetadata);
+}
+
+declare abstract class ValueObject<T> {
+    get value(): T;
+    protected readonly props: Readonly<T>;
+    protected constructor(props: T);
+    /**
+     * Type guard to check if an unknown object is an instance of ValueObject.
+     * This is useful for runtime type checking.
+     *
+     * @param vo The object to check.
+     * @returns True if the object is a ValueObject instance, false otherwise.
+     */
+    static is(vo: unknown): vo is ValueObject<unknown>;
+    /**
+     * Deep equality comparison of ValueObjects
+     */
+    equals(other?: ValueObject<T>): boolean;
+    /**
+     * Validates the value object props
+     * @throws InvalidValueObjectError if validation fails
+     */
+    protected abstract validate(props: T): void;
+}
+
+/**
+ * Custom error class for entity validation failures.
+ */
+declare class EntityValidationError extends DomainError {
+    constructor(message: string, cause?: Error);
+}
+
+declare class InvalidValueObjectError extends DomainError {
+    constructor(message: string);
+}
+
+/**
+ * AggregateId is a ValueObject that represents a unique identifier for an aggregate.
+ */
+declare class AggregateId extends ValueObject<string> {
+    /**
+     * The schema for the AggregateId
+     */
+    private static readonly schema;
+    /**
+     * Get the UUID of the AggregateId
+     * @returns The UUID of the AggregateId
+     */
+    get uuid(): string;
+    /**
+     * Create a new AggregateId
+     * @param value The value to create the AggregateId from
+     * @returns The new AggregateId
+     */
+    static create(value: string): AggregateId;
+    /**
+     * Create a new AggregateId with a random UUID v4
+     */
+    static generate(): AggregateId;
+    /**
+     * Check if the AggregateId is empty
+     * @returns True if the AggregateId is empty, false otherwise
+     */
+    isEmpty(): boolean;
+    /**
+     * Convert the AggregateId to a string
+     * @returns The string representation of the AggregateId
+     */
+    toString(): string;
+    /**
+     * Validate the AggregateId
+     * @param value The value to validate
+     * @throws InvalidValueObjectException if the value is invalid
+     */
+    protected validate(value: string): void;
+}
+
+/**
+ * HTTP status code catalog.
+ *
+ * This object provides a typed, immutable map of standard HTTP status names
+ * to their numeric codes. Designed for server-side frameworks such as Fastify.
+ *
+ * - All identifiers use clear, canonical semantic names.
+ * - Values are numeric status codes.
+ * - Frozen to prevent runtime mutation.
+ * - Exporting `HttpStatus` ensures type-safe usage across the codebase.
+ */
+declare const HttpStatus: Readonly<{
+    readonly REQUEST_HEADER_FIELDS_TOO_LARGE: 431;
+    readonly NETWORK_AUTHENTICATION_REQUIRED: 511;
+    readonly NON_AUTHORITATIVE_INFORMATION: 203;
+    readonly PROXY_AUTHENTICATION_REQUIRED: 407;
+    readonly UNAVAILABLE_FOR_LEGAL_REASONS: 451;
+    readonly HTTP_VERSION_NOT_SUPPORTED: 505;
+    readonly BANDWIDTH_LIMIT_EXCEEDED: 509;
+    readonly VARIANT_ALSO_NEGOTIATES: 506;
+    readonly UNSUPPORTED_MEDIA_TYPE: 415;
+    readonly RANGE_NOT_SATISFIABLE: 416;
+    readonly PRECONDITION_REQUIRED: 428;
+    readonly INTERNAL_SERVER_ERROR: 500;
+    readonly UNPROCESSABLE_ENTITY: 422;
+    readonly INSUFFICIENT_STORAGE: 507;
+    readonly SWITCHING_PROTOCOLS: 101;
+    readonly PRECONDITION_FAILED: 412;
+    readonly MISDIRECTED_REQUEST: 421;
+    readonly SERVICE_UNAVAILABLE: 503;
+    readonly TEMPORARY_REDIRECT: 307;
+    readonly PERMANENT_REDIRECT: 308;
+    readonly METHOD_NOT_ALLOWED: 405;
+    readonly EXPECTATION_FAILED: 417;
+    readonly MOVED_PERMANENTLY: 301;
+    readonly PAYLOAD_TOO_LARGE: 413;
+    readonly FAILED_DEPENDENCY: 424;
+    readonly TOO_MANY_REQUESTS: 429;
+    readonly ALREADY_REPORTED: 208;
+    readonly MULTIPLE_CHOICES: 300;
+    readonly PAYMENT_REQUIRED: 402;
+    readonly UPGRADE_REQUIRED: 426;
+    readonly PARTIAL_CONTENT: 206;
+    readonly REQUEST_TIMEOUT: 408;
+    readonly LENGTH_REQUIRED: 411;
+    readonly NOT_IMPLEMENTED: 501;
+    readonly GATEWAY_TIMEOUT: 504;
+    readonly NOT_ACCEPTABLE: 406;
+    readonly RESET_CONTENT: 205;
+    readonly LOOP_DETECTED: 508;
+    readonly MULTI_STATUS: 207;
+    readonly NOT_MODIFIED: 304;
+    readonly UNAUTHORIZED: 401;
+    readonly URI_TOO_LONG: 414;
+    readonly NOT_EXTENDED: 510;
+    readonly EARLY_HINTS: 103;
+    readonly BAD_REQUEST: 400;
+    readonly IM_A_TEAPOT: 418;
+    readonly BAD_GATEWAY: 502;
+    readonly PROCESSING: 102;
+    readonly NO_CONTENT: 204;
+    readonly SEE_OTHER: 303;
+    readonly USE_PROXY: 305;
+    readonly FORBIDDEN: 403;
+    readonly NOT_FOUND: 404;
+    readonly TOO_EARLY: 425;
+    readonly CONTINUE: 100;
+    readonly ACCEPTED: 202;
+    readonly CONFLICT: 409;
+    readonly CREATED: 201;
+    readonly IM_USED: 226;
+    readonly LOCKED: 423;
+    readonly FOUND: 302;
+    readonly GONE: 410;
+    readonly OK: 200;
+}>;
+type HttpStatusCode = keyof typeof HttpStatusMessage;
+/**
+ * HTTP status messages mapped by numeric code.
+ * Use for sending descriptive text in responses or logging.
+ */
+declare const HttpStatusMessage: {
+    readonly 431: "Request Header Fields Too Large";
+    readonly 511: "Network Authentication Required";
+    readonly 203: "Non-Authoritative Information";
+    readonly 407: "Proxy Authentication Required";
+    readonly 451: "Unavailable For Legal Reasons";
+    readonly 505: "HTTP Version Not Supported";
+    readonly 509: "Bandwidth Limit Exceeded";
+    readonly 506: "Variant Also Negotiates";
+    readonly 415: "Unsupported Media Type";
+    readonly 416: "Range Not Satisfiable";
+    readonly 428: "Precondition Required";
+    readonly 500: "Internal Server Error";
+    readonly 422: "Unprocessable Entity";
+    readonly 507: "Insufficient Storage";
+    readonly 101: "Switching Protocols";
+    readonly 412: "Precondition Failed";
+    readonly 421: "Misdirected Request";
+    readonly 503: "Service Unavailable";
+    readonly 307: "Temporary Redirect";
+    readonly 308: "Permanent Redirect";
+    readonly 405: "Method Not Allowed";
+    readonly 417: "Expectation Failed";
+    readonly 301: "Moved Permanently";
+    readonly 413: "Payload Too Large";
+    readonly 424: "Failed Dependency";
+    readonly 429: "Too Many Requests";
+    readonly 208: "Already Reported";
+    readonly 300: "Multiple Choices";
+    readonly 402: "Payment Required";
+    readonly 426: "Upgrade Required";
+    readonly 206: "Partial Content";
+    readonly 408: "Request Timeout";
+    readonly 411: "Length Required";
+    readonly 501: "Not Implemented";
+    readonly 504: "Gateway Timeout";
+    readonly 406: "Not Acceptable";
+    readonly 205: "Reset Content";
+    readonly 508: "Loop Detected";
+    readonly 207: "Multi-Status";
+    readonly 304: "Not Modified";
+    readonly 401: "Unauthorized";
+    readonly 414: "URI Too Long";
+    readonly 418: "I'm a Teapot";
+    readonly 510: "Not Extended";
+    readonly 103: "Early Hints";
+    readonly 400: "Bad Request";
+    readonly 502: "Bad Gateway";
+    readonly 102: "Processing";
+    readonly 204: "No Content";
+    readonly 303: "See Other";
+    readonly 305: "Use Proxy";
+    readonly 403: "Forbidden";
+    readonly 404: "Not Found";
+    readonly 425: "Too Early";
+    readonly 100: "Continue";
+    readonly 202: "Accepted";
+    readonly 226: "I'm Used";
+    readonly 409: "Conflict";
+    readonly 201: "Created";
+    readonly 423: "Locked";
+    readonly 302: "Found";
+    readonly 410: "Gone";
+    readonly 200: "OK";
+};
+type HttpStatusMessage = (typeof HttpStatusMessage)[keyof typeof HttpStatusMessage];
+
+/**
+ * Utility to deeply freeze objects to ensure immutability
+ */
+declare function deepFreeze<T>(obj: T, seen?: WeakSet<object>): Readonly<T>;
+
+interface ErrorParams {
+    message: string;
+    code: HttpStatusMessage;
+    status?: HttpStatusCode;
+    metadata?: Record<string, unknown> | undefined;
+    isOperational?: boolean;
+    cause?: Error | undefined;
+}
+/**
+ * Abstract base class for application-level errors with structured error handling.
+ *
+ * Extends the native Error class to provide machine-readable error codes, HTTP status codes,
+ * operational error classification, and optional metadata for better error tracking and client communication.
+ *
+ * @abstract
+ * @extends {Error}
+ *
+ * @example
+ * ```typescript
+ * class UserNotFoundError extends ApplicationError {
+ *   constructor(userId: string) {
+ *     super({
+ *       code: HttpStatusMessage['404'],
+ *       status: 404,
+ *       isOperational: true,
+ *       message: `User with id ${userId} not found`,
+ *       metadata: { userId }
+ *     });
+ *   }
+ * }
+ * ```
+ */
+declare abstract class ApplicationError extends Error {
+    /** Optional cause (linked error) */
+    readonly cause?: Error | undefined;
+    /** Machine-readable error code (e.g. `OTP_LOCKED`, `USER_NOT_FOUND`) */
+    readonly code: HttpStatusMessage;
+    /** Operational vs programmer error flag */
+    readonly isOperational: boolean;
+    /** Optional structured metadata for debugging or clients */
+    readonly metadata?: Record<string, unknown> | undefined;
+    /** HTTP status code intended for response layer */
+    readonly status: HttpStatusCode;
+    constructor({ code, isOperational, status, metadata, message, cause, }: ErrorParams);
+}
+
+type UnwrapValueObject<T> = T extends ValueObject<infer V> ? UnwrapValueObject<V> : T extends (infer U)[] ? UnwrapValueObject<U>[] : T extends Map<infer K, infer V> ? Map<K, UnwrapValueObject<V>> : T extends Set<infer V> ? Set<UnwrapValueObject<V>> : T extends Date ? string : T extends object ? {
+    [K in keyof T]: UnwrapValueObject<T[K]>;
+} : T;
+declare function unwrapValueObject<T>(input: T, seen?: WeakSet<object>): UnwrapValueObject<T>;
+declare function ensureObject<T>(input: UnwrapValueObject<T>): object;
+
+export { AggregateId, ApplicationError, type ApplicationServicePort, DomainError, type DomainErrorMetadata, EntityValidationError, HttpStatus, type HttpStatusCode, HttpStatusMessage, InvalidValueObjectError, type UnwrapValueObject, ValueObject, deepFreeze, ensureObject, unwrapValueObject };