@breadstone/archipel-mcp 0.0.9 → 0.0.10

package/data/packages/platform-core/api/index.md

@@ -3,140 +3,140 @@ title: '@breadstone/archipel-platform-core'
 generated: true
 editUrl: false
 ---
-
 # @breadstone/archipel-platform-core
 
 ## Namespaces
 
-| Namespace                                | Description                                 |
-| ---------------------------------------- | ------------------------------------------- |
+| Namespace | Description |
+| ------ | ------ |
 | [ISseEventData](Namespace.ISseEventData) | Represents the data of a Server-Sent Event. |
 
 ## Classes
 
-| Class                                                                | Description                                                                                                                                                                                                          |
-| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [AppHealthIndicator](Class.AppHealthIndicator)                       | Health indicator for the application.                                                                                                                                                                                |
-| [BlobResourceStrategy](Class.BlobResourceStrategy)                   | Strategy for loading resources from blob storage.                                                                                                                                                                    |
-| [BooleanUtils](Class.BooleanUtils)                                   | Boolean Utility Class. This class provides static methods to parse and format boolean values.                                                                                                                        |
-| [CasingInterceptor](Class.CasingInterceptor)                         | This interceptor is responsible for converting snake_case or other casing styles in the request body to camelCase before passing them to controllers. It also handles the transformation of the response if needed.  |
-| [CatchUtils](Class.CatchUtils)                                       | -                                                                                                                                                                                                                    |
-| [ConfigModule](Class.ConfigModule)                                   | The `ConfigModule` class.                                                                                                                                                                                            |
-| [ConfigRegistry](Class.ConfigRegistry)                               | A static, global registry that collects all configuration keys registered by platform libraries. This enables a central overview of every environment variable the application depends on, grouped by source module. |
-| [ConfigService](Class.ConfigService)                                 | -                                                                                                                                                                                                                    |
-| [ConfigStrategyBase](Class.ConfigStrategyBase)                       | The `ConfigStrategyBase` class. Represents the base class for configuration strategies.                                                                                                                              |
-| [ContentTemplateEngine](Class.ContentTemplateEngine)                 | The `ContentTemplateEngine` class.                                                                                                                                                                                   |
-| [CUIDGenerator](Class.CUIDGenerator)                                 | CUID Generator class                                                                                                                                                                                                 |
-| [DateTimeUtils](Class.DateTimeUtils)                                 | TimeSpan Utility Class. Provides methods to parse and format time span values.                                                                                                                                       |
-| [DeviceParserService](Class.DeviceParserService)                     | The `DeviceParserService` class.                                                                                                                                                                                     |
-| [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy)           | Strategy for loading embedded resources from memory.                                                                                                                                                                 |
-| [EnvironmentConfigStrategy](Class.EnvironmentConfigStrategy)         | The `EnvironmentConfigStrategy` class.                                                                                                                                                                               |
-| [ErrorTemplateService](Class.ErrorTemplateService)                   | Service for rendering error page templates.                                                                                                                                                                          |
-| [EventHub](Class.EventHub)                                           | Provides a strongly typed event hub that can publish and subscribe to events.                                                                                                                                        |
-| [EventModule](Class.EventModule)                                     | Module that provides event hub services.                                                                                                                                                                             |
-| [FileConfigStrategy](Class.FileConfigStrategy)                       | The `FileConfigStrategy` class.                                                                                                                                                                                      |
-| [FileResourceStrategy](Class.FileResourceStrategy)                   | Strategy for loading resources from the local file system.                                                                                                                                                           |
-| [GlobalExceptionFilter](Class.GlobalExceptionFilter)                 | A global exception filter that handles all uncaught exceptions in the application. Returns HTML error pages for browser requests and JSON for API requests.                                                          |
-| [GUIDGenerator](Class.GUIDGenerator)                                 | GUID Generator class                                                                                                                                                                                                 |
-| [HealthModule](Class.HealthModule)                                   | -                                                                                                                                                                                                                    |
-| [HealthOrchestrator](Class.HealthOrchestrator)                       | Orchestrates execution of all registered health indicators and aggregates their results.                                                                                                                             |
-| [HostModule](Class.HostModule)                                       | The `HostModule` provides host-related services globally.                                                                                                                                                            |
-| [HostService](Class.HostService)                                     | The `HostService` class.                                                                                                                                                                                             |
-| [HttpLoggerMiddleware](Class.HttpLoggerMiddleware)                   | -                                                                                                                                                                                                                    |
-| [IdentifierModule](Class.IdentifierModule)                           | -                                                                                                                                                                                                                    |
-| [IdGeneratorBase](Class.IdGeneratorBase)                             | Abstract base class for ID Generators                                                                                                                                                                                |
-| [LimitRequestSizeMiddleware](Class.LimitRequestSizeMiddleware)       | -                                                                                                                                                                                                                    |
-| [LocalizedTextRequest](Class.LocalizedTextRequest)                   | Request DTO for a single localized text entry.                                                                                                                                                                       |
-| [LocalizedTextResponse](Class.LocalizedTextResponse)                 | Base class for localized text responses.                                                                                                                                                                             |
-| [MappingBuilder](Class.MappingBuilder)                               | A mapping builder that uses the mapping service to register maps.                                                                                                                                                    |
-| [MappingModule](Class.MappingModule)                                 | Module that provides mapping services and allows registration of mapping profiles.                                                                                                                                   |
-| [MappingNotRegisteredError](Class.MappingNotRegisteredError)         | Thrown when a keyed mapping is requested but not registered.                                                                                                                                                         |
-| [MappingProfileBase](Class.MappingProfileBase)                       | Base class for mapping profiles to simplify implementation.                                                                                                                                                          |
-| [MappingService](Class.MappingService)                               | Central mapping registry supporting keyed & type-based mappings.                                                                                                                                                     |
-| [NormalizedUtils](Class.NormalizedUtils)                             | Utility functions for normalizing data.                                                                                                                                                                              |
-| [PageableRequest](Class.PageableRequest)                             | Base class describing pagination query parameters shared across endpoints.                                                                                                                                           |
-| [PageableResponse](Class.PageableResponse)                           | Base class describing pagination metadata returned alongside list payloads.                                                                                                                                          |
-| [ProblemDetailException](Class.ProblemDetailException)               | A NestJS HttpException that represents a Problem Detail as per RFC 7807.                                                                                                                                             |
-| [ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter)   | A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807.                                                                                                       |
-| [QuantityResponse](Class.QuantityResponse)                           | Base class for quantity responses.                                                                                                                                                                                   |
-| [ResourceManager](Class.ResourceManager)                             | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching.                                                                                        |
-| [ResourceModule](Class.ResourceModule)                               | Module providing the ResourceManager.                                                                                                                                                                                |
-| [ResponseReturn](Class.ResponseReturn)                               | -                                                                                                                                                                                                                    |
-| [SseHub](Class.SseHub)                                               | Represents a server-sent event service.                                                                                                                                                                              |
-| [SseModule](Class.SseModule)                                         | Represents the `SseModule` class.                                                                                                                                                                                    |
-| [TimeStampResponse](Class.TimeStampResponse)                         | The base class for all time stamp responses.                                                                                                                                                                         |
-| [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered.                                                                                                                                                          |
-| [UserAvatarGeneratorService](Class.UserAvatarGeneratorService)       | Service for generating GitHub-style identicon avatars.                                                                                                                                                               |
-| [UserNameGeneratorService](Class.UserNameGeneratorService)           | Random user name generator class                                                                                                                                                                                     |
-| [UUIDGenerator](Class.UUIDGenerator)                                 | UUID Generator class                                                                                                                                                                                                 |
+| Class | Description |
+| ------ | ------ |
+| [AppHealthIndicator](Class.AppHealthIndicator) | Health indicator for the application. |
+| [BlobResourceStrategy](Class.BlobResourceStrategy) | Strategy for loading resources from blob storage. |
+| [BooleanUtils](Class.BooleanUtils) | Boolean Utility Class. This class provides static methods to parse and format boolean values. |
+| [CasingInterceptor](Class.CasingInterceptor) | This interceptor is responsible for converting snake_case or other casing styles in the request body to camelCase before passing them to controllers. It also handles the transformation of the response if needed. |
+| [CatchUtils](Class.CatchUtils) | - |
+| [ConfigKeyNotFoundError](Class.ConfigKeyNotFoundError) | Error thrown when a configuration key cannot be resolved. |
+| [ConfigModule](Class.ConfigModule) | The `ConfigModule` class. |
+| [ConfigRegistry](Class.ConfigRegistry) | A static, global registry that collects all configuration keys registered by platform libraries. This enables a central overview of every environment variable the application depends on, grouped by source module. |
+| [ConfigService](Class.ConfigService) | - |
+| [ConfigStrategyBase](Class.ConfigStrategyBase) | The `ConfigStrategyBase` class. Represents the base class for configuration strategies. |
+| [ContentTemplateEngine](Class.ContentTemplateEngine) | The `ContentTemplateEngine` class. |
+| [CUIDGenerator](Class.CUIDGenerator) | CUID Generator class |
+| [DateTimeUtils](Class.DateTimeUtils) | TimeSpan Utility Class. Provides methods to parse and format time span values. |
+| [DeviceParserService](Class.DeviceParserService) | The `DeviceParserService` class. |
+| [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy) | Strategy for loading embedded resources from memory. |
+| [EnvironmentConfigStrategy](Class.EnvironmentConfigStrategy) | The `EnvironmentConfigStrategy` class. |
+| [ErrorTemplateService](Class.ErrorTemplateService) | Service for rendering error page templates. |
+| [EventHub](Class.EventHub) | Provides a strongly typed event hub that can publish and subscribe to events. |
+| [EventModule](Class.EventModule) | Module that provides event hub services. |
+| [FileConfigStrategy](Class.FileConfigStrategy) | The `FileConfigStrategy` class. |
+| [FileResourceStrategy](Class.FileResourceStrategy) | Strategy for loading resources from the local file system. |
+| [GlobalExceptionFilter](Class.GlobalExceptionFilter) | A global exception filter that handles all uncaught exceptions in the application. Returns HTML error pages for browser requests and JSON for API requests. |
+| [GUIDGenerator](Class.GUIDGenerator) | GUID Generator class |
+| [HealthModule](Class.HealthModule) | - |
+| [HealthOrchestrator](Class.HealthOrchestrator) | Orchestrates execution of all registered health indicators and aggregates their results. |
+| [HostModule](Class.HostModule) | The `HostModule` provides host-related services globally. |
+| [HostService](Class.HostService) | The `HostService` class. |
+| [HttpLoggerMiddleware](Class.HttpLoggerMiddleware) | - |
+| [IdentifierModule](Class.IdentifierModule) | - |
+| [IdGeneratorBase](Class.IdGeneratorBase) | Abstract base class for ID Generators |
+| [LimitRequestSizeMiddleware](Class.LimitRequestSizeMiddleware) | - |
+| [LocalizedTextRequest](Class.LocalizedTextRequest) | Request DTO for a single localized text entry. |
+| [LocalizedTextResponse](Class.LocalizedTextResponse) | Base class for localized text responses. |
+| [MappingBuilder](Class.MappingBuilder) | A mapping builder that uses the mapping service to register maps. |
+| [MappingModule](Class.MappingModule) | Module that provides mapping services and allows registration of mapping profiles. |
+| [MappingNotRegisteredError](Class.MappingNotRegisteredError) | Thrown when a keyed mapping is requested but not registered. |
+| [MappingProfileBase](Class.MappingProfileBase) | Base class for mapping profiles to simplify implementation. |
+| [MappingService](Class.MappingService) | Central mapping registry supporting keyed & type-based mappings. |
+| [NormalizedUtils](Class.NormalizedUtils) | Utility functions for normalizing data. |
+| [PageableRequest](Class.PageableRequest) | Base class describing pagination query parameters shared across endpoints. |
+| [PageableResponse](Class.PageableResponse) | Base class describing pagination metadata returned alongside list payloads. |
+| [ProblemDetailException](Class.ProblemDetailException) | A NestJS HttpException that represents a Problem Detail as per RFC 7807. |
+| [ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter) | A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807. |
+| [QuantityResponse](Class.QuantityResponse) | Base class for quantity responses. |
+| [ResourceManager](Class.ResourceManager) | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching. |
+| [ResourceModule](Class.ResourceModule) | Module providing the ResourceManager. |
+| [ResponseReturn](Class.ResponseReturn) | - |
+| [SseHub](Class.SseHub) | Represents a server-sent event service. |
+| [SseModule](Class.SseModule) | Represents the `SseModule` class. |
+| [TimeStampResponse](Class.TimeStampResponse) | The base class for all time stamp responses. |
+| [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered. |
+| [UserAvatarGeneratorService](Class.UserAvatarGeneratorService) | Service for generating GitHub-style identicon avatars. |
+| [UserNameGeneratorService](Class.UserNameGeneratorService) | Random user name generator class |
+| [UUIDGenerator](Class.UUIDGenerator) | UUID Generator class |
 
 ## Interfaces
 
-| Interface                                                            | Description                                                                                                                                   |
-| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy.                                                                                                 |
-| [IBlobServiceAdapter](Interface.IBlobServiceAdapter)                 | Minimal blob service interface to avoid circular dependencies.                                                                                |
-| [IConfigKey](Interface.IConfigKey)                                   | A type-safe config key that encodes both the config key and the type of its value.                                                            |
-| [IConfigModuleOptions](Interface.IConfigModuleOptions)               | The `IConfigModuleOptions` interface.                                                                                                         |
-| [IConfigRegistryEntry](Interface.IConfigRegistryEntry)               | Describes a registered configuration entry, including its source module and whether the entry is required or optional (with a default value). |
-| [IDeviceInfo](Interface.IDeviceInfo)                                 | Interface for parsed device information                                                                                                       |
-| [IErrorPageParams](Interface.IErrorPageParams)                       | Parameters for generating error page content.                                                                                                 |
-| [IEventKey](Interface.IEventKey)                                     | Represents a strongly typed event key that encodes the payload type.                                                                          |
-| [IEventMap](Interface.IEventMap)                                     | Represents the shape of the event map used by the [EventHub](Class.EventHub).                                                                 |
-| [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy.                                                                                                 |
-| [IHealthCheckResult](Interface.IHealthCheckResult)                   | Represents the result of a health check indicator.                                                                                            |
-| [IHealthIndicator](Interface.IHealthIndicator)                       | Defines the contract for a health indicator that can be orchestrated.                                                                         |
-| [IHostContentParams](Interface.IHostContentParams)                   | Parameters for generating host content.                                                                                                       |
-| [IIdGenerator](Interface.IIdGenerator)                               | Interface for ID generators                                                                                                                   |
-| [IMappingBuilder](Interface.IMappingBuilder)                         | Defines the interface for a mapping builder.                                                                                                  |
-| [IMappingKey](Interface.IMappingKey)                                 | Type-safe mapping key that encodes both input and output types. This ensures compile-time type safety when using the mapping service.         |
-| [IMappingProfile](Interface.IMappingProfile)                         | Defines the interface for a mapping profile.                                                                                                  |
-| [IResourceManagerConfig](Interface.IResourceManagerConfig)           | Configuration for the ResourceManager.                                                                                                        |
-| [IResourceMetadata](Interface.IResourceMetadata)                     | Metadata about a resource.                                                                                                                    |
-| [IResourceResult](Interface.IResourceResult)                         | Result of loading a resource.                                                                                                                 |
-| [IResourceStrategy](Interface.IResourceStrategy)                     | Strategy for loading resources from a specific source.                                                                                        |
-| [ISseEventData](Interface.ISseEventData)                             | Represents the data of a Server-Sent Event.                                                                                                   |
-| [ISseHub](Interface.ISseHub)                                         | Represents a server-sent event service.                                                                                                       |
+| Interface | Description |
+| ------ | ------ |
+| [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy. |
+| [IBlobServiceAdapter](Interface.IBlobServiceAdapter) | Minimal blob service interface to avoid circular dependencies. |
+| [IConfigKey](Interface.IConfigKey) | A type-safe config key that encodes both the config key and the type of its value. |
+| [IConfigModuleOptions](Interface.IConfigModuleOptions) | The `IConfigModuleOptions` interface. |
+| [IConfigRegistryEntry](Interface.IConfigRegistryEntry) | Describes a registered configuration entry, including its source module and whether the entry is required or optional (with a default value). |
+| [IDeviceInfo](Interface.IDeviceInfo) | Interface for parsed device information |
+| [IErrorPageParams](Interface.IErrorPageParams) | Parameters for generating error page content. |
+| [IEventKey](Interface.IEventKey) | Represents a strongly typed event key that encodes the payload type. |
+| [IEventMap](Interface.IEventMap) | Represents the shape of the event map used by the [EventHub](Class.EventHub). |
+| [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy. |
+| [IHealthCheckResult](Interface.IHealthCheckResult) | Represents the result of a health check indicator. |
+| [IHealthIndicator](Interface.IHealthIndicator) | Defines the contract for a health indicator that can be orchestrated. |
+| [IHostContentParams](Interface.IHostContentParams) | Parameters for generating host content. |
+| [IIdGenerator](Interface.IIdGenerator) | Interface for ID generators |
+| [IMappingBuilder](Interface.IMappingBuilder) | Defines the interface for a mapping builder. |
+| [IMappingKey](Interface.IMappingKey) | Type-safe mapping key that encodes both input and output types. This ensures compile-time type safety when using the mapping service. |
+| [IMappingProfile](Interface.IMappingProfile) | Defines the interface for a mapping profile. |
+| [IResourceManagerConfig](Interface.IResourceManagerConfig) | Configuration for the ResourceManager. |
+| [IResourceMetadata](Interface.IResourceMetadata) | Metadata about a resource. |
+| [IResourceResult](Interface.IResourceResult) | Result of loading a resource. |
+| [IResourceStrategy](Interface.IResourceStrategy) | Strategy for loading resources from a specific source. |
+| [ISseEventData](Interface.ISseEventData) | Represents the data of a Server-Sent Event. |
+| [ISseHub](Interface.ISseHub) | Represents a server-sent event service. |
 
 ## Type Aliases
 
-| Type Alias                                                             | Description                                                                 |
-| ---------------------------------------------------------------------- | --------------------------------------------------------------------------- |
-| [CamelCase](TypeAlias.CamelCase)                                       | -                                                                           |
-| [ProblemDetail](TypeAlias.ProblemDetail)                               | A Problem Detail object as per RFC 7807.                                    |
+| Type Alias | Description |
+| ------ | ------ |
+| [CamelCase](TypeAlias.CamelCase) | - |
+| [ProblemDetail](TypeAlias.ProblemDetail) | A Problem Detail object as per RFC 7807. |
 | [ProblemDetailTypeUrlResolver](TypeAlias.ProblemDetailTypeUrlResolver) | A function that resolves a type URL for a given HTTP status code and title. |
-| [SetOptional](TypeAlias.SetOptional)                                   | Sets the specified keys of T as optional.                                   |
-| [StringValue](TypeAlias.StringValue)                                   | -                                                                           |
+| [SetOptional](TypeAlias.SetOptional) | Sets the specified keys of T as optional. |
+| [StringValue](TypeAlias.StringValue) | - |
 
 ## Variables
 
-| Variable                                                                  | Description                                                                                                                                   |
-| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| [APP_NAME](Variable.APP_NAME)                                             | Human-readable name of the application.                                                                                                       |
-| [APP_PORT](Variable.APP_PORT)                                             | HTTP port the application listens on.                                                                                                         |
-| [APP_URL](Variable.APP_URL)                                               | Base URL the application is served from (e.g. `https://example.com`).                                                                         |
-| [APP_VERSION](Variable.APP_VERSION)                                       | Semantic version of the running application (e.g. `1.2.3`).                                                                                   |
-| [GIT_COMMIT](Variable.GIT_COMMIT)                                         | Git commit SHA of the current build.                                                                                                          |
-| [HEALTH_INDICATORS_TOKEN](Variable.HEALTH_INDICATORS_TOKEN)               | Injection token for registered health indicators                                                                                              |
-| [ID_GENERATOR_TOKEN](Variable.ID_GENERATOR_TOKEN)                         | Interface for ID generators                                                                                                                   |
-| [INTELLIGENCE_MAX_OUTPUT_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model.                                                                                             |
-| [INTELLIGENCE_MODEL](Variable.INTELLIGENCE_MODEL)                         | AI model identifier to use for text generation.                                                                                               |
-| [INTELLIGENCE_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE)             | Sampling temperature for the AI model.                                                                                                        |
-| [INTELLIGENCE_TOP_P](Variable.INTELLIGENCE_TOP_P)                         | Top-p (nucleus sampling) for the AI model.                                                                                                    |
-| [IpAddress](Variable.IpAddress)                                           | Extracts the client IP address from the current HTTP request. Handles IPv6 (::1), proxy headers (X-Forwarded-For), and normalizes the output. |
-| [IS_PUBLIC_KEY](Variable.IS_PUBLIC_KEY)                                   | -                                                                                                                                             |
-| [Lang](Variable.Lang)                                                     | Extracts the first language token from the Accept-Language header.                                                                            |
-| [NODE_ENV](Variable.NODE_ENV)                                             | The current Node.js environment (`development`, `production`, etc.).                                                                          |
-| [PLATFORM_CORE_CONFIG_ENTRIES](Variable.PLATFORM_CORE_CONFIG_ENTRIES)     | All configuration entries required by `platform-core`.                                                                                        |
-| [UserAgent](Variable.UserAgent)                                           | Extracts the User-Agent header from the incoming HTTP request.                                                                                |
+| Variable | Description |
+| ------ | ------ |
+| [APP\_NAME](Variable.APP_NAME) | Human-readable name of the application. |
+| [APP\_PORT](Variable.APP_PORT) | HTTP port the application listens on. |
+| [APP\_URL](Variable.APP_URL) | Base URL the application is served from (e.g. `https://example.com`). |
+| [APP\_VERSION](Variable.APP_VERSION) | Semantic version of the running application (e.g. `1.2.3`). |
+| [GIT\_COMMIT](Variable.GIT_COMMIT) | Git commit SHA of the current build. |
+| [HEALTH\_INDICATORS\_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |
+| [ID\_GENERATOR\_TOKEN](Variable.ID_GENERATOR_TOKEN) | Interface for ID generators |
+| [INTELLIGENCE\_MAX\_OUTPUT\_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
+| [INTELLIGENCE\_MODEL](Variable.INTELLIGENCE_MODEL) | AI model identifier to use for text generation. |
+| [INTELLIGENCE\_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
+| [INTELLIGENCE\_TOP\_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
+| [IpAddress](Variable.IpAddress) | Extracts the client IP address from the current HTTP request. Handles IPv6 (::1), proxy headers (X-Forwarded-For), and normalizes the output. |
+| [IS\_PUBLIC\_KEY](Variable.IS_PUBLIC_KEY) | - |
+| [Lang](Variable.Lang) | Extracts the first language token from the Accept-Language header. |
+| [NODE\_ENV](Variable.NODE_ENV) | The current Node.js environment (`development`, `production`, etc.). |
+| [PLATFORM\_CORE\_CONFIG\_ENTRIES](Variable.PLATFORM_CORE_CONFIG_ENTRIES) | All configuration entries required by `platform-core`. |
+| [UserAgent](Variable.UserAgent) | Extracts the User-Agent header from the incoming HTTP request. |
 
 ## Functions
 
-| Function                                                                      | Description                                                     |
-| ----------------------------------------------------------------------------- | --------------------------------------------------------------- |
-| [createConfigKey](Function.createConfigKey)                                   | Creates a type-safe config key.                                 |
-| [createEventKey](Function.createEventKey)                                     | Creates a branded event key for the [EventHub](Class.EventHub). |
-| [createMappingKey](Function.createMappingKey)                                 | Creates a type-safe mapping key.                                |
-| [env](Function.env)                                                           | Marker function for environment strings.                        |
-| [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension.                        |
-| [Public](Function.Public)                                                     | The `Public` decorator.                                         |
+| Function | Description |
+| ------ | ------ |
+| [createConfigKey](Function.createConfigKey) | Creates a type-safe config key. |
+| [createEventKey](Function.createEventKey) | Creates a branded event key for the [EventHub](Class.EventHub). |
+| [createMappingKey](Function.createMappingKey) | Creates a type-safe mapping key. |
+| [env](Function.env) | Marker function for environment strings. |
+| [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension. |
+| [Public](Function.Public) | The `Public` decorator. |

package/data/packages/platform-cryptography/api/Class.BcryptService.md

@@ -3,7 +3,6 @@ title: 'Class: BcryptService'
 generated: true
 editUrl: false
 ---
-
 # Class: BcryptService
 
 Defined in: [BcryptService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L15)
@@ -37,9 +36,9 @@ Compares the given data with the encrypted data.
 
 #### Parameters
 
-| Parameter   | Type     | Description                        |
-| ----------- | -------- | ---------------------------------- |
-| `data`      | `string` | The data to be compared.           |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `string` | The data to be compared. |
 | `encrypted` | `string` | The encrypted data to be compared. |
 
 #### Returns
@@ -48,7 +47,7 @@ Compares the given data with the encrypted data.
 
 `true` if the data matches the encrypted hash; otherwise `false`.
 
----
+***
 
 ### hash()
 
@@ -62,9 +61,9 @@ Hashes the given data using bcrypt with a generated salt.
 
 #### Parameters
 
-| Parameter | Type     | Description            |
-| --------- | -------- | ---------------------- |
-| `data`    | `string` | The data to be hashed. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `string` | The data to be hashed. |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Class: CryptoService'
 generated: true
 editUrl: false
 ---
-
 # Class: CryptoService
 
 Defined in: [CryptoService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L15)
@@ -41,9 +40,9 @@ Generates a random GUID prefixed with the given string.
 
 #### Parameters
 
-| Parameter | Type     | Description                                  |
-| --------- | -------- | -------------------------------------------- |
-| `prefix`  | `string` | The prefix to prepend to the generated UUID. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `prefix` | `string` | The prefix to prepend to the generated UUID. |
 
 #### Returns
 

package/data/packages/platform-cryptography/api/Class.OtpService.md

@@ -3,7 +3,6 @@ title: 'Class: OtpService'
 generated: true
 editUrl: false
 ---
-
 # Class: OtpService
 
 Defined in: [otp/OtpService.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L42)
@@ -52,7 +51,7 @@ The generated secret string.
 
 [`IOtpService`](Interface.IOtpService).[`generateSecret`](Interface.IOtpService#generatesecret)
 
----
+***
 
 ### generateUri()
 
@@ -66,8 +65,8 @@ Generates an `otpauth://` URI for QR code enrollment.
 
 #### Parameters
 
-| Parameter | Type                                         | Description                 |
-| --------- | -------------------------------------------- | --------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IOtpUriOptions`](Interface.IOtpUriOptions) | The URI generation options. |
 
 #### Returns
@@ -80,7 +79,7 @@ The formatted `otpauth://` URI.
 
 [`IOtpService`](Interface.IOtpService).[`generateUri`](Interface.IOtpService#generateuri)
 
----
+***
 
 ### verify()
 
@@ -94,10 +93,10 @@ Verifies a TOTP token against the given secret.
 
 #### Parameters
 
-| Parameter | Type     | Description                      |
-| --------- | -------- | -------------------------------- |
-| `token`   | `string` | The one-time password to verify. |
-| `secret`  | `string` | The shared secret.               |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The one-time password to verify. |
+| `secret` | `string` | The shared secret. |
 
 #### Returns
 

package/data/packages/platform-cryptography/api/Interface.IOtpService.md

@@ -3,7 +3,6 @@ title: 'Interface: IOtpService'
 generated: true
 editUrl: false
 ---
-
 # Interface: IOtpService
 
 Defined in: [otp/IOtpService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L38)
@@ -32,7 +31,7 @@ Generates a cryptographically random secret suitable for TOTP.
 
 The generated secret string.
 
----
+***
 
 ### generateUri()
 
@@ -46,8 +45,8 @@ Generates an `otpauth://` URI for QR code enrollment.
 
 #### Parameters
 
-| Parameter | Type                                         | Description                 |
-| --------- | -------------------------------------------- | --------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IOtpUriOptions`](Interface.IOtpUriOptions) | The URI generation options. |
 
 #### Returns
@@ -56,7 +55,7 @@ Generates an `otpauth://` URI for QR code enrollment.
 
 The formatted `otpauth://` URI.
 
----
+***
 
 ### verify()
 
@@ -70,10 +69,10 @@ Verifies a TOTP token against the given secret.
 
 #### Parameters
 
-| Parameter | Type     | Description                      |
-| --------- | -------- | -------------------------------- |
-| `token`   | `string` | The one-time password to verify. |
-| `secret`  | `string` | The shared secret.               |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The one-time password to verify. |
+| `secret` | `string` | The shared secret. |
 
 #### Returns
 

package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md

@@ -3,7 +3,6 @@ title: 'Interface: IOtpUriOptions'
 generated: true
 editUrl: false
 ---
-
 # Interface: IOtpUriOptions
 
 Defined in: [otp/IOtpService.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L6)
@@ -22,7 +21,7 @@ Defined in: [otp/IOtpService.ts:12](https://github.com/RueDeRennes/archipel/blob
 
 The issuer name displayed in the authenticator app.
 
----
+***
 
 ### label
 
@@ -34,7 +33,7 @@ Defined in: [otp/IOtpService.ts:19](https://github.com/RueDeRennes/archipel/blob
 
 The account label (e.g. email or username) shown in the authenticator app.
 
----
+***
 
 ### secret
 

package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md

@@ -3,8 +3,7 @@ title: 'Variable: OTP\_SERVICE\_TOKEN'
 generated: true
 editUrl: false
 ---
-
-# Variable: OTP_SERVICE_TOKEN
+# Variable: OTP\_SERVICE\_TOKEN
 
 ```ts
 const OTP_SERVICE_TOKEN: typeof OTP_SERVICE_TOKEN;

package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md

@@ -3,8 +3,7 @@ title: 'Variable: TOTP\_EPOCH\_TOLERANCE'
 generated: true
 editUrl: false
 ---
-
-# Variable: TOTP_EPOCH_TOLERANCE
+# Variable: TOTP\_EPOCH\_TOLERANCE
 
 ```ts
 const TOTP_EPOCH_TOLERANCE: 30 = 30;
@@ -16,9 +15,9 @@ TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance
 
 Each time step equals 30 seconds by default (RFC 6238).
 
-| `epochTolerance` | Accepted range    |
-| ---------------- | ----------------- |
-| 0                | current step only |
-| 30               | ±1 step (±30 s)   |
-| 60               | ±2 steps (±60 s)  |
-| 90               | ±3 steps (±90 s)  |
+| `epochTolerance` | Accepted range          |
+|------------------|-------------------------|
+| 0                | current step only       |
+| 30               | ±1 step (±30 s)         |
+| 60               | ±2 steps (±60 s)        |
+| 90               | ±3 steps (±90 s)        |

package/data/packages/platform-cryptography/api/index.md

@@ -3,27 +3,26 @@ title: '@breadstone/archipel-platform-cryptography'
 generated: true
 editUrl: false
 ---
-
 # @breadstone/archipel-platform-cryptography
 
 ## Classes
 
-| Class                                | Description                                                                               |
-| ------------------------------------ | ----------------------------------------------------------------------------------------- |
-| [BcryptService](Class.BcryptService) | The `BcryptService` class. Represents the service that provides bcrypt operations.        |
+| Class | Description |
+| ------ | ------ |
+| [BcryptService](Class.BcryptService) | The `BcryptService` class. Represents the service that provides bcrypt operations. |
 | [CryptoService](Class.CryptoService) | The `CryptoService` class. Represents the service that provides cryptographic operations. |
-| [OtpService](Class.OtpService)       | OTP service implementation backed by otplib v13.                                          |
+| [OtpService](Class.OtpService) | OTP service implementation backed by otplib v13. |
 
 ## Interfaces
 
-| Interface                                  | Description                                                    |
-| ------------------------------------------ | -------------------------------------------------------------- |
-| [IOtpService](Interface.IOtpService)       | Abstraction over OTP (One-Time Password) operations.           |
+| Interface | Description |
+| ------ | ------ |
+| [IOtpService](Interface.IOtpService) | Abstraction over OTP (One-Time Password) operations. |
 | [IOtpUriOptions](Interface.IOtpUriOptions) | Options for generating an OTP authentication URI (otpauth://). |
 
 ## Variables
 
-| Variable                                              | Description                                                                         |
-| ----------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| [OTP_SERVICE_TOKEN](Variable.OTP_SERVICE_TOKEN)       | Injection token for [IOtpService](Interface.IOtpService).                           |
-| [TOTP_EPOCH_TOLERANCE](Variable.TOTP_EPOCH_TOLERANCE) | TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`). |
+| Variable | Description |
+| ------ | ------ |
+| [OTP\_SERVICE\_TOKEN](Variable.OTP_SERVICE_TOKEN) | Injection token for [IOtpService](Interface.IOtpService). |
+| [TOTP\_EPOCH\_TOLERANCE](Variable.TOTP_EPOCH_TOLERANCE) | TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`). |

package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md

@@ -3,7 +3,6 @@ title: 'Class: DatabaseHealthIndicator'
 generated: true
 editUrl: false
 ---
-
 # Class: DatabaseHealthIndicator
 
 Defined in: [terminus/DatabaseHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L16)
@@ -26,10 +25,10 @@ Defined in: [terminus/DatabaseHealthIndicator.ts:26](https://github.com/RueDeRen
 
 #### Parameters
 
-| Parameter               | Type                                       |
-| ----------------------- | ------------------------------------------ |
-| `prismaHealthIndicator` | `PrismaHealthIndicator`                    |
-| `databaseService`       | [`DatabaseService`](Class.DatabaseService) |
+| Parameter | Type |
+| ------ | ------ |
+| `prismaHealthIndicator` | `PrismaHealthIndicator` |
+| `databaseService` | [`DatabaseService`](Class.DatabaseService) |
 
 #### Returns
 
@@ -50,7 +49,7 @@ Unique key identifying the indicator
 #### Implementation of
 
 ```ts
-IHealthIndicator.key;
+IHealthIndicator.key
 ```
 
 ## Methods
@@ -72,5 +71,5 @@ Performs the health check and returns a result keyed by the indicator key
 #### Implementation of
 
 ```ts
-IHealthIndicator.check;
+IHealthIndicator.check
 ```