Merge branch 'master' into accessors

Author: Robin Buschmann

.npmignore

@@ -4,5 +4,6 @@ npm-debug.log
 .gitignore
 tsconfig.json
 test
+example
 .DS_Store
 .idea

README.md

@@ -9,6 +9,8 @@ Decorators and some other extras for sequelize (v3 + v4).
    - [`@Table` API](#table-api)
    - [`@Column` API](#column-api)
  - [Usage](#usage)
+   - [Configuration](#Ccnfiguration)
+   - [Model-path resolving](#model-path-resolving)
  - [Model association](#model-association)
    - [One-to-many](#one-to-many)
    - [Many-to-many](#many-to-many)
@@ -173,15 +175,26 @@ const sequelize =  new Sequelize({
         username: 'root',
         password: '',
         storage: ':memory:',
-        modelPaths: [__dirname + '/models'] // here
+        modelPaths: [__dirname + '/models']
 });
-
-sequelize.addModels([Person]); // and/or here
 ```
 Before you can use your models, you have to tell sequelize where they can be found. So either set `modelPaths` in the 
 sequlize config or add the required models later on by calling `sequelize.addModels([Person])` or 
-`sequelize.addModels([__dirname + '/models'])`.
+`sequelize.addModels([__dirname + '/models'])`:
+
+```typescript
+sequelize.addModels([Person]);
+sequelize.addModels(['path/to/models']);
+```
+#### Model-path resolving
+When using a path to resolve the required models, either the class has to be exported as default or if not exported
+as default, the file should have the same name as the corresponding class:
+```typescript
+export default class User extends Model<User> {}
 
+// User.ts
+export class User extends Model<User> {}
+```
 ### Build and create
 Instantiation and inserts can be achieved in the good old sequelize way
 ```typescript
@@ -361,10 +374,10 @@ explicitly:
   proofedBooks: Book[];
 ```
 
-### Type safe usage of generated getter and setter
-With the creation of a relation, sequelize generates getter and setter functions on the corresponding
+### Type safe usage of auto generated functions
+With the creation of a relation, sequelize generates some method on the corresponding
 models. So when you create a 1:n relation between `ModelA` and `ModelB`, an instance of `ModelA` will
-have the functions `getModelBs`, `setModelBs`, `addModelB`. These functions still exist with *sequelize-typescript*. 
+have the functions `getModelBs`, `setModelBs`, `addModelB`, `removeModelB`, `hasModelB`. These functions still exist with *sequelize-typescript*. 
 But TypeScript will not know of them and in turn will complain, when you try to access `getModelB`, `setModelB` or 
 `addModelB`. To make TypeScript happy, the `Model.prototype` of *sequelize-typescript* has `$set`, `$get`, `$add` 
 functions. 
@@ -387,9 +400,13 @@ To use them pass the property key of the respective relation as the first parame
 ```typescript
 const modelA = new ModelA();
 
-modelA.$set('bs', [ /* models */]).then( /* ... */);
-modelA.$add('b', /* model */).then( /* ... */);
+modelA.$set('bs', [ /* instance */]).then( /* ... */);
+modelA.$add('b', /* instance */).then( /* ... */);
 modelA.$get('bs').then( /* ... */);
+modelA.$count('bs').then( /* ... */);
+modelA.$has('bs').then( /* ... */);
+modelA.$remove('bs', /* instance */ ).then( /* ... */);
+modelA.$create('bs', /* value */ ).then( /* ... */);
 ```
 
 ## Model validation

example/app.ts

@@ -5,7 +5,7 @@ import {Comment} from './models/Comment';
 import {Sequelize} from "../index";
 import * as prettyjson from 'prettyjson';
 import {Person} from "./models/validation-only/Person";
-import {Book} from "./models/Book";
+import Book from "./models/Book";
 
 /* tslint:disable:no-console */
 /* tslint:disable:no-unused-new */

example/models/Author.ts

@@ -1,7 +1,7 @@
 import {Table, Model, PrimaryKey, Column, AutoIncrement, BelongsToMany,
 DefaultScope, Scopes} from "../../index";
 import {AuthorFriend} from "./AuthorFriend";
-import {Book} from "./Book";
+import Book from "./Book";
 
 @DefaultScope({
   attributes: ['id', 'name']

example/models/Book.ts

@@ -8,7 +8,7 @@ import {Author} from "./Author";
   }]}
 })
 @Table
-export class Book extends Model<Book> {
+export default class Book extends Model<Book> {
 
   @Column
   title: string;

lib/services/models.ts

@@ -195,7 +195,7 @@ export function getModels(arg: Array<typeof Model|string>): Array<typeof Model>
           if (!module[modelName] && !module.default) {
             throw new Error(`No default export defined for file "${file}" or export does not satisfy filename.`);
           }
-          return module[modelName];
+          return module[modelName] || module.default;
         });
 
       models.push(..._models);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sequelize-typescript",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Decorators and some other extras for sequelize (v3 + v4)",
   "scripts": {
     "build": "tsc && tsc --project lib/models/v4",

test/models/exports/Game.ts

@@ -0,0 +1,8 @@
+import {Table, Column, Model} from '../../../index';
+
+@Table
+export class Game extends Model<Game> {
+
+  @Column
+  title: string;
+}

test/models/exports/gamer.model.ts

@@ -0,0 +1,8 @@
+import {Table, Column, Model} from '../../../index';
+
+@Table
+export default class Gamer extends Model<Gamer> {
+
+  @Column
+  nickname: string;
+}

test/models/exports/throws/_cheater.ts

@@ -0,0 +1,4 @@
+import {Table, Model} from '../../../../index';
+
+@Table
+export class Cheater extends Model<Cheater> {}