@rineex/ddd 0.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.mts

@@ -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 };