@breadstone/archipel-mcp 0.0.6 → 0.0.8

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

@@ -0,0 +1,122 @@
+---
+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)
+
+Metrics recorder for cache operations. Implementations can forward
+measurements to Prometheus, OpenTelemetry, or any other backend.
+
+## Methods
+
+### recordEviction()?
+
+```ts
+optional recordEviction(cache): void;
+```
+
+Defined in: [ICacheMetricsRecorder.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L49)
+
+Records a cache eviction.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
+
+#### Returns
+
+`void`
+
+---
+
+### recordHit()
+
+```ts
+recordHit(cache): void;
+```
+
+Defined in: [ICacheMetricsRecorder.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L17)
+
+Records a cache hit.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
+
+#### Returns
+
+`void`
+
+---
+
+### recordLoadError()
+
+```ts
+recordLoadError(cache): void;
+```
+
+Defined in: [ICacheMetricsRecorder.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L41)
+
+Records a failed cache load.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
+
+#### Returns
+
+`void`
+
+---
+
+### recordLoadSuccess()
+
+```ts
+recordLoadSuccess(cache): void;
+```
+
+Defined in: [ICacheMetricsRecorder.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L33)
+
+Records a successful cache load.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
+
+#### Returns
+
+`void`
+
+---
+
+### recordMiss()
+
+```ts
+recordMiss(cache): void;
+```
+
+Defined in: [ICacheMetricsRecorder.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L25)
+
+Records a cache miss.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,71 @@
+---
+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)
+
+Cache statistics snapshot returned by cache implementations.
+
+## Properties
+
+### evictions?
+
+```ts
+optional evictions?: number;
+```
+
+Defined in: [ICacheStats.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L43)
+
+Number of cache evictions (if supported).
+
+---
+
+### hits
+
+```ts
+hits: number;
+```
+
+Defined in: [ICacheStats.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L15)
+
+Number of cache hits.
+
+---
+
+### loadErrors
+
+```ts
+loadErrors: number;
+```
+
+Defined in: [ICacheStats.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L36)
+
+Number of failed cache loads.
+
+---
+
+### loads
+
+```ts
+loads: number;
+```
+
+Defined in: [ICacheStats.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L29)
+
+Number of successful cache loads.
+
+---
+
+### misses
+
+```ts
+misses: number;
+```
+
+Defined in: [ICacheStats.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L22)
+
+Number of cache misses.

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

@@ -0,0 +1,199 @@
+---
+title: 'Interface: ILayeredCache\<TKey, TValue\>'
+generated: true
+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)
+
+Generic layered cache contract supporting synchronous and asynchronous
+access patterns with optional warm-up and statistics.
+
+## Type Parameters
+
+| Type Parameter | Description                   |
+| -------------- | ----------------------------- |
+| `TKey`         | The type of the cache keys.   |
+| `TValue`       | The type of the cache values. |
+
+## Methods
+
+### get()
+
+```ts
+get(key): TValue | undefined;
+```
+
+Defined in: [ILayeredCache.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L26)
+
+Retrieves a value from the cache synchronously.
+
+#### Parameters
+
+| Parameter | Type   | Description          |
+| --------- | ------ | -------------------- |
+| `key`     | `TKey` | The key to retrieve. |
+
+#### Returns
+
+`TValue` \| `undefined`
+
+The cached value or `undefined` on a miss.
+
+---
+
+### getAsync()
+
+```ts
+getAsync(key): Promise<TValue | undefined>;
+```
+
+Defined in: [ILayeredCache.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L35)
+
+Retrieves a value from the cache asynchronously.
+
+#### Parameters
+
+| Parameter | Type   | Description          |
+| --------- | ------ | -------------------- |
+| `key`     | `TKey` | The key to retrieve. |
+
+#### Returns
+
+`Promise`\<`TValue` \| `undefined`\>
+
+A promise resolving to the cached value or `undefined` on a miss.
+
+---
+
+### invalidate()
+
+```ts
+invalidate(key): void;
+```
+
+Defined in: [ILayeredCache.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L70)
+
+Invalidates a key in the cache synchronously.
+
+#### Parameters
+
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
+
+#### Returns
+
+`void`
+
+---
+
+### invalidateAsync()
+
+```ts
+invalidateAsync(key): Promise<void>;
+```
+
+Defined in: [ILayeredCache.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L78)
+
+Invalidates a key in the cache asynchronously.
+
+#### Parameters
+
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### set()
+
+```ts
+set(key, value): void;
+```
+
+Defined in: [ILayeredCache.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L44)
+
+Stores a value in the cache synchronously.
+
+#### Parameters
+
+| Parameter | Type     | Description         |
+| --------- | -------- | ------------------- |
+| `key`     | `TKey`   | The key to store.   |
+| `value`   | `TValue` | The value to store. |
+
+#### Returns
+
+`void`
+
+---
+
+### setAsync()
+
+```ts
+setAsync(key, value): Promise<void>;
+```
+
+Defined in: [ILayeredCache.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L53)
+
+Stores a value in the cache asynchronously.
+
+#### Parameters
+
+| Parameter | Type     | Description         |
+| --------- | -------- | ------------------- |
+| `key`     | `TKey`   | The key to store.   |
+| `value`   | `TValue` | The value to store. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### stats()?
+
+```ts
+optional stats(): ICacheStats;
+```
+
+Defined in: [ILayeredCache.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L86)
+
+Returns current cache statistics.
+
+#### Returns
+
+[`ICacheStats`](Interface.ICacheStats)
+
+The cache statistics snapshot.
+
+---
+
+### warm()?
+
+```ts
+optional warm(key): Promise<TValue | undefined>;
+```
+
+Defined in: [ILayeredCache.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L62)
+
+Proactively warms the cache for a given key.
+
+#### Parameters
+
+| Parameter | Type   | Description      |
+| --------- | ------ | ---------------- |
+| `key`     | `TKey` | The key to warm. |
+
+#### Returns
+
+`Promise`\<`TValue` \| `undefined`\>
+
+The value that was loaded and cached, or `undefined` if not found.

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

@@ -0,0 +1,76 @@
+---
+title: 'Interface: ILayeredCacheOptions'
+generated: true
+editUrl: false
+---
+
+# Interface: ILayeredCacheOptions
+
+Defined in: [MemoryLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L16)
+
+Configuration options for [MemoryLayeredCache](Class.MemoryLayeredCache).
+
+## Properties
+
+### cacheName?
+
+```ts
+optional cacheName?: string;
+```
+
+Defined in: [MemoryLayeredCache.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L58)
+
+An optional name / label for the cache instance, used in metrics.
+Defaults to `'memory'`.
+
+---
+
+### maxEntries?
+
+```ts
+optional maxEntries?: number;
+```
+
+Defined in: [MemoryLayeredCache.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L42)
+
+Maximum number of entries retained in the cache. Oldest entries are
+evicted first (LRU). Defaults to infinite.
+
+---
+
+### metricsRecorder?
+
+```ts
+optional metricsRecorder?: ICacheMetricsRecorder;
+```
+
+Defined in: [MemoryLayeredCache.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L50)
+
+Optional metrics recorder forwarded cache operation statistics.
+Falls back to [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) when omitted.
+
+---
+
+### staleWhileRevalidate?
+
+```ts
+optional staleWhileRevalidate?: boolean;
+```
+
+Defined in: [MemoryLayeredCache.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L34)
+
+When `true`, expired entries are served immediately while a background
+refresh is triggered. Defaults to `false`.
+
+---
+
+### ttlMs?
+
+```ts
+optional ttlMs?: number;
+```
+
+Defined in: [MemoryLayeredCache.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L26)
+
+Time to live in milliseconds. Entries older than this are considered expired.
+Defaults to infinite (no expiration).

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

@@ -0,0 +1,122 @@
+---
+title: 'Interface: IRedisLayeredCacheOptions\<TValue\>'
+generated: true
+editUrl: false
+---
+
+# Interface: IRedisLayeredCacheOptions\<TValue\>
+
+Defined in: [redis/RedisLayeredCache.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L18)
+
+Configuration options for [RedisLayeredCache](Class.RedisLayeredCache).
+
+## Type Parameters
+
+| Type Parameter | Description                              |
+| -------------- | ---------------------------------------- |
+| `TValue`       | The type of values stored in this cache. |
+
+## Properties
+
+### cacheName?
+
+```ts
+optional cacheName?: string;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L68)
+
+An optional name / label for the cache instance, used in metrics.
+Defaults to `'redis'`.
+
+---
+
+### deserialize?
+
+```ts
+optional deserialize?: (raw) => TValue;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L53)
+
+Custom deserialization function. Defaults to `JSON.parse`.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `raw`     | `string` |
+
+#### Returns
+
+`TValue`
+
+---
+
+### keyPrefix
+
+```ts
+keyPrefix: string;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L32)
+
+Key prefix applied to all Redis keys managed by this cache instance.
+
+---
+
+### metricsRecorder?
+
+```ts
+optional metricsRecorder?: ICacheMetricsRecorder;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L60)
+
+Optional metrics recorder forwarded cache operation statistics.
+
+---
+
+### serialize?
+
+```ts
+optional serialize?: (value) => string;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L46)
+
+Custom serialization function. Defaults to `JSON.stringify`.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `value`   | `TValue` |
+
+#### Returns
+
+`string`
+
+---
+
+### ttlSeconds?
+
+```ts
+optional ttlSeconds?: number;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L39)
+
+Optional TTL in seconds applied to every stored entry.
+
+---
+
+### url
+
+```ts
+url: string;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L25)
+
+Redis connection URL (e.g. `redis://localhost:6379`).

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

@@ -0,0 +1,25 @@
+---
+title: '@breadstone/archipel-platform-caching'
+generated: true
+editUrl: false
+---
+
+# @breadstone/archipel-platform-caching
+
+## Classes
+
+| Class                                                      | Description                                                                                                                                                           |
+| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [MemoryLayeredCache](Class.MemoryLayeredCache)             | In-memory layered cache with LRU eviction, TTL expiration and optional stale-while-revalidate support. Falls back to an asynchronous loader function on cache misses. |
+| [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) | No-op implementation of [ICacheMetricsRecorder](Interface.ICacheMetricsRecorder) used as the default when no external metrics backend is configured.                  |
+| [RedisLayeredCache](Class.RedisLayeredCache)               | Redis-backed layered cache implementation. Falls back to an asynchronous loader function when the requested key is not present in Redis.                              |
+
+## Interfaces
+
+| Interface                                                        | Description                                                                                                                         |
+| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| [ICacheMetricsRecorder](Interface.ICacheMetricsRecorder)         | Metrics recorder for cache operations. Implementations can forward measurements to Prometheus, OpenTelemetry, or any other backend. |
+| [ICacheStats](Interface.ICacheStats)                             | Cache statistics snapshot returned by cache implementations.                                                                        |
+| [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).                                                             |