@breadstone/archipel-mcp 0.0.23 → 0.0.25

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
+```

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

@@ -46,7 +46,7 @@ Defined in: [stripe/StripeClient.ts:40](https://github.com/RueDeRennes/archipel/
 constructWebhookEvent(payload, signature): INormalizedWebhookEvent;
 ```
 
-Defined in: [stripe/StripeClient.ts:153](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L153)
+Defined in: [stripe/StripeClient.ts:156](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L156)
 
 Construct and normalize a webhook event.
 
@@ -79,7 +79,7 @@ createCheckoutSession(
 userId?): Promise<INormalizedCheckoutSession>;
 ```
 
-Defined in: [stripe/StripeClient.ts:88](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L88)
+Defined in: [stripe/StripeClient.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L91)
 
 Create a checkout session.
 
@@ -110,7 +110,7 @@ Normalized checkout session
 fetchPrices(productId): Promise<INormalizedPrice[]>;
 ```
 
-Defined in: [stripe/StripeClient.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L59)
+Defined in: [stripe/StripeClient.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L62)
 
 Fetch all active prices for a product.
 
@@ -140,7 +140,7 @@ fetchSubscription(subscriptionId): Promise<
 | null>;
 ```
 
-Defined in: [stripe/StripeClient.ts:128](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L128)
+Defined in: [stripe/StripeClient.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L131)
 
 Retrieve subscription details.
 
@@ -161,3 +161,27 @@ Normalized subscription
 #### 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/index.md

@@ -17,6 +17,7 @@ editUrl: false
 | [PaddleClient](Class.PaddleClient) | Paddle implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing API. |
 | [PaymentClientPort](Class.PaymentClientPort) | Abstract port for payment provider clients. Each provider (Stripe, Paddle, LemonSqueezy, Mollie) must implement this contract so that the consuming application can switch providers without changing business logic. |
 | [PaymentError](Class.PaymentError) | Domain error thrown when a payment operation fails. |
+| [PaymentHealthIndicator](Class.PaymentHealthIndicator) | Health indicator for the payment infrastructure. Calls [PaymentClientPort.ping](Class.PaymentClientPort#ping) to verify provider connectivity. |
 | [PaymentModule](Class.PaymentModule) | NestJS module providing generic payment infrastructure. Exposes a configurable payment client, a feature-gating guard, and a usage-tracking interceptor. The specific payment provider (Stripe, Paddle, LemonSqueezy, Mollie) is selected via the options. |
 | [StripeClient](Class.StripeClient) | Stripe implementation of the [PaymentClientPort](Class.PaymentClientPort). All Stripe-specific types and logic are encapsulated here. |
 

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

@@ -2,7 +2,7 @@
 title: platform-payments
 description: Provider-agnostic payment infrastructure with support for Stripe, Paddle, LemonSqueezy, and Mollie.
 order: 4
-tags: [payments, stripe, paddle, lemonsqueezy, mollie, feature-gating, quotas, guards, interceptors, ports-and-adapters]
+tags: [payments, stripe, paddle, lemonsqueezy, mollie, feature-gating, quotas, guards, interceptors, ports-and-adapters, health]
 package: '@breadstone/archipel-platform-payments'
 ---
 
@@ -151,7 +151,7 @@ import { LemonSqueezyClient, LEMONSQUEEZY_CONFIG_ENTRIES } from '@breadstone/arc
 | Variable                | Description                            | Required |
 | ----------------------- | -------------------------------------- | -------- |
 | `MOLLIE_API_KEY`        | Mollie API key                         | Yes      |
-| `MOLLIE_WEBHOOK_SECRET` | Mollie webhook secret for verification | No       |
+| `MOLLIE_WEBHOOK_SECRET` | Mollie webhook secret for verification | Yes      |
 
 ```typescript
 import { MollieClient, MOLLIE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-payments/mollie';
@@ -532,6 +532,29 @@ try {
 
 ---
 
+## Health Check
+
+The `PaymentHealthIndicator` verifies that a `PaymentClientPort` is injected. If no payment client is registered, it reports `disabled: true`. Import it from the `/health` subpath:
+
+```typescript
+import { PaymentHealthIndicator } from '@breadstone/archipel-platform-payments/health';
+import { HealthModule } from '@breadstone/archipel-platform-health';
+
+@Module({
+  imports: [
+    PaymentModule.register({ /* ... */ }),
+    HealthModule.withIndicators([PaymentHealthIndicator]),
+  ],
+})
+export class AppModule {}
+```
+
+| Key | Check | Dependencies |
+| --- | ----- | ------------ |
+| `payment` | `up` if `PaymentClientPort` injected, else `disabled` | `@Optional() PaymentClientPort` |
+
+---
+
 ## Exports Summary
 
 ### Core (`@breadstone/archipel-platform-payments`)
@@ -552,6 +575,7 @@ try {
 | `INormalizedWebhookEvent`    | Interface     | Normalized webhook event            |
 | `SubscriptionStatus`         | Type Alias    | Subscription status union           |
 | `PaymentError`               | Error class   | Domain error for payment failures   |
+| `PaymentHealthIndicator`     | Health        | Payment readiness check (`/health` subpath) |
 
 ### Provider subpaths
 

package/data/packages/platform-queue/api/Class.AzureQueue.md

@@ -0,0 +1,221 @@
+---
+title: 'Class: AzureQueue'
+generated: true
+editUrl: false
+---
+# Class: AzureQueue
+
+Defined in: [azure/AzureQueue.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L56)
+
+Azure Service Bus queue implementation.
+
+Uses Azure Service Bus for cloud-native, enterprise-grade messaging.
+Operates in peek-lock mode: dequeued messages remain locked until
+explicitly completed or dead-lettered.
+
+## Remarks
+
+Senders and receivers are lazily created per queue name and cached for
+the lifetime of the instance. Call [onModuleDestroy](#onmoduledestroy) (handled
+automatically by NestJS) to release all underlying connections.
+
+## Implements
+
+- [`IQueue`](Interface.IQueue)
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+new AzureQueue(options): AzureQueue;
+```
+
+Defined in: [azure/AzureQueue.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L76)
+
+Creates a new AzureQueue instance.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IAzureQueueOptions`](Interface.IAzureQueueOptions) | Connection and receive configuration. See [IAzureQueueOptions](Interface.IAzureQueueOptions). |
+
+#### Returns
+
+`AzureQueue`
+
+## Methods
+
+### dequeue()
+
+```ts
+dequeue(queueName): Promise<IQueueJob<unknown> | null>;
+```
+
+Defined in: [azure/AzureQueue.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L115)
+
+Dequeues the next pending job from the named queue.
+
+The returned job transitions to `processing` status.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the queue to dequeue from. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\> \| `null`\>
+
+The next pending job, or `null` if the queue is empty.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`dequeue`](Interface.IQueue#dequeue)
+
+***
+
+### enqueue()
+
+```ts
+enqueue<T>(queueName, payload): Promise<IQueueJob<T>>;
+```
+
+Defined in: [azure/AzureQueue.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L86)
+
+Enqueues a new job into the named queue.
+
+#### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `T` | `unknown` |  |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the target queue. |
+| `payload` | `T` | The job payload. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`T`\>\>
+
+The created job in `pending` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`enqueue`](Interface.IQueue#enqueue)
+
+***
+
+### getJobs()
+
+```ts
+getJobs(queueName): Promise<readonly IQueueJob<unknown>[]>;
+```
+
+Defined in: [azure/AzureQueue.ts:222](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L222)
+
+Returns all jobs for the given queue in insertion order.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the queue. |
+
+#### Returns
+
+`Promise`\<readonly [`IQueueJob`](Interface.IQueueJob)\<`unknown`\>[]\>
+
+An array of jobs, possibly empty.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`getJobs`](Interface.IQueue#getjobs)
+
+***
+
+### markCompleted()
+
+```ts
+markCompleted(jobId): Promise<IQueueJob<unknown>>;
+```
+
+Defined in: [azure/AzureQueue.ts:147](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L147)
+
+Marks a processing job as completed.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jobId` | `string` | The ID of the job to complete. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\>\>
+
+The updated job in `completed` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`markCompleted`](Interface.IQueue#markcompleted)
+
+***
+
+### markFailed()
+
+```ts
+markFailed(jobId, errorMessage): Promise<IQueueJob<unknown>>;
+```
+
+Defined in: [azure/AzureQueue.ts:180](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L180)
+
+Marks a processing job as failed.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jobId` | `string` | The ID of the job to mark as failed. |
+| `errorMessage` | `string` | A human-readable error message. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\>\>
+
+The updated job in `failed` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`markFailed`](Interface.IQueue#markfailed)
+
+***
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): Promise<void>;
+```
+
+Defined in: [azure/AzureQueue.ts:247](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L247)
+
+Closes all senders, receivers, and the underlying Service Bus client.
+
+Called automatically by the NestJS lifecycle when the module is destroyed.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy
+```