@breadstone/archipel-mcp 0.0.7 → 0.0.8

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

@@ -0,0 +1,296 @@
+---
+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)
+
+Redis-backed layered cache implementation. Falls back to an asynchronous
+loader function when the requested key is not present in Redis.
+
+## Remarks
+
+Synchronous methods (`get`, `set`, `invalidate`) throw because Redis
+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. |
+
+## Implements
+
+- [`ILayeredCache`](Interface.ILayeredCache)\<`TKey`, `TValue`\>
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+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)
+
+Initializes a new instance of the RedisLayeredCache class.
+
+#### Parameters
+
+| 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
+
+`RedisLayeredCache`\<`TKey`, `TValue`\>
+
+## Methods
+
+### get()
+
+```ts
+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)
+
+Not supported — Redis is inherently asynchronous.
+
+#### Parameters
+
+| Parameter | Type   |
+| --------- | ------ |
+| `key`     | `TKey` |
+
+#### Returns
+
+`TValue` \| `undefined`
+
+#### Throws
+
+Always throws. Use [getAsync](#getasync) instead.
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`get`](Interface.ILayeredCache#get)
+
+---
+
+### getAsync()
+
+```ts
+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)
+
+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.
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`getAsync`](Interface.ILayeredCache#getasync)
+
+---
+
+### invalidate()
+
+```ts
+invalidate(key): void;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:188](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L188)
+
+Not supported — Redis is inherently asynchronous.
+
+#### Parameters
+
+| Parameter | Type   |
+| --------- | ------ |
+| `key`     | `TKey` |
+
+#### Returns
+
+`void`
+
+#### Throws
+
+Always throws. Use [invalidateAsync](#invalidateasync) instead.
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`invalidate`](Interface.ILayeredCache#invalidate)
+
+---
+
+### invalidateAsync()
+
+```ts
+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)
+
+Invalidates a key in the cache asynchronously.
+
+#### Parameters
+
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`invalidateAsync`](Interface.ILayeredCache#invalidateasync)
+
+---
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): Promise<void>;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:214](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L214)
+
+Gracefully disconnects the Redis client when the NestJS module is destroyed.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy;
+```
+
+---
+
+### set()
+
+```ts
+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)
+
+Not supported — Redis is inherently asynchronous.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `key`     | `TKey`   |
+| `value`   | `TValue` |
+
+#### Returns
+
+`void`
+
+#### Throws
+
+Always throws. Use [setAsync](#setasync) instead.
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`set`](Interface.ILayeredCache#set)
+
+---
+
+### setAsync()
+
+```ts
+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)
+
+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`\>
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`setAsync`](Interface.ILayeredCache#setasync)
+
+---
+
+### stats()
+
+```ts
+stats(): ICacheStats;
+```
+
+Defined in: [redis/RedisLayeredCache.ts:202](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L202)
+
+Returns current cache statistics.
+
+#### Returns
+
+[`ICacheStats`](Interface.ICacheStats)
+
+The cache statistics snapshot.
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`stats`](Interface.ILayeredCache#stats)
+
+---
+
+### warm()
+
+```ts
+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)
+
+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.
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`warm`](Interface.ILayeredCache#warm)

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.