@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,168 @@
+---
+title: 'Class: MollieClient'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Class: MollieClient
+
+Defined in: [mollie/MollieClient.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L23)
+
+Mollie implementation of the [PaymentClientPort](Class.PaymentClientPort).
+Uses the official `@mollie/api-client` to interact with the Mollie API.
+
+## Extends
+
+- [`PaymentClientPort`](Class.PaymentClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new MollieClient(configService): MollieClient;
+```
+
+Defined in: [mollie/MollieClient.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L34)
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`MollieClient`
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`constructor`](Class.PaymentClientPort#constructor)
+
+## Methods
+
+### constructWebhookEvent()
+
+```ts
+constructWebhookEvent(payload, signature): INormalizedWebhookEvent;
+```
+
+Defined in: [mollie/MollieClient.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L122)
+
+Construct and normalize a webhook event from raw payload.
+
+#### Parameters
+
+| Parameter   | Type                                      | Description               |
+| ----------- | ----------------------------------------- | ------------------------- |
+| `payload`   | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body.         |
+| `signature` | `string`                                  | Webhook signature header. |
+
+#### Returns
+
+[`INormalizedWebhookEvent`](Interface.INormalizedWebhookEvent)
+
+Normalized webhook event.
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`constructWebhookEvent`](Class.PaymentClientPort#constructwebhookevent)
+
+---
+
+### createCheckoutSession()
+
+```ts
+createCheckoutSession(
+   priceId,
+   successUrl,
+   cancelUrl,
+userId?): Promise<INormalizedCheckoutSession>;
+```
+
+Defined in: [mollie/MollieClient.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L59)
+
+Create a checkout session.
+
+#### Parameters
+
+| Parameter    | Type     | Description              |
+| ------------ | -------- | ------------------------ |
+| `priceId`    | `string` | Price identifier.        |
+| `successUrl` | `string` | Success redirect URL.    |
+| `cancelUrl`  | `string` | Cancel redirect URL.     |
+| `userId?`    | `string` | Optional user reference. |
+
+#### Returns
+
+`Promise`\<[`INormalizedCheckoutSession`](Interface.INormalizedCheckoutSession)\>
+
+Normalized checkout session.
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`createCheckoutSession`](Class.PaymentClientPort#createcheckoutsession)
+
+---
+
+### fetchPrices()
+
+```ts
+fetchPrices(_productId): Promise<INormalizedPrice[]>;
+```
+
+Defined in: [mollie/MollieClient.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L48)
+
+Fetch all active prices for a product.
+
+#### Parameters
+
+| Parameter    | Type     | Description                  |
+| ------------ | -------- | ---------------------------- |
+| `_productId` | `string` | External product identifier. |
+
+#### Returns
+
+`Promise`\<[`INormalizedPrice`](Interface.INormalizedPrice)[]\>
+
+Array of normalized prices.
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`fetchPrices`](Class.PaymentClientPort#fetchprices)
+
+---
+
+### fetchSubscription()
+
+```ts
+fetchSubscription(subscriptionId): Promise<
+  | INormalizedSubscription
+| null>;
+```
+
+Defined in: [mollie/MollieClient.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L96)
+
+Retrieve subscription details.
+
+#### Parameters
+
+| Parameter        | Type     | Description              |
+| ---------------- | -------- | ------------------------ |
+| `subscriptionId` | `string` | Subscription identifier. |
+
+#### Returns
+
+`Promise`\<
+\| [`INormalizedSubscription`](Interface.INormalizedSubscription)
+\| `null`\>
+
+Normalized subscription or `null` if not found.
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`fetchSubscription`](Class.PaymentClientPort#fetchsubscription)

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

@@ -0,0 +1,168 @@
+---
+title: 'Class: PaddleClient'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Class: PaddleClient
+
+Defined in: [paddle/PaddleClient.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L23)
+
+Paddle implementation of the [PaymentClientPort](Class.PaymentClientPort).
+Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing API.
+
+## Extends
+
+- [`PaymentClientPort`](Class.PaymentClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new PaddleClient(configService): PaddleClient;
+```
+
+Defined in: [paddle/PaddleClient.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L34)
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`PaddleClient`
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`constructor`](Class.PaymentClientPort#constructor)
+
+## Methods
+
+### constructWebhookEvent()
+
+```ts
+constructWebhookEvent(payload, signature): Promise<INormalizedWebhookEvent>;
+```
+
+Defined in: [paddle/PaddleClient.ts:120](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L120)
+
+Construct and normalize a webhook event from raw payload.
+
+#### Parameters
+
+| Parameter   | Type                                      | Description               |
+| ----------- | ----------------------------------------- | ------------------------- |
+| `payload`   | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body.         |
+| `signature` | `string`                                  | Webhook signature header. |
+
+#### Returns
+
+`Promise`\<[`INormalizedWebhookEvent`](Interface.INormalizedWebhookEvent)\>
+
+Normalized webhook event.
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`constructWebhookEvent`](Class.PaymentClientPort#constructwebhookevent)
+
+---
+
+### createCheckoutSession()
+
+```ts
+createCheckoutSession(
+   priceId,
+   successUrl,
+   _cancelUrl,
+userId?): Promise<INormalizedCheckoutSession>;
+```
+
+Defined in: [paddle/PaddleClient.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L71)
+
+Create a checkout session.
+
+#### Parameters
+
+| Parameter    | Type     | Description              |
+| ------------ | -------- | ------------------------ |
+| `priceId`    | `string` | Price identifier.        |
+| `successUrl` | `string` | Success redirect URL.    |
+| `_cancelUrl` | `string` | Cancel redirect URL.     |
+| `userId?`    | `string` | Optional user reference. |
+
+#### Returns
+
+`Promise`\<[`INormalizedCheckoutSession`](Interface.INormalizedCheckoutSession)\>
+
+Normalized checkout session.
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`createCheckoutSession`](Class.PaymentClientPort#createcheckoutsession)
+
+---
+
+### fetchPrices()
+
+```ts
+fetchPrices(productId): Promise<INormalizedPrice[]>;
+```
+
+Defined in: [paddle/PaddleClient.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L51)
+
+Fetch all active prices for a product.
+
+#### Parameters
+
+| Parameter   | Type     | Description                  |
+| ----------- | -------- | ---------------------------- |
+| `productId` | `string` | External product identifier. |
+
+#### Returns
+
+`Promise`\<[`INormalizedPrice`](Interface.INormalizedPrice)[]\>
+
+Array of normalized prices.
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`fetchPrices`](Class.PaymentClientPort#fetchprices)
+
+---
+
+### fetchSubscription()
+
+```ts
+fetchSubscription(subscriptionId): Promise<
+  | INormalizedSubscription
+| null>;
+```
+
+Defined in: [paddle/PaddleClient.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L105)
+
+Retrieve subscription details.
+
+#### Parameters
+
+| Parameter        | Type     | Description              |
+| ---------------- | -------- | ------------------------ |
+| `subscriptionId` | `string` | Subscription identifier. |
+
+#### Returns
+
+`Promise`\<
+\| [`INormalizedSubscription`](Interface.INormalizedSubscription)
+\| `null`\>
+
+Normalized subscription or `null` if not found.
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`fetchSubscription`](Class.PaymentClientPort#fetchsubscription)

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

@@ -0,0 +1,147 @@
+---
+title: 'Abstract Class: PaymentClientPort'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Abstract Class: PaymentClientPort
+
+Defined in: [contracts/PaymentClientPort.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L17)
+
+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.
+
+## Extended by
+
+- [`StripeClient`](Class.StripeClient)
+- [`PaddleClient`](Class.PaddleClient)
+- [`LemonSqueezyClient`](Class.LemonSqueezyClient)
+- [`MollieClient`](Class.MollieClient)
+
+## Constructors
+
+### Constructor
+
+```ts
+new PaymentClientPort(): PaymentClientPort;
+```
+
+#### Returns
+
+`PaymentClientPort`
+
+## Methods
+
+### constructWebhookEvent()
+
+```ts
+abstract constructWebhookEvent(payload, signature):
+  | INormalizedWebhookEvent
+| Promise<INormalizedWebhookEvent>;
+```
+
+Defined in: [contracts/PaymentClientPort.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L63)
+
+Construct and normalize a webhook event from raw payload.
+
+#### Parameters
+
+| Parameter   | Type                                      | Description               |
+| ----------- | ----------------------------------------- | ------------------------- |
+| `payload`   | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body.         |
+| `signature` | `string`                                  | Webhook signature header. |
+
+#### Returns
+
+\| [`INormalizedWebhookEvent`](Interface.INormalizedWebhookEvent)
+\| `Promise`\<[`INormalizedWebhookEvent`](Interface.INormalizedWebhookEvent)\>
+
+Normalized webhook event.
+
+---
+
+### createCheckoutSession()
+
+```ts
+abstract createCheckoutSession(
+   priceId,
+   successUrl,
+   cancelUrl,
+userId?): Promise<INormalizedCheckoutSession>;
+```
+
+Defined in: [contracts/PaymentClientPort.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L39)
+
+Create a checkout session.
+
+#### Parameters
+
+| Parameter    | Type     | Description              |
+| ------------ | -------- | ------------------------ |
+| `priceId`    | `string` | Price identifier.        |
+| `successUrl` | `string` | Success redirect URL.    |
+| `cancelUrl`  | `string` | Cancel redirect URL.     |
+| `userId?`    | `string` | Optional user reference. |
+
+#### Returns
+
+`Promise`\<[`INormalizedCheckoutSession`](Interface.INormalizedCheckoutSession)\>
+
+Normalized checkout session.
+
+---
+
+### fetchPrices()
+
+```ts
+abstract fetchPrices(productId): Promise<INormalizedPrice[]>;
+```
+
+Defined in: [contracts/PaymentClientPort.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L27)
+
+Fetch all active prices for a product.
+
+#### Parameters
+
+| Parameter   | Type     | Description                  |
+| ----------- | -------- | ---------------------------- |
+| `productId` | `string` | External product identifier. |
+
+#### Returns
+
+`Promise`\<[`INormalizedPrice`](Interface.INormalizedPrice)[]\>
+
+Array of normalized prices.
+
+---
+
+### fetchSubscription()
+
+```ts
+abstract fetchSubscription(subscriptionId): Promise<
+  | INormalizedSubscription
+| null>;
+```
+
+Defined in: [contracts/PaymentClientPort.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/PaymentClientPort.ts#L53)
+
+Retrieve subscription details.
+
+#### Parameters
+
+| Parameter        | Type     | Description              |
+| ---------------- | -------- | ------------------------ |
+| `subscriptionId` | `string` | Subscription identifier. |
+
+#### Returns
+
+`Promise`\<
+\| [`INormalizedSubscription`](Interface.INormalizedSubscription)
+\| `null`\>
+
+Normalized subscription or `null` if not found.

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

@@ -0,0 +1,53 @@
+---
+title: 'Class: PaymentModule'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Class: PaymentModule
+
+Defined in: [PaymentModule.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L53)
+
+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.
+
+## Constructors
+
+### Constructor
+
+```ts
+new PaymentModule(): PaymentModule;
+```
+
+#### Returns
+
+`PaymentModule`
+
+## Methods
+
+### register()
+
+```ts
+static register(options): DynamicModule;
+```
+
+Defined in: [PaymentModule.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L63)
+
+Configures the module with the specified options.
+
+#### Parameters
+
+| Parameter | Type                                                       | Description                       |
+| --------- | ---------------------------------------------------------- | --------------------------------- |
+| `options` | [`IPaymentModuleOptions`](Interface.IPaymentModuleOptions) | The module configuration options. |
+
+#### Returns
+
+`DynamicModule`
+
+Dynamic module definition.

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

@@ -0,0 +1,168 @@
+---
+title: 'Class: StripeClient'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Class: StripeClient
+
+Defined in: [stripe/StripeClient.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L28)
+
+Stripe implementation of the [PaymentClientPort](Class.PaymentClientPort).
+All Stripe-specific types and logic are encapsulated here.
+
+## Extends
+
+- [`PaymentClientPort`](Class.PaymentClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new StripeClient(configService): StripeClient;
+```
+
+Defined in: [stripe/StripeClient.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L39)
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`StripeClient`
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`constructor`](Class.PaymentClientPort#constructor)
+
+## Methods
+
+### constructWebhookEvent()
+
+```ts
+constructWebhookEvent(payload, signature): INormalizedWebhookEvent;
+```
+
+Defined in: [stripe/StripeClient.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L152)
+
+Construct and normalize a webhook event.
+
+#### Parameters
+
+| Parameter   | Type                                      | Description              |
+| ----------- | ----------------------------------------- | ------------------------ |
+| `payload`   | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body         |
+| `signature` | `string`                                  | Webhook signature header |
+
+#### Returns
+
+[`INormalizedWebhookEvent`](Interface.INormalizedWebhookEvent)
+
+Normalized webhook event
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`constructWebhookEvent`](Class.PaymentClientPort#constructwebhookevent)
+
+---
+
+### createCheckoutSession()
+
+```ts
+createCheckoutSession(
+   priceId,
+   successUrl,
+   cancelUrl,
+userId?): Promise<INormalizedCheckoutSession>;
+```
+
+Defined in: [stripe/StripeClient.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L87)
+
+Create a checkout session.
+
+#### Parameters
+
+| Parameter    | Type     | Description             |
+| ------------ | -------- | ----------------------- |
+| `priceId`    | `string` | Price identifier        |
+| `successUrl` | `string` | Success redirect URL    |
+| `cancelUrl`  | `string` | Cancel redirect URL     |
+| `userId?`    | `string` | Optional user reference |
+
+#### Returns
+
+`Promise`\<[`INormalizedCheckoutSession`](Interface.INormalizedCheckoutSession)\>
+
+Normalized checkout session
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`createCheckoutSession`](Class.PaymentClientPort#createcheckoutsession)
+
+---
+
+### fetchPrices()
+
+```ts
+fetchPrices(productId): Promise<INormalizedPrice[]>;
+```
+
+Defined in: [stripe/StripeClient.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L58)
+
+Fetch all active prices for a product.
+
+#### Parameters
+
+| Parameter   | Type     | Description                 |
+| ----------- | -------- | --------------------------- |
+| `productId` | `string` | External product identifier |
+
+#### Returns
+
+`Promise`\<[`INormalizedPrice`](Interface.INormalizedPrice)[]\>
+
+Array of normalized prices
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`fetchPrices`](Class.PaymentClientPort#fetchprices)
+
+---
+
+### fetchSubscription()
+
+```ts
+fetchSubscription(subscriptionId): Promise<
+  | INormalizedSubscription
+| null>;
+```
+
+Defined in: [stripe/StripeClient.ts:127](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L127)
+
+Retrieve subscription details.
+
+#### Parameters
+
+| Parameter        | Type     | Description             |
+| ---------------- | -------- | ----------------------- |
+| `subscriptionId` | `string` | Subscription identifier |
+
+#### Returns
+
+`Promise`\<
+\| [`INormalizedSubscription`](Interface.INormalizedSubscription)
+\| `null`\>
+
+Normalized subscription
+
+#### Overrides
+
+[`PaymentClientPort`](Class.PaymentClientPort).[`fetchSubscription`](Class.PaymentClientPort#fetchsubscription)