@breadstone/archipel-mcp 0.0.8 → 0.0.10

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

@@ -3,10 +3,9 @@ title: 'Class: RedisLayeredCache\<TKey, TValue\>'
 generated: true
 editUrl: false
 ---
-
 # Class: RedisLayeredCache\<TKey, TValue\>
 
-Defined in: [redis/RedisLayeredCache.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L84)
+Defined in: [redis/RedisLayeredCache.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L83)
 
 Redis-backed layered cache implementation. Falls back to an asynchronous
 loader function when the requested key is not present in Redis.
@@ -18,10 +17,10 @@ is inherently asynchronous. Use the `*Async` variants instead.
 
 ## Type Parameters
 
-| Type Parameter | Description                   |
-| -------------- | ----------------------------- |
-| `TKey`         | The type of the cache keys.   |
-| `TValue`       | The type of the cache values. |
+| Type Parameter | Description |
+| ------ | ------ |
+| `TKey` | The type of the cache keys. |
+| `TValue` | The type of the cache values. |
 
 ## Implements
 
@@ -36,15 +35,15 @@ is inherently asynchronous. Use the `*Async` variants instead.
 new RedisLayeredCache<TKey, TValue>(loadFn, options): RedisLayeredCache<TKey, TValue>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L109)
+Defined in: [redis/RedisLayeredCache.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L107)
 
 Initializes a new instance of the RedisLayeredCache class.
 
 #### Parameters
 
-| Parameter | Type                                                                           | Description                                         |
-| --------- | ------------------------------------------------------------------------------ | --------------------------------------------------- |
-| `loadFn`  | (`key`) => `Promise`\<`TValue` \| `undefined`\>                                | Async loader invoked on cache misses.               |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `loadFn` | (`key`) => `Promise`\<`TValue` \| `undefined`\> | Async loader invoked on cache misses. |
 | `options` | [`IRedisLayeredCacheOptions`](Interface.IRedisLayeredCacheOptions)\<`TValue`\> | Redis connection and cache behaviour configuration. |
 
 #### Returns
@@ -59,15 +58,15 @@ Initializes a new instance of the RedisLayeredCache class.
 get(key): TValue | undefined;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L126)
+Defined in: [redis/RedisLayeredCache.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L124)
 
 Not supported — Redis is inherently asynchronous.
 
 #### Parameters
 
-| Parameter | Type   |
-| --------- | ------ |
-| `key`     | `TKey` |
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `TKey` |
 
 #### Returns
 
@@ -81,7 +80,7 @@ Always throws. Use [getAsync](#getasync) instead.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`get`](Interface.ILayeredCache#get)
 
----
+***
 
 ### getAsync()
 
@@ -89,15 +88,15 @@ Always throws. Use [getAsync](#getasync) instead.
 getAsync(key): Promise<TValue | undefined>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L131)
+Defined in: [redis/RedisLayeredCache.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L129)
 
 Retrieves a value from the cache asynchronously.
 
 #### Parameters
 
-| Parameter | Type   | Description          |
-| --------- | ------ | -------------------- |
-| `key`     | `TKey` | The key to retrieve. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `TKey` | The key to retrieve. |
 
 #### Returns
 
@@ -109,7 +108,7 @@ A promise resolving to the cached value or `undefined` on a miss.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`getAsync`](Interface.ILayeredCache#getasync)
 
----
+***
 
 ### invalidate()
 
@@ -117,15 +116,15 @@ A promise resolving to the cached value or `undefined` on a miss.
 invalidate(key): void;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:188](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L188)
+Defined in: [redis/RedisLayeredCache.ts:186](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L186)
 
 Not supported — Redis is inherently asynchronous.
 
 #### Parameters
 
-| Parameter | Type   |
-| --------- | ------ |
-| `key`     | `TKey` |
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `TKey` |
 
 #### Returns
 
@@ -139,7 +138,7 @@ Always throws. Use [invalidateAsync](#invalidateasync) instead.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`invalidate`](Interface.ILayeredCache#invalidate)
 
----
+***
 
 ### invalidateAsync()
 
@@ -153,9 +152,9 @@ Invalidates a key in the cache asynchronously.
 
 #### Parameters
 
-| Parameter | Type   | Description            |
-| --------- | ------ | ---------------------- |
-| `key`     | `TKey` | The key to invalidate. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `TKey` | The key to invalidate. |
 
 #### Returns
 
@@ -165,7 +164,7 @@ Invalidates a key in the cache asynchronously.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`invalidateAsync`](Interface.ILayeredCache#invalidateasync)
 
----
+***
 
 ### onModuleDestroy()
 
@@ -184,10 +183,10 @@ Gracefully disconnects the Redis client when the NestJS module is destroyed.
 #### Implementation of
 
 ```ts
-OnModuleDestroy.onModuleDestroy;
+OnModuleDestroy.onModuleDestroy
 ```
 
----
+***
 
 ### set()
 
@@ -195,16 +194,16 @@ OnModuleDestroy.onModuleDestroy;
 set(key, value): void;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:162](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L162)
+Defined in: [redis/RedisLayeredCache.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L160)
 
 Not supported — Redis is inherently asynchronous.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `key`     | `TKey`   |
-| `value`   | `TValue` |
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `TKey` |
+| `value` | `TValue` |
 
 #### Returns
 
@@ -218,7 +217,7 @@ Always throws. Use [setAsync](#setasync) instead.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`set`](Interface.ILayeredCache#set)
 
----
+***
 
 ### setAsync()
 
@@ -226,16 +225,16 @@ Always throws. Use [setAsync](#setasync) instead.
 setAsync(key, value): Promise<void>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:167](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L167)
+Defined in: [redis/RedisLayeredCache.ts:165](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L165)
 
 Stores a value in the cache asynchronously.
 
 #### Parameters
 
-| Parameter | Type     | Description         |
-| --------- | -------- | ------------------- |
-| `key`     | `TKey`   | The key to store.   |
-| `value`   | `TValue` | The value to store. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `TKey` | The key to store. |
+| `value` | `TValue` | The value to store. |
 
 #### Returns
 
@@ -245,7 +244,7 @@ Stores a value in the cache asynchronously.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`setAsync`](Interface.ILayeredCache#setasync)
 
----
+***
 
 ### stats()
 
@@ -267,7 +266,7 @@ The cache statistics snapshot.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`stats`](Interface.ILayeredCache#stats)
 
----
+***
 
 ### warm()
 
@@ -275,15 +274,15 @@ The cache statistics snapshot.
 warm(key): Promise<TValue | undefined>;
 ```
 
-Defined in: [redis/RedisLayeredCache.ts:179](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L179)
+Defined in: [redis/RedisLayeredCache.ts:177](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L177)
 
 Proactively warms the cache for a given key.
 
 #### Parameters
 
-| Parameter | Type   | Description      |
-| --------- | ------ | ---------------- |
-| `key`     | `TKey` | The key to warm. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `TKey` | The key to warm. |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Interface: ICacheMetricsRecorder'
 generated: true
 editUrl: false
 ---
-
 # Interface: ICacheMetricsRecorder
 
 Defined in: [ICacheMetricsRecorder.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L7)
@@ -19,21 +18,21 @@ measurements to Prometheus, OpenTelemetry, or any other backend.
 optional recordEviction(cache): void;
 ```
 
-Defined in: [ICacheMetricsRecorder.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L49)
+Defined in: [ICacheMetricsRecorder.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L48)
 
 Records a cache eviction.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `cache`   | `string` | The cache name / label. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name / label. |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### recordHit()
 
@@ -41,21 +40,21 @@ Records a cache eviction.
 recordHit(cache): void;
 ```
 
-Defined in: [ICacheMetricsRecorder.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L17)
+Defined in: [ICacheMetricsRecorder.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L16)
 
 Records a cache hit.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `cache`   | `string` | The cache name / label. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name / label. |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### recordLoadError()
 
@@ -63,21 +62,21 @@ Records a cache hit.
 recordLoadError(cache): void;
 ```
 
-Defined in: [ICacheMetricsRecorder.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L41)
+Defined in: [ICacheMetricsRecorder.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L40)
 
 Records a failed cache load.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `cache`   | `string` | The cache name / label. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name / label. |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### recordLoadSuccess()
 
@@ -85,21 +84,21 @@ Records a failed cache load.
 recordLoadSuccess(cache): void;
 ```
 
-Defined in: [ICacheMetricsRecorder.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L33)
+Defined in: [ICacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L32)
 
 Records a successful cache load.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `cache`   | `string` | The cache name / label. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name / label. |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### recordMiss()
 
@@ -107,15 +106,15 @@ Records a successful cache load.
 recordMiss(cache): void;
 ```
 
-Defined in: [ICacheMetricsRecorder.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L25)
+Defined in: [ICacheMetricsRecorder.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L24)
 
 Records a cache miss.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `cache`   | `string` | The cache name / label. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name / label. |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Interface: ICacheStats'
 generated: true
 editUrl: false
 ---
-
 # Interface: ICacheStats
 
 Defined in: [ICacheStats.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L6)
@@ -18,11 +17,11 @@ Cache statistics snapshot returned by cache implementations.
 optional evictions?: number;
 ```
 
-Defined in: [ICacheStats.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L43)
+Defined in: [ICacheStats.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L42)
 
 Number of cache evictions (if supported).
 
----
+***
 
 ### hits
 
@@ -30,11 +29,11 @@ Number of cache evictions (if supported).
 hits: number;
 ```
 
-Defined in: [ICacheStats.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L15)
+Defined in: [ICacheStats.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L14)
 
 Number of cache hits.
 
----
+***
 
 ### loadErrors
 
@@ -42,11 +41,11 @@ Number of cache hits.
 loadErrors: number;
 ```
 
-Defined in: [ICacheStats.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L36)
+Defined in: [ICacheStats.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L35)
 
 Number of failed cache loads.
 
----
+***
 
 ### loads
 
@@ -54,11 +53,11 @@ Number of failed cache loads.
 loads: number;
 ```
 
-Defined in: [ICacheStats.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L29)
+Defined in: [ICacheStats.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L28)
 
 Number of successful cache loads.
 
----
+***
 
 ### misses
 
@@ -66,6 +65,6 @@ Number of successful cache loads.
 misses: number;
 ```
 
-Defined in: [ICacheStats.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L22)
+Defined in: [ICacheStats.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L21)
 
 Number of cache misses.