metal-orm 1.0.12 → 1.0.13

package/src/orm/orm-context.ts

@@ -1,20 +1,21 @@
 import type { Dialect } from '../core/dialect/abstract.js';
 import type { RelationDef } from '../schema/relation.js';
 import type { TableDef } from '../schema/table.js';
-import type { DbExecutor, QueryResult } from './db-executor.js';
-import { DomainEventBus, DomainEventHandler as DomainEventHandlerFn, addDomainEvent } from './domain-event-bus.js';
-import { IdentityMap } from './identity-map.js';
-import { RelationChangeProcessor } from './relation-change-processor.js';
-import { runInTransaction } from './transaction-runner.js';
-import { UnitOfWork } from './unit-of-work.js';
-import {
-  EntityStatus,
-  HasDomainEvents,
-  RelationChange,
-  RelationChangeEntry,
-  RelationKey,
-  TrackedEntity
-} from './runtime-types.js';
+import type { DbExecutor, QueryResult } from './db-executor.js';
+import { DomainEventBus, DomainEventHandler as DomainEventHandlerFn, addDomainEvent } from './domain-event-bus.js';
+import { IdentityMap } from './identity-map.js';
+import { RelationChangeProcessor } from './relation-change-processor.js';
+import { runInTransaction } from './transaction-runner.js';
+import { UnitOfWork } from './unit-of-work.js';
+import {
+  EntityStatus,
+  HasDomainEvents,
+  RelationChange,
+  RelationChangeEntry,
+  RelationKey,
+  TrackedEntity
+} from './runtime-types.js';
+import { createQueryLoggingExecutor, QueryLogger } from './query-logger.js';
 
 export interface OrmInterceptor {
   beforeFlush?(ctx: OrmContext): Promise<void> | void;
@@ -23,43 +24,46 @@ export interface OrmInterceptor {
 
 export type DomainEventHandler = DomainEventHandlerFn<OrmContext>;
 
-export interface OrmContextOptions {
-  dialect: Dialect;
-  executor: DbExecutor;
-  interceptors?: OrmInterceptor[];
-  domainEventHandlers?: Record<string, DomainEventHandler[]>;
-}
-
-export class OrmContext {
-  private readonly identityMap = new IdentityMap();
-  private readonly unitOfWork: UnitOfWork;
-  private readonly relationChanges: RelationChangeProcessor;
-  private readonly interceptors: OrmInterceptor[];
-  private readonly domainEvents: DomainEventBus<OrmContext>;
-
-  constructor(private readonly options: OrmContextOptions) {
-    this.interceptors = [...(options.interceptors ?? [])];
-    this.unitOfWork = new UnitOfWork(
-      options.dialect,
-      options.executor,
-      this.identityMap,
-      () => this
-    );
-    this.relationChanges = new RelationChangeProcessor(
-      this.unitOfWork,
-      options.dialect,
-      options.executor
-    );
-    this.domainEvents = new DomainEventBus<OrmContext>(options.domainEventHandlers);
-  }
+export interface OrmContextOptions {
+  dialect: Dialect;
+  executor: DbExecutor;
+  interceptors?: OrmInterceptor[];
+  domainEventHandlers?: Record<string, DomainEventHandler[]>;
+  queryLogger?: QueryLogger;
+}
+
+export class OrmContext {
+  private readonly identityMap = new IdentityMap();
+  private readonly executorWithLogging: DbExecutor;
+  private readonly unitOfWork: UnitOfWork;
+  private readonly relationChanges: RelationChangeProcessor;
+  private readonly interceptors: OrmInterceptor[];
+  private readonly domainEvents: DomainEventBus<OrmContext>;
+
+  constructor(private readonly options: OrmContextOptions) {
+    this.interceptors = [...(options.interceptors ?? [])];
+    this.executorWithLogging = createQueryLoggingExecutor(options.executor, options.queryLogger);
+    this.unitOfWork = new UnitOfWork(
+      options.dialect,
+      this.executorWithLogging,
+      this.identityMap,
+      () => this
+    );
+    this.relationChanges = new RelationChangeProcessor(
+      this.unitOfWork,
+      options.dialect,
+      this.executorWithLogging
+    );
+    this.domainEvents = new DomainEventBus<OrmContext>(options.domainEventHandlers);
+  }
 
   get dialect(): Dialect {
     return this.options.dialect;
   }
 
-  get executor(): DbExecutor {
-    return this.options.executor;
-  }
+  get executor(): DbExecutor {
+    return this.executorWithLogging;
+  }
 
   get identityBuckets(): Map<string, Map<string, TrackedEntity>> {
     return this.unitOfWork.identityBuckets;
@@ -143,12 +147,13 @@ export class OrmContext {
   }
 }
 
-export { addDomainEvent };
-export { EntityStatus };
-export type {
-  QueryResult,
-  DbExecutor,
-  RelationKey,
-  RelationChange,
-  HasDomainEvents
-};
+export { addDomainEvent };
+export { EntityStatus };
+export type {
+  QueryResult,
+  DbExecutor,
+  RelationKey,
+  RelationChange,
+  HasDomainEvents
+};
+export type { QueryLogEntry, QueryLogger } from './query-logger.js';

package/src/orm/query-logger.ts

@@ -0,0 +1,38 @@
+import type { DbExecutor } from './db-executor.js';
+
+export interface QueryLogEntry {
+  sql: string;
+  params?: unknown[];
+}
+
+export type QueryLogger = (entry: QueryLogEntry) => void;
+
+export const createQueryLoggingExecutor = (
+  executor: DbExecutor,
+  logger?: QueryLogger
+): DbExecutor => {
+  if (!logger) {
+    return executor;
+  }
+
+  const wrapped: DbExecutor = {
+    async executeSql(sql, params) {
+      logger({ sql, params });
+      return executor.executeSql(sql, params);
+    }
+  };
+
+  if (executor.beginTransaction) {
+    wrapped.beginTransaction = executor.beginTransaction.bind(executor);
+  }
+
+  if (executor.commitTransaction) {
+    wrapped.commitTransaction = executor.commitTransaction.bind(executor);
+  }
+
+  if (executor.rollbackTransaction) {
+    wrapped.rollbackTransaction = executor.rollbackTransaction.bind(executor);
+  }
+
+  return wrapped;
+};

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

@@ -4,15 +4,26 @@ import { BelongsToRelation } from '../../schema/relation.js';
 import { TableDef } from '../../schema/table.js';
 import { EntityMeta, getHydrationRecord, hasEntityMeta } from '../entity-meta.js';
 
-type Rows = Record<string, any>;
-
-const toKey = (value: unknown): string => (value === null || value === undefined ? '' : String(value));
-
-export class DefaultBelongsToReference<TParent> implements BelongsToReference<TParent> {
-  private loaded = false;
-  private current: TParent | null = null;
-
-  constructor(
+type Rows = Record<string, any>;
+
+const toKey = (value: unknown): string => (value === null || value === undefined ? '' : String(value));
+
+const hideInternal = (obj: any, keys: string[]): void => {
+  for (const key of keys) {
+    Object.defineProperty(obj, key, {
+      value: obj[key],
+      writable: false,
+      configurable: false,
+      enumerable: false
+    });
+  }
+};
+
+export class DefaultBelongsToReference<TParent> implements BelongsToReference<TParent> {
+  private loaded = false;
+  private current: TParent | null = null;
+
+  constructor(
     private readonly ctx: OrmContext,
     private readonly meta: EntityMeta<any>,
     private readonly root: any,
@@ -20,14 +31,15 @@ export class DefaultBelongsToReference<TParent> implements BelongsToReference<TP
     private readonly relation: BelongsToRelation,
     private readonly rootTable: TableDef,
     private readonly loader: () => Promise<Map<string, Rows>>,
-    private readonly createEntity: (row: Record<string, any>) => TParent,
-    private readonly targetKey: string
-  ) {
-    this.populateFromHydrationCache();
-  }
-
-  async load(): Promise<TParent | null> {
-    if (this.loaded) return this.current;
+    private readonly createEntity: (row: Record<string, any>) => TParent,
+    private readonly targetKey: string
+  ) {
+    hideInternal(this, ['ctx', 'meta', 'root', 'relationName', 'relation', 'rootTable', 'loader', 'createEntity', 'targetKey']);
+    this.populateFromHydrationCache();
+  }
+
+  async load(): Promise<TParent | null> {
+    if (this.loaded) return this.current;
     const map = await this.loader();
     const fkValue = this.root[this.relation.foreignKey];
     if (fkValue === null || fkValue === undefined) {
@@ -81,12 +93,16 @@ export class DefaultBelongsToReference<TParent> implements BelongsToReference<TP
     return `${this.rootTable.name}.${this.relationName}`;
   }
 
-  private populateFromHydrationCache(): void {
-    const fkValue = this.root[this.relation.foreignKey];
-    if (fkValue === undefined || fkValue === null) return;
-    const row = getHydrationRecord(this.meta, this.relationName, fkValue);
-    if (!row) return;
-    this.current = this.createEntity(row);
-    this.loaded = true;
-  }
-}
+  private populateFromHydrationCache(): void {
+    const fkValue = this.root[this.relation.foreignKey];
+    if (fkValue === undefined || fkValue === null) return;
+    const row = getHydrationRecord(this.meta, this.relationName, fkValue);
+    if (!row) return;
+    this.current = this.createEntity(row);
+    this.loaded = true;
+  }
+
+  toJSON(): TParent | null {
+    return this.current;
+  }
+}

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

@@ -4,15 +4,26 @@ import { HasManyRelation } from '../../schema/relation.js';
 import { TableDef } from '../../schema/table.js';
 import { EntityMeta, getHydrationRows } from '../entity-meta.js';
 
-type Rows = Record<string, any>[];
-
-const toKey = (value: unknown): string => (value === null || value === undefined ? '' : String(value));
-
-export class DefaultHasManyCollection<TChild> implements HasManyCollection<TChild> {
-  private loaded = false;
-  private items: TChild[] = [];
-  private readonly added = new Set<TChild>();
-  private readonly removed = new Set<TChild>();
+type Rows = Record<string, any>[];
+
+const toKey = (value: unknown): string => (value === null || value === undefined ? '' : String(value));
+
+const hideInternal = (obj: any, keys: string[]): void => {
+  for (const key of keys) {
+    Object.defineProperty(obj, key, {
+      value: obj[key],
+      writable: false,
+      configurable: false,
+      enumerable: false
+    });
+  }
+};
+
+export class DefaultHasManyCollection<TChild> implements HasManyCollection<TChild> {
+  private loaded = false;
+  private items: TChild[] = [];
+  private readonly added = new Set<TChild>();
+  private readonly removed = new Set<TChild>();
 
   constructor(
     private readonly ctx: OrmContext,
@@ -23,13 +34,14 @@ export class DefaultHasManyCollection<TChild> implements HasManyCollection<TChil
     private readonly rootTable: TableDef,
     private readonly loader: () => Promise<Map<string, Rows>>,
     private readonly createEntity: (row: Record<string, any>) => TChild,
-    private readonly localKey: string
-  ) {
-    this.hydrateFromCache();
-  }
-
-  async load(): Promise<TChild[]> {
-    if (this.loaded) return this.items;
+    private readonly localKey: string
+  ) {
+    hideInternal(this, ['ctx', 'meta', 'root', 'relationName', 'relation', 'rootTable', 'loader', 'createEntity', 'localKey']);
+    this.hydrateFromCache();
+  }
+
+  async load(): Promise<TChild[]> {
+    if (this.loaded) return this.items;
     const map = await this.loader();
     const key = toKey(this.root[this.localKey]);
     const rows = map.get(key) ?? [];
@@ -100,12 +112,16 @@ export class DefaultHasManyCollection<TChild> implements HasManyCollection<TChil
     return `${this.rootTable.name}.${this.relationName}`;
   }
 
-  private hydrateFromCache(): void {
-    const keyValue = this.root[this.localKey];
-    if (keyValue === undefined || keyValue === null) return;
-    const rows = getHydrationRows(this.meta, this.relationName, keyValue);
-    if (!rows?.length) return;
-    this.items = rows.map(row => this.createEntity(row));
-    this.loaded = true;
-  }
-}
+  private hydrateFromCache(): void {
+    const keyValue = this.root[this.localKey];
+    if (keyValue === undefined || keyValue === null) return;
+    const rows = getHydrationRows(this.meta, this.relationName, keyValue);
+    if (!rows?.length) return;
+    this.items = rows.map(row => this.createEntity(row));
+    this.loaded = true;
+  }
+
+  toJSON(): TChild[] {
+    return this.items;
+  }
+}

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

@@ -5,15 +5,26 @@ import { TableDef } from '../../schema/table.js';
 import { findPrimaryKey } from '../../query-builder/hydration-planner.js';
 import { EntityMeta, getHydrationRows } from '../entity-meta.js';
 
-type Rows = Record<string, any>[];
-
-const toKey = (value: unknown): string => (value === null || value === undefined ? '' : String(value));
-
-export class DefaultManyToManyCollection<TTarget> implements ManyToManyCollection<TTarget> {
-  private loaded = false;
-  private items: TTarget[] = [];
-
-  constructor(
+type Rows = Record<string, any>[];
+
+const toKey = (value: unknown): string => (value === null || value === undefined ? '' : String(value));
+
+const hideInternal = (obj: any, keys: string[]): void => {
+  for (const key of keys) {
+    Object.defineProperty(obj, key, {
+      value: obj[key],
+      writable: false,
+      configurable: false,
+      enumerable: false
+    });
+  }
+};
+
+export class DefaultManyToManyCollection<TTarget> implements ManyToManyCollection<TTarget> {
+  private loaded = false;
+  private items: TTarget[] = [];
+
+  constructor(
     private readonly ctx: OrmContext,
     private readonly meta: EntityMeta<any>,
     private readonly root: any,
@@ -21,14 +32,15 @@ export class DefaultManyToManyCollection<TTarget> implements ManyToManyCollectio
     private readonly relation: BelongsToManyRelation,
     private readonly rootTable: TableDef,
     private readonly loader: () => Promise<Map<string, Rows>>,
-    private readonly createEntity: (row: Record<string, any>) => TTarget,
-    private readonly localKey: string
-  ) {
-    this.hydrateFromCache();
-  }
-
-  async load(): Promise<TTarget[]> {
-    if (this.loaded) return this.items;
+    private readonly createEntity: (row: Record<string, any>) => TTarget,
+    private readonly localKey: string
+  ) {
+    hideInternal(this, ['ctx', 'meta', 'root', 'relationName', 'relation', 'rootTable', 'loader', 'createEntity', 'localKey']);
+    this.hydrateFromCache();
+  }
+
+  async load(): Promise<TTarget[]> {
+    if (this.loaded) return this.items;
     const map = await this.loader();
     const key = toKey(this.root[this.localKey]);
     const rows = map.get(key) ?? [];
@@ -132,18 +144,22 @@ export class DefaultManyToManyCollection<TTarget> implements ManyToManyCollectio
     return this.relation.targetKey || findPrimaryKey(this.relation.target);
   }
 
-  private hydrateFromCache(): void {
-    const keyValue = this.root[this.localKey];
-    if (keyValue === undefined || keyValue === null) return;
-    const rows = getHydrationRows(this.meta, this.relationName, keyValue);
-    if (!rows?.length) return;
+  private hydrateFromCache(): void {
+    const keyValue = this.root[this.localKey];
+    if (keyValue === undefined || keyValue === null) return;
+    const rows = getHydrationRows(this.meta, this.relationName, keyValue);
+    if (!rows?.length) return;
     this.items = rows.map(row => {
       const entity = this.createEntity(row);
       if ((row as any)._pivot) {
         (entity as any)._pivot = (row as any)._pivot;
       }
-      return entity;
-    });
-    this.loaded = true;
-  }
-}
+      return entity;
+    });
+    this.loaded = true;
+  }
+
+  toJSON(): TTarget[] {
+    return this.items;
+  }
+}

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

@@ -1,11 +1,11 @@
-import { eq } from '../core/ast/expression.js';
-import type { Dialect, CompiledQuery } from '../core/dialect/abstract.js';
+import { ColumnNode, eq } 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';
 import { DeleteQueryBuilder } from '../query-builder/delete.js';
 import { findPrimaryKey } from '../query-builder/hydration-planner.js';
 import type { TableDef, TableHooks } from '../schema/table.js';
-import type { DbExecutor } from './db-executor.js';
+import type { DbExecutor, QueryResult } from './db-executor.js';
 import { IdentityMap } from './identity-map.js';
 import { EntityStatus } from './runtime-types.js';
 import type { TrackedEntity } from './runtime-types.js';
@@ -120,10 +120,14 @@ 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);
-    const builder = new InsertQueryBuilder(tracked.table).values(payload);
-    const compiled = builder.compile(this.dialect);
-    await this.executeCompiled(compiled);
+    const payload = this.extractColumns(tracked.table, tracked.entity);
+    let builder = new InsertQueryBuilder(tracked.table).values(payload);
+    if (this.dialect.supportsReturning()) {
+      builder = builder.returning(...this.getReturningColumns(tracked.table));
+    }
+    const compiled = builder.compile(this.dialect);
+    const results = await this.executeCompiled(compiled);
+    this.applyReturningResults(tracked, results);
 
     tracked.status = EntityStatus.Managed;
     tracked.original = this.createSnapshot(tracked.table, tracked.entity);
@@ -146,12 +150,17 @@ export class UnitOfWork {
     const pkColumn = tracked.table.columns[findPrimaryKey(tracked.table)];
     if (!pkColumn) return;
 
-    const builder = new UpdateQueryBuilder(tracked.table)
-      .set(changes)
-      .where(eq(pkColumn, tracked.pk));
-
-    const compiled = builder.compile(this.dialect);
-    await this.executeCompiled(compiled);
+    let builder = new UpdateQueryBuilder(tracked.table)
+      .set(changes)
+      .where(eq(pkColumn, tracked.pk));
+
+    if (this.dialect.supportsReturning()) {
+      builder = builder.returning(...this.getReturningColumns(tracked.table));
+    }
+
+    const compiled = builder.compile(this.dialect);
+    const results = await this.executeCompiled(compiled);
+    this.applyReturningResults(tracked, results);
 
     tracked.status = EntityStatus.Managed;
     tracked.original = this.createSnapshot(tracked.table, tracked.entity);
@@ -206,16 +215,44 @@ export class UnitOfWork {
     return payload;
   }
 
-  private async executeCompiled(compiled: CompiledQuery): Promise<void> {
-    await this.executor.executeSql(compiled.sql, compiled.params);
-  }
-
-  private registerIdentity(tracked: TrackedEntity): void {
-    if (tracked.pk == null) return;
-    this.identityMap.register(tracked);
-  }
-
-  private createSnapshot(table: TableDef, entity: any): Record<string, any> {
+  private async executeCompiled(compiled: CompiledQuery): Promise<QueryResult[]> {
+    return this.executor.executeSql(compiled.sql, compiled.params);
+  }
+
+  private getReturningColumns(table: TableDef): ColumnNode[] {
+    return Object.values(table.columns).map(column => ({
+      type: 'Column',
+      table: table.name,
+      name: column.name,
+      alias: column.name
+    }));
+  }
+
+  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 normalizeColumnName(column: string): string {
+    const parts = column.split('.');
+    const candidate = parts[parts.length - 1];
+    return candidate.replace(/^["`[\]]+|["`[\]]+$/g, '');
+  }
+
+  private registerIdentity(tracked: TrackedEntity): void {
+    if (tracked.pk == null) return;
+    this.identityMap.register(tracked);
+  }
+
+  private createSnapshot(table: TableDef, entity: any): Record<string, any> {
     const snapshot: Record<string, any> = {};
     for (const column of Object.keys(table.columns)) {
       snapshot[column] = entity[column];