@breadstone/archipel-mcp 0.0.22 → 0.0.25

package/data/packages/platform-caching/api/Class.RedisLayeredCache.md

@@ -35,7 +35,7 @@ is inherently asynchronous. Use the `*Async` variants instead.
 new RedisLayeredCache<TKey, TValue>(loadFn, options): RedisLayeredCache<TKey, TValue>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L107)
+Defined in: [redis/RedisLayeredCache.ts:108](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L108)
 
 Initializes a new instance of the RedisLayeredCache class.
 
@@ -58,9 +58,9 @@ Initializes a new instance of the RedisLayeredCache class.
 get(key): TValue | undefined;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L124)
+Defined in: [redis/RedisLayeredCache.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L125)
 
-Not supported — Redis is inherently asynchronous.
+Not supported - Redis is inherently asynchronous.
 
 #### Parameters
 
@@ -88,7 +88,7 @@ Always throws. Use [getAsync](#getasync) instead.
 getAsync(key): Promise<TValue | undefined>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L129)
+Defined in: [redis/RedisLayeredCache.ts:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L130)
 
 Retrieves a value from the cache asynchronously.
 
@@ -116,9 +116,9 @@ A promise resolving to the cached value or `undefined` on a miss.
 invalidate(key): void;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:186](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L186)
+Defined in: [redis/RedisLayeredCache.ts:209](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L209)
 
-Not supported — Redis is inherently asynchronous.
+Not supported - Redis is inherently asynchronous.
 
 #### Parameters
 
@@ -146,7 +146,7 @@ Always throws. Use [invalidateAsync](#invalidateasync) instead.
 invalidateAsync(key): Promise<void>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:193](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L193)
+Defined in: [redis/RedisLayeredCache.ts:216](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L216)
 
 Invalidates a key in the cache asynchronously.
 
@@ -172,7 +172,7 @@ Invalidates a key in the cache asynchronously.
 onModuleDestroy(): Promise<void>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:214](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L214)
+Defined in: [redis/RedisLayeredCache.ts:237](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L237)
 
 Gracefully disconnects the Redis client when the NestJS module is destroyed.
 
@@ -194,9 +194,9 @@ OnModuleDestroy.onModuleDestroy
 set(key, value): void;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L160)
+Defined in: [redis/RedisLayeredCache.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L183)
 
-Not supported — Redis is inherently asynchronous.
+Not supported - Redis is inherently asynchronous.
 
 #### Parameters
 
@@ -225,7 +225,7 @@ Always throws. Use [setAsync](#setasync) instead.
 setAsync(key, value): Promise<void>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:165](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L165)
+Defined in: [redis/RedisLayeredCache.ts:188](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L188)
 
 Stores a value in the cache asynchronously.
 
@@ -252,7 +252,7 @@ Stores a value in the cache asynchronously.
 stats(): ICacheStats;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:202](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L202)
+Defined in: [redis/RedisLayeredCache.ts:225](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L225)
 
 Returns current cache statistics.
 
@@ -274,7 +274,7 @@ The cache statistics snapshot.
 warm(key): Promise<TValue | undefined>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:177](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L177)
+Defined in: [redis/RedisLayeredCache.ts:200](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L200)
 
 Proactively warms the cache for a given key.
 

package/data/packages/platform-caching/api/Interface.ILayeredCache.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Interface: ILayeredCache\<TKey, TValue\>
 
-Defined in: [ILayeredCache.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L15)
+Defined in: [interfaces/ILayeredCache.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L15)
 
 Generic layered cache contract supporting synchronous and asynchronous
 access patterns with optional warm-up and statistics.
@@ -25,7 +25,7 @@ access patterns with optional warm-up and statistics.
 get(key): TValue | undefined;
 ```
 
-Defined in: [ILayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L25)
+Defined in: [interfaces/ILayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L25)
 
 Retrieves a value from the cache synchronously.
 
@@ -49,7 +49,7 @@ The cached value or `undefined` on a miss.
 getAsync(key): Promise<TValue | undefined>;
 ```
 
-Defined in: [ILayeredCache.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L34)
+Defined in: [interfaces/ILayeredCache.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L34)
 
 Retrieves a value from the cache asynchronously.
 
@@ -73,7 +73,7 @@ A promise resolving to the cached value or `undefined` on a miss.
 invalidate(key): void;
 ```
 
-Defined in: [ILayeredCache.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L69)
+Defined in: [interfaces/ILayeredCache.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L69)
 
 Invalidates a key in the cache synchronously.
 
@@ -95,7 +95,7 @@ Invalidates a key in the cache synchronously.
 invalidateAsync(key): Promise<void>;
 ```
 
-Defined in: [ILayeredCache.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L77)
+Defined in: [interfaces/ILayeredCache.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L77)
 
 Invalidates a key in the cache asynchronously.
 
@@ -117,7 +117,7 @@ Invalidates a key in the cache asynchronously.
 set(key, value): void;
 ```
 
-Defined in: [ILayeredCache.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L43)
+Defined in: [interfaces/ILayeredCache.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L43)
 
 Stores a value in the cache synchronously.
 
@@ -140,7 +140,7 @@ Stores a value in the cache synchronously.
 setAsync(key, value): Promise<void>;
 ```
 
-Defined in: [ILayeredCache.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L52)
+Defined in: [interfaces/ILayeredCache.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L52)
 
 Stores a value in the cache asynchronously.
 
@@ -163,7 +163,7 @@ Stores a value in the cache asynchronously.
 optional stats(): ICacheStats;
 ```
 
-Defined in: [ILayeredCache.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L85)
+Defined in: [interfaces/ILayeredCache.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L85)
 
 Returns current cache statistics.
 
@@ -181,7 +181,7 @@ The cache statistics snapshot.
 optional warm(key): Promise<TValue | undefined>;
 ```
 
-Defined in: [ILayeredCache.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L61)
+Defined in: [interfaces/ILayeredCache.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/interfaces/ILayeredCache.ts#L61)
 
 Proactively warms the cache for a given key.
 

package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Interface: ILayeredCacheOptions
 
-Defined in: [MemoryLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L16)
+Defined in: [memory/MemoryLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L16)
 
 Configuration options for [MemoryLayeredCache](Class.MemoryLayeredCache).
 
@@ -17,7 +17,7 @@ Configuration options for [MemoryLayeredCache](Class.MemoryLayeredCache).
 optional cacheName?: string;
 ```
 
-Defined in: [MemoryLayeredCache.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L57)
+Defined in: [memory/MemoryLayeredCache.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L57)
 
 An optional name / label for the cache instance, used in metrics.
 Defaults to `'memory'`.
@@ -30,7 +30,7 @@ Defaults to `'memory'`.
 optional maxEntries?: number;
 ```
 
-Defined in: [MemoryLayeredCache.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L41)
+Defined in: [memory/MemoryLayeredCache.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L41)
 
 Maximum number of entries retained in the cache. Oldest entries are
 evicted first (LRU). Defaults to infinite.
@@ -43,7 +43,7 @@ evicted first (LRU). Defaults to infinite.
 optional metricsRecorder?: ICacheMetricsRecorder;
 ```
 
-Defined in: [MemoryLayeredCache.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L49)
+Defined in: [memory/MemoryLayeredCache.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L49)
 
 Optional metrics recorder forwarded cache operation statistics.
 Falls back to [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) when omitted.
@@ -56,7 +56,7 @@ Falls back to [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) when om
 optional staleWhileRevalidate?: boolean;
 ```
 
-Defined in: [MemoryLayeredCache.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L33)
+Defined in: [memory/MemoryLayeredCache.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L33)
 
 When `true`, expired entries are served immediately while a background
 refresh is triggered. Defaults to `false`.
@@ -69,7 +69,7 @@ refresh is triggered. Defaults to `false`.
 optional ttlMs?: number;
 ```
 
-Defined in: [MemoryLayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L25)
+Defined in: [memory/MemoryLayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L25)
 
 Time to live in milliseconds. Entries older than this are considered expired.
 Defaults to infinite (no expiration).

package/data/packages/platform-caching/api/Variable.CACHE_DEFAULT_TTL_MS.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: CACHE\_DEFAULT\_TTL\_MS'
+generated: true
+editUrl: false
+---
+# Variable: CACHE\_DEFAULT\_TTL\_MS
+
+```ts
+const CACHE_DEFAULT_TTL_MS: IConfigKey<number>;
+```
+
+Defined in: [env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/env.ts#L12)
+
+Default cache TTL in milliseconds applied when no provider-specific TTL is configured.

package/data/packages/platform-caching/api/Variable.CACHE_MAX_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: CACHE\_MAX\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: CACHE\_MAX\_ENTRIES
+
+```ts
+const CACHE_MAX_ENTRIES: IConfigKey<number>;
+```
+
+Defined in: [env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/env.ts#L15)
+
+Maximum number of entries retained in an in-memory cache (LRU limit).

package/data/packages/platform-caching/api/Variable.CACHE_STALE_WHILE_REVALIDATE.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: CACHE\_STALE\_WHILE\_REVALIDATE'
+generated: true
+editUrl: false
+---
+# Variable: CACHE\_STALE\_WHILE\_REVALIDATE
+
+```ts
+const CACHE_STALE_WHILE_REVALIDATE: IConfigKey<boolean>;
+```
+
+Defined in: [env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/env.ts#L18)
+
+Whether expired entries are served while a background refresh is in progress.

package/data/packages/platform-caching/api/Variable.PLATFORM_CACHING_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: PLATFORM\_CACHING\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: PLATFORM\_CACHING\_CONFIG\_ENTRIES
+
+```ts
+const PLATFORM_CACHING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/env.ts#L25)
+
+All configuration entries required by `platform-caching`.

package/data/packages/platform-caching/api/Variable.REDIS_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: REDIS\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: REDIS\_CONFIG\_ENTRIES
+
+```ts
+const REDIS_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [redis/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/env.ts#L25)
+
+Configuration entries required by the Redis caching provider.

package/data/packages/platform-caching/api/Variable.REDIS_KEY_PREFIX.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: REDIS\_KEY\_PREFIX'
+generated: true
+editUrl: false
+---
+# Variable: REDIS\_KEY\_PREFIX
+
+```ts
+const REDIS_KEY_PREFIX: IConfigKey<string>;
+```
+
+Defined in: [redis/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/env.ts#L15)
+
+Key prefix applied to all Redis keys managed by the cache instance.

package/data/packages/platform-caching/api/Variable.REDIS_TTL_SECONDS.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: REDIS\_TTL\_SECONDS'
+generated: true
+editUrl: false
+---
+# Variable: REDIS\_TTL\_SECONDS
+
+```ts
+const REDIS_TTL_SECONDS: IConfigKey<number>;
+```
+
+Defined in: [redis/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/env.ts#L18)
+
+TTL in seconds applied to every stored Redis entry.

package/data/packages/platform-caching/api/Variable.REDIS_URL.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: REDIS\_URL'
+generated: true
+editUrl: false
+---
+# Variable: REDIS\_URL
+
+```ts
+const REDIS_URL: IConfigKey<string>;
+```
+
+Defined in: [redis/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/env.ts#L12)
+
+Redis connection URL (e.g. `redis://localhost:6379`).

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

@@ -22,3 +22,16 @@ editUrl: false
 | [ILayeredCache](Interface.ILayeredCache) | Generic layered cache contract supporting synchronous and asynchronous access patterns with optional warm-up and statistics. |
 | [ILayeredCacheOptions](Interface.ILayeredCacheOptions) | Configuration options for [MemoryLayeredCache](Class.MemoryLayeredCache). |
 | [IRedisLayeredCacheOptions](Interface.IRedisLayeredCacheOptions) | Configuration options for [RedisLayeredCache](Class.RedisLayeredCache). |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [CACHE\_DEFAULT\_TTL\_MS](Variable.CACHE_DEFAULT_TTL_MS) | Default cache TTL in milliseconds applied when no provider-specific TTL is configured. |
+| [CACHE\_MAX\_ENTRIES](Variable.CACHE_MAX_ENTRIES) | Maximum number of entries retained in an in-memory cache (LRU limit). |
+| [CACHE\_STALE\_WHILE\_REVALIDATE](Variable.CACHE_STALE_WHILE_REVALIDATE) | Whether expired entries are served while a background refresh is in progress. |
+| [PLATFORM\_CACHING\_CONFIG\_ENTRIES](Variable.PLATFORM_CACHING_CONFIG_ENTRIES) | All configuration entries required by `platform-caching`. |
+| [REDIS\_CONFIG\_ENTRIES](Variable.REDIS_CONFIG_ENTRIES) | Configuration entries required by the Redis caching provider. |
+| [REDIS\_KEY\_PREFIX](Variable.REDIS_KEY_PREFIX) | Key prefix applied to all Redis keys managed by the cache instance. |
+| [REDIS\_TTL\_SECONDS](Variable.REDIS_TTL_SECONDS) | TTL in seconds applied to every stored Redis entry. |
+| [REDIS\_URL](Variable.REDIS_URL) | Redis connection URL (e.g. `redis://localhost:6379`). |

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

@@ -2,7 +2,7 @@
 title: platform-caching
 description: Layered caching with in-memory LRU and Redis-backed implementations, TTL, stale-while-revalidate, and metrics.
 order: 15
-tags: [caching, lru, redis, ttl, stale-while-revalidate, metrics]
+tags: [caching, lru, redis, ttl, stale-while-revalidate, metrics, health]
 package: '@breadstone/archipel-platform-caching'
 ---
 
@@ -84,6 +84,29 @@ Both implementations share this contract:
 
 ---
 
+## Environment Variables
+
+### Core (optional)
+
+| Variable                       | Description                                                  | Default | Required |
+| ------------------------------ | ------------------------------------------------------------ | ------- | -------- |
+| `CACHE_DEFAULT_TTL_MS`         | Default cache TTL in milliseconds                            | —       | No       |
+| `CACHE_MAX_ENTRIES`            | Maximum number of entries retained in an in-memory cache     | —       | No       |
+| `CACHE_STALE_WHILE_REVALIDATE` | Whether expired entries are served during background refresh | `false` | No       |
+
+### Redis
+
+**Subpath:** `@breadstone/archipel-platform-caching/redis`
+**SDK:** `ioredis` ≥ 5.0.0
+
+| Variable            | Description                         | Default | Required |
+| ------------------- | ----------------------------------- | ------- | -------- |
+| `REDIS_URL`         | Redis connection URL                | —       | Yes      |
+| `REDIS_KEY_PREFIX`  | Key prefix for all Redis cache keys | `''`    | No       |
+| `REDIS_TTL_SECONDS` | TTL in seconds for Redis entries    | —       | No       |
+
+---
+
 ## Metrics
 
 Implement `ICacheMetricsRecorder` to forward cache statistics to your telemetry system:
@@ -114,6 +137,29 @@ When no recorder is provided, `NoopCacheMetricsRecorder` is used as a silent fal
 
 ---
 
+## Health Check
+
+The `CachingHealthIndicator` reports the caching subsystem as available. Import it from the `/health` subpath:
+
+```typescript
+import { CachingHealthIndicator } from '@breadstone/archipel-platform-caching/health';
+import { HealthModule } from '@breadstone/archipel-platform-health';
+
+@Module({
+  imports: [
+    CachingModule,
+    HealthModule.withIndicators([CachingHealthIndicator]),
+  ],
+})
+export class AppModule {}
+```
+
+| Key | Check | Dependencies |
+| --- | ----- | ------------ |
+| `caching` | Always reports `up` | None |
+
+---
+
 ## API Reference
 
 See the full [API documentation](./api/) for all exported types and classes.

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

@@ -55,4 +55,4 @@ const enabled = configService.get(FEATURE_X_ENABLED); // typed as boolean
 
 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.
+compile-time checking - enabling you to avoid magic strings and untyped fetches.

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

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: HttpLoggerMiddleware
 
-Defined in: [middlewares/HttpLoggerMiddleware.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L50)
+Defined in: [middlewares/HttpLoggerMiddleware.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L12)
 
 ## Implements
 
@@ -19,7 +19,7 @@ Defined in: [middlewares/HttpLoggerMiddleware.ts:50](https://github.com/RueDeRen
 new HttpLoggerMiddleware(): HttpLoggerMiddleware;
 ```
 
-Defined in: [middlewares/HttpLoggerMiddleware.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L64)
+Defined in: [middlewares/HttpLoggerMiddleware.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L26)
 
 Constructs a new instance of the `HttpLoggerMiddleware` class.
 
@@ -38,7 +38,7 @@ use(
    next): void;
 ```
 
-Defined in: [middlewares/HttpLoggerMiddleware.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L70)
+Defined in: [middlewares/HttpLoggerMiddleware.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L32)
 
 #### Parameters
 

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

@@ -0,0 +1,26 @@
+---
+title: 'Function: maskSensitive()'
+generated: true
+editUrl: false
+---
+# Function: maskSensitive()
+
+```ts
+function maskSensitive(value): string;
+```
+
+Defined in: [utils/MaskSensitiveUtils.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/MaskSensitiveUtils.ts#L67)
+
+Serializes a value to a JSON string with sensitive keys masked.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | Arbitrary value to sanitize and serialize. |
+
+## Returns
+
+`string`
+
+A JSON string safe for logging.

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

@@ -0,0 +1,26 @@
+---
+title: 'Function: maskSensitiveFields()'
+generated: true
+editUrl: false
+---
+# Function: maskSensitiveFields()
+
+```ts
+function maskSensitiveFields(value): unknown;
+```
+
+Defined in: [utils/MaskSensitiveUtils.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/MaskSensitiveUtils.ts#L35)
+
+Recursively masks values of sensitive keys in a plain object for safe logging.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | Arbitrary value to sanitize (objects, arrays, primitives). |
+
+## Returns
+
+`unknown`
+
+A new value with sensitive fields replaced by `'***'`.

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

@@ -97,4 +97,6 @@ editUrl: false
 | [createEventKey](Function.createEventKey) | Creates a branded event key for the [EventHub](Class.EventHub). |
 | [env](Function.env) | Marker function for environment strings. |
 | [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension. |
+| [maskSensitive](Function.maskSensitive) | Serializes a value to a JSON string with sensitive keys masked. |
+| [maskSensitiveFields](Function.maskSensitiveFields) | Recursively masks values of sensitive keys in a plain object for safe logging. |
 | [Public](Function.Public) | The `Public` decorator. |

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

@@ -466,6 +466,14 @@ export class OrderService {
 | `UserAvatarGeneratorService` | Generate deterministic avatars from user identifiers                     |
 | `UsernameGeneratorService`   | Generate random usernames from word lists                                |
 | `SseHub`                     | Server-Sent Events hub — bounded to 10,000 event subjects                |
+| `maskSensitiveFields()`      | Recursively masks sensitive keys (password, token, apikey, etc.) in objects for safe logging |
+| `maskSensitive()`            | Serializes a value to JSON with sensitive keys masked                    |
+
+---
+
+## HTTP Logger Middleware
+
+The `HttpLoggerMiddleware` logs incoming requests with automatic masking of sensitive data in query parameters, route params, and request bodies. Sensitive fields (passwords, tokens, API keys, emails, etc.) are replaced with `'***'` before logging.
 
 ---
 
@@ -489,3 +497,6 @@ export class OrderService {
 | `ContentTemplateEngine` | Service       | Template compilation                                                                |
 | `MemoryLayeredCache`    | Class         | In-memory LRU cache                                                                 |
 | `RedisLayeredCache`     | Class         | Redis-backed cache                                                                  |
+| `maskSensitiveFields()` | Utility       | Recursively masks sensitive keys in objects for safe logging                        |
+| `maskSensitive()`       | Utility       | JSON-serializes values with sensitive keys masked                                   |
+| `HttpLoggerMiddleware`  | Middleware    | Request logging with automatic sensitive data masking                               |

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

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: DatabaseHealthIndicator
 
-Defined in: [terminus/DatabaseHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L16)
+Defined in: health/DatabaseHealthIndicator.ts:16
 
 Health indicator for database connectivity.
 
@@ -21,7 +21,7 @@ Health indicator for database connectivity.
 new DatabaseHealthIndicator(prismaHealthIndicator, databaseService): DatabaseHealthIndicator;
 ```
 
-Defined in: [terminus/DatabaseHealthIndicator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L26)
+Defined in: health/DatabaseHealthIndicator.ts:26
 
 #### Parameters
 
@@ -39,10 +39,10 @@ Defined in: [terminus/DatabaseHealthIndicator.ts:26](https://github.com/RueDeRen
 ### key
 
 ```ts
-readonly key: "database" = 'database';
+readonly key: string = 'database';
 ```
 
-Defined in: [terminus/DatabaseHealthIndicator.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L35)
+Defined in: health/DatabaseHealthIndicator.ts:35
 
 Unique key identifying the indicator
 
@@ -60,14 +60,16 @@ IHealthIndicator.key
 check(): Promise<HealthIndicatorResult<"database">>;
 ```
 
-Defined in: [terminus/DatabaseHealthIndicator.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L41)
+Defined in: health/DatabaseHealthIndicator.ts:47
 
-Performs the health check and returns a result keyed by the indicator key
+Checks database connectivity via a Prisma ping.
 
 #### Returns
 
 `Promise`\<`HealthIndicatorResult`\<`"database"`\>\>
 
+The health indicator result.
+
 #### Implementation of
 
 ```ts

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

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: DatabaseModule
 
-Defined in: [DatabaseModule.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L66)
+Defined in: [DatabaseModule.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L53)
 
 ## Constructors
 
@@ -27,7 +27,7 @@ new DatabaseModule(): DatabaseModule;
 static forRoot(config?): DynamicModule;
 ```
 
-Defined in: [DatabaseModule.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L75)
+Defined in: [DatabaseModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L62)
 
 Registers the `DatabaseModule` with global middlewares.
 
@@ -51,7 +51,7 @@ A `DynamicModule` that can be imported globally
 static register(config?): DynamicModule;
 ```
 
-Defined in: [DatabaseModule.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L95)
+Defined in: [DatabaseModule.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L82)
 
 Registers the `DatabaseModule` with dynamic middlewares.