metal-orm 1.0.85 → 1.0.86

package/dist/index.js

@@ -770,6 +770,8 @@ var registerExpressionDispatcher = (type, dispatcher) => {
 var registerOperandDispatcher = (type, dispatcher) => {
   operandRegistry = operandRegistry.register(type, dispatcher);
 };
+var hasExpressionDispatcher = (type) => expressionRegistry.get(type) !== void 0;
+var hasOperandDispatcher = (type) => operandRegistry.get(type) !== void 0;
 var clearExpressionDispatchers = () => {
   expressionRegistry = expressionRegistry.clear();
 };
@@ -864,6 +866,12 @@ var visitOperand = (node, visitor) => {
     case "Collate":
       if (visitor.visitCollate) return visitor.visitCollate(node);
       break;
+    case "ArithmeticExpression":
+      if (visitor.visitArithmeticExpression) return visitor.visitArithmeticExpression(node);
+      break;
+    case "BitwiseExpression":
+      if (visitor.visitBitwiseExpression) return visitor.visitBitwiseExpression(node);
+      break;
     default:
       break;
   }
@@ -6152,9 +6160,9 @@ var flattenResults = (results) => {
   }
   return rows;
 };
-var executeWithContexts = async (execCtx, entityCtx, qb) => {
+var executeWithContexts = async (execCtx, entityCtx, qb, options) => {
   const ast = qb.getAST();
-  const compiled = execCtx.dialect.compileSelect(ast);
+  const compiled = options?.allowParamOperands ? execCtx.dialect.compileSelectWithOptions(ast, { allowParams: true }) : execCtx.dialect.compileSelect(ast);
   const executed = await execCtx.interceptors.run({ sql: compiled.sql, params: compiled.params }, execCtx.executor);
   const rows = flattenResults(executed);
   const lazyRelations = qb.getLazyRelations();
@@ -6172,9 +6180,9 @@ var executeWithContexts = async (execCtx, entityCtx, qb) => {
   await preloadRelationIncludes(entities, includeTree);
   return entities;
 };
-var executePlainWithContexts = async (execCtx, qb) => {
+var executePlainWithContexts = async (execCtx, qb, options) => {
   const ast = qb.getAST();
-  const compiled = execCtx.dialect.compileSelect(ast);
+  const compiled = options?.allowParamOperands ? execCtx.dialect.compileSelectWithOptions(ast, { allowParams: true }) : execCtx.dialect.compileSelect(ast);
   const executed = await execCtx.interceptors.run({ sql: compiled.sql, params: compiled.params }, execCtx.executor);
   const rows = flattenResults(executed);
   if (ast.setOps && ast.setOps.length > 0) {
@@ -6182,21 +6190,21 @@ var executePlainWithContexts = async (execCtx, qb) => {
   }
   return hydrateRows(rows, qb.getHydrationPlan());
 };
-async function executeHydrated(session, qb) {
-  return executeWithContexts(session.getExecutionContext(), session, qb);
+async function executeHydrated(session, qb, options) {
+  return executeWithContexts(session.getExecutionContext(), session, qb, options);
 }
-async function executeHydratedPlain(session, qb) {
-  return executePlainWithContexts(session.getExecutionContext(), qb);
+async function executeHydratedPlain(session, qb, options) {
+  return executePlainWithContexts(session.getExecutionContext(), qb, options);
 }
-async function executeHydratedWithContexts(execCtx, hydCtx, qb) {
+async function executeHydratedWithContexts(execCtx, hydCtx, qb, options) {
   const entityCtx = hydCtx.entityContext;
   if (!entityCtx) {
     throw new Error("Hydration context is missing an EntityContext");
   }
-  return executeWithContexts(execCtx, entityCtx, qb);
+  return executeWithContexts(execCtx, entityCtx, qb, options);
 }
-async function executeHydratedPlainWithContexts(execCtx, qb) {
-  return executePlainWithContexts(execCtx, qb);
+async function executeHydratedPlainWithContexts(execCtx, qb, options) {
+  return executePlainWithContexts(execCtx, qb, options);
 }
 var loadLazyRelationsForTable = async (ctx, table, lazyRelations, lazyRelationOptions) => {
   if (!lazyRelations.length) return;
@@ -6397,7 +6405,7 @@ function applyOrderBy(context, predicateFacet, term, directionOrOptions) {
   const dir = options.direction ?? ORDER_DIRECTIONS.ASC;
   return predicateFacet.orderBy(context, term, dir, options.nulls, options.collation);
 }
-async function executeCount(context, env, session) {
+async function executeCount(context, env, session, options) {
   const unpagedAst = {
     ...context.state.ast,
     orderBy: void 0,
@@ -6417,7 +6425,7 @@ async function executeCount(context, env, session) {
     joins: []
   };
   const execCtx = session.getExecutionContext();
-  const compiled = execCtx.dialect.compileSelect(countQuery);
+  const compiled = options?.allowParamOperands ? execCtx.dialect.compileSelectWithOptions(countQuery, { allowParams: true }) : execCtx.dialect.compileSelect(countQuery);
   const results = await execCtx.interceptors.run({ sql: compiled.sql, params: compiled.params }, execCtx.executor);
   const value = results[0]?.values?.[0]?.[0];
   if (typeof value === "number") return value;
@@ -6425,7 +6433,7 @@ async function executeCount(context, env, session) {
   if (typeof value === "string") return Number(value);
   return value === null || value === void 0 ? 0 : Number(value);
 }
-async function executePagedQuery(builder, session, options, countCallback) {
+async function executePagedQuery(builder, session, options, countCallback, paramOptions) {
   const { page, pageSize } = options;
   if (!Number.isInteger(page) || page < 1) {
     throw new Error("executePaged: page must be an integer >= 1");
@@ -6435,7 +6443,7 @@ async function executePagedQuery(builder, session, options, countCallback) {
   }
   const offset = (page - 1) * pageSize;
   const totalItems = await countCallback(session);
-  const items = await builder.limit(pageSize).offset(offset).execute(session);
+  const items = await builder.limit(pageSize).offset(offset).execute(session, paramOptions);
   return { items, totalItems, page, pageSize };
 }
 function buildWhereHasPredicate(env, context, relationFacet, createChildBuilder, relationName, callbackOrOptions, maybeOptions, negate = false) {
@@ -7367,7 +7375,7 @@ var collectFilterColumns = (expr, table, rootTables) => {
       columns.add(node.name);
     }
   };
-  const visitOrderingTerm2 = (term) => {
+  const visitOrderingTerm = (term) => {
     if (!term || typeof term !== "object") return;
     if (isOperandNode(term)) {
       visitOperand2(term);
@@ -7379,7 +7387,7 @@ var collectFilterColumns = (expr, table, rootTables) => {
   };
   const visitOrderBy = (orderBy) => {
     if (!orderBy) return;
-    orderBy.forEach((node) => visitOrderingTerm2(node.term));
+    orderBy.forEach((node) => visitOrderingTerm(node.term));
   };
   const visitOperand2 = (node) => {
     switch (node.type) {
@@ -7531,137 +7539,174 @@ var getNodeType3 = (value) => {
   }
   return void 0;
 };
-var visitOrderingTerm = (term, visitor) => {
-  if (isOperandNode(term)) {
-    visitOperandNode(term, visitor);
-    return;
-  }
-  visitExpressionNode(term, visitor);
-};
-var visitOrderByNode = (node, visitor) => {
-  visitor.visitOrderBy?.(node);
-  visitOrderingTerm(node.term, visitor);
-};
-var visitTableSource = (source, visitor) => {
-  visitor.visitTableSource?.(source);
-  if (source.type === "DerivedTable") {
-    visitor.visitDerivedTable?.(source);
-    visitSelectQuery(source.query, visitor);
-    return;
-  }
-  if (source.type === "FunctionTable") {
-    visitor.visitFunctionTable?.(source);
-    source.args?.forEach((arg) => visitOperandNode(arg, visitor));
-  }
-};
-var visitExpressionNode = (node, visitor) => {
-  visitor.visitExpression?.(node);
-  const type = getNodeType3(node);
-  if (!type) return;
-  switch (type) {
-    case "BinaryExpression":
-      visitOperandNode(node.left, visitor);
-      visitOperandNode(node.right, visitor);
-      if (node.escape) {
-        visitOperandNode(node.escape, visitor);
-      }
+var visitSelectQuery = (ast, visitor) => {
+  const visitExpressionNode = (node) => {
+    visitExpression(node, expressionVisitor);
+  };
+  const visitOperandNode = (node) => {
+    visitOperand(node, operandVisitor);
+  };
+  const visitOrderingTerm = (term) => {
+    if (!term || typeof term !== "object") return;
+    if (isOperandNode(term)) {
+      visitOperandNode(term);
       return;
-    case "LogicalExpression":
-      node.operands.forEach((operand) => visitExpressionNode(operand, visitor));
+    }
+    const type = getNodeType3(term);
+    if (type && hasOperandDispatcher(type)) {
+      visitOperandNode(term);
       return;
-    case "NullExpression":
-      visitOperandNode(node.left, visitor);
+    }
+    if (type) {
+      visitExpressionNode(term);
+    }
+  };
+  const visitOrderByNode = (node) => {
+    visitor.visitOrderBy?.(node);
+    visitOrderingTerm(node.term);
+  };
+  const visitTableSource = (source) => {
+    visitor.visitTableSource?.(source);
+    if (source.type === "DerivedTable") {
+      visitor.visitDerivedTable?.(source);
+      visitSelectQuery(source.query, visitor);
       return;
-    case "InExpression":
-      visitOperandNode(node.left, visitor);
+    }
+    if (source.type === "FunctionTable") {
+      visitor.visitFunctionTable?.(source);
+      source.args?.forEach((arg) => visitOperandNode(arg));
+    }
+  };
+  const expressionVisitor = {
+    visitBinaryExpression: (node) => {
+      visitor.visitExpression?.(node);
+      visitOperandNode(node.left);
+      visitOperandNode(node.right);
+      if (node.escape) {
+        visitOperandNode(node.escape);
+      }
+    },
+    visitLogicalExpression: (node) => {
+      visitor.visitExpression?.(node);
+      node.operands.forEach((operand) => visitExpressionNode(operand));
+    },
+    visitNullExpression: (node) => {
+      visitor.visitExpression?.(node);
+      visitOperandNode(node.left);
+    },
+    visitInExpression: (node) => {
+      visitor.visitExpression?.(node);
+      visitOperandNode(node.left);
       if (Array.isArray(node.right)) {
-        node.right.forEach((operand) => visitOperandNode(operand, visitor));
+        node.right.forEach((operand) => visitOperandNode(operand));
       } else {
-        visitOperandNode(node.right, visitor);
+        visitOperandNode(node.right);
       }
-      return;
-    case "ExistsExpression":
+    },
+    visitExistsExpression: (node) => {
+      visitor.visitExpression?.(node);
       visitSelectQuery(node.subquery, visitor);
-      return;
-    case "BetweenExpression":
-      visitOperandNode(node.left, visitor);
-      visitOperandNode(node.lower, visitor);
-      visitOperandNode(node.upper, visitor);
-      return;
-    case "ArithmeticExpression":
-      visitOperandNode(node.left, visitor);
-      visitOperandNode(node.right, visitor);
-      return;
-    case "BitwiseExpression":
-      visitOperandNode(node.left, visitor);
-      visitOperandNode(node.right, visitor);
-      return;
-    default: {
-      return;
+    },
+    visitBetweenExpression: (node) => {
+      visitor.visitExpression?.(node);
+      visitOperandNode(node.left);
+      visitOperandNode(node.lower);
+      visitOperandNode(node.upper);
+    },
+    visitArithmeticExpression: (node) => {
+      visitor.visitExpression?.(node);
+      visitOperandNode(node.left);
+      visitOperandNode(node.right);
+    },
+    visitBitwiseExpression: (node) => {
+      visitor.visitExpression?.(node);
+      visitOperandNode(node.left);
+      visitOperandNode(node.right);
+    },
+    visitOperand: (node) => {
+      visitOperandNode(node);
+    },
+    visitSelectQuery: (node) => {
+      visitSelectQuery(node, visitor);
+    },
+    otherwise: (node) => {
+      visitor.visitExpression?.(node);
     }
-  }
-};
-var visitOperandNode = (node, visitor) => {
-  visitor.visitOperand?.(node);
-  const type = getNodeType3(node);
-  if (type === "Param") {
-    visitor.visitParam?.(node);
-  }
-  if (!type) return;
-  switch (type) {
-    case "Column":
-    case "Literal":
-    case "Param":
-    case "AliasRef":
-      return;
-    case "Function":
-      node.args?.forEach((arg) => visitOperandNode(arg, visitor));
-      node.orderBy?.forEach((order) => visitOrderByNode(order, visitor));
+  };
+  const operandVisitor = {
+    visitColumn: (node) => {
+      visitor.visitOperand?.(node);
+    },
+    visitLiteral: (node) => {
+      visitor.visitOperand?.(node);
+    },
+    visitParam: (node) => {
+      visitor.visitOperand?.(node);
+      visitor.visitParam?.(node);
+    },
+    visitFunction: (node) => {
+      visitor.visitOperand?.(node);
+      node.args?.forEach((arg) => visitOperandNode(arg));
+      node.orderBy?.forEach((order) => visitOrderByNode(order));
       if (node.separator) {
-        visitOperandNode(node.separator, visitor);
+        visitOperandNode(node.separator);
       }
-      return;
-    case "JsonPath":
-      visitOperandNode(node.column, visitor);
-      return;
-    case "ScalarSubquery":
+    },
+    visitJsonPath: (node) => {
+      visitor.visitOperand?.(node);
+      visitOperandNode(node.column);
+    },
+    visitScalarSubquery: (node) => {
+      visitor.visitOperand?.(node);
       visitSelectQuery(node.query, visitor);
-      return;
-    case "CaseExpression":
+    },
+    visitCaseExpression: (node) => {
+      visitor.visitOperand?.(node);
       node.conditions.forEach((cond) => {
-        visitExpressionNode(cond.when, visitor);
-        visitOperandNode(cond.then, visitor);
+        visitExpressionNode(cond.when);
+        visitOperandNode(cond.then);
       });
       if (node.else) {
-        visitOperandNode(node.else, visitor);
+        visitOperandNode(node.else);
       }
-      return;
-    case "Cast":
-      visitOperandNode(node.expression, visitor);
-      return;
-    case "WindowFunction":
-      node.args?.forEach((arg) => visitOperandNode(arg, visitor));
-      node.partitionBy?.forEach((term) => visitOperandNode(term, visitor));
-      node.orderBy?.forEach((order) => visitOrderByNode(order, visitor));
-      return;
-    case "ArithmeticExpression":
-      visitOperandNode(node.left, visitor);
-      visitOperandNode(node.right, visitor);
-      return;
-    case "BitwiseExpression":
-      visitOperandNode(node.left, visitor);
-      visitOperandNode(node.right, visitor);
-      return;
-    case "Collate":
-      visitOperandNode(node.expression, visitor);
-      return;
-    default: {
-      const _exhaustive = node;
-      return _exhaustive;
+    },
+    visitCast: (node) => {
+      visitor.visitOperand?.(node);
+      visitOperandNode(node.expression);
+    },
+    visitWindowFunction: (node) => {
+      visitor.visitOperand?.(node);
+      node.args?.forEach((arg) => visitOperandNode(arg));
+      node.partitionBy?.forEach((term) => visitOperandNode(term));
+      node.orderBy?.forEach((order) => visitOrderByNode(order));
+    },
+    visitArithmeticExpression: (node) => {
+      visitor.visitOperand?.(node);
+      visitOperandNode(node.left);
+      visitOperandNode(node.right);
+    },
+    visitBitwiseExpression: (node) => {
+      visitor.visitOperand?.(node);
+      visitOperandNode(node.left);
+      visitOperandNode(node.right);
+    },
+    visitExpression: (node) => {
+      visitExpressionNode(node);
+    },
+    visitSelectQuery: (node) => {
+      visitSelectQuery(node, visitor);
+    },
+    visitCollate: (node) => {
+      visitor.visitOperand?.(node);
+      visitOperandNode(node.expression);
+    },
+    visitAliasRef: (node) => {
+      visitor.visitOperand?.(node);
+    },
+    otherwise: (node) => {
+      visitor.visitOperand?.(node);
     }
-  }
-};
-var visitSelectQuery = (ast, visitor) => {
+  };
   visitor.visitSelectQuery?.(ast);
   if (ast.ctes) {
     for (const cte of ast.ctes) {
@@ -7669,29 +7714,29 @@ var visitSelectQuery = (ast, visitor) => {
       visitSelectQuery(cte.query, visitor);
     }
   }
-  visitTableSource(ast.from, visitor);
+  visitTableSource(ast.from);
   ast.columns?.forEach((col2) => {
-    visitOperandNode(col2, visitor);
+    visitOperandNode(col2);
   });
   ast.joins?.forEach((join) => {
     visitor.visitJoin?.(join);
-    visitTableSource(join.table, visitor);
-    visitExpressionNode(join.condition, visitor);
+    visitTableSource(join.table);
+    visitExpressionNode(join.condition);
   });
   if (ast.where) {
-    visitExpressionNode(ast.where, visitor);
+    visitExpressionNode(ast.where);
   }
   ast.groupBy?.forEach((term) => {
-    visitOrderingTerm(term, visitor);
+    visitOrderingTerm(term);
   });
   if (ast.having) {
-    visitExpressionNode(ast.having, visitor);
+    visitExpressionNode(ast.having);
   }
   ast.orderBy?.forEach((order) => {
-    visitOrderByNode(order, visitor);
+    visitOrderByNode(order);
   });
   ast.distinct?.forEach((col2) => {
-    visitOperandNode(col2, visitor);
+    visitOperandNode(col2);
   });
   ast.setOps?.forEach((op) => {
     visitor.visitSetOperation?.(op);
@@ -7700,14 +7745,16 @@ var visitSelectQuery = (ast, visitor) => {
 };
 
 // src/core/ast/ast-validation.ts
-var hasParamOperandsInQuery = (ast) => {
-  let hasParams = false;
+var findFirstParamOperandName = (ast) => {
+  let name;
   visitSelectQuery(ast, {
-    visitParam: () => {
-      hasParams = true;
+    visitParam: (node) => {
+      if (!name) {
+        name = node.name;
+      }
     }
   });
-  return hasParams;
+  return name;
 };
 
 // src/query-builder/select.ts
@@ -8187,11 +8234,12 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    * Validates that the query does not contain Param operands.
    * Param proxies are only for schema generation, not execution.
    */
-  validateNoParamOperands() {
+  validateNoParamOperands(options) {
+    if (options?.allowParamOperands) return;
     const ast = this.context.hydration.applyToAst(this.context.state.ast);
-    const hasParams = hasParamOperandsInQuery(ast);
-    if (hasParams) {
-      throw new Error("Cannot execute query containing Param operands. Param proxies are only for schema generation (getSchema()). If you need real parameters, use literal values.");
+    const paramName = findFirstParamOperandName(ast);
+    if (paramName) {
+      throw new Error(`Cannot execute query containing Param operand "${paramName}". Param proxies are only for schema generation (getSchema()). If you need real parameters, use literal values.`);
     }
   }
   /**
@@ -8206,13 +8254,13 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    * // users is User[]
    * users[0] instanceof User; // true
    */
-  async execute(ctx) {
-    this.validateNoParamOperands();
+  async execute(ctx, options) {
+    this.validateNoParamOperands(options);
     if (this.entityConstructor) {
-      return this.executeAs(this.entityConstructor, ctx);
+      return this.executeAs(this.entityConstructor, ctx, options);
     }
     const builder = this.ensureDefaultSelection();
-    return executeHydrated(ctx, builder);
+    return executeHydrated(ctx, builder, options);
   }
   /**
    * Executes the query and returns plain row objects (POJOs), ignoring any entity materialization.
@@ -8225,10 +8273,10 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    * // rows is EntityInstance<UserTable>[] (plain objects)
    * rows[0] instanceof User; // false
    */
-  async executePlain(ctx) {
-    this.validateNoParamOperands();
+  async executePlain(ctx, options) {
+    this.validateNoParamOperands(options);
     const builder = this.ensureDefaultSelection();
-    const rows = await executeHydratedPlain(ctx, builder);
+    const rows = await executeHydratedPlain(ctx, builder, options);
     return rows;
   }
   /**
@@ -8245,10 +8293,10 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    * users[0] instanceof User; // true!
    * users[0].getFullName();   // works!
    */
-  async executeAs(entityClass, ctx) {
-    this.validateNoParamOperands();
+  async executeAs(entityClass, ctx, options) {
+    this.validateNoParamOperands(options);
     const builder = this.ensureDefaultSelection();
-    const results = await executeHydrated(ctx, builder);
+    const results = await executeHydrated(ctx, builder, options);
     return materializeAs(entityClass, results);
   }
   /**
@@ -8257,9 +8305,9 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    * @example
    * const total = await qb.count(session);
    */
-  async count(session) {
-    this.validateNoParamOperands();
-    return executeCount(this.context, this.env, session);
+  async count(session, options) {
+    this.validateNoParamOperands(options);
+    return executeCount(this.context, this.env, session, options);
   }
   /**
    * Executes the query and returns both the paged items and the total.
@@ -8268,9 +8316,9 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    * const { items, totalItems, page, pageSize } = await qb.executePaged(session, { page: 1, pageSize: 20 });
    */
   async executePaged(session, options) {
-    this.validateNoParamOperands();
+    this.validateNoParamOperands(options);
     const builder = this.ensureDefaultSelection();
-    return executePagedQuery(builder, session, options, (sess) => builder.count(sess));
+    return executePagedQuery(builder, session, options, (sess) => builder.count(sess, options), options);
   }
   /**
    * Executes the query with provided execution and hydration contexts
@@ -8282,10 +8330,10 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    * const hydCtx = new HydrationContext();
    * const users = await qb.executeWithContexts(execCtx, hydCtx);
    */
-  async executeWithContexts(execCtx, hydCtx) {
-    this.validateNoParamOperands();
+  async executeWithContexts(execCtx, hydCtx, options) {
+    this.validateNoParamOperands(options);
     const builder = this.ensureDefaultSelection();
-    const results = await executeHydratedWithContexts(execCtx, hydCtx, builder);
+    const results = await executeHydratedWithContexts(execCtx, hydCtx, builder, options);
     if (this.entityConstructor) {
       return materializeAs(this.entityConstructor, results);
     }
@@ -8518,9 +8566,17 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    *   .compile('postgres');
    * console.log(compiled.sql); // SELECT "id", "name" FROM "users" WHERE "active" = true
    */
-  compile(dialect) {
+  compile(dialect, options) {
     const resolved = resolveDialectInput(dialect);
-    return resolved.compileSelect(this.getAST());
+    const ast = this.getAST();
+    if (!options?.allowParamOperands) {
+      const paramName = findFirstParamOperandName(ast);
+      if (paramName) {
+        throw new Error(`Cannot compile query containing Param operand "${paramName}". Param proxies are only for schema generation (getSchema()). If you need real parameters, use literal values.`);
+      }
+      return resolved.compileSelect(ast);
+    }
+    return resolved.compileSelectWithOptions(ast, { allowParams: true });
   }
   /**
    * Converts the query to SQL string for a specific dialect
@@ -8532,8 +8588,8 @@ var SelectQueryBuilder = class _SelectQueryBuilder {
    *   .toSql('postgres');
    * console.log(sql); // SELECT "id", "name" FROM "users" WHERE "active" = true
    */
-  toSql(dialect) {
-    return this.compile(dialect).sql;
+  toSql(dialect, options) {
+    return this.compile(dialect, options).sql;
   }
   /**
    * Gets hydration plan for query
@@ -14221,8 +14277,10 @@ export {
   groupConcat,
   gt,
   gte,
+  hasExpressionDispatcher,
   hasMany,
   hasOne,
+  hasOperandDispatcher,
   hour,
   hydrateRows,
   ifNull,