@mikro-orm/sql 7.0.14 → 7.0.15-dev.0

package/query/ArrayCriteriaNode.d.ts

@@ -4,8 +4,8 @@ import type { IQueryBuilder, ICriteriaNodeProcessOptions } from '../typings.js';
  * @internal
  */
 export declare class ArrayCriteriaNode<T extends object> extends CriteriaNode<T> {
-  process(qb: IQueryBuilder<T>, options?: ICriteriaNodeProcessOptions): any;
-  unwrap(): any;
-  willAutoJoin(qb: IQueryBuilder<T>, alias?: string, options?: ICriteriaNodeProcessOptions): boolean;
-  isStrict(): boolean;
+    process(qb: IQueryBuilder<T>, options?: ICriteriaNodeProcessOptions): any;
+    unwrap(): any;
+    willAutoJoin(qb: IQueryBuilder<T>, alias?: string, options?: ICriteriaNodeProcessOptions): boolean;
+    isStrict(): boolean;
 }

package/query/ArrayCriteriaNode.js

@@ -3,22 +3,22 @@ import { CriteriaNode } from './CriteriaNode.js';
  * @internal
  */
 export class ArrayCriteriaNode extends CriteriaNode {
-  process(qb, options) {
-    return this.payload.map(node => {
-      return node.process(qb, options);
-    });
-  }
-  unwrap() {
-    return this.payload.map(node => {
-      return node.unwrap();
-    });
-  }
-  willAutoJoin(qb, alias, options) {
-    return this.payload.some(node => {
-      return node.willAutoJoin(qb, alias, options);
-    });
-  }
-  isStrict() {
-    return this.strict || this.payload.some(node => node.isStrict());
-  }
+    process(qb, options) {
+        return this.payload.map((node) => {
+            return node.process(qb, options);
+        });
+    }
+    unwrap() {
+        return this.payload.map((node) => {
+            return node.unwrap();
+        });
+    }
+    willAutoJoin(qb, alias, options) {
+        return this.payload.some((node) => {
+            return node.willAutoJoin(qb, alias, options);
+        });
+    }
+    isStrict() {
+        return this.strict || this.payload.some((node) => node.isStrict());
+    }
 }

package/query/CriteriaNode.d.ts

@@ -1,10 +1,4 @@
-import {
-  type EntityKey,
-  type EntityProperty,
-  type MetadataStorage,
-  type RawQueryFragmentSymbol,
-  type EntityName,
-} from '@mikro-orm/core';
+import { type EntityKey, type EntityProperty, type MetadataStorage, type RawQueryFragmentSymbol, type EntityName } from '@mikro-orm/core';
 import type { ICriteriaNode, ICriteriaNodeProcessOptions, IQueryBuilder } from '../typings.js';
 /**
  * Helper for working with deeply nested where/orderBy/having criteria. Uses composite pattern to build tree from the payload.
@@ -12,32 +6,28 @@ import type { ICriteriaNode, ICriteriaNodeProcessOptions, IQueryBuilder } from '
  * @internal
  */
 export declare class CriteriaNode<T extends object> implements ICriteriaNode<T> {
-  protected readonly metadata: MetadataStorage;
-  readonly entityName: EntityName<T>;
-  readonly parent?: ICriteriaNode<T> | undefined;
-  readonly key?: (EntityKey<T> | RawQueryFragmentSymbol) | undefined;
-  readonly validate: boolean;
-  readonly strict: boolean;
-  payload: any;
-  prop?: EntityProperty<T>;
-  index?: number;
-  constructor(
-    metadata: MetadataStorage,
-    entityName: EntityName<T>,
-    parent?: ICriteriaNode<T> | undefined,
-    key?: (EntityKey<T> | RawQueryFragmentSymbol) | undefined,
-    validate?: boolean,
-    strict?: boolean,
-  );
-  process(qb: IQueryBuilder<T>, options?: ICriteriaNodeProcessOptions): any;
-  unwrap(): any;
-  shouldInline(payload: any): boolean;
-  willAutoJoin(qb: IQueryBuilder<T>, alias?: string, options?: ICriteriaNodeProcessOptions): boolean;
-  shouldRename(payload: any): boolean;
-  renameFieldToPK<T>(qb: IQueryBuilder<T>, ownerAlias?: string, options?: ICriteriaNodeProcessOptions): string;
-  getPath(opts?: { addIndex?: boolean; parentPath?: string }): string;
-  private isPivotJoin;
-  getPivotPath(path: string): string;
-  aliased(field: string, alias?: string): string;
-  isStrict(): boolean;
+    protected readonly metadata: MetadataStorage;
+    readonly entityName: EntityName<T>;
+    readonly parent?: ICriteriaNode<T> | undefined;
+    readonly key?: (EntityKey<T> | RawQueryFragmentSymbol) | undefined;
+    readonly validate: boolean;
+    readonly strict: boolean;
+    payload: any;
+    prop?: EntityProperty<T>;
+    index?: number;
+    constructor(metadata: MetadataStorage, entityName: EntityName<T>, parent?: ICriteriaNode<T> | undefined, key?: (EntityKey<T> | RawQueryFragmentSymbol) | undefined, validate?: boolean, strict?: boolean);
+    process(qb: IQueryBuilder<T>, options?: ICriteriaNodeProcessOptions): any;
+    unwrap(): any;
+    shouldInline(payload: any): boolean;
+    willAutoJoin(qb: IQueryBuilder<T>, alias?: string, options?: ICriteriaNodeProcessOptions): boolean;
+    shouldRename(payload: any): boolean;
+    renameFieldToPK<T>(qb: IQueryBuilder<T>, ownerAlias?: string, options?: ICriteriaNodeProcessOptions): string;
+    getPath(opts?: {
+        addIndex?: boolean;
+        parentPath?: string;
+    }): string;
+    private isPivotJoin;
+    getPivotPath(path: string): string;
+    aliased(field: string, alias?: string): string;
+    isStrict(): boolean;
 }

package/query/CriteriaNode.js

@@ -1,159 +1,149 @@
-import { RawQueryFragment, ReferenceKind, Utils, inspect } from '@mikro-orm/core';
+import { RawQueryFragment, ReferenceKind, Utils, inspect, } from '@mikro-orm/core';
 /**
  * Helper for working with deeply nested where/orderBy/having criteria. Uses composite pattern to build tree from the payload.
  * Auto-joins relations and converts payload from { books: { publisher: { name: '...' } } } to { 'publisher_alias.name': '...' }
  * @internal
  */
 export class CriteriaNode {
-  metadata;
-  entityName;
-  parent;
-  key;
-  validate;
-  strict;
-  payload;
-  prop;
-  index;
-  constructor(metadata, entityName, parent, key, validate = true, strict = false) {
-    this.metadata = metadata;
-    this.entityName = entityName;
-    this.parent = parent;
-    this.key = key;
-    this.validate = validate;
-    this.strict = strict;
-    const meta = parent && metadata.find(parent.entityName);
-    if (meta && key && !RawQueryFragment.isKnownFragmentSymbol(key)) {
-      const pks = Utils.splitPrimaryKeys(key);
-      if (pks.length > 1) {
-        return;
-      }
-      for (const k of pks) {
-        this.prop = meta.props.find(
-          prop =>
-            prop.name === k || (prop.fieldNames?.length === 1 && prop.fieldNames[0] === k && prop.persist !== false),
-        );
-        const isProp = this.prop || meta.props.find(prop => (prop.fieldNames || []).includes(k));
-        // do not validate if the key is prefixed or type casted (e.g. `k::text`)
-        if (validate && !isProp && !k.includes('.') && !k.includes('::') && !Utils.isOperator(k)) {
-          throw new Error(`Trying to query by not existing property ${Utils.className(entityName)}.${k}`);
+    metadata;
+    entityName;
+    parent;
+    key;
+    validate;
+    strict;
+    payload;
+    prop;
+    index;
+    constructor(metadata, entityName, parent, key, validate = true, strict = false) {
+        this.metadata = metadata;
+        this.entityName = entityName;
+        this.parent = parent;
+        this.key = key;
+        this.validate = validate;
+        this.strict = strict;
+        const meta = parent && metadata.find(parent.entityName);
+        if (meta && key && !RawQueryFragment.isKnownFragmentSymbol(key)) {
+            const pks = Utils.splitPrimaryKeys(key);
+            if (pks.length > 1) {
+                return;
+            }
+            for (const k of pks) {
+                this.prop = meta.props.find(prop => prop.name === k || (prop.fieldNames?.length === 1 && prop.fieldNames[0] === k && prop.persist !== false));
+                const isProp = this.prop || meta.props.find(prop => (prop.fieldNames || []).includes(k));
+                // do not validate if the key is prefixed or type casted (e.g. `k::text`)
+                if (validate && !isProp && !k.includes('.') && !k.includes('::') && !Utils.isOperator(k)) {
+                    throw new Error(`Trying to query by not existing property ${Utils.className(entityName)}.${k}`);
+                }
+            }
         }
-      }
     }
-  }
-  process(qb, options) {
-    return this.payload;
-  }
-  unwrap() {
-    return this.payload;
-  }
-  shouldInline(payload) {
-    return false;
-  }
-  willAutoJoin(qb, alias, options) {
-    return false;
-  }
-  shouldRename(payload) {
-    const type = this.prop ? this.prop.kind : null;
-    // Polymorphic relations have a composite column set (discriminator + FK), but we only
-    // need tuple-renaming when the payload is itself a tuple (entity ref expanded by
-    // `convertCompositeEntityRefs`) or an array-valued operator like `$in`. Scalar payloads
-    // such as `null` or `{ $ne: null }` keep single-column semantics against `fieldNames[0]`.
-    const polymorphicComposite =
-      !!this.prop?.polymorphic &&
-      (this.prop.fieldNames?.length ?? 0) > 1 &&
-      (Array.isArray(payload) || (Utils.isPlainObject(payload) && Object.values(payload).some(v => Array.isArray(v))));
-    const composite = polymorphicComposite || (this.prop?.joinColumns ? this.prop.joinColumns.length > 1 : false);
-    const rawField = RawQueryFragment.isKnownFragmentSymbol(this.key);
-    const scalar =
-      payload === null ||
-      Utils.isPrimaryKey(payload) ||
-      payload instanceof RegExp ||
-      payload instanceof Date ||
-      rawField;
-    const operator =
-      Utils.isPlainObject(payload) && Utils.getObjectQueryKeys(payload).every(k => Utils.isOperator(k, false));
-    if (composite) {
-      return true;
+    process(qb, options) {
+        return this.payload;
     }
-    switch (type) {
-      case ReferenceKind.MANY_TO_ONE:
+    unwrap() {
+        return this.payload;
+    }
+    shouldInline(payload) {
         return false;
-      case ReferenceKind.ONE_TO_ONE:
-        return !this.prop.owner;
-      case ReferenceKind.ONE_TO_MANY:
-        return scalar || operator;
-      case ReferenceKind.MANY_TO_MANY:
-        return scalar || operator;
-      default:
+    }
+    willAutoJoin(qb, alias, options) {
         return false;
     }
-  }
-  renameFieldToPK(qb, ownerAlias, options) {
-    const joinAlias = qb.getAliasForJoinPath(this.getPath(), { ...options, matchPopulateJoins: true });
-    if (
-      !joinAlias &&
-      this.parent &&
-      [ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(this.prop.kind) &&
-      this.prop.owner
-    ) {
-      const alias = qb.getAliasForJoinPath(this.parent.getPath()) ?? ownerAlias ?? qb.alias;
-      const columns = this.prop.polymorphic ? this.prop.fieldNames : this.prop.joinColumns;
-      return Utils.getPrimaryKeyHash(columns.map(col => `${alias}.${col}`));
+    shouldRename(payload) {
+        const type = this.prop ? this.prop.kind : null;
+        // Polymorphic relations have a composite column set (discriminator + FK), but we only
+        // need tuple-renaming when the payload is itself a tuple (entity ref expanded by
+        // `convertCompositeEntityRefs`) or an array-valued operator like `$in`. Scalar payloads
+        // such as `null` or `{ $ne: null }` keep single-column semantics against `fieldNames[0]`.
+        const polymorphicComposite = !!this.prop?.polymorphic &&
+            (this.prop.fieldNames?.length ?? 0) > 1 &&
+            (Array.isArray(payload) ||
+                (Utils.isPlainObject(payload) && Object.values(payload).some(v => Array.isArray(v))));
+        const composite = polymorphicComposite || (this.prop?.joinColumns ? this.prop.joinColumns.length > 1 : false);
+        const rawField = RawQueryFragment.isKnownFragmentSymbol(this.key);
+        const scalar = payload === null ||
+            Utils.isPrimaryKey(payload) ||
+            payload instanceof RegExp ||
+            payload instanceof Date ||
+            rawField;
+        const operator = Utils.isPlainObject(payload) && Utils.getObjectQueryKeys(payload).every(k => Utils.isOperator(k, false));
+        if (composite) {
+            return true;
+        }
+        switch (type) {
+            case ReferenceKind.MANY_TO_ONE:
+                return false;
+            case ReferenceKind.ONE_TO_ONE:
+                return !this.prop.owner;
+            case ReferenceKind.ONE_TO_MANY:
+                return scalar || operator;
+            case ReferenceKind.MANY_TO_MANY:
+                return scalar || operator;
+            default:
+                return false;
+        }
+    }
+    renameFieldToPK(qb, ownerAlias, options) {
+        const joinAlias = qb.getAliasForJoinPath(this.getPath(), { ...options, matchPopulateJoins: true });
+        if (!joinAlias &&
+            this.parent &&
+            [ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(this.prop.kind) &&
+            this.prop.owner) {
+            const alias = qb.getAliasForJoinPath(this.parent.getPath()) ?? ownerAlias ?? qb.alias;
+            const columns = this.prop.polymorphic ? this.prop.fieldNames : this.prop.joinColumns;
+            return Utils.getPrimaryKeyHash(columns.map(col => `${alias}.${col}`));
+        }
+        const alias = joinAlias ?? ownerAlias ?? qb.alias;
+        if (this.prop.kind === ReferenceKind.MANY_TO_MANY) {
+            return Utils.getPrimaryKeyHash(this.prop.inverseJoinColumns.map(col => `${alias}.${col}`));
+        }
+        return Utils.getPrimaryKeyHash(this.prop.referencedColumnNames.map(col => `${alias}.${col}`));
+    }
+    getPath(opts) {
+        // use index on parent only if we are processing to-many relation
+        const addParentIndex = this.prop && [ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(this.prop.kind);
+        const parentPath = opts?.parentPath ?? this.parent?.getPath({ addIndex: addParentIndex }) ?? Utils.className(this.entityName);
+        const index = opts?.addIndex && this.index != null ? `[${this.index}]` : '';
+        // ignore group operators to allow easier mapping (e.g. for orderBy)
+        const key = this.key && !RawQueryFragment.isKnownFragmentSymbol(this.key) && !['$and', '$or', '$not'].includes(this.key)
+            ? '.' + this.key
+            : '';
+        const ret = parentPath + index + key;
+        if (this.isPivotJoin()) {
+            // distinguish pivot table join from target entity join
+            return this.getPivotPath(ret);
+        }
+        return ret;
+    }
+    isPivotJoin() {
+        if (!this.key || !this.prop) {
+            return false;
+        }
+        const rawField = RawQueryFragment.isKnownFragmentSymbol(this.key);
+        const scalar = this.payload === null ||
+            Utils.isPrimaryKey(this.payload) ||
+            this.payload instanceof RegExp ||
+            this.payload instanceof Date ||
+            rawField;
+        const operator = Utils.isObject(this.payload) && Utils.getObjectQueryKeys(this.payload).every(k => Utils.isOperator(k, false));
+        return this.prop.kind === ReferenceKind.MANY_TO_MANY && (scalar || operator);
+    }
+    getPivotPath(path) {
+        return `${path}[pivot]`;
     }
-    const alias = joinAlias ?? ownerAlias ?? qb.alias;
-    if (this.prop.kind === ReferenceKind.MANY_TO_MANY) {
-      return Utils.getPrimaryKeyHash(this.prop.inverseJoinColumns.map(col => `${alias}.${col}`));
+    aliased(field, alias) {
+        return alias ? `${alias}.${field}` : field;
     }
-    return Utils.getPrimaryKeyHash(this.prop.referencedColumnNames.map(col => `${alias}.${col}`));
-  }
-  getPath(opts) {
-    // use index on parent only if we are processing to-many relation
-    const addParentIndex =
-      this.prop && [ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(this.prop.kind);
-    const parentPath =
-      opts?.parentPath ?? this.parent?.getPath({ addIndex: addParentIndex }) ?? Utils.className(this.entityName);
-    const index = opts?.addIndex && this.index != null ? `[${this.index}]` : '';
-    // ignore group operators to allow easier mapping (e.g. for orderBy)
-    const key =
-      this.key && !RawQueryFragment.isKnownFragmentSymbol(this.key) && !['$and', '$or', '$not'].includes(this.key)
-        ? '.' + this.key
-        : '';
-    const ret = parentPath + index + key;
-    if (this.isPivotJoin()) {
-      // distinguish pivot table join from target entity join
-      return this.getPivotPath(ret);
+    isStrict() {
+        return this.strict;
     }
-    return ret;
-  }
-  isPivotJoin() {
-    if (!this.key || !this.prop) {
-      return false;
+    /** @ignore */
+    /* v8 ignore next */
+    [Symbol.for('nodejs.util.inspect.custom')]() {
+        const o = {};
+        ['entityName', 'key', 'index', 'payload']
+            .filter(k => this[k] !== undefined)
+            .forEach(k => (o[k] = this[k]));
+        return `${this.constructor.name} ${inspect(o)}`;
     }
-    const rawField = RawQueryFragment.isKnownFragmentSymbol(this.key);
-    const scalar =
-      this.payload === null ||
-      Utils.isPrimaryKey(this.payload) ||
-      this.payload instanceof RegExp ||
-      this.payload instanceof Date ||
-      rawField;
-    const operator =
-      Utils.isObject(this.payload) && Utils.getObjectQueryKeys(this.payload).every(k => Utils.isOperator(k, false));
-    return this.prop.kind === ReferenceKind.MANY_TO_MANY && (scalar || operator);
-  }
-  getPivotPath(path) {
-    return `${path}[pivot]`;
-  }
-  aliased(field, alias) {
-    return alias ? `${alias}.${field}` : field;
-  }
-  isStrict() {
-    return this.strict;
-  }
-  /** @ignore */
-  /* v8 ignore next */
-  [Symbol.for('nodejs.util.inspect.custom')]() {
-    const o = {};
-    ['entityName', 'key', 'index', 'payload'].filter(k => this[k] !== undefined).forEach(k => (o[k] = this[k]));
-    return `${this.constructor.name} ${inspect(o)}`;
-  }
 }

package/query/CriteriaNodeFactory.d.ts

@@ -1,55 +1,12 @@
-import {
-  type Dictionary,
-  type EntityKey,
-  type EntityMetadata,
-  type EntityName,
-  type MetadataStorage,
-  type RawQueryFragmentSymbol,
-} from '@mikro-orm/core';
+import { type Dictionary, type EntityKey, type EntityMetadata, type EntityName, type MetadataStorage, type RawQueryFragmentSymbol } from '@mikro-orm/core';
 import type { ICriteriaNode } from '../typings.js';
 /**
  * @internal
  */
 export declare class CriteriaNodeFactory {
-  static createNode<T extends object>(
-    metadata: MetadataStorage,
-    entityName: EntityName<T>,
-    payload: any,
-    parent?: ICriteriaNode<T>,
-    key?: EntityKey<T> | RawQueryFragmentSymbol,
-    validate?: boolean,
-  ): ICriteriaNode<T>;
-  static createScalarNode<T extends object>(
-    metadata: MetadataStorage,
-    entityName: EntityName<T>,
-    payload: any,
-    parent?: ICriteriaNode<T>,
-    key?: EntityKey<T> | RawQueryFragmentSymbol,
-    validate?: boolean,
-  ): ICriteriaNode<T>;
-  static createArrayNode<T extends object>(
-    metadata: MetadataStorage,
-    entityName: EntityName<T>,
-    payload: any[],
-    parent?: ICriteriaNode<T>,
-    key?: EntityKey<T>,
-    validate?: boolean,
-  ): ICriteriaNode<T>;
-  static createObjectNode<T extends object>(
-    metadata: MetadataStorage,
-    entityName: EntityName<T>,
-    payload: Dictionary,
-    parent?: ICriteriaNode<T>,
-    key?: EntityKey<T>,
-    validate?: boolean,
-  ): ICriteriaNode<T>;
-  static createObjectItemNode<T extends object>(
-    metadata: MetadataStorage,
-    entityName: EntityName<T>,
-    node: ICriteriaNode<T>,
-    payload: Dictionary,
-    key: EntityKey<T> | RawQueryFragmentSymbol,
-    meta?: EntityMetadata<T>,
-    validate?: boolean,
-  ): ICriteriaNode<T>;
+    static createNode<T extends object>(metadata: MetadataStorage, entityName: EntityName<T>, payload: any, parent?: ICriteriaNode<T>, key?: EntityKey<T> | RawQueryFragmentSymbol, validate?: boolean): ICriteriaNode<T>;
+    static createScalarNode<T extends object>(metadata: MetadataStorage, entityName: EntityName<T>, payload: any, parent?: ICriteriaNode<T>, key?: EntityKey<T> | RawQueryFragmentSymbol, validate?: boolean): ICriteriaNode<T>;
+    static createArrayNode<T extends object>(metadata: MetadataStorage, entityName: EntityName<T>, payload: any[], parent?: ICriteriaNode<T>, key?: EntityKey<T>, validate?: boolean): ICriteriaNode<T>;
+    static createObjectNode<T extends object>(metadata: MetadataStorage, entityName: EntityName<T>, payload: Dictionary, parent?: ICriteriaNode<T>, key?: EntityKey<T>, validate?: boolean): ICriteriaNode<T>;
+    static createObjectItemNode<T extends object>(metadata: MetadataStorage, entityName: EntityName<T>, node: ICriteriaNode<T>, payload: Dictionary, key: EntityKey<T> | RawQueryFragmentSymbol, meta?: EntityMetadata<T>, validate?: boolean): ICriteriaNode<T>;
 }