metal-orm 1.1.11 → 1.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (182) hide show
  1. package/README.md +758 -769
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.js.map +1 -1
  4. package/package.json +100 -96
  5. package/scripts/generate-entities/schema.mjs +122 -122
  6. package/scripts/generate-entities/tree-detection.mjs +92 -92
  7. package/scripts/inflection/pt-br.mjs +468 -468
  8. package/scripts/run-eslint.mjs +33 -34
  9. package/scripts/show-sql-seed.sql +102 -0
  10. package/scripts/show-sql.mjs +321 -325
  11. package/src/codegen/naming-strategy.ts +54 -54
  12. package/src/codegen/typescript.ts +482 -482
  13. package/src/core/ast/adapters.ts +1 -1
  14. package/src/core/ast/builders.ts +123 -123
  15. package/src/core/ast/expression-builders.ts +745 -745
  16. package/src/core/ast/expression-nodes.ts +304 -304
  17. package/src/core/ast/expression-visitor.ts +212 -212
  18. package/src/core/ast/expression.ts +20 -20
  19. package/src/core/ast/helpers.ts +14 -14
  20. package/src/core/ast/join.ts +18 -18
  21. package/src/core/ast/query.ts +200 -200
  22. package/src/core/ddl/dialects/base-schema-dialect.ts +1 -1
  23. package/src/core/ddl/dialects/mssql-schema-dialect.ts +1 -1
  24. package/src/core/ddl/dialects/mysql-schema-dialect.ts +1 -1
  25. package/src/core/ddl/dialects/postgres-schema-dialect.ts +1 -1
  26. package/src/core/ddl/dialects/render-reference.test.ts +70 -70
  27. package/src/core/ddl/dialects/sqlite-schema-dialect.ts +1 -1
  28. package/src/core/ddl/introspect/catalogs/index.ts +5 -5
  29. package/src/core/ddl/introspect/catalogs/postgres.ts +146 -146
  30. package/src/core/ddl/introspect/context.ts +15 -15
  31. package/src/core/ddl/introspect/functions/postgres.ts +35 -35
  32. package/src/core/ddl/introspect/registry.ts +40 -40
  33. package/src/core/ddl/introspect/run-select.ts +35 -35
  34. package/src/core/ddl/introspect/utils.ts +56 -56
  35. package/src/core/ddl/naming-strategy.ts +16 -16
  36. package/src/core/ddl/schema-dialect.ts +56 -56
  37. package/src/core/ddl/schema-diff.ts +234 -234
  38. package/src/core/ddl/schema-generator.ts +1 -1
  39. package/src/core/ddl/schema-introspect.ts +25 -25
  40. package/src/core/ddl/sql-writing.ts +171 -171
  41. package/src/core/dialect/abstract.ts +541 -541
  42. package/src/core/dialect/base/cte-compiler.ts +33 -33
  43. package/src/core/dialect/base/function-table-formatter.ts +103 -103
  44. package/src/core/dialect/base/groupby-compiler.ts +21 -21
  45. package/src/core/dialect/base/join-compiler.ts +25 -25
  46. package/src/core/dialect/base/orderby-compiler.ts +35 -35
  47. package/src/core/dialect/base/pagination-strategy.ts +32 -32
  48. package/src/core/dialect/base/returning-strategy.ts +57 -57
  49. package/src/core/dialect/base/sql-dialect.ts +294 -294
  50. package/src/core/dialect/dialect-factory.ts +91 -91
  51. package/src/core/dialect/mssql/functions.ts +120 -120
  52. package/src/core/dialect/mssql/index.ts +317 -317
  53. package/src/core/dialect/mysql/functions.ts +103 -103
  54. package/src/core/dialect/mysql/index.ts +105 -105
  55. package/src/core/dialect/postgres/functions.ts +108 -108
  56. package/src/core/dialect/postgres/index.ts +91 -91
  57. package/src/core/dialect/sqlite/functions.ts +129 -129
  58. package/src/core/dialect/sqlite/index.ts +67 -67
  59. package/src/core/driver/database-driver.ts +19 -19
  60. package/src/core/driver/mssql-driver.ts +23 -23
  61. package/src/core/driver/mysql-driver.ts +23 -23
  62. package/src/core/driver/postgres-driver.ts +23 -23
  63. package/src/core/driver/sqlite-driver.ts +23 -23
  64. package/src/core/execution/db-executor.ts +92 -92
  65. package/src/core/execution/executors/better-sqlite3-executor.ts +90 -90
  66. package/src/core/execution/executors/mssql-executor.ts +184 -184
  67. package/src/core/execution/executors/mysql-executor.ts +88 -88
  68. package/src/core/execution/executors/postgres-executor.ts +26 -26
  69. package/src/core/execution/executors/sqlite-executor.ts +42 -42
  70. package/src/core/execution/pooling/pool-types.ts +30 -30
  71. package/src/core/execution/pooling/pool.ts +275 -275
  72. package/src/core/functions/array.ts +35 -35
  73. package/src/core/functions/control-flow.ts +79 -79
  74. package/src/core/functions/datetime.ts +237 -237
  75. package/src/core/functions/json.ts +70 -70
  76. package/src/core/functions/numeric.ts +297 -297
  77. package/src/core/functions/text.ts +334 -334
  78. package/src/core/functions/types.ts +33 -33
  79. package/src/core/hydration/types.ts +51 -51
  80. package/src/core/sql/sql-operator-config.ts +39 -39
  81. package/src/core/sql/sql.ts +152 -152
  82. package/src/decorators/column-decorator.ts +87 -87
  83. package/src/decorators/decorator-metadata.ts +143 -143
  84. package/src/decorators/entity.ts +93 -93
  85. package/src/decorators/index.ts +39 -39
  86. package/src/decorators/relations.ts +231 -231
  87. package/src/decorators/transformers/built-in/string-transformers.ts +231 -231
  88. package/src/decorators/transformers/transformer-decorators.ts +134 -134
  89. package/src/decorators/transformers/transformer-executor.ts +171 -171
  90. package/src/decorators/transformers/transformer-metadata.ts +73 -73
  91. package/src/decorators/validators/built-in/br-cep-validator.ts +55 -55
  92. package/src/decorators/validators/built-in/br-cnpj-validator.ts +105 -105
  93. package/src/decorators/validators/built-in/br-cpf-validator.ts +103 -103
  94. package/src/decorators/validators/country-validator-registry.ts +64 -64
  95. package/src/decorators/validators/country-validators-decorators.ts +203 -203
  96. package/src/decorators/validators/country-validators.ts +105 -105
  97. package/src/decorators/validators/validator-metadata.ts +59 -59
  98. package/src/dto/dto-types.ts +226 -226
  99. package/src/dto/filter-types.ts +141 -141
  100. package/src/dto/index.ts +95 -95
  101. package/src/dto/openapi/generators/base.ts +29 -29
  102. package/src/dto/openapi/generators/column.ts +37 -37
  103. package/src/dto/openapi/generators/dto.ts +91 -91
  104. package/src/dto/openapi/generators/filter.ts +75 -75
  105. package/src/dto/openapi/generators/nested-dto.ts +618 -618
  106. package/src/dto/openapi/generators/pagination.ts +111 -111
  107. package/src/dto/openapi/generators/relation-filter.ts +228 -228
  108. package/src/dto/openapi/index.ts +12 -12
  109. package/src/dto/openapi/types.ts +101 -101
  110. package/src/dto/openapi/utilities.ts +95 -95
  111. package/src/dto/pagination-utils.ts +150 -150
  112. package/src/dto/transform.ts +197 -197
  113. package/src/index.ts +86 -86
  114. package/src/orm/als.ts +58 -58
  115. package/src/orm/domain-event-bus.ts +119 -119
  116. package/src/orm/entity-context.ts +86 -86
  117. package/src/orm/entity-materializer.ts +159 -159
  118. package/src/orm/entity-meta.ts +97 -97
  119. package/src/orm/entity-registry.ts +39 -39
  120. package/src/orm/entity-relation-cache.ts +39 -39
  121. package/src/orm/execute.ts +194 -194
  122. package/src/orm/execution-context.ts +18 -18
  123. package/src/orm/hydration-context.ts +26 -26
  124. package/src/orm/hydration.ts +112 -112
  125. package/src/orm/identity-map.ts +61 -61
  126. package/src/orm/interceptor-pipeline.ts +16 -16
  127. package/src/orm/lazy-batch/belongs-to-many.ts +119 -119
  128. package/src/orm/lazy-batch/belongs-to.ts +108 -108
  129. package/src/orm/lazy-batch/has-many.ts +69 -69
  130. package/src/orm/lazy-batch/has-one.ts +68 -68
  131. package/src/orm/lazy-batch/shared.ts +125 -125
  132. package/src/orm/orm-session.ts +620 -620
  133. package/src/orm/orm.ts +34 -34
  134. package/src/orm/pooled-executor-factory.ts +121 -121
  135. package/src/orm/query-logger.ts +40 -40
  136. package/src/orm/relation-change-processor.ts +420 -420
  137. package/src/orm/relations/belongs-to.ts +143 -143
  138. package/src/orm/relations/has-many.ts +204 -204
  139. package/src/orm/relations/has-one.ts +174 -174
  140. package/src/orm/relations/many-to-many.ts +288 -288
  141. package/src/orm/relations/morph-many.ts +156 -156
  142. package/src/orm/relations/morph-one.ts +151 -151
  143. package/src/orm/relations/morph-to.ts +162 -162
  144. package/src/orm/runtime-types.ts +92 -92
  145. package/src/orm/save-graph.ts +561 -561
  146. package/src/orm/transaction-runner.ts +24 -24
  147. package/src/orm/unit-of-work.ts +426 -426
  148. package/src/query/index.ts +69 -69
  149. package/src/query/target.ts +46 -46
  150. package/src/query-builder/column-selector.ts +81 -81
  151. package/src/query-builder/delete.ts +141 -141
  152. package/src/query-builder/insert-query-state.ts +149 -149
  153. package/src/query-builder/insert.ts +117 -117
  154. package/src/query-builder/query-ast-service.ts +287 -287
  155. package/src/query-builder/query-resolution.ts +78 -78
  156. package/src/query-builder/raw-column-parser.ts +38 -38
  157. package/src/query-builder/relation-filter-utils.ts +153 -153
  158. package/src/query-builder/relation-join-planner.ts +10 -10
  159. package/src/query-builder/relation-manager.ts +87 -87
  160. package/src/query-builder/relation-projection-helper.ts +102 -102
  161. package/src/query-builder/relation-types.ts +9 -9
  162. package/src/query-builder/relation-utils.ts +15 -15
  163. package/src/query-builder/select/cte-facet.ts +40 -40
  164. package/src/query-builder/select/from-facet.ts +80 -80
  165. package/src/query-builder/select/join-facet.ts +62 -62
  166. package/src/query-builder/select/predicate-facet.ts +104 -104
  167. package/src/query-builder/select/projection-facet.ts +70 -70
  168. package/src/query-builder/select/relation-facet.ts +81 -81
  169. package/src/query-builder/select/setop-facet.ts +36 -36
  170. package/src/query-builder/select-helpers.ts +1 -1
  171. package/src/query-builder/select-query-builder-deps.ts +130 -130
  172. package/src/query-builder/select-query-state.ts +207 -207
  173. package/src/query-builder/update.ts +151 -151
  174. package/src/schema/column-types.ts +322 -322
  175. package/src/schema/table-guards.ts +37 -37
  176. package/src/schema/table.ts +281 -281
  177. package/src/tree/index.ts +13 -13
  178. package/src/tree/nested-set-strategy.ts +545 -545
  179. package/src/tree/tree-decorator.ts +397 -397
  180. package/src/tree/tree-manager.ts +754 -754
  181. package/src/tree/tree-query.ts +427 -427
  182. package/src/tree/tree-types.ts +299 -299
@@ -1,79 +1,79 @@
1
- // Pure AST Builders - No Dialect Logic Here!
2
-
3
- import { ColumnDef } from '../../schema/column-types.js';
4
- import { columnOperand, valueToOperand } from '../ast/expression-builders.js';
5
- import { FunctionNode, OperandNode, isOperandNode, TypedExpression, asType } from '../ast/expression.js';
6
-
7
- type OperandInput = OperandNode | ColumnDef | string | number | boolean | null;
8
-
9
- const isColumnDef = (val: unknown): val is ColumnDef => !!val && typeof val === 'object' && 'type' in val && 'name' in val;
10
-
11
- const toOperand = (input: OperandInput): OperandNode => {
12
- if (isOperandNode(input)) return input;
13
- if (isColumnDef(input)) return columnOperand(input);
14
-
15
- return valueToOperand(input);
16
- };
17
-
18
- const fn = (key: string, args: OperandInput[]): FunctionNode => ({
19
- type: 'Function',
20
- name: key,
21
- fn: key,
22
- args: args.map(toOperand)
23
- });
24
-
25
- const afn = <T = unknown>(key: string, args: OperandInput[]): TypedExpression<T> => asType<T>(fn(key, args));
26
-
27
- /**
28
- * Returns the first non-null value in a list.
29
- *
30
- * @param args - The list of values or columns to check.
31
- * @returns A `TypedExpression<T>` representing the `COALESCE` SQL function.
32
- *
33
- * @example
34
- * coalesce(users.nickname, users.firstName, 'Guest');
35
- */
36
- export const coalesce = <T = unknown>(...args: OperandInput[]): TypedExpression<T> => {
37
- if (args.length < 2) throw new Error('coalesce() expects at least 2 arguments');
38
- return afn<T>('COALESCE', args);
39
- };
40
-
41
- /**
42
- * Returns null if the two arguments are equal, otherwise returns the first argument.
43
- *
44
- * @param val1 - The first value.
45
- * @param val2 - The second value to compare against.
46
- * @returns A `TypedExpression<T>` representing the `NULLIF` SQL function.
47
- */
48
- export const nullif = <T = unknown>(val1: OperandInput, val2: OperandInput): TypedExpression<T> => afn<T>('NULLIF', [val1, val2]);
49
-
50
- /**
51
- * Returns the largest value in a list.
52
- *
53
- * @param args - The list of values or columns to compare.
54
- * @returns A `TypedExpression<T>` representing the `GREATEST` SQL function.
55
- */
56
- export const greatest = <T = unknown>(...args: OperandInput[]): TypedExpression<T> => {
57
- if (args.length < 2) throw new Error('greatest() expects at least 2 arguments');
58
- return afn<T>('GREATEST', args);
59
- };
60
-
61
- /**
62
- * Returns the smallest value in a list.
63
- *
64
- * @param args - The list of values or columns to compare.
65
- * @returns A `TypedExpression<T>` representing the `LEAST` SQL function.
66
- */
67
- export const least = <T = unknown>(...args: OperandInput[]): TypedExpression<T> => {
68
- if (args.length < 2) throw new Error('least() expects at least 2 arguments');
69
- return afn<T>('LEAST', args);
70
- };
71
-
72
- /**
73
- * Returns the first argument if it is not null, otherwise returns the second argument.
74
- *
75
- * @param val - The value to check.
76
- * @param defaultValue - The default value to return if val is null.
77
- * @returns A `TypedExpression<T>` representing the `COALESCE` SQL function.
78
- */
79
- export const ifNull = <T = unknown>(val: OperandInput, defaultValue: OperandInput): TypedExpression<T> => coalesce<T>(val, defaultValue);
1
+ // Pure AST Builders - No Dialect Logic Here!
2
+
3
+ import { ColumnDef } from '../../schema/column-types.js';
4
+ import { columnOperand, valueToOperand } from '../ast/expression-builders.js';
5
+ import { FunctionNode, OperandNode, isOperandNode, TypedExpression, asType } from '../ast/expression.js';
6
+
7
+ type OperandInput = OperandNode | ColumnDef | string | number | boolean | null;
8
+
9
+ const isColumnDef = (val: unknown): val is ColumnDef => !!val && typeof val === 'object' && 'type' in val && 'name' in val;
10
+
11
+ const toOperand = (input: OperandInput): OperandNode => {
12
+ if (isOperandNode(input)) return input;
13
+ if (isColumnDef(input)) return columnOperand(input);
14
+
15
+ return valueToOperand(input);
16
+ };
17
+
18
+ const fn = (key: string, args: OperandInput[]): FunctionNode => ({
19
+ type: 'Function',
20
+ name: key,
21
+ fn: key,
22
+ args: args.map(toOperand)
23
+ });
24
+
25
+ const afn = <T = unknown>(key: string, args: OperandInput[]): TypedExpression<T> => asType<T>(fn(key, args));
26
+
27
+ /**
28
+ * Returns the first non-null value in a list.
29
+ *
30
+ * @param args - The list of values or columns to check.
31
+ * @returns A `TypedExpression<T>` representing the `COALESCE` SQL function.
32
+ *
33
+ * @example
34
+ * coalesce(users.nickname, users.firstName, 'Guest');
35
+ */
36
+ export const coalesce = <T = unknown>(...args: OperandInput[]): TypedExpression<T> => {
37
+ if (args.length < 2) throw new Error('coalesce() expects at least 2 arguments');
38
+ return afn<T>('COALESCE', args);
39
+ };
40
+
41
+ /**
42
+ * Returns null if the two arguments are equal, otherwise returns the first argument.
43
+ *
44
+ * @param val1 - The first value.
45
+ * @param val2 - The second value to compare against.
46
+ * @returns A `TypedExpression<T>` representing the `NULLIF` SQL function.
47
+ */
48
+ export const nullif = <T = unknown>(val1: OperandInput, val2: OperandInput): TypedExpression<T> => afn<T>('NULLIF', [val1, val2]);
49
+
50
+ /**
51
+ * Returns the largest value in a list.
52
+ *
53
+ * @param args - The list of values or columns to compare.
54
+ * @returns A `TypedExpression<T>` representing the `GREATEST` SQL function.
55
+ */
56
+ export const greatest = <T = unknown>(...args: OperandInput[]): TypedExpression<T> => {
57
+ if (args.length < 2) throw new Error('greatest() expects at least 2 arguments');
58
+ return afn<T>('GREATEST', args);
59
+ };
60
+
61
+ /**
62
+ * Returns the smallest value in a list.
63
+ *
64
+ * @param args - The list of values or columns to compare.
65
+ * @returns A `TypedExpression<T>` representing the `LEAST` SQL function.
66
+ */
67
+ export const least = <T = unknown>(...args: OperandInput[]): TypedExpression<T> => {
68
+ if (args.length < 2) throw new Error('least() expects at least 2 arguments');
69
+ return afn<T>('LEAST', args);
70
+ };
71
+
72
+ /**
73
+ * Returns the first argument if it is not null, otherwise returns the second argument.
74
+ *
75
+ * @param val - The value to check.
76
+ * @param defaultValue - The default value to return if val is null.
77
+ * @returns A `TypedExpression<T>` representing the `COALESCE` SQL function.
78
+ */
79
+ export const ifNull = <T = unknown>(val: OperandInput, defaultValue: OperandInput): TypedExpression<T> => coalesce<T>(val, defaultValue);
@@ -1,237 +1,237 @@
1
- // Pure AST Builders - No Dialect Logic Here!
2
-
3
- import { ColumnDef } from '../../schema/column-types.js';
4
- import { columnOperand, valueToOperand } from '../ast/expression-builders.js';
5
- import { FunctionNode, OperandNode, isOperandNode, TypedExpression, asType } from '../ast/expression.js';
6
-
7
- type OperandInput = OperandNode | ColumnDef | string | number | boolean | null;
8
-
9
- const isColumnDef = (val: unknown): val is ColumnDef => !!val && typeof val === 'object' && 'type' in val && 'name' in val;
10
-
11
- const toOperand = (input: OperandInput): OperandNode => {
12
- if (isOperandNode(input)) return input;
13
- if (isColumnDef(input)) return columnOperand(input);
14
-
15
- return valueToOperand(input);
16
- };
17
-
18
- const fn = (key: string, args: OperandInput[]): FunctionNode => ({
19
- type: 'Function',
20
- name: key,
21
- fn: key,
22
- args: args.map(toOperand)
23
- });
24
-
25
- const dfn = (key: string, args: OperandInput[]): TypedExpression<Date> => asType<Date>(fn(key, args));
26
- const nfn = (key: string, args: OperandInput[]): TypedExpression<number> => asType<number>(fn(key, args));
27
- const sfn = (key: string, args: OperandInput[]): TypedExpression<string> => asType<string>(fn(key, args));
28
-
29
- // ----------------------
30
- // Helper Functions
31
- // ----------------------
32
-
33
- /**
34
- * Returns the current local date and time.
35
- *
36
- * @returns A `TypedExpression<Date>` representing the `NOW()` SQL function.
37
- */
38
- export const now = (): TypedExpression<Date> => dfn('NOW', []);
39
-
40
- /**
41
- * Returns the current date (without time).
42
- *
43
- * @returns A `TypedExpression<Date>` representing the `CURRENT_DATE` SQL function.
44
- */
45
- export const currentDate = (): TypedExpression<Date> => dfn('CURRENT_DATE', []);
46
-
47
- /**
48
- * Returns the current time (without date).
49
- *
50
- * @returns A `TypedExpression<Date>` representing the `CURRENT_TIME` SQL function.
51
- */
52
- export const currentTime = (): TypedExpression<Date> => dfn('CURRENT_TIME', []);
53
-
54
- /**
55
- * Returns the current UTC date and time.
56
- *
57
- * @returns A `TypedExpression<Date>` representing the `UTC_NOW()` SQL function.
58
- */
59
- export const utcNow = (): TypedExpression<Date> => dfn('UTC_NOW', []);
60
-
61
- /**
62
- * Returns the current local time.
63
- *
64
- * @returns A `TypedExpression<Date>` representing the `LOCALTIME` SQL function.
65
- */
66
- export const localTime = (): TypedExpression<Date> => dfn('LOCALTIME', []);
67
-
68
- /**
69
- * Returns the current local timestamp.
70
- *
71
- * @returns A `TypedExpression<Date>` representing the `LOCALTIMESTAMP` SQL function.
72
- */
73
- export const localTimestamp = (): TypedExpression<Date> => dfn('LOCALTIMESTAMP', []);
74
-
75
- /**
76
- * Extracts a specified part from a date or datetime value.
77
- *
78
- * @param part - The date part to extract (e.g., 'YEAR', 'MONTH', 'DAY').
79
- * @param date - The date/datetime value or column.
80
- * @returns A `TypedExpression<number>` representing the `EXTRACT` SQL function.
81
- */
82
- export const extract = (part: OperandInput, date: OperandInput): TypedExpression<number> => nfn('EXTRACT', [part, date]);
83
-
84
- /**
85
- * Extracts the year from a date or datetime value.
86
- *
87
- * @param date - The date value.
88
- * @returns A `TypedExpression<number>` representing the `YEAR` SQL function.
89
- */
90
- export const year = (date: OperandInput): TypedExpression<number> => nfn('YEAR', [date]);
91
-
92
- /**
93
- * Extracts the month from a date or datetime value.
94
- *
95
- * @param date - The date value.
96
- * @returns A `TypedExpression<number>` representing the `MONTH` SQL function.
97
- */
98
- export const month = (date: OperandInput): TypedExpression<number> => nfn('MONTH', [date]);
99
-
100
- /**
101
- * Extracts the day of the month from a date or datetime value.
102
- *
103
- * @param date - The date value.
104
- * @returns A `TypedExpression<number>` representing the `DAY` SQL function.
105
- */
106
- export const day = (date: OperandInput): TypedExpression<number> => nfn('DAY', [date]);
107
-
108
- /**
109
- * Adds a specified time interval to a date or datetime value.
110
- *
111
- * @param date - The base date.
112
- * @param interval - The numeric interval to add.
113
- * @param unit - The unit (e.g., 'DAY', 'MONTH').
114
- * @returns A `TypedExpression<Date>` representing the `DATE_ADD` SQL function.
115
- */
116
- export const dateAdd = (date: OperandInput, interval: OperandInput, unit: OperandInput): TypedExpression<Date> =>
117
- dfn('DATE_ADD', [date, interval, unit]);
118
-
119
- /**
120
- * Subtracts a specified time interval from a date or datetime value.
121
- *
122
- * @param date - The base date.
123
- * @param interval - The numeric interval to subtract.
124
- * @param unit - The unit (e.g., 'DAY', 'MONTH').
125
- * @returns A `TypedExpression<Date>` representing the `DATE_SUB` SQL function.
126
- */
127
- export const dateSub = (date: OperandInput, interval: OperandInput, unit: OperandInput): TypedExpression<Date> =>
128
- dfn('DATE_SUB', [date, interval, unit]);
129
-
130
- /**
131
- * Returns the difference between two dates in days.
132
- *
133
- * @param date1 - End date.
134
- * @param date2 - Start date.
135
- * @returns A `TypedExpression<number>` representing the `DATE_DIFF` SQL function.
136
- */
137
- export const dateDiff = (date1: OperandInput, date2: OperandInput): TypedExpression<number> => nfn('DATE_DIFF', [date1, date2]);
138
-
139
- /**
140
- * Converts a date or datetime value to a formatted string.
141
- *
142
- * @param date - The date value.
143
- * @param format - Dialect-specific format string.
144
- * @returns A `TypedExpression<string>` representing the `DATE_FORMAT` SQL function.
145
- */
146
- export const dateFormat = (date: OperandInput, format: OperandInput): TypedExpression<string> => sfn('DATE_FORMAT', [date, format]);
147
-
148
- /**
149
- * Returns the current Unix timestamp (seconds since epoch).
150
- *
151
- * @returns A `TypedExpression<number>` representing the `UNIX_TIMESTAMP` SQL function.
152
- */
153
- export const unixTimestamp = (): TypedExpression<number> => nfn('UNIX_TIMESTAMP', []);
154
-
155
- /**
156
- * Converts a Unix timestamp to a Date.
157
- *
158
- * @param timestamp - Seconds since epoch.
159
- * @returns A `TypedExpression<Date>` representing the `FROM_UNIXTIME` SQL function.
160
- */
161
- export const fromUnixTime = (timestamp: OperandInput): TypedExpression<Date> => dfn('FROM_UNIXTIME', [timestamp]);
162
-
163
- /**
164
- * Returns the last day of the month for a given date.
165
- *
166
- * @param date - The date value.
167
- * @returns A `TypedExpression<Date>` representing the `END_OF_MONTH` SQL function.
168
- */
169
- export const endOfMonth = (date: OperandInput): TypedExpression<Date> => dfn('END_OF_MONTH', [date]);
170
-
171
- /**
172
- * Returns the index of the weekday for a given date (1 = Sunday, 2 = Monday, etc.).
173
- *
174
- * @param date - The date value.
175
- * @returns A `TypedExpression<number>` representing the `DAY_OF_WEEK` SQL function.
176
- */
177
- export const dayOfWeek = (date: OperandInput): TypedExpression<number> => nfn('DAY_OF_WEEK', [date]);
178
-
179
- /**
180
- * Returns the week number of the year for a given date.
181
- *
182
- * @param date - The date value.
183
- * @returns A `TypedExpression<number>` representing the `WEEK_OF_YEAR` SQL function.
184
- */
185
- export const weekOfYear = (date: OperandInput): TypedExpression<number> => nfn('WEEK_OF_YEAR', [date]);
186
-
187
- /**
188
- * Truncates a date or datetime value to a specified precision.
189
- *
190
- * @param part - The precision (e.g., 'YEAR', 'MONTH').
191
- * @param date - The date to truncate.
192
- * @returns A `TypedExpression<Date>` representing the `DATE_TRUNC` SQL function.
193
- */
194
- export const dateTrunc = (part: OperandInput, date: OperandInput): TypedExpression<Date> => dfn('DATE_TRUNC', [part, date]);
195
-
196
- /**
197
- * Returns the difference between two timestamps as an interval string.
198
- *
199
- * @param timestamp - End timestamp.
200
- * @param baseTimestamp - Optional start timestamp.
201
- * @returns A `TypedExpression<string>` representing the `AGE` SQL function.
202
- */
203
- export const age = (timestamp: OperandInput, baseTimestamp?: OperandInput): TypedExpression<string> =>
204
- baseTimestamp === undefined ? sfn('AGE', [timestamp]) : sfn('AGE', [timestamp, baseTimestamp]);
205
-
206
- /**
207
- * Extracts the hour from a date or datetime value.
208
- *
209
- * @param date - The date value.
210
- * @returns A `TypedExpression<number>` representing the `HOUR` SQL function.
211
- */
212
- export const hour = (date: OperandInput): TypedExpression<number> => nfn('HOUR', [date]);
213
-
214
- /**
215
- * Extracts the minute from a date or datetime value.
216
- *
217
- * @param date - The date value.
218
- * @returns A `TypedExpression<number>` representing the `MINUTE` SQL function.
219
- */
220
- export const minute = (date: OperandInput): TypedExpression<number> => nfn('MINUTE', [date]);
221
-
222
- /**
223
- * Extracts the second from a date or datetime value.
224
- *
225
- * @param date - The date value.
226
- * @returns A `TypedExpression<number>` representing the `SECOND` SQL function.
227
- */
228
- export const second = (date: OperandInput): TypedExpression<number> => nfn('SECOND', [date]);
229
-
230
- /**
231
- * Extracts the quarter from a date or datetime value (1-4).
232
- *
233
- * @param date - The date value.
234
- * @returns A `TypedExpression<number>` representing the `QUARTER` SQL function.
235
- */
236
- export const quarter = (date: OperandInput): TypedExpression<number> => nfn('QUARTER', [date]);
237
-
1
+ // Pure AST Builders - No Dialect Logic Here!
2
+
3
+ import { ColumnDef } from '../../schema/column-types.js';
4
+ import { columnOperand, valueToOperand } from '../ast/expression-builders.js';
5
+ import { FunctionNode, OperandNode, isOperandNode, TypedExpression, asType } from '../ast/expression.js';
6
+
7
+ type OperandInput = OperandNode | ColumnDef | string | number | boolean | null;
8
+
9
+ const isColumnDef = (val: unknown): val is ColumnDef => !!val && typeof val === 'object' && 'type' in val && 'name' in val;
10
+
11
+ const toOperand = (input: OperandInput): OperandNode => {
12
+ if (isOperandNode(input)) return input;
13
+ if (isColumnDef(input)) return columnOperand(input);
14
+
15
+ return valueToOperand(input);
16
+ };
17
+
18
+ const fn = (key: string, args: OperandInput[]): FunctionNode => ({
19
+ type: 'Function',
20
+ name: key,
21
+ fn: key,
22
+ args: args.map(toOperand)
23
+ });
24
+
25
+ const dfn = (key: string, args: OperandInput[]): TypedExpression<Date> => asType<Date>(fn(key, args));
26
+ const nfn = (key: string, args: OperandInput[]): TypedExpression<number> => asType<number>(fn(key, args));
27
+ const sfn = (key: string, args: OperandInput[]): TypedExpression<string> => asType<string>(fn(key, args));
28
+
29
+ // ----------------------
30
+ // Helper Functions
31
+ // ----------------------
32
+
33
+ /**
34
+ * Returns the current local date and time.
35
+ *
36
+ * @returns A `TypedExpression<Date>` representing the `NOW()` SQL function.
37
+ */
38
+ export const now = (): TypedExpression<Date> => dfn('NOW', []);
39
+
40
+ /**
41
+ * Returns the current date (without time).
42
+ *
43
+ * @returns A `TypedExpression<Date>` representing the `CURRENT_DATE` SQL function.
44
+ */
45
+ export const currentDate = (): TypedExpression<Date> => dfn('CURRENT_DATE', []);
46
+
47
+ /**
48
+ * Returns the current time (without date).
49
+ *
50
+ * @returns A `TypedExpression<Date>` representing the `CURRENT_TIME` SQL function.
51
+ */
52
+ export const currentTime = (): TypedExpression<Date> => dfn('CURRENT_TIME', []);
53
+
54
+ /**
55
+ * Returns the current UTC date and time.
56
+ *
57
+ * @returns A `TypedExpression<Date>` representing the `UTC_NOW()` SQL function.
58
+ */
59
+ export const utcNow = (): TypedExpression<Date> => dfn('UTC_NOW', []);
60
+
61
+ /**
62
+ * Returns the current local time.
63
+ *
64
+ * @returns A `TypedExpression<Date>` representing the `LOCALTIME` SQL function.
65
+ */
66
+ export const localTime = (): TypedExpression<Date> => dfn('LOCALTIME', []);
67
+
68
+ /**
69
+ * Returns the current local timestamp.
70
+ *
71
+ * @returns A `TypedExpression<Date>` representing the `LOCALTIMESTAMP` SQL function.
72
+ */
73
+ export const localTimestamp = (): TypedExpression<Date> => dfn('LOCALTIMESTAMP', []);
74
+
75
+ /**
76
+ * Extracts a specified part from a date or datetime value.
77
+ *
78
+ * @param part - The date part to extract (e.g., 'YEAR', 'MONTH', 'DAY').
79
+ * @param date - The date/datetime value or column.
80
+ * @returns A `TypedExpression<number>` representing the `EXTRACT` SQL function.
81
+ */
82
+ export const extract = (part: OperandInput, date: OperandInput): TypedExpression<number> => nfn('EXTRACT', [part, date]);
83
+
84
+ /**
85
+ * Extracts the year from a date or datetime value.
86
+ *
87
+ * @param date - The date value.
88
+ * @returns A `TypedExpression<number>` representing the `YEAR` SQL function.
89
+ */
90
+ export const year = (date: OperandInput): TypedExpression<number> => nfn('YEAR', [date]);
91
+
92
+ /**
93
+ * Extracts the month from a date or datetime value.
94
+ *
95
+ * @param date - The date value.
96
+ * @returns A `TypedExpression<number>` representing the `MONTH` SQL function.
97
+ */
98
+ export const month = (date: OperandInput): TypedExpression<number> => nfn('MONTH', [date]);
99
+
100
+ /**
101
+ * Extracts the day of the month from a date or datetime value.
102
+ *
103
+ * @param date - The date value.
104
+ * @returns A `TypedExpression<number>` representing the `DAY` SQL function.
105
+ */
106
+ export const day = (date: OperandInput): TypedExpression<number> => nfn('DAY', [date]);
107
+
108
+ /**
109
+ * Adds a specified time interval to a date or datetime value.
110
+ *
111
+ * @param date - The base date.
112
+ * @param interval - The numeric interval to add.
113
+ * @param unit - The unit (e.g., 'DAY', 'MONTH').
114
+ * @returns A `TypedExpression<Date>` representing the `DATE_ADD` SQL function.
115
+ */
116
+ export const dateAdd = (date: OperandInput, interval: OperandInput, unit: OperandInput): TypedExpression<Date> =>
117
+ dfn('DATE_ADD', [date, interval, unit]);
118
+
119
+ /**
120
+ * Subtracts a specified time interval from a date or datetime value.
121
+ *
122
+ * @param date - The base date.
123
+ * @param interval - The numeric interval to subtract.
124
+ * @param unit - The unit (e.g., 'DAY', 'MONTH').
125
+ * @returns A `TypedExpression<Date>` representing the `DATE_SUB` SQL function.
126
+ */
127
+ export const dateSub = (date: OperandInput, interval: OperandInput, unit: OperandInput): TypedExpression<Date> =>
128
+ dfn('DATE_SUB', [date, interval, unit]);
129
+
130
+ /**
131
+ * Returns the difference between two dates in days.
132
+ *
133
+ * @param date1 - End date.
134
+ * @param date2 - Start date.
135
+ * @returns A `TypedExpression<number>` representing the `DATE_DIFF` SQL function.
136
+ */
137
+ export const dateDiff = (date1: OperandInput, date2: OperandInput): TypedExpression<number> => nfn('DATE_DIFF', [date1, date2]);
138
+
139
+ /**
140
+ * Converts a date or datetime value to a formatted string.
141
+ *
142
+ * @param date - The date value.
143
+ * @param format - Dialect-specific format string.
144
+ * @returns A `TypedExpression<string>` representing the `DATE_FORMAT` SQL function.
145
+ */
146
+ export const dateFormat = (date: OperandInput, format: OperandInput): TypedExpression<string> => sfn('DATE_FORMAT', [date, format]);
147
+
148
+ /**
149
+ * Returns the current Unix timestamp (seconds since epoch).
150
+ *
151
+ * @returns A `TypedExpression<number>` representing the `UNIX_TIMESTAMP` SQL function.
152
+ */
153
+ export const unixTimestamp = (): TypedExpression<number> => nfn('UNIX_TIMESTAMP', []);
154
+
155
+ /**
156
+ * Converts a Unix timestamp to a Date.
157
+ *
158
+ * @param timestamp - Seconds since epoch.
159
+ * @returns A `TypedExpression<Date>` representing the `FROM_UNIXTIME` SQL function.
160
+ */
161
+ export const fromUnixTime = (timestamp: OperandInput): TypedExpression<Date> => dfn('FROM_UNIXTIME', [timestamp]);
162
+
163
+ /**
164
+ * Returns the last day of the month for a given date.
165
+ *
166
+ * @param date - The date value.
167
+ * @returns A `TypedExpression<Date>` representing the `END_OF_MONTH` SQL function.
168
+ */
169
+ export const endOfMonth = (date: OperandInput): TypedExpression<Date> => dfn('END_OF_MONTH', [date]);
170
+
171
+ /**
172
+ * Returns the index of the weekday for a given date (1 = Sunday, 2 = Monday, etc.).
173
+ *
174
+ * @param date - The date value.
175
+ * @returns A `TypedExpression<number>` representing the `DAY_OF_WEEK` SQL function.
176
+ */
177
+ export const dayOfWeek = (date: OperandInput): TypedExpression<number> => nfn('DAY_OF_WEEK', [date]);
178
+
179
+ /**
180
+ * Returns the week number of the year for a given date.
181
+ *
182
+ * @param date - The date value.
183
+ * @returns A `TypedExpression<number>` representing the `WEEK_OF_YEAR` SQL function.
184
+ */
185
+ export const weekOfYear = (date: OperandInput): TypedExpression<number> => nfn('WEEK_OF_YEAR', [date]);
186
+
187
+ /**
188
+ * Truncates a date or datetime value to a specified precision.
189
+ *
190
+ * @param part - The precision (e.g., 'YEAR', 'MONTH').
191
+ * @param date - The date to truncate.
192
+ * @returns A `TypedExpression<Date>` representing the `DATE_TRUNC` SQL function.
193
+ */
194
+ export const dateTrunc = (part: OperandInput, date: OperandInput): TypedExpression<Date> => dfn('DATE_TRUNC', [part, date]);
195
+
196
+ /**
197
+ * Returns the difference between two timestamps as an interval string.
198
+ *
199
+ * @param timestamp - End timestamp.
200
+ * @param baseTimestamp - Optional start timestamp.
201
+ * @returns A `TypedExpression<string>` representing the `AGE` SQL function.
202
+ */
203
+ export const age = (timestamp: OperandInput, baseTimestamp?: OperandInput): TypedExpression<string> =>
204
+ baseTimestamp === undefined ? sfn('AGE', [timestamp]) : sfn('AGE', [timestamp, baseTimestamp]);
205
+
206
+ /**
207
+ * Extracts the hour from a date or datetime value.
208
+ *
209
+ * @param date - The date value.
210
+ * @returns A `TypedExpression<number>` representing the `HOUR` SQL function.
211
+ */
212
+ export const hour = (date: OperandInput): TypedExpression<number> => nfn('HOUR', [date]);
213
+
214
+ /**
215
+ * Extracts the minute from a date or datetime value.
216
+ *
217
+ * @param date - The date value.
218
+ * @returns A `TypedExpression<number>` representing the `MINUTE` SQL function.
219
+ */
220
+ export const minute = (date: OperandInput): TypedExpression<number> => nfn('MINUTE', [date]);
221
+
222
+ /**
223
+ * Extracts the second from a date or datetime value.
224
+ *
225
+ * @param date - The date value.
226
+ * @returns A `TypedExpression<number>` representing the `SECOND` SQL function.
227
+ */
228
+ export const second = (date: OperandInput): TypedExpression<number> => nfn('SECOND', [date]);
229
+
230
+ /**
231
+ * Extracts the quarter from a date or datetime value (1-4).
232
+ *
233
+ * @param date - The date value.
234
+ * @returns A `TypedExpression<number>` representing the `QUARTER` SQL function.
235
+ */
236
+ export const quarter = (date: OperandInput): TypedExpression<number> => nfn('QUARTER', [date]);
237
+