@breadstone/archipel-mcp 0.0.8 → 0.0.10

package/data/packages/platform-core/api/Class.FileConfigStrategy.md

@@ -3,10 +3,9 @@ title: 'Class: FileConfigStrategy'
 generated: true
 editUrl: false
 ---
-
 # Class: FileConfigStrategy
 
-Defined in: [config/strategies/FileConfigStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L16)
+Defined in: [config/strategies/FileConfigStrategy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L17)
 
 The `FileConfigStrategy` class.
 
@@ -26,8 +25,8 @@ Defined in: [config/strategies/FileConfigStrategy.ts:27](https://github.com/RueD
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `envFile` | `string` |
 
 #### Returns
@@ -46,13 +45,13 @@ Defined in: [config/strategies/FileConfigStrategy.ts:27](https://github.com/RueD
 has(key): boolean;
 ```
 
-Defined in: [config/strategies/FileConfigStrategy.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L64)
+Defined in: [config/strategies/FileConfigStrategy.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L67)
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `key`     | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
 
 #### Returns
 
@@ -62,7 +61,7 @@ Defined in: [config/strategies/FileConfigStrategy.ts:64](https://github.com/RueD
 
 [`ConfigStrategyBase`](Class.ConfigStrategyBase).[`has`](Class.ConfigStrategyBase#has)
 
----
+***
 
 ### initialize()
 
@@ -82,7 +81,7 @@ Defined in: [config/strategies/FileConfigStrategy.ts:37](https://github.com/RueD
 
 [`ConfigStrategyBase`](Class.ConfigStrategyBase).[`initialize`](Class.ConfigStrategyBase#initialize)
 
----
+***
 
 ### resolve()
 
@@ -97,14 +96,14 @@ Defined in: [config/strategies/FileConfigStrategy.ts:43](https://github.com/RueD
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |
 
 #### Parameters
 
-| Parameter | Type     | Description         |
-| --------- | -------- | ------------------- |
-| `key`     | `string` | The key to resolve. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The key to resolve. |
 
 #### Returns
 
@@ -116,7 +115,7 @@ The resolved configuration value.
 
 [`ConfigStrategyBase`](Class.ConfigStrategyBase).[`resolve`](Class.ConfigStrategyBase#resolve)
 
----
+***
 
 ### tryResolve()
 
@@ -129,15 +128,15 @@ Defined in: [config/strategies/FileConfigStrategy.ts:53](https://github.com/RueD
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |
 
 #### Parameters
 
-| Parameter  | Type     |
-| ---------- | -------- |
-| `key`      | `string` |
-| `fallback` | `T`      |
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+| `fallback` | `T` |
 
 #### Returns
 

package/data/packages/platform-core/api/Class.FileResourceStrategy.md

@@ -3,7 +3,6 @@ title: 'Class: FileResourceStrategy'
 generated: true
 editUrl: false
 ---
-
 # Class: FileResourceStrategy
 
 Defined in: [resources/strategies/FileResourceStrategy.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L47)
@@ -28,9 +27,9 @@ Constructs a new instance of the `FileResourceStrategy` class.
 
 #### Parameters
 
-| Parameter | Type                                                                   |
-| --------- | ---------------------------------------------------------------------- |
-| `config`  | [`IFileResourceStrategyConfig`](Interface.IFileResourceStrategyConfig) |
+| Parameter | Type |
+| ------ | ------ |
+| `config` | [`IFileResourceStrategyConfig`](Interface.IFileResourceStrategyConfig) |
 
 #### Returns
 
@@ -74,9 +73,9 @@ Checks if a resource exists without loading it.
 
 #### Parameters
 
-| Parameter | Type     | Description      |
-| --------- | -------- | ---------------- |
-| `key`     | `string` | The resource key |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key |
 
 #### Returns
 
@@ -88,7 +87,7 @@ True if the resource exists
 
 [`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
 
----
+***
 
 ### existsAsync()
 
@@ -102,9 +101,9 @@ Checks if a resource exists without loading it (asynchronous).
 
 #### Parameters
 
-| Parameter | Type     | Description      |
-| --------- | -------- | ---------------- |
-| `key`     | `string` | The resource key |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key |
 
 #### Returns
 
@@ -116,7 +115,7 @@ Promise resolving to true if the resource exists
 
 [`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
 
----
+***
 
 ### load()
 
@@ -130,9 +129,9 @@ Loads a resource by its key.
 
 #### Parameters
 
-| Parameter | Type     | Description      |
-| --------- | -------- | ---------------- |
-| `key`     | `string` | The resource key |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key |
 
 #### Returns
 
@@ -144,7 +143,7 @@ The resource result or undefined if not found
 
 [`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
 
----
+***
 
 ### loadAsync()
 
@@ -158,9 +157,9 @@ Loads a resource by its key (asynchronous).
 
 #### Parameters
 
-| Parameter | Type     | Description      |
-| --------- | -------- | ---------------- |
-| `key`     | `string` | The resource key |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key |
 
 #### Returns
 
@@ -172,7 +171,7 @@ Promise resolving to the resource result or undefined if not found
 
 [`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
 
----
+***
 
 ### whatDoIHave()
 

package/data/packages/platform-core/api/Class.GUIDGenerator.md

@@ -3,7 +3,6 @@ title: 'Class: GUIDGenerator'
 generated: true
 editUrl: false
 ---
-
 # Class: GUIDGenerator
 
 Defined in: [identifiers/generators/GUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/GUIDGenerator.ts#L14)
@@ -44,9 +43,9 @@ Generates a GUID (variant of UUID)
 
 #### Parameters
 
-| Parameter  | Type     | Description                          |
-| ---------- | -------- | ------------------------------------ |
-| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `prefix?` | `string` | Optional prefix to prepend to the ID |
 | `postfix?` | `string` | Optional postfix to append to the ID |
 
 #### Returns
@@ -57,7 +56,7 @@ Generates a GUID (variant of UUID)
 
 [`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
 
----
+***
 
 ### isValid()
 
@@ -71,9 +70,9 @@ Validates if the provided string is a valid GUID
 
 #### Parameters
 
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `id`      | `string` | The ID to validate |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID to validate |
 
 #### Returns
 

package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md

@@ -3,7 +3,6 @@ title: 'Class: GlobalExceptionFilter'
 generated: true
 editUrl: false
 ---
-
 # Class: GlobalExceptionFilter
 
 Defined in: [filters/GlobalExceptionFilter.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/GlobalExceptionFilter.ts#L17)
@@ -29,8 +28,8 @@ Constructs a new instance of the `GlobalExceptionFilter` class.
 
 #### Parameters
 
-| Parameter               | Type                                                 | Description                                         |
-| ----------------------- | ---------------------------------------------------- | --------------------------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `errorTemplateService?` | [`ErrorTemplateService`](Class.ErrorTemplateService) | Optional error template service for HTML rendering. |
 
 #### Returns
@@ -51,10 +50,10 @@ Catches the exception and formats the response.
 
 #### Parameters
 
-| Parameter   | Type            | Description           |
-| ----------- | --------------- | --------------------- |
-| `exception` | `unknown`       | The caught exception. |
-| `host`      | `ArgumentsHost` | The arguments host.   |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `exception` | `unknown` | The caught exception. |
+| `host` | `ArgumentsHost` | The arguments host. |
 
 #### Returns
 
@@ -63,5 +62,5 @@ Catches the exception and formats the response.
 #### Implementation of
 
 ```ts
-ExceptionFilter.catch;
+ExceptionFilter.catch
 ```

package/data/packages/platform-core/api/Class.HealthModule.md

@@ -3,7 +3,6 @@ title: 'Class: HealthModule'
 generated: true
 editUrl: false
 ---
-
 # Class: HealthModule
 
 Defined in: [health/HealthModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthModule.ts#L21)
@@ -34,8 +33,8 @@ Registers additional health indicators.
 
 #### Parameters
 
-| Parameter    | Type                                                         | Description                                              |
-| ------------ | ------------------------------------------------------------ | -------------------------------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `indicators` | `Type`\<[`IHealthIndicator`](Interface.IHealthIndicator)\>[] | Array of indicator classes implementing IHealthIndicator |
 
 #### Returns

package/data/packages/platform-core/api/Class.HealthOrchestrator.md

@@ -3,7 +3,6 @@ title: 'Class: HealthOrchestrator'
 generated: true
 editUrl: false
 ---
-
 # Class: HealthOrchestrator
 
 Defined in: [health/HealthOrchestrator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthOrchestrator.ts#L15)
@@ -42,7 +41,7 @@ Executes all registered health indicators and aggregates their results.
 
 The aggregated health check results.
 
----
+***
 
 ### registerIndicator()
 
@@ -56,8 +55,8 @@ Registers a health indicator.
 
 #### Parameters
 
-| Parameter   | Type                                             | Description                       |
-| ----------- | ------------------------------------------------ | --------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `indicator` | [`IHealthIndicator`](Interface.IHealthIndicator) | The health indicator to register. |
 
 #### Returns

package/data/packages/platform-core/api/Class.HostModule.md

@@ -3,7 +3,6 @@ title: 'Class: HostModule'
 generated: true
 editUrl: false
 ---
-
 # Class: HostModule
 
 Defined in: [host/HostModule.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/host/HostModule.ts#L33)
@@ -11,7 +10,6 @@ Defined in: [host/HostModule.ts:33](https://github.com/RueDeRennes/archipel/blob
 The `HostModule` provides host-related services globally.
 
 This module exports:
-
 - `HostService`: Provides access to host configuration (host URL, stage, version, etc.)
 - `ContentTemplateEngine`: Template engine for rendering dynamic content
 

package/data/packages/platform-core/api/Class.HostService.md

@@ -3,10 +3,9 @@ title: 'Class: HostService'
 generated: true
 editUrl: false
 ---
-
 # Class: HostService
 
-Defined in: [services/HostService.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L142)
+Defined in: [services/HostService.ts:137](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L137)
 
 The `HostService` class.
 
@@ -16,22 +15,22 @@ The `HostService` class.
 
 ```ts
 new HostService(
-   configService,
-   contentTemplateEngine,
+   configService, 
+   contentTemplateEngine, 
    resourceManager): HostService;
 ```
 
-Defined in: [services/HostService.ts:159](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L159)
+Defined in: [services/HostService.ts:153](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L153)
 
 Constructs a new instance of the `HostService` class.
 
 #### Parameters
 
-| Parameter               | Type                                                   |
-| ----------------------- | ------------------------------------------------------ |
-| `configService`         | [`ConfigService`](Class.ConfigService)                 |
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | [`ConfigService`](Class.ConfigService) |
 | `contentTemplateEngine` | [`ContentTemplateEngine`](Class.ContentTemplateEngine) |
-| `resourceManager`       | [`ResourceManager`](Class.ResourceManager)             |
+| `resourceManager` | [`ResourceManager`](Class.ResourceManager) |
 
 #### Returns
 
@@ -47,7 +46,7 @@ Constructs a new instance of the `HostService` class.
 get host(): string;
 ```
 
-Defined in: [services/HostService.ts:195](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L195)
+Defined in: [services/HostService.ts:193](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L193)
 
 The full host (URL + port in development).
 
@@ -55,7 +54,7 @@ The full host (URL + port in development).
 
 `string`
 
----
+***
 
 ### port
 
@@ -65,7 +64,7 @@ The full host (URL + port in development).
 get port(): number;
 ```
 
-Defined in: [services/HostService.ts:185](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L185)
+Defined in: [services/HostService.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L183)
 
 The port of the host.
 
@@ -73,7 +72,7 @@ The port of the host.
 
 `number`
 
----
+***
 
 ### stage
 
@@ -83,7 +82,7 @@ The port of the host.
 get stage(): "unknown" | "local" | "development" | "preview" | "production";
 ```
 
-Defined in: [services/HostService.ts:207](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L207)
+Defined in: [services/HostService.ts:203](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L203)
 
 The current stage of the application.
 
@@ -91,7 +90,7 @@ The current stage of the application.
 
 `"unknown"` \| `"local"` \| `"development"` \| `"preview"` \| `"production"`
 
----
+***
 
 ### url
 
@@ -101,7 +100,7 @@ The current stage of the application.
 get url(): string;
 ```
 
-Defined in: [services/HostService.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L175)
+Defined in: [services/HostService.ts:173](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L173)
 
 The URL of the host.
 
@@ -109,7 +108,7 @@ The URL of the host.
 
 `string`
 
----
+***
 
 ### version
 
@@ -119,7 +118,7 @@ The URL of the host.
 get version(): string;
 ```
 
-Defined in: [services/HostService.ts:228](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L228)
+Defined in: [services/HostService.ts:224](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L224)
 
 The application version.
 
@@ -135,15 +134,15 @@ The application version.
 getHostContent(params): Promise<string>;
 ```
 
-Defined in: [services/HostService.ts:240](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L240)
+Defined in: [services/HostService.ts:236](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L236)
 
 Retrieves the host content
 
 #### Parameters
 
-| Parameter | Type                                                 |
-| --------- | ---------------------------------------------------- |
-| `params`  | [`IHostContentParams`](Interface.IHostContentParams) |
+| Parameter | Type |
+| ------ | ------ |
+| `params` | [`IHostContentParams`](Interface.IHostContentParams) |
 
 #### Returns
 

package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md

@@ -3,7 +3,6 @@ title: 'Class: HttpLoggerMiddleware'
 generated: true
 editUrl: false
 ---
-
 # Class: HttpLoggerMiddleware
 
 Defined in: [middlewares/HttpLoggerMiddleware.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L10)
@@ -34,8 +33,8 @@ Constructs a new instance of the `HttpLoggerMiddleware` class.
 
 ```ts
 use(
-   req,
-   _res,
+   req, 
+   _res, 
    next): void;
 ```
 
@@ -43,11 +42,11 @@ Defined in: [middlewares/HttpLoggerMiddleware.ts:31](https://github.com/RueDeRen
 
 #### Parameters
 
-| Parameter | Type         |
-| --------- | ------------ |
-| `req`     | `any`        |
-| `_res`    | `any`        |
-| `next`    | () => `void` |
+| Parameter | Type |
+| ------ | ------ |
+| `req` | `any` |
+| `_res` | `any` |
+| `next` | () => `void` |
 
 #### Returns
 
@@ -56,5 +55,5 @@ Defined in: [middlewares/HttpLoggerMiddleware.ts:31](https://github.com/RueDeRen
 #### Implementation of
 
 ```ts
-NestMiddleware.use;
+NestMiddleware.use
 ```

package/data/packages/platform-core/api/Class.IdGeneratorBase.md

@@ -3,7 +3,6 @@ title: 'Abstract Class: IdGeneratorBase'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: IdGeneratorBase
 
 Defined in: [identifiers/generators/abstracts/IdGeneratorBase.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/abstracts/IdGeneratorBase.ts#L15)
@@ -46,9 +45,9 @@ Generates a new ID
 
 #### Parameters
 
-| Parameter  | Type     | Description                          |
-| ---------- | -------- | ------------------------------------ |
-| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `prefix?` | `string` | Optional prefix to prepend to the ID |
 | `postfix?` | `string` | Optional postfix to append to the ID |
 
 #### Returns
@@ -59,7 +58,7 @@ Generates a new ID
 
 [`IIdGenerator`](Interface.IIdGenerator).[`generate`](Interface.IIdGenerator#generate)
 
----
+***
 
 ### isValid()
 
@@ -73,9 +72,9 @@ Validates if the given ID conforms to the expected format
 
 #### Parameters
 
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `id`      | `string` | The ID to validate |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID to validate |
 
 #### Returns
 

package/data/packages/platform-core/api/Class.IdentifierModule.md

@@ -3,7 +3,6 @@ title: 'Class: IdentifierModule'
 generated: true
 editUrl: false
 ---
-
 # Class: IdentifierModule
 
 Defined in: [identifiers/IdentifierModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierModule.ts#L23)
@@ -32,9 +31,9 @@ Defined in: [identifiers/IdentifierModule.ts:24](https://github.com/RueDeRennes/
 
 #### Parameters
 
-| Parameter | Type                             |
-| --------- | -------------------------------- |
-| `type`    | `"UUID"` \| `"GUID"` \| `"CUID"` |
+| Parameter | Type |
+| ------ | ------ |
+| `type` | `"UUID"` \| `"GUID"` \| `"CUID"` |
 
 #### Returns
 

package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md

@@ -3,7 +3,6 @@ title: 'Class: LimitRequestSizeMiddleware'
 generated: true
 editUrl: false
 ---
-
 # Class: LimitRequestSizeMiddleware
 
 Defined in: [middlewares/LimitRequestSizeMiddleware.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/LimitRequestSizeMiddleware.ts#L5)
@@ -34,8 +33,8 @@ Constructs a new instance of the `LimitRequestSizeMiddleware` class.
 
 ```ts
 use(
-   request,
-   _response,
+   request, 
+   _response, 
    next): void;
 ```
 
@@ -43,11 +42,11 @@ Defined in: [middlewares/LimitRequestSizeMiddleware.ts:22](https://github.com/Ru
 
 #### Parameters
 
-| Parameter   | Type           |
-| ----------- | -------------- |
-| `request`   | `Request`      |
-| `_response` | `Response`     |
-| `next`      | `NextFunction` |
+| Parameter | Type |
+| ------ | ------ |
+| `request` | `Request` |
+| `_response` | `Response` |
+| `next` | `NextFunction` |
 
 #### Returns
 
@@ -56,5 +55,5 @@ Defined in: [middlewares/LimitRequestSizeMiddleware.ts:22](https://github.com/Ru
 #### Implementation of
 
 ```ts
-NestMiddleware.use;
+NestMiddleware.use
 ```

package/data/packages/platform-core/api/Class.LocalizedTextRequest.md

@@ -3,7 +3,6 @@ title: 'Class: LocalizedTextRequest'
 generated: true
 editUrl: false
 ---
-
 # Class: LocalizedTextRequest
 
 Defined in: [models/requests/LocalizedTextRequest.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/LocalizedTextRequest.ts#L14)
@@ -32,7 +31,7 @@ locale: string;
 
 Defined in: [models/requests/LocalizedTextRequest.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/LocalizedTextRequest.ts#L26)
 
----
+***
 
 ### value