@carlonicora/nextjs-jsonapi 6.4.0 → 6.6.0

package/dist/billing/index.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { ReactNode } from 'react';
-import { S as StripeSubscriptionInterface, a as StripePriceInterface, b as StripePriceInput, c as StripeProductInterface, d as StripeProductInput, e as SubscriptionStatus } from '../stripe-price.interface-DGqcklFJ.js';
-import { P as PaymentMethodInterface, S as StripeCustomerInterface, a as StripeInvoiceInterface, M as MeterInterface, e as MeterSummaryInterface, B as BillingFormatOptions, g as PromotionCodeValidationResult, j as StripeCouponInterface, m as StripeCouponInput, n as StripeCouponRenameInput, p as StripeCouponCodeInput, o as StripeCouponCodeInterface, q as StripeCouponCodeFlagsInput, I as InvoiceStatus, b as ProrationPreviewInterface, d as StripeUsageInterface } from '../currency-CBgZkS0u.js';
+import { S as StripeSubscriptionInterface, a as StripePriceInterface, c as StripeProductInterface, e as SubscriptionStatus, b as StripePriceInput, d as StripeProductInput } from '../stripe-price.interface-DGqcklFJ.js';
+import { P as PaymentMethodInterface, S as StripeCustomerInterface, a as StripeInvoiceInterface, M as MeterInterface, e as MeterSummaryInterface, b as ProrationPreviewInterface, g as PromotionCodeValidationResult, B as BillingFormatOptions, j as StripeCouponInterface, m as StripeCouponInput, n as StripeCouponRenameInput, p as StripeCouponCodeInput, o as StripeCouponCodeInterface, q as StripeCouponCodeFlagsInput, I as InvoiceStatus, d as StripeUsageInterface } from '../currency-CBgZkS0u.js';
 export { u as BillingTranslator, s as formatCurrency, t as formatFixed, r as formatInterval } from '../currency-CBgZkS0u.js';
 import { J as JsonApiHydratedDataInterface } from '../ApiDataInterface-BcZeXy5X.js';
 import { FieldValues, UseFormReturn } from 'react-hook-form';
@@ -48,7 +48,177 @@ type BillingUsageSummaryCardProps = {
 };
 declare function BillingUsageSummaryCard({ meters, summaries, loading, error, onViewDetailsClick, }: BillingUsageSummaryCardProps): React.JSX.Element;
 
-declare function BillingDashboardContainer(): React.JSX.Element;
+/** Props an app receives when it replaces the library cancel dialog. */
+type CancelDialogRenderProps = {
+    subscription: StripeSubscriptionInterface;
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    onSuccess: () => void;
+    /** Opens the plan-change wizard for this subscription and closes the details. Undefined when the host gave no onChangePlan. */
+    openChangePlan?: () => void;
+};
+/** Optional replacement for the library cancel dialog. Absent, the library renders CancelSubscriptionDialog. */
+type RenderCancelDialog = (props: CancelDialogRenderProps) => ReactNode;
+type SubscriptionDetailsProps = {
+    subscription: StripeSubscriptionInterface;
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    onSubscriptionChange: () => void;
+    onChangePlan?: (subscription: StripeSubscriptionInterface) => void;
+    renderCancelDialog?: RenderCancelDialog;
+};
+declare function SubscriptionDetails({ subscription, open, onOpenChange, onSubscriptionChange, onChangePlan, renderCancelDialog, }: SubscriptionDetailsProps): React.JSX.Element;
+
+type SubscriptionsContainerProps = {
+    onOpenWizard?: (subscription?: StripeSubscriptionInterface) => void;
+    hasActiveRecurringSubscription?: boolean;
+    /**
+     * The list a parent already holds (the billing dashboard). When given, the container
+     * shows it instead of loading its own, and a change asks the parent to refresh through
+     * `onSubscriptionsChange`, so the dialog and the cards behind it never disagree.
+     */
+    subscriptions?: StripeSubscriptionInterface[];
+    onSubscriptionsChange?: () => void;
+    /** Replaces the library cancel dialog; absent, the library dialog renders. */
+    renderCancelDialog?: RenderCancelDialog;
+};
+declare function SubscriptionsContainer({ onOpenWizard, hasActiveRecurringSubscription, subscriptions: parentSubscriptions, onSubscriptionsChange, renderCancelDialog, }: SubscriptionsContainerProps): React.JSX.Element;
+
+type CancelSubscriptionDialogProps = {
+    subscription: StripeSubscriptionInterface;
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    onSuccess: () => void;
+};
+declare function CancelSubscriptionDialog({ subscription, open, onOpenChange, onSuccess, }: CancelSubscriptionDialogProps): React.JSX.Element;
+
+type SubscriptionsListProps = {
+    subscriptions: StripeSubscriptionInterface[];
+    onSubscriptionsChange: () => void;
+    onChangePlan?: (subscription: StripeSubscriptionInterface) => void;
+    renderCancelDialog?: RenderCancelDialog;
+};
+declare function SubscriptionsList({ subscriptions, onSubscriptionsChange, onChangePlan, renderCancelDialog, }: SubscriptionsListProps): React.JSX.Element;
+
+type BillingInterval = "month" | "year";
+type IntervalToggleProps = {
+    value: BillingInterval;
+    onChange: (interval: BillingInterval) => void;
+    hasMonthly: boolean;
+    hasYearly: boolean;
+};
+declare function IntervalToggle({ value, onChange, hasMonthly, hasYearly }: IntervalToggleProps): React.JSX.Element | null;
+
+type PricingCardProps = {
+    price: StripePriceInterface;
+    isCurrentPlan?: boolean;
+    isSelected?: boolean;
+    isDisabled?: boolean;
+    isLoading?: boolean;
+    onSelect: (price: StripePriceInterface) => void;
+};
+declare function PricingCard({ price, isCurrentPlan, isSelected, isDisabled, isLoading, onSelect, }: PricingCardProps): React.JSX.Element;
+
+type ProductPricingListProps = {
+    products: StripeProductInterface[];
+    selectedInterval: BillingInterval;
+    currentPriceId?: string;
+    selectedPriceId?: string;
+    loadingPriceId?: string;
+    loading?: boolean;
+    onSelectPrice: (price: StripePriceInterface) => void;
+    hideRecurringPrices?: boolean;
+    hideOneTimePrices?: boolean;
+};
+declare function ProductPricingList({ products, selectedInterval, currentPriceId, selectedPriceId, loadingPriceId, loading, onSelectPrice, hideRecurringPrices, hideOneTimePrices, }: ProductPricingListProps): React.JSX.Element;
+
+type ProductPricingRowProps = {
+    product: StripeProductInterface;
+    prices: StripePriceInterface[];
+    currentPriceId?: string;
+    selectedPriceId?: string;
+    loadingPriceId?: string;
+    onSelectPrice: (price: StripePriceInterface) => void;
+};
+declare function ProductPricingRow({ product, prices, currentPriceId, selectedPriceId, loadingPriceId, onSelectPrice, }: ProductPricingRowProps): React.JSX.Element | null;
+
+type ProrationPreviewProps = {
+    preview: ProrationPreviewInterface;
+};
+declare function ProrationPreview({ preview }: ProrationPreviewProps): React.JSX.Element;
+
+type SubscriptionStatusBadgeProps = {
+    status: SubscriptionStatus;
+    cancelAtPeriodEnd?: boolean;
+};
+declare function SubscriptionStatusBadge({ status, cancelAtPeriodEnd }: SubscriptionStatusBadgeProps): React.JSX.Element;
+
+type SubscriptionConfirmationProps = {
+    price: StripePriceInterface;
+    isLoading: boolean;
+    onConfirm: () => void;
+    onCancel: () => void;
+};
+declare function SubscriptionConfirmation({ price, isLoading, onConfirm, onCancel }: SubscriptionConfirmationProps): React.JSX.Element;
+
+type SubscriptionWizardProps = {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    onSuccess: () => void;
+    hasActiveRecurringSubscription: boolean;
+    subscription?: StripeSubscriptionInterface;
+};
+declare function SubscriptionWizard({ open, onOpenChange, onSuccess, hasActiveRecurringSubscription, subscription, }: SubscriptionWizardProps): React.JSX.Element;
+
+type WizardStep = "plan-selection" | "review" | "payment-method";
+
+type WizardProgressIndicatorProps = {
+    currentStep: WizardStep;
+};
+declare function WizardProgressIndicator({ currentStep }: WizardProgressIndicatorProps): React.JSX.Element;
+
+type WizardStepPlanSelectionProps = {
+    selectedPrice: StripePriceInterface | null;
+    selectedInterval: BillingInterval;
+    currentPriceId?: string;
+    hideRecurringPrices: boolean;
+    hideOneTimePrices: boolean;
+    onSelectPrice: (price: StripePriceInterface) => void;
+    onIntervalChange: (interval: BillingInterval) => void;
+    onNext: () => void;
+    isProcessing: boolean;
+};
+declare function WizardStepPlanSelection({ selectedPrice, selectedInterval, currentPriceId, hideRecurringPrices, hideOneTimePrices, onSelectPrice, onIntervalChange, onNext, isProcessing, }: WizardStepPlanSelectionProps): React.JSX.Element;
+
+type WizardStepReviewProps = {
+    selectedPrice: StripePriceInterface | null;
+    subscription?: StripeSubscriptionInterface;
+    prorationPreview: ProrationPreviewInterface | null;
+    hasPaymentMethod: boolean;
+    error: string | null;
+    isProcessing: boolean;
+    onBack: () => void;
+    onAddPaymentMethod: () => void;
+    onConfirm: () => void;
+    promotionCode: PromotionCodeValidationResult | null;
+    isValidatingPromoCode: boolean;
+    promoCodeError: string | null;
+    onApplyPromoCode: (code: string) => void;
+    onRemovePromoCode: () => void;
+    isTrialUpgrade: boolean;
+};
+declare function WizardStepReview({ selectedPrice, subscription, prorationPreview, hasPaymentMethod, error, isProcessing, onBack, onAddPaymentMethod, onConfirm, promotionCode, isValidatingPromoCode, promoCodeError, onApplyPromoCode, onRemovePromoCode, isTrialUpgrade, }: WizardStepReviewProps): React.JSX.Element;
+
+type WizardStepPaymentMethodProps = {
+    onBack: () => void;
+    onSuccess: () => void;
+    isProcessing: boolean;
+};
+declare function WizardStepPaymentMethod({ onBack, onSuccess, isProcessing }: WizardStepPaymentMethodProps): React.JSX.Element;
+
+declare function BillingDashboardContainer({ renderCancelDialog }?: {
+    renderCancelDialog?: RenderCancelDialog;
+}): React.JSX.Element;
 
 type BillingDetailModalProps = {
     open: boolean;
@@ -495,159 +665,6 @@ type CouponCodeActionsProps = {
  */
 declare function CouponCodeActions({ code, status }: CouponCodeActionsProps): React.JSX.Element;
 
-type SubscriptionsContainerProps = {
-    onOpenWizard?: (subscription?: StripeSubscriptionInterface) => void;
-    hasActiveRecurringSubscription?: boolean;
-    /**
-     * The list a parent already holds (the billing dashboard). When given, the container
-     * shows it instead of loading its own, and a change asks the parent to refresh through
-     * `onSubscriptionsChange`, so the dialog and the cards behind it never disagree.
-     */
-    subscriptions?: StripeSubscriptionInterface[];
-    onSubscriptionsChange?: () => void;
-};
-declare function SubscriptionsContainer({ onOpenWizard, hasActiveRecurringSubscription, subscriptions: parentSubscriptions, onSubscriptionsChange, }: SubscriptionsContainerProps): React.JSX.Element;
-
-type SubscriptionDetailsProps = {
-    subscription: StripeSubscriptionInterface;
-    open: boolean;
-    onOpenChange: (open: boolean) => void;
-    onSubscriptionChange: () => void;
-    onChangePlan?: (subscription: StripeSubscriptionInterface) => void;
-};
-declare function SubscriptionDetails({ subscription, open, onOpenChange, onSubscriptionChange, onChangePlan, }: SubscriptionDetailsProps): React.JSX.Element;
-
-type CancelSubscriptionDialogProps = {
-    subscription: StripeSubscriptionInterface;
-    open: boolean;
-    onOpenChange: (open: boolean) => void;
-    onSuccess: () => void;
-};
-declare function CancelSubscriptionDialog({ subscription, open, onOpenChange, onSuccess, }: CancelSubscriptionDialogProps): React.JSX.Element;
-
-type SubscriptionsListProps = {
-    subscriptions: StripeSubscriptionInterface[];
-    onSubscriptionsChange: () => void;
-    onChangePlan?: (subscription: StripeSubscriptionInterface) => void;
-};
-declare function SubscriptionsList({ subscriptions, onSubscriptionsChange, onChangePlan }: SubscriptionsListProps): React.JSX.Element;
-
-type BillingInterval = "month" | "year";
-type IntervalToggleProps = {
-    value: BillingInterval;
-    onChange: (interval: BillingInterval) => void;
-    hasMonthly: boolean;
-    hasYearly: boolean;
-};
-declare function IntervalToggle({ value, onChange, hasMonthly, hasYearly }: IntervalToggleProps): React.JSX.Element | null;
-
-type PricingCardProps = {
-    price: StripePriceInterface;
-    isCurrentPlan?: boolean;
-    isSelected?: boolean;
-    isDisabled?: boolean;
-    isLoading?: boolean;
-    onSelect: (price: StripePriceInterface) => void;
-};
-declare function PricingCard({ price, isCurrentPlan, isSelected, isDisabled, isLoading, onSelect, }: PricingCardProps): React.JSX.Element;
-
-type ProductPricingListProps = {
-    products: StripeProductInterface[];
-    selectedInterval: BillingInterval;
-    currentPriceId?: string;
-    selectedPriceId?: string;
-    loadingPriceId?: string;
-    loading?: boolean;
-    onSelectPrice: (price: StripePriceInterface) => void;
-    hideRecurringPrices?: boolean;
-    hideOneTimePrices?: boolean;
-};
-declare function ProductPricingList({ products, selectedInterval, currentPriceId, selectedPriceId, loadingPriceId, loading, onSelectPrice, hideRecurringPrices, hideOneTimePrices, }: ProductPricingListProps): React.JSX.Element;
-
-type ProductPricingRowProps = {
-    product: StripeProductInterface;
-    prices: StripePriceInterface[];
-    currentPriceId?: string;
-    selectedPriceId?: string;
-    loadingPriceId?: string;
-    onSelectPrice: (price: StripePriceInterface) => void;
-};
-declare function ProductPricingRow({ product, prices, currentPriceId, selectedPriceId, loadingPriceId, onSelectPrice, }: ProductPricingRowProps): React.JSX.Element | null;
-
-type ProrationPreviewProps = {
-    preview: ProrationPreviewInterface;
-};
-declare function ProrationPreview({ preview }: ProrationPreviewProps): React.JSX.Element;
-
-type SubscriptionStatusBadgeProps = {
-    status: SubscriptionStatus;
-    cancelAtPeriodEnd?: boolean;
-};
-declare function SubscriptionStatusBadge({ status, cancelAtPeriodEnd }: SubscriptionStatusBadgeProps): React.JSX.Element;
-
-type SubscriptionConfirmationProps = {
-    price: StripePriceInterface;
-    isLoading: boolean;
-    onConfirm: () => void;
-    onCancel: () => void;
-};
-declare function SubscriptionConfirmation({ price, isLoading, onConfirm, onCancel }: SubscriptionConfirmationProps): React.JSX.Element;
-
-type SubscriptionWizardProps = {
-    open: boolean;
-    onOpenChange: (open: boolean) => void;
-    onSuccess: () => void;
-    hasActiveRecurringSubscription: boolean;
-    subscription?: StripeSubscriptionInterface;
-};
-declare function SubscriptionWizard({ open, onOpenChange, onSuccess, hasActiveRecurringSubscription, subscription, }: SubscriptionWizardProps): React.JSX.Element;
-
-type WizardStep = "plan-selection" | "review" | "payment-method";
-
-type WizardProgressIndicatorProps = {
-    currentStep: WizardStep;
-};
-declare function WizardProgressIndicator({ currentStep }: WizardProgressIndicatorProps): React.JSX.Element;
-
-type WizardStepPlanSelectionProps = {
-    selectedPrice: StripePriceInterface | null;
-    selectedInterval: BillingInterval;
-    currentPriceId?: string;
-    hideRecurringPrices: boolean;
-    hideOneTimePrices: boolean;
-    onSelectPrice: (price: StripePriceInterface) => void;
-    onIntervalChange: (interval: BillingInterval) => void;
-    onNext: () => void;
-    isProcessing: boolean;
-};
-declare function WizardStepPlanSelection({ selectedPrice, selectedInterval, currentPriceId, hideRecurringPrices, hideOneTimePrices, onSelectPrice, onIntervalChange, onNext, isProcessing, }: WizardStepPlanSelectionProps): React.JSX.Element;
-
-type WizardStepReviewProps = {
-    selectedPrice: StripePriceInterface | null;
-    subscription?: StripeSubscriptionInterface;
-    prorationPreview: ProrationPreviewInterface | null;
-    hasPaymentMethod: boolean;
-    error: string | null;
-    isProcessing: boolean;
-    onBack: () => void;
-    onAddPaymentMethod: () => void;
-    onConfirm: () => void;
-    promotionCode: PromotionCodeValidationResult | null;
-    isValidatingPromoCode: boolean;
-    promoCodeError: string | null;
-    onApplyPromoCode: (code: string) => void;
-    onRemovePromoCode: () => void;
-    isTrialUpgrade: boolean;
-};
-declare function WizardStepReview({ selectedPrice, subscription, prorationPreview, hasPaymentMethod, error, isProcessing, onBack, onAddPaymentMethod, onConfirm, promotionCode, isValidatingPromoCode, promoCodeError, onApplyPromoCode, onRemovePromoCode, isTrialUpgrade, }: WizardStepReviewProps): React.JSX.Element;
-
-type WizardStepPaymentMethodProps = {
-    onBack: () => void;
-    onSuccess: () => void;
-    isProcessing: boolean;
-};
-declare function WizardStepPaymentMethod({ onBack, onSuccess, isProcessing }: WizardStepPaymentMethodProps): React.JSX.Element;
-
 declare function UsageContainer(): React.JSX.Element | null;
 
 type UsageSummaryCardProps = {
@@ -677,4 +694,4 @@ type PromoCodeInputProps = {
 };
 declare function PromoCodeInput({ appliedCode, isValidating, error, onApply, onRemove, disabled, }: PromoCodeInputProps): React.JSX.Element;
 
-export { BillingAlertBanner, BillingDashboardContainer, BillingDetailModal, type BillingDiscount, BillingFormatOptions, type BillingInterval, BillingUsageSummaryCard, CancelSubscriptionDialog, CouponCodeActions, CouponCodeEditor, type CouponCodeEditorProps, CouponCodeFields, type CouponCodeFormValues, CouponCodesList, CouponContainer, type CouponContextType, CouponDetails, CouponEditor, type CouponEditorProps, CouponProvider, type CouponProviderProps, CouponRefresher, CouponsList, CustomerInfoCard, IntervalToggle, type IntervalToggleProps, InvoiceDetails, InvoiceStatusBadge, InvoicesContainer, InvoicesList, InvoicesSummaryCard, PaymentMethodCard, PaymentMethodEditor, PaymentMethodForm, PaymentMethodSummaryCard, PaymentMethodsContainer, PaymentMethodsList, PriceArchiver, PriceContainer, type PriceContextType, PriceDetails, PriceEditor, type PriceEditorProps, PriceProvider, type PriceProviderProps, PricesList, PricingCard, type PricingCardProps, ProductArchiver, ProductContainer, type ProductContextType, ProductDetails, ProductEditor, type ProductEditorProps, ProductPricingList, type ProductPricingListProps, ProductPricingRow, type ProductPricingRowProps, ProductProvider, type ProductProviderProps, ProductsList, ProductsListContainer, PromoCodeInput, ProrationPreview, StripeProvider, SubscriptionConfirmation, SubscriptionDetails, SubscriptionStatusBadge, SubscriptionSummaryCard, SubscriptionWizard, type SubscriptionWizardProps, SubscriptionsContainer, SubscriptionsList, UsageContainer, UsageHistoryTable, UsageSummaryCard, UsageSummaryCards, WizardProgressIndicator, WizardStepPaymentMethod, WizardStepPlanSelection, WizardStepReview, applyDiscount, couponCodeDefaults, couponCodeSchema, couponCurrencyOptions, formatDate, isStripeConfigured, optionalDate, optionalDecimal, optionalPositiveInt, parseOptionalDecimal, parseOptionalPositiveInt, priceLabel, promotionCodeDiscount, subscriptionDiscount, toCouponCodeInput, useBillingFormatOptions, useCouponContext, usePriceContext, useProductContext };
+export { BillingAlertBanner, BillingDashboardContainer, BillingDetailModal, type BillingDiscount, BillingFormatOptions, type BillingInterval, BillingUsageSummaryCard, type CancelDialogRenderProps, CancelSubscriptionDialog, CouponCodeActions, CouponCodeEditor, type CouponCodeEditorProps, CouponCodeFields, type CouponCodeFormValues, CouponCodesList, CouponContainer, type CouponContextType, CouponDetails, CouponEditor, type CouponEditorProps, CouponProvider, type CouponProviderProps, CouponRefresher, CouponsList, CustomerInfoCard, IntervalToggle, type IntervalToggleProps, InvoiceDetails, InvoiceStatusBadge, InvoicesContainer, InvoicesList, InvoicesSummaryCard, PaymentMethodCard, PaymentMethodEditor, PaymentMethodForm, PaymentMethodSummaryCard, PaymentMethodsContainer, PaymentMethodsList, PriceArchiver, PriceContainer, type PriceContextType, PriceDetails, PriceEditor, type PriceEditorProps, PriceProvider, type PriceProviderProps, PricesList, PricingCard, type PricingCardProps, ProductArchiver, ProductContainer, type ProductContextType, ProductDetails, ProductEditor, type ProductEditorProps, ProductPricingList, type ProductPricingListProps, ProductPricingRow, type ProductPricingRowProps, ProductProvider, type ProductProviderProps, ProductsList, ProductsListContainer, PromoCodeInput, ProrationPreview, type RenderCancelDialog, StripeProvider, SubscriptionConfirmation, SubscriptionDetails, SubscriptionStatusBadge, SubscriptionSummaryCard, SubscriptionWizard, type SubscriptionWizardProps, SubscriptionsContainer, SubscriptionsList, UsageContainer, UsageHistoryTable, UsageSummaryCard, UsageSummaryCards, WizardProgressIndicator, WizardStepPaymentMethod, WizardStepPlanSelection, WizardStepReview, applyDiscount, couponCodeDefaults, couponCodeSchema, couponCurrencyOptions, formatDate, isStripeConfigured, optionalDate, optionalDecimal, optionalPositiveInt, parseOptionalDecimal, parseOptionalPositiveInt, priceLabel, promotionCodeDiscount, subscriptionDiscount, toCouponCodeInput, useBillingFormatOptions, useCouponContext, usePriceContext, useProductContext };