metal-orm 1.1.11 → 1.1.16

package/src/core/functions/types.ts

@@ -1,33 +1,33 @@
-import { FunctionNode, OperandNode } from '../ast/expression.js';
-
-/**
- * Context provided to function renderers.
- */
-export interface FunctionRenderContext {
-    /** The function node being rendered. */
-    node: FunctionNode;
-    /** The compiled arguments for the function. */
-    compiledArgs: string[];
-    /** Helper to compile additional operands (e.g., separators or ORDER BY columns). */
-    compileOperand: (operand: OperandNode) => string;
-}
-
-/**
- * A function that renders a SQL function call.
- * @param ctx - The rendering context.
- * @returns The rendered SQL string.
- */
-export type FunctionRenderer = (ctx: FunctionRenderContext) => string;
-
-/**
- * Strategy for rendering SQL functions in a specific dialect.
- */
-export interface FunctionStrategy {
-    /**
-     * Returns a renderer for a specific function name (e.g. "DATE_ADD").
-     * Returns undefined if this dialect doesn't support the function.
-     * @param functionName - The name of the function.
-     * @returns The renderer function or undefined.
-     */
-    getRenderer(functionName: string): FunctionRenderer | undefined;
-}
+import { FunctionNode, OperandNode } from '../ast/expression.js';
+
+/**
+ * Context provided to function renderers.
+ */
+export interface FunctionRenderContext {
+    /** The function node being rendered. */
+    node: FunctionNode;
+    /** The compiled arguments for the function. */
+    compiledArgs: string[];
+    /** Helper to compile additional operands (e.g., separators or ORDER BY columns). */
+    compileOperand: (operand: OperandNode) => string;
+}
+
+/**
+ * A function that renders a SQL function call.
+ * @param ctx - The rendering context.
+ * @returns The rendered SQL string.
+ */
+export type FunctionRenderer = (ctx: FunctionRenderContext) => string;
+
+/**
+ * Strategy for rendering SQL functions in a specific dialect.
+ */
+export interface FunctionStrategy {
+    /**
+     * Returns a renderer for a specific function name (e.g. "DATE_ADD").
+     * Returns undefined if this dialect doesn't support the function.
+     * @param functionName - The name of the function.
+     * @returns The renderer function or undefined.
+     */
+    getRenderer(functionName: string): FunctionRenderer | undefined;
+}

package/src/core/hydration/types.ts

@@ -1,8 +1,8 @@
-import { RelationType } from '../../schema/relation.js';
-
-/**
- * Plan describing pivot columns needed for hydration
- */
+import { RelationType } from '../../schema/relation.js';
+
+/**
+ * Plan describing pivot columns needed for hydration
+ */
 export interface HydrationPivotPlan {
   table: string;
   primaryKey: string;
@@ -11,49 +11,49 @@ export interface HydrationPivotPlan {
   /** If true, merge pivot columns onto the child entity (non-destructive). */
   merge?: boolean;
 }
-
-/**
- * Plan for hydrating relationship data
- */
-export interface HydrationRelationPlan {
-  /** Name of the relationship */
-  name: string;
-  /** Alias prefix for the relationship */
-  aliasPrefix: string;
-  /** Type of relationship */
-  type: RelationType;
-  /** Target table name */
-  targetTable: string;
-  /** Target table primary key */
-  targetPrimaryKey: string;
-  /** Foreign key column */
-  foreignKey: string;
-  /** Local key column */
-  localKey: string;
-  /** Columns to include */
-  columns: string[];
-  /** Optional pivot plan for many-to-many relationships */
-  pivot?: HydrationPivotPlan;
-}
-
-/**
- * Complete hydration plan for a query
- */
-export interface HydrationPlan {
-  /** Root table name */
-  rootTable: string;
-  /** Root table primary key */
-  rootPrimaryKey: string;
-  /** Root table columns */
-  rootColumns: string[];
-  /** Relationship hydration plans */
-  relations: HydrationRelationPlan[];
-}
-
-/**
- * Metadata bag for attaching hydration to query ASTs without coupling AST types.
- */
-export interface HydrationMetadata {
-  hydration?: HydrationPlan;
-  [key: string]: unknown;
-}
+
+/**
+ * Plan for hydrating relationship data
+ */
+export interface HydrationRelationPlan {
+  /** Name of the relationship */
+  name: string;
+  /** Alias prefix for the relationship */
+  aliasPrefix: string;
+  /** Type of relationship */
+  type: RelationType;
+  /** Target table name */
+  targetTable: string;
+  /** Target table primary key */
+  targetPrimaryKey: string;
+  /** Foreign key column */
+  foreignKey: string;
+  /** Local key column */
+  localKey: string;
+  /** Columns to include */
+  columns: string[];
+  /** Optional pivot plan for many-to-many relationships */
+  pivot?: HydrationPivotPlan;
+}
+
+/**
+ * Complete hydration plan for a query
+ */
+export interface HydrationPlan {
+  /** Root table name */
+  rootTable: string;
+  /** Root table primary key */
+  rootPrimaryKey: string;
+  /** Root table columns */
+  rootColumns: string[];
+  /** Relationship hydration plans */
+  relations: HydrationRelationPlan[];
+}
+
+/**
+ * Metadata bag for attaching hydration to query ASTs without coupling AST types.
+ */
+export interface HydrationMetadata {
+  hydration?: HydrationPlan;
+  [key: string]: unknown;
+}

package/src/core/sql/sql-operator-config.ts

@@ -1,39 +1,39 @@
-import { SQL_OPERATORS, SqlOperator } from './sql.js';
-
-/**
- * Configuration for how SQL operators map to TypeScript builder helpers
- */
-export interface SqlOperatorConfig {
-  /**
-   * SQL operator literal
-   */
-  sql: SqlOperator;
-  /**
-   * Corresponding TypeScript helper name
-   */
-  tsName: string;
-}
-
-/**
- * Registry of supported SQL operators and their companion helper names
- */
-export const SQL_OPERATOR_REGISTRY: Record<SqlOperator, SqlOperatorConfig> = {
-  [SQL_OPERATORS.EQUALS]: { sql: SQL_OPERATORS.EQUALS, tsName: 'eq' },
-  [SQL_OPERATORS.NOT_EQUALS]: { sql: SQL_OPERATORS.NOT_EQUALS, tsName: 'neq' },
-  [SQL_OPERATORS.GREATER_THAN]: { sql: SQL_OPERATORS.GREATER_THAN, tsName: 'gt' },
-  [SQL_OPERATORS.GREATER_OR_EQUAL]: { sql: SQL_OPERATORS.GREATER_OR_EQUAL, tsName: 'gte' },
-  [SQL_OPERATORS.LESS_THAN]: { sql: SQL_OPERATORS.LESS_THAN, tsName: 'lt' },
-  [SQL_OPERATORS.LESS_OR_EQUAL]: { sql: SQL_OPERATORS.LESS_OR_EQUAL, tsName: 'lte' },
-  [SQL_OPERATORS.LIKE]: { sql: SQL_OPERATORS.LIKE, tsName: 'like' },
-  [SQL_OPERATORS.NOT_LIKE]: { sql: SQL_OPERATORS.NOT_LIKE, tsName: 'notLike' },
-  [SQL_OPERATORS.IN]: { sql: SQL_OPERATORS.IN, tsName: 'inList' },
-  [SQL_OPERATORS.NOT_IN]: { sql: SQL_OPERATORS.NOT_IN, tsName: 'notInList' },
-  [SQL_OPERATORS.IS_NULL]: { sql: SQL_OPERATORS.IS_NULL, tsName: 'isNull' },
-  [SQL_OPERATORS.IS_NOT_NULL]: { sql: SQL_OPERATORS.IS_NOT_NULL, tsName: 'isNotNull' },
-  [SQL_OPERATORS.AND]: { sql: SQL_OPERATORS.AND, tsName: 'and' },
-  [SQL_OPERATORS.OR]: { sql: SQL_OPERATORS.OR, tsName: 'or' },
-  [SQL_OPERATORS.BETWEEN]: { sql: SQL_OPERATORS.BETWEEN, tsName: 'between' },
-  [SQL_OPERATORS.NOT_BETWEEN]: { sql: SQL_OPERATORS.NOT_BETWEEN, tsName: 'notBetween' },
-  [SQL_OPERATORS.EXISTS]: { sql: SQL_OPERATORS.EXISTS, tsName: 'exists' },
-  [SQL_OPERATORS.NOT_EXISTS]: { sql: SQL_OPERATORS.NOT_EXISTS, tsName: 'notExists' }
-};
+import { SQL_OPERATORS, SqlOperator } from './sql.js';
+
+/**
+ * Configuration for how SQL operators map to TypeScript builder helpers
+ */
+export interface SqlOperatorConfig {
+  /**
+   * SQL operator literal
+   */
+  sql: SqlOperator;
+  /**
+   * Corresponding TypeScript helper name
+   */
+  tsName: string;
+}
+
+/**
+ * Registry of supported SQL operators and their companion helper names
+ */
+export const SQL_OPERATOR_REGISTRY: Record<SqlOperator, SqlOperatorConfig> = {
+  [SQL_OPERATORS.EQUALS]: { sql: SQL_OPERATORS.EQUALS, tsName: 'eq' },
+  [SQL_OPERATORS.NOT_EQUALS]: { sql: SQL_OPERATORS.NOT_EQUALS, tsName: 'neq' },
+  [SQL_OPERATORS.GREATER_THAN]: { sql: SQL_OPERATORS.GREATER_THAN, tsName: 'gt' },
+  [SQL_OPERATORS.GREATER_OR_EQUAL]: { sql: SQL_OPERATORS.GREATER_OR_EQUAL, tsName: 'gte' },
+  [SQL_OPERATORS.LESS_THAN]: { sql: SQL_OPERATORS.LESS_THAN, tsName: 'lt' },
+  [SQL_OPERATORS.LESS_OR_EQUAL]: { sql: SQL_OPERATORS.LESS_OR_EQUAL, tsName: 'lte' },
+  [SQL_OPERATORS.LIKE]: { sql: SQL_OPERATORS.LIKE, tsName: 'like' },
+  [SQL_OPERATORS.NOT_LIKE]: { sql: SQL_OPERATORS.NOT_LIKE, tsName: 'notLike' },
+  [SQL_OPERATORS.IN]: { sql: SQL_OPERATORS.IN, tsName: 'inList' },
+  [SQL_OPERATORS.NOT_IN]: { sql: SQL_OPERATORS.NOT_IN, tsName: 'notInList' },
+  [SQL_OPERATORS.IS_NULL]: { sql: SQL_OPERATORS.IS_NULL, tsName: 'isNull' },
+  [SQL_OPERATORS.IS_NOT_NULL]: { sql: SQL_OPERATORS.IS_NOT_NULL, tsName: 'isNotNull' },
+  [SQL_OPERATORS.AND]: { sql: SQL_OPERATORS.AND, tsName: 'and' },
+  [SQL_OPERATORS.OR]: { sql: SQL_OPERATORS.OR, tsName: 'or' },
+  [SQL_OPERATORS.BETWEEN]: { sql: SQL_OPERATORS.BETWEEN, tsName: 'between' },
+  [SQL_OPERATORS.NOT_BETWEEN]: { sql: SQL_OPERATORS.NOT_BETWEEN, tsName: 'notBetween' },
+  [SQL_OPERATORS.EXISTS]: { sql: SQL_OPERATORS.EXISTS, tsName: 'exists' },
+  [SQL_OPERATORS.NOT_EXISTS]: { sql: SQL_OPERATORS.NOT_EXISTS, tsName: 'notExists' }
+};

package/src/core/sql/sql.ts

@@ -1,152 +1,152 @@
-/**
- * SQL keywords used in query generation
- */
-export const SQL_KEYWORDS = {
-  /** SELECT clause keyword */
-  SELECT: 'SELECT',
-  /** FROM clause keyword */
-  FROM: 'FROM',
-  /** WHERE clause keyword */
-  WHERE: 'WHERE',
-  /** JOIN keyword */
-  JOIN: 'JOIN',
-  /** INNER JOIN keyword */
-  INNER_JOIN: 'INNER JOIN',
-  /** LEFT JOIN keyword */
-  LEFT_JOIN: 'LEFT JOIN',
-  /** RIGHT JOIN keyword */
-  RIGHT_JOIN: 'RIGHT JOIN',
-  /** ORDER BY clause keyword */
-  ORDER_BY: 'ORDER BY',
-  /** GROUP BY clause keyword */
-  GROUP_BY: 'GROUP BY',
-  /** HAVING clause keyword */
-  HAVING: 'HAVING',
-  /** DISTINCT keyword */
-  DISTINCT: 'DISTINCT',
-  /** EXISTS operator */
-  EXISTS: 'EXISTS',
-  /** NOT EXISTS operator */
-  NOT_EXISTS: 'NOT EXISTS'
-} as const;
-
-/**
- * SQL operators used in query conditions
- */
-export const SQL_OPERATORS = {
-  /** Equality operator */
-  EQUALS: '=',
-  /** Not equals operator */
-  NOT_EQUALS: '!=',
-  /** Greater than operator */
-  GREATER_THAN: '>',
-  /** Greater than or equal operator */
-  GREATER_OR_EQUAL: '>=',
-  /** Less than operator */
-  LESS_THAN: '<',
-  /** Less than or equal operator */
-  LESS_OR_EQUAL: '<=',
-  /** LIKE pattern matching operator */
-  LIKE: 'LIKE',
-  /** NOT LIKE pattern matching operator */
-  NOT_LIKE: 'NOT LIKE',
-  /** IN membership operator */
-  IN: 'IN',
-  /** NOT IN membership operator */
-  NOT_IN: 'NOT IN',
-  /** BETWEEN range operator */
-  BETWEEN: 'BETWEEN',
-  /** NOT BETWEEN range operator */
-  NOT_BETWEEN: 'NOT BETWEEN',
-  /** IS NULL null check operator */
-  IS_NULL: 'IS NULL',
-  /** IS NOT NULL null check operator */
-  IS_NOT_NULL: 'IS NOT NULL',
-  /** Logical AND operator */
-  AND: 'AND',
-  /** Logical OR operator */
-  OR: 'OR',
-  /** EXISTS operator */
-  EXISTS: 'EXISTS',
-  /** NOT EXISTS operator */
-  NOT_EXISTS: 'NOT EXISTS'
-} as const;
-
-/**
- * SQL bitwise operators
- */
-export const BITWISE_OPERATORS = {
-  /** Bitwise AND */
-  AND: '&',
-  /** Bitwise OR */
-  OR: '|',
-  /** Bitwise XOR */
-  XOR: '^',
-  /** Bitwise Shift Left */
-  SHIFT_LEFT: '<<',
-  /** Bitwise Shift Right */
-  SHIFT_RIGHT: '>>'
-} as const;
-
-/**
- * Type representing supported bitwise operators
- */
-export type BitwiseOperator = (typeof BITWISE_OPERATORS)[keyof typeof BITWISE_OPERATORS];
-
-/**
- * Type representing any supported SQL operator
- */
-export type SqlOperator = (typeof SQL_OPERATORS)[keyof typeof SQL_OPERATORS];
-
-/**
- * Types of SQL joins supported
- */
-export const JOIN_KINDS = {
-  /** INNER JOIN type */
-  INNER: 'INNER',
-  /** LEFT JOIN type */
-  LEFT: 'LEFT',
-  /** RIGHT JOIN type */
-  RIGHT: 'RIGHT',
-  /** CROSS JOIN type */
-  CROSS: 'CROSS'
-} as const;
-
-/**
- * Type representing any supported join kind
- */
-export type JoinKind = (typeof JOIN_KINDS)[keyof typeof JOIN_KINDS];
-
-/**
- * Ordering directions for result sorting
- */
-export const ORDER_DIRECTIONS = {
-  /** Ascending order */
-  ASC: 'ASC',
-  /** Descending order */
-  DESC: 'DESC'
-} as const;
-
-/**
- * Type representing any supported order direction
- */
-export type OrderDirection = (typeof ORDER_DIRECTIONS)[keyof typeof ORDER_DIRECTIONS];
-
-/**
- * Supported database dialects
- */
-export const SUPPORTED_DIALECTS = {
-  /** MySQL database dialect */
-  MYSQL: 'mysql',
-  /** SQLite database dialect */
-  SQLITE: 'sqlite',
-  /** Microsoft SQL Server dialect */
-  MSSQL: 'mssql',
-  /** PostgreSQL database dialect */
-  POSTGRES: 'postgres'
-} as const;
-
-/**
- * Type representing any supported database dialect
- */
-export type DialectName = (typeof SUPPORTED_DIALECTS)[keyof typeof SUPPORTED_DIALECTS];
+/**
+ * SQL keywords used in query generation
+ */
+export const SQL_KEYWORDS = {
+  /** SELECT clause keyword */
+  SELECT: 'SELECT',
+  /** FROM clause keyword */
+  FROM: 'FROM',
+  /** WHERE clause keyword */
+  WHERE: 'WHERE',
+  /** JOIN keyword */
+  JOIN: 'JOIN',
+  /** INNER JOIN keyword */
+  INNER_JOIN: 'INNER JOIN',
+  /** LEFT JOIN keyword */
+  LEFT_JOIN: 'LEFT JOIN',
+  /** RIGHT JOIN keyword */
+  RIGHT_JOIN: 'RIGHT JOIN',
+  /** ORDER BY clause keyword */
+  ORDER_BY: 'ORDER BY',
+  /** GROUP BY clause keyword */
+  GROUP_BY: 'GROUP BY',
+  /** HAVING clause keyword */
+  HAVING: 'HAVING',
+  /** DISTINCT keyword */
+  DISTINCT: 'DISTINCT',
+  /** EXISTS operator */
+  EXISTS: 'EXISTS',
+  /** NOT EXISTS operator */
+  NOT_EXISTS: 'NOT EXISTS'
+} as const;
+
+/**
+ * SQL operators used in query conditions
+ */
+export const SQL_OPERATORS = {
+  /** Equality operator */
+  EQUALS: '=',
+  /** Not equals operator */
+  NOT_EQUALS: '!=',
+  /** Greater than operator */
+  GREATER_THAN: '>',
+  /** Greater than or equal operator */
+  GREATER_OR_EQUAL: '>=',
+  /** Less than operator */
+  LESS_THAN: '<',
+  /** Less than or equal operator */
+  LESS_OR_EQUAL: '<=',
+  /** LIKE pattern matching operator */
+  LIKE: 'LIKE',
+  /** NOT LIKE pattern matching operator */
+  NOT_LIKE: 'NOT LIKE',
+  /** IN membership operator */
+  IN: 'IN',
+  /** NOT IN membership operator */
+  NOT_IN: 'NOT IN',
+  /** BETWEEN range operator */
+  BETWEEN: 'BETWEEN',
+  /** NOT BETWEEN range operator */
+  NOT_BETWEEN: 'NOT BETWEEN',
+  /** IS NULL null check operator */
+  IS_NULL: 'IS NULL',
+  /** IS NOT NULL null check operator */
+  IS_NOT_NULL: 'IS NOT NULL',
+  /** Logical AND operator */
+  AND: 'AND',
+  /** Logical OR operator */
+  OR: 'OR',
+  /** EXISTS operator */
+  EXISTS: 'EXISTS',
+  /** NOT EXISTS operator */
+  NOT_EXISTS: 'NOT EXISTS'
+} as const;
+
+/**
+ * SQL bitwise operators
+ */
+export const BITWISE_OPERATORS = {
+  /** Bitwise AND */
+  AND: '&',
+  /** Bitwise OR */
+  OR: '|',
+  /** Bitwise XOR */
+  XOR: '^',
+  /** Bitwise Shift Left */
+  SHIFT_LEFT: '<<',
+  /** Bitwise Shift Right */
+  SHIFT_RIGHT: '>>'
+} as const;
+
+/**
+ * Type representing supported bitwise operators
+ */
+export type BitwiseOperator = (typeof BITWISE_OPERATORS)[keyof typeof BITWISE_OPERATORS];
+
+/**
+ * Type representing any supported SQL operator
+ */
+export type SqlOperator = (typeof SQL_OPERATORS)[keyof typeof SQL_OPERATORS];
+
+/**
+ * Types of SQL joins supported
+ */
+export const JOIN_KINDS = {
+  /** INNER JOIN type */
+  INNER: 'INNER',
+  /** LEFT JOIN type */
+  LEFT: 'LEFT',
+  /** RIGHT JOIN type */
+  RIGHT: 'RIGHT',
+  /** CROSS JOIN type */
+  CROSS: 'CROSS'
+} as const;
+
+/**
+ * Type representing any supported join kind
+ */
+export type JoinKind = (typeof JOIN_KINDS)[keyof typeof JOIN_KINDS];
+
+/**
+ * Ordering directions for result sorting
+ */
+export const ORDER_DIRECTIONS = {
+  /** Ascending order */
+  ASC: 'ASC',
+  /** Descending order */
+  DESC: 'DESC'
+} as const;
+
+/**
+ * Type representing any supported order direction
+ */
+export type OrderDirection = (typeof ORDER_DIRECTIONS)[keyof typeof ORDER_DIRECTIONS];
+
+/**
+ * Supported database dialects
+ */
+export const SUPPORTED_DIALECTS = {
+  /** MySQL database dialect */
+  MYSQL: 'mysql',
+  /** SQLite database dialect */
+  SQLITE: 'sqlite',
+  /** Microsoft SQL Server dialect */
+  MSSQL: 'mssql',
+  /** PostgreSQL database dialect */
+  POSTGRES: 'postgres'
+} as const;
+
+/**
+ * Type representing any supported database dialect
+ */
+export type DialectName = (typeof SUPPORTED_DIALECTS)[keyof typeof SUPPORTED_DIALECTS];