fix(typings): restrict update typings (#13216)

JacobLey · web-flow · commit 63ceb7381b3a · 2021-06-25T11:32:28.000-03:00
diff --git a/types/lib/model.d.ts b/types/lib/model.d.ts
@@ -2087,7 +2087,9 @@ export abstract class Model<TModelAttributes extends {} = any, TCreationAttribut
    */
   public static update<M extends Model>(
     this: ModelStatic<M>,
-    values: Partial<M['_attributes']>,
+    values: {
+        [key in keyof M['_attributes']]?: M['_attributes'][key] | Fn | Col | Literal;
+    },
     options: UpdateOptions<M['_attributes']>
   ): Promise<[number, M[]]>;
 
@@ -2744,8 +2746,13 @@ export abstract class Model<TModelAttributes extends {} = any, TCreationAttribut
   /**
    * This is the same as calling `set` and then calling `save`.
    */
-  public update<K extends keyof this>(key: K, value: this[K], options?: InstanceUpdateOptions<TModelAttributes>): Promise<this>;
-  public update(keys: object, options?: InstanceUpdateOptions<TModelAttributes>): Promise<this>;
+  public update<K extends keyof TModelAttributes>(key: K, value: TModelAttributes[K] | Col | Fn | Literal, options?: InstanceUpdateOptions<TModelAttributes>): Promise<this>;
+  public update(
+    keys: {
+        [key in keyof TModelAttributes]?: TModelAttributes[key] | Fn | Col | Literal;
+    },
+    options?: InstanceUpdateOptions<TModelAttributes>
+  ): Promise<this>;
 
   /**
    * Destroy the row corresponding to this instance. Depending on your setting for paranoid, the row will
diff --git a/types/test/update.ts b/types/test/update.ts
@@ -1,4 +1,4 @@
-import { Model } from 'sequelize';
+import { Model, fn, col, literal } from 'sequelize';
 import { User } from './models/User';
 
 class TestModel extends Model {
@@ -11,8 +11,27 @@ TestModel.update({}, { where: {}, returning: ['foo'] });
 
 
 User.update({}, { where: {} });
+User.update({
+    id: 123,
+    username: fn('FN'),
+    firstName: col('id'),
+    lastName: literal('Smith'),
+}, { where: {} });
 User.update({}, { where: {}, returning: true });
 User.update({}, { where: {}, returning: false });
 User.update({}, { where: {}, returning: ['username'] });
-// @ts-expect-error
+User.build().update({
+    id: 123,
+    username: fn('FN'),
+    firstName: col('id'),
+    lastName: literal('Smith'),
+});
+// @ts-expect-error invalid `returning`
 User.update({}, { where: {}, returning: ['foo'] });
+// @ts-expect-error no `where`
+User.update({}, {});
+// @ts-expect-error invalid attribute
+User.update({ foo: '<bar>' }, { where: {} });
+// @ts-expect-error invalid attribute
+User.build().update({ foo: '<bar>' });
+
