From 8795eba09e15a21dc370b76ad3746a261bb1efd5 Mon Sep 17 00:00:00 2001 From: adrien2p Date: Mon, 21 Mar 2022 11:06:46 +0100 Subject: [PATCH] docs: Improve documentation --- .github/docs/index.html | 4 +- README.md | 51 +---------------- blueprint.json | 2 +- docs/README.md | 57 +++---------------- docs/classes/Medusa.Medusa-1.md | 8 +-- .../classes/core_componentMap.ComponentMap.md | 2 +- ...nt_emmiter.Internals.CustomEventEmmiter.md | 12 ++-- docs/classes/core_logger.Logger.md | 26 ++++----- ...tityEvent_decorator.OnMedusaEntityEvent.md | 26 ++++----- ..._1647204670085_tenant_migration.default.md | 6 +- ...ules_multi_tenancy_tenant_entity.Tenant.md | 14 ++--- ...ancy_tenant_middleware.TenantMiddleware.md | 2 +- ...ti_tenancy_tenant_service.TenantService.md | 8 +-- docs/index.html | 4 +- .../core_types.MedusaDynamicModule.md | 2 +- .../interfaces/core_types.MedusaMiddleware.md | 2 +- docs/interfaces/core_types.Type.md | 2 +- .../modules_monitoring.MonitoringOptions.md | 30 +++++----- ...multi_tenancy_types.MultiTenancyOptions.md | 4 +- .../cli_commands_generate_component.md | 8 +-- docs/modules/cli_commands_init.md | 2 +- docs/modules/cli_commands_migrate.md | 2 +- docs/modules/cli_templates_entity_template.md | 2 +- .../cli_templates_middleware_template.md | 2 +- .../cli_templates_migration_template.md | 2 +- docs/modules/cli_templates_module_template.md | 2 +- .../cli_templates_repository_template.md | 2 +- docs/modules/cli_templates_router_template.md | 2 +- .../modules/cli_templates_service_template.md | 2 +- .../cli_templates_validator_template.md | 2 +- docs/modules/cli_utils_create_directory.md | 2 +- .../cli_utils_lookup_closest_module.md | 2 +- .../cli_utils_parse_component_value.md | 2 +- docs/modules/cli_utils_slash.md | 2 +- docs/modules/core_constants.md | 6 +- docs/modules/core_event_emmiter.Internals.md | 2 +- docs/modules/core_event_emmiter.md | 2 +- docs/modules/core_metadata_reader.md | 4 +- docs/modules/core_package_loader.md | 4 +- docs/modules/core_types.md | 38 ++++++------- docs/modules/core_utils.md | 10 ++-- .../decorators_components_decorator.md | 14 ++--- ...ators_helpers_build_component_decorator.md | 2 +- docs/modules/decorators_module_decorator.md | 2 +- ...ecorators_onMedusaEntityEvent_decorator.md | 10 ++-- docs/modules/loaders_admin_api_loader.md | 2 +- docs/modules/loaders_database_loader.md | 2 +- docs/modules/loaders_entities_loader.md | 8 +-- .../loaders_helpers_apply_middlewares.md | 4 +- docs/modules/loaders_helpers_apply_routers.md | 4 +- docs/modules/loaders_migrations_loader.md | 2 +- docs/modules/loaders_modules_loader.md | 2 +- docs/modules/loaders_plugins_loader.md | 2 +- docs/modules/loaders_repository_loader.md | 4 +- docs/modules/loaders_services_loader.md | 6 +- docs/modules/loaders_store_api_loader.md | 2 +- docs/modules/loaders_validators_loader.md | 2 +- docs/modules/modules_monitoring.md | 2 +- docs/modules/modules_multi_tenancy_loader.md | 2 +- ..._multi_tenancy_tenant_service.Internals.md | 2 +- docs/modules/modules_multi_tenancy_types.md | 2 +- documentation/09-features.md | 39 +------------ documentation/_README_BUILT.md | 57 +++---------------- package.json | 2 +- tsconfig.json | 1 + 65 files changed, 189 insertions(+), 350 deletions(-) diff --git a/.github/docs/index.html b/.github/docs/index.html index 857cb262..3e6743a0 100644 --- a/.github/docs/index.html +++ b/.github/docs/index.html @@ -13,7 +13,9 @@ - diff --git a/README.md b/README.md index c05c0809..a5869040 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,7 @@ * [Getting started :rocket:](#getting-started-rocket) * [Existing medusa project](#existing-medusa-project) * [From server starter](#from-server-starter) -* [Features :monocle_face:](#features-monocle_face) - * [Non exhaustive list](#non-exhaustive-list) - * [Directory Architecture](#directory-architecture) +* [Application Architecture](#application-architecture) * [CLI `medex`](#cli-medex) * [Commands references](https://adrien2p.github.io/medusa-extender/#/?id=commands-references) * [Command `generate` reference](https://adrien2p.github.io/medusa-extender/#/?id=command-generate-reference) @@ -155,52 +153,9 @@ to be able to run the migrations and show the list of applied and to be applied To see more about the usage and references, [click here to see the documentation](https://adrien2p.github.io/medusa-extender/#/?id=cli-medex) -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#features-monocle_face) +# Application Architecture -# Features :monocle_face: - - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#non-exhaustive-list) - -## Non exhaustive list - -Here is a list of the features that you can find in that package - -- [Create or extend an entity](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [Create or extend a repository](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [Create or extend a service](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [Create middleware before or after medusa authentication strategy](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [Create new migrations](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [Create new router handler](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [Extend validators from medusa to includes custom fields](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [Emit entity subscribers events](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [Group your component by module](https://adrien2p.github.io/medusa-extender/#/?id=module) -- [Register component dynamically with dynamic module](https://adrien2p.github.io/medusa-extender/#/?id=module-dynamic-module) -- [Listen to entity subscribers and handle them wherever you want](https://adrien2p.github.io/medusa-extender/#/?id=decorators) -- [CLI](https://adrien2p.github.io/medusa-extender/#/?id=cli-medex) - - [Generate new components](https://adrien2p.github.io/medusa-extender/#/?id=cli-medex) - - [Migrate your data](https://adrien2p.github.io/medusa-extender/#/?id=cli-medex) -- [Monitoring `(Optional module)`](https://adrien2p.github.io/medusa-extender/#/?id=monitoring) -- [Multi-tenancy architecture `(Optional module)`](#https://adrien2p.github.io/medusa-extender/#/?id=multi-tenancy) - -All those features aims to help you build what you want such as - -- Creating and managing a marketplace -- Creating a media store to sell nft - video - images - keys - etc. -- And basically create whatever you want on top of `@medusajs` - -Share your code - -- Build shareable modules/plugins to use across your project or to share with the community - - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#architecture) - -## Directory Architecture - -Using this package also allow you to manage your architecture as you want. -you will not be limited by any constraint as long as the component are decorated -and the modules are referenced into the main file to be loaded, everything is fine. +Using this package help you organise your code in a module approach. That means that you can go for a modular architecture and decoupled your code depending on your domains. diff --git a/blueprint.json b/blueprint.json index ca329fa5..024a65aa 100644 --- a/blueprint.json +++ b/blueprint.json @@ -4,7 +4,7 @@ "input": "blueprint.md", "output": "documentation/_README_BUILT.md", "line": "cloudy", - "text": "Fully customisable medusa, create custom fields in any entity, implement your own feature or extend existing one in minutes! Make your own architecture or choose the modular architecture provided.\n Build a store, marketplace, media store and anything you want to do you can do it.\n Enjoy the full power of Medusa with extra badass features :rocket:", + "text": "The extender provides an out-of-the-box application architecture which allows developers and teams to create highly testable, scalable, loosely coupled, and easily maintainable applications.\nIn also increase medusa extensibility and customisation for special use cases. It comes with handy\ndecorators approach to increase the DX and full typings support for easier development. It is a complement to medusa but not a replacement :rocket:", "documentationConfig": { "markdown": { "titleLevel": 2 diff --git a/docs/README.md b/docs/README.md index 89a85045..be23704f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -29,10 +29,10 @@

- :syringe: Medusa on steroid, take your medusa project to the next level with some badass features :rocket:
- Fully customisable medusa, create custom fields in any entity, implement your own feature or extend existing one in minutes! Make your own architecture or choose the modular architecture provided. - Build a store, marketplace, media store and anything you want to do you can do it. - Enjoy the full power of Medusa with extra badass features :rocket: + Medusa on steroid, take your medusa project to the next level with some badass features :rocket:
+ The extender provides an out-of-the-box application architecture which allows developers and teams to create highly testable, scalable, loosely coupled, and easily maintainable applications. +In also increase medusa extensibility and customisation for special use cases. It comes with handy +decorators approach to increase the DX and full typings support for easier development. It is a complement to medusa but not a replacement :rocket:


@@ -51,9 +51,7 @@ * [Getting started :rocket:](#getting-started-rocket) * [Existing medusa project](#existing-medusa-project) * [From server starter](#from-server-starter) -* [Features :monocle_face:](#features-monocle_face) - * [Non exhaustive list](#non-exhaustive-list) - * [Directory Architecture](#directory-architecture) +* [Directory Architecture](#directory-architecture) * [CLI `medex`](#cli-medex) * [Commands references](#commands-references) * [Command `generate` reference](#command-generate-reference) @@ -146,52 +144,11 @@ npm run start That's it, your server is now up and running :rocket: -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#features-monocle_face) - -# Features :monocle_face: - - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#non-exhaustive-list) - -## Non exhaustive list - -Here is a list of the features that you can find in that package - -- [Create or extend an entity](#decorators) -- [Create or extend a repository](#decorators) -- [Create or extend a service](#decorators) -- [Create middleware before or after medusa authentication strategy](#decorators) -- [Create new migrations](#decorators) -- [Create new router handler](#decorators) -- [Extend validators from medusa to includes custom fields](#decorators) -- [Emit entity subscribers events](#decorators) -- [Group your component by module](#module) -- [Register component dynamically with dynamic module](#module-dynamic-module) -- [Listen to entity subscribers and handle them wherever you want](#decorators) -- [CLI](#cli-medex) - - [Generate new components](#cli-medex) - - [Migrate your data](#cli-medex) -- [Monitoring `(Optional module)`](#monitoring) -- [Multi-tenancy architecture `(Optional module)`](#multi-tenancy) - -All those features aims to help you build what you want such as - -- Creating and managing a marketplace -- Creating a media store to sell nft - video - images - keys - etc. -- And basically create whatever you want on top of `@medusajs` - -Share your code - -- Build shareable modules/plugins to use across your project or to share with the community - - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#directory-architecture) -## Directory Architecture +# Directory Architecture -Using this package also allow you to manage your architecture as you want. -you will not be limited by any constraint as long as the component are decorated -and the modules are referenced into the main file to be loaded, everything is fine. +Using this package help you organise your code in a module approach. That means that you can go for a modular architecture and decoupled your code depending on your domains. diff --git a/docs/classes/Medusa.Medusa-1.md b/docs/classes/Medusa.Medusa-1.md index 438f303d..c9d687ea 100644 --- a/docs/classes/Medusa.Medusa-1.md +++ b/docs/classes/Medusa.Medusa-1.md @@ -36,7 +36,7 @@ Load medusa and apply all components #### Defined in -[src/Medusa.ts:39](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/Medusa.ts#L39) +[src/Medusa.ts:39](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/Medusa.ts#L39) ## Properties @@ -46,7 +46,7 @@ Load medusa and apply all components #### Defined in -[src/Medusa.ts:32](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/Medusa.ts#L32) +[src/Medusa.ts:32](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/Medusa.ts#L32) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[src/Medusa.ts:33](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/Medusa.ts#L33) +[src/Medusa.ts:33](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/Medusa.ts#L33) ## Methods @@ -76,4 +76,4 @@ ___ #### Defined in -[src/Medusa.ts:47](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/Medusa.ts#L47) +[src/Medusa.ts:47](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/Medusa.ts#L47) diff --git a/docs/classes/core_componentMap.ComponentMap.md b/docs/classes/core_componentMap.ComponentMap.md index c3b97220..96db6264 100644 --- a/docs/classes/core_componentMap.ComponentMap.md +++ b/docs/classes/core_componentMap.ComponentMap.md @@ -84,4 +84,4 @@ Map.get #### Defined in -[src/core/componentMap.ts:4](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/componentMap.ts#L4) +[src/core/componentMap.ts:4](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/componentMap.ts#L4) diff --git a/docs/classes/core_event_emmiter.Internals.CustomEventEmmiter.md b/docs/classes/core_event_emmiter.Internals.CustomEventEmmiter.md index 86b35e96..d3188bd1 100644 --- a/docs/classes/core_event_emmiter.Internals.CustomEventEmmiter.md +++ b/docs/classes/core_event_emmiter.Internals.CustomEventEmmiter.md @@ -41,7 +41,7 @@ EventEmitter.constructor #### Defined in -[src/core/event-emmiter.ts:22](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/event-emmiter.ts#L22) +[src/core/event-emmiter.ts:22](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/event-emmiter.ts#L22) ## Properties @@ -51,7 +51,7 @@ EventEmitter.constructor #### Defined in -[src/core/event-emmiter.ts:20](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/event-emmiter.ts#L20) +[src/core/event-emmiter.ts:20](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/event-emmiter.ts#L20) ## Methods @@ -80,7 +80,7 @@ Emit an asynchrone event entity based and wait for the result. #### Defined in -[src/core/event-emmiter.ts:79](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/event-emmiter.ts#L79) +[src/core/event-emmiter.ts:79](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/event-emmiter.ts#L79) ___ @@ -110,7 +110,7 @@ Register a new event handler. #### Defined in -[src/core/event-emmiter.ts:32](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/event-emmiter.ts#L32) +[src/core/event-emmiter.ts:32](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/event-emmiter.ts#L32) ___ @@ -132,7 +132,7 @@ Apply all event handlers hold by the `listenerDescriptor`. #### Defined in -[src/core/event-emmiter.ts:44](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/event-emmiter.ts#L44) +[src/core/event-emmiter.ts:44](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/event-emmiter.ts#L44) ___ @@ -146,4 +146,4 @@ ___ #### Defined in -[src/core/event-emmiter.ts:67](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/event-emmiter.ts#L67) +[src/core/event-emmiter.ts:67](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/event-emmiter.ts#L67) diff --git a/docs/classes/core_logger.Logger.md b/docs/classes/core_logger.Logger.md index 94e5507a..4a576af6 100644 --- a/docs/classes/core_logger.Logger.md +++ b/docs/classes/core_logger.Logger.md @@ -49,7 +49,7 @@ Internal logger to display information about the build. #### Defined in -[src/core/logger.ts:20](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L20) +[src/core/logger.ts:20](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L20) ## Properties @@ -59,7 +59,7 @@ Internal logger to display information about the build. #### Defined in -[src/core/logger.ts:10](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L10) +[src/core/logger.ts:10](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L10) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[src/core/logger.ts:9](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L9) +[src/core/logger.ts:9](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L9) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[src/core/logger.ts:8](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L8) +[src/core/logger.ts:8](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L8) ## Accessors @@ -93,7 +93,7 @@ ___ #### Defined in -[src/core/logger.ts:16](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L16) +[src/core/logger.ts:16](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L16) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[src/core/logger.ts:12](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L12) +[src/core/logger.ts:12](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L12) ## Methods @@ -131,7 +131,7 @@ Build logs taking in count the level color #### Defined in -[src/core/logger.ts:89](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L89) +[src/core/logger.ts:89](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L89) ___ @@ -154,7 +154,7 @@ Display error logs in red immediately #### Defined in -[src/core/logger.ts:66](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L66) +[src/core/logger.ts:66](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L66) ___ @@ -170,7 +170,7 @@ display all queues logs and then reset the queue. #### Defined in -[src/core/logger.ts:73](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L73) +[src/core/logger.ts:73](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L73) ___ @@ -193,7 +193,7 @@ Display log immediately. #### Defined in -[src/core/logger.ts:48](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L48) +[src/core/logger.ts:48](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L48) ___ @@ -216,7 +216,7 @@ Push new logs to queue and then show them later on. #### Defined in -[src/core/logger.ts:34](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L34) +[src/core/logger.ts:34](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L34) ___ @@ -239,7 +239,7 @@ Display warning immediately. #### Defined in -[src/core/logger.ts:57](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L57) +[src/core/logger.ts:57](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L57) ___ @@ -260,4 +260,4 @@ ___ #### Defined in -[src/core/logger.ts:25](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/logger.ts#L25) +[src/core/logger.ts:25](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/logger.ts#L25) diff --git a/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md b/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md index e8415b5e..adab105f 100644 --- a/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md +++ b/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md @@ -45,7 +45,7 @@ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:41](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L41) +[src/decorators/onMedusaEntityEvent.decorator.ts:41](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L41) ## Properties @@ -55,7 +55,7 @@ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L39) +[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L39) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:38](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L38) +[src/decorators/onMedusaEntityEvent.decorator.ts:38](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L38) ## Accessors @@ -79,7 +79,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:49](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L49) +[src/decorators/onMedusaEntityEvent.decorator.ts:49](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L49) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:45](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L45) +[src/decorators/onMedusaEntityEvent.decorator.ts:45](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L45) ## Methods @@ -120,7 +120,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L69) +[src/decorators/onMedusaEntityEvent.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L69) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:57](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L57) +[src/decorators/onMedusaEntityEvent.decorator.ts:57](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L57) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:83](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L83) +[src/decorators/onMedusaEntityEvent.decorator.ts:83](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L83) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:65](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L65) +[src/decorators/onMedusaEntityEvent.decorator.ts:65](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L65) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:76](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L76) +[src/decorators/onMedusaEntityEvent.decorator.ts:76](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L76) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:61](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L61) +[src/decorators/onMedusaEntityEvent.decorator.ts:61](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L61) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:90](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L90) +[src/decorators/onMedusaEntityEvent.decorator.ts:90](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L90) ___ @@ -300,4 +300,4 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:53](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L53) +[src/decorators/onMedusaEntityEvent.decorator.ts:53](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L53) diff --git a/docs/classes/modules_multi_tenancy_1647204670085_tenant_migration.default.md b/docs/classes/modules_multi_tenancy_1647204670085_tenant_migration.default.md index 3b3538aa..ce8a4e48 100644 --- a/docs/classes/modules_multi_tenancy_1647204670085_tenant_migration.default.md +++ b/docs/classes/modules_multi_tenancy_1647204670085_tenant_migration.default.md @@ -41,7 +41,7 @@ MigrationInterface.name #### Defined in -[src/modules/multi-tenancy/1647204670085-tenant.migration.ts:6](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/1647204670085-tenant.migration.ts#L6) +[src/modules/multi-tenancy/1647204670085-tenant.migration.ts:6](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/1647204670085-tenant.migration.ts#L6) ## Methods @@ -65,7 +65,7 @@ MigrationInterface.down #### Defined in -[src/modules/multi-tenancy/1647204670085-tenant.migration.ts:24](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/1647204670085-tenant.migration.ts#L24) +[src/modules/multi-tenancy/1647204670085-tenant.migration.ts:24](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/1647204670085-tenant.migration.ts#L24) ___ @@ -89,4 +89,4 @@ MigrationInterface.up #### Defined in -[src/modules/multi-tenancy/1647204670085-tenant.migration.ts:8](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/1647204670085-tenant.migration.ts#L8) +[src/modules/multi-tenancy/1647204670085-tenant.migration.ts:8](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/1647204670085-tenant.migration.ts#L8) diff --git a/docs/classes/modules_multi_tenancy_tenant_entity.Tenant.md b/docs/classes/modules_multi_tenancy_tenant_entity.Tenant.md index e7acdea3..81e81d3f 100644 --- a/docs/classes/modules_multi_tenancy_tenant_entity.Tenant.md +++ b/docs/classes/modules_multi_tenancy_tenant_entity.Tenant.md @@ -37,7 +37,7 @@ #### Defined in -[src/modules/multi-tenancy/tenant.entity.ts:12](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.entity.ts#L12) +[src/modules/multi-tenancy/tenant.entity.ts:12](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.entity.ts#L12) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[src/modules/multi-tenancy/tenant.entity.ts:21](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.entity.ts#L21) +[src/modules/multi-tenancy/tenant.entity.ts:21](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.entity.ts#L21) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[src/modules/multi-tenancy/tenant.entity.ts:24](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.entity.ts#L24) +[src/modules/multi-tenancy/tenant.entity.ts:24](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.entity.ts#L24) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[src/modules/multi-tenancy/tenant.entity.ts:18](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.entity.ts#L18) +[src/modules/multi-tenancy/tenant.entity.ts:18](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.entity.ts#L18) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[src/modules/multi-tenancy/tenant.entity.ts:15](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.entity.ts#L15) +[src/modules/multi-tenancy/tenant.entity.ts:15](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.entity.ts#L15) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[src/modules/multi-tenancy/tenant.entity.ts:9](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.entity.ts#L9) +[src/modules/multi-tenancy/tenant.entity.ts:9](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.entity.ts#L9) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[src/modules/multi-tenancy/tenant.entity.ts:27](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.entity.ts#L27) +[src/modules/multi-tenancy/tenant.entity.ts:27](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.entity.ts#L27) diff --git a/docs/classes/modules_multi_tenancy_tenant_middleware.TenantMiddleware.md b/docs/classes/modules_multi_tenancy_tenant_middleware.TenantMiddleware.md index 2c336655..8b890bcb 100644 --- a/docs/classes/modules_multi_tenancy_tenant_middleware.TenantMiddleware.md +++ b/docs/classes/modules_multi_tenancy_tenant_middleware.TenantMiddleware.md @@ -48,4 +48,4 @@ #### Defined in -[src/modules/multi-tenancy/tenant.middleware.ts:12](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.middleware.ts#L12) +[src/modules/multi-tenancy/tenant.middleware.ts:12](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.middleware.ts#L12) diff --git a/docs/classes/modules_multi_tenancy_tenant_service.TenantService.md b/docs/classes/modules_multi_tenancy_tenant_service.TenantService.md index cb40291f..ab7de73a 100644 --- a/docs/classes/modules_multi_tenancy_tenant_service.TenantService.md +++ b/docs/classes/modules_multi_tenancy_tenant_service.TenantService.md @@ -34,7 +34,7 @@ #### Defined in -[src/modules/multi-tenancy/tenant.service.ts:18](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.service.ts#L18) +[src/modules/multi-tenancy/tenant.service.ts:18](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.service.ts#L18) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/modules/multi-tenancy/tenant.service.ts:16](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.service.ts#L16) +[src/modules/multi-tenancy/tenant.service.ts:16](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.service.ts#L16) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[src/modules/multi-tenancy/tenant.service.ts:14](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.service.ts#L14) +[src/modules/multi-tenancy/tenant.service.ts:14](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.service.ts#L14) ## Methods @@ -77,4 +77,4 @@ Provide a way to switch between database connections depending on the request pr #### Defined in -[src/modules/multi-tenancy/tenant.service.ts:27](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.service.ts#L27) +[src/modules/multi-tenancy/tenant.service.ts:27](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.service.ts#L27) diff --git a/docs/index.html b/docs/index.html index 857cb262..3e6743a0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,7 +13,9 @@ - diff --git a/docs/interfaces/core_types.MedusaDynamicModule.md b/docs/interfaces/core_types.MedusaDynamicModule.md index 04cbe031..aab98af3 100644 --- a/docs/interfaces/core_types.MedusaDynamicModule.md +++ b/docs/interfaces/core_types.MedusaDynamicModule.md @@ -37,4 +37,4 @@ Describe a dynamic module which resolve its import dynamically. #### Defined in -[src/core/types.ts:170](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L170) +[src/core/types.ts:170](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L170) diff --git a/docs/interfaces/core_types.MedusaMiddleware.md b/docs/interfaces/core_types.MedusaMiddleware.md index c82a7a6a..edfe59a1 100644 --- a/docs/interfaces/core_types.MedusaMiddleware.md +++ b/docs/interfaces/core_types.MedusaMiddleware.md @@ -37,4 +37,4 @@ Describe a custom middleware instance. #### Defined in -[src/core/types.ts:162](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L162) +[src/core/types.ts:162](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L162) diff --git a/docs/interfaces/core_types.Type.md b/docs/interfaces/core_types.Type.md index ec4c4ae6..adaac7eb 100644 --- a/docs/interfaces/core_types.Type.md +++ b/docs/interfaces/core_types.Type.md @@ -40,4 +40,4 @@ Function.constructor #### Defined in -[src/core/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L6) +[src/core/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L6) diff --git a/docs/interfaces/modules_monitoring.MonitoringOptions.md b/docs/interfaces/modules_monitoring.MonitoringOptions.md index 68a57f45..2a8609e3 100644 --- a/docs/interfaces/modules_monitoring.MonitoringOptions.md +++ b/docs/interfaces/modules_monitoring.MonitoringOptions.md @@ -35,7 +35,7 @@ #### Defined in -[src/modules/monitoring.ts:15](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L15) +[src/modules/monitoring.ts:15](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L15) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:17](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L17) +[src/modules/monitoring.ts:17](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L17) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:12](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L12) +[src/modules/monitoring.ts:12](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L12) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:19](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L19) +[src/modules/monitoring.ts:19](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L19) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:7](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L7) +[src/modules/monitoring.ts:7](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L7) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:8](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L8) +[src/modules/monitoring.ts:8](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L8) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:13](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L13) +[src/modules/monitoring.ts:13](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L13) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:14](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L14) +[src/modules/monitoring.ts:14](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L14) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:18](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L18) +[src/modules/monitoring.ts:18](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L18) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:10](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L10) +[src/modules/monitoring.ts:10](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L10) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:9](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L9) +[src/modules/monitoring.ts:9](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L9) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:11](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L11) +[src/modules/monitoring.ts:11](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L11) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:6](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L6) +[src/modules/monitoring.ts:6](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L6) ## Methods @@ -177,7 +177,7 @@ ___ #### Defined in -[src/modules/monitoring.ts:20](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L20) +[src/modules/monitoring.ts:20](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L20) ___ @@ -199,4 +199,4 @@ ___ #### Defined in -[src/modules/monitoring.ts:16](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L16) +[src/modules/monitoring.ts:16](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L16) diff --git a/docs/interfaces/modules_multi_tenancy_types.MultiTenancyOptions.md b/docs/interfaces/modules_multi_tenancy_types.MultiTenancyOptions.md index 72f649eb..3fbccb69 100644 --- a/docs/interfaces/modules_multi_tenancy_types.MultiTenancyOptions.md +++ b/docs/interfaces/modules_multi_tenancy_types.MultiTenancyOptions.md @@ -22,7 +22,7 @@ #### Defined in -[src/modules/multi-tenancy/types.ts:10](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/types.ts#L10) +[src/modules/multi-tenancy/types.ts:10](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/types.ts#L10) ## Methods @@ -42,4 +42,4 @@ #### Defined in -[src/modules/multi-tenancy/types.ts:11](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/types.ts#L11) +[src/modules/multi-tenancy/types.ts:11](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/types.ts#L11) diff --git a/docs/modules/cli_commands_generate_component.md b/docs/modules/cli_commands_generate_component.md index 936e3934..305e61cd 100644 --- a/docs/modules/cli_commands_generate_component.md +++ b/docs/modules/cli_commands_generate_component.md @@ -36,7 +36,7 @@ #### Defined in -[src/cli/commands/generate-component.ts:21](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/commands/generate-component.ts#L21) +[src/cli/commands/generate-component.ts:21](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/commands/generate-component.ts#L21) ## Functions @@ -62,7 +62,7 @@ Create the component file and fill it with the template content. #### Defined in -[src/cli/commands/generate-component.ts:113](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/commands/generate-component.ts#L113) +[src/cli/commands/generate-component.ts:113](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/commands/generate-component.ts#L113) ___ @@ -85,7 +85,7 @@ Generate the required components from the user command. #### Defined in -[src/cli/commands/generate-component.ts:48](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/commands/generate-component.ts#L48) +[src/cli/commands/generate-component.ts:48](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/commands/generate-component.ts#L48) ___ @@ -107,4 +107,4 @@ Lookup for the closest module from the component and update its imports. #### Defined in -[src/cli/commands/generate-component.ts:140](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/commands/generate-component.ts#L140) +[src/cli/commands/generate-component.ts:140](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/commands/generate-component.ts#L140) diff --git a/docs/modules/cli_commands_init.md b/docs/modules/cli_commands_init.md index 381e8bf7..f4f5c263 100644 --- a/docs/modules/cli_commands_init.md +++ b/docs/modules/cli_commands_init.md @@ -22,4 +22,4 @@ Update or create everything related to medusa-extender in an existing medusa pro #### Defined in -[src/cli/commands/init.ts:12](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/commands/init.ts#L12) +[src/cli/commands/init.ts:12](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/commands/init.ts#L12) diff --git a/docs/modules/cli_commands_migrate.md b/docs/modules/cli_commands_migrate.md index 2da5f654..9c1e5e7f 100644 --- a/docs/modules/cli_commands_migrate.md +++ b/docs/modules/cli_commands_migrate.md @@ -26,4 +26,4 @@ #### Defined in -[src/cli/commands/migrate.ts:22](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/commands/migrate.ts#L22) +[src/cli/commands/migrate.ts:22](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/commands/migrate.ts#L22) diff --git a/docs/modules/cli_templates_entity_template.md b/docs/modules/cli_templates_entity_template.md index b99aab42..e9498fd2 100644 --- a/docs/modules/cli_templates_entity_template.md +++ b/docs/modules/cli_templates_entity_template.md @@ -28,4 +28,4 @@ Provide a basic template for the entity component generation. #### Defined in -[src/cli/templates/entity-template.ts:8](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/templates/entity-template.ts#L8) +[src/cli/templates/entity-template.ts:8](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/templates/entity-template.ts#L8) diff --git a/docs/modules/cli_templates_middleware_template.md b/docs/modules/cli_templates_middleware_template.md index e339f1dd..f921f9f6 100644 --- a/docs/modules/cli_templates_middleware_template.md +++ b/docs/modules/cli_templates_middleware_template.md @@ -28,4 +28,4 @@ Provide a basic template for the middleware component generation. #### Defined in -[src/cli/templates/middleware-template.ts:7](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/templates/middleware-template.ts#L7) +[src/cli/templates/middleware-template.ts:7](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/templates/middleware-template.ts#L7) diff --git a/docs/modules/cli_templates_migration_template.md b/docs/modules/cli_templates_migration_template.md index f8715144..7701bdf1 100644 --- a/docs/modules/cli_templates_migration_template.md +++ b/docs/modules/cli_templates_migration_template.md @@ -29,4 +29,4 @@ Provide a basic template for the migration component generation. #### Defined in -[src/cli/templates/migration-template.ts:8](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/templates/migration-template.ts#L8) +[src/cli/templates/migration-template.ts:8](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/templates/migration-template.ts#L8) diff --git a/docs/modules/cli_templates_module_template.md b/docs/modules/cli_templates_module_template.md index beb239db..7a7a4f0d 100644 --- a/docs/modules/cli_templates_module_template.md +++ b/docs/modules/cli_templates_module_template.md @@ -28,4 +28,4 @@ Provide a basic template for the module component generation. #### Defined in -[src/cli/templates/module-template.ts:7](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/templates/module-template.ts#L7) +[src/cli/templates/module-template.ts:7](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/templates/module-template.ts#L7) diff --git a/docs/modules/cli_templates_repository_template.md b/docs/modules/cli_templates_repository_template.md index 10d09477..0d6ded69 100644 --- a/docs/modules/cli_templates_repository_template.md +++ b/docs/modules/cli_templates_repository_template.md @@ -28,4 +28,4 @@ Provide a basic template for the repository component generation. #### Defined in -[src/cli/templates/repository-template.ts:8](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/templates/repository-template.ts#L8) +[src/cli/templates/repository-template.ts:8](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/templates/repository-template.ts#L8) diff --git a/docs/modules/cli_templates_router_template.md b/docs/modules/cli_templates_router_template.md index b75fca25..528bb97e 100644 --- a/docs/modules/cli_templates_router_template.md +++ b/docs/modules/cli_templates_router_template.md @@ -28,4 +28,4 @@ Provide a basic template for the router component generation. #### Defined in -[src/cli/templates/router-template.ts:7](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/templates/router-template.ts#L7) +[src/cli/templates/router-template.ts:7](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/templates/router-template.ts#L7) diff --git a/docs/modules/cli_templates_service_template.md b/docs/modules/cli_templates_service_template.md index 8a9996dd..63a37905 100644 --- a/docs/modules/cli_templates_service_template.md +++ b/docs/modules/cli_templates_service_template.md @@ -28,4 +28,4 @@ Provide a basic template for the service component generation. #### Defined in -[src/cli/templates/service-template.ts:8](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/templates/service-template.ts#L8) +[src/cli/templates/service-template.ts:8](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/templates/service-template.ts#L8) diff --git a/docs/modules/cli_templates_validator_template.md b/docs/modules/cli_templates_validator_template.md index 284e4776..131aad57 100644 --- a/docs/modules/cli_templates_validator_template.md +++ b/docs/modules/cli_templates_validator_template.md @@ -28,4 +28,4 @@ Provide a basic template for the validator component generation. #### Defined in -[src/cli/templates/validator-template.ts:7](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/templates/validator-template.ts#L7) +[src/cli/templates/validator-template.ts:7](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/templates/validator-template.ts#L7) diff --git a/docs/modules/cli_utils_create_directory.md b/docs/modules/cli_utils_create_directory.md index de97a4c7..3d3d0ec4 100644 --- a/docs/modules/cli_utils_create_directory.md +++ b/docs/modules/cli_utils_create_directory.md @@ -30,4 +30,4 @@ Create the new directory, if necessary, that will receive the components. #### Defined in -[src/cli/utils/create-directory.ts:10](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/utils/create-directory.ts#L10) +[src/cli/utils/create-directory.ts:10](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/utils/create-directory.ts#L10) diff --git a/docs/modules/cli_utils_lookup_closest_module.md b/docs/modules/cli_utils_lookup_closest_module.md index d76b3524..60e898ac 100644 --- a/docs/modules/cli_utils_lookup_closest_module.md +++ b/docs/modules/cli_utils_lookup_closest_module.md @@ -29,4 +29,4 @@ Lookup for the closest module component from the destination path. #### Defined in -[src/cli/utils/lookup-closest-module.ts:12](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/utils/lookup-closest-module.ts#L12) +[src/cli/utils/lookup-closest-module.ts:12](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/utils/lookup-closest-module.ts#L12) diff --git a/docs/modules/cli_utils_parse_component_value.md b/docs/modules/cli_utils_parse_component_value.md index fad53110..691f9a98 100644 --- a/docs/modules/cli_utils_parse_component_value.md +++ b/docs/modules/cli_utils_parse_component_value.md @@ -38,4 +38,4 @@ Parse the component information to create a kind of descriptor. #### Defined in -[src/cli/utils/parse-component-value.ts:11](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/utils/parse-component-value.ts#L11) +[src/cli/utils/parse-component-value.ts:11](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/utils/parse-component-value.ts#L11) diff --git a/docs/modules/cli_utils_slash.md b/docs/modules/cli_utils_slash.md index 0a3cdfb4..9874a8fb 100644 --- a/docs/modules/cli_utils_slash.md +++ b/docs/modules/cli_utils_slash.md @@ -20,4 +20,4 @@ #### Defined in -[src/cli/utils/slash.ts:1](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/cli/utils/slash.ts#L1) +[src/cli/utils/slash.ts:1](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/cli/utils/slash.ts#L1) diff --git a/docs/modules/core_constants.md b/docs/modules/core_constants.md index 927c91e1..0236539c 100644 --- a/docs/modules/core_constants.md +++ b/docs/modules/core_constants.md @@ -20,7 +20,7 @@ Metadata key to store config from decorated injectables. #### Defined in -[src/core/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/constants.ts#L9) +[src/core/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/constants.ts#L9) ___ @@ -66,7 +66,7 @@ Hold the name of the medusa services registered into the container for later on #### Defined in -[src/core/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/constants.ts#L14) +[src/core/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/constants.ts#L14) ___ @@ -78,4 +78,4 @@ Metadata key to store config from decorated injectables. #### Defined in -[src/core/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/constants.ts#L4) +[src/core/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/constants.ts#L4) diff --git a/docs/modules/core_event_emmiter.Internals.md b/docs/modules/core_event_emmiter.Internals.md index 43438300..b97f379b 100644 --- a/docs/modules/core_event_emmiter.Internals.md +++ b/docs/modules/core_event_emmiter.Internals.md @@ -38,4 +38,4 @@ A listener descriptor. #### Defined in -[src/core/event-emmiter.ts:10](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/event-emmiter.ts#L10) +[src/core/event-emmiter.ts:10](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/event-emmiter.ts#L10) diff --git a/docs/modules/core_event_emmiter.md b/docs/modules/core_event_emmiter.md index bbeac668..366f4ca0 100644 --- a/docs/modules/core_event_emmiter.md +++ b/docs/modules/core_event_emmiter.md @@ -23,4 +23,4 @@ Export the instance of the event emmiter. #### Defined in -[src/core/event-emmiter.ts:101](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/event-emmiter.ts#L101) +[src/core/event-emmiter.ts:101](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/event-emmiter.ts#L101) diff --git a/docs/modules/core_metadata_reader.md b/docs/modules/core_metadata_reader.md index 3185b1d7..d8bf84d5 100644 --- a/docs/modules/core_metadata_reader.md +++ b/docs/modules/core_metadata_reader.md @@ -37,7 +37,7 @@ Return the options from components. #### Defined in -[src/core/metadata-reader.ts:44](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/metadata-reader.ts#L44) +[src/core/metadata-reader.ts:44](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/metadata-reader.ts#L44) ___ @@ -61,4 +61,4 @@ Read all metadata from the imported modules and extract components that will be #### Defined in -[src/core/metadata-reader.ts:11](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/metadata-reader.ts#L11) +[src/core/metadata-reader.ts:11](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/metadata-reader.ts#L11) diff --git a/docs/modules/core_package_loader.md b/docs/modules/core_package_loader.md index 5a26527d..021861d4 100644 --- a/docs/modules/core_package_loader.md +++ b/docs/modules/core_package_loader.md @@ -24,7 +24,7 @@ Return the install command from the user package manager. #### Defined in -[src/core/package-loader.ts:52](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/package-loader.ts#L52) +[src/core/package-loader.ts:52](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/package-loader.ts#L52) ___ @@ -48,4 +48,4 @@ Load packages at run time. #### Defined in -[src/core/package-loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/package-loader.ts#L12) +[src/core/package-loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/package-loader.ts#L12) diff --git a/docs/modules/core_types.md b/docs/modules/core_types.md index e29ec7b5..7df50b67 100644 --- a/docs/modules/core_types.md +++ b/docs/modules/core_types.md @@ -56,7 +56,7 @@ #### Defined in -[src/core/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L9) +[src/core/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L9) ___ @@ -81,7 +81,7 @@ Defines the injection options for entities. #### Defined in -[src/core/types.ts:28](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L28) +[src/core/types.ts:28](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L28) ___ @@ -99,7 +99,7 @@ Determine which options type it actually is depending on the component type. #### Defined in -[src/core/types.ts:103](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L103) +[src/core/types.ts:103](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L103) ___ @@ -117,7 +117,7 @@ Determine which options type it actually is depending on the component type. #### Defined in -[src/core/types.ts:126](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L126) +[src/core/types.ts:126](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L126) ___ @@ -129,7 +129,7 @@ Components that does not required any other options that Type. #### Defined in -[src/core/types.ts:16](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L16) +[src/core/types.ts:16](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L16) ___ @@ -147,7 +147,7 @@ Union of all options type possible for injectable. #### Defined in -[src/core/types.ts:92](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L92) +[src/core/types.ts:92](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L92) ___ @@ -159,7 +159,7 @@ Describe the expected request from a middleware [MedusaMiddleware](../interfaces #### Defined in -[src/core/types.ts:140](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L140) +[src/core/types.ts:140](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L140) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[src/core/types.ts:11](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L11) +[src/core/types.ts:11](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L11) ___ @@ -188,7 +188,7 @@ Medusa request extended. #### Defined in -[src/core/types.ts:132](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L132) +[src/core/types.ts:132](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L132) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[src/core/types.ts:147](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L147) +[src/core/types.ts:147](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L147) ___ @@ -217,7 +217,7 @@ Describe all the available options for the Route [MedusaMiddleware](../interface #### Defined in -[src/core/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L152) +[src/core/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L152) ___ @@ -236,7 +236,7 @@ Defines the injection options for middlewares. #### Defined in -[src/core/types.ts:70](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L70) +[src/core/types.ts:70](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L70) ___ @@ -255,7 +255,7 @@ Mix the return type of two objects. #### Defined in -[src/core/types.ts:176](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L176) +[src/core/types.ts:176](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L176) ___ @@ -279,7 +279,7 @@ Defines the injection options for routes. #### Defined in -[src/core/types.ts:85](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L85) +[src/core/types.ts:85](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L85) ___ @@ -304,7 +304,7 @@ Defines the injection options for services, entities, repositories. #### Defined in -[src/core/types.ts:45](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L45) +[src/core/types.ts:45](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L45) ___ @@ -322,7 +322,7 @@ Defines the injection options for routes. #### Defined in -[src/core/types.ts:63](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L63) +[src/core/types.ts:63](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L63) ___ @@ -343,7 +343,7 @@ Define a router and its configuration. #### Defined in -[src/core/types.ts:53](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L53) +[src/core/types.ts:53](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L53) ___ @@ -369,7 +369,7 @@ Defines the injection options for service. #### Defined in -[src/core/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L36) +[src/core/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L36) ___ @@ -393,4 +393,4 @@ Defines the injection options for routes. #### Defined in -[src/core/types.ts:78](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/types.ts#L78) +[src/core/types.ts:78](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/types.ts#L78) diff --git a/docs/modules/core_utils.md b/docs/modules/core_utils.md index a56c874f..45611afb 100644 --- a/docs/modules/core_utils.md +++ b/docs/modules/core_utils.md @@ -42,7 +42,7 @@ Allow to omit some property from a class. #### Defined in -[src/core/utils.ts:53](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/utils.ts#L53) +[src/core/utils.ts:52](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/utils.ts#L52) ___ @@ -72,7 +72,7 @@ Attach a new subscriber to a specific entities. #### Defined in -[src/core/utils.ts:30](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/utils.ts#L30) +[src/core/utils.ts:29](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/utils.ts#L29) ___ @@ -94,7 +94,7 @@ Lower case the first character of the input string. #### Defined in -[src/core/utils.ts:60](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/utils.ts#L60) +[src/core/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/utils.ts#L59) ___ @@ -124,7 +124,7 @@ Since it is not possible to use multiple extend, you can use that utilities to a #### Defined in -[src/core/utils.ts:10](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/utils.ts#L10) +[src/core/utils.ts:9](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/utils.ts#L9) ___ @@ -146,4 +146,4 @@ Upper case the first character of the input string. #### Defined in -[src/core/utils.ts:68](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/core/utils.ts#L68) +[src/core/utils.ts:67](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/core/utils.ts#L67) diff --git a/docs/modules/decorators_components_decorator.md b/docs/modules/decorators_components_decorator.md index b30bef7e..bc6e33bd 100644 --- a/docs/modules/decorators_components_decorator.md +++ b/docs/modules/decorators_components_decorator.md @@ -40,7 +40,7 @@ Mark a class as an entity to be used by the loader. #### Defined in -[src/decorators/components.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/components.decorator.ts#L16) +[src/decorators/components.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/components.decorator.ts#L16) ___ @@ -62,7 +62,7 @@ Mark a class as a middleware to be used by the loader. #### Defined in -[src/decorators/components.decorator.ts:43](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/components.decorator.ts#L43) +[src/decorators/components.decorator.ts:43](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/components.decorator.ts#L43) ___ @@ -78,7 +78,7 @@ Mark a class as a migration to be used by the loader. #### Defined in -[src/decorators/components.decorator.ts:51](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/components.decorator.ts#L51) +[src/decorators/components.decorator.ts:51](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/components.decorator.ts#L51) ___ @@ -106,7 +106,7 @@ Mark a class as a repository to be used by the loader. #### Defined in -[src/decorators/components.decorator.ts:34](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/components.decorator.ts#L34) +[src/decorators/components.decorator.ts:34](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/components.decorator.ts#L34) ___ @@ -128,7 +128,7 @@ Mark a class as a router to be used by the loader. #### Defined in -[src/decorators/components.decorator.ts:60](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/components.decorator.ts#L60) +[src/decorators/components.decorator.ts:60](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/components.decorator.ts#L60) ___ @@ -156,7 +156,7 @@ Mark a class as a service to be used by the loader. #### Defined in -[src/decorators/components.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/components.decorator.ts#L25) +[src/decorators/components.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/components.decorator.ts#L25) ___ @@ -178,4 +178,4 @@ Mark a class as a validator to be used by the validator utility. #### Defined in -[src/decorators/components.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/components.decorator.ts#L69) +[src/decorators/components.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/components.decorator.ts#L69) diff --git a/docs/modules/decorators_helpers_build_component_decorator.md b/docs/modules/decorators_helpers_build_component_decorator.md index e237b436..59ca1149 100644 --- a/docs/modules/decorators_helpers_build_component_decorator.md +++ b/docs/modules/decorators_helpers_build_component_decorator.md @@ -32,4 +32,4 @@ #### Defined in -[src/decorators/helpers/build-component-decorator.ts:4](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/helpers/build-component-decorator.ts#L4) +[src/decorators/helpers/build-component-decorator.ts:4](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/helpers/build-component-decorator.ts#L4) diff --git a/docs/modules/decorators_module_decorator.md b/docs/modules/decorators_module_decorator.md index aa014a75..05a37bb0 100644 --- a/docs/modules/decorators_module_decorator.md +++ b/docs/modules/decorators_module_decorator.md @@ -28,4 +28,4 @@ Mark a class as aa module and store all injectable on it. #### Defined in -[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/module.decorator.ts#L9) +[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/module.decorator.ts#L9) diff --git a/docs/modules/decorators_onMedusaEntityEvent_decorator.md b/docs/modules/decorators_onMedusaEntityEvent_decorator.md index 69177219..e892aff5 100644 --- a/docs/modules/decorators_onMedusaEntityEvent_decorator.md +++ b/docs/modules/decorators_onMedusaEntityEvent_decorator.md @@ -24,7 +24,7 @@ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:10](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L10) +[src/decorators/onMedusaEntityEvent.decorator.ts:10](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L10) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:5](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L5) +[src/decorators/onMedusaEntityEvent.decorator.ts:5](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L5) ___ @@ -60,7 +60,7 @@ Event types that can be emitted. #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L15) +[src/decorators/onMedusaEntityEvent.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L15) ___ @@ -86,7 +86,7 @@ The arguments expected by the [OnMedusaEntityEvent](../classes/decorators_onMedu #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L24) +[src/decorators/onMedusaEntityEvent.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L24) ___ @@ -112,4 +112,4 @@ The arguments expected by the event handler. #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:32](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/decorators/onMedusaEntityEvent.decorator.ts#L32) +[src/decorators/onMedusaEntityEvent.decorator.ts:32](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/decorators/onMedusaEntityEvent.decorator.ts#L32) diff --git a/docs/modules/loaders_admin_api_loader.md b/docs/modules/loaders_admin_api_loader.md index 40964ceb..0c62495a 100644 --- a/docs/modules/loaders_admin_api_loader.md +++ b/docs/modules/loaders_admin_api_loader.md @@ -31,4 +31,4 @@ Apply middlewares and routes on the underlying @medusajs admin API. #### Defined in -[src/loaders/admin-api.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/admin-api.loader.ts#L13) +[src/loaders/admin-api.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/admin-api.loader.ts#L13) diff --git a/docs/modules/loaders_database_loader.md b/docs/modules/loaders_database_loader.md index 8ca0ba69..e6c50e32 100644 --- a/docs/modules/loaders_database_loader.md +++ b/docs/modules/loaders_database_loader.md @@ -27,4 +27,4 @@ #### Defined in -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/database.loader.ts#L5) +[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/database.loader.ts#L5) diff --git a/docs/modules/loaders_entities_loader.md b/docs/modules/loaders_entities_loader.md index ff88c2b7..192bd544 100644 --- a/docs/modules/loaders_entities_loader.md +++ b/docs/modules/loaders_entities_loader.md @@ -33,7 +33,7 @@ Load all custom entities into the underlying @medusajs instance. #### Defined in -[src/loaders/entities.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/entities.loader.ts#L13) +[src/loaders/entities.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/entities.loader.ts#L13) ___ @@ -56,7 +56,7 @@ Load all custom entities that override @medusajs instance entities. #### Defined in -[src/loaders/entities.loader.ts:36](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/entities.loader.ts#L36) +[src/loaders/entities.loader.ts:36](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/entities.loader.ts#L36) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/loaders/entities.loader.ts:63](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/entities.loader.ts#L63) +[src/loaders/entities.loader.ts:63](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/entities.loader.ts#L63) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[src/loaders/entities.loader.ts:51](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/entities.loader.ts#L51) +[src/loaders/entities.loader.ts:51](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/entities.loader.ts#L51) diff --git a/docs/modules/loaders_helpers_apply_middlewares.md b/docs/modules/loaders_helpers_apply_middlewares.md index e64dd4f9..b8b243b5 100644 --- a/docs/modules/loaders_helpers_apply_middlewares.md +++ b/docs/modules/loaders_helpers_apply_middlewares.md @@ -31,7 +31,7 @@ Apply all middlewares on the app that must be applied after the @medusajs authen #### Defined in -[src/loaders/helpers/apply-middlewares.ts:40](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/helpers/apply-middlewares.ts#L40) +[src/loaders/helpers/apply-middlewares.ts:40](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/helpers/apply-middlewares.ts#L40) ___ @@ -55,4 +55,4 @@ Apply all middlewares on the app that must be applied before the @medusajs authe #### Defined in -[src/loaders/helpers/apply-middlewares.ts:18](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/helpers/apply-middlewares.ts#L18) +[src/loaders/helpers/apply-middlewares.ts:18](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/helpers/apply-middlewares.ts#L18) diff --git a/docs/modules/loaders_helpers_apply_routers.md b/docs/modules/loaders_helpers_apply_routers.md index bc49ab6c..b7b1fa54 100644 --- a/docs/modules/loaders_helpers_apply_routers.md +++ b/docs/modules/loaders_helpers_apply_routers.md @@ -31,7 +31,7 @@ Apply all routes on the app that must be applied after the @medusajs authenticat #### Defined in -[src/loaders/helpers/apply-routers.ts:26](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/helpers/apply-routers.ts#L26) +[src/loaders/helpers/apply-routers.ts:26](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/helpers/apply-routers.ts#L26) ___ @@ -55,4 +55,4 @@ Apply all routes on the app that must be applied before the @medusajs authentica #### Defined in -[src/loaders/helpers/apply-routers.ts:10](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/helpers/apply-routers.ts#L10) +[src/loaders/helpers/apply-routers.ts:10](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/helpers/apply-routers.ts#L10) diff --git a/docs/modules/loaders_migrations_loader.md b/docs/modules/loaders_migrations_loader.md index fe6ffe44..49809719 100644 --- a/docs/modules/loaders_migrations_loader.md +++ b/docs/modules/loaders_migrations_loader.md @@ -30,4 +30,4 @@ Run custom migrations that are find from the provided directory and stored in a #### Defined in -[src/loaders/migrations.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/migrations.loader.ts#L13) +[src/loaders/migrations.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/migrations.loader.ts#L13) diff --git a/docs/modules/loaders_modules_loader.md b/docs/modules/loaders_modules_loader.md index bb37a2f8..3a968042 100644 --- a/docs/modules/loaders_modules_loader.md +++ b/docs/modules/loaders_modules_loader.md @@ -28,4 +28,4 @@ #### Defined in -[src/loaders/modules.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/modules.loader.ts#L5) +[src/loaders/modules.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/modules.loader.ts#L5) diff --git a/docs/modules/loaders_plugins_loader.md b/docs/modules/loaders_plugins_loader.md index 751dc5cb..2fb649b5 100644 --- a/docs/modules/loaders_plugins_loader.md +++ b/docs/modules/loaders_plugins_loader.md @@ -29,4 +29,4 @@ Register all listeners before the plugins are loaded to be sure that the scope m #### Defined in -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/plugins.loader.ts#L11) +[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/plugins.loader.ts#L11) diff --git a/docs/modules/loaders_repository_loader.md b/docs/modules/loaders_repository_loader.md index a6e7e3f8..e781faf0 100644 --- a/docs/modules/loaders_repository_loader.md +++ b/docs/modules/loaders_repository_loader.md @@ -30,7 +30,7 @@ Load all custom repositories that override @medusajs instance entities. #### Defined in -[src/loaders/repository.loader.ts:37](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/repository.loader.ts#L37) +[src/loaders/repository.loader.ts:37](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/repository.loader.ts#L37) ___ @@ -54,4 +54,4 @@ Load all custom repositories into the underlying @medusajs instance. #### Defined in -[src/loaders/repository.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/repository.loader.ts#L14) +[src/loaders/repository.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/repository.loader.ts#L14) diff --git a/docs/modules/loaders_services_loader.md b/docs/modules/loaders_services_loader.md index d39005bb..75fccc56 100644 --- a/docs/modules/loaders_services_loader.md +++ b/docs/modules/loaders_services_loader.md @@ -30,7 +30,7 @@ #### Defined in -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/services.loader.ts#L55) +[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/services.loader.ts#L55) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/loaders/services.loader.ts:40](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/services.loader.ts#L40) +[src/loaders/services.loader.ts:40](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/services.loader.ts#L40) ___ @@ -75,4 +75,4 @@ Load all custom services and overridden services into the underlying @medusajs i #### Defined in -[src/loaders/services.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/services.loader.ts#L12) +[src/loaders/services.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/services.loader.ts#L12) diff --git a/docs/modules/loaders_store_api_loader.md b/docs/modules/loaders_store_api_loader.md index dd2a9807..9777a128 100644 --- a/docs/modules/loaders_store_api_loader.md +++ b/docs/modules/loaders_store_api_loader.md @@ -31,4 +31,4 @@ Apply middlewares and routes on store API. #### Defined in -[src/loaders/store-api.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/store-api.loader.ts#L13) +[src/loaders/store-api.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/store-api.loader.ts#L13) diff --git a/docs/modules/loaders_validators_loader.md b/docs/modules/loaders_validators_loader.md index 4f71ba0b..588b0e26 100644 --- a/docs/modules/loaders_validators_loader.md +++ b/docs/modules/loaders_validators_loader.md @@ -29,4 +29,4 @@ Load all custom extended validators into the underlying @medusajs instance. #### Defined in -[src/loaders/validators.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/loaders/validators.loader.ts#L11) +[src/loaders/validators.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/loaders/validators.loader.ts#L11) diff --git a/docs/modules/modules_monitoring.md b/docs/modules/modules_monitoring.md index 2e625fa7..a9b8257b 100644 --- a/docs/modules/modules_monitoring.md +++ b/docs/modules/modules_monitoring.md @@ -33,4 +33,4 @@ #### Defined in -[src/modules/monitoring.ts:25](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/monitoring.ts#L25) +[src/modules/monitoring.ts:25](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/monitoring.ts#L25) diff --git a/docs/modules/modules_multi_tenancy_loader.md b/docs/modules/modules_multi_tenancy_loader.md index 804c2ad5..e83e4ac5 100644 --- a/docs/modules/modules_multi_tenancy_loader.md +++ b/docs/modules/modules_multi_tenancy_loader.md @@ -26,4 +26,4 @@ #### Defined in -[src/modules/multi-tenancy/loader.ts:3](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/loader.ts#L3) +[src/modules/multi-tenancy/loader.ts:3](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/loader.ts#L3) diff --git a/docs/modules/modules_multi_tenancy_tenant_service.Internals.md b/docs/modules/modules_multi_tenancy_tenant_service.Internals.md index 14ad659f..055a5fd8 100644 --- a/docs/modules/modules_multi_tenancy_tenant_service.Internals.md +++ b/docs/modules/modules_multi_tenancy_tenant_service.Internals.md @@ -24,4 +24,4 @@ #### Defined in -[src/modules/multi-tenancy/tenant.service.ts:8](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/tenant.service.ts#L8) +[src/modules/multi-tenancy/tenant.service.ts:8](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/tenant.service.ts#L8) diff --git a/docs/modules/modules_multi_tenancy_types.md b/docs/modules/modules_multi_tenancy_types.md index 14a3f24d..5bf2683c 100644 --- a/docs/modules/modules_multi_tenancy_types.md +++ b/docs/modules/modules_multi_tenancy_types.md @@ -20,4 +20,4 @@ #### Defined in -[src/modules/multi-tenancy/types.ts:4](https://github.com/adrien2p/medusa-extender/blob/f0b5bec/src/modules/multi-tenancy/types.ts#L4) +[src/modules/multi-tenancy/types.ts:4](https://github.com/adrien2p/medusa-extender/blob/83dceb0/src/modules/multi-tenancy/types.ts#L4) diff --git a/documentation/09-features.md b/documentation/09-features.md index d9929822..a4dfd0c1 100644 --- a/documentation/09-features.md +++ b/documentation/09-features.md @@ -1,41 +1,6 @@ -# Features :monocle_face: +# Directory Architecture -## Non exhaustive list - -Here is a list of the features that you can find in that package - -- [Create or extend an entity](#decorators) -- [Create or extend a repository](#decorators) -- [Create or extend a service](#decorators) -- [Create middleware before or after medusa authentication strategy](#decorators) -- [Create new migrations](#decorators) -- [Create new router handler](#decorators) -- [Extend validators from medusa to includes custom fields](#decorators) -- [Emit entity subscribers events](#decorators) -- [Group your component by module](#module) -- [Register component dynamically with dynamic module](#module-dynamic-module) -- [Listen to entity subscribers and handle them wherever you want](#decorators) -- [CLI](#cli-medex) - - [Generate new components](#cli-medex) - - [Migrate your data](#cli-medex) -- [Monitoring `(Optional module)`](#monitoring) -- [Multi-tenancy architecture `(Optional module)`](#multi-tenancy) - -All those features aims to help you build what you want such as - -- Creating and managing a marketplace -- Creating a media store to sell nft - video - images - keys - etc. -- And basically create whatever you want on top of `@medusajs` - -Share your code - -- Build shareable modules/plugins to use across your project or to share with the community - -## Directory Architecture - -Using this package also allow you to manage your architecture as you want. -you will not be limited by any constraint as long as the component are decorated -and the modules are referenced into the main file to be loaded, everything is fine. +Using this package help you organise your code in a module approach. That means that you can go for a modular architecture and decoupled your code depending on your domains. diff --git a/documentation/_README_BUILT.md b/documentation/_README_BUILT.md index 89a85045..be23704f 100644 --- a/documentation/_README_BUILT.md +++ b/documentation/_README_BUILT.md @@ -29,10 +29,10 @@

- :syringe: Medusa on steroid, take your medusa project to the next level with some badass features :rocket:
- Fully customisable medusa, create custom fields in any entity, implement your own feature or extend existing one in minutes! Make your own architecture or choose the modular architecture provided. - Build a store, marketplace, media store and anything you want to do you can do it. - Enjoy the full power of Medusa with extra badass features :rocket: + Medusa on steroid, take your medusa project to the next level with some badass features :rocket:
+ The extender provides an out-of-the-box application architecture which allows developers and teams to create highly testable, scalable, loosely coupled, and easily maintainable applications. +In also increase medusa extensibility and customisation for special use cases. It comes with handy +decorators approach to increase the DX and full typings support for easier development. It is a complement to medusa but not a replacement :rocket:


@@ -51,9 +51,7 @@ * [Getting started :rocket:](#getting-started-rocket) * [Existing medusa project](#existing-medusa-project) * [From server starter](#from-server-starter) -* [Features :monocle_face:](#features-monocle_face) - * [Non exhaustive list](#non-exhaustive-list) - * [Directory Architecture](#directory-architecture) +* [Directory Architecture](#directory-architecture) * [CLI `medex`](#cli-medex) * [Commands references](#commands-references) * [Command `generate` reference](#command-generate-reference) @@ -146,52 +144,11 @@ npm run start That's it, your server is now up and running :rocket: -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#features-monocle_face) - -# Features :monocle_face: - - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#non-exhaustive-list) - -## Non exhaustive list - -Here is a list of the features that you can find in that package - -- [Create or extend an entity](#decorators) -- [Create or extend a repository](#decorators) -- [Create or extend a service](#decorators) -- [Create middleware before or after medusa authentication strategy](#decorators) -- [Create new migrations](#decorators) -- [Create new router handler](#decorators) -- [Extend validators from medusa to includes custom fields](#decorators) -- [Emit entity subscribers events](#decorators) -- [Group your component by module](#module) -- [Register component dynamically with dynamic module](#module-dynamic-module) -- [Listen to entity subscribers and handle them wherever you want](#decorators) -- [CLI](#cli-medex) - - [Generate new components](#cli-medex) - - [Migrate your data](#cli-medex) -- [Monitoring `(Optional module)`](#monitoring) -- [Multi-tenancy architecture `(Optional module)`](#multi-tenancy) - -All those features aims to help you build what you want such as - -- Creating and managing a marketplace -- Creating a media store to sell nft - video - images - keys - etc. -- And basically create whatever you want on top of `@medusajs` - -Share your code - -- Build shareable modules/plugins to use across your project or to share with the community - - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png)](#directory-architecture) -## Directory Architecture +# Directory Architecture -Using this package also allow you to manage your architecture as you want. -you will not be limited by any constraint as long as the component are decorated -and the modules are referenced into the main file to be loaded, everything is fine. +Using this package help you organise your code in a module approach. That means that you can go for a modular architecture and decoupled your code depending on your domains. diff --git a/package.json b/package.json index ece61e8f..b3f14aaf 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "medusa-extender", "version": "1.6.0", - "description": ":syringe: Medusa on steroid, take your medusa project to the next level with some badass features :rocket:", + "description": "Medusa on steroid, take your medusa project to the next level with some badass features :rocket:", "keywords": [ "medusa", "medusajs", diff --git a/tsconfig.json b/tsconfig.json index ca1747ac..f1722a77 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -5,5 +5,6 @@ "baseUrl": "./src", "rootDir": "./src" }, + "include": ["src"], "exclude": ["**/tests", "node_modules"] }