Merge pull request #206 from RobinBuschmann/issue-204-scope-typings

closes #204 scope typings

Author: RobinBuschmann

lib/models/Model.d.ts

@@ -21,6 +21,8 @@ import {ICountOptions} from '../interfaces/ICountOptions';
 /* tslint:disable:array-type */
 /* tslint:disable:max-line-length */
 /* tslint:disable:max-classes-per-file */
+type ForTypeOf<T> = {[P in keyof T]: T[P]};
+type NonAbstractTypeOfModel<T> = (new () => T) & ForTypeOf<typeof Model>;
 
 export declare abstract class Model<T> extends Hooks {
 
@@ -132,7 +134,7 @@ export declare abstract class Model<T> extends Hooks {
    * @return Model A reference to the model, with the scope(s) applied. Calling scope again on the returned
    *     model will clear the previous scope.
    */
-  static scope(options?: string | string[] | ScopeOptions | WhereOptions<any>): typeof Model;
+  static scope<T>(this: NonAbstractTypeOfModel<T>, options?: string | string[] | ScopeOptions | WhereOptions<any>): NonAbstractTypeOfModel<T>;
 
   /**
    * Search for multiple instances.
@@ -407,7 +409,7 @@ export declare abstract class Model<T> extends Hooks {
   /**
    * Unscope the model
    */
-  static unscoped(): typeof Model;
+  static unscoped<T>(this: NonAbstractTypeOfModel<T>): NonAbstractTypeOfModel<T>;
 
   /**
    * A reference to the sequelize instance

test/specs/scopes.spec.ts

@@ -70,7 +70,7 @@ describe('scopes', () => {
 
     it('should consider other scopes', () =>
 
-      (ShoeWithScopes.scope('full') as typeof ShoeWithScopes).findOne()
+      ShoeWithScopes.scope('full').findOne()
         .then(shoe => {
 
           expect(shoe).to.have.property('manufacturer').which.is.not.null;
@@ -89,8 +89,8 @@ describe('scopes', () => {
     );
 
     it('should not consider default scope due to unscoped call', () =>
-      (ShoeWithScopes
-        .unscoped() as typeof ShoeWithScopes)
+      ShoeWithScopes
+        .unscoped()
         .findOne()
         .then(shoe => {
           expect(shoe).to.have.property('secretKey').which.is.a('string');
@@ -101,7 +101,7 @@ describe('scopes', () => {
 
       it('should consider scopes and additional included model (object)', () =>
         expect(
-          (ShoeWithScopes.scope('full') as typeof ShoeWithScopes)
+          ShoeWithScopes.scope('full')
             .findOne({
               include: [{
                 model: Person,
@@ -117,7 +117,7 @@ describe('scopes', () => {
 
       it('should consider scopes and additional included model (model)', () =>
         expect(
-          (ShoeWithScopes.scope('full') as typeof ShoeWithScopes)
+          ShoeWithScopes.scope('full')
             .findOne({
               include: [Person]
             })
@@ -131,7 +131,7 @@ describe('scopes', () => {
 
       it('should not consider default scope due to unscoped call, but additonal includes (object)', () =>
 
-        (ShoeWithScopes.unscoped() as typeof ShoeWithScopes)
+        ShoeWithScopes.unscoped()
           .findOne({
             include: [{model: Person}]
           })
@@ -143,8 +143,8 @@ describe('scopes', () => {
 
       it('should not consider default scope due to unscoped call, but additonal includes (model)', () =>
 
-        (ShoeWithScopes
-          .unscoped() as typeof ShoeWithScopes)
+        ShoeWithScopes
+          .unscoped()
           .findOne({
             include: [Person]
           })
@@ -169,7 +169,7 @@ describe('scopes', () => {
         );
 
         it('should consider scope of included model (with own scope)', () =>
-          (ShoeWithScopes.scope('red') as typeof ShoeWithScopes)
+          ShoeWithScopes.scope('red')
             .findOne({
               include: [Manufacturer.scope('brandOnly') as typeof Manufacturer]
             })
@@ -187,7 +187,7 @@ describe('scopes', () => {
     describe('with nested scope', () => {
 
       it('should consider nested scope', () =>
-        (ShoeWithScopes.scope('manufacturerWithScope') as typeof ShoeWithScopes)
+        ShoeWithScopes.scope('manufacturerWithScope')
           .findOne()
           .then(shoe => {
             expect(shoe).to.have.property('manufacturer')
@@ -197,7 +197,7 @@ describe('scopes', () => {
       );
 
       it('should not consider nested scope', () =>
-        (ShoeWithScopes.scope('full') as typeof ShoeWithScopes)
+        ShoeWithScopes.scope('full')
           .findOne()
           .then(shoe => {
             expect(shoe).to.have.property('manufacturer')
@@ -211,15 +211,15 @@ describe('scopes', () => {
     describe('with scope function', () => {
 
       it('should find appropriate shoe due to correctly passed scope function param', () =>
-        (ShoeWithScopes.scope({method: ['primaryColor', 'red']})  as typeof ShoeWithScopes)
+        ShoeWithScopes.scope({method: ['primaryColor', 'red']})
           .findOne()
           .then(shoe => {
             expect(shoe).to.have.property('primaryColor', 'red');
           })
       );
 
       it('should find appropriate shoe due to correctly passed scope function param including associated model', () =>
-        (ShoeWithScopes.scope({method: ['primaryColorWithManufacturer', 'red']})  as typeof ShoeWithScopes)
+        ShoeWithScopes.scope({method: ['primaryColorWithManufacturer', 'red']})
           .findOne()
           .then(shoe => {
             expect(shoe).to.have.property('primaryColor', 'red');