fix(*): use extends for keyof to fix models, add rejectOnEmpty add find options for associations, fix multi scopes (#129)

Author: SimonSchick

.travis.yml

@@ -9,6 +9,7 @@ install:
   - typings install
 
 script:
+  - npm run lint
   - npm run build
   - npm test
 

index.d.ts

@@ -1,2 +1,3 @@
-
 export * from './lib/sequelize';
+export * from './lib/query-interface';
+export * from './lib/data-types'

lib/associations/belongs-to-many.d.ts

@@ -86,22 +86,11 @@ export class BelongsToMany extends Association {
  * The options for the getAssociations mixin of the belongsToMany association.
  * @see BelongsToManyGetAssociationsMixin
  */
-export interface BelongsToManyGetAssociationsMixinOptions {
-
-  /**
-   * An optional where clause to limit the associated models.
-   */
-  where?: WhereOptions;
-
+export interface BelongsToManyGetAssociationsMixinOptions extends FindOptions {
   /**
    * Apply a scope on the related model, or remove its default scope by passing false.
    */
   scope?: string | boolean;
-
-  /**
-   * Transaction to run query under
-   */
-  transaction?: Transaction;
 }
 
 /**

lib/associations/belongs-to.d.ts

@@ -1,6 +1,6 @@
 
-import {Association, SingleAssociationAccessors} from './base';
-import {Model, SaveOptions, CreateOptions} from '../model';
+import {Association, SingleAssociationAccessors, } from './base';
+import {Model, SaveOptions, CreateOptions, FindOptions } from '../model';
 import {DataType} from '../data-types';
 import {AssociationOptions} from './base';
 import {Promise} from '../promise';
@@ -35,11 +35,11 @@ export class BelongsTo extends Association {
  * The options for the getAssociation mixin of the belongsTo association.
  * @see BelongsToGetAssociationMixin
  */
-export interface BelongsToGetAssociationMixinOptions {
+export interface BelongsToGetAssociationMixinOptions extends FindOptions {
   /**
    * Apply a scope on the related model, or remove its default scope by passing false.
    */
-  scope?: string | boolean;
+  scope?: string | string[] | boolean;
 }
 
 /**

lib/associations/has-many.d.ts

@@ -26,22 +26,11 @@ export class HasMany extends Association {
    * The options for the getAssociations mixin of the hasMany association.
    * @see HasManyGetAssociationsMixin
    */
-  export interface HasManyGetAssociationsMixinOptions {
-
-    /**
-     * An optional where clause to limit the associated models.
-     */
-    where?: WhereOptions;
-
+  export interface HasManyGetAssociationsMixinOptions extends FindOptions {
     /**
      * Apply a scope on the related model, or remove its default scope by passing false.
      */
-    scope?: string | boolean;
-
-    /**
-     * Transaction to run query under
-     */
-    transaction?: Transaction;
+    scope?: string | string[] | boolean;
   }
 
   /**

lib/associations/has-one.d.ts

@@ -1,6 +1,6 @@
 
 import {Association, AssociationOptions, SingleAssociationAccessors} from './base';
-import {Model, SaveOptions, CreateOptions} from '../model';
+import {Model, SaveOptions, CreateOptions, FindOptions} from '../model';
 import {DataType} from '../data-types';
 import {Promise} from '../promise';
 
@@ -20,16 +20,15 @@ export class HasOne extends Association {
   constructor(source: typeof Model, target: typeof Model, options: HasOneOptions);
 }
 
-
 /**
  * The options for the getAssociation mixin of the hasOne association.
  * @see HasOneGetAssociationMixin
  */
-export interface HasOneGetAssociationMixinOptions {
+export interface HasOneGetAssociationMixinOptions extends FindOptions {
   /**
    * Apply a scope on the related model, or remove its default scope by passing false.
    */
-  scope?: string | boolean;
+  scope?: string | string[] | boolean;
 }
 
 /**

lib/model.d.ts

@@ -1,4 +1,3 @@
-
 import {Promise} from './promise';
 import {Col, Fn, Literal, Where} from './utils';
 import {SyncOptions} from './sequelize';
@@ -272,7 +271,7 @@ export interface IncludeThroughOptions {
 /**
  * Options for eager-loading associated models, also allowing for all associations to be loaded at once
  */
-export type Includeable = Model | Association | IncludeOptions | { all: true };
+export type Includeable = typeof Model | Association | IncludeOptions | { all: true };
 
 /**
  * Complex include options
@@ -449,6 +448,10 @@ export interface FindOptions {
    */
   subQuery?: boolean;
 
+  /**
+   * Throw if nothing was found.
+   */
+  rejectOnEmpty?: boolean;
 }
 
 /**
@@ -1839,15 +1842,19 @@ export abstract class Model {
    * Search for a single instance by its primary key. This applies LIMIT 1, so the listener will
    * always be called with a single instance.
    */
-  static findById<M extends Model>(this: {new (): M} & typeof Model, identifier?: number | string, options?: FindOptions): Promise<M | null>;
-  static findByPrimary<M extends Model>(this: {new (): M} & typeof Model, identifier?: number | string, options?: FindOptions): Promise<M | null>;
+  static findById<M extends Model>(this: {new (): M} & typeof Model, identifier?: number | string, options?: FindOptions & { rejectOnEmpty?: false }): Promise<M | null>;
+  static findById<M extends Model>(this: {new (): M} & typeof Model, identifier: number | string, options: FindOptions & { rejectOnEmpty: true }): Promise<M>;
+  static findByPrimary<M extends Model>(this: {new (): M} & typeof Model, identifier?: number | string, options?: FindOptions & { rejectOnEmpty?: false }): Promise<M | null>;
+  static findByPrimary<M extends Model>(this: {new (): M} & typeof Model, identifier: number | string, options: FindOptions & { rejectOnEmpty: true }): Promise<M>;
 
   /**
    * Search for a single instance. This applies LIMIT 1, so the listener will always be called with a single
    * instance.
    */
-  static findOne<M extends Model>(this: {new (): M} & typeof Model, options?: FindOptions): Promise<M | null>;
-  static find<M extends Model>(this: {new (): M} & typeof Model, options?: FindOptions): Promise<M | null>;
+  static findOne<M extends Model>(this: {new (): M} & typeof Model, options?: FindOptions & { rejectOnEmpty?: false }): Promise<M | null>;
+  static findOne<M extends Model>(this: {new (): M} & typeof Model, options: FindOptions & { rejectOnEmpty: true }): Promise<M>;
+  static find<M extends Model>(this: {new (): M} & typeof Model, options?: FindOptions & { rejectOnEmpty?: false }): Promise<M | null>;
+  static find<M extends Model>(this: {new (): M} & typeof Model, options: FindOptions & { rejectOnEmpty: true }): Promise<M>;
 
   /**
    * Run an aggregation method on the specified field
@@ -1858,7 +1865,7 @@ export abstract class Model {
    * @return Returns the aggregate result cast to `options.dataType`, unless `options.plain` is false, in
    *     which case the complete data result is returned.
    */
-  aggregate(field: keyof this, aggregateFunction: string, options?: AggregateOptions): Promise<any>;
+  aggregate<K extends keyof this>(field: K, aggregateFunction: string, options?: AggregateOptions): Promise<any>;
   static aggregate<M extends Model>(this: {new (): M} & typeof Model, field: keyof M, aggregateFunction: string, options?: AggregateOptions): Promise<any>;
 
   /**
@@ -2517,8 +2524,8 @@ export abstract class Model {
    *
    * If changed is called without an argument and no keys have changed, it will return `false`.
    */
-  changed(key: keyof this): boolean;
-  changed(key: keyof this, dirty: boolean): void;
+  changed<K extends keyof this>(key: K): boolean;
+  changed<K extends keyof this>(key: K, dirty: boolean): void;
   changed(): false | string[];
 
   /**
@@ -2592,7 +2599,7 @@ export abstract class Model {
    *               If an array is provided, the same is true for each column.
    *               If and object is provided, each column is incremented by the value given.
    */
-  increment(fields: keyof this | (keyof this)[] | Partial<this>, options?: IncrementDecrementOptions): Promise<this>;
+  increment<K extends keyof this>(fields: K | K[] | Partial<this>, options?: IncrementDecrementOptions): Promise<this>;
 
   /**
    * Decrement the value of one or more columns. This is done in the database, which means it does not use
@@ -2614,7 +2621,7 @@ export abstract class Model {
    *               If an array is provided, the same is true for each column.
    *               If and object is provided, each column is decremented by the value given
    */
-  decrement(fields: keyof this | (keyof this)[] | Partial<this>, options?: IncrementDecrementOptions): Promise<this>;
+  decrement<K extends keyof this>(fields: K | K[] | Partial<this>, options?: IncrementDecrementOptions): Promise<this>;
 
   /**
    * Check whether all values of this and `other` Instance are the same

package.json

@@ -9,18 +9,19 @@
     "@types/validator": "types/validator#83990944fcc53bcb4b05b347c3cdfcb7aa05b3c7"
   },
   "peerDependencies": {
-    "typescript": ">=2.0.0 <2.4.0"
+    "typescript": ">=2.0.0"
   },
   "devDependencies": {
     "tslint": "^5.4.3",
     "typedoc": "^0.7.1",
-    "typescript": "~2.3.4",
+    "typescript": "~2.5.2",
     "typings": "^2.1.1"
   },
   "scripts": {
     "build": "tsc -p . && typings bundle -o dist/index.d.ts",
     "test": "tsc -p test",
-    "typedoc": "typedoc --module es6 --target es6 --includeDeclarations --excludeExternals --readme docs_index.md --name \"TypeScript definitions for Sequelize\" --mode modules --out typedoc lib/sequelize.d.ts lib/model.d.ts lib/transaction.d.ts lib/errors.d.ts lib/data-types.d.ts lib/query-interface.d.ts lib/deferrable.d.ts lib/associations/base.d.ts lib/associations/belongs-to-many.d.ts lib/associations/belongs-to.d.ts lib/associations/has-many.d.ts lib/associations/has-one.d.ts typings/index.d.ts"
+    "typedoc": "typedoc --module es6 --target es6 --includeDeclarations --excludeExternals --readme docs_index.md --name \"TypeScript definitions for Sequelize\" --mode modules --out typedoc lib/sequelize.d.ts lib/model.d.ts lib/transaction.d.ts lib/errors.d.ts lib/data-types.d.ts lib/query-interface.d.ts lib/deferrable.d.ts lib/associations/base.d.ts lib/associations/belongs-to-many.d.ts lib/associations/belongs-to.d.ts lib/associations/has-many.d.ts lib/associations/has-one.d.ts typings/index.d.ts",
+    "lint": "tslint -p tsconfig.json && tslint -p test/tsconfig.json"
   },
   "repository": {
     "type": "git",

test/errors.ts

@@ -12,4 +12,3 @@ async function test() {
     }
   }
 }
-

test/include.ts

@@ -13,8 +13,8 @@ MyModel.findAll({
         separate: true,
         order: [['id', 'DESC']]
     }]
-})
+});
 
 MyModel.findAll({
   include: [{ all: true }]
-})
+});