@mikro-orm/sql 7.0.0-dev.335 → 7.0.0-dev.336

package/AbstractSqlPlatform.d.ts

@@ -26,6 +26,12 @@ export declare abstract class AbstractSqlPlatform extends Platform {
     quoteValue(value: any): string;
     getSearchJsonPropertySQL(path: string, type: string, aliased: boolean): string | RawQueryFragment;
     getSearchJsonPropertyKey(path: string[], type: string, aliased: boolean, value?: unknown): string | RawQueryFragment;
+    /**
+     * Quotes a key for use inside a JSON path expression (e.g. `$.key`).
+     * Simple alphanumeric keys are left unquoted; others are wrapped in double quotes.
+     * @internal
+     */
+    quoteJsonKey(key: string): string;
     getJsonIndexDefinition(index: IndexDef): string[];
     supportsUnionWhere(): boolean;
     supportsSchemas(): boolean;
@@ -42,6 +48,25 @@ export declare abstract class AbstractSqlPlatform extends Platform {
     quoteCollation(collation: string): string;
     /** @internal */
     protected validateCollationName(collation: string): void;
+    /**
+     * Returns FROM clause for JSON array iteration.
+     * @internal
+     */
+    getJsonArrayFromSQL(column: string, alias: string, _properties: {
+        name: string;
+        type: string;
+    }[]): string;
+    /**
+     * Returns SQL expression to access an element's property within a JSON array iteration.
+     * @internal
+     */
+    getJsonArrayElementPropertySQL(alias: string, property: string, _type: string): string;
+    /**
+     * Wraps JSON array FROM clause and WHERE condition into a full EXISTS condition.
+     * MySQL overrides this because `json_table` doesn't support correlated subqueries.
+     * @internal
+     */
+    getJsonArrayExistsSQL(from: string, where: string): string;
     /**
      * Maps a runtime type name (e.g. 'string', 'number') to a driver-specific bind type constant.
      * Used by NativeQueryBuilder for output bindings.

package/AbstractSqlPlatform.js

@@ -64,11 +64,18 @@ export class AbstractSqlPlatform extends Platform {
     }
     getSearchJsonPropertyKey(path, type, aliased, value) {
         const [a, ...b] = path;
-        const quoteKey = (key) => (/^[a-z]\w*$/i.exec(key) ? key : `"${key}"`);
         if (aliased) {
-            return raw(alias => `json_extract(${this.quoteIdentifier(`${alias}.${a}`)}, '$.${b.map(quoteKey).join('.')}')`);
+            return raw(alias => `json_extract(${this.quoteIdentifier(`${alias}.${a}`)}, '$.${b.map(this.quoteJsonKey).join('.')}')`);
         }
-        return raw(`json_extract(${this.quoteIdentifier(a)}, '$.${b.map(quoteKey).join('.')}')`);
+        return raw(`json_extract(${this.quoteIdentifier(a)}, '$.${b.map(this.quoteJsonKey).join('.')}')`);
+    }
+    /**
+     * Quotes a key for use inside a JSON path expression (e.g. `$.key`).
+     * Simple alphanumeric keys are left unquoted; others are wrapped in double quotes.
+     * @internal
+     */
+    quoteJsonKey(key) {
+        return /^[a-z]\w*$/i.exec(key) ? key : `"${key}"`;
     }
     getJsonIndexDefinition(index) {
         return index.columnNames.map(column => {
@@ -116,6 +123,28 @@ export class AbstractSqlPlatform extends Platform {
             throw new Error(`Invalid collation name: '${collation}'. Collation names must contain only word characters.`);
         }
     }
+    /**
+     * Returns FROM clause for JSON array iteration.
+     * @internal
+     */
+    getJsonArrayFromSQL(column, alias, _properties) {
+        return `json_each(${column}) as ${this.quoteIdentifier(alias)}`;
+    }
+    /**
+     * Returns SQL expression to access an element's property within a JSON array iteration.
+     * @internal
+     */
+    getJsonArrayElementPropertySQL(alias, property, _type) {
+        return `${this.quoteIdentifier(alias)}.${this.quoteIdentifier(property)}`;
+    }
+    /**
+     * Wraps JSON array FROM clause and WHERE condition into a full EXISTS condition.
+     * MySQL overrides this because `json_table` doesn't support correlated subqueries.
+     * @internal
+     */
+    getJsonArrayExistsSQL(from, where) {
+        return `exists (select 1 from ${from} where ${where})`;
+    }
     /**
      * Maps a runtime type name (e.g. 'string', 'number') to a driver-specific bind type constant.
      * Used by NativeQueryBuilder for output bindings.

package/dialects/mysql/BaseMySqlPlatform.d.ts

@@ -5,6 +5,7 @@ import { AbstractSqlPlatform } from '../../AbstractSqlPlatform.js';
 import type { IndexDef } from '../../typings.js';
 import { MySqlNativeQueryBuilder } from './MySqlNativeQueryBuilder.js';
 export declare class BaseMySqlPlatform extends AbstractSqlPlatform {
+    #private;
     protected readonly schemaHelper: MySqlSchemaHelper;
     protected readonly exceptionConverter: MySqlExceptionConverter;
     protected readonly ORDER_BY_NULLS_TRANSLATE: {
@@ -42,5 +43,10 @@ export declare class BaseMySqlPlatform extends AbstractSqlPlatform {
     getFullTextWhereClause(): string;
     getFullTextIndexExpression(indexName: string, schemaName: string | undefined, tableName: string, columns: SimpleColumnMeta[]): string;
     getOrderByExpression(column: string, direction: string, collation?: string): string[];
+    getJsonArrayFromSQL(column: string, alias: string, properties: {
+        name: string;
+        type: string;
+    }[]): string;
+    getJsonArrayExistsSQL(from: string, where: string): string;
     getDefaultClientUrl(): string;
 }

package/dialects/mysql/BaseMySqlPlatform.js

@@ -6,6 +6,12 @@ import { MySqlNativeQueryBuilder } from './MySqlNativeQueryBuilder.js';
 export class BaseMySqlPlatform extends AbstractSqlPlatform {
     schemaHelper = new MySqlSchemaHelper(this);
     exceptionConverter = new MySqlExceptionConverter();
+    #jsonTypeCasts = {
+        string: 'text',
+        number: 'double',
+        bigint: 'bigint',
+        boolean: 'unsigned',
+    };
     ORDER_BY_NULLS_TRANSLATE = {
         [QueryOrder.asc_nulls_first]: 'is not null',
         [QueryOrder.asc_nulls_last]: 'is null',
@@ -114,6 +120,17 @@ export class BaseMySqlPlatform extends AbstractSqlPlatform {
         ret.push(`${col} ${dir.replace(/(\s|nulls|first|last)*/gi, '')}`);
         return ret;
     }
+    getJsonArrayFromSQL(column, alias, properties) {
+        const columns = properties
+            .map(p => `${this.quoteIdentifier(p.name)} ${this.#jsonTypeCasts[p.type] ?? 'text'} path '$.${this.quoteJsonKey(p.name)}'`)
+            .join(', ');
+        return `json_table(${column}, '$[*]' columns (${columns})) as ${this.quoteIdentifier(alias)}`;
+    }
+    // MySQL does not support correlated json_table inside EXISTS subqueries,
+    // so we use a semi-join via the comma-join pattern instead.
+    getJsonArrayExistsSQL(from, where) {
+        return `(select 1 from ${from} where ${where} limit 1) is not null`;
+    }
     getDefaultClientUrl() {
         return 'mysql://root@127.0.0.1:3306';
     }

package/dialects/postgresql/BasePostgreSqlPlatform.d.ts

@@ -5,6 +5,7 @@ import { PostgreSqlNativeQueryBuilder } from './PostgreSqlNativeQueryBuilder.js'
 import { PostgreSqlSchemaHelper } from './PostgreSqlSchemaHelper.js';
 import { PostgreSqlExceptionConverter } from './PostgreSqlExceptionConverter.js';
 export declare class BasePostgreSqlPlatform extends AbstractSqlPlatform {
+    #private;
     protected readonly schemaHelper: PostgreSqlSchemaHelper;
     protected readonly exceptionConverter: PostgreSqlExceptionConverter;
     createNativeQueryBuilder(): PostgreSqlNativeQueryBuilder;
@@ -102,5 +103,10 @@ export declare class BasePostgreSqlPlatform extends AbstractSqlPlatform {
     castColumn(prop?: {
         columnTypes?: string[];
     }): string;
+    getJsonArrayFromSQL(column: string, alias: string, _properties: {
+        name: string;
+        type: string;
+    }[]): string;
+    getJsonArrayElementPropertySQL(alias: string, property: string, type: string): string;
     getDefaultClientUrl(): string;
 }

package/dialects/postgresql/BasePostgreSqlPlatform.js

@@ -7,6 +7,8 @@ import { FullTextType } from './FullTextType.js';
 export class BasePostgreSqlPlatform extends AbstractSqlPlatform {
     schemaHelper = new PostgreSqlSchemaHelper(this);
     exceptionConverter = new PostgreSqlExceptionConverter();
+    /** Maps JS runtime type names to PostgreSQL cast types for JSON property access. @internal */
+    #jsonTypeCasts = { number: 'float8', bigint: 'int8', boolean: 'bool' };
     createNativeQueryBuilder() {
         return new PostgreSqlNativeQueryBuilder(this);
     }
@@ -215,12 +217,7 @@ export class BasePostgreSqlPlatform extends AbstractSqlPlatform {
         const last = path.pop();
         const root = this.quoteIdentifier(aliased ? `${ALIAS_REPLACEMENT}.${first}` : first);
         type = typeof type === 'string' ? this.getMappedType(type).runtimeType : String(type);
-        const types = {
-            number: 'float8',
-            bigint: 'int8',
-            boolean: 'bool',
-        };
-        const cast = (key) => raw(type in types ? `(${key})::${types[type]}` : key);
+        const cast = (key) => raw(type in this.#jsonTypeCasts ? `(${key})::${this.#jsonTypeCasts[type]}` : key);
         let lastOperator = '->>';
         // force `->` for operator payloads with array values
         if (Utils.isPlainObject(value) &&
@@ -352,6 +349,13 @@ export class BasePostgreSqlPlatform extends AbstractSqlPlatform {
                 return '';
         }
     }
+    getJsonArrayFromSQL(column, alias, _properties) {
+        return `jsonb_array_elements(${column}) as ${this.quoteIdentifier(alias)}`;
+    }
+    getJsonArrayElementPropertySQL(alias, property, type) {
+        const expr = `${this.quoteIdentifier(alias)}->>${this.quoteValue(property)}`;
+        return type in this.#jsonTypeCasts ? `(${expr})::${this.#jsonTypeCasts[type]}` : expr;
+    }
     getDefaultClientUrl() {
         return 'postgresql://postgres@127.0.0.1:5432';
     }

package/dialects/sqlite/SqlitePlatform.d.ts

@@ -75,5 +75,6 @@ export declare class SqlitePlatform extends AbstractSqlPlatform {
     convertVersionValue(value: Date | number, prop: EntityProperty): number | {
         $in: (string | number)[];
     };
+    getJsonArrayElementPropertySQL(alias: string, property: string, _type: string): string;
     quoteValue(value: any): string;
 }

package/dialects/sqlite/SqlitePlatform.js

@@ -133,6 +133,9 @@ export class SqlitePlatform extends AbstractSqlPlatform {
         }
         return value;
     }
+    getJsonArrayElementPropertySQL(alias, property, _type) {
+        return `json_extract(${this.quoteIdentifier(alias)}.value, '$.${this.quoteJsonKey(property)}')`;
+    }
     quoteValue(value) {
         if (value instanceof Date) {
             return '' + +value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/sql",
-  "version": "7.0.0-dev.335",
+  "version": "7.0.0-dev.336",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "keywords": [
     "data-mapper",
@@ -53,7 +53,7 @@
     "@mikro-orm/core": "^6.6.9"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.335"
+    "@mikro-orm/core": "7.0.0-dev.336"
   },
   "engines": {
     "node": ">= 22.17.0"

package/query/CriteriaNodeFactory.js

@@ -2,6 +2,7 @@ import { GroupOperator, isRaw, JsonType, RawQueryFragment, ReferenceKind, Utils,
 import { ObjectCriteriaNode } from './ObjectCriteriaNode.js';
 import { ArrayCriteriaNode } from './ArrayCriteriaNode.js';
 import { ScalarCriteriaNode } from './ScalarCriteriaNode.js';
+import { EMBEDDABLE_ARRAY_OPS } from './enums.js';
 /**
  * @internal
  */
@@ -69,15 +70,26 @@ export class CriteriaNodeFactory {
             }, {});
             return this.createNode(metadata, entityName, map, node, key, validate);
         }
+        // For array embeddeds stored as real columns, route property-level queries
+        // as scalar nodes so QueryBuilderHelper generates EXISTS subqueries with
+        // JSON array iteration.  Keys containing `~` indicate the property lives
+        // inside a parent's object-mode JSON column (MetadataDiscovery uses `~` as
+        // the glue for object embeds), where JSON path access is used instead.
+        if (prop.array && !String(key).includes('~')) {
+            const keys = Object.keys(val);
+            const hasOnlyArrayOps = keys.every(k => EMBEDDABLE_ARRAY_OPS.includes(k));
+            if (!hasOnlyArrayOps) {
+                return this.createScalarNode(metadata, entityName, val, node, key, validate);
+            }
+        }
         // array operators can be used on embedded properties
-        const allowedOperators = ['$contains', '$contained', '$overlap'];
-        const operator = Object.keys(val).some(f => Utils.isOperator(f) && !allowedOperators.includes(f));
+        const operator = Object.keys(val).some(f => Utils.isOperator(f) && !EMBEDDABLE_ARRAY_OPS.includes(f));
         if (operator) {
             throw ValidationError.cannotUseOperatorsInsideEmbeddables(entityName, prop.name, payload);
         }
         const map = Object.keys(val).reduce((oo, k) => {
             const embeddedProp = prop.embeddedProps[k] ?? Object.values(prop.embeddedProps).find(p => p.name === k);
-            if (!embeddedProp && !allowedOperators.includes(k)) {
+            if (!embeddedProp && !EMBEDDABLE_ARRAY_OPS.includes(k)) {
                 throw ValidationError.invalidEmbeddableQuery(entityName, k, prop.type);
             }
             if (embeddedProp) {

package/query/QueryBuilderHelper.d.ts

@@ -56,6 +56,11 @@ export declare class QueryBuilderHelper {
     private fieldName;
     getProperty(field: string, alias?: string): EntityProperty | undefined;
     isTableNameAliasRequired(type: QueryType): boolean;
+    private processEmbeddedArrayCondition;
+    private buildJsonArrayExists;
+    private resolveEmbeddedProp;
+    private buildEmbeddedArrayWhere;
+    private buildEmbeddedArrayOperatorCondition;
     processOnConflictCondition(cond: FilterQuery<any>, schema?: string): FilterQuery<any>;
     createFormulaTable(alias: string, meta: EntityMetadata, schema?: string): FormulaTable;
 }

package/query/QueryBuilderHelper.js

@@ -1,5 +1,5 @@
 import { ALIAS_REPLACEMENT, ALIAS_REPLACEMENT_RE, ArrayType, inspect, isRaw, LockMode, OptimisticLockError, QueryOperator, QueryOrderNumeric, raw, Raw, QueryHelper, ReferenceKind, Utils, ValidationError, } from '@mikro-orm/core';
-import { JoinType, QueryType } from './enums.js';
+import { EMBEDDABLE_ARRAY_OPS, JoinType, QueryType } from './enums.js';
 /**
  * @internal
  */
@@ -12,6 +12,8 @@ export class QueryBuilderHelper {
     #subQueries;
     #driver;
     #tptAliasMap;
+    /** Monotonically increasing counter for unique JSON array iteration aliases within a single query. */
+    #jsonAliasCounter = 0;
     constructor(entityName, alias, aliasMap, subQueries, driver, tptAliasMap = {}) {
         this.#entityName = entityName;
         this.#alias = alias;
@@ -436,6 +438,17 @@ export class QueryBuilderHelper {
             params.push(this.getRegExpParam(cond[key]));
             return { sql: parts.join(' and '), params };
         }
+        if (Utils.isPlainObject(cond[key]) && !Raw.isKnownFragmentSymbol(key)) {
+            const [a, f] = this.splitField(key);
+            const prop = this.getProperty(f, a);
+            if (prop?.kind === ReferenceKind.EMBEDDED && prop.array) {
+                const keys = Object.keys(cond[key]);
+                const hasOnlyArrayOps = keys.every((k) => EMBEDDABLE_ARRAY_OPS.includes(k));
+                if (!hasOnlyArrayOps) {
+                    return this.processEmbeddedArrayCondition(cond[key], prop, a);
+                }
+            }
+        }
         if (Utils.isPlainObject(cond[key]) || cond[key] instanceof RegExp) {
             return this.processObjectSubCondition(cond, key, type);
         }
@@ -827,6 +840,148 @@ export class QueryBuilderHelper {
     isTableNameAliasRequired(type) {
         return [QueryType.SELECT, QueryType.COUNT].includes(type);
     }
+    processEmbeddedArrayCondition(cond, prop, alias) {
+        const fieldName = prop.fieldNames[0];
+        const column = this.#platform.quoteIdentifier(`${alias}.${fieldName}`);
+        const parts = [];
+        const allParams = [];
+        // Top-level $not generates NOT EXISTS (no element matches the inner condition).
+        const { $not, ...rest } = cond;
+        if (Utils.hasObjectKeys(rest)) {
+            const result = this.buildJsonArrayExists(rest, prop, column, false);
+            if (result) {
+                parts.push(result.sql);
+                allParams.push(...result.params);
+            }
+        }
+        if ($not != null) {
+            if (!Utils.isPlainObject($not)) {
+                throw new ValidationError(`Invalid query: $not in embedded array queries expects an object value`);
+            }
+            const result = this.buildJsonArrayExists($not, prop, column, true);
+            if (result) {
+                parts.push(result.sql);
+                allParams.push(...result.params);
+            }
+        }
+        if (parts.length === 0) {
+            return { sql: '1 = 1', params: [] };
+        }
+        return { sql: parts.join(' and '), params: allParams };
+    }
+    buildJsonArrayExists(cond, prop, column, negate) {
+        const jeAlias = `__je${this.#jsonAliasCounter++}`;
+        const referencedProps = new Map();
+        const { sql: whereSql, params } = this.buildEmbeddedArrayWhere(cond, prop, jeAlias, referencedProps);
+        if (!whereSql) {
+            return null;
+        }
+        const from = this.#platform.getJsonArrayFromSQL(column, jeAlias, [...referencedProps.values()]);
+        const exists = this.#platform.getJsonArrayExistsSQL(from, whereSql);
+        return { sql: negate ? `not ${exists}` : exists, params };
+    }
+    resolveEmbeddedProp(prop, key) {
+        const embProp = prop.embeddedProps[key] ?? Object.values(prop.embeddedProps).find(p => p.name === key);
+        if (!embProp) {
+            throw ValidationError.invalidEmbeddableQuery(this.#entityName, key, prop.type);
+        }
+        const prefix = `${prop.fieldNames[0]}~`;
+        const raw = embProp.fieldNames[0];
+        const jsonPropName = raw.startsWith(prefix) ? raw.slice(prefix.length) : raw;
+        return { embProp, jsonPropName };
+    }
+    buildEmbeddedArrayWhere(cond, prop, jeAlias, referencedProps) {
+        const parts = [];
+        const params = [];
+        for (const k of Object.keys(cond)) {
+            if (k === '$and' || k === '$or') {
+                const items = cond[k];
+                if (items.length === 0) {
+                    continue;
+                }
+                const subParts = [];
+                for (const item of items) {
+                    const sub = this.buildEmbeddedArrayWhere(item, prop, jeAlias, referencedProps);
+                    if (sub.sql) {
+                        subParts.push(sub.sql);
+                        params.push(...sub.params);
+                    }
+                }
+                if (subParts.length > 0) {
+                    const joiner = k === '$or' ? ' or ' : ' and ';
+                    parts.push(`(${subParts.join(joiner)})`);
+                }
+                continue;
+            }
+            // Within $or/$and scope, $not provides element-level negation:
+            // "this element does not match the condition".
+            if (k === '$not') {
+                const sub = this.buildEmbeddedArrayWhere(cond[k], prop, jeAlias, referencedProps);
+                if (sub.sql) {
+                    parts.push(`not (${sub.sql})`);
+                    params.push(...sub.params);
+                }
+                continue;
+            }
+            const { embProp, jsonPropName } = this.resolveEmbeddedProp(prop, k);
+            referencedProps.set(k, { name: jsonPropName, type: embProp.runtimeType ?? 'string' });
+            const lhs = this.#platform.getJsonArrayElementPropertySQL(jeAlias, jsonPropName, embProp.runtimeType ?? 'string');
+            const value = cond[k];
+            if (Utils.isPlainObject(value)) {
+                // Validate that all keys are operators — nested embeddables within array elements are not supported.
+                const valueKeys = Object.keys(value);
+                if (valueKeys.some(vk => !Utils.isOperator(vk))) {
+                    throw ValidationError.invalidEmbeddableQuery(this.#entityName, k, prop.type);
+                }
+                const sub = this.buildEmbeddedArrayOperatorCondition(lhs, value, params);
+                parts.push(sub);
+            }
+            else if (value === null) {
+                parts.push(`${lhs} is null`);
+            }
+            else {
+                parts.push(`${lhs} = ?`);
+                params.push(value);
+            }
+        }
+        return { sql: parts.join(' and '), params };
+    }
+    buildEmbeddedArrayOperatorCondition(lhs, value, params) {
+        const supported = new Set(['$eq', '$ne', '$gt', '$gte', '$lt', '$lte', '$in', '$nin', '$not', '$like', '$exists']);
+        const parts = [];
+        // Clone to avoid getOperatorReplacement mutating the original (it sets value[op] = null for $exists).
+        value = { ...value };
+        for (const op of Object.keys(value)) {
+            if (!supported.has(op)) {
+                throw new ValidationError(`Operator ${op} is not supported in embedded array queries`);
+            }
+            const replacement = this.getOperatorReplacement(op, value);
+            const val = value[op];
+            if (['$in', '$nin'].includes(op)) {
+                if (!Array.isArray(val)) {
+                    throw new ValidationError(`Invalid query: ${op} operator expects an array value`);
+                }
+                else if (val.length === 0) {
+                    parts.push(`1 = ${op === '$in' ? 0 : 1}`);
+                }
+                else {
+                    val.forEach((v) => params.push(v));
+                    parts.push(`${lhs} ${replacement} (${val.map(() => '?').join(', ')})`);
+                }
+            }
+            else if (op === '$exists') {
+                parts.push(`${lhs} ${replacement} null`);
+            }
+            else if (val === null) {
+                parts.push(`${lhs} ${replacement} null`);
+            }
+            else {
+                parts.push(`${lhs} ${replacement} ?`);
+                params.push(val);
+            }
+        }
+        return parts.join(' and ');
+    }
     processOnConflictCondition(cond, schema) {
         const meta = this.#metadata.get(this.#entityName);
         const tableName = meta.tableName;

package/query/enums.d.ts

@@ -7,6 +7,8 @@ export declare enum QueryType {
     DELETE = "DELETE",
     UPSERT = "UPSERT"
 }
+/** Operators that apply to the embedded array column itself, not to individual elements. */
+export declare const EMBEDDABLE_ARRAY_OPS: string[];
 export declare enum JoinType {
     leftJoin = "left join",
     innerJoin = "inner join",

package/query/enums.js

@@ -8,6 +8,8 @@ export var QueryType;
     QueryType["DELETE"] = "DELETE";
     QueryType["UPSERT"] = "UPSERT";
 })(QueryType || (QueryType = {}));
+/** Operators that apply to the embedded array column itself, not to individual elements. */
+export const EMBEDDABLE_ARRAY_OPS = ['$contains', '$contained', '$overlap'];
 export var JoinType;
 (function (JoinType) {
     JoinType["leftJoin"] = "left join";