add optimistic locking option

Author: hiradimir

lib/interfaces/IDefineOptions.ts

@@ -2,4 +2,9 @@ import {DefineOptions} from "sequelize";
 
 export interface IDefineOptions extends DefineOptions<any> {
   modelName?: string;
+
+  /**
+   * To enable optimistic locking.
+   */
+  version?: boolean;
 }

lib/models/Model.d.ts

@@ -466,6 +466,11 @@ export declare class Model<T> extends Hooks {
    */
   deletedAt?: Date|any;
 
+  /**
+   * version number automatically created by sequelize if table options.version is true
+   */
+  version?: number;
+
   /**
    * Returns true if this instance has not yet been persisted to the database
    */

test/models/UserWithVersion.ts

@@ -0,0 +1,9 @@
+import {Column, Model, Table} from "../../index";
+
+@Table({version: true})
+export class UserWithVersion extends Model<UserWithVersion> {
+
+  @Column
+  name: string;
+
+}

test/specs/instance.spec.ts

@@ -20,6 +20,7 @@ import {UserWithValidation} from "../models/UserWithValidation";
 import {UserWithNoAutoIncrementation} from "../models/UserWithNoAutoIncrementation";
 import {UserWithCustomUpdatedAt} from "../models/UserWithCustomUpdatedAt";
 import {UserWithCreatedAtButWithoutUpdatedAt} from "../models/UserWithCreatedAtButWithoutUpdatedAt";
+import {UserWithVersion} from "../models/UserWithVersion";
 import chaiDatetime = require('chai-datetime');
 import {IDefineOptions} from "../../lib/interfaces/IDefineOptions";
 // import {UserWithSwag} from "../models/UserWithSwag";
@@ -1481,6 +1482,29 @@ describe('instance', () => {
       });
     });
 
+
+    describe('with version option', () => {
+
+      it("version column is updated by sequelize", () => {
+        let version = undefined;
+          UserWithCustomUpdatedAt
+            .sync()
+            .then(() => UserWithVersion.create<UserWithVersion>({ name: 'john doe' }))
+            .then((johnDoe: UserWithVersion) => {
+              expect(johnDoe.version).not.to.be.undefined;
+              version = johnDoe.version;
+              return johnDoe.update({name: 'doe john'});
+            })
+            .then((johnDoe: UserWithVersion) => {
+              expect(johnDoe.name).not.equals('doe john');
+              expect(johnDoe.version).not.equals(version);
+              return johnDoe.update({});
+            })
+        }
+      )
+    });
+
+
     it('should fail a validation upon creating', () =>
       User
         .create({aNumber: 0, validateTest: 'hello'})