@breadstone/archipel-mcp 0.0.2 → 0.0.4

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

@@ -3,6 +3,7 @@ title: 'Class: CatchUtils'
 generated: true
 editUrl: false
 ---
+
 # Class: CatchUtils
 
 Defined in: [utils/CatchUtils.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L2)
@@ -31,22 +32,22 @@ Defined in: [utils/CatchUtils.ts:6](https://github.com/RueDeRennes/archipel/blob
 
 #### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `Error` |
+| Type Parameter        |
+| --------------------- |
+| `T` _extends_ `Error` |
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `input` | `unknown` |
+| Parameter | Type                 |
+| --------- | -------------------- |
+| `input`   | `unknown`            |
 | `handler` | (`error`) => `Error` |
 
 #### Returns
 
 `void`
 
-***
+---
 
 ### catchError()
 
@@ -59,20 +60,20 @@ Defined in: [utils/CatchUtils.ts:12](https://github.com/RueDeRennes/archipel/blo
 #### Type Parameters
 
 | Type Parameter |
-| ------ |
-| `T` |
+| -------------- |
+| `T`            |
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter | Type             |
+| --------- | ---------------- |
 | `promise` | `Promise`\<`T`\> |
 
 #### Returns
 
 `Promise`\<\[`undefined`, `T`\] \| \[`Error`\]\>
 
-***
+---
 
 ### isError()
 
@@ -84,9 +85,9 @@ Defined in: [utils/CatchUtils.ts:18](https://github.com/RueDeRennes/archipel/blo
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `unknown` |
+| Parameter | Type      |
+| --------- | --------- |
+| `value`   | `unknown` |
 
 #### Returns
 

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

@@ -3,9 +3,10 @@ title: 'Class: ConfigModule'
 generated: true
 editUrl: false
 ---
+
 # Class: ConfigModule
 
-Defined in: [config/ConfigModule.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L30)
+Defined in: [config/ConfigModule.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L27)
 
 The `ConfigModule` class.
 
@@ -29,19 +30,19 @@ new ConfigModule(): ConfigModule;
 static forRoot(options): DynamicModule;
 ```
 
-Defined in: [config/ConfigModule.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L50)
+Defined in: [config/ConfigModule.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L47)
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter | Type                                                                  |
+| --------- | --------------------------------------------------------------------- |
 | `options` | `Partial`\<[`IConfigModuleOptions`](Interface.IConfigModuleOptions)\> |
 
 #### Returns
 
 `DynamicModule`
 
-***
+---
 
 ### register()
 
@@ -49,7 +50,7 @@ Defined in: [config/ConfigModule.ts:50](https://github.com/RueDeRennes/archipel/
 static register(module, entries): DynamicModule;
 ```
 
-Defined in: [config/ConfigModule.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L42)
+Defined in: [config/ConfigModule.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L39)
 
 Registers environment variable keys from a library module into the
 central [ConfigRegistry](Class.ConfigRegistry). Call this in each library's module
@@ -57,10 +58,10 @@ to declare the configuration it depends upon.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `module` | `string` | The logical module name (e.g. `'platform-authentication'`). |
-| `entries` | readonly `Omit`\<[`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>, `"module"`\>[] | The configuration entries the module depends on. |
+| Parameter | Type                                                                                                   | Description                                                 |
+| --------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
+| `module`  | `string`                                                                                               | The logical module name (e.g. `'platform-authentication'`). |
+| `entries` | readonly `Omit`\<[`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>, `"module"`\>[] | The configuration entries the module depends on.            |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ title: 'Class: ConfigRegistry'
 generated: true
 editUrl: false
 ---
+
 # Class: ConfigRegistry
 
 Defined in: [config/ConfigRegistry.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L53)
@@ -43,7 +44,7 @@ Returns all registered configuration entries as a flat array.
 
 readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]
 
-***
+---
 
 ### getByModule()
 
@@ -59,7 +60,7 @@ Returns all registered entries grouped by their source module.
 
 `ReadonlyMap`\<`string`, readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]\>
 
-***
+---
 
 ### getModules()
 
@@ -75,7 +76,7 @@ Returns all unique module names that have registered keys.
 
 readonly `string`[]
 
-***
+---
 
 ### getRequired()
 
@@ -91,7 +92,7 @@ Returns all registered entries whose `required` flag is `true`.
 
 readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]
 
-***
+---
 
 ### register()
 
@@ -105,10 +106,10 @@ Registers one or more configuration entries.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `module` | `string` | The logical module name (e.g. `'platform-mailing'`). |
-| `entries` | readonly `Omit`\<[`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>, `"module"`\>[] | The configuration entries to register. |
+| Parameter | Type                                                                                                   | Description                                          |
+| --------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- |
+| `module`  | `string`                                                                                               | The logical module name (e.g. `'platform-mailing'`). |
+| `entries` | readonly `Omit`\<[`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>, `"module"`\>[] | The configuration entries to register.               |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ title: 'Class: ConfigService'
 generated: true
 editUrl: false
 ---
+
 # Class: ConfigService
 
 Defined in: [config/services/ConfigService.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L9)
@@ -19,10 +20,10 @@ Defined in: [config/services/ConfigService.ts:20](https://github.com/RueDeRennes
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter  | Type                                             |
+| ---------- | ------------------------------------------------ |
 | `strategy` | [`ConfigStrategyBase`](Class.ConfigStrategyBase) |
-| `statics` | `Record`\<`string`, `string`\> |
+| `statics`  | `Record`\<`string`, `string`\>                   |
 
 #### Returns
 
@@ -42,16 +43,16 @@ Compares the value of the specified configuration key with the given value.
 
 #### Type Parameters
 
-| Type Parameter | Default type | Description |
-| ------ | ------ | ------ |
-| `T` | `string` | Expected type of the comparison value. |
+| Type Parameter | Default type | Description                            |
+| -------------- | ------------ | -------------------------------------- |
+| `T`            | `string`     | Expected type of the comparison value. |
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The configuration key to compare. |
-| `value` | `T` | The value to compare against. |
+| Parameter | Type     | Description                       |
+| --------- | -------- | --------------------------------- |
+| `key`     | `string` | The configuration key to compare. |
+| `value`   | `T`      | The value to compare against.     |
 
 #### Returns
 
@@ -59,7 +60,7 @@ Compares the value of the specified configuration key with the given value.
 
 True if the resolved value matches; otherwise, false.
 
-***
+---
 
 ### get()
 
@@ -75,15 +76,15 @@ Automatically parses strings into numbers, booleans, or null if applicable.
 
 #### Type Parameters
 
-| Type Parameter | Default type | Description |
-| ------ | ------ | ------ |
-| `T` | `string` | Expected type of the returned value. |
+| Type Parameter | Default type | Description                          |
+| -------------- | ------------ | ------------------------------------ |
+| `T`            | `string`     | Expected type of the returned value. |
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The configuration key to retrieve. |
+| Parameter | Type     | Description                        |
+| --------- | -------- | ---------------------------------- |
+| `key`     | `string` | The configuration key to retrieve. |
 
 #### Returns
 
@@ -91,7 +92,7 @@ Automatically parses strings into numbers, booleans, or null if applicable.
 
 The parsed configuration value.
 
-***
+---
 
 ### initialize()
 
@@ -105,7 +106,7 @@ Defined in: [config/services/ConfigService.ts:32](https://github.com/RueDeRennes
 
 `void`
 
-***
+---
 
 ### tryGet()
 
@@ -120,16 +121,16 @@ If the key does not exist, returns the provided fallback value.
 
 #### Type Parameters
 
-| Type Parameter | Default type | Description |
-| ------ | ------ | ------ |
-| `T` | `string` | Expected type of the returned value. |
+| Type Parameter | Default type | Description                          |
+| -------------- | ------------ | ------------------------------------ |
+| `T`            | `string`     | Expected type of the returned value. |
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The configuration key to retrieve. |
-| `fallback` | `T` | The fallback value to return if the key is not found. |
+| Parameter  | Type     | Description                                           |
+| ---------- | -------- | ----------------------------------------------------- |
+| `key`      | `string` | The configuration key to retrieve.                    |
+| `fallback` | `T`      | The fallback value to return if the key is not found. |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ title: 'Abstract Class: ConfigStrategyBase'
 generated: true
 editUrl: false
 ---
+
 # Abstract Class: ConfigStrategyBase
 
 Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/Abstracts/ConfigStrategyBase.ts#L8)
@@ -43,15 +44,15 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:38](https://githu
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `key` | `string` |
+| Parameter | Type     |
+| --------- | -------- |
+| `key`     | `string` |
 
 #### Returns
 
 `boolean`
 
-***
+---
 
 ### initialize()
 
@@ -67,7 +68,7 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:26](https://githu
 
 `void`
 
-***
+---
 
 ### resolve()
 
@@ -82,14 +83,14 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:34](https://githu
 #### 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
 
@@ -97,7 +98,7 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:34](https://githu
 
 The resolved configuration value.
 
-***
+---
 
 ### tryResolve()
 
@@ -110,15 +111,15 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:36](https://githu
 #### 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.ContentTemplateEngine.md

@@ -3,6 +3,7 @@ title: 'Class: ContentTemplateEngine'
 generated: true
 editUrl: false
 ---
+
 # Class: ContentTemplateEngine
 
 Defined in: [templates/ContentTemplateEngine.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L17)
@@ -39,10 +40,10 @@ Compiles a template by replacing placeholders with the provided parameters.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `content` | `string` | The content of the template to compile. |
-| `params` | `Record`\<`string`, `unknown`\> | The parameters to insert into the template. |
+| Parameter | Type                            | Description                                 |
+| --------- | ------------------------------- | ------------------------------------------- |
+| `content` | `string`                        | The content of the template to compile.     |
+| `params`  | `Record`\<`string`, `unknown`\> | The parameters to insert into the template. |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ title: 'Class: CryptoService'
 generated: true
 editUrl: false
 ---
+
 # Class: CryptoService
 
 Defined in: [services/CryptoService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/CryptoService.ts#L15)
@@ -40,9 +41,9 @@ Hashes the given data.
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `prefix` | `string` |
+| Parameter | Type     |
+| --------- | -------- |
+| `prefix`  | `string` |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ title: 'Class: DateTimeUtils'
 generated: true
 editUrl: false
 ---
+
 # Class: DateTimeUtils
 
 Defined in: [utils/DateTimeUtils.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/DateTimeUtils.ts#L28)
@@ -36,10 +37,10 @@ Converts a time span value (string or number) to milliseconds or a formatted str
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `number` \| [`StringValue`](TypeAlias.StringValue) | The time span value to convert |
-| `options?` | `Options` | Options for formatting the output |
+| Parameter  | Type                                               | Description                       |
+| ---------- | -------------------------------------------------- | --------------------------------- |
+| `value`    | `number` \| [`StringValue`](TypeAlias.StringValue) | The time span value to convert    |
+| `options?` | `Options`                                          | Options for formatting the output |
 
 #### Returns
 
@@ -47,7 +48,7 @@ Converts a time span value (string or number) to milliseconds or a formatted str
 
 The parsed time in milliseconds or formatted time string
 
-***
+---
 
 ### format()
 
@@ -61,9 +62,9 @@ Formats a number of milliseconds into a string representation.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `ms` | `number` | The milliseconds to format |
+| Parameter  | Type      | Description                       |
+| ---------- | --------- | --------------------------------- |
+| `ms`       | `number`  | The milliseconds to format        |
 | `options?` | `Options` | Options for formatting the output |
 
 #### Returns
@@ -72,7 +73,7 @@ Formats a number of milliseconds into a string representation.
 
 The formatted time span string
 
-***
+---
 
 ### parse()
 
@@ -86,9 +87,9 @@ Parses a time span string to milliseconds.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | [`StringValue`](TypeAlias.StringValue) | The time span string to parse |
+| Parameter | Type                                   | Description                   |
+| --------- | -------------------------------------- | ----------------------------- |
+| `value`   | [`StringValue`](TypeAlias.StringValue) | The time span string to parse |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ title: 'Class: DeviceParserService'
 generated: true
 editUrl: false
 ---
+
 # Class: DeviceParserService
 
 Defined in: [services/DeviceParserService.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L31)
@@ -41,8 +42,8 @@ Parse User-Agent string and extract device information
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter   | Type     | Description                  |
+| ----------- | -------- | ---------------------------- |
 | `userAgent` | `string` | The User-Agent header string |
 
 #### Returns

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

@@ -3,6 +3,7 @@ title: 'Class: EmbeddedResourceStrategy'
 generated: true
 editUrl: false
 ---
+
 # Class: EmbeddedResourceStrategy
 
 Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L14)
@@ -27,8 +28,8 @@ Constructs a new instance of the `EmbeddedResourceStrategy` class.
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter   | Type                           |
+| ----------- | ------------------------------ |
 | `resources` | `Record`\<`string`, `string`\> |
 
 #### Returns
@@ -73,9 +74,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
 
@@ -87,7 +88,7 @@ True if the resource exists
 
 [`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
 
-***
+---
 
 ### existsAsync()
 
@@ -101,9 +102,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
 
@@ -115,7 +116,7 @@ Promise resolving to true if the resource exists
 
 [`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
 
-***
+---
 
 ### load()
 
@@ -129,9 +130,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
 
@@ -143,7 +144,7 @@ The resource result or undefined if not found
 
 [`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
 
-***
+---
 
 ### loadAsync()
 
@@ -157,9 +158,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
 
@@ -171,7 +172,7 @@ Promise resolving to the resource result or undefined if not found
 
 [`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
 
-***
+---
 
 ### register()
 
@@ -185,16 +186,16 @@ Registers a new embedded resource.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The resource key |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `key`     | `string` | The resource key     |
 | `content` | `string` | The resource content |
 
 #### Returns
 
 `void`
 
-***
+---
 
 ### whatDoIHave()