postgrelize 0.0.0-stage → 1.0.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 (308) hide show
  1. package/CHANGELOG.md +269 -0
  2. package/LICENSE +21 -0
  3. package/README.md +131 -2
  4. package/dist/associations/association-accessors.d.ts +21 -0
  5. package/dist/associations/association-key-types.d.ts +44 -0
  6. package/dist/associations/association-keys.d.ts +98 -0
  7. package/dist/associations/association-lookup.d.ts +26 -0
  8. package/dist/associations/association-shape.d.ts +25 -0
  9. package/dist/associations/association.d.ts +95 -0
  10. package/dist/associations/belongs-to-many.d.ts +86 -0
  11. package/dist/associations/belongs-to.d.ts +45 -0
  12. package/dist/associations/has-many.d.ts +79 -0
  13. package/dist/associations/has-one.d.ts +44 -0
  14. package/dist/associations/include-assembler.d.ts +21 -0
  15. package/dist/associations/include-columns.d.ts +24 -0
  16. package/dist/associations/include-joins.d.ts +17 -0
  17. package/dist/associations/include-loader.d.ts +48 -0
  18. package/dist/associations/include-order.d.ts +22 -0
  19. package/dist/associations/include-query-builder.d.ts +54 -0
  20. package/dist/associations/include-resolver.d.ts +29 -0
  21. package/dist/associations/include-rows.d.ts +47 -0
  22. package/dist/associations/include-sub-query.d.ts +35 -0
  23. package/dist/associations/include.d.ts +112 -0
  24. package/dist/associations/junction-keys.d.ts +23 -0
  25. package/dist/associations/nested-creator.d.ts +44 -0
  26. package/dist/associations/nested-saver.d.ts +30 -0
  27. package/dist/associations/owner-keys.d.ts +34 -0
  28. package/dist/associations/separate-include-loader.d.ts +24 -0
  29. package/dist/associations/types.d.ts +139 -0
  30. package/dist/connection/connection-config.d.ts +33 -0
  31. package/dist/connection/connection-manager.d.ts +65 -0
  32. package/dist/connection/connection-types.d.ts +21 -0
  33. package/dist/connection/copy-from-stdin.d.ts +52 -0
  34. package/dist/connection/copy-runner.d.ts +30 -0
  35. package/dist/connection/copy-to-stdout.d.ts +49 -0
  36. package/dist/connection/copy.d.ts +22 -0
  37. package/dist/connection/notifications.d.ts +28 -0
  38. package/dist/connection/options.d.ts +158 -0
  39. package/dist/connection/query-logger.d.ts +41 -0
  40. package/dist/connection/replica-router.d.ts +20 -0
  41. package/dist/connection/statement-cache.d.ts +36 -0
  42. package/dist/connection/statement-timeout.d.ts +22 -0
  43. package/dist/data-types/abstract-data-type.d.ts +58 -0
  44. package/dist/data-types/array-literal-parser.d.ts +17 -0
  45. package/dist/data-types/array-type.d.ts +18 -0
  46. package/dist/data-types/bit-type.d.ts +14 -0
  47. package/dist/data-types/blob-type.d.ts +12 -0
  48. package/dist/data-types/char-type.d.ts +12 -0
  49. package/dist/data-types/composite-fields.d.ts +26 -0
  50. package/dist/data-types/composite-type.d.ts +32 -0
  51. package/dist/data-types/data-types.d.ts +172 -0
  52. package/dist/data-types/date-type.d.ts +14 -0
  53. package/dist/data-types/decimal-type.d.ts +13 -0
  54. package/dist/data-types/default-value-generator.d.ts +15 -0
  55. package/dist/data-types/enum-type.d.ts +19 -0
  56. package/dist/data-types/ewkb-reader.d.ts +18 -0
  57. package/dist/data-types/ewkb-writer.d.ts +17 -0
  58. package/dist/data-types/float-type.d.ts +12 -0
  59. package/dist/data-types/geometric-text.d.ts +65 -0
  60. package/dist/data-types/geometric-type.d.ts +46 -0
  61. package/dist/data-types/hstore-type.d.ts +16 -0
  62. package/dist/data-types/integer-type.d.ts +24 -0
  63. package/dist/data-types/json-type.d.ts +16 -0
  64. package/dist/data-types/multirange-type.d.ts +19 -0
  65. package/dist/data-types/range-type.d.ts +28 -0
  66. package/dist/data-types/record-text.d.ts +29 -0
  67. package/dist/data-types/scalar-type.d.ts +13 -0
  68. package/dist/data-types/spatial-type.d.ts +20 -0
  69. package/dist/data-types/string-type.d.ts +12 -0
  70. package/dist/data-types/text-type.d.ts +12 -0
  71. package/dist/data-types/timestamp-type.d.ts +15 -0
  72. package/dist/data-types/virtual-type.d.ts +15 -0
  73. package/dist/data-types/wall-clock.d.ts +14 -0
  74. package/dist/ddl/column-ddl.d.ts +73 -0
  75. package/dist/ddl/constraint-ddl.d.ts +30 -0
  76. package/dist/ddl/ddl-generator.d.ts +181 -0
  77. package/dist/ddl/ddl-guards.d.ts +60 -0
  78. package/dist/ddl/ddl-types.d.ts +193 -0
  79. package/dist/ddl/enum-ddl.d.ts +42 -0
  80. package/dist/ddl/extension-ddl.d.ts +57 -0
  81. package/dist/ddl/function-ddl.d.ts +98 -0
  82. package/dist/ddl/index-ddl.d.ts +29 -0
  83. package/dist/ddl/index-element-ddl.d.ts +19 -0
  84. package/dist/ddl/partition-ddl.d.ts +88 -0
  85. package/dist/ddl/partition-types.d.ts +94 -0
  86. package/dist/ddl/policy-ddl.d.ts +137 -0
  87. package/dist/ddl/routine-guards.d.ts +63 -0
  88. package/dist/ddl/sequence-ddl.d.ts +103 -0
  89. package/dist/ddl/sql-literal.d.ts +61 -0
  90. package/dist/ddl/table-ddl.d.ts +35 -0
  91. package/dist/ddl/trigger-ddl.d.ts +81 -0
  92. package/dist/ddl/view-ddl.d.ts +122 -0
  93. package/dist/decorators/association-applier.d.ts +18 -0
  94. package/dist/decorators/association-decorators.d.ts +72 -0
  95. package/dist/decorators/column-decorators.d.ts +147 -0
  96. package/dist/decorators/decorator-factory.d.ts +45 -0
  97. package/dist/decorators/decorator-signature.d.ts +26 -0
  98. package/dist/decorators/decorator-types.d.ts +24 -0
  99. package/dist/decorators/foreign-key-decorator.d.ts +21 -0
  100. package/dist/decorators/hook-decorators.d.ts +393 -0
  101. package/dist/decorators/init-arguments.d.ts +29 -0
  102. package/dist/decorators/model-decorators.d.ts +18 -0
  103. package/dist/decorators/model-metadata.d.ts +70 -0
  104. package/dist/decorators/table-decorators.d.ts +43 -0
  105. package/dist/decorators/timestamp-decorators.d.ts +38 -0
  106. package/dist/errors/base-error.d.ts +40 -0
  107. package/dist/errors/connection-errors.d.ts +152 -0
  108. package/dist/errors/database-errors.d.ts +152 -0
  109. package/dist/errors/errors.d.ts +5 -0
  110. package/dist/errors/map-pg-error.d.ts +27 -0
  111. package/dist/errors/misc-errors.d.ts +188 -0
  112. package/dist/errors/validation-errors.d.ts +117 -0
  113. package/dist/exports-core.d.ts +15 -0
  114. package/dist/exports-decorators.d.ts +8 -0
  115. package/dist/exports-errors.d.ts +2 -0
  116. package/dist/exports-model.d.ts +21 -0
  117. package/dist/exports-schema.d.ts +19 -0
  118. package/dist/expressions/call-expressions.d.ts +54 -0
  119. package/dist/expressions/condition-expressions.d.ts +51 -0
  120. package/dist/expressions/expression.d.ts +52 -0
  121. package/dist/expressions/jsonpath-helpers.d.ts +37 -0
  122. package/dist/expressions/methods.d.ts +188 -0
  123. package/dist/expressions/op.d.ts +182 -0
  124. package/dist/expressions/query-expressions.d.ts +110 -0
  125. package/dist/expressions/row-expressions.d.ts +35 -0
  126. package/dist/expressions/search-helpers.d.ts +138 -0
  127. package/dist/expressions/trigram-helpers.d.ts +40 -0
  128. package/dist/hooks/hooks.d.ts +125 -0
  129. package/dist/index.cjs +20461 -0
  130. package/dist/index.cjs.map +1 -0
  131. package/dist/index.d.ts +5 -0
  132. package/dist/index.js +20332 -0
  133. package/dist/index.js.map +1 -0
  134. package/dist/model/attribute-columns.d.ts +85 -0
  135. package/dist/model/attribute-normalizer.d.ts +42 -0
  136. package/dist/model/attribute-options.d.ts +121 -0
  137. package/dist/model/bulk-insert-builder.d.ts +24 -0
  138. package/dist/model/bulk-options.d.ts +173 -0
  139. package/dist/model/copy-options.d.ts +51 -0
  140. package/dist/model/cte-builder.d.ts +134 -0
  141. package/dist/model/definition-normalizer.d.ts +26 -0
  142. package/dist/model/delete-query-builder.d.ts +42 -0
  143. package/dist/model/find-options.d.ts +144 -0
  144. package/dist/model/find-query-builder.d.ts +38 -0
  145. package/dist/model/insert-query-builder.d.ts +41 -0
  146. package/dist/model/instance-destroyer.d.ts +44 -0
  147. package/dist/model/instance-lifecycle-services.d.ts +61 -0
  148. package/dist/model/instance-lifecycle.d.ts +128 -0
  149. package/dist/model/instance-saver.d.ts +25 -0
  150. package/dist/model/instance-state.d.ts +48 -0
  151. package/dist/model/instance-validation.d.ts +35 -0
  152. package/dist/model/instance-values.d.ts +80 -0
  153. package/dist/model/instance-writer.d.ts +59 -0
  154. package/dist/model/join-source-builder.d.ts +25 -0
  155. package/dist/model/lateral-keys-builder.d.ts +25 -0
  156. package/dist/model/merge-action-builder.d.ts +31 -0
  157. package/dist/model/merge-options.d.ts +72 -0
  158. package/dist/model/merge-query-builder.d.ts +29 -0
  159. package/dist/model/merge-source-builder.d.ts +22 -0
  160. package/dist/model/mixins/model-aggregates.d.ts +69 -0
  161. package/dist/model/mixins/model-associations.d.ts +73 -0
  162. package/dist/model/mixins/model-constructor.d.ts +7 -0
  163. package/dist/model/mixins/model-finders.d.ts +124 -0
  164. package/dist/model/mixins/model-hooks.d.ts +138 -0
  165. package/dist/model/mixins/model-postgres.d.ts +198 -0
  166. package/dist/model/mixins/model-schema-binding.d.ts +36 -0
  167. package/dist/model/mixins/model-schema.d.ts +55 -0
  168. package/dist/model/mixins/model-scopes.d.ts +57 -0
  169. package/dist/model/mixins/model-writers.d.ts +175 -0
  170. package/dist/model/mixins/named-hooks.d.ts +28 -0
  171. package/dist/model/model-accessors.d.ts +22 -0
  172. package/dist/model/model-base.d.ts +83 -0
  173. package/dist/model/model-definition.d.ts +130 -0
  174. package/dist/model/model-instance-persistence.d.ts +132 -0
  175. package/dist/model/model-instance-values.d.ts +154 -0
  176. package/dist/model/model-operations.d.ts +22 -0
  177. package/dist/model/model-registry.d.ts +139 -0
  178. package/dist/model/model-services.d.ts +46 -0
  179. package/dist/model/model-state.d.ts +60 -0
  180. package/dist/model/model-values.d.ts +86 -0
  181. package/dist/model/model.d.ts +560 -0
  182. package/dist/model/on-conflict-builder.d.ts +111 -0
  183. package/dist/model/operations/bulk-create-operation.d.ts +40 -0
  184. package/dist/model/operations/copy-from-source.d.ts +51 -0
  185. package/dist/model/operations/copy-operation.d.ts +54 -0
  186. package/dist/model/operations/count-operation.d.ts +52 -0
  187. package/dist/model/operations/create-operation.d.ts +31 -0
  188. package/dist/model/operations/destroy-operation.d.ts +65 -0
  189. package/dist/model/operations/find-cursor.d.ts +23 -0
  190. package/dist/model/operations/find-lookups.d.ts +89 -0
  191. package/dist/model/operations/find-operation.d.ts +47 -0
  192. package/dist/model/operations/increment-operation.d.ts +40 -0
  193. package/dist/model/operations/insert-operation.d.ts +71 -0
  194. package/dist/model/operations/merge-operation.d.ts +56 -0
  195. package/dist/model/operations/model-operation.d.ts +33 -0
  196. package/dist/model/operations/update-operation.d.ts +45 -0
  197. package/dist/model/operations/upsert-operation.d.ts +39 -0
  198. package/dist/model/options.d.ts +103 -0
  199. package/dist/model/returning-old.d.ts +52 -0
  200. package/dist/model/row-mapper.d.ts +78 -0
  201. package/dist/model/row-plan.d.ts +31 -0
  202. package/dist/model/runtime.d.ts +54 -0
  203. package/dist/model/scope-registry.d.ts +81 -0
  204. package/dist/model/select-aggregates.d.ts +37 -0
  205. package/dist/model/select-lock.d.ts +13 -0
  206. package/dist/model/select-options.d.ts +92 -0
  207. package/dist/model/select-query-builder.d.ts +73 -0
  208. package/dist/model/select-targets.d.ts +77 -0
  209. package/dist/model/source-option-builder.d.ts +23 -0
  210. package/dist/model/source-options.d.ts +108 -0
  211. package/dist/model/statement-builder.d.ts +77 -0
  212. package/dist/model/statement-services.d.ts +2 -0
  213. package/dist/model/sync-hooks.d.ts +18 -0
  214. package/dist/model/table-sample-builder.d.ts +13 -0
  215. package/dist/model/types.d.ts +85 -0
  216. package/dist/model/unnest-insert-builder.d.ts +24 -0
  217. package/dist/model/update-query-builder.d.ts +39 -0
  218. package/dist/model/v6-conflict-builder.d.ts +37 -0
  219. package/dist/model/value-cloner.d.ts +17 -0
  220. package/dist/model/values-writer.d.ts +12 -0
  221. package/dist/model/where-options.d.ts +164 -0
  222. package/dist/model/write-options.d.ts +160 -0
  223. package/dist/model/written-rows.d.ts +56 -0
  224. package/dist/query/query-result-shaper.d.ts +91 -0
  225. package/dist/query/raw-query.d.ts +27 -0
  226. package/dist/query-interface/alter-planner.d.ts +40 -0
  227. package/dist/query-interface/bulk-data.d.ts +44 -0
  228. package/dist/query-interface/column-commands.d.ts +52 -0
  229. package/dist/query-interface/column-describer.d.ts +17 -0
  230. package/dist/query-interface/enum-commands.d.ts +36 -0
  231. package/dist/query-interface/index-commands.d.ts +57 -0
  232. package/dist/query-interface/model-tables.d.ts +58 -0
  233. package/dist/query-interface/object-commands.d.ts +71 -0
  234. package/dist/query-interface/partition-commands.d.ts +43 -0
  235. package/dist/query-interface/policy-commands.d.ts +54 -0
  236. package/dist/query-interface/query-interface-objects.d.ts +108 -0
  237. package/dist/query-interface/query-interface-partitions.d.ts +66 -0
  238. package/dist/query-interface/query-interface-policies.d.ts +86 -0
  239. package/dist/query-interface/query-interface-routines.d.ts +120 -0
  240. package/dist/query-interface/query-interface-tables.d.ts +179 -0
  241. package/dist/query-interface/query-interface-types.d.ts +62 -0
  242. package/dist/query-interface/query-interface-views.d.ts +84 -0
  243. package/dist/query-interface/query-interface.d.ts +256 -0
  244. package/dist/query-interface/routine-commands.d.ts +71 -0
  245. package/dist/query-interface/schema-synchronizer.d.ts +99 -0
  246. package/dist/query-interface/statement-runner.d.ts +40 -0
  247. package/dist/query-interface/sync-planner.d.ts +26 -0
  248. package/dist/query-interface/table-commands.d.ts +63 -0
  249. package/dist/query-interface/table-introspector.d.ts +58 -0
  250. package/dist/query-interface/view-commands.d.ts +47 -0
  251. package/dist/sequelize/sequelize-base.d.ts +196 -0
  252. package/dist/sequelize/sequelize-constructor.d.ts +7 -0
  253. package/dist/sequelize/sequelize-hooks.d.ts +86 -0
  254. package/dist/sequelize/sequelize-internals.d.ts +87 -0
  255. package/dist/sequelize/sequelize-notifications.d.ts +66 -0
  256. package/dist/sequelize/sequelize-schema.d.ts +106 -0
  257. package/dist/sequelize/sequelize-transactions.d.ts +96 -0
  258. package/dist/sequelize.d.ts +790 -0
  259. package/dist/sql/ast-clauses.d.ts +137 -0
  260. package/dist/sql/ast-expressions.d.ts +88 -0
  261. package/dist/sql/ast-statements.d.ts +80 -0
  262. package/dist/sql/ast.d.ts +21 -0
  263. package/dist/sql/compile.d.ts +21 -0
  264. package/dist/sql/dml-compiler.d.ts +54 -0
  265. package/dist/sql/expression-compiler.d.ts +56 -0
  266. package/dist/sql/from-compiler.d.ts +39 -0
  267. package/dist/sql/identifier-quoter.d.ts +15 -0
  268. package/dist/sql/merge-compiler.d.ts +20 -0
  269. package/dist/sql/order.d.ts +15 -0
  270. package/dist/sql/query-compiler.d.ts +45 -0
  271. package/dist/sql/sql-chunks.d.ts +50 -0
  272. package/dist/sql/with-compiler.d.ts +19 -0
  273. package/dist/transaction/advisory-locks.d.ts +28 -0
  274. package/dist/transaction/transaction-constants.d.ts +35 -0
  275. package/dist/transaction/transaction-runner.d.ts +60 -0
  276. package/dist/transaction/transaction-starter.d.ts +25 -0
  277. package/dist/transaction/transaction-statements.d.ts +28 -0
  278. package/dist/transaction/transaction.d.ts +198 -0
  279. package/dist/validation/attribute-validators.d.ts +23 -0
  280. package/dist/validation/builtin-attribute-validator.d.ts +19 -0
  281. package/dist/validation/builtin-validators.d.ts +16 -0
  282. package/dist/validation/core-validator.d.ts +16 -0
  283. package/dist/validation/custom-validators.d.ts +13 -0
  284. package/dist/validation/instance-validator.d.ts +25 -0
  285. package/dist/validation/schema-items.d.ts +22 -0
  286. package/dist/validation/standard-schema-validator.d.ts +30 -0
  287. package/dist/validation/standard-schema.d.ts +39 -0
  288. package/dist/validation/types.d.ts +36 -0
  289. package/dist/validation/validation-target.d.ts +13 -0
  290. package/dist/where/comparison-compiler.d.ts +27 -0
  291. package/dist/where/condition-compiler.d.ts +18 -0
  292. package/dist/where/operand-resolver.d.ts +10 -0
  293. package/dist/where/operator-allowlist.d.ts +14 -0
  294. package/dist/where/where-support.d.ts +52 -0
  295. package/dist/where/where.d.ts +46 -0
  296. package/dist/where/window-compiler.d.ts +14 -0
  297. package/llm/USAGE.md +423 -0
  298. package/package.json +102 -4
  299. package/skills/postgrelize/SKILL.md +57 -0
  300. package/skills/postgrelize/reference/associations.md +108 -0
  301. package/skills/postgrelize/reference/errors.md +37 -0
  302. package/skills/postgrelize/reference/migrating-from-sequelize.md +15 -0
  303. package/skills/postgrelize/reference/postgresql-features.md +157 -0
  304. package/skills/postgrelize/reference/querying.md +111 -0
  305. package/skills/postgrelize/reference/schema.md +135 -0
  306. package/skills/postgrelize/reference/security.md +34 -0
  307. package/skills/postgrelize/reference/transactions-and-sessions.md +122 -0
  308. package/skills/postgrelize/reference/writing.md +198 -0
@@ -0,0 +1,28 @@
1
+ import { HookFunction } from '../../hooks/hooks.ts';
2
+ /**
3
+ * Named hook method of a model class, e.g. `Model.beforeCreate`: registers a hook function, optionally under a name that
4
+ * {@link Model.removeHook} can use later.
5
+ *
6
+ * @example
7
+ * ```ts
8
+ * User.beforeCreate(async (instance: User) => {
9
+ * instance.set('email', String(instance.get('email')).trim());
10
+ * });
11
+ * User.afterCreate('audit', async (instance: User) => {
12
+ * console.log('created', instance.get('id'));
13
+ * });
14
+ * ```
15
+ */
16
+ export type NamedHookAdder = {
17
+ /**
18
+ * @param fn - Hook function.
19
+ */
20
+ (fn: HookFunction): void;
21
+ /**
22
+ * @param name - Hook name, used to remove it later.
23
+ * @param fn - Hook function.
24
+ */
25
+ (name: string, fn: HookFunction): void;
26
+ };
27
+ /** @internal Hook types that get a named adder method on model classes. */
28
+ export declare const NAMED_HOOKS: readonly ["beforeValidate", "afterValidate", "validationFailed", "beforeCreate", "afterCreate", "beforeUpdate", "afterUpdate", "beforeSave", "afterSave", "beforeDestroy", "afterDestroy", "beforeRestore", "afterRestore", "beforeUpsert", "afterUpsert", "beforeBulkCreate", "afterBulkCreate", "beforeBulkUpdate", "afterBulkUpdate", "beforeBulkDestroy", "afterBulkDestroy", "beforeBulkRestore", "afterBulkRestore", "beforeFind", "beforeFindAfterExpandIncludeAll", "beforeFindAfterOptions", "afterFind", "beforeCount"];
@@ -0,0 +1,22 @@
1
+ import { ModelDefinition } from './model-definition.ts';
2
+ /**
3
+ * Installs `instance.<attribute>` and `instance.<alias>` accessors on model prototypes.
4
+ *
5
+ * @internal
6
+ */
7
+ export declare class ModelAccessors {
8
+ /**
9
+ * Defines `instance.<attribute>` getters / setters on the model prototype (once per attribute).
10
+ *
11
+ * @param prototype - Model prototype.
12
+ * @param definition - Model definition.
13
+ */
14
+ defineAttributes(prototype: object, definition: ModelDefinition): void;
15
+ /**
16
+ * Defines `instance.<alias>` for an association, holding included / nested instances.
17
+ *
18
+ * @param prototype - Model prototype.
19
+ * @param alias - Association alias.
20
+ */
21
+ defineAssociation(prototype: object, alias: string): void;
22
+ }
@@ -0,0 +1,83 @@
1
+ import { AttributeDefinition, DefinitionOptions, ModelAttributes } from './model-definition.ts';
2
+ import { AnyModel, BuildOptions, InitOptions, ModelStatic, QualifiedTableName, Values } from './options.ts';
3
+ import { RuntimeOwner } from './runtime.ts';
4
+ /**
5
+ * Core of every model: instance state, model metadata and `init`. Capabilities are added by the
6
+ * model mixins; `Model` is the public class.
7
+ *
8
+ * @internal
9
+ */
10
+ export declare class ModelBase {
11
+ /**
12
+ * @param values - Attribute values.
13
+ * @param options - Build options.
14
+ */
15
+ constructor(values?: Values, options?: BuildOptions);
16
+ /**
17
+ * For instances returned by `insert`, `create` / `bulkCreate` / `upsert` with `onConflict`:
18
+ * true when the row was inserted, false when an existing row was updated (or nothing was
19
+ * written). `undefined` otherwise. PostgreSQL extension.
20
+ */
21
+ get wasInserted(): boolean | undefined;
22
+ /**
23
+ * For instances returned with `returningOld: true`: attribute values of the row before the
24
+ * statement, or `null` when the row did not exist (inserted). `undefined` otherwise. PostgreSQL 18+.
25
+ */
26
+ get oldValues(): Readonly<Record<string, unknown>> | null | undefined;
27
+ /** `Sequelize` instance the model belongs to. */
28
+ get sequelize(): RuntimeOwner;
29
+ /** Name the model was registered under, as given by `modelName` in the init options (default: the class name). */
30
+ static get modelName(): string;
31
+ /** Name of the database table backing the model (pluralized model name unless `tableName` was set). */
32
+ static get tableName(): string;
33
+ /** Normalized attributes keyed by attribute name. */
34
+ static get rawAttributes(): Readonly<Record<string, AttributeDefinition>>;
35
+ /** First primary key attribute name. */
36
+ static get primaryKeyAttribute(): string | undefined;
37
+ /** All primary key attribute names. */
38
+ static get primaryKeyAttributes(): readonly string[];
39
+ /** Model options after defaults were applied. */
40
+ static get options(): DefinitionOptions;
41
+ /** `Sequelize` instance the model belongs to. */
42
+ static get sequelize(): RuntimeOwner;
43
+ /**
44
+ * Defines attributes and options of the model and registers it in `sequelize.models`. Does not
45
+ * touch the database; call {@link Model.sync} or run migrations to create the table.
46
+ *
47
+ * @param this - The model class being initialized.
48
+ * @param attributes - Attribute definitions.
49
+ * @param options - Model options, including the `sequelize` instance.
50
+ * @returns The model class.
51
+ * @example
52
+ * ```ts
53
+ * class Project extends Model {}
54
+ * Project.init(
55
+ * { id: { type: DataTypes.INTEGER, primaryKey: true, autoIncrement: true }, name: DataTypes.STRING },
56
+ * { sequelize, modelName: 'Project', paranoid: true },
57
+ * );
58
+ * ```
59
+ */
60
+ static init<MS extends ModelStatic<AnyModel>>(this: MS, attributes: ModelAttributes, options: InitOptions): MS;
61
+ /**
62
+ * Returns the normalized attribute definitions, same as {@link Model.rawAttributes}.
63
+ *
64
+ * @returns Attribute definitions.
65
+ * @example
66
+ * ```ts
67
+ * const attributes = User.getAttributes();
68
+ * Object.keys(attributes);
69
+ * ```
70
+ */
71
+ static getAttributes(): Readonly<Record<string, AttributeDefinition>>;
72
+ /**
73
+ * Table name, or the qualified table (`{ tableName, schema, delimiter, ... }`, like v6) when the
74
+ * model has a schema. `String(qualified)` is the quoted `"schema"."table"` reference.
75
+ *
76
+ * @returns Table name or qualified table.
77
+ * @example
78
+ * ```ts
79
+ * const table = User.getTableName();
80
+ * ```
81
+ */
82
+ static getTableName(): string | QualifiedTableName;
83
+ }
@@ -0,0 +1,130 @@
1
+ import { ModelDefaults } from '../connection/options.ts';
2
+ import { DataTypeInput } from '../data-types/data-types.ts';
3
+ import { IndexOptions } from '../ddl/ddl-generator.ts';
4
+ import { AttributeDefinition, AttributeOptions, ModelAttributes } from './attribute-options.ts';
5
+ export type { AttributeDefinition, AttributeOptions, GeneratedColumn, ModelAttributes, ReferencedTable, ReferenceOptions, UniqueOptions, } from './attribute-options.ts';
6
+ /**
7
+ * Table-level model options shared by `Model.init` and `sequelize.define`.
8
+ *
9
+ * Extends the model defaults (`paranoid`, `timestamps`, `schema`, ...).
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const opts: DefinitionOptions = {
14
+ * modelName: 'Invoice',
15
+ * tableName: 'invoices',
16
+ * timestamps: true,
17
+ * paranoid: true,
18
+ * version: true,
19
+ * indexes: [{ fields: ['number'], unique: true }],
20
+ * };
21
+ * ```
22
+ */
23
+ export type DefinitionOptions = ModelDefaults & Readonly<{
24
+ /** Model name. Defaults to the class name. */
25
+ modelName?: string;
26
+ /** Table name. Defaults to the pluralized model name. */
27
+ tableName?: string;
28
+ /** Separator between schema and table that `getTableName` reports (PostgreSQL always uses `.` in SQL). */
29
+ schemaDelimiter?: string;
30
+ /** Name of the created-at attribute, or `false` to disable it.
31
+ * @defaultValue 'createdAt' */
32
+ createdAt?: string | boolean;
33
+ /** Name of the updated-at attribute, or `false` to disable it.
34
+ * @defaultValue 'updatedAt' */
35
+ updatedAt?: string | boolean;
36
+ /** Name of the deleted-at attribute of paranoid models.
37
+ * @defaultValue 'deletedAt' */
38
+ deletedAt?: string | boolean;
39
+ /** Optimistic locking: `true` adds a `version` attribute, a string names it. */
40
+ version?: boolean | string;
41
+ /** Indexes created by `sync()`. */
42
+ indexes?: readonly IndexOptions[];
43
+ /** Table comment. */
44
+ comment?: string;
45
+ /** `CREATE UNLOGGED TABLE` on `sync`: faster writes, no WAL, emptied after a crash, not replicated. */
46
+ unlogged?: boolean;
47
+ /** `CREATE TEMPORARY TABLE` on `sync`: lives as long as the database session; cannot have a `schema`. See {@link QueryInterface.createTable}. */
48
+ temporary?: boolean;
49
+ }>;
50
+ /** Normalized fields of a {@link ModelDefinition}. */
51
+ export type ModelDefinitionFields = Readonly<{
52
+ /** Model name. */
53
+ name: string;
54
+ /** Table name. */
55
+ tableName: string;
56
+ /** Table schema. */
57
+ schema: string | undefined;
58
+ /** Normalized attributes by attribute name. */
59
+ attributes: ReadonlyMap<string, AttributeDefinition>;
60
+ /** Attribute name by column name. */
61
+ fieldToAttribute: ReadonlyMap<string, string>;
62
+ /** Primary key attribute names. */
63
+ primaryKeys: readonly string[];
64
+ /** Created-at attribute. */
65
+ createdAt: string | undefined;
66
+ /** Updated-at attribute. */
67
+ updatedAt: string | undefined;
68
+ /** Deleted-at attribute when the model is paranoid. */
69
+ deletedAt: string | undefined;
70
+ /** Version attribute when optimistic locking is enabled. */
71
+ version: string | undefined;
72
+ /** Unique keys from attribute `unique` options: key name → attribute names (in definition order). */
73
+ uniqueKeys: ReadonlyMap<string, readonly string[]>;
74
+ /** Model options after defaults were applied. */
75
+ options: DefinitionOptions;
76
+ }>;
77
+ /**
78
+ * Immutable normalized model definition: table, attributes, keys, timestamps and options of a
79
+ * model, built from `Model.init` arguments with Sequelize v6 defaults by {@link ModelDefinition.normalize}.
80
+ */
81
+ export declare class ModelDefinition {
82
+ /** Model name. */
83
+ readonly name: string;
84
+ /** Table name. */
85
+ readonly tableName: string;
86
+ /** Table schema. */
87
+ readonly schema: string | undefined;
88
+ /** Normalized attributes by attribute name. */
89
+ readonly attributes: ReadonlyMap<string, AttributeDefinition>;
90
+ /** Attribute name by column name. */
91
+ readonly fieldToAttribute: ReadonlyMap<string, string>;
92
+ /** Primary key attribute names. */
93
+ readonly primaryKeys: readonly string[];
94
+ /** Created-at attribute. */
95
+ readonly createdAt: string | undefined;
96
+ /** Updated-at attribute. */
97
+ readonly updatedAt: string | undefined;
98
+ /** Deleted-at attribute when the model is paranoid. */
99
+ readonly deletedAt: string | undefined;
100
+ /** Version attribute when optimistic locking is enabled. */
101
+ readonly version: string | undefined;
102
+ /** Unique keys from attribute `unique` options: key name → attribute names (in definition order). */
103
+ readonly uniqueKeys: ReadonlyMap<string, readonly string[]>;
104
+ /** Model options after defaults were applied. */
105
+ readonly options: DefinitionOptions;
106
+ /**
107
+ * @param fields - Normalized fields; the instance is frozen.
108
+ */
109
+ constructor(fields: ModelDefinitionFields);
110
+ /**
111
+ * Normalizes one attribute: column name, data type instance, `allowNull` default.
112
+ *
113
+ * @param name - Attribute name.
114
+ * @param input - Data type or column options.
115
+ * @param underscored - Derive the column name in snake case.
116
+ * @returns Frozen attribute definition.
117
+ */
118
+ static attribute(name: string, input: DataTypeInput | AttributeOptions, underscored: boolean): AttributeDefinition;
119
+ /**
120
+ * Normalizes `Model.init` arguments into an immutable definition, applying Sequelize v6 defaults.
121
+ *
122
+ * @param className - Class name (default model name).
123
+ * @param attributes - Declared attributes.
124
+ * @param options - Model options.
125
+ * @param defaults - `define` defaults of the Sequelize instance.
126
+ * @param associationAttributes - Attributes added by associations (foreign keys).
127
+ * @returns The definition.
128
+ */
129
+ static normalize(className: string, attributes: ModelAttributes, options: DefinitionOptions, defaults?: ModelDefaults, associationAttributes?: ModelAttributes): ModelDefinition;
130
+ }
@@ -0,0 +1,132 @@
1
+ import { ValidateOptions } from './instance-lifecycle.ts';
2
+ import { AttributeAmounts, IncrementOptions, InstanceDestroyOptions, SaveOptions, Values } from './options.ts';
3
+ import { QueryOptionsBase } from './runtime.ts';
4
+ /**
5
+ * Persistence of model instances: `save`, `validate`, `update`, `reload`, `destroy`, `restore`, `isSoftDeleted`, `increment`, `decrement`.
6
+ *
7
+ * @internal
8
+ */
9
+ export declare class ModelInstancePersistence<TAttributes extends object = Values> {
10
+ /** Current attribute values. */
11
+ dataValues: TAttributes;
12
+ /**
13
+ * Inserts the instance when it is new, otherwise updates its changed attributes. Runs validation
14
+ * and the `beforeValidate`/`afterValidate`, `beforeSave`/`afterSave` and `beforeCreate`/`beforeUpdate`
15
+ * (and `after*`) hooks unless disabled in the options; updating an unchanged instance sends no query.
16
+ *
17
+ * @param options - Save options.
18
+ * @returns This instance with values returned by the database.
19
+ * @throws ValidationError when validation fails.
20
+ * @throws UniqueConstraintError when a unique constraint is violated.
21
+ * @throws ForeignKeyConstraintError when a foreign key constraint is violated.
22
+ * @example
23
+ * ```ts
24
+ * const user = User.build({ email: 'ada@example.com' });
25
+ * await user.save({ transaction });
26
+ * ```
27
+ */
28
+ save(options?: SaveOptions<TAttributes>): Promise<this>;
29
+ /**
30
+ * Runs the attribute validators and model validators without saving (Sequelize v6 `instance.validate()`).
31
+ *
32
+ * @param options - `hooks`, `skip`, `fields`.
33
+ * @returns Resolves when valid.
34
+ * @throws ValidationError with all failures.
35
+ * @example
36
+ * ```ts
37
+ * await user.validate();
38
+ * ```
39
+ */
40
+ validate(options?: ValidateOptions): Promise<void>;
41
+ /**
42
+ * Sets values and saves the instance, same as {@link Model.set} followed by {@link Model.save}.
43
+ *
44
+ * @param values - New values.
45
+ * @param options - Save options.
46
+ * @returns This instance.
47
+ * @throws ValidationError when validation fails.
48
+ * @example
49
+ * ```ts
50
+ * await user.update({ email: 'ada@example.com' });
51
+ * ```
52
+ */
53
+ update(values: Partial<TAttributes>, options?: SaveOptions<TAttributes>): Promise<this>;
54
+ /**
55
+ * Re-reads the row from the database and replaces the instance values, discarding unsaved changes.
56
+ *
57
+ * @param options - Query options.
58
+ * @returns This instance.
59
+ * @throws InstanceError when the row no longer exists.
60
+ * @example
61
+ * ```ts
62
+ * await user.reload({ transaction });
63
+ * ```
64
+ */
65
+ reload(options?: QueryOptionsBase): Promise<this>;
66
+ /**
67
+ * Deletes the row of this instance. For paranoid models it sets `deletedAt` instead, unless
68
+ * `force: true`. Runs `beforeDestroy`/`afterDestroy` hooks unless `hooks: false`.
69
+ *
70
+ * @param options - Destroy options (`force`, `hooks`, query options).
71
+ * @returns Resolves when deleted.
72
+ * @example
73
+ * ```ts
74
+ * await user.destroy();
75
+ * ```
76
+ */
77
+ destroy(options?: InstanceDestroyOptions): Promise<void>;
78
+ /**
79
+ * Clears `deletedAt` of this soft-deleted instance of a paranoid model.
80
+ *
81
+ * @param options - Query options; `hooks: false` skips restore hooks.
82
+ * @returns Resolves when restored.
83
+ * @throws Error when the model is not paranoid.
84
+ * @example
85
+ * ```ts
86
+ * await user.restore();
87
+ * ```
88
+ */
89
+ restore(options?: QueryOptionsBase & Readonly<{
90
+ hooks?: boolean;
91
+ }>): Promise<void>;
92
+ /**
93
+ * Whether this instance of a paranoid model is soft-deleted.
94
+ *
95
+ * @returns True when `deletedAt` is set.
96
+ * @throws Error when the model is not paranoid.
97
+ * @example
98
+ * ```ts
99
+ * if (user.isSoftDeleted()) {
100
+ * await user.restore();
101
+ * }
102
+ * ```
103
+ */
104
+ isSoftDeleted(): boolean;
105
+ /**
106
+ * Increments numeric attributes of this row in the database (`SET x = x + by`). The instance values are
107
+ * not reloaded; call {@link Model.reload} to read the new numbers.
108
+ *
109
+ * @param fields - Attribute name(s) or map of amounts.
110
+ * @param options - `by` (default 1), `silent`, and query options.
111
+ * @returns This instance.
112
+ * @example
113
+ * ```ts
114
+ * await user.increment('loginCount');
115
+ * await user.increment({ loginCount: 2, score: 10 });
116
+ * ```
117
+ */
118
+ increment(fields: AttributeAmounts<TAttributes>, options?: Omit<IncrementOptions<TAttributes>, 'where'>): Promise<this>;
119
+ /**
120
+ * Decrements numeric attributes of this row in the database (`SET x = x - by`). The instance values are
121
+ * not reloaded; call {@link Model.reload} to read the new numbers.
122
+ *
123
+ * @param fields - Attribute name(s) or map of amounts.
124
+ * @param options - `by` (default 1), `silent`, and query options.
125
+ * @returns This instance.
126
+ * @example
127
+ * ```ts
128
+ * await user.decrement('credits', { by: 5 });
129
+ * ```
130
+ */
131
+ decrement(fields: AttributeAmounts<TAttributes>, options?: Omit<IncrementOptions<TAttributes>, 'where'>): Promise<this>;
132
+ }
@@ -0,0 +1,154 @@
1
+ import { Model } from './model.ts';
2
+ import { Values } from './options.ts';
3
+ /**
4
+ * Value access of model instances: `get`, `set`, `getDataValue`, `setDataValue`, `changed`, `previous`, `equals`, `toJSON`.
5
+ *
6
+ * @internal
7
+ */
8
+ export declare class ModelInstanceValues<TAttributes extends object = Values> {
9
+ /** Current attribute values. */
10
+ dataValues: TAttributes;
11
+ /**
12
+ * Returns all attribute values of the instance; no query is run.
13
+ *
14
+ * @param options - `plain: true` returns a copy of all values with custom getters applied; `raw: true` skips custom getters.
15
+ * @returns Values object.
16
+ * @example
17
+ * ```ts
18
+ * const values = user.get({ plain: true });
19
+ * ```
20
+ */
21
+ get(options?: Readonly<{
22
+ plain?: boolean;
23
+ raw?: boolean;
24
+ clone?: boolean;
25
+ }>): TAttributes;
26
+ /**
27
+ * Returns one attribute value, applying its custom getter unless `raw` is set.
28
+ *
29
+ * @param key - Attribute name.
30
+ * @param options - `raw: true` skips the custom getter.
31
+ * @returns Attribute value.
32
+ * @example
33
+ * ```ts
34
+ * const email = user.get('email');
35
+ * ```
36
+ */
37
+ get<K extends keyof TAttributes>(key: K, options?: Readonly<{
38
+ raw?: boolean;
39
+ }>): TAttributes[K];
40
+ /**
41
+ * Sets one attribute value, applying its custom setter unless `raw` is set. Nothing is written to
42
+ * the database until {@link Model.save}; the attribute is marked as changed when the value differs.
43
+ *
44
+ * @param key - Attribute name.
45
+ * @param value - New value.
46
+ * @param options - `raw: true` skips the custom setter and change tracking.
47
+ * @returns This instance.
48
+ * @example
49
+ * ```ts
50
+ * user.set('email', 'ada@example.com');
51
+ * await user.save();
52
+ * ```
53
+ */
54
+ set<K extends keyof TAttributes>(key: K, value: TAttributes[K], options?: Readonly<{
55
+ raw?: boolean;
56
+ }>): this;
57
+ /**
58
+ * Sets several attribute values at once, applying custom setters unless `raw` is set.
59
+ *
60
+ * @param values - Attribute values.
61
+ * @param options - `raw: true` skips custom setters and change tracking.
62
+ * @returns This instance.
63
+ * @example
64
+ * ```ts
65
+ * user.set({ email: 'ada@example.com', active: true });
66
+ * ```
67
+ */
68
+ set(values: Partial<TAttributes> | Values, options?: Readonly<{
69
+ raw?: boolean;
70
+ }>): this;
71
+ /**
72
+ * Reads the stored value of an attribute, bypassing its custom getter.
73
+ *
74
+ * @param key - Attribute name.
75
+ * @returns Raw value.
76
+ * @example
77
+ * ```ts
78
+ * const stored = user.getDataValue('email');
79
+ * ```
80
+ */
81
+ getDataValue<K extends keyof TAttributes>(key: K): TAttributes[K];
82
+ /**
83
+ * Writes the stored value of an attribute, bypassing its custom setter, and marks it as changed.
84
+ *
85
+ * @param key - Attribute name.
86
+ * @param value - New value.
87
+ * @returns This instance.
88
+ * @example
89
+ * ```ts
90
+ * user.setDataValue('email', 'ada@example.com');
91
+ * ```
92
+ */
93
+ setDataValue<K extends keyof TAttributes>(key: K, value: TAttributes[K]): this;
94
+ /**
95
+ * Lists the attributes changed since the instance was loaded or last saved.
96
+ *
97
+ * @returns Changed attribute names, or `false` when nothing changed.
98
+ * @example
99
+ * ```ts
100
+ * user.set('email', 'ada@example.com');
101
+ * const changedFields = user.changed();
102
+ * ```
103
+ */
104
+ changed(): (keyof TAttributes & string)[] | false;
105
+ /**
106
+ * Checks whether one attribute changed since the instance was loaded or last saved.
107
+ *
108
+ * @param key - Attribute name.
109
+ * @returns True when changed.
110
+ */
111
+ changed(key: keyof TAttributes & string): boolean;
112
+ /**
113
+ * Marks an attribute as changed or unchanged, which controls whether {@link Model.save} writes it.
114
+ *
115
+ * @param key - Attribute name.
116
+ * @param value - Changed flag.
117
+ */
118
+ changed(key: keyof TAttributes & string, value: boolean): void;
119
+ /**
120
+ * Returns the value an attribute had before it was changed, or all previous values of changed
121
+ * attributes when no key is given.
122
+ *
123
+ * @param key - Attribute name; omit to get all.
124
+ * @returns Previous value(s).
125
+ * @example
126
+ * ```ts
127
+ * user.set('email', 'ada@example.com');
128
+ * const before = user.previous('email');
129
+ * ```
130
+ */
131
+ previous<K extends keyof TAttributes>(key?: K): TAttributes[K] | Partial<TAttributes> | undefined;
132
+ /**
133
+ * Compares the primary keys of two instances.
134
+ *
135
+ * @param other - Instance to compare with.
136
+ * @returns True when all primary key values are equal.
137
+ * @example
138
+ * ```ts
139
+ * const other = User.build({ id: user.get('id') });
140
+ * const same = user.equals(other);
141
+ * ```
142
+ */
143
+ equals(other: Model): boolean;
144
+ /**
145
+ * Returns a deep copy of the values with custom getters applied, used by `JSON.stringify`.
146
+ *
147
+ * @returns Plain object.
148
+ * @example
149
+ * ```ts
150
+ * const json = JSON.stringify(user);
151
+ * ```
152
+ */
153
+ toJSON(): TAttributes;
154
+ }
@@ -0,0 +1,22 @@
1
+ import { BulkCreateOperation } from './operations/bulk-create-operation.ts';
2
+ import { CopyOperation } from './operations/copy-operation.ts';
3
+ import { CountOperation } from './operations/count-operation.ts';
4
+ import { CreateOperation } from './operations/create-operation.ts';
5
+ import { DestroyOperation } from './operations/destroy-operation.ts';
6
+ import { FindOperation } from './operations/find-operation.ts';
7
+ import { IncrementOperation } from './operations/increment-operation.ts';
8
+ import { InsertOperation } from './operations/insert-operation.ts';
9
+ import { MergeOperation } from './operations/merge-operation.ts';
10
+ import { UpdateOperation } from './operations/update-operation.ts';
11
+ import { UpsertOperation } from './operations/upsert-operation.ts';
12
+ export declare const finder: FindOperation;
13
+ export declare const counter: CountOperation;
14
+ export declare const inserter: InsertOperation;
15
+ export declare const creator: CreateOperation;
16
+ export declare const bulkCreator: BulkCreateOperation;
17
+ export declare const upserter: UpsertOperation;
18
+ export declare const updater: UpdateOperation;
19
+ export declare const destroyer: DestroyOperation;
20
+ export declare const incrementer: IncrementOperation;
21
+ export declare const merger: MergeOperation;
22
+ export declare const copier: CopyOperation;