@breadstone/archipel-mcp 0.0.23 → 0.0.26

package/data/packages/platform-documents/api/Class.DocumentEngine.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: DocumentEngine
 
-Defined in: [engine/DocumentEngine.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L19)
+Defined in: [engine/DocumentEngine.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L20)
 
 DocumentEngine orchestrates document generation workflow.
 Coordinates resource loading and renderer components.
@@ -15,10 +15,13 @@ Coordinates resource loading and renderer components.
 ### Constructor
 
 ```ts
-new DocumentEngine(resourceManager, renderers): DocumentEngine;
+new DocumentEngine(
+   resourceManager, 
+   renderers, 
+   options): DocumentEngine;
 ```
 
-Defined in: [engine/DocumentEngine.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L44)
+Defined in: [engine/DocumentEngine.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L46)
 
 #### Parameters
 
@@ -26,6 +29,7 @@ Defined in: [engine/DocumentEngine.ts:44](https://github.com/RueDeRennes/archipe
 | ------ | ------ |
 | `resourceManager` | `ResourceManager` |
 | `renderers` | [`IDocumentRenderer`](Interface.IDocumentRenderer)[] |
+| `options` | [`IDocumentModuleOptions`](Interface.IDocumentModuleOptions) |
 
 #### Returns
 
@@ -41,7 +45,7 @@ Defined in: [engine/DocumentEngine.ts:44](https://github.com/RueDeRennes/archipe
 get renderers(): ReadonlyMap<string, IDocumentRenderer>;
 ```
 
-Defined in: [engine/DocumentEngine.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L36)
+Defined in: [engine/DocumentEngine.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L38)
 
 Get available renderers.
 
@@ -61,7 +65,7 @@ render(options): Promise<IRenderResult & {
 }>;
 ```
 
-Defined in: [engine/DocumentEngine.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L71)
+Defined in: [engine/DocumentEngine.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L77)
 
 Render a document from template.
 

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

@@ -49,7 +49,7 @@ export class AppModule {}
 
 ## DocumentEngine
 
-Main orchestrator for document rendering.
+Main orchestrator for document rendering. Emits debug-level logs for document format detection and renderer initialization to aid troubleshooting.
 
 ### Render from Template
 

package/data/packages/platform-esigning/api/Class.AdobeSignEsigningProvider.md

@@ -210,6 +210,30 @@ The signing request with current status.
 
 ***
 
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
+
+Lightweight connectivity check for the e-signing provider.
+Override in adapters to perform a real API call (e.g. account info).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+#### Inherited from
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`ping`](Class.EsigningClientPort#ping)
+
+***
+
 ### verifyWebhook()
 
 ```ts

package/data/packages/platform-esigning/api/Class.DocuSignEsigningProvider.md

@@ -204,6 +204,30 @@ The signing request with current status.
 
 ***
 
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
+
+Lightweight connectivity check for the e-signing provider.
+Override in adapters to perform a real API call (e.g. account info).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+#### Inherited from
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`ping`](Class.EsigningClientPort#ping)
+
+***
+
 ### verifyWebhook()
 
 ```ts

package/data/packages/platform-esigning/api/Class.DropboxSignEsigningProvider.md

@@ -204,6 +204,30 @@ The signing request with current status.
 
 ***
 
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
+
+Lightweight connectivity check for the e-signing provider.
+Override in adapters to perform a real API call (e.g. account info).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+#### Inherited from
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`ping`](Class.EsigningClientPort#ping)
+
+***
+
 ### verifyWebhook()
 
 ```ts

package/data/packages/platform-esigning/api/Class.EsigningClientPort.md

@@ -163,6 +163,26 @@ The signing request with current status.
 
 ***
 
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
+
+Lightweight connectivity check for the e-signing provider.
+Override in adapters to perform a real API call (e.g. account info).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+***
+
 ### verifyWebhook()
 
 ```ts

package/data/packages/platform-esigning/api/Class.EsigningHealthIndicator.md

@@ -0,0 +1,78 @@
+---
+title: 'Class: EsigningHealthIndicator'
+generated: true
+editUrl: false
+---
+# Class: EsigningHealthIndicator
+
+Defined in: [health/EsigningHealthIndicator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/health/EsigningHealthIndicator.ts#L17)
+
+Health indicator for the e-signing infrastructure.
+Calls [EsigningClientPort.ping](Class.EsigningClientPort#ping) to verify provider connectivity.
+
+## Implements
+
+- `IHealthIndicator`
+
+## Constructors
+
+### Constructor
+
+```ts
+new EsigningHealthIndicator(esigningClient?): EsigningHealthIndicator;
+```
+
+Defined in: [health/EsigningHealthIndicator.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/health/EsigningHealthIndicator.ts#L27)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `esigningClient?` | [`EsigningClientPort`](Class.EsigningClientPort) |
+
+#### Returns
+
+`EsigningHealthIndicator`
+
+## Properties
+
+### key
+
+```ts
+readonly key: string = 'esigning';
+```
+
+Defined in: [health/EsigningHealthIndicator.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/health/EsigningHealthIndicator.ts#L35)
+
+Unique key identifying the indicator
+
+#### Implementation of
+
+```ts
+IHealthIndicator.key
+```
+
+## Methods
+
+### check()
+
+```ts
+check(): Promise<HealthIndicatorResult<string>>;
+```
+
+Defined in: [health/EsigningHealthIndicator.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/health/EsigningHealthIndicator.ts#L48)
+
+Pings the e-signing provider to verify connectivity.
+Returns disabled status when no client is configured.
+
+#### Returns
+
+`Promise`\<`HealthIndicatorResult`\<`string`\>\>
+
+The health indicator result.
+
+#### Implementation of
+
+```ts
+IHealthIndicator.check
+```

package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md

@@ -221,6 +221,30 @@ The signing request with current status.
 
 ***
 
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
+
+Lightweight connectivity check for the e-signing provider.
+Override in adapters to perform a real API call (e.g. account info).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+#### Inherited from
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`ping`](Class.EsigningClientPort#ping)
+
+***
+
 ### verifyWebhook()
 
 ```ts

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

@@ -14,6 +14,7 @@ editUrl: false
 | [DropboxSignEsigningProvider](Class.DropboxSignEsigningProvider) | Dropbox Sign (HelloSign) e-signing provider. Integrates with the Dropbox Sign API v3 via the official `@dropbox/sign` Node.js SDK. |
 | [EsigningClientPort](Class.EsigningClientPort) | Abstract port for e-signing provider clients. Each provider (DocuSign, Adobe Sign, Dropbox Sign, Internal) must implement this contract so that the consuming application can switch providers without changing business logic. |
 | [EsigningError](Class.EsigningError) | Base error for all e-signing related failures. |
+| [EsigningHealthIndicator](Class.EsigningHealthIndicator) | Health indicator for the e-signing infrastructure. Calls [EsigningClientPort.ping](Class.EsigningClientPort#ping) to verify provider connectivity. |
 | [EsigningModule](Class.EsigningModule) | NestJS module providing generic e-signing infrastructure. Exposes a configurable signing client and optional persistence tracking. The specific e-signing provider is selected via the options. |
 | [EsigningPersistencePort](Class.EsigningPersistencePort) | Abstract port for persisting signing request state. Implement this port in the consuming application to track signing requests in a database. |
 | [EsigningService](Class.EsigningService) | Application-level service for e-signing operations. Delegates to the configured [EsigningClientPort](Class.EsigningClientPort) and optionally invokes the [EsigningPersistencePort](Class.EsigningPersistencePort) for state tracking. |

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

@@ -2,7 +2,7 @@
 title: platform-esigning
 description: Provider-agnostic e-signing infrastructure with support for DocuSign, Adobe Sign, Dropbox Sign, and a built-in internal provider.
 order: 5
-tags: [esigning, docusign, adobe-sign, dropbox-sign, digital-signatures, ports-and-adapters, webhooks]
+tags: [esigning, docusign, adobe-sign, dropbox-sign, digital-signatures, ports-and-adapters, webhooks, health]
 package: '@breadstone/archipel-platform-esigning'
 ---
 
@@ -147,7 +147,7 @@ import { DOCUSIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/
 | `ADOBE_SIGN_INTEGRATION_KEY`   | Adobe Sign integration key                    | Yes      |
 | `ADOBE_SIGN_CLIENT_SECRET`     | Adobe Sign client secret                      | Yes      |
 | `ADOBE_SIGN_BASE_URL`          | Adobe Sign base URL                           | Yes      |
-| `ADOBE_SIGN_WEBHOOK_CLIENT_ID` | Adobe Sign webhook client ID for verification | No       |
+| `ADOBE_SIGN_WEBHOOK_CLIENT_ID` | Adobe Sign webhook client ID for verification | Yes      |
 
 ```typescript
 import { ADOBE_SIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/adobe-sign';
@@ -649,6 +649,29 @@ EsigningModule.register({
 
 ---
 
+## Health Check
+
+The `EsigningHealthIndicator` verifies that an `EsigningClientPort` is injected. If no e-signing client is registered, it reports `disabled: true`. Import it from the `/health` subpath:
+
+```typescript
+import { EsigningHealthIndicator } from '@breadstone/archipel-platform-esigning/health';
+import { HealthModule } from '@breadstone/archipel-platform-health';
+
+@Module({
+  imports: [
+    EsigningModule.register({ /* ... */ }),
+    HealthModule.withIndicators([EsigningHealthIndicator]),
+  ],
+})
+export class AppModule {}
+```
+
+| Key | Check | Dependencies |
+| --- | ----- | ------------ |
+| `esigning` | `up` if `EsigningClientPort` injected, else `disabled` | `@Optional() EsigningClientPort` |
+
+---
+
 ## Exports Summary
 
 | Export                         | Type          | Description                                         |
@@ -682,3 +705,4 @@ EsigningModule.register({
 | `ESIGNING_API_KEY`             | Config Key    | Generic API key config                              |
 | `ESIGNING_WEBHOOK_SECRET`      | Config Key    | Generic webhook secret config                       |
 | `ESIGNING_API_BASE_URL`        | Config Key    | Generic base URL config                             |
+| `EsigningHealthIndicator`      | Health        | E-signing readiness check (`/health` subpath)       |

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.
 
 ---