@breadstone/archipel-mcp 0.0.11 → 0.0.14

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

@@ -1,163 +0,0 @@
----
-title: 'Class: PaddleClient'
-generated: true
-editUrl: false
----
-# Class: PaddleClient
-
-Defined in: [paddle/PaddleClient.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L24)
-
-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:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L35)
-
-#### 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:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L121)
-
-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:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L72)
-
-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:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L52)
-
-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:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L106)
-
-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

@@ -1,142 +0,0 @@
----
-title: 'Abstract Class: PaymentClientPort'
-generated: true
-editUrl: false
----
-# 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

@@ -1,48 +0,0 @@
----
-title: 'Class: PaymentModule'
-generated: true
-editUrl: false
----
-# 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

@@ -1,163 +0,0 @@
----
-title: 'Class: StripeClient'
-generated: true
-editUrl: false
----
-# Class: StripeClient
-
-Defined in: [stripe/StripeClient.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L29)
-
-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:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L40)
-
-#### 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:155](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L155)
-
-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:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L90)
-
-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:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L61)
-
-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:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/StripeClient.ts#L130)
-
-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)

package/data/packages/platform-payments/api/Function.RequiresFeature.md

@@ -1,25 +0,0 @@
----
-title: 'Function: RequiresFeature()'
-generated: true
-editUrl: false
----
-# Function: RequiresFeature()
-
-```ts
-function RequiresFeature(featureKey): CustomDecorator<string>;
-```
-
-Defined in: [guards/FeatureGuard.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/guards/FeatureGuard.ts#L17)
-
-Decorator to mark endpoints that require feature access check.
-The `featureKey` is a free-form string defined by the consuming project.
-
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `featureKey` | `string` |
-
-## Returns
-
-`CustomDecorator`\<`string`\>

package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md

@@ -1,70 +0,0 @@
----
-title: 'Interface: IFeatureAccessResult'
-generated: true
-editUrl: false
----
-# Interface: IFeatureAccessResult
-
-Defined in: [contracts/IFeatureAccessResult.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/IFeatureAccessResult.ts#L6)
-
-Result of a feature access check.
-
-## Properties
-
-### allowed
-
-```ts
-readonly allowed: boolean;
-```
-
-Defined in: [contracts/IFeatureAccessResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/IFeatureAccessResult.ts#L12)
-
-Whether the user is allowed to use the feature.
-
-***
-
-### limit
-
-```ts
-readonly limit: number;
-```
-
-Defined in: [contracts/IFeatureAccessResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/IFeatureAccessResult.ts#L22)
-
-Maximum allowed usage count. `-1` means unlimited.
-
-***
-
-### remaining
-
-```ts
-readonly remaining: number;
-```
-
-Defined in: [contracts/IFeatureAccessResult.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/IFeatureAccessResult.ts#L27)
-
-Remaining usage count. `-1` means unlimited.
-
-***
-
-### resetAt
-
-```ts
-readonly resetAt: Date;
-```
-
-Defined in: [contracts/IFeatureAccessResult.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/IFeatureAccessResult.ts#L32)
-
-When the current usage period resets.
-
-***
-
-### used
-
-```ts
-readonly used: number;
-```
-
-Defined in: [contracts/IFeatureAccessResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/IFeatureAccessResult.ts#L17)
-
-Current usage count for the feature in the active period.

package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md

@@ -1,70 +0,0 @@
----
-title: 'Interface: INormalizedCheckoutSession'
-generated: true
-editUrl: false
----
-# Interface: INormalizedCheckoutSession
-
-Defined in: [models/INormalizedCheckoutSession.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedCheckoutSession.ts#L6)
-
-Normalized checkout session.
-
-## Properties
-
-### clientReferenceId
-
-```ts
-readonly clientReferenceId: string | null;
-```
-
-Defined in: [models/INormalizedCheckoutSession.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedCheckoutSession.ts#L11)
-
-***
-
-### customerId
-
-```ts
-readonly customerId: string | null;
-```
-
-Defined in: [models/INormalizedCheckoutSession.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedCheckoutSession.ts#L10)
-
-***
-
-### id
-
-```ts
-readonly id: string;
-```
-
-Defined in: [models/INormalizedCheckoutSession.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedCheckoutSession.ts#L7)
-
-***
-
-### paymentStatus
-
-```ts
-readonly paymentStatus: "paid" | "unpaid" | "no_payment_required";
-```
-
-Defined in: [models/INormalizedCheckoutSession.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedCheckoutSession.ts#L12)
-
-***
-
-### subscriptionId
-
-```ts
-readonly subscriptionId: string | null;
-```
-
-Defined in: [models/INormalizedCheckoutSession.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedCheckoutSession.ts#L9)
-
-***
-
-### url
-
-```ts
-readonly url: string | null;
-```
-
-Defined in: [models/INormalizedCheckoutSession.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedCheckoutSession.ts#L8)