@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,75 @@
+---
+title: 'Interface: IFeatureAccessResult'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# 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

@@ -0,0 +1,75 @@
+---
+title: 'Interface: INormalizedCheckoutSession'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# 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)

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

@@ -0,0 +1,85 @@
+---
+title: 'Interface: INormalizedPrice'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Interface: INormalizedPrice
+
+Defined in: [models/INormalizedPrice.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L6)
+
+Normalized price information.
+
+## Properties
+
+### active
+
+```ts
+readonly active: boolean;
+```
+
+Defined in: [models/INormalizedPrice.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L13)
+
+---
+
+### amount
+
+```ts
+readonly amount: number;
+```
+
+Defined in: [models/INormalizedPrice.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L9)
+
+---
+
+### currency
+
+```ts
+readonly currency: string;
+```
+
+Defined in: [models/INormalizedPrice.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L10)
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [models/INormalizedPrice.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L7)
+
+---
+
+### interval
+
+```ts
+readonly interval: "week" | "month" | "quarter" | "year" | null;
+```
+
+Defined in: [models/INormalizedPrice.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L11)
+
+---
+
+### intervalCount
+
+```ts
+readonly intervalCount: number;
+```
+
+Defined in: [models/INormalizedPrice.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L12)
+
+---
+
+### productId
+
+```ts
+readonly productId: string;
+```
+
+Defined in: [models/INormalizedPrice.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L8)

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

@@ -0,0 +1,105 @@
+---
+title: 'Interface: INormalizedSubscription'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Interface: INormalizedSubscription
+
+Defined in: [models/INormalizedSubscription.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L12)
+
+Normalized subscription.
+
+## Properties
+
+### cancelAtPeriodEnd
+
+```ts
+readonly cancelAtPeriodEnd: boolean;
+```
+
+Defined in: [models/INormalizedSubscription.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L19)
+
+---
+
+### currentPeriodEnd
+
+```ts
+readonly currentPeriodEnd: Date;
+```
+
+Defined in: [models/INormalizedSubscription.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L18)
+
+---
+
+### currentPeriodStart
+
+```ts
+readonly currentPeriodStart: Date;
+```
+
+Defined in: [models/INormalizedSubscription.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L17)
+
+---
+
+### customerId
+
+```ts
+readonly customerId: string;
+```
+
+Defined in: [models/INormalizedSubscription.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L14)
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [models/INormalizedSubscription.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L13)
+
+---
+
+### priceId
+
+```ts
+readonly priceId: string;
+```
+
+Defined in: [models/INormalizedSubscription.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L16)
+
+---
+
+### status
+
+```ts
+readonly status: SubscriptionStatus;
+```
+
+Defined in: [models/INormalizedSubscription.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L15)
+
+---
+
+### trialEnd
+
+```ts
+readonly trialEnd: Date | null;
+```
+
+Defined in: [models/INormalizedSubscription.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L21)
+
+---
+
+### trialStart
+
+```ts
+readonly trialStart: Date | null;
+```
+
+Defined in: [models/INormalizedSubscription.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L20)

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

@@ -0,0 +1,89 @@
+---
+title: 'Interface: INormalizedWebhookEvent'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Interface: INormalizedWebhookEvent
+
+Defined in: [models/INormalizedWebhookEvent.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedWebhookEvent.ts#L13)
+
+Normalized webhook event.
+
+## Properties
+
+### data
+
+```ts
+readonly data: {
+  checkoutSession?: INormalizedCheckoutSession;
+  invoice?: {
+     id: string;
+     status: "paid" | "draft" | "open" | "uncollectible" | "void";
+     subscriptionId: string | null;
+  };
+  subscription?: INormalizedSubscription;
+};
+```
+
+Defined in: [models/INormalizedWebhookEvent.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedWebhookEvent.ts#L21)
+
+#### checkoutSession?
+
+```ts
+readonly optional checkoutSession?: INormalizedCheckoutSession;
+```
+
+#### invoice?
+
+```ts
+readonly optional invoice?: {
+  id: string;
+  status: "paid" | "draft" | "open" | "uncollectible" | "void";
+  subscriptionId: string | null;
+};
+```
+
+##### invoice.id
+
+```ts
+readonly id: string;
+```
+
+##### invoice.status
+
+```ts
+readonly status: "paid" | "draft" | "open" | "uncollectible" | "void";
+```
+
+##### invoice.subscriptionId
+
+```ts
+readonly subscriptionId: string | null;
+```
+
+#### subscription?
+
+```ts
+readonly optional subscription?: INormalizedSubscription;
+```
+
+---
+
+### type
+
+```ts
+readonly type:
+  | "checkout.session.completed"
+  | "subscription.updated"
+  | "subscription.deleted"
+  | "invoice.payment_failed"
+  | "invoice.payment_succeeded"
+  | "unknown";
+```
+
+Defined in: [models/INormalizedWebhookEvent.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedWebhookEvent.ts#L14)

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

@@ -0,0 +1,65 @@
+---
+title: 'Interface: IPaymentModuleOptions'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Interface: IPaymentModuleOptions
+
+Defined in: [PaymentModule.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L19)
+
+Configuration options for the `PaymentModule`.
+
+## Properties
+
+### configEntries?
+
+```ts
+optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
+```
+
+Defined in: [PaymentModule.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L29)
+
+Provider-specific configuration entries to register with the config module.
+
+---
+
+### featureAccess?
+
+```ts
+optional featureAccess?: Type<FeatureAccessPort>;
+```
+
+Defined in: [PaymentModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L35)
+
+Concrete implementation of the [FeatureAccessPort](Class.FeatureAccessPort).
+Required when using `FeatureGuard` or `FeatureUsageInterceptor`.
+
+---
+
+### isGlobal?
+
+```ts
+optional isGlobal?: boolean;
+```
+
+Defined in: [PaymentModule.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L40)
+
+When `true` the module is registered globally.
+
+---
+
+### paymentClient
+
+```ts
+paymentClient: Type<PaymentClientPort>;
+```
+
+Defined in: [PaymentModule.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L24)
+
+Concrete implementation of the [PaymentClientPort](Class.PaymentClientPort).
+For example, `StripeClient`, `PaddleClient`, `LemonSqueezyClient`, or `MollieClient`.

package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md

@@ -0,0 +1,27 @@
+---
+title: 'Type Alias: SubscriptionStatus'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-payments**](../)
+
+---
+
+# Type Alias: SubscriptionStatus
+
+```ts
+type SubscriptionStatus =
+  | 'active'
+  | 'canceled'
+  | 'incomplete'
+  | 'incompleteExpired'
+  | 'pastDue'
+  | 'trialing'
+  | 'unpaid'
+  | 'paused';
+```
+
+Defined in: [models/SubscriptionStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/SubscriptionStatus.ts#L6)
+
+Normalized subscription status values.