@breadstone/archipel-mcp 0.0.7 → 0.0.8

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

@@ -1,275 +0,0 @@
----
-title: 'Class: RedisLayeredCache\<TKey, TValue\>'
-generated: true
-editUrl: false
----
-
-# Class: RedisLayeredCache\<TKey, TValue\>
-
-Defined in: [cache/RedisLayeredCache.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L27)
-
-Generic layered cache contract (DB first, then memory, then external fetcher).
-
-## 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: [cache/RedisLayeredCache.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L46)
-
-#### Parameters
-
-| Parameter | Type                                                                           |
-| --------- | ------------------------------------------------------------------------------ |
-| `loadFn`  | (`key`) => `Promise`\<`TValue` \| `undefined`\>                                |
-| `options` | [`IRedisLayeredCacheOptions`](Interface.IRedisLayeredCacheOptions)\<`TValue`\> |
-
-#### Returns
-
-`RedisLayeredCache`\<`TKey`, `TValue`\>
-
-## Methods
-
-### get()
-
-```ts
-get(key): TValue | undefined;
-```
-
-Defined in: [cache/RedisLayeredCache.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L65)
-
-Retrieves a value from the cache.
-Note: Redis is inherently async, so this throws an error.
-
-#### Parameters
-
-| Parameter | Type   | Description          |
-| --------- | ------ | -------------------- |
-| `key`     | `TKey` | The key to retrieve. |
-
-#### Returns
-
-`TValue` \| `undefined`
-
-#### Implementation of
-
-[`ILayeredCache`](Interface.ILayeredCache).[`get`](Interface.ILayeredCache#get)
-
----
-
-### getAsync()
-
-```ts
-getAsync(key): Promise<TValue | undefined>;
-```
-
-Defined in: [cache/RedisLayeredCache.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L75)
-
-Retrieves a value from the cache (asynchronous).
-
-#### Parameters
-
-| Parameter | Type   | Description          |
-| --------- | ------ | -------------------- |
-| `key`     | `TKey` | The key to retrieve. |
-
-#### Returns
-
-`Promise`\<`TValue` \| `undefined`\>
-
-#### Implementation of
-
-[`ILayeredCache`](Interface.ILayeredCache).[`getAsync`](Interface.ILayeredCache#getasync)
-
----
-
-### invalidate()
-
-```ts
-invalidate(key): void;
-```
-
-Defined in: [cache/RedisLayeredCache.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L142)
-
-Invalidates a key in the cache.
-Note: Redis is inherently async, so this throws an error.
-
-#### Parameters
-
-| Parameter | Type   | Description            |
-| --------- | ------ | ---------------------- |
-| `key`     | `TKey` | The key to invalidate. |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`ILayeredCache`](Interface.ILayeredCache).[`invalidate`](Interface.ILayeredCache#invalidate)
-
----
-
-### invalidateAsync()
-
-```ts
-invalidateAsync(key): Promise<void>;
-```
-
-Defined in: [cache/RedisLayeredCache.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L152)
-
-Invalidates a key in the cache (asynchronous).
-
-#### 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: [cache/RedisLayeredCache.ts:169](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L169)
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Implementation of
-
-```ts
-OnModuleDestroy.onModuleDestroy;
-```
-
----
-
-### set()
-
-```ts
-set(key, value): void;
-```
-
-Defined in: [cache/RedisLayeredCache.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L109)
-
-Sets a value in the cache.
-Note: Redis is inherently async, so this throws an error.
-
-#### Parameters
-
-| Parameter | Type     | Description       |
-| --------- | -------- | ----------------- |
-| `key`     | `TKey`   | The key to set.   |
-| `value`   | `TValue` | The value to set. |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`ILayeredCache`](Interface.ILayeredCache).[`set`](Interface.ILayeredCache#set)
-
----
-
-### setAsync()
-
-```ts
-setAsync(key, value): Promise<void>;
-```
-
-Defined in: [cache/RedisLayeredCache.ts:120](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L120)
-
-Sets a value in the cache (asynchronous).
-
-#### Parameters
-
-| Parameter | Type     | Description       |
-| --------- | -------- | ----------------- |
-| `key`     | `TKey`   | The key to set.   |
-| `value`   | `TValue` | The value to set. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Implementation of
-
-[`ILayeredCache`](Interface.ILayeredCache).[`setAsync`](Interface.ILayeredCache#setasync)
-
----
-
-### stats()
-
-```ts
-stats(): ICacheStats;
-```
-
-Defined in: [cache/RedisLayeredCache.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L160)
-
-Retrieves cache statistics.
-
-#### Returns
-
-[`ICacheStats`](Interface.ICacheStats)
-
-The cache statistics.
-
-#### Implementation of
-
-[`ILayeredCache`](Interface.ILayeredCache).[`stats`](Interface.ILayeredCache#stats)
-
----
-
-### warm()
-
-```ts
-warm(key): Promise<TValue | undefined>;
-```
-
-Defined in: [cache/RedisLayeredCache.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L131)
-
-Proactively warms the cache for a given key (optional).
-
-#### 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-core/api/Interface.ICacheMetricsRecorder.md

@@ -1,121 +0,0 @@
----
-title: 'Interface: ICacheMetricsRecorder'
-generated: true
-editUrl: false
----
-
-# Interface: ICacheMetricsRecorder
-
-Defined in: [cache/ICacheMetricsRecorder.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L6)
-
-Metrics recorder for cache operations. Implementations can forward to Prometheus, OpenTelemetry, etc.
-
-## Methods
-
-### recordEviction()?
-
-```ts
-optional recordEviction(cache): void;
-```
-
-Defined in: [cache/ICacheMetricsRecorder.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L48)
-
-Records a cache eviction.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
----
-
-### recordHit()
-
-```ts
-recordHit(cache): void;
-```
-
-Defined in: [cache/ICacheMetricsRecorder.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L16)
-
-Records a cache hit.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
----
-
-### recordLoadError()
-
-```ts
-recordLoadError(cache): void;
-```
-
-Defined in: [cache/ICacheMetricsRecorder.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L40)
-
-Records a failed cache load.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
----
-
-### recordLoadSuccess()
-
-```ts
-recordLoadSuccess(cache): void;
-```
-
-Defined in: [cache/ICacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L32)
-
-Records a successful cache load.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
----
-
-### recordMiss()
-
-```ts
-recordMiss(cache): void;
-```
-
-Defined in: [cache/ICacheMetricsRecorder.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L24)
-
-Records a cache miss.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
-
-#### Returns
-
-`void`

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

@@ -1,71 +0,0 @@
----
-title: 'Interface: ICacheStats'
-generated: true
-editUrl: false
----
-
-# Interface: ICacheStats
-
-Defined in: [cache/ICacheStats.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L6)
-
-Cache statistics.
-
-## Properties
-
-### evictions?
-
-```ts
-optional evictions?: number;
-```
-
-Defined in: [cache/ICacheStats.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L42)
-
-Number of cache evictions (if supported).
-
----
-
-### hits
-
-```ts
-hits: number;
-```
-
-Defined in: [cache/ICacheStats.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L14)
-
-Number of cache hits.
-
----
-
-### loadErrors
-
-```ts
-loadErrors: number;
-```
-
-Defined in: [cache/ICacheStats.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L35)
-
-Number of failed cache loads.
-
----
-
-### loads
-
-```ts
-loads: number;
-```
-
-Defined in: [cache/ICacheStats.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L28)
-
-Number of successful cache loads.
-
----
-
-### misses
-
-```ts
-misses: number;
-```
-
-Defined in: [cache/ICacheStats.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L21)
-
-Number of cache misses.

package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md

@@ -1,31 +0,0 @@
----
-title: 'Interface: IIntelligenceArtifact'
-generated: true
-editUrl: false
----
-
-# Interface: IIntelligenceArtifact
-
-Defined in: [intelligence/contracts/IIntelligenceArtifact.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceArtifact.ts#L10)
-
-Represents a structured artifact returned by a capability.
-
-## Properties
-
-### data
-
-```ts
-readonly data: Record<string, unknown>;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceArtifact.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceArtifact.ts#L14)
-
----
-
-### type
-
-```ts
-readonly type: string;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceArtifact.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceArtifact.ts#L13)

package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md

@@ -1,62 +0,0 @@
----
-title: 'Interface: IIntelligenceCapability'
-generated: true
-editUrl: false
----
-
-# Interface: IIntelligenceCapability
-
-Defined in: [intelligence/contracts/IIntelligenceCapability.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapability.ts#L16)
-
-Abstraction implemented by all capability providers.
-
-## Properties
-
-### metadata
-
-```ts
-readonly metadata: IIntelligenceCapabilityMetadata;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapability.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapability.ts#L19)
-
-## Methods
-
-### canHandle()
-
-```ts
-canHandle(intent, context): boolean;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapability.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapability.ts#L25)
-
-#### Parameters
-
-| Parameter | Type                                                     |
-| --------- | -------------------------------------------------------- |
-| `intent`  | [`IIntelligenceIntent`](Interface.IIntelligenceIntent)   |
-| `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) |
-
-#### Returns
-
-`boolean`
-
----
-
-### execute()
-
-```ts
-execute(payload): Promise<IIntelligenceCapabilityResult>;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapability.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapability.ts#L26)
-
-#### Parameters
-
-| Parameter | Type                                                                         |
-| --------- | ---------------------------------------------------------------------------- |
-| `payload` | [`IIntelligenceCapabilityPayload`](Interface.IIntelligenceCapabilityPayload) |
-
-#### Returns
-
-`Promise`\<[`IIntelligenceCapabilityResult`](Interface.IIntelligenceCapabilityResult)\>

package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md

@@ -1,61 +0,0 @@
----
-title: 'Interface: IIntelligenceCapabilityMetadata'
-generated: true
-editUrl: false
----
-
-# Interface: IIntelligenceCapabilityMetadata
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L10)
-
-Metadata describing a capability for orchestration and analytics purposes.
-
-## Properties
-
-### description
-
-```ts
-readonly description: string;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L15)
-
----
-
-### id
-
-```ts
-readonly id: string;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L13)
-
----
-
-### intentName
-
-```ts
-readonly intentName: string;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L17)
-
----
-
-### name
-
-```ts
-readonly name: string;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L14)
-
----
-
-### priority
-
-```ts
-readonly priority: number;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L16)

package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md

@@ -1,41 +0,0 @@
----
-title: 'Interface: IIntelligenceCapabilityPayload'
-generated: true
-editUrl: false
----
-
-# Interface: IIntelligenceCapabilityPayload
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityPayload.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityPayload.ts#L13)
-
-Payload forwarded to capabilities for execution.
-
-## Properties
-
-### context
-
-```ts
-readonly context: IIntelligenceContext;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityPayload.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityPayload.ts#L17)
-
----
-
-### intent
-
-```ts
-readonly intent: IIntelligenceIntent;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityPayload.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityPayload.ts#L16)
-
----
-
-### userMessage
-
-```ts
-readonly userMessage: string;
-```
-
-Defined in: [intelligence/contracts/IIntelligenceCapabilityPayload.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityPayload.ts#L18)