@breadstone/archipel-mcp 0.0.1 → 0.0.2

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

@@ -3,643 +3,183 @@ 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.                                                                                                                                                                                |
-| [BcryptService](Class.BcryptService)                                             | The `BcryptService` class. Represents the service that provides bcrypt operations.                                                                                                                                   |
-| [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.                                                                                                                                                                                   |
-| [CryptoService](Class.CryptoService)                                             | The `CryptoService` class. Represents the service that provides cryptographic operations.                                                                                                                            |
-| [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                                                                                                                                                                                |
-| [IntelligenceCapabilityRegistrarBase](Class.IntelligenceCapabilityRegistrarBase) | Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private.                                 |
-| [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry)           | Central registry responsible for resolving intelligence capabilities based on intent metadata.                                                                                                                       |
-| [IntelligenceModule](Class.IntelligenceModule)                                   | Core module exposing the shared intelligence infrastructure to feature modules.                                                                                                                                      |
-| [IntelligenceTextGenerator](Class.IntelligenceTextGenerator)                     | Executes text completions using the configured intelligence provider.                                                                                                                                                |
-| [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.                                                                                                                                                     |
-| [MemoryLayeredCache](Class.MemoryLayeredCache)                                   | In-memory layered cache implementation.                                                                                                                                                                              |
-| [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder)                       | No-op implementation used when no metrics backend is configured.                                                                                                                                                     |
-| [NormalizedUtils](Class.NormalizedUtils)                                         | Utility functions for normalizing data.                                                                                                                                                                              |
-| [OtpService](Class.OtpService)                                                   | OTP service implementation backed by otplib v13.                                                                                                                                                                     |
-| [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.                                                                                                                                                                                   |
-| [RedisLayeredCache](Class.RedisLayeredCache)                                     | Generic layered cache contract (DB first, then memory, then external fetcher).                                                                                                                                       |
-| [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. |
+| [BcryptService](Class.BcryptService) | The `BcryptService` class. Represents the service that provides bcrypt operations. |
+| [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. |
+| [CryptoService](Class.CryptoService) | The `CryptoService` class. Represents the service that provides cryptographic operations. |
+| [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 |
+| [IntelligenceCapabilityRegistrarBase](Class.IntelligenceCapabilityRegistrarBase) | Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private. |
+| [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry) | Central registry responsible for resolving intelligence capabilities based on intent metadata. |
+| [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure to feature modules. |
+| [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
+| [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. |
+| [MemoryLayeredCache](Class.MemoryLayeredCache) | In-memory layered cache implementation. |
+| [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) | No-op implementation used when no metrics backend is configured. |
+| [NormalizedUtils](Class.NormalizedUtils) | Utility functions for normalizing data. |
+| [OtpService](Class.OtpService) | OTP service implementation backed by otplib v13. |
+| [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. |
+| [RedisLayeredCache](Class.RedisLayeredCache) | Generic layered cache contract (DB first, then memory, then external fetcher). |
+| [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.                                                                                                            |
-| [ICacheMetricsRecorder](Interface.ICacheMetricsRecorder)                                       | Metrics recorder for cache operations. Implementations can forward to Prometheus, OpenTelemetry, etc.                                                                     |
-| [ICacheStats](Interface.ICacheStats)                                                           | Cache statistics.                                                                                                                                                         |
-| [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                                                                                                                                               |
-| [IIntelligenceArtifact](Interface.IIntelligenceArtifact)                                       | Represents a structured artifact returned by a capability.                                                                                                                |
-| [IIntelligenceCapability](Interface.IIntelligenceCapability)                                   | Abstraction implemented by all capability providers.                                                                                                                      |
-| [IIntelligenceCapabilityMetadata](Interface.IIntelligenceCapabilityMetadata)                   | Metadata describing a capability for orchestration and analytics purposes.                                                                                                |
-| [IIntelligenceCapabilityPayload](Interface.IIntelligenceCapabilityPayload)                     | Payload forwarded to capabilities for execution.                                                                                                                          |
-| [IIntelligenceCapabilityRegistry](Interface.IIntelligenceCapabilityRegistry)                   | Registry abstraction responsible for resolving capabilities.                                                                                                              |
-| [IIntelligenceCapabilityResult](Interface.IIntelligenceCapabilityResult)                       | Represents the outcome produced by a capability execution.                                                                                                                |
-| [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage)                         | Captures usage telemetry returned by the intelligence provider.                                                                                                           |
-| [IIntelligenceContext](Interface.IIntelligenceContext)                                         | Describes the context aggregated before routing a request to a capability.                                                                                                |
-| [IIntelligenceContextBuilder](Interface.IIntelligenceContextBuilder)                           | Responsible for composing the context supplied to capabilities.                                                                                                           |
-| [IIntelligenceConversationMessageSnapshot](Interface.IIntelligenceConversationMessageSnapshot) | Represents a single message returned within a conversation snapshot.                                                                                                      |
-| [IIntelligenceConversationSnapshot](Interface.IIntelligenceConversationSnapshot)               | Represents a lightweight snapshot of a conversation used for context building.                                                                                            |
-| [IIntelligenceFollowUpQuestion](Interface.IIntelligenceFollowUpQuestion)                       | Represents a follow-up question suggested to keep the dialogue active.                                                                                                    |
-| [IIntelligenceIntent](Interface.IIntelligenceIntent)                                           | Represents the structured intent resolved from a user message.                                                                                                            |
-| [IIntelligenceIntentEntity](Interface.IIntelligenceIntentEntity)                               | Represents an entity extracted from a resolved intelligence intent.                                                                                                       |
-| [IIntelligenceMessageModel](Interface.IIntelligenceMessageModel)                               | Represents a normalized message stored in persistence.                                                                                                                    |
-| [IIntelligenceMessagePayload](Interface.IIntelligenceMessagePayload)                           | Carries the payload submitted when messaging the intelligence entrypoint.                                                                                                 |
-| [IIntelligencePrompt](Interface.IIntelligencePrompt)                                           | Represents the input supplied to the intelligence text generator.                                                                                                         |
-| [IIntelligencePromptMessage](Interface.IIntelligencePromptMessage)                             | Describes a normalized message used for text generation prompts.                                                                                                          |
-| [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration)             | Describes the resolved configuration for the intelligence provider.                                                                                                       |
-| [IIntelligenceResponseMessage](Interface.IIntelligenceResponseMessage)                         | Represents a single assistant message returned by a capability.                                                                                                           |
-| [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion)                           | Represents the normalized completion result produced by the intelligence provider.                                                                                        |
-| [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions)             | Options that can be supplied when generating text with the intelligence provider.                                                                                         |
-| [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator)                             | Abstraction responsible for executing text completions using the configured provider.                                                                                     |
-| [ILayeredCache](Interface.ILayeredCache)                                                       | Generic layered cache contract (DB first, then memory, then external fetcher).                                                                                            |
-| [ILayeredCacheOptions](Interface.ILayeredCacheOptions)                                         | In-memory layered cache: memory (LRU+TTL+SWR) + async loader fallback.                                                                                                    |
-| [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.                                                                                                                              |
-| [IOtpService](Interface.IOtpService)                                                           | Abstraction over OTP (One-Time Password) operations.                                                                                                                      |
-| [IOtpUriOptions](Interface.IOtpUriOptions)                                                     | Options for generating an OTP authentication URI (otpauth://).                                                                                                            |
-| [IRedisLayeredCacheOptions](Interface.IRedisLayeredCacheOptions)                               | Skeleton Redis-backed cache (placeholder; implement ioredis logic later). Provides same contract as in-memory layered cache; currently delegates to provided loader only. |
-| [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. |
+| [ICacheMetricsRecorder](Interface.ICacheMetricsRecorder) | Metrics recorder for cache operations. Implementations can forward to Prometheus, OpenTelemetry, etc. |
+| [ICacheStats](Interface.ICacheStats) | Cache statistics. |
+| [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 |
+| [IIntelligenceArtifact](Interface.IIntelligenceArtifact) | Represents a structured artifact returned by a capability. |
+| [IIntelligenceCapability](Interface.IIntelligenceCapability) | Abstraction implemented by all capability providers. |
+| [IIntelligenceCapabilityMetadata](Interface.IIntelligenceCapabilityMetadata) | Metadata describing a capability for orchestration and analytics purposes. |
+| [IIntelligenceCapabilityPayload](Interface.IIntelligenceCapabilityPayload) | Payload forwarded to capabilities for execution. |
+| [IIntelligenceCapabilityRegistry](Interface.IIntelligenceCapabilityRegistry) | Registry abstraction responsible for resolving capabilities. |
+| [IIntelligenceCapabilityResult](Interface.IIntelligenceCapabilityResult) | Represents the outcome produced by a capability execution. |
+| [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage) | Captures usage telemetry returned by the intelligence provider. |
+| [IIntelligenceContext](Interface.IIntelligenceContext) | Describes the context aggregated before routing a request to a capability. |
+| [IIntelligenceContextBuilder](Interface.IIntelligenceContextBuilder) | Responsible for composing the context supplied to capabilities. |
+| [IIntelligenceConversationMessageSnapshot](Interface.IIntelligenceConversationMessageSnapshot) | Represents a single message returned within a conversation snapshot. |
+| [IIntelligenceConversationSnapshot](Interface.IIntelligenceConversationSnapshot) | Represents a lightweight snapshot of a conversation used for context building. |
+| [IIntelligenceFollowUpQuestion](Interface.IIntelligenceFollowUpQuestion) | Represents a follow-up question suggested to keep the dialogue active. |
+| [IIntelligenceIntent](Interface.IIntelligenceIntent) | Represents the structured intent resolved from a user message. |
+| [IIntelligenceIntentEntity](Interface.IIntelligenceIntentEntity) | Represents an entity extracted from a resolved intelligence intent. |
+| [IIntelligenceMessageModel](Interface.IIntelligenceMessageModel) | Represents a normalized message stored in persistence. |
+| [IIntelligenceMessagePayload](Interface.IIntelligenceMessagePayload) | Carries the payload submitted when messaging the intelligence entrypoint. |
+| [IIntelligencePrompt](Interface.IIntelligencePrompt) | Represents the input supplied to the intelligence text generator. |
+| [IIntelligencePromptMessage](Interface.IIntelligencePromptMessage) | Describes a normalized message used for text generation prompts. |
+| [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
+| [IIntelligenceResponseMessage](Interface.IIntelligenceResponseMessage) | Represents a single assistant message returned by a capability. |
+| [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion) | Represents the normalized completion result produced by the intelligence provider. |
+| [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions) | Options that can be supplied when generating text with the intelligence provider. |
+| [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator) | Abstraction responsible for executing text completions using the configured provider. |
+| [ILayeredCache](Interface.ILayeredCache) | Generic layered cache contract (DB first, then memory, then external fetcher). |
+| [ILayeredCacheOptions](Interface.ILayeredCacheOptions) | In-memory layered cache: memory (LRU+TTL+SWR) + async loader fallback. |
+| [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. |
+| [IOtpService](Interface.IOtpService) | Abstraction over OTP (One-Time Password) operations. |
+| [IOtpUriOptions](Interface.IOtpUriOptions) | Options for generating an OTP authentication URI (otpauth://). |
+| [IRedisLayeredCacheOptions](Interface.IRedisLayeredCacheOptions) | Skeleton Redis-backed cache (placeholder; implement ioredis logic later). Provides same contract as in-memory layered cache; currently delegates to provided loader only. |
+| [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)                                                     | -                                                                           |
-| [IntelligenceConversationMessageRole](TypeAlias.IntelligenceConversationMessageRole) | Represents the union of supported conversation message roles.               |
-| [IntelligenceProviderName](TypeAlias.IntelligenceProviderName)                       | Represents the union of supported intelligence provider identifiers.        |
-| [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)                                                 | -                                                                           |
+| Type Alias | Description |
+| ------ | ------ |
+| [CamelCase](TypeAlias.CamelCase) | - |
+| [IntelligenceConversationMessageRole](TypeAlias.IntelligenceConversationMessageRole) | Represents the union of supported conversation message roles. |
+| [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
+| [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) | - |
 
 ## Variables
 
-### APP_PORT
-
-```ts
-const APP_PORT: IConfigKey<number>;
-```
-
-Defined in: [env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L16)
-
-HTTP port the application listens on.
-
----
-
-### APP_URL
-
-```ts
-const APP_URL: IConfigKey<string>;
-```
-
-Defined in: [env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L13)
-
-Base URL the application is served from (e.g. `https://example.com`).
-
----
-
-### APP_VERSION
-
-```ts
-const APP_VERSION: IConfigKey<string>;
-```
-
-Defined in: [env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L19)
-
-Semantic version of the running application (e.g. `1.2.3`).
-
----
-
-### HEALTH_INDICATORS_TOKEN
-
-```ts
-const HEALTH_INDICATORS_TOKEN: typeof HEALTH_INDICATORS_TOKEN;
-```
-
-Defined in: [health/HealthTokens.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthTokens.ts#L2)
-
-Injection token for registered health indicators
-
----
-
-### ID_GENERATOR_TOKEN
-
-```ts
-const ID_GENERATOR_TOKEN: typeof ID_GENERATOR_TOKEN;
-```
-
-Defined in: [identifiers/IdentifierTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierTokens.ts#L6)
-
-Interface for ID generators
-
----
-
-### INTELLIGENCE_MAX_OUTPUT_TOKENS
-
-```ts
-const INTELLIGENCE_MAX_OUTPUT_TOKENS: IConfigKey<number>;
-```
-
-Defined in: [env.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L38)
-
-Maximum number of output tokens for the AI model.
-
----
-
-### INTELLIGENCE_MODEL
-
-```ts
-const INTELLIGENCE_MODEL: IConfigKey<string>;
-```
-
-Defined in: [env.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L29)
-
-AI model identifier to use for text generation.
-
----
-
-### INTELLIGENCE_TEMPERATURE
-
-```ts
-const INTELLIGENCE_TEMPERATURE: IConfigKey<number>;
-```
-
-Defined in: [env.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L32)
-
-Sampling temperature for the AI model.
-
----
-
-### INTELLIGENCE_TOP_P
-
-```ts
-const INTELLIGENCE_TOP_P: IConfigKey<number>;
-```
-
-Defined in: [env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L35)
-
-Top-p (nucleus sampling) for the AI model.
-
----
-
-### IntelligenceConversationMessageRoles
-
-```ts
-const IntelligenceConversationMessageRoles: {
-  Assistant: 'assistant';
-  System: 'system';
-  User: 'user';
-};
-```
-
-Defined in: [intelligence/contracts/IntelligenceConversationMessageRoles.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L4)
-
-Enumerates the conversation roles used for contextual snapshots and messages.
-
-#### Type Declaration
-
-| Name                                        | Type          | Default value | Defined in                                                                                                                                                                                                     |
-| ------------------------------------------- | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-assistant"></a> `Assistant` | `"assistant"` | `'assistant'` | [intelligence/contracts/IntelligenceConversationMessageRoles.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L6) |
-| <a id="property-system"></a> `System`       | `"system"`    | `'system'`    | [intelligence/contracts/IntelligenceConversationMessageRoles.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L7) |
-| <a id="property-user"></a> `User`           | `"user"`      | `'user'`      | [intelligence/contracts/IntelligenceConversationMessageRoles.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L5) |
-
----
-
-### IntelligenceProviderNames
-
-```ts
-const IntelligenceProviderNames: {
-  Anthropic: 'anthropic';
-  Google: 'google';
-  Grok: 'grok';
-  OpenAI: 'openai';
-};
-```
-
-Defined in: [intelligence/contracts/IntelligenceProviderNames.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L4)
-
-Enumerates the supported model providers powering the intelligence pipeline.
-
-#### Type Declaration
-
-| Name                                        | Type          | Default value | Defined in                                                                                                                                                                               |
-| ------------------------------------------- | ------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-anthropic"></a> `Anthropic` | `"anthropic"` | `'anthropic'` | [intelligence/contracts/IntelligenceProviderNames.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L6) |
-| <a id="property-google"></a> `Google`       | `"google"`    | `'google'`    | [intelligence/contracts/IntelligenceProviderNames.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L7) |
-| <a id="property-grok"></a> `Grok`           | `"grok"`      | `'grok'`      | [intelligence/contracts/IntelligenceProviderNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L8) |
-| <a id="property-openai"></a> `OpenAI`       | `"openai"`    | `'openai'`    | [intelligence/contracts/IntelligenceProviderNames.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L5) |
-
----
-
-### IpAddress
-
-```ts
-const IpAddress: (...dataOrPipes) => ParameterDecorator;
-```
-
-Defined in: [decorators/IpAddress.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/IpAddress.ts#L15)
-
-Extracts the client IP address from the current HTTP request.
-Handles IPv6 (::1), proxy headers (X-Forwarded-For), and normalizes the output.
-
-Examples:
-"192.168.0.5" -> "192.168.0.5"
-"::ffff:127.0.0.1" -> "127.0.0.1"
-"::1" / "127.0.0.1" -> "localhost"
-undefined / "" -> undefined
-
-#### Parameters
-
-| Parameter        | Type                                                                                                            |
-| ---------------- | --------------------------------------------------------------------------------------------------------------- |
-| ...`dataOrPipes` | ( \| `string` \| `PipeTransform`\<`any`, `any`\> \| `Type`\<`PipeTransform`\<`any`, `any`\>\> \| `undefined`)[] |
-
-#### Returns
-
-`ParameterDecorator`
-
----
-
-### IS_PUBLIC_KEY
-
-```ts
-const IS_PUBLIC_KEY: 'isPublic' = 'isPublic';
-```
-
-Defined in: [decorators/Public.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L7)
-
----
-
-### Lang
-
-```ts
-const Lang: (...dataOrPipes) => ParameterDecorator;
-```
-
-Defined in: [decorators/Lang.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Lang.ts#L13)
-
-Extracts the first language token from the Accept-Language header.
-
-Examples:
-"da, en-gb;q=0.8, en;q=0.7" -> "da"
-"en-US,en;q=0.9" -> "en-US"
-undefined / "" -> undefined
-
-#### Parameters
-
-| Parameter        | Type                                                                                                            |
-| ---------------- | --------------------------------------------------------------------------------------------------------------- |
-| ...`dataOrPipes` | ( \| `string` \| `PipeTransform`\<`any`, `any`\> \| `Type`\<`PipeTransform`\<`any`, `any`\>\> \| `undefined`)[] |
-
-#### Returns
-
-`ParameterDecorator`
-
----
-
-### NODE_ENV
-
-```ts
-const NODE_ENV: IConfigKey<string>;
-```
-
-Defined in: [env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L22)
-
-The current Node.js environment (`development`, `production`, etc.).
-
----
-
-### OTP_SERVICE_TOKEN
-
-```ts
-const OTP_SERVICE_TOKEN: typeof OTP_SERVICE_TOKEN;
-```
-
-Defined in: [services/OtpService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L14)
-
-Injection token for [IOtpService](Interface.IOtpService).
-
----
-
-### PLATFORM_CORE_CONFIG_ENTRIES
-
-```ts
-const PLATFORM_CORE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
-```
-
-Defined in: [env.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L45)
-
-All configuration entries required by `platform-core`.
-
----
-
-### TOTP_EPOCH_TOLERANCE
-
-```ts
-const TOTP_EPOCH_TOLERANCE: 30 = 30;
-```
-
-Defined in: [services/OtpService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L30)
-
-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)  |
-
----
-
-### UserAgent
-
-```ts
-const UserAgent: (...dataOrPipes) => ParameterDecorator;
-```
-
-Defined in: [decorators/UserAgent.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/UserAgent.ts#L8)
-
-Extracts the User-Agent header from the incoming HTTP request.
-
-#### Parameters
-
-| Parameter        | Type        |
-| ---------------- | ----------- |
-| ...`dataOrPipes` | `unknown`[] |
-
-#### Returns
-
-`ParameterDecorator`
+| Variable | Description |
+| ------ | ------ |
+| [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`). |
+| [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. |
+| [IntelligenceConversationMessageRoles](Variable.IntelligenceConversationMessageRoles) | Enumerates the conversation roles used for contextual snapshots and messages. |
+| [IntelligenceProviderNames](Variable.IntelligenceProviderNames) | Enumerates the supported model providers powering the intelligence pipeline. |
+| [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.). |
+| [OTP\_SERVICE\_TOKEN](Variable.OTP_SERVICE_TOKEN) | Injection token for [IOtpService](Interface.IOtpService). |
+| [PLATFORM\_CORE\_CONFIG\_ENTRIES](Variable.PLATFORM_CORE_CONFIG_ENTRIES) | All configuration entries required by `platform-core`. |
+| [TOTP\_EPOCH\_TOLERANCE](Variable.TOTP_EPOCH_TOLERANCE) | TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`). |
+| [UserAgent](Variable.UserAgent) | Extracts the User-Agent header from the incoming HTTP request. |
 
 ## Functions
 
-### createConfigKey()
-
-```ts
-function createConfigKey<TType>(key): IConfigKey<TType>;
-```
-
-Defined in: [config/ConfigKey.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L74)
-
-Creates a type-safe config key.
-
-Use this factory function to define all configuration keys in your application.
-This ensures you don’t scatter raw strings and you assign a type to each key.
-
-#### Type Parameters
-
-| Type Parameter | Default type |
-| -------------- | ------------ |
-| `TType`        | `unknown`    |
-
-#### Parameters
-
-| 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.
-
-#### Example
-
-```typescript
-// In some config-keys file
-export const DATABASE_URL = createConfigKey<string>('DATABASE_URL');
-export const MAX_TIMEOUT_MS = createConfigKey<number>('MAX_TIMEOUT_MS');
-export const FEATURE_X_ENABLED = createConfigKey<boolean>('FEATURE_X_ENABLED');
-```
-
-Then, when fetching:
-
-```ts
-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
-```
-
-#### Remarks
-
-At runtime the returned object is minimal (just `{ key: string }`) so there is
-virtually no overhead. The generic `TType` is only used by TypeScript for stronger
-compile-time checking — enabling you to avoid magic strings and untyped fetches.
-
----
-
-### createEventKey()
-
-```ts
-function createEventKey<TEvents, TKey>(eventName): IEventKey<TEvents, TKey>;
-```
-
-Defined in: [events/EventKey.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L26)
-
-Creates a branded event key for the [EventHub](Class.EventHub).
-
-#### Type Parameters
-
-| Type Parameter                                         |
-| ------------------------------------------------------ |
-| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
-| `TKey` _extends_ `string` \| `number` \| `symbol`      |
-
-#### Parameters
-
-| Parameter   | Type   | Description                   |
-| ----------- | ------ | ----------------------------- |
-| `eventName` | `TKey` | The unique name of the event. |
-
-#### Returns
-
-[`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\>
-
-The branded event key encoding the payload type.
-
----
-
-### createMappingKey()
-
-```ts
-function createMappingKey<TInput, TOutput>(key): IMappingKey<TInput, TOutput>;
-```
-
-Defined in: [mapping/types/MappingKey.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L28)
-
-Creates a type-safe mapping key.
-
-#### Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `TInput`       |
-| `TOutput`      |
-
-#### Parameters
-
-| Parameter | Type     | Description                                   |
-| --------- | -------- | --------------------------------------------- |
-| `key`     | `string` | The unique string identifier for the mapping. |
-
-#### Returns
-
-[`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\>
-
-A branded mapping key that encodes the input and output types.
-
-#### Example
-
-```typescript
-export const PRODUCT_MAPPING_KEY = createMappingKey<IProductMappingInput, ProductResponse>('food.product');
-```
-
----
-
-### env()
-
-```ts
-function env(strings, ...values): string;
-```
-
-Defined in: [utils/EnvUtils.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/EnvUtils.ts#L7)
-
-Marker function for environment strings.
-
-It behaves like a normal template literal but allows you to
-later search/grep all `env` usages in the codebase.
-
-#### Parameters
-
-| Parameter   | Type                   |
-| ----------- | ---------------------- |
-| `strings`   | `TemplateStringsArray` |
-| ...`values` | `unknown`[]            |
-
-#### Returns
-
-`string`
-
----
-
-### getMimeTypeByFileNameOrExtension()
-
-```ts
-function getMimeTypeByFileNameOrExtension(...args): string | false;
-```
-
-Defined in: [mime/mimeTypes.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mime/mimeTypes.ts#L14)
-
-Get MIME type by file name or extension.
-
-#### Parameters
-
-| Parameter | Type         | Description                     |
-| --------- | ------------ | ------------------------------- |
-| ...`args` | \[`string`\] | Arguments for mime-types lookup |
-
-#### Returns
-
-`string` \| `false`
-
-MIME type or false if not found
-
----
-
-### Public()
-
-```ts
-function Public(): CustomDecorator;
-```
-
-Defined in: [decorators/Public.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L14)
-
-The `Public` decorator.
-
-#### Returns
-
-`CustomDecorator`
+| 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. |