@breadstone/archipel-mcp 0.0.22 → 0.0.25

package/data/packages/platform-health/api/Class.HealthModule.md

@@ -0,0 +1,42 @@
+---
+title: 'Class: HealthModule'
+generated: true
+editUrl: false
+---
+# Class: HealthModule
+
+Defined in: [HealthModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/HealthModule.ts#L15)
+
+## Constructors
+
+### Constructor
+
+```ts
+new HealthModule(): HealthModule;
+```
+
+#### Returns
+
+`HealthModule`
+
+## Methods
+
+### withIndicators()
+
+```ts
+static withIndicators(indicators): DynamicModule;
+```
+
+Defined in: [HealthModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/HealthModule.ts#L21)
+
+Registers additional health indicators.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `indicators` | `Type`\<[`IHealthIndicator`](Interface.IHealthIndicator)\>[] | Array of indicator classes implementing IHealthIndicator |
+
+#### Returns
+
+`DynamicModule`

package/data/packages/platform-health/api/Class.HealthOrchestrator.md

@@ -0,0 +1,64 @@
+---
+title: 'Class: HealthOrchestrator'
+generated: true
+editUrl: false
+---
+# Class: HealthOrchestrator
+
+Defined in: [HealthOrchestrator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/HealthOrchestrator.ts#L15)
+
+Orchestrates execution of all registered health indicators and aggregates their results.
+
+## Constructors
+
+### Constructor
+
+```ts
+new HealthOrchestrator(): HealthOrchestrator;
+```
+
+Defined in: [HealthOrchestrator.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/HealthOrchestrator.ts#L27)
+
+#### Returns
+
+`HealthOrchestrator`
+
+## Methods
+
+### check()
+
+```ts
+check(): Promise<IHealthCheckResult[]>;
+```
+
+Defined in: [HealthOrchestrator.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/HealthOrchestrator.ts#L67)
+
+Executes all registered health indicators and aggregates their results.
+
+#### Returns
+
+`Promise`\<[`IHealthCheckResult`](Interface.IHealthCheckResult)[]\>
+
+The aggregated health check results.
+
+***
+
+### registerIndicator()
+
+```ts
+registerIndicator(indicator): void;
+```
+
+Defined in: [HealthOrchestrator.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/HealthOrchestrator.ts#L41)
+
+Registers a health indicator.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `indicator` | [`IHealthIndicator`](Interface.IHealthIndicator) | The health indicator to register. |
+
+#### Returns
+
+`void`

package/data/packages/platform-health/api/Interface.IHealthCheckResult.md

@@ -0,0 +1,46 @@
+---
+title: 'Interface: IHealthCheckResult'
+generated: true
+editUrl: false
+---
+# Interface: IHealthCheckResult
+
+Defined in: [IHealthCheckResult.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/IHealthCheckResult.ts#L6)
+
+Represents the result of a health check indicator.
+
+## Properties
+
+### details?
+
+```ts
+optional details?: Record<string, unknown>;
+```
+
+Defined in: [IHealthCheckResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/IHealthCheckResult.ts#L20)
+
+Optional additional details about the health check.
+
+***
+
+### name
+
+```ts
+name: string;
+```
+
+Defined in: [IHealthCheckResult.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/IHealthCheckResult.ts#L10)
+
+The name of the health indicator (e.g., 'database', 'app').
+
+***
+
+### status
+
+```ts
+status: "up" | "down";
+```
+
+Defined in: [IHealthCheckResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/IHealthCheckResult.ts#L15)
+
+The status of the health indicator ('up', 'down').

package/data/packages/platform-health/api/Interface.IHealthIndicator.md

@@ -0,0 +1,41 @@
+---
+title: 'Interface: IHealthIndicator'
+generated: true
+editUrl: false
+---
+# Interface: IHealthIndicator
+
+Defined in: [IHealthIndicator.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/IHealthIndicator.ts#L12)
+
+Defines the contract for a health indicator that can be orchestrated.
+
+## Properties
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: [IHealthIndicator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/IHealthIndicator.ts#L14)
+
+Unique key identifying the indicator
+
+## Methods
+
+### check()
+
+```ts
+check(): 
+  | HealthIndicatorResult<string>
+| Promise<HealthIndicatorResult<string>>;
+```
+
+Defined in: [IHealthIndicator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/IHealthIndicator.ts#L17)
+
+Performs the health check and returns a result keyed by the indicator key
+
+#### Returns
+
+  \| `HealthIndicatorResult`\<`string`\>
+  \| `Promise`\<`HealthIndicatorResult`\<`string`\>\>

package/data/packages/platform-health/api/Variable.HEALTH_INDICATORS_TOKEN.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: HEALTH\_INDICATORS\_TOKEN'
+generated: true
+editUrl: false
+---
+# Variable: HEALTH\_INDICATORS\_TOKEN
+
+```ts
+const HEALTH_INDICATORS_TOKEN: typeof HEALTH_INDICATORS_TOKEN;
+```
+
+Defined in: [tokens/HealthTokens.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-health/src/tokens/HealthTokens.ts#L2)
+
+Injection token for registered health indicators

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

@@ -0,0 +1,26 @@
+---
+title: '@breadstone/archipel-platform-health'
+generated: true
+editUrl: false
+---
+# @breadstone/archipel-platform-health
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [HealthModule](Class.HealthModule) | - |
+| [HealthOrchestrator](Class.HealthOrchestrator) | Orchestrates execution of all registered health indicators and aggregates their results. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [IHealthCheckResult](Interface.IHealthCheckResult) | Represents the result of a health check indicator. |
+| [IHealthIndicator](Interface.IHealthIndicator) | Defines the contract for a health indicator that can be orchestrated. |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [HEALTH\_INDICATORS\_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |

package/data/packages/platform-health/index.md

@@ -90,13 +90,24 @@ export class HealthController {
 
 ## Built-in Consumers
 
-Several Archipel libraries automatically register health indicators when imported alongside `platform-health`:
-
-| Library                | Indicator                  | Check                         |
-| ---------------------- | -------------------------- | ----------------------------- |
-| `platform-database`    | `DatabaseHealthIndicator`  | `SELECT 1` ping               |
-| `platform-blob-storage`| `BlobHealthIndicator`      | Blob storage connectivity     |
-| `platform-mailing`     | `MailHealthIndicator`      | Mail server connectivity      |
+All Archipel platform libraries provide health indicators via their `/health` subpath export. Register them with `HealthModule.withIndicators()`:
+
+| Library                  | Indicator                      | Key              | Check                                                     |
+| ------------------------ | ------------------------------ | ---------------- | --------------------------------------------------------- |
+| `platform-database`      | `DatabaseHealthIndicator`      | `database`       | Prisma `SELECT 1` ping                                    |
+| `platform-blob-storage`  | `BlobHealthIndicator`          | `blob`           | HTTP ping to blob URL (or disabled if unconfigured)       |
+| `platform-mailing`       | `MailHealthIndicator`          | `mail`           | Validates mail host, user, and port config                |
+| `platform-caching`       | `CachingHealthIndicator`       | `caching`        | Always `up`                                               |
+| `platform-queue`         | `QueueHealthIndicator`         | `queue`          | Always `up`                                               |
+| `platform-payments`      | `PaymentHealthIndicator`       | `payment`        | `up` if `PaymentClientPort` injected, else `disabled`     |
+| `platform-esigning`      | `EsigningHealthIndicator`      | `esigning`       | `up` if `EsigningClientPort` injected, else `disabled`    |
+| `platform-intelligence`  | `IntelligenceHealthIndicator`  | `intelligence`   | `up` if `IntelligenceCapabilityRegistry` injected, else `disabled` |
+| `platform-analytics`     | `AnalyticsHealthIndicator`     | `analytics`      | `up` if `AnalyticsClientPort` injected, else `disabled`   |
+| `platform-telemetry`     | `TelemetryHealthIndicator`     | `telemetry`      | `up` if `OtelSdkHolder` injected, else `disabled`         |
+| `platform-authentication`| `AuthenticationHealthIndicator`| `authentication` | Always `up`                                               |
+| `platform-mcp`           | `McpHealthIndicator`           | `mcp`            | `up` if `McpRegistryService` injected, else `disabled`    |
+
+See the [Health Indicators guide](../../guides/health-indicators) for full setup instructions.
 
 ---
 
@@ -125,4 +136,4 @@ The `HealthOrchestrator` enforces a maximum of **100** registered indicators. If
 
 ## API Reference
 
-See the auto-generated [API Reference](./api/) for full details on all exported classes, interfaces, and types.
+The auto-generated API reference is published when API docs are generated for this package.

package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md

@@ -0,0 +1,78 @@
+---
+title: 'Class: IntelligenceHealthIndicator'
+generated: true
+editUrl: false
+---
+# Class: IntelligenceHealthIndicator
+
+Defined in: health/IntelligenceHealthIndicator.ts:17
+
+Health indicator for the intelligence infrastructure.
+Verifies that at least one intelligence capability is registered.
+
+## Implements
+
+- `IHealthIndicator`
+
+## Constructors
+
+### Constructor
+
+```ts
+new IntelligenceHealthIndicator(registry?): IntelligenceHealthIndicator;
+```
+
+Defined in: health/IntelligenceHealthIndicator.ts:26
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `registry?` | [`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry) |
+
+#### Returns
+
+`IntelligenceHealthIndicator`
+
+## Properties
+
+### key
+
+```ts
+readonly key: string = 'intelligence';
+```
+
+Defined in: health/IntelligenceHealthIndicator.ts:34
+
+Unique key identifying the indicator
+
+#### Implementation of
+
+```ts
+IHealthIndicator.key
+```
+
+## Methods
+
+### check()
+
+```ts
+check(): HealthIndicatorResult<string>;
+```
+
+Defined in: health/IntelligenceHealthIndicator.ts:47
+
+Verifies that the capability registry contains at least one registered capability.
+Returns disabled status when no registry is configured.
+
+#### Returns
+
+`HealthIndicatorResult`\<`string`\>
+
+The health indicator result.
+
+#### Implementation of
+
+```ts
+IHealthIndicator.check
+```

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

@@ -12,6 +12,7 @@ editUrl: false
 | [IntelligenceCapabilityRegistrarBase](Class.IntelligenceCapabilityRegistrarBase) | Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private. |
 | [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry) | Central registry responsible for resolving intelligence capabilities based on intent metadata. |
 | [IntelligenceConfigurationError](Class.IntelligenceConfigurationError) | Error thrown when an intelligence provider configuration is invalid or missing. |
+| [IntelligenceHealthIndicator](Class.IntelligenceHealthIndicator) | Health indicator for the intelligence infrastructure. Verifies that at least one intelligence capability is registered. |
 | [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure to feature modules. |
 | [IntelligenceProviderError](Class.IntelligenceProviderError) | Error thrown when an intelligence provider call fails. |
 | [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |

package/data/packages/platform-intelligence/index.md

@@ -2,7 +2,7 @@
 title: platform-intelligence
 description: Multi-provider AI text generation with capability registry and intent-based orchestration.
 order: 16
-tags: [intelligence, ai, openai, anthropic, google, grok, text-generation, capability-registry]
+tags: [intelligence, ai, openai, anthropic, google, grok, text-generation, capability-registry, health]
 package: '@breadstone/archipel-platform-intelligence'
 ---
 
@@ -182,6 +182,29 @@ import {
 
 ---
 
+## Health Check
+
+The `IntelligenceHealthIndicator` verifies that an `IntelligenceCapabilityRegistry` is injected. If no registry is available, it reports `disabled: true`. Import it from the `/health` subpath:
+
+```typescript
+import { IntelligenceHealthIndicator } from '@breadstone/archipel-platform-intelligence/health';
+import { HealthModule } from '@breadstone/archipel-platform-health';
+
+@Module({
+  imports: [
+    IntelligenceModule.register({ /* ... */ }),
+    HealthModule.withIndicators([IntelligenceHealthIndicator]),
+  ],
+})
+export class AppModule {}
+```
+
+| Key | Check | Dependencies |
+| --- | ----- | ------------ |
+| `intelligence` | `up` if `IntelligenceCapabilityRegistry` injected, else `disabled` | `@Optional() IntelligenceCapabilityRegistry` |
+
+---
+
 ## API Reference
 
 See the full [API documentation](./api/) for all exported types, interfaces, and classes.

package/data/packages/platform-logging/api/Class.ContextLogger.md

@@ -0,0 +1,152 @@
+---
+title: 'Class: ContextLogger'
+generated: true
+editUrl: false
+---
+# Class: ContextLogger
+
+Defined in: [ContextLogger.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/ContextLogger.ts#L20)
+
+Structured logger that automatically enriches log entries with the
+current request context (requestId, userId) from [RequestContextStore](Class.RequestContextStore).
+
+## Remarks
+
+This logger wraps the NestJS Logger and prepends structured
+context fields. It is intended as a drop-in replacement for direct
+`Logger` usage in services that need request-scoped correlation.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ContextLogger(context?): ContextLogger;
+```
+
+Defined in: [ContextLogger.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/ContextLogger.ts#L29)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `context?` | `string` |
+
+#### Returns
+
+`ContextLogger`
+
+## Methods
+
+### debug()
+
+```ts
+debug(message, data?): void;
+```
+
+Defined in: [ContextLogger.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/ContextLogger.ts#L69)
+
+Logs at `debug` level with request context.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `data?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`
+
+***
+
+### error()
+
+```ts
+error(message, data?): void;
+```
+
+Defined in: [ContextLogger.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/ContextLogger.ts#L60)
+
+Logs at `error` level with request context.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `data?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`
+
+***
+
+### log()
+
+```ts
+log(message, data?): void;
+```
+
+Defined in: [ContextLogger.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/ContextLogger.ts#L42)
+
+Logs at `log` level with request context.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `data?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`
+
+***
+
+### verbose()
+
+```ts
+verbose(message, data?): void;
+```
+
+Defined in: [ContextLogger.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/ContextLogger.ts#L78)
+
+Logs at `verbose` level with request context.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `data?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`
+
+***
+
+### warn()
+
+```ts
+warn(message, data?): void;
+```
+
+Defined in: [ContextLogger.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/ContextLogger.ts#L51)
+
+Logs at `warn` level with request context.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `data?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`

package/data/packages/platform-logging/api/Class.LoggerModule.md

@@ -5,9 +5,15 @@ editUrl: false
 ---
 # Class: LoggerModule
 
-Defined in: [LoggerModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/LoggerModule.ts#L35)
+Defined in: [LoggerModule.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/LoggerModule.ts#L44)
 
-Global logging module that configures the NestJS Logger with an application-wide log level.
+Global logging module that configures the NestJS Logger with an application-wide log level
+and provides request-scoped context propagation via [RequestIdMiddleware](Class.RequestIdMiddleware).
+
+## Remarks
+
+Apply [RequestIdMiddleware](Class.RequestIdMiddleware) in your `AppModule.configure()` to enable
+automatic `requestId` propagation to all log entries via [ContextLogger](Class.ContextLogger).
 
 ## Constructors
 

package/data/packages/platform-logging/api/Class.RequestContextStore.md

@@ -0,0 +1,90 @@
+---
+title: 'Class: RequestContextStore'
+generated: true
+editUrl: false
+---
+# Class: RequestContextStore
+
+Defined in: [RequestContextStore.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/RequestContextStore.ts#L29)
+
+AsyncLocalStorage-based request context store.
+
+Provides a per-request context accessible anywhere in the call stack
+without passing parameters explicitly. This is the foundation for
+structured logging with automatic `requestId` propagation.
+
+## Constructors
+
+### Constructor
+
+```ts
+new RequestContextStore(): RequestContextStore;
+```
+
+#### Returns
+
+`RequestContextStore`
+
+## Methods
+
+### get()
+
+```ts
+static get(): IRequestContext | undefined;
+```
+
+Defined in: [RequestContextStore.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/RequestContextStore.ts#L57)
+
+Returns the current request context, or `undefined` if called
+outside a request scope.
+
+#### Returns
+
+[`IRequestContext`](Interface.IRequestContext) \| `undefined`
+
+***
+
+### getRequestId()
+
+```ts
+static getRequestId(): string;
+```
+
+Defined in: [RequestContextStore.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/RequestContextStore.ts#L66)
+
+Returns the current `requestId`, or `'unknown'` if no context is active.
+
+#### Returns
+
+`string`
+
+***
+
+### run()
+
+```ts
+static run<T>(context, callback): T;
+```
+
+Defined in: [RequestContextStore.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/RequestContextStore.ts#L47)
+
+Runs a callback within a new request context.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | [`IRequestContext`](Interface.IRequestContext) | The request context to associate with the callback execution. |
+| `callback` | () => `T` | The function to execute within the context. |
+
+#### Returns
+
+`T`
+
+The return value of the callback.