metal-orm 1.0.64 → 1.0.65

package/src/orm/orm-session.ts

@@ -18,7 +18,7 @@ import { RelationChangeProcessor } from './relation-change-processor.js';
 import { createQueryLoggingExecutor, QueryLogger } from './query-logger.js';
 import { ExecutionContext } from './execution-context.js';
 import type { HydrationContext } from './hydration-context.js';
-import type { EntityContext } from './entity-context.js';
+import type { EntityContext, PrimaryKey } from './entity-context.js';
 import {
   DomainEvent,
   OrmDomainEvent,
@@ -27,10 +27,10 @@ import {
   RelationKey,
   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 { 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';
 
 /**
  * Interface for ORM interceptors that allow hooking into the flush lifecycle.
@@ -142,9 +142,9 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
    * @param pk - The primary key value
    * @returns The entity or undefined if not found
    */
-  getEntity(table: TableDef, pk: unknown): unknown | undefined {
-    return this.unitOfWork.getEntity(table, pk as string | number);
-  }
+  getEntity(table: TableDef, pk: PrimaryKey): object | undefined {
+    return this.unitOfWork.getEntity(table, pk);
+  }
 
   /**
    * Sets an entity in the identity map.
@@ -152,9 +152,9 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
    * @param pk - The primary key value
    * @param entity - The entity instance
    */
-  setEntity(table: TableDef, pk: unknown, entity: unknown): void {
-    this.unitOfWork.setEntity(table, pk as string | number, entity);
-  }
+  setEntity(table: TableDef, pk: PrimaryKey, entity: object): void {
+    this.unitOfWork.setEntity(table, pk, entity);
+  }
 
   /**
    * Tracks a new entity.
@@ -162,9 +162,9 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
    * @param entity - The entity instance
    * @param pk - Optional primary key value
    */
-  trackNew(table: TableDef, entity: unknown, pk?: unknown): void {
-    this.unitOfWork.trackNew(table, entity, pk as string | number);
-  }
+  trackNew(table: TableDef, entity: object, pk?: PrimaryKey): void {
+    this.unitOfWork.trackNew(table, entity, pk);
+  }
 
   /**
    * Tracks a managed entity.
@@ -172,25 +172,25 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
    * @param pk - The primary key value
    * @param entity - The entity instance
    */
-  trackManaged(table: TableDef, pk: unknown, entity: unknown): void {
-    this.unitOfWork.trackManaged(table, pk as string | number, entity);
-  }
+  trackManaged(table: TableDef, pk: PrimaryKey, entity: object): void {
+    this.unitOfWork.trackManaged(table, pk, entity);
+  }
 
   /**
    * Marks an entity as dirty (modified).
    * @param entity - The entity to mark as dirty
    */
-  markDirty(entity: unknown): void {
-    this.unitOfWork.markDirty(entity);
-  }
+  markDirty(entity: object): void {
+    this.unitOfWork.markDirty(entity);
+  }
 
   /**
    * Marks an entity as removed.
    * @param entity - The entity to mark as removed
    */
-  markRemoved(entity: unknown): void {
-    this.unitOfWork.markRemoved(entity);
-  }
+  markRemoved(entity: object): void {
+    this.unitOfWork.markRemoved(entity);
+  }
 
   /**
    * Registers a relation change.
@@ -298,30 +298,30 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
     return executeHydrated(this, qb);
   }
 
-  /**
-   * Saves an entity graph (root + nested relations) based on a DTO-like 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
-   */
-  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());
-  }
+  /**
+   * Saves an entity graph (root + nested relations) based on a DTO-like 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
+   */
+  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());
+  }
 
   /**
    * Persists an entity (either inserts or updates).
@@ -340,7 +340,7 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
     const primaryKey = findPrimaryKey(table);
     const pkValue = (entity as Record<string, unknown>)[primaryKey];
     if (pkValue !== undefined && pkValue !== null) {
-      this.trackManaged(table, pkValue, entity);
+      this.trackManaged(table, pkValue as PrimaryKey, entity);
     } else {
       this.trackNew(table, entity);
     }
@@ -354,12 +354,12 @@ export class OrmSession<E extends DomainEvent = OrmDomainEvent> implements Entit
     this.markRemoved(entity);
   }
 
-  /**
-   * Flushes pending changes to the database without session hooks, relation processing, or domain events.
-   */
-  async flush(): Promise<void> {
-    await this.unitOfWork.flush();
-  }
+  /**
+   * Flushes pending changes to the database without session hooks, relation processing, or domain events.
+   */
+  async flush(): Promise<void> {
+    await this.unitOfWork.flush();
+  }
 
   /**
    * Flushes pending changes with interceptors and relation processing.

package/src/orm/relation-change-processor.ts

@@ -78,7 +78,7 @@ export class RelationChangeProcessor {
     const target = entry.change.entity;
     if (!target) return;
 
-    const tracked = this.unitOfWork.findTracked(target);
+    const tracked = this.unitOfWork.findTracked(target as object);
     if (!tracked) return;
 
     const localKey = relation.localKey || findPrimaryKey(entry.rootTable);
@@ -105,7 +105,7 @@ export class RelationChangeProcessor {
     const target = entry.change.entity;
     if (!target) return;
 
-    const tracked = this.unitOfWork.findTracked(target);
+    const tracked = this.unitOfWork.findTracked(target as object);
     if (!tracked) return;
 
     const localKey = relation.localKey || findPrimaryKey(entry.rootTable);
@@ -154,7 +154,7 @@ export class RelationChangeProcessor {
       await this.deletePivotRow(relation, rootId, targetId);
 
       if (relation.cascade === 'all' || relation.cascade === 'remove') {
-        this.unitOfWork.markRemoved(entry.change.entity);
+        this.unitOfWork.markRemoved(entry.change.entity as object);
       }
     }
   }

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

@@ -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);
+    this.ctx.markDirty(entity as object);
     this.items.push(entity);
     this.ctx.registerRelationChange(
       this.root,

package/src/orm/runtime-types.ts

@@ -20,11 +20,11 @@ export enum EntityStatus {
 /**
  * Represents an entity being tracked by the ORM
  */
-export interface TrackedEntity {
-  /** The table definition this entity belongs to */
-  table: TableDef;
-  /** The actual entity instance */
-  entity: unknown;
+export interface TrackedEntity {
+  /** The table definition this entity belongs to */
+  table: TableDef;
+  /** The actual entity instance */
+  entity: object;
   /** Primary key value of the entity */
   pk: string | number | null;
   /** Current status of the entity */

package/src/orm/save-graph.ts

@@ -1,16 +1,16 @@
-import type {
-  EntityInstance,
-  HasManyCollection,
-  HasOneReference,
-  BelongsToReference,
-  ManyToManyCollection
-} from '../schema/types.js';
-import { normalizeColumnType, type ColumnDef } from '../schema/column-types.js';
-import {
-  RelationKinds,
-  type BelongsToManyRelation,
-  type BelongsToRelation,
-  type HasManyRelation,
+import type {
+  EntityInstance,
+  HasManyCollection,
+  HasOneReference,
+  BelongsToReference,
+  ManyToManyCollection
+} from '../schema/types.js';
+import { normalizeColumnType, type ColumnDef } from '../schema/column-types.js';
+import {
+  RelationKinds,
+  type BelongsToManyRelation,
+  type BelongsToRelation,
+  type HasManyRelation,
   type HasOneRelation,
   type RelationDef
 } from '../schema/relation.js';
@@ -24,16 +24,16 @@ import type { OrmSession } from './orm-session.js';
 /**
  * Options for controlling the behavior of save graph operations.
  */
-export interface SaveGraphOptions {
-  /** Remove existing collection members that are not present in the payload */
-  pruneMissing?: boolean;
-  /**
-   * Coerce JSON-friendly input values into DB-friendly primitives.
-   * Currently:
-   * - Date -> ISO string (for DATE/DATETIME/TIMESTAMP/TIMESTAMPTZ columns)
-   */
-  coerce?: 'json';
-}
+export interface SaveGraphOptions {
+  /** Remove existing collection members that are not present in the payload */
+  pruneMissing?: boolean;
+  /**
+   * Coerce JSON-friendly input values into DB-friendly primitives.
+   * Currently:
+   * - Date -> ISO string (for DATE/DATETIME/TIMESTAMP/TIMESTAMPTZ columns)
+   */
+  coerce?: 'json';
+}
 
 /** Represents an entity object with arbitrary properties. */
 
@@ -51,58 +51,58 @@ type AnyEntity = Record<string, unknown>;
 
  */
 
-const toKey = (value: unknown): string => (value === null || value === undefined ? '' : String(value));
-
-const coerceColumnValue = (
-  table: TableDef,
-  columnName: string,
-  value: unknown,
-  options: SaveGraphOptions
-): unknown => {
-  if (options.coerce !== 'json') return value;
-  if (value === null || value === undefined) return value;
-
-  const column = table.columns[columnName] as unknown as ColumnDef | undefined;
-  if (!column) return value;
-
-  const normalized = normalizeColumnType(column.type);
-
-  const isDateLikeColumn =
-    normalized === 'date' ||
-    normalized === 'datetime' ||
-    normalized === 'timestamp' ||
-    normalized === 'timestamptz';
-
-  if (isDateLikeColumn && value instanceof Date) {
-    return value.toISOString();
-  }
-
-  // Future coercions can be added here based on `normalized`.
-  return value;
-};
-
-const pickColumns = (table: TableDef, payload: AnyEntity, options: SaveGraphOptions): Record<string, unknown> => {
-  const columns: Record<string, unknown> = {};
-  for (const key of Object.keys(table.columns)) {
-    if (payload[key] !== undefined) {
-      columns[key] = coerceColumnValue(table, key, payload[key], options);
-    }
-  }
-  return columns;
-};
-
-const ensureEntity = <TTable extends TableDef>(
-  session: OrmSession,
-  table: TTable,
-  payload: AnyEntity,
-  options: SaveGraphOptions
-): EntityInstance<TTable> => {
-  const pk = findPrimaryKey(table);
-  const row = pickColumns(table, payload, options);
-  const pkValue = payload[pk];
+const toKey = (value: unknown): string => (value === null || value === undefined ? '' : String(value));
+
+const coerceColumnValue = (
+  table: TableDef,
+  columnName: string,
+  value: unknown,
+  options: SaveGraphOptions
+): unknown => {
+  if (options.coerce !== 'json') return value;
+  if (value === null || value === undefined) return value;
+
+  const column = table.columns[columnName] as unknown as ColumnDef | undefined;
+  if (!column) return value;
+
+  const normalized = normalizeColumnType(column.type);
+
+  const isDateLikeColumn =
+    normalized === 'date' ||
+    normalized === 'datetime' ||
+    normalized === 'timestamp' ||
+    normalized === 'timestamptz';
+
+  if (isDateLikeColumn && value instanceof Date) {
+    return value.toISOString();
+  }
+
+  // Future coercions can be added here based on `normalized`.
+  return value;
+};
+
+const pickColumns = (table: TableDef, payload: AnyEntity, options: SaveGraphOptions): Record<string, unknown> => {
+  const columns: Record<string, unknown> = {};
+  for (const key of Object.keys(table.columns)) {
+    if (payload[key] !== undefined) {
+      columns[key] = coerceColumnValue(table, key, payload[key], options);
+    }
+  }
+  return columns;
+};
+
+const ensureEntity = <TTable extends TableDef>(
+  session: OrmSession,
+  table: TTable,
+  payload: AnyEntity,
+  options: SaveGraphOptions
+): EntityInstance<TTable> => {
+  const pk = findPrimaryKey(table);
+  const row = pickColumns(table, payload, options);
+  const pkValue = payload[pk];
 
   if (pkValue !== undefined && pkValue !== null) {
-    const tracked = session.getEntity(table, pkValue);
+    const tracked = session.getEntity(table, pkValue as string | number);
     if (tracked) {
       return tracked as EntityInstance<TTable>;
     }
@@ -112,16 +112,16 @@ const ensureEntity = <TTable extends TableDef>(
     }
   }
 
-  return createEntityFromRow(session, table, row) as EntityInstance<TTable>;
-};
-
-const assignColumns = (table: TableDef, entity: AnyEntity, payload: AnyEntity, options: SaveGraphOptions): void => {
-  for (const key of Object.keys(table.columns)) {
-    if (payload[key] !== undefined) {
-      entity[key] = coerceColumnValue(table, key, payload[key], options);
-    }
-  }
-};
+  return createEntityFromRow(session, table, row) as EntityInstance<TTable>;
+};
+
+const assignColumns = (table: TableDef, entity: AnyEntity, payload: AnyEntity, options: SaveGraphOptions): void => {
+  for (const key of Object.keys(table.columns)) {
+    if (payload[key] !== undefined) {
+      entity[key] = coerceColumnValue(table, key, payload[key], options);
+    }
+  }
+};
 
 const isEntityInCollection = (items: AnyEntity[], pkName: string, entity: AnyEntity): boolean => {
   if (items.includes(entity)) return true;
@@ -157,13 +157,13 @@ const handleHasMany = async (
     const asObj = typeof item === 'object' ? (item as AnyEntity) : { [targetPk]: item };
     const pkValue = asObj[targetPk];
 
-    const current =
-      findInCollectionByPk(existing, targetPk, pkValue) ??
-      (pkValue !== undefined && pkValue !== null ? session.getEntity(targetTable, pkValue) : undefined);
-
-    const entity = current ?? ensureEntity(session, targetTable, asObj, options);
-    assignColumns(targetTable, entity as AnyEntity, asObj, options);
-    await applyGraphToEntity(session, targetTable, entity as AnyEntity, asObj, options);
+    const current =
+      findInCollectionByPk(existing, targetPk, pkValue) ??
+      (pkValue !== undefined && pkValue !== null ? session.getEntity(targetTable, pkValue as string | number) : undefined);
+
+    const entity = current ?? ensureEntity(session, targetTable, asObj, options);
+    assignColumns(targetTable, entity as AnyEntity, asObj, options);
+    await applyGraphToEntity(session, targetTable, entity as AnyEntity, asObj, options);
 
     if (!isEntityInCollection(collection.getItems() as unknown as AnyEntity[], targetPk, entity as unknown as AnyEntity)) {
       collection.attach(entity);
@@ -184,15 +184,15 @@ const handleHasMany = async (
   }
 };
 
-const handleHasOne = async (
-  session: OrmSession,
-  root: AnyEntity,
-  relationName: string,
-  relation: HasOneRelation,
-  payload: unknown,
-  options: SaveGraphOptions
-): Promise<void> => {
-  const ref = root[relationName] as unknown as HasOneReference<object>;
+const handleHasOne = async (
+  session: OrmSession,
+  root: AnyEntity,
+  relationName: string,
+  relation: HasOneRelation,
+  payload: unknown,
+  options: SaveGraphOptions
+): Promise<void> => {
+  const ref = root[relationName] as unknown as HasOneReference<object>;
   if (payload === undefined) return;
   if (payload === null) {
     ref.set(null);
@@ -206,21 +206,21 @@ const handleHasOne = async (
     }
     return;
   }
-  const attached = ref.set(payload as AnyEntity);
-  if (attached) {
-    await applyGraphToEntity(session, relation.target, attached as AnyEntity, payload as AnyEntity, options);
-  }
-};
-
-const handleBelongsTo = async (
-  session: OrmSession,
-  root: AnyEntity,
-  relationName: string,
-  relation: BelongsToRelation,
-  payload: unknown,
-  options: SaveGraphOptions
-): Promise<void> => {
-  const ref = root[relationName] as unknown as BelongsToReference<object>;
+  const attached = ref.set(payload as AnyEntity);
+  if (attached) {
+    await applyGraphToEntity(session, relation.target, attached as AnyEntity, payload as AnyEntity, options);
+  }
+};
+
+const handleBelongsTo = async (
+  session: OrmSession,
+  root: AnyEntity,
+  relationName: string,
+  relation: BelongsToRelation,
+  payload: unknown,
+  options: SaveGraphOptions
+): Promise<void> => {
+  const ref = root[relationName] as unknown as BelongsToReference<object>;
   if (payload === undefined) return;
   if (payload === null) {
     ref.set(null);
@@ -234,11 +234,11 @@ const handleBelongsTo = async (
     }
     return;
   }
-  const attached = ref.set(payload as AnyEntity);
-  if (attached) {
-    await applyGraphToEntity(session, relation.target, attached as AnyEntity, payload as AnyEntity, options);
-  }
-};
+  const attached = ref.set(payload as AnyEntity);
+  if (attached) {
+    await applyGraphToEntity(session, relation.target, attached as AnyEntity, payload as AnyEntity, options);
+  }
+};
 
 const handleBelongsToMany = async (
   session: OrmSession,
@@ -265,14 +265,14 @@ const handleBelongsToMany = async (
       continue;
     }
 
-    const asObj = item as AnyEntity;
-    const pkValue = asObj[targetPk];
-    const entity = pkValue !== undefined && pkValue !== null
-      ? session.getEntity(targetTable, pkValue) ?? ensureEntity(session, targetTable, asObj, options)
-      : ensureEntity(session, targetTable, asObj, options);
-
-    assignColumns(targetTable, entity as AnyEntity, asObj, options);
-    await applyGraphToEntity(session, targetTable, entity as AnyEntity, asObj, options);
+    const asObj = item as AnyEntity;
+    const pkValue = asObj[targetPk];
+    const entity = pkValue !== undefined && pkValue !== null
+      ? session.getEntity(targetTable, pkValue as string | number) ?? ensureEntity(session, targetTable, asObj, options)
+      : ensureEntity(session, targetTable, asObj, options);
+
+    assignColumns(targetTable, entity as AnyEntity, asObj, options);
+    await applyGraphToEntity(session, targetTable, entity as AnyEntity, asObj, options);
 
     if (!isEntityInCollection(collection.getItems() as unknown as AnyEntity[], targetPk, entity as unknown as AnyEntity)) {
       collection.attach(entity);
@@ -314,36 +314,36 @@ const applyRelation = async (
   }
 };
 
-const applyGraphToEntity = async (
-  session: OrmSession,
-  table: TableDef,
-  entity: AnyEntity,
-  payload: AnyEntity,
-  options: SaveGraphOptions
-): Promise<void> => {
-  assignColumns(table, entity, payload, options);
-
-  for (const [relationName, relation] of Object.entries(table.relations)) {
-    if (!(relationName in payload)) continue;
-    await applyRelation(session, table, entity, relationName, relation as RelationDef, payload[relationName], options);
-  }
-};
-
-export const saveGraph = async <TTable extends TableDef>(
-  session: OrmSession,
-  entityClass: EntityConstructor,
-  payload: AnyEntity,
-  options: SaveGraphOptions = {}
-): Promise<EntityInstance<TTable>> => {
+const applyGraphToEntity = async (
+  session: OrmSession,
+  table: TableDef,
+  entity: AnyEntity,
+  payload: AnyEntity,
+  options: SaveGraphOptions
+): Promise<void> => {
+  assignColumns(table, entity, payload, options);
+
+  for (const [relationName, relation] of Object.entries(table.relations)) {
+    if (!(relationName in payload)) continue;
+    await applyRelation(session, table, entity, relationName, relation as RelationDef, payload[relationName], options);
+  }
+};
+
+export const saveGraph = async <TTable extends TableDef>(
+  session: OrmSession,
+  entityClass: EntityConstructor,
+  payload: AnyEntity,
+  options: SaveGraphOptions = {}
+): Promise<EntityInstance<TTable>> => {
   const table = getTableDefFromEntity(entityClass);
   if (!table) {
     throw new Error('Entity metadata has not been bootstrapped');
   }
 
-  const root = ensureEntity<TTable>(session, table as TTable, payload, options);
-  await applyGraphToEntity(session, table, root as AnyEntity, payload, options);
-  return root;
-};
+  const root = ensureEntity<TTable>(session, table as TTable, payload, options);
+  await applyGraphToEntity(session, table, root as AnyEntity, payload, options);
+  return root;
+};
 
 /**
 
@@ -361,7 +361,7 @@ export const saveGraph = async <TTable extends TableDef>(
 
  */
 
-export const saveGraphInternal = async <TCtor extends EntityConstructor>(
+export const saveGraphInternal = async <TCtor extends EntityConstructor>(
 
   session: OrmSession,
 
@@ -373,7 +373,7 @@ export const saveGraphInternal = async <TCtor extends EntityConstructor>(
 
 ): Promise<InstanceType<TCtor>> => {
 
-  const table = getTableDefFromEntity(entityClass);
+  const table = getTableDefFromEntity(entityClass);
 
   if (!table) {
 
@@ -381,10 +381,10 @@ export const saveGraphInternal = async <TCtor extends EntityConstructor>(
 
   }
 
-  const root = ensureEntity(session, table, payload, options);
-
-  await applyGraphToEntity(session, table, root as AnyEntity, payload, options);
-
-  return root as unknown as InstanceType<TCtor>;
-
-};
+  const root = ensureEntity(session, table, payload, options);
+
+  await applyGraphToEntity(session, table, root as AnyEntity, payload, options);
+
+  return root as unknown as InstanceType<TCtor>;
+
+};