@breadstone/archipel-mcp 0.0.2 → 0.0.4

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

@@ -3,6 +3,7 @@ title: 'Class: UUIDGenerator'
 generated: true
 editUrl: false
 ---
+
 # Class: UUIDGenerator
 
 Defined in: [identifiers/generators/UUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/UUIDGenerator.ts#L14)
@@ -43,9 +44,9 @@ Generates a version 4 UUID (random-based)
 
 #### 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
@@ -56,7 +57,7 @@ Generates a version 4 UUID (random-based)
 
 [`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
 
-***
+---
 
 ### isValid()
 
@@ -70,9 +71,9 @@ Validates if the provided string is a valid UUID (version 4)
 
 #### 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.UserAvatarGeneratorService.md

@@ -3,6 +3,7 @@ title: 'Class: UserAvatarGeneratorService'
 generated: true
 editUrl: false
 ---
+
 # Class: UserAvatarGeneratorService
 
 Defined in: [services/UserAvatarGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UserAvatarGenerator.ts#L14)
@@ -35,10 +36,10 @@ Generates a random avatar as a base64-encoded PNG string.
 
 #### Parameters
 
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `width` | `number` | `128` | Width of the avatar in pixels (default: 128) |
-| `height` | `number` | `128` | Height of the avatar in pixels (default: 128) |
+| Parameter | Type     | Default value | Description                                   |
+| --------- | -------- | ------------- | --------------------------------------------- |
+| `width`   | `number` | `128`         | Width of the avatar in pixels (default: 128)  |
+| `height`  | `number` | `128`         | Height of the avatar in pixels (default: 128) |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ title: 'Class: UserNameGeneratorService'
 generated: true
 editUrl: false
 ---
+
 # Class: UserNameGeneratorService
 
 Defined in: [services/UsernameGeneratorService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UsernameGeneratorService.ts#L14)
@@ -35,9 +36,9 @@ Generates a random user name.
 
 #### Parameters
 
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `useNumbers` | `boolean` | `true` | If true, adds random numbers at the end of the user name |
+| Parameter    | Type      | Default value | Description                                              |
+| ------------ | --------- | ------------- | -------------------------------------------------------- |
+| `useNumbers` | `boolean` | `true`        | If true, adds random numbers at the end of the user name |
 
 #### Returns
 
@@ -45,7 +46,7 @@ Generates a random user name.
 
 A randomly generated user name
 
-***
+---
 
 ### generateSecure()
 

package/data/packages/platform-core/api/Function.Public.md

@@ -3,6 +3,7 @@ title: 'Function: Public()'
 generated: true
 editUrl: false
 ---
+
 # Function: Public()
 
 ```ts

package/data/packages/platform-core/api/Function.createConfigKey.md

@@ -3,6 +3,7 @@ title: 'Function: createConfigKey()'
 generated: true
 editUrl: false
 ---
+
 # Function: createConfigKey()
 
 ```ts
@@ -19,21 +20,21 @@ This ensures you don’t scatter raw strings and you assign a type to each key.
 ## Type Parameters
 
 | Type Parameter | Default type |
-| ------ | ------ |
-| `TType` | `unknown` |
+| -------------- | ------------ |
+| `TType`        | `unknown`    |
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | – The unique string identifier for the config entry. For example: `'DATABASE_URL'`, `'featureX.enabled'`, `'timeout.ms'`. |
+| Parameter | Type     | Description                                                                                                               |
+| --------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
+| `key`     | `string` | – The unique string identifier for the config entry. For example: `'DATABASE_URL'`, `'featureX.enabled'`, `'timeout.ms'`. |
 
 ## Returns
 
 [`IConfigKey`](Interface.IConfigKey)\<`TType`\>
 
 A branded config key of type `IConfigKey<TType>` where `TType` is
-         inferred (or specified) as the expected type of the value.
+inferred (or specified) as the expected type of the value.
 
 ## Example
 
@@ -45,8 +46,9 @@ export const FEATURE_X_ENABLED = createConfigKey<boolean>('FEATURE_X_ENABLED');
 ```
 
 Then, when fetching:
+
 ```ts
-const url = configService.get(DATABASE_URL);       // typed as string
+const url = configService.get(DATABASE_URL); // typed as string
 const timeout = configService.get(MAX_TIMEOUT_MS); // typed as number
 const enabled = configService.get(FEATURE_X_ENABLED); // typed as boolean
 ```

package/data/packages/platform-core/api/Function.createEventKey.md

@@ -3,6 +3,7 @@ title: 'Function: createEventKey()'
 generated: true
 editUrl: false
 ---
+
 # Function: createEventKey()
 
 ```ts
@@ -15,15 +16,15 @@ Creates a branded event key for the [EventHub](Class.EventHub).
 
 ## Type Parameters
 
-| Type Parameter |
-| ------ |
-| `TEvents` *extends* [`IEventMap`](Interface.IEventMap) |
-| `TKey` *extends* `string` \| `number` \| `symbol` |
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
+| `TKey` _extends_ `string` \| `number` \| `symbol`      |
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter   | Type   | Description                   |
+| ----------- | ------ | ----------------------------- |
 | `eventName` | `TKey` | The unique name of the event. |
 
 ## Returns

package/data/packages/platform-core/api/Function.createMappingKey.md

@@ -3,6 +3,7 @@ title: 'Function: createMappingKey()'
 generated: true
 editUrl: false
 ---
+
 # Function: createMappingKey()
 
 ```ts
@@ -16,15 +17,15 @@ Creates a type-safe mapping key.
 ## Type Parameters
 
 | Type Parameter |
-| ------ |
-| `TInput` |
-| `TOutput` |
+| -------------- |
+| `TInput`       |
+| `TOutput`      |
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The unique string identifier for the mapping. |
+| Parameter | Type     | Description                                   |
+| --------- | -------- | --------------------------------------------- |
+| `key`     | `string` | The unique string identifier for the mapping. |
 
 ## Returns
 

package/data/packages/platform-core/api/Function.env.md

@@ -3,6 +3,7 @@ title: 'Function: env()'
 generated: true
 editUrl: false
 ---
+
 # Function: env()
 
 ```ts
@@ -18,10 +19,10 @@ later search/grep all `env` usages in the codebase.
 
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `strings` | `TemplateStringsArray` |
-| ...`values` | `unknown`[] |
+| Parameter   | Type                   |
+| ----------- | ---------------------- |
+| `strings`   | `TemplateStringsArray` |
+| ...`values` | `unknown`[]            |
 
 ## Returns
 

package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md

@@ -3,6 +3,7 @@ title: 'Function: getMimeTypeByFileNameOrExtension()'
 generated: true
 editUrl: false
 ---
+
 # Function: getMimeTypeByFileNameOrExtension()
 
 ```ts
@@ -15,8 +16,8 @@ Get MIME type by file name or extension.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type         | Description                     |
+| --------- | ------------ | ------------------------------- |
 | ...`args` | \[`string`\] | Arguments for mime-types lookup |
 
 ## Returns

package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md

@@ -3,6 +3,7 @@ title: 'Function: isActionId()'
 generated: true
 editUrl: false
 ---
+
 # Function: isActionId()
 
 ```ts
@@ -15,10 +16,10 @@ Checks if the action id is valid.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The key to check. |
-| `action` | `string` | The action to check. |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `key`     | `string` | The key to check.    |
+| `action`  | `string` | The action to check. |
 
 ## Returns
 

package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md

@@ -3,6 +3,7 @@ title: 'Interface: IBlobResourceStrategyConfig'
 generated: true
 editUrl: false
 ---
+
 # Interface: IBlobResourceStrategyConfig
 
 Defined in: [resources/strategies/BlobResourceStrategy.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L36)
@@ -24,5 +25,5 @@ Optional key prefix for blob storage.
 #### Example
 
 ```ts
-'resources/', 'templates/'
+('resources/', 'templates/');
 ```

package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md

@@ -3,6 +3,7 @@ title: 'Interface: IBlobServiceAdapter'
 generated: true
 editUrl: false
 ---
+
 # Interface: IBlobServiceAdapter
 
 Defined in: [resources/strategies/BlobResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L14)
@@ -26,15 +27,15 @@ Downloads a file from blob storage.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The blob key |
+| Parameter | Type     | Description  |
+| --------- | -------- | ------------ |
+| `key`     | `string` | The blob key |
 
 #### Returns
 
 `Promise`\<\{
-  `contentType?`: `string`;
-  `data`: `unknown`;
+`contentType?`: `string`;
+`data`: `unknown`;
 \}\>
 
 The download result

package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md

@@ -3,6 +3,7 @@ title: 'Interface: ICacheMetricsRecorder'
 generated: true
 editUrl: false
 ---
+
 # Interface: ICacheMetricsRecorder
 
 Defined in: [cache/ICacheMetricsRecorder.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L6)
@@ -23,15 +24,15 @@ Records a cache eviction.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `cache` | `string` | The cache name/label |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
 
 #### Returns
 
 `void`
 
-***
+---
 
 ### recordHit()
 
@@ -45,15 +46,15 @@ Records a cache hit.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `cache` | `string` | The cache name/label |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
 
 #### Returns
 
 `void`
 
-***
+---
 
 ### recordLoadError()
 
@@ -67,15 +68,15 @@ Records a failed cache load.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `cache` | `string` | The cache name/label |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
 
 #### Returns
 
 `void`
 
-***
+---
 
 ### recordLoadSuccess()
 
@@ -89,15 +90,15 @@ Records a successful cache load.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `cache` | `string` | The cache name/label |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
 
 #### Returns
 
 `void`
 
-***
+---
 
 ### recordMiss()
 
@@ -111,9 +112,9 @@ Records a cache miss.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `cache` | `string` | The cache name/label |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
 
 #### Returns
 

package/data/packages/platform-core/api/Interface.ICacheStats.md

@@ -3,6 +3,7 @@ title: 'Interface: ICacheStats'
 generated: true
 editUrl: false
 ---
+
 # Interface: ICacheStats
 
 Defined in: [cache/ICacheStats.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L6)
@@ -21,7 +22,7 @@ Defined in: [cache/ICacheStats.ts:42](https://github.com/RueDeRennes/archipel/bl
 
 Number of cache evictions (if supported).
 
-***
+---
 
 ### hits
 
@@ -33,7 +34,7 @@ Defined in: [cache/ICacheStats.ts:14](https://github.com/RueDeRennes/archipel/bl
 
 Number of cache hits.
 
-***
+---
 
 ### loadErrors
 
@@ -45,7 +46,7 @@ Defined in: [cache/ICacheStats.ts:35](https://github.com/RueDeRennes/archipel/bl
 
 Number of failed cache loads.
 
-***
+---
 
 ### loads
 
@@ -57,7 +58,7 @@ Defined in: [cache/ICacheStats.ts:28](https://github.com/RueDeRennes/archipel/bl
 
 Number of successful cache loads.
 
-***
+---
 
 ### misses
 

package/data/packages/platform-core/api/Interface.IConfigKey.md

@@ -3,6 +3,7 @@ title: 'Interface: IConfigKey\<TType\>'
 generated: true
 editUrl: false
 ---
+
 # Interface: IConfigKey\<TType\>
 
 Defined in: [config/ConfigKey.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L27)
@@ -12,29 +13,29 @@ A type-safe config key that encodes both the config key and the type of its valu
 **Why this exists**: In large codebases it is common for configuration values
 (environment variables, feature flags, constants) to be accessed directly via
 raw strings or via `process.env['SOME_KEY']`. This leads to several issues:
-  • scattered literal strings making refactoring and discovery difficult,
-  • lack of compile-time checking for correct key names,
-  • no guarantee about the type of the value retrieved (string, number, boolean, etc),
-  • difficulty enforcing a consistent mechanism for configuration access.
+• scattered literal strings making refactoring and discovery difficult,
+• lack of compile-time checking for correct key names,
+• no guarantee about the type of the value retrieved (string, number, boolean, etc),
+• difficulty enforcing a consistent mechanism for configuration access.
 
 To address these, we introduce a **typed config-key abstraction**:
-  – each config key is defined once (via createConfigKey),
-  – the `IConfigKey<TType>` carries at compile time the expected type of its value,
-  – the runtime shape remains minimal (just a `key: string`),
-  – developers are encouraged to use a central `ConfigService` to fetch values,
-    rather than scattering `process.env[...]` everywhere.
+– each config key is defined once (via createConfigKey),
+– the `IConfigKey<TType>` carries at compile time the expected type of its value,
+– the runtime shape remains minimal (just a `key: string`),
+– developers are encouraged to use a central `ConfigService` to fetch values,
+rather than scattering `process.env[...]` everywhere.
 
 This improves:
-  – discoverability (IDE autocomplete, “find usages” works),
-  – safety (correct key names, correct value types),
-  – maintainability (single source of truth for config keys),
-  – clarity (developers see intent: “this key returns a number”, “this key returns a boolean”).
+– discoverability (IDE autocomplete, “find usages” works),
+– safety (correct key names, correct value types),
+– maintainability (single source of truth for config keys),
+– clarity (developers see intent: “this key returns a number”, “this key returns a boolean”).
 
 ## Type Parameters
 
 | Type Parameter | Default type |
-| ------ | ------ |
-| `TType` | `unknown` |
+| -------------- | ------------ |
+| `TType`        | `unknown`    |
 
 ## Properties
 
@@ -49,7 +50,7 @@ Defined in: [config/ConfigKey.ts:33](https://github.com/RueDeRennes/archipel/blo
 Phantom generic to encode the expected value type. This property
 is never intended to be used at runtime.
 
-***
+---
 
 ### key
 

package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md

@@ -3,6 +3,7 @@ title: 'Interface: IConfigModuleOptions'
 generated: true
 editUrl: false
 ---
+
 # Interface: IConfigModuleOptions
 
 Defined in: [config/ConfigModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L15)
@@ -19,7 +20,7 @@ optional statics?: Record<string, string>;
 
 Defined in: [config/ConfigModule.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L17)
 
-***
+---
 
 ### strategyFactory?
 
@@ -31,8 +32,8 @@ Defined in: [config/ConfigModule.ts:16](https://github.com/RueDeRennes/archipel/
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter | Type    |
+| --------- | ------- |
 | ...`args` | `any`[] |
 
 #### Returns

package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md

@@ -3,6 +3,7 @@ title: 'Interface: IConfigRegistryEntry\<TType\>'
 generated: true
 editUrl: false
 ---
+
 # Interface: IConfigRegistryEntry\<TType\>
 
 Defined in: [config/ConfigRegistry.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L13)
@@ -13,8 +14,8 @@ whether the entry is required or optional (with a default value).
 ## Type Parameters
 
 | Type Parameter | Default type |
-| ------ | ------ |
-| `TType` | `unknown` |
+| -------------- | ------------ |
+| `TType`        | `unknown`    |
 
 ## Properties
 
@@ -29,7 +30,7 @@ Defined in: [config/ConfigRegistry.ts:34](https://github.com/RueDeRennes/archipe
 An optional default value used when the key is not set.
 Only meaningful when `required` is `false`.
 
-***
+---
 
 ### description?
 
@@ -41,7 +42,7 @@ Defined in: [config/ConfigRegistry.ts:39](https://github.com/RueDeRennes/archipe
 
 An optional human-readable description of the configuration entry.
 
-***
+---
 
 ### key
 
@@ -53,7 +54,7 @@ Defined in: [config/ConfigRegistry.ts:17](https://github.com/RueDeRennes/archipe
 
 The typed configuration key.
 
-***
+---
 
 ### module
 
@@ -65,7 +66,7 @@ Defined in: [config/ConfigRegistry.ts:22](https://github.com/RueDeRennes/archipe
 
 The name of the module that registered this key (e.g. `'platform-authentication'`).
 
-***
+---
 
 ### required
 

package/data/packages/platform-core/api/Interface.IDeviceInfo.md

@@ -3,6 +3,7 @@ title: 'Interface: IDeviceInfo'
 generated: true
 editUrl: false
 ---
+
 # Interface: IDeviceInfo
 
 Defined in: [services/DeviceParserService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L13)
@@ -19,7 +20,7 @@ browserName: string;
 
 Defined in: [services/DeviceParserService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L17)
 
-***
+---
 
 ### browserVersion
 
@@ -29,7 +30,7 @@ browserVersion: string | null;
 
 Defined in: [services/DeviceParserService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L18)
 
-***
+---
 
 ### deviceName
 
@@ -39,7 +40,7 @@ deviceName: string;
 
 Defined in: [services/DeviceParserService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L16)
 
-***
+---
 
 ### deviceType
 
@@ -49,7 +50,7 @@ deviceType: string;
 
 Defined in: [services/DeviceParserService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L15)
 
-***
+---
 
 ### osName
 
@@ -59,7 +60,7 @@ osName: string;
 
 Defined in: [services/DeviceParserService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L19)
 
-***
+---
 
 ### osVersion
 
@@ -69,7 +70,7 @@ osVersion: string | null;
 
 Defined in: [services/DeviceParserService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L20)
 
-***
+---
 
 ### userAgent