metal-orm 1.0.66 → 1.0.68

package/src/orm/entity-relation-cache.ts

@@ -1,39 +1,39 @@
-import { TableDef } from '../schema/table.js';
-import { EntityMeta, getEntityMeta } from './entity-meta.js';
-
-/**
- * Caches relation loader results across entities of the same type.
- * @template T - The cache type
- * @param meta - The entity metadata
- * @param relationName - The relation name
- * @param factory - The factory function to create the cache
- * @returns Promise with the cached relation data
- */
-export const relationLoaderCache = <TTable extends TableDef, T extends Map<string, unknown>>(
-  meta: EntityMeta<TTable>,
-  relationName: string,
-  factory: () => Promise<T>
-): Promise<T> => {
-  if (meta.relationCache.has(relationName)) {
-    return meta.relationCache.get(relationName)! as Promise<T>;
-  }
-
-  const promise = factory().then(value => {
-    for (const tracked of meta.ctx.getEntitiesForTable(meta.table)) {
-      const otherMeta = getEntityMeta(tracked.entity);
-      if (!otherMeta) continue;
-      otherMeta.relationHydration.set(relationName, value);
-    }
-    return value;
-  });
-
-  meta.relationCache.set(relationName, promise);
-
-  for (const tracked of meta.ctx.getEntitiesForTable(meta.table)) {
-    const otherMeta = getEntityMeta(tracked.entity);
-    if (!otherMeta) continue;
-    otherMeta.relationCache.set(relationName, promise);
-  }
-
-  return promise;
-};
+import { TableDef } from '../schema/table.js';
+import { EntityMeta, getEntityMeta } from './entity-meta.js';
+
+/**
+ * Caches relation loader results across entities of the same type.
+ * @template T - The cache type
+ * @param meta - The entity metadata
+ * @param relationName - The relation name
+ * @param factory - The factory function to create the cache
+ * @returns Promise with the cached relation data
+ */
+export const relationLoaderCache = <TTable extends TableDef, T extends Map<string, unknown>>(
+  meta: EntityMeta<TTable>,
+  relationName: string,
+  factory: () => Promise<T>
+): Promise<T> => {
+  if (meta.relationCache.has(relationName)) {
+    return meta.relationCache.get(relationName)! as Promise<T>;
+  }
+
+  const promise = factory().then(value => {
+    for (const tracked of meta.ctx.getEntitiesForTable(meta.table)) {
+      const otherMeta = getEntityMeta(tracked.entity);
+      if (!otherMeta) continue;
+      otherMeta.relationHydration.set(relationName, value);
+    }
+    return value;
+  });
+
+  meta.relationCache.set(relationName, promise);
+
+  for (const tracked of meta.ctx.getEntitiesForTable(meta.table)) {
+    const otherMeta = getEntityMeta(tracked.entity);
+    if (!otherMeta) continue;
+    otherMeta.relationCache.set(relationName, promise);
+  }
+
+  return promise;
+};

package/src/orm/entity.ts

@@ -1,6 +1,6 @@
 import { TableDef } from '../schema/table.js';
 import { EntityInstance } from '../schema/types.js';
-import type { EntityContext, PrimaryKey } from './entity-context.js';
+import type { EntityContext, PrimaryKey } from './entity-context.js';
 import { ENTITY_META, EntityMeta, RelationKey } from './entity-meta.js';
 import { findPrimaryKey } from '../query-builder/hydration-planner.js';
 import { RelationIncludeOptions } from '../query-builder/relation-types.js';
@@ -109,13 +109,13 @@ export const createEntityFromRow = <
   const pkName = findPrimaryKey(table);
   const pkValue = row[pkName];
   if (pkValue !== undefined && pkValue !== null) {
-    const tracked = ctx.getEntity(table, pkValue as PrimaryKey);
+    const tracked = ctx.getEntity(table, pkValue as PrimaryKey);
     if (tracked) return tracked as TResult;
   }
 
   const entity = createEntityProxy(ctx, table, row, lazyRelations, lazyRelationOptions);
   if (pkValue !== undefined && pkValue !== null) {
-    ctx.trackManaged(table, pkValue as PrimaryKey, entity);
+    ctx.trackManaged(table, pkValue as PrimaryKey, entity);
   } else {
     ctx.trackNew(table, entity);
   }

package/src/orm/orm-session.ts

@@ -28,9 +28,9 @@ import {
   TrackedEntity
 } from './runtime-types.js';
 import { executeHydrated } from './execute.js';
-import { runInTransaction } from './transaction-runner.js';
-import { saveGraphInternal, SaveGraphOptions } from './save-graph.js';
-import type { SaveGraphInputPayload } from './save-graph-types.js';
+import { runInTransaction } from './transaction-runner.js';
+import { saveGraphInternal, SaveGraphOptions } from './save-graph.js';
+import type { SaveGraphInputPayload } from './save-graph-types.js';
 
 /**
  * Interface for ORM interceptors that allow hooking into the flush lifecycle.
@@ -53,7 +53,7 @@ export interface OrmInterceptor {
  * Options for creating an OrmSession instance.
  * @template E - The domain event type
  */
-export interface OrmSessionOptions<E extends DomainEvent = OrmDomainEvent> {
+export interface OrmSessionOptions<E extends DomainEvent = OrmDomainEvent> {
   /** The ORM instance */
   orm: Orm<E>;
   /** The database executor */
@@ -63,14 +63,21 @@ export interface OrmSessionOptions<E extends DomainEvent = OrmDomainEvent> {
   /** Optional interceptors for flush lifecycle hooks */
   interceptors?: OrmInterceptor[];
   /** Optional domain event handlers */
-  domainEventHandlers?: InitialHandlers<E, OrmSession<E>>;
-}
-
-/**
- * ORM Session that manages entity lifecycle, identity mapping, and database operations.
- * @template E - The domain event type
- */
-export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements EntityContext {
+  domainEventHandlers?: InitialHandlers<E, OrmSession<E>>;
+}
+
+export interface SaveGraphSessionOptions extends SaveGraphOptions {
+  /** Wrap the save operation in a transaction (default: true). */
+  transactional?: boolean;
+  /** Flush after saveGraph when not transactional (default: false). */
+  flush?: boolean;
+}
+
+/**
+ * ORM Session that manages entity lifecycle, identity mapping, and database operations.
+ * @template E - The domain event type
+ */
+export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements EntityContext {
   /** The ORM instance */
   readonly orm: Orm<E>;
   /** The database executor */
@@ -81,10 +88,11 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
   readonly unitOfWork: UnitOfWork;
   /** The domain event bus */
   readonly domainEvents: DomainEventBus<E, OrmSession<E>>;
-  /** The relation change processor */
-  readonly relationChanges: RelationChangeProcessor;
-
-  private readonly interceptors: OrmInterceptor[];
+  /** The relation change processor */
+  readonly relationChanges: RelationChangeProcessor;
+
+  private readonly interceptors: OrmInterceptor[];
+  private saveGraphDefaults?: SaveGraphSessionOptions;
 
   /**
    * Creates a new OrmSession instance.
@@ -236,12 +244,22 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
    * @param type - The event type
    * @param handler - The event handler
    */
-  registerDomainEventHandler<TType extends E['type']>(
-    type: TType,
-    handler: DomainEventHandler<Extract<E, { type: TType }>, OrmSession<E>>
-  ): void {
-    this.domainEvents.on(type, handler);
-  }
+  registerDomainEventHandler<TType extends E['type']>(
+    type: TType,
+    handler: DomainEventHandler<Extract<E, { type: TType }>, OrmSession<E>>
+  ): void {
+    this.domainEvents.on(type, handler);
+  }
+
+  /**
+   * Sets default options applied to all saveGraph calls for this session.
+   * Per-call options override these defaults.
+   * @param defaults - Default saveGraph options for the session
+   */
+  withSaveGraphDefaults(defaults: SaveGraphSessionOptions): this {
+    this.saveGraphDefaults = { ...defaults };
+    return this;
+  }
 
   /**
    * Finds an entity by its primary key.
@@ -305,23 +323,85 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
    * @param options - Graph save options
    * @returns The root entity instance
    */
-  async saveGraph<TCtor extends EntityConstructor<object>>(
-    entityClass: TCtor,
-    payload: SaveGraphInputPayload<InstanceType<TCtor>>,
-    options?: SaveGraphOptions & { transactional?: boolean }
-  ): Promise<InstanceType<TCtor>>;
-  async saveGraph<TCtor extends EntityConstructor<object>>(
-    entityClass: TCtor,
-    payload: Record<string, unknown>,
-    options?: SaveGraphOptions & { transactional?: boolean }
-  ): Promise<InstanceType<TCtor>> {
-    const { transactional = true, ...graphOptions } = options ?? {};
-    const execute = () => saveGraphInternal(this, entityClass, payload, graphOptions);
-    if (!transactional) {
-      return execute();
-    }
-    return this.transaction(() => execute());
-  }
+  async saveGraph<TCtor extends EntityConstructor<object>>(
+    entityClass: TCtor,
+    payload: SaveGraphInputPayload<InstanceType<TCtor>>,
+    options?: SaveGraphSessionOptions
+  ): Promise<InstanceType<TCtor>>;
+  async saveGraph<TCtor extends EntityConstructor<object>>(
+    entityClass: TCtor,
+    payload: Record<string, unknown>,
+    options?: SaveGraphSessionOptions
+  ): Promise<InstanceType<TCtor>> {
+    const resolved = this.resolveSaveGraphOptions(options);
+    const { transactional = true, flush = false, ...graphOptions } = resolved;
+    const execute = () => saveGraphInternal(this, entityClass, payload, graphOptions);
+    if (!transactional) {
+      const result = await execute();
+      if (flush) {
+        await this.flush();
+      }
+      return result;
+    }
+    return this.transaction(() => execute());
+  }
+
+  /**
+   * Saves an entity graph and flushes immediately (defaults to transactional: false).
+   * @param entityClass - Root entity constructor
+   * @param payload - DTO payload containing column values and nested relations
+   * @param options - Graph save options
+   * @returns The root entity instance
+   */
+  async saveGraphAndFlush<TCtor extends EntityConstructor<object>>(
+    entityClass: TCtor,
+    payload: SaveGraphInputPayload<InstanceType<TCtor>>,
+    options?: SaveGraphSessionOptions
+  ): Promise<InstanceType<TCtor>> {
+    const merged = { ...(options ?? {}), flush: true, transactional: options?.transactional ?? false };
+    return this.saveGraph(entityClass, payload, merged);
+  }
+
+  /**
+   * Updates an existing entity graph (requires a primary key in the payload).
+   * @param entityClass - Root entity constructor
+   * @param payload - DTO payload containing column values and nested relations
+   * @param options - Graph save options
+   * @returns The root entity instance or null if not found
+   */
+  async updateGraph<TCtor extends EntityConstructor<object>>(
+    entityClass: TCtor,
+    payload: SaveGraphInputPayload<InstanceType<TCtor>>,
+    options?: SaveGraphSessionOptions
+  ): Promise<InstanceType<TCtor> | null> {
+    const table = getTableDefFromEntity(entityClass);
+    if (!table) {
+      throw new Error('Entity metadata has not been bootstrapped');
+    }
+    const primaryKey = findPrimaryKey(table);
+    const pkValue = (payload as Record<string, unknown>)[primaryKey];
+    if (pkValue === undefined || pkValue === null) {
+      throw new Error(`updateGraph requires a primary key value for "${primaryKey}"`);
+    }
+
+    const resolved = this.resolveSaveGraphOptions(options);
+    const { transactional = true, flush = false, ...graphOptions } = resolved;
+    const execute = async (): Promise<InstanceType<TCtor> | null> => {
+      const tracked = this.getEntity(table, pkValue as PrimaryKey) as InstanceType<TCtor> | undefined;
+      const existing = tracked ?? await this.find(entityClass, pkValue);
+      if (!existing) return null;
+      return saveGraphInternal(this, entityClass, payload, graphOptions);
+    };
+
+    if (!transactional) {
+      const result = await execute();
+      if (result && flush) {
+        await this.flush();
+      }
+      return result;
+    }
+    return this.transaction(() => execute());
+  }
 
   /**
    * Persists an entity (either inserts or updates).
@@ -396,7 +476,7 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
    * @returns The result of the function
    * @throws If the transaction fails
    */
-  async transaction<T>(fn: (session: OrmSession<E>) => Promise<T>): Promise<T> {
+  async transaction<T>(fn: (session: OrmSession<E>) => Promise<T>): Promise<T> {
     // If the executor can't do transactions, just run and commit once.
     if (!this.executor.capabilities.transactions) {
       const result = await fn(this);
@@ -444,16 +524,25 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
    * Gets the hydration context.
    * @returns The hydration context
    */
-  getHydrationContext(): HydrationContext<E> {
-    return {
-      identityMap: this.identityMap,
-      unitOfWork: this.unitOfWork,
-      domainEvents: this.domainEvents,
-      relationChanges: this.relationChanges,
-      entityContext: this
-    };
-  }
-}
+  getHydrationContext(): HydrationContext<E> {
+    return {
+      identityMap: this.identityMap,
+      unitOfWork: this.unitOfWork,
+      domainEvents: this.domainEvents,
+      relationChanges: this.relationChanges,
+      entityContext: this
+    };
+  }
+
+  /**
+   * Merges session defaults with per-call saveGraph options.
+   * @param options - Per-call saveGraph options
+   * @returns Combined options with per-call values taking precedence
+   */
+  private resolveSaveGraphOptions(options?: SaveGraphSessionOptions): SaveGraphSessionOptions {
+    return { ...(this.saveGraphDefaults ?? {}), ...(options ?? {}) };
+  }
+}
 
 const buildRelationChangeEntry = (
   root: unknown,

package/src/orm/relations/belongs-to.ts

@@ -1,4 +1,4 @@
-import { BelongsToReferenceApi } from '../../schema/types.js';
+import { BelongsToReferenceApi } from '../../schema/types.js';
 import { EntityContext } from '../entity-context.js';
 import { RelationKey } from '../runtime-types.js';
 import { BelongsToRelation } from '../../schema/relation.js';
@@ -26,7 +26,7 @@ const hideInternal = (obj: object, keys: string[]): void => {
  *
  * @template TParent The type of the parent entity.
  */
-export class DefaultBelongsToReference<TParent extends object> implements BelongsToReferenceApi<TParent> {
+export class DefaultBelongsToReference<TParent extends object> implements BelongsToReferenceApi<TParent> {
   private loaded = false;
   private current: TParent | null = null;
 

package/src/orm/relations/has-many.ts

@@ -69,29 +69,29 @@ export class DefaultHasManyCollection<TChild> implements HasManyCollection<TChil
     this.items = rows.map(row => this.createEntity(row));
     this.loaded = true;
     return this.items;
-  }
-
-  /**
-   * Gets the current items in the collection.
-   * @returns Array of child entities
-   */
-  getItems(): TChild[] {
-    return this.items;
-  }
- 
-  /**
-   * Array-compatible length for testing frameworks.
-   */
-  get length(): number {
-    return this.items.length;
-  }
-
-  /**
-   * Enables iteration over the collection like an array.
-   */
-  [Symbol.iterator](): Iterator<TChild> {
-    return this.items[Symbol.iterator]();
-  }
+  }
+
+  /**
+   * Gets the current items in the collection.
+   * @returns Array of child entities
+   */
+  getItems(): TChild[] {
+    return this.items;
+  }
+ 
+  /**
+   * Array-compatible length for testing frameworks.
+   */
+  get length(): number {
+    return this.items.length;
+  }
+
+  /**
+   * Enables iteration over the collection like an array.
+   */
+  [Symbol.iterator](): Iterator<TChild> {
+    return this.items[Symbol.iterator]();
+  }
 
   /**
    * Adds a new child entity to the collection.
@@ -125,7 +125,7 @@ export class DefaultHasManyCollection<TChild> implements HasManyCollection<TChil
   attach(entity: TChild): void {
     const keyValue = this.root[this.localKey];
     (entity as Record<string, unknown>)[this.relation.foreignKey] = keyValue;
-    this.ctx.markDirty(entity as object);
+    this.ctx.markDirty(entity as object);
     this.items.push(entity);
     this.ctx.registerRelationChange(
       this.root,

package/src/orm/relations/has-one.ts

@@ -1,4 +1,4 @@
-import { HasOneReferenceApi } from '../../schema/types.js';
+import { HasOneReferenceApi } from '../../schema/types.js';
 import { EntityContext } from '../entity-context.js';
 import { RelationKey } from '../runtime-types.js';
 import { HasOneRelation } from '../../schema/relation.js';
@@ -26,7 +26,7 @@ const hideInternal = (obj: object, keys: string[]): void => {
  *
  * @template TChild The type of the child entity.
  */
-export class DefaultHasOneReference<TChild extends object> implements HasOneReferenceApi<TChild> {
+export class DefaultHasOneReference<TChild extends object> implements HasOneReferenceApi<TChild> {
   private loaded = false;
   private current: TChild | null = null;
 

package/src/orm/relations/many-to-many.ts

@@ -28,8 +28,8 @@ const hideInternal = (obj: object, keys: string[]): void => {
  *
  * @template TTarget The type of the target entities in the collection.
  */
-export class DefaultManyToManyCollection<TTarget, TPivot extends object | undefined = undefined>
-  implements ManyToManyCollection<TTarget, TPivot> {
+export class DefaultManyToManyCollection<TTarget, TPivot extends object | undefined = undefined>
+  implements ManyToManyCollection<TTarget, TPivot> {
   private loaded = false;
   private items: TTarget[] = [];
 
@@ -79,33 +79,33 @@ export class DefaultManyToManyCollection<TTarget, TPivot extends object | undefi
     return this.items;
   }
 
-  /**
-   * Returns the currently loaded items.
-   * @returns Array of target entities.
-   */
-  getItems(): TTarget[] {
-    return this.items;
-  }
-
-  /**
-   * Array-compatible length for testing frameworks.
-   */
-  get length(): number {
-    return this.items.length;
-  }
-
-  /**
-   * Enables iteration over the collection like an array.
-   */
-  [Symbol.iterator](): Iterator<TTarget> {
-    return this.items[Symbol.iterator]();
-  }
-
-  /**
-   * Attaches an entity to the collection.
-   * Registers an 'attach' change in the entity context.
-   * @param target Entity instance or its primary key value.
-   */
+  /**
+   * Returns the currently loaded items.
+   * @returns Array of target entities.
+   */
+  getItems(): TTarget[] {
+    return this.items;
+  }
+
+  /**
+   * Array-compatible length for testing frameworks.
+   */
+  get length(): number {
+    return this.items.length;
+  }
+
+  /**
+   * Enables iteration over the collection like an array.
+   */
+  [Symbol.iterator](): Iterator<TTarget> {
+    return this.items[Symbol.iterator]();
+  }
+
+  /**
+   * Attaches an entity to the collection.
+   * Registers an 'attach' change in the entity context.
+   * @param target Entity instance or its primary key value.
+   */
   attach(target: TTarget | number | string): void {
     const entity = this.ensureEntity(target);
     const id = this.extractId(entity);

package/src/orm/save-graph-types.ts

@@ -1,55 +1,56 @@
-import type {
-  BelongsToReference,
-  HasManyCollection,
-  HasOneReference,
-  ManyToManyCollection
-} from '../schema/types.js';
-
-type AnyId = number | string;
-type AnyFn = (...args: unknown[]) => unknown;
-
-type RelationWrapper =
-  | HasManyCollection<unknown>
-  | HasOneReference
-  | BelongsToReference
-  | ManyToManyCollection<unknown>;
-
-type FunctionKeys<T> = {
-  [K in keyof T & string]-?: T[K] extends AnyFn ? K : never;
-}[keyof T & string];
-
-type RelationKeys<T> = {
-  [K in keyof T & string]-?: NonNullable<T[K]> extends RelationWrapper ? K : never;
-}[keyof T & string];
-
-type ColumnKeys<T> = Exclude<keyof T & string, FunctionKeys<T> | RelationKeys<T>>;
-
-export type SaveGraphJsonScalar<T> = T extends Date ? string : T;
-
+import type {
+  BelongsToReference,
+  HasManyCollection,
+  HasOneReference,
+  ManyToManyCollection
+} from '../schema/types.js';
+
+type AnyId = number | string;
+type AnyFn = (...args: unknown[]) => unknown;
+
+type RelationWrapper =
+  | HasManyCollection<unknown>
+  | HasOneReference
+  | BelongsToReference
+  | ManyToManyCollection<unknown>;
+
+type FunctionKeys<T> = {
+  [K in keyof T & string]-?: T[K] extends AnyFn ? K : never;
+}[keyof T & string];
+
+type RelationKeys<T> = {
+  [K in keyof T & string]-?: NonNullable<T[K]> extends RelationWrapper ? K : never;
+}[keyof T & string];
+
+type ColumnKeys<T> = Exclude<keyof T & string, FunctionKeys<T> | RelationKeys<T>>;
+
+export type SaveGraphJsonScalar<T> = T extends Date ? string : T;
+
 /**
  * Input scalar type for `OrmSession.saveGraph` payloads.
  *
  * Note: runtime coercion is opt-in via `SaveGraphOptions.coerce`.
+ * For Date columns, string input is only safe when using `coerce: 'json-in'`.
  */
-export type SaveGraphInputScalar<T> = T;
-
-type ColumnInput<TEntity> = {
-  [K in ColumnKeys<TEntity>]?: SaveGraphInputScalar<TEntity[K]>;
-};
-
-type RelationInputValue<T> =
-  T extends HasManyCollection<infer C> ? Array<SaveGraphInputPayload<C> | AnyId> :
-  T extends HasOneReference<infer C> ? SaveGraphInputPayload<C> | AnyId | null :
-  T extends BelongsToReference<infer P> ? SaveGraphInputPayload<P> | AnyId | null :
-  T extends ManyToManyCollection<infer Tgt> ? Array<SaveGraphInputPayload<Tgt> | AnyId> :
-  never;
-
-type RelationInput<TEntity> = {
-  [K in RelationKeys<TEntity>]?: RelationInputValue<NonNullable<TEntity[K]>>;
-};
-
-/**
- * Typed payload accepted by `OrmSession.saveGraph`:
- * - Only entity scalar keys + relation keys are accepted.
- */
-export type SaveGraphInputPayload<TEntity> = ColumnInput<TEntity> & RelationInput<TEntity>;
+export type SaveGraphInputScalar<T> = T extends Date ? T | string | number : T;
+
+type ColumnInput<TEntity> = {
+  [K in ColumnKeys<TEntity>]?: SaveGraphInputScalar<TEntity[K]>;
+};
+
+type RelationInputValue<T> =
+  T extends HasManyCollection<infer C> ? Array<SaveGraphInputPayload<C> | AnyId> :
+  T extends HasOneReference<infer C> ? SaveGraphInputPayload<C> | AnyId | null :
+  T extends BelongsToReference<infer P> ? SaveGraphInputPayload<P> | AnyId | null :
+  T extends ManyToManyCollection<infer Tgt> ? Array<SaveGraphInputPayload<Tgt> | AnyId> :
+  never;
+
+type RelationInput<TEntity> = {
+  [K in RelationKeys<TEntity>]?: RelationInputValue<NonNullable<TEntity[K]>>;
+};
+
+/**
+ * Typed payload accepted by `OrmSession.saveGraph`:
+ * - Only entity scalar keys + relation keys are accepted.
+ */
+export type SaveGraphInputPayload<TEntity> = ColumnInput<TEntity> & RelationInput<TEntity>;