metal-orm 1.0.63 → 1.0.65

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

package/src/orm/unit-of-work.ts

@@ -1,4 +1,5 @@
-import { ColumnNode, eq } from '../core/ast/expression.js';
+import { ColumnNode, eq } from '../core/ast/expression.js';
+import type { ValueOperandInput } from '../core/ast/expression.js';
 import type { Dialect, CompiledQuery } from '../core/dialect/abstract.js';
 import { InsertQueryBuilder } from '../query-builder/insert.js';
 import { UpdateQueryBuilder } from '../query-builder/update.js';
@@ -13,8 +14,8 @@ import type { TrackedEntity } from './runtime-types.js';
 /**
  * Unit of Work pattern implementation for tracking entity changes.
  */
-export class UnitOfWork {
-  private readonly trackedEntities = new Map<unknown, TrackedEntity>();
+export class UnitOfWork {
+  private readonly trackedEntities = new Map<object, TrackedEntity>();
 
   /**
    * Creates a new UnitOfWork instance.
@@ -51,9 +52,9 @@ export class UnitOfWork {
    * @param pk - The primary key value
    * @returns The entity or undefined if not found
    */
-  getEntity(table: TableDef, pk: string | number): unknown | undefined {
-    return this.identityMap.getEntity(table, pk);
-  }
+  getEntity(table: TableDef, pk: string | number): object | undefined {
+    return this.identityMap.getEntity(table, pk);
+  }
 
   /**
    * Gets all tracked entities for a specific table.
@@ -69,9 +70,9 @@ export class UnitOfWork {
    * @param entity - The entity to find
    * @returns The tracked entity or undefined if not found
    */
-  findTracked(entity: unknown): TrackedEntity | undefined {
-    return this.trackedEntities.get(entity);
-  }
+  findTracked(entity: object): TrackedEntity | undefined {
+    return this.trackedEntities.get(entity);
+  }
 
   /**
    * Sets an entity in the identity map.
@@ -79,9 +80,9 @@ export class UnitOfWork {
    * @param pk - The primary key value
    * @param entity - The entity instance
    */
-  setEntity(table: TableDef, pk: string | number, entity: unknown): void {
-    if (pk === null || pk === undefined) return;
-    let tracked = this.trackedEntities.get(entity);
+  setEntity(table: TableDef, pk: string | number, entity: object): void {
+    if (pk === null || pk === undefined) return;
+    let tracked = this.trackedEntities.get(entity);
     if (!tracked) {
       tracked = {
         table,
@@ -104,7 +105,7 @@ export class UnitOfWork {
    * @param entity - The entity instance
    * @param pk - Optional primary key value
    */
-  trackNew(table: TableDef, entity: unknown, pk?: string | number): void {
+  trackNew(table: TableDef, entity: object, pk?: string | number): void {
     const tracked: TrackedEntity = {
       table,
       entity,
@@ -124,7 +125,7 @@ export class UnitOfWork {
    * @param pk - The primary key value
    * @param entity - The entity instance
    */
-  trackManaged(table: TableDef, pk: string | number, entity: unknown): void {
+  trackManaged(table: TableDef, pk: string | number, entity: object): void {
     const tracked: TrackedEntity = {
       table,
       entity,
@@ -140,22 +141,22 @@ export class UnitOfWork {
    * Marks an entity as dirty (modified).
    * @param entity - The entity to mark as dirty
    */
-  markDirty(entity: unknown): void {
-    const tracked = this.trackedEntities.get(entity);
-    if (!tracked) return;
-    if (tracked.status === EntityStatus.New || tracked.status === EntityStatus.Removed) return;
-    tracked.status = EntityStatus.Dirty;
-  }
+  markDirty(entity: object): void {
+    const tracked = this.trackedEntities.get(entity);
+    if (!tracked) return;
+    if (tracked.status === EntityStatus.New || tracked.status === EntityStatus.Removed) return;
+    tracked.status = EntityStatus.Dirty;
+  }
 
   /**
    * Marks an entity as removed.
    * @param entity - The entity to mark as removed
    */
-  markRemoved(entity: unknown): void {
-    const tracked = this.trackedEntities.get(entity);
-    if (!tracked) return;
-    tracked.status = EntityStatus.Removed;
-  }
+  markRemoved(entity: object): void {
+    const tracked = this.trackedEntities.get(entity);
+    if (!tracked) return;
+    tracked.status = EntityStatus.Removed;
+  }
 
   /**
    * Flushes pending changes to the database.
@@ -194,8 +195,8 @@ export class UnitOfWork {
   private async flushInsert(tracked: TrackedEntity): Promise<void> {
     await this.runHook(tracked.table.hooks?.beforeInsert, tracked);
 
-    const payload = this.extractColumns(tracked.table, tracked.entity as Record<string, unknown>);
-    let builder = new InsertQueryBuilder(tracked.table).values(payload);
+    const payload = this.extractColumns(tracked.table, tracked.entity as Record<string, unknown>);
+    let builder = new InsertQueryBuilder(tracked.table).values(payload as Record<string, ValueOperandInput>);
     if (this.dialect.supportsReturning()) {
       builder = builder.returning(...this.getReturningColumns(tracked.table));
     }
@@ -287,16 +288,16 @@ export class UnitOfWork {
    * @param tracked - The tracked entity
    * @returns Object with changed column values
    */
-  private computeChanges(tracked: TrackedEntity): Record<string, unknown> {
-    const snapshot = tracked.original ?? {};
-    const changes: Record<string, unknown> = {};
-    for (const column of Object.keys(tracked.table.columns)) {
-      const current = tracked.entity[column];
-      if (snapshot[column] !== current) {
-        changes[column] = current;
-      }
-    }
-    return changes;
+  private computeChanges(tracked: TrackedEntity): Record<string, unknown> {
+    const snapshot = tracked.original ?? {};
+    const changes: Record<string, unknown> = {};
+    for (const column of Object.keys(tracked.table.columns)) {
+      const current = (tracked.entity as Record<string, unknown>)[column];
+      if (snapshot[column] !== current) {
+        changes[column] = current;
+      }
+    }
+    return changes;
   }
 
   /**
@@ -342,18 +343,18 @@ export class UnitOfWork {
    * @param tracked - The tracked entity
    * @param results - Query results
    */
-  private applyReturningResults(tracked: TrackedEntity, results: QueryResult[]): void {
-    if (!this.dialect.supportsReturning()) return;
-    const first = results[0];
-    if (!first || first.values.length === 0) return;
-
-    const row = first.values[0];
-    for (let i = 0; i < first.columns.length; i++) {
-      const columnName = this.normalizeColumnName(first.columns[i]);
-      if (!(columnName in tracked.table.columns)) continue;
-      tracked.entity[columnName] = row[i];
-    }
-  }
+  private applyReturningResults(tracked: TrackedEntity, results: QueryResult[]): void {
+    if (!this.dialect.supportsReturning()) return;
+    const first = results[0];
+    if (!first || first.values.length === 0) return;
+
+    const row = first.values[0];
+    for (let i = 0; i < first.columns.length; i++) {
+      const columnName = this.normalizeColumnName(first.columns[i]);
+      if (!(columnName in tracked.table.columns)) continue;
+      (tracked.entity as Record<string, unknown>)[columnName] = row[i];
+    }
+  }
 
   /**
    * Normalizes a column name by removing quotes and table prefixes.
@@ -394,10 +395,11 @@ export class UnitOfWork {
    * @param tracked - The tracked entity
    * @returns Primary key value or null
    */
-  private getPrimaryKeyValue(tracked: TrackedEntity): string | number | null {
-    const key = findPrimaryKey(tracked.table);
-    const val = tracked.entity[key];
-    if (val === undefined || val === null) return null;
-    return val;
-  }
-}
+  private getPrimaryKeyValue(tracked: TrackedEntity): string | number | null {
+    const key = findPrimaryKey(tracked.table);
+    const val = (tracked.entity as Record<string, unknown>)[key];
+    if (val === undefined || val === null) return null;
+    if (typeof val !== 'string' && typeof val !== 'number') return null;
+    return val;
+  }
+}