@breadstone/archipel-mcp 0.0.23 → 0.0.25

package/data/packages/platform-blob-storage/index.md

@@ -2,7 +2,7 @@
 title: platform-blob-storage
 description: Cloud file storage abstraction with pluggable providers and optional metadata persistence.
 order: 3
-tags: [blob-storage, files, upload, download, vercel, azure, aws, s3, providers, ports-and-adapters]
+tags: [blob-storage, files, upload, download, vercel, azure, aws, s3, providers, ports-and-adapters, health]
 package: '@breadstone/archipel-platform-blob-storage'
 ---
 
@@ -267,7 +267,7 @@ BlobModule.forRoot({
 
 > **\*** `accessKeyId` and `secretAccessKey` must be provided **together**. Omit both to use the default AWS credential chain (IAM roles, instance profiles, environment variables).
 
-The provider supports pre-signed URLs and lazy-loads the AWS SDK for tree-shaking.
+The provider supports pre-signed URLs and lazy-loads the AWS SDK for tree-shaking. `downloadObject()` gracefully handles JSON parse errors, returning the raw response body when content cannot be parsed.
 
 ### Custom Provider
 
@@ -305,20 +305,24 @@ BlobModule.forRoot({
 
 ## Health Check
 
-The `BlobHealthIndicator` integrates with NestJS Terminus for health monitoring:
+The `BlobHealthIndicator` pings the configured blob storage URL via HTTP. If no URL is configured, it reports `disabled: true`. Import it from the `/health` subpath:
 
 ```typescript
-import { BlobHealthIndicator } from '@breadstone/archipel-platform-blob-storage';
+import { BlobHealthIndicator } from '@breadstone/archipel-platform-blob-storage/health';
+import { HealthModule } from '@breadstone/archipel-platform-health';
 
-@Controller('health')
-export class HealthController {
-  constructor(private readonly _blobHealth: BlobHealthIndicator) {}
+@Module({
+  imports: [
+    BlobModule.forRoot({ /* ... */ }),
+    HealthModule.withIndicators([BlobHealthIndicator]),
+  ],
+})
+export class AppModule {}
+```
 
-  @Get()
-  public async check(): Promise<HealthCheckResult> {
-    return this._blobHealth.isHealthy('blob');
-  }
-}
+| Key | Check | Dependencies |
+| --- | ----- | ------------ |
+| `blob` | HTTP ping to blob URL (or disabled if unconfigured) | `ConfigService`, `HttpHealthIndicator` |
 ```
 
 ---
@@ -329,10 +333,11 @@ Each provider is tree-shakeable via sub-path imports:
 
 | Import Path                                         | Contents                                              |
 | --------------------------------------------------- | ----------------------------------------------------- |
-| `@breadstone/archipel-platform-blob-storage`        | Core module, service, ports, health check, interfaces |
+| `@breadstone/archipel-platform-blob-storage`        | Core module, service, ports, interfaces               |
 | `@breadstone/archipel-platform-blob-storage/vercel` | VercelBlobProvider, VERCEL_BLOB_PROVIDER_OPTIONS      |
 | `@breadstone/archipel-platform-blob-storage/azure`  | AzureBlobProvider, AZURE_BLOB_PROVIDER_OPTIONS        |
 | `@breadstone/archipel-platform-blob-storage/aws-s3` | AwsS3BlobProvider, AWS_S3_PROVIDER_OPTIONS            |
+| `@breadstone/archipel-platform-blob-storage/health`  | BlobHealthIndicator                                   |
 
 ---
 
@@ -347,7 +352,7 @@ Each provider is tree-shakeable via sub-path imports:
 | `VercelBlobProvider`         | Provider      | Vercel Blob implementation (sub-path)                 |
 | `AzureBlobProvider`          | Provider      | Azure Blob Storage implementation (sub-path)          |
 | `AwsS3BlobProvider`          | Provider      | AWS S3 implementation (sub-path)                      |
-| `BlobHealthIndicator`        | Health        | Terminus health check                                 |
+| `BlobHealthIndicator`        | Health        | Blob storage health check (`/health` subpath)         |
 | `IBlobProvider`              | Interface     | Custom provider contract                              |
 | `BlobProviderKinds`          | Constant      | `'vercel'` \| `'azure'` \| `'aws-s3'` \| `'custom'`   |
 | `BlobDownloadResponseTypes`  | Constant      | `'arraybuffer'` \| `'json'` \| `'stream'` \| `'text'` |

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

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: MemoryLayeredCache\<TKey, TValue\>
 
-Defined in: [MemoryLayeredCache.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L72)
+Defined in: [memory/MemoryLayeredCache.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L72)
 
 In-memory layered cache with LRU eviction, TTL expiration and
 optional stale-while-revalidate support. Falls back to an
@@ -30,7 +30,7 @@ asynchronous loader function on cache misses.
 new MemoryLayeredCache<TKey, TValue>(loadFn, options?): MemoryLayeredCache<TKey, TValue>;
 ```
 
-Defined in: [MemoryLayeredCache.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L97)
+Defined in: [memory/MemoryLayeredCache.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L97)
 
 Initializes a new instance of the MemoryLayeredCache class.
 
@@ -53,7 +53,7 @@ Initializes a new instance of the MemoryLayeredCache class.
 get(key): TValue | undefined;
 ```
 
-Defined in: [MemoryLayeredCache.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L109)
+Defined in: [memory/MemoryLayeredCache.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L109)
 
 Retrieves a value from the cache synchronously.
 
@@ -81,7 +81,7 @@ The cached value or `undefined` on a miss.
 getAsync(key): Promise<TValue | undefined>;
 ```
 
-Defined in: [MemoryLayeredCache.ts:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L130)
+Defined in: [memory/MemoryLayeredCache.ts:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L130)
 
 Retrieves a value from the cache asynchronously.
 
@@ -109,7 +109,7 @@ A promise resolving to the cached value or `undefined` on a miss.
 invalidate(key): void;
 ```
 
-Defined in: [MemoryLayeredCache.ts:176](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L176)
+Defined in: [memory/MemoryLayeredCache.ts:176](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L176)
 
 Invalidates a key in the cache synchronously.
 
@@ -135,7 +135,7 @@ Invalidates a key in the cache synchronously.
 invalidateAsync(key): Promise<void>;
 ```
 
-Defined in: [MemoryLayeredCache.ts:181](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L181)
+Defined in: [memory/MemoryLayeredCache.ts:181](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L181)
 
 Invalidates a key in the cache asynchronously.
 
@@ -161,7 +161,7 @@ Invalidates a key in the cache asynchronously.
 set(key, value): void;
 ```
 
-Defined in: [MemoryLayeredCache.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L152)
+Defined in: [memory/MemoryLayeredCache.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L152)
 
 Stores a value in the cache synchronously.
 
@@ -188,7 +188,7 @@ Stores a value in the cache synchronously.
 setAsync(key, value): Promise<void>;
 ```
 
-Defined in: [MemoryLayeredCache.ts:161](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L161)
+Defined in: [memory/MemoryLayeredCache.ts:161](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L161)
 
 Stores a value in the cache asynchronously.
 
@@ -215,7 +215,7 @@ Stores a value in the cache asynchronously.
 stats(): ICacheStats;
 ```
 
-Defined in: [MemoryLayeredCache.ts:186](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L186)
+Defined in: [memory/MemoryLayeredCache.ts:186](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L186)
 
 Returns current cache statistics.
 
@@ -237,7 +237,7 @@ The cache statistics snapshot.
 warm(key): Promise<TValue | undefined>;
 ```
 
-Defined in: [MemoryLayeredCache.ts:170](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L170)
+Defined in: [memory/MemoryLayeredCache.ts:170](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/memory/MemoryLayeredCache.ts#L170)
 
 Proactively warms the cache for a given key.
 

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

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: NoopCacheMetricsRecorder
 
-Defined in: [NoopCacheMetricsRecorder.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L13)
+Defined in: [metrics/noop/NoopCacheMetricsRecorder.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/metrics/noop/NoopCacheMetricsRecorder.ts#L13)
 
 No-op implementation of [ICacheMetricsRecorder](Interface.ICacheMetricsRecorder) used as the default
 when no external metrics backend is configured.
@@ -34,7 +34,7 @@ new NoopCacheMetricsRecorder(): NoopCacheMetricsRecorder;
 optional recordEviction(_cache): void;
 ```
 
-Defined in: [NoopCacheMetricsRecorder.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L37)
+Defined in: [metrics/noop/NoopCacheMetricsRecorder.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/metrics/noop/NoopCacheMetricsRecorder.ts#L37)
 
 Records a cache eviction.
 
@@ -60,7 +60,7 @@ Records a cache eviction.
 recordHit(_cache): void;
 ```
 
-Defined in: [NoopCacheMetricsRecorder.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L17)
+Defined in: [metrics/noop/NoopCacheMetricsRecorder.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/metrics/noop/NoopCacheMetricsRecorder.ts#L17)
 
 Records a cache hit.
 
@@ -86,7 +86,7 @@ Records a cache hit.
 recordLoadError(_cache): void;
 ```
 
-Defined in: [NoopCacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L32)
+Defined in: [metrics/noop/NoopCacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/metrics/noop/NoopCacheMetricsRecorder.ts#L32)
 
 Records a failed cache load.
 
@@ -112,7 +112,7 @@ Records a failed cache load.
 recordLoadSuccess(_cache): void;
 ```
 
-Defined in: [NoopCacheMetricsRecorder.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L27)
+Defined in: [metrics/noop/NoopCacheMetricsRecorder.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/metrics/noop/NoopCacheMetricsRecorder.ts#L27)
 
 Records a successful cache load.
 
@@ -138,7 +138,7 @@ Records a successful cache load.
 recordMiss(_cache): void;
 ```
 
-Defined in: [NoopCacheMetricsRecorder.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L22)
+Defined in: [metrics/noop/NoopCacheMetricsRecorder.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/metrics/noop/NoopCacheMetricsRecorder.ts#L22)
 
 Records a cache miss.
 

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,7 +58,7 @@ 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.
 
@@ -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,7 +116,7 @@ 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.
 
@@ -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,7 +194,7 @@ 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.
 
@@ -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.