Merge pull request #101 from natesilva/feature/hooks

feature(hooks): add decorators for declaring hooks

Author: RobinBuschmann

README.md

@@ -21,6 +21,7 @@ Decorators and some other extras for sequelize (v3 + v4).
    - [Multiple relations of same models](#multiple-relations-of-same-models)
  - [Model validation](#model-validation)
  - [Scopes](#scopes)
+ - [Hooks](#hooks)
  - [Why `() => Model`?](#user-content-why---model)
  - [Recommendations and limitations](#recommendations-and-limitations)
 
@@ -552,6 +553,34 @@ export class ShoeWithScopes extends Model<ShoeWithScopes> {
 }
 ```
 
+## Hooks
+Hooks can be attached to your models. All Model-level hooks are supported. See [the related unit tests](test/models/Hook.ts) for a summary.
+
+Each hook must be a `static` method. Multiple hooks can be attached to a single method, and you can define multiple methods for a given hook.
+
+The name of the method cannot be the same as the name of the hook (for example, a `@BeforeCreate` hook method cannot be named `beforeCreate`). That’s because Sequelize has pre-defined methods with those names.
+
+```typescript
+@Table
+export class Person extends Model<Person> {
+  @Column
+  name: string;
+
+  @BeforeUpdate
+  @BeforeCreate
+  static makeUpperCase(instance: Person) {
+    // this will be called when an instance is created or updated
+    instance.name = instance.name.toLocaleUpperCase();
+  }
+
+  @BeforeCreate
+  static addUnicorn(instance: Person) {
+    // this will also be called when an instance is created
+    instance.name += ' 🦄';
+  }
+}
+```
+
 ## Why `() => Model`?
 `@ForeignKey(Model)` is much easier to read, so why is `@ForeignKey(() => Model)` so important? When it
 comes to circular-dependencies (which are in general solved by node for you) `Model` can be `undefined`

index.ts

@@ -51,6 +51,40 @@ export {NotIn} from "./lib/annotations/validation/NotIn";
 export {NotNull} from "./lib/annotations/validation/NotNull";
 export {Validate} from "./lib/annotations/validation/Validate";
 
+// hooks
+export {BeforeValidate} from "./lib/annotations/hooks/BeforeValidate";
+export {AfterValidate} from "./lib/annotations/hooks/AfterValidate";
+export {ValidationFailed} from "./lib/annotations/hooks/ValidationFailed";
+export {BeforeCreate} from "./lib/annotations/hooks/BeforeCreate";
+export {AfterCreate} from "./lib/annotations/hooks/AfterCreate";
+export {BeforeDestroy} from "./lib/annotations/hooks/BeforeDestroy";
+export {AfterDestroy} from "./lib/annotations/hooks/AfterDestroy";
+export {BeforeRestore} from "./lib/annotations/hooks/BeforeRestore";
+export {AfterRestore} from "./lib/annotations/hooks/AfterRestore";
+export {BeforeUpdate} from "./lib/annotations/hooks/BeforeUpdate";
+export {AfterUpdate} from "./lib/annotations/hooks/AfterUpdate";
+export {BeforeSave} from "./lib/annotations/hooks/BeforeSave";
+export {AfterSave} from "./lib/annotations/hooks/AfterSave";
+export {BeforeUpsert} from "./lib/annotations/hooks/BeforeUpsert";
+export {AfterUpsert} from "./lib/annotations/hooks/AfterUpsert";
+export {BeforeBulkCreate} from "./lib/annotations/hooks/BeforeBulkCreate";
+export {AfterBulkCreate} from "./lib/annotations/hooks/AfterBulkCreate";
+export {BeforeBulkDestroy} from "./lib/annotations/hooks/BeforeBulkDestroy";
+export {AfterBulkDestroy} from "./lib/annotations/hooks/AfterBulkDestroy";
+export {BeforeBulkRestore} from "./lib/annotations/hooks/BeforeBulkRestore";
+export {AfterBulkRestore} from "./lib/annotations/hooks/AfterBulkRestore";
+export {BeforeBulkUpdate} from "./lib/annotations/hooks/BeforeBulkUpdate";
+export {AfterBulkUpdate} from "./lib/annotations/hooks/AfterBulkUpdate";
+export {BeforeFind} from "./lib/annotations/hooks/BeforeFind";
+export {BeforeFindAfterExpandIncludeAll} from "./lib/annotations/hooks/BeforeFindAfterExpandIncludeAll";
+export {BeforeFindAfterOptions} from "./lib/annotations/hooks/BeforeFindAfterOptions";
+export {AfterFind} from "./lib/annotations/hooks/AfterFind";
+export {BeforeCount} from "./lib/annotations/hooks/BeforeCount";
+export {BeforeDelete} from "./lib/annotations/hooks/BeforeDelete";
+export {AfterDelete} from "./lib/annotations/hooks/AfterDelete";
+export {BeforeBulkDelete} from "./lib/annotations/hooks/BeforeBulkDelete";
+export {AfterBulkDelete} from "./lib/annotations/hooks/AfterBulkDelete";
+
 // interfaces
 export {IAssociationActionOptions} from "./lib/interfaces/IAssociationActionOptions";
 export {IBuildOptions} from "./lib/interfaces/IBuildOptions";

lib/annotations/hooks/AfterBulkCreate.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterBulkCreate(target: any, propertyName: string): void;
+export function AfterBulkCreate(options: IHookOptions): Function;
+export function AfterBulkCreate(...args: any[]): void|Function {
+  return implementHookDecorator('afterBulkCreate', args);
+}

lib/annotations/hooks/AfterBulkDelete.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterBulkDelete(target: any, propertyName: string): void;
+export function AfterBulkDelete(options: IHookOptions): Function;
+export function AfterBulkDelete(...args: any[]): void|Function {
+  return implementHookDecorator('afterBulkDelete', args);
+}

lib/annotations/hooks/AfterBulkDestroy.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterBulkDestroy(target: any, propertyName: string): void;
+export function AfterBulkDestroy(options: IHookOptions): Function;
+export function AfterBulkDestroy(...args: any[]): void|Function {
+  return implementHookDecorator('afterBulkDestroy', args);
+}

lib/annotations/hooks/AfterBulkRestore.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterBulkRestore(target: any, propertyName: string): void;
+export function AfterBulkRestore(options: IHookOptions): Function;
+export function AfterBulkRestore(...args: any[]): void|Function {
+  return implementHookDecorator('afterBulkRestore', args);
+}

lib/annotations/hooks/AfterBulkSync.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterBulkSync(target: any, propertyName: string): void;
+export function AfterBulkSync(options: IHookOptions): Function;
+export function AfterBulkSync(...args: any[]): void|Function {
+  return implementHookDecorator('afterBulkSync', args);
+}

lib/annotations/hooks/AfterBulkUpdate.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterBulkUpdate(target: any, propertyName: string): void;
+export function AfterBulkUpdate(options: IHookOptions): Function;
+export function AfterBulkUpdate(...args: any[]): void|Function {
+  return implementHookDecorator('afterBulkUpdate', args);
+}

lib/annotations/hooks/AfterConnect.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterConnect(target: any, propertyName: string): void;
+export function AfterConnect(options: IHookOptions): Function;
+export function AfterConnect(...args: any[]): void|Function {
+  return implementHookDecorator('afterConnect', args);
+}

lib/annotations/hooks/AfterCreate.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterCreate(target: any, propertyName: string): void;
+export function AfterCreate(options: IHookOptions): Function;
+export function AfterCreate(...args: any[]): void|Function {
+  return implementHookDecorator('afterCreate', args);
+}

lib/annotations/hooks/AfterDefine.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterDefine(target: any, propertyName: string): void;
+export function AfterDefine(options: IHookOptions): Function;
+export function AfterDefine(...args: any[]): void|Function {
+  return implementHookDecorator('afterDefine', args);
+}

lib/annotations/hooks/AfterDelete.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterDelete(target: any, propertyName: string): void;
+export function AfterDelete(options: IHookOptions): Function;
+export function AfterDelete(...args: any[]): void|Function {
+  return implementHookDecorator('afterDelete', args);
+}

lib/annotations/hooks/AfterDestroy.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterDestroy(target: any, propertyName: string): void;
+export function AfterDestroy(options: IHookOptions): Function;
+export function AfterDestroy(...args: any[]): void|Function {
+  return implementHookDecorator('afterDestroy', args);
+}

lib/annotations/hooks/AfterFind.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterFind(target: any, propertyName: string): void;
+export function AfterFind(options: IHookOptions): Function;
+export function AfterFind(...args: any[]): void|Function {
+  return implementHookDecorator('afterFind', args);
+}

lib/annotations/hooks/AfterInit.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterInit(target: any, propertyName: string): void;
+export function AfterInit(options: IHookOptions): Function;
+export function AfterInit(...args: any[]): void|Function {
+  return implementHookDecorator('afterInit', args);
+}

lib/annotations/hooks/AfterRestore.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterRestore(target: any, propertyName: string): void;
+export function AfterRestore(options: IHookOptions): Function;
+export function AfterRestore(...args: any[]): void|Function {
+  return implementHookDecorator('afterRestore', args);
+}

lib/annotations/hooks/AfterSave.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterSave(target: any, propertyName: string): void;
+export function AfterSave(options: IHookOptions): Function;
+export function AfterSave(...args: any[]): void|Function {
+  return implementHookDecorator('afterSave', args);
+}

lib/annotations/hooks/AfterSync.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterSync(target: any, propertyName: string): void;
+export function AfterSync(options: IHookOptions): Function;
+export function AfterSync(...args: any[]): void|Function {
+  return implementHookDecorator('afterSync', args);
+}

lib/annotations/hooks/AfterUpdate.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterUpdate(target: any, propertyName: string): void;
+export function AfterUpdate(options: IHookOptions): Function;
+export function AfterUpdate(...args: any[]): void|Function {
+  return implementHookDecorator('afterUpdate', args);
+}

lib/annotations/hooks/AfterUpsert.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterUpsert(target: any, propertyName: string): void;
+export function AfterUpsert(options: IHookOptions): Function;
+export function AfterUpsert(...args: any[]): void|Function {
+  return implementHookDecorator('afterUpsert', args);
+}

lib/annotations/hooks/AfterValidate.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function AfterValidate(target: any, propertyName: string): void;
+export function AfterValidate(options: IHookOptions): Function;
+export function AfterValidate(...args: any[]): void|Function {
+  return implementHookDecorator('afterValidate', args);
+}

lib/annotations/hooks/BeforeBulkCreate.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeBulkCreate(target: any, propertyName: string): void;
+export function BeforeBulkCreate(options: IHookOptions): Function;
+export function BeforeBulkCreate(...args: any[]): void|Function {
+  return implementHookDecorator('beforeBulkCreate', args);
+}

lib/annotations/hooks/BeforeBulkDelete.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeBulkDelete(target: any, propertyName: string): void;
+export function BeforeBulkDelete(options: IHookOptions): Function;
+export function BeforeBulkDelete(...args: any[]): void|Function {
+  return implementHookDecorator('beforeBulkDelete', args);
+}

lib/annotations/hooks/BeforeBulkDestroy.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeBulkDestroy(target: any, propertyName: string): void;
+export function BeforeBulkDestroy(options: IHookOptions): Function;
+export function BeforeBulkDestroy(...args: any[]): void|Function {
+  return implementHookDecorator('beforeBulkDestroy', args);
+}

lib/annotations/hooks/BeforeBulkRestore.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeBulkRestore(target: any, propertyName: string): void;
+export function BeforeBulkRestore(options: IHookOptions): Function;
+export function BeforeBulkRestore(...args: any[]): void|Function {
+  return implementHookDecorator('beforeBulkRestore', args);
+}

lib/annotations/hooks/BeforeBulkSync.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeBulkSync(target: any, propertyName: string): void;
+export function BeforeBulkSync(options: IHookOptions): Function;
+export function BeforeBulkSync(...args: any[]): void|Function {
+  return implementHookDecorator('beforeBulkSync', args);
+}

lib/annotations/hooks/BeforeBulkUpdate.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeBulkUpdate(target: any, propertyName: string): void;
+export function BeforeBulkUpdate(options: IHookOptions): Function;
+export function BeforeBulkUpdate(...args: any[]): void|Function {
+  return implementHookDecorator('beforeBulkUpdate', args);
+}

lib/annotations/hooks/BeforeConnect.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeConnect(target: any, propertyName: string): void;
+export function BeforeConnect(options: IHookOptions): Function;
+export function BeforeConnect(...args: any[]): void|Function {
+  return implementHookDecorator('beforeConnect', args);
+}

lib/annotations/hooks/BeforeCount.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeCount(target: any, propertyName: string): void;
+export function BeforeCount(options: IHookOptions): Function;
+export function BeforeCount(...args: any[]): void|Function {
+  return implementHookDecorator('beforeCount', args);
+}

lib/annotations/hooks/BeforeCreate.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeCreate(target: any, propertyName: string): void;
+export function BeforeCreate(options: IHookOptions): Function;
+export function BeforeCreate(...args: any[]): void|Function {
+  return implementHookDecorator('beforeCreate', args);
+}

lib/annotations/hooks/BeforeDefine.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeDefine(target: any, propertyName: string): void;
+export function BeforeDefine(options: IHookOptions): Function;
+export function BeforeDefine(...args: any[]): void|Function {
+  return implementHookDecorator('beforeDefine', args);
+}

lib/annotations/hooks/BeforeDelete.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeDelete(target: any, propertyName: string): void;
+export function BeforeDelete(options: IHookOptions): Function;
+export function BeforeDelete(...args: any[]): void|Function {
+  return implementHookDecorator('beforeDelete', args);
+}

lib/annotations/hooks/BeforeDestroy.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeDestroy(target: any, propertyName: string): void;
+export function BeforeDestroy(options: IHookOptions): Function;
+export function BeforeDestroy(...args: any[]): void|Function {
+  return implementHookDecorator('beforeDestroy', args);
+}

lib/annotations/hooks/BeforeFind.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeFind(target: any, propertyName: string): void;
+export function BeforeFind(options: IHookOptions): Function;
+export function BeforeFind(...args: any[]): void|Function {
+  return implementHookDecorator('beforeFind', args);
+}

lib/annotations/hooks/BeforeFindAfterExpandIncludeAll.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeFindAfterExpandIncludeAll(target: any, propertyName: string): void;
+export function BeforeFindAfterExpandIncludeAll(options: IHookOptions): Function;
+export function BeforeFindAfterExpandIncludeAll(...args: any[]): void|Function {
+  return implementHookDecorator('beforeFindAfterExpandIncludeAll', args);
+}

lib/annotations/hooks/BeforeFindAfterOptions.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeFindAfterOptions(target: any, propertyName: string): void;
+export function BeforeFindAfterOptions(options: IHookOptions): Function;
+export function BeforeFindAfterOptions(...args: any[]): void|Function {
+  return implementHookDecorator('beforeFindAfterOptions', args);
+}

lib/annotations/hooks/BeforeInit.ts

@@ -0,0 +1,8 @@
+import {IHookOptions} from "../../interfaces/IHookOptions";
+import {implementHookDecorator} from "../../services/hooks";
+
+export function BeforeInit(target: any, propertyName: string): void;
+export function BeforeInit(options: IHookOptions): Function;
+export function BeforeInit(...args: any[]): void|Function {
+  return implementHookDecorator('beforeInit', args);
+}