@woltz/rich-domain 1.9.2 → 1.9.3

package/src/types/change-tracker.ts

@@ -1,268 +1,268 @@
-import { Entity, ValueObject } from "../core/index";
-
-/**
- * Base operation with common information.
- */
-export interface BaseOperation {
-  /** Entity name in the domain (e.g., 'User', 'Post', 'Comment') */
-  entity: string;
-  /** Depth in the aggregate tree (0 = root, 1 = direct children, etc.) */
-  depth: number;
-  /** Name of the relation field in the parent entity (e.g., 'tags', 'comments') */
-  relationField?: string;
-}
-
-/**
- * Create operation.
- */
-export interface CreateOperation<T = any> extends BaseOperation {
-  type: "create";
-  /** Entity data to be created */
-  data: T;
-  /** Parent ID (for FK) */
-  parentId?: string;
-  /** Parent entity name */
-  parentEntity?: string;
-}
-
-/**
- * Update operation.
- */
-export interface UpdateOperation<T = any> extends BaseOperation {
-  type: "update";
-  /** Entity ID */
-  id: string;
-  /** Current entity instance */
-  data: T;
-  /** Only fields that have changed */
-  changedFields: Record<string, any>;
-}
-
-/**
- * Delete operation.
- */
-export interface DeleteOperation<T = any> extends BaseOperation {
-  type: "delete";
-  /** Entity ID to be deleted */
-  id: string;
-  /** Entity data (for reference) */
-  data: T;
-  /** Parent entity name */
-  parentEntity?: string;
-  /** Parent ID */
-  parentId?: string;
-}
-
-/**
- * Union of all possible operations.
- */
-export type Operation<T = any> =
-  | CreateOperation<T>
-  | UpdateOperation<T>
-  | DeleteOperation<T>;
-
-/**
- * Item for batch creation.
- */
-export interface BatchCreateItem<T = any> {
-  /** Entity data */
-  data: T;
-  /** Parent ID (for FK) */
-  parentId?: string;
-  /** Parent entity name */
-  parentEntity?: string;
-  /** Relation field name */
-  relationField?: string;
-}
-
-/**
- * Item for batch update.
- */
-export interface BatchUpdateItem {
-  /** Entity ID */
-  id: string;
-  /** Fields that have changed */
-  changedFields: Record<string, any>;
-}
-
-/**
- * Item for batch delete.
- */
-export interface BatchDeleteItem {
-  /** Entity ID */
-  id: string;
-  /** Relation field name */
-  relationField?: string;
-}
-
-export interface BatchDeleteOperation {
-  entity: string;
-  depth: number;
-  ids: string[];
-  parentId?: string;
-  /** Relation field name (for determining owned vs reference) */
-  relationField?: string;
-  /** Parent entity name */
-  parentEntity?: string;
-  /** Individual items with their relation fields (when mixed) */
-  items?: BatchDeleteItem[];
-}
-
-export interface BatchCreateOperation {
-  entity: string;
-  depth: number;
-  items: BatchCreateItem[];
-  /** Relation field name (for determining owned vs reference) */
-  relationField?: string;
-  /** Parent entity name */
-  parentEntity?: string;
-}
-
-export interface BatchUpdateOperation {
-  entity: string;
-  items: BatchUpdateItem[];
-}
-
-/**
- * Grouped and ordered operations for batch execution.
- */
-export interface BatchOperations {
-  /**
-   * Deletes grouped by entity, ordered by depth descending (leaf → root).
-   */
-  deletes: Array<BatchDeleteOperation>;
-
-  /**
-   * Creates grouped by entity, ordered by depth ascending (root → leaf).
-   */
-  creates: Array<BatchCreateOperation>;
-
-  /**
-   * Updates grouped by entity.
-   */
-  updates: Array<BatchUpdateOperation>;
-}
-
-/**
- * Changes detected in a collection (1:N).
- */
-export interface CollectionChanges<T = any> {
-  /** Created items */
-  created: T[];
-  /** Updated items with their changes */
-  updated: Array<{
-    entity: T;
-    changes: Record<string, { from: any; to: any }>;
-  }>;
-  /** Deleted items */
-  deleted: T[];
-}
-
-/**
- * Possible states for a 1:1 relationship.
- */
-export type EntityChangeState =
-  | "created" // null → Entity
-  | "updated" // Entity(id:1) → Entity(id:1) with changes
-  | "deleted" // Entity → null
-  | "replaced" // Entity(id:1) → Entity(id:2)
-  | "unchanged"; // No changes
-
-/**
- * Change in a 1:1 entity relationship.
- */
-export interface EntityChange<T = any> {
-  /** State of the change */
-  state: EntityChangeState;
-  /** Current entity (null if deleted) */
-  current: T | null;
-  /** Previous entity (null if created) */
-  previous: T | null;
-  /** Field changes (if state === 'updated') */
-  changes?: Record<string, { from: any; to: any }>;
-}
-
-/**
- * Change in a primitive field.
- */
-export interface FieldChange<T = any> {
-  from: T;
-  to: T;
-}
-
-/**
- * Extracts the props type from an Entity or ValueObject.
- */
-export type ExtractProps<T> =
-  T extends Entity<infer P> ? P : T extends ValueObject<infer P> ? P : never;
-
-/**
- * Keys of primitive properties (not Entity, ValueObject or Array).
- */
-export type PrimitiveKeys<T> = {
-  [K in keyof T]: T[K] extends
-    | Entity<any>
-    | ValueObject<any>
-    | Array<any>
-    | undefined
-    ? never
-    : K;
-}[keyof T];
-
-/**
- * Keys of collections (arrays).
- */
-export type CollectionKeys<T> = {
-  [K in keyof T]: T[K] extends Array<any> ? K : never;
-}[keyof T];
-
-/**
- * Keys of single entities (1:1).
- */
-export type SingleEntityKeys<T> = {
-  [K in keyof T]: T[K] extends Entity<any> | ValueObject<any> | null | undefined
-    ? T[K] extends Array<any>
-      ? never
-      : K
-    : never;
-}[keyof T];
-
-/**
- * Change history entry.
- */
-export interface HistoryEntry {
-  path: string;
-  previousValue: any;
-  currentValue: any;
-  timestamp: number;
-}
-
-/**
- * Metadata from a tracked entity/VO.
- */
-export interface TrackedEntityMetadata {
-  /** Entity name */
-  entityName: string;
-  /** Depth in the tree */
-  depth: number;
-  /** Parent ID */
-  parentId?: string;
-  /** Parent entity name */
-  parentEntity?: string;
-  /** Path in the object (e.g., 'posts[0].comments[1]') */
-  path: string;
-}
-
-export interface TrackedItem {
-  entity: any;
-  metadata: TrackedEntityMetadata;
-  originalState: any;
-}
-
-export interface ArrayState {
-  cloned: any[];
-  original: any[];
-  metadata: TrackedEntityMetadata;
-  /** Indicates if array contains only primitive values (string, number, boolean, etc.) */
-  isPrimitiveArray?: boolean;
-}
+import { Entity, ValueObject } from "../core/index.js";
+
+/**
+ * Base operation with common information.
+ */
+export interface BaseOperation {
+  /** Entity name in the domain (e.g., 'User', 'Post', 'Comment') */
+  entity: string;
+  /** Depth in the aggregate tree (0 = root, 1 = direct children, etc.) */
+  depth: number;
+  /** Name of the relation field in the parent entity (e.g., 'tags', 'comments') */
+  relationField?: string;
+}
+
+/**
+ * Create operation.
+ */
+export interface CreateOperation<T = any> extends BaseOperation {
+  type: "create";
+  /** Entity data to be created */
+  data: T;
+  /** Parent ID (for FK) */
+  parentId?: string;
+  /** Parent entity name */
+  parentEntity?: string;
+}
+
+/**
+ * Update operation.
+ */
+export interface UpdateOperation<T = any> extends BaseOperation {
+  type: "update";
+  /** Entity ID */
+  id: string;
+  /** Current entity instance */
+  data: T;
+  /** Only fields that have changed */
+  changedFields: Record<string, any>;
+}
+
+/**
+ * Delete operation.
+ */
+export interface DeleteOperation<T = any> extends BaseOperation {
+  type: "delete";
+  /** Entity ID to be deleted */
+  id: string;
+  /** Entity data (for reference) */
+  data: T;
+  /** Parent entity name */
+  parentEntity?: string;
+  /** Parent ID */
+  parentId?: string;
+}
+
+/**
+ * Union of all possible operations.
+ */
+export type Operation<T = any> =
+  | CreateOperation<T>
+  | UpdateOperation<T>
+  | DeleteOperation<T>;
+
+/**
+ * Item for batch creation.
+ */
+export interface BatchCreateItem<T = any> {
+  /** Entity data */
+  data: T;
+  /** Parent ID (for FK) */
+  parentId?: string;
+  /** Parent entity name */
+  parentEntity?: string;
+  /** Relation field name */
+  relationField?: string;
+}
+
+/**
+ * Item for batch update.
+ */
+export interface BatchUpdateItem {
+  /** Entity ID */
+  id: string;
+  /** Fields that have changed */
+  changedFields: Record<string, any>;
+}
+
+/**
+ * Item for batch delete.
+ */
+export interface BatchDeleteItem {
+  /** Entity ID */
+  id: string;
+  /** Relation field name */
+  relationField?: string;
+}
+
+export interface BatchDeleteOperation {
+  entity: string;
+  depth: number;
+  ids: string[];
+  parentId?: string;
+  /** Relation field name (for determining owned vs reference) */
+  relationField?: string;
+  /** Parent entity name */
+  parentEntity?: string;
+  /** Individual items with their relation fields (when mixed) */
+  items?: BatchDeleteItem[];
+}
+
+export interface BatchCreateOperation {
+  entity: string;
+  depth: number;
+  items: BatchCreateItem[];
+  /** Relation field name (for determining owned vs reference) */
+  relationField?: string;
+  /** Parent entity name */
+  parentEntity?: string;
+}
+
+export interface BatchUpdateOperation {
+  entity: string;
+  items: BatchUpdateItem[];
+}
+
+/**
+ * Grouped and ordered operations for batch execution.
+ */
+export interface BatchOperations {
+  /**
+   * Deletes grouped by entity, ordered by depth descending (leaf → root).
+   */
+  deletes: Array<BatchDeleteOperation>;
+
+  /**
+   * Creates grouped by entity, ordered by depth ascending (root → leaf).
+   */
+  creates: Array<BatchCreateOperation>;
+
+  /**
+   * Updates grouped by entity.
+   */
+  updates: Array<BatchUpdateOperation>;
+}
+
+/**
+ * Changes detected in a collection (1:N).
+ */
+export interface CollectionChanges<T = any> {
+  /** Created items */
+  created: T[];
+  /** Updated items with their changes */
+  updated: Array<{
+    entity: T;
+    changes: Record<string, { from: any; to: any }>;
+  }>;
+  /** Deleted items */
+  deleted: T[];
+}
+
+/**
+ * Possible states for a 1:1 relationship.
+ */
+export type EntityChangeState =
+  | "created" // null → Entity
+  | "updated" // Entity(id:1) → Entity(id:1) with changes
+  | "deleted" // Entity → null
+  | "replaced" // Entity(id:1) → Entity(id:2)
+  | "unchanged"; // No changes
+
+/**
+ * Change in a 1:1 entity relationship.
+ */
+export interface EntityChange<T = any> {
+  /** State of the change */
+  state: EntityChangeState;
+  /** Current entity (null if deleted) */
+  current: T | null;
+  /** Previous entity (null if created) */
+  previous: T | null;
+  /** Field changes (if state === 'updated') */
+  changes?: Record<string, { from: any; to: any }>;
+}
+
+/**
+ * Change in a primitive field.
+ */
+export interface FieldChange<T = any> {
+  from: T;
+  to: T;
+}
+
+/**
+ * Extracts the props type from an Entity or ValueObject.
+ */
+export type ExtractProps<T> =
+  T extends Entity<infer P> ? P : T extends ValueObject<infer P> ? P : never;
+
+/**
+ * Keys of primitive properties (not Entity, ValueObject or Array).
+ */
+export type PrimitiveKeys<T> = {
+  [K in keyof T]: T[K] extends
+    | Entity<any>
+    | ValueObject<any>
+    | Array<any>
+    | undefined
+    ? never
+    : K;
+}[keyof T];
+
+/**
+ * Keys of collections (arrays).
+ */
+export type CollectionKeys<T> = {
+  [K in keyof T]: T[K] extends Array<any> ? K : never;
+}[keyof T];
+
+/**
+ * Keys of single entities (1:1).
+ */
+export type SingleEntityKeys<T> = {
+  [K in keyof T]: T[K] extends Entity<any> | ValueObject<any> | null | undefined
+    ? T[K] extends Array<any>
+      ? never
+      : K
+    : never;
+}[keyof T];
+
+/**
+ * Change history entry.
+ */
+export interface HistoryEntry {
+  path: string;
+  previousValue: any;
+  currentValue: any;
+  timestamp: number;
+}
+
+/**
+ * Metadata from a tracked entity/VO.
+ */
+export interface TrackedEntityMetadata {
+  /** Entity name */
+  entityName: string;
+  /** Depth in the tree */
+  depth: number;
+  /** Parent ID */
+  parentId?: string;
+  /** Parent entity name */
+  parentEntity?: string;
+  /** Path in the object (e.g., 'posts[0].comments[1]') */
+  path: string;
+}
+
+export interface TrackedItem {
+  entity: any;
+  metadata: TrackedEntityMetadata;
+  originalState: any;
+}
+
+export interface ArrayState {
+  cloned: any[];
+  original: any[];
+  metadata: TrackedEntityMetadata;
+  /** Indicates if array contains only primitive values (string, number, boolean, etc.) */
+  isPrimitiveArray?: boolean;
+}

package/src/types/domain.ts

@@ -1,41 +1,41 @@
-import { Id } from "../core/index";
-import { StandardSchema } from "./standard-schema.js";
-
-export interface BaseProps {
-  id: Id;
-}
-
-interface DomainValidation<T> {
-  schema: StandardSchema<T>;
-  config?: ValidationConfig;
-}
-
-export type EntityValidation<T> = DomainValidation<T>;
-export type VOValidation<T> = DomainValidation<T>;
-
-export interface VOHooks<V, VO> {
-  onBeforeCreate?: (value: V) => void;
-  rules?: (valueObject: VO) => void;
-}
-
-export interface EntityHooks<T extends BaseProps, E> {
-  onBeforeCreate?: (props: T) => void;
-  onBeforeUpdate?: (entity: E, snapshot: T) => boolean;
-  onCreate?: (entity: E) => void;
-  rules?: (entity: E) => void;
-}
-
-export interface ValidationConfig {
-  /** When true, validates the entity on creation. Default: true */
-  onCreate?: boolean;
-  /** When true, validates the entity on update. Default: true */
-  onUpdate?: boolean;
-  /** When true, throws a ValidationError when validation fails. Default: true */
-  throwOnError?: boolean;
-  /**
-   * When `throwOnError` is `false`, controls whether invalid updates are kept on the entity.
-   * - `true` (default): apply mutations and refresh `validationErrors` (dirty / form mode).
-   * - `false`: block mutations when errors already exist, and revert updates that fail validation.
-   */
-  persistInvalidMutations?: boolean;
-}
+import { Id } from "../core/index.js";
+import { StandardSchema } from "./standard-schema.js";
+
+export interface BaseProps {
+  id: Id;
+}
+
+interface DomainValidation<T> {
+  schema: StandardSchema<T>;
+  config?: ValidationConfig;
+}
+
+export type EntityValidation<T> = DomainValidation<T>;
+export type VOValidation<T> = DomainValidation<T>;
+
+export interface VOHooks<V, VO> {
+  onBeforeCreate?: (value: V) => void;
+  rules?: (valueObject: VO) => void;
+}
+
+export interface EntityHooks<T extends BaseProps, E> {
+  onBeforeCreate?: (props: T) => void;
+  onBeforeUpdate?: (entity: E, snapshot: T) => boolean;
+  onCreate?: (entity: E) => void;
+  rules?: (entity: E) => void;
+}
+
+export interface ValidationConfig {
+  /** When true, validates the entity on creation. Default: true */
+  onCreate?: boolean;
+  /** When true, validates the entity on update. Default: true */
+  onUpdate?: boolean;
+  /** When true, throws a ValidationError when validation fails. Default: true */
+  throwOnError?: boolean;
+  /**
+   * When `throwOnError` is `false`, controls whether invalid updates are kept on the entity.
+   * - `true` (default): apply mutations and refresh `validationErrors` (dirty / form mode).
+   * - `false`: block mutations when errors already exist, and revert updates that fail validation.
+   */
+  persistInvalidMutations?: boolean;
+}

package/src/types/event-bus.ts

@@ -1,17 +1,17 @@
-import { IDomainEvent } from "./domain-event";
-
-export interface IDomainEventBus {
-  /**
-   * Publish a single domain event.
-   *
-   * @param event - The domain event to publish
-   */
-  publish(event: IDomainEvent): Promise<void>;
-
-  /**
-   * Publish multiple domain events.
-   *
-   * @param events - Array of domain events to publish
-   */
-  publishAll(events: IDomainEvent[]): Promise<void>;
-}
+import type { IDomainEvent } from "./domain-event.js";
+
+export interface IDomainEventBus {
+  /**
+   * Publish a single domain event.
+   *
+   * @param event - The domain event to publish
+   */
+  publish(event: IDomainEvent): Promise<void>;
+
+  /**
+   * Publish multiple domain events.
+   *
+   * @param events - Array of domain events to publish
+   */
+  publishAll(events: IDomainEvent[]): Promise<void>;
+}