@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,243 @@
+---
+title: '@breadstone/archipel-platform-payments'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# @breadstone/archipel-platform-payments
+
+## Classes
+
+| Class                                                    | Description                                                                                                                                                                                                                                                |
+| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [FeatureAccessPort](Class.FeatureAccessPort)             | Abstract port for checking and recording feature usage. Consuming projects must provide a concrete implementation (e.g. backed by Prisma with subscription + usage tables) and register it via `PaymentModule.register()`.                                 |
+| [FeatureGuard](Class.FeatureGuard)                       | Guard that checks if the user has access to a specific feature by delegating to the registered [FeatureAccessPort](Class.FeatureAccessPort).                                                                                                               |
+| [FeatureUsageInterceptor](Class.FeatureUsageInterceptor) | Interceptor that records feature usage after successful request handling. Delegates recording to the registered [FeatureAccessPort](Class.FeatureAccessPort).                                                                                              |
+| [LemonSqueezyClient](Class.LemonSqueezyClient)           | LemonSqueezy implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK.                                                                                                                    |
+| [MollieClient](Class.MollieClient)                       | Mollie implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@mollie/api-client` to interact with the Mollie API.                                                                                                         |
+| [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.                                      |
+| [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.                                                                                                                      |
+
+## Interfaces
+
+| Interface                                                          | Description                                    |
+| ------------------------------------------------------------------ | ---------------------------------------------- |
+| [IFeatureAccessResult](Interface.IFeatureAccessResult)             | Result of a feature access check.              |
+| [INormalizedCheckoutSession](Interface.INormalizedCheckoutSession) | Normalized checkout session.                   |
+| [INormalizedPrice](Interface.INormalizedPrice)                     | Normalized price information.                  |
+| [INormalizedSubscription](Interface.INormalizedSubscription)       | Normalized subscription.                       |
+| [INormalizedWebhookEvent](Interface.INormalizedWebhookEvent)       | Normalized webhook event.                      |
+| [IPaymentModuleOptions](Interface.IPaymentModuleOptions)           | Configuration options for the `PaymentModule`. |
+
+## Type Aliases
+
+| Type Alias                                         | Description                            |
+| -------------------------------------------------- | -------------------------------------- |
+| [SubscriptionStatus](TypeAlias.SubscriptionStatus) | Normalized subscription status values. |
+
+## Variables
+
+### FEATURE_KEY_METADATA
+
+```ts
+const FEATURE_KEY_METADATA: 'feature_key' = 'feature_key';
+```
+
+Defined in: [guards/FeatureGuard.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/guards/FeatureGuard.ts#L9)
+
+---
+
+### LEMONSQUEEZY_API_KEY
+
+```ts
+const LEMONSQUEEZY_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [lemonsqueezy/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L12)
+
+LemonSqueezy API key.
+
+---
+
+### LEMONSQUEEZY_CONFIG_ENTRIES
+
+```ts
+const LEMONSQUEEZY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [lemonsqueezy/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L25)
+
+Configuration entries required by the LemonSqueezy payment provider.
+
+---
+
+### LEMONSQUEEZY_STORE_ID
+
+```ts
+const LEMONSQUEEZY_STORE_ID: IConfigKey<string>;
+```
+
+Defined in: [lemonsqueezy/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L18)
+
+LemonSqueezy store ID.
+
+---
+
+### LEMONSQUEEZY_WEBHOOK_SECRET
+
+```ts
+const LEMONSQUEEZY_WEBHOOK_SECRET: IConfigKey<string>;
+```
+
+Defined in: [lemonsqueezy/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L15)
+
+LemonSqueezy webhook signing secret.
+
+---
+
+### MOLLIE_API_KEY
+
+```ts
+const MOLLIE_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [mollie/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L12)
+
+Mollie API key.
+
+---
+
+### MOLLIE_CONFIG_ENTRIES
+
+```ts
+const MOLLIE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [mollie/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L22)
+
+Configuration entries required by the Mollie payment provider.
+
+---
+
+### MOLLIE_WEBHOOK_SECRET
+
+```ts
+const MOLLIE_WEBHOOK_SECRET: IConfigKey<string>;
+```
+
+Defined in: [mollie/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L15)
+
+Mollie webhook secret for verifying webhook payloads.
+
+---
+
+### PADDLE_API_KEY
+
+```ts
+const PADDLE_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [paddle/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L12)
+
+Paddle API key.
+
+---
+
+### PADDLE_CONFIG_ENTRIES
+
+```ts
+const PADDLE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [paddle/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L25)
+
+Configuration entries required by the Paddle payment provider.
+
+---
+
+### PADDLE_ENVIRONMENT
+
+```ts
+const PADDLE_ENVIRONMENT: IConfigKey<string>;
+```
+
+Defined in: [paddle/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L18)
+
+Paddle environment (`production` or `sandbox`). Defaults to `production`.
+
+---
+
+### PADDLE_WEBHOOK_SECRET
+
+```ts
+const PADDLE_WEBHOOK_SECRET: IConfigKey<string>;
+```
+
+Defined in: [paddle/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L15)
+
+Paddle webhook secret key.
+
+---
+
+### STRIPE_API_KEY
+
+```ts
+const STRIPE_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [stripe/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L12)
+
+Stripe secret API key.
+
+---
+
+### STRIPE_CONFIG_ENTRIES
+
+```ts
+const STRIPE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [stripe/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L22)
+
+Configuration entries required by the Stripe payment provider.
+
+---
+
+### STRIPE_WEBHOOK_SECRET
+
+```ts
+const STRIPE_WEBHOOK_SECRET: IConfigKey<string>;
+```
+
+Defined in: [stripe/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L15)
+
+Stripe webhook signing secret.
+
+## Functions
+
+### 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`\>