added modelName to DefineOptions; added minfication hint in readme #7

Author: Robin Buschmann

README.md

@@ -22,7 +22,7 @@ Decorators and some other extras for sequelize (v3 + v4).
  - [Model valiation](#model-validation)
  - [Scopes](#scopes)
  - [Why `() => Model`?](#user-content-why---model)
- - [Limitations and recommendations](#limitations-and-recommendations)
+ - [Recommendations and limitations](#recommendations-and-limitations)
 
 ### Installation
 *sequelize-typescript* requires [sequelize](https://github.com/sequelize/sequelize)
@@ -552,8 +552,8 @@ comes to circular-dependencies (which are in general solved by node for you) `Mo
 when it gets passed to @ForeignKey. With the usage of a function, which returns the actual model, we prevent
 this issue.
 
-## Limitations and recommendations
-### One connection per model 
+## Recommendations and limitations 
+### One Sequelize instance per model 
 You cannot add one and the same model to multiple Sequelize instances with
 differently configured connections. So that one model will only work for one connection.
 ### One model class per file
@@ -562,3 +562,9 @@ of execution. Since typescript creates a `__metadata("design:type", SomeModel)`
 compile option, in some cases `SomeModel` is probably not defined(not undefined!) and would throw a `ReferenceError`.
 When putting `SomeModel` in a separate file, it would look like `__metadata("design:type", SomeModel_1.SomeModel)`,
 which does not throw an error.
+### Minification
+If you need to minify your code, you need to set `tableName` and `modelName` 
+in the `DefineOptions` for `@Table` annotation. sequelize-typescript
+uses the class name as default name for `tableName` and `modelName`. 
+When the code is minified the class name will no longer be the originally
+defined one (So that `class User` will become `class b` for example).

lib/annotations/Table.ts

@@ -1,8 +1,8 @@
 import 'reflect-metadata';
 import {setModelName, addOptions} from "../services/models";
-import {DefineOptions} from "sequelize";
+import {IDefineOptions} from "../interfaces/IDefineOptions";
 
-export function Table(options: DefineOptions<any>): Function;
+export function Table(options: IDefineOptions): Function;
 export function Table(target: any): void;
 export function Table(arg: any): void|Function {
 
@@ -12,19 +12,19 @@ export function Table(arg: any): void|Function {
     annotate(target);
   } else {
 
-    const options: DefineOptions<any> = Object.assign({}, arg);
+    const options: IDefineOptions = Object.assign({}, arg);
 
     return (target: any) => annotate(target, options);
   }
 }
 
-function annotate(target: any, options: DefineOptions<any> = {}): void {
+function annotate(target: any, options: IDefineOptions = {}): void {
 
   if (!options.tableName) options.tableName = target.name;
 
   options.instanceMethods = target.prototype;
   options.classMethods = target;
 
-  setModelName(target.prototype, options['modelName'] || target.name);
+  setModelName(target.prototype, options.modelName || target.name);
   addOptions(target.prototype, options);
 }

lib/interfaces/IDefineOptions.ts

@@ -0,0 +1,5 @@
+import {DefineOptions} from "sequelize";
+
+export interface IDefineOptions extends DefineOptions<any> {
+  modelName?: string;
+}

lib/models/v3/Sequelize.ts

@@ -1,6 +1,5 @@
 import 'reflect-metadata';
 import * as SequelizeOrigin from 'sequelize';
-import {DefineOptions} from 'sequelize';
 import {Model} from "../Model";
 import {ISequelizeConfig} from "../../interfaces/ISequelizeConfig";
 import {getModelName, getAttributes, getOptions} from "../../services/models";
@@ -39,7 +38,7 @@ export class Sequelize extends SequelizeOrigin implements BaseSequelize {
   getThroughModel(through: string): typeof Model {
 
     // tslint:disable:max-classes-per-file
-    @Table({tableName: through, modelName: through} as DefineOptions<any>)
+    @Table({tableName: through, modelName: through})
     class Through extends Model<Through> {
     }
 

lib/models/v4/Sequelize.ts

@@ -1,6 +1,5 @@
 import 'reflect-metadata';
 import * as OriginSequelize from 'sequelize';
-import {DefineOptions} from 'sequelize';
 import {Model} from "../Model";
 import {ISequelizeConfig} from "../../interfaces/ISequelizeConfig";
 import {getModelName, getAttributes, getOptions} from "../../services/models";
@@ -35,7 +34,7 @@ export class Sequelize extends OriginSequelize implements BaseSequelize {
   getThroughModel(through: string): typeof Model {
 
     // tslint:disable:max-classes-per-file
-    @Table({tableName: through, modelName: through} as DefineOptions<any>)
+    @Table({tableName: through, modelName: through})
     class Through extends Model<Through> {
     }
 

test/specs/instance.spec.ts

@@ -3,7 +3,6 @@ import {useFakeTimers} from 'sinon';
 import * as chaiAsPromised from 'chai-as-promised';
 import * as validateUUID from 'uuid-validate';
 import {createSequelize} from "../utils/sequelize";
-import {DefineOptions} from "sequelize";
 import {
   Sequelize, Model, Table, Column, AllowNull, PrimaryKey,
   ForeignKey, HasMany, BelongsTo, HasOne, DataType, Default
@@ -22,6 +21,7 @@ import {UserWithNoAutoIncrementation} from "../models/UserWithNoAutoIncrementati
 import {UserWithCustomUpdatedAt} from "../models/UserWithCustomUpdatedAt";
 import {UserWithCreatedAtButWithoutUpdatedAt} from "../models/UserWithCreatedAtButWithoutUpdatedAt";
 import chaiDatetime = require('chai-datetime');
+import {IDefineOptions} from "../../lib/interfaces/IDefineOptions";
 // import {UserWithSwag} from "../models/UserWithSwag";
 
 // TODO@robin create belongs to many with through options "add" test
@@ -2103,7 +2103,7 @@ describe('instance', () => {
 
     it('returns null for null, undefined, and unset boolean values', () => {
 
-      @Table({logging: true} as DefineOptions<any>)
+      @Table({logging: true} as IDefineOptions)
       class Setting extends Model<Setting> {
 
         @Column
@@ -2212,7 +2212,7 @@ describe('instance', () => {
 
     it('returns all values', () => {
 
-      @Table({logging: false} as DefineOptions<any>)
+      @Table({logging: false} as IDefineOptions)
       class UserHelper extends Model<UserHelper> {
 
         @Column

test/specs/model.spec.ts

@@ -6,7 +6,7 @@ import * as sinonChai from 'sinon-chai';
 import * as _ from 'lodash';
 import * as moment from 'moment';
 import * as Promise from 'bluebird';
-import {UniqueConstraintError, DefineOptions} from 'sequelize';
+import {UniqueConstraintError} from 'sequelize';
 import * as chaiAsPromised from 'chai-as-promised';
 import {createSequelize} from "../utils/sequelize";
 import {
@@ -16,6 +16,7 @@ import {
   BelongsToMany
 } from "../../index";
 import chaiDatetime = require('chai-datetime');
+import {IDefineOptions} from "../../lib/interfaces/IDefineOptions";
 
 use(sinonChai);
 use(chaiAsPromised);
@@ -494,7 +495,7 @@ describe('model', () => {
           fields: ['fieldD']
         }],
         engine: 'MyISAM'
-      } as DefineOptions<any>)
+      } as IDefineOptions)
       class ModelA extends Model<ModelA> {
         @Column
         fieldA: string;