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.
- package/CHANGELOG.md +289 -0
- package/LICENSE +21 -0
- package/README.md +131 -2
- package/dist/associations/alias-minifier.d.ts +43 -0
- package/dist/associations/association-accessors.d.ts +21 -0
- package/dist/associations/association-key-types.d.ts +44 -0
- package/dist/associations/association-keys.d.ts +98 -0
- package/dist/associations/association-lookup.d.ts +26 -0
- package/dist/associations/association-shape.d.ts +25 -0
- package/dist/associations/association.d.ts +95 -0
- package/dist/associations/belongs-to-many.d.ts +86 -0
- package/dist/associations/belongs-to.d.ts +45 -0
- package/dist/associations/has-many.d.ts +79 -0
- package/dist/associations/has-one.d.ts +44 -0
- package/dist/associations/include-assembler.d.ts +21 -0
- package/dist/associations/include-columns.d.ts +24 -0
- package/dist/associations/include-joins.d.ts +17 -0
- package/dist/associations/include-loader.d.ts +48 -0
- package/dist/associations/include-order.d.ts +22 -0
- package/dist/associations/include-query-builder.d.ts +54 -0
- package/dist/associations/include-resolver.d.ts +29 -0
- package/dist/associations/include-rows.d.ts +47 -0
- package/dist/associations/include-sub-query.d.ts +35 -0
- package/dist/associations/include.d.ts +112 -0
- package/dist/associations/junction-keys.d.ts +23 -0
- package/dist/associations/nested-creator.d.ts +44 -0
- package/dist/associations/nested-saver.d.ts +30 -0
- package/dist/associations/owner-keys.d.ts +34 -0
- package/dist/associations/separate-include-loader.d.ts +24 -0
- package/dist/associations/types.d.ts +139 -0
- package/dist/connection/after-connect-hook.d.ts +24 -0
- package/dist/connection/connect-hooks.d.ts +26 -0
- package/dist/connection/connection-config.d.ts +33 -0
- package/dist/connection/connection-manager.d.ts +65 -0
- package/dist/connection/connection-types.d.ts +21 -0
- package/dist/connection/copy-from-stdin.d.ts +52 -0
- package/dist/connection/copy-runner.d.ts +30 -0
- package/dist/connection/copy-to-stdout.d.ts +49 -0
- package/dist/connection/copy.d.ts +22 -0
- package/dist/connection/notifications.d.ts +28 -0
- package/dist/connection/options.d.ts +165 -0
- package/dist/connection/query-logger.d.ts +41 -0
- package/dist/connection/replica-router.d.ts +20 -0
- package/dist/connection/statement-cache.d.ts +36 -0
- package/dist/connection/statement-timeout.d.ts +22 -0
- package/dist/data-types/abstract-data-type.d.ts +58 -0
- package/dist/data-types/array-literal-parser.d.ts +17 -0
- package/dist/data-types/array-type.d.ts +18 -0
- package/dist/data-types/bit-type.d.ts +14 -0
- package/dist/data-types/blob-type.d.ts +12 -0
- package/dist/data-types/char-type.d.ts +12 -0
- package/dist/data-types/composite-fields.d.ts +26 -0
- package/dist/data-types/composite-type.d.ts +32 -0
- package/dist/data-types/data-types.d.ts +176 -0
- package/dist/data-types/date-type.d.ts +14 -0
- package/dist/data-types/decimal-type.d.ts +13 -0
- package/dist/data-types/default-value-generator.d.ts +15 -0
- package/dist/data-types/enum-type.d.ts +19 -0
- package/dist/data-types/ewkb-reader.d.ts +18 -0
- package/dist/data-types/ewkb-writer.d.ts +17 -0
- package/dist/data-types/float-type.d.ts +12 -0
- package/dist/data-types/geometric-text.d.ts +65 -0
- package/dist/data-types/geometric-type.d.ts +46 -0
- package/dist/data-types/hstore-type.d.ts +16 -0
- package/dist/data-types/integer-type.d.ts +24 -0
- package/dist/data-types/json-type.d.ts +16 -0
- package/dist/data-types/multirange-type.d.ts +19 -0
- package/dist/data-types/range-type.d.ts +28 -0
- package/dist/data-types/record-text.d.ts +29 -0
- package/dist/data-types/scalar-type.d.ts +13 -0
- package/dist/data-types/spatial-type.d.ts +20 -0
- package/dist/data-types/string-type.d.ts +12 -0
- package/dist/data-types/text-type.d.ts +12 -0
- package/dist/data-types/timestamp-type.d.ts +15 -0
- package/dist/data-types/virtual-type.d.ts +15 -0
- package/dist/data-types/wall-clock.d.ts +14 -0
- package/dist/ddl/column-ddl.d.ts +73 -0
- package/dist/ddl/constraint-ddl.d.ts +30 -0
- package/dist/ddl/ddl-generator.d.ts +181 -0
- package/dist/ddl/ddl-guards.d.ts +60 -0
- package/dist/ddl/ddl-types.d.ts +204 -0
- package/dist/ddl/enum-ddl.d.ts +42 -0
- package/dist/ddl/extension-ddl.d.ts +57 -0
- package/dist/ddl/function-ddl.d.ts +98 -0
- package/dist/ddl/index-ddl.d.ts +29 -0
- package/dist/ddl/index-element-ddl.d.ts +19 -0
- package/dist/ddl/partition-ddl.d.ts +88 -0
- package/dist/ddl/partition-types.d.ts +94 -0
- package/dist/ddl/policy-ddl.d.ts +137 -0
- package/dist/ddl/routine-guards.d.ts +63 -0
- package/dist/ddl/sequence-ddl.d.ts +103 -0
- package/dist/ddl/sql-literal.d.ts +61 -0
- package/dist/ddl/table-ddl.d.ts +35 -0
- package/dist/ddl/trigger-ddl.d.ts +81 -0
- package/dist/ddl/view-ddl.d.ts +122 -0
- package/dist/decorators/association-applier.d.ts +18 -0
- package/dist/decorators/association-decorators.d.ts +72 -0
- package/dist/decorators/column-decorators.d.ts +147 -0
- package/dist/decorators/decorator-factory.d.ts +45 -0
- package/dist/decorators/decorator-signature.d.ts +26 -0
- package/dist/decorators/decorator-types.d.ts +24 -0
- package/dist/decorators/foreign-key-decorator.d.ts +21 -0
- package/dist/decorators/hook-decorators.d.ts +393 -0
- package/dist/decorators/init-arguments.d.ts +29 -0
- package/dist/decorators/model-decorators.d.ts +18 -0
- package/dist/decorators/model-metadata.d.ts +70 -0
- package/dist/decorators/table-decorators.d.ts +43 -0
- package/dist/decorators/timestamp-decorators.d.ts +38 -0
- package/dist/errors/base-error.d.ts +40 -0
- package/dist/errors/connection-errors.d.ts +152 -0
- package/dist/errors/database-errors.d.ts +186 -0
- package/dist/errors/errors.d.ts +5 -0
- package/dist/errors/map-pg-error.d.ts +27 -0
- package/dist/errors/misc-errors.d.ts +232 -0
- package/dist/errors/validation-errors.d.ts +141 -0
- package/dist/exports-associations.d.ts +6 -0
- package/dist/exports-core.d.ts +95 -0
- package/dist/exports-decorators.d.ts +8 -0
- package/dist/exports-errors.d.ts +2 -0
- package/dist/exports-model.d.ts +21 -0
- package/dist/exports-schema.d.ts +19 -0
- package/dist/expressions/call-expressions.d.ts +54 -0
- package/dist/expressions/condition-expressions.d.ts +51 -0
- package/dist/expressions/expression.d.ts +52 -0
- package/dist/expressions/jsonpath-helpers.d.ts +37 -0
- package/dist/expressions/logic.d.ts +25 -0
- package/dist/expressions/methods.d.ts +188 -0
- package/dist/expressions/op.d.ts +182 -0
- package/dist/expressions/query-expressions.d.ts +110 -0
- package/dist/expressions/row-expressions.d.ts +35 -0
- package/dist/expressions/search-helpers.d.ts +138 -0
- package/dist/expressions/trigram-helpers.d.ts +40 -0
- package/dist/hooks/hooks.d.ts +125 -0
- package/dist/index.cjs +21864 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +21688 -0
- package/dist/index.js.map +1 -0
- package/dist/model/attribute-columns.d.ts +85 -0
- package/dist/model/attribute-normalizer.d.ts +42 -0
- package/dist/model/attribute-options.d.ts +121 -0
- package/dist/model/bulk-insert-builder.d.ts +24 -0
- package/dist/model/bulk-options.d.ts +173 -0
- package/dist/model/copy-options.d.ts +51 -0
- package/dist/model/cte-builder.d.ts +134 -0
- package/dist/model/definition-normalizer.d.ts +26 -0
- package/dist/model/delete-query-builder.d.ts +42 -0
- package/dist/model/find-options.d.ts +144 -0
- package/dist/model/find-query-builder.d.ts +38 -0
- package/dist/model/inflector.d.ts +28 -0
- package/dist/model/insert-query-builder.d.ts +41 -0
- package/dist/model/instance-destroyer.d.ts +44 -0
- package/dist/model/instance-lifecycle-services.d.ts +61 -0
- package/dist/model/instance-lifecycle.d.ts +128 -0
- package/dist/model/instance-saver.d.ts +25 -0
- package/dist/model/instance-state.d.ts +48 -0
- package/dist/model/instance-validation.d.ts +35 -0
- package/dist/model/instance-values.d.ts +88 -0
- package/dist/model/instance-writer.d.ts +59 -0
- package/dist/model/join-source-builder.d.ts +25 -0
- package/dist/model/lateral-keys-builder.d.ts +25 -0
- package/dist/model/merge-action-builder.d.ts +31 -0
- package/dist/model/merge-options.d.ts +72 -0
- package/dist/model/merge-query-builder.d.ts +29 -0
- package/dist/model/merge-source-builder.d.ts +22 -0
- package/dist/model/mixins/model-aggregates.d.ts +69 -0
- package/dist/model/mixins/model-associations.d.ts +113 -0
- package/dist/model/mixins/model-constructor.d.ts +7 -0
- package/dist/model/mixins/model-finders.d.ts +140 -0
- package/dist/model/mixins/model-hooks.d.ts +142 -0
- package/dist/model/mixins/model-postgres.d.ts +198 -0
- package/dist/model/mixins/model-schema-binding.d.ts +36 -0
- package/dist/model/mixins/model-schema.d.ts +100 -0
- package/dist/model/mixins/model-scopes.d.ts +57 -0
- package/dist/model/mixins/model-writers.d.ts +175 -0
- package/dist/model/mixins/named-hooks.d.ts +28 -0
- package/dist/model/model-accessors.d.ts +22 -0
- package/dist/model/model-base.d.ts +83 -0
- package/dist/model/model-definition.d.ts +130 -0
- package/dist/model/model-instance-persistence.d.ts +132 -0
- package/dist/model/model-instance-values.d.ts +197 -0
- package/dist/model/model-operations.d.ts +22 -0
- package/dist/model/model-registry.d.ts +152 -0
- package/dist/model/model-services.d.ts +46 -0
- package/dist/model/model-state.d.ts +68 -0
- package/dist/model/model-values.d.ts +86 -0
- package/dist/model/model.d.ts +629 -0
- package/dist/model/on-conflict-builder.d.ts +111 -0
- package/dist/model/operations/bulk-create-operation.d.ts +40 -0
- package/dist/model/operations/copy-from-source.d.ts +51 -0
- package/dist/model/operations/copy-operation.d.ts +54 -0
- package/dist/model/operations/count-operation.d.ts +52 -0
- package/dist/model/operations/create-operation.d.ts +31 -0
- package/dist/model/operations/destroy-operation.d.ts +65 -0
- package/dist/model/operations/find-cursor.d.ts +23 -0
- package/dist/model/operations/find-lookups.d.ts +99 -0
- package/dist/model/operations/find-operation.d.ts +47 -0
- package/dist/model/operations/increment-operation.d.ts +40 -0
- package/dist/model/operations/insert-operation.d.ts +71 -0
- package/dist/model/operations/merge-operation.d.ts +56 -0
- package/dist/model/operations/model-operation.d.ts +33 -0
- package/dist/model/operations/update-operation.d.ts +45 -0
- package/dist/model/operations/upsert-operation.d.ts +39 -0
- package/dist/model/options.d.ts +103 -0
- package/dist/model/returning-old.d.ts +52 -0
- package/dist/model/row-mapper.d.ts +78 -0
- package/dist/model/row-plan.d.ts +31 -0
- package/dist/model/runtime.d.ts +56 -0
- package/dist/model/scope-registry.d.ts +81 -0
- package/dist/model/select-aggregates.d.ts +37 -0
- package/dist/model/select-lock.d.ts +13 -0
- package/dist/model/select-options.d.ts +92 -0
- package/dist/model/select-query-builder.d.ts +73 -0
- package/dist/model/select-targets.d.ts +77 -0
- package/dist/model/source-option-builder.d.ts +23 -0
- package/dist/model/source-options.d.ts +108 -0
- package/dist/model/statement-builder.d.ts +77 -0
- package/dist/model/statement-services.d.ts +2 -0
- package/dist/model/sync-hooks.d.ts +18 -0
- package/dist/model/table-sample-builder.d.ts +13 -0
- package/dist/model/types.d.ts +85 -0
- package/dist/model/unnest-insert-builder.d.ts +24 -0
- package/dist/model/update-query-builder.d.ts +39 -0
- package/dist/model/v6-conflict-builder.d.ts +37 -0
- package/dist/model/value-cloner.d.ts +17 -0
- package/dist/model/values-writer.d.ts +12 -0
- package/dist/model/where-options.d.ts +164 -0
- package/dist/model/write-options.d.ts +160 -0
- package/dist/model/written-rows.d.ts +56 -0
- package/dist/package-version.d.ts +8 -0
- package/dist/query/query-result-shaper.d.ts +93 -0
- package/dist/query/raw-query.d.ts +27 -0
- package/dist/query-interface/alter-planner.d.ts +40 -0
- package/dist/query-interface/bulk-data.d.ts +44 -0
- package/dist/query-interface/column-commands.d.ts +52 -0
- package/dist/query-interface/column-describer.d.ts +17 -0
- package/dist/query-interface/enum-commands.d.ts +36 -0
- package/dist/query-interface/index-commands.d.ts +57 -0
- package/dist/query-interface/model-tables.d.ts +58 -0
- package/dist/query-interface/object-commands.d.ts +71 -0
- package/dist/query-interface/partition-commands.d.ts +43 -0
- package/dist/query-interface/policy-commands.d.ts +54 -0
- package/dist/query-interface/query-interface-catalog.d.ts +180 -0
- package/dist/query-interface/query-interface-objects.d.ts +108 -0
- package/dist/query-interface/query-interface-partitions.d.ts +66 -0
- package/dist/query-interface/query-interface-policies.d.ts +86 -0
- package/dist/query-interface/query-interface-routines.d.ts +120 -0
- package/dist/query-interface/query-interface-tables.d.ts +179 -0
- package/dist/query-interface/query-interface-types.d.ts +62 -0
- package/dist/query-interface/query-interface-views.d.ts +84 -0
- package/dist/query-interface/query-interface.d.ts +256 -0
- package/dist/query-interface/routine-commands.d.ts +71 -0
- package/dist/query-interface/schema-synchronizer.d.ts +110 -0
- package/dist/query-interface/statement-runner.d.ts +40 -0
- package/dist/query-interface/sync-planner.d.ts +26 -0
- package/dist/query-interface/table-commands.d.ts +63 -0
- package/dist/query-interface/table-introspector.d.ts +58 -0
- package/dist/query-interface/view-commands.d.ts +47 -0
- package/dist/sequelize/instance-hook-adders.d.ts +72 -0
- package/dist/sequelize/sequelize-base.d.ts +196 -0
- package/dist/sequelize/sequelize-constructor.d.ts +7 -0
- package/dist/sequelize/sequelize-helpers.d.ts +133 -0
- package/dist/sequelize/sequelize-hooks.d.ts +99 -0
- package/dist/sequelize/sequelize-internals.d.ts +87 -0
- package/dist/sequelize/sequelize-notifications.d.ts +66 -0
- package/dist/sequelize/sequelize-schema.d.ts +125 -0
- package/dist/sequelize/sequelize-transactions.d.ts +96 -0
- package/dist/sequelize.d.ts +1175 -0
- package/dist/sql/ast-clauses.d.ts +137 -0
- package/dist/sql/ast-expressions.d.ts +88 -0
- package/dist/sql/ast-statements.d.ts +80 -0
- package/dist/sql/ast.d.ts +21 -0
- package/dist/sql/compile.d.ts +21 -0
- package/dist/sql/dml-compiler.d.ts +54 -0
- package/dist/sql/expression-compiler.d.ts +56 -0
- package/dist/sql/from-compiler.d.ts +39 -0
- package/dist/sql/identifier-quoter.d.ts +15 -0
- package/dist/sql/merge-compiler.d.ts +20 -0
- package/dist/sql/order.d.ts +15 -0
- package/dist/sql/query-compiler.d.ts +45 -0
- package/dist/sql/sql-chunks.d.ts +50 -0
- package/dist/sql/with-compiler.d.ts +19 -0
- package/dist/transaction/advisory-locks.d.ts +28 -0
- package/dist/transaction/cls-namespace.d.ts +44 -0
- package/dist/transaction/transaction-constants.d.ts +35 -0
- package/dist/transaction/transaction-runner.d.ts +78 -0
- package/dist/transaction/transaction-starter.d.ts +25 -0
- package/dist/transaction/transaction-statements.d.ts +29 -0
- package/dist/transaction/transaction.d.ts +201 -0
- package/dist/validation/attribute-validators.d.ts +23 -0
- package/dist/validation/builtin-attribute-validator.d.ts +19 -0
- package/dist/validation/builtin-validators.d.ts +16 -0
- package/dist/validation/core-validator.d.ts +16 -0
- package/dist/validation/custom-validators.d.ts +13 -0
- package/dist/validation/instance-validator.d.ts +25 -0
- package/dist/validation/schema-items.d.ts +22 -0
- package/dist/validation/standard-schema-validator.d.ts +30 -0
- package/dist/validation/standard-schema.d.ts +39 -0
- package/dist/validation/types.d.ts +36 -0
- package/dist/validation/validation-target.d.ts +13 -0
- package/dist/where/comparison-compiler.d.ts +27 -0
- package/dist/where/condition-compiler.d.ts +18 -0
- package/dist/where/operand-resolver.d.ts +10 -0
- package/dist/where/operator-allowlist.d.ts +14 -0
- package/dist/where/where-support.d.ts +52 -0
- package/dist/where/where.d.ts +46 -0
- package/dist/where/window-compiler.d.ts +14 -0
- package/llm/USAGE.md +423 -0
- package/package.json +103 -4
- package/skills/postgrelize/SKILL.md +57 -0
- package/skills/postgrelize/reference/associations.md +108 -0
- package/skills/postgrelize/reference/errors.md +37 -0
- package/skills/postgrelize/reference/migrating-from-sequelize.md +15 -0
- package/skills/postgrelize/reference/postgresql-features.md +157 -0
- package/skills/postgrelize/reference/querying.md +111 -0
- package/skills/postgrelize/reference/schema.md +135 -0
- package/skills/postgrelize/reference/security.md +34 -0
- package/skills/postgrelize/reference/transactions-and-sessions.md +122 -0
- package/skills/postgrelize/reference/writing.md +198 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Fn } from './call-expressions.ts';
|
|
2
|
+
import { Where } from './condition-expressions.ts';
|
|
3
|
+
/**
|
|
4
|
+
* `similarity(a, b)` of `pg_trgm`: trigram similarity from 0 to 1. PostgreSQL extension; needs
|
|
5
|
+
* `CREATE EXTENSION pg_trgm`.
|
|
6
|
+
*
|
|
7
|
+
* @param left - Text expression, e.g. `col('name')`.
|
|
8
|
+
* @param right - Text expression or value (bound as a parameter).
|
|
9
|
+
* @returns Function call expression.
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* await User.findAll({ order: [[trigramSimilarity(col('name'), 'jon'), 'DESC']], limit: 5 });
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
15
|
+
export declare const trigramSimilarity: (left: unknown, right: unknown) => Fn;
|
|
16
|
+
/**
|
|
17
|
+
* `word_similarity(a, b)` of `pg_trgm`: similarity of `a` to the best matching part of `b`. PostgreSQL extension.
|
|
18
|
+
*
|
|
19
|
+
* @param left - Text expression or value, the searched word.
|
|
20
|
+
* @param right - Text expression, e.g. `col('body')`.
|
|
21
|
+
* @returns Function call expression.
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* await Post.findAll({ attributes: [[trigramWordSimilarity('postgre', col('title')), 'score']] });
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
export declare const trigramWordSimilarity: (left: unknown, right: unknown) => Fn;
|
|
28
|
+
/**
|
|
29
|
+
* `left <-> right` of `pg_trgm`: trigram distance (`1 - similarity`), served by GiST trigram
|
|
30
|
+
* indexes for nearest-neighbour `order`. PostgreSQL extension.
|
|
31
|
+
*
|
|
32
|
+
* @param left - Text expression, e.g. `col('name')`.
|
|
33
|
+
* @param right - Text expression or value (bound as a parameter).
|
|
34
|
+
* @returns Where expression usable in `order` and `attributes`.
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* await User.findAll({ order: [[trigramDistance(col('name'), 'jon'), 'ASC']], limit: 5 });
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
export declare const trigramDistance: (left: unknown, right: unknown) => Where;
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Hook names accepted by `addHook` (Sequelize v6). Model lifecycle hooks, `beforeConnect`, `afterConnect` and the sync
|
|
3
|
+
* hooks (`beforeBulkSync`, `afterBulkSync`, `beforeSync`, `afterSync`) run; the other connection / define hooks are
|
|
4
|
+
* accepted and not run yet.
|
|
5
|
+
*/
|
|
6
|
+
export declare const HOOK_TYPES: 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", "beforeConnect", "afterConnect", "beforeDisconnect", "afterDisconnect", "beforePoolAcquire", "afterPoolAcquire", "beforeQuery", "afterQuery", "beforeSync", "afterSync", "beforeBulkSync", "afterBulkSync", "beforeDefine", "afterDefine", "beforeInit", "afterInit", "beforeAssociate", "afterAssociate"];
|
|
7
|
+
/** One of {@link HOOK_TYPES}. */
|
|
8
|
+
export type HookType = (typeof HOOK_TYPES)[number];
|
|
9
|
+
/** Hook function. May be async; its return value is ignored. Receives the model class as `this`. */
|
|
10
|
+
export type HookFunction = (...args: never[]) => unknown;
|
|
11
|
+
/** Registered hook: a function, optionally named so it can be removed by name. */
|
|
12
|
+
export type Hook = Readonly<{
|
|
13
|
+
/** Hook name, used by `removeHook`. */
|
|
14
|
+
name?: string;
|
|
15
|
+
/** Hook function. */
|
|
16
|
+
fn: HookFunction;
|
|
17
|
+
}>;
|
|
18
|
+
/** Hooks passed in `init({ hooks })` / `define({ hooks })`: one function or a list per hook type. */
|
|
19
|
+
export type HooksOption = Partial<Readonly<Record<HookType, HookFunction | readonly HookFunction[]>>>;
|
|
20
|
+
/**
|
|
21
|
+
* Immutable registry of hooks by type: `add` and `remove` return a new registry, so a model or `Sequelize`
|
|
22
|
+
* instance replaces its registry on change.
|
|
23
|
+
*/
|
|
24
|
+
export declare class HookRegistry {
|
|
25
|
+
#private;
|
|
26
|
+
/** Registry without hooks. */
|
|
27
|
+
static readonly EMPTY: HookRegistry;
|
|
28
|
+
private constructor();
|
|
29
|
+
/**
|
|
30
|
+
* Builds a registry from the `hooks` option.
|
|
31
|
+
*
|
|
32
|
+
* @param option - One function or a list per hook type.
|
|
33
|
+
* @param base - Registry the hooks are added to.
|
|
34
|
+
* @returns Registry with the hooks of `base`, then those of `option`.
|
|
35
|
+
*/
|
|
36
|
+
static fromOption(option: HooksOption | undefined, base?: HookRegistry): HookRegistry;
|
|
37
|
+
/**
|
|
38
|
+
* Runs hooks of `type` from each registry in order (model hooks first, then Sequelize-level hooks).
|
|
39
|
+
*
|
|
40
|
+
* @param registries - Registries in run order.
|
|
41
|
+
* @param type - Hook type.
|
|
42
|
+
* @param context - `this` of the hook functions.
|
|
43
|
+
* @param args - Hook arguments.
|
|
44
|
+
* @returns Resolves when all hooks finished.
|
|
45
|
+
*/
|
|
46
|
+
static runAll(registries: readonly HookRegistry[], type: HookType, context: unknown, ...args: readonly unknown[]): Promise<void>;
|
|
47
|
+
/**
|
|
48
|
+
* Returns a registry with `fn` added (to the proxied types for `beforeSave` / `afterSave`, like v6).
|
|
49
|
+
*
|
|
50
|
+
* @param type - Hook type.
|
|
51
|
+
* @param fn - Hook function.
|
|
52
|
+
* @param name - Name to remove the hook by.
|
|
53
|
+
* @returns New registry; the receiver is not modified.
|
|
54
|
+
* @throws Error for an unknown hook type.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* let registry!: HookRegistry;
|
|
59
|
+
* const next = registry.add('beforeCreate', () => {}, 'audit');
|
|
60
|
+
* next.has('beforeCreate');
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
add(type: string, fn: HookFunction, name?: string): HookRegistry;
|
|
64
|
+
/**
|
|
65
|
+
* Returns a registry without hooks matching `nameOrFn`.
|
|
66
|
+
*
|
|
67
|
+
* @param type - Hook type.
|
|
68
|
+
* @param nameOrFn - Hook name or function; all hooks of the type when omitted.
|
|
69
|
+
* @returns New registry; the receiver is not modified.
|
|
70
|
+
* @throws Error for an unknown hook type.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* let registry!: HookRegistry;
|
|
75
|
+
* const next = registry.remove('beforeCreate', 'audit');
|
|
76
|
+
* next.has('beforeCreate');
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
remove(type: string, nameOrFn?: string | HookFunction): HookRegistry;
|
|
80
|
+
/**
|
|
81
|
+
* Checks whether the registry has hooks of the type.
|
|
82
|
+
*
|
|
83
|
+
* @param type - Hook type.
|
|
84
|
+
* @returns True when at least one hook exists.
|
|
85
|
+
* @throws Error for an unknown hook type.
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```ts
|
|
89
|
+
* let registry!: HookRegistry;
|
|
90
|
+
* if (registry.has('afterCreate')) {
|
|
91
|
+
* console.log('afterCreate hooks registered');
|
|
92
|
+
* }
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
has(type: string): boolean;
|
|
96
|
+
/**
|
|
97
|
+
* Like {@link HookRegistry.has}, but `undefined` for a type that never had a hook (what
|
|
98
|
+
* Sequelize v6 `hasHook` returns).
|
|
99
|
+
*
|
|
100
|
+
* @param type - Hook type.
|
|
101
|
+
* @returns Whether hooks exist, `undefined` when none was ever added.
|
|
102
|
+
* @throws Error for an unknown hook type.
|
|
103
|
+
* @example
|
|
104
|
+
* ```ts
|
|
105
|
+
* let registry!: HookRegistry;
|
|
106
|
+
* const known = registry.hasOrUndefined('beforeCreate'); // undefined until a hook was added
|
|
107
|
+
* ```
|
|
108
|
+
*/
|
|
109
|
+
hasOrUndefined(type: string): boolean | undefined;
|
|
110
|
+
/**
|
|
111
|
+
* Runs the hooks of `type` in registration order.
|
|
112
|
+
*
|
|
113
|
+
* @param type - Hook type.
|
|
114
|
+
* @param context - `this` of the hook functions.
|
|
115
|
+
* @param args - Hook arguments.
|
|
116
|
+
* @returns Resolves when all hooks finished; a rejecting hook stops the chain.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* ```ts
|
|
120
|
+
* let registry!: HookRegistry;
|
|
121
|
+
* await registry.run('beforeCreate', User, { name: 'Ann' }, {});
|
|
122
|
+
* ```
|
|
123
|
+
*/
|
|
124
|
+
run(type: HookType, context: unknown, ...args: readonly unknown[]): Promise<void>;
|
|
125
|
+
}
|