@breadstone/archipel-mcp 0.0.9 → 0.0.10

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

@@ -3,7 +3,6 @@ title: 'Class: BooleanUtils'
 generated: true
 editUrl: false
 ---
-
 # Class: BooleanUtils
 
 Defined in: [utils/BooleanUtils.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/BooleanUtils.ts#L22)
@@ -29,8 +28,8 @@ new BooleanUtils(): BooleanUtils;
 
 ```ts
 static formatBoolean(
-   bool,
-   trueFormat?,
+   bool, 
+   trueFormat?, 
    falseFormat?): string;
 ```
 
@@ -40,11 +39,11 @@ Formats a boolean into a specific string representation.
 
 #### Parameters
 
-| Parameter     | Type      | Default value | Description                                                   |
-| ------------- | --------- | ------------- | ------------------------------------------------------------- |
-| `bool`        | `boolean` | `undefined`   | The boolean to format                                         |
-| `trueFormat`  | `string`  | `'true'`      | The string to return for `true` values (defaults to "true")   |
-| `falseFormat` | `string`  | `'false'`     | The string to return for `false` values (defaults to "false") |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `bool` | `boolean` | `undefined` | The boolean to format |
+| `trueFormat` | `string` | `'true'` | The string to return for `true` values (defaults to "true") |
+| `falseFormat` | `string` | `'false'` | The string to return for `false` values (defaults to "false") |
 
 #### Returns
 
@@ -52,7 +51,7 @@ Formats a boolean into a specific string representation.
 
 The formatted string representation of the boolean
 
----
+***
 
 ### parseBoolean()
 
@@ -67,10 +66,10 @@ Accepts flexible strings like "yes", "no", "y", "n", "1", "0", "true", "false".
 
 #### Parameters
 
-| Parameter  | Type                  | Description                       |
-| ---------- | --------------------- | --------------------------------- |
-| `value`    | `string` \| `boolean` | The value to parse into a boolean |
-| `options?` | `BooleanOptions`      | Options for strict parsing mode   |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `string` \| `boolean` | The value to parse into a boolean |
+| `options?` | `BooleanOptions` | Options for strict parsing mode |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Class: CUIDGenerator'
 generated: true
 editUrl: false
 ---
-
 # Class: CUIDGenerator
 
 Defined in: [identifiers/generators/CUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L14)
@@ -44,9 +43,9 @@ Generates a CUID (Collision-Resistant Unique Identifier).
 
 #### 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 CUID (Collision-Resistant Unique Identifier).
 
 [`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
 
----
+***
 
 ### isValid()
 
@@ -71,9 +70,9 @@ Validates if the provided string is a valid CUID
 
 #### Parameters
 
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `id`      | `string` | The ID to validate |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID to validate |
 
 #### Returns
 
@@ -85,12 +84,12 @@ True if the ID is valid, otherwise false
 
 [`IdGeneratorBase`](Class.IdGeneratorBase).[`isValid`](Class.IdGeneratorBase#isvalid)
 
----
+***
 
 ### parse()
 
 ```ts
-parse(cuid):
+parse(cuid): 
   | {
   counter: string;
   random: string;
@@ -105,17 +104,17 @@ Parses a CUID into its segments
 
 #### Parameters
 
-| Parameter | Type     | Description              |
-| --------- | -------- | ------------------------ |
-| `cuid`    | `string` | The CUID string to parse |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cuid` | `string` | The CUID string to parse |
 
 #### Returns
 
-\| \{
-`counter`: `string`;
-`random`: `string`;
-`timestamp`: `string`;
+  \| \{
+  `counter`: `string`;
+  `random`: `string`;
+  `timestamp`: `string`;
 \}
-\| `null`
+  \| `null`
 
 An object containing the parsed segments

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

@@ -3,7 +3,6 @@ title: 'Class: CasingInterceptor'
 generated: true
 editUrl: false
 ---
-
 # Class: CasingInterceptor
 
 Defined in: [interceptors/CasingInterceptor.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L18)
@@ -42,10 +41,10 @@ Method to implement a custom interceptor.
 
 #### Parameters
 
-| Parameter | Type               | Description                                                                                                                         |
-| --------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
-| `context` | `ExecutionContext` | an `ExecutionContext` object providing methods to access the route handler and class about to be invoked.                           |
-| `next`    | `CallHandler`      | a reference to the `CallHandler`, which provides access to an `Observable` representing the response stream from the route handler. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | `ExecutionContext` | an `ExecutionContext` object providing methods to access the route handler and class about to be invoked. |
+| `next` | `CallHandler` | a reference to the `CallHandler`, which provides access to an `Observable` representing the response stream from the route handler. |
 
 #### Returns
 
@@ -54,10 +53,10 @@ Method to implement a custom interceptor.
 #### Implementation of
 
 ```ts
-NestInterceptor.intercept;
+NestInterceptor.intercept
 ```
 
----
+***
 
 ### process()
 
@@ -70,14 +69,14 @@ Defined in: [interceptors/CasingInterceptor.ts:38](https://github.com/RueDeRenne
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |
 
 #### Parameters
 
 | Parameter | Type |
-| --------- | ---- |
-| `value`   | `T`  |
+| ------ | ------ |
+| `value` | `T` |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ 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)
@@ -32,22 +31,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()
 
@@ -60,20 +59,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()
 
@@ -85,9 +84,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.ConfigKeyNotFoundError.md

@@ -0,0 +1,89 @@
+---
+title: 'Class: ConfigKeyNotFoundError'
+generated: true
+editUrl: false
+---
+# Class: ConfigKeyNotFoundError
+
+Defined in: [config/errors/ConfigKeyNotFoundError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/errors/ConfigKeyNotFoundError.ts#L6)
+
+Error thrown when a configuration key cannot be resolved.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ConfigKeyNotFoundError(key, source): ConfigKeyNotFoundError;
+```
+
+Defined in: [config/errors/ConfigKeyNotFoundError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/errors/ConfigKeyNotFoundError.ts#L16)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+| `source` | `string` |
+
+#### Returns
+
+`ConfigKeyNotFoundError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Properties
+
+### code
+
+```ts
+readonly code: "CONFIG_KEY_NOT_FOUND" = 'CONFIG_KEY_NOT_FOUND';
+```
+
+Defined in: [config/errors/ConfigKeyNotFoundError.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/errors/ConfigKeyNotFoundError.ts#L28)
+
+Machine-readable error code.
+
+## Accessors
+
+### key
+
+#### Get Signature
+
+```ts
+get key(): string;
+```
+
+Defined in: [config/errors/ConfigKeyNotFoundError.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/errors/ConfigKeyNotFoundError.ts#L31)
+
+The configuration key that was not found.
+
+##### Returns
+
+`string`
+
+***
+
+### source
+
+#### Get Signature
+
+```ts
+get source(): string;
+```
+
+Defined in: [config/errors/ConfigKeyNotFoundError.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/errors/ConfigKeyNotFoundError.ts#L36)
+
+The source that was searched (e.g. `'process.env'`, a file path).
+
+##### Returns
+
+`string`

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

@@ -3,7 +3,6 @@ title: 'Class: ConfigModule'
 generated: true
 editUrl: false
 ---
-
 # Class: ConfigModule
 
 Defined in: [config/ConfigModule.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L27)
@@ -34,15 +33,15 @@ Defined in: [config/ConfigModule.ts:47](https://github.com/RueDeRennes/archipel/
 
 #### Parameters
 
-| Parameter | Type                                                                  |
-| --------- | --------------------------------------------------------------------- |
+| Parameter | Type |
+| ------ | ------ |
 | `options` | `Partial`\<[`IConfigModuleOptions`](Interface.IConfigModuleOptions)\> |
 
 #### Returns
 
 `DynamicModule`
 
----
+***
 
 ### register()
 
@@ -58,10 +57,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,7 +3,6 @@ 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)
@@ -44,7 +43,7 @@ Returns all registered configuration entries as a flat array.
 
 readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]
 
----
+***
 
 ### getByModule()
 
@@ -60,7 +59,7 @@ Returns all registered entries grouped by their source module.
 
 `ReadonlyMap`\<`string`, readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]\>
 
----
+***
 
 ### getModules()
 
@@ -76,7 +75,7 @@ Returns all unique module names that have registered keys.
 
 readonly `string`[]
 
----
+***
 
 ### getRequired()
 
@@ -92,7 +91,7 @@ Returns all registered entries whose `required` flag is `true`.
 
 readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]
 
----
+***
 
 ### register()
 
@@ -106,10 +105,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,10 +3,9 @@ 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)
+Defined in: [config/services/ConfigService.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L10)
 
 ## Constructors
 
@@ -20,10 +19,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
 
@@ -37,22 +36,22 @@ Defined in: [config/services/ConfigService.ts:20](https://github.com/RueDeRennes
 compare<T>(key, value): boolean;
 ```
 
-Defined in: [config/services/ConfigService.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L81)
+Defined in: [config/services/ConfigService.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L80)
 
 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
 
@@ -60,7 +59,7 @@ Compares the value of the specified configuration key with the given value.
 
 True if the resolved value matches; otherwise, false.
 
----
+***
 
 ### get()
 
@@ -68,23 +67,22 @@ True if the resolved value matches; otherwise, false.
 get<T>(key): T;
 ```
 
-Defined in: [config/services/ConfigService.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L45)
+Defined in: [config/services/ConfigService.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L44)
 
 Retrieves the parsed value of the specified configuration key.
-
 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
 
@@ -92,7 +90,7 @@ Automatically parses strings into numbers, booleans, or null if applicable.
 
 The parsed configuration value.
 
----
+***
 
 ### initialize()
 
@@ -106,7 +104,7 @@ Defined in: [config/services/ConfigService.ts:32](https://github.com/RueDeRennes
 
 `void`
 
----
+***
 
 ### tryGet()
 
@@ -114,23 +112,23 @@ Defined in: [config/services/ConfigService.ts:32](https://github.com/RueDeRennes
 tryGet<T>(key, fallback): T;
 ```
 
-Defined in: [config/services/ConfigService.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L65)
+Defined in: [config/services/ConfigService.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L64)
 
 Attempts to retrieve the value of the specified configuration key.
 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