@breadstone/archipel-mcp 0.0.11 → 0.0.14

package/data/packages/platform-core/api/Variable.UserAgent.md

@@ -1,24 +0,0 @@
----
-title: 'Variable: UserAgent'
-generated: true
-editUrl: false
----
-# Variable: 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`

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

@@ -1,142 +0,0 @@
----
-title: '@breadstone/archipel-platform-core'
-generated: true
-editUrl: false
----
-# @breadstone/archipel-platform-core
-
-## Namespaces
-
-| 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) | - |
-| [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. |
-
-## Type Aliases
-
-| 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) | - |
-
-## 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. |
-
-## 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. |

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

@@ -1,485 +0,0 @@
----
-title: platform-core
-description: Foundation library providing configuration, mapping, templates, event pub/sub, and shared utilities.
-order: 1
-tags: [core, config, mapping, templates, event-hub]
-package: '@breadstone/archipel-platform-core'
----
-
-# platform-core
-
-The foundation library that every other Archipel package depends on. Provides configuration management, object mapping, template engines, event pub/sub, and shared utilities.
-
-> **Note:** Caching has moved to [`platform-caching`](../platform-caching/) and cryptography/OTP to [`platform-cryptography`](../platform-cryptography/). Re-exports are still available from `platform-core` for backward compatibility.
-
-**Package:** `@breadstone/archipel-platform-core`
-
-## Installation
-
-```typescript
-import {
-  ConfigModule,
-  ConfigRegistry,
-  MappingModule,
-  MappingService,
-  BcryptService,
-  CryptoService,
-  OtpService,
-  MemoryLayeredCache,
-  RedisLayeredCache,
-  ContentTemplateEngine,
-  EventHub,
-} from '@breadstone/archipel-platform-core';
-```
-
----
-
-## Configuration System
-
-Type-safe, module-scoped configuration with validation.
-
-### Defining Config Keys
-
-```typescript
-import { createConfigKey, type IConfigRegistryEntry } from '@breadstone/archipel-platform-core';
-
-// Type-safe config keys with phantom types
-const SMTP_HOST = createConfigKey<string>('SMTP_HOST');
-const SMTP_PORT = createConfigKey<number>('SMTP_PORT');
-const SMTP_SECURE = createConfigKey<boolean>('SMTP_SECURE');
-
-export const MY_MODULE_CONFIG_ENTRIES: ReadonlyArray<IConfigRegistryEntry> = [
-  { key: SMTP_HOST, module: 'my-module', required: true, description: 'SMTP server hostname' },
-  { key: SMTP_PORT, module: 'my-module', required: false, defaultValue: 587, description: 'SMTP port' },
-  { key: SMTP_SECURE, module: 'my-module', required: false, defaultValue: true },
-];
-```
-
-### Registering in a Module
-
-```typescript
-import { Module } from '@nestjs/common';
-import { ConfigModule } from '@breadstone/archipel-platform-core';
-import { MY_MODULE_CONFIG_ENTRIES } from './env';
-
-@Module({
-  imports: [ConfigModule.register('my-module', MY_MODULE_CONFIG_ENTRIES)],
-})
-export class MyModule {}
-```
-
-### Using the ConfigService
-
-```typescript
-import { Injectable } from '@nestjs/common';
-import { ConfigService } from '@breadstone/archipel-platform-core';
-
-@Injectable()
-export class SmtpClient {
-  private readonly _host: string;
-  private readonly _port: number;
-
-  constructor(configService: ConfigService) {
-    this._host = configService.get<string>('SMTP_HOST');
-    this._port = configService.tryGet<number>('SMTP_PORT', 587);
-  }
-}
-```
-
-### ConfigRegistry (Static Access)
-
-```typescript
-import { ConfigRegistry } from '@breadstone/archipel-platform-core';
-
-// List all registered modules
-const modules = ConfigRegistry.getModules(); // ['my-module', 'platform-auth', ...]
-
-// Get all required entries
-const required = ConfigRegistry.getRequired();
-
-// Get entries grouped by module
-const grouped = ConfigRegistry.getByModule();
-```
-
----
-
-## Caching
-
-Layered caching with pluggable backends, metrics, and stale-while-revalidate support.
-
-### ILayeredCache Interface
-
-```typescript
-interface ILayeredCache<TKey, TValue> {
-  get(key: TKey): TValue | undefined;
-  getAsync(key: TKey): Promise<TValue | undefined>;
-  set(key: TKey, value: TValue): void;
-  setAsync(key: TKey, value: TValue): Promise<void>;
-  invalidate(key: TKey): void;
-  invalidateAsync(key: TKey): Promise<void>;
-  warm?(key: TKey): Promise<TValue | undefined>;
-  stats?(): ICacheStats;
-}
-```
-
-### MemoryLayeredCache
-
-In-memory LRU cache with TTL and stale-while-revalidate.
-
-```typescript
-import { MemoryLayeredCache } from '@breadstone/archipel-platform-core';
-
-const productCache = new MemoryLayeredCache<string, IProduct>(
-  async (key) => {
-    // Load function — called on cache miss
-    return await this._productRepository.findById(key);
-  },
-  {
-    ttlMs: 60_000, // 60 seconds TTL
-    staleWhileRevalidate: true, // Serve stale data while refreshing
-    maxEntries: 1000, // LRU eviction after 1000 entries
-    cacheName: 'products', // For metrics labeling
-    metricsRecorder: telemetryRecorder,
-  },
-);
-
-// Usage
-const product = await productCache.getAsync('prod-123');
-
-// Invalidate after mutation
-productCache.invalidate('prod-123');
-
-// Check stats
-const stats = productCache.stats();
-// → { hits: 142, misses: 23, loads: 23, loadErrors: 0, evictions: 0 }
-```
-
-### RedisLayeredCache
-
-Redis-backed distributed cache for multi-instance deployments.
-
-```typescript
-import { RedisLayeredCache } from '@breadstone/archipel-platform-core';
-
-const sessionCache = new RedisLayeredCache<string, ISessionData>(
-  async (key) => await this._sessionStore.findByToken(key),
-  {
-    url: 'redis://localhost:6379',
-    keyPrefix: 'session:',
-    ttlSeconds: 3600,
-    serialize: (value) => JSON.stringify(value),
-    deserialize: (raw) => JSON.parse(raw),
-    cacheName: 'sessions',
-  },
-);
-```
-
-### ICacheMetricsRecorder
-
-Integrate cache metrics with your observability stack.
-
-```typescript
-import type { ICacheMetricsRecorder } from '@breadstone/archipel-platform-core';
-
-class MyMetricsRecorder implements ICacheMetricsRecorder {
-  public recordHit(cache: string): void {
-    /* prometheus counter */
-  }
-  public recordMiss(cache: string): void {
-    /* prometheus counter */
-  }
-  public recordLoadSuccess(cache: string): void {
-    /* ... */
-  }
-  public recordLoadError(cache: string): void {
-    /* ... */
-  }
-  public recordEviction(cache: string): void {
-    /* ... */
-  }
-}
-```
-
----
-
-## Mapping Service
-
-Centralized object mapping with type-safe keys and profiles.
-
-### Defining Mapping Keys
-
-```typescript
-import { createMappingKey } from '@breadstone/archipel-platform-core';
-import type { IUserEntity } from './entities';
-import type { UserResponse } from './responses';
-
-export const USER_TO_RESPONSE = createMappingKey<IUserEntity, UserResponse>('UserEntity→UserResponse');
-export const USER_TO_SUMMARY = createMappingKey<IUserEntity, UserSummary>('UserEntity→UserSummary');
-```
-
-### Creating a Mapping Profile
-
-```typescript
-import { Injectable } from '@nestjs/common';
-import { MappingProfileBase, type IMappingBuilder } from '@breadstone/archipel-platform-core';
-import { USER_TO_RESPONSE, USER_TO_SUMMARY } from './mapping-keys';
-
-@Injectable()
-export class UserMappingProfile extends MappingProfileBase {
-  public override configure(builder: IMappingBuilder): void {
-    builder.createKeyedMap(USER_TO_RESPONSE, (source) => ({
-      id: source.id,
-      name: source.userName,
-      email: source.email,
-      verified: source.isVerified,
-      roles: [...source.roles],
-    }));
-
-    builder.createKeyedMap(USER_TO_SUMMARY, (source) => ({
-      id: source.id,
-      displayName: source.userName ?? source.email ?? 'Anonymous',
-    }));
-  }
-}
-```
-
-### Registering Profiles in a Module
-
-```typescript
-import { Module } from '@nestjs/common';
-import { MappingModule } from '@breadstone/archipel-platform-core';
-import { UserMappingProfile } from './mappers/UserMappingProfile';
-import { OrderMappingProfile } from './mappers/OrderMappingProfile';
-
-@Module({
-  imports: [MappingModule.withProfiles([UserMappingProfile, OrderMappingProfile])],
-})
-export class AppModule {}
-```
-
-### Using in a Controller
-
-```typescript
-import { Controller, Get, Param } from '@nestjs/common';
-import { MappingService } from '@breadstone/archipel-platform-core';
-import { USER_TO_RESPONSE } from './mapping-keys';
-
-@Controller('users')
-export class UserController {
-  constructor(
-    private readonly _userService: UserService,
-    private readonly _mappingService: MappingService,
-  ) {}
-
-  @Get(':id')
-  public async getUser(@Param('id') id: string): Promise<UserResponse> {
-    const entity = await this._userService.findById(id);
-    return this._mappingService.map(USER_TO_RESPONSE, entity);
-  }
-}
-```
-
----
-
-## Cryptography & OTP
-
-### BcryptService
-
-Password hashing with bcrypt.
-
-```typescript
-import { BcryptService } from '@breadstone/archipel-platform-core';
-
-@Injectable()
-export class AccountService {
-  constructor(private readonly _bcrypt: BcryptService) {}
-
-  public async register(password: string): Promise<void> {
-    const hash = await this._bcrypt.hash(password);
-    // Store hash in database
-  }
-
-  public async verifyPassword(input: string, storedHash: string): Promise<boolean> {
-    return this._bcrypt.compare(input, storedHash);
-  }
-}
-```
-
-### CryptoService
-
-UUID-based identifier generation.
-
-```typescript
-import { CryptoService } from '@breadstone/archipel-platform-core';
-
-const crypto = new CryptoService();
-const token = crypto.getRandomGuid('verify');
-// → "verify-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
-```
-
-### OtpService
-
-TOTP one-time password generation and verification (otplib).
-
-```typescript
-import { OtpService } from '@breadstone/archipel-platform-core';
-import type { IOtpService } from '@breadstone/archipel-platform-core';
-
-@Injectable()
-export class MfaSetupService {
-  constructor(@Inject(OTP_SERVICE_TOKEN) private readonly _otp: IOtpService) {}
-
-  public setup(userEmail: string): { secret: string; uri: string } {
-    const secret = this._otp.generateSecret();
-    const uri = this._otp.generateUri({
-      issuer: 'MyApp',
-      label: userEmail,
-      secret,
-    });
-    return { secret, uri };
-  }
-
-  public verify(token: string, secret: string): boolean {
-    return this._otp.verify(token, secret);
-    // Window = 1 → accepts current + previous 30s interval
-  }
-}
-```
-
----
-
-## Event System
-
-Type-safe publish/subscribe with RxJS.
-
-### Defining Events
-
-```typescript
-import { createEventKey, type IEventMap } from '@breadstone/archipel-platform-core';
-
-interface IOrderEvents extends IEventMap {
-  'order.created': { orderId: string; userId: string };
-  'order.shipped': { orderId: string; trackingNumber: string };
-  'order.cancelled': { orderId: string; reason: string };
-}
-
-export const ORDER_CREATED = createEventKey<IOrderEvents, 'order.created'>('order.created');
-export const ORDER_SHIPPED = createEventKey<IOrderEvents, 'order.shipped'>('order.shipped');
-```
-
-### Publishing & Subscribing
-
-```typescript
-import { EventHub } from '@breadstone/archipel-platform-core';
-import { ORDER_CREATED, ORDER_SHIPPED } from './events';
-
-@Injectable()
-export class OrderService {
-  constructor(private readonly _events: EventHub) {}
-
-  public async createOrder(userId: string): Promise<void> {
-    const orderId = '...';
-    // ... create order logic
-
-    this._events.publish(ORDER_CREATED, { orderId, userId });
-  }
-}
-
-@Injectable()
-export class NotificationService {
-  constructor(events: EventHub) {
-    events.subscribe(ORDER_CREATED, (payload) => {
-      // payload is typed as { orderId: string; userId: string }
-      this.sendOrderConfirmation(payload.userId, payload.orderId);
-    });
-  }
-}
-```
-
----
-
-## Content Template Engine
-
-Handlebars-style template compilation with block helpers.
-
-```typescript
-import { ContentTemplateEngine } from '@breadstone/archipel-platform-core';
-
-const engine = new ContentTemplateEngine();
-
-// Simple variable substitution
-const result = engine.compileTemplate('Hello {{name}}, welcome to {{app}}!', { name: 'Alice', app: 'MyApp' });
-// → "Hello Alice, welcome to MyApp!"
-
-// Block helpers
-const list = engine.compileTemplate('{{#each items}}- {{this.name}}: {{this.price}}€\n{{/each}}', {
-  items: [
-    { name: 'Widget', price: 9.99 },
-    { name: 'Gadget', price: 19.99 },
-  ],
-});
-
-// Conditionals
-const conditional = engine.compileTemplate('{{#if isPremium}}Premium Member{{/if}}{{#if !isPremium}}Free Tier{{/if}}', {
-  isPremium: true,
-});
-```
-
----
-
-## Identifier Generation
-
-Pluggable ID generation via `IdentifierModule`.
-
-```typescript
-import { IdentifierModule, ID_GENERATOR_TOKEN, type IIdGenerator } from '@breadstone/archipel-platform-core';
-
-// Module setup — choose strategy
-@Module({
-  imports: [IdentifierModule.register('CUID')],
-})
-export class AppModule {}
-
-// Usage in a service
-@Injectable()
-export class OrderService {
-  constructor(@Inject(ID_GENERATOR_TOKEN) private readonly _idGen: IIdGenerator) {}
-
-  public createOrder(): string {
-    return this._idGen.generate(); // CUID, UUID, or GUID depending on registration
-  }
-}
-```
-
----
-
-## Utility Services
-
-| Service                      | Purpose                                                                  |
-| ---------------------------- | ------------------------------------------------------------------------ |
-| `DeviceParserService`        | Parse `User-Agent` headers into `IDeviceInfo` (browser, OS, device type) |
-| `HostService`                | Host configuration (title, logo, features, health endpoints)             |
-| `UserAvatarGeneratorService` | Generate deterministic avatars from user identifiers                     |
-| `UsernameGeneratorService`   | Generate random usernames from word lists                                |
-
----
-
-## Module Summary
-
-| Export                  | Type          | Description                               |
-| ----------------------- | ------------- | ----------------------------------------- |
-| `ConfigModule`          | NestJS Module | Configuration registration and validation |
-| `MappingModule`         | NestJS Module | Mapping profile registration              |
-| `EventModule`           | NestJS Module | Event pub/sub system                      |
-| `IdentifierModule`      | NestJS Module | ID generation strategy                    |
-| `HostModule`            | NestJS Module | Host services and templates               |
-| `HealthModule`          | NestJS Module | Health check orchestration                |
-| `MappingService`        | Service       | Central object mapping                    |
-| `ConfigService`         | Service       | Type-safe config access                   |
-| `BcryptService`         | Service       | Password hashing                          |
-| `CryptoService`         | Service       | UUID generation                           |
-| `OtpService`            | Service       | TOTP generation/verification              |
-| `EventHub`              | Service       | Event publish/subscribe                   |
-| `ContentTemplateEngine` | Service       | Template compilation                      |
-| `MemoryLayeredCache`    | Class         | In-memory LRU cache                       |
-| `RedisLayeredCache`     | Class         | Redis-backed cache                        |