Feat() Update doc by describing the provided decorators

README.md

@@ -35,6 +35,7 @@
         - [Middleware](#middleware)
         - [Router](#router)
         - [Module](#module)
+- [Decorators](#decorators)
 - [Entity event handling](#entity-event-handling)
 
 # Getting started
@@ -315,6 +316,21 @@ export class MyModule {}
 
 That's it you've completed your first module :rocket:
 
+## Decorators
+
+Here is the list of the provided decorators.
+
+| Decorator                        | Description                                                                 | Option               |
+| ----------------------           | ----------------------                                                      | ----------------------
+| @Entity(/*...*/)                 | Decorate an entity                                                          | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type<TOverride>; };`
+| @Repository(/*...*/)             | Decorate a repository                                                       | `{ resolutionKey?: string; override?: Type<TOverride>; };`
+| @Service(/*...*/)                | Decorate a service                                                          | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type<TOverride>; };`
+| @Middleware(/*...*/)             | Decorate a middleware                                                       | `{ requireAuth: boolean; string; routerOptions: MedusaRouteOptions[]; };`
+| @Router(/*...*/)                 | Decorate a router                                                           | `{ router: RoutesInjectionRouterConfiguration[]; };`
+| @Migration(/*...*/)              | Decorate a migration                                                        | 
+| @OnMedusaEntityEvent.\*.\*(/*...*/)| Can be used to send the right event type or register handler to an event    |
+
+
 ## Entity event handling
 
 One of the feature out the box is the ability to emit (sync/async) event from

docs/README.md

@@ -37,6 +37,7 @@ medusa-extender / [Exports](modules.md)
         - [Middleware](#middleware)
         - [Router](#router)
         - [Module](#module)
+- [Decorators](#decorators)
 - [Entity event handling](#entity-event-handling)
 
 # Getting started
@@ -317,6 +318,20 @@ export class MyModule {}
 
 That's it you've completed your first module :rocket:
 
+## Decorators
+
+Here is the list of the provided decorators.
+
+| Decorator                        | Description                                                                 | Option               |
+| ----------------------           | ----------------------                                                      | ----------------------
+| @Entity(/*...*/)                 | Decorate an entity                                                          | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type<TOverride>; };`
+| @Repository(/*...*/)             | Decorate a repository                                                       | `{ resolutionKey?: string; override?: Type<TOverride>; };`
+| @Service(/*...*/)                | Decorate a service                                                          | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type<TOverride>; };`
+| @Middleware(/*...*/)             | Decorate a middleware                                                       | `{ requireAuth: boolean; string; routerOptions: MedusaRouteOptions[]; };`
+| @Router(/*...*/)                 | Decorate a router                                                           | `{ router: RoutesInjectionRouterConfiguration[]; };`
+| @Migration(/*...*/)              | Decorate a migration                                                        | 
+| @OnMedusaEntityEvent.\*.\*(/*...*/)| Can be used to send the right event type or register handler to an event    |
+
 ## Entity event handling
 
 One of the feature out the box is the ability to emit (sync/async) event from

docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md

@@ -45,7 +45,7 @@
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
+[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
 
 ## Properties
 
@@ -55,7 +55,7 @@
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
+[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
+[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
 
 ## Accessors
 
@@ -79,7 +79,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
+[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
 
 ___
 
@@ -93,7 +93,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
+[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
 
 ## Methods
 
@@ -120,7 +120,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
+[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
 
 ___
 
@@ -146,7 +146,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
+[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
 
 ___
 
@@ -173,7 +173,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
+[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
 
 ___
 
@@ -199,7 +199,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
+[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
 
 ___
 
@@ -226,7 +226,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
+[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
 
 ___
 
@@ -252,7 +252,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
+[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
 
 ___
 
@@ -280,7 +280,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
+[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
 
 ___
 
@@ -300,4 +300,4 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
+[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L54)

docs/classes/event_emmiter.Internals.CustomEventEmmiter.md

@@ -41,7 +41,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L21)
+[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L21)
 
 ## Properties
 
@@ -51,7 +51,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L19)
+[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L19)
 
 ## Methods
 
@@ -74,7 +74,7 @@ Emit an asynchrone event entity based and wait for the result.
 
 #### Defined in
 
-[src/event-emmiter.ts:81](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L81)
+[src/event-emmiter.ts:81](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L81)
 
 ___
 
@@ -104,7 +104,7 @@ Register a new event handler.
 
 #### Defined in
 
-[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L31)
+[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L31)
 
 ___
 
@@ -126,7 +126,7 @@ Apply all event handlers hold by the `listenerDescriptor`.
 
 #### Defined in
 
-[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L43)
+[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L43)
 
 ___
 
@@ -140,4 +140,4 @@ ___
 
 #### Defined in
 
-[src/event-emmiter.ts:69](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L69)
+[src/event-emmiter.ts:69](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L69)

docs/classes/loader.Loader.md

@@ -44,4 +44,4 @@ internal container and database connection.
 
 #### Defined in
 
-[src/loader.ts:35](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/loader.ts#L35)
+[src/loader.ts:35](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loader.ts#L35)

docs/classes/medusa.Medusa.md

@@ -36,7 +36,7 @@ Register steps that must be executed before/after medusa is load.
 
 #### Defined in
 
-[src/medusa.ts:15](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/medusa.ts#L15)
+[src/medusa.ts:15](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/medusa.ts#L15)
 
 ## Properties
 
@@ -46,7 +46,7 @@ Register steps that must be executed before/after medusa is load.
 
 #### Defined in
 
-[src/medusa.ts:8](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/medusa.ts#L8)
+[src/medusa.ts:8](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/medusa.ts#L8)
 
 ___
 
@@ -56,7 +56,7 @@ ___
 
 #### Defined in
 
-[src/medusa.ts:9](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/medusa.ts#L9)
+[src/medusa.ts:9](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/medusa.ts#L9)
 
 ## Methods
 
@@ -78,4 +78,4 @@ Launch all the steps before/after medusa according to the `stepOptions`.
 
 #### Defined in
 
-[src/medusa.ts:23](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/medusa.ts#L23)
+[src/medusa.ts:23](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/medusa.ts#L23)

docs/classes/metadata_reader.Internals.CustomMap.md

@@ -84,4 +84,4 @@ Map.get
 
 #### Defined in
 
-[src/metadata-reader.ts:6](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/metadata-reader.ts#L6)
+[src/metadata-reader.ts:6](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/metadata-reader.ts#L6)

docs/classes/utils.Utils.md

@@ -56,7 +56,7 @@ Attach a new subscriber to a specific entities.
 
 #### Defined in
 
-[src/utils.ts:40](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L40)
+[src/utils.ts:40](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L40)
 
 ___
 
@@ -78,7 +78,7 @@ Log all the routes from the express instance.
 
 #### Defined in
 
-[src/utils.ts:61](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L61)
+[src/utils.ts:61](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L61)
 
 ___
 
@@ -101,7 +101,7 @@ Prepare the log to be shown to be consistent everywhere.
 
 #### Defined in
 
-[src/utils.ts:70](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L70)
+[src/utils.ts:70](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L70)
 
 ___
 
@@ -122,7 +122,7 @@ ___
 
 #### Defined in
 
-[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L81)
+[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L81)
 
 ___
 
@@ -153,7 +153,7 @@ Since it is not possible to use multiple extend, you can use that utilities to a
 
 #### Defined in
 
-[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L17)
+[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L17)
 
 ___
 
@@ -173,4 +173,4 @@ ___
 
 #### Defined in
 
-[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L101)
+[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L101)

docs/interfaces/types.MedusaMiddleware.md

@@ -46,4 +46,4 @@ Describe a custom middleware instance.
 
 #### Defined in
 
-[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L135)
+[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L135)

docs/interfaces/types.Type.md

@@ -40,4 +40,4 @@ Function.constructor
 
 #### Defined in
 
-[src/types.ts:5](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L5)
+[src/types.ts:5](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L5)

docs/modules/contants.md

@@ -20,7 +20,7 @@ Metadata key to store config from decorated injectables.
 
 #### Defined in
 
-[src/contants.ts:9](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/contants.ts#L9)
+[src/contants.ts:9](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/contants.ts#L9)
 
 ___
 
@@ -66,7 +66,7 @@ Hold the name of the medusa services registered into the container for later on
 
 #### Defined in
 
-[src/contants.ts:14](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/contants.ts#L14)
+[src/contants.ts:14](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/contants.ts#L14)
 
 ___
 
@@ -78,4 +78,4 @@ Metadata key to store config from decorated injectables.
 
 #### Defined in
 
-[src/contants.ts:4](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/contants.ts#L4)
+[src/contants.ts:4](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/contants.ts#L4)