@breadstone/archipel-mcp 0.0.22 → 0.0.25

package/data/packages/platform-mapping/api/Class.TypeMappingNotRegisteredError.md

@@ -0,0 +1,53 @@
+---
+title: 'Class: TypeMappingNotRegisteredError'
+generated: true
+editUrl: false
+---
+# Class: TypeMappingNotRegisteredError
+
+Defined in: [errors/TypeMappingNotRegisteredError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/TypeMappingNotRegisteredError.ts#L12)
+
+Thrown when a type mapping is requested but not registered.
+
+## Extends
+
+- [`MappingError`](Class.MappingError)
+
+## Constructors
+
+### Constructor
+
+```ts
+new TypeMappingNotRegisteredError(source, destination): TypeMappingNotRegisteredError;
+```
+
+Defined in: [errors/TypeMappingNotRegisteredError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/TypeMappingNotRegisteredError.ts#L15)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `source` | `string` |
+| `destination` | `string` |
+
+#### Returns
+
+`TypeMappingNotRegisteredError`
+
+#### Overrides
+
+[`MappingError`](Class.MappingError).[`constructor`](Class.MappingError#constructor)
+
+## Properties
+
+### code
+
+```ts
+readonly code: string;
+```
+
+Defined in: [errors/MappingError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/MappingError.ts#L10)
+
+#### Inherited from
+
+[`MappingError`](Class.MappingError).[`code`](Class.MappingError#code)

package/data/packages/platform-mapping/api/Function.createMappingKey.md

@@ -0,0 +1,39 @@
+---
+title: 'Function: createMappingKey()'
+generated: true
+editUrl: false
+---
+# Function: createMappingKey()
+
+```ts
+function createMappingKey<TInput, TOutput>(key): IMappingKey<TInput, TOutput>;
+```
+
+Defined in: [types/MappingKey.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L28)
+
+Creates a type-safe mapping key.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique string identifier for the mapping. |
+
+## Returns
+
+[`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\>
+
+A branded mapping key that encodes the input and output types.
+
+## Example
+
+```typescript
+export const PRODUCT_MAPPING_KEY = createMappingKey<IProductMappingInput, ProductResponse>('food.product');
+```

package/data/packages/platform-mapping/api/Interface.IMappingBuilder.md

@@ -0,0 +1,76 @@
+---
+title: 'Interface: IMappingBuilder'
+generated: true
+editUrl: false
+---
+# Interface: IMappingBuilder
+
+Defined in: [builder/interfaces/IMappingBuilder.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/interfaces/IMappingBuilder.ts#L24)
+
+Defines the interface for a mapping builder.
+
+## Methods
+
+### createKeyedMap()
+
+```ts
+createKeyedMap<TInput, TOutput>(key, fn): this;
+```
+
+Defined in: [builder/interfaces/IMappingBuilder.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/interfaces/IMappingBuilder.ts#L50)
+
+Creates a keyed mapping between two types with full type safety.
+The mapping key encodes both input and output types at compile time.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
+| `fn` | (`source`) => `MappingCompatible`\<`TInput`, `TOutput`\> & `TOutput` | The mapping function that must return a valid destination. |
+
+#### Returns
+
+`this`
+
+***
+
+### createMap()
+
+```ts
+createMap<TSource, TDestination>(
+   source, 
+   destination, 
+   fn): this;
+```
+
+Defined in: [builder/interfaces/IMappingBuilder.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/interfaces/IMappingBuilder.ts#L36)
+
+Creates a mapping between two types.
+Ensures compile-time type compatibility between source and destination.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `source` | [`Constructor`](TypeAlias.Constructor)\<`TSource`\> | The source type. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The destination type. |
+| `fn` | (`source`) => `MappingCompatible`\<`TSource`, `TDestination`\> & `TDestination` | The mapping function that must return a valid destination. |
+
+#### Returns
+
+`this`

package/data/packages/platform-mapping/api/Interface.IMappingKey.md

@@ -0,0 +1,58 @@
+---
+title: 'Interface: IMappingKey\<TInput, TOutput\>'
+generated: true
+editUrl: false
+---
+# Interface: IMappingKey\<TInput, TOutput\>
+
+Defined in: [types/MappingKey.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L9)
+
+Type-safe mapping key that encodes both input and output types.
+This ensures compile-time type safety when using the mapping service.
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `TInput` | The input type for the mapping. |
+| `TOutput` | The output type for the mapping. |
+
+## Properties
+
+### \_brand
+
+```ts
+readonly _brand: "MappingKey";
+```
+
+Defined in: [types/MappingKey.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L10)
+
+***
+
+### \_input
+
+```ts
+readonly _input: TInput;
+```
+
+Defined in: [types/MappingKey.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L11)
+
+***
+
+### \_output
+
+```ts
+readonly _output: TOutput;
+```
+
+Defined in: [types/MappingKey.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L12)
+
+***
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: [types/MappingKey.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L13)

package/data/packages/platform-mapping/api/Interface.IMappingProfile.md

@@ -0,0 +1,32 @@
+---
+title: 'Interface: IMappingProfile'
+generated: true
+editUrl: false
+---
+# Interface: IMappingProfile
+
+Defined in: [profile/interfaces/IMappingProfile.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/profile/interfaces/IMappingProfile.ts#L12)
+
+Defines the interface for a mapping profile.
+
+## Methods
+
+### configure()
+
+```ts
+configure(builder): void;
+```
+
+Defined in: [profile/interfaces/IMappingProfile.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/profile/interfaces/IMappingProfile.ts#L21)
+
+Configures the mapping profile.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
+
+#### Returns
+
+`void`

package/data/packages/platform-mapping/api/TypeAlias.Constructor.md

@@ -0,0 +1,28 @@
+---
+title: 'Type Alias: Constructor\<T\>'
+generated: true
+editUrl: false
+---
+# Type Alias: Constructor\<T\>
+
+```ts
+type Constructor<T> = (...args) => T;
+```
+
+Defined in: [types/Constructor.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/Constructor.ts#L1)
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | `unknown`[] |
+
+## Returns
+
+`T`

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

@@ -0,0 +1,38 @@
+---
+title: '@breadstone/archipel-platform-mapping'
+generated: true
+editUrl: false
+---
+# @breadstone/archipel-platform-mapping
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [MappingBuilder](Class.MappingBuilder) | A mapping builder that uses the mapping service to register maps. |
+| [MappingError](Class.MappingError) | Base class for mapping related domain errors. |
+| [MappingModule](Class.MappingModule) | Module that provides mapping services and allows registration of mapping profiles. |
+| [MappingNotRegisteredError](Class.MappingNotRegisteredError) | Thrown when a keyed mapping is requested but not registered. |
+| [MappingProfileBase](Class.MappingProfileBase) | Base class for mapping profiles to simplify implementation. |
+| [MappingService](Class.MappingService) | Central mapping registry supporting keyed & type-based mappings. |
+| [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [IMappingBuilder](Interface.IMappingBuilder) | Defines the interface for a mapping builder. |
+| [IMappingKey](Interface.IMappingKey) | Type-safe mapping key that encodes both input and output types. This ensures compile-time type safety when using the mapping service. |
+| [IMappingProfile](Interface.IMappingProfile) | Defines the interface for a mapping profile. |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [Constructor](TypeAlias.Constructor) | - |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [createMappingKey](Function.createMappingKey) | Creates a type-safe mapping key. |

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

@@ -118,4 +118,4 @@ export class UserController {
 
 ## 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-mcp/api/Class.McpHealthIndicator.md

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

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

@@ -10,6 +10,7 @@ editUrl: false
 | Class | Description |
 | ------ | ------ |
 | [McpDiscoveryService](Class.McpDiscoveryService) | Discovers all NestJS providers that have methods decorated with `@McpTool`, `@McpResource`, or `@McpPrompt` and registers them in the [McpRegistryService](Class.McpRegistryService). |
+| [McpHealthIndicator](Class.McpHealthIndicator) | Health indicator for the MCP server infrastructure. Verifies that at least one tool, resource, or prompt handler is registered. |
 | [McpModule](Class.McpModule) | NestJS dynamic module that bootstraps an MCP server. |
 | [McpRegistryService](Class.McpRegistryService) | Central registry that stores all MCP tool, resource, and prompt handlers discovered from NestJS providers. |
 | [McpServerService](Class.McpServerService) | Manages the MCP server lifecycle. Creates the `McpServer` instance, registers all discovered handlers from the registry, and provides methods to connect various transports. |

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

@@ -2,7 +2,7 @@
 title: platform-mcp
 description: Reusable NestJS module for building Model Context Protocol (MCP) servers with decorator-driven handler registration and multi-transport support.
 order: 13
-tags: [mcp, model-context-protocol, tools, resources, prompts, transports]
+tags: [mcp, model-context-protocol, tools, resources, prompts, transports, health]
 package: '@breadstone/archipel-platform-mcp'
 ---
 
@@ -300,6 +300,29 @@ graph TD
 
 ---
 
+## Health Check
+
+The `McpHealthIndicator` verifies that the `McpRegistryService` is injected. If no MCP registry is available, it reports `disabled: true`. Import it from the `/health` subpath:
+
+```typescript
+import { McpHealthIndicator } from '@breadstone/archipel-platform-mcp/health';
+import { HealthModule } from '@breadstone/archipel-platform-health';
+
+@Module({
+  imports: [
+    McpModule.register({ /* ... */ }),
+    HealthModule.withIndicators([McpHealthIndicator]),
+  ],
+})
+export class AppModule {}
+```
+
+| Key | Check | Dependencies |
+| --- | ----- | ------------ |
+| `mcp` | `up` if `McpRegistryService` injected, else `disabled` | `@Optional() McpRegistryService` |
+
+---
+
 ## Resource Limits & Shutdown
 
 | Limit                | Value      | Description                                                              |

package/data/packages/platform-openapi/api/Function.SwaggerFeature.md

@@ -6,7 +6,7 @@ editUrl: false
 # Function: SwaggerFeature()
 
 ```ts
-function SwaggerFeature(metadata): (target) => any;
+function SwaggerFeature(metadata): (target) => (...args) => object;
 ```
 
 Defined in: [decorators/SwaggerFeature.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L92)
@@ -22,7 +22,7 @@ This allows the SwaggerMultiDocumentService to automatically discover and create
 
 ## Returns
 
-(`target`) => `any`
+(`target`) => (...`args`) => `object`
 
 ## Example
 

package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md

@@ -11,7 +11,7 @@ function getSwaggerFeatureMetadata(target):
   | undefined;
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L113)
+Defined in: [decorators/SwaggerFeature.ts:111](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L111)
 
 Get the Swagger feature metadata from a module class
 
@@ -19,7 +19,7 @@ Get the Swagger feature metadata from a module class
 
 | Parameter | Type |
 | ------ | ------ |
-| `target` | `any` |
+| `target` | (...`args`) => `object` |
 
 ## Returns
 

package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md

@@ -161,3 +161,27 @@ Normalized subscription or `null` if not found.
 #### Overrides
 
 [`PaymentClientPort`](Class.PaymentClientPort).[`fetchSubscription`](Class.PaymentClientPort#fetchsubscription)
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/PaymentClientPort.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L76)
+
+Lightweight connectivity check for the payment provider.
+Override in adapters to perform a real API call (e.g. list products).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+#### Inherited from
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`ping`](Class.PaymentClientPort#ping)

package/data/packages/platform-payments/api/Class.MollieClient.md

@@ -164,3 +164,27 @@ Normalized subscription or `null` if not found.
 #### Overrides
 
 [`PaymentClientPort`](Class.PaymentClientPort).[`fetchSubscription`](Class.PaymentClientPort#fetchsubscription)
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/PaymentClientPort.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L76)
+
+Lightweight connectivity check for the payment provider.
+Override in adapters to perform a real API call (e.g. list products).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+#### Inherited from
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`ping`](Class.PaymentClientPort#ping)

package/data/packages/platform-payments/api/Class.PaddleClient.md

@@ -161,3 +161,27 @@ Normalized subscription or `null` if not found.
 #### Overrides
 
 [`PaymentClientPort`](Class.PaymentClientPort).[`fetchSubscription`](Class.PaymentClientPort#fetchsubscription)
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/PaymentClientPort.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L76)
+
+Lightweight connectivity check for the payment provider.
+Override in adapters to perform a real API call (e.g. list products).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+#### Inherited from
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`ping`](Class.PaymentClientPort#ping)

package/data/packages/platform-payments/api/Class.PaymentClientPort.md

@@ -140,3 +140,23 @@ Retrieve subscription details.
   \| `null`\>
 
 Normalized subscription or `null` if not found.
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: [contracts/PaymentClientPort.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L76)
+
+Lightweight connectivity check for the payment provider.
+Override in adapters to perform a real API call (e.g. list products).
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.

package/data/packages/platform-payments/api/Class.PaymentHealthIndicator.md

@@ -0,0 +1,78 @@
+---
+title: 'Class: PaymentHealthIndicator'
+generated: true
+editUrl: false
+---
+# Class: PaymentHealthIndicator
+
+Defined in: health/PaymentHealthIndicator.ts:17
+
+Health indicator for the payment infrastructure.
+Calls [PaymentClientPort.ping](Class.PaymentClientPort#ping) to verify provider connectivity.
+
+## Implements
+
+- `IHealthIndicator`
+
+## Constructors
+
+### Constructor
+
+```ts
+new PaymentHealthIndicator(paymentClient?): PaymentHealthIndicator;
+```
+
+Defined in: health/PaymentHealthIndicator.ts:27
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `paymentClient?` | [`PaymentClientPort`](Class.PaymentClientPort) |
+
+#### Returns
+
+`PaymentHealthIndicator`
+
+## Properties
+
+### key
+
+```ts
+readonly key: string = 'payment';
+```
+
+Defined in: health/PaymentHealthIndicator.ts:35
+
+Unique key identifying the indicator
+
+#### Implementation of
+
+```ts
+IHealthIndicator.key
+```
+
+## Methods
+
+### check()
+
+```ts
+check(): Promise<HealthIndicatorResult<string>>;
+```
+
+Defined in: health/PaymentHealthIndicator.ts:48
+
+Pings the payment 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
+```