postgrelize 0.0.0-stage → 1.1.0

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 (319) hide show
  1. package/CHANGELOG.md +289 -0
  2. package/LICENSE +21 -0
  3. package/README.md +131 -2
  4. package/dist/associations/alias-minifier.d.ts +43 -0
  5. package/dist/associations/association-accessors.d.ts +21 -0
  6. package/dist/associations/association-key-types.d.ts +44 -0
  7. package/dist/associations/association-keys.d.ts +98 -0
  8. package/dist/associations/association-lookup.d.ts +26 -0
  9. package/dist/associations/association-shape.d.ts +25 -0
  10. package/dist/associations/association.d.ts +95 -0
  11. package/dist/associations/belongs-to-many.d.ts +86 -0
  12. package/dist/associations/belongs-to.d.ts +45 -0
  13. package/dist/associations/has-many.d.ts +79 -0
  14. package/dist/associations/has-one.d.ts +44 -0
  15. package/dist/associations/include-assembler.d.ts +21 -0
  16. package/dist/associations/include-columns.d.ts +24 -0
  17. package/dist/associations/include-joins.d.ts +17 -0
  18. package/dist/associations/include-loader.d.ts +48 -0
  19. package/dist/associations/include-order.d.ts +22 -0
  20. package/dist/associations/include-query-builder.d.ts +54 -0
  21. package/dist/associations/include-resolver.d.ts +29 -0
  22. package/dist/associations/include-rows.d.ts +47 -0
  23. package/dist/associations/include-sub-query.d.ts +35 -0
  24. package/dist/associations/include.d.ts +112 -0
  25. package/dist/associations/junction-keys.d.ts +23 -0
  26. package/dist/associations/nested-creator.d.ts +44 -0
  27. package/dist/associations/nested-saver.d.ts +30 -0
  28. package/dist/associations/owner-keys.d.ts +34 -0
  29. package/dist/associations/separate-include-loader.d.ts +24 -0
  30. package/dist/associations/types.d.ts +139 -0
  31. package/dist/connection/after-connect-hook.d.ts +24 -0
  32. package/dist/connection/connect-hooks.d.ts +26 -0
  33. package/dist/connection/connection-config.d.ts +33 -0
  34. package/dist/connection/connection-manager.d.ts +65 -0
  35. package/dist/connection/connection-types.d.ts +21 -0
  36. package/dist/connection/copy-from-stdin.d.ts +52 -0
  37. package/dist/connection/copy-runner.d.ts +30 -0
  38. package/dist/connection/copy-to-stdout.d.ts +49 -0
  39. package/dist/connection/copy.d.ts +22 -0
  40. package/dist/connection/notifications.d.ts +28 -0
  41. package/dist/connection/options.d.ts +165 -0
  42. package/dist/connection/query-logger.d.ts +41 -0
  43. package/dist/connection/replica-router.d.ts +20 -0
  44. package/dist/connection/statement-cache.d.ts +36 -0
  45. package/dist/connection/statement-timeout.d.ts +22 -0
  46. package/dist/data-types/abstract-data-type.d.ts +58 -0
  47. package/dist/data-types/array-literal-parser.d.ts +17 -0
  48. package/dist/data-types/array-type.d.ts +18 -0
  49. package/dist/data-types/bit-type.d.ts +14 -0
  50. package/dist/data-types/blob-type.d.ts +12 -0
  51. package/dist/data-types/char-type.d.ts +12 -0
  52. package/dist/data-types/composite-fields.d.ts +26 -0
  53. package/dist/data-types/composite-type.d.ts +32 -0
  54. package/dist/data-types/data-types.d.ts +176 -0
  55. package/dist/data-types/date-type.d.ts +14 -0
  56. package/dist/data-types/decimal-type.d.ts +13 -0
  57. package/dist/data-types/default-value-generator.d.ts +15 -0
  58. package/dist/data-types/enum-type.d.ts +19 -0
  59. package/dist/data-types/ewkb-reader.d.ts +18 -0
  60. package/dist/data-types/ewkb-writer.d.ts +17 -0
  61. package/dist/data-types/float-type.d.ts +12 -0
  62. package/dist/data-types/geometric-text.d.ts +65 -0
  63. package/dist/data-types/geometric-type.d.ts +46 -0
  64. package/dist/data-types/hstore-type.d.ts +16 -0
  65. package/dist/data-types/integer-type.d.ts +24 -0
  66. package/dist/data-types/json-type.d.ts +16 -0
  67. package/dist/data-types/multirange-type.d.ts +19 -0
  68. package/dist/data-types/range-type.d.ts +28 -0
  69. package/dist/data-types/record-text.d.ts +29 -0
  70. package/dist/data-types/scalar-type.d.ts +13 -0
  71. package/dist/data-types/spatial-type.d.ts +20 -0
  72. package/dist/data-types/string-type.d.ts +12 -0
  73. package/dist/data-types/text-type.d.ts +12 -0
  74. package/dist/data-types/timestamp-type.d.ts +15 -0
  75. package/dist/data-types/virtual-type.d.ts +15 -0
  76. package/dist/data-types/wall-clock.d.ts +14 -0
  77. package/dist/ddl/column-ddl.d.ts +73 -0
  78. package/dist/ddl/constraint-ddl.d.ts +30 -0
  79. package/dist/ddl/ddl-generator.d.ts +181 -0
  80. package/dist/ddl/ddl-guards.d.ts +60 -0
  81. package/dist/ddl/ddl-types.d.ts +204 -0
  82. package/dist/ddl/enum-ddl.d.ts +42 -0
  83. package/dist/ddl/extension-ddl.d.ts +57 -0
  84. package/dist/ddl/function-ddl.d.ts +98 -0
  85. package/dist/ddl/index-ddl.d.ts +29 -0
  86. package/dist/ddl/index-element-ddl.d.ts +19 -0
  87. package/dist/ddl/partition-ddl.d.ts +88 -0
  88. package/dist/ddl/partition-types.d.ts +94 -0
  89. package/dist/ddl/policy-ddl.d.ts +137 -0
  90. package/dist/ddl/routine-guards.d.ts +63 -0
  91. package/dist/ddl/sequence-ddl.d.ts +103 -0
  92. package/dist/ddl/sql-literal.d.ts +61 -0
  93. package/dist/ddl/table-ddl.d.ts +35 -0
  94. package/dist/ddl/trigger-ddl.d.ts +81 -0
  95. package/dist/ddl/view-ddl.d.ts +122 -0
  96. package/dist/decorators/association-applier.d.ts +18 -0
  97. package/dist/decorators/association-decorators.d.ts +72 -0
  98. package/dist/decorators/column-decorators.d.ts +147 -0
  99. package/dist/decorators/decorator-factory.d.ts +45 -0
  100. package/dist/decorators/decorator-signature.d.ts +26 -0
  101. package/dist/decorators/decorator-types.d.ts +24 -0
  102. package/dist/decorators/foreign-key-decorator.d.ts +21 -0
  103. package/dist/decorators/hook-decorators.d.ts +393 -0
  104. package/dist/decorators/init-arguments.d.ts +29 -0
  105. package/dist/decorators/model-decorators.d.ts +18 -0
  106. package/dist/decorators/model-metadata.d.ts +70 -0
  107. package/dist/decorators/table-decorators.d.ts +43 -0
  108. package/dist/decorators/timestamp-decorators.d.ts +38 -0
  109. package/dist/errors/base-error.d.ts +40 -0
  110. package/dist/errors/connection-errors.d.ts +152 -0
  111. package/dist/errors/database-errors.d.ts +186 -0
  112. package/dist/errors/errors.d.ts +5 -0
  113. package/dist/errors/map-pg-error.d.ts +27 -0
  114. package/dist/errors/misc-errors.d.ts +232 -0
  115. package/dist/errors/validation-errors.d.ts +141 -0
  116. package/dist/exports-associations.d.ts +6 -0
  117. package/dist/exports-core.d.ts +95 -0
  118. package/dist/exports-decorators.d.ts +8 -0
  119. package/dist/exports-errors.d.ts +2 -0
  120. package/dist/exports-model.d.ts +21 -0
  121. package/dist/exports-schema.d.ts +19 -0
  122. package/dist/expressions/call-expressions.d.ts +54 -0
  123. package/dist/expressions/condition-expressions.d.ts +51 -0
  124. package/dist/expressions/expression.d.ts +52 -0
  125. package/dist/expressions/jsonpath-helpers.d.ts +37 -0
  126. package/dist/expressions/logic.d.ts +25 -0
  127. package/dist/expressions/methods.d.ts +188 -0
  128. package/dist/expressions/op.d.ts +182 -0
  129. package/dist/expressions/query-expressions.d.ts +110 -0
  130. package/dist/expressions/row-expressions.d.ts +35 -0
  131. package/dist/expressions/search-helpers.d.ts +138 -0
  132. package/dist/expressions/trigram-helpers.d.ts +40 -0
  133. package/dist/hooks/hooks.d.ts +125 -0
  134. package/dist/index.cjs +21864 -0
  135. package/dist/index.cjs.map +1 -0
  136. package/dist/index.d.ts +6 -0
  137. package/dist/index.js +21688 -0
  138. package/dist/index.js.map +1 -0
  139. package/dist/model/attribute-columns.d.ts +85 -0
  140. package/dist/model/attribute-normalizer.d.ts +42 -0
  141. package/dist/model/attribute-options.d.ts +121 -0
  142. package/dist/model/bulk-insert-builder.d.ts +24 -0
  143. package/dist/model/bulk-options.d.ts +173 -0
  144. package/dist/model/copy-options.d.ts +51 -0
  145. package/dist/model/cte-builder.d.ts +134 -0
  146. package/dist/model/definition-normalizer.d.ts +26 -0
  147. package/dist/model/delete-query-builder.d.ts +42 -0
  148. package/dist/model/find-options.d.ts +144 -0
  149. package/dist/model/find-query-builder.d.ts +38 -0
  150. package/dist/model/inflector.d.ts +28 -0
  151. package/dist/model/insert-query-builder.d.ts +41 -0
  152. package/dist/model/instance-destroyer.d.ts +44 -0
  153. package/dist/model/instance-lifecycle-services.d.ts +61 -0
  154. package/dist/model/instance-lifecycle.d.ts +128 -0
  155. package/dist/model/instance-saver.d.ts +25 -0
  156. package/dist/model/instance-state.d.ts +48 -0
  157. package/dist/model/instance-validation.d.ts +35 -0
  158. package/dist/model/instance-values.d.ts +88 -0
  159. package/dist/model/instance-writer.d.ts +59 -0
  160. package/dist/model/join-source-builder.d.ts +25 -0
  161. package/dist/model/lateral-keys-builder.d.ts +25 -0
  162. package/dist/model/merge-action-builder.d.ts +31 -0
  163. package/dist/model/merge-options.d.ts +72 -0
  164. package/dist/model/merge-query-builder.d.ts +29 -0
  165. package/dist/model/merge-source-builder.d.ts +22 -0
  166. package/dist/model/mixins/model-aggregates.d.ts +69 -0
  167. package/dist/model/mixins/model-associations.d.ts +113 -0
  168. package/dist/model/mixins/model-constructor.d.ts +7 -0
  169. package/dist/model/mixins/model-finders.d.ts +140 -0
  170. package/dist/model/mixins/model-hooks.d.ts +142 -0
  171. package/dist/model/mixins/model-postgres.d.ts +198 -0
  172. package/dist/model/mixins/model-schema-binding.d.ts +36 -0
  173. package/dist/model/mixins/model-schema.d.ts +100 -0
  174. package/dist/model/mixins/model-scopes.d.ts +57 -0
  175. package/dist/model/mixins/model-writers.d.ts +175 -0
  176. package/dist/model/mixins/named-hooks.d.ts +28 -0
  177. package/dist/model/model-accessors.d.ts +22 -0
  178. package/dist/model/model-base.d.ts +83 -0
  179. package/dist/model/model-definition.d.ts +130 -0
  180. package/dist/model/model-instance-persistence.d.ts +132 -0
  181. package/dist/model/model-instance-values.d.ts +197 -0
  182. package/dist/model/model-operations.d.ts +22 -0
  183. package/dist/model/model-registry.d.ts +152 -0
  184. package/dist/model/model-services.d.ts +46 -0
  185. package/dist/model/model-state.d.ts +68 -0
  186. package/dist/model/model-values.d.ts +86 -0
  187. package/dist/model/model.d.ts +629 -0
  188. package/dist/model/on-conflict-builder.d.ts +111 -0
  189. package/dist/model/operations/bulk-create-operation.d.ts +40 -0
  190. package/dist/model/operations/copy-from-source.d.ts +51 -0
  191. package/dist/model/operations/copy-operation.d.ts +54 -0
  192. package/dist/model/operations/count-operation.d.ts +52 -0
  193. package/dist/model/operations/create-operation.d.ts +31 -0
  194. package/dist/model/operations/destroy-operation.d.ts +65 -0
  195. package/dist/model/operations/find-cursor.d.ts +23 -0
  196. package/dist/model/operations/find-lookups.d.ts +99 -0
  197. package/dist/model/operations/find-operation.d.ts +47 -0
  198. package/dist/model/operations/increment-operation.d.ts +40 -0
  199. package/dist/model/operations/insert-operation.d.ts +71 -0
  200. package/dist/model/operations/merge-operation.d.ts +56 -0
  201. package/dist/model/operations/model-operation.d.ts +33 -0
  202. package/dist/model/operations/update-operation.d.ts +45 -0
  203. package/dist/model/operations/upsert-operation.d.ts +39 -0
  204. package/dist/model/options.d.ts +103 -0
  205. package/dist/model/returning-old.d.ts +52 -0
  206. package/dist/model/row-mapper.d.ts +78 -0
  207. package/dist/model/row-plan.d.ts +31 -0
  208. package/dist/model/runtime.d.ts +56 -0
  209. package/dist/model/scope-registry.d.ts +81 -0
  210. package/dist/model/select-aggregates.d.ts +37 -0
  211. package/dist/model/select-lock.d.ts +13 -0
  212. package/dist/model/select-options.d.ts +92 -0
  213. package/dist/model/select-query-builder.d.ts +73 -0
  214. package/dist/model/select-targets.d.ts +77 -0
  215. package/dist/model/source-option-builder.d.ts +23 -0
  216. package/dist/model/source-options.d.ts +108 -0
  217. package/dist/model/statement-builder.d.ts +77 -0
  218. package/dist/model/statement-services.d.ts +2 -0
  219. package/dist/model/sync-hooks.d.ts +18 -0
  220. package/dist/model/table-sample-builder.d.ts +13 -0
  221. package/dist/model/types.d.ts +85 -0
  222. package/dist/model/unnest-insert-builder.d.ts +24 -0
  223. package/dist/model/update-query-builder.d.ts +39 -0
  224. package/dist/model/v6-conflict-builder.d.ts +37 -0
  225. package/dist/model/value-cloner.d.ts +17 -0
  226. package/dist/model/values-writer.d.ts +12 -0
  227. package/dist/model/where-options.d.ts +164 -0
  228. package/dist/model/write-options.d.ts +160 -0
  229. package/dist/model/written-rows.d.ts +56 -0
  230. package/dist/package-version.d.ts +8 -0
  231. package/dist/query/query-result-shaper.d.ts +93 -0
  232. package/dist/query/raw-query.d.ts +27 -0
  233. package/dist/query-interface/alter-planner.d.ts +40 -0
  234. package/dist/query-interface/bulk-data.d.ts +44 -0
  235. package/dist/query-interface/column-commands.d.ts +52 -0
  236. package/dist/query-interface/column-describer.d.ts +17 -0
  237. package/dist/query-interface/enum-commands.d.ts +36 -0
  238. package/dist/query-interface/index-commands.d.ts +57 -0
  239. package/dist/query-interface/model-tables.d.ts +58 -0
  240. package/dist/query-interface/object-commands.d.ts +71 -0
  241. package/dist/query-interface/partition-commands.d.ts +43 -0
  242. package/dist/query-interface/policy-commands.d.ts +54 -0
  243. package/dist/query-interface/query-interface-catalog.d.ts +180 -0
  244. package/dist/query-interface/query-interface-objects.d.ts +108 -0
  245. package/dist/query-interface/query-interface-partitions.d.ts +66 -0
  246. package/dist/query-interface/query-interface-policies.d.ts +86 -0
  247. package/dist/query-interface/query-interface-routines.d.ts +120 -0
  248. package/dist/query-interface/query-interface-tables.d.ts +179 -0
  249. package/dist/query-interface/query-interface-types.d.ts +62 -0
  250. package/dist/query-interface/query-interface-views.d.ts +84 -0
  251. package/dist/query-interface/query-interface.d.ts +256 -0
  252. package/dist/query-interface/routine-commands.d.ts +71 -0
  253. package/dist/query-interface/schema-synchronizer.d.ts +110 -0
  254. package/dist/query-interface/statement-runner.d.ts +40 -0
  255. package/dist/query-interface/sync-planner.d.ts +26 -0
  256. package/dist/query-interface/table-commands.d.ts +63 -0
  257. package/dist/query-interface/table-introspector.d.ts +58 -0
  258. package/dist/query-interface/view-commands.d.ts +47 -0
  259. package/dist/sequelize/instance-hook-adders.d.ts +72 -0
  260. package/dist/sequelize/sequelize-base.d.ts +196 -0
  261. package/dist/sequelize/sequelize-constructor.d.ts +7 -0
  262. package/dist/sequelize/sequelize-helpers.d.ts +133 -0
  263. package/dist/sequelize/sequelize-hooks.d.ts +99 -0
  264. package/dist/sequelize/sequelize-internals.d.ts +87 -0
  265. package/dist/sequelize/sequelize-notifications.d.ts +66 -0
  266. package/dist/sequelize/sequelize-schema.d.ts +125 -0
  267. package/dist/sequelize/sequelize-transactions.d.ts +96 -0
  268. package/dist/sequelize.d.ts +1175 -0
  269. package/dist/sql/ast-clauses.d.ts +137 -0
  270. package/dist/sql/ast-expressions.d.ts +88 -0
  271. package/dist/sql/ast-statements.d.ts +80 -0
  272. package/dist/sql/ast.d.ts +21 -0
  273. package/dist/sql/compile.d.ts +21 -0
  274. package/dist/sql/dml-compiler.d.ts +54 -0
  275. package/dist/sql/expression-compiler.d.ts +56 -0
  276. package/dist/sql/from-compiler.d.ts +39 -0
  277. package/dist/sql/identifier-quoter.d.ts +15 -0
  278. package/dist/sql/merge-compiler.d.ts +20 -0
  279. package/dist/sql/order.d.ts +15 -0
  280. package/dist/sql/query-compiler.d.ts +45 -0
  281. package/dist/sql/sql-chunks.d.ts +50 -0
  282. package/dist/sql/with-compiler.d.ts +19 -0
  283. package/dist/transaction/advisory-locks.d.ts +28 -0
  284. package/dist/transaction/cls-namespace.d.ts +44 -0
  285. package/dist/transaction/transaction-constants.d.ts +35 -0
  286. package/dist/transaction/transaction-runner.d.ts +78 -0
  287. package/dist/transaction/transaction-starter.d.ts +25 -0
  288. package/dist/transaction/transaction-statements.d.ts +29 -0
  289. package/dist/transaction/transaction.d.ts +201 -0
  290. package/dist/validation/attribute-validators.d.ts +23 -0
  291. package/dist/validation/builtin-attribute-validator.d.ts +19 -0
  292. package/dist/validation/builtin-validators.d.ts +16 -0
  293. package/dist/validation/core-validator.d.ts +16 -0
  294. package/dist/validation/custom-validators.d.ts +13 -0
  295. package/dist/validation/instance-validator.d.ts +25 -0
  296. package/dist/validation/schema-items.d.ts +22 -0
  297. package/dist/validation/standard-schema-validator.d.ts +30 -0
  298. package/dist/validation/standard-schema.d.ts +39 -0
  299. package/dist/validation/types.d.ts +36 -0
  300. package/dist/validation/validation-target.d.ts +13 -0
  301. package/dist/where/comparison-compiler.d.ts +27 -0
  302. package/dist/where/condition-compiler.d.ts +18 -0
  303. package/dist/where/operand-resolver.d.ts +10 -0
  304. package/dist/where/operator-allowlist.d.ts +14 -0
  305. package/dist/where/where-support.d.ts +52 -0
  306. package/dist/where/where.d.ts +46 -0
  307. package/dist/where/window-compiler.d.ts +14 -0
  308. package/llm/USAGE.md +423 -0
  309. package/package.json +103 -4
  310. package/skills/postgrelize/SKILL.md +57 -0
  311. package/skills/postgrelize/reference/associations.md +108 -0
  312. package/skills/postgrelize/reference/errors.md +37 -0
  313. package/skills/postgrelize/reference/migrating-from-sequelize.md +15 -0
  314. package/skills/postgrelize/reference/postgresql-features.md +157 -0
  315. package/skills/postgrelize/reference/querying.md +111 -0
  316. package/skills/postgrelize/reference/schema.md +135 -0
  317. package/skills/postgrelize/reference/security.md +34 -0
  318. package/skills/postgrelize/reference/transactions-and-sessions.md +122 -0
  319. package/skills/postgrelize/reference/writing.md +198 -0
@@ -0,0 +1,141 @@
1
+ import { BaseError, DriverError } from './base-error.ts';
2
+ import { ConstraintErrorOptions } from './database-errors.ts';
3
+ /** Origin of a validation error item. */
4
+ export type ValidationErrorItemOrigin = 'CORE' | 'DB' | 'FUNCTION';
5
+ /** Shape of {@link ValidationErrorItemOrigin}. */
6
+ export interface ValidationErrorItemOrigins {
7
+ /** Raised by a built-in check such as not-null. */
8
+ readonly CORE: 'CORE';
9
+ /** Raised by the database, e.g. a unique violation. */
10
+ readonly DB: 'DB';
11
+ /** Raised by a custom validator function. */
12
+ readonly FUNCTION: 'FUNCTION';
13
+ }
14
+ /** Shape of {@link ValidationErrorItemType}. */
15
+ export interface ValidationErrorItemTypes {
16
+ /** A not-null violation is a `CORE` error. */
17
+ readonly 'notnull violation': 'CORE';
18
+ /** A string violation is a `CORE` error. */
19
+ readonly 'string violation': 'CORE';
20
+ /** A unique violation is a `DB` error. */
21
+ readonly 'unique violation': 'DB';
22
+ /** A failed validator is a `FUNCTION` error. */
23
+ readonly 'validation error': 'FUNCTION';
24
+ }
25
+ /** Values of {@link ValidationErrorItem.origin}, as in Sequelize v6. */
26
+ export declare const ValidationErrorItemOrigin: ValidationErrorItemOrigins;
27
+ /** Origin by validation error type, as in Sequelize v6 (`ValidationErrorItemType['unique violation']` is `'DB'`). */
28
+ export declare const ValidationErrorItemType: ValidationErrorItemTypes;
29
+ /**
30
+ * Describes a single failed validation: which attribute, which value and which validator (Sequelize v6 `ValidationErrorItem`).
31
+ *
32
+ * `origin` is derived from `type`: `'CORE'` for not-null and string violations, `'DB'` for unique violations, `'FUNCTION'` for custom validators.
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * try {
37
+ * await User.create({ email: 'not-an-email' });
38
+ * } catch (e) {
39
+ * if (e instanceof ValidationError) {
40
+ * for (const item of e.errors) {
41
+ * console.error(item.path, item.validatorKey, item.value, item.origin);
42
+ * }
43
+ * }
44
+ * }
45
+ * ```
46
+ */
47
+ export declare class ValidationErrorItem {
48
+ /** Human-readable message. */
49
+ readonly message: string;
50
+ /** Validation type, e.g. `'unique violation'`, `'notNull Violation'`, `'Validation error'`. */
51
+ readonly type: string | null;
52
+ /** Attribute name (or model validator name). */
53
+ readonly path: string | null;
54
+ /** Offending value. */
55
+ readonly value: unknown;
56
+ /** Where the error was raised, derived from `type`. */
57
+ readonly origin: ValidationErrorItemOrigin | null;
58
+ /** Instance being validated. */
59
+ readonly instance: object | null;
60
+ /** Validator key, e.g. `'not_unique'`, `'is_null'`, `'isEmail'`. */
61
+ readonly validatorKey: string | null;
62
+ /** Built-in validator name. */
63
+ readonly validatorName: string | null;
64
+ /** Built-in validator arguments. */
65
+ readonly validatorArgs: readonly unknown[];
66
+ /**
67
+ * Creates an item; `path`, `instance`, `validatorKey` and `validatorName` default to `null`, `validatorArgs` to `[]`, and `value` to `null` when `undefined`.
68
+ *
69
+ * @param message - Human-readable message.
70
+ * @param type - Validation type or origin.
71
+ * @param path - Attribute name.
72
+ * @param value - Offending value.
73
+ * @param instance - Instance being validated.
74
+ * @param validatorKey - Validator key.
75
+ * @param validatorName - Built-in validator name.
76
+ * @param validatorArgs - Built-in validator arguments.
77
+ */
78
+ constructor(message: string, type?: string | null, path?: string | null, value?: unknown, instance?: object | null, validatorKey?: string | null, validatorName?: string | null, validatorArgs?: readonly unknown[]);
79
+ }
80
+ /**
81
+ * Thrown when a model instance fails validation, carrying one item per failed rule (Sequelize v6 `ValidationError`).
82
+ *
83
+ * Raised by `create`, `save`, `update`, `build(...).validate()` and similar before any SQL is sent. Not-null, unique and validator failures all end up in `errors`.
84
+ *
85
+ * @example
86
+ * ```ts
87
+ * try {
88
+ * await User.create({ email: 'not-an-email' });
89
+ * } catch (e) {
90
+ * if (e instanceof ValidationError) {
91
+ * console.error(e.errors.map((item) => `${item.path}: ${item.message}`));
92
+ * }
93
+ * }
94
+ * ```
95
+ */
96
+ export declare class ValidationError extends BaseError {
97
+ /** Individual validation failures. */
98
+ readonly errors: readonly ValidationErrorItem[];
99
+ /**
100
+ * Creates the error from a message and its items.
101
+ *
102
+ * @param message - Error message; when empty it is built from the items like Sequelize v6.
103
+ * @param errors - Individual validation failures.
104
+ */
105
+ constructor(message: string | null | undefined, errors?: readonly ValidationErrorItem[]);
106
+ }
107
+ /**
108
+ * Thrown when PostgreSQL reports a unique violation (SQLSTATE `23505`); a {@link ValidationError} subclass like in Sequelize v6.
109
+ *
110
+ * `fields` maps the unique columns to the offending values (parsed from the PostgreSQL detail) and `errors` has one `not_unique` item per column.
111
+ *
112
+ * @example
113
+ * ```ts
114
+ * try {
115
+ * await User.create({ email: 'taken@example.com' });
116
+ * } catch (e) {
117
+ * if (e instanceof UniqueConstraintError) {
118
+ * console.error(e.fields, e.errors[0]?.message);
119
+ * }
120
+ * }
121
+ * ```
122
+ */
123
+ export declare class UniqueConstraintError extends ValidationError {
124
+ /** Original driver error. */
125
+ readonly parent: DriverError;
126
+ /** Original driver error (alias of `parent`). */
127
+ readonly original: DriverError;
128
+ /** Executed SQL text. */
129
+ readonly sql: string;
130
+ /** Unique columns mapped to offending values. */
131
+ readonly fields: Readonly<Record<string, string>>;
132
+ /**
133
+ * Builds the error; the message defaults to `Validation error`.
134
+ *
135
+ * @param options - Driver error, fields and validation items.
136
+ */
137
+ constructor(options: Omit<ConstraintErrorOptions, 'fields'> & Readonly<{
138
+ fields?: Readonly<Record<string, string>>;
139
+ errors?: readonly ValidationErrorItem[];
140
+ }>);
141
+ }
@@ -0,0 +1,6 @@
1
+ import { Association as AssociationClass } from './associations/association.ts';
2
+ import { Association as AssociationShape } from './associations/types.ts';
3
+ /** Description of one association of a model: what `Model.associations` holds and `Model.hasMany()` and friends return. */
4
+ export type Association = AssociationShape;
5
+ /** Base class of the association classes (`Sequelize.HasOne`, `Sequelize.HasMany`, `Sequelize.BelongsTo`, `Sequelize.BelongsToMany`). */
6
+ export declare const Association: typeof AssociationClass;
@@ -0,0 +1,95 @@
1
+ import { DataTypes } from './data-types/data-types.ts';
2
+ /** The `validator` (validator.js) library used by the built-in validators, e.g. `Validator.isEmail(value)` (Sequelize v6 `Validator`). */
3
+ export declare const Validator: typeof import('validator');
4
+ export { DataTypes };
5
+ /** Alias of `DataTypes.ARRAY` (Sequelize v6 module export). */
6
+ export declare const ARRAY: (subtype: import('./exports-core.ts').DataTypeInput) => import('./data-types/array-type.ts').ArrayType;
7
+ /** Alias of `DataTypes.BIGINT` (Sequelize v6 module export). */
8
+ export declare const BIGINT: import('./data-types/integer-type.ts').IntegerType;
9
+ /** Alias of `DataTypes.BLOB` (Sequelize v6 module export). */
10
+ export declare const BLOB: ((size?: "tiny" | "medium" | "long" | undefined) => import('./data-types/blob-type.ts').BlobType) & import('./data-types/blob-type.ts').BlobType;
11
+ /** Alias of `DataTypes.BOOLEAN` (Sequelize v6 module export). */
12
+ export declare const BOOLEAN: import('./data-types/scalar-type.ts').ScalarType;
13
+ /** Alias of `DataTypes.CHAR` (Sequelize v6 module export). */
14
+ export declare const CHAR: ((length?: number | undefined) => import('./data-types/char-type.ts').CharType) & import('./data-types/char-type.ts').CharType;
15
+ /** Alias of `DataTypes.CIDR` (Sequelize v6 module export). */
16
+ export declare const CIDR: import('./data-types/scalar-type.ts').ScalarType;
17
+ /** Alias of `DataTypes.CITEXT` (Sequelize v6 module export). */
18
+ export declare const CITEXT: import('./data-types/scalar-type.ts').ScalarType;
19
+ /** Alias of `DataTypes.DATE` (Sequelize v6 module export). */
20
+ export declare const DATE: ((fsp?: number | undefined) => import('./data-types/date-type.ts').DateType) & import('./data-types/date-type.ts').DateType;
21
+ /** Alias of `DataTypes.DATEONLY` (Sequelize v6 module export). */
22
+ export declare const DATEONLY: import('./data-types/scalar-type.ts').ScalarType;
23
+ /** Alias of `DataTypes.DECIMAL` (Sequelize v6 module export). */
24
+ export declare const DECIMAL: ((digits?: number | undefined, scale?: number | undefined) => import('./data-types/decimal-type.ts').DecimalType) & import('./data-types/decimal-type.ts').DecimalType;
25
+ /** Alias of `DataTypes.DOUBLE` (Sequelize v6 module export). */
26
+ export declare const DOUBLE: import('./data-types/scalar-type.ts').ScalarType;
27
+ /** Alias of `DataTypes.ENUM` (Sequelize v6 module export). */
28
+ export declare const ENUM: (...args: readonly (string | readonly string[] | Readonly<{
29
+ values: readonly string[];
30
+ }>)[]) => import('./data-types/enum-type.ts').EnumType;
31
+ /** Alias of `DataTypes.FLOAT` (Sequelize v6 module export). */
32
+ export declare const FLOAT: ((digits?: number | undefined) => import('./data-types/float-type.ts').FloatType) & import('./data-types/float-type.ts').FloatType;
33
+ /** Alias of `DataTypes.GEOGRAPHY` (Sequelize v6 module export). */
34
+ export declare const GEOGRAPHY: ((geographyType?: string | undefined, srid?: number | undefined) => import('./data-types/spatial-type.ts').SpatialType) & import('./data-types/spatial-type.ts').SpatialType;
35
+ /** Alias of `DataTypes.GEOMETRY` (Sequelize v6 module export). */
36
+ export declare const GEOMETRY: ((geometryType?: string | undefined, srid?: number | undefined) => import('./data-types/spatial-type.ts').SpatialType) & import('./data-types/spatial-type.ts').SpatialType;
37
+ /** Alias of `DataTypes.HSTORE` (Sequelize v6 module export). */
38
+ export declare const HSTORE: import('./data-types/hstore-type.ts').HstoreType;
39
+ /** Alias of `DataTypes.INET` (Sequelize v6 module export). */
40
+ export declare const INET: import('./data-types/scalar-type.ts').ScalarType;
41
+ /** Alias of `DataTypes.INTEGER` (Sequelize v6 module export). */
42
+ export declare const INTEGER: import('./data-types/integer-type.ts').IntegerType;
43
+ /** Alias of `DataTypes.JSON` (Sequelize v6 module export). */
44
+ export declare const JSON: import('./data-types/json-type.ts').JsonType;
45
+ /** Alias of `DataTypes.JSONB` (Sequelize v6 module export). */
46
+ export declare const JSONB: import('./data-types/json-type.ts').JsonType;
47
+ /** Alias of `DataTypes.MACADDR` (Sequelize v6 module export). */
48
+ export declare const MACADDR: import('./data-types/scalar-type.ts').ScalarType;
49
+ /** Alias of `DataTypes.MEDIUMINT` (Sequelize v6 module export). */
50
+ export declare const MEDIUMINT: import('./data-types/integer-type.ts').IntegerType;
51
+ /** Alias of `DataTypes.NOW` (Sequelize v6 module export). */
52
+ export declare const NOW: import('./exports-core.ts').DefaultValueGenerator;
53
+ /** Alias of `DataTypes.NUMBER` (Sequelize v6 module export). */
54
+ export declare const NUMBER: ((digits?: number | undefined, scale?: number | undefined) => import('./data-types/decimal-type.ts').DecimalType) & import('./data-types/decimal-type.ts').DecimalType;
55
+ /** Alias of `DataTypes.NUMERIC` (Sequelize v6 module export). */
56
+ export declare const NUMERIC: ((digits?: number | undefined, scale?: number | undefined) => import('./data-types/decimal-type.ts').DecimalType) & import('./data-types/decimal-type.ts').DecimalType;
57
+ /** Alias of `DataTypes.RANGE` (Sequelize v6 module export). */
58
+ export declare const RANGE: ((subtype?: import('./exports-core.ts').DataTypeInput | undefined) => import('./data-types/range-type.ts').RangeType) & import('./data-types/range-type.ts').RangeType;
59
+ /** Alias of `DataTypes.REAL` (Sequelize v6 module export). */
60
+ export declare const REAL: import('./data-types/scalar-type.ts').ScalarType;
61
+ /** Alias of `DataTypes.SMALLINT` (Sequelize v6 module export). */
62
+ export declare const SMALLINT: import('./data-types/integer-type.ts').IntegerType;
63
+ /** Alias of `DataTypes.STRING` (Sequelize v6 module export). */
64
+ export declare const STRING: ((length?: number | undefined) => import('./data-types/string-type.ts').StringType) & import('./data-types/string-type.ts').StringType;
65
+ /** Alias of `DataTypes.TEXT` (Sequelize v6 module export). */
66
+ export declare const TEXT: ((size?: "tiny" | "medium" | "long" | undefined) => import('./data-types/text-type.ts').TextType) & import('./data-types/text-type.ts').TextType;
67
+ /** Alias of `DataTypes.TIME` (Sequelize v6 module export). */
68
+ export declare const TIME: import('./data-types/scalar-type.ts').ScalarType;
69
+ /** Alias of `DataTypes.TINYINT` (Sequelize v6 module export). */
70
+ export declare const TINYINT: import('./data-types/integer-type.ts').IntegerType;
71
+ /** Alias of `DataTypes.TSVECTOR` (Sequelize v6 module export). */
72
+ export declare const TSVECTOR: import('./data-types/scalar-type.ts').ScalarType;
73
+ /** Alias of `DataTypes.UUID` (Sequelize v6 module export). */
74
+ export declare const UUID: import('./data-types/scalar-type.ts').ScalarType;
75
+ /** Alias of `DataTypes.UUIDV4` (Sequelize v6 module export). */
76
+ export declare const UUIDV4: import('./exports-core.ts').DefaultValueGenerator;
77
+ /** Alias of `DataTypes.VIRTUAL` (Sequelize v6 module export). */
78
+ export declare const VIRTUAL: ((returnType?: import('./exports-core.ts').DataTypeInput | undefined, fields?: readonly string[] | undefined) => import('./data-types/virtual-type.ts').VirtualType) & import('./data-types/virtual-type.ts').VirtualType;
79
+ export type { CompositeValue, DataType, DataTypeInput, DefaultValueGenerator, GeoCircle, GeoLine, GeoPath, GeoPoint, IntegerDataType, RangeBound, } from './data-types/data-types.ts';
80
+ export { Op } from './expressions/op.ts';
81
+ export { and, or } from './expressions/logic.ts';
82
+ export { useInflection } from './model/inflector.ts';
83
+ export type { Inflection } from './model/inflector.ts';
84
+ export type { OpSymbol } from './expressions/op.ts';
85
+ export { jsonbPath } from './expressions/jsonpath-helpers.ts';
86
+ export type { JsonbPathKind, JsonbPathOptions } from './expressions/jsonpath-helpers.ts';
87
+ export { plainToTsQuery, phraseToTsQuery, setWeight, toTsQuery, toTsVector, tsHeadline, tsRank, websearchToTsQuery, } from './expressions/search-helpers.ts';
88
+ export type { TsHeadlineOptions, TsRankOptions } from './expressions/search-helpers.ts';
89
+ export { trigramDistance, trigramSimilarity, trigramWordSimilarity, } from './expressions/trigram-helpers.ts';
90
+ export { cast, col, excluded, exists, fn, json, literal, notExists, over, tuple, where, } from './expressions/methods.ts';
91
+ export type { Cast, Col, Excluded, Exists, Fn, Json, Literal, Over, SqlExpression, SetOperationOptions, Subquery, WriteStatement, Tuple, Where, WhereFactory, WindowOptions, } from './expressions/methods.ts';
92
+ export { Transaction, ISOLATION_LEVELS, LOCK, TRANSACTION_TYPES, } from './transaction/transaction.ts';
93
+ export type { AdvisoryLockKey, IsolationLevel, LockStrength, TransactionOptions, } from './transaction/transaction.ts';
94
+ export type { ConnectionConfig, LoggingFunction, ModelDefaults, PoolOptions, StatementCacheOptions, ReplicationMember, ReplicationOptions, SequelizeOptions, } from './connection/options.ts';
95
+ export type { Replacements, BindParameters } from './query/raw-query.ts';
@@ -0,0 +1,8 @@
1
+ export * from './decorators/association-decorators.ts';
2
+ export * from './decorators/column-decorators.ts';
3
+ export * from './decorators/foreign-key-decorator.ts';
4
+ export * from './decorators/hook-decorators.ts';
5
+ export * from './decorators/table-decorators.ts';
6
+ export * from './decorators/timestamp-decorators.ts';
7
+ export type { ModelClassDecorator, ModelPropertyDecorator, ModelStaticMethodDecorator, } from './decorators/decorator-types.ts';
8
+ export type { ModelGetter, ScopesInput, TableOptions } from './decorators/model-metadata.ts';
@@ -0,0 +1,2 @@
1
+ export { BaseError as Error, AccessDeniedError, AggregateError, AssociationError, BaseError, BulkRecordError, ConnectionAcquireTimeoutError, ConnectionError, ConnectionRefusedError, ConnectionTimedOutError, DatabaseError, EagerLoadingError, EmptyResultError, ExclusionConstraintError, ForeignKeyConstraintError, HostNotFoundError, HostNotReachableError, InstanceError, InvalidConnectionError, QueryError, SequelizeScopeError, UnknownConstraintError, ValidationErrorItemOrigin, ValidationErrorItemType, OptimisticLockError, TimeoutError, UniqueConstraintError, ValidationError, ValidationErrorItem, } from './errors/errors.ts';
2
+ export type { ConstraintErrorOptions, DriverError, QueryErrorContext } from './errors/errors.ts';
@@ -0,0 +1,21 @@
1
+ export { Sequelize, QueryTypes } from './sequelize.ts';
2
+ export type { QueryOptions, QueryType, DefineOptions } from './sequelize.ts';
3
+ export { Model } from './model/model.ts';
4
+ export type { NamedHookAdder } from './model/model.ts';
5
+ export type { MergeActionName, MergeResult } from './model/operations/merge-operation.ts';
6
+ export type { JoinSources } from './model/join-source-builder.ts';
7
+ export type { UpdateStatementOptions, WriteStatementOptions } from './model/statement-builder.ts';
8
+ export type { FromSourceOption, JsonTableColumnOptions, JsonTableOptions, TableSampleOptions, } from './model/source-options.ts';
9
+ export type { MergeInsertAction, MergeMatchedAction, MergeOptions, } from './model/merge-query-builder.ts';
10
+ export { HOOK_TYPES } from './hooks/hooks.ts';
11
+ export type { Hook, HookFunction, HookRegistry, HookType, HooksOption } from './hooks/hooks.ts';
12
+ export type { ValidateOptions } from './model/instance-lifecycle.ts';
13
+ export type { ScopeDefinition, ScopeOptions, ScopeSelector, WhereMergeStrategy, } from './model/scope-registry.ts';
14
+ export type { AttributeValidateOptions, AttributeValidatorFunction, BuiltinValidatorOption, ModelValidatorFunction, ValidatorSetting, } from './validation/types.ts';
15
+ export type { StandardSchemaIssue, StandardSchemaPathSegment, StandardSchemaProps, StandardSchemaResult, StandardSchemaV1, } from './validation/standard-schema.ts';
16
+ export type { AggregateOptions, AnyModel, AttributeAmounts, Attributes, BuildOptions, BulkCreateOptions, BulkHookOptions, CopyFromOptions, CopyToFormatOptions, CopyToOptions, CountOptions, CreateOptions, CreationAttributes, DestroyOptions, FindAndCountResult, FindOptions, FindOrCreateOptions, IncrementOptions, InsertFromOptions, InsertOptions, InstanceDestroyOptions, InitOptions, ModelStatic, QualifiedTableName, RestoreOptions, SaveOptions, UpdateOptions, UpsertOptions, Values, } from './model/options.ts';
17
+ export type { AttributeDefinition, AttributeOptions, DefinitionOptions, ModelAttributes, ReferenceOptions, ReferencedTable, UniqueOptions, } from './model/model-definition.ts';
18
+ export type { AttributeSpec, FindAttributeOptions, LockTarget, LockOption, Order, OrderItem, SelectOptions, } from './model/select-query-builder.ts';
19
+ export type { QueryOptionsBase, RuntimeOwner } from './model/runtime.ts';
20
+ export type { OnConflictColumnsTarget, OnConflictConstraintTarget, OnConflictOptions, OnConflictTarget, OnConflictUpdate, OnConflictUpdateAction, } from './model/on-conflict-builder.ts';
21
+ export type { AllowArray, AnyAll, CreationOptionalBrand, ForeignKeyBrandType, NonAttributeBrandType, ValuesList, CreationOptional, Expression, InferAttributes, InferAttributesOptions, InferCreationAttributes, MakeNullishOptional, ModelBase, NonAttribute, Optional, SqlValue, WhereAttributeHash, WhereAttributeValue, WhereLogic, WhereOperators, WhereOptions, } from './model/types.ts';
@@ -0,0 +1,19 @@
1
+ export type { AssociationName, AssociationOptions, AssociationThrough, AssociationType, BelongsToManyOptions, ForeignKeyOptions, ThroughOptions, } from './associations/types.ts';
2
+ export type { IncludeOption, IncludeOptions, IncludeThroughOptions, } from './associations/include.ts';
3
+ export { QueryInterface } from './query-interface/query-interface.ts';
4
+ export type { ColumnDescription, CreateTableOptions, DropTableOptions, } from './query-interface/query-interface.ts';
5
+ export type { AlterOptions, DropOptions, SyncOptions, } from './query-interface/schema-synchronizer.ts';
6
+ export { Deferrable } from './ddl/ddl-generator.ts';
7
+ export type { ConstraintOptions, DeferrableValue, ExcludeElement, IndexField, IndexOptions, } from './ddl/ddl-generator.ts';
8
+ export { PartitionBound } from './ddl/partition-types.ts';
9
+ export type { PartitionBoundMarker, PartitionBoundSpec, PartitionKey, PartitionKeyElement, PartitionStrategy, } from './ddl/partition-types.ts';
10
+ export type { CreatePartitionOptions, DetachPartitionOptions } from './ddl/partition-ddl.ts';
11
+ export type { CreateExtensionOptions, DropExtensionOptions } from './ddl/extension-ddl.ts';
12
+ export type { AlterSequenceOptions, CreateSequenceOptions, DropSequenceOptions, SequenceNumber, SequenceOwner, } from './ddl/sequence-ddl.ts';
13
+ export type { CreateFunctionOptions, DropFunctionOptions, FunctionName, FunctionParam, FunctionVariable, } from './ddl/function-ddl.ts';
14
+ export type { CreateTriggerOptions, DropTriggerOptions, TriggerArgument, TriggerEvent, TriggerTiming, } from './ddl/trigger-ddl.ts';
15
+ export type { CreateMaterializedViewOptions, CreateViewOptions, DropViewOptions, RefreshMaterializedViewOptions, } from './ddl/view-ddl.ts';
16
+ export type { AlterPolicyOptions, CreatePolicyOptions, DisableRowLevelSecurityOptions, DropPolicyOptions, EnableRowLevelSecurityOptions, PolicyCondition, } from './ddl/policy-ddl.ts';
17
+ export type { QualifiedTable, TableName } from './ddl/sql-literal.ts';
18
+ export type { NotificationHandler } from './connection/notifications.ts';
19
+ export type { CteCycleOptions, CteDefinition, CteFindOptions, CteSearchOptions, WithOption, } from './model/cte-builder.ts';
@@ -0,0 +1,54 @@
1
+ import { SqlExpression, SqlExpressionVisitor } from './expression.ts';
2
+ /** SQL function call. Created by {@link fn}. */
3
+ export declare class Fn extends SqlExpression {
4
+ /** @internal */
5
+ static readonly kind = "Fn";
6
+ /** Function name. */
7
+ readonly fn: string;
8
+ /** Arguments. */
9
+ readonly args: readonly unknown[];
10
+ /**
11
+ * @param fn - Function name; must be a plain or schema-qualified identifier.
12
+ * @param args - Arguments.
13
+ */
14
+ constructor(fn: string, args: readonly unknown[]);
15
+ /**
16
+ * Checks that a function name is a plain or schema-qualified identifier.
17
+ *
18
+ * @internal
19
+ */
20
+ static validName(name: string): string;
21
+ /** @internal */
22
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
23
+ }
24
+ /** Column reference. Created by {@link col}. */
25
+ export declare class Col extends SqlExpression {
26
+ /** @internal */
27
+ static readonly kind = "Col";
28
+ /** Column name or path. */
29
+ readonly col: string | readonly string[];
30
+ /**
31
+ * @param col - Column name or path.
32
+ */
33
+ constructor(col: string | readonly string[]);
34
+ /** @internal */
35
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
36
+ }
37
+ /** Type cast `CAST(value AS type)`. Created by {@link cast}. */
38
+ export declare class Cast extends SqlExpression {
39
+ /** @internal */
40
+ static readonly kind = "Cast";
41
+ /** Value or expression to cast. */
42
+ readonly val: unknown;
43
+ /** Target type. */
44
+ readonly type: string;
45
+ /** Kept for Sequelize v6 compatibility. */
46
+ readonly json: boolean;
47
+ /**
48
+ * @param val - Value or expression to cast.
49
+ * @param type - PostgreSQL type name.
50
+ */
51
+ constructor(val: unknown, type: string);
52
+ /** @internal */
53
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
54
+ }
@@ -0,0 +1,51 @@
1
+ import { SqlExpression, SqlExpressionVisitor } from './expression.ts';
2
+ /** JSON path access or JSON conditions. Created by {@link json}. */
3
+ export declare class Json extends SqlExpression {
4
+ /** @internal */
5
+ static readonly kind = "Json";
6
+ /** Dot-separated path starting with the attribute name. */
7
+ readonly path?: string;
8
+ /** Conditions object. */
9
+ readonly conditions?: object;
10
+ /** Value compared with the path (`undefined`: no comparison). */
11
+ readonly value?: unknown;
12
+ /**
13
+ * @param conditionsOrPath - Dot-separated path or conditions object.
14
+ * @param value - Value compared with the path.
15
+ */
16
+ constructor(conditionsOrPath: string | object, value?: unknown);
17
+ /** @internal */
18
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
19
+ }
20
+ /** Comparison of an arbitrary expression with a value. Created by {@link where}. */
21
+ export declare class Where extends SqlExpression {
22
+ /** @internal */
23
+ static readonly kind = "Where";
24
+ /** Left-hand expression. */
25
+ readonly attribute: unknown;
26
+ /** Comparison operator. */
27
+ readonly comparator: string | symbol;
28
+ /** Right-hand value. */
29
+ readonly logic: unknown;
30
+ /**
31
+ * @param attribute - Left-hand expression.
32
+ * @param comparator - Comparison operator.
33
+ * @param logic - Right-hand value.
34
+ */
35
+ constructor(attribute: unknown, comparator: string | symbol, logic: unknown);
36
+ /** @internal */
37
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
38
+ }
39
+ /** Reference to a column of the row proposed for insertion in `ON CONFLICT DO UPDATE`. Created by {@link excluded}. */
40
+ export declare class Excluded extends SqlExpression {
41
+ /** @internal */
42
+ static readonly kind = "Excluded";
43
+ /** Attribute name. */
44
+ readonly column: string;
45
+ /**
46
+ * @param column - Attribute name.
47
+ */
48
+ constructor(column: string);
49
+ /** @internal */
50
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
51
+ }
@@ -0,0 +1,52 @@
1
+ import { Cast, Col, Fn } from './call-expressions.ts';
2
+ import { Excluded, Json, Where } from './condition-expressions.ts';
3
+ import { Literal } from './methods.ts';
4
+ import { Exists, Subquery } from './query-expressions.ts';
5
+ import { Over, Tuple } from './row-expressions.ts';
6
+ /**
7
+ * Operations over every expression class (double dispatch through {@link SqlExpression.accept}).
8
+ *
9
+ * @internal
10
+ */
11
+ export interface SqlExpressionVisitor<R> {
12
+ /** Visits a {@link Literal}. */
13
+ visitLiteral(expression: Literal): R;
14
+ /** Visits a {@link Fn}. */
15
+ visitFn(expression: Fn): R;
16
+ /** Visits a {@link Col}. */
17
+ visitCol(expression: Col): R;
18
+ /** Visits a {@link Cast}. */
19
+ visitCast(expression: Cast): R;
20
+ /** Visits a {@link Json}. */
21
+ visitJson(expression: Json): R;
22
+ /** Visits a {@link Where}. */
23
+ visitWhere(expression: Where): R;
24
+ /** Visits a {@link Excluded}. */
25
+ visitExcluded(expression: Excluded): R;
26
+ /** Visits a {@link Subquery}. */
27
+ visitSubquery(expression: Subquery): R;
28
+ /** Visits a {@link Exists}. */
29
+ visitExists(expression: Exists): R;
30
+ /** Visits a {@link Over}. */
31
+ visitOver(expression: Over): R;
32
+ /** Visits a {@link Tuple}. */
33
+ visitTuple(expression: Tuple): R;
34
+ }
35
+ /**
36
+ * Any expression builder accepted where Sequelize v6 accepts a `SequelizeMethod`. Instances are
37
+ * immutable.
38
+ */
39
+ export declare abstract class SqlExpression {
40
+ /** @internal Expression kind; set by every concrete class. */
41
+ static readonly kind: string;
42
+ constructor();
43
+ /**
44
+ * `instanceof` by kind tag instead of prototype chain, so it works across package copies.
45
+ *
46
+ * @param value - Value to test.
47
+ * @returns True when `value` is an expression of this class (any expression for the base class).
48
+ */
49
+ static [Symbol.hasInstance](value: unknown): boolean;
50
+ /** @internal Dispatches to the visitor method of the concrete expression class. */
51
+ abstract accept<R>(visitor: SqlExpressionVisitor<R>): R;
52
+ }
@@ -0,0 +1,37 @@
1
+ import { Fn } from './call-expressions.ts';
2
+ /** Function of {@link jsonbPath}: `exists`, `match`, `query`, `queryFirst` or `queryArray`. */
3
+ export type JsonbPathKind = 'exists' | 'match' | 'query' | 'queryFirst' | 'queryArray';
4
+ /**
5
+ * Options of {@link jsonbPath}.
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const options: JsonbPathOptions = { vars: { min: 10 }, silent: true };
10
+ * ```
11
+ */
12
+ export type JsonbPathOptions = Readonly<{
13
+ /** Values of the `$name` variables of the path; serialized to jsonb and bound as a parameter. */
14
+ vars?: Readonly<Record<string, unknown>>;
15
+ /** Suppresses missing-key and type errors of the path (the `silent` argument). */
16
+ silent?: boolean;
17
+ /** Uses the `_tz` variant, which converts between time zones (stable instead of immutable). */
18
+ tz?: boolean;
19
+ }>;
20
+ /**
21
+ * Calls a `jsonb_path_*` function (`exists`, `match`, `query`, `queryFirst`, `queryArray`) with a
22
+ * bound jsonpath. PostgreSQL extension.
23
+ *
24
+ * `Op.jsonPathExists` (`@?`) and `Op.match` (`@@`) are the operator forms of `exists` and `match`.
25
+ *
26
+ * @param kind - Which function to call.
27
+ * @param target - jsonb expression, e.g. `col('doc')`.
28
+ * @param path - jsonpath text, bound as a parameter. Invalid syntax is a database error.
29
+ * @param options - `vars`, `silent` and `tz`.
30
+ * @returns Function call expression.
31
+ * @throws Error when `kind` is not one of the five names.
32
+ * @example
33
+ * ```ts
34
+ * await Product.findAll({ where: where(jsonbPath('exists', col('attrs'), '$.price ? (@ > $min)', { vars: { min: 10 } }), true) });
35
+ * ```
36
+ */
37
+ export declare const jsonbPath: (kind: JsonbPathKind, target: unknown, path: string, options?: JsonbPathOptions) => Fn;
@@ -0,0 +1,25 @@
1
+ import { WhereOptions } from '../model/where-options.ts';
2
+ /**
3
+ * Combines conditions with `AND` (Sequelize v6 `and`), for use inside `where`.
4
+ *
5
+ * @param conditions - Conditions to combine.
6
+ * @returns A `{ [Op.and]: conditions }` condition usable as `where`.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * await User.findAll({ where: and({ age: { [Op.gt]: 18 } }, { active: true }) });
11
+ * ```
12
+ */
13
+ export declare const and: (...conditions: readonly WhereOptions[]) => WhereOptions;
14
+ /**
15
+ * Combines conditions with `OR` (Sequelize v6 `or`), for use inside `where`.
16
+ *
17
+ * @param conditions - Conditions to combine.
18
+ * @returns A `{ [Op.or]: conditions }` condition usable as `where`.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * await User.findAll({ where: or({ role: 'admin' }, { role: 'owner' }) });
23
+ * ```
24
+ */
25
+ export declare const or: (...conditions: readonly WhereOptions[]) => WhereOptions;