fix: update typescript to v5.8.2 (#17728)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Alyx <[email protected]>

Author: renovate[bot]

.github/workflows/ci.yml

@@ -156,7 +156,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ts-version: ['5.1', '5.2', '5.3', '5.4']
+        ts-version: ['5.5', '5.6', '5.7', '5.8']
     name: TS Typings (${{ matrix.ts-version }})
     runs-on: ubuntu-latest
     needs: lint

package.json

@@ -95,11 +95,10 @@
     "prettier-plugin-organize-imports": "4.1.0",
     "source-map-support": "0.5.21",
     "ts-node": "10.9.2",
-    "typedoc": "0.25.13",
-    "typedoc-plugin-carbon-ads": "1.6.0",
-    "typedoc-plugin-mdn-links": "3.3.8",
-    "typedoc-plugin-missing-exports": "2.3.0",
-    "typescript": "5.4.5"
+    "typedoc": "0.27.9",
+    "typedoc-plugin-mdn-links": "5.0.1",
+    "typedoc-plugin-missing-exports": "3.1.0",
+    "typescript": "5.8.2"
   },
   "packageManager": "[email protected]",
   "lint-staged": {

packages/core/src/abstract-dialect/query-generator-typescript.ts

@@ -132,7 +132,7 @@ export interface EscapeOptions extends FormatWhereOptions {
 
 export interface FormatWhereOptions extends Bindable {
   /**
-   * These are used to inline replacements into the query, when one is found inside of a {@link Literal}.
+   * These are used to inline replacements into the query, when one is found inside of a {@link sql.literal}.
    */
   readonly replacements?: BindOrReplacements | undefined;
 

packages/core/src/abstract-dialect/query-generator.js

@@ -942,7 +942,7 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
    *
    * ⚠️ You almost certainly want to use `quoteIdentifier` instead!
    * This method splits the identifier by "." into multiple identifiers, and has special meaning for "*".
-   * This behavior should never be the default and should be explicitly opted into by using {@link Col}.
+   * This behavior should never be the default and should be explicitly opted into by using {@link sql.col}.
    *
    * @param {string} identifiers
    *

packages/core/src/associations/belongs-to-many.ts

@@ -131,7 +131,7 @@ export class BelongsToManyAssociation<
   /**
    * The name of the Foreign Key attribute, located on the through table, that points to the Target model.
    *
-   * Not to be confused with @link {BelongsToMany.foreignKey}, which points to the Source model instead.
+   * Not to be confused with {@link BelongsToManyAssociation#foreignKey}, which points to the Source model instead.
    */
   get otherKey(): string {
     return this.pairedWith.foreignKey;

packages/core/src/decorators/legacy/validation.ts

@@ -40,14 +40,14 @@ export const ValidateAttribute = createRequiredAttributeOptionsDecorator<ColumnV
  * @example
  * ```ts
  * class User extends Model {
- *   @ValidateModel
+ *   @ModelValidator
  *   onValidate() {
  *     if (this.name !== VALID_NAME) {
  *       throw new Error(ERROR_MESSAGE);
  *     }
  *   }
  *
- *   @ValidateModel
+ *   @ModelValidator
  *   static onValidate(instance) {
  *     if (instance.name !== VALID_NAME) {
  *       throw new Error(ERROR_MESSAGE);

packages/core/src/decorators/shared/model.ts

@@ -112,7 +112,7 @@ export function mergeAttributeOptions(
     // These are objects. We merge their properties, unless the same key is used in both values.
     if (optionName === 'validate') {
       for (const [subOptionName, subOptionValue] of getAllOwnEntries(optionValue)) {
-        if (subOptionName in existingOptions[optionName]! && !overrideOnConflict) {
+        if (subOptionName in existingOptions[optionName] && !overrideOnConflict) {
           throw new Error(
             `Multiple decorators are attempting to register option ${optionName}[${JSON.stringify(subOptionName)}] of attribute ${attributeName} on model ${model.name}.`,
           );
@@ -134,7 +134,8 @@ export function mergeAttributeOptions(
       }
 
       if (Array.isArray(optionValue)) {
-        // @ts-expect-error -- runtime type checking is enforced by model
+        // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error -- became valid in TS 5.8
+        // @ts-ignore -- runtime type checking is enforced by model
         existingOptions[optionName] = [...existingOptions[optionName], ...optionValue];
       } else {
         existingOptions[optionName] = [...existingOptions[optionName], optionValue];

packages/core/src/expression-builders/attribute.ts

@@ -6,7 +6,7 @@ import type { DialectAwareFn } from './dialect-aware-fn.js';
 import type { JsonPath } from './json-path.js';
 
 /**
- * Use {@link attribute} instead.
+ * Use {@link sql.attribute} instead.
  */
 export class Attribute extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'attribute';

packages/core/src/expression-builders/cast.ts

@@ -6,7 +6,7 @@ import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
 import { where } from './where.js';
 
 /**
- * Do not use me directly. Use {@link cast}
+ * Do not use me directly. Use {@link sql.cast}
  */
 export class Cast extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'cast';

packages/core/src/expression-builders/col.ts

@@ -1,7 +1,7 @@
 import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
 
 /**
- * Do not use me directly. Use {@link col}
+ * Do not use me directly. Use {@link sql.col}
  */
 export class Col extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'col';
@@ -18,11 +18,11 @@ export class Col extends BaseSqlExpression {
 
 /**
  * Creates an object which represents a column in the DB, this allows referencing another column in your query.
- * This is often useful in conjunction with {@link fn}, {@link where} and {@link sql} which interpret strings as values and not column names.
+ * This is often useful in conjunction with {@link sql.fn}, {@link sql.where} and {@link sql} which interpret strings as values and not column names.
  *
- * Col works similarly to {@link Identifier}, but "*" has special meaning, for backwards compatibility.
+ * Col works similarly to {@link sql.identifier}, but "*" has special meaning, for backwards compatibility.
  *
- * ⚠️ We recommend using {@link Identifier}, or {@link Attribute} instead.
+ * ⚠️ We recommend using {@link sql.identifier}, or {@link sql.attribute} instead.
  *
  * @param identifiers The name of the column
  */

packages/core/src/expression-builders/dialect-aware-fn.ts

@@ -6,7 +6,7 @@ import { BaseSqlExpression } from './base-sql-expression.js';
 import { JsonPath } from './json-path.js';
 
 /**
- * Unlike {@link Fn}, this class does not accept a function name.
+ * Unlike {@link sql.fn}, this class does not accept a function name.
  * It must instead be extended by a class that implements the {@link applyForDialect} method, in which
  * the function name is provided.
  *

packages/core/src/expression-builders/fn.ts

@@ -5,7 +5,7 @@ import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
 import { where } from './where.js';
 
 /**
- * Do not use me directly. Use {@link fn}
+ * Do not use me directly. Use {@link sql.fn}
  */
 export class Fn extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'fn';
@@ -22,7 +22,7 @@ export class Fn extends BaseSqlExpression {
 
 /**
  * Creates an object representing a database function. This can be used in search queries, both in where and order parts, and as default values in column definitions.
- * If you want to refer to columns in your function, you should use {@link Attribute} (recommended), {@link Identifier}, or {@link col} (discouraged)
+ * If you want to refer to columns in your function, you should use {@link sql.attribute} (recommended), {@link sql.identifier}, or {@link sql.col} (discouraged)
  * otherwise the value will be interpreted as a string.
  *
  * ℹ️ This method is usually verbose and we recommend using the {@link sql} template string tag instead.

packages/core/src/expression-builders/identifier.ts

@@ -2,7 +2,7 @@ import type { TableOrModel } from '../abstract-dialect/query-generator.types';
 import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
 
 /**
- * Use {@link identifier} instead.
+ * Use {@link sql.identifier} instead.
  */
 export class Identifier extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'identifier';
@@ -14,7 +14,7 @@ export class Identifier extends BaseSqlExpression {
 
 /**
  * Used to represent a value that will either be escaped to a literal, or a bind parameter.
- * Unlike {@link attribute} and {@link col}, this identifier will be escaped as-is,
+ * Unlike {@link sql.attribute} and {@link sql.col}, this identifier will be escaped as-is,
  * without mapping to a column name or any other transformation.
  *
  * This method supports strings, table structures, model classes (in which case the identifiers will be the model schema & table name), and model definitions (same behavior as model classes)

packages/core/src/expression-builders/json-path.ts

@@ -2,7 +2,7 @@ import type { Expression } from '../sequelize.js';
 import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
 
 /**
- * Do not use me directly. Use {@link jsonPath}.
+ * Do not use me directly. Use {@link sql.jsonPath}.
  */
 export class JsonPath extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'jsonPath';
@@ -17,7 +17,7 @@ export class JsonPath extends BaseSqlExpression {
 
 /**
  * Use this to access nested properties in a JSON column.
- * You can also use the dot notation with {@link Attribute}, but this works with any values, not just attributes.
+ * You can also use the dot notation with {@link sql.attribute}, but this works with any values, not just attributes.
  *
  * @param expression The expression to access the property on.
  * @param path The path to the property. If a number is used, it will be treated as an array index, otherwise as a key.

packages/core/src/expression-builders/list.ts

@@ -1,7 +1,7 @@
 import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
 
 /**
- * Use {@link list} instead.
+ * Use {@link sql.list} instead.
  */
 export class List extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'list';

packages/core/src/expression-builders/literal.ts

@@ -1,7 +1,7 @@
 import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
 
 /**
- * Do not use me directly. Use {@link literal}
+ * Do not use me directly. Use {@link sql.literal}
  */
 export class Literal extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'literal';

packages/core/src/expression-builders/sql.ts

@@ -14,7 +14,7 @@ import { Value } from './value.js';
 import { where } from './where.js';
 
 /**
- * The template tag function used to easily create {@link literal}.
+ * The template tag function used to easily create {@link sql.literal}.
  *
  * @param rawSql
  * @param values

packages/core/src/expression-builders/where.ts

@@ -9,7 +9,7 @@ import type { Expression } from '../sequelize.js';
 import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
 
 /**
- * Do not use me directly. Use {@link where}
+ * Do not use me directly. Use {@link sql.where}
  */
 export class Where<Operator extends keyof WhereOperators = typeof Op.eq> extends BaseSqlExpression {
   declare protected readonly [SQL_IDENTIFIER]: 'where';
@@ -78,7 +78,7 @@ If you wish to use custom operators not provided by Sequelize, you can use the "
  * A way of writing an SQL binary operator, or more complex where conditions.
  *
  * This solution is slightly more verbose than the POJO syntax, but allows any value on the left hand side of the operator (unlike the POJO syntax which only accepts attribute names).
- * For instance, either the left or right hand side of the operator can be {@link fn}, {@link col}, {@link literal} etc.
+ * For instance, either the left or right hand side of the operator can be {@link sql.fn}, {@link sql.col}, {@link sql.literal} etc.
  *
  * If your left operand is an attribute name, using the regular POJO syntax (`{ where: { attrName: value }}`) syntax is usually more convenient.
  *

packages/core/src/model-definition.ts

@@ -982,7 +982,7 @@ export function mergeModelOptions<M extends Model>(
           continue;
         }
 
-        if (!overrideOnConflict && subOptionName in existingModelOptions[optionName]!) {
+        if (!overrideOnConflict && subOptionName in existingModelOptions[optionName]) {
           throw new Error(
             `Trying to set the option ${optionName}[${JSON.stringify(subOptionName)}], but a value already exists.`,
           );
@@ -1009,7 +1009,8 @@ export function mergeModelOptions<M extends Model>(
           : [existingHooks[hookType]];
 
         if (!Array.isArray(optionValue[hookType])) {
-          // @ts-expect-error -- typescript doesn't like this merge algorithm.
+          // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error -- became valid in TS 5.8
+          // @ts-ignore -- typescript doesn't like this merge algorithm.
           existingHooks[hookType] = [...existingHooksOfType, optionValue[hookType]];
         } else {
           // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error -- This error only occurs on TS 5.3+

packages/core/src/model.d.ts

@@ -84,6 +84,7 @@ export interface Transactionable {
    * Internal only
    *
    * @private
+   * @hidden
    */
   [COMPLETES_TRANSACTION]?: boolean | undefined;
 }
@@ -1757,7 +1758,7 @@ export interface AttributeOptions<M extends Model = Model> {
   columnName?: string | undefined;
 
   /**
-   * A literal default value, a JavaScript function, or an SQL function (using {@link fn})
+   * A literal default value, a JavaScript function, or an SQL function (using {@link sql.fn})
    */
   defaultValue?: unknown | undefined;
 

packages/core/src/sequelize-typescript.ts

@@ -805,7 +805,7 @@ Connection options can be used at the root of the option bag, in the "replicatio
   /**
    * Escape value to be used in raw SQL.
    *
-   * If you are using this to use the value in a {@link literal}, consider using {@link sql} instead, which automatically
+   * If you are using this to use the value in a {@link sql.literal}, consider using {@link sql} instead, which automatically
    * escapes interpolated values.
    *
    * @param value The value to escape

packages/core/src/sequelize.d.ts

@@ -240,12 +240,12 @@ export class Sequelize<
    * @param fn The function you want to call
    * @param args All further arguments will be passed as arguments to the function
    *
-   * @deprecated use top level {@link fn} instead
+   * @deprecated use top level {@link sql.fn} instead
    * @hidden
    */
   static fn: typeof fn;
   /**
-   * @deprecated use top level {@link fn} instead
+   * @deprecated use top level {@link sql.fn} instead
    * @hidden
    */
   fn: typeof fn;
@@ -256,12 +256,12 @@ export class Sequelize<
    *
    * @param col The name of the column
    *
-   * @deprecated use top level {@link col} instead
+   * @deprecated use top level {@link sql.col} instead
    * @hidden
    */
   static col: typeof col;
   /**
-   * @deprecated use top level {@link col} instead
+   * @deprecated use top level {@link sql.col} instead
    * @hidden
    */
   col: typeof col;
@@ -287,12 +287,12 @@ export class Sequelize<
    *
    * @param val
    *
-   * @deprecated use top level {@link literal} instead
+   * @deprecated use top level {@link sql.literal} instead
    * @hidden
    */
   static literal: typeof literal;
   /**
-   * @deprecated use top level {@link literal} instead
+   * @deprecated use top level {@link sql.literal} instead
    * @hidden
    */
   literal: typeof literal;

packages/core/test/integration/data-types/data-types.test.ts

@@ -1545,7 +1545,7 @@ describe('DataTypes', () => {
   describe('BLOB', () => {
     const vars = beforeAll2(async () => {
       class User extends Model<InferAttributes<User>> {
-        declare attr: ArrayBuffer | string | Blob;
+        declare attr: ArrayBuffer | string | Buffer | Uint8Array;
       }
 
       User.init(
@@ -1589,6 +1589,8 @@ describe('DataTypes', () => {
       it('rejects Blobs & non-Uint8Array ArrayBufferViews', async () => {
         await expect(
           vars.User.create({
+            // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error -- error only appears in TS 5.5+
+            // @ts-ignore -- intentionally testing invalid input
             attr: new Blob(['abcd']),
           }),
         ).to.be.rejectedWith(
@@ -1598,6 +1600,8 @@ describe('DataTypes', () => {
 
         await expect(
           vars.User.create({
+            // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error -- error only appears in TS 5.5+
+            // @ts-ignore -- intentionally testing invalid input
             attr: new Uint16Array([49, 50, 51, 52]),
           }),
         ).to.be.rejectedWith(